New action NXAST_RESUBMIT_TABLE.
[openvswitch] / lib / ovsdb-idl.c
1 /* Copyright (c) 2009, 2010, 2011 Nicira Networks.
2  *
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:
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
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.
14  */
15
16 #include <config.h>
17
18 #include "ovsdb-idl.h"
19
20 #include <assert.h>
21 #include <errno.h>
22 #include <inttypes.h>
23 #include <limits.h>
24 #include <stdlib.h>
25
26 #include "bitmap.h"
27 #include "dynamic-string.h"
28 #include "fatal-signal.h"
29 #include "json.h"
30 #include "jsonrpc.h"
31 #include "ovsdb-data.h"
32 #include "ovsdb-error.h"
33 #include "ovsdb-idl-provider.h"
34 #include "poll-loop.h"
35 #include "shash.h"
36 #include "util.h"
37 #include "vlog.h"
38
39 VLOG_DEFINE_THIS_MODULE(ovsdb_idl);
40
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
43  * (the destination).
44  *
45  * Arcs from a row to itself are omitted, that is, src and dst are always
46  * different.
47  *
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.
50  *
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.
54  *
55  * The source and destination row may be in the same table or in different
56  * tables.
57  */
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. */
63 };
64
65 struct ovsdb_idl {
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;
73
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. */
79
80     /* Transaction support. */
81     struct ovsdb_idl_txn *txn;
82     struct hmap outstanding_txns;
83 };
84
85 struct ovsdb_idl_txn {
86     struct hmap_node hmap_node;
87     struct json *request_id;
88     struct ovsdb_idl *idl;
89     struct hmap txn_rows;
90     enum ovsdb_idl_txn_status status;
91     char *error;
92     bool dry_run;
93     struct ds comment;
94
95     /* Increments. */
96     char *inc_table;
97     char *inc_column;
98     struct json *inc_where;
99     unsigned int inc_index;
100     int64_t inc_new_value;
101
102     /* Inserted rows. */
103     struct hmap inserted_rows;
104 };
105
106 struct ovsdb_idl_txn_insert {
107     struct hmap_node hmap_node; /* In struct ovsdb_idl_txn's inserted_rows. */
108     struct uuid dummy;          /* Dummy UUID used locally. */
109     int op_index;               /* Index into transaction's operation array. */
110     struct uuid real;           /* Real UUID used by database server. */
111 };
112
113 static struct vlog_rate_limit syntax_rl = VLOG_RATE_LIMIT_INIT(1, 5);
114 static struct vlog_rate_limit semantic_rl = VLOG_RATE_LIMIT_INIT(1, 5);
115
116 static void ovsdb_idl_clear(struct ovsdb_idl *);
117 static void ovsdb_idl_send_monitor_request(struct ovsdb_idl *);
118 static void ovsdb_idl_parse_update(struct ovsdb_idl *, const struct json *);
119 static struct ovsdb_error *ovsdb_idl_parse_update__(struct ovsdb_idl *,
120                                                     const struct json *);
121 static bool ovsdb_idl_process_update(struct ovsdb_idl_table *,
122                                      const struct uuid *,
123                                      const struct json *old,
124                                      const struct json *new);
125 static void ovsdb_idl_insert_row(struct ovsdb_idl_row *, const struct json *);
126 static void ovsdb_idl_delete_row(struct ovsdb_idl_row *);
127 static bool ovsdb_idl_modify_row(struct ovsdb_idl_row *, const struct json *);
128
129 static bool ovsdb_idl_row_is_orphan(const struct ovsdb_idl_row *);
130 static struct ovsdb_idl_row *ovsdb_idl_row_create__(
131     const struct ovsdb_idl_table_class *);
132 static struct ovsdb_idl_row *ovsdb_idl_row_create(struct ovsdb_idl_table *,
133                                                   const struct uuid *);
134 static void ovsdb_idl_row_destroy(struct ovsdb_idl_row *);
135
136 static void ovsdb_idl_row_parse(struct ovsdb_idl_row *);
137 static void ovsdb_idl_row_unparse(struct ovsdb_idl_row *);
138 static void ovsdb_idl_row_clear_old(struct ovsdb_idl_row *);
139 static void ovsdb_idl_row_clear_new(struct ovsdb_idl_row *);
140
141 static void ovsdb_idl_txn_abort_all(struct ovsdb_idl *);
142 static bool ovsdb_idl_txn_process_reply(struct ovsdb_idl *,
143                                         const struct jsonrpc_msg *msg);
144
145 static void ovsdb_idl_send_lock_request(struct ovsdb_idl *);
146 static void ovsdb_idl_send_unlock_request(struct ovsdb_idl *);
147 static void ovsdb_idl_parse_lock_reply(struct ovsdb_idl *,
148                                        const struct json *);
149 static void ovsdb_idl_parse_lock_notify(struct ovsdb_idl *,
150                                         const struct json *params,
151                                         bool new_has_lock);
152
153 /* Creates and returns a connection to database 'remote', which should be in a
154  * form acceptable to jsonrpc_session_open().  The connection will maintain an
155  * in-memory replica of the remote database whose schema is described by
156  * 'class'.  (Ordinarily 'class' is compiled from an OVSDB schema automatically
157  * by ovsdb-idlc.)
158  *
159  * If 'monitor_everything_by_default' is true, then everything in the remote
160  * database will be replicated by default.  ovsdb_idl_omit() and
161  * ovsdb_idl_omit_alert() may be used to selectively drop some columns from
162  * monitoring.
163  *
164  * If 'monitor_everything_by_default' is false, then no columns or tables will
165  * be replicated by default.  ovsdb_idl_add_column() and ovsdb_idl_add_table()
166  * must be used to choose some columns or tables to replicate.
167  */
168 struct ovsdb_idl *
169 ovsdb_idl_create(const char *remote, const struct ovsdb_idl_class *class,
170                  bool monitor_everything_by_default)
171 {
172     struct ovsdb_idl *idl;
173     uint8_t default_mode;
174     size_t i;
175
176     default_mode = (monitor_everything_by_default
177                     ? OVSDB_IDL_MONITOR | OVSDB_IDL_ALERT
178                     : 0);
179
180     idl = xzalloc(sizeof *idl);
181     idl->class = class;
182     idl->session = jsonrpc_session_open(remote);
183     shash_init(&idl->table_by_name);
184     idl->tables = xmalloc(class->n_tables * sizeof *idl->tables);
185     for (i = 0; i < class->n_tables; i++) {
186         const struct ovsdb_idl_table_class *tc = &class->tables[i];
187         struct ovsdb_idl_table *table = &idl->tables[i];
188         size_t j;
189
190         shash_add_assert(&idl->table_by_name, tc->name, table);
191         table->class = tc;
192         table->modes = xmalloc(tc->n_columns);
193         memset(table->modes, default_mode, tc->n_columns);
194         table->need_table = false;
195         shash_init(&table->columns);
196         for (j = 0; j < tc->n_columns; j++) {
197             const struct ovsdb_idl_column *column = &tc->columns[j];
198
199             shash_add_assert(&table->columns, column->name, column);
200         }
201         hmap_init(&table->rows);
202         table->idl = idl;
203     }
204     idl->last_monitor_request_seqno = UINT_MAX;
205     hmap_init(&idl->outstanding_txns);
206
207     return idl;
208 }
209
210 /* Destroys 'idl' and all of the data structures that it manages. */
211 void
212 ovsdb_idl_destroy(struct ovsdb_idl *idl)
213 {
214     if (idl) {
215         size_t i;
216
217         assert(!idl->txn);
218         ovsdb_idl_clear(idl);
219         jsonrpc_session_close(idl->session);
220
221         for (i = 0; i < idl->class->n_tables; i++) {
222             struct ovsdb_idl_table *table = &idl->tables[i];
223             shash_destroy(&table->columns);
224             hmap_destroy(&table->rows);
225             free(table->modes);
226         }
227         shash_destroy(&idl->table_by_name);
228         free(idl->tables);
229         json_destroy(idl->monitor_request_id);
230         free(idl->lock_name);
231         json_destroy(idl->lock_request_id);
232         free(idl);
233     }
234 }
235
236 static void
237 ovsdb_idl_clear(struct ovsdb_idl *idl)
238 {
239     bool changed = false;
240     size_t i;
241
242     for (i = 0; i < idl->class->n_tables; i++) {
243         struct ovsdb_idl_table *table = &idl->tables[i];
244         struct ovsdb_idl_row *row, *next_row;
245
246         if (hmap_is_empty(&table->rows)) {
247             continue;
248         }
249
250         changed = true;
251         HMAP_FOR_EACH_SAFE (row, next_row, hmap_node, &table->rows) {
252             struct ovsdb_idl_arc *arc, *next_arc;
253
254             if (!ovsdb_idl_row_is_orphan(row)) {
255                 ovsdb_idl_row_unparse(row);
256             }
257             LIST_FOR_EACH_SAFE (arc, next_arc, src_node, &row->src_arcs) {
258                 free(arc);
259             }
260             /* No need to do anything with dst_arcs: some node has those arcs
261              * as forward arcs and will destroy them itself. */
262
263             ovsdb_idl_row_destroy(row);
264         }
265     }
266
267     if (changed) {
268         idl->change_seqno++;
269     }
270 }
271
272 /* Processes a batch of messages from the database server on 'idl'.  Returns
273  * true if the database as seen through 'idl' changed, false if it did not
274  * change.  The initial fetch of the entire contents of the remote database is
275  * considered to be one kind of change.  If 'idl' has been configured to
276  * acquire a database lock (with ovsdb_idl_set_lock()), then successfully
277  * acquiring the lock is also considered to be a change.
278  *
279  * When this function returns false, the client may continue to use any data
280  * structures it obtained from 'idl' in the past.  But when it returns true,
281  * the client must not access any of these data structures again, because they
282  * could have freed or reused for other purposes.
283  *
284  * This function can return occasional false positives, that is, report that
285  * the database changed even though it didn't.  This happens if the connection
286  * to the database drops and reconnects, which causes the database contents to
287  * be reloaded even if they didn't change.  (It could also happen if the
288  * database server sends out a "change" that reflects what we already thought
289  * was in the database, but the database server is not supposed to do that.)
290  *
291  * As an alternative to checking the return value, the client may check for
292  * changes in the value returned by ovsdb_idl_get_seqno().
293  */
294 bool
295 ovsdb_idl_run(struct ovsdb_idl *idl)
296 {
297     unsigned int initial_change_seqno = idl->change_seqno;
298     int i;
299
300     assert(!idl->txn);
301     jsonrpc_session_run(idl->session);
302     for (i = 0; jsonrpc_session_is_connected(idl->session) && i < 50; i++) {
303         struct jsonrpc_msg *msg;
304         unsigned int seqno;
305
306         seqno = jsonrpc_session_get_seqno(idl->session);
307         if (idl->last_monitor_request_seqno != seqno) {
308             idl->last_monitor_request_seqno = seqno;
309             ovsdb_idl_txn_abort_all(idl);
310             ovsdb_idl_send_monitor_request(idl);
311             if (idl->lock_name) {
312                 ovsdb_idl_send_lock_request(idl);
313             }
314             break;
315         }
316
317         msg = jsonrpc_session_recv(idl->session);
318         if (!msg) {
319             break;
320         }
321
322         if (msg->type == JSONRPC_NOTIFY
323                    && !strcmp(msg->method, "update")
324                    && msg->params->type == JSON_ARRAY
325                    && msg->params->u.array.n == 2
326                    && msg->params->u.array.elems[0]->type == JSON_NULL) {
327             /* Database contents changed. */
328             ovsdb_idl_parse_update(idl, msg->params->u.array.elems[1]);
329         } else if (msg->type == JSONRPC_REPLY
330                    && idl->monitor_request_id
331                    && json_equal(idl->monitor_request_id, msg->id)) {
332             /* Reply to our "monitor" request. */
333             idl->change_seqno++;
334             json_destroy(idl->monitor_request_id);
335             idl->monitor_request_id = NULL;
336             ovsdb_idl_clear(idl);
337             ovsdb_idl_parse_update(idl, msg->result);
338         } else if (msg->type == JSONRPC_REPLY
339                    && idl->lock_request_id
340                    && json_equal(idl->lock_request_id, msg->id)) {
341             /* Reply to our "lock" request. */
342             ovsdb_idl_parse_lock_reply(idl, msg->result);
343         } else if (msg->type == JSONRPC_NOTIFY
344                    && !strcmp(msg->method, "locked")) {
345             /* We got our lock. */
346             ovsdb_idl_parse_lock_notify(idl, msg->params, true);
347         } else if (msg->type == JSONRPC_NOTIFY
348                    && !strcmp(msg->method, "stolen")) {
349             /* Someone else stole our lock. */
350             ovsdb_idl_parse_lock_notify(idl, msg->params, false);
351         } else if (msg->type == JSONRPC_REPLY && msg->id->type == JSON_STRING
352                    && !strcmp(msg->id->u.string, "echo")) {
353             /* Reply to our echo request.  Ignore it. */
354         } else if ((msg->type == JSONRPC_ERROR
355                     || msg->type == JSONRPC_REPLY)
356                    && ovsdb_idl_txn_process_reply(idl, msg)) {
357             /* ovsdb_idl_txn_process_reply() did everything needful. */
358         } else {
359             /* This can happen if ovsdb_idl_txn_destroy() is called to destroy
360              * a transaction before we receive the reply, so keep the log level
361              * low. */
362             VLOG_DBG("%s: received unexpected %s message",
363                      jsonrpc_session_get_name(idl->session),
364                      jsonrpc_msg_type_to_string(msg->type));
365         }
366         jsonrpc_msg_destroy(msg);
367     }
368
369     return initial_change_seqno != idl->change_seqno;
370 }
371
372 /* Arranges for poll_block() to wake up when ovsdb_idl_run() has something to
373  * do or when activity occurs on a transaction on 'idl'. */
374 void
375 ovsdb_idl_wait(struct ovsdb_idl *idl)
376 {
377     jsonrpc_session_wait(idl->session);
378     jsonrpc_session_recv_wait(idl->session);
379 }
380
381 /* Returns a number that represents the state of 'idl'.  When 'idl' is updated
382  * (by ovsdb_idl_run()), the return value changes. */
383 unsigned int
384 ovsdb_idl_get_seqno(const struct ovsdb_idl *idl)
385 {
386     return idl->change_seqno;
387 }
388
389 /* Returns true if 'idl' successfully connected to the remote database and
390  * retrieved its contents (even if the connection subsequently dropped and is
391  * in the process of reconnecting).  If so, then 'idl' contains an atomic
392  * snapshot of the database's contents (but it might be arbitrarily old if the
393  * connection dropped).
394  *
395  * Returns false if 'idl' has never connected or retrieved the database's
396  * contents.  If so, 'idl' is empty. */
397 bool
398 ovsdb_idl_has_ever_connected(const struct ovsdb_idl *idl)
399 {
400     return ovsdb_idl_get_seqno(idl) != 0;
401 }
402
403 /* Forces 'idl' to drop its connection to the database and reconnect.  In the
404  * meantime, the contents of 'idl' will not change. */
405 void
406 ovsdb_idl_force_reconnect(struct ovsdb_idl *idl)
407 {
408     jsonrpc_session_force_reconnect(idl->session);
409 }
410 \f
411 static unsigned char *
412 ovsdb_idl_get_mode(struct ovsdb_idl *idl,
413                    const struct ovsdb_idl_column *column)
414 {
415     size_t i;
416
417     assert(!idl->change_seqno);
418
419     for (i = 0; i < idl->class->n_tables; i++) {
420         const struct ovsdb_idl_table *table = &idl->tables[i];
421         const struct ovsdb_idl_table_class *tc = table->class;
422
423         if (column >= tc->columns && column < &tc->columns[tc->n_columns]) {
424             return &table->modes[column - tc->columns];
425         }
426     }
427
428     NOT_REACHED();
429 }
430
431 static void
432 add_ref_table(struct ovsdb_idl *idl, const struct ovsdb_base_type *base)
433 {
434     if (base->type == OVSDB_TYPE_UUID && base->u.uuid.refTableName) {
435         struct ovsdb_idl_table *table;
436
437         table = shash_find_data(&idl->table_by_name,
438                                 base->u.uuid.refTableName);
439         if (table) {
440             table->need_table = true;
441         } else {
442             VLOG_WARN("%s IDL class missing referenced table %s",
443                       idl->class->database, base->u.uuid.refTableName);
444         }
445     }
446 }
447
448 /* Turns on OVSDB_IDL_MONITOR and OVSDB_IDL_ALERT for 'column' in 'idl'.  Also
449  * ensures that any tables referenced by 'column' will be replicated, even if
450  * no columns in that table are selected for replication (see
451  * ovsdb_idl_add_table() for more information).
452  *
453  * This function is only useful if 'monitor_everything_by_default' was false in
454  * the call to ovsdb_idl_create().  This function should be called between
455  * ovsdb_idl_create() and the first call to ovsdb_idl_run().
456  */
457 void
458 ovsdb_idl_add_column(struct ovsdb_idl *idl,
459                      const struct ovsdb_idl_column *column)
460 {
461     *ovsdb_idl_get_mode(idl, column) = OVSDB_IDL_MONITOR | OVSDB_IDL_ALERT;
462     add_ref_table(idl, &column->type.key);
463     add_ref_table(idl, &column->type.value);
464 }
465
466 /* Ensures that the table with class 'tc' will be replicated on 'idl' even if
467  * no columns are selected for replication.  This can be useful because it
468  * allows 'idl' to keep track of what rows in the table actually exist, which
469  * in turn allows columns that reference the table to have accurate contents.
470  * (The IDL presents the database with references to rows that do not exist
471  * removed.)
472  *
473  * This function is only useful if 'monitor_everything_by_default' was false in
474  * the call to ovsdb_idl_create().  This function should be called between
475  * ovsdb_idl_create() and the first call to ovsdb_idl_run().
476  */
477 void
478 ovsdb_idl_add_table(struct ovsdb_idl *idl,
479                     const struct ovsdb_idl_table_class *tc)
480 {
481     size_t i;
482
483     for (i = 0; i < idl->class->n_tables; i++) {
484         struct ovsdb_idl_table *table = &idl->tables[i];
485
486         if (table->class == tc) {
487             table->need_table = true;
488             return;
489         }
490     }
491
492     NOT_REACHED();
493 }
494
495 /* Turns off OVSDB_IDL_ALERT for 'column' in 'idl'.
496  *
497  * This function should be called between ovsdb_idl_create() and the first call
498  * to ovsdb_idl_run().
499  */
500 void
501 ovsdb_idl_omit_alert(struct ovsdb_idl *idl,
502                      const struct ovsdb_idl_column *column)
503 {
504     *ovsdb_idl_get_mode(idl, column) &= ~OVSDB_IDL_ALERT;
505 }
506
507 /* Sets the mode for 'column' in 'idl' to 0.  See the big comment above
508  * OVSDB_IDL_MONITOR for details.
509  *
510  * This function should be called between ovsdb_idl_create() and the first call
511  * to ovsdb_idl_run().
512  */
513 void
514 ovsdb_idl_omit(struct ovsdb_idl *idl, const struct ovsdb_idl_column *column)
515 {
516     *ovsdb_idl_get_mode(idl, column) = 0;
517 }
518 \f
519 static void
520 ovsdb_idl_send_monitor_request(struct ovsdb_idl *idl)
521 {
522     struct json *monitor_requests;
523     struct jsonrpc_msg *msg;
524     size_t i;
525
526     monitor_requests = json_object_create();
527     for (i = 0; i < idl->class->n_tables; i++) {
528         const struct ovsdb_idl_table *table = &idl->tables[i];
529         const struct ovsdb_idl_table_class *tc = table->class;
530         struct json *monitor_request, *columns;
531         size_t j;
532
533         columns = table->need_table ? json_array_create_empty() : NULL;
534         for (j = 0; j < tc->n_columns; j++) {
535             const struct ovsdb_idl_column *column = &tc->columns[j];
536             if (table->modes[j] & OVSDB_IDL_MONITOR) {
537                 if (!columns) {
538                     columns = json_array_create_empty();
539                 }
540                 json_array_add(columns, json_string_create(column->name));
541             }
542         }
543
544         if (columns) {
545             monitor_request = json_object_create();
546             json_object_put(monitor_request, "columns", columns);
547             json_object_put(monitor_requests, tc->name, monitor_request);
548         }
549     }
550
551     json_destroy(idl->monitor_request_id);
552     msg = jsonrpc_create_request(
553         "monitor",
554         json_array_create_3(json_string_create(idl->class->database),
555                             json_null_create(), monitor_requests),
556         &idl->monitor_request_id);
557     jsonrpc_session_send(idl->session, msg);
558 }
559
560 static void
561 ovsdb_idl_parse_update(struct ovsdb_idl *idl, const struct json *table_updates)
562 {
563     struct ovsdb_error *error = ovsdb_idl_parse_update__(idl, table_updates);
564     if (error) {
565         if (!VLOG_DROP_WARN(&syntax_rl)) {
566             char *s = ovsdb_error_to_string(error);
567             VLOG_WARN_RL(&syntax_rl, "%s", s);
568             free(s);
569         }
570         ovsdb_error_destroy(error);
571     }
572 }
573
574 static struct ovsdb_error *
575 ovsdb_idl_parse_update__(struct ovsdb_idl *idl,
576                          const struct json *table_updates)
577 {
578     const struct shash_node *tables_node;
579
580     if (table_updates->type != JSON_OBJECT) {
581         return ovsdb_syntax_error(table_updates, NULL,
582                                   "<table-updates> is not an object");
583     }
584     SHASH_FOR_EACH (tables_node, json_object(table_updates)) {
585         const struct json *table_update = tables_node->data;
586         const struct shash_node *table_node;
587         struct ovsdb_idl_table *table;
588
589         table = shash_find_data(&idl->table_by_name, tables_node->name);
590         if (!table) {
591             return ovsdb_syntax_error(
592                 table_updates, NULL,
593                 "<table-updates> includes unknown table \"%s\"",
594                 tables_node->name);
595         }
596
597         if (table_update->type != JSON_OBJECT) {
598             return ovsdb_syntax_error(table_update, NULL,
599                                       "<table-update> for table \"%s\" is "
600                                       "not an object", table->class->name);
601         }
602         SHASH_FOR_EACH (table_node, json_object(table_update)) {
603             const struct json *row_update = table_node->data;
604             const struct json *old_json, *new_json;
605             struct uuid uuid;
606
607             if (!uuid_from_string(&uuid, table_node->name)) {
608                 return ovsdb_syntax_error(table_update, NULL,
609                                           "<table-update> for table \"%s\" "
610                                           "contains bad UUID "
611                                           "\"%s\" as member name",
612                                           table->class->name,
613                                           table_node->name);
614             }
615             if (row_update->type != JSON_OBJECT) {
616                 return ovsdb_syntax_error(row_update, NULL,
617                                           "<table-update> for table \"%s\" "
618                                           "contains <row-update> for %s that "
619                                           "is not an object",
620                                           table->class->name,
621                                           table_node->name);
622             }
623
624             old_json = shash_find_data(json_object(row_update), "old");
625             new_json = shash_find_data(json_object(row_update), "new");
626             if (old_json && old_json->type != JSON_OBJECT) {
627                 return ovsdb_syntax_error(old_json, NULL,
628                                           "\"old\" <row> is not object");
629             } else if (new_json && new_json->type != JSON_OBJECT) {
630                 return ovsdb_syntax_error(new_json, NULL,
631                                           "\"new\" <row> is not object");
632             } else if ((old_json != NULL) + (new_json != NULL)
633                        != shash_count(json_object(row_update))) {
634                 return ovsdb_syntax_error(row_update, NULL,
635                                           "<row-update> contains unexpected "
636                                           "member");
637             } else if (!old_json && !new_json) {
638                 return ovsdb_syntax_error(row_update, NULL,
639                                           "<row-update> missing \"old\" "
640                                           "and \"new\" members");
641             }
642
643             if (ovsdb_idl_process_update(table, &uuid, old_json, new_json)) {
644                 idl->change_seqno++;
645             }
646         }
647     }
648
649     return NULL;
650 }
651
652 static struct ovsdb_idl_row *
653 ovsdb_idl_get_row(struct ovsdb_idl_table *table, const struct uuid *uuid)
654 {
655     struct ovsdb_idl_row *row;
656
657     HMAP_FOR_EACH_WITH_HASH (row, hmap_node, uuid_hash(uuid), &table->rows) {
658         if (uuid_equals(&row->uuid, uuid)) {
659             return row;
660         }
661     }
662     return NULL;
663 }
664
665 /* Returns true if a column with mode OVSDB_IDL_MODE_RW changed, false
666  * otherwise. */
667 static bool
668 ovsdb_idl_process_update(struct ovsdb_idl_table *table,
669                          const struct uuid *uuid, const struct json *old,
670                          const struct json *new)
671 {
672     struct ovsdb_idl_row *row;
673
674     row = ovsdb_idl_get_row(table, uuid);
675     if (!new) {
676         /* Delete row. */
677         if (row && !ovsdb_idl_row_is_orphan(row)) {
678             /* XXX perhaps we should check the 'old' values? */
679             ovsdb_idl_delete_row(row);
680         } else {
681             VLOG_WARN_RL(&semantic_rl, "cannot delete missing row "UUID_FMT" "
682                          "from table %s",
683                          UUID_ARGS(uuid), table->class->name);
684             return false;
685         }
686     } else if (!old) {
687         /* Insert row. */
688         if (!row) {
689             ovsdb_idl_insert_row(ovsdb_idl_row_create(table, uuid), new);
690         } else if (ovsdb_idl_row_is_orphan(row)) {
691             ovsdb_idl_insert_row(row, new);
692         } else {
693             VLOG_WARN_RL(&semantic_rl, "cannot add existing row "UUID_FMT" to "
694                          "table %s", UUID_ARGS(uuid), table->class->name);
695             return ovsdb_idl_modify_row(row, new);
696         }
697     } else {
698         /* Modify row. */
699         if (row) {
700             /* XXX perhaps we should check the 'old' values? */
701             if (!ovsdb_idl_row_is_orphan(row)) {
702                 return ovsdb_idl_modify_row(row, new);
703             } else {
704                 VLOG_WARN_RL(&semantic_rl, "cannot modify missing but "
705                              "referenced row "UUID_FMT" in table %s",
706                              UUID_ARGS(uuid), table->class->name);
707                 ovsdb_idl_insert_row(row, new);
708             }
709         } else {
710             VLOG_WARN_RL(&semantic_rl, "cannot modify missing row "UUID_FMT" "
711                          "in table %s", UUID_ARGS(uuid), table->class->name);
712             ovsdb_idl_insert_row(ovsdb_idl_row_create(table, uuid), new);
713         }
714     }
715
716     return true;
717 }
718
719 /* Returns true if a column with mode OVSDB_IDL_MODE_RW changed, false
720  * otherwise. */
721 static bool
722 ovsdb_idl_row_update(struct ovsdb_idl_row *row, const struct json *row_json)
723 {
724     struct ovsdb_idl_table *table = row->table;
725     struct shash_node *node;
726     bool changed = false;
727
728     SHASH_FOR_EACH (node, json_object(row_json)) {
729         const char *column_name = node->name;
730         const struct ovsdb_idl_column *column;
731         struct ovsdb_datum datum;
732         struct ovsdb_error *error;
733
734         column = shash_find_data(&table->columns, column_name);
735         if (!column) {
736             VLOG_WARN_RL(&syntax_rl, "unknown column %s updating row "UUID_FMT,
737                          column_name, UUID_ARGS(&row->uuid));
738             continue;
739         }
740
741         error = ovsdb_datum_from_json(&datum, &column->type, node->data, NULL);
742         if (!error) {
743             unsigned int column_idx = column - table->class->columns;
744             struct ovsdb_datum *old = &row->old[column_idx];
745
746             if (!ovsdb_datum_equals(old, &datum, &column->type)) {
747                 ovsdb_datum_swap(old, &datum);
748                 if (table->modes[column_idx] & OVSDB_IDL_ALERT) {
749                     changed = true;
750                 }
751             } else {
752                 /* Didn't really change but the OVSDB monitor protocol always
753                  * includes every value in a row. */
754             }
755
756             ovsdb_datum_destroy(&datum, &column->type);
757         } else {
758             char *s = ovsdb_error_to_string(error);
759             VLOG_WARN_RL(&syntax_rl, "error parsing column %s in row "UUID_FMT
760                          " in table %s: %s", column_name,
761                          UUID_ARGS(&row->uuid), table->class->name, s);
762             free(s);
763             ovsdb_error_destroy(error);
764         }
765     }
766     return changed;
767 }
768
769 /* When a row A refers to row B through a column with a "refTable" constraint,
770  * but row B does not exist, row B is called an "orphan row".  Orphan rows
771  * should not persist, because the database enforces referential integrity, but
772  * they can appear transiently as changes from the database are received (the
773  * database doesn't try to topologically sort them and circular references mean
774  * it isn't always possible anyhow).
775  *
776  * This function returns true if 'row' is an orphan row, otherwise false.
777  */
778 static bool
779 ovsdb_idl_row_is_orphan(const struct ovsdb_idl_row *row)
780 {
781     return !row->old && !row->new;
782 }
783
784 /* Returns true if 'row' is conceptually part of the database as modified by
785  * the current transaction (if any), false otherwise.
786  *
787  * This function will return true if 'row' is not an orphan (see the comment on
788  * ovsdb_idl_row_is_orphan()) and:
789  *
790  *   - 'row' exists in the database and has not been deleted within the
791  *     current transaction (if any).
792  *
793  *   - 'row' was inserted within the current transaction and has not been
794  *     deleted.  (In the latter case you should not have passed 'row' in at
795  *     all, because ovsdb_idl_txn_delete() freed it.)
796  *
797  * This function will return false if 'row' is an orphan or if 'row' was
798  * deleted within the current transaction.
799  */
800 static bool
801 ovsdb_idl_row_exists(const struct ovsdb_idl_row *row)
802 {
803     return row->new != NULL;
804 }
805
806 static void
807 ovsdb_idl_row_parse(struct ovsdb_idl_row *row)
808 {
809     const struct ovsdb_idl_table_class *class = row->table->class;
810     size_t i;
811
812     for (i = 0; i < class->n_columns; i++) {
813         const struct ovsdb_idl_column *c = &class->columns[i];
814         (c->parse)(row, &row->old[i]);
815     }
816 }
817
818 static void
819 ovsdb_idl_row_unparse(struct ovsdb_idl_row *row)
820 {
821     const struct ovsdb_idl_table_class *class = row->table->class;
822     size_t i;
823
824     for (i = 0; i < class->n_columns; i++) {
825         const struct ovsdb_idl_column *c = &class->columns[i];
826         (c->unparse)(row);
827     }
828 }
829
830 static void
831 ovsdb_idl_row_clear_old(struct ovsdb_idl_row *row)
832 {
833     assert(row->old == row->new);
834     if (!ovsdb_idl_row_is_orphan(row)) {
835         const struct ovsdb_idl_table_class *class = row->table->class;
836         size_t i;
837
838         for (i = 0; i < class->n_columns; i++) {
839             ovsdb_datum_destroy(&row->old[i], &class->columns[i].type);
840         }
841         free(row->old);
842         row->old = row->new = NULL;
843     }
844 }
845
846 static void
847 ovsdb_idl_row_clear_new(struct ovsdb_idl_row *row)
848 {
849     if (row->old != row->new) {
850         if (row->new) {
851             const struct ovsdb_idl_table_class *class = row->table->class;
852             size_t i;
853
854             if (row->written) {
855                 BITMAP_FOR_EACH_1 (i, class->n_columns, row->written) {
856                     ovsdb_datum_destroy(&row->new[i], &class->columns[i].type);
857                 }
858             }
859             free(row->new);
860             free(row->written);
861             row->written = NULL;
862         }
863         row->new = row->old;
864     }
865 }
866
867 static void
868 ovsdb_idl_row_clear_arcs(struct ovsdb_idl_row *row, bool destroy_dsts)
869 {
870     struct ovsdb_idl_arc *arc, *next;
871
872     /* Delete all forward arcs.  If 'destroy_dsts', destroy any orphaned rows
873      * that this causes to be unreferenced. */
874     LIST_FOR_EACH_SAFE (arc, next, src_node, &row->src_arcs) {
875         list_remove(&arc->dst_node);
876         if (destroy_dsts
877             && ovsdb_idl_row_is_orphan(arc->dst)
878             && list_is_empty(&arc->dst->dst_arcs)) {
879             ovsdb_idl_row_destroy(arc->dst);
880         }
881         free(arc);
882     }
883     list_init(&row->src_arcs);
884 }
885
886 /* Force nodes that reference 'row' to reparse. */
887 static void
888 ovsdb_idl_row_reparse_backrefs(struct ovsdb_idl_row *row)
889 {
890     struct ovsdb_idl_arc *arc, *next;
891
892     /* This is trickier than it looks.  ovsdb_idl_row_clear_arcs() will destroy
893      * 'arc', so we need to use the "safe" variant of list traversal.  However,
894      * calling an ovsdb_idl_column's 'parse' function will add an arc
895      * equivalent to 'arc' to row->arcs.  That could be a problem for
896      * traversal, but it adds it at the beginning of the list to prevent us
897      * from stumbling upon it again.
898      *
899      * (If duplicate arcs were possible then we would need to make sure that
900      * 'next' didn't also point into 'arc''s destination, but we forbid
901      * duplicate arcs.) */
902     LIST_FOR_EACH_SAFE (arc, next, dst_node, &row->dst_arcs) {
903         struct ovsdb_idl_row *ref = arc->src;
904
905         ovsdb_idl_row_unparse(ref);
906         ovsdb_idl_row_clear_arcs(ref, false);
907         ovsdb_idl_row_parse(ref);
908     }
909 }
910
911 static struct ovsdb_idl_row *
912 ovsdb_idl_row_create__(const struct ovsdb_idl_table_class *class)
913 {
914     struct ovsdb_idl_row *row = xzalloc(class->allocation_size);
915     list_init(&row->src_arcs);
916     list_init(&row->dst_arcs);
917     hmap_node_nullify(&row->txn_node);
918     return row;
919 }
920
921 static struct ovsdb_idl_row *
922 ovsdb_idl_row_create(struct ovsdb_idl_table *table, const struct uuid *uuid)
923 {
924     struct ovsdb_idl_row *row = ovsdb_idl_row_create__(table->class);
925     hmap_insert(&table->rows, &row->hmap_node, uuid_hash(uuid));
926     row->uuid = *uuid;
927     row->table = table;
928     return row;
929 }
930
931 static void
932 ovsdb_idl_row_destroy(struct ovsdb_idl_row *row)
933 {
934     if (row) {
935         ovsdb_idl_row_clear_old(row);
936         hmap_remove(&row->table->rows, &row->hmap_node);
937         free(row);
938     }
939 }
940
941 static void
942 ovsdb_idl_insert_row(struct ovsdb_idl_row *row, const struct json *row_json)
943 {
944     const struct ovsdb_idl_table_class *class = row->table->class;
945     size_t i;
946
947     assert(!row->old && !row->new);
948     row->old = row->new = xmalloc(class->n_columns * sizeof *row->old);
949     for (i = 0; i < class->n_columns; i++) {
950         ovsdb_datum_init_default(&row->old[i], &class->columns[i].type);
951     }
952     ovsdb_idl_row_update(row, row_json);
953     ovsdb_idl_row_parse(row);
954
955     ovsdb_idl_row_reparse_backrefs(row);
956 }
957
958 static void
959 ovsdb_idl_delete_row(struct ovsdb_idl_row *row)
960 {
961     ovsdb_idl_row_unparse(row);
962     ovsdb_idl_row_clear_arcs(row, true);
963     ovsdb_idl_row_clear_old(row);
964     if (list_is_empty(&row->dst_arcs)) {
965         ovsdb_idl_row_destroy(row);
966     } else {
967         ovsdb_idl_row_reparse_backrefs(row);
968     }
969 }
970
971 /* Returns true if a column with mode OVSDB_IDL_MODE_RW changed, false
972  * otherwise. */
973 static bool
974 ovsdb_idl_modify_row(struct ovsdb_idl_row *row, const struct json *row_json)
975 {
976     bool changed;
977
978     ovsdb_idl_row_unparse(row);
979     ovsdb_idl_row_clear_arcs(row, true);
980     changed = ovsdb_idl_row_update(row, row_json);
981     ovsdb_idl_row_parse(row);
982
983     return changed;
984 }
985
986 static bool
987 may_add_arc(const struct ovsdb_idl_row *src, const struct ovsdb_idl_row *dst)
988 {
989     const struct ovsdb_idl_arc *arc;
990
991     /* No self-arcs. */
992     if (src == dst) {
993         return false;
994     }
995
996     /* No duplicate arcs.
997      *
998      * We only need to test whether the first arc in dst->dst_arcs originates
999      * at 'src', since we add all of the arcs from a given source in a clump
1000      * (in a single call to ovsdb_idl_row_parse()) and new arcs are always
1001      * added at the front of the dst_arcs list. */
1002     if (list_is_empty(&dst->dst_arcs)) {
1003         return true;
1004     }
1005     arc = CONTAINER_OF(dst->dst_arcs.next, struct ovsdb_idl_arc, dst_node);
1006     return arc->src != src;
1007 }
1008
1009 static struct ovsdb_idl_table *
1010 ovsdb_idl_table_from_class(const struct ovsdb_idl *idl,
1011                            const struct ovsdb_idl_table_class *table_class)
1012 {
1013     return &idl->tables[table_class - idl->class->tables];
1014 }
1015
1016 struct ovsdb_idl_row *
1017 ovsdb_idl_get_row_arc(struct ovsdb_idl_row *src,
1018                       struct ovsdb_idl_table_class *dst_table_class,
1019                       const struct uuid *dst_uuid)
1020 {
1021     struct ovsdb_idl *idl = src->table->idl;
1022     struct ovsdb_idl_table *dst_table;
1023     struct ovsdb_idl_arc *arc;
1024     struct ovsdb_idl_row *dst;
1025
1026     dst_table = ovsdb_idl_table_from_class(idl, dst_table_class);
1027     dst = ovsdb_idl_get_row(dst_table, dst_uuid);
1028     if (idl->txn) {
1029         /* We're being called from ovsdb_idl_txn_write().  We must not update
1030          * any arcs, because the transaction will be backed out at commit or
1031          * abort time and we don't want our graph screwed up.
1032          *
1033          * Just return the destination row, if there is one and it has not been
1034          * deleted. */
1035         if (dst && (hmap_node_is_null(&dst->txn_node) || dst->new)) {
1036             return dst;
1037         }
1038         return NULL;
1039     } else {
1040         /* We're being called from some other context.  Update the graph. */
1041         if (!dst) {
1042             dst = ovsdb_idl_row_create(dst_table, dst_uuid);
1043         }
1044
1045         /* Add a new arc, if it wouldn't be a self-arc or a duplicate arc. */
1046         if (may_add_arc(src, dst)) {
1047             /* The arc *must* be added at the front of the dst_arcs list.  See
1048              * ovsdb_idl_row_reparse_backrefs() for details. */
1049             arc = xmalloc(sizeof *arc);
1050             list_push_front(&src->src_arcs, &arc->src_node);
1051             list_push_front(&dst->dst_arcs, &arc->dst_node);
1052             arc->src = src;
1053             arc->dst = dst;
1054         }
1055
1056         return !ovsdb_idl_row_is_orphan(dst) ? dst : NULL;
1057     }
1058 }
1059
1060 const struct ovsdb_idl_row *
1061 ovsdb_idl_get_row_for_uuid(const struct ovsdb_idl *idl,
1062                            const struct ovsdb_idl_table_class *tc,
1063                            const struct uuid *uuid)
1064 {
1065     return ovsdb_idl_get_row(ovsdb_idl_table_from_class(idl, tc), uuid);
1066 }
1067
1068 static struct ovsdb_idl_row *
1069 next_real_row(struct ovsdb_idl_table *table, struct hmap_node *node)
1070 {
1071     for (; node; node = hmap_next(&table->rows, node)) {
1072         struct ovsdb_idl_row *row;
1073
1074         row = CONTAINER_OF(node, struct ovsdb_idl_row, hmap_node);
1075         if (ovsdb_idl_row_exists(row)) {
1076             return row;
1077         }
1078     }
1079     return NULL;
1080 }
1081
1082 const struct ovsdb_idl_row *
1083 ovsdb_idl_first_row(const struct ovsdb_idl *idl,
1084                     const struct ovsdb_idl_table_class *table_class)
1085 {
1086     struct ovsdb_idl_table *table
1087         = ovsdb_idl_table_from_class(idl, table_class);
1088     return next_real_row(table, hmap_first(&table->rows));
1089 }
1090
1091 const struct ovsdb_idl_row *
1092 ovsdb_idl_next_row(const struct ovsdb_idl_row *row)
1093 {
1094     struct ovsdb_idl_table *table = row->table;
1095
1096     return next_real_row(table, hmap_next(&table->rows, &row->hmap_node));
1097 }
1098
1099 /* Reads and returns the value of 'column' within 'row'.  If an ongoing
1100  * transaction has changed 'column''s value, the modified value is returned.
1101  *
1102  * The caller must not modify or free the returned value.
1103  *
1104  * Various kinds of changes can invalidate the returned value: writing to the
1105  * same 'column' in 'row' (e.g. with ovsdb_idl_txn_write()), deleting 'row'
1106  * (e.g. with ovsdb_idl_txn_delete()), or completing an ongoing transaction
1107  * (e.g. with ovsdb_idl_txn_commit() or ovsdb_idl_txn_abort()).  If the
1108  * returned value is needed for a long time, it is best to make a copy of it
1109  * with ovsdb_datum_clone(). */
1110 const struct ovsdb_datum *
1111 ovsdb_idl_read(const struct ovsdb_idl_row *row,
1112                const struct ovsdb_idl_column *column)
1113 {
1114     const struct ovsdb_idl_table_class *class = row->table->class;
1115     size_t column_idx = column - class->columns;
1116
1117     assert(row->new != NULL);
1118     assert(column_idx < class->n_columns);
1119
1120     if (row->written && bitmap_is_set(row->written, column_idx)) {
1121         return &row->new[column_idx];
1122     } else if (row->old) {
1123         return &row->old[column_idx];
1124     } else {
1125         return ovsdb_datum_default(&column->type);
1126     }
1127 }
1128
1129 /* Same as ovsdb_idl_read(), except that it also asserts that 'column' has key
1130  * type 'key_type' and value type 'value_type'.  (Scalar and set types will
1131  * have a value type of OVSDB_TYPE_VOID.)
1132  *
1133  * This is useful in code that "knows" that a particular column has a given
1134  * type, so that it will abort if someone changes the column's type without
1135  * updating the code that uses it. */
1136 const struct ovsdb_datum *
1137 ovsdb_idl_get(const struct ovsdb_idl_row *row,
1138               const struct ovsdb_idl_column *column,
1139               enum ovsdb_atomic_type key_type OVS_UNUSED,
1140               enum ovsdb_atomic_type value_type OVS_UNUSED)
1141 {
1142     assert(column->type.key.type == key_type);
1143     assert(column->type.value.type == value_type);
1144
1145     return ovsdb_idl_read(row, column);
1146 }
1147
1148 /* Returns false if 'row' was obtained from the IDL, true if it was initialized
1149  * to all-zero-bits by some other entity.  If 'row' was set up some other way
1150  * then the return value is indeterminate. */
1151 bool
1152 ovsdb_idl_row_is_synthetic(const struct ovsdb_idl_row *row)
1153 {
1154     return row->table == NULL;
1155 }
1156 \f
1157 /* Transactions. */
1158
1159 static void ovsdb_idl_txn_complete(struct ovsdb_idl_txn *txn,
1160                                    enum ovsdb_idl_txn_status);
1161
1162 const char *
1163 ovsdb_idl_txn_status_to_string(enum ovsdb_idl_txn_status status)
1164 {
1165     switch (status) {
1166     case TXN_UNCOMMITTED:
1167         return "uncommitted";
1168     case TXN_UNCHANGED:
1169         return "unchanged";
1170     case TXN_INCOMPLETE:
1171         return "incomplete";
1172     case TXN_ABORTED:
1173         return "aborted";
1174     case TXN_SUCCESS:
1175         return "success";
1176     case TXN_TRY_AGAIN:
1177         return "try again";
1178     case TXN_NOT_LOCKED:
1179         return "not locked";
1180     case TXN_ERROR:
1181         return "error";
1182     }
1183     return "<unknown>";
1184 }
1185
1186 struct ovsdb_idl_txn *
1187 ovsdb_idl_txn_create(struct ovsdb_idl *idl)
1188 {
1189     struct ovsdb_idl_txn *txn;
1190
1191     assert(!idl->txn);
1192     idl->txn = txn = xmalloc(sizeof *txn);
1193     txn->request_id = NULL;
1194     txn->idl = idl;
1195     hmap_init(&txn->txn_rows);
1196     txn->status = TXN_UNCOMMITTED;
1197     txn->error = NULL;
1198     txn->dry_run = false;
1199     ds_init(&txn->comment);
1200
1201     txn->inc_table = NULL;
1202     txn->inc_column = NULL;
1203     txn->inc_where = NULL;
1204
1205     hmap_init(&txn->inserted_rows);
1206
1207     return txn;
1208 }
1209
1210 /* Appends 's', which is treated as a printf()-type format string, to the
1211  * comments that will be passed to the OVSDB server when 'txn' is committed.
1212  * (The comment will be committed to the OVSDB log, which "ovsdb-tool
1213  * show-log" can print in a relatively human-readable form.) */
1214 void
1215 ovsdb_idl_txn_add_comment(struct ovsdb_idl_txn *txn, const char *s, ...)
1216 {
1217     va_list args;
1218
1219     if (txn->comment.length) {
1220         ds_put_char(&txn->comment, '\n');
1221     }
1222
1223     va_start(args, s);
1224     ds_put_format_valist(&txn->comment, s, args);
1225     va_end(args);
1226 }
1227
1228 void
1229 ovsdb_idl_txn_set_dry_run(struct ovsdb_idl_txn *txn)
1230 {
1231     txn->dry_run = true;
1232 }
1233
1234 void
1235 ovsdb_idl_txn_increment(struct ovsdb_idl_txn *txn, const char *table,
1236                         const char *column, const struct json *where)
1237 {
1238     assert(!txn->inc_table);
1239     txn->inc_table = xstrdup(table);
1240     txn->inc_column = xstrdup(column);
1241     txn->inc_where = where ? json_clone(where) : json_array_create_empty();
1242 }
1243
1244 void
1245 ovsdb_idl_txn_destroy(struct ovsdb_idl_txn *txn)
1246 {
1247     struct ovsdb_idl_txn_insert *insert, *next;
1248
1249     json_destroy(txn->request_id);
1250     if (txn->status == TXN_INCOMPLETE) {
1251         hmap_remove(&txn->idl->outstanding_txns, &txn->hmap_node);
1252     }
1253     ovsdb_idl_txn_abort(txn);
1254     ds_destroy(&txn->comment);
1255     free(txn->error);
1256     free(txn->inc_table);
1257     free(txn->inc_column);
1258     json_destroy(txn->inc_where);
1259     HMAP_FOR_EACH_SAFE (insert, next, hmap_node, &txn->inserted_rows) {
1260         free(insert);
1261     }
1262     hmap_destroy(&txn->inserted_rows);
1263     free(txn);
1264 }
1265
1266 void
1267 ovsdb_idl_txn_wait(const struct ovsdb_idl_txn *txn)
1268 {
1269     if (txn->status != TXN_UNCOMMITTED && txn->status != TXN_INCOMPLETE) {
1270         poll_immediate_wake();
1271     }
1272 }
1273
1274 static struct json *
1275 where_uuid_equals(const struct uuid *uuid)
1276 {
1277     return
1278         json_array_create_1(
1279             json_array_create_3(
1280                 json_string_create("_uuid"),
1281                 json_string_create("=="),
1282                 json_array_create_2(
1283                     json_string_create("uuid"),
1284                     json_string_create_nocopy(
1285                         xasprintf(UUID_FMT, UUID_ARGS(uuid))))));
1286 }
1287
1288 static char *
1289 uuid_name_from_uuid(const struct uuid *uuid)
1290 {
1291     char *name;
1292     char *p;
1293
1294     name = xasprintf("row"UUID_FMT, UUID_ARGS(uuid));
1295     for (p = name; *p != '\0'; p++) {
1296         if (*p == '-') {
1297             *p = '_';
1298         }
1299     }
1300
1301     return name;
1302 }
1303
1304 static const struct ovsdb_idl_row *
1305 ovsdb_idl_txn_get_row(const struct ovsdb_idl_txn *txn, const struct uuid *uuid)
1306 {
1307     const struct ovsdb_idl_row *row;
1308
1309     HMAP_FOR_EACH_WITH_HASH (row, txn_node, uuid_hash(uuid), &txn->txn_rows) {
1310         if (uuid_equals(&row->uuid, uuid)) {
1311             return row;
1312         }
1313     }
1314     return NULL;
1315 }
1316
1317 /* XXX there must be a cleaner way to do this */
1318 static struct json *
1319 substitute_uuids(struct json *json, const struct ovsdb_idl_txn *txn)
1320 {
1321     if (json->type == JSON_ARRAY) {
1322         struct uuid uuid;
1323         size_t i;
1324
1325         if (json->u.array.n == 2
1326             && json->u.array.elems[0]->type == JSON_STRING
1327             && json->u.array.elems[1]->type == JSON_STRING
1328             && !strcmp(json->u.array.elems[0]->u.string, "uuid")
1329             && uuid_from_string(&uuid, json->u.array.elems[1]->u.string)) {
1330             const struct ovsdb_idl_row *row;
1331
1332             row = ovsdb_idl_txn_get_row(txn, &uuid);
1333             if (row && !row->old && row->new) {
1334                 json_destroy(json);
1335
1336                 return json_array_create_2(
1337                     json_string_create("named-uuid"),
1338                     json_string_create_nocopy(uuid_name_from_uuid(&uuid)));
1339             }
1340         }
1341
1342         for (i = 0; i < json->u.array.n; i++) {
1343             json->u.array.elems[i] = substitute_uuids(json->u.array.elems[i],
1344                                                       txn);
1345         }
1346     } else if (json->type == JSON_OBJECT) {
1347         struct shash_node *node;
1348
1349         SHASH_FOR_EACH (node, json_object(json)) {
1350             node->data = substitute_uuids(node->data, txn);
1351         }
1352     }
1353     return json;
1354 }
1355
1356 static void
1357 ovsdb_idl_txn_disassemble(struct ovsdb_idl_txn *txn)
1358 {
1359     struct ovsdb_idl_row *row, *next;
1360
1361     /* This must happen early.  Otherwise, ovsdb_idl_row_parse() will call an
1362      * ovsdb_idl_column's 'parse' function, which will call
1363      * ovsdb_idl_get_row_arc(), which will seen that the IDL is in a
1364      * transaction and fail to update the graph.  */
1365     txn->idl->txn = NULL;
1366
1367     HMAP_FOR_EACH_SAFE (row, next, txn_node, &txn->txn_rows) {
1368         if (row->old) {
1369             if (row->written) {
1370                 ovsdb_idl_row_unparse(row);
1371                 ovsdb_idl_row_clear_arcs(row, false);
1372                 ovsdb_idl_row_parse(row);
1373             }
1374         } else {
1375             ovsdb_idl_row_unparse(row);
1376         }
1377         ovsdb_idl_row_clear_new(row);
1378
1379         free(row->prereqs);
1380         row->prereqs = NULL;
1381
1382         free(row->written);
1383         row->written = NULL;
1384
1385         hmap_remove(&txn->txn_rows, &row->txn_node);
1386         hmap_node_nullify(&row->txn_node);
1387         if (!row->old) {
1388             hmap_remove(&row->table->rows, &row->hmap_node);
1389             free(row);
1390         }
1391     }
1392     hmap_destroy(&txn->txn_rows);
1393     hmap_init(&txn->txn_rows);
1394 }
1395
1396 enum ovsdb_idl_txn_status
1397 ovsdb_idl_txn_commit(struct ovsdb_idl_txn *txn)
1398 {
1399     struct ovsdb_idl_row *row;
1400     struct json *operations;
1401     bool any_updates;
1402
1403     if (txn != txn->idl->txn) {
1404         return txn->status;
1405     }
1406
1407     /* If we need a lock but don't have it, give up quickly. */
1408     if (txn->idl->lock_name && !ovsdb_idl_has_lock(txn->idl)) {
1409         txn->status = TXN_NOT_LOCKED;
1410         ovsdb_idl_txn_disassemble(txn);
1411         return txn->status;
1412     }
1413
1414     operations = json_array_create_1(
1415         json_string_create(txn->idl->class->database));
1416
1417     /* Assert that we have the required lock (avoiding a race). */
1418     if (txn->idl->lock_name) {
1419         struct json *op = json_object_create();
1420         json_array_add(operations, op);
1421         json_object_put_string(op, "op", "assert");
1422         json_object_put_string(op, "lock", txn->idl->lock_name);
1423     }
1424
1425     /* Add prerequisites and declarations of new rows. */
1426     HMAP_FOR_EACH (row, txn_node, &txn->txn_rows) {
1427         /* XXX check that deleted rows exist even if no prereqs? */
1428         if (row->prereqs) {
1429             const struct ovsdb_idl_table_class *class = row->table->class;
1430             size_t n_columns = class->n_columns;
1431             struct json *op, *columns, *row_json;
1432             size_t idx;
1433
1434             op = json_object_create();
1435             json_array_add(operations, op);
1436             json_object_put_string(op, "op", "wait");
1437             json_object_put_string(op, "table", class->name);
1438             json_object_put(op, "timeout", json_integer_create(0));
1439             json_object_put(op, "where", where_uuid_equals(&row->uuid));
1440             json_object_put_string(op, "until", "==");
1441             columns = json_array_create_empty();
1442             json_object_put(op, "columns", columns);
1443             row_json = json_object_create();
1444             json_object_put(op, "rows", json_array_create_1(row_json));
1445
1446             BITMAP_FOR_EACH_1 (idx, n_columns, row->prereqs) {
1447                 const struct ovsdb_idl_column *column = &class->columns[idx];
1448                 json_array_add(columns, json_string_create(column->name));
1449                 json_object_put(row_json, column->name,
1450                                 ovsdb_datum_to_json(&row->old[idx],
1451                                                     &column->type));
1452             }
1453         }
1454     }
1455
1456     /* Add updates. */
1457     any_updates = false;
1458     HMAP_FOR_EACH (row, txn_node, &txn->txn_rows) {
1459         const struct ovsdb_idl_table_class *class = row->table->class;
1460
1461         if (row->old == row->new) {
1462             continue;
1463         } else if (!row->new) {
1464             if (class->is_root) {
1465                 struct json *op = json_object_create();
1466                 json_object_put_string(op, "op", "delete");
1467                 json_object_put_string(op, "table", class->name);
1468                 json_object_put(op, "where", where_uuid_equals(&row->uuid));
1469                 json_array_add(operations, op);
1470                 any_updates = true;
1471             } else {
1472                 /* Let ovsdb-server decide whether to really delete it. */
1473             }
1474         } else {
1475             struct json *row_json;
1476             struct json *op;
1477             size_t idx;
1478
1479             op = json_object_create();
1480             json_object_put_string(op, "op", row->old ? "update" : "insert");
1481             json_object_put_string(op, "table", class->name);
1482             if (row->old) {
1483                 json_object_put(op, "where", where_uuid_equals(&row->uuid));
1484             } else {
1485                 struct ovsdb_idl_txn_insert *insert;
1486
1487                 any_updates = true;
1488
1489                 json_object_put(op, "uuid-name",
1490                                 json_string_create_nocopy(
1491                                     uuid_name_from_uuid(&row->uuid)));
1492
1493                 insert = xmalloc(sizeof *insert);
1494                 insert->dummy = row->uuid;
1495                 insert->op_index = operations->u.array.n - 1;
1496                 uuid_zero(&insert->real);
1497                 hmap_insert(&txn->inserted_rows, &insert->hmap_node,
1498                             uuid_hash(&insert->dummy));
1499             }
1500             row_json = json_object_create();
1501             json_object_put(op, "row", row_json);
1502
1503             if (row->written) {
1504                 BITMAP_FOR_EACH_1 (idx, class->n_columns, row->written) {
1505                     const struct ovsdb_idl_column *column =
1506                                                         &class->columns[idx];
1507
1508                     if (row->old
1509                         || !ovsdb_datum_is_default(&row->new[idx],
1510                                                   &column->type)) {
1511                         json_object_put(row_json, column->name,
1512                                         substitute_uuids(
1513                                             ovsdb_datum_to_json(&row->new[idx],
1514                                                                 &column->type),
1515                                             txn));
1516
1517                         /* If anything really changed, consider it an update.
1518                          * We can't suppress not-really-changed values earlier
1519                          * or transactions would become nonatomic (see the big
1520                          * comment inside ovsdb_idl_txn_write()). */
1521                         if (!any_updates && row->old &&
1522                             !ovsdb_datum_equals(&row->old[idx], &row->new[idx],
1523                                                 &column->type)) {
1524                             any_updates = true;
1525                         }
1526                     }
1527                 }
1528             }
1529
1530             if (!row->old || !shash_is_empty(json_object(row_json))) {
1531                 json_array_add(operations, op);
1532             } else {
1533                 json_destroy(op);
1534             }
1535         }
1536     }
1537
1538     /* Add increment. */
1539     if (txn->inc_table && any_updates) {
1540         struct json *op;
1541
1542         txn->inc_index = operations->u.array.n - 1;
1543
1544         op = json_object_create();
1545         json_object_put_string(op, "op", "mutate");
1546         json_object_put_string(op, "table", txn->inc_table);
1547         json_object_put(op, "where",
1548                         substitute_uuids(json_clone(txn->inc_where), txn));
1549         json_object_put(op, "mutations",
1550                         json_array_create_1(
1551                             json_array_create_3(
1552                                 json_string_create(txn->inc_column),
1553                                 json_string_create("+="),
1554                                 json_integer_create(1))));
1555         json_array_add(operations, op);
1556
1557         op = json_object_create();
1558         json_object_put_string(op, "op", "select");
1559         json_object_put_string(op, "table", txn->inc_table);
1560         json_object_put(op, "where",
1561                         substitute_uuids(json_clone(txn->inc_where), txn));
1562         json_object_put(op, "columns",
1563                         json_array_create_1(json_string_create(
1564                                                 txn->inc_column)));
1565         json_array_add(operations, op);
1566     }
1567
1568     if (txn->comment.length) {
1569         struct json *op = json_object_create();
1570         json_object_put_string(op, "op", "comment");
1571         json_object_put_string(op, "comment", ds_cstr(&txn->comment));
1572         json_array_add(operations, op);
1573     }
1574
1575     if (txn->dry_run) {
1576         struct json *op = json_object_create();
1577         json_object_put_string(op, "op", "abort");
1578         json_array_add(operations, op);
1579     }
1580
1581     if (!any_updates) {
1582         txn->status = TXN_UNCHANGED;
1583         json_destroy(operations);
1584     } else if (!jsonrpc_session_send(
1585                    txn->idl->session,
1586                    jsonrpc_create_request(
1587                        "transact", operations, &txn->request_id))) {
1588         hmap_insert(&txn->idl->outstanding_txns, &txn->hmap_node,
1589                     json_hash(txn->request_id, 0));
1590         txn->status = TXN_INCOMPLETE;
1591     } else {
1592         txn->status = TXN_TRY_AGAIN;
1593     }
1594
1595     ovsdb_idl_txn_disassemble(txn);
1596     return txn->status;
1597 }
1598
1599 /* Attempts to commit 'txn', blocking until the commit either succeeds or
1600  * fails.  Returns the final commit status, which may be any TXN_* value other
1601  * than TXN_INCOMPLETE. */
1602 enum ovsdb_idl_txn_status
1603 ovsdb_idl_txn_commit_block(struct ovsdb_idl_txn *txn)
1604 {
1605     enum ovsdb_idl_txn_status status;
1606
1607     fatal_signal_run();
1608     while ((status = ovsdb_idl_txn_commit(txn)) == TXN_INCOMPLETE) {
1609         ovsdb_idl_run(txn->idl);
1610         ovsdb_idl_wait(txn->idl);
1611         ovsdb_idl_txn_wait(txn);
1612         poll_block();
1613     }
1614     return status;
1615 }
1616
1617 int64_t
1618 ovsdb_idl_txn_get_increment_new_value(const struct ovsdb_idl_txn *txn)
1619 {
1620     assert(txn->status == TXN_SUCCESS);
1621     return txn->inc_new_value;
1622 }
1623
1624 void
1625 ovsdb_idl_txn_abort(struct ovsdb_idl_txn *txn)
1626 {
1627     ovsdb_idl_txn_disassemble(txn);
1628     if (txn->status == TXN_UNCOMMITTED || txn->status == TXN_INCOMPLETE) {
1629         txn->status = TXN_ABORTED;
1630     }
1631 }
1632
1633 const char *
1634 ovsdb_idl_txn_get_error(const struct ovsdb_idl_txn *txn)
1635 {
1636     if (txn->status != TXN_ERROR) {
1637         return ovsdb_idl_txn_status_to_string(txn->status);
1638     } else if (txn->error) {
1639         return txn->error;
1640     } else {
1641         return "no error details available";
1642     }
1643 }
1644
1645 static void
1646 ovsdb_idl_txn_set_error_json(struct ovsdb_idl_txn *txn,
1647                              const struct json *json)
1648 {
1649     if (txn->error == NULL) {
1650         txn->error = json_to_string(json, JSSF_SORT);
1651     }
1652 }
1653
1654 /* For transaction 'txn' that completed successfully, finds and returns the
1655  * permanent UUID that the database assigned to a newly inserted row, given the
1656  * 'uuid' that ovsdb_idl_txn_insert() assigned locally to that row.
1657  *
1658  * Returns NULL if 'uuid' is not a UUID assigned by ovsdb_idl_txn_insert() or
1659  * if it was assigned by that function and then deleted by
1660  * ovsdb_idl_txn_delete() within the same transaction.  (Rows that are inserted
1661  * and then deleted within a single transaction are never sent to the database
1662  * server, so it never assigns them a permanent UUID.) */
1663 const struct uuid *
1664 ovsdb_idl_txn_get_insert_uuid(const struct ovsdb_idl_txn *txn,
1665                               const struct uuid *uuid)
1666 {
1667     const struct ovsdb_idl_txn_insert *insert;
1668
1669     assert(txn->status == TXN_SUCCESS || txn->status == TXN_UNCHANGED);
1670     HMAP_FOR_EACH_IN_BUCKET (insert, hmap_node,
1671                              uuid_hash(uuid), &txn->inserted_rows) {
1672         if (uuid_equals(uuid, &insert->dummy)) {
1673             return &insert->real;
1674         }
1675     }
1676     return NULL;
1677 }
1678
1679 static void
1680 ovsdb_idl_txn_complete(struct ovsdb_idl_txn *txn,
1681                        enum ovsdb_idl_txn_status status)
1682 {
1683     txn->status = status;
1684     hmap_remove(&txn->idl->outstanding_txns, &txn->hmap_node);
1685 }
1686
1687 /* Writes 'datum' to the specified 'column' in 'row_'.  Updates both 'row_'
1688  * itself and the structs derived from it (e.g. the "struct ovsrec_*", for
1689  * ovs-vswitchd).
1690  *
1691  * 'datum' must have the correct type for its column.  The IDL does not check
1692  * that it meets schema constraints, but ovsdb-server will do so at commit time
1693  * so it had better be correct.
1694  *
1695  * A transaction must be in progress.  Replication of 'column' must not have
1696  * been disabled (by calling ovsdb_idl_omit()).
1697  *
1698  * Usually this function is used indirectly through one of the "set" functions
1699  * generated by ovsdb-idlc.
1700  *
1701  * Takes ownership of what 'datum' points to (and in some cases destroys that
1702  * data before returning) but makes a copy of 'datum' itself.  (Commonly
1703  * 'datum' is on the caller's stack.) */
1704 void
1705 ovsdb_idl_txn_write(const struct ovsdb_idl_row *row_,
1706                     const struct ovsdb_idl_column *column,
1707                     struct ovsdb_datum *datum)
1708 {
1709     struct ovsdb_idl_row *row = (struct ovsdb_idl_row *) row_;
1710     const struct ovsdb_idl_table_class *class = row->table->class;
1711     size_t column_idx = column - class->columns;
1712
1713     assert(row->new != NULL);
1714     assert(column_idx < class->n_columns);
1715     assert(row->old == NULL ||
1716            row->table->modes[column_idx] & OVSDB_IDL_MONITOR);
1717
1718     /* If this is a write-only column and the datum being written is the same
1719      * as the one already there, just skip the update entirely.  This is worth
1720      * optimizing because we have a lot of columns that get periodically
1721      * refreshed into the database but don't actually change that often.
1722      *
1723      * We don't do this for read/write columns because that would break
1724      * atomicity of transactions--some other client might have written a
1725      * different value in that column since we read it.  (But if a whole
1726      * transaction only does writes of existing values, without making any real
1727      * changes, we will drop the whole transaction later in
1728      * ovsdb_idl_txn_commit().) */
1729     if (row->table->modes[column_idx] == OVSDB_IDL_MONITOR
1730         && ovsdb_datum_equals(ovsdb_idl_read(row, column),
1731                               datum, &column->type)) {
1732         ovsdb_datum_destroy(datum, &column->type);
1733         return;
1734     }
1735
1736     if (hmap_node_is_null(&row->txn_node)) {
1737         hmap_insert(&row->table->idl->txn->txn_rows, &row->txn_node,
1738                     uuid_hash(&row->uuid));
1739     }
1740     if (row->old == row->new) {
1741         row->new = xmalloc(class->n_columns * sizeof *row->new);
1742     }
1743     if (!row->written) {
1744         row->written = bitmap_allocate(class->n_columns);
1745     }
1746     if (bitmap_is_set(row->written, column_idx)) {
1747         ovsdb_datum_destroy(&row->new[column_idx], &column->type);
1748     } else {
1749         bitmap_set1(row->written, column_idx);
1750     }
1751     row->new[column_idx] = *datum;
1752     (column->unparse)(row);
1753     (column->parse)(row, &row->new[column_idx]);
1754 }
1755
1756 /* Causes the original contents of 'column' in 'row_' to be verified as a
1757  * prerequisite to completing the transaction.  That is, if 'column' in 'row_'
1758  * changed (or if 'row_' was deleted) between the time that the IDL originally
1759  * read its contents and the time that the transaction commits, then the
1760  * transaction aborts and ovsdb_idl_txn_commit() returns TXN_TRY_AGAIN.
1761  *
1762  * The intention is that, to ensure that no transaction commits based on dirty
1763  * reads, an application should call ovsdb_idl_txn_verify() on each data item
1764  * read as part of a read-modify-write operation.
1765  *
1766  * In some cases ovsdb_idl_txn_verify() reduces to a no-op, because the current
1767  * value of 'column' is already known:
1768  *
1769  *   - If 'row_' is a row created by the current transaction (returned by
1770  *     ovsdb_idl_txn_insert()).
1771  *
1772  *   - If 'column' has already been modified (with ovsdb_idl_txn_write())
1773  *     within the current transaction.
1774  *
1775  * Because of the latter property, always call ovsdb_idl_txn_verify() *before*
1776  * ovsdb_idl_txn_write() for a given read-modify-write.
1777  *
1778  * A transaction must be in progress.
1779  *
1780  * Usually this function is used indirectly through one of the "verify"
1781  * functions generated by ovsdb-idlc. */
1782 void
1783 ovsdb_idl_txn_verify(const struct ovsdb_idl_row *row_,
1784                      const struct ovsdb_idl_column *column)
1785 {
1786     struct ovsdb_idl_row *row = (struct ovsdb_idl_row *) row_;
1787     const struct ovsdb_idl_table_class *class = row->table->class;
1788     size_t column_idx = column - class->columns;
1789
1790     assert(row->new != NULL);
1791     assert(row->old == NULL ||
1792            row->table->modes[column_idx] & OVSDB_IDL_MONITOR);
1793     if (!row->old
1794         || (row->written && bitmap_is_set(row->written, column_idx))) {
1795         return;
1796     }
1797
1798     if (hmap_node_is_null(&row->txn_node)) {
1799         hmap_insert(&row->table->idl->txn->txn_rows, &row->txn_node,
1800                     uuid_hash(&row->uuid));
1801     }
1802     if (!row->prereqs) {
1803         row->prereqs = bitmap_allocate(class->n_columns);
1804     }
1805     bitmap_set1(row->prereqs, column_idx);
1806 }
1807
1808 /* Deletes 'row_' from its table.  May free 'row_', so it must not be
1809  * accessed afterward.
1810  *
1811  * A transaction must be in progress.
1812  *
1813  * Usually this function is used indirectly through one of the "delete"
1814  * functions generated by ovsdb-idlc. */
1815 void
1816 ovsdb_idl_txn_delete(const struct ovsdb_idl_row *row_)
1817 {
1818     struct ovsdb_idl_row *row = (struct ovsdb_idl_row *) row_;
1819
1820     assert(row->new != NULL);
1821     if (!row->old) {
1822         ovsdb_idl_row_unparse(row);
1823         ovsdb_idl_row_clear_new(row);
1824         assert(!row->prereqs);
1825         hmap_remove(&row->table->rows, &row->hmap_node);
1826         hmap_remove(&row->table->idl->txn->txn_rows, &row->txn_node);
1827         free(row);
1828         return;
1829     }
1830     if (hmap_node_is_null(&row->txn_node)) {
1831         hmap_insert(&row->table->idl->txn->txn_rows, &row->txn_node,
1832                     uuid_hash(&row->uuid));
1833     }
1834     ovsdb_idl_row_clear_new(row);
1835     row->new = NULL;
1836 }
1837
1838 /* Inserts and returns a new row in the table with the specified 'class' in the
1839  * database with open transaction 'txn'.
1840  *
1841  * The new row is assigned a provisional UUID.  If 'uuid' is null then one is
1842  * randomly generated; otherwise 'uuid' should specify a randomly generated
1843  * UUID not otherwise in use.  ovsdb-server will assign a different UUID when
1844  * 'txn' is committed, but the IDL will replace any uses of the provisional
1845  * UUID in the data to be to be committed by the UUID assigned by
1846  * ovsdb-server.
1847  *
1848  * Usually this function is used indirectly through one of the "insert"
1849  * functions generated by ovsdb-idlc. */
1850 const struct ovsdb_idl_row *
1851 ovsdb_idl_txn_insert(struct ovsdb_idl_txn *txn,
1852                      const struct ovsdb_idl_table_class *class,
1853                      const struct uuid *uuid)
1854 {
1855     struct ovsdb_idl_row *row = ovsdb_idl_row_create__(class);
1856
1857     if (uuid) {
1858         assert(!ovsdb_idl_txn_get_row(txn, uuid));
1859         row->uuid = *uuid;
1860     } else {
1861         uuid_generate(&row->uuid);
1862     }
1863
1864     row->table = ovsdb_idl_table_from_class(txn->idl, class);
1865     row->new = xmalloc(class->n_columns * sizeof *row->new);
1866     hmap_insert(&row->table->rows, &row->hmap_node, uuid_hash(&row->uuid));
1867     hmap_insert(&txn->txn_rows, &row->txn_node, uuid_hash(&row->uuid));
1868     return row;
1869 }
1870
1871 static void
1872 ovsdb_idl_txn_abort_all(struct ovsdb_idl *idl)
1873 {
1874     struct ovsdb_idl_txn *txn;
1875
1876     HMAP_FOR_EACH (txn, hmap_node, &idl->outstanding_txns) {
1877         ovsdb_idl_txn_complete(txn, TXN_TRY_AGAIN);
1878     }
1879 }
1880
1881 static struct ovsdb_idl_txn *
1882 ovsdb_idl_txn_find(struct ovsdb_idl *idl, const struct json *id)
1883 {
1884     struct ovsdb_idl_txn *txn;
1885
1886     HMAP_FOR_EACH_WITH_HASH (txn, hmap_node,
1887                              json_hash(id, 0), &idl->outstanding_txns) {
1888         if (json_equal(id, txn->request_id)) {
1889             return txn;
1890         }
1891     }
1892     return NULL;
1893 }
1894
1895 static bool
1896 check_json_type(const struct json *json, enum json_type type, const char *name)
1897 {
1898     if (!json) {
1899         VLOG_WARN_RL(&syntax_rl, "%s is missing", name);
1900         return false;
1901     } else if (json->type != type) {
1902         VLOG_WARN_RL(&syntax_rl, "%s is %s instead of %s",
1903                      name, json_type_to_string(json->type),
1904                      json_type_to_string(type));
1905         return false;
1906     } else {
1907         return true;
1908     }
1909 }
1910
1911 static bool
1912 ovsdb_idl_txn_process_inc_reply(struct ovsdb_idl_txn *txn,
1913                                 const struct json_array *results)
1914 {
1915     struct json *count, *rows, *row, *column;
1916     struct shash *mutate, *select;
1917
1918     if (txn->inc_index + 2 > results->n) {
1919         VLOG_WARN_RL(&syntax_rl, "reply does not contain enough operations "
1920                      "for increment (has %zu, needs %u)",
1921                      results->n, txn->inc_index + 2);
1922         return false;
1923     }
1924
1925     /* We know that this is a JSON object because the loop in
1926      * ovsdb_idl_txn_process_reply() checked. */
1927     mutate = json_object(results->elems[txn->inc_index]);
1928     count = shash_find_data(mutate, "count");
1929     if (!check_json_type(count, JSON_INTEGER, "\"mutate\" reply \"count\"")) {
1930         return false;
1931     }
1932     if (count->u.integer != 1) {
1933         VLOG_WARN_RL(&syntax_rl,
1934                      "\"mutate\" reply \"count\" is %lld instead of 1",
1935                      count->u.integer);
1936         return false;
1937     }
1938
1939     select = json_object(results->elems[txn->inc_index + 1]);
1940     rows = shash_find_data(select, "rows");
1941     if (!check_json_type(rows, JSON_ARRAY, "\"select\" reply \"rows\"")) {
1942         return false;
1943     }
1944     if (rows->u.array.n != 1) {
1945         VLOG_WARN_RL(&syntax_rl, "\"select\" reply \"rows\" has %zu elements "
1946                      "instead of 1",
1947                      rows->u.array.n);
1948         return false;
1949     }
1950     row = rows->u.array.elems[0];
1951     if (!check_json_type(row, JSON_OBJECT, "\"select\" reply row")) {
1952         return false;
1953     }
1954     column = shash_find_data(json_object(row), txn->inc_column);
1955     if (!check_json_type(column, JSON_INTEGER,
1956                          "\"select\" reply inc column")) {
1957         return false;
1958     }
1959     txn->inc_new_value = column->u.integer;
1960     return true;
1961 }
1962
1963 static bool
1964 ovsdb_idl_txn_process_insert_reply(struct ovsdb_idl_txn_insert *insert,
1965                                    const struct json_array *results)
1966 {
1967     static const struct ovsdb_base_type uuid_type = OVSDB_BASE_UUID_INIT;
1968     struct ovsdb_error *error;
1969     struct json *json_uuid;
1970     union ovsdb_atom uuid;
1971     struct shash *reply;
1972
1973     if (insert->op_index >= results->n) {
1974         VLOG_WARN_RL(&syntax_rl, "reply does not contain enough operations "
1975                      "for insert (has %zu, needs %u)",
1976                      results->n, insert->op_index);
1977         return false;
1978     }
1979
1980     /* We know that this is a JSON object because the loop in
1981      * ovsdb_idl_txn_process_reply() checked. */
1982     reply = json_object(results->elems[insert->op_index]);
1983     json_uuid = shash_find_data(reply, "uuid");
1984     if (!check_json_type(json_uuid, JSON_ARRAY, "\"insert\" reply \"uuid\"")) {
1985         return false;
1986     }
1987
1988     error = ovsdb_atom_from_json(&uuid, &uuid_type, json_uuid, NULL);
1989     if (error) {
1990         char *s = ovsdb_error_to_string(error);
1991         VLOG_WARN_RL(&syntax_rl, "\"insert\" reply \"uuid\" is not a JSON "
1992                      "UUID: %s", s);
1993         free(s);
1994         return false;
1995     }
1996
1997     insert->real = uuid.uuid;
1998
1999     return true;
2000 }
2001
2002 static bool
2003 ovsdb_idl_txn_process_reply(struct ovsdb_idl *idl,
2004                             const struct jsonrpc_msg *msg)
2005 {
2006     struct ovsdb_idl_txn *txn;
2007     enum ovsdb_idl_txn_status status;
2008
2009     txn = ovsdb_idl_txn_find(idl, msg->id);
2010     if (!txn) {
2011         return false;
2012     }
2013
2014     if (msg->type == JSONRPC_ERROR) {
2015         status = TXN_ERROR;
2016     } else if (msg->result->type != JSON_ARRAY) {
2017         VLOG_WARN_RL(&syntax_rl, "reply to \"transact\" is not JSON array");
2018         status = TXN_ERROR;
2019     } else {
2020         struct json_array *ops = &msg->result->u.array;
2021         int hard_errors = 0;
2022         int soft_errors = 0;
2023         int lock_errors = 0;
2024         size_t i;
2025
2026         for (i = 0; i < ops->n; i++) {
2027             struct json *op = ops->elems[i];
2028
2029             if (op->type == JSON_NULL) {
2030                 /* This isn't an error in itself but indicates that some prior
2031                  * operation failed, so make sure that we know about it. */
2032                 soft_errors++;
2033             } else if (op->type == JSON_OBJECT) {
2034                 struct json *error;
2035
2036                 error = shash_find_data(json_object(op), "error");
2037                 if (error) {
2038                     if (error->type == JSON_STRING) {
2039                         if (!strcmp(error->u.string, "timed out")) {
2040                             soft_errors++;
2041                         } else if (!strcmp(error->u.string, "not owner")) {
2042                             lock_errors++;
2043                         } else if (strcmp(error->u.string, "aborted")) {
2044                             hard_errors++;
2045                             ovsdb_idl_txn_set_error_json(txn, op);
2046                         }
2047                     } else {
2048                         hard_errors++;
2049                         ovsdb_idl_txn_set_error_json(txn, op);
2050                         VLOG_WARN_RL(&syntax_rl,
2051                                      "\"error\" in reply is not JSON string");
2052                     }
2053                 }
2054             } else {
2055                 hard_errors++;
2056                 ovsdb_idl_txn_set_error_json(txn, op);
2057                 VLOG_WARN_RL(&syntax_rl,
2058                              "operation reply is not JSON null or object");
2059             }
2060         }
2061
2062         if (!soft_errors && !hard_errors && !lock_errors) {
2063             struct ovsdb_idl_txn_insert *insert;
2064
2065             if (txn->inc_table && !ovsdb_idl_txn_process_inc_reply(txn, ops)) {
2066                 hard_errors++;
2067             }
2068
2069             HMAP_FOR_EACH (insert, hmap_node, &txn->inserted_rows) {
2070                 if (!ovsdb_idl_txn_process_insert_reply(insert, ops)) {
2071                     hard_errors++;
2072                 }
2073             }
2074         }
2075
2076         status = (hard_errors ? TXN_ERROR
2077                   : lock_errors ? TXN_NOT_LOCKED
2078                   : soft_errors ? TXN_TRY_AGAIN
2079                   : TXN_SUCCESS);
2080     }
2081
2082     ovsdb_idl_txn_complete(txn, status);
2083     return true;
2084 }
2085
2086 struct ovsdb_idl_txn *
2087 ovsdb_idl_txn_get(const struct ovsdb_idl_row *row)
2088 {
2089     struct ovsdb_idl_txn *txn = row->table->idl->txn;
2090     assert(txn != NULL);
2091     return txn;
2092 }
2093
2094 struct ovsdb_idl *
2095 ovsdb_idl_txn_get_idl (struct ovsdb_idl_txn *txn)
2096 {
2097     return txn->idl;
2098 }
2099 \f
2100 /* If 'lock_name' is nonnull, configures 'idl' to obtain the named lock from
2101  * the database server and to avoid modifying the database when the lock cannot
2102  * be acquired (that is, when another client has the same lock).
2103  *
2104  * If 'lock_name' is NULL, drops the locking requirement and releases the
2105  * lock. */
2106 void
2107 ovsdb_idl_set_lock(struct ovsdb_idl *idl, const char *lock_name)
2108 {
2109     assert(!idl->txn);
2110     assert(hmap_is_empty(&idl->outstanding_txns));
2111
2112     if (idl->lock_name && (!lock_name || strcmp(lock_name, idl->lock_name))) {
2113         /* Release previous lock. */
2114         ovsdb_idl_send_unlock_request(idl);
2115         free(idl->lock_name);
2116         idl->lock_name = NULL;
2117         idl->is_lock_contended = false;
2118     }
2119
2120     if (lock_name && !idl->lock_name) {
2121         /* Acquire new lock. */
2122         idl->lock_name = xstrdup(lock_name);
2123         ovsdb_idl_send_lock_request(idl);
2124     }
2125 }
2126
2127 /* Returns true if 'idl' is configured to obtain a lock and owns that lock.
2128  *
2129  * Locking and unlocking happens asynchronously from the database client's
2130  * point of view, so the information is only useful for optimization (e.g. if
2131  * the client doesn't have the lock then there's no point in trying to write to
2132  * the database). */
2133 bool
2134 ovsdb_idl_has_lock(const struct ovsdb_idl *idl)
2135 {
2136     return idl->has_lock;
2137 }
2138
2139 /* Returns true if 'idl' is configured to obtain a lock but the database server
2140  * has indicated that some other client already owns the requested lock. */
2141 bool
2142 ovsdb_idl_is_lock_contended(const struct ovsdb_idl *idl)
2143 {
2144     return idl->is_lock_contended;
2145 }
2146
2147 static void
2148 ovsdb_idl_update_has_lock(struct ovsdb_idl *idl, bool new_has_lock)
2149 {
2150     if (new_has_lock && !idl->has_lock) {
2151         if (!idl->monitor_request_id) {
2152             idl->change_seqno++;
2153         } else {
2154             /* We're waiting for a monitor reply, so don't signal that the
2155              * database changed.  The monitor reply will increment change_seqno
2156              * anyhow. */
2157         }
2158         idl->is_lock_contended = false;
2159     }
2160     idl->has_lock = new_has_lock;
2161 }
2162
2163 static void
2164 ovsdb_idl_send_lock_request__(struct ovsdb_idl *idl, const char *method,
2165                               struct json **idp)
2166 {
2167     ovsdb_idl_update_has_lock(idl, false);
2168
2169     json_destroy(idl->lock_request_id);
2170     idl->lock_request_id = NULL;
2171
2172     if (jsonrpc_session_is_connected(idl->session)) {
2173         struct json *params;
2174
2175         params = json_array_create_1(json_string_create(idl->lock_name));
2176         jsonrpc_session_send(idl->session,
2177                              jsonrpc_create_request(method, params, idp));
2178     }
2179 }
2180
2181 static void
2182 ovsdb_idl_send_lock_request(struct ovsdb_idl *idl)
2183 {
2184     ovsdb_idl_send_lock_request__(idl, "lock", &idl->lock_request_id);
2185 }
2186
2187 static void
2188 ovsdb_idl_send_unlock_request(struct ovsdb_idl *idl)
2189 {
2190     ovsdb_idl_send_lock_request__(idl, "unlock", NULL);
2191 }
2192
2193 static void
2194 ovsdb_idl_parse_lock_reply(struct ovsdb_idl *idl, const struct json *result)
2195 {
2196     bool got_lock;
2197
2198     json_destroy(idl->lock_request_id);
2199     idl->lock_request_id = NULL;
2200
2201     if (result->type == JSON_OBJECT) {
2202         const struct json *locked;
2203
2204         locked = shash_find_data(json_object(result), "locked");
2205         got_lock = locked && locked->type == JSON_TRUE;
2206     } else {
2207         got_lock = false;
2208     }
2209
2210     ovsdb_idl_update_has_lock(idl, got_lock);
2211     if (!got_lock) {
2212         idl->is_lock_contended = true;
2213     }
2214 }
2215
2216 static void
2217 ovsdb_idl_parse_lock_notify(struct ovsdb_idl *idl,
2218                             const struct json *params,
2219                             bool new_has_lock)
2220 {
2221     if (idl->lock_name
2222         && params->type == JSON_ARRAY
2223         && json_array(params)->n > 0
2224         && json_array(params)->elems[0]->type == JSON_STRING) {
2225         const char *lock_name = json_string(json_array(params)->elems[0]);
2226
2227         if (!strcmp(idl->lock_name, lock_name)) {
2228             ovsdb_idl_update_has_lock(idl, new_has_lock);
2229             if (!new_has_lock) {
2230                 idl->is_lock_contended = true;
2231             }
2232         }
2233     }
2234 }