1 /* Copyright (c) 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
25 #include "command-line.h"
29 #include "dynamic-string.h"
34 #include "jsonrpc-server.h"
38 #include "ovsdb-data.h"
39 #include "ovsdb-types.h"
40 #include "ovsdb-error.h"
41 #include "poll-loop.h"
46 #include "stream-ssl.h"
51 #include "transaction.h"
57 VLOG_DEFINE_THIS_MODULE(ovsdb_server);
60 /* Initialized in main(). */
62 struct ovsdb_file *file;
65 /* Only used by update_remote_status(). */
66 struct ovsdb_txn *txn;
69 /* SSL configuration. */
70 static char *private_key_file;
71 static char *certificate_file;
72 static char *ca_cert_file;
73 static bool bootstrap_ca_cert;
75 static unixctl_cb_func ovsdb_server_exit;
76 static unixctl_cb_func ovsdb_server_compact;
77 static unixctl_cb_func ovsdb_server_reconnect;
79 struct server_config {
81 struct shash *all_dbs;
83 struct ovsdb_jsonrpc_server *jsonrpc;
85 static unixctl_cb_func ovsdb_server_add_remote;
86 static unixctl_cb_func ovsdb_server_remove_remote;
87 static unixctl_cb_func ovsdb_server_list_remotes;
89 static unixctl_cb_func ovsdb_server_add_database;
90 static unixctl_cb_func ovsdb_server_remove_database;
91 static unixctl_cb_func ovsdb_server_list_databases;
93 static char *open_db(struct server_config *config, const char *filename);
95 static void parse_options(int *argc, char **argvp[],
96 struct sset *remotes, char **unixctl_pathp,
98 static void usage(void) NO_RETURN;
100 static char *reconfigure_remotes(struct ovsdb_jsonrpc_server *,
101 const struct shash *all_dbs,
102 struct sset *remotes);
103 static char *reconfigure_ssl(const struct shash *all_dbs);
104 static void report_error_if_changed(char *error, char **last_errorp);
106 static void update_remote_status(const struct ovsdb_jsonrpc_server *jsonrpc,
107 const struct sset *remotes,
108 struct shash *all_dbs);
110 static void save_config__(FILE *config_file, const struct sset *remotes,
111 const struct sset *db_filenames);
112 static void save_config(struct server_config *);
113 static void load_config(FILE *config_file, struct sset *remotes,
114 struct sset *db_filenames);
117 main(int argc, char *argv[])
119 char *unixctl_path = NULL;
120 char *run_command = NULL;
121 struct unixctl_server *unixctl;
122 struct ovsdb_jsonrpc_server *jsonrpc;
123 struct sset remotes, db_filenames;
124 const char *db_filename;
125 struct process *run_process;
128 long long int status_timer = LLONG_MIN;
129 FILE *config_tmpfile;
130 struct server_config server_config;
131 struct shash all_dbs;
132 struct shash_node *node;
133 char *remotes_error, *ssl_error;
137 proctitle_init(argc, argv);
138 set_program_name(argv[0]);
139 service_start(&argc, &argv);
140 signal(SIGPIPE, SIG_IGN);
143 parse_options(&argc, &argv, &remotes, &unixctl_path, &run_command);
145 /* Create and initialize 'config_tmpfile' as a temporary file to hold
146 * ovsdb-server's most basic configuration, and then save our initial
147 * configuration to it. When --monitor is used, this preserves the effects
148 * of ovs-appctl commands such as ovsdb-server/add-remote (which saves the
149 * new configuration) across crashes. */
150 config_tmpfile = tmpfile();
151 if (!config_tmpfile) {
152 ovs_fatal(errno, "failed to create temporary file");
155 sset_init(&db_filenames);
157 for (i = 0; i < argc; i++) {
158 sset_add(&db_filenames, argv[i]);
161 char *default_db = xasprintf("%s/conf.db", ovs_dbdir());
162 sset_add(&db_filenames, default_db);
166 server_config.remotes = &remotes;
167 server_config.config_tmpfile = config_tmpfile;
169 save_config__(config_tmpfile, &remotes, &db_filenames);
173 /* Load the saved config. */
174 load_config(config_tmpfile, &remotes, &db_filenames);
175 jsonrpc = ovsdb_jsonrpc_server_create();
177 shash_init(&all_dbs);
178 server_config.all_dbs = &all_dbs;
179 server_config.jsonrpc = jsonrpc;
180 SSET_FOR_EACH (db_filename, &db_filenames) {
181 error = open_db(&server_config, db_filename);
183 ovs_fatal(0, "%s", error);
187 error = reconfigure_remotes(jsonrpc, &all_dbs, &remotes);
189 error = reconfigure_ssl(&all_dbs);
192 ovs_fatal(0, "%s", error);
195 retval = unixctl_server_create(unixctl_path, &unixctl);
203 run_argv[0] = "/bin/sh";
205 run_argv[2] = run_command;
208 retval = process_start(run_argv, &run_process);
210 ovs_fatal(retval, "%s: process failed to start", run_command);
216 daemonize_complete();
219 /* ovsdb-server is usually a long-running process, in which case it
220 * makes plenty of sense to log the version, but --run makes
221 * ovsdb-server more like a command-line tool, so skip it. */
222 VLOG_INFO("%s (Open vSwitch) %s", program_name, VERSION);
225 unixctl_command_register("exit", "", 0, 0, ovsdb_server_exit, &exiting);
226 unixctl_command_register("ovsdb-server/compact", "", 0, 1,
227 ovsdb_server_compact, &all_dbs);
228 unixctl_command_register("ovsdb-server/reconnect", "", 0, 0,
229 ovsdb_server_reconnect, jsonrpc);
231 unixctl_command_register("ovsdb-server/add-remote", "REMOTE", 1, 1,
232 ovsdb_server_add_remote, &server_config);
233 unixctl_command_register("ovsdb-server/remove-remote", "REMOTE", 1, 1,
234 ovsdb_server_remove_remote, &server_config);
235 unixctl_command_register("ovsdb-server/list-remotes", "", 0, 0,
236 ovsdb_server_list_remotes, &remotes);
238 unixctl_command_register("ovsdb-server/add-db", "DB", 1, 1,
239 ovsdb_server_add_database, &server_config);
240 unixctl_command_register("ovsdb-server/remove-db", "DB", 1, 1,
241 ovsdb_server_remove_database, &server_config);
242 unixctl_command_register("ovsdb-server/list-dbs", "", 0, 0,
243 ovsdb_server_list_databases, &all_dbs);
247 remotes_error = NULL;
250 if (memory_should_report()) {
254 ovsdb_jsonrpc_server_get_memory_usage(jsonrpc, &usage);
255 SHASH_FOR_EACH(node, &all_dbs) {
256 struct db *db = node->data;
257 ovsdb_get_memory_usage(db->db, &usage);
259 memory_report(&usage);
260 simap_destroy(&usage);
263 /* Run unixctl_server_run() before reconfigure_remotes() because
264 * ovsdb-server/add-remote and ovsdb-server/remove-remote can change
265 * the set of remotes that reconfigure_remotes() uses. */
266 unixctl_server_run(unixctl);
268 report_error_if_changed(
269 reconfigure_remotes(jsonrpc, &all_dbs, &remotes),
271 report_error_if_changed(reconfigure_ssl(&all_dbs), &ssl_error);
272 ovsdb_jsonrpc_server_run(jsonrpc);
274 SHASH_FOR_EACH(node, &all_dbs) {
275 struct db *db = node->data;
276 ovsdb_trigger_run(db->db, time_msec());
280 if (process_exited(run_process)) {
285 /* update Manager status(es) every 5 seconds */
286 if (time_msec() >= status_timer) {
287 status_timer = time_msec() + 5000;
288 update_remote_status(jsonrpc, &remotes, &all_dbs);
292 ovsdb_jsonrpc_server_wait(jsonrpc);
293 unixctl_server_wait(unixctl);
294 SHASH_FOR_EACH(node, &all_dbs) {
295 struct db *db = node->data;
296 ovsdb_trigger_wait(db->db, time_msec());
299 process_wait(run_process);
302 poll_immediate_wake();
304 poll_timer_wait_until(status_timer);
306 if (should_service_stop()) {
310 ovsdb_jsonrpc_server_destroy(jsonrpc);
311 SHASH_FOR_EACH(node, &all_dbs) {
312 struct db *db = node->data;
313 ovsdb_destroy(db->db);
315 sset_destroy(&remotes);
316 unixctl_server_destroy(unixctl);
318 if (run_process && process_exited(run_process)) {
319 int status = process_status(run_process);
321 ovs_fatal(0, "%s: child exited, %s",
322 run_command, process_status_msg(status));
331 open_db(struct server_config *config, const char *filename)
333 struct ovsdb_error *db_error;
337 db = xzalloc(sizeof *db);
338 db->filename = xstrdup(filename);
340 db_error = ovsdb_file_open(db->filename, false, &db->db, &db->file);
342 error = ovsdb_error_to_string(db_error);
343 } else if (!ovsdb_jsonrpc_server_add_db(config->jsonrpc, db->db)) {
344 error = xasprintf("%s: duplicate database name", db->db->schema->name);
346 shash_add_assert(config->all_dbs, db->db->schema->name, db);
350 ovsdb_error_destroy(db_error);
351 ovsdb_destroy(db->db);
357 static const struct db *
358 find_db(const struct shash *all_dbs, const char *db_name)
360 struct shash_node *node;
362 SHASH_FOR_EACH(node, all_dbs) {
363 struct db *db = node->data;
364 if (!strcmp(db->db->schema->name, db_name)) {
372 static char * WARN_UNUSED_RESULT
373 parse_db_column__(const struct shash *all_dbs,
374 const char *name_, char *name,
375 const struct db **dbp,
376 const struct ovsdb_table **tablep,
377 const struct ovsdb_column **columnp)
379 const char *db_name, *table_name, *column_name;
380 const struct ovsdb_column *column;
381 const struct ovsdb_table *table;
382 const char *tokens[3];
383 char *save_ptr = NULL;
390 strtok_r(name, ":", &save_ptr); /* "db:" */
391 tokens[0] = strtok_r(NULL, ",", &save_ptr);
392 tokens[1] = strtok_r(NULL, ",", &save_ptr);
393 tokens[2] = strtok_r(NULL, ",", &save_ptr);
394 if (!tokens[0] || !tokens[1] || !tokens[2]) {
395 return xasprintf("\"%s\": invalid syntax", name_);
399 table_name = tokens[1];
400 column_name = tokens[2];
402 db = find_db(all_dbs, tokens[0]);
404 return xasprintf("\"%s\": no database named %s", name_, db_name);
407 table = ovsdb_get_table(db->db, table_name);
409 return xasprintf("\"%s\": no table named %s", name_, table_name);
412 column = ovsdb_table_schema_get_column(table->schema, column_name);
414 return xasprintf("\"%s\": table \"%s\" has no column \"%s\"",
415 name_, table_name, column_name);
424 /* Returns NULL if successful, otherwise a malloc()'d string describing the
426 static char * WARN_UNUSED_RESULT
427 parse_db_column(const struct shash *all_dbs,
429 const struct db **dbp,
430 const struct ovsdb_table **tablep,
431 const struct ovsdb_column **columnp)
433 char *name = xstrdup(name_);
434 char *retval = parse_db_column__(all_dbs, name_, name,
435 dbp, tablep, columnp);
440 /* Returns NULL if successful, otherwise a malloc()'d string describing the
442 static char * WARN_UNUSED_RESULT
443 parse_db_string_column(const struct shash *all_dbs,
445 const struct db **dbp,
446 const struct ovsdb_table **tablep,
447 const struct ovsdb_column **columnp)
451 retval = parse_db_column(all_dbs, name, dbp, tablep, columnp);
456 if ((*columnp)->type.key.type != OVSDB_TYPE_STRING
457 || (*columnp)->type.value.type != OVSDB_TYPE_VOID) {
458 return xasprintf("\"%s\": table \"%s\" column \"%s\" is "
459 "not string or set of strings",
460 name, (*tablep)->schema->name, (*columnp)->name);
467 query_db_string(const struct shash *all_dbs, const char *name,
470 if (!name || strncmp(name, "db:", 3)) {
473 const struct ovsdb_column *column;
474 const struct ovsdb_table *table;
475 const struct ovsdb_row *row;
479 retval = parse_db_string_column(all_dbs, name,
480 &db, &table, &column);
482 ds_put_format(errors, "%s\n", retval);
486 HMAP_FOR_EACH (row, hmap_node, &table->rows) {
487 const struct ovsdb_datum *datum;
490 datum = &row->fields[column->index];
491 for (i = 0; i < datum->n; i++) {
492 if (datum->keys[i].string[0]) {
493 return datum->keys[i].string;
501 static struct ovsdb_jsonrpc_options *
502 add_remote(struct shash *remotes, const char *target)
504 struct ovsdb_jsonrpc_options *options;
506 options = shash_find_data(remotes, target);
508 options = ovsdb_jsonrpc_default_options(target);
509 shash_add(remotes, target, options);
515 static struct ovsdb_datum *
516 get_datum(struct ovsdb_row *row, const char *column_name,
517 const enum ovsdb_atomic_type key_type,
518 const enum ovsdb_atomic_type value_type,
521 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
522 const struct ovsdb_table_schema *schema = row->table->schema;
523 const struct ovsdb_column *column;
525 column = ovsdb_table_schema_get_column(schema, column_name);
527 VLOG_DBG_RL(&rl, "Table `%s' has no `%s' column",
528 schema->name, column_name);
532 if (column->type.key.type != key_type
533 || column->type.value.type != value_type
534 || column->type.n_max != n_max) {
535 if (!VLOG_DROP_DBG(&rl)) {
536 char *type_name = ovsdb_type_to_english(&column->type);
537 VLOG_DBG("Table `%s' column `%s' has type %s, not expected "
538 "key type %s, value type %s, max elements %"PRIuSIZE".",
539 schema->name, column_name, type_name,
540 ovsdb_atomic_type_to_string(key_type),
541 ovsdb_atomic_type_to_string(value_type),
548 return &row->fields[column->index];
551 /* Read string-string key-values from a map. Returns the value associated with
552 * 'key', if found, or NULL */
554 read_map_string_column(const struct ovsdb_row *row, const char *column_name,
557 const struct ovsdb_datum *datum;
558 union ovsdb_atom *atom_key = NULL, *atom_value = NULL;
561 datum = get_datum(CONST_CAST(struct ovsdb_row *, row), column_name,
562 OVSDB_TYPE_STRING, OVSDB_TYPE_STRING, UINT_MAX);
568 for (i = 0; i < datum->n; i++) {
569 atom_key = &datum->keys[i];
570 if (!strcmp(atom_key->string, key)){
571 atom_value = &datum->values[i];
576 return atom_value ? atom_value->string : NULL;
579 static const union ovsdb_atom *
580 read_column(const struct ovsdb_row *row, const char *column_name,
581 enum ovsdb_atomic_type type)
583 const struct ovsdb_datum *datum;
585 datum = get_datum(CONST_CAST(struct ovsdb_row *, row), column_name, type,
587 return datum && datum->n ? datum->keys : NULL;
591 read_integer_column(const struct ovsdb_row *row, const char *column_name,
592 long long int *integerp)
594 const union ovsdb_atom *atom;
596 atom = read_column(row, column_name, OVSDB_TYPE_INTEGER);
597 *integerp = atom ? atom->integer : 0;
602 read_string_column(const struct ovsdb_row *row, const char *column_name,
603 const char **stringp)
605 const union ovsdb_atom *atom;
607 atom = read_column(row, column_name, OVSDB_TYPE_STRING);
608 *stringp = atom ? atom->string : NULL;
613 write_bool_column(struct ovsdb_row *row, const char *column_name, bool value)
615 const struct ovsdb_column *column;
616 struct ovsdb_datum *datum;
618 column = ovsdb_table_schema_get_column(row->table->schema, column_name);
619 datum = get_datum(row, column_name, OVSDB_TYPE_BOOLEAN,
626 ovsdb_datum_destroy(datum, &column->type);
629 datum->keys = xmalloc(sizeof *datum->keys);
630 datum->values = NULL;
633 datum->keys[0].boolean = value;
637 write_string_string_column(struct ovsdb_row *row, const char *column_name,
638 char **keys, char **values, size_t n)
640 const struct ovsdb_column *column;
641 struct ovsdb_datum *datum;
644 column = ovsdb_table_schema_get_column(row->table->schema, column_name);
645 datum = get_datum(row, column_name, OVSDB_TYPE_STRING, OVSDB_TYPE_STRING,
648 for (i = 0; i < n; i++) {
655 /* Free existing data. */
656 ovsdb_datum_destroy(datum, &column->type);
658 /* Allocate space for new values. */
660 datum->keys = xmalloc(n * sizeof *datum->keys);
661 datum->values = xmalloc(n * sizeof *datum->values);
663 for (i = 0; i < n; ++i) {
664 datum->keys[i].string = keys[i];
665 datum->values[i].string = values[i];
668 /* Sort and check constraints. */
669 ovsdb_datum_sort_assert(datum, column->type.key.type);
672 /* Adds a remote and options to 'remotes', based on the Manager table row in
675 add_manager_options(struct shash *remotes, const struct ovsdb_row *row)
677 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
678 struct ovsdb_jsonrpc_options *options;
679 long long int max_backoff, probe_interval;
680 const char *target, *dscp_string;
682 if (!read_string_column(row, "target", &target) || !target) {
683 VLOG_INFO_RL(&rl, "Table `%s' has missing or invalid `target' column",
684 row->table->schema->name);
688 options = add_remote(remotes, target);
689 if (read_integer_column(row, "max_backoff", &max_backoff)) {
690 options->max_backoff = max_backoff;
692 if (read_integer_column(row, "inactivity_probe", &probe_interval)) {
693 options->probe_interval = probe_interval;
696 options->dscp = DSCP_DEFAULT;
697 dscp_string = read_map_string_column(row, "other_config", "dscp");
699 int dscp = atoi(dscp_string);
700 if (dscp >= 0 && dscp <= 63) {
701 options->dscp = dscp;
707 query_db_remotes(const char *name, const struct shash *all_dbs,
708 struct shash *remotes, struct ds *errors)
710 const struct ovsdb_column *column;
711 const struct ovsdb_table *table;
712 const struct ovsdb_row *row;
716 retval = parse_db_column(all_dbs, name, &db, &table, &column);
718 ds_put_format(errors, "%s\n", retval);
723 if (column->type.key.type == OVSDB_TYPE_STRING
724 && column->type.value.type == OVSDB_TYPE_VOID) {
725 HMAP_FOR_EACH (row, hmap_node, &table->rows) {
726 const struct ovsdb_datum *datum;
729 datum = &row->fields[column->index];
730 for (i = 0; i < datum->n; i++) {
731 add_remote(remotes, datum->keys[i].string);
734 } else if (column->type.key.type == OVSDB_TYPE_UUID
735 && column->type.key.u.uuid.refTable
736 && column->type.value.type == OVSDB_TYPE_VOID) {
737 const struct ovsdb_table *ref_table = column->type.key.u.uuid.refTable;
738 HMAP_FOR_EACH (row, hmap_node, &table->rows) {
739 const struct ovsdb_datum *datum;
742 datum = &row->fields[column->index];
743 for (i = 0; i < datum->n; i++) {
744 const struct ovsdb_row *ref_row;
746 ref_row = ovsdb_table_get_row(ref_table, &datum->keys[i].uuid);
748 add_manager_options(remotes, ref_row);
756 update_remote_row(const struct ovsdb_row *row, struct ovsdb_txn *txn,
757 const struct ovsdb_jsonrpc_server *jsonrpc)
759 struct ovsdb_jsonrpc_remote_status status;
760 struct ovsdb_row *rw_row;
762 char *keys[9], *values[9];
765 /* Get the "target" (protocol/host/port) spec. */
766 if (!read_string_column(row, "target", &target)) {
767 /* Bad remote spec or incorrect schema. */
770 rw_row = ovsdb_txn_row_modify(txn, row);
771 ovsdb_jsonrpc_server_get_remote_status(jsonrpc, target, &status);
773 /* Update status information columns. */
774 write_bool_column(rw_row, "is_connected", status.is_connected);
777 keys[n] = xstrdup("state");
778 values[n++] = xstrdup(status.state);
780 if (status.sec_since_connect != UINT_MAX) {
781 keys[n] = xstrdup("sec_since_connect");
782 values[n++] = xasprintf("%u", status.sec_since_connect);
784 if (status.sec_since_disconnect != UINT_MAX) {
785 keys[n] = xstrdup("sec_since_disconnect");
786 values[n++] = xasprintf("%u", status.sec_since_disconnect);
788 if (status.last_error) {
789 keys[n] = xstrdup("last_error");
791 xstrdup(ovs_retval_to_string(status.last_error));
793 if (status.locks_held && status.locks_held[0]) {
794 keys[n] = xstrdup("locks_held");
795 values[n++] = xstrdup(status.locks_held);
797 if (status.locks_waiting && status.locks_waiting[0]) {
798 keys[n] = xstrdup("locks_waiting");
799 values[n++] = xstrdup(status.locks_waiting);
801 if (status.locks_lost && status.locks_lost[0]) {
802 keys[n] = xstrdup("locks_lost");
803 values[n++] = xstrdup(status.locks_lost);
805 if (status.n_connections > 1) {
806 keys[n] = xstrdup("n_connections");
807 values[n++] = xasprintf("%d", status.n_connections);
809 if (status.bound_port != htons(0)) {
810 keys[n] = xstrdup("bound_port");
811 values[n++] = xasprintf("%"PRIu16, ntohs(status.bound_port));
813 write_string_string_column(rw_row, "status", keys, values, n);
815 ovsdb_jsonrpc_server_free_remote_status(&status);
819 update_remote_rows(const struct shash *all_dbs,
820 const char *remote_name,
821 const struct ovsdb_jsonrpc_server *jsonrpc)
823 const struct ovsdb_table *table, *ref_table;
824 const struct ovsdb_column *column;
825 const struct ovsdb_row *row;
829 if (strncmp("db:", remote_name, 3)) {
833 retval = parse_db_column(all_dbs, remote_name, &db, &table, &column);
839 if (column->type.key.type != OVSDB_TYPE_UUID
840 || !column->type.key.u.uuid.refTable
841 || column->type.value.type != OVSDB_TYPE_VOID) {
845 ref_table = column->type.key.u.uuid.refTable;
847 HMAP_FOR_EACH (row, hmap_node, &table->rows) {
848 const struct ovsdb_datum *datum;
851 datum = &row->fields[column->index];
852 for (i = 0; i < datum->n; i++) {
853 const struct ovsdb_row *ref_row;
855 ref_row = ovsdb_table_get_row(ref_table, &datum->keys[i].uuid);
857 update_remote_row(ref_row, db->txn, jsonrpc);
864 update_remote_status(const struct ovsdb_jsonrpc_server *jsonrpc,
865 const struct sset *remotes,
866 struct shash *all_dbs)
868 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
871 struct shash_node *node;
873 SHASH_FOR_EACH(node, all_dbs) {
875 db->txn = ovsdb_txn_create(db->db);
878 /* Iterate over --remote arguments given on command line. */
879 SSET_FOR_EACH (remote, remotes) {
880 update_remote_rows(all_dbs, remote, jsonrpc);
883 SHASH_FOR_EACH(node, all_dbs) {
884 struct ovsdb_error *error;
886 error = ovsdb_txn_commit(db->txn, false);
888 VLOG_ERR_RL(&rl, "Failed to update remote status: %s",
889 ovsdb_error_to_string(error));
890 ovsdb_error_destroy(error);
895 /* Reconfigures ovsdb-server's remotes based on information in the database. */
897 reconfigure_remotes(struct ovsdb_jsonrpc_server *jsonrpc,
898 const struct shash *all_dbs, struct sset *remotes)
900 struct ds errors = DS_EMPTY_INITIALIZER;
901 struct shash resolved_remotes;
904 /* Configure remotes. */
905 shash_init(&resolved_remotes);
906 SSET_FOR_EACH (name, remotes) {
907 if (!strncmp(name, "db:", 3)) {
908 query_db_remotes(name, all_dbs, &resolved_remotes, &errors);
910 add_remote(&resolved_remotes, name);
913 ovsdb_jsonrpc_server_set_remotes(jsonrpc, &resolved_remotes);
914 shash_destroy_free_data(&resolved_remotes);
916 return errors.string;
920 reconfigure_ssl(const struct shash *all_dbs)
922 struct ds errors = DS_EMPTY_INITIALIZER;
923 const char *resolved_private_key;
924 const char *resolved_certificate;
925 const char *resolved_ca_cert;
927 resolved_private_key = query_db_string(all_dbs, private_key_file, &errors);
928 resolved_certificate = query_db_string(all_dbs, certificate_file, &errors);
929 resolved_ca_cert = query_db_string(all_dbs, ca_cert_file, &errors);
931 stream_ssl_set_key_and_cert(resolved_private_key, resolved_certificate);
932 stream_ssl_set_ca_cert_file(resolved_ca_cert, bootstrap_ca_cert);
934 return errors.string;
938 report_error_if_changed(char *error, char **last_errorp)
941 if (!*last_errorp || strcmp(error, *last_errorp)) {
942 VLOG_WARN("%s", error);
944 *last_errorp = error;
955 ovsdb_server_exit(struct unixctl_conn *conn, int argc OVS_UNUSED,
956 const char *argv[] OVS_UNUSED,
959 bool *exiting = exiting_;
961 unixctl_command_reply(conn, NULL);
965 ovsdb_server_compact(struct unixctl_conn *conn, int argc,
966 const char *argv[], void *dbs_)
968 struct shash *all_dbs = dbs_;
971 struct shash_node *node;
975 SHASH_FOR_EACH(node, all_dbs) {
979 name = db->db->schema->name;
981 if (argc < 2 || !strcmp(argv[1], name)) {
982 struct ovsdb_error *error;
984 VLOG_INFO("compacting %s database by user request", name);
986 error = ovsdb_file_compact(db->file);
988 char *s = ovsdb_error_to_string(error);
989 ds_put_format(&reply, "%s\n", s);
991 ovsdb_error_destroy(error);
999 unixctl_command_reply_error(conn, "no database by that name");
1000 } else if (reply.length) {
1001 unixctl_command_reply_error(conn, ds_cstr(&reply));
1003 unixctl_command_reply(conn, NULL);
1008 /* "ovsdb-server/reconnect": makes ovsdb-server drop all of its JSON-RPC
1009 * connections and reconnect. */
1011 ovsdb_server_reconnect(struct unixctl_conn *conn, int argc OVS_UNUSED,
1012 const char *argv[] OVS_UNUSED, void *jsonrpc_)
1014 struct ovsdb_jsonrpc_server *jsonrpc = jsonrpc_;
1016 ovsdb_jsonrpc_server_reconnect(jsonrpc);
1017 unixctl_command_reply(conn, NULL);
1020 /* "ovsdb-server/add-remote REMOTE": adds REMOTE to the set of remotes that
1021 * ovsdb-server services. */
1023 ovsdb_server_add_remote(struct unixctl_conn *conn, int argc OVS_UNUSED,
1024 const char *argv[], void *config_)
1026 struct server_config *config = config_;
1027 const char *remote = argv[1];
1029 const struct ovsdb_column *column;
1030 const struct ovsdb_table *table;
1031 const struct db *db;
1034 retval = (strncmp("db:", remote, 3)
1036 : parse_db_column(config->all_dbs, remote,
1037 &db, &table, &column));
1039 if (sset_add(config->remotes, remote)) {
1040 save_config(config);
1042 unixctl_command_reply(conn, NULL);
1044 unixctl_command_reply_error(conn, retval);
1049 /* "ovsdb-server/remove-remote REMOTE": removes REMOTE frmo the set of remotes
1050 * that ovsdb-server services. */
1052 ovsdb_server_remove_remote(struct unixctl_conn *conn, int argc OVS_UNUSED,
1053 const char *argv[], void *config_)
1055 struct server_config *config = config_;
1056 struct sset_node *node;
1058 node = sset_find(config->remotes, argv[1]);
1060 sset_delete(config->remotes, node);
1061 save_config(config);
1062 unixctl_command_reply(conn, NULL);
1064 unixctl_command_reply_error(conn, "no such remote");
1068 /* "ovsdb-server/list-remotes": outputs a list of configured rmeotes. */
1070 ovsdb_server_list_remotes(struct unixctl_conn *conn, int argc OVS_UNUSED,
1071 const char *argv[] OVS_UNUSED, void *remotes_)
1073 struct sset *remotes = remotes_;
1074 const char **list, **p;
1079 list = sset_sort(remotes);
1080 for (p = list; *p; p++) {
1081 ds_put_format(&s, "%s\n", *p);
1085 unixctl_command_reply(conn, ds_cstr(&s));
1090 /* "ovsdb-server/add-db DB": adds the DB to ovsdb-server. */
1092 ovsdb_server_add_database(struct unixctl_conn *conn, int argc OVS_UNUSED,
1093 const char *argv[], void *config_)
1095 struct server_config *config = config_;
1096 const char *filename = argv[1];
1099 error = open_db(config, filename);
1101 save_config(config);
1102 unixctl_command_reply(conn, NULL);
1104 unixctl_command_reply_error(conn, error);
1110 ovsdb_server_remove_database(struct unixctl_conn *conn, int argc OVS_UNUSED,
1111 const char *argv[], void *config_)
1113 struct server_config *config = config_;
1114 struct shash_node *node;
1118 node = shash_find(config->all_dbs, argv[1]);
1120 unixctl_command_reply_error(conn, "Failed to find the database.");
1125 ok = ovsdb_jsonrpc_server_remove_db(config->jsonrpc, db->db);
1128 ovsdb_destroy(db->db);
1129 shash_delete(config->all_dbs, node);
1133 save_config(config);
1134 unixctl_command_reply(conn, NULL);
1138 ovsdb_server_list_databases(struct unixctl_conn *conn, int argc OVS_UNUSED,
1139 const char *argv[] OVS_UNUSED, void *all_dbs_)
1141 struct shash *all_dbs = all_dbs_;
1142 const struct shash_node **nodes;
1148 nodes = shash_sort(all_dbs);
1149 for (i = 0; i < shash_count(all_dbs); i++) {
1150 struct db *db = nodes[i]->data;
1151 ds_put_format(&s, "%s\n", db->db->schema->name);
1155 unixctl_command_reply(conn, ds_cstr(&s));
1160 parse_options(int *argcp, char **argvp[],
1161 struct sset *remotes, char **unixctl_pathp, char **run_command)
1164 OPT_REMOTE = UCHAR_MAX + 1,
1167 OPT_BOOTSTRAP_CA_CERT,
1172 static const struct option long_options[] = {
1173 {"remote", required_argument, NULL, OPT_REMOTE},
1174 {"unixctl", required_argument, NULL, OPT_UNIXCTL},
1175 {"run", required_argument, NULL, OPT_RUN},
1176 {"help", no_argument, NULL, 'h'},
1177 {"version", no_argument, NULL, 'V'},
1178 DAEMON_LONG_OPTIONS,
1180 {"bootstrap-ca-cert", required_argument, NULL, OPT_BOOTSTRAP_CA_CERT},
1181 {"private-key", required_argument, NULL, 'p'},
1182 {"certificate", required_argument, NULL, 'c'},
1183 {"ca-cert", required_argument, NULL, 'C'},
1184 {"enable-dummy", optional_argument, NULL, OPT_ENABLE_DUMMY},
1187 char *short_options = long_options_to_short_options(long_options);
1189 char **argv = *argvp;
1195 c = getopt_long(argc, argv, short_options, long_options, NULL);
1202 sset_add(remotes, optarg);
1206 *unixctl_pathp = optarg;
1210 *run_command = optarg;
1217 ovs_print_version(0, 0);
1220 VLOG_OPTION_HANDLERS
1221 DAEMON_OPTION_HANDLERS
1224 private_key_file = optarg;
1228 certificate_file = optarg;
1232 ca_cert_file = optarg;
1233 bootstrap_ca_cert = false;
1236 case OPT_BOOTSTRAP_CA_CERT:
1237 ca_cert_file = optarg;
1238 bootstrap_ca_cert = true;
1241 case OPT_ENABLE_DUMMY:
1242 dummy_enable(optarg && !strcmp(optarg, "override"));
1252 free(short_options);
1261 printf("%s: Open vSwitch database server\n"
1262 "usage: %s [OPTIONS] [DATABASE...]\n"
1263 "where each DATABASE is a database file in ovsdb format.\n"
1264 "The default DATABASE, if none is given, is\n%s/conf.db.\n",
1265 program_name, program_name, ovs_dbdir());
1266 printf("\nJSON-RPC options (may be specified any number of times):\n"
1267 " --remote=REMOTE connect or listen to REMOTE\n");
1268 stream_usage("JSON-RPC", true, true, true);
1271 printf("\nOther options:\n"
1272 " --run COMMAND run COMMAND as subprocess then exit\n"
1273 " --unixctl=SOCKET override default control socket name\n"
1274 " -h, --help display this help message\n"
1275 " -V, --version display version information\n");
1279 static struct json *
1280 sset_to_json(const struct sset *sset)
1285 array = json_array_create_empty();
1286 SSET_FOR_EACH (s, sset) {
1287 json_array_add(array, json_string_create(s));
1292 /* Truncates and replaces the contents of 'config_file' by a representation of
1293 * 'remotes' and 'db_filenames'. */
1295 save_config__(FILE *config_file, const struct sset *remotes,
1296 const struct sset *db_filenames)
1301 if (ftruncate(fileno(config_file), 0) == -1) {
1302 VLOG_FATAL("failed to truncate temporary file (%s)",
1303 ovs_strerror(errno));
1306 obj = json_object_create();
1307 json_object_put(obj, "remotes", sset_to_json(remotes));
1308 json_object_put(obj, "db_filenames", sset_to_json(db_filenames));
1309 s = json_to_string(obj, 0);
1312 if (fseek(config_file, 0, SEEK_SET) != 0
1313 || fputs(s, config_file) == EOF
1314 || fflush(config_file) == EOF) {
1315 VLOG_FATAL("failed to write temporary file (%s)", ovs_strerror(errno));
1320 /* Truncates and replaces the contents of 'config_file' by a representation of
1323 save_config(struct server_config *config)
1325 struct sset db_filenames;
1326 struct shash_node *node;
1328 sset_init(&db_filenames);
1329 SHASH_FOR_EACH (node, config->all_dbs) {
1330 struct db *db = node->data;
1331 sset_add(&db_filenames, db->filename);
1334 save_config__(config->config_tmpfile, config->remotes, &db_filenames);
1336 sset_destroy(&db_filenames);
1340 sset_from_json(struct sset *sset, const struct json *array)
1346 ovs_assert(array->type == JSON_ARRAY);
1347 for (i = 0; i < array->u.array.n; i++) {
1348 const struct json *elem = array->u.array.elems[i];
1349 sset_add(sset, json_string(elem));
1353 /* Clears and replaces 'remotes' and 'dbnames' by a configuration read from
1354 * 'config_file', which must have been previously written by save_config(). */
1356 load_config(FILE *config_file, struct sset *remotes, struct sset *db_filenames)
1360 if (fseek(config_file, 0, SEEK_SET) != 0) {
1361 VLOG_FATAL("seek failed in temporary file (%s)", ovs_strerror(errno));
1363 json = json_from_stream(config_file);
1364 if (json->type == JSON_STRING) {
1365 VLOG_FATAL("reading json failed (%s)", json_string(json));
1367 ovs_assert(json->type == JSON_OBJECT);
1369 sset_from_json(remotes, shash_find_data(json_object(json), "remotes"));
1370 sset_from_json(db_filenames,
1371 shash_find_data(json_object(json), "db_filenames"));