1 /* Copyright (c) 2009, 2010, 2011, 2012 Nicira, Inc.
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;
94 unsigned int commit_seqno;
97 const char *inc_table;
98 const char *inc_column;
100 unsigned int inc_index;
101 int64_t inc_new_value;
104 struct hmap inserted_rows; /* Contains "struct ovsdb_idl_txn_insert"s. */
107 struct ovsdb_idl_txn_insert {
108 struct hmap_node hmap_node; /* In struct ovsdb_idl_txn's inserted_rows. */
109 struct uuid dummy; /* Dummy UUID used locally. */
110 int op_index; /* Index into transaction's operation array. */
111 struct uuid real; /* Real UUID used by database server. */
114 static struct vlog_rate_limit syntax_rl = VLOG_RATE_LIMIT_INIT(1, 5);
115 static struct vlog_rate_limit semantic_rl = VLOG_RATE_LIMIT_INIT(1, 5);
117 static void ovsdb_idl_clear(struct ovsdb_idl *);
118 static void ovsdb_idl_send_monitor_request(struct ovsdb_idl *);
119 static void ovsdb_idl_parse_update(struct ovsdb_idl *, const struct json *);
120 static struct ovsdb_error *ovsdb_idl_parse_update__(struct ovsdb_idl *,
121 const struct json *);
122 static bool ovsdb_idl_process_update(struct ovsdb_idl_table *,
124 const struct json *old,
125 const struct json *new);
126 static void ovsdb_idl_insert_row(struct ovsdb_idl_row *, const struct json *);
127 static void ovsdb_idl_delete_row(struct ovsdb_idl_row *);
128 static bool ovsdb_idl_modify_row(struct ovsdb_idl_row *, const struct json *);
130 static bool ovsdb_idl_row_is_orphan(const struct ovsdb_idl_row *);
131 static struct ovsdb_idl_row *ovsdb_idl_row_create__(
132 const struct ovsdb_idl_table_class *);
133 static struct ovsdb_idl_row *ovsdb_idl_row_create(struct ovsdb_idl_table *,
134 const struct uuid *);
135 static void ovsdb_idl_row_destroy(struct ovsdb_idl_row *);
137 static void ovsdb_idl_row_parse(struct ovsdb_idl_row *);
138 static void ovsdb_idl_row_unparse(struct ovsdb_idl_row *);
139 static void ovsdb_idl_row_clear_old(struct ovsdb_idl_row *);
140 static void ovsdb_idl_row_clear_new(struct ovsdb_idl_row *);
142 static void ovsdb_idl_txn_abort_all(struct ovsdb_idl *);
143 static bool ovsdb_idl_txn_process_reply(struct ovsdb_idl *,
144 const struct jsonrpc_msg *msg);
146 static void ovsdb_idl_send_lock_request(struct ovsdb_idl *);
147 static void ovsdb_idl_send_unlock_request(struct ovsdb_idl *);
148 static void ovsdb_idl_parse_lock_reply(struct ovsdb_idl *,
149 const struct json *);
150 static void ovsdb_idl_parse_lock_notify(struct ovsdb_idl *,
151 const struct json *params,
154 /* Creates and returns a connection to database 'remote', which should be in a
155 * form acceptable to jsonrpc_session_open(). The connection will maintain an
156 * in-memory replica of the remote database whose schema is described by
157 * 'class'. (Ordinarily 'class' is compiled from an OVSDB schema automatically
160 * If 'monitor_everything_by_default' is true, then everything in the remote
161 * database will be replicated by default. ovsdb_idl_omit() and
162 * ovsdb_idl_omit_alert() may be used to selectively drop some columns from
165 * If 'monitor_everything_by_default' is false, then no columns or tables will
166 * be replicated by default. ovsdb_idl_add_column() and ovsdb_idl_add_table()
167 * must be used to choose some columns or tables to replicate.
170 ovsdb_idl_create(const char *remote, const struct ovsdb_idl_class *class,
171 bool monitor_everything_by_default)
173 struct ovsdb_idl *idl;
174 uint8_t default_mode;
177 default_mode = (monitor_everything_by_default
178 ? OVSDB_IDL_MONITOR | OVSDB_IDL_ALERT
181 idl = xzalloc(sizeof *idl);
183 idl->session = jsonrpc_session_open(remote);
184 shash_init(&idl->table_by_name);
185 idl->tables = xmalloc(class->n_tables * sizeof *idl->tables);
186 for (i = 0; i < class->n_tables; i++) {
187 const struct ovsdb_idl_table_class *tc = &class->tables[i];
188 struct ovsdb_idl_table *table = &idl->tables[i];
191 shash_add_assert(&idl->table_by_name, tc->name, table);
193 table->modes = xmalloc(tc->n_columns);
194 memset(table->modes, default_mode, tc->n_columns);
195 table->need_table = false;
196 shash_init(&table->columns);
197 for (j = 0; j < tc->n_columns; j++) {
198 const struct ovsdb_idl_column *column = &tc->columns[j];
200 shash_add_assert(&table->columns, column->name, column);
202 hmap_init(&table->rows);
205 idl->last_monitor_request_seqno = UINT_MAX;
206 hmap_init(&idl->outstanding_txns);
211 /* Destroys 'idl' and all of the data structures that it manages. */
213 ovsdb_idl_destroy(struct ovsdb_idl *idl)
219 ovsdb_idl_clear(idl);
220 jsonrpc_session_close(idl->session);
222 for (i = 0; i < idl->class->n_tables; i++) {
223 struct ovsdb_idl_table *table = &idl->tables[i];
224 shash_destroy(&table->columns);
225 hmap_destroy(&table->rows);
228 shash_destroy(&idl->table_by_name);
230 json_destroy(idl->monitor_request_id);
231 free(idl->lock_name);
232 json_destroy(idl->lock_request_id);
233 hmap_destroy(&idl->outstanding_txns);
239 ovsdb_idl_clear(struct ovsdb_idl *idl)
241 bool changed = false;
244 for (i = 0; i < idl->class->n_tables; i++) {
245 struct ovsdb_idl_table *table = &idl->tables[i];
246 struct ovsdb_idl_row *row, *next_row;
248 if (hmap_is_empty(&table->rows)) {
253 HMAP_FOR_EACH_SAFE (row, next_row, hmap_node, &table->rows) {
254 struct ovsdb_idl_arc *arc, *next_arc;
256 if (!ovsdb_idl_row_is_orphan(row)) {
257 ovsdb_idl_row_unparse(row);
259 LIST_FOR_EACH_SAFE (arc, next_arc, src_node, &row->src_arcs) {
262 /* No need to do anything with dst_arcs: some node has those arcs
263 * as forward arcs and will destroy them itself. */
265 ovsdb_idl_row_destroy(row);
274 /* Processes a batch of messages from the database server on 'idl'. This may
275 * cause the IDL's contents to change. The client may check for that with
276 * ovsdb_idl_get_seqno(). */
278 ovsdb_idl_run(struct ovsdb_idl *idl)
283 jsonrpc_session_run(idl->session);
284 for (i = 0; jsonrpc_session_is_connected(idl->session) && i < 50; i++) {
285 struct jsonrpc_msg *msg;
288 seqno = jsonrpc_session_get_seqno(idl->session);
289 if (idl->last_monitor_request_seqno != seqno) {
290 idl->last_monitor_request_seqno = seqno;
291 ovsdb_idl_txn_abort_all(idl);
292 ovsdb_idl_send_monitor_request(idl);
293 if (idl->lock_name) {
294 ovsdb_idl_send_lock_request(idl);
299 msg = jsonrpc_session_recv(idl->session);
304 if (msg->type == JSONRPC_NOTIFY
305 && !strcmp(msg->method, "update")
306 && msg->params->type == JSON_ARRAY
307 && msg->params->u.array.n == 2
308 && msg->params->u.array.elems[0]->type == JSON_NULL) {
309 /* Database contents changed. */
310 ovsdb_idl_parse_update(idl, msg->params->u.array.elems[1]);
311 } else if (msg->type == JSONRPC_REPLY
312 && idl->monitor_request_id
313 && json_equal(idl->monitor_request_id, msg->id)) {
314 /* Reply to our "monitor" request. */
316 json_destroy(idl->monitor_request_id);
317 idl->monitor_request_id = NULL;
318 ovsdb_idl_clear(idl);
319 ovsdb_idl_parse_update(idl, msg->result);
320 } else if (msg->type == JSONRPC_REPLY
321 && idl->lock_request_id
322 && json_equal(idl->lock_request_id, msg->id)) {
323 /* Reply to our "lock" request. */
324 ovsdb_idl_parse_lock_reply(idl, msg->result);
325 } else if (msg->type == JSONRPC_NOTIFY
326 && !strcmp(msg->method, "locked")) {
327 /* We got our lock. */
328 ovsdb_idl_parse_lock_notify(idl, msg->params, true);
329 } else if (msg->type == JSONRPC_NOTIFY
330 && !strcmp(msg->method, "stolen")) {
331 /* Someone else stole our lock. */
332 ovsdb_idl_parse_lock_notify(idl, msg->params, false);
333 } else if (msg->type == JSONRPC_REPLY && msg->id->type == JSON_STRING
334 && !strcmp(msg->id->u.string, "echo")) {
335 /* Reply to our echo request. Ignore it. */
336 } else if ((msg->type == JSONRPC_ERROR
337 || msg->type == JSONRPC_REPLY)
338 && ovsdb_idl_txn_process_reply(idl, msg)) {
339 /* ovsdb_idl_txn_process_reply() did everything needful. */
341 /* This can happen if ovsdb_idl_txn_destroy() is called to destroy
342 * a transaction before we receive the reply, so keep the log level
344 VLOG_DBG("%s: received unexpected %s message",
345 jsonrpc_session_get_name(idl->session),
346 jsonrpc_msg_type_to_string(msg->type));
348 jsonrpc_msg_destroy(msg);
352 /* Arranges for poll_block() to wake up when ovsdb_idl_run() has something to
353 * do or when activity occurs on a transaction on 'idl'. */
355 ovsdb_idl_wait(struct ovsdb_idl *idl)
357 jsonrpc_session_wait(idl->session);
358 jsonrpc_session_recv_wait(idl->session);
361 /* Returns a "sequence number" that represents the state of 'idl'. When
362 * ovsdb_idl_run() changes the database, the sequence number changes. The
363 * initial fetch of the entire contents of the remote database is considered to
364 * be one kind of change. Successfully acquiring a lock, if one has been
365 * configured with ovsdb_idl_set_lock(), is also considered to be a change.
367 * As long as the sequence number does not change, the client may continue to
368 * use any data structures it obtains from 'idl'. But when it changes, the
369 * client must not access any of these data structures again, because they
370 * could have freed or reused for other purposes.
372 * The sequence number can occasionally change even if the database does not.
373 * This happens if the connection to the database drops and reconnects, which
374 * causes the database contents to be reloaded even if they didn't change. (It
375 * could also happen if the database server sends out a "change" that reflects
376 * what the IDL already thought was in the database. The database server is
377 * not supposed to do that, but bugs could in theory cause it to do so.) */
379 ovsdb_idl_get_seqno(const struct ovsdb_idl *idl)
381 return idl->change_seqno;
384 /* Returns true if 'idl' successfully connected to the remote database and
385 * retrieved its contents (even if the connection subsequently dropped and is
386 * in the process of reconnecting). If so, then 'idl' contains an atomic
387 * snapshot of the database's contents (but it might be arbitrarily old if the
388 * connection dropped).
390 * Returns false if 'idl' has never connected or retrieved the database's
391 * contents. If so, 'idl' is empty. */
393 ovsdb_idl_has_ever_connected(const struct ovsdb_idl *idl)
395 return ovsdb_idl_get_seqno(idl) != 0;
398 /* Forces 'idl' to drop its connection to the database and reconnect. In the
399 * meantime, the contents of 'idl' will not change. */
401 ovsdb_idl_force_reconnect(struct ovsdb_idl *idl)
403 jsonrpc_session_force_reconnect(idl->session);
406 static unsigned char *
407 ovsdb_idl_get_mode(struct ovsdb_idl *idl,
408 const struct ovsdb_idl_column *column)
412 assert(!idl->change_seqno);
414 for (i = 0; i < idl->class->n_tables; i++) {
415 const struct ovsdb_idl_table *table = &idl->tables[i];
416 const struct ovsdb_idl_table_class *tc = table->class;
418 if (column >= tc->columns && column < &tc->columns[tc->n_columns]) {
419 return &table->modes[column - tc->columns];
427 add_ref_table(struct ovsdb_idl *idl, const struct ovsdb_base_type *base)
429 if (base->type == OVSDB_TYPE_UUID && base->u.uuid.refTableName) {
430 struct ovsdb_idl_table *table;
432 table = shash_find_data(&idl->table_by_name,
433 base->u.uuid.refTableName);
435 table->need_table = true;
437 VLOG_WARN("%s IDL class missing referenced table %s",
438 idl->class->database, base->u.uuid.refTableName);
443 /* Turns on OVSDB_IDL_MONITOR and OVSDB_IDL_ALERT for 'column' in 'idl'. Also
444 * ensures that any tables referenced by 'column' will be replicated, even if
445 * no columns in that table are selected for replication (see
446 * ovsdb_idl_add_table() for more information).
448 * This function is only useful if 'monitor_everything_by_default' was false in
449 * the call to ovsdb_idl_create(). This function should be called between
450 * ovsdb_idl_create() and the first call to ovsdb_idl_run().
453 ovsdb_idl_add_column(struct ovsdb_idl *idl,
454 const struct ovsdb_idl_column *column)
456 *ovsdb_idl_get_mode(idl, column) = OVSDB_IDL_MONITOR | OVSDB_IDL_ALERT;
457 add_ref_table(idl, &column->type.key);
458 add_ref_table(idl, &column->type.value);
461 /* Ensures that the table with class 'tc' will be replicated on 'idl' even if
462 * no columns are selected for replication. This can be useful because it
463 * allows 'idl' to keep track of what rows in the table actually exist, which
464 * in turn allows columns that reference the table to have accurate contents.
465 * (The IDL presents the database with references to rows that do not exist
468 * This function is only useful if 'monitor_everything_by_default' was false in
469 * the call to ovsdb_idl_create(). This function should be called between
470 * ovsdb_idl_create() and the first call to ovsdb_idl_run().
473 ovsdb_idl_add_table(struct ovsdb_idl *idl,
474 const struct ovsdb_idl_table_class *tc)
478 for (i = 0; i < idl->class->n_tables; i++) {
479 struct ovsdb_idl_table *table = &idl->tables[i];
481 if (table->class == tc) {
482 table->need_table = true;
490 /* Turns off OVSDB_IDL_ALERT for 'column' in 'idl'.
492 * This function should be called between ovsdb_idl_create() and the first call
493 * to ovsdb_idl_run().
496 ovsdb_idl_omit_alert(struct ovsdb_idl *idl,
497 const struct ovsdb_idl_column *column)
499 *ovsdb_idl_get_mode(idl, column) &= ~OVSDB_IDL_ALERT;
502 /* Sets the mode for 'column' in 'idl' to 0. See the big comment above
503 * OVSDB_IDL_MONITOR for details.
505 * This function should be called between ovsdb_idl_create() and the first call
506 * to ovsdb_idl_run().
509 ovsdb_idl_omit(struct ovsdb_idl *idl, const struct ovsdb_idl_column *column)
511 *ovsdb_idl_get_mode(idl, column) = 0;
515 ovsdb_idl_send_monitor_request(struct ovsdb_idl *idl)
517 struct json *monitor_requests;
518 struct jsonrpc_msg *msg;
521 monitor_requests = json_object_create();
522 for (i = 0; i < idl->class->n_tables; i++) {
523 const struct ovsdb_idl_table *table = &idl->tables[i];
524 const struct ovsdb_idl_table_class *tc = table->class;
525 struct json *monitor_request, *columns;
528 columns = table->need_table ? json_array_create_empty() : NULL;
529 for (j = 0; j < tc->n_columns; j++) {
530 const struct ovsdb_idl_column *column = &tc->columns[j];
531 if (table->modes[j] & OVSDB_IDL_MONITOR) {
533 columns = json_array_create_empty();
535 json_array_add(columns, json_string_create(column->name));
540 monitor_request = json_object_create();
541 json_object_put(monitor_request, "columns", columns);
542 json_object_put(monitor_requests, tc->name, monitor_request);
546 json_destroy(idl->monitor_request_id);
547 msg = jsonrpc_create_request(
549 json_array_create_3(json_string_create(idl->class->database),
550 json_null_create(), monitor_requests),
551 &idl->monitor_request_id);
552 jsonrpc_session_send(idl->session, msg);
556 ovsdb_idl_parse_update(struct ovsdb_idl *idl, const struct json *table_updates)
558 struct ovsdb_error *error = ovsdb_idl_parse_update__(idl, table_updates);
560 if (!VLOG_DROP_WARN(&syntax_rl)) {
561 char *s = ovsdb_error_to_string(error);
562 VLOG_WARN_RL(&syntax_rl, "%s", s);
565 ovsdb_error_destroy(error);
569 static struct ovsdb_error *
570 ovsdb_idl_parse_update__(struct ovsdb_idl *idl,
571 const struct json *table_updates)
573 const struct shash_node *tables_node;
575 if (table_updates->type != JSON_OBJECT) {
576 return ovsdb_syntax_error(table_updates, NULL,
577 "<table-updates> is not an object");
579 SHASH_FOR_EACH (tables_node, json_object(table_updates)) {
580 const struct json *table_update = tables_node->data;
581 const struct shash_node *table_node;
582 struct ovsdb_idl_table *table;
584 table = shash_find_data(&idl->table_by_name, tables_node->name);
586 return ovsdb_syntax_error(
588 "<table-updates> includes unknown table \"%s\"",
592 if (table_update->type != JSON_OBJECT) {
593 return ovsdb_syntax_error(table_update, NULL,
594 "<table-update> for table \"%s\" is "
595 "not an object", table->class->name);
597 SHASH_FOR_EACH (table_node, json_object(table_update)) {
598 const struct json *row_update = table_node->data;
599 const struct json *old_json, *new_json;
602 if (!uuid_from_string(&uuid, table_node->name)) {
603 return ovsdb_syntax_error(table_update, NULL,
604 "<table-update> for table \"%s\" "
606 "\"%s\" as member name",
610 if (row_update->type != JSON_OBJECT) {
611 return ovsdb_syntax_error(row_update, NULL,
612 "<table-update> for table \"%s\" "
613 "contains <row-update> for %s that "
619 old_json = shash_find_data(json_object(row_update), "old");
620 new_json = shash_find_data(json_object(row_update), "new");
621 if (old_json && old_json->type != JSON_OBJECT) {
622 return ovsdb_syntax_error(old_json, NULL,
623 "\"old\" <row> is not object");
624 } else if (new_json && new_json->type != JSON_OBJECT) {
625 return ovsdb_syntax_error(new_json, NULL,
626 "\"new\" <row> is not object");
627 } else if ((old_json != NULL) + (new_json != NULL)
628 != shash_count(json_object(row_update))) {
629 return ovsdb_syntax_error(row_update, NULL,
630 "<row-update> contains unexpected "
632 } else if (!old_json && !new_json) {
633 return ovsdb_syntax_error(row_update, NULL,
634 "<row-update> missing \"old\" "
635 "and \"new\" members");
638 if (ovsdb_idl_process_update(table, &uuid, old_json, new_json)) {
647 static struct ovsdb_idl_row *
648 ovsdb_idl_get_row(struct ovsdb_idl_table *table, const struct uuid *uuid)
650 struct ovsdb_idl_row *row;
652 HMAP_FOR_EACH_WITH_HASH (row, hmap_node, uuid_hash(uuid), &table->rows) {
653 if (uuid_equals(&row->uuid, uuid)) {
660 /* Returns true if a column with mode OVSDB_IDL_MODE_RW changed, false
663 ovsdb_idl_process_update(struct ovsdb_idl_table *table,
664 const struct uuid *uuid, const struct json *old,
665 const struct json *new)
667 struct ovsdb_idl_row *row;
669 row = ovsdb_idl_get_row(table, uuid);
672 if (row && !ovsdb_idl_row_is_orphan(row)) {
673 /* XXX perhaps we should check the 'old' values? */
674 ovsdb_idl_delete_row(row);
676 VLOG_WARN_RL(&semantic_rl, "cannot delete missing row "UUID_FMT" "
678 UUID_ARGS(uuid), table->class->name);
684 ovsdb_idl_insert_row(ovsdb_idl_row_create(table, uuid), new);
685 } else if (ovsdb_idl_row_is_orphan(row)) {
686 ovsdb_idl_insert_row(row, new);
688 VLOG_WARN_RL(&semantic_rl, "cannot add existing row "UUID_FMT" to "
689 "table %s", UUID_ARGS(uuid), table->class->name);
690 return ovsdb_idl_modify_row(row, new);
695 /* XXX perhaps we should check the 'old' values? */
696 if (!ovsdb_idl_row_is_orphan(row)) {
697 return ovsdb_idl_modify_row(row, new);
699 VLOG_WARN_RL(&semantic_rl, "cannot modify missing but "
700 "referenced row "UUID_FMT" in table %s",
701 UUID_ARGS(uuid), table->class->name);
702 ovsdb_idl_insert_row(row, new);
705 VLOG_WARN_RL(&semantic_rl, "cannot modify missing row "UUID_FMT" "
706 "in table %s", UUID_ARGS(uuid), table->class->name);
707 ovsdb_idl_insert_row(ovsdb_idl_row_create(table, uuid), new);
714 /* Returns true if a column with mode OVSDB_IDL_MODE_RW changed, false
717 ovsdb_idl_row_update(struct ovsdb_idl_row *row, const struct json *row_json)
719 struct ovsdb_idl_table *table = row->table;
720 struct shash_node *node;
721 bool changed = false;
723 SHASH_FOR_EACH (node, json_object(row_json)) {
724 const char *column_name = node->name;
725 const struct ovsdb_idl_column *column;
726 struct ovsdb_datum datum;
727 struct ovsdb_error *error;
729 column = shash_find_data(&table->columns, column_name);
731 VLOG_WARN_RL(&syntax_rl, "unknown column %s updating row "UUID_FMT,
732 column_name, UUID_ARGS(&row->uuid));
736 error = ovsdb_datum_from_json(&datum, &column->type, node->data, NULL);
738 unsigned int column_idx = column - table->class->columns;
739 struct ovsdb_datum *old = &row->old[column_idx];
741 if (!ovsdb_datum_equals(old, &datum, &column->type)) {
742 ovsdb_datum_swap(old, &datum);
743 if (table->modes[column_idx] & OVSDB_IDL_ALERT) {
747 /* Didn't really change but the OVSDB monitor protocol always
748 * includes every value in a row. */
751 ovsdb_datum_destroy(&datum, &column->type);
753 char *s = ovsdb_error_to_string(error);
754 VLOG_WARN_RL(&syntax_rl, "error parsing column %s in row "UUID_FMT
755 " in table %s: %s", column_name,
756 UUID_ARGS(&row->uuid), table->class->name, s);
758 ovsdb_error_destroy(error);
764 /* When a row A refers to row B through a column with a "refTable" constraint,
765 * but row B does not exist, row B is called an "orphan row". Orphan rows
766 * should not persist, because the database enforces referential integrity, but
767 * they can appear transiently as changes from the database are received (the
768 * database doesn't try to topologically sort them and circular references mean
769 * it isn't always possible anyhow).
771 * This function returns true if 'row' is an orphan row, otherwise false.
774 ovsdb_idl_row_is_orphan(const struct ovsdb_idl_row *row)
776 return !row->old && !row->new;
779 /* Returns true if 'row' is conceptually part of the database as modified by
780 * the current transaction (if any), false otherwise.
782 * This function will return true if 'row' is not an orphan (see the comment on
783 * ovsdb_idl_row_is_orphan()) and:
785 * - 'row' exists in the database and has not been deleted within the
786 * current transaction (if any).
788 * - 'row' was inserted within the current transaction and has not been
789 * deleted. (In the latter case you should not have passed 'row' in at
790 * all, because ovsdb_idl_txn_delete() freed it.)
792 * This function will return false if 'row' is an orphan or if 'row' was
793 * deleted within the current transaction.
796 ovsdb_idl_row_exists(const struct ovsdb_idl_row *row)
798 return row->new != NULL;
802 ovsdb_idl_row_parse(struct ovsdb_idl_row *row)
804 const struct ovsdb_idl_table_class *class = row->table->class;
807 for (i = 0; i < class->n_columns; i++) {
808 const struct ovsdb_idl_column *c = &class->columns[i];
809 (c->parse)(row, &row->old[i]);
814 ovsdb_idl_row_unparse(struct ovsdb_idl_row *row)
816 const struct ovsdb_idl_table_class *class = row->table->class;
819 for (i = 0; i < class->n_columns; i++) {
820 const struct ovsdb_idl_column *c = &class->columns[i];
826 ovsdb_idl_row_clear_old(struct ovsdb_idl_row *row)
828 assert(row->old == row->new);
829 if (!ovsdb_idl_row_is_orphan(row)) {
830 const struct ovsdb_idl_table_class *class = row->table->class;
833 for (i = 0; i < class->n_columns; i++) {
834 ovsdb_datum_destroy(&row->old[i], &class->columns[i].type);
837 row->old = row->new = NULL;
842 ovsdb_idl_row_clear_new(struct ovsdb_idl_row *row)
844 if (row->old != row->new) {
846 const struct ovsdb_idl_table_class *class = row->table->class;
850 BITMAP_FOR_EACH_1 (i, class->n_columns, row->written) {
851 ovsdb_datum_destroy(&row->new[i], &class->columns[i].type);
863 ovsdb_idl_row_clear_arcs(struct ovsdb_idl_row *row, bool destroy_dsts)
865 struct ovsdb_idl_arc *arc, *next;
867 /* Delete all forward arcs. If 'destroy_dsts', destroy any orphaned rows
868 * that this causes to be unreferenced. */
869 LIST_FOR_EACH_SAFE (arc, next, src_node, &row->src_arcs) {
870 list_remove(&arc->dst_node);
872 && ovsdb_idl_row_is_orphan(arc->dst)
873 && list_is_empty(&arc->dst->dst_arcs)) {
874 ovsdb_idl_row_destroy(arc->dst);
878 list_init(&row->src_arcs);
881 /* Force nodes that reference 'row' to reparse. */
883 ovsdb_idl_row_reparse_backrefs(struct ovsdb_idl_row *row)
885 struct ovsdb_idl_arc *arc, *next;
887 /* This is trickier than it looks. ovsdb_idl_row_clear_arcs() will destroy
888 * 'arc', so we need to use the "safe" variant of list traversal. However,
889 * calling an ovsdb_idl_column's 'parse' function will add an arc
890 * equivalent to 'arc' to row->arcs. That could be a problem for
891 * traversal, but it adds it at the beginning of the list to prevent us
892 * from stumbling upon it again.
894 * (If duplicate arcs were possible then we would need to make sure that
895 * 'next' didn't also point into 'arc''s destination, but we forbid
896 * duplicate arcs.) */
897 LIST_FOR_EACH_SAFE (arc, next, dst_node, &row->dst_arcs) {
898 struct ovsdb_idl_row *ref = arc->src;
900 ovsdb_idl_row_unparse(ref);
901 ovsdb_idl_row_clear_arcs(ref, false);
902 ovsdb_idl_row_parse(ref);
906 static struct ovsdb_idl_row *
907 ovsdb_idl_row_create__(const struct ovsdb_idl_table_class *class)
909 struct ovsdb_idl_row *row = xzalloc(class->allocation_size);
910 class->row_init(row);
911 list_init(&row->src_arcs);
912 list_init(&row->dst_arcs);
913 hmap_node_nullify(&row->txn_node);
917 static struct ovsdb_idl_row *
918 ovsdb_idl_row_create(struct ovsdb_idl_table *table, const struct uuid *uuid)
920 struct ovsdb_idl_row *row = ovsdb_idl_row_create__(table->class);
921 hmap_insert(&table->rows, &row->hmap_node, uuid_hash(uuid));
928 ovsdb_idl_row_destroy(struct ovsdb_idl_row *row)
931 ovsdb_idl_row_clear_old(row);
932 hmap_remove(&row->table->rows, &row->hmap_node);
938 ovsdb_idl_insert_row(struct ovsdb_idl_row *row, const struct json *row_json)
940 const struct ovsdb_idl_table_class *class = row->table->class;
943 assert(!row->old && !row->new);
944 row->old = row->new = xmalloc(class->n_columns * sizeof *row->old);
945 for (i = 0; i < class->n_columns; i++) {
946 ovsdb_datum_init_default(&row->old[i], &class->columns[i].type);
948 ovsdb_idl_row_update(row, row_json);
949 ovsdb_idl_row_parse(row);
951 ovsdb_idl_row_reparse_backrefs(row);
955 ovsdb_idl_delete_row(struct ovsdb_idl_row *row)
957 ovsdb_idl_row_unparse(row);
958 ovsdb_idl_row_clear_arcs(row, true);
959 ovsdb_idl_row_clear_old(row);
960 if (list_is_empty(&row->dst_arcs)) {
961 ovsdb_idl_row_destroy(row);
963 ovsdb_idl_row_reparse_backrefs(row);
967 /* Returns true if a column with mode OVSDB_IDL_MODE_RW changed, false
970 ovsdb_idl_modify_row(struct ovsdb_idl_row *row, const struct json *row_json)
974 ovsdb_idl_row_unparse(row);
975 ovsdb_idl_row_clear_arcs(row, true);
976 changed = ovsdb_idl_row_update(row, row_json);
977 ovsdb_idl_row_parse(row);
983 may_add_arc(const struct ovsdb_idl_row *src, const struct ovsdb_idl_row *dst)
985 const struct ovsdb_idl_arc *arc;
992 /* No duplicate arcs.
994 * We only need to test whether the first arc in dst->dst_arcs originates
995 * at 'src', since we add all of the arcs from a given source in a clump
996 * (in a single call to ovsdb_idl_row_parse()) and new arcs are always
997 * added at the front of the dst_arcs list. */
998 if (list_is_empty(&dst->dst_arcs)) {
1001 arc = CONTAINER_OF(dst->dst_arcs.next, struct ovsdb_idl_arc, dst_node);
1002 return arc->src != src;
1005 static struct ovsdb_idl_table *
1006 ovsdb_idl_table_from_class(const struct ovsdb_idl *idl,
1007 const struct ovsdb_idl_table_class *table_class)
1009 return &idl->tables[table_class - idl->class->tables];
1012 /* Called by ovsdb-idlc generated code. */
1013 struct ovsdb_idl_row *
1014 ovsdb_idl_get_row_arc(struct ovsdb_idl_row *src,
1015 struct ovsdb_idl_table_class *dst_table_class,
1016 const struct uuid *dst_uuid)
1018 struct ovsdb_idl *idl = src->table->idl;
1019 struct ovsdb_idl_table *dst_table;
1020 struct ovsdb_idl_arc *arc;
1021 struct ovsdb_idl_row *dst;
1023 dst_table = ovsdb_idl_table_from_class(idl, dst_table_class);
1024 dst = ovsdb_idl_get_row(dst_table, dst_uuid);
1026 /* We're being called from ovsdb_idl_txn_write(). We must not update
1027 * any arcs, because the transaction will be backed out at commit or
1028 * abort time and we don't want our graph screwed up.
1030 * Just return the destination row, if there is one and it has not been
1032 if (dst && (hmap_node_is_null(&dst->txn_node) || dst->new)) {
1037 /* We're being called from some other context. Update the graph. */
1039 dst = ovsdb_idl_row_create(dst_table, dst_uuid);
1042 /* Add a new arc, if it wouldn't be a self-arc or a duplicate arc. */
1043 if (may_add_arc(src, dst)) {
1044 /* The arc *must* be added at the front of the dst_arcs list. See
1045 * ovsdb_idl_row_reparse_backrefs() for details. */
1046 arc = xmalloc(sizeof *arc);
1047 list_push_front(&src->src_arcs, &arc->src_node);
1048 list_push_front(&dst->dst_arcs, &arc->dst_node);
1053 return !ovsdb_idl_row_is_orphan(dst) ? dst : NULL;
1057 /* Searches 'tc''s table in 'idl' for a row with UUID 'uuid'. Returns a
1058 * pointer to the row if there is one, otherwise a null pointer. */
1059 const struct ovsdb_idl_row *
1060 ovsdb_idl_get_row_for_uuid(const struct ovsdb_idl *idl,
1061 const struct ovsdb_idl_table_class *tc,
1062 const struct uuid *uuid)
1064 return ovsdb_idl_get_row(ovsdb_idl_table_from_class(idl, tc), uuid);
1067 static struct ovsdb_idl_row *
1068 next_real_row(struct ovsdb_idl_table *table, struct hmap_node *node)
1070 for (; node; node = hmap_next(&table->rows, node)) {
1071 struct ovsdb_idl_row *row;
1073 row = CONTAINER_OF(node, struct ovsdb_idl_row, hmap_node);
1074 if (ovsdb_idl_row_exists(row)) {
1081 /* Returns a row in 'table_class''s table in 'idl', or a null pointer if that
1084 * Database tables are internally maintained as hash tables, so adding or
1085 * removing rows while traversing the same table can cause some rows to be
1086 * visited twice or not at apply. */
1087 const struct ovsdb_idl_row *
1088 ovsdb_idl_first_row(const struct ovsdb_idl *idl,
1089 const struct ovsdb_idl_table_class *table_class)
1091 struct ovsdb_idl_table *table
1092 = ovsdb_idl_table_from_class(idl, table_class);
1093 return next_real_row(table, hmap_first(&table->rows));
1096 /* Returns a row following 'row' within its table, or a null pointer if 'row'
1097 * is the last row in its table. */
1098 const struct ovsdb_idl_row *
1099 ovsdb_idl_next_row(const struct ovsdb_idl_row *row)
1101 struct ovsdb_idl_table *table = row->table;
1103 return next_real_row(table, hmap_next(&table->rows, &row->hmap_node));
1106 /* Reads and returns the value of 'column' within 'row'. If an ongoing
1107 * transaction has changed 'column''s value, the modified value is returned.
1109 * The caller must not modify or free the returned value.
1111 * Various kinds of changes can invalidate the returned value: writing to the
1112 * same 'column' in 'row' (e.g. with ovsdb_idl_txn_write()), deleting 'row'
1113 * (e.g. with ovsdb_idl_txn_delete()), or completing an ongoing transaction
1114 * (e.g. with ovsdb_idl_txn_commit() or ovsdb_idl_txn_abort()). If the
1115 * returned value is needed for a long time, it is best to make a copy of it
1116 * with ovsdb_datum_clone(). */
1117 const struct ovsdb_datum *
1118 ovsdb_idl_read(const struct ovsdb_idl_row *row,
1119 const struct ovsdb_idl_column *column)
1121 const struct ovsdb_idl_table_class *class;
1124 assert(!ovsdb_idl_row_is_synthetic(row));
1126 class = row->table->class;
1127 column_idx = column - class->columns;
1129 assert(row->new != NULL);
1130 assert(column_idx < class->n_columns);
1132 if (row->written && bitmap_is_set(row->written, column_idx)) {
1133 return &row->new[column_idx];
1134 } else if (row->old) {
1135 return &row->old[column_idx];
1137 return ovsdb_datum_default(&column->type);
1141 /* Same as ovsdb_idl_read(), except that it also asserts that 'column' has key
1142 * type 'key_type' and value type 'value_type'. (Scalar and set types will
1143 * have a value type of OVSDB_TYPE_VOID.)
1145 * This is useful in code that "knows" that a particular column has a given
1146 * type, so that it will abort if someone changes the column's type without
1147 * updating the code that uses it. */
1148 const struct ovsdb_datum *
1149 ovsdb_idl_get(const struct ovsdb_idl_row *row,
1150 const struct ovsdb_idl_column *column,
1151 enum ovsdb_atomic_type key_type OVS_UNUSED,
1152 enum ovsdb_atomic_type value_type OVS_UNUSED)
1154 assert(column->type.key.type == key_type);
1155 assert(column->type.value.type == value_type);
1157 return ovsdb_idl_read(row, column);
1160 /* Returns false if 'row' was obtained from the IDL, true if it was initialized
1161 * to all-zero-bits by some other entity. If 'row' was set up some other way
1162 * then the return value is indeterminate. */
1164 ovsdb_idl_row_is_synthetic(const struct ovsdb_idl_row *row)
1166 return row->table == NULL;
1171 static void ovsdb_idl_txn_complete(struct ovsdb_idl_txn *txn,
1172 enum ovsdb_idl_txn_status);
1174 /* Returns a string representation of 'status'. The caller must not modify or
1175 * free the returned string.
1177 * The return value is probably useful only for debug log messages and unit
1180 ovsdb_idl_txn_status_to_string(enum ovsdb_idl_txn_status status)
1183 case TXN_UNCOMMITTED:
1184 return "uncommitted";
1187 case TXN_INCOMPLETE:
1188 return "incomplete";
1195 case TXN_NOT_LOCKED:
1196 return "not locked";
1203 /* Starts a new transaction on 'idl'. A given ovsdb_idl may only have a single
1204 * active transaction at a time. See the large comment in ovsdb-idl.h for
1205 * general information on transactions. */
1206 struct ovsdb_idl_txn *
1207 ovsdb_idl_txn_create(struct ovsdb_idl *idl)
1209 struct ovsdb_idl_txn *txn;
1212 idl->txn = txn = xmalloc(sizeof *txn);
1213 txn->request_id = NULL;
1215 hmap_init(&txn->txn_rows);
1216 txn->status = TXN_UNCOMMITTED;
1218 txn->dry_run = false;
1219 ds_init(&txn->comment);
1220 txn->commit_seqno = txn->idl->change_seqno;
1222 txn->inc_table = NULL;
1223 txn->inc_column = NULL;
1225 hmap_init(&txn->inserted_rows);
1230 /* Appends 's', which is treated as a printf()-type format string, to the
1231 * comments that will be passed to the OVSDB server when 'txn' is committed.
1232 * (The comment will be committed to the OVSDB log, which "ovsdb-tool
1233 * show-log" can print in a relatively human-readable form.) */
1235 ovsdb_idl_txn_add_comment(struct ovsdb_idl_txn *txn, const char *s, ...)
1239 if (txn->comment.length) {
1240 ds_put_char(&txn->comment, '\n');
1244 ds_put_format_valist(&txn->comment, s, args);
1248 /* Marks 'txn' as a transaction that will not actually modify the database. In
1249 * almost every way, the transaction is treated like other transactions. It
1250 * must be committed or aborted like other transactions, it will be sent to the
1251 * database server like other transactions, and so on. The only difference is
1252 * that the operations sent to the database server will include, as the last
1253 * step, an "abort" operation, so that any changes made by the transaction will
1254 * not actually take effect. */
1256 ovsdb_idl_txn_set_dry_run(struct ovsdb_idl_txn *txn)
1258 txn->dry_run = true;
1261 /* Causes 'txn', when committed, to increment the value of 'column' within
1262 * 'row' by 1. 'column' must have an integer type. After 'txn' commits
1263 * successfully, the client may retrieve the final (incremented) value of
1264 * 'column' with ovsdb_idl_txn_get_increment_new_value().
1266 * The client could accomplish something similar with ovsdb_idl_read(),
1267 * ovsdb_idl_txn_verify() and ovsdb_idl_txn_write(), or with ovsdb-idlc
1268 * generated wrappers for these functions. However, ovsdb_idl_txn_increment()
1269 * will never (by itself) fail because of a verify error.
1271 * The intended use is for incrementing the "next_cfg" column in the
1272 * Open_vSwitch table. */
1274 ovsdb_idl_txn_increment(struct ovsdb_idl_txn *txn,
1275 const struct ovsdb_idl_row *row,
1276 const struct ovsdb_idl_column *column)
1278 assert(!txn->inc_table);
1279 assert(column->type.key.type == OVSDB_TYPE_INTEGER);
1280 assert(column->type.value.type == OVSDB_TYPE_VOID);
1282 txn->inc_table = row->table->class->name;
1283 txn->inc_column = column->name;
1284 txn->inc_row = row->uuid;
1287 /* Destroys 'txn' and frees all associated memory. If ovsdb_idl_txn_commit()
1288 * has been called for 'txn' but the commit is still incomplete (that is, the
1289 * last call returned TXN_INCOMPLETE) then the transaction may or may not still
1290 * end up committing at the database server, but the client will not be able to
1291 * get any further status information back. */
1293 ovsdb_idl_txn_destroy(struct ovsdb_idl_txn *txn)
1295 struct ovsdb_idl_txn_insert *insert, *next;
1297 json_destroy(txn->request_id);
1298 if (txn->status == TXN_INCOMPLETE) {
1299 hmap_remove(&txn->idl->outstanding_txns, &txn->hmap_node);
1301 ovsdb_idl_txn_abort(txn);
1302 ds_destroy(&txn->comment);
1304 HMAP_FOR_EACH_SAFE (insert, next, hmap_node, &txn->inserted_rows) {
1307 hmap_destroy(&txn->inserted_rows);
1311 /* Causes poll_block() to wake up if 'txn' has completed committing. */
1313 ovsdb_idl_txn_wait(const struct ovsdb_idl_txn *txn)
1315 if (txn->status != TXN_UNCOMMITTED && txn->status != TXN_INCOMPLETE) {
1316 poll_immediate_wake();
1320 static struct json *
1321 where_uuid_equals(const struct uuid *uuid)
1324 json_array_create_1(
1325 json_array_create_3(
1326 json_string_create("_uuid"),
1327 json_string_create("=="),
1328 json_array_create_2(
1329 json_string_create("uuid"),
1330 json_string_create_nocopy(
1331 xasprintf(UUID_FMT, UUID_ARGS(uuid))))));
1335 uuid_name_from_uuid(const struct uuid *uuid)
1340 name = xasprintf("row"UUID_FMT, UUID_ARGS(uuid));
1341 for (p = name; *p != '\0'; p++) {
1350 static const struct ovsdb_idl_row *
1351 ovsdb_idl_txn_get_row(const struct ovsdb_idl_txn *txn, const struct uuid *uuid)
1353 const struct ovsdb_idl_row *row;
1355 HMAP_FOR_EACH_WITH_HASH (row, txn_node, uuid_hash(uuid), &txn->txn_rows) {
1356 if (uuid_equals(&row->uuid, uuid)) {
1363 /* XXX there must be a cleaner way to do this */
1364 static struct json *
1365 substitute_uuids(struct json *json, const struct ovsdb_idl_txn *txn)
1367 if (json->type == JSON_ARRAY) {
1371 if (json->u.array.n == 2
1372 && json->u.array.elems[0]->type == JSON_STRING
1373 && json->u.array.elems[1]->type == JSON_STRING
1374 && !strcmp(json->u.array.elems[0]->u.string, "uuid")
1375 && uuid_from_string(&uuid, json->u.array.elems[1]->u.string)) {
1376 const struct ovsdb_idl_row *row;
1378 row = ovsdb_idl_txn_get_row(txn, &uuid);
1379 if (row && !row->old && row->new) {
1382 return json_array_create_2(
1383 json_string_create("named-uuid"),
1384 json_string_create_nocopy(uuid_name_from_uuid(&uuid)));
1388 for (i = 0; i < json->u.array.n; i++) {
1389 json->u.array.elems[i] = substitute_uuids(json->u.array.elems[i],
1392 } else if (json->type == JSON_OBJECT) {
1393 struct shash_node *node;
1395 SHASH_FOR_EACH (node, json_object(json)) {
1396 node->data = substitute_uuids(node->data, txn);
1403 ovsdb_idl_txn_disassemble(struct ovsdb_idl_txn *txn)
1405 struct ovsdb_idl_row *row, *next;
1407 /* This must happen early. Otherwise, ovsdb_idl_row_parse() will call an
1408 * ovsdb_idl_column's 'parse' function, which will call
1409 * ovsdb_idl_get_row_arc(), which will seen that the IDL is in a
1410 * transaction and fail to update the graph. */
1411 txn->idl->txn = NULL;
1413 HMAP_FOR_EACH_SAFE (row, next, txn_node, &txn->txn_rows) {
1416 ovsdb_idl_row_unparse(row);
1417 ovsdb_idl_row_clear_arcs(row, false);
1418 ovsdb_idl_row_parse(row);
1421 ovsdb_idl_row_unparse(row);
1423 ovsdb_idl_row_clear_new(row);
1426 row->prereqs = NULL;
1429 row->written = NULL;
1431 hmap_remove(&txn->txn_rows, &row->txn_node);
1432 hmap_node_nullify(&row->txn_node);
1434 hmap_remove(&row->table->rows, &row->hmap_node);
1438 hmap_destroy(&txn->txn_rows);
1439 hmap_init(&txn->txn_rows);
1442 /* Attempts to commit 'txn'. Returns the status of the commit operation, one
1443 * of the following TXN_* constants:
1447 * The transaction is in progress, but not yet complete. The caller
1448 * should call again later, after calling ovsdb_idl_run() to let the IDL
1449 * do OVSDB protocol processing.
1453 * The transaction is complete. (It didn't actually change the database,
1454 * so the IDL didn't send any request to the database server.)
1458 * The caller previously called ovsdb_idl_txn_abort().
1462 * The transaction was successful. The update made by the transaction
1463 * (and possibly other changes made by other database clients) should
1464 * already be visible in the IDL.
1468 * The transaction failed for some transient reason, e.g. because a
1469 * "verify" operation reported an inconsistency or due to a network
1470 * problem. The caller should wait for a change to the database, then
1471 * compose a new transaction, and commit the new transaction.
1473 * Use the return value of ovsdb_idl_get_seqno() to wait for a change in
1474 * the database. It is important to use its return value *before* the
1475 * initial call to ovsdb_idl_txn_commit() as the baseline for this
1476 * purpose, because the change that one should wait for can happen after
1477 * the initial call but before the call that returns TXN_TRY_AGAIN, and
1478 * using some other baseline value in that situation could cause an
1479 * indefinite wait if the database rarely changes.
1483 * The transaction failed because the IDL has been configured to require
1484 * a database lock (with ovsdb_idl_set_lock()) but didn't get it yet or
1485 * has already lost it.
1487 * Committing a transaction rolls back all of the changes that it made to the
1488 * IDL's copy of the database. If the transaction commits successfully, then
1489 * the database server will send an update and, thus, the IDL will be updated
1490 * with the committed changes. */
1491 enum ovsdb_idl_txn_status
1492 ovsdb_idl_txn_commit(struct ovsdb_idl_txn *txn)
1494 struct ovsdb_idl_row *row;
1495 struct json *operations;
1498 if (txn != txn->idl->txn) {
1502 /* If we need a lock but don't have it, give up quickly. */
1503 if (txn->idl->lock_name && !ovsdb_idl_has_lock(txn->idl)) {
1504 txn->status = TXN_NOT_LOCKED;
1505 ovsdb_idl_txn_disassemble(txn);
1509 operations = json_array_create_1(
1510 json_string_create(txn->idl->class->database));
1512 /* Assert that we have the required lock (avoiding a race). */
1513 if (txn->idl->lock_name) {
1514 struct json *op = json_object_create();
1515 json_array_add(operations, op);
1516 json_object_put_string(op, "op", "assert");
1517 json_object_put_string(op, "lock", txn->idl->lock_name);
1520 /* Add prerequisites and declarations of new rows. */
1521 HMAP_FOR_EACH (row, txn_node, &txn->txn_rows) {
1522 /* XXX check that deleted rows exist even if no prereqs? */
1524 const struct ovsdb_idl_table_class *class = row->table->class;
1525 size_t n_columns = class->n_columns;
1526 struct json *op, *columns, *row_json;
1529 op = json_object_create();
1530 json_array_add(operations, op);
1531 json_object_put_string(op, "op", "wait");
1532 json_object_put_string(op, "table", class->name);
1533 json_object_put(op, "timeout", json_integer_create(0));
1534 json_object_put(op, "where", where_uuid_equals(&row->uuid));
1535 json_object_put_string(op, "until", "==");
1536 columns = json_array_create_empty();
1537 json_object_put(op, "columns", columns);
1538 row_json = json_object_create();
1539 json_object_put(op, "rows", json_array_create_1(row_json));
1541 BITMAP_FOR_EACH_1 (idx, n_columns, row->prereqs) {
1542 const struct ovsdb_idl_column *column = &class->columns[idx];
1543 json_array_add(columns, json_string_create(column->name));
1544 json_object_put(row_json, column->name,
1545 ovsdb_datum_to_json(&row->old[idx],
1552 any_updates = false;
1553 HMAP_FOR_EACH (row, txn_node, &txn->txn_rows) {
1554 const struct ovsdb_idl_table_class *class = row->table->class;
1557 if (class->is_root) {
1558 struct json *op = json_object_create();
1559 json_object_put_string(op, "op", "delete");
1560 json_object_put_string(op, "table", class->name);
1561 json_object_put(op, "where", where_uuid_equals(&row->uuid));
1562 json_array_add(operations, op);
1565 /* Let ovsdb-server decide whether to really delete it. */
1567 } else if (row->old != row->new) {
1568 struct json *row_json;
1572 op = json_object_create();
1573 json_object_put_string(op, "op", row->old ? "update" : "insert");
1574 json_object_put_string(op, "table", class->name);
1576 json_object_put(op, "where", where_uuid_equals(&row->uuid));
1578 struct ovsdb_idl_txn_insert *insert;
1582 json_object_put(op, "uuid-name",
1583 json_string_create_nocopy(
1584 uuid_name_from_uuid(&row->uuid)));
1586 insert = xmalloc(sizeof *insert);
1587 insert->dummy = row->uuid;
1588 insert->op_index = operations->u.array.n - 1;
1589 uuid_zero(&insert->real);
1590 hmap_insert(&txn->inserted_rows, &insert->hmap_node,
1591 uuid_hash(&insert->dummy));
1593 row_json = json_object_create();
1594 json_object_put(op, "row", row_json);
1597 BITMAP_FOR_EACH_1 (idx, class->n_columns, row->written) {
1598 const struct ovsdb_idl_column *column =
1599 &class->columns[idx];
1602 || !ovsdb_datum_is_default(&row->new[idx],
1604 json_object_put(row_json, column->name,
1606 ovsdb_datum_to_json(&row->new[idx],
1610 /* If anything really changed, consider it an update.
1611 * We can't suppress not-really-changed values earlier
1612 * or transactions would become nonatomic (see the big
1613 * comment inside ovsdb_idl_txn_write()). */
1614 if (!any_updates && row->old &&
1615 !ovsdb_datum_equals(&row->old[idx], &row->new[idx],
1623 if (!row->old || !shash_is_empty(json_object(row_json))) {
1624 json_array_add(operations, op);
1631 /* Add increment. */
1632 if (txn->inc_table && any_updates) {
1635 txn->inc_index = operations->u.array.n - 1;
1637 op = json_object_create();
1638 json_object_put_string(op, "op", "mutate");
1639 json_object_put_string(op, "table", txn->inc_table);
1640 json_object_put(op, "where",
1641 substitute_uuids(where_uuid_equals(&txn->inc_row),
1643 json_object_put(op, "mutations",
1644 json_array_create_1(
1645 json_array_create_3(
1646 json_string_create(txn->inc_column),
1647 json_string_create("+="),
1648 json_integer_create(1))));
1649 json_array_add(operations, op);
1651 op = json_object_create();
1652 json_object_put_string(op, "op", "select");
1653 json_object_put_string(op, "table", txn->inc_table);
1654 json_object_put(op, "where",
1655 substitute_uuids(where_uuid_equals(&txn->inc_row),
1657 json_object_put(op, "columns",
1658 json_array_create_1(json_string_create(
1660 json_array_add(operations, op);
1663 if (txn->comment.length) {
1664 struct json *op = json_object_create();
1665 json_object_put_string(op, "op", "comment");
1666 json_object_put_string(op, "comment", ds_cstr(&txn->comment));
1667 json_array_add(operations, op);
1671 struct json *op = json_object_create();
1672 json_object_put_string(op, "op", "abort");
1673 json_array_add(operations, op);
1677 txn->status = TXN_UNCHANGED;
1678 json_destroy(operations);
1679 } else if (!jsonrpc_session_send(
1681 jsonrpc_create_request(
1682 "transact", operations, &txn->request_id))) {
1683 hmap_insert(&txn->idl->outstanding_txns, &txn->hmap_node,
1684 json_hash(txn->request_id, 0));
1685 txn->status = TXN_INCOMPLETE;
1687 txn->status = TXN_TRY_AGAIN;
1690 ovsdb_idl_txn_disassemble(txn);
1694 /* Attempts to commit 'txn', blocking until the commit either succeeds or
1695 * fails. Returns the final commit status, which may be any TXN_* value other
1696 * than TXN_INCOMPLETE.
1698 * This function calls ovsdb_idl_run() on 'txn''s IDL, so it may cause the
1699 * return value of ovsdb_idl_get_seqno() to change. */
1700 enum ovsdb_idl_txn_status
1701 ovsdb_idl_txn_commit_block(struct ovsdb_idl_txn *txn)
1703 enum ovsdb_idl_txn_status status;
1706 while ((status = ovsdb_idl_txn_commit(txn)) == TXN_INCOMPLETE) {
1707 ovsdb_idl_run(txn->idl);
1708 ovsdb_idl_wait(txn->idl);
1709 ovsdb_idl_txn_wait(txn);
1715 /* Returns the final (incremented) value of the column in 'txn' that was set to
1716 * be incremented by ovsdb_idl_txn_increment(). 'txn' must have committed
1719 ovsdb_idl_txn_get_increment_new_value(const struct ovsdb_idl_txn *txn)
1721 assert(txn->status == TXN_SUCCESS);
1722 return txn->inc_new_value;
1725 /* Aborts 'txn' without sending it to the database server. This is effective
1726 * only if ovsdb_idl_txn_commit() has not yet been called for 'txn'.
1727 * Otherwise, it has no effect.
1729 * Aborting a transaction doesn't free its memory. Use
1730 * ovsdb_idl_txn_destroy() to do that. */
1732 ovsdb_idl_txn_abort(struct ovsdb_idl_txn *txn)
1734 ovsdb_idl_txn_disassemble(txn);
1735 if (txn->status == TXN_UNCOMMITTED || txn->status == TXN_INCOMPLETE) {
1736 txn->status = TXN_ABORTED;
1740 /* Returns a string that reports the error status for 'txn'. The caller must
1741 * not modify or free the returned string. A call to ovsdb_idl_txn_destroy()
1742 * for 'txn' may free the returned string.
1744 * The return value is ordinarily one of the strings that
1745 * ovsdb_idl_txn_status_to_string() would return, but if the transaction failed
1746 * due to an error reported by the database server, the return value is that
1749 ovsdb_idl_txn_get_error(const struct ovsdb_idl_txn *txn)
1751 if (txn->status != TXN_ERROR) {
1752 return ovsdb_idl_txn_status_to_string(txn->status);
1753 } else if (txn->error) {
1756 return "no error details available";
1761 ovsdb_idl_txn_set_error_json(struct ovsdb_idl_txn *txn,
1762 const struct json *json)
1764 if (txn->error == NULL) {
1765 txn->error = json_to_string(json, JSSF_SORT);
1769 /* For transaction 'txn' that completed successfully, finds and returns the
1770 * permanent UUID that the database assigned to a newly inserted row, given the
1771 * 'uuid' that ovsdb_idl_txn_insert() assigned locally to that row.
1773 * Returns NULL if 'uuid' is not a UUID assigned by ovsdb_idl_txn_insert() or
1774 * if it was assigned by that function and then deleted by
1775 * ovsdb_idl_txn_delete() within the same transaction. (Rows that are inserted
1776 * and then deleted within a single transaction are never sent to the database
1777 * server, so it never assigns them a permanent UUID.) */
1779 ovsdb_idl_txn_get_insert_uuid(const struct ovsdb_idl_txn *txn,
1780 const struct uuid *uuid)
1782 const struct ovsdb_idl_txn_insert *insert;
1784 assert(txn->status == TXN_SUCCESS || txn->status == TXN_UNCHANGED);
1785 HMAP_FOR_EACH_IN_BUCKET (insert, hmap_node,
1786 uuid_hash(uuid), &txn->inserted_rows) {
1787 if (uuid_equals(uuid, &insert->dummy)) {
1788 return &insert->real;
1795 ovsdb_idl_txn_complete(struct ovsdb_idl_txn *txn,
1796 enum ovsdb_idl_txn_status status)
1798 txn->status = status;
1799 hmap_remove(&txn->idl->outstanding_txns, &txn->hmap_node);
1802 /* Writes 'datum' to the specified 'column' in 'row_'. Updates both 'row_'
1803 * itself and the structs derived from it (e.g. the "struct ovsrec_*", for
1806 * 'datum' must have the correct type for its column. The IDL does not check
1807 * that it meets schema constraints, but ovsdb-server will do so at commit time
1808 * so it had better be correct.
1810 * A transaction must be in progress. Replication of 'column' must not have
1811 * been disabled (by calling ovsdb_idl_omit()).
1813 * Usually this function is used indirectly through one of the "set" functions
1814 * generated by ovsdb-idlc.
1816 * Takes ownership of what 'datum' points to (and in some cases destroys that
1817 * data before returning) but makes a copy of 'datum' itself. (Commonly
1818 * 'datum' is on the caller's stack.) */
1820 ovsdb_idl_txn_write(const struct ovsdb_idl_row *row_,
1821 const struct ovsdb_idl_column *column,
1822 struct ovsdb_datum *datum)
1824 struct ovsdb_idl_row *row = CONST_CAST(struct ovsdb_idl_row *, row_);
1825 const struct ovsdb_idl_table_class *class;
1828 if (ovsdb_idl_row_is_synthetic(row)) {
1829 ovsdb_datum_destroy(datum, &column->type);
1833 class = row->table->class;
1834 column_idx = column - class->columns;
1836 assert(row->new != NULL);
1837 assert(column_idx < class->n_columns);
1838 assert(row->old == NULL ||
1839 row->table->modes[column_idx] & OVSDB_IDL_MONITOR);
1841 /* If this is a write-only column and the datum being written is the same
1842 * as the one already there, just skip the update entirely. This is worth
1843 * optimizing because we have a lot of columns that get periodically
1844 * refreshed into the database but don't actually change that often.
1846 * We don't do this for read/write columns because that would break
1847 * atomicity of transactions--some other client might have written a
1848 * different value in that column since we read it. (But if a whole
1849 * transaction only does writes of existing values, without making any real
1850 * changes, we will drop the whole transaction later in
1851 * ovsdb_idl_txn_commit().) */
1852 if (row->table->modes[column_idx] == OVSDB_IDL_MONITOR
1853 && ovsdb_datum_equals(ovsdb_idl_read(row, column),
1854 datum, &column->type)) {
1855 ovsdb_datum_destroy(datum, &column->type);
1859 if (hmap_node_is_null(&row->txn_node)) {
1860 hmap_insert(&row->table->idl->txn->txn_rows, &row->txn_node,
1861 uuid_hash(&row->uuid));
1863 if (row->old == row->new) {
1864 row->new = xmalloc(class->n_columns * sizeof *row->new);
1866 if (!row->written) {
1867 row->written = bitmap_allocate(class->n_columns);
1869 if (bitmap_is_set(row->written, column_idx)) {
1870 ovsdb_datum_destroy(&row->new[column_idx], &column->type);
1872 bitmap_set1(row->written, column_idx);
1874 row->new[column_idx] = *datum;
1875 (column->unparse)(row);
1876 (column->parse)(row, &row->new[column_idx]);
1879 /* Causes the original contents of 'column' in 'row_' to be verified as a
1880 * prerequisite to completing the transaction. That is, if 'column' in 'row_'
1881 * changed (or if 'row_' was deleted) between the time that the IDL originally
1882 * read its contents and the time that the transaction commits, then the
1883 * transaction aborts and ovsdb_idl_txn_commit() returns TXN_AGAIN_WAIT or
1884 * TXN_AGAIN_NOW (depending on whether the database change has already been
1887 * The intention is that, to ensure that no transaction commits based on dirty
1888 * reads, an application should call ovsdb_idl_txn_verify() on each data item
1889 * read as part of a read-modify-write operation.
1891 * In some cases ovsdb_idl_txn_verify() reduces to a no-op, because the current
1892 * value of 'column' is already known:
1894 * - If 'row_' is a row created by the current transaction (returned by
1895 * ovsdb_idl_txn_insert()).
1897 * - If 'column' has already been modified (with ovsdb_idl_txn_write())
1898 * within the current transaction.
1900 * Because of the latter property, always call ovsdb_idl_txn_verify() *before*
1901 * ovsdb_idl_txn_write() for a given read-modify-write.
1903 * A transaction must be in progress.
1905 * Usually this function is used indirectly through one of the "verify"
1906 * functions generated by ovsdb-idlc. */
1908 ovsdb_idl_txn_verify(const struct ovsdb_idl_row *row_,
1909 const struct ovsdb_idl_column *column)
1911 struct ovsdb_idl_row *row = CONST_CAST(struct ovsdb_idl_row *, row_);
1912 const struct ovsdb_idl_table_class *class;
1915 if (ovsdb_idl_row_is_synthetic(row)) {
1919 class = row->table->class;
1920 column_idx = column - class->columns;
1922 assert(row->new != NULL);
1923 assert(row->old == NULL ||
1924 row->table->modes[column_idx] & OVSDB_IDL_MONITOR);
1926 || (row->written && bitmap_is_set(row->written, column_idx))) {
1930 if (hmap_node_is_null(&row->txn_node)) {
1931 hmap_insert(&row->table->idl->txn->txn_rows, &row->txn_node,
1932 uuid_hash(&row->uuid));
1934 if (!row->prereqs) {
1935 row->prereqs = bitmap_allocate(class->n_columns);
1937 bitmap_set1(row->prereqs, column_idx);
1940 /* Deletes 'row_' from its table. May free 'row_', so it must not be
1941 * accessed afterward.
1943 * A transaction must be in progress.
1945 * Usually this function is used indirectly through one of the "delete"
1946 * functions generated by ovsdb-idlc. */
1948 ovsdb_idl_txn_delete(const struct ovsdb_idl_row *row_)
1950 struct ovsdb_idl_row *row = CONST_CAST(struct ovsdb_idl_row *, row_);
1952 if (ovsdb_idl_row_is_synthetic(row)) {
1956 assert(row->new != NULL);
1958 ovsdb_idl_row_unparse(row);
1959 ovsdb_idl_row_clear_new(row);
1960 assert(!row->prereqs);
1961 hmap_remove(&row->table->rows, &row->hmap_node);
1962 hmap_remove(&row->table->idl->txn->txn_rows, &row->txn_node);
1966 if (hmap_node_is_null(&row->txn_node)) {
1967 hmap_insert(&row->table->idl->txn->txn_rows, &row->txn_node,
1968 uuid_hash(&row->uuid));
1970 ovsdb_idl_row_clear_new(row);
1974 /* Inserts and returns a new row in the table with the specified 'class' in the
1975 * database with open transaction 'txn'.
1977 * The new row is assigned a provisional UUID. If 'uuid' is null then one is
1978 * randomly generated; otherwise 'uuid' should specify a randomly generated
1979 * UUID not otherwise in use. ovsdb-server will assign a different UUID when
1980 * 'txn' is committed, but the IDL will replace any uses of the provisional
1981 * UUID in the data to be to be committed by the UUID assigned by
1984 * Usually this function is used indirectly through one of the "insert"
1985 * functions generated by ovsdb-idlc. */
1986 const struct ovsdb_idl_row *
1987 ovsdb_idl_txn_insert(struct ovsdb_idl_txn *txn,
1988 const struct ovsdb_idl_table_class *class,
1989 const struct uuid *uuid)
1991 struct ovsdb_idl_row *row = ovsdb_idl_row_create__(class);
1994 assert(!ovsdb_idl_txn_get_row(txn, uuid));
1997 uuid_generate(&row->uuid);
2000 row->table = ovsdb_idl_table_from_class(txn->idl, class);
2001 row->new = xmalloc(class->n_columns * sizeof *row->new);
2002 hmap_insert(&row->table->rows, &row->hmap_node, uuid_hash(&row->uuid));
2003 hmap_insert(&txn->txn_rows, &row->txn_node, uuid_hash(&row->uuid));
2008 ovsdb_idl_txn_abort_all(struct ovsdb_idl *idl)
2010 struct ovsdb_idl_txn *txn;
2012 HMAP_FOR_EACH (txn, hmap_node, &idl->outstanding_txns) {
2013 ovsdb_idl_txn_complete(txn, TXN_TRY_AGAIN);
2017 static struct ovsdb_idl_txn *
2018 ovsdb_idl_txn_find(struct ovsdb_idl *idl, const struct json *id)
2020 struct ovsdb_idl_txn *txn;
2022 HMAP_FOR_EACH_WITH_HASH (txn, hmap_node,
2023 json_hash(id, 0), &idl->outstanding_txns) {
2024 if (json_equal(id, txn->request_id)) {
2032 check_json_type(const struct json *json, enum json_type type, const char *name)
2035 VLOG_WARN_RL(&syntax_rl, "%s is missing", name);
2037 } else if (json->type != type) {
2038 VLOG_WARN_RL(&syntax_rl, "%s is %s instead of %s",
2039 name, json_type_to_string(json->type),
2040 json_type_to_string(type));
2048 ovsdb_idl_txn_process_inc_reply(struct ovsdb_idl_txn *txn,
2049 const struct json_array *results)
2051 struct json *count, *rows, *row, *column;
2052 struct shash *mutate, *select;
2054 if (txn->inc_index + 2 > results->n) {
2055 VLOG_WARN_RL(&syntax_rl, "reply does not contain enough operations "
2056 "for increment (has %zu, needs %u)",
2057 results->n, txn->inc_index + 2);
2061 /* We know that this is a JSON object because the loop in
2062 * ovsdb_idl_txn_process_reply() checked. */
2063 mutate = json_object(results->elems[txn->inc_index]);
2064 count = shash_find_data(mutate, "count");
2065 if (!check_json_type(count, JSON_INTEGER, "\"mutate\" reply \"count\"")) {
2068 if (count->u.integer != 1) {
2069 VLOG_WARN_RL(&syntax_rl,
2070 "\"mutate\" reply \"count\" is %lld instead of 1",
2075 select = json_object(results->elems[txn->inc_index + 1]);
2076 rows = shash_find_data(select, "rows");
2077 if (!check_json_type(rows, JSON_ARRAY, "\"select\" reply \"rows\"")) {
2080 if (rows->u.array.n != 1) {
2081 VLOG_WARN_RL(&syntax_rl, "\"select\" reply \"rows\" has %zu elements "
2086 row = rows->u.array.elems[0];
2087 if (!check_json_type(row, JSON_OBJECT, "\"select\" reply row")) {
2090 column = shash_find_data(json_object(row), txn->inc_column);
2091 if (!check_json_type(column, JSON_INTEGER,
2092 "\"select\" reply inc column")) {
2095 txn->inc_new_value = column->u.integer;
2100 ovsdb_idl_txn_process_insert_reply(struct ovsdb_idl_txn_insert *insert,
2101 const struct json_array *results)
2103 static const struct ovsdb_base_type uuid_type = OVSDB_BASE_UUID_INIT;
2104 struct ovsdb_error *error;
2105 struct json *json_uuid;
2106 union ovsdb_atom uuid;
2107 struct shash *reply;
2109 if (insert->op_index >= results->n) {
2110 VLOG_WARN_RL(&syntax_rl, "reply does not contain enough operations "
2111 "for insert (has %zu, needs %u)",
2112 results->n, insert->op_index);
2116 /* We know that this is a JSON object because the loop in
2117 * ovsdb_idl_txn_process_reply() checked. */
2118 reply = json_object(results->elems[insert->op_index]);
2119 json_uuid = shash_find_data(reply, "uuid");
2120 if (!check_json_type(json_uuid, JSON_ARRAY, "\"insert\" reply \"uuid\"")) {
2124 error = ovsdb_atom_from_json(&uuid, &uuid_type, json_uuid, NULL);
2126 char *s = ovsdb_error_to_string(error);
2127 VLOG_WARN_RL(&syntax_rl, "\"insert\" reply \"uuid\" is not a JSON "
2133 insert->real = uuid.uuid;
2139 ovsdb_idl_txn_process_reply(struct ovsdb_idl *idl,
2140 const struct jsonrpc_msg *msg)
2142 struct ovsdb_idl_txn *txn;
2143 enum ovsdb_idl_txn_status status;
2145 txn = ovsdb_idl_txn_find(idl, msg->id);
2150 if (msg->type == JSONRPC_ERROR) {
2152 } else if (msg->result->type != JSON_ARRAY) {
2153 VLOG_WARN_RL(&syntax_rl, "reply to \"transact\" is not JSON array");
2156 struct json_array *ops = &msg->result->u.array;
2157 int hard_errors = 0;
2158 int soft_errors = 0;
2159 int lock_errors = 0;
2162 for (i = 0; i < ops->n; i++) {
2163 struct json *op = ops->elems[i];
2165 if (op->type == JSON_NULL) {
2166 /* This isn't an error in itself but indicates that some prior
2167 * operation failed, so make sure that we know about it. */
2169 } else if (op->type == JSON_OBJECT) {
2172 error = shash_find_data(json_object(op), "error");
2174 if (error->type == JSON_STRING) {
2175 if (!strcmp(error->u.string, "timed out")) {
2177 } else if (!strcmp(error->u.string, "not owner")) {
2179 } else if (strcmp(error->u.string, "aborted")) {
2181 ovsdb_idl_txn_set_error_json(txn, op);
2185 ovsdb_idl_txn_set_error_json(txn, op);
2186 VLOG_WARN_RL(&syntax_rl,
2187 "\"error\" in reply is not JSON string");
2192 ovsdb_idl_txn_set_error_json(txn, op);
2193 VLOG_WARN_RL(&syntax_rl,
2194 "operation reply is not JSON null or object");
2198 if (!soft_errors && !hard_errors && !lock_errors) {
2199 struct ovsdb_idl_txn_insert *insert;
2201 if (txn->inc_table && !ovsdb_idl_txn_process_inc_reply(txn, ops)) {
2205 HMAP_FOR_EACH (insert, hmap_node, &txn->inserted_rows) {
2206 if (!ovsdb_idl_txn_process_insert_reply(insert, ops)) {
2212 status = (hard_errors ? TXN_ERROR
2213 : lock_errors ? TXN_NOT_LOCKED
2214 : soft_errors ? TXN_TRY_AGAIN
2218 ovsdb_idl_txn_complete(txn, status);
2222 /* Returns the transaction currently active for 'row''s IDL. A transaction
2223 * must currently be active. */
2224 struct ovsdb_idl_txn *
2225 ovsdb_idl_txn_get(const struct ovsdb_idl_row *row)
2227 struct ovsdb_idl_txn *txn = row->table->idl->txn;
2228 assert(txn != NULL);
2232 /* Returns the IDL on which 'txn' acts. */
2234 ovsdb_idl_txn_get_idl (struct ovsdb_idl_txn *txn)
2239 /* If 'lock_name' is nonnull, configures 'idl' to obtain the named lock from
2240 * the database server and to avoid modifying the database when the lock cannot
2241 * be acquired (that is, when another client has the same lock).
2243 * If 'lock_name' is NULL, drops the locking requirement and releases the
2246 ovsdb_idl_set_lock(struct ovsdb_idl *idl, const char *lock_name)
2249 assert(hmap_is_empty(&idl->outstanding_txns));
2251 if (idl->lock_name && (!lock_name || strcmp(lock_name, idl->lock_name))) {
2252 /* Release previous lock. */
2253 ovsdb_idl_send_unlock_request(idl);
2254 free(idl->lock_name);
2255 idl->lock_name = NULL;
2256 idl->is_lock_contended = false;
2259 if (lock_name && !idl->lock_name) {
2260 /* Acquire new lock. */
2261 idl->lock_name = xstrdup(lock_name);
2262 ovsdb_idl_send_lock_request(idl);
2266 /* Returns true if 'idl' is configured to obtain a lock and owns that lock.
2268 * Locking and unlocking happens asynchronously from the database client's
2269 * point of view, so the information is only useful for optimization (e.g. if
2270 * the client doesn't have the lock then there's no point in trying to write to
2273 ovsdb_idl_has_lock(const struct ovsdb_idl *idl)
2275 return idl->has_lock;
2278 /* Returns true if 'idl' is configured to obtain a lock but the database server
2279 * has indicated that some other client already owns the requested lock. */
2281 ovsdb_idl_is_lock_contended(const struct ovsdb_idl *idl)
2283 return idl->is_lock_contended;
2287 ovsdb_idl_update_has_lock(struct ovsdb_idl *idl, bool new_has_lock)
2289 if (new_has_lock && !idl->has_lock) {
2290 if (!idl->monitor_request_id) {
2291 idl->change_seqno++;
2293 /* We're waiting for a monitor reply, so don't signal that the
2294 * database changed. The monitor reply will increment change_seqno
2297 idl->is_lock_contended = false;
2299 idl->has_lock = new_has_lock;
2303 ovsdb_idl_send_lock_request__(struct ovsdb_idl *idl, const char *method,
2306 ovsdb_idl_update_has_lock(idl, false);
2308 json_destroy(idl->lock_request_id);
2309 idl->lock_request_id = NULL;
2311 if (jsonrpc_session_is_connected(idl->session)) {
2312 struct json *params;
2314 params = json_array_create_1(json_string_create(idl->lock_name));
2315 jsonrpc_session_send(idl->session,
2316 jsonrpc_create_request(method, params, idp));
2321 ovsdb_idl_send_lock_request(struct ovsdb_idl *idl)
2323 ovsdb_idl_send_lock_request__(idl, "lock", &idl->lock_request_id);
2327 ovsdb_idl_send_unlock_request(struct ovsdb_idl *idl)
2329 ovsdb_idl_send_lock_request__(idl, "unlock", NULL);
2333 ovsdb_idl_parse_lock_reply(struct ovsdb_idl *idl, const struct json *result)
2337 json_destroy(idl->lock_request_id);
2338 idl->lock_request_id = NULL;
2340 if (result->type == JSON_OBJECT) {
2341 const struct json *locked;
2343 locked = shash_find_data(json_object(result), "locked");
2344 got_lock = locked && locked->type == JSON_TRUE;
2349 ovsdb_idl_update_has_lock(idl, got_lock);
2351 idl->is_lock_contended = true;
2356 ovsdb_idl_parse_lock_notify(struct ovsdb_idl *idl,
2357 const struct json *params,
2361 && params->type == JSON_ARRAY
2362 && json_array(params)->n > 0
2363 && json_array(params)->elems[0]->type == JSON_STRING) {
2364 const char *lock_name = json_string(json_array(params)->elems[0]);
2366 if (!strcmp(idl->lock_name, lock_name)) {
2367 ovsdb_idl_update_has_lock(idl, new_has_lock);
2368 if (!new_has_lock) {
2369 idl->is_lock_contended = true;