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"
30 #include "dynamic-string.h"
31 #include "fatal-signal.h"
36 #include "jsonrpc-server.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"
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;
81 struct server_config {
83 struct shash *all_dbs;
85 struct ovsdb_jsonrpc_server *jsonrpc;
87 static unixctl_cb_func ovsdb_server_add_remote;
88 static unixctl_cb_func ovsdb_server_remove_remote;
89 static unixctl_cb_func ovsdb_server_list_remotes;
91 static unixctl_cb_func ovsdb_server_add_database;
92 static unixctl_cb_func ovsdb_server_remove_database;
93 static unixctl_cb_func ovsdb_server_list_databases;
95 static char *open_db(struct server_config *config, const char *filename);
96 static void close_db(struct db *db);
98 static void parse_options(int *argc, char **argvp[],
99 struct sset *remotes, char **unixctl_pathp,
101 static void usage(void) NO_RETURN;
103 static char *reconfigure_remotes(struct ovsdb_jsonrpc_server *,
104 const struct shash *all_dbs,
105 struct sset *remotes);
106 static char *reconfigure_ssl(const struct shash *all_dbs);
107 static void report_error_if_changed(char *error, char **last_errorp);
109 static void update_remote_status(const struct ovsdb_jsonrpc_server *jsonrpc,
110 const struct sset *remotes,
111 struct shash *all_dbs);
113 static void save_config__(FILE *config_file, const struct sset *remotes,
114 const struct sset *db_filenames);
115 static void save_config(struct server_config *);
116 static void load_config(FILE *config_file, struct sset *remotes,
117 struct sset *db_filenames);
120 main_loop(struct ovsdb_jsonrpc_server *jsonrpc, struct shash *all_dbs,
121 struct unixctl_server *unixctl, struct sset *remotes,
122 struct process *run_process, bool *exiting)
124 char *remotes_error, *ssl_error;
125 struct shash_node *node;
126 long long int status_timer = LLONG_MIN;
130 remotes_error = NULL;
133 if (memory_should_report()) {
137 ovsdb_jsonrpc_server_get_memory_usage(jsonrpc, &usage);
138 SHASH_FOR_EACH(node, all_dbs) {
139 struct db *db = node->data;
140 ovsdb_get_memory_usage(db->db, &usage);
142 memory_report(&usage);
143 simap_destroy(&usage);
146 /* Run unixctl_server_run() before reconfigure_remotes() because
147 * ovsdb-server/add-remote and ovsdb-server/remove-remote can change
148 * the set of remotes that reconfigure_remotes() uses. */
149 unixctl_server_run(unixctl);
151 report_error_if_changed(
152 reconfigure_remotes(jsonrpc, all_dbs, remotes),
154 report_error_if_changed(reconfigure_ssl(all_dbs), &ssl_error);
155 ovsdb_jsonrpc_server_run(jsonrpc);
157 SHASH_FOR_EACH(node, all_dbs) {
158 struct db *db = node->data;
159 ovsdb_trigger_run(db->db, time_msec());
163 if (process_exited(run_process)) {
168 /* update Manager status(es) every 5 seconds */
169 if (time_msec() >= status_timer) {
170 status_timer = time_msec() + 5000;
171 update_remote_status(jsonrpc, remotes, all_dbs);
175 ovsdb_jsonrpc_server_wait(jsonrpc);
176 unixctl_server_wait(unixctl);
177 SHASH_FOR_EACH(node, all_dbs) {
178 struct db *db = node->data;
179 ovsdb_trigger_wait(db->db, time_msec());
182 process_wait(run_process);
185 poll_immediate_wake();
187 poll_timer_wait_until(status_timer);
189 if (should_service_stop()) {
197 main(int argc, char *argv[])
199 char *unixctl_path = NULL;
200 char *run_command = NULL;
201 struct unixctl_server *unixctl;
202 struct ovsdb_jsonrpc_server *jsonrpc;
203 struct sset remotes, db_filenames;
204 const char *db_filename;
205 struct process *run_process;
208 FILE *config_tmpfile;
209 struct server_config server_config;
210 struct shash all_dbs;
211 struct shash_node *node, *next;
215 proctitle_init(argc, argv);
216 set_program_name(argv[0]);
217 service_start(&argc, &argv);
218 fatal_ignore_sigpipe();
221 parse_options(&argc, &argv, &remotes, &unixctl_path, &run_command);
223 /* Create and initialize 'config_tmpfile' as a temporary file to hold
224 * ovsdb-server's most basic configuration, and then save our initial
225 * configuration to it. When --monitor is used, this preserves the effects
226 * of ovs-appctl commands such as ovsdb-server/add-remote (which saves the
227 * new configuration) across crashes. */
228 config_tmpfile = tmpfile();
229 if (!config_tmpfile) {
230 ovs_fatal(errno, "failed to create temporary file");
233 sset_init(&db_filenames);
235 for (i = 0; i < argc; i++) {
236 sset_add(&db_filenames, argv[i]);
239 char *default_db = xasprintf("%s/conf.db", ovs_dbdir());
240 sset_add(&db_filenames, default_db);
244 server_config.remotes = &remotes;
245 server_config.config_tmpfile = config_tmpfile;
247 save_config__(config_tmpfile, &remotes, &db_filenames);
251 /* Load the saved config. */
252 load_config(config_tmpfile, &remotes, &db_filenames);
253 jsonrpc = ovsdb_jsonrpc_server_create();
255 shash_init(&all_dbs);
256 server_config.all_dbs = &all_dbs;
257 server_config.jsonrpc = jsonrpc;
258 SSET_FOR_EACH (db_filename, &db_filenames) {
259 error = open_db(&server_config, db_filename);
261 ovs_fatal(0, "%s", error);
265 error = reconfigure_remotes(jsonrpc, &all_dbs, &remotes);
267 error = reconfigure_ssl(&all_dbs);
270 ovs_fatal(0, "%s", error);
273 retval = unixctl_server_create(unixctl_path, &unixctl);
281 run_argv[0] = "/bin/sh";
283 run_argv[2] = run_command;
286 retval = process_start(run_argv, &run_process);
288 ovs_fatal(retval, "%s: process failed to start", run_command);
294 daemonize_complete();
297 /* ovsdb-server is usually a long-running process, in which case it
298 * makes plenty of sense to log the version, but --run makes
299 * ovsdb-server more like a command-line tool, so skip it. */
300 VLOG_INFO("%s (Open vSwitch) %s", program_name, VERSION);
303 unixctl_command_register("exit", "", 0, 0, ovsdb_server_exit, &exiting);
304 unixctl_command_register("ovsdb-server/compact", "", 0, 1,
305 ovsdb_server_compact, &all_dbs);
306 unixctl_command_register("ovsdb-server/reconnect", "", 0, 0,
307 ovsdb_server_reconnect, jsonrpc);
309 unixctl_command_register("ovsdb-server/add-remote", "REMOTE", 1, 1,
310 ovsdb_server_add_remote, &server_config);
311 unixctl_command_register("ovsdb-server/remove-remote", "REMOTE", 1, 1,
312 ovsdb_server_remove_remote, &server_config);
313 unixctl_command_register("ovsdb-server/list-remotes", "", 0, 0,
314 ovsdb_server_list_remotes, &remotes);
316 unixctl_command_register("ovsdb-server/add-db", "DB", 1, 1,
317 ovsdb_server_add_database, &server_config);
318 unixctl_command_register("ovsdb-server/remove-db", "DB", 1, 1,
319 ovsdb_server_remove_database, &server_config);
320 unixctl_command_register("ovsdb-server/list-dbs", "", 0, 0,
321 ovsdb_server_list_databases, &all_dbs);
323 main_loop(jsonrpc, &all_dbs, unixctl, &remotes, run_process, &exiting);
325 ovsdb_jsonrpc_server_destroy(jsonrpc);
326 SHASH_FOR_EACH_SAFE(node, next, &all_dbs) {
327 struct db *db = node->data;
329 shash_delete(&all_dbs, node);
331 sset_destroy(&remotes);
332 sset_destroy(&db_filenames);
333 unixctl_server_destroy(unixctl);
335 if (run_process && process_exited(run_process)) {
336 int status = process_status(run_process);
338 ovs_fatal(0, "%s: child exited, %s",
339 run_command, process_status_msg(status));
347 /* Returns true if 'filename' is known to be already open as a database,
350 * "False negatives" are possible. */
352 is_already_open(struct server_config *config OVS_UNUSED,
353 const char *filename OVS_UNUSED)
358 if (!stat(filename, &s)) {
359 struct shash_node *node;
361 SHASH_FOR_EACH (node, config->all_dbs) {
362 struct db *db = node->data;
365 if (!stat(db->filename, &s2)
366 && s.st_dev == s2.st_dev
367 && s.st_ino == s2.st_ino) {
378 close_db(struct db *db)
380 ovsdb_destroy(db->db);
386 open_db(struct server_config *config, const char *filename)
388 struct ovsdb_error *db_error;
392 /* If we know that the file is already open, return a good error message.
393 * Otherwise, if the file is open, we'll fail later on with a harder to
394 * interpret file locking error. */
395 if (is_already_open(config, filename)) {
396 return xasprintf("%s: already open", filename);
399 db = xzalloc(sizeof *db);
400 db->filename = xstrdup(filename);
402 db_error = ovsdb_file_open(db->filename, false, &db->db, &db->file);
404 error = ovsdb_error_to_string(db_error);
405 } else if (!ovsdb_jsonrpc_server_add_db(config->jsonrpc, db->db)) {
406 error = xasprintf("%s: duplicate database name", db->db->schema->name);
408 shash_add_assert(config->all_dbs, db->db->schema->name, db);
412 ovsdb_error_destroy(db_error);
417 static const struct db *
418 find_db(const struct shash *all_dbs, const char *db_name)
420 struct shash_node *node;
422 SHASH_FOR_EACH(node, all_dbs) {
423 struct db *db = node->data;
424 if (!strcmp(db->db->schema->name, db_name)) {
432 static char * WARN_UNUSED_RESULT
433 parse_db_column__(const struct shash *all_dbs,
434 const char *name_, char *name,
435 const struct db **dbp,
436 const struct ovsdb_table **tablep,
437 const struct ovsdb_column **columnp)
439 const char *db_name, *table_name, *column_name;
440 const struct ovsdb_column *column;
441 const struct ovsdb_table *table;
442 const char *tokens[3];
443 char *save_ptr = NULL;
450 strtok_r(name, ":", &save_ptr); /* "db:" */
451 tokens[0] = strtok_r(NULL, ",", &save_ptr);
452 tokens[1] = strtok_r(NULL, ",", &save_ptr);
453 tokens[2] = strtok_r(NULL, ",", &save_ptr);
454 if (!tokens[0] || !tokens[1] || !tokens[2]) {
455 return xasprintf("\"%s\": invalid syntax", name_);
459 table_name = tokens[1];
460 column_name = tokens[2];
462 db = find_db(all_dbs, tokens[0]);
464 return xasprintf("\"%s\": no database named %s", name_, db_name);
467 table = ovsdb_get_table(db->db, table_name);
469 return xasprintf("\"%s\": no table named %s", name_, table_name);
472 column = ovsdb_table_schema_get_column(table->schema, column_name);
474 return xasprintf("\"%s\": table \"%s\" has no column \"%s\"",
475 name_, table_name, column_name);
484 /* Returns NULL if successful, otherwise a malloc()'d string describing the
486 static char * WARN_UNUSED_RESULT
487 parse_db_column(const struct shash *all_dbs,
489 const struct db **dbp,
490 const struct ovsdb_table **tablep,
491 const struct ovsdb_column **columnp)
493 char *name = xstrdup(name_);
494 char *retval = parse_db_column__(all_dbs, name_, name,
495 dbp, tablep, columnp);
500 /* Returns NULL if successful, otherwise a malloc()'d string describing the
502 static char * WARN_UNUSED_RESULT
503 parse_db_string_column(const struct shash *all_dbs,
505 const struct db **dbp,
506 const struct ovsdb_table **tablep,
507 const struct ovsdb_column **columnp)
511 retval = parse_db_column(all_dbs, name, dbp, tablep, columnp);
516 if ((*columnp)->type.key.type != OVSDB_TYPE_STRING
517 || (*columnp)->type.value.type != OVSDB_TYPE_VOID) {
518 return xasprintf("\"%s\": table \"%s\" column \"%s\" is "
519 "not string or set of strings",
520 name, (*tablep)->schema->name, (*columnp)->name);
527 query_db_string(const struct shash *all_dbs, const char *name,
530 if (!name || strncmp(name, "db:", 3)) {
533 const struct ovsdb_column *column;
534 const struct ovsdb_table *table;
535 const struct ovsdb_row *row;
539 retval = parse_db_string_column(all_dbs, name,
540 &db, &table, &column);
542 ds_put_format(errors, "%s\n", retval);
547 HMAP_FOR_EACH (row, hmap_node, &table->rows) {
548 const struct ovsdb_datum *datum;
551 datum = &row->fields[column->index];
552 for (i = 0; i < datum->n; i++) {
553 if (datum->keys[i].string[0]) {
554 return datum->keys[i].string;
562 static struct ovsdb_jsonrpc_options *
563 add_remote(struct shash *remotes, const char *target)
565 struct ovsdb_jsonrpc_options *options;
567 options = shash_find_data(remotes, target);
569 options = ovsdb_jsonrpc_default_options(target);
570 shash_add(remotes, target, options);
576 static struct ovsdb_datum *
577 get_datum(struct ovsdb_row *row, const char *column_name,
578 const enum ovsdb_atomic_type key_type,
579 const enum ovsdb_atomic_type value_type,
582 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
583 const struct ovsdb_table_schema *schema = row->table->schema;
584 const struct ovsdb_column *column;
586 column = ovsdb_table_schema_get_column(schema, column_name);
588 VLOG_DBG_RL(&rl, "Table `%s' has no `%s' column",
589 schema->name, column_name);
593 if (column->type.key.type != key_type
594 || column->type.value.type != value_type
595 || column->type.n_max != n_max) {
596 if (!VLOG_DROP_DBG(&rl)) {
597 char *type_name = ovsdb_type_to_english(&column->type);
598 VLOG_DBG("Table `%s' column `%s' has type %s, not expected "
599 "key type %s, value type %s, max elements %"PRIuSIZE".",
600 schema->name, column_name, type_name,
601 ovsdb_atomic_type_to_string(key_type),
602 ovsdb_atomic_type_to_string(value_type),
609 return &row->fields[column->index];
612 /* Read string-string key-values from a map. Returns the value associated with
613 * 'key', if found, or NULL */
615 read_map_string_column(const struct ovsdb_row *row, const char *column_name,
618 const struct ovsdb_datum *datum;
619 union ovsdb_atom *atom_key = NULL, *atom_value = NULL;
622 datum = get_datum(CONST_CAST(struct ovsdb_row *, row), column_name,
623 OVSDB_TYPE_STRING, OVSDB_TYPE_STRING, UINT_MAX);
629 for (i = 0; i < datum->n; i++) {
630 atom_key = &datum->keys[i];
631 if (!strcmp(atom_key->string, key)){
632 atom_value = &datum->values[i];
637 return atom_value ? atom_value->string : NULL;
640 static const union ovsdb_atom *
641 read_column(const struct ovsdb_row *row, const char *column_name,
642 enum ovsdb_atomic_type type)
644 const struct ovsdb_datum *datum;
646 datum = get_datum(CONST_CAST(struct ovsdb_row *, row), column_name, type,
648 return datum && datum->n ? datum->keys : NULL;
652 read_integer_column(const struct ovsdb_row *row, const char *column_name,
653 long long int *integerp)
655 const union ovsdb_atom *atom;
657 atom = read_column(row, column_name, OVSDB_TYPE_INTEGER);
658 *integerp = atom ? atom->integer : 0;
663 read_string_column(const struct ovsdb_row *row, const char *column_name,
664 const char **stringp)
666 const union ovsdb_atom *atom;
668 atom = read_column(row, column_name, OVSDB_TYPE_STRING);
669 *stringp = atom ? atom->string : NULL;
674 write_bool_column(struct ovsdb_row *row, const char *column_name, bool value)
676 const struct ovsdb_column *column;
677 struct ovsdb_datum *datum;
679 column = ovsdb_table_schema_get_column(row->table->schema, column_name);
680 datum = get_datum(row, column_name, OVSDB_TYPE_BOOLEAN,
687 ovsdb_datum_destroy(datum, &column->type);
690 datum->keys = xmalloc(sizeof *datum->keys);
691 datum->values = NULL;
694 datum->keys[0].boolean = value;
698 write_string_string_column(struct ovsdb_row *row, const char *column_name,
699 char **keys, char **values, size_t n)
701 const struct ovsdb_column *column;
702 struct ovsdb_datum *datum;
705 column = ovsdb_table_schema_get_column(row->table->schema, column_name);
706 datum = get_datum(row, column_name, OVSDB_TYPE_STRING, OVSDB_TYPE_STRING,
709 for (i = 0; i < n; i++) {
716 /* Free existing data. */
717 ovsdb_datum_destroy(datum, &column->type);
719 /* Allocate space for new values. */
721 datum->keys = xmalloc(n * sizeof *datum->keys);
722 datum->values = xmalloc(n * sizeof *datum->values);
724 for (i = 0; i < n; ++i) {
725 datum->keys[i].string = keys[i];
726 datum->values[i].string = values[i];
729 /* Sort and check constraints. */
730 ovsdb_datum_sort_assert(datum, column->type.key.type);
733 /* Adds a remote and options to 'remotes', based on the Manager table row in
736 add_manager_options(struct shash *remotes, const struct ovsdb_row *row)
738 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
739 struct ovsdb_jsonrpc_options *options;
740 long long int max_backoff, probe_interval;
741 const char *target, *dscp_string;
743 if (!read_string_column(row, "target", &target) || !target) {
744 VLOG_INFO_RL(&rl, "Table `%s' has missing or invalid `target' column",
745 row->table->schema->name);
749 options = add_remote(remotes, target);
750 if (read_integer_column(row, "max_backoff", &max_backoff)) {
751 options->max_backoff = max_backoff;
753 if (read_integer_column(row, "inactivity_probe", &probe_interval)) {
754 options->probe_interval = probe_interval;
757 options->dscp = DSCP_DEFAULT;
758 dscp_string = read_map_string_column(row, "other_config", "dscp");
760 int dscp = atoi(dscp_string);
761 if (dscp >= 0 && dscp <= 63) {
762 options->dscp = dscp;
768 query_db_remotes(const char *name, const struct shash *all_dbs,
769 struct shash *remotes, struct ds *errors)
771 const struct ovsdb_column *column;
772 const struct ovsdb_table *table;
773 const struct ovsdb_row *row;
777 retval = parse_db_column(all_dbs, name, &db, &table, &column);
779 ds_put_format(errors, "%s\n", retval);
784 if (column->type.key.type == OVSDB_TYPE_STRING
785 && column->type.value.type == OVSDB_TYPE_VOID) {
786 HMAP_FOR_EACH (row, hmap_node, &table->rows) {
787 const struct ovsdb_datum *datum;
790 datum = &row->fields[column->index];
791 for (i = 0; i < datum->n; i++) {
792 add_remote(remotes, datum->keys[i].string);
795 } else if (column->type.key.type == OVSDB_TYPE_UUID
796 && column->type.key.u.uuid.refTable
797 && column->type.value.type == OVSDB_TYPE_VOID) {
798 const struct ovsdb_table *ref_table = column->type.key.u.uuid.refTable;
799 HMAP_FOR_EACH (row, hmap_node, &table->rows) {
800 const struct ovsdb_datum *datum;
803 datum = &row->fields[column->index];
804 for (i = 0; i < datum->n; i++) {
805 const struct ovsdb_row *ref_row;
807 ref_row = ovsdb_table_get_row(ref_table, &datum->keys[i].uuid);
809 add_manager_options(remotes, ref_row);
817 update_remote_row(const struct ovsdb_row *row, struct ovsdb_txn *txn,
818 const struct ovsdb_jsonrpc_server *jsonrpc)
820 struct ovsdb_jsonrpc_remote_status status;
821 struct ovsdb_row *rw_row;
823 char *keys[9], *values[9];
826 /* Get the "target" (protocol/host/port) spec. */
827 if (!read_string_column(row, "target", &target)) {
828 /* Bad remote spec or incorrect schema. */
831 rw_row = ovsdb_txn_row_modify(txn, row);
832 ovsdb_jsonrpc_server_get_remote_status(jsonrpc, target, &status);
834 /* Update status information columns. */
835 write_bool_column(rw_row, "is_connected", status.is_connected);
838 keys[n] = xstrdup("state");
839 values[n++] = xstrdup(status.state);
841 if (status.sec_since_connect != UINT_MAX) {
842 keys[n] = xstrdup("sec_since_connect");
843 values[n++] = xasprintf("%u", status.sec_since_connect);
845 if (status.sec_since_disconnect != UINT_MAX) {
846 keys[n] = xstrdup("sec_since_disconnect");
847 values[n++] = xasprintf("%u", status.sec_since_disconnect);
849 if (status.last_error) {
850 keys[n] = xstrdup("last_error");
852 xstrdup(ovs_retval_to_string(status.last_error));
854 if (status.locks_held && status.locks_held[0]) {
855 keys[n] = xstrdup("locks_held");
856 values[n++] = xstrdup(status.locks_held);
858 if (status.locks_waiting && status.locks_waiting[0]) {
859 keys[n] = xstrdup("locks_waiting");
860 values[n++] = xstrdup(status.locks_waiting);
862 if (status.locks_lost && status.locks_lost[0]) {
863 keys[n] = xstrdup("locks_lost");
864 values[n++] = xstrdup(status.locks_lost);
866 if (status.n_connections > 1) {
867 keys[n] = xstrdup("n_connections");
868 values[n++] = xasprintf("%d", status.n_connections);
870 if (status.bound_port != htons(0)) {
871 keys[n] = xstrdup("bound_port");
872 values[n++] = xasprintf("%"PRIu16, ntohs(status.bound_port));
874 write_string_string_column(rw_row, "status", keys, values, n);
876 ovsdb_jsonrpc_server_free_remote_status(&status);
880 update_remote_rows(const struct shash *all_dbs,
881 const char *remote_name,
882 const struct ovsdb_jsonrpc_server *jsonrpc)
884 const struct ovsdb_table *table, *ref_table;
885 const struct ovsdb_column *column;
886 const struct ovsdb_row *row;
890 if (strncmp("db:", remote_name, 3)) {
894 retval = parse_db_column(all_dbs, remote_name, &db, &table, &column);
900 if (column->type.key.type != OVSDB_TYPE_UUID
901 || !column->type.key.u.uuid.refTable
902 || column->type.value.type != OVSDB_TYPE_VOID) {
906 ref_table = column->type.key.u.uuid.refTable;
908 HMAP_FOR_EACH (row, hmap_node, &table->rows) {
909 const struct ovsdb_datum *datum;
912 datum = &row->fields[column->index];
913 for (i = 0; i < datum->n; i++) {
914 const struct ovsdb_row *ref_row;
916 ref_row = ovsdb_table_get_row(ref_table, &datum->keys[i].uuid);
918 update_remote_row(ref_row, db->txn, jsonrpc);
925 update_remote_status(const struct ovsdb_jsonrpc_server *jsonrpc,
926 const struct sset *remotes,
927 struct shash *all_dbs)
929 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
932 struct shash_node *node;
934 SHASH_FOR_EACH(node, all_dbs) {
936 db->txn = ovsdb_txn_create(db->db);
939 /* Iterate over --remote arguments given on command line. */
940 SSET_FOR_EACH (remote, remotes) {
941 update_remote_rows(all_dbs, remote, jsonrpc);
944 SHASH_FOR_EACH(node, all_dbs) {
945 struct ovsdb_error *error;
947 error = ovsdb_txn_commit(db->txn, false);
949 VLOG_ERR_RL(&rl, "Failed to update remote status: %s",
950 ovsdb_error_to_string(error));
951 ovsdb_error_destroy(error);
956 /* Reconfigures ovsdb-server's remotes based on information in the database. */
958 reconfigure_remotes(struct ovsdb_jsonrpc_server *jsonrpc,
959 const struct shash *all_dbs, struct sset *remotes)
961 struct ds errors = DS_EMPTY_INITIALIZER;
962 struct shash resolved_remotes;
965 /* Configure remotes. */
966 shash_init(&resolved_remotes);
967 SSET_FOR_EACH (name, remotes) {
968 if (!strncmp(name, "db:", 3)) {
969 query_db_remotes(name, all_dbs, &resolved_remotes, &errors);
971 add_remote(&resolved_remotes, name);
974 ovsdb_jsonrpc_server_set_remotes(jsonrpc, &resolved_remotes);
975 shash_destroy_free_data(&resolved_remotes);
977 return errors.string;
981 reconfigure_ssl(const struct shash *all_dbs)
983 struct ds errors = DS_EMPTY_INITIALIZER;
984 const char *resolved_private_key;
985 const char *resolved_certificate;
986 const char *resolved_ca_cert;
988 resolved_private_key = query_db_string(all_dbs, private_key_file, &errors);
989 resolved_certificate = query_db_string(all_dbs, certificate_file, &errors);
990 resolved_ca_cert = query_db_string(all_dbs, ca_cert_file, &errors);
992 stream_ssl_set_key_and_cert(resolved_private_key, resolved_certificate);
993 stream_ssl_set_ca_cert_file(resolved_ca_cert, bootstrap_ca_cert);
995 return errors.string;
999 report_error_if_changed(char *error, char **last_errorp)
1002 if (!*last_errorp || strcmp(error, *last_errorp)) {
1003 VLOG_WARN("%s", error);
1005 *last_errorp = error;
1011 *last_errorp = NULL;
1016 ovsdb_server_exit(struct unixctl_conn *conn, int argc OVS_UNUSED,
1017 const char *argv[] OVS_UNUSED,
1020 bool *exiting = exiting_;
1022 unixctl_command_reply(conn, NULL);
1026 ovsdb_server_compact(struct unixctl_conn *conn, int argc,
1027 const char *argv[], void *dbs_)
1029 struct shash *all_dbs = dbs_;
1032 struct shash_node *node;
1036 SHASH_FOR_EACH(node, all_dbs) {
1040 name = db->db->schema->name;
1042 if (argc < 2 || !strcmp(argv[1], name)) {
1043 struct ovsdb_error *error;
1045 VLOG_INFO("compacting %s database by user request", name);
1047 error = ovsdb_file_compact(db->file);
1049 char *s = ovsdb_error_to_string(error);
1050 ds_put_format(&reply, "%s\n", s);
1052 ovsdb_error_destroy(error);
1060 unixctl_command_reply_error(conn, "no database by that name");
1061 } else if (reply.length) {
1062 unixctl_command_reply_error(conn, ds_cstr(&reply));
1064 unixctl_command_reply(conn, NULL);
1069 /* "ovsdb-server/reconnect": makes ovsdb-server drop all of its JSON-RPC
1070 * connections and reconnect. */
1072 ovsdb_server_reconnect(struct unixctl_conn *conn, int argc OVS_UNUSED,
1073 const char *argv[] OVS_UNUSED, void *jsonrpc_)
1075 struct ovsdb_jsonrpc_server *jsonrpc = jsonrpc_;
1077 ovsdb_jsonrpc_server_reconnect(jsonrpc);
1078 unixctl_command_reply(conn, NULL);
1081 /* "ovsdb-server/add-remote REMOTE": adds REMOTE to the set of remotes that
1082 * ovsdb-server services. */
1084 ovsdb_server_add_remote(struct unixctl_conn *conn, int argc OVS_UNUSED,
1085 const char *argv[], void *config_)
1087 struct server_config *config = config_;
1088 const char *remote = argv[1];
1090 const struct ovsdb_column *column;
1091 const struct ovsdb_table *table;
1092 const struct db *db;
1095 retval = (strncmp("db:", remote, 3)
1097 : parse_db_column(config->all_dbs, remote,
1098 &db, &table, &column));
1100 if (sset_add(config->remotes, remote)) {
1101 save_config(config);
1103 unixctl_command_reply(conn, NULL);
1105 unixctl_command_reply_error(conn, retval);
1110 /* "ovsdb-server/remove-remote REMOTE": removes REMOTE frmo the set of remotes
1111 * that ovsdb-server services. */
1113 ovsdb_server_remove_remote(struct unixctl_conn *conn, int argc OVS_UNUSED,
1114 const char *argv[], void *config_)
1116 struct server_config *config = config_;
1117 struct sset_node *node;
1119 node = sset_find(config->remotes, argv[1]);
1121 sset_delete(config->remotes, node);
1122 save_config(config);
1123 unixctl_command_reply(conn, NULL);
1125 unixctl_command_reply_error(conn, "no such remote");
1129 /* "ovsdb-server/list-remotes": outputs a list of configured rmeotes. */
1131 ovsdb_server_list_remotes(struct unixctl_conn *conn, int argc OVS_UNUSED,
1132 const char *argv[] OVS_UNUSED, void *remotes_)
1134 struct sset *remotes = remotes_;
1135 const char **list, **p;
1140 list = sset_sort(remotes);
1141 for (p = list; *p; p++) {
1142 ds_put_format(&s, "%s\n", *p);
1146 unixctl_command_reply(conn, ds_cstr(&s));
1151 /* "ovsdb-server/add-db DB": adds the DB to ovsdb-server. */
1153 ovsdb_server_add_database(struct unixctl_conn *conn, int argc OVS_UNUSED,
1154 const char *argv[], void *config_)
1156 struct server_config *config = config_;
1157 const char *filename = argv[1];
1160 error = open_db(config, filename);
1162 save_config(config);
1163 unixctl_command_reply(conn, NULL);
1165 unixctl_command_reply_error(conn, error);
1171 ovsdb_server_remove_database(struct unixctl_conn *conn, int argc OVS_UNUSED,
1172 const char *argv[], void *config_)
1174 struct server_config *config = config_;
1175 struct shash_node *node;
1179 node = shash_find(config->all_dbs, argv[1]);
1181 unixctl_command_reply_error(conn, "Failed to find the database.");
1186 ok = ovsdb_jsonrpc_server_remove_db(config->jsonrpc, db->db);
1190 shash_delete(config->all_dbs, node);
1192 save_config(config);
1193 unixctl_command_reply(conn, NULL);
1197 ovsdb_server_list_databases(struct unixctl_conn *conn, int argc OVS_UNUSED,
1198 const char *argv[] OVS_UNUSED, void *all_dbs_)
1200 struct shash *all_dbs = all_dbs_;
1201 const struct shash_node **nodes;
1207 nodes = shash_sort(all_dbs);
1208 for (i = 0; i < shash_count(all_dbs); i++) {
1209 struct db *db = nodes[i]->data;
1210 ds_put_format(&s, "%s\n", db->db->schema->name);
1214 unixctl_command_reply(conn, ds_cstr(&s));
1219 parse_options(int *argcp, char **argvp[],
1220 struct sset *remotes, char **unixctl_pathp, char **run_command)
1223 OPT_REMOTE = UCHAR_MAX + 1,
1226 OPT_BOOTSTRAP_CA_CERT,
1231 static const struct option long_options[] = {
1232 {"remote", required_argument, NULL, OPT_REMOTE},
1233 {"unixctl", required_argument, NULL, OPT_UNIXCTL},
1235 {"run", required_argument, NULL, OPT_RUN},
1237 {"help", no_argument, NULL, 'h'},
1238 {"version", no_argument, NULL, 'V'},
1239 DAEMON_LONG_OPTIONS,
1241 {"bootstrap-ca-cert", required_argument, NULL, OPT_BOOTSTRAP_CA_CERT},
1242 {"private-key", required_argument, NULL, 'p'},
1243 {"certificate", required_argument, NULL, 'c'},
1244 {"ca-cert", required_argument, NULL, 'C'},
1245 {"enable-dummy", optional_argument, NULL, OPT_ENABLE_DUMMY},
1248 char *short_options = long_options_to_short_options(long_options);
1250 char **argv = *argvp;
1256 c = getopt_long(argc, argv, short_options, long_options, NULL);
1263 sset_add(remotes, optarg);
1267 *unixctl_pathp = optarg;
1271 *run_command = optarg;
1278 ovs_print_version(0, 0);
1281 VLOG_OPTION_HANDLERS
1282 DAEMON_OPTION_HANDLERS
1285 private_key_file = optarg;
1289 certificate_file = optarg;
1293 ca_cert_file = optarg;
1294 bootstrap_ca_cert = false;
1297 case OPT_BOOTSTRAP_CA_CERT:
1298 ca_cert_file = optarg;
1299 bootstrap_ca_cert = true;
1302 case OPT_ENABLE_DUMMY:
1303 dummy_enable(optarg && !strcmp(optarg, "override"));
1313 free(short_options);
1322 printf("%s: Open vSwitch database server\n"
1323 "usage: %s [OPTIONS] [DATABASE...]\n"
1324 "where each DATABASE is a database file in ovsdb format.\n"
1325 "The default DATABASE, if none is given, is\n%s/conf.db.\n",
1326 program_name, program_name, ovs_dbdir());
1327 printf("\nJSON-RPC options (may be specified any number of times):\n"
1328 " --remote=REMOTE connect or listen to REMOTE\n");
1329 stream_usage("JSON-RPC", true, true, true);
1332 printf("\nOther options:\n"
1333 " --run COMMAND run COMMAND as subprocess then exit\n"
1334 " --unixctl=SOCKET override default control socket name\n"
1335 " -h, --help display this help message\n"
1336 " -V, --version display version information\n");
1340 static struct json *
1341 sset_to_json(const struct sset *sset)
1346 array = json_array_create_empty();
1347 SSET_FOR_EACH (s, sset) {
1348 json_array_add(array, json_string_create(s));
1353 /* Truncates and replaces the contents of 'config_file' by a representation of
1354 * 'remotes' and 'db_filenames'. */
1356 save_config__(FILE *config_file, const struct sset *remotes,
1357 const struct sset *db_filenames)
1362 if (ftruncate(fileno(config_file), 0) == -1) {
1363 VLOG_FATAL("failed to truncate temporary file (%s)",
1364 ovs_strerror(errno));
1367 obj = json_object_create();
1368 json_object_put(obj, "remotes", sset_to_json(remotes));
1369 json_object_put(obj, "db_filenames", sset_to_json(db_filenames));
1370 s = json_to_string(obj, 0);
1373 if (fseek(config_file, 0, SEEK_SET) != 0
1374 || fputs(s, config_file) == EOF
1375 || fflush(config_file) == EOF) {
1376 VLOG_FATAL("failed to write temporary file (%s)", ovs_strerror(errno));
1381 /* Truncates and replaces the contents of 'config_file' by a representation of
1384 save_config(struct server_config *config)
1386 struct sset db_filenames;
1387 struct shash_node *node;
1389 sset_init(&db_filenames);
1390 SHASH_FOR_EACH (node, config->all_dbs) {
1391 struct db *db = node->data;
1392 sset_add(&db_filenames, db->filename);
1395 save_config__(config->config_tmpfile, config->remotes, &db_filenames);
1397 sset_destroy(&db_filenames);
1401 sset_from_json(struct sset *sset, const struct json *array)
1407 ovs_assert(array->type == JSON_ARRAY);
1408 for (i = 0; i < array->u.array.n; i++) {
1409 const struct json *elem = array->u.array.elems[i];
1410 sset_add(sset, json_string(elem));
1414 /* Clears and replaces 'remotes' and 'dbnames' by a configuration read from
1415 * 'config_file', which must have been previously written by save_config(). */
1417 load_config(FILE *config_file, struct sset *remotes, struct sset *db_filenames)
1421 if (fseek(config_file, 0, SEEK_SET) != 0) {
1422 VLOG_FATAL("seek failed in temporary file (%s)", ovs_strerror(errno));
1424 json = json_from_stream(config_file);
1425 if (json->type == JSON_STRING) {
1426 VLOG_FATAL("reading json failed (%s)", json_string(json));
1428 ovs_assert(json->type == JSON_OBJECT);
1430 sset_from_json(remotes, shash_find_data(json_object(json), "remotes"));
1431 sset_from_json(db_filenames,
1432 shash_find_data(json_object(json), "db_filenames"));