1 /* Copyright (c) 2009, 2010, 2011 Nicira, Inc.
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.
25 #include "command-line.h"
32 #include "jsonrpc-server.h"
33 #include "leak-checker.h"
36 #include "ovsdb-data.h"
37 #include "ovsdb-types.h"
38 #include "ovsdb-error.h"
39 #include "poll-loop.h"
42 #include "stream-ssl.h"
48 #include "transaction.h"
54 VLOG_DEFINE_THIS_MODULE(ovsdb_server);
56 /* SSL configuration. */
57 static char *private_key_file;
58 static char *certificate_file;
59 static char *ca_cert_file;
60 static bool bootstrap_ca_cert;
62 static unixctl_cb_func ovsdb_server_exit;
63 static unixctl_cb_func ovsdb_server_compact;
64 static unixctl_cb_func ovsdb_server_reconnect;
66 static void parse_options(int argc, char *argv[], char **file_namep,
67 struct sset *remotes, char **unixctl_pathp,
69 static void usage(void) NO_RETURN;
71 static void reconfigure_from_db(struct ovsdb_jsonrpc_server *jsonrpc,
72 const struct ovsdb *db, struct sset *remotes);
74 static void update_remote_status(const struct ovsdb_jsonrpc_server *jsonrpc,
75 const struct sset *remotes,
79 main(int argc, char *argv[])
81 char *unixctl_path = NULL;
82 char *run_command = NULL;
83 struct unixctl_server *unixctl;
84 struct ovsdb_jsonrpc_server *jsonrpc;
86 struct ovsdb_error *error;
87 struct ovsdb_file *file;
89 struct process *run_process;
93 long long int status_timer = LLONG_MIN;
95 proctitle_init(argc, argv);
96 set_program_name(argv[0]);
97 stress_init_command();
98 signal(SIGPIPE, SIG_IGN);
101 parse_options(argc, argv, &file_name, &remotes, &unixctl_path,
106 error = ovsdb_file_open(file_name, false, &db, &file);
108 ovs_fatal(0, "%s", ovsdb_error_to_string(error));
112 jsonrpc = ovsdb_jsonrpc_server_create(db);
113 reconfigure_from_db(jsonrpc, db, &remotes);
115 retval = unixctl_server_create(unixctl_path, &unixctl);
123 run_argv[0] = "/bin/sh";
125 run_argv[2] = run_command;
128 retval = process_start(run_argv, NULL, 0, NULL, 0, &run_process);
130 ovs_fatal(retval, "%s: process failed to start", run_command);
136 daemonize_complete();
138 unixctl_command_register("exit", "", 0, 0, ovsdb_server_exit, &exiting);
139 unixctl_command_register("ovsdb-server/compact", "", 0, 0,
140 ovsdb_server_compact, file);
141 unixctl_command_register("ovsdb-server/reconnect", "", 0, 0,
142 ovsdb_server_reconnect, jsonrpc);
146 reconfigure_from_db(jsonrpc, db, &remotes);
147 ovsdb_jsonrpc_server_run(jsonrpc);
148 unixctl_server_run(unixctl);
149 ovsdb_trigger_run(db, time_msec());
150 if (run_process && process_exited(run_process)) {
154 /* update Manager status(es) every 5 seconds */
155 if (time_msec() >= status_timer) {
156 status_timer = time_msec() + 5000;
157 update_remote_status(jsonrpc, &remotes, db);
160 ovsdb_jsonrpc_server_wait(jsonrpc);
161 unixctl_server_wait(unixctl);
162 ovsdb_trigger_wait(db, time_msec());
164 process_wait(run_process);
167 poll_immediate_wake();
169 poll_timer_wait_until(status_timer);
172 ovsdb_jsonrpc_server_destroy(jsonrpc);
174 sset_destroy(&remotes);
175 unixctl_server_destroy(unixctl);
177 if (run_process && process_exited(run_process)) {
178 int status = process_status(run_process);
180 ovs_fatal(0, "%s: child exited, %s",
181 run_command, process_status_msg(status));
189 parse_db_column(const struct ovsdb *db,
191 const struct ovsdb_table **tablep,
192 const struct ovsdb_column **columnp)
194 char *name, *table_name, *column_name;
195 const struct ovsdb_column *column;
196 const struct ovsdb_table *table;
197 char *save_ptr = NULL;
199 name = xstrdup(name_);
200 strtok_r(name, ":", &save_ptr); /* "db:" */
201 table_name = strtok_r(NULL, ",", &save_ptr);
202 column_name = strtok_r(NULL, ",", &save_ptr);
203 if (!table_name || !column_name) {
204 ovs_fatal(0, "\"%s\": invalid syntax", name_);
207 table = ovsdb_get_table(db, table_name);
209 ovs_fatal(0, "\"%s\": no table named %s", name_, table_name);
212 column = ovsdb_table_schema_get_column(table->schema, column_name);
214 ovs_fatal(0, "\"%s\": table \"%s\" has no column \"%s\"",
215 name_, table_name, column_name);
224 parse_db_string_column(const struct ovsdb *db,
226 const struct ovsdb_table **tablep,
227 const struct ovsdb_column **columnp)
229 const struct ovsdb_column *column;
230 const struct ovsdb_table *table;
232 parse_db_column(db, name, &table, &column);
234 if (column->type.key.type != OVSDB_TYPE_STRING
235 || column->type.value.type != OVSDB_TYPE_VOID) {
236 ovs_fatal(0, "\"%s\": table \"%s\" column \"%s\" is "
237 "not string or set of strings",
238 name, table->schema->name, column->name);
245 static OVS_UNUSED const char *
246 query_db_string(const struct ovsdb *db, const char *name)
248 if (!name || strncmp(name, "db:", 3)) {
251 const struct ovsdb_column *column;
252 const struct ovsdb_table *table;
253 const struct ovsdb_row *row;
255 parse_db_string_column(db, name, &table, &column);
257 HMAP_FOR_EACH (row, hmap_node, &table->rows) {
258 const struct ovsdb_datum *datum;
261 datum = &row->fields[column->index];
262 for (i = 0; i < datum->n; i++) {
263 if (datum->keys[i].string[0]) {
264 return datum->keys[i].string;
272 static struct ovsdb_jsonrpc_options *
273 add_remote(struct shash *remotes, const char *target)
275 struct ovsdb_jsonrpc_options *options;
277 options = shash_find_data(remotes, target);
279 options = ovsdb_jsonrpc_default_options(target);
280 shash_add(remotes, target, options);
286 static struct ovsdb_datum *
287 get_datum(struct ovsdb_row *row, const char *column_name,
288 const enum ovsdb_atomic_type key_type,
289 const enum ovsdb_atomic_type value_type,
292 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
293 const struct ovsdb_table_schema *schema = row->table->schema;
294 const struct ovsdb_column *column;
296 column = ovsdb_table_schema_get_column(schema, column_name);
298 VLOG_DBG_RL(&rl, "Table `%s' has no `%s' column",
299 schema->name, column_name);
303 if (column->type.key.type != key_type
304 || column->type.value.type != value_type
305 || column->type.n_max != n_max) {
306 if (!VLOG_DROP_DBG(&rl)) {
307 char *type_name = ovsdb_type_to_english(&column->type);
308 VLOG_DBG("Table `%s' column `%s' has type %s, not expected "
309 "key type %s, value type %s, max elements %zd.",
310 schema->name, column_name, type_name,
311 ovsdb_atomic_type_to_string(key_type),
312 ovsdb_atomic_type_to_string(value_type),
319 return &row->fields[column->index];
322 /* Read string-string key-values from a map. Returns the value associated with
323 * 'key', if found, or NULL */
325 read_map_string_column(const struct ovsdb_row *row, const char *column_name,
328 const struct ovsdb_datum *datum;
329 union ovsdb_atom *atom_key = NULL, *atom_value = NULL;
332 datum = get_datum((struct ovsdb_row *) row, column_name, OVSDB_TYPE_STRING,
333 OVSDB_TYPE_STRING, UINT_MAX);
339 for (i = 0; i < datum->n; i++) {
340 atom_key = &datum->keys[i];
341 if (!strcmp(atom_key->string, key)){
342 atom_value = &datum->values[i];
347 return atom_value ? atom_value->string : NULL;
350 static const union ovsdb_atom *
351 read_column(const struct ovsdb_row *row, const char *column_name,
352 enum ovsdb_atomic_type type)
354 const struct ovsdb_datum *datum;
356 datum = get_datum((struct ovsdb_row *) row, column_name, type, OVSDB_TYPE_VOID,
358 return datum && datum->n ? datum->keys : NULL;
362 read_integer_column(const struct ovsdb_row *row, const char *column_name,
363 long long int *integerp)
365 const union ovsdb_atom *atom;
367 atom = read_column(row, column_name, OVSDB_TYPE_INTEGER);
368 *integerp = atom ? atom->integer : 0;
373 read_string_column(const struct ovsdb_row *row, const char *column_name,
374 const char **stringp)
376 const union ovsdb_atom *atom;
378 atom = read_column(row, column_name, OVSDB_TYPE_STRING);
379 *stringp = atom ? atom->string : NULL;
384 write_bool_column(struct ovsdb_row *row, const char *column_name, bool value)
386 struct ovsdb_datum *datum = get_datum(row, column_name, OVSDB_TYPE_BOOLEAN,
392 datum->keys[0].boolean = value;
396 write_string_string_column(struct ovsdb_row *row, const char *column_name,
397 char **keys, char **values, size_t n)
399 const struct ovsdb_column *column;
400 struct ovsdb_datum *datum;
403 column = ovsdb_table_schema_get_column(row->table->schema, column_name);
404 datum = get_datum(row, column_name, OVSDB_TYPE_STRING, OVSDB_TYPE_STRING,
410 /* Free existing data. */
411 ovsdb_datum_destroy(datum, &column->type);
413 /* Allocate space for new values. */
415 datum->keys = xmalloc(n * sizeof *datum->keys);
416 datum->values = xmalloc(n * sizeof *datum->values);
418 for (i = 0; i < n; ++i) {
419 datum->keys[i].string = keys[i];
420 datum->values[i].string = values[i];
423 /* Sort and check constraints. */
424 ovsdb_datum_sort_assert(datum, column->type.key.type);
427 /* Adds a remote and options to 'remotes', based on the Manager table row in
430 add_manager_options(struct shash *remotes, const struct ovsdb_row *row)
432 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
433 struct ovsdb_jsonrpc_options *options;
434 long long int max_backoff, probe_interval;
435 const char *target, *dscp_string;
437 if (!read_string_column(row, "target", &target) || !target) {
438 VLOG_INFO_RL(&rl, "Table `%s' has missing or invalid `target' column",
439 row->table->schema->name);
443 options = add_remote(remotes, target);
444 if (read_integer_column(row, "max_backoff", &max_backoff)) {
445 options->max_backoff = max_backoff;
447 if (read_integer_column(row, "inactivity_probe", &probe_interval)) {
448 options->probe_interval = probe_interval;
451 options->dscp = DSCP_DEFAULT;
452 dscp_string = read_map_string_column(row, "other_config", "dscp");
454 int dscp = atoi(dscp_string);
455 if (dscp >= 0 && dscp <= 63) {
456 options->dscp = dscp;
462 query_db_remotes(const char *name, const struct ovsdb *db,
463 struct shash *remotes)
465 const struct ovsdb_column *column;
466 const struct ovsdb_table *table;
467 const struct ovsdb_row *row;
469 parse_db_column(db, name, &table, &column);
471 if (column->type.key.type == OVSDB_TYPE_STRING
472 && column->type.value.type == OVSDB_TYPE_VOID) {
473 HMAP_FOR_EACH (row, hmap_node, &table->rows) {
474 const struct ovsdb_datum *datum;
477 datum = &row->fields[column->index];
478 for (i = 0; i < datum->n; i++) {
479 add_remote(remotes, datum->keys[i].string);
482 } else if (column->type.key.type == OVSDB_TYPE_UUID
483 && column->type.key.u.uuid.refTable
484 && column->type.value.type == OVSDB_TYPE_VOID) {
485 const struct ovsdb_table *ref_table = column->type.key.u.uuid.refTable;
486 HMAP_FOR_EACH (row, hmap_node, &table->rows) {
487 const struct ovsdb_datum *datum;
490 datum = &row->fields[column->index];
491 for (i = 0; i < datum->n; i++) {
492 const struct ovsdb_row *ref_row;
494 ref_row = ovsdb_table_get_row(ref_table, &datum->keys[i].uuid);
496 add_manager_options(remotes, ref_row);
504 update_remote_row(const struct ovsdb_row *row, struct ovsdb_txn *txn,
505 const struct ovsdb_jsonrpc_server *jsonrpc)
507 struct ovsdb_jsonrpc_remote_status status;
508 struct ovsdb_row *rw_row;
510 char *keys[8], *values[8];
513 /* Get the "target" (protocol/host/port) spec. */
514 if (!read_string_column(row, "target", &target)) {
515 /* Bad remote spec or incorrect schema. */
518 rw_row = ovsdb_txn_row_modify(txn, row);
519 ovsdb_jsonrpc_server_get_remote_status(jsonrpc, target, &status);
521 /* Update status information columns. */
522 write_bool_column(rw_row, "is_connected", status.is_connected);
525 keys[n] = xstrdup("state");
526 values[n++] = xstrdup(status.state);
528 if (status.sec_since_connect != UINT_MAX) {
529 keys[n] = xstrdup("sec_since_connect");
530 values[n++] = xasprintf("%u", status.sec_since_connect);
532 if (status.sec_since_disconnect != UINT_MAX) {
533 keys[n] = xstrdup("sec_since_disconnect");
534 values[n++] = xasprintf("%u", status.sec_since_disconnect);
536 if (status.last_error) {
537 keys[n] = xstrdup("last_error");
539 xstrdup(ovs_retval_to_string(status.last_error));
541 if (status.locks_held && status.locks_held[0]) {
542 keys[n] = xstrdup("locks_held");
543 values[n++] = xstrdup(status.locks_held);
545 if (status.locks_waiting && status.locks_waiting[0]) {
546 keys[n] = xstrdup("locks_waiting");
547 values[n++] = xstrdup(status.locks_waiting);
549 if (status.locks_lost && status.locks_lost[0]) {
550 keys[n] = xstrdup("locks_lost");
551 values[n++] = xstrdup(status.locks_lost);
553 if (status.n_connections > 1) {
554 keys[n] = xstrdup("n_connections");
555 values[n++] = xasprintf("%d", status.n_connections);
557 write_string_string_column(rw_row, "status", keys, values, n);
559 ovsdb_jsonrpc_server_free_remote_status(&status);
563 update_remote_rows(const struct ovsdb *db, struct ovsdb_txn *txn,
564 const char *remote_name,
565 const struct ovsdb_jsonrpc_server *jsonrpc)
567 const struct ovsdb_table *table, *ref_table;
568 const struct ovsdb_column *column;
569 const struct ovsdb_row *row;
571 if (strncmp("db:", remote_name, 3)) {
575 parse_db_column(db, remote_name, &table, &column);
577 if (column->type.key.type != OVSDB_TYPE_UUID
578 || !column->type.key.u.uuid.refTable
579 || column->type.value.type != OVSDB_TYPE_VOID) {
583 ref_table = column->type.key.u.uuid.refTable;
585 HMAP_FOR_EACH (row, hmap_node, &table->rows) {
586 const struct ovsdb_datum *datum;
589 datum = &row->fields[column->index];
590 for (i = 0; i < datum->n; i++) {
591 const struct ovsdb_row *ref_row;
593 ref_row = ovsdb_table_get_row(ref_table, &datum->keys[i].uuid);
595 update_remote_row(ref_row, txn, jsonrpc);
602 update_remote_status(const struct ovsdb_jsonrpc_server *jsonrpc,
603 const struct sset *remotes, struct ovsdb *db)
605 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
606 struct ovsdb_txn *txn;
607 const bool durable_txn = false;
608 struct ovsdb_error *error;
611 txn = ovsdb_txn_create(db);
613 /* Iterate over --remote arguments given on command line. */
614 SSET_FOR_EACH (remote, remotes) {
615 update_remote_rows(db, txn, remote, jsonrpc);
618 error = ovsdb_txn_commit(txn, durable_txn);
620 VLOG_ERR_RL(&rl, "Failed to update remote status: %s",
621 ovsdb_error_to_string(error));
625 /* Reconfigures ovsdb-server based on information in the database. */
627 reconfigure_from_db(struct ovsdb_jsonrpc_server *jsonrpc,
628 const struct ovsdb *db, struct sset *remotes)
630 struct shash resolved_remotes;
633 /* Configure remotes. */
634 shash_init(&resolved_remotes);
635 SSET_FOR_EACH (name, remotes) {
636 if (!strncmp(name, "db:", 3)) {
637 query_db_remotes(name, db, &resolved_remotes);
639 add_remote(&resolved_remotes, name);
642 ovsdb_jsonrpc_server_set_remotes(jsonrpc, &resolved_remotes);
643 shash_destroy_free_data(&resolved_remotes);
646 stream_ssl_set_key_and_cert(query_db_string(db, private_key_file),
647 query_db_string(db, certificate_file));
648 stream_ssl_set_ca_cert_file(query_db_string(db, ca_cert_file),
653 ovsdb_server_exit(struct unixctl_conn *conn, int argc OVS_UNUSED,
654 const char *argv[] OVS_UNUSED,
657 bool *exiting = exiting_;
659 unixctl_command_reply(conn, NULL);
663 ovsdb_server_compact(struct unixctl_conn *conn, int argc OVS_UNUSED,
664 const char *argv[] OVS_UNUSED, void *file_)
666 struct ovsdb_file *file = file_;
667 struct ovsdb_error *error;
669 VLOG_INFO("compacting database by user request");
670 error = ovsdb_file_compact(file);
672 unixctl_command_reply(conn, NULL);
674 char *s = ovsdb_error_to_string(error);
675 ovsdb_error_destroy(error);
676 unixctl_command_reply_error(conn, s);
681 /* "ovsdb-server/reconnect": makes ovsdb-server drop all of its JSON-RPC
682 * connections and reconnect. */
684 ovsdb_server_reconnect(struct unixctl_conn *conn, int argc OVS_UNUSED,
685 const char *argv[] OVS_UNUSED, void *jsonrpc_)
687 struct ovsdb_jsonrpc_server *jsonrpc = jsonrpc_;
689 ovsdb_jsonrpc_server_reconnect(jsonrpc);
690 unixctl_command_reply(conn, NULL);
694 parse_options(int argc, char *argv[], char **file_namep,
695 struct sset *remotes, char **unixctl_pathp,
699 OPT_DUMMY = UCHAR_MAX + 1,
703 OPT_BOOTSTRAP_CA_CERT,
705 LEAK_CHECKER_OPTION_ENUMS,
708 static struct option long_options[] = {
709 {"remote", required_argument, NULL, OPT_REMOTE},
710 {"unixctl", required_argument, NULL, OPT_UNIXCTL},
711 {"run", required_argument, NULL, OPT_RUN},
712 {"help", no_argument, NULL, 'h'},
713 {"version", no_argument, NULL, 'V'},
716 LEAK_CHECKER_LONG_OPTIONS,
717 {"bootstrap-ca-cert", required_argument, NULL, OPT_BOOTSTRAP_CA_CERT},
718 {"private-key", required_argument, NULL, 'p'},
719 {"certificate", required_argument, NULL, 'c'},
720 {"ca-cert", required_argument, NULL, 'C'},
723 char *short_options = long_options_to_short_options(long_options);
729 c = getopt_long(argc, argv, short_options, long_options, NULL);
736 sset_add(remotes, optarg);
740 *unixctl_pathp = optarg;
744 *run_command = optarg;
751 ovs_print_version(0, 0);
755 DAEMON_OPTION_HANDLERS
756 LEAK_CHECKER_OPTION_HANDLERS
759 private_key_file = optarg;
763 certificate_file = optarg;
767 ca_cert_file = optarg;
768 bootstrap_ca_cert = false;
771 case OPT_BOOTSTRAP_CA_CERT:
772 ca_cert_file = optarg;
773 bootstrap_ca_cert = true;
790 *file_namep = xasprintf("%s/openvswitch/conf.db", ovs_sysconfdir());
794 *file_namep = xstrdup(argv[0]);
798 ovs_fatal(0, "database file is only non-option argument; "
799 "use --help for usage");
806 printf("%s: Open vSwitch database server\n"
807 "usage: %s [OPTIONS] DATABASE\n"
808 "where DATABASE is a database file in ovsdb format.\n",
809 program_name, program_name);
810 printf("\nJSON-RPC options (may be specified any number of times):\n"
811 " --remote=REMOTE connect or listen to REMOTE\n");
812 stream_usage("JSON-RPC", true, true, true);
815 printf("\nOther options:\n"
816 " --run COMMAND run COMMAND as subprocess then exit\n"
817 " --unixctl=SOCKET override default control socket name\n"
818 " -h, --help display this help message\n"
819 " -V, --version display version information\n");
820 leak_checker_usage();