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