]> git.proxmox.com Git - mirror_ovs.git/blame - utilities/ovs-vsctl.c
ovs-ctl.in: Merge a single line function.
[mirror_ovs.git] / utilities / ovs-vsctl.c
CommitLineData
c75d1511 1/*
e99d41f7 2 * Copyright (c) 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
c75d1511
BP
3 *
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:
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
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.
15 */
16
17#include <config.h>
18
ad83bfa6 19#include <ctype.h>
c75d1511 20#include <errno.h>
ad83bfa6 21#include <float.h>
c75d1511
BP
22#include <getopt.h>
23#include <inttypes.h>
24#include <signal.h>
25#include <stdarg.h>
26#include <stdlib.h>
27#include <string.h>
6d5abe94 28#include <unistd.h>
c75d1511
BP
29
30#include "command-line.h"
31#include "compiler.h"
32#include "dirs.h"
33#include "dynamic-string.h"
a341ee57 34#include "hash.h"
b54e22e9 35#include "json.h"
ad83bfa6 36#include "ovsdb-data.h"
c75d1511
BP
37#include "ovsdb-idl.h"
38#include "poll-loop.h"
f8ff4bc4 39#include "process.h"
ae9a3235 40#include "stream.h"
218a6f59 41#include "stream-ssl.h"
a699f614 42#include "smap.h"
b3c01ed3 43#include "sset.h"
dfbe07ba 44#include "svec.h"
eaa67ba8 45#include "lib/vswitch-idl.h"
e051b42c 46#include "table.h"
c75d1511
BP
47#include "timeval.h"
48#include "util.h"
070723f9 49#include "vconn.h"
c75d1511 50#include "vlog.h"
5136ce49 51
d98e6007 52VLOG_DEFINE_THIS_MODULE(vsctl);
c75d1511 53
def90f62
BP
54/* vsctl_fatal() also logs the error, so it is preferred in this file. */
55#define ovs_fatal please_use_vsctl_fatal_instead_of_ovs_fatal
56
f8ff4bc4
BP
57struct vsctl_context;
58
e5e12280 59/* A command supported by ovs-vsctl. */
f8ff4bc4 60struct vsctl_command_syntax {
e5e12280
BP
61 const char *name; /* e.g. "add-br" */
62 int min_args; /* Min number of arguments following name. */
63 int max_args; /* Max number of arguments following name. */
64
65 /* If nonnull, calls ovsdb_idl_add_column() or ovsdb_idl_add_table() for
66 * each column or table in ctx->idl that it uses. */
67 void (*prerequisites)(struct vsctl_context *ctx);
68
69 /* Does the actual work of the command and puts the command's output, if
e051b42c 70 * any, in ctx->output or ctx->table.
e5e12280
BP
71 *
72 * Alternatively, if some prerequisite of the command is not met and the
73 * caller should wait for something to change and then retry, it may set
74 * ctx->try_again to true. (Only the "wait-until" command currently does
75 * this.) */
76 void (*run)(struct vsctl_context *ctx);
77
78 /* If nonnull, called after the transaction has been successfully
79 * committed. ctx->output is the output from the "run" function, which
80 * this function may modify and otherwise postprocess as needed. (Only the
81 * "create" command currently does any postprocessing.) */
82 void (*postprocess)(struct vsctl_context *ctx);
83
84 /* A comma-separated list of supported options, e.g. "--a,--b", or the
85 * empty string if the command does not support any options. */
f8ff4bc4 86 const char *options;
0c18b5a0 87 enum { RO, RW } mode; /* Does this command modify the database? */
f8ff4bc4
BP
88};
89
90struct vsctl_command {
91 /* Data that remains constant after initialization. */
92 const struct vsctl_command_syntax *syntax;
93 int argc;
94 char **argv;
95 struct shash options;
96
97 /* Data modified by commands. */
98 struct ds output;
e051b42c 99 struct table *table;
f8ff4bc4
BP
100};
101
c75d1511
BP
102/* --db: The database server to contact. */
103static const char *db;
104
105/* --oneline: Write each command's output as a single line? */
106static bool oneline;
107
577aebdf
BP
108/* --dry-run: Do not commit any changes. */
109static bool dry_run;
110
b54e22e9
BP
111/* --no-wait: Wait for ovs-vswitchd to reload its configuration? */
112static bool wait_for_reload = true;
113
a39a859a 114/* --timeout: Time to wait for a connection to 'db'. */
6b7b9d34 115static int timeout;
a39a859a 116
fba6bd1d
BP
117/* --retry: If true, ovs-vsctl will retry connecting to the database forever.
118 * If false and --db says to use an active connection method (e.g. "unix:",
119 * "tcp:", "ssl:"), then ovs-vsctl will try to connect once and exit with an
120 * error if the database server cannot be contacted (e.g. ovsdb-server is not
121 * running).
122 *
123 * Regardless of this setting, --timeout always limits how long ovs-vsctl will
124 * wait. */
125static bool retry;
126
e051b42c
BP
127/* Format for table output. */
128static struct table_style table_style = TABLE_STYLE_DEFAULT;
129
f8ff4bc4
BP
130/* All supported commands. */
131static const struct vsctl_command_syntax all_commands[];
132
1d48b4be
BP
133/* The IDL we're using and the current transaction, if any.
134 * This is for use by vsctl_exit() only, to allow it to clean up.
135 * Other code should use its context arguments. */
136static struct ovsdb_idl *the_idl;
137static struct ovsdb_idl_txn *the_idl_txn;
138
139static void vsctl_exit(int status) NO_RETURN;
c88b6a27 140static void vsctl_fatal(const char *, ...) PRINTF_FORMAT(1, 2) NO_RETURN;
c75d1511
BP
141static char *default_db(void);
142static void usage(void) NO_RETURN;
401d5a6d 143static void parse_options(int argc, char *argv[], struct shash *local_options);
0c18b5a0 144static bool might_write_to_db(char **argv);
c75d1511 145
f8ff4bc4 146static struct vsctl_command *parse_commands(int argc, char *argv[],
401d5a6d 147 struct shash *local_options,
f8ff4bc4 148 size_t *n_commandsp);
401d5a6d
BP
149static void parse_command(int argc, char *argv[], struct shash *local_options,
150 struct vsctl_command *);
1998cd4d 151static const struct vsctl_command_syntax *find_command(const char *name);
e5e12280
BP
152static void run_prerequisites(struct vsctl_command[], size_t n_commands,
153 struct ovsdb_idl *);
854a94d9
BP
154static void do_vsctl(const char *args, struct vsctl_command *, size_t n,
155 struct ovsdb_idl *);
c75d1511 156
18b239f5
BP
157static const struct vsctl_table_class *get_table(const char *table_name);
158static void set_column(const struct vsctl_table_class *,
ce5a3e38
BP
159 const struct ovsdb_idl_row *, const char *arg,
160 struct ovsdb_symbol_table *);
18b239f5 161
0a140468
BP
162static bool is_condition_satisfied(const struct vsctl_table_class *,
163 const struct ovsdb_idl_row *,
164 const char *arg,
165 struct ovsdb_symbol_table *);
166
c75d1511
BP
167int
168main(int argc, char *argv[])
169{
480ce8ab 170 extern struct vlog_module VLM_reconnect;
c75d1511 171 struct ovsdb_idl *idl;
f8ff4bc4 172 struct vsctl_command *commands;
401d5a6d 173 struct shash local_options;
854a94d9 174 unsigned int seqno;
f8ff4bc4
BP
175 size_t n_commands;
176 char *args;
c75d1511
BP
177
178 set_program_name(argv[0]);
179 signal(SIGPIPE, SIG_IGN);
480ce8ab
BP
180 vlog_set_levels(NULL, VLF_CONSOLE, VLL_WARN);
181 vlog_set_levels(&VLM_reconnect, VLF_ANY_FACILITY, VLL_WARN);
bd76d25d 182 ovsrec_init();
f8ff4bc4
BP
183
184 /* Log our arguments. This is often valuable for debugging systems. */
185 args = process_escape_args(argv);
0c18b5a0 186 VLOG(might_write_to_db(argv) ? VLL_INFO : VLL_DBG, "Called as %s", args);
f8ff4bc4
BP
187
188 /* Parse command line. */
401d5a6d
BP
189 shash_init(&local_options);
190 parse_options(argc, argv, &local_options);
191 commands = parse_commands(argc - optind, argv + optind, &local_options,
192 &n_commands);
c75d1511 193
a39a859a
JP
194 if (timeout) {
195 time_alarm(timeout);
196 }
197
e5e12280 198 /* Initialize IDL. */
fba6bd1d 199 idl = the_idl = ovsdb_idl_create(db, &ovsrec_idl_class, false, retry);
e5e12280
BP
200 run_prerequisites(commands, n_commands, idl);
201
854a94d9
BP
202 /* Execute the commands.
203 *
204 * 'seqno' is the database sequence number for which we last tried to
205 * execute our transaction. There's no point in trying to commit more than
206 * once for any given sequence number, because if the transaction fails
207 * it's because the database changed and we need to obtain an up-to-date
208 * view of the database before we try the transaction again. */
209 seqno = ovsdb_idl_get_seqno(idl);
c75d1511 210 for (;;) {
854a94d9 211 ovsdb_idl_run(idl);
fba6bd1d
BP
212 if (!ovsdb_idl_is_alive(idl)) {
213 int retval = ovsdb_idl_get_last_error(idl);
214 vsctl_fatal("%s: database connection failed (%s)",
215 db, ovs_retval_to_string(retval));
216 }
854a94d9
BP
217
218 if (seqno != ovsdb_idl_get_seqno(idl)) {
219 seqno = ovsdb_idl_get_seqno(idl);
220 do_vsctl(args, commands, n_commands, idl);
c75d1511
BP
221 }
222
854a94d9 223 if (seqno == ovsdb_idl_get_seqno(idl)) {
4fdfe5cc
BP
224 ovsdb_idl_wait(idl);
225 poll_block();
226 }
c75d1511
BP
227 }
228}
229
401d5a6d
BP
230static struct option *
231find_option(const char *name, struct option *options, size_t n_options)
232{
233 size_t i;
234
235 for (i = 0; i < n_options; i++) {
236 if (!strcmp(options[i].name, name)) {
237 return &options[i];
238 }
239 }
240 return NULL;
241}
242
243static struct option *
244add_option(struct option **optionsp, size_t *n_optionsp,
245 size_t *allocated_optionsp)
246{
247 if (*n_optionsp >= *allocated_optionsp) {
248 *optionsp = x2nrealloc(*optionsp, allocated_optionsp,
249 sizeof **optionsp);
250 }
251 return &(*optionsp)[(*n_optionsp)++];
252}
253
c75d1511 254static void
401d5a6d 255parse_options(int argc, char *argv[], struct shash *local_options)
c75d1511
BP
256{
257 enum {
258 OPT_DB = UCHAR_MAX + 1,
259 OPT_ONELINE,
0c3dd1e1 260 OPT_NO_SYSLOG,
577aebdf 261 OPT_NO_WAIT,
e26b5a06 262 OPT_DRY_RUN,
218a6f59 263 OPT_PEER_CA_CERT,
401d5a6d 264 OPT_LOCAL,
fba6bd1d 265 OPT_RETRY,
e051b42c
BP
266 VLOG_OPTION_ENUMS,
267 TABLE_OPTION_ENUMS
c75d1511 268 };
401d5a6d 269 static const struct option global_long_options[] = {
e3c17733
BP
270 {"db", required_argument, NULL, OPT_DB},
271 {"no-syslog", no_argument, NULL, OPT_NO_SYSLOG},
272 {"no-wait", no_argument, NULL, OPT_NO_WAIT},
273 {"dry-run", no_argument, NULL, OPT_DRY_RUN},
274 {"oneline", no_argument, NULL, OPT_ONELINE},
275 {"timeout", required_argument, NULL, 't'},
fba6bd1d 276 {"retry", no_argument, NULL, OPT_RETRY},
e3c17733
BP
277 {"help", no_argument, NULL, 'h'},
278 {"version", no_argument, NULL, 'V'},
e26b5a06 279 VLOG_LONG_OPTIONS,
e051b42c 280 TABLE_LONG_OPTIONS,
bf8f2167 281 STREAM_SSL_LONG_OPTIONS,
e3c17733
BP
282 {"peer-ca-cert", required_argument, NULL, OPT_PEER_CA_CERT},
283 {NULL, 0, NULL, 0},
c75d1511 284 };
401d5a6d 285 const int n_global_long_options = ARRAY_SIZE(global_long_options) - 1;
a2a9d2d9 286 char *tmp, *short_options;
c75d1511 287
401d5a6d
BP
288 const struct vsctl_command_syntax *p;
289 struct option *options, *o;
290 size_t allocated_options;
291 size_t n_options;
292 size_t i;
293
294 tmp = long_options_to_short_options(global_long_options);
a2a9d2d9
BP
295 short_options = xasprintf("+%s", tmp);
296 free(tmp);
342045e1 297
401d5a6d
BP
298 /* We want to parse both global and command-specific options here, but
299 * getopt_long() isn't too convenient for the job. We copy our global
300 * options into a dynamic array, then append all of the command-specific
301 * options. */
302 options = xmemdup(global_long_options, sizeof global_long_options);
303 allocated_options = ARRAY_SIZE(global_long_options);
304 n_options = n_global_long_options;
305 for (p = all_commands; p->name; p++) {
306 if (p->options[0]) {
307 char *save_ptr = NULL;
308 char *name;
309 char *s;
310
311 s = xstrdup(p->options);
312 for (name = strtok_r(s, ",", &save_ptr); name != NULL;
313 name = strtok_r(NULL, ",", &save_ptr)) {
314 char *equals;
315 int has_arg;
316
cb22974d 317 ovs_assert(name[0] == '-' && name[1] == '-' && name[2]);
401d5a6d
BP
318 name += 2;
319
320 equals = strchr(name, '=');
321 if (equals) {
322 has_arg = required_argument;
323 *equals = '\0';
324 } else {
325 has_arg = no_argument;
326 }
327
328 o = find_option(name, options, n_options);
329 if (o) {
cb22974d
BP
330 ovs_assert(o - options >= n_global_long_options);
331 ovs_assert(o->has_arg == has_arg);
401d5a6d
BP
332 } else {
333 o = add_option(&options, &n_options, &allocated_options);
334 o->name = xstrdup(name);
335 o->has_arg = has_arg;
336 o->flag = NULL;
337 o->val = OPT_LOCAL;
338 }
339 }
340
341 free(s);
342 }
343 }
344 o = add_option(&options, &n_options, &allocated_options);
345 memset(o, 0, sizeof *o);
346
e051b42c
BP
347 table_style.format = TF_LIST;
348
c75d1511 349 for (;;) {
401d5a6d 350 int idx;
c75d1511
BP
351 int c;
352
401d5a6d 353 c = getopt_long(argc, argv, short_options, options, &idx);
c75d1511
BP
354 if (c == -1) {
355 break;
356 }
357
358 switch (c) {
359 case OPT_DB:
360 db = optarg;
361 break;
362
363 case OPT_ONELINE:
364 oneline = true;
365 break;
366
dfbe07ba 367 case OPT_NO_SYSLOG:
480ce8ab 368 vlog_set_levels(&VLM_vsctl, VLF_SYSLOG, VLL_WARN);
dfbe07ba
BP
369 break;
370
0c3dd1e1 371 case OPT_NO_WAIT:
b54e22e9 372 wait_for_reload = false;
0c3dd1e1
BP
373 break;
374
577aebdf
BP
375 case OPT_DRY_RUN:
376 dry_run = true;
377 break;
378
401d5a6d
BP
379 case OPT_LOCAL:
380 if (shash_find(local_options, options[idx].name)) {
381 vsctl_fatal("'%s' option specified multiple times",
382 options[idx].name);
383 }
384 shash_add_nocopy(local_options,
385 xasprintf("--%s", options[idx].name),
386 optarg ? xstrdup(optarg) : NULL);
387 break;
388
c75d1511
BP
389 case 'h':
390 usage();
391
392 case 'V':
55d5bb44 393 ovs_print_version(0, 0);
c75d1511
BP
394 exit(EXIT_SUCCESS);
395
342045e1
BP
396 case 't':
397 timeout = strtoul(optarg, NULL, 10);
a39a859a 398 if (timeout < 0) {
def90f62
BP
399 vsctl_fatal("value %s on -t or --timeout is invalid",
400 optarg);
342045e1
BP
401 }
402 break;
403
fba6bd1d
BP
404 case OPT_RETRY:
405 retry = true;
406 break;
407
e26b5a06 408 VLOG_OPTION_HANDLERS
e051b42c 409 TABLE_OPTION_HANDLERS(&table_style)
c75d1511 410
218a6f59
BP
411 STREAM_SSL_OPTION_HANDLERS
412
413 case OPT_PEER_CA_CERT:
414 stream_ssl_set_peer_ca_cert_file(optarg);
415 break;
218a6f59 416
c75d1511
BP
417 case '?':
418 exit(EXIT_FAILURE);
419
420 default:
421 abort();
422 }
423 }
a2a9d2d9 424 free(short_options);
c75d1511
BP
425
426 if (!db) {
427 db = default_db();
428 }
401d5a6d
BP
429
430 for (i = n_global_long_options; options[i].name; i++) {
431 free(CONST_CAST(char *, options[i].name));
432 }
433 free(options);
c75d1511
BP
434}
435
f8ff4bc4 436static struct vsctl_command *
401d5a6d
BP
437parse_commands(int argc, char *argv[], struct shash *local_options,
438 size_t *n_commandsp)
f8ff4bc4
BP
439{
440 struct vsctl_command *commands;
441 size_t n_commands, allocated_commands;
442 int i, start;
443
444 commands = NULL;
445 n_commands = allocated_commands = 0;
446
447 for (start = i = 0; i <= argc; i++) {
448 if (i == argc || !strcmp(argv[i], "--")) {
449 if (i > start) {
450 if (n_commands >= allocated_commands) {
451 struct vsctl_command *c;
452
453 commands = x2nrealloc(commands, &allocated_commands,
454 sizeof *commands);
455 for (c = commands; c < &commands[n_commands]; c++) {
456 shash_moved(&c->options);
457 }
458 }
401d5a6d 459 parse_command(i - start, &argv[start], local_options,
f8ff4bc4 460 &commands[n_commands++]);
401d5a6d
BP
461 } else if (!shash_is_empty(local_options)) {
462 vsctl_fatal("missing command name (use --help for help)");
f8ff4bc4
BP
463 }
464 start = i + 1;
465 }
466 }
467 if (!n_commands) {
468 vsctl_fatal("missing command name (use --help for help)");
469 }
470 *n_commandsp = n_commands;
471 return commands;
472}
473
474static void
401d5a6d
BP
475parse_command(int argc, char *argv[], struct shash *local_options,
476 struct vsctl_command *command)
f8ff4bc4
BP
477{
478 const struct vsctl_command_syntax *p;
1998cd4d
BP
479 struct shash_node *node;
480 int n_arg;
f8ff4bc4
BP
481 int i;
482
483 shash_init(&command->options);
401d5a6d 484 shash_swap(local_options, &command->options);
f8ff4bc4 485 for (i = 0; i < argc; i++) {
4a033593
BP
486 const char *option = argv[i];
487 const char *equals;
488 char *key, *value;
489
490 if (option[0] != '-') {
f8ff4bc4
BP
491 break;
492 }
4a033593
BP
493
494 equals = strchr(option, '=');
495 if (equals) {
496 key = xmemdup0(option, equals - option);
497 value = xstrdup(equals + 1);
498 } else {
499 key = xstrdup(option);
500 value = NULL;
501 }
502
503 if (shash_find(&command->options, key)) {
f8ff4bc4
BP
504 vsctl_fatal("'%s' option specified multiple times", argv[i]);
505 }
4a033593 506 shash_add_nocopy(&command->options, key, value);
f8ff4bc4
BP
507 }
508 if (i == argc) {
401d5a6d 509 vsctl_fatal("missing command name (use --help for help)");
f8ff4bc4
BP
510 }
511
1998cd4d
BP
512 p = find_command(argv[i]);
513 if (!p) {
514 vsctl_fatal("unknown command '%s'; use --help for help", argv[i]);
515 }
f8ff4bc4 516
1998cd4d
BP
517 SHASH_FOR_EACH (node, &command->options) {
518 const char *s = strstr(p->options, node->name);
519 int end = s ? s[strlen(node->name)] : EOF;
4a033593 520
1998cd4d
BP
521 if (end != '=' && end != ',' && end != ' ' && end != '\0') {
522 vsctl_fatal("'%s' command has no '%s' option",
523 argv[i], node->name);
524 }
525 if ((end == '=') != (node->data != NULL)) {
526 if (end == '=') {
527 vsctl_fatal("missing argument to '%s' option on '%s' "
528 "command", node->name, argv[i]);
529 } else {
530 vsctl_fatal("'%s' option on '%s' does not accept an "
531 "argument", node->name, argv[i]);
f8ff4bc4 532 }
1998cd4d
BP
533 }
534 }
f8ff4bc4 535
1998cd4d
BP
536 n_arg = argc - i - 1;
537 if (n_arg < p->min_args) {
538 vsctl_fatal("'%s' command requires at least %d arguments",
539 p->name, p->min_args);
540 } else if (n_arg > p->max_args) {
541 int j;
542
543 for (j = i + 1; j < argc; j++) {
544 if (argv[j][0] == '-') {
545 vsctl_fatal("'%s' command takes at most %d arguments "
546 "(note that options must precede command "
547 "names and follow a \"--\" argument)",
f8ff4bc4 548 p->name, p->max_args);
f8ff4bc4
BP
549 }
550 }
1998cd4d
BP
551
552 vsctl_fatal("'%s' command takes at most %d arguments",
553 p->name, p->max_args);
554 }
555
556 command->syntax = p;
557 command->argc = n_arg + 1;
558 command->argv = &argv[i];
559}
560
561/* Returns the "struct vsctl_command_syntax" for a given command 'name', or a
562 * null pointer if there is none. */
563static const struct vsctl_command_syntax *
564find_command(const char *name)
565{
566 static struct shash commands = SHASH_INITIALIZER(&commands);
567
568 if (shash_is_empty(&commands)) {
569 const struct vsctl_command_syntax *p;
570
571 for (p = all_commands; p->name; p++) {
572 shash_add_assert(&commands, p->name, p);
573 }
f8ff4bc4
BP
574 }
575
1998cd4d 576 return shash_find_data(&commands, name);
f8ff4bc4
BP
577}
578
579static void
580vsctl_fatal(const char *format, ...)
581{
582 char *message;
583 va_list args;
584
585 va_start(args, format);
586 message = xvasprintf(format, args);
587 va_end(args);
588
c1a543a8 589 vlog_set_levels(&VLM_vsctl, VLF_CONSOLE, VLL_OFF);
f8ff4bc4 590 VLOG_ERR("%s", message);
def90f62 591 ovs_error(0, "%s", message);
1d48b4be
BP
592 vsctl_exit(EXIT_FAILURE);
593}
594
595/* Frees the current transaction and the underlying IDL and then calls
596 * exit(status).
597 *
598 * Freeing the transaction and the IDL is not strictly necessary, but it makes
599 * for a clean memory leak report from valgrind in the normal case. That makes
600 * it easier to notice real memory leaks. */
601static void
602vsctl_exit(int status)
603{
604 if (the_idl_txn) {
605 ovsdb_idl_txn_abort(the_idl_txn);
606 ovsdb_idl_txn_destroy(the_idl_txn);
607 }
608 ovsdb_idl_destroy(the_idl);
609 exit(status);
f8ff4bc4
BP
610}
611
c75d1511
BP
612static void
613usage(void)
614{
8f7501e8
BP
615 printf("\
616%s: ovs-vswitchd management utility\n\
617usage: %s [OPTIONS] COMMAND [ARG...]\n\
618\n\
ae9a3235
BP
619Open vSwitch commands:\n\
620 init initialize database, if not yet initialized\n\
9b1735a7 621 show print overview of database contents\n\
ae9a3235
BP
622 emer-reset reset configuration to clean state\n\
623\n\
8f7501e8
BP
624Bridge commands:\n\
625 add-br BRIDGE create a new bridge named BRIDGE\n\
626 add-br BRIDGE PARENT VLAN create new fake BRIDGE in PARENT on VLAN\n\
627 del-br BRIDGE delete BRIDGE and all of its ports\n\
628 list-br print the names of all the bridges\n\
b5fcae50 629 br-exists BRIDGE exit 2 if BRIDGE does not exist\n\
8f7501e8
BP
630 br-to-vlan BRIDGE print the VLAN which BRIDGE is on\n\
631 br-to-parent BRIDGE print the parent of BRIDGE\n\
632 br-set-external-id BRIDGE KEY VALUE set KEY on BRIDGE to VALUE\n\
633 br-set-external-id BRIDGE KEY unset KEY on BRIDGE\n\
634 br-get-external-id BRIDGE KEY print value of KEY on BRIDGE\n\
635 br-get-external-id BRIDGE list key-value pairs on BRIDGE\n\
636\n\
ae9a3235 637Port commands (a bond is considered to be a single port):\n\
8f7501e8
BP
638 list-ports BRIDGE print the names of all the ports on BRIDGE\n\
639 add-port BRIDGE PORT add network device PORT to BRIDGE\n\
640 add-bond BRIDGE PORT IFACE... add bonded port PORT in BRIDGE from IFACES\n\
641 del-port [BRIDGE] PORT delete PORT (which may be bonded) from BRIDGE\n\
642 port-to-br PORT print name of bridge that contains PORT\n\
8f7501e8
BP
643\n\
644Interface commands (a bond consists of multiple interfaces):\n\
645 list-ifaces BRIDGE print the names of all interfaces on BRIDGE\n\
646 iface-to-br IFACE print name of bridge that contains IFACE\n\
8f7501e8
BP
647\n\
648Controller commands:\n\
a892775d
BP
649 get-controller BRIDGE print the controllers for BRIDGE\n\
650 del-controller BRIDGE delete the controllers for BRIDGE\n\
651 set-controller BRIDGE TARGET... set the controllers for BRIDGE\n\
1a048029
JP
652 get-fail-mode BRIDGE print the fail-mode for BRIDGE\n\
653 del-fail-mode BRIDGE delete the fail-mode for BRIDGE\n\
654 set-fail-mode BRIDGE MODE set the fail-mode for BRIDGE to MODE\n\
8f7501e8 655\n\
24b8b259 656Manager commands:\n\
a892775d
BP
657 get-manager print the managers\n\
658 del-manager delete the managers\n\
659 set-manager TARGET... set the list of managers to TARGET...\n\
24b8b259 660\n\
8f7501e8
BP
661SSL commands:\n\
662 get-ssl print the SSL configuration\n\
663 del-ssl delete the SSL configuration\n\
664 set-ssl PRIV-KEY CERT CA-CERT set the SSL configuration\n\
665\n\
18ee958b
JP
666Switch commands:\n\
667 emer-reset reset switch to known good state\n\
668\n\
8f7501e8
BP
669Database commands:\n\
670 list TBL [REC] list RECord (or all records) in TBL\n\
0a140468 671 find TBL CONDITION... list records satisfying CONDITION in TBL\n\
4f1361e8 672 get TBL REC COL[:KEY] print values of COLumns in RECord in TBL\n\
8f7501e8
BP
673 set TBL REC COL[:KEY]=VALUE set COLumn values in RECord in TBL\n\
674 add TBL REC COL [KEY=]VALUE add (KEY=)VALUE to COLumn in RECord in TBL\n\
675 remove TBL REC COL [KEY=]VALUE remove (KEY=)VALUE from COLumn\n\
676 clear TBL REC COL clear values from COLumn in RECord in TBL\n\
677 create TBL COL[:KEY]=VALUE create and initialize new record\n\
4f1361e8 678 destroy TBL REC delete RECord from TBL\n\
7db03f7c 679 wait-until TBL REC [COL[:KEY]=VALUE] wait until condition is true\n\
8f7501e8
BP
680Potentially unsafe database commands require --force option.\n\
681\n\
682Options:\n\
683 --db=DATABASE connect to DATABASE\n\
684 (default: %s)\n\
ae9a3235 685 --no-wait do not wait for ovs-vswitchd to reconfigure\n\
fba6bd1d 686 --retry keep trying to connect to server forever\n\
ae9a3235
BP
687 -t, --timeout=SECS wait at most SECS seconds for ovs-vswitchd\n\
688 --dry-run do not commit changes to database\n\
8f7501e8
BP
689 --oneline print exactly one line of output per command\n",
690 program_name, program_name, default_db());
c75d1511 691 vlog_usage();
ae9a3235
BP
692 printf("\
693 --no-syslog equivalent to --verbose=vsctl:syslog:warn\n");
694 stream_usage("database", true, true, false);
8f7501e8
BP
695 printf("\n\
696Other options:\n\
697 -h, --help display this help message\n\
698 -V, --version display version information\n");
c75d1511
BP
699 exit(EXIT_SUCCESS);
700}
701
702static char *
703default_db(void)
704{
705 static char *def;
706 if (!def) {
b43c6fe2 707 def = xasprintf("unix:%s/db.sock", ovs_rundir());
c75d1511
BP
708 }
709 return def;
710}
0c18b5a0
BP
711
712/* Returns true if it looks like this set of arguments might modify the
713 * database, otherwise false. (Not very smart, so it's prone to false
714 * positives.) */
715static bool
716might_write_to_db(char **argv)
717{
718 for (; *argv; argv++) {
719 const struct vsctl_command_syntax *p = find_command(*argv);
720 if (p && p->mode == RW) {
721 return true;
722 }
723 }
724 return false;
725}
c75d1511 726\f
5d9cb63c 727struct vsctl_context {
f8ff4bc4 728 /* Read-only. */
5d9cb63c
BP
729 int argc;
730 char **argv;
f8ff4bc4
BP
731 struct shash options;
732
733 /* Modifiable state. */
734 struct ds output;
e051b42c 735 struct table *table;
ad83bfa6 736 struct ovsdb_idl *idl;
f8ff4bc4 737 struct ovsdb_idl_txn *txn;
ce5a3e38 738 struct ovsdb_symbol_table *symtab;
5d9cb63c 739 const struct ovsrec_open_vswitch *ovs;
f74055e7 740 bool verified_ports;
87b23a01 741
5ce5a6b5
BP
742 /* A cache of the contents of the database.
743 *
744 * A command that needs to use any of this information must first call
745 * vsctl_context_populate_cache(). A command that changes anything that
746 * could invalidate the cache must either call
747 * vsctl_context_invalidate_cache() or manually update the cache to
748 * maintain its correctness. */
749 bool cache_valid;
750 struct shash bridges; /* Maps from bridge name to struct vsctl_bridge. */
751 struct shash ports; /* Maps from port name to struct vsctl_port. */
752 struct shash ifaces; /* Maps from port name to struct vsctl_iface. */
753
87b23a01
BP
754 /* A command may set this member to true if some prerequisite is not met
755 * and the caller should wait for something to change and then retry. */
756 bool try_again;
5d9cb63c
BP
757};
758
c75d1511
BP
759struct vsctl_bridge {
760 struct ovsrec_bridge *br_cfg;
761 char *name;
a341ee57 762 struct list ports; /* Contains "struct vsctl_port"s. */
5341d046
BP
763
764 /* VLAN ("fake") bridge support.
765 *
766 * Use 'parent != NULL' to detect a fake bridge, because 'vlan' can be 0
767 * in either case. */
a341ee57
BP
768 struct hmap children; /* VLAN bridges indexed by 'vlan'. */
769 struct hmap_node children_node; /* Node in parent's 'children' hmap. */
5341d046
BP
770 struct vsctl_bridge *parent; /* Real bridge, or NULL. */
771 int vlan; /* VLAN VID (0...4095), or 0. */
c75d1511
BP
772};
773
774struct vsctl_port {
a341ee57
BP
775 struct list ports_node; /* In struct vsctl_bridge's 'ports' list. */
776 struct list ifaces; /* Contains "struct vsctl_iface"s. */
c75d1511
BP
777 struct ovsrec_port *port_cfg;
778 struct vsctl_bridge *bridge;
779};
780
781struct vsctl_iface {
a341ee57 782 struct list ifaces_node; /* In struct vsctl_port's 'ifaces' list. */
c75d1511
BP
783 struct ovsrec_interface *iface_cfg;
784 struct vsctl_port *port;
785};
786
bb1c67c8
BP
787static char *
788vsctl_context_to_string(const struct vsctl_context *ctx)
789{
790 const struct shash_node *node;
791 struct svec words;
792 char *s;
793 int i;
794
795 svec_init(&words);
796 SHASH_FOR_EACH (node, &ctx->options) {
797 svec_add(&words, node->name);
798 }
799 for (i = 0; i < ctx->argc; i++) {
800 svec_add(&words, ctx->argv[i]);
801 }
802 svec_terminate(&words);
803
804 s = process_escape_args(words.names);
805
806 svec_destroy(&words);
807
808 return s;
809}
810
f74055e7
BP
811static void
812verify_ports(struct vsctl_context *ctx)
813{
814 if (!ctx->verified_ports) {
815 const struct ovsrec_bridge *bridge;
816 const struct ovsrec_port *port;
817
818 ovsrec_open_vswitch_verify_bridges(ctx->ovs);
819 OVSREC_BRIDGE_FOR_EACH (bridge, ctx->idl) {
820 ovsrec_bridge_verify_ports(bridge);
821 }
822 OVSREC_PORT_FOR_EACH (port, ctx->idl) {
823 ovsrec_port_verify_interfaces(port);
824 }
825
826 ctx->verified_ports = true;
827 }
828}
829
c75d1511 830static struct vsctl_bridge *
a341ee57
BP
831add_bridge_to_cache(struct vsctl_context *ctx,
832 struct ovsrec_bridge *br_cfg, const char *name,
833 struct vsctl_bridge *parent, int vlan)
c75d1511
BP
834{
835 struct vsctl_bridge *br = xmalloc(sizeof *br);
836 br->br_cfg = br_cfg;
837 br->name = xstrdup(name);
a341ee57 838 list_init(&br->ports);
c75d1511
BP
839 br->parent = parent;
840 br->vlan = vlan;
a341ee57
BP
841 hmap_init(&br->children);
842 if (parent) {
843 hmap_insert(&parent->children, &br->children_node, hash_int(vlan, 0));
844 }
5ce5a6b5 845 shash_add(&ctx->bridges, br->name, br);
c75d1511
BP
846 return br;
847}
848
a341ee57
BP
849static void
850ovs_delete_bridge(const struct ovsrec_open_vswitch *ovs,
851 struct ovsrec_bridge *bridge)
852{
853 struct ovsrec_bridge **bridges;
854 size_t i, n;
855
856 bridges = xmalloc(sizeof *ovs->bridges * ovs->n_bridges);
857 for (i = n = 0; i < ovs->n_bridges; i++) {
858 if (ovs->bridges[i] != bridge) {
859 bridges[n++] = ovs->bridges[i];
860 }
861 }
862 ovsrec_open_vswitch_set_bridges(ovs, bridges, n);
863 free(bridges);
864}
865
866static void
867del_cached_bridge(struct vsctl_context *ctx, struct vsctl_bridge *br)
868{
cb22974d
BP
869 ovs_assert(list_is_empty(&br->ports));
870 ovs_assert(hmap_is_empty(&br->children));
a341ee57
BP
871 if (br->parent) {
872 hmap_remove(&br->parent->children, &br->children_node);
873 }
874 if (br->br_cfg) {
875 ovsrec_bridge_delete(br->br_cfg);
876 ovs_delete_bridge(ctx->ovs, br->br_cfg);
877 }
878 shash_find_and_delete(&ctx->bridges, br->name);
879 hmap_destroy(&br->children);
880 free(br->name);
881 free(br);
882}
883
c75d1511
BP
884static bool
885port_is_fake_bridge(const struct ovsrec_port *port_cfg)
886{
887 return (port_cfg->fake_bridge
888 && port_cfg->tag
5341d046 889 && *port_cfg->tag >= 0 && *port_cfg->tag <= 4095);
c75d1511
BP
890}
891
892static struct vsctl_bridge *
a341ee57 893find_vlan_bridge(struct vsctl_bridge *parent, int vlan)
c75d1511 894{
a341ee57 895 struct vsctl_bridge *child;
c75d1511 896
a341ee57
BP
897 HMAP_FOR_EACH_IN_BUCKET (child, children_node, hash_int(vlan, 0),
898 &parent->children) {
899 if (child->vlan == vlan) {
900 return child;
c75d1511
BP
901 }
902 }
903
904 return NULL;
905}
906
a341ee57
BP
907static struct vsctl_port *
908add_port_to_cache(struct vsctl_context *ctx, struct vsctl_bridge *parent,
909 struct ovsrec_port *port_cfg)
910{
911 struct vsctl_port *port;
912
913 if (port_cfg->tag
914 && *port_cfg->tag >= 0 && *port_cfg->tag <= 4095) {
915 struct vsctl_bridge *vlan_bridge;
916
917 vlan_bridge = find_vlan_bridge(parent, *port_cfg->tag);
918 if (vlan_bridge) {
919 parent = vlan_bridge;
920 }
921 }
922
923 port = xmalloc(sizeof *port);
924 list_push_back(&parent->ports, &port->ports_node);
925 list_init(&port->ifaces);
926 port->port_cfg = port_cfg;
927 port->bridge = parent;
928 shash_add(&ctx->ports, port_cfg->name, port);
929
930 return port;
931}
932
933static void
934del_cached_port(struct vsctl_context *ctx, struct vsctl_port *port)
935{
cb22974d 936 ovs_assert(list_is_empty(&port->ifaces));
a341ee57
BP
937 list_remove(&port->ports_node);
938 shash_find_and_delete(&ctx->ports, port->port_cfg->name);
939 ovsrec_port_delete(port->port_cfg);
940 free(port);
941}
942
943static struct vsctl_iface *
944add_iface_to_cache(struct vsctl_context *ctx, struct vsctl_port *parent,
945 struct ovsrec_interface *iface_cfg)
946{
947 struct vsctl_iface *iface;
948
949 iface = xmalloc(sizeof *iface);
950 list_push_back(&parent->ifaces, &iface->ifaces_node);
951 iface->iface_cfg = iface_cfg;
952 iface->port = parent;
953 shash_add(&ctx->ifaces, iface_cfg->name, iface);
954
955 return iface;
956}
957
958static void
959del_cached_iface(struct vsctl_context *ctx, struct vsctl_iface *iface)
960{
961 list_remove(&iface->ifaces_node);
962 shash_find_and_delete(&ctx->ifaces, iface->iface_cfg->name);
963 ovsrec_interface_delete(iface->iface_cfg);
964 free(iface);
965}
966
c75d1511 967static void
5ce5a6b5 968vsctl_context_invalidate_cache(struct vsctl_context *ctx)
c75d1511
BP
969{
970 struct shash_node *node;
971
5ce5a6b5
BP
972 if (!ctx->cache_valid) {
973 return;
974 }
975 ctx->cache_valid = false;
976
977 SHASH_FOR_EACH (node, &ctx->bridges) {
c75d1511 978 struct vsctl_bridge *bridge = node->data;
a341ee57 979 hmap_destroy(&bridge->children);
c75d1511
BP
980 free(bridge->name);
981 free(bridge);
982 }
5ce5a6b5 983 shash_destroy(&ctx->bridges);
c75d1511 984
5ce5a6b5
BP
985 shash_destroy_free_data(&ctx->ports);
986 shash_destroy_free_data(&ctx->ifaces);
c75d1511
BP
987}
988
e5e12280
BP
989static void
990pre_get_info(struct vsctl_context *ctx)
991{
992 ovsdb_idl_add_column(ctx->idl, &ovsrec_open_vswitch_col_bridges);
993
994 ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_name);
995 ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_controller);
996 ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_fail_mode);
997 ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_ports);
998
999 ovsdb_idl_add_column(ctx->idl, &ovsrec_port_col_name);
1000 ovsdb_idl_add_column(ctx->idl, &ovsrec_port_col_fake_bridge);
1001 ovsdb_idl_add_column(ctx->idl, &ovsrec_port_col_tag);
1002 ovsdb_idl_add_column(ctx->idl, &ovsrec_port_col_interfaces);
1003
1004 ovsdb_idl_add_column(ctx->idl, &ovsrec_interface_col_name);
1005}
1006
c75d1511 1007static void
5ce5a6b5 1008vsctl_context_populate_cache(struct vsctl_context *ctx)
c75d1511 1009{
1588bb8d 1010 const struct ovsrec_open_vswitch *ovs = ctx->ovs;
b3c01ed3 1011 struct sset bridges, ports;
c75d1511
BP
1012 size_t i;
1013
5ce5a6b5
BP
1014 if (ctx->cache_valid) {
1015 /* Cache is already populated. */
1016 return;
1017 }
1018 ctx->cache_valid = true;
1019 shash_init(&ctx->bridges);
1020 shash_init(&ctx->ports);
1021 shash_init(&ctx->ifaces);
c75d1511 1022
b3c01ed3
BP
1023 sset_init(&bridges);
1024 sset_init(&ports);
c75d1511
BP
1025 for (i = 0; i < ovs->n_bridges; i++) {
1026 struct ovsrec_bridge *br_cfg = ovs->bridges[i];
1027 struct vsctl_bridge *br;
1028 size_t j;
1029
b3c01ed3 1030 if (!sset_add(&bridges, br_cfg->name)) {
c75d1511
BP
1031 VLOG_WARN("%s: database contains duplicate bridge name",
1032 br_cfg->name);
1033 continue;
1034 }
a341ee57 1035 br = add_bridge_to_cache(ctx, br_cfg, br_cfg->name, NULL, 0);
c75d1511
BP
1036 if (!br) {
1037 continue;
1038 }
1039
1040 for (j = 0; j < br_cfg->n_ports; j++) {
1041 struct ovsrec_port *port_cfg = br_cfg->ports[j];
1042
b3c01ed3 1043 if (!sset_add(&ports, port_cfg->name)) {
48a69501 1044 /* Duplicate port name. (We will warn about that later.) */
c75d1511
BP
1045 continue;
1046 }
1047
1048 if (port_is_fake_bridge(port_cfg)
b3c01ed3 1049 && sset_add(&bridges, port_cfg->name)) {
a341ee57
BP
1050 add_bridge_to_cache(ctx, NULL, port_cfg->name, br,
1051 *port_cfg->tag);
c75d1511
BP
1052 }
1053 }
1054 }
b3c01ed3
BP
1055 sset_destroy(&bridges);
1056 sset_destroy(&ports);
c75d1511 1057
b3c01ed3 1058 sset_init(&bridges);
c75d1511
BP
1059 for (i = 0; i < ovs->n_bridges; i++) {
1060 struct ovsrec_bridge *br_cfg = ovs->bridges[i];
1061 struct vsctl_bridge *br;
1062 size_t j;
1063
b3c01ed3 1064 if (!sset_add(&bridges, br_cfg->name)) {
c75d1511
BP
1065 continue;
1066 }
5ce5a6b5 1067 br = shash_find_data(&ctx->bridges, br_cfg->name);
c75d1511
BP
1068 for (j = 0; j < br_cfg->n_ports; j++) {
1069 struct ovsrec_port *port_cfg = br_cfg->ports[j];
1070 struct vsctl_port *port;
1071 size_t k;
1072
5ce5a6b5 1073 port = shash_find_data(&ctx->ports, port_cfg->name);
48a69501
BP
1074 if (port) {
1075 if (port_cfg == port->port_cfg) {
1076 VLOG_WARN("%s: port is in multiple bridges (%s and %s)",
1077 port_cfg->name, br->name, port->bridge->name);
1078 } else {
1079 /* Log as an error because this violates the database's
1080 * uniqueness constraints, so the database server shouldn't
1081 * have allowed it. */
1082 VLOG_ERR("%s: database contains duplicate port name",
1083 port_cfg->name);
1084 }
c75d1511
BP
1085 continue;
1086 }
1087
1088 if (port_is_fake_bridge(port_cfg)
b3c01ed3 1089 && !sset_add(&bridges, port_cfg->name)) {
c75d1511
BP
1090 continue;
1091 }
1092
a341ee57 1093 port = add_port_to_cache(ctx, br, port_cfg);
c75d1511
BP
1094 for (k = 0; k < port_cfg->n_interfaces; k++) {
1095 struct ovsrec_interface *iface_cfg = port_cfg->interfaces[k];
1096 struct vsctl_iface *iface;
1097
5ce5a6b5 1098 iface = shash_find_data(&ctx->ifaces, iface_cfg->name);
48a69501
BP
1099 if (iface) {
1100 if (iface_cfg == iface->iface_cfg) {
1101 VLOG_WARN("%s: interface is in multiple ports "
1102 "(%s and %s)",
1103 iface_cfg->name,
1104 iface->port->port_cfg->name,
1105 port->port_cfg->name);
1106 } else {
1107 /* Log as an error because this violates the database's
1108 * uniqueness constraints, so the database server
1109 * shouldn't have allowed it. */
1110 VLOG_ERR("%s: database contains duplicate interface "
1111 "name", iface_cfg->name);
1112 }
c75d1511
BP
1113 continue;
1114 }
1115
a341ee57 1116 add_iface_to_cache(ctx, port, iface_cfg);
c75d1511
BP
1117 }
1118 }
1119 }
b3c01ed3 1120 sset_destroy(&bridges);
c75d1511
BP
1121}
1122
1123static void
5ce5a6b5 1124check_conflicts(struct vsctl_context *ctx, const char *name,
c75d1511
BP
1125 char *msg)
1126{
1127 struct vsctl_iface *iface;
1128 struct vsctl_port *port;
1129
5ce5a6b5 1130 verify_ports(ctx);
f74055e7 1131
5ce5a6b5 1132 if (shash_find(&ctx->bridges, name)) {
c88b6a27
BP
1133 vsctl_fatal("%s because a bridge named %s already exists",
1134 msg, name);
c75d1511
BP
1135 }
1136
5ce5a6b5 1137 port = shash_find_data(&ctx->ports, name);
c75d1511 1138 if (port) {
c88b6a27
BP
1139 vsctl_fatal("%s because a port named %s already exists on "
1140 "bridge %s", msg, name, port->bridge->name);
c75d1511
BP
1141 }
1142
5ce5a6b5 1143 iface = shash_find_data(&ctx->ifaces, name);
c75d1511 1144 if (iface) {
c88b6a27
BP
1145 vsctl_fatal("%s because an interface named %s already exists "
1146 "on bridge %s", msg, name, iface->port->bridge->name);
c75d1511
BP
1147 }
1148
1149 free(msg);
1150}
1151
1152static struct vsctl_bridge *
5ce5a6b5 1153find_bridge(struct vsctl_context *ctx, const char *name, bool must_exist)
c75d1511 1154{
5ce5a6b5
BP
1155 struct vsctl_bridge *br;
1156
cb22974d 1157 ovs_assert(ctx->cache_valid);
5ce5a6b5
BP
1158
1159 br = shash_find_data(&ctx->bridges, name);
01845ce8 1160 if (must_exist && !br) {
c88b6a27 1161 vsctl_fatal("no bridge named %s", name);
c75d1511 1162 }
5ce5a6b5 1163 ovsrec_open_vswitch_verify_bridges(ctx->ovs);
c75d1511
BP
1164 return br;
1165}
1166
975ac531 1167static struct vsctl_bridge *
5ce5a6b5 1168find_real_bridge(struct vsctl_context *ctx, const char *name, bool must_exist)
975ac531 1169{
5ce5a6b5 1170 struct vsctl_bridge *br = find_bridge(ctx, name, must_exist);
975ac531
JP
1171 if (br && br->parent) {
1172 vsctl_fatal("%s is a fake bridge", name);
1173 }
1174 return br;
1175}
1176
c75d1511 1177static struct vsctl_port *
5ce5a6b5 1178find_port(struct vsctl_context *ctx, const char *name, bool must_exist)
c75d1511 1179{
5ce5a6b5
BP
1180 struct vsctl_port *port;
1181
cb22974d 1182 ovs_assert(ctx->cache_valid);
5ce5a6b5
BP
1183
1184 port = shash_find_data(&ctx->ports, name);
460aad80 1185 if (port && !strcmp(name, port->bridge->name)) {
01845ce8
BP
1186 port = NULL;
1187 }
1188 if (must_exist && !port) {
c88b6a27 1189 vsctl_fatal("no port named %s", name);
c75d1511 1190 }
5ce5a6b5 1191 verify_ports(ctx);
c75d1511
BP
1192 return port;
1193}
1194
1195static struct vsctl_iface *
5ce5a6b5 1196find_iface(struct vsctl_context *ctx, const char *name, bool must_exist)
c75d1511 1197{
5ce5a6b5
BP
1198 struct vsctl_iface *iface;
1199
cb22974d 1200 ovs_assert(ctx->cache_valid);
5ce5a6b5
BP
1201
1202 iface = shash_find_data(&ctx->ifaces, name);
460aad80 1203 if (iface && !strcmp(name, iface->port->bridge->name)) {
01845ce8
BP
1204 iface = NULL;
1205 }
1206 if (must_exist && !iface) {
c88b6a27 1207 vsctl_fatal("no interface named %s", name);
c75d1511 1208 }
5ce5a6b5 1209 verify_ports(ctx);
c75d1511
BP
1210 return iface;
1211}
1212
1213static void
1214bridge_insert_port(struct ovsrec_bridge *br, struct ovsrec_port *port)
1215{
1216 struct ovsrec_port **ports;
1217 size_t i;
1218
1219 ports = xmalloc(sizeof *br->ports * (br->n_ports + 1));
1220 for (i = 0; i < br->n_ports; i++) {
1221 ports[i] = br->ports[i];
1222 }
c75d1511
BP
1223 ports[br->n_ports] = port;
1224 ovsrec_bridge_set_ports(br, ports, br->n_ports + 1);
1225 free(ports);
1226}
1227
1228static void
1229bridge_delete_port(struct ovsrec_bridge *br, struct ovsrec_port *port)
1230{
1231 struct ovsrec_port **ports;
1232 size_t i, n;
1233
1234 ports = xmalloc(sizeof *br->ports * br->n_ports);
1235 for (i = n = 0; i < br->n_ports; i++) {
1236 if (br->ports[i] != port) {
1237 ports[n++] = br->ports[i];
1238 }
1239 }
1240 ovsrec_bridge_set_ports(br, ports, n);
1241 free(ports);
1242}
1243
1244static void
1245ovs_insert_bridge(const struct ovsrec_open_vswitch *ovs,
1246 struct ovsrec_bridge *bridge)
1247{
1248 struct ovsrec_bridge **bridges;
1249 size_t i;
1250
1251 bridges = xmalloc(sizeof *ovs->bridges * (ovs->n_bridges + 1));
1252 for (i = 0; i < ovs->n_bridges; i++) {
1253 bridges[i] = ovs->bridges[i];
1254 }
1255 bridges[ovs->n_bridges] = bridge;
1256 ovsrec_open_vswitch_set_bridges(ovs, bridges, ovs->n_bridges + 1);
1257 free(bridges);
1258}
1259
524555d1 1260static void
c69ee87c 1261cmd_init(struct vsctl_context *ctx OVS_UNUSED)
524555d1
BP
1262{
1263}
1264
9b1735a7
BP
1265struct cmd_show_table {
1266 const struct ovsdb_idl_table_class *table;
1267 const struct ovsdb_idl_column *name_column;
1268 const struct ovsdb_idl_column *columns[3];
1269 bool recurse;
1270};
1271
1272static struct cmd_show_table cmd_show_tables[] = {
1273 {&ovsrec_table_open_vswitch,
1274 NULL,
1275 {&ovsrec_open_vswitch_col_manager_options,
1276 &ovsrec_open_vswitch_col_bridges,
1277 &ovsrec_open_vswitch_col_ovs_version},
1278 false},
1279
1280 {&ovsrec_table_bridge,
1281 &ovsrec_bridge_col_name,
1282 {&ovsrec_bridge_col_controller,
1283 &ovsrec_bridge_col_fail_mode,
1284 &ovsrec_bridge_col_ports},
1285 false},
1286
1287 {&ovsrec_table_port,
1288 &ovsrec_port_col_name,
1289 {&ovsrec_port_col_tag,
1290 &ovsrec_port_col_trunks,
1291 &ovsrec_port_col_interfaces},
1292 false},
1293
1294 {&ovsrec_table_interface,
1295 &ovsrec_interface_col_name,
1296 {&ovsrec_interface_col_type,
1297 &ovsrec_interface_col_options,
1298 NULL},
1299 false},
1300
1301 {&ovsrec_table_controller,
1302 &ovsrec_controller_col_target,
1303 {&ovsrec_controller_col_is_connected,
1304 NULL,
1305 NULL},
1306 false},
1307
1308 {&ovsrec_table_manager,
1309 &ovsrec_manager_col_target,
1310 {&ovsrec_manager_col_is_connected,
1311 NULL,
1312 NULL},
1313 false},
1314};
1315
1316static void
1317pre_cmd_show(struct vsctl_context *ctx)
1318{
1319 struct cmd_show_table *show;
1320
1321 for (show = cmd_show_tables;
1322 show < &cmd_show_tables[ARRAY_SIZE(cmd_show_tables)];
1323 show++) {
1324 size_t i;
1325
1326 ovsdb_idl_add_table(ctx->idl, show->table);
1327 if (show->name_column) {
1328 ovsdb_idl_add_column(ctx->idl, show->name_column);
1329 }
1330 for (i = 0; i < ARRAY_SIZE(show->columns); i++) {
1331 const struct ovsdb_idl_column *column = show->columns[i];
1332 if (column) {
1333 ovsdb_idl_add_column(ctx->idl, column);
1334 }
1335 }
1336 }
1337}
1338
1339static struct cmd_show_table *
1340cmd_show_find_table_by_row(const struct ovsdb_idl_row *row)
1341{
1342 struct cmd_show_table *show;
1343
1344 for (show = cmd_show_tables;
1345 show < &cmd_show_tables[ARRAY_SIZE(cmd_show_tables)];
1346 show++) {
1347 if (show->table == row->table->class) {
1348 return show;
1349 }
1350 }
1351 return NULL;
1352}
1353
1354static struct cmd_show_table *
1355cmd_show_find_table_by_name(const char *name)
1356{
1357 struct cmd_show_table *show;
1358
1359 for (show = cmd_show_tables;
1360 show < &cmd_show_tables[ARRAY_SIZE(cmd_show_tables)];
1361 show++) {
1362 if (!strcmp(show->table->name, name)) {
1363 return show;
1364 }
1365 }
1366 return NULL;
1367}
1368
1369static void
1370cmd_show_row(struct vsctl_context *ctx, const struct ovsdb_idl_row *row,
1371 int level)
1372{
1373 struct cmd_show_table *show = cmd_show_find_table_by_row(row);
1374 size_t i;
1375
1376 ds_put_char_multiple(&ctx->output, ' ', level * 4);
1377 if (show && show->name_column) {
1378 const struct ovsdb_datum *datum;
1379
1380 ds_put_format(&ctx->output, "%s ", show->table->name);
1381 datum = ovsdb_idl_read(row, show->name_column);
1382 ovsdb_datum_to_string(datum, &show->name_column->type, &ctx->output);
1383 } else {
1384 ds_put_format(&ctx->output, UUID_FMT, UUID_ARGS(&row->uuid));
1385 }
1386 ds_put_char(&ctx->output, '\n');
1387
1388 if (!show || show->recurse) {
1389 return;
1390 }
1391
1392 show->recurse = true;
1393 for (i = 0; i < ARRAY_SIZE(show->columns); i++) {
1394 const struct ovsdb_idl_column *column = show->columns[i];
1395 const struct ovsdb_datum *datum;
1396
1397 if (!column) {
1398 break;
1399 }
1400
1401 datum = ovsdb_idl_read(row, column);
1402 if (column->type.key.type == OVSDB_TYPE_UUID &&
1403 column->type.key.u.uuid.refTableName) {
1404 struct cmd_show_table *ref_show;
1405 size_t j;
1406
1407 ref_show = cmd_show_find_table_by_name(
1408 column->type.key.u.uuid.refTableName);
1409 if (ref_show) {
1410 for (j = 0; j < datum->n; j++) {
1411 const struct ovsdb_idl_row *ref_row;
1412
1413 ref_row = ovsdb_idl_get_row_for_uuid(ctx->idl,
1414 ref_show->table,
1415 &datum->keys[j].uuid);
1416 if (ref_row) {
1417 cmd_show_row(ctx, ref_row, level + 1);
1418 }
1419 }
1420 continue;
1421 }
1422 }
1423
1424 if (!ovsdb_datum_is_default(datum, &column->type)) {
1425 ds_put_char_multiple(&ctx->output, ' ', (level + 1) * 4);
1426 ds_put_format(&ctx->output, "%s: ", column->name);
1427 ovsdb_datum_to_string(datum, &column->type, &ctx->output);
1428 ds_put_char(&ctx->output, '\n');
1429 }
1430 }
1431 show->recurse = false;
1432}
1433
1434static void
1435cmd_show(struct vsctl_context *ctx)
1436{
1437 const struct ovsdb_idl_row *row;
1438
1439 for (row = ovsdb_idl_first_row(ctx->idl, cmd_show_tables[0].table);
1440 row; row = ovsdb_idl_next_row(row)) {
1441 cmd_show_row(ctx, row, 0);
1442 }
1443}
1444
e5e12280
BP
1445static void
1446pre_cmd_emer_reset(struct vsctl_context *ctx)
1447{
87824b0b 1448 ovsdb_idl_add_column(ctx->idl, &ovsrec_open_vswitch_col_manager_options);
e5e12280
BP
1449 ovsdb_idl_add_column(ctx->idl, &ovsrec_open_vswitch_col_ssl);
1450
1451 ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_controller);
f67e3b66 1452 ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_fail_mode);
e5e12280
BP
1453 ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_mirrors);
1454 ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_netflow);
1455 ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_sflow);
1456 ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_flood_vlans);
1457 ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_other_config);
1458
1459 ovsdb_idl_add_column(ctx->idl, &ovsrec_port_col_other_config);
1460
1461 ovsdb_idl_add_column(ctx->idl,
1462 &ovsrec_interface_col_ingress_policing_rate);
1463 ovsdb_idl_add_column(ctx->idl,
1464 &ovsrec_interface_col_ingress_policing_burst);
1465}
1466
18ee958b
JP
1467static void
1468cmd_emer_reset(struct vsctl_context *ctx)
1469{
1470 const struct ovsdb_idl *idl = ctx->idl;
1471 const struct ovsrec_bridge *br;
1472 const struct ovsrec_port *port;
1473 const struct ovsrec_interface *iface;
28a14bf3
EJ
1474 const struct ovsrec_mirror *mirror, *next_mirror;
1475 const struct ovsrec_controller *ctrl, *next_ctrl;
1476 const struct ovsrec_manager *mgr, *next_mgr;
1477 const struct ovsrec_netflow *nf, *next_nf;
1478 const struct ovsrec_ssl *ssl, *next_ssl;
1479 const struct ovsrec_sflow *sflow, *next_sflow;
18ee958b 1480
18ee958b 1481 /* Reset the Open_vSwitch table. */
87824b0b 1482 ovsrec_open_vswitch_set_manager_options(ctx->ovs, NULL, 0);
18ee958b
JP
1483 ovsrec_open_vswitch_set_ssl(ctx->ovs, NULL);
1484
1485 OVSREC_BRIDGE_FOR_EACH (br, idl) {
a699f614 1486 const char *hwaddr;
18ee958b
JP
1487
1488 ovsrec_bridge_set_controller(br, NULL, 0);
f67e3b66 1489 ovsrec_bridge_set_fail_mode(br, NULL);
18ee958b
JP
1490 ovsrec_bridge_set_mirrors(br, NULL, 0);
1491 ovsrec_bridge_set_netflow(br, NULL);
1492 ovsrec_bridge_set_sflow(br, NULL);
1493 ovsrec_bridge_set_flood_vlans(br, NULL, 0);
1494
1495 /* We only want to save the "hwaddr" key from other_config. */
a699f614
EJ
1496 hwaddr = smap_get(&br->other_config, "hwaddr");
1497 if (hwaddr) {
1498 struct smap smap = SMAP_INITIALIZER(&smap);
1499 smap_add(&smap, "hwaddr", hwaddr);
1500 ovsrec_bridge_set_other_config(br, &smap);
1501 smap_destroy(&smap);
18ee958b 1502 } else {
a699f614 1503 ovsrec_bridge_set_other_config(br, NULL);
18ee958b
JP
1504 }
1505 }
1506
1507 OVSREC_PORT_FOR_EACH (port, idl) {
a699f614 1508 ovsrec_port_set_other_config(port, NULL);
18ee958b
JP
1509 }
1510
1511 OVSREC_INTERFACE_FOR_EACH (iface, idl) {
1512 /* xxx What do we do about gre/patch devices created by mgr? */
1513
1514 ovsrec_interface_set_ingress_policing_rate(iface, 0);
1515 ovsrec_interface_set_ingress_policing_burst(iface, 0);
1516 }
28a14bf3
EJ
1517
1518 OVSREC_MIRROR_FOR_EACH_SAFE (mirror, next_mirror, idl) {
1519 ovsrec_mirror_delete(mirror);
1520 }
1521
1522 OVSREC_CONTROLLER_FOR_EACH_SAFE (ctrl, next_ctrl, idl) {
1523 ovsrec_controller_delete(ctrl);
1524 }
1525
1526 OVSREC_MANAGER_FOR_EACH_SAFE (mgr, next_mgr, idl) {
1527 ovsrec_manager_delete(mgr);
1528 }
1529
1530 OVSREC_NETFLOW_FOR_EACH_SAFE (nf, next_nf, idl) {
1531 ovsrec_netflow_delete(nf);
1532 }
1533
1534 OVSREC_SSL_FOR_EACH_SAFE (ssl, next_ssl, idl) {
1535 ovsrec_ssl_delete(ssl);
1536 }
1537
1538 OVSREC_SFLOW_FOR_EACH_SAFE (sflow, next_sflow, idl) {
1539 ovsrec_sflow_delete(sflow);
1540 }
5ce5a6b5
BP
1541
1542 vsctl_context_invalidate_cache(ctx);
18ee958b
JP
1543}
1544
c75d1511 1545static void
5d9cb63c 1546cmd_add_br(struct vsctl_context *ctx)
c75d1511 1547{
e3c17733 1548 bool may_exist = shash_find(&ctx->options, "--may-exist") != NULL;
b89d8339 1549 const char *br_name, *parent_name;
b89d8339 1550 int vlan;
c75d1511 1551
aeee85aa
BP
1552 br_name = ctx->argv[1];
1553 if (ctx->argc == 2) {
1554 parent_name = NULL;
1555 vlan = 0;
1556 } else if (ctx->argc == 4) {
1557 parent_name = ctx->argv[2];
1558 vlan = atoi(ctx->argv[3]);
5341d046
BP
1559 if (vlan < 0 || vlan > 4095) {
1560 vsctl_fatal("%s: vlan must be between 0 and 4095", ctx->argv[0]);
aeee85aa
BP
1561 }
1562 } else {
1563 vsctl_fatal("'%s' command takes exactly 1 or 3 arguments",
1564 ctx->argv[0]);
1565 }
1566
5ce5a6b5 1567 vsctl_context_populate_cache(ctx);
aeee85aa
BP
1568 if (may_exist) {
1569 struct vsctl_bridge *br;
1570
5ce5a6b5 1571 br = find_bridge(ctx, br_name, false);
aeee85aa
BP
1572 if (br) {
1573 if (!parent_name) {
1574 if (br->parent) {
1575 vsctl_fatal("\"--may-exist add-br %s\" but %s is "
1576 "a VLAN bridge for VLAN %d",
1577 br_name, br_name, br->vlan);
1578 }
1579 } else {
1580 if (!br->parent) {
1581 vsctl_fatal("\"--may-exist add-br %s %s %d\" but %s "
1582 "is not a VLAN bridge",
1583 br_name, parent_name, vlan, br_name);
1584 } else if (strcmp(br->parent->name, parent_name)) {
1585 vsctl_fatal("\"--may-exist add-br %s %s %d\" but %s "
1586 "has the wrong parent %s",
1587 br_name, parent_name, vlan,
1588 br_name, br->parent->name);
1589 } else if (br->vlan != vlan) {
1590 vsctl_fatal("\"--may-exist add-br %s %s %d\" but %s "
1591 "is a VLAN bridge for the wrong VLAN %d",
1592 br_name, parent_name, vlan, br_name, br->vlan);
1593 }
1594 }
1595 return;
1596 }
1597 }
5ce5a6b5 1598 check_conflicts(ctx, br_name,
c75d1511
BP
1599 xasprintf("cannot create a bridge named %s", br_name));
1600
aeee85aa 1601 if (!parent_name) {
c75d1511
BP
1602 struct ovsrec_port *port;
1603 struct ovsrec_interface *iface;
aeee85aa 1604 struct ovsrec_bridge *br;
c75d1511 1605
f8ff4bc4 1606 iface = ovsrec_interface_insert(ctx->txn);
c75d1511 1607 ovsrec_interface_set_name(iface, br_name);
9106d88c 1608 ovsrec_interface_set_type(iface, "internal");
c75d1511 1609
f8ff4bc4 1610 port = ovsrec_port_insert(ctx->txn);
c75d1511
BP
1611 ovsrec_port_set_name(port, br_name);
1612 ovsrec_port_set_interfaces(port, &iface, 1);
1613
f8ff4bc4 1614 br = ovsrec_bridge_insert(ctx->txn);
c75d1511
BP
1615 ovsrec_bridge_set_name(br, br_name);
1616 ovsrec_bridge_set_ports(br, &port, 1);
1617
5d9cb63c 1618 ovs_insert_bridge(ctx->ovs, br);
aeee85aa 1619 } else {
c75d1511
BP
1620 struct vsctl_bridge *parent;
1621 struct ovsrec_port *port;
1622 struct ovsrec_interface *iface;
aeee85aa 1623 struct ovsrec_bridge *br;
c75d1511
BP
1624 int64_t tag = vlan;
1625
5ce5a6b5 1626 parent = find_bridge(ctx, parent_name, false);
5341d046 1627 if (parent && parent->parent) {
11aa5627 1628 vsctl_fatal("cannot create bridge with fake bridge as parent");
c75d1511
BP
1629 }
1630 if (!parent) {
c88b6a27 1631 vsctl_fatal("parent bridge %s does not exist", parent_name);
c75d1511
BP
1632 }
1633 br = parent->br_cfg;
1634
f8ff4bc4 1635 iface = ovsrec_interface_insert(ctx->txn);
c75d1511
BP
1636 ovsrec_interface_set_name(iface, br_name);
1637 ovsrec_interface_set_type(iface, "internal");
1638
f8ff4bc4 1639 port = ovsrec_port_insert(ctx->txn);
c75d1511
BP
1640 ovsrec_port_set_name(port, br_name);
1641 ovsrec_port_set_interfaces(port, &iface, 1);
1642 ovsrec_port_set_fake_bridge(port, true);
1643 ovsrec_port_set_tag(port, &tag, 1);
dfbe07ba
BP
1644
1645 bridge_insert_port(br, port);
c75d1511
BP
1646 }
1647
5ce5a6b5 1648 vsctl_context_invalidate_cache(ctx);
c75d1511
BP
1649}
1650
1651static void
5ce5a6b5 1652del_port(struct vsctl_context *ctx, struct vsctl_port *port)
c75d1511 1653{
a341ee57 1654 struct vsctl_iface *iface, *next_iface;
28a14bf3 1655
c75d1511
BP
1656 bridge_delete_port((port->bridge->parent
1657 ? port->bridge->parent->br_cfg
1658 : port->bridge->br_cfg), port->port_cfg);
a341ee57
BP
1659
1660 LIST_FOR_EACH_SAFE (iface, next_iface, ifaces_node, &port->ifaces) {
1661 del_cached_iface(ctx, iface);
1662 }
1663 del_cached_port(ctx, port);
1664}
1665
1666static void
1667del_bridge(struct vsctl_context *ctx, struct vsctl_bridge *br)
1668{
1669 struct vsctl_bridge *child, *next_child;
1670 struct vsctl_port *port, *next_port;
1671
1672 HMAP_FOR_EACH_SAFE (child, next_child, children_node, &br->children) {
1673 del_bridge(ctx, child);
1674 }
1675
1676 LIST_FOR_EACH_SAFE (port, next_port, ports_node, &br->ports) {
1677 del_port(ctx, port);
1678 }
1679
1680 del_cached_bridge(ctx, br);
c75d1511
BP
1681}
1682
1683static void
5d9cb63c 1684cmd_del_br(struct vsctl_context *ctx)
c75d1511 1685{
460aad80 1686 bool must_exist = !shash_find(&ctx->options, "--if-exists");
c75d1511
BP
1687 struct vsctl_bridge *bridge;
1688
5ce5a6b5
BP
1689 vsctl_context_populate_cache(ctx);
1690 bridge = find_bridge(ctx, ctx->argv[1], must_exist);
460aad80 1691 if (bridge) {
a341ee57 1692 del_bridge(ctx, bridge);
c75d1511 1693 }
c75d1511
BP
1694}
1695
dfbe07ba
BP
1696static void
1697output_sorted(struct svec *svec, struct ds *output)
1698{
1699 const char *name;
1700 size_t i;
1701
1702 svec_sort(svec);
1703 SVEC_FOR_EACH (i, name, svec) {
1704 ds_put_format(output, "%s\n", name);
1705 }
1706}
1707
c75d1511 1708static void
5d9cb63c 1709cmd_list_br(struct vsctl_context *ctx)
c75d1511
BP
1710{
1711 struct shash_node *node;
dfbe07ba 1712 struct svec bridges;
515d830a
JP
1713 bool real = shash_find(&ctx->options, "--real");
1714 bool fake = shash_find(&ctx->options, "--fake");
1715
1716 /* If neither fake nor real were requested, return both. */
1717 if (!real && !fake) {
1718 real = fake = true;
1719 }
c75d1511 1720
5ce5a6b5 1721 vsctl_context_populate_cache(ctx);
dfbe07ba
BP
1722
1723 svec_init(&bridges);
5ce5a6b5 1724 SHASH_FOR_EACH (node, &ctx->bridges) {
c75d1511 1725 struct vsctl_bridge *br = node->data;
515d830a
JP
1726
1727 if (br->parent ? fake : real) {
1728 svec_add(&bridges, br->name);
1729 }
c75d1511 1730 }
5d9cb63c 1731 output_sorted(&bridges, &ctx->output);
dfbe07ba 1732 svec_destroy(&bridges);
c75d1511
BP
1733}
1734
1735static void
5d9cb63c 1736cmd_br_exists(struct vsctl_context *ctx)
c75d1511 1737{
5ce5a6b5
BP
1738 vsctl_context_populate_cache(ctx);
1739 if (!find_bridge(ctx, ctx->argv[1], false)) {
1d48b4be 1740 vsctl_exit(2);
c75d1511 1741 }
c75d1511
BP
1742}
1743
457e1eb0 1744static void
a699f614
EJ
1745set_external_id(struct smap *old, struct smap *new,
1746 char *key, char *value)
457e1eb0 1747{
a699f614 1748 smap_clone(new, old);
457e1eb0 1749
457e1eb0 1750 if (value) {
a699f614
EJ
1751 smap_replace(new, key, value);
1752 } else {
1753 smap_remove(new, key);
457e1eb0 1754 }
457e1eb0
BP
1755}
1756
e5e12280
BP
1757static void
1758pre_cmd_br_set_external_id(struct vsctl_context *ctx)
1759{
1760 pre_get_info(ctx);
1761 ovsdb_idl_add_column(ctx->idl, &ovsrec_bridge_col_external_ids);
1762 ovsdb_idl_add_column(ctx->idl, &ovsrec_port_col_external_ids);
1763}
1764
457e1eb0 1765static void
5d9cb63c 1766cmd_br_set_external_id(struct vsctl_context *ctx)
457e1eb0 1767{
457e1eb0 1768 struct vsctl_bridge *bridge;
a699f614 1769 struct smap new;
457e1eb0 1770
5ce5a6b5
BP
1771 vsctl_context_populate_cache(ctx);
1772 bridge = find_bridge(ctx, ctx->argv[1], true);
457e1eb0 1773 if (bridge->br_cfg) {
a699f614
EJ
1774
1775 set_external_id(&bridge->br_cfg->external_ids, &new, ctx->argv[2],
1776 ctx->argc >= 4 ? ctx->argv[3] : NULL);
f74055e7 1777 ovsrec_bridge_verify_external_ids(bridge->br_cfg);
a699f614 1778 ovsrec_bridge_set_external_ids(bridge->br_cfg, &new);
457e1eb0 1779 } else {
5d9cb63c 1780 char *key = xasprintf("fake-bridge-%s", ctx->argv[2]);
5ce5a6b5 1781 struct vsctl_port *port = shash_find_data(&ctx->ports, ctx->argv[1]);
a699f614
EJ
1782 set_external_id(&port->port_cfg->external_ids, &new,
1783 key, ctx->argc >= 4 ? ctx->argv[3] : NULL);
f74055e7 1784 ovsrec_port_verify_external_ids(port->port_cfg);
a699f614 1785 ovsrec_port_set_external_ids(port->port_cfg, &new);
457e1eb0
BP
1786 free(key);
1787 }
a699f614 1788 smap_destroy(&new);
457e1eb0
BP
1789}
1790
1791static void
a699f614 1792get_external_id(struct smap *smap, const char *prefix, const char *key,
457e1eb0
BP
1793 struct ds *output)
1794{
a699f614
EJ
1795 if (key) {
1796 char *prefix_key = xasprintf("%s%s", prefix, key);
1797 const char *value = smap_get(smap, prefix_key);
457e1eb0 1798
a699f614
EJ
1799 if (value) {
1800 ds_put_format(output, "%s\n", value);
1801 }
1802 free(prefix_key);
1803 } else {
1804 const struct smap_node **sorted = smap_sort(smap);
1805 size_t prefix_len = strlen(prefix);
1806 size_t i;
1807
1808 for (i = 0; i < smap_count(smap); i++) {
1809 const struct smap_node *node = sorted[i];
1810 if (!strncmp(node->key, prefix, prefix_len)) {
1811 ds_put_format(output, "%s=%s\n", node->key + prefix_len,
1812 node->value);
1813 }
457e1eb0 1814 }
a699f614 1815 free(sorted);
457e1eb0 1816 }
457e1eb0
BP
1817}
1818
e5e12280
BP
1819static void
1820pre_cmd_br_get_external_id(struct vsctl_context *ctx)
1821{
1822 pre_cmd_br_set_external_id(ctx);
1823}
1824
457e1eb0 1825static void
5d9cb63c 1826cmd_br_get_external_id(struct vsctl_context *ctx)
457e1eb0 1827{
457e1eb0
BP
1828 struct vsctl_bridge *bridge;
1829
5ce5a6b5
BP
1830 vsctl_context_populate_cache(ctx);
1831
1832 bridge = find_bridge(ctx, ctx->argv[1], true);
457e1eb0 1833 if (bridge->br_cfg) {
f74055e7 1834 ovsrec_bridge_verify_external_ids(bridge->br_cfg);
a699f614
EJ
1835 get_external_id(&bridge->br_cfg->external_ids, "",
1836 ctx->argc >= 3 ? ctx->argv[2] : NULL, &ctx->output);
457e1eb0 1837 } else {
5ce5a6b5 1838 struct vsctl_port *port = shash_find_data(&ctx->ports, ctx->argv[1]);
f74055e7 1839 ovsrec_port_verify_external_ids(port->port_cfg);
a699f614
EJ
1840 get_external_id(&port->port_cfg->external_ids, "fake-bridge-",
1841 ctx->argc >= 3 ? ctx->argv[2] : NULL, &ctx->output);
457e1eb0 1842 }
457e1eb0
BP
1843}
1844
c75d1511 1845static void
5d9cb63c 1846cmd_list_ports(struct vsctl_context *ctx)
c75d1511
BP
1847{
1848 struct vsctl_bridge *br;
a341ee57 1849 struct vsctl_port *port;
dfbe07ba 1850 struct svec ports;
c75d1511 1851
5ce5a6b5
BP
1852 vsctl_context_populate_cache(ctx);
1853 br = find_bridge(ctx, ctx->argv[1], true);
f74055e7 1854 ovsrec_bridge_verify_ports(br->br_cfg ? br->br_cfg : br->parent->br_cfg);
dfbe07ba
BP
1855
1856 svec_init(&ports);
a341ee57
BP
1857 LIST_FOR_EACH (port, ports_node, &br->ports) {
1858 if (strcmp(port->port_cfg->name, br->name)) {
dfbe07ba 1859 svec_add(&ports, port->port_cfg->name);
c75d1511
BP
1860 }
1861 }
5d9cb63c 1862 output_sorted(&ports, &ctx->output);
dfbe07ba 1863 svec_destroy(&ports);
c75d1511
BP
1864}
1865
1866static void
f8ff4bc4 1867add_port(struct vsctl_context *ctx,
bb1c67c8
BP
1868 const char *br_name, const char *port_name,
1869 bool may_exist, bool fake_iface,
18b239f5
BP
1870 char *iface_names[], int n_ifaces,
1871 char *settings[], int n_settings)
c75d1511 1872{
a341ee57 1873 struct vsctl_port *vsctl_port;
c75d1511
BP
1874 struct vsctl_bridge *bridge;
1875 struct ovsrec_interface **ifaces;
1876 struct ovsrec_port *port;
1877 size_t i;
1878
5ce5a6b5 1879 vsctl_context_populate_cache(ctx);
bb1c67c8 1880 if (may_exist) {
2a022368 1881 struct vsctl_port *vsctl_port;
bb1c67c8 1882
5ce5a6b5 1883 vsctl_port = find_port(ctx, port_name, false);
2a022368 1884 if (vsctl_port) {
bb1c67c8 1885 struct svec want_names, have_names;
bb1c67c8
BP
1886
1887 svec_init(&want_names);
1888 for (i = 0; i < n_ifaces; i++) {
1889 svec_add(&want_names, iface_names[i]);
1890 }
1891 svec_sort(&want_names);
1892
1893 svec_init(&have_names);
2a022368
BP
1894 for (i = 0; i < vsctl_port->port_cfg->n_interfaces; i++) {
1895 svec_add(&have_names,
1896 vsctl_port->port_cfg->interfaces[i]->name);
bb1c67c8
BP
1897 }
1898 svec_sort(&have_names);
1899
2a022368 1900 if (strcmp(vsctl_port->bridge->name, br_name)) {
bb1c67c8
BP
1901 char *command = vsctl_context_to_string(ctx);
1902 vsctl_fatal("\"%s\" but %s is actually attached to bridge %s",
2a022368 1903 command, port_name, vsctl_port->bridge->name);
bb1c67c8
BP
1904 }
1905
1906 if (!svec_equal(&want_names, &have_names)) {
1907 char *have_names_string = svec_join(&have_names, ", ", "");
1908 char *command = vsctl_context_to_string(ctx);
1909
1910 vsctl_fatal("\"%s\" but %s actually has interface(s) %s",
1911 command, port_name, have_names_string);
1912 }
1913
1914 svec_destroy(&want_names);
1915 svec_destroy(&have_names);
1916
1917 return;
1918 }
1919 }
5ce5a6b5 1920 check_conflicts(ctx, port_name,
c75d1511 1921 xasprintf("cannot create a port named %s", port_name));
bb1c67c8 1922 for (i = 0; i < n_ifaces; i++) {
5ce5a6b5 1923 check_conflicts(ctx, iface_names[i],
bb1c67c8
BP
1924 xasprintf("cannot create an interface named %s",
1925 iface_names[i]));
1926 }
5ce5a6b5 1927 bridge = find_bridge(ctx, br_name, true);
c75d1511
BP
1928
1929 ifaces = xmalloc(n_ifaces * sizeof *ifaces);
1930 for (i = 0; i < n_ifaces; i++) {
f8ff4bc4 1931 ifaces[i] = ovsrec_interface_insert(ctx->txn);
c75d1511
BP
1932 ovsrec_interface_set_name(ifaces[i], iface_names[i]);
1933 }
1934
f8ff4bc4 1935 port = ovsrec_port_insert(ctx->txn);
c75d1511
BP
1936 ovsrec_port_set_name(port, port_name);
1937 ovsrec_port_set_interfaces(port, ifaces, n_ifaces);
b4182c7f 1938 ovsrec_port_set_bond_fake_iface(port, fake_iface);
a0a9f31d 1939
5341d046 1940 if (bridge->parent) {
c75d1511
BP
1941 int64_t tag = bridge->vlan;
1942 ovsrec_port_set_tag(port, &tag, 1);
1943 }
1944
18b239f5 1945 for (i = 0; i < n_settings; i++) {
ce5a3e38
BP
1946 set_column(get_table("Port"), &port->header_, settings[i],
1947 ctx->symtab);
18b239f5
BP
1948 }
1949
c75d1511
BP
1950 bridge_insert_port((bridge->parent ? bridge->parent->br_cfg
1951 : bridge->br_cfg), port);
1952
a341ee57
BP
1953 vsctl_port = add_port_to_cache(ctx, bridge, port);
1954 for (i = 0; i < n_ifaces; i++) {
1955 add_iface_to_cache(ctx, vsctl_port, ifaces[i]);
1956 }
1957 free(ifaces);
c75d1511
BP
1958}
1959
1960static void
5d9cb63c 1961cmd_add_port(struct vsctl_context *ctx)
c75d1511 1962{
e3c17733 1963 bool may_exist = shash_find(&ctx->options, "--may-exist") != NULL;
bb1c67c8
BP
1964
1965 add_port(ctx, ctx->argv[1], ctx->argv[2], may_exist, false,
18b239f5 1966 &ctx->argv[2], 1, &ctx->argv[3], ctx->argc - 3);
c75d1511
BP
1967}
1968
1969static void
5d9cb63c 1970cmd_add_bond(struct vsctl_context *ctx)
c75d1511 1971{
e3c17733 1972 bool may_exist = shash_find(&ctx->options, "--may-exist") != NULL;
b4182c7f 1973 bool fake_iface = shash_find(&ctx->options, "--fake-iface");
18b239f5
BP
1974 int n_ifaces;
1975 int i;
1976
1977 n_ifaces = ctx->argc - 3;
1978 for (i = 3; i < ctx->argc; i++) {
1979 if (strchr(ctx->argv[i], '=')) {
1980 n_ifaces = i - 3;
1981 break;
1982 }
1983 }
1984 if (n_ifaces < 2) {
1985 vsctl_fatal("add-bond requires at least 2 interfaces, but only "
1986 "%d were specified", n_ifaces);
1987 }
b4182c7f 1988
bb1c67c8 1989 add_port(ctx, ctx->argv[1], ctx->argv[2], may_exist, fake_iface,
18b239f5
BP
1990 &ctx->argv[3], n_ifaces,
1991 &ctx->argv[n_ifaces + 3], ctx->argc - 3 - n_ifaces);
c75d1511
BP
1992}
1993
1994static void
5d9cb63c 1995cmd_del_port(struct vsctl_context *ctx)
c75d1511 1996{
460aad80 1997 bool must_exist = !shash_find(&ctx->options, "--if-exists");
7c79588e
BP
1998 bool with_iface = shash_find(&ctx->options, "--with-iface") != NULL;
1999 struct vsctl_port *port;
c75d1511 2000
5ce5a6b5 2001 vsctl_context_populate_cache(ctx);
7c79588e 2002 if (!with_iface) {
5ce5a6b5 2003 port = find_port(ctx, ctx->argv[ctx->argc - 1], must_exist);
7c79588e
BP
2004 } else {
2005 const char *target = ctx->argv[ctx->argc - 1];
2006 struct vsctl_iface *iface;
2007
5ce5a6b5 2008 port = find_port(ctx, target, false);
7c79588e 2009 if (!port) {
5ce5a6b5 2010 iface = find_iface(ctx, target, false);
7c79588e
BP
2011 if (iface) {
2012 port = iface->port;
2013 }
2014 }
2015 if (must_exist && !port) {
2016 vsctl_fatal("no port or interface named %s", target);
460aad80 2017 }
7c79588e 2018 }
460aad80 2019
7c79588e
BP
2020 if (port) {
2021 if (ctx->argc == 3) {
2022 struct vsctl_bridge *bridge;
2023
5ce5a6b5 2024 bridge = find_bridge(ctx, ctx->argv[1], true);
7c79588e
BP
2025 if (port->bridge != bridge) {
2026 if (port->bridge->parent == bridge) {
2027 vsctl_fatal("bridge %s does not have a port %s (although "
2028 "its parent bridge %s does)",
2029 ctx->argv[1], ctx->argv[2],
2030 bridge->parent->name);
2031 } else {
2032 vsctl_fatal("bridge %s does not have a port %s",
2033 ctx->argv[1], ctx->argv[2]);
2034 }
460aad80 2035 }
c75d1511 2036 }
7c79588e 2037
5ce5a6b5 2038 del_port(ctx, port);
c75d1511 2039 }
c75d1511
BP
2040}
2041
2042static void
5d9cb63c 2043cmd_port_to_br(struct vsctl_context *ctx)
c75d1511
BP
2044{
2045 struct vsctl_port *port;
c75d1511 2046
5ce5a6b5
BP
2047 vsctl_context_populate_cache(ctx);
2048
2049 port = find_port(ctx, ctx->argv[1], true);
5d9cb63c 2050 ds_put_format(&ctx->output, "%s\n", port->bridge->name);
c75d1511
BP
2051}
2052
2053static void
5d9cb63c 2054cmd_br_to_vlan(struct vsctl_context *ctx)
c75d1511
BP
2055{
2056 struct vsctl_bridge *bridge;
c75d1511 2057
5ce5a6b5
BP
2058 vsctl_context_populate_cache(ctx);
2059
2060 bridge = find_bridge(ctx, ctx->argv[1], true);
5d9cb63c 2061 ds_put_format(&ctx->output, "%d\n", bridge->vlan);
c75d1511
BP
2062}
2063
2064static void
5d9cb63c 2065cmd_br_to_parent(struct vsctl_context *ctx)
c75d1511
BP
2066{
2067 struct vsctl_bridge *bridge;
c75d1511 2068
5ce5a6b5
BP
2069 vsctl_context_populate_cache(ctx);
2070
2071 bridge = find_bridge(ctx, ctx->argv[1], true);
c75d1511
BP
2072 if (bridge->parent) {
2073 bridge = bridge->parent;
2074 }
5d9cb63c 2075 ds_put_format(&ctx->output, "%s\n", bridge->name);
c75d1511
BP
2076}
2077
2078static void
5d9cb63c 2079cmd_list_ifaces(struct vsctl_context *ctx)
c75d1511
BP
2080{
2081 struct vsctl_bridge *br;
a341ee57 2082 struct vsctl_port *port;
dfbe07ba 2083 struct svec ifaces;
c75d1511 2084
5ce5a6b5
BP
2085 vsctl_context_populate_cache(ctx);
2086
2087 br = find_bridge(ctx, ctx->argv[1], true);
f74055e7 2088 verify_ports(ctx);
dfbe07ba
BP
2089
2090 svec_init(&ifaces);
a341ee57
BP
2091 LIST_FOR_EACH (port, ports_node, &br->ports) {
2092 struct vsctl_iface *iface;
c75d1511 2093
a341ee57
BP
2094 LIST_FOR_EACH (iface, ifaces_node, &port->ifaces) {
2095 if (strcmp(iface->iface_cfg->name, br->name)) {
2096 svec_add(&ifaces, iface->iface_cfg->name);
2097 }
c75d1511
BP
2098 }
2099 }
5d9cb63c 2100 output_sorted(&ifaces, &ctx->output);
dfbe07ba 2101 svec_destroy(&ifaces);
c75d1511
BP
2102}
2103
2104static void
5d9cb63c 2105cmd_iface_to_br(struct vsctl_context *ctx)
c75d1511
BP
2106{
2107 struct vsctl_iface *iface;
c75d1511 2108
5ce5a6b5
BP
2109 vsctl_context_populate_cache(ctx);
2110
2111 iface = find_iface(ctx, ctx->argv[1], true);
5d9cb63c 2112 ds_put_format(&ctx->output, "%s\n", iface->port->bridge->name);
c75d1511 2113}
457e1eb0 2114
f74055e7
BP
2115static void
2116verify_controllers(struct ovsrec_bridge *bridge)
2117{
7da6c3a6 2118 size_t i;
f74055e7 2119
7da6c3a6
BP
2120 ovsrec_bridge_verify_controller(bridge);
2121 for (i = 0; i < bridge->n_controller; i++) {
2122 ovsrec_controller_verify_target(bridge->controller[i]);
f74055e7
BP
2123 }
2124}
2125
4e3e7ff9
BP
2126static void
2127pre_controller(struct vsctl_context *ctx)
2128{
2129 pre_get_info(ctx);
2130
2131 ovsdb_idl_add_column(ctx->idl, &ovsrec_controller_col_target);
2132}
2133
76ce9432 2134static void
1a048029 2135cmd_get_controller(struct vsctl_context *ctx)
76ce9432 2136{
1a048029 2137 struct vsctl_bridge *br;
76ce9432
BP
2138 struct svec targets;
2139 size_t i;
2140
5ce5a6b5
BP
2141 vsctl_context_populate_cache(ctx);
2142
2143 br = find_bridge(ctx, ctx->argv[1], true);
7da6c3a6
BP
2144 if (br->parent) {
2145 br = br->parent;
2146 }
f74055e7 2147 verify_controllers(br->br_cfg);
1a048029
JP
2148
2149 /* Print the targets in sorted order for reproducibility. */
76ce9432 2150 svec_init(&targets);
286a2e82
BP
2151 for (i = 0; i < br->br_cfg->n_controller; i++) {
2152 svec_add(&targets, br->br_cfg->controller[i]->target);
76ce9432
BP
2153 }
2154
2155 svec_sort(&targets);
2156 for (i = 0; i < targets.n; i++) {
2157 ds_put_format(&ctx->output, "%s\n", targets.names[i]);
2158 }
2159 svec_destroy(&targets);
5aa00635
JP
2160}
2161
28a14bf3
EJ
2162static void
2163delete_controllers(struct ovsrec_controller **controllers,
2164 size_t n_controllers)
2165{
2166 size_t i;
2167
2168 for (i = 0; i < n_controllers; i++) {
2169 ovsrec_controller_delete(controllers[i]);
2170 }
2171}
2172
5aa00635
JP
2173static void
2174cmd_del_controller(struct vsctl_context *ctx)
2175{
286a2e82 2176 struct ovsrec_bridge *br;
5aa00635 2177
5ce5a6b5 2178 vsctl_context_populate_cache(ctx);
5aa00635 2179
286a2e82
BP
2180 br = find_real_bridge(ctx, ctx->argv[1], true)->br_cfg;
2181 verify_controllers(br);
5aa00635 2182
286a2e82
BP
2183 if (br->controller) {
2184 delete_controllers(br->controller, br->n_controller);
2185 ovsrec_bridge_set_controller(br, NULL, 0);
5ce5a6b5 2186 }
5aa00635
JP
2187}
2188
76ce9432
BP
2189static struct ovsrec_controller **
2190insert_controllers(struct ovsdb_idl_txn *txn, char *targets[], size_t n)
2191{
2192 struct ovsrec_controller **controllers;
2193 size_t i;
2194
2195 controllers = xmalloc(n * sizeof *controllers);
2196 for (i = 0; i < n; i++) {
070723f9
JP
2197 if (vconn_verify_name(targets[i]) && pvconn_verify_name(targets[i])) {
2198 VLOG_WARN("target type \"%s\" is possibly erroneous", targets[i]);
2199 }
76ce9432
BP
2200 controllers[i] = ovsrec_controller_insert(txn);
2201 ovsrec_controller_set_target(controllers[i], targets[i]);
2202 }
2203
2204 return controllers;
2205}
2206
5aa00635
JP
2207static void
2208cmd_set_controller(struct vsctl_context *ctx)
2209{
1a048029 2210 struct ovsrec_controller **controllers;
286a2e82 2211 struct ovsrec_bridge *br;
1a048029 2212 size_t n;
5aa00635 2213
5ce5a6b5
BP
2214 vsctl_context_populate_cache(ctx);
2215
286a2e82
BP
2216 br = find_real_bridge(ctx, ctx->argv[1], true)->br_cfg;
2217 verify_controllers(br);
28a14bf3 2218
286a2e82 2219 delete_controllers(br->controller, br->n_controller);
76ce9432 2220
1a048029
JP
2221 n = ctx->argc - 2;
2222 controllers = insert_controllers(ctx->txn, &ctx->argv[2], n);
286a2e82 2223 ovsrec_bridge_set_controller(br, controllers, n);
1a048029 2224 free(controllers);
5aa00635
JP
2225}
2226
2227static void
2228cmd_get_fail_mode(struct vsctl_context *ctx)
2229{
1a048029 2230 struct vsctl_bridge *br;
753cb20f 2231 const char *fail_mode;
5aa00635 2232
5ce5a6b5
BP
2233 vsctl_context_populate_cache(ctx);
2234 br = find_bridge(ctx, ctx->argv[1], true);
5aa00635 2235
753cb20f
BP
2236 if (br->parent) {
2237 br = br->parent;
2238 }
2239 ovsrec_bridge_verify_fail_mode(br->br_cfg);
2240
2241 fail_mode = br->br_cfg->fail_mode;
2242 if (fail_mode && strlen(fail_mode)) {
2243 ds_put_format(&ctx->output, "%s\n", fail_mode);
5aa00635 2244 }
5aa00635
JP
2245}
2246
2247static void
2248cmd_del_fail_mode(struct vsctl_context *ctx)
2249{
1a048029 2250 struct vsctl_bridge *br;
5aa00635 2251
5ce5a6b5 2252 vsctl_context_populate_cache(ctx);
5aa00635 2253
5ce5a6b5 2254 br = find_real_bridge(ctx, ctx->argv[1], true);
5aa00635 2255
5ce5a6b5 2256 ovsrec_bridge_set_fail_mode(br->br_cfg, NULL);
5aa00635
JP
2257}
2258
2259static void
2260cmd_set_fail_mode(struct vsctl_context *ctx)
2261{
1a048029
JP
2262 struct vsctl_bridge *br;
2263 const char *fail_mode = ctx->argv[2];
5aa00635 2264
5ce5a6b5
BP
2265 vsctl_context_populate_cache(ctx);
2266
2267 br = find_real_bridge(ctx, ctx->argv[1], true);
5aa00635
JP
2268
2269 if (strcmp(fail_mode, "standalone") && strcmp(fail_mode, "secure")) {
2270 vsctl_fatal("fail-mode must be \"standalone\" or \"secure\"");
2271 }
2272
31681a5d 2273 ovsrec_bridge_set_fail_mode(br->br_cfg, fail_mode);
5aa00635 2274}
dd8ac6fe 2275
24b8b259
AE
2276static void
2277verify_managers(const struct ovsrec_open_vswitch *ovs)
2278{
2279 size_t i;
2280
24b8b259
AE
2281 ovsrec_open_vswitch_verify_manager_options(ovs);
2282
2283 for (i = 0; i < ovs->n_manager_options; ++i) {
2284 const struct ovsrec_manager *mgr = ovs->manager_options[i];
2285
2286 ovsrec_manager_verify_target(mgr);
2287 }
2288}
2289
2290static void
2291pre_manager(struct vsctl_context *ctx)
2292{
24b8b259
AE
2293 ovsdb_idl_add_column(ctx->idl, &ovsrec_open_vswitch_col_manager_options);
2294 ovsdb_idl_add_column(ctx->idl, &ovsrec_manager_col_target);
2295}
2296
2297static void
2298cmd_get_manager(struct vsctl_context *ctx)
2299{
2300 const struct ovsrec_open_vswitch *ovs = ctx->ovs;
2301 struct svec targets;
2302 size_t i;
2303
2304 verify_managers(ovs);
2305
2306 /* Print the targets in sorted order for reproducibility. */
2307 svec_init(&targets);
2308
24b8b259
AE
2309 for (i = 0; i < ovs->n_manager_options; i++) {
2310 svec_add(&targets, ovs->manager_options[i]->target);
2311 }
2312
2313 svec_sort_unique(&targets);
2314 for (i = 0; i < targets.n; i++) {
2315 ds_put_format(&ctx->output, "%s\n", targets.names[i]);
2316 }
2317 svec_destroy(&targets);
2318}
2319
24b8b259 2320static void
28a14bf3 2321delete_managers(const struct vsctl_context *ctx)
24b8b259
AE
2322{
2323 const struct ovsrec_open_vswitch *ovs = ctx->ovs;
28a14bf3
EJ
2324 size_t i;
2325
2326 /* Delete Manager rows pointed to by 'manager_options' column. */
2327 for (i = 0; i < ovs->n_manager_options; i++) {
2328 ovsrec_manager_delete(ovs->manager_options[i]);
2329 }
24b8b259 2330
28a14bf3 2331 /* Delete 'Manager' row refs in 'manager_options' column. */
c5f341ab 2332 ovsrec_open_vswitch_set_manager_options(ovs, NULL, 0);
24b8b259
AE
2333}
2334
28a14bf3
EJ
2335static void
2336cmd_del_manager(struct vsctl_context *ctx)
2337{
2338 const struct ovsrec_open_vswitch *ovs = ctx->ovs;
2339
2340 verify_managers(ovs);
2341 delete_managers(ctx);
2342}
2343
24b8b259
AE
2344static void
2345insert_managers(struct vsctl_context *ctx, char *targets[], size_t n)
2346{
2347 struct ovsrec_manager **managers;
2348 size_t i;
2349
24b8b259
AE
2350 /* Insert each manager in a new row in Manager table. */
2351 managers = xmalloc(n * sizeof *managers);
2352 for (i = 0; i < n; i++) {
070723f9
JP
2353 if (stream_verify_name(targets[i]) && pstream_verify_name(targets[i])) {
2354 VLOG_WARN("target type \"%s\" is possibly erroneous", targets[i]);
2355 }
24b8b259
AE
2356 managers[i] = ovsrec_manager_insert(ctx->txn);
2357 ovsrec_manager_set_target(managers[i], targets[i]);
2358 }
2359
2360 /* Store uuids of new Manager rows in 'manager_options' column. */
2361 ovsrec_open_vswitch_set_manager_options(ctx->ovs, managers, n);
2362 free(managers);
2363}
2364
2365static void
2366cmd_set_manager(struct vsctl_context *ctx)
2367{
2368 const size_t n = ctx->argc - 1;
2369
28a14bf3
EJ
2370 verify_managers(ctx->ovs);
2371 delete_managers(ctx);
24b8b259
AE
2372 insert_managers(ctx, &ctx->argv[1], n);
2373}
2374
e5e12280
BP
2375static void
2376pre_cmd_get_ssl(struct vsctl_context *ctx)
2377{
2378 ovsdb_idl_add_column(ctx->idl, &ovsrec_open_vswitch_col_ssl);
2379
2380 ovsdb_idl_add_column(ctx->idl, &ovsrec_ssl_col_private_key);
2381 ovsdb_idl_add_column(ctx->idl, &ovsrec_ssl_col_certificate);
2382 ovsdb_idl_add_column(ctx->idl, &ovsrec_ssl_col_ca_cert);
2383 ovsdb_idl_add_column(ctx->idl, &ovsrec_ssl_col_bootstrap_ca_cert);
2384}
2385
dd8ac6fe
JP
2386static void
2387cmd_get_ssl(struct vsctl_context *ctx)
2388{
2389 struct ovsrec_ssl *ssl = ctx->ovs->ssl;
2390
f74055e7 2391 ovsrec_open_vswitch_verify_ssl(ctx->ovs);
dd8ac6fe 2392 if (ssl) {
f74055e7
BP
2393 ovsrec_ssl_verify_private_key(ssl);
2394 ovsrec_ssl_verify_certificate(ssl);
2395 ovsrec_ssl_verify_ca_cert(ssl);
2396 ovsrec_ssl_verify_bootstrap_ca_cert(ssl);
2397
dd8ac6fe
JP
2398 ds_put_format(&ctx->output, "Private key: %s\n", ssl->private_key);
2399 ds_put_format(&ctx->output, "Certificate: %s\n", ssl->certificate);
2400 ds_put_format(&ctx->output, "CA Certificate: %s\n", ssl->ca_cert);
2401 ds_put_format(&ctx->output, "Bootstrap: %s\n",
2402 ssl->bootstrap_ca_cert ? "true" : "false");
2403 }
2404}
2405
e5e12280
BP
2406static void
2407pre_cmd_del_ssl(struct vsctl_context *ctx)
2408{
2409 ovsdb_idl_add_column(ctx->idl, &ovsrec_open_vswitch_col_ssl);
2410}
2411
dd8ac6fe
JP
2412static void
2413cmd_del_ssl(struct vsctl_context *ctx)
2414{
28a14bf3
EJ
2415 struct ovsrec_ssl *ssl = ctx->ovs->ssl;
2416
2417 if (ssl) {
2418 ovsrec_open_vswitch_verify_ssl(ctx->ovs);
2419 ovsrec_ssl_delete(ssl);
2420 ovsrec_open_vswitch_set_ssl(ctx->ovs, NULL);
2421 }
dd8ac6fe
JP
2422}
2423
e5e12280
BP
2424static void
2425pre_cmd_set_ssl(struct vsctl_context *ctx)
2426{
2427 ovsdb_idl_add_column(ctx->idl, &ovsrec_open_vswitch_col_ssl);
2428}
2429
dd8ac6fe
JP
2430static void
2431cmd_set_ssl(struct vsctl_context *ctx)
2432{
2433 bool bootstrap = shash_find(&ctx->options, "--bootstrap");
28a14bf3 2434 struct ovsrec_ssl *ssl = ctx->ovs->ssl;
dd8ac6fe 2435
28a14bf3
EJ
2436 ovsrec_open_vswitch_verify_ssl(ctx->ovs);
2437 if (ssl) {
2438 ovsrec_ssl_delete(ssl);
2439 }
f8ff4bc4 2440 ssl = ovsrec_ssl_insert(ctx->txn);
dd8ac6fe
JP
2441
2442 ovsrec_ssl_set_private_key(ssl, ctx->argv[1]);
2443 ovsrec_ssl_set_certificate(ssl, ctx->argv[2]);
2444 ovsrec_ssl_set_ca_cert(ssl, ctx->argv[3]);
2445
2446 ovsrec_ssl_set_bootstrap_ca_cert(ssl, bootstrap);
2447
2448 ovsrec_open_vswitch_set_ssl(ctx->ovs, ssl);
2449}
c75d1511 2450\f
ad83bfa6
BP
2451/* Parameter commands. */
2452
ad83bfa6
BP
2453struct vsctl_row_id {
2454 const struct ovsdb_idl_table_class *table;
2455 const struct ovsdb_idl_column *name_column;
2456 const struct ovsdb_idl_column *uuid_column;
2457};
2458
2459struct vsctl_table_class {
2460 struct ovsdb_idl_table_class *class;
ad83bfa6
BP
2461 struct vsctl_row_id row_ids[2];
2462};
2463
2464static const struct vsctl_table_class tables[] = {
bd76d25d 2465 {&ovsrec_table_bridge,
ad83bfa6
BP
2466 {{&ovsrec_table_bridge, &ovsrec_bridge_col_name, NULL},
2467 {NULL, NULL, NULL}}},
2468
bd76d25d 2469 {&ovsrec_table_controller,
ad83bfa6
BP
2470 {{&ovsrec_table_bridge,
2471 &ovsrec_bridge_col_name,
1a048029 2472 &ovsrec_bridge_col_controller}}},
ad83bfa6 2473
bd76d25d 2474 {&ovsrec_table_interface,
ad83bfa6
BP
2475 {{&ovsrec_table_interface, &ovsrec_interface_col_name, NULL},
2476 {NULL, NULL, NULL}}},
2477
bd76d25d 2478 {&ovsrec_table_mirror,
ad83bfa6
BP
2479 {{&ovsrec_table_mirror, &ovsrec_mirror_col_name, NULL},
2480 {NULL, NULL, NULL}}},
2481
94db5407
BP
2482 {&ovsrec_table_manager,
2483 {{&ovsrec_table_manager, &ovsrec_manager_col_target, NULL},
2484 {NULL, NULL, NULL}}},
2485
bd76d25d 2486 {&ovsrec_table_netflow,
ad83bfa6
BP
2487 {{&ovsrec_table_bridge,
2488 &ovsrec_bridge_col_name,
2489 &ovsrec_bridge_col_netflow},
2490 {NULL, NULL, NULL}}},
2491
bd76d25d 2492 {&ovsrec_table_open_vswitch,
ad83bfa6
BP
2493 {{&ovsrec_table_open_vswitch, NULL, NULL},
2494 {NULL, NULL, NULL}}},
2495
bd76d25d 2496 {&ovsrec_table_port,
ad83bfa6
BP
2497 {{&ovsrec_table_port, &ovsrec_port_col_name, NULL},
2498 {NULL, NULL, NULL}}},
2499
c1c9c9c4
BP
2500 {&ovsrec_table_qos,
2501 {{&ovsrec_table_port, &ovsrec_port_col_name, &ovsrec_port_col_qos},
2502 {NULL, NULL, NULL}}},
2503
2504 {&ovsrec_table_queue,
2505 {{NULL, NULL, NULL},
2506 {NULL, NULL, NULL}}},
2507
bd76d25d 2508 {&ovsrec_table_ssl,
ad83bfa6
BP
2509 {{&ovsrec_table_open_vswitch, NULL, &ovsrec_open_vswitch_col_ssl}}},
2510
d01600a2
BP
2511 {&ovsrec_table_sflow,
2512 {{&ovsrec_table_bridge,
2513 &ovsrec_bridge_col_name,
2514 &ovsrec_bridge_col_sflow},
2515 {NULL, NULL, NULL}}},
2516
254750ce
BP
2517 {&ovsrec_table_flow_table,
2518 {{&ovsrec_table_flow_table, &ovsrec_flow_table_col_name, NULL},
2519 {NULL, NULL, NULL}}},
2520
bd76d25d 2521 {NULL, {{NULL, NULL, NULL}, {NULL, NULL, NULL}}}
ad83bfa6
BP
2522};
2523
1bc6ff29
BP
2524static void
2525die_if_error(char *error)
2526{
2527 if (error) {
def90f62 2528 vsctl_fatal("%s", error);
1bc6ff29
BP
2529 }
2530}
2531
ad83bfa6
BP
2532static int
2533to_lower_and_underscores(unsigned c)
2534{
2535 return c == '-' ? '_' : tolower(c);
2536}
2537
2538static unsigned int
2539score_partial_match(const char *name, const char *s)
2540{
2541 int score;
2542
5128bd9c
BP
2543 if (!strcmp(name, s)) {
2544 return UINT_MAX;
2545 }
ad83bfa6
BP
2546 for (score = 0; ; score++, name++, s++) {
2547 if (to_lower_and_underscores(*name) != to_lower_and_underscores(*s)) {
2548 break;
2549 } else if (*name == '\0') {
5128bd9c 2550 return UINT_MAX - 1;
ad83bfa6
BP
2551 }
2552 }
2553 return *s == '\0' ? score : 0;
2554}
2555
2556static const struct vsctl_table_class *
2557get_table(const char *table_name)
2558{
2559 const struct vsctl_table_class *table;
2560 const struct vsctl_table_class *best_match = NULL;
2561 unsigned int best_score = 0;
2562
2563 for (table = tables; table->class; table++) {
2564 unsigned int score = score_partial_match(table->class->name,
2565 table_name);
2566 if (score > best_score) {
2567 best_match = table;
2568 best_score = score;
2569 } else if (score == best_score) {
2570 best_match = NULL;
2571 }
2572 }
2573 if (best_match) {
2574 return best_match;
2575 } else if (best_score) {
def90f62 2576 vsctl_fatal("multiple table names match \"%s\"", table_name);
ad83bfa6 2577 } else {
def90f62 2578 vsctl_fatal("unknown table \"%s\"", table_name);
ad83bfa6
BP
2579 }
2580}
2581
e5e12280
BP
2582static const struct vsctl_table_class *
2583pre_get_table(struct vsctl_context *ctx, const char *table_name)
2584{
2585 const struct vsctl_table_class *table_class;
2586 int i;
2587
2588 table_class = get_table(table_name);
2589 ovsdb_idl_add_table(ctx->idl, table_class->class);
2590
2591 for (i = 0; i < ARRAY_SIZE(table_class->row_ids); i++) {
2592 const struct vsctl_row_id *id = &table_class->row_ids[i];
2593 if (id->table) {
2594 ovsdb_idl_add_table(ctx->idl, id->table);
2595 }
2596 if (id->name_column) {
2597 ovsdb_idl_add_column(ctx->idl, id->name_column);
2598 }
2599 if (id->uuid_column) {
2600 ovsdb_idl_add_column(ctx->idl, id->uuid_column);
2601 }
2602 }
2603
2604 return table_class;
2605}
2606
ad83bfa6
BP
2607static const struct ovsdb_idl_row *
2608get_row_by_id(struct vsctl_context *ctx, const struct vsctl_table_class *table,
e111e681 2609 const struct vsctl_row_id *id, const char *record_id)
ad83bfa6
BP
2610{
2611 const struct ovsdb_idl_row *referrer, *final;
2612
2613 if (!id->table) {
2614 return NULL;
2615 }
2616
2617 if (!id->name_column) {
2618 if (strcmp(record_id, ".")) {
2619 return NULL;
2620 }
2621 referrer = ovsdb_idl_first_row(ctx->idl, id->table);
2622 if (!referrer || ovsdb_idl_next_row(referrer)) {
2623 return NULL;
2624 }
2625 } else {
2626 const struct ovsdb_idl_row *row;
ad83bfa6 2627
ad83bfa6
BP
2628 referrer = NULL;
2629 for (row = ovsdb_idl_first_row(ctx->idl, id->table);
e111e681 2630 row != NULL;
ad83bfa6
BP
2631 row = ovsdb_idl_next_row(row))
2632 {
8c3c2f30 2633 const struct ovsdb_datum *name;
ad83bfa6 2634
8c3c2f30
BP
2635 name = ovsdb_idl_get(row, id->name_column,
2636 OVSDB_TYPE_STRING, OVSDB_TYPE_VOID);
e111e681
BP
2637 if (name->n == 1 && !strcmp(name->keys[0].string, record_id)) {
2638 if (referrer) {
2639 vsctl_fatal("multiple rows in %s match \"%s\"",
2640 table->class->name, record_id);
ad83bfa6 2641 }
e111e681 2642 referrer = row;
ad83bfa6 2643 }
ad83bfa6
BP
2644 }
2645 }
2646 if (!referrer) {
2647 return NULL;
2648 }
2649
93255bc5 2650 final = NULL;
ad83bfa6 2651 if (id->uuid_column) {
8c3c2f30 2652 const struct ovsdb_datum *uuid;
ad83bfa6 2653
f74055e7 2654 ovsdb_idl_txn_verify(referrer, id->uuid_column);
8c3c2f30
BP
2655 uuid = ovsdb_idl_get(referrer, id->uuid_column,
2656 OVSDB_TYPE_UUID, OVSDB_TYPE_VOID);
2657 if (uuid->n == 1) {
ad83bfa6 2658 final = ovsdb_idl_get_row_for_uuid(ctx->idl, table->class,
8c3c2f30 2659 &uuid->keys[0].uuid);
ad83bfa6 2660 }
ad83bfa6
BP
2661 } else {
2662 final = referrer;
2663 }
2664
2665 return final;
2666}
2667
2668static const struct ovsdb_idl_row *
e111e681 2669get_row (struct vsctl_context *ctx,
e99d41f7
BP
2670 const struct vsctl_table_class *table, const char *record_id,
2671 bool must_exist)
ad83bfa6
BP
2672{
2673 const struct ovsdb_idl_row *row;
2674 struct uuid uuid;
2675
2676 if (uuid_from_string(&uuid, record_id)) {
2677 row = ovsdb_idl_get_row_for_uuid(ctx->idl, table->class, &uuid);
2678 } else {
2679 int i;
2680
2681 for (i = 0; i < ARRAY_SIZE(table->row_ids); i++) {
e111e681 2682 row = get_row_by_id(ctx, table, &table->row_ids[i], record_id);
ad83bfa6
BP
2683 if (row) {
2684 break;
2685 }
2686 }
2687 }
e99d41f7 2688 if (must_exist && !row) {
def90f62
BP
2689 vsctl_fatal("no row \"%s\" in table %s",
2690 record_id, table->class->name);
ad83bfa6
BP
2691 }
2692 return row;
2693}
2694
1bc6ff29
BP
2695static char *
2696get_column(const struct vsctl_table_class *table, const char *column_name,
bd76d25d 2697 const struct ovsdb_idl_column **columnp)
ad83bfa6 2698{
bd76d25d 2699 const struct ovsdb_idl_column *best_match = NULL;
ad83bfa6 2700 unsigned int best_score = 0;
bd76d25d 2701 size_t i;
ad83bfa6 2702
bd76d25d
BP
2703 for (i = 0; i < table->class->n_columns; i++) {
2704 const struct ovsdb_idl_column *column = &table->class->columns[i];
2705 unsigned int score = score_partial_match(column->name, column_name);
2706 if (score > best_score) {
2707 best_match = column;
2708 best_score = score;
2709 } else if (score == best_score) {
2710 best_match = NULL;
ad83bfa6
BP
2711 }
2712 }
1bc6ff29
BP
2713
2714 *columnp = best_match;
ad83bfa6 2715 if (best_match) {
1bc6ff29 2716 return NULL;
ad83bfa6 2717 } else if (best_score) {
1bc6ff29
BP
2718 return xasprintf("%s contains more than one column whose name "
2719 "matches \"%s\"", table->class->name, column_name);
ad83bfa6 2720 } else {
1bc6ff29
BP
2721 return xasprintf("%s does not contain a column whose name matches "
2722 "\"%s\"", table->class->name, column_name);
ad83bfa6
BP
2723 }
2724}
2725
c5f341ab 2726static struct ovsdb_symbol *
aed133bf
BP
2727create_symbol(struct ovsdb_symbol_table *symtab, const char *id, bool *newp)
2728{
2729 struct ovsdb_symbol *symbol;
2730
2731 if (id[0] != '@') {
2732 vsctl_fatal("row id \"%s\" does not begin with \"@\"", id);
2733 }
2734
2735 if (newp) {
2736 *newp = ovsdb_symbol_table_get(symtab, id) == NULL;
2737 }
2738
2739 symbol = ovsdb_symbol_table_insert(symtab, id);
e9387de4 2740 if (symbol->created) {
aed133bf
BP
2741 vsctl_fatal("row id \"%s\" may only be specified on one --id option",
2742 id);
2743 }
e9387de4 2744 symbol->created = true;
c5f341ab 2745 return symbol;
aed133bf
BP
2746}
2747
e5e12280
BP
2748static void
2749pre_get_column(struct vsctl_context *ctx,
2750 const struct vsctl_table_class *table, const char *column_name,
2751 const struct ovsdb_idl_column **columnp)
2752{
2753 die_if_error(get_column(table, column_name, columnp));
2754 ovsdb_idl_add_column(ctx->idl, *columnp);
2755}
2756
e89e5374
BP
2757static char *
2758missing_operator_error(const char *arg, const char **allowed_operators,
2759 size_t n_allowed)
2760{
2761 struct ds s;
2762
2763 ds_init(&s);
2764 ds_put_format(&s, "%s: argument does not end in ", arg);
2765 ds_put_format(&s, "\"%s\"", allowed_operators[0]);
2766 if (n_allowed == 2) {
2767 ds_put_format(&s, " or \"%s\"", allowed_operators[1]);
2768 } else if (n_allowed > 2) {
2769 size_t i;
2770
2771 for (i = 1; i < n_allowed - 1; i++) {
2772 ds_put_format(&s, ", \"%s\"", allowed_operators[i]);
2773 }
2774 ds_put_format(&s, ", or \"%s\"", allowed_operators[i]);
2775 }
2776 ds_put_format(&s, " followed by a value.");
2777
2778 return ds_steal_cstr(&s);
2779}
2780
2781/* Breaks 'arg' apart into a number of fields in the following order:
2782 *
4a433a0f
BP
2783 * - The name of a column in 'table', stored into '*columnp'. The column
2784 * name may be abbreviated.
e89e5374 2785 *
4a433a0f
BP
2786 * - Optionally ':' followed by a key string. The key is stored as a
2787 * malloc()'d string into '*keyp', or NULL if no key is present in
2788 * 'arg'.
e89e5374
BP
2789 *
2790 * - If 'valuep' is nonnull, an operator followed by a value string. The
2791 * allowed operators are the 'n_allowed' string in 'allowed_operators',
2792 * or just "=" if 'n_allowed' is 0. If 'operatorp' is nonnull, then the
2a9537e2
BP
2793 * index of the operator within 'allowed_operators' is stored into
2794 * '*operatorp'. The value is stored as a malloc()'d string into
2795 * '*valuep', or NULL if no value is present in 'arg'.
e89e5374 2796 *
e89e5374
BP
2797 * On success, returns NULL. On failure, returned a malloc()'d string error
2798 * message and stores NULL into all of the nonnull output arguments. */
1bc6ff29 2799static char * WARN_UNUSED_RESULT
e89e5374
BP
2800parse_column_key_value(const char *arg,
2801 const struct vsctl_table_class *table,
2802 const struct ovsdb_idl_column **columnp, char **keyp,
2a9537e2 2803 int *operatorp,
e89e5374
BP
2804 const char **allowed_operators, size_t n_allowed,
2805 char **valuep)
ad83bfa6
BP
2806{
2807 const char *p = arg;
4a433a0f 2808 char *column_name;
1bc6ff29 2809 char *error;
ad83bfa6 2810
cb22974d 2811 ovs_assert(!(operatorp && !valuep));
4a433a0f 2812 *keyp = NULL;
1bc6ff29
BP
2813 if (valuep) {
2814 *valuep = NULL;
2815 }
ad83bfa6
BP
2816
2817 /* Parse column name. */
4a433a0f
BP
2818 error = ovsdb_token_parse(&p, &column_name);
2819 if (error) {
2820 goto error;
2821 }
2822 if (column_name[0] == '\0') {
a3326252 2823 free(column_name);
4a433a0f
BP
2824 error = xasprintf("%s: missing column name", arg);
2825 goto error;
2826 }
2827 error = get_column(table, column_name, columnp);
2828 free(column_name);
2829 if (error) {
2830 goto error;
ad83bfa6
BP
2831 }
2832
2833 /* Parse key string. */
4a433a0f
BP
2834 if (*p == ':') {
2835 p++;
1bc6ff29
BP
2836 error = ovsdb_token_parse(&p, keyp);
2837 if (error) {
2838 goto error;
ad83bfa6 2839 }
ad83bfa6
BP
2840 }
2841
2842 /* Parse value string. */
e89e5374 2843 if (valuep) {
e89e5374
BP
2844 size_t best_len;
2845 size_t i;
2a9537e2 2846 int best;
e89e5374
BP
2847
2848 if (!allowed_operators) {
2849 static const char *equals = "=";
2850 allowed_operators = &equals;
2851 n_allowed = 1;
2852 }
2853
2a9537e2 2854 best = -1;
e89e5374
BP
2855 best_len = 0;
2856 for (i = 0; i < n_allowed; i++) {
2857 const char *op = allowed_operators[i];
2858 size_t op_len = strlen(op);
2859
7db03f7c 2860 if (op_len > best_len && !strncmp(op, p, op_len) && p[op_len]) {
e89e5374 2861 best_len = op_len;
2a9537e2 2862 best = i;
e89e5374
BP
2863 }
2864 }
2a9537e2 2865 if (best < 0) {
e89e5374 2866 error = missing_operator_error(arg, allowed_operators, n_allowed);
1bc6ff29 2867 goto error;
ad83bfa6 2868 }
e89e5374
BP
2869
2870 if (operatorp) {
2871 *operatorp = best;
2872 }
7db03f7c 2873 *valuep = xstrdup(p + best_len);
ad83bfa6 2874 } else {
1bc6ff29 2875 if (*p != '\0') {
c29a8ba8
BP
2876 error = xasprintf("%s: trailing garbage \"%s\" in argument",
2877 arg, p);
1bc6ff29
BP
2878 goto error;
2879 }
2880 }
2881 return NULL;
2882
2883error:
4a433a0f
BP
2884 *columnp = NULL;
2885 free(*keyp);
2886 *keyp = NULL;
1bc6ff29
BP
2887 if (valuep) {
2888 free(*valuep);
2889 *valuep = NULL;
e89e5374 2890 if (operatorp) {
2a9537e2 2891 *operatorp = -1;
e89e5374 2892 }
ad83bfa6 2893 }
1bc6ff29 2894 return error;
ad83bfa6
BP
2895}
2896
341c4e59 2897static const struct ovsdb_idl_column *
e5e12280
BP
2898pre_parse_column_key_value(struct vsctl_context *ctx,
2899 const char *arg,
2900 const struct vsctl_table_class *table)
2901{
2902 const struct ovsdb_idl_column *column;
2903 const char *p;
2904 char *column_name;
2905
2906 p = arg;
2907 die_if_error(ovsdb_token_parse(&p, &column_name));
2908 if (column_name[0] == '\0') {
2909 vsctl_fatal("%s: missing column name", arg);
2910 }
2911
2912 pre_get_column(ctx, table, column_name, &column);
2913 free(column_name);
341c4e59
BP
2914
2915 return column;
2916}
2917
2918static void
2919check_mutable(const struct vsctl_table_class *table,
2920 const struct ovsdb_idl_column *column)
2921{
2922 if (!column->mutable) {
2923 vsctl_fatal("cannot modify read-only column %s in table %s",
2924 column->name, table->class->name);
2925 }
e5e12280
BP
2926}
2927
2928static void
2929pre_cmd_get(struct vsctl_context *ctx)
2930{
6d5abe94 2931 const char *id = shash_find_data(&ctx->options, "--id");
e5e12280
BP
2932 const char *table_name = ctx->argv[1];
2933 const struct vsctl_table_class *table;
2934 int i;
2935
6d5abe94
BP
2936 /* Using "get" without --id or a column name could possibly make sense.
2937 * Maybe, for example, a ovs-vsctl run wants to assert that a row exists.
2938 * But it is unlikely that an interactive user would want to do that, so
2939 * issue a warning if we're running on a terminal. */
2940 if (!id && ctx->argc <= 3 && isatty(STDOUT_FILENO)) {
2941 VLOG_WARN("\"get\" command without row arguments or \"--id\" is "
2942 "possibly erroneous");
2943 }
2944
e5e12280
BP
2945 table = pre_get_table(ctx, table_name);
2946 for (i = 3; i < ctx->argc; i++) {
2947 if (!strcasecmp(ctx->argv[i], "_uuid")
2948 || !strcasecmp(ctx->argv[i], "-uuid")) {
2949 continue;
2950 }
2951
2952 pre_parse_column_key_value(ctx, ctx->argv[i], table);
2953 }
2954}
2955
ad83bfa6
BP
2956static void
2957cmd_get(struct vsctl_context *ctx)
2958{
aed133bf 2959 const char *id = shash_find_data(&ctx->options, "--id");
e99d41f7 2960 bool must_exist = !shash_find(&ctx->options, "--if-exists");
ad83bfa6
BP
2961 const char *table_name = ctx->argv[1];
2962 const char *record_id = ctx->argv[2];
2963 const struct vsctl_table_class *table;
2964 const struct ovsdb_idl_row *row;
2965 struct ds *out = &ctx->output;
2966 int i;
2967
e99d41f7
BP
2968 if (id && !must_exist) {
2969 vsctl_fatal("--if-exists and --id may not be specified together");
2970 }
2971
ad83bfa6 2972 table = get_table(table_name);
e99d41f7
BP
2973 row = get_row(ctx, table, record_id, must_exist);
2974 if (!row) {
2975 return;
2976 }
2977
aed133bf 2978 if (id) {
c5f341ab 2979 struct ovsdb_symbol *symbol;
aed133bf
BP
2980 bool new;
2981
c5f341ab 2982 symbol = create_symbol(ctx->symtab, id, &new);
aed133bf
BP
2983 if (!new) {
2984 vsctl_fatal("row id \"%s\" specified on \"get\" command was used "
2985 "before it was defined", id);
2986 }
c5f341ab
BP
2987 symbol->uuid = row->uuid;
2988
2989 /* This symbol refers to a row that already exists, so disable warnings
2990 * about it being unreferenced. */
2991 symbol->strong_ref = true;
aed133bf 2992 }
ad83bfa6 2993 for (i = 3; i < ctx->argc; i++) {
bd76d25d 2994 const struct ovsdb_idl_column *column;
8c3c2f30 2995 const struct ovsdb_datum *datum;
ad83bfa6
BP
2996 char *key_string;
2997
f40a9b61
BP
2998 /* Special case for obtaining the UUID of a row. We can't just do this
2999 * through parse_column_key_value() below since it returns a "struct
3000 * ovsdb_idl_column" and the UUID column doesn't have one. */
3001 if (!strcasecmp(ctx->argv[i], "_uuid")
3002 || !strcasecmp(ctx->argv[i], "-uuid")) {
3003 ds_put_format(out, UUID_FMT"\n", UUID_ARGS(&row->uuid));
3004 continue;
3005 }
3006
1bc6ff29 3007 die_if_error(parse_column_key_value(ctx->argv[i], table,
e89e5374
BP
3008 &column, &key_string,
3009 NULL, NULL, 0, NULL));
ad83bfa6 3010
f74055e7 3011 ovsdb_idl_txn_verify(row, column);
8c3c2f30 3012 datum = ovsdb_idl_read(row, column);
ad83bfa6
BP
3013 if (key_string) {
3014 union ovsdb_atom key;
3015 unsigned int idx;
3016
bd76d25d 3017 if (column->type.value.type == OVSDB_TYPE_VOID) {
def90f62 3018 vsctl_fatal("cannot specify key to get for non-map column %s",
bd76d25d 3019 column->name);
ad83bfa6
BP
3020 }
3021
1bc6ff29 3022 die_if_error(ovsdb_atom_from_string(&key,
bd76d25d 3023 &column->type.key,
ce5a3e38 3024 key_string, ctx->symtab));
ad83bfa6 3025
8c3c2f30 3026 idx = ovsdb_datum_find_key(datum, &key,
bd76d25d 3027 column->type.key.type);
ad83bfa6 3028 if (idx == UINT_MAX) {
e99d41f7 3029 if (must_exist) {
def90f62
BP
3030 vsctl_fatal("no key \"%s\" in %s record \"%s\" column %s",
3031 key_string, table->class->name, record_id,
bd76d25d 3032 column->name);
870aeb4a
BP
3033 }
3034 } else {
8c3c2f30 3035 ovsdb_atom_to_string(&datum->values[idx],
bd76d25d 3036 column->type.value.type, out);
ad83bfa6 3037 }
bd76d25d 3038 ovsdb_atom_destroy(&key, column->type.key.type);
ad83bfa6 3039 } else {
8c3c2f30 3040 ovsdb_datum_to_string(datum, &column->type, out);
ad83bfa6
BP
3041 }
3042 ds_put_char(out, '\n');
ad83bfa6
BP
3043
3044 free(key_string);
3045 }
3046}
3047
9591fefe
BP
3048static void
3049parse_column_names(const char *column_names,
3050 const struct vsctl_table_class *table,
3051 const struct ovsdb_idl_column ***columnsp,
3052 size_t *n_columnsp)
3053{
3054 const struct ovsdb_idl_column **columns;
3055 size_t n_columns;
3056
3057 if (!column_names) {
3058 size_t i;
3059
3060 n_columns = table->class->n_columns + 1;
3061 columns = xmalloc(n_columns * sizeof *columns);
3062 columns[0] = NULL;
3063 for (i = 0; i < table->class->n_columns; i++) {
3064 columns[i + 1] = &table->class->columns[i];
3065 }
3066 } else {
3067 char *s = xstrdup(column_names);
3068 size_t allocated_columns;
3069 char *save_ptr = NULL;
3070 char *column_name;
3071
3072 columns = NULL;
3073 allocated_columns = n_columns = 0;
3074 for (column_name = strtok_r(s, ", ", &save_ptr); column_name;
3075 column_name = strtok_r(NULL, ", ", &save_ptr)) {
3076 const struct ovsdb_idl_column *column;
3077
3078 if (!strcasecmp(column_name, "_uuid")) {
3079 column = NULL;
3080 } else {
3081 die_if_error(get_column(table, column_name, &column));
3082 }
3083 if (n_columns >= allocated_columns) {
3084 columns = x2nrealloc(columns, &allocated_columns,
3085 sizeof *columns);
3086 }
3087 columns[n_columns++] = column;
3088 }
3089 free(s);
3090
3091 if (!n_columns) {
3092 vsctl_fatal("must specify at least one column name");
3093 }
3094 }
3095 *columnsp = columns;
3096 *n_columnsp = n_columns;
3097}
3098
3099
3100static void
3101pre_list_columns(struct vsctl_context *ctx,
3102 const struct vsctl_table_class *table,
3103 const char *column_names)
3104{
3105 const struct ovsdb_idl_column **columns;
3106 size_t n_columns;
3107 size_t i;
3108
3109 parse_column_names(column_names, table, &columns, &n_columns);
3110 for (i = 0; i < n_columns; i++) {
3111 if (columns[i]) {
3112 ovsdb_idl_add_column(ctx->idl, columns[i]);
3113 }
3114 }
3115 free(columns);
3116}
3117
e5e12280
BP
3118static void
3119pre_cmd_list(struct vsctl_context *ctx)
3120{
9591fefe 3121 const char *column_names = shash_find_data(&ctx->options, "--columns");
e5e12280
BP
3122 const char *table_name = ctx->argv[1];
3123 const struct vsctl_table_class *table;
e5e12280
BP
3124
3125 table = pre_get_table(ctx, table_name);
9591fefe 3126 pre_list_columns(ctx, table, column_names);
e5e12280
BP
3127}
3128
e051b42c
BP
3129static struct table *
3130list_make_table(const struct ovsdb_idl_column **columns, size_t n_columns)
3131{
3132 struct table *out;
3133 size_t i;
3134
3135 out = xmalloc(sizeof *out);
3136 table_init(out);
3137
3138 for (i = 0; i < n_columns; i++) {
3139 const struct ovsdb_idl_column *column = columns[i];
3140 const char *column_name = column ? column->name : "_uuid";
3141
3142 table_add_column(out, "%s", column_name);
3143 }
3144
3145 return out;
3146}
3147
ad83bfa6 3148static void
9591fefe
BP
3149list_record(const struct ovsdb_idl_row *row,
3150 const struct ovsdb_idl_column **columns, size_t n_columns,
e051b42c 3151 struct table *out)
ad83bfa6 3152{
bd76d25d 3153 size_t i;
ad83bfa6 3154
e99d41f7
BP
3155 if (!row) {
3156 return;
3157 }
3158
e051b42c 3159 table_add_row(out);
9591fefe
BP
3160 for (i = 0; i < n_columns; i++) {
3161 const struct ovsdb_idl_column *column = columns[i];
e051b42c 3162 struct cell *cell = table_add_cell(out);
ad83bfa6 3163
9591fefe 3164 if (!column) {
e051b42c
BP
3165 struct ovsdb_datum datum;
3166 union ovsdb_atom atom;
3167
3168 atom.uuid = row->uuid;
3169
3170 datum.keys = &atom;
3171 datum.values = NULL;
3172 datum.n = 1;
3173
3174 cell->json = ovsdb_datum_to_json(&datum, &ovsdb_type_uuid);
3175 cell->type = &ovsdb_type_uuid;
9591fefe
BP
3176 } else {
3177 const struct ovsdb_datum *datum = ovsdb_idl_read(row, column);
e051b42c
BP
3178
3179 cell->json = ovsdb_datum_to_json(datum, &column->type);
3180 cell->type = &column->type;
9591fefe 3181 }
ad83bfa6
BP
3182 }
3183}
3184
3185static void
3186cmd_list(struct vsctl_context *ctx)
3187{
9591fefe 3188 const char *column_names = shash_find_data(&ctx->options, "--columns");
e99d41f7 3189 bool must_exist = !shash_find(&ctx->options, "--if-exists");
9591fefe 3190 const struct ovsdb_idl_column **columns;
ad83bfa6
BP
3191 const char *table_name = ctx->argv[1];
3192 const struct vsctl_table_class *table;
e051b42c 3193 struct table *out;
9591fefe 3194 size_t n_columns;
ad83bfa6
BP
3195 int i;
3196
3197 table = get_table(table_name);
9591fefe 3198 parse_column_names(column_names, table, &columns, &n_columns);
e051b42c 3199 out = ctx->table = list_make_table(columns, n_columns);
ad83bfa6
BP
3200 if (ctx->argc > 2) {
3201 for (i = 2; i < ctx->argc; i++) {
e99d41f7 3202 list_record(get_row(ctx, table, ctx->argv[i], must_exist),
9591fefe 3203 columns, n_columns, out);
ad83bfa6
BP
3204 }
3205 } else {
3206 const struct ovsdb_idl_row *row;
ad83bfa6 3207
16f4f61d
EJ
3208 for (row = ovsdb_idl_first_row(ctx->idl, table->class); row != NULL;
3209 row = ovsdb_idl_next_row(row)) {
9591fefe 3210 list_record(row, columns, n_columns, out);
ad83bfa6
BP
3211 }
3212 }
9591fefe 3213 free(columns);
ad83bfa6
BP
3214}
3215
0a140468
BP
3216static void
3217pre_cmd_find(struct vsctl_context *ctx)
3218{
3219 const char *column_names = shash_find_data(&ctx->options, "--columns");
3220 const char *table_name = ctx->argv[1];
3221 const struct vsctl_table_class *table;
3222 int i;
3223
3224 table = pre_get_table(ctx, table_name);
3225 pre_list_columns(ctx, table, column_names);
3226 for (i = 2; i < ctx->argc; i++) {
3227 pre_parse_column_key_value(ctx, ctx->argv[i], table);
3228 }
3229}
3230
3231static void
3232cmd_find(struct vsctl_context *ctx)
3233{
3234 const char *column_names = shash_find_data(&ctx->options, "--columns");
3235 const struct ovsdb_idl_column **columns;
3236 const char *table_name = ctx->argv[1];
3237 const struct vsctl_table_class *table;
3238 const struct ovsdb_idl_row *row;
e051b42c 3239 struct table *out;
0a140468
BP
3240 size_t n_columns;
3241
3242 table = get_table(table_name);
3243 parse_column_names(column_names, table, &columns, &n_columns);
e051b42c 3244 out = ctx->table = list_make_table(columns, n_columns);
0a140468
BP
3245 for (row = ovsdb_idl_first_row(ctx->idl, table->class); row;
3246 row = ovsdb_idl_next_row(row)) {
3247 int i;
3248
3249 for (i = 2; i < ctx->argc; i++) {
3250 if (!is_condition_satisfied(table, row, ctx->argv[i],
3251 ctx->symtab)) {
3252 goto next_row;
3253 }
3254 }
0a140468
BP
3255 list_record(row, columns, n_columns, out);
3256
3257 next_row: ;
3258 }
cea0c393 3259 free(columns);
0a140468
BP
3260}
3261
e5e12280
BP
3262static void
3263pre_cmd_set(struct vsctl_context *ctx)
3264{
3265 const char *table_name = ctx->argv[1];
3266 const struct vsctl_table_class *table;
3267 int i;
3268
3269 table = pre_get_table(ctx, table_name);
3270 for (i = 3; i < ctx->argc; i++) {
341c4e59
BP
3271 const struct ovsdb_idl_column *column;
3272
3273 column = pre_parse_column_key_value(ctx, ctx->argv[i], table);
3274 check_mutable(table, column);
e5e12280
BP
3275 }
3276}
3277
ad83bfa6 3278static void
557e3718 3279set_column(const struct vsctl_table_class *table,
ce5a3e38
BP
3280 const struct ovsdb_idl_row *row, const char *arg,
3281 struct ovsdb_symbol_table *symtab)
ad83bfa6 3282{
bd76d25d 3283 const struct ovsdb_idl_column *column;
557e3718
BP
3284 char *key_string, *value_string;
3285 char *error;
ad83bfa6 3286
557e3718 3287 error = parse_column_key_value(arg, table, &column, &key_string,
e89e5374 3288 NULL, NULL, 0, &value_string);
557e3718 3289 die_if_error(error);
557e3718 3290 if (!value_string) {
def90f62 3291 vsctl_fatal("%s: missing value", arg);
557e3718 3292 }
ad83bfa6 3293
557e3718
BP
3294 if (key_string) {
3295 union ovsdb_atom key, value;
8c3c2f30 3296 struct ovsdb_datum datum;
557e3718 3297
bd76d25d 3298 if (column->type.value.type == OVSDB_TYPE_VOID) {
def90f62 3299 vsctl_fatal("cannot specify key to set for non-map column %s",
bd76d25d 3300 column->name);
ad83bfa6
BP
3301 }
3302
bd76d25d 3303 die_if_error(ovsdb_atom_from_string(&key, &column->type.key,
ce5a3e38 3304 key_string, symtab));
bd76d25d 3305 die_if_error(ovsdb_atom_from_string(&value, &column->type.value,
ce5a3e38 3306 value_string, symtab));
ad83bfa6 3307
8c3c2f30
BP
3308 ovsdb_datum_init_empty(&datum);
3309 ovsdb_datum_add_unsafe(&datum, &key, &value, &column->type);
ad83bfa6 3310
bd76d25d
BP
3311 ovsdb_atom_destroy(&key, column->type.key.type);
3312 ovsdb_atom_destroy(&value, column->type.value.type);
a3326252 3313
8c3c2f30
BP
3314 ovsdb_datum_union(&datum, ovsdb_idl_read(row, column),
3315 &column->type, false);
3316 ovsdb_idl_txn_write(row, column, &datum);
557e3718
BP
3317 } else {
3318 struct ovsdb_datum datum;
ad83bfa6 3319
bd76d25d 3320 die_if_error(ovsdb_datum_from_string(&datum, &column->type,
ce5a3e38 3321 value_string, symtab));
bd76d25d 3322 ovsdb_idl_txn_write(row, column, &datum);
557e3718 3323 }
ad83bfa6 3324
557e3718 3325 free(key_string);
a3326252 3326 free(value_string);
557e3718 3327}
ad83bfa6 3328
557e3718
BP
3329static void
3330cmd_set(struct vsctl_context *ctx)
3331{
e99d41f7 3332 bool must_exist = !shash_find(&ctx->options, "--if-exists");
557e3718
BP
3333 const char *table_name = ctx->argv[1];
3334 const char *record_id = ctx->argv[2];
3335 const struct vsctl_table_class *table;
3336 const struct ovsdb_idl_row *row;
3337 int i;
ad83bfa6 3338
557e3718 3339 table = get_table(table_name);
e99d41f7
BP
3340 row = get_row(ctx, table, record_id, must_exist);
3341 if (!row) {
3342 return;
3343 }
3344
557e3718 3345 for (i = 3; i < ctx->argc; i++) {
ce5a3e38 3346 set_column(table, row, ctx->argv[i], ctx->symtab);
ad83bfa6 3347 }
5ce5a6b5
BP
3348
3349 vsctl_context_invalidate_cache(ctx);
ad83bfa6
BP
3350}
3351
e5e12280
BP
3352static void
3353pre_cmd_add(struct vsctl_context *ctx)
3354{
3355 const char *table_name = ctx->argv[1];
3356 const char *column_name = ctx->argv[3];
3357 const struct vsctl_table_class *table;
3358 const struct ovsdb_idl_column *column;
3359
3360 table = pre_get_table(ctx, table_name);
3361 pre_get_column(ctx, table, column_name, &column);
341c4e59 3362 check_mutable(table, column);
e5e12280
BP
3363}
3364
ad83bfa6
BP
3365static void
3366cmd_add(struct vsctl_context *ctx)
3367{
e99d41f7 3368 bool must_exist = !shash_find(&ctx->options, "--if-exists");
ad83bfa6
BP
3369 const char *table_name = ctx->argv[1];
3370 const char *record_id = ctx->argv[2];
3371 const char *column_name = ctx->argv[3];
3372 const struct vsctl_table_class *table;
bd76d25d 3373 const struct ovsdb_idl_column *column;
ad83bfa6
BP
3374 const struct ovsdb_idl_row *row;
3375 const struct ovsdb_type *type;
3376 struct ovsdb_datum old;
3377 int i;
3378
3379 table = get_table(table_name);
1bc6ff29 3380 die_if_error(get_column(table, column_name, &column));
e99d41f7
BP
3381 row = get_row(ctx, table, record_id, must_exist);
3382 if (!row) {
3383 return;
3384 }
c29a8ba8 3385
bd76d25d 3386 type = &column->type;
8c3c2f30 3387 ovsdb_datum_clone(&old, ovsdb_idl_read(row, column), &column->type);
ad83bfa6
BP
3388 for (i = 4; i < ctx->argc; i++) {
3389 struct ovsdb_type add_type;
3390 struct ovsdb_datum add;
3391
ad83bfa6
BP
3392 add_type = *type;
3393 add_type.n_min = 1;
3394 add_type.n_max = UINT_MAX;
ce5a3e38
BP
3395 die_if_error(ovsdb_datum_from_string(&add, &add_type, ctx->argv[i],
3396 ctx->symtab));
ad83bfa6
BP
3397 ovsdb_datum_union(&old, &add, type, false);
3398 ovsdb_datum_destroy(&add, type);
3399 }
3400 if (old.n > type->n_max) {
def90f62
BP
3401 vsctl_fatal("\"add\" operation would put %u %s in column %s of "
3402 "table %s but the maximum number is %u",
3403 old.n,
bd76d25d
BP
3404 type->value.type == OVSDB_TYPE_VOID ? "values" : "pairs",
3405 column->name, table->class->name, type->n_max);
ad83bfa6 3406 }
f74055e7 3407 ovsdb_idl_txn_verify(row, column);
bd76d25d 3408 ovsdb_idl_txn_write(row, column, &old);
5ce5a6b5
BP
3409
3410 vsctl_context_invalidate_cache(ctx);
ad83bfa6 3411}
90c4bd00 3412
e5e12280
BP
3413static void
3414pre_cmd_remove(struct vsctl_context *ctx)
3415{
3416 const char *table_name = ctx->argv[1];
3417 const char *column_name = ctx->argv[3];
3418 const struct vsctl_table_class *table;
3419 const struct ovsdb_idl_column *column;
3420
3421 table = pre_get_table(ctx, table_name);
3422 pre_get_column(ctx, table, column_name, &column);
341c4e59 3423 check_mutable(table, column);
e5e12280
BP
3424}
3425
90c4bd00
BP
3426static void
3427cmd_remove(struct vsctl_context *ctx)
3428{
e99d41f7 3429 bool must_exist = !shash_find(&ctx->options, "--if-exists");
90c4bd00
BP
3430 const char *table_name = ctx->argv[1];
3431 const char *record_id = ctx->argv[2];
3432 const char *column_name = ctx->argv[3];
3433 const struct vsctl_table_class *table;
bd76d25d 3434 const struct ovsdb_idl_column *column;
90c4bd00
BP
3435 const struct ovsdb_idl_row *row;
3436 const struct ovsdb_type *type;
3437 struct ovsdb_datum old;
3438 int i;
3439
3440 table = get_table(table_name);
90c4bd00 3441 die_if_error(get_column(table, column_name, &column));
e99d41f7
BP
3442 row = get_row(ctx, table, record_id, must_exist);
3443 if (!row) {
3444 return;
3445 }
c29a8ba8 3446
bd76d25d 3447 type = &column->type;
8c3c2f30 3448 ovsdb_datum_clone(&old, ovsdb_idl_read(row, column), &column->type);
90c4bd00
BP
3449 for (i = 4; i < ctx->argc; i++) {
3450 struct ovsdb_type rm_type;
3451 struct ovsdb_datum rm;
3452 char *error;
3453
90c4bd00
BP
3454 rm_type = *type;
3455 rm_type.n_min = 1;
3456 rm_type.n_max = UINT_MAX;
ce5a3e38
BP
3457 error = ovsdb_datum_from_string(&rm, &rm_type,
3458 ctx->argv[i], ctx->symtab);
90c4bd00
BP
3459 if (error && ovsdb_type_is_map(&rm_type)) {
3460 free(error);
bd76d25d 3461 rm_type.value.type = OVSDB_TYPE_VOID;
ce5a3e38
BP
3462 die_if_error(ovsdb_datum_from_string(&rm, &rm_type,
3463 ctx->argv[i], ctx->symtab));
90c4bd00
BP
3464 }
3465 ovsdb_datum_subtract(&old, type, &rm, &rm_type);
3466 ovsdb_datum_destroy(&rm, &rm_type);
3467 }
3468 if (old.n < type->n_min) {
def90f62 3469 vsctl_fatal("\"remove\" operation would put %u %s in column %s of "
f19f25a4 3470 "table %s but the minimum number is %u",
def90f62 3471 old.n,
bd76d25d
BP
3472 type->value.type == OVSDB_TYPE_VOID ? "values" : "pairs",
3473 column->name, table->class->name, type->n_min);
90c4bd00 3474 }
f74055e7 3475 ovsdb_idl_txn_verify(row, column);
bd76d25d 3476 ovsdb_idl_txn_write(row, column, &old);
5ce5a6b5
BP
3477
3478 vsctl_context_invalidate_cache(ctx);
90c4bd00
BP
3479}
3480
e5e12280
BP
3481static void
3482pre_cmd_clear(struct vsctl_context *ctx)
3483{
3484 const char *table_name = ctx->argv[1];
3485 const struct vsctl_table_class *table;
3486 int i;
3487
3488 table = pre_get_table(ctx, table_name);
3489 for (i = 3; i < ctx->argc; i++) {
3490 const struct ovsdb_idl_column *column;
3491
3492 pre_get_column(ctx, table, ctx->argv[i], &column);
341c4e59 3493 check_mutable(table, column);
e5e12280
BP
3494 }
3495}
3496
90c4bd00
BP
3497static void
3498cmd_clear(struct vsctl_context *ctx)
3499{
e99d41f7 3500 bool must_exist = !shash_find(&ctx->options, "--if-exists");
90c4bd00
BP
3501 const char *table_name = ctx->argv[1];
3502 const char *record_id = ctx->argv[2];
3503 const struct vsctl_table_class *table;
3504 const struct ovsdb_idl_row *row;
3505 int i;
3506
3507 table = get_table(table_name);
e99d41f7
BP
3508 row = get_row(ctx, table, record_id, must_exist);
3509 if (!row) {
3510 return;
3511 }
3512
90c4bd00 3513 for (i = 3; i < ctx->argc; i++) {
bd76d25d 3514 const struct ovsdb_idl_column *column;
90c4bd00
BP
3515 const struct ovsdb_type *type;
3516 struct ovsdb_datum datum;
3517
3518 die_if_error(get_column(table, ctx->argv[i], &column));
3519
bd76d25d
BP
3520 type = &column->type;
3521 if (type->n_min > 0) {
def90f62
BP
3522 vsctl_fatal("\"clear\" operation cannot be applied to column %s "
3523 "of table %s, which is not allowed to be empty",
bd76d25d 3524 column->name, table->class->name);
90c4bd00
BP
3525 }
3526
3527 ovsdb_datum_init_empty(&datum);
bd76d25d 3528 ovsdb_idl_txn_write(row, column, &datum);
90c4bd00 3529 }
5ce5a6b5
BP
3530
3531 vsctl_context_invalidate_cache(ctx);
90c4bd00 3532}
557e3718
BP
3533
3534static void
c5f341ab 3535pre_create(struct vsctl_context *ctx)
557e3718 3536{
ce5a3e38 3537 const char *id = shash_find_data(&ctx->options, "--id");
557e3718
BP
3538 const char *table_name = ctx->argv[1];
3539 const struct vsctl_table_class *table;
c5f341ab
BP
3540
3541 table = get_table(table_name);
3542 if (!id && !table->class->is_root) {
3543 VLOG_WARN("applying \"create\" command to table %s without --id "
3544 "option will have no effect", table->class->name);
3545 }
3546}
3547
3548static void
3549cmd_create(struct vsctl_context *ctx)
3550{
3551 const char *id = shash_find_data(&ctx->options, "--id");
3552 const char *table_name = ctx->argv[1];
3553 const struct vsctl_table_class *table = get_table(table_name);
557e3718 3554 const struct ovsdb_idl_row *row;
ce5a3e38 3555 const struct uuid *uuid;
557e3718
BP
3556 int i;
3557
c5f341ab
BP
3558 if (id) {
3559 struct ovsdb_symbol *symbol = create_symbol(ctx->symtab, id, NULL);
3560 if (table->class->is_root) {
3561 /* This table is in the root set, meaning that rows created in it
3562 * won't disappear even if they are unreferenced, so disable
3563 * warnings about that by pretending that there is a reference. */
3564 symbol->strong_ref = true;
3565 }
3566 uuid = &symbol->uuid;
3567 } else {
3568 uuid = NULL;
3569 }
ce5a3e38 3570
ce5a3e38 3571 row = ovsdb_idl_txn_insert(ctx->txn, table->class, uuid);
557e3718 3572 for (i = 2; i < ctx->argc; i++) {
ce5a3e38 3573 set_column(table, row, ctx->argv[i], ctx->symtab);
557e3718 3574 }
f8ff4bc4 3575 ds_put_format(&ctx->output, UUID_FMT, UUID_ARGS(&row->uuid));
557e3718 3576}
b7f74b6f 3577
3ef917b5
BP
3578/* This function may be used as the 'postprocess' function for commands that
3579 * insert new rows into the database. It expects that the command's 'run'
3580 * function prints the UUID reported by ovsdb_idl_txn_insert() as the command's
3581 * sole output. It replaces that output by the row's permanent UUID assigned
3582 * by the database server and appends a new-line.
3583 *
3584 * Currently we use this only for "create", because the higher-level commands
3585 * are supposed to be independent of the actual structure of the vswitch
3586 * configuration. */
3587static void
3588post_create(struct vsctl_context *ctx)
3589{
3590 const struct uuid *real;
3591 struct uuid dummy;
3592
1611cf3f
BP
3593 if (!uuid_from_string(&dummy, ds_cstr(&ctx->output))) {
3594 NOT_REACHED();
3595 }
3ef917b5
BP
3596 real = ovsdb_idl_txn_get_insert_uuid(ctx->txn, &dummy);
3597 if (real) {
3598 ds_clear(&ctx->output);
3599 ds_put_format(&ctx->output, UUID_FMT, UUID_ARGS(real));
3600 }
3601 ds_put_char(&ctx->output, '\n');
3602}
3603
e5e12280
BP
3604static void
3605pre_cmd_destroy(struct vsctl_context *ctx)
3606{
3607 const char *table_name = ctx->argv[1];
3608
3609 pre_get_table(ctx, table_name);
3610}
3611
b7f74b6f
BP
3612static void
3613cmd_destroy(struct vsctl_context *ctx)
3614{
b7f74b6f 3615 bool must_exist = !shash_find(&ctx->options, "--if-exists");
eeb8467e 3616 bool delete_all = shash_find(&ctx->options, "--all");
b7f74b6f
BP
3617 const char *table_name = ctx->argv[1];
3618 const struct vsctl_table_class *table;
3619 int i;
3620
b7f74b6f 3621 table = get_table(table_name);
eeb8467e
AS
3622
3623 if (delete_all && ctx->argc > 2) {
3624 vsctl_fatal("--all and records argument should not be specified together");
3625 }
3626
3627 if (delete_all && !must_exist) {
3628 vsctl_fatal("--all and --if-exists should not be specified together");
3629 }
3630
3631 if (delete_all) {
b7f74b6f 3632 const struct ovsdb_idl_row *row;
eeb8467e 3633 const struct ovsdb_idl_row *next_row;
b7f74b6f 3634
eeb8467e
AS
3635 for (row = ovsdb_idl_first_row(ctx->idl, table->class);
3636 row;) {
3637 next_row = ovsdb_idl_next_row(row);
3638 ovsdb_idl_txn_delete(row);
3639 row = next_row;
b7f74b6f 3640 }
eeb8467e
AS
3641 } else {
3642 for (i = 2; i < ctx->argc; i++) {
3643 const struct ovsdb_idl_row *row;
5ce5a6b5 3644
e99d41f7 3645 row = get_row(ctx, table, ctx->argv[i], must_exist);
eeb8467e
AS
3646 if (row) {
3647 ovsdb_idl_txn_delete(row);
3648 }
3649 }
3650 }
5ce5a6b5 3651 vsctl_context_invalidate_cache(ctx);
b7f74b6f 3652}
7db03f7c 3653
2a9537e2
BP
3654#define RELOPS \
3655 RELOP(RELOP_EQ, "=") \
3656 RELOP(RELOP_NE, "!=") \
3657 RELOP(RELOP_LT, "<") \
3658 RELOP(RELOP_GT, ">") \
3659 RELOP(RELOP_LE, "<=") \
3660 RELOP(RELOP_GE, ">=") \
3661 RELOP(RELOP_SET_EQ, "{=}") \
3662 RELOP(RELOP_SET_NE, "{!=}") \
3663 RELOP(RELOP_SET_LT, "{<}") \
3664 RELOP(RELOP_SET_GT, "{>}") \
3665 RELOP(RELOP_SET_LE, "{<=}") \
3666 RELOP(RELOP_SET_GE, "{>=}")
3667
3668enum relop {
3669#define RELOP(ENUM, STRING) ENUM,
3670 RELOPS
3671#undef RELOP
3672};
3673
3674static bool
3675is_set_operator(enum relop op)
3676{
3677 return (op == RELOP_SET_EQ || op == RELOP_SET_NE ||
3678 op == RELOP_SET_LT || op == RELOP_SET_GT ||
3679 op == RELOP_SET_LE || op == RELOP_SET_GE);
3680}
3681
3682static bool
3683evaluate_relop(const struct ovsdb_datum *a, const struct ovsdb_datum *b,
3684 const struct ovsdb_type *type, enum relop op)
3685{
3686 switch (op) {
3687 case RELOP_EQ:
3688 case RELOP_SET_EQ:
3689 return ovsdb_datum_compare_3way(a, b, type) == 0;
3690 case RELOP_NE:
3691 case RELOP_SET_NE:
3692 return ovsdb_datum_compare_3way(a, b, type) != 0;
3693 case RELOP_LT:
3694 return ovsdb_datum_compare_3way(a, b, type) < 0;
3695 case RELOP_GT:
3696 return ovsdb_datum_compare_3way(a, b, type) > 0;
3697 case RELOP_LE:
3698 return ovsdb_datum_compare_3way(a, b, type) <= 0;
3699 case RELOP_GE:
3700 return ovsdb_datum_compare_3way(a, b, type) >= 0;
3701
3702 case RELOP_SET_LT:
3703 return b->n > a->n && ovsdb_datum_includes_all(a, b, type);
3704 case RELOP_SET_GT:
3705 return a->n > b->n && ovsdb_datum_includes_all(b, a, type);
3706 case RELOP_SET_LE:
3707 return ovsdb_datum_includes_all(a, b, type);
3708 case RELOP_SET_GE:
3709 return ovsdb_datum_includes_all(b, a, type);
3710
3711 default:
3712 NOT_REACHED();
3713 }
3714}
3715
7db03f7c 3716static bool
f158c54a
BP
3717is_condition_satisfied(const struct vsctl_table_class *table,
3718 const struct ovsdb_idl_row *row, const char *arg,
3719 struct ovsdb_symbol_table *symtab)
7db03f7c
BP
3720{
3721 static const char *operators[] = {
2a9537e2
BP
3722#define RELOP(ENUM, STRING) STRING,
3723 RELOPS
3724#undef RELOP
7db03f7c
BP
3725 };
3726
3727 const struct ovsdb_idl_column *column;
8c3c2f30 3728 const struct ovsdb_datum *have_datum;
7db03f7c 3729 char *key_string, *value_string;
2a9537e2
BP
3730 struct ovsdb_type type;
3731 int operator;
3732 bool retval;
7db03f7c 3733 char *error;
7db03f7c
BP
3734
3735 error = parse_column_key_value(arg, table, &column, &key_string,
3736 &operator, operators, ARRAY_SIZE(operators),
3737 &value_string);
3738 die_if_error(error);
3739 if (!value_string) {
3740 vsctl_fatal("%s: missing value", arg);
3741 }
3742
2a9537e2
BP
3743 type = column->type;
3744 type.n_max = UINT_MAX;
3745
8c3c2f30 3746 have_datum = ovsdb_idl_read(row, column);
7db03f7c 3747 if (key_string) {
2a9537e2
BP
3748 union ovsdb_atom want_key;
3749 struct ovsdb_datum b;
3750 unsigned int idx;
7db03f7c
BP
3751
3752 if (column->type.value.type == OVSDB_TYPE_VOID) {
3753 vsctl_fatal("cannot specify key to check for non-map column %s",
3754 column->name);
3755 }
3756
3757 die_if_error(ovsdb_atom_from_string(&want_key, &column->type.key,
3758 key_string, symtab));
2a9537e2
BP
3759
3760 type.key = type.value;
3761 type.value.type = OVSDB_TYPE_VOID;
3762 die_if_error(ovsdb_datum_from_string(&b, &type, value_string, symtab));
7db03f7c 3763
8c3c2f30 3764 idx = ovsdb_datum_find_key(have_datum,
7db03f7c 3765 &want_key, column->type.key.type);
2a9537e2
BP
3766 if (idx == UINT_MAX && !is_set_operator(operator)) {
3767 retval = false;
3768 } else {
3769 struct ovsdb_datum a;
3770
3771 if (idx != UINT_MAX) {
3772 a.n = 1;
3773 a.keys = &have_datum->values[idx];
3774 a.values = NULL;
3775 } else {
3776 a.n = 0;
3777 a.keys = NULL;
3778 a.values = NULL;
3779 }
3780
3781 retval = evaluate_relop(&a, &b, &type, operator);
7db03f7c
BP
3782 }
3783
3784 ovsdb_atom_destroy(&want_key, column->type.key.type);
e49190c4 3785 ovsdb_datum_destroy(&b, &type);
7db03f7c
BP
3786 } else {
3787 struct ovsdb_datum want_datum;
3788
3789 die_if_error(ovsdb_datum_from_string(&want_datum, &column->type,
3790 value_string, symtab));
2a9537e2 3791 retval = evaluate_relop(have_datum, &want_datum, &type, operator);
7db03f7c
BP
3792 ovsdb_datum_destroy(&want_datum, &column->type);
3793 }
7db03f7c
BP
3794
3795 free(key_string);
3796 free(value_string);
3797
2a9537e2 3798 return retval;
7db03f7c
BP
3799}
3800
e5e12280
BP
3801static void
3802pre_cmd_wait_until(struct vsctl_context *ctx)
3803{
3804 const char *table_name = ctx->argv[1];
3805 const struct vsctl_table_class *table;
3806 int i;
3807
3808 table = pre_get_table(ctx, table_name);
3809
3810 for (i = 3; i < ctx->argc; i++) {
3811 pre_parse_column_key_value(ctx, ctx->argv[i], table);
3812 }
3813}
3814
7db03f7c
BP
3815static void
3816cmd_wait_until(struct vsctl_context *ctx)
3817{
3818 const char *table_name = ctx->argv[1];
3819 const char *record_id = ctx->argv[2];
3820 const struct vsctl_table_class *table;
3821 const struct ovsdb_idl_row *row;
3822 int i;
3823
3824 table = get_table(table_name);
3825
e99d41f7 3826 row = get_row(ctx, table, record_id, false);
7db03f7c
BP
3827 if (!row) {
3828 ctx->try_again = true;
3829 return;
3830 }
3831
3832 for (i = 3; i < ctx->argc; i++) {
f158c54a 3833 if (!is_condition_satisfied(table, row, ctx->argv[i], ctx->symtab)) {
7db03f7c
BP
3834 ctx->try_again = true;
3835 return;
3836 }
3837 }
3838}
ad83bfa6 3839\f
5ce5a6b5
BP
3840/* Prepares 'ctx', which has already been initialized with
3841 * vsctl_context_init(), for processing 'command'. */
c75d1511 3842static void
5ce5a6b5
BP
3843vsctl_context_init_command(struct vsctl_context *ctx,
3844 struct vsctl_command *command)
f8ff4bc4
BP
3845{
3846 ctx->argc = command->argc;
3847 ctx->argv = command->argv;
3848 ctx->options = command->options;
3849
3850 ds_swap(&ctx->output, &command->output);
e051b42c 3851 ctx->table = command->table;
5ce5a6b5
BP
3852
3853 ctx->verified_ports = false;
3854
3855 ctx->try_again = false;
3856}
3857
3858/* Prepares 'ctx' for processing commands, initializing its members with the
3859 * values passed in as arguments.
3860 *
3861 * If 'command' is nonnull, calls vsctl_context_init_command() to prepare for
3862 * that particular command. */
3863static void
3864vsctl_context_init(struct vsctl_context *ctx, struct vsctl_command *command,
3865 struct ovsdb_idl *idl, struct ovsdb_idl_txn *txn,
3866 const struct ovsrec_open_vswitch *ovs,
3867 struct ovsdb_symbol_table *symtab)
3868{
3869 if (command) {
3870 vsctl_context_init_command(ctx, command);
3871 }
f8ff4bc4
BP
3872 ctx->idl = idl;
3873 ctx->txn = txn;
3874 ctx->ovs = ovs;
ce5a3e38 3875 ctx->symtab = symtab;
5ce5a6b5 3876 ctx->cache_valid = false;
f8ff4bc4
BP
3877}
3878
5ce5a6b5 3879/* Completes processing of 'command' within 'ctx'. */
f8ff4bc4 3880static void
5ce5a6b5
BP
3881vsctl_context_done_command(struct vsctl_context *ctx,
3882 struct vsctl_command *command)
f8ff4bc4
BP
3883{
3884 ds_swap(&ctx->output, &command->output);
e051b42c 3885 command->table = ctx->table;
f8ff4bc4
BP
3886}
3887
5ce5a6b5
BP
3888/* Finishes up with 'ctx'.
3889 *
3890 * If command is nonnull, first calls vsctl_context_done_command() to complete
3891 * processing that command within 'ctx'. */
3892static void
3893vsctl_context_done(struct vsctl_context *ctx, struct vsctl_command *command)
3894{
3895 if (command) {
3896 vsctl_context_done_command(ctx, command);
3897 }
3898 vsctl_context_invalidate_cache(ctx);
3899}
3900
e5e12280
BP
3901static void
3902run_prerequisites(struct vsctl_command *commands, size_t n_commands,
3903 struct ovsdb_idl *idl)
3904{
3905 struct vsctl_command *c;
3906
3907 ovsdb_idl_add_table(idl, &ovsrec_table_open_vswitch);
b8fa7102
BP
3908 if (wait_for_reload) {
3909 ovsdb_idl_add_column(idl, &ovsrec_open_vswitch_col_cur_cfg);
3910 }
e5e12280
BP
3911 for (c = commands; c < &commands[n_commands]; c++) {
3912 if (c->syntax->prerequisites) {
3913 struct vsctl_context ctx;
3914
3915 ds_init(&c->output);
e051b42c 3916 c->table = NULL;
e5e12280
BP
3917
3918 vsctl_context_init(&ctx, c, idl, NULL, NULL, NULL);
3919 (c->syntax->prerequisites)(&ctx);
3920 vsctl_context_done(&ctx, c);
3921
cb22974d
BP
3922 ovs_assert(!c->output.string);
3923 ovs_assert(!c->table);
e5e12280
BP
3924 }
3925 }
3926}
3927
854a94d9 3928static void
f8ff4bc4
BP
3929do_vsctl(const char *args, struct vsctl_command *commands, size_t n_commands,
3930 struct ovsdb_idl *idl)
c75d1511
BP
3931{
3932 struct ovsdb_idl_txn *txn;
3933 const struct ovsrec_open_vswitch *ovs;
3934 enum ovsdb_idl_txn_status status;
ce5a3e38 3935 struct ovsdb_symbol_table *symtab;
5ce5a6b5 3936 struct vsctl_context ctx;
f8ff4bc4 3937 struct vsctl_command *c;
0dc66db9 3938 struct shash_node *node;
84a0ee89 3939 int64_t next_cfg = 0;
af9af3e2 3940 char *error = NULL;
c75d1511 3941
1d48b4be 3942 txn = the_idl_txn = ovsdb_idl_txn_create(idl);
577aebdf
BP
3943 if (dry_run) {
3944 ovsdb_idl_txn_set_dry_run(txn);
3945 }
524555d1 3946
e1c0e2d1 3947 ovsdb_idl_txn_add_comment(txn, "ovs-vsctl: %s", args);
d171b584 3948
c75d1511
BP
3949 ovs = ovsrec_open_vswitch_first(idl);
3950 if (!ovs) {
524555d1
BP
3951 /* XXX add verification that table is empty */
3952 ovs = ovsrec_open_vswitch_insert(txn);
c75d1511
BP
3953 }
3954
b54e22e9 3955 if (wait_for_reload) {
94fbe1aa
BP
3956 ovsdb_idl_txn_increment(txn, &ovs->header_,
3957 &ovsrec_open_vswitch_col_next_cfg);
b54e22e9
BP
3958 }
3959
ce5a3e38 3960 symtab = ovsdb_symbol_table_create();
87b23a01
BP
3961 for (c = commands; c < &commands[n_commands]; c++) {
3962 ds_init(&c->output);
e051b42c 3963 c->table = NULL;
87b23a01 3964 }
5ce5a6b5 3965 vsctl_context_init(&ctx, NULL, idl, txn, ovs, symtab);
f8ff4bc4 3966 for (c = commands; c < &commands[n_commands]; c++) {
5ce5a6b5 3967 vsctl_context_init_command(&ctx, c);
ffd66ea9
BP
3968 if (c->syntax->run) {
3969 (c->syntax->run)(&ctx);
3970 }
5ce5a6b5 3971 vsctl_context_done_command(&ctx, c);
87b23a01
BP
3972
3973 if (ctx.try_again) {
5ce5a6b5 3974 vsctl_context_done(&ctx, NULL);
87b23a01
BP
3975 goto try_again;
3976 }
c75d1511 3977 }
5ce5a6b5 3978 vsctl_context_done(&ctx, NULL);
c75d1511 3979
0dc66db9
BP
3980 SHASH_FOR_EACH (node, &symtab->sh) {
3981 struct ovsdb_symbol *symbol = node->data;
3982 if (!symbol->created) {
3983 vsctl_fatal("row id \"%s\" is referenced but never created (e.g. "
3984 "with \"-- --id=%s create ...\")",
3985 node->name, node->name);
3986 }
c5f341ab
BP
3987 if (!symbol->strong_ref) {
3988 if (!symbol->weak_ref) {
3989 VLOG_WARN("row id \"%s\" was created but no reference to it "
3990 "was inserted, so it will not actually appear in "
3991 "the database", node->name);
3992 } else {
3993 VLOG_WARN("row id \"%s\" was created but only a weak "
3994 "reference to it was inserted, so it will not "
3995 "actually appear in the database", node->name);
3996 }
3997 }
28a3b753
BP
3998 }
3999
af96ccd2 4000 status = ovsdb_idl_txn_commit_block(txn);
b54e22e9
BP
4001 if (wait_for_reload && status == TXN_SUCCESS) {
4002 next_cfg = ovsdb_idl_txn_get_increment_new_value(txn);
4003 }
8d49c47a
BP
4004 if (status == TXN_UNCHANGED || status == TXN_SUCCESS) {
4005 for (c = commands; c < &commands[n_commands]; c++) {
4006 if (c->syntax->postprocess) {
4007 struct vsctl_context ctx;
4008
ce5a3e38 4009 vsctl_context_init(&ctx, c, idl, txn, ovs, symtab);
8d49c47a
BP
4010 (c->syntax->postprocess)(&ctx);
4011 vsctl_context_done(&ctx, c);
4012 }
3da1c516
BP
4013 }
4014 }
91e310a5 4015 error = xstrdup(ovsdb_idl_txn_get_error(txn));
c75d1511 4016 ovsdb_idl_txn_destroy(txn);
b7b6e2c4 4017 txn = the_idl_txn = NULL;
c75d1511
BP
4018
4019 switch (status) {
2096903b 4020 case TXN_UNCOMMITTED:
c75d1511
BP
4021 case TXN_INCOMPLETE:
4022 NOT_REACHED();
4023
4024 case TXN_ABORTED:
4025 /* Should not happen--we never call ovsdb_idl_txn_abort(). */
c88b6a27 4026 vsctl_fatal("transaction aborted");
c75d1511 4027
b54e22e9 4028 case TXN_UNCHANGED:
c75d1511
BP
4029 case TXN_SUCCESS:
4030 break;
4031
854a94d9 4032 case TXN_TRY_AGAIN:
87b23a01 4033 goto try_again;
c75d1511
BP
4034
4035 case TXN_ERROR:
91e310a5 4036 vsctl_fatal("transaction error: %s", error);
c75d1511 4037
06b6d651
BP
4038 case TXN_NOT_LOCKED:
4039 /* Should not happen--we never call ovsdb_idl_set_lock(). */
4040 vsctl_fatal("database not locked");
4041
c75d1511
BP
4042 default:
4043 NOT_REACHED();
4044 }
91e310a5 4045 free(error);
c75d1511 4046
87b23a01
BP
4047 ovsdb_symbol_table_destroy(symtab);
4048
f8ff4bc4
BP
4049 for (c = commands; c < &commands[n_commands]; c++) {
4050 struct ds *ds = &c->output;
ce5a3e38 4051
e051b42c
BP
4052 if (c->table) {
4053 table_print(c->table, &table_style);
4054 } else if (oneline) {
c75d1511
BP
4055 size_t j;
4056
4057 ds_chomp(ds, '\n');
4058 for (j = 0; j < ds->length; j++) {
2a022368
BP
4059 int ch = ds->string[j];
4060 switch (ch) {
c75d1511
BP
4061 case '\n':
4062 fputs("\\n", stdout);
4063 break;
4064
4065 case '\\':
4066 fputs("\\\\", stdout);
4067 break;
4068
4069 default:
2a022368 4070 putchar(ch);
c75d1511
BP
4071 }
4072 }
4073 putchar('\n');
4074 } else {
4075 fputs(ds_cstr(ds), stdout);
4076 }
b86b43aa 4077 ds_destroy(&c->output);
e051b42c
BP
4078 table_destroy(c->table);
4079 free(c->table);
ce5a3e38 4080
79f1cbe9 4081 shash_destroy_free_data(&c->options);
c75d1511 4082 }
b86b43aa 4083 free(commands);
b54e22e9
BP
4084
4085 if (wait_for_reload && status != TXN_UNCHANGED) {
4086 for (;;) {
b54e22e9
BP
4087 ovsdb_idl_run(idl);
4088 OVSREC_OPEN_VSWITCH_FOR_EACH (ovs, idl) {
4089 if (ovs->cur_cfg >= next_cfg) {
4090 goto done;
4091 }
4092 }
4093 ovsdb_idl_wait(idl);
4094 poll_block();
4095 }
4096 done: ;
4097 }
b86b43aa 4098 ovsdb_idl_destroy(idl);
b54e22e9 4099
c75d1511 4100 exit(EXIT_SUCCESS);
87b23a01
BP
4101
4102try_again:
4103 /* Our transaction needs to be rerun, or a prerequisite was not met. Free
4104 * resources and return so that the caller can try again. */
b7b6e2c4
JP
4105 if (txn) {
4106 ovsdb_idl_txn_abort(txn);
4107 ovsdb_idl_txn_destroy(txn);
4108 }
87b23a01
BP
4109 ovsdb_symbol_table_destroy(symtab);
4110 for (c = commands; c < &commands[n_commands]; c++) {
4111 ds_destroy(&c->output);
e051b42c
BP
4112 table_destroy(c->table);
4113 free(c->table);
87b23a01
BP
4114 }
4115 free(error);
c75d1511
BP
4116}
4117
f8ff4bc4
BP
4118static const struct vsctl_command_syntax all_commands[] = {
4119 /* Open vSwitch commands. */
e5e12280 4120 {"init", 0, 0, NULL, cmd_init, NULL, "", RW},
9b1735a7 4121 {"show", 0, 0, pre_cmd_show, cmd_show, NULL, "", RO},
f8ff4bc4
BP
4122
4123 /* Bridge commands. */
e5e12280
BP
4124 {"add-br", 1, 3, pre_get_info, cmd_add_br, NULL, "--may-exist", RW},
4125 {"del-br", 1, 1, pre_get_info, cmd_del_br, NULL, "--if-exists", RW},
515d830a 4126 {"list-br", 0, 0, pre_get_info, cmd_list_br, NULL, "--real,--fake", RO},
e5e12280
BP
4127 {"br-exists", 1, 1, pre_get_info, cmd_br_exists, NULL, "", RO},
4128 {"br-to-vlan", 1, 1, pre_get_info, cmd_br_to_vlan, NULL, "", RO},
4129 {"br-to-parent", 1, 1, pre_get_info, cmd_br_to_parent, NULL, "", RO},
fbd8715e
BP
4130 {"br-set-external-id", 2, 3, pre_cmd_br_set_external_id,
4131 cmd_br_set_external_id, NULL, "", RW},
e5e12280
BP
4132 {"br-get-external-id", 1, 2, pre_cmd_br_get_external_id,
4133 cmd_br_get_external_id, NULL, "", RO},
f8ff4bc4
BP
4134
4135 /* Port commands. */
e5e12280
BP
4136 {"list-ports", 1, 1, pre_get_info, cmd_list_ports, NULL, "", RO},
4137 {"add-port", 2, INT_MAX, pre_get_info, cmd_add_port, NULL, "--may-exist",
4138 RW},
4139 {"add-bond", 4, INT_MAX, pre_get_info, cmd_add_bond, NULL,
4140 "--may-exist,--fake-iface", RW},
4141 {"del-port", 1, 2, pre_get_info, cmd_del_port, NULL,
4142 "--if-exists,--with-iface", RW},
4143 {"port-to-br", 1, 1, pre_get_info, cmd_port_to_br, NULL, "", RO},
f8ff4bc4
BP
4144
4145 /* Interface commands. */
e5e12280
BP
4146 {"list-ifaces", 1, 1, pre_get_info, cmd_list_ifaces, NULL, "", RO},
4147 {"iface-to-br", 1, 1, pre_get_info, cmd_iface_to_br, NULL, "", RO},
f8ff4bc4
BP
4148
4149 /* Controller commands. */
4e3e7ff9
BP
4150 {"get-controller", 1, 1, pre_controller, cmd_get_controller, NULL, "", RO},
4151 {"del-controller", 1, 1, pre_controller, cmd_del_controller, NULL, "", RW},
4152 {"set-controller", 1, INT_MAX, pre_controller, cmd_set_controller, NULL,
4153 "", RW},
e5e12280
BP
4154 {"get-fail-mode", 1, 1, pre_get_info, cmd_get_fail_mode, NULL, "", RO},
4155 {"del-fail-mode", 1, 1, pre_get_info, cmd_del_fail_mode, NULL, "", RW},
4156 {"set-fail-mode", 2, 2, pre_get_info, cmd_set_fail_mode, NULL, "", RW},
f8ff4bc4 4157
24b8b259
AE
4158 /* Manager commands. */
4159 {"get-manager", 0, 0, pre_manager, cmd_get_manager, NULL, "", RO},
0d2f19a9 4160 {"del-manager", 0, 0, pre_manager, cmd_del_manager, NULL, "", RW},
24b8b259
AE
4161 {"set-manager", 1, INT_MAX, pre_manager, cmd_set_manager, NULL, "", RW},
4162
f8ff4bc4 4163 /* SSL commands. */
e5e12280
BP
4164 {"get-ssl", 0, 0, pre_cmd_get_ssl, cmd_get_ssl, NULL, "", RO},
4165 {"del-ssl", 0, 0, pre_cmd_del_ssl, cmd_del_ssl, NULL, "", RW},
4166 {"set-ssl", 3, 3, pre_cmd_set_ssl, cmd_set_ssl, NULL, "--bootstrap", RW},
f8ff4bc4 4167
18ee958b 4168 /* Switch commands. */
e5e12280 4169 {"emer-reset", 0, 0, pre_cmd_emer_reset, cmd_emer_reset, NULL, "", RW},
18ee958b 4170
ffd66ea9
BP
4171 /* Database commands. */
4172 {"comment", 0, INT_MAX, NULL, NULL, NULL, "", RO},
e5e12280 4173 {"get", 2, INT_MAX, pre_cmd_get, cmd_get, NULL, "--if-exists,--id=", RO},
e99d41f7
BP
4174 {"list", 1, INT_MAX, pre_cmd_list, cmd_list, NULL,
4175 "--if-exists,--columns=", RO},
0a140468 4176 {"find", 1, INT_MAX, pre_cmd_find, cmd_find, NULL, "--columns=", RO},
e99d41f7
BP
4177 {"set", 3, INT_MAX, pre_cmd_set, cmd_set, NULL, "--if-exists", RW},
4178 {"add", 4, INT_MAX, pre_cmd_add, cmd_add, NULL, "--if-exists", RW},
4179 {"remove", 4, INT_MAX, pre_cmd_remove, cmd_remove, NULL, "--if-exists",
4180 RW},
4181 {"clear", 3, INT_MAX, pre_cmd_clear, cmd_clear, NULL, "--if-exists", RW},
c5f341ab 4182 {"create", 2, INT_MAX, pre_create, cmd_create, post_create, "--id=", RW},
eeb8467e
AS
4183 {"destroy", 1, INT_MAX, pre_cmd_destroy, cmd_destroy, NULL,
4184 "--if-exists,--all", RW},
e5e12280
BP
4185 {"wait-until", 2, INT_MAX, pre_cmd_wait_until, cmd_wait_until, NULL, "",
4186 RO},
4187
4188 {NULL, 0, 0, NULL, NULL, NULL, NULL, RO},
f8ff4bc4 4189};
5d9cb63c 4190