pintos-os.org Git - openvswitch/blob - utilities/ovs-vsctl.c

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