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);
224 daemon_become_new_user(false);
226 /* Create and initialize 'config_tmpfile' as a temporary file to hold
227 * ovsdb-server's most basic configuration, and then save our initial
228 * configuration to it. When --monitor is used, this preserves the effects
229 * of ovs-appctl commands such as ovsdb-server/add-remote (which saves the
230 * new configuration) across crashes. */
231 config_tmpfile = tmpfile();
232 if (!config_tmpfile) {
233 ovs_fatal(errno, "failed to create temporary file");
236 sset_init(&db_filenames);
238 for (i = 0; i < argc; i++) {
239 sset_add(&db_filenames, argv[i]);
242 char *default_db = xasprintf("%s/conf.db", ovs_dbdir());
243 sset_add(&db_filenames, default_db);
247 server_config.remotes = &remotes;
248 server_config.config_tmpfile = config_tmpfile;
250 save_config__(config_tmpfile, &remotes, &db_filenames);
252 daemonize_start(false);
254 /* Load the saved config. */
255 load_config(config_tmpfile, &remotes, &db_filenames);
256 jsonrpc = ovsdb_jsonrpc_server_create();
258 shash_init(&all_dbs);
259 server_config.all_dbs = &all_dbs;
260 server_config.jsonrpc = jsonrpc;
261 SSET_FOR_EACH (db_filename, &db_filenames) {
262 error = open_db(&server_config, db_filename);
264 ovs_fatal(0, "%s", error);
268 error = reconfigure_remotes(jsonrpc, &all_dbs, &remotes);
270 error = reconfigure_ssl(&all_dbs);
273 ovs_fatal(0, "%s", error);
276 retval = unixctl_server_create(unixctl_path, &unixctl);
284 run_argv[0] = "/bin/sh";
286 run_argv[2] = run_command;
289 retval = process_start(run_argv, &run_process);
291 ovs_fatal(retval, "%s: process failed to start", run_command);
297 daemonize_complete();
299 perf_counters_init();
302 /* ovsdb-server is usually a long-running process, in which case it
303 * makes plenty of sense to log the version, but --run makes
304 * ovsdb-server more like a command-line tool, so skip it. */
305 VLOG_INFO("%s (Open vSwitch) %s", program_name, VERSION);
308 unixctl_command_register("exit", "", 0, 0, ovsdb_server_exit, &exiting);
309 unixctl_command_register("ovsdb-server/compact", "", 0, 1,
310 ovsdb_server_compact, &all_dbs);
311 unixctl_command_register("ovsdb-server/reconnect", "", 0, 0,
312 ovsdb_server_reconnect, jsonrpc);
314 unixctl_command_register("ovsdb-server/add-remote", "REMOTE", 1, 1,
315 ovsdb_server_add_remote, &server_config);
316 unixctl_command_register("ovsdb-server/remove-remote", "REMOTE", 1, 1,
317 ovsdb_server_remove_remote, &server_config);
318 unixctl_command_register("ovsdb-server/list-remotes", "", 0, 0,
319 ovsdb_server_list_remotes, &remotes);
321 unixctl_command_register("ovsdb-server/add-db", "DB", 1, 1,
322 ovsdb_server_add_database, &server_config);
323 unixctl_command_register("ovsdb-server/remove-db", "DB", 1, 1,
324 ovsdb_server_remove_database, &server_config);
325 unixctl_command_register("ovsdb-server/list-dbs", "", 0, 0,
326 ovsdb_server_list_databases, &all_dbs);
327 unixctl_command_register("ovsdb-server/perf-counters-show", "", 0, 0,
328 ovsdb_server_perf_counters_show, NULL);
329 unixctl_command_register("ovsdb-server/perf-counters-clear", "", 0, 0,
330 ovsdb_server_perf_counters_clear, NULL);
332 main_loop(jsonrpc, &all_dbs, unixctl, &remotes, run_process, &exiting);
334 ovsdb_jsonrpc_server_destroy(jsonrpc);
335 SHASH_FOR_EACH_SAFE(node, next, &all_dbs) {
336 struct db *db = node->data;
338 shash_delete(&all_dbs, node);
340 shash_destroy(&all_dbs);
341 sset_destroy(&remotes);
342 sset_destroy(&db_filenames);
343 unixctl_server_destroy(unixctl);
345 if (run_process && process_exited(run_process)) {
346 int status = process_status(run_process);
348 ovs_fatal(0, "%s: child exited, %s",
349 run_command, process_status_msg(status));
352 perf_counters_destroy();
357 /* Returns true if 'filename' is known to be already open as a database,
360 * "False negatives" are possible. */
362 is_already_open(struct server_config *config OVS_UNUSED,
363 const char *filename OVS_UNUSED)
368 if (!stat(filename, &s)) {
369 struct shash_node *node;
371 SHASH_FOR_EACH (node, config->all_dbs) {
372 struct db *db = node->data;
375 if (!stat(db->filename, &s2)
376 && s.st_dev == s2.st_dev
377 && s.st_ino == s2.st_ino) {
388 close_db(struct db *db)
390 ovsdb_destroy(db->db);
396 open_db(struct server_config *config, const char *filename)
398 struct ovsdb_error *db_error;
402 /* If we know that the file is already open, return a good error message.
403 * Otherwise, if the file is open, we'll fail later on with a harder to
404 * interpret file locking error. */
405 if (is_already_open(config, filename)) {
406 return xasprintf("%s: already open", filename);
409 db = xzalloc(sizeof *db);
410 db->filename = xstrdup(filename);
412 db_error = ovsdb_file_open(db->filename, false, &db->db, &db->file);
414 error = ovsdb_error_to_string(db_error);
415 } else if (!ovsdb_jsonrpc_server_add_db(config->jsonrpc, db->db)) {
416 error = xasprintf("%s: duplicate database name", db->db->schema->name);
418 shash_add_assert(config->all_dbs, db->db->schema->name, db);
422 ovsdb_error_destroy(db_error);
427 static const struct db *
428 find_db(const struct shash *all_dbs, const char *db_name)
430 struct shash_node *node;
432 SHASH_FOR_EACH(node, all_dbs) {
433 struct db *db = node->data;
434 if (!strcmp(db->db->schema->name, db_name)) {
442 static char * OVS_WARN_UNUSED_RESULT
443 parse_db_column__(const struct shash *all_dbs,
444 const char *name_, char *name,
445 const struct db **dbp,
446 const struct ovsdb_table **tablep,
447 const struct ovsdb_column **columnp)
449 const char *db_name, *table_name, *column_name;
450 const struct ovsdb_column *column;
451 const struct ovsdb_table *table;
452 const char *tokens[3];
453 char *save_ptr = NULL;
460 strtok_r(name, ":", &save_ptr); /* "db:" */
461 tokens[0] = strtok_r(NULL, ",", &save_ptr);
462 tokens[1] = strtok_r(NULL, ",", &save_ptr);
463 tokens[2] = strtok_r(NULL, ",", &save_ptr);
464 if (!tokens[0] || !tokens[1] || !tokens[2]) {
465 return xasprintf("\"%s\": invalid syntax", name_);
469 table_name = tokens[1];
470 column_name = tokens[2];
472 db = find_db(all_dbs, tokens[0]);
474 return xasprintf("\"%s\": no database named %s", name_, db_name);
477 table = ovsdb_get_table(db->db, table_name);
479 return xasprintf("\"%s\": no table named %s", name_, table_name);
482 column = ovsdb_table_schema_get_column(table->schema, column_name);
484 return xasprintf("\"%s\": table \"%s\" has no column \"%s\"",
485 name_, table_name, column_name);
494 /* Returns NULL if successful, otherwise a malloc()'d string describing the
496 static char * OVS_WARN_UNUSED_RESULT
497 parse_db_column(const struct shash *all_dbs,
499 const struct db **dbp,
500 const struct ovsdb_table **tablep,
501 const struct ovsdb_column **columnp)
503 char *name = xstrdup(name_);
504 char *retval = parse_db_column__(all_dbs, name_, name,
505 dbp, tablep, columnp);
510 /* Returns NULL if successful, otherwise a malloc()'d string describing the
512 static char * OVS_WARN_UNUSED_RESULT
513 parse_db_string_column(const struct shash *all_dbs,
515 const struct db **dbp,
516 const struct ovsdb_table **tablep,
517 const struct ovsdb_column **columnp)
521 retval = parse_db_column(all_dbs, name, dbp, tablep, columnp);
526 if ((*columnp)->type.key.type != OVSDB_TYPE_STRING
527 || (*columnp)->type.value.type != OVSDB_TYPE_VOID) {
528 return xasprintf("\"%s\": table \"%s\" column \"%s\" is "
529 "not string or set of strings",
530 name, (*tablep)->schema->name, (*columnp)->name);
537 query_db_string(const struct shash *all_dbs, const char *name,
540 if (!name || strncmp(name, "db:", 3)) {
543 const struct ovsdb_column *column;
544 const struct ovsdb_table *table;
545 const struct ovsdb_row *row;
549 retval = parse_db_string_column(all_dbs, name,
550 &db, &table, &column);
552 ds_put_format(errors, "%s\n", retval);
557 HMAP_FOR_EACH (row, hmap_node, &table->rows) {
558 const struct ovsdb_datum *datum;
561 datum = &row->fields[column->index];
562 for (i = 0; i < datum->n; i++) {
563 if (datum->keys[i].string[0]) {
564 return datum->keys[i].string;
572 static struct ovsdb_jsonrpc_options *
573 add_remote(struct shash *remotes, const char *target)
575 struct ovsdb_jsonrpc_options *options;
577 options = shash_find_data(remotes, target);
579 options = ovsdb_jsonrpc_default_options(target);
580 shash_add(remotes, target, options);
586 static struct ovsdb_datum *
587 get_datum(struct ovsdb_row *row, const char *column_name,
588 const enum ovsdb_atomic_type key_type,
589 const enum ovsdb_atomic_type value_type,
592 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
593 const struct ovsdb_table_schema *schema = row->table->schema;
594 const struct ovsdb_column *column;
596 column = ovsdb_table_schema_get_column(schema, column_name);
598 VLOG_DBG_RL(&rl, "Table `%s' has no `%s' column",
599 schema->name, column_name);
603 if (column->type.key.type != key_type
604 || column->type.value.type != value_type
605 || column->type.n_max != n_max) {
606 if (!VLOG_DROP_DBG(&rl)) {
607 char *type_name = ovsdb_type_to_english(&column->type);
608 VLOG_DBG("Table `%s' column `%s' has type %s, not expected "
609 "key type %s, value type %s, max elements %"PRIuSIZE".",
610 schema->name, column_name, type_name,
611 ovsdb_atomic_type_to_string(key_type),
612 ovsdb_atomic_type_to_string(value_type),
619 return &row->fields[column->index];
622 /* Read string-string key-values from a map. Returns the value associated with
623 * 'key', if found, or NULL */
625 read_map_string_column(const struct ovsdb_row *row, const char *column_name,
628 const struct ovsdb_datum *datum;
629 union ovsdb_atom *atom_key = NULL, *atom_value = NULL;
632 datum = get_datum(CONST_CAST(struct ovsdb_row *, row), column_name,
633 OVSDB_TYPE_STRING, OVSDB_TYPE_STRING, UINT_MAX);
639 for (i = 0; i < datum->n; i++) {
640 atom_key = &datum->keys[i];
641 if (!strcmp(atom_key->string, key)){
642 atom_value = &datum->values[i];
647 return atom_value ? atom_value->string : NULL;
650 static const union ovsdb_atom *
651 read_column(const struct ovsdb_row *row, const char *column_name,
652 enum ovsdb_atomic_type type)
654 const struct ovsdb_datum *datum;
656 datum = get_datum(CONST_CAST(struct ovsdb_row *, row), column_name, type,
658 return datum && datum->n ? datum->keys : NULL;
662 read_integer_column(const struct ovsdb_row *row, const char *column_name,
663 long long int *integerp)
665 const union ovsdb_atom *atom;
667 atom = read_column(row, column_name, OVSDB_TYPE_INTEGER);
668 *integerp = atom ? atom->integer : 0;
673 read_string_column(const struct ovsdb_row *row, const char *column_name,
674 const char **stringp)
676 const union ovsdb_atom *atom;
678 atom = read_column(row, column_name, OVSDB_TYPE_STRING);
679 *stringp = atom ? atom->string : NULL;
684 write_bool_column(struct ovsdb_row *row, const char *column_name, bool value)
686 const struct ovsdb_column *column;
687 struct ovsdb_datum *datum;
689 column = ovsdb_table_schema_get_column(row->table->schema, column_name);
690 datum = get_datum(row, column_name, OVSDB_TYPE_BOOLEAN,
697 ovsdb_datum_destroy(datum, &column->type);
700 datum->keys = xmalloc(sizeof *datum->keys);
701 datum->values = NULL;
704 datum->keys[0].boolean = value;
708 write_string_string_column(struct ovsdb_row *row, const char *column_name,
709 char **keys, char **values, size_t n)
711 const struct ovsdb_column *column;
712 struct ovsdb_datum *datum;
715 column = ovsdb_table_schema_get_column(row->table->schema, column_name);
716 datum = get_datum(row, column_name, OVSDB_TYPE_STRING, OVSDB_TYPE_STRING,
719 for (i = 0; i < n; i++) {
726 /* Free existing data. */
727 ovsdb_datum_destroy(datum, &column->type);
729 /* Allocate space for new values. */
731 datum->keys = xmalloc(n * sizeof *datum->keys);
732 datum->values = xmalloc(n * sizeof *datum->values);
734 for (i = 0; i < n; ++i) {
735 datum->keys[i].string = keys[i];
736 datum->values[i].string = values[i];
739 /* Sort and check constraints. */
740 ovsdb_datum_sort_assert(datum, column->type.key.type);
743 /* Adds a remote and options to 'remotes', based on the Manager table row in
746 add_manager_options(struct shash *remotes, const struct ovsdb_row *row)
748 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
749 struct ovsdb_jsonrpc_options *options;
750 long long int max_backoff, probe_interval;
751 const char *target, *dscp_string;
753 if (!read_string_column(row, "target", &target) || !target) {
754 VLOG_INFO_RL(&rl, "Table `%s' has missing or invalid `target' column",
755 row->table->schema->name);
759 options = add_remote(remotes, target);
760 if (read_integer_column(row, "max_backoff", &max_backoff)) {
761 options->max_backoff = max_backoff;
763 if (read_integer_column(row, "inactivity_probe", &probe_interval)) {
764 options->probe_interval = probe_interval;
767 options->dscp = DSCP_DEFAULT;
768 dscp_string = read_map_string_column(row, "other_config", "dscp");
770 int dscp = atoi(dscp_string);
771 if (dscp >= 0 && dscp <= 63) {
772 options->dscp = dscp;
778 query_db_remotes(const char *name, const struct shash *all_dbs,
779 struct shash *remotes, struct ds *errors)
781 const struct ovsdb_column *column;
782 const struct ovsdb_table *table;
783 const struct ovsdb_row *row;
787 retval = parse_db_column(all_dbs, name, &db, &table, &column);
789 ds_put_format(errors, "%s\n", retval);
794 if (column->type.key.type == OVSDB_TYPE_STRING
795 && column->type.value.type == OVSDB_TYPE_VOID) {
796 HMAP_FOR_EACH (row, hmap_node, &table->rows) {
797 const struct ovsdb_datum *datum;
800 datum = &row->fields[column->index];
801 for (i = 0; i < datum->n; i++) {
802 add_remote(remotes, datum->keys[i].string);
805 } else if (column->type.key.type == OVSDB_TYPE_UUID
806 && column->type.key.u.uuid.refTable
807 && column->type.value.type == OVSDB_TYPE_VOID) {
808 const struct ovsdb_table *ref_table = column->type.key.u.uuid.refTable;
809 HMAP_FOR_EACH (row, hmap_node, &table->rows) {
810 const struct ovsdb_datum *datum;
813 datum = &row->fields[column->index];
814 for (i = 0; i < datum->n; i++) {
815 const struct ovsdb_row *ref_row;
817 ref_row = ovsdb_table_get_row(ref_table, &datum->keys[i].uuid);
819 add_manager_options(remotes, ref_row);
827 update_remote_row(const struct ovsdb_row *row, struct ovsdb_txn *txn,
828 const struct ovsdb_jsonrpc_server *jsonrpc)
830 struct ovsdb_jsonrpc_remote_status status;
831 struct ovsdb_row *rw_row;
833 char *keys[9], *values[9];
836 /* Get the "target" (protocol/host/port) spec. */
837 if (!read_string_column(row, "target", &target)) {
838 /* Bad remote spec or incorrect schema. */
841 rw_row = ovsdb_txn_row_modify(txn, row);
842 ovsdb_jsonrpc_server_get_remote_status(jsonrpc, target, &status);
844 /* Update status information columns. */
845 write_bool_column(rw_row, "is_connected", status.is_connected);
848 keys[n] = xstrdup("state");
849 values[n++] = xstrdup(status.state);
851 if (status.sec_since_connect != UINT_MAX) {
852 keys[n] = xstrdup("sec_since_connect");
853 values[n++] = xasprintf("%u", status.sec_since_connect);
855 if (status.sec_since_disconnect != UINT_MAX) {
856 keys[n] = xstrdup("sec_since_disconnect");
857 values[n++] = xasprintf("%u", status.sec_since_disconnect);
859 if (status.last_error) {
860 keys[n] = xstrdup("last_error");
862 xstrdup(ovs_retval_to_string(status.last_error));
864 if (status.locks_held && status.locks_held[0]) {
865 keys[n] = xstrdup("locks_held");
866 values[n++] = xstrdup(status.locks_held);
868 if (status.locks_waiting && status.locks_waiting[0]) {
869 keys[n] = xstrdup("locks_waiting");
870 values[n++] = xstrdup(status.locks_waiting);
872 if (status.locks_lost && status.locks_lost[0]) {
873 keys[n] = xstrdup("locks_lost");
874 values[n++] = xstrdup(status.locks_lost);
876 if (status.n_connections > 1) {
877 keys[n] = xstrdup("n_connections");
878 values[n++] = xasprintf("%d", status.n_connections);
880 if (status.bound_port != htons(0)) {
881 keys[n] = xstrdup("bound_port");
882 values[n++] = xasprintf("%"PRIu16, ntohs(status.bound_port));
884 write_string_string_column(rw_row, "status", keys, values, n);
886 ovsdb_jsonrpc_server_free_remote_status(&status);
890 update_remote_rows(const struct shash *all_dbs,
891 const char *remote_name,
892 const struct ovsdb_jsonrpc_server *jsonrpc)
894 const struct ovsdb_table *table, *ref_table;
895 const struct ovsdb_column *column;
896 const struct ovsdb_row *row;
900 if (strncmp("db:", remote_name, 3)) {
904 retval = parse_db_column(all_dbs, remote_name, &db, &table, &column);
910 if (column->type.key.type != OVSDB_TYPE_UUID
911 || !column->type.key.u.uuid.refTable
912 || column->type.value.type != OVSDB_TYPE_VOID) {
916 ref_table = column->type.key.u.uuid.refTable;
918 HMAP_FOR_EACH (row, hmap_node, &table->rows) {
919 const struct ovsdb_datum *datum;
922 datum = &row->fields[column->index];
923 for (i = 0; i < datum->n; i++) {
924 const struct ovsdb_row *ref_row;
926 ref_row = ovsdb_table_get_row(ref_table, &datum->keys[i].uuid);
928 update_remote_row(ref_row, db->txn, jsonrpc);
935 update_remote_status(const struct ovsdb_jsonrpc_server *jsonrpc,
936 const struct sset *remotes,
937 struct shash *all_dbs)
939 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
942 struct shash_node *node;
944 SHASH_FOR_EACH(node, all_dbs) {
946 db->txn = ovsdb_txn_create(db->db);
949 /* Iterate over --remote arguments given on command line. */
950 SSET_FOR_EACH (remote, remotes) {
951 update_remote_rows(all_dbs, remote, jsonrpc);
954 SHASH_FOR_EACH(node, all_dbs) {
955 struct ovsdb_error *error;
957 error = ovsdb_txn_commit(db->txn, false);
959 VLOG_ERR_RL(&rl, "Failed to update remote status: %s",
960 ovsdb_error_to_string(error));
961 ovsdb_error_destroy(error);
966 /* Reconfigures ovsdb-server's remotes based on information in the database. */
968 reconfigure_remotes(struct ovsdb_jsonrpc_server *jsonrpc,
969 const struct shash *all_dbs, struct sset *remotes)
971 struct ds errors = DS_EMPTY_INITIALIZER;
972 struct shash resolved_remotes;
975 /* Configure remotes. */
976 shash_init(&resolved_remotes);
977 SSET_FOR_EACH (name, remotes) {
978 if (!strncmp(name, "db:", 3)) {
979 query_db_remotes(name, all_dbs, &resolved_remotes, &errors);
981 add_remote(&resolved_remotes, name);
984 ovsdb_jsonrpc_server_set_remotes(jsonrpc, &resolved_remotes);
985 shash_destroy_free_data(&resolved_remotes);
987 return errors.string;
991 reconfigure_ssl(const struct shash *all_dbs)
993 struct ds errors = DS_EMPTY_INITIALIZER;
994 const char *resolved_private_key;
995 const char *resolved_certificate;
996 const char *resolved_ca_cert;
998 resolved_private_key = query_db_string(all_dbs, private_key_file, &errors);
999 resolved_certificate = query_db_string(all_dbs, certificate_file, &errors);
1000 resolved_ca_cert = query_db_string(all_dbs, ca_cert_file, &errors);
1002 stream_ssl_set_key_and_cert(resolved_private_key, resolved_certificate);
1003 stream_ssl_set_ca_cert_file(resolved_ca_cert, bootstrap_ca_cert);
1005 return errors.string;
1009 report_error_if_changed(char *error, char **last_errorp)
1012 if (!*last_errorp || strcmp(error, *last_errorp)) {
1013 VLOG_WARN("%s", error);
1015 *last_errorp = error;
1021 *last_errorp = NULL;
1026 ovsdb_server_exit(struct unixctl_conn *conn, int argc OVS_UNUSED,
1027 const char *argv[] OVS_UNUSED,
1030 bool *exiting = exiting_;
1032 unixctl_command_reply(conn, NULL);
1036 ovsdb_server_perf_counters_show(struct unixctl_conn *conn, int argc OVS_UNUSED,
1037 const char *argv[] OVS_UNUSED,
1038 void *arg_ OVS_UNUSED)
1040 char *s = perf_counters_to_string();
1042 unixctl_command_reply(conn, s);
1047 ovsdb_server_perf_counters_clear(struct unixctl_conn *conn, int argc OVS_UNUSED,
1048 const char *argv[] OVS_UNUSED,
1049 void *arg_ OVS_UNUSED)
1051 perf_counters_clear();
1052 unixctl_command_reply(conn, NULL);
1056 ovsdb_server_compact(struct unixctl_conn *conn, int argc,
1057 const char *argv[], void *dbs_)
1059 struct shash *all_dbs = dbs_;
1062 struct shash_node *node;
1066 SHASH_FOR_EACH(node, all_dbs) {
1070 name = db->db->schema->name;
1072 if (argc < 2 || !strcmp(argv[1], name)) {
1073 struct ovsdb_error *error;
1075 VLOG_INFO("compacting %s database by user request", name);
1077 error = ovsdb_file_compact(db->file);
1079 char *s = ovsdb_error_to_string(error);
1080 ds_put_format(&reply, "%s\n", s);
1082 ovsdb_error_destroy(error);
1090 unixctl_command_reply_error(conn, "no database by that name");
1091 } else if (reply.length) {
1092 unixctl_command_reply_error(conn, ds_cstr(&reply));
1094 unixctl_command_reply(conn, NULL);
1099 /* "ovsdb-server/reconnect": makes ovsdb-server drop all of its JSON-RPC
1100 * connections and reconnect. */
1102 ovsdb_server_reconnect(struct unixctl_conn *conn, int argc OVS_UNUSED,
1103 const char *argv[] OVS_UNUSED, void *jsonrpc_)
1105 struct ovsdb_jsonrpc_server *jsonrpc = jsonrpc_;
1107 ovsdb_jsonrpc_server_reconnect(jsonrpc);
1108 unixctl_command_reply(conn, NULL);
1111 /* "ovsdb-server/add-remote REMOTE": adds REMOTE to the set of remotes that
1112 * ovsdb-server services. */
1114 ovsdb_server_add_remote(struct unixctl_conn *conn, int argc OVS_UNUSED,
1115 const char *argv[], void *config_)
1117 struct server_config *config = config_;
1118 const char *remote = argv[1];
1120 const struct ovsdb_column *column;
1121 const struct ovsdb_table *table;
1122 const struct db *db;
1125 retval = (strncmp("db:", remote, 3)
1127 : parse_db_column(config->all_dbs, remote,
1128 &db, &table, &column));
1130 if (sset_add(config->remotes, remote)) {
1131 save_config(config);
1133 unixctl_command_reply(conn, NULL);
1135 unixctl_command_reply_error(conn, retval);
1140 /* "ovsdb-server/remove-remote REMOTE": removes REMOTE frmo the set of remotes
1141 * that ovsdb-server services. */
1143 ovsdb_server_remove_remote(struct unixctl_conn *conn, int argc OVS_UNUSED,
1144 const char *argv[], void *config_)
1146 struct server_config *config = config_;
1147 struct sset_node *node;
1149 node = sset_find(config->remotes, argv[1]);
1151 sset_delete(config->remotes, node);
1152 save_config(config);
1153 unixctl_command_reply(conn, NULL);
1155 unixctl_command_reply_error(conn, "no such remote");
1159 /* "ovsdb-server/list-remotes": outputs a list of configured rmeotes. */
1161 ovsdb_server_list_remotes(struct unixctl_conn *conn, int argc OVS_UNUSED,
1162 const char *argv[] OVS_UNUSED, void *remotes_)
1164 struct sset *remotes = remotes_;
1165 const char **list, **p;
1170 list = sset_sort(remotes);
1171 for (p = list; *p; p++) {
1172 ds_put_format(&s, "%s\n", *p);
1176 unixctl_command_reply(conn, ds_cstr(&s));
1181 /* "ovsdb-server/add-db DB": adds the DB to ovsdb-server. */
1183 ovsdb_server_add_database(struct unixctl_conn *conn, int argc OVS_UNUSED,
1184 const char *argv[], void *config_)
1186 struct server_config *config = config_;
1187 const char *filename = argv[1];
1190 error = open_db(config, filename);
1192 save_config(config);
1193 unixctl_command_reply(conn, NULL);
1195 unixctl_command_reply_error(conn, error);
1201 ovsdb_server_remove_database(struct unixctl_conn *conn, int argc OVS_UNUSED,
1202 const char *argv[], void *config_)
1204 struct server_config *config = config_;
1205 struct shash_node *node;
1209 node = shash_find(config->all_dbs, argv[1]);
1211 unixctl_command_reply_error(conn, "Failed to find the database.");
1216 ok = ovsdb_jsonrpc_server_remove_db(config->jsonrpc, db->db);
1220 shash_delete(config->all_dbs, node);
1222 save_config(config);
1223 unixctl_command_reply(conn, NULL);
1227 ovsdb_server_list_databases(struct unixctl_conn *conn, int argc OVS_UNUSED,
1228 const char *argv[] OVS_UNUSED, void *all_dbs_)
1230 struct shash *all_dbs = all_dbs_;
1231 const struct shash_node **nodes;
1237 nodes = shash_sort(all_dbs);
1238 for (i = 0; i < shash_count(all_dbs); i++) {
1239 struct db *db = nodes[i]->data;
1240 ds_put_format(&s, "%s\n", db->db->schema->name);
1244 unixctl_command_reply(conn, ds_cstr(&s));
1249 parse_options(int *argcp, char **argvp[],
1250 struct sset *remotes, char **unixctl_pathp, char **run_command)
1253 OPT_REMOTE = UCHAR_MAX + 1,
1256 OPT_BOOTSTRAP_CA_CERT,
1261 static const struct option long_options[] = {
1262 {"remote", required_argument, NULL, OPT_REMOTE},
1263 {"unixctl", required_argument, NULL, OPT_UNIXCTL},
1265 {"run", required_argument, NULL, OPT_RUN},
1267 {"help", no_argument, NULL, 'h'},
1268 {"version", no_argument, NULL, 'V'},
1269 DAEMON_LONG_OPTIONS,
1271 {"bootstrap-ca-cert", required_argument, NULL, OPT_BOOTSTRAP_CA_CERT},
1272 {"peer-ca-cert", required_argument, NULL, OPT_PEER_CA_CERT},
1273 {"private-key", required_argument, NULL, 'p'},
1274 {"certificate", required_argument, NULL, 'c'},
1275 {"ca-cert", required_argument, NULL, 'C'},
1278 char *short_options = ovs_cmdl_long_options_to_short_options(long_options);
1280 char **argv = *argvp;
1286 c = getopt_long(argc, argv, short_options, long_options, NULL);
1293 sset_add(remotes, optarg);
1297 *unixctl_pathp = optarg;
1301 *run_command = optarg;
1308 ovs_print_version(0, 0);
1311 VLOG_OPTION_HANDLERS
1312 DAEMON_OPTION_HANDLERS
1315 private_key_file = optarg;
1319 certificate_file = optarg;
1323 ca_cert_file = optarg;
1324 bootstrap_ca_cert = false;
1327 case OPT_BOOTSTRAP_CA_CERT:
1328 ca_cert_file = optarg;
1329 bootstrap_ca_cert = true;
1332 case OPT_PEER_CA_CERT:
1333 stream_ssl_set_peer_ca_cert_file(optarg);
1343 free(short_options);
1352 printf("%s: Open vSwitch database server\n"
1353 "usage: %s [OPTIONS] [DATABASE...]\n"
1354 "where each DATABASE is a database file in ovsdb format.\n"
1355 "The default DATABASE, if none is given, is\n%s/conf.db.\n",
1356 program_name, program_name, ovs_dbdir());
1357 printf("\nJSON-RPC options (may be specified any number of times):\n"
1358 " --remote=REMOTE connect or listen to REMOTE\n");
1359 stream_usage("JSON-RPC", true, true, true);
1362 printf("\nOther options:\n"
1363 " --run COMMAND run COMMAND as subprocess then exit\n"
1364 " --unixctl=SOCKET override default control socket name\n"
1365 " -h, --help display this help message\n"
1366 " -V, --version display version information\n");
1370 static struct json *
1371 sset_to_json(const struct sset *sset)
1376 array = json_array_create_empty();
1377 SSET_FOR_EACH (s, sset) {
1378 json_array_add(array, json_string_create(s));
1383 /* Truncates and replaces the contents of 'config_file' by a representation of
1384 * 'remotes' and 'db_filenames'. */
1386 save_config__(FILE *config_file, const struct sset *remotes,
1387 const struct sset *db_filenames)
1392 if (ftruncate(fileno(config_file), 0) == -1) {
1393 VLOG_FATAL("failed to truncate temporary file (%s)",
1394 ovs_strerror(errno));
1397 obj = json_object_create();
1398 json_object_put(obj, "remotes", sset_to_json(remotes));
1399 json_object_put(obj, "db_filenames", sset_to_json(db_filenames));
1400 s = json_to_string(obj, 0);
1403 if (fseek(config_file, 0, SEEK_SET) != 0
1404 || fputs(s, config_file) == EOF
1405 || fflush(config_file) == EOF) {
1406 VLOG_FATAL("failed to write temporary file (%s)", ovs_strerror(errno));
1411 /* Truncates and replaces the contents of 'config_file' by a representation of
1414 save_config(struct server_config *config)
1416 struct sset db_filenames;
1417 struct shash_node *node;
1419 sset_init(&db_filenames);
1420 SHASH_FOR_EACH (node, config->all_dbs) {
1421 struct db *db = node->data;
1422 sset_add(&db_filenames, db->filename);
1425 save_config__(config->config_tmpfile, config->remotes, &db_filenames);
1427 sset_destroy(&db_filenames);
1431 sset_from_json(struct sset *sset, const struct json *array)
1437 ovs_assert(array->type == JSON_ARRAY);
1438 for (i = 0; i < array->u.array.n; i++) {
1439 const struct json *elem = array->u.array.elems[i];
1440 sset_add(sset, json_string(elem));
1444 /* Clears and replaces 'remotes' and 'dbnames' by a configuration read from
1445 * 'config_file', which must have been previously written by save_config(). */
1447 load_config(FILE *config_file, struct sset *remotes, struct sset *db_filenames)
1451 if (fseek(config_file, 0, SEEK_SET) != 0) {
1452 VLOG_FATAL("seek failed in temporary file (%s)", ovs_strerror(errno));
1454 json = json_from_stream(config_file);
1455 if (json->type == JSON_STRING) {
1456 VLOG_FATAL("reading json failed (%s)", json_string(json));
1458 ovs_assert(json->type == JSON_OBJECT);
1460 sset_from_json(remotes, shash_find_data(json_object(json), "remotes"));
1461 sset_from_json(db_filenames,
1462 shash_find_data(json_object(json), "db_filenames"));