utilities/ovs-vsctl.c

   1 /*
   2  * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014, 2015 Nicira, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #include <config.h>
  18
  19 #include <ctype.h>
  20 #include <errno.h>
  21 #include <float.h>
  22 #include <getopt.h>
  23 #include <inttypes.h>
  24 #include <signal.h>
  25 #include <stdarg.h>
  26 #include <stdlib.h>
  27 #include <string.h>
  28 #include <unistd.h>
  29
  30 #include "db-ctl-base.h"
  31
  32 #include "command-line.h"
  33 #include "compiler.h"
  34 #include "dynamic-string.h"
  35 #include "fatal-signal.h"
  36 #include "hash.h"
  37 #include "json.h"
  38 #include "ovsdb-data.h"
  39 #include "ovsdb-idl.h"
  40 #include "poll-loop.h"
  41 #include "process.h"
  42 #include "stream.h"
  43 #include "stream-ssl.h"
  44 #include "smap.h"
  45 #include "sset.h"
  46 #include "svec.h"
  47 #include "lib/vswitch-idl.h"
  48 #include "table.h"
  49 #include "timeval.h"
  50 #include "util.h"
  51 #include "openvswitch/vconn.h"
  52 #include "openvswitch/vlog.h"
  53
  54 VLOG_DEFINE_THIS_MODULE(vsctl);
  55
  56 struct vsctl_context;
  57
  58 /* --db: The database server to contact. */
  59 static const char *db;
  60
  61 /* --oneline: Write each command's output as a single line? */
  62 static bool oneline;
  63
  64 /* --dry-run: Do not commit any changes. */
  65 static bool dry_run;
  66
  67 /* --no-wait: Wait for ovs-vswitchd to reload its configuration? */
  68 static bool wait_for_reload = true;
  69
  70 /* --timeout: Time to wait for a connection to 'db'. */
  71 static int timeout;
  72
  73 /* --retry: If true, ovs-vsctl will retry connecting to the database forever.
  74  * If false and --db says to use an active connection method (e.g. "unix:",
  75  * "tcp:", "ssl:"), then ovs-vsctl will try to connect once and exit with an
  76  * error if the database server cannot be contacted (e.g. ovsdb-server is not
  77  * running).
  78  *
  79  * Regardless of this setting, --timeout always limits how long ovs-vsctl will
  80  * wait. */
  81 static bool retry;
  82
  83 /* Format for table output. */
  84 static struct table_style table_style = TABLE_STYLE_DEFAULT;
  85
  86 static void vsctl_cmd_init(void);
  87
  88 /* The IDL we're using and the current transaction, if any.
  89  * This is for use by vsctl_exit() only, to allow it to clean up.
  90  * Other code should use its context arguments. */
  91 static struct ovsdb_idl *the_idl;
  92 static struct ovsdb_idl_txn *the_idl_txn;
  93 OVS_NO_RETURN static void vsctl_exit(int status);
  94
  95 OVS_NO_RETURN static void usage(void);
  96 static void parse_options(int argc, char *argv[], struct shash *local_options);
  97 static void run_prerequisites(struct ctl_command[], size_t n_commands,
  98                               struct ovsdb_idl *);
  99 static void do_vsctl(const char *args, struct ctl_command *, size_t n,
 100                      struct ovsdb_idl *);
 101
 102 /* post_db_reload_check frame work is to allow ovs-vsctl to do additional
 103  * checks after OVSDB transactions are successfully recorded and reload by
 104  * ovs-vswitchd.
 105  *
 106  * For example, When a new interface is added to OVSDB, ovs-vswitchd will
 107  * either store a positive values on successful implementing the new
 108  * interface, or -1 on failure.
 109  *
 110  * Unless -no-wait command line option is specified,
 111  * post_db_reload_do_checks() is called right after any configuration
 112  * changes is picked up (i.e. reload) by ovs-vswitchd. Any error detected
 113  * post OVSDB reload is reported as ovs-vsctl errors. OVS-vswitchd logs
 114  * more detailed messages about those errors.
 115  *
 116  * Current implementation only check for Post OVSDB reload failures on new
 117  * interface additions with 'add-br' and 'add-port' commands.
 118  *
 119  * post_db_reload_expect_iface()
 120  *
 121  * keep track of interfaces to be checked post OVSDB reload. */
 122 static void post_db_reload_check_init(void);
 123 static void post_db_reload_do_checks(const struct vsctl_context *);
 124 static void post_db_reload_expect_iface(const struct ovsrec_interface *);
 125
 126 static struct uuid *neoteric_ifaces;
 127 static size_t n_neoteric_ifaces;
 128 static size_t allocated_neoteric_ifaces;
 129
 130 int
 131 main(int argc, char *argv[])
 132 {
 133     extern struct vlog_module VLM_reconnect;
 134     struct ovsdb_idl *idl;
 135     struct ctl_command *commands;
 136     struct shash local_options;
 137     unsigned int seqno;
 138     size_t n_commands;
 139     char *args;
 140
 141     set_program_name(argv[0]);
 142     fatal_ignore_sigpipe();
 143     vlog_set_levels(NULL, VLF_CONSOLE, VLL_WARN);
 144     vlog_set_levels(&VLM_reconnect, VLF_ANY_DESTINATION, VLL_WARN);
 145     ovsrec_init();
 146
 147     vsctl_cmd_init();
 148
 149     /* Log our arguments.  This is often valuable for debugging systems. */
 150     args = process_escape_args(argv);
 151     VLOG(ctl_might_write_to_db(argv) ? VLL_INFO : VLL_DBG, "Called as %s", args);
 152
 153     /* Parse command line. */
 154     shash_init(&local_options);
 155     parse_options(argc, argv, &local_options);
 156     commands = ctl_parse_commands(argc - optind, argv + optind, &local_options,
 157                                   &n_commands);
 158
 159     if (timeout) {
 160         time_alarm(timeout);
 161     }
 162
 163     /* Initialize IDL. */
 164     idl = the_idl = ovsdb_idl_create(db, &ovsrec_idl_class, false, retry);
 165     run_prerequisites(commands, n_commands, idl);
 166
 167     /* Execute the commands.
 168      *
 169      * 'seqno' is the database sequence number for which we last tried to
 170      * execute our transaction.  There's no point in trying to commit more than
 171      * once for any given sequence number, because if the transaction fails
 172      * it's because the database changed and we need to obtain an up-to-date
 173      * view of the database before we try the transaction again. */
 174     seqno = ovsdb_idl_get_seqno(idl);
 175     for (;;) {
 176         ovsdb_idl_run(idl);
 177         if (!ovsdb_idl_is_alive(idl)) {
 178             int retval = ovsdb_idl_get_last_error(idl);
 179             ctl_fatal("%s: database connection failed (%s)",
 180                         db, ovs_retval_to_string(retval));
 181         }
 182
 183         if (seqno != ovsdb_idl_get_seqno(idl)) {
 184             seqno = ovsdb_idl_get_seqno(idl);
 185             do_vsctl(args, commands, n_commands, idl);
 186         }
 187
 188         if (seqno == ovsdb_idl_get_seqno(idl)) {
 189             ovsdb_idl_wait(idl);
 190             poll_block();
 191         }
 192     }
 193 }
 194
 195 static void
 196 parse_options(int argc, char *argv[], struct shash *local_options)
 197 {
 198     enum {
 199         OPT_DB = UCHAR_MAX + 1,
 200         OPT_ONELINE,
 201         OPT_NO_SYSLOG,
 202         OPT_NO_WAIT,
 203         OPT_DRY_RUN,
 204         OPT_PEER_CA_CERT,
 205         OPT_LOCAL,
 206         OPT_RETRY,
 207         OPT_COMMANDS,
 208         OPT_OPTIONS,
 209         VLOG_OPTION_ENUMS,
 210         TABLE_OPTION_ENUMS
 211     };
 212     static const struct option global_long_options[] = {
 213         {"db", required_argument, NULL, OPT_DB},
 214         {"no-syslog", no_argument, NULL, OPT_NO_SYSLOG},
 215         {"no-wait", no_argument, NULL, OPT_NO_WAIT},
 216         {"dry-run", no_argument, NULL, OPT_DRY_RUN},
 217         {"oneline", no_argument, NULL, OPT_ONELINE},
 218         {"timeout", required_argument, NULL, 't'},
 219         {"retry", no_argument, NULL, OPT_RETRY},
 220         {"help", no_argument, NULL, 'h'},
 221         {"commands", no_argument, NULL, OPT_COMMANDS},
 222         {"options", no_argument, NULL, OPT_OPTIONS},
 223         {"version", no_argument, NULL, 'V'},
 224         VLOG_LONG_OPTIONS,
 225         TABLE_LONG_OPTIONS,
 226         STREAM_SSL_LONG_OPTIONS,
 227         {"peer-ca-cert", required_argument, NULL, OPT_PEER_CA_CERT},
 228         {NULL, 0, NULL, 0},
 229     };
 230     const int n_global_long_options = ARRAY_SIZE(global_long_options) - 1;
 231     char *tmp, *short_options;
 232
 233     struct option *options;
 234     size_t allocated_options;
 235     size_t n_options;
 236     size_t i;
 237
 238     tmp = ovs_cmdl_long_options_to_short_options(global_long_options);
 239     short_options = xasprintf("+%s", tmp);
 240     free(tmp);
 241
 242     /* We want to parse both global and command-specific options here, but
 243      * getopt_long() isn't too convenient for the job.  We copy our global
 244      * options into a dynamic array, then append all of the command-specific
 245      * options. */
 246     options = xmemdup(global_long_options, sizeof global_long_options);
 247     allocated_options = ARRAY_SIZE(global_long_options);
 248     n_options = n_global_long_options;
 249     ctl_add_cmd_options(&options, &n_options, &allocated_options, OPT_LOCAL);
 250     table_style.format = TF_LIST;
 251
 252     for (;;) {
 253         int idx;
 254         int c;
 255
 256         c = getopt_long(argc, argv, short_options, options, &idx);
 257         if (c == -1) {
 258             break;
 259         }
 260
 261         switch (c) {
 262         case OPT_DB:
 263             db = optarg;
 264             break;
 265
 266         case OPT_ONELINE:
 267             oneline = true;
 268             break;
 269
 270         case OPT_NO_SYSLOG:
 271             vlog_set_levels(&VLM_vsctl, VLF_SYSLOG, VLL_WARN);
 272             break;
 273
 274         case OPT_NO_WAIT:
 275             wait_for_reload = false;
 276             break;
 277
 278         case OPT_DRY_RUN:
 279             dry_run = true;
 280             break;
 281
 282         case OPT_LOCAL:
 283             if (shash_find(local_options, options[idx].name)) {
 284                 ctl_fatal("'%s' option specified multiple times",
 285                             options[idx].name);
 286             }
 287             shash_add_nocopy(local_options,
 288                              xasprintf("--%s", options[idx].name),
 289                              optarg ? xstrdup(optarg) : NULL);
 290             break;
 291
 292         case 'h':
 293             usage();
 294
 295         case OPT_COMMANDS:
 296             ctl_print_commands();
 297
 298         case OPT_OPTIONS:
 299             ctl_print_options(global_long_options);
 300
 301         case 'V':
 302             ovs_print_version(0, 0);
 303             printf("DB Schema %s\n", ovsrec_get_db_version());
 304             exit(EXIT_SUCCESS);
 305
 306         case 't':
 307             timeout = strtoul(optarg, NULL, 10);
 308             if (timeout < 0) {
 309                 ctl_fatal("value %s on -t or --timeout is invalid",
 310                             optarg);
 311             }
 312             break;
 313
 314         case OPT_RETRY:
 315             retry = true;
 316             break;
 317
 318         VLOG_OPTION_HANDLERS
 319         TABLE_OPTION_HANDLERS(&table_style)
 320
 321         STREAM_SSL_OPTION_HANDLERS
 322
 323         case OPT_PEER_CA_CERT:
 324             stream_ssl_set_peer_ca_cert_file(optarg);
 325             break;
 326
 327         case '?':
 328             exit(EXIT_FAILURE);
 329
 330         default:
 331             abort();
 332         }
 333     }
 334     free(short_options);
 335
 336     if (!db) {
 337         db = ctl_default_db();
 338     }
 339
 340     for (i = n_global_long_options; options[i].name; i++) {
 341         free(CONST_CAST(char *, options[i].name));
 342     }
 343     free(options);
 344 }
 345
 346 static void
 347 usage(void)
 348 {
 349     printf("\
 350 %s: ovs-vswitchd management utility\n\
 351 usage: %s [OPTIONS] COMMAND [ARG...]\n\
 352 \n\
 353 Open vSwitch commands:\n\
 354   init                        initialize database, if not yet initialized\n\
 355   show                        print overview of database contents\n\
 356   emer-reset                  reset configuration to clean state\n\
 357 \n\
 358 Bridge commands:\n\
 359   add-br BRIDGE               create a new bridge named BRIDGE\n\
 360   add-br BRIDGE PARENT VLAN   create new fake BRIDGE in PARENT on VLAN\n\
 361   del-br BRIDGE               delete BRIDGE and all of its ports\n\
 362   list-br                     print the names of all the bridges\n\
 363   br-exists BRIDGE            exit 2 if BRIDGE does not exist\n\
 364   br-to-vlan BRIDGE           print the VLAN which BRIDGE is on\n\
 365   br-to-parent BRIDGE         print the parent of BRIDGE\n\
 366   br-set-external-id BRIDGE KEY VALUE  set KEY on BRIDGE to VALUE\n\
 367   br-set-external-id BRIDGE KEY  unset KEY on BRIDGE\n\
 368   br-get-external-id BRIDGE KEY  print value of KEY on BRIDGE\n\
 369   br-get-external-id BRIDGE  list key-value pairs on BRIDGE\n\
 370 \n\
 371 Port commands (a bond is considered to be a single port):\n\
 372   list-ports BRIDGE           print the names of all the ports on BRIDGE\n\
 373   add-port BRIDGE PORT        add network device PORT to BRIDGE\n\
 374   add-bond BRIDGE PORT IFACE...  add bonded port PORT in BRIDGE from IFACES\n\
 375   del-port [BRIDGE] PORT      delete PORT (which may be bonded) from BRIDGE\n\
 376   port-to-br PORT             print name of bridge that contains PORT\n\
 377 \n\
 378 Interface commands (a bond consists of multiple interfaces):\n\
 379   list-ifaces BRIDGE          print the names of all interfaces on BRIDGE\n\
 380   iface-to-br IFACE           print name of bridge that contains IFACE\n\
 381 \n\
 382 Controller commands:\n\
 383   get-controller BRIDGE      print the controllers for BRIDGE\n\
 384   del-controller BRIDGE      delete the controllers for BRIDGE\n\
 385   set-controller BRIDGE TARGET...  set the controllers for BRIDGE\n\
 386   get-fail-mode BRIDGE       print the fail-mode for BRIDGE\n\
 387   del-fail-mode BRIDGE       delete the fail-mode for BRIDGE\n\
 388   set-fail-mode BRIDGE MODE  set the fail-mode for BRIDGE to MODE\n\
 389 \n\
 390 Manager commands:\n\
 391   get-manager                print the managers\n\
 392   del-manager                delete the managers\n\
 393   set-manager TARGET...      set the list of managers to TARGET...\n\
 394 \n\
 395 SSL commands:\n\
 396   get-ssl                     print the SSL configuration\n\
 397   del-ssl                     delete the SSL configuration\n\
 398   set-ssl PRIV-KEY CERT CA-CERT  set the SSL configuration\n\
 399 \n\
 400 Auto Attach commands:\n\
 401   add-aa-mapping BRIDGE I-SID VLAN   add Auto Attach mapping to BRIDGE\n\
 402   del-aa-mapping BRIDGE I-SID VLAN   delete Auto Attach mapping VLAN from BRIDGE\n\
 403   get-aa-mapping BRIDGE              get Auto Attach mappings from BRIDGE\n\
 404 \n\
 405 Switch commands:\n\
 406   emer-reset                  reset switch to known good state\n\
 407 \n\
 408 %s\
 409 \n\
 410 Options:\n\
 411   --db=DATABASE               connect to DATABASE\n\
 412                               (default: %s)\n\
 413   --no-wait                   do not wait for ovs-vswitchd to reconfigure\n\
 414   --retry                     keep trying to connect to server forever\n\
 415   -t, --timeout=SECS          wait at most SECS seconds for ovs-vswitchd\n\
 416   --dry-run                   do not commit changes to database\n\
 417   --oneline                   print exactly one line of output per command\n",
 418            program_name, program_name, ctl_get_db_cmd_usage(), ctl_default_db());
 419     vlog_usage();
 420     printf("\
 421   --no-syslog             equivalent to --verbose=vsctl:syslog:warn\n");
 422     stream_usage("database", true, true, false);
 423     printf("\n\
 424 Other options:\n\
 425   -h, --help                  display this help message\n\
 426   -V, --version               display version information\n");
 427     exit(EXIT_SUCCESS);
 428 }
 429
 430 \f
 431 /* ovs-vsctl specific context.  Inherits the 'struct ctl_context' as base. */
 432 struct vsctl_context {
 433     struct ctl_context base;
 434
 435     /* Modifiable state. */
 436     const struct ovsrec_open_vswitch *ovs;
 437     bool verified_ports;
 438
 439     /* A cache of the contents of the database.
 440      *
 441      * A command that needs to use any of this information must first call
 442      * vsctl_context_populate_cache().  A command that changes anything that
 443      * could invalidate the cache must either call
 444      * vsctl_context_invalidate_cache() or manually update the cache to
 445      * maintain its correctness. */
 446     bool cache_valid;
 447     struct shash bridges;   /* Maps from bridge name to struct vsctl_bridge. */
 448     struct shash ports;     /* Maps from port name to struct vsctl_port. */
 449     struct shash ifaces;    /* Maps from port name to struct vsctl_iface. */
 450 };
 451
 452 struct vsctl_bridge {
 453     struct ovsrec_bridge *br_cfg;
 454     char *name;
 455     struct ovs_list ports;      /* Contains "struct vsctl_port"s. */
 456
 457     /* VLAN ("fake") bridge support.
 458      *
 459      * Use 'parent != NULL' to detect a fake bridge, because 'vlan' can be 0
 460      * in either case. */
 461     struct hmap children;        /* VLAN bridges indexed by 'vlan'. */
 462     struct hmap_node children_node; /* Node in parent's 'children' hmap. */
 463     struct vsctl_bridge *parent; /* Real bridge, or NULL. */
 464     int vlan;                    /* VLAN VID (0...4095), or 0. */
 465 };
 466
 467 struct vsctl_port {
 468     struct ovs_list ports_node;  /* In struct vsctl_bridge's 'ports' list. */
 469     struct ovs_list ifaces;      /* Contains "struct vsctl_iface"s. */
 470     struct ovsrec_port *port_cfg;
 471     struct vsctl_bridge *bridge;
 472 };
 473
 474 struct vsctl_iface {
 475     struct ovs_list ifaces_node; /* In struct vsctl_port's 'ifaces' list. */
 476     struct ovsrec_interface *iface_cfg;
 477     struct vsctl_port *port;
 478 };
 479
 480 /* Casts 'base' into 'strcut vsctl_context'. */
 481 static struct vsctl_context *
 482 vsctl_context_cast(struct ctl_context *base)
 483 {
 484     return CONTAINER_OF(base, struct vsctl_context, base);
 485 }
 486
 487 static struct vsctl_bridge *find_vlan_bridge(struct vsctl_bridge *parent,
 488                                              int vlan);
 489
 490 static char *
 491 vsctl_context_to_string(const struct ctl_context *ctx)
 492 {
 493     const struct shash_node *node;
 494     struct svec words;
 495     char *s;
 496     int i;
 497
 498     svec_init(&words);
 499     SHASH_FOR_EACH (node, &ctx->options) {
 500         svec_add(&words, node->name);
 501     }
 502     for (i = 0; i < ctx->argc; i++) {
 503         svec_add(&words, ctx->argv[i]);
 504     }
 505     svec_terminate(&words);
 506
 507     s = process_escape_args(words.names);
 508
 509     svec_destroy(&words);
 510
 511     return s;
 512 }
 513
 514 static void
 515 verify_ports(struct vsctl_context *vsctl_ctx)
 516 {
 517     if (!vsctl_ctx->verified_ports) {
 518         const struct ovsrec_bridge *bridge;
 519         const struct ovsrec_port *port;
 520
 521         ovsrec_open_vswitch_verify_bridges(vsctl_ctx->ovs);
 522         OVSREC_BRIDGE_FOR_EACH (bridge, vsctl_ctx->base.idl) {
 523             ovsrec_bridge_verify_ports(bridge);
 524         }
 525         OVSREC_PORT_FOR_EACH (port, vsctl_ctx->base.idl) {
 526             ovsrec_port_verify_interfaces(port);
 527         }
 528
 529         vsctl_ctx->verified_ports = true;
 530     }
 531 }
 532
 533 static struct vsctl_bridge *
 534 add_bridge_to_cache(struct vsctl_context *vsctl_ctx,
 535                     struct ovsrec_bridge *br_cfg, const char *name,
 536                     struct vsctl_bridge *parent, int vlan)
 537 {
 538     struct vsctl_bridge *br = xmalloc(sizeof *br);
 539     br->br_cfg = br_cfg;
 540     br->name = xstrdup(name);
 541     list_init(&br->ports);
 542     br->parent = parent;
 543     br->vlan = vlan;
 544     hmap_init(&br->children);
 545     if (parent) {
 546         struct vsctl_bridge *conflict = find_vlan_bridge(parent, vlan);
 547         if (conflict) {
 548             VLOG_WARN("%s: bridge has multiple VLAN bridges (%s and %s) "
 549                       "for VLAN %d, but only one is allowed",
 550                       parent->name, name, conflict->name, vlan);
 551         } else {
 552             hmap_insert(&parent->children, &br->children_node,
 553                         hash_int(vlan, 0));
 554         }
 555     }
 556     shash_add(&vsctl_ctx->bridges, br->name, br);
 557     return br;
 558 }
 559
 560 static void
 561 ovs_delete_bridge(const struct ovsrec_open_vswitch *ovs,
 562                   struct ovsrec_bridge *bridge)
 563 {
 564     struct ovsrec_bridge **bridges;
 565     size_t i, n;
 566
 567     bridges = xmalloc(sizeof *ovs->bridges * ovs->n_bridges);
 568     for (i = n = 0; i < ovs->n_bridges; i++) {
 569         if (ovs->bridges[i] != bridge) {
 570             bridges[n++] = ovs->bridges[i];
 571         }
 572     }
 573     ovsrec_open_vswitch_set_bridges(ovs, bridges, n);
 574     free(bridges);
 575 }
 576
 577 static void
 578 del_cached_bridge(struct vsctl_context *vsctl_ctx, struct vsctl_bridge *br)
 579 {
 580     ovs_assert(list_is_empty(&br->ports));
 581     ovs_assert(hmap_is_empty(&br->children));
 582     if (br->parent) {
 583         hmap_remove(&br->parent->children, &br->children_node);
 584     }
 585     if (br->br_cfg) {
 586         ovsrec_bridge_delete(br->br_cfg);
 587         ovs_delete_bridge(vsctl_ctx->ovs, br->br_cfg);
 588     }
 589     shash_find_and_delete(&vsctl_ctx->bridges, br->name);
 590     hmap_destroy(&br->children);
 591     free(br->name);
 592     free(br);
 593 }
 594
 595 static bool
 596 port_is_fake_bridge(const struct ovsrec_port *port_cfg)
 597 {
 598     return (port_cfg->fake_bridge
 599             && port_cfg->tag
 600             && *port_cfg->tag >= 0 && *port_cfg->tag <= 4095);
 601 }
 602
 603 static struct vsctl_bridge *
 604 find_vlan_bridge(struct vsctl_bridge *parent, int vlan)
 605 {
 606     struct vsctl_bridge *child;
 607
 608     HMAP_FOR_EACH_IN_BUCKET (child, children_node, hash_int(vlan, 0),
 609                              &parent->children) {
 610         if (child->vlan == vlan) {
 611             return child;
 612         }
 613     }
 614
 615     return NULL;
 616 }
 617
 618 static struct vsctl_port *
 619 add_port_to_cache(struct vsctl_context *vsctl_ctx, struct vsctl_bridge *parent,
 620                   struct ovsrec_port *port_cfg)
 621 {
 622     struct vsctl_port *port;
 623
 624     if (port_cfg->tag
 625         && *port_cfg->tag >= 0 && *port_cfg->tag <= 4095) {
 626         struct vsctl_bridge *vlan_bridge;
 627
 628         vlan_bridge = find_vlan_bridge(parent, *port_cfg->tag);
 629         if (vlan_bridge) {
 630             parent = vlan_bridge;
 631         }
 632     }
 633
 634     port = xmalloc(sizeof *port);
 635     list_push_back(&parent->ports, &port->ports_node);
 636     list_init(&port->ifaces);
 637     port->port_cfg = port_cfg;
 638     port->bridge = parent;
 639     shash_add(&vsctl_ctx->ports, port_cfg->name, port);
 640
 641     return port;
 642 }
 643
 644 static void
 645 del_cached_port(struct vsctl_context *vsctl_ctx, struct vsctl_port *port)
 646 {
 647     ovs_assert(list_is_empty(&port->ifaces));
 648     list_remove(&port->ports_node);
 649     shash_find_and_delete(&vsctl_ctx->ports, port->port_cfg->name);
 650     ovsrec_port_delete(port->port_cfg);
 651     free(port);
 652 }
 653
 654 static struct vsctl_iface *
 655 add_iface_to_cache(struct vsctl_context *vsctl_ctx, struct vsctl_port *parent,
 656                    struct ovsrec_interface *iface_cfg)
 657 {
 658     struct vsctl_iface *iface;
 659
 660     iface = xmalloc(sizeof *iface);
 661     list_push_back(&parent->ifaces, &iface->ifaces_node);
 662     iface->iface_cfg = iface_cfg;
 663     iface->port = parent;
 664     shash_add(&vsctl_ctx->ifaces, iface_cfg->name, iface);
 665
 666     return iface;
 667 }
 668
 669 static void
 670 del_cached_iface(struct vsctl_context *vsctl_ctx, struct vsctl_iface *iface)
 671 {
 672     list_remove(&iface->ifaces_node);
 673     shash_find_and_delete(&vsctl_ctx->ifaces, iface->iface_cfg->name);
 674     ovsrec_interface_delete(iface->iface_cfg);
 675     free(iface);
 676 }
 677
 678 static void
 679 vsctl_context_invalidate_cache(struct ctl_context *ctx)
 680 {
 681     struct vsctl_context *vsctl_ctx = vsctl_context_cast(ctx);
 682     struct shash_node *node;
 683
 684     if (!vsctl_ctx->cache_valid) {
 685         return;
 686     }
 687     vsctl_ctx->cache_valid = false;
 688
 689     SHASH_FOR_EACH (node, &vsctl_ctx->bridges) {
 690         struct vsctl_bridge *bridge = node->data;
 691         hmap_destroy(&bridge->children);
 692         free(bridge->name);
 693         free(bridge);
 694     }
 695     shash_destroy(&vsctl_ctx->bridges);
 696
 697     shash_destroy_free_data(&vsctl_ctx->ports);
 698     shash_destroy_free_data(&vsctl_ctx->ifaces);
 699 }
 700
 701 static void
 702 pre_get_info(struct ctl_context *ctx)
 703 {
 704     ovsdb_idl_add_column(ctx->idl, &ovsrec_open_vswitch_col_bridges);
 705
 706     ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_name);
 707     ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_controller);
 708     ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_fail_mode);
 709     ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_ports);
 710
 711     ovsdb_idl_add_column(ctx->idl, &ovsrec_port_col_name);
 712     ovsdb_idl_add_column(ctx->idl, &ovsrec_port_col_fake_bridge);
 713     ovsdb_idl_add_column(ctx->idl, &ovsrec_port_col_tag);
 714     ovsdb_idl_add_column(ctx->idl, &ovsrec_port_col_interfaces);
 715
 716     ovsdb_idl_add_column(ctx->idl, &ovsrec_interface_col_name);
 717
 718     ovsdb_idl_add_column(ctx->idl, &ovsrec_interface_col_ofport);
 719 }
 720
 721 static void
 722 vsctl_context_populate_cache(struct ctl_context *ctx)
 723 {
 724     struct vsctl_context *vsctl_ctx = vsctl_context_cast(ctx);
 725     const struct ovsrec_open_vswitch *ovs = vsctl_ctx->ovs;
 726     struct sset bridges, ports;
 727     size_t i;
 728
 729     if (vsctl_ctx->cache_valid) {
 730         /* Cache is already populated. */
 731         return;
 732     }
 733     vsctl_ctx->cache_valid = true;
 734     shash_init(&vsctl_ctx->bridges);
 735     shash_init(&vsctl_ctx->ports);
 736     shash_init(&vsctl_ctx->ifaces);
 737
 738     sset_init(&bridges);
 739     sset_init(&ports);
 740     for (i = 0; i < ovs->n_bridges; i++) {
 741         struct ovsrec_bridge *br_cfg = ovs->bridges[i];
 742         struct vsctl_bridge *br;
 743         size_t j;
 744
 745         if (!sset_add(&bridges, br_cfg->name)) {
 746             VLOG_WARN("%s: database contains duplicate bridge name",
 747                       br_cfg->name);
 748             continue;
 749         }
 750         br = add_bridge_to_cache(vsctl_ctx, br_cfg, br_cfg->name, NULL, 0);
 751
 752         for (j = 0; j < br_cfg->n_ports; j++) {
 753             struct ovsrec_port *port_cfg = br_cfg->ports[j];
 754
 755             if (!sset_add(&ports, port_cfg->name)) {
 756                 /* Duplicate port name.  (We will warn about that later.) */
 757                 continue;
 758             }
 759
 760             if (port_is_fake_bridge(port_cfg)
 761                 && sset_add(&bridges, port_cfg->name)) {
 762                 add_bridge_to_cache(vsctl_ctx, NULL, port_cfg->name, br,
 763                                     *port_cfg->tag);
 764             }
 765         }
 766     }
 767     sset_destroy(&bridges);
 768     sset_destroy(&ports);
 769
 770     sset_init(&bridges);
 771     for (i = 0; i < ovs->n_bridges; i++) {
 772         struct ovsrec_bridge *br_cfg = ovs->bridges[i];
 773         struct vsctl_bridge *br;
 774         size_t j;
 775
 776         if (!sset_add(&bridges, br_cfg->name)) {
 777             continue;
 778         }
 779         br = shash_find_data(&vsctl_ctx->bridges, br_cfg->name);
 780         for (j = 0; j < br_cfg->n_ports; j++) {
 781             struct ovsrec_port *port_cfg = br_cfg->ports[j];
 782             struct vsctl_port *port;
 783             size_t k;
 784
 785             port = shash_find_data(&vsctl_ctx->ports, port_cfg->name);
 786             if (port) {
 787                 if (port_cfg == port->port_cfg) {
 788                     VLOG_WARN("%s: port is in multiple bridges (%s and %s)",
 789                               port_cfg->name, br->name, port->bridge->name);
 790                 } else {
 791                     /* Log as an error because this violates the database's
 792                      * uniqueness constraints, so the database server shouldn't
 793                      * have allowed it. */
 794                     VLOG_ERR("%s: database contains duplicate port name",
 795                              port_cfg->name);
 796                 }
 797                 continue;
 798             }
 799
 800             if (port_is_fake_bridge(port_cfg)
 801                 && !sset_add(&bridges, port_cfg->name)) {
 802                 continue;
 803             }
 804
 805             port = add_port_to_cache(vsctl_ctx, br, port_cfg);
 806             for (k = 0; k < port_cfg->n_interfaces; k++) {
 807                 struct ovsrec_interface *iface_cfg = port_cfg->interfaces[k];
 808                 struct vsctl_iface *iface;
 809
 810                 iface = shash_find_data(&vsctl_ctx->ifaces, iface_cfg->name);
 811                 if (iface) {
 812                     if (iface_cfg == iface->iface_cfg) {
 813                         VLOG_WARN("%s: interface is in multiple ports "
 814                                   "(%s and %s)",
 815                                   iface_cfg->name,
 816                                   iface->port->port_cfg->name,
 817                                   port->port_cfg->name);
 818                     } else {
 819                         /* Log as an error because this violates the database's
 820                          * uniqueness constraints, so the database server
 821                          * shouldn't have allowed it. */
 822                         VLOG_ERR("%s: database contains duplicate interface "
 823                                  "name", iface_cfg->name);
 824                     }
 825                     continue;
 826                 }
 827
 828                 add_iface_to_cache(vsctl_ctx, port, iface_cfg);
 829             }
 830         }
 831     }
 832     sset_destroy(&bridges);
 833 }
 834
 835 static void
 836 check_conflicts(struct vsctl_context *vsctl_ctx, const char *name,
 837                 char *msg)
 838 {
 839     struct vsctl_iface *iface;
 840     struct vsctl_port *port;
 841
 842     verify_ports(vsctl_ctx);
 843
 844     if (shash_find(&vsctl_ctx->bridges, name)) {
 845         ctl_fatal("%s because a bridge named %s already exists",
 846                     msg, name);
 847     }
 848
 849     port = shash_find_data(&vsctl_ctx->ports, name);
 850     if (port) {
 851         ctl_fatal("%s because a port named %s already exists on "
 852                     "bridge %s", msg, name, port->bridge->name);
 853     }
 854
 855     iface = shash_find_data(&vsctl_ctx->ifaces, name);
 856     if (iface) {
 857         ctl_fatal("%s because an interface named %s already exists "
 858                     "on bridge %s", msg, name, iface->port->bridge->name);
 859     }
 860
 861     free(msg);
 862 }
 863
 864 static struct vsctl_bridge *
 865 find_bridge(struct vsctl_context *vsctl_ctx, const char *name, bool must_exist)
 866 {
 867     struct vsctl_bridge *br;
 868
 869     ovs_assert(vsctl_ctx->cache_valid);
 870
 871     br = shash_find_data(&vsctl_ctx->bridges, name);
 872     if (must_exist && !br) {
 873         ctl_fatal("no bridge named %s", name);
 874     }
 875     ovsrec_open_vswitch_verify_bridges(vsctl_ctx->ovs);
 876     return br;
 877 }
 878
 879 static struct vsctl_bridge *
 880 find_real_bridge(struct vsctl_context *vsctl_ctx,
 881                  const char *name, bool must_exist)
 882 {
 883     struct vsctl_bridge *br = find_bridge(vsctl_ctx, name, must_exist);
 884     if (br && br->parent) {
 885         ctl_fatal("%s is a fake bridge", name);
 886     }
 887     return br;
 888 }
 889
 890 static struct vsctl_port *
 891 find_port(struct vsctl_context *vsctl_ctx, const char *name, bool must_exist)
 892 {
 893     struct vsctl_port *port;
 894
 895     ovs_assert(vsctl_ctx->cache_valid);
 896
 897     port = shash_find_data(&vsctl_ctx->ports, name);
 898     if (port && !strcmp(name, port->bridge->name)) {
 899         port = NULL;
 900     }
 901     if (must_exist && !port) {
 902         ctl_fatal("no port named %s", name);
 903     }
 904     verify_ports(vsctl_ctx);
 905     return port;
 906 }
 907
 908 static struct vsctl_iface *
 909 find_iface(struct vsctl_context *vsctl_ctx, const char *name, bool must_exist)
 910 {
 911     struct vsctl_iface *iface;
 912
 913     ovs_assert(vsctl_ctx->cache_valid);
 914
 915     iface = shash_find_data(&vsctl_ctx->ifaces, name);
 916     if (iface && !strcmp(name, iface->port->bridge->name)) {
 917         iface = NULL;
 918     }
 919     if (must_exist && !iface) {
 920         ctl_fatal("no interface named %s", name);
 921     }
 922     verify_ports(vsctl_ctx);
 923     return iface;
 924 }
 925
 926 static void
 927 bridge_insert_port(struct ovsrec_bridge *br, struct ovsrec_port *port)
 928 {
 929     struct ovsrec_port **ports;
 930     size_t i;
 931
 932     ports = xmalloc(sizeof *br->ports * (br->n_ports + 1));
 933     for (i = 0; i < br->n_ports; i++) {
 934         ports[i] = br->ports[i];
 935     }
 936     ports[br->n_ports] = port;
 937     ovsrec_bridge_set_ports(br, ports, br->n_ports + 1);
 938     free(ports);
 939 }
 940
 941 static void
 942 bridge_delete_port(struct ovsrec_bridge *br, struct ovsrec_port *port)
 943 {
 944     struct ovsrec_port **ports;
 945     size_t i, n;
 946
 947     ports = xmalloc(sizeof *br->ports * br->n_ports);
 948     for (i = n = 0; i < br->n_ports; i++) {
 949         if (br->ports[i] != port) {
 950             ports[n++] = br->ports[i];
 951         }
 952     }
 953     ovsrec_bridge_set_ports(br, ports, n);
 954     free(ports);
 955 }
 956
 957 static void
 958 ovs_insert_bridge(const struct ovsrec_open_vswitch *ovs,
 959                   struct ovsrec_bridge *bridge)
 960 {
 961     struct ovsrec_bridge **bridges;
 962     size_t i;
 963
 964     bridges = xmalloc(sizeof *ovs->bridges * (ovs->n_bridges + 1));
 965     for (i = 0; i < ovs->n_bridges; i++) {
 966         bridges[i] = ovs->bridges[i];
 967     }
 968     bridges[ovs->n_bridges] = bridge;
 969     ovsrec_open_vswitch_set_bridges(ovs, bridges, ovs->n_bridges + 1);
 970     free(bridges);
 971 }
 972
 973 static void
 974 cmd_init(struct ctl_context *ctx OVS_UNUSED)
 975 {
 976 }
 977
 978 static struct cmd_show_table cmd_show_tables[] = {
 979     {&ovsrec_table_open_vswitch,
 980      NULL,
 981      {&ovsrec_open_vswitch_col_manager_options,
 982       &ovsrec_open_vswitch_col_bridges,
 983       &ovsrec_open_vswitch_col_ovs_version},
 984      {NULL, NULL, NULL}
 985     },
 986
 987     {&ovsrec_table_bridge,
 988      &ovsrec_bridge_col_name,
 989      {&ovsrec_bridge_col_controller,
 990       &ovsrec_bridge_col_fail_mode,
 991       &ovsrec_bridge_col_ports},
 992      {NULL, NULL, NULL}
 993     },
 994
 995     {&ovsrec_table_port,
 996      &ovsrec_port_col_name,
 997      {&ovsrec_port_col_tag,
 998       &ovsrec_port_col_trunks,
 999       &ovsrec_port_col_interfaces},
1000      {NULL, NULL, NULL}
1001     },
1002
1003     {&ovsrec_table_interface,
1004      &ovsrec_interface_col_name,
1005      {&ovsrec_interface_col_type,
1006       &ovsrec_interface_col_options,
1007       &ovsrec_interface_col_error},
1008      {NULL, NULL, NULL}
1009     },
1010
1011     {&ovsrec_table_controller,
1012      &ovsrec_controller_col_target,
1013      {&ovsrec_controller_col_is_connected,
1014       NULL,
1015       NULL},
1016      {NULL, NULL, NULL}
1017     },
1018
1019     {&ovsrec_table_manager,
1020      &ovsrec_manager_col_target,
1021      {&ovsrec_manager_col_is_connected,
1022       NULL,
1023       NULL},
1024      {NULL, NULL, NULL}
1025     },
1026
1027     {NULL, NULL, {NULL, NULL, NULL}, {NULL, NULL, NULL}}
1028 };
1029
1030 static void
1031 pre_cmd_emer_reset(struct ctl_context *ctx)
1032 {
1033     ovsdb_idl_add_column(ctx->idl, &ovsrec_open_vswitch_col_manager_options);
1034     ovsdb_idl_add_column(ctx->idl, &ovsrec_open_vswitch_col_ssl);
1035
1036     ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_controller);
1037     ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_fail_mode);
1038     ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_mirrors);
1039     ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_netflow);
1040     ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_sflow);
1041     ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_ipfix);
1042     ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_flood_vlans);
1043     ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_other_config);
1044
1045     ovsdb_idl_add_column(ctx->idl, &ovsrec_port_col_other_config);
1046
1047     ovsdb_idl_add_column(ctx->idl,
1048                           &ovsrec_interface_col_ingress_policing_rate);
1049     ovsdb_idl_add_column(ctx->idl,
1050                           &ovsrec_interface_col_ingress_policing_burst);
1051 }
1052
1053 static void
1054 cmd_emer_reset(struct ctl_context *ctx)
1055 {
1056     struct vsctl_context *vsctl_ctx = vsctl_context_cast(ctx);
1057     const struct ovsdb_idl *idl = ctx->idl;
1058     const struct ovsrec_bridge *br;
1059     const struct ovsrec_port *port;
1060     const struct ovsrec_interface *iface;
1061     const struct ovsrec_mirror *mirror, *next_mirror;
1062     const struct ovsrec_controller *ctrl, *next_ctrl;
1063     const struct ovsrec_manager *mgr, *next_mgr;
1064     const struct ovsrec_netflow *nf, *next_nf;
1065     const struct ovsrec_ssl *ssl, *next_ssl;
1066     const struct ovsrec_sflow *sflow, *next_sflow;
1067     const struct ovsrec_ipfix *ipfix, *next_ipfix;
1068     const struct ovsrec_flow_sample_collector_set *fscset, *next_fscset;
1069
1070     /* Reset the Open_vSwitch table. */
1071     ovsrec_open_vswitch_set_manager_options(vsctl_ctx->ovs, NULL, 0);
1072     ovsrec_open_vswitch_set_ssl(vsctl_ctx->ovs, NULL);
1073
1074     OVSREC_BRIDGE_FOR_EACH (br, idl) {
1075         const char *hwaddr;
1076
1077         ovsrec_bridge_set_controller(br, NULL, 0);
1078         ovsrec_bridge_set_fail_mode(br, NULL);
1079         ovsrec_bridge_set_mirrors(br, NULL, 0);
1080         ovsrec_bridge_set_netflow(br, NULL);
1081         ovsrec_bridge_set_sflow(br, NULL);
1082         ovsrec_bridge_set_ipfix(br, NULL);
1083         ovsrec_bridge_set_flood_vlans(br, NULL, 0);
1084
1085         /* We only want to save the "hwaddr" key from other_config. */
1086         hwaddr = smap_get(&br->other_config, "hwaddr");
1087         if (hwaddr) {
1088             struct smap smap = SMAP_INITIALIZER(&smap);
1089             smap_add(&smap, "hwaddr", hwaddr);
1090             ovsrec_bridge_set_other_config(br, &smap);
1091             smap_destroy(&smap);
1092         } else {
1093             ovsrec_bridge_set_other_config(br, NULL);
1094         }
1095     }
1096
1097     OVSREC_PORT_FOR_EACH (port, idl) {
1098         ovsrec_port_set_other_config(port, NULL);
1099     }
1100
1101     OVSREC_INTERFACE_FOR_EACH (iface, idl) {
1102         /* xxx What do we do about gre/patch devices created by mgr? */
1103
1104         ovsrec_interface_set_ingress_policing_rate(iface, 0);
1105         ovsrec_interface_set_ingress_policing_burst(iface, 0);
1106     }
1107
1108     OVSREC_MIRROR_FOR_EACH_SAFE (mirror, next_mirror, idl) {
1109         ovsrec_mirror_delete(mirror);
1110     }
1111
1112     OVSREC_CONTROLLER_FOR_EACH_SAFE (ctrl, next_ctrl, idl) {
1113         ovsrec_controller_delete(ctrl);
1114     }
1115
1116     OVSREC_MANAGER_FOR_EACH_SAFE (mgr, next_mgr, idl) {
1117         ovsrec_manager_delete(mgr);
1118     }
1119
1120     OVSREC_NETFLOW_FOR_EACH_SAFE (nf, next_nf, idl) {
1121         ovsrec_netflow_delete(nf);
1122     }
1123
1124     OVSREC_SSL_FOR_EACH_SAFE (ssl, next_ssl, idl) {
1125         ovsrec_ssl_delete(ssl);
1126     }
1127
1128     OVSREC_SFLOW_FOR_EACH_SAFE (sflow, next_sflow, idl) {
1129         ovsrec_sflow_delete(sflow);
1130     }
1131
1132     OVSREC_IPFIX_FOR_EACH_SAFE (ipfix, next_ipfix, idl) {
1133         ovsrec_ipfix_delete(ipfix);
1134     }
1135
1136     OVSREC_FLOW_SAMPLE_COLLECTOR_SET_FOR_EACH_SAFE (fscset, next_fscset, idl) {
1137         ovsrec_flow_sample_collector_set_delete(fscset);
1138     }
1139
1140     vsctl_context_invalidate_cache(ctx);
1141 }
1142
1143 static void
1144 cmd_add_br(struct ctl_context *ctx)
1145 {
1146     struct vsctl_context *vsctl_ctx = vsctl_context_cast(ctx);
1147     bool may_exist = shash_find(&ctx->options, "--may-exist") != NULL;
1148     const char *br_name, *parent_name;
1149     struct ovsrec_interface *iface;
1150     int vlan;
1151
1152     br_name = ctx->argv[1];
1153     if (ctx->argc == 2) {
1154         parent_name = NULL;
1155         vlan = 0;
1156     } else if (ctx->argc == 4) {
1157         parent_name = ctx->argv[2];
1158         vlan = atoi(ctx->argv[3]);
1159         if (vlan < 0 || vlan > 4095) {
1160             ctl_fatal("%s: vlan must be between 0 and 4095", ctx->argv[0]);
1161         }
1162     } else {
1163         ctl_fatal("'%s' command takes exactly 1 or 3 arguments",
1164                     ctx->argv[0]);
1165     }
1166
1167     vsctl_context_populate_cache(ctx);
1168     if (may_exist) {
1169         struct vsctl_bridge *br;
1170
1171         br = find_bridge(vsctl_ctx, br_name, false);
1172         if (br) {
1173             if (!parent_name) {
1174                 if (br->parent) {
1175                     ctl_fatal("\"--may-exist add-br %s\" but %s is "
1176                                 "a VLAN bridge for VLAN %d",
1177                                 br_name, br_name, br->vlan);
1178                 }
1179             } else {
1180                 if (!br->parent) {
1181                     ctl_fatal("\"--may-exist add-br %s %s %d\" but %s "
1182                                 "is not a VLAN bridge",
1183                                 br_name, parent_name, vlan, br_name);
1184                 } else if (strcmp(br->parent->name, parent_name)) {
1185                     ctl_fatal("\"--may-exist add-br %s %s %d\" but %s "
1186                                 "has the wrong parent %s",
1187                                 br_name, parent_name, vlan,
1188                                 br_name, br->parent->name);
1189                 } else if (br->vlan != vlan) {
1190                     ctl_fatal("\"--may-exist add-br %s %s %d\" but %s "
1191                                 "is a VLAN bridge for the wrong VLAN %d",
1192                                 br_name, parent_name, vlan, br_name, br->vlan);
1193                 }
1194             }
1195             return;
1196         }
1197     }
1198     check_conflicts(vsctl_ctx, br_name,
1199                     xasprintf("cannot create a bridge named %s", br_name));
1200
1201     if (!parent_name) {
1202         struct ovsrec_port *port;
1203         struct ovsrec_bridge *br;
1204
1205         iface = ovsrec_interface_insert(ctx->txn);
1206         ovsrec_interface_set_name(iface, br_name);
1207         ovsrec_interface_set_type(iface, "internal");
1208
1209         port = ovsrec_port_insert(ctx->txn);
1210         ovsrec_port_set_name(port, br_name);
1211         ovsrec_port_set_interfaces(port, &iface, 1);
1212
1213         br = ovsrec_bridge_insert(ctx->txn);
1214         ovsrec_bridge_set_name(br, br_name);
1215         ovsrec_bridge_set_ports(br, &port, 1);
1216
1217         ovs_insert_bridge(vsctl_ctx->ovs, br);
1218     } else {
1219         struct vsctl_bridge *conflict;
1220         struct vsctl_bridge *parent;
1221         struct ovsrec_port *port;
1222         struct ovsrec_bridge *br;
1223         int64_t tag = vlan;
1224
1225         parent = find_bridge(vsctl_ctx, parent_name, false);
1226         if (parent && parent->parent) {
1227             ctl_fatal("cannot create bridge with fake bridge as parent");
1228         }
1229         if (!parent) {
1230             ctl_fatal("parent bridge %s does not exist", parent_name);
1231         }
1232         conflict = find_vlan_bridge(parent, vlan);
1233         if (conflict) {
1234             ctl_fatal("bridge %s already has a child VLAN bridge %s "
1235                         "on VLAN %d", parent_name, conflict->name, vlan);
1236         }
1237         br = parent->br_cfg;
1238
1239         iface = ovsrec_interface_insert(ctx->txn);
1240         ovsrec_interface_set_name(iface, br_name);
1241         ovsrec_interface_set_type(iface, "internal");
1242
1243         port = ovsrec_port_insert(ctx->txn);
1244         ovsrec_port_set_name(port, br_name);
1245         ovsrec_port_set_interfaces(port, &iface, 1);
1246         ovsrec_port_set_fake_bridge(port, true);
1247         ovsrec_port_set_tag(port, &tag, 1);
1248
1249         bridge_insert_port(br, port);
1250     }
1251
1252     post_db_reload_expect_iface(iface);
1253     vsctl_context_invalidate_cache(ctx);
1254 }
1255
1256 static void
1257 del_port(struct vsctl_context *vsctl_ctx, struct vsctl_port *port)
1258 {
1259     struct vsctl_iface *iface, *next_iface;
1260
1261     bridge_delete_port((port->bridge->parent
1262                         ? port->bridge->parent->br_cfg
1263                         : port->bridge->br_cfg), port->port_cfg);
1264
1265     LIST_FOR_EACH_SAFE (iface, next_iface, ifaces_node, &port->ifaces) {
1266         del_cached_iface(vsctl_ctx, iface);
1267     }
1268     del_cached_port(vsctl_ctx, port);
1269 }
1270
1271 static void
1272 del_bridge(struct vsctl_context *vsctl_ctx, struct vsctl_bridge *br)
1273 {
1274     struct vsctl_bridge *child, *next_child;
1275     struct vsctl_port *port, *next_port;
1276     const struct ovsrec_flow_sample_collector_set *fscset, *next_fscset;
1277
1278     HMAP_FOR_EACH_SAFE (child, next_child, children_node, &br->children) {
1279         del_bridge(vsctl_ctx, child);
1280     }
1281
1282     LIST_FOR_EACH_SAFE (port, next_port, ports_node, &br->ports) {
1283         del_port(vsctl_ctx, port);
1284     }
1285
1286     OVSREC_FLOW_SAMPLE_COLLECTOR_SET_FOR_EACH_SAFE (fscset, next_fscset,
1287                                                     vsctl_ctx->base.idl) {
1288         if (fscset->bridge == br->br_cfg) {
1289             ovsrec_flow_sample_collector_set_delete(fscset);
1290         }
1291     }
1292
1293     del_cached_bridge(vsctl_ctx, br);
1294 }
1295
1296 static void
1297 cmd_del_br(struct ctl_context *ctx)
1298 {
1299     struct vsctl_context *vsctl_ctx = vsctl_context_cast(ctx);
1300     bool must_exist = !shash_find(&ctx->options, "--if-exists");
1301     struct vsctl_bridge *bridge;
1302
1303     vsctl_context_populate_cache(ctx);
1304     bridge = find_bridge(vsctl_ctx, ctx->argv[1], must_exist);
1305     if (bridge) {
1306         del_bridge(vsctl_ctx, bridge);
1307     }
1308 }
1309
1310 static void
1311 output_sorted(struct svec *svec, struct ds *output)
1312 {
1313     const char *name;
1314     size_t i;
1315
1316     svec_sort(svec);
1317     SVEC_FOR_EACH (i, name, svec) {
1318         ds_put_format(output, "%s\n", name);
1319     }
1320 }
1321
1322 static void
1323 cmd_list_br(struct ctl_context *ctx)
1324 {
1325     struct vsctl_context *vsctl_ctx = vsctl_context_cast(ctx);
1326     struct shash_node *node;
1327     struct svec bridges;
1328     bool real = shash_find(&ctx->options, "--real");
1329     bool fake = shash_find(&ctx->options, "--fake");
1330
1331     /* If neither fake nor real were requested, return both. */
1332     if (!real && !fake) {
1333         real = fake = true;
1334     }
1335
1336     vsctl_context_populate_cache(ctx);
1337
1338     svec_init(&bridges);
1339     SHASH_FOR_EACH (node, &vsctl_ctx->bridges) {
1340         struct vsctl_bridge *br = node->data;
1341
1342         if (br->parent ? fake : real) {
1343             svec_add(&bridges, br->name);
1344         }
1345     }
1346     output_sorted(&bridges, &ctx->output);
1347     svec_destroy(&bridges);
1348 }
1349
1350 static void
1351 cmd_br_exists(struct ctl_context *ctx)
1352 {
1353     struct vsctl_context *vsctl_ctx = vsctl_context_cast(ctx);
1354
1355     vsctl_context_populate_cache(ctx);
1356     if (!find_bridge(vsctl_ctx, ctx->argv[1], false)) {
1357         vsctl_exit(2);
1358     }
1359 }
1360
1361 static void
1362 set_external_id(struct smap *old, struct smap *new,
1363                 char *key, char *value)
1364 {
1365     smap_clone(new, old);
1366
1367     if (value) {
1368         smap_replace(new, key, value);
1369     } else {
1370         smap_remove(new, key);
1371     }
1372 }
1373
1374 static void
1375 pre_cmd_br_set_external_id(struct ctl_context *ctx)
1376 {
1377     pre_get_info(ctx);
1378     ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_external_ids);
1379     ovsdb_idl_add_column(ctx->idl, &ovsrec_port_col_external_ids);
1380 }
1381
1382 static void
1383 cmd_br_set_external_id(struct ctl_context *ctx)
1384 {
1385     struct vsctl_context *vsctl_ctx = vsctl_context_cast(ctx);
1386     struct vsctl_bridge *bridge;
1387     struct smap new;
1388
1389     vsctl_context_populate_cache(ctx);
1390     bridge = find_bridge(vsctl_ctx, ctx->argv[1], true);
1391     if (bridge->br_cfg) {
1392
1393         set_external_id(&bridge->br_cfg->external_ids, &new, ctx->argv[2],
1394                         ctx->argc >= 4 ? ctx->argv[3] : NULL);
1395         ovsrec_bridge_verify_external_ids(bridge->br_cfg);
1396         ovsrec_bridge_set_external_ids(bridge->br_cfg, &new);
1397     } else {
1398         char *key = xasprintf("fake-bridge-%s", ctx->argv[2]);
1399         struct vsctl_port *port = shash_find_data(&vsctl_ctx->ports,
1400                                                   ctx->argv[1]);
1401         set_external_id(&port->port_cfg->external_ids, &new,
1402                         key, ctx->argc >= 4 ? ctx->argv[3] : NULL);
1403         ovsrec_port_verify_external_ids(port->port_cfg);
1404         ovsrec_port_set_external_ids(port->port_cfg, &new);
1405         free(key);
1406     }
1407     smap_destroy(&new);
1408 }
1409
1410 static void
1411 get_external_id(struct smap *smap, const char *prefix, const char *key,
1412                 struct ds *output)
1413 {
1414     if (key) {
1415         char *prefix_key = xasprintf("%s%s", prefix, key);
1416         const char *value = smap_get(smap, prefix_key);
1417
1418         if (value) {
1419             ds_put_format(output, "%s\n", value);
1420         }
1421         free(prefix_key);
1422     } else {
1423         const struct smap_node **sorted = smap_sort(smap);
1424         size_t prefix_len = strlen(prefix);
1425         size_t i;
1426
1427         for (i = 0; i < smap_count(smap); i++) {
1428             const struct smap_node *node = sorted[i];
1429             if (!strncmp(node->key, prefix, prefix_len)) {
1430                 ds_put_format(output, "%s=%s\n", node->key + prefix_len,
1431                               node->value);
1432             }
1433         }
1434         free(sorted);
1435     }
1436 }
1437
1438 static void
1439 pre_cmd_br_get_external_id(struct ctl_context *ctx)
1440 {
1441     pre_cmd_br_set_external_id(ctx);
1442 }
1443
1444 static void
1445 cmd_br_get_external_id(struct ctl_context *ctx)
1446 {
1447     struct vsctl_context *vsctl_ctx = vsctl_context_cast(ctx);
1448     struct vsctl_bridge *bridge;
1449
1450     vsctl_context_populate_cache(ctx);
1451
1452     bridge = find_bridge(vsctl_ctx, ctx->argv[1], true);
1453     if (bridge->br_cfg) {
1454         ovsrec_bridge_verify_external_ids(bridge->br_cfg);
1455         get_external_id(&bridge->br_cfg->external_ids, "",
1456                         ctx->argc >= 3 ? ctx->argv[2] : NULL, &ctx->output);
1457     } else {
1458         struct vsctl_port *port = shash_find_data(&vsctl_ctx->ports,
1459                                                   ctx->argv[1]);
1460         ovsrec_port_verify_external_ids(port->port_cfg);
1461         get_external_id(&port->port_cfg->external_ids, "fake-bridge-",
1462                         ctx->argc >= 3 ? ctx->argv[2] : NULL, &ctx->output);
1463     }
1464 }
1465
1466 static void
1467 cmd_list_ports(struct ctl_context *ctx)
1468 {
1469     struct vsctl_context *vsctl_ctx = vsctl_context_cast(ctx);
1470     struct vsctl_bridge *br;
1471     struct vsctl_port *port;
1472     struct svec ports;
1473
1474     vsctl_context_populate_cache(ctx);
1475     br = find_bridge(vsctl_ctx, ctx->argv[1], true);
1476     ovsrec_bridge_verify_ports(br->br_cfg ? br->br_cfg : br->parent->br_cfg);
1477
1478     svec_init(&ports);
1479     LIST_FOR_EACH (port, ports_node, &br->ports) {
1480         if (strcmp(port->port_cfg->name, br->name)) {
1481             svec_add(&ports, port->port_cfg->name);
1482         }
1483     }
1484     output_sorted(&ports, &ctx->output);
1485     svec_destroy(&ports);
1486 }
1487
1488 static void
1489 add_port(struct ctl_context *ctx,
1490          const char *br_name, const char *port_name,
1491          bool may_exist, bool fake_iface,
1492          char *iface_names[], int n_ifaces,
1493          char *settings[], int n_settings)
1494 {
1495     struct vsctl_context *vsctl_ctx = vsctl_context_cast(ctx);
1496     struct vsctl_port *vsctl_port;
1497     struct vsctl_bridge *bridge;
1498     struct ovsrec_interface **ifaces;
1499     struct ovsrec_port *port;
1500     size_t i;
1501
1502     vsctl_context_populate_cache(ctx);
1503     if (may_exist) {
1504         struct vsctl_port *vsctl_port;
1505
1506         vsctl_port = find_port(vsctl_ctx, port_name, false);
1507         if (vsctl_port) {
1508             struct svec want_names, have_names;
1509
1510             svec_init(&want_names);
1511             for (i = 0; i < n_ifaces; i++) {
1512                 svec_add(&want_names, iface_names[i]);
1513             }
1514             svec_sort(&want_names);
1515
1516             svec_init(&have_names);
1517             for (i = 0; i < vsctl_port->port_cfg->n_interfaces; i++) {
1518                 svec_add(&have_names,
1519                          vsctl_port->port_cfg->interfaces[i]->name);
1520             }
1521             svec_sort(&have_names);
1522
1523             if (strcmp(vsctl_port->bridge->name, br_name)) {
1524                 char *command = vsctl_context_to_string(ctx);
1525                 ctl_fatal("\"%s\" but %s is actually attached to bridge %s",
1526                             command, port_name, vsctl_port->bridge->name);
1527             }
1528
1529             if (!svec_equal(&want_names, &have_names)) {
1530                 char *have_names_string = svec_join(&have_names, ", ", "");
1531                 char *command = vsctl_context_to_string(ctx);
1532
1533                 ctl_fatal("\"%s\" but %s actually has interface(s) %s",
1534                             command, port_name, have_names_string);
1535             }
1536
1537             svec_destroy(&want_names);
1538             svec_destroy(&have_names);
1539
1540             return;
1541         }
1542     }
1543     check_conflicts(vsctl_ctx, port_name,
1544                     xasprintf("cannot create a port named %s", port_name));
1545     for (i = 0; i < n_ifaces; i++) {
1546         check_conflicts(vsctl_ctx, iface_names[i],
1547                         xasprintf("cannot create an interface named %s",
1548                                   iface_names[i]));
1549     }
1550     bridge = find_bridge(vsctl_ctx, br_name, true);
1551
1552     ifaces = xmalloc(n_ifaces * sizeof *ifaces);
1553     for (i = 0; i < n_ifaces; i++) {
1554         ifaces[i] = ovsrec_interface_insert(ctx->txn);
1555         ovsrec_interface_set_name(ifaces[i], iface_names[i]);
1556         post_db_reload_expect_iface(ifaces[i]);
1557     }
1558
1559     port = ovsrec_port_insert(ctx->txn);
1560     ovsrec_port_set_name(port, port_name);
1561     ovsrec_port_set_interfaces(port, ifaces, n_ifaces);
1562     ovsrec_port_set_bond_fake_iface(port, fake_iface);
1563
1564     if (bridge->parent) {
1565         int64_t tag = bridge->vlan;
1566         ovsrec_port_set_tag(port, &tag, 1);
1567     }
1568
1569     for (i = 0; i < n_settings; i++) {
1570         ctl_set_column("Port", &port->header_, settings[i],
1571                        ctx->symtab);
1572     }
1573
1574     bridge_insert_port((bridge->parent ? bridge->parent->br_cfg
1575                         : bridge->br_cfg), port);
1576
1577     vsctl_port = add_port_to_cache(vsctl_ctx, bridge, port);
1578     for (i = 0; i < n_ifaces; i++) {
1579         add_iface_to_cache(vsctl_ctx, vsctl_port, ifaces[i]);
1580     }
1581     free(ifaces);
1582 }
1583
1584 static void
1585 cmd_add_port(struct ctl_context *ctx)
1586 {
1587     bool may_exist = shash_find(&ctx->options, "--may-exist") != NULL;
1588
1589     add_port(ctx, ctx->argv[1], ctx->argv[2], may_exist, false,
1590              &ctx->argv[2], 1, &ctx->argv[3], ctx->argc - 3);
1591 }
1592
1593 static void
1594 cmd_add_bond(struct ctl_context *ctx)
1595 {
1596     bool may_exist = shash_find(&ctx->options, "--may-exist") != NULL;
1597     bool fake_iface = shash_find(&ctx->options, "--fake-iface");
1598     int n_ifaces;
1599     int i;
1600
1601     n_ifaces = ctx->argc - 3;
1602     for (i = 3; i < ctx->argc; i++) {
1603         if (strchr(ctx->argv[i], '=')) {
1604             n_ifaces = i - 3;
1605             break;
1606         }
1607     }
1608     if (n_ifaces < 2) {
1609         ctl_fatal("add-bond requires at least 2 interfaces, but only "
1610                     "%d were specified", n_ifaces);
1611     }
1612
1613     add_port(ctx, ctx->argv[1], ctx->argv[2], may_exist, fake_iface,
1614              &ctx->argv[3], n_ifaces,
1615              &ctx->argv[n_ifaces + 3], ctx->argc - 3 - n_ifaces);
1616 }
1617
1618 static void
1619 cmd_del_port(struct ctl_context *ctx)
1620 {
1621     struct vsctl_context *vsctl_ctx = vsctl_context_cast(ctx);
1622     bool must_exist = !shash_find(&ctx->options, "--if-exists");
1623     bool with_iface = shash_find(&ctx->options, "--with-iface") != NULL;
1624     const char *target = ctx->argv[ctx->argc - 1];
1625     struct vsctl_port *port;
1626
1627     vsctl_context_populate_cache(ctx);
1628     if (find_bridge(vsctl_ctx, target, false)) {
1629         if (must_exist) {
1630             ctl_fatal("cannot delete port %s because it is the local port "
1631                         "for bridge %s (deleting this port requires deleting "
1632                         "the entire bridge)", target, target);
1633         }
1634         port = NULL;
1635     } else if (!with_iface) {
1636         port = find_port(vsctl_ctx, target, must_exist);
1637     } else {
1638         struct vsctl_iface *iface;
1639
1640         port = find_port(vsctl_ctx, target, false);
1641         if (!port) {
1642             iface = find_iface(vsctl_ctx, target, false);
1643             if (iface) {
1644                 port = iface->port;
1645             }
1646         }
1647         if (must_exist && !port) {
1648             ctl_fatal("no port or interface named %s", target);
1649         }
1650     }
1651
1652     if (port) {
1653         if (ctx->argc == 3) {
1654             struct vsctl_bridge *bridge;
1655
1656             bridge = find_bridge(vsctl_ctx, ctx->argv[1], true);
1657             if (port->bridge != bridge) {
1658                 if (port->bridge->parent == bridge) {
1659                     ctl_fatal("bridge %s does not have a port %s (although "
1660                                 "its parent bridge %s does)",
1661                                 ctx->argv[1], ctx->argv[2],
1662                                 bridge->parent->name);
1663                 } else {
1664                     ctl_fatal("bridge %s does not have a port %s",
1665                                 ctx->argv[1], ctx->argv[2]);
1666                 }
1667             }
1668         }
1669
1670         del_port(vsctl_ctx, port);
1671     }
1672 }
1673
1674 static void
1675 cmd_port_to_br(struct ctl_context *ctx)
1676 {
1677     struct vsctl_context *vsctl_ctx = vsctl_context_cast(ctx);
1678     struct vsctl_port *port;
1679
1680     vsctl_context_populate_cache(ctx);
1681
1682     port = find_port(vsctl_ctx, ctx->argv[1], true);
1683     ds_put_format(&ctx->output, "%s\n", port->bridge->name);
1684 }
1685
1686 static void
1687 cmd_br_to_vlan(struct ctl_context *ctx)
1688 {
1689     struct vsctl_context *vsctl_ctx = vsctl_context_cast(ctx);
1690     struct vsctl_bridge *bridge;
1691
1692     vsctl_context_populate_cache(ctx);
1693
1694     bridge = find_bridge(vsctl_ctx, ctx->argv[1], true);
1695     ds_put_format(&ctx->output, "%d\n", bridge->vlan);
1696 }
1697
1698 static void
1699 cmd_br_to_parent(struct ctl_context *ctx)
1700 {
1701     struct vsctl_context *vsctl_ctx = vsctl_context_cast(ctx);
1702     struct vsctl_bridge *bridge;
1703
1704     vsctl_context_populate_cache(ctx);
1705
1706     bridge = find_bridge(vsctl_ctx, ctx->argv[1], true);
1707     if (bridge->parent) {
1708         bridge = bridge->parent;
1709     }
1710     ds_put_format(&ctx->output, "%s\n", bridge->name);
1711 }
1712
1713 static void
1714 cmd_list_ifaces(struct ctl_context *ctx)
1715 {
1716     struct vsctl_context *vsctl_ctx = vsctl_context_cast(ctx);
1717     struct vsctl_bridge *br;
1718     struct vsctl_port *port;
1719     struct svec ifaces;
1720
1721     vsctl_context_populate_cache(ctx);
1722
1723     br = find_bridge(vsctl_ctx, ctx->argv[1], true);
1724     verify_ports(vsctl_ctx);
1725
1726     svec_init(&ifaces);
1727     LIST_FOR_EACH (port, ports_node, &br->ports) {
1728         struct vsctl_iface *iface;
1729
1730         LIST_FOR_EACH (iface, ifaces_node, &port->ifaces) {
1731             if (strcmp(iface->iface_cfg->name, br->name)) {
1732                 svec_add(&ifaces, iface->iface_cfg->name);
1733             }
1734         }
1735     }
1736     output_sorted(&ifaces, &ctx->output);
1737     svec_destroy(&ifaces);
1738 }
1739
1740 static void
1741 cmd_iface_to_br(struct ctl_context *ctx)
1742 {
1743     struct vsctl_context *vsctl_ctx = vsctl_context_cast(ctx);
1744     struct vsctl_iface *iface;
1745
1746     vsctl_context_populate_cache(ctx);
1747
1748     iface = find_iface(vsctl_ctx, ctx->argv[1], true);
1749     ds_put_format(&ctx->output, "%s\n", iface->port->bridge->name);
1750 }
1751
1752 static void
1753 verify_controllers(struct ovsrec_bridge *bridge)
1754 {
1755     size_t i;
1756
1757     ovsrec_bridge_verify_controller(bridge);
1758     for (i = 0; i < bridge->n_controller; i++) {
1759         ovsrec_controller_verify_target(bridge->controller[i]);
1760     }
1761 }
1762
1763 static void
1764 pre_controller(struct ctl_context *ctx)
1765 {
1766     pre_get_info(ctx);
1767
1768     ovsdb_idl_add_column(ctx->idl, &ovsrec_controller_col_target);
1769 }
1770
1771 static void
1772 cmd_get_controller(struct ctl_context *ctx)
1773 {
1774     struct vsctl_context *vsctl_ctx = vsctl_context_cast(ctx);
1775     struct vsctl_bridge *br;
1776     struct svec targets;
1777     size_t i;
1778
1779     vsctl_context_populate_cache(ctx);
1780
1781     br = find_bridge(vsctl_ctx, ctx->argv[1], true);
1782     if (br->parent) {
1783         br = br->parent;
1784     }
1785     verify_controllers(br->br_cfg);
1786
1787     /* Print the targets in sorted order for reproducibility. */
1788     svec_init(&targets);
1789     for (i = 0; i < br->br_cfg->n_controller; i++) {
1790         svec_add(&targets, br->br_cfg->controller[i]->target);
1791     }
1792
1793     svec_sort(&targets);
1794     for (i = 0; i < targets.n; i++) {
1795         ds_put_format(&ctx->output, "%s\n", targets.names[i]);
1796     }
1797     svec_destroy(&targets);
1798 }
1799
1800 static void
1801 delete_controllers(struct ovsrec_controller **controllers,
1802                    size_t n_controllers)
1803 {
1804     size_t i;
1805
1806     for (i = 0; i < n_controllers; i++) {
1807         ovsrec_controller_delete(controllers[i]);
1808     }
1809 }
1810
1811 static void
1812 cmd_del_controller(struct ctl_context *ctx)
1813 {
1814     struct vsctl_context *vsctl_ctx = vsctl_context_cast(ctx);
1815     struct ovsrec_bridge *br;
1816
1817     vsctl_context_populate_cache(ctx);
1818
1819     br = find_real_bridge(vsctl_ctx, ctx->argv[1], true)->br_cfg;
1820     verify_controllers(br);
1821
1822     if (br->controller) {
1823         delete_controllers(br->controller, br->n_controller);
1824         ovsrec_bridge_set_controller(br, NULL, 0);
1825     }
1826 }
1827
1828 static struct ovsrec_controller **
1829 insert_controllers(struct ovsdb_idl_txn *txn, char *targets[], size_t n)
1830 {
1831     struct ovsrec_controller **controllers;
1832     size_t i;
1833
1834     controllers = xmalloc(n * sizeof *controllers);
1835     for (i = 0; i < n; i++) {
1836         if (vconn_verify_name(targets[i]) && pvconn_verify_name(targets[i])) {
1837             VLOG_WARN("target type \"%s\" is possibly erroneous", targets[i]);
1838         }
1839         controllers[i] = ovsrec_controller_insert(txn);
1840         ovsrec_controller_set_target(controllers[i], targets[i]);
1841     }
1842
1843     return controllers;
1844 }
1845
1846 static void
1847 cmd_set_controller(struct ctl_context *ctx)
1848 {
1849     struct vsctl_context *vsctl_ctx = vsctl_context_cast(ctx);
1850     struct ovsrec_controller **controllers;
1851     struct ovsrec_bridge *br;
1852     size_t n;
1853
1854     vsctl_context_populate_cache(ctx);
1855
1856     br = find_real_bridge(vsctl_ctx, ctx->argv[1], true)->br_cfg;
1857     verify_controllers(br);
1858
1859     delete_controllers(br->controller, br->n_controller);
1860
1861     n = ctx->argc - 2;
1862     controllers = insert_controllers(ctx->txn, &ctx->argv[2], n);
1863     ovsrec_bridge_set_controller(br, controllers, n);
1864     free(controllers);
1865 }
1866
1867 static void
1868 cmd_get_fail_mode(struct ctl_context *ctx)
1869 {
1870     struct vsctl_context *vsctl_ctx = vsctl_context_cast(ctx);
1871     struct vsctl_bridge *br;
1872     const char *fail_mode;
1873
1874     vsctl_context_populate_cache(ctx);
1875     br = find_bridge(vsctl_ctx, ctx->argv[1], true);
1876
1877     if (br->parent) {
1878         br = br->parent;
1879     }
1880     ovsrec_bridge_verify_fail_mode(br->br_cfg);
1881
1882     fail_mode = br->br_cfg->fail_mode;
1883     if (fail_mode && strlen(fail_mode)) {
1884         ds_put_format(&ctx->output, "%s\n", fail_mode);
1885     }
1886 }
1887
1888 static void
1889 cmd_del_fail_mode(struct ctl_context *ctx)
1890 {
1891     struct vsctl_context *vsctl_ctx = vsctl_context_cast(ctx);
1892     struct vsctl_bridge *br;
1893
1894     vsctl_context_populate_cache(ctx);
1895
1896     br = find_real_bridge(vsctl_ctx, ctx->argv[1], true);
1897
1898     ovsrec_bridge_set_fail_mode(br->br_cfg, NULL);
1899 }
1900
1901 static void
1902 cmd_set_fail_mode(struct ctl_context *ctx)
1903 {
1904     struct vsctl_context *vsctl_ctx = vsctl_context_cast(ctx);
1905     struct vsctl_bridge *br;
1906     const char *fail_mode = ctx->argv[2];
1907
1908     vsctl_context_populate_cache(ctx);
1909
1910     br = find_real_bridge(vsctl_ctx, ctx->argv[1], true);
1911
1912     if (strcmp(fail_mode, "standalone") && strcmp(fail_mode, "secure")) {
1913         ctl_fatal("fail-mode must be \"standalone\" or \"secure\"");
1914     }
1915
1916     ovsrec_bridge_set_fail_mode(br->br_cfg, fail_mode);
1917 }
1918
1919 static void
1920 verify_managers(const struct ovsrec_open_vswitch *ovs)
1921 {
1922     size_t i;
1923
1924     ovsrec_open_vswitch_verify_manager_options(ovs);
1925
1926     for (i = 0; i < ovs->n_manager_options; ++i) {
1927         const struct ovsrec_manager *mgr = ovs->manager_options[i];
1928
1929         ovsrec_manager_verify_target(mgr);
1930     }
1931 }
1932
1933 static void
1934 pre_manager(struct ctl_context *ctx)
1935 {
1936     ovsdb_idl_add_column(ctx->idl, &ovsrec_open_vswitch_col_manager_options);
1937     ovsdb_idl_add_column(ctx->idl, &ovsrec_manager_col_target);
1938 }
1939
1940 static void
1941 cmd_get_manager(struct ctl_context *ctx)
1942 {
1943     struct vsctl_context *vsctl_ctx = vsctl_context_cast(ctx);
1944     const struct ovsrec_open_vswitch *ovs = vsctl_ctx->ovs;
1945     struct svec targets;
1946     size_t i;
1947
1948     verify_managers(ovs);
1949
1950     /* Print the targets in sorted order for reproducibility. */
1951     svec_init(&targets);
1952
1953     for (i = 0; i < ovs->n_manager_options; i++) {
1954         svec_add(&targets, ovs->manager_options[i]->target);
1955     }
1956
1957     svec_sort_unique(&targets);
1958     for (i = 0; i < targets.n; i++) {
1959         ds_put_format(&ctx->output, "%s\n", targets.names[i]);
1960     }
1961     svec_destroy(&targets);
1962 }
1963
1964 static void
1965 delete_managers(const struct ovsrec_open_vswitch *ovs)
1966 {
1967     size_t i;
1968
1969     /* Delete Manager rows pointed to by 'manager_options' column. */
1970     for (i = 0; i < ovs->n_manager_options; i++) {
1971         ovsrec_manager_delete(ovs->manager_options[i]);
1972     }
1973
1974     /* Delete 'Manager' row refs in 'manager_options' column. */
1975     ovsrec_open_vswitch_set_manager_options(ovs, NULL, 0);
1976 }
1977
1978 static void
1979 cmd_del_manager(struct ctl_context *ctx)
1980 {
1981     struct vsctl_context *vsctl_ctx = vsctl_context_cast(ctx);
1982     const struct ovsrec_open_vswitch *ovs = vsctl_ctx->ovs;
1983
1984     verify_managers(ovs);
1985     delete_managers(ovs);
1986 }
1987
1988 static void
1989 insert_managers(struct vsctl_context *vsctl_ctx, char *targets[], size_t n)
1990 {
1991     struct ovsrec_manager **managers;
1992     size_t i;
1993
1994     /* Insert each manager in a new row in Manager table. */
1995     managers = xmalloc(n * sizeof *managers);
1996     for (i = 0; i < n; i++) {
1997         if (stream_verify_name(targets[i]) && pstream_verify_name(targets[i])) {
1998             VLOG_WARN("target type \"%s\" is possibly erroneous", targets[i]);
1999         }
2000         managers[i] = ovsrec_manager_insert(vsctl_ctx->base.txn);
2001         ovsrec_manager_set_target(managers[i], targets[i]);
2002     }
2003
2004     /* Store uuids of new Manager rows in 'manager_options' column. */
2005     ovsrec_open_vswitch_set_manager_options(vsctl_ctx->ovs, managers, n);
2006     free(managers);
2007 }
2008
2009 static void
2010 cmd_set_manager(struct ctl_context *ctx)
2011 {
2012     struct vsctl_context *vsctl_ctx = vsctl_context_cast(ctx);
2013     const size_t n = ctx->argc - 1;
2014
2015     verify_managers(vsctl_ctx->ovs);
2016     delete_managers(vsctl_ctx->ovs);
2017     insert_managers(vsctl_ctx, &ctx->argv[1], n);
2018 }
2019
2020 static void
2021 pre_cmd_get_ssl(struct ctl_context *ctx)
2022 {
2023     ovsdb_idl_add_column(ctx->idl, &ovsrec_open_vswitch_col_ssl);
2024
2025     ovsdb_idl_add_column(ctx->idl, &ovsrec_ssl_col_private_key);
2026     ovsdb_idl_add_column(ctx->idl, &ovsrec_ssl_col_certificate);
2027     ovsdb_idl_add_column(ctx->idl, &ovsrec_ssl_col_ca_cert);
2028     ovsdb_idl_add_column(ctx->idl, &ovsrec_ssl_col_bootstrap_ca_cert);
2029 }
2030
2031 static void
2032 cmd_get_ssl(struct ctl_context *ctx)
2033 {
2034     struct vsctl_context *vsctl_ctx = vsctl_context_cast(ctx);
2035     struct ovsrec_ssl *ssl = vsctl_ctx->ovs->ssl;
2036
2037     ovsrec_open_vswitch_verify_ssl(vsctl_ctx->ovs);
2038     if (ssl) {
2039         ovsrec_ssl_verify_private_key(ssl);
2040         ovsrec_ssl_verify_certificate(ssl);
2041         ovsrec_ssl_verify_ca_cert(ssl);
2042         ovsrec_ssl_verify_bootstrap_ca_cert(ssl);
2043
2044         ds_put_format(&ctx->output, "Private key: %s\n", ssl->private_key);
2045         ds_put_format(&ctx->output, "Certificate: %s\n", ssl->certificate);
2046         ds_put_format(&ctx->output, "CA Certificate: %s\n", ssl->ca_cert);
2047         ds_put_format(&ctx->output, "Bootstrap: %s\n",
2048                 ssl->bootstrap_ca_cert ? "true" : "false");
2049     }
2050 }
2051
2052 static void
2053 pre_cmd_del_ssl(struct ctl_context *ctx)
2054 {
2055     ovsdb_idl_add_column(ctx->idl, &ovsrec_open_vswitch_col_ssl);
2056 }
2057
2058 static void
2059 cmd_del_ssl(struct ctl_context *ctx)
2060 {
2061     struct vsctl_context *vsctl_ctx = vsctl_context_cast(ctx);
2062     struct ovsrec_ssl *ssl = vsctl_ctx->ovs->ssl;
2063
2064     if (ssl) {
2065         ovsrec_open_vswitch_verify_ssl(vsctl_ctx->ovs);
2066         ovsrec_ssl_delete(ssl);
2067         ovsrec_open_vswitch_set_ssl(vsctl_ctx->ovs, NULL);
2068     }
2069 }
2070
2071 static void
2072 pre_cmd_set_ssl(struct ctl_context *ctx)
2073 {
2074     ovsdb_idl_add_column(ctx->idl, &ovsrec_open_vswitch_col_ssl);
2075 }
2076
2077 static void
2078 cmd_set_ssl(struct ctl_context *ctx)
2079 {
2080     struct vsctl_context *vsctl_ctx = vsctl_context_cast(ctx);
2081     bool bootstrap = shash_find(&ctx->options, "--bootstrap");
2082     struct ovsrec_ssl *ssl = vsctl_ctx->ovs->ssl;
2083
2084     ovsrec_open_vswitch_verify_ssl(vsctl_ctx->ovs);
2085     if (ssl) {
2086         ovsrec_ssl_delete(ssl);
2087     }
2088     ssl = ovsrec_ssl_insert(ctx->txn);
2089
2090     ovsrec_ssl_set_private_key(ssl, ctx->argv[1]);
2091     ovsrec_ssl_set_certificate(ssl, ctx->argv[2]);
2092     ovsrec_ssl_set_ca_cert(ssl, ctx->argv[3]);
2093
2094     ovsrec_ssl_set_bootstrap_ca_cert(ssl, bootstrap);
2095
2096     ovsrec_open_vswitch_set_ssl(vsctl_ctx->ovs, ssl);
2097 }
2098
2099 static void
2100 autoattach_insert_mapping(struct ovsrec_autoattach *aa,
2101                           int64_t isid,
2102                           int64_t vlan)
2103 {
2104     int64_t *key_mappings, *value_mappings;
2105     size_t i;
2106
2107     key_mappings = xmalloc(sizeof *aa->key_mappings * (aa->n_mappings + 1));
2108     value_mappings = xmalloc(sizeof *aa->value_mappings * (aa->n_mappings + 1));
2109
2110     for (i = 0; i < aa->n_mappings; i++) {
2111         key_mappings[i] = aa->key_mappings[i];
2112         value_mappings[i] = aa->value_mappings[i];
2113     }
2114     key_mappings[aa->n_mappings] = isid;
2115     value_mappings[aa->n_mappings] = vlan;
2116
2117     ovsrec_autoattach_set_mappings(aa, key_mappings, value_mappings,
2118                                    aa->n_mappings + 1);
2119
2120     free(key_mappings);
2121     free(value_mappings);
2122 }
2123
2124 static void
2125 cmd_add_aa_mapping(struct ctl_context *ctx)
2126 {
2127     struct vsctl_context *vsctl_ctx = vsctl_context_cast(ctx);
2128     struct vsctl_bridge *br;
2129     int64_t isid, vlan;
2130     char *nptr = NULL;
2131
2132     isid = strtoull(ctx->argv[2], &nptr, 10);
2133     if (nptr == ctx->argv[2] || nptr == NULL) {
2134         ctl_fatal("Invalid argument %s", ctx->argv[2]);
2135         return;
2136     }
2137
2138     vlan = strtoull(ctx->argv[3], &nptr, 10);
2139     if (nptr == ctx->argv[3] || nptr == NULL) {
2140         ctl_fatal("Invalid argument %s", ctx->argv[3]);
2141         return;
2142     }
2143
2144     vsctl_context_populate_cache(ctx);
2145
2146     br = find_bridge(vsctl_ctx, ctx->argv[1], true);
2147     if (br->parent) {
2148         br = br->parent;
2149     }
2150
2151     if (br->br_cfg) {
2152         if (!br->br_cfg->auto_attach) {
2153             struct ovsrec_autoattach *aa = ovsrec_autoattach_insert(ctx->txn);
2154             ovsrec_bridge_set_auto_attach(br->br_cfg, aa);
2155         }
2156         autoattach_insert_mapping(br->br_cfg->auto_attach, isid, vlan);
2157     }
2158 }
2159
2160 static void
2161 del_aa_mapping(struct ovsrec_autoattach *aa,
2162                int64_t isid,
2163                int64_t vlan)
2164 {
2165     int64_t *key_mappings, *value_mappings;
2166     size_t i, n;
2167
2168     key_mappings = xmalloc(sizeof *aa->key_mappings * (aa->n_mappings));
2169     value_mappings = xmalloc(sizeof *value_mappings * (aa->n_mappings));
2170
2171     for (i = n = 0; i < aa->n_mappings; i++) {
2172         if (aa->key_mappings[i] != isid && aa->value_mappings[i] != vlan) {
2173             key_mappings[n] = aa->key_mappings[i];
2174             value_mappings[n++] = aa->value_mappings[i];
2175         }
2176     }
2177
2178     ovsrec_autoattach_set_mappings(aa, key_mappings, value_mappings, n);
2179
2180     free(key_mappings);
2181     free(value_mappings);
2182 }
2183
2184 static void
2185 cmd_del_aa_mapping(struct ctl_context *ctx)
2186 {
2187     struct vsctl_context *vsctl_ctx = vsctl_context_cast(ctx);
2188     struct vsctl_bridge *br;
2189     int64_t isid, vlan;
2190     char *nptr = NULL;
2191
2192     isid = strtoull(ctx->argv[2], &nptr, 10);
2193     if (nptr == ctx->argv[2] || nptr == NULL) {
2194         ctl_fatal("Invalid argument %s", ctx->argv[2]);
2195         return;
2196     }
2197
2198     vlan = strtoull(ctx->argv[3], &nptr, 10);
2199     if (nptr == ctx->argv[3] || nptr == NULL) {
2200         ctl_fatal("Invalid argument %s", ctx->argv[3]);
2201         return;
2202     }
2203
2204     vsctl_context_populate_cache(ctx);
2205
2206     br = find_bridge(vsctl_ctx, ctx->argv[1], true);
2207     if (br->parent) {
2208         br = br->parent;
2209     }
2210
2211     if (br->br_cfg && br->br_cfg->auto_attach &&
2212         br->br_cfg->auto_attach->key_mappings &&
2213         br->br_cfg->auto_attach->value_mappings) {
2214         size_t i;
2215
2216         for (i = 0; i < br->br_cfg->auto_attach->n_mappings; i++) {
2217             if (br->br_cfg->auto_attach->key_mappings[i] == isid &&
2218                 br->br_cfg->auto_attach->value_mappings[i] == vlan) {
2219                 del_aa_mapping(br->br_cfg->auto_attach, isid, vlan);
2220                 break;
2221             }
2222         }
2223     }
2224 }
2225
2226 static void
2227 pre_aa_mapping(struct ctl_context *ctx)
2228 {
2229     pre_get_info(ctx);
2230
2231     ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_auto_attach);
2232     ovsdb_idl_add_column(ctx->idl, &ovsrec_autoattach_col_mappings);
2233 }
2234
2235 static void
2236 verify_auto_attach(struct ovsrec_bridge *bridge)
2237 {
2238     if (bridge) {
2239         ovsrec_bridge_verify_auto_attach(bridge);
2240
2241         if (bridge->auto_attach) {
2242             ovsrec_autoattach_verify_mappings(bridge->auto_attach);
2243         }
2244     }
2245 }
2246
2247 static void
2248 cmd_get_aa_mapping(struct ctl_context *ctx)
2249 {
2250     struct vsctl_context *vsctl_ctx = vsctl_context_cast(ctx);
2251     struct vsctl_bridge *br;
2252
2253     vsctl_context_populate_cache(ctx);
2254
2255     br = find_bridge(vsctl_ctx, ctx->argv[1], true);
2256     if (br->parent) {
2257         br = br->parent;
2258     }
2259
2260     verify_auto_attach(br->br_cfg);
2261
2262     if (br->br_cfg && br->br_cfg->auto_attach &&
2263         br->br_cfg->auto_attach->key_mappings &&
2264         br->br_cfg->auto_attach->value_mappings) {
2265         size_t i;
2266
2267         for (i = 0; i < br->br_cfg->auto_attach->n_mappings; i++) {
2268             ds_put_format(&ctx->output, "%"PRId64" %"PRId64"\n",
2269                           br->br_cfg->auto_attach->key_mappings[i],
2270                           br->br_cfg->auto_attach->value_mappings[i]);
2271         }
2272     }
2273 }
2274
2275 \f
2276 static const struct ctl_table_class tables[] = {
2277     {&ovsrec_table_bridge,
2278      {{&ovsrec_table_bridge, &ovsrec_bridge_col_name, NULL},
2279       {&ovsrec_table_flow_sample_collector_set, NULL,
2280        &ovsrec_flow_sample_collector_set_col_bridge}}},
2281
2282     {&ovsrec_table_controller,
2283      {{&ovsrec_table_bridge,
2284        &ovsrec_bridge_col_name,
2285        &ovsrec_bridge_col_controller}}},
2286
2287     {&ovsrec_table_interface,
2288      {{&ovsrec_table_interface, &ovsrec_interface_col_name, NULL},
2289       {NULL, NULL, NULL}}},
2290
2291     {&ovsrec_table_mirror,
2292      {{&ovsrec_table_mirror, &ovsrec_mirror_col_name, NULL},
2293       {NULL, NULL, NULL}}},
2294
2295     {&ovsrec_table_manager,
2296      {{&ovsrec_table_manager, &ovsrec_manager_col_target, NULL},
2297       {NULL, NULL, NULL}}},
2298
2299     {&ovsrec_table_netflow,
2300      {{&ovsrec_table_bridge,
2301        &ovsrec_bridge_col_name,
2302        &ovsrec_bridge_col_netflow},
2303       {NULL, NULL, NULL}}},
2304
2305     {&ovsrec_table_open_vswitch,
2306      {{&ovsrec_table_open_vswitch, NULL, NULL},
2307       {NULL, NULL, NULL}}},
2308
2309     {&ovsrec_table_port,
2310      {{&ovsrec_table_port, &ovsrec_port_col_name, NULL},
2311       {NULL, NULL, NULL}}},
2312
2313     {&ovsrec_table_qos,
2314      {{&ovsrec_table_port, &ovsrec_port_col_name, &ovsrec_port_col_qos},
2315       {NULL, NULL, NULL}}},
2316
2317     {&ovsrec_table_queue,
2318      {{NULL, NULL, NULL},
2319       {NULL, NULL, NULL}}},
2320
2321     {&ovsrec_table_ssl,
2322      {{&ovsrec_table_open_vswitch, NULL, &ovsrec_open_vswitch_col_ssl}}},
2323
2324     {&ovsrec_table_sflow,
2325      {{&ovsrec_table_bridge,
2326        &ovsrec_bridge_col_name,
2327        &ovsrec_bridge_col_sflow},
2328       {NULL, NULL, NULL}}},
2329
2330     {&ovsrec_table_flow_table,
2331      {{&ovsrec_table_flow_table, &ovsrec_flow_table_col_name, NULL},
2332       {NULL, NULL, NULL}}},
2333
2334     {&ovsrec_table_ipfix,
2335      {{&ovsrec_table_bridge,
2336        &ovsrec_bridge_col_name,
2337        &ovsrec_bridge_col_ipfix},
2338       {&ovsrec_table_flow_sample_collector_set, NULL,
2339        &ovsrec_flow_sample_collector_set_col_ipfix}}},
2340
2341     {&ovsrec_table_autoattach,
2342      {{&ovsrec_table_bridge,
2343        &ovsrec_bridge_col_name,
2344        &ovsrec_bridge_col_auto_attach},
2345       {NULL, NULL, NULL}}},
2346
2347     {&ovsrec_table_flow_sample_collector_set,
2348      {{NULL, NULL, NULL},
2349       {NULL, NULL, NULL}}},
2350
2351     {NULL, {{NULL, NULL, NULL}, {NULL, NULL, NULL}}}
2352 };
2353
2354 static void
2355 post_db_reload_check_init(void)
2356 {
2357     n_neoteric_ifaces = 0;
2358 }
2359
2360 static void
2361 post_db_reload_expect_iface(const struct ovsrec_interface *iface)
2362 {
2363     if (n_neoteric_ifaces >= allocated_neoteric_ifaces) {
2364         neoteric_ifaces = x2nrealloc(neoteric_ifaces,
2365                                      &allocated_neoteric_ifaces,
2366                                      sizeof *neoteric_ifaces);
2367     }
2368     neoteric_ifaces[n_neoteric_ifaces++] = iface->header_.uuid;
2369 }
2370
2371 static void
2372 post_db_reload_do_checks(const struct vsctl_context *vsctl_ctx)
2373 {
2374     struct ds dead_ifaces = DS_EMPTY_INITIALIZER;
2375     size_t i;
2376
2377     for (i = 0; i < n_neoteric_ifaces; i++) {
2378         const struct uuid *uuid;
2379
2380         uuid = ovsdb_idl_txn_get_insert_uuid(vsctl_ctx->base.txn,
2381                                              &neoteric_ifaces[i]);
2382         if (uuid) {
2383             const struct ovsrec_interface *iface;
2384
2385             iface = ovsrec_interface_get_for_uuid(vsctl_ctx->base.idl, uuid);
2386             if (iface && (!iface->ofport || *iface->ofport == -1)) {
2387                 ds_put_format(&dead_ifaces, "'%s', ", iface->name);
2388             }
2389         }
2390     }
2391
2392     if (dead_ifaces.length) {
2393         dead_ifaces.length -= 2; /* Strip off trailing comma and space. */
2394         ovs_error(0, "Error detected while setting up %s.  See ovs-vswitchd "
2395                   "log for details.", ds_cstr(&dead_ifaces));
2396     }
2397
2398     ds_destroy(&dead_ifaces);
2399 }
2400
2401 \f
2402 static void
2403 vsctl_context_init_command(struct vsctl_context *vsctl_ctx,
2404                            struct ctl_command *command)
2405 {
2406     ctl_context_init_command(&vsctl_ctx->base, command);
2407     vsctl_ctx->verified_ports = false;
2408 }
2409
2410 static void
2411 vsctl_context_init(struct vsctl_context *vsctl_ctx,
2412                    struct ctl_command *command, struct ovsdb_idl *idl,
2413                    struct ovsdb_idl_txn *txn,
2414                    const struct ovsrec_open_vswitch *ovs,
2415                    struct ovsdb_symbol_table *symtab)
2416 {
2417     ctl_context_init(&vsctl_ctx->base, command, idl, txn, symtab,
2418                      vsctl_context_invalidate_cache);
2419     if (command) {
2420         vsctl_ctx->verified_ports = false;
2421     }
2422     vsctl_ctx->ovs = ovs;
2423     vsctl_ctx->cache_valid = false;
2424 }
2425
2426 static void
2427 vsctl_context_done_command(struct vsctl_context *vsctl_ctx,
2428                            struct ctl_command *command)
2429 {
2430     ctl_context_done_command(&vsctl_ctx->base, command);
2431 }
2432
2433 static void
2434 vsctl_context_done(struct vsctl_context *vsctl_ctx,
2435                    struct ctl_command *command)
2436 {
2437     ctl_context_done(&vsctl_ctx->base, command);
2438 }
2439
2440 static void
2441 run_prerequisites(struct ctl_command *commands, size_t n_commands,
2442                   struct ovsdb_idl *idl)
2443 {
2444     struct ctl_command *c;
2445
2446     ovsdb_idl_add_table(idl, &ovsrec_table_open_vswitch);
2447     if (wait_for_reload) {
2448         ovsdb_idl_add_column(idl, &ovsrec_open_vswitch_col_cur_cfg);
2449     }
2450     for (c = commands; c < &commands[n_commands]; c++) {
2451         if (c->syntax->prerequisites) {
2452             struct vsctl_context vsctl_ctx;
2453
2454             ds_init(&c->output);
2455             c->table = NULL;
2456
2457             vsctl_context_init(&vsctl_ctx, c, idl, NULL, NULL, NULL);
2458             (c->syntax->prerequisites)(&vsctl_ctx.base);
2459             vsctl_context_done(&vsctl_ctx, c);
2460
2461             ovs_assert(!c->output.string);
2462             ovs_assert(!c->table);
2463         }
2464     }
2465 }
2466
2467 static void
2468 do_vsctl(const char *args, struct ctl_command *commands, size_t n_commands,
2469          struct ovsdb_idl *idl)
2470 {
2471     struct ovsdb_idl_txn *txn;
2472     const struct ovsrec_open_vswitch *ovs;
2473     enum ovsdb_idl_txn_status status;
2474     struct ovsdb_symbol_table *symtab;
2475     struct vsctl_context vsctl_ctx;
2476     struct ctl_command *c;
2477     struct shash_node *node;
2478     int64_t next_cfg = 0;
2479     char *error = NULL;
2480
2481     txn = the_idl_txn = ovsdb_idl_txn_create(idl);
2482     if (dry_run) {
2483         ovsdb_idl_txn_set_dry_run(txn);
2484     }
2485
2486     ovsdb_idl_txn_add_comment(txn, "ovs-vsctl: %s", args);
2487
2488     ovs = ovsrec_open_vswitch_first(idl);
2489     if (!ovs) {
2490         /* XXX add verification that table is empty */
2491         ovs = ovsrec_open_vswitch_insert(txn);
2492     }
2493
2494     if (wait_for_reload) {
2495         ovsdb_idl_txn_increment(txn, &ovs->header_,
2496                                 &ovsrec_open_vswitch_col_next_cfg);
2497     }
2498
2499     post_db_reload_check_init();
2500     symtab = ovsdb_symbol_table_create();
2501     for (c = commands; c < &commands[n_commands]; c++) {
2502         ds_init(&c->output);
2503         c->table = NULL;
2504     }
2505     vsctl_context_init(&vsctl_ctx, NULL, idl, txn, ovs, symtab);
2506     for (c = commands; c < &commands[n_commands]; c++) {
2507         vsctl_context_init_command(&vsctl_ctx, c);
2508         if (c->syntax->run) {
2509             (c->syntax->run)(&vsctl_ctx.base);
2510         }
2511         vsctl_context_done_command(&vsctl_ctx, c);
2512
2513         if (vsctl_ctx.base.try_again) {
2514             vsctl_context_done(&vsctl_ctx, NULL);
2515             goto try_again;
2516         }
2517     }
2518     vsctl_context_done(&vsctl_ctx, NULL);
2519
2520     SHASH_FOR_EACH (node, &symtab->sh) {
2521         struct ovsdb_symbol *symbol = node->data;
2522         if (!symbol->created) {
2523             ctl_fatal("row id \"%s\" is referenced but never created (e.g. "
2524                         "with \"-- --id=%s create ...\")",
2525                         node->name, node->name);
2526         }
2527         if (!symbol->strong_ref) {
2528             if (!symbol->weak_ref) {
2529                 VLOG_WARN("row id \"%s\" was created but no reference to it "
2530                           "was inserted, so it will not actually appear in "
2531                           "the database", node->name);
2532             } else {
2533                 VLOG_WARN("row id \"%s\" was created but only a weak "
2534                           "reference to it was inserted, so it will not "
2535                           "actually appear in the database", node->name);
2536             }
2537         }
2538     }
2539
2540     status = ovsdb_idl_txn_commit_block(txn);
2541     if (wait_for_reload && status == TXN_SUCCESS) {
2542         next_cfg = ovsdb_idl_txn_get_increment_new_value(txn);
2543     }
2544     if (status == TXN_UNCHANGED || status == TXN_SUCCESS) {
2545         for (c = commands; c < &commands[n_commands]; c++) {
2546             if (c->syntax->postprocess) {
2547                 vsctl_context_init(&vsctl_ctx, c, idl, txn, ovs, symtab);
2548                 (c->syntax->postprocess)(&vsctl_ctx.base);
2549                 vsctl_context_done(&vsctl_ctx, c);
2550             }
2551         }
2552     }
2553     error = xstrdup(ovsdb_idl_txn_get_error(txn));
2554
2555     switch (status) {
2556     case TXN_UNCOMMITTED:
2557     case TXN_INCOMPLETE:
2558         OVS_NOT_REACHED();
2559
2560     case TXN_ABORTED:
2561         /* Should not happen--we never call ovsdb_idl_txn_abort(). */
2562         ctl_fatal("transaction aborted");
2563
2564     case TXN_UNCHANGED:
2565     case TXN_SUCCESS:
2566         break;
2567
2568     case TXN_TRY_AGAIN:
2569         goto try_again;
2570
2571     case TXN_ERROR:
2572         ctl_fatal("transaction error: %s", error);
2573
2574     case TXN_NOT_LOCKED:
2575         /* Should not happen--we never call ovsdb_idl_set_lock(). */
2576         ctl_fatal("database not locked");
2577
2578     default:
2579         OVS_NOT_REACHED();
2580     }
2581     free(error);
2582
2583     ovsdb_symbol_table_destroy(symtab);
2584
2585     for (c = commands; c < &commands[n_commands]; c++) {
2586         struct ds *ds = &c->output;
2587
2588         if (c->table) {
2589             table_print(c->table, &table_style);
2590         } else if (oneline) {
2591             size_t j;
2592
2593             ds_chomp(ds, '\n');
2594             for (j = 0; j < ds->length; j++) {
2595                 int ch = ds->string[j];
2596                 switch (ch) {
2597                 case '\n':
2598                     fputs("\\n", stdout);
2599                     break;
2600
2601                 case '\\':
2602                     fputs("\\\\", stdout);
2603                     break;
2604
2605                 default:
2606                     putchar(ch);
2607                 }
2608             }
2609             putchar('\n');
2610         } else {
2611             fputs(ds_cstr(ds), stdout);
2612         }
2613         ds_destroy(&c->output);
2614         table_destroy(c->table);
2615         free(c->table);
2616
2617         shash_destroy_free_data(&c->options);
2618     }
2619     free(commands);
2620
2621     if (wait_for_reload && status != TXN_UNCHANGED) {
2622         /* Even, if --retry flag was not specified, ovs-vsctl still
2623          * has to retry to establish OVSDB connection, if wait_for_reload
2624          * was set.  Otherwise, ovs-vsctl would end up waiting forever
2625          * until cur_cfg would be updated. */
2626         ovsdb_idl_enable_reconnect(idl);
2627         for (;;) {
2628             ovsdb_idl_run(idl);
2629             OVSREC_OPEN_VSWITCH_FOR_EACH (ovs, idl) {
2630                 if (ovs->cur_cfg >= next_cfg) {
2631                     post_db_reload_do_checks(&vsctl_ctx);
2632                     goto done;
2633                 }
2634             }
2635             ovsdb_idl_wait(idl);
2636             poll_block();
2637         }
2638     done: ;
2639     }
2640     ovsdb_idl_txn_destroy(txn);
2641     ovsdb_idl_destroy(idl);
2642
2643     exit(EXIT_SUCCESS);
2644
2645 try_again:
2646     /* Our transaction needs to be rerun, or a prerequisite was not met.  Free
2647      * resources and return so that the caller can try again. */
2648     if (txn) {
2649         ovsdb_idl_txn_abort(txn);
2650         ovsdb_idl_txn_destroy(txn);
2651         the_idl_txn = NULL;
2652     }
2653     ovsdb_symbol_table_destroy(symtab);
2654     for (c = commands; c < &commands[n_commands]; c++) {
2655         ds_destroy(&c->output);
2656         table_destroy(c->table);
2657         free(c->table);
2658     }
2659     free(error);
2660 }
2661
2662 /* Frees the current transaction and the underlying IDL and then calls
2663  * exit(status).
2664  *
2665  * Freeing the transaction and the IDL is not strictly necessary, but it makes
2666  * for a clean memory leak report from valgrind in the normal case.  That makes
2667  * it easier to notice real memory leaks. */
2668 static void
2669 vsctl_exit(int status)
2670 {
2671     if (the_idl_txn) {
2672         ovsdb_idl_txn_abort(the_idl_txn);
2673         ovsdb_idl_txn_destroy(the_idl_txn);
2674     }
2675     ovsdb_idl_destroy(the_idl);
2676     exit(status);
2677 }
2678
2679 /*
2680  * Developers who add new commands to the 'struct ctl_command_syntax' must
2681  * define the 'arguments' member of the struct.  The following keywords are
2682  * available for composing the argument format:
2683  *
2684  *    TABLE     RECORD       BRIDGE       PARENT         PORT
2685  *    KEY       VALUE        ARG          KEY=VALUE      ?KEY=VALUE
2686  *    IFACE     SYSIFACE     COLUMN       COLUMN?:KEY    COLUMN?:KEY=VALUE
2687  *    MODE      CA-CERT      CERTIFICATE  PRIVATE-KEY
2688  *    TARGET    NEW-* (e.g. NEW-PORT)
2689  *
2690  * For argument types not listed above, just uses 'ARG' as place holder.
2691  *
2692  * Encloses the keyword with '[]' if it is optional.  Appends '...' to
2693  * keyword or enclosed keyword to indicate that the argument can be specified
2694  * multiple times.
2695  *
2696  * */
2697 static const struct ctl_command_syntax vsctl_commands[] = {
2698     /* Open vSwitch commands. */
2699     {"init", 0, 0, "", NULL, cmd_init, NULL, "", RW},
2700
2701     /* Bridge commands. */
2702     {"add-br", 1, 3, "NEW-BRIDGE [PARENT] [NEW-VLAN]", pre_get_info,
2703      cmd_add_br, NULL, "--may-exist", RW},
2704     {"del-br", 1, 1, "BRIDGE", pre_get_info, cmd_del_br,
2705      NULL, "--if-exists", RW},
2706     {"list-br", 0, 0, "", pre_get_info, cmd_list_br, NULL, "--real,--fake",
2707      RO},
2708     {"br-exists", 1, 1, "BRIDGE", pre_get_info, cmd_br_exists, NULL, "", RO},
2709     {"br-to-vlan", 1, 1, "BRIDGE", pre_get_info, cmd_br_to_vlan, NULL, "",
2710      RO},
2711     {"br-to-parent", 1, 1, "BRIDGE", pre_get_info, cmd_br_to_parent, NULL,
2712      "", RO},
2713     {"br-set-external-id", 2, 3, "BRIDGE KEY [VALUE]",
2714      pre_cmd_br_set_external_id, cmd_br_set_external_id, NULL, "", RW},
2715     {"br-get-external-id", 1, 2, "BRIDGE [KEY]", pre_cmd_br_get_external_id,
2716      cmd_br_get_external_id, NULL, "", RO},
2717
2718     /* Port commands. */
2719     {"list-ports", 1, 1, "BRIDGE", pre_get_info, cmd_list_ports, NULL, "",
2720      RO},
2721     {"add-port", 2, INT_MAX, "BRIDGE NEW-PORT [COLUMN[:KEY]=VALUE]...",
2722      pre_get_info, cmd_add_port, NULL, "--may-exist", RW},
2723     {"add-bond", 4, INT_MAX,
2724      "BRIDGE NEW-BOND-PORT SYSIFACE... [COLUMN[:KEY]=VALUE]...", pre_get_info,
2725      cmd_add_bond, NULL, "--may-exist,--fake-iface", RW},
2726     {"del-port", 1, 2, "[BRIDGE] PORT|IFACE", pre_get_info, cmd_del_port, NULL,
2727      "--if-exists,--with-iface", RW},
2728     {"port-to-br", 1, 1, "PORT", pre_get_info, cmd_port_to_br, NULL, "", RO},
2729
2730     /* Interface commands. */
2731     {"list-ifaces", 1, 1, "BRIDGE", pre_get_info, cmd_list_ifaces, NULL, "",
2732      RO},
2733     {"iface-to-br", 1, 1, "IFACE", pre_get_info, cmd_iface_to_br, NULL, "",
2734      RO},
2735
2736     /* Controller commands. */
2737     {"get-controller", 1, 1, "BRIDGE", pre_controller, cmd_get_controller,
2738      NULL, "", RO},
2739     {"del-controller", 1, 1, "BRIDGE", pre_controller, cmd_del_controller,
2740      NULL, "", RW},
2741     {"set-controller", 1, INT_MAX, "BRIDGE TARGET...", pre_controller,
2742      cmd_set_controller, NULL, "", RW},
2743     {"get-fail-mode", 1, 1, "BRIDGE", pre_get_info, cmd_get_fail_mode, NULL,
2744      "", RO},
2745     {"del-fail-mode", 1, 1, "BRIDGE", pre_get_info, cmd_del_fail_mode, NULL,
2746      "", RW},
2747     {"set-fail-mode", 2, 2, "BRIDGE MODE", pre_get_info, cmd_set_fail_mode,
2748      NULL, "", RW},
2749
2750     /* Manager commands. */
2751     {"get-manager", 0, 0, "", pre_manager, cmd_get_manager, NULL, "", RO},
2752     {"del-manager", 0, 0, "", pre_manager, cmd_del_manager, NULL, "", RW},
2753     {"set-manager", 1, INT_MAX, "TARGET...", pre_manager, cmd_set_manager,
2754      NULL, "", RW},
2755
2756     /* SSL commands. */
2757     {"get-ssl", 0, 0, "", pre_cmd_get_ssl, cmd_get_ssl, NULL, "", RO},
2758     {"del-ssl", 0, 0, "", pre_cmd_del_ssl, cmd_del_ssl, NULL, "", RW},
2759     {"set-ssl", 3, 3, "PRIVATE-KEY CERTIFICATE CA-CERT", pre_cmd_set_ssl,
2760      cmd_set_ssl, NULL, "--bootstrap", RW},
2761
2762     /* Auto Attach commands. */
2763     {"add-aa-mapping", 3, 3, "BRIDGE ARG ARG", pre_aa_mapping, cmd_add_aa_mapping,
2764      NULL, "", RW},
2765     {"del-aa-mapping", 3, 3, "BRIDGE ARG ARG", pre_aa_mapping, cmd_del_aa_mapping,
2766      NULL, "", RW},
2767     {"get-aa-mapping", 1, 1, "BRIDGE", pre_aa_mapping, cmd_get_aa_mapping,
2768      NULL, "", RO},
2769
2770     /* Switch commands. */
2771     {"emer-reset", 0, 0, "", pre_cmd_emer_reset, cmd_emer_reset, NULL, "", RW},
2772
2773     {NULL, 0, 0, NULL, NULL, NULL, NULL, NULL, RO},
2774 };
2775
2776 /* Registers vsctl and common db commands. */
2777 static void
2778 vsctl_cmd_init(void)
2779 {
2780     ctl_init(tables, cmd_show_tables, vsctl_exit);
2781     ctl_register_commands(vsctl_commands);
2782 }