X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=utilities%2Fovs-vsctl.c;h=f8863bfc1238990838b39cc58a5622e6829e79a6;hb=a3326252a1ebee8c7f565fe60307b6a2af0ac073;hp=2868c354c2ee6aa87b5b5670a5938fe304a91f4b;hpb=975ac5313396fbafe829b862335d90967b4d74f3;p=openvswitch diff --git a/utilities/ovs-vsctl.c b/utilities/ovs-vsctl.c index 2868c354..f8863bfc 100644 --- a/utilities/ovs-vsctl.c +++ b/utilities/ovs-vsctl.c @@ -1,5 +1,5 @@ /* - * Copyright (c) 2009 Nicira Networks. + * Copyright (c) 2009, 2010 Nicira Networks. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -17,9 +17,12 @@ #include #include +#include #include +#include #include #include +#include #include #include #include @@ -30,8 +33,10 @@ #include "dirs.h" #include "dynamic-string.h" #include "json.h" +#include "ovsdb-data.h" #include "ovsdb-idl.h" #include "poll-loop.h" +#include "process.h" #include "svec.h" #include "vswitchd/vswitch-idl.h" #include "timeval.h" @@ -40,6 +45,33 @@ #include "vlog.h" #define THIS_MODULE VLM_vsctl +/* vsctl_fatal() also logs the error, so it is preferred in this file. */ +#define ovs_fatal please_use_vsctl_fatal_instead_of_ovs_fatal + +struct vsctl_context; + +typedef void vsctl_handler_func(struct vsctl_context *); + +struct vsctl_command_syntax { + const char *name; + int min_args; + int max_args; + vsctl_handler_func *run; + vsctl_handler_func *postprocess; + const char *options; +}; + +struct vsctl_command { + /* Data that remains constant after initialization. */ + const struct vsctl_command_syntax *syntax; + int argc; + char **argv; + struct shash options; + + /* Data modified by commands. */ + struct ds output; +}; + /* --db: The database server to contact. */ static const char *db; @@ -55,23 +87,37 @@ static bool wait_for_reload = true; /* --timeout: Time to wait for a connection to 'db'. */ static int timeout = 5; +/* All supported commands. */ +static const struct vsctl_command_syntax all_commands[]; + +/* The IDL we're using and the current transaction, if any. + * This is for use by vsctl_exit() only, to allow it to clean up. + * Other code should use its context arguments. */ +static struct ovsdb_idl *the_idl; +static struct ovsdb_idl_txn *the_idl_txn; + +static void vsctl_exit(int status) NO_RETURN; static void vsctl_fatal(const char *, ...) PRINTF_FORMAT(1, 2) NO_RETURN; static char *default_db(void); static void usage(void) NO_RETURN; static void parse_options(int argc, char *argv[]); -static void check_vsctl_command(int argc, char *argv[]); -static void do_vsctl(int argc, char *argv[], struct ovsdb_idl *idl); +static struct vsctl_command *parse_commands(int argc, char *argv[], + size_t *n_commandsp); +static void parse_command(int argc, char *argv[], struct vsctl_command *); +static void do_vsctl(const char *args, + struct vsctl_command *, size_t n_commands, + struct ovsdb_idl *); int main(int argc, char *argv[]) { struct ovsdb_idl *idl; unsigned int seqno; - struct ds args; - int start, n_commands; + struct vsctl_command *commands; + size_t n_commands; + char *args; int trials; - int i; set_program_name(argv[0]); signal(SIGPIPE, SIG_IGN); @@ -79,37 +125,23 @@ main(int argc, char *argv[]) vlog_init(); vlog_set_levels(VLM_ANY_MODULE, VLF_CONSOLE, VLL_WARN); vlog_set_levels(VLM_reconnect, VLF_ANY_FACILITY, VLL_WARN); + + /* Log our arguments. This is often valuable for debugging systems. */ + args = process_escape_args(argv); + VLOG_INFO("Called as %s", args); + + /* Parse command line. */ parse_options(argc, argv); + commands = parse_commands(argc - optind, argv + optind, &n_commands); if (timeout) { time_alarm(timeout); } - /* Log our arguments. This is often valuable for debugging systems. */ - ds_init(&args); - for (i = 1; i < argc; i++) { - ds_put_format(&args, " %s", argv[i]); - } - VLOG_INFO("Called as%s", ds_cstr(&args)); - ds_destroy(&args); - /* Do basic command syntax checking. */ - n_commands = 0; - for (start = i = optind; i <= argc; i++) { - if (i == argc || !strcmp(argv[i], "--")) { - if (i > start) { - check_vsctl_command(i - start, &argv[start]); - n_commands++; - } - start = i + 1; - } - } - if (!n_commands) { - vsctl_fatal("missing command name (use --help for help)"); - } /* Now execute the commands. */ - idl = ovsdb_idl_create(db, &ovsrec_idl_class); + idl = the_idl = ovsdb_idl_create(db, &ovsrec_idl_class); seqno = ovsdb_idl_get_seqno(idl); trials = 0; for (;;) { @@ -121,7 +153,7 @@ main(int argc, char *argv[]) if (++trials > 5) { vsctl_fatal("too many database inconsistency failures"); } - do_vsctl(argc - optind, argv + optind, idl); + do_vsctl(args, commands, n_commands, idl); seqno = new_seqno; } @@ -130,21 +162,6 @@ main(int argc, char *argv[]) } } -static void -vsctl_fatal(const char *format, ...) -{ - char *message; - va_list args; - - va_start(args, format); - message = xvasprintf(format, args); - va_end(args); - - vlog_set_levels(VLM_vsctl, VLF_CONSOLE, VLL_EMER); - VLOG_ERR("%s", message); - ovs_fatal(0, "%s", message); -} - static void parse_options(int argc, char *argv[]) { @@ -153,7 +170,8 @@ parse_options(int argc, char *argv[]) OPT_ONELINE, OPT_NO_SYSLOG, OPT_NO_WAIT, - OPT_DRY_RUN + OPT_DRY_RUN, + VLOG_OPTION_ENUMS }; static struct option long_options[] = { {"db", required_argument, 0, OPT_DB}, @@ -162,15 +180,14 @@ parse_options(int argc, char *argv[]) {"dry-run", no_argument, 0, OPT_DRY_RUN}, {"oneline", no_argument, 0, OPT_ONELINE}, {"timeout", required_argument, 0, 't'}, - {"verbose", optional_argument, 0, 'v'}, {"help", no_argument, 0, 'h'}, {"version", no_argument, 0, 'V'}, + VLOG_LONG_OPTIONS, {0, 0, 0, 0}, }; for (;;) { - unsigned long int timeout; int c; c = getopt_long(argc, argv, "+v::hVt:", long_options, NULL); @@ -209,14 +226,12 @@ parse_options(int argc, char *argv[]) case 't': timeout = strtoul(optarg, NULL, 10); if (timeout < 0) { - ovs_fatal(0, "value %s on -t or --timeout is invalid", - optarg); + vsctl_fatal("value %s on -t or --timeout is invalid", + optarg); } break; - case 'v': - vlog_set_verbosity(optarg); - break; + VLOG_OPTION_HANDLERS case '?': exit(EXIT_FAILURE); @@ -231,99 +246,192 @@ parse_options(int argc, char *argv[]) } } +static struct vsctl_command * +parse_commands(int argc, char *argv[], size_t *n_commandsp) +{ + struct vsctl_command *commands; + size_t n_commands, allocated_commands; + int i, start; + + commands = NULL; + n_commands = allocated_commands = 0; + + for (start = i = 0; i <= argc; i++) { + if (i == argc || !strcmp(argv[i], "--")) { + if (i > start) { + if (n_commands >= allocated_commands) { + struct vsctl_command *c; + + commands = x2nrealloc(commands, &allocated_commands, + sizeof *commands); + for (c = commands; c < &commands[n_commands]; c++) { + shash_moved(&c->options); + } + } + parse_command(i - start, &argv[start], + &commands[n_commands++]); + } + start = i + 1; + } + } + if (!n_commands) { + vsctl_fatal("missing command name (use --help for help)"); + } + *n_commandsp = n_commands; + return commands; +} + +static void +parse_command(int argc, char *argv[], struct vsctl_command *command) +{ + const struct vsctl_command_syntax *p; + int i; + + shash_init(&command->options); + for (i = 0; i < argc; i++) { + if (argv[i][0] != '-') { + break; + } + if (!shash_add_once(&command->options, argv[i], NULL)) { + vsctl_fatal("'%s' option specified multiple times", argv[i]); + } + } + if (i == argc) { + vsctl_fatal("missing command name"); + } + + for (p = all_commands; p->name; p++) { + if (!strcmp(p->name, argv[i])) { + struct shash_node *node; + int n_arg; + + SHASH_FOR_EACH (node, &command->options) { + const char *s = strstr(p->options, node->name); + int end = s ? s[strlen(node->name)] : EOF; + if (end != ',' && end != ' ' && end != '\0') { + vsctl_fatal("'%s' command has no '%s' option", + argv[i], node->name); + } + } + + n_arg = argc - i - 1; + if (n_arg < p->min_args) { + vsctl_fatal("'%s' command requires at least %d arguments", + p->name, p->min_args); + } else if (n_arg > p->max_args) { + vsctl_fatal("'%s' command takes at most %d arguments", + p->name, p->max_args); + } else { + command->syntax = p; + command->argc = n_arg + 1; + command->argv = &argv[i]; + return; + } + } + } + + vsctl_fatal("unknown command '%s'; use --help for help", argv[i]); +} + +static void +vsctl_fatal(const char *format, ...) +{ + char *message; + va_list args; + + va_start(args, format); + message = xvasprintf(format, args); + va_end(args); + + vlog_set_levels(VLM_vsctl, VLF_CONSOLE, VLL_EMER); + VLOG_ERR("%s", message); + ovs_error(0, "%s", message); + vsctl_exit(EXIT_FAILURE); +} + +/* Frees the current transaction and the underlying IDL and then calls + * exit(status). + * + * Freeing the transaction and the IDL is not strictly necessary, but it makes + * for a clean memory leak report from valgrind in the normal case. That makes + * it easier to notice real memory leaks. */ +static void +vsctl_exit(int status) +{ + if (the_idl_txn) { + ovsdb_idl_txn_abort(the_idl_txn); + ovsdb_idl_txn_destroy(the_idl_txn); + } + ovsdb_idl_destroy(the_idl); + exit(status); +} + static void usage(void) { - printf("%s: ovs-vswitchd management utility\n" - "usage: %s [OPTIONS] COMMAND [ARG...]\n", - program_name, program_name); - printf("\nBridge commands:\n" - " add-br BRIDGE " - "create a new bridge named BRIDGE\n" - " add-br BRIDGE PARENT VLAN " - "create new fake bridge BRIDGE in PARENT on VLAN\n" - " del-br BRIDGE " - "delete BRIDGE and all of its ports\n" - " list-br " - "print the names of all the bridges\n" - " br-exists BRIDGE " - "test whether BRIDGE exists\n" - " br-to-vlan BRIDGE " - "print the VLAN which BRIDGE is on\n" - " br-to-parent BRIDGE " - "print the parent of BRIDGE\n" - " br-set-external-id BRIDGE KEY VALUE" - " set KEY on BRIDGE to VALUE\n" - " br-set-external-id BRIDGE KEY" - " unset KEY on BRIDGE\n" - " br-get-external-id BRIDGE KEY" - " print value of KEY on BRIDGE\n" - " br-get-external-id BRIDGE" - " list key-value pairs on BRIDGE\n" - ); - printf("\nPort commands:\n" - " list-ports BRIDGE " - "print the names of all the ports on BRIDGE\n" - " add-port BRIDGE PORT " - "add network device PORT to BRIDGE\n" - " add-bond BRIDGE PORT IFACE... " - "add new bonded port PORT in BRIDGE from IFACES\n" - " del-port [BRIDGE] PORT " - "delete PORT (which may be bonded) from BRIDGE\n" - " port-to-br PORT " - "print name of bridge that contains PORT\n" - " port-set-external-id PORT KEY VALUE" - " set KEY on PORT to VALUE\n" - " port-set-external-id PORT KEY" - " unset KEY on PORT\n" - " port-get-external-id PORT KEY" - " print value of KEY on PORT\n" - " port-get-external-id PORT" - " list key-value pairs on PORT\n" - "A bond is considered to be a single port.\n" - ); - printf("\nInterface commands (a bond consists of multiple interfaces):\n" - " list-ifaces BRIDGE " - "print the names of all the interfaces on BRIDGE\n" - " iface-to-br IFACE " - "print name of bridge that contains IFACE\n" - " iface-set-external-id IFACE KEY VALUE" - " set KEY on IFACE to VALUE\n" - " iface-set-external-id IFACE KEY" - " unset KEY on IFACE\n" - " iface-get-external-id IFACE KEY" - " print value of KEY on IFACE\n" - " iface-get-external-id IFACE" - " list key-value pairs on IFACE\n" - ); - printf("\nController commands:\n" - " get-controller [BRIDGE] " - "print the controller for BRIDGE\n" - " del-controller [BRIDGE] " - "delete the controller for BRIDGE\n" - " set-controller [BRIDGE] TARGET " - "set the controller for BRIDGE to TARGET\n" - " get-fail-mode [BRIDGE] " - "print the fail-mode for BRIDGE\n" - " del-fail-mode [BRIDGE] " - "delete the fail-mode for BRIDGE\n" - " set-fail-mode [BRIDGE] MODE " - "set the fail-mode for BRIDGE to MODE\n" - ); - printf("\nOptions:\n" - " --db=DATABASE " - "connect to DATABASE\n" - " " - "(default: %s)\n" - " --oneline " - "print exactly one line of output per command\n", - default_db()); + printf("\ +%s: ovs-vswitchd management utility\n\ +usage: %s [OPTIONS] COMMAND [ARG...]\n\ +\n\ +Bridge commands:\n\ + add-br BRIDGE create a new bridge named BRIDGE\n\ + add-br BRIDGE PARENT VLAN create new fake BRIDGE in PARENT on VLAN\n\ + del-br BRIDGE delete BRIDGE and all of its ports\n\ + list-br print the names of all the bridges\n\ + br-exists BRIDGE test whether BRIDGE exists\n\ + br-to-vlan BRIDGE print the VLAN which BRIDGE is on\n\ + br-to-parent BRIDGE print the parent of BRIDGE\n\ + br-set-external-id BRIDGE KEY VALUE set KEY on BRIDGE to VALUE\n\ + br-set-external-id BRIDGE KEY unset KEY on BRIDGE\n\ + br-get-external-id BRIDGE KEY print value of KEY on BRIDGE\n\ + br-get-external-id BRIDGE list key-value pairs on BRIDGE\n\ +\n\ +Port commands:\n\ + list-ports BRIDGE print the names of all the ports on BRIDGE\n\ + add-port BRIDGE PORT add network device PORT to BRIDGE\n\ + add-bond BRIDGE PORT IFACE... add bonded port PORT in BRIDGE from IFACES\n\ + del-port [BRIDGE] PORT delete PORT (which may be bonded) from BRIDGE\n\ + port-to-br PORT print name of bridge that contains PORT\n\ +A bond is considered to be a single port.\n\ +\n\ +Interface commands (a bond consists of multiple interfaces):\n\ + list-ifaces BRIDGE print the names of all interfaces on BRIDGE\n\ + iface-to-br IFACE print name of bridge that contains IFACE\n\ +\n\ +Controller commands:\n\ + get-controller [BRIDGE] print the controller for BRIDGE\n\ + del-controller [BRIDGE] delete the controller for BRIDGE\n\ + set-controller [BRIDGE] TARGET set the controller for BRIDGE to TARGET\n\ + get-fail-mode [BRIDGE] print the fail-mode for BRIDGE\n\ + del-fail-mode [BRIDGE] delete the fail-mode for BRIDGE\n\ + set-fail-mode [BRIDGE] MODE set the fail-mode for BRIDGE to MODE\n\ +\n\ +SSL commands:\n\ + get-ssl print the SSL configuration\n\ + del-ssl delete the SSL configuration\n\ + set-ssl PRIV-KEY CERT CA-CERT set the SSL configuration\n\ +\n\ +Database commands:\n\ + list TBL [REC] list RECord (or all records) in TBL\n\ + get TBL REC COL[:KEY] print values of COLumns in RECORD in TBL\n\ + set TBL REC COL[:KEY]=VALUE set COLumn values in RECord in TBL\n\ + add TBL REC COL [KEY=]VALUE add (KEY=)VALUE to COLumn in RECord in TBL\n\ + remove TBL REC COL [KEY=]VALUE remove (KEY=)VALUE from COLumn\n\ + clear TBL REC COL clear values from COLumn in RECord in TBL\n\ + create TBL COL[:KEY]=VALUE create and initialize new record\n\ + destroy TBL REC delete REC from TBL\n\ +Potentially unsafe database commands require --force option.\n\ +\n\ +Options:\n\ + --db=DATABASE connect to DATABASE\n\ + (default: %s)\n\ + --oneline print exactly one line of output per command\n", + program_name, program_name, default_db()); vlog_usage(); - printf("\nOther options:\n" - " -h, --help " - "display this help message\n" - " -V, --version " - "display version information\n"); + printf("\n\ +Other options:\n\ + -h, --help display this help message\n\ + -V, --version display version information\n"); exit(EXIT_SUCCESS); } @@ -338,11 +446,16 @@ default_db(void) } struct vsctl_context { + /* Read-only. */ int argc; char **argv; - const struct ovsrec_open_vswitch *ovs; - struct ds output; struct shash options; + + /* Modifiable state. */ + struct ds output; + struct ovsdb_idl *idl; + struct ovsdb_idl_txn *txn; + const struct ovsrec_open_vswitch *ovs; }; struct vsctl_bridge { @@ -370,12 +483,6 @@ struct vsctl_info { struct ovsrec_controller *ctrl; }; -static struct ovsdb_idl_txn * -txn_from_openvswitch(const struct ovsrec_open_vswitch *ovs) -{ - return ovsdb_idl_txn_get(&ovs->header_); -} - static struct vsctl_bridge * add_bridge(struct vsctl_info *b, struct ovsrec_bridge *br_cfg, const char *name, @@ -703,14 +810,14 @@ cmd_add_br(struct vsctl_context *ctx) struct ovsrec_port *port; struct ovsrec_interface *iface; - iface = ovsrec_interface_insert(txn_from_openvswitch(ctx->ovs)); + iface = ovsrec_interface_insert(ctx->txn); ovsrec_interface_set_name(iface, br_name); - port = ovsrec_port_insert(txn_from_openvswitch(ctx->ovs)); + port = ovsrec_port_insert(ctx->txn); ovsrec_port_set_name(port, br_name); ovsrec_port_set_interfaces(port, &iface, 1); - br = ovsrec_bridge_insert(txn_from_openvswitch(ctx->ovs)); + br = ovsrec_bridge_insert(ctx->txn); ovsrec_bridge_set_name(br, br_name); ovsrec_bridge_set_ports(br, &port, 1); @@ -740,11 +847,11 @@ cmd_add_br(struct vsctl_context *ctx) } br = parent->br_cfg; - iface = ovsrec_interface_insert(txn_from_openvswitch(ctx->ovs)); + iface = ovsrec_interface_insert(ctx->txn); ovsrec_interface_set_name(iface, br_name); ovsrec_interface_set_type(iface, "internal"); - port = ovsrec_port_insert(txn_from_openvswitch(ctx->ovs)); + port = ovsrec_port_insert(ctx->txn); ovsrec_port_set_name(port, br_name); ovsrec_port_set_interfaces(port, &iface, 1); ovsrec_port_set_fake_bridge(port, true); @@ -842,7 +949,7 @@ cmd_br_exists(struct vsctl_context *ctx) get_info(ctx->ovs, &info); if (!find_bridge(&info, ctx->argv[1], false)) { - exit(2); + vsctl_exit(2); } free_info(&info); } @@ -994,8 +1101,8 @@ cmd_list_ports(struct vsctl_context *ctx) } static void -add_port(const struct ovsrec_open_vswitch *ovs, - const char *br_name, const char *port_name, +add_port(struct vsctl_context *ctx, + const char *br_name, const char *port_name, bool fake_iface, char *iface_names[], int n_ifaces) { struct vsctl_info info; @@ -1004,7 +1111,7 @@ add_port(const struct ovsrec_open_vswitch *ovs, struct ovsrec_port *port; size_t i; - get_info(ovs, &info); + get_info(ctx->ovs, &info); check_conflicts(&info, port_name, xasprintf("cannot create a port named %s", port_name)); /* XXX need to check for conflicts on interfaces too */ @@ -1012,13 +1119,14 @@ add_port(const struct ovsrec_open_vswitch *ovs, ifaces = xmalloc(n_ifaces * sizeof *ifaces); for (i = 0; i < n_ifaces; i++) { - ifaces[i] = ovsrec_interface_insert(txn_from_openvswitch(ovs)); + ifaces[i] = ovsrec_interface_insert(ctx->txn); ovsrec_interface_set_name(ifaces[i], iface_names[i]); } - port = ovsrec_port_insert(txn_from_openvswitch(ovs)); + port = ovsrec_port_insert(ctx->txn); ovsrec_port_set_name(port, port_name); ovsrec_port_set_interfaces(port, ifaces, n_ifaces); + ovsrec_port_set_bond_fake_iface(port, fake_iface); free(ifaces); if (bridge->vlan) { @@ -1035,13 +1143,16 @@ add_port(const struct ovsrec_open_vswitch *ovs, static void cmd_add_port(struct vsctl_context *ctx) { - add_port(ctx->ovs, ctx->argv[1], ctx->argv[2], &ctx->argv[2], 1); + add_port(ctx, ctx->argv[1], ctx->argv[2], false, &ctx->argv[2], 1); } static void cmd_add_bond(struct vsctl_context *ctx) { - add_port(ctx->ovs, ctx->argv[1], ctx->argv[2], &ctx->argv[3], ctx->argc - 3); + bool fake_iface = shash_find(&ctx->options, "--fake-iface"); + + add_port(ctx, ctx->argv[1], ctx->argv[2], fake_iface, + &ctx->argv[3], ctx->argc - 3); } static void @@ -1088,43 +1199,6 @@ cmd_port_to_br(struct vsctl_context *ctx) free_info(&info); } -static void -cmd_port_set_external_id(struct vsctl_context *ctx) -{ - struct vsctl_info info; - struct vsctl_port *port; - char **keys, **values; - size_t n; - - get_info(ctx->ovs, &info); - port = find_port(&info, ctx->argv[1], true); - set_external_id(port->port_cfg->key_external_ids, - port->port_cfg->value_external_ids, - port->port_cfg->n_external_ids, - ctx->argv[2], ctx->argc >= 4 ? ctx->argv[3] : NULL, - &keys, &values, &n); - ovsrec_port_set_external_ids(port->port_cfg, keys, values, n); - free(keys); - free(values); - - free_info(&info); -} - -static void -cmd_port_get_external_id(struct vsctl_context *ctx) -{ - struct vsctl_info info; - struct vsctl_port *port; - - get_info(ctx->ovs, &info); - port = find_port(&info, ctx->argv[1], true); - get_external_id(port->port_cfg->key_external_ids, - port->port_cfg->value_external_ids, - port->port_cfg->n_external_ids, - "", ctx->argc >= 3 ? ctx->argv[2] : NULL, &ctx->output); - free_info(&info); -} - static void cmd_br_to_vlan(struct vsctl_context *ctx) { @@ -1190,43 +1264,6 @@ cmd_iface_to_br(struct vsctl_context *ctx) free_info(&info); } -static void -cmd_iface_set_external_id(struct vsctl_context *ctx) -{ - struct vsctl_info info; - struct vsctl_iface *iface; - char **keys, **values; - size_t n; - - get_info(ctx->ovs, &info); - iface = find_iface(&info, ctx->argv[1], true); - set_external_id(iface->iface_cfg->key_external_ids, - iface->iface_cfg->value_external_ids, - iface->iface_cfg->n_external_ids, - ctx->argv[2], ctx->argc >= 4 ? ctx->argv[3] : NULL, - &keys, &values, &n); - ovsrec_interface_set_external_ids(iface->iface_cfg, keys, values, n); - free(keys); - free(values); - - free_info(&info); -} - -static void -cmd_iface_get_external_id(struct vsctl_context *ctx) -{ - struct vsctl_info info; - struct vsctl_iface *iface; - - get_info(ctx->ovs, &info); - iface = find_iface(&info, ctx->argv[1], true); - get_external_id(iface->iface_cfg->key_external_ids, - iface->iface_cfg->value_external_ids, - iface->iface_cfg->n_external_ids, - "", ctx->argc >= 3 ? ctx->argv[2] : NULL, &ctx->output); - free_info(&info); -} - static void cmd_get_controller(struct vsctl_context *ctx) { @@ -1292,7 +1329,7 @@ cmd_set_controller(struct vsctl_context *ctx) if (info.ctrl) { ovsrec_controller_delete(info.ctrl); } - ctrl = ovsrec_controller_insert(txn_from_openvswitch(ctx->ovs)); + ctrl = ovsrec_controller_insert(ctx->txn); ovsrec_controller_set_target(ctrl, ctx->argv[1]); ovsrec_open_vswitch_set_controller(ctx->ovs, ctrl); } else { @@ -1302,7 +1339,7 @@ cmd_set_controller(struct vsctl_context *ctx) if (br->ctrl) { ovsrec_controller_delete(br->ctrl); } - ctrl = ovsrec_controller_insert(txn_from_openvswitch(ctx->ovs)); + ctrl = ovsrec_controller_insert(ctx->txn); ovsrec_controller_set_target(ctrl, ctx->argv[2]); ovsrec_bridge_set_controller(br->br_cfg, ctrl); } @@ -1338,7 +1375,7 @@ cmd_get_fail_mode(struct vsctl_context *ctx) } if (fail_mode && strlen(fail_mode)) { - ds_put_format(&ctx->output, "%s\n", info.ctrl->fail_mode); + ds_put_format(&ctx->output, "%s\n", fail_mode); } free_info(&info); @@ -1397,97 +1434,1104 @@ cmd_set_fail_mode(struct vsctl_context *ctx) free_info(&info); } - -typedef void vsctl_handler_func(struct vsctl_context *); - -struct vsctl_command { - const char *name; - int min_args; - int max_args; - vsctl_handler_func *handler; - const char *options; -}; - -static void run_vsctl_command(int argc, char *argv[], - const struct ovsrec_open_vswitch *ovs, - struct ds *output); -static struct json * -where_uuid_equals(const struct uuid *uuid) +static void +cmd_get_ssl(struct vsctl_context *ctx) { - return - json_array_create_1( - json_array_create_3( - json_string_create("_uuid"), - json_string_create("=="), - json_array_create_2( - json_string_create("uuid"), - json_string_create_nocopy( - xasprintf(UUID_FMT, UUID_ARGS(uuid)))))); + struct ovsrec_ssl *ssl = ctx->ovs->ssl; + + if (ssl) { + ds_put_format(&ctx->output, "Private key: %s\n", ssl->private_key); + ds_put_format(&ctx->output, "Certificate: %s\n", ssl->certificate); + ds_put_format(&ctx->output, "CA Certificate: %s\n", ssl->ca_cert); + ds_put_format(&ctx->output, "Bootstrap: %s\n", + ssl->bootstrap_ca_cert ? "true" : "false"); + } } static void -do_vsctl(int argc, char *argv[], struct ovsdb_idl *idl) +cmd_del_ssl(struct vsctl_context *ctx) { - struct ovsdb_idl_txn *txn; - const struct ovsrec_open_vswitch *ovs; - enum ovsdb_idl_txn_status status; - struct ds comment, *output; - int64_t next_cfg; - int n_output; - int i, start; + struct ovsrec_ssl *ssl = ctx->ovs->ssl; - txn = ovsdb_idl_txn_create(idl); - if (dry_run) { - ovsdb_idl_txn_set_dry_run(txn); + if (ssl) { + ovsrec_ssl_delete(ssl); + ovsrec_open_vswitch_set_ssl(ctx->ovs, NULL); } +} - ds_init(&comment); - ds_put_cstr(&comment, "ovs-vsctl:"); - for (i = 0; i < argc; i++) { - ds_put_format(&comment, " %s", argv[i]); - } - ovsdb_idl_txn_add_comment(txn, ds_cstr(&comment)); - ds_destroy(&comment); +static void +cmd_set_ssl(struct vsctl_context *ctx) +{ + bool bootstrap = shash_find(&ctx->options, "--bootstrap"); + struct ovsrec_ssl *ssl = ctx->ovs->ssl; - ovs = ovsrec_open_vswitch_first(idl); - if (!ovs) { - /* XXX add verification that table is empty */ - ovs = ovsrec_open_vswitch_insert(txn); + if (ssl) { + ovsrec_ssl_delete(ssl); } + ssl = ovsrec_ssl_insert(ctx->txn); - if (wait_for_reload) { - struct json *where = where_uuid_equals(&ovs->header_.uuid); - ovsdb_idl_txn_increment(txn, "Open_vSwitch", "next_cfg", - where); - json_destroy(where); - } + ovsrec_ssl_set_private_key(ssl, ctx->argv[1]); + ovsrec_ssl_set_certificate(ssl, ctx->argv[2]); + ovsrec_ssl_set_ca_cert(ssl, ctx->argv[3]); - output = xmalloc(argc * sizeof *output); - n_output = 0; - for (start = i = 0; i <= argc; i++) { - if (i == argc || !strcmp(argv[i], "--")) { - if (i > start) { - ds_init(&output[n_output]); - run_vsctl_command(i - start, &argv[start], ovs, - &output[n_output++]); - } - start = i + 1; - } - } + ovsrec_ssl_set_bootstrap_ca_cert(ssl, bootstrap); - while ((status = ovsdb_idl_txn_commit(txn)) == TXN_INCOMPLETE) { - ovsdb_idl_run(idl); - ovsdb_idl_wait(idl); - ovsdb_idl_txn_wait(txn); - poll_block(); - } - if (wait_for_reload && status == TXN_SUCCESS) { - next_cfg = ovsdb_idl_txn_get_increment_new_value(txn); - } - ovsdb_idl_txn_destroy(txn); + ovsrec_open_vswitch_set_ssl(ctx->ovs, ssl); +} + +/* Parameter commands. */ + +/* POSIX extended regular expression for an 8-bit unsigned decimal integer. */ +#define OCTET_RE "([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])" + +/* POSIX extended regular expression for an IP address. */ +#define IP_RE "("OCTET_RE"\\."OCTET_RE"\\."OCTET_RE"\\."OCTET_RE")" + +/* POSIX extended regular expression for a netmask. */ +#define NETMASK_RE \ + "255.255.255."NETMASK_END_RE"|" \ + "255.255."NETMASK_END_RE".0|" \ + "255."NETMASK_END_RE".0.0|" \ + NETMASK_END_RE".0.0.0" +#define NETMASK_END_RE "(255|254|252|248|240|224|192|128|0)" + +/* POSIX extended regular expression for an Ethernet address. */ +#define XX_RE "[0-9a-fA-F][0-9a-fA-F]" +#define MAC_RE XX_RE":"XX_RE":"XX_RE":"XX_RE":"XX_RE":"XX_RE + +/* POSIX extended regular expression for a TCP or UDP port number. */ +#define PORT_RE \ + "([0-9]|" \ + "[1-9][0-9]|" \ + "[1-9][0-9][0-9]|" \ + "[1-9][0-9][0-9][0-9]|" \ + "[1-5][0-9][0-9][0-9][0-9]|" \ + "6[1-4][0-9][0-9][0-9]|" \ + "65[1-4][0-9][0-9]|" \ + "655[1-2][0-9]|" \ + "6553[1-5])" + +enum { + VSCF_READONLY = 1 << 0, + VSCF_HIDDEN = 1 << 1 +}; - switch (status) { +struct vsctl_column { + struct ovsdb_idl_column *idl; + int flags; + const char *constraint; +}; + +static const struct vsctl_column bridge_columns[] = { + {&ovsrec_bridge_col_controller, VSCF_READONLY, NULL}, + {&ovsrec_bridge_col_datapath_id, VSCF_READONLY, NULL}, + {&ovsrec_bridge_col_datapath_type, VSCF_READONLY, NULL}, + {&ovsrec_bridge_col_external_ids, 0, NULL}, + {&ovsrec_bridge_col_flood_vlans, 0, "[1,4095]"}, + {&ovsrec_bridge_col_mirrors, VSCF_READONLY, NULL}, + {&ovsrec_bridge_col_name, VSCF_READONLY, NULL}, + {&ovsrec_bridge_col_netflow, VSCF_READONLY, NULL}, + {&ovsrec_bridge_col_other_config, 0, NULL}, + {&ovsrec_bridge_col_ports, VSCF_READONLY, NULL}, + {NULL, 0, NULL}, +}; + +static const struct vsctl_column controller_columns[] = { + {&ovsrec_controller_col_connection_mode, 0, "in-band|out-of-band"}, + {&ovsrec_controller_col_controller_burst_limit, 0, "[25,]"}, + {&ovsrec_controller_col_controller_rate_limit, 0, "[100,]"}, + {&ovsrec_controller_col_discover_accept_regex, 0, NULL}, + {&ovsrec_controller_col_discover_update_resolv_conf, 0, NULL}, + {&ovsrec_controller_col_fail_mode, 0, "standalone|secure"}, + {&ovsrec_controller_col_inactivity_probe, 0, "[5000,]"}, + {&ovsrec_controller_col_local_gateway, 0, IP_RE}, + {&ovsrec_controller_col_local_ip, 0, IP_RE}, + {&ovsrec_controller_col_local_netmask, 0, NETMASK_RE}, + {&ovsrec_controller_col_max_backoff, 0, "[1000,]"}, + {&ovsrec_controller_col_target, 0, NULL}, + {NULL, 0, NULL}, +}; + +static const struct vsctl_column interface_columns[] = { + {&ovsrec_interface_col_external_ids, 0, NULL}, + {&ovsrec_interface_col_ingress_policing_burst, 0, "[10,]"}, + {&ovsrec_interface_col_ingress_policing_rate, 0, "[100,]"}, + {&ovsrec_interface_col_mac, 0, MAC_RE}, + {&ovsrec_interface_col_name, VSCF_READONLY, NULL}, + {&ovsrec_interface_col_ofport, VSCF_READONLY, NULL}, + {&ovsrec_interface_col_options, 0, NULL}, + {&ovsrec_interface_col_type, VSCF_READONLY, NULL}, + {NULL, 0, NULL}, +}; + +static const struct vsctl_column mirror_columns[] = { + {&ovsrec_mirror_col_name, VSCF_READONLY, NULL}, + {&ovsrec_mirror_col_output_port, 0, "Port"}, + {&ovsrec_mirror_col_output_vlan, 0, "[1,4095]"}, + {&ovsrec_mirror_col_select_dst_port, 0, "Port"}, + {&ovsrec_mirror_col_select_src_port, 0, "Port"}, + {&ovsrec_mirror_col_select_vlan, 0, "[1,4095]"}, + {NULL, 0, NULL}, +}; + +static const struct vsctl_column netflow_columns[] = { + {&ovsrec_netflow_col_active_timeout, 0, "[-1,]"}, + {&ovsrec_netflow_col_add_id_to_interface, 0, NULL}, + {&ovsrec_netflow_col_engine_id, 0, "[0,255]"}, + {&ovsrec_netflow_col_engine_type, 0, "[0,255]"}, + {&ovsrec_netflow_col_targets, 0, IP_RE":"PORT_RE}, + {NULL, 0, NULL}, +}; + +static const struct vsctl_column open_vswitch_columns[] = { + {&ovsrec_open_vswitch_col_bridges, VSCF_READONLY, NULL}, + {&ovsrec_open_vswitch_col_controller, VSCF_READONLY, NULL}, + {&ovsrec_open_vswitch_col_cur_cfg, VSCF_HIDDEN, NULL}, + {&ovsrec_open_vswitch_col_managers, 0, "p?(ssl|tcp|unix):.*"}, + {&ovsrec_open_vswitch_col_next_cfg, VSCF_HIDDEN, NULL}, + {&ovsrec_open_vswitch_col_ssl, VSCF_READONLY, NULL}, + {NULL, 0, NULL}, +}; + +static const struct vsctl_column port_columns[] = { + {&ovsrec_port_col_bond_downdelay, 0, "[0,]"}, + {&ovsrec_port_col_bond_fake_iface, VSCF_READONLY, NULL}, + {&ovsrec_port_col_bond_updelay, 0, "[0,]"}, + {&ovsrec_port_col_external_ids, 0, NULL}, + {&ovsrec_port_col_fake_bridge, VSCF_READONLY, NULL}, + {&ovsrec_port_col_interfaces, VSCF_READONLY, NULL}, + {&ovsrec_port_col_mac, 0, MAC_RE}, + {&ovsrec_port_col_name, VSCF_READONLY, NULL}, + {&ovsrec_port_col_other_config, 0, NULL}, + {&ovsrec_port_col_tag, 0, "[0,4095]"}, + {&ovsrec_port_col_trunks, 0, "[0,4095]"}, + {NULL, 0, NULL}, +}; + +static const struct vsctl_column ssl_columns[] = { + {&ovsrec_ssl_col_bootstrap_ca_cert, 0, NULL}, + {&ovsrec_ssl_col_ca_cert, 0, NULL}, + {&ovsrec_ssl_col_certificate, 0, NULL}, + {&ovsrec_ssl_col_private_key, 0, NULL}, + {NULL, 0, NULL}, +}; + +struct vsctl_row_id { + const struct ovsdb_idl_table_class *table; + const struct ovsdb_idl_column *name_column; + const struct ovsdb_idl_column *uuid_column; +}; + +struct vsctl_table_class { + struct ovsdb_idl_table_class *class; + const struct vsctl_column *columns; + struct vsctl_row_id row_ids[2]; +}; + +static const struct vsctl_table_class tables[] = { + {&ovsrec_table_bridge, bridge_columns, + {{&ovsrec_table_bridge, &ovsrec_bridge_col_name, NULL}, + {NULL, NULL, NULL}}}, + + {&ovsrec_table_controller, controller_columns, + {{&ovsrec_table_bridge, + &ovsrec_bridge_col_name, + &ovsrec_bridge_col_controller}, + {&ovsrec_table_open_vswitch, + NULL, + &ovsrec_open_vswitch_col_controller}}}, + + {&ovsrec_table_interface, interface_columns, + {{&ovsrec_table_interface, &ovsrec_interface_col_name, NULL}, + {NULL, NULL, NULL}}}, + + {&ovsrec_table_mirror, mirror_columns, + {{&ovsrec_table_mirror, &ovsrec_mirror_col_name, NULL}, + {NULL, NULL, NULL}}}, + + {&ovsrec_table_netflow, netflow_columns, + {{&ovsrec_table_bridge, + &ovsrec_bridge_col_name, + &ovsrec_bridge_col_netflow}, + {NULL, NULL, NULL}}}, + + {&ovsrec_table_open_vswitch, open_vswitch_columns, + {{&ovsrec_table_open_vswitch, NULL, NULL}, + {NULL, NULL, NULL}}}, + + {&ovsrec_table_port, port_columns, + {{&ovsrec_table_port, &ovsrec_port_col_name, NULL}, + {NULL, NULL, NULL}}}, + + {&ovsrec_table_ssl, ssl_columns, + {{&ovsrec_table_open_vswitch, NULL, &ovsrec_open_vswitch_col_ssl}}}, + + {NULL, NULL, {{NULL, NULL, NULL}, {NULL, NULL, NULL}}} +}; + +static void +die_if_error(char *error) +{ + if (error) { + vsctl_fatal("%s", error); + } +} + +static int +to_lower_and_underscores(unsigned c) +{ + return c == '-' ? '_' : tolower(c); +} + +static unsigned int +score_partial_match(const char *name, const char *s) +{ + int score; + + if (!strcmp(name, s)) { + return UINT_MAX; + } + for (score = 0; ; score++, name++, s++) { + if (to_lower_and_underscores(*name) != to_lower_and_underscores(*s)) { + break; + } else if (*name == '\0') { + return UINT_MAX - 1; + } + } + return *s == '\0' ? score : 0; +} + +static const struct vsctl_table_class * +get_table(const char *table_name) +{ + const struct vsctl_table_class *table; + const struct vsctl_table_class *best_match = NULL; + unsigned int best_score = 0; + + for (table = tables; table->class; table++) { + unsigned int score = score_partial_match(table->class->name, + table_name); + if (score > best_score) { + best_match = table; + best_score = score; + } else if (score == best_score) { + best_match = NULL; + } + } + if (best_match) { + return best_match; + } else if (best_score) { + vsctl_fatal("multiple table names match \"%s\"", table_name); + } else { + vsctl_fatal("unknown table \"%s\"", table_name); + } +} + +static const struct ovsdb_idl_row * +get_row_by_id(struct vsctl_context *ctx, const struct vsctl_table_class *table, + const struct vsctl_row_id *id, const char *record_id) +{ + const struct ovsdb_idl_row *referrer, *final; + + if (!id->table) { + return NULL; + } + + if (!id->name_column) { + if (strcmp(record_id, ".")) { + return NULL; + } + referrer = ovsdb_idl_first_row(ctx->idl, id->table); + if (!referrer || ovsdb_idl_next_row(referrer)) { + return NULL; + } + } else { + const struct ovsdb_idl_row *row; + unsigned int best_score = 0; + + /* It might make sense to relax this assertion. */ + assert(id->name_column->type.key_type == OVSDB_TYPE_STRING); + + referrer = NULL; + for (row = ovsdb_idl_first_row(ctx->idl, id->table); + row != NULL && best_score != UINT_MAX; + row = ovsdb_idl_next_row(row)) + { + struct ovsdb_datum name; + + ovsdb_idl_txn_read(row, id->name_column, &name); + if (name.n == 1) { + unsigned int score = score_partial_match(name.keys[0].string, + record_id); + if (score > best_score) { + referrer = row; + best_score = score; + } else if (score == best_score) { + referrer = NULL; + } + } + ovsdb_datum_destroy(&name, &id->name_column->type); + } + if (best_score && !referrer) { + vsctl_fatal("multiple rows in %s match \"%s\"", + table->class->name, record_id); + } + } + if (!referrer) { + return NULL; + } + + final = NULL; + if (id->uuid_column) { + struct ovsdb_datum uuid; + + assert(id->uuid_column->type.key_type == OVSDB_TYPE_UUID); + assert(id->uuid_column->type.value_type == OVSDB_TYPE_VOID); + + ovsdb_idl_txn_read(referrer, id->uuid_column, &uuid); + if (uuid.n == 1) { + final = ovsdb_idl_get_row_for_uuid(ctx->idl, table->class, + &uuid.keys[0].uuid); + } + ovsdb_datum_destroy(&uuid, &id->uuid_column->type); + } else { + final = referrer; + } + + return final; +} + +static const struct ovsdb_idl_row * +get_row(struct vsctl_context *ctx, + const struct vsctl_table_class *table, const char *record_id) +{ + const struct ovsdb_idl_row *row; + struct uuid uuid; + + if (uuid_from_string(&uuid, record_id)) { + row = ovsdb_idl_get_row_for_uuid(ctx->idl, table->class, &uuid); + } else { + int i; + + for (i = 0; i < ARRAY_SIZE(table->row_ids); i++) { + row = get_row_by_id(ctx, table, &table->row_ids[i], record_id); + if (row) { + break; + } + } + } + return row; +} + +static const struct ovsdb_idl_row * +must_get_row(struct vsctl_context *ctx, + const struct vsctl_table_class *table, const char *record_id) +{ + const struct ovsdb_idl_row *row = get_row(ctx, table, record_id); + if (!row) { + vsctl_fatal("no row \"%s\" in table %s", + record_id, table->class->name); + } + return row; +} + +static char * +get_column(const struct vsctl_table_class *table, const char *column_name, + const struct vsctl_column **columnp) +{ + const struct vsctl_column *column; + const struct vsctl_column *best_match = NULL; + unsigned int best_score = 0; + + for (column = table->columns; column->idl; column++) { + if (!(column->flags & VSCF_HIDDEN)) { + unsigned int score = score_partial_match(column->idl->name, + column_name); + if (score > best_score) { + best_match = column; + best_score = score; + } else if (score == best_score) { + best_match = NULL; + } + } + } + + *columnp = best_match; + if (best_match) { + return NULL; + } else if (best_score) { + return xasprintf("%s contains more than one column whose name " + "matches \"%s\"", table->class->name, column_name); + } else { + return xasprintf("%s does not contain a column whose name matches " + "\"%s\"", table->class->name, column_name); + } +} + +static char * WARN_UNUSED_RESULT +parse_column_key_value(const char *arg, const struct vsctl_table_class *table, + const struct vsctl_column **columnp, + char **keyp, char **valuep) +{ + const char *p = arg; + char *error; + + assert(columnp || keyp); + if (keyp) { + *keyp = NULL; + } + if (valuep) { + *valuep = NULL; + } + + /* Parse column name. */ + if (columnp) { + char *column_name; + + error = ovsdb_token_parse(&p, &column_name); + if (error) { + goto error; + } + if (column_name[0] == '\0') { + free(column_name); + error = xasprintf("%s: missing column name", arg); + goto error; + } + error = get_column(table, column_name, columnp); + free(column_name); + if (error) { + goto error; + } + } + + /* Parse key string. */ + if (*p == ':' || !columnp) { + if (columnp) { + p++; + } else if (!keyp) { + error = xasprintf("%s: key not accepted here", arg); + goto error; + } + error = ovsdb_token_parse(&p, keyp); + if (error) { + goto error; + } + } else if (keyp) { + *keyp = NULL; + } + + /* Parse value string. */ + if (*p == '=') { + if (!valuep) { + error = xasprintf("%s: value not accepted here", arg); + goto error; + } + *valuep = xstrdup(p + 1); + } else { + if (valuep) { + *valuep = NULL; + } + if (*p != '\0') { + error = xasprintf("%s: trailing garbage \"%s\" in argument", + arg, p); + goto error; + } + } + return NULL; + +error: + if (columnp) { + *columnp = NULL; + } + if (keyp) { + free(*keyp); + *keyp = NULL; + } + if (valuep) { + free(*valuep); + *valuep = NULL; + } + return error; +} + +static void +cmd_get(struct vsctl_context *ctx) +{ + bool if_exists = shash_find(&ctx->options, "--if-exists"); + const char *table_name = ctx->argv[1]; + const char *record_id = ctx->argv[2]; + const struct vsctl_table_class *table; + const struct ovsdb_idl_row *row; + struct ds *out = &ctx->output; + int i; + + table = get_table(table_name); + row = must_get_row(ctx, table, record_id); + for (i = 3; i < ctx->argc; i++) { + const struct vsctl_column *column; + struct ovsdb_datum datum; + char *key_string; + + die_if_error(parse_column_key_value(ctx->argv[i], table, + &column, &key_string, NULL)); + + ovsdb_idl_txn_read(row, column->idl, &datum); + if (key_string) { + union ovsdb_atom key; + unsigned int idx; + + if (column->idl->type.value_type == OVSDB_TYPE_VOID) { + vsctl_fatal("cannot specify key to get for non-map column %s", + column->idl->name); + } + + die_if_error(ovsdb_atom_from_string(&key, + column->idl->type.key_type, + key_string)); + + idx = ovsdb_datum_find_key(&datum, &key, + column->idl->type.key_type); + if (idx == UINT_MAX) { + if (!if_exists) { + vsctl_fatal("no key \"%s\" in %s record \"%s\" column %s", + key_string, table->class->name, record_id, + column->idl->name); + } + } else { + ovsdb_atom_to_string(&datum.values[idx], + column->idl->type.value_type, out); + } + ovsdb_atom_destroy(&key, column->idl->type.key_type); + } else { + ovsdb_datum_to_string(&datum, &column->idl->type, out); + } + ds_put_char(out, '\n'); + ovsdb_datum_destroy(&datum, &column->idl->type); + + free(key_string); + } +} + +static void +list_record(const struct vsctl_table_class *table, + const struct ovsdb_idl_row *row, struct ds *out) +{ + const struct vsctl_column *column; + + ds_put_format(out, "%-20s (RO): "UUID_FMT"\n", "_uuid", + UUID_ARGS(&row->uuid)); + for (column = table->columns; column->idl; column++) { + struct ovsdb_datum datum; + + if (column->flags & VSCF_HIDDEN) { + continue; + } + + ovsdb_idl_txn_read(row, column->idl, &datum); + + ds_put_format(out, "%-20s (%s): ", column->idl->name, + column->flags & VSCF_READONLY ? "RO" : "RW"); + ovsdb_datum_to_string(&datum, &column->idl->type, out); + ds_put_char(out, '\n'); + + ovsdb_datum_destroy(&datum, &column->idl->type); + } +} + +static void +cmd_list(struct vsctl_context *ctx) +{ + const char *table_name = ctx->argv[1]; + const struct vsctl_table_class *table; + struct ds *out = &ctx->output; + int i; + + table = get_table(table_name); + if (ctx->argc > 2) { + for (i = 2; i < ctx->argc; i++) { + if (i > 2) { + ds_put_char(out, '\n'); + } + list_record(table, must_get_row(ctx, table, ctx->argv[i]), out); + } + } else { + const struct ovsdb_idl_row *row; + bool first; + + for (row = ovsdb_idl_first_row(ctx->idl, table->class), first = true; + row != NULL; + row = ovsdb_idl_next_row(row), first = false) { + if (!first) { + ds_put_char(out, '\n'); + } + list_record(table, row, out); + } + } +} + +static void +check_string_constraint(const struct ovsdb_datum *datum, + const char *constraint) +{ + unsigned int i; + char *regex; + regex_t re; + int retval; + + regex = xasprintf("^%s$", constraint); + retval = regcomp(&re, regex, REG_NOSUB | REG_EXTENDED); + if (retval) { + size_t length = regerror(retval, &re, NULL, 0); + char *buffer = xmalloc(length); + regerror(retval, &re, buffer, length); + vsctl_fatal("internal error compiling regular expression %s: %s", + regex, buffer); + } + + for (i = 0; i < datum->n; i++) { + const char *key = datum->keys[i].string; + if (regexec(&re, key, 0, NULL, 0)) { + vsctl_fatal("%s is not valid (it does not match %s)", key, regex); + } + } + free(regex); + regfree(&re); +} + +static void +check_integer_constraint(const struct ovsdb_datum *datum, + const char *constraint) +{ + int64_t min, max; + unsigned int i; + int n = -1; + + sscanf(constraint, "[%"SCNd64",%"SCNd64"]%n", &min, &max, &n); + if (n == -1) { + sscanf(constraint, "[%"SCNd64",]%n", &min, &n); + if (n == -1) { + sscanf(constraint, "[,%"SCNd64"]%n", &max, &n); + if (n == -1) { + VLOG_DBG("internal error: bad integer contraint \"%s\"", + constraint); + return; + } else { + min = INT64_MIN; + } + } else { + max = INT64_MAX; + } + } + + for (i = 0; i < datum->n; i++) { + int64_t value = datum->keys[i].integer; + if (value < min || value > max) { + if (max == INT64_MAX) { + vsctl_fatal("%"PRId64" is less than the minimum " + "allowed value %"PRId64, value, min); + } else if (min == INT64_MIN) { + vsctl_fatal("%"PRId64" is greater than the maximum " + "allowed value %"PRId64, value, max); + } else { + vsctl_fatal("%"PRId64" is outside the valid range %"PRId64" " + "to %"PRId64" (inclusive)", value, min, max); + } + } + } +} + +static void +check_constraint(const struct ovsdb_datum *datum, + const struct ovsdb_type *type, const char *constraint) +{ + if (constraint && datum->n) { + if (type->key_type == OVSDB_TYPE_STRING) { + check_string_constraint(datum, constraint); + } else if (type->key_type == OVSDB_TYPE_INTEGER) { + check_integer_constraint(datum, constraint); + } + } +} + +static void +set_column(const struct vsctl_table_class *table, + const struct ovsdb_idl_row *row, + const char *arg, bool force) +{ + const struct vsctl_column *column; + char *key_string, *value_string; + char *error; + + error = parse_column_key_value(arg, table, &column, &key_string, + &value_string); + die_if_error(error); + if (column->flags & VSCF_READONLY && !force) { + vsctl_fatal("%s: cannot modify read-only column %s in table %s", + arg, column->idl->name, table->class->name); + } + if (!value_string) { + vsctl_fatal("%s: missing value", arg); + } + + if (key_string) { + union ovsdb_atom key, value; + struct ovsdb_datum old, new; + + if (column->idl->type.value_type == OVSDB_TYPE_VOID) { + vsctl_fatal("cannot specify key to set for non-map column %s", + column->idl->name); + } + + die_if_error(ovsdb_atom_from_string(&key, + column->idl->type.key_type, + key_string)); + die_if_error(ovsdb_atom_from_string(&value, + column->idl->type.value_type, + value_string)); + + ovsdb_datum_init_empty(&new); + ovsdb_datum_add_unsafe(&new, &key, &value, &column->idl->type); + + ovsdb_atom_destroy(&key, column->idl->type.key_type); + ovsdb_atom_destroy(&value, column->idl->type.value_type); + + ovsdb_idl_txn_read(row, column->idl, &old); + ovsdb_datum_union(&old, &new, &column->idl->type, true); + ovsdb_idl_txn_write(row, column->idl, &old); + + ovsdb_datum_destroy(&new, &column->idl->type); + } else { + struct ovsdb_datum datum; + + die_if_error(ovsdb_datum_from_string(&datum, &column->idl->type, + value_string)); + if (!force) { + check_constraint(&datum, &column->idl->type, + column->constraint); + } + ovsdb_idl_txn_write(row, column->idl, &datum); + } + + free(key_string); + free(value_string); +} + +static void +cmd_set(struct vsctl_context *ctx) +{ + bool force = shash_find(&ctx->options, "--force"); + const char *table_name = ctx->argv[1]; + const char *record_id = ctx->argv[2]; + const struct vsctl_table_class *table; + const struct ovsdb_idl_row *row; + int i; + + table = get_table(table_name); + row = must_get_row(ctx, table, record_id); + for (i = 3; i < ctx->argc; i++) { + set_column(table, row, ctx->argv[i], force); + } +} + +static void +cmd_add(struct vsctl_context *ctx) +{ + bool force = shash_find(&ctx->options, "--force"); + const char *table_name = ctx->argv[1]; + const char *record_id = ctx->argv[2]; + const char *column_name = ctx->argv[3]; + const struct vsctl_table_class *table; + const struct vsctl_column *column; + const struct ovsdb_idl_row *row; + const struct ovsdb_type *type; + struct ovsdb_datum old; + int i; + + table = get_table(table_name); + row = must_get_row(ctx, table, record_id); + die_if_error(get_column(table, column_name, &column)); + if (column->flags & VSCF_READONLY && !force) { + vsctl_fatal("cannot modify read-only column %s in table %s", + column->idl->name, table->class->name); + } + + type = &column->idl->type; + ovsdb_idl_txn_read(row, column->idl, &old); + for (i = 4; i < ctx->argc; i++) { + struct ovsdb_type add_type; + struct ovsdb_datum add; + + add_type = *type; + add_type.n_min = 1; + add_type.n_max = UINT_MAX; + die_if_error(ovsdb_datum_from_string(&add, &add_type, ctx->argv[i])); + ovsdb_datum_union(&old, &add, type, false); + ovsdb_datum_destroy(&add, type); + } + if (old.n > type->n_max) { + vsctl_fatal("\"add\" operation would put %u %s in column %s of " + "table %s but the maximum number is %u", + old.n, + type->value_type == OVSDB_TYPE_VOID ? "values" : "pairs", + column->idl->name, table->class->name, type->n_max); + } + ovsdb_idl_txn_write(row, column->idl, &old); +} + +static void +cmd_remove(struct vsctl_context *ctx) +{ + bool force = shash_find(&ctx->options, "--force"); + const char *table_name = ctx->argv[1]; + const char *record_id = ctx->argv[2]; + const char *column_name = ctx->argv[3]; + const struct vsctl_table_class *table; + const struct vsctl_column *column; + const struct ovsdb_idl_row *row; + const struct ovsdb_type *type; + struct ovsdb_datum old; + int i; + + table = get_table(table_name); + row = must_get_row(ctx, table, record_id); + die_if_error(get_column(table, column_name, &column)); + if (column->flags & VSCF_READONLY && !force) { + vsctl_fatal("cannot modify read-only column %s in table %s", + column->idl->name, table->class->name); + } + + type = &column->idl->type; + ovsdb_idl_txn_read(row, column->idl, &old); + for (i = 4; i < ctx->argc; i++) { + struct ovsdb_type rm_type; + struct ovsdb_datum rm; + char *error; + + rm_type = *type; + rm_type.n_min = 1; + rm_type.n_max = UINT_MAX; + error = ovsdb_datum_from_string(&rm, &rm_type, ctx->argv[i]); + if (error && ovsdb_type_is_map(&rm_type)) { + free(error); + rm_type.value_type = OVSDB_TYPE_VOID; + die_if_error(ovsdb_datum_from_string(&rm, &rm_type, ctx->argv[i])); + } + ovsdb_datum_subtract(&old, type, &rm, &rm_type); + ovsdb_datum_destroy(&rm, &rm_type); + } + if (old.n < type->n_min) { + vsctl_fatal("\"remove\" operation would put %u %s in column %s of " + "table %s but the minimun number is %u", + old.n, + type->value_type == OVSDB_TYPE_VOID ? "values" : "pairs", + column->idl->name, table->class->name, type->n_min); + } + ovsdb_idl_txn_write(row, column->idl, &old); +} + +static void +cmd_clear(struct vsctl_context *ctx) +{ + bool force = shash_find(&ctx->options, "--force"); + const char *table_name = ctx->argv[1]; + const char *record_id = ctx->argv[2]; + const struct vsctl_table_class *table; + const struct ovsdb_idl_row *row; + int i; + + table = get_table(table_name); + row = must_get_row(ctx, table, record_id); + for (i = 3; i < ctx->argc; i++) { + const struct vsctl_column *column; + const struct ovsdb_type *type; + struct ovsdb_datum datum; + + die_if_error(get_column(table, ctx->argv[i], &column)); + + type = &column->idl->type; + if (column->flags & VSCF_READONLY && !force) { + vsctl_fatal("cannot modify read-only column %s in table %s", + column->idl->name, table->class->name); + } else if (type->n_min > 0) { + vsctl_fatal("\"clear\" operation cannot be applied to column %s " + "of table %s, which is not allowed to be empty", + column->idl->name, table->class->name); + } + + ovsdb_datum_init_empty(&datum); + ovsdb_idl_txn_write(row, column->idl, &datum); + } +} + +static void +cmd_create(struct vsctl_context *ctx) +{ + bool force = shash_find(&ctx->options, "--force"); + const char *table_name = ctx->argv[1]; + const struct vsctl_table_class *table; + const struct ovsdb_idl_row *row; + int i; + + if (!force) { + vsctl_fatal("\"create\" requires --force"); + } + + table = get_table(table_name); + row = ovsdb_idl_txn_insert(ctx->txn, table->class); + for (i = 2; i < ctx->argc; i++) { + set_column(table, row, ctx->argv[i], force); + } + ds_put_format(&ctx->output, UUID_FMT, UUID_ARGS(&row->uuid)); +} + +/* This function may be used as the 'postprocess' function for commands that + * insert new rows into the database. It expects that the command's 'run' + * function prints the UUID reported by ovsdb_idl_txn_insert() as the command's + * sole output. It replaces that output by the row's permanent UUID assigned + * by the database server and appends a new-line. + * + * Currently we use this only for "create", because the higher-level commands + * are supposed to be independent of the actual structure of the vswitch + * configuration. */ +static void +post_create(struct vsctl_context *ctx) +{ + const struct uuid *real; + struct uuid dummy; + + uuid_from_string(&dummy, ds_cstr(&ctx->output)); + real = ovsdb_idl_txn_get_insert_uuid(ctx->txn, &dummy); + if (real) { + ds_clear(&ctx->output); + ds_put_format(&ctx->output, UUID_FMT, UUID_ARGS(real)); + } + ds_put_char(&ctx->output, '\n'); +} + +static void +cmd_destroy(struct vsctl_context *ctx) +{ + bool force = shash_find(&ctx->options, "--force"); + bool must_exist = !shash_find(&ctx->options, "--if-exists"); + const char *table_name = ctx->argv[1]; + const struct vsctl_table_class *table; + int i; + + if (!force) { + vsctl_fatal("\"destroy\" requires --force"); + } + + table = get_table(table_name); + for (i = 2; i < ctx->argc; i++) { + const struct ovsdb_idl_row *row; + + row = (must_exist ? must_get_row : get_row)(ctx, table, ctx->argv[i]); + if (row) { + ovsdb_idl_txn_delete(row); + } + } +} + +static struct json * +where_uuid_equals(const struct uuid *uuid) +{ + return + json_array_create_1( + json_array_create_3( + json_string_create("_uuid"), + json_string_create("=="), + json_array_create_2( + json_string_create("uuid"), + json_string_create_nocopy( + xasprintf(UUID_FMT, UUID_ARGS(uuid)))))); +} + +static void +vsctl_context_init(struct vsctl_context *ctx, struct vsctl_command *command, + struct ovsdb_idl *idl, struct ovsdb_idl_txn *txn, + const struct ovsrec_open_vswitch *ovs) +{ + ctx->argc = command->argc; + ctx->argv = command->argv; + ctx->options = command->options; + + ds_swap(&ctx->output, &command->output); + ctx->idl = idl; + ctx->txn = txn; + ctx->ovs = ovs; + +} + +static void +vsctl_context_done(struct vsctl_context *ctx, struct vsctl_command *command) +{ + ds_swap(&ctx->output, &command->output); +} + +static void +do_vsctl(const char *args, struct vsctl_command *commands, size_t n_commands, + struct ovsdb_idl *idl) +{ + struct ovsdb_idl_txn *txn; + const struct ovsrec_open_vswitch *ovs; + enum ovsdb_idl_txn_status status; + struct vsctl_command *c; + int64_t next_cfg = 0; + char *comment; + + txn = the_idl_txn = ovsdb_idl_txn_create(idl); + if (dry_run) { + ovsdb_idl_txn_set_dry_run(txn); + } + + comment = xasprintf("ovs-vsctl: %s", args); + ovsdb_idl_txn_add_comment(txn, comment); + free(comment); + + ovs = ovsrec_open_vswitch_first(idl); + if (!ovs) { + /* XXX add verification that table is empty */ + ovs = ovsrec_open_vswitch_insert(txn); + } + + if (wait_for_reload) { + struct json *where = where_uuid_equals(&ovs->header_.uuid); + ovsdb_idl_txn_increment(txn, "Open_vSwitch", "next_cfg", where); + json_destroy(where); + } + + for (c = commands; c < &commands[n_commands]; c++) { + struct vsctl_context ctx; + + ds_init(&c->output); + vsctl_context_init(&ctx, c, idl, txn, ovs); + (c->syntax->run)(&ctx); + vsctl_context_done(&ctx, c); + } + + while ((status = ovsdb_idl_txn_commit(txn)) == TXN_INCOMPLETE) { + ovsdb_idl_run(idl); + ovsdb_idl_wait(idl); + ovsdb_idl_txn_wait(txn); + poll_block(); + } + if (wait_for_reload && status == TXN_SUCCESS) { + next_cfg = ovsdb_idl_txn_get_increment_new_value(txn); + } + for (c = commands; c < &commands[n_commands]; c++) { + if (c->syntax->postprocess) { + struct vsctl_context ctx; + + vsctl_context_init(&ctx, c, idl, txn, ovs); + (c->syntax->postprocess)(&ctx); + vsctl_context_done(&ctx, c); + } + } + ovsdb_idl_txn_destroy(txn); + the_idl_txn = NULL; + + switch (status) { case TXN_INCOMPLETE: NOT_REACHED(); @@ -1500,8 +2544,8 @@ do_vsctl(int argc, char *argv[], struct ovsdb_idl *idl) break; case TXN_TRY_AGAIN: - for (i = 0; i < n_output; i++) { - ds_destroy(&output[i]); + for (c = commands; c < &commands[n_commands]; c++) { + ds_destroy(&c->output); } return; @@ -1512,8 +2556,8 @@ do_vsctl(int argc, char *argv[], struct ovsdb_idl *idl) NOT_REACHED(); } - for (i = 0; i < n_output; i++) { - struct ds *ds = &output[i]; + for (c = commands; c < &commands[n_commands]; c++) { + struct ds *ds = &c->output; if (oneline) { size_t j; @@ -1558,115 +2602,54 @@ do_vsctl(int argc, char *argv[], struct ovsdb_idl *idl) exit(EXIT_SUCCESS); } -static vsctl_handler_func * -get_vsctl_handler(int argc, char *argv[], struct vsctl_context *ctx) -{ - static const struct vsctl_command all_commands[] = { - /* Open vSwitch commands. */ - {"init", 0, 0, cmd_init, ""}, - - /* Bridge commands. */ - {"add-br", 1, 3, cmd_add_br, ""}, - {"del-br", 1, 1, cmd_del_br, "--if-exists"}, - {"list-br", 0, 0, cmd_list_br, ""}, - {"br-exists", 1, 1, cmd_br_exists, ""}, - {"br-to-vlan", 1, 1, cmd_br_to_vlan, ""}, - {"br-to-parent", 1, 1, cmd_br_to_parent, ""}, - {"br-set-external-id", 2, 3, cmd_br_set_external_id, ""}, - {"br-get-external-id", 1, 2, cmd_br_get_external_id, ""}, - - /* Port commands. */ - {"list-ports", 1, 1, cmd_list_ports, ""}, - {"add-port", 2, 2, cmd_add_port, ""}, - {"add-bond", 4, INT_MAX, cmd_add_bond, ""}, - {"del-port", 1, 2, cmd_del_port, "--if-exists"}, - {"port-to-br", 1, 1, cmd_port_to_br, ""}, - {"port-set-external-id", 2, 3, cmd_port_set_external_id, ""}, - {"port-get-external-id", 1, 2, cmd_port_get_external_id, ""}, - - /* Interface commands. */ - {"list-ifaces", 1, 1, cmd_list_ifaces, ""}, - {"iface-to-br", 1, 1, cmd_iface_to_br, ""}, - {"iface-set-external-id", 2, 3, cmd_iface_set_external_id, ""}, - {"iface-get-external-id", 1, 2, cmd_iface_get_external_id, ""}, - - /* Controller commands. */ - {"get-controller", 0, 1, cmd_get_controller, ""}, - {"del-controller", 0, 1, cmd_del_controller, ""}, - {"set-controller", 1, 2, cmd_set_controller, ""}, - {"get-fail-mode", 0, 1, cmd_get_fail_mode, ""}, - {"del-fail-mode", 0, 1, cmd_del_fail_mode, ""}, - {"set-fail-mode", 1, 2, cmd_set_fail_mode, ""}, - }; - - const struct vsctl_command *p; - int i; - - shash_init(&ctx->options); - for (i = 0; i < argc; i++) { - if (argv[i][0] != '-') { - break; - } - if (!shash_add_once(&ctx->options, argv[i], NULL)) { - vsctl_fatal("'%s' option specified multiple times", argv[i]); - } - } - if (i == argc) { - vsctl_fatal("missing command name"); - } - - for (p = all_commands; p < &all_commands[ARRAY_SIZE(all_commands)]; p++) { - if (!strcmp(p->name, argv[i])) { - struct shash_node *node; - int n_arg; - - SHASH_FOR_EACH (node, &ctx->options) { - const char *s = strstr(p->options, node->name); - int end = s ? s[strlen(node->name)] : EOF; - if (end != ',' && end != ' ' && end != '\0') { - vsctl_fatal("'%s' command has no '%s' option", - argv[i], node->name); - } - } - - n_arg = argc - i - 1; - if (n_arg < p->min_args) { - vsctl_fatal("'%s' command requires at least %d arguments", - p->name, p->min_args); - } else if (n_arg > p->max_args) { - vsctl_fatal("'%s' command takes at most %d arguments", - p->name, p->max_args); - } else { - ctx->argc = n_arg + 1; - ctx->argv = &argv[i]; - return p->handler; - } - } - } - - vsctl_fatal("unknown command '%s'; use --help for help", argv[i]); -} - -static void -check_vsctl_command(int argc, char *argv[]) -{ - struct vsctl_context ctx; - - get_vsctl_handler(argc, argv, &ctx); - shash_destroy(&ctx.options); -} - -static void -run_vsctl_command(int argc, char *argv[], - const struct ovsrec_open_vswitch *ovs, struct ds *output) -{ - vsctl_handler_func *function; - struct vsctl_context ctx; +static const struct vsctl_command_syntax all_commands[] = { + /* Open vSwitch commands. */ + {"init", 0, 0, cmd_init, NULL, ""}, + + /* Bridge commands. */ + {"add-br", 1, 3, cmd_add_br, NULL, ""}, + {"del-br", 1, 1, cmd_del_br, NULL, "--if-exists"}, + {"list-br", 0, 0, cmd_list_br, NULL, ""}, + {"br-exists", 1, 1, cmd_br_exists, NULL, ""}, + {"br-to-vlan", 1, 1, cmd_br_to_vlan, NULL, ""}, + {"br-to-parent", 1, 1, cmd_br_to_parent, NULL, ""}, + {"br-set-external-id", 2, 3, cmd_br_set_external_id, NULL, ""}, + {"br-get-external-id", 1, 2, cmd_br_get_external_id, NULL, ""}, + + /* Port commands. */ + {"list-ports", 1, 1, cmd_list_ports, NULL, ""}, + {"add-port", 2, 2, cmd_add_port, NULL, ""}, + {"add-bond", 4, INT_MAX, cmd_add_bond, NULL, "--fake-iface"}, + {"del-port", 1, 2, cmd_del_port, NULL, "--if-exists"}, + {"port-to-br", 1, 1, cmd_port_to_br, NULL, ""}, + + /* Interface commands. */ + {"list-ifaces", 1, 1, cmd_list_ifaces, NULL, ""}, + {"iface-to-br", 1, 1, cmd_iface_to_br, NULL, ""}, + + /* Controller commands. */ + {"get-controller", 0, 1, cmd_get_controller, NULL, ""}, + {"del-controller", 0, 1, cmd_del_controller, NULL, ""}, + {"set-controller", 1, 2, cmd_set_controller, NULL, ""}, + {"get-fail-mode", 0, 1, cmd_get_fail_mode, NULL, ""}, + {"del-fail-mode", 0, 1, cmd_del_fail_mode, NULL, ""}, + {"set-fail-mode", 1, 2, cmd_set_fail_mode, NULL, ""}, + + /* SSL commands. */ + {"get-ssl", 0, 0, cmd_get_ssl, NULL, ""}, + {"del-ssl", 0, 0, cmd_del_ssl, NULL, ""}, + {"set-ssl", 3, 3, cmd_set_ssl, NULL, "--bootstrap"}, + + /* Parameter commands. */ + {"get", 3, INT_MAX, cmd_get, NULL, "--if-exists"}, + {"list", 1, INT_MAX, cmd_list, NULL, ""}, + {"set", 3, INT_MAX, cmd_set, NULL, "--force"}, + {"add", 4, INT_MAX, cmd_add, NULL, "--force"}, + {"remove", 4, INT_MAX, cmd_remove, NULL, "--force"}, + {"clear", 3, INT_MAX, cmd_clear, NULL, "--force"}, + {"create", 2, INT_MAX, cmd_create, post_create, "--force"}, + {"destroy", 1, INT_MAX, cmd_destroy, NULL, "--force,--if-exists"}, + + {NULL, 0, 0, NULL, NULL, NULL}, +}; - function = get_vsctl_handler(argc, argv, &ctx); - ctx.ovs = ovs; - ds_init(&ctx.output); - function(&ctx); - *output = ctx.output; - shash_destroy(&ctx.options); -}