2 * Copyright (c) 2009, 2010, 2011, 2012 Nicira Networks.
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"
36 #include "ovsdb-data.h"
37 #include "ovsdb-idl.h"
38 #include "poll-loop.h"
41 #include "stream-ssl.h"
44 #include "lib/vswitch-idl.h"
51 VLOG_DEFINE_THIS_MODULE(vsctl);
53 /* vsctl_fatal() also logs the error, so it is preferred in this file. */
54 #define ovs_fatal please_use_vsctl_fatal_instead_of_ovs_fatal
58 /* A command supported by ovs-vsctl. */
59 struct vsctl_command_syntax {
60 const char *name; /* e.g. "add-br" */
61 int min_args; /* Min number of arguments following name. */
62 int max_args; /* Max number of arguments following name. */
64 /* If nonnull, calls ovsdb_idl_add_column() or ovsdb_idl_add_table() for
65 * each column or table in ctx->idl that it uses. */
66 void (*prerequisites)(struct vsctl_context *ctx);
68 /* Does the actual work of the command and puts the command's output, if
69 * any, in ctx->output or ctx->table.
71 * Alternatively, if some prerequisite of the command is not met and the
72 * caller should wait for something to change and then retry, it may set
73 * ctx->try_again to true. (Only the "wait-until" command currently does
75 void (*run)(struct vsctl_context *ctx);
77 /* If nonnull, called after the transaction has been successfully
78 * committed. ctx->output is the output from the "run" function, which
79 * this function may modify and otherwise postprocess as needed. (Only the
80 * "create" command currently does any postprocessing.) */
81 void (*postprocess)(struct vsctl_context *ctx);
83 /* A comma-separated list of supported options, e.g. "--a,--b", or the
84 * empty string if the command does not support any options. */
86 enum { RO, RW } mode; /* Does this command modify the database? */
89 struct vsctl_command {
90 /* Data that remains constant after initialization. */
91 const struct vsctl_command_syntax *syntax;
96 /* Data modified by commands. */
101 /* --db: The database server to contact. */
102 static const char *db;
104 /* --oneline: Write each command's output as a single line? */
107 /* --dry-run: Do not commit any changes. */
110 /* --no-wait: Wait for ovs-vswitchd to reload its configuration? */
111 static bool wait_for_reload = true;
113 /* --timeout: Time to wait for a connection to 'db'. */
116 /* Format for table output. */
117 static struct table_style table_style = TABLE_STYLE_DEFAULT;
119 /* All supported commands. */
120 static const struct vsctl_command_syntax all_commands[];
122 /* The IDL we're using and the current transaction, if any.
123 * This is for use by vsctl_exit() only, to allow it to clean up.
124 * Other code should use its context arguments. */
125 static struct ovsdb_idl *the_idl;
126 static struct ovsdb_idl_txn *the_idl_txn;
128 static void vsctl_exit(int status) NO_RETURN;
129 static void vsctl_fatal(const char *, ...) PRINTF_FORMAT(1, 2) NO_RETURN;
130 static char *default_db(void);
131 static void usage(void) NO_RETURN;
132 static void parse_options(int argc, char *argv[]);
133 static bool might_write_to_db(char **argv);
135 static struct vsctl_command *parse_commands(int argc, char *argv[],
136 size_t *n_commandsp);
137 static void parse_command(int argc, char *argv[], struct vsctl_command *);
138 static const struct vsctl_command_syntax *find_command(const char *name);
139 static void run_prerequisites(struct vsctl_command[], size_t n_commands,
141 static void do_vsctl(const char *args, struct vsctl_command *, size_t n,
144 static const struct vsctl_table_class *get_table(const char *table_name);
145 static void set_column(const struct vsctl_table_class *,
146 const struct ovsdb_idl_row *, const char *arg,
147 struct ovsdb_symbol_table *);
149 static bool is_condition_satisfied(const struct vsctl_table_class *,
150 const struct ovsdb_idl_row *,
152 struct ovsdb_symbol_table *);
155 main(int argc, char *argv[])
157 extern struct vlog_module VLM_reconnect;
158 struct ovsdb_idl *idl;
159 struct vsctl_command *commands;
164 set_program_name(argv[0]);
165 signal(SIGPIPE, SIG_IGN);
166 vlog_set_levels(NULL, VLF_CONSOLE, VLL_WARN);
167 vlog_set_levels(&VLM_reconnect, VLF_ANY_FACILITY, VLL_WARN);
170 /* Log our arguments. This is often valuable for debugging systems. */
171 args = process_escape_args(argv);
172 VLOG(might_write_to_db(argv) ? VLL_INFO : VLL_DBG, "Called as %s", args);
174 /* Parse command line. */
175 parse_options(argc, argv);
176 commands = parse_commands(argc - optind, argv + optind, &n_commands);
182 /* Initialize IDL. */
183 idl = the_idl = ovsdb_idl_create(db, &ovsrec_idl_class, false);
184 run_prerequisites(commands, n_commands, idl);
186 /* Execute the commands.
188 * 'seqno' is the database sequence number for which we last tried to
189 * execute our transaction. There's no point in trying to commit more than
190 * once for any given sequence number, because if the transaction fails
191 * it's because the database changed and we need to obtain an up-to-date
192 * view of the database before we try the transaction again. */
193 seqno = ovsdb_idl_get_seqno(idl);
197 if (seqno != ovsdb_idl_get_seqno(idl)) {
198 seqno = ovsdb_idl_get_seqno(idl);
199 do_vsctl(args, commands, n_commands, idl);
202 if (seqno == ovsdb_idl_get_seqno(idl)) {
210 parse_options(int argc, char *argv[])
213 OPT_DB = UCHAR_MAX + 1,
222 static struct option long_options[] = {
223 {"db", required_argument, NULL, OPT_DB},
224 {"no-syslog", no_argument, NULL, OPT_NO_SYSLOG},
225 {"no-wait", no_argument, NULL, OPT_NO_WAIT},
226 {"dry-run", no_argument, NULL, OPT_DRY_RUN},
227 {"oneline", no_argument, NULL, OPT_ONELINE},
228 {"timeout", required_argument, NULL, 't'},
229 {"help", no_argument, NULL, 'h'},
230 {"version", no_argument, NULL, 'V'},
233 STREAM_SSL_LONG_OPTIONS,
234 {"peer-ca-cert", required_argument, NULL, OPT_PEER_CA_CERT},
237 char *tmp, *short_options;
239 tmp = long_options_to_short_options(long_options);
240 short_options = xasprintf("+%s", tmp);
243 table_style.format = TF_LIST;
248 c = getopt_long(argc, argv, short_options, long_options, NULL);
263 vlog_set_levels(&VLM_vsctl, VLF_SYSLOG, VLL_WARN);
267 wait_for_reload = false;
278 ovs_print_version(0, 0);
282 timeout = strtoul(optarg, NULL, 10);
284 vsctl_fatal("value %s on -t or --timeout is invalid",
290 TABLE_OPTION_HANDLERS(&table_style)
292 STREAM_SSL_OPTION_HANDLERS
294 case OPT_PEER_CA_CERT:
295 stream_ssl_set_peer_ca_cert_file(optarg);
312 static struct vsctl_command *
313 parse_commands(int argc, char *argv[], size_t *n_commandsp)
315 struct vsctl_command *commands;
316 size_t n_commands, allocated_commands;
320 n_commands = allocated_commands = 0;
322 for (start = i = 0; i <= argc; i++) {
323 if (i == argc || !strcmp(argv[i], "--")) {
325 if (n_commands >= allocated_commands) {
326 struct vsctl_command *c;
328 commands = x2nrealloc(commands, &allocated_commands,
330 for (c = commands; c < &commands[n_commands]; c++) {
331 shash_moved(&c->options);
334 parse_command(i - start, &argv[start],
335 &commands[n_commands++]);
341 vsctl_fatal("missing command name (use --help for help)");
343 *n_commandsp = n_commands;
348 parse_command(int argc, char *argv[], struct vsctl_command *command)
350 const struct vsctl_command_syntax *p;
351 struct shash_node *node;
355 shash_init(&command->options);
356 for (i = 0; i < argc; i++) {
357 const char *option = argv[i];
361 if (option[0] != '-') {
365 equals = strchr(option, '=');
367 key = xmemdup0(option, equals - option);
368 value = xstrdup(equals + 1);
370 key = xstrdup(option);
374 if (shash_find(&command->options, key)) {
375 vsctl_fatal("'%s' option specified multiple times", argv[i]);
377 shash_add_nocopy(&command->options, key, value);
380 vsctl_fatal("missing command name");
383 p = find_command(argv[i]);
385 vsctl_fatal("unknown command '%s'; use --help for help", argv[i]);
388 SHASH_FOR_EACH (node, &command->options) {
389 const char *s = strstr(p->options, node->name);
390 int end = s ? s[strlen(node->name)] : EOF;
392 if (end != '=' && end != ',' && end != ' ' && end != '\0') {
393 vsctl_fatal("'%s' command has no '%s' option",
394 argv[i], node->name);
396 if ((end == '=') != (node->data != NULL)) {
398 vsctl_fatal("missing argument to '%s' option on '%s' "
399 "command", node->name, argv[i]);
401 vsctl_fatal("'%s' option on '%s' does not accept an "
402 "argument", node->name, argv[i]);
407 n_arg = argc - i - 1;
408 if (n_arg < p->min_args) {
409 vsctl_fatal("'%s' command requires at least %d arguments",
410 p->name, p->min_args);
411 } else if (n_arg > p->max_args) {
414 for (j = i + 1; j < argc; j++) {
415 if (argv[j][0] == '-') {
416 vsctl_fatal("'%s' command takes at most %d arguments "
417 "(note that options must precede command "
418 "names and follow a \"--\" argument)",
419 p->name, p->max_args);
423 vsctl_fatal("'%s' command takes at most %d arguments",
424 p->name, p->max_args);
428 command->argc = n_arg + 1;
429 command->argv = &argv[i];
432 /* Returns the "struct vsctl_command_syntax" for a given command 'name', or a
433 * null pointer if there is none. */
434 static const struct vsctl_command_syntax *
435 find_command(const char *name)
437 static struct shash commands = SHASH_INITIALIZER(&commands);
439 if (shash_is_empty(&commands)) {
440 const struct vsctl_command_syntax *p;
442 for (p = all_commands; p->name; p++) {
443 shash_add_assert(&commands, p->name, p);
447 return shash_find_data(&commands, name);
451 vsctl_fatal(const char *format, ...)
456 va_start(args, format);
457 message = xvasprintf(format, args);
460 vlog_set_levels(&VLM_vsctl, VLF_CONSOLE, VLL_OFF);
461 VLOG_ERR("%s", message);
462 ovs_error(0, "%s", message);
463 vsctl_exit(EXIT_FAILURE);
466 /* Frees the current transaction and the underlying IDL and then calls
469 * Freeing the transaction and the IDL is not strictly necessary, but it makes
470 * for a clean memory leak report from valgrind in the normal case. That makes
471 * it easier to notice real memory leaks. */
473 vsctl_exit(int status)
476 ovsdb_idl_txn_abort(the_idl_txn);
477 ovsdb_idl_txn_destroy(the_idl_txn);
479 ovsdb_idl_destroy(the_idl);
487 %s: ovs-vswitchd management utility\n\
488 usage: %s [OPTIONS] COMMAND [ARG...]\n\
490 Open vSwitch commands:\n\
491 init initialize database, if not yet initialized\n\
492 show print overview of database contents\n\
493 emer-reset reset configuration to clean state\n\
496 add-br BRIDGE create a new bridge named BRIDGE\n\
497 add-br BRIDGE PARENT VLAN create new fake BRIDGE in PARENT on VLAN\n\
498 del-br BRIDGE delete BRIDGE and all of its ports\n\
499 list-br print the names of all the bridges\n\
500 br-exists BRIDGE exit 2 if BRIDGE does not exist\n\
501 br-to-vlan BRIDGE print the VLAN which BRIDGE is on\n\
502 br-to-parent BRIDGE print the parent of BRIDGE\n\
503 br-set-external-id BRIDGE KEY VALUE set KEY on BRIDGE to VALUE\n\
504 br-set-external-id BRIDGE KEY unset KEY on BRIDGE\n\
505 br-get-external-id BRIDGE KEY print value of KEY on BRIDGE\n\
506 br-get-external-id BRIDGE list key-value pairs on BRIDGE\n\
508 Port commands (a bond is considered to be a single port):\n\
509 list-ports BRIDGE print the names of all the ports on BRIDGE\n\
510 add-port BRIDGE PORT add network device PORT to BRIDGE\n\
511 add-bond BRIDGE PORT IFACE... add bonded port PORT in BRIDGE from IFACES\n\
512 del-port [BRIDGE] PORT delete PORT (which may be bonded) from BRIDGE\n\
513 port-to-br PORT print name of bridge that contains PORT\n\
515 Interface commands (a bond consists of multiple interfaces):\n\
516 list-ifaces BRIDGE print the names of all interfaces on BRIDGE\n\
517 iface-to-br IFACE print name of bridge that contains IFACE\n\
519 Controller commands:\n\
520 get-controller BRIDGE print the controllers for BRIDGE\n\
521 del-controller BRIDGE delete the controllers for BRIDGE\n\
522 set-controller BRIDGE TARGET... set the controllers for BRIDGE\n\
523 get-fail-mode BRIDGE print the fail-mode for BRIDGE\n\
524 del-fail-mode BRIDGE delete the fail-mode for BRIDGE\n\
525 set-fail-mode BRIDGE MODE set the fail-mode for BRIDGE to MODE\n\
528 get-manager print the managers\n\
529 del-manager delete the managers\n\
530 set-manager TARGET... set the list of managers to TARGET...\n\
533 get-ssl print the SSL configuration\n\
534 del-ssl delete the SSL configuration\n\
535 set-ssl PRIV-KEY CERT CA-CERT set the SSL configuration\n\
538 emer-reset reset switch to known good state\n\
540 Database commands:\n\
541 list TBL [REC] list RECord (or all records) in TBL\n\
542 find TBL CONDITION... list records satisfying CONDITION in TBL\n\
543 get TBL REC COL[:KEY] print values of COLumns in RECord in TBL\n\
544 set TBL REC COL[:KEY]=VALUE set COLumn values in RECord in TBL\n\
545 add TBL REC COL [KEY=]VALUE add (KEY=)VALUE to COLumn in RECord in TBL\n\
546 remove TBL REC COL [KEY=]VALUE remove (KEY=)VALUE from COLumn\n\
547 clear TBL REC COL clear values from COLumn in RECord in TBL\n\
548 create TBL COL[:KEY]=VALUE create and initialize new record\n\
549 destroy TBL REC delete RECord from TBL\n\
550 wait-until TBL REC [COL[:KEY]=VALUE] wait until condition is true\n\
551 Potentially unsafe database commands require --force option.\n\
554 --db=DATABASE connect to DATABASE\n\
556 --no-wait do not wait for ovs-vswitchd to reconfigure\n\
557 -t, --timeout=SECS wait at most SECS seconds for ovs-vswitchd\n\
558 --dry-run do not commit changes to database\n\
559 --oneline print exactly one line of output per command\n",
560 program_name, program_name, default_db());
563 --no-syslog equivalent to --verbose=vsctl:syslog:warn\n");
564 stream_usage("database", true, true, false);
567 -h, --help display this help message\n\
568 -V, --version display version information\n");
577 def = xasprintf("unix:%s/db.sock", ovs_rundir());
582 /* Returns true if it looks like this set of arguments might modify the
583 * database, otherwise false. (Not very smart, so it's prone to false
586 might_write_to_db(char **argv)
588 for (; *argv; argv++) {
589 const struct vsctl_command_syntax *p = find_command(*argv);
590 if (p && p->mode == RW) {
597 struct vsctl_context {
601 struct shash options;
603 /* Modifiable state. */
606 struct ovsdb_idl *idl;
607 struct ovsdb_idl_txn *txn;
608 struct ovsdb_symbol_table *symtab;
609 const struct ovsrec_open_vswitch *ovs;
612 /* A command may set this member to true if some prerequisite is not met
613 * and the caller should wait for something to change and then retry. */
617 struct vsctl_bridge {
618 struct ovsrec_bridge *br_cfg;
620 struct ovsrec_controller **ctrl;
624 /* VLAN ("fake") bridge support.
626 * Use 'parent != NULL' to detect a fake bridge, because 'vlan' can be 0
628 struct vsctl_bridge *parent; /* Real bridge, or NULL. */
629 int vlan; /* VLAN VID (0...4095), or 0. */
633 struct ovsrec_port *port_cfg;
634 struct vsctl_bridge *bridge;
638 struct ovsrec_interface *iface_cfg;
639 struct vsctl_port *port;
643 struct vsctl_context *ctx;
644 struct shash bridges; /* Maps from bridge name to struct vsctl_bridge. */
645 struct shash ports; /* Maps from port name to struct vsctl_port. */
646 struct shash ifaces; /* Maps from port name to struct vsctl_iface. */
650 vsctl_context_to_string(const struct vsctl_context *ctx)
652 const struct shash_node *node;
658 SHASH_FOR_EACH (node, &ctx->options) {
659 svec_add(&words, node->name);
661 for (i = 0; i < ctx->argc; i++) {
662 svec_add(&words, ctx->argv[i]);
664 svec_terminate(&words);
666 s = process_escape_args(words.names);
668 svec_destroy(&words);
674 verify_ports(struct vsctl_context *ctx)
676 if (!ctx->verified_ports) {
677 const struct ovsrec_bridge *bridge;
678 const struct ovsrec_port *port;
680 ovsrec_open_vswitch_verify_bridges(ctx->ovs);
681 OVSREC_BRIDGE_FOR_EACH (bridge, ctx->idl) {
682 ovsrec_bridge_verify_ports(bridge);
684 OVSREC_PORT_FOR_EACH (port, ctx->idl) {
685 ovsrec_port_verify_interfaces(port);
688 ctx->verified_ports = true;
692 static struct vsctl_bridge *
693 add_bridge(struct vsctl_info *b,
694 struct ovsrec_bridge *br_cfg, const char *name,
695 struct vsctl_bridge *parent, int vlan)
697 struct vsctl_bridge *br = xmalloc(sizeof *br);
699 br->name = xstrdup(name);
703 br->ctrl = parent->br_cfg->controller;
704 br->n_ctrl = parent->br_cfg->n_controller;
705 br->fail_mode = parent->br_cfg->fail_mode;
707 br->ctrl = br_cfg->controller;
708 br->n_ctrl = br_cfg->n_controller;
709 br->fail_mode = br_cfg->fail_mode;
711 shash_add(&b->bridges, br->name, br);
716 port_is_fake_bridge(const struct ovsrec_port *port_cfg)
718 return (port_cfg->fake_bridge
720 && *port_cfg->tag >= 0 && *port_cfg->tag <= 4095);
723 static struct vsctl_bridge *
724 find_vlan_bridge(struct vsctl_info *info,
725 struct vsctl_bridge *parent, int vlan)
727 struct shash_node *node;
729 SHASH_FOR_EACH (node, &info->bridges) {
730 struct vsctl_bridge *br = node->data;
731 if (br->parent == parent && br->vlan == vlan) {
740 free_info(struct vsctl_info *info)
742 struct shash_node *node;
744 SHASH_FOR_EACH (node, &info->bridges) {
745 struct vsctl_bridge *bridge = node->data;
749 shash_destroy(&info->bridges);
751 shash_destroy_free_data(&info->ports);
752 shash_destroy_free_data(&info->ifaces);
756 pre_get_info(struct vsctl_context *ctx)
758 ovsdb_idl_add_column(ctx->idl, &ovsrec_open_vswitch_col_bridges);
760 ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_name);
761 ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_controller);
762 ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_fail_mode);
763 ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_ports);
765 ovsdb_idl_add_column(ctx->idl, &ovsrec_port_col_name);
766 ovsdb_idl_add_column(ctx->idl, &ovsrec_port_col_fake_bridge);
767 ovsdb_idl_add_column(ctx->idl, &ovsrec_port_col_tag);
768 ovsdb_idl_add_column(ctx->idl, &ovsrec_port_col_interfaces);
770 ovsdb_idl_add_column(ctx->idl, &ovsrec_interface_col_name);
774 get_info(struct vsctl_context *ctx, struct vsctl_info *info)
776 const struct ovsrec_open_vswitch *ovs = ctx->ovs;
777 struct sset bridges, ports;
781 shash_init(&info->bridges);
782 shash_init(&info->ports);
783 shash_init(&info->ifaces);
787 for (i = 0; i < ovs->n_bridges; i++) {
788 struct ovsrec_bridge *br_cfg = ovs->bridges[i];
789 struct vsctl_bridge *br;
792 if (!sset_add(&bridges, br_cfg->name)) {
793 VLOG_WARN("%s: database contains duplicate bridge name",
797 br = add_bridge(info, br_cfg, br_cfg->name, NULL, 0);
802 for (j = 0; j < br_cfg->n_ports; j++) {
803 struct ovsrec_port *port_cfg = br_cfg->ports[j];
805 if (!sset_add(&ports, port_cfg->name)) {
806 /* Duplicate port name. (We will warn about that later.) */
810 if (port_is_fake_bridge(port_cfg)
811 && sset_add(&bridges, port_cfg->name)) {
812 add_bridge(info, NULL, port_cfg->name, br, *port_cfg->tag);
816 sset_destroy(&bridges);
817 sset_destroy(&ports);
820 for (i = 0; i < ovs->n_bridges; i++) {
821 struct ovsrec_bridge *br_cfg = ovs->bridges[i];
822 struct vsctl_bridge *br;
825 if (!sset_add(&bridges, br_cfg->name)) {
828 br = shash_find_data(&info->bridges, br_cfg->name);
829 for (j = 0; j < br_cfg->n_ports; j++) {
830 struct ovsrec_port *port_cfg = br_cfg->ports[j];
831 struct vsctl_port *port;
834 port = shash_find_data(&info->ports, port_cfg->name);
836 if (port_cfg == port->port_cfg) {
837 VLOG_WARN("%s: port is in multiple bridges (%s and %s)",
838 port_cfg->name, br->name, port->bridge->name);
840 /* Log as an error because this violates the database's
841 * uniqueness constraints, so the database server shouldn't
842 * have allowed it. */
843 VLOG_ERR("%s: database contains duplicate port name",
849 if (port_is_fake_bridge(port_cfg)
850 && !sset_add(&bridges, port_cfg->name)) {
854 port = xmalloc(sizeof *port);
855 port->port_cfg = port_cfg;
857 && *port_cfg->tag >= 0 && *port_cfg->tag <= 4095) {
858 port->bridge = find_vlan_bridge(info, br, *port_cfg->tag);
865 shash_add(&info->ports, port_cfg->name, port);
867 for (k = 0; k < port_cfg->n_interfaces; k++) {
868 struct ovsrec_interface *iface_cfg = port_cfg->interfaces[k];
869 struct vsctl_iface *iface;
871 iface = shash_find_data(&info->ifaces, iface_cfg->name);
873 if (iface_cfg == iface->iface_cfg) {
874 VLOG_WARN("%s: interface is in multiple ports "
877 iface->port->port_cfg->name,
878 port->port_cfg->name);
880 /* Log as an error because this violates the database's
881 * uniqueness constraints, so the database server
882 * shouldn't have allowed it. */
883 VLOG_ERR("%s: database contains duplicate interface "
884 "name", iface_cfg->name);
889 iface = xmalloc(sizeof *iface);
890 iface->iface_cfg = iface_cfg;
892 shash_add(&info->ifaces, iface_cfg->name, iface);
896 sset_destroy(&bridges);
900 check_conflicts(struct vsctl_info *info, const char *name,
903 struct vsctl_iface *iface;
904 struct vsctl_port *port;
906 verify_ports(info->ctx);
908 if (shash_find(&info->bridges, name)) {
909 vsctl_fatal("%s because a bridge named %s already exists",
913 port = shash_find_data(&info->ports, name);
915 vsctl_fatal("%s because a port named %s already exists on "
916 "bridge %s", msg, name, port->bridge->name);
919 iface = shash_find_data(&info->ifaces, name);
921 vsctl_fatal("%s because an interface named %s already exists "
922 "on bridge %s", msg, name, iface->port->bridge->name);
928 static struct vsctl_bridge *
929 find_bridge(struct vsctl_info *info, const char *name, bool must_exist)
931 struct vsctl_bridge *br = shash_find_data(&info->bridges, name);
932 if (must_exist && !br) {
933 vsctl_fatal("no bridge named %s", name);
935 ovsrec_open_vswitch_verify_bridges(info->ctx->ovs);
939 static struct vsctl_bridge *
940 find_real_bridge(struct vsctl_info *info, const char *name, bool must_exist)
942 struct vsctl_bridge *br = find_bridge(info, name, must_exist);
943 if (br && br->parent) {
944 vsctl_fatal("%s is a fake bridge", name);
949 static struct vsctl_port *
950 find_port(struct vsctl_info *info, const char *name, bool must_exist)
952 struct vsctl_port *port = shash_find_data(&info->ports, name);
953 if (port && !strcmp(name, port->bridge->name)) {
956 if (must_exist && !port) {
957 vsctl_fatal("no port named %s", name);
959 verify_ports(info->ctx);
963 static struct vsctl_iface *
964 find_iface(struct vsctl_info *info, const char *name, bool must_exist)
966 struct vsctl_iface *iface = shash_find_data(&info->ifaces, name);
967 if (iface && !strcmp(name, iface->port->bridge->name)) {
970 if (must_exist && !iface) {
971 vsctl_fatal("no interface named %s", name);
973 verify_ports(info->ctx);
978 bridge_insert_port(struct ovsrec_bridge *br, struct ovsrec_port *port)
980 struct ovsrec_port **ports;
983 ports = xmalloc(sizeof *br->ports * (br->n_ports + 1));
984 for (i = 0; i < br->n_ports; i++) {
985 ports[i] = br->ports[i];
987 ports[br->n_ports] = port;
988 ovsrec_bridge_set_ports(br, ports, br->n_ports + 1);
993 bridge_delete_port(struct ovsrec_bridge *br, struct ovsrec_port *port)
995 struct ovsrec_port **ports;
998 ports = xmalloc(sizeof *br->ports * br->n_ports);
999 for (i = n = 0; i < br->n_ports; i++) {
1000 if (br->ports[i] != port) {
1001 ports[n++] = br->ports[i];
1004 ovsrec_bridge_set_ports(br, ports, n);
1009 ovs_insert_bridge(const struct ovsrec_open_vswitch *ovs,
1010 struct ovsrec_bridge *bridge)
1012 struct ovsrec_bridge **bridges;
1015 bridges = xmalloc(sizeof *ovs->bridges * (ovs->n_bridges + 1));
1016 for (i = 0; i < ovs->n_bridges; i++) {
1017 bridges[i] = ovs->bridges[i];
1019 bridges[ovs->n_bridges] = bridge;
1020 ovsrec_open_vswitch_set_bridges(ovs, bridges, ovs->n_bridges + 1);
1025 ovs_delete_bridge(const struct ovsrec_open_vswitch *ovs,
1026 struct ovsrec_bridge *bridge)
1028 struct ovsrec_bridge **bridges;
1031 bridges = xmalloc(sizeof *ovs->bridges * ovs->n_bridges);
1032 for (i = n = 0; i < ovs->n_bridges; i++) {
1033 if (ovs->bridges[i] != bridge) {
1034 bridges[n++] = ovs->bridges[i];
1037 ovsrec_open_vswitch_set_bridges(ovs, bridges, n);
1042 cmd_init(struct vsctl_context *ctx OVS_UNUSED)
1046 struct cmd_show_table {
1047 const struct ovsdb_idl_table_class *table;
1048 const struct ovsdb_idl_column *name_column;
1049 const struct ovsdb_idl_column *columns[3];
1053 static struct cmd_show_table cmd_show_tables[] = {
1054 {&ovsrec_table_open_vswitch,
1056 {&ovsrec_open_vswitch_col_manager_options,
1057 &ovsrec_open_vswitch_col_bridges,
1058 &ovsrec_open_vswitch_col_ovs_version},
1061 {&ovsrec_table_bridge,
1062 &ovsrec_bridge_col_name,
1063 {&ovsrec_bridge_col_controller,
1064 &ovsrec_bridge_col_fail_mode,
1065 &ovsrec_bridge_col_ports},
1068 {&ovsrec_table_port,
1069 &ovsrec_port_col_name,
1070 {&ovsrec_port_col_tag,
1071 &ovsrec_port_col_trunks,
1072 &ovsrec_port_col_interfaces},
1075 {&ovsrec_table_interface,
1076 &ovsrec_interface_col_name,
1077 {&ovsrec_interface_col_type,
1078 &ovsrec_interface_col_options,
1082 {&ovsrec_table_controller,
1083 &ovsrec_controller_col_target,
1084 {&ovsrec_controller_col_is_connected,
1089 {&ovsrec_table_manager,
1090 &ovsrec_manager_col_target,
1091 {&ovsrec_manager_col_is_connected,
1098 pre_cmd_show(struct vsctl_context *ctx)
1100 struct cmd_show_table *show;
1102 for (show = cmd_show_tables;
1103 show < &cmd_show_tables[ARRAY_SIZE(cmd_show_tables)];
1107 ovsdb_idl_add_table(ctx->idl, show->table);
1108 if (show->name_column) {
1109 ovsdb_idl_add_column(ctx->idl, show->name_column);
1111 for (i = 0; i < ARRAY_SIZE(show->columns); i++) {
1112 const struct ovsdb_idl_column *column = show->columns[i];
1114 ovsdb_idl_add_column(ctx->idl, column);
1120 static struct cmd_show_table *
1121 cmd_show_find_table_by_row(const struct ovsdb_idl_row *row)
1123 struct cmd_show_table *show;
1125 for (show = cmd_show_tables;
1126 show < &cmd_show_tables[ARRAY_SIZE(cmd_show_tables)];
1128 if (show->table == row->table->class) {
1135 static struct cmd_show_table *
1136 cmd_show_find_table_by_name(const char *name)
1138 struct cmd_show_table *show;
1140 for (show = cmd_show_tables;
1141 show < &cmd_show_tables[ARRAY_SIZE(cmd_show_tables)];
1143 if (!strcmp(show->table->name, name)) {
1151 cmd_show_row(struct vsctl_context *ctx, const struct ovsdb_idl_row *row,
1154 struct cmd_show_table *show = cmd_show_find_table_by_row(row);
1157 ds_put_char_multiple(&ctx->output, ' ', level * 4);
1158 if (show && show->name_column) {
1159 const struct ovsdb_datum *datum;
1161 ds_put_format(&ctx->output, "%s ", show->table->name);
1162 datum = ovsdb_idl_read(row, show->name_column);
1163 ovsdb_datum_to_string(datum, &show->name_column->type, &ctx->output);
1165 ds_put_format(&ctx->output, UUID_FMT, UUID_ARGS(&row->uuid));
1167 ds_put_char(&ctx->output, '\n');
1169 if (!show || show->recurse) {
1173 show->recurse = true;
1174 for (i = 0; i < ARRAY_SIZE(show->columns); i++) {
1175 const struct ovsdb_idl_column *column = show->columns[i];
1176 const struct ovsdb_datum *datum;
1182 datum = ovsdb_idl_read(row, column);
1183 if (column->type.key.type == OVSDB_TYPE_UUID &&
1184 column->type.key.u.uuid.refTableName) {
1185 struct cmd_show_table *ref_show;
1188 ref_show = cmd_show_find_table_by_name(
1189 column->type.key.u.uuid.refTableName);
1191 for (j = 0; j < datum->n; j++) {
1192 const struct ovsdb_idl_row *ref_row;
1194 ref_row = ovsdb_idl_get_row_for_uuid(ctx->idl,
1196 &datum->keys[j].uuid);
1198 cmd_show_row(ctx, ref_row, level + 1);
1205 if (!ovsdb_datum_is_default(datum, &column->type)) {
1206 ds_put_char_multiple(&ctx->output, ' ', (level + 1) * 4);
1207 ds_put_format(&ctx->output, "%s: ", column->name);
1208 ovsdb_datum_to_string(datum, &column->type, &ctx->output);
1209 ds_put_char(&ctx->output, '\n');
1212 show->recurse = false;
1216 cmd_show(struct vsctl_context *ctx)
1218 const struct ovsdb_idl_row *row;
1220 for (row = ovsdb_idl_first_row(ctx->idl, cmd_show_tables[0].table);
1221 row; row = ovsdb_idl_next_row(row)) {
1222 cmd_show_row(ctx, row, 0);
1227 pre_cmd_emer_reset(struct vsctl_context *ctx)
1229 ovsdb_idl_add_column(ctx->idl, &ovsrec_open_vswitch_col_manager_options);
1230 ovsdb_idl_add_column(ctx->idl, &ovsrec_open_vswitch_col_ssl);
1232 ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_controller);
1233 ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_fail_mode);
1234 ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_mirrors);
1235 ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_netflow);
1236 ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_sflow);
1237 ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_flood_vlans);
1238 ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_other_config);
1240 ovsdb_idl_add_column(ctx->idl, &ovsrec_port_col_other_config);
1242 ovsdb_idl_add_column(ctx->idl,
1243 &ovsrec_interface_col_ingress_policing_rate);
1244 ovsdb_idl_add_column(ctx->idl,
1245 &ovsrec_interface_col_ingress_policing_burst);
1249 cmd_emer_reset(struct vsctl_context *ctx)
1251 const struct ovsdb_idl *idl = ctx->idl;
1252 const struct ovsrec_bridge *br;
1253 const struct ovsrec_port *port;
1254 const struct ovsrec_interface *iface;
1255 const struct ovsrec_mirror *mirror, *next_mirror;
1256 const struct ovsrec_controller *ctrl, *next_ctrl;
1257 const struct ovsrec_manager *mgr, *next_mgr;
1258 const struct ovsrec_netflow *nf, *next_nf;
1259 const struct ovsrec_ssl *ssl, *next_ssl;
1260 const struct ovsrec_sflow *sflow, *next_sflow;
1262 /* Reset the Open_vSwitch table. */
1263 ovsrec_open_vswitch_set_manager_options(ctx->ovs, NULL, 0);
1264 ovsrec_open_vswitch_set_ssl(ctx->ovs, NULL);
1266 OVSREC_BRIDGE_FOR_EACH (br, idl) {
1268 char *hw_key = "hwaddr";
1269 char *hw_val = NULL;
1271 ovsrec_bridge_set_controller(br, NULL, 0);
1272 ovsrec_bridge_set_fail_mode(br, NULL);
1273 ovsrec_bridge_set_mirrors(br, NULL, 0);
1274 ovsrec_bridge_set_netflow(br, NULL);
1275 ovsrec_bridge_set_sflow(br, NULL);
1276 ovsrec_bridge_set_flood_vlans(br, NULL, 0);
1278 /* We only want to save the "hwaddr" key from other_config. */
1279 for (i=0; i < br->n_other_config; i++) {
1280 if (!strcmp(br->key_other_config[i], hw_key)) {
1281 hw_val = br->value_other_config[i];
1286 char *val = xstrdup(hw_val);
1287 ovsrec_bridge_set_other_config(br, &hw_key, &val, 1);
1290 ovsrec_bridge_set_other_config(br, NULL, NULL, 0);
1294 OVSREC_PORT_FOR_EACH (port, idl) {
1295 ovsrec_port_set_other_config(port, NULL, NULL, 0);
1298 OVSREC_INTERFACE_FOR_EACH (iface, idl) {
1299 /* xxx What do we do about gre/patch devices created by mgr? */
1301 ovsrec_interface_set_ingress_policing_rate(iface, 0);
1302 ovsrec_interface_set_ingress_policing_burst(iface, 0);
1305 OVSREC_MIRROR_FOR_EACH_SAFE (mirror, next_mirror, idl) {
1306 ovsrec_mirror_delete(mirror);
1309 OVSREC_CONTROLLER_FOR_EACH_SAFE (ctrl, next_ctrl, idl) {
1310 ovsrec_controller_delete(ctrl);
1313 OVSREC_MANAGER_FOR_EACH_SAFE (mgr, next_mgr, idl) {
1314 ovsrec_manager_delete(mgr);
1317 OVSREC_NETFLOW_FOR_EACH_SAFE (nf, next_nf, idl) {
1318 ovsrec_netflow_delete(nf);
1321 OVSREC_SSL_FOR_EACH_SAFE (ssl, next_ssl, idl) {
1322 ovsrec_ssl_delete(ssl);
1325 OVSREC_SFLOW_FOR_EACH_SAFE (sflow, next_sflow, idl) {
1326 ovsrec_sflow_delete(sflow);
1331 cmd_add_br(struct vsctl_context *ctx)
1333 bool may_exist = shash_find(&ctx->options, "--may-exist") != NULL;
1334 const char *br_name, *parent_name;
1335 struct vsctl_info info;
1338 br_name = ctx->argv[1];
1339 if (ctx->argc == 2) {
1342 } else if (ctx->argc == 4) {
1343 parent_name = ctx->argv[2];
1344 vlan = atoi(ctx->argv[3]);
1345 if (vlan < 0 || vlan > 4095) {
1346 vsctl_fatal("%s: vlan must be between 0 and 4095", ctx->argv[0]);
1349 vsctl_fatal("'%s' command takes exactly 1 or 3 arguments",
1353 get_info(ctx, &info);
1355 struct vsctl_bridge *br;
1357 br = find_bridge(&info, br_name, false);
1361 vsctl_fatal("\"--may-exist add-br %s\" but %s is "
1362 "a VLAN bridge for VLAN %d",
1363 br_name, br_name, br->vlan);
1367 vsctl_fatal("\"--may-exist add-br %s %s %d\" but %s "
1368 "is not a VLAN bridge",
1369 br_name, parent_name, vlan, br_name);
1370 } else if (strcmp(br->parent->name, parent_name)) {
1371 vsctl_fatal("\"--may-exist add-br %s %s %d\" but %s "
1372 "has the wrong parent %s",
1373 br_name, parent_name, vlan,
1374 br_name, br->parent->name);
1375 } else if (br->vlan != vlan) {
1376 vsctl_fatal("\"--may-exist add-br %s %s %d\" but %s "
1377 "is a VLAN bridge for the wrong VLAN %d",
1378 br_name, parent_name, vlan, br_name, br->vlan);
1385 check_conflicts(&info, br_name,
1386 xasprintf("cannot create a bridge named %s", br_name));
1389 struct ovsrec_port *port;
1390 struct ovsrec_interface *iface;
1391 struct ovsrec_bridge *br;
1393 iface = ovsrec_interface_insert(ctx->txn);
1394 ovsrec_interface_set_name(iface, br_name);
1395 ovsrec_interface_set_type(iface, "internal");
1397 port = ovsrec_port_insert(ctx->txn);
1398 ovsrec_port_set_name(port, br_name);
1399 ovsrec_port_set_interfaces(port, &iface, 1);
1401 br = ovsrec_bridge_insert(ctx->txn);
1402 ovsrec_bridge_set_name(br, br_name);
1403 ovsrec_bridge_set_ports(br, &port, 1);
1405 ovs_insert_bridge(ctx->ovs, br);
1407 struct vsctl_bridge *parent;
1408 struct ovsrec_port *port;
1409 struct ovsrec_interface *iface;
1410 struct ovsrec_bridge *br;
1413 parent = find_bridge(&info, parent_name, false);
1414 if (parent && parent->parent) {
1415 vsctl_fatal("cannot create bridge with fake bridge as parent");
1418 vsctl_fatal("parent bridge %s does not exist", parent_name);
1420 br = parent->br_cfg;
1422 iface = ovsrec_interface_insert(ctx->txn);
1423 ovsrec_interface_set_name(iface, br_name);
1424 ovsrec_interface_set_type(iface, "internal");
1426 port = ovsrec_port_insert(ctx->txn);
1427 ovsrec_port_set_name(port, br_name);
1428 ovsrec_port_set_interfaces(port, &iface, 1);
1429 ovsrec_port_set_fake_bridge(port, true);
1430 ovsrec_port_set_tag(port, &tag, 1);
1432 bridge_insert_port(br, port);
1439 del_port(struct vsctl_info *info, struct vsctl_port *port)
1441 struct shash_node *node;
1443 SHASH_FOR_EACH (node, &info->ifaces) {
1444 struct vsctl_iface *iface = node->data;
1445 if (iface->port == port) {
1446 ovsrec_interface_delete(iface->iface_cfg);
1449 ovsrec_port_delete(port->port_cfg);
1451 bridge_delete_port((port->bridge->parent
1452 ? port->bridge->parent->br_cfg
1453 : port->bridge->br_cfg), port->port_cfg);
1457 cmd_del_br(struct vsctl_context *ctx)
1459 bool must_exist = !shash_find(&ctx->options, "--if-exists");
1460 struct vsctl_bridge *bridge;
1461 struct vsctl_info info;
1463 get_info(ctx, &info);
1464 bridge = find_bridge(&info, ctx->argv[1], must_exist);
1466 struct shash_node *node;
1468 SHASH_FOR_EACH (node, &info.ports) {
1469 struct vsctl_port *port = node->data;
1470 if (port->bridge == bridge || port->bridge->parent == bridge
1471 || !strcmp(port->port_cfg->name, bridge->name)) {
1472 del_port(&info, port);
1475 if (bridge->br_cfg) {
1476 ovsrec_bridge_delete(bridge->br_cfg);
1477 ovs_delete_bridge(ctx->ovs, bridge->br_cfg);
1484 output_sorted(struct svec *svec, struct ds *output)
1490 SVEC_FOR_EACH (i, name, svec) {
1491 ds_put_format(output, "%s\n", name);
1496 cmd_list_br(struct vsctl_context *ctx)
1498 struct shash_node *node;
1499 struct vsctl_info info;
1500 struct svec bridges;
1502 get_info(ctx, &info);
1504 svec_init(&bridges);
1505 SHASH_FOR_EACH (node, &info.bridges) {
1506 struct vsctl_bridge *br = node->data;
1507 svec_add(&bridges, br->name);
1509 output_sorted(&bridges, &ctx->output);
1510 svec_destroy(&bridges);
1516 cmd_br_exists(struct vsctl_context *ctx)
1518 struct vsctl_info info;
1520 get_info(ctx, &info);
1521 if (!find_bridge(&info, ctx->argv[1], false)) {
1527 /* Returns true if 'b_prefix' (of length 'b_prefix_len') concatenated with 'b'
1528 * equals 'a', false otherwise. */
1530 key_matches(const char *a,
1531 const char *b_prefix, size_t b_prefix_len, const char *b)
1533 return !strncmp(a, b_prefix, b_prefix_len) && !strcmp(a + b_prefix_len, b);
1537 set_external_id(char **old_keys, char **old_values, size_t old_n,
1538 char *key, char *value,
1539 char ***new_keysp, char ***new_valuesp, size_t *new_np)
1546 new_keys = xmalloc(sizeof *new_keys * (old_n + 1));
1547 new_values = xmalloc(sizeof *new_values * (old_n + 1));
1549 for (i = 0; i < old_n; i++) {
1550 if (strcmp(key, old_keys[i])) {
1551 new_keys[new_n] = old_keys[i];
1552 new_values[new_n] = old_values[i];
1557 new_keys[new_n] = key;
1558 new_values[new_n] = value;
1561 *new_keysp = new_keys;
1562 *new_valuesp = new_values;
1567 pre_cmd_br_set_external_id(struct vsctl_context *ctx)
1570 ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_external_ids);
1571 ovsdb_idl_add_column(ctx->idl, &ovsrec_port_col_external_ids);
1575 cmd_br_set_external_id(struct vsctl_context *ctx)
1577 struct vsctl_info info;
1578 struct vsctl_bridge *bridge;
1579 char **keys, **values;
1582 get_info(ctx, &info);
1583 bridge = find_bridge(&info, ctx->argv[1], true);
1584 if (bridge->br_cfg) {
1585 set_external_id(bridge->br_cfg->key_external_ids,
1586 bridge->br_cfg->value_external_ids,
1587 bridge->br_cfg->n_external_ids,
1588 ctx->argv[2], ctx->argc >= 4 ? ctx->argv[3] : NULL,
1589 &keys, &values, &n);
1590 ovsrec_bridge_verify_external_ids(bridge->br_cfg);
1591 ovsrec_bridge_set_external_ids(bridge->br_cfg, keys, values, n);
1593 char *key = xasprintf("fake-bridge-%s", ctx->argv[2]);
1594 struct vsctl_port *port = shash_find_data(&info.ports, ctx->argv[1]);
1595 set_external_id(port->port_cfg->key_external_ids,
1596 port->port_cfg->value_external_ids,
1597 port->port_cfg->n_external_ids,
1598 key, ctx->argc >= 4 ? ctx->argv[3] : NULL,
1599 &keys, &values, &n);
1600 ovsrec_port_verify_external_ids(port->port_cfg);
1601 ovsrec_port_set_external_ids(port->port_cfg, keys, values, n);
1611 get_external_id(char **keys, char **values, size_t n,
1612 const char *prefix, const char *key,
1615 size_t prefix_len = strlen(prefix);
1620 for (i = 0; i < n; i++) {
1621 if (!key && !strncmp(keys[i], prefix, prefix_len)) {
1622 svec_add_nocopy(&svec, xasprintf("%s=%s",
1623 keys[i] + prefix_len, values[i]));
1624 } else if (key && key_matches(keys[i], prefix, prefix_len, key)) {
1625 svec_add(&svec, values[i]);
1629 output_sorted(&svec, output);
1630 svec_destroy(&svec);
1634 pre_cmd_br_get_external_id(struct vsctl_context *ctx)
1636 pre_cmd_br_set_external_id(ctx);
1640 cmd_br_get_external_id(struct vsctl_context *ctx)
1642 struct vsctl_info info;
1643 struct vsctl_bridge *bridge;
1645 get_info(ctx, &info);
1646 bridge = find_bridge(&info, ctx->argv[1], true);
1647 if (bridge->br_cfg) {
1648 ovsrec_bridge_verify_external_ids(bridge->br_cfg);
1649 get_external_id(bridge->br_cfg->key_external_ids,
1650 bridge->br_cfg->value_external_ids,
1651 bridge->br_cfg->n_external_ids,
1652 "", ctx->argc >= 3 ? ctx->argv[2] : NULL,
1655 struct vsctl_port *port = shash_find_data(&info.ports, ctx->argv[1]);
1656 ovsrec_port_verify_external_ids(port->port_cfg);
1657 get_external_id(port->port_cfg->key_external_ids,
1658 port->port_cfg->value_external_ids,
1659 port->port_cfg->n_external_ids,
1660 "fake-bridge-", ctx->argc >= 3 ? ctx->argv[2] : NULL, &ctx->output);
1667 cmd_list_ports(struct vsctl_context *ctx)
1669 struct vsctl_bridge *br;
1670 struct shash_node *node;
1671 struct vsctl_info info;
1674 get_info(ctx, &info);
1675 br = find_bridge(&info, ctx->argv[1], true);
1676 ovsrec_bridge_verify_ports(br->br_cfg ? br->br_cfg : br->parent->br_cfg);
1679 SHASH_FOR_EACH (node, &info.ports) {
1680 struct vsctl_port *port = node->data;
1682 if (strcmp(port->port_cfg->name, br->name) && br == port->bridge) {
1683 svec_add(&ports, port->port_cfg->name);
1686 output_sorted(&ports, &ctx->output);
1687 svec_destroy(&ports);
1693 add_port(struct vsctl_context *ctx,
1694 const char *br_name, const char *port_name,
1695 bool may_exist, bool fake_iface,
1696 char *iface_names[], int n_ifaces,
1697 char *settings[], int n_settings)
1699 struct vsctl_info info;
1700 struct vsctl_bridge *bridge;
1701 struct ovsrec_interface **ifaces;
1702 struct ovsrec_port *port;
1705 get_info(ctx, &info);
1707 struct vsctl_port *vsctl_port;
1709 vsctl_port = find_port(&info, port_name, false);
1711 struct svec want_names, have_names;
1713 svec_init(&want_names);
1714 for (i = 0; i < n_ifaces; i++) {
1715 svec_add(&want_names, iface_names[i]);
1717 svec_sort(&want_names);
1719 svec_init(&have_names);
1720 for (i = 0; i < vsctl_port->port_cfg->n_interfaces; i++) {
1721 svec_add(&have_names,
1722 vsctl_port->port_cfg->interfaces[i]->name);
1724 svec_sort(&have_names);
1726 if (strcmp(vsctl_port->bridge->name, br_name)) {
1727 char *command = vsctl_context_to_string(ctx);
1728 vsctl_fatal("\"%s\" but %s is actually attached to bridge %s",
1729 command, port_name, vsctl_port->bridge->name);
1732 if (!svec_equal(&want_names, &have_names)) {
1733 char *have_names_string = svec_join(&have_names, ", ", "");
1734 char *command = vsctl_context_to_string(ctx);
1736 vsctl_fatal("\"%s\" but %s actually has interface(s) %s",
1737 command, port_name, have_names_string);
1740 svec_destroy(&want_names);
1741 svec_destroy(&have_names);
1747 check_conflicts(&info, port_name,
1748 xasprintf("cannot create a port named %s", port_name));
1749 for (i = 0; i < n_ifaces; i++) {
1750 check_conflicts(&info, iface_names[i],
1751 xasprintf("cannot create an interface named %s",
1754 bridge = find_bridge(&info, br_name, true);
1756 ifaces = xmalloc(n_ifaces * sizeof *ifaces);
1757 for (i = 0; i < n_ifaces; i++) {
1758 ifaces[i] = ovsrec_interface_insert(ctx->txn);
1759 ovsrec_interface_set_name(ifaces[i], iface_names[i]);
1762 port = ovsrec_port_insert(ctx->txn);
1763 ovsrec_port_set_name(port, port_name);
1764 ovsrec_port_set_interfaces(port, ifaces, n_ifaces);
1765 ovsrec_port_set_bond_fake_iface(port, fake_iface);
1768 if (bridge->parent) {
1769 int64_t tag = bridge->vlan;
1770 ovsrec_port_set_tag(port, &tag, 1);
1773 for (i = 0; i < n_settings; i++) {
1774 set_column(get_table("Port"), &port->header_, settings[i],
1778 bridge_insert_port((bridge->parent ? bridge->parent->br_cfg
1779 : bridge->br_cfg), port);
1785 cmd_add_port(struct vsctl_context *ctx)
1787 bool may_exist = shash_find(&ctx->options, "--may-exist") != NULL;
1789 add_port(ctx, ctx->argv[1], ctx->argv[2], may_exist, false,
1790 &ctx->argv[2], 1, &ctx->argv[3], ctx->argc - 3);
1794 cmd_add_bond(struct vsctl_context *ctx)
1796 bool may_exist = shash_find(&ctx->options, "--may-exist") != NULL;
1797 bool fake_iface = shash_find(&ctx->options, "--fake-iface");
1801 n_ifaces = ctx->argc - 3;
1802 for (i = 3; i < ctx->argc; i++) {
1803 if (strchr(ctx->argv[i], '=')) {
1809 vsctl_fatal("add-bond requires at least 2 interfaces, but only "
1810 "%d were specified", n_ifaces);
1813 add_port(ctx, ctx->argv[1], ctx->argv[2], may_exist, fake_iface,
1814 &ctx->argv[3], n_ifaces,
1815 &ctx->argv[n_ifaces + 3], ctx->argc - 3 - n_ifaces);
1819 cmd_del_port(struct vsctl_context *ctx)
1821 bool must_exist = !shash_find(&ctx->options, "--if-exists");
1822 bool with_iface = shash_find(&ctx->options, "--with-iface") != NULL;
1823 struct vsctl_port *port;
1824 struct vsctl_info info;
1826 get_info(ctx, &info);
1828 port = find_port(&info, ctx->argv[ctx->argc - 1], must_exist);
1830 const char *target = ctx->argv[ctx->argc - 1];
1831 struct vsctl_iface *iface;
1833 port = find_port(&info, target, false);
1835 iface = find_iface(&info, target, false);
1840 if (must_exist && !port) {
1841 vsctl_fatal("no port or interface named %s", target);
1846 if (ctx->argc == 3) {
1847 struct vsctl_bridge *bridge;
1849 bridge = find_bridge(&info, ctx->argv[1], true);
1850 if (port->bridge != bridge) {
1851 if (port->bridge->parent == bridge) {
1852 vsctl_fatal("bridge %s does not have a port %s (although "
1853 "its parent bridge %s does)",
1854 ctx->argv[1], ctx->argv[2],
1855 bridge->parent->name);
1857 vsctl_fatal("bridge %s does not have a port %s",
1858 ctx->argv[1], ctx->argv[2]);
1863 del_port(&info, port);
1870 cmd_port_to_br(struct vsctl_context *ctx)
1872 struct vsctl_port *port;
1873 struct vsctl_info info;
1875 get_info(ctx, &info);
1876 port = find_port(&info, ctx->argv[1], true);
1877 ds_put_format(&ctx->output, "%s\n", port->bridge->name);
1882 cmd_br_to_vlan(struct vsctl_context *ctx)
1884 struct vsctl_bridge *bridge;
1885 struct vsctl_info info;
1887 get_info(ctx, &info);
1888 bridge = find_bridge(&info, ctx->argv[1], true);
1889 ds_put_format(&ctx->output, "%d\n", bridge->vlan);
1894 cmd_br_to_parent(struct vsctl_context *ctx)
1896 struct vsctl_bridge *bridge;
1897 struct vsctl_info info;
1899 get_info(ctx, &info);
1900 bridge = find_bridge(&info, ctx->argv[1], true);
1901 if (bridge->parent) {
1902 bridge = bridge->parent;
1904 ds_put_format(&ctx->output, "%s\n", bridge->name);
1909 cmd_list_ifaces(struct vsctl_context *ctx)
1911 struct vsctl_bridge *br;
1912 struct shash_node *node;
1913 struct vsctl_info info;
1916 get_info(ctx, &info);
1917 br = find_bridge(&info, ctx->argv[1], true);
1921 SHASH_FOR_EACH (node, &info.ifaces) {
1922 struct vsctl_iface *iface = node->data;
1924 if (strcmp(iface->iface_cfg->name, br->name)
1925 && br == iface->port->bridge) {
1926 svec_add(&ifaces, iface->iface_cfg->name);
1929 output_sorted(&ifaces, &ctx->output);
1930 svec_destroy(&ifaces);
1936 cmd_iface_to_br(struct vsctl_context *ctx)
1938 struct vsctl_iface *iface;
1939 struct vsctl_info info;
1941 get_info(ctx, &info);
1942 iface = find_iface(&info, ctx->argv[1], true);
1943 ds_put_format(&ctx->output, "%s\n", iface->port->bridge->name);
1948 verify_controllers(struct ovsrec_bridge *bridge)
1953 ovsrec_bridge_verify_controller(bridge);
1954 for (i = 0; i < bridge->n_controller; i++) {
1955 ovsrec_controller_verify_target(bridge->controller[i]);
1961 pre_controller(struct vsctl_context *ctx)
1965 ovsdb_idl_add_column(ctx->idl, &ovsrec_controller_col_target);
1969 cmd_get_controller(struct vsctl_context *ctx)
1971 struct vsctl_info info;
1972 struct vsctl_bridge *br;
1973 struct svec targets;
1976 get_info(ctx, &info);
1977 br = find_bridge(&info, ctx->argv[1], true);
1978 verify_controllers(br->br_cfg);
1980 /* Print the targets in sorted order for reproducibility. */
1981 svec_init(&targets);
1982 for (i = 0; i < br->n_ctrl; i++) {
1983 svec_add(&targets, br->ctrl[i]->target);
1986 svec_sort(&targets);
1987 for (i = 0; i < targets.n; i++) {
1988 ds_put_format(&ctx->output, "%s\n", targets.names[i]);
1990 svec_destroy(&targets);
1996 delete_controllers(struct ovsrec_controller **controllers,
1997 size_t n_controllers)
2001 for (i = 0; i < n_controllers; i++) {
2002 ovsrec_controller_delete(controllers[i]);
2007 cmd_del_controller(struct vsctl_context *ctx)
2009 struct vsctl_info info;
2010 struct vsctl_bridge *br;
2012 get_info(ctx, &info);
2014 br = find_real_bridge(&info, ctx->argv[1], true);
2015 verify_controllers(br->br_cfg);
2018 delete_controllers(br->ctrl, br->n_ctrl);
2019 ovsrec_bridge_set_controller(br->br_cfg, NULL, 0);
2025 static struct ovsrec_controller **
2026 insert_controllers(struct ovsdb_idl_txn *txn, char *targets[], size_t n)
2028 struct ovsrec_controller **controllers;
2031 controllers = xmalloc(n * sizeof *controllers);
2032 for (i = 0; i < n; i++) {
2033 if (vconn_verify_name(targets[i]) && pvconn_verify_name(targets[i])) {
2034 VLOG_WARN("target type \"%s\" is possibly erroneous", targets[i]);
2036 controllers[i] = ovsrec_controller_insert(txn);
2037 ovsrec_controller_set_target(controllers[i], targets[i]);
2044 cmd_set_controller(struct vsctl_context *ctx)
2046 struct vsctl_info info;
2047 struct vsctl_bridge *br;
2048 struct ovsrec_controller **controllers;
2051 get_info(ctx, &info);
2052 br = find_real_bridge(&info, ctx->argv[1], true);
2053 verify_controllers(br->br_cfg);
2055 delete_controllers(br->ctrl, br->n_ctrl);
2058 controllers = insert_controllers(ctx->txn, &ctx->argv[2], n);
2059 ovsrec_bridge_set_controller(br->br_cfg, controllers, n);
2066 cmd_get_fail_mode(struct vsctl_context *ctx)
2068 struct vsctl_info info;
2069 struct vsctl_bridge *br;
2071 get_info(ctx, &info);
2072 br = find_bridge(&info, ctx->argv[1], true);
2075 ovsrec_bridge_verify_fail_mode(br->br_cfg);
2077 if (br->fail_mode && strlen(br->fail_mode)) {
2078 ds_put_format(&ctx->output, "%s\n", br->fail_mode);
2085 cmd_del_fail_mode(struct vsctl_context *ctx)
2087 struct vsctl_info info;
2088 struct vsctl_bridge *br;
2090 get_info(ctx, &info);
2091 br = find_real_bridge(&info, ctx->argv[1], true);
2093 ovsrec_bridge_set_fail_mode(br->br_cfg, NULL);
2099 cmd_set_fail_mode(struct vsctl_context *ctx)
2101 struct vsctl_info info;
2102 struct vsctl_bridge *br;
2103 const char *fail_mode = ctx->argv[2];
2105 get_info(ctx, &info);
2106 br = find_real_bridge(&info, ctx->argv[1], true);
2108 if (strcmp(fail_mode, "standalone") && strcmp(fail_mode, "secure")) {
2109 vsctl_fatal("fail-mode must be \"standalone\" or \"secure\"");
2112 ovsrec_bridge_set_fail_mode(br->br_cfg, fail_mode);
2118 verify_managers(const struct ovsrec_open_vswitch *ovs)
2122 ovsrec_open_vswitch_verify_manager_options(ovs);
2124 for (i = 0; i < ovs->n_manager_options; ++i) {
2125 const struct ovsrec_manager *mgr = ovs->manager_options[i];
2127 ovsrec_manager_verify_target(mgr);
2132 pre_manager(struct vsctl_context *ctx)
2134 ovsdb_idl_add_column(ctx->idl, &ovsrec_open_vswitch_col_manager_options);
2135 ovsdb_idl_add_column(ctx->idl, &ovsrec_manager_col_target);
2139 cmd_get_manager(struct vsctl_context *ctx)
2141 const struct ovsrec_open_vswitch *ovs = ctx->ovs;
2142 struct svec targets;
2145 verify_managers(ovs);
2147 /* Print the targets in sorted order for reproducibility. */
2148 svec_init(&targets);
2150 for (i = 0; i < ovs->n_manager_options; i++) {
2151 svec_add(&targets, ovs->manager_options[i]->target);
2154 svec_sort_unique(&targets);
2155 for (i = 0; i < targets.n; i++) {
2156 ds_put_format(&ctx->output, "%s\n", targets.names[i]);
2158 svec_destroy(&targets);
2162 delete_managers(const struct vsctl_context *ctx)
2164 const struct ovsrec_open_vswitch *ovs = ctx->ovs;
2167 /* Delete Manager rows pointed to by 'manager_options' column. */
2168 for (i = 0; i < ovs->n_manager_options; i++) {
2169 ovsrec_manager_delete(ovs->manager_options[i]);
2172 /* Delete 'Manager' row refs in 'manager_options' column. */
2173 ovsrec_open_vswitch_set_manager_options(ovs, NULL, 0);
2177 cmd_del_manager(struct vsctl_context *ctx)
2179 const struct ovsrec_open_vswitch *ovs = ctx->ovs;
2181 verify_managers(ovs);
2182 delete_managers(ctx);
2186 insert_managers(struct vsctl_context *ctx, char *targets[], size_t n)
2188 struct ovsrec_manager **managers;
2191 /* Insert each manager in a new row in Manager table. */
2192 managers = xmalloc(n * sizeof *managers);
2193 for (i = 0; i < n; i++) {
2194 if (stream_verify_name(targets[i]) && pstream_verify_name(targets[i])) {
2195 VLOG_WARN("target type \"%s\" is possibly erroneous", targets[i]);
2197 managers[i] = ovsrec_manager_insert(ctx->txn);
2198 ovsrec_manager_set_target(managers[i], targets[i]);
2201 /* Store uuids of new Manager rows in 'manager_options' column. */
2202 ovsrec_open_vswitch_set_manager_options(ctx->ovs, managers, n);
2207 cmd_set_manager(struct vsctl_context *ctx)
2209 const size_t n = ctx->argc - 1;
2211 verify_managers(ctx->ovs);
2212 delete_managers(ctx);
2213 insert_managers(ctx, &ctx->argv[1], n);
2217 pre_cmd_get_ssl(struct vsctl_context *ctx)
2219 ovsdb_idl_add_column(ctx->idl, &ovsrec_open_vswitch_col_ssl);
2221 ovsdb_idl_add_column(ctx->idl, &ovsrec_ssl_col_private_key);
2222 ovsdb_idl_add_column(ctx->idl, &ovsrec_ssl_col_certificate);
2223 ovsdb_idl_add_column(ctx->idl, &ovsrec_ssl_col_ca_cert);
2224 ovsdb_idl_add_column(ctx->idl, &ovsrec_ssl_col_bootstrap_ca_cert);
2228 cmd_get_ssl(struct vsctl_context *ctx)
2230 struct ovsrec_ssl *ssl = ctx->ovs->ssl;
2232 ovsrec_open_vswitch_verify_ssl(ctx->ovs);
2234 ovsrec_ssl_verify_private_key(ssl);
2235 ovsrec_ssl_verify_certificate(ssl);
2236 ovsrec_ssl_verify_ca_cert(ssl);
2237 ovsrec_ssl_verify_bootstrap_ca_cert(ssl);
2239 ds_put_format(&ctx->output, "Private key: %s\n", ssl->private_key);
2240 ds_put_format(&ctx->output, "Certificate: %s\n", ssl->certificate);
2241 ds_put_format(&ctx->output, "CA Certificate: %s\n", ssl->ca_cert);
2242 ds_put_format(&ctx->output, "Bootstrap: %s\n",
2243 ssl->bootstrap_ca_cert ? "true" : "false");
2248 pre_cmd_del_ssl(struct vsctl_context *ctx)
2250 ovsdb_idl_add_column(ctx->idl, &ovsrec_open_vswitch_col_ssl);
2254 cmd_del_ssl(struct vsctl_context *ctx)
2256 struct ovsrec_ssl *ssl = ctx->ovs->ssl;
2259 ovsrec_open_vswitch_verify_ssl(ctx->ovs);
2260 ovsrec_ssl_delete(ssl);
2261 ovsrec_open_vswitch_set_ssl(ctx->ovs, NULL);
2266 pre_cmd_set_ssl(struct vsctl_context *ctx)
2268 ovsdb_idl_add_column(ctx->idl, &ovsrec_open_vswitch_col_ssl);
2272 cmd_set_ssl(struct vsctl_context *ctx)
2274 bool bootstrap = shash_find(&ctx->options, "--bootstrap");
2275 struct ovsrec_ssl *ssl = ctx->ovs->ssl;
2277 ovsrec_open_vswitch_verify_ssl(ctx->ovs);
2279 ovsrec_ssl_delete(ssl);
2281 ssl = ovsrec_ssl_insert(ctx->txn);
2283 ovsrec_ssl_set_private_key(ssl, ctx->argv[1]);
2284 ovsrec_ssl_set_certificate(ssl, ctx->argv[2]);
2285 ovsrec_ssl_set_ca_cert(ssl, ctx->argv[3]);
2287 ovsrec_ssl_set_bootstrap_ca_cert(ssl, bootstrap);
2289 ovsrec_open_vswitch_set_ssl(ctx->ovs, ssl);
2292 /* Parameter commands. */
2294 struct vsctl_row_id {
2295 const struct ovsdb_idl_table_class *table;
2296 const struct ovsdb_idl_column *name_column;
2297 const struct ovsdb_idl_column *uuid_column;
2300 struct vsctl_table_class {
2301 struct ovsdb_idl_table_class *class;
2302 struct vsctl_row_id row_ids[2];
2305 static const struct vsctl_table_class tables[] = {
2306 {&ovsrec_table_bridge,
2307 {{&ovsrec_table_bridge, &ovsrec_bridge_col_name, NULL},
2308 {NULL, NULL, NULL}}},
2310 {&ovsrec_table_controller,
2311 {{&ovsrec_table_bridge,
2312 &ovsrec_bridge_col_name,
2313 &ovsrec_bridge_col_controller}}},
2315 {&ovsrec_table_interface,
2316 {{&ovsrec_table_interface, &ovsrec_interface_col_name, NULL},
2317 {NULL, NULL, NULL}}},
2319 {&ovsrec_table_mirror,
2320 {{&ovsrec_table_mirror, &ovsrec_mirror_col_name, NULL},
2321 {NULL, NULL, NULL}}},
2323 {&ovsrec_table_manager,
2324 {{&ovsrec_table_manager, &ovsrec_manager_col_target, NULL},
2325 {NULL, NULL, NULL}}},
2327 {&ovsrec_table_netflow,
2328 {{&ovsrec_table_bridge,
2329 &ovsrec_bridge_col_name,
2330 &ovsrec_bridge_col_netflow},
2331 {NULL, NULL, NULL}}},
2333 {&ovsrec_table_open_vswitch,
2334 {{&ovsrec_table_open_vswitch, NULL, NULL},
2335 {NULL, NULL, NULL}}},
2337 {&ovsrec_table_port,
2338 {{&ovsrec_table_port, &ovsrec_port_col_name, NULL},
2339 {NULL, NULL, NULL}}},
2342 {{&ovsrec_table_port, &ovsrec_port_col_name, &ovsrec_port_col_qos},
2343 {NULL, NULL, NULL}}},
2345 {&ovsrec_table_queue,
2346 {{NULL, NULL, NULL},
2347 {NULL, NULL, NULL}}},
2350 {{&ovsrec_table_open_vswitch, NULL, &ovsrec_open_vswitch_col_ssl}}},
2352 {&ovsrec_table_sflow,
2353 {{&ovsrec_table_bridge,
2354 &ovsrec_bridge_col_name,
2355 &ovsrec_bridge_col_sflow},
2356 {NULL, NULL, NULL}}},
2358 {&ovsrec_table_flow_table,
2359 {{&ovsrec_table_flow_table, &ovsrec_flow_table_col_name, NULL},
2360 {NULL, NULL, NULL}}},
2362 {NULL, {{NULL, NULL, NULL}, {NULL, NULL, NULL}}}
2366 die_if_error(char *error)
2369 vsctl_fatal("%s", error);
2374 to_lower_and_underscores(unsigned c)
2376 return c == '-' ? '_' : tolower(c);
2380 score_partial_match(const char *name, const char *s)
2384 if (!strcmp(name, s)) {
2387 for (score = 0; ; score++, name++, s++) {
2388 if (to_lower_and_underscores(*name) != to_lower_and_underscores(*s)) {
2390 } else if (*name == '\0') {
2391 return UINT_MAX - 1;
2394 return *s == '\0' ? score : 0;
2397 static const struct vsctl_table_class *
2398 get_table(const char *table_name)
2400 const struct vsctl_table_class *table;
2401 const struct vsctl_table_class *best_match = NULL;
2402 unsigned int best_score = 0;
2404 for (table = tables; table->class; table++) {
2405 unsigned int score = score_partial_match(table->class->name,
2407 if (score > best_score) {
2410 } else if (score == best_score) {
2416 } else if (best_score) {
2417 vsctl_fatal("multiple table names match \"%s\"", table_name);
2419 vsctl_fatal("unknown table \"%s\"", table_name);
2423 static const struct vsctl_table_class *
2424 pre_get_table(struct vsctl_context *ctx, const char *table_name)
2426 const struct vsctl_table_class *table_class;
2429 table_class = get_table(table_name);
2430 ovsdb_idl_add_table(ctx->idl, table_class->class);
2432 for (i = 0; i < ARRAY_SIZE(table_class->row_ids); i++) {
2433 const struct vsctl_row_id *id = &table_class->row_ids[i];
2435 ovsdb_idl_add_table(ctx->idl, id->table);
2437 if (id->name_column) {
2438 ovsdb_idl_add_column(ctx->idl, id->name_column);
2440 if (id->uuid_column) {
2441 ovsdb_idl_add_column(ctx->idl, id->uuid_column);
2448 static const struct ovsdb_idl_row *
2449 get_row_by_id(struct vsctl_context *ctx, const struct vsctl_table_class *table,
2450 const struct vsctl_row_id *id, const char *record_id)
2452 const struct ovsdb_idl_row *referrer, *final;
2458 if (!id->name_column) {
2459 if (strcmp(record_id, ".")) {
2462 referrer = ovsdb_idl_first_row(ctx->idl, id->table);
2463 if (!referrer || ovsdb_idl_next_row(referrer)) {
2467 const struct ovsdb_idl_row *row;
2470 for (row = ovsdb_idl_first_row(ctx->idl, id->table);
2472 row = ovsdb_idl_next_row(row))
2474 const struct ovsdb_datum *name;
2476 name = ovsdb_idl_get(row, id->name_column,
2477 OVSDB_TYPE_STRING, OVSDB_TYPE_VOID);
2478 if (name->n == 1 && !strcmp(name->keys[0].string, record_id)) {
2480 vsctl_fatal("multiple rows in %s match \"%s\"",
2481 table->class->name, record_id);
2492 if (id->uuid_column) {
2493 const struct ovsdb_datum *uuid;
2495 ovsdb_idl_txn_verify(referrer, id->uuid_column);
2496 uuid = ovsdb_idl_get(referrer, id->uuid_column,
2497 OVSDB_TYPE_UUID, OVSDB_TYPE_VOID);
2499 final = ovsdb_idl_get_row_for_uuid(ctx->idl, table->class,
2500 &uuid->keys[0].uuid);
2509 static const struct ovsdb_idl_row *
2510 get_row (struct vsctl_context *ctx,
2511 const struct vsctl_table_class *table, const char *record_id)
2513 const struct ovsdb_idl_row *row;
2516 if (uuid_from_string(&uuid, record_id)) {
2517 row = ovsdb_idl_get_row_for_uuid(ctx->idl, table->class, &uuid);
2521 for (i = 0; i < ARRAY_SIZE(table->row_ids); i++) {
2522 row = get_row_by_id(ctx, table, &table->row_ids[i], record_id);
2531 static const struct ovsdb_idl_row *
2532 must_get_row(struct vsctl_context *ctx,
2533 const struct vsctl_table_class *table, const char *record_id)
2535 const struct ovsdb_idl_row *row = get_row(ctx, table, record_id);
2537 vsctl_fatal("no row \"%s\" in table %s",
2538 record_id, table->class->name);
2544 get_column(const struct vsctl_table_class *table, const char *column_name,
2545 const struct ovsdb_idl_column **columnp)
2547 const struct ovsdb_idl_column *best_match = NULL;
2548 unsigned int best_score = 0;
2551 for (i = 0; i < table->class->n_columns; i++) {
2552 const struct ovsdb_idl_column *column = &table->class->columns[i];
2553 unsigned int score = score_partial_match(column->name, column_name);
2554 if (score > best_score) {
2555 best_match = column;
2557 } else if (score == best_score) {
2562 *columnp = best_match;
2565 } else if (best_score) {
2566 return xasprintf("%s contains more than one column whose name "
2567 "matches \"%s\"", table->class->name, column_name);
2569 return xasprintf("%s does not contain a column whose name matches "
2570 "\"%s\"", table->class->name, column_name);
2574 static struct ovsdb_symbol *
2575 create_symbol(struct ovsdb_symbol_table *symtab, const char *id, bool *newp)
2577 struct ovsdb_symbol *symbol;
2580 vsctl_fatal("row id \"%s\" does not begin with \"@\"", id);
2584 *newp = ovsdb_symbol_table_get(symtab, id) == NULL;
2587 symbol = ovsdb_symbol_table_insert(symtab, id);
2588 if (symbol->created) {
2589 vsctl_fatal("row id \"%s\" may only be specified on one --id option",
2592 symbol->created = true;
2597 pre_get_column(struct vsctl_context *ctx,
2598 const struct vsctl_table_class *table, const char *column_name,
2599 const struct ovsdb_idl_column **columnp)
2601 die_if_error(get_column(table, column_name, columnp));
2602 ovsdb_idl_add_column(ctx->idl, *columnp);
2606 missing_operator_error(const char *arg, const char **allowed_operators,
2612 ds_put_format(&s, "%s: argument does not end in ", arg);
2613 ds_put_format(&s, "\"%s\"", allowed_operators[0]);
2614 if (n_allowed == 2) {
2615 ds_put_format(&s, " or \"%s\"", allowed_operators[1]);
2616 } else if (n_allowed > 2) {
2619 for (i = 1; i < n_allowed - 1; i++) {
2620 ds_put_format(&s, ", \"%s\"", allowed_operators[i]);
2622 ds_put_format(&s, ", or \"%s\"", allowed_operators[i]);
2624 ds_put_format(&s, " followed by a value.");
2626 return ds_steal_cstr(&s);
2629 /* Breaks 'arg' apart into a number of fields in the following order:
2631 * - The name of a column in 'table', stored into '*columnp'. The column
2632 * name may be abbreviated.
2634 * - Optionally ':' followed by a key string. The key is stored as a
2635 * malloc()'d string into '*keyp', or NULL if no key is present in
2638 * - If 'valuep' is nonnull, an operator followed by a value string. The
2639 * allowed operators are the 'n_allowed' string in 'allowed_operators',
2640 * or just "=" if 'n_allowed' is 0. If 'operatorp' is nonnull, then the
2641 * index of the operator within 'allowed_operators' is stored into
2642 * '*operatorp'. The value is stored as a malloc()'d string into
2643 * '*valuep', or NULL if no value is present in 'arg'.
2645 * On success, returns NULL. On failure, returned a malloc()'d string error
2646 * message and stores NULL into all of the nonnull output arguments. */
2647 static char * WARN_UNUSED_RESULT
2648 parse_column_key_value(const char *arg,
2649 const struct vsctl_table_class *table,
2650 const struct ovsdb_idl_column **columnp, char **keyp,
2652 const char **allowed_operators, size_t n_allowed,
2655 const char *p = arg;
2659 assert(!(operatorp && !valuep));
2665 /* Parse column name. */
2666 error = ovsdb_token_parse(&p, &column_name);
2670 if (column_name[0] == '\0') {
2672 error = xasprintf("%s: missing column name", arg);
2675 error = get_column(table, column_name, columnp);
2681 /* Parse key string. */
2684 error = ovsdb_token_parse(&p, keyp);
2690 /* Parse value string. */
2696 if (!allowed_operators) {
2697 static const char *equals = "=";
2698 allowed_operators = =
2704 for (i = 0; i < n_allowed; i++) {
2705 const char *op = allowed_operators[i];
2706 size_t op_len = strlen(op);
2708 if (op_len > best_len && !strncmp(op, p, op_len) && p[op_len]) {
2714 error = missing_operator_error(arg, allowed_operators, n_allowed);
2721 *valuep = xstrdup(p + best_len);
2724 error = xasprintf("%s: trailing garbage \"%s\" in argument",
2746 pre_parse_column_key_value(struct vsctl_context *ctx,
2748 const struct vsctl_table_class *table)
2750 const struct ovsdb_idl_column *column;
2755 die_if_error(ovsdb_token_parse(&p, &column_name));
2756 if (column_name[0] == '\0') {
2757 vsctl_fatal("%s: missing column name", arg);
2760 pre_get_column(ctx, table, column_name, &column);
2765 pre_cmd_get(struct vsctl_context *ctx)
2767 const char *id = shash_find_data(&ctx->options, "--id");
2768 const char *table_name = ctx->argv[1];
2769 const struct vsctl_table_class *table;
2772 /* Using "get" without --id or a column name could possibly make sense.
2773 * Maybe, for example, a ovs-vsctl run wants to assert that a row exists.
2774 * But it is unlikely that an interactive user would want to do that, so
2775 * issue a warning if we're running on a terminal. */
2776 if (!id && ctx->argc <= 3 && isatty(STDOUT_FILENO)) {
2777 VLOG_WARN("\"get\" command without row arguments or \"--id\" is "
2778 "possibly erroneous");
2781 table = pre_get_table(ctx, table_name);
2782 for (i = 3; i < ctx->argc; i++) {
2783 if (!strcasecmp(ctx->argv[i], "_uuid")
2784 || !strcasecmp(ctx->argv[i], "-uuid")) {
2788 pre_parse_column_key_value(ctx, ctx->argv[i], table);
2793 cmd_get(struct vsctl_context *ctx)
2795 const char *id = shash_find_data(&ctx->options, "--id");
2796 bool if_exists = shash_find(&ctx->options, "--if-exists");
2797 const char *table_name = ctx->argv[1];
2798 const char *record_id = ctx->argv[2];
2799 const struct vsctl_table_class *table;
2800 const struct ovsdb_idl_row *row;
2801 struct ds *out = &ctx->output;
2804 table = get_table(table_name);
2805 row = must_get_row(ctx, table, record_id);
2807 struct ovsdb_symbol *symbol;
2810 symbol = create_symbol(ctx->symtab, id, &new);
2812 vsctl_fatal("row id \"%s\" specified on \"get\" command was used "
2813 "before it was defined", id);
2815 symbol->uuid = row->uuid;
2817 /* This symbol refers to a row that already exists, so disable warnings
2818 * about it being unreferenced. */
2819 symbol->strong_ref = true;
2821 for (i = 3; i < ctx->argc; i++) {
2822 const struct ovsdb_idl_column *column;
2823 const struct ovsdb_datum *datum;
2826 /* Special case for obtaining the UUID of a row. We can't just do this
2827 * through parse_column_key_value() below since it returns a "struct
2828 * ovsdb_idl_column" and the UUID column doesn't have one. */
2829 if (!strcasecmp(ctx->argv[i], "_uuid")
2830 || !strcasecmp(ctx->argv[i], "-uuid")) {
2831 ds_put_format(out, UUID_FMT"\n", UUID_ARGS(&row->uuid));
2835 die_if_error(parse_column_key_value(ctx->argv[i], table,
2836 &column, &key_string,
2837 NULL, NULL, 0, NULL));
2839 ovsdb_idl_txn_verify(row, column);
2840 datum = ovsdb_idl_read(row, column);
2842 union ovsdb_atom key;
2845 if (column->type.value.type == OVSDB_TYPE_VOID) {
2846 vsctl_fatal("cannot specify key to get for non-map column %s",
2850 die_if_error(ovsdb_atom_from_string(&key,
2852 key_string, ctx->symtab));
2854 idx = ovsdb_datum_find_key(datum, &key,
2855 column->type.key.type);
2856 if (idx == UINT_MAX) {
2858 vsctl_fatal("no key \"%s\" in %s record \"%s\" column %s",
2859 key_string, table->class->name, record_id,
2863 ovsdb_atom_to_string(&datum->values[idx],
2864 column->type.value.type, out);
2866 ovsdb_atom_destroy(&key, column->type.key.type);
2868 ovsdb_datum_to_string(datum, &column->type, out);
2870 ds_put_char(out, '\n');
2877 parse_column_names(const char *column_names,
2878 const struct vsctl_table_class *table,
2879 const struct ovsdb_idl_column ***columnsp,
2882 const struct ovsdb_idl_column **columns;
2885 if (!column_names) {
2888 n_columns = table->class->n_columns + 1;
2889 columns = xmalloc(n_columns * sizeof *columns);
2891 for (i = 0; i < table->class->n_columns; i++) {
2892 columns[i + 1] = &table->class->columns[i];
2895 char *s = xstrdup(column_names);
2896 size_t allocated_columns;
2897 char *save_ptr = NULL;
2901 allocated_columns = n_columns = 0;
2902 for (column_name = strtok_r(s, ", ", &save_ptr); column_name;
2903 column_name = strtok_r(NULL, ", ", &save_ptr)) {
2904 const struct ovsdb_idl_column *column;
2906 if (!strcasecmp(column_name, "_uuid")) {
2909 die_if_error(get_column(table, column_name, &column));
2911 if (n_columns >= allocated_columns) {
2912 columns = x2nrealloc(columns, &allocated_columns,
2915 columns[n_columns++] = column;
2920 vsctl_fatal("must specify at least one column name");
2923 *columnsp = columns;
2924 *n_columnsp = n_columns;
2929 pre_list_columns(struct vsctl_context *ctx,
2930 const struct vsctl_table_class *table,
2931 const char *column_names)
2933 const struct ovsdb_idl_column **columns;
2937 parse_column_names(column_names, table, &columns, &n_columns);
2938 for (i = 0; i < n_columns; i++) {
2940 ovsdb_idl_add_column(ctx->idl, columns[i]);
2947 pre_cmd_list(struct vsctl_context *ctx)
2949 const char *column_names = shash_find_data(&ctx->options, "--columns");
2950 const char *table_name = ctx->argv[1];
2951 const struct vsctl_table_class *table;
2953 table = pre_get_table(ctx, table_name);
2954 pre_list_columns(ctx, table, column_names);
2957 static struct table *
2958 list_make_table(const struct ovsdb_idl_column **columns, size_t n_columns)
2963 out = xmalloc(sizeof *out);
2966 for (i = 0; i < n_columns; i++) {
2967 const struct ovsdb_idl_column *column = columns[i];
2968 const char *column_name = column ? column->name : "_uuid";
2970 table_add_column(out, "%s", column_name);
2977 list_record(const struct ovsdb_idl_row *row,
2978 const struct ovsdb_idl_column **columns, size_t n_columns,
2984 for (i = 0; i < n_columns; i++) {
2985 const struct ovsdb_idl_column *column = columns[i];
2986 struct cell *cell = table_add_cell(out);
2989 struct ovsdb_datum datum;
2990 union ovsdb_atom atom;
2992 atom.uuid = row->uuid;
2995 datum.values = NULL;
2998 cell->json = ovsdb_datum_to_json(&datum, &ovsdb_type_uuid);
2999 cell->type = &ovsdb_type_uuid;
3001 const struct ovsdb_datum *datum = ovsdb_idl_read(row, column);
3003 cell->json = ovsdb_datum_to_json(datum, &column->type);
3004 cell->type = &column->type;
3010 cmd_list(struct vsctl_context *ctx)
3012 const char *column_names = shash_find_data(&ctx->options, "--columns");
3013 const struct ovsdb_idl_column **columns;
3014 const char *table_name = ctx->argv[1];
3015 const struct vsctl_table_class *table;
3020 table = get_table(table_name);
3021 parse_column_names(column_names, table, &columns, &n_columns);
3022 out = ctx->table = list_make_table(columns, n_columns);
3023 if (ctx->argc > 2) {
3024 for (i = 2; i < ctx->argc; i++) {
3025 list_record(must_get_row(ctx, table, ctx->argv[i]),
3026 columns, n_columns, out);
3029 const struct ovsdb_idl_row *row;
3031 for (row = ovsdb_idl_first_row(ctx->idl, table->class); row != NULL;
3032 row = ovsdb_idl_next_row(row)) {
3033 list_record(row, columns, n_columns, out);
3040 pre_cmd_find(struct vsctl_context *ctx)
3042 const char *column_names = shash_find_data(&ctx->options, "--columns");
3043 const char *table_name = ctx->argv[1];
3044 const struct vsctl_table_class *table;
3047 table = pre_get_table(ctx, table_name);
3048 pre_list_columns(ctx, table, column_names);
3049 for (i = 2; i < ctx->argc; i++) {
3050 pre_parse_column_key_value(ctx, ctx->argv[i], table);
3055 cmd_find(struct vsctl_context *ctx)
3057 const char *column_names = shash_find_data(&ctx->options, "--columns");
3058 const struct ovsdb_idl_column **columns;
3059 const char *table_name = ctx->argv[1];
3060 const struct vsctl_table_class *table;
3061 const struct ovsdb_idl_row *row;
3065 table = get_table(table_name);
3066 parse_column_names(column_names, table, &columns, &n_columns);
3067 out = ctx->table = list_make_table(columns, n_columns);
3068 for (row = ovsdb_idl_first_row(ctx->idl, table->class); row;
3069 row = ovsdb_idl_next_row(row)) {
3072 for (i = 2; i < ctx->argc; i++) {
3073 if (!is_condition_satisfied(table, row, ctx->argv[i],
3078 list_record(row, columns, n_columns, out);
3086 pre_cmd_set(struct vsctl_context *ctx)
3088 const char *table_name = ctx->argv[1];
3089 const struct vsctl_table_class *table;
3092 table = pre_get_table(ctx, table_name);
3093 for (i = 3; i < ctx->argc; i++) {
3094 pre_parse_column_key_value(ctx, ctx->argv[i], table);
3099 set_column(const struct vsctl_table_class *table,
3100 const struct ovsdb_idl_row *row, const char *arg,
3101 struct ovsdb_symbol_table *symtab)
3103 const struct ovsdb_idl_column *column;
3104 char *key_string, *value_string;
3107 error = parse_column_key_value(arg, table, &column, &key_string,
3108 NULL, NULL, 0, &value_string);
3109 die_if_error(error);
3110 if (!value_string) {
3111 vsctl_fatal("%s: missing value", arg);
3115 union ovsdb_atom key, value;
3116 struct ovsdb_datum datum;
3118 if (column->type.value.type == OVSDB_TYPE_VOID) {
3119 vsctl_fatal("cannot specify key to set for non-map column %s",
3123 die_if_error(ovsdb_atom_from_string(&key, &column->type.key,
3124 key_string, symtab));
3125 die_if_error(ovsdb_atom_from_string(&value, &column->type.value,
3126 value_string, symtab));
3128 ovsdb_datum_init_empty(&datum);
3129 ovsdb_datum_add_unsafe(&datum, &key, &value, &column->type);
3131 ovsdb_atom_destroy(&key, column->type.key.type);
3132 ovsdb_atom_destroy(&value, column->type.value.type);
3134 ovsdb_datum_union(&datum, ovsdb_idl_read(row, column),
3135 &column->type, false);
3136 ovsdb_idl_txn_write(row, column, &datum);
3138 struct ovsdb_datum datum;
3140 die_if_error(ovsdb_datum_from_string(&datum, &column->type,
3141 value_string, symtab));
3142 ovsdb_idl_txn_write(row, column, &datum);
3150 cmd_set(struct vsctl_context *ctx)
3152 const char *table_name = ctx->argv[1];
3153 const char *record_id = ctx->argv[2];
3154 const struct vsctl_table_class *table;
3155 const struct ovsdb_idl_row *row;
3158 table = get_table(table_name);
3159 row = must_get_row(ctx, table, record_id);
3160 for (i = 3; i < ctx->argc; i++) {
3161 set_column(table, row, ctx->argv[i], ctx->symtab);
3166 pre_cmd_add(struct vsctl_context *ctx)
3168 const char *table_name = ctx->argv[1];
3169 const char *column_name = ctx->argv[3];
3170 const struct vsctl_table_class *table;
3171 const struct ovsdb_idl_column *column;
3173 table = pre_get_table(ctx, table_name);
3174 pre_get_column(ctx, table, column_name, &column);
3178 cmd_add(struct vsctl_context *ctx)
3180 const char *table_name = ctx->argv[1];
3181 const char *record_id = ctx->argv[2];
3182 const char *column_name = ctx->argv[3];
3183 const struct vsctl_table_class *table;
3184 const struct ovsdb_idl_column *column;
3185 const struct ovsdb_idl_row *row;
3186 const struct ovsdb_type *type;
3187 struct ovsdb_datum old;
3190 table = get_table(table_name);
3191 row = must_get_row(ctx, table, record_id);
3192 die_if_error(get_column(table, column_name, &column));
3194 type = &column->type;
3195 ovsdb_datum_clone(&old, ovsdb_idl_read(row, column), &column->type);
3196 for (i = 4; i < ctx->argc; i++) {
3197 struct ovsdb_type add_type;
3198 struct ovsdb_datum add;
3202 add_type.n_max = UINT_MAX;
3203 die_if_error(ovsdb_datum_from_string(&add, &add_type, ctx->argv[i],
3205 ovsdb_datum_union(&old, &add, type, false);
3206 ovsdb_datum_destroy(&add, type);
3208 if (old.n > type->n_max) {
3209 vsctl_fatal("\"add\" operation would put %u %s in column %s of "
3210 "table %s but the maximum number is %u",
3212 type->value.type == OVSDB_TYPE_VOID ? "values" : "pairs",
3213 column->name, table->class->name, type->n_max);
3215 ovsdb_idl_txn_verify(row, column);
3216 ovsdb_idl_txn_write(row, column, &old);
3220 pre_cmd_remove(struct vsctl_context *ctx)
3222 const char *table_name = ctx->argv[1];
3223 const char *column_name = ctx->argv[3];
3224 const struct vsctl_table_class *table;
3225 const struct ovsdb_idl_column *column;
3227 table = pre_get_table(ctx, table_name);
3228 pre_get_column(ctx, table, column_name, &column);
3232 cmd_remove(struct vsctl_context *ctx)
3234 const char *table_name = ctx->argv[1];
3235 const char *record_id = ctx->argv[2];
3236 const char *column_name = ctx->argv[3];
3237 const struct vsctl_table_class *table;
3238 const struct ovsdb_idl_column *column;
3239 const struct ovsdb_idl_row *row;
3240 const struct ovsdb_type *type;
3241 struct ovsdb_datum old;
3244 table = get_table(table_name);
3245 row = must_get_row(ctx, table, record_id);
3246 die_if_error(get_column(table, column_name, &column));
3248 type = &column->type;
3249 ovsdb_datum_clone(&old, ovsdb_idl_read(row, column), &column->type);
3250 for (i = 4; i < ctx->argc; i++) {
3251 struct ovsdb_type rm_type;
3252 struct ovsdb_datum rm;
3257 rm_type.n_max = UINT_MAX;
3258 error = ovsdb_datum_from_string(&rm, &rm_type,
3259 ctx->argv[i], ctx->symtab);
3260 if (error && ovsdb_type_is_map(&rm_type)) {
3262 rm_type.value.type = OVSDB_TYPE_VOID;
3263 die_if_error(ovsdb_datum_from_string(&rm, &rm_type,
3264 ctx->argv[i], ctx->symtab));
3266 ovsdb_datum_subtract(&old, type, &rm, &rm_type);
3267 ovsdb_datum_destroy(&rm, &rm_type);
3269 if (old.n < type->n_min) {
3270 vsctl_fatal("\"remove\" operation would put %u %s in column %s of "
3271 "table %s but the minimum number is %u",
3273 type->value.type == OVSDB_TYPE_VOID ? "values" : "pairs",
3274 column->name, table->class->name, type->n_min);
3276 ovsdb_idl_txn_verify(row, column);
3277 ovsdb_idl_txn_write(row, column, &old);
3281 pre_cmd_clear(struct vsctl_context *ctx)
3283 const char *table_name = ctx->argv[1];
3284 const struct vsctl_table_class *table;
3287 table = pre_get_table(ctx, table_name);
3288 for (i = 3; i < ctx->argc; i++) {
3289 const struct ovsdb_idl_column *column;
3291 pre_get_column(ctx, table, ctx->argv[i], &column);
3296 cmd_clear(struct vsctl_context *ctx)
3298 const char *table_name = ctx->argv[1];
3299 const char *record_id = ctx->argv[2];
3300 const struct vsctl_table_class *table;
3301 const struct ovsdb_idl_row *row;
3304 table = get_table(table_name);
3305 row = must_get_row(ctx, table, record_id);
3306 for (i = 3; i < ctx->argc; i++) {
3307 const struct ovsdb_idl_column *column;
3308 const struct ovsdb_type *type;
3309 struct ovsdb_datum datum;
3311 die_if_error(get_column(table, ctx->argv[i], &column));
3313 type = &column->type;
3314 if (type->n_min > 0) {
3315 vsctl_fatal("\"clear\" operation cannot be applied to column %s "
3316 "of table %s, which is not allowed to be empty",
3317 column->name, table->class->name);
3320 ovsdb_datum_init_empty(&datum);
3321 ovsdb_idl_txn_write(row, column, &datum);
3326 pre_create(struct vsctl_context *ctx)
3328 const char *id = shash_find_data(&ctx->options, "--id");
3329 const char *table_name = ctx->argv[1];
3330 const struct vsctl_table_class *table;
3332 table = get_table(table_name);
3333 if (!id && !table->class->is_root) {
3334 VLOG_WARN("applying \"create\" command to table %s without --id "
3335 "option will have no effect", table->class->name);
3340 cmd_create(struct vsctl_context *ctx)
3342 const char *id = shash_find_data(&ctx->options, "--id");
3343 const char *table_name = ctx->argv[1];
3344 const struct vsctl_table_class *table = get_table(table_name);
3345 const struct ovsdb_idl_row *row;
3346 const struct uuid *uuid;
3350 struct ovsdb_symbol *symbol = create_symbol(ctx->symtab, id, NULL);
3351 if (table->class->is_root) {
3352 /* This table is in the root set, meaning that rows created in it
3353 * won't disappear even if they are unreferenced, so disable
3354 * warnings about that by pretending that there is a reference. */
3355 symbol->strong_ref = true;
3357 uuid = &symbol->uuid;
3362 row = ovsdb_idl_txn_insert(ctx->txn, table->class, uuid);
3363 for (i = 2; i < ctx->argc; i++) {
3364 set_column(table, row, ctx->argv[i], ctx->symtab);
3366 ds_put_format(&ctx->output, UUID_FMT, UUID_ARGS(&row->uuid));
3369 /* This function may be used as the 'postprocess' function for commands that
3370 * insert new rows into the database. It expects that the command's 'run'
3371 * function prints the UUID reported by ovsdb_idl_txn_insert() as the command's
3372 * sole output. It replaces that output by the row's permanent UUID assigned
3373 * by the database server and appends a new-line.
3375 * Currently we use this only for "create", because the higher-level commands
3376 * are supposed to be independent of the actual structure of the vswitch
3379 post_create(struct vsctl_context *ctx)
3381 const struct uuid *real;
3384 if (!uuid_from_string(&dummy, ds_cstr(&ctx->output))) {
3387 real = ovsdb_idl_txn_get_insert_uuid(ctx->txn, &dummy);
3389 ds_clear(&ctx->output);
3390 ds_put_format(&ctx->output, UUID_FMT, UUID_ARGS(real));
3392 ds_put_char(&ctx->output, '\n');
3396 pre_cmd_destroy(struct vsctl_context *ctx)
3398 const char *table_name = ctx->argv[1];
3400 pre_get_table(ctx, table_name);
3404 cmd_destroy(struct vsctl_context *ctx)
3406 bool must_exist = !shash_find(&ctx->options, "--if-exists");
3407 const char *table_name = ctx->argv[1];
3408 const struct vsctl_table_class *table;
3411 table = get_table(table_name);
3412 for (i = 2; i < ctx->argc; i++) {
3413 const struct ovsdb_idl_row *row;
3415 row = (must_exist ? must_get_row : get_row)(ctx, table, ctx->argv[i]);
3417 ovsdb_idl_txn_delete(row);
3423 RELOP(RELOP_EQ, "=") \
3424 RELOP(RELOP_NE, "!=") \
3425 RELOP(RELOP_LT, "<") \
3426 RELOP(RELOP_GT, ">") \
3427 RELOP(RELOP_LE, "<=") \
3428 RELOP(RELOP_GE, ">=") \
3429 RELOP(RELOP_SET_EQ, "{=}") \
3430 RELOP(RELOP_SET_NE, "{!=}") \
3431 RELOP(RELOP_SET_LT, "{<}") \
3432 RELOP(RELOP_SET_GT, "{>}") \
3433 RELOP(RELOP_SET_LE, "{<=}") \
3434 RELOP(RELOP_SET_GE, "{>=}")
3437 #define RELOP(ENUM, STRING) ENUM,
3443 is_set_operator(enum relop op)
3445 return (op == RELOP_SET_EQ || op == RELOP_SET_NE ||
3446 op == RELOP_SET_LT || op == RELOP_SET_GT ||
3447 op == RELOP_SET_LE || op == RELOP_SET_GE);
3451 evaluate_relop(const struct ovsdb_datum *a, const struct ovsdb_datum *b,
3452 const struct ovsdb_type *type, enum relop op)
3457 return ovsdb_datum_compare_3way(a, b, type) == 0;
3460 return ovsdb_datum_compare_3way(a, b, type) != 0;
3462 return ovsdb_datum_compare_3way(a, b, type) < 0;
3464 return ovsdb_datum_compare_3way(a, b, type) > 0;
3466 return ovsdb_datum_compare_3way(a, b, type) <= 0;
3468 return ovsdb_datum_compare_3way(a, b, type) >= 0;
3471 return b->n > a->n && ovsdb_datum_includes_all(a, b, type);
3473 return a->n > b->n && ovsdb_datum_includes_all(b, a, type);
3475 return ovsdb_datum_includes_all(a, b, type);
3477 return ovsdb_datum_includes_all(b, a, type);
3485 is_condition_satisfied(const struct vsctl_table_class *table,
3486 const struct ovsdb_idl_row *row, const char *arg,
3487 struct ovsdb_symbol_table *symtab)
3489 static const char *operators[] = {
3490 #define RELOP(ENUM, STRING) STRING,
3495 const struct ovsdb_idl_column *column;
3496 const struct ovsdb_datum *have_datum;
3497 char *key_string, *value_string;
3498 struct ovsdb_type type;
3503 error = parse_column_key_value(arg, table, &column, &key_string,
3504 &operator, operators, ARRAY_SIZE(operators),
3506 die_if_error(error);
3507 if (!value_string) {
3508 vsctl_fatal("%s: missing value", arg);
3511 type = column->type;
3512 type.n_max = UINT_MAX;
3514 have_datum = ovsdb_idl_read(row, column);
3516 union ovsdb_atom want_key;
3517 struct ovsdb_datum b;
3520 if (column->type.value.type == OVSDB_TYPE_VOID) {
3521 vsctl_fatal("cannot specify key to check for non-map column %s",
3525 die_if_error(ovsdb_atom_from_string(&want_key, &column->type.key,
3526 key_string, symtab));
3528 type.key = type.value;
3529 type.value.type = OVSDB_TYPE_VOID;
3530 die_if_error(ovsdb_datum_from_string(&b, &type, value_string, symtab));
3532 idx = ovsdb_datum_find_key(have_datum,
3533 &want_key, column->type.key.type);
3534 if (idx == UINT_MAX && !is_set_operator(operator)) {
3537 struct ovsdb_datum a;
3539 if (idx != UINT_MAX) {
3541 a.keys = &have_datum->values[idx];
3549 retval = evaluate_relop(&a, &b, &type, operator);
3552 ovsdb_atom_destroy(&want_key, column->type.key.type);
3553 ovsdb_datum_destroy(&b, &type);
3555 struct ovsdb_datum want_datum;
3557 die_if_error(ovsdb_datum_from_string(&want_datum, &column->type,
3558 value_string, symtab));
3559 retval = evaluate_relop(have_datum, &want_datum, &type, operator);
3560 ovsdb_datum_destroy(&want_datum, &column->type);
3570 pre_cmd_wait_until(struct vsctl_context *ctx)
3572 const char *table_name = ctx->argv[1];
3573 const struct vsctl_table_class *table;
3576 table = pre_get_table(ctx, table_name);
3578 for (i = 3; i < ctx->argc; i++) {
3579 pre_parse_column_key_value(ctx, ctx->argv[i], table);
3584 cmd_wait_until(struct vsctl_context *ctx)
3586 const char *table_name = ctx->argv[1];
3587 const char *record_id = ctx->argv[2];
3588 const struct vsctl_table_class *table;
3589 const struct ovsdb_idl_row *row;
3592 table = get_table(table_name);
3594 row = get_row(ctx, table, record_id);
3596 ctx->try_again = true;
3600 for (i = 3; i < ctx->argc; i++) {
3601 if (!is_condition_satisfied(table, row, ctx->argv[i], ctx->symtab)) {
3602 ctx->try_again = true;
3609 vsctl_context_init(struct vsctl_context *ctx, struct vsctl_command *command,
3610 struct ovsdb_idl *idl, struct ovsdb_idl_txn *txn,
3611 const struct ovsrec_open_vswitch *ovs,
3612 struct ovsdb_symbol_table *symtab)
3614 ctx->argc = command->argc;
3615 ctx->argv = command->argv;
3616 ctx->options = command->options;
3618 ds_swap(&ctx->output, &command->output);
3619 ctx->table = command->table;
3623 ctx->symtab = symtab;
3624 ctx->verified_ports = false;
3626 ctx->try_again = false;
3630 vsctl_context_done(struct vsctl_context *ctx, struct vsctl_command *command)
3632 ds_swap(&ctx->output, &command->output);
3633 command->table = ctx->table;
3637 run_prerequisites(struct vsctl_command *commands, size_t n_commands,
3638 struct ovsdb_idl *idl)
3640 struct vsctl_command *c;
3642 ovsdb_idl_add_table(idl, &ovsrec_table_open_vswitch);
3643 if (wait_for_reload) {
3644 ovsdb_idl_add_column(idl, &ovsrec_open_vswitch_col_cur_cfg);
3646 for (c = commands; c < &commands[n_commands]; c++) {
3647 if (c->syntax->prerequisites) {
3648 struct vsctl_context ctx;
3650 ds_init(&c->output);
3653 vsctl_context_init(&ctx, c, idl, NULL, NULL, NULL);
3654 (c->syntax->prerequisites)(&ctx);
3655 vsctl_context_done(&ctx, c);
3657 assert(!c->output.string);
3664 do_vsctl(const char *args, struct vsctl_command *commands, size_t n_commands,
3665 struct ovsdb_idl *idl)
3667 struct ovsdb_idl_txn *txn;
3668 const struct ovsrec_open_vswitch *ovs;
3669 enum ovsdb_idl_txn_status status;
3670 struct ovsdb_symbol_table *symtab;
3671 struct vsctl_command *c;
3672 struct shash_node *node;
3673 int64_t next_cfg = 0;
3676 txn = the_idl_txn = ovsdb_idl_txn_create(idl);
3678 ovsdb_idl_txn_set_dry_run(txn);
3681 ovsdb_idl_txn_add_comment(txn, "ovs-vsctl: %s", args);
3683 ovs = ovsrec_open_vswitch_first(idl);
3685 /* XXX add verification that table is empty */
3686 ovs = ovsrec_open_vswitch_insert(txn);
3689 if (wait_for_reload) {
3690 ovsdb_idl_txn_increment(txn, &ovs->header_,
3691 &ovsrec_open_vswitch_col_next_cfg);
3694 symtab = ovsdb_symbol_table_create();
3695 for (c = commands; c < &commands[n_commands]; c++) {
3696 ds_init(&c->output);
3699 for (c = commands; c < &commands[n_commands]; c++) {
3700 struct vsctl_context ctx;
3702 vsctl_context_init(&ctx, c, idl, txn, ovs, symtab);
3703 if (c->syntax->run) {
3704 (c->syntax->run)(&ctx);
3706 vsctl_context_done(&ctx, c);
3708 if (ctx.try_again) {
3709 status = TXN_TRY_AGAIN;
3714 SHASH_FOR_EACH (node, &symtab->sh) {
3715 struct ovsdb_symbol *symbol = node->data;
3716 if (!symbol->created) {
3717 vsctl_fatal("row id \"%s\" is referenced but never created (e.g. "
3718 "with \"-- --id=%s create ...\")",
3719 node->name, node->name);
3721 if (!symbol->strong_ref) {
3722 if (!symbol->weak_ref) {
3723 VLOG_WARN("row id \"%s\" was created but no reference to it "
3724 "was inserted, so it will not actually appear in "
3725 "the database", node->name);
3727 VLOG_WARN("row id \"%s\" was created but only a weak "
3728 "reference to it was inserted, so it will not "
3729 "actually appear in the database", node->name);
3734 status = ovsdb_idl_txn_commit_block(txn);
3735 if (wait_for_reload && status == TXN_SUCCESS) {
3736 next_cfg = ovsdb_idl_txn_get_increment_new_value(txn);
3738 if (status == TXN_UNCHANGED || status == TXN_SUCCESS) {
3739 for (c = commands; c < &commands[n_commands]; c++) {
3740 if (c->syntax->postprocess) {
3741 struct vsctl_context ctx;
3743 vsctl_context_init(&ctx, c, idl, txn, ovs, symtab);
3744 (c->syntax->postprocess)(&ctx);
3745 vsctl_context_done(&ctx, c);
3749 error = xstrdup(ovsdb_idl_txn_get_error(txn));
3750 ovsdb_idl_txn_destroy(txn);
3751 txn = the_idl_txn = NULL;
3754 case TXN_UNCOMMITTED:
3755 case TXN_INCOMPLETE:
3759 /* Should not happen--we never call ovsdb_idl_txn_abort(). */
3760 vsctl_fatal("transaction aborted");
3770 vsctl_fatal("transaction error: %s", error);
3772 case TXN_NOT_LOCKED:
3773 /* Should not happen--we never call ovsdb_idl_set_lock(). */
3774 vsctl_fatal("database not locked");
3781 ovsdb_symbol_table_destroy(symtab);
3783 for (c = commands; c < &commands[n_commands]; c++) {
3784 struct ds *ds = &c->output;
3787 table_print(c->table, &table_style);
3788 } else if (oneline) {
3792 for (j = 0; j < ds->length; j++) {
3793 int ch = ds->string[j];
3796 fputs("\\n", stdout);
3800 fputs("\\\\", stdout);
3809 fputs(ds_cstr(ds), stdout);
3811 ds_destroy(&c->output);
3812 table_destroy(c->table);
3815 smap_destroy(&c->options);
3819 if (wait_for_reload && status != TXN_UNCHANGED) {
3822 OVSREC_OPEN_VSWITCH_FOR_EACH (ovs, idl) {
3823 if (ovs->cur_cfg >= next_cfg) {
3827 ovsdb_idl_wait(idl);
3832 ovsdb_idl_destroy(idl);
3837 /* Our transaction needs to be rerun, or a prerequisite was not met. Free
3838 * resources and return so that the caller can try again. */
3840 ovsdb_idl_txn_abort(txn);
3841 ovsdb_idl_txn_destroy(txn);
3843 ovsdb_symbol_table_destroy(symtab);
3844 for (c = commands; c < &commands[n_commands]; c++) {
3845 ds_destroy(&c->output);
3846 table_destroy(c->table);
3852 static const struct vsctl_command_syntax all_commands[] = {
3853 /* Open vSwitch commands. */
3854 {"init", 0, 0, NULL, cmd_init, NULL, "", RW},
3855 {"show", 0, 0, pre_cmd_show, cmd_show, NULL, "", RO},
3857 /* Bridge commands. */
3858 {"add-br", 1, 3, pre_get_info, cmd_add_br, NULL, "--may-exist", RW},
3859 {"del-br", 1, 1, pre_get_info, cmd_del_br, NULL, "--if-exists", RW},
3860 {"list-br", 0, 0, pre_get_info, cmd_list_br, NULL, "", RO},
3861 {"br-exists", 1, 1, pre_get_info, cmd_br_exists, NULL, "", RO},
3862 {"br-to-vlan", 1, 1, pre_get_info, cmd_br_to_vlan, NULL, "", RO},
3863 {"br-to-parent", 1, 1, pre_get_info, cmd_br_to_parent, NULL, "", RO},
3864 {"br-set-external-id", 2, 3, pre_cmd_br_set_external_id,
3865 cmd_br_set_external_id, NULL, "", RW},
3866 {"br-get-external-id", 1, 2, pre_cmd_br_get_external_id,
3867 cmd_br_get_external_id, NULL, "", RO},
3869 /* Port commands. */
3870 {"list-ports", 1, 1, pre_get_info, cmd_list_ports, NULL, "", RO},
3871 {"add-port", 2, INT_MAX, pre_get_info, cmd_add_port, NULL, "--may-exist",
3873 {"add-bond", 4, INT_MAX, pre_get_info, cmd_add_bond, NULL,
3874 "--may-exist,--fake-iface", RW},
3875 {"del-port", 1, 2, pre_get_info, cmd_del_port, NULL,
3876 "--if-exists,--with-iface", RW},
3877 {"port-to-br", 1, 1, pre_get_info, cmd_port_to_br, NULL, "", RO},
3879 /* Interface commands. */
3880 {"list-ifaces", 1, 1, pre_get_info, cmd_list_ifaces, NULL, "", RO},
3881 {"iface-to-br", 1, 1, pre_get_info, cmd_iface_to_br, NULL, "", RO},
3883 /* Controller commands. */
3884 {"get-controller", 1, 1, pre_controller, cmd_get_controller, NULL, "", RO},
3885 {"del-controller", 1, 1, pre_controller, cmd_del_controller, NULL, "", RW},
3886 {"set-controller", 1, INT_MAX, pre_controller, cmd_set_controller, NULL,
3888 {"get-fail-mode", 1, 1, pre_get_info, cmd_get_fail_mode, NULL, "", RO},
3889 {"del-fail-mode", 1, 1, pre_get_info, cmd_del_fail_mode, NULL, "", RW},
3890 {"set-fail-mode", 2, 2, pre_get_info, cmd_set_fail_mode, NULL, "", RW},
3892 /* Manager commands. */
3893 {"get-manager", 0, 0, pre_manager, cmd_get_manager, NULL, "", RO},
3894 {"del-manager", 0, INT_MAX, pre_manager, cmd_del_manager, NULL, "", RW},
3895 {"set-manager", 1, INT_MAX, pre_manager, cmd_set_manager, NULL, "", RW},
3898 {"get-ssl", 0, 0, pre_cmd_get_ssl, cmd_get_ssl, NULL, "", RO},
3899 {"del-ssl", 0, 0, pre_cmd_del_ssl, cmd_del_ssl, NULL, "", RW},
3900 {"set-ssl", 3, 3, pre_cmd_set_ssl, cmd_set_ssl, NULL, "--bootstrap", RW},
3902 /* Switch commands. */
3903 {"emer-reset", 0, 0, pre_cmd_emer_reset, cmd_emer_reset, NULL, "", RW},
3905 /* Database commands. */
3906 {"comment", 0, INT_MAX, NULL, NULL, NULL, "", RO},
3907 {"get", 2, INT_MAX, pre_cmd_get, cmd_get, NULL, "--if-exists,--id=", RO},
3908 {"list", 1, INT_MAX, pre_cmd_list, cmd_list, NULL, "--columns=", RO},
3909 {"find", 1, INT_MAX, pre_cmd_find, cmd_find, NULL, "--columns=", RO},
3910 {"set", 3, INT_MAX, pre_cmd_set, cmd_set, NULL, "", RW},
3911 {"add", 4, INT_MAX, pre_cmd_add, cmd_add, NULL, "", RW},
3912 {"remove", 4, INT_MAX, pre_cmd_remove, cmd_remove, NULL, "", RW},
3913 {"clear", 3, INT_MAX, pre_cmd_clear, cmd_clear, NULL, "", RW},
3914 {"create", 2, INT_MAX, pre_create, cmd_create, post_create, "--id=", RW},
3915 {"destroy", 1, INT_MAX, pre_cmd_destroy, cmd_destroy, NULL, "--if-exists",
3917 {"wait-until", 2, INT_MAX, pre_cmd_wait_until, cmd_wait_until, NULL, "",
3920 {NULL, 0, 0, NULL, NULL, NULL, NULL, RO},