2 * Licensed under the Apache License, Version 2.0 (the "License");
3 * you may not use this file except in compliance with the License.
4 * You may obtain a copy of the License at:
6 * http://www.apache.org/licenses/LICENSE-2.0
8 * Unless required by applicable law or agreed to in writing, software
9 * distributed under the License is distributed on an "AS IS" BASIS,
10 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11 * See the License for the specific language governing permissions and
12 * limitations under the License.
22 #include "command-line.h"
23 #include "db-ctl-base.h"
25 #include "fatal-signal.h"
27 #include "ovn/lib/ovn-nb-idl.h"
28 #include "poll-loop.h"
32 #include "stream-ssl.h"
37 #include "openvswitch/vlog.h"
39 VLOG_DEFINE_THIS_MODULE(nbctl);
41 /* --db: The database server to contact. */
42 static const char *db;
44 /* --oneline: Write each command's output as a single line? */
47 /* --dry-run: Do not commit any changes. */
50 /* --timeout: Time to wait for a connection to 'db'. */
53 /* Format for table output. */
54 static struct table_style table_style = TABLE_STYLE_DEFAULT;
56 /* The IDL we're using and the current transaction, if any.
57 * This is for use by nbctl_exit() only, to allow it to clean up.
58 * Other code should use its context arguments. */
59 static struct ovsdb_idl *the_idl;
60 static struct ovsdb_idl_txn *the_idl_txn;
61 OVS_NO_RETURN static void nbctl_exit(int status);
63 static void nbctl_cmd_init(void);
64 OVS_NO_RETURN static void usage(void);
65 static void parse_options(int argc, char *argv[], struct shash *local_options);
66 static const char *nbctl_default_db(void);
67 static void run_prerequisites(struct ctl_command[], size_t n_commands,
69 static void do_nbctl(const char *args, struct ctl_command *, size_t n,
73 main(int argc, char *argv[])
75 extern struct vlog_module VLM_reconnect;
76 struct ovsdb_idl *idl;
77 struct ctl_command *commands;
78 struct shash local_options;
83 set_program_name(argv[0]);
84 fatal_ignore_sigpipe();
85 vlog_set_levels(NULL, VLF_CONSOLE, VLL_WARN);
86 vlog_set_levels(&VLM_reconnect, VLF_ANY_DESTINATION, VLL_WARN);
91 /* Log our arguments. This is often valuable for debugging systems. */
92 args = process_escape_args(argv);
93 VLOG(ctl_might_write_to_db(argv) ? VLL_INFO : VLL_DBG,
94 "Called as %s", args);
96 /* Parse command line. */
97 shash_init(&local_options);
98 parse_options(argc, argv, &local_options);
99 commands = ctl_parse_commands(argc - optind, argv + optind, &local_options,
106 /* Initialize IDL. */
107 idl = the_idl = ovsdb_idl_create(db, &nbrec_idl_class, true, false);
108 run_prerequisites(commands, n_commands, idl);
110 /* Execute the commands.
112 * 'seqno' is the database sequence number for which we last tried to
113 * execute our transaction. There's no point in trying to commit more than
114 * once for any given sequence number, because if the transaction fails
115 * it's because the database changed and we need to obtain an up-to-date
116 * view of the database before we try the transaction again. */
117 seqno = ovsdb_idl_get_seqno(idl);
120 if (!ovsdb_idl_is_alive(idl)) {
121 int retval = ovsdb_idl_get_last_error(idl);
122 ctl_fatal("%s: database connection failed (%s)",
123 db, ovs_retval_to_string(retval));
126 if (seqno != ovsdb_idl_get_seqno(idl)) {
127 seqno = ovsdb_idl_get_seqno(idl);
128 do_nbctl(args, commands, n_commands, idl);
131 if (seqno == ovsdb_idl_get_seqno(idl)) {
139 nbctl_default_db(void)
143 def = getenv("OVN_NB_DB");
145 def = ctl_default_db();
152 parse_options(int argc, char *argv[], struct shash *local_options)
155 OPT_DB = UCHAR_MAX + 1,
165 static const struct option global_long_options[] = {
166 {"db", required_argument, NULL, OPT_DB},
167 {"no-syslog", no_argument, NULL, OPT_NO_SYSLOG},
168 {"dry-run", no_argument, NULL, OPT_DRY_RUN},
169 {"oneline", no_argument, NULL, OPT_ONELINE},
170 {"timeout", required_argument, NULL, 't'},
171 {"help", no_argument, NULL, 'h'},
172 {"commands", no_argument, NULL, OPT_COMMANDS},
173 {"options", no_argument, NULL, OPT_OPTIONS},
174 {"version", no_argument, NULL, 'V'},
176 STREAM_SSL_LONG_OPTIONS,
180 const int n_global_long_options = ARRAY_SIZE(global_long_options) - 1;
181 char *tmp, *short_options;
183 struct option *options;
184 size_t allocated_options;
188 tmp = ovs_cmdl_long_options_to_short_options(global_long_options);
189 short_options = xasprintf("+%s", tmp);
192 /* We want to parse both global and command-specific options here, but
193 * getopt_long() isn't too convenient for the job. We copy our global
194 * options into a dynamic array, then append all of the command-specific
196 options = xmemdup(global_long_options, sizeof global_long_options);
197 allocated_options = ARRAY_SIZE(global_long_options);
198 n_options = n_global_long_options;
199 ctl_add_cmd_options(&options, &n_options, &allocated_options, OPT_LOCAL);
200 table_style.format = TF_LIST;
206 c = getopt_long(argc, argv, short_options, options, &idx);
221 vlog_set_levels(&VLM_nbctl, VLF_SYSLOG, VLL_WARN);
229 if (shash_find(local_options, options[idx].name)) {
230 ctl_fatal("'%s' option specified multiple times",
233 shash_add_nocopy(local_options,
234 xasprintf("--%s", options[idx].name),
235 optarg ? xstrdup(optarg) : NULL);
243 ctl_print_commands();
246 ctl_print_options(global_long_options);
249 ovs_print_version(0, 0);
250 printf("DB Schema %s\n", nbrec_get_db_version());
254 timeout = strtoul(optarg, NULL, 10);
256 ctl_fatal("value %s on -t or --timeout is invalid", optarg);
261 TABLE_OPTION_HANDLERS(&table_style)
262 STREAM_SSL_OPTION_HANDLERS
274 db = nbctl_default_db();
277 for (i = n_global_long_options; options[i].name; i++) {
278 free(CONST_CAST(char *, options[i].name));
287 %s: OVN northbound DB management utility\n\
288 usage: %s [OPTIONS] COMMAND [ARG...]\n\
291 show print overview of database contents\n\
292 show LSWITCH print overview of database contents for LSWITCH\n\
294 Logical switch commands:\n\
295 lswitch-add [LSWITCH] create a logical switch named LSWITCH\n\
296 lswitch-del LSWITCH delete LSWITCH and all its ports\n\
297 lswitch-list print the names of all logical switches\n\
300 acl-add LSWITCH DIRECTION PRIORITY MATCH ACTION [log]\n\
301 add an ACL to LSWITCH\n\
302 acl-del LSWITCH [DIRECTION [PRIORITY MATCH]]\n\
303 remove ACLs from LSWITCH\n\
304 acl-list LSWITCH print ACLs for LSWITCH\n\
306 Logical port commands:\n\
307 lport-add LSWITCH LPORT add logical port LPORT on LSWITCH\n\
308 lport-add LSWITCH LPORT PARENT TAG\n\
309 add logical port LPORT on LSWITCH with PARENT\n\
311 lport-del LPORT delete LPORT from its attached switch\n\
312 lport-list LSWITCH print the names of all logical ports on LSWITCH\n\
313 lport-get-parent LPORT get the parent of LPORT if set\n\
314 lport-get-tag LPORT get the LPORT's tag if set\n\
315 lport-set-addresses LPORT [ADDRESS]...\n\
316 set MAC or MAC+IP addresses for LPORT.\n\
317 lport-get-addresses LPORT get a list of MAC addresses on LPORT\n\
318 lport-set-port-security LPORT [ADDRS]...\n\
319 set port security addresses for LPORT.\n\
320 lport-get-port-security LPORT get LPORT's port security addresses\n\
321 lport-get-up LPORT get state of LPORT ('up' or 'down')\n\
322 lport-set-enabled LPORT STATE\n\
323 set administrative state LPORT\n\
324 ('enabled' or 'disabled')\n\
325 lport-get-enabled LPORT get administrative state LPORT\n\
326 ('enabled' or 'disabled')\n\
327 lport-set-type LPORT TYPE Set the type for LPORT\n\
328 lport-get-type LPORT Get the type for LPORT\n\
329 lport-set-options LPORT KEY=VALUE [KEY=VALUE]...\n\
330 Set options related to the type of LPORT\n\
331 lport-get-options LPORT Get the type specific options for LPORT\n\
334 --db=DATABASE connect to DATABASE\n\
336 -t, --timeout=SECS wait at most SECS seconds\n\
337 --dry-run do not commit changes to database\n\
338 --oneline print exactly one line of output per command\n",
339 program_name, program_name, nbctl_default_db());
342 --no-syslog equivalent to --verbose=nbctl:syslog:warn\n");
345 -h, --help display this help message\n\
346 -V, --version display version information\n");
350 static const struct nbrec_logical_switch *
351 lswitch_by_name_or_uuid(struct ctl_context *ctx, const char *id)
353 const struct nbrec_logical_switch *lswitch = NULL;
354 bool is_uuid = false;
355 bool duplicate = false;
356 struct uuid lswitch_uuid;
358 if (uuid_from_string(&lswitch_uuid, id)) {
360 lswitch = nbrec_logical_switch_get_for_uuid(ctx->idl,
365 const struct nbrec_logical_switch *iter;
367 NBREC_LOGICAL_SWITCH_FOR_EACH(iter, ctx->idl) {
368 if (strcmp(iter->name, id)) {
372 VLOG_WARN("There is more than one logical switch named '%s'. "
382 if (!lswitch && !duplicate) {
383 VLOG_WARN("lswitch not found for %s: '%s'",
384 is_uuid ? "UUID" : "name", id);
391 print_lswitch(const struct nbrec_logical_switch *lswitch, struct ds *s)
393 ds_put_format(s, " lswitch "UUID_FMT" (%s)\n",
394 UUID_ARGS(&lswitch->header_.uuid), lswitch->name);
396 for (size_t i = 0; i < lswitch->n_ports; i++) {
397 const struct nbrec_logical_port *lport = lswitch->ports[i];
399 ds_put_format(s, " lport %s\n", lport->name);
400 if (lport->parent_name) {
401 ds_put_format(s, " parent: %s\n", lport->parent_name);
404 ds_put_format(s, " tag: %"PRIu64"\n", lport->tag[0]);
406 if (lport->n_addresses) {
407 ds_put_cstr(s, " addresses:");
408 for (size_t j = 0; j < lport->n_addresses; j++) {
409 ds_put_format(s, " %s", lport->addresses[j]);
411 ds_put_char(s, '\n');
417 nbctl_show(struct ctl_context *ctx)
419 const struct nbrec_logical_switch *lswitch;
421 if (ctx->argc == 2) {
422 lswitch = lswitch_by_name_or_uuid(ctx, ctx->argv[1]);
424 print_lswitch(lswitch, &ctx->output);
427 NBREC_LOGICAL_SWITCH_FOR_EACH(lswitch, ctx->idl) {
428 print_lswitch(lswitch, &ctx->output);
434 nbctl_lswitch_add(struct ctl_context *ctx)
436 struct nbrec_logical_switch *lswitch;
438 lswitch = nbrec_logical_switch_insert(ctx->txn);
439 if (ctx->argc == 2) {
440 nbrec_logical_switch_set_name(lswitch, ctx->argv[1]);
445 nbctl_lswitch_del(struct ctl_context *ctx)
447 const char *id = ctx->argv[1];
448 const struct nbrec_logical_switch *lswitch;
450 lswitch = lswitch_by_name_or_uuid(ctx, id);
455 nbrec_logical_switch_delete(lswitch);
459 nbctl_lswitch_list(struct ctl_context *ctx)
461 const struct nbrec_logical_switch *lswitch;
462 struct smap lswitches;
464 smap_init(&lswitches);
465 NBREC_LOGICAL_SWITCH_FOR_EACH(lswitch, ctx->idl) {
466 smap_add_format(&lswitches, lswitch->name, UUID_FMT " (%s)",
467 UUID_ARGS(&lswitch->header_.uuid), lswitch->name);
469 const struct smap_node **nodes = smap_sort(&lswitches);
470 for (size_t i = 0; i < smap_count(&lswitches); i++) {
471 const struct smap_node *node = nodes[i];
472 ds_put_format(&ctx->output, "%s\n", node->value);
474 smap_destroy(&lswitches);
478 static const struct nbrec_logical_port *
479 lport_by_name_or_uuid(struct ctl_context *ctx, const char *id)
481 const struct nbrec_logical_port *lport = NULL;
482 bool is_uuid = false;
483 struct uuid lport_uuid;
485 if (uuid_from_string(&lport_uuid, id)) {
487 lport = nbrec_logical_port_get_for_uuid(ctx->idl, &lport_uuid);
491 NBREC_LOGICAL_PORT_FOR_EACH(lport, ctx->idl) {
492 if (!strcmp(lport->name, id)) {
499 VLOG_WARN("lport not found for %s: '%s'",
500 is_uuid ? "UUID" : "name", id);
507 nbctl_lport_add(struct ctl_context *ctx)
509 struct nbrec_logical_port *lport;
510 const struct nbrec_logical_switch *lswitch;
513 lswitch = lswitch_by_name_or_uuid(ctx, ctx->argv[1]);
518 if (ctx->argc != 3 && ctx->argc != 5) {
519 /* If a parent_name is specified, a tag must be specified as well. */
520 VLOG_WARN("Invalid arguments to lport-add.");
524 if (ctx->argc == 5) {
526 if (!ovs_scan(ctx->argv[4], "%"SCNd64, &tag) || tag < 0 || tag > 4095) {
527 VLOG_WARN("Invalid tag '%s'", ctx->argv[4]);
532 /* Create the logical port. */
533 lport = nbrec_logical_port_insert(ctx->txn);
534 nbrec_logical_port_set_name(lport, ctx->argv[2]);
535 if (ctx->argc == 5) {
536 nbrec_logical_port_set_parent_name(lport, ctx->argv[3]);
537 nbrec_logical_port_set_tag(lport, &tag, 1);
540 /* Insert the logical port into the logical switch. */
541 nbrec_logical_switch_verify_ports(lswitch);
542 struct nbrec_logical_port **new_ports = xmalloc(sizeof *new_ports *
543 (lswitch->n_ports + 1));
544 memcpy(new_ports, lswitch->ports, sizeof *new_ports * lswitch->n_ports);
545 new_ports[lswitch->n_ports] = lport;
546 nbrec_logical_switch_set_ports(lswitch, new_ports, lswitch->n_ports + 1);
550 /* Removes lport 'lswitch->ports[idx]'. */
552 remove_lport(const struct nbrec_logical_switch *lswitch, size_t idx)
554 const struct nbrec_logical_port *lport = lswitch->ports[idx];
556 /* First remove 'lport' from the array of ports. This is what will
557 * actually cause the logical port to be deleted when the transaction is
558 * sent to the database server (due to garbage collection). */
559 struct nbrec_logical_port **new_ports
560 = xmemdup(lswitch->ports, sizeof *new_ports * lswitch->n_ports);
561 new_ports[idx] = new_ports[lswitch->n_ports - 1];
562 nbrec_logical_switch_verify_ports(lswitch);
563 nbrec_logical_switch_set_ports(lswitch, new_ports, lswitch->n_ports - 1);
566 /* Delete 'lport' from the IDL. This won't have a real effect on the
567 * database server (the IDL will suppress it in fact) but it means that it
568 * won't show up when we iterate with NBREC_LOGICAL_PORT_FOR_EACH later. */
569 nbrec_logical_port_delete(lport);
573 nbctl_lport_del(struct ctl_context *ctx)
575 const struct nbrec_logical_port *lport;
577 lport = lport_by_name_or_uuid(ctx, ctx->argv[1]);
582 /* Find the switch that contains 'lport', then delete it. */
583 const struct nbrec_logical_switch *lswitch;
584 NBREC_LOGICAL_SWITCH_FOR_EACH (lswitch, ctx->idl) {
585 for (size_t i = 0; i < lswitch->n_ports; i++) {
586 if (lswitch->ports[i] == lport) {
587 remove_lport(lswitch, i);
593 VLOG_WARN("logical port %s is not part of any logical switch",
598 nbctl_lport_list(struct ctl_context *ctx)
600 const char *id = ctx->argv[1];
601 const struct nbrec_logical_switch *lswitch;
605 lswitch = lswitch_by_name_or_uuid(ctx, id);
611 for (i = 0; i < lswitch->n_ports; i++) {
612 const struct nbrec_logical_port *lport = lswitch->ports[i];
613 smap_add_format(&lports, lport->name, UUID_FMT " (%s)",
614 UUID_ARGS(&lport->header_.uuid), lport->name);
616 const struct smap_node **nodes = smap_sort(&lports);
617 for (i = 0; i < smap_count(&lports); i++) {
618 const struct smap_node *node = nodes[i];
619 ds_put_format(&ctx->output, "%s\n", node->value);
621 smap_destroy(&lports);
626 nbctl_lport_get_parent(struct ctl_context *ctx)
628 const struct nbrec_logical_port *lport;
630 lport = lport_by_name_or_uuid(ctx, ctx->argv[1]);
635 if (lport->parent_name) {
636 ds_put_format(&ctx->output, "%s\n", lport->parent_name);
641 nbctl_lport_get_tag(struct ctl_context *ctx)
643 const struct nbrec_logical_port *lport;
645 lport = lport_by_name_or_uuid(ctx, ctx->argv[1]);
650 if (lport->n_tag > 0) {
651 ds_put_format(&ctx->output, "%"PRId64"\n", lport->tag[0]);
656 nbctl_lport_set_addresses(struct ctl_context *ctx)
658 const char *id = ctx->argv[1];
659 const struct nbrec_logical_port *lport;
661 lport = lport_by_name_or_uuid(ctx, id);
666 nbrec_logical_port_set_addresses(lport,
667 (const char **) ctx->argv + 2, ctx->argc - 2);
671 nbctl_lport_get_addresses(struct ctl_context *ctx)
673 const char *id = ctx->argv[1];
674 const struct nbrec_logical_port *lport;
675 struct svec addresses;
679 lport = lport_by_name_or_uuid(ctx, id);
684 svec_init(&addresses);
685 for (i = 0; i < lport->n_addresses; i++) {
686 svec_add(&addresses, lport->addresses[i]);
688 svec_sort(&addresses);
689 SVEC_FOR_EACH(i, mac, &addresses) {
690 ds_put_format(&ctx->output, "%s\n", mac);
692 svec_destroy(&addresses);
696 nbctl_lport_set_port_security(struct ctl_context *ctx)
698 const char *id = ctx->argv[1];
699 const struct nbrec_logical_port *lport;
701 lport = lport_by_name_or_uuid(ctx, id);
706 nbrec_logical_port_set_port_security(lport,
707 (const char **) ctx->argv + 2, ctx->argc - 2);
711 nbctl_lport_get_port_security(struct ctl_context *ctx)
713 const char *id = ctx->argv[1];
714 const struct nbrec_logical_port *lport;
719 lport = lport_by_name_or_uuid(ctx, id);
725 for (i = 0; i < lport->n_port_security; i++) {
726 svec_add(&addrs, lport->port_security[i]);
729 SVEC_FOR_EACH(i, addr, &addrs) {
730 ds_put_format(&ctx->output, "%s\n", addr);
732 svec_destroy(&addrs);
736 nbctl_lport_get_up(struct ctl_context *ctx)
738 const char *id = ctx->argv[1];
739 const struct nbrec_logical_port *lport;
741 lport = lport_by_name_or_uuid(ctx, id);
746 ds_put_format(&ctx->output,
747 "%s\n", (lport->up && *lport->up) ? "up" : "down");
751 nbctl_lport_set_enabled(struct ctl_context *ctx)
753 const char *id = ctx->argv[1];
754 const char *state = ctx->argv[2];
755 const struct nbrec_logical_port *lport;
757 lport = lport_by_name_or_uuid(ctx, id);
762 if (!strcasecmp(state, "enabled")) {
764 nbrec_logical_port_set_enabled(lport, &enabled, 1);
765 } else if (!strcasecmp(state, "disabled")) {
766 bool enabled = false;
767 nbrec_logical_port_set_enabled(lport, &enabled, 1);
769 VLOG_ERR("Invalid state '%s' provided to lport-set-enabled", state);
774 nbctl_lport_get_enabled(struct ctl_context *ctx)
776 const char *id = ctx->argv[1];
777 const struct nbrec_logical_port *lport;
779 lport = lport_by_name_or_uuid(ctx, id);
784 ds_put_format(&ctx->output, "%s\n",
785 !lport->enabled || *lport->enabled ? "enabled" : "disabled");
789 nbctl_lport_set_type(struct ctl_context *ctx)
791 const char *id = ctx->argv[1];
792 const char *type = ctx->argv[2];
793 const struct nbrec_logical_port *lport;
795 lport = lport_by_name_or_uuid(ctx, id);
800 nbrec_logical_port_set_type(lport, type);
804 nbctl_lport_get_type(struct ctl_context *ctx)
806 const char *id = ctx->argv[1];
807 const struct nbrec_logical_port *lport;
809 lport = lport_by_name_or_uuid(ctx, id);
814 ds_put_format(&ctx->output, "%s\n", lport->type);
818 nbctl_lport_set_options(struct ctl_context *ctx)
820 const char *id = ctx->argv[1];
821 const struct nbrec_logical_port *lport;
823 struct smap options = SMAP_INITIALIZER(&options);
825 lport = lport_by_name_or_uuid(ctx, id);
830 for (i = 2; i < ctx->argc; i++) {
832 value = xstrdup(ctx->argv[i]);
833 key = strsep(&value, "=");
835 smap_add(&options, key, value);
840 nbrec_logical_port_set_options(lport, &options);
842 smap_destroy(&options);
846 nbctl_lport_get_options(struct ctl_context *ctx)
848 const char *id = ctx->argv[1];
849 const struct nbrec_logical_port *lport;
850 struct smap_node *node;
852 lport = lport_by_name_or_uuid(ctx, id);
857 SMAP_FOR_EACH(node, &lport->options) {
858 ds_put_format(&ctx->output, "%s=%s\n", node->key, node->value);
868 dir_encode(const char *dir)
870 if (!strcmp(dir, "from-lport")) {
871 return DIR_FROM_LPORT;
872 } else if (!strcmp(dir, "to-lport")) {
880 acl_cmp(const void *acl1_, const void *acl2_)
882 const struct nbrec_acl *const *acl1p = acl1_;
883 const struct nbrec_acl *const *acl2p = acl2_;
884 const struct nbrec_acl *acl1 = *acl1p;
885 const struct nbrec_acl *acl2 = *acl2p;
887 int dir1 = dir_encode(acl1->direction);
888 int dir2 = dir_encode(acl2->direction);
891 return dir1 < dir2 ? -1 : 1;
892 } else if (acl1->priority != acl2->priority) {
893 return acl1->priority > acl2->priority ? -1 : 1;
895 return strcmp(acl1->match, acl2->match);
900 nbctl_acl_list(struct ctl_context *ctx)
902 const struct nbrec_logical_switch *lswitch;
903 const struct nbrec_acl **acls;
906 lswitch = lswitch_by_name_or_uuid(ctx, ctx->argv[1]);
911 acls = xmalloc(sizeof *acls * lswitch->n_acls);
912 for (i = 0; i < lswitch->n_acls; i++) {
913 acls[i] = lswitch->acls[i];
916 qsort(acls, lswitch->n_acls, sizeof *acls, acl_cmp);
918 for (i = 0; i < lswitch->n_acls; i++) {
919 const struct nbrec_acl *acl = acls[i];
920 printf("%10s %5"PRId64" (%s) %s%s\n", acl->direction, acl->priority,
921 acl->match, acl->action, acl->log ? " log" : "");
928 nbctl_acl_add(struct ctl_context *ctx)
930 const struct nbrec_logical_switch *lswitch;
931 const char *action = ctx->argv[5];
932 const char *direction;
935 lswitch = lswitch_by_name_or_uuid(ctx, ctx->argv[1]);
940 /* Validate direction. Only require the first letter. */
941 if (ctx->argv[2][0] == 't') {
942 direction = "to-lport";
943 } else if (ctx->argv[2][0] == 'f') {
944 direction = "from-lport";
946 VLOG_WARN("Invalid direction '%s'", ctx->argv[2]);
950 /* Validate priority. */
951 if (!ovs_scan(ctx->argv[3], "%"SCNd64, &priority) || priority < 0
952 || priority > 32767) {
953 VLOG_WARN("Invalid priority '%s'", ctx->argv[3]);
957 /* Validate action. */
958 if (strcmp(action, "allow") && strcmp(action, "allow-related")
959 && strcmp(action, "drop") && strcmp(action, "reject")) {
960 VLOG_WARN("Invalid action '%s'", action);
964 /* Create the acl. */
965 struct nbrec_acl *acl = nbrec_acl_insert(ctx->txn);
966 nbrec_acl_set_priority(acl, priority);
967 nbrec_acl_set_direction(acl, direction);
968 nbrec_acl_set_match(acl, ctx->argv[4]);
969 nbrec_acl_set_action(acl, action);
970 if (shash_find(&ctx->options, "--log") != NULL) {
971 nbrec_acl_set_log(acl, true);
974 /* Insert the acl into the logical switch. */
975 nbrec_logical_switch_verify_acls(lswitch);
976 struct nbrec_acl **new_acls = xmalloc(sizeof *new_acls *
977 (lswitch->n_acls + 1));
978 memcpy(new_acls, lswitch->acls, sizeof *new_acls * lswitch->n_acls);
979 new_acls[lswitch->n_acls] = acl;
980 nbrec_logical_switch_set_acls(lswitch, new_acls, lswitch->n_acls + 1);
985 nbctl_acl_del(struct ctl_context *ctx)
987 const struct nbrec_logical_switch *lswitch;
988 const char *direction;
989 int64_t priority = 0;
991 lswitch = lswitch_by_name_or_uuid(ctx, ctx->argv[1]);
996 if (ctx->argc != 2 && ctx->argc != 3 && ctx->argc != 5) {
997 VLOG_WARN("Invalid number of arguments");
1001 if (ctx->argc == 2) {
1002 /* If direction, priority, and match are not specified, delete
1004 nbrec_logical_switch_verify_acls(lswitch);
1005 nbrec_logical_switch_set_acls(lswitch, NULL, 0);
1009 /* Validate direction. Only require first letter. */
1010 if (ctx->argv[2][0] == 't') {
1011 direction = "to-lport";
1012 } else if (ctx->argv[2][0] == 'f') {
1013 direction = "from-lport";
1015 VLOG_WARN("Invalid direction '%s'", ctx->argv[2]);
1019 /* If priority and match are not specified, delete all ACLs with the
1020 * specified direction. */
1021 if (ctx->argc == 3) {
1022 struct nbrec_acl **new_acls
1023 = xmalloc(sizeof *new_acls * lswitch->n_acls);
1026 for (size_t i = 0; i < lswitch->n_acls; i++) {
1027 if (strcmp(direction, lswitch->acls[i]->direction)) {
1028 new_acls[n_acls++] = lswitch->acls[i];
1032 nbrec_logical_switch_verify_acls(lswitch);
1033 nbrec_logical_switch_set_acls(lswitch, new_acls, n_acls);
1038 /* Validate priority. */
1039 if (!ovs_scan(ctx->argv[3], "%"SCNd64, &priority) || priority < 0
1040 || priority > 32767) {
1041 VLOG_WARN("Invalid priority '%s'", ctx->argv[3]);
1045 /* Remove the matching rule. */
1046 for (size_t i = 0; i < lswitch->n_acls; i++) {
1047 struct nbrec_acl *acl = lswitch->acls[i];
1049 if (priority == acl->priority && !strcmp(ctx->argv[4], acl->match) &&
1050 !strcmp(direction, acl->direction)) {
1051 struct nbrec_acl **new_acls
1052 = xmemdup(lswitch->acls, sizeof *new_acls * lswitch->n_acls);
1053 new_acls[i] = lswitch->acls[lswitch->n_acls - 1];
1054 nbrec_logical_switch_verify_acls(lswitch);
1055 nbrec_logical_switch_set_acls(lswitch, new_acls,
1056 lswitch->n_acls - 1);
1063 static const struct ctl_table_class tables[] = {
1064 {&nbrec_table_logical_switch,
1065 {{&nbrec_table_logical_switch, &nbrec_logical_switch_col_name, NULL},
1066 {NULL, NULL, NULL}}},
1068 {&nbrec_table_logical_port,
1069 {{&nbrec_table_logical_port, &nbrec_logical_port_col_name, NULL},
1070 {NULL, NULL, NULL}}},
1073 {{NULL, NULL, NULL},
1074 {NULL, NULL, NULL}}},
1076 {&nbrec_table_logical_router,
1077 {{&nbrec_table_logical_router, &nbrec_logical_router_col_name, NULL},
1078 {NULL, NULL, NULL}}},
1080 {&nbrec_table_logical_router_port,
1081 {{&nbrec_table_logical_router_port, &nbrec_logical_router_port_col_name,
1083 {NULL, NULL, NULL}}},
1085 {NULL, {{NULL, NULL, NULL}, {NULL, NULL, NULL}}}
1089 run_prerequisites(struct ctl_command *commands, size_t n_commands,
1090 struct ovsdb_idl *idl)
1092 struct ctl_command *c;
1094 for (c = commands; c < &commands[n_commands]; c++) {
1095 if (c->syntax->prerequisites) {
1096 struct ctl_context ctx;
1098 ds_init(&c->output);
1101 ctl_context_init(&ctx, c, idl, NULL, NULL, NULL);
1102 (c->syntax->prerequisites)(&ctx);
1103 ctl_context_done(&ctx, c);
1105 ovs_assert(!c->output.string);
1106 ovs_assert(!c->table);
1112 do_nbctl(const char *args, struct ctl_command *commands, size_t n_commands,
1113 struct ovsdb_idl *idl)
1115 struct ovsdb_idl_txn *txn;
1116 enum ovsdb_idl_txn_status status;
1117 struct ovsdb_symbol_table *symtab;
1118 struct ctl_context ctx;
1119 struct ctl_command *c;
1120 struct shash_node *node;
1123 txn = the_idl_txn = ovsdb_idl_txn_create(idl);
1125 ovsdb_idl_txn_set_dry_run(txn);
1128 ovsdb_idl_txn_add_comment(txn, "ovs-nbctl: %s", args);
1130 symtab = ovsdb_symbol_table_create();
1131 for (c = commands; c < &commands[n_commands]; c++) {
1132 ds_init(&c->output);
1135 ctl_context_init(&ctx, NULL, idl, txn, symtab, NULL);
1136 for (c = commands; c < &commands[n_commands]; c++) {
1137 ctl_context_init_command(&ctx, c);
1138 if (c->syntax->run) {
1139 (c->syntax->run)(&ctx);
1141 ctl_context_done_command(&ctx, c);
1143 if (ctx.try_again) {
1144 ctl_context_done(&ctx, NULL);
1148 ctl_context_done(&ctx, NULL);
1150 SHASH_FOR_EACH (node, &symtab->sh) {
1151 struct ovsdb_symbol *symbol = node->data;
1152 if (!symbol->created) {
1153 ctl_fatal("row id \"%s\" is referenced but never created (e.g. "
1154 "with \"-- --id=%s create ...\")",
1155 node->name, node->name);
1157 if (!symbol->strong_ref) {
1158 if (!symbol->weak_ref) {
1159 VLOG_WARN("row id \"%s\" was created but no reference to it "
1160 "was inserted, so it will not actually appear in "
1161 "the database", node->name);
1163 VLOG_WARN("row id \"%s\" was created but only a weak "
1164 "reference to it was inserted, so it will not "
1165 "actually appear in the database", node->name);
1170 status = ovsdb_idl_txn_commit_block(txn);
1171 if (status == TXN_UNCHANGED || status == TXN_SUCCESS) {
1172 for (c = commands; c < &commands[n_commands]; c++) {
1173 if (c->syntax->postprocess) {
1174 ctl_context_init(&ctx, c, idl, txn, symtab, NULL);
1175 (c->syntax->postprocess)(&ctx);
1176 ctl_context_done(&ctx, c);
1180 error = xstrdup(ovsdb_idl_txn_get_error(txn));
1183 case TXN_UNCOMMITTED:
1184 case TXN_INCOMPLETE:
1188 /* Should not happen--we never call ovsdb_idl_txn_abort(). */
1189 ctl_fatal("transaction aborted");
1199 ctl_fatal("transaction error: %s", error);
1201 case TXN_NOT_LOCKED:
1202 /* Should not happen--we never call ovsdb_idl_set_lock(). */
1203 ctl_fatal("database not locked");
1210 ovsdb_symbol_table_destroy(symtab);
1212 for (c = commands; c < &commands[n_commands]; c++) {
1213 struct ds *ds = &c->output;
1216 table_print(c->table, &table_style);
1217 } else if (oneline) {
1221 for (j = 0; j < ds->length; j++) {
1222 int ch = ds->string[j];
1225 fputs("\\n", stdout);
1229 fputs("\\\\", stdout);
1238 fputs(ds_cstr(ds), stdout);
1240 ds_destroy(&c->output);
1241 table_destroy(c->table);
1244 shash_destroy_free_data(&c->options);
1247 ovsdb_idl_txn_destroy(txn);
1248 ovsdb_idl_destroy(idl);
1253 /* Our transaction needs to be rerun, or a prerequisite was not met. Free
1254 * resources and return so that the caller can try again. */
1256 ovsdb_idl_txn_abort(txn);
1257 ovsdb_idl_txn_destroy(txn);
1260 ovsdb_symbol_table_destroy(symtab);
1261 for (c = commands; c < &commands[n_commands]; c++) {
1262 ds_destroy(&c->output);
1263 table_destroy(c->table);
1269 /* Frees the current transaction and the underlying IDL and then calls
1272 * Freeing the transaction and the IDL is not strictly necessary, but it makes
1273 * for a clean memory leak report from valgrind in the normal case. That makes
1274 * it easier to notice real memory leaks. */
1276 nbctl_exit(int status)
1279 ovsdb_idl_txn_abort(the_idl_txn);
1280 ovsdb_idl_txn_destroy(the_idl_txn);
1282 ovsdb_idl_destroy(the_idl);
1286 static const struct ctl_command_syntax nbctl_commands[] = {
1287 { "show", 0, 1, "[LSWITCH]", NULL, nbctl_show, NULL, "", RO },
1289 /* lswitch commands. */
1290 { "lswitch-add", 0, 1, "[LSWITCH]", NULL, nbctl_lswitch_add,
1292 { "lswitch-del", 1, 1, "LSWITCH", NULL, nbctl_lswitch_del,
1294 { "lswitch-list", 0, 0, "", NULL, nbctl_lswitch_list, NULL, "", RO },
1297 { "acl-add", 5, 5, "LSWITCH DIRECTION PRIORITY MATCH ACTION", NULL,
1298 nbctl_acl_add, NULL, "--log", RW },
1299 { "acl-del", 1, 4, "LSWITCH [DIRECTION [PRIORITY MATCH]]", NULL,
1300 nbctl_acl_del, NULL, "", RW },
1301 { "acl-list", 1, 1, "LSWITCH", NULL, nbctl_acl_list, NULL, "", RO },
1303 /* lport commands. */
1304 { "lport-add", 2, 4, "LSWITCH LPORT [PARENT] [TAG]", NULL, nbctl_lport_add,
1306 { "lport-del", 1, 1, "LPORT", NULL, nbctl_lport_del, NULL, "", RO },
1307 { "lport-list", 1, 1, "LSWITCH", NULL, nbctl_lport_list, NULL, "", RO },
1308 { "lport-get-parent", 1, 1, "LPORT", NULL, nbctl_lport_get_parent, NULL,
1310 { "lport-get-tag", 1, 1, "LPORT", NULL, nbctl_lport_get_tag, NULL, "",
1312 { "lport-set-addresses", 1, INT_MAX, "LPORT [ADDRESS]...", NULL,
1313 nbctl_lport_set_addresses, NULL, "", RW },
1314 { "lport-get-addresses", 1, 1, "LPORT", NULL,
1315 nbctl_lport_get_addresses, NULL,
1317 { "lport-set-port-security", 0, INT_MAX, "LPORT [ADDRS]...", NULL,
1318 nbctl_lport_set_port_security, NULL, "", RW },
1319 { "lport-get-port-security", 1, 1, "LPORT", NULL,
1320 nbctl_lport_get_port_security, NULL, "", RO },
1321 { "lport-get-up", 1, 1, "LPORT", NULL, nbctl_lport_get_up, NULL, "", RO },
1322 { "lport-set-enabled", 2, 2, "LPORT STATE", NULL, nbctl_lport_set_enabled,
1324 { "lport-get-enabled", 1, 1, "LPORT", NULL, nbctl_lport_get_enabled, NULL,
1326 { "lport-set-type", 2, 2, "LPORT TYPE", NULL, nbctl_lport_set_type, NULL,
1328 { "lport-get-type", 1, 1, "LPORT", NULL, nbctl_lport_get_type, NULL, "",
1330 { "lport-set-options", 1, INT_MAX, "LPORT KEY=VALUE [KEY=VALUE]...", NULL,
1331 nbctl_lport_set_options, NULL, "", RW },
1332 { "lport-get-options", 1, 1, "LPORT", NULL, nbctl_lport_get_options, NULL,
1335 {NULL, 0, 0, NULL, NULL, NULL, NULL, "", RO},
1338 /* Registers nbctl and common db commands. */
1340 nbctl_cmd_init(void)
1342 ctl_init(tables, NULL, nbctl_exit);
1343 ctl_register_commands(nbctl_commands);