2 * Copyright (c) 2009, 2010, 2011, 2012 Nicira, Inc.
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
31 #include "command-line.h"
34 #include "dynamic-string.h"
37 #include "ovsdb-data.h"
38 #include "ovsdb-idl.h"
39 #include "poll-loop.h"
42 #include "stream-ssl.h"
46 #include "lib/vswitch-idl.h"
53 VLOG_DEFINE_THIS_MODULE(vsctl);
55 /* vsctl_fatal() also logs the error, so it is preferred in this file. */
56 #define ovs_fatal please_use_vsctl_fatal_instead_of_ovs_fatal
60 /* A command supported by ovs-vsctl. */
61 struct vsctl_command_syntax {
62 const char *name; /* e.g. "add-br" */
63 int min_args; /* Min number of arguments following name. */
64 int max_args; /* Max number of arguments following name. */
66 /* If nonnull, calls ovsdb_idl_add_column() or ovsdb_idl_add_table() for
67 * each column or table in ctx->idl that it uses. */
68 void (*prerequisites)(struct vsctl_context *ctx);
70 /* Does the actual work of the command and puts the command's output, if
71 * any, in ctx->output or ctx->table.
73 * Alternatively, if some prerequisite of the command is not met and the
74 * caller should wait for something to change and then retry, it may set
75 * ctx->try_again to true. (Only the "wait-until" command currently does
77 void (*run)(struct vsctl_context *ctx);
79 /* If nonnull, called after the transaction has been successfully
80 * committed. ctx->output is the output from the "run" function, which
81 * this function may modify and otherwise postprocess as needed. (Only the
82 * "create" command currently does any postprocessing.) */
83 void (*postprocess)(struct vsctl_context *ctx);
85 /* A comma-separated list of supported options, e.g. "--a,--b", or the
86 * empty string if the command does not support any options. */
88 enum { RO, RW } mode; /* Does this command modify the database? */
91 struct vsctl_command {
92 /* Data that remains constant after initialization. */
93 const struct vsctl_command_syntax *syntax;
98 /* Data modified by commands. */
103 /* --db: The database server to contact. */
104 static const char *db;
106 /* --oneline: Write each command's output as a single line? */
109 /* --dry-run: Do not commit any changes. */
112 /* --no-wait: Wait for ovs-vswitchd to reload its configuration? */
113 static bool wait_for_reload = true;
115 /* --timeout: Time to wait for a connection to 'db'. */
118 /* Format for table output. */
119 static struct table_style table_style = TABLE_STYLE_DEFAULT;
121 /* All supported commands. */
122 static const struct vsctl_command_syntax all_commands[];
124 /* The IDL we're using and the current transaction, if any.
125 * This is for use by vsctl_exit() only, to allow it to clean up.
126 * Other code should use its context arguments. */
127 static struct ovsdb_idl *the_idl;
128 static struct ovsdb_idl_txn *the_idl_txn;
130 static void vsctl_exit(int status) NO_RETURN;
131 static void vsctl_fatal(const char *, ...) PRINTF_FORMAT(1, 2) NO_RETURN;
132 static char *default_db(void);
133 static void usage(void) NO_RETURN;
134 static void parse_options(int argc, char *argv[]);
135 static bool might_write_to_db(char **argv);
137 static struct vsctl_command *parse_commands(int argc, char *argv[],
138 size_t *n_commandsp);
139 static void parse_command(int argc, char *argv[], struct vsctl_command *);
140 static const struct vsctl_command_syntax *find_command(const char *name);
141 static void run_prerequisites(struct vsctl_command[], size_t n_commands,
143 static void do_vsctl(const char *args, struct vsctl_command *, size_t n,
146 static const struct vsctl_table_class *get_table(const char *table_name);
147 static void set_column(const struct vsctl_table_class *,
148 const struct ovsdb_idl_row *, const char *arg,
149 struct ovsdb_symbol_table *);
151 static bool is_condition_satisfied(const struct vsctl_table_class *,
152 const struct ovsdb_idl_row *,
154 struct ovsdb_symbol_table *);
157 main(int argc, char *argv[])
159 extern struct vlog_module VLM_reconnect;
160 struct ovsdb_idl *idl;
161 struct vsctl_command *commands;
166 set_program_name(argv[0]);
167 signal(SIGPIPE, SIG_IGN);
168 vlog_set_levels(NULL, VLF_CONSOLE, VLL_WARN);
169 vlog_set_levels(&VLM_reconnect, VLF_ANY_FACILITY, VLL_WARN);
172 /* Log our arguments. This is often valuable for debugging systems. */
173 args = process_escape_args(argv);
174 VLOG(might_write_to_db(argv) ? VLL_INFO : VLL_DBG, "Called as %s", args);
176 /* Parse command line. */
177 parse_options(argc, argv);
178 commands = parse_commands(argc - optind, argv + optind, &n_commands);
184 /* Initialize IDL. */
185 idl = the_idl = ovsdb_idl_create(db, &ovsrec_idl_class, false);
186 run_prerequisites(commands, n_commands, idl);
188 /* Execute the commands.
190 * 'seqno' is the database sequence number for which we last tried to
191 * execute our transaction. There's no point in trying to commit more than
192 * once for any given sequence number, because if the transaction fails
193 * it's because the database changed and we need to obtain an up-to-date
194 * view of the database before we try the transaction again. */
195 seqno = ovsdb_idl_get_seqno(idl);
199 if (seqno != ovsdb_idl_get_seqno(idl)) {
200 seqno = ovsdb_idl_get_seqno(idl);
201 do_vsctl(args, commands, n_commands, idl);
204 if (seqno == ovsdb_idl_get_seqno(idl)) {
212 parse_options(int argc, char *argv[])
215 OPT_DB = UCHAR_MAX + 1,
224 static struct option long_options[] = {
225 {"db", required_argument, NULL, OPT_DB},
226 {"no-syslog", no_argument, NULL, OPT_NO_SYSLOG},
227 {"no-wait", no_argument, NULL, OPT_NO_WAIT},
228 {"dry-run", no_argument, NULL, OPT_DRY_RUN},
229 {"oneline", no_argument, NULL, OPT_ONELINE},
230 {"timeout", required_argument, NULL, 't'},
231 {"help", no_argument, NULL, 'h'},
232 {"version", no_argument, NULL, 'V'},
235 STREAM_SSL_LONG_OPTIONS,
236 {"peer-ca-cert", required_argument, NULL, OPT_PEER_CA_CERT},
239 char *tmp, *short_options;
241 tmp = long_options_to_short_options(long_options);
242 short_options = xasprintf("+%s", tmp);
245 table_style.format = TF_LIST;
250 c = getopt_long(argc, argv, short_options, long_options, NULL);
265 vlog_set_levels(&VLM_vsctl, VLF_SYSLOG, VLL_WARN);
269 wait_for_reload = false;
280 ovs_print_version(0, 0);
284 timeout = strtoul(optarg, NULL, 10);
286 vsctl_fatal("value %s on -t or --timeout is invalid",
292 TABLE_OPTION_HANDLERS(&table_style)
294 STREAM_SSL_OPTION_HANDLERS
296 case OPT_PEER_CA_CERT:
297 stream_ssl_set_peer_ca_cert_file(optarg);
314 static struct vsctl_command *
315 parse_commands(int argc, char *argv[], size_t *n_commandsp)
317 struct vsctl_command *commands;
318 size_t n_commands, allocated_commands;
322 n_commands = allocated_commands = 0;
324 for (start = i = 0; i <= argc; i++) {
325 if (i == argc || !strcmp(argv[i], "--")) {
327 if (n_commands >= allocated_commands) {
328 struct vsctl_command *c;
330 commands = x2nrealloc(commands, &allocated_commands,
332 for (c = commands; c < &commands[n_commands]; c++) {
333 shash_moved(&c->options);
336 parse_command(i - start, &argv[start],
337 &commands[n_commands++]);
343 vsctl_fatal("missing command name (use --help for help)");
345 *n_commandsp = n_commands;
350 parse_command(int argc, char *argv[], struct vsctl_command *command)
352 const struct vsctl_command_syntax *p;
353 struct shash_node *node;
357 shash_init(&command->options);
358 for (i = 0; i < argc; i++) {
359 const char *option = argv[i];
363 if (option[0] != '-') {
367 equals = strchr(option, '=');
369 key = xmemdup0(option, equals - option);
370 value = xstrdup(equals + 1);
372 key = xstrdup(option);
376 if (shash_find(&command->options, key)) {
377 vsctl_fatal("'%s' option specified multiple times", argv[i]);
379 shash_add_nocopy(&command->options, key, value);
382 vsctl_fatal("missing command name");
385 p = find_command(argv[i]);
387 vsctl_fatal("unknown command '%s'; use --help for help", argv[i]);
390 SHASH_FOR_EACH (node, &command->options) {
391 const char *s = strstr(p->options, node->name);
392 int end = s ? s[strlen(node->name)] : EOF;
394 if (end != '=' && end != ',' && end != ' ' && end != '\0') {
395 vsctl_fatal("'%s' command has no '%s' option",
396 argv[i], node->name);
398 if ((end == '=') != (node->data != NULL)) {
400 vsctl_fatal("missing argument to '%s' option on '%s' "
401 "command", node->name, argv[i]);
403 vsctl_fatal("'%s' option on '%s' does not accept an "
404 "argument", node->name, argv[i]);
409 n_arg = argc - i - 1;
410 if (n_arg < p->min_args) {
411 vsctl_fatal("'%s' command requires at least %d arguments",
412 p->name, p->min_args);
413 } else if (n_arg > p->max_args) {
416 for (j = i + 1; j < argc; j++) {
417 if (argv[j][0] == '-') {
418 vsctl_fatal("'%s' command takes at most %d arguments "
419 "(note that options must precede command "
420 "names and follow a \"--\" argument)",
421 p->name, p->max_args);
425 vsctl_fatal("'%s' command takes at most %d arguments",
426 p->name, p->max_args);
430 command->argc = n_arg + 1;
431 command->argv = &argv[i];
434 /* Returns the "struct vsctl_command_syntax" for a given command 'name', or a
435 * null pointer if there is none. */
436 static const struct vsctl_command_syntax *
437 find_command(const char *name)
439 static struct shash commands = SHASH_INITIALIZER(&commands);
441 if (shash_is_empty(&commands)) {
442 const struct vsctl_command_syntax *p;
444 for (p = all_commands; p->name; p++) {
445 shash_add_assert(&commands, p->name, p);
449 return shash_find_data(&commands, name);
453 vsctl_fatal(const char *format, ...)
458 va_start(args, format);
459 message = xvasprintf(format, args);
462 vlog_set_levels(&VLM_vsctl, VLF_CONSOLE, VLL_OFF);
463 VLOG_ERR("%s", message);
464 ovs_error(0, "%s", message);
465 vsctl_exit(EXIT_FAILURE);
468 /* Frees the current transaction and the underlying IDL and then calls
471 * Freeing the transaction and the IDL is not strictly necessary, but it makes
472 * for a clean memory leak report from valgrind in the normal case. That makes
473 * it easier to notice real memory leaks. */
475 vsctl_exit(int status)
478 ovsdb_idl_txn_abort(the_idl_txn);
479 ovsdb_idl_txn_destroy(the_idl_txn);
481 ovsdb_idl_destroy(the_idl);
489 %s: ovs-vswitchd management utility\n\
490 usage: %s [OPTIONS] COMMAND [ARG...]\n\
492 Open vSwitch commands:\n\
493 init initialize database, if not yet initialized\n\
494 show print overview of database contents\n\
495 emer-reset reset configuration to clean state\n\
498 add-br BRIDGE create a new bridge named BRIDGE\n\
499 add-br BRIDGE PARENT VLAN create new fake BRIDGE in PARENT on VLAN\n\
500 del-br BRIDGE delete BRIDGE and all of its ports\n\
501 list-br print the names of all the bridges\n\
502 br-exists BRIDGE exit 2 if BRIDGE does not exist\n\
503 br-to-vlan BRIDGE print the VLAN which BRIDGE is on\n\
504 br-to-parent BRIDGE print the parent of BRIDGE\n\
505 br-set-external-id BRIDGE KEY VALUE set KEY on BRIDGE to VALUE\n\
506 br-set-external-id BRIDGE KEY unset KEY on BRIDGE\n\
507 br-get-external-id BRIDGE KEY print value of KEY on BRIDGE\n\
508 br-get-external-id BRIDGE list key-value pairs on BRIDGE\n\
510 Port commands (a bond is considered to be a single port):\n\
511 list-ports BRIDGE print the names of all the ports on BRIDGE\n\
512 add-port BRIDGE PORT add network device PORT to BRIDGE\n\
513 add-bond BRIDGE PORT IFACE... add bonded port PORT in BRIDGE from IFACES\n\
514 del-port [BRIDGE] PORT delete PORT (which may be bonded) from BRIDGE\n\
515 port-to-br PORT print name of bridge that contains PORT\n\
517 Interface commands (a bond consists of multiple interfaces):\n\
518 list-ifaces BRIDGE print the names of all interfaces on BRIDGE\n\
519 iface-to-br IFACE print name of bridge that contains IFACE\n\
521 Controller commands:\n\
522 get-controller BRIDGE print the controllers for BRIDGE\n\
523 del-controller BRIDGE delete the controllers for BRIDGE\n\
524 set-controller BRIDGE TARGET... set the controllers for BRIDGE\n\
525 get-fail-mode BRIDGE print the fail-mode for BRIDGE\n\
526 del-fail-mode BRIDGE delete the fail-mode for BRIDGE\n\
527 set-fail-mode BRIDGE MODE set the fail-mode for BRIDGE to MODE\n\
530 get-manager print the managers\n\
531 del-manager delete the managers\n\
532 set-manager TARGET... set the list of managers to TARGET...\n\
535 get-ssl print the SSL configuration\n\
536 del-ssl delete the SSL configuration\n\
537 set-ssl PRIV-KEY CERT CA-CERT set the SSL configuration\n\
540 emer-reset reset switch to known good state\n\
542 Database commands:\n\
543 list TBL [REC] list RECord (or all records) in TBL\n\
544 find TBL CONDITION... list records satisfying CONDITION in TBL\n\
545 get TBL REC COL[:KEY] print values of COLumns in RECord in TBL\n\
546 set TBL REC COL[:KEY]=VALUE set COLumn values in RECord in TBL\n\
547 add TBL REC COL [KEY=]VALUE add (KEY=)VALUE to COLumn in RECord in TBL\n\
548 remove TBL REC COL [KEY=]VALUE remove (KEY=)VALUE from COLumn\n\
549 clear TBL REC COL clear values from COLumn in RECord in TBL\n\
550 create TBL COL[:KEY]=VALUE create and initialize new record\n\
551 destroy TBL REC delete RECord from TBL\n\
552 wait-until TBL REC [COL[:KEY]=VALUE] wait until condition is true\n\
553 Potentially unsafe database commands require --force option.\n\
556 --db=DATABASE connect to DATABASE\n\
558 --no-wait do not wait for ovs-vswitchd to reconfigure\n\
559 -t, --timeout=SECS wait at most SECS seconds for ovs-vswitchd\n\
560 --dry-run do not commit changes to database\n\
561 --oneline print exactly one line of output per command\n",
562 program_name, program_name, default_db());
565 --no-syslog equivalent to --verbose=vsctl:syslog:warn\n");
566 stream_usage("database", true, true, false);
569 -h, --help display this help message\n\
570 -V, --version display version information\n");
579 def = xasprintf("unix:%s/db.sock", ovs_rundir());
584 /* Returns true if it looks like this set of arguments might modify the
585 * database, otherwise false. (Not very smart, so it's prone to false
588 might_write_to_db(char **argv)
590 for (; *argv; argv++) {
591 const struct vsctl_command_syntax *p = find_command(*argv);
592 if (p && p->mode == RW) {
599 struct vsctl_context {
603 struct shash options;
605 /* Modifiable state. */
608 struct ovsdb_idl *idl;
609 struct ovsdb_idl_txn *txn;
610 struct ovsdb_symbol_table *symtab;
611 const struct ovsrec_open_vswitch *ovs;
614 /* A cache of the contents of the database.
616 * A command that needs to use any of this information must first call
617 * vsctl_context_populate_cache(). A command that changes anything that
618 * could invalidate the cache must either call
619 * vsctl_context_invalidate_cache() or manually update the cache to
620 * maintain its correctness. */
622 struct shash bridges; /* Maps from bridge name to struct vsctl_bridge. */
623 struct shash ports; /* Maps from port name to struct vsctl_port. */
624 struct shash ifaces; /* Maps from port name to struct vsctl_iface. */
626 /* A command may set this member to true if some prerequisite is not met
627 * and the caller should wait for something to change and then retry. */
631 struct vsctl_bridge {
632 struct ovsrec_bridge *br_cfg;
634 struct list ports; /* Contains "struct vsctl_port"s. */
636 /* VLAN ("fake") bridge support.
638 * Use 'parent != NULL' to detect a fake bridge, because 'vlan' can be 0
640 struct hmap children; /* VLAN bridges indexed by 'vlan'. */
641 struct hmap_node children_node; /* Node in parent's 'children' hmap. */
642 struct vsctl_bridge *parent; /* Real bridge, or NULL. */
643 int vlan; /* VLAN VID (0...4095), or 0. */
647 struct list ports_node; /* In struct vsctl_bridge's 'ports' list. */
648 struct list ifaces; /* Contains "struct vsctl_iface"s. */
649 struct ovsrec_port *port_cfg;
650 struct vsctl_bridge *bridge;
654 struct list ifaces_node; /* In struct vsctl_port's 'ifaces' list. */
655 struct ovsrec_interface *iface_cfg;
656 struct vsctl_port *port;
660 vsctl_context_to_string(const struct vsctl_context *ctx)
662 const struct shash_node *node;
668 SHASH_FOR_EACH (node, &ctx->options) {
669 svec_add(&words, node->name);
671 for (i = 0; i < ctx->argc; i++) {
672 svec_add(&words, ctx->argv[i]);
674 svec_terminate(&words);
676 s = process_escape_args(words.names);
678 svec_destroy(&words);
684 verify_ports(struct vsctl_context *ctx)
686 if (!ctx->verified_ports) {
687 const struct ovsrec_bridge *bridge;
688 const struct ovsrec_port *port;
690 ovsrec_open_vswitch_verify_bridges(ctx->ovs);
691 OVSREC_BRIDGE_FOR_EACH (bridge, ctx->idl) {
692 ovsrec_bridge_verify_ports(bridge);
694 OVSREC_PORT_FOR_EACH (port, ctx->idl) {
695 ovsrec_port_verify_interfaces(port);
698 ctx->verified_ports = true;
702 static struct vsctl_bridge *
703 add_bridge_to_cache(struct vsctl_context *ctx,
704 struct ovsrec_bridge *br_cfg, const char *name,
705 struct vsctl_bridge *parent, int vlan)
707 struct vsctl_bridge *br = xmalloc(sizeof *br);
709 br->name = xstrdup(name);
710 list_init(&br->ports);
713 hmap_init(&br->children);
715 hmap_insert(&parent->children, &br->children_node, hash_int(vlan, 0));
717 shash_add(&ctx->bridges, br->name, br);
722 ovs_delete_bridge(const struct ovsrec_open_vswitch *ovs,
723 struct ovsrec_bridge *bridge)
725 struct ovsrec_bridge **bridges;
728 bridges = xmalloc(sizeof *ovs->bridges * ovs->n_bridges);
729 for (i = n = 0; i < ovs->n_bridges; i++) {
730 if (ovs->bridges[i] != bridge) {
731 bridges[n++] = ovs->bridges[i];
734 ovsrec_open_vswitch_set_bridges(ovs, bridges, n);
739 del_cached_bridge(struct vsctl_context *ctx, struct vsctl_bridge *br)
741 assert(list_is_empty(&br->ports));
742 assert(hmap_is_empty(&br->children));
744 hmap_remove(&br->parent->children, &br->children_node);
747 ovsrec_bridge_delete(br->br_cfg);
748 ovs_delete_bridge(ctx->ovs, br->br_cfg);
750 shash_find_and_delete(&ctx->bridges, br->name);
751 hmap_destroy(&br->children);
757 port_is_fake_bridge(const struct ovsrec_port *port_cfg)
759 return (port_cfg->fake_bridge
761 && *port_cfg->tag >= 0 && *port_cfg->tag <= 4095);
764 static struct vsctl_bridge *
765 find_vlan_bridge(struct vsctl_bridge *parent, int vlan)
767 struct vsctl_bridge *child;
769 HMAP_FOR_EACH_IN_BUCKET (child, children_node, hash_int(vlan, 0),
771 if (child->vlan == vlan) {
779 static struct vsctl_port *
780 add_port_to_cache(struct vsctl_context *ctx, struct vsctl_bridge *parent,
781 struct ovsrec_port *port_cfg)
783 struct vsctl_port *port;
786 && *port_cfg->tag >= 0 && *port_cfg->tag <= 4095) {
787 struct vsctl_bridge *vlan_bridge;
789 vlan_bridge = find_vlan_bridge(parent, *port_cfg->tag);
791 parent = vlan_bridge;
795 port = xmalloc(sizeof *port);
796 list_push_back(&parent->ports, &port->ports_node);
797 list_init(&port->ifaces);
798 port->port_cfg = port_cfg;
799 port->bridge = parent;
800 shash_add(&ctx->ports, port_cfg->name, port);
806 del_cached_port(struct vsctl_context *ctx, struct vsctl_port *port)
808 assert(list_is_empty(&port->ifaces));
809 list_remove(&port->ports_node);
810 shash_find_and_delete(&ctx->ports, port->port_cfg->name);
811 ovsrec_port_delete(port->port_cfg);
815 static struct vsctl_iface *
816 add_iface_to_cache(struct vsctl_context *ctx, struct vsctl_port *parent,
817 struct ovsrec_interface *iface_cfg)
819 struct vsctl_iface *iface;
821 iface = xmalloc(sizeof *iface);
822 list_push_back(&parent->ifaces, &iface->ifaces_node);
823 iface->iface_cfg = iface_cfg;
824 iface->port = parent;
825 shash_add(&ctx->ifaces, iface_cfg->name, iface);
831 del_cached_iface(struct vsctl_context *ctx, struct vsctl_iface *iface)
833 list_remove(&iface->ifaces_node);
834 shash_find_and_delete(&ctx->ifaces, iface->iface_cfg->name);
835 ovsrec_interface_delete(iface->iface_cfg);
840 vsctl_context_invalidate_cache(struct vsctl_context *ctx)
842 struct shash_node *node;
844 if (!ctx->cache_valid) {
847 ctx->cache_valid = false;
849 SHASH_FOR_EACH (node, &ctx->bridges) {
850 struct vsctl_bridge *bridge = node->data;
851 hmap_destroy(&bridge->children);
855 shash_destroy(&ctx->bridges);
857 shash_destroy_free_data(&ctx->ports);
858 shash_destroy_free_data(&ctx->ifaces);
862 pre_get_info(struct vsctl_context *ctx)
864 ovsdb_idl_add_column(ctx->idl, &ovsrec_open_vswitch_col_bridges);
866 ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_name);
867 ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_controller);
868 ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_fail_mode);
869 ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_ports);
871 ovsdb_idl_add_column(ctx->idl, &ovsrec_port_col_name);
872 ovsdb_idl_add_column(ctx->idl, &ovsrec_port_col_fake_bridge);
873 ovsdb_idl_add_column(ctx->idl, &ovsrec_port_col_tag);
874 ovsdb_idl_add_column(ctx->idl, &ovsrec_port_col_interfaces);
876 ovsdb_idl_add_column(ctx->idl, &ovsrec_interface_col_name);
880 vsctl_context_populate_cache(struct vsctl_context *ctx)
882 const struct ovsrec_open_vswitch *ovs = ctx->ovs;
883 struct sset bridges, ports;
886 if (ctx->cache_valid) {
887 /* Cache is already populated. */
890 ctx->cache_valid = true;
891 shash_init(&ctx->bridges);
892 shash_init(&ctx->ports);
893 shash_init(&ctx->ifaces);
897 for (i = 0; i < ovs->n_bridges; i++) {
898 struct ovsrec_bridge *br_cfg = ovs->bridges[i];
899 struct vsctl_bridge *br;
902 if (!sset_add(&bridges, br_cfg->name)) {
903 VLOG_WARN("%s: database contains duplicate bridge name",
907 br = add_bridge_to_cache(ctx, br_cfg, br_cfg->name, NULL, 0);
912 for (j = 0; j < br_cfg->n_ports; j++) {
913 struct ovsrec_port *port_cfg = br_cfg->ports[j];
915 if (!sset_add(&ports, port_cfg->name)) {
916 /* Duplicate port name. (We will warn about that later.) */
920 if (port_is_fake_bridge(port_cfg)
921 && sset_add(&bridges, port_cfg->name)) {
922 add_bridge_to_cache(ctx, NULL, port_cfg->name, br,
927 sset_destroy(&bridges);
928 sset_destroy(&ports);
931 for (i = 0; i < ovs->n_bridges; i++) {
932 struct ovsrec_bridge *br_cfg = ovs->bridges[i];
933 struct vsctl_bridge *br;
936 if (!sset_add(&bridges, br_cfg->name)) {
939 br = shash_find_data(&ctx->bridges, br_cfg->name);
940 for (j = 0; j < br_cfg->n_ports; j++) {
941 struct ovsrec_port *port_cfg = br_cfg->ports[j];
942 struct vsctl_port *port;
945 port = shash_find_data(&ctx->ports, port_cfg->name);
947 if (port_cfg == port->port_cfg) {
948 VLOG_WARN("%s: port is in multiple bridges (%s and %s)",
949 port_cfg->name, br->name, port->bridge->name);
951 /* Log as an error because this violates the database's
952 * uniqueness constraints, so the database server shouldn't
953 * have allowed it. */
954 VLOG_ERR("%s: database contains duplicate port name",
960 if (port_is_fake_bridge(port_cfg)
961 && !sset_add(&bridges, port_cfg->name)) {
965 port = add_port_to_cache(ctx, br, port_cfg);
966 for (k = 0; k < port_cfg->n_interfaces; k++) {
967 struct ovsrec_interface *iface_cfg = port_cfg->interfaces[k];
968 struct vsctl_iface *iface;
970 iface = shash_find_data(&ctx->ifaces, iface_cfg->name);
972 if (iface_cfg == iface->iface_cfg) {
973 VLOG_WARN("%s: interface is in multiple ports "
976 iface->port->port_cfg->name,
977 port->port_cfg->name);
979 /* Log as an error because this violates the database's
980 * uniqueness constraints, so the database server
981 * shouldn't have allowed it. */
982 VLOG_ERR("%s: database contains duplicate interface "
983 "name", iface_cfg->name);
988 add_iface_to_cache(ctx, port, iface_cfg);
992 sset_destroy(&bridges);
996 check_conflicts(struct vsctl_context *ctx, const char *name,
999 struct vsctl_iface *iface;
1000 struct vsctl_port *port;
1004 if (shash_find(&ctx->bridges, name)) {
1005 vsctl_fatal("%s because a bridge named %s already exists",
1009 port = shash_find_data(&ctx->ports, name);
1011 vsctl_fatal("%s because a port named %s already exists on "
1012 "bridge %s", msg, name, port->bridge->name);
1015 iface = shash_find_data(&ctx->ifaces, name);
1017 vsctl_fatal("%s because an interface named %s already exists "
1018 "on bridge %s", msg, name, iface->port->bridge->name);
1024 static struct vsctl_bridge *
1025 find_bridge(struct vsctl_context *ctx, const char *name, bool must_exist)
1027 struct vsctl_bridge *br;
1029 assert(ctx->cache_valid);
1031 br = shash_find_data(&ctx->bridges, name);
1032 if (must_exist && !br) {
1033 vsctl_fatal("no bridge named %s", name);
1035 ovsrec_open_vswitch_verify_bridges(ctx->ovs);
1039 static struct vsctl_bridge *
1040 find_real_bridge(struct vsctl_context *ctx, const char *name, bool must_exist)
1042 struct vsctl_bridge *br = find_bridge(ctx, name, must_exist);
1043 if (br && br->parent) {
1044 vsctl_fatal("%s is a fake bridge", name);
1049 static struct vsctl_port *
1050 find_port(struct vsctl_context *ctx, const char *name, bool must_exist)
1052 struct vsctl_port *port;
1054 assert(ctx->cache_valid);
1056 port = shash_find_data(&ctx->ports, name);
1057 if (port && !strcmp(name, port->bridge->name)) {
1060 if (must_exist && !port) {
1061 vsctl_fatal("no port named %s", name);
1067 static struct vsctl_iface *
1068 find_iface(struct vsctl_context *ctx, const char *name, bool must_exist)
1070 struct vsctl_iface *iface;
1072 assert(ctx->cache_valid);
1074 iface = shash_find_data(&ctx->ifaces, name);
1075 if (iface && !strcmp(name, iface->port->bridge->name)) {
1078 if (must_exist && !iface) {
1079 vsctl_fatal("no interface named %s", name);
1086 bridge_insert_port(struct ovsrec_bridge *br, struct ovsrec_port *port)
1088 struct ovsrec_port **ports;
1091 ports = xmalloc(sizeof *br->ports * (br->n_ports + 1));
1092 for (i = 0; i < br->n_ports; i++) {
1093 ports[i] = br->ports[i];
1095 ports[br->n_ports] = port;
1096 ovsrec_bridge_set_ports(br, ports, br->n_ports + 1);
1101 bridge_delete_port(struct ovsrec_bridge *br, struct ovsrec_port *port)
1103 struct ovsrec_port **ports;
1106 ports = xmalloc(sizeof *br->ports * br->n_ports);
1107 for (i = n = 0; i < br->n_ports; i++) {
1108 if (br->ports[i] != port) {
1109 ports[n++] = br->ports[i];
1112 ovsrec_bridge_set_ports(br, ports, n);
1117 ovs_insert_bridge(const struct ovsrec_open_vswitch *ovs,
1118 struct ovsrec_bridge *bridge)
1120 struct ovsrec_bridge **bridges;
1123 bridges = xmalloc(sizeof *ovs->bridges * (ovs->n_bridges + 1));
1124 for (i = 0; i < ovs->n_bridges; i++) {
1125 bridges[i] = ovs->bridges[i];
1127 bridges[ovs->n_bridges] = bridge;
1128 ovsrec_open_vswitch_set_bridges(ovs, bridges, ovs->n_bridges + 1);
1133 cmd_init(struct vsctl_context *ctx OVS_UNUSED)
1137 struct cmd_show_table {
1138 const struct ovsdb_idl_table_class *table;
1139 const struct ovsdb_idl_column *name_column;
1140 const struct ovsdb_idl_column *columns[3];
1144 static struct cmd_show_table cmd_show_tables[] = {
1145 {&ovsrec_table_open_vswitch,
1147 {&ovsrec_open_vswitch_col_manager_options,
1148 &ovsrec_open_vswitch_col_bridges,
1149 &ovsrec_open_vswitch_col_ovs_version},
1152 {&ovsrec_table_bridge,
1153 &ovsrec_bridge_col_name,
1154 {&ovsrec_bridge_col_controller,
1155 &ovsrec_bridge_col_fail_mode,
1156 &ovsrec_bridge_col_ports},
1159 {&ovsrec_table_port,
1160 &ovsrec_port_col_name,
1161 {&ovsrec_port_col_tag,
1162 &ovsrec_port_col_trunks,
1163 &ovsrec_port_col_interfaces},
1166 {&ovsrec_table_interface,
1167 &ovsrec_interface_col_name,
1168 {&ovsrec_interface_col_type,
1169 &ovsrec_interface_col_options,
1173 {&ovsrec_table_controller,
1174 &ovsrec_controller_col_target,
1175 {&ovsrec_controller_col_is_connected,
1180 {&ovsrec_table_manager,
1181 &ovsrec_manager_col_target,
1182 {&ovsrec_manager_col_is_connected,
1189 pre_cmd_show(struct vsctl_context *ctx)
1191 struct cmd_show_table *show;
1193 for (show = cmd_show_tables;
1194 show < &cmd_show_tables[ARRAY_SIZE(cmd_show_tables)];
1198 ovsdb_idl_add_table(ctx->idl, show->table);
1199 if (show->name_column) {
1200 ovsdb_idl_add_column(ctx->idl, show->name_column);
1202 for (i = 0; i < ARRAY_SIZE(show->columns); i++) {
1203 const struct ovsdb_idl_column *column = show->columns[i];
1205 ovsdb_idl_add_column(ctx->idl, column);
1211 static struct cmd_show_table *
1212 cmd_show_find_table_by_row(const struct ovsdb_idl_row *row)
1214 struct cmd_show_table *show;
1216 for (show = cmd_show_tables;
1217 show < &cmd_show_tables[ARRAY_SIZE(cmd_show_tables)];
1219 if (show->table == row->table->class) {
1226 static struct cmd_show_table *
1227 cmd_show_find_table_by_name(const char *name)
1229 struct cmd_show_table *show;
1231 for (show = cmd_show_tables;
1232 show < &cmd_show_tables[ARRAY_SIZE(cmd_show_tables)];
1234 if (!strcmp(show->table->name, name)) {
1242 cmd_show_row(struct vsctl_context *ctx, const struct ovsdb_idl_row *row,
1245 struct cmd_show_table *show = cmd_show_find_table_by_row(row);
1248 ds_put_char_multiple(&ctx->output, ' ', level * 4);
1249 if (show && show->name_column) {
1250 const struct ovsdb_datum *datum;
1252 ds_put_format(&ctx->output, "%s ", show->table->name);
1253 datum = ovsdb_idl_read(row, show->name_column);
1254 ovsdb_datum_to_string(datum, &show->name_column->type, &ctx->output);
1256 ds_put_format(&ctx->output, UUID_FMT, UUID_ARGS(&row->uuid));
1258 ds_put_char(&ctx->output, '\n');
1260 if (!show || show->recurse) {
1264 show->recurse = true;
1265 for (i = 0; i < ARRAY_SIZE(show->columns); i++) {
1266 const struct ovsdb_idl_column *column = show->columns[i];
1267 const struct ovsdb_datum *datum;
1273 datum = ovsdb_idl_read(row, column);
1274 if (column->type.key.type == OVSDB_TYPE_UUID &&
1275 column->type.key.u.uuid.refTableName) {
1276 struct cmd_show_table *ref_show;
1279 ref_show = cmd_show_find_table_by_name(
1280 column->type.key.u.uuid.refTableName);
1282 for (j = 0; j < datum->n; j++) {
1283 const struct ovsdb_idl_row *ref_row;
1285 ref_row = ovsdb_idl_get_row_for_uuid(ctx->idl,
1287 &datum->keys[j].uuid);
1289 cmd_show_row(ctx, ref_row, level + 1);
1296 if (!ovsdb_datum_is_default(datum, &column->type)) {
1297 ds_put_char_multiple(&ctx->output, ' ', (level + 1) * 4);
1298 ds_put_format(&ctx->output, "%s: ", column->name);
1299 ovsdb_datum_to_string(datum, &column->type, &ctx->output);
1300 ds_put_char(&ctx->output, '\n');
1303 show->recurse = false;
1307 cmd_show(struct vsctl_context *ctx)
1309 const struct ovsdb_idl_row *row;
1311 for (row = ovsdb_idl_first_row(ctx->idl, cmd_show_tables[0].table);
1312 row; row = ovsdb_idl_next_row(row)) {
1313 cmd_show_row(ctx, row, 0);
1318 pre_cmd_emer_reset(struct vsctl_context *ctx)
1320 ovsdb_idl_add_column(ctx->idl, &ovsrec_open_vswitch_col_manager_options);
1321 ovsdb_idl_add_column(ctx->idl, &ovsrec_open_vswitch_col_ssl);
1323 ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_controller);
1324 ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_fail_mode);
1325 ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_mirrors);
1326 ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_netflow);
1327 ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_sflow);
1328 ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_flood_vlans);
1329 ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_other_config);
1331 ovsdb_idl_add_column(ctx->idl, &ovsrec_port_col_other_config);
1333 ovsdb_idl_add_column(ctx->idl,
1334 &ovsrec_interface_col_ingress_policing_rate);
1335 ovsdb_idl_add_column(ctx->idl,
1336 &ovsrec_interface_col_ingress_policing_burst);
1340 cmd_emer_reset(struct vsctl_context *ctx)
1342 const struct ovsdb_idl *idl = ctx->idl;
1343 const struct ovsrec_bridge *br;
1344 const struct ovsrec_port *port;
1345 const struct ovsrec_interface *iface;
1346 const struct ovsrec_mirror *mirror, *next_mirror;
1347 const struct ovsrec_controller *ctrl, *next_ctrl;
1348 const struct ovsrec_manager *mgr, *next_mgr;
1349 const struct ovsrec_netflow *nf, *next_nf;
1350 const struct ovsrec_ssl *ssl, *next_ssl;
1351 const struct ovsrec_sflow *sflow, *next_sflow;
1353 /* Reset the Open_vSwitch table. */
1354 ovsrec_open_vswitch_set_manager_options(ctx->ovs, NULL, 0);
1355 ovsrec_open_vswitch_set_ssl(ctx->ovs, NULL);
1357 OVSREC_BRIDGE_FOR_EACH (br, idl) {
1360 ovsrec_bridge_set_controller(br, NULL, 0);
1361 ovsrec_bridge_set_fail_mode(br, NULL);
1362 ovsrec_bridge_set_mirrors(br, NULL, 0);
1363 ovsrec_bridge_set_netflow(br, NULL);
1364 ovsrec_bridge_set_sflow(br, NULL);
1365 ovsrec_bridge_set_flood_vlans(br, NULL, 0);
1367 /* We only want to save the "hwaddr" key from other_config. */
1368 hwaddr = smap_get(&br->other_config, "hwaddr");
1370 struct smap smap = SMAP_INITIALIZER(&smap);
1371 smap_add(&smap, "hwaddr", hwaddr);
1372 ovsrec_bridge_set_other_config(br, &smap);
1373 smap_destroy(&smap);
1375 ovsrec_bridge_set_other_config(br, NULL);
1379 OVSREC_PORT_FOR_EACH (port, idl) {
1380 ovsrec_port_set_other_config(port, NULL);
1383 OVSREC_INTERFACE_FOR_EACH (iface, idl) {
1384 /* xxx What do we do about gre/patch devices created by mgr? */
1386 ovsrec_interface_set_ingress_policing_rate(iface, 0);
1387 ovsrec_interface_set_ingress_policing_burst(iface, 0);
1390 OVSREC_MIRROR_FOR_EACH_SAFE (mirror, next_mirror, idl) {
1391 ovsrec_mirror_delete(mirror);
1394 OVSREC_CONTROLLER_FOR_EACH_SAFE (ctrl, next_ctrl, idl) {
1395 ovsrec_controller_delete(ctrl);
1398 OVSREC_MANAGER_FOR_EACH_SAFE (mgr, next_mgr, idl) {
1399 ovsrec_manager_delete(mgr);
1402 OVSREC_NETFLOW_FOR_EACH_SAFE (nf, next_nf, idl) {
1403 ovsrec_netflow_delete(nf);
1406 OVSREC_SSL_FOR_EACH_SAFE (ssl, next_ssl, idl) {
1407 ovsrec_ssl_delete(ssl);
1410 OVSREC_SFLOW_FOR_EACH_SAFE (sflow, next_sflow, idl) {
1411 ovsrec_sflow_delete(sflow);
1414 vsctl_context_invalidate_cache(ctx);
1418 cmd_add_br(struct vsctl_context *ctx)
1420 bool may_exist = shash_find(&ctx->options, "--may-exist") != NULL;
1421 const char *br_name, *parent_name;
1424 br_name = ctx->argv[1];
1425 if (ctx->argc == 2) {
1428 } else if (ctx->argc == 4) {
1429 parent_name = ctx->argv[2];
1430 vlan = atoi(ctx->argv[3]);
1431 if (vlan < 0 || vlan > 4095) {
1432 vsctl_fatal("%s: vlan must be between 0 and 4095", ctx->argv[0]);
1435 vsctl_fatal("'%s' command takes exactly 1 or 3 arguments",
1439 vsctl_context_populate_cache(ctx);
1441 struct vsctl_bridge *br;
1443 br = find_bridge(ctx, br_name, false);
1447 vsctl_fatal("\"--may-exist add-br %s\" but %s is "
1448 "a VLAN bridge for VLAN %d",
1449 br_name, br_name, br->vlan);
1453 vsctl_fatal("\"--may-exist add-br %s %s %d\" but %s "
1454 "is not a VLAN bridge",
1455 br_name, parent_name, vlan, br_name);
1456 } else if (strcmp(br->parent->name, parent_name)) {
1457 vsctl_fatal("\"--may-exist add-br %s %s %d\" but %s "
1458 "has the wrong parent %s",
1459 br_name, parent_name, vlan,
1460 br_name, br->parent->name);
1461 } else if (br->vlan != vlan) {
1462 vsctl_fatal("\"--may-exist add-br %s %s %d\" but %s "
1463 "is a VLAN bridge for the wrong VLAN %d",
1464 br_name, parent_name, vlan, br_name, br->vlan);
1470 check_conflicts(ctx, br_name,
1471 xasprintf("cannot create a bridge named %s", br_name));
1474 struct ovsrec_port *port;
1475 struct ovsrec_interface *iface;
1476 struct ovsrec_bridge *br;
1478 iface = ovsrec_interface_insert(ctx->txn);
1479 ovsrec_interface_set_name(iface, br_name);
1480 ovsrec_interface_set_type(iface, "internal");
1482 port = ovsrec_port_insert(ctx->txn);
1483 ovsrec_port_set_name(port, br_name);
1484 ovsrec_port_set_interfaces(port, &iface, 1);
1486 br = ovsrec_bridge_insert(ctx->txn);
1487 ovsrec_bridge_set_name(br, br_name);
1488 ovsrec_bridge_set_ports(br, &port, 1);
1490 ovs_insert_bridge(ctx->ovs, br);
1492 struct vsctl_bridge *parent;
1493 struct ovsrec_port *port;
1494 struct ovsrec_interface *iface;
1495 struct ovsrec_bridge *br;
1498 parent = find_bridge(ctx, parent_name, false);
1499 if (parent && parent->parent) {
1500 vsctl_fatal("cannot create bridge with fake bridge as parent");
1503 vsctl_fatal("parent bridge %s does not exist", parent_name);
1505 br = parent->br_cfg;
1507 iface = ovsrec_interface_insert(ctx->txn);
1508 ovsrec_interface_set_name(iface, br_name);
1509 ovsrec_interface_set_type(iface, "internal");
1511 port = ovsrec_port_insert(ctx->txn);
1512 ovsrec_port_set_name(port, br_name);
1513 ovsrec_port_set_interfaces(port, &iface, 1);
1514 ovsrec_port_set_fake_bridge(port, true);
1515 ovsrec_port_set_tag(port, &tag, 1);
1517 bridge_insert_port(br, port);
1520 vsctl_context_invalidate_cache(ctx);
1524 del_port(struct vsctl_context *ctx, struct vsctl_port *port)
1526 struct vsctl_iface *iface, *next_iface;
1528 bridge_delete_port((port->bridge->parent
1529 ? port->bridge->parent->br_cfg
1530 : port->bridge->br_cfg), port->port_cfg);
1532 LIST_FOR_EACH_SAFE (iface, next_iface, ifaces_node, &port->ifaces) {
1533 del_cached_iface(ctx, iface);
1535 del_cached_port(ctx, port);
1539 del_bridge(struct vsctl_context *ctx, struct vsctl_bridge *br)
1541 struct vsctl_bridge *child, *next_child;
1542 struct vsctl_port *port, *next_port;
1544 HMAP_FOR_EACH_SAFE (child, next_child, children_node, &br->children) {
1545 del_bridge(ctx, child);
1548 LIST_FOR_EACH_SAFE (port, next_port, ports_node, &br->ports) {
1549 del_port(ctx, port);
1552 del_cached_bridge(ctx, br);
1556 cmd_del_br(struct vsctl_context *ctx)
1558 bool must_exist = !shash_find(&ctx->options, "--if-exists");
1559 struct vsctl_bridge *bridge;
1561 vsctl_context_populate_cache(ctx);
1562 bridge = find_bridge(ctx, ctx->argv[1], must_exist);
1564 del_bridge(ctx, bridge);
1569 output_sorted(struct svec *svec, struct ds *output)
1575 SVEC_FOR_EACH (i, name, svec) {
1576 ds_put_format(output, "%s\n", name);
1581 cmd_list_br(struct vsctl_context *ctx)
1583 struct shash_node *node;
1584 struct svec bridges;
1586 vsctl_context_populate_cache(ctx);
1588 svec_init(&bridges);
1589 SHASH_FOR_EACH (node, &ctx->bridges) {
1590 struct vsctl_bridge *br = node->data;
1591 svec_add(&bridges, br->name);
1593 output_sorted(&bridges, &ctx->output);
1594 svec_destroy(&bridges);
1598 cmd_br_exists(struct vsctl_context *ctx)
1600 vsctl_context_populate_cache(ctx);
1601 if (!find_bridge(ctx, ctx->argv[1], false)) {
1607 set_external_id(struct smap *old, struct smap *new,
1608 char *key, char *value)
1610 smap_clone(new, old);
1613 smap_replace(new, key, value);
1615 smap_remove(new, key);
1620 pre_cmd_br_set_external_id(struct vsctl_context *ctx)
1623 ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_external_ids);
1624 ovsdb_idl_add_column(ctx->idl, &ovsrec_port_col_external_ids);
1628 cmd_br_set_external_id(struct vsctl_context *ctx)
1630 struct vsctl_bridge *bridge;
1633 vsctl_context_populate_cache(ctx);
1634 bridge = find_bridge(ctx, ctx->argv[1], true);
1635 if (bridge->br_cfg) {
1637 set_external_id(&bridge->br_cfg->external_ids, &new, ctx->argv[2],
1638 ctx->argc >= 4 ? ctx->argv[3] : NULL);
1639 ovsrec_bridge_verify_external_ids(bridge->br_cfg);
1640 ovsrec_bridge_set_external_ids(bridge->br_cfg, &new);
1642 char *key = xasprintf("fake-bridge-%s", ctx->argv[2]);
1643 struct vsctl_port *port = shash_find_data(&ctx->ports, ctx->argv[1]);
1644 set_external_id(&port->port_cfg->external_ids, &new,
1645 key, ctx->argc >= 4 ? ctx->argv[3] : NULL);
1646 ovsrec_port_verify_external_ids(port->port_cfg);
1647 ovsrec_port_set_external_ids(port->port_cfg, &new);
1654 get_external_id(struct smap *smap, const char *prefix, const char *key,
1658 char *prefix_key = xasprintf("%s%s", prefix, key);
1659 const char *value = smap_get(smap, prefix_key);
1662 ds_put_format(output, "%s\n", value);
1666 const struct smap_node **sorted = smap_sort(smap);
1667 size_t prefix_len = strlen(prefix);
1670 for (i = 0; i < smap_count(smap); i++) {
1671 const struct smap_node *node = sorted[i];
1672 if (!strncmp(node->key, prefix, prefix_len)) {
1673 ds_put_format(output, "%s=%s\n", node->key + prefix_len,
1682 pre_cmd_br_get_external_id(struct vsctl_context *ctx)
1684 pre_cmd_br_set_external_id(ctx);
1688 cmd_br_get_external_id(struct vsctl_context *ctx)
1690 struct vsctl_bridge *bridge;
1692 vsctl_context_populate_cache(ctx);
1694 bridge = find_bridge(ctx, ctx->argv[1], true);
1695 if (bridge->br_cfg) {
1696 ovsrec_bridge_verify_external_ids(bridge->br_cfg);
1697 get_external_id(&bridge->br_cfg->external_ids, "",
1698 ctx->argc >= 3 ? ctx->argv[2] : NULL, &ctx->output);
1700 struct vsctl_port *port = shash_find_data(&ctx->ports, ctx->argv[1]);
1701 ovsrec_port_verify_external_ids(port->port_cfg);
1702 get_external_id(&port->port_cfg->external_ids, "fake-bridge-",
1703 ctx->argc >= 3 ? ctx->argv[2] : NULL, &ctx->output);
1708 cmd_list_ports(struct vsctl_context *ctx)
1710 struct vsctl_bridge *br;
1711 struct vsctl_port *port;
1714 vsctl_context_populate_cache(ctx);
1715 br = find_bridge(ctx, ctx->argv[1], true);
1716 ovsrec_bridge_verify_ports(br->br_cfg ? br->br_cfg : br->parent->br_cfg);
1719 LIST_FOR_EACH (port, ports_node, &br->ports) {
1720 if (strcmp(port->port_cfg->name, br->name)) {
1721 svec_add(&ports, port->port_cfg->name);
1724 output_sorted(&ports, &ctx->output);
1725 svec_destroy(&ports);
1729 add_port(struct vsctl_context *ctx,
1730 const char *br_name, const char *port_name,
1731 bool may_exist, bool fake_iface,
1732 char *iface_names[], int n_ifaces,
1733 char *settings[], int n_settings)
1735 struct vsctl_port *vsctl_port;
1736 struct vsctl_bridge *bridge;
1737 struct ovsrec_interface **ifaces;
1738 struct ovsrec_port *port;
1741 vsctl_context_populate_cache(ctx);
1743 struct vsctl_port *vsctl_port;
1745 vsctl_port = find_port(ctx, port_name, false);
1747 struct svec want_names, have_names;
1749 svec_init(&want_names);
1750 for (i = 0; i < n_ifaces; i++) {
1751 svec_add(&want_names, iface_names[i]);
1753 svec_sort(&want_names);
1755 svec_init(&have_names);
1756 for (i = 0; i < vsctl_port->port_cfg->n_interfaces; i++) {
1757 svec_add(&have_names,
1758 vsctl_port->port_cfg->interfaces[i]->name);
1760 svec_sort(&have_names);
1762 if (strcmp(vsctl_port->bridge->name, br_name)) {
1763 char *command = vsctl_context_to_string(ctx);
1764 vsctl_fatal("\"%s\" but %s is actually attached to bridge %s",
1765 command, port_name, vsctl_port->bridge->name);
1768 if (!svec_equal(&want_names, &have_names)) {
1769 char *have_names_string = svec_join(&have_names, ", ", "");
1770 char *command = vsctl_context_to_string(ctx);
1772 vsctl_fatal("\"%s\" but %s actually has interface(s) %s",
1773 command, port_name, have_names_string);
1776 svec_destroy(&want_names);
1777 svec_destroy(&have_names);
1782 check_conflicts(ctx, port_name,
1783 xasprintf("cannot create a port named %s", port_name));
1784 for (i = 0; i < n_ifaces; i++) {
1785 check_conflicts(ctx, iface_names[i],
1786 xasprintf("cannot create an interface named %s",
1789 bridge = find_bridge(ctx, br_name, true);
1791 ifaces = xmalloc(n_ifaces * sizeof *ifaces);
1792 for (i = 0; i < n_ifaces; i++) {
1793 ifaces[i] = ovsrec_interface_insert(ctx->txn);
1794 ovsrec_interface_set_name(ifaces[i], iface_names[i]);
1797 port = ovsrec_port_insert(ctx->txn);
1798 ovsrec_port_set_name(port, port_name);
1799 ovsrec_port_set_interfaces(port, ifaces, n_ifaces);
1800 ovsrec_port_set_bond_fake_iface(port, fake_iface);
1802 if (bridge->parent) {
1803 int64_t tag = bridge->vlan;
1804 ovsrec_port_set_tag(port, &tag, 1);
1807 for (i = 0; i < n_settings; i++) {
1808 set_column(get_table("Port"), &port->header_, settings[i],
1812 bridge_insert_port((bridge->parent ? bridge->parent->br_cfg
1813 : bridge->br_cfg), port);
1815 vsctl_port = add_port_to_cache(ctx, bridge, port);
1816 for (i = 0; i < n_ifaces; i++) {
1817 add_iface_to_cache(ctx, vsctl_port, ifaces[i]);
1823 cmd_add_port(struct vsctl_context *ctx)
1825 bool may_exist = shash_find(&ctx->options, "--may-exist") != NULL;
1827 add_port(ctx, ctx->argv[1], ctx->argv[2], may_exist, false,
1828 &ctx->argv[2], 1, &ctx->argv[3], ctx->argc - 3);
1832 cmd_add_bond(struct vsctl_context *ctx)
1834 bool may_exist = shash_find(&ctx->options, "--may-exist") != NULL;
1835 bool fake_iface = shash_find(&ctx->options, "--fake-iface");
1839 n_ifaces = ctx->argc - 3;
1840 for (i = 3; i < ctx->argc; i++) {
1841 if (strchr(ctx->argv[i], '=')) {
1847 vsctl_fatal("add-bond requires at least 2 interfaces, but only "
1848 "%d were specified", n_ifaces);
1851 add_port(ctx, ctx->argv[1], ctx->argv[2], may_exist, fake_iface,
1852 &ctx->argv[3], n_ifaces,
1853 &ctx->argv[n_ifaces + 3], ctx->argc - 3 - n_ifaces);
1857 cmd_del_port(struct vsctl_context *ctx)
1859 bool must_exist = !shash_find(&ctx->options, "--if-exists");
1860 bool with_iface = shash_find(&ctx->options, "--with-iface") != NULL;
1861 struct vsctl_port *port;
1863 vsctl_context_populate_cache(ctx);
1865 port = find_port(ctx, ctx->argv[ctx->argc - 1], must_exist);
1867 const char *target = ctx->argv[ctx->argc - 1];
1868 struct vsctl_iface *iface;
1870 port = find_port(ctx, target, false);
1872 iface = find_iface(ctx, target, false);
1877 if (must_exist && !port) {
1878 vsctl_fatal("no port or interface named %s", target);
1883 if (ctx->argc == 3) {
1884 struct vsctl_bridge *bridge;
1886 bridge = find_bridge(ctx, ctx->argv[1], true);
1887 if (port->bridge != bridge) {
1888 if (port->bridge->parent == bridge) {
1889 vsctl_fatal("bridge %s does not have a port %s (although "
1890 "its parent bridge %s does)",
1891 ctx->argv[1], ctx->argv[2],
1892 bridge->parent->name);
1894 vsctl_fatal("bridge %s does not have a port %s",
1895 ctx->argv[1], ctx->argv[2]);
1900 del_port(ctx, port);
1905 cmd_port_to_br(struct vsctl_context *ctx)
1907 struct vsctl_port *port;
1909 vsctl_context_populate_cache(ctx);
1911 port = find_port(ctx, ctx->argv[1], true);
1912 ds_put_format(&ctx->output, "%s\n", port->bridge->name);
1916 cmd_br_to_vlan(struct vsctl_context *ctx)
1918 struct vsctl_bridge *bridge;
1920 vsctl_context_populate_cache(ctx);
1922 bridge = find_bridge(ctx, ctx->argv[1], true);
1923 ds_put_format(&ctx->output, "%d\n", bridge->vlan);
1927 cmd_br_to_parent(struct vsctl_context *ctx)
1929 struct vsctl_bridge *bridge;
1931 vsctl_context_populate_cache(ctx);
1933 bridge = find_bridge(ctx, ctx->argv[1], true);
1934 if (bridge->parent) {
1935 bridge = bridge->parent;
1937 ds_put_format(&ctx->output, "%s\n", bridge->name);
1941 cmd_list_ifaces(struct vsctl_context *ctx)
1943 struct vsctl_bridge *br;
1944 struct vsctl_port *port;
1947 vsctl_context_populate_cache(ctx);
1949 br = find_bridge(ctx, ctx->argv[1], true);
1953 LIST_FOR_EACH (port, ports_node, &br->ports) {
1954 struct vsctl_iface *iface;
1956 LIST_FOR_EACH (iface, ifaces_node, &port->ifaces) {
1957 if (strcmp(iface->iface_cfg->name, br->name)) {
1958 svec_add(&ifaces, iface->iface_cfg->name);
1962 output_sorted(&ifaces, &ctx->output);
1963 svec_destroy(&ifaces);
1967 cmd_iface_to_br(struct vsctl_context *ctx)
1969 struct vsctl_iface *iface;
1971 vsctl_context_populate_cache(ctx);
1973 iface = find_iface(ctx, ctx->argv[1], true);
1974 ds_put_format(&ctx->output, "%s\n", iface->port->bridge->name);
1978 verify_controllers(struct ovsrec_bridge *bridge)
1982 ovsrec_bridge_verify_controller(bridge);
1983 for (i = 0; i < bridge->n_controller; i++) {
1984 ovsrec_controller_verify_target(bridge->controller[i]);
1989 pre_controller(struct vsctl_context *ctx)
1993 ovsdb_idl_add_column(ctx->idl, &ovsrec_controller_col_target);
1997 cmd_get_controller(struct vsctl_context *ctx)
1999 struct vsctl_bridge *br;
2000 struct svec targets;
2003 vsctl_context_populate_cache(ctx);
2005 br = find_bridge(ctx, ctx->argv[1], true);
2009 verify_controllers(br->br_cfg);
2011 /* Print the targets in sorted order for reproducibility. */
2012 svec_init(&targets);
2013 for (i = 0; i < br->br_cfg->n_controller; i++) {
2014 svec_add(&targets, br->br_cfg->controller[i]->target);
2017 svec_sort(&targets);
2018 for (i = 0; i < targets.n; i++) {
2019 ds_put_format(&ctx->output, "%s\n", targets.names[i]);
2021 svec_destroy(&targets);
2025 delete_controllers(struct ovsrec_controller **controllers,
2026 size_t n_controllers)
2030 for (i = 0; i < n_controllers; i++) {
2031 ovsrec_controller_delete(controllers[i]);
2036 cmd_del_controller(struct vsctl_context *ctx)
2038 struct ovsrec_bridge *br;
2040 vsctl_context_populate_cache(ctx);
2042 br = find_real_bridge(ctx, ctx->argv[1], true)->br_cfg;
2043 verify_controllers(br);
2045 if (br->controller) {
2046 delete_controllers(br->controller, br->n_controller);
2047 ovsrec_bridge_set_controller(br, NULL, 0);
2051 static struct ovsrec_controller **
2052 insert_controllers(struct ovsdb_idl_txn *txn, char *targets[], size_t n)
2054 struct ovsrec_controller **controllers;
2057 controllers = xmalloc(n * sizeof *controllers);
2058 for (i = 0; i < n; i++) {
2059 if (vconn_verify_name(targets[i]) && pvconn_verify_name(targets[i])) {
2060 VLOG_WARN("target type \"%s\" is possibly erroneous", targets[i]);
2062 controllers[i] = ovsrec_controller_insert(txn);
2063 ovsrec_controller_set_target(controllers[i], targets[i]);
2070 cmd_set_controller(struct vsctl_context *ctx)
2072 struct ovsrec_controller **controllers;
2073 struct ovsrec_bridge *br;
2076 vsctl_context_populate_cache(ctx);
2078 br = find_real_bridge(ctx, ctx->argv[1], true)->br_cfg;
2079 verify_controllers(br);
2081 delete_controllers(br->controller, br->n_controller);
2084 controllers = insert_controllers(ctx->txn, &ctx->argv[2], n);
2085 ovsrec_bridge_set_controller(br, controllers, n);
2090 cmd_get_fail_mode(struct vsctl_context *ctx)
2092 struct vsctl_bridge *br;
2093 const char *fail_mode;
2095 vsctl_context_populate_cache(ctx);
2096 br = find_bridge(ctx, ctx->argv[1], true);
2101 ovsrec_bridge_verify_fail_mode(br->br_cfg);
2103 fail_mode = br->br_cfg->fail_mode;
2104 if (fail_mode && strlen(fail_mode)) {
2105 ds_put_format(&ctx->output, "%s\n", fail_mode);
2110 cmd_del_fail_mode(struct vsctl_context *ctx)
2112 struct vsctl_bridge *br;
2114 vsctl_context_populate_cache(ctx);
2116 br = find_real_bridge(ctx, ctx->argv[1], true);
2118 ovsrec_bridge_set_fail_mode(br->br_cfg, NULL);
2122 cmd_set_fail_mode(struct vsctl_context *ctx)
2124 struct vsctl_bridge *br;
2125 const char *fail_mode = ctx->argv[2];
2127 vsctl_context_populate_cache(ctx);
2129 br = find_real_bridge(ctx, ctx->argv[1], true);
2131 if (strcmp(fail_mode, "standalone") && strcmp(fail_mode, "secure")) {
2132 vsctl_fatal("fail-mode must be \"standalone\" or \"secure\"");
2135 ovsrec_bridge_set_fail_mode(br->br_cfg, fail_mode);
2139 verify_managers(const struct ovsrec_open_vswitch *ovs)
2143 ovsrec_open_vswitch_verify_manager_options(ovs);
2145 for (i = 0; i < ovs->n_manager_options; ++i) {
2146 const struct ovsrec_manager *mgr = ovs->manager_options[i];
2148 ovsrec_manager_verify_target(mgr);
2153 pre_manager(struct vsctl_context *ctx)
2155 ovsdb_idl_add_column(ctx->idl, &ovsrec_open_vswitch_col_manager_options);
2156 ovsdb_idl_add_column(ctx->idl, &ovsrec_manager_col_target);
2160 cmd_get_manager(struct vsctl_context *ctx)
2162 const struct ovsrec_open_vswitch *ovs = ctx->ovs;
2163 struct svec targets;
2166 verify_managers(ovs);
2168 /* Print the targets in sorted order for reproducibility. */
2169 svec_init(&targets);
2171 for (i = 0; i < ovs->n_manager_options; i++) {
2172 svec_add(&targets, ovs->manager_options[i]->target);
2175 svec_sort_unique(&targets);
2176 for (i = 0; i < targets.n; i++) {
2177 ds_put_format(&ctx->output, "%s\n", targets.names[i]);
2179 svec_destroy(&targets);
2183 delete_managers(const struct vsctl_context *ctx)
2185 const struct ovsrec_open_vswitch *ovs = ctx->ovs;
2188 /* Delete Manager rows pointed to by 'manager_options' column. */
2189 for (i = 0; i < ovs->n_manager_options; i++) {
2190 ovsrec_manager_delete(ovs->manager_options[i]);
2193 /* Delete 'Manager' row refs in 'manager_options' column. */
2194 ovsrec_open_vswitch_set_manager_options(ovs, NULL, 0);
2198 cmd_del_manager(struct vsctl_context *ctx)
2200 const struct ovsrec_open_vswitch *ovs = ctx->ovs;
2202 verify_managers(ovs);
2203 delete_managers(ctx);
2207 insert_managers(struct vsctl_context *ctx, char *targets[], size_t n)
2209 struct ovsrec_manager **managers;
2212 /* Insert each manager in a new row in Manager table. */
2213 managers = xmalloc(n * sizeof *managers);
2214 for (i = 0; i < n; i++) {
2215 if (stream_verify_name(targets[i]) && pstream_verify_name(targets[i])) {
2216 VLOG_WARN("target type \"%s\" is possibly erroneous", targets[i]);
2218 managers[i] = ovsrec_manager_insert(ctx->txn);
2219 ovsrec_manager_set_target(managers[i], targets[i]);
2222 /* Store uuids of new Manager rows in 'manager_options' column. */
2223 ovsrec_open_vswitch_set_manager_options(ctx->ovs, managers, n);
2228 cmd_set_manager(struct vsctl_context *ctx)
2230 const size_t n = ctx->argc - 1;
2232 verify_managers(ctx->ovs);
2233 delete_managers(ctx);
2234 insert_managers(ctx, &ctx->argv[1], n);
2238 pre_cmd_get_ssl(struct vsctl_context *ctx)
2240 ovsdb_idl_add_column(ctx->idl, &ovsrec_open_vswitch_col_ssl);
2242 ovsdb_idl_add_column(ctx->idl, &ovsrec_ssl_col_private_key);
2243 ovsdb_idl_add_column(ctx->idl, &ovsrec_ssl_col_certificate);
2244 ovsdb_idl_add_column(ctx->idl, &ovsrec_ssl_col_ca_cert);
2245 ovsdb_idl_add_column(ctx->idl, &ovsrec_ssl_col_bootstrap_ca_cert);
2249 cmd_get_ssl(struct vsctl_context *ctx)
2251 struct ovsrec_ssl *ssl = ctx->ovs->ssl;
2253 ovsrec_open_vswitch_verify_ssl(ctx->ovs);
2255 ovsrec_ssl_verify_private_key(ssl);
2256 ovsrec_ssl_verify_certificate(ssl);
2257 ovsrec_ssl_verify_ca_cert(ssl);
2258 ovsrec_ssl_verify_bootstrap_ca_cert(ssl);
2260 ds_put_format(&ctx->output, "Private key: %s\n", ssl->private_key);
2261 ds_put_format(&ctx->output, "Certificate: %s\n", ssl->certificate);
2262 ds_put_format(&ctx->output, "CA Certificate: %s\n", ssl->ca_cert);
2263 ds_put_format(&ctx->output, "Bootstrap: %s\n",
2264 ssl->bootstrap_ca_cert ? "true" : "false");
2269 pre_cmd_del_ssl(struct vsctl_context *ctx)
2271 ovsdb_idl_add_column(ctx->idl, &ovsrec_open_vswitch_col_ssl);
2275 cmd_del_ssl(struct vsctl_context *ctx)
2277 struct ovsrec_ssl *ssl = ctx->ovs->ssl;
2280 ovsrec_open_vswitch_verify_ssl(ctx->ovs);
2281 ovsrec_ssl_delete(ssl);
2282 ovsrec_open_vswitch_set_ssl(ctx->ovs, NULL);
2287 pre_cmd_set_ssl(struct vsctl_context *ctx)
2289 ovsdb_idl_add_column(ctx->idl, &ovsrec_open_vswitch_col_ssl);
2293 cmd_set_ssl(struct vsctl_context *ctx)
2295 bool bootstrap = shash_find(&ctx->options, "--bootstrap");
2296 struct ovsrec_ssl *ssl = ctx->ovs->ssl;
2298 ovsrec_open_vswitch_verify_ssl(ctx->ovs);
2300 ovsrec_ssl_delete(ssl);
2302 ssl = ovsrec_ssl_insert(ctx->txn);
2304 ovsrec_ssl_set_private_key(ssl, ctx->argv[1]);
2305 ovsrec_ssl_set_certificate(ssl, ctx->argv[2]);
2306 ovsrec_ssl_set_ca_cert(ssl, ctx->argv[3]);
2308 ovsrec_ssl_set_bootstrap_ca_cert(ssl, bootstrap);
2310 ovsrec_open_vswitch_set_ssl(ctx->ovs, ssl);
2313 /* Parameter commands. */
2315 struct vsctl_row_id {
2316 const struct ovsdb_idl_table_class *table;
2317 const struct ovsdb_idl_column *name_column;
2318 const struct ovsdb_idl_column *uuid_column;
2321 struct vsctl_table_class {
2322 struct ovsdb_idl_table_class *class;
2323 struct vsctl_row_id row_ids[2];
2326 static const struct vsctl_table_class tables[] = {
2327 {&ovsrec_table_bridge,
2328 {{&ovsrec_table_bridge, &ovsrec_bridge_col_name, NULL},
2329 {NULL, NULL, NULL}}},
2331 {&ovsrec_table_controller,
2332 {{&ovsrec_table_bridge,
2333 &ovsrec_bridge_col_name,
2334 &ovsrec_bridge_col_controller}}},
2336 {&ovsrec_table_interface,
2337 {{&ovsrec_table_interface, &ovsrec_interface_col_name, NULL},
2338 {NULL, NULL, NULL}}},
2340 {&ovsrec_table_mirror,
2341 {{&ovsrec_table_mirror, &ovsrec_mirror_col_name, NULL},
2342 {NULL, NULL, NULL}}},
2344 {&ovsrec_table_manager,
2345 {{&ovsrec_table_manager, &ovsrec_manager_col_target, NULL},
2346 {NULL, NULL, NULL}}},
2348 {&ovsrec_table_netflow,
2349 {{&ovsrec_table_bridge,
2350 &ovsrec_bridge_col_name,
2351 &ovsrec_bridge_col_netflow},
2352 {NULL, NULL, NULL}}},
2354 {&ovsrec_table_open_vswitch,
2355 {{&ovsrec_table_open_vswitch, NULL, NULL},
2356 {NULL, NULL, NULL}}},
2358 {&ovsrec_table_port,
2359 {{&ovsrec_table_port, &ovsrec_port_col_name, NULL},
2360 {NULL, NULL, NULL}}},
2363 {{&ovsrec_table_port, &ovsrec_port_col_name, &ovsrec_port_col_qos},
2364 {NULL, NULL, NULL}}},
2366 {&ovsrec_table_queue,
2367 {{NULL, NULL, NULL},
2368 {NULL, NULL, NULL}}},
2371 {{&ovsrec_table_open_vswitch, NULL, &ovsrec_open_vswitch_col_ssl}}},
2373 {&ovsrec_table_sflow,
2374 {{&ovsrec_table_bridge,
2375 &ovsrec_bridge_col_name,
2376 &ovsrec_bridge_col_sflow},
2377 {NULL, NULL, NULL}}},
2379 {&ovsrec_table_flow_table,
2380 {{&ovsrec_table_flow_table, &ovsrec_flow_table_col_name, NULL},
2381 {NULL, NULL, NULL}}},
2383 {NULL, {{NULL, NULL, NULL}, {NULL, NULL, NULL}}}
2387 die_if_error(char *error)
2390 vsctl_fatal("%s", error);
2395 to_lower_and_underscores(unsigned c)
2397 return c == '-' ? '_' : tolower(c);
2401 score_partial_match(const char *name, const char *s)
2405 if (!strcmp(name, s)) {
2408 for (score = 0; ; score++, name++, s++) {
2409 if (to_lower_and_underscores(*name) != to_lower_and_underscores(*s)) {
2411 } else if (*name == '\0') {
2412 return UINT_MAX - 1;
2415 return *s == '\0' ? score : 0;
2418 static const struct vsctl_table_class *
2419 get_table(const char *table_name)
2421 const struct vsctl_table_class *table;
2422 const struct vsctl_table_class *best_match = NULL;
2423 unsigned int best_score = 0;
2425 for (table = tables; table->class; table++) {
2426 unsigned int score = score_partial_match(table->class->name,
2428 if (score > best_score) {
2431 } else if (score == best_score) {
2437 } else if (best_score) {
2438 vsctl_fatal("multiple table names match \"%s\"", table_name);
2440 vsctl_fatal("unknown table \"%s\"", table_name);
2444 static const struct vsctl_table_class *
2445 pre_get_table(struct vsctl_context *ctx, const char *table_name)
2447 const struct vsctl_table_class *table_class;
2450 table_class = get_table(table_name);
2451 ovsdb_idl_add_table(ctx->idl, table_class->class);
2453 for (i = 0; i < ARRAY_SIZE(table_class->row_ids); i++) {
2454 const struct vsctl_row_id *id = &table_class->row_ids[i];
2456 ovsdb_idl_add_table(ctx->idl, id->table);
2458 if (id->name_column) {
2459 ovsdb_idl_add_column(ctx->idl, id->name_column);
2461 if (id->uuid_column) {
2462 ovsdb_idl_add_column(ctx->idl, id->uuid_column);
2469 static const struct ovsdb_idl_row *
2470 get_row_by_id(struct vsctl_context *ctx, const struct vsctl_table_class *table,
2471 const struct vsctl_row_id *id, const char *record_id)
2473 const struct ovsdb_idl_row *referrer, *final;
2479 if (!id->name_column) {
2480 if (strcmp(record_id, ".")) {
2483 referrer = ovsdb_idl_first_row(ctx->idl, id->table);
2484 if (!referrer || ovsdb_idl_next_row(referrer)) {
2488 const struct ovsdb_idl_row *row;
2491 for (row = ovsdb_idl_first_row(ctx->idl, id->table);
2493 row = ovsdb_idl_next_row(row))
2495 const struct ovsdb_datum *name;
2497 name = ovsdb_idl_get(row, id->name_column,
2498 OVSDB_TYPE_STRING, OVSDB_TYPE_VOID);
2499 if (name->n == 1 && !strcmp(name->keys[0].string, record_id)) {
2501 vsctl_fatal("multiple rows in %s match \"%s\"",
2502 table->class->name, record_id);
2513 if (id->uuid_column) {
2514 const struct ovsdb_datum *uuid;
2516 ovsdb_idl_txn_verify(referrer, id->uuid_column);
2517 uuid = ovsdb_idl_get(referrer, id->uuid_column,
2518 OVSDB_TYPE_UUID, OVSDB_TYPE_VOID);
2520 final = ovsdb_idl_get_row_for_uuid(ctx->idl, table->class,
2521 &uuid->keys[0].uuid);
2530 static const struct ovsdb_idl_row *
2531 get_row (struct vsctl_context *ctx,
2532 const struct vsctl_table_class *table, const char *record_id)
2534 const struct ovsdb_idl_row *row;
2537 if (uuid_from_string(&uuid, record_id)) {
2538 row = ovsdb_idl_get_row_for_uuid(ctx->idl, table->class, &uuid);
2542 for (i = 0; i < ARRAY_SIZE(table->row_ids); i++) {
2543 row = get_row_by_id(ctx, table, &table->row_ids[i], record_id);
2552 static const struct ovsdb_idl_row *
2553 must_get_row(struct vsctl_context *ctx,
2554 const struct vsctl_table_class *table, const char *record_id)
2556 const struct ovsdb_idl_row *row = get_row(ctx, table, record_id);
2558 vsctl_fatal("no row \"%s\" in table %s",
2559 record_id, table->class->name);
2565 get_column(const struct vsctl_table_class *table, const char *column_name,
2566 const struct ovsdb_idl_column **columnp)
2568 const struct ovsdb_idl_column *best_match = NULL;
2569 unsigned int best_score = 0;
2572 for (i = 0; i < table->class->n_columns; i++) {
2573 const struct ovsdb_idl_column *column = &table->class->columns[i];
2574 unsigned int score = score_partial_match(column->name, column_name);
2575 if (score > best_score) {
2576 best_match = column;
2578 } else if (score == best_score) {
2583 *columnp = best_match;
2586 } else if (best_score) {
2587 return xasprintf("%s contains more than one column whose name "
2588 "matches \"%s\"", table->class->name, column_name);
2590 return xasprintf("%s does not contain a column whose name matches "
2591 "\"%s\"", table->class->name, column_name);
2595 static struct ovsdb_symbol *
2596 create_symbol(struct ovsdb_symbol_table *symtab, const char *id, bool *newp)
2598 struct ovsdb_symbol *symbol;
2601 vsctl_fatal("row id \"%s\" does not begin with \"@\"", id);
2605 *newp = ovsdb_symbol_table_get(symtab, id) == NULL;
2608 symbol = ovsdb_symbol_table_insert(symtab, id);
2609 if (symbol->created) {
2610 vsctl_fatal("row id \"%s\" may only be specified on one --id option",
2613 symbol->created = true;
2618 pre_get_column(struct vsctl_context *ctx,
2619 const struct vsctl_table_class *table, const char *column_name,
2620 const struct ovsdb_idl_column **columnp)
2622 die_if_error(get_column(table, column_name, columnp));
2623 ovsdb_idl_add_column(ctx->idl, *columnp);
2627 missing_operator_error(const char *arg, const char **allowed_operators,
2633 ds_put_format(&s, "%s: argument does not end in ", arg);
2634 ds_put_format(&s, "\"%s\"", allowed_operators[0]);
2635 if (n_allowed == 2) {
2636 ds_put_format(&s, " or \"%s\"", allowed_operators[1]);
2637 } else if (n_allowed > 2) {
2640 for (i = 1; i < n_allowed - 1; i++) {
2641 ds_put_format(&s, ", \"%s\"", allowed_operators[i]);
2643 ds_put_format(&s, ", or \"%s\"", allowed_operators[i]);
2645 ds_put_format(&s, " followed by a value.");
2647 return ds_steal_cstr(&s);
2650 /* Breaks 'arg' apart into a number of fields in the following order:
2652 * - The name of a column in 'table', stored into '*columnp'. The column
2653 * name may be abbreviated.
2655 * - Optionally ':' followed by a key string. The key is stored as a
2656 * malloc()'d string into '*keyp', or NULL if no key is present in
2659 * - If 'valuep' is nonnull, an operator followed by a value string. The
2660 * allowed operators are the 'n_allowed' string in 'allowed_operators',
2661 * or just "=" if 'n_allowed' is 0. If 'operatorp' is nonnull, then the
2662 * index of the operator within 'allowed_operators' is stored into
2663 * '*operatorp'. The value is stored as a malloc()'d string into
2664 * '*valuep', or NULL if no value is present in 'arg'.
2666 * On success, returns NULL. On failure, returned a malloc()'d string error
2667 * message and stores NULL into all of the nonnull output arguments. */
2668 static char * WARN_UNUSED_RESULT
2669 parse_column_key_value(const char *arg,
2670 const struct vsctl_table_class *table,
2671 const struct ovsdb_idl_column **columnp, char **keyp,
2673 const char **allowed_operators, size_t n_allowed,
2676 const char *p = arg;
2680 assert(!(operatorp && !valuep));
2686 /* Parse column name. */
2687 error = ovsdb_token_parse(&p, &column_name);
2691 if (column_name[0] == '\0') {
2693 error = xasprintf("%s: missing column name", arg);
2696 error = get_column(table, column_name, columnp);
2702 /* Parse key string. */
2705 error = ovsdb_token_parse(&p, keyp);
2711 /* Parse value string. */
2717 if (!allowed_operators) {
2718 static const char *equals = "=";
2719 allowed_operators = =
2725 for (i = 0; i < n_allowed; i++) {
2726 const char *op = allowed_operators[i];
2727 size_t op_len = strlen(op);
2729 if (op_len > best_len && !strncmp(op, p, op_len) && p[op_len]) {
2735 error = missing_operator_error(arg, allowed_operators, n_allowed);
2742 *valuep = xstrdup(p + best_len);
2745 error = xasprintf("%s: trailing garbage \"%s\" in argument",
2767 pre_parse_column_key_value(struct vsctl_context *ctx,
2769 const struct vsctl_table_class *table)
2771 const struct ovsdb_idl_column *column;
2776 die_if_error(ovsdb_token_parse(&p, &column_name));
2777 if (column_name[0] == '\0') {
2778 vsctl_fatal("%s: missing column name", arg);
2781 pre_get_column(ctx, table, column_name, &column);
2786 pre_cmd_get(struct vsctl_context *ctx)
2788 const char *id = shash_find_data(&ctx->options, "--id");
2789 const char *table_name = ctx->argv[1];
2790 const struct vsctl_table_class *table;
2793 /* Using "get" without --id or a column name could possibly make sense.
2794 * Maybe, for example, a ovs-vsctl run wants to assert that a row exists.
2795 * But it is unlikely that an interactive user would want to do that, so
2796 * issue a warning if we're running on a terminal. */
2797 if (!id && ctx->argc <= 3 && isatty(STDOUT_FILENO)) {
2798 VLOG_WARN("\"get\" command without row arguments or \"--id\" is "
2799 "possibly erroneous");
2802 table = pre_get_table(ctx, table_name);
2803 for (i = 3; i < ctx->argc; i++) {
2804 if (!strcasecmp(ctx->argv[i], "_uuid")
2805 || !strcasecmp(ctx->argv[i], "-uuid")) {
2809 pre_parse_column_key_value(ctx, ctx->argv[i], table);
2814 cmd_get(struct vsctl_context *ctx)
2816 const char *id = shash_find_data(&ctx->options, "--id");
2817 bool if_exists = shash_find(&ctx->options, "--if-exists");
2818 const char *table_name = ctx->argv[1];
2819 const char *record_id = ctx->argv[2];
2820 const struct vsctl_table_class *table;
2821 const struct ovsdb_idl_row *row;
2822 struct ds *out = &ctx->output;
2825 table = get_table(table_name);
2826 row = must_get_row(ctx, table, record_id);
2828 struct ovsdb_symbol *symbol;
2831 symbol = create_symbol(ctx->symtab, id, &new);
2833 vsctl_fatal("row id \"%s\" specified on \"get\" command was used "
2834 "before it was defined", id);
2836 symbol->uuid = row->uuid;
2838 /* This symbol refers to a row that already exists, so disable warnings
2839 * about it being unreferenced. */
2840 symbol->strong_ref = true;
2842 for (i = 3; i < ctx->argc; i++) {
2843 const struct ovsdb_idl_column *column;
2844 const struct ovsdb_datum *datum;
2847 /* Special case for obtaining the UUID of a row. We can't just do this
2848 * through parse_column_key_value() below since it returns a "struct
2849 * ovsdb_idl_column" and the UUID column doesn't have one. */
2850 if (!strcasecmp(ctx->argv[i], "_uuid")
2851 || !strcasecmp(ctx->argv[i], "-uuid")) {
2852 ds_put_format(out, UUID_FMT"\n", UUID_ARGS(&row->uuid));
2856 die_if_error(parse_column_key_value(ctx->argv[i], table,
2857 &column, &key_string,
2858 NULL, NULL, 0, NULL));
2860 ovsdb_idl_txn_verify(row, column);
2861 datum = ovsdb_idl_read(row, column);
2863 union ovsdb_atom key;
2866 if (column->type.value.type == OVSDB_TYPE_VOID) {
2867 vsctl_fatal("cannot specify key to get for non-map column %s",
2871 die_if_error(ovsdb_atom_from_string(&key,
2873 key_string, ctx->symtab));
2875 idx = ovsdb_datum_find_key(datum, &key,
2876 column->type.key.type);
2877 if (idx == UINT_MAX) {
2879 vsctl_fatal("no key \"%s\" in %s record \"%s\" column %s",
2880 key_string, table->class->name, record_id,
2884 ovsdb_atom_to_string(&datum->values[idx],
2885 column->type.value.type, out);
2887 ovsdb_atom_destroy(&key, column->type.key.type);
2889 ovsdb_datum_to_string(datum, &column->type, out);
2891 ds_put_char(out, '\n');
2898 parse_column_names(const char *column_names,
2899 const struct vsctl_table_class *table,
2900 const struct ovsdb_idl_column ***columnsp,
2903 const struct ovsdb_idl_column **columns;
2906 if (!column_names) {
2909 n_columns = table->class->n_columns + 1;
2910 columns = xmalloc(n_columns * sizeof *columns);
2912 for (i = 0; i < table->class->n_columns; i++) {
2913 columns[i + 1] = &table->class->columns[i];
2916 char *s = xstrdup(column_names);
2917 size_t allocated_columns;
2918 char *save_ptr = NULL;
2922 allocated_columns = n_columns = 0;
2923 for (column_name = strtok_r(s, ", ", &save_ptr); column_name;
2924 column_name = strtok_r(NULL, ", ", &save_ptr)) {
2925 const struct ovsdb_idl_column *column;
2927 if (!strcasecmp(column_name, "_uuid")) {
2930 die_if_error(get_column(table, column_name, &column));
2932 if (n_columns >= allocated_columns) {
2933 columns = x2nrealloc(columns, &allocated_columns,
2936 columns[n_columns++] = column;
2941 vsctl_fatal("must specify at least one column name");
2944 *columnsp = columns;
2945 *n_columnsp = n_columns;
2950 pre_list_columns(struct vsctl_context *ctx,
2951 const struct vsctl_table_class *table,
2952 const char *column_names)
2954 const struct ovsdb_idl_column **columns;
2958 parse_column_names(column_names, table, &columns, &n_columns);
2959 for (i = 0; i < n_columns; i++) {
2961 ovsdb_idl_add_column(ctx->idl, columns[i]);
2968 pre_cmd_list(struct vsctl_context *ctx)
2970 const char *column_names = shash_find_data(&ctx->options, "--columns");
2971 const char *table_name = ctx->argv[1];
2972 const struct vsctl_table_class *table;
2974 table = pre_get_table(ctx, table_name);
2975 pre_list_columns(ctx, table, column_names);
2978 static struct table *
2979 list_make_table(const struct ovsdb_idl_column **columns, size_t n_columns)
2984 out = xmalloc(sizeof *out);
2987 for (i = 0; i < n_columns; i++) {
2988 const struct ovsdb_idl_column *column = columns[i];
2989 const char *column_name = column ? column->name : "_uuid";
2991 table_add_column(out, "%s", column_name);
2998 list_record(const struct ovsdb_idl_row *row,
2999 const struct ovsdb_idl_column **columns, size_t n_columns,
3005 for (i = 0; i < n_columns; i++) {
3006 const struct ovsdb_idl_column *column = columns[i];
3007 struct cell *cell = table_add_cell(out);
3010 struct ovsdb_datum datum;
3011 union ovsdb_atom atom;
3013 atom.uuid = row->uuid;
3016 datum.values = NULL;
3019 cell->json = ovsdb_datum_to_json(&datum, &ovsdb_type_uuid);
3020 cell->type = &ovsdb_type_uuid;
3022 const struct ovsdb_datum *datum = ovsdb_idl_read(row, column);
3024 cell->json = ovsdb_datum_to_json(datum, &column->type);
3025 cell->type = &column->type;
3031 cmd_list(struct vsctl_context *ctx)
3033 const char *column_names = shash_find_data(&ctx->options, "--columns");
3034 const struct ovsdb_idl_column **columns;
3035 const char *table_name = ctx->argv[1];
3036 const struct vsctl_table_class *table;
3041 table = get_table(table_name);
3042 parse_column_names(column_names, table, &columns, &n_columns);
3043 out = ctx->table = list_make_table(columns, n_columns);
3044 if (ctx->argc > 2) {
3045 for (i = 2; i < ctx->argc; i++) {
3046 list_record(must_get_row(ctx, table, ctx->argv[i]),
3047 columns, n_columns, out);
3050 const struct ovsdb_idl_row *row;
3052 for (row = ovsdb_idl_first_row(ctx->idl, table->class); row != NULL;
3053 row = ovsdb_idl_next_row(row)) {
3054 list_record(row, columns, n_columns, out);
3061 pre_cmd_find(struct vsctl_context *ctx)
3063 const char *column_names = shash_find_data(&ctx->options, "--columns");
3064 const char *table_name = ctx->argv[1];
3065 const struct vsctl_table_class *table;
3068 table = pre_get_table(ctx, table_name);
3069 pre_list_columns(ctx, table, column_names);
3070 for (i = 2; i < ctx->argc; i++) {
3071 pre_parse_column_key_value(ctx, ctx->argv[i], table);
3076 cmd_find(struct vsctl_context *ctx)
3078 const char *column_names = shash_find_data(&ctx->options, "--columns");
3079 const struct ovsdb_idl_column **columns;
3080 const char *table_name = ctx->argv[1];
3081 const struct vsctl_table_class *table;
3082 const struct ovsdb_idl_row *row;
3086 table = get_table(table_name);
3087 parse_column_names(column_names, table, &columns, &n_columns);
3088 out = ctx->table = list_make_table(columns, n_columns);
3089 for (row = ovsdb_idl_first_row(ctx->idl, table->class); row;
3090 row = ovsdb_idl_next_row(row)) {
3093 for (i = 2; i < ctx->argc; i++) {
3094 if (!is_condition_satisfied(table, row, ctx->argv[i],
3099 list_record(row, columns, n_columns, out);
3107 pre_cmd_set(struct vsctl_context *ctx)
3109 const char *table_name = ctx->argv[1];
3110 const struct vsctl_table_class *table;
3113 table = pre_get_table(ctx, table_name);
3114 for (i = 3; i < ctx->argc; i++) {
3115 pre_parse_column_key_value(ctx, ctx->argv[i], table);
3120 set_column(const struct vsctl_table_class *table,
3121 const struct ovsdb_idl_row *row, const char *arg,
3122 struct ovsdb_symbol_table *symtab)
3124 const struct ovsdb_idl_column *column;
3125 char *key_string, *value_string;
3128 error = parse_column_key_value(arg, table, &column, &key_string,
3129 NULL, NULL, 0, &value_string);
3130 die_if_error(error);
3131 if (!value_string) {
3132 vsctl_fatal("%s: missing value", arg);
3136 union ovsdb_atom key, value;
3137 struct ovsdb_datum datum;
3139 if (column->type.value.type == OVSDB_TYPE_VOID) {
3140 vsctl_fatal("cannot specify key to set for non-map column %s",
3144 die_if_error(ovsdb_atom_from_string(&key, &column->type.key,
3145 key_string, symtab));
3146 die_if_error(ovsdb_atom_from_string(&value, &column->type.value,
3147 value_string, symtab));
3149 ovsdb_datum_init_empty(&datum);
3150 ovsdb_datum_add_unsafe(&datum, &key, &value, &column->type);
3152 ovsdb_atom_destroy(&key, column->type.key.type);
3153 ovsdb_atom_destroy(&value, column->type.value.type);
3155 ovsdb_datum_union(&datum, ovsdb_idl_read(row, column),
3156 &column->type, false);
3157 ovsdb_idl_txn_write(row, column, &datum);
3159 struct ovsdb_datum datum;
3161 die_if_error(ovsdb_datum_from_string(&datum, &column->type,
3162 value_string, symtab));
3163 ovsdb_idl_txn_write(row, column, &datum);
3171 cmd_set(struct vsctl_context *ctx)
3173 const char *table_name = ctx->argv[1];
3174 const char *record_id = ctx->argv[2];
3175 const struct vsctl_table_class *table;
3176 const struct ovsdb_idl_row *row;
3179 table = get_table(table_name);
3180 row = must_get_row(ctx, table, record_id);
3181 for (i = 3; i < ctx->argc; i++) {
3182 set_column(table, row, ctx->argv[i], ctx->symtab);
3185 vsctl_context_invalidate_cache(ctx);
3189 pre_cmd_add(struct vsctl_context *ctx)
3191 const char *table_name = ctx->argv[1];
3192 const char *column_name = ctx->argv[3];
3193 const struct vsctl_table_class *table;
3194 const struct ovsdb_idl_column *column;
3196 table = pre_get_table(ctx, table_name);
3197 pre_get_column(ctx, table, column_name, &column);
3201 cmd_add(struct vsctl_context *ctx)
3203 const char *table_name = ctx->argv[1];
3204 const char *record_id = ctx->argv[2];
3205 const char *column_name = ctx->argv[3];
3206 const struct vsctl_table_class *table;
3207 const struct ovsdb_idl_column *column;
3208 const struct ovsdb_idl_row *row;
3209 const struct ovsdb_type *type;
3210 struct ovsdb_datum old;
3213 table = get_table(table_name);
3214 row = must_get_row(ctx, table, record_id);
3215 die_if_error(get_column(table, column_name, &column));
3217 type = &column->type;
3218 ovsdb_datum_clone(&old, ovsdb_idl_read(row, column), &column->type);
3219 for (i = 4; i < ctx->argc; i++) {
3220 struct ovsdb_type add_type;
3221 struct ovsdb_datum add;
3225 add_type.n_max = UINT_MAX;
3226 die_if_error(ovsdb_datum_from_string(&add, &add_type, ctx->argv[i],
3228 ovsdb_datum_union(&old, &add, type, false);
3229 ovsdb_datum_destroy(&add, type);
3231 if (old.n > type->n_max) {
3232 vsctl_fatal("\"add\" operation would put %u %s in column %s of "
3233 "table %s but the maximum number is %u",
3235 type->value.type == OVSDB_TYPE_VOID ? "values" : "pairs",
3236 column->name, table->class->name, type->n_max);
3238 ovsdb_idl_txn_verify(row, column);
3239 ovsdb_idl_txn_write(row, column, &old);
3241 vsctl_context_invalidate_cache(ctx);
3245 pre_cmd_remove(struct vsctl_context *ctx)
3247 const char *table_name = ctx->argv[1];
3248 const char *column_name = ctx->argv[3];
3249 const struct vsctl_table_class *table;
3250 const struct ovsdb_idl_column *column;
3252 table = pre_get_table(ctx, table_name);
3253 pre_get_column(ctx, table, column_name, &column);
3257 cmd_remove(struct vsctl_context *ctx)
3259 const char *table_name = ctx->argv[1];
3260 const char *record_id = ctx->argv[2];
3261 const char *column_name = ctx->argv[3];
3262 const struct vsctl_table_class *table;
3263 const struct ovsdb_idl_column *column;
3264 const struct ovsdb_idl_row *row;
3265 const struct ovsdb_type *type;
3266 struct ovsdb_datum old;
3269 table = get_table(table_name);
3270 row = must_get_row(ctx, table, record_id);
3271 die_if_error(get_column(table, column_name, &column));
3273 type = &column->type;
3274 ovsdb_datum_clone(&old, ovsdb_idl_read(row, column), &column->type);
3275 for (i = 4; i < ctx->argc; i++) {
3276 struct ovsdb_type rm_type;
3277 struct ovsdb_datum rm;
3282 rm_type.n_max = UINT_MAX;
3283 error = ovsdb_datum_from_string(&rm, &rm_type,
3284 ctx->argv[i], ctx->symtab);
3285 if (error && ovsdb_type_is_map(&rm_type)) {
3287 rm_type.value.type = OVSDB_TYPE_VOID;
3288 die_if_error(ovsdb_datum_from_string(&rm, &rm_type,
3289 ctx->argv[i], ctx->symtab));
3291 ovsdb_datum_subtract(&old, type, &rm, &rm_type);
3292 ovsdb_datum_destroy(&rm, &rm_type);
3294 if (old.n < type->n_min) {
3295 vsctl_fatal("\"remove\" operation would put %u %s in column %s of "
3296 "table %s but the minimum number is %u",
3298 type->value.type == OVSDB_TYPE_VOID ? "values" : "pairs",
3299 column->name, table->class->name, type->n_min);
3301 ovsdb_idl_txn_verify(row, column);
3302 ovsdb_idl_txn_write(row, column, &old);
3304 vsctl_context_invalidate_cache(ctx);
3308 pre_cmd_clear(struct vsctl_context *ctx)
3310 const char *table_name = ctx->argv[1];
3311 const struct vsctl_table_class *table;
3314 table = pre_get_table(ctx, table_name);
3315 for (i = 3; i < ctx->argc; i++) {
3316 const struct ovsdb_idl_column *column;
3318 pre_get_column(ctx, table, ctx->argv[i], &column);
3323 cmd_clear(struct vsctl_context *ctx)
3325 const char *table_name = ctx->argv[1];
3326 const char *record_id = ctx->argv[2];
3327 const struct vsctl_table_class *table;
3328 const struct ovsdb_idl_row *row;
3331 table = get_table(table_name);
3332 row = must_get_row(ctx, table, record_id);
3333 for (i = 3; i < ctx->argc; i++) {
3334 const struct ovsdb_idl_column *column;
3335 const struct ovsdb_type *type;
3336 struct ovsdb_datum datum;
3338 die_if_error(get_column(table, ctx->argv[i], &column));
3340 type = &column->type;
3341 if (type->n_min > 0) {
3342 vsctl_fatal("\"clear\" operation cannot be applied to column %s "
3343 "of table %s, which is not allowed to be empty",
3344 column->name, table->class->name);
3347 ovsdb_datum_init_empty(&datum);
3348 ovsdb_idl_txn_write(row, column, &datum);
3351 vsctl_context_invalidate_cache(ctx);
3355 pre_create(struct vsctl_context *ctx)
3357 const char *id = shash_find_data(&ctx->options, "--id");
3358 const char *table_name = ctx->argv[1];
3359 const struct vsctl_table_class *table;
3361 table = get_table(table_name);
3362 if (!id && !table->class->is_root) {
3363 VLOG_WARN("applying \"create\" command to table %s without --id "
3364 "option will have no effect", table->class->name);
3369 cmd_create(struct vsctl_context *ctx)
3371 const char *id = shash_find_data(&ctx->options, "--id");
3372 const char *table_name = ctx->argv[1];
3373 const struct vsctl_table_class *table = get_table(table_name);
3374 const struct ovsdb_idl_row *row;
3375 const struct uuid *uuid;
3379 struct ovsdb_symbol *symbol = create_symbol(ctx->symtab, id, NULL);
3380 if (table->class->is_root) {
3381 /* This table is in the root set, meaning that rows created in it
3382 * won't disappear even if they are unreferenced, so disable
3383 * warnings about that by pretending that there is a reference. */
3384 symbol->strong_ref = true;
3386 uuid = &symbol->uuid;
3391 row = ovsdb_idl_txn_insert(ctx->txn, table->class, uuid);
3392 for (i = 2; i < ctx->argc; i++) {
3393 set_column(table, row, ctx->argv[i], ctx->symtab);
3395 ds_put_format(&ctx->output, UUID_FMT, UUID_ARGS(&row->uuid));
3398 /* This function may be used as the 'postprocess' function for commands that
3399 * insert new rows into the database. It expects that the command's 'run'
3400 * function prints the UUID reported by ovsdb_idl_txn_insert() as the command's
3401 * sole output. It replaces that output by the row's permanent UUID assigned
3402 * by the database server and appends a new-line.
3404 * Currently we use this only for "create", because the higher-level commands
3405 * are supposed to be independent of the actual structure of the vswitch
3408 post_create(struct vsctl_context *ctx)
3410 const struct uuid *real;
3413 if (!uuid_from_string(&dummy, ds_cstr(&ctx->output))) {
3416 real = ovsdb_idl_txn_get_insert_uuid(ctx->txn, &dummy);
3418 ds_clear(&ctx->output);
3419 ds_put_format(&ctx->output, UUID_FMT, UUID_ARGS(real));
3421 ds_put_char(&ctx->output, '\n');
3425 pre_cmd_destroy(struct vsctl_context *ctx)
3427 const char *table_name = ctx->argv[1];
3429 pre_get_table(ctx, table_name);
3433 cmd_destroy(struct vsctl_context *ctx)
3435 bool must_exist = !shash_find(&ctx->options, "--if-exists");
3436 bool delete_all = shash_find(&ctx->options, "--all");
3437 const char *table_name = ctx->argv[1];
3438 const struct vsctl_table_class *table;
3441 table = get_table(table_name);
3443 if (delete_all && ctx->argc > 2) {
3444 vsctl_fatal("--all and records argument should not be specified together");
3447 if (delete_all && !must_exist) {
3448 vsctl_fatal("--all and --if-exists should not be specified together");
3452 const struct ovsdb_idl_row *row;
3453 const struct ovsdb_idl_row *next_row;
3455 for (row = ovsdb_idl_first_row(ctx->idl, table->class);
3457 next_row = ovsdb_idl_next_row(row);
3458 ovsdb_idl_txn_delete(row);
3462 for (i = 2; i < ctx->argc; i++) {
3463 const struct ovsdb_idl_row *row;
3465 row = (must_exist ? must_get_row : get_row)(ctx, table, ctx->argv[i]);
3467 ovsdb_idl_txn_delete(row);
3471 vsctl_context_invalidate_cache(ctx);
3475 RELOP(RELOP_EQ, "=") \
3476 RELOP(RELOP_NE, "!=") \
3477 RELOP(RELOP_LT, "<") \
3478 RELOP(RELOP_GT, ">") \
3479 RELOP(RELOP_LE, "<=") \
3480 RELOP(RELOP_GE, ">=") \
3481 RELOP(RELOP_SET_EQ, "{=}") \
3482 RELOP(RELOP_SET_NE, "{!=}") \
3483 RELOP(RELOP_SET_LT, "{<}") \
3484 RELOP(RELOP_SET_GT, "{>}") \
3485 RELOP(RELOP_SET_LE, "{<=}") \
3486 RELOP(RELOP_SET_GE, "{>=}")
3489 #define RELOP(ENUM, STRING) ENUM,
3495 is_set_operator(enum relop op)
3497 return (op == RELOP_SET_EQ || op == RELOP_SET_NE ||
3498 op == RELOP_SET_LT || op == RELOP_SET_GT ||
3499 op == RELOP_SET_LE || op == RELOP_SET_GE);
3503 evaluate_relop(const struct ovsdb_datum *a, const struct ovsdb_datum *b,
3504 const struct ovsdb_type *type, enum relop op)
3509 return ovsdb_datum_compare_3way(a, b, type) == 0;
3512 return ovsdb_datum_compare_3way(a, b, type) != 0;
3514 return ovsdb_datum_compare_3way(a, b, type) < 0;
3516 return ovsdb_datum_compare_3way(a, b, type) > 0;
3518 return ovsdb_datum_compare_3way(a, b, type) <= 0;
3520 return ovsdb_datum_compare_3way(a, b, type) >= 0;
3523 return b->n > a->n && ovsdb_datum_includes_all(a, b, type);
3525 return a->n > b->n && ovsdb_datum_includes_all(b, a, type);
3527 return ovsdb_datum_includes_all(a, b, type);
3529 return ovsdb_datum_includes_all(b, a, type);
3537 is_condition_satisfied(const struct vsctl_table_class *table,
3538 const struct ovsdb_idl_row *row, const char *arg,
3539 struct ovsdb_symbol_table *symtab)
3541 static const char *operators[] = {
3542 #define RELOP(ENUM, STRING) STRING,
3547 const struct ovsdb_idl_column *column;
3548 const struct ovsdb_datum *have_datum;
3549 char *key_string, *value_string;
3550 struct ovsdb_type type;
3555 error = parse_column_key_value(arg, table, &column, &key_string,
3556 &operator, operators, ARRAY_SIZE(operators),
3558 die_if_error(error);
3559 if (!value_string) {
3560 vsctl_fatal("%s: missing value", arg);
3563 type = column->type;
3564 type.n_max = UINT_MAX;
3566 have_datum = ovsdb_idl_read(row, column);
3568 union ovsdb_atom want_key;
3569 struct ovsdb_datum b;
3572 if (column->type.value.type == OVSDB_TYPE_VOID) {
3573 vsctl_fatal("cannot specify key to check for non-map column %s",
3577 die_if_error(ovsdb_atom_from_string(&want_key, &column->type.key,
3578 key_string, symtab));
3580 type.key = type.value;
3581 type.value.type = OVSDB_TYPE_VOID;
3582 die_if_error(ovsdb_datum_from_string(&b, &type, value_string, symtab));
3584 idx = ovsdb_datum_find_key(have_datum,
3585 &want_key, column->type.key.type);
3586 if (idx == UINT_MAX && !is_set_operator(operator)) {
3589 struct ovsdb_datum a;
3591 if (idx != UINT_MAX) {
3593 a.keys = &have_datum->values[idx];
3601 retval = evaluate_relop(&a, &b, &type, operator);
3604 ovsdb_atom_destroy(&want_key, column->type.key.type);
3605 ovsdb_datum_destroy(&b, &type);
3607 struct ovsdb_datum want_datum;
3609 die_if_error(ovsdb_datum_from_string(&want_datum, &column->type,
3610 value_string, symtab));
3611 retval = evaluate_relop(have_datum, &want_datum, &type, operator);
3612 ovsdb_datum_destroy(&want_datum, &column->type);
3622 pre_cmd_wait_until(struct vsctl_context *ctx)
3624 const char *table_name = ctx->argv[1];
3625 const struct vsctl_table_class *table;
3628 table = pre_get_table(ctx, table_name);
3630 for (i = 3; i < ctx->argc; i++) {
3631 pre_parse_column_key_value(ctx, ctx->argv[i], table);
3636 cmd_wait_until(struct vsctl_context *ctx)
3638 const char *table_name = ctx->argv[1];
3639 const char *record_id = ctx->argv[2];
3640 const struct vsctl_table_class *table;
3641 const struct ovsdb_idl_row *row;
3644 table = get_table(table_name);
3646 row = get_row(ctx, table, record_id);
3648 ctx->try_again = true;
3652 for (i = 3; i < ctx->argc; i++) {
3653 if (!is_condition_satisfied(table, row, ctx->argv[i], ctx->symtab)) {
3654 ctx->try_again = true;
3660 /* Prepares 'ctx', which has already been initialized with
3661 * vsctl_context_init(), for processing 'command'. */
3663 vsctl_context_init_command(struct vsctl_context *ctx,
3664 struct vsctl_command *command)
3666 ctx->argc = command->argc;
3667 ctx->argv = command->argv;
3668 ctx->options = command->options;
3670 ds_swap(&ctx->output, &command->output);
3671 ctx->table = command->table;
3673 ctx->verified_ports = false;
3675 ctx->try_again = false;
3678 /* Prepares 'ctx' for processing commands, initializing its members with the
3679 * values passed in as arguments.
3681 * If 'command' is nonnull, calls vsctl_context_init_command() to prepare for
3682 * that particular command. */
3684 vsctl_context_init(struct vsctl_context *ctx, struct vsctl_command *command,
3685 struct ovsdb_idl *idl, struct ovsdb_idl_txn *txn,
3686 const struct ovsrec_open_vswitch *ovs,
3687 struct ovsdb_symbol_table *symtab)
3690 vsctl_context_init_command(ctx, command);
3695 ctx->symtab = symtab;
3696 ctx->cache_valid = false;
3699 /* Completes processing of 'command' within 'ctx'. */
3701 vsctl_context_done_command(struct vsctl_context *ctx,
3702 struct vsctl_command *command)
3704 ds_swap(&ctx->output, &command->output);
3705 command->table = ctx->table;
3708 /* Finishes up with 'ctx'.
3710 * If command is nonnull, first calls vsctl_context_done_command() to complete
3711 * processing that command within 'ctx'. */
3713 vsctl_context_done(struct vsctl_context *ctx, struct vsctl_command *command)
3716 vsctl_context_done_command(ctx, command);
3718 vsctl_context_invalidate_cache(ctx);
3722 run_prerequisites(struct vsctl_command *commands, size_t n_commands,
3723 struct ovsdb_idl *idl)
3725 struct vsctl_command *c;
3727 ovsdb_idl_add_table(idl, &ovsrec_table_open_vswitch);
3728 if (wait_for_reload) {
3729 ovsdb_idl_add_column(idl, &ovsrec_open_vswitch_col_cur_cfg);
3731 for (c = commands; c < &commands[n_commands]; c++) {
3732 if (c->syntax->prerequisites) {
3733 struct vsctl_context ctx;
3735 ds_init(&c->output);
3738 vsctl_context_init(&ctx, c, idl, NULL, NULL, NULL);
3739 (c->syntax->prerequisites)(&ctx);
3740 vsctl_context_done(&ctx, c);
3742 assert(!c->output.string);
3749 do_vsctl(const char *args, struct vsctl_command *commands, size_t n_commands,
3750 struct ovsdb_idl *idl)
3752 struct ovsdb_idl_txn *txn;
3753 const struct ovsrec_open_vswitch *ovs;
3754 enum ovsdb_idl_txn_status status;
3755 struct ovsdb_symbol_table *symtab;
3756 struct vsctl_context ctx;
3757 struct vsctl_command *c;
3758 struct shash_node *node;
3759 int64_t next_cfg = 0;
3762 txn = the_idl_txn = ovsdb_idl_txn_create(idl);
3764 ovsdb_idl_txn_set_dry_run(txn);
3767 ovsdb_idl_txn_add_comment(txn, "ovs-vsctl: %s", args);
3769 ovs = ovsrec_open_vswitch_first(idl);
3771 /* XXX add verification that table is empty */
3772 ovs = ovsrec_open_vswitch_insert(txn);
3775 if (wait_for_reload) {
3776 ovsdb_idl_txn_increment(txn, &ovs->header_,
3777 &ovsrec_open_vswitch_col_next_cfg);
3780 symtab = ovsdb_symbol_table_create();
3781 for (c = commands; c < &commands[n_commands]; c++) {
3782 ds_init(&c->output);
3785 vsctl_context_init(&ctx, NULL, idl, txn, ovs, symtab);
3786 for (c = commands; c < &commands[n_commands]; c++) {
3787 vsctl_context_init_command(&ctx, c);
3788 if (c->syntax->run) {
3789 (c->syntax->run)(&ctx);
3791 vsctl_context_done_command(&ctx, c);
3793 if (ctx.try_again) {
3794 vsctl_context_done(&ctx, NULL);
3798 vsctl_context_done(&ctx, NULL);
3800 SHASH_FOR_EACH (node, &symtab->sh) {
3801 struct ovsdb_symbol *symbol = node->data;
3802 if (!symbol->created) {
3803 vsctl_fatal("row id \"%s\" is referenced but never created (e.g. "
3804 "with \"-- --id=%s create ...\")",
3805 node->name, node->name);
3807 if (!symbol->strong_ref) {
3808 if (!symbol->weak_ref) {
3809 VLOG_WARN("row id \"%s\" was created but no reference to it "
3810 "was inserted, so it will not actually appear in "
3811 "the database", node->name);
3813 VLOG_WARN("row id \"%s\" was created but only a weak "
3814 "reference to it was inserted, so it will not "
3815 "actually appear in the database", node->name);
3820 status = ovsdb_idl_txn_commit_block(txn);
3821 if (wait_for_reload && status == TXN_SUCCESS) {
3822 next_cfg = ovsdb_idl_txn_get_increment_new_value(txn);
3824 if (status == TXN_UNCHANGED || status == TXN_SUCCESS) {
3825 for (c = commands; c < &commands[n_commands]; c++) {
3826 if (c->syntax->postprocess) {
3827 struct vsctl_context ctx;
3829 vsctl_context_init(&ctx, c, idl, txn, ovs, symtab);
3830 (c->syntax->postprocess)(&ctx);
3831 vsctl_context_done(&ctx, c);
3835 error = xstrdup(ovsdb_idl_txn_get_error(txn));
3836 ovsdb_idl_txn_destroy(txn);
3837 txn = the_idl_txn = NULL;
3840 case TXN_UNCOMMITTED:
3841 case TXN_INCOMPLETE:
3845 /* Should not happen--we never call ovsdb_idl_txn_abort(). */
3846 vsctl_fatal("transaction aborted");
3856 vsctl_fatal("transaction error: %s", error);
3858 case TXN_NOT_LOCKED:
3859 /* Should not happen--we never call ovsdb_idl_set_lock(). */
3860 vsctl_fatal("database not locked");
3867 ovsdb_symbol_table_destroy(symtab);
3869 for (c = commands; c < &commands[n_commands]; c++) {
3870 struct ds *ds = &c->output;
3873 table_print(c->table, &table_style);
3874 } else if (oneline) {
3878 for (j = 0; j < ds->length; j++) {
3879 int ch = ds->string[j];
3882 fputs("\\n", stdout);
3886 fputs("\\\\", stdout);
3895 fputs(ds_cstr(ds), stdout);
3897 ds_destroy(&c->output);
3898 table_destroy(c->table);
3901 shash_destroy_free_data(&c->options);
3905 if (wait_for_reload && status != TXN_UNCHANGED) {
3908 OVSREC_OPEN_VSWITCH_FOR_EACH (ovs, idl) {
3909 if (ovs->cur_cfg >= next_cfg) {
3913 ovsdb_idl_wait(idl);
3918 ovsdb_idl_destroy(idl);
3923 /* Our transaction needs to be rerun, or a prerequisite was not met. Free
3924 * resources and return so that the caller can try again. */
3926 ovsdb_idl_txn_abort(txn);
3927 ovsdb_idl_txn_destroy(txn);
3929 ovsdb_symbol_table_destroy(symtab);
3930 for (c = commands; c < &commands[n_commands]; c++) {
3931 ds_destroy(&c->output);
3932 table_destroy(c->table);
3938 static const struct vsctl_command_syntax all_commands[] = {
3939 /* Open vSwitch commands. */
3940 {"init", 0, 0, NULL, cmd_init, NULL, "", RW},
3941 {"show", 0, 0, pre_cmd_show, cmd_show, NULL, "", RO},
3943 /* Bridge commands. */
3944 {"add-br", 1, 3, pre_get_info, cmd_add_br, NULL, "--may-exist", RW},
3945 {"del-br", 1, 1, pre_get_info, cmd_del_br, NULL, "--if-exists", RW},
3946 {"list-br", 0, 0, pre_get_info, cmd_list_br, NULL, "", RO},
3947 {"br-exists", 1, 1, pre_get_info, cmd_br_exists, NULL, "", RO},
3948 {"br-to-vlan", 1, 1, pre_get_info, cmd_br_to_vlan, NULL, "", RO},
3949 {"br-to-parent", 1, 1, pre_get_info, cmd_br_to_parent, NULL, "", RO},
3950 {"br-set-external-id", 2, 3, pre_cmd_br_set_external_id,
3951 cmd_br_set_external_id, NULL, "", RW},
3952 {"br-get-external-id", 1, 2, pre_cmd_br_get_external_id,
3953 cmd_br_get_external_id, NULL, "", RO},
3955 /* Port commands. */
3956 {"list-ports", 1, 1, pre_get_info, cmd_list_ports, NULL, "", RO},
3957 {"add-port", 2, INT_MAX, pre_get_info, cmd_add_port, NULL, "--may-exist",
3959 {"add-bond", 4, INT_MAX, pre_get_info, cmd_add_bond, NULL,
3960 "--may-exist,--fake-iface", RW},
3961 {"del-port", 1, 2, pre_get_info, cmd_del_port, NULL,
3962 "--if-exists,--with-iface", RW},
3963 {"port-to-br", 1, 1, pre_get_info, cmd_port_to_br, NULL, "", RO},
3965 /* Interface commands. */
3966 {"list-ifaces", 1, 1, pre_get_info, cmd_list_ifaces, NULL, "", RO},
3967 {"iface-to-br", 1, 1, pre_get_info, cmd_iface_to_br, NULL, "", RO},
3969 /* Controller commands. */
3970 {"get-controller", 1, 1, pre_controller, cmd_get_controller, NULL, "", RO},
3971 {"del-controller", 1, 1, pre_controller, cmd_del_controller, NULL, "", RW},
3972 {"set-controller", 1, INT_MAX, pre_controller, cmd_set_controller, NULL,
3974 {"get-fail-mode", 1, 1, pre_get_info, cmd_get_fail_mode, NULL, "", RO},
3975 {"del-fail-mode", 1, 1, pre_get_info, cmd_del_fail_mode, NULL, "", RW},
3976 {"set-fail-mode", 2, 2, pre_get_info, cmd_set_fail_mode, NULL, "", RW},
3978 /* Manager commands. */
3979 {"get-manager", 0, 0, pre_manager, cmd_get_manager, NULL, "", RO},
3980 {"del-manager", 0, INT_MAX, pre_manager, cmd_del_manager, NULL, "", RW},
3981 {"set-manager", 1, INT_MAX, pre_manager, cmd_set_manager, NULL, "", RW},
3984 {"get-ssl", 0, 0, pre_cmd_get_ssl, cmd_get_ssl, NULL, "", RO},
3985 {"del-ssl", 0, 0, pre_cmd_del_ssl, cmd_del_ssl, NULL, "", RW},
3986 {"set-ssl", 3, 3, pre_cmd_set_ssl, cmd_set_ssl, NULL, "--bootstrap", RW},
3988 /* Switch commands. */
3989 {"emer-reset", 0, 0, pre_cmd_emer_reset, cmd_emer_reset, NULL, "", RW},
3991 /* Database commands. */
3992 {"comment", 0, INT_MAX, NULL, NULL, NULL, "", RO},
3993 {"get", 2, INT_MAX, pre_cmd_get, cmd_get, NULL, "--if-exists,--id=", RO},
3994 {"list", 1, INT_MAX, pre_cmd_list, cmd_list, NULL, "--columns=", RO},
3995 {"find", 1, INT_MAX, pre_cmd_find, cmd_find, NULL, "--columns=", RO},
3996 {"set", 3, INT_MAX, pre_cmd_set, cmd_set, NULL, "", RW},
3997 {"add", 4, INT_MAX, pre_cmd_add, cmd_add, NULL, "", RW},
3998 {"remove", 4, INT_MAX, pre_cmd_remove, cmd_remove, NULL, "", RW},
3999 {"clear", 3, INT_MAX, pre_cmd_clear, cmd_clear, NULL, "", RW},
4000 {"create", 2, INT_MAX, pre_create, cmd_create, post_create, "--id=", RW},
4001 {"destroy", 1, INT_MAX, pre_cmd_destroy, cmd_destroy, NULL,
4002 "--if-exists,--all", RW},
4003 {"wait-until", 2, INT_MAX, pre_cmd_wait_until, cmd_wait_until, NULL, "",
4006 {NULL, 0, 0, NULL, NULL, NULL, NULL, RO},