1 /* Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016 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 "openvswitch/dynamic-string.h"
28 #include "fatal-signal.h"
31 #include "ovsdb/ovsdb.h"
32 #include "ovsdb/table.h"
33 #include "ovsdb-data.h"
34 #include "ovsdb-error.h"
35 #include "ovsdb-idl-provider.h"
36 #include "ovsdb-parser.h"
37 #include "poll-loop.h"
41 #include "openvswitch/vlog.h"
43 VLOG_DEFINE_THIS_MODULE(ovsdb_idl);
45 COVERAGE_DEFINE(txn_uncommitted);
46 COVERAGE_DEFINE(txn_unchanged);
47 COVERAGE_DEFINE(txn_incomplete);
48 COVERAGE_DEFINE(txn_aborted);
49 COVERAGE_DEFINE(txn_success);
50 COVERAGE_DEFINE(txn_try_again);
51 COVERAGE_DEFINE(txn_not_locked);
52 COVERAGE_DEFINE(txn_error);
54 /* An arc from one idl_row to another. When row A contains a UUID that
55 * references row B, this is represented by an arc from A (the source) to B
58 * Arcs from a row to itself are omitted, that is, src and dst are always
61 * Arcs are never duplicated, that is, even if there are multiple references
62 * from A to B, there is only a single arc from A to B.
64 * Arcs are directed: an arc from A to B is the converse of an an arc from B to
65 * A. Both an arc and its converse may both be present, if each row refers
66 * to the other circularly.
68 * The source and destination row may be in the same table or in different
71 struct ovsdb_idl_arc {
72 struct ovs_list src_node; /* In src->src_arcs list. */
73 struct ovs_list dst_node; /* In dst->dst_arcs list. */
74 struct ovsdb_idl_row *src; /* Source row. */
75 struct ovsdb_idl_row *dst; /* Destination row. */
78 enum ovsdb_idl_state {
79 IDL_S_SCHEMA_REQUESTED,
80 IDL_S_MONITOR_REQUESTED,
82 IDL_S_MONITOR2_REQUESTED,
88 const struct ovsdb_idl_class *class;
89 struct jsonrpc_session *session;
90 struct shash table_by_name;
91 struct ovsdb_idl_table *tables; /* Contains "struct ovsdb_idl_table *"s.*/
92 unsigned int change_seqno;
93 bool verify_write_only;
96 unsigned int state_seqno;
97 enum ovsdb_idl_state state;
98 struct json *request_id;
101 /* Database locking. */
102 char *lock_name; /* Name of lock we need, NULL if none. */
103 bool has_lock; /* Has db server told us we have the lock? */
104 bool is_lock_contended; /* Has db server told us we can't get lock? */
105 struct json *lock_request_id; /* JSON-RPC ID of in-flight lock request. */
107 /* Transaction support. */
108 struct ovsdb_idl_txn *txn;
109 struct hmap outstanding_txns;
112 struct ovsdb_idl_txn {
113 struct hmap_node hmap_node;
114 struct json *request_id;
115 struct ovsdb_idl *idl;
116 struct hmap txn_rows;
117 enum ovsdb_idl_txn_status status;
123 const char *inc_table;
124 const char *inc_column;
126 unsigned int inc_index;
127 int64_t inc_new_value;
130 struct hmap inserted_rows; /* Contains "struct ovsdb_idl_txn_insert"s. */
133 struct ovsdb_idl_txn_insert {
134 struct hmap_node hmap_node; /* In struct ovsdb_idl_txn's inserted_rows. */
135 struct uuid dummy; /* Dummy UUID used locally. */
136 int op_index; /* Index into transaction's operation array. */
137 struct uuid real; /* Real UUID used by database server. */
140 enum ovsdb_update_version {
141 OVSDB_UPDATE, /* RFC 7047 "update" method. */
142 OVSDB_UPDATE2 /* "update2" Extension to RFC 7047.
143 See ovsdb-server(1) for more information. */
146 /* Name arrays indexed by 'enum ovsdb_update_version'. */
147 static const char *table_updates_names[] = {"table_updates", "table_updates2"};
148 static const char *table_update_names[] = {"table_update", "table_update2"};
149 static const char *row_update_names[] = {"row_update", "row_update2"};
151 static struct vlog_rate_limit syntax_rl = VLOG_RATE_LIMIT_INIT(1, 5);
152 static struct vlog_rate_limit semantic_rl = VLOG_RATE_LIMIT_INIT(1, 5);
154 static void ovsdb_idl_clear(struct ovsdb_idl *);
155 static void ovsdb_idl_send_schema_request(struct ovsdb_idl *);
156 static void ovsdb_idl_send_monitor_request(struct ovsdb_idl *);
157 static void ovsdb_idl_send_monitor2_request(struct ovsdb_idl *);
158 static void ovsdb_idl_parse_update(struct ovsdb_idl *, const struct json *,
159 enum ovsdb_update_version);
160 static struct ovsdb_error *ovsdb_idl_parse_update__(struct ovsdb_idl *,
162 enum ovsdb_update_version);
163 static bool ovsdb_idl_process_update(struct ovsdb_idl_table *,
165 const struct json *old,
166 const struct json *new);
167 static bool ovsdb_idl_process_update2(struct ovsdb_idl_table *,
169 const char *operation,
170 const struct json *row);
171 static void ovsdb_idl_insert_row(struct ovsdb_idl_row *, const struct json *);
172 static void ovsdb_idl_delete_row(struct ovsdb_idl_row *);
173 static bool ovsdb_idl_modify_row(struct ovsdb_idl_row *, const struct json *);
174 static bool ovsdb_idl_modify_row_by_diff(struct ovsdb_idl_row *,
175 const struct json *);
177 static bool ovsdb_idl_row_is_orphan(const struct ovsdb_idl_row *);
178 static struct ovsdb_idl_row *ovsdb_idl_row_create__(
179 const struct ovsdb_idl_table_class *);
180 static struct ovsdb_idl_row *ovsdb_idl_row_create(struct ovsdb_idl_table *,
181 const struct uuid *);
182 static void ovsdb_idl_row_destroy(struct ovsdb_idl_row *);
183 static void ovsdb_idl_row_destroy_postprocess(struct ovsdb_idl *);
185 static void ovsdb_idl_row_parse(struct ovsdb_idl_row *);
186 static void ovsdb_idl_row_unparse(struct ovsdb_idl_row *);
187 static void ovsdb_idl_row_clear_old(struct ovsdb_idl_row *);
188 static void ovsdb_idl_row_clear_new(struct ovsdb_idl_row *);
189 static void ovsdb_idl_row_clear_arcs(struct ovsdb_idl_row *, bool destroy_dsts);
191 static void ovsdb_idl_txn_abort_all(struct ovsdb_idl *);
192 static bool ovsdb_idl_txn_process_reply(struct ovsdb_idl *,
193 const struct jsonrpc_msg *msg);
195 static void ovsdb_idl_send_lock_request(struct ovsdb_idl *);
196 static void ovsdb_idl_send_unlock_request(struct ovsdb_idl *);
197 static void ovsdb_idl_parse_lock_reply(struct ovsdb_idl *,
198 const struct json *);
199 static void ovsdb_idl_parse_lock_notify(struct ovsdb_idl *,
200 const struct json *params,
202 static struct ovsdb_idl_table *
203 ovsdb_idl_table_from_class(const struct ovsdb_idl *,
204 const struct ovsdb_idl_table_class *);
205 static bool ovsdb_idl_track_is_set(struct ovsdb_idl_table *table);
207 /* Creates and returns a connection to database 'remote', which should be in a
208 * form acceptable to jsonrpc_session_open(). The connection will maintain an
209 * in-memory replica of the remote database whose schema is described by
210 * 'class'. (Ordinarily 'class' is compiled from an OVSDB schema automatically
213 * Passes 'retry' to jsonrpc_session_open(). See that function for
216 * If 'monitor_everything_by_default' is true, then everything in the remote
217 * database will be replicated by default. ovsdb_idl_omit() and
218 * ovsdb_idl_omit_alert() may be used to selectively drop some columns from
221 * If 'monitor_everything_by_default' is false, then no columns or tables will
222 * be replicated by default. ovsdb_idl_add_column() and ovsdb_idl_add_table()
223 * must be used to choose some columns or tables to replicate.
226 ovsdb_idl_create(const char *remote, const struct ovsdb_idl_class *class,
227 bool monitor_everything_by_default, bool retry)
229 struct ovsdb_idl *idl;
230 uint8_t default_mode;
233 default_mode = (monitor_everything_by_default
234 ? OVSDB_IDL_MONITOR | OVSDB_IDL_ALERT
237 idl = xzalloc(sizeof *idl);
239 idl->session = jsonrpc_session_open(remote, retry);
240 shash_init(&idl->table_by_name);
241 idl->tables = xmalloc(class->n_tables * sizeof *idl->tables);
242 for (i = 0; i < class->n_tables; i++) {
243 const struct ovsdb_idl_table_class *tc = &class->tables[i];
244 struct ovsdb_idl_table *table = &idl->tables[i];
247 shash_add_assert(&idl->table_by_name, tc->name, table);
249 table->modes = xmalloc(tc->n_columns);
250 memset(table->modes, default_mode, tc->n_columns);
251 table->need_table = false;
252 shash_init(&table->columns);
253 for (j = 0; j < tc->n_columns; j++) {
254 const struct ovsdb_idl_column *column = &tc->columns[j];
256 shash_add_assert(&table->columns, column->name, column);
258 hmap_init(&table->rows);
259 ovs_list_init(&table->track_list);
260 table->change_seqno[OVSDB_IDL_CHANGE_INSERT]
261 = table->change_seqno[OVSDB_IDL_CHANGE_MODIFY]
262 = table->change_seqno[OVSDB_IDL_CHANGE_DELETE] = 0;
266 idl->state_seqno = UINT_MAX;
267 idl->request_id = NULL;
270 hmap_init(&idl->outstanding_txns);
275 /* Destroys 'idl' and all of the data structures that it manages. */
277 ovsdb_idl_destroy(struct ovsdb_idl *idl)
282 ovs_assert(!idl->txn);
283 ovsdb_idl_clear(idl);
284 jsonrpc_session_close(idl->session);
286 for (i = 0; i < idl->class->n_tables; i++) {
287 struct ovsdb_idl_table *table = &idl->tables[i];
288 shash_destroy(&table->columns);
289 hmap_destroy(&table->rows);
292 shash_destroy(&idl->table_by_name);
294 json_destroy(idl->request_id);
295 free(idl->lock_name);
296 json_destroy(idl->lock_request_id);
297 json_destroy(idl->schema);
298 hmap_destroy(&idl->outstanding_txns);
304 ovsdb_idl_clear(struct ovsdb_idl *idl)
306 bool changed = false;
309 for (i = 0; i < idl->class->n_tables; i++) {
310 struct ovsdb_idl_table *table = &idl->tables[i];
311 struct ovsdb_idl_row *row, *next_row;
313 if (hmap_is_empty(&table->rows)) {
318 HMAP_FOR_EACH_SAFE (row, next_row, hmap_node, &table->rows) {
319 struct ovsdb_idl_arc *arc, *next_arc;
321 if (!ovsdb_idl_row_is_orphan(row)) {
322 ovsdb_idl_row_unparse(row);
324 LIST_FOR_EACH_SAFE (arc, next_arc, src_node, &row->src_arcs) {
327 /* No need to do anything with dst_arcs: some node has those arcs
328 * as forward arcs and will destroy them itself. */
330 if (!ovs_list_is_empty(&row->track_node)) {
331 ovs_list_remove(&row->track_node);
334 ovsdb_idl_row_destroy(row);
338 ovsdb_idl_track_clear(idl);
345 /* Processes a batch of messages from the database server on 'idl'. This may
346 * cause the IDL's contents to change. The client may check for that with
347 * ovsdb_idl_get_seqno(). */
349 ovsdb_idl_run(struct ovsdb_idl *idl)
353 ovs_assert(!idl->txn);
354 jsonrpc_session_run(idl->session);
355 for (i = 0; jsonrpc_session_is_connected(idl->session) && i < 50; i++) {
356 struct jsonrpc_msg *msg;
359 seqno = jsonrpc_session_get_seqno(idl->session);
360 if (idl->state_seqno != seqno) {
361 idl->state_seqno = seqno;
362 json_destroy(idl->request_id);
363 idl->request_id = NULL;
364 ovsdb_idl_txn_abort_all(idl);
366 ovsdb_idl_send_schema_request(idl);
367 idl->state = IDL_S_SCHEMA_REQUESTED;
368 if (idl->lock_name) {
369 ovsdb_idl_send_lock_request(idl);
373 msg = jsonrpc_session_recv(idl->session);
378 if (msg->type == JSONRPC_NOTIFY
379 && !strcmp(msg->method, "update2")
380 && msg->params->type == JSON_ARRAY
381 && msg->params->u.array.n == 2
382 && msg->params->u.array.elems[0]->type == JSON_NULL) {
383 /* Database contents changed. */
384 ovsdb_idl_parse_update(idl, msg->params->u.array.elems[1],
386 } else if (msg->type == JSONRPC_REPLY
388 && json_equal(idl->request_id, msg->id)) {
389 json_destroy(idl->request_id);
390 idl->request_id = NULL;
392 switch (idl->state) {
393 case IDL_S_SCHEMA_REQUESTED:
394 /* Reply to our "get_schema" request. */
395 idl->schema = json_clone(msg->result);
396 ovsdb_idl_send_monitor2_request(idl);
397 idl->state = IDL_S_MONITOR2_REQUESTED;
400 case IDL_S_MONITOR_REQUESTED:
401 case IDL_S_MONITOR2_REQUESTED:
402 /* Reply to our "monitor" or "monitor2" request. */
404 ovsdb_idl_clear(idl);
405 if (idl->state == IDL_S_MONITOR_REQUESTED) {
406 idl->state = IDL_S_MONITORING;
407 ovsdb_idl_parse_update(idl, msg->result, OVSDB_UPDATE);
408 } else { /* IDL_S_MONITOR2_REQUESTED. */
409 idl->state = IDL_S_MONITORING2;
410 ovsdb_idl_parse_update(idl, msg->result, OVSDB_UPDATE2);
413 /* Schema is not useful after monitor request is accepted
415 json_destroy(idl->schema);
419 case IDL_S_MONITORING:
420 case IDL_S_MONITORING2:
421 case IDL_S_NO_SCHEMA:
425 } else if (msg->type == JSONRPC_NOTIFY
426 && !strcmp(msg->method, "update")
427 && msg->params->type == JSON_ARRAY
428 && msg->params->u.array.n == 2
429 && msg->params->u.array.elems[0]->type == JSON_NULL) {
430 /* Database contents changed. */
431 ovsdb_idl_parse_update(idl, msg->params->u.array.elems[1],
433 } else if (msg->type == JSONRPC_REPLY
434 && idl->lock_request_id
435 && json_equal(idl->lock_request_id, msg->id)) {
436 /* Reply to our "lock" request. */
437 ovsdb_idl_parse_lock_reply(idl, msg->result);
438 } else if (msg->type == JSONRPC_NOTIFY
439 && !strcmp(msg->method, "locked")) {
440 /* We got our lock. */
441 ovsdb_idl_parse_lock_notify(idl, msg->params, true);
442 } else if (msg->type == JSONRPC_NOTIFY
443 && !strcmp(msg->method, "stolen")) {
444 /* Someone else stole our lock. */
445 ovsdb_idl_parse_lock_notify(idl, msg->params, false);
446 } else if (msg->type == JSONRPC_ERROR
447 && idl->state == IDL_S_MONITOR2_REQUESTED
449 && json_equal(idl->request_id, msg->id)) {
450 if (msg->error && !strcmp(json_string(msg->error),
452 /* Fall back to using "monitor" method. */
453 json_destroy(idl->request_id);
454 idl->request_id = NULL;
455 ovsdb_idl_send_monitor_request(idl);
456 idl->state = IDL_S_MONITOR_REQUESTED;
458 } else if (msg->type == JSONRPC_ERROR
459 && idl->state == IDL_S_SCHEMA_REQUESTED
461 && json_equal(idl->request_id, msg->id)) {
462 json_destroy(idl->request_id);
463 idl->request_id = NULL;
464 VLOG_ERR("%s: requested schema not found",
465 jsonrpc_session_get_name(idl->session));
466 idl->state = IDL_S_NO_SCHEMA;
467 } else if ((msg->type == JSONRPC_ERROR
468 || msg->type == JSONRPC_REPLY)
469 && ovsdb_idl_txn_process_reply(idl, msg)) {
470 /* ovsdb_idl_txn_process_reply() did everything needful. */
472 /* This can happen if ovsdb_idl_txn_destroy() is called to destroy
473 * a transaction before we receive the reply, so keep the log level
475 VLOG_DBG("%s: received unexpected %s message",
476 jsonrpc_session_get_name(idl->session),
477 jsonrpc_msg_type_to_string(msg->type));
479 jsonrpc_msg_destroy(msg);
481 ovsdb_idl_row_destroy_postprocess(idl);
484 /* Arranges for poll_block() to wake up when ovsdb_idl_run() has something to
485 * do or when activity occurs on a transaction on 'idl'. */
487 ovsdb_idl_wait(struct ovsdb_idl *idl)
489 jsonrpc_session_wait(idl->session);
490 jsonrpc_session_recv_wait(idl->session);
493 /* Returns a "sequence number" that represents the state of 'idl'. When
494 * ovsdb_idl_run() changes the database, the sequence number changes. The
495 * initial fetch of the entire contents of the remote database is considered to
496 * be one kind of change. Successfully acquiring a lock, if one has been
497 * configured with ovsdb_idl_set_lock(), is also considered to be a change.
499 * As long as the sequence number does not change, the client may continue to
500 * use any data structures it obtains from 'idl'. But when it changes, the
501 * client must not access any of these data structures again, because they
502 * could have freed or reused for other purposes.
504 * The sequence number can occasionally change even if the database does not.
505 * This happens if the connection to the database drops and reconnects, which
506 * causes the database contents to be reloaded even if they didn't change. (It
507 * could also happen if the database server sends out a "change" that reflects
508 * what the IDL already thought was in the database. The database server is
509 * not supposed to do that, but bugs could in theory cause it to do so.) */
511 ovsdb_idl_get_seqno(const struct ovsdb_idl *idl)
513 return idl->change_seqno;
516 /* Returns true if 'idl' successfully connected to the remote database and
517 * retrieved its contents (even if the connection subsequently dropped and is
518 * in the process of reconnecting). If so, then 'idl' contains an atomic
519 * snapshot of the database's contents (but it might be arbitrarily old if the
520 * connection dropped).
522 * Returns false if 'idl' has never connected or retrieved the database's
523 * contents. If so, 'idl' is empty. */
525 ovsdb_idl_has_ever_connected(const struct ovsdb_idl *idl)
527 return ovsdb_idl_get_seqno(idl) != 0;
530 /* Reconfigures 'idl' so that it would reconnect to the database, if
531 * connection was dropped. */
533 ovsdb_idl_enable_reconnect(struct ovsdb_idl *idl)
535 jsonrpc_session_enable_reconnect(idl->session);
538 /* Forces 'idl' to drop its connection to the database and reconnect. In the
539 * meantime, the contents of 'idl' will not change. */
541 ovsdb_idl_force_reconnect(struct ovsdb_idl *idl)
543 jsonrpc_session_force_reconnect(idl->session);
546 /* Some IDL users should only write to write-only columns. Furthermore,
547 * writing to a column which is not write-only can cause serious performance
548 * degradations for these users. This function causes 'idl' to reject writes
549 * to columns which are not marked write only using ovsdb_idl_omit_alert(). */
551 ovsdb_idl_verify_write_only(struct ovsdb_idl *idl)
553 idl->verify_write_only = true;
556 /* Returns true if 'idl' is currently connected or trying to connect
557 * and a negative response to a schema request has not been received */
559 ovsdb_idl_is_alive(const struct ovsdb_idl *idl)
561 return jsonrpc_session_is_alive(idl->session) &&
562 idl->state != IDL_S_NO_SCHEMA;
565 /* Returns the last error reported on a connection by 'idl'. The return value
566 * is 0 only if no connection made by 'idl' has ever encountered an error and
567 * a negative response to a schema request has never been received. See
568 * jsonrpc_get_status() for jsonrpc_session_get_last_error() return value
571 ovsdb_idl_get_last_error(const struct ovsdb_idl *idl)
575 err = jsonrpc_session_get_last_error(idl->session);
579 } else if (idl->state == IDL_S_NO_SCHEMA) {
586 /* Sets the "probe interval" for 'idl->session' to 'probe_interval', in
590 ovsdb_idl_set_probe_interval(const struct ovsdb_idl *idl, int probe_interval)
592 jsonrpc_session_set_probe_interval(idl->session, probe_interval);
595 static unsigned char *
596 ovsdb_idl_get_mode(struct ovsdb_idl *idl,
597 const struct ovsdb_idl_column *column)
601 ovs_assert(!idl->change_seqno);
603 for (i = 0; i < idl->class->n_tables; i++) {
604 const struct ovsdb_idl_table *table = &idl->tables[i];
605 const struct ovsdb_idl_table_class *tc = table->class;
607 if (column >= tc->columns && column < &tc->columns[tc->n_columns]) {
608 return &table->modes[column - tc->columns];
616 add_ref_table(struct ovsdb_idl *idl, const struct ovsdb_base_type *base)
618 if (base->type == OVSDB_TYPE_UUID && base->u.uuid.refTableName) {
619 struct ovsdb_idl_table *table;
621 table = shash_find_data(&idl->table_by_name,
622 base->u.uuid.refTableName);
624 table->need_table = true;
626 VLOG_WARN("%s IDL class missing referenced table %s",
627 idl->class->database, base->u.uuid.refTableName);
632 /* Turns on OVSDB_IDL_MONITOR and OVSDB_IDL_ALERT for 'column' in 'idl'. Also
633 * ensures that any tables referenced by 'column' will be replicated, even if
634 * no columns in that table are selected for replication (see
635 * ovsdb_idl_add_table() for more information).
637 * This function is only useful if 'monitor_everything_by_default' was false in
638 * the call to ovsdb_idl_create(). This function should be called between
639 * ovsdb_idl_create() and the first call to ovsdb_idl_run().
642 ovsdb_idl_add_column(struct ovsdb_idl *idl,
643 const struct ovsdb_idl_column *column)
645 *ovsdb_idl_get_mode(idl, column) = OVSDB_IDL_MONITOR | OVSDB_IDL_ALERT;
646 add_ref_table(idl, &column->type.key);
647 add_ref_table(idl, &column->type.value);
650 /* Ensures that the table with class 'tc' will be replicated on 'idl' even if
651 * no columns are selected for replication. Just the necessary data for table
652 * references will be replicated (the UUID of the rows, for instance), any
653 * columns not selected for replication will remain unreplicated.
654 * This can be useful because it allows 'idl' to keep track of what rows in the
655 * table actually exist, which in turn allows columns that reference the table
656 * to have accurate contents. (The IDL presents the database with references to
657 * rows that do not exist removed.)
659 * This function is only useful if 'monitor_everything_by_default' was false in
660 * the call to ovsdb_idl_create(). This function should be called between
661 * ovsdb_idl_create() and the first call to ovsdb_idl_run().
664 ovsdb_idl_add_table(struct ovsdb_idl *idl,
665 const struct ovsdb_idl_table_class *tc)
669 for (i = 0; i < idl->class->n_tables; i++) {
670 struct ovsdb_idl_table *table = &idl->tables[i];
672 if (table->class == tc) {
673 table->need_table = true;
681 /* Turns off OVSDB_IDL_ALERT for 'column' in 'idl'.
683 * This function should be called between ovsdb_idl_create() and the first call
684 * to ovsdb_idl_run().
687 ovsdb_idl_omit_alert(struct ovsdb_idl *idl,
688 const struct ovsdb_idl_column *column)
690 *ovsdb_idl_get_mode(idl, column) &= ~OVSDB_IDL_ALERT;
693 /* Sets the mode for 'column' in 'idl' to 0. See the big comment above
694 * OVSDB_IDL_MONITOR for details.
696 * This function should be called between ovsdb_idl_create() and the first call
697 * to ovsdb_idl_run().
700 ovsdb_idl_omit(struct ovsdb_idl *idl, const struct ovsdb_idl_column *column)
702 *ovsdb_idl_get_mode(idl, column) = 0;
705 /* Returns the most recent IDL change sequence number that caused a
706 * insert, modify or delete update to the table with class 'table_class'.
709 ovsdb_idl_table_get_seqno(const struct ovsdb_idl *idl,
710 const struct ovsdb_idl_table_class *table_class)
712 struct ovsdb_idl_table *table
713 = ovsdb_idl_table_from_class(idl, table_class);
714 unsigned int max_seqno = table->change_seqno[OVSDB_IDL_CHANGE_INSERT];
716 if (max_seqno < table->change_seqno[OVSDB_IDL_CHANGE_MODIFY]) {
717 max_seqno = table->change_seqno[OVSDB_IDL_CHANGE_MODIFY];
719 if (max_seqno < table->change_seqno[OVSDB_IDL_CHANGE_DELETE]) {
720 max_seqno = table->change_seqno[OVSDB_IDL_CHANGE_DELETE];
725 /* For each row that contains tracked columns, IDL stores the most
726 * recent IDL change sequence numbers associateed with insert, modify
727 * and delete updates to the table.
730 ovsdb_idl_row_get_seqno(const struct ovsdb_idl_row *row,
731 enum ovsdb_idl_change change)
733 return row->change_seqno[change];
736 /* Turns on OVSDB_IDL_TRACK for 'column' in 'idl', ensuring that
737 * all rows whose 'column' is modified are traced. Similarly, insert
738 * or delete of rows having 'column' are tracked. Clients are able
739 * to retrive the tracked rows with the ovsdb_idl_track_get_*()
742 * This function should be called between ovsdb_idl_create() and
743 * the first call to ovsdb_idl_run(). The column to be tracked
744 * should have OVSDB_IDL_ALERT turned on.
747 ovsdb_idl_track_add_column(struct ovsdb_idl *idl,
748 const struct ovsdb_idl_column *column)
750 if (!(*ovsdb_idl_get_mode(idl, column) & OVSDB_IDL_ALERT)) {
751 ovsdb_idl_add_column(idl, column);
753 *ovsdb_idl_get_mode(idl, column) |= OVSDB_IDL_TRACK;
757 ovsdb_idl_track_add_all(struct ovsdb_idl *idl)
761 for (i = 0; i < idl->class->n_tables; i++) {
762 const struct ovsdb_idl_table_class *tc = &idl->class->tables[i];
764 for (j = 0; j < tc->n_columns; j++) {
765 const struct ovsdb_idl_column *column = &tc->columns[j];
766 ovsdb_idl_track_add_column(idl, column);
771 /* Returns true if 'table' has any tracked column. */
773 ovsdb_idl_track_is_set(struct ovsdb_idl_table *table)
777 for (i = 0; i < table->class->n_columns; i++) {
778 if (table->modes[i] & OVSDB_IDL_TRACK) {
785 /* Returns the first tracked row in table with class 'table_class'
786 * for the specified 'idl'. Returns NULL if there are no tracked rows */
787 const struct ovsdb_idl_row *
788 ovsdb_idl_track_get_first(const struct ovsdb_idl *idl,
789 const struct ovsdb_idl_table_class *table_class)
791 struct ovsdb_idl_table *table
792 = ovsdb_idl_table_from_class(idl, table_class);
794 if (!ovs_list_is_empty(&table->track_list)) {
795 return CONTAINER_OF(ovs_list_front(&table->track_list), struct ovsdb_idl_row, track_node);
800 /* Returns the next tracked row in table after the specified 'row'
801 * (in no particular order). Returns NULL if there are no tracked rows */
802 const struct ovsdb_idl_row *
803 ovsdb_idl_track_get_next(const struct ovsdb_idl_row *row)
805 if (row->track_node.next != &row->table->track_list) {
806 return CONTAINER_OF(row->track_node.next, struct ovsdb_idl_row, track_node);
812 /* Returns true if a tracked 'column' in 'row' was updated by IDL, false
813 * otherwise. The tracking data is cleared by ovsdb_idl_track_clear()
815 * Function returns false if 'column' is not tracked (see
816 * ovsdb_idl_track_add_column()).
819 ovsdb_idl_track_is_updated(const struct ovsdb_idl_row *row,
820 const struct ovsdb_idl_column *column)
822 const struct ovsdb_idl_table_class *class;
825 class = row->table->class;
826 column_idx = column - class->columns;
828 if (row->updated && bitmap_is_set(row->updated, column_idx)) {
835 /* Flushes the tracked rows. Client calls this function after calling
836 * ovsdb_idl_run() and read all tracked rows with the ovsdb_idl_track_get_*()
837 * functions. This is usually done at the end of the client's processing
838 * loop when it is ready to do ovsdb_idl_run() again.
841 ovsdb_idl_track_clear(const struct ovsdb_idl *idl)
845 for (i = 0; i < idl->class->n_tables; i++) {
846 struct ovsdb_idl_table *table = &idl->tables[i];
848 if (!ovs_list_is_empty(&table->track_list)) {
849 struct ovsdb_idl_row *row, *next;
851 LIST_FOR_EACH_SAFE(row, next, track_node, &table->track_list) {
856 ovs_list_remove(&row->track_node);
857 ovs_list_init(&row->track_node);
858 if (ovsdb_idl_row_is_orphan(row)) {
859 ovsdb_idl_row_clear_old(row);
869 ovsdb_idl_send_schema_request(struct ovsdb_idl *idl)
871 struct jsonrpc_msg *msg;
873 json_destroy(idl->request_id);
874 msg = jsonrpc_create_request(
876 json_array_create_1(json_string_create(idl->class->database)),
878 jsonrpc_session_send(idl->session, msg);
882 log_error(struct ovsdb_error *error)
884 char *s = ovsdb_error_to_string(error);
885 VLOG_WARN("error parsing database schema: %s", s);
887 ovsdb_error_destroy(error);
890 /* Frees 'schema', which is in the format returned by parse_schema(). */
892 free_schema(struct shash *schema)
895 struct shash_node *node, *next;
897 SHASH_FOR_EACH_SAFE (node, next, schema) {
898 struct sset *sset = node->data;
901 shash_delete(schema, node);
903 shash_destroy(schema);
908 /* Parses 'schema_json', an OVSDB schema in JSON format as described in RFC
909 * 7047, to obtain the names of its rows and columns. If successful, returns
910 * an shash whose keys are table names and whose values are ssets, where each
911 * sset contains the names of its table's columns. On failure (due to a parse
912 * error), returns NULL.
914 * It would also be possible to use the general-purpose OVSDB schema parser in
915 * ovsdb-server, but that's overkill, possibly too strict for the current use
916 * case, and would require restructuring ovsdb-server to separate the schema
917 * code from the rest. */
918 static struct shash *
919 parse_schema(const struct json *schema_json)
921 struct ovsdb_parser parser;
922 const struct json *tables_json;
923 struct ovsdb_error *error;
924 struct shash_node *node;
925 struct shash *schema;
927 ovsdb_parser_init(&parser, schema_json, "database schema");
928 tables_json = ovsdb_parser_member(&parser, "tables", OP_OBJECT);
929 error = ovsdb_parser_destroy(&parser);
935 schema = xmalloc(sizeof *schema);
937 SHASH_FOR_EACH (node, json_object(tables_json)) {
938 const char *table_name = node->name;
939 const struct json *json = node->data;
940 const struct json *columns_json;
942 ovsdb_parser_init(&parser, json, "table schema for table %s",
944 columns_json = ovsdb_parser_member(&parser, "columns", OP_OBJECT);
945 error = ovsdb_parser_destroy(&parser);
952 struct sset *columns = xmalloc(sizeof *columns);
955 struct shash_node *node2;
956 SHASH_FOR_EACH (node2, json_object(columns_json)) {
957 const char *column_name = node2->name;
958 sset_add(columns, column_name);
960 shash_add(schema, table_name, columns);
966 ovsdb_idl_send_monitor_request__(struct ovsdb_idl *idl,
969 struct shash *schema;
970 struct json *monitor_requests;
971 struct jsonrpc_msg *msg;
974 schema = parse_schema(idl->schema);
975 monitor_requests = json_object_create();
976 for (i = 0; i < idl->class->n_tables; i++) {
977 const struct ovsdb_idl_table *table = &idl->tables[i];
978 const struct ovsdb_idl_table_class *tc = table->class;
979 struct json *monitor_request, *columns;
980 const struct sset *table_schema;
983 table_schema = (schema
984 ? shash_find_data(schema, table->class->name)
987 columns = table->need_table ? json_array_create_empty() : NULL;
988 for (j = 0; j < tc->n_columns; j++) {
989 const struct ovsdb_idl_column *column = &tc->columns[j];
990 if (table->modes[j] & OVSDB_IDL_MONITOR) {
992 && !sset_contains(table_schema, column->name)) {
993 VLOG_WARN("%s table in %s database lacks %s column "
994 "(database needs upgrade?)",
995 table->class->name, idl->class->database,
1000 columns = json_array_create_empty();
1002 json_array_add(columns, json_string_create(column->name));
1007 if (schema && !table_schema) {
1008 VLOG_WARN("%s database lacks %s table "
1009 "(database needs upgrade?)",
1010 idl->class->database, table->class->name);
1011 json_destroy(columns);
1015 monitor_request = json_object_create();
1016 json_object_put(monitor_request, "columns", columns);
1017 json_object_put(monitor_requests, tc->name, monitor_request);
1020 free_schema(schema);
1022 json_destroy(idl->request_id);
1023 msg = jsonrpc_create_request(
1025 json_array_create_3(json_string_create(idl->class->database),
1026 json_null_create(), monitor_requests),
1028 jsonrpc_session_send(idl->session, msg);
1032 ovsdb_idl_send_monitor_request(struct ovsdb_idl *idl)
1034 ovsdb_idl_send_monitor_request__(idl, "monitor");
1038 log_parse_update_error(struct ovsdb_error *error)
1040 if (!VLOG_DROP_WARN(&syntax_rl)) {
1041 char *s = ovsdb_error_to_string(error);
1042 VLOG_WARN_RL(&syntax_rl, "%s", s);
1045 ovsdb_error_destroy(error);
1049 ovsdb_idl_send_monitor2_request(struct ovsdb_idl *idl)
1051 ovsdb_idl_send_monitor_request__(idl, "monitor2");
1055 ovsdb_idl_parse_update(struct ovsdb_idl *idl, const struct json *table_updates,
1056 enum ovsdb_update_version version)
1058 struct ovsdb_error *error = ovsdb_idl_parse_update__(idl, table_updates,
1061 log_parse_update_error(error);
1065 static struct ovsdb_error *
1066 ovsdb_idl_parse_update__(struct ovsdb_idl *idl,
1067 const struct json *table_updates,
1068 enum ovsdb_update_version version)
1070 const struct shash_node *tables_node;
1071 const char *table_updates_name = table_updates_names[version];
1072 const char *table_update_name = table_update_names[version];
1073 const char *row_update_name = row_update_names[version];
1075 if (table_updates->type != JSON_OBJECT) {
1076 return ovsdb_syntax_error(table_updates, NULL,
1077 "<%s> is not an object",
1078 table_updates_name);
1081 SHASH_FOR_EACH (tables_node, json_object(table_updates)) {
1082 const struct json *table_update = tables_node->data;
1083 const struct shash_node *table_node;
1084 struct ovsdb_idl_table *table;
1086 table = shash_find_data(&idl->table_by_name, tables_node->name);
1088 return ovsdb_syntax_error(
1089 table_updates, NULL,
1090 "<%s> includes unknown table \"%s\"",
1095 if (table_update->type != JSON_OBJECT) {
1096 return ovsdb_syntax_error(table_update, NULL,
1097 "<%s> for table \"%s\" is "
1100 table->class->name);
1102 SHASH_FOR_EACH (table_node, json_object(table_update)) {
1103 const struct json *row_update = table_node->data;
1104 const struct json *old_json, *new_json;
1107 if (!uuid_from_string(&uuid, table_node->name)) {
1108 return ovsdb_syntax_error(table_update, NULL,
1109 "<%s> for table \"%s\" "
1110 "contains bad UUID "
1111 "\"%s\" as member name",
1116 if (row_update->type != JSON_OBJECT) {
1117 return ovsdb_syntax_error(row_update, NULL,
1118 "<%s> for table \"%s\" "
1119 "contains <%s> for %s that "
1129 old_json = shash_find_data(json_object(row_update), "old");
1130 new_json = shash_find_data(json_object(row_update), "new");
1131 if (old_json && old_json->type != JSON_OBJECT) {
1132 return ovsdb_syntax_error(old_json, NULL,
1133 "\"old\" <row> is not object");
1134 } else if (new_json && new_json->type != JSON_OBJECT) {
1135 return ovsdb_syntax_error(new_json, NULL,
1136 "\"new\" <row> is not object");
1137 } else if ((old_json != NULL) + (new_json != NULL)
1138 != shash_count(json_object(row_update))) {
1139 return ovsdb_syntax_error(row_update, NULL,
1140 "<row-update> contains "
1141 "unexpected member");
1142 } else if (!old_json && !new_json) {
1143 return ovsdb_syntax_error(row_update, NULL,
1144 "<row-update> missing \"old\" "
1145 "and \"new\" members");
1148 if (ovsdb_idl_process_update(table, &uuid, old_json,
1150 idl->change_seqno++;
1154 case OVSDB_UPDATE2: {
1155 const char *ops[] = {"modify", "insert", "delete", "initial"};
1156 const char *operation;
1157 const struct json *row;
1160 for (i = 0; i < ARRAY_SIZE(ops); i++) {
1162 row = shash_find_data(json_object(row_update), operation);
1165 if (ovsdb_idl_process_update2(table, &uuid, operation,
1167 idl->change_seqno++;
1173 /* row_update2 should contain one of the objects */
1174 if (i == ARRAY_SIZE(ops)) {
1175 return ovsdb_syntax_error(row_update, NULL,
1176 "<row_update2> includes unknown "
1191 static struct ovsdb_idl_row *
1192 ovsdb_idl_get_row(struct ovsdb_idl_table *table, const struct uuid *uuid)
1194 struct ovsdb_idl_row *row;
1196 HMAP_FOR_EACH_WITH_HASH (row, hmap_node, uuid_hash(uuid), &table->rows) {
1197 if (uuid_equals(&row->uuid, uuid)) {
1204 /* Returns true if a column with mode OVSDB_IDL_MODE_RW changed, false
1207 ovsdb_idl_process_update(struct ovsdb_idl_table *table,
1208 const struct uuid *uuid, const struct json *old,
1209 const struct json *new)
1211 struct ovsdb_idl_row *row;
1213 row = ovsdb_idl_get_row(table, uuid);
1216 if (row && !ovsdb_idl_row_is_orphan(row)) {
1217 /* XXX perhaps we should check the 'old' values? */
1218 ovsdb_idl_delete_row(row);
1220 VLOG_WARN_RL(&semantic_rl, "cannot delete missing row "UUID_FMT" "
1222 UUID_ARGS(uuid), table->class->name);
1228 ovsdb_idl_insert_row(ovsdb_idl_row_create(table, uuid), new);
1229 } else if (ovsdb_idl_row_is_orphan(row)) {
1230 ovsdb_idl_insert_row(row, new);
1232 VLOG_WARN_RL(&semantic_rl, "cannot add existing row "UUID_FMT" to "
1233 "table %s", UUID_ARGS(uuid), table->class->name);
1234 return ovsdb_idl_modify_row(row, new);
1239 /* XXX perhaps we should check the 'old' values? */
1240 if (!ovsdb_idl_row_is_orphan(row)) {
1241 return ovsdb_idl_modify_row(row, new);
1243 VLOG_WARN_RL(&semantic_rl, "cannot modify missing but "
1244 "referenced row "UUID_FMT" in table %s",
1245 UUID_ARGS(uuid), table->class->name);
1246 ovsdb_idl_insert_row(row, new);
1249 VLOG_WARN_RL(&semantic_rl, "cannot modify missing row "UUID_FMT" "
1250 "in table %s", UUID_ARGS(uuid), table->class->name);
1251 ovsdb_idl_insert_row(ovsdb_idl_row_create(table, uuid), new);
1258 /* Returns true if a column with mode OVSDB_IDL_MODE_RW changed, false
1261 ovsdb_idl_process_update2(struct ovsdb_idl_table *table,
1262 const struct uuid *uuid,
1263 const char *operation,
1264 const struct json *json_row)
1266 struct ovsdb_idl_row *row;
1268 row = ovsdb_idl_get_row(table, uuid);
1269 if (!strcmp(operation, "delete")) {
1271 if (row && !ovsdb_idl_row_is_orphan(row)) {
1272 ovsdb_idl_delete_row(row);
1274 VLOG_WARN_RL(&semantic_rl, "cannot delete missing row "UUID_FMT" "
1276 UUID_ARGS(uuid), table->class->name);
1279 } else if (!strcmp(operation, "insert") || !strcmp(operation, "initial")) {
1282 ovsdb_idl_insert_row(ovsdb_idl_row_create(table, uuid), json_row);
1283 } else if (ovsdb_idl_row_is_orphan(row)) {
1284 ovsdb_idl_insert_row(row, json_row);
1286 VLOG_WARN_RL(&semantic_rl, "cannot add existing row "UUID_FMT" to "
1287 "table %s", UUID_ARGS(uuid), table->class->name);
1288 ovsdb_idl_delete_row(row);
1289 ovsdb_idl_insert_row(row, json_row);
1291 } else if (!strcmp(operation, "modify")) {
1294 if (!ovsdb_idl_row_is_orphan(row)) {
1295 return ovsdb_idl_modify_row_by_diff(row, json_row);
1297 VLOG_WARN_RL(&semantic_rl, "cannot modify missing but "
1298 "referenced row "UUID_FMT" in table %s",
1299 UUID_ARGS(uuid), table->class->name);
1303 VLOG_WARN_RL(&semantic_rl, "cannot modify missing row "UUID_FMT" "
1304 "in table %s", UUID_ARGS(uuid), table->class->name);
1308 VLOG_WARN_RL(&semantic_rl, "unknown operation %s to "
1309 "table %s", operation, table->class->name);
1316 /* Returns true if a column with mode OVSDB_IDL_MODE_RW changed, false
1319 * Change 'row' either with the content of 'row_json' or by apply 'diff'.
1320 * Caller needs to provide either valid 'row_json' or 'diff', but not
1323 ovsdb_idl_row_change__(struct ovsdb_idl_row *row, const struct json *row_json,
1324 const struct json *diff_json,
1325 enum ovsdb_idl_change change)
1327 struct ovsdb_idl_table *table = row->table;
1328 const struct ovsdb_idl_table_class *class = table->class;
1329 struct shash_node *node;
1330 bool changed = false;
1331 bool apply_diff = diff_json != NULL;
1332 const struct json *json = apply_diff ? diff_json : row_json;
1334 SHASH_FOR_EACH (node, json_object(json)) {
1335 const char *column_name = node->name;
1336 const struct ovsdb_idl_column *column;
1337 struct ovsdb_datum datum;
1338 struct ovsdb_error *error;
1339 unsigned int column_idx;
1340 struct ovsdb_datum *old;
1342 column = shash_find_data(&table->columns, column_name);
1344 VLOG_WARN_RL(&syntax_rl, "unknown column %s updating row "UUID_FMT,
1345 column_name, UUID_ARGS(&row->uuid));
1349 column_idx = column - table->class->columns;
1350 old = &row->old[column_idx];
1354 struct ovsdb_datum diff;
1356 ovs_assert(!row_json);
1357 error = ovsdb_transient_datum_from_json(&diff, &column->type,
1360 error = ovsdb_datum_apply_diff(&datum, old, &diff,
1362 ovsdb_datum_destroy(&diff, &column->type);
1365 ovs_assert(!diff_json);
1366 error = ovsdb_datum_from_json(&datum, &column->type, node->data,
1371 if (!ovsdb_datum_equals(old, &datum, &column->type)) {
1372 ovsdb_datum_swap(old, &datum);
1373 if (table->modes[column_idx] & OVSDB_IDL_ALERT) {
1375 row->change_seqno[change]
1376 = row->table->change_seqno[change]
1377 = row->table->idl->change_seqno + 1;
1378 if (table->modes[column_idx] & OVSDB_IDL_TRACK) {
1379 if (!ovs_list_is_empty(&row->track_node)) {
1380 ovs_list_remove(&row->track_node);
1382 ovs_list_push_back(&row->table->track_list,
1384 if (!row->updated) {
1385 row->updated = bitmap_allocate(class->n_columns);
1387 bitmap_set1(row->updated, column_idx);
1391 /* Didn't really change but the OVSDB monitor protocol always
1392 * includes every value in a row. */
1395 ovsdb_datum_destroy(&datum, &column->type);
1397 char *s = ovsdb_error_to_string(error);
1398 VLOG_WARN_RL(&syntax_rl, "error parsing column %s in row "UUID_FMT
1399 " in table %s: %s", column_name,
1400 UUID_ARGS(&row->uuid), table->class->name, s);
1402 ovsdb_error_destroy(error);
1409 ovsdb_idl_row_update(struct ovsdb_idl_row *row, const struct json *row_json,
1410 enum ovsdb_idl_change change)
1412 return ovsdb_idl_row_change__(row, row_json, NULL, change);
1416 ovsdb_idl_row_apply_diff(struct ovsdb_idl_row *row,
1417 const struct json *diff_json,
1418 enum ovsdb_idl_change change)
1420 return ovsdb_idl_row_change__(row, NULL, diff_json, change);
1423 /* When a row A refers to row B through a column with a "refTable" constraint,
1424 * but row B does not exist, row B is called an "orphan row". Orphan rows
1425 * should not persist, because the database enforces referential integrity, but
1426 * they can appear transiently as changes from the database are received (the
1427 * database doesn't try to topologically sort them and circular references mean
1428 * it isn't always possible anyhow).
1430 * This function returns true if 'row' is an orphan row, otherwise false.
1433 ovsdb_idl_row_is_orphan(const struct ovsdb_idl_row *row)
1435 return !row->old && !row->new;
1438 /* Returns true if 'row' is conceptually part of the database as modified by
1439 * the current transaction (if any), false otherwise.
1441 * This function will return true if 'row' is not an orphan (see the comment on
1442 * ovsdb_idl_row_is_orphan()) and:
1444 * - 'row' exists in the database and has not been deleted within the
1445 * current transaction (if any).
1447 * - 'row' was inserted within the current transaction and has not been
1448 * deleted. (In the latter case you should not have passed 'row' in at
1449 * all, because ovsdb_idl_txn_delete() freed it.)
1451 * This function will return false if 'row' is an orphan or if 'row' was
1452 * deleted within the current transaction.
1455 ovsdb_idl_row_exists(const struct ovsdb_idl_row *row)
1457 return row->new != NULL;
1461 ovsdb_idl_row_parse(struct ovsdb_idl_row *row)
1463 const struct ovsdb_idl_table_class *class = row->table->class;
1466 for (i = 0; i < class->n_columns; i++) {
1467 const struct ovsdb_idl_column *c = &class->columns[i];
1468 (c->parse)(row, &row->old[i]);
1473 ovsdb_idl_row_unparse(struct ovsdb_idl_row *row)
1475 const struct ovsdb_idl_table_class *class = row->table->class;
1478 for (i = 0; i < class->n_columns; i++) {
1479 const struct ovsdb_idl_column *c = &class->columns[i];
1485 ovsdb_idl_row_clear_old(struct ovsdb_idl_row *row)
1487 ovs_assert(row->old == row->new);
1488 if (!ovsdb_idl_row_is_orphan(row)) {
1489 const struct ovsdb_idl_table_class *class = row->table->class;
1492 for (i = 0; i < class->n_columns; i++) {
1493 ovsdb_datum_destroy(&row->old[i], &class->columns[i].type);
1496 row->old = row->new = NULL;
1501 ovsdb_idl_row_clear_new(struct ovsdb_idl_row *row)
1503 if (row->old != row->new) {
1505 const struct ovsdb_idl_table_class *class = row->table->class;
1509 BITMAP_FOR_EACH_1 (i, class->n_columns, row->written) {
1510 ovsdb_datum_destroy(&row->new[i], &class->columns[i].type);
1515 row->written = NULL;
1517 row->new = row->old;
1522 ovsdb_idl_row_clear_arcs(struct ovsdb_idl_row *row, bool destroy_dsts)
1524 struct ovsdb_idl_arc *arc, *next;
1526 /* Delete all forward arcs. If 'destroy_dsts', destroy any orphaned rows
1527 * that this causes to be unreferenced, if tracking is not enabled.
1528 * If tracking is enabled, orphaned nodes are removed from hmap but not
1531 LIST_FOR_EACH_SAFE (arc, next, src_node, &row->src_arcs) {
1532 ovs_list_remove(&arc->dst_node);
1534 && ovsdb_idl_row_is_orphan(arc->dst)
1535 && ovs_list_is_empty(&arc->dst->dst_arcs)) {
1536 ovsdb_idl_row_destroy(arc->dst);
1540 ovs_list_init(&row->src_arcs);
1543 /* Force nodes that reference 'row' to reparse. */
1545 ovsdb_idl_row_reparse_backrefs(struct ovsdb_idl_row *row)
1547 struct ovsdb_idl_arc *arc, *next;
1549 /* This is trickier than it looks. ovsdb_idl_row_clear_arcs() will destroy
1550 * 'arc', so we need to use the "safe" variant of list traversal. However,
1551 * calling an ovsdb_idl_column's 'parse' function will add an arc
1552 * equivalent to 'arc' to row->arcs. That could be a problem for
1553 * traversal, but it adds it at the beginning of the list to prevent us
1554 * from stumbling upon it again.
1556 * (If duplicate arcs were possible then we would need to make sure that
1557 * 'next' didn't also point into 'arc''s destination, but we forbid
1558 * duplicate arcs.) */
1559 LIST_FOR_EACH_SAFE (arc, next, dst_node, &row->dst_arcs) {
1560 struct ovsdb_idl_row *ref = arc->src;
1562 ovsdb_idl_row_unparse(ref);
1563 ovsdb_idl_row_clear_arcs(ref, false);
1564 ovsdb_idl_row_parse(ref);
1568 static struct ovsdb_idl_row *
1569 ovsdb_idl_row_create__(const struct ovsdb_idl_table_class *class)
1571 struct ovsdb_idl_row *row = xzalloc(class->allocation_size);
1572 class->row_init(row);
1573 ovs_list_init(&row->src_arcs);
1574 ovs_list_init(&row->dst_arcs);
1575 hmap_node_nullify(&row->txn_node);
1576 ovs_list_init(&row->track_node);
1580 static struct ovsdb_idl_row *
1581 ovsdb_idl_row_create(struct ovsdb_idl_table *table, const struct uuid *uuid)
1583 struct ovsdb_idl_row *row = ovsdb_idl_row_create__(table->class);
1584 hmap_insert(&table->rows, &row->hmap_node, uuid_hash(uuid));
1591 ovsdb_idl_row_destroy(struct ovsdb_idl_row *row)
1594 ovsdb_idl_row_clear_old(row);
1595 hmap_remove(&row->table->rows, &row->hmap_node);
1596 if (ovsdb_idl_track_is_set(row->table)) {
1597 row->change_seqno[OVSDB_IDL_CHANGE_DELETE]
1598 = row->table->change_seqno[OVSDB_IDL_CHANGE_DELETE]
1599 = row->table->idl->change_seqno + 1;
1601 if (!ovs_list_is_empty(&row->track_node)) {
1602 ovs_list_remove(&row->track_node);
1604 ovs_list_push_back(&row->table->track_list, &row->track_node);
1609 ovsdb_idl_row_destroy_postprocess(struct ovsdb_idl *idl)
1613 for (i = 0; i < idl->class->n_tables; i++) {
1614 struct ovsdb_idl_table *table = &idl->tables[i];
1616 if (!ovs_list_is_empty(&table->track_list)) {
1617 struct ovsdb_idl_row *row, *next;
1619 LIST_FOR_EACH_SAFE(row, next, track_node, &table->track_list) {
1620 if (!ovsdb_idl_track_is_set(row->table)) {
1621 ovs_list_remove(&row->track_node);
1630 ovsdb_idl_insert_row(struct ovsdb_idl_row *row, const struct json *row_json)
1632 const struct ovsdb_idl_table_class *class = row->table->class;
1635 ovs_assert(!row->old && !row->new);
1636 row->old = row->new = xmalloc(class->n_columns * sizeof *row->old);
1637 for (i = 0; i < class->n_columns; i++) {
1638 ovsdb_datum_init_default(&row->old[i], &class->columns[i].type);
1640 ovsdb_idl_row_update(row, row_json, OVSDB_IDL_CHANGE_INSERT);
1641 ovsdb_idl_row_parse(row);
1643 ovsdb_idl_row_reparse_backrefs(row);
1647 ovsdb_idl_delete_row(struct ovsdb_idl_row *row)
1649 ovsdb_idl_row_unparse(row);
1650 ovsdb_idl_row_clear_arcs(row, true);
1651 ovsdb_idl_row_clear_old(row);
1652 if (ovs_list_is_empty(&row->dst_arcs)) {
1653 ovsdb_idl_row_destroy(row);
1655 ovsdb_idl_row_reparse_backrefs(row);
1659 /* Returns true if a column with mode OVSDB_IDL_MODE_RW changed, false
1662 ovsdb_idl_modify_row(struct ovsdb_idl_row *row, const struct json *row_json)
1666 ovsdb_idl_row_unparse(row);
1667 ovsdb_idl_row_clear_arcs(row, true);
1668 changed = ovsdb_idl_row_update(row, row_json, OVSDB_IDL_CHANGE_MODIFY);
1669 ovsdb_idl_row_parse(row);
1675 ovsdb_idl_modify_row_by_diff(struct ovsdb_idl_row *row,
1676 const struct json *diff_json)
1680 ovsdb_idl_row_unparse(row);
1681 ovsdb_idl_row_clear_arcs(row, true);
1682 changed = ovsdb_idl_row_apply_diff(row, diff_json,
1683 OVSDB_IDL_CHANGE_MODIFY);
1684 ovsdb_idl_row_parse(row);
1690 may_add_arc(const struct ovsdb_idl_row *src, const struct ovsdb_idl_row *dst)
1692 const struct ovsdb_idl_arc *arc;
1699 /* No duplicate arcs.
1701 * We only need to test whether the first arc in dst->dst_arcs originates
1702 * at 'src', since we add all of the arcs from a given source in a clump
1703 * (in a single call to ovsdb_idl_row_parse()) and new arcs are always
1704 * added at the front of the dst_arcs list. */
1705 if (ovs_list_is_empty(&dst->dst_arcs)) {
1708 arc = CONTAINER_OF(dst->dst_arcs.next, struct ovsdb_idl_arc, dst_node);
1709 return arc->src != src;
1712 static struct ovsdb_idl_table *
1713 ovsdb_idl_table_from_class(const struct ovsdb_idl *idl,
1714 const struct ovsdb_idl_table_class *table_class)
1716 return &idl->tables[table_class - idl->class->tables];
1719 /* Called by ovsdb-idlc generated code. */
1720 struct ovsdb_idl_row *
1721 ovsdb_idl_get_row_arc(struct ovsdb_idl_row *src,
1722 struct ovsdb_idl_table_class *dst_table_class,
1723 const struct uuid *dst_uuid)
1725 struct ovsdb_idl *idl = src->table->idl;
1726 struct ovsdb_idl_table *dst_table;
1727 struct ovsdb_idl_arc *arc;
1728 struct ovsdb_idl_row *dst;
1730 dst_table = ovsdb_idl_table_from_class(idl, dst_table_class);
1731 dst = ovsdb_idl_get_row(dst_table, dst_uuid);
1733 /* We're being called from ovsdb_idl_txn_write(). We must not update
1734 * any arcs, because the transaction will be backed out at commit or
1735 * abort time and we don't want our graph screwed up.
1737 * Just return the destination row, if there is one and it has not been
1739 if (dst && (hmap_node_is_null(&dst->txn_node) || dst->new)) {
1744 /* We're being called from some other context. Update the graph. */
1746 dst = ovsdb_idl_row_create(dst_table, dst_uuid);
1749 /* Add a new arc, if it wouldn't be a self-arc or a duplicate arc. */
1750 if (may_add_arc(src, dst)) {
1751 /* The arc *must* be added at the front of the dst_arcs list. See
1752 * ovsdb_idl_row_reparse_backrefs() for details. */
1753 arc = xmalloc(sizeof *arc);
1754 ovs_list_push_front(&src->src_arcs, &arc->src_node);
1755 ovs_list_push_front(&dst->dst_arcs, &arc->dst_node);
1760 return !ovsdb_idl_row_is_orphan(dst) ? dst : NULL;
1764 /* Searches 'tc''s table in 'idl' for a row with UUID 'uuid'. Returns a
1765 * pointer to the row if there is one, otherwise a null pointer. */
1766 const struct ovsdb_idl_row *
1767 ovsdb_idl_get_row_for_uuid(const struct ovsdb_idl *idl,
1768 const struct ovsdb_idl_table_class *tc,
1769 const struct uuid *uuid)
1771 return ovsdb_idl_get_row(ovsdb_idl_table_from_class(idl, tc), uuid);
1774 static struct ovsdb_idl_row *
1775 next_real_row(struct ovsdb_idl_table *table, struct hmap_node *node)
1777 for (; node; node = hmap_next(&table->rows, node)) {
1778 struct ovsdb_idl_row *row;
1780 row = CONTAINER_OF(node, struct ovsdb_idl_row, hmap_node);
1781 if (ovsdb_idl_row_exists(row)) {
1788 /* Returns a row in 'table_class''s table in 'idl', or a null pointer if that
1791 * Database tables are internally maintained as hash tables, so adding or
1792 * removing rows while traversing the same table can cause some rows to be
1793 * visited twice or not at apply. */
1794 const struct ovsdb_idl_row *
1795 ovsdb_idl_first_row(const struct ovsdb_idl *idl,
1796 const struct ovsdb_idl_table_class *table_class)
1798 struct ovsdb_idl_table *table
1799 = ovsdb_idl_table_from_class(idl, table_class);
1800 return next_real_row(table, hmap_first(&table->rows));
1803 /* Returns a row following 'row' within its table, or a null pointer if 'row'
1804 * is the last row in its table. */
1805 const struct ovsdb_idl_row *
1806 ovsdb_idl_next_row(const struct ovsdb_idl_row *row)
1808 struct ovsdb_idl_table *table = row->table;
1810 return next_real_row(table, hmap_next(&table->rows, &row->hmap_node));
1813 /* Reads and returns the value of 'column' within 'row'. If an ongoing
1814 * transaction has changed 'column''s value, the modified value is returned.
1816 * The caller must not modify or free the returned value.
1818 * Various kinds of changes can invalidate the returned value: writing to the
1819 * same 'column' in 'row' (e.g. with ovsdb_idl_txn_write()), deleting 'row'
1820 * (e.g. with ovsdb_idl_txn_delete()), or completing an ongoing transaction
1821 * (e.g. with ovsdb_idl_txn_commit() or ovsdb_idl_txn_abort()). If the
1822 * returned value is needed for a long time, it is best to make a copy of it
1823 * with ovsdb_datum_clone(). */
1824 const struct ovsdb_datum *
1825 ovsdb_idl_read(const struct ovsdb_idl_row *row,
1826 const struct ovsdb_idl_column *column)
1828 const struct ovsdb_idl_table_class *class;
1831 ovs_assert(!ovsdb_idl_row_is_synthetic(row));
1833 class = row->table->class;
1834 column_idx = column - class->columns;
1836 ovs_assert(row->new != NULL);
1837 ovs_assert(column_idx < class->n_columns);
1839 if (row->written && bitmap_is_set(row->written, column_idx)) {
1840 return &row->new[column_idx];
1841 } else if (row->old) {
1842 return &row->old[column_idx];
1844 return ovsdb_datum_default(&column->type);
1848 /* Same as ovsdb_idl_read(), except that it also asserts that 'column' has key
1849 * type 'key_type' and value type 'value_type'. (Scalar and set types will
1850 * have a value type of OVSDB_TYPE_VOID.)
1852 * This is useful in code that "knows" that a particular column has a given
1853 * type, so that it will abort if someone changes the column's type without
1854 * updating the code that uses it. */
1855 const struct ovsdb_datum *
1856 ovsdb_idl_get(const struct ovsdb_idl_row *row,
1857 const struct ovsdb_idl_column *column,
1858 enum ovsdb_atomic_type key_type OVS_UNUSED,
1859 enum ovsdb_atomic_type value_type OVS_UNUSED)
1861 ovs_assert(column->type.key.type == key_type);
1862 ovs_assert(column->type.value.type == value_type);
1864 return ovsdb_idl_read(row, column);
1867 /* Returns true if the field represented by 'column' in 'row' may be modified,
1868 * false if it is immutable.
1870 * Normally, whether a field is mutable is controlled by its column's schema.
1871 * However, an immutable column can be set to any initial value at the time of
1872 * insertion, so if 'row' is a new row (one that is being added as part of the
1873 * current transaction, supposing that a transaction is in progress) then even
1874 * its "immutable" fields are actually mutable. */
1876 ovsdb_idl_is_mutable(const struct ovsdb_idl_row *row,
1877 const struct ovsdb_idl_column *column)
1879 return column->mutable || (row->new && !row->old);
1882 /* Returns false if 'row' was obtained from the IDL, true if it was initialized
1883 * to all-zero-bits by some other entity. If 'row' was set up some other way
1884 * then the return value is indeterminate. */
1886 ovsdb_idl_row_is_synthetic(const struct ovsdb_idl_row *row)
1888 return row->table == NULL;
1893 static void ovsdb_idl_txn_complete(struct ovsdb_idl_txn *txn,
1894 enum ovsdb_idl_txn_status);
1896 /* Returns a string representation of 'status'. The caller must not modify or
1897 * free the returned string.
1899 * The return value is probably useful only for debug log messages and unit
1902 ovsdb_idl_txn_status_to_string(enum ovsdb_idl_txn_status status)
1905 case TXN_UNCOMMITTED:
1906 return "uncommitted";
1909 case TXN_INCOMPLETE:
1910 return "incomplete";
1917 case TXN_NOT_LOCKED:
1918 return "not locked";
1925 /* Starts a new transaction on 'idl'. A given ovsdb_idl may only have a single
1926 * active transaction at a time. See the large comment in ovsdb-idl.h for
1927 * general information on transactions. */
1928 struct ovsdb_idl_txn *
1929 ovsdb_idl_txn_create(struct ovsdb_idl *idl)
1931 struct ovsdb_idl_txn *txn;
1933 ovs_assert(!idl->txn);
1934 idl->txn = txn = xmalloc(sizeof *txn);
1935 txn->request_id = NULL;
1937 hmap_init(&txn->txn_rows);
1938 txn->status = TXN_UNCOMMITTED;
1940 txn->dry_run = false;
1941 ds_init(&txn->comment);
1943 txn->inc_table = NULL;
1944 txn->inc_column = NULL;
1946 hmap_init(&txn->inserted_rows);
1951 /* Appends 's', which is treated as a printf()-type format string, to the
1952 * comments that will be passed to the OVSDB server when 'txn' is committed.
1953 * (The comment will be committed to the OVSDB log, which "ovsdb-tool
1954 * show-log" can print in a relatively human-readable form.) */
1956 ovsdb_idl_txn_add_comment(struct ovsdb_idl_txn *txn, const char *s, ...)
1960 if (txn->comment.length) {
1961 ds_put_char(&txn->comment, '\n');
1965 ds_put_format_valist(&txn->comment, s, args);
1969 /* Marks 'txn' as a transaction that will not actually modify the database. In
1970 * almost every way, the transaction is treated like other transactions. It
1971 * must be committed or aborted like other transactions, it will be sent to the
1972 * database server like other transactions, and so on. The only difference is
1973 * that the operations sent to the database server will include, as the last
1974 * step, an "abort" operation, so that any changes made by the transaction will
1975 * not actually take effect. */
1977 ovsdb_idl_txn_set_dry_run(struct ovsdb_idl_txn *txn)
1979 txn->dry_run = true;
1982 /* Causes 'txn', when committed, to increment the value of 'column' within
1983 * 'row' by 1. 'column' must have an integer type. After 'txn' commits
1984 * successfully, the client may retrieve the final (incremented) value of
1985 * 'column' with ovsdb_idl_txn_get_increment_new_value().
1987 * The client could accomplish something similar with ovsdb_idl_read(),
1988 * ovsdb_idl_txn_verify() and ovsdb_idl_txn_write(), or with ovsdb-idlc
1989 * generated wrappers for these functions. However, ovsdb_idl_txn_increment()
1990 * will never (by itself) fail because of a verify error.
1992 * The intended use is for incrementing the "next_cfg" column in the
1993 * Open_vSwitch table. */
1995 ovsdb_idl_txn_increment(struct ovsdb_idl_txn *txn,
1996 const struct ovsdb_idl_row *row,
1997 const struct ovsdb_idl_column *column)
1999 ovs_assert(!txn->inc_table);
2000 ovs_assert(column->type.key.type == OVSDB_TYPE_INTEGER);
2001 ovs_assert(column->type.value.type == OVSDB_TYPE_VOID);
2003 txn->inc_table = row->table->class->name;
2004 txn->inc_column = column->name;
2005 txn->inc_row = row->uuid;
2008 /* Destroys 'txn' and frees all associated memory. If ovsdb_idl_txn_commit()
2009 * has been called for 'txn' but the commit is still incomplete (that is, the
2010 * last call returned TXN_INCOMPLETE) then the transaction may or may not still
2011 * end up committing at the database server, but the client will not be able to
2012 * get any further status information back. */
2014 ovsdb_idl_txn_destroy(struct ovsdb_idl_txn *txn)
2016 struct ovsdb_idl_txn_insert *insert, *next;
2018 json_destroy(txn->request_id);
2019 if (txn->status == TXN_INCOMPLETE) {
2020 hmap_remove(&txn->idl->outstanding_txns, &txn->hmap_node);
2022 ovsdb_idl_txn_abort(txn);
2023 ds_destroy(&txn->comment);
2025 HMAP_FOR_EACH_SAFE (insert, next, hmap_node, &txn->inserted_rows) {
2028 hmap_destroy(&txn->inserted_rows);
2032 /* Causes poll_block() to wake up if 'txn' has completed committing. */
2034 ovsdb_idl_txn_wait(const struct ovsdb_idl_txn *txn)
2036 if (txn->status != TXN_UNCOMMITTED && txn->status != TXN_INCOMPLETE) {
2037 poll_immediate_wake();
2041 static struct json *
2042 where_uuid_equals(const struct uuid *uuid)
2045 json_array_create_1(
2046 json_array_create_3(
2047 json_string_create("_uuid"),
2048 json_string_create("=="),
2049 json_array_create_2(
2050 json_string_create("uuid"),
2051 json_string_create_nocopy(
2052 xasprintf(UUID_FMT, UUID_ARGS(uuid))))));
2056 uuid_name_from_uuid(const struct uuid *uuid)
2061 name = xasprintf("row"UUID_FMT, UUID_ARGS(uuid));
2062 for (p = name; *p != '\0'; p++) {
2071 static const struct ovsdb_idl_row *
2072 ovsdb_idl_txn_get_row(const struct ovsdb_idl_txn *txn, const struct uuid *uuid)
2074 const struct ovsdb_idl_row *row;
2076 HMAP_FOR_EACH_WITH_HASH (row, txn_node, uuid_hash(uuid), &txn->txn_rows) {
2077 if (uuid_equals(&row->uuid, uuid)) {
2084 /* XXX there must be a cleaner way to do this */
2085 static struct json *
2086 substitute_uuids(struct json *json, const struct ovsdb_idl_txn *txn)
2088 if (json->type == JSON_ARRAY) {
2092 if (json->u.array.n == 2
2093 && json->u.array.elems[0]->type == JSON_STRING
2094 && json->u.array.elems[1]->type == JSON_STRING
2095 && !strcmp(json->u.array.elems[0]->u.string, "uuid")
2096 && uuid_from_string(&uuid, json->u.array.elems[1]->u.string)) {
2097 const struct ovsdb_idl_row *row;
2099 row = ovsdb_idl_txn_get_row(txn, &uuid);
2100 if (row && !row->old && row->new) {
2103 return json_array_create_2(
2104 json_string_create("named-uuid"),
2105 json_string_create_nocopy(uuid_name_from_uuid(&uuid)));
2109 for (i = 0; i < json->u.array.n; i++) {
2110 json->u.array.elems[i] = substitute_uuids(json->u.array.elems[i],
2113 } else if (json->type == JSON_OBJECT) {
2114 struct shash_node *node;
2116 SHASH_FOR_EACH (node, json_object(json)) {
2117 node->data = substitute_uuids(node->data, txn);
2124 ovsdb_idl_txn_disassemble(struct ovsdb_idl_txn *txn)
2126 struct ovsdb_idl_row *row, *next;
2128 /* This must happen early. Otherwise, ovsdb_idl_row_parse() will call an
2129 * ovsdb_idl_column's 'parse' function, which will call
2130 * ovsdb_idl_get_row_arc(), which will seen that the IDL is in a
2131 * transaction and fail to update the graph. */
2132 txn->idl->txn = NULL;
2134 HMAP_FOR_EACH_SAFE (row, next, txn_node, &txn->txn_rows) {
2137 ovsdb_idl_row_unparse(row);
2138 ovsdb_idl_row_clear_arcs(row, false);
2139 ovsdb_idl_row_parse(row);
2142 ovsdb_idl_row_unparse(row);
2144 ovsdb_idl_row_clear_new(row);
2147 row->prereqs = NULL;
2150 row->written = NULL;
2152 hmap_remove(&txn->txn_rows, &row->txn_node);
2153 hmap_node_nullify(&row->txn_node);
2155 hmap_remove(&row->table->rows, &row->hmap_node);
2159 hmap_destroy(&txn->txn_rows);
2160 hmap_init(&txn->txn_rows);
2163 /* Attempts to commit 'txn'. Returns the status of the commit operation, one
2164 * of the following TXN_* constants:
2168 * The transaction is in progress, but not yet complete. The caller
2169 * should call again later, after calling ovsdb_idl_run() to let the IDL
2170 * do OVSDB protocol processing.
2174 * The transaction is complete. (It didn't actually change the database,
2175 * so the IDL didn't send any request to the database server.)
2179 * The caller previously called ovsdb_idl_txn_abort().
2183 * The transaction was successful. The update made by the transaction
2184 * (and possibly other changes made by other database clients) should
2185 * already be visible in the IDL.
2189 * The transaction failed for some transient reason, e.g. because a
2190 * "verify" operation reported an inconsistency or due to a network
2191 * problem. The caller should wait for a change to the database, then
2192 * compose a new transaction, and commit the new transaction.
2194 * Use the return value of ovsdb_idl_get_seqno() to wait for a change in
2195 * the database. It is important to use its return value *before* the
2196 * initial call to ovsdb_idl_txn_commit() as the baseline for this
2197 * purpose, because the change that one should wait for can happen after
2198 * the initial call but before the call that returns TXN_TRY_AGAIN, and
2199 * using some other baseline value in that situation could cause an
2200 * indefinite wait if the database rarely changes.
2204 * The transaction failed because the IDL has been configured to require
2205 * a database lock (with ovsdb_idl_set_lock()) but didn't get it yet or
2206 * has already lost it.
2208 * Committing a transaction rolls back all of the changes that it made to the
2209 * IDL's copy of the database. If the transaction commits successfully, then
2210 * the database server will send an update and, thus, the IDL will be updated
2211 * with the committed changes. */
2212 enum ovsdb_idl_txn_status
2213 ovsdb_idl_txn_commit(struct ovsdb_idl_txn *txn)
2215 struct ovsdb_idl_row *row;
2216 struct json *operations;
2219 if (txn != txn->idl->txn) {
2223 /* If we need a lock but don't have it, give up quickly. */
2224 if (txn->idl->lock_name && !ovsdb_idl_has_lock(txn->idl)) {
2225 txn->status = TXN_NOT_LOCKED;
2226 goto disassemble_out;
2229 operations = json_array_create_1(
2230 json_string_create(txn->idl->class->database));
2232 /* Assert that we have the required lock (avoiding a race). */
2233 if (txn->idl->lock_name) {
2234 struct json *op = json_object_create();
2235 json_array_add(operations, op);
2236 json_object_put_string(op, "op", "assert");
2237 json_object_put_string(op, "lock", txn->idl->lock_name);
2240 /* Add prerequisites and declarations of new rows. */
2241 HMAP_FOR_EACH (row, txn_node, &txn->txn_rows) {
2242 /* XXX check that deleted rows exist even if no prereqs? */
2244 const struct ovsdb_idl_table_class *class = row->table->class;
2245 size_t n_columns = class->n_columns;
2246 struct json *op, *columns, *row_json;
2249 op = json_object_create();
2250 json_array_add(operations, op);
2251 json_object_put_string(op, "op", "wait");
2252 json_object_put_string(op, "table", class->name);
2253 json_object_put(op, "timeout", json_integer_create(0));
2254 json_object_put(op, "where", where_uuid_equals(&row->uuid));
2255 json_object_put_string(op, "until", "==");
2256 columns = json_array_create_empty();
2257 json_object_put(op, "columns", columns);
2258 row_json = json_object_create();
2259 json_object_put(op, "rows", json_array_create_1(row_json));
2261 BITMAP_FOR_EACH_1 (idx, n_columns, row->prereqs) {
2262 const struct ovsdb_idl_column *column = &class->columns[idx];
2263 json_array_add(columns, json_string_create(column->name));
2264 json_object_put(row_json, column->name,
2265 ovsdb_datum_to_json(&row->old[idx],
2272 any_updates = false;
2273 HMAP_FOR_EACH (row, txn_node, &txn->txn_rows) {
2274 const struct ovsdb_idl_table_class *class = row->table->class;
2277 if (class->is_root) {
2278 struct json *op = json_object_create();
2279 json_object_put_string(op, "op", "delete");
2280 json_object_put_string(op, "table", class->name);
2281 json_object_put(op, "where", where_uuid_equals(&row->uuid));
2282 json_array_add(operations, op);
2285 /* Let ovsdb-server decide whether to really delete it. */
2287 } else if (row->old != row->new) {
2288 struct json *row_json;
2292 op = json_object_create();
2293 json_object_put_string(op, "op", row->old ? "update" : "insert");
2294 json_object_put_string(op, "table", class->name);
2296 json_object_put(op, "where", where_uuid_equals(&row->uuid));
2298 struct ovsdb_idl_txn_insert *insert;
2302 json_object_put(op, "uuid-name",
2303 json_string_create_nocopy(
2304 uuid_name_from_uuid(&row->uuid)));
2306 insert = xmalloc(sizeof *insert);
2307 insert->dummy = row->uuid;
2308 insert->op_index = operations->u.array.n - 1;
2309 uuid_zero(&insert->real);
2310 hmap_insert(&txn->inserted_rows, &insert->hmap_node,
2311 uuid_hash(&insert->dummy));
2313 row_json = json_object_create();
2314 json_object_put(op, "row", row_json);
2317 BITMAP_FOR_EACH_1 (idx, class->n_columns, row->written) {
2318 const struct ovsdb_idl_column *column =
2319 &class->columns[idx];
2322 || !ovsdb_datum_is_default(&row->new[idx],
2324 json_object_put(row_json, column->name,
2326 ovsdb_datum_to_json(&row->new[idx],
2330 /* If anything really changed, consider it an update.
2331 * We can't suppress not-really-changed values earlier
2332 * or transactions would become nonatomic (see the big
2333 * comment inside ovsdb_idl_txn_write()). */
2334 if (!any_updates && row->old &&
2335 !ovsdb_datum_equals(&row->old[idx], &row->new[idx],
2343 if (!row->old || !shash_is_empty(json_object(row_json))) {
2344 json_array_add(operations, op);
2351 /* Add increment. */
2352 if (txn->inc_table && any_updates) {
2355 txn->inc_index = operations->u.array.n - 1;
2357 op = json_object_create();
2358 json_object_put_string(op, "op", "mutate");
2359 json_object_put_string(op, "table", txn->inc_table);
2360 json_object_put(op, "where",
2361 substitute_uuids(where_uuid_equals(&txn->inc_row),
2363 json_object_put(op, "mutations",
2364 json_array_create_1(
2365 json_array_create_3(
2366 json_string_create(txn->inc_column),
2367 json_string_create("+="),
2368 json_integer_create(1))));
2369 json_array_add(operations, op);
2371 op = json_object_create();
2372 json_object_put_string(op, "op", "select");
2373 json_object_put_string(op, "table", txn->inc_table);
2374 json_object_put(op, "where",
2375 substitute_uuids(where_uuid_equals(&txn->inc_row),
2377 json_object_put(op, "columns",
2378 json_array_create_1(json_string_create(
2380 json_array_add(operations, op);
2383 if (txn->comment.length) {
2384 struct json *op = json_object_create();
2385 json_object_put_string(op, "op", "comment");
2386 json_object_put_string(op, "comment", ds_cstr(&txn->comment));
2387 json_array_add(operations, op);
2391 struct json *op = json_object_create();
2392 json_object_put_string(op, "op", "abort");
2393 json_array_add(operations, op);
2397 txn->status = TXN_UNCHANGED;
2398 json_destroy(operations);
2399 } else if (!jsonrpc_session_send(
2401 jsonrpc_create_request(
2402 "transact", operations, &txn->request_id))) {
2403 hmap_insert(&txn->idl->outstanding_txns, &txn->hmap_node,
2404 json_hash(txn->request_id, 0));
2405 txn->status = TXN_INCOMPLETE;
2407 txn->status = TXN_TRY_AGAIN;
2411 ovsdb_idl_txn_disassemble(txn);
2413 switch (txn->status) {
2414 case TXN_UNCOMMITTED: COVERAGE_INC(txn_uncommitted); break;
2415 case TXN_UNCHANGED: COVERAGE_INC(txn_unchanged); break;
2416 case TXN_INCOMPLETE: COVERAGE_INC(txn_incomplete); break;
2417 case TXN_ABORTED: COVERAGE_INC(txn_aborted); break;
2418 case TXN_SUCCESS: COVERAGE_INC(txn_success); break;
2419 case TXN_TRY_AGAIN: COVERAGE_INC(txn_try_again); break;
2420 case TXN_NOT_LOCKED: COVERAGE_INC(txn_not_locked); break;
2421 case TXN_ERROR: COVERAGE_INC(txn_error); break;
2427 /* Attempts to commit 'txn', blocking until the commit either succeeds or
2428 * fails. Returns the final commit status, which may be any TXN_* value other
2429 * than TXN_INCOMPLETE.
2431 * This function calls ovsdb_idl_run() on 'txn''s IDL, so it may cause the
2432 * return value of ovsdb_idl_get_seqno() to change. */
2433 enum ovsdb_idl_txn_status
2434 ovsdb_idl_txn_commit_block(struct ovsdb_idl_txn *txn)
2436 enum ovsdb_idl_txn_status status;
2439 while ((status = ovsdb_idl_txn_commit(txn)) == TXN_INCOMPLETE) {
2440 ovsdb_idl_run(txn->idl);
2441 ovsdb_idl_wait(txn->idl);
2442 ovsdb_idl_txn_wait(txn);
2448 /* Returns the final (incremented) value of the column in 'txn' that was set to
2449 * be incremented by ovsdb_idl_txn_increment(). 'txn' must have committed
2452 ovsdb_idl_txn_get_increment_new_value(const struct ovsdb_idl_txn *txn)
2454 ovs_assert(txn->status == TXN_SUCCESS);
2455 return txn->inc_new_value;
2458 /* Aborts 'txn' without sending it to the database server. This is effective
2459 * only if ovsdb_idl_txn_commit() has not yet been called for 'txn'.
2460 * Otherwise, it has no effect.
2462 * Aborting a transaction doesn't free its memory. Use
2463 * ovsdb_idl_txn_destroy() to do that. */
2465 ovsdb_idl_txn_abort(struct ovsdb_idl_txn *txn)
2467 ovsdb_idl_txn_disassemble(txn);
2468 if (txn->status == TXN_UNCOMMITTED || txn->status == TXN_INCOMPLETE) {
2469 txn->status = TXN_ABORTED;
2473 /* Returns a string that reports the error status for 'txn'. The caller must
2474 * not modify or free the returned string. A call to ovsdb_idl_txn_destroy()
2475 * for 'txn' may free the returned string.
2477 * The return value is ordinarily one of the strings that
2478 * ovsdb_idl_txn_status_to_string() would return, but if the transaction failed
2479 * due to an error reported by the database server, the return value is that
2482 ovsdb_idl_txn_get_error(const struct ovsdb_idl_txn *txn)
2484 if (txn->status != TXN_ERROR) {
2485 return ovsdb_idl_txn_status_to_string(txn->status);
2486 } else if (txn->error) {
2489 return "no error details available";
2494 ovsdb_idl_txn_set_error_json(struct ovsdb_idl_txn *txn,
2495 const struct json *json)
2497 if (txn->error == NULL) {
2498 txn->error = json_to_string(json, JSSF_SORT);
2502 /* For transaction 'txn' that completed successfully, finds and returns the
2503 * permanent UUID that the database assigned to a newly inserted row, given the
2504 * 'uuid' that ovsdb_idl_txn_insert() assigned locally to that row.
2506 * Returns NULL if 'uuid' is not a UUID assigned by ovsdb_idl_txn_insert() or
2507 * if it was assigned by that function and then deleted by
2508 * ovsdb_idl_txn_delete() within the same transaction. (Rows that are inserted
2509 * and then deleted within a single transaction are never sent to the database
2510 * server, so it never assigns them a permanent UUID.) */
2512 ovsdb_idl_txn_get_insert_uuid(const struct ovsdb_idl_txn *txn,
2513 const struct uuid *uuid)
2515 const struct ovsdb_idl_txn_insert *insert;
2517 ovs_assert(txn->status == TXN_SUCCESS || txn->status == TXN_UNCHANGED);
2518 HMAP_FOR_EACH_IN_BUCKET (insert, hmap_node,
2519 uuid_hash(uuid), &txn->inserted_rows) {
2520 if (uuid_equals(uuid, &insert->dummy)) {
2521 return &insert->real;
2528 ovsdb_idl_txn_complete(struct ovsdb_idl_txn *txn,
2529 enum ovsdb_idl_txn_status status)
2531 txn->status = status;
2532 hmap_remove(&txn->idl->outstanding_txns, &txn->hmap_node);
2535 /* Writes 'datum' to the specified 'column' in 'row_'. Updates both 'row_'
2536 * itself and the structs derived from it (e.g. the "struct ovsrec_*", for
2539 * 'datum' must have the correct type for its column. The IDL does not check
2540 * that it meets schema constraints, but ovsdb-server will do so at commit time
2541 * so it had better be correct.
2543 * A transaction must be in progress. Replication of 'column' must not have
2544 * been disabled (by calling ovsdb_idl_omit()).
2546 * Usually this function is used indirectly through one of the "set" functions
2547 * generated by ovsdb-idlc.
2549 * Takes ownership of what 'datum' points to (and in some cases destroys that
2550 * data before returning) but makes a copy of 'datum' itself. (Commonly
2551 * 'datum' is on the caller's stack.) */
2553 ovsdb_idl_txn_write__(const struct ovsdb_idl_row *row_,
2554 const struct ovsdb_idl_column *column,
2555 struct ovsdb_datum *datum, bool owns_datum)
2557 struct ovsdb_idl_row *row = CONST_CAST(struct ovsdb_idl_row *, row_);
2558 const struct ovsdb_idl_table_class *class;
2562 if (ovsdb_idl_row_is_synthetic(row)) {
2566 class = row->table->class;
2567 column_idx = column - class->columns;
2568 write_only = row->table->modes[column_idx] == OVSDB_IDL_MONITOR;
2570 ovs_assert(row->new != NULL);
2571 ovs_assert(column_idx < class->n_columns);
2572 ovs_assert(row->old == NULL ||
2573 row->table->modes[column_idx] & OVSDB_IDL_MONITOR);
2575 if (row->table->idl->verify_write_only && !write_only) {
2576 VLOG_ERR("Bug: Attempt to write to a read/write column (%s:%s) when"
2577 " explicitly configured not to.", class->name, column->name);
2581 /* If this is a write-only column and the datum being written is the same
2582 * as the one already there, just skip the update entirely. This is worth
2583 * optimizing because we have a lot of columns that get periodically
2584 * refreshed into the database but don't actually change that often.
2586 * We don't do this for read/write columns because that would break
2587 * atomicity of transactions--some other client might have written a
2588 * different value in that column since we read it. (But if a whole
2589 * transaction only does writes of existing values, without making any real
2590 * changes, we will drop the whole transaction later in
2591 * ovsdb_idl_txn_commit().) */
2592 if (write_only && ovsdb_datum_equals(ovsdb_idl_read(row, column),
2593 datum, &column->type)) {
2597 if (hmap_node_is_null(&row->txn_node)) {
2598 hmap_insert(&row->table->idl->txn->txn_rows, &row->txn_node,
2599 uuid_hash(&row->uuid));
2601 if (row->old == row->new) {
2602 row->new = xmalloc(class->n_columns * sizeof *row->new);
2604 if (!row->written) {
2605 row->written = bitmap_allocate(class->n_columns);
2607 if (bitmap_is_set(row->written, column_idx)) {
2608 ovsdb_datum_destroy(&row->new[column_idx], &column->type);
2610 bitmap_set1(row->written, column_idx);
2613 row->new[column_idx] = *datum;
2615 ovsdb_datum_clone(&row->new[column_idx], datum, &column->type);
2617 (column->unparse)(row);
2618 (column->parse)(row, &row->new[column_idx]);
2623 ovsdb_datum_destroy(datum, &column->type);
2628 ovsdb_idl_txn_write(const struct ovsdb_idl_row *row,
2629 const struct ovsdb_idl_column *column,
2630 struct ovsdb_datum *datum)
2632 ovsdb_idl_txn_write__(row, column, datum, true);
2636 ovsdb_idl_txn_write_clone(const struct ovsdb_idl_row *row,
2637 const struct ovsdb_idl_column *column,
2638 const struct ovsdb_datum *datum)
2640 ovsdb_idl_txn_write__(row, column,
2641 CONST_CAST(struct ovsdb_datum *, datum), false);
2644 /* Causes the original contents of 'column' in 'row_' to be verified as a
2645 * prerequisite to completing the transaction. That is, if 'column' in 'row_'
2646 * changed (or if 'row_' was deleted) between the time that the IDL originally
2647 * read its contents and the time that the transaction commits, then the
2648 * transaction aborts and ovsdb_idl_txn_commit() returns TXN_AGAIN_WAIT or
2649 * TXN_AGAIN_NOW (depending on whether the database change has already been
2652 * The intention is that, to ensure that no transaction commits based on dirty
2653 * reads, an application should call ovsdb_idl_txn_verify() on each data item
2654 * read as part of a read-modify-write operation.
2656 * In some cases ovsdb_idl_txn_verify() reduces to a no-op, because the current
2657 * value of 'column' is already known:
2659 * - If 'row_' is a row created by the current transaction (returned by
2660 * ovsdb_idl_txn_insert()).
2662 * - If 'column' has already been modified (with ovsdb_idl_txn_write())
2663 * within the current transaction.
2665 * Because of the latter property, always call ovsdb_idl_txn_verify() *before*
2666 * ovsdb_idl_txn_write() for a given read-modify-write.
2668 * A transaction must be in progress.
2670 * Usually this function is used indirectly through one of the "verify"
2671 * functions generated by ovsdb-idlc. */
2673 ovsdb_idl_txn_verify(const struct ovsdb_idl_row *row_,
2674 const struct ovsdb_idl_column *column)
2676 struct ovsdb_idl_row *row = CONST_CAST(struct ovsdb_idl_row *, row_);
2677 const struct ovsdb_idl_table_class *class;
2680 if (ovsdb_idl_row_is_synthetic(row)) {
2684 class = row->table->class;
2685 column_idx = column - class->columns;
2687 ovs_assert(row->new != NULL);
2688 ovs_assert(row->old == NULL ||
2689 row->table->modes[column_idx] & OVSDB_IDL_MONITOR);
2691 || (row->written && bitmap_is_set(row->written, column_idx))) {
2695 if (hmap_node_is_null(&row->txn_node)) {
2696 hmap_insert(&row->table->idl->txn->txn_rows, &row->txn_node,
2697 uuid_hash(&row->uuid));
2699 if (!row->prereqs) {
2700 row->prereqs = bitmap_allocate(class->n_columns);
2702 bitmap_set1(row->prereqs, column_idx);
2705 /* Deletes 'row_' from its table. May free 'row_', so it must not be
2706 * accessed afterward.
2708 * A transaction must be in progress.
2710 * Usually this function is used indirectly through one of the "delete"
2711 * functions generated by ovsdb-idlc. */
2713 ovsdb_idl_txn_delete(const struct ovsdb_idl_row *row_)
2715 struct ovsdb_idl_row *row = CONST_CAST(struct ovsdb_idl_row *, row_);
2717 if (ovsdb_idl_row_is_synthetic(row)) {
2721 ovs_assert(row->new != NULL);
2723 ovsdb_idl_row_unparse(row);
2724 ovsdb_idl_row_clear_new(row);
2725 ovs_assert(!row->prereqs);
2726 hmap_remove(&row->table->rows, &row->hmap_node);
2727 hmap_remove(&row->table->idl->txn->txn_rows, &row->txn_node);
2731 if (hmap_node_is_null(&row->txn_node)) {
2732 hmap_insert(&row->table->idl->txn->txn_rows, &row->txn_node,
2733 uuid_hash(&row->uuid));
2735 ovsdb_idl_row_clear_new(row);
2739 /* Inserts and returns a new row in the table with the specified 'class' in the
2740 * database with open transaction 'txn'.
2742 * The new row is assigned a provisional UUID. If 'uuid' is null then one is
2743 * randomly generated; otherwise 'uuid' should specify a randomly generated
2744 * UUID not otherwise in use. ovsdb-server will assign a different UUID when
2745 * 'txn' is committed, but the IDL will replace any uses of the provisional
2746 * UUID in the data to be to be committed by the UUID assigned by
2749 * Usually this function is used indirectly through one of the "insert"
2750 * functions generated by ovsdb-idlc. */
2751 const struct ovsdb_idl_row *
2752 ovsdb_idl_txn_insert(struct ovsdb_idl_txn *txn,
2753 const struct ovsdb_idl_table_class *class,
2754 const struct uuid *uuid)
2756 struct ovsdb_idl_row *row = ovsdb_idl_row_create__(class);
2759 ovs_assert(!ovsdb_idl_txn_get_row(txn, uuid));
2762 uuid_generate(&row->uuid);
2765 row->table = ovsdb_idl_table_from_class(txn->idl, class);
2766 row->new = xmalloc(class->n_columns * sizeof *row->new);
2767 hmap_insert(&row->table->rows, &row->hmap_node, uuid_hash(&row->uuid));
2768 hmap_insert(&txn->txn_rows, &row->txn_node, uuid_hash(&row->uuid));
2773 ovsdb_idl_txn_abort_all(struct ovsdb_idl *idl)
2775 struct ovsdb_idl_txn *txn;
2777 HMAP_FOR_EACH (txn, hmap_node, &idl->outstanding_txns) {
2778 ovsdb_idl_txn_complete(txn, TXN_TRY_AGAIN);
2782 static struct ovsdb_idl_txn *
2783 ovsdb_idl_txn_find(struct ovsdb_idl *idl, const struct json *id)
2785 struct ovsdb_idl_txn *txn;
2787 HMAP_FOR_EACH_WITH_HASH (txn, hmap_node,
2788 json_hash(id, 0), &idl->outstanding_txns) {
2789 if (json_equal(id, txn->request_id)) {
2797 check_json_type(const struct json *json, enum json_type type, const char *name)
2800 VLOG_WARN_RL(&syntax_rl, "%s is missing", name);
2802 } else if (json->type != type) {
2803 VLOG_WARN_RL(&syntax_rl, "%s is %s instead of %s",
2804 name, json_type_to_string(json->type),
2805 json_type_to_string(type));
2813 ovsdb_idl_txn_process_inc_reply(struct ovsdb_idl_txn *txn,
2814 const struct json_array *results)
2816 struct json *count, *rows, *row, *column;
2817 struct shash *mutate, *select;
2819 if (txn->inc_index + 2 > results->n) {
2820 VLOG_WARN_RL(&syntax_rl, "reply does not contain enough operations "
2821 "for increment (has %"PRIuSIZE", needs %u)",
2822 results->n, txn->inc_index + 2);
2826 /* We know that this is a JSON object because the loop in
2827 * ovsdb_idl_txn_process_reply() checked. */
2828 mutate = json_object(results->elems[txn->inc_index]);
2829 count = shash_find_data(mutate, "count");
2830 if (!check_json_type(count, JSON_INTEGER, "\"mutate\" reply \"count\"")) {
2833 if (count->u.integer != 1) {
2834 VLOG_WARN_RL(&syntax_rl,
2835 "\"mutate\" reply \"count\" is %lld instead of 1",
2840 select = json_object(results->elems[txn->inc_index + 1]);
2841 rows = shash_find_data(select, "rows");
2842 if (!check_json_type(rows, JSON_ARRAY, "\"select\" reply \"rows\"")) {
2845 if (rows->u.array.n != 1) {
2846 VLOG_WARN_RL(&syntax_rl, "\"select\" reply \"rows\" has %"PRIuSIZE" elements "
2851 row = rows->u.array.elems[0];
2852 if (!check_json_type(row, JSON_OBJECT, "\"select\" reply row")) {
2855 column = shash_find_data(json_object(row), txn->inc_column);
2856 if (!check_json_type(column, JSON_INTEGER,
2857 "\"select\" reply inc column")) {
2860 txn->inc_new_value = column->u.integer;
2865 ovsdb_idl_txn_process_insert_reply(struct ovsdb_idl_txn_insert *insert,
2866 const struct json_array *results)
2868 static const struct ovsdb_base_type uuid_type = OVSDB_BASE_UUID_INIT;
2869 struct ovsdb_error *error;
2870 struct json *json_uuid;
2871 union ovsdb_atom uuid;
2872 struct shash *reply;
2874 if (insert->op_index >= results->n) {
2875 VLOG_WARN_RL(&syntax_rl, "reply does not contain enough operations "
2876 "for insert (has %"PRIuSIZE", needs %u)",
2877 results->n, insert->op_index);
2881 /* We know that this is a JSON object because the loop in
2882 * ovsdb_idl_txn_process_reply() checked. */
2883 reply = json_object(results->elems[insert->op_index]);
2884 json_uuid = shash_find_data(reply, "uuid");
2885 if (!check_json_type(json_uuid, JSON_ARRAY, "\"insert\" reply \"uuid\"")) {
2889 error = ovsdb_atom_from_json(&uuid, &uuid_type, json_uuid, NULL);
2891 char *s = ovsdb_error_to_string(error);
2892 VLOG_WARN_RL(&syntax_rl, "\"insert\" reply \"uuid\" is not a JSON "
2895 ovsdb_error_destroy(error);
2899 insert->real = uuid.uuid;
2905 ovsdb_idl_txn_process_reply(struct ovsdb_idl *idl,
2906 const struct jsonrpc_msg *msg)
2908 struct ovsdb_idl_txn *txn;
2909 enum ovsdb_idl_txn_status status;
2911 txn = ovsdb_idl_txn_find(idl, msg->id);
2916 if (msg->type == JSONRPC_ERROR) {
2918 } else if (msg->result->type != JSON_ARRAY) {
2919 VLOG_WARN_RL(&syntax_rl, "reply to \"transact\" is not JSON array");
2922 struct json_array *ops = &msg->result->u.array;
2923 int hard_errors = 0;
2924 int soft_errors = 0;
2925 int lock_errors = 0;
2928 for (i = 0; i < ops->n; i++) {
2929 struct json *op = ops->elems[i];
2931 if (op->type == JSON_NULL) {
2932 /* This isn't an error in itself but indicates that some prior
2933 * operation failed, so make sure that we know about it. */
2935 } else if (op->type == JSON_OBJECT) {
2938 error = shash_find_data(json_object(op), "error");
2940 if (error->type == JSON_STRING) {
2941 if (!strcmp(error->u.string, "timed out")) {
2943 } else if (!strcmp(error->u.string, "not owner")) {
2945 } else if (strcmp(error->u.string, "aborted")) {
2947 ovsdb_idl_txn_set_error_json(txn, op);
2951 ovsdb_idl_txn_set_error_json(txn, op);
2952 VLOG_WARN_RL(&syntax_rl,
2953 "\"error\" in reply is not JSON string");
2958 ovsdb_idl_txn_set_error_json(txn, op);
2959 VLOG_WARN_RL(&syntax_rl,
2960 "operation reply is not JSON null or object");
2964 if (!soft_errors && !hard_errors && !lock_errors) {
2965 struct ovsdb_idl_txn_insert *insert;
2967 if (txn->inc_table && !ovsdb_idl_txn_process_inc_reply(txn, ops)) {
2971 HMAP_FOR_EACH (insert, hmap_node, &txn->inserted_rows) {
2972 if (!ovsdb_idl_txn_process_insert_reply(insert, ops)) {
2978 status = (hard_errors ? TXN_ERROR
2979 : lock_errors ? TXN_NOT_LOCKED
2980 : soft_errors ? TXN_TRY_AGAIN
2984 ovsdb_idl_txn_complete(txn, status);
2988 /* Returns the transaction currently active for 'row''s IDL. A transaction
2989 * must currently be active. */
2990 struct ovsdb_idl_txn *
2991 ovsdb_idl_txn_get(const struct ovsdb_idl_row *row)
2993 struct ovsdb_idl_txn *txn = row->table->idl->txn;
2994 ovs_assert(txn != NULL);
2998 /* Returns the IDL on which 'txn' acts. */
3000 ovsdb_idl_txn_get_idl (struct ovsdb_idl_txn *txn)
3005 /* Blocks until 'idl' successfully connects to the remote database and
3006 * retrieves its contents. */
3008 ovsdb_idl_get_initial_snapshot(struct ovsdb_idl *idl)
3012 if (ovsdb_idl_has_ever_connected(idl)) {
3015 ovsdb_idl_wait(idl);
3020 /* If 'lock_name' is nonnull, configures 'idl' to obtain the named lock from
3021 * the database server and to avoid modifying the database when the lock cannot
3022 * be acquired (that is, when another client has the same lock).
3024 * If 'lock_name' is NULL, drops the locking requirement and releases the
3027 ovsdb_idl_set_lock(struct ovsdb_idl *idl, const char *lock_name)
3029 ovs_assert(!idl->txn);
3030 ovs_assert(hmap_is_empty(&idl->outstanding_txns));
3032 if (idl->lock_name && (!lock_name || strcmp(lock_name, idl->lock_name))) {
3033 /* Release previous lock. */
3034 ovsdb_idl_send_unlock_request(idl);
3035 free(idl->lock_name);
3036 idl->lock_name = NULL;
3037 idl->is_lock_contended = false;
3040 if (lock_name && !idl->lock_name) {
3041 /* Acquire new lock. */
3042 idl->lock_name = xstrdup(lock_name);
3043 ovsdb_idl_send_lock_request(idl);
3047 /* Returns true if 'idl' is configured to obtain a lock and owns that lock.
3049 * Locking and unlocking happens asynchronously from the database client's
3050 * point of view, so the information is only useful for optimization (e.g. if
3051 * the client doesn't have the lock then there's no point in trying to write to
3054 ovsdb_idl_has_lock(const struct ovsdb_idl *idl)
3056 return idl->has_lock;
3059 /* Returns true if 'idl' is configured to obtain a lock but the database server
3060 * has indicated that some other client already owns the requested lock. */
3062 ovsdb_idl_is_lock_contended(const struct ovsdb_idl *idl)
3064 return idl->is_lock_contended;
3068 ovsdb_idl_update_has_lock(struct ovsdb_idl *idl, bool new_has_lock)
3070 if (new_has_lock && !idl->has_lock) {
3071 if (idl->state == IDL_S_MONITORING ||
3072 idl->state == IDL_S_MONITORING2) {
3073 idl->change_seqno++;
3075 /* We're setting up a session, so don't signal that the database
3076 * changed. Finalizing the session will increment change_seqno
3079 idl->is_lock_contended = false;
3081 idl->has_lock = new_has_lock;
3085 ovsdb_idl_send_lock_request__(struct ovsdb_idl *idl, const char *method,
3088 ovsdb_idl_update_has_lock(idl, false);
3090 json_destroy(idl->lock_request_id);
3091 idl->lock_request_id = NULL;
3093 if (jsonrpc_session_is_connected(idl->session)) {
3094 struct json *params;
3096 params = json_array_create_1(json_string_create(idl->lock_name));
3097 jsonrpc_session_send(idl->session,
3098 jsonrpc_create_request(method, params, idp));
3103 ovsdb_idl_send_lock_request(struct ovsdb_idl *idl)
3105 ovsdb_idl_send_lock_request__(idl, "lock", &idl->lock_request_id);
3109 ovsdb_idl_send_unlock_request(struct ovsdb_idl *idl)
3111 ovsdb_idl_send_lock_request__(idl, "unlock", NULL);
3115 ovsdb_idl_parse_lock_reply(struct ovsdb_idl *idl, const struct json *result)
3119 json_destroy(idl->lock_request_id);
3120 idl->lock_request_id = NULL;
3122 if (result->type == JSON_OBJECT) {
3123 const struct json *locked;
3125 locked = shash_find_data(json_object(result), "locked");
3126 got_lock = locked && locked->type == JSON_TRUE;
3131 ovsdb_idl_update_has_lock(idl, got_lock);
3133 idl->is_lock_contended = true;
3138 ovsdb_idl_parse_lock_notify(struct ovsdb_idl *idl,
3139 const struct json *params,
3143 && params->type == JSON_ARRAY
3144 && json_array(params)->n > 0
3145 && json_array(params)->elems[0]->type == JSON_STRING) {
3146 const char *lock_name = json_string(json_array(params)->elems[0]);
3148 if (!strcmp(idl->lock_name, lock_name)) {
3149 ovsdb_idl_update_has_lock(idl, new_has_lock);
3150 if (!new_has_lock) {
3151 idl->is_lock_contended = true;
3158 ovsdb_idl_loop_destroy(struct ovsdb_idl_loop *loop)
3161 ovsdb_idl_destroy(loop->idl);
3165 struct ovsdb_idl_txn *
3166 ovsdb_idl_loop_run(struct ovsdb_idl_loop *loop)
3168 ovsdb_idl_run(loop->idl);
3169 loop->open_txn = (loop->committing_txn
3170 || ovsdb_idl_get_seqno(loop->idl) == loop->skip_seqno
3172 : ovsdb_idl_txn_create(loop->idl));
3173 return loop->open_txn;
3177 ovsdb_idl_loop_commit_and_wait(struct ovsdb_idl_loop *loop)
3179 if (loop->open_txn) {
3180 loop->committing_txn = loop->open_txn;
3181 loop->open_txn = NULL;
3183 loop->precommit_seqno = ovsdb_idl_get_seqno(loop->idl);
3186 struct ovsdb_idl_txn *txn = loop->committing_txn;
3188 enum ovsdb_idl_txn_status status = ovsdb_idl_txn_commit(txn);
3189 if (status != TXN_INCOMPLETE) {
3192 /* We want to re-evaluate the database when it's changed from
3193 * the contents that it had when we started the commit. (That
3194 * might have already happened.) */
3195 loop->skip_seqno = loop->precommit_seqno;
3196 if (ovsdb_idl_get_seqno(loop->idl) != loop->skip_seqno) {
3197 poll_immediate_wake();
3202 /* If the database has already changed since we started the
3203 * commit, re-evaluate it immediately to avoid missing a change
3205 if (ovsdb_idl_get_seqno(loop->idl) != loop->precommit_seqno) {
3206 poll_immediate_wake();
3212 case TXN_NOT_LOCKED:
3216 case TXN_UNCOMMITTED:
3217 case TXN_INCOMPLETE:
3221 ovsdb_idl_txn_destroy(txn);
3222 loop->committing_txn = NULL;
3226 ovsdb_idl_wait(loop->idl);