utilities/ovs-vsctl.c

   1 /*
   2  * Copyright (c) 2009, 2010 Nicira Networks.
   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 <assert.h>
  20 #include <ctype.h>
  21 #include <errno.h>
  22 #include <float.h>
  23 #include <getopt.h>
  24 #include <inttypes.h>
  25 #include <signal.h>
  26 #include <stdarg.h>
  27 #include <stdlib.h>
  28 #include <string.h>
  29
  30 #include "command-line.h"
  31 #include "compiler.h"
  32 #include "dirs.h"
  33 #include "dynamic-string.h"
  34 #include "json.h"
  35 #include "ovsdb-data.h"
  36 #include "ovsdb-idl.h"
  37 #include "poll-loop.h"
  38 #include "process.h"
  39 #include "stream-ssl.h"
  40 #include "svec.h"
  41 #include "vswitchd/vswitch-idl.h"
  42 #include "timeval.h"
  43 #include "util.h"
  44 #include "vlog.h"
  45
  46 VLOG_DEFINE_THIS_MODULE(vsctl)
  47
  48 /* vsctl_fatal() also logs the error, so it is preferred in this file. */
  49 #define ovs_fatal please_use_vsctl_fatal_instead_of_ovs_fatal
  50
  51 struct vsctl_context;
  52
  53 typedef void vsctl_handler_func(struct vsctl_context *);
  54
  55 struct vsctl_command_syntax {
  56     const char *name;
  57     int min_args;
  58     int max_args;
  59     vsctl_handler_func *run;
  60     vsctl_handler_func *postprocess;
  61     const char *options;
  62     enum { RO, RW } mode;       /* Does this command modify the database? */
  63 };
  64
  65 struct vsctl_command {
  66     /* Data that remains constant after initialization. */
  67     const struct vsctl_command_syntax *syntax;
  68     int argc;
  69     char **argv;
  70     struct shash options;
  71
  72     /* Data modified by commands. */
  73     struct ds output;
  74 };
  75
  76 /* --db: The database server to contact. */
  77 static const char *db;
  78
  79 /* --oneline: Write each command's output as a single line? */
  80 static bool oneline;
  81
  82 /* --dry-run: Do not commit any changes. */
  83 static bool dry_run;
  84
  85 /* --no-wait: Wait for ovs-vswitchd to reload its configuration? */
  86 static bool wait_for_reload = true;
  87
  88 /* --timeout: Time to wait for a connection to 'db'. */
  89 static int timeout;
  90
  91 /* All supported commands. */
  92 static const struct vsctl_command_syntax all_commands[];
  93
  94 /* The IDL we're using and the current transaction, if any.
  95  * This is for use by vsctl_exit() only, to allow it to clean up.
  96  * Other code should use its context arguments. */
  97 static struct ovsdb_idl *the_idl;
  98 static struct ovsdb_idl_txn *the_idl_txn;
  99
 100 static void vsctl_exit(int status) NO_RETURN;
 101 static void vsctl_fatal(const char *, ...) PRINTF_FORMAT(1, 2) NO_RETURN;
 102 static char *default_db(void);
 103 static void usage(void) NO_RETURN;
 104 static void parse_options(int argc, char *argv[]);
 105 static bool might_write_to_db(char **argv);
 106
 107 static struct vsctl_command *parse_commands(int argc, char *argv[],
 108                                             size_t *n_commandsp);
 109 static void parse_command(int argc, char *argv[], struct vsctl_command *);
 110 static const struct vsctl_command_syntax *find_command(const char *name);
 111 static void do_vsctl(const char *args,
 112                      struct vsctl_command *, size_t n_commands,
 113                      struct ovsdb_idl *);
 114
 115 static const struct vsctl_table_class *get_table(const char *table_name);
 116 static void set_column(const struct vsctl_table_class *,
 117                        const struct ovsdb_idl_row *, const char *arg,
 118                        struct ovsdb_symbol_table *);
 119
 120 int
 121 main(int argc, char *argv[])
 122 {
 123     extern struct vlog_module VLM_reconnect;
 124     struct ovsdb_idl *idl;
 125     struct vsctl_command *commands;
 126     size_t n_commands;
 127     char *args;
 128
 129     set_program_name(argv[0]);
 130     signal(SIGPIPE, SIG_IGN);
 131     vlog_set_levels(NULL, VLF_CONSOLE, VLL_WARN);
 132     vlog_set_levels(&VLM_reconnect, VLF_ANY_FACILITY, VLL_WARN);
 133     ovsrec_init();
 134
 135     /* Log our arguments.  This is often valuable for debugging systems. */
 136     args = process_escape_args(argv);
 137     VLOG(might_write_to_db(argv) ? VLL_INFO : VLL_DBG, "Called as %s", args);
 138
 139     /* Parse command line. */
 140     parse_options(argc, argv);
 141     commands = parse_commands(argc - optind, argv + optind, &n_commands);
 142
 143     if (timeout) {
 144         time_alarm(timeout);
 145     }
 146
 147     /* Now execute the commands. */
 148     idl = the_idl = ovsdb_idl_create(db, &ovsrec_idl_class);
 149     for (;;) {
 150         if (ovsdb_idl_run(idl)) {
 151             do_vsctl(args, commands, n_commands, idl);
 152         }
 153
 154         ovsdb_idl_wait(idl);
 155         poll_block();
 156     }
 157 }
 158
 159 static void
 160 parse_options(int argc, char *argv[])
 161 {
 162     enum {
 163         OPT_DB = UCHAR_MAX + 1,
 164         OPT_ONELINE,
 165         OPT_NO_SYSLOG,
 166         OPT_NO_WAIT,
 167         OPT_DRY_RUN,
 168         OPT_PEER_CA_CERT,
 169         VLOG_OPTION_ENUMS
 170     };
 171     static struct option long_options[] = {
 172         {"db", required_argument, 0, OPT_DB},
 173         {"no-syslog", no_argument, 0, OPT_NO_SYSLOG},
 174         {"no-wait", no_argument, 0, OPT_NO_WAIT},
 175         {"dry-run", no_argument, 0, OPT_DRY_RUN},
 176         {"oneline", no_argument, 0, OPT_ONELINE},
 177         {"timeout", required_argument, 0, 't'},
 178         {"help", no_argument, 0, 'h'},
 179         {"version", no_argument, 0, 'V'},
 180         VLOG_LONG_OPTIONS,
 181 #ifdef HAVE_OPENSSL
 182         STREAM_SSL_LONG_OPTIONS
 183         {"peer-ca-cert", required_argument, 0, OPT_PEER_CA_CERT},
 184 #endif
 185         {0, 0, 0, 0},
 186     };
 187     char *tmp, *short_options;
 188
 189     tmp = long_options_to_short_options(long_options);
 190     short_options = xasprintf("+%s", tmp);
 191     free(tmp);
 192
 193     for (;;) {
 194         int c;
 195
 196         c = getopt_long(argc, argv, short_options, long_options, NULL);
 197         if (c == -1) {
 198             break;
 199         }
 200
 201         switch (c) {
 202         case OPT_DB:
 203             db = optarg;
 204             break;
 205
 206         case OPT_ONELINE:
 207             oneline = true;
 208             break;
 209
 210         case OPT_NO_SYSLOG:
 211             vlog_set_levels(&VLM_vsctl, VLF_SYSLOG, VLL_WARN);
 212             break;
 213
 214         case OPT_NO_WAIT:
 215             wait_for_reload = false;
 216             break;
 217
 218         case OPT_DRY_RUN:
 219             dry_run = true;
 220             break;
 221
 222         case 'h':
 223             usage();
 224
 225         case 'V':
 226             OVS_PRINT_VERSION(0, 0);
 227             exit(EXIT_SUCCESS);
 228
 229         case 't':
 230             timeout = strtoul(optarg, NULL, 10);
 231             if (timeout < 0) {
 232                 vsctl_fatal("value %s on -t or --timeout is invalid",
 233                             optarg);
 234             }
 235             break;
 236
 237         VLOG_OPTION_HANDLERS
 238
 239 #ifdef HAVE_OPENSSL
 240         STREAM_SSL_OPTION_HANDLERS
 241
 242         case OPT_PEER_CA_CERT:
 243             stream_ssl_set_peer_ca_cert_file(optarg);
 244             break;
 245 #endif
 246
 247         case '?':
 248             exit(EXIT_FAILURE);
 249
 250         default:
 251             abort();
 252         }
 253     }
 254     free(short_options);
 255
 256     if (!db) {
 257         db = default_db();
 258     }
 259 }
 260
 261 static struct vsctl_command *
 262 parse_commands(int argc, char *argv[], size_t *n_commandsp)
 263 {
 264     struct vsctl_command *commands;
 265     size_t n_commands, allocated_commands;
 266     int i, start;
 267
 268     commands = NULL;
 269     n_commands = allocated_commands = 0;
 270
 271     for (start = i = 0; i <= argc; i++) {
 272         if (i == argc || !strcmp(argv[i], "--")) {
 273             if (i > start) {
 274                 if (n_commands >= allocated_commands) {
 275                     struct vsctl_command *c;
 276
 277                     commands = x2nrealloc(commands, &allocated_commands,
 278                                           sizeof *commands);
 279                     for (c = commands; c < &commands[n_commands]; c++) {
 280                         shash_moved(&c->options);
 281                     }
 282                 }
 283                 parse_command(i - start, &argv[start],
 284                               &commands[n_commands++]);
 285             }
 286             start = i + 1;
 287         }
 288     }
 289     if (!n_commands) {
 290         vsctl_fatal("missing command name (use --help for help)");
 291     }
 292     *n_commandsp = n_commands;
 293     return commands;
 294 }
 295
 296 static void
 297 parse_command(int argc, char *argv[], struct vsctl_command *command)
 298 {
 299     const struct vsctl_command_syntax *p;
 300     struct shash_node *node;
 301     int n_arg;
 302     int i;
 303
 304     shash_init(&command->options);
 305     for (i = 0; i < argc; i++) {
 306         const char *option = argv[i];
 307         const char *equals;
 308         char *key, *value;
 309
 310         if (option[0] != '-') {
 311             break;
 312         }
 313
 314         equals = strchr(option, '=');
 315         if (equals) {
 316             key = xmemdup0(option, equals - option);
 317             value = xstrdup(equals + 1);
 318         } else {
 319             key = xstrdup(option);
 320             value = NULL;
 321         }
 322
 323         if (shash_find(&command->options, key)) {
 324             vsctl_fatal("'%s' option specified multiple times", argv[i]);
 325         }
 326         shash_add_nocopy(&command->options, key, value);
 327     }
 328     if (i == argc) {
 329         vsctl_fatal("missing command name");
 330     }
 331
 332     p = find_command(argv[i]);
 333     if (!p) {
 334         vsctl_fatal("unknown command '%s'; use --help for help", argv[i]);
 335     }
 336
 337     SHASH_FOR_EACH (node, &command->options) {
 338         const char *s = strstr(p->options, node->name);
 339         int end = s ? s[strlen(node->name)] : EOF;
 340
 341         if (end != '=' && end != ',' && end != ' ' && end != '\0') {
 342             vsctl_fatal("'%s' command has no '%s' option",
 343                         argv[i], node->name);
 344         }
 345         if ((end == '=') != (node->data != NULL)) {
 346             if (end == '=') {
 347                 vsctl_fatal("missing argument to '%s' option on '%s' "
 348                             "command", node->name, argv[i]);
 349             } else {
 350                 vsctl_fatal("'%s' option on '%s' does not accept an "
 351                             "argument", node->name, argv[i]);
 352             }
 353         }
 354     }
 355
 356     n_arg = argc - i - 1;
 357     if (n_arg < p->min_args) {
 358         vsctl_fatal("'%s' command requires at least %d arguments",
 359                     p->name, p->min_args);
 360     } else if (n_arg > p->max_args) {
 361         int j;
 362
 363         for (j = i + 1; j < argc; j++) {
 364             if (argv[j][0] == '-') {
 365                 vsctl_fatal("'%s' command takes at most %d arguments "
 366                             "(note that options must precede command "
 367                             "names and follow a \"--\" argument)",
 368                             p->name, p->max_args);
 369             }
 370         }
 371
 372         vsctl_fatal("'%s' command takes at most %d arguments",
 373                     p->name, p->max_args);
 374     }
 375
 376     command->syntax = p;
 377     command->argc = n_arg + 1;
 378     command->argv = &argv[i];
 379 }
 380
 381 /* Returns the "struct vsctl_command_syntax" for a given command 'name', or a
 382  * null pointer if there is none. */
 383 static const struct vsctl_command_syntax *
 384 find_command(const char *name)
 385 {
 386     static struct shash commands = SHASH_INITIALIZER(&commands);
 387
 388     if (shash_is_empty(&commands)) {
 389         const struct vsctl_command_syntax *p;
 390
 391         for (p = all_commands; p->name; p++) {
 392             shash_add_assert(&commands, p->name, p);
 393         }
 394     }
 395
 396     return shash_find_data(&commands, name);
 397 }
 398
 399 static void
 400 vsctl_fatal(const char *format, ...)
 401 {
 402     char *message;
 403     va_list args;
 404
 405     va_start(args, format);
 406     message = xvasprintf(format, args);
 407     va_end(args);
 408
 409     vlog_set_levels(&VLM_vsctl, VLF_CONSOLE, VLL_EMER);
 410     VLOG_ERR("%s", message);
 411     ovs_error(0, "%s", message);
 412     vsctl_exit(EXIT_FAILURE);
 413 }
 414
 415 /* Frees the current transaction and the underlying IDL and then calls
 416  * exit(status).
 417  *
 418  * Freeing the transaction and the IDL is not strictly necessary, but it makes
 419  * for a clean memory leak report from valgrind in the normal case.  That makes
 420  * it easier to notice real memory leaks. */
 421 static void
 422 vsctl_exit(int status)
 423 {
 424     if (the_idl_txn) {
 425         ovsdb_idl_txn_abort(the_idl_txn);
 426         ovsdb_idl_txn_destroy(the_idl_txn);
 427     }
 428     ovsdb_idl_destroy(the_idl);
 429     exit(status);
 430 }
 431
 432 static void
 433 usage(void)
 434 {
 435     printf("\
 436 %s: ovs-vswitchd management utility\n\
 437 usage: %s [OPTIONS] COMMAND [ARG...]\n\
 438 \n\
 439 Bridge commands:\n\
 440   add-br BRIDGE               create a new bridge named BRIDGE\n\
 441   add-br BRIDGE PARENT VLAN   create new fake BRIDGE in PARENT on VLAN\n\
 442   del-br BRIDGE               delete BRIDGE and all of its ports\n\
 443   list-br                     print the names of all the bridges\n\
 444   br-exists BRIDGE            test whether BRIDGE exists\n\
 445   br-to-vlan BRIDGE           print the VLAN which BRIDGE is on\n\
 446   br-to-parent BRIDGE         print the parent of BRIDGE\n\
 447   br-set-external-id BRIDGE KEY VALUE  set KEY on BRIDGE to VALUE\n\
 448   br-set-external-id BRIDGE KEY  unset KEY on BRIDGE\n\
 449   br-get-external-id BRIDGE KEY  print value of KEY on BRIDGE\n\
 450   br-get-external-id BRIDGE  list key-value pairs on BRIDGE\n\
 451 \n\
 452 Port commands:\n\
 453   list-ports BRIDGE           print the names of all the ports on BRIDGE\n\
 454   add-port BRIDGE PORT        add network device PORT to BRIDGE\n\
 455   add-bond BRIDGE PORT IFACE...  add bonded port PORT in BRIDGE from IFACES\n\
 456   del-port [BRIDGE] PORT      delete PORT (which may be bonded) from BRIDGE\n\
 457   port-to-br PORT             print name of bridge that contains PORT\n\
 458 A bond is considered to be a single port.\n\
 459 \n\
 460 Interface commands (a bond consists of multiple interfaces):\n\
 461   list-ifaces BRIDGE          print the names of all interfaces on BRIDGE\n\
 462   iface-to-br IFACE           print name of bridge that contains IFACE\n\
 463 \n\
 464 Controller commands:\n\
 465   get-controller BRIDGE      print the controller for BRIDGE\n\
 466   del-controller BRIDGE      delete the controller for BRIDGE\n\
 467   set-controller BRIDGE TARGET  set the controller for BRIDGE to TARGET\n\
 468   get-fail-mode BRIDGE       print the fail-mode for BRIDGE\n\
 469   del-fail-mode BRIDGE       delete the fail-mode for BRIDGE\n\
 470   set-fail-mode BRIDGE MODE  set the fail-mode for BRIDGE to MODE\n\
 471 \n\
 472 SSL commands:\n\
 473   get-ssl                     print the SSL configuration\n\
 474   del-ssl                     delete the SSL configuration\n\
 475   set-ssl PRIV-KEY CERT CA-CERT  set the SSL configuration\n\
 476 \n\
 477 Switch commands:\n\
 478   emer-reset                  reset switch to known good state\n\
 479 \n\
 480 Database commands:\n\
 481   list TBL [REC]              list RECord (or all records) in TBL\n\
 482   get TBL REC COL[:KEY]       print values of COLumns in RECord in TBL\n\
 483   set TBL REC COL[:KEY]=VALUE set COLumn values in RECord in TBL\n\
 484   add TBL REC COL [KEY=]VALUE add (KEY=)VALUE to COLumn in RECord in TBL\n\
 485   remove TBL REC COL [KEY=]VALUE  remove (KEY=)VALUE from COLumn\n\
 486   clear TBL REC COL           clear values from COLumn in RECord in TBL\n\
 487   create TBL COL[:KEY]=VALUE  create and initialize new record\n\
 488   destroy TBL REC             delete RECord from TBL\n\
 489   wait-until TBL REC [COL[:KEY]=VALUE]  wait until condition is true\n\
 490 Potentially unsafe database commands require --force option.\n\
 491 \n\
 492 Options:\n\
 493   --db=DATABASE               connect to DATABASE\n\
 494                               (default: %s)\n\
 495   --oneline                   print exactly one line of output per command\n",
 496            program_name, program_name, default_db());
 497     vlog_usage();
 498     printf("\n\
 499 Other options:\n\
 500   -h, --help                  display this help message\n\
 501   -V, --version               display version information\n");
 502     exit(EXIT_SUCCESS);
 503 }
 504
 505 static char *
 506 default_db(void)
 507 {
 508     static char *def;
 509     if (!def) {
 510         def = xasprintf("unix:%s/db.sock", ovs_rundir);
 511     }
 512     return def;
 513 }
 514
 515 /* Returns true if it looks like this set of arguments might modify the
 516  * database, otherwise false.  (Not very smart, so it's prone to false
 517  * positives.) */
 518 static bool
 519 might_write_to_db(char **argv)
 520 {
 521     for (; *argv; argv++) {
 522         const struct vsctl_command_syntax *p = find_command(*argv);
 523         if (p && p->mode == RW) {
 524             return true;
 525         }
 526     }
 527     return false;
 528 }
 529 \f
 530 struct vsctl_context {
 531     /* Read-only. */
 532     int argc;
 533     char **argv;
 534     struct shash options;
 535
 536     /* Modifiable state. */
 537     struct ds output;
 538     struct ovsdb_idl *idl;
 539     struct ovsdb_idl_txn *txn;
 540     struct ovsdb_symbol_table *symtab;
 541     const struct ovsrec_open_vswitch *ovs;
 542     bool verified_ports;
 543
 544     /* A command may set this member to true if some prerequisite is not met
 545      * and the caller should wait for something to change and then retry. */
 546     bool try_again;
 547 };
 548
 549 struct vsctl_bridge {
 550     struct ovsrec_bridge *br_cfg;
 551     char *name;
 552     struct ovsrec_controller **ctrl;
 553     char *fail_mode;
 554     size_t n_ctrl;
 555     struct vsctl_bridge *parent;
 556     int vlan;
 557 };
 558
 559 struct vsctl_port {
 560     struct ovsrec_port *port_cfg;
 561     struct vsctl_bridge *bridge;
 562 };
 563
 564 struct vsctl_iface {
 565     struct ovsrec_interface *iface_cfg;
 566     struct vsctl_port *port;
 567 };
 568
 569 struct vsctl_info {
 570     struct vsctl_context *ctx;
 571     struct shash bridges;
 572     struct shash ports;
 573     struct shash ifaces;
 574 };
 575
 576 static char *
 577 vsctl_context_to_string(const struct vsctl_context *ctx)
 578 {
 579     const struct shash_node *node;
 580     struct svec words;
 581     char *s;
 582     int i;
 583
 584     svec_init(&words);
 585     SHASH_FOR_EACH (node, &ctx->options) {
 586         svec_add(&words, node->name);
 587     }
 588     for (i = 0; i < ctx->argc; i++) {
 589         svec_add(&words, ctx->argv[i]);
 590     }
 591     svec_terminate(&words);
 592
 593     s = process_escape_args(words.names);
 594
 595     svec_destroy(&words);
 596
 597     return s;
 598 }
 599
 600 static void
 601 verify_ports(struct vsctl_context *ctx)
 602 {
 603     if (!ctx->verified_ports) {
 604         const struct ovsrec_bridge *bridge;
 605         const struct ovsrec_port *port;
 606
 607         ovsrec_open_vswitch_verify_bridges(ctx->ovs);
 608         OVSREC_BRIDGE_FOR_EACH (bridge, ctx->idl) {
 609             ovsrec_bridge_verify_ports(bridge);
 610         }
 611         OVSREC_PORT_FOR_EACH (port, ctx->idl) {
 612             ovsrec_port_verify_interfaces(port);
 613         }
 614
 615         ctx->verified_ports = true;
 616     }
 617 }
 618
 619 static struct vsctl_bridge *
 620 add_bridge(struct vsctl_info *b,
 621            struct ovsrec_bridge *br_cfg, const char *name,
 622            struct vsctl_bridge *parent, int vlan)
 623 {
 624     struct vsctl_bridge *br = xmalloc(sizeof *br);
 625     br->br_cfg = br_cfg;
 626     br->name = xstrdup(name);
 627     br->parent = parent;
 628     br->vlan = vlan;
 629     if (parent) {
 630         br->ctrl = parent->br_cfg->controller;
 631         br->n_ctrl = parent->br_cfg->n_controller;
 632         br->fail_mode = parent->br_cfg->fail_mode;
 633     } else {
 634         br->ctrl = br_cfg->controller;
 635         br->n_ctrl = br_cfg->n_controller;
 636         br->fail_mode = br_cfg->fail_mode;
 637     }
 638     shash_add(&b->bridges, br->name, br);
 639     return br;
 640 }
 641
 642 static bool
 643 port_is_fake_bridge(const struct ovsrec_port *port_cfg)
 644 {
 645     return (port_cfg->fake_bridge
 646             && port_cfg->tag
 647             && *port_cfg->tag >= 1 && *port_cfg->tag <= 4095);
 648 }
 649
 650 static struct vsctl_bridge *
 651 find_vlan_bridge(struct vsctl_info *info,
 652                  struct vsctl_bridge *parent, int vlan)
 653 {
 654     struct shash_node *node;
 655
 656     SHASH_FOR_EACH (node, &info->bridges) {
 657         struct vsctl_bridge *br = node->data;
 658         if (br->parent == parent && br->vlan == vlan) {
 659             return br;
 660         }
 661     }
 662
 663     return NULL;
 664 }
 665
 666 static void
 667 free_info(struct vsctl_info *info)
 668 {
 669     struct shash_node *node;
 670
 671     SHASH_FOR_EACH (node, &info->bridges) {
 672         struct vsctl_bridge *bridge = node->data;
 673         free(bridge->name);
 674         free(bridge);
 675     }
 676     shash_destroy(&info->bridges);
 677
 678     shash_destroy_free_data(&info->ports);
 679     shash_destroy_free_data(&info->ifaces);
 680 }
 681
 682 static void
 683 get_info(struct vsctl_context *ctx, struct vsctl_info *info)
 684 {
 685     const struct ovsrec_open_vswitch *ovs = ctx->ovs;
 686     struct shash bridges, ports;
 687     size_t i;
 688
 689     info->ctx = ctx;
 690     shash_init(&info->bridges);
 691     shash_init(&info->ports);
 692     shash_init(&info->ifaces);
 693
 694     shash_init(&bridges);
 695     shash_init(&ports);
 696     for (i = 0; i < ovs->n_bridges; i++) {
 697         struct ovsrec_bridge *br_cfg = ovs->bridges[i];
 698         struct vsctl_bridge *br;
 699         size_t j;
 700
 701         if (!shash_add_once(&bridges, br_cfg->name, NULL)) {
 702             VLOG_WARN("%s: database contains duplicate bridge name",
 703                       br_cfg->name);
 704             continue;
 705         }
 706         br = add_bridge(info, br_cfg, br_cfg->name, NULL, 0);
 707         if (!br) {
 708             continue;
 709         }
 710
 711         for (j = 0; j < br_cfg->n_ports; j++) {
 712             struct ovsrec_port *port_cfg = br_cfg->ports[j];
 713
 714             if (!shash_add_once(&ports, port_cfg->name, NULL)) {
 715                 VLOG_WARN("%s: database contains duplicate port name",
 716                           port_cfg->name);
 717                 continue;
 718             }
 719
 720             if (port_is_fake_bridge(port_cfg)
 721                 && shash_add_once(&bridges, port_cfg->name, NULL)) {
 722                 add_bridge(info, NULL, port_cfg->name, br, *port_cfg->tag);
 723             }
 724         }
 725     }
 726     shash_destroy(&bridges);
 727     shash_destroy(&ports);
 728
 729     shash_init(&bridges);
 730     shash_init(&ports);
 731     for (i = 0; i < ovs->n_bridges; i++) {
 732         struct ovsrec_bridge *br_cfg = ovs->bridges[i];
 733         struct vsctl_bridge *br;
 734         size_t j;
 735
 736         if (!shash_add_once(&bridges, br_cfg->name, NULL)) {
 737             continue;
 738         }
 739         br = shash_find_data(&info->bridges, br_cfg->name);
 740         for (j = 0; j < br_cfg->n_ports; j++) {
 741             struct ovsrec_port *port_cfg = br_cfg->ports[j];
 742             struct vsctl_port *port;
 743             size_t k;
 744
 745             if (!shash_add_once(&ports, port_cfg->name, NULL)) {
 746                 continue;
 747             }
 748
 749             if (port_is_fake_bridge(port_cfg)
 750                 && !shash_add_once(&bridges, port_cfg->name, NULL)) {
 751                 continue;
 752             }
 753
 754             port = xmalloc(sizeof *port);
 755             port->port_cfg = port_cfg;
 756             if (port_cfg->tag
 757                 && *port_cfg->tag >= 1 && *port_cfg->tag <= 4095) {
 758                 port->bridge = find_vlan_bridge(info, br, *port_cfg->tag);
 759                 if (!port->bridge) {
 760                     port->bridge = br;
 761                 }
 762             } else {
 763                 port->bridge = br;
 764             }
 765             shash_add(&info->ports, port_cfg->name, port);
 766
 767             for (k = 0; k < port_cfg->n_interfaces; k++) {
 768                 struct ovsrec_interface *iface_cfg = port_cfg->interfaces[k];
 769                 struct vsctl_iface *iface;
 770
 771                 if (shash_find(&info->ifaces, iface_cfg->name)) {
 772                     VLOG_WARN("%s: database contains duplicate interface name",
 773                               iface_cfg->name);
 774                     continue;
 775                 }
 776
 777                 iface = xmalloc(sizeof *iface);
 778                 iface->iface_cfg = iface_cfg;
 779                 iface->port = port;
 780                 shash_add(&info->ifaces, iface_cfg->name, iface);
 781             }
 782         }
 783     }
 784     shash_destroy(&bridges);
 785     shash_destroy(&ports);
 786 }
 787
 788 static void
 789 check_conflicts(struct vsctl_info *info, const char *name,
 790                 char *msg)
 791 {
 792     struct vsctl_iface *iface;
 793     struct vsctl_port *port;
 794
 795     verify_ports(info->ctx);
 796
 797     if (shash_find(&info->bridges, name)) {
 798         vsctl_fatal("%s because a bridge named %s already exists",
 799                     msg, name);
 800     }
 801
 802     port = shash_find_data(&info->ports, name);
 803     if (port) {
 804         vsctl_fatal("%s because a port named %s already exists on "
 805                     "bridge %s", msg, name, port->bridge->name);
 806     }
 807
 808     iface = shash_find_data(&info->ifaces, name);
 809     if (iface) {
 810         vsctl_fatal("%s because an interface named %s already exists "
 811                     "on bridge %s", msg, name, iface->port->bridge->name);
 812     }
 813
 814     free(msg);
 815 }
 816
 817 static struct vsctl_bridge *
 818 find_bridge(struct vsctl_info *info, const char *name, bool must_exist)
 819 {
 820     struct vsctl_bridge *br = shash_find_data(&info->bridges, name);
 821     if (must_exist && !br) {
 822         vsctl_fatal("no bridge named %s", name);
 823     }
 824     ovsrec_open_vswitch_verify_bridges(info->ctx->ovs);
 825     return br;
 826 }
 827
 828 static struct vsctl_bridge *
 829 find_real_bridge(struct vsctl_info *info, const char *name, bool must_exist)
 830 {
 831     struct vsctl_bridge *br = find_bridge(info, name, must_exist);
 832     if (br && br->parent) {
 833         vsctl_fatal("%s is a fake bridge", name);
 834     }
 835     return br;
 836 }
 837
 838 static struct vsctl_port *
 839 find_port(struct vsctl_info *info, const char *name, bool must_exist)
 840 {
 841     struct vsctl_port *port = shash_find_data(&info->ports, name);
 842     if (port && !strcmp(name, port->bridge->name)) {
 843         port = NULL;
 844     }
 845     if (must_exist && !port) {
 846         vsctl_fatal("no port named %s", name);
 847     }
 848     verify_ports(info->ctx);
 849     return port;
 850 }
 851
 852 static struct vsctl_iface *
 853 find_iface(struct vsctl_info *info, const char *name, bool must_exist)
 854 {
 855     struct vsctl_iface *iface = shash_find_data(&info->ifaces, name);
 856     if (iface && !strcmp(name, iface->port->bridge->name)) {
 857         iface = NULL;
 858     }
 859     if (must_exist && !iface) {
 860         vsctl_fatal("no interface named %s", name);
 861     }
 862     verify_ports(info->ctx);
 863     return iface;
 864 }
 865
 866 static void
 867 bridge_insert_port(struct ovsrec_bridge *br, struct ovsrec_port *port)
 868 {
 869     struct ovsrec_port **ports;
 870     size_t i;
 871
 872     ports = xmalloc(sizeof *br->ports * (br->n_ports + 1));
 873     for (i = 0; i < br->n_ports; i++) {
 874         ports[i] = br->ports[i];
 875     }
 876     ports[br->n_ports] = port;
 877     ovsrec_bridge_set_ports(br, ports, br->n_ports + 1);
 878     free(ports);
 879 }
 880
 881 static void
 882 bridge_delete_port(struct ovsrec_bridge *br, struct ovsrec_port *port)
 883 {
 884     struct ovsrec_port **ports;
 885     size_t i, n;
 886
 887     ports = xmalloc(sizeof *br->ports * br->n_ports);
 888     for (i = n = 0; i < br->n_ports; i++) {
 889         if (br->ports[i] != port) {
 890             ports[n++] = br->ports[i];
 891         }
 892     }
 893     ovsrec_bridge_set_ports(br, ports, n);
 894     free(ports);
 895 }
 896
 897 static void
 898 ovs_insert_bridge(const struct ovsrec_open_vswitch *ovs,
 899                   struct ovsrec_bridge *bridge)
 900 {
 901     struct ovsrec_bridge **bridges;
 902     size_t i;
 903
 904     bridges = xmalloc(sizeof *ovs->bridges * (ovs->n_bridges + 1));
 905     for (i = 0; i < ovs->n_bridges; i++) {
 906         bridges[i] = ovs->bridges[i];
 907     }
 908     bridges[ovs->n_bridges] = bridge;
 909     ovsrec_open_vswitch_set_bridges(ovs, bridges, ovs->n_bridges + 1);
 910     free(bridges);
 911 }
 912
 913 static void
 914 ovs_delete_bridge(const struct ovsrec_open_vswitch *ovs,
 915                   struct ovsrec_bridge *bridge)
 916 {
 917     struct ovsrec_bridge **bridges;
 918     size_t i, n;
 919
 920     bridges = xmalloc(sizeof *ovs->bridges * ovs->n_bridges);
 921     for (i = n = 0; i < ovs->n_bridges; i++) {
 922         if (ovs->bridges[i] != bridge) {
 923             bridges[n++] = ovs->bridges[i];
 924         }
 925     }
 926     ovsrec_open_vswitch_set_bridges(ovs, bridges, n);
 927     free(bridges);
 928 }
 929
 930 static void
 931 cmd_init(struct vsctl_context *ctx OVS_UNUSED)
 932 {
 933 }
 934
 935 static void
 936 cmd_emer_reset(struct vsctl_context *ctx)
 937 {
 938     const struct ovsdb_idl *idl = ctx->idl;
 939     const struct ovsrec_bridge *br;
 940     const struct ovsrec_port *port;
 941     const struct ovsrec_interface *iface;
 942     const struct ovsrec_mirror *mirror, *next_mirror;
 943     const struct ovsrec_controller *ctrl, *next_ctrl;
 944     const struct ovsrec_netflow *nf, *next_nf;
 945     const struct ovsrec_ssl *ssl, *next_ssl;
 946     const struct ovsrec_sflow *sflow, *next_sflow;
 947
 948
 949     /* Reset the Open_vSwitch table. */
 950     ovsrec_open_vswitch_set_managers(ctx->ovs, NULL, 0);
 951     ovsrec_open_vswitch_set_ssl(ctx->ovs, NULL);
 952
 953     OVSREC_BRIDGE_FOR_EACH (br, idl) {
 954         int i;
 955         char *hw_key = "hwaddr";
 956         char *hw_val = NULL;
 957
 958         ovsrec_bridge_set_controller(br, NULL, 0);
 959         ovsrec_bridge_set_mirrors(br, NULL, 0);
 960         ovsrec_bridge_set_netflow(br, NULL);
 961         ovsrec_bridge_set_sflow(br, NULL);
 962         ovsrec_bridge_set_flood_vlans(br, NULL, 0);
 963
 964         /* We only want to save the "hwaddr" key from other_config. */
 965         for (i=0; i < br->n_other_config; i++) {
 966             if (!strcmp(br->key_other_config[i], hw_key)) {
 967                 hw_val = br->value_other_config[i];
 968                 break;
 969             }
 970         }
 971         if (hw_val) {
 972             char *val = xstrdup(hw_val);
 973             ovsrec_bridge_set_other_config(br, &hw_key, &val, 1);
 974             free(val);
 975         } else {
 976             ovsrec_bridge_set_other_config(br, NULL, NULL, 0);
 977         }
 978     }
 979
 980     OVSREC_PORT_FOR_EACH (port, idl) {
 981         ovsrec_port_set_other_config(port, NULL, NULL, 0);
 982     }
 983
 984     OVSREC_INTERFACE_FOR_EACH (iface, idl) {
 985         /* xxx What do we do about gre/patch devices created by mgr? */
 986
 987         ovsrec_interface_set_ingress_policing_rate(iface, 0);
 988         ovsrec_interface_set_ingress_policing_burst(iface, 0);
 989     }
 990
 991     OVSREC_MIRROR_FOR_EACH_SAFE (mirror, next_mirror, idl) {
 992         ovsrec_mirror_delete(mirror);
 993     }
 994
 995     OVSREC_CONTROLLER_FOR_EACH_SAFE (ctrl, next_ctrl, idl) {
 996         ovsrec_controller_delete(ctrl);
 997     }
 998
 999     OVSREC_NETFLOW_FOR_EACH_SAFE (nf, next_nf, idl) {
1000         ovsrec_netflow_delete(nf);
1001     }
1002
1003     OVSREC_SSL_FOR_EACH_SAFE (ssl, next_ssl, idl) {
1004         ovsrec_ssl_delete(ssl);
1005     }
1006
1007     OVSREC_SFLOW_FOR_EACH_SAFE (sflow, next_sflow, idl) {
1008         ovsrec_sflow_delete(sflow);
1009     }
1010 }
1011
1012 static void
1013 cmd_add_br(struct vsctl_context *ctx)
1014 {
1015     bool may_exist = shash_find(&ctx->options, "--may-exist") != 0;
1016     const char *br_name, *parent_name;
1017     struct vsctl_info info;
1018     int vlan;
1019
1020     br_name = ctx->argv[1];
1021     if (ctx->argc == 2) {
1022         parent_name = NULL;
1023         vlan = 0;
1024     } else if (ctx->argc == 4) {
1025         parent_name = ctx->argv[2];
1026         vlan = atoi(ctx->argv[3]);
1027         if (vlan < 1 || vlan > 4095) {
1028             vsctl_fatal("%s: vlan must be between 1 and 4095", ctx->argv[0]);
1029         }
1030     } else {
1031         vsctl_fatal("'%s' command takes exactly 1 or 3 arguments",
1032                     ctx->argv[0]);
1033     }
1034
1035     get_info(ctx, &info);
1036     if (may_exist) {
1037         struct vsctl_bridge *br;
1038
1039         br = find_bridge(&info, br_name, false);
1040         if (br) {
1041             if (!parent_name) {
1042                 if (br->parent) {
1043                     vsctl_fatal("\"--may-exist add-br %s\" but %s is "
1044                                 "a VLAN bridge for VLAN %d",
1045                                 br_name, br_name, br->vlan);
1046                 }
1047             } else {
1048                 if (!br->parent) {
1049                     vsctl_fatal("\"--may-exist add-br %s %s %d\" but %s "
1050                                 "is not a VLAN bridge",
1051                                 br_name, parent_name, vlan, br_name);
1052                 } else if (strcmp(br->parent->name, parent_name)) {
1053                     vsctl_fatal("\"--may-exist add-br %s %s %d\" but %s "
1054                                 "has the wrong parent %s",
1055                                 br_name, parent_name, vlan,
1056                                 br_name, br->parent->name);
1057                 } else if (br->vlan != vlan) {
1058                     vsctl_fatal("\"--may-exist add-br %s %s %d\" but %s "
1059                                 "is a VLAN bridge for the wrong VLAN %d",
1060                                 br_name, parent_name, vlan, br_name, br->vlan);
1061                 }
1062             }
1063             return;
1064         }
1065     }
1066     check_conflicts(&info, br_name,
1067                     xasprintf("cannot create a bridge named %s", br_name));
1068
1069     if (!parent_name) {
1070         struct ovsrec_port *port;
1071         struct ovsrec_interface *iface;
1072         struct ovsrec_bridge *br;
1073
1074         iface = ovsrec_interface_insert(ctx->txn);
1075         ovsrec_interface_set_name(iface, br_name);
1076
1077         port = ovsrec_port_insert(ctx->txn);
1078         ovsrec_port_set_name(port, br_name);
1079         ovsrec_port_set_interfaces(port, &iface, 1);
1080
1081         br = ovsrec_bridge_insert(ctx->txn);
1082         ovsrec_bridge_set_name(br, br_name);
1083         ovsrec_bridge_set_ports(br, &port, 1);
1084
1085         ovs_insert_bridge(ctx->ovs, br);
1086     } else {
1087         struct vsctl_bridge *parent;
1088         struct ovsrec_port *port;
1089         struct ovsrec_interface *iface;
1090         struct ovsrec_bridge *br;
1091         int64_t tag = vlan;
1092
1093         parent = find_bridge(&info, parent_name, false);
1094         if (parent && parent->vlan) {
1095             vsctl_fatal("cannot create bridge with fake bridge as parent");
1096         }
1097         if (!parent) {
1098             vsctl_fatal("parent bridge %s does not exist", parent_name);
1099         }
1100         br = parent->br_cfg;
1101
1102         iface = ovsrec_interface_insert(ctx->txn);
1103         ovsrec_interface_set_name(iface, br_name);
1104         ovsrec_interface_set_type(iface, "internal");
1105
1106         port = ovsrec_port_insert(ctx->txn);
1107         ovsrec_port_set_name(port, br_name);
1108         ovsrec_port_set_interfaces(port, &iface, 1);
1109         ovsrec_port_set_fake_bridge(port, true);
1110         ovsrec_port_set_tag(port, &tag, 1);
1111
1112         bridge_insert_port(br, port);
1113     }
1114
1115     free_info(&info);
1116 }
1117
1118 static void
1119 del_port(struct vsctl_info *info, struct vsctl_port *port)
1120 {
1121     struct shash_node *node;
1122
1123     SHASH_FOR_EACH (node, &info->ifaces) {
1124         struct vsctl_iface *iface = node->data;
1125         if (iface->port == port) {
1126             ovsrec_interface_delete(iface->iface_cfg);
1127         }
1128     }
1129     ovsrec_port_delete(port->port_cfg);
1130
1131     bridge_delete_port((port->bridge->parent
1132                         ? port->bridge->parent->br_cfg
1133                         : port->bridge->br_cfg), port->port_cfg);
1134 }
1135
1136 static void
1137 cmd_del_br(struct vsctl_context *ctx)
1138 {
1139     bool must_exist = !shash_find(&ctx->options, "--if-exists");
1140     struct vsctl_bridge *bridge;
1141     struct vsctl_info info;
1142
1143     get_info(ctx, &info);
1144     bridge = find_bridge(&info, ctx->argv[1], must_exist);
1145     if (bridge) {
1146         struct shash_node *node;
1147
1148         SHASH_FOR_EACH (node, &info.ports) {
1149             struct vsctl_port *port = node->data;
1150             if (port->bridge == bridge || port->bridge->parent == bridge
1151                 || !strcmp(port->port_cfg->name, bridge->name)) {
1152                 del_port(&info, port);
1153             }
1154         }
1155         if (bridge->br_cfg) {
1156             ovsrec_bridge_delete(bridge->br_cfg);
1157             ovs_delete_bridge(ctx->ovs, bridge->br_cfg);
1158         }
1159     }
1160     free_info(&info);
1161 }
1162
1163 static void
1164 output_sorted(struct svec *svec, struct ds *output)
1165 {
1166     const char *name;
1167     size_t i;
1168
1169     svec_sort(svec);
1170     SVEC_FOR_EACH (i, name, svec) {
1171         ds_put_format(output, "%s\n", name);
1172     }
1173 }
1174
1175 static void
1176 cmd_list_br(struct vsctl_context *ctx)
1177 {
1178     struct shash_node *node;
1179     struct vsctl_info info;
1180     struct svec bridges;
1181
1182     get_info(ctx, &info);
1183
1184     svec_init(&bridges);
1185     SHASH_FOR_EACH (node, &info.bridges) {
1186         struct vsctl_bridge *br = node->data;
1187         svec_add(&bridges, br->name);
1188     }
1189     output_sorted(&bridges, &ctx->output);
1190     svec_destroy(&bridges);
1191
1192     free_info(&info);
1193 }
1194
1195 static void
1196 cmd_br_exists(struct vsctl_context *ctx)
1197 {
1198     struct vsctl_info info;
1199
1200     get_info(ctx, &info);
1201     if (!find_bridge(&info, ctx->argv[1], false)) {
1202         vsctl_exit(2);
1203     }
1204     free_info(&info);
1205 }
1206
1207 /* Returns true if 'b_prefix' (of length 'b_prefix_len') concatenated with 'b'
1208  * equals 'a', false otherwise. */
1209 static bool
1210 key_matches(const char *a,
1211             const char *b_prefix, size_t b_prefix_len, const char *b)
1212 {
1213     return !strncmp(a, b_prefix, b_prefix_len) && !strcmp(a + b_prefix_len, b);
1214 }
1215
1216 static void
1217 set_external_id(char **old_keys, char **old_values, size_t old_n,
1218                 char *key, char *value,
1219                 char ***new_keysp, char ***new_valuesp, size_t *new_np)
1220 {
1221     char **new_keys;
1222     char **new_values;
1223     size_t new_n;
1224     size_t i;
1225
1226     new_keys = xmalloc(sizeof *new_keys * (old_n + 1));
1227     new_values = xmalloc(sizeof *new_values * (old_n + 1));
1228     new_n = 0;
1229     for (i = 0; i < old_n; i++) {
1230         if (strcmp(key, old_keys[i])) {
1231             new_keys[new_n] = old_keys[i];
1232             new_values[new_n] = old_values[i];
1233             new_n++;
1234         }
1235     }
1236     if (value) {
1237         new_keys[new_n] = key;
1238         new_values[new_n] = value;
1239         new_n++;
1240     }
1241     *new_keysp = new_keys;
1242     *new_valuesp = new_values;
1243     *new_np = new_n;
1244 }
1245
1246 static void
1247 cmd_br_set_external_id(struct vsctl_context *ctx)
1248 {
1249     struct vsctl_info info;
1250     struct vsctl_bridge *bridge;
1251     char **keys, **values;
1252     size_t n;
1253
1254     get_info(ctx, &info);
1255     bridge = find_bridge(&info, ctx->argv[1], true);
1256     if (bridge->br_cfg) {
1257         set_external_id(bridge->br_cfg->key_external_ids,
1258                         bridge->br_cfg->value_external_ids,
1259                         bridge->br_cfg->n_external_ids,
1260                         ctx->argv[2], ctx->argc >= 4 ? ctx->argv[3] : NULL,
1261                         &keys, &values, &n);
1262         ovsrec_bridge_verify_external_ids(bridge->br_cfg);
1263         ovsrec_bridge_set_external_ids(bridge->br_cfg, keys, values, n);
1264     } else {
1265         char *key = xasprintf("fake-bridge-%s", ctx->argv[2]);
1266         struct vsctl_port *port = shash_find_data(&info.ports, ctx->argv[1]);
1267         set_external_id(port->port_cfg->key_external_ids,
1268                         port->port_cfg->value_external_ids,
1269                         port->port_cfg->n_external_ids,
1270                         key, ctx->argc >= 4 ? ctx->argv[3] : NULL,
1271                         &keys, &values, &n);
1272         ovsrec_port_verify_external_ids(port->port_cfg);
1273         ovsrec_port_set_external_ids(port->port_cfg, keys, values, n);
1274         free(key);
1275     }
1276     free(keys);
1277     free(values);
1278
1279     free_info(&info);
1280 }
1281
1282 static void
1283 get_external_id(char **keys, char **values, size_t n,
1284                 const char *prefix, const char *key,
1285                 struct ds *output)
1286 {
1287     size_t prefix_len = strlen(prefix);
1288     struct svec svec;
1289     size_t i;
1290
1291     svec_init(&svec);
1292     for (i = 0; i < n; i++) {
1293         if (!key && !strncmp(keys[i], prefix, prefix_len)) {
1294             svec_add_nocopy(&svec, xasprintf("%s=%s",
1295                                              keys[i] + prefix_len, values[i]));
1296         } else if (key_matches(keys[i], prefix, prefix_len, key)) {
1297             svec_add(&svec, values[i]);
1298             break;
1299         }
1300     }
1301     output_sorted(&svec, output);
1302     svec_destroy(&svec);
1303 }
1304
1305 static void
1306 cmd_br_get_external_id(struct vsctl_context *ctx)
1307 {
1308     struct vsctl_info info;
1309     struct vsctl_bridge *bridge;
1310
1311     get_info(ctx, &info);
1312     bridge = find_bridge(&info, ctx->argv[1], true);
1313     if (bridge->br_cfg) {
1314         ovsrec_bridge_verify_external_ids(bridge->br_cfg);
1315         get_external_id(bridge->br_cfg->key_external_ids,
1316                         bridge->br_cfg->value_external_ids,
1317                         bridge->br_cfg->n_external_ids,
1318                         "", ctx->argc >= 3 ? ctx->argv[2] : NULL,
1319                         &ctx->output);
1320     } else {
1321         struct vsctl_port *port = shash_find_data(&info.ports, ctx->argv[1]);
1322         ovsrec_port_verify_external_ids(port->port_cfg);
1323         get_external_id(port->port_cfg->key_external_ids,
1324                         port->port_cfg->value_external_ids,
1325                         port->port_cfg->n_external_ids,
1326                         "fake-bridge-", ctx->argc >= 3 ? ctx->argv[2] : NULL, &ctx->output);
1327     }
1328     free_info(&info);
1329 }
1330
1331
1332 static void
1333 cmd_list_ports(struct vsctl_context *ctx)
1334 {
1335     struct vsctl_bridge *br;
1336     struct shash_node *node;
1337     struct vsctl_info info;
1338     struct svec ports;
1339
1340     get_info(ctx, &info);
1341     br = find_bridge(&info, ctx->argv[1], true);
1342     ovsrec_bridge_verify_ports(br->br_cfg ? br->br_cfg : br->parent->br_cfg);
1343
1344     svec_init(&ports);
1345     SHASH_FOR_EACH (node, &info.ports) {
1346         struct vsctl_port *port = node->data;
1347
1348         if (strcmp(port->port_cfg->name, br->name) && br == port->bridge) {
1349             svec_add(&ports, port->port_cfg->name);
1350         }
1351     }
1352     output_sorted(&ports, &ctx->output);
1353     svec_destroy(&ports);
1354
1355     free_info(&info);
1356 }
1357
1358 static void
1359 add_port(struct vsctl_context *ctx,
1360          const char *br_name, const char *port_name,
1361          bool may_exist, bool fake_iface,
1362          char *iface_names[], int n_ifaces,
1363          char *settings[], int n_settings)
1364 {
1365     struct vsctl_info info;
1366     struct vsctl_bridge *bridge;
1367     struct ovsrec_interface **ifaces;
1368     struct ovsrec_port *port;
1369     size_t i;
1370
1371     get_info(ctx, &info);
1372     if (may_exist) {
1373         struct vsctl_port *vsctl_port;
1374
1375         vsctl_port = find_port(&info, port_name, false);
1376         if (vsctl_port) {
1377             struct svec want_names, have_names;
1378
1379             svec_init(&want_names);
1380             for (i = 0; i < n_ifaces; i++) {
1381                 svec_add(&want_names, iface_names[i]);
1382             }
1383             svec_sort(&want_names);
1384
1385             svec_init(&have_names);
1386             for (i = 0; i < vsctl_port->port_cfg->n_interfaces; i++) {
1387                 svec_add(&have_names,
1388                          vsctl_port->port_cfg->interfaces[i]->name);
1389             }
1390             svec_sort(&have_names);
1391
1392             if (strcmp(vsctl_port->bridge->name, br_name)) {
1393                 char *command = vsctl_context_to_string(ctx);
1394                 vsctl_fatal("\"%s\" but %s is actually attached to bridge %s",
1395                             command, port_name, vsctl_port->bridge->name);
1396             }
1397
1398             if (!svec_equal(&want_names, &have_names)) {
1399                 char *have_names_string = svec_join(&have_names, ", ", "");
1400                 char *command = vsctl_context_to_string(ctx);
1401
1402                 vsctl_fatal("\"%s\" but %s actually has interface(s) %s",
1403                             command, port_name, have_names_string);
1404             }
1405
1406             svec_destroy(&want_names);
1407             svec_destroy(&have_names);
1408
1409             return;
1410         }
1411     }
1412     check_conflicts(&info, port_name,
1413                     xasprintf("cannot create a port named %s", port_name));
1414     for (i = 0; i < n_ifaces; i++) {
1415         check_conflicts(&info, iface_names[i],
1416                         xasprintf("cannot create an interface named %s",
1417                                   iface_names[i]));
1418     }
1419     bridge = find_bridge(&info, br_name, true);
1420
1421     ifaces = xmalloc(n_ifaces * sizeof *ifaces);
1422     for (i = 0; i < n_ifaces; i++) {
1423         ifaces[i] = ovsrec_interface_insert(ctx->txn);
1424         ovsrec_interface_set_name(ifaces[i], iface_names[i]);
1425     }
1426
1427     port = ovsrec_port_insert(ctx->txn);
1428     ovsrec_port_set_name(port, port_name);
1429     ovsrec_port_set_interfaces(port, ifaces, n_ifaces);
1430     ovsrec_port_set_bond_fake_iface(port, fake_iface);
1431     free(ifaces);
1432
1433     if (bridge->vlan) {
1434         int64_t tag = bridge->vlan;
1435         ovsrec_port_set_tag(port, &tag, 1);
1436     }
1437
1438     for (i = 0; i < n_settings; i++) {
1439         set_column(get_table("Port"), &port->header_, settings[i],
1440                    ctx->symtab);
1441     }
1442
1443     bridge_insert_port((bridge->parent ? bridge->parent->br_cfg
1444                         : bridge->br_cfg), port);
1445
1446     free_info(&info);
1447 }
1448
1449 static void
1450 cmd_add_port(struct vsctl_context *ctx)
1451 {
1452     bool may_exist = shash_find(&ctx->options, "--may-exist") != 0;
1453
1454     add_port(ctx, ctx->argv[1], ctx->argv[2], may_exist, false,
1455              &ctx->argv[2], 1, &ctx->argv[3], ctx->argc - 3);
1456 }
1457
1458 static void
1459 cmd_add_bond(struct vsctl_context *ctx)
1460 {
1461     bool may_exist = shash_find(&ctx->options, "--may-exist") != 0;
1462     bool fake_iface = shash_find(&ctx->options, "--fake-iface");
1463     int n_ifaces;
1464     int i;
1465
1466     n_ifaces = ctx->argc - 3;
1467     for (i = 3; i < ctx->argc; i++) {
1468         if (strchr(ctx->argv[i], '=')) {
1469             n_ifaces = i - 3;
1470             break;
1471         }
1472     }
1473     if (n_ifaces < 2) {
1474         vsctl_fatal("add-bond requires at least 2 interfaces, but only "
1475                     "%d were specified", n_ifaces);
1476     }
1477
1478     add_port(ctx, ctx->argv[1], ctx->argv[2], may_exist, fake_iface,
1479              &ctx->argv[3], n_ifaces,
1480              &ctx->argv[n_ifaces + 3], ctx->argc - 3 - n_ifaces);
1481 }
1482
1483 static void
1484 cmd_del_port(struct vsctl_context *ctx)
1485 {
1486     bool must_exist = !shash_find(&ctx->options, "--if-exists");
1487     bool with_iface = shash_find(&ctx->options, "--with-iface") != NULL;
1488     struct vsctl_port *port;
1489     struct vsctl_info info;
1490
1491     get_info(ctx, &info);
1492     if (!with_iface) {
1493         port = find_port(&info, ctx->argv[ctx->argc - 1], must_exist);
1494     } else {
1495         const char *target = ctx->argv[ctx->argc - 1];
1496         struct vsctl_iface *iface;
1497
1498         port = find_port(&info, target, false);
1499         if (!port) {
1500             iface = find_iface(&info, target, false);
1501             if (iface) {
1502                 port = iface->port;
1503             }
1504         }
1505         if (must_exist && !port) {
1506             vsctl_fatal("no port or interface named %s", target);
1507         }
1508     }
1509
1510     if (port) {
1511         if (ctx->argc == 3) {
1512             struct vsctl_bridge *bridge;
1513
1514             bridge = find_bridge(&info, ctx->argv[1], true);
1515             if (port->bridge != bridge) {
1516                 if (port->bridge->parent == bridge) {
1517                     vsctl_fatal("bridge %s does not have a port %s (although "
1518                                 "its parent bridge %s does)",
1519                                 ctx->argv[1], ctx->argv[2],
1520                                 bridge->parent->name);
1521                 } else {
1522                     vsctl_fatal("bridge %s does not have a port %s",
1523                                 ctx->argv[1], ctx->argv[2]);
1524                 }
1525             }
1526         }
1527
1528         del_port(&info, port);
1529     }
1530
1531     free_info(&info);
1532 }
1533
1534 static void
1535 cmd_port_to_br(struct vsctl_context *ctx)
1536 {
1537     struct vsctl_port *port;
1538     struct vsctl_info info;
1539
1540     get_info(ctx, &info);
1541     port = find_port(&info, ctx->argv[1], true);
1542     ds_put_format(&ctx->output, "%s\n", port->bridge->name);
1543     free_info(&info);
1544 }
1545
1546 static void
1547 cmd_br_to_vlan(struct vsctl_context *ctx)
1548 {
1549     struct vsctl_bridge *bridge;
1550     struct vsctl_info info;
1551
1552     get_info(ctx, &info);
1553     bridge = find_bridge(&info, ctx->argv[1], true);
1554     ds_put_format(&ctx->output, "%d\n", bridge->vlan);
1555     free_info(&info);
1556 }
1557
1558 static void
1559 cmd_br_to_parent(struct vsctl_context *ctx)
1560 {
1561     struct vsctl_bridge *bridge;
1562     struct vsctl_info info;
1563
1564     get_info(ctx, &info);
1565     bridge = find_bridge(&info, ctx->argv[1], true);
1566     if (bridge->parent) {
1567         bridge = bridge->parent;
1568     }
1569     ds_put_format(&ctx->output, "%s\n", bridge->name);
1570     free_info(&info);
1571 }
1572
1573 static void
1574 cmd_list_ifaces(struct vsctl_context *ctx)
1575 {
1576     struct vsctl_bridge *br;
1577     struct shash_node *node;
1578     struct vsctl_info info;
1579     struct svec ifaces;
1580
1581     get_info(ctx, &info);
1582     br = find_bridge(&info, ctx->argv[1], true);
1583     verify_ports(ctx);
1584
1585     svec_init(&ifaces);
1586     SHASH_FOR_EACH (node, &info.ifaces) {
1587         struct vsctl_iface *iface = node->data;
1588
1589         if (strcmp(iface->iface_cfg->name, br->name)
1590             && br == iface->port->bridge) {
1591             svec_add(&ifaces, iface->iface_cfg->name);
1592         }
1593     }
1594     output_sorted(&ifaces, &ctx->output);
1595     svec_destroy(&ifaces);
1596
1597     free_info(&info);
1598 }
1599
1600 static void
1601 cmd_iface_to_br(struct vsctl_context *ctx)
1602 {
1603     struct vsctl_iface *iface;
1604     struct vsctl_info info;
1605
1606     get_info(ctx, &info);
1607     iface = find_iface(&info, ctx->argv[1], true);
1608     ds_put_format(&ctx->output, "%s\n", iface->port->bridge->name);
1609     free_info(&info);
1610 }
1611
1612 static void
1613 verify_controllers(struct ovsrec_bridge *bridge)
1614 {
1615     if (bridge) {
1616         size_t i;
1617
1618         ovsrec_bridge_verify_controller(bridge);
1619         for (i = 0; i < bridge->n_controller; i++) {
1620             ovsrec_controller_verify_target(bridge->controller[i]);
1621         }
1622     }
1623 }
1624
1625 static void
1626 cmd_get_controller(struct vsctl_context *ctx)
1627 {
1628     struct vsctl_info info;
1629     struct vsctl_bridge *br;
1630     struct svec targets;
1631     size_t i;
1632
1633     get_info(ctx, &info);
1634     br = find_bridge(&info, ctx->argv[1], true);
1635     verify_controllers(br->br_cfg);
1636
1637     /* Print the targets in sorted order for reproducibility. */
1638     svec_init(&targets);
1639     for (i = 0; i < br->n_ctrl; i++) {
1640         svec_add(&targets, br->ctrl[i]->target);
1641     }
1642
1643     svec_sort(&targets);
1644     for (i = 0; i < targets.n; i++) {
1645         ds_put_format(&ctx->output, "%s\n", targets.names[i]);
1646     }
1647     svec_destroy(&targets);
1648
1649     free_info(&info);
1650 }
1651
1652 static void
1653 delete_controllers(struct ovsrec_controller **controllers,
1654                    size_t n_controllers)
1655 {
1656     size_t i;
1657
1658     for (i = 0; i < n_controllers; i++) {
1659         ovsrec_controller_delete(controllers[i]);
1660     }
1661 }
1662
1663 static void
1664 cmd_del_controller(struct vsctl_context *ctx)
1665 {
1666     struct vsctl_info info;
1667     struct vsctl_bridge *br;
1668
1669     get_info(ctx, &info);
1670     br = find_real_bridge(&info, ctx->argv[1], true);
1671     verify_controllers(br->br_cfg);
1672
1673     if (br->ctrl) {
1674         delete_controllers(br->ctrl, br->n_ctrl);
1675         ovsrec_bridge_set_controller(br->br_cfg, NULL, 0);
1676     }
1677
1678     free_info(&info);
1679 }
1680
1681 static struct ovsrec_controller **
1682 insert_controllers(struct ovsdb_idl_txn *txn, char *targets[], size_t n)
1683 {
1684     struct ovsrec_controller **controllers;
1685     size_t i;
1686
1687     controllers = xmalloc(n * sizeof *controllers);
1688     for (i = 0; i < n; i++) {
1689         controllers[i] = ovsrec_controller_insert(txn);
1690         ovsrec_controller_set_target(controllers[i], targets[i]);
1691     }
1692
1693     return controllers;
1694 }
1695
1696 static void
1697 cmd_set_controller(struct vsctl_context *ctx)
1698 {
1699     struct vsctl_info info;
1700     struct vsctl_bridge *br;
1701     struct ovsrec_controller **controllers;
1702     size_t n;
1703
1704     get_info(ctx, &info);
1705     br = find_real_bridge(&info, ctx->argv[1], true);
1706     verify_controllers(br->br_cfg);
1707
1708     delete_controllers(br->ctrl, br->n_ctrl);
1709
1710     n = ctx->argc - 2;
1711     controllers = insert_controllers(ctx->txn, &ctx->argv[2], n);
1712     ovsrec_bridge_set_controller(br->br_cfg, controllers, n);
1713     free(controllers);
1714
1715     free_info(&info);
1716 }
1717
1718 static void
1719 cmd_get_fail_mode(struct vsctl_context *ctx)
1720 {
1721     struct vsctl_info info;
1722     struct vsctl_bridge *br;
1723
1724     get_info(ctx, &info);
1725     br = find_bridge(&info, ctx->argv[1], true);
1726
1727     if (br->br_cfg) {
1728         ovsrec_bridge_verify_fail_mode(br->br_cfg);
1729     }
1730     if (br->fail_mode && strlen(br->fail_mode)) {
1731         ds_put_format(&ctx->output, "%s\n", br->fail_mode);
1732     }
1733
1734     free_info(&info);
1735 }
1736
1737 static void
1738 cmd_del_fail_mode(struct vsctl_context *ctx)
1739 {
1740     struct vsctl_info info;
1741     struct vsctl_bridge *br;
1742
1743     get_info(ctx, &info);
1744     br = find_real_bridge(&info, ctx->argv[1], true);
1745
1746     ovsrec_bridge_set_fail_mode(br->br_cfg, NULL);
1747
1748     free_info(&info);
1749 }
1750
1751 static void
1752 cmd_set_fail_mode(struct vsctl_context *ctx)
1753 {
1754     struct vsctl_info info;
1755     struct vsctl_bridge *br;
1756     const char *fail_mode = ctx->argv[2];
1757
1758     get_info(ctx, &info);
1759     br = find_real_bridge(&info, ctx->argv[1], true);
1760
1761     if (strcmp(fail_mode, "standalone") && strcmp(fail_mode, "secure")) {
1762         vsctl_fatal("fail-mode must be \"standalone\" or \"secure\"");
1763     }
1764
1765     ovsrec_bridge_set_fail_mode(br->br_cfg, fail_mode);
1766
1767     free_info(&info);
1768 }
1769
1770 static void
1771 cmd_get_ssl(struct vsctl_context *ctx)
1772 {
1773     struct ovsrec_ssl *ssl = ctx->ovs->ssl;
1774
1775     ovsrec_open_vswitch_verify_ssl(ctx->ovs);
1776     if (ssl) {
1777         ovsrec_ssl_verify_private_key(ssl);
1778         ovsrec_ssl_verify_certificate(ssl);
1779         ovsrec_ssl_verify_ca_cert(ssl);
1780         ovsrec_ssl_verify_bootstrap_ca_cert(ssl);
1781
1782         ds_put_format(&ctx->output, "Private key: %s\n", ssl->private_key);
1783         ds_put_format(&ctx->output, "Certificate: %s\n", ssl->certificate);
1784         ds_put_format(&ctx->output, "CA Certificate: %s\n", ssl->ca_cert);
1785         ds_put_format(&ctx->output, "Bootstrap: %s\n",
1786                 ssl->bootstrap_ca_cert ? "true" : "false");
1787     }
1788 }
1789
1790 static void
1791 cmd_del_ssl(struct vsctl_context *ctx)
1792 {
1793     struct ovsrec_ssl *ssl = ctx->ovs->ssl;
1794
1795     if (ssl) {
1796         ovsrec_open_vswitch_verify_ssl(ctx->ovs);
1797         ovsrec_ssl_delete(ssl);
1798         ovsrec_open_vswitch_set_ssl(ctx->ovs, NULL);
1799     }
1800 }
1801
1802 static void
1803 cmd_set_ssl(struct vsctl_context *ctx)
1804 {
1805     bool bootstrap = shash_find(&ctx->options, "--bootstrap");
1806     struct ovsrec_ssl *ssl = ctx->ovs->ssl;
1807
1808     ovsrec_open_vswitch_verify_ssl(ctx->ovs);
1809     if (ssl) {
1810         ovsrec_ssl_delete(ssl);
1811     }
1812     ssl = ovsrec_ssl_insert(ctx->txn);
1813
1814     ovsrec_ssl_set_private_key(ssl, ctx->argv[1]);
1815     ovsrec_ssl_set_certificate(ssl, ctx->argv[2]);
1816     ovsrec_ssl_set_ca_cert(ssl, ctx->argv[3]);
1817
1818     ovsrec_ssl_set_bootstrap_ca_cert(ssl, bootstrap);
1819
1820     ovsrec_open_vswitch_set_ssl(ctx->ovs, ssl);
1821 }
1822 \f
1823 /* Parameter commands. */
1824
1825 struct vsctl_row_id {
1826     const struct ovsdb_idl_table_class *table;
1827     const struct ovsdb_idl_column *name_column;
1828     const struct ovsdb_idl_column *uuid_column;
1829 };
1830
1831 struct vsctl_table_class {
1832     struct ovsdb_idl_table_class *class;
1833     struct vsctl_row_id row_ids[2];
1834 };
1835
1836 static const struct vsctl_table_class tables[] = {
1837     {&ovsrec_table_bridge,
1838      {{&ovsrec_table_bridge, &ovsrec_bridge_col_name, NULL},
1839       {NULL, NULL, NULL}}},
1840
1841     {&ovsrec_table_controller,
1842      {{&ovsrec_table_bridge,
1843        &ovsrec_bridge_col_name,
1844        &ovsrec_bridge_col_controller}}},
1845
1846     {&ovsrec_table_interface,
1847      {{&ovsrec_table_interface, &ovsrec_interface_col_name, NULL},
1848       {NULL, NULL, NULL}}},
1849
1850     {&ovsrec_table_mirror,
1851      {{&ovsrec_table_mirror, &ovsrec_mirror_col_name, NULL},
1852       {NULL, NULL, NULL}}},
1853
1854     {&ovsrec_table_netflow,
1855      {{&ovsrec_table_bridge,
1856        &ovsrec_bridge_col_name,
1857        &ovsrec_bridge_col_netflow},
1858       {NULL, NULL, NULL}}},
1859
1860     {&ovsrec_table_open_vswitch,
1861      {{&ovsrec_table_open_vswitch, NULL, NULL},
1862       {NULL, NULL, NULL}}},
1863
1864     {&ovsrec_table_port,
1865      {{&ovsrec_table_port, &ovsrec_port_col_name, NULL},
1866       {NULL, NULL, NULL}}},
1867
1868     {&ovsrec_table_qos,
1869      {{&ovsrec_table_port, &ovsrec_port_col_name, &ovsrec_port_col_qos},
1870       {NULL, NULL, NULL}}},
1871
1872     {&ovsrec_table_queue,
1873      {{NULL, NULL, NULL},
1874       {NULL, NULL, NULL}}},
1875
1876     {&ovsrec_table_ssl,
1877      {{&ovsrec_table_open_vswitch, NULL, &ovsrec_open_vswitch_col_ssl}}},
1878
1879     {&ovsrec_table_sflow,
1880      {{&ovsrec_table_bridge,
1881        &ovsrec_bridge_col_name,
1882        &ovsrec_bridge_col_sflow},
1883       {NULL, NULL, NULL}}},
1884
1885     {NULL, {{NULL, NULL, NULL}, {NULL, NULL, NULL}}}
1886 };
1887
1888 static void
1889 die_if_error(char *error)
1890 {
1891     if (error) {
1892         vsctl_fatal("%s", error);
1893     }
1894 }
1895
1896 static int
1897 to_lower_and_underscores(unsigned c)
1898 {
1899     return c == '-' ? '_' : tolower(c);
1900 }
1901
1902 static unsigned int
1903 score_partial_match(const char *name, const char *s)
1904 {
1905     int score;
1906
1907     if (!strcmp(name, s)) {
1908         return UINT_MAX;
1909     }
1910     for (score = 0; ; score++, name++, s++) {
1911         if (to_lower_and_underscores(*name) != to_lower_and_underscores(*s)) {
1912             break;
1913         } else if (*name == '\0') {
1914             return UINT_MAX - 1;
1915         }
1916     }
1917     return *s == '\0' ? score : 0;
1918 }
1919
1920 static const struct vsctl_table_class *
1921 get_table(const char *table_name)
1922 {
1923     const struct vsctl_table_class *table;
1924     const struct vsctl_table_class *best_match = NULL;
1925     unsigned int best_score = 0;
1926
1927     for (table = tables; table->class; table++) {
1928         unsigned int score = score_partial_match(table->class->name,
1929                                                  table_name);
1930         if (score > best_score) {
1931             best_match = table;
1932             best_score = score;
1933         } else if (score == best_score) {
1934             best_match = NULL;
1935         }
1936     }
1937     if (best_match) {
1938         return best_match;
1939     } else if (best_score) {
1940         vsctl_fatal("multiple table names match \"%s\"", table_name);
1941     } else {
1942         vsctl_fatal("unknown table \"%s\"", table_name);
1943     }
1944 }
1945
1946 static const struct ovsdb_idl_row *
1947 get_row_by_id(struct vsctl_context *ctx, const struct vsctl_table_class *table,
1948               const struct vsctl_row_id *id, const char *record_id)
1949 {
1950     const struct ovsdb_idl_row *referrer, *final;
1951
1952     if (!id->table) {
1953         return NULL;
1954     }
1955
1956     if (!id->name_column) {
1957         if (strcmp(record_id, ".")) {
1958             return NULL;
1959         }
1960         referrer = ovsdb_idl_first_row(ctx->idl, id->table);
1961         if (!referrer || ovsdb_idl_next_row(referrer)) {
1962             return NULL;
1963         }
1964     } else {
1965         const struct ovsdb_idl_row *row;
1966
1967         referrer = NULL;
1968         for (row = ovsdb_idl_first_row(ctx->idl, id->table);
1969              row != NULL;
1970              row = ovsdb_idl_next_row(row))
1971         {
1972             const struct ovsdb_datum *name;
1973
1974             name = ovsdb_idl_get(row, id->name_column,
1975                                  OVSDB_TYPE_STRING, OVSDB_TYPE_VOID);
1976             if (name->n == 1 && !strcmp(name->keys[0].string, record_id)) {
1977                 if (referrer) {
1978                     vsctl_fatal("multiple rows in %s match \"%s\"",
1979                                 table->class->name, record_id);
1980                 }
1981                 referrer = row;
1982             }
1983         }
1984     }
1985     if (!referrer) {
1986         return NULL;
1987     }
1988
1989     final = NULL;
1990     if (id->uuid_column) {
1991         const struct ovsdb_datum *uuid;
1992
1993         ovsdb_idl_txn_verify(referrer, id->uuid_column);
1994         uuid = ovsdb_idl_get(referrer, id->uuid_column,
1995                              OVSDB_TYPE_UUID, OVSDB_TYPE_VOID);
1996         if (uuid->n == 1) {
1997             final = ovsdb_idl_get_row_for_uuid(ctx->idl, table->class,
1998                                                &uuid->keys[0].uuid);
1999         }
2000     } else {
2001         final = referrer;
2002     }
2003
2004     return final;
2005 }
2006
2007 static const struct ovsdb_idl_row *
2008 get_row (struct vsctl_context *ctx,
2009          const struct vsctl_table_class *table, const char *record_id)
2010 {
2011     const struct ovsdb_idl_row *row;
2012     struct uuid uuid;
2013
2014     if (uuid_from_string(&uuid, record_id)) {
2015         row = ovsdb_idl_get_row_for_uuid(ctx->idl, table->class, &uuid);
2016     } else {
2017         int i;
2018
2019         for (i = 0; i < ARRAY_SIZE(table->row_ids); i++) {
2020             row = get_row_by_id(ctx, table, &table->row_ids[i], record_id);
2021             if (row) {
2022                 break;
2023             }
2024         }
2025     }
2026     return row;
2027 }
2028
2029 static const struct ovsdb_idl_row *
2030 must_get_row(struct vsctl_context *ctx,
2031              const struct vsctl_table_class *table, const char *record_id)
2032 {
2033     const struct ovsdb_idl_row *row = get_row(ctx, table, record_id);
2034     if (!row) {
2035         vsctl_fatal("no row \"%s\" in table %s",
2036                     record_id, table->class->name);
2037     }
2038     return row;
2039 }
2040
2041 static char *
2042 get_column(const struct vsctl_table_class *table, const char *column_name,
2043            const struct ovsdb_idl_column **columnp)
2044 {
2045     const struct ovsdb_idl_column *best_match = NULL;
2046     unsigned int best_score = 0;
2047     size_t i;
2048
2049     for (i = 0; i < table->class->n_columns; i++) {
2050         const struct ovsdb_idl_column *column = &table->class->columns[i];
2051         unsigned int score = score_partial_match(column->name, column_name);
2052         if (score > best_score) {
2053             best_match = column;
2054             best_score = score;
2055         } else if (score == best_score) {
2056             best_match = NULL;
2057         }
2058     }
2059
2060     *columnp = best_match;
2061     if (best_match) {
2062         return NULL;
2063     } else if (best_score) {
2064         return xasprintf("%s contains more than one column whose name "
2065                          "matches \"%s\"", table->class->name, column_name);
2066     } else {
2067         return xasprintf("%s does not contain a column whose name matches "
2068                          "\"%s\"", table->class->name, column_name);
2069     }
2070 }
2071
2072 static struct uuid *
2073 create_symbol(struct ovsdb_symbol_table *symtab, const char *id, bool *newp)
2074 {
2075     struct ovsdb_symbol *symbol;
2076
2077     if (id[0] != '@') {
2078         vsctl_fatal("row id \"%s\" does not begin with \"@\"", id);
2079     }
2080
2081     if (newp) {
2082         *newp = ovsdb_symbol_table_get(symtab, id) == NULL;
2083     }
2084
2085     symbol = ovsdb_symbol_table_insert(symtab, id);
2086     if (symbol->used) {
2087         vsctl_fatal("row id \"%s\" may only be specified on one --id option",
2088                     id);
2089     }
2090     symbol->used = true;
2091     return &symbol->uuid;
2092 }
2093
2094 static char *
2095 missing_operator_error(const char *arg, const char **allowed_operators,
2096                        size_t n_allowed)
2097 {
2098     struct ds s;
2099
2100     ds_init(&s);
2101     ds_put_format(&s, "%s: argument does not end in ", arg);
2102     ds_put_format(&s, "\"%s\"", allowed_operators[0]);
2103     if (n_allowed == 2) {
2104         ds_put_format(&s, " or \"%s\"", allowed_operators[1]);
2105     } else if (n_allowed > 2) {
2106         size_t i;
2107
2108         for (i = 1; i < n_allowed - 1; i++) {
2109             ds_put_format(&s, ", \"%s\"", allowed_operators[i]);
2110         }
2111         ds_put_format(&s, ", or \"%s\"", allowed_operators[i]);
2112     }
2113     ds_put_format(&s, " followed by a value.");
2114
2115     return ds_steal_cstr(&s);
2116 }
2117
2118 /* Breaks 'arg' apart into a number of fields in the following order:
2119  *
2120  *      - If 'columnp' is nonnull, the name of a column in 'table'.  The column
2121  *        is stored into '*columnp'.  The column name may be abbreviated.
2122  *
2123  *      - If 'keyp' is nonnull, optionally a key string.  (If both 'columnp'
2124  *        and 'keyp' are nonnull, then the column and key names are expected to
2125  *        be separated by ':').  The key is stored as a malloc()'d string into
2126  *        '*keyp', or NULL if no key is present in 'arg'.
2127  *
2128  *      - If 'valuep' is nonnull, an operator followed by a value string.  The
2129  *        allowed operators are the 'n_allowed' string in 'allowed_operators',
2130  *        or just "=" if 'n_allowed' is 0.  If 'operatorp' is nonnull, then the
2131  *        operator is stored into '*operatorp' (one of the pointers from
2132  *        'allowed_operators' is stored; nothing is malloc()'d).  The value is
2133  *        stored as a malloc()'d string into '*valuep', or NULL if no value is
2134  *        present in 'arg'.
2135  *
2136  * At least 'columnp' or 'keyp' must be nonnull.
2137  *
2138  * On success, returns NULL.  On failure, returned a malloc()'d string error
2139  * message and stores NULL into all of the nonnull output arguments. */
2140 static char * WARN_UNUSED_RESULT
2141 parse_column_key_value(const char *arg,
2142                        const struct vsctl_table_class *table,
2143                        const struct ovsdb_idl_column **columnp, char **keyp,
2144                        const char **operatorp,
2145                        const char **allowed_operators, size_t n_allowed,
2146                        char **valuep)
2147 {
2148     const char *p = arg;
2149     char *error;
2150
2151     assert(columnp || keyp);
2152     assert(!(operatorp && !valuep));
2153     if (keyp) {
2154         *keyp = NULL;
2155     }
2156     if (valuep) {
2157         *valuep = NULL;
2158     }
2159
2160     /* Parse column name. */
2161     if (columnp) {
2162         char *column_name;
2163
2164         error = ovsdb_token_parse(&p, &column_name);
2165         if (error) {
2166             goto error;
2167         }
2168         if (column_name[0] == '\0') {
2169             free(column_name);
2170             error = xasprintf("%s: missing column name", arg);
2171             goto error;
2172         }
2173         error = get_column(table, column_name, columnp);
2174         free(column_name);
2175         if (error) {
2176             goto error;
2177         }
2178     }
2179
2180     /* Parse key string. */
2181     if (*p == ':' || !columnp) {
2182         if (columnp) {
2183             p++;
2184         } else if (!keyp) {
2185             error = xasprintf("%s: key not accepted here", arg);
2186             goto error;
2187         }
2188         error = ovsdb_token_parse(&p, keyp);
2189         if (error) {
2190             goto error;
2191         }
2192     } else if (keyp) {
2193         *keyp = NULL;
2194     }
2195
2196     /* Parse value string. */
2197     if (valuep) {
2198         const char *best;
2199         size_t best_len;
2200         size_t i;
2201
2202         if (!allowed_operators) {
2203             static const char *equals = "=";
2204             allowed_operators = &equals;
2205             n_allowed = 1;
2206         }
2207
2208         best = NULL;
2209         best_len = 0;
2210         for (i = 0; i < n_allowed; i++) {
2211             const char *op = allowed_operators[i];
2212             size_t op_len = strlen(op);
2213
2214             if (op_len > best_len && !strncmp(op, p, op_len) && p[op_len]) {
2215                 best_len = op_len;
2216                 best = op;
2217             }
2218         }
2219         if (!best) {
2220             error = missing_operator_error(arg, allowed_operators, n_allowed);
2221             goto error;
2222         }
2223
2224         if (operatorp) {
2225             *operatorp = best;
2226         }
2227         *valuep = xstrdup(p + best_len);
2228     } else {
2229         if (valuep) {
2230             *valuep = NULL;
2231         }
2232         if (*p != '\0') {
2233             error = xasprintf("%s: trailing garbage \"%s\" in argument",
2234                               arg, p);
2235             goto error;
2236         }
2237     }
2238     return NULL;
2239
2240 error:
2241     if (columnp) {
2242         *columnp = NULL;
2243     }
2244     if (keyp) {
2245         free(*keyp);
2246         *keyp = NULL;
2247     }
2248     if (valuep) {
2249         free(*valuep);
2250         *valuep = NULL;
2251         if (operatorp) {
2252             *operatorp = NULL;
2253         }
2254     }
2255     return error;
2256 }
2257
2258 static void
2259 cmd_get(struct vsctl_context *ctx)
2260 {
2261     const char *id = shash_find_data(&ctx->options, "--id");
2262     bool if_exists = shash_find(&ctx->options, "--if-exists");
2263     const char *table_name = ctx->argv[1];
2264     const char *record_id = ctx->argv[2];
2265     const struct vsctl_table_class *table;
2266     const struct ovsdb_idl_row *row;
2267     struct ds *out = &ctx->output;
2268     int i;
2269
2270     table = get_table(table_name);
2271     row = must_get_row(ctx, table, record_id);
2272     if (id) {
2273         bool new;
2274
2275         *create_symbol(ctx->symtab, id, &new) = row->uuid;
2276         if (!new) {
2277             vsctl_fatal("row id \"%s\" specified on \"get\" command was used "
2278                         "before it was defined", id);
2279         }
2280     }
2281     for (i = 3; i < ctx->argc; i++) {
2282         const struct ovsdb_idl_column *column;
2283         const struct ovsdb_datum *datum;
2284         char *key_string;
2285
2286         /* Special case for obtaining the UUID of a row.  We can't just do this
2287          * through parse_column_key_value() below since it returns a "struct
2288          * ovsdb_idl_column" and the UUID column doesn't have one. */
2289         if (!strcasecmp(ctx->argv[i], "_uuid")
2290             || !strcasecmp(ctx->argv[i], "-uuid")) {
2291             ds_put_format(out, UUID_FMT"\n", UUID_ARGS(&row->uuid));
2292             continue;
2293         }
2294
2295         die_if_error(parse_column_key_value(ctx->argv[i], table,
2296                                             &column, &key_string,
2297                                             NULL, NULL, 0, NULL));
2298
2299         ovsdb_idl_txn_verify(row, column);
2300         datum = ovsdb_idl_read(row, column);
2301         if (key_string) {
2302             union ovsdb_atom key;
2303             unsigned int idx;
2304
2305             if (column->type.value.type == OVSDB_TYPE_VOID) {
2306                 vsctl_fatal("cannot specify key to get for non-map column %s",
2307                             column->name);
2308             }
2309
2310             die_if_error(ovsdb_atom_from_string(&key,
2311                                                 &column->type.key,
2312                                                 key_string, ctx->symtab));
2313
2314             idx = ovsdb_datum_find_key(datum, &key,
2315                                        column->type.key.type);
2316             if (idx == UINT_MAX) {
2317                 if (!if_exists) {
2318                     vsctl_fatal("no key \"%s\" in %s record \"%s\" column %s",
2319                                 key_string, table->class->name, record_id,
2320                                 column->name);
2321                 }
2322             } else {
2323                 ovsdb_atom_to_string(&datum->values[idx],
2324                                      column->type.value.type, out);
2325             }
2326             ovsdb_atom_destroy(&key, column->type.key.type);
2327         } else {
2328             ovsdb_datum_to_string(datum, &column->type, out);
2329         }
2330         ds_put_char(out, '\n');
2331
2332         free(key_string);
2333     }
2334 }
2335
2336 static void
2337 list_record(const struct vsctl_table_class *table,
2338             const struct ovsdb_idl_row *row, struct ds *out)
2339 {
2340     size_t i;
2341
2342     ds_put_format(out, "%-20s: "UUID_FMT"\n", "_uuid",
2343                   UUID_ARGS(&row->uuid));
2344     for (i = 0; i < table->class->n_columns; i++) {
2345         const struct ovsdb_idl_column *column = &table->class->columns[i];
2346         const struct ovsdb_datum *datum;
2347
2348         datum = ovsdb_idl_read(row, column);
2349
2350         ds_put_format(out, "%-20s: ", column->name);
2351         ovsdb_datum_to_string(datum, &column->type, out);
2352         ds_put_char(out, '\n');
2353     }
2354 }
2355
2356 static void
2357 cmd_list(struct vsctl_context *ctx)
2358 {
2359     const char *table_name = ctx->argv[1];
2360     const struct vsctl_table_class *table;
2361     struct ds *out = &ctx->output;
2362     int i;
2363
2364     table = get_table(table_name);
2365     if (ctx->argc > 2) {
2366         for (i = 2; i < ctx->argc; i++) {
2367             if (i > 2) {
2368                 ds_put_char(out, '\n');
2369             }
2370             list_record(table, must_get_row(ctx, table, ctx->argv[i]), out);
2371         }
2372     } else {
2373         const struct ovsdb_idl_row *row;
2374         bool first;
2375
2376         for (row = ovsdb_idl_first_row(ctx->idl, table->class), first = true;
2377              row != NULL;
2378              row = ovsdb_idl_next_row(row), first = false) {
2379             if (!first) {
2380                 ds_put_char(out, '\n');
2381             }
2382             list_record(table, row, out);
2383         }
2384     }
2385 }
2386
2387 static void
2388 set_column(const struct vsctl_table_class *table,
2389            const struct ovsdb_idl_row *row, const char *arg,
2390            struct ovsdb_symbol_table *symtab)
2391 {
2392     const struct ovsdb_idl_column *column;
2393     char *key_string, *value_string;
2394     char *error;
2395
2396     error = parse_column_key_value(arg, table, &column, &key_string,
2397                                    NULL, NULL, 0, &value_string);
2398     die_if_error(error);
2399     if (!value_string) {
2400         vsctl_fatal("%s: missing value", arg);
2401     }
2402
2403     if (key_string) {
2404         union ovsdb_atom key, value;
2405         struct ovsdb_datum datum;
2406
2407         if (column->type.value.type == OVSDB_TYPE_VOID) {
2408             vsctl_fatal("cannot specify key to set for non-map column %s",
2409                         column->name);
2410         }
2411
2412         die_if_error(ovsdb_atom_from_string(&key, &column->type.key,
2413                                             key_string, symtab));
2414         die_if_error(ovsdb_atom_from_string(&value, &column->type.value,
2415                                             value_string, symtab));
2416
2417         ovsdb_datum_init_empty(&datum);
2418         ovsdb_datum_add_unsafe(&datum, &key, &value, &column->type);
2419
2420         ovsdb_atom_destroy(&key, column->type.key.type);
2421         ovsdb_atom_destroy(&value, column->type.value.type);
2422
2423         ovsdb_datum_union(&datum, ovsdb_idl_read(row, column),
2424                           &column->type, false);
2425         ovsdb_idl_txn_write(row, column, &datum);
2426     } else {
2427         struct ovsdb_datum datum;
2428
2429         die_if_error(ovsdb_datum_from_string(&datum, &column->type,
2430                                              value_string, symtab));
2431         ovsdb_idl_txn_write(row, column, &datum);
2432     }
2433
2434     free(key_string);
2435     free(value_string);
2436 }
2437
2438 static void
2439 cmd_set(struct vsctl_context *ctx)
2440 {
2441     const char *table_name = ctx->argv[1];
2442     const char *record_id = ctx->argv[2];
2443     const struct vsctl_table_class *table;
2444     const struct ovsdb_idl_row *row;
2445     int i;
2446
2447     table = get_table(table_name);
2448     row = must_get_row(ctx, table, record_id);
2449     for (i = 3; i < ctx->argc; i++) {
2450         set_column(table, row, ctx->argv[i], ctx->symtab);
2451     }
2452 }
2453
2454 static void
2455 cmd_add(struct vsctl_context *ctx)
2456 {
2457     const char *table_name = ctx->argv[1];
2458     const char *record_id = ctx->argv[2];
2459     const char *column_name = ctx->argv[3];
2460     const struct vsctl_table_class *table;
2461     const struct ovsdb_idl_column *column;
2462     const struct ovsdb_idl_row *row;
2463     const struct ovsdb_type *type;
2464     struct ovsdb_datum old;
2465     int i;
2466
2467     table = get_table(table_name);
2468     row = must_get_row(ctx, table, record_id);
2469     die_if_error(get_column(table, column_name, &column));
2470
2471     type = &column->type;
2472     ovsdb_datum_clone(&old, ovsdb_idl_read(row, column), &column->type);
2473     for (i = 4; i < ctx->argc; i++) {
2474         struct ovsdb_type add_type;
2475         struct ovsdb_datum add;
2476
2477         add_type = *type;
2478         add_type.n_min = 1;
2479         add_type.n_max = UINT_MAX;
2480         die_if_error(ovsdb_datum_from_string(&add, &add_type, ctx->argv[i],
2481                                              ctx->symtab));
2482         ovsdb_datum_union(&old, &add, type, false);
2483         ovsdb_datum_destroy(&add, type);
2484     }
2485     if (old.n > type->n_max) {
2486         vsctl_fatal("\"add\" operation would put %u %s in column %s of "
2487                     "table %s but the maximum number is %u",
2488                     old.n,
2489                     type->value.type == OVSDB_TYPE_VOID ? "values" : "pairs",
2490                     column->name, table->class->name, type->n_max);
2491     }
2492     ovsdb_idl_txn_verify(row, column);
2493     ovsdb_idl_txn_write(row, column, &old);
2494 }
2495
2496 static void
2497 cmd_remove(struct vsctl_context *ctx)
2498 {
2499     const char *table_name = ctx->argv[1];
2500     const char *record_id = ctx->argv[2];
2501     const char *column_name = ctx->argv[3];
2502     const struct vsctl_table_class *table;
2503     const struct ovsdb_idl_column *column;
2504     const struct ovsdb_idl_row *row;
2505     const struct ovsdb_type *type;
2506     struct ovsdb_datum old;
2507     int i;
2508
2509     table = get_table(table_name);
2510     row = must_get_row(ctx, table, record_id);
2511     die_if_error(get_column(table, column_name, &column));
2512
2513     type = &column->type;
2514     ovsdb_datum_clone(&old, ovsdb_idl_read(row, column), &column->type);
2515     for (i = 4; i < ctx->argc; i++) {
2516         struct ovsdb_type rm_type;
2517         struct ovsdb_datum rm;
2518         char *error;
2519
2520         rm_type = *type;
2521         rm_type.n_min = 1;
2522         rm_type.n_max = UINT_MAX;
2523         error = ovsdb_datum_from_string(&rm, &rm_type,
2524                                         ctx->argv[i], ctx->symtab);
2525         if (error && ovsdb_type_is_map(&rm_type)) {
2526             free(error);
2527             rm_type.value.type = OVSDB_TYPE_VOID;
2528             die_if_error(ovsdb_datum_from_string(&rm, &rm_type,
2529                                                  ctx->argv[i], ctx->symtab));
2530         }
2531         ovsdb_datum_subtract(&old, type, &rm, &rm_type);
2532         ovsdb_datum_destroy(&rm, &rm_type);
2533     }
2534     if (old.n < type->n_min) {
2535         vsctl_fatal("\"remove\" operation would put %u %s in column %s of "
2536                     "table %s but the minimum number is %u",
2537                     old.n,
2538                     type->value.type == OVSDB_TYPE_VOID ? "values" : "pairs",
2539                     column->name, table->class->name, type->n_min);
2540     }
2541     ovsdb_idl_txn_verify(row, column);
2542     ovsdb_idl_txn_write(row, column, &old);
2543 }
2544
2545 static void
2546 cmd_clear(struct vsctl_context *ctx)
2547 {
2548     const char *table_name = ctx->argv[1];
2549     const char *record_id = ctx->argv[2];
2550     const struct vsctl_table_class *table;
2551     const struct ovsdb_idl_row *row;
2552     int i;
2553
2554     table = get_table(table_name);
2555     row = must_get_row(ctx, table, record_id);
2556     for (i = 3; i < ctx->argc; i++) {
2557         const struct ovsdb_idl_column *column;
2558         const struct ovsdb_type *type;
2559         struct ovsdb_datum datum;
2560
2561         die_if_error(get_column(table, ctx->argv[i], &column));
2562
2563         type = &column->type;
2564         if (type->n_min > 0) {
2565             vsctl_fatal("\"clear\" operation cannot be applied to column %s "
2566                         "of table %s, which is not allowed to be empty",
2567                         column->name, table->class->name);
2568         }
2569
2570         ovsdb_datum_init_empty(&datum);
2571         ovsdb_idl_txn_write(row, column, &datum);
2572     }
2573 }
2574
2575 static void
2576 cmd_create(struct vsctl_context *ctx)
2577 {
2578     const char *id = shash_find_data(&ctx->options, "--id");
2579     const char *table_name = ctx->argv[1];
2580     const struct vsctl_table_class *table;
2581     const struct ovsdb_idl_row *row;
2582     const struct uuid *uuid;
2583     int i;
2584
2585     uuid = id ? create_symbol(ctx->symtab, id, NULL) : NULL;
2586
2587     table = get_table(table_name);
2588     row = ovsdb_idl_txn_insert(ctx->txn, table->class, uuid);
2589     for (i = 2; i < ctx->argc; i++) {
2590         set_column(table, row, ctx->argv[i], ctx->symtab);
2591     }
2592     ds_put_format(&ctx->output, UUID_FMT, UUID_ARGS(&row->uuid));
2593 }
2594
2595 /* This function may be used as the 'postprocess' function for commands that
2596  * insert new rows into the database.  It expects that the command's 'run'
2597  * function prints the UUID reported by ovsdb_idl_txn_insert() as the command's
2598  * sole output.  It replaces that output by the row's permanent UUID assigned
2599  * by the database server and appends a new-line.
2600  *
2601  * Currently we use this only for "create", because the higher-level commands
2602  * are supposed to be independent of the actual structure of the vswitch
2603  * configuration. */
2604 static void
2605 post_create(struct vsctl_context *ctx)
2606 {
2607     const struct uuid *real;
2608     struct uuid dummy;
2609
2610     uuid_from_string(&dummy, ds_cstr(&ctx->output));
2611     real = ovsdb_idl_txn_get_insert_uuid(ctx->txn, &dummy);
2612     if (real) {
2613         ds_clear(&ctx->output);
2614         ds_put_format(&ctx->output, UUID_FMT, UUID_ARGS(real));
2615     }
2616     ds_put_char(&ctx->output, '\n');
2617 }
2618
2619 static void
2620 cmd_destroy(struct vsctl_context *ctx)
2621 {
2622     bool must_exist = !shash_find(&ctx->options, "--if-exists");
2623     const char *table_name = ctx->argv[1];
2624     const struct vsctl_table_class *table;
2625     int i;
2626
2627     table = get_table(table_name);
2628     for (i = 2; i < ctx->argc; i++) {
2629         const struct ovsdb_idl_row *row;
2630
2631         row = (must_exist ? must_get_row : get_row)(ctx, table, ctx->argv[i]);
2632         if (row) {
2633             ovsdb_idl_txn_delete(row);
2634         }
2635     }
2636 }
2637
2638 static bool
2639 is_condition_satified(const struct vsctl_table_class *table,
2640                       const struct ovsdb_idl_row *row, const char *arg,
2641                       struct ovsdb_symbol_table *symtab)
2642 {
2643     static const char *operators[] = {
2644         "=", "!=", "<", ">", "<=", ">="
2645     };
2646
2647     const struct ovsdb_idl_column *column;
2648     const struct ovsdb_datum *have_datum;
2649     char *key_string, *value_string;
2650     const char *operator;
2651     unsigned int idx;
2652     char *error;
2653     int cmp = 0;
2654
2655     error = parse_column_key_value(arg, table, &column, &key_string,
2656                                    &operator, operators, ARRAY_SIZE(operators),
2657                                    &value_string);
2658     die_if_error(error);
2659     if (!value_string) {
2660         vsctl_fatal("%s: missing value", arg);
2661     }
2662
2663     have_datum = ovsdb_idl_read(row, column);
2664     if (key_string) {
2665         union ovsdb_atom want_key, want_value;
2666
2667         if (column->type.value.type == OVSDB_TYPE_VOID) {
2668             vsctl_fatal("cannot specify key to check for non-map column %s",
2669                         column->name);
2670         }
2671
2672         die_if_error(ovsdb_atom_from_string(&want_key, &column->type.key,
2673                                             key_string, symtab));
2674         die_if_error(ovsdb_atom_from_string(&want_value, &column->type.value,
2675                                             value_string, symtab));
2676
2677         idx = ovsdb_datum_find_key(have_datum,
2678                                    &want_key, column->type.key.type);
2679         if (idx != UINT_MAX) {
2680             cmp = ovsdb_atom_compare_3way(&have_datum->values[idx],
2681                                           &want_value,
2682                                           column->type.value.type);
2683         }
2684
2685         ovsdb_atom_destroy(&want_key, column->type.key.type);
2686         ovsdb_atom_destroy(&want_value, column->type.value.type);
2687     } else {
2688         struct ovsdb_datum want_datum;
2689
2690         die_if_error(ovsdb_datum_from_string(&want_datum, &column->type,
2691                                              value_string, symtab));
2692         idx = 0;
2693         cmp = ovsdb_datum_compare_3way(have_datum, &want_datum,
2694                                        &column->type);
2695         ovsdb_datum_destroy(&want_datum, &column->type);
2696     }
2697
2698     free(key_string);
2699     free(value_string);
2700
2701     return (idx == UINT_MAX ? false
2702             : !strcmp(operator, "=") ? cmp == 0
2703             : !strcmp(operator, "!=") ? cmp != 0
2704             : !strcmp(operator, "<") ? cmp < 0
2705             : !strcmp(operator, ">") ? cmp > 0
2706             : !strcmp(operator, "<=") ? cmp <= 0
2707             : !strcmp(operator, ">=") ? cmp >= 0
2708             : (abort(), 0));
2709 }
2710
2711 static void
2712 cmd_wait_until(struct vsctl_context *ctx)
2713 {
2714     const char *table_name = ctx->argv[1];
2715     const char *record_id = ctx->argv[2];
2716     const struct vsctl_table_class *table;
2717     const struct ovsdb_idl_row *row;
2718     int i;
2719
2720     table = get_table(table_name);
2721
2722     row = get_row(ctx, table, record_id);
2723     if (!row) {
2724         ctx->try_again = true;
2725         return;
2726     }
2727
2728     for (i = 3; i < ctx->argc; i++) {
2729         if (!is_condition_satified(table, row, ctx->argv[i], ctx->symtab)) {
2730             ctx->try_again = true;
2731             return;
2732         }
2733     }
2734 }
2735 \f
2736 static struct json *
2737 where_uuid_equals(const struct uuid *uuid)
2738 {
2739     return
2740         json_array_create_1(
2741             json_array_create_3(
2742                 json_string_create("_uuid"),
2743                 json_string_create("=="),
2744                 json_array_create_2(
2745                     json_string_create("uuid"),
2746                     json_string_create_nocopy(
2747                         xasprintf(UUID_FMT, UUID_ARGS(uuid))))));
2748 }
2749
2750 static void
2751 vsctl_context_init(struct vsctl_context *ctx, struct vsctl_command *command,
2752                    struct ovsdb_idl *idl, struct ovsdb_idl_txn *txn,
2753                    const struct ovsrec_open_vswitch *ovs,
2754     struct ovsdb_symbol_table *symtab)
2755 {
2756     ctx->argc = command->argc;
2757     ctx->argv = command->argv;
2758     ctx->options = command->options;
2759
2760     ds_swap(&ctx->output, &command->output);
2761     ctx->idl = idl;
2762     ctx->txn = txn;
2763     ctx->ovs = ovs;
2764     ctx->symtab = symtab;
2765     ctx->verified_ports = false;
2766
2767     ctx->try_again = false;
2768 }
2769
2770 static void
2771 vsctl_context_done(struct vsctl_context *ctx, struct vsctl_command *command)
2772 {
2773     ds_swap(&ctx->output, &command->output);
2774 }
2775
2776 static void
2777 do_vsctl(const char *args, struct vsctl_command *commands, size_t n_commands,
2778          struct ovsdb_idl *idl)
2779 {
2780     struct ovsdb_idl_txn *txn;
2781     const struct ovsrec_open_vswitch *ovs;
2782     enum ovsdb_idl_txn_status status;
2783     struct ovsdb_symbol_table *symtab;
2784     const char *unused;
2785     struct vsctl_command *c;
2786     int64_t next_cfg = 0;
2787     char *error = NULL;
2788
2789     txn = the_idl_txn = ovsdb_idl_txn_create(idl);
2790     if (dry_run) {
2791         ovsdb_idl_txn_set_dry_run(txn);
2792     }
2793
2794     ovsdb_idl_txn_add_comment(txn, "ovs-vsctl: %s", args);
2795
2796     ovs = ovsrec_open_vswitch_first(idl);
2797     if (!ovs) {
2798         /* XXX add verification that table is empty */
2799         ovs = ovsrec_open_vswitch_insert(txn);
2800     }
2801
2802     if (wait_for_reload) {
2803         struct json *where = where_uuid_equals(&ovs->header_.uuid);
2804         ovsdb_idl_txn_increment(txn, "Open_vSwitch", "next_cfg", where);
2805         json_destroy(where);
2806     }
2807
2808     symtab = ovsdb_symbol_table_create();
2809     for (c = commands; c < &commands[n_commands]; c++) {
2810         ds_init(&c->output);
2811     }
2812     for (c = commands; c < &commands[n_commands]; c++) {
2813         struct vsctl_context ctx;
2814
2815         vsctl_context_init(&ctx, c, idl, txn, ovs, symtab);
2816         (c->syntax->run)(&ctx);
2817         vsctl_context_done(&ctx, c);
2818
2819         if (ctx.try_again) {
2820             goto try_again;
2821         }
2822     }
2823
2824     status = ovsdb_idl_txn_commit_block(txn);
2825     if (wait_for_reload && status == TXN_SUCCESS) {
2826         next_cfg = ovsdb_idl_txn_get_increment_new_value(txn);
2827     }
2828     if (status == TXN_UNCHANGED || status == TXN_SUCCESS) {
2829         for (c = commands; c < &commands[n_commands]; c++) {
2830             if (c->syntax->postprocess) {
2831                 struct vsctl_context ctx;
2832
2833                 vsctl_context_init(&ctx, c, idl, txn, ovs, symtab);
2834                 (c->syntax->postprocess)(&ctx);
2835                 vsctl_context_done(&ctx, c);
2836             }
2837         }
2838     }
2839     error = xstrdup(ovsdb_idl_txn_get_error(txn));
2840     ovsdb_idl_txn_destroy(txn);
2841     the_idl_txn = NULL;
2842
2843     unused = ovsdb_symbol_table_find_unused(symtab);
2844     if (unused) {
2845         vsctl_fatal("row id \"%s\" is referenced but never created (e.g. "
2846                     "with \"-- --id=%s create ...\")", unused, unused);
2847     }
2848
2849     switch (status) {
2850     case TXN_INCOMPLETE:
2851         NOT_REACHED();
2852
2853     case TXN_ABORTED:
2854         /* Should not happen--we never call ovsdb_idl_txn_abort(). */
2855         vsctl_fatal("transaction aborted");
2856
2857     case TXN_UNCHANGED:
2858     case TXN_SUCCESS:
2859         break;
2860
2861     case TXN_TRY_AGAIN:
2862         goto try_again;
2863
2864     case TXN_ERROR:
2865         vsctl_fatal("transaction error: %s", error);
2866
2867     default:
2868         NOT_REACHED();
2869     }
2870     free(error);
2871
2872     ovsdb_symbol_table_destroy(symtab);
2873
2874     for (c = commands; c < &commands[n_commands]; c++) {
2875         struct ds *ds = &c->output;
2876         struct shash_node *node;
2877
2878         if (oneline) {
2879             size_t j;
2880
2881             ds_chomp(ds, '\n');
2882             for (j = 0; j < ds->length; j++) {
2883                 int ch = ds->string[j];
2884                 switch (ch) {
2885                 case '\n':
2886                     fputs("\\n", stdout);
2887                     break;
2888
2889                 case '\\':
2890                     fputs("\\\\", stdout);
2891                     break;
2892
2893                 default:
2894                     putchar(ch);
2895                 }
2896             }
2897             putchar('\n');
2898         } else {
2899             fputs(ds_cstr(ds), stdout);
2900         }
2901         ds_destroy(&c->output);
2902
2903         SHASH_FOR_EACH (node, &c->options) {
2904             free(node->data);
2905         }
2906         shash_destroy(&c->options);
2907     }
2908     free(commands);
2909
2910     if (wait_for_reload && status != TXN_UNCHANGED) {
2911         for (;;) {
2912             ovsdb_idl_run(idl);
2913             OVSREC_OPEN_VSWITCH_FOR_EACH (ovs, idl) {
2914                 if (ovs->cur_cfg >= next_cfg) {
2915                     goto done;
2916                 }
2917             }
2918             ovsdb_idl_wait(idl);
2919             poll_block();
2920         }
2921     done: ;
2922     }
2923     ovsdb_idl_destroy(idl);
2924
2925     exit(EXIT_SUCCESS);
2926
2927 try_again:
2928     /* Our transaction needs to be rerun, or a prerequisite was not met.  Free
2929      * resources and return so that the caller can try again. */
2930     ovsdb_idl_txn_abort(txn);
2931     ovsdb_idl_txn_destroy(txn);
2932     ovsdb_symbol_table_destroy(symtab);
2933     for (c = commands; c < &commands[n_commands]; c++) {
2934         ds_destroy(&c->output);
2935     }
2936     free(error);
2937 }
2938
2939 static const struct vsctl_command_syntax all_commands[] = {
2940     /* Open vSwitch commands. */
2941     {"init", 0, 0, cmd_init, NULL, "", RW},
2942
2943     /* Bridge commands. */
2944     {"add-br", 1, 3, cmd_add_br, NULL, "--may-exist", RW},
2945     {"del-br", 1, 1, cmd_del_br, NULL, "--if-exists", RW},
2946     {"list-br", 0, 0, cmd_list_br, NULL, "", RO},
2947     {"br-exists", 1, 1, cmd_br_exists, NULL, "", RO},
2948     {"br-to-vlan", 1, 1, cmd_br_to_vlan, NULL, "", RO},
2949     {"br-to-parent", 1, 1, cmd_br_to_parent, NULL, "", RO},
2950     {"br-set-external-id", 2, 3, cmd_br_set_external_id, NULL, "", RW},
2951     {"br-get-external-id", 1, 2, cmd_br_get_external_id, NULL, "", RO},
2952
2953     /* Port commands. */
2954     {"list-ports", 1, 1, cmd_list_ports, NULL, "", RO},
2955     {"add-port", 2, INT_MAX, cmd_add_port, NULL, "--may-exist", RW},
2956     {"add-bond", 4, INT_MAX, cmd_add_bond, NULL, "--may-exist,--fake-iface", RW},
2957     {"del-port", 1, 2, cmd_del_port, NULL, "--if-exists,--with-iface", RW},
2958     {"port-to-br", 1, 1, cmd_port_to_br, NULL, "", RO},
2959
2960     /* Interface commands. */
2961     {"list-ifaces", 1, 1, cmd_list_ifaces, NULL, "", RO},
2962     {"iface-to-br", 1, 1, cmd_iface_to_br, NULL, "", RO},
2963
2964     /* Controller commands. */
2965     {"get-controller", 1, 1, cmd_get_controller, NULL, "", RO},
2966     {"del-controller", 1, 1, cmd_del_controller, NULL, "", RW},
2967     {"set-controller", 1, INT_MAX, cmd_set_controller, NULL, "", RW},
2968     {"get-fail-mode", 1, 1, cmd_get_fail_mode, NULL, "", RO},
2969     {"del-fail-mode", 1, 1, cmd_del_fail_mode, NULL, "", RW},
2970     {"set-fail-mode", 2, 2, cmd_set_fail_mode, NULL, "", RW},
2971
2972     /* SSL commands. */
2973     {"get-ssl", 0, 0, cmd_get_ssl, NULL, "", RO},
2974     {"del-ssl", 0, 0, cmd_del_ssl, NULL, "", RW},
2975     {"set-ssl", 3, 3, cmd_set_ssl, NULL, "--bootstrap", RW},
2976
2977     /* Switch commands. */
2978     {"emer-reset", 0, 0, cmd_emer_reset, NULL, "", RW},
2979
2980     /* Parameter commands. */
2981     {"get", 2, INT_MAX, cmd_get, NULL, "--if-exists,--id=", RO},
2982     {"list", 1, INT_MAX, cmd_list, NULL, "", RO},
2983     {"set", 3, INT_MAX, cmd_set, NULL, "", RW},
2984     {"add", 4, INT_MAX, cmd_add, NULL, "", RW},
2985     {"remove", 4, INT_MAX, cmd_remove, NULL, "", RW},
2986     {"clear", 3, INT_MAX, cmd_clear, NULL, "", RW},
2987     {"create", 2, INT_MAX, cmd_create, post_create, "--id=", RW},
2988     {"destroy", 1, INT_MAX, cmd_destroy, NULL, "--if-exists", RW},
2989     {"wait-until", 2, INT_MAX, cmd_wait_until, NULL, "", RO},
2990
2991     {NULL, 0, 0, NULL, NULL, NULL, RO},
2992 };
2993