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