2 * Copyright (c) 2015, 2016, 2017 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.
23 #include "db-ctl-base.h"
25 #include "command-line.h"
28 #include "openvswitch/dynamic-string.h"
29 #include "fatal-signal.h"
31 #include "openvswitch/json.h"
32 #include "openvswitch/vlog.h"
33 #include "ovsdb-data.h"
34 #include "ovsdb-idl.h"
35 #include "ovsdb-idl-provider.h"
36 #include "openvswitch/shash.h"
43 VLOG_DEFINE_THIS_MODULE(db_ctl_base
);
45 /* This array defines the 'show' command output format. User can check the
46 * definition in utilities/ovs-vsctl.c as reference.
48 * Particularly, if an element in 'columns[]' represents a reference to
49 * another table, the referred table must also be defined as an entry in
50 * in 'cmd_show_tables[]'.
52 * The definition must end with an all-NULL entry. It is initalized once
53 * when ctl_init() is called.
56 static const struct cmd_show_table
*cmd_show_tables
;
58 /* ctl_exit() is called by ctl_fatal(). User can optionally supply an exit
59 * function ctl_exit_func() via ctl_init. If supplied, this function will
60 * be called by ctl_exit()
62 static void (*ctl_exit_func
)(int status
) = NULL
;
63 OVS_NO_RETURN
static void ctl_exit(int status
);
66 static const struct ovsdb_idl_class
*idl_class
;
68 /* Two arrays with 'n_classes' elements, which represent the tables in this
69 * database and how the user can refer to their rows. */
70 static const struct ctl_table_class
*ctl_classes
;
71 static const struct ovsdb_idl_table_class
*idl_classes
;
72 static size_t n_classes
;
74 static struct shash all_commands
= SHASH_INITIALIZER(&all_commands
);
75 static char *get_table(const char *, const struct ovsdb_idl_table_class
**);
76 static char *set_column(const struct ovsdb_idl_table_class
*,
77 const struct ovsdb_idl_row
*, const char *,
78 struct ovsdb_symbol_table
*);
81 static struct option
*
82 find_option(const char *name
, struct option
*options
, size_t n_options
)
86 for (i
= 0; i
< n_options
; i
++) {
87 if (!strcmp(options
[i
].name
, name
)) {
94 static struct option
*
95 add_option(struct option
**optionsp
, size_t *n_optionsp
,
96 size_t *allocated_optionsp
)
98 if (*n_optionsp
>= *allocated_optionsp
) {
99 *optionsp
= x2nrealloc(*optionsp
, allocated_optionsp
,
102 return &(*optionsp
)[(*n_optionsp
)++];
105 /* Converts the command arguments into format that can be parsed by
106 * bash completion script.
108 * Therein, arguments will be attached with following prefixes:
110 * !argument :: The argument is required
111 * ?argument :: The argument is optional
112 * *argument :: The argument may appear any number (0 or more) times
113 * +argument :: The argument may appear one or more times
117 print_command_arguments(const struct ctl_command_syntax
*command
)
120 * The argument string is parsed in reverse. We use a stack 'oew_stack' to
121 * keep track of nested optionals. Whenever a ']' is encountered, we push
122 * a bit to 'oew_stack'. The bit is set to 1 if the ']' is not nested.
123 * Subsequently, we pop an entry everytime '[' is met.
125 * We use 'whole_word_is_optional' value to decide whether or not a ! or +
126 * should be added on encountering a space: if the optional surrounds the
127 * whole word then it shouldn't be, but if it is only a part of the word
128 * (i.e. [key=]value), it should be.
130 uint32_t oew_stack
= 0;
132 const char *arguments
= command
->arguments
;
133 int length
= strlen(arguments
);
138 /* Output buffer, written backward from end. */
139 char *output
= xmalloc(2 * length
);
140 char *outp
= output
+ 2 * length
;
143 bool in_repeated
= false;
144 bool whole_word_is_optional
= false;
146 for (const char *inp
= arguments
+ length
; inp
> arguments
; ) {
150 if (inp
[1] == '\0' || inp
[1] == ' ' || inp
[1] == '.') {
155 /* Checks if the whole word is optional, and sets the
156 * 'whole_word_is_optional' accordingly. */
157 if ((inp
== arguments
|| inp
[-1] == ' ') && oew_stack
& 1) {
158 *--outp
= in_repeated
? '*' : '?';
159 whole_word_is_optional
= true;
162 whole_word_is_optional
= false;
167 if (!whole_word_is_optional
) {
168 *--outp
= in_repeated
? '+' : '!';
172 whole_word_is_optional
= false;
182 if (arguments
[0] != '[' && outp
!= output
+ 2 * length
- 1) {
183 *--outp
= in_repeated
? '+' : '!';
190 to_lower_and_underscores(unsigned c
)
192 return c
== '-' ? '_' : tolower(c
);
195 /* Returns a score representing how well 's' matches 'name'. Higher return
196 * values indicate a better match. The order of the arguments is important:
197 * 'name' is the name of an entity such as a table or a column, and 's' is user
200 score_partial_match(const char *name
, const char *s
)
204 if (!strcmp(name
, s
)) {
207 for (score
= 0; ; score
++, name
++, s
++) {
208 if (to_lower_and_underscores(*name
) != to_lower_and_underscores(*s
)) {
210 } else if (*name
== '\0') {
214 return *s
== '\0' ? score
: 0;
217 /* Returns NULL and sets 'symbolp' and 'newp' if symbol was created
218 * successfully. Otherwise returns a malloc()'ed error message on failure. */
219 static char * OVS_WARN_UNUSED_RESULT
220 create_symbol(struct ovsdb_symbol_table
*symtab
, const char *id
,
221 struct ovsdb_symbol
**symbolp
, bool *newp
)
223 struct ovsdb_symbol
*symbol
;
228 return xasprintf("row id \"%s\" does not begin with \"@\"", id
);
232 *newp
= ovsdb_symbol_table_get(symtab
, id
) == NULL
;
235 symbol
= ovsdb_symbol_table_insert(symtab
, id
);
236 if (symbol
->created
) {
237 return xasprintf("row id \"%s\" may only be specified on one --id "
240 symbol
->created
= true;
246 record_id_equals(const union ovsdb_atom
*name
, enum ovsdb_atomic_type type
,
247 const char *record_id
)
249 if (type
== OVSDB_TYPE_STRING
) {
250 if (!strcmp(name
->string
, record_id
)) {
255 size_t len
= strlen(record_id
);
257 && uuid_from_string(&uuid
, name
->string
)
258 && !strncmp(name
->string
, record_id
, len
)) {
264 ovs_assert(type
== OVSDB_TYPE_INTEGER
);
265 return name
->integer
== strtoll(record_id
, NULL
, 10);
269 static const struct ovsdb_idl_row
*
270 get_row_by_id(struct ctl_context
*ctx
,
271 const struct ovsdb_idl_table_class
*table
,
272 const struct ctl_row_id
*id
, const char *record_id
,
273 bool *multiple_matches
)
275 ovs_assert(multiple_matches
);
276 *multiple_matches
= false;
278 if (!id
->name_column
) {
282 const struct ovsdb_idl_row
*referrer
= NULL
;
284 /* Figure out the 'key' and 'value' types for the column that we're going
285 * to look at. One of these ('name_type') is the type of the name we're
286 * going to compare against 'record_id'. */
287 enum ovsdb_atomic_type key
, value
, name_type
;
289 name_type
= key
= id
->name_column
->type
.key
.type
;
290 value
= OVSDB_TYPE_VOID
;
292 key
= OVSDB_TYPE_STRING
;
293 name_type
= value
= id
->name_column
->type
.value
.type
;
296 /* We only support integer and string names (so far). */
297 if (name_type
== OVSDB_TYPE_INTEGER
) {
298 if (!record_id
[0] || record_id
[strspn(record_id
, "0123456789")]) {
302 ovs_assert(name_type
== OVSDB_TYPE_STRING
);
305 const struct ovsdb_idl_class
*class = ovsdb_idl_get_class(ctx
->idl
);
306 const struct ovsdb_idl_table_class
*id_table
307 = ovsdb_idl_table_class_from_column(class, id
->name_column
);
308 for (const struct ovsdb_idl_row
*row
= ovsdb_idl_first_row(ctx
->idl
,
311 row
= ovsdb_idl_next_row(row
)) {
312 /* Pick out the name column's data. */
313 const struct ovsdb_datum
*datum
= ovsdb_idl_get(
314 row
, id
->name_column
, key
, value
);
316 /* Extract the name from the column. */
317 const union ovsdb_atom
*name
;
319 name
= datum
->n
== 1 ? &datum
->keys
[0] : NULL
;
321 const union ovsdb_atom key_atom
322 = { .string
= CONST_CAST(char *, id
->key
) };
323 unsigned int i
= ovsdb_datum_find_key(datum
, &key_atom
,
325 name
= i
== UINT_MAX
? NULL
: &datum
->values
[i
];
331 /* If the name equals 'record_id', take it. */
332 if (record_id_equals(name
, name_type
, record_id
)) {
334 *multiple_matches
= true;
344 const struct ovsdb_idl_row
*final
= referrer
;
345 if (id
->uuid_column
) {
346 const struct ovsdb_datum
*uuid
;
348 ovsdb_idl_txn_verify(referrer
, id
->uuid_column
);
349 uuid
= ovsdb_idl_get(referrer
, id
->uuid_column
,
350 OVSDB_TYPE_UUID
, OVSDB_TYPE_VOID
);
352 final
= ovsdb_idl_get_row_for_uuid(ctx
->idl
, table
,
353 &uuid
->keys
[0].uuid
);
361 char * OVS_WARN_UNUSED_RESULT
362 ctl_get_row(struct ctl_context
*ctx
,
363 const struct ovsdb_idl_table_class
*table
, const char *record_id
,
364 bool must_exist
, const struct ovsdb_idl_row
**rowp
)
366 const struct ovsdb_idl_row
*row
= NULL
;
371 if (uuid_from_string(&uuid
, record_id
)) {
372 row
= ovsdb_idl_get_row_for_uuid(ctx
->idl
, table
, &uuid
);
375 if (!strcmp(record_id
, ".")) {
376 row
= ovsdb_idl_first_row(ctx
->idl
, table
);
377 if (row
&& ovsdb_idl_next_row(row
)) {
383 const struct ctl_table_class
*ctl_class
384 = &ctl_classes
[table
- idl_classes
];
385 for (int i
= 0; i
< ARRAY_SIZE(ctl_class
->row_ids
); i
++) {
386 const struct ctl_row_id
*id
= &ctl_class
->row_ids
[i
];
387 bool multiple_matches
;
389 row
= get_row_by_id(ctx
, table
, id
, record_id
, &multiple_matches
);
390 if (multiple_matches
) {
391 const struct ovsdb_idl_class
*class =
392 ovsdb_idl_get_class(ctx
->idl
);
393 const struct ovsdb_idl_table_class
*table_class
=
394 ovsdb_idl_table_class_from_column(class, id
->name_column
);
395 return xasprintf("multiple rows in %s match \"%s\"",
396 table_class
->name
, record_id
);
403 if (!row
&& uuid_is_partial_string(record_id
) >= 4) {
404 for (const struct ovsdb_idl_row
*r
= ovsdb_idl_first_row(ctx
->idl
,
407 r
= ovsdb_idl_next_row(r
)) {
408 if (uuid_is_partial_match(&r
->uuid
, record_id
)) {
412 return xasprintf("%s contains 2 or more rows whose UUIDs "
413 "begin with %s: at least "UUID_FMT
" "
414 "and "UUID_FMT
, table
->name
, record_id
,
415 UUID_ARGS(&row
->uuid
),
416 UUID_ARGS(&r
->uuid
));
421 if (must_exist
&& !row
) {
422 return xasprintf("no row \"%s\" in table %s", record_id
, table
->name
);
430 get_column(const struct ovsdb_idl_table_class
*table
, const char *column_name
,
431 const struct ovsdb_idl_column
**columnp
)
433 const struct ovsdb_idl_column
*best_match
= NULL
;
434 unsigned int best_score
= 0;
437 for (i
= 0; i
< table
->n_columns
; i
++) {
438 const struct ovsdb_idl_column
*column
= &table
->columns
[i
];
439 unsigned int score
= score_partial_match(column
->name
, column_name
);
440 if (score
> best_score
) {
443 } else if (score
== best_score
) {
448 *columnp
= best_match
;
451 } else if (best_score
) {
452 return xasprintf("%s contains more than one column whose name "
453 "matches \"%s\"", table
->name
, column_name
);
455 return xasprintf("%s does not contain a column whose name matches "
456 "\"%s\"", table
->name
, column_name
);
460 static char * OVS_WARN_UNUSED_RESULT
461 pre_get_column(struct ctl_context
*ctx
,
462 const struct ovsdb_idl_table_class
*table
,
463 const char *column_name
,
464 const struct ovsdb_idl_column
**columnp
)
466 char *error
= get_column(table
, column_name
, columnp
);
470 ovsdb_idl_add_column(ctx
->idl
, *columnp
);
474 static char * OVS_WARN_UNUSED_RESULT
475 pre_get_table(struct ctl_context
*ctx
, const char *table_name
,
476 const struct ovsdb_idl_table_class
**tablep
)
478 const struct ovsdb_idl_table_class
*table
;
479 char *error
= get_table(table_name
, &table
);
483 ovsdb_idl_add_table(ctx
->idl
, table
);
485 const struct ctl_table_class
*ctl
= &ctl_classes
[table
- idl_classes
];
486 for (int i
= 0; i
< ARRAY_SIZE(ctl
->row_ids
); i
++) {
487 const struct ctl_row_id
*id
= &ctl
->row_ids
[i
];
488 if (id
->name_column
) {
489 ovsdb_idl_add_column(ctx
->idl
, id
->name_column
);
491 if (id
->uuid_column
) {
492 ovsdb_idl_add_column(ctx
->idl
, id
->uuid_column
);
503 missing_operator_error(const char *arg
, const char **allowed_operators
,
509 ds_put_format(&s
, "%s: argument does not end in ", arg
);
510 ds_put_format(&s
, "\"%s\"", allowed_operators
[0]);
511 if (n_allowed
== 2) {
512 ds_put_format(&s
, " or \"%s\"", allowed_operators
[1]);
513 } else if (n_allowed
> 2) {
516 for (i
= 1; i
< n_allowed
- 1; i
++) {
517 ds_put_format(&s
, ", \"%s\"", allowed_operators
[i
]);
519 ds_put_format(&s
, ", or \"%s\"", allowed_operators
[i
]);
521 ds_put_format(&s
, " followed by a value.");
523 return ds_steal_cstr(&s
);
526 /* Breaks 'arg' apart into a number of fields in the following order:
528 * - The name of a column in 'table', stored into '*columnp'. The column
529 * name may be abbreviated.
531 * - Optionally ':' followed by a key string. The key is stored as a
532 * malloc()'d string into '*keyp', or NULL if no key is present in
535 * - If 'valuep' is nonnull, an operator followed by a value string. The
536 * allowed operators are the 'n_allowed' string in 'allowed_operators',
537 * or just "=" if 'n_allowed' is 0. If 'operatorp' is nonnull, then the
538 * index of the operator within 'allowed_operators' is stored into
539 * '*operatorp'. The value is stored as a malloc()'d string into
540 * '*valuep', or NULL if no value is present in 'arg'.
542 * On success, returns NULL. On failure, returned a malloc()'d string error
543 * message and stores NULL into all of the nonnull output arguments. */
544 static char * OVS_WARN_UNUSED_RESULT
545 parse_column_key_value(const char *arg
,
546 const struct ovsdb_idl_table_class
*table
,
547 const struct ovsdb_idl_column
**columnp
, char **keyp
,
549 const char **allowed_operators
, size_t n_allowed
,
556 ovs_assert(!(operatorp
&& !valuep
));
562 /* Parse column name. */
563 error
= ovsdb_token_parse(&p
, &column_name
);
567 if (column_name
[0] == '\0') {
569 error
= xasprintf("%s: missing column name", arg
);
572 error
= get_column(table
, column_name
, columnp
);
578 /* Parse key string. */
581 error
= ovsdb_token_parse(&p
, keyp
);
587 /* Parse value string. */
593 if (!allowed_operators
) {
594 static const char *equals
= "=";
595 allowed_operators
= &equals
;
601 for (i
= 0; i
< n_allowed
; i
++) {
602 const char *op
= allowed_operators
[i
];
603 size_t op_len
= strlen(op
);
605 if (op_len
> best_len
&& !strncmp(op
, p
, op_len
) && p
[op_len
]) {
611 error
= missing_operator_error(arg
, allowed_operators
, n_allowed
);
618 *valuep
= xstrdup(p
+ best_len
);
621 error
= xasprintf("%s: trailing garbage \"%s\" in argument",
642 static char * OVS_WARN_UNUSED_RESULT
643 pre_parse_column_key_value(struct ctl_context
*ctx
, const char *arg
,
644 const struct ovsdb_idl_table_class
*table
)
646 const struct ovsdb_idl_column
*column
;
648 char *column_name
= NULL
;
652 error
= ovsdb_token_parse(&p
, &column_name
);
656 if (column_name
[0] == '\0') {
657 error
= xasprintf("%s: missing column name", arg
);
661 error
= pre_get_column(ctx
, table
, column_name
, &column
);
668 /* Checks if the 'column' is mutable. Returns NULL if it is mutable, or a
669 * malloc()'ed error message otherwise. */
670 static char * OVS_WARN_UNUSED_RESULT
671 check_mutable(const struct ovsdb_idl_row
*row
,
672 const struct ovsdb_idl_column
*column
)
674 if (!ovsdb_idl_is_mutable(row
, column
)) {
675 return xasprintf("cannot modify read-only column %s in table %s",
676 column
->name
, row
->table
->class_
->name
);
682 RELOP(RELOP_EQ, "=") \
683 RELOP(RELOP_NE, "!=") \
684 RELOP(RELOP_LT, "<") \
685 RELOP(RELOP_GT, ">") \
686 RELOP(RELOP_LE, "<=") \
687 RELOP(RELOP_GE, ">=") \
688 RELOP(RELOP_SET_EQ, "{=}") \
689 RELOP(RELOP_SET_NE, "{!=}") \
690 RELOP(RELOP_SET_LT, "{<}") \
691 RELOP(RELOP_SET_GT, "{>}") \
692 RELOP(RELOP_SET_LE, "{<=}") \
693 RELOP(RELOP_SET_GE, "{>=}")
696 #define RELOP(ENUM, STRING) ENUM,
702 is_set_operator(enum relop op
)
704 return (op
== RELOP_SET_EQ
|| op
== RELOP_SET_NE
||
705 op
== RELOP_SET_LT
|| op
== RELOP_SET_GT
||
706 op
== RELOP_SET_LE
|| op
== RELOP_SET_GE
);
710 evaluate_relop(const struct ovsdb_datum
*a
, const struct ovsdb_datum
*b
,
711 const struct ovsdb_type
*type
, enum relop op
)
716 return ovsdb_datum_compare_3way(a
, b
, type
) == 0;
719 return ovsdb_datum_compare_3way(a
, b
, type
) != 0;
721 return ovsdb_datum_compare_3way(a
, b
, type
) < 0;
723 return ovsdb_datum_compare_3way(a
, b
, type
) > 0;
725 return ovsdb_datum_compare_3way(a
, b
, type
) <= 0;
727 return ovsdb_datum_compare_3way(a
, b
, type
) >= 0;
730 return b
->n
> a
->n
&& ovsdb_datum_includes_all(a
, b
, type
);
732 return a
->n
> b
->n
&& ovsdb_datum_includes_all(b
, a
, type
);
734 return ovsdb_datum_includes_all(a
, b
, type
);
736 return ovsdb_datum_includes_all(b
, a
, type
);
743 /* Checks if given row satisfies the specified condition. Returns the result of
744 * evaluating the condition in 'satisfied' flag and NULL as a return value on
745 * success. On failure returns a malloc()'ed error message and 'satisfied'
746 * value is not modified. */
747 static char * OVS_WARN_UNUSED_RESULT
748 check_condition(const struct ovsdb_idl_table_class
*table
,
749 const struct ovsdb_idl_row
*row
, const char *arg
,
750 struct ovsdb_symbol_table
*symtab
, bool *satisfied
)
752 static const char *operators
[] = {
753 #define RELOP(ENUM, STRING) STRING,
758 const struct ovsdb_idl_column
*column
;
759 const struct ovsdb_datum
*have_datum
;
760 char *key_string
= NULL
;
761 char *value_string
= NULL
;
762 struct ovsdb_type type
;
767 ovs_assert(satisfied
);
769 error
= parse_column_key_value(arg
, table
, &column
, &key_string
,
770 &operator, operators
, ARRAY_SIZE(operators
),
776 error
= xasprintf("%s: missing value", arg
);
781 type
.n_max
= UINT_MAX
;
783 have_datum
= ovsdb_idl_read(row
, column
);
785 union ovsdb_atom want_key
;
786 struct ovsdb_datum b
;
789 if (column
->type
.value
.type
== OVSDB_TYPE_VOID
) {
790 error
= xasprintf("cannot specify key to check for non-map column "
795 error
= ovsdb_atom_from_string(&want_key
, NULL
, &column
->type
.key
,
801 type
.key
= type
.value
;
802 type
.value
.type
= OVSDB_TYPE_VOID
;
803 error
= ovsdb_datum_from_string(&b
, &type
, value_string
, symtab
);
808 idx
= ovsdb_datum_find_key(have_datum
,
809 &want_key
, column
->type
.key
.type
);
810 if (idx
== UINT_MAX
&& !is_set_operator(operator)) {
813 struct ovsdb_datum a
;
815 if (idx
!= UINT_MAX
) {
817 a
.keys
= &have_datum
->values
[idx
];
825 retval
= evaluate_relop(&a
, &b
, &type
, operator);
828 ovsdb_atom_destroy(&want_key
, column
->type
.key
.type
);
829 ovsdb_datum_destroy(&b
, &type
);
831 struct ovsdb_datum want_datum
;
833 error
= ovsdb_datum_from_string(&want_datum
, &column
->type
,
834 value_string
, symtab
);
838 retval
= evaluate_relop(have_datum
, &want_datum
, &type
, operator);
839 ovsdb_datum_destroy(&want_datum
, &column
->type
);
851 invalidate_cache(struct ctl_context
*ctx
)
853 if (ctx
->invalidate_cache_cb
) {
854 (ctx
->invalidate_cache_cb
)(ctx
);
859 pre_cmd_get(struct ctl_context
*ctx
)
861 const char *id
= shash_find_data(&ctx
->options
, "--id");
862 const char *table_name
= ctx
->argv
[1];
863 const struct ovsdb_idl_table_class
*table
;
866 /* Using "get" without --id or a column name could possibly make sense.
867 * Maybe, for example, a *ctl command run wants to assert that a row
868 * exists. But it is unlikely that an interactive user would want to do
869 * that, so issue a warning if we're running on a terminal. */
870 if (!id
&& ctx
->argc
<= 3 && isatty(STDOUT_FILENO
)) {
871 VLOG_WARN("\"get\" command without row arguments or \"--id\" is "
872 "possibly erroneous");
875 ctx
->error
= pre_get_table(ctx
, table_name
, &table
);
879 for (i
= 3; i
< ctx
->argc
; i
++) {
880 if (!strcasecmp(ctx
->argv
[i
], "_uuid")
881 || !strcasecmp(ctx
->argv
[i
], "-uuid")) {
885 ctx
->error
= pre_parse_column_key_value(ctx
, ctx
->argv
[i
], table
);
893 cmd_get(struct ctl_context
*ctx
)
895 const char *id
= shash_find_data(&ctx
->options
, "--id");
896 bool must_exist
= !shash_find(&ctx
->options
, "--if-exists");
897 const char *table_name
= ctx
->argv
[1];
898 const char *record_id
= ctx
->argv
[2];
899 const struct ovsdb_idl_table_class
*table
;
900 const struct ovsdb_idl_row
*row
;
901 struct ds
*out
= &ctx
->output
;
904 if (id
&& !must_exist
) {
905 ctl_error(ctx
, "--if-exists and --id may not be specified together");
909 ctx
->error
= get_table(table_name
, &table
);
913 ctx
->error
= ctl_get_row(ctx
, table
, record_id
, must_exist
, &row
);
922 struct ovsdb_symbol
*symbol
;
925 ctx
->error
= create_symbol(ctx
->symtab
, id
, &symbol
, &new);
930 ctl_error(ctx
, "row id \"%s\" specified on \"get\" command was "
931 "used before it was defined", id
);
934 symbol
->uuid
= row
->uuid
;
936 /* This symbol refers to a row that already exists, so disable warnings
937 * about it being unreferenced. */
938 symbol
->strong_ref
= true;
940 for (i
= 3; i
< ctx
->argc
; i
++) {
941 const struct ovsdb_idl_column
*column
;
942 const struct ovsdb_datum
*datum
;
945 /* Special case for obtaining the UUID of a row. We can't just do this
946 * through parse_column_key_value() below since it returns a "struct
947 * ovsdb_idl_column" and the UUID column doesn't have one. */
948 if (!strcasecmp(ctx
->argv
[i
], "_uuid")
949 || !strcasecmp(ctx
->argv
[i
], "-uuid")) {
950 ds_put_format(out
, UUID_FMT
"\n", UUID_ARGS(&row
->uuid
));
954 ctx
->error
= parse_column_key_value(ctx
->argv
[i
], table
, &column
,
955 &key_string
, NULL
, NULL
, 0, NULL
);
960 ovsdb_idl_txn_verify(row
, column
);
961 datum
= ovsdb_idl_read(row
, column
);
963 union ovsdb_atom key
;
966 if (column
->type
.value
.type
== OVSDB_TYPE_VOID
) {
968 "cannot specify key to get for non-map column %s",
974 ctx
->error
= ovsdb_atom_from_string(&key
, NULL
, &column
->type
.key
,
975 key_string
, ctx
->symtab
);
981 idx
= ovsdb_datum_find_key(datum
, &key
,
982 column
->type
.key
.type
);
983 if (idx
== UINT_MAX
) {
986 ctx
, "no key \"%s\" in %s record \"%s\" column %s",
987 key_string
, table
->name
, record_id
, column
->name
);
992 ovsdb_atom_to_string(&datum
->values
[idx
],
993 column
->type
.value
.type
, out
);
995 ovsdb_atom_destroy(&key
, column
->type
.key
.type
);
997 ovsdb_datum_to_string(datum
, &column
->type
, out
);
999 ds_put_char(out
, '\n');
1005 /* Returns NULL on success or malloc()'ed error message on failure. */
1006 static char * OVS_WARN_UNUSED_RESULT
1007 parse_column_names(const char *column_names
,
1008 const struct ovsdb_idl_table_class
*table
,
1009 const struct ovsdb_idl_column
***columnsp
,
1012 const struct ovsdb_idl_column
**columns
;
1015 if (!column_names
) {
1018 n_columns
= table
->n_columns
+ 1;
1019 columns
= xmalloc(n_columns
* sizeof *columns
);
1021 for (i
= 0; i
< table
->n_columns
; i
++) {
1022 columns
[i
+ 1] = &table
->columns
[i
];
1025 char *s
= xstrdup(column_names
);
1026 size_t allocated_columns
;
1027 char *save_ptr
= NULL
;
1031 allocated_columns
= n_columns
= 0;
1032 for (column_name
= strtok_r(s
, ", ", &save_ptr
); column_name
;
1033 column_name
= strtok_r(NULL
, ", ", &save_ptr
)) {
1034 const struct ovsdb_idl_column
*column
;
1036 if (!strcasecmp(column_name
, "_uuid")) {
1039 char *error
= get_column(table
, column_name
, &column
);
1046 if (n_columns
>= allocated_columns
) {
1047 columns
= x2nrealloc(columns
, &allocated_columns
,
1050 columns
[n_columns
++] = column
;
1055 return xstrdup("must specify at least one column name");
1058 *columnsp
= columns
;
1059 *n_columnsp
= n_columns
;
1063 static char * OVS_WARN_UNUSED_RESULT
1064 pre_list_columns(struct ctl_context
*ctx
,
1065 const struct ovsdb_idl_table_class
*table
,
1066 const char *column_names
)
1068 const struct ovsdb_idl_column
**columns
;
1073 error
= parse_column_names(column_names
, table
, &columns
, &n_columns
);
1077 for (i
= 0; i
< n_columns
; i
++) {
1079 ovsdb_idl_add_column(ctx
->idl
, columns
[i
]);
1087 pre_cmd_list(struct ctl_context
*ctx
)
1089 const char *column_names
= shash_find_data(&ctx
->options
, "--columns");
1090 const char *table_name
= ctx
->argv
[1];
1091 const struct ovsdb_idl_table_class
*table
;
1093 ctx
->error
= pre_get_table(ctx
, table_name
, &table
);
1097 ctx
->error
= pre_list_columns(ctx
, table
, column_names
);
1103 static struct table
*
1104 list_make_table(const struct ovsdb_idl_column
**columns
, size_t n_columns
)
1109 out
= xmalloc(sizeof *out
);
1112 for (i
= 0; i
< n_columns
; i
++) {
1113 const struct ovsdb_idl_column
*column
= columns
[i
];
1114 const char *column_name
= column
? column
->name
: "_uuid";
1116 table_add_column(out
, "%s", column_name
);
1123 list_record(const struct ovsdb_idl_row
*row
,
1124 const struct ovsdb_idl_column
**columns
, size_t n_columns
,
1134 for (i
= 0; i
< n_columns
; i
++) {
1135 const struct ovsdb_idl_column
*column
= columns
[i
];
1136 struct cell
*cell
= table_add_cell(out
);
1139 struct ovsdb_datum datum
;
1140 union ovsdb_atom atom
;
1142 atom
.uuid
= row
->uuid
;
1145 datum
.values
= NULL
;
1148 cell
->json
= ovsdb_datum_to_json(&datum
, &ovsdb_type_uuid
);
1149 cell
->type
= &ovsdb_type_uuid
;
1151 const struct ovsdb_datum
*datum
= ovsdb_idl_read(row
, column
);
1153 cell
->json
= ovsdb_datum_to_json(datum
, &column
->type
);
1154 cell
->type
= &column
->type
;
1160 cmd_list(struct ctl_context
*ctx
)
1162 const char *column_names
= shash_find_data(&ctx
->options
, "--columns");
1163 bool must_exist
= !shash_find(&ctx
->options
, "--if-exists");
1164 const struct ovsdb_idl_column
**columns
;
1165 const char *table_name
= ctx
->argv
[1];
1166 const struct ovsdb_idl_table_class
*table
;
1171 ctx
->error
= get_table(table_name
, &table
);
1175 ctx
->error
= parse_column_names(column_names
, table
, &columns
, &n_columns
);
1179 out
= ctx
->table
= list_make_table(columns
, n_columns
);
1180 if (ctx
->argc
> 2) {
1181 for (i
= 2; i
< ctx
->argc
; i
++) {
1182 const struct ovsdb_idl_row
*row
;
1184 ctx
->error
= ctl_get_row(ctx
, table
, ctx
->argv
[i
], must_exist
,
1190 list_record(row
, columns
, n_columns
, out
);
1193 const struct ovsdb_idl_row
*row
;
1195 for (row
= ovsdb_idl_first_row(ctx
->idl
, table
); row
!= NULL
;
1196 row
= ovsdb_idl_next_row(row
)) {
1197 list_record(row
, columns
, n_columns
, out
);
1203 /* Finds the "struct ovsdb_idl_table_class *" with 'table_name' by searching
1204 * the tables in these schema. Returns NULL and sets 'tablep' on success, or a
1205 * malloc()'ed error message on failure. */
1206 static char * OVS_WARN_UNUSED_RESULT
1207 get_table(const char *table_name
, const struct ovsdb_idl_table_class
**tablep
)
1209 const struct ovsdb_idl_table_class
*best_match
= NULL
;
1210 unsigned int best_score
= 0;
1213 for (const struct ovsdb_idl_table_class
*table
= idl_classes
;
1214 table
< &idl_classes
[n_classes
]; table
++) {
1215 unsigned int score
= score_partial_match(table
->name
, table_name
);
1216 if (score
> best_score
) {
1219 } else if (score
== best_score
) {
1224 *tablep
= best_match
;
1225 } else if (best_score
) {
1226 error
= xasprintf("multiple table names match \"%s\"", table_name
);
1228 error
= xasprintf("unknown table \"%s\"", table_name
);
1234 pre_cmd_find(struct ctl_context
*ctx
)
1236 const char *column_names
= shash_find_data(&ctx
->options
, "--columns");
1237 const char *table_name
= ctx
->argv
[1];
1238 const struct ovsdb_idl_table_class
*table
;
1241 ctx
->error
= pre_get_table(ctx
, table_name
, &table
);
1245 ctx
->error
= pre_list_columns(ctx
, table
, column_names
);
1249 for (i
= 2; i
< ctx
->argc
; i
++) {
1250 ctx
->error
= pre_parse_column_key_value(ctx
, ctx
->argv
[i
], table
);
1258 cmd_find(struct ctl_context
*ctx
)
1260 const char *column_names
= shash_find_data(&ctx
->options
, "--columns");
1261 const struct ovsdb_idl_column
**columns
;
1262 const char *table_name
= ctx
->argv
[1];
1263 const struct ovsdb_idl_table_class
*table
;
1264 const struct ovsdb_idl_row
*row
;
1268 ctx
->error
= get_table(table_name
, &table
);
1272 ctx
->error
= parse_column_names(column_names
, table
, &columns
, &n_columns
);
1276 out
= ctx
->table
= list_make_table(columns
, n_columns
);
1277 for (row
= ovsdb_idl_first_row(ctx
->idl
, table
); row
;
1278 row
= ovsdb_idl_next_row(row
)) {
1281 for (i
= 2; i
< ctx
->argc
; i
++) {
1284 ctx
->error
= check_condition(table
, row
, ctx
->argv
[i
],
1285 ctx
->symtab
, &satisfied
);
1294 list_record(row
, columns
, n_columns
, out
);
1301 /* Sets the column of 'row' in 'table'. Returns NULL on success or a
1302 * malloc()'ed error message on failure. */
1303 static char * OVS_WARN_UNUSED_RESULT
1304 set_column(const struct ovsdb_idl_table_class
*table
,
1305 const struct ovsdb_idl_row
*row
, const char *arg
,
1306 struct ovsdb_symbol_table
*symtab
)
1308 const struct ovsdb_idl_column
*column
;
1309 char *key_string
= NULL
;
1310 char *value_string
= NULL
;
1313 error
= parse_column_key_value(arg
, table
, &column
, &key_string
,
1314 NULL
, NULL
, 0, &value_string
);
1318 if (!value_string
) {
1319 error
= xasprintf("%s: missing value", arg
);
1322 error
= check_mutable(row
, column
);
1328 union ovsdb_atom key
, value
;
1329 struct ovsdb_datum datum
;
1331 if (column
->type
.value
.type
== OVSDB_TYPE_VOID
) {
1332 error
= xasprintf("cannot specify key to set for non-map column "
1333 "%s", column
->name
);
1337 error
= ovsdb_atom_from_string(&key
, NULL
, &column
->type
.key
,
1338 key_string
, symtab
);
1342 error
= ovsdb_atom_from_string(&value
, NULL
, &column
->type
.value
,
1343 value_string
, symtab
);
1348 ovsdb_datum_init_empty(&datum
);
1349 ovsdb_datum_add_unsafe(&datum
, &key
, &value
, &column
->type
, NULL
);
1351 ovsdb_atom_destroy(&key
, column
->type
.key
.type
);
1352 ovsdb_atom_destroy(&value
, column
->type
.value
.type
);
1354 ovsdb_datum_union(&datum
, ovsdb_idl_read(row
, column
),
1355 &column
->type
, false);
1356 ovsdb_idl_txn_verify(row
, column
);
1357 ovsdb_idl_txn_write(row
, column
, &datum
);
1359 struct ovsdb_datum datum
;
1361 error
= ovsdb_datum_from_string(&datum
, &column
->type
,
1362 value_string
, symtab
);
1366 ovsdb_idl_txn_write(row
, column
, &datum
);
1377 pre_cmd_set(struct ctl_context
*ctx
)
1379 const char *table_name
= ctx
->argv
[1];
1380 const struct ovsdb_idl_table_class
*table
;
1383 ctx
->error
= pre_get_table(ctx
, table_name
, &table
);
1387 for (i
= 3; i
< ctx
->argc
; i
++) {
1388 ctx
->error
= pre_parse_column_key_value(ctx
, ctx
->argv
[i
], table
);
1396 cmd_set(struct ctl_context
*ctx
)
1398 bool must_exist
= !shash_find(&ctx
->options
, "--if-exists");
1399 const char *table_name
= ctx
->argv
[1];
1400 const char *record_id
= ctx
->argv
[2];
1401 const struct ovsdb_idl_table_class
*table
;
1402 const struct ovsdb_idl_row
*row
;
1405 ctx
->error
= get_table(table_name
, &table
);
1409 ctx
->error
= ctl_get_row(ctx
, table
, record_id
, must_exist
, &row
);
1417 for (i
= 3; i
< ctx
->argc
; i
++) {
1418 ctx
->error
= set_column(table
, row
, ctx
->argv
[i
], ctx
->symtab
);
1424 invalidate_cache(ctx
);
1428 pre_cmd_add(struct ctl_context
*ctx
)
1430 const char *table_name
= ctx
->argv
[1];
1431 const char *column_name
= ctx
->argv
[3];
1432 const struct ovsdb_idl_table_class
*table
;
1433 const struct ovsdb_idl_column
*column
;
1435 ctx
->error
= pre_get_table(ctx
, table_name
, &table
);
1439 ctx
->error
= pre_get_column(ctx
, table
, column_name
, &column
);
1446 cmd_add(struct ctl_context
*ctx
)
1448 bool must_exist
= !shash_find(&ctx
->options
, "--if-exists");
1449 const char *table_name
= ctx
->argv
[1];
1450 const char *record_id
= ctx
->argv
[2];
1451 const char *column_name
= ctx
->argv
[3];
1452 const struct ovsdb_idl_table_class
*table
;
1453 const struct ovsdb_idl_column
*column
;
1454 const struct ovsdb_idl_row
*row
;
1455 const struct ovsdb_type
*type
;
1456 struct ovsdb_datum old
;
1459 ctx
->error
= get_table(table_name
, &table
);
1463 ctx
->error
= get_column(table
, column_name
, &column
);
1467 ctx
->error
= ctl_get_row(ctx
, table
, record_id
, must_exist
, &row
);
1474 ctx
->error
= check_mutable(row
, column
);
1479 type
= &column
->type
;
1480 ovsdb_datum_clone(&old
, ovsdb_idl_read(row
, column
), &column
->type
);
1481 for (i
= 4; i
< ctx
->argc
; i
++) {
1482 struct ovsdb_type add_type
;
1483 struct ovsdb_datum add
;
1487 add_type
.n_max
= UINT_MAX
;
1488 ctx
->error
= ovsdb_datum_from_string(&add
, &add_type
, ctx
->argv
[i
],
1493 ovsdb_datum_union(&old
, &add
, type
, false);
1494 ovsdb_datum_destroy(&add
, type
);
1496 if (old
.n
> type
->n_max
) {
1497 ctl_fatal("\"add\" operation would put %u %s in column %s of "
1498 "table %s but the maximum number is %u",
1500 type
->value
.type
== OVSDB_TYPE_VOID
? "values" : "pairs",
1501 column
->name
, table
->name
, type
->n_max
);
1503 ovsdb_idl_txn_verify(row
, column
);
1504 ovsdb_idl_txn_write(row
, column
, &old
);
1506 invalidate_cache(ctx
);
1510 pre_cmd_remove(struct ctl_context
*ctx
)
1512 const char *table_name
= ctx
->argv
[1];
1513 const char *column_name
= ctx
->argv
[3];
1514 const struct ovsdb_idl_table_class
*table
;
1515 const struct ovsdb_idl_column
*column
;
1517 ctx
->error
= pre_get_table(ctx
, table_name
, &table
);
1521 ctx
->error
= pre_get_column(ctx
, table
, column_name
, &column
);
1528 cmd_remove(struct ctl_context
*ctx
)
1530 bool must_exist
= !shash_find(&ctx
->options
, "--if-exists");
1531 const char *table_name
= ctx
->argv
[1];
1532 const char *record_id
= ctx
->argv
[2];
1533 const char *column_name
= ctx
->argv
[3];
1534 const struct ovsdb_idl_table_class
*table
;
1535 const struct ovsdb_idl_column
*column
;
1536 const struct ovsdb_idl_row
*row
;
1537 const struct ovsdb_type
*type
;
1538 struct ovsdb_datum old
;
1541 ctx
->error
= get_table(table_name
, &table
);
1545 ctx
->error
= get_column(table
, column_name
, &column
);
1549 ctx
->error
= ctl_get_row(ctx
, table
, record_id
, must_exist
, &row
);
1556 ctx
->error
= check_mutable(row
, column
);
1561 type
= &column
->type
;
1562 ovsdb_datum_clone(&old
, ovsdb_idl_read(row
, column
), &column
->type
);
1563 for (i
= 4; i
< ctx
->argc
; i
++) {
1564 struct ovsdb_type rm_type
;
1565 struct ovsdb_datum rm
;
1570 rm_type
.n_max
= UINT_MAX
;
1571 error
= ovsdb_datum_from_string(&rm
, &rm_type
,
1572 ctx
->argv
[i
], ctx
->symtab
);
1575 if (ovsdb_type_is_map(&rm_type
)) {
1576 rm_type
.value
.type
= OVSDB_TYPE_VOID
;
1578 ctx
->error
= ovsdb_datum_from_string(&rm
, &rm_type
,
1589 ovsdb_datum_subtract(&old
, type
, &rm
, &rm_type
);
1590 ovsdb_datum_destroy(&rm
, &rm_type
);
1592 if (old
.n
< type
->n_min
) {
1593 ctl_error(ctx
, "\"remove\" operation would put %u %s in column %s of "
1594 "table %s but the minimum number is %u", old
.n
,
1595 type
->value
.type
== OVSDB_TYPE_VOID
? "values" : "pairs",
1596 column
->name
, table
->name
, type
->n_min
);
1599 ovsdb_idl_txn_verify(row
, column
);
1600 ovsdb_idl_txn_write(row
, column
, &old
);
1602 invalidate_cache(ctx
);
1606 pre_cmd_clear(struct ctl_context
*ctx
)
1608 const char *table_name
= ctx
->argv
[1];
1609 const struct ovsdb_idl_table_class
*table
;
1612 ctx
->error
= pre_get_table(ctx
, table_name
, &table
);
1616 for (i
= 3; i
< ctx
->argc
; i
++) {
1617 const struct ovsdb_idl_column
*column
;
1619 ctx
->error
= pre_get_column(ctx
, table
, ctx
->argv
[i
], &column
);
1627 cmd_clear(struct ctl_context
*ctx
)
1629 bool must_exist
= !shash_find(&ctx
->options
, "--if-exists");
1630 const char *table_name
= ctx
->argv
[1];
1631 const char *record_id
= ctx
->argv
[2];
1632 const struct ovsdb_idl_table_class
*table
;
1633 const struct ovsdb_idl_row
*row
;
1636 ctx
->error
= get_table(table_name
, &table
);
1640 ctx
->error
= ctl_get_row(ctx
, table
, record_id
, must_exist
, &row
);
1648 for (i
= 3; i
< ctx
->argc
; i
++) {
1649 const struct ovsdb_idl_column
*column
;
1650 const struct ovsdb_type
*type
;
1651 struct ovsdb_datum datum
;
1653 ctx
->error
= get_column(table
, ctx
->argv
[i
], &column
);
1657 ctx
->error
= check_mutable(row
, column
);
1662 type
= &column
->type
;
1663 if (type
->n_min
> 0) {
1664 ctl_fatal("\"clear\" operation cannot be applied to column %s "
1665 "of table %s, which is not allowed to be empty",
1666 column
->name
, table
->name
);
1669 ovsdb_datum_init_empty(&datum
);
1670 ovsdb_idl_txn_write(row
, column
, &datum
);
1673 invalidate_cache(ctx
);
1677 pre_create(struct ctl_context
*ctx
)
1679 const char *id
= shash_find_data(&ctx
->options
, "--id");
1680 const char *table_name
= ctx
->argv
[1];
1681 const struct ovsdb_idl_table_class
*table
;
1683 ctx
->error
= get_table(table_name
, &table
);
1687 if (!id
&& !table
->is_root
) {
1688 VLOG_WARN("applying \"create\" command to table %s without --id "
1689 "option will have no effect", table
->name
);
1694 cmd_create(struct ctl_context
*ctx
)
1696 const char *id
= shash_find_data(&ctx
->options
, "--id");
1697 const char *table_name
= ctx
->argv
[1];
1698 const struct ovsdb_idl_table_class
*table
;
1699 const struct ovsdb_idl_row
*row
;
1700 const struct uuid
*uuid
;
1703 ctx
->error
= get_table(table_name
, &table
);
1708 struct ovsdb_symbol
*symbol
;
1710 ctx
->error
= create_symbol(ctx
->symtab
, id
, &symbol
, NULL
);
1714 if (table
->is_root
) {
1715 /* This table is in the root set, meaning that rows created in it
1716 * won't disappear even if they are unreferenced, so disable
1717 * warnings about that by pretending that there is a reference. */
1718 symbol
->strong_ref
= true;
1720 uuid
= &symbol
->uuid
;
1725 row
= ovsdb_idl_txn_insert(ctx
->txn
, table
, uuid
);
1726 for (i
= 2; i
< ctx
->argc
; i
++) {
1727 ctx
->error
= set_column(table
, row
, ctx
->argv
[i
], ctx
->symtab
);
1732 ds_put_format(&ctx
->output
, UUID_FMT
, UUID_ARGS(&row
->uuid
));
1735 /* This function may be used as the 'postprocess' function for commands that
1736 * insert new rows into the database. It expects that the command's 'run'
1737 * function prints the UUID reported by ovsdb_idl_txn_insert() as the command's
1738 * sole output. It replaces that output by the row's permanent UUID assigned
1739 * by the database server and appends a new-line.
1741 * Currently we use this only for "create", because the higher-level commands
1742 * are supposed to be independent of the actual structure of the vswitch
1745 post_create(struct ctl_context
*ctx
)
1747 const struct uuid
*real
;
1750 if (!uuid_from_string(&dummy
, ds_cstr(&ctx
->output
))) {
1753 real
= ovsdb_idl_txn_get_insert_uuid(ctx
->txn
, &dummy
);
1755 ds_clear(&ctx
->output
);
1756 ds_put_format(&ctx
->output
, UUID_FMT
, UUID_ARGS(real
));
1758 ds_put_char(&ctx
->output
, '\n');
1762 pre_cmd_destroy(struct ctl_context
*ctx
)
1764 const char *table_name
= ctx
->argv
[1];
1766 ctx
->error
= pre_get_table(ctx
, table_name
, NULL
);
1773 cmd_destroy(struct ctl_context
*ctx
)
1775 bool must_exist
= !shash_find(&ctx
->options
, "--if-exists");
1776 bool delete_all
= shash_find(&ctx
->options
, "--all");
1777 const char *table_name
= ctx
->argv
[1];
1778 const struct ovsdb_idl_table_class
*table
;
1781 ctx
->error
= get_table(table_name
, &table
);
1786 if (delete_all
&& ctx
->argc
> 2) {
1787 ctl_fatal("--all and records argument should not be specified together");
1790 if (delete_all
&& !must_exist
) {
1791 ctl_fatal("--all and --if-exists should not be specified together");
1795 const struct ovsdb_idl_row
*row
;
1796 const struct ovsdb_idl_row
*next_row
;
1798 for (row
= ovsdb_idl_first_row(ctx
->idl
, table
);
1800 next_row
= ovsdb_idl_next_row(row
);
1801 ovsdb_idl_txn_delete(row
);
1805 for (i
= 2; i
< ctx
->argc
; i
++) {
1806 const struct ovsdb_idl_row
*row
;
1808 ctx
->error
= ctl_get_row(ctx
, table
, ctx
->argv
[i
], must_exist
,
1814 ovsdb_idl_txn_delete(row
);
1818 invalidate_cache(ctx
);
1822 pre_cmd_wait_until(struct ctl_context
*ctx
)
1824 const char *table_name
= ctx
->argv
[1];
1825 const struct ovsdb_idl_table_class
*table
;
1828 ctx
->error
= pre_get_table(ctx
, table_name
, &table
);
1833 for (i
= 3; i
< ctx
->argc
; i
++) {
1834 ctx
->error
= pre_parse_column_key_value(ctx
, ctx
->argv
[i
], table
);
1842 cmd_wait_until(struct ctl_context
*ctx
)
1844 const char *table_name
= ctx
->argv
[1];
1845 const char *record_id
= ctx
->argv
[2];
1846 const struct ovsdb_idl_table_class
*table
;
1847 const struct ovsdb_idl_row
*row
;
1850 ctx
->error
= get_table(table_name
, &table
);
1854 ctx
->error
= ctl_get_row(ctx
, table
, record_id
, false, &row
);
1859 ctx
->try_again
= true;
1863 for (i
= 3; i
< ctx
->argc
; i
++) {
1866 ctx
->error
= check_condition(table
, row
, ctx
->argv
[i
], ctx
->symtab
,
1872 ctx
->try_again
= true;
1878 /* Parses one command. */
1880 parse_command(int argc
, char *argv
[], struct shash
*local_options
,
1881 struct ctl_command
*command
)
1883 const struct ctl_command_syntax
*p
;
1884 struct shash_node
*node
;
1888 shash_init(&command
->options
);
1889 shash_swap(local_options
, &command
->options
);
1890 for (i
= 0; i
< argc
; i
++) {
1891 const char *option
= argv
[i
];
1895 if (option
[0] != '-') {
1899 equals
= strchr(option
, '=');
1901 key
= xmemdup0(option
, equals
- option
);
1902 value
= xstrdup(equals
+ 1);
1904 key
= xstrdup(option
);
1908 if (shash_find(&command
->options
, key
)) {
1909 ctl_fatal("'%s' option specified multiple times", argv
[i
]);
1911 shash_add_nocopy(&command
->options
, key
, value
);
1914 ctl_fatal("missing command name (use --help for help)");
1917 p
= shash_find_data(&all_commands
, argv
[i
]);
1919 ctl_fatal("unknown command '%s'; use --help for help", argv
[i
]);
1922 SHASH_FOR_EACH (node
, &command
->options
) {
1923 const char *s
= strstr(p
->options
, node
->name
);
1924 int end
= s
? s
[strlen(node
->name
)] : EOF
;
1926 if (!strchr("=,? ", end
)) {
1927 ctl_fatal("'%s' command has no '%s' option",
1928 argv
[i
], node
->name
);
1930 if (end
!= '?' && (end
== '=') != (node
->data
!= NULL
)) {
1932 ctl_fatal("missing argument to '%s' option on '%s' "
1933 "command", node
->name
, argv
[i
]);
1935 ctl_fatal("'%s' option on '%s' does not accept an "
1936 "argument", node
->name
, argv
[i
]);
1941 n_arg
= argc
- i
- 1;
1942 if (n_arg
< p
->min_args
) {
1943 ctl_fatal("'%s' command requires at least %d arguments",
1944 p
->name
, p
->min_args
);
1945 } else if (n_arg
> p
->max_args
) {
1948 for (j
= i
+ 1; j
< argc
; j
++) {
1949 if (argv
[j
][0] == '-') {
1950 ctl_fatal("'%s' command takes at most %d arguments "
1951 "(note that options must precede command "
1952 "names and follow a \"--\" argument)",
1953 p
->name
, p
->max_args
);
1957 ctl_fatal("'%s' command takes at most %d arguments",
1958 p
->name
, p
->max_args
);
1961 command
->syntax
= p
;
1962 command
->argc
= n_arg
+ 1;
1963 command
->argv
= &argv
[i
];
1967 pre_cmd_show(struct ctl_context
*ctx
)
1969 const struct cmd_show_table
*show
;
1971 for (show
= cmd_show_tables
; show
->table
; show
++) {
1974 ovsdb_idl_add_table(ctx
->idl
, show
->table
);
1975 if (show
->name_column
) {
1976 ovsdb_idl_add_column(ctx
->idl
, show
->name_column
);
1978 for (i
= 0; i
< ARRAY_SIZE(show
->columns
); i
++) {
1979 const struct ovsdb_idl_column
*column
= show
->columns
[i
];
1981 ovsdb_idl_add_column(ctx
->idl
, column
);
1984 if (show
->wref_table
.table
) {
1985 ovsdb_idl_add_table(ctx
->idl
, show
->wref_table
.table
);
1987 if (show
->wref_table
.name_column
) {
1988 ovsdb_idl_add_column(ctx
->idl
, show
->wref_table
.name_column
);
1990 if (show
->wref_table
.wref_column
) {
1991 ovsdb_idl_add_column(ctx
->idl
, show
->wref_table
.wref_column
);
1996 static const struct cmd_show_table
*
1997 cmd_show_find_table_by_row(const struct ovsdb_idl_row
*row
)
1999 const struct cmd_show_table
*show
;
2001 for (show
= cmd_show_tables
; show
->table
; show
++) {
2002 if (show
->table
== row
->table
->class_
) {
2009 static const struct cmd_show_table
*
2010 cmd_show_find_table_by_name(const char *name
)
2012 const struct cmd_show_table
*show
;
2014 for (show
= cmd_show_tables
; show
->table
; show
++) {
2015 if (!strcmp(show
->table
->name
, name
)) {
2022 /* Prints table entries that weak reference the 'cur_row'. */
2024 cmd_show_weak_ref(struct ctl_context
*ctx
, const struct cmd_show_table
*show
,
2025 const struct ovsdb_idl_row
*cur_row
, int level
)
2027 const struct ovsdb_idl_row
*row_wref
;
2028 const struct ovsdb_idl_table_class
*table
= show
->wref_table
.table
;
2029 const struct ovsdb_idl_column
*name_column
2030 = show
->wref_table
.name_column
;
2031 const struct ovsdb_idl_column
*wref_column
2032 = show
->wref_table
.wref_column
;
2034 if (!table
|| !name_column
|| !wref_column
) {
2038 for (row_wref
= ovsdb_idl_first_row(ctx
->idl
, table
); row_wref
;
2039 row_wref
= ovsdb_idl_next_row(row_wref
)) {
2040 const struct ovsdb_datum
*wref_datum
2041 = ovsdb_idl_read(row_wref
, wref_column
);
2042 /* If weak reference refers to the 'cur_row', prints it. */
2044 && uuid_equals(&cur_row
->uuid
, &wref_datum
->keys
[0].uuid
)) {
2045 const struct ovsdb_datum
*name_datum
2046 = ovsdb_idl_read(row_wref
, name_column
);
2047 ds_put_char_multiple(&ctx
->output
, ' ', (level
+ 1) * 4);
2048 ds_put_format(&ctx
->output
, "%s ", table
->name
);
2049 ovsdb_datum_to_string(name_datum
, &name_column
->type
, &ctx
->output
);
2050 ds_put_char(&ctx
->output
, '\n');
2055 /* 'shown' records the tables that has been displayed by the current
2056 * command to avoid duplicated prints.
2059 cmd_show_row(struct ctl_context
*ctx
, const struct ovsdb_idl_row
*row
,
2060 int level
, struct sset
*shown
)
2062 const struct cmd_show_table
*show
= cmd_show_find_table_by_row(row
);
2065 ds_put_char_multiple(&ctx
->output
, ' ', level
* 4);
2066 if (show
&& show
->name_column
) {
2067 const struct ovsdb_datum
*datum
;
2069 ds_put_format(&ctx
->output
, "%s ", show
->table
->name
);
2070 datum
= ovsdb_idl_read(row
, show
->name_column
);
2071 ovsdb_datum_to_string(datum
, &show
->name_column
->type
, &ctx
->output
);
2073 ds_put_format(&ctx
->output
, UUID_FMT
, UUID_ARGS(&row
->uuid
));
2075 ds_put_char(&ctx
->output
, '\n');
2077 if (!show
|| sset_find(shown
, show
->table
->name
)) {
2081 sset_add(shown
, show
->table
->name
);
2082 for (i
= 0; i
< ARRAY_SIZE(show
->columns
); i
++) {
2083 const struct ovsdb_idl_column
*column
= show
->columns
[i
];
2084 const struct ovsdb_datum
*datum
;
2090 datum
= ovsdb_idl_read(row
, column
);
2091 if (column
->type
.key
.type
== OVSDB_TYPE_UUID
&&
2092 column
->type
.key
.uuid
.refTableName
) {
2093 const struct cmd_show_table
*ref_show
;
2096 ref_show
= cmd_show_find_table_by_name(
2097 column
->type
.key
.uuid
.refTableName
);
2099 for (j
= 0; j
< datum
->n
; j
++) {
2100 const struct ovsdb_idl_row
*ref_row
;
2102 ref_row
= ovsdb_idl_get_row_for_uuid(ctx
->idl
,
2104 &datum
->keys
[j
].uuid
);
2106 cmd_show_row(ctx
, ref_row
, level
+ 1, shown
);
2111 } else if (ovsdb_type_is_map(&column
->type
) &&
2112 column
->type
.value
.type
== OVSDB_TYPE_UUID
&&
2113 column
->type
.value
.uuid
.refTableName
) {
2114 const struct cmd_show_table
*ref_show
;
2117 /* Prints the key to ref'ed table name map if the ref'ed table
2118 * is also defined in 'cmd_show_tables'. */
2119 ref_show
= cmd_show_find_table_by_name(
2120 column
->type
.value
.uuid
.refTableName
);
2121 if (ref_show
&& ref_show
->name_column
) {
2122 ds_put_char_multiple(&ctx
->output
, ' ', (level
+ 1) * 4);
2123 ds_put_format(&ctx
->output
, "%s:\n", column
->name
);
2124 for (j
= 0; j
< datum
->n
; j
++) {
2125 const struct ovsdb_idl_row
*ref_row
;
2127 ref_row
= ovsdb_idl_get_row_for_uuid(ctx
->idl
,
2129 &datum
->values
[j
].uuid
);
2131 ds_put_char_multiple(&ctx
->output
, ' ', (level
+ 2) * 4);
2132 ovsdb_atom_to_string(&datum
->keys
[j
], column
->type
.key
.type
,
2134 ds_put_char(&ctx
->output
, '=');
2136 const struct ovsdb_datum
*ref_datum
;
2138 ref_datum
= ovsdb_idl_read(ref_row
,
2139 ref_show
->name_column
);
2140 ovsdb_datum_to_string(ref_datum
,
2141 &ref_show
->name_column
->type
,
2144 ds_put_cstr(&ctx
->output
, "\"<null>\"");
2146 ds_put_char(&ctx
->output
, '\n');
2152 if (!ovsdb_datum_is_default(datum
, &column
->type
)) {
2153 ds_put_char_multiple(&ctx
->output
, ' ', (level
+ 1) * 4);
2154 ds_put_format(&ctx
->output
, "%s: ", column
->name
);
2155 ovsdb_datum_to_string(datum
, &column
->type
, &ctx
->output
);
2156 ds_put_char(&ctx
->output
, '\n');
2159 cmd_show_weak_ref(ctx
, show
, row
, level
);
2160 sset_find_and_delete_assert(shown
, show
->table
->name
);
2164 cmd_show(struct ctl_context
*ctx
)
2166 const struct ovsdb_idl_row
*row
;
2167 struct sset shown
= SSET_INITIALIZER(&shown
);
2169 for (row
= ovsdb_idl_first_row(ctx
->idl
, cmd_show_tables
[0].table
);
2170 row
; row
= ovsdb_idl_next_row(row
)) {
2171 cmd_show_row(ctx
, row
, 0, &shown
);
2174 ovs_assert(sset_is_empty(&shown
));
2175 sset_destroy(&shown
);
2179 /* Given pointer to dynamic array 'options_p', array's current size
2180 * 'allocated_options_p' and number of added options 'n_options_p',
2181 * adds all command options to the array. Enlarges the array if
2184 ctl_add_cmd_options(struct option
**options_p
, size_t *n_options_p
,
2185 size_t *allocated_options_p
, int opt_val
)
2188 const struct shash_node
*node
;
2189 size_t n_existing_options
= *n_options_p
;
2191 SHASH_FOR_EACH (node
, &all_commands
) {
2192 const struct ctl_command_syntax
*p
= node
->data
;
2194 if (p
->options
[0]) {
2195 char *save_ptr
= NULL
;
2199 s
= xstrdup(p
->options
);
2200 for (name
= strtok_r(s
, ",", &save_ptr
); name
!= NULL
;
2201 name
= strtok_r(NULL
, ",", &save_ptr
)) {
2202 ovs_assert(name
[0] == '-' && name
[1] == '-' && name
[2]);
2205 size_t n
= strcspn(name
, "=?");
2206 int has_arg
= (name
[n
] == '\0' ? no_argument
2207 : name
[n
] == '=' ? required_argument
2208 : optional_argument
);
2211 o
= find_option(name
, *options_p
, *n_options_p
);
2213 ovs_assert(o
- *options_p
>= n_existing_options
);
2214 ovs_assert(o
->has_arg
== has_arg
);
2216 o
= add_option(options_p
, n_options_p
, allocated_options_p
);
2217 o
->name
= xstrdup(name
);
2218 o
->has_arg
= has_arg
;
2227 o
= add_option(options_p
, n_options_p
, allocated_options_p
);
2228 memset(o
, 0, sizeof *o
);
2231 /* Parses command-line input for commands. */
2232 struct ctl_command
*
2233 ctl_parse_commands(int argc
, char *argv
[], struct shash
*local_options
,
2234 size_t *n_commandsp
)
2236 struct ctl_command
*commands
;
2237 size_t n_commands
, allocated_commands
;
2241 n_commands
= allocated_commands
= 0;
2243 for (start
= i
= 0; i
<= argc
; i
++) {
2244 if (i
== argc
|| !strcmp(argv
[i
], "--")) {
2246 if (n_commands
>= allocated_commands
) {
2247 struct ctl_command
*c
;
2249 commands
= x2nrealloc(commands
, &allocated_commands
,
2251 for (c
= commands
; c
< &commands
[n_commands
]; c
++) {
2252 shash_moved(&c
->options
);
2255 parse_command(i
- start
, &argv
[start
], local_options
,
2256 &commands
[n_commands
++]);
2257 } else if (!shash_is_empty(local_options
)) {
2258 ctl_fatal("missing command name (use --help for help)");
2264 ctl_fatal("missing command name (use --help for help)");
2266 *n_commandsp
= n_commands
;
2270 /* Prints all registered commands. */
2272 ctl_print_commands(void)
2274 const struct shash_node
*node
;
2276 SHASH_FOR_EACH (node
, &all_commands
) {
2277 const struct ctl_command_syntax
*p
= node
->data
;
2278 char *options
= xstrdup(p
->options
);
2279 char *options_begin
= options
;
2282 for (item
= strsep(&options
, ","); item
!= NULL
;
2283 item
= strsep(&options
, ",")) {
2284 if (item
[0] != '\0') {
2285 printf("[%s] ", item
);
2288 printf(",%s,", p
->name
);
2289 print_command_arguments(p
);
2292 free(options_begin
);
2298 /* Given array of options 'options', prints them. */
2300 ctl_print_options(const struct option
*options
)
2302 for (; options
->name
; options
++) {
2303 const struct option
*o
= options
;
2305 printf("--%s%s\n", o
->name
, o
->has_arg
? "=ARG" : "");
2306 if (o
->flag
== NULL
&& o
->val
> 0 && o
->val
<= UCHAR_MAX
) {
2307 printf("-%c%s\n", o
->val
, o
->has_arg
? " ARG" : "");
2314 /* Returns the default local database path. */
2316 ctl_default_db(void)
2320 def
= xasprintf("unix:%s/db.sock", ovs_rundir());
2325 /* Returns true if it looks like this set of arguments might modify the
2326 * database, otherwise false. (Not very smart, so it's prone to false
2329 ctl_might_write_to_db(const struct ctl_command
*commands
, size_t n
)
2331 for (size_t i
= 0; i
< n
; i
++) {
2332 if (commands
[i
].syntax
->mode
== RW
) {
2339 /* Report an error while running in the command context. Caller should return
2340 * to its caller immediately after reporting the error. */
2342 ctl_error(struct ctl_context
*ctx
, const char *format
, ...)
2349 VLOG_ERR("Discarding unhandled error: %s", ctx
->error
);
2353 va_start(args
, format
);
2354 ctx
->error
= xvasprintf(format
, args
);
2359 ctl_fatal(const char *format
, ...)
2364 va_start(args
, format
);
2365 message
= xvasprintf(format
, args
);
2368 vlog_set_levels(&this_module
, VLF_CONSOLE
, VLL_OFF
);
2369 VLOG_ERR("%s", message
);
2370 ovs_error(0, "%s", message
);
2371 ctl_exit(EXIT_FAILURE
);
2374 /* Frees the current transaction and the underlying IDL and then calls
2377 * Freeing the transaction and the IDL is not strictly necessary, but it makes
2378 * for a clean memory leak report from valgrind in the normal case. That makes
2379 * it easier to notice real memory leaks. */
2381 ctl_exit(int status
)
2383 if (ctl_exit_func
) {
2384 ctl_exit_func(status
);
2389 /* Comman database commands to be registered. */
2390 static const struct ctl_command_syntax db_ctl_commands
[] = {
2391 {"comment", 0, INT_MAX
, "[ARG]...", NULL
, NULL
, NULL
, "", RO
},
2392 {"get", 2, INT_MAX
, "TABLE RECORD [COLUMN[:KEY]]...",pre_cmd_get
, cmd_get
,
2393 NULL
, "--if-exists,--id=", RO
},
2394 {"list", 1, INT_MAX
, "TABLE [RECORD]...", pre_cmd_list
, cmd_list
, NULL
,
2395 "--if-exists,--columns=", RO
},
2396 {"find", 1, INT_MAX
, "TABLE [COLUMN[:KEY]=VALUE]...", pre_cmd_find
,
2397 cmd_find
, NULL
, "--columns=", RO
},
2398 {"set", 3, INT_MAX
, "TABLE RECORD COLUMN[:KEY]=VALUE...", pre_cmd_set
,
2399 cmd_set
, NULL
, "--if-exists", RW
},
2400 {"add", 4, INT_MAX
, "TABLE RECORD COLUMN [KEY=]VALUE...", pre_cmd_add
,
2401 cmd_add
, NULL
, "--if-exists", RW
},
2402 {"remove", 4, INT_MAX
, "TABLE RECORD COLUMN KEY|VALUE|KEY=VALUE...",
2403 pre_cmd_remove
, cmd_remove
, NULL
, "--if-exists", RW
},
2404 {"clear", 3, INT_MAX
, "TABLE RECORD COLUMN...", pre_cmd_clear
, cmd_clear
,
2405 NULL
, "--if-exists", RW
},
2406 {"create", 2, INT_MAX
, "TABLE COLUMN[:KEY]=VALUE...", pre_create
,
2407 cmd_create
, post_create
, "--id=", RW
},
2408 {"destroy", 1, INT_MAX
, "TABLE [RECORD]...", pre_cmd_destroy
, cmd_destroy
,
2409 NULL
, "--if-exists,--all", RW
},
2410 {"wait-until", 2, INT_MAX
, "TABLE RECORD [COLUMN[:KEY]=VALUE]...",
2411 pre_cmd_wait_until
, cmd_wait_until
, NULL
, "", RO
},
2412 {NULL
, 0, 0, NULL
, NULL
, NULL
, NULL
, NULL
, RO
},
2416 ctl_register_command(const struct ctl_command_syntax
*command
)
2418 shash_add_assert(&all_commands
, command
->name
, command
);
2421 /* Registers commands represented by 'struct ctl_command_syntax's to
2422 * 'all_commands'. The last element of 'commands' must be an all-NULL
2425 ctl_register_commands(const struct ctl_command_syntax
*commands
)
2427 const struct ctl_command_syntax
*p
;
2429 for (p
= commands
; p
->name
; p
++) {
2430 ctl_register_command(p
);
2434 /* Registers the 'db_ctl_commands' to 'all_commands'. */
2436 ctl_init__(const struct ovsdb_idl_class
*idl_class_
,
2437 const struct ctl_table_class
*ctl_classes_
,
2438 const struct cmd_show_table cmd_show_tables_
[],
2439 void (*ctl_exit_func_
)(int status
))
2441 idl_class
= idl_class_
;
2442 idl_classes
= idl_class_
->tables
;
2443 ctl_classes
= ctl_classes_
;
2444 n_classes
= idl_class
->n_tables
;
2445 ctl_exit_func
= ctl_exit_func_
;
2446 ctl_register_commands(db_ctl_commands
);
2448 cmd_show_tables
= cmd_show_tables_
;
2449 if (cmd_show_tables
) {
2450 static const struct ctl_command_syntax show
=
2451 {"show", 0, 0, "", pre_cmd_show
, cmd_show
, NULL
, "", RO
};
2452 ctl_register_command(&show
);
2456 /* Returns the text for the database commands usage. */
2458 ctl_get_db_cmd_usage(void)
2460 return "Database commands:\n\
2461 list TBL [REC] list RECord (or all records) in TBL\n\
2462 find TBL CONDITION... list records satisfying CONDITION in TBL\n\
2463 get TBL REC COL[:KEY] print values of COLumns in RECord in TBL\n\
2464 set TBL REC COL[:KEY]=VALUE set COLumn values in RECord in TBL\n\
2465 add TBL REC COL [KEY=]VALUE add (KEY=)VALUE to COLumn in RECord in TBL\n\
2466 remove TBL REC COL [KEY=]VALUE remove (KEY=)VALUE from COLumn\n\
2467 clear TBL REC COL clear values from COLumn in RECord in TBL\n\
2468 create TBL COL[:KEY]=VALUE create and initialize new record\n\
2469 destroy TBL REC delete RECord from TBL\n\
2470 wait-until TBL REC [COL[:KEY]=VALUE] wait until condition is true\n\
2471 Potentially unsafe database commands require --force option.\n";
2475 ctl_list_db_tables_usage(void)
2477 static struct ds s
= DS_EMPTY_INITIALIZER
;
2482 ds_put_cstr(&s
, "Database commands may reference a row in each table in the following ways:\n");
2483 for (int i
= 0; i
< n_classes
; i
++) {
2484 struct svec options
= SVEC_EMPTY_INITIALIZER
;
2486 svec_add(&options
, "by UUID");
2487 if (idl_classes
[i
].is_singleton
) {
2488 svec_add(&options
, "as \".\"");
2491 for (int j
= 0; j
< ARRAY_SIZE(ctl_classes
[i
].row_ids
); j
++) {
2492 const struct ctl_row_id
*id
= &ctl_classes
[i
].row_ids
[j
];
2493 if (!id
->name_column
) {
2497 struct ds o
= DS_EMPTY_INITIALIZER
;
2498 if (id
->uuid_column
) {
2499 ds_put_format(&o
, "via \"%s\"", id
->uuid_column
->name
);
2500 const struct ovsdb_idl_table_class
*referrer
2501 = ovsdb_idl_table_class_from_column(idl_class
,
2503 if (referrer
!= &idl_classes
[i
]) {
2504 ds_put_format(&o
, " of %s", referrer
->name
);
2507 ds_put_format(&o
, " with matching \"%s:%s\"",
2508 id
->name_column
->name
, id
->key
);
2510 ds_put_format(&o
, " with matching \"%s\"", id
->name_column
->name
);
2512 } else if (id
->key
) {
2513 ds_put_format(&o
, "by \"%s:%s\"", id
->name_column
->name
, id
->key
);
2515 ds_put_format(&o
, "by \"%s\"", id
->name_column
->name
);
2517 svec_add_nocopy(&options
, ds_steal_cstr(&o
));
2520 ds_put_format(&s
, " %s:", idl_classes
[i
].name
);
2521 for (int j
= 0; j
< options
.n
; j
++) {
2522 ds_put_format(&s
, "\n %s", options
.names
[j
]);
2524 ds_put_char(&s
, '\n');
2525 svec_destroy(&options
);
2531 /* Initializes 'ctx' from 'command'. */
2533 ctl_context_init_command(struct ctl_context
*ctx
,
2534 struct ctl_command
*command
)
2536 ctx
->argc
= command
->argc
;
2537 ctx
->argv
= command
->argv
;
2538 ctx
->options
= command
->options
;
2540 ds_swap(&ctx
->output
, &command
->output
);
2541 ctx
->table
= command
->table
;
2542 ctx
->try_again
= false;
2546 /* Initializes the entire 'ctx'. */
2548 ctl_context_init(struct ctl_context
*ctx
, struct ctl_command
*command
,
2549 struct ovsdb_idl
*idl
, struct ovsdb_idl_txn
*txn
,
2550 struct ovsdb_symbol_table
*symtab
,
2551 void (*invalidate_cache_cb
)(struct ctl_context
*))
2554 ctl_context_init_command(ctx
, command
);
2558 ctx
->symtab
= symtab
;
2559 ctx
->invalidate_cache_cb
= invalidate_cache_cb
;
2562 /* Completes processing of 'command' within 'ctx'. */
2564 ctl_context_done_command(struct ctl_context
*ctx
,
2565 struct ctl_command
*command
)
2567 ds_swap(&ctx
->output
, &command
->output
);
2568 command
->table
= ctx
->table
;
2573 /* Finishes up with 'ctx'.
2575 * If command is nonnull, first calls ctl_context_done_command() to complete
2576 * processing that command within 'ctx'. */
2578 ctl_context_done(struct ctl_context
*ctx
,
2579 struct ctl_command
*command
)
2582 ctl_context_done_command(ctx
, command
);
2584 invalidate_cache(ctx
);
2587 char * OVS_WARN_UNUSED_RESULT
2588 ctl_set_column(const char *table_name
, const struct ovsdb_idl_row
*row
,
2589 const char *arg
, struct ovsdb_symbol_table
*symtab
)
2591 const struct ovsdb_idl_table_class
*table
;
2594 error
= get_table(table_name
, &table
);
2598 error
= set_column(table
, row
, arg
, symtab
);