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;
544 /* A command may set this member to true if some prerequisite is not met
545 * and the caller should wait for something to change and then retry. */
549 struct vsctl_bridge {
550 struct ovsrec_bridge *br_cfg;
552 struct ovsrec_controller **ctrl;
555 struct vsctl_bridge *parent;
560 struct ovsrec_port *port_cfg;
561 struct vsctl_bridge *bridge;
565 struct ovsrec_interface *iface_cfg;
566 struct vsctl_port *port;
570 struct vsctl_context *ctx;
571 struct shash bridges;
577 vsctl_context_to_string(const struct vsctl_context *ctx)
579 const struct shash_node *node;
585 SHASH_FOR_EACH (node, &ctx->options) {
586 svec_add(&words, node->name);
588 for (i = 0; i < ctx->argc; i++) {
589 svec_add(&words, ctx->argv[i]);
591 svec_terminate(&words);
593 s = process_escape_args(words.names);
595 svec_destroy(&words);
601 verify_ports(struct vsctl_context *ctx)
603 if (!ctx->verified_ports) {
604 const struct ovsrec_bridge *bridge;
605 const struct ovsrec_port *port;
607 ovsrec_open_vswitch_verify_bridges(ctx->ovs);
608 OVSREC_BRIDGE_FOR_EACH (bridge, ctx->idl) {
609 ovsrec_bridge_verify_ports(bridge);
611 OVSREC_PORT_FOR_EACH (port, ctx->idl) {
612 ovsrec_port_verify_interfaces(port);
615 ctx->verified_ports = true;
619 static struct vsctl_bridge *
620 add_bridge(struct vsctl_info *b,
621 struct ovsrec_bridge *br_cfg, const char *name,
622 struct vsctl_bridge *parent, int vlan)
624 struct vsctl_bridge *br = xmalloc(sizeof *br);
626 br->name = xstrdup(name);
630 br->ctrl = parent->br_cfg->controller;
631 br->n_ctrl = parent->br_cfg->n_controller;
632 br->fail_mode = parent->br_cfg->fail_mode;
634 br->ctrl = br_cfg->controller;
635 br->n_ctrl = br_cfg->n_controller;
636 br->fail_mode = br_cfg->fail_mode;
638 shash_add(&b->bridges, br->name, br);
643 port_is_fake_bridge(const struct ovsrec_port *port_cfg)
645 return (port_cfg->fake_bridge
647 && *port_cfg->tag >= 1 && *port_cfg->tag <= 4095);
650 static struct vsctl_bridge *
651 find_vlan_bridge(struct vsctl_info *info,
652 struct vsctl_bridge *parent, int vlan)
654 struct shash_node *node;
656 SHASH_FOR_EACH (node, &info->bridges) {
657 struct vsctl_bridge *br = node->data;
658 if (br->parent == parent && br->vlan == vlan) {
667 free_info(struct vsctl_info *info)
669 struct shash_node *node;
671 SHASH_FOR_EACH (node, &info->bridges) {
672 struct vsctl_bridge *bridge = node->data;
676 shash_destroy(&info->bridges);
678 shash_destroy_free_data(&info->ports);
679 shash_destroy_free_data(&info->ifaces);
683 get_info(struct vsctl_context *ctx, struct vsctl_info *info)
685 const struct ovsrec_open_vswitch *ovs = ctx->ovs;
686 struct shash bridges, ports;
690 shash_init(&info->bridges);
691 shash_init(&info->ports);
692 shash_init(&info->ifaces);
694 shash_init(&bridges);
696 for (i = 0; i < ovs->n_bridges; i++) {
697 struct ovsrec_bridge *br_cfg = ovs->bridges[i];
698 struct vsctl_bridge *br;
701 if (!shash_add_once(&bridges, br_cfg->name, NULL)) {
702 VLOG_WARN("%s: database contains duplicate bridge name",
706 br = add_bridge(info, br_cfg, br_cfg->name, NULL, 0);
711 for (j = 0; j < br_cfg->n_ports; j++) {
712 struct ovsrec_port *port_cfg = br_cfg->ports[j];
714 if (!shash_add_once(&ports, port_cfg->name, NULL)) {
715 VLOG_WARN("%s: database contains duplicate port name",
720 if (port_is_fake_bridge(port_cfg)
721 && shash_add_once(&bridges, port_cfg->name, NULL)) {
722 add_bridge(info, NULL, port_cfg->name, br, *port_cfg->tag);
726 shash_destroy(&bridges);
727 shash_destroy(&ports);
729 shash_init(&bridges);
731 for (i = 0; i < ovs->n_bridges; i++) {
732 struct ovsrec_bridge *br_cfg = ovs->bridges[i];
733 struct vsctl_bridge *br;
736 if (!shash_add_once(&bridges, br_cfg->name, NULL)) {
739 br = shash_find_data(&info->bridges, br_cfg->name);
740 for (j = 0; j < br_cfg->n_ports; j++) {
741 struct ovsrec_port *port_cfg = br_cfg->ports[j];
742 struct vsctl_port *port;
745 if (!shash_add_once(&ports, port_cfg->name, NULL)) {
749 if (port_is_fake_bridge(port_cfg)
750 && !shash_add_once(&bridges, port_cfg->name, NULL)) {
754 port = xmalloc(sizeof *port);
755 port->port_cfg = port_cfg;
757 && *port_cfg->tag >= 1 && *port_cfg->tag <= 4095) {
758 port->bridge = find_vlan_bridge(info, br, *port_cfg->tag);
765 shash_add(&info->ports, port_cfg->name, port);
767 for (k = 0; k < port_cfg->n_interfaces; k++) {
768 struct ovsrec_interface *iface_cfg = port_cfg->interfaces[k];
769 struct vsctl_iface *iface;
771 if (shash_find(&info->ifaces, iface_cfg->name)) {
772 VLOG_WARN("%s: database contains duplicate interface name",
777 iface = xmalloc(sizeof *iface);
778 iface->iface_cfg = iface_cfg;
780 shash_add(&info->ifaces, iface_cfg->name, iface);
784 shash_destroy(&bridges);
785 shash_destroy(&ports);
789 check_conflicts(struct vsctl_info *info, const char *name,
792 struct vsctl_iface *iface;
793 struct vsctl_port *port;
795 verify_ports(info->ctx);
797 if (shash_find(&info->bridges, name)) {
798 vsctl_fatal("%s because a bridge named %s already exists",
802 port = shash_find_data(&info->ports, name);
804 vsctl_fatal("%s because a port named %s already exists on "
805 "bridge %s", msg, name, port->bridge->name);
808 iface = shash_find_data(&info->ifaces, name);
810 vsctl_fatal("%s because an interface named %s already exists "
811 "on bridge %s", msg, name, iface->port->bridge->name);
817 static struct vsctl_bridge *
818 find_bridge(struct vsctl_info *info, const char *name, bool must_exist)
820 struct vsctl_bridge *br = shash_find_data(&info->bridges, name);
821 if (must_exist && !br) {
822 vsctl_fatal("no bridge named %s", name);
824 ovsrec_open_vswitch_verify_bridges(info->ctx->ovs);
828 static struct vsctl_bridge *
829 find_real_bridge(struct vsctl_info *info, const char *name, bool must_exist)
831 struct vsctl_bridge *br = find_bridge(info, name, must_exist);
832 if (br && br->parent) {
833 vsctl_fatal("%s is a fake bridge", name);
838 static struct vsctl_port *
839 find_port(struct vsctl_info *info, const char *name, bool must_exist)
841 struct vsctl_port *port = shash_find_data(&info->ports, name);
842 if (port && !strcmp(name, port->bridge->name)) {
845 if (must_exist && !port) {
846 vsctl_fatal("no port named %s", name);
848 verify_ports(info->ctx);
852 static struct vsctl_iface *
853 find_iface(struct vsctl_info *info, const char *name, bool must_exist)
855 struct vsctl_iface *iface = shash_find_data(&info->ifaces, name);
856 if (iface && !strcmp(name, iface->port->bridge->name)) {
859 if (must_exist && !iface) {
860 vsctl_fatal("no interface named %s", name);
862 verify_ports(info->ctx);
867 bridge_insert_port(struct ovsrec_bridge *br, struct ovsrec_port *port)
869 struct ovsrec_port **ports;
872 ports = xmalloc(sizeof *br->ports * (br->n_ports + 1));
873 for (i = 0; i < br->n_ports; i++) {
874 ports[i] = br->ports[i];
876 ports[br->n_ports] = port;
877 ovsrec_bridge_set_ports(br, ports, br->n_ports + 1);
882 bridge_delete_port(struct ovsrec_bridge *br, struct ovsrec_port *port)
884 struct ovsrec_port **ports;
887 ports = xmalloc(sizeof *br->ports * br->n_ports);
888 for (i = n = 0; i < br->n_ports; i++) {
889 if (br->ports[i] != port) {
890 ports[n++] = br->ports[i];
893 ovsrec_bridge_set_ports(br, ports, n);
898 ovs_insert_bridge(const struct ovsrec_open_vswitch *ovs,
899 struct ovsrec_bridge *bridge)
901 struct ovsrec_bridge **bridges;
904 bridges = xmalloc(sizeof *ovs->bridges * (ovs->n_bridges + 1));
905 for (i = 0; i < ovs->n_bridges; i++) {
906 bridges[i] = ovs->bridges[i];
908 bridges[ovs->n_bridges] = bridge;
909 ovsrec_open_vswitch_set_bridges(ovs, bridges, ovs->n_bridges + 1);
914 ovs_delete_bridge(const struct ovsrec_open_vswitch *ovs,
915 struct ovsrec_bridge *bridge)
917 struct ovsrec_bridge **bridges;
920 bridges = xmalloc(sizeof *ovs->bridges * ovs->n_bridges);
921 for (i = n = 0; i < ovs->n_bridges; i++) {
922 if (ovs->bridges[i] != bridge) {
923 bridges[n++] = ovs->bridges[i];
926 ovsrec_open_vswitch_set_bridges(ovs, bridges, n);
931 cmd_init(struct vsctl_context *ctx OVS_UNUSED)
936 cmd_emer_reset(struct vsctl_context *ctx)
938 const struct ovsdb_idl *idl = ctx->idl;
939 const struct ovsrec_bridge *br;
940 const struct ovsrec_port *port;
941 const struct ovsrec_interface *iface;
942 const struct ovsrec_mirror *mirror, *next_mirror;
943 const struct ovsrec_controller *ctrl, *next_ctrl;
944 const struct ovsrec_netflow *nf, *next_nf;
945 const struct ovsrec_ssl *ssl, *next_ssl;
946 const struct ovsrec_sflow *sflow, *next_sflow;
949 /* Reset the Open_vSwitch table. */
950 ovsrec_open_vswitch_set_managers(ctx->ovs, NULL, 0);
951 ovsrec_open_vswitch_set_ssl(ctx->ovs, NULL);
953 OVSREC_BRIDGE_FOR_EACH (br, idl) {
955 char *hw_key = "hwaddr";
958 ovsrec_bridge_set_controller(br, NULL, 0);
959 ovsrec_bridge_set_mirrors(br, NULL, 0);
960 ovsrec_bridge_set_netflow(br, NULL);
961 ovsrec_bridge_set_sflow(br, NULL);
962 ovsrec_bridge_set_flood_vlans(br, NULL, 0);
964 /* We only want to save the "hwaddr" key from other_config. */
965 for (i=0; i < br->n_other_config; i++) {
966 if (!strcmp(br->key_other_config[i], hw_key)) {
967 hw_val = br->value_other_config[i];
972 char *val = xstrdup(hw_val);
973 ovsrec_bridge_set_other_config(br, &hw_key, &val, 1);
976 ovsrec_bridge_set_other_config(br, NULL, NULL, 0);
980 OVSREC_PORT_FOR_EACH (port, idl) {
981 ovsrec_port_set_other_config(port, NULL, NULL, 0);
984 OVSREC_INTERFACE_FOR_EACH (iface, idl) {
985 /* xxx What do we do about gre/patch devices created by mgr? */
987 ovsrec_interface_set_ingress_policing_rate(iface, 0);
988 ovsrec_interface_set_ingress_policing_burst(iface, 0);
991 OVSREC_MIRROR_FOR_EACH_SAFE (mirror, next_mirror, idl) {
992 ovsrec_mirror_delete(mirror);
995 OVSREC_CONTROLLER_FOR_EACH_SAFE (ctrl, next_ctrl, idl) {
996 ovsrec_controller_delete(ctrl);
999 OVSREC_NETFLOW_FOR_EACH_SAFE (nf, next_nf, idl) {
1000 ovsrec_netflow_delete(nf);
1003 OVSREC_SSL_FOR_EACH_SAFE (ssl, next_ssl, idl) {
1004 ovsrec_ssl_delete(ssl);
1007 OVSREC_SFLOW_FOR_EACH_SAFE (sflow, next_sflow, idl) {
1008 ovsrec_sflow_delete(sflow);
1013 cmd_add_br(struct vsctl_context *ctx)
1015 bool may_exist = shash_find(&ctx->options, "--may-exist") != 0;
1016 const char *br_name, *parent_name;
1017 struct vsctl_info info;
1020 br_name = ctx->argv[1];
1021 if (ctx->argc == 2) {
1024 } else if (ctx->argc == 4) {
1025 parent_name = ctx->argv[2];
1026 vlan = atoi(ctx->argv[3]);
1027 if (vlan < 1 || vlan > 4095) {
1028 vsctl_fatal("%s: vlan must be between 1 and 4095", ctx->argv[0]);
1031 vsctl_fatal("'%s' command takes exactly 1 or 3 arguments",
1035 get_info(ctx, &info);
1037 struct vsctl_bridge *br;
1039 br = find_bridge(&info, br_name, false);
1043 vsctl_fatal("\"--may-exist add-br %s\" but %s is "
1044 "a VLAN bridge for VLAN %d",
1045 br_name, br_name, br->vlan);
1049 vsctl_fatal("\"--may-exist add-br %s %s %d\" but %s "
1050 "is not a VLAN bridge",
1051 br_name, parent_name, vlan, br_name);
1052 } else if (strcmp(br->parent->name, parent_name)) {
1053 vsctl_fatal("\"--may-exist add-br %s %s %d\" but %s "
1054 "has the wrong parent %s",
1055 br_name, parent_name, vlan,
1056 br_name, br->parent->name);
1057 } else if (br->vlan != vlan) {
1058 vsctl_fatal("\"--may-exist add-br %s %s %d\" but %s "
1059 "is a VLAN bridge for the wrong VLAN %d",
1060 br_name, parent_name, vlan, br_name, br->vlan);
1066 check_conflicts(&info, br_name,
1067 xasprintf("cannot create a bridge named %s", br_name));
1070 struct ovsrec_port *port;
1071 struct ovsrec_interface *iface;
1072 struct ovsrec_bridge *br;
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);
1082 br = ovsrec_bridge_insert(ctx->txn);
1083 ovsrec_bridge_set_name(br, br_name);
1084 ovsrec_bridge_set_ports(br, &port, 1);
1086 ovs_insert_bridge(ctx->ovs, br);
1088 struct vsctl_bridge *parent;
1089 struct ovsrec_port *port;
1090 struct ovsrec_interface *iface;
1091 struct ovsrec_bridge *br;
1094 parent = find_bridge(&info, parent_name, false);
1095 if (parent && parent->vlan) {
1096 vsctl_fatal("cannot create bridge with fake bridge as parent");
1099 vsctl_fatal("parent bridge %s does not exist", parent_name);
1101 br = parent->br_cfg;
1103 iface = ovsrec_interface_insert(ctx->txn);
1104 ovsrec_interface_set_name(iface, br_name);
1105 ovsrec_interface_set_type(iface, "internal");
1107 port = ovsrec_port_insert(ctx->txn);
1108 ovsrec_port_set_name(port, br_name);
1109 ovsrec_port_set_interfaces(port, &iface, 1);
1110 ovsrec_port_set_fake_bridge(port, true);
1111 ovsrec_port_set_tag(port, &tag, 1);
1113 bridge_insert_port(br, port);
1120 del_port(struct vsctl_info *info, struct vsctl_port *port)
1122 struct shash_node *node;
1124 SHASH_FOR_EACH (node, &info->ifaces) {
1125 struct vsctl_iface *iface = node->data;
1126 if (iface->port == port) {
1127 ovsrec_interface_delete(iface->iface_cfg);
1130 ovsrec_port_delete(port->port_cfg);
1132 bridge_delete_port((port->bridge->parent
1133 ? port->bridge->parent->br_cfg
1134 : port->bridge->br_cfg), port->port_cfg);
1138 cmd_del_br(struct vsctl_context *ctx)
1140 bool must_exist = !shash_find(&ctx->options, "--if-exists");
1141 struct vsctl_bridge *bridge;
1142 struct vsctl_info info;
1144 get_info(ctx, &info);
1145 bridge = find_bridge(&info, ctx->argv[1], must_exist);
1147 struct shash_node *node;
1149 SHASH_FOR_EACH (node, &info.ports) {
1150 struct vsctl_port *port = node->data;
1151 if (port->bridge == bridge || port->bridge->parent == bridge
1152 || !strcmp(port->port_cfg->name, bridge->name)) {
1153 del_port(&info, port);
1156 if (bridge->br_cfg) {
1157 ovsrec_bridge_delete(bridge->br_cfg);
1158 ovs_delete_bridge(ctx->ovs, bridge->br_cfg);
1165 output_sorted(struct svec *svec, struct ds *output)
1171 SVEC_FOR_EACH (i, name, svec) {
1172 ds_put_format(output, "%s\n", name);
1177 cmd_list_br(struct vsctl_context *ctx)
1179 struct shash_node *node;
1180 struct vsctl_info info;
1181 struct svec bridges;
1183 get_info(ctx, &info);
1185 svec_init(&bridges);
1186 SHASH_FOR_EACH (node, &info.bridges) {
1187 struct vsctl_bridge *br = node->data;
1188 svec_add(&bridges, br->name);
1190 output_sorted(&bridges, &ctx->output);
1191 svec_destroy(&bridges);
1197 cmd_br_exists(struct vsctl_context *ctx)
1199 struct vsctl_info info;
1201 get_info(ctx, &info);
1202 if (!find_bridge(&info, ctx->argv[1], false)) {
1208 /* Returns true if 'b_prefix' (of length 'b_prefix_len') concatenated with 'b'
1209 * equals 'a', false otherwise. */
1211 key_matches(const char *a,
1212 const char *b_prefix, size_t b_prefix_len, const char *b)
1214 return !strncmp(a, b_prefix, b_prefix_len) && !strcmp(a + b_prefix_len, b);
1218 set_external_id(char **old_keys, char **old_values, size_t old_n,
1219 char *key, char *value,
1220 char ***new_keysp, char ***new_valuesp, size_t *new_np)
1227 new_keys = xmalloc(sizeof *new_keys * (old_n + 1));
1228 new_values = xmalloc(sizeof *new_values * (old_n + 1));
1230 for (i = 0; i < old_n; i++) {
1231 if (strcmp(key, old_keys[i])) {
1232 new_keys[new_n] = old_keys[i];
1233 new_values[new_n] = old_values[i];
1238 new_keys[new_n] = key;
1239 new_values[new_n] = value;
1242 *new_keysp = new_keys;
1243 *new_valuesp = new_values;
1248 cmd_br_set_external_id(struct vsctl_context *ctx)
1250 struct vsctl_info info;
1251 struct vsctl_bridge *bridge;
1252 char **keys, **values;
1255 get_info(ctx, &info);
1256 bridge = find_bridge(&info, ctx->argv[1], true);
1257 if (bridge->br_cfg) {
1258 set_external_id(bridge->br_cfg->key_external_ids,
1259 bridge->br_cfg->value_external_ids,
1260 bridge->br_cfg->n_external_ids,
1261 ctx->argv[2], ctx->argc >= 4 ? ctx->argv[3] : NULL,
1262 &keys, &values, &n);
1263 ovsrec_bridge_verify_external_ids(bridge->br_cfg);
1264 ovsrec_bridge_set_external_ids(bridge->br_cfg, keys, values, n);
1266 char *key = xasprintf("fake-bridge-%s", ctx->argv[2]);
1267 struct vsctl_port *port = shash_find_data(&info.ports, ctx->argv[1]);
1268 set_external_id(port->port_cfg->key_external_ids,
1269 port->port_cfg->value_external_ids,
1270 port->port_cfg->n_external_ids,
1271 key, ctx->argc >= 4 ? ctx->argv[3] : NULL,
1272 &keys, &values, &n);
1273 ovsrec_port_verify_external_ids(port->port_cfg);
1274 ovsrec_port_set_external_ids(port->port_cfg, keys, values, n);
1284 get_external_id(char **keys, char **values, size_t n,
1285 const char *prefix, const char *key,
1288 size_t prefix_len = strlen(prefix);
1293 for (i = 0; i < n; i++) {
1294 if (!key && !strncmp(keys[i], prefix, prefix_len)) {
1295 svec_add_nocopy(&svec, xasprintf("%s=%s",
1296 keys[i] + prefix_len, values[i]));
1297 } else if (key_matches(keys[i], prefix, prefix_len, key)) {
1298 svec_add(&svec, values[i]);
1302 output_sorted(&svec, output);
1303 svec_destroy(&svec);
1307 cmd_br_get_external_id(struct vsctl_context *ctx)
1309 struct vsctl_info info;
1310 struct vsctl_bridge *bridge;
1312 get_info(ctx, &info);
1313 bridge = find_bridge(&info, ctx->argv[1], true);
1314 if (bridge->br_cfg) {
1315 ovsrec_bridge_verify_external_ids(bridge->br_cfg);
1316 get_external_id(bridge->br_cfg->key_external_ids,
1317 bridge->br_cfg->value_external_ids,
1318 bridge->br_cfg->n_external_ids,
1319 "", ctx->argc >= 3 ? ctx->argv[2] : NULL,
1322 struct vsctl_port *port = shash_find_data(&info.ports, ctx->argv[1]);
1323 ovsrec_port_verify_external_ids(port->port_cfg);
1324 get_external_id(port->port_cfg->key_external_ids,
1325 port->port_cfg->value_external_ids,
1326 port->port_cfg->n_external_ids,
1327 "fake-bridge-", ctx->argc >= 3 ? ctx->argv[2] : NULL, &ctx->output);
1334 cmd_list_ports(struct vsctl_context *ctx)
1336 struct vsctl_bridge *br;
1337 struct shash_node *node;
1338 struct vsctl_info info;
1341 get_info(ctx, &info);
1342 br = find_bridge(&info, ctx->argv[1], true);
1343 ovsrec_bridge_verify_ports(br->br_cfg ? br->br_cfg : br->parent->br_cfg);
1346 SHASH_FOR_EACH (node, &info.ports) {
1347 struct vsctl_port *port = node->data;
1349 if (strcmp(port->port_cfg->name, br->name) && br == port->bridge) {
1350 svec_add(&ports, port->port_cfg->name);
1353 output_sorted(&ports, &ctx->output);
1354 svec_destroy(&ports);
1360 add_port(struct vsctl_context *ctx,
1361 const char *br_name, const char *port_name,
1362 bool may_exist, bool fake_iface,
1363 char *iface_names[], int n_ifaces,
1364 char *settings[], int n_settings)
1366 struct vsctl_info info;
1367 struct vsctl_bridge *bridge;
1368 struct ovsrec_interface **ifaces;
1369 struct ovsrec_port *port;
1372 get_info(ctx, &info);
1374 struct vsctl_port *vsctl_port;
1376 vsctl_port = find_port(&info, port_name, false);
1378 struct svec want_names, have_names;
1380 svec_init(&want_names);
1381 for (i = 0; i < n_ifaces; i++) {
1382 svec_add(&want_names, iface_names[i]);
1384 svec_sort(&want_names);
1386 svec_init(&have_names);
1387 for (i = 0; i < vsctl_port->port_cfg->n_interfaces; i++) {
1388 svec_add(&have_names,
1389 vsctl_port->port_cfg->interfaces[i]->name);
1391 svec_sort(&have_names);
1393 if (strcmp(vsctl_port->bridge->name, br_name)) {
1394 char *command = vsctl_context_to_string(ctx);
1395 vsctl_fatal("\"%s\" but %s is actually attached to bridge %s",
1396 command, port_name, vsctl_port->bridge->name);
1399 if (!svec_equal(&want_names, &have_names)) {
1400 char *have_names_string = svec_join(&have_names, ", ", "");
1401 char *command = vsctl_context_to_string(ctx);
1403 vsctl_fatal("\"%s\" but %s actually has interface(s) %s",
1404 command, port_name, have_names_string);
1407 svec_destroy(&want_names);
1408 svec_destroy(&have_names);
1413 check_conflicts(&info, port_name,
1414 xasprintf("cannot create a port named %s", port_name));
1415 for (i = 0; i < n_ifaces; i++) {
1416 check_conflicts(&info, iface_names[i],
1417 xasprintf("cannot create an interface named %s",
1420 bridge = find_bridge(&info, br_name, true);
1422 ifaces = xmalloc(n_ifaces * sizeof *ifaces);
1423 for (i = 0; i < n_ifaces; i++) {
1424 ifaces[i] = ovsrec_interface_insert(ctx->txn);
1425 ovsrec_interface_set_name(ifaces[i], iface_names[i]);
1428 port = ovsrec_port_insert(ctx->txn);
1429 ovsrec_port_set_name(port, port_name);
1430 ovsrec_port_set_interfaces(port, ifaces, n_ifaces);
1431 ovsrec_port_set_bond_fake_iface(port, fake_iface);
1435 int64_t tag = bridge->vlan;
1436 ovsrec_port_set_tag(port, &tag, 1);
1439 for (i = 0; i < n_settings; i++) {
1440 set_column(get_table("Port"), &port->header_, settings[i],
1444 bridge_insert_port((bridge->parent ? bridge->parent->br_cfg
1445 : bridge->br_cfg), port);
1451 cmd_add_port(struct vsctl_context *ctx)
1453 bool may_exist = shash_find(&ctx->options, "--may-exist") != 0;
1455 add_port(ctx, ctx->argv[1], ctx->argv[2], may_exist, false,
1456 &ctx->argv[2], 1, &ctx->argv[3], ctx->argc - 3);
1460 cmd_add_bond(struct vsctl_context *ctx)
1462 bool may_exist = shash_find(&ctx->options, "--may-exist") != 0;
1463 bool fake_iface = shash_find(&ctx->options, "--fake-iface");
1467 n_ifaces = ctx->argc - 3;
1468 for (i = 3; i < ctx->argc; i++) {
1469 if (strchr(ctx->argv[i], '=')) {
1475 vsctl_fatal("add-bond requires at least 2 interfaces, but only "
1476 "%d were specified", n_ifaces);
1479 add_port(ctx, ctx->argv[1], ctx->argv[2], may_exist, fake_iface,
1480 &ctx->argv[3], n_ifaces,
1481 &ctx->argv[n_ifaces + 3], ctx->argc - 3 - n_ifaces);
1485 cmd_del_port(struct vsctl_context *ctx)
1487 bool must_exist = !shash_find(&ctx->options, "--if-exists");
1488 bool with_iface = shash_find(&ctx->options, "--with-iface") != NULL;
1489 struct vsctl_port *port;
1490 struct vsctl_info info;
1492 get_info(ctx, &info);
1494 port = find_port(&info, ctx->argv[ctx->argc - 1], must_exist);
1496 const char *target = ctx->argv[ctx->argc - 1];
1497 struct vsctl_iface *iface;
1499 port = find_port(&info, target, false);
1501 iface = find_iface(&info, target, false);
1506 if (must_exist && !port) {
1507 vsctl_fatal("no port or interface named %s", target);
1512 if (ctx->argc == 3) {
1513 struct vsctl_bridge *bridge;
1515 bridge = find_bridge(&info, ctx->argv[1], true);
1516 if (port->bridge != bridge) {
1517 if (port->bridge->parent == bridge) {
1518 vsctl_fatal("bridge %s does not have a port %s (although "
1519 "its parent bridge %s does)",
1520 ctx->argv[1], ctx->argv[2],
1521 bridge->parent->name);
1523 vsctl_fatal("bridge %s does not have a port %s",
1524 ctx->argv[1], ctx->argv[2]);
1529 del_port(&info, port);
1536 cmd_port_to_br(struct vsctl_context *ctx)
1538 struct vsctl_port *port;
1539 struct vsctl_info info;
1541 get_info(ctx, &info);
1542 port = find_port(&info, ctx->argv[1], true);
1543 ds_put_format(&ctx->output, "%s\n", port->bridge->name);
1548 cmd_br_to_vlan(struct vsctl_context *ctx)
1550 struct vsctl_bridge *bridge;
1551 struct vsctl_info info;
1553 get_info(ctx, &info);
1554 bridge = find_bridge(&info, ctx->argv[1], true);
1555 ds_put_format(&ctx->output, "%d\n", bridge->vlan);
1560 cmd_br_to_parent(struct vsctl_context *ctx)
1562 struct vsctl_bridge *bridge;
1563 struct vsctl_info info;
1565 get_info(ctx, &info);
1566 bridge = find_bridge(&info, ctx->argv[1], true);
1567 if (bridge->parent) {
1568 bridge = bridge->parent;
1570 ds_put_format(&ctx->output, "%s\n", bridge->name);
1575 cmd_list_ifaces(struct vsctl_context *ctx)
1577 struct vsctl_bridge *br;
1578 struct shash_node *node;
1579 struct vsctl_info info;
1582 get_info(ctx, &info);
1583 br = find_bridge(&info, ctx->argv[1], true);
1587 SHASH_FOR_EACH (node, &info.ifaces) {
1588 struct vsctl_iface *iface = node->data;
1590 if (strcmp(iface->iface_cfg->name, br->name)
1591 && br == iface->port->bridge) {
1592 svec_add(&ifaces, iface->iface_cfg->name);
1595 output_sorted(&ifaces, &ctx->output);
1596 svec_destroy(&ifaces);
1602 cmd_iface_to_br(struct vsctl_context *ctx)
1604 struct vsctl_iface *iface;
1605 struct vsctl_info info;
1607 get_info(ctx, &info);
1608 iface = find_iface(&info, ctx->argv[1], true);
1609 ds_put_format(&ctx->output, "%s\n", iface->port->bridge->name);
1614 verify_controllers(struct ovsrec_bridge *bridge)
1619 ovsrec_bridge_verify_controller(bridge);
1620 for (i = 0; i < bridge->n_controller; i++) {
1621 ovsrec_controller_verify_target(bridge->controller[i]);
1627 cmd_get_controller(struct vsctl_context *ctx)
1629 struct vsctl_info info;
1630 struct vsctl_bridge *br;
1631 struct svec targets;
1634 get_info(ctx, &info);
1635 br = find_bridge(&info, ctx->argv[1], true);
1636 verify_controllers(br->br_cfg);
1638 /* Print the targets in sorted order for reproducibility. */
1639 svec_init(&targets);
1640 for (i = 0; i < br->n_ctrl; i++) {
1641 svec_add(&targets, br->ctrl[i]->target);
1644 svec_sort(&targets);
1645 for (i = 0; i < targets.n; i++) {
1646 ds_put_format(&ctx->output, "%s\n", targets.names[i]);
1648 svec_destroy(&targets);
1654 delete_controllers(struct ovsrec_controller **controllers,
1655 size_t n_controllers)
1659 for (i = 0; i < n_controllers; i++) {
1660 ovsrec_controller_delete(controllers[i]);
1665 cmd_del_controller(struct vsctl_context *ctx)
1667 struct vsctl_info info;
1668 struct vsctl_bridge *br;
1670 get_info(ctx, &info);
1671 br = find_real_bridge(&info, ctx->argv[1], true);
1672 verify_controllers(br->br_cfg);
1675 delete_controllers(br->ctrl, br->n_ctrl);
1676 ovsrec_bridge_set_controller(br->br_cfg, NULL, 0);
1682 static struct ovsrec_controller **
1683 insert_controllers(struct ovsdb_idl_txn *txn, char *targets[], size_t n)
1685 struct ovsrec_controller **controllers;
1688 controllers = xmalloc(n * sizeof *controllers);
1689 for (i = 0; i < n; i++) {
1690 controllers[i] = ovsrec_controller_insert(txn);
1691 ovsrec_controller_set_target(controllers[i], targets[i]);
1698 cmd_set_controller(struct vsctl_context *ctx)
1700 struct vsctl_info info;
1701 struct vsctl_bridge *br;
1702 struct ovsrec_controller **controllers;
1705 get_info(ctx, &info);
1706 br = find_real_bridge(&info, ctx->argv[1], true);
1707 verify_controllers(br->br_cfg);
1709 delete_controllers(br->ctrl, br->n_ctrl);
1712 controllers = insert_controllers(ctx->txn, &ctx->argv[2], n);
1713 ovsrec_bridge_set_controller(br->br_cfg, controllers, n);
1720 cmd_get_fail_mode(struct vsctl_context *ctx)
1722 struct vsctl_info info;
1723 struct vsctl_bridge *br;
1725 get_info(ctx, &info);
1726 br = find_bridge(&info, ctx->argv[1], true);
1729 ovsrec_bridge_verify_fail_mode(br->br_cfg);
1731 if (br->fail_mode && strlen(br->fail_mode)) {
1732 ds_put_format(&ctx->output, "%s\n", br->fail_mode);
1739 cmd_del_fail_mode(struct vsctl_context *ctx)
1741 struct vsctl_info info;
1742 struct vsctl_bridge *br;
1744 get_info(ctx, &info);
1745 br = find_real_bridge(&info, ctx->argv[1], true);
1747 ovsrec_bridge_set_fail_mode(br->br_cfg, NULL);
1753 cmd_set_fail_mode(struct vsctl_context *ctx)
1755 struct vsctl_info info;
1756 struct vsctl_bridge *br;
1757 const char *fail_mode = ctx->argv[2];
1759 get_info(ctx, &info);
1760 br = find_real_bridge(&info, ctx->argv[1], true);
1762 if (strcmp(fail_mode, "standalone") && strcmp(fail_mode, "secure")) {
1763 vsctl_fatal("fail-mode must be \"standalone\" or \"secure\"");
1766 ovsrec_bridge_set_fail_mode(br->br_cfg, fail_mode);
1772 cmd_get_ssl(struct vsctl_context *ctx)
1774 struct ovsrec_ssl *ssl = ctx->ovs->ssl;
1776 ovsrec_open_vswitch_verify_ssl(ctx->ovs);
1778 ovsrec_ssl_verify_private_key(ssl);
1779 ovsrec_ssl_verify_certificate(ssl);
1780 ovsrec_ssl_verify_ca_cert(ssl);
1781 ovsrec_ssl_verify_bootstrap_ca_cert(ssl);
1783 ds_put_format(&ctx->output, "Private key: %s\n", ssl->private_key);
1784 ds_put_format(&ctx->output, "Certificate: %s\n", ssl->certificate);
1785 ds_put_format(&ctx->output, "CA Certificate: %s\n", ssl->ca_cert);
1786 ds_put_format(&ctx->output, "Bootstrap: %s\n",
1787 ssl->bootstrap_ca_cert ? "true" : "false");
1792 cmd_del_ssl(struct vsctl_context *ctx)
1794 struct ovsrec_ssl *ssl = ctx->ovs->ssl;
1797 ovsrec_open_vswitch_verify_ssl(ctx->ovs);
1798 ovsrec_ssl_delete(ssl);
1799 ovsrec_open_vswitch_set_ssl(ctx->ovs, NULL);
1804 cmd_set_ssl(struct vsctl_context *ctx)
1806 bool bootstrap = shash_find(&ctx->options, "--bootstrap");
1807 struct ovsrec_ssl *ssl = ctx->ovs->ssl;
1809 ovsrec_open_vswitch_verify_ssl(ctx->ovs);
1811 ovsrec_ssl_delete(ssl);
1813 ssl = ovsrec_ssl_insert(ctx->txn);
1815 ovsrec_ssl_set_private_key(ssl, ctx->argv[1]);
1816 ovsrec_ssl_set_certificate(ssl, ctx->argv[2]);
1817 ovsrec_ssl_set_ca_cert(ssl, ctx->argv[3]);
1819 ovsrec_ssl_set_bootstrap_ca_cert(ssl, bootstrap);
1821 ovsrec_open_vswitch_set_ssl(ctx->ovs, ssl);
1824 /* Parameter commands. */
1826 struct vsctl_row_id {
1827 const struct ovsdb_idl_table_class *table;
1828 const struct ovsdb_idl_column *name_column;
1829 const struct ovsdb_idl_column *uuid_column;
1832 struct vsctl_table_class {
1833 struct ovsdb_idl_table_class *class;
1834 struct vsctl_row_id row_ids[2];
1837 static const struct vsctl_table_class tables[] = {
1838 {&ovsrec_table_bridge,
1839 {{&ovsrec_table_bridge, &ovsrec_bridge_col_name, NULL},
1840 {NULL, NULL, NULL}}},
1842 {&ovsrec_table_controller,
1843 {{&ovsrec_table_bridge,
1844 &ovsrec_bridge_col_name,
1845 &ovsrec_bridge_col_controller}}},
1847 {&ovsrec_table_interface,
1848 {{&ovsrec_table_interface, &ovsrec_interface_col_name, NULL},
1849 {NULL, NULL, NULL}}},
1851 {&ovsrec_table_mirror,
1852 {{&ovsrec_table_mirror, &ovsrec_mirror_col_name, NULL},
1853 {NULL, NULL, NULL}}},
1855 {&ovsrec_table_netflow,
1856 {{&ovsrec_table_bridge,
1857 &ovsrec_bridge_col_name,
1858 &ovsrec_bridge_col_netflow},
1859 {NULL, NULL, NULL}}},
1861 {&ovsrec_table_open_vswitch,
1862 {{&ovsrec_table_open_vswitch, NULL, NULL},
1863 {NULL, NULL, NULL}}},
1865 {&ovsrec_table_port,
1866 {{&ovsrec_table_port, &ovsrec_port_col_name, NULL},
1867 {NULL, NULL, NULL}}},
1870 {{&ovsrec_table_port, &ovsrec_port_col_name, &ovsrec_port_col_qos},
1871 {NULL, NULL, NULL}}},
1873 {&ovsrec_table_queue,
1874 {{NULL, NULL, NULL},
1875 {NULL, NULL, NULL}}},
1878 {{&ovsrec_table_open_vswitch, NULL, &ovsrec_open_vswitch_col_ssl}}},
1880 {&ovsrec_table_sflow,
1881 {{&ovsrec_table_bridge,
1882 &ovsrec_bridge_col_name,
1883 &ovsrec_bridge_col_sflow},
1884 {NULL, NULL, NULL}}},
1886 {NULL, {{NULL, NULL, NULL}, {NULL, NULL, NULL}}}
1890 die_if_error(char *error)
1893 vsctl_fatal("%s", error);
1898 to_lower_and_underscores(unsigned c)
1900 return c == '-' ? '_' : tolower(c);
1904 score_partial_match(const char *name, const char *s)
1908 if (!strcmp(name, s)) {
1911 for (score = 0; ; score++, name++, s++) {
1912 if (to_lower_and_underscores(*name) != to_lower_and_underscores(*s)) {
1914 } else if (*name == '\0') {
1915 return UINT_MAX - 1;
1918 return *s == '\0' ? score : 0;
1921 static const struct vsctl_table_class *
1922 get_table(const char *table_name)
1924 const struct vsctl_table_class *table;
1925 const struct vsctl_table_class *best_match = NULL;
1926 unsigned int best_score = 0;
1928 for (table = tables; table->class; table++) {
1929 unsigned int score = score_partial_match(table->class->name,
1931 if (score > best_score) {
1934 } else if (score == best_score) {
1940 } else if (best_score) {
1941 vsctl_fatal("multiple table names match \"%s\"", table_name);
1943 vsctl_fatal("unknown table \"%s\"", table_name);
1947 static const struct ovsdb_idl_row *
1948 get_row_by_id(struct vsctl_context *ctx, const struct vsctl_table_class *table,
1949 const struct vsctl_row_id *id, const char *record_id)
1951 const struct ovsdb_idl_row *referrer, *final;
1957 if (!id->name_column) {
1958 if (strcmp(record_id, ".")) {
1961 referrer = ovsdb_idl_first_row(ctx->idl, id->table);
1962 if (!referrer || ovsdb_idl_next_row(referrer)) {
1966 const struct ovsdb_idl_row *row;
1969 for (row = ovsdb_idl_first_row(ctx->idl, id->table);
1971 row = ovsdb_idl_next_row(row))
1973 const struct ovsdb_datum *name;
1975 name = ovsdb_idl_get(row, id->name_column,
1976 OVSDB_TYPE_STRING, OVSDB_TYPE_VOID);
1977 if (name->n == 1 && !strcmp(name->keys[0].string, record_id)) {
1979 vsctl_fatal("multiple rows in %s match \"%s\"",
1980 table->class->name, record_id);
1991 if (id->uuid_column) {
1992 const struct ovsdb_datum *uuid;
1994 ovsdb_idl_txn_verify(referrer, id->uuid_column);
1995 uuid = ovsdb_idl_get(referrer, id->uuid_column,
1996 OVSDB_TYPE_UUID, OVSDB_TYPE_VOID);
1998 final = ovsdb_idl_get_row_for_uuid(ctx->idl, table->class,
1999 &uuid->keys[0].uuid);
2008 static const struct ovsdb_idl_row *
2009 get_row (struct vsctl_context *ctx,
2010 const struct vsctl_table_class *table, const char *record_id)
2012 const struct ovsdb_idl_row *row;
2015 if (uuid_from_string(&uuid, record_id)) {
2016 row = ovsdb_idl_get_row_for_uuid(ctx->idl, table->class, &uuid);
2020 for (i = 0; i < ARRAY_SIZE(table->row_ids); i++) {
2021 row = get_row_by_id(ctx, table, &table->row_ids[i], record_id);
2030 static const struct ovsdb_idl_row *
2031 must_get_row(struct vsctl_context *ctx,
2032 const struct vsctl_table_class *table, const char *record_id)
2034 const struct ovsdb_idl_row *row = get_row(ctx, table, record_id);
2036 vsctl_fatal("no row \"%s\" in table %s",
2037 record_id, table->class->name);
2043 get_column(const struct vsctl_table_class *table, const char *column_name,
2044 const struct ovsdb_idl_column **columnp)
2046 const struct ovsdb_idl_column *best_match = NULL;
2047 unsigned int best_score = 0;
2050 for (i = 0; i < table->class->n_columns; i++) {
2051 const struct ovsdb_idl_column *column = &table->class->columns[i];
2052 unsigned int score = score_partial_match(column->name, column_name);
2053 if (score > best_score) {
2054 best_match = column;
2056 } else if (score == best_score) {
2061 *columnp = best_match;
2064 } else if (best_score) {
2065 return xasprintf("%s contains more than one column whose name "
2066 "matches \"%s\"", table->class->name, column_name);
2068 return xasprintf("%s does not contain a column whose name matches "
2069 "\"%s\"", table->class->name, column_name);
2073 static struct uuid *
2074 create_symbol(struct ovsdb_symbol_table *symtab, const char *id, bool *newp)
2076 struct ovsdb_symbol *symbol;
2079 vsctl_fatal("row id \"%s\" does not begin with \"@\"", id);
2083 *newp = ovsdb_symbol_table_get(symtab, id) == NULL;
2086 symbol = ovsdb_symbol_table_insert(symtab, id);
2088 vsctl_fatal("row id \"%s\" may only be specified on one --id option",
2091 symbol->used = true;
2092 return &symbol->uuid;
2096 missing_operator_error(const char *arg, const char **allowed_operators,
2102 ds_put_format(&s, "%s: argument does not end in ", arg);
2103 ds_put_format(&s, "\"%s\"", allowed_operators[0]);
2104 if (n_allowed == 2) {
2105 ds_put_format(&s, " or \"%s\"", allowed_operators[1]);
2106 } else if (n_allowed > 2) {
2109 for (i = 1; i < n_allowed - 1; i++) {
2110 ds_put_format(&s, ", \"%s\"", allowed_operators[i]);
2112 ds_put_format(&s, ", or \"%s\"", allowed_operators[i]);
2114 ds_put_format(&s, " followed by a value.");
2116 return ds_steal_cstr(&s);
2119 /* Breaks 'arg' apart into a number of fields in the following order:
2121 * - If 'columnp' is nonnull, the name of a column in 'table'. The column
2122 * is stored into '*columnp'. The column name may be abbreviated.
2124 * - If 'keyp' is nonnull, optionally a key string. (If both 'columnp'
2125 * and 'keyp' are nonnull, then the column and key names are expected to
2126 * be separated by ':'). The key is stored as a malloc()'d string into
2127 * '*keyp', or NULL if no key is present in 'arg'.
2129 * - If 'valuep' is nonnull, an operator followed by a value string. The
2130 * allowed operators are the 'n_allowed' string in 'allowed_operators',
2131 * or just "=" if 'n_allowed' is 0. If 'operatorp' is nonnull, then the
2132 * operator is stored into '*operatorp' (one of the pointers from
2133 * 'allowed_operators' is stored; nothing is malloc()'d). The value is
2134 * stored as a malloc()'d string into '*valuep', or NULL if no value is
2137 * At least 'columnp' or 'keyp' must be nonnull.
2139 * On success, returns NULL. On failure, returned a malloc()'d string error
2140 * message and stores NULL into all of the nonnull output arguments. */
2141 static char * WARN_UNUSED_RESULT
2142 parse_column_key_value(const char *arg,
2143 const struct vsctl_table_class *table,
2144 const struct ovsdb_idl_column **columnp, char **keyp,
2145 const char **operatorp,
2146 const char **allowed_operators, size_t n_allowed,
2149 const char *p = arg;
2152 assert(columnp || keyp);
2153 assert(!(operatorp && !valuep));
2161 /* Parse column name. */
2165 error = ovsdb_token_parse(&p, &column_name);
2169 if (column_name[0] == '\0') {
2171 error = xasprintf("%s: missing column name", arg);
2174 error = get_column(table, column_name, columnp);
2181 /* Parse key string. */
2182 if (*p == ':' || !columnp) {
2186 error = xasprintf("%s: key not accepted here", arg);
2189 error = ovsdb_token_parse(&p, keyp);
2197 /* Parse value string. */
2203 if (!allowed_operators) {
2204 static const char *equals = "=";
2205 allowed_operators = =
2211 for (i = 0; i < n_allowed; i++) {
2212 const char *op = allowed_operators[i];
2213 size_t op_len = strlen(op);
2215 if (op_len > best_len && !strncmp(op, p, op_len) && p[op_len]) {
2221 error = missing_operator_error(arg, allowed_operators, n_allowed);
2228 *valuep = xstrdup(p + best_len);
2234 error = xasprintf("%s: trailing garbage \"%s\" in argument",
2260 cmd_get(struct vsctl_context *ctx)
2262 const char *id = shash_find_data(&ctx->options, "--id");
2263 bool if_exists = shash_find(&ctx->options, "--if-exists");
2264 const char *table_name = ctx->argv[1];
2265 const char *record_id = ctx->argv[2];
2266 const struct vsctl_table_class *table;
2267 const struct ovsdb_idl_row *row;
2268 struct ds *out = &ctx->output;
2271 table = get_table(table_name);
2272 row = must_get_row(ctx, table, record_id);
2276 *create_symbol(ctx->symtab, id, &new) = row->uuid;
2278 vsctl_fatal("row id \"%s\" specified on \"get\" command was used "
2279 "before it was defined", id);
2282 for (i = 3; i < ctx->argc; i++) {
2283 const struct ovsdb_idl_column *column;
2284 const struct ovsdb_datum *datum;
2287 /* Special case for obtaining the UUID of a row. We can't just do this
2288 * through parse_column_key_value() below since it returns a "struct
2289 * ovsdb_idl_column" and the UUID column doesn't have one. */
2290 if (!strcasecmp(ctx->argv[i], "_uuid")
2291 || !strcasecmp(ctx->argv[i], "-uuid")) {
2292 ds_put_format(out, UUID_FMT"\n", UUID_ARGS(&row->uuid));
2296 die_if_error(parse_column_key_value(ctx->argv[i], table,
2297 &column, &key_string,
2298 NULL, NULL, 0, NULL));
2300 ovsdb_idl_txn_verify(row, column);
2301 datum = ovsdb_idl_read(row, column);
2303 union ovsdb_atom key;
2306 if (column->type.value.type == OVSDB_TYPE_VOID) {
2307 vsctl_fatal("cannot specify key to get for non-map column %s",
2311 die_if_error(ovsdb_atom_from_string(&key,
2313 key_string, ctx->symtab));
2315 idx = ovsdb_datum_find_key(datum, &key,
2316 column->type.key.type);
2317 if (idx == UINT_MAX) {
2319 vsctl_fatal("no key \"%s\" in %s record \"%s\" column %s",
2320 key_string, table->class->name, record_id,
2324 ovsdb_atom_to_string(&datum->values[idx],
2325 column->type.value.type, out);
2327 ovsdb_atom_destroy(&key, column->type.key.type);
2329 ovsdb_datum_to_string(datum, &column->type, out);
2331 ds_put_char(out, '\n');
2338 list_record(const struct vsctl_table_class *table,
2339 const struct ovsdb_idl_row *row, struct ds *out)
2343 ds_put_format(out, "%-20s: "UUID_FMT"\n", "_uuid",
2344 UUID_ARGS(&row->uuid));
2345 for (i = 0; i < table->class->n_columns; i++) {
2346 const struct ovsdb_idl_column *column = &table->class->columns[i];
2347 const struct ovsdb_datum *datum;
2349 datum = ovsdb_idl_read(row, column);
2351 ds_put_format(out, "%-20s: ", column->name);
2352 ovsdb_datum_to_string(datum, &column->type, out);
2353 ds_put_char(out, '\n');
2358 cmd_list(struct vsctl_context *ctx)
2360 const char *table_name = ctx->argv[1];
2361 const struct vsctl_table_class *table;
2362 struct ds *out = &ctx->output;
2365 table = get_table(table_name);
2366 if (ctx->argc > 2) {
2367 for (i = 2; i < ctx->argc; i++) {
2369 ds_put_char(out, '\n');
2371 list_record(table, must_get_row(ctx, table, ctx->argv[i]), out);
2374 const struct ovsdb_idl_row *row;
2377 for (row = ovsdb_idl_first_row(ctx->idl, table->class), first = true;
2379 row = ovsdb_idl_next_row(row), first = false) {
2381 ds_put_char(out, '\n');
2383 list_record(table, row, out);
2389 set_column(const struct vsctl_table_class *table,
2390 const struct ovsdb_idl_row *row, const char *arg,
2391 struct ovsdb_symbol_table *symtab)
2393 const struct ovsdb_idl_column *column;
2394 char *key_string, *value_string;
2397 error = parse_column_key_value(arg, table, &column, &key_string,
2398 NULL, NULL, 0, &value_string);
2399 die_if_error(error);
2400 if (!value_string) {
2401 vsctl_fatal("%s: missing value", arg);
2405 union ovsdb_atom key, value;
2406 struct ovsdb_datum datum;
2408 if (column->type.value.type == OVSDB_TYPE_VOID) {
2409 vsctl_fatal("cannot specify key to set for non-map column %s",
2413 die_if_error(ovsdb_atom_from_string(&key, &column->type.key,
2414 key_string, symtab));
2415 die_if_error(ovsdb_atom_from_string(&value, &column->type.value,
2416 value_string, symtab));
2418 ovsdb_datum_init_empty(&datum);
2419 ovsdb_datum_add_unsafe(&datum, &key, &value, &column->type);
2421 ovsdb_atom_destroy(&key, column->type.key.type);
2422 ovsdb_atom_destroy(&value, column->type.value.type);
2424 ovsdb_datum_union(&datum, ovsdb_idl_read(row, column),
2425 &column->type, false);
2426 ovsdb_idl_txn_write(row, column, &datum);
2428 struct ovsdb_datum datum;
2430 die_if_error(ovsdb_datum_from_string(&datum, &column->type,
2431 value_string, symtab));
2432 ovsdb_idl_txn_write(row, column, &datum);
2440 cmd_set(struct vsctl_context *ctx)
2442 const char *table_name = ctx->argv[1];
2443 const char *record_id = ctx->argv[2];
2444 const struct vsctl_table_class *table;
2445 const struct ovsdb_idl_row *row;
2448 table = get_table(table_name);
2449 row = must_get_row(ctx, table, record_id);
2450 for (i = 3; i < ctx->argc; i++) {
2451 set_column(table, row, ctx->argv[i], ctx->symtab);
2456 cmd_add(struct vsctl_context *ctx)
2458 const char *table_name = ctx->argv[1];
2459 const char *record_id = ctx->argv[2];
2460 const char *column_name = ctx->argv[3];
2461 const struct vsctl_table_class *table;
2462 const struct ovsdb_idl_column *column;
2463 const struct ovsdb_idl_row *row;
2464 const struct ovsdb_type *type;
2465 struct ovsdb_datum old;
2468 table = get_table(table_name);
2469 row = must_get_row(ctx, table, record_id);
2470 die_if_error(get_column(table, column_name, &column));
2472 type = &column->type;
2473 ovsdb_datum_clone(&old, ovsdb_idl_read(row, column), &column->type);
2474 for (i = 4; i < ctx->argc; i++) {
2475 struct ovsdb_type add_type;
2476 struct ovsdb_datum add;
2480 add_type.n_max = UINT_MAX;
2481 die_if_error(ovsdb_datum_from_string(&add, &add_type, ctx->argv[i],
2483 ovsdb_datum_union(&old, &add, type, false);
2484 ovsdb_datum_destroy(&add, type);
2486 if (old.n > type->n_max) {
2487 vsctl_fatal("\"add\" operation would put %u %s in column %s of "
2488 "table %s but the maximum number is %u",
2490 type->value.type == OVSDB_TYPE_VOID ? "values" : "pairs",
2491 column->name, table->class->name, type->n_max);
2493 ovsdb_idl_txn_verify(row, column);
2494 ovsdb_idl_txn_write(row, column, &old);
2498 cmd_remove(struct vsctl_context *ctx)
2500 const char *table_name = ctx->argv[1];
2501 const char *record_id = ctx->argv[2];
2502 const char *column_name = ctx->argv[3];
2503 const struct vsctl_table_class *table;
2504 const struct ovsdb_idl_column *column;
2505 const struct ovsdb_idl_row *row;
2506 const struct ovsdb_type *type;
2507 struct ovsdb_datum old;
2510 table = get_table(table_name);
2511 row = must_get_row(ctx, table, record_id);
2512 die_if_error(get_column(table, column_name, &column));
2514 type = &column->type;
2515 ovsdb_datum_clone(&old, ovsdb_idl_read(row, column), &column->type);
2516 for (i = 4; i < ctx->argc; i++) {
2517 struct ovsdb_type rm_type;
2518 struct ovsdb_datum rm;
2523 rm_type.n_max = UINT_MAX;
2524 error = ovsdb_datum_from_string(&rm, &rm_type,
2525 ctx->argv[i], ctx->symtab);
2526 if (error && ovsdb_type_is_map(&rm_type)) {
2528 rm_type.value.type = OVSDB_TYPE_VOID;
2529 die_if_error(ovsdb_datum_from_string(&rm, &rm_type,
2530 ctx->argv[i], ctx->symtab));
2532 ovsdb_datum_subtract(&old, type, &rm, &rm_type);
2533 ovsdb_datum_destroy(&rm, &rm_type);
2535 if (old.n < type->n_min) {
2536 vsctl_fatal("\"remove\" operation would put %u %s in column %s of "
2537 "table %s but the minimum number is %u",
2539 type->value.type == OVSDB_TYPE_VOID ? "values" : "pairs",
2540 column->name, table->class->name, type->n_min);
2542 ovsdb_idl_txn_verify(row, column);
2543 ovsdb_idl_txn_write(row, column, &old);
2547 cmd_clear(struct vsctl_context *ctx)
2549 const char *table_name = ctx->argv[1];
2550 const char *record_id = ctx->argv[2];
2551 const struct vsctl_table_class *table;
2552 const struct ovsdb_idl_row *row;
2555 table = get_table(table_name);
2556 row = must_get_row(ctx, table, record_id);
2557 for (i = 3; i < ctx->argc; i++) {
2558 const struct ovsdb_idl_column *column;
2559 const struct ovsdb_type *type;
2560 struct ovsdb_datum datum;
2562 die_if_error(get_column(table, ctx->argv[i], &column));
2564 type = &column->type;
2565 if (type->n_min > 0) {
2566 vsctl_fatal("\"clear\" operation cannot be applied to column %s "
2567 "of table %s, which is not allowed to be empty",
2568 column->name, table->class->name);
2571 ovsdb_datum_init_empty(&datum);
2572 ovsdb_idl_txn_write(row, column, &datum);
2577 cmd_create(struct vsctl_context *ctx)
2579 const char *id = shash_find_data(&ctx->options, "--id");
2580 const char *table_name = ctx->argv[1];
2581 const struct vsctl_table_class *table;
2582 const struct ovsdb_idl_row *row;
2583 const struct uuid *uuid;
2586 uuid = id ? create_symbol(ctx->symtab, id, NULL) : NULL;
2588 table = get_table(table_name);
2589 row = ovsdb_idl_txn_insert(ctx->txn, table->class, uuid);
2590 for (i = 2; i < ctx->argc; i++) {
2591 set_column(table, row, ctx->argv[i], ctx->symtab);
2593 ds_put_format(&ctx->output, UUID_FMT, UUID_ARGS(&row->uuid));
2596 /* This function may be used as the 'postprocess' function for commands that
2597 * insert new rows into the database. It expects that the command's 'run'
2598 * function prints the UUID reported by ovsdb_idl_txn_insert() as the command's
2599 * sole output. It replaces that output by the row's permanent UUID assigned
2600 * by the database server and appends a new-line.
2602 * Currently we use this only for "create", because the higher-level commands
2603 * are supposed to be independent of the actual structure of the vswitch
2606 post_create(struct vsctl_context *ctx)
2608 const struct uuid *real;
2611 uuid_from_string(&dummy, ds_cstr(&ctx->output));
2612 real = ovsdb_idl_txn_get_insert_uuid(ctx->txn, &dummy);
2614 ds_clear(&ctx->output);
2615 ds_put_format(&ctx->output, UUID_FMT, UUID_ARGS(real));
2617 ds_put_char(&ctx->output, '\n');
2621 cmd_destroy(struct vsctl_context *ctx)
2623 bool must_exist = !shash_find(&ctx->options, "--if-exists");
2624 const char *table_name = ctx->argv[1];
2625 const struct vsctl_table_class *table;
2628 table = get_table(table_name);
2629 for (i = 2; i < ctx->argc; i++) {
2630 const struct ovsdb_idl_row *row;
2632 row = (must_exist ? must_get_row : get_row)(ctx, table, ctx->argv[i]);
2634 ovsdb_idl_txn_delete(row);
2640 is_condition_satified(const struct vsctl_table_class *table,
2641 const struct ovsdb_idl_row *row, const char *arg,
2642 struct ovsdb_symbol_table *symtab)
2644 static const char *operators[] = {
2645 "=", "!=", "<", ">", "<=", ">="
2648 const struct ovsdb_idl_column *column;
2649 const struct ovsdb_datum *have_datum;
2650 char *key_string, *value_string;
2651 const char *operator;
2656 error = parse_column_key_value(arg, table, &column, &key_string,
2657 &operator, operators, ARRAY_SIZE(operators),
2659 die_if_error(error);
2660 if (!value_string) {
2661 vsctl_fatal("%s: missing value", arg);
2664 have_datum = ovsdb_idl_read(row, column);
2666 union ovsdb_atom want_key, want_value;
2668 if (column->type.value.type == OVSDB_TYPE_VOID) {
2669 vsctl_fatal("cannot specify key to check for non-map column %s",
2673 die_if_error(ovsdb_atom_from_string(&want_key, &column->type.key,
2674 key_string, symtab));
2675 die_if_error(ovsdb_atom_from_string(&want_value, &column->type.value,
2676 value_string, symtab));
2678 idx = ovsdb_datum_find_key(have_datum,
2679 &want_key, column->type.key.type);
2680 if (idx != UINT_MAX) {
2681 cmp = ovsdb_atom_compare_3way(&have_datum->values[idx],
2683 column->type.value.type);
2686 ovsdb_atom_destroy(&want_key, column->type.key.type);
2687 ovsdb_atom_destroy(&want_value, column->type.value.type);
2689 struct ovsdb_datum want_datum;
2691 die_if_error(ovsdb_datum_from_string(&want_datum, &column->type,
2692 value_string, symtab));
2694 cmp = ovsdb_datum_compare_3way(have_datum, &want_datum,
2696 ovsdb_datum_destroy(&want_datum, &column->type);
2702 return (idx == UINT_MAX ? false
2703 : !strcmp(operator, "=") ? cmp == 0
2704 : !strcmp(operator, "!=") ? cmp != 0
2705 : !strcmp(operator, "<") ? cmp < 0
2706 : !strcmp(operator, ">") ? cmp > 0
2707 : !strcmp(operator, "<=") ? cmp <= 0
2708 : !strcmp(operator, ">=") ? cmp >= 0
2713 cmd_wait_until(struct vsctl_context *ctx)
2715 const char *table_name = ctx->argv[1];
2716 const char *record_id = ctx->argv[2];
2717 const struct vsctl_table_class *table;
2718 const struct ovsdb_idl_row *row;
2721 table = get_table(table_name);
2723 row = get_row(ctx, table, record_id);
2725 ctx->try_again = true;
2729 for (i = 3; i < ctx->argc; i++) {
2730 if (!is_condition_satified(table, row, ctx->argv[i], ctx->symtab)) {
2731 ctx->try_again = true;
2737 static struct json *
2738 where_uuid_equals(const struct uuid *uuid)
2741 json_array_create_1(
2742 json_array_create_3(
2743 json_string_create("_uuid"),
2744 json_string_create("=="),
2745 json_array_create_2(
2746 json_string_create("uuid"),
2747 json_string_create_nocopy(
2748 xasprintf(UUID_FMT, UUID_ARGS(uuid))))));
2752 vsctl_context_init(struct vsctl_context *ctx, struct vsctl_command *command,
2753 struct ovsdb_idl *idl, struct ovsdb_idl_txn *txn,
2754 const struct ovsrec_open_vswitch *ovs,
2755 struct ovsdb_symbol_table *symtab)
2757 ctx->argc = command->argc;
2758 ctx->argv = command->argv;
2759 ctx->options = command->options;
2761 ds_swap(&ctx->output, &command->output);
2765 ctx->symtab = symtab;
2766 ctx->verified_ports = false;
2768 ctx->try_again = false;
2772 vsctl_context_done(struct vsctl_context *ctx, struct vsctl_command *command)
2774 ds_swap(&ctx->output, &command->output);
2778 do_vsctl(const char *args, struct vsctl_command *commands, size_t n_commands,
2779 struct ovsdb_idl *idl)
2781 struct ovsdb_idl_txn *txn;
2782 const struct ovsrec_open_vswitch *ovs;
2783 enum ovsdb_idl_txn_status status;
2784 struct ovsdb_symbol_table *symtab;
2786 struct vsctl_command *c;
2787 int64_t next_cfg = 0;
2790 txn = the_idl_txn = ovsdb_idl_txn_create(idl);
2792 ovsdb_idl_txn_set_dry_run(txn);
2795 ovsdb_idl_txn_add_comment(txn, "ovs-vsctl: %s", args);
2797 ovs = ovsrec_open_vswitch_first(idl);
2799 /* XXX add verification that table is empty */
2800 ovs = ovsrec_open_vswitch_insert(txn);
2803 if (wait_for_reload) {
2804 struct json *where = where_uuid_equals(&ovs->header_.uuid);
2805 ovsdb_idl_txn_increment(txn, "Open_vSwitch", "next_cfg", where);
2806 json_destroy(where);
2809 symtab = ovsdb_symbol_table_create();
2810 for (c = commands; c < &commands[n_commands]; c++) {
2811 ds_init(&c->output);
2813 for (c = commands; c < &commands[n_commands]; c++) {
2814 struct vsctl_context ctx;
2816 vsctl_context_init(&ctx, c, idl, txn, ovs, symtab);
2817 (c->syntax->run)(&ctx);
2818 vsctl_context_done(&ctx, c);
2820 if (ctx.try_again) {
2825 status = ovsdb_idl_txn_commit_block(txn);
2826 if (wait_for_reload && status == TXN_SUCCESS) {
2827 next_cfg = ovsdb_idl_txn_get_increment_new_value(txn);
2829 if (status == TXN_UNCHANGED || status == TXN_SUCCESS) {
2830 for (c = commands; c < &commands[n_commands]; c++) {
2831 if (c->syntax->postprocess) {
2832 struct vsctl_context ctx;
2834 vsctl_context_init(&ctx, c, idl, txn, ovs, symtab);
2835 (c->syntax->postprocess)(&ctx);
2836 vsctl_context_done(&ctx, c);
2840 error = xstrdup(ovsdb_idl_txn_get_error(txn));
2841 ovsdb_idl_txn_destroy(txn);
2842 txn = the_idl_txn = NULL;
2844 unused = ovsdb_symbol_table_find_unused(symtab);
2846 vsctl_fatal("row id \"%s\" is referenced but never created (e.g. "
2847 "with \"-- --id=%s create ...\")", unused, unused);
2851 case TXN_INCOMPLETE:
2855 /* Should not happen--we never call ovsdb_idl_txn_abort(). */
2856 vsctl_fatal("transaction aborted");
2866 vsctl_fatal("transaction error: %s", error);
2873 ovsdb_symbol_table_destroy(symtab);
2875 for (c = commands; c < &commands[n_commands]; c++) {
2876 struct ds *ds = &c->output;
2877 struct shash_node *node;
2883 for (j = 0; j < ds->length; j++) {
2884 int ch = ds->string[j];
2887 fputs("\\n", stdout);
2891 fputs("\\\\", stdout);
2900 fputs(ds_cstr(ds), stdout);
2902 ds_destroy(&c->output);
2904 SHASH_FOR_EACH (node, &c->options) {
2907 shash_destroy(&c->options);
2911 if (wait_for_reload && status != TXN_UNCHANGED) {
2914 OVSREC_OPEN_VSWITCH_FOR_EACH (ovs, idl) {
2915 if (ovs->cur_cfg >= next_cfg) {
2919 ovsdb_idl_wait(idl);
2924 ovsdb_idl_destroy(idl);
2929 /* Our transaction needs to be rerun, or a prerequisite was not met. Free
2930 * resources and return so that the caller can try again. */
2932 ovsdb_idl_txn_abort(txn);
2933 ovsdb_idl_txn_destroy(txn);
2935 ovsdb_symbol_table_destroy(symtab);
2936 for (c = commands; c < &commands[n_commands]; c++) {
2937 ds_destroy(&c->output);
2942 static const struct vsctl_command_syntax all_commands[] = {
2943 /* Open vSwitch commands. */
2944 {"init", 0, 0, cmd_init, NULL, "", RW},
2946 /* Bridge commands. */
2947 {"add-br", 1, 3, cmd_add_br, NULL, "--may-exist", RW},
2948 {"del-br", 1, 1, cmd_del_br, NULL, "--if-exists", RW},
2949 {"list-br", 0, 0, cmd_list_br, NULL, "", RO},
2950 {"br-exists", 1, 1, cmd_br_exists, NULL, "", RO},
2951 {"br-to-vlan", 1, 1, cmd_br_to_vlan, NULL, "", RO},
2952 {"br-to-parent", 1, 1, cmd_br_to_parent, NULL, "", RO},
2953 {"br-set-external-id", 2, 3, cmd_br_set_external_id, NULL, "", RW},
2954 {"br-get-external-id", 1, 2, cmd_br_get_external_id, NULL, "", RO},
2956 /* Port commands. */
2957 {"list-ports", 1, 1, cmd_list_ports, NULL, "", RO},
2958 {"add-port", 2, INT_MAX, cmd_add_port, NULL, "--may-exist", RW},
2959 {"add-bond", 4, INT_MAX, cmd_add_bond, NULL, "--may-exist,--fake-iface", RW},
2960 {"del-port", 1, 2, cmd_del_port, NULL, "--if-exists,--with-iface", RW},
2961 {"port-to-br", 1, 1, cmd_port_to_br, NULL, "", RO},
2963 /* Interface commands. */
2964 {"list-ifaces", 1, 1, cmd_list_ifaces, NULL, "", RO},
2965 {"iface-to-br", 1, 1, cmd_iface_to_br, NULL, "", RO},
2967 /* Controller commands. */
2968 {"get-controller", 1, 1, cmd_get_controller, NULL, "", RO},
2969 {"del-controller", 1, 1, cmd_del_controller, NULL, "", RW},
2970 {"set-controller", 1, INT_MAX, cmd_set_controller, NULL, "", RW},
2971 {"get-fail-mode", 1, 1, cmd_get_fail_mode, NULL, "", RO},
2972 {"del-fail-mode", 1, 1, cmd_del_fail_mode, NULL, "", RW},
2973 {"set-fail-mode", 2, 2, cmd_set_fail_mode, NULL, "", RW},
2976 {"get-ssl", 0, 0, cmd_get_ssl, NULL, "", RO},
2977 {"del-ssl", 0, 0, cmd_del_ssl, NULL, "", RW},
2978 {"set-ssl", 3, 3, cmd_set_ssl, NULL, "--bootstrap", RW},
2980 /* Switch commands. */
2981 {"emer-reset", 0, 0, cmd_emer_reset, NULL, "", RW},
2983 /* Parameter commands. */
2984 {"get", 2, INT_MAX, cmd_get, NULL, "--if-exists,--id=", RO},
2985 {"list", 1, INT_MAX, cmd_list, NULL, "", RO},
2986 {"set", 3, INT_MAX, cmd_set, NULL, "", RW},
2987 {"add", 4, INT_MAX, cmd_add, NULL, "", RW},
2988 {"remove", 4, INT_MAX, cmd_remove, NULL, "", RW},
2989 {"clear", 3, INT_MAX, cmd_clear, NULL, "", RW},
2990 {"create", 2, INT_MAX, cmd_create, post_create, "--id=", RW},
2991 {"destroy", 1, INT_MAX, cmd_destroy, NULL, "--if-exists", RW},
2992 {"wait-until", 2, INT_MAX, cmd_wait_until, NULL, "", RO},
2994 {NULL, 0, 0, NULL, NULL, NULL, RO},