1 /* Copyright (c) 2009, 2010, 2011 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.
18 #include "ovsdb-idl.h"
27 #include "dynamic-string.h"
28 #include "fatal-signal.h"
31 #include "ovsdb-data.h"
32 #include "ovsdb-error.h"
33 #include "ovsdb-idl-provider.h"
34 #include "poll-loop.h"
39 VLOG_DEFINE_THIS_MODULE(ovsdb_idl);
41 /* An arc from one idl_row to another. When row A contains a UUID that
42 * references row B, this is represented by an arc from A (the source) to B
45 * Arcs from a row to itself are omitted, that is, src and dst are always
48 * Arcs are never duplicated, that is, even if there are multiple references
49 * from A to B, there is only a single arc from A to B.
51 * Arcs are directed: an arc from A to B is the converse of an an arc from B to
52 * A. Both an arc and its converse may both be present, if each row refers
53 * to the other circularly.
55 * The source and destination row may be in the same table or in different
58 struct ovsdb_idl_arc {
59 struct list src_node; /* In src->src_arcs list. */
60 struct list dst_node; /* In dst->dst_arcs list. */
61 struct ovsdb_idl_row *src; /* Source row. */
62 struct ovsdb_idl_row *dst; /* Destination row. */
66 const struct ovsdb_idl_class *class;
67 struct jsonrpc_session *session;
68 struct shash table_by_name;
69 struct ovsdb_idl_table *tables; /* Contains "struct ovsdb_idl_table *"s.*/
70 struct json *monitor_request_id;
71 unsigned int last_monitor_request_seqno;
72 unsigned int change_seqno;
74 /* Database locking. */
75 char *lock_name; /* Name of lock we need, NULL if none. */
76 bool has_lock; /* Has db server told us we have the lock? */
77 bool is_lock_contended; /* Has db server told us we can't get lock? */
78 struct json *lock_request_id; /* JSON-RPC ID of in-flight lock request. */
80 /* Transaction support. */
81 struct ovsdb_idl_txn *txn;
82 struct hmap outstanding_txns;
85 struct ovsdb_idl_txn {
86 struct hmap_node hmap_node;
87 struct json *request_id;
88 struct ovsdb_idl *idl;
90 enum ovsdb_idl_txn_status status;
98 struct json *inc_where;
99 unsigned int inc_index;
100 int64_t inc_new_value;
103 struct hmap inserted_rows; /* Contains "struct ovsdb_idl_txn_insert"s. */
106 struct ovsdb_idl_txn_insert {
107 struct hmap_node hmap_node; /* In struct ovsdb_idl_txn's inserted_rows. */
108 struct uuid dummy; /* Dummy UUID used locally. */
109 int op_index; /* Index into transaction's operation array. */
110 struct uuid real; /* Real UUID used by database server. */
113 static struct vlog_rate_limit syntax_rl = VLOG_RATE_LIMIT_INIT(1, 5);
114 static struct vlog_rate_limit semantic_rl = VLOG_RATE_LIMIT_INIT(1, 5);
116 static void ovsdb_idl_clear(struct ovsdb_idl *);
117 static void ovsdb_idl_send_monitor_request(struct ovsdb_idl *);
118 static void ovsdb_idl_parse_update(struct ovsdb_idl *, const struct json *);
119 static struct ovsdb_error *ovsdb_idl_parse_update__(struct ovsdb_idl *,
120 const struct json *);
121 static bool ovsdb_idl_process_update(struct ovsdb_idl_table *,
123 const struct json *old,
124 const struct json *new);
125 static void ovsdb_idl_insert_row(struct ovsdb_idl_row *, const struct json *);
126 static void ovsdb_idl_delete_row(struct ovsdb_idl_row *);
127 static bool ovsdb_idl_modify_row(struct ovsdb_idl_row *, const struct json *);
129 static bool ovsdb_idl_row_is_orphan(const struct ovsdb_idl_row *);
130 static struct ovsdb_idl_row *ovsdb_idl_row_create__(
131 const struct ovsdb_idl_table_class *);
132 static struct ovsdb_idl_row *ovsdb_idl_row_create(struct ovsdb_idl_table *,
133 const struct uuid *);
134 static void ovsdb_idl_row_destroy(struct ovsdb_idl_row *);
136 static void ovsdb_idl_row_parse(struct ovsdb_idl_row *);
137 static void ovsdb_idl_row_unparse(struct ovsdb_idl_row *);
138 static void ovsdb_idl_row_clear_old(struct ovsdb_idl_row *);
139 static void ovsdb_idl_row_clear_new(struct ovsdb_idl_row *);
141 static void ovsdb_idl_txn_abort_all(struct ovsdb_idl *);
142 static bool ovsdb_idl_txn_process_reply(struct ovsdb_idl *,
143 const struct jsonrpc_msg *msg);
145 static void ovsdb_idl_send_lock_request(struct ovsdb_idl *);
146 static void ovsdb_idl_send_unlock_request(struct ovsdb_idl *);
147 static void ovsdb_idl_parse_lock_reply(struct ovsdb_idl *,
148 const struct json *);
149 static void ovsdb_idl_parse_lock_notify(struct ovsdb_idl *,
150 const struct json *params,
153 /* Creates and returns a connection to database 'remote', which should be in a
154 * form acceptable to jsonrpc_session_open(). The connection will maintain an
155 * in-memory replica of the remote database whose schema is described by
156 * 'class'. (Ordinarily 'class' is compiled from an OVSDB schema automatically
159 * If 'monitor_everything_by_default' is true, then everything in the remote
160 * database will be replicated by default. ovsdb_idl_omit() and
161 * ovsdb_idl_omit_alert() may be used to selectively drop some columns from
164 * If 'monitor_everything_by_default' is false, then no columns or tables will
165 * be replicated by default. ovsdb_idl_add_column() and ovsdb_idl_add_table()
166 * must be used to choose some columns or tables to replicate.
169 ovsdb_idl_create(const char *remote, const struct ovsdb_idl_class *class,
170 bool monitor_everything_by_default)
172 struct ovsdb_idl *idl;
173 uint8_t default_mode;
176 default_mode = (monitor_everything_by_default
177 ? OVSDB_IDL_MONITOR | OVSDB_IDL_ALERT
180 idl = xzalloc(sizeof *idl);
182 idl->session = jsonrpc_session_open(remote);
183 shash_init(&idl->table_by_name);
184 idl->tables = xmalloc(class->n_tables * sizeof *idl->tables);
185 for (i = 0; i < class->n_tables; i++) {
186 const struct ovsdb_idl_table_class *tc = &class->tables[i];
187 struct ovsdb_idl_table *table = &idl->tables[i];
190 shash_add_assert(&idl->table_by_name, tc->name, table);
192 table->modes = xmalloc(tc->n_columns);
193 memset(table->modes, default_mode, tc->n_columns);
194 table->need_table = false;
195 shash_init(&table->columns);
196 for (j = 0; j < tc->n_columns; j++) {
197 const struct ovsdb_idl_column *column = &tc->columns[j];
199 shash_add_assert(&table->columns, column->name, column);
201 hmap_init(&table->rows);
204 idl->last_monitor_request_seqno = UINT_MAX;
205 hmap_init(&idl->outstanding_txns);
210 /* Destroys 'idl' and all of the data structures that it manages. */
212 ovsdb_idl_destroy(struct ovsdb_idl *idl)
218 ovsdb_idl_clear(idl);
219 jsonrpc_session_close(idl->session);
221 for (i = 0; i < idl->class->n_tables; i++) {
222 struct ovsdb_idl_table *table = &idl->tables[i];
223 shash_destroy(&table->columns);
224 hmap_destroy(&table->rows);
227 shash_destroy(&idl->table_by_name);
229 json_destroy(idl->monitor_request_id);
230 free(idl->lock_name);
231 json_destroy(idl->lock_request_id);
237 ovsdb_idl_clear(struct ovsdb_idl *idl)
239 bool changed = false;
242 for (i = 0; i < idl->class->n_tables; i++) {
243 struct ovsdb_idl_table *table = &idl->tables[i];
244 struct ovsdb_idl_row *row, *next_row;
246 if (hmap_is_empty(&table->rows)) {
251 HMAP_FOR_EACH_SAFE (row, next_row, hmap_node, &table->rows) {
252 struct ovsdb_idl_arc *arc, *next_arc;
254 if (!ovsdb_idl_row_is_orphan(row)) {
255 ovsdb_idl_row_unparse(row);
257 LIST_FOR_EACH_SAFE (arc, next_arc, src_node, &row->src_arcs) {
260 /* No need to do anything with dst_arcs: some node has those arcs
261 * as forward arcs and will destroy them itself. */
263 ovsdb_idl_row_destroy(row);
272 /* Processes a batch of messages from the database server on 'idl'. Returns
273 * true if the database as seen through 'idl' changed, false if it did not
274 * change. The initial fetch of the entire contents of the remote database is
275 * considered to be one kind of change. If 'idl' has been configured to
276 * acquire a database lock (with ovsdb_idl_set_lock()), then successfully
277 * acquiring the lock is also considered to be a change.
279 * When this function returns false, the client may continue to use any data
280 * structures it obtained from 'idl' in the past. But when it returns true,
281 * the client must not access any of these data structures again, because they
282 * could have freed or reused for other purposes.
284 * This function can return occasional false positives, that is, report that
285 * the database changed even though it didn't. This happens if the connection
286 * to the database drops and reconnects, which causes the database contents to
287 * be reloaded even if they didn't change. (It could also happen if the
288 * database server sends out a "change" that reflects what we already thought
289 * was in the database, but the database server is not supposed to do that.)
291 * As an alternative to checking the return value, the client may check for
292 * changes in the value returned by ovsdb_idl_get_seqno().
295 ovsdb_idl_run(struct ovsdb_idl *idl)
297 unsigned int initial_change_seqno = idl->change_seqno;
301 jsonrpc_session_run(idl->session);
302 for (i = 0; jsonrpc_session_is_connected(idl->session) && i < 50; i++) {
303 struct jsonrpc_msg *msg;
306 seqno = jsonrpc_session_get_seqno(idl->session);
307 if (idl->last_monitor_request_seqno != seqno) {
308 idl->last_monitor_request_seqno = seqno;
309 ovsdb_idl_txn_abort_all(idl);
310 ovsdb_idl_send_monitor_request(idl);
311 if (idl->lock_name) {
312 ovsdb_idl_send_lock_request(idl);
317 msg = jsonrpc_session_recv(idl->session);
322 if (msg->type == JSONRPC_NOTIFY
323 && !strcmp(msg->method, "update")
324 && msg->params->type == JSON_ARRAY
325 && msg->params->u.array.n == 2
326 && msg->params->u.array.elems[0]->type == JSON_NULL) {
327 /* Database contents changed. */
328 ovsdb_idl_parse_update(idl, msg->params->u.array.elems[1]);
329 } else if (msg->type == JSONRPC_REPLY
330 && idl->monitor_request_id
331 && json_equal(idl->monitor_request_id, msg->id)) {
332 /* Reply to our "monitor" request. */
334 json_destroy(idl->monitor_request_id);
335 idl->monitor_request_id = NULL;
336 ovsdb_idl_clear(idl);
337 ovsdb_idl_parse_update(idl, msg->result);
338 } else if (msg->type == JSONRPC_REPLY
339 && idl->lock_request_id
340 && json_equal(idl->lock_request_id, msg->id)) {
341 /* Reply to our "lock" request. */
342 ovsdb_idl_parse_lock_reply(idl, msg->result);
343 } else if (msg->type == JSONRPC_NOTIFY
344 && !strcmp(msg->method, "locked")) {
345 /* We got our lock. */
346 ovsdb_idl_parse_lock_notify(idl, msg->params, true);
347 } else if (msg->type == JSONRPC_NOTIFY
348 && !strcmp(msg->method, "stolen")) {
349 /* Someone else stole our lock. */
350 ovsdb_idl_parse_lock_notify(idl, msg->params, false);
351 } else if (msg->type == JSONRPC_REPLY && msg->id->type == JSON_STRING
352 && !strcmp(msg->id->u.string, "echo")) {
353 /* Reply to our echo request. Ignore it. */
354 } else if ((msg->type == JSONRPC_ERROR
355 || msg->type == JSONRPC_REPLY)
356 && ovsdb_idl_txn_process_reply(idl, msg)) {
357 /* ovsdb_idl_txn_process_reply() did everything needful. */
359 /* This can happen if ovsdb_idl_txn_destroy() is called to destroy
360 * a transaction before we receive the reply, so keep the log level
362 VLOG_DBG("%s: received unexpected %s message",
363 jsonrpc_session_get_name(idl->session),
364 jsonrpc_msg_type_to_string(msg->type));
366 jsonrpc_msg_destroy(msg);
369 return initial_change_seqno != idl->change_seqno;
372 /* Arranges for poll_block() to wake up when ovsdb_idl_run() has something to
373 * do or when activity occurs on a transaction on 'idl'. */
375 ovsdb_idl_wait(struct ovsdb_idl *idl)
377 jsonrpc_session_wait(idl->session);
378 jsonrpc_session_recv_wait(idl->session);
381 /* Returns a number that represents the state of 'idl'. When 'idl' is updated
382 * (by ovsdb_idl_run()), the return value changes. */
384 ovsdb_idl_get_seqno(const struct ovsdb_idl *idl)
386 return idl->change_seqno;
389 /* Returns true if 'idl' successfully connected to the remote database and
390 * retrieved its contents (even if the connection subsequently dropped and is
391 * in the process of reconnecting). If so, then 'idl' contains an atomic
392 * snapshot of the database's contents (but it might be arbitrarily old if the
393 * connection dropped).
395 * Returns false if 'idl' has never connected or retrieved the database's
396 * contents. If so, 'idl' is empty. */
398 ovsdb_idl_has_ever_connected(const struct ovsdb_idl *idl)
400 return ovsdb_idl_get_seqno(idl) != 0;
403 /* Forces 'idl' to drop its connection to the database and reconnect. In the
404 * meantime, the contents of 'idl' will not change. */
406 ovsdb_idl_force_reconnect(struct ovsdb_idl *idl)
408 jsonrpc_session_force_reconnect(idl->session);
411 static unsigned char *
412 ovsdb_idl_get_mode(struct ovsdb_idl *idl,
413 const struct ovsdb_idl_column *column)
417 assert(!idl->change_seqno);
419 for (i = 0; i < idl->class->n_tables; i++) {
420 const struct ovsdb_idl_table *table = &idl->tables[i];
421 const struct ovsdb_idl_table_class *tc = table->class;
423 if (column >= tc->columns && column < &tc->columns[tc->n_columns]) {
424 return &table->modes[column - tc->columns];
432 add_ref_table(struct ovsdb_idl *idl, const struct ovsdb_base_type *base)
434 if (base->type == OVSDB_TYPE_UUID && base->u.uuid.refTableName) {
435 struct ovsdb_idl_table *table;
437 table = shash_find_data(&idl->table_by_name,
438 base->u.uuid.refTableName);
440 table->need_table = true;
442 VLOG_WARN("%s IDL class missing referenced table %s",
443 idl->class->database, base->u.uuid.refTableName);
448 /* Turns on OVSDB_IDL_MONITOR and OVSDB_IDL_ALERT for 'column' in 'idl'. Also
449 * ensures that any tables referenced by 'column' will be replicated, even if
450 * no columns in that table are selected for replication (see
451 * ovsdb_idl_add_table() for more information).
453 * This function is only useful if 'monitor_everything_by_default' was false in
454 * the call to ovsdb_idl_create(). This function should be called between
455 * ovsdb_idl_create() and the first call to ovsdb_idl_run().
458 ovsdb_idl_add_column(struct ovsdb_idl *idl,
459 const struct ovsdb_idl_column *column)
461 *ovsdb_idl_get_mode(idl, column) = OVSDB_IDL_MONITOR | OVSDB_IDL_ALERT;
462 add_ref_table(idl, &column->type.key);
463 add_ref_table(idl, &column->type.value);
466 /* Ensures that the table with class 'tc' will be replicated on 'idl' even if
467 * no columns are selected for replication. This can be useful because it
468 * allows 'idl' to keep track of what rows in the table actually exist, which
469 * in turn allows columns that reference the table to have accurate contents.
470 * (The IDL presents the database with references to rows that do not exist
473 * This function is only useful if 'monitor_everything_by_default' was false in
474 * the call to ovsdb_idl_create(). This function should be called between
475 * ovsdb_idl_create() and the first call to ovsdb_idl_run().
478 ovsdb_idl_add_table(struct ovsdb_idl *idl,
479 const struct ovsdb_idl_table_class *tc)
483 for (i = 0; i < idl->class->n_tables; i++) {
484 struct ovsdb_idl_table *table = &idl->tables[i];
486 if (table->class == tc) {
487 table->need_table = true;
495 /* Turns off OVSDB_IDL_ALERT for 'column' in 'idl'.
497 * This function should be called between ovsdb_idl_create() and the first call
498 * to ovsdb_idl_run().
501 ovsdb_idl_omit_alert(struct ovsdb_idl *idl,
502 const struct ovsdb_idl_column *column)
504 *ovsdb_idl_get_mode(idl, column) &= ~OVSDB_IDL_ALERT;
507 /* Sets the mode for 'column' in 'idl' to 0. See the big comment above
508 * OVSDB_IDL_MONITOR for details.
510 * This function should be called between ovsdb_idl_create() and the first call
511 * to ovsdb_idl_run().
514 ovsdb_idl_omit(struct ovsdb_idl *idl, const struct ovsdb_idl_column *column)
516 *ovsdb_idl_get_mode(idl, column) = 0;
520 ovsdb_idl_send_monitor_request(struct ovsdb_idl *idl)
522 struct json *monitor_requests;
523 struct jsonrpc_msg *msg;
526 monitor_requests = json_object_create();
527 for (i = 0; i < idl->class->n_tables; i++) {
528 const struct ovsdb_idl_table *table = &idl->tables[i];
529 const struct ovsdb_idl_table_class *tc = table->class;
530 struct json *monitor_request, *columns;
533 columns = table->need_table ? json_array_create_empty() : NULL;
534 for (j = 0; j < tc->n_columns; j++) {
535 const struct ovsdb_idl_column *column = &tc->columns[j];
536 if (table->modes[j] & OVSDB_IDL_MONITOR) {
538 columns = json_array_create_empty();
540 json_array_add(columns, json_string_create(column->name));
545 monitor_request = json_object_create();
546 json_object_put(monitor_request, "columns", columns);
547 json_object_put(monitor_requests, tc->name, monitor_request);
551 json_destroy(idl->monitor_request_id);
552 msg = jsonrpc_create_request(
554 json_array_create_3(json_string_create(idl->class->database),
555 json_null_create(), monitor_requests),
556 &idl->monitor_request_id);
557 jsonrpc_session_send(idl->session, msg);
561 ovsdb_idl_parse_update(struct ovsdb_idl *idl, const struct json *table_updates)
563 struct ovsdb_error *error = ovsdb_idl_parse_update__(idl, table_updates);
565 if (!VLOG_DROP_WARN(&syntax_rl)) {
566 char *s = ovsdb_error_to_string(error);
567 VLOG_WARN_RL(&syntax_rl, "%s", s);
570 ovsdb_error_destroy(error);
574 static struct ovsdb_error *
575 ovsdb_idl_parse_update__(struct ovsdb_idl *idl,
576 const struct json *table_updates)
578 const struct shash_node *tables_node;
580 if (table_updates->type != JSON_OBJECT) {
581 return ovsdb_syntax_error(table_updates, NULL,
582 "<table-updates> is not an object");
584 SHASH_FOR_EACH (tables_node, json_object(table_updates)) {
585 const struct json *table_update = tables_node->data;
586 const struct shash_node *table_node;
587 struct ovsdb_idl_table *table;
589 table = shash_find_data(&idl->table_by_name, tables_node->name);
591 return ovsdb_syntax_error(
593 "<table-updates> includes unknown table \"%s\"",
597 if (table_update->type != JSON_OBJECT) {
598 return ovsdb_syntax_error(table_update, NULL,
599 "<table-update> for table \"%s\" is "
600 "not an object", table->class->name);
602 SHASH_FOR_EACH (table_node, json_object(table_update)) {
603 const struct json *row_update = table_node->data;
604 const struct json *old_json, *new_json;
607 if (!uuid_from_string(&uuid, table_node->name)) {
608 return ovsdb_syntax_error(table_update, NULL,
609 "<table-update> for table \"%s\" "
611 "\"%s\" as member name",
615 if (row_update->type != JSON_OBJECT) {
616 return ovsdb_syntax_error(row_update, NULL,
617 "<table-update> for table \"%s\" "
618 "contains <row-update> for %s that "
624 old_json = shash_find_data(json_object(row_update), "old");
625 new_json = shash_find_data(json_object(row_update), "new");
626 if (old_json && old_json->type != JSON_OBJECT) {
627 return ovsdb_syntax_error(old_json, NULL,
628 "\"old\" <row> is not object");
629 } else if (new_json && new_json->type != JSON_OBJECT) {
630 return ovsdb_syntax_error(new_json, NULL,
631 "\"new\" <row> is not object");
632 } else if ((old_json != NULL) + (new_json != NULL)
633 != shash_count(json_object(row_update))) {
634 return ovsdb_syntax_error(row_update, NULL,
635 "<row-update> contains unexpected "
637 } else if (!old_json && !new_json) {
638 return ovsdb_syntax_error(row_update, NULL,
639 "<row-update> missing \"old\" "
640 "and \"new\" members");
643 if (ovsdb_idl_process_update(table, &uuid, old_json, new_json)) {
652 static struct ovsdb_idl_row *
653 ovsdb_idl_get_row(struct ovsdb_idl_table *table, const struct uuid *uuid)
655 struct ovsdb_idl_row *row;
657 HMAP_FOR_EACH_WITH_HASH (row, hmap_node, uuid_hash(uuid), &table->rows) {
658 if (uuid_equals(&row->uuid, uuid)) {
665 /* Returns true if a column with mode OVSDB_IDL_MODE_RW changed, false
668 ovsdb_idl_process_update(struct ovsdb_idl_table *table,
669 const struct uuid *uuid, const struct json *old,
670 const struct json *new)
672 struct ovsdb_idl_row *row;
674 row = ovsdb_idl_get_row(table, uuid);
677 if (row && !ovsdb_idl_row_is_orphan(row)) {
678 /* XXX perhaps we should check the 'old' values? */
679 ovsdb_idl_delete_row(row);
681 VLOG_WARN_RL(&semantic_rl, "cannot delete missing row "UUID_FMT" "
683 UUID_ARGS(uuid), table->class->name);
689 ovsdb_idl_insert_row(ovsdb_idl_row_create(table, uuid), new);
690 } else if (ovsdb_idl_row_is_orphan(row)) {
691 ovsdb_idl_insert_row(row, new);
693 VLOG_WARN_RL(&semantic_rl, "cannot add existing row "UUID_FMT" to "
694 "table %s", UUID_ARGS(uuid), table->class->name);
695 return ovsdb_idl_modify_row(row, new);
700 /* XXX perhaps we should check the 'old' values? */
701 if (!ovsdb_idl_row_is_orphan(row)) {
702 return ovsdb_idl_modify_row(row, new);
704 VLOG_WARN_RL(&semantic_rl, "cannot modify missing but "
705 "referenced row "UUID_FMT" in table %s",
706 UUID_ARGS(uuid), table->class->name);
707 ovsdb_idl_insert_row(row, new);
710 VLOG_WARN_RL(&semantic_rl, "cannot modify missing row "UUID_FMT" "
711 "in table %s", UUID_ARGS(uuid), table->class->name);
712 ovsdb_idl_insert_row(ovsdb_idl_row_create(table, uuid), new);
719 /* Returns true if a column with mode OVSDB_IDL_MODE_RW changed, false
722 ovsdb_idl_row_update(struct ovsdb_idl_row *row, const struct json *row_json)
724 struct ovsdb_idl_table *table = row->table;
725 struct shash_node *node;
726 bool changed = false;
728 SHASH_FOR_EACH (node, json_object(row_json)) {
729 const char *column_name = node->name;
730 const struct ovsdb_idl_column *column;
731 struct ovsdb_datum datum;
732 struct ovsdb_error *error;
734 column = shash_find_data(&table->columns, column_name);
736 VLOG_WARN_RL(&syntax_rl, "unknown column %s updating row "UUID_FMT,
737 column_name, UUID_ARGS(&row->uuid));
741 error = ovsdb_datum_from_json(&datum, &column->type, node->data, NULL);
743 unsigned int column_idx = column - table->class->columns;
744 struct ovsdb_datum *old = &row->old[column_idx];
746 if (!ovsdb_datum_equals(old, &datum, &column->type)) {
747 ovsdb_datum_swap(old, &datum);
748 if (table->modes[column_idx] & OVSDB_IDL_ALERT) {
752 /* Didn't really change but the OVSDB monitor protocol always
753 * includes every value in a row. */
756 ovsdb_datum_destroy(&datum, &column->type);
758 char *s = ovsdb_error_to_string(error);
759 VLOG_WARN_RL(&syntax_rl, "error parsing column %s in row "UUID_FMT
760 " in table %s: %s", column_name,
761 UUID_ARGS(&row->uuid), table->class->name, s);
763 ovsdb_error_destroy(error);
769 /* When a row A refers to row B through a column with a "refTable" constraint,
770 * but row B does not exist, row B is called an "orphan row". Orphan rows
771 * should not persist, because the database enforces referential integrity, but
772 * they can appear transiently as changes from the database are received (the
773 * database doesn't try to topologically sort them and circular references mean
774 * it isn't always possible anyhow).
776 * This function returns true if 'row' is an orphan row, otherwise false.
779 ovsdb_idl_row_is_orphan(const struct ovsdb_idl_row *row)
781 return !row->old && !row->new;
784 /* Returns true if 'row' is conceptually part of the database as modified by
785 * the current transaction (if any), false otherwise.
787 * This function will return true if 'row' is not an orphan (see the comment on
788 * ovsdb_idl_row_is_orphan()) and:
790 * - 'row' exists in the database and has not been deleted within the
791 * current transaction (if any).
793 * - 'row' was inserted within the current transaction and has not been
794 * deleted. (In the latter case you should not have passed 'row' in at
795 * all, because ovsdb_idl_txn_delete() freed it.)
797 * This function will return false if 'row' is an orphan or if 'row' was
798 * deleted within the current transaction.
801 ovsdb_idl_row_exists(const struct ovsdb_idl_row *row)
803 return row->new != NULL;
807 ovsdb_idl_row_parse(struct ovsdb_idl_row *row)
809 const struct ovsdb_idl_table_class *class = row->table->class;
812 for (i = 0; i < class->n_columns; i++) {
813 const struct ovsdb_idl_column *c = &class->columns[i];
814 (c->parse)(row, &row->old[i]);
819 ovsdb_idl_row_unparse(struct ovsdb_idl_row *row)
821 const struct ovsdb_idl_table_class *class = row->table->class;
824 for (i = 0; i < class->n_columns; i++) {
825 const struct ovsdb_idl_column *c = &class->columns[i];
831 ovsdb_idl_row_clear_old(struct ovsdb_idl_row *row)
833 assert(row->old == row->new);
834 if (!ovsdb_idl_row_is_orphan(row)) {
835 const struct ovsdb_idl_table_class *class = row->table->class;
838 for (i = 0; i < class->n_columns; i++) {
839 ovsdb_datum_destroy(&row->old[i], &class->columns[i].type);
842 row->old = row->new = NULL;
847 ovsdb_idl_row_clear_new(struct ovsdb_idl_row *row)
849 if (row->old != row->new) {
851 const struct ovsdb_idl_table_class *class = row->table->class;
855 BITMAP_FOR_EACH_1 (i, class->n_columns, row->written) {
856 ovsdb_datum_destroy(&row->new[i], &class->columns[i].type);
868 ovsdb_idl_row_clear_arcs(struct ovsdb_idl_row *row, bool destroy_dsts)
870 struct ovsdb_idl_arc *arc, *next;
872 /* Delete all forward arcs. If 'destroy_dsts', destroy any orphaned rows
873 * that this causes to be unreferenced. */
874 LIST_FOR_EACH_SAFE (arc, next, src_node, &row->src_arcs) {
875 list_remove(&arc->dst_node);
877 && ovsdb_idl_row_is_orphan(arc->dst)
878 && list_is_empty(&arc->dst->dst_arcs)) {
879 ovsdb_idl_row_destroy(arc->dst);
883 list_init(&row->src_arcs);
886 /* Force nodes that reference 'row' to reparse. */
888 ovsdb_idl_row_reparse_backrefs(struct ovsdb_idl_row *row)
890 struct ovsdb_idl_arc *arc, *next;
892 /* This is trickier than it looks. ovsdb_idl_row_clear_arcs() will destroy
893 * 'arc', so we need to use the "safe" variant of list traversal. However,
894 * calling an ovsdb_idl_column's 'parse' function will add an arc
895 * equivalent to 'arc' to row->arcs. That could be a problem for
896 * traversal, but it adds it at the beginning of the list to prevent us
897 * from stumbling upon it again.
899 * (If duplicate arcs were possible then we would need to make sure that
900 * 'next' didn't also point into 'arc''s destination, but we forbid
901 * duplicate arcs.) */
902 LIST_FOR_EACH_SAFE (arc, next, dst_node, &row->dst_arcs) {
903 struct ovsdb_idl_row *ref = arc->src;
905 ovsdb_idl_row_unparse(ref);
906 ovsdb_idl_row_clear_arcs(ref, false);
907 ovsdb_idl_row_parse(ref);
911 static struct ovsdb_idl_row *
912 ovsdb_idl_row_create__(const struct ovsdb_idl_table_class *class)
914 struct ovsdb_idl_row *row = xzalloc(class->allocation_size);
915 list_init(&row->src_arcs);
916 list_init(&row->dst_arcs);
917 hmap_node_nullify(&row->txn_node);
921 static struct ovsdb_idl_row *
922 ovsdb_idl_row_create(struct ovsdb_idl_table *table, const struct uuid *uuid)
924 struct ovsdb_idl_row *row = ovsdb_idl_row_create__(table->class);
925 hmap_insert(&table->rows, &row->hmap_node, uuid_hash(uuid));
932 ovsdb_idl_row_destroy(struct ovsdb_idl_row *row)
935 ovsdb_idl_row_clear_old(row);
936 hmap_remove(&row->table->rows, &row->hmap_node);
942 ovsdb_idl_insert_row(struct ovsdb_idl_row *row, const struct json *row_json)
944 const struct ovsdb_idl_table_class *class = row->table->class;
947 assert(!row->old && !row->new);
948 row->old = row->new = xmalloc(class->n_columns * sizeof *row->old);
949 for (i = 0; i < class->n_columns; i++) {
950 ovsdb_datum_init_default(&row->old[i], &class->columns[i].type);
952 ovsdb_idl_row_update(row, row_json);
953 ovsdb_idl_row_parse(row);
955 ovsdb_idl_row_reparse_backrefs(row);
959 ovsdb_idl_delete_row(struct ovsdb_idl_row *row)
961 ovsdb_idl_row_unparse(row);
962 ovsdb_idl_row_clear_arcs(row, true);
963 ovsdb_idl_row_clear_old(row);
964 if (list_is_empty(&row->dst_arcs)) {
965 ovsdb_idl_row_destroy(row);
967 ovsdb_idl_row_reparse_backrefs(row);
971 /* Returns true if a column with mode OVSDB_IDL_MODE_RW changed, false
974 ovsdb_idl_modify_row(struct ovsdb_idl_row *row, const struct json *row_json)
978 ovsdb_idl_row_unparse(row);
979 ovsdb_idl_row_clear_arcs(row, true);
980 changed = ovsdb_idl_row_update(row, row_json);
981 ovsdb_idl_row_parse(row);
987 may_add_arc(const struct ovsdb_idl_row *src, const struct ovsdb_idl_row *dst)
989 const struct ovsdb_idl_arc *arc;
996 /* No duplicate arcs.
998 * We only need to test whether the first arc in dst->dst_arcs originates
999 * at 'src', since we add all of the arcs from a given source in a clump
1000 * (in a single call to ovsdb_idl_row_parse()) and new arcs are always
1001 * added at the front of the dst_arcs list. */
1002 if (list_is_empty(&dst->dst_arcs)) {
1005 arc = CONTAINER_OF(dst->dst_arcs.next, struct ovsdb_idl_arc, dst_node);
1006 return arc->src != src;
1009 static struct ovsdb_idl_table *
1010 ovsdb_idl_table_from_class(const struct ovsdb_idl *idl,
1011 const struct ovsdb_idl_table_class *table_class)
1013 return &idl->tables[table_class - idl->class->tables];
1016 struct ovsdb_idl_row *
1017 ovsdb_idl_get_row_arc(struct ovsdb_idl_row *src,
1018 struct ovsdb_idl_table_class *dst_table_class,
1019 const struct uuid *dst_uuid)
1021 struct ovsdb_idl *idl = src->table->idl;
1022 struct ovsdb_idl_table *dst_table;
1023 struct ovsdb_idl_arc *arc;
1024 struct ovsdb_idl_row *dst;
1026 dst_table = ovsdb_idl_table_from_class(idl, dst_table_class);
1027 dst = ovsdb_idl_get_row(dst_table, dst_uuid);
1029 /* We're being called from ovsdb_idl_txn_write(). We must not update
1030 * any arcs, because the transaction will be backed out at commit or
1031 * abort time and we don't want our graph screwed up.
1033 * Just return the destination row, if there is one and it has not been
1035 if (dst && (hmap_node_is_null(&dst->txn_node) || dst->new)) {
1040 /* We're being called from some other context. Update the graph. */
1042 dst = ovsdb_idl_row_create(dst_table, dst_uuid);
1045 /* Add a new arc, if it wouldn't be a self-arc or a duplicate arc. */
1046 if (may_add_arc(src, dst)) {
1047 /* The arc *must* be added at the front of the dst_arcs list. See
1048 * ovsdb_idl_row_reparse_backrefs() for details. */
1049 arc = xmalloc(sizeof *arc);
1050 list_push_front(&src->src_arcs, &arc->src_node);
1051 list_push_front(&dst->dst_arcs, &arc->dst_node);
1056 return !ovsdb_idl_row_is_orphan(dst) ? dst : NULL;
1060 const struct ovsdb_idl_row *
1061 ovsdb_idl_get_row_for_uuid(const struct ovsdb_idl *idl,
1062 const struct ovsdb_idl_table_class *tc,
1063 const struct uuid *uuid)
1065 return ovsdb_idl_get_row(ovsdb_idl_table_from_class(idl, tc), uuid);
1068 static struct ovsdb_idl_row *
1069 next_real_row(struct ovsdb_idl_table *table, struct hmap_node *node)
1071 for (; node; node = hmap_next(&table->rows, node)) {
1072 struct ovsdb_idl_row *row;
1074 row = CONTAINER_OF(node, struct ovsdb_idl_row, hmap_node);
1075 if (ovsdb_idl_row_exists(row)) {
1082 const struct ovsdb_idl_row *
1083 ovsdb_idl_first_row(const struct ovsdb_idl *idl,
1084 const struct ovsdb_idl_table_class *table_class)
1086 struct ovsdb_idl_table *table
1087 = ovsdb_idl_table_from_class(idl, table_class);
1088 return next_real_row(table, hmap_first(&table->rows));
1091 const struct ovsdb_idl_row *
1092 ovsdb_idl_next_row(const struct ovsdb_idl_row *row)
1094 struct ovsdb_idl_table *table = row->table;
1096 return next_real_row(table, hmap_next(&table->rows, &row->hmap_node));
1099 /* Reads and returns the value of 'column' within 'row'. If an ongoing
1100 * transaction has changed 'column''s value, the modified value is returned.
1102 * The caller must not modify or free the returned value.
1104 * Various kinds of changes can invalidate the returned value: writing to the
1105 * same 'column' in 'row' (e.g. with ovsdb_idl_txn_write()), deleting 'row'
1106 * (e.g. with ovsdb_idl_txn_delete()), or completing an ongoing transaction
1107 * (e.g. with ovsdb_idl_txn_commit() or ovsdb_idl_txn_abort()). If the
1108 * returned value is needed for a long time, it is best to make a copy of it
1109 * with ovsdb_datum_clone(). */
1110 const struct ovsdb_datum *
1111 ovsdb_idl_read(const struct ovsdb_idl_row *row,
1112 const struct ovsdb_idl_column *column)
1114 const struct ovsdb_idl_table_class *class = row->table->class;
1115 size_t column_idx = column - class->columns;
1117 assert(row->new != NULL);
1118 assert(column_idx < class->n_columns);
1120 if (row->written && bitmap_is_set(row->written, column_idx)) {
1121 return &row->new[column_idx];
1122 } else if (row->old) {
1123 return &row->old[column_idx];
1125 return ovsdb_datum_default(&column->type);
1129 /* Same as ovsdb_idl_read(), except that it also asserts that 'column' has key
1130 * type 'key_type' and value type 'value_type'. (Scalar and set types will
1131 * have a value type of OVSDB_TYPE_VOID.)
1133 * This is useful in code that "knows" that a particular column has a given
1134 * type, so that it will abort if someone changes the column's type without
1135 * updating the code that uses it. */
1136 const struct ovsdb_datum *
1137 ovsdb_idl_get(const struct ovsdb_idl_row *row,
1138 const struct ovsdb_idl_column *column,
1139 enum ovsdb_atomic_type key_type OVS_UNUSED,
1140 enum ovsdb_atomic_type value_type OVS_UNUSED)
1142 assert(column->type.key.type == key_type);
1143 assert(column->type.value.type == value_type);
1145 return ovsdb_idl_read(row, column);
1148 /* Returns false if 'row' was obtained from the IDL, true if it was initialized
1149 * to all-zero-bits by some other entity. If 'row' was set up some other way
1150 * then the return value is indeterminate. */
1152 ovsdb_idl_row_is_synthetic(const struct ovsdb_idl_row *row)
1154 return row->table == NULL;
1159 static void ovsdb_idl_txn_complete(struct ovsdb_idl_txn *txn,
1160 enum ovsdb_idl_txn_status);
1163 ovsdb_idl_txn_status_to_string(enum ovsdb_idl_txn_status status)
1166 case TXN_UNCOMMITTED:
1167 return "uncommitted";
1170 case TXN_INCOMPLETE:
1171 return "incomplete";
1178 case TXN_NOT_LOCKED:
1179 return "not locked";
1186 struct ovsdb_idl_txn *
1187 ovsdb_idl_txn_create(struct ovsdb_idl *idl)
1189 struct ovsdb_idl_txn *txn;
1192 idl->txn = txn = xmalloc(sizeof *txn);
1193 txn->request_id = NULL;
1195 hmap_init(&txn->txn_rows);
1196 txn->status = TXN_UNCOMMITTED;
1198 txn->dry_run = false;
1199 ds_init(&txn->comment);
1201 txn->inc_table = NULL;
1202 txn->inc_column = NULL;
1203 txn->inc_where = NULL;
1205 hmap_init(&txn->inserted_rows);
1210 /* Appends 's', which is treated as a printf()-type format string, to the
1211 * comments that will be passed to the OVSDB server when 'txn' is committed.
1212 * (The comment will be committed to the OVSDB log, which "ovsdb-tool
1213 * show-log" can print in a relatively human-readable form.) */
1215 ovsdb_idl_txn_add_comment(struct ovsdb_idl_txn *txn, const char *s, ...)
1219 if (txn->comment.length) {
1220 ds_put_char(&txn->comment, '\n');
1224 ds_put_format_valist(&txn->comment, s, args);
1229 ovsdb_idl_txn_set_dry_run(struct ovsdb_idl_txn *txn)
1231 txn->dry_run = true;
1235 ovsdb_idl_txn_increment(struct ovsdb_idl_txn *txn, const char *table,
1236 const char *column, const struct json *where)
1238 assert(!txn->inc_table);
1239 txn->inc_table = xstrdup(table);
1240 txn->inc_column = xstrdup(column);
1241 txn->inc_where = where ? json_clone(where) : json_array_create_empty();
1245 ovsdb_idl_txn_destroy(struct ovsdb_idl_txn *txn)
1247 struct ovsdb_idl_txn_insert *insert, *next;
1249 json_destroy(txn->request_id);
1250 if (txn->status == TXN_INCOMPLETE) {
1251 hmap_remove(&txn->idl->outstanding_txns, &txn->hmap_node);
1253 ovsdb_idl_txn_abort(txn);
1254 ds_destroy(&txn->comment);
1256 free(txn->inc_table);
1257 free(txn->inc_column);
1258 json_destroy(txn->inc_where);
1259 HMAP_FOR_EACH_SAFE (insert, next, hmap_node, &txn->inserted_rows) {
1262 hmap_destroy(&txn->inserted_rows);
1267 ovsdb_idl_txn_wait(const struct ovsdb_idl_txn *txn)
1269 if (txn->status != TXN_UNCOMMITTED && txn->status != TXN_INCOMPLETE) {
1270 poll_immediate_wake();
1274 static struct json *
1275 where_uuid_equals(const struct uuid *uuid)
1278 json_array_create_1(
1279 json_array_create_3(
1280 json_string_create("_uuid"),
1281 json_string_create("=="),
1282 json_array_create_2(
1283 json_string_create("uuid"),
1284 json_string_create_nocopy(
1285 xasprintf(UUID_FMT, UUID_ARGS(uuid))))));
1289 uuid_name_from_uuid(const struct uuid *uuid)
1294 name = xasprintf("row"UUID_FMT, UUID_ARGS(uuid));
1295 for (p = name; *p != '\0'; p++) {
1304 static const struct ovsdb_idl_row *
1305 ovsdb_idl_txn_get_row(const struct ovsdb_idl_txn *txn, const struct uuid *uuid)
1307 const struct ovsdb_idl_row *row;
1309 HMAP_FOR_EACH_WITH_HASH (row, txn_node, uuid_hash(uuid), &txn->txn_rows) {
1310 if (uuid_equals(&row->uuid, uuid)) {
1317 /* XXX there must be a cleaner way to do this */
1318 static struct json *
1319 substitute_uuids(struct json *json, const struct ovsdb_idl_txn *txn)
1321 if (json->type == JSON_ARRAY) {
1325 if (json->u.array.n == 2
1326 && json->u.array.elems[0]->type == JSON_STRING
1327 && json->u.array.elems[1]->type == JSON_STRING
1328 && !strcmp(json->u.array.elems[0]->u.string, "uuid")
1329 && uuid_from_string(&uuid, json->u.array.elems[1]->u.string)) {
1330 const struct ovsdb_idl_row *row;
1332 row = ovsdb_idl_txn_get_row(txn, &uuid);
1333 if (row && !row->old && row->new) {
1336 return json_array_create_2(
1337 json_string_create("named-uuid"),
1338 json_string_create_nocopy(uuid_name_from_uuid(&uuid)));
1342 for (i = 0; i < json->u.array.n; i++) {
1343 json->u.array.elems[i] = substitute_uuids(json->u.array.elems[i],
1346 } else if (json->type == JSON_OBJECT) {
1347 struct shash_node *node;
1349 SHASH_FOR_EACH (node, json_object(json)) {
1350 node->data = substitute_uuids(node->data, txn);
1357 ovsdb_idl_txn_disassemble(struct ovsdb_idl_txn *txn)
1359 struct ovsdb_idl_row *row, *next;
1361 /* This must happen early. Otherwise, ovsdb_idl_row_parse() will call an
1362 * ovsdb_idl_column's 'parse' function, which will call
1363 * ovsdb_idl_get_row_arc(), which will seen that the IDL is in a
1364 * transaction and fail to update the graph. */
1365 txn->idl->txn = NULL;
1367 HMAP_FOR_EACH_SAFE (row, next, txn_node, &txn->txn_rows) {
1370 ovsdb_idl_row_unparse(row);
1371 ovsdb_idl_row_clear_arcs(row, false);
1372 ovsdb_idl_row_parse(row);
1375 ovsdb_idl_row_unparse(row);
1377 ovsdb_idl_row_clear_new(row);
1380 row->prereqs = NULL;
1383 row->written = NULL;
1385 hmap_remove(&txn->txn_rows, &row->txn_node);
1386 hmap_node_nullify(&row->txn_node);
1388 hmap_remove(&row->table->rows, &row->hmap_node);
1392 hmap_destroy(&txn->txn_rows);
1393 hmap_init(&txn->txn_rows);
1396 enum ovsdb_idl_txn_status
1397 ovsdb_idl_txn_commit(struct ovsdb_idl_txn *txn)
1399 struct ovsdb_idl_row *row;
1400 struct json *operations;
1403 if (txn != txn->idl->txn) {
1407 /* If we need a lock but don't have it, give up quickly. */
1408 if (txn->idl->lock_name && !ovsdb_idl_has_lock(txn->idl)) {
1409 txn->status = TXN_NOT_LOCKED;
1410 ovsdb_idl_txn_disassemble(txn);
1414 operations = json_array_create_1(
1415 json_string_create(txn->idl->class->database));
1417 /* Assert that we have the required lock (avoiding a race). */
1418 if (txn->idl->lock_name) {
1419 struct json *op = json_object_create();
1420 json_array_add(operations, op);
1421 json_object_put_string(op, "op", "assert");
1422 json_object_put_string(op, "lock", txn->idl->lock_name);
1425 /* Add prerequisites and declarations of new rows. */
1426 HMAP_FOR_EACH (row, txn_node, &txn->txn_rows) {
1427 /* XXX check that deleted rows exist even if no prereqs? */
1429 const struct ovsdb_idl_table_class *class = row->table->class;
1430 size_t n_columns = class->n_columns;
1431 struct json *op, *columns, *row_json;
1434 op = json_object_create();
1435 json_array_add(operations, op);
1436 json_object_put_string(op, "op", "wait");
1437 json_object_put_string(op, "table", class->name);
1438 json_object_put(op, "timeout", json_integer_create(0));
1439 json_object_put(op, "where", where_uuid_equals(&row->uuid));
1440 json_object_put_string(op, "until", "==");
1441 columns = json_array_create_empty();
1442 json_object_put(op, "columns", columns);
1443 row_json = json_object_create();
1444 json_object_put(op, "rows", json_array_create_1(row_json));
1446 BITMAP_FOR_EACH_1 (idx, n_columns, row->prereqs) {
1447 const struct ovsdb_idl_column *column = &class->columns[idx];
1448 json_array_add(columns, json_string_create(column->name));
1449 json_object_put(row_json, column->name,
1450 ovsdb_datum_to_json(&row->old[idx],
1457 any_updates = false;
1458 HMAP_FOR_EACH (row, txn_node, &txn->txn_rows) {
1459 const struct ovsdb_idl_table_class *class = row->table->class;
1462 if (class->is_root) {
1463 struct json *op = json_object_create();
1464 json_object_put_string(op, "op", "delete");
1465 json_object_put_string(op, "table", class->name);
1466 json_object_put(op, "where", where_uuid_equals(&row->uuid));
1467 json_array_add(operations, op);
1470 /* Let ovsdb-server decide whether to really delete it. */
1472 } else if (row->old != row->new) {
1473 struct json *row_json;
1477 op = json_object_create();
1478 json_object_put_string(op, "op", row->old ? "update" : "insert");
1479 json_object_put_string(op, "table", class->name);
1481 json_object_put(op, "where", where_uuid_equals(&row->uuid));
1483 struct ovsdb_idl_txn_insert *insert;
1487 json_object_put(op, "uuid-name",
1488 json_string_create_nocopy(
1489 uuid_name_from_uuid(&row->uuid)));
1491 insert = xmalloc(sizeof *insert);
1492 insert->dummy = row->uuid;
1493 insert->op_index = operations->u.array.n - 1;
1494 uuid_zero(&insert->real);
1495 hmap_insert(&txn->inserted_rows, &insert->hmap_node,
1496 uuid_hash(&insert->dummy));
1498 row_json = json_object_create();
1499 json_object_put(op, "row", row_json);
1502 BITMAP_FOR_EACH_1 (idx, class->n_columns, row->written) {
1503 const struct ovsdb_idl_column *column =
1504 &class->columns[idx];
1507 || !ovsdb_datum_is_default(&row->new[idx],
1509 json_object_put(row_json, column->name,
1511 ovsdb_datum_to_json(&row->new[idx],
1515 /* If anything really changed, consider it an update.
1516 * We can't suppress not-really-changed values earlier
1517 * or transactions would become nonatomic (see the big
1518 * comment inside ovsdb_idl_txn_write()). */
1519 if (!any_updates && row->old &&
1520 !ovsdb_datum_equals(&row->old[idx], &row->new[idx],
1528 if (!row->old || !shash_is_empty(json_object(row_json))) {
1529 json_array_add(operations, op);
1536 /* Add increment. */
1537 if (txn->inc_table && any_updates) {
1540 txn->inc_index = operations->u.array.n - 1;
1542 op = json_object_create();
1543 json_object_put_string(op, "op", "mutate");
1544 json_object_put_string(op, "table", txn->inc_table);
1545 json_object_put(op, "where",
1546 substitute_uuids(json_clone(txn->inc_where), txn));
1547 json_object_put(op, "mutations",
1548 json_array_create_1(
1549 json_array_create_3(
1550 json_string_create(txn->inc_column),
1551 json_string_create("+="),
1552 json_integer_create(1))));
1553 json_array_add(operations, op);
1555 op = json_object_create();
1556 json_object_put_string(op, "op", "select");
1557 json_object_put_string(op, "table", txn->inc_table);
1558 json_object_put(op, "where",
1559 substitute_uuids(json_clone(txn->inc_where), txn));
1560 json_object_put(op, "columns",
1561 json_array_create_1(json_string_create(
1563 json_array_add(operations, op);
1566 if (txn->comment.length) {
1567 struct json *op = json_object_create();
1568 json_object_put_string(op, "op", "comment");
1569 json_object_put_string(op, "comment", ds_cstr(&txn->comment));
1570 json_array_add(operations, op);
1574 struct json *op = json_object_create();
1575 json_object_put_string(op, "op", "abort");
1576 json_array_add(operations, op);
1580 txn->status = TXN_UNCHANGED;
1581 json_destroy(operations);
1582 } else if (!jsonrpc_session_send(
1584 jsonrpc_create_request(
1585 "transact", operations, &txn->request_id))) {
1586 hmap_insert(&txn->idl->outstanding_txns, &txn->hmap_node,
1587 json_hash(txn->request_id, 0));
1588 txn->status = TXN_INCOMPLETE;
1590 txn->status = TXN_TRY_AGAIN;
1593 ovsdb_idl_txn_disassemble(txn);
1597 /* Attempts to commit 'txn', blocking until the commit either succeeds or
1598 * fails. Returns the final commit status, which may be any TXN_* value other
1599 * than TXN_INCOMPLETE. */
1600 enum ovsdb_idl_txn_status
1601 ovsdb_idl_txn_commit_block(struct ovsdb_idl_txn *txn)
1603 enum ovsdb_idl_txn_status status;
1606 while ((status = ovsdb_idl_txn_commit(txn)) == TXN_INCOMPLETE) {
1607 ovsdb_idl_run(txn->idl);
1608 ovsdb_idl_wait(txn->idl);
1609 ovsdb_idl_txn_wait(txn);
1616 ovsdb_idl_txn_get_increment_new_value(const struct ovsdb_idl_txn *txn)
1618 assert(txn->status == TXN_SUCCESS);
1619 return txn->inc_new_value;
1623 ovsdb_idl_txn_abort(struct ovsdb_idl_txn *txn)
1625 ovsdb_idl_txn_disassemble(txn);
1626 if (txn->status == TXN_UNCOMMITTED || txn->status == TXN_INCOMPLETE) {
1627 txn->status = TXN_ABORTED;
1632 ovsdb_idl_txn_get_error(const struct ovsdb_idl_txn *txn)
1634 if (txn->status != TXN_ERROR) {
1635 return ovsdb_idl_txn_status_to_string(txn->status);
1636 } else if (txn->error) {
1639 return "no error details available";
1644 ovsdb_idl_txn_set_error_json(struct ovsdb_idl_txn *txn,
1645 const struct json *json)
1647 if (txn->error == NULL) {
1648 txn->error = json_to_string(json, JSSF_SORT);
1652 /* For transaction 'txn' that completed successfully, finds and returns the
1653 * permanent UUID that the database assigned to a newly inserted row, given the
1654 * 'uuid' that ovsdb_idl_txn_insert() assigned locally to that row.
1656 * Returns NULL if 'uuid' is not a UUID assigned by ovsdb_idl_txn_insert() or
1657 * if it was assigned by that function and then deleted by
1658 * ovsdb_idl_txn_delete() within the same transaction. (Rows that are inserted
1659 * and then deleted within a single transaction are never sent to the database
1660 * server, so it never assigns them a permanent UUID.) */
1662 ovsdb_idl_txn_get_insert_uuid(const struct ovsdb_idl_txn *txn,
1663 const struct uuid *uuid)
1665 const struct ovsdb_idl_txn_insert *insert;
1667 assert(txn->status == TXN_SUCCESS || txn->status == TXN_UNCHANGED);
1668 HMAP_FOR_EACH_IN_BUCKET (insert, hmap_node,
1669 uuid_hash(uuid), &txn->inserted_rows) {
1670 if (uuid_equals(uuid, &insert->dummy)) {
1671 return &insert->real;
1678 ovsdb_idl_txn_complete(struct ovsdb_idl_txn *txn,
1679 enum ovsdb_idl_txn_status status)
1681 txn->status = status;
1682 hmap_remove(&txn->idl->outstanding_txns, &txn->hmap_node);
1685 /* Writes 'datum' to the specified 'column' in 'row_'. Updates both 'row_'
1686 * itself and the structs derived from it (e.g. the "struct ovsrec_*", for
1689 * 'datum' must have the correct type for its column. The IDL does not check
1690 * that it meets schema constraints, but ovsdb-server will do so at commit time
1691 * so it had better be correct.
1693 * A transaction must be in progress. Replication of 'column' must not have
1694 * been disabled (by calling ovsdb_idl_omit()).
1696 * Usually this function is used indirectly through one of the "set" functions
1697 * generated by ovsdb-idlc.
1699 * Takes ownership of what 'datum' points to (and in some cases destroys that
1700 * data before returning) but makes a copy of 'datum' itself. (Commonly
1701 * 'datum' is on the caller's stack.) */
1703 ovsdb_idl_txn_write(const struct ovsdb_idl_row *row_,
1704 const struct ovsdb_idl_column *column,
1705 struct ovsdb_datum *datum)
1707 struct ovsdb_idl_row *row = (struct ovsdb_idl_row *) row_;
1708 const struct ovsdb_idl_table_class *class = row->table->class;
1709 size_t column_idx = column - class->columns;
1711 assert(row->new != NULL);
1712 assert(column_idx < class->n_columns);
1713 assert(row->old == NULL ||
1714 row->table->modes[column_idx] & OVSDB_IDL_MONITOR);
1716 /* If this is a write-only column and the datum being written is the same
1717 * as the one already there, just skip the update entirely. This is worth
1718 * optimizing because we have a lot of columns that get periodically
1719 * refreshed into the database but don't actually change that often.
1721 * We don't do this for read/write columns because that would break
1722 * atomicity of transactions--some other client might have written a
1723 * different value in that column since we read it. (But if a whole
1724 * transaction only does writes of existing values, without making any real
1725 * changes, we will drop the whole transaction later in
1726 * ovsdb_idl_txn_commit().) */
1727 if (row->table->modes[column_idx] == OVSDB_IDL_MONITOR
1728 && ovsdb_datum_equals(ovsdb_idl_read(row, column),
1729 datum, &column->type)) {
1730 ovsdb_datum_destroy(datum, &column->type);
1734 if (hmap_node_is_null(&row->txn_node)) {
1735 hmap_insert(&row->table->idl->txn->txn_rows, &row->txn_node,
1736 uuid_hash(&row->uuid));
1738 if (row->old == row->new) {
1739 row->new = xmalloc(class->n_columns * sizeof *row->new);
1741 if (!row->written) {
1742 row->written = bitmap_allocate(class->n_columns);
1744 if (bitmap_is_set(row->written, column_idx)) {
1745 ovsdb_datum_destroy(&row->new[column_idx], &column->type);
1747 bitmap_set1(row->written, column_idx);
1749 row->new[column_idx] = *datum;
1750 (column->unparse)(row);
1751 (column->parse)(row, &row->new[column_idx]);
1754 /* Causes the original contents of 'column' in 'row_' to be verified as a
1755 * prerequisite to completing the transaction. That is, if 'column' in 'row_'
1756 * changed (or if 'row_' was deleted) between the time that the IDL originally
1757 * read its contents and the time that the transaction commits, then the
1758 * transaction aborts and ovsdb_idl_txn_commit() returns TXN_TRY_AGAIN.
1760 * The intention is that, to ensure that no transaction commits based on dirty
1761 * reads, an application should call ovsdb_idl_txn_verify() on each data item
1762 * read as part of a read-modify-write operation.
1764 * In some cases ovsdb_idl_txn_verify() reduces to a no-op, because the current
1765 * value of 'column' is already known:
1767 * - If 'row_' is a row created by the current transaction (returned by
1768 * ovsdb_idl_txn_insert()).
1770 * - If 'column' has already been modified (with ovsdb_idl_txn_write())
1771 * within the current transaction.
1773 * Because of the latter property, always call ovsdb_idl_txn_verify() *before*
1774 * ovsdb_idl_txn_write() for a given read-modify-write.
1776 * A transaction must be in progress.
1778 * Usually this function is used indirectly through one of the "verify"
1779 * functions generated by ovsdb-idlc. */
1781 ovsdb_idl_txn_verify(const struct ovsdb_idl_row *row_,
1782 const struct ovsdb_idl_column *column)
1784 struct ovsdb_idl_row *row = (struct ovsdb_idl_row *) row_;
1785 const struct ovsdb_idl_table_class *class = row->table->class;
1786 size_t column_idx = column - class->columns;
1788 assert(row->new != NULL);
1789 assert(row->old == NULL ||
1790 row->table->modes[column_idx] & OVSDB_IDL_MONITOR);
1792 || (row->written && bitmap_is_set(row->written, column_idx))) {
1796 if (hmap_node_is_null(&row->txn_node)) {
1797 hmap_insert(&row->table->idl->txn->txn_rows, &row->txn_node,
1798 uuid_hash(&row->uuid));
1800 if (!row->prereqs) {
1801 row->prereqs = bitmap_allocate(class->n_columns);
1803 bitmap_set1(row->prereqs, column_idx);
1806 /* Deletes 'row_' from its table. May free 'row_', so it must not be
1807 * accessed afterward.
1809 * A transaction must be in progress.
1811 * Usually this function is used indirectly through one of the "delete"
1812 * functions generated by ovsdb-idlc. */
1814 ovsdb_idl_txn_delete(const struct ovsdb_idl_row *row_)
1816 struct ovsdb_idl_row *row = (struct ovsdb_idl_row *) row_;
1818 assert(row->new != NULL);
1820 ovsdb_idl_row_unparse(row);
1821 ovsdb_idl_row_clear_new(row);
1822 assert(!row->prereqs);
1823 hmap_remove(&row->table->rows, &row->hmap_node);
1824 hmap_remove(&row->table->idl->txn->txn_rows, &row->txn_node);
1828 if (hmap_node_is_null(&row->txn_node)) {
1829 hmap_insert(&row->table->idl->txn->txn_rows, &row->txn_node,
1830 uuid_hash(&row->uuid));
1832 ovsdb_idl_row_clear_new(row);
1836 /* Inserts and returns a new row in the table with the specified 'class' in the
1837 * database with open transaction 'txn'.
1839 * The new row is assigned a provisional UUID. If 'uuid' is null then one is
1840 * randomly generated; otherwise 'uuid' should specify a randomly generated
1841 * UUID not otherwise in use. ovsdb-server will assign a different UUID when
1842 * 'txn' is committed, but the IDL will replace any uses of the provisional
1843 * UUID in the data to be to be committed by the UUID assigned by
1846 * Usually this function is used indirectly through one of the "insert"
1847 * functions generated by ovsdb-idlc. */
1848 const struct ovsdb_idl_row *
1849 ovsdb_idl_txn_insert(struct ovsdb_idl_txn *txn,
1850 const struct ovsdb_idl_table_class *class,
1851 const struct uuid *uuid)
1853 struct ovsdb_idl_row *row = ovsdb_idl_row_create__(class);
1856 assert(!ovsdb_idl_txn_get_row(txn, uuid));
1859 uuid_generate(&row->uuid);
1862 row->table = ovsdb_idl_table_from_class(txn->idl, class);
1863 row->new = xmalloc(class->n_columns * sizeof *row->new);
1864 hmap_insert(&row->table->rows, &row->hmap_node, uuid_hash(&row->uuid));
1865 hmap_insert(&txn->txn_rows, &row->txn_node, uuid_hash(&row->uuid));
1870 ovsdb_idl_txn_abort_all(struct ovsdb_idl *idl)
1872 struct ovsdb_idl_txn *txn;
1874 HMAP_FOR_EACH (txn, hmap_node, &idl->outstanding_txns) {
1875 ovsdb_idl_txn_complete(txn, TXN_TRY_AGAIN);
1879 static struct ovsdb_idl_txn *
1880 ovsdb_idl_txn_find(struct ovsdb_idl *idl, const struct json *id)
1882 struct ovsdb_idl_txn *txn;
1884 HMAP_FOR_EACH_WITH_HASH (txn, hmap_node,
1885 json_hash(id, 0), &idl->outstanding_txns) {
1886 if (json_equal(id, txn->request_id)) {
1894 check_json_type(const struct json *json, enum json_type type, const char *name)
1897 VLOG_WARN_RL(&syntax_rl, "%s is missing", name);
1899 } else if (json->type != type) {
1900 VLOG_WARN_RL(&syntax_rl, "%s is %s instead of %s",
1901 name, json_type_to_string(json->type),
1902 json_type_to_string(type));
1910 ovsdb_idl_txn_process_inc_reply(struct ovsdb_idl_txn *txn,
1911 const struct json_array *results)
1913 struct json *count, *rows, *row, *column;
1914 struct shash *mutate, *select;
1916 if (txn->inc_index + 2 > results->n) {
1917 VLOG_WARN_RL(&syntax_rl, "reply does not contain enough operations "
1918 "for increment (has %zu, needs %u)",
1919 results->n, txn->inc_index + 2);
1923 /* We know that this is a JSON object because the loop in
1924 * ovsdb_idl_txn_process_reply() checked. */
1925 mutate = json_object(results->elems[txn->inc_index]);
1926 count = shash_find_data(mutate, "count");
1927 if (!check_json_type(count, JSON_INTEGER, "\"mutate\" reply \"count\"")) {
1930 if (count->u.integer != 1) {
1931 VLOG_WARN_RL(&syntax_rl,
1932 "\"mutate\" reply \"count\" is %lld instead of 1",
1937 select = json_object(results->elems[txn->inc_index + 1]);
1938 rows = shash_find_data(select, "rows");
1939 if (!check_json_type(rows, JSON_ARRAY, "\"select\" reply \"rows\"")) {
1942 if (rows->u.array.n != 1) {
1943 VLOG_WARN_RL(&syntax_rl, "\"select\" reply \"rows\" has %zu elements "
1948 row = rows->u.array.elems[0];
1949 if (!check_json_type(row, JSON_OBJECT, "\"select\" reply row")) {
1952 column = shash_find_data(json_object(row), txn->inc_column);
1953 if (!check_json_type(column, JSON_INTEGER,
1954 "\"select\" reply inc column")) {
1957 txn->inc_new_value = column->u.integer;
1962 ovsdb_idl_txn_process_insert_reply(struct ovsdb_idl_txn_insert *insert,
1963 const struct json_array *results)
1965 static const struct ovsdb_base_type uuid_type = OVSDB_BASE_UUID_INIT;
1966 struct ovsdb_error *error;
1967 struct json *json_uuid;
1968 union ovsdb_atom uuid;
1969 struct shash *reply;
1971 if (insert->op_index >= results->n) {
1972 VLOG_WARN_RL(&syntax_rl, "reply does not contain enough operations "
1973 "for insert (has %zu, needs %u)",
1974 results->n, insert->op_index);
1978 /* We know that this is a JSON object because the loop in
1979 * ovsdb_idl_txn_process_reply() checked. */
1980 reply = json_object(results->elems[insert->op_index]);
1981 json_uuid = shash_find_data(reply, "uuid");
1982 if (!check_json_type(json_uuid, JSON_ARRAY, "\"insert\" reply \"uuid\"")) {
1986 error = ovsdb_atom_from_json(&uuid, &uuid_type, json_uuid, NULL);
1988 char *s = ovsdb_error_to_string(error);
1989 VLOG_WARN_RL(&syntax_rl, "\"insert\" reply \"uuid\" is not a JSON "
1995 insert->real = uuid.uuid;
2001 ovsdb_idl_txn_process_reply(struct ovsdb_idl *idl,
2002 const struct jsonrpc_msg *msg)
2004 struct ovsdb_idl_txn *txn;
2005 enum ovsdb_idl_txn_status status;
2007 txn = ovsdb_idl_txn_find(idl, msg->id);
2012 if (msg->type == JSONRPC_ERROR) {
2014 } else if (msg->result->type != JSON_ARRAY) {
2015 VLOG_WARN_RL(&syntax_rl, "reply to \"transact\" is not JSON array");
2018 struct json_array *ops = &msg->result->u.array;
2019 int hard_errors = 0;
2020 int soft_errors = 0;
2021 int lock_errors = 0;
2024 for (i = 0; i < ops->n; i++) {
2025 struct json *op = ops->elems[i];
2027 if (op->type == JSON_NULL) {
2028 /* This isn't an error in itself but indicates that some prior
2029 * operation failed, so make sure that we know about it. */
2031 } else if (op->type == JSON_OBJECT) {
2034 error = shash_find_data(json_object(op), "error");
2036 if (error->type == JSON_STRING) {
2037 if (!strcmp(error->u.string, "timed out")) {
2039 } else if (!strcmp(error->u.string, "not owner")) {
2041 } else if (strcmp(error->u.string, "aborted")) {
2043 ovsdb_idl_txn_set_error_json(txn, op);
2047 ovsdb_idl_txn_set_error_json(txn, op);
2048 VLOG_WARN_RL(&syntax_rl,
2049 "\"error\" in reply is not JSON string");
2054 ovsdb_idl_txn_set_error_json(txn, op);
2055 VLOG_WARN_RL(&syntax_rl,
2056 "operation reply is not JSON null or object");
2060 if (!soft_errors && !hard_errors && !lock_errors) {
2061 struct ovsdb_idl_txn_insert *insert;
2063 if (txn->inc_table && !ovsdb_idl_txn_process_inc_reply(txn, ops)) {
2067 HMAP_FOR_EACH (insert, hmap_node, &txn->inserted_rows) {
2068 if (!ovsdb_idl_txn_process_insert_reply(insert, ops)) {
2074 status = (hard_errors ? TXN_ERROR
2075 : lock_errors ? TXN_NOT_LOCKED
2076 : soft_errors ? TXN_TRY_AGAIN
2080 ovsdb_idl_txn_complete(txn, status);
2084 struct ovsdb_idl_txn *
2085 ovsdb_idl_txn_get(const struct ovsdb_idl_row *row)
2087 struct ovsdb_idl_txn *txn = row->table->idl->txn;
2088 assert(txn != NULL);
2093 ovsdb_idl_txn_get_idl (struct ovsdb_idl_txn *txn)
2098 /* If 'lock_name' is nonnull, configures 'idl' to obtain the named lock from
2099 * the database server and to avoid modifying the database when the lock cannot
2100 * be acquired (that is, when another client has the same lock).
2102 * If 'lock_name' is NULL, drops the locking requirement and releases the
2105 ovsdb_idl_set_lock(struct ovsdb_idl *idl, const char *lock_name)
2108 assert(hmap_is_empty(&idl->outstanding_txns));
2110 if (idl->lock_name && (!lock_name || strcmp(lock_name, idl->lock_name))) {
2111 /* Release previous lock. */
2112 ovsdb_idl_send_unlock_request(idl);
2113 free(idl->lock_name);
2114 idl->lock_name = NULL;
2115 idl->is_lock_contended = false;
2118 if (lock_name && !idl->lock_name) {
2119 /* Acquire new lock. */
2120 idl->lock_name = xstrdup(lock_name);
2121 ovsdb_idl_send_lock_request(idl);
2125 /* Returns true if 'idl' is configured to obtain a lock and owns that lock.
2127 * Locking and unlocking happens asynchronously from the database client's
2128 * point of view, so the information is only useful for optimization (e.g. if
2129 * the client doesn't have the lock then there's no point in trying to write to
2132 ovsdb_idl_has_lock(const struct ovsdb_idl *idl)
2134 return idl->has_lock;
2137 /* Returns true if 'idl' is configured to obtain a lock but the database server
2138 * has indicated that some other client already owns the requested lock. */
2140 ovsdb_idl_is_lock_contended(const struct ovsdb_idl *idl)
2142 return idl->is_lock_contended;
2146 ovsdb_idl_update_has_lock(struct ovsdb_idl *idl, bool new_has_lock)
2148 if (new_has_lock && !idl->has_lock) {
2149 if (!idl->monitor_request_id) {
2150 idl->change_seqno++;
2152 /* We're waiting for a monitor reply, so don't signal that the
2153 * database changed. The monitor reply will increment change_seqno
2156 idl->is_lock_contended = false;
2158 idl->has_lock = new_has_lock;
2162 ovsdb_idl_send_lock_request__(struct ovsdb_idl *idl, const char *method,
2165 ovsdb_idl_update_has_lock(idl, false);
2167 json_destroy(idl->lock_request_id);
2168 idl->lock_request_id = NULL;
2170 if (jsonrpc_session_is_connected(idl->session)) {
2171 struct json *params;
2173 params = json_array_create_1(json_string_create(idl->lock_name));
2174 jsonrpc_session_send(idl->session,
2175 jsonrpc_create_request(method, params, idp));
2180 ovsdb_idl_send_lock_request(struct ovsdb_idl *idl)
2182 ovsdb_idl_send_lock_request__(idl, "lock", &idl->lock_request_id);
2186 ovsdb_idl_send_unlock_request(struct ovsdb_idl *idl)
2188 ovsdb_idl_send_lock_request__(idl, "unlock", NULL);
2192 ovsdb_idl_parse_lock_reply(struct ovsdb_idl *idl, const struct json *result)
2196 json_destroy(idl->lock_request_id);
2197 idl->lock_request_id = NULL;
2199 if (result->type == JSON_OBJECT) {
2200 const struct json *locked;
2202 locked = shash_find_data(json_object(result), "locked");
2203 got_lock = locked && locked->type == JSON_TRUE;
2208 ovsdb_idl_update_has_lock(idl, got_lock);
2210 idl->is_lock_contended = true;
2215 ovsdb_idl_parse_lock_notify(struct ovsdb_idl *idl,
2216 const struct json *params,
2220 && params->type == JSON_ARRAY
2221 && json_array(params)->n > 0
2222 && json_array(params)->elems[0]->type == JSON_STRING) {
2223 const char *lock_name = json_string(json_array(params)->elems[0]);
2225 if (!strcmp(idl->lock_name, lock_name)) {
2226 ovsdb_idl_update_has_lock(idl, new_has_lock);
2227 if (!new_has_lock) {
2228 idl->is_lock_contended = true;