utilities/ovs-vsctl.c

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