1 /* Copyright (c) 2009, 2010 Nicira Networks
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
22 #include "condition.h"
26 #include "ovsdb-data.h"
27 #include "ovsdb-error.h"
28 #include "ovsdb-parser.h"
34 #include "transaction.h"
36 struct ovsdb_execution {
38 struct ovsdb_txn *txn;
39 struct ovsdb_symbol_table *symtab;
43 long long int elapsed_msec;
44 long long int timeout_msec;
47 typedef struct ovsdb_error *ovsdb_operation_executor(struct ovsdb_execution *,
48 struct ovsdb_parser *,
51 static ovsdb_operation_executor ovsdb_execute_insert;
52 static ovsdb_operation_executor ovsdb_execute_select;
53 static ovsdb_operation_executor ovsdb_execute_update;
54 static ovsdb_operation_executor ovsdb_execute_mutate;
55 static ovsdb_operation_executor ovsdb_execute_delete;
56 static ovsdb_operation_executor ovsdb_execute_wait;
57 static ovsdb_operation_executor ovsdb_execute_commit;
58 static ovsdb_operation_executor ovsdb_execute_abort;
59 static ovsdb_operation_executor ovsdb_execute_comment;
61 static ovsdb_operation_executor *
62 lookup_executor(const char *name)
64 struct ovsdb_operation {
66 ovsdb_operation_executor *executor;
69 static const struct ovsdb_operation operations[] = {
70 { "insert", ovsdb_execute_insert },
71 { "select", ovsdb_execute_select },
72 { "update", ovsdb_execute_update },
73 { "mutate", ovsdb_execute_mutate },
74 { "delete", ovsdb_execute_delete },
75 { "wait", ovsdb_execute_wait },
76 { "commit", ovsdb_execute_commit },
77 { "abort", ovsdb_execute_abort },
78 { "comment", ovsdb_execute_comment },
83 for (i = 0; i < ARRAY_SIZE(operations); i++) {
84 const struct ovsdb_operation *c = &operations[i];
85 if (!strcmp(c->name, name)) {
93 ovsdb_execute(struct ovsdb *db, const struct json *params,
94 long long int elapsed_msec, long long int *timeout_msec)
96 struct ovsdb_execution x;
97 struct ovsdb_error *error;
102 if (params->type != JSON_ARRAY
103 || !params->u.array.n
104 || params->u.array.elems[0]->type != JSON_STRING
105 || strcmp(params->u.array.elems[0]->u.string, db->schema->name)) {
106 if (params->type != JSON_ARRAY) {
107 error = ovsdb_syntax_error(params, NULL, "array expected");
109 error = ovsdb_syntax_error(params, NULL, "database name expected "
110 "as first parameter");
113 results = ovsdb_error_to_json(error);
114 ovsdb_error_destroy(error);
119 x.txn = ovsdb_txn_create(db);
120 x.symtab = ovsdb_symbol_table_create();
122 x.elapsed_msec = elapsed_msec;
123 x.timeout_msec = LLONG_MAX;
126 results = json_array_create_empty();
127 n_operations = params->u.array.n - 1;
129 for (i = 1; i <= n_operations; i++) {
130 struct json *operation = params->u.array.elems[i];
131 struct ovsdb_error *parse_error;
132 struct ovsdb_parser parser;
134 const struct json *op;
136 /* Parse and execute operation. */
137 ovsdb_parser_init(&parser, operation,
138 "ovsdb operation %zu of %zu", i, n_operations);
139 op = ovsdb_parser_member(&parser, "op", OP_ID);
140 result = json_object_create();
142 const char *op_name = json_string(op);
143 ovsdb_operation_executor *executor = lookup_executor(op_name);
145 error = executor(&x, &parser, result);
147 ovsdb_parser_raise_error(&parser, "No operation \"%s\"",
151 assert(ovsdb_parser_has_error(&parser));
154 /* A parse error overrides any other error.
155 * An error overrides any other result. */
156 parse_error = ovsdb_parser_finish(&parser);
158 ovsdb_error_destroy(error);
162 json_destroy(result);
163 result = ovsdb_error_to_json(error);
165 if (error && !strcmp(ovsdb_error_get_tag(error), "not supported")
167 ovsdb_txn_abort(x.txn);
168 *timeout_msec = x.timeout_msec;
170 json_destroy(result);
171 json_destroy(results);
176 /* Add result to array. */
177 json_array_add(results, result);
184 error = ovsdb_txn_commit(x.txn, x.durable);
186 json_array_add(results, ovsdb_error_to_json(error));
189 ovsdb_txn_abort(x.txn);
192 while (json_array(results)->n < n_operations) {
193 json_array_add(results, json_null_create());
197 ovsdb_error_destroy(error);
198 ovsdb_symbol_table_destroy(x.symtab);
204 ovsdb_execute_commit(struct ovsdb_execution *x, struct ovsdb_parser *parser,
205 struct json *result OVS_UNUSED)
207 const struct json *durable;
209 durable = ovsdb_parser_member(parser, "durable", OP_BOOLEAN);
210 if (durable && json_boolean(durable)) {
216 static struct ovsdb_error *
217 ovsdb_execute_abort(struct ovsdb_execution *x OVS_UNUSED,
218 struct ovsdb_parser *parser OVS_UNUSED,
219 struct json *result OVS_UNUSED)
221 return ovsdb_error("aborted", "aborted by request");
224 static struct ovsdb_table *
225 parse_table(struct ovsdb_execution *x,
226 struct ovsdb_parser *parser, const char *member)
228 struct ovsdb_table *table;
229 const char *table_name;
230 const struct json *json;
232 json = ovsdb_parser_member(parser, member, OP_ID);
236 table_name = json_string(json);
238 table = shash_find_data(&x->db->tables, table_name);
240 ovsdb_parser_raise_error(parser, "No table named %s.", table_name);
245 static WARN_UNUSED_RESULT struct ovsdb_error *
246 parse_row(struct ovsdb_parser *parser, const char *member,
247 const struct ovsdb_table *table,
248 struct ovsdb_symbol_table *symtab,
249 struct ovsdb_row **rowp, struct ovsdb_column_set *columns)
251 struct ovsdb_error *error;
252 const struct json *json;
253 struct ovsdb_row *row;
258 return OVSDB_BUG("null table");
260 json = ovsdb_parser_member(parser, member, OP_OBJECT);
262 return OVSDB_BUG("null row member");
265 row = ovsdb_row_create(table);
266 error = ovsdb_row_from_json(row, json, symtab, columns);
268 ovsdb_row_destroy(row);
277 ovsdb_execute_insert(struct ovsdb_execution *x, struct ovsdb_parser *parser,
280 struct ovsdb_table *table;
281 struct ovsdb_row *row = NULL;
282 const struct json *uuid_name;
283 struct ovsdb_error *error;
284 struct uuid row_uuid;
286 table = parse_table(x, parser, "table");
287 uuid_name = ovsdb_parser_member(parser, "uuid-name", OP_ID | OP_OPTIONAL);
288 error = ovsdb_parser_get_error(parser);
291 struct ovsdb_symbol *symbol;
293 symbol = ovsdb_symbol_table_insert(x->symtab, json_string(uuid_name));
295 return ovsdb_syntax_error(uuid_name, "duplicate uuid-name",
296 "This \"uuid-name\" appeared on an "
297 "earlier \"insert\" operation.");
299 row_uuid = symbol->uuid;
302 uuid_generate(&row_uuid);
306 error = parse_row(parser, "row", table, x->symtab, &row, NULL);
309 /* Check constraints for columns not included in "row", in case the
310 * default values do not satisfy the constraints. We could check only
311 * the columns that have their default values by supplying an
312 * ovsdb_column_set to parse_row() above, but I suspect that this is
314 const struct shash_node *node;
316 SHASH_FOR_EACH (node, &table->schema->columns) {
317 const struct ovsdb_column *column = node->data;
318 const struct ovsdb_datum *datum = &row->fields[column->index];
320 /* If there are 0 keys or pairs, there's nothing to check.
321 * If there is 1, it might be a default value.
322 * If there are more, it can't be a default value, so the value has
323 * already been checked. */
325 error = ovsdb_datum_check_constraints(datum, &column->type);
327 ovsdb_row_destroy(row);
334 *ovsdb_row_get_uuid_rw(row) = row_uuid;
335 ovsdb_txn_row_insert(x->txn, row);
336 json_object_put(result, "uuid",
337 ovsdb_datum_to_json(&row->fields[OVSDB_COL_UUID],
344 ovsdb_execute_select(struct ovsdb_execution *x, struct ovsdb_parser *parser,
347 struct ovsdb_table *table;
348 const struct json *where, *columns_json, *sort_json;
349 struct ovsdb_condition condition = OVSDB_CONDITION_INITIALIZER;
350 struct ovsdb_column_set columns = OVSDB_COLUMN_SET_INITIALIZER;
351 struct ovsdb_column_set sort = OVSDB_COLUMN_SET_INITIALIZER;
352 struct ovsdb_error *error;
354 table = parse_table(x, parser, "table");
355 where = ovsdb_parser_member(parser, "where", OP_ARRAY);
356 columns_json = ovsdb_parser_member(parser, "columns",
357 OP_ARRAY | OP_OPTIONAL);
358 sort_json = ovsdb_parser_member(parser, "sort", OP_ARRAY | OP_OPTIONAL);
360 error = ovsdb_parser_get_error(parser);
362 error = ovsdb_condition_from_json(table->schema, where, x->symtab,
366 error = ovsdb_column_set_from_json(columns_json, table, &columns);
369 error = ovsdb_column_set_from_json(sort_json, table, &sort);
372 struct ovsdb_row_set rows = OVSDB_ROW_SET_INITIALIZER;
374 ovsdb_query_distinct(table, &condition, &columns, &rows);
375 ovsdb_row_set_sort(&rows, &sort);
376 json_object_put(result, "rows",
377 ovsdb_row_set_to_json(&rows, &columns));
379 ovsdb_row_set_destroy(&rows);
382 ovsdb_column_set_destroy(&columns);
383 ovsdb_column_set_destroy(&sort);
384 ovsdb_condition_destroy(&condition);
389 struct update_row_cbdata {
391 struct ovsdb_txn *txn;
392 const struct ovsdb_row *row;
393 const struct ovsdb_column_set *columns;
397 update_row_cb(const struct ovsdb_row *row, void *ur_)
399 struct update_row_cbdata *ur = ur_;
402 if (!ovsdb_row_equal_columns(row, ur->row, ur->columns)) {
403 ovsdb_row_update_columns(ovsdb_txn_row_modify(ur->txn, row),
404 ur->row, ur->columns);
411 ovsdb_execute_update(struct ovsdb_execution *x, struct ovsdb_parser *parser,
414 struct ovsdb_table *table;
415 const struct json *where;
416 struct ovsdb_condition condition = OVSDB_CONDITION_INITIALIZER;
417 struct ovsdb_column_set columns = OVSDB_COLUMN_SET_INITIALIZER;
418 struct ovsdb_row *row = NULL;
419 struct update_row_cbdata ur;
420 struct ovsdb_error *error;
422 table = parse_table(x, parser, "table");
423 where = ovsdb_parser_member(parser, "where", OP_ARRAY);
424 error = ovsdb_parser_get_error(parser);
426 error = parse_row(parser, "row", table, x->symtab, &row, &columns);
429 error = ovsdb_condition_from_json(table->schema, where, x->symtab,
436 ur.columns = &columns;
437 ovsdb_query(table, &condition, update_row_cb, &ur);
438 json_object_put(result, "count", json_integer_create(ur.n_matches));
441 ovsdb_row_destroy(row);
442 ovsdb_column_set_destroy(&columns);
443 ovsdb_condition_destroy(&condition);
448 struct mutate_row_cbdata {
450 struct ovsdb_txn *txn;
451 const struct ovsdb_mutation_set *mutations;
455 mutate_row_cb(const struct ovsdb_row *row, void *mr_)
457 struct mutate_row_cbdata *mr = mr_;
460 ovsdb_mutation_set_execute(ovsdb_txn_row_modify(mr->txn, row),
467 ovsdb_execute_mutate(struct ovsdb_execution *x, struct ovsdb_parser *parser,
470 struct ovsdb_table *table;
471 const struct json *where;
472 const struct json *mutations_json;
473 struct ovsdb_condition condition = OVSDB_CONDITION_INITIALIZER;
474 struct ovsdb_mutation_set mutations = OVSDB_MUTATION_SET_INITIALIZER;
475 struct ovsdb_row *row = NULL;
476 struct mutate_row_cbdata mr;
477 struct ovsdb_error *error;
479 table = parse_table(x, parser, "table");
480 where = ovsdb_parser_member(parser, "where", OP_ARRAY);
481 mutations_json = ovsdb_parser_member(parser, "mutations", OP_ARRAY);
482 error = ovsdb_parser_get_error(parser);
484 error = ovsdb_mutation_set_from_json(table->schema, mutations_json,
485 x->symtab, &mutations);
488 error = ovsdb_condition_from_json(table->schema, where, x->symtab,
494 mr.mutations = &mutations;
495 ovsdb_query(table, &condition, mutate_row_cb, &mr);
496 json_object_put(result, "count", json_integer_create(mr.n_matches));
499 ovsdb_row_destroy(row);
500 ovsdb_mutation_set_destroy(&mutations);
501 ovsdb_condition_destroy(&condition);
506 struct delete_row_cbdata {
508 const struct ovsdb_table *table;
509 struct ovsdb_txn *txn;
513 delete_row_cb(const struct ovsdb_row *row, void *dr_)
515 struct delete_row_cbdata *dr = dr_;
518 ovsdb_txn_row_delete(dr->txn, row);
524 ovsdb_execute_delete(struct ovsdb_execution *x, struct ovsdb_parser *parser,
527 struct ovsdb_table *table;
528 const struct json *where;
529 struct ovsdb_condition condition = OVSDB_CONDITION_INITIALIZER;
530 struct ovsdb_error *error;
532 where = ovsdb_parser_member(parser, "where", OP_ARRAY);
533 table = parse_table(x, parser, "table");
534 error = ovsdb_parser_get_error(parser);
536 error = ovsdb_condition_from_json(table->schema, where, x->symtab,
540 struct delete_row_cbdata dr;
545 ovsdb_query(table, &condition, delete_row_cb, &dr);
547 json_object_put(result, "count", json_integer_create(dr.n_matches));
550 ovsdb_condition_destroy(&condition);
555 struct wait_auxdata {
556 struct ovsdb_row_hash *actual;
557 struct ovsdb_row_hash *expected;
562 ovsdb_execute_wait_query_cb(const struct ovsdb_row *row, void *aux_)
564 struct wait_auxdata *aux = aux_;
566 if (ovsdb_row_hash_contains(aux->expected, row)) {
567 ovsdb_row_hash_insert(aux->actual, row);
570 /* The query row isn't in the expected result set, so the actual and
571 * expected results sets definitely differ and we can short-circuit the
572 * rest of the query. */
578 static struct ovsdb_error *
579 ovsdb_execute_wait(struct ovsdb_execution *x, struct ovsdb_parser *parser,
580 struct json *result OVS_UNUSED)
582 struct ovsdb_table *table;
583 const struct json *timeout, *where, *columns_json, *until, *rows;
584 struct ovsdb_condition condition = OVSDB_CONDITION_INITIALIZER;
585 struct ovsdb_column_set columns = OVSDB_COLUMN_SET_INITIALIZER;
586 struct ovsdb_row_hash expected = OVSDB_ROW_HASH_INITIALIZER(expected);
587 struct ovsdb_row_hash actual = OVSDB_ROW_HASH_INITIALIZER(actual);
588 struct ovsdb_error *error;
589 struct wait_auxdata aux;
590 long long int timeout_msec = 0;
593 timeout = ovsdb_parser_member(parser, "timeout", OP_NUMBER | OP_OPTIONAL);
594 where = ovsdb_parser_member(parser, "where", OP_ARRAY);
595 columns_json = ovsdb_parser_member(parser, "columns",
596 OP_ARRAY | OP_OPTIONAL);
597 until = ovsdb_parser_member(parser, "until", OP_STRING);
598 rows = ovsdb_parser_member(parser, "rows", OP_ARRAY);
599 table = parse_table(x, parser, "table");
600 error = ovsdb_parser_get_error(parser);
602 error = ovsdb_condition_from_json(table->schema, where, x->symtab,
606 error = ovsdb_column_set_from_json(columns_json, table, &columns);
610 timeout_msec = MIN(LLONG_MAX, json_real(timeout));
611 if (timeout_msec < 0) {
612 error = ovsdb_syntax_error(timeout, NULL,
613 "timeout must be nonnegative");
614 } else if (timeout_msec < x->timeout_msec) {
615 x->timeout_msec = timeout_msec;
618 timeout_msec = LLONG_MAX;
620 if (strcmp(json_string(until), "==")
621 && strcmp(json_string(until), "!=")) {
622 error = ovsdb_syntax_error(until, NULL,
623 "\"until\" must be \"==\" or \"!=\"");
627 /* Parse "rows" into 'expected'. */
628 ovsdb_row_hash_init(&expected, &columns);
629 for (i = 0; i < rows->u.array.n; i++) {
630 struct ovsdb_row *row;
632 row = ovsdb_row_create(table);
633 error = ovsdb_row_from_json(row, rows->u.array.elems[i], x->symtab,
639 if (!ovsdb_row_hash_insert(&expected, row)) {
640 /* XXX Perhaps we should abort with an error or log a
642 ovsdb_row_destroy(row);
649 ovsdb_row_hash_init(&actual, &columns);
650 aux.actual = &actual;
651 aux.expected = &expected;
653 ovsdb_query(table, &condition, ovsdb_execute_wait_query_cb, &aux);
655 /* We know that every row in 'actual' is also in 'expected'. We
656 * also know that all of the rows in 'actual' are distinct and that
657 * all of the rows in 'expected' are distinct. Therefore, if
658 * 'actual' and 'expected' have the same number of rows, then they
659 * have the same content. */
660 size_t n_actual = ovsdb_row_hash_count(&actual);
661 size_t n_expected = ovsdb_row_hash_count(&expected);
662 equal = n_actual == n_expected;
664 if (!strcmp(json_string(until), "==") != equal) {
665 if (timeout && x->elapsed_msec >= timeout_msec) {
666 if (x->elapsed_msec) {
667 error = ovsdb_error("timed out",
668 "\"wait\" timed out after %lld ms",
671 error = ovsdb_error("timed out", "\"wait\" timed out");
674 /* ovsdb_execute() will change this, if triggers really are
676 error = ovsdb_error("not supported", "triggers not supported");
682 ovsdb_row_hash_destroy(&expected, true);
683 ovsdb_row_hash_destroy(&actual, false);
684 ovsdb_column_set_destroy(&columns);
685 ovsdb_condition_destroy(&condition);
690 static struct ovsdb_error *
691 ovsdb_execute_comment(struct ovsdb_execution *x, struct ovsdb_parser *parser,
692 struct json *result OVS_UNUSED)
694 const struct json *comment;
696 comment = ovsdb_parser_member(parser, "comment", OP_STRING);
700 ovsdb_txn_add_comment(x->txn, json_string(comment));