1 /* Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014 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.
26 #include "command-line.h"
29 #include "openvswitch/dynamic-string.h"
30 #include "fatal-signal.h"
35 #include "jsonrpc-server.h"
36 #include "openvswitch/list.h"
40 #include "ovsdb-data.h"
41 #include "ovsdb-types.h"
42 #include "ovsdb-error.h"
43 #include "poll-loop.h"
48 #include "stream-ssl.h"
53 #include "transaction.h"
57 #include "perf-counter.h"
58 #include "openvswitch/vlog.h"
60 VLOG_DEFINE_THIS_MODULE(ovsdb_server);
63 /* Initialized in main(). */
65 struct ovsdb_file *file;
68 /* Only used by update_remote_status(). */
69 struct ovsdb_txn *txn;
72 /* SSL configuration. */
73 static char *private_key_file;
74 static char *certificate_file;
75 static char *ca_cert_file;
76 static bool bootstrap_ca_cert;
78 static unixctl_cb_func ovsdb_server_exit;
79 static unixctl_cb_func ovsdb_server_compact;
80 static unixctl_cb_func ovsdb_server_reconnect;
81 static unixctl_cb_func ovsdb_server_perf_counters_clear;
82 static unixctl_cb_func ovsdb_server_perf_counters_show;
83 static unixctl_cb_func ovsdb_server_disable_monitor2;
85 struct server_config {
87 struct shash *all_dbs;
89 struct ovsdb_jsonrpc_server *jsonrpc;
91 static unixctl_cb_func ovsdb_server_add_remote;
92 static unixctl_cb_func ovsdb_server_remove_remote;
93 static unixctl_cb_func ovsdb_server_list_remotes;
95 static unixctl_cb_func ovsdb_server_add_database;
96 static unixctl_cb_func ovsdb_server_remove_database;
97 static unixctl_cb_func ovsdb_server_list_databases;
99 static char *open_db(struct server_config *config, const char *filename);
100 static void close_db(struct db *db);
102 static void parse_options(int *argc, char **argvp[],
103 struct sset *remotes, char **unixctl_pathp,
105 OVS_NO_RETURN static void usage(void);
107 static char *reconfigure_remotes(struct ovsdb_jsonrpc_server *,
108 const struct shash *all_dbs,
109 struct sset *remotes);
110 static char *reconfigure_ssl(const struct shash *all_dbs);
111 static void report_error_if_changed(char *error, char **last_errorp);
113 static void update_remote_status(const struct ovsdb_jsonrpc_server *jsonrpc,
114 const struct sset *remotes,
115 struct shash *all_dbs);
117 static void save_config__(FILE *config_file, const struct sset *remotes,
118 const struct sset *db_filenames);
119 static void save_config(struct server_config *);
120 static void load_config(FILE *config_file, struct sset *remotes,
121 struct sset *db_filenames);
124 main_loop(struct ovsdb_jsonrpc_server *jsonrpc, struct shash *all_dbs,
125 struct unixctl_server *unixctl, struct sset *remotes,
126 struct process *run_process, bool *exiting)
128 char *remotes_error, *ssl_error;
129 struct shash_node *node;
130 long long int status_timer = LLONG_MIN;
134 remotes_error = NULL;
137 if (memory_should_report()) {
141 ovsdb_jsonrpc_server_get_memory_usage(jsonrpc, &usage);
142 ovsdb_monitor_get_memory_usage(&usage);
143 SHASH_FOR_EACH(node, all_dbs) {
144 struct db *db = node->data;
145 ovsdb_get_memory_usage(db->db, &usage);
147 memory_report(&usage);
148 simap_destroy(&usage);
151 /* Run unixctl_server_run() before reconfigure_remotes() because
152 * ovsdb-server/add-remote and ovsdb-server/remove-remote can change
153 * the set of remotes that reconfigure_remotes() uses. */
154 unixctl_server_run(unixctl);
156 report_error_if_changed(
157 reconfigure_remotes(jsonrpc, all_dbs, remotes),
159 report_error_if_changed(reconfigure_ssl(all_dbs), &ssl_error);
160 ovsdb_jsonrpc_server_run(jsonrpc);
162 SHASH_FOR_EACH(node, all_dbs) {
163 struct db *db = node->data;
164 ovsdb_trigger_run(db->db, time_msec());
168 if (process_exited(run_process)) {
173 /* update Manager status(es) every 5 seconds */
174 if (time_msec() >= status_timer) {
175 status_timer = time_msec() + 5000;
176 update_remote_status(jsonrpc, remotes, all_dbs);
180 ovsdb_jsonrpc_server_wait(jsonrpc);
181 unixctl_server_wait(unixctl);
182 SHASH_FOR_EACH(node, all_dbs) {
183 struct db *db = node->data;
184 ovsdb_trigger_wait(db->db, time_msec());
187 process_wait(run_process);
190 poll_immediate_wake();
192 poll_timer_wait_until(status_timer);
194 if (should_service_stop()) {
203 main(int argc, char *argv[])
205 char *unixctl_path = NULL;
206 char *run_command = NULL;
207 struct unixctl_server *unixctl;
208 struct ovsdb_jsonrpc_server *jsonrpc;
209 struct sset remotes, db_filenames;
210 const char *db_filename;
211 struct process *run_process;
214 FILE *config_tmpfile;
215 struct server_config server_config;
216 struct shash all_dbs;
217 struct shash_node *node, *next;
221 ovs_cmdl_proctitle_init(argc, argv);
222 set_program_name(argv[0]);
223 service_start(&argc, &argv);
224 fatal_ignore_sigpipe();
227 parse_options(&argc, &argv, &remotes, &unixctl_path, &run_command);
228 daemon_become_new_user(false);
230 /* Create and initialize 'config_tmpfile' as a temporary file to hold
231 * ovsdb-server's most basic configuration, and then save our initial
232 * configuration to it. When --monitor is used, this preserves the effects
233 * of ovs-appctl commands such as ovsdb-server/add-remote (which saves the
234 * new configuration) across crashes. */
235 config_tmpfile = tmpfile();
236 if (!config_tmpfile) {
237 ovs_fatal(errno, "failed to create temporary file");
240 sset_init(&db_filenames);
242 for (i = 0; i < argc; i++) {
243 sset_add(&db_filenames, argv[i]);
246 char *default_db = xasprintf("%s/conf.db", ovs_dbdir());
247 sset_add(&db_filenames, default_db);
251 server_config.remotes = &remotes;
252 server_config.config_tmpfile = config_tmpfile;
254 save_config__(config_tmpfile, &remotes, &db_filenames);
256 daemonize_start(false);
258 /* Load the saved config. */
259 load_config(config_tmpfile, &remotes, &db_filenames);
260 jsonrpc = ovsdb_jsonrpc_server_create();
262 shash_init(&all_dbs);
263 server_config.all_dbs = &all_dbs;
264 server_config.jsonrpc = jsonrpc;
266 perf_counters_init();
268 SSET_FOR_EACH (db_filename, &db_filenames) {
269 error = open_db(&server_config, db_filename);
271 ovs_fatal(0, "%s", error);
275 error = reconfigure_remotes(jsonrpc, &all_dbs, &remotes);
277 error = reconfigure_ssl(&all_dbs);
280 ovs_fatal(0, "%s", error);
283 retval = unixctl_server_create(unixctl_path, &unixctl);
291 run_argv[0] = "/bin/sh";
293 run_argv[2] = run_command;
296 retval = process_start(run_argv, &run_process);
298 ovs_fatal(retval, "%s: process failed to start", run_command);
304 daemonize_complete();
307 /* ovsdb-server is usually a long-running process, in which case it
308 * makes plenty of sense to log the version, but --run makes
309 * ovsdb-server more like a command-line tool, so skip it. */
310 VLOG_INFO("%s (Open vSwitch) %s", program_name, VERSION);
313 unixctl_command_register("exit", "", 0, 0, ovsdb_server_exit, &exiting);
314 unixctl_command_register("ovsdb-server/compact", "", 0, 1,
315 ovsdb_server_compact, &all_dbs);
316 unixctl_command_register("ovsdb-server/reconnect", "", 0, 0,
317 ovsdb_server_reconnect, jsonrpc);
319 unixctl_command_register("ovsdb-server/add-remote", "REMOTE", 1, 1,
320 ovsdb_server_add_remote, &server_config);
321 unixctl_command_register("ovsdb-server/remove-remote", "REMOTE", 1, 1,
322 ovsdb_server_remove_remote, &server_config);
323 unixctl_command_register("ovsdb-server/list-remotes", "", 0, 0,
324 ovsdb_server_list_remotes, &remotes);
326 unixctl_command_register("ovsdb-server/add-db", "DB", 1, 1,
327 ovsdb_server_add_database, &server_config);
328 unixctl_command_register("ovsdb-server/remove-db", "DB", 1, 1,
329 ovsdb_server_remove_database, &server_config);
330 unixctl_command_register("ovsdb-server/list-dbs", "", 0, 0,
331 ovsdb_server_list_databases, &all_dbs);
332 unixctl_command_register("ovsdb-server/perf-counters-show", "", 0, 0,
333 ovsdb_server_perf_counters_show, NULL);
334 unixctl_command_register("ovsdb-server/perf-counters-clear", "", 0, 0,
335 ovsdb_server_perf_counters_clear, NULL);
337 /* Simulate the behavior of OVS release prior to version 2.5 that
338 * does not support the monitor2 method. */
339 unixctl_command_register("ovsdb-server/disable-monitor2", "", 0, 0,
340 ovsdb_server_disable_monitor2, jsonrpc);
342 main_loop(jsonrpc, &all_dbs, unixctl, &remotes, run_process, &exiting);
344 ovsdb_jsonrpc_server_destroy(jsonrpc);
345 SHASH_FOR_EACH_SAFE(node, next, &all_dbs) {
346 struct db *db = node->data;
348 shash_delete(&all_dbs, node);
350 shash_destroy(&all_dbs);
351 sset_destroy(&remotes);
352 sset_destroy(&db_filenames);
353 unixctl_server_destroy(unixctl);
355 if (run_process && process_exited(run_process)) {
356 int status = process_status(run_process);
358 ovs_fatal(0, "%s: child exited, %s",
359 run_command, process_status_msg(status));
362 perf_counters_destroy();
367 /* Returns true if 'filename' is known to be already open as a database,
370 * "False negatives" are possible. */
372 is_already_open(struct server_config *config OVS_UNUSED,
373 const char *filename OVS_UNUSED)
378 if (!stat(filename, &s)) {
379 struct shash_node *node;
381 SHASH_FOR_EACH (node, config->all_dbs) {
382 struct db *db = node->data;
385 if (!stat(db->filename, &s2)
386 && s.st_dev == s2.st_dev
387 && s.st_ino == s2.st_ino) {
398 close_db(struct db *db)
400 ovsdb_destroy(db->db);
406 open_db(struct server_config *config, const char *filename)
408 struct ovsdb_error *db_error;
412 /* If we know that the file is already open, return a good error message.
413 * Otherwise, if the file is open, we'll fail later on with a harder to
414 * interpret file locking error. */
415 if (is_already_open(config, filename)) {
416 return xasprintf("%s: already open", filename);
419 db = xzalloc(sizeof *db);
420 db->filename = xstrdup(filename);
422 db_error = ovsdb_file_open(db->filename, false, &db->db, &db->file);
424 error = ovsdb_error_to_string(db_error);
425 } else if (!ovsdb_jsonrpc_server_add_db(config->jsonrpc, db->db)) {
426 error = xasprintf("%s: duplicate database name", db->db->schema->name);
428 shash_add_assert(config->all_dbs, db->db->schema->name, db);
432 ovsdb_error_destroy(db_error);
437 static const struct db *
438 find_db(const struct shash *all_dbs, const char *db_name)
440 struct shash_node *node;
442 SHASH_FOR_EACH(node, all_dbs) {
443 struct db *db = node->data;
444 if (!strcmp(db->db->schema->name, db_name)) {
452 static char * OVS_WARN_UNUSED_RESULT
453 parse_db_column__(const struct shash *all_dbs,
454 const char *name_, char *name,
455 const struct db **dbp,
456 const struct ovsdb_table **tablep,
457 const struct ovsdb_column **columnp)
459 const char *db_name, *table_name, *column_name;
460 const struct ovsdb_column *column;
461 const struct ovsdb_table *table;
462 const char *tokens[3];
463 char *save_ptr = NULL;
470 strtok_r(name, ":", &save_ptr); /* "db:" */
471 tokens[0] = strtok_r(NULL, ",", &save_ptr);
472 tokens[1] = strtok_r(NULL, ",", &save_ptr);
473 tokens[2] = strtok_r(NULL, ",", &save_ptr);
474 if (!tokens[0] || !tokens[1] || !tokens[2]) {
475 return xasprintf("\"%s\": invalid syntax", name_);
479 table_name = tokens[1];
480 column_name = tokens[2];
482 db = find_db(all_dbs, tokens[0]);
484 return xasprintf("\"%s\": no database named %s", name_, db_name);
487 table = ovsdb_get_table(db->db, table_name);
489 return xasprintf("\"%s\": no table named %s", name_, table_name);
492 column = ovsdb_table_schema_get_column(table->schema, column_name);
494 return xasprintf("\"%s\": table \"%s\" has no column \"%s\"",
495 name_, table_name, column_name);
504 /* Returns NULL if successful, otherwise a malloc()'d string describing the
506 static char * OVS_WARN_UNUSED_RESULT
507 parse_db_column(const struct shash *all_dbs,
509 const struct db **dbp,
510 const struct ovsdb_table **tablep,
511 const struct ovsdb_column **columnp)
513 char *name = xstrdup(name_);
514 char *retval = parse_db_column__(all_dbs, name_, name,
515 dbp, tablep, columnp);
520 /* Returns NULL if successful, otherwise a malloc()'d string describing the
522 static char * OVS_WARN_UNUSED_RESULT
523 parse_db_string_column(const struct shash *all_dbs,
525 const struct db **dbp,
526 const struct ovsdb_table **tablep,
527 const struct ovsdb_column **columnp)
531 retval = parse_db_column(all_dbs, name, dbp, tablep, columnp);
536 if ((*columnp)->type.key.type != OVSDB_TYPE_STRING
537 || (*columnp)->type.value.type != OVSDB_TYPE_VOID) {
538 return xasprintf("\"%s\": table \"%s\" column \"%s\" is "
539 "not string or set of strings",
540 name, (*tablep)->schema->name, (*columnp)->name);
547 query_db_string(const struct shash *all_dbs, const char *name,
550 if (!name || strncmp(name, "db:", 3)) {
553 const struct ovsdb_column *column;
554 const struct ovsdb_table *table;
555 const struct ovsdb_row *row;
559 retval = parse_db_string_column(all_dbs, name,
560 &db, &table, &column);
562 ds_put_format(errors, "%s\n", retval);
567 HMAP_FOR_EACH (row, hmap_node, &table->rows) {
568 const struct ovsdb_datum *datum;
571 datum = &row->fields[column->index];
572 for (i = 0; i < datum->n; i++) {
573 if (datum->keys[i].string[0]) {
574 return datum->keys[i].string;
582 static struct ovsdb_jsonrpc_options *
583 add_remote(struct shash *remotes, const char *target)
585 struct ovsdb_jsonrpc_options *options;
587 options = shash_find_data(remotes, target);
589 options = ovsdb_jsonrpc_default_options(target);
590 shash_add(remotes, target, options);
596 static struct ovsdb_datum *
597 get_datum(struct ovsdb_row *row, const char *column_name,
598 const enum ovsdb_atomic_type key_type,
599 const enum ovsdb_atomic_type value_type,
602 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
603 const struct ovsdb_table_schema *schema = row->table->schema;
604 const struct ovsdb_column *column;
606 column = ovsdb_table_schema_get_column(schema, column_name);
608 VLOG_DBG_RL(&rl, "Table `%s' has no `%s' column",
609 schema->name, column_name);
613 if (column->type.key.type != key_type
614 || column->type.value.type != value_type
615 || column->type.n_max != n_max) {
616 if (!VLOG_DROP_DBG(&rl)) {
617 char *type_name = ovsdb_type_to_english(&column->type);
618 VLOG_DBG("Table `%s' column `%s' has type %s, not expected "
619 "key type %s, value type %s, max elements %"PRIuSIZE".",
620 schema->name, column_name, type_name,
621 ovsdb_atomic_type_to_string(key_type),
622 ovsdb_atomic_type_to_string(value_type),
629 return &row->fields[column->index];
632 /* Read string-string key-values from a map. Returns the value associated with
633 * 'key', if found, or NULL */
635 read_map_string_column(const struct ovsdb_row *row, const char *column_name,
638 const struct ovsdb_datum *datum;
639 union ovsdb_atom *atom_key = NULL, *atom_value = NULL;
642 datum = get_datum(CONST_CAST(struct ovsdb_row *, row), column_name,
643 OVSDB_TYPE_STRING, OVSDB_TYPE_STRING, UINT_MAX);
649 for (i = 0; i < datum->n; i++) {
650 atom_key = &datum->keys[i];
651 if (!strcmp(atom_key->string, key)){
652 atom_value = &datum->values[i];
657 return atom_value ? atom_value->string : NULL;
660 static const union ovsdb_atom *
661 read_column(const struct ovsdb_row *row, const char *column_name,
662 enum ovsdb_atomic_type type)
664 const struct ovsdb_datum *datum;
666 datum = get_datum(CONST_CAST(struct ovsdb_row *, row), column_name, type,
668 return datum && datum->n ? datum->keys : NULL;
672 read_integer_column(const struct ovsdb_row *row, const char *column_name,
673 long long int *integerp)
675 const union ovsdb_atom *atom;
677 atom = read_column(row, column_name, OVSDB_TYPE_INTEGER);
678 *integerp = atom ? atom->integer : 0;
683 read_string_column(const struct ovsdb_row *row, const char *column_name,
684 const char **stringp)
686 const union ovsdb_atom *atom;
688 atom = read_column(row, column_name, OVSDB_TYPE_STRING);
689 *stringp = atom ? atom->string : NULL;
694 write_bool_column(struct ovsdb_row *row, const char *column_name, bool value)
696 const struct ovsdb_column *column;
697 struct ovsdb_datum *datum;
699 column = ovsdb_table_schema_get_column(row->table->schema, column_name);
700 datum = get_datum(row, column_name, OVSDB_TYPE_BOOLEAN,
707 ovsdb_datum_destroy(datum, &column->type);
710 datum->keys = xmalloc(sizeof *datum->keys);
711 datum->values = NULL;
714 datum->keys[0].boolean = value;
718 write_string_string_column(struct ovsdb_row *row, const char *column_name,
719 char **keys, char **values, size_t n)
721 const struct ovsdb_column *column;
722 struct ovsdb_datum *datum;
725 column = ovsdb_table_schema_get_column(row->table->schema, column_name);
726 datum = get_datum(row, column_name, OVSDB_TYPE_STRING, OVSDB_TYPE_STRING,
729 for (i = 0; i < n; i++) {
736 /* Free existing data. */
737 ovsdb_datum_destroy(datum, &column->type);
739 /* Allocate space for new values. */
741 datum->keys = xmalloc(n * sizeof *datum->keys);
742 datum->values = xmalloc(n * sizeof *datum->values);
744 for (i = 0; i < n; ++i) {
745 datum->keys[i].string = keys[i];
746 datum->values[i].string = values[i];
749 /* Sort and check constraints. */
750 ovsdb_datum_sort_assert(datum, column->type.key.type);
753 /* Adds a remote and options to 'remotes', based on the Manager table row in
756 add_manager_options(struct shash *remotes, const struct ovsdb_row *row)
758 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
759 struct ovsdb_jsonrpc_options *options;
760 long long int max_backoff, probe_interval;
761 const char *target, *dscp_string;
763 if (!read_string_column(row, "target", &target) || !target) {
764 VLOG_INFO_RL(&rl, "Table `%s' has missing or invalid `target' column",
765 row->table->schema->name);
769 options = add_remote(remotes, target);
770 if (read_integer_column(row, "max_backoff", &max_backoff)) {
771 options->max_backoff = max_backoff;
773 if (read_integer_column(row, "inactivity_probe", &probe_interval)) {
774 options->probe_interval = probe_interval;
777 options->dscp = DSCP_DEFAULT;
778 dscp_string = read_map_string_column(row, "other_config", "dscp");
780 int dscp = atoi(dscp_string);
781 if (dscp >= 0 && dscp <= 63) {
782 options->dscp = dscp;
788 query_db_remotes(const char *name, const struct shash *all_dbs,
789 struct shash *remotes, struct ds *errors)
791 const struct ovsdb_column *column;
792 const struct ovsdb_table *table;
793 const struct ovsdb_row *row;
797 retval = parse_db_column(all_dbs, name, &db, &table, &column);
799 ds_put_format(errors, "%s\n", retval);
804 if (column->type.key.type == OVSDB_TYPE_STRING
805 && column->type.value.type == OVSDB_TYPE_VOID) {
806 HMAP_FOR_EACH (row, hmap_node, &table->rows) {
807 const struct ovsdb_datum *datum;
810 datum = &row->fields[column->index];
811 for (i = 0; i < datum->n; i++) {
812 add_remote(remotes, datum->keys[i].string);
815 } else if (column->type.key.type == OVSDB_TYPE_UUID
816 && column->type.key.u.uuid.refTable
817 && column->type.value.type == OVSDB_TYPE_VOID) {
818 const struct ovsdb_table *ref_table = column->type.key.u.uuid.refTable;
819 HMAP_FOR_EACH (row, hmap_node, &table->rows) {
820 const struct ovsdb_datum *datum;
823 datum = &row->fields[column->index];
824 for (i = 0; i < datum->n; i++) {
825 const struct ovsdb_row *ref_row;
827 ref_row = ovsdb_table_get_row(ref_table, &datum->keys[i].uuid);
829 add_manager_options(remotes, ref_row);
837 update_remote_row(const struct ovsdb_row *row, struct ovsdb_txn *txn,
838 const struct ovsdb_jsonrpc_server *jsonrpc)
840 struct ovsdb_jsonrpc_remote_status status;
841 struct ovsdb_row *rw_row;
843 char *keys[9], *values[9];
846 /* Get the "target" (protocol/host/port) spec. */
847 if (!read_string_column(row, "target", &target)) {
848 /* Bad remote spec or incorrect schema. */
851 rw_row = ovsdb_txn_row_modify(txn, row);
852 ovsdb_jsonrpc_server_get_remote_status(jsonrpc, target, &status);
854 /* Update status information columns. */
855 write_bool_column(rw_row, "is_connected", status.is_connected);
858 keys[n] = xstrdup("state");
859 values[n++] = xstrdup(status.state);
861 if (status.sec_since_connect != UINT_MAX) {
862 keys[n] = xstrdup("sec_since_connect");
863 values[n++] = xasprintf("%u", status.sec_since_connect);
865 if (status.sec_since_disconnect != UINT_MAX) {
866 keys[n] = xstrdup("sec_since_disconnect");
867 values[n++] = xasprintf("%u", status.sec_since_disconnect);
869 if (status.last_error) {
870 keys[n] = xstrdup("last_error");
872 xstrdup(ovs_retval_to_string(status.last_error));
874 if (status.locks_held && status.locks_held[0]) {
875 keys[n] = xstrdup("locks_held");
876 values[n++] = xstrdup(status.locks_held);
878 if (status.locks_waiting && status.locks_waiting[0]) {
879 keys[n] = xstrdup("locks_waiting");
880 values[n++] = xstrdup(status.locks_waiting);
882 if (status.locks_lost && status.locks_lost[0]) {
883 keys[n] = xstrdup("locks_lost");
884 values[n++] = xstrdup(status.locks_lost);
886 if (status.n_connections > 1) {
887 keys[n] = xstrdup("n_connections");
888 values[n++] = xasprintf("%d", status.n_connections);
890 if (status.bound_port != htons(0)) {
891 keys[n] = xstrdup("bound_port");
892 values[n++] = xasprintf("%"PRIu16, ntohs(status.bound_port));
894 write_string_string_column(rw_row, "status", keys, values, n);
896 ovsdb_jsonrpc_server_free_remote_status(&status);
900 update_remote_rows(const struct shash *all_dbs,
901 const char *remote_name,
902 const struct ovsdb_jsonrpc_server *jsonrpc)
904 const struct ovsdb_table *table, *ref_table;
905 const struct ovsdb_column *column;
906 const struct ovsdb_row *row;
910 if (strncmp("db:", remote_name, 3)) {
914 retval = parse_db_column(all_dbs, remote_name, &db, &table, &column);
920 if (column->type.key.type != OVSDB_TYPE_UUID
921 || !column->type.key.u.uuid.refTable
922 || column->type.value.type != OVSDB_TYPE_VOID) {
926 ref_table = column->type.key.u.uuid.refTable;
928 HMAP_FOR_EACH (row, hmap_node, &table->rows) {
929 const struct ovsdb_datum *datum;
932 datum = &row->fields[column->index];
933 for (i = 0; i < datum->n; i++) {
934 const struct ovsdb_row *ref_row;
936 ref_row = ovsdb_table_get_row(ref_table, &datum->keys[i].uuid);
938 update_remote_row(ref_row, db->txn, jsonrpc);
945 update_remote_status(const struct ovsdb_jsonrpc_server *jsonrpc,
946 const struct sset *remotes,
947 struct shash *all_dbs)
949 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
952 struct shash_node *node;
954 SHASH_FOR_EACH(node, all_dbs) {
956 db->txn = ovsdb_txn_create(db->db);
959 /* Iterate over --remote arguments given on command line. */
960 SSET_FOR_EACH (remote, remotes) {
961 update_remote_rows(all_dbs, remote, jsonrpc);
964 SHASH_FOR_EACH(node, all_dbs) {
965 struct ovsdb_error *error;
967 error = ovsdb_txn_commit(db->txn, false);
969 VLOG_ERR_RL(&rl, "Failed to update remote status: %s",
970 ovsdb_error_to_string(error));
971 ovsdb_error_destroy(error);
976 /* Reconfigures ovsdb-server's remotes based on information in the database. */
978 reconfigure_remotes(struct ovsdb_jsonrpc_server *jsonrpc,
979 const struct shash *all_dbs, struct sset *remotes)
981 struct ds errors = DS_EMPTY_INITIALIZER;
982 struct shash resolved_remotes;
985 /* Configure remotes. */
986 shash_init(&resolved_remotes);
987 SSET_FOR_EACH (name, remotes) {
988 if (!strncmp(name, "db:", 3)) {
989 query_db_remotes(name, all_dbs, &resolved_remotes, &errors);
991 add_remote(&resolved_remotes, name);
994 ovsdb_jsonrpc_server_set_remotes(jsonrpc, &resolved_remotes);
995 shash_destroy_free_data(&resolved_remotes);
997 return errors.string;
1001 reconfigure_ssl(const struct shash *all_dbs)
1003 struct ds errors = DS_EMPTY_INITIALIZER;
1004 const char *resolved_private_key;
1005 const char *resolved_certificate;
1006 const char *resolved_ca_cert;
1008 resolved_private_key = query_db_string(all_dbs, private_key_file, &errors);
1009 resolved_certificate = query_db_string(all_dbs, certificate_file, &errors);
1010 resolved_ca_cert = query_db_string(all_dbs, ca_cert_file, &errors);
1012 stream_ssl_set_key_and_cert(resolved_private_key, resolved_certificate);
1013 stream_ssl_set_ca_cert_file(resolved_ca_cert, bootstrap_ca_cert);
1015 return errors.string;
1019 report_error_if_changed(char *error, char **last_errorp)
1022 if (!*last_errorp || strcmp(error, *last_errorp)) {
1023 VLOG_WARN("%s", error);
1025 *last_errorp = error;
1031 *last_errorp = NULL;
1036 ovsdb_server_exit(struct unixctl_conn *conn, int argc OVS_UNUSED,
1037 const char *argv[] OVS_UNUSED,
1040 bool *exiting = exiting_;
1042 unixctl_command_reply(conn, NULL);
1046 ovsdb_server_perf_counters_show(struct unixctl_conn *conn, int argc OVS_UNUSED,
1047 const char *argv[] OVS_UNUSED,
1048 void *arg_ OVS_UNUSED)
1050 char *s = perf_counters_to_string();
1052 unixctl_command_reply(conn, s);
1057 ovsdb_server_perf_counters_clear(struct unixctl_conn *conn, int argc OVS_UNUSED,
1058 const char *argv[] OVS_UNUSED,
1059 void *arg_ OVS_UNUSED)
1061 perf_counters_clear();
1062 unixctl_command_reply(conn, NULL);
1065 /* "ovsdb-server/disable-monitor2": makes ovsdb-server drop all of its
1066 * JSON-RPC connections and reconnect. New sessions will not recognize
1067 * the 'monitor2' method. */
1069 ovsdb_server_disable_monitor2(struct unixctl_conn *conn, int argc OVS_UNUSED,
1070 const char *argv[] OVS_UNUSED, void *jsonrpc_)
1072 struct ovsdb_jsonrpc_server *jsonrpc = jsonrpc_;
1074 ovsdb_jsonrpc_disable_monitor2();
1075 ovsdb_jsonrpc_server_reconnect(jsonrpc);
1076 unixctl_command_reply(conn, NULL);
1080 ovsdb_server_compact(struct unixctl_conn *conn, int argc,
1081 const char *argv[], void *dbs_)
1083 struct shash *all_dbs = dbs_;
1086 struct shash_node *node;
1090 SHASH_FOR_EACH(node, all_dbs) {
1094 name = db->db->schema->name;
1096 if (argc < 2 || !strcmp(argv[1], name)) {
1097 struct ovsdb_error *error;
1099 VLOG_INFO("compacting %s database by user request", name);
1101 error = ovsdb_file_compact(db->file);
1103 char *s = ovsdb_error_to_string(error);
1104 ds_put_format(&reply, "%s\n", s);
1106 ovsdb_error_destroy(error);
1114 unixctl_command_reply_error(conn, "no database by that name");
1115 } else if (reply.length) {
1116 unixctl_command_reply_error(conn, ds_cstr(&reply));
1118 unixctl_command_reply(conn, NULL);
1123 /* "ovsdb-server/reconnect": makes ovsdb-server drop all of its JSON-RPC
1124 * connections and reconnect. */
1126 ovsdb_server_reconnect(struct unixctl_conn *conn, int argc OVS_UNUSED,
1127 const char *argv[] OVS_UNUSED, void *jsonrpc_)
1129 struct ovsdb_jsonrpc_server *jsonrpc = jsonrpc_;
1131 ovsdb_jsonrpc_server_reconnect(jsonrpc);
1132 unixctl_command_reply(conn, NULL);
1135 /* "ovsdb-server/add-remote REMOTE": adds REMOTE to the set of remotes that
1136 * ovsdb-server services. */
1138 ovsdb_server_add_remote(struct unixctl_conn *conn, int argc OVS_UNUSED,
1139 const char *argv[], void *config_)
1141 struct server_config *config = config_;
1142 const char *remote = argv[1];
1144 const struct ovsdb_column *column;
1145 const struct ovsdb_table *table;
1146 const struct db *db;
1149 retval = (strncmp("db:", remote, 3)
1151 : parse_db_column(config->all_dbs, remote,
1152 &db, &table, &column));
1154 if (sset_add(config->remotes, remote)) {
1155 save_config(config);
1157 unixctl_command_reply(conn, NULL);
1159 unixctl_command_reply_error(conn, retval);
1164 /* "ovsdb-server/remove-remote REMOTE": removes REMOTE frmo the set of remotes
1165 * that ovsdb-server services. */
1167 ovsdb_server_remove_remote(struct unixctl_conn *conn, int argc OVS_UNUSED,
1168 const char *argv[], void *config_)
1170 struct server_config *config = config_;
1171 struct sset_node *node;
1173 node = sset_find(config->remotes, argv[1]);
1175 sset_delete(config->remotes, node);
1176 save_config(config);
1177 unixctl_command_reply(conn, NULL);
1179 unixctl_command_reply_error(conn, "no such remote");
1183 /* "ovsdb-server/list-remotes": outputs a list of configured rmeotes. */
1185 ovsdb_server_list_remotes(struct unixctl_conn *conn, int argc OVS_UNUSED,
1186 const char *argv[] OVS_UNUSED, void *remotes_)
1188 struct sset *remotes = remotes_;
1189 const char **list, **p;
1194 list = sset_sort(remotes);
1195 for (p = list; *p; p++) {
1196 ds_put_format(&s, "%s\n", *p);
1200 unixctl_command_reply(conn, ds_cstr(&s));
1205 /* "ovsdb-server/add-db DB": adds the DB to ovsdb-server. */
1207 ovsdb_server_add_database(struct unixctl_conn *conn, int argc OVS_UNUSED,
1208 const char *argv[], void *config_)
1210 struct server_config *config = config_;
1211 const char *filename = argv[1];
1214 error = open_db(config, filename);
1216 save_config(config);
1217 unixctl_command_reply(conn, NULL);
1219 unixctl_command_reply_error(conn, error);
1225 ovsdb_server_remove_database(struct unixctl_conn *conn, int argc OVS_UNUSED,
1226 const char *argv[], void *config_)
1228 struct server_config *config = config_;
1229 struct shash_node *node;
1233 node = shash_find(config->all_dbs, argv[1]);
1235 unixctl_command_reply_error(conn, "Failed to find the database.");
1240 ok = ovsdb_jsonrpc_server_remove_db(config->jsonrpc, db->db);
1244 shash_delete(config->all_dbs, node);
1246 save_config(config);
1247 unixctl_command_reply(conn, NULL);
1251 ovsdb_server_list_databases(struct unixctl_conn *conn, int argc OVS_UNUSED,
1252 const char *argv[] OVS_UNUSED, void *all_dbs_)
1254 struct shash *all_dbs = all_dbs_;
1255 const struct shash_node **nodes;
1261 nodes = shash_sort(all_dbs);
1262 for (i = 0; i < shash_count(all_dbs); i++) {
1263 struct db *db = nodes[i]->data;
1264 ds_put_format(&s, "%s\n", db->db->schema->name);
1268 unixctl_command_reply(conn, ds_cstr(&s));
1273 parse_options(int *argcp, char **argvp[],
1274 struct sset *remotes, char **unixctl_pathp, char **run_command)
1277 OPT_REMOTE = UCHAR_MAX + 1,
1280 OPT_BOOTSTRAP_CA_CERT,
1285 static const struct option long_options[] = {
1286 {"remote", required_argument, NULL, OPT_REMOTE},
1287 {"unixctl", required_argument, NULL, OPT_UNIXCTL},
1289 {"run", required_argument, NULL, OPT_RUN},
1291 {"help", no_argument, NULL, 'h'},
1292 {"version", no_argument, NULL, 'V'},
1293 DAEMON_LONG_OPTIONS,
1295 {"bootstrap-ca-cert", required_argument, NULL, OPT_BOOTSTRAP_CA_CERT},
1296 {"peer-ca-cert", required_argument, NULL, OPT_PEER_CA_CERT},
1297 {"private-key", required_argument, NULL, 'p'},
1298 {"certificate", required_argument, NULL, 'c'},
1299 {"ca-cert", required_argument, NULL, 'C'},
1302 char *short_options = ovs_cmdl_long_options_to_short_options(long_options);
1304 char **argv = *argvp;
1310 c = getopt_long(argc, argv, short_options, long_options, NULL);
1317 sset_add(remotes, optarg);
1321 *unixctl_pathp = optarg;
1325 *run_command = optarg;
1332 ovs_print_version(0, 0);
1335 VLOG_OPTION_HANDLERS
1336 DAEMON_OPTION_HANDLERS
1339 private_key_file = optarg;
1343 certificate_file = optarg;
1347 ca_cert_file = optarg;
1348 bootstrap_ca_cert = false;
1351 case OPT_BOOTSTRAP_CA_CERT:
1352 ca_cert_file = optarg;
1353 bootstrap_ca_cert = true;
1356 case OPT_PEER_CA_CERT:
1357 stream_ssl_set_peer_ca_cert_file(optarg);
1367 free(short_options);
1376 printf("%s: Open vSwitch database server\n"
1377 "usage: %s [OPTIONS] [DATABASE...]\n"
1378 "where each DATABASE is a database file in ovsdb format.\n"
1379 "The default DATABASE, if none is given, is\n%s/conf.db.\n",
1380 program_name, program_name, ovs_dbdir());
1381 printf("\nJSON-RPC options (may be specified any number of times):\n"
1382 " --remote=REMOTE connect or listen to REMOTE\n");
1383 stream_usage("JSON-RPC", true, true, true);
1386 printf("\nOther options:\n"
1387 " --run COMMAND run COMMAND as subprocess then exit\n"
1388 " --unixctl=SOCKET override default control socket name\n"
1389 " -h, --help display this help message\n"
1390 " -V, --version display version information\n");
1394 static struct json *
1395 sset_to_json(const struct sset *sset)
1400 array = json_array_create_empty();
1401 SSET_FOR_EACH (s, sset) {
1402 json_array_add(array, json_string_create(s));
1407 /* Truncates and replaces the contents of 'config_file' by a representation of
1408 * 'remotes' and 'db_filenames'. */
1410 save_config__(FILE *config_file, const struct sset *remotes,
1411 const struct sset *db_filenames)
1416 if (ftruncate(fileno(config_file), 0) == -1) {
1417 VLOG_FATAL("failed to truncate temporary file (%s)",
1418 ovs_strerror(errno));
1421 obj = json_object_create();
1422 json_object_put(obj, "remotes", sset_to_json(remotes));
1423 json_object_put(obj, "db_filenames", sset_to_json(db_filenames));
1424 s = json_to_string(obj, 0);
1427 if (fseek(config_file, 0, SEEK_SET) != 0
1428 || fputs(s, config_file) == EOF
1429 || fflush(config_file) == EOF) {
1430 VLOG_FATAL("failed to write temporary file (%s)", ovs_strerror(errno));
1435 /* Truncates and replaces the contents of 'config_file' by a representation of
1438 save_config(struct server_config *config)
1440 struct sset db_filenames;
1441 struct shash_node *node;
1443 sset_init(&db_filenames);
1444 SHASH_FOR_EACH (node, config->all_dbs) {
1445 struct db *db = node->data;
1446 sset_add(&db_filenames, db->filename);
1449 save_config__(config->config_tmpfile, config->remotes, &db_filenames);
1451 sset_destroy(&db_filenames);
1455 sset_from_json(struct sset *sset, const struct json *array)
1461 ovs_assert(array->type == JSON_ARRAY);
1462 for (i = 0; i < array->u.array.n; i++) {
1463 const struct json *elem = array->u.array.elems[i];
1464 sset_add(sset, json_string(elem));
1468 /* Clears and replaces 'remotes' and 'dbnames' by a configuration read from
1469 * 'config_file', which must have been previously written by save_config(). */
1471 load_config(FILE *config_file, struct sset *remotes, struct sset *db_filenames)
1475 if (fseek(config_file, 0, SEEK_SET) != 0) {
1476 VLOG_FATAL("seek failed in temporary file (%s)", ovs_strerror(errno));
1478 json = json_from_stream(config_file);
1479 if (json->type == JSON_STRING) {
1480 VLOG_FATAL("reading json failed (%s)", json_string(json));
1482 ovs_assert(json->type == JSON_OBJECT);
1484 sset_from_json(remotes, shash_find_data(json_object(json), "remotes"));
1485 sset_from_json(db_filenames,
1486 shash_find_data(json_object(json), "db_filenames"));