1 /* Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014, 2015 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/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,
85 const struct ovsdb_idl_class *class;
86 struct jsonrpc_session *session;
87 struct shash table_by_name;
88 struct ovsdb_idl_table *tables; /* Contains "struct ovsdb_idl_table *"s.*/
89 unsigned int change_seqno;
90 bool verify_write_only;
93 unsigned int state_seqno;
94 enum ovsdb_idl_state state;
95 struct json *request_id;
97 /* Database locking. */
98 char *lock_name; /* Name of lock we need, NULL if none. */
99 bool has_lock; /* Has db server told us we have the lock? */
100 bool is_lock_contended; /* Has db server told us we can't get lock? */
101 struct json *lock_request_id; /* JSON-RPC ID of in-flight lock request. */
103 /* Transaction support. */
104 struct ovsdb_idl_txn *txn;
105 struct hmap outstanding_txns;
108 struct ovsdb_idl_txn {
109 struct hmap_node hmap_node;
110 struct json *request_id;
111 struct ovsdb_idl *idl;
112 struct hmap txn_rows;
113 enum ovsdb_idl_txn_status status;
119 const char *inc_table;
120 const char *inc_column;
122 unsigned int inc_index;
123 int64_t inc_new_value;
126 struct hmap inserted_rows; /* Contains "struct ovsdb_idl_txn_insert"s. */
129 struct ovsdb_idl_txn_insert {
130 struct hmap_node hmap_node; /* In struct ovsdb_idl_txn's inserted_rows. */
131 struct uuid dummy; /* Dummy UUID used locally. */
132 int op_index; /* Index into transaction's operation array. */
133 struct uuid real; /* Real UUID used by database server. */
136 static struct vlog_rate_limit syntax_rl = VLOG_RATE_LIMIT_INIT(1, 5);
137 static struct vlog_rate_limit semantic_rl = VLOG_RATE_LIMIT_INIT(1, 5);
139 static void ovsdb_idl_clear(struct ovsdb_idl *);
140 static void ovsdb_idl_send_schema_request(struct ovsdb_idl *);
141 static void ovsdb_idl_send_monitor_request(struct ovsdb_idl *,
142 const struct json *schema_json);
143 static void ovsdb_idl_parse_update(struct ovsdb_idl *, const struct json *);
144 static struct ovsdb_error *ovsdb_idl_parse_update__(struct ovsdb_idl *,
145 const struct json *);
146 static bool ovsdb_idl_process_update(struct ovsdb_idl_table *,
148 const struct json *old,
149 const struct json *new);
150 static void ovsdb_idl_insert_row(struct ovsdb_idl_row *, const struct json *);
151 static void ovsdb_idl_delete_row(struct ovsdb_idl_row *);
152 static bool ovsdb_idl_modify_row(struct ovsdb_idl_row *, const struct json *);
154 static bool ovsdb_idl_row_is_orphan(const struct ovsdb_idl_row *);
155 static struct ovsdb_idl_row *ovsdb_idl_row_create__(
156 const struct ovsdb_idl_table_class *);
157 static struct ovsdb_idl_row *ovsdb_idl_row_create(struct ovsdb_idl_table *,
158 const struct uuid *);
159 static void ovsdb_idl_row_destroy(struct ovsdb_idl_row *);
160 static void ovsdb_idl_row_destroy_postprocess(struct ovsdb_idl *);
162 static void ovsdb_idl_row_parse(struct ovsdb_idl_row *);
163 static void ovsdb_idl_row_unparse(struct ovsdb_idl_row *);
164 static void ovsdb_idl_row_clear_old(struct ovsdb_idl_row *);
165 static void ovsdb_idl_row_clear_new(struct ovsdb_idl_row *);
166 static void ovsdb_idl_row_clear_arcs(struct ovsdb_idl_row *, bool destroy_dsts);
168 static void ovsdb_idl_txn_abort_all(struct ovsdb_idl *);
169 static bool ovsdb_idl_txn_process_reply(struct ovsdb_idl *,
170 const struct jsonrpc_msg *msg);
172 static void ovsdb_idl_send_lock_request(struct ovsdb_idl *);
173 static void ovsdb_idl_send_unlock_request(struct ovsdb_idl *);
174 static void ovsdb_idl_parse_lock_reply(struct ovsdb_idl *,
175 const struct json *);
176 static void ovsdb_idl_parse_lock_notify(struct ovsdb_idl *,
177 const struct json *params,
179 static struct ovsdb_idl_table *
180 ovsdb_idl_table_from_class(const struct ovsdb_idl *,
181 const struct ovsdb_idl_table_class *);
182 static bool ovsdb_idl_track_is_set(struct ovsdb_idl_table *table);
184 /* Creates and returns a connection to database 'remote', which should be in a
185 * form acceptable to jsonrpc_session_open(). The connection will maintain an
186 * in-memory replica of the remote database whose schema is described by
187 * 'class'. (Ordinarily 'class' is compiled from an OVSDB schema automatically
190 * Passes 'retry' to jsonrpc_session_open(). See that function for
193 * If 'monitor_everything_by_default' is true, then everything in the remote
194 * database will be replicated by default. ovsdb_idl_omit() and
195 * ovsdb_idl_omit_alert() may be used to selectively drop some columns from
198 * If 'monitor_everything_by_default' is false, then no columns or tables will
199 * be replicated by default. ovsdb_idl_add_column() and ovsdb_idl_add_table()
200 * must be used to choose some columns or tables to replicate.
203 ovsdb_idl_create(const char *remote, const struct ovsdb_idl_class *class,
204 bool monitor_everything_by_default, bool retry)
206 struct ovsdb_idl *idl;
207 uint8_t default_mode;
210 default_mode = (monitor_everything_by_default
211 ? OVSDB_IDL_MONITOR | OVSDB_IDL_ALERT
214 idl = xzalloc(sizeof *idl);
216 idl->session = jsonrpc_session_open(remote, retry);
217 shash_init(&idl->table_by_name);
218 idl->tables = xmalloc(class->n_tables * sizeof *idl->tables);
219 for (i = 0; i < class->n_tables; i++) {
220 const struct ovsdb_idl_table_class *tc = &class->tables[i];
221 struct ovsdb_idl_table *table = &idl->tables[i];
224 shash_add_assert(&idl->table_by_name, tc->name, table);
226 table->modes = xmalloc(tc->n_columns);
227 memset(table->modes, default_mode, tc->n_columns);
228 table->need_table = false;
229 shash_init(&table->columns);
230 for (j = 0; j < tc->n_columns; j++) {
231 const struct ovsdb_idl_column *column = &tc->columns[j];
233 shash_add_assert(&table->columns, column->name, column);
235 hmap_init(&table->rows);
236 list_init(&table->track_list);
237 table->change_seqno[OVSDB_IDL_CHANGE_INSERT]
238 = table->change_seqno[OVSDB_IDL_CHANGE_MODIFY]
239 = table->change_seqno[OVSDB_IDL_CHANGE_DELETE] = 0;
243 idl->state_seqno = UINT_MAX;
244 idl->request_id = NULL;
246 hmap_init(&idl->outstanding_txns);
251 /* Destroys 'idl' and all of the data structures that it manages. */
253 ovsdb_idl_destroy(struct ovsdb_idl *idl)
258 ovs_assert(!idl->txn);
259 ovsdb_idl_clear(idl);
260 jsonrpc_session_close(idl->session);
262 for (i = 0; i < idl->class->n_tables; i++) {
263 struct ovsdb_idl_table *table = &idl->tables[i];
264 shash_destroy(&table->columns);
265 hmap_destroy(&table->rows);
268 shash_destroy(&idl->table_by_name);
270 json_destroy(idl->request_id);
271 free(idl->lock_name);
272 json_destroy(idl->lock_request_id);
273 hmap_destroy(&idl->outstanding_txns);
279 ovsdb_idl_clear(struct ovsdb_idl *idl)
281 bool changed = false;
284 for (i = 0; i < idl->class->n_tables; i++) {
285 struct ovsdb_idl_table *table = &idl->tables[i];
286 struct ovsdb_idl_row *row, *next_row;
288 if (hmap_is_empty(&table->rows)) {
293 HMAP_FOR_EACH_SAFE (row, next_row, hmap_node, &table->rows) {
294 struct ovsdb_idl_arc *arc, *next_arc;
296 if (!ovsdb_idl_row_is_orphan(row)) {
297 ovsdb_idl_row_unparse(row);
299 LIST_FOR_EACH_SAFE (arc, next_arc, src_node, &row->src_arcs) {
302 /* No need to do anything with dst_arcs: some node has those arcs
303 * as forward arcs and will destroy them itself. */
305 if (!list_is_empty(&row->track_node)) {
306 list_remove(&row->track_node);
309 ovsdb_idl_row_destroy(row);
313 ovsdb_idl_track_clear(idl);
320 /* Processes a batch of messages from the database server on 'idl'. This may
321 * cause the IDL's contents to change. The client may check for that with
322 * ovsdb_idl_get_seqno(). */
324 ovsdb_idl_run(struct ovsdb_idl *idl)
328 ovs_assert(!idl->txn);
329 jsonrpc_session_run(idl->session);
330 for (i = 0; jsonrpc_session_is_connected(idl->session) && i < 50; i++) {
331 struct jsonrpc_msg *msg;
334 seqno = jsonrpc_session_get_seqno(idl->session);
335 if (idl->state_seqno != seqno) {
336 idl->state_seqno = seqno;
337 json_destroy(idl->request_id);
338 idl->request_id = NULL;
339 ovsdb_idl_txn_abort_all(idl);
341 ovsdb_idl_send_schema_request(idl);
342 idl->state = IDL_S_SCHEMA_REQUESTED;
343 if (idl->lock_name) {
344 ovsdb_idl_send_lock_request(idl);
348 msg = jsonrpc_session_recv(idl->session);
353 if (msg->type == JSONRPC_NOTIFY
354 && !strcmp(msg->method, "update")
355 && msg->params->type == JSON_ARRAY
356 && msg->params->u.array.n == 2
357 && msg->params->u.array.elems[0]->type == JSON_NULL) {
358 /* Database contents changed. */
359 ovsdb_idl_parse_update(idl, msg->params->u.array.elems[1]);
360 } else if (msg->type == JSONRPC_REPLY
362 && json_equal(idl->request_id, msg->id)) {
363 switch (idl->state) {
364 case IDL_S_SCHEMA_REQUESTED:
365 /* Reply to our "get_schema" request. */
366 json_destroy(idl->request_id);
367 idl->request_id = NULL;
368 ovsdb_idl_send_monitor_request(idl, msg->result);
369 idl->state = IDL_S_MONITOR_REQUESTED;
372 case IDL_S_MONITOR_REQUESTED:
373 /* Reply to our "monitor" request. */
375 json_destroy(idl->request_id);
376 idl->request_id = NULL;
377 idl->state = IDL_S_MONITORING;
378 ovsdb_idl_clear(idl);
379 ovsdb_idl_parse_update(idl, msg->result);
382 case IDL_S_MONITORING:
386 } else if (msg->type == JSONRPC_REPLY
387 && idl->lock_request_id
388 && json_equal(idl->lock_request_id, msg->id)) {
389 /* Reply to our "lock" request. */
390 ovsdb_idl_parse_lock_reply(idl, msg->result);
391 } else if (msg->type == JSONRPC_NOTIFY
392 && !strcmp(msg->method, "locked")) {
393 /* We got our lock. */
394 ovsdb_idl_parse_lock_notify(idl, msg->params, true);
395 } else if (msg->type == JSONRPC_NOTIFY
396 && !strcmp(msg->method, "stolen")) {
397 /* Someone else stole our lock. */
398 ovsdb_idl_parse_lock_notify(idl, msg->params, false);
399 } else if ((msg->type == JSONRPC_ERROR
400 || msg->type == JSONRPC_REPLY)
401 && ovsdb_idl_txn_process_reply(idl, msg)) {
402 /* ovsdb_idl_txn_process_reply() did everything needful. */
404 /* This can happen if ovsdb_idl_txn_destroy() is called to destroy
405 * a transaction before we receive the reply, so keep the log level
407 VLOG_DBG("%s: received unexpected %s message",
408 jsonrpc_session_get_name(idl->session),
409 jsonrpc_msg_type_to_string(msg->type));
411 jsonrpc_msg_destroy(msg);
413 ovsdb_idl_row_destroy_postprocess(idl);
416 /* Arranges for poll_block() to wake up when ovsdb_idl_run() has something to
417 * do or when activity occurs on a transaction on 'idl'. */
419 ovsdb_idl_wait(struct ovsdb_idl *idl)
421 jsonrpc_session_wait(idl->session);
422 jsonrpc_session_recv_wait(idl->session);
425 /* Returns a "sequence number" that represents the state of 'idl'. When
426 * ovsdb_idl_run() changes the database, the sequence number changes. The
427 * initial fetch of the entire contents of the remote database is considered to
428 * be one kind of change. Successfully acquiring a lock, if one has been
429 * configured with ovsdb_idl_set_lock(), is also considered to be a change.
431 * As long as the sequence number does not change, the client may continue to
432 * use any data structures it obtains from 'idl'. But when it changes, the
433 * client must not access any of these data structures again, because they
434 * could have freed or reused for other purposes.
436 * The sequence number can occasionally change even if the database does not.
437 * This happens if the connection to the database drops and reconnects, which
438 * causes the database contents to be reloaded even if they didn't change. (It
439 * could also happen if the database server sends out a "change" that reflects
440 * what the IDL already thought was in the database. The database server is
441 * not supposed to do that, but bugs could in theory cause it to do so.) */
443 ovsdb_idl_get_seqno(const struct ovsdb_idl *idl)
445 return idl->change_seqno;
448 /* Returns true if 'idl' successfully connected to the remote database and
449 * retrieved its contents (even if the connection subsequently dropped and is
450 * in the process of reconnecting). If so, then 'idl' contains an atomic
451 * snapshot of the database's contents (but it might be arbitrarily old if the
452 * connection dropped).
454 * Returns false if 'idl' has never connected or retrieved the database's
455 * contents. If so, 'idl' is empty. */
457 ovsdb_idl_has_ever_connected(const struct ovsdb_idl *idl)
459 return ovsdb_idl_get_seqno(idl) != 0;
462 /* Reconfigures 'idl' so that it would reconnect to the database, if
463 * connection was dropped. */
465 ovsdb_idl_enable_reconnect(struct ovsdb_idl *idl)
467 jsonrpc_session_enable_reconnect(idl->session);
470 /* Forces 'idl' to drop its connection to the database and reconnect. In the
471 * meantime, the contents of 'idl' will not change. */
473 ovsdb_idl_force_reconnect(struct ovsdb_idl *idl)
475 jsonrpc_session_force_reconnect(idl->session);
478 /* Some IDL users should only write to write-only columns. Furthermore,
479 * writing to a column which is not write-only can cause serious performance
480 * degradations for these users. This function causes 'idl' to reject writes
481 * to columns which are not marked write only using ovsdb_idl_omit_alert(). */
483 ovsdb_idl_verify_write_only(struct ovsdb_idl *idl)
485 idl->verify_write_only = true;
488 /* Returns true if 'idl' is currently connected or trying to connect. */
490 ovsdb_idl_is_alive(const struct ovsdb_idl *idl)
492 return jsonrpc_session_is_alive(idl->session);
495 /* Returns the last error reported on a connection by 'idl'. The return value
496 * is 0 only if no connection made by 'idl' has ever encountered an error. See
497 * jsonrpc_get_status() for return value interpretation. */
499 ovsdb_idl_get_last_error(const struct ovsdb_idl *idl)
501 return jsonrpc_session_get_last_error(idl->session);
504 static unsigned char *
505 ovsdb_idl_get_mode(struct ovsdb_idl *idl,
506 const struct ovsdb_idl_column *column)
510 ovs_assert(!idl->change_seqno);
512 for (i = 0; i < idl->class->n_tables; i++) {
513 const struct ovsdb_idl_table *table = &idl->tables[i];
514 const struct ovsdb_idl_table_class *tc = table->class;
516 if (column >= tc->columns && column < &tc->columns[tc->n_columns]) {
517 return &table->modes[column - tc->columns];
525 add_ref_table(struct ovsdb_idl *idl, const struct ovsdb_base_type *base)
527 if (base->type == OVSDB_TYPE_UUID && base->u.uuid.refTableName) {
528 struct ovsdb_idl_table *table;
530 table = shash_find_data(&idl->table_by_name,
531 base->u.uuid.refTableName);
533 table->need_table = true;
535 VLOG_WARN("%s IDL class missing referenced table %s",
536 idl->class->database, base->u.uuid.refTableName);
541 /* Turns on OVSDB_IDL_MONITOR and OVSDB_IDL_ALERT for 'column' in 'idl'. Also
542 * ensures that any tables referenced by 'column' will be replicated, even if
543 * no columns in that table are selected for replication (see
544 * ovsdb_idl_add_table() for more information).
546 * This function is only useful if 'monitor_everything_by_default' was false in
547 * the call to ovsdb_idl_create(). This function should be called between
548 * ovsdb_idl_create() and the first call to ovsdb_idl_run().
551 ovsdb_idl_add_column(struct ovsdb_idl *idl,
552 const struct ovsdb_idl_column *column)
554 *ovsdb_idl_get_mode(idl, column) = OVSDB_IDL_MONITOR | OVSDB_IDL_ALERT;
555 add_ref_table(idl, &column->type.key);
556 add_ref_table(idl, &column->type.value);
559 /* Ensures that the table with class 'tc' will be replicated on 'idl' even if
560 * no columns are selected for replication. Just the necessary data for table
561 * references will be replicated (the UUID of the rows, for instance), any
562 * columns not selected for replication will remain unreplicated.
563 * This can be useful because it allows 'idl' to keep track of what rows in the
564 * table actually exist, which in turn allows columns that reference the table
565 * to have accurate contents. (The IDL presents the database with references to
566 * rows that do not exist removed.)
568 * This function is only useful if 'monitor_everything_by_default' was false in
569 * the call to ovsdb_idl_create(). This function should be called between
570 * ovsdb_idl_create() and the first call to ovsdb_idl_run().
573 ovsdb_idl_add_table(struct ovsdb_idl *idl,
574 const struct ovsdb_idl_table_class *tc)
578 for (i = 0; i < idl->class->n_tables; i++) {
579 struct ovsdb_idl_table *table = &idl->tables[i];
581 if (table->class == tc) {
582 table->need_table = true;
590 /* Turns off OVSDB_IDL_ALERT for 'column' in 'idl'.
592 * This function should be called between ovsdb_idl_create() and the first call
593 * to ovsdb_idl_run().
596 ovsdb_idl_omit_alert(struct ovsdb_idl *idl,
597 const struct ovsdb_idl_column *column)
599 *ovsdb_idl_get_mode(idl, column) &= ~OVSDB_IDL_ALERT;
602 /* Sets the mode for 'column' in 'idl' to 0. See the big comment above
603 * OVSDB_IDL_MONITOR for details.
605 * This function should be called between ovsdb_idl_create() and the first call
606 * to ovsdb_idl_run().
609 ovsdb_idl_omit(struct ovsdb_idl *idl, const struct ovsdb_idl_column *column)
611 *ovsdb_idl_get_mode(idl, column) = 0;
614 /* Returns the most recent IDL change sequence number that caused a
615 * insert, modify or delete update to the table with class 'table_class'.
618 ovsdb_idl_table_get_seqno(const struct ovsdb_idl *idl,
619 const struct ovsdb_idl_table_class *table_class)
621 struct ovsdb_idl_table *table
622 = ovsdb_idl_table_from_class(idl, table_class);
623 unsigned int max_seqno = table->change_seqno[OVSDB_IDL_CHANGE_INSERT];
625 if (max_seqno < table->change_seqno[OVSDB_IDL_CHANGE_MODIFY]) {
626 max_seqno = table->change_seqno[OVSDB_IDL_CHANGE_MODIFY];
628 if (max_seqno < table->change_seqno[OVSDB_IDL_CHANGE_DELETE]) {
629 max_seqno = table->change_seqno[OVSDB_IDL_CHANGE_DELETE];
634 /* For each row that contains tracked columns, IDL stores the most
635 * recent IDL change sequence numbers associateed with insert, modify
636 * and delete updates to the table.
639 ovsdb_idl_row_get_seqno(const struct ovsdb_idl_row *row,
640 enum ovsdb_idl_change change)
642 return row->change_seqno[change];
645 /* Turns on OVSDB_IDL_TRACK for 'column' in 'idl', ensuring that
646 * all rows whose 'column' is modified are traced. Similarly, insert
647 * or delete of rows having 'column' are tracked. Clients are able
648 * to retrive the tracked rows with the ovsdb_idl_track_get_*()
651 * This function should be called between ovsdb_idl_create() and
652 * the first call to ovsdb_idl_run(). The column to be tracked
653 * should have OVSDB_IDL_ALERT turned on.
656 ovsdb_idl_track_add_column(struct ovsdb_idl *idl,
657 const struct ovsdb_idl_column *column)
659 if (!(*ovsdb_idl_get_mode(idl, column) & OVSDB_IDL_ALERT)) {
660 ovsdb_idl_add_column(idl, column);
662 *ovsdb_idl_get_mode(idl, column) |= OVSDB_IDL_TRACK;
666 ovsdb_idl_track_add_all(struct ovsdb_idl *idl)
670 for (i = 0; i < idl->class->n_tables; i++) {
671 const struct ovsdb_idl_table_class *tc = &idl->class->tables[i];
673 for (j = 0; j < tc->n_columns; j++) {
674 const struct ovsdb_idl_column *column = &tc->columns[j];
675 ovsdb_idl_track_add_column(idl, column);
680 /* Returns true if 'table' has any tracked column. */
682 ovsdb_idl_track_is_set(struct ovsdb_idl_table *table)
686 for (i = 0; i < table->class->n_columns; i++) {
687 if (table->modes[i] & OVSDB_IDL_TRACK) {
694 /* Returns the first tracked row in table with class 'table_class'
695 * for the specified 'idl'. Returns NULL if there are no tracked rows */
696 const struct ovsdb_idl_row *
697 ovsdb_idl_track_get_first(const struct ovsdb_idl *idl,
698 const struct ovsdb_idl_table_class *table_class)
700 struct ovsdb_idl_table *table
701 = ovsdb_idl_table_from_class(idl, table_class);
703 if (!list_is_empty(&table->track_list)) {
704 return CONTAINER_OF(list_front(&table->track_list), struct ovsdb_idl_row, track_node);
709 /* Returns the next tracked row in table after the specified 'row'
710 * (in no particular order). Returns NULL if there are no tracked rows */
711 const struct ovsdb_idl_row *
712 ovsdb_idl_track_get_next(const struct ovsdb_idl_row *row)
714 if (row->track_node.next != &row->table->track_list) {
715 return CONTAINER_OF(row->track_node.next, struct ovsdb_idl_row, track_node);
721 /* Flushes the tracked rows. Client calls this function after calling
722 * ovsdb_idl_run() and read all tracked rows with the ovsdb_idl_track_get_*()
723 * functions. This is usually done at the end of the client's processing
724 * loop when it is ready to do ovsdb_idl_run() again.
727 ovsdb_idl_track_clear(const struct ovsdb_idl *idl)
731 for (i = 0; i < idl->class->n_tables; i++) {
732 struct ovsdb_idl_table *table = &idl->tables[i];
734 if (!list_is_empty(&table->track_list)) {
735 struct ovsdb_idl_row *row, *next;
737 LIST_FOR_EACH_SAFE(row, next, track_node, &table->track_list) {
738 list_remove(&row->track_node);
739 list_init(&row->track_node);
740 if (ovsdb_idl_row_is_orphan(row)) {
741 ovsdb_idl_row_clear_old(row);
751 ovsdb_idl_send_schema_request(struct ovsdb_idl *idl)
753 struct jsonrpc_msg *msg;
755 json_destroy(idl->request_id);
756 msg = jsonrpc_create_request(
758 json_array_create_1(json_string_create(idl->class->database)),
760 jsonrpc_session_send(idl->session, msg);
764 log_error(struct ovsdb_error *error)
766 char *s = ovsdb_error_to_string(error);
767 VLOG_WARN("error parsing database schema: %s", s);
769 ovsdb_error_destroy(error);
772 /* Frees 'schema', which is in the format returned by parse_schema(). */
774 free_schema(struct shash *schema)
777 struct shash_node *node, *next;
779 SHASH_FOR_EACH_SAFE (node, next, schema) {
780 struct sset *sset = node->data;
783 shash_delete(schema, node);
785 shash_destroy(schema);
790 /* Parses 'schema_json', an OVSDB schema in JSON format as described in RFC
791 * 7047, to obtain the names of its rows and columns. If successful, returns
792 * an shash whose keys are table names and whose values are ssets, where each
793 * sset contains the names of its table's columns. On failure (due to a parse
794 * error), returns NULL.
796 * It would also be possible to use the general-purpose OVSDB schema parser in
797 * ovsdb-server, but that's overkill, possibly too strict for the current use
798 * case, and would require restructuring ovsdb-server to separate the schema
799 * code from the rest. */
800 static struct shash *
801 parse_schema(const struct json *schema_json)
803 struct ovsdb_parser parser;
804 const struct json *tables_json;
805 struct ovsdb_error *error;
806 struct shash_node *node;
807 struct shash *schema;
809 ovsdb_parser_init(&parser, schema_json, "database schema");
810 tables_json = ovsdb_parser_member(&parser, "tables", OP_OBJECT);
811 error = ovsdb_parser_destroy(&parser);
817 schema = xmalloc(sizeof *schema);
819 SHASH_FOR_EACH (node, json_object(tables_json)) {
820 const char *table_name = node->name;
821 const struct json *json = node->data;
822 const struct json *columns_json;
824 ovsdb_parser_init(&parser, json, "table schema for table %s",
826 columns_json = ovsdb_parser_member(&parser, "columns", OP_OBJECT);
827 error = ovsdb_parser_destroy(&parser);
834 struct sset *columns = xmalloc(sizeof *columns);
837 struct shash_node *node2;
838 SHASH_FOR_EACH (node2, json_object(columns_json)) {
839 const char *column_name = node2->name;
840 sset_add(columns, column_name);
842 shash_add(schema, table_name, columns);
848 ovsdb_idl_send_monitor_request(struct ovsdb_idl *idl,
849 const struct json *schema_json)
851 struct shash *schema = parse_schema(schema_json);
852 struct json *monitor_requests;
853 struct jsonrpc_msg *msg;
856 monitor_requests = json_object_create();
857 for (i = 0; i < idl->class->n_tables; i++) {
858 const struct ovsdb_idl_table *table = &idl->tables[i];
859 const struct ovsdb_idl_table_class *tc = table->class;
860 struct json *monitor_request, *columns;
861 const struct sset *table_schema;
864 table_schema = (schema
865 ? shash_find_data(schema, table->class->name)
868 columns = table->need_table ? json_array_create_empty() : NULL;
869 for (j = 0; j < tc->n_columns; j++) {
870 const struct ovsdb_idl_column *column = &tc->columns[j];
871 if (table->modes[j] & OVSDB_IDL_MONITOR) {
873 && !sset_contains(table_schema, column->name)) {
874 VLOG_WARN("%s table in %s database lacks %s column "
875 "(database needs upgrade?)",
876 table->class->name, idl->class->database,
881 columns = json_array_create_empty();
883 json_array_add(columns, json_string_create(column->name));
888 if (schema && !table_schema) {
889 VLOG_WARN("%s database lacks %s table "
890 "(database needs upgrade?)",
891 idl->class->database, table->class->name);
892 json_destroy(columns);
896 monitor_request = json_object_create();
897 json_object_put(monitor_request, "columns", columns);
898 json_object_put(monitor_requests, tc->name, monitor_request);
903 json_destroy(idl->request_id);
904 msg = jsonrpc_create_request(
906 json_array_create_3(json_string_create(idl->class->database),
907 json_null_create(), monitor_requests),
909 jsonrpc_session_send(idl->session, msg);
913 ovsdb_idl_parse_update(struct ovsdb_idl *idl, const struct json *table_updates)
915 struct ovsdb_error *error = ovsdb_idl_parse_update__(idl, table_updates);
917 if (!VLOG_DROP_WARN(&syntax_rl)) {
918 char *s = ovsdb_error_to_string(error);
919 VLOG_WARN_RL(&syntax_rl, "%s", s);
922 ovsdb_error_destroy(error);
926 static struct ovsdb_error *
927 ovsdb_idl_parse_update__(struct ovsdb_idl *idl,
928 const struct json *table_updates)
930 const struct shash_node *tables_node;
932 if (table_updates->type != JSON_OBJECT) {
933 return ovsdb_syntax_error(table_updates, NULL,
934 "<table-updates> is not an object");
936 SHASH_FOR_EACH (tables_node, json_object(table_updates)) {
937 const struct json *table_update = tables_node->data;
938 const struct shash_node *table_node;
939 struct ovsdb_idl_table *table;
941 table = shash_find_data(&idl->table_by_name, tables_node->name);
943 return ovsdb_syntax_error(
945 "<table-updates> includes unknown table \"%s\"",
949 if (table_update->type != JSON_OBJECT) {
950 return ovsdb_syntax_error(table_update, NULL,
951 "<table-update> for table \"%s\" is "
952 "not an object", table->class->name);
954 SHASH_FOR_EACH (table_node, json_object(table_update)) {
955 const struct json *row_update = table_node->data;
956 const struct json *old_json, *new_json;
959 if (!uuid_from_string(&uuid, table_node->name)) {
960 return ovsdb_syntax_error(table_update, NULL,
961 "<table-update> for table \"%s\" "
963 "\"%s\" as member name",
967 if (row_update->type != JSON_OBJECT) {
968 return ovsdb_syntax_error(row_update, NULL,
969 "<table-update> for table \"%s\" "
970 "contains <row-update> for %s that "
976 old_json = shash_find_data(json_object(row_update), "old");
977 new_json = shash_find_data(json_object(row_update), "new");
978 if (old_json && old_json->type != JSON_OBJECT) {
979 return ovsdb_syntax_error(old_json, NULL,
980 "\"old\" <row> is not object");
981 } else if (new_json && new_json->type != JSON_OBJECT) {
982 return ovsdb_syntax_error(new_json, NULL,
983 "\"new\" <row> is not object");
984 } else if ((old_json != NULL) + (new_json != NULL)
985 != shash_count(json_object(row_update))) {
986 return ovsdb_syntax_error(row_update, NULL,
987 "<row-update> contains unexpected "
989 } else if (!old_json && !new_json) {
990 return ovsdb_syntax_error(row_update, NULL,
991 "<row-update> missing \"old\" "
992 "and \"new\" members");
995 if (ovsdb_idl_process_update(table, &uuid, old_json, new_json)) {
1004 static struct ovsdb_idl_row *
1005 ovsdb_idl_get_row(struct ovsdb_idl_table *table, const struct uuid *uuid)
1007 struct ovsdb_idl_row *row;
1009 HMAP_FOR_EACH_WITH_HASH (row, hmap_node, uuid_hash(uuid), &table->rows) {
1010 if (uuid_equals(&row->uuid, uuid)) {
1017 /* Returns true if a column with mode OVSDB_IDL_MODE_RW changed, false
1020 ovsdb_idl_process_update(struct ovsdb_idl_table *table,
1021 const struct uuid *uuid, const struct json *old,
1022 const struct json *new)
1024 struct ovsdb_idl_row *row;
1026 row = ovsdb_idl_get_row(table, uuid);
1029 if (row && !ovsdb_idl_row_is_orphan(row)) {
1030 /* XXX perhaps we should check the 'old' values? */
1031 ovsdb_idl_delete_row(row);
1033 VLOG_WARN_RL(&semantic_rl, "cannot delete missing row "UUID_FMT" "
1035 UUID_ARGS(uuid), table->class->name);
1041 ovsdb_idl_insert_row(ovsdb_idl_row_create(table, uuid), new);
1042 } else if (ovsdb_idl_row_is_orphan(row)) {
1043 ovsdb_idl_insert_row(row, new);
1045 VLOG_WARN_RL(&semantic_rl, "cannot add existing row "UUID_FMT" to "
1046 "table %s", UUID_ARGS(uuid), table->class->name);
1047 return ovsdb_idl_modify_row(row, new);
1052 /* XXX perhaps we should check the 'old' values? */
1053 if (!ovsdb_idl_row_is_orphan(row)) {
1054 return ovsdb_idl_modify_row(row, new);
1056 VLOG_WARN_RL(&semantic_rl, "cannot modify missing but "
1057 "referenced row "UUID_FMT" in table %s",
1058 UUID_ARGS(uuid), table->class->name);
1059 ovsdb_idl_insert_row(row, new);
1062 VLOG_WARN_RL(&semantic_rl, "cannot modify missing row "UUID_FMT" "
1063 "in table %s", UUID_ARGS(uuid), table->class->name);
1064 ovsdb_idl_insert_row(ovsdb_idl_row_create(table, uuid), new);
1071 /* Returns true if a column with mode OVSDB_IDL_MODE_RW changed, false
1074 ovsdb_idl_row_update(struct ovsdb_idl_row *row, const struct json *row_json,
1075 enum ovsdb_idl_change change)
1077 struct ovsdb_idl_table *table = row->table;
1078 struct shash_node *node;
1079 bool changed = false;
1081 SHASH_FOR_EACH (node, json_object(row_json)) {
1082 const char *column_name = node->name;
1083 const struct ovsdb_idl_column *column;
1084 struct ovsdb_datum datum;
1085 struct ovsdb_error *error;
1087 column = shash_find_data(&table->columns, column_name);
1089 VLOG_WARN_RL(&syntax_rl, "unknown column %s updating row "UUID_FMT,
1090 column_name, UUID_ARGS(&row->uuid));
1094 error = ovsdb_datum_from_json(&datum, &column->type, node->data, NULL);
1096 unsigned int column_idx = column - table->class->columns;
1097 struct ovsdb_datum *old = &row->old[column_idx];
1099 if (!ovsdb_datum_equals(old, &datum, &column->type)) {
1100 ovsdb_datum_swap(old, &datum);
1101 if (table->modes[column_idx] & OVSDB_IDL_ALERT) {
1103 row->change_seqno[change]
1104 = row->table->change_seqno[change]
1105 = row->table->idl->change_seqno + 1;
1106 if (table->modes[column_idx] & OVSDB_IDL_TRACK) {
1107 if (list_is_empty(&row->track_node)) {
1108 list_push_front(&row->table->track_list,
1114 /* Didn't really change but the OVSDB monitor protocol always
1115 * includes every value in a row. */
1118 ovsdb_datum_destroy(&datum, &column->type);
1120 char *s = ovsdb_error_to_string(error);
1121 VLOG_WARN_RL(&syntax_rl, "error parsing column %s in row "UUID_FMT
1122 " in table %s: %s", column_name,
1123 UUID_ARGS(&row->uuid), table->class->name, s);
1125 ovsdb_error_destroy(error);
1131 /* When a row A refers to row B through a column with a "refTable" constraint,
1132 * but row B does not exist, row B is called an "orphan row". Orphan rows
1133 * should not persist, because the database enforces referential integrity, but
1134 * they can appear transiently as changes from the database are received (the
1135 * database doesn't try to topologically sort them and circular references mean
1136 * it isn't always possible anyhow).
1138 * This function returns true if 'row' is an orphan row, otherwise false.
1141 ovsdb_idl_row_is_orphan(const struct ovsdb_idl_row *row)
1143 return !row->old && !row->new;
1146 /* Returns true if 'row' is conceptually part of the database as modified by
1147 * the current transaction (if any), false otherwise.
1149 * This function will return true if 'row' is not an orphan (see the comment on
1150 * ovsdb_idl_row_is_orphan()) and:
1152 * - 'row' exists in the database and has not been deleted within the
1153 * current transaction (if any).
1155 * - 'row' was inserted within the current transaction and has not been
1156 * deleted. (In the latter case you should not have passed 'row' in at
1157 * all, because ovsdb_idl_txn_delete() freed it.)
1159 * This function will return false if 'row' is an orphan or if 'row' was
1160 * deleted within the current transaction.
1163 ovsdb_idl_row_exists(const struct ovsdb_idl_row *row)
1165 return row->new != NULL;
1169 ovsdb_idl_row_parse(struct ovsdb_idl_row *row)
1171 const struct ovsdb_idl_table_class *class = row->table->class;
1174 for (i = 0; i < class->n_columns; i++) {
1175 const struct ovsdb_idl_column *c = &class->columns[i];
1176 (c->parse)(row, &row->old[i]);
1181 ovsdb_idl_row_unparse(struct ovsdb_idl_row *row)
1183 const struct ovsdb_idl_table_class *class = row->table->class;
1186 for (i = 0; i < class->n_columns; i++) {
1187 const struct ovsdb_idl_column *c = &class->columns[i];
1193 ovsdb_idl_row_clear_old(struct ovsdb_idl_row *row)
1195 ovs_assert(row->old == row->new);
1196 if (!ovsdb_idl_row_is_orphan(row)) {
1197 const struct ovsdb_idl_table_class *class = row->table->class;
1200 for (i = 0; i < class->n_columns; i++) {
1201 ovsdb_datum_destroy(&row->old[i], &class->columns[i].type);
1204 row->old = row->new = NULL;
1209 ovsdb_idl_row_clear_new(struct ovsdb_idl_row *row)
1211 if (row->old != row->new) {
1213 const struct ovsdb_idl_table_class *class = row->table->class;
1217 BITMAP_FOR_EACH_1 (i, class->n_columns, row->written) {
1218 ovsdb_datum_destroy(&row->new[i], &class->columns[i].type);
1223 row->written = NULL;
1225 row->new = row->old;
1230 ovsdb_idl_row_clear_arcs(struct ovsdb_idl_row *row, bool destroy_dsts)
1232 struct ovsdb_idl_arc *arc, *next;
1234 /* Delete all forward arcs. If 'destroy_dsts', destroy any orphaned rows
1235 * that this causes to be unreferenced, if tracking is not enabled.
1236 * If tracking is enabled, orphaned nodes are removed from hmap but not
1239 LIST_FOR_EACH_SAFE (arc, next, src_node, &row->src_arcs) {
1240 list_remove(&arc->dst_node);
1242 && ovsdb_idl_row_is_orphan(arc->dst)
1243 && list_is_empty(&arc->dst->dst_arcs)) {
1244 ovsdb_idl_row_destroy(arc->dst);
1248 list_init(&row->src_arcs);
1251 /* Force nodes that reference 'row' to reparse. */
1253 ovsdb_idl_row_reparse_backrefs(struct ovsdb_idl_row *row)
1255 struct ovsdb_idl_arc *arc, *next;
1257 /* This is trickier than it looks. ovsdb_idl_row_clear_arcs() will destroy
1258 * 'arc', so we need to use the "safe" variant of list traversal. However,
1259 * calling an ovsdb_idl_column's 'parse' function will add an arc
1260 * equivalent to 'arc' to row->arcs. That could be a problem for
1261 * traversal, but it adds it at the beginning of the list to prevent us
1262 * from stumbling upon it again.
1264 * (If duplicate arcs were possible then we would need to make sure that
1265 * 'next' didn't also point into 'arc''s destination, but we forbid
1266 * duplicate arcs.) */
1267 LIST_FOR_EACH_SAFE (arc, next, dst_node, &row->dst_arcs) {
1268 struct ovsdb_idl_row *ref = arc->src;
1270 ovsdb_idl_row_unparse(ref);
1271 ovsdb_idl_row_clear_arcs(ref, false);
1272 ovsdb_idl_row_parse(ref);
1276 static struct ovsdb_idl_row *
1277 ovsdb_idl_row_create__(const struct ovsdb_idl_table_class *class)
1279 struct ovsdb_idl_row *row = xzalloc(class->allocation_size);
1280 class->row_init(row);
1281 list_init(&row->src_arcs);
1282 list_init(&row->dst_arcs);
1283 hmap_node_nullify(&row->txn_node);
1284 list_init(&row->track_node);
1288 static struct ovsdb_idl_row *
1289 ovsdb_idl_row_create(struct ovsdb_idl_table *table, const struct uuid *uuid)
1291 struct ovsdb_idl_row *row = ovsdb_idl_row_create__(table->class);
1292 hmap_insert(&table->rows, &row->hmap_node, uuid_hash(uuid));
1299 ovsdb_idl_row_destroy(struct ovsdb_idl_row *row)
1302 ovsdb_idl_row_clear_old(row);
1303 hmap_remove(&row->table->rows, &row->hmap_node);
1304 if (ovsdb_idl_track_is_set(row->table)) {
1305 row->change_seqno[OVSDB_IDL_CHANGE_DELETE]
1306 = row->table->change_seqno[OVSDB_IDL_CHANGE_DELETE]
1307 = row->table->idl->change_seqno + 1;
1309 if (list_is_empty(&row->track_node)) {
1310 list_push_front(&row->table->track_list, &row->track_node);
1316 ovsdb_idl_row_destroy_postprocess(struct ovsdb_idl *idl)
1320 for (i = 0; i < idl->class->n_tables; i++) {
1321 struct ovsdb_idl_table *table = &idl->tables[i];
1323 if (!list_is_empty(&table->track_list)) {
1324 struct ovsdb_idl_row *row, *next;
1326 LIST_FOR_EACH_SAFE(row, next, track_node, &table->track_list) {
1327 if (!ovsdb_idl_track_is_set(row->table)) {
1328 list_remove(&row->track_node);
1337 ovsdb_idl_insert_row(struct ovsdb_idl_row *row, const struct json *row_json)
1339 const struct ovsdb_idl_table_class *class = row->table->class;
1342 ovs_assert(!row->old && !row->new);
1343 row->old = row->new = xmalloc(class->n_columns * sizeof *row->old);
1344 for (i = 0; i < class->n_columns; i++) {
1345 ovsdb_datum_init_default(&row->old[i], &class->columns[i].type);
1347 ovsdb_idl_row_update(row, row_json, OVSDB_IDL_CHANGE_INSERT);
1348 ovsdb_idl_row_parse(row);
1350 ovsdb_idl_row_reparse_backrefs(row);
1354 ovsdb_idl_delete_row(struct ovsdb_idl_row *row)
1356 ovsdb_idl_row_unparse(row);
1357 ovsdb_idl_row_clear_arcs(row, true);
1358 ovsdb_idl_row_clear_old(row);
1359 if (list_is_empty(&row->dst_arcs)) {
1360 ovsdb_idl_row_destroy(row);
1362 ovsdb_idl_row_reparse_backrefs(row);
1366 /* Returns true if a column with mode OVSDB_IDL_MODE_RW changed, false
1369 ovsdb_idl_modify_row(struct ovsdb_idl_row *row, const struct json *row_json)
1373 ovsdb_idl_row_unparse(row);
1374 ovsdb_idl_row_clear_arcs(row, true);
1375 changed = ovsdb_idl_row_update(row, row_json, OVSDB_IDL_CHANGE_MODIFY);
1376 ovsdb_idl_row_parse(row);
1382 may_add_arc(const struct ovsdb_idl_row *src, const struct ovsdb_idl_row *dst)
1384 const struct ovsdb_idl_arc *arc;
1391 /* No duplicate arcs.
1393 * We only need to test whether the first arc in dst->dst_arcs originates
1394 * at 'src', since we add all of the arcs from a given source in a clump
1395 * (in a single call to ovsdb_idl_row_parse()) and new arcs are always
1396 * added at the front of the dst_arcs list. */
1397 if (list_is_empty(&dst->dst_arcs)) {
1400 arc = CONTAINER_OF(dst->dst_arcs.next, struct ovsdb_idl_arc, dst_node);
1401 return arc->src != src;
1404 static struct ovsdb_idl_table *
1405 ovsdb_idl_table_from_class(const struct ovsdb_idl *idl,
1406 const struct ovsdb_idl_table_class *table_class)
1408 return &idl->tables[table_class - idl->class->tables];
1411 /* Called by ovsdb-idlc generated code. */
1412 struct ovsdb_idl_row *
1413 ovsdb_idl_get_row_arc(struct ovsdb_idl_row *src,
1414 struct ovsdb_idl_table_class *dst_table_class,
1415 const struct uuid *dst_uuid)
1417 struct ovsdb_idl *idl = src->table->idl;
1418 struct ovsdb_idl_table *dst_table;
1419 struct ovsdb_idl_arc *arc;
1420 struct ovsdb_idl_row *dst;
1422 dst_table = ovsdb_idl_table_from_class(idl, dst_table_class);
1423 dst = ovsdb_idl_get_row(dst_table, dst_uuid);
1425 /* We're being called from ovsdb_idl_txn_write(). We must not update
1426 * any arcs, because the transaction will be backed out at commit or
1427 * abort time and we don't want our graph screwed up.
1429 * Just return the destination row, if there is one and it has not been
1431 if (dst && (hmap_node_is_null(&dst->txn_node) || dst->new)) {
1436 /* We're being called from some other context. Update the graph. */
1438 dst = ovsdb_idl_row_create(dst_table, dst_uuid);
1441 /* Add a new arc, if it wouldn't be a self-arc or a duplicate arc. */
1442 if (may_add_arc(src, dst)) {
1443 /* The arc *must* be added at the front of the dst_arcs list. See
1444 * ovsdb_idl_row_reparse_backrefs() for details. */
1445 arc = xmalloc(sizeof *arc);
1446 list_push_front(&src->src_arcs, &arc->src_node);
1447 list_push_front(&dst->dst_arcs, &arc->dst_node);
1452 return !ovsdb_idl_row_is_orphan(dst) ? dst : NULL;
1456 /* Searches 'tc''s table in 'idl' for a row with UUID 'uuid'. Returns a
1457 * pointer to the row if there is one, otherwise a null pointer. */
1458 const struct ovsdb_idl_row *
1459 ovsdb_idl_get_row_for_uuid(const struct ovsdb_idl *idl,
1460 const struct ovsdb_idl_table_class *tc,
1461 const struct uuid *uuid)
1463 return ovsdb_idl_get_row(ovsdb_idl_table_from_class(idl, tc), uuid);
1466 static struct ovsdb_idl_row *
1467 next_real_row(struct ovsdb_idl_table *table, struct hmap_node *node)
1469 for (; node; node = hmap_next(&table->rows, node)) {
1470 struct ovsdb_idl_row *row;
1472 row = CONTAINER_OF(node, struct ovsdb_idl_row, hmap_node);
1473 if (ovsdb_idl_row_exists(row)) {
1480 /* Returns a row in 'table_class''s table in 'idl', or a null pointer if that
1483 * Database tables are internally maintained as hash tables, so adding or
1484 * removing rows while traversing the same table can cause some rows to be
1485 * visited twice or not at apply. */
1486 const struct ovsdb_idl_row *
1487 ovsdb_idl_first_row(const struct ovsdb_idl *idl,
1488 const struct ovsdb_idl_table_class *table_class)
1490 struct ovsdb_idl_table *table
1491 = ovsdb_idl_table_from_class(idl, table_class);
1492 return next_real_row(table, hmap_first(&table->rows));
1495 /* Returns a row following 'row' within its table, or a null pointer if 'row'
1496 * is the last row in its table. */
1497 const struct ovsdb_idl_row *
1498 ovsdb_idl_next_row(const struct ovsdb_idl_row *row)
1500 struct ovsdb_idl_table *table = row->table;
1502 return next_real_row(table, hmap_next(&table->rows, &row->hmap_node));
1505 /* Reads and returns the value of 'column' within 'row'. If an ongoing
1506 * transaction has changed 'column''s value, the modified value is returned.
1508 * The caller must not modify or free the returned value.
1510 * Various kinds of changes can invalidate the returned value: writing to the
1511 * same 'column' in 'row' (e.g. with ovsdb_idl_txn_write()), deleting 'row'
1512 * (e.g. with ovsdb_idl_txn_delete()), or completing an ongoing transaction
1513 * (e.g. with ovsdb_idl_txn_commit() or ovsdb_idl_txn_abort()). If the
1514 * returned value is needed for a long time, it is best to make a copy of it
1515 * with ovsdb_datum_clone(). */
1516 const struct ovsdb_datum *
1517 ovsdb_idl_read(const struct ovsdb_idl_row *row,
1518 const struct ovsdb_idl_column *column)
1520 const struct ovsdb_idl_table_class *class;
1523 ovs_assert(!ovsdb_idl_row_is_synthetic(row));
1525 class = row->table->class;
1526 column_idx = column - class->columns;
1528 ovs_assert(row->new != NULL);
1529 ovs_assert(column_idx < class->n_columns);
1531 if (row->written && bitmap_is_set(row->written, column_idx)) {
1532 return &row->new[column_idx];
1533 } else if (row->old) {
1534 return &row->old[column_idx];
1536 return ovsdb_datum_default(&column->type);
1540 /* Same as ovsdb_idl_read(), except that it also asserts that 'column' has key
1541 * type 'key_type' and value type 'value_type'. (Scalar and set types will
1542 * have a value type of OVSDB_TYPE_VOID.)
1544 * This is useful in code that "knows" that a particular column has a given
1545 * type, so that it will abort if someone changes the column's type without
1546 * updating the code that uses it. */
1547 const struct ovsdb_datum *
1548 ovsdb_idl_get(const struct ovsdb_idl_row *row,
1549 const struct ovsdb_idl_column *column,
1550 enum ovsdb_atomic_type key_type OVS_UNUSED,
1551 enum ovsdb_atomic_type value_type OVS_UNUSED)
1553 ovs_assert(column->type.key.type == key_type);
1554 ovs_assert(column->type.value.type == value_type);
1556 return ovsdb_idl_read(row, column);
1559 /* Returns true if the field represented by 'column' in 'row' may be modified,
1560 * false if it is immutable.
1562 * Normally, whether a field is mutable is controlled by its column's schema.
1563 * However, an immutable column can be set to any initial value at the time of
1564 * insertion, so if 'row' is a new row (one that is being added as part of the
1565 * current transaction, supposing that a transaction is in progress) then even
1566 * its "immutable" fields are actually mutable. */
1568 ovsdb_idl_is_mutable(const struct ovsdb_idl_row *row,
1569 const struct ovsdb_idl_column *column)
1571 return column->mutable || (row->new && !row->old);
1574 /* Returns false if 'row' was obtained from the IDL, true if it was initialized
1575 * to all-zero-bits by some other entity. If 'row' was set up some other way
1576 * then the return value is indeterminate. */
1578 ovsdb_idl_row_is_synthetic(const struct ovsdb_idl_row *row)
1580 return row->table == NULL;
1585 static void ovsdb_idl_txn_complete(struct ovsdb_idl_txn *txn,
1586 enum ovsdb_idl_txn_status);
1588 /* Returns a string representation of 'status'. The caller must not modify or
1589 * free the returned string.
1591 * The return value is probably useful only for debug log messages and unit
1594 ovsdb_idl_txn_status_to_string(enum ovsdb_idl_txn_status status)
1597 case TXN_UNCOMMITTED:
1598 return "uncommitted";
1601 case TXN_INCOMPLETE:
1602 return "incomplete";
1609 case TXN_NOT_LOCKED:
1610 return "not locked";
1617 /* Starts a new transaction on 'idl'. A given ovsdb_idl may only have a single
1618 * active transaction at a time. See the large comment in ovsdb-idl.h for
1619 * general information on transactions. */
1620 struct ovsdb_idl_txn *
1621 ovsdb_idl_txn_create(struct ovsdb_idl *idl)
1623 struct ovsdb_idl_txn *txn;
1625 ovs_assert(!idl->txn);
1626 idl->txn = txn = xmalloc(sizeof *txn);
1627 txn->request_id = NULL;
1629 hmap_init(&txn->txn_rows);
1630 txn->status = TXN_UNCOMMITTED;
1632 txn->dry_run = false;
1633 ds_init(&txn->comment);
1635 txn->inc_table = NULL;
1636 txn->inc_column = NULL;
1638 hmap_init(&txn->inserted_rows);
1643 /* Appends 's', which is treated as a printf()-type format string, to the
1644 * comments that will be passed to the OVSDB server when 'txn' is committed.
1645 * (The comment will be committed to the OVSDB log, which "ovsdb-tool
1646 * show-log" can print in a relatively human-readable form.) */
1648 ovsdb_idl_txn_add_comment(struct ovsdb_idl_txn *txn, const char *s, ...)
1652 if (txn->comment.length) {
1653 ds_put_char(&txn->comment, '\n');
1657 ds_put_format_valist(&txn->comment, s, args);
1661 /* Marks 'txn' as a transaction that will not actually modify the database. In
1662 * almost every way, the transaction is treated like other transactions. It
1663 * must be committed or aborted like other transactions, it will be sent to the
1664 * database server like other transactions, and so on. The only difference is
1665 * that the operations sent to the database server will include, as the last
1666 * step, an "abort" operation, so that any changes made by the transaction will
1667 * not actually take effect. */
1669 ovsdb_idl_txn_set_dry_run(struct ovsdb_idl_txn *txn)
1671 txn->dry_run = true;
1674 /* Causes 'txn', when committed, to increment the value of 'column' within
1675 * 'row' by 1. 'column' must have an integer type. After 'txn' commits
1676 * successfully, the client may retrieve the final (incremented) value of
1677 * 'column' with ovsdb_idl_txn_get_increment_new_value().
1679 * The client could accomplish something similar with ovsdb_idl_read(),
1680 * ovsdb_idl_txn_verify() and ovsdb_idl_txn_write(), or with ovsdb-idlc
1681 * generated wrappers for these functions. However, ovsdb_idl_txn_increment()
1682 * will never (by itself) fail because of a verify error.
1684 * The intended use is for incrementing the "next_cfg" column in the
1685 * Open_vSwitch table. */
1687 ovsdb_idl_txn_increment(struct ovsdb_idl_txn *txn,
1688 const struct ovsdb_idl_row *row,
1689 const struct ovsdb_idl_column *column)
1691 ovs_assert(!txn->inc_table);
1692 ovs_assert(column->type.key.type == OVSDB_TYPE_INTEGER);
1693 ovs_assert(column->type.value.type == OVSDB_TYPE_VOID);
1695 txn->inc_table = row->table->class->name;
1696 txn->inc_column = column->name;
1697 txn->inc_row = row->uuid;
1700 /* Destroys 'txn' and frees all associated memory. If ovsdb_idl_txn_commit()
1701 * has been called for 'txn' but the commit is still incomplete (that is, the
1702 * last call returned TXN_INCOMPLETE) then the transaction may or may not still
1703 * end up committing at the database server, but the client will not be able to
1704 * get any further status information back. */
1706 ovsdb_idl_txn_destroy(struct ovsdb_idl_txn *txn)
1708 struct ovsdb_idl_txn_insert *insert, *next;
1710 json_destroy(txn->request_id);
1711 if (txn->status == TXN_INCOMPLETE) {
1712 hmap_remove(&txn->idl->outstanding_txns, &txn->hmap_node);
1714 ovsdb_idl_txn_abort(txn);
1715 ds_destroy(&txn->comment);
1717 HMAP_FOR_EACH_SAFE (insert, next, hmap_node, &txn->inserted_rows) {
1720 hmap_destroy(&txn->inserted_rows);
1724 /* Causes poll_block() to wake up if 'txn' has completed committing. */
1726 ovsdb_idl_txn_wait(const struct ovsdb_idl_txn *txn)
1728 if (txn->status != TXN_UNCOMMITTED && txn->status != TXN_INCOMPLETE) {
1729 poll_immediate_wake();
1733 static struct json *
1734 where_uuid_equals(const struct uuid *uuid)
1737 json_array_create_1(
1738 json_array_create_3(
1739 json_string_create("_uuid"),
1740 json_string_create("=="),
1741 json_array_create_2(
1742 json_string_create("uuid"),
1743 json_string_create_nocopy(
1744 xasprintf(UUID_FMT, UUID_ARGS(uuid))))));
1748 uuid_name_from_uuid(const struct uuid *uuid)
1753 name = xasprintf("row"UUID_FMT, UUID_ARGS(uuid));
1754 for (p = name; *p != '\0'; p++) {
1763 static const struct ovsdb_idl_row *
1764 ovsdb_idl_txn_get_row(const struct ovsdb_idl_txn *txn, const struct uuid *uuid)
1766 const struct ovsdb_idl_row *row;
1768 HMAP_FOR_EACH_WITH_HASH (row, txn_node, uuid_hash(uuid), &txn->txn_rows) {
1769 if (uuid_equals(&row->uuid, uuid)) {
1776 /* XXX there must be a cleaner way to do this */
1777 static struct json *
1778 substitute_uuids(struct json *json, const struct ovsdb_idl_txn *txn)
1780 if (json->type == JSON_ARRAY) {
1784 if (json->u.array.n == 2
1785 && json->u.array.elems[0]->type == JSON_STRING
1786 && json->u.array.elems[1]->type == JSON_STRING
1787 && !strcmp(json->u.array.elems[0]->u.string, "uuid")
1788 && uuid_from_string(&uuid, json->u.array.elems[1]->u.string)) {
1789 const struct ovsdb_idl_row *row;
1791 row = ovsdb_idl_txn_get_row(txn, &uuid);
1792 if (row && !row->old && row->new) {
1795 return json_array_create_2(
1796 json_string_create("named-uuid"),
1797 json_string_create_nocopy(uuid_name_from_uuid(&uuid)));
1801 for (i = 0; i < json->u.array.n; i++) {
1802 json->u.array.elems[i] = substitute_uuids(json->u.array.elems[i],
1805 } else if (json->type == JSON_OBJECT) {
1806 struct shash_node *node;
1808 SHASH_FOR_EACH (node, json_object(json)) {
1809 node->data = substitute_uuids(node->data, txn);
1816 ovsdb_idl_txn_disassemble(struct ovsdb_idl_txn *txn)
1818 struct ovsdb_idl_row *row, *next;
1820 /* This must happen early. Otherwise, ovsdb_idl_row_parse() will call an
1821 * ovsdb_idl_column's 'parse' function, which will call
1822 * ovsdb_idl_get_row_arc(), which will seen that the IDL is in a
1823 * transaction and fail to update the graph. */
1824 txn->idl->txn = NULL;
1826 HMAP_FOR_EACH_SAFE (row, next, txn_node, &txn->txn_rows) {
1829 ovsdb_idl_row_unparse(row);
1830 ovsdb_idl_row_clear_arcs(row, false);
1831 ovsdb_idl_row_parse(row);
1834 ovsdb_idl_row_unparse(row);
1836 ovsdb_idl_row_clear_new(row);
1839 row->prereqs = NULL;
1842 row->written = NULL;
1844 hmap_remove(&txn->txn_rows, &row->txn_node);
1845 hmap_node_nullify(&row->txn_node);
1847 hmap_remove(&row->table->rows, &row->hmap_node);
1851 hmap_destroy(&txn->txn_rows);
1852 hmap_init(&txn->txn_rows);
1855 /* Attempts to commit 'txn'. Returns the status of the commit operation, one
1856 * of the following TXN_* constants:
1860 * The transaction is in progress, but not yet complete. The caller
1861 * should call again later, after calling ovsdb_idl_run() to let the IDL
1862 * do OVSDB protocol processing.
1866 * The transaction is complete. (It didn't actually change the database,
1867 * so the IDL didn't send any request to the database server.)
1871 * The caller previously called ovsdb_idl_txn_abort().
1875 * The transaction was successful. The update made by the transaction
1876 * (and possibly other changes made by other database clients) should
1877 * already be visible in the IDL.
1881 * The transaction failed for some transient reason, e.g. because a
1882 * "verify" operation reported an inconsistency or due to a network
1883 * problem. The caller should wait for a change to the database, then
1884 * compose a new transaction, and commit the new transaction.
1886 * Use the return value of ovsdb_idl_get_seqno() to wait for a change in
1887 * the database. It is important to use its return value *before* the
1888 * initial call to ovsdb_idl_txn_commit() as the baseline for this
1889 * purpose, because the change that one should wait for can happen after
1890 * the initial call but before the call that returns TXN_TRY_AGAIN, and
1891 * using some other baseline value in that situation could cause an
1892 * indefinite wait if the database rarely changes.
1896 * The transaction failed because the IDL has been configured to require
1897 * a database lock (with ovsdb_idl_set_lock()) but didn't get it yet or
1898 * has already lost it.
1900 * Committing a transaction rolls back all of the changes that it made to the
1901 * IDL's copy of the database. If the transaction commits successfully, then
1902 * the database server will send an update and, thus, the IDL will be updated
1903 * with the committed changes. */
1904 enum ovsdb_idl_txn_status
1905 ovsdb_idl_txn_commit(struct ovsdb_idl_txn *txn)
1907 struct ovsdb_idl_row *row;
1908 struct json *operations;
1911 if (txn != txn->idl->txn) {
1915 /* If we need a lock but don't have it, give up quickly. */
1916 if (txn->idl->lock_name && !ovsdb_idl_has_lock(txn->idl)) {
1917 txn->status = TXN_NOT_LOCKED;
1918 goto disassemble_out;
1921 operations = json_array_create_1(
1922 json_string_create(txn->idl->class->database));
1924 /* Assert that we have the required lock (avoiding a race). */
1925 if (txn->idl->lock_name) {
1926 struct json *op = json_object_create();
1927 json_array_add(operations, op);
1928 json_object_put_string(op, "op", "assert");
1929 json_object_put_string(op, "lock", txn->idl->lock_name);
1932 /* Add prerequisites and declarations of new rows. */
1933 HMAP_FOR_EACH (row, txn_node, &txn->txn_rows) {
1934 /* XXX check that deleted rows exist even if no prereqs? */
1936 const struct ovsdb_idl_table_class *class = row->table->class;
1937 size_t n_columns = class->n_columns;
1938 struct json *op, *columns, *row_json;
1941 op = json_object_create();
1942 json_array_add(operations, op);
1943 json_object_put_string(op, "op", "wait");
1944 json_object_put_string(op, "table", class->name);
1945 json_object_put(op, "timeout", json_integer_create(0));
1946 json_object_put(op, "where", where_uuid_equals(&row->uuid));
1947 json_object_put_string(op, "until", "==");
1948 columns = json_array_create_empty();
1949 json_object_put(op, "columns", columns);
1950 row_json = json_object_create();
1951 json_object_put(op, "rows", json_array_create_1(row_json));
1953 BITMAP_FOR_EACH_1 (idx, n_columns, row->prereqs) {
1954 const struct ovsdb_idl_column *column = &class->columns[idx];
1955 json_array_add(columns, json_string_create(column->name));
1956 json_object_put(row_json, column->name,
1957 ovsdb_datum_to_json(&row->old[idx],
1964 any_updates = false;
1965 HMAP_FOR_EACH (row, txn_node, &txn->txn_rows) {
1966 const struct ovsdb_idl_table_class *class = row->table->class;
1969 if (class->is_root) {
1970 struct json *op = json_object_create();
1971 json_object_put_string(op, "op", "delete");
1972 json_object_put_string(op, "table", class->name);
1973 json_object_put(op, "where", where_uuid_equals(&row->uuid));
1974 json_array_add(operations, op);
1977 /* Let ovsdb-server decide whether to really delete it. */
1979 } else if (row->old != row->new) {
1980 struct json *row_json;
1984 op = json_object_create();
1985 json_object_put_string(op, "op", row->old ? "update" : "insert");
1986 json_object_put_string(op, "table", class->name);
1988 json_object_put(op, "where", where_uuid_equals(&row->uuid));
1990 struct ovsdb_idl_txn_insert *insert;
1994 json_object_put(op, "uuid-name",
1995 json_string_create_nocopy(
1996 uuid_name_from_uuid(&row->uuid)));
1998 insert = xmalloc(sizeof *insert);
1999 insert->dummy = row->uuid;
2000 insert->op_index = operations->u.array.n - 1;
2001 uuid_zero(&insert->real);
2002 hmap_insert(&txn->inserted_rows, &insert->hmap_node,
2003 uuid_hash(&insert->dummy));
2005 row_json = json_object_create();
2006 json_object_put(op, "row", row_json);
2009 BITMAP_FOR_EACH_1 (idx, class->n_columns, row->written) {
2010 const struct ovsdb_idl_column *column =
2011 &class->columns[idx];
2014 || !ovsdb_datum_is_default(&row->new[idx],
2016 json_object_put(row_json, column->name,
2018 ovsdb_datum_to_json(&row->new[idx],
2022 /* If anything really changed, consider it an update.
2023 * We can't suppress not-really-changed values earlier
2024 * or transactions would become nonatomic (see the big
2025 * comment inside ovsdb_idl_txn_write()). */
2026 if (!any_updates && row->old &&
2027 !ovsdb_datum_equals(&row->old[idx], &row->new[idx],
2035 if (!row->old || !shash_is_empty(json_object(row_json))) {
2036 json_array_add(operations, op);
2043 /* Add increment. */
2044 if (txn->inc_table && any_updates) {
2047 txn->inc_index = operations->u.array.n - 1;
2049 op = json_object_create();
2050 json_object_put_string(op, "op", "mutate");
2051 json_object_put_string(op, "table", txn->inc_table);
2052 json_object_put(op, "where",
2053 substitute_uuids(where_uuid_equals(&txn->inc_row),
2055 json_object_put(op, "mutations",
2056 json_array_create_1(
2057 json_array_create_3(
2058 json_string_create(txn->inc_column),
2059 json_string_create("+="),
2060 json_integer_create(1))));
2061 json_array_add(operations, op);
2063 op = json_object_create();
2064 json_object_put_string(op, "op", "select");
2065 json_object_put_string(op, "table", txn->inc_table);
2066 json_object_put(op, "where",
2067 substitute_uuids(where_uuid_equals(&txn->inc_row),
2069 json_object_put(op, "columns",
2070 json_array_create_1(json_string_create(
2072 json_array_add(operations, op);
2075 if (txn->comment.length) {
2076 struct json *op = json_object_create();
2077 json_object_put_string(op, "op", "comment");
2078 json_object_put_string(op, "comment", ds_cstr(&txn->comment));
2079 json_array_add(operations, op);
2083 struct json *op = json_object_create();
2084 json_object_put_string(op, "op", "abort");
2085 json_array_add(operations, op);
2089 txn->status = TXN_UNCHANGED;
2090 json_destroy(operations);
2091 } else if (!jsonrpc_session_send(
2093 jsonrpc_create_request(
2094 "transact", operations, &txn->request_id))) {
2095 hmap_insert(&txn->idl->outstanding_txns, &txn->hmap_node,
2096 json_hash(txn->request_id, 0));
2097 txn->status = TXN_INCOMPLETE;
2099 txn->status = TXN_TRY_AGAIN;
2103 ovsdb_idl_txn_disassemble(txn);
2105 switch (txn->status) {
2106 case TXN_UNCOMMITTED: COVERAGE_INC(txn_uncommitted); break;
2107 case TXN_UNCHANGED: COVERAGE_INC(txn_unchanged); break;
2108 case TXN_INCOMPLETE: COVERAGE_INC(txn_incomplete); break;
2109 case TXN_ABORTED: COVERAGE_INC(txn_aborted); break;
2110 case TXN_SUCCESS: COVERAGE_INC(txn_success); break;
2111 case TXN_TRY_AGAIN: COVERAGE_INC(txn_try_again); break;
2112 case TXN_NOT_LOCKED: COVERAGE_INC(txn_not_locked); break;
2113 case TXN_ERROR: COVERAGE_INC(txn_error); break;
2119 /* Attempts to commit 'txn', blocking until the commit either succeeds or
2120 * fails. Returns the final commit status, which may be any TXN_* value other
2121 * than TXN_INCOMPLETE.
2123 * This function calls ovsdb_idl_run() on 'txn''s IDL, so it may cause the
2124 * return value of ovsdb_idl_get_seqno() to change. */
2125 enum ovsdb_idl_txn_status
2126 ovsdb_idl_txn_commit_block(struct ovsdb_idl_txn *txn)
2128 enum ovsdb_idl_txn_status status;
2131 while ((status = ovsdb_idl_txn_commit(txn)) == TXN_INCOMPLETE) {
2132 ovsdb_idl_run(txn->idl);
2133 ovsdb_idl_wait(txn->idl);
2134 ovsdb_idl_txn_wait(txn);
2140 /* Returns the final (incremented) value of the column in 'txn' that was set to
2141 * be incremented by ovsdb_idl_txn_increment(). 'txn' must have committed
2144 ovsdb_idl_txn_get_increment_new_value(const struct ovsdb_idl_txn *txn)
2146 ovs_assert(txn->status == TXN_SUCCESS);
2147 return txn->inc_new_value;
2150 /* Aborts 'txn' without sending it to the database server. This is effective
2151 * only if ovsdb_idl_txn_commit() has not yet been called for 'txn'.
2152 * Otherwise, it has no effect.
2154 * Aborting a transaction doesn't free its memory. Use
2155 * ovsdb_idl_txn_destroy() to do that. */
2157 ovsdb_idl_txn_abort(struct ovsdb_idl_txn *txn)
2159 ovsdb_idl_txn_disassemble(txn);
2160 if (txn->status == TXN_UNCOMMITTED || txn->status == TXN_INCOMPLETE) {
2161 txn->status = TXN_ABORTED;
2165 /* Returns a string that reports the error status for 'txn'. The caller must
2166 * not modify or free the returned string. A call to ovsdb_idl_txn_destroy()
2167 * for 'txn' may free the returned string.
2169 * The return value is ordinarily one of the strings that
2170 * ovsdb_idl_txn_status_to_string() would return, but if the transaction failed
2171 * due to an error reported by the database server, the return value is that
2174 ovsdb_idl_txn_get_error(const struct ovsdb_idl_txn *txn)
2176 if (txn->status != TXN_ERROR) {
2177 return ovsdb_idl_txn_status_to_string(txn->status);
2178 } else if (txn->error) {
2181 return "no error details available";
2186 ovsdb_idl_txn_set_error_json(struct ovsdb_idl_txn *txn,
2187 const struct json *json)
2189 if (txn->error == NULL) {
2190 txn->error = json_to_string(json, JSSF_SORT);
2194 /* For transaction 'txn' that completed successfully, finds and returns the
2195 * permanent UUID that the database assigned to a newly inserted row, given the
2196 * 'uuid' that ovsdb_idl_txn_insert() assigned locally to that row.
2198 * Returns NULL if 'uuid' is not a UUID assigned by ovsdb_idl_txn_insert() or
2199 * if it was assigned by that function and then deleted by
2200 * ovsdb_idl_txn_delete() within the same transaction. (Rows that are inserted
2201 * and then deleted within a single transaction are never sent to the database
2202 * server, so it never assigns them a permanent UUID.) */
2204 ovsdb_idl_txn_get_insert_uuid(const struct ovsdb_idl_txn *txn,
2205 const struct uuid *uuid)
2207 const struct ovsdb_idl_txn_insert *insert;
2209 ovs_assert(txn->status == TXN_SUCCESS || txn->status == TXN_UNCHANGED);
2210 HMAP_FOR_EACH_IN_BUCKET (insert, hmap_node,
2211 uuid_hash(uuid), &txn->inserted_rows) {
2212 if (uuid_equals(uuid, &insert->dummy)) {
2213 return &insert->real;
2220 ovsdb_idl_txn_complete(struct ovsdb_idl_txn *txn,
2221 enum ovsdb_idl_txn_status status)
2223 txn->status = status;
2224 hmap_remove(&txn->idl->outstanding_txns, &txn->hmap_node);
2227 /* Writes 'datum' to the specified 'column' in 'row_'. Updates both 'row_'
2228 * itself and the structs derived from it (e.g. the "struct ovsrec_*", for
2231 * 'datum' must have the correct type for its column. The IDL does not check
2232 * that it meets schema constraints, but ovsdb-server will do so at commit time
2233 * so it had better be correct.
2235 * A transaction must be in progress. Replication of 'column' must not have
2236 * been disabled (by calling ovsdb_idl_omit()).
2238 * Usually this function is used indirectly through one of the "set" functions
2239 * generated by ovsdb-idlc.
2241 * Takes ownership of what 'datum' points to (and in some cases destroys that
2242 * data before returning) but makes a copy of 'datum' itself. (Commonly
2243 * 'datum' is on the caller's stack.) */
2245 ovsdb_idl_txn_write__(const struct ovsdb_idl_row *row_,
2246 const struct ovsdb_idl_column *column,
2247 struct ovsdb_datum *datum, bool owns_datum)
2249 struct ovsdb_idl_row *row = CONST_CAST(struct ovsdb_idl_row *, row_);
2250 const struct ovsdb_idl_table_class *class;
2254 if (ovsdb_idl_row_is_synthetic(row)) {
2258 class = row->table->class;
2259 column_idx = column - class->columns;
2260 write_only = row->table->modes[column_idx] == OVSDB_IDL_MONITOR;
2262 ovs_assert(row->new != NULL);
2263 ovs_assert(column_idx < class->n_columns);
2264 ovs_assert(row->old == NULL ||
2265 row->table->modes[column_idx] & OVSDB_IDL_MONITOR);
2267 if (row->table->idl->verify_write_only && !write_only) {
2268 VLOG_ERR("Bug: Attempt to write to a read/write column (%s:%s) when"
2269 " explicitly configured not to.", class->name, column->name);
2273 /* If this is a write-only column and the datum being written is the same
2274 * as the one already there, just skip the update entirely. This is worth
2275 * optimizing because we have a lot of columns that get periodically
2276 * refreshed into the database but don't actually change that often.
2278 * We don't do this for read/write columns because that would break
2279 * atomicity of transactions--some other client might have written a
2280 * different value in that column since we read it. (But if a whole
2281 * transaction only does writes of existing values, without making any real
2282 * changes, we will drop the whole transaction later in
2283 * ovsdb_idl_txn_commit().) */
2284 if (write_only && ovsdb_datum_equals(ovsdb_idl_read(row, column),
2285 datum, &column->type)) {
2289 if (hmap_node_is_null(&row->txn_node)) {
2290 hmap_insert(&row->table->idl->txn->txn_rows, &row->txn_node,
2291 uuid_hash(&row->uuid));
2293 if (row->old == row->new) {
2294 row->new = xmalloc(class->n_columns * sizeof *row->new);
2296 if (!row->written) {
2297 row->written = bitmap_allocate(class->n_columns);
2299 if (bitmap_is_set(row->written, column_idx)) {
2300 ovsdb_datum_destroy(&row->new[column_idx], &column->type);
2302 bitmap_set1(row->written, column_idx);
2305 row->new[column_idx] = *datum;
2307 ovsdb_datum_clone(&row->new[column_idx], datum, &column->type);
2309 (column->unparse)(row);
2310 (column->parse)(row, &row->new[column_idx]);
2315 ovsdb_datum_destroy(datum, &column->type);
2320 ovsdb_idl_txn_write(const struct ovsdb_idl_row *row,
2321 const struct ovsdb_idl_column *column,
2322 struct ovsdb_datum *datum)
2324 ovsdb_idl_txn_write__(row, column, datum, true);
2328 ovsdb_idl_txn_write_clone(const struct ovsdb_idl_row *row,
2329 const struct ovsdb_idl_column *column,
2330 const struct ovsdb_datum *datum)
2332 ovsdb_idl_txn_write__(row, column,
2333 CONST_CAST(struct ovsdb_datum *, datum), false);
2336 /* Causes the original contents of 'column' in 'row_' to be verified as a
2337 * prerequisite to completing the transaction. That is, if 'column' in 'row_'
2338 * changed (or if 'row_' was deleted) between the time that the IDL originally
2339 * read its contents and the time that the transaction commits, then the
2340 * transaction aborts and ovsdb_idl_txn_commit() returns TXN_AGAIN_WAIT or
2341 * TXN_AGAIN_NOW (depending on whether the database change has already been
2344 * The intention is that, to ensure that no transaction commits based on dirty
2345 * reads, an application should call ovsdb_idl_txn_verify() on each data item
2346 * read as part of a read-modify-write operation.
2348 * In some cases ovsdb_idl_txn_verify() reduces to a no-op, because the current
2349 * value of 'column' is already known:
2351 * - If 'row_' is a row created by the current transaction (returned by
2352 * ovsdb_idl_txn_insert()).
2354 * - If 'column' has already been modified (with ovsdb_idl_txn_write())
2355 * within the current transaction.
2357 * Because of the latter property, always call ovsdb_idl_txn_verify() *before*
2358 * ovsdb_idl_txn_write() for a given read-modify-write.
2360 * A transaction must be in progress.
2362 * Usually this function is used indirectly through one of the "verify"
2363 * functions generated by ovsdb-idlc. */
2365 ovsdb_idl_txn_verify(const struct ovsdb_idl_row *row_,
2366 const struct ovsdb_idl_column *column)
2368 struct ovsdb_idl_row *row = CONST_CAST(struct ovsdb_idl_row *, row_);
2369 const struct ovsdb_idl_table_class *class;
2372 if (ovsdb_idl_row_is_synthetic(row)) {
2376 class = row->table->class;
2377 column_idx = column - class->columns;
2379 ovs_assert(row->new != NULL);
2380 ovs_assert(row->old == NULL ||
2381 row->table->modes[column_idx] & OVSDB_IDL_MONITOR);
2383 || (row->written && bitmap_is_set(row->written, column_idx))) {
2387 if (hmap_node_is_null(&row->txn_node)) {
2388 hmap_insert(&row->table->idl->txn->txn_rows, &row->txn_node,
2389 uuid_hash(&row->uuid));
2391 if (!row->prereqs) {
2392 row->prereqs = bitmap_allocate(class->n_columns);
2394 bitmap_set1(row->prereqs, column_idx);
2397 /* Deletes 'row_' from its table. May free 'row_', so it must not be
2398 * accessed afterward.
2400 * A transaction must be in progress.
2402 * Usually this function is used indirectly through one of the "delete"
2403 * functions generated by ovsdb-idlc. */
2405 ovsdb_idl_txn_delete(const struct ovsdb_idl_row *row_)
2407 struct ovsdb_idl_row *row = CONST_CAST(struct ovsdb_idl_row *, row_);
2409 if (ovsdb_idl_row_is_synthetic(row)) {
2413 ovs_assert(row->new != NULL);
2415 ovsdb_idl_row_unparse(row);
2416 ovsdb_idl_row_clear_new(row);
2417 ovs_assert(!row->prereqs);
2418 hmap_remove(&row->table->rows, &row->hmap_node);
2419 hmap_remove(&row->table->idl->txn->txn_rows, &row->txn_node);
2423 if (hmap_node_is_null(&row->txn_node)) {
2424 hmap_insert(&row->table->idl->txn->txn_rows, &row->txn_node,
2425 uuid_hash(&row->uuid));
2427 ovsdb_idl_row_clear_new(row);
2431 /* Inserts and returns a new row in the table with the specified 'class' in the
2432 * database with open transaction 'txn'.
2434 * The new row is assigned a provisional UUID. If 'uuid' is null then one is
2435 * randomly generated; otherwise 'uuid' should specify a randomly generated
2436 * UUID not otherwise in use. ovsdb-server will assign a different UUID when
2437 * 'txn' is committed, but the IDL will replace any uses of the provisional
2438 * UUID in the data to be to be committed by the UUID assigned by
2441 * Usually this function is used indirectly through one of the "insert"
2442 * functions generated by ovsdb-idlc. */
2443 const struct ovsdb_idl_row *
2444 ovsdb_idl_txn_insert(struct ovsdb_idl_txn *txn,
2445 const struct ovsdb_idl_table_class *class,
2446 const struct uuid *uuid)
2448 struct ovsdb_idl_row *row = ovsdb_idl_row_create__(class);
2451 ovs_assert(!ovsdb_idl_txn_get_row(txn, uuid));
2454 uuid_generate(&row->uuid);
2457 row->table = ovsdb_idl_table_from_class(txn->idl, class);
2458 row->new = xmalloc(class->n_columns * sizeof *row->new);
2459 hmap_insert(&row->table->rows, &row->hmap_node, uuid_hash(&row->uuid));
2460 hmap_insert(&txn->txn_rows, &row->txn_node, uuid_hash(&row->uuid));
2465 ovsdb_idl_txn_abort_all(struct ovsdb_idl *idl)
2467 struct ovsdb_idl_txn *txn;
2469 HMAP_FOR_EACH (txn, hmap_node, &idl->outstanding_txns) {
2470 ovsdb_idl_txn_complete(txn, TXN_TRY_AGAIN);
2474 static struct ovsdb_idl_txn *
2475 ovsdb_idl_txn_find(struct ovsdb_idl *idl, const struct json *id)
2477 struct ovsdb_idl_txn *txn;
2479 HMAP_FOR_EACH_WITH_HASH (txn, hmap_node,
2480 json_hash(id, 0), &idl->outstanding_txns) {
2481 if (json_equal(id, txn->request_id)) {
2489 check_json_type(const struct json *json, enum json_type type, const char *name)
2492 VLOG_WARN_RL(&syntax_rl, "%s is missing", name);
2494 } else if (json->type != type) {
2495 VLOG_WARN_RL(&syntax_rl, "%s is %s instead of %s",
2496 name, json_type_to_string(json->type),
2497 json_type_to_string(type));
2505 ovsdb_idl_txn_process_inc_reply(struct ovsdb_idl_txn *txn,
2506 const struct json_array *results)
2508 struct json *count, *rows, *row, *column;
2509 struct shash *mutate, *select;
2511 if (txn->inc_index + 2 > results->n) {
2512 VLOG_WARN_RL(&syntax_rl, "reply does not contain enough operations "
2513 "for increment (has %"PRIuSIZE", needs %u)",
2514 results->n, txn->inc_index + 2);
2518 /* We know that this is a JSON object because the loop in
2519 * ovsdb_idl_txn_process_reply() checked. */
2520 mutate = json_object(results->elems[txn->inc_index]);
2521 count = shash_find_data(mutate, "count");
2522 if (!check_json_type(count, JSON_INTEGER, "\"mutate\" reply \"count\"")) {
2525 if (count->u.integer != 1) {
2526 VLOG_WARN_RL(&syntax_rl,
2527 "\"mutate\" reply \"count\" is %lld instead of 1",
2532 select = json_object(results->elems[txn->inc_index + 1]);
2533 rows = shash_find_data(select, "rows");
2534 if (!check_json_type(rows, JSON_ARRAY, "\"select\" reply \"rows\"")) {
2537 if (rows->u.array.n != 1) {
2538 VLOG_WARN_RL(&syntax_rl, "\"select\" reply \"rows\" has %"PRIuSIZE" elements "
2543 row = rows->u.array.elems[0];
2544 if (!check_json_type(row, JSON_OBJECT, "\"select\" reply row")) {
2547 column = shash_find_data(json_object(row), txn->inc_column);
2548 if (!check_json_type(column, JSON_INTEGER,
2549 "\"select\" reply inc column")) {
2552 txn->inc_new_value = column->u.integer;
2557 ovsdb_idl_txn_process_insert_reply(struct ovsdb_idl_txn_insert *insert,
2558 const struct json_array *results)
2560 static const struct ovsdb_base_type uuid_type = OVSDB_BASE_UUID_INIT;
2561 struct ovsdb_error *error;
2562 struct json *json_uuid;
2563 union ovsdb_atom uuid;
2564 struct shash *reply;
2566 if (insert->op_index >= results->n) {
2567 VLOG_WARN_RL(&syntax_rl, "reply does not contain enough operations "
2568 "for insert (has %"PRIuSIZE", needs %u)",
2569 results->n, insert->op_index);
2573 /* We know that this is a JSON object because the loop in
2574 * ovsdb_idl_txn_process_reply() checked. */
2575 reply = json_object(results->elems[insert->op_index]);
2576 json_uuid = shash_find_data(reply, "uuid");
2577 if (!check_json_type(json_uuid, JSON_ARRAY, "\"insert\" reply \"uuid\"")) {
2581 error = ovsdb_atom_from_json(&uuid, &uuid_type, json_uuid, NULL);
2583 char *s = ovsdb_error_to_string(error);
2584 VLOG_WARN_RL(&syntax_rl, "\"insert\" reply \"uuid\" is not a JSON "
2587 ovsdb_error_destroy(error);
2591 insert->real = uuid.uuid;
2597 ovsdb_idl_txn_process_reply(struct ovsdb_idl *idl,
2598 const struct jsonrpc_msg *msg)
2600 struct ovsdb_idl_txn *txn;
2601 enum ovsdb_idl_txn_status status;
2603 txn = ovsdb_idl_txn_find(idl, msg->id);
2608 if (msg->type == JSONRPC_ERROR) {
2610 } else if (msg->result->type != JSON_ARRAY) {
2611 VLOG_WARN_RL(&syntax_rl, "reply to \"transact\" is not JSON array");
2614 struct json_array *ops = &msg->result->u.array;
2615 int hard_errors = 0;
2616 int soft_errors = 0;
2617 int lock_errors = 0;
2620 for (i = 0; i < ops->n; i++) {
2621 struct json *op = ops->elems[i];
2623 if (op->type == JSON_NULL) {
2624 /* This isn't an error in itself but indicates that some prior
2625 * operation failed, so make sure that we know about it. */
2627 } else if (op->type == JSON_OBJECT) {
2630 error = shash_find_data(json_object(op), "error");
2632 if (error->type == JSON_STRING) {
2633 if (!strcmp(error->u.string, "timed out")) {
2635 } else if (!strcmp(error->u.string, "not owner")) {
2637 } else if (strcmp(error->u.string, "aborted")) {
2639 ovsdb_idl_txn_set_error_json(txn, op);
2643 ovsdb_idl_txn_set_error_json(txn, op);
2644 VLOG_WARN_RL(&syntax_rl,
2645 "\"error\" in reply is not JSON string");
2650 ovsdb_idl_txn_set_error_json(txn, op);
2651 VLOG_WARN_RL(&syntax_rl,
2652 "operation reply is not JSON null or object");
2656 if (!soft_errors && !hard_errors && !lock_errors) {
2657 struct ovsdb_idl_txn_insert *insert;
2659 if (txn->inc_table && !ovsdb_idl_txn_process_inc_reply(txn, ops)) {
2663 HMAP_FOR_EACH (insert, hmap_node, &txn->inserted_rows) {
2664 if (!ovsdb_idl_txn_process_insert_reply(insert, ops)) {
2670 status = (hard_errors ? TXN_ERROR
2671 : lock_errors ? TXN_NOT_LOCKED
2672 : soft_errors ? TXN_TRY_AGAIN
2676 ovsdb_idl_txn_complete(txn, status);
2680 /* Returns the transaction currently active for 'row''s IDL. A transaction
2681 * must currently be active. */
2682 struct ovsdb_idl_txn *
2683 ovsdb_idl_txn_get(const struct ovsdb_idl_row *row)
2685 struct ovsdb_idl_txn *txn = row->table->idl->txn;
2686 ovs_assert(txn != NULL);
2690 /* Returns the IDL on which 'txn' acts. */
2692 ovsdb_idl_txn_get_idl (struct ovsdb_idl_txn *txn)
2697 /* Blocks until 'idl' successfully connects to the remote database and
2698 * retrieves its contents. */
2700 ovsdb_idl_get_initial_snapshot(struct ovsdb_idl *idl)
2704 if (ovsdb_idl_has_ever_connected(idl)) {
2707 ovsdb_idl_wait(idl);
2712 /* If 'lock_name' is nonnull, configures 'idl' to obtain the named lock from
2713 * the database server and to avoid modifying the database when the lock cannot
2714 * be acquired (that is, when another client has the same lock).
2716 * If 'lock_name' is NULL, drops the locking requirement and releases the
2719 ovsdb_idl_set_lock(struct ovsdb_idl *idl, const char *lock_name)
2721 ovs_assert(!idl->txn);
2722 ovs_assert(hmap_is_empty(&idl->outstanding_txns));
2724 if (idl->lock_name && (!lock_name || strcmp(lock_name, idl->lock_name))) {
2725 /* Release previous lock. */
2726 ovsdb_idl_send_unlock_request(idl);
2727 free(idl->lock_name);
2728 idl->lock_name = NULL;
2729 idl->is_lock_contended = false;
2732 if (lock_name && !idl->lock_name) {
2733 /* Acquire new lock. */
2734 idl->lock_name = xstrdup(lock_name);
2735 ovsdb_idl_send_lock_request(idl);
2739 /* Returns true if 'idl' is configured to obtain a lock and owns that lock.
2741 * Locking and unlocking happens asynchronously from the database client's
2742 * point of view, so the information is only useful for optimization (e.g. if
2743 * the client doesn't have the lock then there's no point in trying to write to
2746 ovsdb_idl_has_lock(const struct ovsdb_idl *idl)
2748 return idl->has_lock;
2751 /* Returns true if 'idl' is configured to obtain a lock but the database server
2752 * has indicated that some other client already owns the requested lock. */
2754 ovsdb_idl_is_lock_contended(const struct ovsdb_idl *idl)
2756 return idl->is_lock_contended;
2760 ovsdb_idl_update_has_lock(struct ovsdb_idl *idl, bool new_has_lock)
2762 if (new_has_lock && !idl->has_lock) {
2763 if (idl->state == IDL_S_MONITORING) {
2764 idl->change_seqno++;
2766 /* We're setting up a session, so don't signal that the database
2767 * changed. Finalizing the session will increment change_seqno
2770 idl->is_lock_contended = false;
2772 idl->has_lock = new_has_lock;
2776 ovsdb_idl_send_lock_request__(struct ovsdb_idl *idl, const char *method,
2779 ovsdb_idl_update_has_lock(idl, false);
2781 json_destroy(idl->lock_request_id);
2782 idl->lock_request_id = NULL;
2784 if (jsonrpc_session_is_connected(idl->session)) {
2785 struct json *params;
2787 params = json_array_create_1(json_string_create(idl->lock_name));
2788 jsonrpc_session_send(idl->session,
2789 jsonrpc_create_request(method, params, idp));
2794 ovsdb_idl_send_lock_request(struct ovsdb_idl *idl)
2796 ovsdb_idl_send_lock_request__(idl, "lock", &idl->lock_request_id);
2800 ovsdb_idl_send_unlock_request(struct ovsdb_idl *idl)
2802 ovsdb_idl_send_lock_request__(idl, "unlock", NULL);
2806 ovsdb_idl_parse_lock_reply(struct ovsdb_idl *idl, const struct json *result)
2810 json_destroy(idl->lock_request_id);
2811 idl->lock_request_id = NULL;
2813 if (result->type == JSON_OBJECT) {
2814 const struct json *locked;
2816 locked = shash_find_data(json_object(result), "locked");
2817 got_lock = locked && locked->type == JSON_TRUE;
2822 ovsdb_idl_update_has_lock(idl, got_lock);
2824 idl->is_lock_contended = true;
2829 ovsdb_idl_parse_lock_notify(struct ovsdb_idl *idl,
2830 const struct json *params,
2834 && params->type == JSON_ARRAY
2835 && json_array(params)->n > 0
2836 && json_array(params)->elems[0]->type == JSON_STRING) {
2837 const char *lock_name = json_string(json_array(params)->elems[0]);
2839 if (!strcmp(idl->lock_name, lock_name)) {
2840 ovsdb_idl_update_has_lock(idl, new_has_lock);
2841 if (!new_has_lock) {
2842 idl->is_lock_contended = true;
2849 ovsdb_idl_loop_destroy(struct ovsdb_idl_loop *loop)
2852 ovsdb_idl_destroy(loop->idl);
2856 struct ovsdb_idl_txn *
2857 ovsdb_idl_loop_run(struct ovsdb_idl_loop *loop)
2859 ovsdb_idl_run(loop->idl);
2860 loop->open_txn = (loop->committing_txn
2861 || ovsdb_idl_get_seqno(loop->idl) == loop->skip_seqno
2863 : ovsdb_idl_txn_create(loop->idl));
2864 return loop->open_txn;
2868 ovsdb_idl_loop_commit_and_wait(struct ovsdb_idl_loop *loop)
2870 if (loop->open_txn) {
2871 loop->committing_txn = loop->open_txn;
2872 loop->open_txn = NULL;
2874 loop->precommit_seqno = ovsdb_idl_get_seqno(loop->idl);
2877 struct ovsdb_idl_txn *txn = loop->committing_txn;
2879 enum ovsdb_idl_txn_status status = ovsdb_idl_txn_commit(txn);
2880 if (status != TXN_INCOMPLETE) {
2883 /* We want to re-evaluate the database when it's changed from
2884 * the contents that it had when we started the commit. (That
2885 * might have already happened.) */
2886 loop->skip_seqno = loop->precommit_seqno;
2887 if (ovsdb_idl_get_seqno(loop->idl) != loop->skip_seqno) {
2888 poll_immediate_wake();
2893 /* If the database has already changed since we started the
2894 * commit, re-evaluate it immediately to avoid missing a change
2896 if (ovsdb_idl_get_seqno(loop->idl) != loop->precommit_seqno) {
2897 poll_immediate_wake();
2903 case TXN_NOT_LOCKED:
2907 case TXN_UNCOMMITTED:
2908 case TXN_INCOMPLETE:
2912 ovsdb_idl_txn_destroy(txn);
2913 loop->committing_txn = NULL;
2917 ovsdb_idl_wait(loop->idl);