2 * Copyright (c) 2015, 2016 Nicira, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
30 #include "db-ctl-base.h"
32 #include "command-line.h"
34 #include "dynamic-string.h"
35 #include "fatal-signal.h"
37 #include "ovsdb-data.h"
38 #include "ovsdb-idl.h"
39 #include "poll-loop.h"
43 #include "stream-ssl.h"
48 #include "openvswitch/vlog.h"
49 #include "ovn/lib/ovn-sb-idl.h"
51 VLOG_DEFINE_THIS_MODULE(sbctl);
55 /* --db: The database server to contact. */
56 static const char *db;
58 /* --oneline: Write each command's output as a single line? */
61 /* --dry-run: Do not commit any changes. */
64 /* --timeout: Time to wait for a connection to 'db'. */
67 /* Format for table output. */
68 static struct table_style table_style = TABLE_STYLE_DEFAULT;
70 /* The IDL we're using and the current transaction, if any.
71 * This is for use by sbctl_exit() only, to allow it to clean up.
72 * Other code should use its context arguments. */
73 static struct ovsdb_idl *the_idl;
74 static struct ovsdb_idl_txn *the_idl_txn;
75 OVS_NO_RETURN static void sbctl_exit(int status);
77 static void sbctl_cmd_init(void);
78 OVS_NO_RETURN static void usage(void);
79 static void parse_options(int argc, char *argv[], struct shash *local_options);
80 static const char *sbctl_default_db(void);
81 static void run_prerequisites(struct ctl_command[], size_t n_commands,
83 static void do_sbctl(const char *args, struct ctl_command *, size_t n,
87 main(int argc, char *argv[])
89 struct ovsdb_idl *idl;
90 struct ctl_command *commands;
91 struct shash local_options;
96 set_program_name(argv[0]);
97 fatal_ignore_sigpipe();
98 vlog_set_levels(NULL, VLF_CONSOLE, VLL_WARN);
99 vlog_set_levels_from_string_assert("reconnect:warn");
104 /* Log our arguments. This is often valuable for debugging systems. */
105 args = process_escape_args(argv);
106 VLOG(ctl_might_write_to_db(argv) ? VLL_INFO : VLL_DBG, "Called as %s", args);
108 /* Parse command line. */
109 shash_init(&local_options);
110 parse_options(argc, argv, &local_options);
111 commands = ctl_parse_commands(argc - optind, argv + optind, &local_options,
118 /* Initialize IDL. */
119 idl = the_idl = ovsdb_idl_create(db, &sbrec_idl_class, false, false);
120 run_prerequisites(commands, n_commands, idl);
122 /* Execute the commands.
124 * 'seqno' is the database sequence number for which we last tried to
125 * execute our transaction. There's no point in trying to commit more than
126 * once for any given sequence number, because if the transaction fails
127 * it's because the database changed and we need to obtain an up-to-date
128 * view of the database before we try the transaction again. */
129 seqno = ovsdb_idl_get_seqno(idl);
132 if (!ovsdb_idl_is_alive(idl)) {
133 int retval = ovsdb_idl_get_last_error(idl);
134 ctl_fatal("%s: database connection failed (%s)",
135 db, ovs_retval_to_string(retval));
138 if (seqno != ovsdb_idl_get_seqno(idl)) {
139 seqno = ovsdb_idl_get_seqno(idl);
140 do_sbctl(args, commands, n_commands, idl);
143 if (seqno == ovsdb_idl_get_seqno(idl)) {
151 sbctl_default_db(void)
155 def = getenv("OVN_SB_DB");
157 def = ctl_default_db();
164 parse_options(int argc, char *argv[], struct shash *local_options)
167 OPT_DB = UCHAR_MAX + 1,
178 static const struct option global_long_options[] = {
179 {"db", required_argument, NULL, OPT_DB},
180 {"no-syslog", no_argument, NULL, OPT_NO_SYSLOG},
181 {"dry-run", no_argument, NULL, OPT_DRY_RUN},
182 {"oneline", no_argument, NULL, OPT_ONELINE},
183 {"timeout", required_argument, NULL, 't'},
184 {"help", no_argument, NULL, 'h'},
185 {"commands", no_argument, NULL, OPT_COMMANDS},
186 {"options", no_argument, NULL, OPT_OPTIONS},
187 {"version", no_argument, NULL, 'V'},
189 STREAM_SSL_LONG_OPTIONS,
193 const int n_global_long_options = ARRAY_SIZE(global_long_options) - 1;
194 char *tmp, *short_options;
196 struct option *options;
197 size_t allocated_options;
201 tmp = ovs_cmdl_long_options_to_short_options(global_long_options);
202 short_options = xasprintf("+%s", tmp);
205 /* We want to parse both global and command-specific options here, but
206 * getopt_long() isn't too convenient for the job. We copy our global
207 * options into a dynamic array, then append all of the command-specific
209 options = xmemdup(global_long_options, sizeof global_long_options);
210 allocated_options = ARRAY_SIZE(global_long_options);
211 n_options = n_global_long_options;
212 ctl_add_cmd_options(&options, &n_options, &allocated_options, OPT_LOCAL);
213 table_style.format = TF_LIST;
219 c = getopt_long(argc, argv, short_options, options, &idx);
234 vlog_set_levels(&this_module, VLF_SYSLOG, VLL_WARN);
242 if (shash_find(local_options, options[idx].name)) {
243 ctl_fatal("'%s' option specified multiple times",
246 shash_add_nocopy(local_options,
247 xasprintf("--%s", options[idx].name),
248 optarg ? xstrdup(optarg) : NULL);
255 ctl_print_commands();
258 ctl_print_options(global_long_options);
261 ovs_print_version(0, 0);
262 printf("DB Schema %s\n", sbrec_get_db_version());
266 timeout = strtoul(optarg, NULL, 10);
268 ctl_fatal("value %s on -t or --timeout is invalid", optarg);
273 TABLE_OPTION_HANDLERS(&table_style)
274 STREAM_SSL_OPTION_HANDLERS
286 db = sbctl_default_db();
289 for (i = n_global_long_options; options[i].name; i++) {
290 free(CONST_CAST(char *, options[i].name));
299 %s: OVN southbound DB management utility\n\
301 For debugging and testing only, not for use in production.\n\
303 usage: %s [OPTIONS] COMMAND [ARG...]\n\
306 show print overview of database contents\n\
309 chassis-add CHASSIS ENCAP-TYPE ENCAP-IP create a new chassis named\n\
310 CHASSIS with ENCAP-TYPE tunnels\n\
312 chassis-del CHASSIS delete CHASSIS and all of its encaps\n\
315 Port binding commands:\n\
316 lport-bind LPORT CHASSIS bind logical port LPORT to CHASSIS\n\
317 lport-unbind LPORT reset the port binding of logical port LPORT\n\
319 Logical flow commands:\n\
320 lflow-list [DATAPATH] List logical flows for all or a single datapath\n\
321 dump-flows [DATAPATH] Alias for lflow-list\n\
326 --db=DATABASE connect to DATABASE\n\
328 -t, --timeout=SECS wait at most SECS seconds\n\
329 --dry-run do not commit changes to database\n\
330 --oneline print exactly one line of output per command\n",
331 program_name, program_name, ctl_get_db_cmd_usage(), ctl_default_db());
334 --no-syslog equivalent to --verbose=sbctl:syslog:warn\n");
337 -h, --help display this help message\n\
338 -V, --version display version information\n");
339 stream_usage("database", true, true, false);
344 /* ovs-sbctl specific context. Inherits the 'struct ctl_context' as base. */
345 struct sbctl_context {
346 struct ctl_context base;
348 /* A cache of the contents of the database.
350 * A command that needs to use any of this information must first call
351 * sbctl_context_populate_cache(). A command that changes anything that
352 * could invalidate the cache must either call
353 * sbctl_context_invalidate_cache() or manually update the cache to
354 * maintain its correctness. */
356 /* Maps from chassis name to struct sbctl_chassis. */
357 struct shash chassis;
358 /* Maps from lport name to struct sbctl_port_binding. */
359 struct shash port_bindings;
362 /* Casts 'base' into 'struct sbctl_context'. */
363 static struct sbctl_context *
364 sbctl_context_cast(struct ctl_context *base)
366 return CONTAINER_OF(base, struct sbctl_context, base);
369 struct sbctl_chassis {
370 const struct sbrec_chassis *ch_cfg;
373 struct sbctl_port_binding {
374 const struct sbrec_port_binding *bd_cfg;
378 sbctl_context_invalidate_cache(struct ctl_context *ctx)
380 struct sbctl_context *sbctl_ctx = sbctl_context_cast(ctx);
382 if (!sbctl_ctx->cache_valid) {
385 sbctl_ctx->cache_valid = false;
386 shash_destroy_free_data(&sbctl_ctx->chassis);
387 shash_destroy_free_data(&sbctl_ctx->port_bindings);
391 sbctl_context_populate_cache(struct ctl_context *ctx)
393 struct sbctl_context *sbctl_ctx = sbctl_context_cast(ctx);
394 const struct sbrec_chassis *chassis_rec;
395 const struct sbrec_port_binding *port_binding_rec;
396 struct sset chassis, port_bindings;
398 if (sbctl_ctx->cache_valid) {
399 /* Cache is already populated. */
402 sbctl_ctx->cache_valid = true;
403 shash_init(&sbctl_ctx->chassis);
404 shash_init(&sbctl_ctx->port_bindings);
406 SBREC_CHASSIS_FOR_EACH(chassis_rec, ctx->idl) {
407 struct sbctl_chassis *ch;
409 if (!sset_add(&chassis, chassis_rec->name)) {
410 VLOG_WARN("database contains duplicate chassis name (%s)",
415 ch = xmalloc(sizeof *ch);
416 ch->ch_cfg = chassis_rec;
417 shash_add(&sbctl_ctx->chassis, chassis_rec->name, ch);
419 sset_destroy(&chassis);
421 sset_init(&port_bindings);
422 SBREC_PORT_BINDING_FOR_EACH(port_binding_rec, ctx->idl) {
423 struct sbctl_port_binding *bd;
425 if (!sset_add(&port_bindings, port_binding_rec->logical_port)) {
426 VLOG_WARN("database contains duplicate port binding for logical "
428 port_binding_rec->logical_port);
432 bd = xmalloc(sizeof *bd);
433 bd->bd_cfg = port_binding_rec;
434 shash_add(&sbctl_ctx->port_bindings, port_binding_rec->logical_port,
437 sset_destroy(&port_bindings);
441 check_conflicts(struct sbctl_context *sbctl_ctx, const char *name,
444 if (shash_find(&sbctl_ctx->chassis, name)) {
445 ctl_fatal("%s because a chassis named %s already exists",
451 static struct sbctl_chassis *
452 find_chassis(struct sbctl_context *sbctl_ctx, const char *name,
455 struct sbctl_chassis *sbctl_ch;
457 ovs_assert(sbctl_ctx->cache_valid);
459 sbctl_ch = shash_find_data(&sbctl_ctx->chassis, name);
460 if (must_exist && !sbctl_ch) {
461 ctl_fatal("no chassis named %s", name);
467 static struct sbctl_port_binding *
468 find_port_binding(struct sbctl_context *sbctl_ctx, const char *name,
471 struct sbctl_port_binding *bd;
473 ovs_assert(sbctl_ctx->cache_valid);
475 bd = shash_find_data(&sbctl_ctx->port_bindings, name);
476 if (must_exist && !bd) {
477 ctl_fatal("no port named %s", name);
484 pre_get_info(struct ctl_context *ctx)
486 ovsdb_idl_add_column(ctx->idl, &sbrec_chassis_col_name);
487 ovsdb_idl_add_column(ctx->idl, &sbrec_chassis_col_encaps);
489 ovsdb_idl_add_column(ctx->idl, &sbrec_encap_col_type);
490 ovsdb_idl_add_column(ctx->idl, &sbrec_encap_col_ip);
492 ovsdb_idl_add_column(ctx->idl, &sbrec_port_binding_col_logical_port);
493 ovsdb_idl_add_column(ctx->idl, &sbrec_port_binding_col_chassis);
495 ovsdb_idl_add_column(ctx->idl, &sbrec_logical_flow_col_logical_datapath);
496 ovsdb_idl_add_column(ctx->idl, &sbrec_logical_flow_col_pipeline);
497 ovsdb_idl_add_column(ctx->idl, &sbrec_logical_flow_col_actions);
498 ovsdb_idl_add_column(ctx->idl, &sbrec_logical_flow_col_priority);
499 ovsdb_idl_add_column(ctx->idl, &sbrec_logical_flow_col_table_id);
500 ovsdb_idl_add_column(ctx->idl, &sbrec_logical_flow_col_match);
501 ovsdb_idl_add_column(ctx->idl, &sbrec_logical_flow_col_external_ids);
504 static struct cmd_show_table cmd_show_tables[] = {
505 {&sbrec_table_chassis,
506 &sbrec_chassis_col_name,
507 {&sbrec_chassis_col_encaps,
510 {&sbrec_table_port_binding,
511 &sbrec_port_binding_col_logical_port,
512 &sbrec_port_binding_col_chassis}},
515 &sbrec_encap_col_type,
516 {&sbrec_encap_col_ip,
517 &sbrec_encap_col_options,
521 {NULL, NULL, {NULL, NULL, NULL}, {NULL, NULL, NULL}},
525 cmd_chassis_add(struct ctl_context *ctx)
527 struct sbctl_context *sbctl_ctx = sbctl_context_cast(ctx);
528 bool may_exist = shash_find(&ctx->options, "--may-exist") != NULL;
529 const char *ch_name, *encap_types, *encap_ip;
531 ch_name = ctx->argv[1];
532 encap_types = ctx->argv[2];
533 encap_ip = ctx->argv[3];
535 sbctl_context_populate_cache(ctx);
537 struct sbctl_chassis *sbctl_ch;
539 sbctl_ch = find_chassis(sbctl_ctx, ch_name, false);
544 check_conflicts(sbctl_ctx, ch_name,
545 xasprintf("cannot create a chassis named %s", ch_name));
547 char *tokstr = xstrdup(encap_types);
548 char *token, *save_ptr = NULL;
549 struct sset encap_set = SSET_INITIALIZER(&encap_set);
550 for (token = strtok_r(tokstr, ",", &save_ptr); token != NULL;
551 token = strtok_r(NULL, ",", &save_ptr)) {
552 sset_add(&encap_set, token);
556 size_t n_encaps = sset_count(&encap_set);
557 struct sbrec_encap **encaps = xmalloc(n_encaps * sizeof *encaps);
558 const char *encap_type;
560 SSET_FOR_EACH (encap_type, &encap_set){
561 encaps[i] = sbrec_encap_insert(ctx->txn);
563 sbrec_encap_set_type(encaps[i], encap_type);
564 sbrec_encap_set_ip(encaps[i], encap_ip);
567 sset_destroy(&encap_set);
569 struct sbrec_chassis *ch = sbrec_chassis_insert(ctx->txn);
570 sbrec_chassis_set_name(ch, ch_name);
571 sbrec_chassis_set_encaps(ch, encaps, n_encaps);
574 sbctl_context_invalidate_cache(ctx);
578 cmd_chassis_del(struct ctl_context *ctx)
580 struct sbctl_context *sbctl_ctx = sbctl_context_cast(ctx);
581 bool must_exist = !shash_find(&ctx->options, "--if-exists");
582 struct sbctl_chassis *sbctl_ch;
584 sbctl_context_populate_cache(ctx);
585 sbctl_ch = find_chassis(sbctl_ctx, ctx->argv[1], must_exist);
587 if (sbctl_ch->ch_cfg) {
590 for (i = 0; i < sbctl_ch->ch_cfg->n_encaps; i++) {
591 sbrec_encap_delete(sbctl_ch->ch_cfg->encaps[i]);
593 sbrec_chassis_delete(sbctl_ch->ch_cfg);
595 shash_find_and_delete(&sbctl_ctx->chassis, ctx->argv[1]);
601 cmd_lport_bind(struct ctl_context *ctx)
603 struct sbctl_context *sbctl_ctx = sbctl_context_cast(ctx);
604 bool may_exist = shash_find(&ctx->options, "--may-exist") != NULL;
605 struct sbctl_chassis *sbctl_ch;
606 struct sbctl_port_binding *sbctl_bd;
607 char *lport_name, *ch_name;
609 /* port_binding must exist, chassis must exist! */
610 lport_name = ctx->argv[1];
611 ch_name = ctx->argv[2];
613 sbctl_context_populate_cache(ctx);
614 sbctl_bd = find_port_binding(sbctl_ctx, lport_name, true);
615 sbctl_ch = find_chassis(sbctl_ctx, ch_name, true);
617 if (sbctl_bd->bd_cfg->chassis) {
618 if (may_exist && sbctl_bd->bd_cfg->chassis == sbctl_ch->ch_cfg) {
621 ctl_fatal("lport (%s) has already been binded to chassis (%s)",
622 lport_name, sbctl_bd->bd_cfg->chassis->name);
625 sbrec_port_binding_set_chassis(sbctl_bd->bd_cfg, sbctl_ch->ch_cfg);
626 sbctl_context_invalidate_cache(ctx);
630 cmd_lport_unbind(struct ctl_context *ctx)
632 struct sbctl_context *sbctl_ctx = sbctl_context_cast(ctx);
633 bool must_exist = !shash_find(&ctx->options, "--if-exists");
634 struct sbctl_port_binding *sbctl_bd;
637 lport_name = ctx->argv[1];
638 sbctl_context_populate_cache(ctx);
639 sbctl_bd = find_port_binding(sbctl_ctx, lport_name, must_exist);
641 sbrec_port_binding_set_chassis(sbctl_bd->bd_cfg, NULL);
650 /* Help ensure we catch any future pipeline values */
652 pipeline_encode(const char *pl)
654 if (!strcmp(pl, "ingress")) {
656 } else if (!strcmp(pl, "egress")) {
664 lflow_cmp(const void *lf1_, const void *lf2_)
666 const struct sbrec_logical_flow *const *lf1p = lf1_;
667 const struct sbrec_logical_flow *const *lf2p = lf2_;
668 const struct sbrec_logical_flow *lf1 = *lf1p;
669 const struct sbrec_logical_flow *lf2 = *lf2p;
671 int pl1 = pipeline_encode(lf1->pipeline);
672 int pl2 = pipeline_encode(lf2->pipeline);
683 CMP(uuid_compare_3way(&lf1->logical_datapath->header_.uuid,
684 &lf2->logical_datapath->header_.uuid));
686 CMP(lf1->table_id > lf2->table_id ? 1 :
687 (lf1->table_id < lf2->table_id ? -1 : 0));
688 CMP(lf1->priority > lf2->priority ? -1 :
689 (lf1->priority < lf2->priority ? 1 : 0));
690 CMP(strcmp(lf1->match, lf2->match));
698 cmd_lflow_list(struct ctl_context *ctx)
700 const char *datapath = ctx->argc == 2 ? ctx->argv[1] : NULL;
701 struct uuid datapath_uuid = { .parts = { 0, }};
702 const struct sbrec_logical_flow **lflows;
703 const struct sbrec_logical_flow *lflow;
704 size_t n_flows = 0, n_capacity = 64;
706 if (datapath && !uuid_from_string(&datapath_uuid, datapath)) {
707 VLOG_ERR("Invalid format of datapath UUID");
711 lflows = xmalloc(sizeof *lflows * n_capacity);
712 SBREC_LOGICAL_FLOW_FOR_EACH (lflow, ctx->idl) {
713 if (n_flows == n_capacity) {
714 lflows = x2nrealloc(lflows, &n_capacity, sizeof *lflows);
716 lflows[n_flows] = lflow;
720 qsort(lflows, n_flows, sizeof *lflows, lflow_cmp);
722 const char *cur_pipeline = "";
724 for (i = 0; i < n_flows; i++) {
726 if (datapath && !uuid_equals(&datapath_uuid,
727 &lflow->logical_datapath->header_.uuid)) {
730 if (strcmp(cur_pipeline, lflow->pipeline)) {
731 printf("Datapath: " UUID_FMT " Pipeline: %s\n",
732 UUID_ARGS(&lflow->logical_datapath->header_.uuid),
734 cur_pipeline = lflow->pipeline;
737 const char *table_name = smap_get(&lflow->external_ids, "stage-name");
738 printf(" table=%" PRId64 "(%16s), priority=%5" PRId64
739 ", match=(%s), action=(%s)\n",
740 lflow->table_id, table_name ? table_name : "",
741 lflow->priority, lflow->match, lflow->actions);
748 static const struct ctl_table_class tables[] = {
749 {&sbrec_table_chassis,
750 {{&sbrec_table_chassis, &sbrec_chassis_col_name, NULL},
751 {NULL, NULL, NULL}}},
755 {NULL, NULL, NULL}}},
757 {&sbrec_table_logical_flow,
758 {{&sbrec_table_logical_flow, NULL,
759 &sbrec_logical_flow_col_logical_datapath},
760 {NULL, NULL, NULL}}},
762 {&sbrec_table_multicast_group,
764 {NULL, NULL, NULL}}},
766 {&sbrec_table_datapath_binding,
768 {NULL, NULL, NULL}}},
770 {&sbrec_table_port_binding,
771 {{&sbrec_table_port_binding, &sbrec_port_binding_col_logical_port, NULL},
772 {NULL, NULL, NULL}}},
774 {NULL, {{NULL, NULL, NULL}, {NULL, NULL, NULL}}}
779 sbctl_context_init_command(struct sbctl_context *sbctl_ctx,
780 struct ctl_command *command)
782 ctl_context_init_command(&sbctl_ctx->base, command);
786 sbctl_context_init(struct sbctl_context *sbctl_ctx,
787 struct ctl_command *command, struct ovsdb_idl *idl,
788 struct ovsdb_idl_txn *txn,
789 struct ovsdb_symbol_table *symtab)
791 ctl_context_init(&sbctl_ctx->base, command, idl, txn, symtab,
792 sbctl_context_invalidate_cache);
793 sbctl_ctx->cache_valid = false;
797 sbctl_context_done_command(struct sbctl_context *sbctl_ctx,
798 struct ctl_command *command)
800 ctl_context_done_command(&sbctl_ctx->base, command);
804 sbctl_context_done(struct sbctl_context *sbctl_ctx,
805 struct ctl_command *command)
807 ctl_context_done(&sbctl_ctx->base, command);
811 run_prerequisites(struct ctl_command *commands, size_t n_commands,
812 struct ovsdb_idl *idl)
814 struct ctl_command *c;
816 for (c = commands; c < &commands[n_commands]; c++) {
817 if (c->syntax->prerequisites) {
818 struct sbctl_context sbctl_ctx;
823 sbctl_context_init(&sbctl_ctx, c, idl, NULL, NULL);
824 (c->syntax->prerequisites)(&sbctl_ctx.base);
825 sbctl_context_done(&sbctl_ctx, c);
827 ovs_assert(!c->output.string);
828 ovs_assert(!c->table);
834 do_sbctl(const char *args, struct ctl_command *commands, size_t n_commands,
835 struct ovsdb_idl *idl)
837 struct ovsdb_idl_txn *txn;
838 enum ovsdb_idl_txn_status status;
839 struct ovsdb_symbol_table *symtab;
840 struct sbctl_context sbctl_ctx;
841 struct ctl_command *c;
842 struct shash_node *node;
845 txn = the_idl_txn = ovsdb_idl_txn_create(idl);
847 ovsdb_idl_txn_set_dry_run(txn);
850 ovsdb_idl_txn_add_comment(txn, "ovs-sbctl: %s", args);
852 symtab = ovsdb_symbol_table_create();
853 for (c = commands; c < &commands[n_commands]; c++) {
857 sbctl_context_init(&sbctl_ctx, NULL, idl, txn, symtab);
858 for (c = commands; c < &commands[n_commands]; c++) {
859 sbctl_context_init_command(&sbctl_ctx, c);
860 if (c->syntax->run) {
861 (c->syntax->run)(&sbctl_ctx.base);
863 sbctl_context_done_command(&sbctl_ctx, c);
865 if (sbctl_ctx.base.try_again) {
866 sbctl_context_done(&sbctl_ctx, NULL);
870 sbctl_context_done(&sbctl_ctx, NULL);
872 SHASH_FOR_EACH (node, &symtab->sh) {
873 struct ovsdb_symbol *symbol = node->data;
874 if (!symbol->created) {
875 ctl_fatal("row id \"%s\" is referenced but never created (e.g. "
876 "with \"-- --id=%s create ...\")",
877 node->name, node->name);
879 if (!symbol->strong_ref) {
880 if (!symbol->weak_ref) {
881 VLOG_WARN("row id \"%s\" was created but no reference to it "
882 "was inserted, so it will not actually appear in "
883 "the database", node->name);
885 VLOG_WARN("row id \"%s\" was created but only a weak "
886 "reference to it was inserted, so it will not "
887 "actually appear in the database", node->name);
892 status = ovsdb_idl_txn_commit_block(txn);
893 if (status == TXN_UNCHANGED || status == TXN_SUCCESS) {
894 for (c = commands; c < &commands[n_commands]; c++) {
895 if (c->syntax->postprocess) {
896 sbctl_context_init(&sbctl_ctx, c, idl, txn, symtab);
897 (c->syntax->postprocess)(&sbctl_ctx.base);
898 sbctl_context_done(&sbctl_ctx, c);
902 error = xstrdup(ovsdb_idl_txn_get_error(txn));
905 case TXN_UNCOMMITTED:
910 /* Should not happen--we never call ovsdb_idl_txn_abort(). */
911 ctl_fatal("transaction aborted");
921 ctl_fatal("transaction error: %s", error);
924 /* Should not happen--we never call ovsdb_idl_set_lock(). */
925 ctl_fatal("database not locked");
932 ovsdb_symbol_table_destroy(symtab);
934 for (c = commands; c < &commands[n_commands]; c++) {
935 struct ds *ds = &c->output;
938 table_print(c->table, &table_style);
939 } else if (oneline) {
943 for (j = 0; j < ds->length; j++) {
944 int ch = ds->string[j];
947 fputs("\\n", stdout);
951 fputs("\\\\", stdout);
960 fputs(ds_cstr(ds), stdout);
962 ds_destroy(&c->output);
963 table_destroy(c->table);
966 shash_destroy_free_data(&c->options);
969 ovsdb_idl_txn_destroy(txn);
970 ovsdb_idl_destroy(idl);
975 /* Our transaction needs to be rerun, or a prerequisite was not met. Free
976 * resources and return so that the caller can try again. */
978 ovsdb_idl_txn_abort(txn);
979 ovsdb_idl_txn_destroy(txn);
982 ovsdb_symbol_table_destroy(symtab);
983 for (c = commands; c < &commands[n_commands]; c++) {
984 ds_destroy(&c->output);
985 table_destroy(c->table);
991 /* Frees the current transaction and the underlying IDL and then calls
994 * Freeing the transaction and the IDL is not strictly necessary, but it makes
995 * for a clean memory leak report from valgrind in the normal case. That makes
996 * it easier to notice real memory leaks. */
998 sbctl_exit(int status)
1001 ovsdb_idl_txn_abort(the_idl_txn);
1002 ovsdb_idl_txn_destroy(the_idl_txn);
1004 ovsdb_idl_destroy(the_idl);
1008 static const struct ctl_command_syntax sbctl_commands[] = {
1009 /* Chassis commands. */
1010 {"chassis-add", 3, 3, "CHASSIS ENCAP-TYPE ENCAP-IP", pre_get_info,
1011 cmd_chassis_add, NULL, "--may-exist", RW},
1012 {"chassis-del", 1, 1, "CHASSIS", pre_get_info, cmd_chassis_del, NULL,
1015 /* Port binding commands. */
1016 {"lport-bind", 2, 2, "LPORT CHASSIS", pre_get_info, cmd_lport_bind, NULL,
1018 {"lport-unbind", 1, 1, "LPORT", pre_get_info, cmd_lport_unbind, NULL,
1021 /* Logical flow commands */
1022 {"lflow-list", 0, 1, "[DATAPATH]", pre_get_info, cmd_lflow_list, NULL,
1024 {"dump-flows", 0, 1, "[DATAPATH]", pre_get_info, cmd_lflow_list, NULL,
1025 "", RO}, /* Friendly alias for lflow-list */
1027 /* SSL commands (To Be Added). */
1029 {NULL, 0, 0, NULL, NULL, NULL, NULL, NULL, RO},
1032 /* Registers sbctl and common db commands. */
1034 sbctl_cmd_init(void)
1036 ctl_init(tables, cmd_show_tables, sbctl_exit);
1037 ctl_register_commands(sbctl_commands);