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]);
92 signal(SIGPIPE, SIG_IGN);
95 parse_options(argc, argv, &file_name, &remotes, &unixctl_path,
98 die_if_already_running();
101 error = ovsdb_file_open(file_name, false, &db, &file);
103 ovs_fatal(0, "%s", ovsdb_error_to_string(error));
106 jsonrpc = ovsdb_jsonrpc_server_create(db);
107 reconfigure_from_db(jsonrpc, db, &remotes);
109 retval = unixctl_server_create(unixctl_path, &unixctl);
117 run_argv[0] = "/bin/sh";
119 run_argv[2] = run_command;
122 retval = process_start(run_argv, NULL, 0, NULL, 0, &run_process);
124 ovs_fatal(retval, "%s: process failed to start", run_command);
130 daemonize_complete();
132 unixctl_command_register("exit", ovsdb_server_exit, &exiting);
133 unixctl_command_register("ovsdb-server/compact", ovsdb_server_compact,
135 unixctl_command_register("ovsdb-server/reconnect", ovsdb_server_reconnect,
140 reconfigure_from_db(jsonrpc, db, &remotes);
141 ovsdb_jsonrpc_server_run(jsonrpc);
142 unixctl_server_run(unixctl);
143 ovsdb_trigger_run(db, time_msec());
144 if (run_process && process_exited(run_process)) {
148 ovsdb_jsonrpc_server_wait(jsonrpc);
149 unixctl_server_wait(unixctl);
150 ovsdb_trigger_wait(db, time_msec());
152 process_wait(run_process);
156 ovsdb_jsonrpc_server_destroy(jsonrpc);
158 shash_destroy(&remotes);
159 unixctl_server_destroy(unixctl);
161 if (run_process && process_exited(run_process)) {
162 int status = process_status(run_process);
164 ovs_fatal(0, "%s: child exited, %s",
165 run_command, process_status_msg(status));
173 parse_db_string_column(const struct ovsdb *db,
175 const struct ovsdb_table **tablep,
176 const struct ovsdb_column **columnp)
178 char *name, *table_name, *column_name;
179 const struct ovsdb_column *column;
180 const struct ovsdb_table *table;
181 char *save_ptr = NULL;
183 name = xstrdup(name_);
184 strtok_r(name, ":", &save_ptr); /* "db:" */
185 table_name = strtok_r(NULL, ",", &save_ptr);
186 column_name = strtok_r(NULL, ",", &save_ptr);
187 if (!table_name || !column_name) {
188 ovs_fatal(0, "\"%s\": invalid syntax", name_);
191 table = ovsdb_get_table(db, table_name);
193 ovs_fatal(0, "\"%s\": no table named %s", name_, table_name);
196 column = ovsdb_table_schema_get_column(table->schema, column_name);
198 ovs_fatal(0, "\"%s\": table \"%s\" has no column \"%s\"",
199 name_, table_name, column_name);
203 if (column->type.key.type != OVSDB_TYPE_STRING
204 || column->type.value.type != OVSDB_TYPE_VOID) {
205 ovs_fatal(0, "\"%s\": table \"%s\" column \"%s\" is "
206 "not string or set of strings",
207 name_, table->schema->name, column->name);
216 query_db_string(const struct ovsdb *db, const char *name)
218 if (!name || strncmp(name, "db:", 3)) {
221 const struct ovsdb_column *column;
222 const struct ovsdb_table *table;
223 const struct ovsdb_row *row;
225 parse_db_string_column(db, name, &table, &column);
227 HMAP_FOR_EACH (row, struct ovsdb_row, hmap_node, &table->rows) {
228 const struct ovsdb_datum *datum;
231 datum = &row->fields[column->index];
232 for (i = 0; i < datum->n; i++) {
233 if (datum->keys[i].string[0]) {
234 return datum->keys[i].string;
241 #endif /* HAVE_OPENSSL */
244 query_db_remotes(const char *name, const struct ovsdb *db,
245 struct shash *remotes)
247 const struct ovsdb_column *column;
248 const struct ovsdb_table *table;
249 const struct ovsdb_row *row;
251 parse_db_string_column(db, name, &table, &column);
253 HMAP_FOR_EACH (row, struct ovsdb_row, hmap_node, &table->rows) {
254 const struct ovsdb_datum *datum;
257 datum = &row->fields[column->index];
258 for (i = 0; i < datum->n; i++) {
259 shash_add_once(remotes, datum->keys[i].string, NULL);
264 /* Reconfigures ovsdb-server based on information in the database. */
266 reconfigure_from_db(struct ovsdb_jsonrpc_server *jsonrpc,
267 const struct ovsdb *db, struct shash *remotes)
269 struct shash resolved_remotes;
270 struct shash_node *node;
272 /* Configure remotes. */
273 shash_init(&resolved_remotes);
274 SHASH_FOR_EACH (node, remotes) {
275 const char *name = node->name;
277 if (!strncmp(name, "db:", 3)) {
278 query_db_remotes(name, db, &resolved_remotes);
280 shash_add_once(&resolved_remotes, name, NULL);
283 ovsdb_jsonrpc_server_set_remotes(jsonrpc, &resolved_remotes);
284 shash_destroy(&resolved_remotes);
288 stream_ssl_set_private_key_file(query_db_string(db, private_key_file));
289 stream_ssl_set_certificate_file(query_db_string(db, certificate_file));
290 stream_ssl_set_ca_cert_file(query_db_string(db, ca_cert_file),
296 ovsdb_server_exit(struct unixctl_conn *conn, const char *args OVS_UNUSED,
299 bool *exiting = exiting_;
301 unixctl_command_reply(conn, 200, NULL);
305 ovsdb_server_compact(struct unixctl_conn *conn, const char *args OVS_UNUSED,
308 struct ovsdb_file *file = file_;
309 struct ovsdb_error *error;
311 VLOG_INFO("compacting database by user request");
312 error = ovsdb_file_compact(file);
314 unixctl_command_reply(conn, 200, NULL);
316 char *s = ovsdb_error_to_string(error);
317 ovsdb_error_destroy(error);
318 unixctl_command_reply(conn, 503, s);
323 /* "ovsdb-server/reconnect": makes ovsdb-server drop all of its JSON-RPC
324 * connections and reconnect. */
326 ovsdb_server_reconnect(struct unixctl_conn *conn, const char *args OVS_UNUSED,
329 struct ovsdb_jsonrpc_server *jsonrpc = jsonrpc_;
331 ovsdb_jsonrpc_server_reconnect(jsonrpc);
332 unixctl_command_reply(conn, 200, NULL);
336 parse_options(int argc, char *argv[], char **file_namep,
337 struct shash *remotes, char **unixctl_pathp,
341 OPT_DUMMY = UCHAR_MAX + 1,
345 OPT_BOOTSTRAP_CA_CERT,
347 LEAK_CHECKER_OPTION_ENUMS
349 static struct option long_options[] = {
350 {"remote", required_argument, 0, OPT_REMOTE},
351 {"unixctl", required_argument, 0, OPT_UNIXCTL},
352 {"run", required_argument, 0, OPT_RUN},
353 {"help", no_argument, 0, 'h'},
354 {"version", no_argument, 0, 'V'},
357 LEAK_CHECKER_LONG_OPTIONS,
359 {"bootstrap-ca-cert", required_argument, 0, OPT_BOOTSTRAP_CA_CERT},
360 {"private-key", required_argument, 0, 'p'},
361 {"certificate", required_argument, 0, 'c'},
362 {"ca-cert", required_argument, 0, 'C'},
366 char *short_options = long_options_to_short_options(long_options);
372 c = getopt_long(argc, argv, short_options, long_options, NULL);
379 shash_add_once(remotes, optarg, NULL);
383 *unixctl_pathp = optarg;
387 *run_command = optarg;
394 OVS_PRINT_VERSION(0, 0);
398 DAEMON_OPTION_HANDLERS
399 LEAK_CHECKER_OPTION_HANDLERS
403 private_key_file = optarg;
407 certificate_file = optarg;
411 ca_cert_file = optarg;
412 bootstrap_ca_cert = false;
415 case OPT_BOOTSTRAP_CA_CERT:
416 ca_cert_file = optarg;
417 bootstrap_ca_cert = true;
434 ovs_fatal(0, "database file is only non-option argument; "
435 "use --help for usage");
436 } else if (argc < 1) {
437 ovs_fatal(0, "missing database file argument; use --help for usage");
440 *file_namep = argv[0];
446 printf("%s: Open vSwitch database server\n"
447 "usage: %s [OPTIONS] DATABASE\n"
448 "where DATABASE is a database file in ovsdb format.\n",
449 program_name, program_name);
450 printf("\nJSON-RPC options (may be specified any number of times):\n"
451 " --remote=REMOTE connect or listen to REMOTE\n");
452 stream_usage("JSON-RPC", true, true, true);
455 printf("\nOther options:\n"
456 " --run COMMAND run COMMAND as subprocess then exit\n"
457 " --unixctl=SOCKET override default control socket name\n"
458 " -h, --help display this help message\n"
459 " -V, --version display version information\n");
460 leak_checker_usage();