+ *columnp = best_match;
+ if (best_match) {
+ return NULL;
+ } else if (best_score) {
+ return xasprintf("%s contains more than one column whose name "
+ "matches \"%s\"", table->class->name, column_name);
+ } else {
+ return xasprintf("%s does not contain a column whose name matches "
+ "\"%s\"", table->class->name, column_name);
+ }
+}
+
+static char * WARN_UNUSED_RESULT
+parse_column_key_value(const char *arg, const struct vsctl_table_class *table,
+ const struct vsctl_column **columnp,
+ char **keyp, char **valuep)
+{
+ const char *p = arg;
+ char *error;
+
+ assert(columnp || keyp);
+ if (keyp) {
+ *keyp = NULL;
+ }
+ if (valuep) {
+ *valuep = NULL;
+ }
+
+ /* Parse column name. */
+ if (columnp) {
+ char *column_name;
+
+ error = ovsdb_token_parse(&p, &column_name);
+ if (error) {
+ goto error;
+ }
+ if (column_name[0] == '\0') {
+ free(column_name);
+ error = xasprintf("%s: missing column name", arg);
+ goto error;
+ }
+ error = get_column(table, column_name, columnp);
+ free(column_name);
+ if (error) {
+ goto error;
+ }
+ }
+
+ /* Parse key string. */
+ if (*p == ':' || !columnp) {
+ if (columnp) {
+ p++;
+ } else if (!keyp) {
+ error = xasprintf("%s: key not accepted here", arg);
+ goto error;
+ }
+ error = ovsdb_token_parse(&p, keyp);
+ if (error) {
+ goto error;
+ }
+ } else if (keyp) {
+ *keyp = NULL;
+ }
+
+ /* Parse value string. */
+ if (*p == '=') {
+ if (!valuep) {
+ error = xasprintf("%s: value not accepted here", arg);
+ goto error;
+ }
+ *valuep = xstrdup(p + 1);
+ } else {
+ if (valuep) {
+ *valuep = NULL;
+ }
+ if (*p != '\0') {
+ error = xasprintf("%s: trailing garbage \"%s\" in argument",
+ arg, p);
+ goto error;
+ }
+ }
+ return NULL;
+
+error:
+ if (columnp) {
+ *columnp = NULL;
+ }
+ if (keyp) {
+ free(*keyp);
+ *keyp = NULL;
+ }
+ if (valuep) {
+ free(*valuep);
+ *valuep = NULL;
+ }
+ return error;
+}
+
+static void
+cmd_get(struct vsctl_context *ctx)
+{
+ bool if_exists = shash_find(&ctx->options, "--if-exists");
+ const char *table_name = ctx->argv[1];
+ const char *record_id = ctx->argv[2];
+ const struct vsctl_table_class *table;
+ const struct ovsdb_idl_row *row;
+ struct ds *out = &ctx->output;
+ int i;
+
+ table = get_table(table_name);
+ row = must_get_row(ctx, table, record_id);
+ for (i = 3; i < ctx->argc; i++) {
+ const struct vsctl_column *column;
+ struct ovsdb_datum datum;
+ char *key_string;
+
+ die_if_error(parse_column_key_value(ctx->argv[i], table,
+ &column, &key_string, NULL));
+
+ ovsdb_idl_txn_read(row, column->idl, &datum);
+ if (key_string) {
+ union ovsdb_atom key;
+ unsigned int idx;
+
+ if (column->idl->type.value_type == OVSDB_TYPE_VOID) {
+ vsctl_fatal("cannot specify key to get for non-map column %s",
+ column->idl->name);
+ }
+
+ die_if_error(ovsdb_atom_from_string(&key,
+ column->idl->type.key_type,
+ key_string));
+
+ idx = ovsdb_datum_find_key(&datum, &key,
+ column->idl->type.key_type);
+ if (idx == UINT_MAX) {
+ if (!if_exists) {
+ vsctl_fatal("no key \"%s\" in %s record \"%s\" column %s",
+ key_string, table->class->name, record_id,
+ column->idl->name);
+ }
+ } else {
+ ovsdb_atom_to_string(&datum.values[idx],
+ column->idl->type.value_type, out);
+ }
+ ovsdb_atom_destroy(&key, column->idl->type.key_type);
+ } else {
+ ovsdb_datum_to_string(&datum, &column->idl->type, out);
+ }
+ ds_put_char(out, '\n');
+ ovsdb_datum_destroy(&datum, &column->idl->type);
+
+ free(key_string);
+ }
+}
+
+static void
+list_record(const struct vsctl_table_class *table,
+ const struct ovsdb_idl_row *row, struct ds *out)
+{
+ const struct vsctl_column *column;
+
+ ds_put_format(out, "%-20s (RO): "UUID_FMT"\n", "_uuid",
+ UUID_ARGS(&row->uuid));
+ for (column = table->columns; column->idl; column++) {
+ struct ovsdb_datum datum;
+
+ if (column->flags & VSCF_HIDDEN) {
+ continue;
+ }
+
+ ovsdb_idl_txn_read(row, column->idl, &datum);
+
+ ds_put_format(out, "%-20s (%s): ", column->idl->name,
+ column->flags & VSCF_READONLY ? "RO" : "RW");
+ ovsdb_datum_to_string(&datum, &column->idl->type, out);
+ ds_put_char(out, '\n');
+
+ ovsdb_datum_destroy(&datum, &column->idl->type);
+ }
+}
+
+static void
+cmd_list(struct vsctl_context *ctx)
+{
+ const char *table_name = ctx->argv[1];
+ const struct vsctl_table_class *table;
+ struct ds *out = &ctx->output;
+ int i;
+
+ table = get_table(table_name);
+ if (ctx->argc > 2) {
+ for (i = 2; i < ctx->argc; i++) {
+ if (i > 2) {
+ ds_put_char(out, '\n');
+ }
+ list_record(table, must_get_row(ctx, table, ctx->argv[i]), out);
+ }
+ } else {
+ const struct ovsdb_idl_row *row;
+ bool first;
+
+ for (row = ovsdb_idl_first_row(ctx->idl, table->class), first = true;
+ row != NULL;
+ row = ovsdb_idl_next_row(row), first = false) {
+ if (!first) {
+ ds_put_char(out, '\n');
+ }
+ list_record(table, row, out);
+ }
+ }
+}
+
+static void
+check_string_constraint(const struct ovsdb_datum *datum,
+ const char *constraint)
+{
+ unsigned int i;
+ char *regex;
+ regex_t re;
+ int retval;
+
+ regex = xasprintf("^%s$", constraint);
+ retval = regcomp(&re, regex, REG_NOSUB | REG_EXTENDED);
+ if (retval) {
+ size_t length = regerror(retval, &re, NULL, 0);
+ char *buffer = xmalloc(length);
+ regerror(retval, &re, buffer, length);
+ vsctl_fatal("internal error compiling regular expression %s: %s",
+ regex, buffer);
+ }
+
+ for (i = 0; i < datum->n; i++) {
+ const char *key = datum->keys[i].string;
+ if (regexec(&re, key, 0, NULL, 0)) {
+ vsctl_fatal("%s is not valid (it does not match %s)", key, regex);
+ }
+ }
+ free(regex);
+ regfree(&re);
+}
+
+static void
+check_integer_constraint(const struct ovsdb_datum *datum,
+ const char *constraint)
+{
+ int64_t min, max;
+ unsigned int i;
+ int n = -1;
+
+ sscanf(constraint, "[%"SCNd64",%"SCNd64"]%n", &min, &max, &n);
+ if (n == -1) {
+ sscanf(constraint, "[%"SCNd64",]%n", &min, &n);
+ if (n == -1) {
+ sscanf(constraint, "[,%"SCNd64"]%n", &max, &n);
+ if (n == -1) {
+ VLOG_DBG("internal error: bad integer contraint \"%s\"",
+ constraint);
+ return;
+ } else {
+ min = INT64_MIN;
+ }
+ } else {
+ max = INT64_MAX;
+ }
+ }
+
+ for (i = 0; i < datum->n; i++) {
+ int64_t value = datum->keys[i].integer;
+ if (value < min || value > max) {
+ if (max == INT64_MAX) {
+ vsctl_fatal("%"PRId64" is less than the minimum "
+ "allowed value %"PRId64, value, min);
+ } else if (min == INT64_MIN) {
+ vsctl_fatal("%"PRId64" is greater than the maximum "
+ "allowed value %"PRId64, value, max);
+ } else {
+ vsctl_fatal("%"PRId64" is outside the valid range %"PRId64" "
+ "to %"PRId64" (inclusive)", value, min, max);
+ }
+ }
+ }
+}
+
+static void
+check_constraint(const struct ovsdb_datum *datum,
+ const struct ovsdb_type *type, const char *constraint)
+{
+ if (constraint && datum->n) {
+ if (type->key_type == OVSDB_TYPE_STRING) {
+ check_string_constraint(datum, constraint);
+ } else if (type->key_type == OVSDB_TYPE_INTEGER) {
+ check_integer_constraint(datum, constraint);
+ }
+ }
+}
+
+static void
+set_column(const struct vsctl_table_class *table,
+ const struct ovsdb_idl_row *row,
+ const char *arg, bool force)
+{
+ const struct vsctl_column *column;
+ char *key_string, *value_string;
+ char *error;
+
+ error = parse_column_key_value(arg, table, &column, &key_string,
+ &value_string);
+ die_if_error(error);
+ if (column->flags & VSCF_READONLY && !force) {
+ vsctl_fatal("%s: cannot modify read-only column %s in table %s",
+ arg, column->idl->name, table->class->name);
+ }
+ if (!value_string) {
+ vsctl_fatal("%s: missing value", arg);
+ }
+
+ if (key_string) {
+ union ovsdb_atom key, value;
+ struct ovsdb_datum old, new;
+
+ if (column->idl->type.value_type == OVSDB_TYPE_VOID) {
+ vsctl_fatal("cannot specify key to set for non-map column %s",
+ column->idl->name);
+ }
+
+ die_if_error(ovsdb_atom_from_string(&key,
+ column->idl->type.key_type,
+ key_string));
+ die_if_error(ovsdb_atom_from_string(&value,
+ column->idl->type.value_type,
+ value_string));
+
+ ovsdb_datum_init_empty(&new);
+ ovsdb_datum_add_unsafe(&new, &key, &value, &column->idl->type);
+
+ ovsdb_atom_destroy(&key, column->idl->type.key_type);
+ ovsdb_atom_destroy(&value, column->idl->type.value_type);
+
+ ovsdb_idl_txn_read(row, column->idl, &old);
+ ovsdb_datum_union(&old, &new, &column->idl->type, true);
+ ovsdb_idl_txn_write(row, column->idl, &old);
+
+ ovsdb_datum_destroy(&new, &column->idl->type);
+ } else {
+ struct ovsdb_datum datum;
+
+ die_if_error(ovsdb_datum_from_string(&datum, &column->idl->type,
+ value_string));
+ if (!force) {
+ check_constraint(&datum, &column->idl->type,
+ column->constraint);
+ }
+ ovsdb_idl_txn_write(row, column->idl, &datum);
+ }
+
+ free(key_string);
+ free(value_string);
+}
+
+static void
+cmd_set(struct vsctl_context *ctx)
+{
+ bool force = shash_find(&ctx->options, "--force");
+ const char *table_name = ctx->argv[1];
+ const char *record_id = ctx->argv[2];
+ const struct vsctl_table_class *table;
+ const struct ovsdb_idl_row *row;
+ int i;
+
+ table = get_table(table_name);
+ row = must_get_row(ctx, table, record_id);
+ for (i = 3; i < ctx->argc; i++) {
+ set_column(table, row, ctx->argv[i], force);
+ }
+}
+
+static void
+cmd_add(struct vsctl_context *ctx)
+{
+ bool force = shash_find(&ctx->options, "--force");
+ const char *table_name = ctx->argv[1];
+ const char *record_id = ctx->argv[2];
+ const char *column_name = ctx->argv[3];
+ const struct vsctl_table_class *table;
+ const struct vsctl_column *column;
+ const struct ovsdb_idl_row *row;
+ const struct ovsdb_type *type;
+ struct ovsdb_datum old;
+ int i;
+
+ table = get_table(table_name);
+ row = must_get_row(ctx, table, record_id);
+ die_if_error(get_column(table, column_name, &column));
+ if (column->flags & VSCF_READONLY && !force) {
+ vsctl_fatal("cannot modify read-only column %s in table %s",
+ column->idl->name, table->class->name);
+ }
+
+ type = &column->idl->type;
+ ovsdb_idl_txn_read(row, column->idl, &old);
+ for (i = 4; i < ctx->argc; i++) {
+ struct ovsdb_type add_type;
+ struct ovsdb_datum add;
+
+ add_type = *type;
+ add_type.n_min = 1;
+ add_type.n_max = UINT_MAX;
+ die_if_error(ovsdb_datum_from_string(&add, &add_type, ctx->argv[i]));
+ ovsdb_datum_union(&old, &add, type, false);
+ ovsdb_datum_destroy(&add, type);
+ }
+ if (old.n > type->n_max) {
+ vsctl_fatal("\"add\" operation would put %u %s in column %s of "
+ "table %s but the maximum number is %u",
+ old.n,
+ type->value_type == OVSDB_TYPE_VOID ? "values" : "pairs",
+ column->idl->name, table->class->name, type->n_max);
+ }
+ ovsdb_idl_txn_write(row, column->idl, &old);
+}
+
+static void
+cmd_remove(struct vsctl_context *ctx)
+{
+ bool force = shash_find(&ctx->options, "--force");
+ const char *table_name = ctx->argv[1];
+ const char *record_id = ctx->argv[2];
+ const char *column_name = ctx->argv[3];
+ const struct vsctl_table_class *table;
+ const struct vsctl_column *column;
+ const struct ovsdb_idl_row *row;
+ const struct ovsdb_type *type;
+ struct ovsdb_datum old;
+ int i;
+
+ table = get_table(table_name);
+ row = must_get_row(ctx, table, record_id);
+ die_if_error(get_column(table, column_name, &column));
+ if (column->flags & VSCF_READONLY && !force) {
+ vsctl_fatal("cannot modify read-only column %s in table %s",
+ column->idl->name, table->class->name);
+ }
+
+ type = &column->idl->type;
+ ovsdb_idl_txn_read(row, column->idl, &old);
+ for (i = 4; i < ctx->argc; i++) {
+ struct ovsdb_type rm_type;
+ struct ovsdb_datum rm;
+ char *error;
+
+ rm_type = *type;
+ rm_type.n_min = 1;
+ rm_type.n_max = UINT_MAX;
+ error = ovsdb_datum_from_string(&rm, &rm_type, ctx->argv[i]);
+ if (error && ovsdb_type_is_map(&rm_type)) {
+ free(error);
+ rm_type.value_type = OVSDB_TYPE_VOID;
+ die_if_error(ovsdb_datum_from_string(&rm, &rm_type, ctx->argv[i]));
+ }
+ ovsdb_datum_subtract(&old, type, &rm, &rm_type);
+ ovsdb_datum_destroy(&rm, &rm_type);
+ }
+ if (old.n < type->n_min) {
+ vsctl_fatal("\"remove\" operation would put %u %s in column %s of "
+ "table %s but the minimun number is %u",
+ old.n,
+ type->value_type == OVSDB_TYPE_VOID ? "values" : "pairs",
+ column->idl->name, table->class->name, type->n_min);
+ }
+ ovsdb_idl_txn_write(row, column->idl, &old);
+}
+
+static void
+cmd_clear(struct vsctl_context *ctx)
+{
+ bool force = shash_find(&ctx->options, "--force");
+ const char *table_name = ctx->argv[1];
+ const char *record_id = ctx->argv[2];
+ const struct vsctl_table_class *table;
+ const struct ovsdb_idl_row *row;
+ int i;
+
+ table = get_table(table_name);
+ row = must_get_row(ctx, table, record_id);
+ for (i = 3; i < ctx->argc; i++) {
+ const struct vsctl_column *column;
+ const struct ovsdb_type *type;
+ struct ovsdb_datum datum;
+
+ die_if_error(get_column(table, ctx->argv[i], &column));
+
+ type = &column->idl->type;
+ if (column->flags & VSCF_READONLY && !force) {
+ vsctl_fatal("cannot modify read-only column %s in table %s",
+ column->idl->name, table->class->name);
+ } else if (type->n_min > 0) {
+ vsctl_fatal("\"clear\" operation cannot be applied to column %s "
+ "of table %s, which is not allowed to be empty",
+ column->idl->name, table->class->name);
+ }
+
+ ovsdb_datum_init_empty(&datum);
+ ovsdb_idl_txn_write(row, column->idl, &datum);
+ }
+}
+
+static void
+cmd_create(struct vsctl_context *ctx)
+{
+ bool force = shash_find(&ctx->options, "--force");
+ const char *table_name = ctx->argv[1];
+ const struct vsctl_table_class *table;
+ const struct ovsdb_idl_row *row;
+ int i;
+
+ if (!force) {
+ vsctl_fatal("\"create\" requires --force");
+ }
+
+ table = get_table(table_name);
+ row = ovsdb_idl_txn_insert(ctx->txn, table->class);
+ for (i = 2; i < ctx->argc; i++) {
+ set_column(table, row, ctx->argv[i], force);
+ }
+ ds_put_format(&ctx->output, UUID_FMT, UUID_ARGS(&row->uuid));
+}
+
+/* This function may be used as the 'postprocess' function for commands that
+ * insert new rows into the database. It expects that the command's 'run'
+ * function prints the UUID reported by ovsdb_idl_txn_insert() as the command's
+ * sole output. It replaces that output by the row's permanent UUID assigned
+ * by the database server and appends a new-line.
+ *
+ * Currently we use this only for "create", because the higher-level commands
+ * are supposed to be independent of the actual structure of the vswitch
+ * configuration. */
+static void
+post_create(struct vsctl_context *ctx)
+{
+ const struct uuid *real;
+ struct uuid dummy;
+
+ uuid_from_string(&dummy, ds_cstr(&ctx->output));
+ real = ovsdb_idl_txn_get_insert_uuid(ctx->txn, &dummy);
+ if (real) {
+ ds_clear(&ctx->output);
+ ds_put_format(&ctx->output, UUID_FMT, UUID_ARGS(real));
+ }
+ ds_put_char(&ctx->output, '\n');
+}
+
+static void
+cmd_destroy(struct vsctl_context *ctx)
+{
+ bool force = shash_find(&ctx->options, "--force");
+ bool must_exist = !shash_find(&ctx->options, "--if-exists");
+ const char *table_name = ctx->argv[1];
+ const struct vsctl_table_class *table;
+ int i;
+
+ if (!force) {
+ vsctl_fatal("\"destroy\" requires --force");
+ }
+
+ table = get_table(table_name);
+ for (i = 2; i < ctx->argc; i++) {
+ const struct ovsdb_idl_row *row;
+
+ row = (must_exist ? must_get_row : get_row)(ctx, table, ctx->argv[i]);
+ if (row) {
+ ovsdb_idl_txn_delete(row);
+ }
+ }
+}
+\f
+static struct json *
+where_uuid_equals(const struct uuid *uuid)
+{
+ return
+ json_array_create_1(
+ json_array_create_3(
+ json_string_create("_uuid"),
+ json_string_create("=="),
+ json_array_create_2(
+ json_string_create("uuid"),
+ json_string_create_nocopy(
+ xasprintf(UUID_FMT, UUID_ARGS(uuid))))));
+}
+
+static void
+vsctl_context_init(struct vsctl_context *ctx, struct vsctl_command *command,
+ struct ovsdb_idl *idl, struct ovsdb_idl_txn *txn,
+ const struct ovsrec_open_vswitch *ovs)
+{
+ ctx->argc = command->argc;
+ ctx->argv = command->argv;
+ ctx->options = command->options;
+
+ ds_swap(&ctx->output, &command->output);
+ ctx->idl = idl;
+ ctx->txn = txn;
+ ctx->ovs = ovs;
+
+}
+
+static void
+vsctl_context_done(struct vsctl_context *ctx, struct vsctl_command *command)
+{
+ ds_swap(&ctx->output, &command->output);
+}
+
+static void
+do_vsctl(const char *args, struct vsctl_command *commands, size_t n_commands,
+ struct ovsdb_idl *idl)
+{
+ struct ovsdb_idl_txn *txn;
+ const struct ovsrec_open_vswitch *ovs;
+ enum ovsdb_idl_txn_status status;
+ struct vsctl_command *c;
+ int64_t next_cfg = 0;
+ char *comment;
+
+ txn = the_idl_txn = ovsdb_idl_txn_create(idl);
+ if (dry_run) {
+ ovsdb_idl_txn_set_dry_run(txn);
+ }
+
+ comment = xasprintf("ovs-vsctl: %s", args);
+ ovsdb_idl_txn_add_comment(txn, comment);
+ free(comment);
+
+ ovs = ovsrec_open_vswitch_first(idl);
+ if (!ovs) {
+ /* XXX add verification that table is empty */
+ ovs = ovsrec_open_vswitch_insert(txn);
+ }
+
+ if (wait_for_reload) {
+ struct json *where = where_uuid_equals(&ovs->header_.uuid);
+ ovsdb_idl_txn_increment(txn, "Open_vSwitch", "next_cfg", where);
+ json_destroy(where);
+ }
+
+ for (c = commands; c < &commands[n_commands]; c++) {
+ struct vsctl_context ctx;
+
+ ds_init(&c->output);
+ vsctl_context_init(&ctx, c, idl, txn, ovs);
+ (c->syntax->run)(&ctx);
+ vsctl_context_done(&ctx, c);
+ }
+