2 * Copyright (c) 2015 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"
46 #include "openvswitch/vlog.h"
47 #include "ovn/lib/ovn-sb-idl.h"
49 VLOG_DEFINE_THIS_MODULE(sbctl
);
53 /* --db: The database server to contact. */
54 static const char *db
;
56 /* --oneline: Write each command's output as a single line? */
59 /* --dry-run: Do not commit any changes. */
62 /* --timeout: Time to wait for a connection to 'db'. */
65 /* Format for table output. */
66 static struct table_style table_style
= TABLE_STYLE_DEFAULT
;
68 /* The IDL we're using and the current transaction, if any.
69 * This is for use by sbctl_exit() only, to allow it to clean up.
70 * Other code should use its context arguments. */
71 static struct ovsdb_idl
*the_idl
;
72 static struct ovsdb_idl_txn
*the_idl_txn
;
73 OVS_NO_RETURN
static void sbctl_exit(int status
);
75 static void sbctl_cmd_init(void);
76 OVS_NO_RETURN
static void usage(void);
77 static void parse_options(int argc
, char *argv
[], struct shash
*local_options
);
78 static void run_prerequisites(struct ctl_command
[], size_t n_commands
,
80 static void do_sbctl(const char *args
, struct ctl_command
*, size_t n
,
84 main(int argc
, char *argv
[])
86 extern struct vlog_module VLM_reconnect
;
87 struct ovsdb_idl
*idl
;
88 struct ctl_command
*commands
;
89 struct shash local_options
;
94 set_program_name(argv
[0]);
95 fatal_ignore_sigpipe();
96 vlog_set_levels(NULL
, VLF_CONSOLE
, VLL_WARN
);
97 vlog_set_levels(&VLM_reconnect
, VLF_ANY_DESTINATION
, VLL_WARN
);
102 /* Log our arguments. This is often valuable for debugging systems. */
103 args
= process_escape_args(argv
);
104 VLOG(ctl_might_write_to_db(argv
) ? VLL_INFO
: VLL_DBG
, "Called as %s", args
);
106 /* Parse command line. */
107 shash_init(&local_options
);
108 parse_options(argc
, argv
, &local_options
);
109 commands
= ctl_parse_commands(argc
- optind
, argv
+ optind
, &local_options
,
116 /* Initialize IDL. */
117 idl
= the_idl
= ovsdb_idl_create(db
, &sbrec_idl_class
, false, false);
118 run_prerequisites(commands
, n_commands
, idl
);
120 /* Execute the commands.
122 * 'seqno' is the database sequence number for which we last tried to
123 * execute our transaction. There's no point in trying to commit more than
124 * once for any given sequence number, because if the transaction fails
125 * it's because the database changed and we need to obtain an up-to-date
126 * view of the database before we try the transaction again. */
127 seqno
= ovsdb_idl_get_seqno(idl
);
130 if (!ovsdb_idl_is_alive(idl
)) {
131 int retval
= ovsdb_idl_get_last_error(idl
);
132 ctl_fatal("%s: database connection failed (%s)",
133 db
, ovs_retval_to_string(retval
));
136 if (seqno
!= ovsdb_idl_get_seqno(idl
)) {
137 seqno
= ovsdb_idl_get_seqno(idl
);
138 do_sbctl(args
, commands
, n_commands
, idl
);
141 if (seqno
== ovsdb_idl_get_seqno(idl
)) {
149 parse_options(int argc
, char *argv
[], struct shash
*local_options
)
152 OPT_DB
= UCHAR_MAX
+ 1,
163 static const struct option global_long_options
[] = {
164 {"db", required_argument
, NULL
, OPT_DB
},
165 {"no-syslog", no_argument
, NULL
, OPT_NO_SYSLOG
},
166 {"dry-run", no_argument
, NULL
, OPT_DRY_RUN
},
167 {"oneline", no_argument
, NULL
, OPT_ONELINE
},
168 {"timeout", required_argument
, NULL
, 't'},
169 {"help", no_argument
, NULL
, 'h'},
170 {"commands", no_argument
, NULL
, OPT_COMMANDS
},
171 {"options", no_argument
, NULL
, OPT_OPTIONS
},
172 {"version", no_argument
, NULL
, 'V'},
177 const int n_global_long_options
= ARRAY_SIZE(global_long_options
) - 1;
178 char *tmp
, *short_options
;
180 struct option
*options
;
181 size_t allocated_options
;
185 tmp
= ovs_cmdl_long_options_to_short_options(global_long_options
);
186 short_options
= xasprintf("+%s", tmp
);
189 /* We want to parse both global and command-specific options here, but
190 * getopt_long() isn't too convenient for the job. We copy our global
191 * options into a dynamic array, then append all of the command-specific
193 options
= xmemdup(global_long_options
, sizeof global_long_options
);
194 allocated_options
= ARRAY_SIZE(global_long_options
);
195 n_options
= n_global_long_options
;
196 ctl_add_cmd_options(&options
, &n_options
, &allocated_options
, OPT_LOCAL
);
197 table_style
.format
= TF_LIST
;
203 c
= getopt_long(argc
, argv
, short_options
, options
, &idx
);
218 vlog_set_levels(&VLM_sbctl
, VLF_SYSLOG
, VLL_WARN
);
226 if (shash_find(local_options
, options
[idx
].name
)) {
227 ctl_fatal("'%s' option specified multiple times",
230 shash_add_nocopy(local_options
,
231 xasprintf("--%s", options
[idx
].name
),
232 optarg
? xstrdup(optarg
) : NULL
);
239 ctl_print_commands();
242 ctl_print_options(global_long_options
);
245 ovs_print_version(0, 0);
246 printf("DB Schema %s\n", sbrec_get_db_version());
250 timeout
= strtoul(optarg
, NULL
, 10);
252 ctl_fatal("value %s on -t or --timeout is invalid",
258 TABLE_OPTION_HANDLERS(&table_style
)
270 db
= ctl_default_db();
273 for (i
= n_global_long_options
; options
[i
].name
; i
++) {
274 free(CONST_CAST(char *, options
[i
].name
));
283 %s: ovs-vswitchd management utility\n\
285 for debugging and testing only, never use it in production\n\
287 usage: %s [OPTIONS] COMMAND [ARG...]\n\
289 SouthBound DB commands:\n\
290 show print overview of database contents\n\
293 chassis-add CHASSIS ENCAP-TYPE ENCAP-IP create a new chassis named\n\
294 CHASSIS with one encapsulation\n\
295 entry of ENCAP-TYPE and ENCAP-IP\n\
296 chassis-del CHASSIS delete CHASSIS and all of its encaps,\n\
299 Port binding commands:\n\
300 lport-bind LPORT CHASSIS bind logical port LPORT to CHASSIS\n\
301 lport-unbind LPORT reset the port binding of logical port LPORT\n\
303 Logical flow commands:\n\
304 lflow-list [DATAPATH] List logical flows for all or a single datapath\n\
305 dump-flows [DATAPATH] Alias for lflow-list\n\
310 --db=DATABASE connect to DATABASE\n\
312 -t, --timeout=SECS wait at most SECS seconds for ovs-vswitchd\n\
313 --dry-run do not commit changes to database\n\
314 --oneline print exactly one line of output per command\n",
315 program_name
, program_name
, ctl_get_db_cmd_usage(), ctl_default_db());
318 --no-syslog equivalent to --verbose=sbctl:syslog:warn\n");
321 -h, --help display this help message\n\
322 -V, --version display version information\n");
327 /* ovs-sbctl specific context. Inherits the 'struct ctl_context' as base. */
328 struct sbctl_context
{
329 struct ctl_context base
;
331 /* A cache of the contents of the database.
333 * A command that needs to use any of this information must first call
334 * sbctl_context_populate_cache(). A command that changes anything that
335 * could invalidate the cache must either call
336 * sbctl_context_invalidate_cache() or manually update the cache to
337 * maintain its correctness. */
339 /* Maps from chassis name to struct sbctl_chassis. */
340 struct shash chassis
;
341 /* Maps from lport name to struct sbctl_port_binding. */
342 struct shash port_bindings
;
345 /* Casts 'base' into 'strcut sbctl_context'. */
346 static struct sbctl_context
*
347 sbctl_context_cast(struct ctl_context
*base
)
349 return CONTAINER_OF(base
, struct sbctl_context
, base
);
352 struct sbctl_chassis
{
353 const struct sbrec_chassis
*ch_cfg
;
356 struct sbctl_port_binding
{
357 const struct sbrec_port_binding
*bd_cfg
;
361 sbctl_context_invalidate_cache(struct ctl_context
*ctx
)
363 struct sbctl_context
*sbctl_ctx
= sbctl_context_cast(ctx
);
365 if (!sbctl_ctx
->cache_valid
) {
368 sbctl_ctx
->cache_valid
= false;
369 shash_destroy_free_data(&sbctl_ctx
->chassis
);
370 shash_destroy_free_data(&sbctl_ctx
->port_bindings
);
374 sbctl_context_populate_cache(struct ctl_context
*ctx
)
376 struct sbctl_context
*sbctl_ctx
= sbctl_context_cast(ctx
);
377 const struct sbrec_chassis
*chassis_rec
;
378 const struct sbrec_port_binding
*port_binding_rec
;
379 struct sset chassis
, port_bindings
;
381 if (sbctl_ctx
->cache_valid
) {
382 /* Cache is already populated. */
385 sbctl_ctx
->cache_valid
= true;
386 shash_init(&sbctl_ctx
->chassis
);
387 shash_init(&sbctl_ctx
->port_bindings
);
389 SBREC_CHASSIS_FOR_EACH(chassis_rec
, ctx
->idl
) {
390 struct sbctl_chassis
*ch
;
392 if (!sset_add(&chassis
, chassis_rec
->name
)) {
393 VLOG_WARN("database contains duplicate chassis name (%s)",
398 ch
= xmalloc(sizeof *ch
);
399 ch
->ch_cfg
= chassis_rec
;
400 shash_add(&sbctl_ctx
->chassis
, chassis_rec
->name
, ch
);
402 sset_destroy(&chassis
);
404 sset_init(&port_bindings
);
405 SBREC_PORT_BINDING_FOR_EACH(port_binding_rec
, ctx
->idl
) {
406 struct sbctl_port_binding
*bd
;
408 if (!sset_add(&port_bindings
, port_binding_rec
->logical_port
)) {
409 VLOG_WARN("database contains duplicate port binding for logical "
411 port_binding_rec
->logical_port
);
415 bd
= xmalloc(sizeof *bd
);
416 bd
->bd_cfg
= port_binding_rec
;
417 shash_add(&sbctl_ctx
->port_bindings
, port_binding_rec
->logical_port
,
420 sset_destroy(&port_bindings
);
424 check_conflicts(struct sbctl_context
*sbctl_ctx
, const char *name
,
427 if (shash_find(&sbctl_ctx
->chassis
, name
)) {
428 ctl_fatal("%s because a chassis named %s already exists",
434 static struct sbctl_chassis
*
435 find_chassis(struct sbctl_context
*sbctl_ctx
, const char *name
,
438 struct sbctl_chassis
*sbctl_ch
;
440 ovs_assert(sbctl_ctx
->cache_valid
);
442 sbctl_ch
= shash_find_data(&sbctl_ctx
->chassis
, name
);
443 if (must_exist
&& !sbctl_ch
) {
444 ctl_fatal("no chassis named %s", name
);
450 static struct sbctl_port_binding
*
451 find_port_binding(struct sbctl_context
*sbctl_ctx
, const char *name
,
454 struct sbctl_port_binding
*bd
;
456 ovs_assert(sbctl_ctx
->cache_valid
);
458 bd
= shash_find_data(&sbctl_ctx
->port_bindings
, name
);
459 if (must_exist
&& !bd
) {
460 ctl_fatal("no port named %s", name
);
467 pre_get_info(struct ctl_context
*ctx
)
469 ovsdb_idl_add_column(ctx
->idl
, &sbrec_chassis_col_name
);
470 ovsdb_idl_add_column(ctx
->idl
, &sbrec_chassis_col_encaps
);
472 ovsdb_idl_add_column(ctx
->idl
, &sbrec_encap_col_type
);
473 ovsdb_idl_add_column(ctx
->idl
, &sbrec_encap_col_ip
);
475 ovsdb_idl_add_column(ctx
->idl
, &sbrec_port_binding_col_logical_port
);
476 ovsdb_idl_add_column(ctx
->idl
, &sbrec_port_binding_col_chassis
);
478 ovsdb_idl_add_column(ctx
->idl
, &sbrec_logical_flow_col_logical_datapath
);
479 ovsdb_idl_add_column(ctx
->idl
, &sbrec_logical_flow_col_pipeline
);
480 ovsdb_idl_add_column(ctx
->idl
, &sbrec_logical_flow_col_actions
);
481 ovsdb_idl_add_column(ctx
->idl
, &sbrec_logical_flow_col_priority
);
482 ovsdb_idl_add_column(ctx
->idl
, &sbrec_logical_flow_col_table_id
);
483 ovsdb_idl_add_column(ctx
->idl
, &sbrec_logical_flow_col_match
);
484 ovsdb_idl_add_column(ctx
->idl
, &sbrec_logical_flow_col_external_ids
);
487 static struct cmd_show_table cmd_show_tables
[] = {
488 {&sbrec_table_chassis
,
489 &sbrec_chassis_col_name
,
490 {&sbrec_chassis_col_encaps
,
493 {&sbrec_table_port_binding
,
494 &sbrec_port_binding_col_logical_port
,
495 &sbrec_port_binding_col_chassis
}},
498 &sbrec_encap_col_type
,
499 {&sbrec_encap_col_ip
,
500 &sbrec_encap_col_options
,
504 {NULL
, NULL
, {NULL
, NULL
, NULL
}, {NULL
, NULL
, NULL
}},
508 cmd_chassis_add(struct ctl_context
*ctx
)
510 struct sbctl_context
*sbctl_ctx
= sbctl_context_cast(ctx
);
511 struct sbrec_chassis
*ch
;
512 struct sbrec_encap
*encap
;
513 bool may_exist
= shash_find(&ctx
->options
, "--may-exist") != NULL
;
514 const char *ch_name
, *encap_type
, *encap_ip
;
516 ch_name
= ctx
->argv
[1];
517 encap_type
= ctx
->argv
[2];
518 encap_ip
= ctx
->argv
[3];
520 sbctl_context_populate_cache(ctx
);
522 struct sbctl_chassis
*sbctl_ch
;
524 sbctl_ch
= find_chassis(sbctl_ctx
, ch_name
, false);
529 check_conflicts(sbctl_ctx
, ch_name
,
530 xasprintf("cannot create a chassis named %s", ch_name
));
531 ch
= sbrec_chassis_insert(ctx
->txn
);
532 sbrec_chassis_set_name(ch
, ch_name
);
533 encap
= sbrec_encap_insert(ctx
->txn
);
534 sbrec_encap_set_type(encap
, encap_type
);
535 sbrec_encap_set_ip(encap
, encap_ip
);
536 sbrec_chassis_set_encaps(ch
, &encap
, 1);
537 sbctl_context_invalidate_cache(ctx
);
541 cmd_chassis_del(struct ctl_context
*ctx
)
543 struct sbctl_context
*sbctl_ctx
= sbctl_context_cast(ctx
);
544 bool must_exist
= !shash_find(&ctx
->options
, "--if-exists");
545 struct sbctl_chassis
*sbctl_ch
;
547 sbctl_context_populate_cache(ctx
);
548 sbctl_ch
= find_chassis(sbctl_ctx
, ctx
->argv
[1], must_exist
);
550 if (sbctl_ch
->ch_cfg
) {
553 for (i
= 0; i
< sbctl_ch
->ch_cfg
->n_encaps
; i
++) {
554 sbrec_encap_delete(sbctl_ch
->ch_cfg
->encaps
[i
]);
556 sbrec_chassis_delete(sbctl_ch
->ch_cfg
);
558 shash_find_and_delete(&sbctl_ctx
->chassis
, ctx
->argv
[1]);
564 cmd_lport_bind(struct ctl_context
*ctx
)
566 struct sbctl_context
*sbctl_ctx
= sbctl_context_cast(ctx
);
567 bool may_exist
= shash_find(&ctx
->options
, "--may-exist") != NULL
;
568 struct sbctl_chassis
*sbctl_ch
;
569 struct sbctl_port_binding
*sbctl_bd
;
570 char *lport_name
, *ch_name
;
572 /* port_binding must exist, chassis must exist! */
573 lport_name
= ctx
->argv
[1];
574 ch_name
= ctx
->argv
[2];
576 sbctl_context_populate_cache(ctx
);
577 sbctl_bd
= find_port_binding(sbctl_ctx
, lport_name
, true);
578 sbctl_ch
= find_chassis(sbctl_ctx
, ch_name
, true);
580 if (sbctl_bd
->bd_cfg
->chassis
) {
581 if (may_exist
&& sbctl_bd
->bd_cfg
->chassis
== sbctl_ch
->ch_cfg
) {
584 ctl_fatal("lport (%s) has already been binded to chassis (%s)",
585 lport_name
, sbctl_bd
->bd_cfg
->chassis
->name
);
588 sbrec_port_binding_set_chassis(sbctl_bd
->bd_cfg
, sbctl_ch
->ch_cfg
);
589 sbctl_context_invalidate_cache(ctx
);
593 cmd_lport_unbind(struct ctl_context
*ctx
)
595 struct sbctl_context
*sbctl_ctx
= sbctl_context_cast(ctx
);
596 bool must_exist
= !shash_find(&ctx
->options
, "--if-exists");
597 struct sbctl_port_binding
*sbctl_bd
;
600 lport_name
= ctx
->argv
[1];
601 sbctl_context_populate_cache(ctx
);
602 sbctl_bd
= find_port_binding(sbctl_ctx
, lport_name
, must_exist
);
604 sbrec_port_binding_set_chassis(sbctl_bd
->bd_cfg
, NULL
);
613 /* Help ensure we catch any future pipeline values */
615 pipeline_encode(const char *pl
)
617 if (!strcmp(pl
, "ingress")) {
619 } else if (!strcmp(pl
, "egress")) {
627 lflow_cmp(const void *lf1_
, const void *lf2_
)
629 const struct sbrec_logical_flow
*const *lf1p
= lf1_
;
630 const struct sbrec_logical_flow
*const *lf2p
= lf2_
;
631 const struct sbrec_logical_flow
*lf1
= *lf1p
;
632 const struct sbrec_logical_flow
*lf2
= *lf2p
;
634 int pl1
= pipeline_encode(lf1
->pipeline
);
635 int pl2
= pipeline_encode(lf2
->pipeline
);
646 CMP(uuid_compare_3way(&lf1
->logical_datapath
->header_
.uuid
,
647 &lf2
->logical_datapath
->header_
.uuid
));
649 CMP(lf1
->table_id
> lf2
->table_id
? 1 :
650 (lf1
->table_id
< lf2
->table_id
? -1 : 0));
651 CMP(lf1
->priority
> lf2
->priority
? -1 :
652 (lf1
->priority
< lf2
->priority
? 1 : 0));
653 CMP(strcmp(lf1
->match
, lf2
->match
));
661 cmd_lflow_list(struct ctl_context
*ctx
)
663 const char *datapath
= ctx
->argc
== 2 ? ctx
->argv
[1] : NULL
;
664 struct uuid datapath_uuid
= { .parts
= { 0, }};
665 const struct sbrec_logical_flow
**lflows
;
666 const struct sbrec_logical_flow
*lflow
;
667 size_t n_flows
= 0, n_capacity
= 64;
669 if (datapath
&& !uuid_from_string(&datapath_uuid
, datapath
)) {
670 VLOG_ERR("Invalid format of datapath UUID");
674 lflows
= xmalloc(sizeof *lflows
* n_capacity
);
675 SBREC_LOGICAL_FLOW_FOR_EACH (lflow
, ctx
->idl
) {
676 if (n_flows
== n_capacity
) {
677 lflows
= x2nrealloc(lflows
, &n_capacity
, sizeof *lflows
);
679 lflows
[n_flows
] = lflow
;
683 qsort(lflows
, n_flows
, sizeof *lflows
, lflow_cmp
);
685 const char *cur_pipeline
= "";
687 for (i
= 0; i
< n_flows
; i
++) {
689 if (datapath
&& !uuid_equals(&datapath_uuid
,
690 &lflow
->logical_datapath
->header_
.uuid
)) {
693 if (strcmp(cur_pipeline
, lflow
->pipeline
)) {
694 printf("Datapath: " UUID_FMT
" Pipeline: %s\n",
695 UUID_ARGS(&lflow
->logical_datapath
->header_
.uuid
),
697 cur_pipeline
= lflow
->pipeline
;
700 const char *table_name
= smap_get(&lflow
->external_ids
, "stage-name");
701 printf(" table=%" PRId64
"(%8s), priority=%3" PRId64
702 ", match=(%s), action=(%s)\n",
703 lflow
->table_id
, table_name
? table_name
: "",
704 lflow
->priority
, lflow
->match
, lflow
->actions
);
711 static const struct ctl_table_class tables
[] = {
712 {&sbrec_table_chassis
,
713 {{&sbrec_table_chassis
, &sbrec_chassis_col_name
, NULL
},
714 {NULL
, NULL
, NULL
}}},
718 {NULL
, NULL
, NULL
}}},
720 {&sbrec_table_logical_flow
,
721 {{&sbrec_table_logical_flow
, NULL
,
722 &sbrec_logical_flow_col_logical_datapath
},
723 {NULL
, NULL
, NULL
}}},
725 {&sbrec_table_multicast_group
,
727 {NULL
, NULL
, NULL
}}},
729 {&sbrec_table_datapath_binding
,
731 {NULL
, NULL
, NULL
}}},
733 {&sbrec_table_port_binding
,
734 {{&sbrec_table_port_binding
, &sbrec_port_binding_col_logical_port
, NULL
},
735 {NULL
, NULL
, NULL
}}},
737 {NULL
, {{NULL
, NULL
, NULL
}, {NULL
, NULL
, NULL
}}}
742 sbctl_context_init_command(struct sbctl_context
*sbctl_ctx
,
743 struct ctl_command
*command
)
745 ctl_context_init_command(&sbctl_ctx
->base
, command
);
749 sbctl_context_init(struct sbctl_context
*sbctl_ctx
,
750 struct ctl_command
*command
, struct ovsdb_idl
*idl
,
751 struct ovsdb_idl_txn
*txn
,
752 struct ovsdb_symbol_table
*symtab
)
754 ctl_context_init(&sbctl_ctx
->base
, command
, idl
, txn
, symtab
,
755 sbctl_context_invalidate_cache
);
756 sbctl_ctx
->cache_valid
= false;
760 sbctl_context_done_command(struct sbctl_context
*sbctl_ctx
,
761 struct ctl_command
*command
)
763 ctl_context_done_command(&sbctl_ctx
->base
, command
);
767 sbctl_context_done(struct sbctl_context
*sbctl_ctx
,
768 struct ctl_command
*command
)
770 ctl_context_done(&sbctl_ctx
->base
, command
);
774 run_prerequisites(struct ctl_command
*commands
, size_t n_commands
,
775 struct ovsdb_idl
*idl
)
777 struct ctl_command
*c
;
779 for (c
= commands
; c
< &commands
[n_commands
]; c
++) {
780 if (c
->syntax
->prerequisites
) {
781 struct sbctl_context sbctl_ctx
;
786 sbctl_context_init(&sbctl_ctx
, c
, idl
, NULL
, NULL
);
787 (c
->syntax
->prerequisites
)(&sbctl_ctx
.base
);
788 sbctl_context_done(&sbctl_ctx
, c
);
790 ovs_assert(!c
->output
.string
);
791 ovs_assert(!c
->table
);
797 do_sbctl(const char *args
, struct ctl_command
*commands
, size_t n_commands
,
798 struct ovsdb_idl
*idl
)
800 struct ovsdb_idl_txn
*txn
;
801 enum ovsdb_idl_txn_status status
;
802 struct ovsdb_symbol_table
*symtab
;
803 struct sbctl_context sbctl_ctx
;
804 struct ctl_command
*c
;
805 struct shash_node
*node
;
808 txn
= the_idl_txn
= ovsdb_idl_txn_create(idl
);
810 ovsdb_idl_txn_set_dry_run(txn
);
813 ovsdb_idl_txn_add_comment(txn
, "ovs-sbctl: %s", args
);
815 symtab
= ovsdb_symbol_table_create();
816 for (c
= commands
; c
< &commands
[n_commands
]; c
++) {
820 sbctl_context_init(&sbctl_ctx
, NULL
, idl
, txn
, symtab
);
821 for (c
= commands
; c
< &commands
[n_commands
]; c
++) {
822 sbctl_context_init_command(&sbctl_ctx
, c
);
823 if (c
->syntax
->run
) {
824 (c
->syntax
->run
)(&sbctl_ctx
.base
);
826 sbctl_context_done_command(&sbctl_ctx
, c
);
828 if (sbctl_ctx
.base
.try_again
) {
829 sbctl_context_done(&sbctl_ctx
, NULL
);
833 sbctl_context_done(&sbctl_ctx
, NULL
);
835 SHASH_FOR_EACH (node
, &symtab
->sh
) {
836 struct ovsdb_symbol
*symbol
= node
->data
;
837 if (!symbol
->created
) {
838 ctl_fatal("row id \"%s\" is referenced but never created (e.g. "
839 "with \"-- --id=%s create ...\")",
840 node
->name
, node
->name
);
842 if (!symbol
->strong_ref
) {
843 if (!symbol
->weak_ref
) {
844 VLOG_WARN("row id \"%s\" was created but no reference to it "
845 "was inserted, so it will not actually appear in "
846 "the database", node
->name
);
848 VLOG_WARN("row id \"%s\" was created but only a weak "
849 "reference to it was inserted, so it will not "
850 "actually appear in the database", node
->name
);
855 status
= ovsdb_idl_txn_commit_block(txn
);
856 if (status
== TXN_UNCHANGED
|| status
== TXN_SUCCESS
) {
857 for (c
= commands
; c
< &commands
[n_commands
]; c
++) {
858 if (c
->syntax
->postprocess
) {
859 sbctl_context_init(&sbctl_ctx
, c
, idl
, txn
, symtab
);
860 (c
->syntax
->postprocess
)(&sbctl_ctx
.base
);
861 sbctl_context_done(&sbctl_ctx
, c
);
865 error
= xstrdup(ovsdb_idl_txn_get_error(txn
));
868 case TXN_UNCOMMITTED
:
873 /* Should not happen--we never call ovsdb_idl_txn_abort(). */
874 ctl_fatal("transaction aborted");
884 ctl_fatal("transaction error: %s", error
);
887 /* Should not happen--we never call ovsdb_idl_set_lock(). */
888 ctl_fatal("database not locked");
895 ovsdb_symbol_table_destroy(symtab
);
897 for (c
= commands
; c
< &commands
[n_commands
]; c
++) {
898 struct ds
*ds
= &c
->output
;
901 table_print(c
->table
, &table_style
);
902 } else if (oneline
) {
906 for (j
= 0; j
< ds
->length
; j
++) {
907 int ch
= ds
->string
[j
];
910 fputs("\\n", stdout
);
914 fputs("\\\\", stdout
);
923 fputs(ds_cstr(ds
), stdout
);
925 ds_destroy(&c
->output
);
926 table_destroy(c
->table
);
929 shash_destroy_free_data(&c
->options
);
932 ovsdb_idl_txn_destroy(txn
);
933 ovsdb_idl_destroy(idl
);
938 /* Our transaction needs to be rerun, or a prerequisite was not met. Free
939 * resources and return so that the caller can try again. */
941 ovsdb_idl_txn_abort(txn
);
942 ovsdb_idl_txn_destroy(txn
);
945 ovsdb_symbol_table_destroy(symtab
);
946 for (c
= commands
; c
< &commands
[n_commands
]; c
++) {
947 ds_destroy(&c
->output
);
948 table_destroy(c
->table
);
954 /* Frees the current transaction and the underlying IDL and then calls
957 * Freeing the transaction and the IDL is not strictly necessary, but it makes
958 * for a clean memory leak report from valgrind in the normal case. That makes
959 * it easier to notice real memory leaks. */
961 sbctl_exit(int status
)
964 ovsdb_idl_txn_abort(the_idl_txn
);
965 ovsdb_idl_txn_destroy(the_idl_txn
);
967 ovsdb_idl_destroy(the_idl
);
971 static const struct ctl_command_syntax sbctl_commands
[] = {
972 /* Chassis commands. */
973 {"chassis-add", 3, 3, "CHASSIS ENCAP-TYPE ENCAP-IP", pre_get_info
,
974 cmd_chassis_add
, NULL
, "--may-exist", RW
},
975 {"chassis-del", 1, 1, "CHASSIS", pre_get_info
, cmd_chassis_del
, NULL
,
978 /* Port binding commands. */
979 {"lport-bind", 2, 2, "LPORT CHASSIS", pre_get_info
, cmd_lport_bind
, NULL
,
981 {"lport-unbind", 1, 1, "LPORT", pre_get_info
, cmd_lport_unbind
, NULL
,
984 /* Logical flow commands */
985 {"lflow-list", 0, 1, "[DATAPATH]", pre_get_info
, cmd_lflow_list
, NULL
,
987 {"dump-flows", 0, 1, "[DATAPATH]", pre_get_info
, cmd_lflow_list
, NULL
,
988 "", RO
}, /* Friendly alias for lflow-list */
990 /* SSL commands (To Be Added). */
992 {NULL
, 0, 0, NULL
, NULL
, NULL
, NULL
, NULL
, RO
},
995 /* Registers sbctl and common db commands. */
999 ctl_init(tables
, cmd_show_tables
, sbctl_exit
);
1000 ctl_register_commands(sbctl_commands
);