ovs-vsctl: Add "wait-until" command.
[sliver-openvswitch.git] / utilities / ovs-vsctl.c
index aea317c..0291fe8 100644 (file)
@@ -119,11 +119,9 @@ int
 main(int argc, char *argv[])
 {
     struct ovsdb_idl *idl;
-    unsigned int seqno;
     struct vsctl_command *commands;
     size_t n_commands;
     char *args;
-    int trials;
 
     set_program_name(argv[0]);
     signal(SIGPIPE, SIG_IGN);
@@ -147,19 +145,9 @@ main(int argc, char *argv[])
 
     /* Now execute the commands. */
     idl = the_idl = ovsdb_idl_create(db, &ovsrec_idl_class);
-    seqno = ovsdb_idl_get_seqno(idl);
-    trials = 0;
     for (;;) {
-        unsigned int new_seqno;
-
-        ovsdb_idl_run(idl);
-        new_seqno = ovsdb_idl_get_seqno(idl);
-        if (new_seqno != seqno) {
-            if (++trials > 5) {
-                vsctl_fatal("too many database inconsistency failures");
-            }
+        if (ovsdb_idl_run(idl)) {
             do_vsctl(args, commands, n_commands, idl);
-            seqno = new_seqno;
         }
 
         ovsdb_idl_wait(idl);
@@ -477,6 +465,7 @@ Database commands:\n\
   clear TBL REC COL           clear values from COLumn in RECord in TBL\n\
   create TBL COL[:KEY]=VALUE  create and initialize new record\n\
   destroy TBL REC             delete REC from TBL\n\
+  wait-until TBL REC [COL[:KEY]=VALUE]  wait until condition is true\n\
 Potentially unsafe database commands require --force option.\n\
 \n\
 Options:\n\
@@ -514,6 +503,10 @@ struct vsctl_context {
     struct ovsdb_idl_txn *txn;
     struct ovsdb_symbol_table *symtab;
     const struct ovsrec_open_vswitch *ovs;
+
+    /* A command may set this member to true if some prerequisite is not met
+     * and the caller should wait for something to change and then retry. */
+    bool try_again;
 };
 
 struct vsctl_bridge {
@@ -624,17 +617,8 @@ free_info(struct vsctl_info *info)
     }
     shash_destroy(&info->bridges);
 
-    SHASH_FOR_EACH (node, &info->ports) {
-        struct vsctl_port *port = node->data;
-        free(port);
-    }
-    shash_destroy(&info->ports);
-
-    SHASH_FOR_EACH (node, &info->ifaces) {
-        struct vsctl_iface *iface = node->data;
-        free(iface);
-    }
-    shash_destroy(&info->ifaces);
+    shash_destroy_free_data(&info->ports);
+    shash_destroy_free_data(&info->ifaces);
 }
 
 static void
@@ -1984,7 +1968,8 @@ get_table(const char *table_name)
 
 static const struct ovsdb_idl_row *
 get_row_by_id(struct vsctl_context *ctx, const struct vsctl_table_class *table,
-              const struct vsctl_row_id *id, const char *record_id)
+              const struct vsctl_row_id *id, const char *record_id,
+              bool partial_match_ok)
 {
     const struct ovsdb_idl_row *referrer, *final;
 
@@ -2016,8 +2001,11 @@ get_row_by_id(struct vsctl_context *ctx, const struct vsctl_table_class *table,
 
             ovsdb_idl_txn_read(row, id->name_column, &name);
             if (name.n == 1) {
-                unsigned int score = score_partial_match(name.keys[0].string,
-                                                         record_id);
+                unsigned int score;
+
+                score = (partial_match_ok
+                         ? score_partial_match(name.keys[0].string, record_id)
+                         : !strcmp(name.keys[0].string, record_id));
                 if (score > best_score) {
                     referrer = row;
                     best_score = score;
@@ -2057,8 +2045,9 @@ get_row_by_id(struct vsctl_context *ctx, const struct vsctl_table_class *table,
 }
 
 static const struct ovsdb_idl_row *
-get_row(struct vsctl_context *ctx,
-        const struct vsctl_table_class *table, const char *record_id)
+get_row__(struct vsctl_context *ctx,
+          const struct vsctl_table_class *table, const char *record_id,
+          bool partial_match_ok)
 {
     const struct ovsdb_idl_row *row;
     struct uuid uuid;
@@ -2069,7 +2058,8 @@ get_row(struct vsctl_context *ctx,
         int i;
 
         for (i = 0; i < ARRAY_SIZE(table->row_ids); i++) {
-            row = get_row_by_id(ctx, table, &table->row_ids[i], record_id);
+            row = get_row_by_id(ctx, table, &table->row_ids[i], record_id,
+                                partial_match_ok);
             if (row) {
                 break;
             }
@@ -2078,6 +2068,13 @@ get_row(struct vsctl_context *ctx,
     return row;
 }
 
+static const struct ovsdb_idl_row *
+get_row(struct vsctl_context *ctx,
+        const struct vsctl_table_class *table, const char *record_id)
+{
+    return get_row__(ctx, table, record_id, true);
+}
+
 static const struct ovsdb_idl_row *
 must_get_row(struct vsctl_context *ctx,
              const struct vsctl_table_class *table, const char *record_id)
@@ -2121,15 +2118,65 @@ get_column(const struct vsctl_table_class *table, const char *column_name,
     }
 }
 
+static char *
+missing_operator_error(const char *arg, const char **allowed_operators,
+                       size_t n_allowed)
+{
+    struct ds s;
+
+    ds_init(&s);
+    ds_put_format(&s, "%s: argument does not end in ", arg);
+    ds_put_format(&s, "\"%s\"", allowed_operators[0]);
+    if (n_allowed == 2) {
+        ds_put_format(&s, " or \"%s\"", allowed_operators[1]);
+    } else if (n_allowed > 2) {
+        size_t i;
+
+        for (i = 1; i < n_allowed - 1; i++) {
+            ds_put_format(&s, ", \"%s\"", allowed_operators[i]);
+        }
+        ds_put_format(&s, ", or \"%s\"", allowed_operators[i]);
+    }
+    ds_put_format(&s, " followed by a value.");
+
+    return ds_steal_cstr(&s);
+}
+
+/* Breaks 'arg' apart into a number of fields in the following order:
+ *
+ *      - If 'columnp' is nonnull, the name of a column in 'table'.  The column
+ *        is stored into '*columnp'.  The column name may be abbreviated.
+ *
+ *      - If 'keyp' is nonnull, optionally a key string.  (If both 'columnp'
+ *        and 'keyp' are nonnull, then the column and key names are expected to
+ *        be separated by ':').  The key is stored as a malloc()'d string into
+ *        '*keyp', or NULL if no key is present in 'arg'.
+ *
+ *      - If 'valuep' is nonnull, an operator followed by a value string.  The
+ *        allowed operators are the 'n_allowed' string in 'allowed_operators',
+ *        or just "=" if 'n_allowed' is 0.  If 'operatorp' is nonnull, then the
+ *        operator is stored into '*operatorp' (one of the pointers from
+ *        'allowed_operators' is stored; nothing is malloc()'d).  The value is
+ *        stored as a malloc()'d string into '*valuep', or NULL if no value is
+ *        present in 'arg'.
+ *
+ * At least 'columnp' or 'keyp' must be nonnull.
+ *
+ * On success, returns NULL.  On failure, returned a malloc()'d string error
+ * message and stores NULL into all of the nonnull output arguments. */
 static char * WARN_UNUSED_RESULT
-parse_column_key_value(const char *arg, const struct vsctl_table_class *table,
-                       const struct ovsdb_idl_column **columnp,
-                       char **keyp, char **valuep)
+parse_column_key_value(const char *arg,
+                       const struct vsctl_table_class *table,
+                       const struct ovsdb_idl_column **columnp, char **keyp,
+                       const char **operatorp,
+                       const char **allowed_operators, size_t n_allowed,
+                       char **valuep)
 {
     const char *p = arg;
     char *error;
 
     assert(columnp || keyp);
+    assert(!(operatorp && !valuep));
     if (keyp) {
         *keyp = NULL;
     }
@@ -2174,12 +2221,37 @@ parse_column_key_value(const char *arg, const struct vsctl_table_class *table,
     }
 
     /* Parse value string. */
-    if (*p == '=') {
-        if (!valuep) {
-            error = xasprintf("%s: value not accepted here", arg);
+    if (valuep) {
+        const char *best;
+        size_t best_len;
+        size_t i;
+
+        if (!allowed_operators) {
+            static const char *equals = "=";
+            allowed_operators = &equals;
+            n_allowed = 1;
+        }
+
+        best = NULL;
+        best_len = 0;
+        for (i = 0; i < n_allowed; i++) {
+            const char *op = allowed_operators[i];
+            size_t op_len = strlen(op);
+
+            if (op_len > best_len && !strncmp(op, p, op_len) && p[op_len]) {
+                best_len = op_len;
+                best = op;
+            }
+        }
+        if (!best) {
+            error = missing_operator_error(arg, allowed_operators, n_allowed);
             goto error;
         }
-        *valuep = xstrdup(p + 1);
+
+        if (operatorp) {
+            *operatorp = best;
+        }
+        *valuep = xstrdup(p + best_len);
     } else {
         if (valuep) {
             *valuep = NULL;
@@ -2203,6 +2275,9 @@ error:
     if (valuep) {
         free(*valuep);
         *valuep = NULL;
+        if (operatorp) {
+            *operatorp = NULL;
+        }
     }
     return error;
 }
@@ -2225,8 +2300,18 @@ cmd_get(struct vsctl_context *ctx)
         struct ovsdb_datum datum;
         char *key_string;
 
+        /* Special case for obtaining the UUID of a row.  We can't just do this
+         * through parse_column_key_value() below since it returns a "struct
+         * ovsdb_idl_column" and the UUID column doesn't have one. */
+        if (!strcasecmp(ctx->argv[i], "_uuid")
+            || !strcasecmp(ctx->argv[i], "-uuid")) {
+            ds_put_format(out, UUID_FMT"\n", UUID_ARGS(&row->uuid));
+            continue;
+        }
+
         die_if_error(parse_column_key_value(ctx->argv[i], table,
-                                            &column, &key_string, NULL));
+                                            &column, &key_string,
+                                            NULL, NULL, 0, NULL));
 
         ovsdb_idl_txn_read(row, column, &datum);
         if (key_string) {
@@ -2328,7 +2413,7 @@ set_column(const struct vsctl_table_class *table,
     char *error;
 
     error = parse_column_key_value(arg, table, &column, &key_string,
-                                   &value_string);
+                                   NULL, NULL, 0, &value_string);
     die_if_error(error);
     if (!value_string) {
         vsctl_fatal("%s: missing value", arg);
@@ -2585,6 +2670,105 @@ cmd_destroy(struct vsctl_context *ctx)
         }
     }
 }
+
+static bool
+is_condition_satified(const struct vsctl_table_class *table,
+                      const struct ovsdb_idl_row *row, const char *arg,
+                      struct ovsdb_symbol_table *symtab)
+{
+    static const char *operators[] = {
+        "=", "!=", "<", ">", "<=", ">="
+    };
+
+    const struct ovsdb_idl_column *column;
+    char *key_string, *value_string;
+    struct ovsdb_datum have_datum;
+    const char *operator;
+    unsigned int idx;
+    char *error;
+    int cmp;
+
+    error = parse_column_key_value(arg, table, &column, &key_string,
+                                   &operator, operators, ARRAY_SIZE(operators),
+                                   &value_string);
+    die_if_error(error);
+    if (!value_string) {
+        vsctl_fatal("%s: missing value", arg);
+    }
+
+    ovsdb_idl_txn_read(row, column, &have_datum);
+    if (key_string) {
+        union ovsdb_atom want_key, want_value;
+
+        if (column->type.value.type == OVSDB_TYPE_VOID) {
+            vsctl_fatal("cannot specify key to check for non-map column %s",
+                        column->name);
+        }
+
+        die_if_error(ovsdb_atom_from_string(&want_key, &column->type.key,
+                                            key_string, symtab));
+        die_if_error(ovsdb_atom_from_string(&want_value, &column->type.value,
+                                            value_string, symtab));
+
+        idx = ovsdb_datum_find_key(&have_datum,
+                                   &want_key, column->type.key.type);
+        if (idx != UINT_MAX) {
+            cmp = ovsdb_atom_compare_3way(&have_datum.values[idx],
+                                          &want_value,
+                                          column->type.value.type);
+        }
+
+        ovsdb_atom_destroy(&want_key, column->type.key.type);
+        ovsdb_atom_destroy(&want_value, column->type.value.type);
+    } else {
+        struct ovsdb_datum want_datum;
+
+        die_if_error(ovsdb_datum_from_string(&want_datum, &column->type,
+                                             value_string, symtab));
+        idx = 0;
+        cmp = ovsdb_datum_compare_3way(&have_datum, &want_datum,
+                                       &column->type);
+        ovsdb_datum_destroy(&want_datum, &column->type);
+    }
+    ovsdb_datum_destroy(&have_datum, &column->type);
+
+    free(key_string);
+    free(value_string);
+
+    return (idx == UINT_MAX ? false
+            : !strcmp(operator, "=") ? cmp == 0
+            : !strcmp(operator, "!=") ? cmp != 0
+            : !strcmp(operator, "<") ? cmp < 0
+            : !strcmp(operator, ">") ? cmp > 0
+            : !strcmp(operator, "<=") ? cmp <= 0
+            : !strcmp(operator, ">=") ? cmp >= 0
+            : (abort(), 0));
+}
+
+static void
+cmd_wait_until(struct vsctl_context *ctx)
+{
+    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 = get_row__(ctx, table, record_id, false);
+    if (!row) {
+        ctx->try_again = true;
+        return;
+    }
+
+    for (i = 3; i < ctx->argc; i++) {
+        if (!is_condition_satified(table, row, ctx->argv[i], ctx->symtab)) {
+            ctx->try_again = true;
+            return;
+        }
+    }
+}
 \f
 static struct json *
 where_uuid_equals(const struct uuid *uuid)
@@ -2615,6 +2799,8 @@ vsctl_context_init(struct vsctl_context *ctx, struct vsctl_command *command,
     ctx->txn = txn;
     ctx->ovs = ovs;
     ctx->symtab = symtab;
+
+    ctx->try_again = false;
 }
 
 static void
@@ -2656,13 +2842,19 @@ do_vsctl(const char *args, struct vsctl_command *commands, size_t n_commands,
     }
 
     symtab = ovsdb_symbol_table_create();
+    for (c = commands; c < &commands[n_commands]; c++) {
+        ds_init(&c->output);
+    }
     for (c = commands; c < &commands[n_commands]; c++) {
         struct vsctl_context ctx;
 
-        ds_init(&c->output);
         vsctl_context_init(&ctx, c, idl, txn, ovs, symtab);
         (c->syntax->run)(&ctx);
         vsctl_context_done(&ctx, c);
+
+        if (ctx.try_again) {
+            goto try_again;
+        }
     }
 
     status = ovsdb_idl_txn_commit_block(txn);
@@ -2689,7 +2881,6 @@ do_vsctl(const char *args, struct vsctl_command *commands, size_t n_commands,
         vsctl_fatal("row id \"%s\" is referenced but never created (e.g. "
                     "with \"-- --id=%s create ...\")", unused, unused);
     }
-    ovsdb_symbol_table_destroy(symtab);
 
     switch (status) {
     case TXN_INCOMPLETE:
@@ -2704,11 +2895,7 @@ do_vsctl(const char *args, struct vsctl_command *commands, size_t n_commands,
         break;
 
     case TXN_TRY_AGAIN:
-        for (c = commands; c < &commands[n_commands]; c++) {
-            ds_destroy(&c->output);
-        }
-        free(error);
-        return;
+        goto try_again;
 
     case TXN_ERROR:
         vsctl_fatal("transaction error: %s", error);
@@ -2718,6 +2905,8 @@ do_vsctl(const char *args, struct vsctl_command *commands, size_t n_commands,
     }
     free(error);
 
+    ovsdb_symbol_table_destroy(symtab);
+
     for (c = commands; c < &commands[n_commands]; c++) {
         struct ds *ds = &c->output;
         struct shash_node *node;
@@ -2772,6 +2961,17 @@ do_vsctl(const char *args, struct vsctl_command *commands, size_t n_commands,
     ovsdb_idl_destroy(idl);
 
     exit(EXIT_SUCCESS);
+
+try_again:
+    /* Our transaction needs to be rerun, or a prerequisite was not met.  Free
+     * resources and return so that the caller can try again. */
+    ovsdb_idl_txn_abort(txn);
+    ovsdb_idl_txn_destroy(txn);
+    ovsdb_symbol_table_destroy(symtab);
+    for (c = commands; c < &commands[n_commands]; c++) {
+        ds_destroy(&c->output);
+    }
+    free(error);
 }
 
 static const struct vsctl_command_syntax all_commands[] = {
@@ -2824,6 +3024,7 @@ static const struct vsctl_command_syntax all_commands[] = {
     {"clear", 3, INT_MAX, cmd_clear, NULL, ""},
     {"create", 2, INT_MAX, cmd_create, post_create, "--id="},
     {"destroy", 1, INT_MAX, cmd_destroy, NULL, "--if-exists"},
+    {"wait-until", 2, INT_MAX, cmd_wait_until, NULL, ""},
 
     {NULL, 0, 0, NULL, NULL, NULL},
 };