ovsdb/ovsdb-server.c

   1 /* Copyright (c) 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
   2  *
   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:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   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.
  14  */
  15
  16 #include <config.h>
  17
  18 #include <errno.h>
  19 #include <getopt.h>
  20 #include <inttypes.h>
  21 #include <signal.h>
  22 #include <unistd.h>
  23
  24 #include "column.h"
  25 #include "command-line.h"
  26 #include "daemon.h"
  27 #include "dirs.h"
  28 #include "dummy.h"
  29 #include "dynamic-string.h"
  30 #include "file.h"
  31 #include "hash.h"
  32 #include "json.h"
  33 #include "jsonrpc.h"
  34 #include "jsonrpc-server.h"
  35 #include "list.h"
  36 #include "memory.h"
  37 #include "ovsdb.h"
  38 #include "ovsdb-data.h"
  39 #include "ovsdb-types.h"
  40 #include "ovsdb-error.h"
  41 #include "poll-loop.h"
  42 #include "process.h"
  43 #include "row.h"
  44 #include "simap.h"
  45 #include "shash.h"
  46 #include "stream-ssl.h"
  47 #include "stream.h"
  48 #include "stress.h"
  49 #include "sset.h"
  50 #include "table.h"
  51 #include "timeval.h"
  52 #include "transaction.h"
  53 #include "trigger.h"
  54 #include "util.h"
  55 #include "unixctl.h"
  56 #include "vlog.h"
  57
  58 VLOG_DEFINE_THIS_MODULE(ovsdb_server);
  59
  60 struct db {
  61     /* Initialized in main(). */
  62     char *filename;
  63     struct ovsdb_file *file;
  64     struct ovsdb *db;
  65
  66     /* Only used by update_remote_status(). */
  67     struct ovsdb_txn *txn;
  68 };
  69
  70 /* SSL configuration. */
  71 static char *private_key_file;
  72 static char *certificate_file;
  73 static char *ca_cert_file;
  74 static bool bootstrap_ca_cert;
  75
  76 static unixctl_cb_func ovsdb_server_exit;
  77 static unixctl_cb_func ovsdb_server_compact;
  78 static unixctl_cb_func ovsdb_server_reconnect;
  79
  80 struct server_config {
  81     struct sset *remotes;
  82     struct shash *all_dbs;
  83     FILE *config_tmpfile;
  84     struct ovsdb_jsonrpc_server *jsonrpc;
  85 };
  86 static unixctl_cb_func ovsdb_server_add_remote;
  87 static unixctl_cb_func ovsdb_server_remove_remote;
  88 static unixctl_cb_func ovsdb_server_list_remotes;
  89
  90 static unixctl_cb_func ovsdb_server_add_database;
  91 static unixctl_cb_func ovsdb_server_remove_database;
  92 static unixctl_cb_func ovsdb_server_list_databases;
  93
  94 static char *open_db(struct server_config *config, const char *filename);
  95
  96 static void parse_options(int *argc, char **argvp[],
  97                           struct sset *remotes, char **unixctl_pathp,
  98                           char **run_command);
  99 static void usage(void) NO_RETURN;
 100
 101 static char *reconfigure_remotes(struct ovsdb_jsonrpc_server *,
 102                                  const struct shash *all_dbs,
 103                                  struct sset *remotes);
 104 static char *reconfigure_ssl(const struct shash *all_dbs);
 105 static void report_error_if_changed(char *error, char **last_errorp);
 106
 107 static void update_remote_status(const struct ovsdb_jsonrpc_server *jsonrpc,
 108                                  const struct sset *remotes,
 109                                  struct shash *all_dbs);
 110
 111 static void save_config__(FILE *config_file, const struct sset *remotes,
 112                           const struct sset *db_filenames);
 113 static void save_config(struct server_config *);
 114 static void load_config(FILE *config_file, struct sset *remotes,
 115                         struct sset *db_filenames);
 116
 117 int
 118 main(int argc, char *argv[])
 119 {
 120     char *unixctl_path = NULL;
 121     char *run_command = NULL;
 122     struct unixctl_server *unixctl;
 123     struct ovsdb_jsonrpc_server *jsonrpc;
 124     struct sset remotes, db_filenames;
 125     const char *db_filename;
 126     struct process *run_process;
 127     bool exiting;
 128     int retval;
 129     long long int status_timer = LLONG_MIN;
 130     FILE *config_tmpfile;
 131     struct server_config server_config;
 132     struct shash all_dbs;
 133     struct shash_node *node;
 134     char *remotes_error, *ssl_error;
 135     char *error;
 136     int i;
 137
 138     proctitle_init(argc, argv);
 139     set_program_name(argv[0]);
 140     stress_init_command();
 141     signal(SIGPIPE, SIG_IGN);
 142     process_init();
 143
 144     parse_options(&argc, &argv, &remotes, &unixctl_path, &run_command);
 145
 146     /* Create and initialize 'config_tmpfile' as a temporary file to hold
 147      * ovsdb-server's most basic configuration, and then save our initial
 148      * configuration to it.  When --monitor is used, this preserves the effects
 149      * of ovs-appctl commands such as ovsdb-server/add-remote (which saves the
 150      * new configuration) across crashes. */
 151     config_tmpfile = tmpfile();
 152     if (!config_tmpfile) {
 153         ovs_fatal(errno, "failed to create temporary file");
 154     }
 155
 156     sset_init(&db_filenames);
 157     if (argc > 0) {
 158         for (i = 0; i < argc; i++) {
 159             sset_add(&db_filenames, argv[i]);
 160          }
 161     } else {
 162         char *default_db = xasprintf("%s/conf.db", ovs_dbdir());
 163         sset_add(&db_filenames, default_db);
 164         free(default_db);
 165     }
 166
 167     server_config.remotes = &remotes;
 168     server_config.config_tmpfile = config_tmpfile;
 169
 170     save_config__(config_tmpfile, &remotes, &db_filenames);
 171
 172     daemonize_start();
 173
 174     /* Load the saved config. */
 175     load_config(config_tmpfile, &remotes, &db_filenames);
 176     jsonrpc = ovsdb_jsonrpc_server_create();
 177
 178     shash_init(&all_dbs);
 179     server_config.all_dbs = &all_dbs;
 180     server_config.jsonrpc = jsonrpc;
 181     SSET_FOR_EACH (db_filename, &db_filenames) {
 182         error = open_db(&server_config, db_filename);
 183         if (error) {
 184             ovs_fatal(0, "%s", error);
 185         }
 186     }
 187
 188     error = reconfigure_remotes(jsonrpc, &all_dbs, &remotes);
 189     if (!error) {
 190         error = reconfigure_ssl(&all_dbs);
 191     }
 192     if (error) {
 193         ovs_fatal(0, "%s", error);
 194     }
 195
 196     retval = unixctl_server_create(unixctl_path, &unixctl);
 197     if (retval) {
 198         exit(EXIT_FAILURE);
 199     }
 200
 201     if (run_command) {
 202         char *run_argv[4];
 203
 204         run_argv[0] = "/bin/sh";
 205         run_argv[1] = "-c";
 206         run_argv[2] = run_command;
 207         run_argv[3] = NULL;
 208
 209         retval = process_start(run_argv, &run_process);
 210         if (retval) {
 211             ovs_fatal(retval, "%s: process failed to start", run_command);
 212         }
 213     } else {
 214         run_process = NULL;
 215     }
 216
 217     daemonize_complete();
 218
 219     if (!run_command) {
 220         /* ovsdb-server is usually a long-running process, in which case it
 221          * makes plenty of sense to log the version, but --run makes
 222          * ovsdb-server more like a command-line tool, so skip it.  */
 223         VLOG_INFO("%s (Open vSwitch) %s", program_name, VERSION);
 224     }
 225
 226     unixctl_command_register("exit", "", 0, 0, ovsdb_server_exit, &exiting);
 227     unixctl_command_register("ovsdb-server/compact", "", 0, 1,
 228                              ovsdb_server_compact, &all_dbs);
 229     unixctl_command_register("ovsdb-server/reconnect", "", 0, 0,
 230                              ovsdb_server_reconnect, jsonrpc);
 231
 232     unixctl_command_register("ovsdb-server/add-remote", "REMOTE", 1, 1,
 233                              ovsdb_server_add_remote, &server_config);
 234     unixctl_command_register("ovsdb-server/remove-remote", "REMOTE", 1, 1,
 235                              ovsdb_server_remove_remote, &server_config);
 236     unixctl_command_register("ovsdb-server/list-remotes", "", 0, 0,
 237                              ovsdb_server_list_remotes, &remotes);
 238
 239     unixctl_command_register("ovsdb-server/add-db", "DB", 1, 1,
 240                              ovsdb_server_add_database, &server_config);
 241     unixctl_command_register("ovsdb-server/remove-db", "DB", 1, 1,
 242                              ovsdb_server_remove_database, &server_config);
 243     unixctl_command_register("ovsdb-server/list-dbs", "", 0, 0,
 244                              ovsdb_server_list_databases, &all_dbs);
 245
 246     exiting = false;
 247     ssl_error = NULL;
 248     remotes_error = NULL;
 249     while (!exiting) {
 250         memory_run();
 251         if (memory_should_report()) {
 252             struct simap usage;
 253
 254             simap_init(&usage);
 255             ovsdb_jsonrpc_server_get_memory_usage(jsonrpc, &usage);
 256             SHASH_FOR_EACH(node, &all_dbs) {
 257                 struct db *db = node->data;
 258                 ovsdb_get_memory_usage(db->db, &usage);
 259             }
 260             memory_report(&usage);
 261             simap_destroy(&usage);
 262         }
 263
 264         /* Run unixctl_server_run() before reconfigure_remotes() because
 265          * ovsdb-server/add-remote and ovsdb-server/remove-remote can change
 266          * the set of remotes that reconfigure_remotes() uses. */
 267         unixctl_server_run(unixctl);
 268
 269         report_error_if_changed(
 270             reconfigure_remotes(jsonrpc, &all_dbs, &remotes),
 271             &remotes_error);
 272         report_error_if_changed(reconfigure_ssl(&all_dbs), &ssl_error);
 273         ovsdb_jsonrpc_server_run(jsonrpc);
 274
 275         SHASH_FOR_EACH(node, &all_dbs) {
 276             struct db *db = node->data;
 277             ovsdb_trigger_run(db->db, time_msec());
 278         }
 279         if (run_process) {
 280             process_run();
 281             if (process_exited(run_process)) {
 282                 exiting = true;
 283             }
 284         }
 285
 286         /* update Manager status(es) every 5 seconds */
 287         if (time_msec() >= status_timer) {
 288             status_timer = time_msec() + 5000;
 289             update_remote_status(jsonrpc, &remotes, &all_dbs);
 290         }
 291
 292         memory_wait();
 293         ovsdb_jsonrpc_server_wait(jsonrpc);
 294         unixctl_server_wait(unixctl);
 295         SHASH_FOR_EACH(node, &all_dbs) {
 296             struct db *db = node->data;
 297             ovsdb_trigger_wait(db->db, time_msec());
 298         }
 299         if (run_process) {
 300             process_wait(run_process);
 301         }
 302         if (exiting) {
 303             poll_immediate_wake();
 304         }
 305         poll_timer_wait_until(status_timer);
 306         poll_block();
 307     }
 308     ovsdb_jsonrpc_server_destroy(jsonrpc);
 309     SHASH_FOR_EACH(node, &all_dbs) {
 310         struct db *db = node->data;
 311         ovsdb_destroy(db->db);
 312     }
 313     sset_destroy(&remotes);
 314     unixctl_server_destroy(unixctl);
 315
 316     if (run_process && process_exited(run_process)) {
 317         int status = process_status(run_process);
 318         if (status) {
 319             ovs_fatal(0, "%s: child exited, %s",
 320                       run_command, process_status_msg(status));
 321         }
 322     }
 323
 324     return 0;
 325 }
 326
 327 static char *
 328 open_db(struct server_config *config, const char *filename)
 329 {
 330     struct ovsdb_error *db_error;
 331     struct db *db;
 332     char *error;
 333
 334     db = xzalloc(sizeof *db);
 335     db->filename = xstrdup(filename);
 336
 337     db_error = ovsdb_file_open(db->filename, false, &db->db, &db->file);
 338     if (db_error) {
 339         error = ovsdb_error_to_string(db_error);
 340     } else if (!ovsdb_jsonrpc_server_add_db(config->jsonrpc, db->db)) {
 341         error = xasprintf("%s: duplicate database name", db->db->schema->name);
 342     } else {
 343         shash_add_assert(config->all_dbs, db->db->schema->name, db);
 344         return NULL;
 345     }
 346
 347     ovsdb_error_destroy(db_error);
 348     ovsdb_destroy(db->db);
 349     free(db->filename);
 350     free(db);
 351     return error;
 352 }
 353
 354 static const struct db *
 355 find_db(const struct shash *all_dbs, const char *db_name)
 356 {
 357     struct shash_node *node;
 358
 359     SHASH_FOR_EACH(node, all_dbs) {
 360         struct db *db = node->data;
 361         if (!strcmp(db->db->schema->name, db_name)) {
 362             return db;
 363         }
 364     }
 365
 366     return NULL;
 367 }
 368
 369 static char * WARN_UNUSED_RESULT
 370 parse_db_column__(const struct shash *all_dbs,
 371                   const char *name_, char *name,
 372                   const struct db **dbp,
 373                   const struct ovsdb_table **tablep,
 374                   const struct ovsdb_column **columnp)
 375 {
 376     const char *db_name, *table_name, *column_name;
 377     const struct ovsdb_column *column;
 378     const struct ovsdb_table *table;
 379     const char *tokens[3];
 380     char *save_ptr = NULL;
 381     const struct db *db;
 382
 383     *dbp = NULL;
 384     *tablep = NULL;
 385     *columnp = NULL;
 386
 387     strtok_r(name, ":", &save_ptr); /* "db:" */
 388     tokens[0] = strtok_r(NULL, ",", &save_ptr);
 389     tokens[1] = strtok_r(NULL, ",", &save_ptr);
 390     tokens[2] = strtok_r(NULL, ",", &save_ptr);
 391     if (!tokens[0] || !tokens[1] || !tokens[2]) {
 392         return xasprintf("\"%s\": invalid syntax", name_);
 393     }
 394
 395     db_name = tokens[0];
 396     table_name = tokens[1];
 397     column_name = tokens[2];
 398
 399     db = find_db(all_dbs, tokens[0]);
 400     if (!db) {
 401         return xasprintf("\"%s\": no database named %s", name_, db_name);
 402     }
 403
 404     table = ovsdb_get_table(db->db, table_name);
 405     if (!table) {
 406         return xasprintf("\"%s\": no table named %s", name_, table_name);
 407     }
 408
 409     column = ovsdb_table_schema_get_column(table->schema, column_name);
 410     if (!column) {
 411         return xasprintf("\"%s\": table \"%s\" has no column \"%s\"",
 412                          name_, table_name, column_name);
 413     }
 414
 415     *dbp = db;
 416     *columnp = column;
 417     *tablep = table;
 418     return NULL;
 419 }
 420
 421 /* Returns NULL if successful, otherwise a malloc()'d string describing the
 422  * error. */
 423 static char * WARN_UNUSED_RESULT
 424 parse_db_column(const struct shash *all_dbs,
 425                 const char *name_,
 426                 const struct db **dbp,
 427                 const struct ovsdb_table **tablep,
 428                 const struct ovsdb_column **columnp)
 429 {
 430     char *name = xstrdup(name_);
 431     char *retval = parse_db_column__(all_dbs, name_, name,
 432                                      dbp, tablep, columnp);
 433     free(name);
 434     return retval;
 435 }
 436
 437 /* Returns NULL if successful, otherwise a malloc()'d string describing the
 438  * error. */
 439 static char * WARN_UNUSED_RESULT
 440 parse_db_string_column(const struct shash *all_dbs,
 441                        const char *name,
 442                        const struct db **dbp,
 443                        const struct ovsdb_table **tablep,
 444                        const struct ovsdb_column **columnp)
 445 {
 446     char *retval;
 447
 448     retval = parse_db_column(all_dbs, name, dbp, tablep, columnp);
 449     if (retval) {
 450         return retval;
 451     }
 452
 453     if ((*columnp)->type.key.type != OVSDB_TYPE_STRING
 454         || (*columnp)->type.value.type != OVSDB_TYPE_VOID) {
 455         return xasprintf("\"%s\": table \"%s\" column \"%s\" is "
 456                          "not string or set of strings",
 457                          name, (*tablep)->schema->name, (*columnp)->name);
 458     }
 459
 460     return NULL;
 461 }
 462
 463 static const char *
 464 query_db_string(const struct shash *all_dbs, const char *name,
 465                 struct ds *errors)
 466 {
 467     if (!name || strncmp(name, "db:", 3)) {
 468         return name;
 469     } else {
 470         const struct ovsdb_column *column;
 471         const struct ovsdb_table *table;
 472         const struct ovsdb_row *row;
 473         const struct db *db;
 474         char *retval;
 475
 476         retval = parse_db_string_column(all_dbs, name,
 477                                         &db, &table, &column);
 478         if (retval) {
 479             ds_put_format(errors, "%s\n", retval);
 480             return NULL;
 481         }
 482
 483         HMAP_FOR_EACH (row, hmap_node, &table->rows) {
 484             const struct ovsdb_datum *datum;
 485             size_t i;
 486
 487             datum = &row->fields[column->index];
 488             for (i = 0; i < datum->n; i++) {
 489                 if (datum->keys[i].string[0]) {
 490                     return datum->keys[i].string;
 491                 }
 492             }
 493         }
 494         return NULL;
 495     }
 496 }
 497
 498 static struct ovsdb_jsonrpc_options *
 499 add_remote(struct shash *remotes, const char *target)
 500 {
 501     struct ovsdb_jsonrpc_options *options;
 502
 503     options = shash_find_data(remotes, target);
 504     if (!options) {
 505         options = ovsdb_jsonrpc_default_options(target);
 506         shash_add(remotes, target, options);
 507     }
 508
 509     return options;
 510 }
 511
 512 static struct ovsdb_datum *
 513 get_datum(struct ovsdb_row *row, const char *column_name,
 514           const enum ovsdb_atomic_type key_type,
 515           const enum ovsdb_atomic_type value_type,
 516           const size_t n_max)
 517 {
 518     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
 519     const struct ovsdb_table_schema *schema = row->table->schema;
 520     const struct ovsdb_column *column;
 521
 522     column = ovsdb_table_schema_get_column(schema, column_name);
 523     if (!column) {
 524         VLOG_DBG_RL(&rl, "Table `%s' has no `%s' column",
 525                     schema->name, column_name);
 526         return NULL;
 527     }
 528
 529     if (column->type.key.type != key_type
 530         || column->type.value.type != value_type
 531         || column->type.n_max != n_max) {
 532         if (!VLOG_DROP_DBG(&rl)) {
 533             char *type_name = ovsdb_type_to_english(&column->type);
 534             VLOG_DBG("Table `%s' column `%s' has type %s, not expected "
 535                      "key type %s, value type %s, max elements %zd.",
 536                      schema->name, column_name, type_name,
 537                      ovsdb_atomic_type_to_string(key_type),
 538                      ovsdb_atomic_type_to_string(value_type),
 539                      n_max);
 540             free(type_name);
 541         }
 542         return NULL;
 543     }
 544
 545     return &row->fields[column->index];
 546 }
 547
 548 /* Read string-string key-values from a map.  Returns the value associated with
 549  * 'key', if found, or NULL */
 550 static const char *
 551 read_map_string_column(const struct ovsdb_row *row, const char *column_name,
 552                        const char *key)
 553 {
 554     const struct ovsdb_datum *datum;
 555     union ovsdb_atom *atom_key = NULL, *atom_value = NULL;
 556     size_t i;
 557
 558     datum = get_datum(CONST_CAST(struct ovsdb_row *, row), column_name,
 559                       OVSDB_TYPE_STRING, OVSDB_TYPE_STRING, UINT_MAX);
 560
 561     if (!datum) {
 562         return NULL;
 563     }
 564
 565     for (i = 0; i < datum->n; i++) {
 566         atom_key = &datum->keys[i];
 567         if (!strcmp(atom_key->string, key)){
 568             atom_value = &datum->values[i];
 569             break;
 570         }
 571     }
 572
 573     return atom_value ? atom_value->string : NULL;
 574 }
 575
 576 static const union ovsdb_atom *
 577 read_column(const struct ovsdb_row *row, const char *column_name,
 578             enum ovsdb_atomic_type type)
 579 {
 580     const struct ovsdb_datum *datum;
 581
 582     datum = get_datum(CONST_CAST(struct ovsdb_row *, row), column_name, type,
 583                       OVSDB_TYPE_VOID, 1);
 584     return datum && datum->n ? datum->keys : NULL;
 585 }
 586
 587 static bool
 588 read_integer_column(const struct ovsdb_row *row, const char *column_name,
 589                     long long int *integerp)
 590 {
 591     const union ovsdb_atom *atom;
 592
 593     atom = read_column(row, column_name, OVSDB_TYPE_INTEGER);
 594     *integerp = atom ? atom->integer : 0;
 595     return atom != NULL;
 596 }
 597
 598 static bool
 599 read_string_column(const struct ovsdb_row *row, const char *column_name,
 600                    const char **stringp)
 601 {
 602     const union ovsdb_atom *atom;
 603
 604     atom = read_column(row, column_name, OVSDB_TYPE_STRING);
 605     *stringp = atom ? atom->string : NULL;
 606     return atom != NULL;
 607 }
 608
 609 static void
 610 write_bool_column(struct ovsdb_row *row, const char *column_name, bool value)
 611 {
 612     const struct ovsdb_column *column;
 613     struct ovsdb_datum *datum;
 614
 615     column = ovsdb_table_schema_get_column(row->table->schema, column_name);
 616     datum = get_datum(row, column_name, OVSDB_TYPE_BOOLEAN,
 617                       OVSDB_TYPE_VOID, 1);
 618     if (!datum) {
 619         return;
 620     }
 621
 622     if (datum->n != 1) {
 623         ovsdb_datum_destroy(datum, &column->type);
 624
 625         datum->n = 1;
 626         datum->keys = xmalloc(sizeof *datum->keys);
 627         datum->values = NULL;
 628     }
 629
 630     datum->keys[0].boolean = value;
 631 }
 632
 633 static void
 634 write_string_string_column(struct ovsdb_row *row, const char *column_name,
 635                            char **keys, char **values, size_t n)
 636 {
 637     const struct ovsdb_column *column;
 638     struct ovsdb_datum *datum;
 639     size_t i;
 640
 641     column = ovsdb_table_schema_get_column(row->table->schema, column_name);
 642     datum = get_datum(row, column_name, OVSDB_TYPE_STRING, OVSDB_TYPE_STRING,
 643                       UINT_MAX);
 644     if (!datum) {
 645         for (i = 0; i < n; i++) {
 646             free(keys[i]);
 647             free(values[i]);
 648         }
 649         return;
 650     }
 651
 652     /* Free existing data. */
 653     ovsdb_datum_destroy(datum, &column->type);
 654
 655     /* Allocate space for new values. */
 656     datum->n = n;
 657     datum->keys = xmalloc(n * sizeof *datum->keys);
 658     datum->values = xmalloc(n * sizeof *datum->values);
 659
 660     for (i = 0; i < n; ++i) {
 661         datum->keys[i].string = keys[i];
 662         datum->values[i].string = values[i];
 663     }
 664
 665     /* Sort and check constraints. */
 666     ovsdb_datum_sort_assert(datum, column->type.key.type);
 667 }
 668
 669 /* Adds a remote and options to 'remotes', based on the Manager table row in
 670  * 'row'. */
 671 static void
 672 add_manager_options(struct shash *remotes, const struct ovsdb_row *row)
 673 {
 674     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
 675     struct ovsdb_jsonrpc_options *options;
 676     long long int max_backoff, probe_interval;
 677     const char *target, *dscp_string;
 678
 679     if (!read_string_column(row, "target", &target) || !target) {
 680         VLOG_INFO_RL(&rl, "Table `%s' has missing or invalid `target' column",
 681                      row->table->schema->name);
 682         return;
 683     }
 684
 685     options = add_remote(remotes, target);
 686     if (read_integer_column(row, "max_backoff", &max_backoff)) {
 687         options->max_backoff = max_backoff;
 688     }
 689     if (read_integer_column(row, "inactivity_probe", &probe_interval)) {
 690         options->probe_interval = probe_interval;
 691     }
 692
 693     options->dscp = DSCP_DEFAULT;
 694     dscp_string = read_map_string_column(row, "other_config", "dscp");
 695     if (dscp_string) {
 696         int dscp = atoi(dscp_string);
 697         if (dscp >= 0 && dscp <= 63) {
 698             options->dscp = dscp;
 699         }
 700     }
 701 }
 702
 703 static void
 704 query_db_remotes(const char *name, const struct shash *all_dbs,
 705                  struct shash *remotes, struct ds *errors)
 706 {
 707     const struct ovsdb_column *column;
 708     const struct ovsdb_table *table;
 709     const struct ovsdb_row *row;
 710     const struct db *db;
 711     char *retval;
 712
 713     retval = parse_db_column(all_dbs, name, &db, &table, &column);
 714     if (retval) {
 715         ds_put_format(errors, "%s\n", retval);
 716         free(retval);
 717         return;
 718     }
 719
 720     if (column->type.key.type == OVSDB_TYPE_STRING
 721         && column->type.value.type == OVSDB_TYPE_VOID) {
 722         HMAP_FOR_EACH (row, hmap_node, &table->rows) {
 723             const struct ovsdb_datum *datum;
 724             size_t i;
 725
 726             datum = &row->fields[column->index];
 727             for (i = 0; i < datum->n; i++) {
 728                 add_remote(remotes, datum->keys[i].string);
 729             }
 730         }
 731     } else if (column->type.key.type == OVSDB_TYPE_UUID
 732                && column->type.key.u.uuid.refTable
 733                && column->type.value.type == OVSDB_TYPE_VOID) {
 734         const struct ovsdb_table *ref_table = column->type.key.u.uuid.refTable;
 735         HMAP_FOR_EACH (row, hmap_node, &table->rows) {
 736             const struct ovsdb_datum *datum;
 737             size_t i;
 738
 739             datum = &row->fields[column->index];
 740             for (i = 0; i < datum->n; i++) {
 741                 const struct ovsdb_row *ref_row;
 742
 743                 ref_row = ovsdb_table_get_row(ref_table, &datum->keys[i].uuid);
 744                 if (ref_row) {
 745                     add_manager_options(remotes, ref_row);
 746                 }
 747             }
 748         }
 749     }
 750 }
 751
 752 static void
 753 update_remote_row(const struct ovsdb_row *row, struct ovsdb_txn *txn,
 754                   const struct ovsdb_jsonrpc_server *jsonrpc)
 755 {
 756     struct ovsdb_jsonrpc_remote_status status;
 757     struct ovsdb_row *rw_row;
 758     const char *target;
 759     char *keys[9], *values[9];
 760     size_t n = 0;
 761
 762     /* Get the "target" (protocol/host/port) spec. */
 763     if (!read_string_column(row, "target", &target)) {
 764         /* Bad remote spec or incorrect schema. */
 765         return;
 766     }
 767     rw_row = ovsdb_txn_row_modify(txn, row);
 768     ovsdb_jsonrpc_server_get_remote_status(jsonrpc, target, &status);
 769
 770     /* Update status information columns. */
 771     write_bool_column(rw_row, "is_connected", status.is_connected);
 772
 773     if (status.state) {
 774         keys[n] = xstrdup("state");
 775         values[n++] = xstrdup(status.state);
 776     }
 777     if (status.sec_since_connect != UINT_MAX) {
 778         keys[n] = xstrdup("sec_since_connect");
 779         values[n++] = xasprintf("%u", status.sec_since_connect);
 780     }
 781     if (status.sec_since_disconnect != UINT_MAX) {
 782         keys[n] = xstrdup("sec_since_disconnect");
 783         values[n++] = xasprintf("%u", status.sec_since_disconnect);
 784     }
 785     if (status.last_error) {
 786         keys[n] = xstrdup("last_error");
 787         values[n++] =
 788             xstrdup(ovs_retval_to_string(status.last_error));
 789     }
 790     if (status.locks_held && status.locks_held[0]) {
 791         keys[n] = xstrdup("locks_held");
 792         values[n++] = xstrdup(status.locks_held);
 793     }
 794     if (status.locks_waiting && status.locks_waiting[0]) {
 795         keys[n] = xstrdup("locks_waiting");
 796         values[n++] = xstrdup(status.locks_waiting);
 797     }
 798     if (status.locks_lost && status.locks_lost[0]) {
 799         keys[n] = xstrdup("locks_lost");
 800         values[n++] = xstrdup(status.locks_lost);
 801     }
 802     if (status.n_connections > 1) {
 803         keys[n] = xstrdup("n_connections");
 804         values[n++] = xasprintf("%d", status.n_connections);
 805     }
 806     if (status.bound_port != htons(0)) {
 807         keys[n] = xstrdup("bound_port");
 808         values[n++] = xasprintf("%"PRIu16, ntohs(status.bound_port));
 809     }
 810     write_string_string_column(rw_row, "status", keys, values, n);
 811
 812     ovsdb_jsonrpc_server_free_remote_status(&status);
 813 }
 814
 815 static void
 816 update_remote_rows(const struct shash *all_dbs,
 817                    const char *remote_name,
 818                    const struct ovsdb_jsonrpc_server *jsonrpc)
 819 {
 820     const struct ovsdb_table *table, *ref_table;
 821     const struct ovsdb_column *column;
 822     const struct ovsdb_row *row;
 823     const struct db *db;
 824     char *retval;
 825
 826     if (strncmp("db:", remote_name, 3)) {
 827         return;
 828     }
 829
 830     retval = parse_db_column(all_dbs, remote_name, &db, &table, &column);
 831     if (retval) {
 832         free(retval);
 833         return;
 834     }
 835
 836     if (column->type.key.type != OVSDB_TYPE_UUID
 837         || !column->type.key.u.uuid.refTable
 838         || column->type.value.type != OVSDB_TYPE_VOID) {
 839         return;
 840     }
 841
 842     ref_table = column->type.key.u.uuid.refTable;
 843
 844     HMAP_FOR_EACH (row, hmap_node, &table->rows) {
 845         const struct ovsdb_datum *datum;
 846         size_t i;
 847
 848         datum = &row->fields[column->index];
 849         for (i = 0; i < datum->n; i++) {
 850             const struct ovsdb_row *ref_row;
 851
 852             ref_row = ovsdb_table_get_row(ref_table, &datum->keys[i].uuid);
 853             if (ref_row) {
 854                 update_remote_row(ref_row, db->txn, jsonrpc);
 855             }
 856         }
 857     }
 858 }
 859
 860 static void
 861 update_remote_status(const struct ovsdb_jsonrpc_server *jsonrpc,
 862                      const struct sset *remotes,
 863                      struct shash *all_dbs)
 864 {
 865     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
 866     const char *remote;
 867     struct db *db;
 868     struct shash_node *node;
 869
 870     SHASH_FOR_EACH(node, all_dbs) {
 871         db = node->data;
 872         db->txn = ovsdb_txn_create(db->db);
 873     }
 874
 875     /* Iterate over --remote arguments given on command line. */
 876     SSET_FOR_EACH (remote, remotes) {
 877         update_remote_rows(all_dbs, remote, jsonrpc);
 878     }
 879
 880     SHASH_FOR_EACH(node, all_dbs) {
 881         struct ovsdb_error *error;
 882         db = node->data;
 883         error = ovsdb_txn_commit(db->txn, false);
 884         if (error) {
 885             VLOG_ERR_RL(&rl, "Failed to update remote status: %s",
 886                         ovsdb_error_to_string(error));
 887             ovsdb_error_destroy(error);
 888         }
 889     }
 890 }
 891
 892 /* Reconfigures ovsdb-server's remotes based on information in the database. */
 893 static char *
 894 reconfigure_remotes(struct ovsdb_jsonrpc_server *jsonrpc,
 895                     const struct shash *all_dbs, struct sset *remotes)
 896 {
 897     struct ds errors = DS_EMPTY_INITIALIZER;
 898     struct shash resolved_remotes;
 899     const char *name;
 900
 901     /* Configure remotes. */
 902     shash_init(&resolved_remotes);
 903     SSET_FOR_EACH (name, remotes) {
 904         if (!strncmp(name, "db:", 3)) {
 905             query_db_remotes(name, all_dbs, &resolved_remotes, &errors);
 906         } else {
 907             add_remote(&resolved_remotes, name);
 908         }
 909     }
 910     ovsdb_jsonrpc_server_set_remotes(jsonrpc, &resolved_remotes);
 911     shash_destroy_free_data(&resolved_remotes);
 912
 913     return errors.string;
 914 }
 915
 916 static char *
 917 reconfigure_ssl(const struct shash *all_dbs)
 918 {
 919     struct ds errors = DS_EMPTY_INITIALIZER;
 920     const char *resolved_private_key;
 921     const char *resolved_certificate;
 922     const char *resolved_ca_cert;
 923
 924     resolved_private_key = query_db_string(all_dbs, private_key_file, &errors);
 925     resolved_certificate = query_db_string(all_dbs, certificate_file, &errors);
 926     resolved_ca_cert = query_db_string(all_dbs, ca_cert_file, &errors);
 927
 928     stream_ssl_set_key_and_cert(resolved_private_key, resolved_certificate);
 929     stream_ssl_set_ca_cert_file(resolved_ca_cert, bootstrap_ca_cert);
 930
 931     return errors.string;
 932 }
 933
 934 static void
 935 report_error_if_changed(char *error, char **last_errorp)
 936 {
 937     if (error) {
 938         if (!*last_errorp || strcmp(error, *last_errorp)) {
 939             VLOG_WARN("%s", error);
 940             free(*last_errorp);
 941             *last_errorp = error;
 942             return;
 943         }
 944         free(error);
 945     } else {
 946         free(*last_errorp);
 947         *last_errorp = NULL;
 948     }
 949 }
 950
 951 static void
 952 ovsdb_server_exit(struct unixctl_conn *conn, int argc OVS_UNUSED,
 953                   const char *argv[] OVS_UNUSED,
 954                   void *exiting_)
 955 {
 956     bool *exiting = exiting_;
 957     *exiting = true;
 958     unixctl_command_reply(conn, NULL);
 959 }
 960
 961 static void
 962 ovsdb_server_compact(struct unixctl_conn *conn, int argc,
 963                      const char *argv[], void *dbs_)
 964 {
 965     struct shash *all_dbs = dbs_;
 966     struct ds reply;
 967     struct db *db;
 968     struct shash_node *node;
 969     int n = 0;
 970
 971     ds_init(&reply);
 972     SHASH_FOR_EACH(node, all_dbs) {
 973         const char *name;
 974
 975         db = node->data;
 976         name = db->db->schema->name;
 977
 978         if (argc < 2 || !strcmp(argv[1], name)) {
 979             struct ovsdb_error *error;
 980
 981             VLOG_INFO("compacting %s database by user request", name);
 982
 983             error = ovsdb_file_compact(db->file);
 984             if (error) {
 985                 char *s = ovsdb_error_to_string(error);
 986                 ds_put_format(&reply, "%s\n", s);
 987                 free(s);
 988             }
 989
 990             n++;
 991         }
 992     }
 993
 994     if (!n) {
 995         unixctl_command_reply_error(conn, "no database by that name");
 996     } else if (reply.length) {
 997         unixctl_command_reply_error(conn, ds_cstr(&reply));
 998     } else {
 999         unixctl_command_reply(conn, NULL);
1000     }
1001     ds_destroy(&reply);
1002 }
1003
1004 /* "ovsdb-server/reconnect": makes ovsdb-server drop all of its JSON-RPC
1005  * connections and reconnect. */
1006 static void
1007 ovsdb_server_reconnect(struct unixctl_conn *conn, int argc OVS_UNUSED,
1008                        const char *argv[] OVS_UNUSED, void *jsonrpc_)
1009 {
1010     struct ovsdb_jsonrpc_server *jsonrpc = jsonrpc_;
1011
1012     ovsdb_jsonrpc_server_reconnect(jsonrpc);
1013     unixctl_command_reply(conn, NULL);
1014 }
1015
1016 /* "ovsdb-server/add-remote REMOTE": adds REMOTE to the set of remotes that
1017  * ovsdb-server services. */
1018 static void
1019 ovsdb_server_add_remote(struct unixctl_conn *conn, int argc OVS_UNUSED,
1020                         const char *argv[], void *config_)
1021 {
1022     struct server_config *config = config_;
1023     const char *remote = argv[1];
1024
1025     const struct ovsdb_column *column;
1026     const struct ovsdb_table *table;
1027     const struct db *db;
1028     char *retval;
1029
1030     retval = (strncmp("db:", remote, 3)
1031               ? NULL
1032               : parse_db_column(config->all_dbs, remote,
1033                                 &db, &table, &column));
1034     if (!retval) {
1035         if (sset_add(config->remotes, remote)) {
1036             save_config(config);
1037         }
1038         unixctl_command_reply(conn, NULL);
1039     } else {
1040         unixctl_command_reply_error(conn, retval);
1041         free(retval);
1042     }
1043 }
1044
1045 /* "ovsdb-server/remove-remote REMOTE": removes REMOTE frmo the set of remotes
1046  * that ovsdb-server services. */
1047 static void
1048 ovsdb_server_remove_remote(struct unixctl_conn *conn, int argc OVS_UNUSED,
1049                            const char *argv[], void *config_)
1050 {
1051     struct server_config *config = config_;
1052     struct sset_node *node;
1053
1054     node = sset_find(config->remotes, argv[1]);
1055     if (node) {
1056         sset_delete(config->remotes, node);
1057         save_config(config);
1058         unixctl_command_reply(conn, NULL);
1059     } else {
1060         unixctl_command_reply_error(conn, "no such remote");
1061     }
1062 }
1063
1064 /* "ovsdb-server/list-remotes": outputs a list of configured rmeotes. */
1065 static void
1066 ovsdb_server_list_remotes(struct unixctl_conn *conn, int argc OVS_UNUSED,
1067                           const char *argv[] OVS_UNUSED, void *remotes_)
1068 {
1069     struct sset *remotes = remotes_;
1070     const char **list, **p;
1071     struct ds s;
1072
1073     ds_init(&s);
1074
1075     list = sset_sort(remotes);
1076     for (p = list; *p; p++) {
1077         ds_put_format(&s, "%s\n", *p);
1078     }
1079     free(list);
1080
1081     unixctl_command_reply(conn, ds_cstr(&s));
1082     ds_destroy(&s);
1083 }
1084
1085
1086 /* "ovsdb-server/add-db DB": adds the DB to ovsdb-server. */
1087 static void
1088 ovsdb_server_add_database(struct unixctl_conn *conn, int argc OVS_UNUSED,
1089                           const char *argv[], void *config_)
1090 {
1091     struct server_config *config = config_;
1092     const char *filename = argv[1];
1093     char *error;
1094
1095     error = open_db(config, filename);
1096     if (!error) {
1097         save_config(config);
1098         unixctl_command_reply(conn, NULL);
1099     } else {
1100         unixctl_command_reply_error(conn, error);
1101         free(error);
1102     }
1103 }
1104
1105 static void
1106 ovsdb_server_remove_database(struct unixctl_conn *conn, int argc OVS_UNUSED,
1107                              const char *argv[], void *config_)
1108 {
1109     struct server_config *config = config_;
1110     struct shash_node *node;
1111     struct db *db;
1112     bool ok;
1113
1114     node = shash_find(config->all_dbs, argv[1]);
1115     if (!node)  {
1116         unixctl_command_reply_error(conn, "Failed to find the database.");
1117         return;
1118     }
1119     db = node->data;
1120
1121     ok = ovsdb_jsonrpc_server_remove_db(config->jsonrpc, db->db);
1122     ovs_assert(ok);
1123
1124     ovsdb_destroy(db->db);
1125     shash_delete(config->all_dbs, node);
1126     free(db->filename);
1127     free(db);
1128
1129     save_config(config);
1130     unixctl_command_reply(conn, NULL);
1131 }
1132
1133 static void
1134 ovsdb_server_list_databases(struct unixctl_conn *conn, int argc OVS_UNUSED,
1135                             const char *argv[] OVS_UNUSED, void *all_dbs_)
1136 {
1137     struct shash *all_dbs = all_dbs_;
1138     const struct shash_node **nodes;
1139     struct ds s;
1140     size_t i;
1141
1142     ds_init(&s);
1143
1144     nodes = shash_sort(all_dbs);
1145     for (i = 0; i < shash_count(all_dbs); i++) {
1146         struct db *db = nodes[i]->data;
1147         ds_put_format(&s, "%s\n", db->db->schema->name);
1148     }
1149     free(nodes);
1150
1151     unixctl_command_reply(conn, ds_cstr(&s));
1152     ds_destroy(&s);
1153 }
1154
1155 static void
1156 parse_options(int *argcp, char **argvp[],
1157               struct sset *remotes, char **unixctl_pathp, char **run_command)
1158 {
1159     enum {
1160         OPT_REMOTE = UCHAR_MAX + 1,
1161         OPT_UNIXCTL,
1162         OPT_RUN,
1163         OPT_BOOTSTRAP_CA_CERT,
1164         OPT_ENABLE_DUMMY,
1165         VLOG_OPTION_ENUMS,
1166         DAEMON_OPTION_ENUMS
1167     };
1168     static const struct option long_options[] = {
1169         {"remote",      required_argument, NULL, OPT_REMOTE},
1170         {"unixctl",     required_argument, NULL, OPT_UNIXCTL},
1171         {"run",         required_argument, NULL, OPT_RUN},
1172         {"help",        no_argument, NULL, 'h'},
1173         {"version",     no_argument, NULL, 'V'},
1174         DAEMON_LONG_OPTIONS,
1175         VLOG_LONG_OPTIONS,
1176         {"bootstrap-ca-cert", required_argument, NULL, OPT_BOOTSTRAP_CA_CERT},
1177         {"private-key", required_argument, NULL, 'p'},
1178         {"certificate", required_argument, NULL, 'c'},
1179         {"ca-cert",     required_argument, NULL, 'C'},
1180         {"enable-dummy", optional_argument, NULL, OPT_ENABLE_DUMMY},
1181         {NULL, 0, NULL, 0},
1182     };
1183     char *short_options = long_options_to_short_options(long_options);
1184     int argc = *argcp;
1185     char **argv = *argvp;
1186
1187     sset_init(remotes);
1188     for (;;) {
1189         int c;
1190
1191         c = getopt_long(argc, argv, short_options, long_options, NULL);
1192         if (c == -1) {
1193             break;
1194         }
1195
1196         switch (c) {
1197         case OPT_REMOTE:
1198             sset_add(remotes, optarg);
1199             break;
1200
1201         case OPT_UNIXCTL:
1202             *unixctl_pathp = optarg;
1203             break;
1204
1205         case OPT_RUN:
1206             *run_command = optarg;
1207             break;
1208
1209         case 'h':
1210             usage();
1211
1212         case 'V':
1213             ovs_print_version(0, 0);
1214             exit(EXIT_SUCCESS);
1215
1216         VLOG_OPTION_HANDLERS
1217         DAEMON_OPTION_HANDLERS
1218
1219         case 'p':
1220             private_key_file = optarg;
1221             break;
1222
1223         case 'c':
1224             certificate_file = optarg;
1225             break;
1226
1227         case 'C':
1228             ca_cert_file = optarg;
1229             bootstrap_ca_cert = false;
1230             break;
1231
1232         case OPT_BOOTSTRAP_CA_CERT:
1233             ca_cert_file = optarg;
1234             bootstrap_ca_cert = true;
1235             break;
1236
1237         case OPT_ENABLE_DUMMY:
1238             dummy_enable(optarg && !strcmp(optarg, "override"));
1239             break;
1240
1241         case '?':
1242             exit(EXIT_FAILURE);
1243
1244         default:
1245             abort();
1246         }
1247     }
1248     free(short_options);
1249
1250     *argcp -= optind;
1251     *argvp += optind;
1252 }
1253
1254 static void
1255 usage(void)
1256 {
1257     printf("%s: Open vSwitch database server\n"
1258            "usage: %s [OPTIONS] [DATABASE...]\n"
1259            "where each DATABASE is a database file in ovsdb format.\n"
1260            "The default DATABASE, if none is given, is\n%s/conf.db.\n",
1261            program_name, program_name, ovs_dbdir());
1262     printf("\nJSON-RPC options (may be specified any number of times):\n"
1263            "  --remote=REMOTE         connect or listen to REMOTE\n");
1264     stream_usage("JSON-RPC", true, true, true);
1265     daemon_usage();
1266     vlog_usage();
1267     printf("\nOther options:\n"
1268            "  --run COMMAND           run COMMAND as subprocess then exit\n"
1269            "  --unixctl=SOCKET        override default control socket name\n"
1270            "  -h, --help              display this help message\n"
1271            "  -V, --version           display version information\n");
1272     exit(EXIT_SUCCESS);
1273 }
1274 \f
1275 static struct json *
1276 sset_to_json(const struct sset *sset)
1277 {
1278     struct json *array;
1279     const char *s;
1280
1281     array = json_array_create_empty();
1282     SSET_FOR_EACH (s, sset) {
1283         json_array_add(array, json_string_create(s));
1284     }
1285     return array;
1286 }
1287
1288 /* Truncates and replaces the contents of 'config_file' by a representation of
1289  * 'remotes' and 'db_filenames'. */
1290 static void
1291 save_config__(FILE *config_file, const struct sset *remotes,
1292               const struct sset *db_filenames)
1293 {
1294     struct json *obj;
1295     char *s;
1296
1297     if (ftruncate(fileno(config_file), 0) == -1) {
1298         VLOG_FATAL("failed to truncate temporary file (%s)",
1299                    ovs_strerror(errno));
1300     }
1301
1302     obj = json_object_create();
1303     json_object_put(obj, "remotes", sset_to_json(remotes));
1304     json_object_put(obj, "db_filenames", sset_to_json(db_filenames));
1305     s = json_to_string(obj, 0);
1306     json_destroy(obj);
1307
1308     if (fseek(config_file, 0, SEEK_SET) != 0
1309         || fputs(s, config_file) == EOF
1310         || fflush(config_file) == EOF) {
1311         VLOG_FATAL("failed to write temporary file (%s)", ovs_strerror(errno));
1312     }
1313     free(s);
1314 }
1315
1316 /* Truncates and replaces the contents of 'config_file' by a representation of
1317  * 'config'. */
1318 static void
1319 save_config(struct server_config *config)
1320 {
1321     struct sset db_filenames;
1322     struct shash_node *node;
1323
1324     sset_init(&db_filenames);
1325     SHASH_FOR_EACH (node, config->all_dbs) {
1326         struct db *db = node->data;
1327         sset_add(&db_filenames, db->filename);
1328     }
1329
1330     save_config__(config->config_tmpfile, config->remotes, &db_filenames);
1331
1332     sset_destroy(&db_filenames);
1333 }
1334
1335 static void
1336 sset_from_json(struct sset *sset, const struct json *array)
1337 {
1338     size_t i;
1339
1340     sset_clear(sset);
1341
1342     ovs_assert(array->type == JSON_ARRAY);
1343     for (i = 0; i < array->u.array.n; i++) {
1344         const struct json *elem = array->u.array.elems[i];
1345         sset_add(sset, json_string(elem));
1346     }
1347 }
1348
1349 /* Clears and replaces 'remotes' and 'dbnames' by a configuration read from
1350  * 'config_file', which must have been previously written by save_config(). */
1351 static void
1352 load_config(FILE *config_file, struct sset *remotes, struct sset *db_filenames)
1353 {
1354     struct json *json;
1355
1356     if (fseek(config_file, 0, SEEK_SET) != 0) {
1357         VLOG_FATAL("seek failed in temporary file (%s)", ovs_strerror(errno));
1358     }
1359     json = json_from_stream(config_file);
1360     if (json->type == JSON_STRING) {
1361         VLOG_FATAL("reading json failed (%s)", json_string(json));
1362     }
1363     ovs_assert(json->type == JSON_OBJECT);
1364
1365     sset_from_json(remotes, shash_find_data(json_object(json), "remotes"));
1366     sset_from_json(db_filenames,
1367                    shash_find_data(json_object(json), "db_filenames"));
1368     json_destroy(json);
1369 }