1 /* Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
26 #include "command-line.h"
29 #include "openvswitch/dynamic-string.h"
30 #include "fatal-signal.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 "poll-loop.h"
48 #include "stream-ssl.h"
53 #include "transaction.h"
57 #include "perf-counter.h"
58 #include "openvswitch/vlog.h"
60 VLOG_DEFINE_THIS_MODULE(ovsdb_server
);
63 /* Initialized in main(). */
65 struct ovsdb_file
*file
;
68 /* Only used by update_remote_status(). */
69 struct ovsdb_txn
*txn
;
72 /* SSL configuration. */
73 static char *private_key_file
;
74 static char *certificate_file
;
75 static char *ca_cert_file
;
76 static bool bootstrap_ca_cert
;
78 static unixctl_cb_func ovsdb_server_exit
;
79 static unixctl_cb_func ovsdb_server_compact
;
80 static unixctl_cb_func ovsdb_server_reconnect
;
81 static unixctl_cb_func ovsdb_server_perf_counters_clear
;
82 static unixctl_cb_func ovsdb_server_perf_counters_show
;
83 static unixctl_cb_func ovsdb_server_disable_monitor2
;
85 struct server_config
{
87 struct shash
*all_dbs
;
89 struct ovsdb_jsonrpc_server
*jsonrpc
;
91 static unixctl_cb_func ovsdb_server_add_remote
;
92 static unixctl_cb_func ovsdb_server_remove_remote
;
93 static unixctl_cb_func ovsdb_server_list_remotes
;
95 static unixctl_cb_func ovsdb_server_add_database
;
96 static unixctl_cb_func ovsdb_server_remove_database
;
97 static unixctl_cb_func ovsdb_server_list_databases
;
99 static char *open_db(struct server_config
*config
, const char *filename
);
100 static void close_db(struct db
*db
);
102 static void parse_options(int *argc
, char **argvp
[],
103 struct sset
*remotes
, char **unixctl_pathp
,
105 OVS_NO_RETURN
static void usage(void);
107 static char *reconfigure_remotes(struct ovsdb_jsonrpc_server
*,
108 const struct shash
*all_dbs
,
109 struct sset
*remotes
);
110 static char *reconfigure_ssl(const struct shash
*all_dbs
);
111 static void report_error_if_changed(char *error
, char **last_errorp
);
113 static void update_remote_status(const struct ovsdb_jsonrpc_server
*jsonrpc
,
114 const struct sset
*remotes
,
115 struct shash
*all_dbs
);
117 static void save_config__(FILE *config_file
, const struct sset
*remotes
,
118 const struct sset
*db_filenames
);
119 static void save_config(struct server_config
*);
120 static void load_config(FILE *config_file
, struct sset
*remotes
,
121 struct sset
*db_filenames
);
124 main_loop(struct ovsdb_jsonrpc_server
*jsonrpc
, struct shash
*all_dbs
,
125 struct unixctl_server
*unixctl
, struct sset
*remotes
,
126 struct process
*run_process
, bool *exiting
)
128 char *remotes_error
, *ssl_error
;
129 struct shash_node
*node
;
130 long long int status_timer
= LLONG_MIN
;
134 remotes_error
= NULL
;
137 if (memory_should_report()) {
141 ovsdb_jsonrpc_server_get_memory_usage(jsonrpc
, &usage
);
142 ovsdb_monitor_get_memory_usage(&usage
);
143 SHASH_FOR_EACH(node
, all_dbs
) {
144 struct db
*db
= node
->data
;
145 ovsdb_get_memory_usage(db
->db
, &usage
);
147 memory_report(&usage
);
148 simap_destroy(&usage
);
151 /* Run unixctl_server_run() before reconfigure_remotes() because
152 * ovsdb-server/add-remote and ovsdb-server/remove-remote can change
153 * the set of remotes that reconfigure_remotes() uses. */
154 unixctl_server_run(unixctl
);
156 report_error_if_changed(
157 reconfigure_remotes(jsonrpc
, all_dbs
, remotes
),
159 report_error_if_changed(reconfigure_ssl(all_dbs
), &ssl_error
);
160 ovsdb_jsonrpc_server_run(jsonrpc
);
162 SHASH_FOR_EACH(node
, all_dbs
) {
163 struct db
*db
= node
->data
;
164 ovsdb_trigger_run(db
->db
, time_msec());
168 if (process_exited(run_process
)) {
173 /* update Manager status(es) every 5 seconds */
174 if (time_msec() >= status_timer
) {
175 status_timer
= time_msec() + 5000;
176 update_remote_status(jsonrpc
, remotes
, all_dbs
);
180 ovsdb_jsonrpc_server_wait(jsonrpc
);
181 unixctl_server_wait(unixctl
);
182 SHASH_FOR_EACH(node
, all_dbs
) {
183 struct db
*db
= node
->data
;
184 ovsdb_trigger_wait(db
->db
, time_msec());
187 process_wait(run_process
);
190 poll_immediate_wake();
192 poll_timer_wait_until(status_timer
);
194 if (should_service_stop()) {
202 main(int argc
, char *argv
[])
204 char *unixctl_path
= NULL
;
205 char *run_command
= NULL
;
206 struct unixctl_server
*unixctl
;
207 struct ovsdb_jsonrpc_server
*jsonrpc
;
208 struct sset remotes
, db_filenames
;
209 const char *db_filename
;
210 struct process
*run_process
;
213 FILE *config_tmpfile
;
214 struct server_config server_config
;
215 struct shash all_dbs
;
216 struct shash_node
*node
, *next
;
220 ovs_cmdl_proctitle_init(argc
, argv
);
221 set_program_name(argv
[0]);
222 service_start(&argc
, &argv
);
223 fatal_ignore_sigpipe();
226 parse_options(&argc
, &argv
, &remotes
, &unixctl_path
, &run_command
);
227 daemon_become_new_user(false);
229 /* Create and initialize 'config_tmpfile' as a temporary file to hold
230 * ovsdb-server's most basic configuration, and then save our initial
231 * configuration to it. When --monitor is used, this preserves the effects
232 * of ovs-appctl commands such as ovsdb-server/add-remote (which saves the
233 * new configuration) across crashes. */
234 config_tmpfile
= tmpfile();
235 if (!config_tmpfile
) {
236 ovs_fatal(errno
, "failed to create temporary file");
239 sset_init(&db_filenames
);
241 for (i
= 0; i
< argc
; i
++) {
242 sset_add(&db_filenames
, argv
[i
]);
245 char *default_db
= xasprintf("%s/conf.db", ovs_dbdir());
246 sset_add(&db_filenames
, default_db
);
250 server_config
.remotes
= &remotes
;
251 server_config
.config_tmpfile
= config_tmpfile
;
253 save_config__(config_tmpfile
, &remotes
, &db_filenames
);
255 daemonize_start(false);
257 /* Load the saved config. */
258 load_config(config_tmpfile
, &remotes
, &db_filenames
);
259 jsonrpc
= ovsdb_jsonrpc_server_create();
261 shash_init(&all_dbs
);
262 server_config
.all_dbs
= &all_dbs
;
263 server_config
.jsonrpc
= jsonrpc
;
265 perf_counters_init();
267 SSET_FOR_EACH (db_filename
, &db_filenames
) {
268 error
= open_db(&server_config
, db_filename
);
270 ovs_fatal(0, "%s", error
);
274 error
= reconfigure_remotes(jsonrpc
, &all_dbs
, &remotes
);
276 error
= reconfigure_ssl(&all_dbs
);
279 ovs_fatal(0, "%s", error
);
282 retval
= unixctl_server_create(unixctl_path
, &unixctl
);
290 run_argv
[0] = "/bin/sh";
292 run_argv
[2] = run_command
;
295 retval
= process_start(run_argv
, &run_process
);
297 ovs_fatal(retval
, "%s: process failed to start", run_command
);
303 daemonize_complete();
306 /* ovsdb-server is usually a long-running process, in which case it
307 * makes plenty of sense to log the version, but --run makes
308 * ovsdb-server more like a command-line tool, so skip it. */
309 VLOG_INFO("%s (Open vSwitch) %s", program_name
, VERSION
);
312 unixctl_command_register("exit", "", 0, 0, ovsdb_server_exit
, &exiting
);
313 unixctl_command_register("ovsdb-server/compact", "", 0, 1,
314 ovsdb_server_compact
, &all_dbs
);
315 unixctl_command_register("ovsdb-server/reconnect", "", 0, 0,
316 ovsdb_server_reconnect
, jsonrpc
);
318 unixctl_command_register("ovsdb-server/add-remote", "REMOTE", 1, 1,
319 ovsdb_server_add_remote
, &server_config
);
320 unixctl_command_register("ovsdb-server/remove-remote", "REMOTE", 1, 1,
321 ovsdb_server_remove_remote
, &server_config
);
322 unixctl_command_register("ovsdb-server/list-remotes", "", 0, 0,
323 ovsdb_server_list_remotes
, &remotes
);
325 unixctl_command_register("ovsdb-server/add-db", "DB", 1, 1,
326 ovsdb_server_add_database
, &server_config
);
327 unixctl_command_register("ovsdb-server/remove-db", "DB", 1, 1,
328 ovsdb_server_remove_database
, &server_config
);
329 unixctl_command_register("ovsdb-server/list-dbs", "", 0, 0,
330 ovsdb_server_list_databases
, &all_dbs
);
331 unixctl_command_register("ovsdb-server/perf-counters-show", "", 0, 0,
332 ovsdb_server_perf_counters_show
, NULL
);
333 unixctl_command_register("ovsdb-server/perf-counters-clear", "", 0, 0,
334 ovsdb_server_perf_counters_clear
, NULL
);
336 /* Simulate the behavior of OVS release prior to version 2.5 that
337 * does not support the monitor2 method. */
338 unixctl_command_register("ovsdb-server/disable-monitor2", "", 0, 0,
339 ovsdb_server_disable_monitor2
, jsonrpc
);
341 main_loop(jsonrpc
, &all_dbs
, unixctl
, &remotes
, run_process
, &exiting
);
343 ovsdb_jsonrpc_server_destroy(jsonrpc
);
344 SHASH_FOR_EACH_SAFE(node
, next
, &all_dbs
) {
345 struct db
*db
= node
->data
;
347 shash_delete(&all_dbs
, node
);
349 shash_destroy(&all_dbs
);
350 sset_destroy(&remotes
);
351 sset_destroy(&db_filenames
);
352 unixctl_server_destroy(unixctl
);
354 if (run_process
&& process_exited(run_process
)) {
355 int status
= process_status(run_process
);
357 ovs_fatal(0, "%s: child exited, %s",
358 run_command
, process_status_msg(status
));
361 perf_counters_destroy();
366 /* Returns true if 'filename' is known to be already open as a database,
369 * "False negatives" are possible. */
371 is_already_open(struct server_config
*config OVS_UNUSED
,
372 const char *filename OVS_UNUSED
)
377 if (!stat(filename
, &s
)) {
378 struct shash_node
*node
;
380 SHASH_FOR_EACH (node
, config
->all_dbs
) {
381 struct db
*db
= node
->data
;
384 if (!stat(db
->filename
, &s2
)
385 && s
.st_dev
== s2
.st_dev
386 && s
.st_ino
== s2
.st_ino
) {
397 close_db(struct db
*db
)
399 ovsdb_destroy(db
->db
);
405 open_db(struct server_config
*config
, const char *filename
)
407 struct ovsdb_error
*db_error
;
411 /* If we know that the file is already open, return a good error message.
412 * Otherwise, if the file is open, we'll fail later on with a harder to
413 * interpret file locking error. */
414 if (is_already_open(config
, filename
)) {
415 return xasprintf("%s: already open", filename
);
418 db
= xzalloc(sizeof *db
);
419 db
->filename
= xstrdup(filename
);
421 db_error
= ovsdb_file_open(db
->filename
, false, &db
->db
, &db
->file
);
423 error
= ovsdb_error_to_string(db_error
);
424 } else if (!ovsdb_jsonrpc_server_add_db(config
->jsonrpc
, db
->db
)) {
425 error
= xasprintf("%s: duplicate database name", db
->db
->schema
->name
);
427 shash_add_assert(config
->all_dbs
, db
->db
->schema
->name
, db
);
431 ovsdb_error_destroy(db_error
);
436 static const struct db
*
437 find_db(const struct shash
*all_dbs
, const char *db_name
)
439 struct shash_node
*node
;
441 SHASH_FOR_EACH(node
, all_dbs
) {
442 struct db
*db
= node
->data
;
443 if (!strcmp(db
->db
->schema
->name
, db_name
)) {
451 static char * OVS_WARN_UNUSED_RESULT
452 parse_db_column__(const struct shash
*all_dbs
,
453 const char *name_
, char *name
,
454 const struct db
**dbp
,
455 const struct ovsdb_table
**tablep
,
456 const struct ovsdb_column
**columnp
)
458 const char *db_name
, *table_name
, *column_name
;
459 const struct ovsdb_column
*column
;
460 const struct ovsdb_table
*table
;
461 const char *tokens
[3];
462 char *save_ptr
= NULL
;
469 strtok_r(name
, ":", &save_ptr
); /* "db:" */
470 tokens
[0] = strtok_r(NULL
, ",", &save_ptr
);
471 tokens
[1] = strtok_r(NULL
, ",", &save_ptr
);
472 tokens
[2] = strtok_r(NULL
, ",", &save_ptr
);
473 if (!tokens
[0] || !tokens
[1] || !tokens
[2]) {
474 return xasprintf("\"%s\": invalid syntax", name_
);
478 table_name
= tokens
[1];
479 column_name
= tokens
[2];
481 db
= find_db(all_dbs
, tokens
[0]);
483 return xasprintf("\"%s\": no database named %s", name_
, db_name
);
486 table
= ovsdb_get_table(db
->db
, table_name
);
488 return xasprintf("\"%s\": no table named %s", name_
, table_name
);
491 column
= ovsdb_table_schema_get_column(table
->schema
, column_name
);
493 return xasprintf("\"%s\": table \"%s\" has no column \"%s\"",
494 name_
, table_name
, column_name
);
503 /* Returns NULL if successful, otherwise a malloc()'d string describing the
505 static char * OVS_WARN_UNUSED_RESULT
506 parse_db_column(const struct shash
*all_dbs
,
508 const struct db
**dbp
,
509 const struct ovsdb_table
**tablep
,
510 const struct ovsdb_column
**columnp
)
512 char *name
= xstrdup(name_
);
513 char *retval
= parse_db_column__(all_dbs
, name_
, name
,
514 dbp
, tablep
, columnp
);
519 /* Returns NULL if successful, otherwise a malloc()'d string describing the
521 static char * OVS_WARN_UNUSED_RESULT
522 parse_db_string_column(const struct shash
*all_dbs
,
524 const struct db
**dbp
,
525 const struct ovsdb_table
**tablep
,
526 const struct ovsdb_column
**columnp
)
530 retval
= parse_db_column(all_dbs
, name
, dbp
, tablep
, columnp
);
535 if ((*columnp
)->type
.key
.type
!= OVSDB_TYPE_STRING
536 || (*columnp
)->type
.value
.type
!= OVSDB_TYPE_VOID
) {
537 return xasprintf("\"%s\": table \"%s\" column \"%s\" is "
538 "not string or set of strings",
539 name
, (*tablep
)->schema
->name
, (*columnp
)->name
);
546 query_db_string(const struct shash
*all_dbs
, const char *name
,
549 if (!name
|| strncmp(name
, "db:", 3)) {
552 const struct ovsdb_column
*column
;
553 const struct ovsdb_table
*table
;
554 const struct ovsdb_row
*row
;
558 retval
= parse_db_string_column(all_dbs
, name
,
559 &db
, &table
, &column
);
561 ds_put_format(errors
, "%s\n", retval
);
566 HMAP_FOR_EACH (row
, hmap_node
, &table
->rows
) {
567 const struct ovsdb_datum
*datum
;
570 datum
= &row
->fields
[column
->index
];
571 for (i
= 0; i
< datum
->n
; i
++) {
572 if (datum
->keys
[i
].string
[0]) {
573 return datum
->keys
[i
].string
;
581 static struct ovsdb_jsonrpc_options
*
582 add_remote(struct shash
*remotes
, const char *target
)
584 struct ovsdb_jsonrpc_options
*options
;
586 options
= shash_find_data(remotes
, target
);
588 options
= ovsdb_jsonrpc_default_options(target
);
589 shash_add(remotes
, target
, options
);
595 static struct ovsdb_datum
*
596 get_datum(struct ovsdb_row
*row
, const char *column_name
,
597 const enum ovsdb_atomic_type key_type
,
598 const enum ovsdb_atomic_type value_type
,
601 static struct vlog_rate_limit rl
= VLOG_RATE_LIMIT_INIT(1, 1);
602 const struct ovsdb_table_schema
*schema
= row
->table
->schema
;
603 const struct ovsdb_column
*column
;
605 column
= ovsdb_table_schema_get_column(schema
, column_name
);
607 VLOG_DBG_RL(&rl
, "Table `%s' has no `%s' column",
608 schema
->name
, column_name
);
612 if (column
->type
.key
.type
!= key_type
613 || column
->type
.value
.type
!= value_type
614 || column
->type
.n_max
!= n_max
) {
615 if (!VLOG_DROP_DBG(&rl
)) {
616 char *type_name
= ovsdb_type_to_english(&column
->type
);
617 VLOG_DBG("Table `%s' column `%s' has type %s, not expected "
618 "key type %s, value type %s, max elements %"PRIuSIZE
".",
619 schema
->name
, column_name
, type_name
,
620 ovsdb_atomic_type_to_string(key_type
),
621 ovsdb_atomic_type_to_string(value_type
),
628 return &row
->fields
[column
->index
];
631 /* Read string-string key-values from a map. Returns the value associated with
632 * 'key', if found, or NULL */
634 read_map_string_column(const struct ovsdb_row
*row
, const char *column_name
,
637 const struct ovsdb_datum
*datum
;
638 union ovsdb_atom
*atom_key
= NULL
, *atom_value
= NULL
;
641 datum
= get_datum(CONST_CAST(struct ovsdb_row
*, row
), column_name
,
642 OVSDB_TYPE_STRING
, OVSDB_TYPE_STRING
, UINT_MAX
);
648 for (i
= 0; i
< datum
->n
; i
++) {
649 atom_key
= &datum
->keys
[i
];
650 if (!strcmp(atom_key
->string
, key
)){
651 atom_value
= &datum
->values
[i
];
656 return atom_value
? atom_value
->string
: NULL
;
659 static const union ovsdb_atom
*
660 read_column(const struct ovsdb_row
*row
, const char *column_name
,
661 enum ovsdb_atomic_type type
)
663 const struct ovsdb_datum
*datum
;
665 datum
= get_datum(CONST_CAST(struct ovsdb_row
*, row
), column_name
, type
,
667 return datum
&& datum
->n
? datum
->keys
: NULL
;
671 read_integer_column(const struct ovsdb_row
*row
, const char *column_name
,
672 long long int *integerp
)
674 const union ovsdb_atom
*atom
;
676 atom
= read_column(row
, column_name
, OVSDB_TYPE_INTEGER
);
677 *integerp
= atom
? atom
->integer
: 0;
682 read_string_column(const struct ovsdb_row
*row
, const char *column_name
,
683 const char **stringp
)
685 const union ovsdb_atom
*atom
;
687 atom
= read_column(row
, column_name
, OVSDB_TYPE_STRING
);
688 *stringp
= atom
? atom
->string
: NULL
;
693 write_bool_column(struct ovsdb_row
*row
, const char *column_name
, bool value
)
695 const struct ovsdb_column
*column
;
696 struct ovsdb_datum
*datum
;
698 column
= ovsdb_table_schema_get_column(row
->table
->schema
, column_name
);
699 datum
= get_datum(row
, column_name
, OVSDB_TYPE_BOOLEAN
,
706 ovsdb_datum_destroy(datum
, &column
->type
);
709 datum
->keys
= xmalloc(sizeof *datum
->keys
);
710 datum
->values
= NULL
;
713 datum
->keys
[0].boolean
= value
;
717 write_string_string_column(struct ovsdb_row
*row
, const char *column_name
,
718 char **keys
, char **values
, size_t n
)
720 const struct ovsdb_column
*column
;
721 struct ovsdb_datum
*datum
;
724 column
= ovsdb_table_schema_get_column(row
->table
->schema
, column_name
);
725 datum
= get_datum(row
, column_name
, OVSDB_TYPE_STRING
, OVSDB_TYPE_STRING
,
728 for (i
= 0; i
< n
; i
++) {
735 /* Free existing data. */
736 ovsdb_datum_destroy(datum
, &column
->type
);
738 /* Allocate space for new values. */
740 datum
->keys
= xmalloc(n
* sizeof *datum
->keys
);
741 datum
->values
= xmalloc(n
* sizeof *datum
->values
);
743 for (i
= 0; i
< n
; ++i
) {
744 datum
->keys
[i
].string
= keys
[i
];
745 datum
->values
[i
].string
= values
[i
];
748 /* Sort and check constraints. */
749 ovsdb_datum_sort_assert(datum
, column
->type
.key
.type
);
752 /* Adds a remote and options to 'remotes', based on the Manager table row in
755 add_manager_options(struct shash
*remotes
, const struct ovsdb_row
*row
)
757 static struct vlog_rate_limit rl
= VLOG_RATE_LIMIT_INIT(1, 1);
758 struct ovsdb_jsonrpc_options
*options
;
759 long long int max_backoff
, probe_interval
;
760 const char *target
, *dscp_string
;
762 if (!read_string_column(row
, "target", &target
) || !target
) {
763 VLOG_INFO_RL(&rl
, "Table `%s' has missing or invalid `target' column",
764 row
->table
->schema
->name
);
768 options
= add_remote(remotes
, target
);
769 if (read_integer_column(row
, "max_backoff", &max_backoff
)) {
770 options
->max_backoff
= max_backoff
;
772 if (read_integer_column(row
, "inactivity_probe", &probe_interval
)) {
773 options
->probe_interval
= probe_interval
;
776 options
->dscp
= DSCP_DEFAULT
;
777 dscp_string
= read_map_string_column(row
, "other_config", "dscp");
779 int dscp
= atoi(dscp_string
);
780 if (dscp
>= 0 && dscp
<= 63) {
781 options
->dscp
= dscp
;
787 query_db_remotes(const char *name
, const struct shash
*all_dbs
,
788 struct shash
*remotes
, struct ds
*errors
)
790 const struct ovsdb_column
*column
;
791 const struct ovsdb_table
*table
;
792 const struct ovsdb_row
*row
;
796 retval
= parse_db_column(all_dbs
, name
, &db
, &table
, &column
);
798 ds_put_format(errors
, "%s\n", retval
);
803 if (column
->type
.key
.type
== OVSDB_TYPE_STRING
804 && column
->type
.value
.type
== OVSDB_TYPE_VOID
) {
805 HMAP_FOR_EACH (row
, hmap_node
, &table
->rows
) {
806 const struct ovsdb_datum
*datum
;
809 datum
= &row
->fields
[column
->index
];
810 for (i
= 0; i
< datum
->n
; i
++) {
811 add_remote(remotes
, datum
->keys
[i
].string
);
814 } else if (column
->type
.key
.type
== OVSDB_TYPE_UUID
815 && column
->type
.key
.u
.uuid
.refTable
816 && column
->type
.value
.type
== OVSDB_TYPE_VOID
) {
817 const struct ovsdb_table
*ref_table
= column
->type
.key
.u
.uuid
.refTable
;
818 HMAP_FOR_EACH (row
, hmap_node
, &table
->rows
) {
819 const struct ovsdb_datum
*datum
;
822 datum
= &row
->fields
[column
->index
];
823 for (i
= 0; i
< datum
->n
; i
++) {
824 const struct ovsdb_row
*ref_row
;
826 ref_row
= ovsdb_table_get_row(ref_table
, &datum
->keys
[i
].uuid
);
828 add_manager_options(remotes
, ref_row
);
836 update_remote_row(const struct ovsdb_row
*row
, struct ovsdb_txn
*txn
,
837 const struct ovsdb_jsonrpc_server
*jsonrpc
)
839 struct ovsdb_jsonrpc_remote_status status
;
840 struct ovsdb_row
*rw_row
;
842 char *keys
[9], *values
[9];
845 /* Get the "target" (protocol/host/port) spec. */
846 if (!read_string_column(row
, "target", &target
)) {
847 /* Bad remote spec or incorrect schema. */
850 rw_row
= ovsdb_txn_row_modify(txn
, row
);
851 ovsdb_jsonrpc_server_get_remote_status(jsonrpc
, target
, &status
);
853 /* Update status information columns. */
854 write_bool_column(rw_row
, "is_connected", status
.is_connected
);
857 keys
[n
] = xstrdup("state");
858 values
[n
++] = xstrdup(status
.state
);
860 if (status
.sec_since_connect
!= UINT_MAX
) {
861 keys
[n
] = xstrdup("sec_since_connect");
862 values
[n
++] = xasprintf("%u", status
.sec_since_connect
);
864 if (status
.sec_since_disconnect
!= UINT_MAX
) {
865 keys
[n
] = xstrdup("sec_since_disconnect");
866 values
[n
++] = xasprintf("%u", status
.sec_since_disconnect
);
868 if (status
.last_error
) {
869 keys
[n
] = xstrdup("last_error");
871 xstrdup(ovs_retval_to_string(status
.last_error
));
873 if (status
.locks_held
&& status
.locks_held
[0]) {
874 keys
[n
] = xstrdup("locks_held");
875 values
[n
++] = xstrdup(status
.locks_held
);
877 if (status
.locks_waiting
&& status
.locks_waiting
[0]) {
878 keys
[n
] = xstrdup("locks_waiting");
879 values
[n
++] = xstrdup(status
.locks_waiting
);
881 if (status
.locks_lost
&& status
.locks_lost
[0]) {
882 keys
[n
] = xstrdup("locks_lost");
883 values
[n
++] = xstrdup(status
.locks_lost
);
885 if (status
.n_connections
> 1) {
886 keys
[n
] = xstrdup("n_connections");
887 values
[n
++] = xasprintf("%d", status
.n_connections
);
889 if (status
.bound_port
!= htons(0)) {
890 keys
[n
] = xstrdup("bound_port");
891 values
[n
++] = xasprintf("%"PRIu16
, ntohs(status
.bound_port
));
893 write_string_string_column(rw_row
, "status", keys
, values
, n
);
895 ovsdb_jsonrpc_server_free_remote_status(&status
);
899 update_remote_rows(const struct shash
*all_dbs
,
900 const char *remote_name
,
901 const struct ovsdb_jsonrpc_server
*jsonrpc
)
903 const struct ovsdb_table
*table
, *ref_table
;
904 const struct ovsdb_column
*column
;
905 const struct ovsdb_row
*row
;
909 if (strncmp("db:", remote_name
, 3)) {
913 retval
= parse_db_column(all_dbs
, remote_name
, &db
, &table
, &column
);
919 if (column
->type
.key
.type
!= OVSDB_TYPE_UUID
920 || !column
->type
.key
.u
.uuid
.refTable
921 || column
->type
.value
.type
!= OVSDB_TYPE_VOID
) {
925 ref_table
= column
->type
.key
.u
.uuid
.refTable
;
927 HMAP_FOR_EACH (row
, hmap_node
, &table
->rows
) {
928 const struct ovsdb_datum
*datum
;
931 datum
= &row
->fields
[column
->index
];
932 for (i
= 0; i
< datum
->n
; i
++) {
933 const struct ovsdb_row
*ref_row
;
935 ref_row
= ovsdb_table_get_row(ref_table
, &datum
->keys
[i
].uuid
);
937 update_remote_row(ref_row
, db
->txn
, jsonrpc
);
944 update_remote_status(const struct ovsdb_jsonrpc_server
*jsonrpc
,
945 const struct sset
*remotes
,
946 struct shash
*all_dbs
)
948 static struct vlog_rate_limit rl
= VLOG_RATE_LIMIT_INIT(1, 1);
951 struct shash_node
*node
;
953 SHASH_FOR_EACH(node
, all_dbs
) {
955 db
->txn
= ovsdb_txn_create(db
->db
);
958 /* Iterate over --remote arguments given on command line. */
959 SSET_FOR_EACH (remote
, remotes
) {
960 update_remote_rows(all_dbs
, remote
, jsonrpc
);
963 SHASH_FOR_EACH(node
, all_dbs
) {
964 struct ovsdb_error
*error
;
966 error
= ovsdb_txn_commit(db
->txn
, false);
968 VLOG_ERR_RL(&rl
, "Failed to update remote status: %s",
969 ovsdb_error_to_string(error
));
970 ovsdb_error_destroy(error
);
975 /* Reconfigures ovsdb-server's remotes based on information in the database. */
977 reconfigure_remotes(struct ovsdb_jsonrpc_server
*jsonrpc
,
978 const struct shash
*all_dbs
, struct sset
*remotes
)
980 struct ds errors
= DS_EMPTY_INITIALIZER
;
981 struct shash resolved_remotes
;
984 /* Configure remotes. */
985 shash_init(&resolved_remotes
);
986 SSET_FOR_EACH (name
, remotes
) {
987 if (!strncmp(name
, "db:", 3)) {
988 query_db_remotes(name
, all_dbs
, &resolved_remotes
, &errors
);
990 add_remote(&resolved_remotes
, name
);
993 ovsdb_jsonrpc_server_set_remotes(jsonrpc
, &resolved_remotes
);
994 shash_destroy_free_data(&resolved_remotes
);
996 return errors
.string
;
1000 reconfigure_ssl(const struct shash
*all_dbs
)
1002 struct ds errors
= DS_EMPTY_INITIALIZER
;
1003 const char *resolved_private_key
;
1004 const char *resolved_certificate
;
1005 const char *resolved_ca_cert
;
1007 resolved_private_key
= query_db_string(all_dbs
, private_key_file
, &errors
);
1008 resolved_certificate
= query_db_string(all_dbs
, certificate_file
, &errors
);
1009 resolved_ca_cert
= query_db_string(all_dbs
, ca_cert_file
, &errors
);
1011 stream_ssl_set_key_and_cert(resolved_private_key
, resolved_certificate
);
1012 stream_ssl_set_ca_cert_file(resolved_ca_cert
, bootstrap_ca_cert
);
1014 return errors
.string
;
1018 report_error_if_changed(char *error
, char **last_errorp
)
1021 if (!*last_errorp
|| strcmp(error
, *last_errorp
)) {
1022 VLOG_WARN("%s", error
);
1024 *last_errorp
= error
;
1030 *last_errorp
= NULL
;
1035 ovsdb_server_exit(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
1036 const char *argv
[] OVS_UNUSED
,
1039 bool *exiting
= exiting_
;
1041 unixctl_command_reply(conn
, NULL
);
1045 ovsdb_server_perf_counters_show(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
1046 const char *argv
[] OVS_UNUSED
,
1047 void *arg_ OVS_UNUSED
)
1049 char *s
= perf_counters_to_string();
1051 unixctl_command_reply(conn
, s
);
1056 ovsdb_server_perf_counters_clear(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
1057 const char *argv
[] OVS_UNUSED
,
1058 void *arg_ OVS_UNUSED
)
1060 perf_counters_clear();
1061 unixctl_command_reply(conn
, NULL
);
1064 /* "ovsdb-server/disable-monitor2": makes ovsdb-server drop all of its
1065 * JSON-RPC connections and reconnect. New sessions will not recognize
1066 * the 'monitor2' method. */
1068 ovsdb_server_disable_monitor2(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
1069 const char *argv
[] OVS_UNUSED
, void *jsonrpc_
)
1071 struct ovsdb_jsonrpc_server
*jsonrpc
= jsonrpc_
;
1073 ovsdb_jsonrpc_disable_monitor2();
1074 ovsdb_jsonrpc_server_reconnect(jsonrpc
);
1075 unixctl_command_reply(conn
, NULL
);
1079 ovsdb_server_compact(struct unixctl_conn
*conn
, int argc
,
1080 const char *argv
[], void *dbs_
)
1082 struct shash
*all_dbs
= dbs_
;
1085 struct shash_node
*node
;
1089 SHASH_FOR_EACH(node
, all_dbs
) {
1093 name
= db
->db
->schema
->name
;
1095 if (argc
< 2 || !strcmp(argv
[1], name
)) {
1096 struct ovsdb_error
*error
;
1098 VLOG_INFO("compacting %s database by user request", name
);
1100 error
= ovsdb_file_compact(db
->file
);
1102 char *s
= ovsdb_error_to_string(error
);
1103 ds_put_format(&reply
, "%s\n", s
);
1105 ovsdb_error_destroy(error
);
1113 unixctl_command_reply_error(conn
, "no database by that name");
1114 } else if (reply
.length
) {
1115 unixctl_command_reply_error(conn
, ds_cstr(&reply
));
1117 unixctl_command_reply(conn
, NULL
);
1122 /* "ovsdb-server/reconnect": makes ovsdb-server drop all of its JSON-RPC
1123 * connections and reconnect. */
1125 ovsdb_server_reconnect(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
1126 const char *argv
[] OVS_UNUSED
, void *jsonrpc_
)
1128 struct ovsdb_jsonrpc_server
*jsonrpc
= jsonrpc_
;
1130 ovsdb_jsonrpc_server_reconnect(jsonrpc
);
1131 unixctl_command_reply(conn
, NULL
);
1134 /* "ovsdb-server/add-remote REMOTE": adds REMOTE to the set of remotes that
1135 * ovsdb-server services. */
1137 ovsdb_server_add_remote(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
1138 const char *argv
[], void *config_
)
1140 struct server_config
*config
= config_
;
1141 const char *remote
= argv
[1];
1143 const struct ovsdb_column
*column
;
1144 const struct ovsdb_table
*table
;
1145 const struct db
*db
;
1148 retval
= (strncmp("db:", remote
, 3)
1150 : parse_db_column(config
->all_dbs
, remote
,
1151 &db
, &table
, &column
));
1153 if (sset_add(config
->remotes
, remote
)) {
1154 save_config(config
);
1156 unixctl_command_reply(conn
, NULL
);
1158 unixctl_command_reply_error(conn
, retval
);
1163 /* "ovsdb-server/remove-remote REMOTE": removes REMOTE frmo the set of remotes
1164 * that ovsdb-server services. */
1166 ovsdb_server_remove_remote(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
1167 const char *argv
[], void *config_
)
1169 struct server_config
*config
= config_
;
1170 struct sset_node
*node
;
1172 node
= sset_find(config
->remotes
, argv
[1]);
1174 sset_delete(config
->remotes
, node
);
1175 save_config(config
);
1176 unixctl_command_reply(conn
, NULL
);
1178 unixctl_command_reply_error(conn
, "no such remote");
1182 /* "ovsdb-server/list-remotes": outputs a list of configured rmeotes. */
1184 ovsdb_server_list_remotes(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
1185 const char *argv
[] OVS_UNUSED
, void *remotes_
)
1187 struct sset
*remotes
= remotes_
;
1188 const char **list
, **p
;
1193 list
= sset_sort(remotes
);
1194 for (p
= list
; *p
; p
++) {
1195 ds_put_format(&s
, "%s\n", *p
);
1199 unixctl_command_reply(conn
, ds_cstr(&s
));
1204 /* "ovsdb-server/add-db DB": adds the DB to ovsdb-server. */
1206 ovsdb_server_add_database(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
1207 const char *argv
[], void *config_
)
1209 struct server_config
*config
= config_
;
1210 const char *filename
= argv
[1];
1213 error
= open_db(config
, filename
);
1215 save_config(config
);
1216 unixctl_command_reply(conn
, NULL
);
1218 unixctl_command_reply_error(conn
, error
);
1224 ovsdb_server_remove_database(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
1225 const char *argv
[], void *config_
)
1227 struct server_config
*config
= config_
;
1228 struct shash_node
*node
;
1232 node
= shash_find(config
->all_dbs
, argv
[1]);
1234 unixctl_command_reply_error(conn
, "Failed to find the database.");
1239 ok
= ovsdb_jsonrpc_server_remove_db(config
->jsonrpc
, db
->db
);
1243 shash_delete(config
->all_dbs
, node
);
1245 save_config(config
);
1246 unixctl_command_reply(conn
, NULL
);
1250 ovsdb_server_list_databases(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
1251 const char *argv
[] OVS_UNUSED
, void *all_dbs_
)
1253 struct shash
*all_dbs
= all_dbs_
;
1254 const struct shash_node
**nodes
;
1260 nodes
= shash_sort(all_dbs
);
1261 for (i
= 0; i
< shash_count(all_dbs
); i
++) {
1262 struct db
*db
= nodes
[i
]->data
;
1263 ds_put_format(&s
, "%s\n", db
->db
->schema
->name
);
1267 unixctl_command_reply(conn
, ds_cstr(&s
));
1272 parse_options(int *argcp
, char **argvp
[],
1273 struct sset
*remotes
, char **unixctl_pathp
, char **run_command
)
1276 OPT_REMOTE
= UCHAR_MAX
+ 1,
1279 OPT_BOOTSTRAP_CA_CERT
,
1284 static const struct option long_options
[] = {
1285 {"remote", required_argument
, NULL
, OPT_REMOTE
},
1286 {"unixctl", required_argument
, NULL
, OPT_UNIXCTL
},
1288 {"run", required_argument
, NULL
, OPT_RUN
},
1290 {"help", no_argument
, NULL
, 'h'},
1291 {"version", no_argument
, NULL
, 'V'},
1292 DAEMON_LONG_OPTIONS
,
1294 {"bootstrap-ca-cert", required_argument
, NULL
, OPT_BOOTSTRAP_CA_CERT
},
1295 {"peer-ca-cert", required_argument
, NULL
, OPT_PEER_CA_CERT
},
1296 {"private-key", required_argument
, NULL
, 'p'},
1297 {"certificate", required_argument
, NULL
, 'c'},
1298 {"ca-cert", required_argument
, NULL
, 'C'},
1301 char *short_options
= ovs_cmdl_long_options_to_short_options(long_options
);
1303 char **argv
= *argvp
;
1309 c
= getopt_long(argc
, argv
, short_options
, long_options
, NULL
);
1316 sset_add(remotes
, optarg
);
1320 *unixctl_pathp
= optarg
;
1324 *run_command
= optarg
;
1331 ovs_print_version(0, 0);
1334 VLOG_OPTION_HANDLERS
1335 DAEMON_OPTION_HANDLERS
1338 private_key_file
= optarg
;
1342 certificate_file
= optarg
;
1346 ca_cert_file
= optarg
;
1347 bootstrap_ca_cert
= false;
1350 case OPT_BOOTSTRAP_CA_CERT
:
1351 ca_cert_file
= optarg
;
1352 bootstrap_ca_cert
= true;
1355 case OPT_PEER_CA_CERT
:
1356 stream_ssl_set_peer_ca_cert_file(optarg
);
1366 free(short_options
);
1375 printf("%s: Open vSwitch database server\n"
1376 "usage: %s [OPTIONS] [DATABASE...]\n"
1377 "where each DATABASE is a database file in ovsdb format.\n"
1378 "The default DATABASE, if none is given, is\n%s/conf.db.\n",
1379 program_name
, program_name
, ovs_dbdir());
1380 printf("\nJSON-RPC options (may be specified any number of times):\n"
1381 " --remote=REMOTE connect or listen to REMOTE\n");
1382 stream_usage("JSON-RPC", true, true, true);
1385 printf("\nOther options:\n"
1386 " --run COMMAND run COMMAND as subprocess then exit\n"
1387 " --unixctl=SOCKET override default control socket name\n"
1388 " -h, --help display this help message\n"
1389 " -V, --version display version information\n");
1393 static struct json
*
1394 sset_to_json(const struct sset
*sset
)
1399 array
= json_array_create_empty();
1400 SSET_FOR_EACH (s
, sset
) {
1401 json_array_add(array
, json_string_create(s
));
1406 /* Truncates and replaces the contents of 'config_file' by a representation of
1407 * 'remotes' and 'db_filenames'. */
1409 save_config__(FILE *config_file
, const struct sset
*remotes
,
1410 const struct sset
*db_filenames
)
1415 if (ftruncate(fileno(config_file
), 0) == -1) {
1416 VLOG_FATAL("failed to truncate temporary file (%s)",
1417 ovs_strerror(errno
));
1420 obj
= json_object_create();
1421 json_object_put(obj
, "remotes", sset_to_json(remotes
));
1422 json_object_put(obj
, "db_filenames", sset_to_json(db_filenames
));
1423 s
= json_to_string(obj
, 0);
1426 if (fseek(config_file
, 0, SEEK_SET
) != 0
1427 || fputs(s
, config_file
) == EOF
1428 || fflush(config_file
) == EOF
) {
1429 VLOG_FATAL("failed to write temporary file (%s)", ovs_strerror(errno
));
1434 /* Truncates and replaces the contents of 'config_file' by a representation of
1437 save_config(struct server_config
*config
)
1439 struct sset db_filenames
;
1440 struct shash_node
*node
;
1442 sset_init(&db_filenames
);
1443 SHASH_FOR_EACH (node
, config
->all_dbs
) {
1444 struct db
*db
= node
->data
;
1445 sset_add(&db_filenames
, db
->filename
);
1448 save_config__(config
->config_tmpfile
, config
->remotes
, &db_filenames
);
1450 sset_destroy(&db_filenames
);
1454 sset_from_json(struct sset
*sset
, const struct json
*array
)
1460 ovs_assert(array
->type
== JSON_ARRAY
);
1461 for (i
= 0; i
< array
->u
.array
.n
; i
++) {
1462 const struct json
*elem
= array
->u
.array
.elems
[i
];
1463 sset_add(sset
, json_string(elem
));
1467 /* Clears and replaces 'remotes' and 'dbnames' by a configuration read from
1468 * 'config_file', which must have been previously written by save_config(). */
1470 load_config(FILE *config_file
, struct sset
*remotes
, struct sset
*db_filenames
)
1474 if (fseek(config_file
, 0, SEEK_SET
) != 0) {
1475 VLOG_FATAL("seek failed in temporary file (%s)", ovs_strerror(errno
));
1477 json
= json_from_stream(config_file
);
1478 if (json
->type
== JSON_STRING
) {
1479 VLOG_FATAL("reading json failed (%s)", json_string(json
));
1481 ovs_assert(json
->type
== JSON_OBJECT
);
1483 sset_from_json(remotes
, shash_find_data(json_object(json
), "remotes"));
1484 sset_from_json(db_filenames
,
1485 shash_find_data(json_object(json
), "db_filenames"));