1 /* Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014, 2016, 2017 Nicira, Inc.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
26 #include "command-line.h"
29 #include "openvswitch/dynamic-string.h"
30 #include "fatal-signal.h"
33 #include "openvswitch/json.h"
35 #include "jsonrpc-server.h"
36 #include "openvswitch/list.h"
40 #include "ovsdb-data.h"
41 #include "ovsdb-types.h"
42 #include "ovsdb-error.h"
43 #include "openvswitch/poll-loop.h"
45 #include "replication.h"
48 #include "openvswitch/shash.h"
49 #include "stream-ssl.h"
55 #include "transaction.h"
59 #include "perf-counter.h"
60 #include "ovsdb-util.h"
61 #include "openvswitch/vlog.h"
63 VLOG_DEFINE_THIS_MODULE(ovsdb_server
);
71 /* SSL configuration. */
72 static char *private_key_file
;
73 static char *certificate_file
;
74 static char *ca_cert_file
;
75 static char *ssl_protocols
;
76 static char *ssl_ciphers
;
77 static bool bootstrap_ca_cert
;
79 static unixctl_cb_func ovsdb_server_exit
;
80 static unixctl_cb_func ovsdb_server_compact
;
81 static unixctl_cb_func ovsdb_server_reconnect
;
82 static unixctl_cb_func ovsdb_server_perf_counters_clear
;
83 static unixctl_cb_func ovsdb_server_perf_counters_show
;
84 static unixctl_cb_func ovsdb_server_disable_monitor_cond
;
85 static unixctl_cb_func ovsdb_server_set_active_ovsdb_server
;
86 static unixctl_cb_func ovsdb_server_get_active_ovsdb_server
;
87 static unixctl_cb_func ovsdb_server_connect_active_ovsdb_server
;
88 static unixctl_cb_func ovsdb_server_disconnect_active_ovsdb_server
;
89 static unixctl_cb_func ovsdb_server_set_sync_exclude_tables
;
90 static unixctl_cb_func ovsdb_server_get_sync_exclude_tables
;
91 static unixctl_cb_func ovsdb_server_get_sync_status
;
93 struct server_config
{
95 struct shash
*all_dbs
;
100 struct ovsdb_jsonrpc_server
*jsonrpc
;
102 static unixctl_cb_func ovsdb_server_add_remote
;
103 static unixctl_cb_func ovsdb_server_remove_remote
;
104 static unixctl_cb_func ovsdb_server_list_remotes
;
106 static unixctl_cb_func ovsdb_server_add_database
;
107 static unixctl_cb_func ovsdb_server_remove_database
;
108 static unixctl_cb_func ovsdb_server_list_databases
;
110 static void read_db(struct server_config
*, struct db
*);
111 static struct ovsdb_error
*open_db(struct server_config
*,
112 const char *filename
)
113 OVS_WARN_UNUSED_RESULT
;
114 static void add_server_db(struct server_config
*);
115 static void remove_db(struct server_config
*, struct shash_node
*db
, char *);
116 static void close_db(struct server_config
*, struct db
*, char *);
118 static void parse_options(int argc
, char *argvp
[],
119 struct sset
*db_filenames
, struct sset
*remotes
,
120 char **unixctl_pathp
, char **run_command
,
121 char **sync_from
, char **sync_exclude
,
123 OVS_NO_RETURN
static void usage(void);
125 static char *reconfigure_remotes(struct ovsdb_jsonrpc_server
*,
126 const struct shash
*all_dbs
,
127 struct sset
*remotes
);
128 static char *reconfigure_ssl(const struct shash
*all_dbs
);
129 static void report_error_if_changed(char *error
, char **last_errorp
);
131 static void update_remote_status(const struct ovsdb_jsonrpc_server
*jsonrpc
,
132 const struct sset
*remotes
,
133 struct shash
*all_dbs
);
134 static void update_server_status(struct shash
*all_dbs
);
136 static void save_config__(FILE *config_file
, const struct sset
*remotes
,
137 const struct sset
*db_filenames
,
138 const char *sync_from
, const char *sync_exclude
,
140 static void save_config(struct server_config
*);
141 static void load_config(FILE *config_file
, struct sset
*remotes
,
142 struct sset
*db_filenames
, char **sync_from
,
143 char **sync_exclude
, bool *is_backup
);
146 ovsdb_replication_init(const char *sync_from
, const char *exclude
,
147 struct shash
*all_dbs
, const struct uuid
*server_uuid
)
149 replication_init(sync_from
, exclude
, server_uuid
);
150 struct shash_node
*node
;
151 SHASH_FOR_EACH (node
, all_dbs
) {
152 struct db
*db
= node
->data
;
153 if (node
->name
[0] != '_' && db
->db
) {
154 replication_add_local_db(node
->name
, db
->db
);
160 log_and_free_error(struct ovsdb_error
*error
)
163 char *s
= ovsdb_error_to_string_free(error
);
170 main_loop(struct server_config
*config
,
171 struct ovsdb_jsonrpc_server
*jsonrpc
, struct shash
*all_dbs
,
172 struct unixctl_server
*unixctl
, struct sset
*remotes
,
173 struct process
*run_process
, bool *exiting
, bool *is_backup
)
175 char *remotes_error
, *ssl_error
;
176 struct shash_node
*node
;
177 long long int status_timer
= LLONG_MIN
;
181 remotes_error
= NULL
;
184 if (memory_should_report()) {
188 ovsdb_jsonrpc_server_get_memory_usage(jsonrpc
, &usage
);
189 ovsdb_monitor_get_memory_usage(&usage
);
190 SHASH_FOR_EACH(node
, all_dbs
) {
191 struct db
*db
= node
->data
;
192 ovsdb_get_memory_usage(db
->db
, &usage
);
194 memory_report(&usage
);
195 simap_destroy(&usage
);
198 /* Run unixctl_server_run() before reconfigure_remotes() because
199 * ovsdb-server/add-remote and ovsdb-server/remove-remote can change
200 * the set of remotes that reconfigure_remotes() uses. */
201 unixctl_server_run(unixctl
);
203 ovsdb_jsonrpc_server_set_read_only(jsonrpc
, *is_backup
);
205 report_error_if_changed(
206 reconfigure_remotes(jsonrpc
, all_dbs
, remotes
),
208 report_error_if_changed(reconfigure_ssl(all_dbs
), &ssl_error
);
209 ovsdb_jsonrpc_server_run(jsonrpc
);
213 if (!replication_is_alive()) {
214 disconnect_active_server();
219 struct shash_node
*next
;
220 SHASH_FOR_EACH_SAFE (node
, next
, all_dbs
) {
221 struct db
*db
= node
->data
;
222 if (ovsdb_trigger_run(db
->db
, time_msec())) {
223 /* The message below is currently the only reason to disconnect
225 ovsdb_jsonrpc_server_reconnect(
227 xasprintf("committed %s database schema conversion",
230 ovsdb_storage_run(db
->db
->storage
);
232 if (ovsdb_storage_is_dead(db
->db
->storage
)) {
233 VLOG_INFO("%s: removing database because storage disconnected "
234 "permanently", node
->name
);
235 remove_db(config
, node
,
236 xasprintf("removing database %s because storage "
237 "disconnected permanently", node
->name
));
238 } else if (ovsdb_storage_should_snapshot(db
->db
->storage
)) {
239 log_and_free_error(ovsdb_snapshot(db
->db
));
244 if (process_exited(run_process
)) {
249 /* update Manager status(es) every 2.5 seconds */
250 if (time_msec() >= status_timer
) {
251 status_timer
= time_msec() + 2500;
252 update_remote_status(jsonrpc
, remotes
, all_dbs
);
255 update_server_status(all_dbs
);
262 ovsdb_jsonrpc_server_wait(jsonrpc
);
263 unixctl_server_wait(unixctl
);
264 SHASH_FOR_EACH(node
, all_dbs
) {
265 struct db
*db
= node
->data
;
266 ovsdb_trigger_wait(db
->db
, time_msec());
267 ovsdb_storage_wait(db
->db
->storage
);
268 ovsdb_storage_read_wait(db
->db
->storage
);
271 process_wait(run_process
);
274 poll_immediate_wake();
276 poll_timer_wait_until(status_timer
);
278 if (should_service_stop()) {
287 main(int argc
, char *argv
[])
289 char *unixctl_path
= NULL
;
290 char *run_command
= NULL
;
291 struct unixctl_server
*unixctl
;
292 struct ovsdb_jsonrpc_server
*jsonrpc
;
293 struct sset remotes
, db_filenames
;
294 char *sync_from
, *sync_exclude
;
296 const char *db_filename
;
297 struct process
*run_process
;
300 FILE *config_tmpfile
;
301 struct server_config server_config
;
302 struct shash all_dbs
;
303 struct shash_node
*node
, *next
;
305 ovs_cmdl_proctitle_init(argc
, argv
);
306 set_program_name(argv
[0]);
307 service_start(&argc
, &argv
);
308 fatal_ignore_sigpipe();
312 parse_options(argc
, argv
, &db_filenames
, &remotes
, &unixctl_path
,
313 &run_command
, &sync_from
, &sync_exclude
, &active
);
314 is_backup
= sync_from
&& !active
;
316 daemon_become_new_user(false);
318 /* Create and initialize 'config_tmpfile' as a temporary file to hold
319 * ovsdb-server's most basic configuration, and then save our initial
320 * configuration to it. When --monitor is used, this preserves the effects
321 * of ovs-appctl commands such as ovsdb-server/add-remote (which saves the
322 * new configuration) across crashes. */
323 config_tmpfile
= tmpfile();
324 if (!config_tmpfile
) {
325 ovs_fatal(errno
, "failed to create temporary file");
328 server_config
.remotes
= &remotes
;
329 server_config
.config_tmpfile
= config_tmpfile
;
331 save_config__(config_tmpfile
, &remotes
, &db_filenames
, sync_from
,
332 sync_exclude
, is_backup
);
334 daemonize_start(false);
336 /* Load the saved config. */
337 load_config(config_tmpfile
, &remotes
, &db_filenames
, &sync_from
,
338 &sync_exclude
, &is_backup
);
340 /* Start ovsdb jsonrpc server. When running as a backup server,
341 * jsonrpc connections are read only. Otherwise, both read
342 * and write transactions are allowed. */
343 jsonrpc
= ovsdb_jsonrpc_server_create(is_backup
);
345 shash_init(&all_dbs
);
346 server_config
.all_dbs
= &all_dbs
;
347 server_config
.jsonrpc
= jsonrpc
;
348 server_config
.sync_from
= &sync_from
;
349 server_config
.sync_exclude
= &sync_exclude
;
350 server_config
.is_backup
= &is_backup
;
352 perf_counters_init();
354 SSET_FOR_EACH (db_filename
, &db_filenames
) {
355 struct ovsdb_error
*error
= open_db(&server_config
, db_filename
);
357 char *s
= ovsdb_error_to_string_free(error
);
358 ovs_fatal(0, "%s", s
);
361 add_server_db(&server_config
);
363 char *error
= reconfigure_remotes(jsonrpc
, &all_dbs
, &remotes
);
365 error
= reconfigure_ssl(&all_dbs
);
368 ovs_fatal(0, "%s", error
);
371 retval
= unixctl_server_create(unixctl_path
, &unixctl
);
379 run_argv
[0] = "/bin/sh";
381 run_argv
[2] = run_command
;
384 retval
= process_start(run_argv
, &run_process
);
386 ovs_fatal(retval
, "%s: process failed to start", run_command
);
392 daemonize_complete();
395 /* ovsdb-server is usually a long-running process, in which case it
396 * makes plenty of sense to log the version, but --run makes
397 * ovsdb-server more like a command-line tool, so skip it. */
398 VLOG_INFO("%s (Open vSwitch) %s", program_name
, VERSION
);
401 unixctl_command_register("exit", "", 0, 0, ovsdb_server_exit
, &exiting
);
402 unixctl_command_register("ovsdb-server/compact", "", 0, 1,
403 ovsdb_server_compact
, &all_dbs
);
404 unixctl_command_register("ovsdb-server/reconnect", "", 0, 0,
405 ovsdb_server_reconnect
, jsonrpc
);
407 unixctl_command_register("ovsdb-server/add-remote", "REMOTE", 1, 1,
408 ovsdb_server_add_remote
, &server_config
);
409 unixctl_command_register("ovsdb-server/remove-remote", "REMOTE", 1, 1,
410 ovsdb_server_remove_remote
, &server_config
);
411 unixctl_command_register("ovsdb-server/list-remotes", "", 0, 0,
412 ovsdb_server_list_remotes
, &remotes
);
414 unixctl_command_register("ovsdb-server/add-db", "DB", 1, 1,
415 ovsdb_server_add_database
, &server_config
);
416 unixctl_command_register("ovsdb-server/remove-db", "DB", 1, 1,
417 ovsdb_server_remove_database
, &server_config
);
418 unixctl_command_register("ovsdb-server/list-dbs", "", 0, 0,
419 ovsdb_server_list_databases
, &all_dbs
);
420 unixctl_command_register("ovsdb-server/perf-counters-show", "", 0, 0,
421 ovsdb_server_perf_counters_show
, NULL
);
422 unixctl_command_register("ovsdb-server/perf-counters-clear", "", 0, 0,
423 ovsdb_server_perf_counters_clear
, NULL
);
424 unixctl_command_register("ovsdb-server/set-active-ovsdb-server", "", 1, 1,
425 ovsdb_server_set_active_ovsdb_server
,
427 unixctl_command_register("ovsdb-server/get-active-ovsdb-server", "", 0, 0,
428 ovsdb_server_get_active_ovsdb_server
,
430 unixctl_command_register("ovsdb-server/connect-active-ovsdb-server", "",
431 0, 0, ovsdb_server_connect_active_ovsdb_server
,
433 unixctl_command_register("ovsdb-server/disconnect-active-ovsdb-server", "",
434 0, 0, ovsdb_server_disconnect_active_ovsdb_server
,
436 unixctl_command_register("ovsdb-server/set-sync-exclude-tables", "",
437 0, 1, ovsdb_server_set_sync_exclude_tables
,
439 unixctl_command_register("ovsdb-server/get-sync-exclude-tables", "",
440 0, 0, ovsdb_server_get_sync_exclude_tables
,
442 unixctl_command_register("ovsdb-server/sync-status", "",
443 0, 0, ovsdb_server_get_sync_status
,
446 /* Simulate the behavior of OVS release prior to version 2.5 that
447 * does not support the monitor_cond method. */
448 unixctl_command_register("ovsdb-server/disable-monitor-cond", "", 0, 0,
449 ovsdb_server_disable_monitor_cond
, jsonrpc
);
452 const struct uuid
*server_uuid
;
453 server_uuid
= ovsdb_jsonrpc_server_get_uuid(jsonrpc
);
454 ovsdb_replication_init(sync_from
, sync_exclude
, &all_dbs
, server_uuid
);
457 main_loop(&server_config
, jsonrpc
, &all_dbs
, unixctl
, &remotes
,
458 run_process
, &exiting
, &is_backup
);
460 SHASH_FOR_EACH_SAFE(node
, next
, &all_dbs
) {
461 struct db
*db
= node
->data
;
462 close_db(&server_config
, db
, NULL
);
463 shash_delete(&all_dbs
, node
);
465 ovsdb_jsonrpc_server_destroy(jsonrpc
);
466 shash_destroy(&all_dbs
);
467 sset_destroy(&remotes
);
468 sset_destroy(&db_filenames
);
471 unixctl_server_destroy(unixctl
);
472 replication_destroy();
474 if (run_process
&& process_exited(run_process
)) {
475 int status
= process_status(run_process
);
477 ovs_fatal(0, "%s: child exited, %s",
478 run_command
, process_status_msg(status
));
481 perf_counters_destroy();
486 /* Returns true if 'filename' is known to be already open as a database,
489 * "False negatives" are possible. */
491 is_already_open(struct server_config
*config OVS_UNUSED
,
492 const char *filename OVS_UNUSED
)
497 if (!stat(filename
, &s
)) {
498 struct shash_node
*node
;
500 SHASH_FOR_EACH (node
, config
->all_dbs
) {
501 struct db
*db
= node
->data
;
504 if (!stat(db
->filename
, &s2
)
505 && s
.st_dev
== s2
.st_dev
506 && s
.st_ino
== s2
.st_ino
) {
517 close_db(struct server_config
*config
, struct db
*db
, char *comment
)
520 ovsdb_jsonrpc_server_remove_db(config
->jsonrpc
, db
->db
, comment
);
521 ovsdb_destroy(db
->db
);
529 static struct ovsdb_error
* OVS_WARN_UNUSED_RESULT
530 parse_txn(struct server_config
*config
, struct db
*db
,
531 struct ovsdb_schema
*schema
, const struct json
*txn_json
,
532 const struct uuid
*txnid
)
535 /* We're replacing the schema (and the data). Destroy the database
536 * (first grabbing its storage), then replace it with the new schema.
537 * The transaction must also include the replacement data.
539 * Only clustered database schema changes go through this path. */
540 ovs_assert(txn_json
);
541 ovs_assert(ovsdb_storage_is_clustered(db
->db
->storage
));
543 struct ovsdb_error
*error
= ovsdb_schema_check_for_ephemeral_columns(
549 ovsdb_jsonrpc_server_reconnect(
550 config
->jsonrpc
, false,
552 ? xasprintf("database %s schema changed", db
->db
->name
)
553 : xasprintf("database %s connected to storage", db
->db
->name
)));
555 ovsdb_replace(db
->db
, ovsdb_create(schema
, NULL
));
557 /* Force update to schema in _Server database. */
558 db
->row_uuid
= UUID_ZERO
;
562 if (!db
->db
->schema
) {
563 return ovsdb_error(NULL
, "%s: data without schema", db
->filename
);
566 struct ovsdb_txn
*txn
;
567 struct ovsdb_error
*error
;
569 error
= ovsdb_file_txn_from_json(db
->db
, txn_json
, false, &txn
);
571 log_and_free_error(ovsdb_txn_replay_commit(txn
));
573 if (!error
&& !uuid_is_zero(txnid
)) {
574 db
->db
->prereq
= *txnid
;
577 ovsdb_storage_unread(db
->db
->storage
);
586 read_db(struct server_config
*config
, struct db
*db
)
588 struct ovsdb_error
*error
;
590 struct ovsdb_schema
*schema
;
591 struct json
*txn_json
;
593 error
= ovsdb_storage_read(db
->db
->storage
, &schema
, &txn_json
,
597 } else if (!schema
&& !txn_json
) {
601 error
= parse_txn(config
, db
, schema
, txn_json
, &txnid
);
602 json_destroy(txn_json
);
609 /* Log error but otherwise ignore it. Probably the database just
610 * got truncated due to power failure etc. and we should use its
611 * current contents. */
612 char *msg
= ovsdb_error_to_string_free(error
);
618 add_db(struct server_config
*config
, struct db
*db
)
620 db
->row_uuid
= UUID_ZERO
;
621 shash_add_assert(config
->all_dbs
, db
->db
->name
, db
);
624 static struct ovsdb_error
* OVS_WARN_UNUSED_RESULT
625 open_db(struct server_config
*config
, const char *filename
)
629 /* If we know that the file is already open, return a good error message.
630 * Otherwise, if the file is open, we'll fail later on with a harder to
631 * interpret file locking error. */
632 if (is_already_open(config
, filename
)) {
633 return ovsdb_error(NULL
, "%s: already open", filename
);
636 struct ovsdb_storage
*storage
;
637 struct ovsdb_error
*error
;
638 error
= ovsdb_storage_open(filename
, true, &storage
);
643 db
= xzalloc(sizeof *db
);
644 db
->filename
= xstrdup(filename
);
646 struct ovsdb_schema
*schema
;
647 if (ovsdb_storage_is_clustered(storage
)) {
650 struct json
*txn_json
;
651 error
= ovsdb_storage_read(storage
, &schema
, &txn_json
, NULL
);
653 ovsdb_storage_close(storage
);
656 ovs_assert(schema
&& !txn_json
);
658 db
->db
= ovsdb_create(schema
, storage
);
659 ovsdb_jsonrpc_server_add_db(config
->jsonrpc
, db
->db
);
663 error
= (db
->db
->name
[0] == '_'
664 ? ovsdb_error(NULL
, "%s: names beginning with \"_\" are reserved",
666 : shash_find(config
->all_dbs
, db
->db
->name
)
667 ? ovsdb_error(NULL
, "%s: duplicate database name", db
->db
->name
)
670 char *error_s
= ovsdb_error_to_string(error
);
672 xasprintf("cannot complete opening %s database (%s)",
673 db
->db
->name
, error_s
));
682 /* Add the internal _Server database to the server configuration. */
684 add_server_db(struct server_config
*config
)
686 struct json
*schema_json
= json_from_string(
687 #include "ovsdb/_server.ovsschema.inc"
689 ovs_assert(schema_json
->type
== JSON_OBJECT
);
691 struct ovsdb_schema
*schema
;
692 struct ovsdb_error
*error OVS_UNUSED
= ovsdb_schema_from_json(schema_json
,
695 json_destroy(schema_json
);
697 struct db
*db
= xzalloc(sizeof *db
);
698 db
->filename
= xstrdup("<internal>");
699 db
->db
= ovsdb_create(schema
, ovsdb_storage_create_unbacked());
700 bool ok OVS_UNUSED
= ovsdb_jsonrpc_server_add_db(config
->jsonrpc
, db
->db
);
705 static char * OVS_WARN_UNUSED_RESULT
706 parse_db_column__(const struct shash
*all_dbs
,
707 const char *name_
, char *name
,
708 const struct db
**dbp
,
709 const struct ovsdb_table
**tablep
,
710 const struct ovsdb_column
**columnp
)
712 const char *db_name
, *table_name
, *column_name
;
713 const char *tokens
[3];
714 char *save_ptr
= NULL
;
720 strtok_r(name
, ":", &save_ptr
); /* "db:" */
721 tokens
[0] = strtok_r(NULL
, ",", &save_ptr
);
722 tokens
[1] = strtok_r(NULL
, ",", &save_ptr
);
723 tokens
[2] = strtok_r(NULL
, ",", &save_ptr
);
724 if (!tokens
[0] || !tokens
[1] || !tokens
[2]) {
725 return xasprintf("\"%s\": invalid syntax", name_
);
729 table_name
= tokens
[1];
730 column_name
= tokens
[2];
732 *dbp
= shash_find_data(all_dbs
, tokens
[0]);
734 return xasprintf("\"%s\": no database named %s", name_
, db_name
);
737 *tablep
= ovsdb_get_table((*dbp
)->db
, table_name
);
739 return xasprintf("\"%s\": no table named %s", name_
, table_name
);
742 *columnp
= ovsdb_table_schema_get_column((*tablep
)->schema
, column_name
);
744 return xasprintf("\"%s\": table \"%s\" has no column \"%s\"",
745 name_
, table_name
, column_name
);
751 /* Returns NULL if successful, otherwise a malloc()'d string describing the
753 static char * OVS_WARN_UNUSED_RESULT
754 parse_db_column(const struct shash
*all_dbs
,
756 const struct db
**dbp
,
757 const struct ovsdb_table
**tablep
,
758 const struct ovsdb_column
**columnp
)
760 char *name
= xstrdup(name_
);
761 char *retval
= parse_db_column__(all_dbs
, name_
, name
,
762 dbp
, tablep
, columnp
);
767 /* Returns NULL if successful, otherwise a malloc()'d string describing the
769 static char * OVS_WARN_UNUSED_RESULT
770 parse_db_string_column(const struct shash
*all_dbs
,
772 const struct db
**dbp
,
773 const struct ovsdb_table
**tablep
,
774 const struct ovsdb_column
**columnp
)
778 retval
= parse_db_column(all_dbs
, name
, dbp
, tablep
, columnp
);
783 if ((*columnp
)->type
.key
.type
!= OVSDB_TYPE_STRING
784 || (*columnp
)->type
.value
.type
!= OVSDB_TYPE_VOID
) {
785 return xasprintf("\"%s\": table \"%s\" column \"%s\" is "
786 "not string or set of strings",
787 name
, (*tablep
)->schema
->name
, (*columnp
)->name
);
794 query_db_string(const struct shash
*all_dbs
, const char *name
,
797 if (!name
|| strncmp(name
, "db:", 3)) {
800 const struct ovsdb_column
*column
;
801 const struct ovsdb_table
*table
;
802 const struct ovsdb_row
*row
;
806 retval
= parse_db_string_column(all_dbs
, name
,
807 &db
, &table
, &column
);
809 if (db
&& !db
->db
->schema
) {
810 /* 'db' is a clustered database but it hasn't connected to the
811 * cluster yet, so we can't get anything out of it, not even a
812 * schema. Not really an error. */
814 ds_put_format(errors
, "%s\n", retval
);
820 HMAP_FOR_EACH (row
, hmap_node
, &table
->rows
) {
821 const struct ovsdb_datum
*datum
;
824 datum
= &row
->fields
[column
->index
];
825 for (i
= 0; i
< datum
->n
; i
++) {
826 if (datum
->keys
[i
].string
[0]) {
827 return datum
->keys
[i
].string
;
835 static struct ovsdb_jsonrpc_options
*
836 add_remote(struct shash
*remotes
, const char *target
)
838 struct ovsdb_jsonrpc_options
*options
;
840 options
= shash_find_data(remotes
, target
);
842 options
= ovsdb_jsonrpc_default_options(target
);
843 shash_add(remotes
, target
, options
);
850 free_remotes(struct shash
*remotes
)
853 struct shash_node
*node
;
855 SHASH_FOR_EACH (node
, remotes
) {
856 struct ovsdb_jsonrpc_options
*options
= node
->data
;
859 shash_destroy_free_data(remotes
);
863 /* Adds a remote and options to 'remotes', based on the Manager table row in
866 add_manager_options(struct shash
*remotes
, const struct ovsdb_row
*row
)
868 static struct vlog_rate_limit rl
= VLOG_RATE_LIMIT_INIT(1, 1);
869 struct ovsdb_jsonrpc_options
*options
;
870 long long int max_backoff
, probe_interval
;
872 const char *target
, *dscp_string
, *role
;
874 if (!ovsdb_util_read_string_column(row
, "target", &target
) || !target
) {
875 VLOG_INFO_RL(&rl
, "Table `%s' has missing or invalid `target' column",
876 row
->table
->schema
->name
);
880 options
= add_remote(remotes
, target
);
881 if (ovsdb_util_read_integer_column(row
, "max_backoff", &max_backoff
)) {
882 options
->max_backoff
= max_backoff
;
884 if (ovsdb_util_read_integer_column(row
, "inactivity_probe",
886 options
->probe_interval
= probe_interval
;
888 if (ovsdb_util_read_bool_column(row
, "read_only", &read_only
)) {
889 options
->read_only
= read_only
;
893 options
->role
= NULL
;
894 if (ovsdb_util_read_string_column(row
, "role", &role
) && role
) {
895 options
->role
= xstrdup(role
);
898 options
->dscp
= DSCP_DEFAULT
;
899 dscp_string
= ovsdb_util_read_map_string_column(row
, "other_config",
902 int dscp
= atoi(dscp_string
);
903 if (dscp
>= 0 && dscp
<= 63) {
904 options
->dscp
= dscp
;
910 query_db_remotes(const char *name
, const struct shash
*all_dbs
,
911 struct shash
*remotes
, struct ds
*errors
)
913 const struct ovsdb_column
*column
;
914 const struct ovsdb_table
*table
;
915 const struct ovsdb_row
*row
;
919 retval
= parse_db_column(all_dbs
, name
, &db
, &table
, &column
);
921 if (db
&& !db
->db
->schema
) {
922 /* 'db' is a clustered database but it hasn't connected to the
923 * cluster yet, so we can't get anything out of it, not even a
924 * schema. Not really an error. */
926 ds_put_format(errors
, "%s\n", retval
);
932 if (column
->type
.key
.type
== OVSDB_TYPE_STRING
933 && column
->type
.value
.type
== OVSDB_TYPE_VOID
) {
934 HMAP_FOR_EACH (row
, hmap_node
, &table
->rows
) {
935 const struct ovsdb_datum
*datum
;
938 datum
= &row
->fields
[column
->index
];
939 for (i
= 0; i
< datum
->n
; i
++) {
940 add_remote(remotes
, datum
->keys
[i
].string
);
943 } else if (column
->type
.key
.type
== OVSDB_TYPE_UUID
944 && column
->type
.key
.uuid
.refTable
945 && column
->type
.value
.type
== OVSDB_TYPE_VOID
) {
946 const struct ovsdb_table
*ref_table
= column
->type
.key
.uuid
.refTable
;
947 HMAP_FOR_EACH (row
, hmap_node
, &table
->rows
) {
948 const struct ovsdb_datum
*datum
;
951 datum
= &row
->fields
[column
->index
];
952 for (i
= 0; i
< datum
->n
; i
++) {
953 const struct ovsdb_row
*ref_row
;
955 ref_row
= ovsdb_table_get_row(ref_table
, &datum
->keys
[i
].uuid
);
957 add_manager_options(remotes
, ref_row
);
965 update_remote_row(const struct ovsdb_row
*row
, struct ovsdb_txn
*txn
,
966 const struct ovsdb_jsonrpc_server
*jsonrpc
)
968 struct ovsdb_jsonrpc_remote_status status
;
969 struct ovsdb_row
*rw_row
;
971 char *keys
[9], *values
[9];
974 /* Get the "target" (protocol/host/port) spec. */
975 if (!ovsdb_util_read_string_column(row
, "target", &target
)) {
976 /* Bad remote spec or incorrect schema. */
979 rw_row
= ovsdb_txn_row_modify(txn
, row
);
980 ovsdb_jsonrpc_server_get_remote_status(jsonrpc
, target
, &status
);
982 /* Update status information columns. */
983 ovsdb_util_write_bool_column(rw_row
, "is_connected", status
.is_connected
);
986 keys
[n
] = xstrdup("state");
987 values
[n
++] = xstrdup(status
.state
);
989 if (status
.sec_since_connect
!= UINT_MAX
) {
990 keys
[n
] = xstrdup("sec_since_connect");
991 values
[n
++] = xasprintf("%u", status
.sec_since_connect
);
993 if (status
.sec_since_disconnect
!= UINT_MAX
) {
994 keys
[n
] = xstrdup("sec_since_disconnect");
995 values
[n
++] = xasprintf("%u", status
.sec_since_disconnect
);
997 if (status
.last_error
) {
998 keys
[n
] = xstrdup("last_error");
1000 xstrdup(ovs_retval_to_string(status
.last_error
));
1002 if (status
.locks_held
&& status
.locks_held
[0]) {
1003 keys
[n
] = xstrdup("locks_held");
1004 values
[n
++] = xstrdup(status
.locks_held
);
1006 if (status
.locks_waiting
&& status
.locks_waiting
[0]) {
1007 keys
[n
] = xstrdup("locks_waiting");
1008 values
[n
++] = xstrdup(status
.locks_waiting
);
1010 if (status
.locks_lost
&& status
.locks_lost
[0]) {
1011 keys
[n
] = xstrdup("locks_lost");
1012 values
[n
++] = xstrdup(status
.locks_lost
);
1014 if (status
.n_connections
> 1) {
1015 keys
[n
] = xstrdup("n_connections");
1016 values
[n
++] = xasprintf("%d", status
.n_connections
);
1018 if (status
.bound_port
!= htons(0)) {
1019 keys
[n
] = xstrdup("bound_port");
1020 values
[n
++] = xasprintf("%"PRIu16
, ntohs(status
.bound_port
));
1022 ovsdb_util_write_string_string_column(rw_row
, "status", keys
, values
, n
);
1024 ovsdb_jsonrpc_server_free_remote_status(&status
);
1028 update_remote_rows(const struct shash
*all_dbs
, const struct db
*db_
,
1029 const char *remote_name
,
1030 const struct ovsdb_jsonrpc_server
*jsonrpc
,
1031 struct ovsdb_txn
*txn
)
1033 const struct ovsdb_table
*table
, *ref_table
;
1034 const struct ovsdb_column
*column
;
1035 const struct ovsdb_row
*row
;
1036 const struct db
*db
;
1039 if (strncmp("db:", remote_name
, 3)) {
1043 retval
= parse_db_column(all_dbs
, remote_name
, &db
, &table
, &column
);
1050 || column
->type
.key
.type
!= OVSDB_TYPE_UUID
1051 || !column
->type
.key
.uuid
.refTable
1052 || column
->type
.value
.type
!= OVSDB_TYPE_VOID
) {
1056 ref_table
= column
->type
.key
.uuid
.refTable
;
1058 HMAP_FOR_EACH (row
, hmap_node
, &table
->rows
) {
1059 const struct ovsdb_datum
*datum
;
1062 datum
= &row
->fields
[column
->index
];
1063 for (i
= 0; i
< datum
->n
; i
++) {
1064 const struct ovsdb_row
*ref_row
;
1066 ref_row
= ovsdb_table_get_row(ref_table
, &datum
->keys
[i
].uuid
);
1068 update_remote_row(ref_row
, txn
, jsonrpc
);
1075 commit_txn(struct ovsdb_txn
*txn
, const char *name
)
1077 struct ovsdb_error
*error
= ovsdb_txn_propose_commit_block(txn
, false);
1079 static struct vlog_rate_limit rl
= VLOG_RATE_LIMIT_INIT(1, 1);
1080 char *msg
= ovsdb_error_to_string_free(error
);
1081 VLOG_ERR_RL(&rl
, "Failed to update %s: %s", name
, msg
);
1087 update_remote_status(const struct ovsdb_jsonrpc_server
*jsonrpc
,
1088 const struct sset
*remotes
,
1089 struct shash
*all_dbs
)
1091 struct shash_node
*node
;
1092 SHASH_FOR_EACH (node
, all_dbs
) {
1093 struct db
*db
= node
->data
;
1094 if (!db
->db
|| ovsdb_storage_is_clustered(db
->db
->storage
)) {
1098 struct ovsdb_txn
*txn
= ovsdb_txn_create(db
->db
);
1100 SSET_FOR_EACH (remote
, remotes
) {
1101 update_remote_rows(all_dbs
, db
, remote
, jsonrpc
, txn
);
1103 commit_txn(txn
, "remote status");
1107 /* Updates 'row', a row in the _Server database's Database table, to match
1110 update_database_status(struct ovsdb_row
*row
, struct db
*db
)
1112 ovsdb_util_write_string_column(row
, "name", db
->db
->name
);
1113 ovsdb_util_write_string_column(row
, "model",
1114 ovsdb_storage_get_model(db
->db
->storage
));
1115 ovsdb_util_write_bool_column(row
, "connected",
1116 ovsdb_storage_is_connected(db
->db
->storage
));
1117 ovsdb_util_write_bool_column(row
, "leader",
1118 ovsdb_storage_is_leader(db
->db
->storage
));
1119 ovsdb_util_write_uuid_column(row
, "cid",
1120 ovsdb_storage_get_cid(db
->db
->storage
));
1121 ovsdb_util_write_uuid_column(row
, "sid",
1122 ovsdb_storage_get_sid(db
->db
->storage
));
1124 uint64_t index
= ovsdb_storage_get_applied_index(db
->db
->storage
);
1126 ovsdb_util_write_integer_column(row
, "index", index
);
1128 ovsdb_util_clear_column(row
, "index");
1131 const struct uuid
*row_uuid
= ovsdb_row_get_uuid(row
);
1132 if (!uuid_equals(row_uuid
, &db
->row_uuid
)) {
1133 db
->row_uuid
= *row_uuid
;
1135 /* The schema can only change if the row UUID changes, so only update
1136 * it in that case. Presumably, this is worth optimizing because
1137 * schemas are often kilobytes in size and nontrivial to serialize. */
1138 char *schema
= NULL
;
1139 if (db
->db
->schema
) {
1140 struct json
*json_schema
= ovsdb_schema_to_json(db
->db
->schema
);
1141 schema
= json_to_string(json_schema
, JSSF_SORT
);
1142 json_destroy(json_schema
);
1144 ovsdb_util_write_string_column(row
, "schema", schema
);
1149 /* Updates the Database table in the _Server database. */
1151 update_server_status(struct shash
*all_dbs
)
1153 struct db
*server_db
= shash_find_data(all_dbs
, "_Server");
1154 struct ovsdb_table
*database_table
= shash_find_data(
1155 &server_db
->db
->tables
, "Database");
1156 struct ovsdb_txn
*txn
= ovsdb_txn_create(server_db
->db
);
1158 /* Update rows for databases that still exist.
1159 * Delete rows for databases that no longer exist. */
1160 const struct ovsdb_row
*row
, *next_row
;
1161 HMAP_FOR_EACH_SAFE (row
, next_row
, hmap_node
, &database_table
->rows
) {
1163 ovsdb_util_read_string_column(row
, "name", &name
);
1164 struct db
*db
= shash_find_data(all_dbs
, name
);
1165 if (!db
|| !db
->db
) {
1166 ovsdb_txn_row_delete(txn
, row
);
1168 update_database_status(ovsdb_txn_row_modify(txn
, row
), db
);
1172 /* Add rows for new databases.
1174 * This is O(n**2) but usually there are only 2 or 3 databases. */
1175 struct shash_node
*node
;
1176 SHASH_FOR_EACH (node
, all_dbs
) {
1177 struct db
*db
= node
->data
;
1183 HMAP_FOR_EACH (row
, hmap_node
, &database_table
->rows
) {
1185 ovsdb_util_read_string_column(row
, "name", &name
);
1186 if (!strcmp(name
, node
->name
)) {
1192 struct ovsdb_row
*new_row
= ovsdb_row_create(database_table
);
1193 uuid_generate(ovsdb_row_get_uuid_rw(new_row
));
1194 update_database_status(new_row
, db
);
1195 ovsdb_txn_row_insert(txn
, new_row
);
1200 commit_txn(txn
, "_Server");
1203 /* Reconfigures ovsdb-server's remotes based on information in the database. */
1205 reconfigure_remotes(struct ovsdb_jsonrpc_server
*jsonrpc
,
1206 const struct shash
*all_dbs
, struct sset
*remotes
)
1208 struct ds errors
= DS_EMPTY_INITIALIZER
;
1209 struct shash resolved_remotes
;
1212 /* Configure remotes. */
1213 shash_init(&resolved_remotes
);
1214 SSET_FOR_EACH (name
, remotes
) {
1215 if (!strncmp(name
, "db:", 3)) {
1216 query_db_remotes(name
, all_dbs
, &resolved_remotes
, &errors
);
1218 add_remote(&resolved_remotes
, name
);
1221 ovsdb_jsonrpc_server_set_remotes(jsonrpc
, &resolved_remotes
);
1222 free_remotes(&resolved_remotes
);
1224 return errors
.string
;
1228 reconfigure_ssl(const struct shash
*all_dbs
)
1230 struct ds errors
= DS_EMPTY_INITIALIZER
;
1231 const char *resolved_private_key
;
1232 const char *resolved_certificate
;
1233 const char *resolved_ca_cert
;
1234 const char *resolved_ssl_protocols
;
1235 const char *resolved_ssl_ciphers
;
1237 resolved_private_key
= query_db_string(all_dbs
, private_key_file
, &errors
);
1238 resolved_certificate
= query_db_string(all_dbs
, certificate_file
, &errors
);
1239 resolved_ca_cert
= query_db_string(all_dbs
, ca_cert_file
, &errors
);
1240 resolved_ssl_protocols
= query_db_string(all_dbs
, ssl_protocols
, &errors
);
1241 resolved_ssl_ciphers
= query_db_string(all_dbs
, ssl_ciphers
, &errors
);
1243 stream_ssl_set_key_and_cert(resolved_private_key
, resolved_certificate
);
1244 stream_ssl_set_ca_cert_file(resolved_ca_cert
, bootstrap_ca_cert
);
1245 stream_ssl_set_protocols(resolved_ssl_protocols
);
1246 stream_ssl_set_ciphers(resolved_ssl_ciphers
);
1248 return errors
.string
;
1252 report_error_if_changed(char *error
, char **last_errorp
)
1255 if (!*last_errorp
|| strcmp(error
, *last_errorp
)) {
1256 VLOG_WARN("%s", error
);
1258 *last_errorp
= error
;
1264 *last_errorp
= NULL
;
1269 ovsdb_server_set_active_ovsdb_server(struct unixctl_conn
*conn
,
1270 int argc OVS_UNUSED
, const char *argv
[],
1273 struct server_config
*config
= config_
;
1275 if (*config
->sync_from
) {
1276 free(*config
->sync_from
);
1278 *config
->sync_from
= xstrdup(argv
[1]);
1279 save_config(config
);
1281 unixctl_command_reply(conn
, NULL
);
1285 ovsdb_server_get_active_ovsdb_server(struct unixctl_conn
*conn
,
1286 int argc OVS_UNUSED
,
1287 const char *argv
[] OVS_UNUSED
,
1290 struct server_config
*config
= config_
;
1292 unixctl_command_reply(conn
, *config
->sync_from
);
1296 ovsdb_server_connect_active_ovsdb_server(struct unixctl_conn
*conn
,
1297 int argc OVS_UNUSED
,
1298 const char *argv
[] OVS_UNUSED
,
1301 struct server_config
*config
= config_
;
1304 if ( !*config
->sync_from
) {
1305 msg
= "Unable to connect: active server is not specified.\n";
1307 const struct uuid
*server_uuid
;
1308 server_uuid
= ovsdb_jsonrpc_server_get_uuid(config
->jsonrpc
);
1309 ovsdb_replication_init(*config
->sync_from
, *config
->sync_exclude
,
1310 config
->all_dbs
, server_uuid
);
1311 if (!*config
->is_backup
) {
1312 *config
->is_backup
= true;
1313 save_config(config
);
1316 unixctl_command_reply(conn
, msg
);
1320 ovsdb_server_disconnect_active_ovsdb_server(struct unixctl_conn
*conn
,
1321 int argc OVS_UNUSED
,
1322 const char *argv
[] OVS_UNUSED
,
1325 struct server_config
*config
= config_
;
1327 disconnect_active_server();
1328 *config
->is_backup
= false;
1329 save_config(config
);
1330 unixctl_command_reply(conn
, NULL
);
1334 ovsdb_server_set_sync_exclude_tables(struct unixctl_conn
*conn
,
1335 int argc OVS_UNUSED
,
1339 struct server_config
*config
= config_
;
1341 char *err
= set_blacklist_tables(argv
[1], true);
1343 free(*config
->sync_exclude
);
1344 *config
->sync_exclude
= xstrdup(argv
[1]);
1345 save_config(config
);
1346 if (*config
->is_backup
) {
1347 const struct uuid
*server_uuid
;
1348 server_uuid
= ovsdb_jsonrpc_server_get_uuid(config
->jsonrpc
);
1349 ovsdb_replication_init(*config
->sync_from
, *config
->sync_exclude
,
1350 config
->all_dbs
, server_uuid
);
1352 err
= set_blacklist_tables(argv
[1], false);
1354 unixctl_command_reply(conn
, err
);
1359 ovsdb_server_get_sync_exclude_tables(struct unixctl_conn
*conn
,
1360 int argc OVS_UNUSED
,
1361 const char *argv
[] OVS_UNUSED
,
1362 void *arg_ OVS_UNUSED
)
1364 char *reply
= get_blacklist_tables();
1365 unixctl_command_reply(conn
, reply
);
1370 ovsdb_server_exit(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
1371 const char *argv
[] OVS_UNUSED
,
1374 bool *exiting
= exiting_
;
1376 unixctl_command_reply(conn
, NULL
);
1380 ovsdb_server_perf_counters_show(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
1381 const char *argv
[] OVS_UNUSED
,
1382 void *arg_ OVS_UNUSED
)
1384 char *s
= perf_counters_to_string();
1386 unixctl_command_reply(conn
, s
);
1391 ovsdb_server_perf_counters_clear(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
1392 const char *argv
[] OVS_UNUSED
,
1393 void *arg_ OVS_UNUSED
)
1395 perf_counters_clear();
1396 unixctl_command_reply(conn
, NULL
);
1399 /* "ovsdb-server/disable-monitor-cond": makes ovsdb-server drop all of its
1400 * JSON-RPC connections and reconnect. New sessions will not recognize
1401 * the 'monitor_cond' method. */
1403 ovsdb_server_disable_monitor_cond(struct unixctl_conn
*conn
,
1404 int argc OVS_UNUSED
,
1405 const char *argv
[] OVS_UNUSED
,
1408 struct ovsdb_jsonrpc_server
*jsonrpc
= jsonrpc_
;
1410 ovsdb_jsonrpc_disable_monitor_cond();
1411 ovsdb_jsonrpc_server_reconnect(
1412 jsonrpc
, true, xstrdup("user ran ovsdb-server/disable-monitor"));
1413 unixctl_command_reply(conn
, NULL
);
1417 ovsdb_server_compact(struct unixctl_conn
*conn
, int argc
,
1418 const char *argv
[], void *dbs_
)
1420 const char *db_name
= argc
< 2 ? NULL
: argv
[1];
1421 struct shash
*all_dbs
= dbs_
;
1423 struct shash_node
*node
;
1426 if (db_name
&& db_name
[0] == '_') {
1427 unixctl_command_reply_error(conn
, "cannot compact built-in databases");
1432 SHASH_FOR_EACH(node
, all_dbs
) {
1433 struct db
*db
= node
->data
;
1435 ? !strcmp(node
->name
, db_name
)
1436 : node
->name
[0] != '_') {
1438 VLOG_INFO("compacting %s database by user request",
1441 struct ovsdb_error
*error
= ovsdb_snapshot(db
->db
);
1443 char *s
= ovsdb_error_to_string(error
);
1444 ds_put_format(&reply
, "%s\n", s
);
1446 ovsdb_error_destroy(error
);
1455 unixctl_command_reply_error(conn
, "no database by that name");
1456 } else if (reply
.length
) {
1457 unixctl_command_reply_error(conn
, ds_cstr(&reply
));
1459 unixctl_command_reply(conn
, NULL
);
1464 /* "ovsdb-server/reconnect": makes ovsdb-server drop all of its JSON-RPC
1465 * connections and reconnect. */
1467 ovsdb_server_reconnect(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
1468 const char *argv
[] OVS_UNUSED
, void *jsonrpc_
)
1470 struct ovsdb_jsonrpc_server
*jsonrpc
= jsonrpc_
;
1471 ovsdb_jsonrpc_server_reconnect(
1472 jsonrpc
, true, xstrdup("user ran ovsdb-server/reconnect"));
1473 unixctl_command_reply(conn
, NULL
);
1476 /* "ovsdb-server/add-remote REMOTE": adds REMOTE to the set of remotes that
1477 * ovsdb-server services. */
1479 ovsdb_server_add_remote(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
1480 const char *argv
[], void *config_
)
1482 struct server_config
*config
= config_
;
1483 const char *remote
= argv
[1];
1485 const struct ovsdb_column
*column
;
1486 const struct ovsdb_table
*table
;
1487 const struct db
*db
;
1490 retval
= (strncmp("db:", remote
, 3)
1492 : parse_db_column(config
->all_dbs
, remote
,
1493 &db
, &table
, &column
));
1495 if (sset_add(config
->remotes
, remote
)) {
1496 save_config(config
);
1498 unixctl_command_reply(conn
, NULL
);
1500 unixctl_command_reply_error(conn
, retval
);
1505 /* "ovsdb-server/remove-remote REMOTE": removes REMOTE frmo the set of remotes
1506 * that ovsdb-server services. */
1508 ovsdb_server_remove_remote(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
1509 const char *argv
[], void *config_
)
1511 struct server_config
*config
= config_
;
1512 struct sset_node
*node
;
1514 node
= sset_find(config
->remotes
, argv
[1]);
1516 sset_delete(config
->remotes
, node
);
1517 save_config(config
);
1518 unixctl_command_reply(conn
, NULL
);
1520 unixctl_command_reply_error(conn
, "no such remote");
1524 /* "ovsdb-server/list-remotes": outputs a list of configured rmeotes. */
1526 ovsdb_server_list_remotes(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
1527 const char *argv
[] OVS_UNUSED
, void *remotes_
)
1529 struct sset
*remotes
= remotes_
;
1530 const char **list
, **p
;
1535 list
= sset_sort(remotes
);
1536 for (p
= list
; *p
; p
++) {
1537 ds_put_format(&s
, "%s\n", *p
);
1541 unixctl_command_reply(conn
, ds_cstr(&s
));
1546 /* "ovsdb-server/add-db DB": adds the DB to ovsdb-server. */
1548 ovsdb_server_add_database(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
1549 const char *argv
[], void *config_
)
1551 struct server_config
*config
= config_
;
1552 const char *filename
= argv
[1];
1554 char *error
= ovsdb_error_to_string_free(open_db(config
, filename
));
1556 save_config(config
);
1557 if (*config
->is_backup
) {
1558 const struct uuid
*server_uuid
;
1559 server_uuid
= ovsdb_jsonrpc_server_get_uuid(config
->jsonrpc
);
1560 ovsdb_replication_init(*config
->sync_from
, *config
->sync_exclude
,
1561 config
->all_dbs
, server_uuid
);
1563 unixctl_command_reply(conn
, NULL
);
1565 unixctl_command_reply_error(conn
, error
);
1571 remove_db(struct server_config
*config
, struct shash_node
*node
, char *comment
)
1573 struct db
*db
= node
->data
;
1575 close_db(config
, db
, comment
);
1576 shash_delete(config
->all_dbs
, node
);
1578 save_config(config
);
1579 if (*config
->is_backup
) {
1580 const struct uuid
*server_uuid
;
1581 server_uuid
= ovsdb_jsonrpc_server_get_uuid(config
->jsonrpc
);
1582 ovsdb_replication_init(*config
->sync_from
, *config
->sync_exclude
,
1583 config
->all_dbs
, server_uuid
);
1588 ovsdb_server_remove_database(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
1589 const char *argv
[], void *config_
)
1591 struct server_config
*config
= config_
;
1592 struct shash_node
*node
;
1594 node
= shash_find(config
->all_dbs
, argv
[1]);
1596 unixctl_command_reply_error(conn
, "Failed to find the database.");
1599 if (node
->name
[0] == '_') {
1600 unixctl_command_reply_error(conn
, "Cannot remove reserved database.");
1604 remove_db(config
, node
, xasprintf("removing %s database by user request",
1606 unixctl_command_reply(conn
, NULL
);
1610 ovsdb_server_list_databases(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
1611 const char *argv
[] OVS_UNUSED
, void *all_dbs_
)
1613 struct shash
*all_dbs
= all_dbs_
;
1614 const struct shash_node
**nodes
;
1620 nodes
= shash_sort(all_dbs
);
1621 for (i
= 0; i
< shash_count(all_dbs
); i
++) {
1622 const struct shash_node
*node
= nodes
[i
];
1623 struct db
*db
= node
->data
;
1625 ds_put_format(&s
, "%s\n", node
->name
);
1630 unixctl_command_reply(conn
, ds_cstr(&s
));
1635 ovsdb_server_get_sync_status(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
1636 const char *argv
[] OVS_UNUSED
, void *config_
)
1638 struct server_config
*config
= config_
;
1639 bool is_backup
= *config
->is_backup
;
1640 struct ds ds
= DS_EMPTY_INITIALIZER
;
1642 ds_put_format(&ds
, "state: %s\n", is_backup
? "backup" : "active");
1645 ds_put_and_free_cstr(&ds
, replication_status());
1648 unixctl_command_reply(conn
, ds_cstr(&ds
));
1653 parse_options(int argc
, char *argv
[],
1654 struct sset
*db_filenames
, struct sset
*remotes
,
1655 char **unixctl_pathp
, char **run_command
,
1656 char **sync_from
, char **sync_exclude
, bool *active
)
1659 OPT_REMOTE
= UCHAR_MAX
+ 1,
1662 OPT_BOOTSTRAP_CA_CERT
,
1669 DAEMON_OPTION_ENUMS
,
1673 static const struct option long_options
[] = {
1674 {"remote", required_argument
, NULL
, OPT_REMOTE
},
1675 {"unixctl", required_argument
, NULL
, OPT_UNIXCTL
},
1677 {"run", required_argument
, NULL
, OPT_RUN
},
1679 {"help", no_argument
, NULL
, 'h'},
1680 {"version", no_argument
, NULL
, 'V'},
1681 DAEMON_LONG_OPTIONS
,
1683 {"bootstrap-ca-cert", required_argument
, NULL
, OPT_BOOTSTRAP_CA_CERT
},
1684 {"peer-ca-cert", required_argument
, NULL
, OPT_PEER_CA_CERT
},
1685 STREAM_SSL_LONG_OPTIONS
,
1686 {"sync-from", required_argument
, NULL
, OPT_SYNC_FROM
},
1687 {"sync-exclude-tables", required_argument
, NULL
, OPT_SYNC_EXCLUDE
},
1688 {"active", no_argument
, NULL
, OPT_ACTIVE
},
1689 {"no-dbs", no_argument
, NULL
, OPT_NO_DBS
},
1692 char *short_options
= ovs_cmdl_long_options_to_short_options(long_options
);
1693 bool add_default_db
= true;
1696 *sync_exclude
= NULL
;
1697 sset_init(db_filenames
);
1702 c
= getopt_long(argc
, argv
, short_options
, long_options
, NULL
);
1709 sset_add(remotes
, optarg
);
1713 *unixctl_pathp
= optarg
;
1717 *run_command
= optarg
;
1724 ovs_print_version(0, 0);
1727 VLOG_OPTION_HANDLERS
1728 DAEMON_OPTION_HANDLERS
1731 private_key_file
= optarg
;
1735 certificate_file
= optarg
;
1739 ca_cert_file
= optarg
;
1740 bootstrap_ca_cert
= false;
1743 case OPT_SSL_PROTOCOLS
:
1744 ssl_protocols
= optarg
;
1747 case OPT_SSL_CIPHERS
:
1748 ssl_ciphers
= optarg
;
1751 case OPT_BOOTSTRAP_CA_CERT
:
1752 ca_cert_file
= optarg
;
1753 bootstrap_ca_cert
= true;
1756 case OPT_PEER_CA_CERT
:
1757 stream_ssl_set_peer_ca_cert_file(optarg
);
1761 *sync_from
= xstrdup(optarg
);
1764 case OPT_SYNC_EXCLUDE
: {
1765 char *err
= set_blacklist_tables(optarg
, false);
1767 ovs_fatal(0, "%s", err
);
1769 *sync_exclude
= xstrdup(optarg
);
1777 add_default_db
= false;
1787 free(short_options
);
1792 for (int i
= 0; i
< argc
; i
++) {
1793 sset_add(db_filenames
, argv
[i
]);
1795 } else if (add_default_db
) {
1796 sset_add_and_free(db_filenames
, xasprintf("%s/conf.db", ovs_dbdir()));
1803 printf("%s: Open vSwitch database server\n"
1804 "usage: %s [OPTIONS] [DATABASE...]\n"
1805 "where each DATABASE is a database file in ovsdb format.\n"
1806 "The default DATABASE, if none is given, is\n%s/conf.db.\n",
1807 program_name
, program_name
, ovs_dbdir());
1808 printf("\nJSON-RPC options (may be specified any number of times):\n"
1809 " --remote=REMOTE connect or listen to REMOTE\n");
1810 stream_usage("JSON-RPC", true, true, true);
1813 replication_usage();
1814 printf("\nOther options:\n"
1815 " --run COMMAND run COMMAND as subprocess then exit\n"
1816 " --unixctl=SOCKET override default control socket name\n"
1817 " -h, --help display this help message\n"
1818 " -V, --version display version information\n");
1822 static struct json
*
1823 sset_to_json(const struct sset
*sset
)
1828 array
= json_array_create_empty();
1829 SSET_FOR_EACH (s
, sset
) {
1830 json_array_add(array
, json_string_create(s
));
1835 /* Truncates and replaces the contents of 'config_file' by a representation of
1836 * 'remotes' and 'db_filenames'. */
1838 save_config__(FILE *config_file
, const struct sset
*remotes
,
1839 const struct sset
*db_filenames
, const char *sync_from
,
1840 const char *sync_exclude
, bool is_backup
)
1845 if (ftruncate(fileno(config_file
), 0) == -1) {
1846 VLOG_FATAL("failed to truncate temporary file (%s)",
1847 ovs_strerror(errno
));
1850 obj
= json_object_create();
1851 json_object_put(obj
, "remotes", sset_to_json(remotes
));
1852 json_object_put(obj
, "db_filenames", sset_to_json(db_filenames
));
1854 json_object_put(obj
, "sync_from", json_string_create(sync_from
));
1857 json_object_put(obj
, "sync_exclude",
1858 json_string_create(sync_exclude
));
1860 json_object_put(obj
, "is_backup", json_boolean_create(is_backup
));
1862 s
= json_to_string(obj
, 0);
1865 if (fseek(config_file
, 0, SEEK_SET
) != 0
1866 || fputs(s
, config_file
) == EOF
1867 || fflush(config_file
) == EOF
) {
1868 VLOG_FATAL("failed to write temporary file (%s)", ovs_strerror(errno
));
1873 /* Truncates and replaces the contents of 'config_file' by a representation of
1876 save_config(struct server_config
*config
)
1878 struct sset db_filenames
;
1879 struct shash_node
*node
;
1881 sset_init(&db_filenames
);
1882 SHASH_FOR_EACH (node
, config
->all_dbs
) {
1883 struct db
*db
= node
->data
;
1884 if (node
->name
[0] != '_') {
1885 sset_add(&db_filenames
, db
->filename
);
1889 save_config__(config
->config_tmpfile
, config
->remotes
, &db_filenames
,
1890 *config
->sync_from
, *config
->sync_exclude
,
1891 *config
->is_backup
);
1893 sset_destroy(&db_filenames
);
1897 sset_from_json(struct sset
*sset
, const struct json
*array
)
1903 ovs_assert(array
->type
== JSON_ARRAY
);
1904 for (i
= 0; i
< array
->array
.n
; i
++) {
1905 const struct json
*elem
= array
->array
.elems
[i
];
1906 sset_add(sset
, json_string(elem
));
1910 /* Clears and replaces 'remotes' and 'dbnames' by a configuration read from
1911 * 'config_file', which must have been previously written by save_config(). */
1913 load_config(FILE *config_file
, struct sset
*remotes
, struct sset
*db_filenames
,
1914 char **sync_from
, char **sync_exclude
, bool *is_backup
)
1918 if (fseek(config_file
, 0, SEEK_SET
) != 0) {
1919 VLOG_FATAL("seek failed in temporary file (%s)", ovs_strerror(errno
));
1921 json
= json_from_stream(config_file
);
1922 if (json
->type
== JSON_STRING
) {
1923 VLOG_FATAL("reading json failed (%s)", json_string(json
));
1925 ovs_assert(json
->type
== JSON_OBJECT
);
1927 sset_from_json(remotes
, shash_find_data(json_object(json
), "remotes"));
1928 sset_from_json(db_filenames
,
1929 shash_find_data(json_object(json
), "db_filenames"));
1931 struct json
*string
;
1932 string
= shash_find_data(json_object(json
), "sync_from");
1934 *sync_from
= string
? xstrdup(json_string(string
)) : NULL
;
1936 string
= shash_find_data(json_object(json
), "sync_exclude");
1937 free(*sync_exclude
);
1938 *sync_exclude
= string
? xstrdup(json_string(string
)) : NULL
;
1940 *is_backup
= json_boolean(shash_find_data(json_object(json
), "is_backup"));