utilities/ovs-vsctl.c

   1 /*
   2  * Copyright (c) 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #include <config.h>
  18
  19 #include <ctype.h>
  20 #include <errno.h>
  21 #include <float.h>
  22 #include <getopt.h>
  23 #include <inttypes.h>
  24 #include <signal.h>
  25 #include <stdarg.h>
  26 #include <stdlib.h>
  27 #include <string.h>
  28 #include <unistd.h>
  29
  30 #include "command-line.h"
  31 #include "compiler.h"
  32 #include "dirs.h"
  33 #include "dynamic-string.h"
  34 #include "hash.h"
  35 #include "json.h"
  36 #include "ovsdb-data.h"
  37 #include "ovsdb-idl.h"
  38 #include "poll-loop.h"
  39 #include "process.h"
  40 #include "stream.h"
  41 #include "stream-ssl.h"
  42 #include "smap.h"
  43 #include "sset.h"
  44 #include "svec.h"
  45 #include "lib/vswitch-idl.h"
  46 #include "table.h"
  47 #include "timeval.h"
  48 #include "util.h"
  49 #include "vconn.h"
  50 #include "vlog.h"
  51
  52 VLOG_DEFINE_THIS_MODULE(vsctl);
  53
  54 /* vsctl_fatal() also logs the error, so it is preferred in this file. */
  55 #define ovs_fatal please_use_vsctl_fatal_instead_of_ovs_fatal
  56
  57 struct vsctl_context;
  58
  59 /* A command supported by ovs-vsctl. */
  60 struct vsctl_command_syntax {
  61     const char *name;           /* e.g. "add-br" */
  62     int min_args;               /* Min number of arguments following name. */
  63     int max_args;               /* Max number of arguments following name. */
  64
  65     /* If nonnull, calls ovsdb_idl_add_column() or ovsdb_idl_add_table() for
  66      * each column or table in ctx->idl that it uses. */
  67     void (*prerequisites)(struct vsctl_context *ctx);
  68
  69     /* Does the actual work of the command and puts the command's output, if
  70      * any, in ctx->output or ctx->table.
  71      *
  72      * Alternatively, if some prerequisite of the command is not met and the
  73      * caller should wait for something to change and then retry, it may set
  74      * ctx->try_again to true.  (Only the "wait-until" command currently does
  75      * this.) */
  76     void (*run)(struct vsctl_context *ctx);
  77
  78     /* If nonnull, called after the transaction has been successfully
  79      * committed.  ctx->output is the output from the "run" function, which
  80      * this function may modify and otherwise postprocess as needed.  (Only the
  81      * "create" command currently does any postprocessing.) */
  82     void (*postprocess)(struct vsctl_context *ctx);
  83
  84     /* A comma-separated list of supported options, e.g. "--a,--b", or the
  85      * empty string if the command does not support any options. */
  86     const char *options;
  87     enum { RO, RW } mode;       /* Does this command modify the database? */
  88 };
  89
  90 struct vsctl_command {
  91     /* Data that remains constant after initialization. */
  92     const struct vsctl_command_syntax *syntax;
  93     int argc;
  94     char **argv;
  95     struct shash options;
  96
  97     /* Data modified by commands. */
  98     struct ds output;
  99     struct table *table;
 100 };
 101
 102 /* --db: The database server to contact. */
 103 static const char *db;
 104
 105 /* --oneline: Write each command's output as a single line? */
 106 static bool oneline;
 107
 108 /* --dry-run: Do not commit any changes. */
 109 static bool dry_run;
 110
 111 /* --no-wait: Wait for ovs-vswitchd to reload its configuration? */
 112 static bool wait_for_reload = true;
 113
 114 /* --timeout: Time to wait for a connection to 'db'. */
 115 static int timeout;
 116
 117 /* --retry: If true, ovs-vsctl will retry connecting to the database forever.
 118  * If false and --db says to use an active connection method (e.g. "unix:",
 119  * "tcp:", "ssl:"), then ovs-vsctl will try to connect once and exit with an
 120  * error if the database server cannot be contacted (e.g. ovsdb-server is not
 121  * running).
 122  *
 123  * Regardless of this setting, --timeout always limits how long ovs-vsctl will
 124  * wait. */
 125 static bool retry;
 126
 127 /* Format for table output. */
 128 static struct table_style table_style = TABLE_STYLE_DEFAULT;
 129
 130 /* All supported commands. */
 131 static const struct vsctl_command_syntax all_commands[];
 132
 133 /* The IDL we're using and the current transaction, if any.
 134  * This is for use by vsctl_exit() only, to allow it to clean up.
 135  * Other code should use its context arguments. */
 136 static struct ovsdb_idl *the_idl;
 137 static struct ovsdb_idl_txn *the_idl_txn;
 138
 139 static void vsctl_exit(int status) NO_RETURN;
 140 static void vsctl_fatal(const char *, ...) PRINTF_FORMAT(1, 2) NO_RETURN;
 141 static char *default_db(void);
 142 static void usage(void) NO_RETURN;
 143 static void parse_options(int argc, char *argv[], struct shash *local_options);
 144 static bool might_write_to_db(char **argv);
 145
 146 static struct vsctl_command *parse_commands(int argc, char *argv[],
 147                                             struct shash *local_options,
 148                                             size_t *n_commandsp);
 149 static void parse_command(int argc, char *argv[], struct shash *local_options,
 150                           struct vsctl_command *);
 151 static const struct vsctl_command_syntax *find_command(const char *name);
 152 static void run_prerequisites(struct vsctl_command[], size_t n_commands,
 153                               struct ovsdb_idl *);
 154 static void do_vsctl(const char *args, struct vsctl_command *, size_t n,
 155                      struct ovsdb_idl *);
 156
 157 static const struct vsctl_table_class *get_table(const char *table_name);
 158 static void set_column(const struct vsctl_table_class *,
 159                        const struct ovsdb_idl_row *, const char *arg,
 160                        struct ovsdb_symbol_table *);
 161
 162 static bool is_condition_satisfied(const struct vsctl_table_class *,
 163                                    const struct ovsdb_idl_row *,
 164                                    const char *arg,
 165                                    struct ovsdb_symbol_table *);
 166
 167 int
 168 main(int argc, char *argv[])
 169 {
 170     extern struct vlog_module VLM_reconnect;
 171     struct ovsdb_idl *idl;
 172     struct vsctl_command *commands;
 173     struct shash local_options;
 174     unsigned int seqno;
 175     size_t n_commands;
 176     char *args;
 177
 178     set_program_name(argv[0]);
 179     signal(SIGPIPE, SIG_IGN);
 180     vlog_set_levels(NULL, VLF_CONSOLE, VLL_WARN);
 181     vlog_set_levels(&VLM_reconnect, VLF_ANY_FACILITY, VLL_WARN);
 182     ovsrec_init();
 183
 184     /* Log our arguments.  This is often valuable for debugging systems. */
 185     args = process_escape_args(argv);
 186     VLOG(might_write_to_db(argv) ? VLL_INFO : VLL_DBG, "Called as %s", args);
 187
 188     /* Parse command line. */
 189     shash_init(&local_options);
 190     parse_options(argc, argv, &local_options);
 191     commands = parse_commands(argc - optind, argv + optind, &local_options,
 192                               &n_commands);
 193
 194     if (timeout) {
 195         time_alarm(timeout);
 196     }
 197
 198     /* Initialize IDL. */
 199     idl = the_idl = ovsdb_idl_create(db, &ovsrec_idl_class, false, retry);
 200     run_prerequisites(commands, n_commands, idl);
 201
 202     /* Execute the commands.
 203      *
 204      * 'seqno' is the database sequence number for which we last tried to
 205      * execute our transaction.  There's no point in trying to commit more than
 206      * once for any given sequence number, because if the transaction fails
 207      * it's because the database changed and we need to obtain an up-to-date
 208      * view of the database before we try the transaction again. */
 209     seqno = ovsdb_idl_get_seqno(idl);
 210     for (;;) {
 211         ovsdb_idl_run(idl);
 212         if (!ovsdb_idl_is_alive(idl)) {
 213             int retval = ovsdb_idl_get_last_error(idl);
 214             vsctl_fatal("%s: database connection failed (%s)",
 215                         db, ovs_retval_to_string(retval));
 216         }
 217
 218         if (seqno != ovsdb_idl_get_seqno(idl)) {
 219             seqno = ovsdb_idl_get_seqno(idl);
 220             do_vsctl(args, commands, n_commands, idl);
 221         }
 222
 223         if (seqno == ovsdb_idl_get_seqno(idl)) {
 224             ovsdb_idl_wait(idl);
 225             poll_block();
 226         }
 227     }
 228 }
 229
 230 static struct option *
 231 find_option(const char *name, struct option *options, size_t n_options)
 232 {
 233     size_t i;
 234
 235     for (i = 0; i < n_options; i++) {
 236         if (!strcmp(options[i].name, name)) {
 237             return &options[i];
 238         }
 239     }
 240     return NULL;
 241 }
 242
 243 static struct option *
 244 add_option(struct option **optionsp, size_t *n_optionsp,
 245            size_t *allocated_optionsp)
 246 {
 247     if (*n_optionsp >= *allocated_optionsp) {
 248         *optionsp = x2nrealloc(*optionsp, allocated_optionsp,
 249                                sizeof **optionsp);
 250     }
 251     return &(*optionsp)[(*n_optionsp)++];
 252 }
 253
 254 static void
 255 parse_options(int argc, char *argv[], struct shash *local_options)
 256 {
 257     enum {
 258         OPT_DB = UCHAR_MAX + 1,
 259         OPT_ONELINE,
 260         OPT_NO_SYSLOG,
 261         OPT_NO_WAIT,
 262         OPT_DRY_RUN,
 263         OPT_PEER_CA_CERT,
 264         OPT_LOCAL,
 265         OPT_RETRY,
 266         VLOG_OPTION_ENUMS,
 267         TABLE_OPTION_ENUMS
 268     };
 269     static const struct option global_long_options[] = {
 270         {"db", required_argument, NULL, OPT_DB},
 271         {"no-syslog", no_argument, NULL, OPT_NO_SYSLOG},
 272         {"no-wait", no_argument, NULL, OPT_NO_WAIT},
 273         {"dry-run", no_argument, NULL, OPT_DRY_RUN},
 274         {"oneline", no_argument, NULL, OPT_ONELINE},
 275         {"timeout", required_argument, NULL, 't'},
 276         {"retry", no_argument, NULL, OPT_RETRY},
 277         {"help", no_argument, NULL, 'h'},
 278         {"version", no_argument, NULL, 'V'},
 279         VLOG_LONG_OPTIONS,
 280         TABLE_LONG_OPTIONS,
 281         STREAM_SSL_LONG_OPTIONS,
 282         {"peer-ca-cert", required_argument, NULL, OPT_PEER_CA_CERT},
 283         {NULL, 0, NULL, 0},
 284     };
 285     const int n_global_long_options = ARRAY_SIZE(global_long_options) - 1;
 286     char *tmp, *short_options;
 287
 288     const struct vsctl_command_syntax *p;
 289     struct option *options, *o;
 290     size_t allocated_options;
 291     size_t n_options;
 292     size_t i;
 293
 294     tmp = long_options_to_short_options(global_long_options);
 295     short_options = xasprintf("+%s", tmp);
 296     free(tmp);
 297
 298     /* We want to parse both global and command-specific options here, but
 299      * getopt_long() isn't too convenient for the job.  We copy our global
 300      * options into a dynamic array, then append all of the command-specific
 301      * options. */
 302     options = xmemdup(global_long_options, sizeof global_long_options);
 303     allocated_options = ARRAY_SIZE(global_long_options);
 304     n_options = n_global_long_options;
 305     for (p = all_commands; p->name; p++) {
 306         if (p->options[0]) {
 307             char *save_ptr = NULL;
 308             char *name;
 309             char *s;
 310
 311             s = xstrdup(p->options);
 312             for (name = strtok_r(s, ",", &save_ptr); name != NULL;
 313                  name = strtok_r(NULL, ",", &save_ptr)) {
 314                 char *equals;
 315                 int has_arg;
 316
 317                 ovs_assert(name[0] == '-' && name[1] == '-' && name[2]);
 318                 name += 2;
 319
 320                 equals = strchr(name, '=');
 321                 if (equals) {
 322                     has_arg = required_argument;
 323                     *equals = '\0';
 324                 } else {
 325                     has_arg = no_argument;
 326                 }
 327
 328                 o = find_option(name, options, n_options);
 329                 if (o) {
 330                     ovs_assert(o - options >= n_global_long_options);
 331                     ovs_assert(o->has_arg == has_arg);
 332                 } else {
 333                     o = add_option(&options, &n_options, &allocated_options);
 334                     o->name = xstrdup(name);
 335                     o->has_arg = has_arg;
 336                     o->flag = NULL;
 337                     o->val = OPT_LOCAL;
 338                 }
 339             }
 340
 341             free(s);
 342         }
 343     }
 344     o = add_option(&options, &n_options, &allocated_options);
 345     memset(o, 0, sizeof *o);
 346
 347     table_style.format = TF_LIST;
 348
 349     for (;;) {
 350         int idx;
 351         int c;
 352
 353         c = getopt_long(argc, argv, short_options, options, &idx);
 354         if (c == -1) {
 355             break;
 356         }
 357
 358         switch (c) {
 359         case OPT_DB:
 360             db = optarg;
 361             break;
 362
 363         case OPT_ONELINE:
 364             oneline = true;
 365             break;
 366
 367         case OPT_NO_SYSLOG:
 368             vlog_set_levels(&VLM_vsctl, VLF_SYSLOG, VLL_WARN);
 369             break;
 370
 371         case OPT_NO_WAIT:
 372             wait_for_reload = false;
 373             break;
 374
 375         case OPT_DRY_RUN:
 376             dry_run = true;
 377             break;
 378
 379         case OPT_LOCAL:
 380             if (shash_find(local_options, options[idx].name)) {
 381                 vsctl_fatal("'%s' option specified multiple times",
 382                             options[idx].name);
 383             }
 384             shash_add_nocopy(local_options,
 385                              xasprintf("--%s", options[idx].name),
 386                              optarg ? xstrdup(optarg) : NULL);
 387             break;
 388
 389         case 'h':
 390             usage();
 391
 392         case 'V':
 393             ovs_print_version(0, 0);
 394             exit(EXIT_SUCCESS);
 395
 396         case 't':
 397             timeout = strtoul(optarg, NULL, 10);
 398             if (timeout < 0) {
 399                 vsctl_fatal("value %s on -t or --timeout is invalid",
 400                             optarg);
 401             }
 402             break;
 403
 404         case OPT_RETRY:
 405             retry = true;
 406             break;
 407
 408         VLOG_OPTION_HANDLERS
 409         TABLE_OPTION_HANDLERS(&table_style)
 410
 411         STREAM_SSL_OPTION_HANDLERS
 412
 413         case OPT_PEER_CA_CERT:
 414             stream_ssl_set_peer_ca_cert_file(optarg);
 415             break;
 416
 417         case '?':
 418             exit(EXIT_FAILURE);
 419
 420         default:
 421             abort();
 422         }
 423     }
 424     free(short_options);
 425
 426     if (!db) {
 427         db = default_db();
 428     }
 429
 430     for (i = n_global_long_options; options[i].name; i++) {
 431         free(CONST_CAST(char *, options[i].name));
 432     }
 433     free(options);
 434 }
 435
 436 static struct vsctl_command *
 437 parse_commands(int argc, char *argv[], struct shash *local_options,
 438                size_t *n_commandsp)
 439 {
 440     struct vsctl_command *commands;
 441     size_t n_commands, allocated_commands;
 442     int i, start;
 443
 444     commands = NULL;
 445     n_commands = allocated_commands = 0;
 446
 447     for (start = i = 0; i <= argc; i++) {
 448         if (i == argc || !strcmp(argv[i], "--")) {
 449             if (i > start) {
 450                 if (n_commands >= allocated_commands) {
 451                     struct vsctl_command *c;
 452
 453                     commands = x2nrealloc(commands, &allocated_commands,
 454                                           sizeof *commands);
 455                     for (c = commands; c < &commands[n_commands]; c++) {
 456                         shash_moved(&c->options);
 457                     }
 458                 }
 459                 parse_command(i - start, &argv[start], local_options,
 460                               &commands[n_commands++]);
 461             } else if (!shash_is_empty(local_options)) {
 462                 vsctl_fatal("missing command name (use --help for help)");
 463             }
 464             start = i + 1;
 465         }
 466     }
 467     if (!n_commands) {
 468         vsctl_fatal("missing command name (use --help for help)");
 469     }
 470     *n_commandsp = n_commands;
 471     return commands;
 472 }
 473
 474 static void
 475 parse_command(int argc, char *argv[], struct shash *local_options,
 476               struct vsctl_command *command)
 477 {
 478     const struct vsctl_command_syntax *p;
 479     struct shash_node *node;
 480     int n_arg;
 481     int i;
 482
 483     shash_init(&command->options);
 484     shash_swap(local_options, &command->options);
 485     for (i = 0; i < argc; i++) {
 486         const char *option = argv[i];
 487         const char *equals;
 488         char *key, *value;
 489
 490         if (option[0] != '-') {
 491             break;
 492         }
 493
 494         equals = strchr(option, '=');
 495         if (equals) {
 496             key = xmemdup0(option, equals - option);
 497             value = xstrdup(equals + 1);
 498         } else {
 499             key = xstrdup(option);
 500             value = NULL;
 501         }
 502
 503         if (shash_find(&command->options, key)) {
 504             vsctl_fatal("'%s' option specified multiple times", argv[i]);
 505         }
 506         shash_add_nocopy(&command->options, key, value);
 507     }
 508     if (i == argc) {
 509         vsctl_fatal("missing command name (use --help for help)");
 510     }
 511
 512     p = find_command(argv[i]);
 513     if (!p) {
 514         vsctl_fatal("unknown command '%s'; use --help for help", argv[i]);
 515     }
 516
 517     SHASH_FOR_EACH (node, &command->options) {
 518         const char *s = strstr(p->options, node->name);
 519         int end = s ? s[strlen(node->name)] : EOF;
 520
 521         if (end != '=' && end != ',' && end != ' ' && end != '\0') {
 522             vsctl_fatal("'%s' command has no '%s' option",
 523                         argv[i], node->name);
 524         }
 525         if ((end == '=') != (node->data != NULL)) {
 526             if (end == '=') {
 527                 vsctl_fatal("missing argument to '%s' option on '%s' "
 528                             "command", node->name, argv[i]);
 529             } else {
 530                 vsctl_fatal("'%s' option on '%s' does not accept an "
 531                             "argument", node->name, argv[i]);
 532             }
 533         }
 534     }
 535
 536     n_arg = argc - i - 1;
 537     if (n_arg < p->min_args) {
 538         vsctl_fatal("'%s' command requires at least %d arguments",
 539                     p->name, p->min_args);
 540     } else if (n_arg > p->max_args) {
 541         int j;
 542
 543         for (j = i + 1; j < argc; j++) {
 544             if (argv[j][0] == '-') {
 545                 vsctl_fatal("'%s' command takes at most %d arguments "
 546                             "(note that options must precede command "
 547                             "names and follow a \"--\" argument)",
 548                             p->name, p->max_args);
 549             }
 550         }
 551
 552         vsctl_fatal("'%s' command takes at most %d arguments",
 553                     p->name, p->max_args);
 554     }
 555
 556     command->syntax = p;
 557     command->argc = n_arg + 1;
 558     command->argv = &argv[i];
 559 }
 560
 561 /* Returns the "struct vsctl_command_syntax" for a given command 'name', or a
 562  * null pointer if there is none. */
 563 static const struct vsctl_command_syntax *
 564 find_command(const char *name)
 565 {
 566     static struct shash commands = SHASH_INITIALIZER(&commands);
 567
 568     if (shash_is_empty(&commands)) {
 569         const struct vsctl_command_syntax *p;
 570
 571         for (p = all_commands; p->name; p++) {
 572             shash_add_assert(&commands, p->name, p);
 573         }
 574     }
 575
 576     return shash_find_data(&commands, name);
 577 }
 578
 579 static void
 580 vsctl_fatal(const char *format, ...)
 581 {
 582     char *message;
 583     va_list args;
 584
 585     va_start(args, format);
 586     message = xvasprintf(format, args);
 587     va_end(args);
 588
 589     vlog_set_levels(&VLM_vsctl, VLF_CONSOLE, VLL_OFF);
 590     VLOG_ERR("%s", message);
 591     ovs_error(0, "%s", message);
 592     vsctl_exit(EXIT_FAILURE);
 593 }
 594
 595 /* Frees the current transaction and the underlying IDL and then calls
 596  * exit(status).
 597  *
 598  * Freeing the transaction and the IDL is not strictly necessary, but it makes
 599  * for a clean memory leak report from valgrind in the normal case.  That makes
 600  * it easier to notice real memory leaks. */
 601 static void
 602 vsctl_exit(int status)
 603 {
 604     if (the_idl_txn) {
 605         ovsdb_idl_txn_abort(the_idl_txn);
 606         ovsdb_idl_txn_destroy(the_idl_txn);
 607     }
 608     ovsdb_idl_destroy(the_idl);
 609     exit(status);
 610 }
 611
 612 static void
 613 usage(void)
 614 {
 615     printf("\
 616 %s: ovs-vswitchd management utility\n\
 617 usage: %s [OPTIONS] COMMAND [ARG...]\n\
 618 \n\
 619 Open vSwitch commands:\n\
 620   init                        initialize database, if not yet initialized\n\
 621   show                        print overview of database contents\n\
 622   emer-reset                  reset configuration to clean state\n\
 623 \n\
 624 Bridge commands:\n\
 625   add-br BRIDGE               create a new bridge named BRIDGE\n\
 626   add-br BRIDGE PARENT VLAN   create new fake BRIDGE in PARENT on VLAN\n\
 627   del-br BRIDGE               delete BRIDGE and all of its ports\n\
 628   list-br                     print the names of all the bridges\n\
 629   br-exists BRIDGE            exit 2 if BRIDGE does not exist\n\
 630   br-to-vlan BRIDGE           print the VLAN which BRIDGE is on\n\
 631   br-to-parent BRIDGE         print the parent of BRIDGE\n\
 632   br-set-external-id BRIDGE KEY VALUE  set KEY on BRIDGE to VALUE\n\
 633   br-set-external-id BRIDGE KEY  unset KEY on BRIDGE\n\
 634   br-get-external-id BRIDGE KEY  print value of KEY on BRIDGE\n\
 635   br-get-external-id BRIDGE  list key-value pairs on BRIDGE\n\
 636 \n\
 637 Port commands (a bond is considered to be a single port):\n\
 638   list-ports BRIDGE           print the names of all the ports on BRIDGE\n\
 639   add-port BRIDGE PORT        add network device PORT to BRIDGE\n\
 640   add-bond BRIDGE PORT IFACE...  add bonded port PORT in BRIDGE from IFACES\n\
 641   del-port [BRIDGE] PORT      delete PORT (which may be bonded) from BRIDGE\n\
 642   port-to-br PORT             print name of bridge that contains PORT\n\
 643 \n\
 644 Interface commands (a bond consists of multiple interfaces):\n\
 645   list-ifaces BRIDGE          print the names of all interfaces on BRIDGE\n\
 646   iface-to-br IFACE           print name of bridge that contains IFACE\n\
 647 \n\
 648 Controller commands:\n\
 649   get-controller BRIDGE      print the controllers for BRIDGE\n\
 650   del-controller BRIDGE      delete the controllers for BRIDGE\n\
 651   set-controller BRIDGE TARGET...  set the controllers for BRIDGE\n\
 652   get-fail-mode BRIDGE       print the fail-mode for BRIDGE\n\
 653   del-fail-mode BRIDGE       delete the fail-mode for BRIDGE\n\
 654   set-fail-mode BRIDGE MODE  set the fail-mode for BRIDGE to MODE\n\
 655 \n\
 656 Manager commands:\n\
 657   get-manager                print the managers\n\
 658   del-manager                delete the managers\n\
 659   set-manager TARGET...      set the list of managers to TARGET...\n\
 660 \n\
 661 SSL commands:\n\
 662   get-ssl                     print the SSL configuration\n\
 663   del-ssl                     delete the SSL configuration\n\
 664   set-ssl PRIV-KEY CERT CA-CERT  set the SSL configuration\n\
 665 \n\
 666 Switch commands:\n\
 667   emer-reset                  reset switch to known good state\n\
 668 \n\
 669 Database commands:\n\
 670   list TBL [REC]              list RECord (or all records) in TBL\n\
 671   find TBL CONDITION...       list records satisfying CONDITION in TBL\n\
 672   get TBL REC COL[:KEY]       print values of COLumns in RECord in TBL\n\
 673   set TBL REC COL[:KEY]=VALUE set COLumn values in RECord in TBL\n\
 674   add TBL REC COL [KEY=]VALUE add (KEY=)VALUE to COLumn in RECord in TBL\n\
 675   remove TBL REC COL [KEY=]VALUE  remove (KEY=)VALUE from COLumn\n\
 676   clear TBL REC COL           clear values from COLumn in RECord in TBL\n\
 677   create TBL COL[:KEY]=VALUE  create and initialize new record\n\
 678   destroy TBL REC             delete RECord from TBL\n\
 679   wait-until TBL REC [COL[:KEY]=VALUE]  wait until condition is true\n\
 680 Potentially unsafe database commands require --force option.\n\
 681 \n\
 682 Options:\n\
 683   --db=DATABASE               connect to DATABASE\n\
 684                               (default: %s)\n\
 685   --no-wait                   do not wait for ovs-vswitchd to reconfigure\n\
 686   --retry                     keep trying to connect to server forever\n\
 687   -t, --timeout=SECS          wait at most SECS seconds for ovs-vswitchd\n\
 688   --dry-run                   do not commit changes to database\n\
 689   --oneline                   print exactly one line of output per command\n",
 690            program_name, program_name, default_db());
 691     vlog_usage();
 692     printf("\
 693   --no-syslog             equivalent to --verbose=vsctl:syslog:warn\n");
 694     stream_usage("database", true, true, false);
 695     printf("\n\
 696 Other options:\n\
 697   -h, --help                  display this help message\n\
 698   -V, --version               display version information\n");
 699     exit(EXIT_SUCCESS);
 700 }
 701
 702 static char *
 703 default_db(void)
 704 {
 705     static char *def;
 706     if (!def) {
 707         def = xasprintf("unix:%s/db.sock", ovs_rundir());
 708     }
 709     return def;
 710 }
 711
 712 /* Returns true if it looks like this set of arguments might modify the
 713  * database, otherwise false.  (Not very smart, so it's prone to false
 714  * positives.) */
 715 static bool
 716 might_write_to_db(char **argv)
 717 {
 718     for (; *argv; argv++) {
 719         const struct vsctl_command_syntax *p = find_command(*argv);
 720         if (p && p->mode == RW) {
 721             return true;
 722         }
 723     }
 724     return false;
 725 }
 726 \f
 727 struct vsctl_context {
 728     /* Read-only. */
 729     int argc;
 730     char **argv;
 731     struct shash options;
 732
 733     /* Modifiable state. */
 734     struct ds output;
 735     struct table *table;
 736     struct ovsdb_idl *idl;
 737     struct ovsdb_idl_txn *txn;
 738     struct ovsdb_symbol_table *symtab;
 739     const struct ovsrec_open_vswitch *ovs;
 740     bool verified_ports;
 741
 742     /* A cache of the contents of the database.
 743      *
 744      * A command that needs to use any of this information must first call
 745      * vsctl_context_populate_cache().  A command that changes anything that
 746      * could invalidate the cache must either call
 747      * vsctl_context_invalidate_cache() or manually update the cache to
 748      * maintain its correctness. */
 749     bool cache_valid;
 750     struct shash bridges;   /* Maps from bridge name to struct vsctl_bridge. */
 751     struct shash ports;     /* Maps from port name to struct vsctl_port. */
 752     struct shash ifaces;    /* Maps from port name to struct vsctl_iface. */
 753
 754     /* A command may set this member to true if some prerequisite is not met
 755      * and the caller should wait for something to change and then retry. */
 756     bool try_again;
 757 };
 758
 759 struct vsctl_bridge {
 760     struct ovsrec_bridge *br_cfg;
 761     char *name;
 762     struct list ports;          /* Contains "struct vsctl_port"s. */
 763
 764     /* VLAN ("fake") bridge support.
 765      *
 766      * Use 'parent != NULL' to detect a fake bridge, because 'vlan' can be 0
 767      * in either case. */
 768     struct hmap children;        /* VLAN bridges indexed by 'vlan'. */
 769     struct hmap_node children_node; /* Node in parent's 'children' hmap. */
 770     struct vsctl_bridge *parent; /* Real bridge, or NULL. */
 771     int vlan;                    /* VLAN VID (0...4095), or 0. */
 772 };
 773
 774 struct vsctl_port {
 775     struct list ports_node;     /* In struct vsctl_bridge's 'ports' list. */
 776     struct list ifaces;         /* Contains "struct vsctl_iface"s. */
 777     struct ovsrec_port *port_cfg;
 778     struct vsctl_bridge *bridge;
 779 };
 780
 781 struct vsctl_iface {
 782     struct list ifaces_node;     /* In struct vsctl_port's 'ifaces' list. */
 783     struct ovsrec_interface *iface_cfg;
 784     struct vsctl_port *port;
 785 };
 786
 787 static char *
 788 vsctl_context_to_string(const struct vsctl_context *ctx)
 789 {
 790     const struct shash_node *node;
 791     struct svec words;
 792     char *s;
 793     int i;
 794
 795     svec_init(&words);
 796     SHASH_FOR_EACH (node, &ctx->options) {
 797         svec_add(&words, node->name);
 798     }
 799     for (i = 0; i < ctx->argc; i++) {
 800         svec_add(&words, ctx->argv[i]);
 801     }
 802     svec_terminate(&words);
 803
 804     s = process_escape_args(words.names);
 805
 806     svec_destroy(&words);
 807
 808     return s;
 809 }
 810
 811 static void
 812 verify_ports(struct vsctl_context *ctx)
 813 {
 814     if (!ctx->verified_ports) {
 815         const struct ovsrec_bridge *bridge;
 816         const struct ovsrec_port *port;
 817
 818         ovsrec_open_vswitch_verify_bridges(ctx->ovs);
 819         OVSREC_BRIDGE_FOR_EACH (bridge, ctx->idl) {
 820             ovsrec_bridge_verify_ports(bridge);
 821         }
 822         OVSREC_PORT_FOR_EACH (port, ctx->idl) {
 823             ovsrec_port_verify_interfaces(port);
 824         }
 825
 826         ctx->verified_ports = true;
 827     }
 828 }
 829
 830 static struct vsctl_bridge *
 831 add_bridge_to_cache(struct vsctl_context *ctx,
 832                     struct ovsrec_bridge *br_cfg, const char *name,
 833                     struct vsctl_bridge *parent, int vlan)
 834 {
 835     struct vsctl_bridge *br = xmalloc(sizeof *br);
 836     br->br_cfg = br_cfg;
 837     br->name = xstrdup(name);
 838     list_init(&br->ports);
 839     br->parent = parent;
 840     br->vlan = vlan;
 841     hmap_init(&br->children);
 842     if (parent) {
 843         hmap_insert(&parent->children, &br->children_node, hash_int(vlan, 0));
 844     }
 845     shash_add(&ctx->bridges, br->name, br);
 846     return br;
 847 }
 848
 849 static void
 850 ovs_delete_bridge(const struct ovsrec_open_vswitch *ovs,
 851                   struct ovsrec_bridge *bridge)
 852 {
 853     struct ovsrec_bridge **bridges;
 854     size_t i, n;
 855
 856     bridges = xmalloc(sizeof *ovs->bridges * ovs->n_bridges);
 857     for (i = n = 0; i < ovs->n_bridges; i++) {
 858         if (ovs->bridges[i] != bridge) {
 859             bridges[n++] = ovs->bridges[i];
 860         }
 861     }
 862     ovsrec_open_vswitch_set_bridges(ovs, bridges, n);
 863     free(bridges);
 864 }
 865
 866 static void
 867 del_cached_bridge(struct vsctl_context *ctx, struct vsctl_bridge *br)
 868 {
 869     ovs_assert(list_is_empty(&br->ports));
 870     ovs_assert(hmap_is_empty(&br->children));
 871     if (br->parent) {
 872         hmap_remove(&br->parent->children, &br->children_node);
 873     }
 874     if (br->br_cfg) {
 875         ovsrec_bridge_delete(br->br_cfg);
 876         ovs_delete_bridge(ctx->ovs, br->br_cfg);
 877     }
 878     shash_find_and_delete(&ctx->bridges, br->name);
 879     hmap_destroy(&br->children);
 880     free(br->name);
 881     free(br);
 882 }
 883
 884 static bool
 885 port_is_fake_bridge(const struct ovsrec_port *port_cfg)
 886 {
 887     return (port_cfg->fake_bridge
 888             && port_cfg->tag
 889             && *port_cfg->tag >= 0 && *port_cfg->tag <= 4095);
 890 }
 891
 892 static struct vsctl_bridge *
 893 find_vlan_bridge(struct vsctl_bridge *parent, int vlan)
 894 {
 895     struct vsctl_bridge *child;
 896
 897     HMAP_FOR_EACH_IN_BUCKET (child, children_node, hash_int(vlan, 0),
 898                              &parent->children) {
 899         if (child->vlan == vlan) {
 900             return child;
 901         }
 902     }
 903
 904     return NULL;
 905 }
 906
 907 static struct vsctl_port *
 908 add_port_to_cache(struct vsctl_context *ctx, struct vsctl_bridge *parent,
 909                   struct ovsrec_port *port_cfg)
 910 {
 911     struct vsctl_port *port;
 912
 913     if (port_cfg->tag
 914         && *port_cfg->tag >= 0 && *port_cfg->tag <= 4095) {
 915         struct vsctl_bridge *vlan_bridge;
 916
 917         vlan_bridge = find_vlan_bridge(parent, *port_cfg->tag);
 918         if (vlan_bridge) {
 919             parent = vlan_bridge;
 920         }
 921     }
 922
 923     port = xmalloc(sizeof *port);
 924     list_push_back(&parent->ports, &port->ports_node);
 925     list_init(&port->ifaces);
 926     port->port_cfg = port_cfg;
 927     port->bridge = parent;
 928     shash_add(&ctx->ports, port_cfg->name, port);
 929
 930     return port;
 931 }
 932
 933 static void
 934 del_cached_port(struct vsctl_context *ctx, struct vsctl_port *port)
 935 {
 936     ovs_assert(list_is_empty(&port->ifaces));
 937     list_remove(&port->ports_node);
 938     shash_find_and_delete(&ctx->ports, port->port_cfg->name);
 939     ovsrec_port_delete(port->port_cfg);
 940     free(port);
 941 }
 942
 943 static struct vsctl_iface *
 944 add_iface_to_cache(struct vsctl_context *ctx, struct vsctl_port *parent,
 945                    struct ovsrec_interface *iface_cfg)
 946 {
 947     struct vsctl_iface *iface;
 948
 949     iface = xmalloc(sizeof *iface);
 950     list_push_back(&parent->ifaces, &iface->ifaces_node);
 951     iface->iface_cfg = iface_cfg;
 952     iface->port = parent;
 953     shash_add(&ctx->ifaces, iface_cfg->name, iface);
 954
 955     return iface;
 956 }
 957
 958 static void
 959 del_cached_iface(struct vsctl_context *ctx, struct vsctl_iface *iface)
 960 {
 961     list_remove(&iface->ifaces_node);
 962     shash_find_and_delete(&ctx->ifaces, iface->iface_cfg->name);
 963     ovsrec_interface_delete(iface->iface_cfg);
 964     free(iface);
 965 }
 966
 967 static void
 968 vsctl_context_invalidate_cache(struct vsctl_context *ctx)
 969 {
 970     struct shash_node *node;
 971
 972     if (!ctx->cache_valid) {
 973         return;
 974     }
 975     ctx->cache_valid = false;
 976
 977     SHASH_FOR_EACH (node, &ctx->bridges) {
 978         struct vsctl_bridge *bridge = node->data;
 979         hmap_destroy(&bridge->children);
 980         free(bridge->name);
 981         free(bridge);
 982     }
 983     shash_destroy(&ctx->bridges);
 984
 985     shash_destroy_free_data(&ctx->ports);
 986     shash_destroy_free_data(&ctx->ifaces);
 987 }
 988
 989 static void
 990 pre_get_info(struct vsctl_context *ctx)
 991 {
 992     ovsdb_idl_add_column(ctx->idl, &ovsrec_open_vswitch_col_bridges);
 993
 994     ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_name);
 995     ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_controller);
 996     ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_fail_mode);
 997     ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_ports);
 998
 999     ovsdb_idl_add_column(ctx->idl, &ovsrec_port_col_name);
1000     ovsdb_idl_add_column(ctx->idl, &ovsrec_port_col_fake_bridge);
1001     ovsdb_idl_add_column(ctx->idl, &ovsrec_port_col_tag);
1002     ovsdb_idl_add_column(ctx->idl, &ovsrec_port_col_interfaces);
1003
1004     ovsdb_idl_add_column(ctx->idl, &ovsrec_interface_col_name);
1005 }
1006
1007 static void
1008 vsctl_context_populate_cache(struct vsctl_context *ctx)
1009 {
1010     const struct ovsrec_open_vswitch *ovs = ctx->ovs;
1011     struct sset bridges, ports;
1012     size_t i;
1013
1014     if (ctx->cache_valid) {
1015         /* Cache is already populated. */
1016         return;
1017     }
1018     ctx->cache_valid = true;
1019     shash_init(&ctx->bridges);
1020     shash_init(&ctx->ports);
1021     shash_init(&ctx->ifaces);
1022
1023     sset_init(&bridges);
1024     sset_init(&ports);
1025     for (i = 0; i < ovs->n_bridges; i++) {
1026         struct ovsrec_bridge *br_cfg = ovs->bridges[i];
1027         struct vsctl_bridge *br;
1028         size_t j;
1029
1030         if (!sset_add(&bridges, br_cfg->name)) {
1031             VLOG_WARN("%s: database contains duplicate bridge name",
1032                       br_cfg->name);
1033             continue;
1034         }
1035         br = add_bridge_to_cache(ctx, br_cfg, br_cfg->name, NULL, 0);
1036         if (!br) {
1037             continue;
1038         }
1039
1040         for (j = 0; j < br_cfg->n_ports; j++) {
1041             struct ovsrec_port *port_cfg = br_cfg->ports[j];
1042
1043             if (!sset_add(&ports, port_cfg->name)) {
1044                 /* Duplicate port name.  (We will warn about that later.) */
1045                 continue;
1046             }
1047
1048             if (port_is_fake_bridge(port_cfg)
1049                 && sset_add(&bridges, port_cfg->name)) {
1050                 add_bridge_to_cache(ctx, NULL, port_cfg->name, br,
1051                                     *port_cfg->tag);
1052             }
1053         }
1054     }
1055     sset_destroy(&bridges);
1056     sset_destroy(&ports);
1057
1058     sset_init(&bridges);
1059     for (i = 0; i < ovs->n_bridges; i++) {
1060         struct ovsrec_bridge *br_cfg = ovs->bridges[i];
1061         struct vsctl_bridge *br;
1062         size_t j;
1063
1064         if (!sset_add(&bridges, br_cfg->name)) {
1065             continue;
1066         }
1067         br = shash_find_data(&ctx->bridges, br_cfg->name);
1068         for (j = 0; j < br_cfg->n_ports; j++) {
1069             struct ovsrec_port *port_cfg = br_cfg->ports[j];
1070             struct vsctl_port *port;
1071             size_t k;
1072
1073             port = shash_find_data(&ctx->ports, port_cfg->name);
1074             if (port) {
1075                 if (port_cfg == port->port_cfg) {
1076                     VLOG_WARN("%s: port is in multiple bridges (%s and %s)",
1077                               port_cfg->name, br->name, port->bridge->name);
1078                 } else {
1079                     /* Log as an error because this violates the database's
1080                      * uniqueness constraints, so the database server shouldn't
1081                      * have allowed it. */
1082                     VLOG_ERR("%s: database contains duplicate port name",
1083                              port_cfg->name);
1084                 }
1085                 continue;
1086             }
1087
1088             if (port_is_fake_bridge(port_cfg)
1089                 && !sset_add(&bridges, port_cfg->name)) {
1090                 continue;
1091             }
1092
1093             port = add_port_to_cache(ctx, br, port_cfg);
1094             for (k = 0; k < port_cfg->n_interfaces; k++) {
1095                 struct ovsrec_interface *iface_cfg = port_cfg->interfaces[k];
1096                 struct vsctl_iface *iface;
1097
1098                 iface = shash_find_data(&ctx->ifaces, iface_cfg->name);
1099                 if (iface) {
1100                     if (iface_cfg == iface->iface_cfg) {
1101                         VLOG_WARN("%s: interface is in multiple ports "
1102                                   "(%s and %s)",
1103                                   iface_cfg->name,
1104                                   iface->port->port_cfg->name,
1105                                   port->port_cfg->name);
1106                     } else {
1107                         /* Log as an error because this violates the database's
1108                          * uniqueness constraints, so the database server
1109                          * shouldn't have allowed it. */
1110                         VLOG_ERR("%s: database contains duplicate interface "
1111                                  "name", iface_cfg->name);
1112                     }
1113                     continue;
1114                 }
1115
1116                 add_iface_to_cache(ctx, port, iface_cfg);
1117             }
1118         }
1119     }
1120     sset_destroy(&bridges);
1121 }
1122
1123 static void
1124 check_conflicts(struct vsctl_context *ctx, const char *name,
1125                 char *msg)
1126 {
1127     struct vsctl_iface *iface;
1128     struct vsctl_port *port;
1129
1130     verify_ports(ctx);
1131
1132     if (shash_find(&ctx->bridges, name)) {
1133         vsctl_fatal("%s because a bridge named %s already exists",
1134                     msg, name);
1135     }
1136
1137     port = shash_find_data(&ctx->ports, name);
1138     if (port) {
1139         vsctl_fatal("%s because a port named %s already exists on "
1140                     "bridge %s", msg, name, port->bridge->name);
1141     }
1142
1143     iface = shash_find_data(&ctx->ifaces, name);
1144     if (iface) {
1145         vsctl_fatal("%s because an interface named %s already exists "
1146                     "on bridge %s", msg, name, iface->port->bridge->name);
1147     }
1148
1149     free(msg);
1150 }
1151
1152 static struct vsctl_bridge *
1153 find_bridge(struct vsctl_context *ctx, const char *name, bool must_exist)
1154 {
1155     struct vsctl_bridge *br;
1156
1157     ovs_assert(ctx->cache_valid);
1158
1159     br = shash_find_data(&ctx->bridges, name);
1160     if (must_exist && !br) {
1161         vsctl_fatal("no bridge named %s", name);
1162     }
1163     ovsrec_open_vswitch_verify_bridges(ctx->ovs);
1164     return br;
1165 }
1166
1167 static struct vsctl_bridge *
1168 find_real_bridge(struct vsctl_context *ctx, const char *name, bool must_exist)
1169 {
1170     struct vsctl_bridge *br = find_bridge(ctx, name, must_exist);
1171     if (br && br->parent) {
1172         vsctl_fatal("%s is a fake bridge", name);
1173     }
1174     return br;
1175 }
1176
1177 static struct vsctl_port *
1178 find_port(struct vsctl_context *ctx, const char *name, bool must_exist)
1179 {
1180     struct vsctl_port *port;
1181
1182     ovs_assert(ctx->cache_valid);
1183
1184     port = shash_find_data(&ctx->ports, name);
1185     if (port && !strcmp(name, port->bridge->name)) {
1186         port = NULL;
1187     }
1188     if (must_exist && !port) {
1189         vsctl_fatal("no port named %s", name);
1190     }
1191     verify_ports(ctx);
1192     return port;
1193 }
1194
1195 static struct vsctl_iface *
1196 find_iface(struct vsctl_context *ctx, const char *name, bool must_exist)
1197 {
1198     struct vsctl_iface *iface;
1199
1200     ovs_assert(ctx->cache_valid);
1201
1202     iface = shash_find_data(&ctx->ifaces, name);
1203     if (iface && !strcmp(name, iface->port->bridge->name)) {
1204         iface = NULL;
1205     }
1206     if (must_exist && !iface) {
1207         vsctl_fatal("no interface named %s", name);
1208     }
1209     verify_ports(ctx);
1210     return iface;
1211 }
1212
1213 static void
1214 bridge_insert_port(struct ovsrec_bridge *br, struct ovsrec_port *port)
1215 {
1216     struct ovsrec_port **ports;
1217     size_t i;
1218
1219     ports = xmalloc(sizeof *br->ports * (br->n_ports + 1));
1220     for (i = 0; i < br->n_ports; i++) {
1221         ports[i] = br->ports[i];
1222     }
1223     ports[br->n_ports] = port;
1224     ovsrec_bridge_set_ports(br, ports, br->n_ports + 1);
1225     free(ports);
1226 }
1227
1228 static void
1229 bridge_delete_port(struct ovsrec_bridge *br, struct ovsrec_port *port)
1230 {
1231     struct ovsrec_port **ports;
1232     size_t i, n;
1233
1234     ports = xmalloc(sizeof *br->ports * br->n_ports);
1235     for (i = n = 0; i < br->n_ports; i++) {
1236         if (br->ports[i] != port) {
1237             ports[n++] = br->ports[i];
1238         }
1239     }
1240     ovsrec_bridge_set_ports(br, ports, n);
1241     free(ports);
1242 }
1243
1244 static void
1245 ovs_insert_bridge(const struct ovsrec_open_vswitch *ovs,
1246                   struct ovsrec_bridge *bridge)
1247 {
1248     struct ovsrec_bridge **bridges;
1249     size_t i;
1250
1251     bridges = xmalloc(sizeof *ovs->bridges * (ovs->n_bridges + 1));
1252     for (i = 0; i < ovs->n_bridges; i++) {
1253         bridges[i] = ovs->bridges[i];
1254     }
1255     bridges[ovs->n_bridges] = bridge;
1256     ovsrec_open_vswitch_set_bridges(ovs, bridges, ovs->n_bridges + 1);
1257     free(bridges);
1258 }
1259
1260 static void
1261 cmd_init(struct vsctl_context *ctx OVS_UNUSED)
1262 {
1263 }
1264
1265 struct cmd_show_table {
1266     const struct ovsdb_idl_table_class *table;
1267     const struct ovsdb_idl_column *name_column;
1268     const struct ovsdb_idl_column *columns[3];
1269     bool recurse;
1270 };
1271
1272 static struct cmd_show_table cmd_show_tables[] = {
1273     {&ovsrec_table_open_vswitch,
1274      NULL,
1275      {&ovsrec_open_vswitch_col_manager_options,
1276       &ovsrec_open_vswitch_col_bridges,
1277       &ovsrec_open_vswitch_col_ovs_version},
1278      false},
1279
1280     {&ovsrec_table_bridge,
1281      &ovsrec_bridge_col_name,
1282      {&ovsrec_bridge_col_controller,
1283       &ovsrec_bridge_col_fail_mode,
1284       &ovsrec_bridge_col_ports},
1285      false},
1286
1287     {&ovsrec_table_port,
1288      &ovsrec_port_col_name,
1289      {&ovsrec_port_col_tag,
1290       &ovsrec_port_col_trunks,
1291       &ovsrec_port_col_interfaces},
1292      false},
1293
1294     {&ovsrec_table_interface,
1295      &ovsrec_interface_col_name,
1296      {&ovsrec_interface_col_type,
1297       &ovsrec_interface_col_options,
1298       NULL},
1299      false},
1300
1301     {&ovsrec_table_controller,
1302      &ovsrec_controller_col_target,
1303      {&ovsrec_controller_col_is_connected,
1304       NULL,
1305       NULL},
1306      false},
1307
1308     {&ovsrec_table_manager,
1309      &ovsrec_manager_col_target,
1310      {&ovsrec_manager_col_is_connected,
1311       NULL,
1312       NULL},
1313      false},
1314 };
1315
1316 static void
1317 pre_cmd_show(struct vsctl_context *ctx)
1318 {
1319     struct cmd_show_table *show;
1320
1321     for (show = cmd_show_tables;
1322          show < &cmd_show_tables[ARRAY_SIZE(cmd_show_tables)];
1323          show++) {
1324         size_t i;
1325
1326         ovsdb_idl_add_table(ctx->idl, show->table);
1327         if (show->name_column) {
1328             ovsdb_idl_add_column(ctx->idl, show->name_column);
1329         }
1330         for (i = 0; i < ARRAY_SIZE(show->columns); i++) {
1331             const struct ovsdb_idl_column *column = show->columns[i];
1332             if (column) {
1333                 ovsdb_idl_add_column(ctx->idl, column);
1334             }
1335         }
1336     }
1337 }
1338
1339 static struct cmd_show_table *
1340 cmd_show_find_table_by_row(const struct ovsdb_idl_row *row)
1341 {
1342     struct cmd_show_table *show;
1343
1344     for (show = cmd_show_tables;
1345          show < &cmd_show_tables[ARRAY_SIZE(cmd_show_tables)];
1346          show++) {
1347         if (show->table == row->table->class) {
1348             return show;
1349         }
1350     }
1351     return NULL;
1352 }
1353
1354 static struct cmd_show_table *
1355 cmd_show_find_table_by_name(const char *name)
1356 {
1357     struct cmd_show_table *show;
1358
1359     for (show = cmd_show_tables;
1360          show < &cmd_show_tables[ARRAY_SIZE(cmd_show_tables)];
1361          show++) {
1362         if (!strcmp(show->table->name, name)) {
1363             return show;
1364         }
1365     }
1366     return NULL;
1367 }
1368
1369 static void
1370 cmd_show_row(struct vsctl_context *ctx, const struct ovsdb_idl_row *row,
1371              int level)
1372 {
1373     struct cmd_show_table *show = cmd_show_find_table_by_row(row);
1374     size_t i;
1375
1376     ds_put_char_multiple(&ctx->output, ' ', level * 4);
1377     if (show && show->name_column) {
1378         const struct ovsdb_datum *datum;
1379
1380         ds_put_format(&ctx->output, "%s ", show->table->name);
1381         datum = ovsdb_idl_read(row, show->name_column);
1382         ovsdb_datum_to_string(datum, &show->name_column->type, &ctx->output);
1383     } else {
1384         ds_put_format(&ctx->output, UUID_FMT, UUID_ARGS(&row->uuid));
1385     }
1386     ds_put_char(&ctx->output, '\n');
1387
1388     if (!show || show->recurse) {
1389         return;
1390     }
1391
1392     show->recurse = true;
1393     for (i = 0; i < ARRAY_SIZE(show->columns); i++) {
1394         const struct ovsdb_idl_column *column = show->columns[i];
1395         const struct ovsdb_datum *datum;
1396
1397         if (!column) {
1398             break;
1399         }
1400
1401         datum = ovsdb_idl_read(row, column);
1402         if (column->type.key.type == OVSDB_TYPE_UUID &&
1403             column->type.key.u.uuid.refTableName) {
1404             struct cmd_show_table *ref_show;
1405             size_t j;
1406
1407             ref_show = cmd_show_find_table_by_name(
1408                 column->type.key.u.uuid.refTableName);
1409             if (ref_show) {
1410                 for (j = 0; j < datum->n; j++) {
1411                     const struct ovsdb_idl_row *ref_row;
1412
1413                     ref_row = ovsdb_idl_get_row_for_uuid(ctx->idl,
1414                                                          ref_show->table,
1415                                                          &datum->keys[j].uuid);
1416                     if (ref_row) {
1417                         cmd_show_row(ctx, ref_row, level + 1);
1418                     }
1419                 }
1420                 continue;
1421             }
1422         }
1423
1424         if (!ovsdb_datum_is_default(datum, &column->type)) {
1425             ds_put_char_multiple(&ctx->output, ' ', (level + 1) * 4);
1426             ds_put_format(&ctx->output, "%s: ", column->name);
1427             ovsdb_datum_to_string(datum, &column->type, &ctx->output);
1428             ds_put_char(&ctx->output, '\n');
1429         }
1430     }
1431     show->recurse = false;
1432 }
1433
1434 static void
1435 cmd_show(struct vsctl_context *ctx)
1436 {
1437     const struct ovsdb_idl_row *row;
1438
1439     for (row = ovsdb_idl_first_row(ctx->idl, cmd_show_tables[0].table);
1440          row; row = ovsdb_idl_next_row(row)) {
1441         cmd_show_row(ctx, row, 0);
1442     }
1443 }
1444
1445 static void
1446 pre_cmd_emer_reset(struct vsctl_context *ctx)
1447 {
1448     ovsdb_idl_add_column(ctx->idl, &ovsrec_open_vswitch_col_manager_options);
1449     ovsdb_idl_add_column(ctx->idl, &ovsrec_open_vswitch_col_ssl);
1450
1451     ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_controller);
1452     ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_fail_mode);
1453     ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_mirrors);
1454     ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_netflow);
1455     ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_sflow);
1456     ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_ipfix);
1457     ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_flood_vlans);
1458     ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_other_config);
1459
1460     ovsdb_idl_add_column(ctx->idl, &ovsrec_port_col_other_config);
1461
1462     ovsdb_idl_add_column(ctx->idl,
1463                           &ovsrec_interface_col_ingress_policing_rate);
1464     ovsdb_idl_add_column(ctx->idl,
1465                           &ovsrec_interface_col_ingress_policing_burst);
1466 }
1467
1468 static void
1469 cmd_emer_reset(struct vsctl_context *ctx)
1470 {
1471     const struct ovsdb_idl *idl = ctx->idl;
1472     const struct ovsrec_bridge *br;
1473     const struct ovsrec_port *port;
1474     const struct ovsrec_interface *iface;
1475     const struct ovsrec_mirror *mirror, *next_mirror;
1476     const struct ovsrec_controller *ctrl, *next_ctrl;
1477     const struct ovsrec_manager *mgr, *next_mgr;
1478     const struct ovsrec_netflow *nf, *next_nf;
1479     const struct ovsrec_ssl *ssl, *next_ssl;
1480     const struct ovsrec_sflow *sflow, *next_sflow;
1481     const struct ovsrec_ipfix *ipfix, *next_ipfix;
1482     const struct ovsrec_flow_sample_collector_set *fscset, *next_fscset;
1483
1484     /* Reset the Open_vSwitch table. */
1485     ovsrec_open_vswitch_set_manager_options(ctx->ovs, NULL, 0);
1486     ovsrec_open_vswitch_set_ssl(ctx->ovs, NULL);
1487
1488     OVSREC_BRIDGE_FOR_EACH (br, idl) {
1489         const char *hwaddr;
1490
1491         ovsrec_bridge_set_controller(br, NULL, 0);
1492         ovsrec_bridge_set_fail_mode(br, NULL);
1493         ovsrec_bridge_set_mirrors(br, NULL, 0);
1494         ovsrec_bridge_set_netflow(br, NULL);
1495         ovsrec_bridge_set_sflow(br, NULL);
1496         ovsrec_bridge_set_ipfix(br, NULL);
1497         ovsrec_bridge_set_flood_vlans(br, NULL, 0);
1498
1499         /* We only want to save the "hwaddr" key from other_config. */
1500         hwaddr = smap_get(&br->other_config, "hwaddr");
1501         if (hwaddr) {
1502             struct smap smap = SMAP_INITIALIZER(&smap);
1503             smap_add(&smap, "hwaddr", hwaddr);
1504             ovsrec_bridge_set_other_config(br, &smap);
1505             smap_destroy(&smap);
1506         } else {
1507             ovsrec_bridge_set_other_config(br, NULL);
1508         }
1509     }
1510
1511     OVSREC_PORT_FOR_EACH (port, idl) {
1512         ovsrec_port_set_other_config(port, NULL);
1513     }
1514
1515     OVSREC_INTERFACE_FOR_EACH (iface, idl) {
1516         /* xxx What do we do about gre/patch devices created by mgr? */
1517
1518         ovsrec_interface_set_ingress_policing_rate(iface, 0);
1519         ovsrec_interface_set_ingress_policing_burst(iface, 0);
1520     }
1521
1522     OVSREC_MIRROR_FOR_EACH_SAFE (mirror, next_mirror, idl) {
1523         ovsrec_mirror_delete(mirror);
1524     }
1525
1526     OVSREC_CONTROLLER_FOR_EACH_SAFE (ctrl, next_ctrl, idl) {
1527         ovsrec_controller_delete(ctrl);
1528     }
1529
1530     OVSREC_MANAGER_FOR_EACH_SAFE (mgr, next_mgr, idl) {
1531         ovsrec_manager_delete(mgr);
1532     }
1533
1534     OVSREC_NETFLOW_FOR_EACH_SAFE (nf, next_nf, idl) {
1535         ovsrec_netflow_delete(nf);
1536     }
1537
1538     OVSREC_SSL_FOR_EACH_SAFE (ssl, next_ssl, idl) {
1539         ovsrec_ssl_delete(ssl);
1540     }
1541
1542     OVSREC_SFLOW_FOR_EACH_SAFE (sflow, next_sflow, idl) {
1543         ovsrec_sflow_delete(sflow);
1544     }
1545
1546     OVSREC_IPFIX_FOR_EACH_SAFE (ipfix, next_ipfix, idl) {
1547         ovsrec_ipfix_delete(ipfix);
1548     }
1549
1550     OVSREC_FLOW_SAMPLE_COLLECTOR_SET_FOR_EACH_SAFE (fscset, next_fscset, idl) {
1551         ovsrec_flow_sample_collector_set_delete(fscset);
1552     }
1553
1554     vsctl_context_invalidate_cache(ctx);
1555 }
1556
1557 static void
1558 cmd_add_br(struct vsctl_context *ctx)
1559 {
1560     bool may_exist = shash_find(&ctx->options, "--may-exist") != NULL;
1561     const char *br_name, *parent_name;
1562     int vlan;
1563
1564     br_name = ctx->argv[1];
1565     if (ctx->argc == 2) {
1566         parent_name = NULL;
1567         vlan = 0;
1568     } else if (ctx->argc == 4) {
1569         parent_name = ctx->argv[2];
1570         vlan = atoi(ctx->argv[3]);
1571         if (vlan < 0 || vlan > 4095) {
1572             vsctl_fatal("%s: vlan must be between 0 and 4095", ctx->argv[0]);
1573         }
1574     } else {
1575         vsctl_fatal("'%s' command takes exactly 1 or 3 arguments",
1576                     ctx->argv[0]);
1577     }
1578
1579     vsctl_context_populate_cache(ctx);
1580     if (may_exist) {
1581         struct vsctl_bridge *br;
1582
1583         br = find_bridge(ctx, br_name, false);
1584         if (br) {
1585             if (!parent_name) {
1586                 if (br->parent) {
1587                     vsctl_fatal("\"--may-exist add-br %s\" but %s is "
1588                                 "a VLAN bridge for VLAN %d",
1589                                 br_name, br_name, br->vlan);
1590                 }
1591             } else {
1592                 if (!br->parent) {
1593                     vsctl_fatal("\"--may-exist add-br %s %s %d\" but %s "
1594                                 "is not a VLAN bridge",
1595                                 br_name, parent_name, vlan, br_name);
1596                 } else if (strcmp(br->parent->name, parent_name)) {
1597                     vsctl_fatal("\"--may-exist add-br %s %s %d\" but %s "
1598                                 "has the wrong parent %s",
1599                                 br_name, parent_name, vlan,
1600                                 br_name, br->parent->name);
1601                 } else if (br->vlan != vlan) {
1602                     vsctl_fatal("\"--may-exist add-br %s %s %d\" but %s "
1603                                 "is a VLAN bridge for the wrong VLAN %d",
1604                                 br_name, parent_name, vlan, br_name, br->vlan);
1605                 }
1606             }
1607             return;
1608         }
1609     }
1610     check_conflicts(ctx, br_name,
1611                     xasprintf("cannot create a bridge named %s", br_name));
1612
1613     if (!parent_name) {
1614         struct ovsrec_port *port;
1615         struct ovsrec_interface *iface;
1616         struct ovsrec_bridge *br;
1617
1618         iface = ovsrec_interface_insert(ctx->txn);
1619         ovsrec_interface_set_name(iface, br_name);
1620         ovsrec_interface_set_type(iface, "internal");
1621
1622         port = ovsrec_port_insert(ctx->txn);
1623         ovsrec_port_set_name(port, br_name);
1624         ovsrec_port_set_interfaces(port, &iface, 1);
1625
1626         br = ovsrec_bridge_insert(ctx->txn);
1627         ovsrec_bridge_set_name(br, br_name);
1628         ovsrec_bridge_set_ports(br, &port, 1);
1629
1630         ovs_insert_bridge(ctx->ovs, br);
1631     } else {
1632         struct vsctl_bridge *parent;
1633         struct ovsrec_port *port;
1634         struct ovsrec_interface *iface;
1635         struct ovsrec_bridge *br;
1636         int64_t tag = vlan;
1637
1638         parent = find_bridge(ctx, parent_name, false);
1639         if (parent && parent->parent) {
1640             vsctl_fatal("cannot create bridge with fake bridge as parent");
1641         }
1642         if (!parent) {
1643             vsctl_fatal("parent bridge %s does not exist", parent_name);
1644         }
1645         br = parent->br_cfg;
1646
1647         iface = ovsrec_interface_insert(ctx->txn);
1648         ovsrec_interface_set_name(iface, br_name);
1649         ovsrec_interface_set_type(iface, "internal");
1650
1651         port = ovsrec_port_insert(ctx->txn);
1652         ovsrec_port_set_name(port, br_name);
1653         ovsrec_port_set_interfaces(port, &iface, 1);
1654         ovsrec_port_set_fake_bridge(port, true);
1655         ovsrec_port_set_tag(port, &tag, 1);
1656
1657         bridge_insert_port(br, port);
1658     }
1659
1660     vsctl_context_invalidate_cache(ctx);
1661 }
1662
1663 static void
1664 del_port(struct vsctl_context *ctx, struct vsctl_port *port)
1665 {
1666     struct vsctl_iface *iface, *next_iface;
1667
1668     bridge_delete_port((port->bridge->parent
1669                         ? port->bridge->parent->br_cfg
1670                         : port->bridge->br_cfg), port->port_cfg);
1671
1672     LIST_FOR_EACH_SAFE (iface, next_iface, ifaces_node, &port->ifaces) {
1673         del_cached_iface(ctx, iface);
1674     }
1675     del_cached_port(ctx, port);
1676 }
1677
1678 static void
1679 del_bridge(struct vsctl_context *ctx, struct vsctl_bridge *br)
1680 {
1681     struct vsctl_bridge *child, *next_child;
1682     struct vsctl_port *port, *next_port;
1683     const struct ovsrec_flow_sample_collector_set *fscset, *next_fscset;
1684
1685     HMAP_FOR_EACH_SAFE (child, next_child, children_node, &br->children) {
1686         del_bridge(ctx, child);
1687     }
1688
1689     LIST_FOR_EACH_SAFE (port, next_port, ports_node, &br->ports) {
1690         del_port(ctx, port);
1691     }
1692
1693     OVSREC_FLOW_SAMPLE_COLLECTOR_SET_FOR_EACH_SAFE (fscset, next_fscset,
1694                                                     ctx->idl) {
1695         if (fscset->bridge == br->br_cfg) {
1696             ovsrec_flow_sample_collector_set_delete(fscset);
1697         }
1698     }
1699
1700     del_cached_bridge(ctx, br);
1701 }
1702
1703 static void
1704 cmd_del_br(struct vsctl_context *ctx)
1705 {
1706     bool must_exist = !shash_find(&ctx->options, "--if-exists");
1707     struct vsctl_bridge *bridge;
1708
1709     vsctl_context_populate_cache(ctx);
1710     bridge = find_bridge(ctx, ctx->argv[1], must_exist);
1711     if (bridge) {
1712         del_bridge(ctx, bridge);
1713     }
1714 }
1715
1716 static void
1717 output_sorted(struct svec *svec, struct ds *output)
1718 {
1719     const char *name;
1720     size_t i;
1721
1722     svec_sort(svec);
1723     SVEC_FOR_EACH (i, name, svec) {
1724         ds_put_format(output, "%s\n", name);
1725     }
1726 }
1727
1728 static void
1729 cmd_list_br(struct vsctl_context *ctx)
1730 {
1731     struct shash_node *node;
1732     struct svec bridges;
1733     bool real = shash_find(&ctx->options, "--real");
1734     bool fake = shash_find(&ctx->options, "--fake");
1735
1736     /* If neither fake nor real were requested, return both. */
1737     if (!real && !fake) {
1738         real = fake = true;
1739     }
1740
1741     vsctl_context_populate_cache(ctx);
1742
1743     svec_init(&bridges);
1744     SHASH_FOR_EACH (node, &ctx->bridges) {
1745         struct vsctl_bridge *br = node->data;
1746
1747         if (br->parent ? fake : real) {
1748             svec_add(&bridges, br->name);
1749         }
1750     }
1751     output_sorted(&bridges, &ctx->output);
1752     svec_destroy(&bridges);
1753 }
1754
1755 static void
1756 cmd_br_exists(struct vsctl_context *ctx)
1757 {
1758     vsctl_context_populate_cache(ctx);
1759     if (!find_bridge(ctx, ctx->argv[1], false)) {
1760         vsctl_exit(2);
1761     }
1762 }
1763
1764 static void
1765 set_external_id(struct smap *old, struct smap *new,
1766                 char *key, char *value)
1767 {
1768     smap_clone(new, old);
1769
1770     if (value) {
1771         smap_replace(new, key, value);
1772     } else {
1773         smap_remove(new, key);
1774     }
1775 }
1776
1777 static void
1778 pre_cmd_br_set_external_id(struct vsctl_context *ctx)
1779 {
1780     pre_get_info(ctx);
1781     ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_external_ids);
1782     ovsdb_idl_add_column(ctx->idl, &ovsrec_port_col_external_ids);
1783 }
1784
1785 static void
1786 cmd_br_set_external_id(struct vsctl_context *ctx)
1787 {
1788     struct vsctl_bridge *bridge;
1789     struct smap new;
1790
1791     vsctl_context_populate_cache(ctx);
1792     bridge = find_bridge(ctx, ctx->argv[1], true);
1793     if (bridge->br_cfg) {
1794
1795         set_external_id(&bridge->br_cfg->external_ids, &new, ctx->argv[2],
1796                         ctx->argc >= 4 ? ctx->argv[3] : NULL);
1797         ovsrec_bridge_verify_external_ids(bridge->br_cfg);
1798         ovsrec_bridge_set_external_ids(bridge->br_cfg, &new);
1799     } else {
1800         char *key = xasprintf("fake-bridge-%s", ctx->argv[2]);
1801         struct vsctl_port *port = shash_find_data(&ctx->ports, ctx->argv[1]);
1802         set_external_id(&port->port_cfg->external_ids, &new,
1803                         key, ctx->argc >= 4 ? ctx->argv[3] : NULL);
1804         ovsrec_port_verify_external_ids(port->port_cfg);
1805         ovsrec_port_set_external_ids(port->port_cfg, &new);
1806         free(key);
1807     }
1808     smap_destroy(&new);
1809 }
1810
1811 static void
1812 get_external_id(struct smap *smap, const char *prefix, const char *key,
1813                 struct ds *output)
1814 {
1815     if (key) {
1816         char *prefix_key = xasprintf("%s%s", prefix, key);
1817         const char *value = smap_get(smap, prefix_key);
1818
1819         if (value) {
1820             ds_put_format(output, "%s\n", value);
1821         }
1822         free(prefix_key);
1823     } else {
1824         const struct smap_node **sorted = smap_sort(smap);
1825         size_t prefix_len = strlen(prefix);
1826         size_t i;
1827
1828         for (i = 0; i < smap_count(smap); i++) {
1829             const struct smap_node *node = sorted[i];
1830             if (!strncmp(node->key, prefix, prefix_len)) {
1831                 ds_put_format(output, "%s=%s\n", node->key + prefix_len,
1832                               node->value);
1833             }
1834         }
1835         free(sorted);
1836     }
1837 }
1838
1839 static void
1840 pre_cmd_br_get_external_id(struct vsctl_context *ctx)
1841 {
1842     pre_cmd_br_set_external_id(ctx);
1843 }
1844
1845 static void
1846 cmd_br_get_external_id(struct vsctl_context *ctx)
1847 {
1848     struct vsctl_bridge *bridge;
1849
1850     vsctl_context_populate_cache(ctx);
1851
1852     bridge = find_bridge(ctx, ctx->argv[1], true);
1853     if (bridge->br_cfg) {
1854         ovsrec_bridge_verify_external_ids(bridge->br_cfg);
1855         get_external_id(&bridge->br_cfg->external_ids, "",
1856                         ctx->argc >= 3 ? ctx->argv[2] : NULL, &ctx->output);
1857     } else {
1858         struct vsctl_port *port = shash_find_data(&ctx->ports, ctx->argv[1]);
1859         ovsrec_port_verify_external_ids(port->port_cfg);
1860         get_external_id(&port->port_cfg->external_ids, "fake-bridge-",
1861                         ctx->argc >= 3 ? ctx->argv[2] : NULL, &ctx->output);
1862     }
1863 }
1864
1865 static void
1866 cmd_list_ports(struct vsctl_context *ctx)
1867 {
1868     struct vsctl_bridge *br;
1869     struct vsctl_port *port;
1870     struct svec ports;
1871
1872     vsctl_context_populate_cache(ctx);
1873     br = find_bridge(ctx, ctx->argv[1], true);
1874     ovsrec_bridge_verify_ports(br->br_cfg ? br->br_cfg : br->parent->br_cfg);
1875
1876     svec_init(&ports);
1877     LIST_FOR_EACH (port, ports_node, &br->ports) {
1878         if (strcmp(port->port_cfg->name, br->name)) {
1879             svec_add(&ports, port->port_cfg->name);
1880         }
1881     }
1882     output_sorted(&ports, &ctx->output);
1883     svec_destroy(&ports);
1884 }
1885
1886 static void
1887 add_port(struct vsctl_context *ctx,
1888          const char *br_name, const char *port_name,
1889          bool may_exist, bool fake_iface,
1890          char *iface_names[], int n_ifaces,
1891          char *settings[], int n_settings)
1892 {
1893     struct vsctl_port *vsctl_port;
1894     struct vsctl_bridge *bridge;
1895     struct ovsrec_interface **ifaces;
1896     struct ovsrec_port *port;
1897     size_t i;
1898
1899     vsctl_context_populate_cache(ctx);
1900     if (may_exist) {
1901         struct vsctl_port *vsctl_port;
1902
1903         vsctl_port = find_port(ctx, port_name, false);
1904         if (vsctl_port) {
1905             struct svec want_names, have_names;
1906
1907             svec_init(&want_names);
1908             for (i = 0; i < n_ifaces; i++) {
1909                 svec_add(&want_names, iface_names[i]);
1910             }
1911             svec_sort(&want_names);
1912
1913             svec_init(&have_names);
1914             for (i = 0; i < vsctl_port->port_cfg->n_interfaces; i++) {
1915                 svec_add(&have_names,
1916                          vsctl_port->port_cfg->interfaces[i]->name);
1917             }
1918             svec_sort(&have_names);
1919
1920             if (strcmp(vsctl_port->bridge->name, br_name)) {
1921                 char *command = vsctl_context_to_string(ctx);
1922                 vsctl_fatal("\"%s\" but %s is actually attached to bridge %s",
1923                             command, port_name, vsctl_port->bridge->name);
1924             }
1925
1926             if (!svec_equal(&want_names, &have_names)) {
1927                 char *have_names_string = svec_join(&have_names, ", ", "");
1928                 char *command = vsctl_context_to_string(ctx);
1929
1930                 vsctl_fatal("\"%s\" but %s actually has interface(s) %s",
1931                             command, port_name, have_names_string);
1932             }
1933
1934             svec_destroy(&want_names);
1935             svec_destroy(&have_names);
1936
1937             return;
1938         }
1939     }
1940     check_conflicts(ctx, port_name,
1941                     xasprintf("cannot create a port named %s", port_name));
1942     for (i = 0; i < n_ifaces; i++) {
1943         check_conflicts(ctx, iface_names[i],
1944                         xasprintf("cannot create an interface named %s",
1945                                   iface_names[i]));
1946     }
1947     bridge = find_bridge(ctx, br_name, true);
1948
1949     ifaces = xmalloc(n_ifaces * sizeof *ifaces);
1950     for (i = 0; i < n_ifaces; i++) {
1951         ifaces[i] = ovsrec_interface_insert(ctx->txn);
1952         ovsrec_interface_set_name(ifaces[i], iface_names[i]);
1953     }
1954
1955     port = ovsrec_port_insert(ctx->txn);
1956     ovsrec_port_set_name(port, port_name);
1957     ovsrec_port_set_interfaces(port, ifaces, n_ifaces);
1958     ovsrec_port_set_bond_fake_iface(port, fake_iface);
1959
1960     if (bridge->parent) {
1961         int64_t tag = bridge->vlan;
1962         ovsrec_port_set_tag(port, &tag, 1);
1963     }
1964
1965     for (i = 0; i < n_settings; i++) {
1966         set_column(get_table("Port"), &port->header_, settings[i],
1967                    ctx->symtab);
1968     }
1969
1970     bridge_insert_port((bridge->parent ? bridge->parent->br_cfg
1971                         : bridge->br_cfg), port);
1972
1973     vsctl_port = add_port_to_cache(ctx, bridge, port);
1974     for (i = 0; i < n_ifaces; i++) {
1975         add_iface_to_cache(ctx, vsctl_port, ifaces[i]);
1976     }
1977     free(ifaces);
1978 }
1979
1980 static void
1981 cmd_add_port(struct vsctl_context *ctx)
1982 {
1983     bool may_exist = shash_find(&ctx->options, "--may-exist") != NULL;
1984
1985     add_port(ctx, ctx->argv[1], ctx->argv[2], may_exist, false,
1986              &ctx->argv[2], 1, &ctx->argv[3], ctx->argc - 3);
1987 }
1988
1989 static void
1990 cmd_add_bond(struct vsctl_context *ctx)
1991 {
1992     bool may_exist = shash_find(&ctx->options, "--may-exist") != NULL;
1993     bool fake_iface = shash_find(&ctx->options, "--fake-iface");
1994     int n_ifaces;
1995     int i;
1996
1997     n_ifaces = ctx->argc - 3;
1998     for (i = 3; i < ctx->argc; i++) {
1999         if (strchr(ctx->argv[i], '=')) {
2000             n_ifaces = i - 3;
2001             break;
2002         }
2003     }
2004     if (n_ifaces < 2) {
2005         vsctl_fatal("add-bond requires at least 2 interfaces, but only "
2006                     "%d were specified", n_ifaces);
2007     }
2008
2009     add_port(ctx, ctx->argv[1], ctx->argv[2], may_exist, fake_iface,
2010              &ctx->argv[3], n_ifaces,
2011              &ctx->argv[n_ifaces + 3], ctx->argc - 3 - n_ifaces);
2012 }
2013
2014 static void
2015 cmd_del_port(struct vsctl_context *ctx)
2016 {
2017     bool must_exist = !shash_find(&ctx->options, "--if-exists");
2018     bool with_iface = shash_find(&ctx->options, "--with-iface") != NULL;
2019     struct vsctl_port *port;
2020
2021     vsctl_context_populate_cache(ctx);
2022     if (!with_iface) {
2023         port = find_port(ctx, ctx->argv[ctx->argc - 1], must_exist);
2024     } else {
2025         const char *target = ctx->argv[ctx->argc - 1];
2026         struct vsctl_iface *iface;
2027
2028         port = find_port(ctx, target, false);
2029         if (!port) {
2030             iface = find_iface(ctx, target, false);
2031             if (iface) {
2032                 port = iface->port;
2033             }
2034         }
2035         if (must_exist && !port) {
2036             vsctl_fatal("no port or interface named %s", target);
2037         }
2038     }
2039
2040     if (port) {
2041         if (ctx->argc == 3) {
2042             struct vsctl_bridge *bridge;
2043
2044             bridge = find_bridge(ctx, ctx->argv[1], true);
2045             if (port->bridge != bridge) {
2046                 if (port->bridge->parent == bridge) {
2047                     vsctl_fatal("bridge %s does not have a port %s (although "
2048                                 "its parent bridge %s does)",
2049                                 ctx->argv[1], ctx->argv[2],
2050                                 bridge->parent->name);
2051                 } else {
2052                     vsctl_fatal("bridge %s does not have a port %s",
2053                                 ctx->argv[1], ctx->argv[2]);
2054                 }
2055             }
2056         }
2057
2058         del_port(ctx, port);
2059     }
2060 }
2061
2062 static void
2063 cmd_port_to_br(struct vsctl_context *ctx)
2064 {
2065     struct vsctl_port *port;
2066
2067     vsctl_context_populate_cache(ctx);
2068
2069     port = find_port(ctx, ctx->argv[1], true);
2070     ds_put_format(&ctx->output, "%s\n", port->bridge->name);
2071 }
2072
2073 static void
2074 cmd_br_to_vlan(struct vsctl_context *ctx)
2075 {
2076     struct vsctl_bridge *bridge;
2077
2078     vsctl_context_populate_cache(ctx);
2079
2080     bridge = find_bridge(ctx, ctx->argv[1], true);
2081     ds_put_format(&ctx->output, "%d\n", bridge->vlan);
2082 }
2083
2084 static void
2085 cmd_br_to_parent(struct vsctl_context *ctx)
2086 {
2087     struct vsctl_bridge *bridge;
2088
2089     vsctl_context_populate_cache(ctx);
2090
2091     bridge = find_bridge(ctx, ctx->argv[1], true);
2092     if (bridge->parent) {
2093         bridge = bridge->parent;
2094     }
2095     ds_put_format(&ctx->output, "%s\n", bridge->name);
2096 }
2097
2098 static void
2099 cmd_list_ifaces(struct vsctl_context *ctx)
2100 {
2101     struct vsctl_bridge *br;
2102     struct vsctl_port *port;
2103     struct svec ifaces;
2104
2105     vsctl_context_populate_cache(ctx);
2106
2107     br = find_bridge(ctx, ctx->argv[1], true);
2108     verify_ports(ctx);
2109
2110     svec_init(&ifaces);
2111     LIST_FOR_EACH (port, ports_node, &br->ports) {
2112         struct vsctl_iface *iface;
2113
2114         LIST_FOR_EACH (iface, ifaces_node, &port->ifaces) {
2115             if (strcmp(iface->iface_cfg->name, br->name)) {
2116                 svec_add(&ifaces, iface->iface_cfg->name);
2117             }
2118         }
2119     }
2120     output_sorted(&ifaces, &ctx->output);
2121     svec_destroy(&ifaces);
2122 }
2123
2124 static void
2125 cmd_iface_to_br(struct vsctl_context *ctx)
2126 {
2127     struct vsctl_iface *iface;
2128
2129     vsctl_context_populate_cache(ctx);
2130
2131     iface = find_iface(ctx, ctx->argv[1], true);
2132     ds_put_format(&ctx->output, "%s\n", iface->port->bridge->name);
2133 }
2134
2135 static void
2136 verify_controllers(struct ovsrec_bridge *bridge)
2137 {
2138     size_t i;
2139
2140     ovsrec_bridge_verify_controller(bridge);
2141     for (i = 0; i < bridge->n_controller; i++) {
2142         ovsrec_controller_verify_target(bridge->controller[i]);
2143     }
2144 }
2145
2146 static void
2147 pre_controller(struct vsctl_context *ctx)
2148 {
2149     pre_get_info(ctx);
2150
2151     ovsdb_idl_add_column(ctx->idl, &ovsrec_controller_col_target);
2152 }
2153
2154 static void
2155 cmd_get_controller(struct vsctl_context *ctx)
2156 {
2157     struct vsctl_bridge *br;
2158     struct svec targets;
2159     size_t i;
2160
2161     vsctl_context_populate_cache(ctx);
2162
2163     br = find_bridge(ctx, ctx->argv[1], true);
2164     if (br->parent) {
2165         br = br->parent;
2166     }
2167     verify_controllers(br->br_cfg);
2168
2169     /* Print the targets in sorted order for reproducibility. */
2170     svec_init(&targets);
2171     for (i = 0; i < br->br_cfg->n_controller; i++) {
2172         svec_add(&targets, br->br_cfg->controller[i]->target);
2173     }
2174
2175     svec_sort(&targets);
2176     for (i = 0; i < targets.n; i++) {
2177         ds_put_format(&ctx->output, "%s\n", targets.names[i]);
2178     }
2179     svec_destroy(&targets);
2180 }
2181
2182 static void
2183 delete_controllers(struct ovsrec_controller **controllers,
2184                    size_t n_controllers)
2185 {
2186     size_t i;
2187
2188     for (i = 0; i < n_controllers; i++) {
2189         ovsrec_controller_delete(controllers[i]);
2190     }
2191 }
2192
2193 static void
2194 cmd_del_controller(struct vsctl_context *ctx)
2195 {
2196     struct ovsrec_bridge *br;
2197
2198     vsctl_context_populate_cache(ctx);
2199
2200     br = find_real_bridge(ctx, ctx->argv[1], true)->br_cfg;
2201     verify_controllers(br);
2202
2203     if (br->controller) {
2204         delete_controllers(br->controller, br->n_controller);
2205         ovsrec_bridge_set_controller(br, NULL, 0);
2206     }
2207 }
2208
2209 static struct ovsrec_controller **
2210 insert_controllers(struct ovsdb_idl_txn *txn, char *targets[], size_t n)
2211 {
2212     struct ovsrec_controller **controllers;
2213     size_t i;
2214
2215     controllers = xmalloc(n * sizeof *controllers);
2216     for (i = 0; i < n; i++) {
2217         if (vconn_verify_name(targets[i]) && pvconn_verify_name(targets[i])) {
2218             VLOG_WARN("target type \"%s\" is possibly erroneous", targets[i]);
2219         }
2220         controllers[i] = ovsrec_controller_insert(txn);
2221         ovsrec_controller_set_target(controllers[i], targets[i]);
2222     }
2223
2224     return controllers;
2225 }
2226
2227 static void
2228 cmd_set_controller(struct vsctl_context *ctx)
2229 {
2230     struct ovsrec_controller **controllers;
2231     struct ovsrec_bridge *br;
2232     size_t n;
2233
2234     vsctl_context_populate_cache(ctx);
2235
2236     br = find_real_bridge(ctx, ctx->argv[1], true)->br_cfg;
2237     verify_controllers(br);
2238
2239     delete_controllers(br->controller, br->n_controller);
2240
2241     n = ctx->argc - 2;
2242     controllers = insert_controllers(ctx->txn, &ctx->argv[2], n);
2243     ovsrec_bridge_set_controller(br, controllers, n);
2244     free(controllers);
2245 }
2246
2247 static void
2248 cmd_get_fail_mode(struct vsctl_context *ctx)
2249 {
2250     struct vsctl_bridge *br;
2251     const char *fail_mode;
2252
2253     vsctl_context_populate_cache(ctx);
2254     br = find_bridge(ctx, ctx->argv[1], true);
2255
2256     if (br->parent) {
2257         br = br->parent;
2258     }
2259     ovsrec_bridge_verify_fail_mode(br->br_cfg);
2260
2261     fail_mode = br->br_cfg->fail_mode;
2262     if (fail_mode && strlen(fail_mode)) {
2263         ds_put_format(&ctx->output, "%s\n", fail_mode);
2264     }
2265 }
2266
2267 static void
2268 cmd_del_fail_mode(struct vsctl_context *ctx)
2269 {
2270     struct vsctl_bridge *br;
2271
2272     vsctl_context_populate_cache(ctx);
2273
2274     br = find_real_bridge(ctx, ctx->argv[1], true);
2275
2276     ovsrec_bridge_set_fail_mode(br->br_cfg, NULL);
2277 }
2278
2279 static void
2280 cmd_set_fail_mode(struct vsctl_context *ctx)
2281 {
2282     struct vsctl_bridge *br;
2283     const char *fail_mode = ctx->argv[2];
2284
2285     vsctl_context_populate_cache(ctx);
2286
2287     br = find_real_bridge(ctx, ctx->argv[1], true);
2288
2289     if (strcmp(fail_mode, "standalone") && strcmp(fail_mode, "secure")) {
2290         vsctl_fatal("fail-mode must be \"standalone\" or \"secure\"");
2291     }
2292
2293     ovsrec_bridge_set_fail_mode(br->br_cfg, fail_mode);
2294 }
2295
2296 static void
2297 verify_managers(const struct ovsrec_open_vswitch *ovs)
2298 {
2299     size_t i;
2300
2301     ovsrec_open_vswitch_verify_manager_options(ovs);
2302
2303     for (i = 0; i < ovs->n_manager_options; ++i) {
2304         const struct ovsrec_manager *mgr = ovs->manager_options[i];
2305
2306         ovsrec_manager_verify_target(mgr);
2307     }
2308 }
2309
2310 static void
2311 pre_manager(struct vsctl_context *ctx)
2312 {
2313     ovsdb_idl_add_column(ctx->idl, &ovsrec_open_vswitch_col_manager_options);
2314     ovsdb_idl_add_column(ctx->idl, &ovsrec_manager_col_target);
2315 }
2316
2317 static void
2318 cmd_get_manager(struct vsctl_context *ctx)
2319 {
2320     const struct ovsrec_open_vswitch *ovs = ctx->ovs;
2321     struct svec targets;
2322     size_t i;
2323
2324     verify_managers(ovs);
2325
2326     /* Print the targets in sorted order for reproducibility. */
2327     svec_init(&targets);
2328
2329     for (i = 0; i < ovs->n_manager_options; i++) {
2330         svec_add(&targets, ovs->manager_options[i]->target);
2331     }
2332
2333     svec_sort_unique(&targets);
2334     for (i = 0; i < targets.n; i++) {
2335         ds_put_format(&ctx->output, "%s\n", targets.names[i]);
2336     }
2337     svec_destroy(&targets);
2338 }
2339
2340 static void
2341 delete_managers(const struct vsctl_context *ctx)
2342 {
2343     const struct ovsrec_open_vswitch *ovs = ctx->ovs;
2344     size_t i;
2345
2346     /* Delete Manager rows pointed to by 'manager_options' column. */
2347     for (i = 0; i < ovs->n_manager_options; i++) {
2348         ovsrec_manager_delete(ovs->manager_options[i]);
2349     }
2350
2351     /* Delete 'Manager' row refs in 'manager_options' column. */
2352     ovsrec_open_vswitch_set_manager_options(ovs, NULL, 0);
2353 }
2354
2355 static void
2356 cmd_del_manager(struct vsctl_context *ctx)
2357 {
2358     const struct ovsrec_open_vswitch *ovs = ctx->ovs;
2359
2360     verify_managers(ovs);
2361     delete_managers(ctx);
2362 }
2363
2364 static void
2365 insert_managers(struct vsctl_context *ctx, char *targets[], size_t n)
2366 {
2367     struct ovsrec_manager **managers;
2368     size_t i;
2369
2370     /* Insert each manager in a new row in Manager table. */
2371     managers = xmalloc(n * sizeof *managers);
2372     for (i = 0; i < n; i++) {
2373         if (stream_verify_name(targets[i]) && pstream_verify_name(targets[i])) {
2374             VLOG_WARN("target type \"%s\" is possibly erroneous", targets[i]);
2375         }
2376         managers[i] = ovsrec_manager_insert(ctx->txn);
2377         ovsrec_manager_set_target(managers[i], targets[i]);
2378     }
2379
2380     /* Store uuids of new Manager rows in 'manager_options' column. */
2381     ovsrec_open_vswitch_set_manager_options(ctx->ovs, managers, n);
2382     free(managers);
2383 }
2384
2385 static void
2386 cmd_set_manager(struct vsctl_context *ctx)
2387 {
2388     const size_t n = ctx->argc - 1;
2389
2390     verify_managers(ctx->ovs);
2391     delete_managers(ctx);
2392     insert_managers(ctx, &ctx->argv[1], n);
2393 }
2394
2395 static void
2396 pre_cmd_get_ssl(struct vsctl_context *ctx)
2397 {
2398     ovsdb_idl_add_column(ctx->idl, &ovsrec_open_vswitch_col_ssl);
2399
2400     ovsdb_idl_add_column(ctx->idl, &ovsrec_ssl_col_private_key);
2401     ovsdb_idl_add_column(ctx->idl, &ovsrec_ssl_col_certificate);
2402     ovsdb_idl_add_column(ctx->idl, &ovsrec_ssl_col_ca_cert);
2403     ovsdb_idl_add_column(ctx->idl, &ovsrec_ssl_col_bootstrap_ca_cert);
2404 }
2405
2406 static void
2407 cmd_get_ssl(struct vsctl_context *ctx)
2408 {
2409     struct ovsrec_ssl *ssl = ctx->ovs->ssl;
2410
2411     ovsrec_open_vswitch_verify_ssl(ctx->ovs);
2412     if (ssl) {
2413         ovsrec_ssl_verify_private_key(ssl);
2414         ovsrec_ssl_verify_certificate(ssl);
2415         ovsrec_ssl_verify_ca_cert(ssl);
2416         ovsrec_ssl_verify_bootstrap_ca_cert(ssl);
2417
2418         ds_put_format(&ctx->output, "Private key: %s\n", ssl->private_key);
2419         ds_put_format(&ctx->output, "Certificate: %s\n", ssl->certificate);
2420         ds_put_format(&ctx->output, "CA Certificate: %s\n", ssl->ca_cert);
2421         ds_put_format(&ctx->output, "Bootstrap: %s\n",
2422                 ssl->bootstrap_ca_cert ? "true" : "false");
2423     }
2424 }
2425
2426 static void
2427 pre_cmd_del_ssl(struct vsctl_context *ctx)
2428 {
2429     ovsdb_idl_add_column(ctx->idl, &ovsrec_open_vswitch_col_ssl);
2430 }
2431
2432 static void
2433 cmd_del_ssl(struct vsctl_context *ctx)
2434 {
2435     struct ovsrec_ssl *ssl = ctx->ovs->ssl;
2436
2437     if (ssl) {
2438         ovsrec_open_vswitch_verify_ssl(ctx->ovs);
2439         ovsrec_ssl_delete(ssl);
2440         ovsrec_open_vswitch_set_ssl(ctx->ovs, NULL);
2441     }
2442 }
2443
2444 static void
2445 pre_cmd_set_ssl(struct vsctl_context *ctx)
2446 {
2447     ovsdb_idl_add_column(ctx->idl, &ovsrec_open_vswitch_col_ssl);
2448 }
2449
2450 static void
2451 cmd_set_ssl(struct vsctl_context *ctx)
2452 {
2453     bool bootstrap = shash_find(&ctx->options, "--bootstrap");
2454     struct ovsrec_ssl *ssl = ctx->ovs->ssl;
2455
2456     ovsrec_open_vswitch_verify_ssl(ctx->ovs);
2457     if (ssl) {
2458         ovsrec_ssl_delete(ssl);
2459     }
2460     ssl = ovsrec_ssl_insert(ctx->txn);
2461
2462     ovsrec_ssl_set_private_key(ssl, ctx->argv[1]);
2463     ovsrec_ssl_set_certificate(ssl, ctx->argv[2]);
2464     ovsrec_ssl_set_ca_cert(ssl, ctx->argv[3]);
2465
2466     ovsrec_ssl_set_bootstrap_ca_cert(ssl, bootstrap);
2467
2468     ovsrec_open_vswitch_set_ssl(ctx->ovs, ssl);
2469 }
2470 \f
2471 /* Parameter commands. */
2472
2473 struct vsctl_row_id {
2474     const struct ovsdb_idl_table_class *table;
2475     const struct ovsdb_idl_column *name_column;
2476     const struct ovsdb_idl_column *uuid_column;
2477 };
2478
2479 struct vsctl_table_class {
2480     struct ovsdb_idl_table_class *class;
2481     struct vsctl_row_id row_ids[2];
2482 };
2483
2484 static const struct vsctl_table_class tables[] = {
2485     {&ovsrec_table_bridge,
2486      {{&ovsrec_table_bridge, &ovsrec_bridge_col_name, NULL},
2487       {&ovsrec_table_flow_sample_collector_set, NULL,
2488        &ovsrec_flow_sample_collector_set_col_bridge}}},
2489
2490     {&ovsrec_table_controller,
2491      {{&ovsrec_table_bridge,
2492        &ovsrec_bridge_col_name,
2493        &ovsrec_bridge_col_controller}}},
2494
2495     {&ovsrec_table_interface,
2496      {{&ovsrec_table_interface, &ovsrec_interface_col_name, NULL},
2497       {NULL, NULL, NULL}}},
2498
2499     {&ovsrec_table_mirror,
2500      {{&ovsrec_table_mirror, &ovsrec_mirror_col_name, NULL},
2501       {NULL, NULL, NULL}}},
2502
2503     {&ovsrec_table_manager,
2504      {{&ovsrec_table_manager, &ovsrec_manager_col_target, NULL},
2505       {NULL, NULL, NULL}}},
2506
2507     {&ovsrec_table_netflow,
2508      {{&ovsrec_table_bridge,
2509        &ovsrec_bridge_col_name,
2510        &ovsrec_bridge_col_netflow},
2511       {NULL, NULL, NULL}}},
2512
2513     {&ovsrec_table_open_vswitch,
2514      {{&ovsrec_table_open_vswitch, NULL, NULL},
2515       {NULL, NULL, NULL}}},
2516
2517     {&ovsrec_table_port,
2518      {{&ovsrec_table_port, &ovsrec_port_col_name, NULL},
2519       {NULL, NULL, NULL}}},
2520
2521     {&ovsrec_table_qos,
2522      {{&ovsrec_table_port, &ovsrec_port_col_name, &ovsrec_port_col_qos},
2523       {NULL, NULL, NULL}}},
2524
2525     {&ovsrec_table_queue,
2526      {{NULL, NULL, NULL},
2527       {NULL, NULL, NULL}}},
2528
2529     {&ovsrec_table_ssl,
2530      {{&ovsrec_table_open_vswitch, NULL, &ovsrec_open_vswitch_col_ssl}}},
2531
2532     {&ovsrec_table_sflow,
2533      {{&ovsrec_table_bridge,
2534        &ovsrec_bridge_col_name,
2535        &ovsrec_bridge_col_sflow},
2536       {NULL, NULL, NULL}}},
2537
2538     {&ovsrec_table_flow_table,
2539      {{&ovsrec_table_flow_table, &ovsrec_flow_table_col_name, NULL},
2540       {NULL, NULL, NULL}}},
2541
2542     {&ovsrec_table_ipfix,
2543      {{&ovsrec_table_bridge,
2544        &ovsrec_bridge_col_name,
2545        &ovsrec_bridge_col_ipfix},
2546       {&ovsrec_table_flow_sample_collector_set, NULL,
2547        &ovsrec_flow_sample_collector_set_col_ipfix}}},
2548
2549     {&ovsrec_table_flow_sample_collector_set,
2550      {{NULL, NULL, NULL},
2551       {NULL, NULL, NULL}}},
2552
2553     {NULL, {{NULL, NULL, NULL}, {NULL, NULL, NULL}}}
2554 };
2555
2556 static void
2557 die_if_error(char *error)
2558 {
2559     if (error) {
2560         vsctl_fatal("%s", error);
2561     }
2562 }
2563
2564 static int
2565 to_lower_and_underscores(unsigned c)
2566 {
2567     return c == '-' ? '_' : tolower(c);
2568 }
2569
2570 static unsigned int
2571 score_partial_match(const char *name, const char *s)
2572 {
2573     int score;
2574
2575     if (!strcmp(name, s)) {
2576         return UINT_MAX;
2577     }
2578     for (score = 0; ; score++, name++, s++) {
2579         if (to_lower_and_underscores(*name) != to_lower_and_underscores(*s)) {
2580             break;
2581         } else if (*name == '\0') {
2582             return UINT_MAX - 1;
2583         }
2584     }
2585     return *s == '\0' ? score : 0;
2586 }
2587
2588 static const struct vsctl_table_class *
2589 get_table(const char *table_name)
2590 {
2591     const struct vsctl_table_class *table;
2592     const struct vsctl_table_class *best_match = NULL;
2593     unsigned int best_score = 0;
2594
2595     for (table = tables; table->class; table++) {
2596         unsigned int score = score_partial_match(table->class->name,
2597                                                  table_name);
2598         if (score > best_score) {
2599             best_match = table;
2600             best_score = score;
2601         } else if (score == best_score) {
2602             best_match = NULL;
2603         }
2604     }
2605     if (best_match) {
2606         return best_match;
2607     } else if (best_score) {
2608         vsctl_fatal("multiple table names match \"%s\"", table_name);
2609     } else {
2610         vsctl_fatal("unknown table \"%s\"", table_name);
2611     }
2612 }
2613
2614 static const struct vsctl_table_class *
2615 pre_get_table(struct vsctl_context *ctx, const char *table_name)
2616 {
2617     const struct vsctl_table_class *table_class;
2618     int i;
2619
2620     table_class = get_table(table_name);
2621     ovsdb_idl_add_table(ctx->idl, table_class->class);
2622
2623     for (i = 0; i < ARRAY_SIZE(table_class->row_ids); i++) {
2624         const struct vsctl_row_id *id = &table_class->row_ids[i];
2625         if (id->table) {
2626             ovsdb_idl_add_table(ctx->idl, id->table);
2627         }
2628         if (id->name_column) {
2629             ovsdb_idl_add_column(ctx->idl, id->name_column);
2630         }
2631         if (id->uuid_column) {
2632             ovsdb_idl_add_column(ctx->idl, id->uuid_column);
2633         }
2634     }
2635
2636     return table_class;
2637 }
2638
2639 static const struct ovsdb_idl_row *
2640 get_row_by_id(struct vsctl_context *ctx, const struct vsctl_table_class *table,
2641               const struct vsctl_row_id *id, const char *record_id)
2642 {
2643     const struct ovsdb_idl_row *referrer, *final;
2644
2645     if (!id->table) {
2646         return NULL;
2647     }
2648
2649     if (!id->name_column) {
2650         if (strcmp(record_id, ".")) {
2651             return NULL;
2652         }
2653         referrer = ovsdb_idl_first_row(ctx->idl, id->table);
2654         if (!referrer || ovsdb_idl_next_row(referrer)) {
2655             return NULL;
2656         }
2657     } else {
2658         const struct ovsdb_idl_row *row;
2659
2660         referrer = NULL;
2661         for (row = ovsdb_idl_first_row(ctx->idl, id->table);
2662              row != NULL;
2663              row = ovsdb_idl_next_row(row))
2664         {
2665             const struct ovsdb_datum *name;
2666
2667             name = ovsdb_idl_get(row, id->name_column,
2668                                  OVSDB_TYPE_STRING, OVSDB_TYPE_VOID);
2669             if (name->n == 1 && !strcmp(name->keys[0].string, record_id)) {
2670                 if (referrer) {
2671                     vsctl_fatal("multiple rows in %s match \"%s\"",
2672                                 table->class->name, record_id);
2673                 }
2674                 referrer = row;
2675             }
2676         }
2677     }
2678     if (!referrer) {
2679         return NULL;
2680     }
2681
2682     final = NULL;
2683     if (id->uuid_column) {
2684         const struct ovsdb_datum *uuid;
2685
2686         ovsdb_idl_txn_verify(referrer, id->uuid_column);
2687         uuid = ovsdb_idl_get(referrer, id->uuid_column,
2688                              OVSDB_TYPE_UUID, OVSDB_TYPE_VOID);
2689         if (uuid->n == 1) {
2690             final = ovsdb_idl_get_row_for_uuid(ctx->idl, table->class,
2691                                                &uuid->keys[0].uuid);
2692         }
2693     } else {
2694         final = referrer;
2695     }
2696
2697     return final;
2698 }
2699
2700 static const struct ovsdb_idl_row *
2701 get_row (struct vsctl_context *ctx,
2702          const struct vsctl_table_class *table, const char *record_id,
2703          bool must_exist)
2704 {
2705     const struct ovsdb_idl_row *row;
2706     struct uuid uuid;
2707
2708     if (uuid_from_string(&uuid, record_id)) {
2709         row = ovsdb_idl_get_row_for_uuid(ctx->idl, table->class, &uuid);
2710     } else {
2711         int i;
2712
2713         for (i = 0; i < ARRAY_SIZE(table->row_ids); i++) {
2714             row = get_row_by_id(ctx, table, &table->row_ids[i], record_id);
2715             if (row) {
2716                 break;
2717             }
2718         }
2719     }
2720     if (must_exist && !row) {
2721         vsctl_fatal("no row \"%s\" in table %s",
2722                     record_id, table->class->name);
2723     }
2724     return row;
2725 }
2726
2727 static char *
2728 get_column(const struct vsctl_table_class *table, const char *column_name,
2729            const struct ovsdb_idl_column **columnp)
2730 {
2731     const struct ovsdb_idl_column *best_match = NULL;
2732     unsigned int best_score = 0;
2733     size_t i;
2734
2735     for (i = 0; i < table->class->n_columns; i++) {
2736         const struct ovsdb_idl_column *column = &table->class->columns[i];
2737         unsigned int score = score_partial_match(column->name, column_name);
2738         if (score > best_score) {
2739             best_match = column;
2740             best_score = score;
2741         } else if (score == best_score) {
2742             best_match = NULL;
2743         }
2744     }
2745
2746     *columnp = best_match;
2747     if (best_match) {
2748         return NULL;
2749     } else if (best_score) {
2750         return xasprintf("%s contains more than one column whose name "
2751                          "matches \"%s\"", table->class->name, column_name);
2752     } else {
2753         return xasprintf("%s does not contain a column whose name matches "
2754                          "\"%s\"", table->class->name, column_name);
2755     }
2756 }
2757
2758 static struct ovsdb_symbol *
2759 create_symbol(struct ovsdb_symbol_table *symtab, const char *id, bool *newp)
2760 {
2761     struct ovsdb_symbol *symbol;
2762
2763     if (id[0] != '@') {
2764         vsctl_fatal("row id \"%s\" does not begin with \"@\"", id);
2765     }
2766
2767     if (newp) {
2768         *newp = ovsdb_symbol_table_get(symtab, id) == NULL;
2769     }
2770
2771     symbol = ovsdb_symbol_table_insert(symtab, id);
2772     if (symbol->created) {
2773         vsctl_fatal("row id \"%s\" may only be specified on one --id option",
2774                     id);
2775     }
2776     symbol->created = true;
2777     return symbol;
2778 }
2779
2780 static void
2781 pre_get_column(struct vsctl_context *ctx,
2782                const struct vsctl_table_class *table, const char *column_name,
2783                const struct ovsdb_idl_column **columnp)
2784 {
2785     die_if_error(get_column(table, column_name, columnp));
2786     ovsdb_idl_add_column(ctx->idl, *columnp);
2787 }
2788
2789 static char *
2790 missing_operator_error(const char *arg, const char **allowed_operators,
2791                        size_t n_allowed)
2792 {
2793     struct ds s;
2794
2795     ds_init(&s);
2796     ds_put_format(&s, "%s: argument does not end in ", arg);
2797     ds_put_format(&s, "\"%s\"", allowed_operators[0]);
2798     if (n_allowed == 2) {
2799         ds_put_format(&s, " or \"%s\"", allowed_operators[1]);
2800     } else if (n_allowed > 2) {
2801         size_t i;
2802
2803         for (i = 1; i < n_allowed - 1; i++) {
2804             ds_put_format(&s, ", \"%s\"", allowed_operators[i]);
2805         }
2806         ds_put_format(&s, ", or \"%s\"", allowed_operators[i]);
2807     }
2808     ds_put_format(&s, " followed by a value.");
2809
2810     return ds_steal_cstr(&s);
2811 }
2812
2813 /* Breaks 'arg' apart into a number of fields in the following order:
2814  *
2815  *      - The name of a column in 'table', stored into '*columnp'.  The column
2816  *        name may be abbreviated.
2817  *
2818  *      - Optionally ':' followed by a key string.  The key is stored as a
2819  *        malloc()'d string into '*keyp', or NULL if no key is present in
2820  *        'arg'.
2821  *
2822  *      - If 'valuep' is nonnull, an operator followed by a value string.  The
2823  *        allowed operators are the 'n_allowed' string in 'allowed_operators',
2824  *        or just "=" if 'n_allowed' is 0.  If 'operatorp' is nonnull, then the
2825  *        index of the operator within 'allowed_operators' is stored into
2826  *        '*operatorp'.  The value is stored as a malloc()'d string into
2827  *        '*valuep', or NULL if no value is present in 'arg'.
2828  *
2829  * On success, returns NULL.  On failure, returned a malloc()'d string error
2830  * message and stores NULL into all of the nonnull output arguments. */
2831 static char * WARN_UNUSED_RESULT
2832 parse_column_key_value(const char *arg,
2833                        const struct vsctl_table_class *table,
2834                        const struct ovsdb_idl_column **columnp, char **keyp,
2835                        int *operatorp,
2836                        const char **allowed_operators, size_t n_allowed,
2837                        char **valuep)
2838 {
2839     const char *p = arg;
2840     char *column_name;
2841     char *error;
2842
2843     ovs_assert(!(operatorp && !valuep));
2844     *keyp = NULL;
2845     if (valuep) {
2846         *valuep = NULL;
2847     }
2848
2849     /* Parse column name. */
2850     error = ovsdb_token_parse(&p, &column_name);
2851     if (error) {
2852         goto error;
2853     }
2854     if (column_name[0] == '\0') {
2855         free(column_name);
2856         error = xasprintf("%s: missing column name", arg);
2857         goto error;
2858     }
2859     error = get_column(table, column_name, columnp);
2860     free(column_name);
2861     if (error) {
2862         goto error;
2863     }
2864
2865     /* Parse key string. */
2866     if (*p == ':') {
2867         p++;
2868         error = ovsdb_token_parse(&p, keyp);
2869         if (error) {
2870             goto error;
2871         }
2872     }
2873
2874     /* Parse value string. */
2875     if (valuep) {
2876         size_t best_len;
2877         size_t i;
2878         int best;
2879
2880         if (!allowed_operators) {
2881             static const char *equals = "=";
2882             allowed_operators = &equals;
2883             n_allowed = 1;
2884         }
2885
2886         best = -1;
2887         best_len = 0;
2888         for (i = 0; i < n_allowed; i++) {
2889             const char *op = allowed_operators[i];
2890             size_t op_len = strlen(op);
2891
2892             if (op_len > best_len && !strncmp(op, p, op_len) && p[op_len]) {
2893                 best_len = op_len;
2894                 best = i;
2895             }
2896         }
2897         if (best < 0) {
2898             error = missing_operator_error(arg, allowed_operators, n_allowed);
2899             goto error;
2900         }
2901
2902         if (operatorp) {
2903             *operatorp = best;
2904         }
2905         *valuep = xstrdup(p + best_len);
2906     } else {
2907         if (*p != '\0') {
2908             error = xasprintf("%s: trailing garbage \"%s\" in argument",
2909                               arg, p);
2910             goto error;
2911         }
2912     }
2913     return NULL;
2914
2915 error:
2916     *columnp = NULL;
2917     free(*keyp);
2918     *keyp = NULL;
2919     if (valuep) {
2920         free(*valuep);
2921         *valuep = NULL;
2922         if (operatorp) {
2923             *operatorp = -1;
2924         }
2925     }
2926     return error;
2927 }
2928
2929 static const struct ovsdb_idl_column *
2930 pre_parse_column_key_value(struct vsctl_context *ctx,
2931                            const char *arg,
2932                            const struct vsctl_table_class *table)
2933 {
2934     const struct ovsdb_idl_column *column;
2935     const char *p;
2936     char *column_name;
2937
2938     p = arg;
2939     die_if_error(ovsdb_token_parse(&p, &column_name));
2940     if (column_name[0] == '\0') {
2941         vsctl_fatal("%s: missing column name", arg);
2942     }
2943
2944     pre_get_column(ctx, table, column_name, &column);
2945     free(column_name);
2946
2947     return column;
2948 }
2949
2950 static void
2951 check_mutable(const struct vsctl_table_class *table,
2952               const struct ovsdb_idl_column *column)
2953 {
2954     if (!column->mutable) {
2955         vsctl_fatal("cannot modify read-only column %s in table %s",
2956                     column->name, table->class->name);
2957     }
2958 }
2959
2960 static void
2961 pre_cmd_get(struct vsctl_context *ctx)
2962 {
2963     const char *id = shash_find_data(&ctx->options, "--id");
2964     const char *table_name = ctx->argv[1];
2965     const struct vsctl_table_class *table;
2966     int i;
2967
2968     /* Using "get" without --id or a column name could possibly make sense.
2969      * Maybe, for example, a ovs-vsctl run wants to assert that a row exists.
2970      * But it is unlikely that an interactive user would want to do that, so
2971      * issue a warning if we're running on a terminal. */
2972     if (!id && ctx->argc <= 3 && isatty(STDOUT_FILENO)) {
2973         VLOG_WARN("\"get\" command without row arguments or \"--id\" is "
2974                   "possibly erroneous");
2975     }
2976
2977     table = pre_get_table(ctx, table_name);
2978     for (i = 3; i < ctx->argc; i++) {
2979         if (!strcasecmp(ctx->argv[i], "_uuid")
2980             || !strcasecmp(ctx->argv[i], "-uuid")) {
2981             continue;
2982         }
2983
2984         pre_parse_column_key_value(ctx, ctx->argv[i], table);
2985     }
2986 }
2987
2988 static void
2989 cmd_get(struct vsctl_context *ctx)
2990 {
2991     const char *id = shash_find_data(&ctx->options, "--id");
2992     bool must_exist = !shash_find(&ctx->options, "--if-exists");
2993     const char *table_name = ctx->argv[1];
2994     const char *record_id = ctx->argv[2];
2995     const struct vsctl_table_class *table;
2996     const struct ovsdb_idl_row *row;
2997     struct ds *out = &ctx->output;
2998     int i;
2999
3000     if (id && !must_exist) {
3001         vsctl_fatal("--if-exists and --id may not be specified together");
3002     }
3003
3004     table = get_table(table_name);
3005     row = get_row(ctx, table, record_id, must_exist);
3006     if (!row) {
3007         return;
3008     }
3009
3010     if (id) {
3011         struct ovsdb_symbol *symbol;
3012         bool new;
3013
3014         symbol = create_symbol(ctx->symtab, id, &new);
3015         if (!new) {
3016             vsctl_fatal("row id \"%s\" specified on \"get\" command was used "
3017                         "before it was defined", id);
3018         }
3019         symbol->uuid = row->uuid;
3020
3021         /* This symbol refers to a row that already exists, so disable warnings
3022          * about it being unreferenced. */
3023         symbol->strong_ref = true;
3024     }
3025     for (i = 3; i < ctx->argc; i++) {
3026         const struct ovsdb_idl_column *column;
3027         const struct ovsdb_datum *datum;
3028         char *key_string;
3029
3030         /* Special case for obtaining the UUID of a row.  We can't just do this
3031          * through parse_column_key_value() below since it returns a "struct
3032          * ovsdb_idl_column" and the UUID column doesn't have one. */
3033         if (!strcasecmp(ctx->argv[i], "_uuid")
3034             || !strcasecmp(ctx->argv[i], "-uuid")) {
3035             ds_put_format(out, UUID_FMT"\n", UUID_ARGS(&row->uuid));
3036             continue;
3037         }
3038
3039         die_if_error(parse_column_key_value(ctx->argv[i], table,
3040                                             &column, &key_string,
3041                                             NULL, NULL, 0, NULL));
3042
3043         ovsdb_idl_txn_verify(row, column);
3044         datum = ovsdb_idl_read(row, column);
3045         if (key_string) {
3046             union ovsdb_atom key;
3047             unsigned int idx;
3048
3049             if (column->type.value.type == OVSDB_TYPE_VOID) {
3050                 vsctl_fatal("cannot specify key to get for non-map column %s",
3051                             column->name);
3052             }
3053
3054             die_if_error(ovsdb_atom_from_string(&key,
3055                                                 &column->type.key,
3056                                                 key_string, ctx->symtab));
3057
3058             idx = ovsdb_datum_find_key(datum, &key,
3059                                        column->type.key.type);
3060             if (idx == UINT_MAX) {
3061                 if (must_exist) {
3062                     vsctl_fatal("no key \"%s\" in %s record \"%s\" column %s",
3063                                 key_string, table->class->name, record_id,
3064                                 column->name);
3065                 }
3066             } else {
3067                 ovsdb_atom_to_string(&datum->values[idx],
3068                                      column->type.value.type, out);
3069             }
3070             ovsdb_atom_destroy(&key, column->type.key.type);
3071         } else {
3072             ovsdb_datum_to_string(datum, &column->type, out);
3073         }
3074         ds_put_char(out, '\n');
3075
3076         free(key_string);
3077     }
3078 }
3079
3080 static void
3081 parse_column_names(const char *column_names,
3082                    const struct vsctl_table_class *table,
3083                    const struct ovsdb_idl_column ***columnsp,
3084                    size_t *n_columnsp)
3085 {
3086     const struct ovsdb_idl_column **columns;
3087     size_t n_columns;
3088
3089     if (!column_names) {
3090         size_t i;
3091
3092         n_columns = table->class->n_columns + 1;
3093         columns = xmalloc(n_columns * sizeof *columns);
3094         columns[0] = NULL;
3095         for (i = 0; i < table->class->n_columns; i++) {
3096             columns[i + 1] = &table->class->columns[i];
3097         }
3098     } else {
3099         char *s = xstrdup(column_names);
3100         size_t allocated_columns;
3101         char *save_ptr = NULL;
3102         char *column_name;
3103
3104         columns = NULL;
3105         allocated_columns = n_columns = 0;
3106         for (column_name = strtok_r(s, ", ", &save_ptr); column_name;
3107              column_name = strtok_r(NULL, ", ", &save_ptr)) {
3108             const struct ovsdb_idl_column *column;
3109
3110             if (!strcasecmp(column_name, "_uuid")) {
3111                 column = NULL;
3112             } else {
3113                 die_if_error(get_column(table, column_name, &column));
3114             }
3115             if (n_columns >= allocated_columns) {
3116                 columns = x2nrealloc(columns, &allocated_columns,
3117                                      sizeof *columns);
3118             }
3119             columns[n_columns++] = column;
3120         }
3121         free(s);
3122
3123         if (!n_columns) {
3124             vsctl_fatal("must specify at least one column name");
3125         }
3126     }
3127     *columnsp = columns;
3128     *n_columnsp = n_columns;
3129 }
3130
3131
3132 static void
3133 pre_list_columns(struct vsctl_context *ctx,
3134                  const struct vsctl_table_class *table,
3135                  const char *column_names)
3136 {
3137     const struct ovsdb_idl_column **columns;
3138     size_t n_columns;
3139     size_t i;
3140
3141     parse_column_names(column_names, table, &columns, &n_columns);
3142     for (i = 0; i < n_columns; i++) {
3143         if (columns[i]) {
3144             ovsdb_idl_add_column(ctx->idl, columns[i]);
3145         }
3146     }
3147     free(columns);
3148 }
3149
3150 static void
3151 pre_cmd_list(struct vsctl_context *ctx)
3152 {
3153     const char *column_names = shash_find_data(&ctx->options, "--columns");
3154     const char *table_name = ctx->argv[1];
3155     const struct vsctl_table_class *table;
3156
3157     table = pre_get_table(ctx, table_name);
3158     pre_list_columns(ctx, table, column_names);
3159 }
3160
3161 static struct table *
3162 list_make_table(const struct ovsdb_idl_column **columns, size_t n_columns)
3163 {
3164     struct table *out;
3165     size_t i;
3166
3167     out = xmalloc(sizeof *out);
3168     table_init(out);
3169
3170     for (i = 0; i < n_columns; i++) {
3171         const struct ovsdb_idl_column *column = columns[i];
3172         const char *column_name = column ? column->name : "_uuid";
3173
3174         table_add_column(out, "%s", column_name);
3175     }
3176
3177     return out;
3178 }
3179
3180 static void
3181 list_record(const struct ovsdb_idl_row *row,
3182             const struct ovsdb_idl_column **columns, size_t n_columns,
3183             struct table *out)
3184 {
3185     size_t i;
3186
3187     if (!row) {
3188         return;
3189     }
3190
3191     table_add_row(out);
3192     for (i = 0; i < n_columns; i++) {
3193         const struct ovsdb_idl_column *column = columns[i];
3194         struct cell *cell = table_add_cell(out);
3195
3196         if (!column) {
3197             struct ovsdb_datum datum;
3198             union ovsdb_atom atom;
3199
3200             atom.uuid = row->uuid;
3201
3202             datum.keys = &atom;
3203             datum.values = NULL;
3204             datum.n = 1;
3205
3206             cell->json = ovsdb_datum_to_json(&datum, &ovsdb_type_uuid);
3207             cell->type = &ovsdb_type_uuid;
3208         } else {
3209             const struct ovsdb_datum *datum = ovsdb_idl_read(row, column);
3210
3211             cell->json = ovsdb_datum_to_json(datum, &column->type);
3212             cell->type = &column->type;
3213         }
3214     }
3215 }
3216
3217 static void
3218 cmd_list(struct vsctl_context *ctx)
3219 {
3220     const char *column_names = shash_find_data(&ctx->options, "--columns");
3221     bool must_exist = !shash_find(&ctx->options, "--if-exists");
3222     const struct ovsdb_idl_column **columns;
3223     const char *table_name = ctx->argv[1];
3224     const struct vsctl_table_class *table;
3225     struct table *out;
3226     size_t n_columns;
3227     int i;
3228
3229     table = get_table(table_name);
3230     parse_column_names(column_names, table, &columns, &n_columns);
3231     out = ctx->table = list_make_table(columns, n_columns);
3232     if (ctx->argc > 2) {
3233         for (i = 2; i < ctx->argc; i++) {
3234             list_record(get_row(ctx, table, ctx->argv[i], must_exist),
3235                         columns, n_columns, out);
3236         }
3237     } else {
3238         const struct ovsdb_idl_row *row;
3239
3240         for (row = ovsdb_idl_first_row(ctx->idl, table->class); row != NULL;
3241              row = ovsdb_idl_next_row(row)) {
3242             list_record(row, columns, n_columns, out);
3243         }
3244     }
3245     free(columns);
3246 }
3247
3248 static void
3249 pre_cmd_find(struct vsctl_context *ctx)
3250 {
3251     const char *column_names = shash_find_data(&ctx->options, "--columns");
3252     const char *table_name = ctx->argv[1];
3253     const struct vsctl_table_class *table;
3254     int i;
3255
3256     table = pre_get_table(ctx, table_name);
3257     pre_list_columns(ctx, table, column_names);
3258     for (i = 2; i < ctx->argc; i++) {
3259         pre_parse_column_key_value(ctx, ctx->argv[i], table);
3260     }
3261 }
3262
3263 static void
3264 cmd_find(struct vsctl_context *ctx)
3265 {
3266     const char *column_names = shash_find_data(&ctx->options, "--columns");
3267     const struct ovsdb_idl_column **columns;
3268     const char *table_name = ctx->argv[1];
3269     const struct vsctl_table_class *table;
3270     const struct ovsdb_idl_row *row;
3271     struct table *out;
3272     size_t n_columns;
3273
3274     table = get_table(table_name);
3275     parse_column_names(column_names, table, &columns, &n_columns);
3276     out = ctx->table = list_make_table(columns, n_columns);
3277     for (row = ovsdb_idl_first_row(ctx->idl, table->class); row;
3278          row = ovsdb_idl_next_row(row)) {
3279         int i;
3280
3281         for (i = 2; i < ctx->argc; i++) {
3282             if (!is_condition_satisfied(table, row, ctx->argv[i],
3283                                         ctx->symtab)) {
3284                 goto next_row;
3285             }
3286         }
3287         list_record(row, columns, n_columns, out);
3288
3289     next_row: ;
3290     }
3291     free(columns);
3292 }
3293
3294 static void
3295 pre_cmd_set(struct vsctl_context *ctx)
3296 {
3297     const char *table_name = ctx->argv[1];
3298     const struct vsctl_table_class *table;
3299     int i;
3300
3301     table = pre_get_table(ctx, table_name);
3302     for (i = 3; i < ctx->argc; i++) {
3303         const struct ovsdb_idl_column *column;
3304
3305         column = pre_parse_column_key_value(ctx, ctx->argv[i], table);
3306         check_mutable(table, column);
3307     }
3308 }
3309
3310 static void
3311 set_column(const struct vsctl_table_class *table,
3312            const struct ovsdb_idl_row *row, const char *arg,
3313            struct ovsdb_symbol_table *symtab)
3314 {
3315     const struct ovsdb_idl_column *column;
3316     char *key_string, *value_string;
3317     char *error;
3318
3319     error = parse_column_key_value(arg, table, &column, &key_string,
3320                                    NULL, NULL, 0, &value_string);
3321     die_if_error(error);
3322     if (!value_string) {
3323         vsctl_fatal("%s: missing value", arg);
3324     }
3325
3326     if (key_string) {
3327         union ovsdb_atom key, value;
3328         struct ovsdb_datum datum;
3329
3330         if (column->type.value.type == OVSDB_TYPE_VOID) {
3331             vsctl_fatal("cannot specify key to set for non-map column %s",
3332                         column->name);
3333         }
3334
3335         die_if_error(ovsdb_atom_from_string(&key, &column->type.key,
3336                                             key_string, symtab));
3337         die_if_error(ovsdb_atom_from_string(&value, &column->type.value,
3338                                             value_string, symtab));
3339
3340         ovsdb_datum_init_empty(&datum);
3341         ovsdb_datum_add_unsafe(&datum, &key, &value, &column->type);
3342
3343         ovsdb_atom_destroy(&key, column->type.key.type);
3344         ovsdb_atom_destroy(&value, column->type.value.type);
3345
3346         ovsdb_datum_union(&datum, ovsdb_idl_read(row, column),
3347                           &column->type, false);
3348         ovsdb_idl_txn_write(row, column, &datum);
3349     } else {
3350         struct ovsdb_datum datum;
3351
3352         die_if_error(ovsdb_datum_from_string(&datum, &column->type,
3353                                              value_string, symtab));
3354         ovsdb_idl_txn_write(row, column, &datum);
3355     }
3356
3357     free(key_string);
3358     free(value_string);
3359 }
3360
3361 static void
3362 cmd_set(struct vsctl_context *ctx)
3363 {
3364     bool must_exist = !shash_find(&ctx->options, "--if-exists");
3365     const char *table_name = ctx->argv[1];
3366     const char *record_id = ctx->argv[2];
3367     const struct vsctl_table_class *table;
3368     const struct ovsdb_idl_row *row;
3369     int i;
3370
3371     table = get_table(table_name);
3372     row = get_row(ctx, table, record_id, must_exist);
3373     if (!row) {
3374         return;
3375     }
3376
3377     for (i = 3; i < ctx->argc; i++) {
3378         set_column(table, row, ctx->argv[i], ctx->symtab);
3379     }
3380
3381     vsctl_context_invalidate_cache(ctx);
3382 }
3383
3384 static void
3385 pre_cmd_add(struct vsctl_context *ctx)
3386 {
3387     const char *table_name = ctx->argv[1];
3388     const char *column_name = ctx->argv[3];
3389     const struct vsctl_table_class *table;
3390     const struct ovsdb_idl_column *column;
3391
3392     table = pre_get_table(ctx, table_name);
3393     pre_get_column(ctx, table, column_name, &column);
3394     check_mutable(table, column);
3395 }
3396
3397 static void
3398 cmd_add(struct vsctl_context *ctx)
3399 {
3400     bool must_exist = !shash_find(&ctx->options, "--if-exists");
3401     const char *table_name = ctx->argv[1];
3402     const char *record_id = ctx->argv[2];
3403     const char *column_name = ctx->argv[3];
3404     const struct vsctl_table_class *table;
3405     const struct ovsdb_idl_column *column;
3406     const struct ovsdb_idl_row *row;
3407     const struct ovsdb_type *type;
3408     struct ovsdb_datum old;
3409     int i;
3410
3411     table = get_table(table_name);
3412     die_if_error(get_column(table, column_name, &column));
3413     row = get_row(ctx, table, record_id, must_exist);
3414     if (!row) {
3415         return;
3416     }
3417
3418     type = &column->type;
3419     ovsdb_datum_clone(&old, ovsdb_idl_read(row, column), &column->type);
3420     for (i = 4; i < ctx->argc; i++) {
3421         struct ovsdb_type add_type;
3422         struct ovsdb_datum add;
3423
3424         add_type = *type;
3425         add_type.n_min = 1;
3426         add_type.n_max = UINT_MAX;
3427         die_if_error(ovsdb_datum_from_string(&add, &add_type, ctx->argv[i],
3428                                              ctx->symtab));
3429         ovsdb_datum_union(&old, &add, type, false);
3430         ovsdb_datum_destroy(&add, type);
3431     }
3432     if (old.n > type->n_max) {
3433         vsctl_fatal("\"add\" operation would put %u %s in column %s of "
3434                     "table %s but the maximum number is %u",
3435                     old.n,
3436                     type->value.type == OVSDB_TYPE_VOID ? "values" : "pairs",
3437                     column->name, table->class->name, type->n_max);
3438     }
3439     ovsdb_idl_txn_verify(row, column);
3440     ovsdb_idl_txn_write(row, column, &old);
3441
3442     vsctl_context_invalidate_cache(ctx);
3443 }
3444
3445 static void
3446 pre_cmd_remove(struct vsctl_context *ctx)
3447 {
3448     const char *table_name = ctx->argv[1];
3449     const char *column_name = ctx->argv[3];
3450     const struct vsctl_table_class *table;
3451     const struct ovsdb_idl_column *column;
3452
3453     table = pre_get_table(ctx, table_name);
3454     pre_get_column(ctx, table, column_name, &column);
3455     check_mutable(table, column);
3456 }
3457
3458 static void
3459 cmd_remove(struct vsctl_context *ctx)
3460 {
3461     bool must_exist = !shash_find(&ctx->options, "--if-exists");
3462     const char *table_name = ctx->argv[1];
3463     const char *record_id = ctx->argv[2];
3464     const char *column_name = ctx->argv[3];
3465     const struct vsctl_table_class *table;
3466     const struct ovsdb_idl_column *column;
3467     const struct ovsdb_idl_row *row;
3468     const struct ovsdb_type *type;
3469     struct ovsdb_datum old;
3470     int i;
3471
3472     table = get_table(table_name);
3473     die_if_error(get_column(table, column_name, &column));
3474     row = get_row(ctx, table, record_id, must_exist);
3475     if (!row) {
3476         return;
3477     }
3478
3479     type = &column->type;
3480     ovsdb_datum_clone(&old, ovsdb_idl_read(row, column), &column->type);
3481     for (i = 4; i < ctx->argc; i++) {
3482         struct ovsdb_type rm_type;
3483         struct ovsdb_datum rm;
3484         char *error;
3485
3486         rm_type = *type;
3487         rm_type.n_min = 1;
3488         rm_type.n_max = UINT_MAX;
3489         error = ovsdb_datum_from_string(&rm, &rm_type,
3490                                         ctx->argv[i], ctx->symtab);
3491         if (error && ovsdb_type_is_map(&rm_type)) {
3492             free(error);
3493             rm_type.value.type = OVSDB_TYPE_VOID;
3494             die_if_error(ovsdb_datum_from_string(&rm, &rm_type,
3495                                                  ctx->argv[i], ctx->symtab));
3496         }
3497         ovsdb_datum_subtract(&old, type, &rm, &rm_type);
3498         ovsdb_datum_destroy(&rm, &rm_type);
3499     }
3500     if (old.n < type->n_min) {
3501         vsctl_fatal("\"remove\" operation would put %u %s in column %s of "
3502                     "table %s but the minimum number is %u",
3503                     old.n,
3504                     type->value.type == OVSDB_TYPE_VOID ? "values" : "pairs",
3505                     column->name, table->class->name, type->n_min);
3506     }
3507     ovsdb_idl_txn_verify(row, column);
3508     ovsdb_idl_txn_write(row, column, &old);
3509
3510     vsctl_context_invalidate_cache(ctx);
3511 }
3512
3513 static void
3514 pre_cmd_clear(struct vsctl_context *ctx)
3515 {
3516     const char *table_name = ctx->argv[1];
3517     const struct vsctl_table_class *table;
3518     int i;
3519
3520     table = pre_get_table(ctx, table_name);
3521     for (i = 3; i < ctx->argc; i++) {
3522         const struct ovsdb_idl_column *column;
3523
3524         pre_get_column(ctx, table, ctx->argv[i], &column);
3525         check_mutable(table, column);
3526     }
3527 }
3528
3529 static void
3530 cmd_clear(struct vsctl_context *ctx)
3531 {
3532     bool must_exist = !shash_find(&ctx->options, "--if-exists");
3533     const char *table_name = ctx->argv[1];
3534     const char *record_id = ctx->argv[2];
3535     const struct vsctl_table_class *table;
3536     const struct ovsdb_idl_row *row;
3537     int i;
3538
3539     table = get_table(table_name);
3540     row = get_row(ctx, table, record_id, must_exist);
3541     if (!row) {
3542         return;
3543     }
3544
3545     for (i = 3; i < ctx->argc; i++) {
3546         const struct ovsdb_idl_column *column;
3547         const struct ovsdb_type *type;
3548         struct ovsdb_datum datum;
3549
3550         die_if_error(get_column(table, ctx->argv[i], &column));
3551
3552         type = &column->type;
3553         if (type->n_min > 0) {
3554             vsctl_fatal("\"clear\" operation cannot be applied to column %s "
3555                         "of table %s, which is not allowed to be empty",
3556                         column->name, table->class->name);
3557         }
3558
3559         ovsdb_datum_init_empty(&datum);
3560         ovsdb_idl_txn_write(row, column, &datum);
3561     }
3562
3563     vsctl_context_invalidate_cache(ctx);
3564 }
3565
3566 static void
3567 pre_create(struct vsctl_context *ctx)
3568 {
3569     const char *id = shash_find_data(&ctx->options, "--id");
3570     const char *table_name = ctx->argv[1];
3571     const struct vsctl_table_class *table;
3572
3573     table = get_table(table_name);
3574     if (!id && !table->class->is_root) {
3575         VLOG_WARN("applying \"create\" command to table %s without --id "
3576                   "option will have no effect", table->class->name);
3577     }
3578 }
3579
3580 static void
3581 cmd_create(struct vsctl_context *ctx)
3582 {
3583     const char *id = shash_find_data(&ctx->options, "--id");
3584     const char *table_name = ctx->argv[1];
3585     const struct vsctl_table_class *table = get_table(table_name);
3586     const struct ovsdb_idl_row *row;
3587     const struct uuid *uuid;
3588     int i;
3589
3590     if (id) {
3591         struct ovsdb_symbol *symbol = create_symbol(ctx->symtab, id, NULL);
3592         if (table->class->is_root) {
3593             /* This table is in the root set, meaning that rows created in it
3594              * won't disappear even if they are unreferenced, so disable
3595              * warnings about that by pretending that there is a reference. */
3596             symbol->strong_ref = true;
3597         }
3598         uuid = &symbol->uuid;
3599     } else {
3600         uuid = NULL;
3601     }
3602
3603     row = ovsdb_idl_txn_insert(ctx->txn, table->class, uuid);
3604     for (i = 2; i < ctx->argc; i++) {
3605         set_column(table, row, ctx->argv[i], ctx->symtab);
3606     }
3607     ds_put_format(&ctx->output, UUID_FMT, UUID_ARGS(&row->uuid));
3608 }
3609
3610 /* This function may be used as the 'postprocess' function for commands that
3611  * insert new rows into the database.  It expects that the command's 'run'
3612  * function prints the UUID reported by ovsdb_idl_txn_insert() as the command's
3613  * sole output.  It replaces that output by the row's permanent UUID assigned
3614  * by the database server and appends a new-line.
3615  *
3616  * Currently we use this only for "create", because the higher-level commands
3617  * are supposed to be independent of the actual structure of the vswitch
3618  * configuration. */
3619 static void
3620 post_create(struct vsctl_context *ctx)
3621 {
3622     const struct uuid *real;
3623     struct uuid dummy;
3624
3625     if (!uuid_from_string(&dummy, ds_cstr(&ctx->output))) {
3626         NOT_REACHED();
3627     }
3628     real = ovsdb_idl_txn_get_insert_uuid(ctx->txn, &dummy);
3629     if (real) {
3630         ds_clear(&ctx->output);
3631         ds_put_format(&ctx->output, UUID_FMT, UUID_ARGS(real));
3632     }
3633     ds_put_char(&ctx->output, '\n');
3634 }
3635
3636 static void
3637 pre_cmd_destroy(struct vsctl_context *ctx)
3638 {
3639     const char *table_name = ctx->argv[1];
3640
3641     pre_get_table(ctx, table_name);
3642 }
3643
3644 static void
3645 cmd_destroy(struct vsctl_context *ctx)
3646 {
3647     bool must_exist = !shash_find(&ctx->options, "--if-exists");
3648     bool delete_all = shash_find(&ctx->options, "--all");
3649     const char *table_name = ctx->argv[1];
3650     const struct vsctl_table_class *table;
3651     int i;
3652
3653     table = get_table(table_name);
3654
3655     if (delete_all && ctx->argc > 2) {
3656         vsctl_fatal("--all and records argument should not be specified together");
3657     }
3658
3659     if (delete_all && !must_exist) {
3660         vsctl_fatal("--all and --if-exists should not be specified together");
3661     }
3662
3663     if (delete_all) {
3664         const struct ovsdb_idl_row *row;
3665         const struct ovsdb_idl_row *next_row;
3666
3667         for (row = ovsdb_idl_first_row(ctx->idl, table->class);
3668              row;) {
3669              next_row = ovsdb_idl_next_row(row);
3670              ovsdb_idl_txn_delete(row);
3671              row = next_row;
3672         }
3673     } else {
3674         for (i = 2; i < ctx->argc; i++) {
3675             const struct ovsdb_idl_row *row;
3676
3677             row = get_row(ctx, table, ctx->argv[i], must_exist);
3678             if (row) {
3679                 ovsdb_idl_txn_delete(row);
3680             }
3681         }
3682     }
3683     vsctl_context_invalidate_cache(ctx);
3684 }
3685
3686 #define RELOPS                                  \
3687     RELOP(RELOP_EQ,     "=")                    \
3688     RELOP(RELOP_NE,     "!=")                   \
3689     RELOP(RELOP_LT,     "<")                    \
3690     RELOP(RELOP_GT,     ">")                    \
3691     RELOP(RELOP_LE,     "<=")                   \
3692     RELOP(RELOP_GE,     ">=")                   \
3693     RELOP(RELOP_SET_EQ, "{=}")                  \
3694     RELOP(RELOP_SET_NE, "{!=}")                 \
3695     RELOP(RELOP_SET_LT, "{<}")                  \
3696     RELOP(RELOP_SET_GT, "{>}")                  \
3697     RELOP(RELOP_SET_LE, "{<=}")                 \
3698     RELOP(RELOP_SET_GE, "{>=}")
3699
3700 enum relop {
3701 #define RELOP(ENUM, STRING) ENUM,
3702     RELOPS
3703 #undef RELOP
3704 };
3705
3706 static bool
3707 is_set_operator(enum relop op)
3708 {
3709     return (op == RELOP_SET_EQ || op == RELOP_SET_NE ||
3710             op == RELOP_SET_LT || op == RELOP_SET_GT ||
3711             op == RELOP_SET_LE || op == RELOP_SET_GE);
3712 }
3713
3714 static bool
3715 evaluate_relop(const struct ovsdb_datum *a, const struct ovsdb_datum *b,
3716                const struct ovsdb_type *type, enum relop op)
3717 {
3718     switch (op) {
3719     case RELOP_EQ:
3720     case RELOP_SET_EQ:
3721         return ovsdb_datum_compare_3way(a, b, type) == 0;
3722     case RELOP_NE:
3723     case RELOP_SET_NE:
3724         return ovsdb_datum_compare_3way(a, b, type) != 0;
3725     case RELOP_LT:
3726         return ovsdb_datum_compare_3way(a, b, type) < 0;
3727     case RELOP_GT:
3728         return ovsdb_datum_compare_3way(a, b, type) > 0;
3729     case RELOP_LE:
3730         return ovsdb_datum_compare_3way(a, b, type) <= 0;
3731     case RELOP_GE:
3732         return ovsdb_datum_compare_3way(a, b, type) >= 0;
3733
3734     case RELOP_SET_LT:
3735         return b->n > a->n && ovsdb_datum_includes_all(a, b, type);
3736     case RELOP_SET_GT:
3737         return a->n > b->n && ovsdb_datum_includes_all(b, a, type);
3738     case RELOP_SET_LE:
3739         return ovsdb_datum_includes_all(a, b, type);
3740     case RELOP_SET_GE:
3741         return ovsdb_datum_includes_all(b, a, type);
3742
3743     default:
3744         NOT_REACHED();
3745     }
3746 }
3747
3748 static bool
3749 is_condition_satisfied(const struct vsctl_table_class *table,
3750                        const struct ovsdb_idl_row *row, const char *arg,
3751                        struct ovsdb_symbol_table *symtab)
3752 {
3753     static const char *operators[] = {
3754 #define RELOP(ENUM, STRING) STRING,
3755         RELOPS
3756 #undef RELOP
3757     };
3758
3759     const struct ovsdb_idl_column *column;
3760     const struct ovsdb_datum *have_datum;
3761     char *key_string, *value_string;
3762     struct ovsdb_type type;
3763     int operator;
3764     bool retval;
3765     char *error;
3766
3767     error = parse_column_key_value(arg, table, &column, &key_string,
3768                                    &operator, operators, ARRAY_SIZE(operators),
3769                                    &value_string);
3770     die_if_error(error);
3771     if (!value_string) {
3772         vsctl_fatal("%s: missing value", arg);
3773     }
3774
3775     type = column->type;
3776     type.n_max = UINT_MAX;
3777
3778     have_datum = ovsdb_idl_read(row, column);
3779     if (key_string) {
3780         union ovsdb_atom want_key;
3781         struct ovsdb_datum b;
3782         unsigned int idx;
3783
3784         if (column->type.value.type == OVSDB_TYPE_VOID) {
3785             vsctl_fatal("cannot specify key to check for non-map column %s",
3786                         column->name);
3787         }
3788
3789         die_if_error(ovsdb_atom_from_string(&want_key, &column->type.key,
3790                                             key_string, symtab));
3791
3792         type.key = type.value;
3793         type.value.type = OVSDB_TYPE_VOID;
3794         die_if_error(ovsdb_datum_from_string(&b, &type, value_string, symtab));
3795
3796         idx = ovsdb_datum_find_key(have_datum,
3797                                    &want_key, column->type.key.type);
3798         if (idx == UINT_MAX && !is_set_operator(operator)) {
3799             retval = false;
3800         } else {
3801             struct ovsdb_datum a;
3802
3803             if (idx != UINT_MAX) {
3804                 a.n = 1;
3805                 a.keys = &have_datum->values[idx];
3806                 a.values = NULL;
3807             } else {
3808                 a.n = 0;
3809                 a.keys = NULL;
3810                 a.values = NULL;
3811             }
3812
3813             retval = evaluate_relop(&a, &b, &type, operator);
3814         }
3815
3816         ovsdb_atom_destroy(&want_key, column->type.key.type);
3817         ovsdb_datum_destroy(&b, &type);
3818     } else {
3819         struct ovsdb_datum want_datum;
3820
3821         die_if_error(ovsdb_datum_from_string(&want_datum, &column->type,
3822                                              value_string, symtab));
3823         retval = evaluate_relop(have_datum, &want_datum, &type, operator);
3824         ovsdb_datum_destroy(&want_datum, &column->type);
3825     }
3826
3827     free(key_string);
3828     free(value_string);
3829
3830     return retval;
3831 }
3832
3833 static void
3834 pre_cmd_wait_until(struct vsctl_context *ctx)
3835 {
3836     const char *table_name = ctx->argv[1];
3837     const struct vsctl_table_class *table;
3838     int i;
3839
3840     table = pre_get_table(ctx, table_name);
3841
3842     for (i = 3; i < ctx->argc; i++) {
3843         pre_parse_column_key_value(ctx, ctx->argv[i], table);
3844     }
3845 }
3846
3847 static void
3848 cmd_wait_until(struct vsctl_context *ctx)
3849 {
3850     const char *table_name = ctx->argv[1];
3851     const char *record_id = ctx->argv[2];
3852     const struct vsctl_table_class *table;
3853     const struct ovsdb_idl_row *row;
3854     int i;
3855
3856     table = get_table(table_name);
3857
3858     row = get_row(ctx, table, record_id, false);
3859     if (!row) {
3860         ctx->try_again = true;
3861         return;
3862     }
3863
3864     for (i = 3; i < ctx->argc; i++) {
3865         if (!is_condition_satisfied(table, row, ctx->argv[i], ctx->symtab)) {
3866             ctx->try_again = true;
3867             return;
3868         }
3869     }
3870 }
3871 \f
3872 /* Prepares 'ctx', which has already been initialized with
3873  * vsctl_context_init(), for processing 'command'. */
3874 static void
3875 vsctl_context_init_command(struct vsctl_context *ctx,
3876                            struct vsctl_command *command)
3877 {
3878     ctx->argc = command->argc;
3879     ctx->argv = command->argv;
3880     ctx->options = command->options;
3881
3882     ds_swap(&ctx->output, &command->output);
3883     ctx->table = command->table;
3884
3885     ctx->verified_ports = false;
3886
3887     ctx->try_again = false;
3888 }
3889
3890 /* Prepares 'ctx' for processing commands, initializing its members with the
3891  * values passed in as arguments.
3892  *
3893  * If 'command' is nonnull, calls vsctl_context_init_command() to prepare for
3894  * that particular command. */
3895 static void
3896 vsctl_context_init(struct vsctl_context *ctx, struct vsctl_command *command,
3897                    struct ovsdb_idl *idl, struct ovsdb_idl_txn *txn,
3898                    const struct ovsrec_open_vswitch *ovs,
3899                    struct ovsdb_symbol_table *symtab)
3900 {
3901     if (command) {
3902         vsctl_context_init_command(ctx, command);
3903     }
3904     ctx->idl = idl;
3905     ctx->txn = txn;
3906     ctx->ovs = ovs;
3907     ctx->symtab = symtab;
3908     ctx->cache_valid = false;
3909 }
3910
3911 /* Completes processing of 'command' within 'ctx'. */
3912 static void
3913 vsctl_context_done_command(struct vsctl_context *ctx,
3914                            struct vsctl_command *command)
3915 {
3916     ds_swap(&ctx->output, &command->output);
3917     command->table = ctx->table;
3918 }
3919
3920 /* Finishes up with 'ctx'.
3921  *
3922  * If command is nonnull, first calls vsctl_context_done_command() to complete
3923  * processing that command within 'ctx'. */
3924 static void
3925 vsctl_context_done(struct vsctl_context *ctx, struct vsctl_command *command)
3926 {
3927     if (command) {
3928         vsctl_context_done_command(ctx, command);
3929     }
3930     vsctl_context_invalidate_cache(ctx);
3931 }
3932
3933 static void
3934 run_prerequisites(struct vsctl_command *commands, size_t n_commands,
3935                   struct ovsdb_idl *idl)
3936 {
3937     struct vsctl_command *c;
3938
3939     ovsdb_idl_add_table(idl, &ovsrec_table_open_vswitch);
3940     if (wait_for_reload) {
3941         ovsdb_idl_add_column(idl, &ovsrec_open_vswitch_col_cur_cfg);
3942     }
3943     for (c = commands; c < &commands[n_commands]; c++) {
3944         if (c->syntax->prerequisites) {
3945             struct vsctl_context ctx;
3946
3947             ds_init(&c->output);
3948             c->table = NULL;
3949
3950             vsctl_context_init(&ctx, c, idl, NULL, NULL, NULL);
3951             (c->syntax->prerequisites)(&ctx);
3952             vsctl_context_done(&ctx, c);
3953
3954             ovs_assert(!c->output.string);
3955             ovs_assert(!c->table);
3956         }
3957     }
3958 }
3959
3960 static void
3961 do_vsctl(const char *args, struct vsctl_command *commands, size_t n_commands,
3962          struct ovsdb_idl *idl)
3963 {
3964     struct ovsdb_idl_txn *txn;
3965     const struct ovsrec_open_vswitch *ovs;
3966     enum ovsdb_idl_txn_status status;
3967     struct ovsdb_symbol_table *symtab;
3968     struct vsctl_context ctx;
3969     struct vsctl_command *c;
3970     struct shash_node *node;
3971     int64_t next_cfg = 0;
3972     char *error = NULL;
3973
3974     txn = the_idl_txn = ovsdb_idl_txn_create(idl);
3975     if (dry_run) {
3976         ovsdb_idl_txn_set_dry_run(txn);
3977     }
3978
3979     ovsdb_idl_txn_add_comment(txn, "ovs-vsctl: %s", args);
3980
3981     ovs = ovsrec_open_vswitch_first(idl);
3982     if (!ovs) {
3983         /* XXX add verification that table is empty */
3984         ovs = ovsrec_open_vswitch_insert(txn);
3985     }
3986
3987     if (wait_for_reload) {
3988         ovsdb_idl_txn_increment(txn, &ovs->header_,
3989                                 &ovsrec_open_vswitch_col_next_cfg);
3990     }
3991
3992     symtab = ovsdb_symbol_table_create();
3993     for (c = commands; c < &commands[n_commands]; c++) {
3994         ds_init(&c->output);
3995         c->table = NULL;
3996     }
3997     vsctl_context_init(&ctx, NULL, idl, txn, ovs, symtab);
3998     for (c = commands; c < &commands[n_commands]; c++) {
3999         vsctl_context_init_command(&ctx, c);
4000         if (c->syntax->run) {
4001             (c->syntax->run)(&ctx);
4002         }
4003         vsctl_context_done_command(&ctx, c);
4004
4005         if (ctx.try_again) {
4006             vsctl_context_done(&ctx, NULL);
4007             goto try_again;
4008         }
4009     }
4010     vsctl_context_done(&ctx, NULL);
4011
4012     SHASH_FOR_EACH (node, &symtab->sh) {
4013         struct ovsdb_symbol *symbol = node->data;
4014         if (!symbol->created) {
4015             vsctl_fatal("row id \"%s\" is referenced but never created (e.g. "
4016                         "with \"-- --id=%s create ...\")",
4017                         node->name, node->name);
4018         }
4019         if (!symbol->strong_ref) {
4020             if (!symbol->weak_ref) {
4021                 VLOG_WARN("row id \"%s\" was created but no reference to it "
4022                           "was inserted, so it will not actually appear in "
4023                           "the database", node->name);
4024             } else {
4025                 VLOG_WARN("row id \"%s\" was created but only a weak "
4026                           "reference to it was inserted, so it will not "
4027                           "actually appear in the database", node->name);
4028             }
4029         }
4030     }
4031
4032     status = ovsdb_idl_txn_commit_block(txn);
4033     if (wait_for_reload && status == TXN_SUCCESS) {
4034         next_cfg = ovsdb_idl_txn_get_increment_new_value(txn);
4035     }
4036     if (status == TXN_UNCHANGED || status == TXN_SUCCESS) {
4037         for (c = commands; c < &commands[n_commands]; c++) {
4038             if (c->syntax->postprocess) {
4039                 struct vsctl_context ctx;
4040
4041                 vsctl_context_init(&ctx, c, idl, txn, ovs, symtab);
4042                 (c->syntax->postprocess)(&ctx);
4043                 vsctl_context_done(&ctx, c);
4044             }
4045         }
4046     }
4047     error = xstrdup(ovsdb_idl_txn_get_error(txn));
4048     ovsdb_idl_txn_destroy(txn);
4049     txn = the_idl_txn = NULL;
4050
4051     switch (status) {
4052     case TXN_UNCOMMITTED:
4053     case TXN_INCOMPLETE:
4054         NOT_REACHED();
4055
4056     case TXN_ABORTED:
4057         /* Should not happen--we never call ovsdb_idl_txn_abort(). */
4058         vsctl_fatal("transaction aborted");
4059
4060     case TXN_UNCHANGED:
4061     case TXN_SUCCESS:
4062         break;
4063
4064     case TXN_TRY_AGAIN:
4065         goto try_again;
4066
4067     case TXN_ERROR:
4068         vsctl_fatal("transaction error: %s", error);
4069
4070     case TXN_NOT_LOCKED:
4071         /* Should not happen--we never call ovsdb_idl_set_lock(). */
4072         vsctl_fatal("database not locked");
4073
4074     default:
4075         NOT_REACHED();
4076     }
4077     free(error);
4078
4079     ovsdb_symbol_table_destroy(symtab);
4080
4081     for (c = commands; c < &commands[n_commands]; c++) {
4082         struct ds *ds = &c->output;
4083
4084         if (c->table) {
4085             table_print(c->table, &table_style);
4086         } else if (oneline) {
4087             size_t j;
4088
4089             ds_chomp(ds, '\n');
4090             for (j = 0; j < ds->length; j++) {
4091                 int ch = ds->string[j];
4092                 switch (ch) {
4093                 case '\n':
4094                     fputs("\\n", stdout);
4095                     break;
4096
4097                 case '\\':
4098                     fputs("\\\\", stdout);
4099                     break;
4100
4101                 default:
4102                     putchar(ch);
4103                 }
4104             }
4105             putchar('\n');
4106         } else {
4107             fputs(ds_cstr(ds), stdout);
4108         }
4109         ds_destroy(&c->output);
4110         table_destroy(c->table);
4111         free(c->table);
4112
4113         shash_destroy_free_data(&c->options);
4114     }
4115     free(commands);
4116
4117     if (wait_for_reload && status != TXN_UNCHANGED) {
4118         for (;;) {
4119             ovsdb_idl_run(idl);
4120             OVSREC_OPEN_VSWITCH_FOR_EACH (ovs, idl) {
4121                 if (ovs->cur_cfg >= next_cfg) {
4122                     goto done;
4123                 }
4124             }
4125             ovsdb_idl_wait(idl);
4126             poll_block();
4127         }
4128     done: ;
4129     }
4130     ovsdb_idl_destroy(idl);
4131
4132     exit(EXIT_SUCCESS);
4133
4134 try_again:
4135     /* Our transaction needs to be rerun, or a prerequisite was not met.  Free
4136      * resources and return so that the caller can try again. */
4137     if (txn) {
4138         ovsdb_idl_txn_abort(txn);
4139         ovsdb_idl_txn_destroy(txn);
4140         the_idl_txn = NULL;
4141     }
4142     ovsdb_symbol_table_destroy(symtab);
4143     for (c = commands; c < &commands[n_commands]; c++) {
4144         ds_destroy(&c->output);
4145         table_destroy(c->table);
4146         free(c->table);
4147     }
4148     free(error);
4149 }
4150
4151 static const struct vsctl_command_syntax all_commands[] = {
4152     /* Open vSwitch commands. */
4153     {"init", 0, 0, NULL, cmd_init, NULL, "", RW},
4154     {"show", 0, 0, pre_cmd_show, cmd_show, NULL, "", RO},
4155
4156     /* Bridge commands. */
4157     {"add-br", 1, 3, pre_get_info, cmd_add_br, NULL, "--may-exist", RW},
4158     {"del-br", 1, 1, pre_get_info, cmd_del_br, NULL, "--if-exists", RW},
4159     {"list-br", 0, 0, pre_get_info, cmd_list_br, NULL, "--real,--fake", RO},
4160     {"br-exists", 1, 1, pre_get_info, cmd_br_exists, NULL, "", RO},
4161     {"br-to-vlan", 1, 1, pre_get_info, cmd_br_to_vlan, NULL, "", RO},
4162     {"br-to-parent", 1, 1, pre_get_info, cmd_br_to_parent, NULL, "", RO},
4163     {"br-set-external-id", 2, 3, pre_cmd_br_set_external_id,
4164      cmd_br_set_external_id, NULL, "", RW},
4165     {"br-get-external-id", 1, 2, pre_cmd_br_get_external_id,
4166      cmd_br_get_external_id, NULL, "", RO},
4167
4168     /* Port commands. */
4169     {"list-ports", 1, 1, pre_get_info, cmd_list_ports, NULL, "", RO},
4170     {"add-port", 2, INT_MAX, pre_get_info, cmd_add_port, NULL, "--may-exist",
4171      RW},
4172     {"add-bond", 4, INT_MAX, pre_get_info, cmd_add_bond, NULL,
4173      "--may-exist,--fake-iface", RW},
4174     {"del-port", 1, 2, pre_get_info, cmd_del_port, NULL,
4175      "--if-exists,--with-iface", RW},
4176     {"port-to-br", 1, 1, pre_get_info, cmd_port_to_br, NULL, "", RO},
4177
4178     /* Interface commands. */
4179     {"list-ifaces", 1, 1, pre_get_info, cmd_list_ifaces, NULL, "", RO},
4180     {"iface-to-br", 1, 1, pre_get_info, cmd_iface_to_br, NULL, "", RO},
4181
4182     /* Controller commands. */
4183     {"get-controller", 1, 1, pre_controller, cmd_get_controller, NULL, "", RO},
4184     {"del-controller", 1, 1, pre_controller, cmd_del_controller, NULL, "", RW},
4185     {"set-controller", 1, INT_MAX, pre_controller, cmd_set_controller, NULL,
4186      "", RW},
4187     {"get-fail-mode", 1, 1, pre_get_info, cmd_get_fail_mode, NULL, "", RO},
4188     {"del-fail-mode", 1, 1, pre_get_info, cmd_del_fail_mode, NULL, "", RW},
4189     {"set-fail-mode", 2, 2, pre_get_info, cmd_set_fail_mode, NULL, "", RW},
4190
4191     /* Manager commands. */
4192     {"get-manager", 0, 0, pre_manager, cmd_get_manager, NULL, "", RO},
4193     {"del-manager", 0, 0, pre_manager, cmd_del_manager, NULL, "", RW},
4194     {"set-manager", 1, INT_MAX, pre_manager, cmd_set_manager, NULL, "", RW},
4195
4196     /* SSL commands. */
4197     {"get-ssl", 0, 0, pre_cmd_get_ssl, cmd_get_ssl, NULL, "", RO},
4198     {"del-ssl", 0, 0, pre_cmd_del_ssl, cmd_del_ssl, NULL, "", RW},
4199     {"set-ssl", 3, 3, pre_cmd_set_ssl, cmd_set_ssl, NULL, "--bootstrap", RW},
4200
4201     /* Switch commands. */
4202     {"emer-reset", 0, 0, pre_cmd_emer_reset, cmd_emer_reset, NULL, "", RW},
4203
4204     /* Database commands. */
4205     {"comment", 0, INT_MAX, NULL, NULL, NULL, "", RO},
4206     {"get", 2, INT_MAX, pre_cmd_get, cmd_get, NULL, "--if-exists,--id=", RO},
4207     {"list", 1, INT_MAX, pre_cmd_list, cmd_list, NULL,
4208      "--if-exists,--columns=", RO},
4209     {"find", 1, INT_MAX, pre_cmd_find, cmd_find, NULL, "--columns=", RO},
4210     {"set", 3, INT_MAX, pre_cmd_set, cmd_set, NULL, "--if-exists", RW},
4211     {"add", 4, INT_MAX, pre_cmd_add, cmd_add, NULL, "--if-exists", RW},
4212     {"remove", 4, INT_MAX, pre_cmd_remove, cmd_remove, NULL, "--if-exists",
4213      RW},
4214     {"clear", 3, INT_MAX, pre_cmd_clear, cmd_clear, NULL, "--if-exists", RW},
4215     {"create", 2, INT_MAX, pre_create, cmd_create, post_create, "--id=", RW},
4216     {"destroy", 1, INT_MAX, pre_cmd_destroy, cmd_destroy, NULL,
4217      "--if-exists,--all", RW},
4218     {"wait-until", 2, INT_MAX, pre_cmd_wait_until, cmd_wait_until, NULL, "",
4219      RO},
4220
4221     {NULL, 0, 0, NULL, NULL, NULL, NULL, RO},
4222 };
4223