1 /* Copyright (c) 2009, 2010, 2011, 2012 Nicira, Inc.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
18 #include "ovsdb-idl.h"
27 #include "dynamic-string.h"
28 #include "fatal-signal.h"
31 #include "ovsdb-data.h"
32 #include "ovsdb-error.h"
33 #include "ovsdb-idl-provider.h"
34 #include "poll-loop.h"
39 VLOG_DEFINE_THIS_MODULE(ovsdb_idl
);
41 /* An arc from one idl_row to another. When row A contains a UUID that
42 * references row B, this is represented by an arc from A (the source) to B
45 * Arcs from a row to itself are omitted, that is, src and dst are always
48 * Arcs are never duplicated, that is, even if there are multiple references
49 * from A to B, there is only a single arc from A to B.
51 * Arcs are directed: an arc from A to B is the converse of an an arc from B to
52 * A. Both an arc and its converse may both be present, if each row refers
53 * to the other circularly.
55 * The source and destination row may be in the same table or in different
58 struct ovsdb_idl_arc
{
59 struct list src_node
; /* In src->src_arcs list. */
60 struct list dst_node
; /* In dst->dst_arcs list. */
61 struct ovsdb_idl_row
*src
; /* Source row. */
62 struct ovsdb_idl_row
*dst
; /* Destination row. */
66 const struct ovsdb_idl_class
*class;
67 struct jsonrpc_session
*session
;
68 struct shash table_by_name
;
69 struct ovsdb_idl_table
*tables
; /* Contains "struct ovsdb_idl_table *"s.*/
70 struct json
*monitor_request_id
;
71 unsigned int last_monitor_request_seqno
;
72 unsigned int change_seqno
;
74 /* Database locking. */
75 char *lock_name
; /* Name of lock we need, NULL if none. */
76 bool has_lock
; /* Has db server told us we have the lock? */
77 bool is_lock_contended
; /* Has db server told us we can't get lock? */
78 struct json
*lock_request_id
; /* JSON-RPC ID of in-flight lock request. */
80 /* Transaction support. */
81 struct ovsdb_idl_txn
*txn
;
82 struct hmap outstanding_txns
;
85 struct ovsdb_idl_txn
{
86 struct hmap_node hmap_node
;
87 struct json
*request_id
;
88 struct ovsdb_idl
*idl
;
90 enum ovsdb_idl_txn_status status
;
94 unsigned int commit_seqno
;
97 const char *inc_table
;
98 const char *inc_column
;
100 unsigned int inc_index
;
101 int64_t inc_new_value
;
104 struct hmap inserted_rows
; /* Contains "struct ovsdb_idl_txn_insert"s. */
107 struct ovsdb_idl_txn_insert
{
108 struct hmap_node hmap_node
; /* In struct ovsdb_idl_txn's inserted_rows. */
109 struct uuid dummy
; /* Dummy UUID used locally. */
110 int op_index
; /* Index into transaction's operation array. */
111 struct uuid real
; /* Real UUID used by database server. */
114 static struct vlog_rate_limit syntax_rl
= VLOG_RATE_LIMIT_INIT(1, 5);
115 static struct vlog_rate_limit semantic_rl
= VLOG_RATE_LIMIT_INIT(1, 5);
117 static void ovsdb_idl_clear(struct ovsdb_idl
*);
118 static void ovsdb_idl_send_monitor_request(struct ovsdb_idl
*);
119 static void ovsdb_idl_parse_update(struct ovsdb_idl
*, const struct json
*);
120 static struct ovsdb_error
*ovsdb_idl_parse_update__(struct ovsdb_idl
*,
121 const struct json
*);
122 static bool ovsdb_idl_process_update(struct ovsdb_idl_table
*,
124 const struct json
*old
,
125 const struct json
*new);
126 static void ovsdb_idl_insert_row(struct ovsdb_idl_row
*, const struct json
*);
127 static void ovsdb_idl_delete_row(struct ovsdb_idl_row
*);
128 static bool ovsdb_idl_modify_row(struct ovsdb_idl_row
*, const struct json
*);
130 static bool ovsdb_idl_row_is_orphan(const struct ovsdb_idl_row
*);
131 static struct ovsdb_idl_row
*ovsdb_idl_row_create__(
132 const struct ovsdb_idl_table_class
*);
133 static struct ovsdb_idl_row
*ovsdb_idl_row_create(struct ovsdb_idl_table
*,
134 const struct uuid
*);
135 static void ovsdb_idl_row_destroy(struct ovsdb_idl_row
*);
137 static void ovsdb_idl_row_parse(struct ovsdb_idl_row
*);
138 static void ovsdb_idl_row_unparse(struct ovsdb_idl_row
*);
139 static void ovsdb_idl_row_clear_old(struct ovsdb_idl_row
*);
140 static void ovsdb_idl_row_clear_new(struct ovsdb_idl_row
*);
142 static void ovsdb_idl_txn_abort_all(struct ovsdb_idl
*);
143 static bool ovsdb_idl_txn_process_reply(struct ovsdb_idl
*,
144 const struct jsonrpc_msg
*msg
);
146 static void ovsdb_idl_send_lock_request(struct ovsdb_idl
*);
147 static void ovsdb_idl_send_unlock_request(struct ovsdb_idl
*);
148 static void ovsdb_idl_parse_lock_reply(struct ovsdb_idl
*,
149 const struct json
*);
150 static void ovsdb_idl_parse_lock_notify(struct ovsdb_idl
*,
151 const struct json
*params
,
154 /* Creates and returns a connection to database 'remote', which should be in a
155 * form acceptable to jsonrpc_session_open(). The connection will maintain an
156 * in-memory replica of the remote database whose schema is described by
157 * 'class'. (Ordinarily 'class' is compiled from an OVSDB schema automatically
160 * If 'monitor_everything_by_default' is true, then everything in the remote
161 * database will be replicated by default. ovsdb_idl_omit() and
162 * ovsdb_idl_omit_alert() may be used to selectively drop some columns from
165 * If 'monitor_everything_by_default' is false, then no columns or tables will
166 * be replicated by default. ovsdb_idl_add_column() and ovsdb_idl_add_table()
167 * must be used to choose some columns or tables to replicate.
170 ovsdb_idl_create(const char *remote
, const struct ovsdb_idl_class
*class,
171 bool monitor_everything_by_default
)
173 struct ovsdb_idl
*idl
;
174 uint8_t default_mode
;
177 default_mode
= (monitor_everything_by_default
178 ? OVSDB_IDL_MONITOR
| OVSDB_IDL_ALERT
181 idl
= xzalloc(sizeof *idl
);
183 idl
->session
= jsonrpc_session_open(remote
);
184 shash_init(&idl
->table_by_name
);
185 idl
->tables
= xmalloc(class->n_tables
* sizeof *idl
->tables
);
186 for (i
= 0; i
< class->n_tables
; i
++) {
187 const struct ovsdb_idl_table_class
*tc
= &class->tables
[i
];
188 struct ovsdb_idl_table
*table
= &idl
->tables
[i
];
191 shash_add_assert(&idl
->table_by_name
, tc
->name
, table
);
193 table
->modes
= xmalloc(tc
->n_columns
);
194 memset(table
->modes
, default_mode
, tc
->n_columns
);
195 table
->need_table
= false;
196 shash_init(&table
->columns
);
197 for (j
= 0; j
< tc
->n_columns
; j
++) {
198 const struct ovsdb_idl_column
*column
= &tc
->columns
[j
];
200 shash_add_assert(&table
->columns
, column
->name
, column
);
202 hmap_init(&table
->rows
);
205 idl
->last_monitor_request_seqno
= UINT_MAX
;
206 hmap_init(&idl
->outstanding_txns
);
211 /* Destroys 'idl' and all of the data structures that it manages. */
213 ovsdb_idl_destroy(struct ovsdb_idl
*idl
)
219 ovsdb_idl_clear(idl
);
220 jsonrpc_session_close(idl
->session
);
222 for (i
= 0; i
< idl
->class->n_tables
; i
++) {
223 struct ovsdb_idl_table
*table
= &idl
->tables
[i
];
224 shash_destroy(&table
->columns
);
225 hmap_destroy(&table
->rows
);
228 shash_destroy(&idl
->table_by_name
);
230 json_destroy(idl
->monitor_request_id
);
231 free(idl
->lock_name
);
232 json_destroy(idl
->lock_request_id
);
238 ovsdb_idl_clear(struct ovsdb_idl
*idl
)
240 bool changed
= false;
243 for (i
= 0; i
< idl
->class->n_tables
; i
++) {
244 struct ovsdb_idl_table
*table
= &idl
->tables
[i
];
245 struct ovsdb_idl_row
*row
, *next_row
;
247 if (hmap_is_empty(&table
->rows
)) {
252 HMAP_FOR_EACH_SAFE (row
, next_row
, hmap_node
, &table
->rows
) {
253 struct ovsdb_idl_arc
*arc
, *next_arc
;
255 if (!ovsdb_idl_row_is_orphan(row
)) {
256 ovsdb_idl_row_unparse(row
);
258 LIST_FOR_EACH_SAFE (arc
, next_arc
, src_node
, &row
->src_arcs
) {
261 /* No need to do anything with dst_arcs: some node has those arcs
262 * as forward arcs and will destroy them itself. */
264 ovsdb_idl_row_destroy(row
);
273 /* Processes a batch of messages from the database server on 'idl'. This may
274 * cause the IDL's contents to change. The client may check for that with
275 * ovsdb_idl_get_seqno(). */
277 ovsdb_idl_run(struct ovsdb_idl
*idl
)
282 jsonrpc_session_run(idl
->session
);
283 for (i
= 0; jsonrpc_session_is_connected(idl
->session
) && i
< 50; i
++) {
284 struct jsonrpc_msg
*msg
;
287 seqno
= jsonrpc_session_get_seqno(idl
->session
);
288 if (idl
->last_monitor_request_seqno
!= seqno
) {
289 idl
->last_monitor_request_seqno
= seqno
;
290 ovsdb_idl_txn_abort_all(idl
);
291 ovsdb_idl_send_monitor_request(idl
);
292 if (idl
->lock_name
) {
293 ovsdb_idl_send_lock_request(idl
);
298 msg
= jsonrpc_session_recv(idl
->session
);
303 if (msg
->type
== JSONRPC_NOTIFY
304 && !strcmp(msg
->method
, "update")
305 && msg
->params
->type
== JSON_ARRAY
306 && msg
->params
->u
.array
.n
== 2
307 && msg
->params
->u
.array
.elems
[0]->type
== JSON_NULL
) {
308 /* Database contents changed. */
309 ovsdb_idl_parse_update(idl
, msg
->params
->u
.array
.elems
[1]);
310 } else if (msg
->type
== JSONRPC_REPLY
311 && idl
->monitor_request_id
312 && json_equal(idl
->monitor_request_id
, msg
->id
)) {
313 /* Reply to our "monitor" request. */
315 json_destroy(idl
->monitor_request_id
);
316 idl
->monitor_request_id
= NULL
;
317 ovsdb_idl_clear(idl
);
318 ovsdb_idl_parse_update(idl
, msg
->result
);
319 } else if (msg
->type
== JSONRPC_REPLY
320 && idl
->lock_request_id
321 && json_equal(idl
->lock_request_id
, msg
->id
)) {
322 /* Reply to our "lock" request. */
323 ovsdb_idl_parse_lock_reply(idl
, msg
->result
);
324 } else if (msg
->type
== JSONRPC_NOTIFY
325 && !strcmp(msg
->method
, "locked")) {
326 /* We got our lock. */
327 ovsdb_idl_parse_lock_notify(idl
, msg
->params
, true);
328 } else if (msg
->type
== JSONRPC_NOTIFY
329 && !strcmp(msg
->method
, "stolen")) {
330 /* Someone else stole our lock. */
331 ovsdb_idl_parse_lock_notify(idl
, msg
->params
, false);
332 } else if (msg
->type
== JSONRPC_REPLY
&& msg
->id
->type
== JSON_STRING
333 && !strcmp(msg
->id
->u
.string
, "echo")) {
334 /* Reply to our echo request. Ignore it. */
335 } else if ((msg
->type
== JSONRPC_ERROR
336 || msg
->type
== JSONRPC_REPLY
)
337 && ovsdb_idl_txn_process_reply(idl
, msg
)) {
338 /* ovsdb_idl_txn_process_reply() did everything needful. */
340 /* This can happen if ovsdb_idl_txn_destroy() is called to destroy
341 * a transaction before we receive the reply, so keep the log level
343 VLOG_DBG("%s: received unexpected %s message",
344 jsonrpc_session_get_name(idl
->session
),
345 jsonrpc_msg_type_to_string(msg
->type
));
347 jsonrpc_msg_destroy(msg
);
351 /* Arranges for poll_block() to wake up when ovsdb_idl_run() has something to
352 * do or when activity occurs on a transaction on 'idl'. */
354 ovsdb_idl_wait(struct ovsdb_idl
*idl
)
356 jsonrpc_session_wait(idl
->session
);
357 jsonrpc_session_recv_wait(idl
->session
);
360 /* Returns a "sequence number" that represents the state of 'idl'. When
361 * ovsdb_idl_run() changes the database, the sequence number changes. The
362 * initial fetch of the entire contents of the remote database is considered to
363 * be one kind of change. Successfully acquiring a lock, if one has been
364 * configured with ovsdb_idl_set_lock(), is also considered to be a change.
366 * As long as the sequence number does not change, the client may continue to
367 * use any data structures it obtains from 'idl'. But when it changes, the
368 * client must not access any of these data structures again, because they
369 * could have freed or reused for other purposes.
371 * The sequence number can occasionally change even if the database does not.
372 * This happens if the connection to the database drops and reconnects, which
373 * causes the database contents to be reloaded even if they didn't change. (It
374 * could also happen if the database server sends out a "change" that reflects
375 * what the IDL already thought was in the database. The database server is
376 * not supposed to do that, but bugs could in theory cause it to do so.) */
378 ovsdb_idl_get_seqno(const struct ovsdb_idl
*idl
)
380 return idl
->change_seqno
;
383 /* Returns true if 'idl' successfully connected to the remote database and
384 * retrieved its contents (even if the connection subsequently dropped and is
385 * in the process of reconnecting). If so, then 'idl' contains an atomic
386 * snapshot of the database's contents (but it might be arbitrarily old if the
387 * connection dropped).
389 * Returns false if 'idl' has never connected or retrieved the database's
390 * contents. If so, 'idl' is empty. */
392 ovsdb_idl_has_ever_connected(const struct ovsdb_idl
*idl
)
394 return ovsdb_idl_get_seqno(idl
) != 0;
397 /* Forces 'idl' to drop its connection to the database and reconnect. In the
398 * meantime, the contents of 'idl' will not change. */
400 ovsdb_idl_force_reconnect(struct ovsdb_idl
*idl
)
402 jsonrpc_session_force_reconnect(idl
->session
);
405 static unsigned char *
406 ovsdb_idl_get_mode(struct ovsdb_idl
*idl
,
407 const struct ovsdb_idl_column
*column
)
411 assert(!idl
->change_seqno
);
413 for (i
= 0; i
< idl
->class->n_tables
; i
++) {
414 const struct ovsdb_idl_table
*table
= &idl
->tables
[i
];
415 const struct ovsdb_idl_table_class
*tc
= table
->class;
417 if (column
>= tc
->columns
&& column
< &tc
->columns
[tc
->n_columns
]) {
418 return &table
->modes
[column
- tc
->columns
];
426 add_ref_table(struct ovsdb_idl
*idl
, const struct ovsdb_base_type
*base
)
428 if (base
->type
== OVSDB_TYPE_UUID
&& base
->u
.uuid
.refTableName
) {
429 struct ovsdb_idl_table
*table
;
431 table
= shash_find_data(&idl
->table_by_name
,
432 base
->u
.uuid
.refTableName
);
434 table
->need_table
= true;
436 VLOG_WARN("%s IDL class missing referenced table %s",
437 idl
->class->database
, base
->u
.uuid
.refTableName
);
442 /* Turns on OVSDB_IDL_MONITOR and OVSDB_IDL_ALERT for 'column' in 'idl'. Also
443 * ensures that any tables referenced by 'column' will be replicated, even if
444 * no columns in that table are selected for replication (see
445 * ovsdb_idl_add_table() for more information).
447 * This function is only useful if 'monitor_everything_by_default' was false in
448 * the call to ovsdb_idl_create(). This function should be called between
449 * ovsdb_idl_create() and the first call to ovsdb_idl_run().
452 ovsdb_idl_add_column(struct ovsdb_idl
*idl
,
453 const struct ovsdb_idl_column
*column
)
455 *ovsdb_idl_get_mode(idl
, column
) = OVSDB_IDL_MONITOR
| OVSDB_IDL_ALERT
;
456 add_ref_table(idl
, &column
->type
.key
);
457 add_ref_table(idl
, &column
->type
.value
);
460 /* Ensures that the table with class 'tc' will be replicated on 'idl' even if
461 * no columns are selected for replication. This can be useful because it
462 * allows 'idl' to keep track of what rows in the table actually exist, which
463 * in turn allows columns that reference the table to have accurate contents.
464 * (The IDL presents the database with references to rows that do not exist
467 * This function is only useful if 'monitor_everything_by_default' was false in
468 * the call to ovsdb_idl_create(). This function should be called between
469 * ovsdb_idl_create() and the first call to ovsdb_idl_run().
472 ovsdb_idl_add_table(struct ovsdb_idl
*idl
,
473 const struct ovsdb_idl_table_class
*tc
)
477 for (i
= 0; i
< idl
->class->n_tables
; i
++) {
478 struct ovsdb_idl_table
*table
= &idl
->tables
[i
];
480 if (table
->class == tc
) {
481 table
->need_table
= true;
489 /* Turns off OVSDB_IDL_ALERT for 'column' in 'idl'.
491 * This function should be called between ovsdb_idl_create() and the first call
492 * to ovsdb_idl_run().
495 ovsdb_idl_omit_alert(struct ovsdb_idl
*idl
,
496 const struct ovsdb_idl_column
*column
)
498 *ovsdb_idl_get_mode(idl
, column
) &= ~OVSDB_IDL_ALERT
;
501 /* Sets the mode for 'column' in 'idl' to 0. See the big comment above
502 * OVSDB_IDL_MONITOR for details.
504 * This function should be called between ovsdb_idl_create() and the first call
505 * to ovsdb_idl_run().
508 ovsdb_idl_omit(struct ovsdb_idl
*idl
, const struct ovsdb_idl_column
*column
)
510 *ovsdb_idl_get_mode(idl
, column
) = 0;
514 ovsdb_idl_send_monitor_request(struct ovsdb_idl
*idl
)
516 struct json
*monitor_requests
;
517 struct jsonrpc_msg
*msg
;
520 monitor_requests
= json_object_create();
521 for (i
= 0; i
< idl
->class->n_tables
; i
++) {
522 const struct ovsdb_idl_table
*table
= &idl
->tables
[i
];
523 const struct ovsdb_idl_table_class
*tc
= table
->class;
524 struct json
*monitor_request
, *columns
;
527 columns
= table
->need_table
? json_array_create_empty() : NULL
;
528 for (j
= 0; j
< tc
->n_columns
; j
++) {
529 const struct ovsdb_idl_column
*column
= &tc
->columns
[j
];
530 if (table
->modes
[j
] & OVSDB_IDL_MONITOR
) {
532 columns
= json_array_create_empty();
534 json_array_add(columns
, json_string_create(column
->name
));
539 monitor_request
= json_object_create();
540 json_object_put(monitor_request
, "columns", columns
);
541 json_object_put(monitor_requests
, tc
->name
, monitor_request
);
545 json_destroy(idl
->monitor_request_id
);
546 msg
= jsonrpc_create_request(
548 json_array_create_3(json_string_create(idl
->class->database
),
549 json_null_create(), monitor_requests
),
550 &idl
->monitor_request_id
);
551 jsonrpc_session_send(idl
->session
, msg
);
555 ovsdb_idl_parse_update(struct ovsdb_idl
*idl
, const struct json
*table_updates
)
557 struct ovsdb_error
*error
= ovsdb_idl_parse_update__(idl
, table_updates
);
559 if (!VLOG_DROP_WARN(&syntax_rl
)) {
560 char *s
= ovsdb_error_to_string(error
);
561 VLOG_WARN_RL(&syntax_rl
, "%s", s
);
564 ovsdb_error_destroy(error
);
568 static struct ovsdb_error
*
569 ovsdb_idl_parse_update__(struct ovsdb_idl
*idl
,
570 const struct json
*table_updates
)
572 const struct shash_node
*tables_node
;
574 if (table_updates
->type
!= JSON_OBJECT
) {
575 return ovsdb_syntax_error(table_updates
, NULL
,
576 "<table-updates> is not an object");
578 SHASH_FOR_EACH (tables_node
, json_object(table_updates
)) {
579 const struct json
*table_update
= tables_node
->data
;
580 const struct shash_node
*table_node
;
581 struct ovsdb_idl_table
*table
;
583 table
= shash_find_data(&idl
->table_by_name
, tables_node
->name
);
585 return ovsdb_syntax_error(
587 "<table-updates> includes unknown table \"%s\"",
591 if (table_update
->type
!= JSON_OBJECT
) {
592 return ovsdb_syntax_error(table_update
, NULL
,
593 "<table-update> for table \"%s\" is "
594 "not an object", table
->class->name
);
596 SHASH_FOR_EACH (table_node
, json_object(table_update
)) {
597 const struct json
*row_update
= table_node
->data
;
598 const struct json
*old_json
, *new_json
;
601 if (!uuid_from_string(&uuid
, table_node
->name
)) {
602 return ovsdb_syntax_error(table_update
, NULL
,
603 "<table-update> for table \"%s\" "
605 "\"%s\" as member name",
609 if (row_update
->type
!= JSON_OBJECT
) {
610 return ovsdb_syntax_error(row_update
, NULL
,
611 "<table-update> for table \"%s\" "
612 "contains <row-update> for %s that "
618 old_json
= shash_find_data(json_object(row_update
), "old");
619 new_json
= shash_find_data(json_object(row_update
), "new");
620 if (old_json
&& old_json
->type
!= JSON_OBJECT
) {
621 return ovsdb_syntax_error(old_json
, NULL
,
622 "\"old\" <row> is not object");
623 } else if (new_json
&& new_json
->type
!= JSON_OBJECT
) {
624 return ovsdb_syntax_error(new_json
, NULL
,
625 "\"new\" <row> is not object");
626 } else if ((old_json
!= NULL
) + (new_json
!= NULL
)
627 != shash_count(json_object(row_update
))) {
628 return ovsdb_syntax_error(row_update
, NULL
,
629 "<row-update> contains unexpected "
631 } else if (!old_json
&& !new_json
) {
632 return ovsdb_syntax_error(row_update
, NULL
,
633 "<row-update> missing \"old\" "
634 "and \"new\" members");
637 if (ovsdb_idl_process_update(table
, &uuid
, old_json
, new_json
)) {
646 static struct ovsdb_idl_row
*
647 ovsdb_idl_get_row(struct ovsdb_idl_table
*table
, const struct uuid
*uuid
)
649 struct ovsdb_idl_row
*row
;
651 HMAP_FOR_EACH_WITH_HASH (row
, hmap_node
, uuid_hash(uuid
), &table
->rows
) {
652 if (uuid_equals(&row
->uuid
, uuid
)) {
659 /* Returns true if a column with mode OVSDB_IDL_MODE_RW changed, false
662 ovsdb_idl_process_update(struct ovsdb_idl_table
*table
,
663 const struct uuid
*uuid
, const struct json
*old
,
664 const struct json
*new)
666 struct ovsdb_idl_row
*row
;
668 row
= ovsdb_idl_get_row(table
, uuid
);
671 if (row
&& !ovsdb_idl_row_is_orphan(row
)) {
672 /* XXX perhaps we should check the 'old' values? */
673 ovsdb_idl_delete_row(row
);
675 VLOG_WARN_RL(&semantic_rl
, "cannot delete missing row "UUID_FMT
" "
677 UUID_ARGS(uuid
), table
->class->name
);
683 ovsdb_idl_insert_row(ovsdb_idl_row_create(table
, uuid
), new);
684 } else if (ovsdb_idl_row_is_orphan(row
)) {
685 ovsdb_idl_insert_row(row
, new);
687 VLOG_WARN_RL(&semantic_rl
, "cannot add existing row "UUID_FMT
" to "
688 "table %s", UUID_ARGS(uuid
), table
->class->name
);
689 return ovsdb_idl_modify_row(row
, new);
694 /* XXX perhaps we should check the 'old' values? */
695 if (!ovsdb_idl_row_is_orphan(row
)) {
696 return ovsdb_idl_modify_row(row
, new);
698 VLOG_WARN_RL(&semantic_rl
, "cannot modify missing but "
699 "referenced row "UUID_FMT
" in table %s",
700 UUID_ARGS(uuid
), table
->class->name
);
701 ovsdb_idl_insert_row(row
, new);
704 VLOG_WARN_RL(&semantic_rl
, "cannot modify missing row "UUID_FMT
" "
705 "in table %s", UUID_ARGS(uuid
), table
->class->name
);
706 ovsdb_idl_insert_row(ovsdb_idl_row_create(table
, uuid
), new);
713 /* Returns true if a column with mode OVSDB_IDL_MODE_RW changed, false
716 ovsdb_idl_row_update(struct ovsdb_idl_row
*row
, const struct json
*row_json
)
718 struct ovsdb_idl_table
*table
= row
->table
;
719 struct shash_node
*node
;
720 bool changed
= false;
722 SHASH_FOR_EACH (node
, json_object(row_json
)) {
723 const char *column_name
= node
->name
;
724 const struct ovsdb_idl_column
*column
;
725 struct ovsdb_datum datum
;
726 struct ovsdb_error
*error
;
728 column
= shash_find_data(&table
->columns
, column_name
);
730 VLOG_WARN_RL(&syntax_rl
, "unknown column %s updating row "UUID_FMT
,
731 column_name
, UUID_ARGS(&row
->uuid
));
735 error
= ovsdb_datum_from_json(&datum
, &column
->type
, node
->data
, NULL
);
737 unsigned int column_idx
= column
- table
->class->columns
;
738 struct ovsdb_datum
*old
= &row
->old
[column_idx
];
740 if (!ovsdb_datum_equals(old
, &datum
, &column
->type
)) {
741 ovsdb_datum_swap(old
, &datum
);
742 if (table
->modes
[column_idx
] & OVSDB_IDL_ALERT
) {
746 /* Didn't really change but the OVSDB monitor protocol always
747 * includes every value in a row. */
750 ovsdb_datum_destroy(&datum
, &column
->type
);
752 char *s
= ovsdb_error_to_string(error
);
753 VLOG_WARN_RL(&syntax_rl
, "error parsing column %s in row "UUID_FMT
754 " in table %s: %s", column_name
,
755 UUID_ARGS(&row
->uuid
), table
->class->name
, s
);
757 ovsdb_error_destroy(error
);
763 /* When a row A refers to row B through a column with a "refTable" constraint,
764 * but row B does not exist, row B is called an "orphan row". Orphan rows
765 * should not persist, because the database enforces referential integrity, but
766 * they can appear transiently as changes from the database are received (the
767 * database doesn't try to topologically sort them and circular references mean
768 * it isn't always possible anyhow).
770 * This function returns true if 'row' is an orphan row, otherwise false.
773 ovsdb_idl_row_is_orphan(const struct ovsdb_idl_row
*row
)
775 return !row
->old
&& !row
->new;
778 /* Returns true if 'row' is conceptually part of the database as modified by
779 * the current transaction (if any), false otherwise.
781 * This function will return true if 'row' is not an orphan (see the comment on
782 * ovsdb_idl_row_is_orphan()) and:
784 * - 'row' exists in the database and has not been deleted within the
785 * current transaction (if any).
787 * - 'row' was inserted within the current transaction and has not been
788 * deleted. (In the latter case you should not have passed 'row' in at
789 * all, because ovsdb_idl_txn_delete() freed it.)
791 * This function will return false if 'row' is an orphan or if 'row' was
792 * deleted within the current transaction.
795 ovsdb_idl_row_exists(const struct ovsdb_idl_row
*row
)
797 return row
->new != NULL
;
801 ovsdb_idl_row_parse(struct ovsdb_idl_row
*row
)
803 const struct ovsdb_idl_table_class
*class = row
->table
->class;
806 for (i
= 0; i
< class->n_columns
; i
++) {
807 const struct ovsdb_idl_column
*c
= &class->columns
[i
];
808 (c
->parse
)(row
, &row
->old
[i
]);
813 ovsdb_idl_row_unparse(struct ovsdb_idl_row
*row
)
815 const struct ovsdb_idl_table_class
*class = row
->table
->class;
818 for (i
= 0; i
< class->n_columns
; i
++) {
819 const struct ovsdb_idl_column
*c
= &class->columns
[i
];
825 ovsdb_idl_row_clear_old(struct ovsdb_idl_row
*row
)
827 assert(row
->old
== row
->new);
828 if (!ovsdb_idl_row_is_orphan(row
)) {
829 const struct ovsdb_idl_table_class
*class = row
->table
->class;
832 for (i
= 0; i
< class->n_columns
; i
++) {
833 ovsdb_datum_destroy(&row
->old
[i
], &class->columns
[i
].type
);
836 row
->old
= row
->new = NULL
;
841 ovsdb_idl_row_clear_new(struct ovsdb_idl_row
*row
)
843 if (row
->old
!= row
->new) {
845 const struct ovsdb_idl_table_class
*class = row
->table
->class;
849 BITMAP_FOR_EACH_1 (i
, class->n_columns
, row
->written
) {
850 ovsdb_datum_destroy(&row
->new[i
], &class->columns
[i
].type
);
862 ovsdb_idl_row_clear_arcs(struct ovsdb_idl_row
*row
, bool destroy_dsts
)
864 struct ovsdb_idl_arc
*arc
, *next
;
866 /* Delete all forward arcs. If 'destroy_dsts', destroy any orphaned rows
867 * that this causes to be unreferenced. */
868 LIST_FOR_EACH_SAFE (arc
, next
, src_node
, &row
->src_arcs
) {
869 list_remove(&arc
->dst_node
);
871 && ovsdb_idl_row_is_orphan(arc
->dst
)
872 && list_is_empty(&arc
->dst
->dst_arcs
)) {
873 ovsdb_idl_row_destroy(arc
->dst
);
877 list_init(&row
->src_arcs
);
880 /* Force nodes that reference 'row' to reparse. */
882 ovsdb_idl_row_reparse_backrefs(struct ovsdb_idl_row
*row
)
884 struct ovsdb_idl_arc
*arc
, *next
;
886 /* This is trickier than it looks. ovsdb_idl_row_clear_arcs() will destroy
887 * 'arc', so we need to use the "safe" variant of list traversal. However,
888 * calling an ovsdb_idl_column's 'parse' function will add an arc
889 * equivalent to 'arc' to row->arcs. That could be a problem for
890 * traversal, but it adds it at the beginning of the list to prevent us
891 * from stumbling upon it again.
893 * (If duplicate arcs were possible then we would need to make sure that
894 * 'next' didn't also point into 'arc''s destination, but we forbid
895 * duplicate arcs.) */
896 LIST_FOR_EACH_SAFE (arc
, next
, dst_node
, &row
->dst_arcs
) {
897 struct ovsdb_idl_row
*ref
= arc
->src
;
899 ovsdb_idl_row_unparse(ref
);
900 ovsdb_idl_row_clear_arcs(ref
, false);
901 ovsdb_idl_row_parse(ref
);
905 static struct ovsdb_idl_row
*
906 ovsdb_idl_row_create__(const struct ovsdb_idl_table_class
*class)
908 struct ovsdb_idl_row
*row
= xzalloc(class->allocation_size
);
909 list_init(&row
->src_arcs
);
910 list_init(&row
->dst_arcs
);
911 hmap_node_nullify(&row
->txn_node
);
915 static struct ovsdb_idl_row
*
916 ovsdb_idl_row_create(struct ovsdb_idl_table
*table
, const struct uuid
*uuid
)
918 struct ovsdb_idl_row
*row
= ovsdb_idl_row_create__(table
->class);
919 hmap_insert(&table
->rows
, &row
->hmap_node
, uuid_hash(uuid
));
926 ovsdb_idl_row_destroy(struct ovsdb_idl_row
*row
)
929 ovsdb_idl_row_clear_old(row
);
930 hmap_remove(&row
->table
->rows
, &row
->hmap_node
);
936 ovsdb_idl_insert_row(struct ovsdb_idl_row
*row
, const struct json
*row_json
)
938 const struct ovsdb_idl_table_class
*class = row
->table
->class;
941 assert(!row
->old
&& !row
->new);
942 row
->old
= row
->new = xmalloc(class->n_columns
* sizeof *row
->old
);
943 for (i
= 0; i
< class->n_columns
; i
++) {
944 ovsdb_datum_init_default(&row
->old
[i
], &class->columns
[i
].type
);
946 ovsdb_idl_row_update(row
, row_json
);
947 ovsdb_idl_row_parse(row
);
949 ovsdb_idl_row_reparse_backrefs(row
);
953 ovsdb_idl_delete_row(struct ovsdb_idl_row
*row
)
955 ovsdb_idl_row_unparse(row
);
956 ovsdb_idl_row_clear_arcs(row
, true);
957 ovsdb_idl_row_clear_old(row
);
958 if (list_is_empty(&row
->dst_arcs
)) {
959 ovsdb_idl_row_destroy(row
);
961 ovsdb_idl_row_reparse_backrefs(row
);
965 /* Returns true if a column with mode OVSDB_IDL_MODE_RW changed, false
968 ovsdb_idl_modify_row(struct ovsdb_idl_row
*row
, const struct json
*row_json
)
972 ovsdb_idl_row_unparse(row
);
973 ovsdb_idl_row_clear_arcs(row
, true);
974 changed
= ovsdb_idl_row_update(row
, row_json
);
975 ovsdb_idl_row_parse(row
);
981 may_add_arc(const struct ovsdb_idl_row
*src
, const struct ovsdb_idl_row
*dst
)
983 const struct ovsdb_idl_arc
*arc
;
990 /* No duplicate arcs.
992 * We only need to test whether the first arc in dst->dst_arcs originates
993 * at 'src', since we add all of the arcs from a given source in a clump
994 * (in a single call to ovsdb_idl_row_parse()) and new arcs are always
995 * added at the front of the dst_arcs list. */
996 if (list_is_empty(&dst
->dst_arcs
)) {
999 arc
= CONTAINER_OF(dst
->dst_arcs
.next
, struct ovsdb_idl_arc
, dst_node
);
1000 return arc
->src
!= src
;
1003 static struct ovsdb_idl_table
*
1004 ovsdb_idl_table_from_class(const struct ovsdb_idl
*idl
,
1005 const struct ovsdb_idl_table_class
*table_class
)
1007 return &idl
->tables
[table_class
- idl
->class->tables
];
1010 /* Called by ovsdb-idlc generated code. */
1011 struct ovsdb_idl_row
*
1012 ovsdb_idl_get_row_arc(struct ovsdb_idl_row
*src
,
1013 struct ovsdb_idl_table_class
*dst_table_class
,
1014 const struct uuid
*dst_uuid
)
1016 struct ovsdb_idl
*idl
= src
->table
->idl
;
1017 struct ovsdb_idl_table
*dst_table
;
1018 struct ovsdb_idl_arc
*arc
;
1019 struct ovsdb_idl_row
*dst
;
1021 dst_table
= ovsdb_idl_table_from_class(idl
, dst_table_class
);
1022 dst
= ovsdb_idl_get_row(dst_table
, dst_uuid
);
1024 /* We're being called from ovsdb_idl_txn_write(). We must not update
1025 * any arcs, because the transaction will be backed out at commit or
1026 * abort time and we don't want our graph screwed up.
1028 * Just return the destination row, if there is one and it has not been
1030 if (dst
&& (hmap_node_is_null(&dst
->txn_node
) || dst
->new)) {
1035 /* We're being called from some other context. Update the graph. */
1037 dst
= ovsdb_idl_row_create(dst_table
, dst_uuid
);
1040 /* Add a new arc, if it wouldn't be a self-arc or a duplicate arc. */
1041 if (may_add_arc(src
, dst
)) {
1042 /* The arc *must* be added at the front of the dst_arcs list. See
1043 * ovsdb_idl_row_reparse_backrefs() for details. */
1044 arc
= xmalloc(sizeof *arc
);
1045 list_push_front(&src
->src_arcs
, &arc
->src_node
);
1046 list_push_front(&dst
->dst_arcs
, &arc
->dst_node
);
1051 return !ovsdb_idl_row_is_orphan(dst
) ? dst
: NULL
;
1055 /* Searches 'tc''s table in 'idl' for a row with UUID 'uuid'. Returns a
1056 * pointer to the row if there is one, otherwise a null pointer. */
1057 const struct ovsdb_idl_row
*
1058 ovsdb_idl_get_row_for_uuid(const struct ovsdb_idl
*idl
,
1059 const struct ovsdb_idl_table_class
*tc
,
1060 const struct uuid
*uuid
)
1062 return ovsdb_idl_get_row(ovsdb_idl_table_from_class(idl
, tc
), uuid
);
1065 static struct ovsdb_idl_row
*
1066 next_real_row(struct ovsdb_idl_table
*table
, struct hmap_node
*node
)
1068 for (; node
; node
= hmap_next(&table
->rows
, node
)) {
1069 struct ovsdb_idl_row
*row
;
1071 row
= CONTAINER_OF(node
, struct ovsdb_idl_row
, hmap_node
);
1072 if (ovsdb_idl_row_exists(row
)) {
1079 /* Returns a row in 'table_class''s table in 'idl', or a null pointer if that
1082 * Database tables are internally maintained as hash tables, so adding or
1083 * removing rows while traversing the same table can cause some rows to be
1084 * visited twice or not at apply. */
1085 const struct ovsdb_idl_row
*
1086 ovsdb_idl_first_row(const struct ovsdb_idl
*idl
,
1087 const struct ovsdb_idl_table_class
*table_class
)
1089 struct ovsdb_idl_table
*table
1090 = ovsdb_idl_table_from_class(idl
, table_class
);
1091 return next_real_row(table
, hmap_first(&table
->rows
));
1094 /* Returns a row following 'row' within its table, or a null pointer if 'row'
1095 * is the last row in its table. */
1096 const struct ovsdb_idl_row
*
1097 ovsdb_idl_next_row(const struct ovsdb_idl_row
*row
)
1099 struct ovsdb_idl_table
*table
= row
->table
;
1101 return next_real_row(table
, hmap_next(&table
->rows
, &row
->hmap_node
));
1104 /* Reads and returns the value of 'column' within 'row'. If an ongoing
1105 * transaction has changed 'column''s value, the modified value is returned.
1107 * The caller must not modify or free the returned value.
1109 * Various kinds of changes can invalidate the returned value: writing to the
1110 * same 'column' in 'row' (e.g. with ovsdb_idl_txn_write()), deleting 'row'
1111 * (e.g. with ovsdb_idl_txn_delete()), or completing an ongoing transaction
1112 * (e.g. with ovsdb_idl_txn_commit() or ovsdb_idl_txn_abort()). If the
1113 * returned value is needed for a long time, it is best to make a copy of it
1114 * with ovsdb_datum_clone(). */
1115 const struct ovsdb_datum
*
1116 ovsdb_idl_read(const struct ovsdb_idl_row
*row
,
1117 const struct ovsdb_idl_column
*column
)
1119 const struct ovsdb_idl_table_class
*class;
1122 assert(!ovsdb_idl_row_is_synthetic(row
));
1124 class = row
->table
->class;
1125 column_idx
= column
- class->columns
;
1127 assert(row
->new != NULL
);
1128 assert(column_idx
< class->n_columns
);
1130 if (row
->written
&& bitmap_is_set(row
->written
, column_idx
)) {
1131 return &row
->new[column_idx
];
1132 } else if (row
->old
) {
1133 return &row
->old
[column_idx
];
1135 return ovsdb_datum_default(&column
->type
);
1139 /* Same as ovsdb_idl_read(), except that it also asserts that 'column' has key
1140 * type 'key_type' and value type 'value_type'. (Scalar and set types will
1141 * have a value type of OVSDB_TYPE_VOID.)
1143 * This is useful in code that "knows" that a particular column has a given
1144 * type, so that it will abort if someone changes the column's type without
1145 * updating the code that uses it. */
1146 const struct ovsdb_datum
*
1147 ovsdb_idl_get(const struct ovsdb_idl_row
*row
,
1148 const struct ovsdb_idl_column
*column
,
1149 enum ovsdb_atomic_type key_type OVS_UNUSED
,
1150 enum ovsdb_atomic_type value_type OVS_UNUSED
)
1152 assert(column
->type
.key
.type
== key_type
);
1153 assert(column
->type
.value
.type
== value_type
);
1155 return ovsdb_idl_read(row
, column
);
1158 /* Returns false if 'row' was obtained from the IDL, true if it was initialized
1159 * to all-zero-bits by some other entity. If 'row' was set up some other way
1160 * then the return value is indeterminate. */
1162 ovsdb_idl_row_is_synthetic(const struct ovsdb_idl_row
*row
)
1164 return row
->table
== NULL
;
1169 static void ovsdb_idl_txn_complete(struct ovsdb_idl_txn
*txn
,
1170 enum ovsdb_idl_txn_status
);
1172 /* Returns a string representation of 'status'. The caller must not modify or
1173 * free the returned string.
1175 * The return value is probably useful only for debug log messages and unit
1178 ovsdb_idl_txn_status_to_string(enum ovsdb_idl_txn_status status
)
1181 case TXN_UNCOMMITTED
:
1182 return "uncommitted";
1185 case TXN_INCOMPLETE
:
1186 return "incomplete";
1193 case TXN_NOT_LOCKED
:
1194 return "not locked";
1201 /* Starts a new transaction on 'idl'. A given ovsdb_idl may only have a single
1202 * active transaction at a time. See the large comment in ovsdb-idl.h for
1203 * general information on transactions. */
1204 struct ovsdb_idl_txn
*
1205 ovsdb_idl_txn_create(struct ovsdb_idl
*idl
)
1207 struct ovsdb_idl_txn
*txn
;
1210 idl
->txn
= txn
= xmalloc(sizeof *txn
);
1211 txn
->request_id
= NULL
;
1213 hmap_init(&txn
->txn_rows
);
1214 txn
->status
= TXN_UNCOMMITTED
;
1216 txn
->dry_run
= false;
1217 ds_init(&txn
->comment
);
1218 txn
->commit_seqno
= txn
->idl
->change_seqno
;
1220 txn
->inc_table
= NULL
;
1221 txn
->inc_column
= NULL
;
1223 hmap_init(&txn
->inserted_rows
);
1228 /* Appends 's', which is treated as a printf()-type format string, to the
1229 * comments that will be passed to the OVSDB server when 'txn' is committed.
1230 * (The comment will be committed to the OVSDB log, which "ovsdb-tool
1231 * show-log" can print in a relatively human-readable form.) */
1233 ovsdb_idl_txn_add_comment(struct ovsdb_idl_txn
*txn
, const char *s
, ...)
1237 if (txn
->comment
.length
) {
1238 ds_put_char(&txn
->comment
, '\n');
1242 ds_put_format_valist(&txn
->comment
, s
, args
);
1246 /* Marks 'txn' as a transaction that will not actually modify the database. In
1247 * almost every way, the transaction is treated like other transactions. It
1248 * must be committed or aborted like other transactions, it will be sent to the
1249 * database server like other transactions, and so on. The only difference is
1250 * that the operations sent to the database server will include, as the last
1251 * step, an "abort" operation, so that any changes made by the transaction will
1252 * not actually take effect. */
1254 ovsdb_idl_txn_set_dry_run(struct ovsdb_idl_txn
*txn
)
1256 txn
->dry_run
= true;
1259 /* Causes 'txn', when committed, to increment the value of 'column' within
1260 * 'row' by 1. 'column' must have an integer type. After 'txn' commits
1261 * successfully, the client may retrieve the final (incremented) value of
1262 * 'column' with ovsdb_idl_txn_get_increment_new_value().
1264 * The client could accomplish something similar with ovsdb_idl_read(),
1265 * ovsdb_idl_txn_verify() and ovsdb_idl_txn_write(), or with ovsdb-idlc
1266 * generated wrappers for these functions. However, ovsdb_idl_txn_increment()
1267 * will never (by itself) fail because of a verify error.
1269 * The intended use is for incrementing the "next_cfg" column in the
1270 * Open_vSwitch table. */
1272 ovsdb_idl_txn_increment(struct ovsdb_idl_txn
*txn
,
1273 const struct ovsdb_idl_row
*row
,
1274 const struct ovsdb_idl_column
*column
)
1276 assert(!txn
->inc_table
);
1277 assert(column
->type
.key
.type
== OVSDB_TYPE_INTEGER
);
1278 assert(column
->type
.value
.type
== OVSDB_TYPE_VOID
);
1280 txn
->inc_table
= row
->table
->class->name
;
1281 txn
->inc_column
= column
->name
;
1282 txn
->inc_row
= row
->uuid
;
1285 /* Destroys 'txn' and frees all associated memory. If ovsdb_idl_txn_commit()
1286 * has been called for 'txn' but the commit is still incomplete (that is, the
1287 * last call returned TXN_INCOMPLETE) then the transaction may or may not still
1288 * end up committing at the database server, but the client will not be able to
1289 * get any further status information back. */
1291 ovsdb_idl_txn_destroy(struct ovsdb_idl_txn
*txn
)
1293 struct ovsdb_idl_txn_insert
*insert
, *next
;
1295 json_destroy(txn
->request_id
);
1296 if (txn
->status
== TXN_INCOMPLETE
) {
1297 hmap_remove(&txn
->idl
->outstanding_txns
, &txn
->hmap_node
);
1299 ovsdb_idl_txn_abort(txn
);
1300 ds_destroy(&txn
->comment
);
1302 HMAP_FOR_EACH_SAFE (insert
, next
, hmap_node
, &txn
->inserted_rows
) {
1305 hmap_destroy(&txn
->inserted_rows
);
1309 /* Causes poll_block() to wake up if 'txn' has completed committing. */
1311 ovsdb_idl_txn_wait(const struct ovsdb_idl_txn
*txn
)
1313 if (txn
->status
!= TXN_UNCOMMITTED
&& txn
->status
!= TXN_INCOMPLETE
) {
1314 poll_immediate_wake();
1318 static struct json
*
1319 where_uuid_equals(const struct uuid
*uuid
)
1322 json_array_create_1(
1323 json_array_create_3(
1324 json_string_create("_uuid"),
1325 json_string_create("=="),
1326 json_array_create_2(
1327 json_string_create("uuid"),
1328 json_string_create_nocopy(
1329 xasprintf(UUID_FMT
, UUID_ARGS(uuid
))))));
1333 uuid_name_from_uuid(const struct uuid
*uuid
)
1338 name
= xasprintf("row"UUID_FMT
, UUID_ARGS(uuid
));
1339 for (p
= name
; *p
!= '\0'; p
++) {
1348 static const struct ovsdb_idl_row
*
1349 ovsdb_idl_txn_get_row(const struct ovsdb_idl_txn
*txn
, const struct uuid
*uuid
)
1351 const struct ovsdb_idl_row
*row
;
1353 HMAP_FOR_EACH_WITH_HASH (row
, txn_node
, uuid_hash(uuid
), &txn
->txn_rows
) {
1354 if (uuid_equals(&row
->uuid
, uuid
)) {
1361 /* XXX there must be a cleaner way to do this */
1362 static struct json
*
1363 substitute_uuids(struct json
*json
, const struct ovsdb_idl_txn
*txn
)
1365 if (json
->type
== JSON_ARRAY
) {
1369 if (json
->u
.array
.n
== 2
1370 && json
->u
.array
.elems
[0]->type
== JSON_STRING
1371 && json
->u
.array
.elems
[1]->type
== JSON_STRING
1372 && !strcmp(json
->u
.array
.elems
[0]->u
.string
, "uuid")
1373 && uuid_from_string(&uuid
, json
->u
.array
.elems
[1]->u
.string
)) {
1374 const struct ovsdb_idl_row
*row
;
1376 row
= ovsdb_idl_txn_get_row(txn
, &uuid
);
1377 if (row
&& !row
->old
&& row
->new) {
1380 return json_array_create_2(
1381 json_string_create("named-uuid"),
1382 json_string_create_nocopy(uuid_name_from_uuid(&uuid
)));
1386 for (i
= 0; i
< json
->u
.array
.n
; i
++) {
1387 json
->u
.array
.elems
[i
] = substitute_uuids(json
->u
.array
.elems
[i
],
1390 } else if (json
->type
== JSON_OBJECT
) {
1391 struct shash_node
*node
;
1393 SHASH_FOR_EACH (node
, json_object(json
)) {
1394 node
->data
= substitute_uuids(node
->data
, txn
);
1401 ovsdb_idl_txn_disassemble(struct ovsdb_idl_txn
*txn
)
1403 struct ovsdb_idl_row
*row
, *next
;
1405 /* This must happen early. Otherwise, ovsdb_idl_row_parse() will call an
1406 * ovsdb_idl_column's 'parse' function, which will call
1407 * ovsdb_idl_get_row_arc(), which will seen that the IDL is in a
1408 * transaction and fail to update the graph. */
1409 txn
->idl
->txn
= NULL
;
1411 HMAP_FOR_EACH_SAFE (row
, next
, txn_node
, &txn
->txn_rows
) {
1414 ovsdb_idl_row_unparse(row
);
1415 ovsdb_idl_row_clear_arcs(row
, false);
1416 ovsdb_idl_row_parse(row
);
1419 ovsdb_idl_row_unparse(row
);
1421 ovsdb_idl_row_clear_new(row
);
1424 row
->prereqs
= NULL
;
1427 row
->written
= NULL
;
1429 hmap_remove(&txn
->txn_rows
, &row
->txn_node
);
1430 hmap_node_nullify(&row
->txn_node
);
1432 hmap_remove(&row
->table
->rows
, &row
->hmap_node
);
1436 hmap_destroy(&txn
->txn_rows
);
1437 hmap_init(&txn
->txn_rows
);
1440 /* Attempts to commit 'txn'. Returns the status of the commit operation, one
1441 * of the following TXN_* constants:
1445 * The transaction is in progress, but not yet complete. The caller
1446 * should call again later, after calling ovsdb_idl_run() to let the IDL
1447 * do OVSDB protocol processing.
1451 * The transaction is complete. (It didn't actually change the database,
1452 * so the IDL didn't send any request to the database server.)
1456 * The caller previously called ovsdb_idl_txn_abort().
1460 * The transaction was successful. The update made by the transaction
1461 * (and possibly other changes made by other database clients) should
1462 * already be visible in the IDL.
1466 * The transaction failed for some transient reason, e.g. because a
1467 * "verify" operation reported an inconsistency or due to a network
1468 * problem. The caller should wait for a change to the database, then
1469 * compose a new transaction, and commit the new transaction.
1471 * Use the return value of ovsdb_idl_get_seqno() to wait for a change in
1472 * the database. It is important to use its return value *before* the
1473 * initial call to ovsdb_idl_txn_commit() as the baseline for this
1474 * purpose, because the change that one should wait for can happen after
1475 * the initial call but before the call that returns TXN_TRY_AGAIN, and
1476 * using some other baseline value in that situation could cause an
1477 * indefinite wait if the database rarely changes.
1481 * The transaction failed because the IDL has been configured to require
1482 * a database lock (with ovsdb_idl_set_lock()) but didn't get it yet or
1483 * has already lost it.
1485 * Committing a transaction rolls back all of the changes that it made to the
1486 * IDL's copy of the database. If the transaction commits successfully, then
1487 * the database server will send an update and, thus, the IDL will be updated
1488 * with the committed changes. */
1489 enum ovsdb_idl_txn_status
1490 ovsdb_idl_txn_commit(struct ovsdb_idl_txn
*txn
)
1492 struct ovsdb_idl_row
*row
;
1493 struct json
*operations
;
1496 if (txn
!= txn
->idl
->txn
) {
1500 /* If we need a lock but don't have it, give up quickly. */
1501 if (txn
->idl
->lock_name
&& !ovsdb_idl_has_lock(txn
->idl
)) {
1502 txn
->status
= TXN_NOT_LOCKED
;
1503 ovsdb_idl_txn_disassemble(txn
);
1507 operations
= json_array_create_1(
1508 json_string_create(txn
->idl
->class->database
));
1510 /* Assert that we have the required lock (avoiding a race). */
1511 if (txn
->idl
->lock_name
) {
1512 struct json
*op
= json_object_create();
1513 json_array_add(operations
, op
);
1514 json_object_put_string(op
, "op", "assert");
1515 json_object_put_string(op
, "lock", txn
->idl
->lock_name
);
1518 /* Add prerequisites and declarations of new rows. */
1519 HMAP_FOR_EACH (row
, txn_node
, &txn
->txn_rows
) {
1520 /* XXX check that deleted rows exist even if no prereqs? */
1522 const struct ovsdb_idl_table_class
*class = row
->table
->class;
1523 size_t n_columns
= class->n_columns
;
1524 struct json
*op
, *columns
, *row_json
;
1527 op
= json_object_create();
1528 json_array_add(operations
, op
);
1529 json_object_put_string(op
, "op", "wait");
1530 json_object_put_string(op
, "table", class->name
);
1531 json_object_put(op
, "timeout", json_integer_create(0));
1532 json_object_put(op
, "where", where_uuid_equals(&row
->uuid
));
1533 json_object_put_string(op
, "until", "==");
1534 columns
= json_array_create_empty();
1535 json_object_put(op
, "columns", columns
);
1536 row_json
= json_object_create();
1537 json_object_put(op
, "rows", json_array_create_1(row_json
));
1539 BITMAP_FOR_EACH_1 (idx
, n_columns
, row
->prereqs
) {
1540 const struct ovsdb_idl_column
*column
= &class->columns
[idx
];
1541 json_array_add(columns
, json_string_create(column
->name
));
1542 json_object_put(row_json
, column
->name
,
1543 ovsdb_datum_to_json(&row
->old
[idx
],
1550 any_updates
= false;
1551 HMAP_FOR_EACH (row
, txn_node
, &txn
->txn_rows
) {
1552 const struct ovsdb_idl_table_class
*class = row
->table
->class;
1555 if (class->is_root
) {
1556 struct json
*op
= json_object_create();
1557 json_object_put_string(op
, "op", "delete");
1558 json_object_put_string(op
, "table", class->name
);
1559 json_object_put(op
, "where", where_uuid_equals(&row
->uuid
));
1560 json_array_add(operations
, op
);
1563 /* Let ovsdb-server decide whether to really delete it. */
1565 } else if (row
->old
!= row
->new) {
1566 struct json
*row_json
;
1570 op
= json_object_create();
1571 json_object_put_string(op
, "op", row
->old
? "update" : "insert");
1572 json_object_put_string(op
, "table", class->name
);
1574 json_object_put(op
, "where", where_uuid_equals(&row
->uuid
));
1576 struct ovsdb_idl_txn_insert
*insert
;
1580 json_object_put(op
, "uuid-name",
1581 json_string_create_nocopy(
1582 uuid_name_from_uuid(&row
->uuid
)));
1584 insert
= xmalloc(sizeof *insert
);
1585 insert
->dummy
= row
->uuid
;
1586 insert
->op_index
= operations
->u
.array
.n
- 1;
1587 uuid_zero(&insert
->real
);
1588 hmap_insert(&txn
->inserted_rows
, &insert
->hmap_node
,
1589 uuid_hash(&insert
->dummy
));
1591 row_json
= json_object_create();
1592 json_object_put(op
, "row", row_json
);
1595 BITMAP_FOR_EACH_1 (idx
, class->n_columns
, row
->written
) {
1596 const struct ovsdb_idl_column
*column
=
1597 &class->columns
[idx
];
1600 || !ovsdb_datum_is_default(&row
->new[idx
],
1602 json_object_put(row_json
, column
->name
,
1604 ovsdb_datum_to_json(&row
->new[idx
],
1608 /* If anything really changed, consider it an update.
1609 * We can't suppress not-really-changed values earlier
1610 * or transactions would become nonatomic (see the big
1611 * comment inside ovsdb_idl_txn_write()). */
1612 if (!any_updates
&& row
->old
&&
1613 !ovsdb_datum_equals(&row
->old
[idx
], &row
->new[idx
],
1621 if (!row
->old
|| !shash_is_empty(json_object(row_json
))) {
1622 json_array_add(operations
, op
);
1629 /* Add increment. */
1630 if (txn
->inc_table
&& any_updates
) {
1633 txn
->inc_index
= operations
->u
.array
.n
- 1;
1635 op
= json_object_create();
1636 json_object_put_string(op
, "op", "mutate");
1637 json_object_put_string(op
, "table", txn
->inc_table
);
1638 json_object_put(op
, "where",
1639 substitute_uuids(where_uuid_equals(&txn
->inc_row
),
1641 json_object_put(op
, "mutations",
1642 json_array_create_1(
1643 json_array_create_3(
1644 json_string_create(txn
->inc_column
),
1645 json_string_create("+="),
1646 json_integer_create(1))));
1647 json_array_add(operations
, op
);
1649 op
= json_object_create();
1650 json_object_put_string(op
, "op", "select");
1651 json_object_put_string(op
, "table", txn
->inc_table
);
1652 json_object_put(op
, "where",
1653 substitute_uuids(where_uuid_equals(&txn
->inc_row
),
1655 json_object_put(op
, "columns",
1656 json_array_create_1(json_string_create(
1658 json_array_add(operations
, op
);
1661 if (txn
->comment
.length
) {
1662 struct json
*op
= json_object_create();
1663 json_object_put_string(op
, "op", "comment");
1664 json_object_put_string(op
, "comment", ds_cstr(&txn
->comment
));
1665 json_array_add(operations
, op
);
1669 struct json
*op
= json_object_create();
1670 json_object_put_string(op
, "op", "abort");
1671 json_array_add(operations
, op
);
1675 txn
->status
= TXN_UNCHANGED
;
1676 json_destroy(operations
);
1677 } else if (!jsonrpc_session_send(
1679 jsonrpc_create_request(
1680 "transact", operations
, &txn
->request_id
))) {
1681 hmap_insert(&txn
->idl
->outstanding_txns
, &txn
->hmap_node
,
1682 json_hash(txn
->request_id
, 0));
1683 txn
->status
= TXN_INCOMPLETE
;
1685 txn
->status
= TXN_TRY_AGAIN
;
1688 ovsdb_idl_txn_disassemble(txn
);
1692 /* Attempts to commit 'txn', blocking until the commit either succeeds or
1693 * fails. Returns the final commit status, which may be any TXN_* value other
1694 * than TXN_INCOMPLETE.
1696 * This function calls ovsdb_idl_run() on 'txn''s IDL, so it may cause the
1697 * return value of ovsdb_idl_get_seqno() to change. */
1698 enum ovsdb_idl_txn_status
1699 ovsdb_idl_txn_commit_block(struct ovsdb_idl_txn
*txn
)
1701 enum ovsdb_idl_txn_status status
;
1704 while ((status
= ovsdb_idl_txn_commit(txn
)) == TXN_INCOMPLETE
) {
1705 ovsdb_idl_run(txn
->idl
);
1706 ovsdb_idl_wait(txn
->idl
);
1707 ovsdb_idl_txn_wait(txn
);
1713 /* Returns the final (incremented) value of the column in 'txn' that was set to
1714 * be incremented by ovsdb_idl_txn_increment(). 'txn' must have committed
1717 ovsdb_idl_txn_get_increment_new_value(const struct ovsdb_idl_txn
*txn
)
1719 assert(txn
->status
== TXN_SUCCESS
);
1720 return txn
->inc_new_value
;
1723 /* Aborts 'txn' without sending it to the database server. This is effective
1724 * only if ovsdb_idl_txn_commit() has not yet been called for 'txn'.
1725 * Otherwise, it has no effect.
1727 * Aborting a transaction doesn't free its memory. Use
1728 * ovsdb_idl_txn_destroy() to do that. */
1730 ovsdb_idl_txn_abort(struct ovsdb_idl_txn
*txn
)
1732 ovsdb_idl_txn_disassemble(txn
);
1733 if (txn
->status
== TXN_UNCOMMITTED
|| txn
->status
== TXN_INCOMPLETE
) {
1734 txn
->status
= TXN_ABORTED
;
1738 /* Returns a string that reports the error status for 'txn'. The caller must
1739 * not modify or free the returned string. A call to ovsdb_idl_txn_destroy()
1740 * for 'txn' may free the returned string.
1742 * The return value is ordinarily one of the strings that
1743 * ovsdb_idl_txn_status_to_string() would return, but if the transaction failed
1744 * due to an error reported by the database server, the return value is that
1747 ovsdb_idl_txn_get_error(const struct ovsdb_idl_txn
*txn
)
1749 if (txn
->status
!= TXN_ERROR
) {
1750 return ovsdb_idl_txn_status_to_string(txn
->status
);
1751 } else if (txn
->error
) {
1754 return "no error details available";
1759 ovsdb_idl_txn_set_error_json(struct ovsdb_idl_txn
*txn
,
1760 const struct json
*json
)
1762 if (txn
->error
== NULL
) {
1763 txn
->error
= json_to_string(json
, JSSF_SORT
);
1767 /* For transaction 'txn' that completed successfully, finds and returns the
1768 * permanent UUID that the database assigned to a newly inserted row, given the
1769 * 'uuid' that ovsdb_idl_txn_insert() assigned locally to that row.
1771 * Returns NULL if 'uuid' is not a UUID assigned by ovsdb_idl_txn_insert() or
1772 * if it was assigned by that function and then deleted by
1773 * ovsdb_idl_txn_delete() within the same transaction. (Rows that are inserted
1774 * and then deleted within a single transaction are never sent to the database
1775 * server, so it never assigns them a permanent UUID.) */
1777 ovsdb_idl_txn_get_insert_uuid(const struct ovsdb_idl_txn
*txn
,
1778 const struct uuid
*uuid
)
1780 const struct ovsdb_idl_txn_insert
*insert
;
1782 assert(txn
->status
== TXN_SUCCESS
|| txn
->status
== TXN_UNCHANGED
);
1783 HMAP_FOR_EACH_IN_BUCKET (insert
, hmap_node
,
1784 uuid_hash(uuid
), &txn
->inserted_rows
) {
1785 if (uuid_equals(uuid
, &insert
->dummy
)) {
1786 return &insert
->real
;
1793 ovsdb_idl_txn_complete(struct ovsdb_idl_txn
*txn
,
1794 enum ovsdb_idl_txn_status status
)
1796 txn
->status
= status
;
1797 hmap_remove(&txn
->idl
->outstanding_txns
, &txn
->hmap_node
);
1800 /* Writes 'datum' to the specified 'column' in 'row_'. Updates both 'row_'
1801 * itself and the structs derived from it (e.g. the "struct ovsrec_*", for
1804 * 'datum' must have the correct type for its column. The IDL does not check
1805 * that it meets schema constraints, but ovsdb-server will do so at commit time
1806 * so it had better be correct.
1808 * A transaction must be in progress. Replication of 'column' must not have
1809 * been disabled (by calling ovsdb_idl_omit()).
1811 * Usually this function is used indirectly through one of the "set" functions
1812 * generated by ovsdb-idlc.
1814 * Takes ownership of what 'datum' points to (and in some cases destroys that
1815 * data before returning) but makes a copy of 'datum' itself. (Commonly
1816 * 'datum' is on the caller's stack.) */
1818 ovsdb_idl_txn_write(const struct ovsdb_idl_row
*row_
,
1819 const struct ovsdb_idl_column
*column
,
1820 struct ovsdb_datum
*datum
)
1822 struct ovsdb_idl_row
*row
= (struct ovsdb_idl_row
*) row_
;
1823 const struct ovsdb_idl_table_class
*class;
1826 if (ovsdb_idl_row_is_synthetic(row
)) {
1827 ovsdb_datum_destroy(datum
, &column
->type
);
1831 class = row
->table
->class;
1832 column_idx
= column
- class->columns
;
1834 assert(row
->new != NULL
);
1835 assert(column_idx
< class->n_columns
);
1836 assert(row
->old
== NULL
||
1837 row
->table
->modes
[column_idx
] & OVSDB_IDL_MONITOR
);
1839 /* If this is a write-only column and the datum being written is the same
1840 * as the one already there, just skip the update entirely. This is worth
1841 * optimizing because we have a lot of columns that get periodically
1842 * refreshed into the database but don't actually change that often.
1844 * We don't do this for read/write columns because that would break
1845 * atomicity of transactions--some other client might have written a
1846 * different value in that column since we read it. (But if a whole
1847 * transaction only does writes of existing values, without making any real
1848 * changes, we will drop the whole transaction later in
1849 * ovsdb_idl_txn_commit().) */
1850 if (row
->table
->modes
[column_idx
] == OVSDB_IDL_MONITOR
1851 && ovsdb_datum_equals(ovsdb_idl_read(row
, column
),
1852 datum
, &column
->type
)) {
1853 ovsdb_datum_destroy(datum
, &column
->type
);
1857 if (hmap_node_is_null(&row
->txn_node
)) {
1858 hmap_insert(&row
->table
->idl
->txn
->txn_rows
, &row
->txn_node
,
1859 uuid_hash(&row
->uuid
));
1861 if (row
->old
== row
->new) {
1862 row
->new = xmalloc(class->n_columns
* sizeof *row
->new);
1864 if (!row
->written
) {
1865 row
->written
= bitmap_allocate(class->n_columns
);
1867 if (bitmap_is_set(row
->written
, column_idx
)) {
1868 ovsdb_datum_destroy(&row
->new[column_idx
], &column
->type
);
1870 bitmap_set1(row
->written
, column_idx
);
1872 row
->new[column_idx
] = *datum
;
1873 (column
->unparse
)(row
);
1874 (column
->parse
)(row
, &row
->new[column_idx
]);
1877 /* Causes the original contents of 'column' in 'row_' to be verified as a
1878 * prerequisite to completing the transaction. That is, if 'column' in 'row_'
1879 * changed (or if 'row_' was deleted) between the time that the IDL originally
1880 * read its contents and the time that the transaction commits, then the
1881 * transaction aborts and ovsdb_idl_txn_commit() returns TXN_AGAIN_WAIT or
1882 * TXN_AGAIN_NOW (depending on whether the database change has already been
1885 * The intention is that, to ensure that no transaction commits based on dirty
1886 * reads, an application should call ovsdb_idl_txn_verify() on each data item
1887 * read as part of a read-modify-write operation.
1889 * In some cases ovsdb_idl_txn_verify() reduces to a no-op, because the current
1890 * value of 'column' is already known:
1892 * - If 'row_' is a row created by the current transaction (returned by
1893 * ovsdb_idl_txn_insert()).
1895 * - If 'column' has already been modified (with ovsdb_idl_txn_write())
1896 * within the current transaction.
1898 * Because of the latter property, always call ovsdb_idl_txn_verify() *before*
1899 * ovsdb_idl_txn_write() for a given read-modify-write.
1901 * A transaction must be in progress.
1903 * Usually this function is used indirectly through one of the "verify"
1904 * functions generated by ovsdb-idlc. */
1906 ovsdb_idl_txn_verify(const struct ovsdb_idl_row
*row_
,
1907 const struct ovsdb_idl_column
*column
)
1909 struct ovsdb_idl_row
*row
= (struct ovsdb_idl_row
*) row_
;
1910 const struct ovsdb_idl_table_class
*class;
1913 if (ovsdb_idl_row_is_synthetic(row
)) {
1917 class = row
->table
->class;
1918 column_idx
= column
- class->columns
;
1920 assert(row
->new != NULL
);
1921 assert(row
->old
== NULL
||
1922 row
->table
->modes
[column_idx
] & OVSDB_IDL_MONITOR
);
1924 || (row
->written
&& bitmap_is_set(row
->written
, column_idx
))) {
1928 if (hmap_node_is_null(&row
->txn_node
)) {
1929 hmap_insert(&row
->table
->idl
->txn
->txn_rows
, &row
->txn_node
,
1930 uuid_hash(&row
->uuid
));
1932 if (!row
->prereqs
) {
1933 row
->prereqs
= bitmap_allocate(class->n_columns
);
1935 bitmap_set1(row
->prereqs
, column_idx
);
1938 /* Deletes 'row_' from its table. May free 'row_', so it must not be
1939 * accessed afterward.
1941 * A transaction must be in progress.
1943 * Usually this function is used indirectly through one of the "delete"
1944 * functions generated by ovsdb-idlc. */
1946 ovsdb_idl_txn_delete(const struct ovsdb_idl_row
*row_
)
1948 struct ovsdb_idl_row
*row
= (struct ovsdb_idl_row
*) row_
;
1950 if (ovsdb_idl_row_is_synthetic(row
)) {
1954 assert(row
->new != NULL
);
1956 ovsdb_idl_row_unparse(row
);
1957 ovsdb_idl_row_clear_new(row
);
1958 assert(!row
->prereqs
);
1959 hmap_remove(&row
->table
->rows
, &row
->hmap_node
);
1960 hmap_remove(&row
->table
->idl
->txn
->txn_rows
, &row
->txn_node
);
1964 if (hmap_node_is_null(&row
->txn_node
)) {
1965 hmap_insert(&row
->table
->idl
->txn
->txn_rows
, &row
->txn_node
,
1966 uuid_hash(&row
->uuid
));
1968 ovsdb_idl_row_clear_new(row
);
1972 /* Inserts and returns a new row in the table with the specified 'class' in the
1973 * database with open transaction 'txn'.
1975 * The new row is assigned a provisional UUID. If 'uuid' is null then one is
1976 * randomly generated; otherwise 'uuid' should specify a randomly generated
1977 * UUID not otherwise in use. ovsdb-server will assign a different UUID when
1978 * 'txn' is committed, but the IDL will replace any uses of the provisional
1979 * UUID in the data to be to be committed by the UUID assigned by
1982 * Usually this function is used indirectly through one of the "insert"
1983 * functions generated by ovsdb-idlc. */
1984 const struct ovsdb_idl_row
*
1985 ovsdb_idl_txn_insert(struct ovsdb_idl_txn
*txn
,
1986 const struct ovsdb_idl_table_class
*class,
1987 const struct uuid
*uuid
)
1989 struct ovsdb_idl_row
*row
= ovsdb_idl_row_create__(class);
1992 assert(!ovsdb_idl_txn_get_row(txn
, uuid
));
1995 uuid_generate(&row
->uuid
);
1998 row
->table
= ovsdb_idl_table_from_class(txn
->idl
, class);
1999 row
->new = xmalloc(class->n_columns
* sizeof *row
->new);
2000 hmap_insert(&row
->table
->rows
, &row
->hmap_node
, uuid_hash(&row
->uuid
));
2001 hmap_insert(&txn
->txn_rows
, &row
->txn_node
, uuid_hash(&row
->uuid
));
2006 ovsdb_idl_txn_abort_all(struct ovsdb_idl
*idl
)
2008 struct ovsdb_idl_txn
*txn
;
2010 HMAP_FOR_EACH (txn
, hmap_node
, &idl
->outstanding_txns
) {
2011 ovsdb_idl_txn_complete(txn
, TXN_TRY_AGAIN
);
2015 static struct ovsdb_idl_txn
*
2016 ovsdb_idl_txn_find(struct ovsdb_idl
*idl
, const struct json
*id
)
2018 struct ovsdb_idl_txn
*txn
;
2020 HMAP_FOR_EACH_WITH_HASH (txn
, hmap_node
,
2021 json_hash(id
, 0), &idl
->outstanding_txns
) {
2022 if (json_equal(id
, txn
->request_id
)) {
2030 check_json_type(const struct json
*json
, enum json_type type
, const char *name
)
2033 VLOG_WARN_RL(&syntax_rl
, "%s is missing", name
);
2035 } else if (json
->type
!= type
) {
2036 VLOG_WARN_RL(&syntax_rl
, "%s is %s instead of %s",
2037 name
, json_type_to_string(json
->type
),
2038 json_type_to_string(type
));
2046 ovsdb_idl_txn_process_inc_reply(struct ovsdb_idl_txn
*txn
,
2047 const struct json_array
*results
)
2049 struct json
*count
, *rows
, *row
, *column
;
2050 struct shash
*mutate
, *select
;
2052 if (txn
->inc_index
+ 2 > results
->n
) {
2053 VLOG_WARN_RL(&syntax_rl
, "reply does not contain enough operations "
2054 "for increment (has %zu, needs %u)",
2055 results
->n
, txn
->inc_index
+ 2);
2059 /* We know that this is a JSON object because the loop in
2060 * ovsdb_idl_txn_process_reply() checked. */
2061 mutate
= json_object(results
->elems
[txn
->inc_index
]);
2062 count
= shash_find_data(mutate
, "count");
2063 if (!check_json_type(count
, JSON_INTEGER
, "\"mutate\" reply \"count\"")) {
2066 if (count
->u
.integer
!= 1) {
2067 VLOG_WARN_RL(&syntax_rl
,
2068 "\"mutate\" reply \"count\" is %lld instead of 1",
2073 select
= json_object(results
->elems
[txn
->inc_index
+ 1]);
2074 rows
= shash_find_data(select
, "rows");
2075 if (!check_json_type(rows
, JSON_ARRAY
, "\"select\" reply \"rows\"")) {
2078 if (rows
->u
.array
.n
!= 1) {
2079 VLOG_WARN_RL(&syntax_rl
, "\"select\" reply \"rows\" has %zu elements "
2084 row
= rows
->u
.array
.elems
[0];
2085 if (!check_json_type(row
, JSON_OBJECT
, "\"select\" reply row")) {
2088 column
= shash_find_data(json_object(row
), txn
->inc_column
);
2089 if (!check_json_type(column
, JSON_INTEGER
,
2090 "\"select\" reply inc column")) {
2093 txn
->inc_new_value
= column
->u
.integer
;
2098 ovsdb_idl_txn_process_insert_reply(struct ovsdb_idl_txn_insert
*insert
,
2099 const struct json_array
*results
)
2101 static const struct ovsdb_base_type uuid_type
= OVSDB_BASE_UUID_INIT
;
2102 struct ovsdb_error
*error
;
2103 struct json
*json_uuid
;
2104 union ovsdb_atom uuid
;
2105 struct shash
*reply
;
2107 if (insert
->op_index
>= results
->n
) {
2108 VLOG_WARN_RL(&syntax_rl
, "reply does not contain enough operations "
2109 "for insert (has %zu, needs %u)",
2110 results
->n
, insert
->op_index
);
2114 /* We know that this is a JSON object because the loop in
2115 * ovsdb_idl_txn_process_reply() checked. */
2116 reply
= json_object(results
->elems
[insert
->op_index
]);
2117 json_uuid
= shash_find_data(reply
, "uuid");
2118 if (!check_json_type(json_uuid
, JSON_ARRAY
, "\"insert\" reply \"uuid\"")) {
2122 error
= ovsdb_atom_from_json(&uuid
, &uuid_type
, json_uuid
, NULL
);
2124 char *s
= ovsdb_error_to_string(error
);
2125 VLOG_WARN_RL(&syntax_rl
, "\"insert\" reply \"uuid\" is not a JSON "
2131 insert
->real
= uuid
.uuid
;
2137 ovsdb_idl_txn_process_reply(struct ovsdb_idl
*idl
,
2138 const struct jsonrpc_msg
*msg
)
2140 struct ovsdb_idl_txn
*txn
;
2141 enum ovsdb_idl_txn_status status
;
2143 txn
= ovsdb_idl_txn_find(idl
, msg
->id
);
2148 if (msg
->type
== JSONRPC_ERROR
) {
2150 } else if (msg
->result
->type
!= JSON_ARRAY
) {
2151 VLOG_WARN_RL(&syntax_rl
, "reply to \"transact\" is not JSON array");
2154 struct json_array
*ops
= &msg
->result
->u
.array
;
2155 int hard_errors
= 0;
2156 int soft_errors
= 0;
2157 int lock_errors
= 0;
2160 for (i
= 0; i
< ops
->n
; i
++) {
2161 struct json
*op
= ops
->elems
[i
];
2163 if (op
->type
== JSON_NULL
) {
2164 /* This isn't an error in itself but indicates that some prior
2165 * operation failed, so make sure that we know about it. */
2167 } else if (op
->type
== JSON_OBJECT
) {
2170 error
= shash_find_data(json_object(op
), "error");
2172 if (error
->type
== JSON_STRING
) {
2173 if (!strcmp(error
->u
.string
, "timed out")) {
2175 } else if (!strcmp(error
->u
.string
, "not owner")) {
2177 } else if (strcmp(error
->u
.string
, "aborted")) {
2179 ovsdb_idl_txn_set_error_json(txn
, op
);
2183 ovsdb_idl_txn_set_error_json(txn
, op
);
2184 VLOG_WARN_RL(&syntax_rl
,
2185 "\"error\" in reply is not JSON string");
2190 ovsdb_idl_txn_set_error_json(txn
, op
);
2191 VLOG_WARN_RL(&syntax_rl
,
2192 "operation reply is not JSON null or object");
2196 if (!soft_errors
&& !hard_errors
&& !lock_errors
) {
2197 struct ovsdb_idl_txn_insert
*insert
;
2199 if (txn
->inc_table
&& !ovsdb_idl_txn_process_inc_reply(txn
, ops
)) {
2203 HMAP_FOR_EACH (insert
, hmap_node
, &txn
->inserted_rows
) {
2204 if (!ovsdb_idl_txn_process_insert_reply(insert
, ops
)) {
2210 status
= (hard_errors
? TXN_ERROR
2211 : lock_errors
? TXN_NOT_LOCKED
2212 : soft_errors
? TXN_TRY_AGAIN
2216 ovsdb_idl_txn_complete(txn
, status
);
2220 /* Returns the transaction currently active for 'row''s IDL. A transaction
2221 * must currently be active. */
2222 struct ovsdb_idl_txn
*
2223 ovsdb_idl_txn_get(const struct ovsdb_idl_row
*row
)
2225 struct ovsdb_idl_txn
*txn
= row
->table
->idl
->txn
;
2226 assert(txn
!= NULL
);
2230 /* Returns the IDL on which 'txn' acts. */
2232 ovsdb_idl_txn_get_idl (struct ovsdb_idl_txn
*txn
)
2237 /* If 'lock_name' is nonnull, configures 'idl' to obtain the named lock from
2238 * the database server and to avoid modifying the database when the lock cannot
2239 * be acquired (that is, when another client has the same lock).
2241 * If 'lock_name' is NULL, drops the locking requirement and releases the
2244 ovsdb_idl_set_lock(struct ovsdb_idl
*idl
, const char *lock_name
)
2247 assert(hmap_is_empty(&idl
->outstanding_txns
));
2249 if (idl
->lock_name
&& (!lock_name
|| strcmp(lock_name
, idl
->lock_name
))) {
2250 /* Release previous lock. */
2251 ovsdb_idl_send_unlock_request(idl
);
2252 free(idl
->lock_name
);
2253 idl
->lock_name
= NULL
;
2254 idl
->is_lock_contended
= false;
2257 if (lock_name
&& !idl
->lock_name
) {
2258 /* Acquire new lock. */
2259 idl
->lock_name
= xstrdup(lock_name
);
2260 ovsdb_idl_send_lock_request(idl
);
2264 /* Returns true if 'idl' is configured to obtain a lock and owns that lock.
2266 * Locking and unlocking happens asynchronously from the database client's
2267 * point of view, so the information is only useful for optimization (e.g. if
2268 * the client doesn't have the lock then there's no point in trying to write to
2271 ovsdb_idl_has_lock(const struct ovsdb_idl
*idl
)
2273 return idl
->has_lock
;
2276 /* Returns true if 'idl' is configured to obtain a lock but the database server
2277 * has indicated that some other client already owns the requested lock. */
2279 ovsdb_idl_is_lock_contended(const struct ovsdb_idl
*idl
)
2281 return idl
->is_lock_contended
;
2285 ovsdb_idl_update_has_lock(struct ovsdb_idl
*idl
, bool new_has_lock
)
2287 if (new_has_lock
&& !idl
->has_lock
) {
2288 if (!idl
->monitor_request_id
) {
2289 idl
->change_seqno
++;
2291 /* We're waiting for a monitor reply, so don't signal that the
2292 * database changed. The monitor reply will increment change_seqno
2295 idl
->is_lock_contended
= false;
2297 idl
->has_lock
= new_has_lock
;
2301 ovsdb_idl_send_lock_request__(struct ovsdb_idl
*idl
, const char *method
,
2304 ovsdb_idl_update_has_lock(idl
, false);
2306 json_destroy(idl
->lock_request_id
);
2307 idl
->lock_request_id
= NULL
;
2309 if (jsonrpc_session_is_connected(idl
->session
)) {
2310 struct json
*params
;
2312 params
= json_array_create_1(json_string_create(idl
->lock_name
));
2313 jsonrpc_session_send(idl
->session
,
2314 jsonrpc_create_request(method
, params
, idp
));
2319 ovsdb_idl_send_lock_request(struct ovsdb_idl
*idl
)
2321 ovsdb_idl_send_lock_request__(idl
, "lock", &idl
->lock_request_id
);
2325 ovsdb_idl_send_unlock_request(struct ovsdb_idl
*idl
)
2327 ovsdb_idl_send_lock_request__(idl
, "unlock", NULL
);
2331 ovsdb_idl_parse_lock_reply(struct ovsdb_idl
*idl
, const struct json
*result
)
2335 json_destroy(idl
->lock_request_id
);
2336 idl
->lock_request_id
= NULL
;
2338 if (result
->type
== JSON_OBJECT
) {
2339 const struct json
*locked
;
2341 locked
= shash_find_data(json_object(result
), "locked");
2342 got_lock
= locked
&& locked
->type
== JSON_TRUE
;
2347 ovsdb_idl_update_has_lock(idl
, got_lock
);
2349 idl
->is_lock_contended
= true;
2354 ovsdb_idl_parse_lock_notify(struct ovsdb_idl
*idl
,
2355 const struct json
*params
,
2359 && params
->type
== JSON_ARRAY
2360 && json_array(params
)->n
> 0
2361 && json_array(params
)->elems
[0]->type
== JSON_STRING
) {
2362 const char *lock_name
= json_string(json_array(params
)->elems
[0]);
2364 if (!strcmp(idl
->lock_name
, lock_name
)) {
2365 ovsdb_idl_update_has_lock(idl
, new_has_lock
);
2366 if (!new_has_lock
) {
2367 idl
->is_lock_contended
= true;