Better document how ovsdb-server is meant to be used.
[sliver-openvswitch.git] / vswitchd / ovs-vswitchd.c
1 /* Copyright (c) 2008, 2009, 2010 Nicira Networks
2  *
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15
16 #include <config.h>
17
18 #include <assert.h>
19 #include <errno.h>
20 #include <getopt.h>
21 #include <limits.h>
22 #include <signal.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #ifdef HAVE_MLOCKALL
26 #include <sys/mman.h>
27 #endif
28
29 #include "bridge.h"
30 #include "command-line.h"
31 #include "compiler.h"
32 #include "daemon.h"
33 #include "dpif.h"
34 #include "leak-checker.h"
35 #include "netdev.h"
36 #include "ovsdb-idl.h"
37 #include "poll-loop.h"
38 #include "proc-net-compat.h"
39 #include "process.h"
40 #include "signals.h"
41 #include "stream-ssl.h"
42 #include "stream.h"
43 #include "svec.h"
44 #include "timeval.h"
45 #include "unixctl.h"
46 #include "util.h"
47 #include "vconn.h"
48 #include "vswitchd/vswitch-idl.h"
49
50 #include "vlog.h"
51 #define THIS_MODULE VLM_vswitchd
52
53 static unixctl_cb_func ovs_vswitchd_exit;
54
55 static const char *parse_options(int argc, char *argv[]);
56 static void usage(void) NO_RETURN;
57
58 int
59 main(int argc, char *argv[])
60 {
61     struct unixctl_server *unixctl;
62     struct signal *sighup;
63     struct ovsdb_idl *idl;
64     const char *remote;
65     bool need_reconfigure;
66     bool inited, exiting;
67     unsigned int idl_seqno;
68     int retval;
69
70     proctitle_init(argc, argv);
71     set_program_name(argv[0]);
72     time_init();
73     vlog_init();
74     remote = parse_options(argc, argv);
75     signal(SIGPIPE, SIG_IGN);
76     sighup = signal_register(SIGHUP);
77     process_init();
78     ovsrec_init();
79
80     die_if_already_running();
81     daemonize_start();
82
83     retval = unixctl_server_create(NULL, &unixctl);
84     if (retval) {
85         exit(EXIT_FAILURE);
86     }
87     unixctl_command_register("exit", ovs_vswitchd_exit, &exiting);
88
89     daemonize_complete();
90
91     idl = ovsdb_idl_create(remote, &ovsrec_idl_class);
92     idl_seqno = ovsdb_idl_get_seqno(idl);
93
94     need_reconfigure = false;
95     inited = false;
96     exiting = false;
97     while (!exiting) {
98         if (signal_poll(sighup)) {
99             vlog_reopen_log_file();
100         }
101         if (inited && bridge_run()) {
102             need_reconfigure = true;
103         }
104         ovsdb_idl_run(idl);
105         if (idl_seqno != ovsdb_idl_get_seqno(idl)) {
106             idl_seqno = ovsdb_idl_get_seqno(idl);
107             need_reconfigure = true;
108         }
109         if (need_reconfigure) {
110             const struct ovsrec_open_vswitch *cfg;
111
112             need_reconfigure = false;
113             cfg = ovsrec_open_vswitch_first(idl);
114             if (cfg) {
115                 if (inited) {
116                     bridge_reconfigure(cfg);
117                 } else {
118                     bridge_init(cfg);
119                     inited = true;
120                 }
121             }
122         }
123         unixctl_server_run(unixctl);
124         dp_run();
125         netdev_run();
126
127         signal_wait(sighup);
128         if (inited) {
129             bridge_wait();
130         }
131         ovsdb_idl_wait(idl);
132         unixctl_server_wait(unixctl);
133         dp_wait();
134         netdev_wait();
135         poll_block();
136     }
137
138     return 0;
139 }
140
141 static const char *
142 parse_options(int argc, char *argv[])
143 {
144     enum {
145         OPT_PEER_CA_CERT = UCHAR_MAX + 1,
146         OPT_MLOCKALL,
147         OPT_FAKE_PROC_NET,
148         VLOG_OPTION_ENUMS,
149         LEAK_CHECKER_OPTION_ENUMS,
150         OPT_BOOTSTRAP_CA_CERT
151     };
152     static struct option long_options[] = {
153         {"help",        no_argument, 0, 'h'},
154         {"version",     no_argument, 0, 'V'},
155         {"mlockall",    no_argument, 0, OPT_MLOCKALL},
156         {"fake-proc-net", no_argument, 0, OPT_FAKE_PROC_NET},
157         DAEMON_LONG_OPTIONS,
158         VLOG_LONG_OPTIONS,
159         LEAK_CHECKER_LONG_OPTIONS,
160 #ifdef HAVE_OPENSSL
161         STREAM_SSL_LONG_OPTIONS
162         {"peer-ca-cert", required_argument, 0, OPT_PEER_CA_CERT},
163         {"bootstrap-ca-cert", required_argument, 0, OPT_BOOTSTRAP_CA_CERT},
164 #endif
165         {0, 0, 0, 0},
166     };
167     char *short_options = long_options_to_short_options(long_options);
168     int error;
169
170     for (;;) {
171         int c;
172
173         c = getopt_long(argc, argv, short_options, long_options, NULL);
174         if (c == -1) {
175             break;
176         }
177
178         switch (c) {
179         case 'H':
180         case 'h':
181             usage();
182
183         case 'V':
184             OVS_PRINT_VERSION(OFP_VERSION, OFP_VERSION);
185             exit(EXIT_SUCCESS);
186
187         case OPT_MLOCKALL:
188 #ifdef HAVE_MLOCKALL
189             if (mlockall(MCL_CURRENT | MCL_FUTURE)) {
190                 VLOG_ERR("mlockall failed: %s", strerror(errno));
191             }
192 #else
193             VLOG_ERR("mlockall not supported on this system");
194 #endif
195             break;
196
197         case OPT_FAKE_PROC_NET:
198             error = proc_net_compat_init();
199             if (error) {
200                 ovs_fatal(error, "failed to initialize /proc/net "
201                           "compatibility");
202             }
203             break;
204
205         VLOG_OPTION_HANDLERS
206         DAEMON_OPTION_HANDLERS
207         LEAK_CHECKER_OPTION_HANDLERS
208
209 #ifdef HAVE_OPENSSL
210         STREAM_SSL_OPTION_HANDLERS
211
212         case OPT_PEER_CA_CERT:
213             stream_ssl_set_peer_ca_cert_file(optarg);
214             break;
215
216         case OPT_BOOTSTRAP_CA_CERT:
217             stream_ssl_set_ca_cert_file(optarg, true);
218             break;
219 #endif
220
221         case '?':
222             exit(EXIT_FAILURE);
223
224         default:
225             abort();
226         }
227     }
228     free(short_options);
229
230     argc -= optind;
231     argv += optind;
232
233     if (argc != 1) {
234         ovs_fatal(0, "database socket is only non-option argument; "
235                 "use --help for usage");
236     }
237
238     return argv[0];
239 }
240
241 static void
242 usage(void)
243 {
244     printf("%s: Open vSwitch daemon\n"
245            "usage: %s [OPTIONS] DATABASE\n"
246            "where DATABASE is a socket on which ovsdb-server is listening.\n",
247            program_name, program_name);
248     stream_usage("DATABASE", true, false, true);
249     daemon_usage();
250     vlog_usage();
251     printf("\nLegacy compatibility options:\n"
252            " --fake-proc-net          simulate some files in /proc/net\n"
253            "\nOther options:\n"
254            "  -h, --help              display this help message\n"
255            "  -V, --version           display version information\n");
256     leak_checker_usage();
257     exit(EXIT_SUCCESS);
258 }
259
260 static void
261 ovs_vswitchd_exit(struct unixctl_conn *conn, const char *args OVS_UNUSED,
262                   void *exiting_)
263 {
264     bool *exiting = exiting_;
265     *exiting = true;
266     unixctl_command_reply(conn, 200, NULL);
267 }