1 /* Copyright (c) 2009, 2010 Nicira Networks
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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
26 #include "command-line.h"
31 #include "jsonrpc-server.h"
32 #include "leak-checker.h"
34 #include "ovsdb-data.h"
35 #include "ovsdb-types.h"
36 #include "ovsdb-error.h"
37 #include "poll-loop.h"
40 #include "stream-ssl.h"
50 #define THIS_MODULE VLM_ovsdb_server
53 /* SSL configuration. */
54 static char *private_key_file;
55 static char *certificate_file;
56 static char *ca_cert_file;
57 static bool bootstrap_ca_cert;
60 static unixctl_cb_func ovsdb_server_exit;
61 static unixctl_cb_func ovsdb_server_compact;
62 static unixctl_cb_func ovsdb_server_reconnect;
64 static void parse_options(int argc, char *argv[], char **file_namep,
65 struct shash *remotes, char **unixctl_pathp,
67 static void usage(void) NO_RETURN;
69 static void reconfigure_from_db(struct ovsdb_jsonrpc_server *jsonrpc,
70 const struct ovsdb *db, struct shash *remotes);
73 main(int argc, char *argv[])
75 char *unixctl_path = NULL;
76 char *run_command = NULL;
77 struct unixctl_server *unixctl;
78 struct ovsdb_jsonrpc_server *jsonrpc;
80 struct ovsdb_error *error;
81 struct ovsdb_file *file;
83 struct process *run_process;
88 proctitle_init(argc, argv);
89 set_program_name(argv[0]);
91 signal(SIGPIPE, SIG_IGN);
94 parse_options(argc, argv, &file_name, &remotes, &unixctl_path,
97 die_if_already_running();
100 error = ovsdb_file_open(file_name, false, &db, &file);
102 ovs_fatal(0, "%s", ovsdb_error_to_string(error));
105 jsonrpc = ovsdb_jsonrpc_server_create(db);
106 reconfigure_from_db(jsonrpc, db, &remotes);
108 retval = unixctl_server_create(unixctl_path, &unixctl);
116 run_argv[0] = "/bin/sh";
118 run_argv[2] = run_command;
121 retval = process_start(run_argv, NULL, 0, NULL, 0, &run_process);
123 ovs_fatal(retval, "%s: process failed to start", run_command);
129 daemonize_complete();
131 unixctl_command_register("exit", ovsdb_server_exit, &exiting);
132 unixctl_command_register("ovsdb-server/compact", ovsdb_server_compact,
134 unixctl_command_register("ovsdb-server/reconnect", ovsdb_server_reconnect,
139 reconfigure_from_db(jsonrpc, db, &remotes);
140 ovsdb_jsonrpc_server_run(jsonrpc);
141 unixctl_server_run(unixctl);
142 ovsdb_trigger_run(db, time_msec());
143 if (run_process && process_exited(run_process)) {
147 ovsdb_jsonrpc_server_wait(jsonrpc);
148 unixctl_server_wait(unixctl);
149 ovsdb_trigger_wait(db, time_msec());
151 process_wait(run_process);
155 ovsdb_jsonrpc_server_destroy(jsonrpc);
157 shash_destroy(&remotes);
158 unixctl_server_destroy(unixctl);
160 if (run_process && process_exited(run_process)) {
161 int status = process_status(run_process);
163 ovs_fatal(0, "%s: child exited, %s",
164 run_command, process_status_msg(status));
172 parse_db_string_column(const struct ovsdb *db,
174 const struct ovsdb_table **tablep,
175 const struct ovsdb_column **columnp)
177 char *name, *table_name, *column_name;
178 const struct ovsdb_column *column;
179 const struct ovsdb_table *table;
180 char *save_ptr = NULL;
182 name = xstrdup(name_);
183 strtok_r(name, ":", &save_ptr); /* "db:" */
184 table_name = strtok_r(NULL, ",", &save_ptr);
185 column_name = strtok_r(NULL, ",", &save_ptr);
186 if (!table_name || !column_name) {
187 ovs_fatal(0, "\"%s\": invalid syntax", name_);
190 table = ovsdb_get_table(db, table_name);
192 ovs_fatal(0, "\"%s\": no table named %s", name_, table_name);
195 column = ovsdb_table_schema_get_column(table->schema, column_name);
197 ovs_fatal(0, "\"%s\": table \"%s\" has no column \"%s\"",
198 name_, table_name, column_name);
202 if (column->type.key.type != OVSDB_TYPE_STRING
203 || column->type.value.type != OVSDB_TYPE_VOID) {
204 ovs_fatal(0, "\"%s\": table \"%s\" column \"%s\" is "
205 "not string or set of strings",
206 name_, table->schema->name, column->name);
215 query_db_string(const struct ovsdb *db, const char *name)
217 if (!name || strncmp(name, "db:", 3)) {
220 const struct ovsdb_column *column;
221 const struct ovsdb_table *table;
222 const struct ovsdb_row *row;
224 parse_db_string_column(db, name, &table, &column);
226 HMAP_FOR_EACH (row, struct ovsdb_row, hmap_node, &table->rows) {
227 const struct ovsdb_datum *datum;
230 datum = &row->fields[column->index];
231 for (i = 0; i < datum->n; i++) {
232 if (datum->keys[i].string[0]) {
233 return datum->keys[i].string;
240 #endif /* HAVE_OPENSSL */
243 query_db_remotes(const char *name, const struct ovsdb *db,
244 struct shash *remotes)
246 const struct ovsdb_column *column;
247 const struct ovsdb_table *table;
248 const struct ovsdb_row *row;
250 parse_db_string_column(db, name, &table, &column);
252 HMAP_FOR_EACH (row, struct ovsdb_row, hmap_node, &table->rows) {
253 const struct ovsdb_datum *datum;
256 datum = &row->fields[column->index];
257 for (i = 0; i < datum->n; i++) {
258 shash_add_once(remotes, datum->keys[i].string, NULL);
263 /* Reconfigures ovsdb-server based on information in the database. */
265 reconfigure_from_db(struct ovsdb_jsonrpc_server *jsonrpc,
266 const struct ovsdb *db, struct shash *remotes)
268 struct shash resolved_remotes;
269 struct shash_node *node;
271 /* Configure remotes. */
272 shash_init(&resolved_remotes);
273 SHASH_FOR_EACH (node, remotes) {
274 const char *name = node->name;
276 if (!strncmp(name, "db:", 3)) {
277 query_db_remotes(name, db, &resolved_remotes);
279 shash_add_once(&resolved_remotes, name, NULL);
282 ovsdb_jsonrpc_server_set_remotes(jsonrpc, &resolved_remotes);
283 shash_destroy(&resolved_remotes);
287 stream_ssl_set_private_key_file(query_db_string(db, private_key_file));
288 stream_ssl_set_certificate_file(query_db_string(db, certificate_file));
289 stream_ssl_set_ca_cert_file(query_db_string(db, ca_cert_file),
295 ovsdb_server_exit(struct unixctl_conn *conn, const char *args OVS_UNUSED,
298 bool *exiting = exiting_;
300 unixctl_command_reply(conn, 200, NULL);
304 ovsdb_server_compact(struct unixctl_conn *conn, const char *args OVS_UNUSED,
307 struct ovsdb_file *file = file_;
308 struct ovsdb_error *error;
310 VLOG_INFO("compacting database by user request");
311 error = ovsdb_file_compact(file);
313 unixctl_command_reply(conn, 200, NULL);
315 char *s = ovsdb_error_to_string(error);
316 ovsdb_error_destroy(error);
317 unixctl_command_reply(conn, 503, s);
322 /* "ovsdb-server/reconnect": makes ovsdb-server drop all of its JSON-RPC
323 * connections and reconnect. */
325 ovsdb_server_reconnect(struct unixctl_conn *conn, const char *args OVS_UNUSED,
328 struct ovsdb_jsonrpc_server *jsonrpc = jsonrpc_;
330 ovsdb_jsonrpc_server_reconnect(jsonrpc);
331 unixctl_command_reply(conn, 200, NULL);
335 parse_options(int argc, char *argv[], char **file_namep,
336 struct shash *remotes, char **unixctl_pathp,
340 OPT_DUMMY = UCHAR_MAX + 1,
344 OPT_BOOTSTRAP_CA_CERT,
346 LEAK_CHECKER_OPTION_ENUMS
348 static struct option long_options[] = {
349 {"remote", required_argument, 0, OPT_REMOTE},
350 {"unixctl", required_argument, 0, OPT_UNIXCTL},
351 {"run", required_argument, 0, OPT_RUN},
352 {"help", no_argument, 0, 'h'},
353 {"version", no_argument, 0, 'V'},
356 LEAK_CHECKER_LONG_OPTIONS,
358 {"bootstrap-ca-cert", required_argument, 0, OPT_BOOTSTRAP_CA_CERT},
359 {"private-key", required_argument, 0, 'p'},
360 {"certificate", required_argument, 0, 'c'},
361 {"ca-cert", required_argument, 0, 'C'},
365 char *short_options = long_options_to_short_options(long_options);
371 c = getopt_long(argc, argv, short_options, long_options, NULL);
378 shash_add_once(remotes, optarg, NULL);
382 *unixctl_pathp = optarg;
386 *run_command = optarg;
393 OVS_PRINT_VERSION(0, 0);
397 DAEMON_OPTION_HANDLERS
398 LEAK_CHECKER_OPTION_HANDLERS
402 private_key_file = optarg;
406 certificate_file = optarg;
410 ca_cert_file = optarg;
411 bootstrap_ca_cert = false;
414 case OPT_BOOTSTRAP_CA_CERT:
415 ca_cert_file = optarg;
416 bootstrap_ca_cert = true;
433 ovs_fatal(0, "database file is only non-option argument; "
434 "use --help for usage");
435 } else if (argc < 1) {
436 ovs_fatal(0, "missing database file argument; use --help for usage");
439 *file_namep = argv[0];
445 printf("%s: Open vSwitch database server\n"
446 "usage: %s [OPTIONS] DATABASE\n"
447 "where DATABASE is a database file in ovsdb format.\n",
448 program_name, program_name);
449 printf("\nJSON-RPC options (may be specified any number of times):\n"
450 " --remote=REMOTE connect or listen to REMOTE\n");
451 stream_usage("JSON-RPC", true, true, true);
454 printf("\nOther options:\n"
455 " --run COMMAND run COMMAND as subprocess then exit\n"
456 " --unixctl=SOCKET override default control socket name\n"
457 " -h, --help display this help message\n"
458 " -V, --version display version information\n");
459 leak_checker_usage();