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