1 /* Copyright (c) 2009, 2010, 2011 Nicira Networks.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
18 #include "ovsdb-idl.h"
27 #include "dynamic-string.h"
28 #include "fatal-signal.h"
31 #include "ovsdb-data.h"
32 #include "ovsdb-error.h"
33 #include "ovsdb-idl-provider.h"
34 #include "poll-loop.h"
39 VLOG_DEFINE_THIS_MODULE(ovsdb_idl
);
41 /* An arc from one idl_row to another. When row A contains a UUID that
42 * references row B, this is represented by an arc from A (the source) to B
45 * Arcs from a row to itself are omitted, that is, src and dst are always
48 * Arcs are never duplicated, that is, even if there are multiple references
49 * from A to B, there is only a single arc from A to B.
51 * Arcs are directed: an arc from A to B is the converse of an an arc from B to
52 * A. Both an arc and its converse may both be present, if each row refers
53 * to the other circularly.
55 * The source and destination row may be in the same table or in different
58 struct ovsdb_idl_arc
{
59 struct list src_node
; /* In src->src_arcs list. */
60 struct list dst_node
; /* In dst->dst_arcs list. */
61 struct ovsdb_idl_row
*src
; /* Source row. */
62 struct ovsdb_idl_row
*dst
; /* Destination row. */
66 const struct ovsdb_idl_class
*class;
67 struct jsonrpc_session
*session
;
68 struct shash table_by_name
;
69 struct ovsdb_idl_table
*tables
; /* Contains "struct ovsdb_idl_table *"s.*/
70 struct json
*monitor_request_id
;
71 unsigned int last_monitor_request_seqno
;
72 unsigned int change_seqno
;
74 /* Transaction support. */
75 struct ovsdb_idl_txn
*txn
;
76 struct hmap outstanding_txns
;
79 struct ovsdb_idl_txn
{
80 struct hmap_node hmap_node
;
81 struct json
*request_id
;
82 struct ovsdb_idl
*idl
;
84 enum ovsdb_idl_txn_status status
;
92 struct json
*inc_where
;
93 unsigned int inc_index
;
94 int64_t inc_new_value
;
97 struct hmap inserted_rows
;
100 struct ovsdb_idl_txn_insert
{
101 struct hmap_node hmap_node
; /* In struct ovsdb_idl_txn's inserted_rows. */
102 struct uuid dummy
; /* Dummy UUID used locally. */
103 int op_index
; /* Index into transaction's operation array. */
104 struct uuid real
; /* Real UUID used by database server. */
107 static struct vlog_rate_limit syntax_rl
= VLOG_RATE_LIMIT_INIT(1, 5);
108 static struct vlog_rate_limit semantic_rl
= VLOG_RATE_LIMIT_INIT(1, 5);
110 static void ovsdb_idl_clear(struct ovsdb_idl
*);
111 static void ovsdb_idl_send_monitor_request(struct ovsdb_idl
*);
112 static void ovsdb_idl_parse_update(struct ovsdb_idl
*, const struct json
*);
113 static struct ovsdb_error
*ovsdb_idl_parse_update__(struct ovsdb_idl
*,
114 const struct json
*);
115 static bool ovsdb_idl_process_update(struct ovsdb_idl_table
*,
117 const struct json
*old
,
118 const struct json
*new);
119 static void ovsdb_idl_insert_row(struct ovsdb_idl_row
*, const struct json
*);
120 static void ovsdb_idl_delete_row(struct ovsdb_idl_row
*);
121 static bool ovsdb_idl_modify_row(struct ovsdb_idl_row
*, const struct json
*);
123 static bool ovsdb_idl_row_is_orphan(const struct ovsdb_idl_row
*);
124 static struct ovsdb_idl_row
*ovsdb_idl_row_create__(
125 const struct ovsdb_idl_table_class
*);
126 static struct ovsdb_idl_row
*ovsdb_idl_row_create(struct ovsdb_idl_table
*,
127 const struct uuid
*);
128 static void ovsdb_idl_row_destroy(struct ovsdb_idl_row
*);
130 static void ovsdb_idl_row_parse(struct ovsdb_idl_row
*);
131 static void ovsdb_idl_row_unparse(struct ovsdb_idl_row
*);
132 static void ovsdb_idl_row_clear_old(struct ovsdb_idl_row
*);
133 static void ovsdb_idl_row_clear_new(struct ovsdb_idl_row
*);
135 static void ovsdb_idl_txn_abort_all(struct ovsdb_idl
*);
136 static bool ovsdb_idl_txn_process_reply(struct ovsdb_idl
*,
137 const struct jsonrpc_msg
*msg
);
139 /* Creates and returns a connection to database 'remote', which should be in a
140 * form acceptable to jsonrpc_session_open(). The connection will maintain an
141 * in-memory replica of the remote database whose schema is described by
142 * 'class'. (Ordinarily 'class' is compiled from an OVSDB schema automatically
145 * If 'monitor_everything_by_default' is true, then everything in the remote
146 * database will be replicated by default. ovsdb_idl_omit() and
147 * ovsdb_idl_omit_alert() may be used to selectively drop some columns from
150 * If 'monitor_everything_by_default' is false, then no columns or tables will
151 * be replicated by default. ovsdb_idl_add_column() and ovsdb_idl_add_table()
152 * must be used to choose some columns or tables to replicate.
155 ovsdb_idl_create(const char *remote
, const struct ovsdb_idl_class
*class,
156 bool monitor_everything_by_default
)
158 struct ovsdb_idl
*idl
;
159 uint8_t default_mode
;
162 default_mode
= (monitor_everything_by_default
163 ? OVSDB_IDL_MONITOR
| OVSDB_IDL_ALERT
166 idl
= xzalloc(sizeof *idl
);
168 idl
->session
= jsonrpc_session_open(remote
);
169 shash_init(&idl
->table_by_name
);
170 idl
->tables
= xmalloc(class->n_tables
* sizeof *idl
->tables
);
171 for (i
= 0; i
< class->n_tables
; i
++) {
172 const struct ovsdb_idl_table_class
*tc
= &class->tables
[i
];
173 struct ovsdb_idl_table
*table
= &idl
->tables
[i
];
176 shash_add_assert(&idl
->table_by_name
, tc
->name
, table
);
178 table
->modes
= xmalloc(tc
->n_columns
);
179 memset(table
->modes
, default_mode
, tc
->n_columns
);
180 table
->need_table
= false;
181 shash_init(&table
->columns
);
182 for (j
= 0; j
< tc
->n_columns
; j
++) {
183 const struct ovsdb_idl_column
*column
= &tc
->columns
[j
];
185 shash_add_assert(&table
->columns
, column
->name
, column
);
187 hmap_init(&table
->rows
);
190 idl
->last_monitor_request_seqno
= UINT_MAX
;
191 hmap_init(&idl
->outstanding_txns
);
196 /* Destroys 'idl' and all of the data structures that it manages. */
198 ovsdb_idl_destroy(struct ovsdb_idl
*idl
)
204 ovsdb_idl_clear(idl
);
205 jsonrpc_session_close(idl
->session
);
207 for (i
= 0; i
< idl
->class->n_tables
; i
++) {
208 struct ovsdb_idl_table
*table
= &idl
->tables
[i
];
209 shash_destroy(&table
->columns
);
210 hmap_destroy(&table
->rows
);
213 shash_destroy(&idl
->table_by_name
);
215 json_destroy(idl
->monitor_request_id
);
221 ovsdb_idl_clear(struct ovsdb_idl
*idl
)
223 bool changed
= false;
226 for (i
= 0; i
< idl
->class->n_tables
; i
++) {
227 struct ovsdb_idl_table
*table
= &idl
->tables
[i
];
228 struct ovsdb_idl_row
*row
, *next_row
;
230 if (hmap_is_empty(&table
->rows
)) {
235 HMAP_FOR_EACH_SAFE (row
, next_row
, hmap_node
, &table
->rows
) {
236 struct ovsdb_idl_arc
*arc
, *next_arc
;
238 if (!ovsdb_idl_row_is_orphan(row
)) {
239 ovsdb_idl_row_unparse(row
);
241 LIST_FOR_EACH_SAFE (arc
, next_arc
, src_node
, &row
->src_arcs
) {
244 /* No need to do anything with dst_arcs: some node has those arcs
245 * as forward arcs and will destroy them itself. */
247 ovsdb_idl_row_destroy(row
);
256 /* Processes a batch of messages from the database server on 'idl'. Returns
257 * true if the database as seen through 'idl' changed, false if it did not
258 * change. The initial fetch of the entire contents of the remote database is
259 * considered to be one kind of change.
261 * When this function returns false, the client may continue to use any data
262 * structures it obtained from 'idl' in the past. But when it returns true,
263 * the client must not access any of these data structures again, because they
264 * could have freed or reused for other purposes.
266 * This function can return occasional false positives, that is, report that
267 * the database changed even though it didn't. This happens if the connection
268 * to the database drops and reconnects, which causes the database contents to
269 * be reloaded even if they didn't change. (It could also happen if the
270 * database server sends out a "change" that reflects what we already thought
271 * was in the database, but the database server is not supposed to do that.)
273 * As an alternative to checking the return value, the client may check for
274 * changes in the value returned by ovsdb_idl_get_seqno().
277 ovsdb_idl_run(struct ovsdb_idl
*idl
)
279 unsigned int initial_change_seqno
= idl
->change_seqno
;
283 jsonrpc_session_run(idl
->session
);
284 for (i
= 0; jsonrpc_session_is_connected(idl
->session
) && i
< 50; i
++) {
285 struct jsonrpc_msg
*msg
;
288 seqno
= jsonrpc_session_get_seqno(idl
->session
);
289 if (idl
->last_monitor_request_seqno
!= seqno
) {
290 idl
->last_monitor_request_seqno
= seqno
;
291 ovsdb_idl_txn_abort_all(idl
);
292 ovsdb_idl_send_monitor_request(idl
);
296 msg
= jsonrpc_session_recv(idl
->session
);
301 if (msg
->type
== JSONRPC_NOTIFY
302 && !strcmp(msg
->method
, "update")
303 && msg
->params
->type
== JSON_ARRAY
304 && msg
->params
->u
.array
.n
== 2
305 && msg
->params
->u
.array
.elems
[0]->type
== JSON_NULL
) {
306 ovsdb_idl_parse_update(idl
, msg
->params
->u
.array
.elems
[1]);
307 } else if (msg
->type
== JSONRPC_REPLY
308 && idl
->monitor_request_id
309 && json_equal(idl
->monitor_request_id
, msg
->id
)) {
311 json_destroy(idl
->monitor_request_id
);
312 idl
->monitor_request_id
= NULL
;
313 ovsdb_idl_clear(idl
);
314 ovsdb_idl_parse_update(idl
, msg
->result
);
315 } else if (msg
->type
== JSONRPC_REPLY
&& msg
->id
->type
== JSON_STRING
316 && !strcmp(msg
->id
->u
.string
, "echo")) {
317 /* It's a reply to our echo request. Ignore it. */
318 } else if ((msg
->type
== JSONRPC_ERROR
319 || msg
->type
== JSONRPC_REPLY
)
320 && ovsdb_idl_txn_process_reply(idl
, msg
)) {
321 /* ovsdb_idl_txn_process_reply() did everything needful. */
323 /* This can happen if ovsdb_idl_txn_destroy() is called to destroy
324 * a transaction before we receive the reply, so keep the log level
326 VLOG_DBG("%s: received unexpected %s message",
327 jsonrpc_session_get_name(idl
->session
),
328 jsonrpc_msg_type_to_string(msg
->type
));
330 jsonrpc_msg_destroy(msg
);
333 return initial_change_seqno
!= idl
->change_seqno
;
336 /* Arranges for poll_block() to wake up when ovsdb_idl_run() has something to
337 * do or when activity occurs on a transaction on 'idl'. */
339 ovsdb_idl_wait(struct ovsdb_idl
*idl
)
341 jsonrpc_session_wait(idl
->session
);
342 jsonrpc_session_recv_wait(idl
->session
);
345 /* Returns a number that represents the state of 'idl'. When 'idl' is updated
346 * (by ovsdb_idl_run()), the return value changes. */
348 ovsdb_idl_get_seqno(const struct ovsdb_idl
*idl
)
350 return idl
->change_seqno
;
353 /* Returns true if 'idl' successfully connected to the remote database and
354 * retrieved its contents (even if the connection subsequently dropped and is
355 * in the process of reconnecting). If so, then 'idl' contains an atomic
356 * snapshot of the database's contents (but it might be arbitrarily old if the
357 * connection dropped).
359 * Returns false if 'idl' has never connected or retrieved the database's
360 * contents. If so, 'idl' is empty. */
362 ovsdb_idl_has_ever_connected(const struct ovsdb_idl
*idl
)
364 return ovsdb_idl_get_seqno(idl
) != 0;
367 /* Forces 'idl' to drop its connection to the database and reconnect. In the
368 * meantime, the contents of 'idl' will not change. */
370 ovsdb_idl_force_reconnect(struct ovsdb_idl
*idl
)
372 jsonrpc_session_force_reconnect(idl
->session
);
375 static unsigned char *
376 ovsdb_idl_get_mode(struct ovsdb_idl
*idl
,
377 const struct ovsdb_idl_column
*column
)
381 assert(!idl
->change_seqno
);
383 for (i
= 0; i
< idl
->class->n_tables
; i
++) {
384 const struct ovsdb_idl_table
*table
= &idl
->tables
[i
];
385 const struct ovsdb_idl_table_class
*tc
= table
->class;
387 if (column
>= tc
->columns
&& column
< &tc
->columns
[tc
->n_columns
]) {
388 return &table
->modes
[column
- tc
->columns
];
396 add_ref_table(struct ovsdb_idl
*idl
, const struct ovsdb_base_type
*base
)
398 if (base
->type
== OVSDB_TYPE_UUID
&& base
->u
.uuid
.refTableName
) {
399 struct ovsdb_idl_table
*table
;
401 table
= shash_find_data(&idl
->table_by_name
,
402 base
->u
.uuid
.refTableName
);
404 table
->need_table
= true;
406 VLOG_WARN("%s IDL class missing referenced table %s",
407 idl
->class->database
, base
->u
.uuid
.refTableName
);
412 /* Turns on OVSDB_IDL_MONITOR and OVSDB_IDL_ALERT for 'column' in 'idl'. Also
413 * ensures that any tables referenced by 'column' will be replicated, even if
414 * no columns in that table are selected for replication (see
415 * ovsdb_idl_add_table() for more information).
417 * This function is only useful if 'monitor_everything_by_default' was false in
418 * the call to ovsdb_idl_create(). This function should be called between
419 * ovsdb_idl_create() and the first call to ovsdb_idl_run().
422 ovsdb_idl_add_column(struct ovsdb_idl
*idl
,
423 const struct ovsdb_idl_column
*column
)
425 *ovsdb_idl_get_mode(idl
, column
) = OVSDB_IDL_MONITOR
| OVSDB_IDL_ALERT
;
426 add_ref_table(idl
, &column
->type
.key
);
427 add_ref_table(idl
, &column
->type
.value
);
430 /* Ensures that the table with class 'tc' will be replicated on 'idl' even if
431 * no columns are selected for replication. This can be useful because it
432 * allows 'idl' to keep track of what rows in the table actually exist, which
433 * in turn allows columns that reference the table to have accurate contents.
434 * (The IDL presents the database with references to rows that do not exist
437 * This function is only useful if 'monitor_everything_by_default' was false in
438 * the call to ovsdb_idl_create(). This function should be called between
439 * ovsdb_idl_create() and the first call to ovsdb_idl_run().
442 ovsdb_idl_add_table(struct ovsdb_idl
*idl
,
443 const struct ovsdb_idl_table_class
*tc
)
447 for (i
= 0; i
< idl
->class->n_tables
; i
++) {
448 struct ovsdb_idl_table
*table
= &idl
->tables
[i
];
450 if (table
->class == tc
) {
451 table
->need_table
= true;
459 /* Turns off OVSDB_IDL_ALERT for 'column' in 'idl'.
461 * This function should be called between ovsdb_idl_create() and the first call
462 * to ovsdb_idl_run().
465 ovsdb_idl_omit_alert(struct ovsdb_idl
*idl
,
466 const struct ovsdb_idl_column
*column
)
468 *ovsdb_idl_get_mode(idl
, column
) &= ~OVSDB_IDL_ALERT
;
471 /* Sets the mode for 'column' in 'idl' to 0. See the big comment above
472 * OVSDB_IDL_MONITOR for details.
474 * This function should be called between ovsdb_idl_create() and the first call
475 * to ovsdb_idl_run().
478 ovsdb_idl_omit(struct ovsdb_idl
*idl
, const struct ovsdb_idl_column
*column
)
480 *ovsdb_idl_get_mode(idl
, column
) = 0;
484 ovsdb_idl_send_monitor_request(struct ovsdb_idl
*idl
)
486 struct json
*monitor_requests
;
487 struct jsonrpc_msg
*msg
;
490 monitor_requests
= json_object_create();
491 for (i
= 0; i
< idl
->class->n_tables
; i
++) {
492 const struct ovsdb_idl_table
*table
= &idl
->tables
[i
];
493 const struct ovsdb_idl_table_class
*tc
= table
->class;
494 struct json
*monitor_request
, *columns
;
497 columns
= table
->need_table
? json_array_create_empty() : NULL
;
498 for (j
= 0; j
< tc
->n_columns
; j
++) {
499 const struct ovsdb_idl_column
*column
= &tc
->columns
[j
];
500 if (table
->modes
[j
] & OVSDB_IDL_MONITOR
) {
502 columns
= json_array_create_empty();
504 json_array_add(columns
, json_string_create(column
->name
));
509 monitor_request
= json_object_create();
510 json_object_put(monitor_request
, "columns", columns
);
511 json_object_put(monitor_requests
, tc
->name
, monitor_request
);
515 json_destroy(idl
->monitor_request_id
);
516 msg
= jsonrpc_create_request(
518 json_array_create_3(json_string_create(idl
->class->database
),
519 json_null_create(), monitor_requests
),
520 &idl
->monitor_request_id
);
521 jsonrpc_session_send(idl
->session
, msg
);
525 ovsdb_idl_parse_update(struct ovsdb_idl
*idl
, const struct json
*table_updates
)
527 struct ovsdb_error
*error
= ovsdb_idl_parse_update__(idl
, table_updates
);
529 if (!VLOG_DROP_WARN(&syntax_rl
)) {
530 char *s
= ovsdb_error_to_string(error
);
531 VLOG_WARN_RL(&syntax_rl
, "%s", s
);
534 ovsdb_error_destroy(error
);
538 static struct ovsdb_error
*
539 ovsdb_idl_parse_update__(struct ovsdb_idl
*idl
,
540 const struct json
*table_updates
)
542 const struct shash_node
*tables_node
;
544 if (table_updates
->type
!= JSON_OBJECT
) {
545 return ovsdb_syntax_error(table_updates
, NULL
,
546 "<table-updates> is not an object");
548 SHASH_FOR_EACH (tables_node
, json_object(table_updates
)) {
549 const struct json
*table_update
= tables_node
->data
;
550 const struct shash_node
*table_node
;
551 struct ovsdb_idl_table
*table
;
553 table
= shash_find_data(&idl
->table_by_name
, tables_node
->name
);
555 return ovsdb_syntax_error(
557 "<table-updates> includes unknown table \"%s\"",
561 if (table_update
->type
!= JSON_OBJECT
) {
562 return ovsdb_syntax_error(table_update
, NULL
,
563 "<table-update> for table \"%s\" is "
564 "not an object", table
->class->name
);
566 SHASH_FOR_EACH (table_node
, json_object(table_update
)) {
567 const struct json
*row_update
= table_node
->data
;
568 const struct json
*old_json
, *new_json
;
571 if (!uuid_from_string(&uuid
, table_node
->name
)) {
572 return ovsdb_syntax_error(table_update
, NULL
,
573 "<table-update> for table \"%s\" "
575 "\"%s\" as member name",
579 if (row_update
->type
!= JSON_OBJECT
) {
580 return ovsdb_syntax_error(row_update
, NULL
,
581 "<table-update> for table \"%s\" "
582 "contains <row-update> for %s that "
588 old_json
= shash_find_data(json_object(row_update
), "old");
589 new_json
= shash_find_data(json_object(row_update
), "new");
590 if (old_json
&& old_json
->type
!= JSON_OBJECT
) {
591 return ovsdb_syntax_error(old_json
, NULL
,
592 "\"old\" <row> is not object");
593 } else if (new_json
&& new_json
->type
!= JSON_OBJECT
) {
594 return ovsdb_syntax_error(new_json
, NULL
,
595 "\"new\" <row> is not object");
596 } else if ((old_json
!= NULL
) + (new_json
!= NULL
)
597 != shash_count(json_object(row_update
))) {
598 return ovsdb_syntax_error(row_update
, NULL
,
599 "<row-update> contains unexpected "
601 } else if (!old_json
&& !new_json
) {
602 return ovsdb_syntax_error(row_update
, NULL
,
603 "<row-update> missing \"old\" "
604 "and \"new\" members");
607 if (ovsdb_idl_process_update(table
, &uuid
, old_json
, new_json
)) {
616 static struct ovsdb_idl_row
*
617 ovsdb_idl_get_row(struct ovsdb_idl_table
*table
, const struct uuid
*uuid
)
619 struct ovsdb_idl_row
*row
;
621 HMAP_FOR_EACH_WITH_HASH (row
, hmap_node
, uuid_hash(uuid
), &table
->rows
) {
622 if (uuid_equals(&row
->uuid
, uuid
)) {
629 /* Returns true if a column with mode OVSDB_IDL_MODE_RW changed, false
632 ovsdb_idl_process_update(struct ovsdb_idl_table
*table
,
633 const struct uuid
*uuid
, const struct json
*old
,
634 const struct json
*new)
636 struct ovsdb_idl_row
*row
;
638 row
= ovsdb_idl_get_row(table
, uuid
);
641 if (row
&& !ovsdb_idl_row_is_orphan(row
)) {
642 /* XXX perhaps we should check the 'old' values? */
643 ovsdb_idl_delete_row(row
);
645 VLOG_WARN_RL(&semantic_rl
, "cannot delete missing row "UUID_FMT
" "
647 UUID_ARGS(uuid
), table
->class->name
);
653 ovsdb_idl_insert_row(ovsdb_idl_row_create(table
, uuid
), new);
654 } else if (ovsdb_idl_row_is_orphan(row
)) {
655 ovsdb_idl_insert_row(row
, new);
657 VLOG_WARN_RL(&semantic_rl
, "cannot add existing row "UUID_FMT
" to "
658 "table %s", UUID_ARGS(uuid
), table
->class->name
);
659 return ovsdb_idl_modify_row(row
, new);
664 /* XXX perhaps we should check the 'old' values? */
665 if (!ovsdb_idl_row_is_orphan(row
)) {
666 return ovsdb_idl_modify_row(row
, new);
668 VLOG_WARN_RL(&semantic_rl
, "cannot modify missing but "
669 "referenced row "UUID_FMT
" in table %s",
670 UUID_ARGS(uuid
), table
->class->name
);
671 ovsdb_idl_insert_row(row
, new);
674 VLOG_WARN_RL(&semantic_rl
, "cannot modify missing row "UUID_FMT
" "
675 "in table %s", UUID_ARGS(uuid
), table
->class->name
);
676 ovsdb_idl_insert_row(ovsdb_idl_row_create(table
, uuid
), new);
683 /* Returns true if a column with mode OVSDB_IDL_MODE_RW changed, false
686 ovsdb_idl_row_update(struct ovsdb_idl_row
*row
, const struct json
*row_json
)
688 struct ovsdb_idl_table
*table
= row
->table
;
689 struct shash_node
*node
;
690 bool changed
= false;
692 SHASH_FOR_EACH (node
, json_object(row_json
)) {
693 const char *column_name
= node
->name
;
694 const struct ovsdb_idl_column
*column
;
695 struct ovsdb_datum datum
;
696 struct ovsdb_error
*error
;
698 column
= shash_find_data(&table
->columns
, column_name
);
700 VLOG_WARN_RL(&syntax_rl
, "unknown column %s updating row "UUID_FMT
,
701 column_name
, UUID_ARGS(&row
->uuid
));
705 error
= ovsdb_datum_from_json(&datum
, &column
->type
, node
->data
, NULL
);
707 unsigned int column_idx
= column
- table
->class->columns
;
708 struct ovsdb_datum
*old
= &row
->old
[column_idx
];
710 if (!ovsdb_datum_equals(old
, &datum
, &column
->type
)) {
711 ovsdb_datum_swap(old
, &datum
);
712 if (table
->modes
[column_idx
] & OVSDB_IDL_ALERT
) {
716 /* Didn't really change but the OVSDB monitor protocol always
717 * includes every value in a row. */
720 ovsdb_datum_destroy(&datum
, &column
->type
);
722 char *s
= ovsdb_error_to_string(error
);
723 VLOG_WARN_RL(&syntax_rl
, "error parsing column %s in row "UUID_FMT
724 " in table %s: %s", column_name
,
725 UUID_ARGS(&row
->uuid
), table
->class->name
, s
);
727 ovsdb_error_destroy(error
);
733 /* When a row A refers to row B through a column with a "refTable" constraint,
734 * but row B does not exist, row B is called an "orphan row". Orphan rows
735 * should not persist, because the database enforces referential integrity, but
736 * they can appear transiently as changes from the database are received (the
737 * database doesn't try to topologically sort them and circular references mean
738 * it isn't always possible anyhow).
740 * This function returns true if 'row' is an orphan row, otherwise false.
743 ovsdb_idl_row_is_orphan(const struct ovsdb_idl_row
*row
)
745 return !row
->old
&& !row
->new;
748 /* Returns true if 'row' is conceptually part of the database as modified by
749 * the current transaction (if any), false otherwise.
751 * This function will return true if 'row' is not an orphan (see the comment on
752 * ovsdb_idl_row_is_orphan()) and:
754 * - 'row' exists in the database and has not been deleted within the
755 * current transaction (if any).
757 * - 'row' was inserted within the current transaction and has not been
758 * deleted. (In the latter case you should not have passed 'row' in at
759 * all, because ovsdb_idl_txn_delete() freed it.)
761 * This function will return false if 'row' is an orphan or if 'row' was
762 * deleted within the current transaction.
765 ovsdb_idl_row_exists(const struct ovsdb_idl_row
*row
)
767 return row
->new != NULL
;
771 ovsdb_idl_row_parse(struct ovsdb_idl_row
*row
)
773 const struct ovsdb_idl_table_class
*class = row
->table
->class;
776 for (i
= 0; i
< class->n_columns
; i
++) {
777 const struct ovsdb_idl_column
*c
= &class->columns
[i
];
778 (c
->parse
)(row
, &row
->old
[i
]);
783 ovsdb_idl_row_unparse(struct ovsdb_idl_row
*row
)
785 const struct ovsdb_idl_table_class
*class = row
->table
->class;
788 for (i
= 0; i
< class->n_columns
; i
++) {
789 const struct ovsdb_idl_column
*c
= &class->columns
[i
];
795 ovsdb_idl_row_clear_old(struct ovsdb_idl_row
*row
)
797 assert(row
->old
== row
->new);
798 if (!ovsdb_idl_row_is_orphan(row
)) {
799 const struct ovsdb_idl_table_class
*class = row
->table
->class;
802 for (i
= 0; i
< class->n_columns
; i
++) {
803 ovsdb_datum_destroy(&row
->old
[i
], &class->columns
[i
].type
);
806 row
->old
= row
->new = NULL
;
811 ovsdb_idl_row_clear_new(struct ovsdb_idl_row
*row
)
813 if (row
->old
!= row
->new) {
815 const struct ovsdb_idl_table_class
*class = row
->table
->class;
819 BITMAP_FOR_EACH_1 (i
, class->n_columns
, row
->written
) {
820 ovsdb_datum_destroy(&row
->new[i
], &class->columns
[i
].type
);
832 ovsdb_idl_row_clear_arcs(struct ovsdb_idl_row
*row
, bool destroy_dsts
)
834 struct ovsdb_idl_arc
*arc
, *next
;
836 /* Delete all forward arcs. If 'destroy_dsts', destroy any orphaned rows
837 * that this causes to be unreferenced. */
838 LIST_FOR_EACH_SAFE (arc
, next
, src_node
, &row
->src_arcs
) {
839 list_remove(&arc
->dst_node
);
841 && ovsdb_idl_row_is_orphan(arc
->dst
)
842 && list_is_empty(&arc
->dst
->dst_arcs
)) {
843 ovsdb_idl_row_destroy(arc
->dst
);
847 list_init(&row
->src_arcs
);
850 /* Force nodes that reference 'row' to reparse. */
852 ovsdb_idl_row_reparse_backrefs(struct ovsdb_idl_row
*row
)
854 struct ovsdb_idl_arc
*arc
, *next
;
856 /* This is trickier than it looks. ovsdb_idl_row_clear_arcs() will destroy
857 * 'arc', so we need to use the "safe" variant of list traversal. However,
858 * calling an ovsdb_idl_column's 'parse' function will add an arc
859 * equivalent to 'arc' to row->arcs. That could be a problem for
860 * traversal, but it adds it at the beginning of the list to prevent us
861 * from stumbling upon it again.
863 * (If duplicate arcs were possible then we would need to make sure that
864 * 'next' didn't also point into 'arc''s destination, but we forbid
865 * duplicate arcs.) */
866 LIST_FOR_EACH_SAFE (arc
, next
, dst_node
, &row
->dst_arcs
) {
867 struct ovsdb_idl_row
*ref
= arc
->src
;
869 ovsdb_idl_row_unparse(ref
);
870 ovsdb_idl_row_clear_arcs(ref
, false);
871 ovsdb_idl_row_parse(ref
);
875 static struct ovsdb_idl_row
*
876 ovsdb_idl_row_create__(const struct ovsdb_idl_table_class
*class)
878 struct ovsdb_idl_row
*row
= xzalloc(class->allocation_size
);
879 list_init(&row
->src_arcs
);
880 list_init(&row
->dst_arcs
);
881 hmap_node_nullify(&row
->txn_node
);
885 static struct ovsdb_idl_row
*
886 ovsdb_idl_row_create(struct ovsdb_idl_table
*table
, const struct uuid
*uuid
)
888 struct ovsdb_idl_row
*row
= ovsdb_idl_row_create__(table
->class);
889 hmap_insert(&table
->rows
, &row
->hmap_node
, uuid_hash(uuid
));
896 ovsdb_idl_row_destroy(struct ovsdb_idl_row
*row
)
899 ovsdb_idl_row_clear_old(row
);
900 hmap_remove(&row
->table
->rows
, &row
->hmap_node
);
906 ovsdb_idl_insert_row(struct ovsdb_idl_row
*row
, const struct json
*row_json
)
908 const struct ovsdb_idl_table_class
*class = row
->table
->class;
911 assert(!row
->old
&& !row
->new);
912 row
->old
= row
->new = xmalloc(class->n_columns
* sizeof *row
->old
);
913 for (i
= 0; i
< class->n_columns
; i
++) {
914 ovsdb_datum_init_default(&row
->old
[i
], &class->columns
[i
].type
);
916 ovsdb_idl_row_update(row
, row_json
);
917 ovsdb_idl_row_parse(row
);
919 ovsdb_idl_row_reparse_backrefs(row
);
923 ovsdb_idl_delete_row(struct ovsdb_idl_row
*row
)
925 ovsdb_idl_row_unparse(row
);
926 ovsdb_idl_row_clear_arcs(row
, true);
927 ovsdb_idl_row_clear_old(row
);
928 if (list_is_empty(&row
->dst_arcs
)) {
929 ovsdb_idl_row_destroy(row
);
931 ovsdb_idl_row_reparse_backrefs(row
);
935 /* Returns true if a column with mode OVSDB_IDL_MODE_RW changed, false
938 ovsdb_idl_modify_row(struct ovsdb_idl_row
*row
, const struct json
*row_json
)
942 ovsdb_idl_row_unparse(row
);
943 ovsdb_idl_row_clear_arcs(row
, true);
944 changed
= ovsdb_idl_row_update(row
, row_json
);
945 ovsdb_idl_row_parse(row
);
951 may_add_arc(const struct ovsdb_idl_row
*src
, const struct ovsdb_idl_row
*dst
)
953 const struct ovsdb_idl_arc
*arc
;
960 /* No duplicate arcs.
962 * We only need to test whether the first arc in dst->dst_arcs originates
963 * at 'src', since we add all of the arcs from a given source in a clump
964 * (in a single call to ovsdb_idl_row_parse()) and new arcs are always
965 * added at the front of the dst_arcs list. */
966 if (list_is_empty(&dst
->dst_arcs
)) {
969 arc
= CONTAINER_OF(dst
->dst_arcs
.next
, struct ovsdb_idl_arc
, dst_node
);
970 return arc
->src
!= src
;
973 static struct ovsdb_idl_table
*
974 ovsdb_idl_table_from_class(const struct ovsdb_idl
*idl
,
975 const struct ovsdb_idl_table_class
*table_class
)
977 return &idl
->tables
[table_class
- idl
->class->tables
];
980 struct ovsdb_idl_row
*
981 ovsdb_idl_get_row_arc(struct ovsdb_idl_row
*src
,
982 struct ovsdb_idl_table_class
*dst_table_class
,
983 const struct uuid
*dst_uuid
)
985 struct ovsdb_idl
*idl
= src
->table
->idl
;
986 struct ovsdb_idl_table
*dst_table
;
987 struct ovsdb_idl_arc
*arc
;
988 struct ovsdb_idl_row
*dst
;
990 dst_table
= ovsdb_idl_table_from_class(idl
, dst_table_class
);
991 dst
= ovsdb_idl_get_row(dst_table
, dst_uuid
);
993 /* We're being called from ovsdb_idl_txn_write(). We must not update
994 * any arcs, because the transaction will be backed out at commit or
995 * abort time and we don't want our graph screwed up.
997 * Just return the destination row, if there is one and it has not been
999 if (dst
&& (hmap_node_is_null(&dst
->txn_node
) || dst
->new)) {
1004 /* We're being called from some other context. Update the graph. */
1006 dst
= ovsdb_idl_row_create(dst_table
, dst_uuid
);
1009 /* Add a new arc, if it wouldn't be a self-arc or a duplicate arc. */
1010 if (may_add_arc(src
, dst
)) {
1011 /* The arc *must* be added at the front of the dst_arcs list. See
1012 * ovsdb_idl_row_reparse_backrefs() for details. */
1013 arc
= xmalloc(sizeof *arc
);
1014 list_push_front(&src
->src_arcs
, &arc
->src_node
);
1015 list_push_front(&dst
->dst_arcs
, &arc
->dst_node
);
1020 return !ovsdb_idl_row_is_orphan(dst
) ? dst
: NULL
;
1024 const struct ovsdb_idl_row
*
1025 ovsdb_idl_get_row_for_uuid(const struct ovsdb_idl
*idl
,
1026 const struct ovsdb_idl_table_class
*tc
,
1027 const struct uuid
*uuid
)
1029 return ovsdb_idl_get_row(ovsdb_idl_table_from_class(idl
, tc
), uuid
);
1032 static struct ovsdb_idl_row
*
1033 next_real_row(struct ovsdb_idl_table
*table
, struct hmap_node
*node
)
1035 for (; node
; node
= hmap_next(&table
->rows
, node
)) {
1036 struct ovsdb_idl_row
*row
;
1038 row
= CONTAINER_OF(node
, struct ovsdb_idl_row
, hmap_node
);
1039 if (ovsdb_idl_row_exists(row
)) {
1046 const struct ovsdb_idl_row
*
1047 ovsdb_idl_first_row(const struct ovsdb_idl
*idl
,
1048 const struct ovsdb_idl_table_class
*table_class
)
1050 struct ovsdb_idl_table
*table
1051 = ovsdb_idl_table_from_class(idl
, table_class
);
1052 return next_real_row(table
, hmap_first(&table
->rows
));
1055 const struct ovsdb_idl_row
*
1056 ovsdb_idl_next_row(const struct ovsdb_idl_row
*row
)
1058 struct ovsdb_idl_table
*table
= row
->table
;
1060 return next_real_row(table
, hmap_next(&table
->rows
, &row
->hmap_node
));
1063 /* Reads and returns the value of 'column' within 'row'. If an ongoing
1064 * transaction has changed 'column''s value, the modified value is returned.
1066 * The caller must not modify or free the returned value.
1068 * Various kinds of changes can invalidate the returned value: writing to the
1069 * same 'column' in 'row' (e.g. with ovsdb_idl_txn_write()), deleting 'row'
1070 * (e.g. with ovsdb_idl_txn_delete()), or completing an ongoing transaction
1071 * (e.g. with ovsdb_idl_txn_commit() or ovsdb_idl_txn_abort()). If the
1072 * returned value is needed for a long time, it is best to make a copy of it
1073 * with ovsdb_datum_clone(). */
1074 const struct ovsdb_datum
*
1075 ovsdb_idl_read(const struct ovsdb_idl_row
*row
,
1076 const struct ovsdb_idl_column
*column
)
1078 const struct ovsdb_idl_table_class
*class = row
->table
->class;
1079 size_t column_idx
= column
- class->columns
;
1081 assert(row
->new != NULL
);
1082 assert(column_idx
< class->n_columns
);
1084 if (row
->written
&& bitmap_is_set(row
->written
, column_idx
)) {
1085 return &row
->new[column_idx
];
1086 } else if (row
->old
) {
1087 return &row
->old
[column_idx
];
1089 return ovsdb_datum_default(&column
->type
);
1093 /* Same as ovsdb_idl_read(), except that it also asserts that 'column' has key
1094 * type 'key_type' and value type 'value_type'. (Scalar and set types will
1095 * have a value type of OVSDB_TYPE_VOID.)
1097 * This is useful in code that "knows" that a particular column has a given
1098 * type, so that it will abort if someone changes the column's type without
1099 * updating the code that uses it. */
1100 const struct ovsdb_datum
*
1101 ovsdb_idl_get(const struct ovsdb_idl_row
*row
,
1102 const struct ovsdb_idl_column
*column
,
1103 enum ovsdb_atomic_type key_type OVS_UNUSED
,
1104 enum ovsdb_atomic_type value_type OVS_UNUSED
)
1106 assert(column
->type
.key
.type
== key_type
);
1107 assert(column
->type
.value
.type
== value_type
);
1109 return ovsdb_idl_read(row
, column
);
1112 /* Returns false if 'row' was obtained from the IDL, true if it was initialized
1113 * to all-zero-bits by some other entity. If 'row' was set up some other way
1114 * then the return value is indeterminate. */
1116 ovsdb_idl_row_is_synthetic(const struct ovsdb_idl_row
*row
)
1118 return row
->table
== NULL
;
1123 static void ovsdb_idl_txn_complete(struct ovsdb_idl_txn
*txn
,
1124 enum ovsdb_idl_txn_status
);
1127 ovsdb_idl_txn_status_to_string(enum ovsdb_idl_txn_status status
)
1130 case TXN_UNCOMMITTED
:
1131 return "uncommitted";
1134 case TXN_INCOMPLETE
:
1135 return "incomplete";
1148 struct ovsdb_idl_txn
*
1149 ovsdb_idl_txn_create(struct ovsdb_idl
*idl
)
1151 struct ovsdb_idl_txn
*txn
;
1154 idl
->txn
= txn
= xmalloc(sizeof *txn
);
1155 txn
->request_id
= NULL
;
1157 hmap_init(&txn
->txn_rows
);
1158 txn
->status
= TXN_UNCOMMITTED
;
1160 txn
->dry_run
= false;
1161 ds_init(&txn
->comment
);
1163 txn
->inc_table
= NULL
;
1164 txn
->inc_column
= NULL
;
1165 txn
->inc_where
= NULL
;
1167 hmap_init(&txn
->inserted_rows
);
1172 /* Appends 's', which is treated as a printf()-type format string, to the
1173 * comments that will be passed to the OVSDB server when 'txn' is committed.
1174 * (The comment will be committed to the OVSDB log, which "ovsdb-tool
1175 * show-log" can print in a relatively human-readable form.) */
1177 ovsdb_idl_txn_add_comment(struct ovsdb_idl_txn
*txn
, const char *s
, ...)
1181 if (txn
->comment
.length
) {
1182 ds_put_char(&txn
->comment
, '\n');
1186 ds_put_format_valist(&txn
->comment
, s
, args
);
1191 ovsdb_idl_txn_set_dry_run(struct ovsdb_idl_txn
*txn
)
1193 txn
->dry_run
= true;
1197 ovsdb_idl_txn_increment(struct ovsdb_idl_txn
*txn
, const char *table
,
1198 const char *column
, const struct json
*where
)
1200 assert(!txn
->inc_table
);
1201 txn
->inc_table
= xstrdup(table
);
1202 txn
->inc_column
= xstrdup(column
);
1203 txn
->inc_where
= where
? json_clone(where
) : json_array_create_empty();
1207 ovsdb_idl_txn_destroy(struct ovsdb_idl_txn
*txn
)
1209 struct ovsdb_idl_txn_insert
*insert
, *next
;
1211 json_destroy(txn
->request_id
);
1212 if (txn
->status
== TXN_INCOMPLETE
) {
1213 hmap_remove(&txn
->idl
->outstanding_txns
, &txn
->hmap_node
);
1215 ovsdb_idl_txn_abort(txn
);
1216 ds_destroy(&txn
->comment
);
1218 free(txn
->inc_table
);
1219 free(txn
->inc_column
);
1220 json_destroy(txn
->inc_where
);
1221 HMAP_FOR_EACH_SAFE (insert
, next
, hmap_node
, &txn
->inserted_rows
) {
1224 hmap_destroy(&txn
->inserted_rows
);
1229 ovsdb_idl_txn_wait(const struct ovsdb_idl_txn
*txn
)
1231 if (txn
->status
!= TXN_UNCOMMITTED
&& txn
->status
!= TXN_INCOMPLETE
) {
1232 poll_immediate_wake();
1236 static struct json
*
1237 where_uuid_equals(const struct uuid
*uuid
)
1240 json_array_create_1(
1241 json_array_create_3(
1242 json_string_create("_uuid"),
1243 json_string_create("=="),
1244 json_array_create_2(
1245 json_string_create("uuid"),
1246 json_string_create_nocopy(
1247 xasprintf(UUID_FMT
, UUID_ARGS(uuid
))))));
1251 uuid_name_from_uuid(const struct uuid
*uuid
)
1256 name
= xasprintf("row"UUID_FMT
, UUID_ARGS(uuid
));
1257 for (p
= name
; *p
!= '\0'; p
++) {
1266 static const struct ovsdb_idl_row
*
1267 ovsdb_idl_txn_get_row(const struct ovsdb_idl_txn
*txn
, const struct uuid
*uuid
)
1269 const struct ovsdb_idl_row
*row
;
1271 HMAP_FOR_EACH_WITH_HASH (row
, txn_node
, uuid_hash(uuid
), &txn
->txn_rows
) {
1272 if (uuid_equals(&row
->uuid
, uuid
)) {
1279 /* XXX there must be a cleaner way to do this */
1280 static struct json
*
1281 substitute_uuids(struct json
*json
, const struct ovsdb_idl_txn
*txn
)
1283 if (json
->type
== JSON_ARRAY
) {
1287 if (json
->u
.array
.n
== 2
1288 && json
->u
.array
.elems
[0]->type
== JSON_STRING
1289 && json
->u
.array
.elems
[1]->type
== JSON_STRING
1290 && !strcmp(json
->u
.array
.elems
[0]->u
.string
, "uuid")
1291 && uuid_from_string(&uuid
, json
->u
.array
.elems
[1]->u
.string
)) {
1292 const struct ovsdb_idl_row
*row
;
1294 row
= ovsdb_idl_txn_get_row(txn
, &uuid
);
1295 if (row
&& !row
->old
&& row
->new) {
1298 return json_array_create_2(
1299 json_string_create("named-uuid"),
1300 json_string_create_nocopy(uuid_name_from_uuid(&uuid
)));
1304 for (i
= 0; i
< json
->u
.array
.n
; i
++) {
1305 json
->u
.array
.elems
[i
] = substitute_uuids(json
->u
.array
.elems
[i
],
1308 } else if (json
->type
== JSON_OBJECT
) {
1309 struct shash_node
*node
;
1311 SHASH_FOR_EACH (node
, json_object(json
)) {
1312 node
->data
= substitute_uuids(node
->data
, txn
);
1319 ovsdb_idl_txn_disassemble(struct ovsdb_idl_txn
*txn
)
1321 struct ovsdb_idl_row
*row
, *next
;
1323 /* This must happen early. Otherwise, ovsdb_idl_row_parse() will call an
1324 * ovsdb_idl_column's 'parse' function, which will call
1325 * ovsdb_idl_get_row_arc(), which will seen that the IDL is in a
1326 * transaction and fail to update the graph. */
1327 txn
->idl
->txn
= NULL
;
1329 HMAP_FOR_EACH_SAFE (row
, next
, txn_node
, &txn
->txn_rows
) {
1332 ovsdb_idl_row_unparse(row
);
1333 ovsdb_idl_row_clear_arcs(row
, false);
1334 ovsdb_idl_row_parse(row
);
1337 ovsdb_idl_row_unparse(row
);
1339 ovsdb_idl_row_clear_new(row
);
1342 row
->prereqs
= NULL
;
1345 row
->written
= NULL
;
1347 hmap_remove(&txn
->txn_rows
, &row
->txn_node
);
1348 hmap_node_nullify(&row
->txn_node
);
1350 hmap_remove(&row
->table
->rows
, &row
->hmap_node
);
1354 hmap_destroy(&txn
->txn_rows
);
1355 hmap_init(&txn
->txn_rows
);
1358 enum ovsdb_idl_txn_status
1359 ovsdb_idl_txn_commit(struct ovsdb_idl_txn
*txn
)
1361 struct ovsdb_idl_row
*row
;
1362 struct json
*operations
;
1365 if (txn
!= txn
->idl
->txn
) {
1369 operations
= json_array_create_1(
1370 json_string_create(txn
->idl
->class->database
));
1372 /* Add prerequisites and declarations of new rows. */
1373 HMAP_FOR_EACH (row
, txn_node
, &txn
->txn_rows
) {
1374 /* XXX check that deleted rows exist even if no prereqs? */
1376 const struct ovsdb_idl_table_class
*class = row
->table
->class;
1377 size_t n_columns
= class->n_columns
;
1378 struct json
*op
, *columns
, *row_json
;
1381 op
= json_object_create();
1382 json_array_add(operations
, op
);
1383 json_object_put_string(op
, "op", "wait");
1384 json_object_put_string(op
, "table", class->name
);
1385 json_object_put(op
, "timeout", json_integer_create(0));
1386 json_object_put(op
, "where", where_uuid_equals(&row
->uuid
));
1387 json_object_put_string(op
, "until", "==");
1388 columns
= json_array_create_empty();
1389 json_object_put(op
, "columns", columns
);
1390 row_json
= json_object_create();
1391 json_object_put(op
, "rows", json_array_create_1(row_json
));
1393 BITMAP_FOR_EACH_1 (idx
, n_columns
, row
->prereqs
) {
1394 const struct ovsdb_idl_column
*column
= &class->columns
[idx
];
1395 json_array_add(columns
, json_string_create(column
->name
));
1396 json_object_put(row_json
, column
->name
,
1397 ovsdb_datum_to_json(&row
->old
[idx
],
1404 any_updates
= false;
1405 HMAP_FOR_EACH (row
, txn_node
, &txn
->txn_rows
) {
1406 const struct ovsdb_idl_table_class
*class = row
->table
->class;
1408 if (row
->old
== row
->new) {
1410 } else if (!row
->new) {
1411 if (class->is_root
) {
1412 struct json
*op
= json_object_create();
1413 json_object_put_string(op
, "op", "delete");
1414 json_object_put_string(op
, "table", class->name
);
1415 json_object_put(op
, "where", where_uuid_equals(&row
->uuid
));
1416 json_array_add(operations
, op
);
1419 /* Let ovsdb-server decide whether to really delete it. */
1422 struct json
*row_json
;
1426 op
= json_object_create();
1427 json_object_put_string(op
, "op", row
->old
? "update" : "insert");
1428 json_object_put_string(op
, "table", class->name
);
1430 json_object_put(op
, "where", where_uuid_equals(&row
->uuid
));
1432 struct ovsdb_idl_txn_insert
*insert
;
1436 json_object_put(op
, "uuid-name",
1437 json_string_create_nocopy(
1438 uuid_name_from_uuid(&row
->uuid
)));
1440 insert
= xmalloc(sizeof *insert
);
1441 insert
->dummy
= row
->uuid
;
1442 insert
->op_index
= operations
->u
.array
.n
- 1;
1443 uuid_zero(&insert
->real
);
1444 hmap_insert(&txn
->inserted_rows
, &insert
->hmap_node
,
1445 uuid_hash(&insert
->dummy
));
1447 row_json
= json_object_create();
1448 json_object_put(op
, "row", row_json
);
1451 BITMAP_FOR_EACH_1 (idx
, class->n_columns
, row
->written
) {
1452 const struct ovsdb_idl_column
*column
=
1453 &class->columns
[idx
];
1456 || !ovsdb_datum_is_default(&row
->new[idx
],
1458 json_object_put(row_json
, column
->name
,
1460 ovsdb_datum_to_json(&row
->new[idx
],
1464 /* If anything really changed, consider it an update.
1465 * We can't suppress not-really-changed values earlier
1466 * or transactions would become nonatomic (see the big
1467 * comment inside ovsdb_idl_txn_write()). */
1468 if (!any_updates
&& row
->old
&&
1469 !ovsdb_datum_equals(&row
->old
[idx
], &row
->new[idx
],
1477 if (!row
->old
|| !shash_is_empty(json_object(row_json
))) {
1478 json_array_add(operations
, op
);
1485 /* Add increment. */
1486 if (txn
->inc_table
&& any_updates
) {
1489 txn
->inc_index
= operations
->u
.array
.n
- 1;
1491 op
= json_object_create();
1492 json_object_put_string(op
, "op", "mutate");
1493 json_object_put_string(op
, "table", txn
->inc_table
);
1494 json_object_put(op
, "where",
1495 substitute_uuids(json_clone(txn
->inc_where
), txn
));
1496 json_object_put(op
, "mutations",
1497 json_array_create_1(
1498 json_array_create_3(
1499 json_string_create(txn
->inc_column
),
1500 json_string_create("+="),
1501 json_integer_create(1))));
1502 json_array_add(operations
, op
);
1504 op
= json_object_create();
1505 json_object_put_string(op
, "op", "select");
1506 json_object_put_string(op
, "table", txn
->inc_table
);
1507 json_object_put(op
, "where",
1508 substitute_uuids(json_clone(txn
->inc_where
), txn
));
1509 json_object_put(op
, "columns",
1510 json_array_create_1(json_string_create(
1512 json_array_add(operations
, op
);
1515 if (txn
->comment
.length
) {
1516 struct json
*op
= json_object_create();
1517 json_object_put_string(op
, "op", "comment");
1518 json_object_put_string(op
, "comment", ds_cstr(&txn
->comment
));
1519 json_array_add(operations
, op
);
1523 struct json
*op
= json_object_create();
1524 json_object_put_string(op
, "op", "abort");
1525 json_array_add(operations
, op
);
1529 txn
->status
= TXN_UNCHANGED
;
1530 json_destroy(operations
);
1531 } else if (!jsonrpc_session_send(
1533 jsonrpc_create_request(
1534 "transact", operations
, &txn
->request_id
))) {
1535 hmap_insert(&txn
->idl
->outstanding_txns
, &txn
->hmap_node
,
1536 json_hash(txn
->request_id
, 0));
1537 txn
->status
= TXN_INCOMPLETE
;
1539 txn
->status
= TXN_TRY_AGAIN
;
1542 ovsdb_idl_txn_disassemble(txn
);
1546 /* Attempts to commit 'txn', blocking until the commit either succeeds or
1547 * fails. Returns the final commit status, which may be any TXN_* value other
1548 * than TXN_INCOMPLETE. */
1549 enum ovsdb_idl_txn_status
1550 ovsdb_idl_txn_commit_block(struct ovsdb_idl_txn
*txn
)
1552 enum ovsdb_idl_txn_status status
;
1555 while ((status
= ovsdb_idl_txn_commit(txn
)) == TXN_INCOMPLETE
) {
1556 ovsdb_idl_run(txn
->idl
);
1557 ovsdb_idl_wait(txn
->idl
);
1558 ovsdb_idl_txn_wait(txn
);
1565 ovsdb_idl_txn_get_increment_new_value(const struct ovsdb_idl_txn
*txn
)
1567 assert(txn
->status
== TXN_SUCCESS
);
1568 return txn
->inc_new_value
;
1572 ovsdb_idl_txn_abort(struct ovsdb_idl_txn
*txn
)
1574 ovsdb_idl_txn_disassemble(txn
);
1575 if (txn
->status
== TXN_UNCOMMITTED
|| txn
->status
== TXN_INCOMPLETE
) {
1576 txn
->status
= TXN_ABORTED
;
1581 ovsdb_idl_txn_get_error(const struct ovsdb_idl_txn
*txn
)
1583 if (txn
->status
!= TXN_ERROR
) {
1584 return ovsdb_idl_txn_status_to_string(txn
->status
);
1585 } else if (txn
->error
) {
1588 return "no error details available";
1593 ovsdb_idl_txn_set_error_json(struct ovsdb_idl_txn
*txn
,
1594 const struct json
*json
)
1596 if (txn
->error
== NULL
) {
1597 txn
->error
= json_to_string(json
, JSSF_SORT
);
1601 /* For transaction 'txn' that completed successfully, finds and returns the
1602 * permanent UUID that the database assigned to a newly inserted row, given the
1603 * 'uuid' that ovsdb_idl_txn_insert() assigned locally to that row.
1605 * Returns NULL if 'uuid' is not a UUID assigned by ovsdb_idl_txn_insert() or
1606 * if it was assigned by that function and then deleted by
1607 * ovsdb_idl_txn_delete() within the same transaction. (Rows that are inserted
1608 * and then deleted within a single transaction are never sent to the database
1609 * server, so it never assigns them a permanent UUID.) */
1611 ovsdb_idl_txn_get_insert_uuid(const struct ovsdb_idl_txn
*txn
,
1612 const struct uuid
*uuid
)
1614 const struct ovsdb_idl_txn_insert
*insert
;
1616 assert(txn
->status
== TXN_SUCCESS
|| txn
->status
== TXN_UNCHANGED
);
1617 HMAP_FOR_EACH_IN_BUCKET (insert
, hmap_node
,
1618 uuid_hash(uuid
), &txn
->inserted_rows
) {
1619 if (uuid_equals(uuid
, &insert
->dummy
)) {
1620 return &insert
->real
;
1627 ovsdb_idl_txn_complete(struct ovsdb_idl_txn
*txn
,
1628 enum ovsdb_idl_txn_status status
)
1630 txn
->status
= status
;
1631 hmap_remove(&txn
->idl
->outstanding_txns
, &txn
->hmap_node
);
1634 /* Writes 'datum' to the specified 'column' in 'row_'. Updates both 'row_'
1635 * itself and the structs derived from it (e.g. the "struct ovsrec_*", for
1638 * 'datum' must have the correct type for its column. The IDL does not check
1639 * that it meets schema constraints, but ovsdb-server will do so at commit time
1640 * so it had better be correct.
1642 * A transaction must be in progress. Replication of 'column' must not have
1643 * been disabled (by calling ovsdb_idl_omit()).
1645 * Usually this function is used indirectly through one of the "set" functions
1646 * generated by ovsdb-idlc.
1648 * Takes ownership of what 'datum' points to (and in some cases destroys that
1649 * data before returning) but makes a copy of 'datum' itself. (Commonly
1650 * 'datum' is on the caller's stack.) */
1652 ovsdb_idl_txn_write(const struct ovsdb_idl_row
*row_
,
1653 const struct ovsdb_idl_column
*column
,
1654 struct ovsdb_datum
*datum
)
1656 struct ovsdb_idl_row
*row
= (struct ovsdb_idl_row
*) row_
;
1657 const struct ovsdb_idl_table_class
*class = row
->table
->class;
1658 size_t column_idx
= column
- class->columns
;
1660 assert(row
->new != NULL
);
1661 assert(column_idx
< class->n_columns
);
1662 assert(row
->old
== NULL
||
1663 row
->table
->modes
[column_idx
] & OVSDB_IDL_MONITOR
);
1665 /* If this is a write-only column and the datum being written is the same
1666 * as the one already there, just skip the update entirely. This is worth
1667 * optimizing because we have a lot of columns that get periodically
1668 * refreshed into the database but don't actually change that often.
1670 * We don't do this for read/write columns because that would break
1671 * atomicity of transactions--some other client might have written a
1672 * different value in that column since we read it. (But if a whole
1673 * transaction only does writes of existing values, without making any real
1674 * changes, we will drop the whole transaction later in
1675 * ovsdb_idl_txn_commit().) */
1676 if (row
->table
->modes
[column_idx
] == OVSDB_IDL_MONITOR
1677 && ovsdb_datum_equals(ovsdb_idl_read(row
, column
),
1678 datum
, &column
->type
)) {
1679 ovsdb_datum_destroy(datum
, &column
->type
);
1683 if (hmap_node_is_null(&row
->txn_node
)) {
1684 hmap_insert(&row
->table
->idl
->txn
->txn_rows
, &row
->txn_node
,
1685 uuid_hash(&row
->uuid
));
1687 if (row
->old
== row
->new) {
1688 row
->new = xmalloc(class->n_columns
* sizeof *row
->new);
1690 if (!row
->written
) {
1691 row
->written
= bitmap_allocate(class->n_columns
);
1693 if (bitmap_is_set(row
->written
, column_idx
)) {
1694 ovsdb_datum_destroy(&row
->new[column_idx
], &column
->type
);
1696 bitmap_set1(row
->written
, column_idx
);
1698 row
->new[column_idx
] = *datum
;
1699 (column
->unparse
)(row
);
1700 (column
->parse
)(row
, &row
->new[column_idx
]);
1703 /* Causes the original contents of 'column' in 'row_' to be verified as a
1704 * prerequisite to completing the transaction. That is, if 'column' in 'row_'
1705 * changed (or if 'row_' was deleted) between the time that the IDL originally
1706 * read its contents and the time that the transaction commits, then the
1707 * transaction aborts and ovsdb_idl_txn_commit() returns TXN_TRY_AGAIN.
1709 * The intention is that, to ensure that no transaction commits based on dirty
1710 * reads, an application should call ovsdb_idl_txn_verify() on each data item
1711 * read as part of a read-modify-write operation.
1713 * In some cases ovsdb_idl_txn_verify() reduces to a no-op, because the current
1714 * value of 'column' is already known:
1716 * - If 'row_' is a row created by the current transaction (returned by
1717 * ovsdb_idl_txn_insert()).
1719 * - If 'column' has already been modified (with ovsdb_idl_txn_write())
1720 * within the current transaction.
1722 * Because of the latter property, always call ovsdb_idl_txn_verify() *before*
1723 * ovsdb_idl_txn_write() for a given read-modify-write.
1725 * A transaction must be in progress.
1727 * Usually this function is used indirectly through one of the "verify"
1728 * functions generated by ovsdb-idlc. */
1730 ovsdb_idl_txn_verify(const struct ovsdb_idl_row
*row_
,
1731 const struct ovsdb_idl_column
*column
)
1733 struct ovsdb_idl_row
*row
= (struct ovsdb_idl_row
*) row_
;
1734 const struct ovsdb_idl_table_class
*class = row
->table
->class;
1735 size_t column_idx
= column
- class->columns
;
1737 assert(row
->new != NULL
);
1738 assert(row
->old
== NULL
||
1739 row
->table
->modes
[column_idx
] & OVSDB_IDL_MONITOR
);
1741 || (row
->written
&& bitmap_is_set(row
->written
, column_idx
))) {
1745 if (hmap_node_is_null(&row
->txn_node
)) {
1746 hmap_insert(&row
->table
->idl
->txn
->txn_rows
, &row
->txn_node
,
1747 uuid_hash(&row
->uuid
));
1749 if (!row
->prereqs
) {
1750 row
->prereqs
= bitmap_allocate(class->n_columns
);
1752 bitmap_set1(row
->prereqs
, column_idx
);
1755 /* Deletes 'row_' from its table. May free 'row_', so it must not be
1756 * accessed afterward.
1758 * A transaction must be in progress.
1760 * Usually this function is used indirectly through one of the "delete"
1761 * functions generated by ovsdb-idlc. */
1763 ovsdb_idl_txn_delete(const struct ovsdb_idl_row
*row_
)
1765 struct ovsdb_idl_row
*row
= (struct ovsdb_idl_row
*) row_
;
1767 assert(row
->new != NULL
);
1769 ovsdb_idl_row_unparse(row
);
1770 ovsdb_idl_row_clear_new(row
);
1771 assert(!row
->prereqs
);
1772 hmap_remove(&row
->table
->rows
, &row
->hmap_node
);
1773 hmap_remove(&row
->table
->idl
->txn
->txn_rows
, &row
->txn_node
);
1777 if (hmap_node_is_null(&row
->txn_node
)) {
1778 hmap_insert(&row
->table
->idl
->txn
->txn_rows
, &row
->txn_node
,
1779 uuid_hash(&row
->uuid
));
1781 ovsdb_idl_row_clear_new(row
);
1785 /* Inserts and returns a new row in the table with the specified 'class' in the
1786 * database with open transaction 'txn'.
1788 * The new row is assigned a provisional UUID. If 'uuid' is null then one is
1789 * randomly generated; otherwise 'uuid' should specify a randomly generated
1790 * UUID not otherwise in use. ovsdb-server will assign a different UUID when
1791 * 'txn' is committed, but the IDL will replace any uses of the provisional
1792 * UUID in the data to be to be committed by the UUID assigned by
1795 * Usually this function is used indirectly through one of the "insert"
1796 * functions generated by ovsdb-idlc. */
1797 const struct ovsdb_idl_row
*
1798 ovsdb_idl_txn_insert(struct ovsdb_idl_txn
*txn
,
1799 const struct ovsdb_idl_table_class
*class,
1800 const struct uuid
*uuid
)
1802 struct ovsdb_idl_row
*row
= ovsdb_idl_row_create__(class);
1805 assert(!ovsdb_idl_txn_get_row(txn
, uuid
));
1808 uuid_generate(&row
->uuid
);
1811 row
->table
= ovsdb_idl_table_from_class(txn
->idl
, class);
1812 row
->new = xmalloc(class->n_columns
* sizeof *row
->new);
1813 hmap_insert(&row
->table
->rows
, &row
->hmap_node
, uuid_hash(&row
->uuid
));
1814 hmap_insert(&txn
->txn_rows
, &row
->txn_node
, uuid_hash(&row
->uuid
));
1819 ovsdb_idl_txn_abort_all(struct ovsdb_idl
*idl
)
1821 struct ovsdb_idl_txn
*txn
;
1823 HMAP_FOR_EACH (txn
, hmap_node
, &idl
->outstanding_txns
) {
1824 ovsdb_idl_txn_complete(txn
, TXN_TRY_AGAIN
);
1828 static struct ovsdb_idl_txn
*
1829 ovsdb_idl_txn_find(struct ovsdb_idl
*idl
, const struct json
*id
)
1831 struct ovsdb_idl_txn
*txn
;
1833 HMAP_FOR_EACH_WITH_HASH (txn
, hmap_node
,
1834 json_hash(id
, 0), &idl
->outstanding_txns
) {
1835 if (json_equal(id
, txn
->request_id
)) {
1843 check_json_type(const struct json
*json
, enum json_type type
, const char *name
)
1846 VLOG_WARN_RL(&syntax_rl
, "%s is missing", name
);
1848 } else if (json
->type
!= type
) {
1849 VLOG_WARN_RL(&syntax_rl
, "%s is %s instead of %s",
1850 name
, json_type_to_string(json
->type
),
1851 json_type_to_string(type
));
1859 ovsdb_idl_txn_process_inc_reply(struct ovsdb_idl_txn
*txn
,
1860 const struct json_array
*results
)
1862 struct json
*count
, *rows
, *row
, *column
;
1863 struct shash
*mutate
, *select
;
1865 if (txn
->inc_index
+ 2 > results
->n
) {
1866 VLOG_WARN_RL(&syntax_rl
, "reply does not contain enough operations "
1867 "for increment (has %zu, needs %u)",
1868 results
->n
, txn
->inc_index
+ 2);
1872 /* We know that this is a JSON object because the loop in
1873 * ovsdb_idl_txn_process_reply() checked. */
1874 mutate
= json_object(results
->elems
[txn
->inc_index
]);
1875 count
= shash_find_data(mutate
, "count");
1876 if (!check_json_type(count
, JSON_INTEGER
, "\"mutate\" reply \"count\"")) {
1879 if (count
->u
.integer
!= 1) {
1880 VLOG_WARN_RL(&syntax_rl
,
1881 "\"mutate\" reply \"count\" is %lld instead of 1",
1886 select
= json_object(results
->elems
[txn
->inc_index
+ 1]);
1887 rows
= shash_find_data(select
, "rows");
1888 if (!check_json_type(rows
, JSON_ARRAY
, "\"select\" reply \"rows\"")) {
1891 if (rows
->u
.array
.n
!= 1) {
1892 VLOG_WARN_RL(&syntax_rl
, "\"select\" reply \"rows\" has %zu elements "
1897 row
= rows
->u
.array
.elems
[0];
1898 if (!check_json_type(row
, JSON_OBJECT
, "\"select\" reply row")) {
1901 column
= shash_find_data(json_object(row
), txn
->inc_column
);
1902 if (!check_json_type(column
, JSON_INTEGER
,
1903 "\"select\" reply inc column")) {
1906 txn
->inc_new_value
= column
->u
.integer
;
1911 ovsdb_idl_txn_process_insert_reply(struct ovsdb_idl_txn_insert
*insert
,
1912 const struct json_array
*results
)
1914 static const struct ovsdb_base_type uuid_type
= OVSDB_BASE_UUID_INIT
;
1915 struct ovsdb_error
*error
;
1916 struct json
*json_uuid
;
1917 union ovsdb_atom uuid
;
1918 struct shash
*reply
;
1920 if (insert
->op_index
>= results
->n
) {
1921 VLOG_WARN_RL(&syntax_rl
, "reply does not contain enough operations "
1922 "for insert (has %zu, needs %u)",
1923 results
->n
, insert
->op_index
);
1927 /* We know that this is a JSON object because the loop in
1928 * ovsdb_idl_txn_process_reply() checked. */
1929 reply
= json_object(results
->elems
[insert
->op_index
]);
1930 json_uuid
= shash_find_data(reply
, "uuid");
1931 if (!check_json_type(json_uuid
, JSON_ARRAY
, "\"insert\" reply \"uuid\"")) {
1935 error
= ovsdb_atom_from_json(&uuid
, &uuid_type
, json_uuid
, NULL
);
1937 char *s
= ovsdb_error_to_string(error
);
1938 VLOG_WARN_RL(&syntax_rl
, "\"insert\" reply \"uuid\" is not a JSON "
1944 insert
->real
= uuid
.uuid
;
1950 ovsdb_idl_txn_process_reply(struct ovsdb_idl
*idl
,
1951 const struct jsonrpc_msg
*msg
)
1953 struct ovsdb_idl_txn
*txn
;
1954 enum ovsdb_idl_txn_status status
;
1956 txn
= ovsdb_idl_txn_find(idl
, msg
->id
);
1961 if (msg
->type
== JSONRPC_ERROR
) {
1963 } else if (msg
->result
->type
!= JSON_ARRAY
) {
1964 VLOG_WARN_RL(&syntax_rl
, "reply to \"transact\" is not JSON array");
1967 struct json_array
*ops
= &msg
->result
->u
.array
;
1968 int hard_errors
= 0;
1969 int soft_errors
= 0;
1972 for (i
= 0; i
< ops
->n
; i
++) {
1973 struct json
*op
= ops
->elems
[i
];
1975 if (op
->type
== JSON_NULL
) {
1976 /* This isn't an error in itself but indicates that some prior
1977 * operation failed, so make sure that we know about it. */
1979 } else if (op
->type
== JSON_OBJECT
) {
1982 error
= shash_find_data(json_object(op
), "error");
1984 if (error
->type
== JSON_STRING
) {
1985 if (!strcmp(error
->u
.string
, "timed out")) {
1987 } else if (strcmp(error
->u
.string
, "aborted")) {
1989 ovsdb_idl_txn_set_error_json(txn
, op
);
1993 ovsdb_idl_txn_set_error_json(txn
, op
);
1994 VLOG_WARN_RL(&syntax_rl
,
1995 "\"error\" in reply is not JSON string");
2000 ovsdb_idl_txn_set_error_json(txn
, op
);
2001 VLOG_WARN_RL(&syntax_rl
,
2002 "operation reply is not JSON null or object");
2006 if (!soft_errors
&& !hard_errors
) {
2007 struct ovsdb_idl_txn_insert
*insert
;
2009 if (txn
->inc_table
&& !ovsdb_idl_txn_process_inc_reply(txn
, ops
)) {
2013 HMAP_FOR_EACH (insert
, hmap_node
, &txn
->inserted_rows
) {
2014 if (!ovsdb_idl_txn_process_insert_reply(insert
, ops
)) {
2020 status
= (hard_errors
? TXN_ERROR
2021 : soft_errors
? TXN_TRY_AGAIN
2025 ovsdb_idl_txn_complete(txn
, status
);
2029 struct ovsdb_idl_txn
*
2030 ovsdb_idl_txn_get(const struct ovsdb_idl_row
*row
)
2032 struct ovsdb_idl_txn
*txn
= row
->table
->idl
->txn
;
2033 assert(txn
!= NULL
);
2038 ovsdb_idl_txn_get_idl (struct ovsdb_idl_txn
*txn
)