2 * Copyright (c) 2009, 2010 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.
30 #include "command-line.h"
33 #include "dynamic-string.h"
35 #include "ovsdb-data.h"
36 #include "ovsdb-idl.h"
37 #include "poll-loop.h"
39 #include "stream-ssl.h"
41 #include "vswitchd/vswitch-idl.h"
46 VLOG_DEFINE_THIS_MODULE(vsctl)
48 /* vsctl_fatal() also logs the error, so it is preferred in this file. */
49 #define ovs_fatal please_use_vsctl_fatal_instead_of_ovs_fatal
53 typedef void vsctl_handler_func(struct vsctl_context *);
55 struct vsctl_command_syntax {
59 vsctl_handler_func *run;
60 vsctl_handler_func *postprocess;
62 enum { RO, RW } mode; /* Does this command modify the database? */
65 struct vsctl_command {
66 /* Data that remains constant after initialization. */
67 const struct vsctl_command_syntax *syntax;
72 /* Data modified by commands. */
76 /* --db: The database server to contact. */
77 static const char *db;
79 /* --oneline: Write each command's output as a single line? */
82 /* --dry-run: Do not commit any changes. */
85 /* --no-wait: Wait for ovs-vswitchd to reload its configuration? */
86 static bool wait_for_reload = true;
88 /* --timeout: Time to wait for a connection to 'db'. */
91 /* All supported commands. */
92 static const struct vsctl_command_syntax all_commands[];
94 /* The IDL we're using and the current transaction, if any.
95 * This is for use by vsctl_exit() only, to allow it to clean up.
96 * Other code should use its context arguments. */
97 static struct ovsdb_idl *the_idl;
98 static struct ovsdb_idl_txn *the_idl_txn;
100 static void vsctl_exit(int status) NO_RETURN;
101 static void vsctl_fatal(const char *, ...) PRINTF_FORMAT(1, 2) NO_RETURN;
102 static char *default_db(void);
103 static void usage(void) NO_RETURN;
104 static void parse_options(int argc, char *argv[]);
105 static bool might_write_to_db(char **argv);
107 static struct vsctl_command *parse_commands(int argc, char *argv[],
108 size_t *n_commandsp);
109 static void parse_command(int argc, char *argv[], struct vsctl_command *);
110 static const struct vsctl_command_syntax *find_command(const char *name);
111 static void do_vsctl(const char *args,
112 struct vsctl_command *, size_t n_commands,
115 static const struct vsctl_table_class *get_table(const char *table_name);
116 static void set_column(const struct vsctl_table_class *,
117 const struct ovsdb_idl_row *, const char *arg,
118 struct ovsdb_symbol_table *);
121 main(int argc, char *argv[])
123 extern struct vlog_module VLM_reconnect;
124 struct ovsdb_idl *idl;
125 struct vsctl_command *commands;
129 set_program_name(argv[0]);
130 signal(SIGPIPE, SIG_IGN);
131 vlog_set_levels(NULL, VLF_CONSOLE, VLL_WARN);
132 vlog_set_levels(&VLM_reconnect, VLF_ANY_FACILITY, VLL_WARN);
135 /* Log our arguments. This is often valuable for debugging systems. */
136 args = process_escape_args(argv);
137 VLOG(might_write_to_db(argv) ? VLL_INFO : VLL_DBG, "Called as %s", args);
139 /* Parse command line. */
140 parse_options(argc, argv);
141 commands = parse_commands(argc - optind, argv + optind, &n_commands);
147 /* Now execute the commands. */
148 idl = the_idl = ovsdb_idl_create(db, &ovsrec_idl_class);
150 if (ovsdb_idl_run(idl)) {
151 do_vsctl(args, commands, n_commands, idl);
160 parse_options(int argc, char *argv[])
163 OPT_DB = UCHAR_MAX + 1,
171 static struct option long_options[] = {
172 {"db", required_argument, 0, OPT_DB},
173 {"no-syslog", no_argument, 0, OPT_NO_SYSLOG},
174 {"no-wait", no_argument, 0, OPT_NO_WAIT},
175 {"dry-run", no_argument, 0, OPT_DRY_RUN},
176 {"oneline", no_argument, 0, OPT_ONELINE},
177 {"timeout", required_argument, 0, 't'},
178 {"help", no_argument, 0, 'h'},
179 {"version", no_argument, 0, 'V'},
182 STREAM_SSL_LONG_OPTIONS
183 {"peer-ca-cert", required_argument, 0, OPT_PEER_CA_CERT},
187 char *tmp, *short_options;
189 tmp = long_options_to_short_options(long_options);
190 short_options = xasprintf("+%s", tmp);
196 c = getopt_long(argc, argv, short_options, long_options, NULL);
211 vlog_set_levels(&VLM_vsctl, VLF_SYSLOG, VLL_WARN);
215 wait_for_reload = false;
226 OVS_PRINT_VERSION(0, 0);
230 timeout = strtoul(optarg, NULL, 10);
232 vsctl_fatal("value %s on -t or --timeout is invalid",
240 STREAM_SSL_OPTION_HANDLERS
242 case OPT_PEER_CA_CERT:
243 stream_ssl_set_peer_ca_cert_file(optarg);
261 static struct vsctl_command *
262 parse_commands(int argc, char *argv[], size_t *n_commandsp)
264 struct vsctl_command *commands;
265 size_t n_commands, allocated_commands;
269 n_commands = allocated_commands = 0;
271 for (start = i = 0; i <= argc; i++) {
272 if (i == argc || !strcmp(argv[i], "--")) {
274 if (n_commands >= allocated_commands) {
275 struct vsctl_command *c;
277 commands = x2nrealloc(commands, &allocated_commands,
279 for (c = commands; c < &commands[n_commands]; c++) {
280 shash_moved(&c->options);
283 parse_command(i - start, &argv[start],
284 &commands[n_commands++]);
290 vsctl_fatal("missing command name (use --help for help)");
292 *n_commandsp = n_commands;
297 parse_command(int argc, char *argv[], struct vsctl_command *command)
299 const struct vsctl_command_syntax *p;
300 struct shash_node *node;
304 shash_init(&command->options);
305 for (i = 0; i < argc; i++) {
306 const char *option = argv[i];
310 if (option[0] != '-') {
314 equals = strchr(option, '=');
316 key = xmemdup0(option, equals - option);
317 value = xstrdup(equals + 1);
319 key = xstrdup(option);
323 if (shash_find(&command->options, key)) {
324 vsctl_fatal("'%s' option specified multiple times", argv[i]);
326 shash_add_nocopy(&command->options, key, value);
329 vsctl_fatal("missing command name");
332 p = find_command(argv[i]);
334 vsctl_fatal("unknown command '%s'; use --help for help", argv[i]);
337 SHASH_FOR_EACH (node, &command->options) {
338 const char *s = strstr(p->options, node->name);
339 int end = s ? s[strlen(node->name)] : EOF;
341 if (end != '=' && end != ',' && end != ' ' && end != '\0') {
342 vsctl_fatal("'%s' command has no '%s' option",
343 argv[i], node->name);
345 if ((end == '=') != (node->data != NULL)) {
347 vsctl_fatal("missing argument to '%s' option on '%s' "
348 "command", node->name, argv[i]);
350 vsctl_fatal("'%s' option on '%s' does not accept an "
351 "argument", node->name, argv[i]);
356 n_arg = argc - i - 1;
357 if (n_arg < p->min_args) {
358 vsctl_fatal("'%s' command requires at least %d arguments",
359 p->name, p->min_args);
360 } else if (n_arg > p->max_args) {
363 for (j = i + 1; j < argc; j++) {
364 if (argv[j][0] == '-') {
365 vsctl_fatal("'%s' command takes at most %d arguments "
366 "(note that options must precede command "
367 "names and follow a \"--\" argument)",
368 p->name, p->max_args);
372 vsctl_fatal("'%s' command takes at most %d arguments",
373 p->name, p->max_args);
377 command->argc = n_arg + 1;
378 command->argv = &argv[i];
381 /* Returns the "struct vsctl_command_syntax" for a given command 'name', or a
382 * null pointer if there is none. */
383 static const struct vsctl_command_syntax *
384 find_command(const char *name)
386 static struct shash commands = SHASH_INITIALIZER(&commands);
388 if (shash_is_empty(&commands)) {
389 const struct vsctl_command_syntax *p;
391 for (p = all_commands; p->name; p++) {
392 shash_add_assert(&commands, p->name, p);
396 return shash_find_data(&commands, name);
400 vsctl_fatal(const char *format, ...)
405 va_start(args, format);
406 message = xvasprintf(format, args);
409 vlog_set_levels(&VLM_vsctl, VLF_CONSOLE, VLL_EMER);
410 VLOG_ERR("%s", message);
411 ovs_error(0, "%s", message);
412 vsctl_exit(EXIT_FAILURE);
415 /* Frees the current transaction and the underlying IDL and then calls
418 * Freeing the transaction and the IDL is not strictly necessary, but it makes
419 * for a clean memory leak report from valgrind in the normal case. That makes
420 * it easier to notice real memory leaks. */
422 vsctl_exit(int status)
425 ovsdb_idl_txn_abort(the_idl_txn);
426 ovsdb_idl_txn_destroy(the_idl_txn);
428 ovsdb_idl_destroy(the_idl);
436 %s: ovs-vswitchd management utility\n\
437 usage: %s [OPTIONS] COMMAND [ARG...]\n\
440 add-br BRIDGE create a new bridge named BRIDGE\n\
441 add-br BRIDGE PARENT VLAN create new fake BRIDGE in PARENT on VLAN\n\
442 del-br BRIDGE delete BRIDGE and all of its ports\n\
443 list-br print the names of all the bridges\n\
444 br-exists BRIDGE test whether BRIDGE exists\n\
445 br-to-vlan BRIDGE print the VLAN which BRIDGE is on\n\
446 br-to-parent BRIDGE print the parent of BRIDGE\n\
447 br-set-external-id BRIDGE KEY VALUE set KEY on BRIDGE to VALUE\n\
448 br-set-external-id BRIDGE KEY unset KEY on BRIDGE\n\
449 br-get-external-id BRIDGE KEY print value of KEY on BRIDGE\n\
450 br-get-external-id BRIDGE list key-value pairs on BRIDGE\n\
453 list-ports BRIDGE print the names of all the ports on BRIDGE\n\
454 add-port BRIDGE PORT add network device PORT to BRIDGE\n\
455 add-bond BRIDGE PORT IFACE... add bonded port PORT in BRIDGE from IFACES\n\
456 del-port [BRIDGE] PORT delete PORT (which may be bonded) from BRIDGE\n\
457 port-to-br PORT print name of bridge that contains PORT\n\
458 A bond is considered to be a single port.\n\
460 Interface commands (a bond consists of multiple interfaces):\n\
461 list-ifaces BRIDGE print the names of all interfaces on BRIDGE\n\
462 iface-to-br IFACE print name of bridge that contains IFACE\n\
464 Controller commands:\n\
465 get-controller BRIDGE print the controller for BRIDGE\n\
466 del-controller BRIDGE delete the controller for BRIDGE\n\
467 set-controller BRIDGE TARGET set the controller for BRIDGE to TARGET\n\
468 get-fail-mode BRIDGE print the fail-mode for BRIDGE\n\
469 del-fail-mode BRIDGE delete the fail-mode for BRIDGE\n\
470 set-fail-mode BRIDGE MODE set the fail-mode for BRIDGE to MODE\n\
473 get-ssl print the SSL configuration\n\
474 del-ssl delete the SSL configuration\n\
475 set-ssl PRIV-KEY CERT CA-CERT set the SSL configuration\n\
478 emer-reset reset switch to known good state\n\
480 Database commands:\n\
481 list TBL [REC] list RECord (or all records) in TBL\n\
482 get TBL REC COL[:KEY] print values of COLumns in RECord in TBL\n\
483 set TBL REC COL[:KEY]=VALUE set COLumn values in RECord in TBL\n\
484 add TBL REC COL [KEY=]VALUE add (KEY=)VALUE to COLumn in RECord in TBL\n\
485 remove TBL REC COL [KEY=]VALUE remove (KEY=)VALUE from COLumn\n\
486 clear TBL REC COL clear values from COLumn in RECord in TBL\n\
487 create TBL COL[:KEY]=VALUE create and initialize new record\n\
488 destroy TBL REC delete RECord from TBL\n\
489 wait-until TBL REC [COL[:KEY]=VALUE] wait until condition is true\n\
490 Potentially unsafe database commands require --force option.\n\
493 --db=DATABASE connect to DATABASE\n\
495 --oneline print exactly one line of output per command\n",
496 program_name, program_name, default_db());
500 -h, --help display this help message\n\
501 -V, --version display version information\n");
510 def = xasprintf("unix:%s/db.sock", ovs_rundir);
515 /* Returns true if it looks like this set of arguments might modify the
516 * database, otherwise false. (Not very smart, so it's prone to false
519 might_write_to_db(char **argv)
521 for (; *argv; argv++) {
522 const struct vsctl_command_syntax *p = find_command(*argv);
523 if (p && p->mode == RW) {
530 struct vsctl_context {
534 struct shash options;
536 /* Modifiable state. */
538 struct ovsdb_idl *idl;
539 struct ovsdb_idl_txn *txn;
540 struct ovsdb_symbol_table *symtab;
541 const struct ovsrec_open_vswitch *ovs;
543 /* A command may set this member to true if some prerequisite is not met
544 * and the caller should wait for something to change and then retry. */
548 struct vsctl_bridge {
549 struct ovsrec_bridge *br_cfg;
551 struct ovsrec_controller **ctrl;
554 struct vsctl_bridge *parent;
559 struct ovsrec_port *port_cfg;
560 struct vsctl_bridge *bridge;
564 struct ovsrec_interface *iface_cfg;
565 struct vsctl_port *port;
569 struct shash bridges;
575 vsctl_context_to_string(const struct vsctl_context *ctx)
577 const struct shash_node *node;
583 SHASH_FOR_EACH (node, &ctx->options) {
584 svec_add(&words, node->name);
586 for (i = 0; i < ctx->argc; i++) {
587 svec_add(&words, ctx->argv[i]);
589 svec_terminate(&words);
591 s = process_escape_args(words.names);
593 svec_destroy(&words);
598 static struct vsctl_bridge *
599 add_bridge(struct vsctl_info *b,
600 struct ovsrec_bridge *br_cfg, const char *name,
601 struct vsctl_bridge *parent, int vlan)
603 struct vsctl_bridge *br = xmalloc(sizeof *br);
605 br->name = xstrdup(name);
609 br->ctrl = parent->br_cfg->controller;
610 br->n_ctrl = parent->br_cfg->n_controller;
611 br->fail_mode = parent->br_cfg->fail_mode;
613 br->ctrl = br_cfg->controller;
614 br->n_ctrl = br_cfg->n_controller;
615 br->fail_mode = br_cfg->fail_mode;
617 shash_add(&b->bridges, br->name, br);
622 port_is_fake_bridge(const struct ovsrec_port *port_cfg)
624 return (port_cfg->fake_bridge
626 && *port_cfg->tag >= 1 && *port_cfg->tag <= 4095);
629 static struct vsctl_bridge *
630 find_vlan_bridge(struct vsctl_info *info,
631 struct vsctl_bridge *parent, int vlan)
633 struct shash_node *node;
635 SHASH_FOR_EACH (node, &info->bridges) {
636 struct vsctl_bridge *br = node->data;
637 if (br->parent == parent && br->vlan == vlan) {
646 free_info(struct vsctl_info *info)
648 struct shash_node *node;
650 SHASH_FOR_EACH (node, &info->bridges) {
651 struct vsctl_bridge *bridge = node->data;
655 shash_destroy(&info->bridges);
657 shash_destroy_free_data(&info->ports);
658 shash_destroy_free_data(&info->ifaces);
662 get_info(const struct ovsrec_open_vswitch *ovs, struct vsctl_info *info)
664 struct shash bridges, ports;
667 shash_init(&info->bridges);
668 shash_init(&info->ports);
669 shash_init(&info->ifaces);
671 shash_init(&bridges);
673 for (i = 0; i < ovs->n_bridges; i++) {
674 struct ovsrec_bridge *br_cfg = ovs->bridges[i];
675 struct vsctl_bridge *br;
678 if (!shash_add_once(&bridges, br_cfg->name, NULL)) {
679 VLOG_WARN("%s: database contains duplicate bridge name",
683 br = add_bridge(info, br_cfg, br_cfg->name, NULL, 0);
688 for (j = 0; j < br_cfg->n_ports; j++) {
689 struct ovsrec_port *port_cfg = br_cfg->ports[j];
691 if (!shash_add_once(&ports, port_cfg->name, NULL)) {
692 VLOG_WARN("%s: database contains duplicate port name",
697 if (port_is_fake_bridge(port_cfg)
698 && shash_add_once(&bridges, port_cfg->name, NULL)) {
699 add_bridge(info, NULL, port_cfg->name, br, *port_cfg->tag);
703 shash_destroy(&bridges);
704 shash_destroy(&ports);
706 shash_init(&bridges);
708 for (i = 0; i < ovs->n_bridges; i++) {
709 struct ovsrec_bridge *br_cfg = ovs->bridges[i];
710 struct vsctl_bridge *br;
713 if (!shash_add_once(&bridges, br_cfg->name, NULL)) {
716 br = shash_find_data(&info->bridges, br_cfg->name);
717 for (j = 0; j < br_cfg->n_ports; j++) {
718 struct ovsrec_port *port_cfg = br_cfg->ports[j];
719 struct vsctl_port *port;
722 if (!shash_add_once(&ports, port_cfg->name, NULL)) {
726 if (port_is_fake_bridge(port_cfg)
727 && !shash_add_once(&bridges, port_cfg->name, NULL)) {
731 port = xmalloc(sizeof *port);
732 port->port_cfg = port_cfg;
734 && *port_cfg->tag >= 1 && *port_cfg->tag <= 4095) {
735 port->bridge = find_vlan_bridge(info, br, *port_cfg->tag);
742 shash_add(&info->ports, port_cfg->name, port);
744 for (k = 0; k < port_cfg->n_interfaces; k++) {
745 struct ovsrec_interface *iface_cfg = port_cfg->interfaces[k];
746 struct vsctl_iface *iface;
748 if (shash_find(&info->ifaces, iface_cfg->name)) {
749 VLOG_WARN("%s: database contains duplicate interface name",
754 iface = xmalloc(sizeof *iface);
755 iface->iface_cfg = iface_cfg;
757 shash_add(&info->ifaces, iface_cfg->name, iface);
761 shash_destroy(&bridges);
762 shash_destroy(&ports);
766 check_conflicts(struct vsctl_info *info, const char *name,
769 struct vsctl_iface *iface;
770 struct vsctl_port *port;
772 if (shash_find(&info->bridges, name)) {
773 vsctl_fatal("%s because a bridge named %s already exists",
777 port = shash_find_data(&info->ports, name);
779 vsctl_fatal("%s because a port named %s already exists on "
780 "bridge %s", msg, name, port->bridge->name);
783 iface = shash_find_data(&info->ifaces, name);
785 vsctl_fatal("%s because an interface named %s already exists "
786 "on bridge %s", msg, name, iface->port->bridge->name);
792 static struct vsctl_bridge *
793 find_bridge(struct vsctl_info *info, const char *name, bool must_exist)
795 struct vsctl_bridge *br = shash_find_data(&info->bridges, name);
796 if (must_exist && !br) {
797 vsctl_fatal("no bridge named %s", name);
802 static struct vsctl_bridge *
803 find_real_bridge(struct vsctl_info *info, const char *name, bool must_exist)
805 struct vsctl_bridge *br = find_bridge(info, name, must_exist);
806 if (br && br->parent) {
807 vsctl_fatal("%s is a fake bridge", name);
812 static struct vsctl_port *
813 find_port(struct vsctl_info *info, const char *name, bool must_exist)
815 struct vsctl_port *port = shash_find_data(&info->ports, name);
816 if (port && !strcmp(name, port->bridge->name)) {
819 if (must_exist && !port) {
820 vsctl_fatal("no port named %s", name);
825 static struct vsctl_iface *
826 find_iface(struct vsctl_info *info, const char *name, bool must_exist)
828 struct vsctl_iface *iface = shash_find_data(&info->ifaces, name);
829 if (iface && !strcmp(name, iface->port->bridge->name)) {
832 if (must_exist && !iface) {
833 vsctl_fatal("no interface named %s", name);
839 bridge_insert_port(struct ovsrec_bridge *br, struct ovsrec_port *port)
841 struct ovsrec_port **ports;
844 ports = xmalloc(sizeof *br->ports * (br->n_ports + 1));
845 for (i = 0; i < br->n_ports; i++) {
846 ports[i] = br->ports[i];
848 ports[br->n_ports] = port;
849 ovsrec_bridge_set_ports(br, ports, br->n_ports + 1);
854 bridge_delete_port(struct ovsrec_bridge *br, struct ovsrec_port *port)
856 struct ovsrec_port **ports;
859 ports = xmalloc(sizeof *br->ports * br->n_ports);
860 for (i = n = 0; i < br->n_ports; i++) {
861 if (br->ports[i] != port) {
862 ports[n++] = br->ports[i];
865 ovsrec_bridge_set_ports(br, ports, n);
870 ovs_insert_bridge(const struct ovsrec_open_vswitch *ovs,
871 struct ovsrec_bridge *bridge)
873 struct ovsrec_bridge **bridges;
876 bridges = xmalloc(sizeof *ovs->bridges * (ovs->n_bridges + 1));
877 for (i = 0; i < ovs->n_bridges; i++) {
878 bridges[i] = ovs->bridges[i];
880 bridges[ovs->n_bridges] = bridge;
881 ovsrec_open_vswitch_set_bridges(ovs, bridges, ovs->n_bridges + 1);
886 ovs_delete_bridge(const struct ovsrec_open_vswitch *ovs,
887 struct ovsrec_bridge *bridge)
889 struct ovsrec_bridge **bridges;
892 bridges = xmalloc(sizeof *ovs->bridges * ovs->n_bridges);
893 for (i = n = 0; i < ovs->n_bridges; i++) {
894 if (ovs->bridges[i] != bridge) {
895 bridges[n++] = ovs->bridges[i];
898 ovsrec_open_vswitch_set_bridges(ovs, bridges, n);
903 cmd_init(struct vsctl_context *ctx OVS_UNUSED)
908 cmd_emer_reset(struct vsctl_context *ctx)
910 const struct ovsdb_idl *idl = ctx->idl;
911 const struct ovsrec_bridge *br;
912 const struct ovsrec_port *port;
913 const struct ovsrec_interface *iface;
914 const struct ovsrec_mirror *mirror, *next_mirror;
915 const struct ovsrec_controller *ctrl, *next_ctrl;
916 const struct ovsrec_netflow *nf, *next_nf;
917 const struct ovsrec_ssl *ssl, *next_ssl;
918 const struct ovsrec_sflow *sflow, *next_sflow;
921 /* Reset the Open_vSwitch table. */
922 ovsrec_open_vswitch_set_managers(ctx->ovs, NULL, 0);
923 ovsrec_open_vswitch_set_ssl(ctx->ovs, NULL);
925 OVSREC_BRIDGE_FOR_EACH (br, idl) {
927 char *hw_key = "hwaddr";
930 ovsrec_bridge_set_controller(br, NULL, 0);
931 ovsrec_bridge_set_mirrors(br, NULL, 0);
932 ovsrec_bridge_set_netflow(br, NULL);
933 ovsrec_bridge_set_sflow(br, NULL);
934 ovsrec_bridge_set_flood_vlans(br, NULL, 0);
936 /* We only want to save the "hwaddr" key from other_config. */
937 for (i=0; i < br->n_other_config; i++) {
938 if (!strcmp(br->key_other_config[i], hw_key)) {
939 hw_val = br->value_other_config[i];
944 char *val = xstrdup(hw_val);
945 ovsrec_bridge_set_other_config(br, &hw_key, &val, 1);
948 ovsrec_bridge_set_other_config(br, NULL, NULL, 0);
952 OVSREC_PORT_FOR_EACH (port, idl) {
953 ovsrec_port_set_other_config(port, NULL, NULL, 0);
956 OVSREC_INTERFACE_FOR_EACH (iface, idl) {
957 /* xxx What do we do about gre/patch devices created by mgr? */
959 ovsrec_interface_set_ingress_policing_rate(iface, 0);
960 ovsrec_interface_set_ingress_policing_burst(iface, 0);
963 OVSREC_MIRROR_FOR_EACH_SAFE (mirror, next_mirror, idl) {
964 ovsrec_mirror_delete(mirror);
967 OVSREC_CONTROLLER_FOR_EACH_SAFE (ctrl, next_ctrl, idl) {
968 ovsrec_controller_delete(ctrl);
971 OVSREC_NETFLOW_FOR_EACH_SAFE (nf, next_nf, idl) {
972 ovsrec_netflow_delete(nf);
975 OVSREC_SSL_FOR_EACH_SAFE (ssl, next_ssl, idl) {
976 ovsrec_ssl_delete(ssl);
979 OVSREC_SFLOW_FOR_EACH_SAFE (sflow, next_sflow, idl) {
980 ovsrec_sflow_delete(sflow);
985 cmd_add_br(struct vsctl_context *ctx)
987 bool may_exist = shash_find(&ctx->options, "--may-exist") != 0;
988 const char *br_name, *parent_name;
989 struct vsctl_info info;
992 br_name = ctx->argv[1];
993 if (ctx->argc == 2) {
996 } else if (ctx->argc == 4) {
997 parent_name = ctx->argv[2];
998 vlan = atoi(ctx->argv[3]);
999 if (vlan < 1 || vlan > 4095) {
1000 vsctl_fatal("%s: vlan must be between 1 and 4095", ctx->argv[0]);
1003 vsctl_fatal("'%s' command takes exactly 1 or 3 arguments",
1007 get_info(ctx->ovs, &info);
1009 struct vsctl_bridge *br;
1011 br = find_bridge(&info, br_name, false);
1015 vsctl_fatal("\"--may-exist add-br %s\" but %s is "
1016 "a VLAN bridge for VLAN %d",
1017 br_name, br_name, br->vlan);
1021 vsctl_fatal("\"--may-exist add-br %s %s %d\" but %s "
1022 "is not a VLAN bridge",
1023 br_name, parent_name, vlan, br_name);
1024 } else if (strcmp(br->parent->name, parent_name)) {
1025 vsctl_fatal("\"--may-exist add-br %s %s %d\" but %s "
1026 "has the wrong parent %s",
1027 br_name, parent_name, vlan,
1028 br_name, br->parent->name);
1029 } else if (br->vlan != vlan) {
1030 vsctl_fatal("\"--may-exist add-br %s %s %d\" but %s "
1031 "is a VLAN bridge for the wrong VLAN %d",
1032 br_name, parent_name, vlan, br_name, br->vlan);
1038 check_conflicts(&info, br_name,
1039 xasprintf("cannot create a bridge named %s", br_name));
1042 struct ovsrec_port *port;
1043 struct ovsrec_interface *iface;
1044 struct ovsrec_bridge *br;
1046 iface = ovsrec_interface_insert(ctx->txn);
1047 ovsrec_interface_set_name(iface, br_name);
1049 port = ovsrec_port_insert(ctx->txn);
1050 ovsrec_port_set_name(port, br_name);
1051 ovsrec_port_set_interfaces(port, &iface, 1);
1053 br = ovsrec_bridge_insert(ctx->txn);
1054 ovsrec_bridge_set_name(br, br_name);
1055 ovsrec_bridge_set_ports(br, &port, 1);
1057 ovs_insert_bridge(ctx->ovs, br);
1059 struct vsctl_bridge *parent;
1060 struct ovsrec_port *port;
1061 struct ovsrec_interface *iface;
1062 struct ovsrec_bridge *br;
1065 parent = find_bridge(&info, parent_name, false);
1066 if (parent && parent->vlan) {
1067 vsctl_fatal("cannot create bridge with fake bridge as parent");
1070 vsctl_fatal("parent bridge %s does not exist", parent_name);
1072 br = parent->br_cfg;
1074 iface = ovsrec_interface_insert(ctx->txn);
1075 ovsrec_interface_set_name(iface, br_name);
1076 ovsrec_interface_set_type(iface, "internal");
1078 port = ovsrec_port_insert(ctx->txn);
1079 ovsrec_port_set_name(port, br_name);
1080 ovsrec_port_set_interfaces(port, &iface, 1);
1081 ovsrec_port_set_fake_bridge(port, true);
1082 ovsrec_port_set_tag(port, &tag, 1);
1084 bridge_insert_port(br, port);
1091 del_port(struct vsctl_info *info, struct vsctl_port *port)
1093 struct shash_node *node;
1095 SHASH_FOR_EACH (node, &info->ifaces) {
1096 struct vsctl_iface *iface = node->data;
1097 if (iface->port == port) {
1098 ovsrec_interface_delete(iface->iface_cfg);
1101 ovsrec_port_delete(port->port_cfg);
1103 bridge_delete_port((port->bridge->parent
1104 ? port->bridge->parent->br_cfg
1105 : port->bridge->br_cfg), port->port_cfg);
1109 cmd_del_br(struct vsctl_context *ctx)
1111 bool must_exist = !shash_find(&ctx->options, "--if-exists");
1112 struct vsctl_bridge *bridge;
1113 struct vsctl_info info;
1115 get_info(ctx->ovs, &info);
1116 bridge = find_bridge(&info, ctx->argv[1], must_exist);
1118 struct shash_node *node;
1120 SHASH_FOR_EACH (node, &info.ports) {
1121 struct vsctl_port *port = node->data;
1122 if (port->bridge == bridge || port->bridge->parent == bridge
1123 || !strcmp(port->port_cfg->name, bridge->name)) {
1124 del_port(&info, port);
1127 if (bridge->br_cfg) {
1128 ovsrec_bridge_delete(bridge->br_cfg);
1129 ovs_delete_bridge(ctx->ovs, bridge->br_cfg);
1136 output_sorted(struct svec *svec, struct ds *output)
1142 SVEC_FOR_EACH (i, name, svec) {
1143 ds_put_format(output, "%s\n", name);
1148 cmd_list_br(struct vsctl_context *ctx)
1150 struct shash_node *node;
1151 struct vsctl_info info;
1152 struct svec bridges;
1154 get_info(ctx->ovs, &info);
1156 svec_init(&bridges);
1157 SHASH_FOR_EACH (node, &info.bridges) {
1158 struct vsctl_bridge *br = node->data;
1159 svec_add(&bridges, br->name);
1161 output_sorted(&bridges, &ctx->output);
1162 svec_destroy(&bridges);
1168 cmd_br_exists(struct vsctl_context *ctx)
1170 struct vsctl_info info;
1172 get_info(ctx->ovs, &info);
1173 if (!find_bridge(&info, ctx->argv[1], false)) {
1179 /* Returns true if 'b_prefix' (of length 'b_prefix_len') concatenated with 'b'
1180 * equals 'a', false otherwise. */
1182 key_matches(const char *a,
1183 const char *b_prefix, size_t b_prefix_len, const char *b)
1185 return !strncmp(a, b_prefix, b_prefix_len) && !strcmp(a + b_prefix_len, b);
1189 set_external_id(char **old_keys, char **old_values, size_t old_n,
1190 char *key, char *value,
1191 char ***new_keysp, char ***new_valuesp, size_t *new_np)
1198 new_keys = xmalloc(sizeof *new_keys * (old_n + 1));
1199 new_values = xmalloc(sizeof *new_values * (old_n + 1));
1201 for (i = 0; i < old_n; i++) {
1202 if (strcmp(key, old_keys[i])) {
1203 new_keys[new_n] = old_keys[i];
1204 new_values[new_n] = old_values[i];
1209 new_keys[new_n] = key;
1210 new_values[new_n] = value;
1213 *new_keysp = new_keys;
1214 *new_valuesp = new_values;
1219 cmd_br_set_external_id(struct vsctl_context *ctx)
1221 struct vsctl_info info;
1222 struct vsctl_bridge *bridge;
1223 char **keys, **values;
1226 get_info(ctx->ovs, &info);
1227 bridge = find_bridge(&info, ctx->argv[1], true);
1228 if (bridge->br_cfg) {
1229 set_external_id(bridge->br_cfg->key_external_ids,
1230 bridge->br_cfg->value_external_ids,
1231 bridge->br_cfg->n_external_ids,
1232 ctx->argv[2], ctx->argc >= 4 ? ctx->argv[3] : NULL,
1233 &keys, &values, &n);
1234 ovsrec_bridge_set_external_ids(bridge->br_cfg, keys, values, n);
1236 char *key = xasprintf("fake-bridge-%s", ctx->argv[2]);
1237 struct vsctl_port *port = shash_find_data(&info.ports, ctx->argv[1]);
1238 set_external_id(port->port_cfg->key_external_ids,
1239 port->port_cfg->value_external_ids,
1240 port->port_cfg->n_external_ids,
1241 key, ctx->argc >= 4 ? ctx->argv[3] : NULL,
1242 &keys, &values, &n);
1243 ovsrec_port_set_external_ids(port->port_cfg, keys, values, n);
1253 get_external_id(char **keys, char **values, size_t n,
1254 const char *prefix, const char *key,
1257 size_t prefix_len = strlen(prefix);
1262 for (i = 0; i < n; i++) {
1263 if (!key && !strncmp(keys[i], prefix, prefix_len)) {
1264 svec_add_nocopy(&svec, xasprintf("%s=%s",
1265 keys[i] + prefix_len, values[i]));
1266 } else if (key_matches(keys[i], prefix, prefix_len, key)) {
1267 svec_add(&svec, values[i]);
1271 output_sorted(&svec, output);
1272 svec_destroy(&svec);
1276 cmd_br_get_external_id(struct vsctl_context *ctx)
1278 struct vsctl_info info;
1279 struct vsctl_bridge *bridge;
1281 get_info(ctx->ovs, &info);
1282 bridge = find_bridge(&info, ctx->argv[1], true);
1283 if (bridge->br_cfg) {
1284 get_external_id(bridge->br_cfg->key_external_ids,
1285 bridge->br_cfg->value_external_ids,
1286 bridge->br_cfg->n_external_ids,
1287 "", ctx->argc >= 3 ? ctx->argv[2] : NULL,
1290 struct vsctl_port *port = shash_find_data(&info.ports, ctx->argv[1]);
1291 get_external_id(port->port_cfg->key_external_ids,
1292 port->port_cfg->value_external_ids,
1293 port->port_cfg->n_external_ids,
1294 "fake-bridge-", ctx->argc >= 3 ? ctx->argv[2] : NULL, &ctx->output);
1301 cmd_list_ports(struct vsctl_context *ctx)
1303 struct vsctl_bridge *br;
1304 struct shash_node *node;
1305 struct vsctl_info info;
1308 get_info(ctx->ovs, &info);
1309 br = find_bridge(&info, ctx->argv[1], true);
1312 SHASH_FOR_EACH (node, &info.ports) {
1313 struct vsctl_port *port = node->data;
1315 if (strcmp(port->port_cfg->name, br->name) && br == port->bridge) {
1316 svec_add(&ports, port->port_cfg->name);
1319 output_sorted(&ports, &ctx->output);
1320 svec_destroy(&ports);
1326 add_port(struct vsctl_context *ctx,
1327 const char *br_name, const char *port_name,
1328 bool may_exist, bool fake_iface,
1329 char *iface_names[], int n_ifaces,
1330 char *settings[], int n_settings)
1332 struct vsctl_info info;
1333 struct vsctl_bridge *bridge;
1334 struct ovsrec_interface **ifaces;
1335 struct ovsrec_port *port;
1338 get_info(ctx->ovs, &info);
1340 struct vsctl_port *vsctl_port;
1342 vsctl_port = find_port(&info, port_name, false);
1344 struct svec want_names, have_names;
1346 svec_init(&want_names);
1347 for (i = 0; i < n_ifaces; i++) {
1348 svec_add(&want_names, iface_names[i]);
1350 svec_sort(&want_names);
1352 svec_init(&have_names);
1353 for (i = 0; i < vsctl_port->port_cfg->n_interfaces; i++) {
1354 svec_add(&have_names,
1355 vsctl_port->port_cfg->interfaces[i]->name);
1357 svec_sort(&have_names);
1359 if (strcmp(vsctl_port->bridge->name, br_name)) {
1360 char *command = vsctl_context_to_string(ctx);
1361 vsctl_fatal("\"%s\" but %s is actually attached to bridge %s",
1362 command, port_name, vsctl_port->bridge->name);
1365 if (!svec_equal(&want_names, &have_names)) {
1366 char *have_names_string = svec_join(&have_names, ", ", "");
1367 char *command = vsctl_context_to_string(ctx);
1369 vsctl_fatal("\"%s\" but %s actually has interface(s) %s",
1370 command, port_name, have_names_string);
1373 svec_destroy(&want_names);
1374 svec_destroy(&have_names);
1379 check_conflicts(&info, port_name,
1380 xasprintf("cannot create a port named %s", port_name));
1381 for (i = 0; i < n_ifaces; i++) {
1382 check_conflicts(&info, iface_names[i],
1383 xasprintf("cannot create an interface named %s",
1386 bridge = find_bridge(&info, br_name, true);
1388 ifaces = xmalloc(n_ifaces * sizeof *ifaces);
1389 for (i = 0; i < n_ifaces; i++) {
1390 ifaces[i] = ovsrec_interface_insert(ctx->txn);
1391 ovsrec_interface_set_name(ifaces[i], iface_names[i]);
1394 port = ovsrec_port_insert(ctx->txn);
1395 ovsrec_port_set_name(port, port_name);
1396 ovsrec_port_set_interfaces(port, ifaces, n_ifaces);
1397 ovsrec_port_set_bond_fake_iface(port, fake_iface);
1401 int64_t tag = bridge->vlan;
1402 ovsrec_port_set_tag(port, &tag, 1);
1405 for (i = 0; i < n_settings; i++) {
1406 set_column(get_table("Port"), &port->header_, settings[i],
1410 bridge_insert_port((bridge->parent ? bridge->parent->br_cfg
1411 : bridge->br_cfg), port);
1417 cmd_add_port(struct vsctl_context *ctx)
1419 bool may_exist = shash_find(&ctx->options, "--may-exist") != 0;
1421 add_port(ctx, ctx->argv[1], ctx->argv[2], may_exist, false,
1422 &ctx->argv[2], 1, &ctx->argv[3], ctx->argc - 3);
1426 cmd_add_bond(struct vsctl_context *ctx)
1428 bool may_exist = shash_find(&ctx->options, "--may-exist") != 0;
1429 bool fake_iface = shash_find(&ctx->options, "--fake-iface");
1433 n_ifaces = ctx->argc - 3;
1434 for (i = 3; i < ctx->argc; i++) {
1435 if (strchr(ctx->argv[i], '=')) {
1441 vsctl_fatal("add-bond requires at least 2 interfaces, but only "
1442 "%d were specified", n_ifaces);
1445 add_port(ctx, ctx->argv[1], ctx->argv[2], may_exist, fake_iface,
1446 &ctx->argv[3], n_ifaces,
1447 &ctx->argv[n_ifaces + 3], ctx->argc - 3 - n_ifaces);
1451 cmd_del_port(struct vsctl_context *ctx)
1453 bool must_exist = !shash_find(&ctx->options, "--if-exists");
1454 bool with_iface = shash_find(&ctx->options, "--with-iface") != NULL;
1455 struct vsctl_port *port;
1456 struct vsctl_info info;
1458 get_info(ctx->ovs, &info);
1460 port = find_port(&info, ctx->argv[ctx->argc - 1], must_exist);
1462 const char *target = ctx->argv[ctx->argc - 1];
1463 struct vsctl_iface *iface;
1465 port = find_port(&info, target, false);
1467 iface = find_iface(&info, target, false);
1472 if (must_exist && !port) {
1473 vsctl_fatal("no port or interface named %s", target);
1478 if (ctx->argc == 3) {
1479 struct vsctl_bridge *bridge;
1481 bridge = find_bridge(&info, ctx->argv[1], true);
1482 if (port->bridge != bridge) {
1483 if (port->bridge->parent == bridge) {
1484 vsctl_fatal("bridge %s does not have a port %s (although "
1485 "its parent bridge %s does)",
1486 ctx->argv[1], ctx->argv[2],
1487 bridge->parent->name);
1489 vsctl_fatal("bridge %s does not have a port %s",
1490 ctx->argv[1], ctx->argv[2]);
1495 del_port(&info, port);
1502 cmd_port_to_br(struct vsctl_context *ctx)
1504 struct vsctl_port *port;
1505 struct vsctl_info info;
1507 get_info(ctx->ovs, &info);
1508 port = find_port(&info, ctx->argv[1], true);
1509 ds_put_format(&ctx->output, "%s\n", port->bridge->name);
1514 cmd_br_to_vlan(struct vsctl_context *ctx)
1516 struct vsctl_bridge *bridge;
1517 struct vsctl_info info;
1519 get_info(ctx->ovs, &info);
1520 bridge = find_bridge(&info, ctx->argv[1], true);
1521 ds_put_format(&ctx->output, "%d\n", bridge->vlan);
1526 cmd_br_to_parent(struct vsctl_context *ctx)
1528 struct vsctl_bridge *bridge;
1529 struct vsctl_info info;
1531 get_info(ctx->ovs, &info);
1532 bridge = find_bridge(&info, ctx->argv[1], true);
1533 if (bridge->parent) {
1534 bridge = bridge->parent;
1536 ds_put_format(&ctx->output, "%s\n", bridge->name);
1541 cmd_list_ifaces(struct vsctl_context *ctx)
1543 struct vsctl_bridge *br;
1544 struct shash_node *node;
1545 struct vsctl_info info;
1548 get_info(ctx->ovs, &info);
1549 br = find_bridge(&info, ctx->argv[1], true);
1552 SHASH_FOR_EACH (node, &info.ifaces) {
1553 struct vsctl_iface *iface = node->data;
1555 if (strcmp(iface->iface_cfg->name, br->name)
1556 && br == iface->port->bridge) {
1557 svec_add(&ifaces, iface->iface_cfg->name);
1560 output_sorted(&ifaces, &ctx->output);
1561 svec_destroy(&ifaces);
1567 cmd_iface_to_br(struct vsctl_context *ctx)
1569 struct vsctl_iface *iface;
1570 struct vsctl_info info;
1572 get_info(ctx->ovs, &info);
1573 iface = find_iface(&info, ctx->argv[1], true);
1574 ds_put_format(&ctx->output, "%s\n", iface->port->bridge->name);
1579 cmd_get_controller(struct vsctl_context *ctx)
1581 struct vsctl_info info;
1582 struct vsctl_bridge *br;
1583 struct svec targets;
1586 get_info(ctx->ovs, &info);
1587 br = find_bridge(&info, ctx->argv[1], true);
1589 /* Print the targets in sorted order for reproducibility. */
1590 svec_init(&targets);
1591 for (i = 0; i < br->n_ctrl; i++) {
1592 svec_add(&targets, br->ctrl[i]->target);
1595 svec_sort(&targets);
1596 for (i = 0; i < targets.n; i++) {
1597 ds_put_format(&ctx->output, "%s\n", targets.names[i]);
1599 svec_destroy(&targets);
1605 delete_controllers(struct ovsrec_controller **controllers,
1606 size_t n_controllers)
1610 for (i = 0; i < n_controllers; i++) {
1611 ovsrec_controller_delete(controllers[i]);
1616 cmd_del_controller(struct vsctl_context *ctx)
1618 struct vsctl_info info;
1619 struct vsctl_bridge *br;
1621 get_info(ctx->ovs, &info);
1622 br = find_real_bridge(&info, ctx->argv[1], true);
1625 delete_controllers(br->ctrl, br->n_ctrl);
1626 ovsrec_bridge_set_controller(br->br_cfg, NULL, 0);
1632 static struct ovsrec_controller **
1633 insert_controllers(struct ovsdb_idl_txn *txn, char *targets[], size_t n)
1635 struct ovsrec_controller **controllers;
1638 controllers = xmalloc(n * sizeof *controllers);
1639 for (i = 0; i < n; i++) {
1640 controllers[i] = ovsrec_controller_insert(txn);
1641 ovsrec_controller_set_target(controllers[i], targets[i]);
1648 cmd_set_controller(struct vsctl_context *ctx)
1650 struct vsctl_info info;
1651 struct vsctl_bridge *br;
1652 struct ovsrec_controller **controllers;
1655 get_info(ctx->ovs, &info);
1656 br = find_real_bridge(&info, ctx->argv[1], true);
1658 delete_controllers(br->ctrl, br->n_ctrl);
1661 controllers = insert_controllers(ctx->txn, &ctx->argv[2], n);
1662 ovsrec_bridge_set_controller(br->br_cfg, controllers, n);
1669 cmd_get_fail_mode(struct vsctl_context *ctx)
1671 struct vsctl_info info;
1672 struct vsctl_bridge *br;
1674 get_info(ctx->ovs, &info);
1675 br = find_bridge(&info, ctx->argv[1], true);
1677 if (br->fail_mode && strlen(br->fail_mode)) {
1678 ds_put_format(&ctx->output, "%s\n", br->fail_mode);
1685 cmd_del_fail_mode(struct vsctl_context *ctx)
1687 struct vsctl_info info;
1688 struct vsctl_bridge *br;
1690 get_info(ctx->ovs, &info);
1691 br = find_real_bridge(&info, ctx->argv[1], true);
1693 ovsrec_bridge_set_fail_mode(br->br_cfg, NULL);
1699 cmd_set_fail_mode(struct vsctl_context *ctx)
1701 struct vsctl_info info;
1702 struct vsctl_bridge *br;
1703 const char *fail_mode = ctx->argv[2];
1705 get_info(ctx->ovs, &info);
1706 br = find_real_bridge(&info, ctx->argv[1], true);
1708 if (strcmp(fail_mode, "standalone") && strcmp(fail_mode, "secure")) {
1709 vsctl_fatal("fail-mode must be \"standalone\" or \"secure\"");
1712 ovsrec_bridge_set_fail_mode(br->br_cfg, fail_mode);
1718 cmd_get_ssl(struct vsctl_context *ctx)
1720 struct ovsrec_ssl *ssl = ctx->ovs->ssl;
1723 ds_put_format(&ctx->output, "Private key: %s\n", ssl->private_key);
1724 ds_put_format(&ctx->output, "Certificate: %s\n", ssl->certificate);
1725 ds_put_format(&ctx->output, "CA Certificate: %s\n", ssl->ca_cert);
1726 ds_put_format(&ctx->output, "Bootstrap: %s\n",
1727 ssl->bootstrap_ca_cert ? "true" : "false");
1732 cmd_del_ssl(struct vsctl_context *ctx)
1734 struct ovsrec_ssl *ssl = ctx->ovs->ssl;
1737 ovsrec_ssl_delete(ssl);
1738 ovsrec_open_vswitch_set_ssl(ctx->ovs, NULL);
1743 cmd_set_ssl(struct vsctl_context *ctx)
1745 bool bootstrap = shash_find(&ctx->options, "--bootstrap");
1746 struct ovsrec_ssl *ssl = ctx->ovs->ssl;
1749 ovsrec_ssl_delete(ssl);
1751 ssl = ovsrec_ssl_insert(ctx->txn);
1753 ovsrec_ssl_set_private_key(ssl, ctx->argv[1]);
1754 ovsrec_ssl_set_certificate(ssl, ctx->argv[2]);
1755 ovsrec_ssl_set_ca_cert(ssl, ctx->argv[3]);
1757 ovsrec_ssl_set_bootstrap_ca_cert(ssl, bootstrap);
1759 ovsrec_open_vswitch_set_ssl(ctx->ovs, ssl);
1762 /* Parameter commands. */
1764 struct vsctl_row_id {
1765 const struct ovsdb_idl_table_class *table;
1766 const struct ovsdb_idl_column *name_column;
1767 const struct ovsdb_idl_column *uuid_column;
1770 struct vsctl_table_class {
1771 struct ovsdb_idl_table_class *class;
1772 struct vsctl_row_id row_ids[2];
1775 static const struct vsctl_table_class tables[] = {
1776 {&ovsrec_table_bridge,
1777 {{&ovsrec_table_bridge, &ovsrec_bridge_col_name, NULL},
1778 {NULL, NULL, NULL}}},
1780 {&ovsrec_table_controller,
1781 {{&ovsrec_table_bridge,
1782 &ovsrec_bridge_col_name,
1783 &ovsrec_bridge_col_controller}}},
1785 {&ovsrec_table_interface,
1786 {{&ovsrec_table_interface, &ovsrec_interface_col_name, NULL},
1787 {NULL, NULL, NULL}}},
1789 {&ovsrec_table_mirror,
1790 {{&ovsrec_table_mirror, &ovsrec_mirror_col_name, NULL},
1791 {NULL, NULL, NULL}}},
1793 {&ovsrec_table_netflow,
1794 {{&ovsrec_table_bridge,
1795 &ovsrec_bridge_col_name,
1796 &ovsrec_bridge_col_netflow},
1797 {NULL, NULL, NULL}}},
1799 {&ovsrec_table_open_vswitch,
1800 {{&ovsrec_table_open_vswitch, NULL, NULL},
1801 {NULL, NULL, NULL}}},
1803 {&ovsrec_table_port,
1804 {{&ovsrec_table_port, &ovsrec_port_col_name, NULL},
1805 {NULL, NULL, NULL}}},
1808 {{&ovsrec_table_port, &ovsrec_port_col_name, &ovsrec_port_col_qos},
1809 {NULL, NULL, NULL}}},
1811 {&ovsrec_table_queue,
1812 {{NULL, NULL, NULL},
1813 {NULL, NULL, NULL}}},
1816 {{&ovsrec_table_open_vswitch, NULL, &ovsrec_open_vswitch_col_ssl}}},
1818 {&ovsrec_table_sflow,
1819 {{&ovsrec_table_bridge,
1820 &ovsrec_bridge_col_name,
1821 &ovsrec_bridge_col_sflow},
1822 {NULL, NULL, NULL}}},
1824 {NULL, {{NULL, NULL, NULL}, {NULL, NULL, NULL}}}
1828 die_if_error(char *error)
1831 vsctl_fatal("%s", error);
1836 to_lower_and_underscores(unsigned c)
1838 return c == '-' ? '_' : tolower(c);
1842 score_partial_match(const char *name, const char *s)
1846 if (!strcmp(name, s)) {
1849 for (score = 0; ; score++, name++, s++) {
1850 if (to_lower_and_underscores(*name) != to_lower_and_underscores(*s)) {
1852 } else if (*name == '\0') {
1853 return UINT_MAX - 1;
1856 return *s == '\0' ? score : 0;
1859 static const struct vsctl_table_class *
1860 get_table(const char *table_name)
1862 const struct vsctl_table_class *table;
1863 const struct vsctl_table_class *best_match = NULL;
1864 unsigned int best_score = 0;
1866 for (table = tables; table->class; table++) {
1867 unsigned int score = score_partial_match(table->class->name,
1869 if (score > best_score) {
1872 } else if (score == best_score) {
1878 } else if (best_score) {
1879 vsctl_fatal("multiple table names match \"%s\"", table_name);
1881 vsctl_fatal("unknown table \"%s\"", table_name);
1885 static const struct ovsdb_idl_row *
1886 get_row_by_id(struct vsctl_context *ctx, const struct vsctl_table_class *table,
1887 const struct vsctl_row_id *id, const char *record_id)
1889 const struct ovsdb_idl_row *referrer, *final;
1895 if (!id->name_column) {
1896 if (strcmp(record_id, ".")) {
1899 referrer = ovsdb_idl_first_row(ctx->idl, id->table);
1900 if (!referrer || ovsdb_idl_next_row(referrer)) {
1904 const struct ovsdb_idl_row *row;
1907 for (row = ovsdb_idl_first_row(ctx->idl, id->table);
1909 row = ovsdb_idl_next_row(row))
1911 const struct ovsdb_datum *name;
1913 name = ovsdb_idl_get(row, id->name_column,
1914 OVSDB_TYPE_STRING, OVSDB_TYPE_VOID);
1915 if (name->n == 1 && !strcmp(name->keys[0].string, record_id)) {
1917 vsctl_fatal("multiple rows in %s match \"%s\"",
1918 table->class->name, record_id);
1929 if (id->uuid_column) {
1930 const struct ovsdb_datum *uuid;
1932 uuid = ovsdb_idl_get(referrer, id->uuid_column,
1933 OVSDB_TYPE_UUID, OVSDB_TYPE_VOID);
1935 final = ovsdb_idl_get_row_for_uuid(ctx->idl, table->class,
1936 &uuid->keys[0].uuid);
1945 static const struct ovsdb_idl_row *
1946 get_row (struct vsctl_context *ctx,
1947 const struct vsctl_table_class *table, const char *record_id)
1949 const struct ovsdb_idl_row *row;
1952 if (uuid_from_string(&uuid, record_id)) {
1953 row = ovsdb_idl_get_row_for_uuid(ctx->idl, table->class, &uuid);
1957 for (i = 0; i < ARRAY_SIZE(table->row_ids); i++) {
1958 row = get_row_by_id(ctx, table, &table->row_ids[i], record_id);
1967 static const struct ovsdb_idl_row *
1968 must_get_row(struct vsctl_context *ctx,
1969 const struct vsctl_table_class *table, const char *record_id)
1971 const struct ovsdb_idl_row *row = get_row(ctx, table, record_id);
1973 vsctl_fatal("no row \"%s\" in table %s",
1974 record_id, table->class->name);
1980 get_column(const struct vsctl_table_class *table, const char *column_name,
1981 const struct ovsdb_idl_column **columnp)
1983 const struct ovsdb_idl_column *best_match = NULL;
1984 unsigned int best_score = 0;
1987 for (i = 0; i < table->class->n_columns; i++) {
1988 const struct ovsdb_idl_column *column = &table->class->columns[i];
1989 unsigned int score = score_partial_match(column->name, column_name);
1990 if (score > best_score) {
1991 best_match = column;
1993 } else if (score == best_score) {
1998 *columnp = best_match;
2001 } else if (best_score) {
2002 return xasprintf("%s contains more than one column whose name "
2003 "matches \"%s\"", table->class->name, column_name);
2005 return xasprintf("%s does not contain a column whose name matches "
2006 "\"%s\"", table->class->name, column_name);
2010 static struct uuid *
2011 create_symbol(struct ovsdb_symbol_table *symtab, const char *id, bool *newp)
2013 struct ovsdb_symbol *symbol;
2016 vsctl_fatal("row id \"%s\" does not begin with \"@\"", id);
2020 *newp = ovsdb_symbol_table_get(symtab, id) == NULL;
2023 symbol = ovsdb_symbol_table_insert(symtab, id);
2025 vsctl_fatal("row id \"%s\" may only be specified on one --id option",
2028 symbol->used = true;
2029 return &symbol->uuid;
2033 missing_operator_error(const char *arg, const char **allowed_operators,
2039 ds_put_format(&s, "%s: argument does not end in ", arg);
2040 ds_put_format(&s, "\"%s\"", allowed_operators[0]);
2041 if (n_allowed == 2) {
2042 ds_put_format(&s, " or \"%s\"", allowed_operators[1]);
2043 } else if (n_allowed > 2) {
2046 for (i = 1; i < n_allowed - 1; i++) {
2047 ds_put_format(&s, ", \"%s\"", allowed_operators[i]);
2049 ds_put_format(&s, ", or \"%s\"", allowed_operators[i]);
2051 ds_put_format(&s, " followed by a value.");
2053 return ds_steal_cstr(&s);
2056 /* Breaks 'arg' apart into a number of fields in the following order:
2058 * - If 'columnp' is nonnull, the name of a column in 'table'. The column
2059 * is stored into '*columnp'. The column name may be abbreviated.
2061 * - If 'keyp' is nonnull, optionally a key string. (If both 'columnp'
2062 * and 'keyp' are nonnull, then the column and key names are expected to
2063 * be separated by ':'). The key is stored as a malloc()'d string into
2064 * '*keyp', or NULL if no key is present in 'arg'.
2066 * - If 'valuep' is nonnull, an operator followed by a value string. The
2067 * allowed operators are the 'n_allowed' string in 'allowed_operators',
2068 * or just "=" if 'n_allowed' is 0. If 'operatorp' is nonnull, then the
2069 * operator is stored into '*operatorp' (one of the pointers from
2070 * 'allowed_operators' is stored; nothing is malloc()'d). The value is
2071 * stored as a malloc()'d string into '*valuep', or NULL if no value is
2074 * At least 'columnp' or 'keyp' must be nonnull.
2076 * On success, returns NULL. On failure, returned a malloc()'d string error
2077 * message and stores NULL into all of the nonnull output arguments. */
2078 static char * WARN_UNUSED_RESULT
2079 parse_column_key_value(const char *arg,
2080 const struct vsctl_table_class *table,
2081 const struct ovsdb_idl_column **columnp, char **keyp,
2082 const char **operatorp,
2083 const char **allowed_operators, size_t n_allowed,
2086 const char *p = arg;
2089 assert(columnp || keyp);
2090 assert(!(operatorp && !valuep));
2098 /* Parse column name. */
2102 error = ovsdb_token_parse(&p, &column_name);
2106 if (column_name[0] == '\0') {
2108 error = xasprintf("%s: missing column name", arg);
2111 error = get_column(table, column_name, columnp);
2118 /* Parse key string. */
2119 if (*p == ':' || !columnp) {
2123 error = xasprintf("%s: key not accepted here", arg);
2126 error = ovsdb_token_parse(&p, keyp);
2134 /* Parse value string. */
2140 if (!allowed_operators) {
2141 static const char *equals = "=";
2142 allowed_operators = =
2148 for (i = 0; i < n_allowed; i++) {
2149 const char *op = allowed_operators[i];
2150 size_t op_len = strlen(op);
2152 if (op_len > best_len && !strncmp(op, p, op_len) && p[op_len]) {
2158 error = missing_operator_error(arg, allowed_operators, n_allowed);
2165 *valuep = xstrdup(p + best_len);
2171 error = xasprintf("%s: trailing garbage \"%s\" in argument",
2197 cmd_get(struct vsctl_context *ctx)
2199 const char *id = shash_find_data(&ctx->options, "--id");
2200 bool if_exists = shash_find(&ctx->options, "--if-exists");
2201 const char *table_name = ctx->argv[1];
2202 const char *record_id = ctx->argv[2];
2203 const struct vsctl_table_class *table;
2204 const struct ovsdb_idl_row *row;
2205 struct ds *out = &ctx->output;
2208 table = get_table(table_name);
2209 row = must_get_row(ctx, table, record_id);
2213 *create_symbol(ctx->symtab, id, &new) = row->uuid;
2215 vsctl_fatal("row id \"%s\" specified on \"get\" command was used "
2216 "before it was defined", id);
2219 for (i = 3; i < ctx->argc; i++) {
2220 const struct ovsdb_idl_column *column;
2221 const struct ovsdb_datum *datum;
2224 /* Special case for obtaining the UUID of a row. We can't just do this
2225 * through parse_column_key_value() below since it returns a "struct
2226 * ovsdb_idl_column" and the UUID column doesn't have one. */
2227 if (!strcasecmp(ctx->argv[i], "_uuid")
2228 || !strcasecmp(ctx->argv[i], "-uuid")) {
2229 ds_put_format(out, UUID_FMT"\n", UUID_ARGS(&row->uuid));
2233 die_if_error(parse_column_key_value(ctx->argv[i], table,
2234 &column, &key_string,
2235 NULL, NULL, 0, NULL));
2237 datum = ovsdb_idl_read(row, column);
2239 union ovsdb_atom key;
2242 if (column->type.value.type == OVSDB_TYPE_VOID) {
2243 vsctl_fatal("cannot specify key to get for non-map column %s",
2247 die_if_error(ovsdb_atom_from_string(&key,
2249 key_string, ctx->symtab));
2251 idx = ovsdb_datum_find_key(datum, &key,
2252 column->type.key.type);
2253 if (idx == UINT_MAX) {
2255 vsctl_fatal("no key \"%s\" in %s record \"%s\" column %s",
2256 key_string, table->class->name, record_id,
2260 ovsdb_atom_to_string(&datum->values[idx],
2261 column->type.value.type, out);
2263 ovsdb_atom_destroy(&key, column->type.key.type);
2265 ovsdb_datum_to_string(datum, &column->type, out);
2267 ds_put_char(out, '\n');
2274 list_record(const struct vsctl_table_class *table,
2275 const struct ovsdb_idl_row *row, struct ds *out)
2279 ds_put_format(out, "%-20s: "UUID_FMT"\n", "_uuid",
2280 UUID_ARGS(&row->uuid));
2281 for (i = 0; i < table->class->n_columns; i++) {
2282 const struct ovsdb_idl_column *column = &table->class->columns[i];
2283 const struct ovsdb_datum *datum;
2285 datum = ovsdb_idl_read(row, column);
2287 ds_put_format(out, "%-20s: ", column->name);
2288 ovsdb_datum_to_string(datum, &column->type, out);
2289 ds_put_char(out, '\n');
2294 cmd_list(struct vsctl_context *ctx)
2296 const char *table_name = ctx->argv[1];
2297 const struct vsctl_table_class *table;
2298 struct ds *out = &ctx->output;
2301 table = get_table(table_name);
2302 if (ctx->argc > 2) {
2303 for (i = 2; i < ctx->argc; i++) {
2305 ds_put_char(out, '\n');
2307 list_record(table, must_get_row(ctx, table, ctx->argv[i]), out);
2310 const struct ovsdb_idl_row *row;
2313 for (row = ovsdb_idl_first_row(ctx->idl, table->class), first = true;
2315 row = ovsdb_idl_next_row(row), first = false) {
2317 ds_put_char(out, '\n');
2319 list_record(table, row, out);
2325 set_column(const struct vsctl_table_class *table,
2326 const struct ovsdb_idl_row *row, const char *arg,
2327 struct ovsdb_symbol_table *symtab)
2329 const struct ovsdb_idl_column *column;
2330 char *key_string, *value_string;
2333 error = parse_column_key_value(arg, table, &column, &key_string,
2334 NULL, NULL, 0, &value_string);
2335 die_if_error(error);
2336 if (!value_string) {
2337 vsctl_fatal("%s: missing value", arg);
2341 union ovsdb_atom key, value;
2342 struct ovsdb_datum datum;
2344 if (column->type.value.type == OVSDB_TYPE_VOID) {
2345 vsctl_fatal("cannot specify key to set for non-map column %s",
2349 die_if_error(ovsdb_atom_from_string(&key, &column->type.key,
2350 key_string, symtab));
2351 die_if_error(ovsdb_atom_from_string(&value, &column->type.value,
2352 value_string, symtab));
2354 ovsdb_datum_init_empty(&datum);
2355 ovsdb_datum_add_unsafe(&datum, &key, &value, &column->type);
2357 ovsdb_atom_destroy(&key, column->type.key.type);
2358 ovsdb_atom_destroy(&value, column->type.value.type);
2360 ovsdb_datum_union(&datum, ovsdb_idl_read(row, column),
2361 &column->type, false);
2362 ovsdb_idl_txn_write(row, column, &datum);
2364 struct ovsdb_datum datum;
2366 die_if_error(ovsdb_datum_from_string(&datum, &column->type,
2367 value_string, symtab));
2368 ovsdb_idl_txn_write(row, column, &datum);
2376 cmd_set(struct vsctl_context *ctx)
2378 const char *table_name = ctx->argv[1];
2379 const char *record_id = ctx->argv[2];
2380 const struct vsctl_table_class *table;
2381 const struct ovsdb_idl_row *row;
2384 table = get_table(table_name);
2385 row = must_get_row(ctx, table, record_id);
2386 for (i = 3; i < ctx->argc; i++) {
2387 set_column(table, row, ctx->argv[i], ctx->symtab);
2392 cmd_add(struct vsctl_context *ctx)
2394 const char *table_name = ctx->argv[1];
2395 const char *record_id = ctx->argv[2];
2396 const char *column_name = ctx->argv[3];
2397 const struct vsctl_table_class *table;
2398 const struct ovsdb_idl_column *column;
2399 const struct ovsdb_idl_row *row;
2400 const struct ovsdb_type *type;
2401 struct ovsdb_datum old;
2404 table = get_table(table_name);
2405 row = must_get_row(ctx, table, record_id);
2406 die_if_error(get_column(table, column_name, &column));
2408 type = &column->type;
2409 ovsdb_datum_clone(&old, ovsdb_idl_read(row, column), &column->type);
2410 for (i = 4; i < ctx->argc; i++) {
2411 struct ovsdb_type add_type;
2412 struct ovsdb_datum add;
2416 add_type.n_max = UINT_MAX;
2417 die_if_error(ovsdb_datum_from_string(&add, &add_type, ctx->argv[i],
2419 ovsdb_datum_union(&old, &add, type, false);
2420 ovsdb_datum_destroy(&add, type);
2422 if (old.n > type->n_max) {
2423 vsctl_fatal("\"add\" operation would put %u %s in column %s of "
2424 "table %s but the maximum number is %u",
2426 type->value.type == OVSDB_TYPE_VOID ? "values" : "pairs",
2427 column->name, table->class->name, type->n_max);
2429 ovsdb_idl_txn_write(row, column, &old);
2433 cmd_remove(struct vsctl_context *ctx)
2435 const char *table_name = ctx->argv[1];
2436 const char *record_id = ctx->argv[2];
2437 const char *column_name = ctx->argv[3];
2438 const struct vsctl_table_class *table;
2439 const struct ovsdb_idl_column *column;
2440 const struct ovsdb_idl_row *row;
2441 const struct ovsdb_type *type;
2442 struct ovsdb_datum old;
2445 table = get_table(table_name);
2446 row = must_get_row(ctx, table, record_id);
2447 die_if_error(get_column(table, column_name, &column));
2449 type = &column->type;
2450 ovsdb_datum_clone(&old, ovsdb_idl_read(row, column), &column->type);
2451 for (i = 4; i < ctx->argc; i++) {
2452 struct ovsdb_type rm_type;
2453 struct ovsdb_datum rm;
2458 rm_type.n_max = UINT_MAX;
2459 error = ovsdb_datum_from_string(&rm, &rm_type,
2460 ctx->argv[i], ctx->symtab);
2461 if (error && ovsdb_type_is_map(&rm_type)) {
2463 rm_type.value.type = OVSDB_TYPE_VOID;
2464 die_if_error(ovsdb_datum_from_string(&rm, &rm_type,
2465 ctx->argv[i], ctx->symtab));
2467 ovsdb_datum_subtract(&old, type, &rm, &rm_type);
2468 ovsdb_datum_destroy(&rm, &rm_type);
2470 if (old.n < type->n_min) {
2471 vsctl_fatal("\"remove\" operation would put %u %s in column %s of "
2472 "table %s but the minimum number is %u",
2474 type->value.type == OVSDB_TYPE_VOID ? "values" : "pairs",
2475 column->name, table->class->name, type->n_min);
2477 ovsdb_idl_txn_write(row, column, &old);
2481 cmd_clear(struct vsctl_context *ctx)
2483 const char *table_name = ctx->argv[1];
2484 const char *record_id = ctx->argv[2];
2485 const struct vsctl_table_class *table;
2486 const struct ovsdb_idl_row *row;
2489 table = get_table(table_name);
2490 row = must_get_row(ctx, table, record_id);
2491 for (i = 3; i < ctx->argc; i++) {
2492 const struct ovsdb_idl_column *column;
2493 const struct ovsdb_type *type;
2494 struct ovsdb_datum datum;
2496 die_if_error(get_column(table, ctx->argv[i], &column));
2498 type = &column->type;
2499 if (type->n_min > 0) {
2500 vsctl_fatal("\"clear\" operation cannot be applied to column %s "
2501 "of table %s, which is not allowed to be empty",
2502 column->name, table->class->name);
2505 ovsdb_datum_init_empty(&datum);
2506 ovsdb_idl_txn_write(row, column, &datum);
2511 cmd_create(struct vsctl_context *ctx)
2513 const char *id = shash_find_data(&ctx->options, "--id");
2514 const char *table_name = ctx->argv[1];
2515 const struct vsctl_table_class *table;
2516 const struct ovsdb_idl_row *row;
2517 const struct uuid *uuid;
2520 uuid = id ? create_symbol(ctx->symtab, id, NULL) : NULL;
2522 table = get_table(table_name);
2523 row = ovsdb_idl_txn_insert(ctx->txn, table->class, uuid);
2524 for (i = 2; i < ctx->argc; i++) {
2525 set_column(table, row, ctx->argv[i], ctx->symtab);
2527 ds_put_format(&ctx->output, UUID_FMT, UUID_ARGS(&row->uuid));
2530 /* This function may be used as the 'postprocess' function for commands that
2531 * insert new rows into the database. It expects that the command's 'run'
2532 * function prints the UUID reported by ovsdb_idl_txn_insert() as the command's
2533 * sole output. It replaces that output by the row's permanent UUID assigned
2534 * by the database server and appends a new-line.
2536 * Currently we use this only for "create", because the higher-level commands
2537 * are supposed to be independent of the actual structure of the vswitch
2540 post_create(struct vsctl_context *ctx)
2542 const struct uuid *real;
2545 uuid_from_string(&dummy, ds_cstr(&ctx->output));
2546 real = ovsdb_idl_txn_get_insert_uuid(ctx->txn, &dummy);
2548 ds_clear(&ctx->output);
2549 ds_put_format(&ctx->output, UUID_FMT, UUID_ARGS(real));
2551 ds_put_char(&ctx->output, '\n');
2555 cmd_destroy(struct vsctl_context *ctx)
2557 bool must_exist = !shash_find(&ctx->options, "--if-exists");
2558 const char *table_name = ctx->argv[1];
2559 const struct vsctl_table_class *table;
2562 table = get_table(table_name);
2563 for (i = 2; i < ctx->argc; i++) {
2564 const struct ovsdb_idl_row *row;
2566 row = (must_exist ? must_get_row : get_row)(ctx, table, ctx->argv[i]);
2568 ovsdb_idl_txn_delete(row);
2574 is_condition_satified(const struct vsctl_table_class *table,
2575 const struct ovsdb_idl_row *row, const char *arg,
2576 struct ovsdb_symbol_table *symtab)
2578 static const char *operators[] = {
2579 "=", "!=", "<", ">", "<=", ">="
2582 const struct ovsdb_idl_column *column;
2583 const struct ovsdb_datum *have_datum;
2584 char *key_string, *value_string;
2585 const char *operator;
2590 error = parse_column_key_value(arg, table, &column, &key_string,
2591 &operator, operators, ARRAY_SIZE(operators),
2593 die_if_error(error);
2594 if (!value_string) {
2595 vsctl_fatal("%s: missing value", arg);
2598 have_datum = ovsdb_idl_read(row, column);
2600 union ovsdb_atom want_key, want_value;
2602 if (column->type.value.type == OVSDB_TYPE_VOID) {
2603 vsctl_fatal("cannot specify key to check for non-map column %s",
2607 die_if_error(ovsdb_atom_from_string(&want_key, &column->type.key,
2608 key_string, symtab));
2609 die_if_error(ovsdb_atom_from_string(&want_value, &column->type.value,
2610 value_string, symtab));
2612 idx = ovsdb_datum_find_key(have_datum,
2613 &want_key, column->type.key.type);
2614 if (idx != UINT_MAX) {
2615 cmp = ovsdb_atom_compare_3way(&have_datum->values[idx],
2617 column->type.value.type);
2620 ovsdb_atom_destroy(&want_key, column->type.key.type);
2621 ovsdb_atom_destroy(&want_value, column->type.value.type);
2623 struct ovsdb_datum want_datum;
2625 die_if_error(ovsdb_datum_from_string(&want_datum, &column->type,
2626 value_string, symtab));
2628 cmp = ovsdb_datum_compare_3way(have_datum, &want_datum,
2630 ovsdb_datum_destroy(&want_datum, &column->type);
2636 return (idx == UINT_MAX ? false
2637 : !strcmp(operator, "=") ? cmp == 0
2638 : !strcmp(operator, "!=") ? cmp != 0
2639 : !strcmp(operator, "<") ? cmp < 0
2640 : !strcmp(operator, ">") ? cmp > 0
2641 : !strcmp(operator, "<=") ? cmp <= 0
2642 : !strcmp(operator, ">=") ? cmp >= 0
2647 cmd_wait_until(struct vsctl_context *ctx)
2649 const char *table_name = ctx->argv[1];
2650 const char *record_id = ctx->argv[2];
2651 const struct vsctl_table_class *table;
2652 const struct ovsdb_idl_row *row;
2655 table = get_table(table_name);
2657 row = get_row(ctx, table, record_id);
2659 ctx->try_again = true;
2663 for (i = 3; i < ctx->argc; i++) {
2664 if (!is_condition_satified(table, row, ctx->argv[i], ctx->symtab)) {
2665 ctx->try_again = true;
2671 static struct json *
2672 where_uuid_equals(const struct uuid *uuid)
2675 json_array_create_1(
2676 json_array_create_3(
2677 json_string_create("_uuid"),
2678 json_string_create("=="),
2679 json_array_create_2(
2680 json_string_create("uuid"),
2681 json_string_create_nocopy(
2682 xasprintf(UUID_FMT, UUID_ARGS(uuid))))));
2686 vsctl_context_init(struct vsctl_context *ctx, struct vsctl_command *command,
2687 struct ovsdb_idl *idl, struct ovsdb_idl_txn *txn,
2688 const struct ovsrec_open_vswitch *ovs,
2689 struct ovsdb_symbol_table *symtab)
2691 ctx->argc = command->argc;
2692 ctx->argv = command->argv;
2693 ctx->options = command->options;
2695 ds_swap(&ctx->output, &command->output);
2699 ctx->symtab = symtab;
2701 ctx->try_again = false;
2705 vsctl_context_done(struct vsctl_context *ctx, struct vsctl_command *command)
2707 ds_swap(&ctx->output, &command->output);
2711 do_vsctl(const char *args, struct vsctl_command *commands, size_t n_commands,
2712 struct ovsdb_idl *idl)
2714 struct ovsdb_idl_txn *txn;
2715 const struct ovsrec_open_vswitch *ovs;
2716 enum ovsdb_idl_txn_status status;
2717 struct ovsdb_symbol_table *symtab;
2719 struct vsctl_command *c;
2720 int64_t next_cfg = 0;
2723 txn = the_idl_txn = ovsdb_idl_txn_create(idl);
2725 ovsdb_idl_txn_set_dry_run(txn);
2728 ovsdb_idl_txn_add_comment(txn, "ovs-vsctl: %s", args);
2730 ovs = ovsrec_open_vswitch_first(idl);
2732 /* XXX add verification that table is empty */
2733 ovs = ovsrec_open_vswitch_insert(txn);
2736 if (wait_for_reload) {
2737 struct json *where = where_uuid_equals(&ovs->header_.uuid);
2738 ovsdb_idl_txn_increment(txn, "Open_vSwitch", "next_cfg", where);
2739 json_destroy(where);
2742 symtab = ovsdb_symbol_table_create();
2743 for (c = commands; c < &commands[n_commands]; c++) {
2744 ds_init(&c->output);
2746 for (c = commands; c < &commands[n_commands]; c++) {
2747 struct vsctl_context ctx;
2749 vsctl_context_init(&ctx, c, idl, txn, ovs, symtab);
2750 (c->syntax->run)(&ctx);
2751 vsctl_context_done(&ctx, c);
2753 if (ctx.try_again) {
2758 status = ovsdb_idl_txn_commit_block(txn);
2759 if (wait_for_reload && status == TXN_SUCCESS) {
2760 next_cfg = ovsdb_idl_txn_get_increment_new_value(txn);
2762 if (status == TXN_UNCHANGED || status == TXN_SUCCESS) {
2763 for (c = commands; c < &commands[n_commands]; c++) {
2764 if (c->syntax->postprocess) {
2765 struct vsctl_context ctx;
2767 vsctl_context_init(&ctx, c, idl, txn, ovs, symtab);
2768 (c->syntax->postprocess)(&ctx);
2769 vsctl_context_done(&ctx, c);
2773 error = xstrdup(ovsdb_idl_txn_get_error(txn));
2774 ovsdb_idl_txn_destroy(txn);
2777 unused = ovsdb_symbol_table_find_unused(symtab);
2779 vsctl_fatal("row id \"%s\" is referenced but never created (e.g. "
2780 "with \"-- --id=%s create ...\")", unused, unused);
2784 case TXN_INCOMPLETE:
2788 /* Should not happen--we never call ovsdb_idl_txn_abort(). */
2789 vsctl_fatal("transaction aborted");
2799 vsctl_fatal("transaction error: %s", error);
2806 ovsdb_symbol_table_destroy(symtab);
2808 for (c = commands; c < &commands[n_commands]; c++) {
2809 struct ds *ds = &c->output;
2810 struct shash_node *node;
2816 for (j = 0; j < ds->length; j++) {
2817 int ch = ds->string[j];
2820 fputs("\\n", stdout);
2824 fputs("\\\\", stdout);
2833 fputs(ds_cstr(ds), stdout);
2835 ds_destroy(&c->output);
2837 SHASH_FOR_EACH (node, &c->options) {
2840 shash_destroy(&c->options);
2844 if (wait_for_reload && status != TXN_UNCHANGED) {
2847 OVSREC_OPEN_VSWITCH_FOR_EACH (ovs, idl) {
2848 if (ovs->cur_cfg >= next_cfg) {
2852 ovsdb_idl_wait(idl);
2857 ovsdb_idl_destroy(idl);
2862 /* Our transaction needs to be rerun, or a prerequisite was not met. Free
2863 * resources and return so that the caller can try again. */
2864 ovsdb_idl_txn_abort(txn);
2865 ovsdb_idl_txn_destroy(txn);
2866 ovsdb_symbol_table_destroy(symtab);
2867 for (c = commands; c < &commands[n_commands]; c++) {
2868 ds_destroy(&c->output);
2873 static const struct vsctl_command_syntax all_commands[] = {
2874 /* Open vSwitch commands. */
2875 {"init", 0, 0, cmd_init, NULL, "", RW},
2877 /* Bridge commands. */
2878 {"add-br", 1, 3, cmd_add_br, NULL, "--may-exist", RW},
2879 {"del-br", 1, 1, cmd_del_br, NULL, "--if-exists", RW},
2880 {"list-br", 0, 0, cmd_list_br, NULL, "", RO},
2881 {"br-exists", 1, 1, cmd_br_exists, NULL, "", RO},
2882 {"br-to-vlan", 1, 1, cmd_br_to_vlan, NULL, "", RO},
2883 {"br-to-parent", 1, 1, cmd_br_to_parent, NULL, "", RO},
2884 {"br-set-external-id", 2, 3, cmd_br_set_external_id, NULL, "", RW},
2885 {"br-get-external-id", 1, 2, cmd_br_get_external_id, NULL, "", RO},
2887 /* Port commands. */
2888 {"list-ports", 1, 1, cmd_list_ports, NULL, "", RO},
2889 {"add-port", 2, INT_MAX, cmd_add_port, NULL, "--may-exist", RW},
2890 {"add-bond", 4, INT_MAX, cmd_add_bond, NULL, "--may-exist,--fake-iface", RW},
2891 {"del-port", 1, 2, cmd_del_port, NULL, "--if-exists,--with-iface", RW},
2892 {"port-to-br", 1, 1, cmd_port_to_br, NULL, "", RO},
2894 /* Interface commands. */
2895 {"list-ifaces", 1, 1, cmd_list_ifaces, NULL, "", RO},
2896 {"iface-to-br", 1, 1, cmd_iface_to_br, NULL, "", RO},
2898 /* Controller commands. */
2899 {"get-controller", 1, 1, cmd_get_controller, NULL, "", RO},
2900 {"del-controller", 1, 1, cmd_del_controller, NULL, "", RW},
2901 {"set-controller", 1, INT_MAX, cmd_set_controller, NULL, "", RW},
2902 {"get-fail-mode", 1, 1, cmd_get_fail_mode, NULL, "", RO},
2903 {"del-fail-mode", 1, 1, cmd_del_fail_mode, NULL, "", RW},
2904 {"set-fail-mode", 2, 2, cmd_set_fail_mode, NULL, "", RW},
2907 {"get-ssl", 0, 0, cmd_get_ssl, NULL, "", RO},
2908 {"del-ssl", 0, 0, cmd_del_ssl, NULL, "", RW},
2909 {"set-ssl", 3, 3, cmd_set_ssl, NULL, "--bootstrap", RW},
2911 /* Switch commands. */
2912 {"emer-reset", 0, 0, cmd_emer_reset, NULL, "", RW},
2914 /* Parameter commands. */
2915 {"get", 2, INT_MAX, cmd_get, NULL, "--if-exists,--id=", RO},
2916 {"list", 1, INT_MAX, cmd_list, NULL, "", RO},
2917 {"set", 3, INT_MAX, cmd_set, NULL, "", RW},
2918 {"add", 4, INT_MAX, cmd_add, NULL, "", RW},
2919 {"remove", 4, INT_MAX, cmd_remove, NULL, "", RW},
2920 {"clear", 3, INT_MAX, cmd_clear, NULL, "", RW},
2921 {"create", 2, INT_MAX, cmd_create, post_create, "--id=", RW},
2922 {"destroy", 1, INT_MAX, cmd_destroy, NULL, "--if-exists", RW},
2923 {"wait-until", 2, INT_MAX, cmd_wait_until, NULL, "", RO},
2925 {NULL, 0, 0, NULL, NULL, NULL, RO},