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 "dynamic-string.h"
30 #include "fatal-signal.h"
35 #include "jsonrpc-server.h"
39 #include "ovsdb-data.h"
40 #include "ovsdb-types.h"
41 #include "ovsdb-error.h"
42 #include "poll-loop.h"
47 #include "stream-ssl.h"
52 #include "transaction.h"
56 #include "perf-counter.h"
57 #include "openvswitch/vlog.h"
59 VLOG_DEFINE_THIS_MODULE(ovsdb_server);
62 /* Initialized in main(). */
64 struct ovsdb_file *file;
67 /* Only used by update_remote_status(). */
68 struct ovsdb_txn *txn;
71 /* SSL configuration. */
72 static char *private_key_file;
73 static char *certificate_file;
74 static char *ca_cert_file;
75 static bool bootstrap_ca_cert;
77 static unixctl_cb_func ovsdb_server_exit;
78 static unixctl_cb_func ovsdb_server_compact;
79 static unixctl_cb_func ovsdb_server_reconnect;
80 static unixctl_cb_func ovsdb_server_perf_counters_clear;
81 static unixctl_cb_func ovsdb_server_perf_counters_show;
83 struct server_config {
85 struct shash *all_dbs;
87 struct ovsdb_jsonrpc_server *jsonrpc;
89 static unixctl_cb_func ovsdb_server_add_remote;
90 static unixctl_cb_func ovsdb_server_remove_remote;
91 static unixctl_cb_func ovsdb_server_list_remotes;
93 static unixctl_cb_func ovsdb_server_add_database;
94 static unixctl_cb_func ovsdb_server_remove_database;
95 static unixctl_cb_func ovsdb_server_list_databases;
97 static char *open_db(struct server_config *config, const char *filename);
98 static void close_db(struct db *db);
100 static void parse_options(int *argc, char **argvp[],
101 struct sset *remotes, char **unixctl_pathp,
103 OVS_NO_RETURN static void usage(void);
105 static char *reconfigure_remotes(struct ovsdb_jsonrpc_server *,
106 const struct shash *all_dbs,
107 struct sset *remotes);
108 static char *reconfigure_ssl(const struct shash *all_dbs);
109 static void report_error_if_changed(char *error, char **last_errorp);
111 static void update_remote_status(const struct ovsdb_jsonrpc_server *jsonrpc,
112 const struct sset *remotes,
113 struct shash *all_dbs);
115 static void save_config__(FILE *config_file, const struct sset *remotes,
116 const struct sset *db_filenames);
117 static void save_config(struct server_config *);
118 static void load_config(FILE *config_file, struct sset *remotes,
119 struct sset *db_filenames);
122 main_loop(struct ovsdb_jsonrpc_server *jsonrpc, struct shash *all_dbs,
123 struct unixctl_server *unixctl, struct sset *remotes,
124 struct process *run_process, bool *exiting)
126 char *remotes_error, *ssl_error;
127 struct shash_node *node;
128 long long int status_timer = LLONG_MIN;
132 remotes_error = NULL;
135 if (memory_should_report()) {
139 ovsdb_jsonrpc_server_get_memory_usage(jsonrpc, &usage);
140 SHASH_FOR_EACH(node, all_dbs) {
141 struct db *db = node->data;
142 ovsdb_get_memory_usage(db->db, &usage);
144 memory_report(&usage);
145 simap_destroy(&usage);
148 /* Run unixctl_server_run() before reconfigure_remotes() because
149 * ovsdb-server/add-remote and ovsdb-server/remove-remote can change
150 * the set of remotes that reconfigure_remotes() uses. */
151 unixctl_server_run(unixctl);
153 report_error_if_changed(
154 reconfigure_remotes(jsonrpc, all_dbs, remotes),
156 report_error_if_changed(reconfigure_ssl(all_dbs), &ssl_error);
157 ovsdb_jsonrpc_server_run(jsonrpc);
159 SHASH_FOR_EACH(node, all_dbs) {
160 struct db *db = node->data;
161 ovsdb_trigger_run(db->db, time_msec());
165 if (process_exited(run_process)) {
170 /* update Manager status(es) every 5 seconds */
171 if (time_msec() >= status_timer) {
172 status_timer = time_msec() + 5000;
173 update_remote_status(jsonrpc, remotes, all_dbs);
177 ovsdb_jsonrpc_server_wait(jsonrpc);
178 unixctl_server_wait(unixctl);
179 SHASH_FOR_EACH(node, all_dbs) {
180 struct db *db = node->data;
181 ovsdb_trigger_wait(db->db, time_msec());
184 process_wait(run_process);
187 poll_immediate_wake();
189 poll_timer_wait_until(status_timer);
191 if (should_service_stop()) {
199 main(int argc, char *argv[])
201 char *unixctl_path = NULL;
202 char *run_command = NULL;
203 struct unixctl_server *unixctl;
204 struct ovsdb_jsonrpc_server *jsonrpc;
205 struct sset remotes, db_filenames;
206 const char *db_filename;
207 struct process *run_process;
210 FILE *config_tmpfile;
211 struct server_config server_config;
212 struct shash all_dbs;
213 struct shash_node *node, *next;
217 ovs_cmdl_proctitle_init(argc, argv);
218 set_program_name(argv[0]);
219 service_start(&argc, &argv);
220 fatal_ignore_sigpipe();
223 parse_options(&argc, &argv, &remotes, &unixctl_path, &run_command);
225 /* Create and initialize 'config_tmpfile' as a temporary file to hold
226 * ovsdb-server's most basic configuration, and then save our initial
227 * configuration to it. When --monitor is used, this preserves the effects
228 * of ovs-appctl commands such as ovsdb-server/add-remote (which saves the
229 * new configuration) across crashes. */
230 config_tmpfile = tmpfile();
231 if (!config_tmpfile) {
232 ovs_fatal(errno, "failed to create temporary file");
235 sset_init(&db_filenames);
237 for (i = 0; i < argc; i++) {
238 sset_add(&db_filenames, argv[i]);
241 char *default_db = xasprintf("%s/conf.db", ovs_dbdir());
242 sset_add(&db_filenames, default_db);
246 server_config.remotes = &remotes;
247 server_config.config_tmpfile = config_tmpfile;
249 save_config__(config_tmpfile, &remotes, &db_filenames);
253 /* Load the saved config. */
254 load_config(config_tmpfile, &remotes, &db_filenames);
255 jsonrpc = ovsdb_jsonrpc_server_create();
257 shash_init(&all_dbs);
258 server_config.all_dbs = &all_dbs;
259 server_config.jsonrpc = jsonrpc;
260 SSET_FOR_EACH (db_filename, &db_filenames) {
261 error = open_db(&server_config, db_filename);
263 ovs_fatal(0, "%s", error);
267 error = reconfigure_remotes(jsonrpc, &all_dbs, &remotes);
269 error = reconfigure_ssl(&all_dbs);
272 ovs_fatal(0, "%s", error);
275 retval = unixctl_server_create(unixctl_path, &unixctl);
283 run_argv[0] = "/bin/sh";
285 run_argv[2] = run_command;
288 retval = process_start(run_argv, &run_process);
290 ovs_fatal(retval, "%s: process failed to start", run_command);
296 daemonize_complete();
298 perf_counters_init();
301 /* ovsdb-server is usually a long-running process, in which case it
302 * makes plenty of sense to log the version, but --run makes
303 * ovsdb-server more like a command-line tool, so skip it. */
304 VLOG_INFO("%s (Open vSwitch) %s", program_name, VERSION);
307 unixctl_command_register("exit", "", 0, 0, ovsdb_server_exit, &exiting);
308 unixctl_command_register("ovsdb-server/compact", "", 0, 1,
309 ovsdb_server_compact, &all_dbs);
310 unixctl_command_register("ovsdb-server/reconnect", "", 0, 0,
311 ovsdb_server_reconnect, jsonrpc);
313 unixctl_command_register("ovsdb-server/add-remote", "REMOTE", 1, 1,
314 ovsdb_server_add_remote, &server_config);
315 unixctl_command_register("ovsdb-server/remove-remote", "REMOTE", 1, 1,
316 ovsdb_server_remove_remote, &server_config);
317 unixctl_command_register("ovsdb-server/list-remotes", "", 0, 0,
318 ovsdb_server_list_remotes, &remotes);
320 unixctl_command_register("ovsdb-server/add-db", "DB", 1, 1,
321 ovsdb_server_add_database, &server_config);
322 unixctl_command_register("ovsdb-server/remove-db", "DB", 1, 1,
323 ovsdb_server_remove_database, &server_config);
324 unixctl_command_register("ovsdb-server/list-dbs", "", 0, 0,
325 ovsdb_server_list_databases, &all_dbs);
326 unixctl_command_register("ovsdb-server/perf-counters-show", "", 0, 0,
327 ovsdb_server_perf_counters_show, NULL);
328 unixctl_command_register("ovsdb-server/perf-counters-clear", "", 0, 0,
329 ovsdb_server_perf_counters_clear, NULL);
331 main_loop(jsonrpc, &all_dbs, unixctl, &remotes, run_process, &exiting);
333 ovsdb_jsonrpc_server_destroy(jsonrpc);
334 SHASH_FOR_EACH_SAFE(node, next, &all_dbs) {
335 struct db *db = node->data;
337 shash_delete(&all_dbs, node);
339 sset_destroy(&remotes);
340 sset_destroy(&db_filenames);
341 unixctl_server_destroy(unixctl);
343 if (run_process && process_exited(run_process)) {
344 int status = process_status(run_process);
346 ovs_fatal(0, "%s: child exited, %s",
347 run_command, process_status_msg(status));
350 perf_counters_destroy();
355 /* Returns true if 'filename' is known to be already open as a database,
358 * "False negatives" are possible. */
360 is_already_open(struct server_config *config OVS_UNUSED,
361 const char *filename OVS_UNUSED)
366 if (!stat(filename, &s)) {
367 struct shash_node *node;
369 SHASH_FOR_EACH (node, config->all_dbs) {
370 struct db *db = node->data;
373 if (!stat(db->filename, &s2)
374 && s.st_dev == s2.st_dev
375 && s.st_ino == s2.st_ino) {
386 close_db(struct db *db)
388 ovsdb_destroy(db->db);
394 open_db(struct server_config *config, const char *filename)
396 struct ovsdb_error *db_error;
400 /* If we know that the file is already open, return a good error message.
401 * Otherwise, if the file is open, we'll fail later on with a harder to
402 * interpret file locking error. */
403 if (is_already_open(config, filename)) {
404 return xasprintf("%s: already open", filename);
407 db = xzalloc(sizeof *db);
408 db->filename = xstrdup(filename);
410 db_error = ovsdb_file_open(db->filename, false, &db->db, &db->file);
412 error = ovsdb_error_to_string(db_error);
413 } else if (!ovsdb_jsonrpc_server_add_db(config->jsonrpc, db->db)) {
414 error = xasprintf("%s: duplicate database name", db->db->schema->name);
416 shash_add_assert(config->all_dbs, db->db->schema->name, db);
420 ovsdb_error_destroy(db_error);
425 static const struct db *
426 find_db(const struct shash *all_dbs, const char *db_name)
428 struct shash_node *node;
430 SHASH_FOR_EACH(node, all_dbs) {
431 struct db *db = node->data;
432 if (!strcmp(db->db->schema->name, db_name)) {
440 static char * OVS_WARN_UNUSED_RESULT
441 parse_db_column__(const struct shash *all_dbs,
442 const char *name_, char *name,
443 const struct db **dbp,
444 const struct ovsdb_table **tablep,
445 const struct ovsdb_column **columnp)
447 const char *db_name, *table_name, *column_name;
448 const struct ovsdb_column *column;
449 const struct ovsdb_table *table;
450 const char *tokens[3];
451 char *save_ptr = NULL;
458 strtok_r(name, ":", &save_ptr); /* "db:" */
459 tokens[0] = strtok_r(NULL, ",", &save_ptr);
460 tokens[1] = strtok_r(NULL, ",", &save_ptr);
461 tokens[2] = strtok_r(NULL, ",", &save_ptr);
462 if (!tokens[0] || !tokens[1] || !tokens[2]) {
463 return xasprintf("\"%s\": invalid syntax", name_);
467 table_name = tokens[1];
468 column_name = tokens[2];
470 db = find_db(all_dbs, tokens[0]);
472 return xasprintf("\"%s\": no database named %s", name_, db_name);
475 table = ovsdb_get_table(db->db, table_name);
477 return xasprintf("\"%s\": no table named %s", name_, table_name);
480 column = ovsdb_table_schema_get_column(table->schema, column_name);
482 return xasprintf("\"%s\": table \"%s\" has no column \"%s\"",
483 name_, table_name, column_name);
492 /* Returns NULL if successful, otherwise a malloc()'d string describing the
494 static char * OVS_WARN_UNUSED_RESULT
495 parse_db_column(const struct shash *all_dbs,
497 const struct db **dbp,
498 const struct ovsdb_table **tablep,
499 const struct ovsdb_column **columnp)
501 char *name = xstrdup(name_);
502 char *retval = parse_db_column__(all_dbs, name_, name,
503 dbp, tablep, columnp);
508 /* Returns NULL if successful, otherwise a malloc()'d string describing the
510 static char * OVS_WARN_UNUSED_RESULT
511 parse_db_string_column(const struct shash *all_dbs,
513 const struct db **dbp,
514 const struct ovsdb_table **tablep,
515 const struct ovsdb_column **columnp)
519 retval = parse_db_column(all_dbs, name, dbp, tablep, columnp);
524 if ((*columnp)->type.key.type != OVSDB_TYPE_STRING
525 || (*columnp)->type.value.type != OVSDB_TYPE_VOID) {
526 return xasprintf("\"%s\": table \"%s\" column \"%s\" is "
527 "not string or set of strings",
528 name, (*tablep)->schema->name, (*columnp)->name);
535 query_db_string(const struct shash *all_dbs, const char *name,
538 if (!name || strncmp(name, "db:", 3)) {
541 const struct ovsdb_column *column;
542 const struct ovsdb_table *table;
543 const struct ovsdb_row *row;
547 retval = parse_db_string_column(all_dbs, name,
548 &db, &table, &column);
550 ds_put_format(errors, "%s\n", retval);
555 HMAP_FOR_EACH (row, hmap_node, &table->rows) {
556 const struct ovsdb_datum *datum;
559 datum = &row->fields[column->index];
560 for (i = 0; i < datum->n; i++) {
561 if (datum->keys[i].string[0]) {
562 return datum->keys[i].string;
570 static struct ovsdb_jsonrpc_options *
571 add_remote(struct shash *remotes, const char *target)
573 struct ovsdb_jsonrpc_options *options;
575 options = shash_find_data(remotes, target);
577 options = ovsdb_jsonrpc_default_options(target);
578 shash_add(remotes, target, options);
584 static struct ovsdb_datum *
585 get_datum(struct ovsdb_row *row, const char *column_name,
586 const enum ovsdb_atomic_type key_type,
587 const enum ovsdb_atomic_type value_type,
590 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
591 const struct ovsdb_table_schema *schema = row->table->schema;
592 const struct ovsdb_column *column;
594 column = ovsdb_table_schema_get_column(schema, column_name);
596 VLOG_DBG_RL(&rl, "Table `%s' has no `%s' column",
597 schema->name, column_name);
601 if (column->type.key.type != key_type
602 || column->type.value.type != value_type
603 || column->type.n_max != n_max) {
604 if (!VLOG_DROP_DBG(&rl)) {
605 char *type_name = ovsdb_type_to_english(&column->type);
606 VLOG_DBG("Table `%s' column `%s' has type %s, not expected "
607 "key type %s, value type %s, max elements %"PRIuSIZE".",
608 schema->name, column_name, type_name,
609 ovsdb_atomic_type_to_string(key_type),
610 ovsdb_atomic_type_to_string(value_type),
617 return &row->fields[column->index];
620 /* Read string-string key-values from a map. Returns the value associated with
621 * 'key', if found, or NULL */
623 read_map_string_column(const struct ovsdb_row *row, const char *column_name,
626 const struct ovsdb_datum *datum;
627 union ovsdb_atom *atom_key = NULL, *atom_value = NULL;
630 datum = get_datum(CONST_CAST(struct ovsdb_row *, row), column_name,
631 OVSDB_TYPE_STRING, OVSDB_TYPE_STRING, UINT_MAX);
637 for (i = 0; i < datum->n; i++) {
638 atom_key = &datum->keys[i];
639 if (!strcmp(atom_key->string, key)){
640 atom_value = &datum->values[i];
645 return atom_value ? atom_value->string : NULL;
648 static const union ovsdb_atom *
649 read_column(const struct ovsdb_row *row, const char *column_name,
650 enum ovsdb_atomic_type type)
652 const struct ovsdb_datum *datum;
654 datum = get_datum(CONST_CAST(struct ovsdb_row *, row), column_name, type,
656 return datum && datum->n ? datum->keys : NULL;
660 read_integer_column(const struct ovsdb_row *row, const char *column_name,
661 long long int *integerp)
663 const union ovsdb_atom *atom;
665 atom = read_column(row, column_name, OVSDB_TYPE_INTEGER);
666 *integerp = atom ? atom->integer : 0;
671 read_string_column(const struct ovsdb_row *row, const char *column_name,
672 const char **stringp)
674 const union ovsdb_atom *atom;
676 atom = read_column(row, column_name, OVSDB_TYPE_STRING);
677 *stringp = atom ? atom->string : NULL;
682 write_bool_column(struct ovsdb_row *row, const char *column_name, bool value)
684 const struct ovsdb_column *column;
685 struct ovsdb_datum *datum;
687 column = ovsdb_table_schema_get_column(row->table->schema, column_name);
688 datum = get_datum(row, column_name, OVSDB_TYPE_BOOLEAN,
695 ovsdb_datum_destroy(datum, &column->type);
698 datum->keys = xmalloc(sizeof *datum->keys);
699 datum->values = NULL;
702 datum->keys[0].boolean = value;
706 write_string_string_column(struct ovsdb_row *row, const char *column_name,
707 char **keys, char **values, size_t n)
709 const struct ovsdb_column *column;
710 struct ovsdb_datum *datum;
713 column = ovsdb_table_schema_get_column(row->table->schema, column_name);
714 datum = get_datum(row, column_name, OVSDB_TYPE_STRING, OVSDB_TYPE_STRING,
717 for (i = 0; i < n; i++) {
724 /* Free existing data. */
725 ovsdb_datum_destroy(datum, &column->type);
727 /* Allocate space for new values. */
729 datum->keys = xmalloc(n * sizeof *datum->keys);
730 datum->values = xmalloc(n * sizeof *datum->values);
732 for (i = 0; i < n; ++i) {
733 datum->keys[i].string = keys[i];
734 datum->values[i].string = values[i];
737 /* Sort and check constraints. */
738 ovsdb_datum_sort_assert(datum, column->type.key.type);
741 /* Adds a remote and options to 'remotes', based on the Manager table row in
744 add_manager_options(struct shash *remotes, const struct ovsdb_row *row)
746 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
747 struct ovsdb_jsonrpc_options *options;
748 long long int max_backoff, probe_interval;
749 const char *target, *dscp_string;
751 if (!read_string_column(row, "target", &target) || !target) {
752 VLOG_INFO_RL(&rl, "Table `%s' has missing or invalid `target' column",
753 row->table->schema->name);
757 options = add_remote(remotes, target);
758 if (read_integer_column(row, "max_backoff", &max_backoff)) {
759 options->max_backoff = max_backoff;
761 if (read_integer_column(row, "inactivity_probe", &probe_interval)) {
762 options->probe_interval = probe_interval;
765 options->dscp = DSCP_DEFAULT;
766 dscp_string = read_map_string_column(row, "other_config", "dscp");
768 int dscp = atoi(dscp_string);
769 if (dscp >= 0 && dscp <= 63) {
770 options->dscp = dscp;
776 query_db_remotes(const char *name, const struct shash *all_dbs,
777 struct shash *remotes, struct ds *errors)
779 const struct ovsdb_column *column;
780 const struct ovsdb_table *table;
781 const struct ovsdb_row *row;
785 retval = parse_db_column(all_dbs, name, &db, &table, &column);
787 ds_put_format(errors, "%s\n", retval);
792 if (column->type.key.type == OVSDB_TYPE_STRING
793 && column->type.value.type == OVSDB_TYPE_VOID) {
794 HMAP_FOR_EACH (row, hmap_node, &table->rows) {
795 const struct ovsdb_datum *datum;
798 datum = &row->fields[column->index];
799 for (i = 0; i < datum->n; i++) {
800 add_remote(remotes, datum->keys[i].string);
803 } else if (column->type.key.type == OVSDB_TYPE_UUID
804 && column->type.key.u.uuid.refTable
805 && column->type.value.type == OVSDB_TYPE_VOID) {
806 const struct ovsdb_table *ref_table = column->type.key.u.uuid.refTable;
807 HMAP_FOR_EACH (row, hmap_node, &table->rows) {
808 const struct ovsdb_datum *datum;
811 datum = &row->fields[column->index];
812 for (i = 0; i < datum->n; i++) {
813 const struct ovsdb_row *ref_row;
815 ref_row = ovsdb_table_get_row(ref_table, &datum->keys[i].uuid);
817 add_manager_options(remotes, ref_row);
825 update_remote_row(const struct ovsdb_row *row, struct ovsdb_txn *txn,
826 const struct ovsdb_jsonrpc_server *jsonrpc)
828 struct ovsdb_jsonrpc_remote_status status;
829 struct ovsdb_row *rw_row;
831 char *keys[9], *values[9];
834 /* Get the "target" (protocol/host/port) spec. */
835 if (!read_string_column(row, "target", &target)) {
836 /* Bad remote spec or incorrect schema. */
839 rw_row = ovsdb_txn_row_modify(txn, row);
840 ovsdb_jsonrpc_server_get_remote_status(jsonrpc, target, &status);
842 /* Update status information columns. */
843 write_bool_column(rw_row, "is_connected", status.is_connected);
846 keys[n] = xstrdup("state");
847 values[n++] = xstrdup(status.state);
849 if (status.sec_since_connect != UINT_MAX) {
850 keys[n] = xstrdup("sec_since_connect");
851 values[n++] = xasprintf("%u", status.sec_since_connect);
853 if (status.sec_since_disconnect != UINT_MAX) {
854 keys[n] = xstrdup("sec_since_disconnect");
855 values[n++] = xasprintf("%u", status.sec_since_disconnect);
857 if (status.last_error) {
858 keys[n] = xstrdup("last_error");
860 xstrdup(ovs_retval_to_string(status.last_error));
862 if (status.locks_held && status.locks_held[0]) {
863 keys[n] = xstrdup("locks_held");
864 values[n++] = xstrdup(status.locks_held);
866 if (status.locks_waiting && status.locks_waiting[0]) {
867 keys[n] = xstrdup("locks_waiting");
868 values[n++] = xstrdup(status.locks_waiting);
870 if (status.locks_lost && status.locks_lost[0]) {
871 keys[n] = xstrdup("locks_lost");
872 values[n++] = xstrdup(status.locks_lost);
874 if (status.n_connections > 1) {
875 keys[n] = xstrdup("n_connections");
876 values[n++] = xasprintf("%d", status.n_connections);
878 if (status.bound_port != htons(0)) {
879 keys[n] = xstrdup("bound_port");
880 values[n++] = xasprintf("%"PRIu16, ntohs(status.bound_port));
882 write_string_string_column(rw_row, "status", keys, values, n);
884 ovsdb_jsonrpc_server_free_remote_status(&status);
888 update_remote_rows(const struct shash *all_dbs,
889 const char *remote_name,
890 const struct ovsdb_jsonrpc_server *jsonrpc)
892 const struct ovsdb_table *table, *ref_table;
893 const struct ovsdb_column *column;
894 const struct ovsdb_row *row;
898 if (strncmp("db:", remote_name, 3)) {
902 retval = parse_db_column(all_dbs, remote_name, &db, &table, &column);
908 if (column->type.key.type != OVSDB_TYPE_UUID
909 || !column->type.key.u.uuid.refTable
910 || column->type.value.type != OVSDB_TYPE_VOID) {
914 ref_table = column->type.key.u.uuid.refTable;
916 HMAP_FOR_EACH (row, hmap_node, &table->rows) {
917 const struct ovsdb_datum *datum;
920 datum = &row->fields[column->index];
921 for (i = 0; i < datum->n; i++) {
922 const struct ovsdb_row *ref_row;
924 ref_row = ovsdb_table_get_row(ref_table, &datum->keys[i].uuid);
926 update_remote_row(ref_row, db->txn, jsonrpc);
933 update_remote_status(const struct ovsdb_jsonrpc_server *jsonrpc,
934 const struct sset *remotes,
935 struct shash *all_dbs)
937 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
940 struct shash_node *node;
942 SHASH_FOR_EACH(node, all_dbs) {
944 db->txn = ovsdb_txn_create(db->db);
947 /* Iterate over --remote arguments given on command line. */
948 SSET_FOR_EACH (remote, remotes) {
949 update_remote_rows(all_dbs, remote, jsonrpc);
952 SHASH_FOR_EACH(node, all_dbs) {
953 struct ovsdb_error *error;
955 error = ovsdb_txn_commit(db->txn, false);
957 VLOG_ERR_RL(&rl, "Failed to update remote status: %s",
958 ovsdb_error_to_string(error));
959 ovsdb_error_destroy(error);
964 /* Reconfigures ovsdb-server's remotes based on information in the database. */
966 reconfigure_remotes(struct ovsdb_jsonrpc_server *jsonrpc,
967 const struct shash *all_dbs, struct sset *remotes)
969 struct ds errors = DS_EMPTY_INITIALIZER;
970 struct shash resolved_remotes;
973 /* Configure remotes. */
974 shash_init(&resolved_remotes);
975 SSET_FOR_EACH (name, remotes) {
976 if (!strncmp(name, "db:", 3)) {
977 query_db_remotes(name, all_dbs, &resolved_remotes, &errors);
979 add_remote(&resolved_remotes, name);
982 ovsdb_jsonrpc_server_set_remotes(jsonrpc, &resolved_remotes);
983 shash_destroy_free_data(&resolved_remotes);
985 return errors.string;
989 reconfigure_ssl(const struct shash *all_dbs)
991 struct ds errors = DS_EMPTY_INITIALIZER;
992 const char *resolved_private_key;
993 const char *resolved_certificate;
994 const char *resolved_ca_cert;
996 resolved_private_key = query_db_string(all_dbs, private_key_file, &errors);
997 resolved_certificate = query_db_string(all_dbs, certificate_file, &errors);
998 resolved_ca_cert = query_db_string(all_dbs, ca_cert_file, &errors);
1000 stream_ssl_set_key_and_cert(resolved_private_key, resolved_certificate);
1001 stream_ssl_set_ca_cert_file(resolved_ca_cert, bootstrap_ca_cert);
1003 return errors.string;
1007 report_error_if_changed(char *error, char **last_errorp)
1010 if (!*last_errorp || strcmp(error, *last_errorp)) {
1011 VLOG_WARN("%s", error);
1013 *last_errorp = error;
1019 *last_errorp = NULL;
1024 ovsdb_server_exit(struct unixctl_conn *conn, int argc OVS_UNUSED,
1025 const char *argv[] OVS_UNUSED,
1028 bool *exiting = exiting_;
1030 unixctl_command_reply(conn, NULL);
1034 ovsdb_server_perf_counters_show(struct unixctl_conn *conn, int argc OVS_UNUSED,
1035 const char *argv[] OVS_UNUSED,
1036 void *arg_ OVS_UNUSED)
1038 char *s = perf_counters_to_string();
1040 unixctl_command_reply(conn, s);
1045 ovsdb_server_perf_counters_clear(struct unixctl_conn *conn, int argc OVS_UNUSED,
1046 const char *argv[] OVS_UNUSED,
1047 void *arg_ OVS_UNUSED)
1049 perf_counters_clear();
1050 unixctl_command_reply(conn, NULL);
1054 ovsdb_server_compact(struct unixctl_conn *conn, int argc,
1055 const char *argv[], void *dbs_)
1057 struct shash *all_dbs = dbs_;
1060 struct shash_node *node;
1064 SHASH_FOR_EACH(node, all_dbs) {
1068 name = db->db->schema->name;
1070 if (argc < 2 || !strcmp(argv[1], name)) {
1071 struct ovsdb_error *error;
1073 VLOG_INFO("compacting %s database by user request", name);
1075 error = ovsdb_file_compact(db->file);
1077 char *s = ovsdb_error_to_string(error);
1078 ds_put_format(&reply, "%s\n", s);
1080 ovsdb_error_destroy(error);
1088 unixctl_command_reply_error(conn, "no database by that name");
1089 } else if (reply.length) {
1090 unixctl_command_reply_error(conn, ds_cstr(&reply));
1092 unixctl_command_reply(conn, NULL);
1097 /* "ovsdb-server/reconnect": makes ovsdb-server drop all of its JSON-RPC
1098 * connections and reconnect. */
1100 ovsdb_server_reconnect(struct unixctl_conn *conn, int argc OVS_UNUSED,
1101 const char *argv[] OVS_UNUSED, void *jsonrpc_)
1103 struct ovsdb_jsonrpc_server *jsonrpc = jsonrpc_;
1105 ovsdb_jsonrpc_server_reconnect(jsonrpc);
1106 unixctl_command_reply(conn, NULL);
1109 /* "ovsdb-server/add-remote REMOTE": adds REMOTE to the set of remotes that
1110 * ovsdb-server services. */
1112 ovsdb_server_add_remote(struct unixctl_conn *conn, int argc OVS_UNUSED,
1113 const char *argv[], void *config_)
1115 struct server_config *config = config_;
1116 const char *remote = argv[1];
1118 const struct ovsdb_column *column;
1119 const struct ovsdb_table *table;
1120 const struct db *db;
1123 retval = (strncmp("db:", remote, 3)
1125 : parse_db_column(config->all_dbs, remote,
1126 &db, &table, &column));
1128 if (sset_add(config->remotes, remote)) {
1129 save_config(config);
1131 unixctl_command_reply(conn, NULL);
1133 unixctl_command_reply_error(conn, retval);
1138 /* "ovsdb-server/remove-remote REMOTE": removes REMOTE frmo the set of remotes
1139 * that ovsdb-server services. */
1141 ovsdb_server_remove_remote(struct unixctl_conn *conn, int argc OVS_UNUSED,
1142 const char *argv[], void *config_)
1144 struct server_config *config = config_;
1145 struct sset_node *node;
1147 node = sset_find(config->remotes, argv[1]);
1149 sset_delete(config->remotes, node);
1150 save_config(config);
1151 unixctl_command_reply(conn, NULL);
1153 unixctl_command_reply_error(conn, "no such remote");
1157 /* "ovsdb-server/list-remotes": outputs a list of configured rmeotes. */
1159 ovsdb_server_list_remotes(struct unixctl_conn *conn, int argc OVS_UNUSED,
1160 const char *argv[] OVS_UNUSED, void *remotes_)
1162 struct sset *remotes = remotes_;
1163 const char **list, **p;
1168 list = sset_sort(remotes);
1169 for (p = list; *p; p++) {
1170 ds_put_format(&s, "%s\n", *p);
1174 unixctl_command_reply(conn, ds_cstr(&s));
1179 /* "ovsdb-server/add-db DB": adds the DB to ovsdb-server. */
1181 ovsdb_server_add_database(struct unixctl_conn *conn, int argc OVS_UNUSED,
1182 const char *argv[], void *config_)
1184 struct server_config *config = config_;
1185 const char *filename = argv[1];
1188 error = open_db(config, filename);
1190 save_config(config);
1191 unixctl_command_reply(conn, NULL);
1193 unixctl_command_reply_error(conn, error);
1199 ovsdb_server_remove_database(struct unixctl_conn *conn, int argc OVS_UNUSED,
1200 const char *argv[], void *config_)
1202 struct server_config *config = config_;
1203 struct shash_node *node;
1207 node = shash_find(config->all_dbs, argv[1]);
1209 unixctl_command_reply_error(conn, "Failed to find the database.");
1214 ok = ovsdb_jsonrpc_server_remove_db(config->jsonrpc, db->db);
1218 shash_delete(config->all_dbs, node);
1220 save_config(config);
1221 unixctl_command_reply(conn, NULL);
1225 ovsdb_server_list_databases(struct unixctl_conn *conn, int argc OVS_UNUSED,
1226 const char *argv[] OVS_UNUSED, void *all_dbs_)
1228 struct shash *all_dbs = all_dbs_;
1229 const struct shash_node **nodes;
1235 nodes = shash_sort(all_dbs);
1236 for (i = 0; i < shash_count(all_dbs); i++) {
1237 struct db *db = nodes[i]->data;
1238 ds_put_format(&s, "%s\n", db->db->schema->name);
1242 unixctl_command_reply(conn, ds_cstr(&s));
1247 parse_options(int *argcp, char **argvp[],
1248 struct sset *remotes, char **unixctl_pathp, char **run_command)
1251 OPT_REMOTE = UCHAR_MAX + 1,
1254 OPT_BOOTSTRAP_CA_CERT,
1259 static const struct option long_options[] = {
1260 {"remote", required_argument, NULL, OPT_REMOTE},
1261 {"unixctl", required_argument, NULL, OPT_UNIXCTL},
1263 {"run", required_argument, NULL, OPT_RUN},
1265 {"help", no_argument, NULL, 'h'},
1266 {"version", no_argument, NULL, 'V'},
1267 DAEMON_LONG_OPTIONS,
1269 {"bootstrap-ca-cert", required_argument, NULL, OPT_BOOTSTRAP_CA_CERT},
1270 {"peer-ca-cert", required_argument, NULL, OPT_PEER_CA_CERT},
1271 {"private-key", required_argument, NULL, 'p'},
1272 {"certificate", required_argument, NULL, 'c'},
1273 {"ca-cert", required_argument, NULL, 'C'},
1276 char *short_options = ovs_cmdl_long_options_to_short_options(long_options);
1278 char **argv = *argvp;
1284 c = getopt_long(argc, argv, short_options, long_options, NULL);
1291 sset_add(remotes, optarg);
1295 *unixctl_pathp = optarg;
1299 *run_command = optarg;
1306 ovs_print_version(0, 0);
1309 VLOG_OPTION_HANDLERS
1310 DAEMON_OPTION_HANDLERS
1313 private_key_file = optarg;
1317 certificate_file = optarg;
1321 ca_cert_file = optarg;
1322 bootstrap_ca_cert = false;
1325 case OPT_BOOTSTRAP_CA_CERT:
1326 ca_cert_file = optarg;
1327 bootstrap_ca_cert = true;
1330 case OPT_PEER_CA_CERT:
1331 stream_ssl_set_peer_ca_cert_file(optarg);
1341 free(short_options);
1350 printf("%s: Open vSwitch database server\n"
1351 "usage: %s [OPTIONS] [DATABASE...]\n"
1352 "where each DATABASE is a database file in ovsdb format.\n"
1353 "The default DATABASE, if none is given, is\n%s/conf.db.\n",
1354 program_name, program_name, ovs_dbdir());
1355 printf("\nJSON-RPC options (may be specified any number of times):\n"
1356 " --remote=REMOTE connect or listen to REMOTE\n");
1357 stream_usage("JSON-RPC", true, true, true);
1360 printf("\nOther options:\n"
1361 " --run COMMAND run COMMAND as subprocess then exit\n"
1362 " --unixctl=SOCKET override default control socket name\n"
1363 " -h, --help display this help message\n"
1364 " -V, --version display version information\n");
1368 static struct json *
1369 sset_to_json(const struct sset *sset)
1374 array = json_array_create_empty();
1375 SSET_FOR_EACH (s, sset) {
1376 json_array_add(array, json_string_create(s));
1381 /* Truncates and replaces the contents of 'config_file' by a representation of
1382 * 'remotes' and 'db_filenames'. */
1384 save_config__(FILE *config_file, const struct sset *remotes,
1385 const struct sset *db_filenames)
1390 if (ftruncate(fileno(config_file), 0) == -1) {
1391 VLOG_FATAL("failed to truncate temporary file (%s)",
1392 ovs_strerror(errno));
1395 obj = json_object_create();
1396 json_object_put(obj, "remotes", sset_to_json(remotes));
1397 json_object_put(obj, "db_filenames", sset_to_json(db_filenames));
1398 s = json_to_string(obj, 0);
1401 if (fseek(config_file, 0, SEEK_SET) != 0
1402 || fputs(s, config_file) == EOF
1403 || fflush(config_file) == EOF) {
1404 VLOG_FATAL("failed to write temporary file (%s)", ovs_strerror(errno));
1409 /* Truncates and replaces the contents of 'config_file' by a representation of
1412 save_config(struct server_config *config)
1414 struct sset db_filenames;
1415 struct shash_node *node;
1417 sset_init(&db_filenames);
1418 SHASH_FOR_EACH (node, config->all_dbs) {
1419 struct db *db = node->data;
1420 sset_add(&db_filenames, db->filename);
1423 save_config__(config->config_tmpfile, config->remotes, &db_filenames);
1425 sset_destroy(&db_filenames);
1429 sset_from_json(struct sset *sset, const struct json *array)
1435 ovs_assert(array->type == JSON_ARRAY);
1436 for (i = 0; i < array->u.array.n; i++) {
1437 const struct json *elem = array->u.array.elems[i];
1438 sset_add(sset, json_string(elem));
1442 /* Clears and replaces 'remotes' and 'dbnames' by a configuration read from
1443 * 'config_file', which must have been previously written by save_config(). */
1445 load_config(FILE *config_file, struct sset *remotes, struct sset *db_filenames)
1449 if (fseek(config_file, 0, SEEK_SET) != 0) {
1450 VLOG_FATAL("seek failed in temporary file (%s)", ovs_strerror(errno));
1452 json = json_from_stream(config_file);
1453 if (json->type == JSON_STRING) {
1454 VLOG_FATAL("reading json failed (%s)", json_string(json));
1456 ovs_assert(json->type == JSON_OBJECT);
1458 sset_from_json(remotes, shash_find_data(json_object(json), "remotes"));
1459 sset_from_json(db_filenames,
1460 shash_find_data(json_object(json), "db_filenames"));