pintos-os.org Git - openvswitch/blob - lib/ovsdb-idl.c

   1 /* Copyright (c) 2009, 2010 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 "json.h"
  29 #include "jsonrpc.h"
  30 #include "ovsdb-data.h"
  31 #include "ovsdb-error.h"
  32 #include "ovsdb-idl-provider.h"
  33 #include "poll-loop.h"
  34 #include "shash.h"
  35 #include "util.h"
  36
  37 #define THIS_MODULE VLM_ovsdb_idl
  38 #include "vlog.h"
  39
  40 /* An arc from one idl_row to another.  When row A contains a UUID that
  41  * references row B, this is represented by an arc from A (the source) to B
  42  * (the destination).
  43  *
  44  * Arcs from a row to itself are omitted, that is, src and dst are always
  45  * different.
  46  *
  47  * Arcs are never duplicated, that is, even if there are multiple references
  48  * from A to B, there is only a single arc from A to B.
  49  *
  50  * Arcs are directed: an arc from A to B is the converse of an an arc from B to
  51  * A.  Both an arc and its converse may both be present, if each row refers
  52  * to the other circularly.
  53  *
  54  * The source and destination row may be in the same table or in different
  55  * tables.
  56  */
  57 struct ovsdb_idl_arc {
  58     struct list src_node;       /* In src->src_arcs list. */
  59     struct list dst_node;       /* In dst->dst_arcs list. */
  60     struct ovsdb_idl_row *src;  /* Source row. */
  61     struct ovsdb_idl_row *dst;  /* Destination row. */
  62 };
  63
  64 struct ovsdb_idl {
  65     const struct ovsdb_idl_class *class;
  66     struct jsonrpc_session *session;
  67     struct shash table_by_name;
  68     struct ovsdb_idl_table *tables;
  69     struct json *monitor_request_id;
  70     unsigned int last_monitor_request_seqno;
  71     unsigned int change_seqno;
  72
  73     /* Transaction support. */
  74     struct ovsdb_idl_txn *txn;
  75     struct hmap outstanding_txns;
  76 };
  77
  78 struct ovsdb_idl_txn {
  79     struct hmap_node hmap_node;
  80     struct json *request_id;
  81     struct ovsdb_idl *idl;
  82     struct hmap txn_rows;
  83     enum ovsdb_idl_txn_status status;
  84     char *error;
  85     bool dry_run;
  86     struct ds comment;
  87
  88     /* Increments. */
  89     char *inc_table;
  90     char *inc_column;
  91     struct json *inc_where;
  92     unsigned int inc_index;
  93     int64_t inc_new_value;
  94
  95     /* Inserted rows. */
  96     struct hmap inserted_rows;
  97 };
  98
  99 struct ovsdb_idl_txn_insert {
 100     struct hmap_node hmap_node; /* In struct ovsdb_idl_txn's inserted_rows. */
 101     struct uuid dummy;          /* Dummy UUID used locally. */
 102     int op_index;               /* Index into transaction's operation array. */
 103     struct uuid real;           /* Real UUID used by database server. */
 104 };
 105
 106 static struct vlog_rate_limit syntax_rl = VLOG_RATE_LIMIT_INIT(1, 5);
 107 static struct vlog_rate_limit semantic_rl = VLOG_RATE_LIMIT_INIT(1, 5);
 108
 109 static void ovsdb_idl_clear(struct ovsdb_idl *);
 110 static void ovsdb_idl_send_monitor_request(struct ovsdb_idl *);
 111 static void ovsdb_idl_parse_update(struct ovsdb_idl *, const struct json *);
 112 static struct ovsdb_error *ovsdb_idl_parse_update__(struct ovsdb_idl *,
 113                                                     const struct json *);
 114 static void ovsdb_idl_process_update(struct ovsdb_idl_table *,
 115                                      const struct uuid *,
 116                                      const struct json *old,
 117                                      const struct json *new);
 118 static void ovsdb_idl_insert_row(struct ovsdb_idl_row *, const struct json *);
 119 static void ovsdb_idl_delete_row(struct ovsdb_idl_row *);
 120 static void ovsdb_idl_modify_row(struct ovsdb_idl_row *, const struct json *);
 121
 122 static bool ovsdb_idl_row_is_orphan(const struct ovsdb_idl_row *);
 123 static struct ovsdb_idl_row *ovsdb_idl_row_create__(
 124     const struct ovsdb_idl_table_class *);
 125 static struct ovsdb_idl_row *ovsdb_idl_row_create(struct ovsdb_idl_table *,
 126                                                   const struct uuid *);
 127 static void ovsdb_idl_row_destroy(struct ovsdb_idl_row *);
 128
 129 static void ovsdb_idl_row_parse(struct ovsdb_idl_row *);
 130 static void ovsdb_idl_row_unparse(struct ovsdb_idl_row *);
 131 static void ovsdb_idl_row_clear_old(struct ovsdb_idl_row *);
 132 static void ovsdb_idl_row_clear_new(struct ovsdb_idl_row *);
 133
 134 static void ovsdb_idl_txn_abort_all(struct ovsdb_idl *);
 135 static bool ovsdb_idl_txn_process_reply(struct ovsdb_idl *,
 136                                         const struct jsonrpc_msg *msg);
 137
 138 struct ovsdb_idl *
 139 ovsdb_idl_create(const char *remote, const struct ovsdb_idl_class *class)
 140 {
 141     struct ovsdb_idl *idl;
 142     size_t i;
 143
 144     idl = xzalloc(sizeof *idl);
 145     idl->class = class;
 146     idl->session = jsonrpc_session_open(remote);
 147     shash_init(&idl->table_by_name);
 148     idl->tables = xmalloc(class->n_tables * sizeof *idl->tables);
 149     for (i = 0; i < class->n_tables; i++) {
 150         const struct ovsdb_idl_table_class *tc = &class->tables[i];
 151         struct ovsdb_idl_table *table = &idl->tables[i];
 152         size_t j;
 153
 154         assert(!shash_find(&idl->table_by_name, tc->name));
 155         shash_add(&idl->table_by_name, tc->name, table);
 156         table->class = tc;
 157         shash_init(&table->columns);
 158         for (j = 0; j < tc->n_columns; j++) {
 159             const struct ovsdb_idl_column *column = &tc->columns[j];
 160
 161             assert(!shash_find(&table->columns, column->name));
 162             shash_add(&table->columns, column->name, column);
 163         }
 164         hmap_init(&table->rows);
 165         table->idl = idl;
 166     }
 167     idl->last_monitor_request_seqno = UINT_MAX;
 168     hmap_init(&idl->outstanding_txns);
 169
 170     return idl;
 171 }
 172
 173 void
 174 ovsdb_idl_destroy(struct ovsdb_idl *idl)
 175 {
 176     if (idl) {
 177         size_t i;
 178
 179         assert(!idl->txn);
 180         ovsdb_idl_clear(idl);
 181         jsonrpc_session_close(idl->session);
 182
 183         for (i = 0; i < idl->class->n_tables; i++) {
 184             struct ovsdb_idl_table *table = &idl->tables[i];
 185             shash_destroy(&table->columns);
 186             hmap_destroy(&table->rows);
 187         }
 188         shash_destroy(&idl->table_by_name);
 189         free(idl->tables);
 190         json_destroy(idl->monitor_request_id);
 191         free(idl);
 192     }
 193 }
 194
 195 static void
 196 ovsdb_idl_clear(struct ovsdb_idl *idl)
 197 {
 198     bool changed = false;
 199     size_t i;
 200
 201     for (i = 0; i < idl->class->n_tables; i++) {
 202         struct ovsdb_idl_table *table = &idl->tables[i];
 203         struct ovsdb_idl_row *row, *next_row;
 204
 205         if (hmap_is_empty(&table->rows)) {
 206             continue;
 207         }
 208
 209         changed = true;
 210         HMAP_FOR_EACH_SAFE (row, next_row, struct ovsdb_idl_row, hmap_node,
 211                             &table->rows) {
 212             struct ovsdb_idl_arc *arc, *next_arc;
 213
 214             if (!ovsdb_idl_row_is_orphan(row)) {
 215                 ovsdb_idl_row_unparse(row);
 216             }
 217             LIST_FOR_EACH_SAFE (arc, next_arc, struct ovsdb_idl_arc, src_node,
 218                                 &row->src_arcs) {
 219                 free(arc);
 220             }
 221             /* No need to do anything with dst_arcs: some node has those arcs
 222              * as forward arcs and will destroy them itself. */
 223
 224             ovsdb_idl_row_destroy(row);
 225         }
 226     }
 227
 228     if (changed) {
 229         idl->change_seqno++;
 230     }
 231 }
 232
 233 void
 234 ovsdb_idl_run(struct ovsdb_idl *idl)
 235 {
 236     int i;
 237
 238     assert(!idl->txn);
 239     jsonrpc_session_run(idl->session);
 240     for (i = 0; jsonrpc_session_is_connected(idl->session) && i < 50; i++) {
 241         struct jsonrpc_msg *msg, *reply;
 242         unsigned int seqno;
 243
 244         seqno = jsonrpc_session_get_seqno(idl->session);
 245         if (idl->last_monitor_request_seqno != seqno) {
 246             idl->last_monitor_request_seqno = seqno;
 247             ovsdb_idl_txn_abort_all(idl);
 248             ovsdb_idl_send_monitor_request(idl);
 249             break;
 250         }
 251
 252         msg = jsonrpc_session_recv(idl->session);
 253         if (!msg) {
 254             break;
 255         }
 256
 257         reply = NULL;
 258         if (msg->type == JSONRPC_NOTIFY
 259                    && !strcmp(msg->method, "update")
 260                    && msg->params->type == JSON_ARRAY
 261                    && msg->params->u.array.n == 2
 262                    && msg->params->u.array.elems[0]->type == JSON_NULL) {
 263             ovsdb_idl_parse_update(idl, msg->params->u.array.elems[1]);
 264         } else if (msg->type == JSONRPC_REPLY
 265                    && idl->monitor_request_id
 266                    && json_equal(idl->monitor_request_id, msg->id)) {
 267             json_destroy(idl->monitor_request_id);
 268             idl->monitor_request_id = NULL;
 269             ovsdb_idl_clear(idl);
 270             ovsdb_idl_parse_update(idl, msg->result);
 271         } else if (msg->type == JSONRPC_REPLY
 272                    && msg->id && msg->id->type == JSON_STRING
 273                    && !strcmp(msg->id->u.string, "echo")) {
 274             /* It's a reply to our echo request.  Ignore it. */
 275         } else if ((msg->type == JSONRPC_ERROR
 276                     || msg->type == JSONRPC_REPLY)
 277                    && ovsdb_idl_txn_process_reply(idl, msg)) {
 278             /* ovsdb_idl_txn_process_reply() did everything needful. */
 279         } else {
 280             /* This can happen if ovsdb_idl_txn_destroy() is called to destroy
 281              * a transaction before we receive the reply, so keep the log level
 282              * low. */
 283             VLOG_DBG("%s: received unexpected %s message",
 284                      jsonrpc_session_get_name(idl->session),
 285                      jsonrpc_msg_type_to_string(msg->type));
 286         }
 287         if (reply) {
 288             jsonrpc_session_send(idl->session, reply);
 289         }
 290         jsonrpc_msg_destroy(msg);
 291     }
 292 }
 293
 294 void
 295 ovsdb_idl_wait(struct ovsdb_idl *idl)
 296 {
 297     jsonrpc_session_wait(idl->session);
 298     jsonrpc_session_recv_wait(idl->session);
 299 }
 300
 301 unsigned int
 302 ovsdb_idl_get_seqno(const struct ovsdb_idl *idl)
 303 {
 304     return idl->change_seqno;
 305 }
 306
 307 bool
 308 ovsdb_idl_has_ever_connected(const struct ovsdb_idl *idl)
 309 {
 310     return ovsdb_idl_get_seqno(idl) != 0;
 311 }
 312
 313 void
 314 ovsdb_idl_force_reconnect(struct ovsdb_idl *idl)
 315 {
 316     jsonrpc_session_force_reconnect(idl->session);
 317 }
 318 \f
 319 static void
 320 ovsdb_idl_send_monitor_request(struct ovsdb_idl *idl)
 321 {
 322     struct json *monitor_requests;
 323     struct jsonrpc_msg *msg;
 324     size_t i;
 325
 326     monitor_requests = json_object_create();
 327     for (i = 0; i < idl->class->n_tables; i++) {
 328         const struct ovsdb_idl_table *table = &idl->tables[i];
 329         const struct ovsdb_idl_table_class *tc = table->class;
 330         struct json *monitor_request, *columns;
 331         size_t i;
 332
 333         monitor_request = json_object_create();
 334         columns = json_array_create_empty();
 335         for (i = 0; i < tc->n_columns; i++) {
 336             const struct ovsdb_idl_column *column = &tc->columns[i];
 337             json_array_add(columns, json_string_create(column->name));
 338         }
 339         json_object_put(monitor_request, "columns", columns);
 340         json_object_put(monitor_requests, tc->name, monitor_request);
 341     }
 342
 343     json_destroy(idl->monitor_request_id);
 344     msg = jsonrpc_create_request(
 345         "monitor",
 346         json_array_create_3(json_string_create(idl->class->database),
 347                             json_null_create(), monitor_requests),
 348         &idl->monitor_request_id);
 349     jsonrpc_session_send(idl->session, msg);
 350 }
 351
 352 static void
 353 ovsdb_idl_parse_update(struct ovsdb_idl *idl, const struct json *table_updates)
 354 {
 355     struct ovsdb_error *error;
 356
 357     idl->change_seqno++;
 358
 359     error = ovsdb_idl_parse_update__(idl, table_updates);
 360     if (error) {
 361         if (!VLOG_DROP_WARN(&syntax_rl)) {
 362             char *s = ovsdb_error_to_string(error);
 363             VLOG_WARN_RL(&syntax_rl, "%s", s);
 364             free(s);
 365         }
 366         ovsdb_error_destroy(error);
 367     }
 368 }
 369
 370 static struct ovsdb_error *
 371 ovsdb_idl_parse_update__(struct ovsdb_idl *idl,
 372                          const struct json *table_updates)
 373 {
 374     const struct shash_node *tables_node;
 375
 376     if (table_updates->type != JSON_OBJECT) {
 377         return ovsdb_syntax_error(table_updates, NULL,
 378                                   "<table-updates> is not an object");
 379     }
 380     SHASH_FOR_EACH (tables_node, json_object(table_updates)) {
 381         const struct json *table_update = tables_node->data;
 382         const struct shash_node *table_node;
 383         struct ovsdb_idl_table *table;
 384
 385         table = shash_find_data(&idl->table_by_name, tables_node->name);
 386         if (!table) {
 387             return ovsdb_syntax_error(
 388                 table_updates, NULL,
 389                 "<table-updates> includes unknown table \"%s\"",
 390                 tables_node->name);
 391         }
 392
 393         if (table_update->type != JSON_OBJECT) {
 394             return ovsdb_syntax_error(table_update, NULL,
 395                                       "<table-update> for table \"%s\" is "
 396                                       "not an object", table->class->name);
 397         }
 398         SHASH_FOR_EACH (table_node, json_object(table_update)) {
 399             const struct json *row_update = table_node->data;
 400             const struct json *old_json, *new_json;
 401             struct uuid uuid;
 402
 403             if (!uuid_from_string(&uuid, table_node->name)) {
 404                 return ovsdb_syntax_error(table_update, NULL,
 405                                           "<table-update> for table \"%s\" "
 406                                           "contains bad UUID "
 407                                           "\"%s\" as member name",
 408                                           table->class->name,
 409                                           table_node->name);
 410             }
 411             if (row_update->type != JSON_OBJECT) {
 412                 return ovsdb_syntax_error(row_update, NULL,
 413                                           "<table-update> for table \"%s\" "
 414                                           "contains <row-update> for %s that "
 415                                           "is not an object",
 416                                           table->class->name,
 417                                           table_node->name);
 418             }
 419
 420             old_json = shash_find_data(json_object(row_update), "old");
 421             new_json = shash_find_data(json_object(row_update), "new");
 422             if (old_json && old_json->type != JSON_OBJECT) {
 423                 return ovsdb_syntax_error(old_json, NULL,
 424                                           "\"old\" <row> is not object");
 425             } else if (new_json && new_json->type != JSON_OBJECT) {
 426                 return ovsdb_syntax_error(new_json, NULL,
 427                                           "\"new\" <row> is not object");
 428             } else if ((old_json != NULL) + (new_json != NULL)
 429                        != shash_count(json_object(row_update))) {
 430                 return ovsdb_syntax_error(row_update, NULL,
 431                                           "<row-update> contains unexpected "
 432                                           "member");
 433             } else if (!old_json && !new_json) {
 434                 return ovsdb_syntax_error(row_update, NULL,
 435                                           "<row-update> missing \"old\" "
 436                                           "and \"new\" members");
 437             }
 438
 439             ovsdb_idl_process_update(table, &uuid, old_json, new_json);
 440         }
 441     }
 442
 443     return NULL;
 444 }
 445
 446 static struct ovsdb_idl_row *
 447 ovsdb_idl_get_row(struct ovsdb_idl_table *table, const struct uuid *uuid)
 448 {
 449     struct ovsdb_idl_row *row;
 450
 451     HMAP_FOR_EACH_WITH_HASH (row, struct ovsdb_idl_row, hmap_node,
 452                              uuid_hash(uuid), &table->rows) {
 453         if (uuid_equals(&row->uuid, uuid)) {
 454             return row;
 455         }
 456     }
 457     return NULL;
 458 }
 459
 460 static void
 461 ovsdb_idl_process_update(struct ovsdb_idl_table *table,
 462                          const struct uuid *uuid, const struct json *old,
 463                          const struct json *new)
 464 {
 465     struct ovsdb_idl_row *row;
 466
 467     row = ovsdb_idl_get_row(table, uuid);
 468     if (!new) {
 469         /* Delete row. */
 470         if (row && !ovsdb_idl_row_is_orphan(row)) {
 471             /* XXX perhaps we should check the 'old' values? */
 472             ovsdb_idl_delete_row(row);
 473         } else {
 474             VLOG_WARN_RL(&semantic_rl, "cannot delete missing row "UUID_FMT" "
 475                          "from table %s",
 476                          UUID_ARGS(uuid), table->class->name);
 477         }
 478     } else if (!old) {
 479         /* Insert row. */
 480         if (!row) {
 481             ovsdb_idl_insert_row(ovsdb_idl_row_create(table, uuid), new);
 482         } else if (ovsdb_idl_row_is_orphan(row)) {
 483             ovsdb_idl_insert_row(row, new);
 484         } else {
 485             VLOG_WARN_RL(&semantic_rl, "cannot add existing row "UUID_FMT" to "
 486                          "table %s", UUID_ARGS(uuid), table->class->name);
 487             ovsdb_idl_modify_row(row, new);
 488         }
 489     } else {
 490         /* Modify row. */
 491         if (row) {
 492             /* XXX perhaps we should check the 'old' values? */
 493             if (!ovsdb_idl_row_is_orphan(row)) {
 494                 ovsdb_idl_modify_row(row, new);
 495             } else {
 496                 VLOG_WARN_RL(&semantic_rl, "cannot modify missing but "
 497                              "referenced row "UUID_FMT" in table %s",
 498                              UUID_ARGS(uuid), table->class->name);
 499                 ovsdb_idl_insert_row(row, new);
 500             }
 501         } else {
 502             VLOG_WARN_RL(&semantic_rl, "cannot modify missing row "UUID_FMT" "
 503                          "in table %s", UUID_ARGS(uuid), table->class->name);
 504             ovsdb_idl_insert_row(ovsdb_idl_row_create(table, uuid), new);
 505         }
 506     }
 507 }
 508
 509 static void
 510 ovsdb_idl_row_update(struct ovsdb_idl_row *row, const struct json *row_json)
 511 {
 512     struct ovsdb_idl_table *table = row->table;
 513     struct shash_node *node;
 514
 515     SHASH_FOR_EACH (node, json_object(row_json)) {
 516         const char *column_name = node->name;
 517         const struct ovsdb_idl_column *column;
 518         struct ovsdb_datum datum;
 519         struct ovsdb_error *error;
 520
 521         column = shash_find_data(&table->columns, column_name);
 522         if (!column) {
 523             VLOG_WARN_RL(&syntax_rl, "unknown column %s updating row "UUID_FMT,
 524                          column_name, UUID_ARGS(&row->uuid));
 525             continue;
 526         }
 527
 528         error = ovsdb_datum_from_json(&datum, &column->type, node->data, NULL);
 529         if (!error) {
 530             ovsdb_datum_swap(&row->old[column - table->class->columns],
 531                              &datum);
 532             ovsdb_datum_destroy(&datum, &column->type);
 533         } else {
 534             char *s = ovsdb_error_to_string(error);
 535             VLOG_WARN_RL(&syntax_rl, "error parsing column %s in row "UUID_FMT
 536                          " in table %s: %s", column_name,
 537                          UUID_ARGS(&row->uuid), table->class->name, s);
 538             free(s);
 539             ovsdb_error_destroy(error);
 540         }
 541     }
 542 }
 543
 544 /* When a row A refers to row B through a column with a "refTable" constraint,
 545  * but row B does not exist, row B is called an "orphan row".  Orphan rows
 546  * should not persist, because the database enforces referential integrity, but
 547  * they can appear transiently as changes from the database are received (the
 548  * database doesn't try to topologically sort them and circular references mean
 549  * it isn't always possible anyhow).
 550  *
 551  * This function returns true if 'row' is an orphan row, otherwise false.
 552  */
 553 static bool
 554 ovsdb_idl_row_is_orphan(const struct ovsdb_idl_row *row)
 555 {
 556     return !row->old && !row->new;
 557 }
 558
 559 /* Returns true if 'row' is conceptually part of the database as modified by
 560  * the current transaction (if any), false otherwise.
 561  *
 562  * This function will return true if 'row' is not an orphan (see the comment on
 563  * ovsdb_idl_row_is_orphan()) and:
 564  *
 565  *   - 'row' exists in the database and has not been deleted within the
 566  *     current transaction (if any).
 567  *
 568  *   - 'row' was inserted within the current transaction and has not been
 569  *     deleted.  (In the latter case you should not have passed 'row' in at
 570  *     all, because ovsdb_idl_txn_delete() freed it.)
 571  *
 572  * This function will return false if 'row' is an orphan or if 'row' was
 573  * deleted within the current transaction.
 574  */
 575 static bool
 576 ovsdb_idl_row_exists(const struct ovsdb_idl_row *row)
 577 {
 578     return row->new != NULL;
 579 }
 580
 581 static void
 582 ovsdb_idl_row_parse(struct ovsdb_idl_row *row)
 583 {
 584     const struct ovsdb_idl_table_class *class = row->table->class;
 585     size_t i;
 586
 587     for (i = 0; i < class->n_columns; i++) {
 588         const struct ovsdb_idl_column *c = &class->columns[i];
 589         (c->parse)(row, &row->old[i]);
 590     }
 591 }
 592
 593 static void
 594 ovsdb_idl_row_unparse(struct ovsdb_idl_row *row)
 595 {
 596     const struct ovsdb_idl_table_class *class = row->table->class;
 597     size_t i;
 598
 599     for (i = 0; i < class->n_columns; i++) {
 600         const struct ovsdb_idl_column *c = &class->columns[i];
 601         (c->unparse)(row);
 602     }
 603 }
 604
 605 static void
 606 ovsdb_idl_row_clear_old(struct ovsdb_idl_row *row)
 607 {
 608     assert(row->old == row->new);
 609     if (!ovsdb_idl_row_is_orphan(row)) {
 610         const struct ovsdb_idl_table_class *class = row->table->class;
 611         size_t i;
 612
 613         for (i = 0; i < class->n_columns; i++) {
 614             ovsdb_datum_destroy(&row->old[i], &class->columns[i].type);
 615         }
 616         free(row->old);
 617         row->old = row->new = NULL;
 618     }
 619 }
 620
 621 static void
 622 ovsdb_idl_row_clear_new(struct ovsdb_idl_row *row)
 623 {
 624     if (row->old != row->new) {
 625         if (row->new) {
 626             const struct ovsdb_idl_table_class *class = row->table->class;
 627             size_t i;
 628
 629             BITMAP_FOR_EACH_1 (i, class->n_columns, row->written) {
 630                 ovsdb_datum_destroy(&row->new[i], &class->columns[i].type);
 631             }
 632             free(row->new);
 633             free(row->written);
 634             row->written = NULL;
 635         }
 636         row->new = row->old;
 637     }
 638 }
 639
 640 static void
 641 ovsdb_idl_row_clear_arcs(struct ovsdb_idl_row *row, bool destroy_dsts)
 642 {
 643     struct ovsdb_idl_arc *arc, *next;
 644
 645     /* Delete all forward arcs.  If 'destroy_dsts', destroy any orphaned rows
 646      * that this causes to be unreferenced. */
 647     LIST_FOR_EACH_SAFE (arc, next, struct ovsdb_idl_arc, src_node,
 648                         &row->src_arcs) {
 649         list_remove(&arc->dst_node);
 650         if (destroy_dsts
 651             && ovsdb_idl_row_is_orphan(arc->dst)
 652             && list_is_empty(&arc->dst->dst_arcs)) {
 653             ovsdb_idl_row_destroy(arc->dst);
 654         }
 655         free(arc);
 656     }
 657     list_init(&row->src_arcs);
 658 }
 659
 660 /* Force nodes that reference 'row' to reparse. */
 661 static void
 662 ovsdb_idl_row_reparse_backrefs(struct ovsdb_idl_row *row)
 663 {
 664     struct ovsdb_idl_arc *arc, *next;
 665
 666     /* This is trickier than it looks.  ovsdb_idl_row_clear_arcs() will destroy
 667      * 'arc', so we need to use the "safe" variant of list traversal.  However,
 668      * calling an ovsdb_idl_column's 'parse' function will add an arc
 669      * equivalent to 'arc' to row->arcs.  That could be a problem for
 670      * traversal, but it adds it at the beginning of the list to prevent us
 671      * from stumbling upon it again.
 672      *
 673      * (If duplicate arcs were possible then we would need to make sure that
 674      * 'next' didn't also point into 'arc''s destination, but we forbid
 675      * duplicate arcs.) */
 676     LIST_FOR_EACH_SAFE (arc, next, struct ovsdb_idl_arc, dst_node,
 677                         &row->dst_arcs) {
 678         struct ovsdb_idl_row *ref = arc->src;
 679
 680         ovsdb_idl_row_unparse(ref);
 681         ovsdb_idl_row_clear_arcs(ref, false);
 682         ovsdb_idl_row_parse(ref);
 683     }
 684 }
 685
 686 static struct ovsdb_idl_row *
 687 ovsdb_idl_row_create__(const struct ovsdb_idl_table_class *class)
 688 {
 689     struct ovsdb_idl_row *row = xzalloc(class->allocation_size);
 690     list_init(&row->src_arcs);
 691     list_init(&row->dst_arcs);
 692     hmap_node_nullify(&row->txn_node);
 693     return row;
 694 }
 695
 696 static struct ovsdb_idl_row *
 697 ovsdb_idl_row_create(struct ovsdb_idl_table *table, const struct uuid *uuid)
 698 {
 699     struct ovsdb_idl_row *row = ovsdb_idl_row_create__(table->class);
 700     hmap_insert(&table->rows, &row->hmap_node, uuid_hash(uuid));
 701     row->uuid = *uuid;
 702     row->table = table;
 703     return row;
 704 }
 705
 706 static void
 707 ovsdb_idl_row_destroy(struct ovsdb_idl_row *row)
 708 {
 709     if (row) {
 710         ovsdb_idl_row_clear_old(row);
 711         hmap_remove(&row->table->rows, &row->hmap_node);
 712         free(row);
 713     }
 714 }
 715
 716 static void
 717 ovsdb_idl_insert_row(struct ovsdb_idl_row *row, const struct json *row_json)
 718 {
 719     const struct ovsdb_idl_table_class *class = row->table->class;
 720     size_t i;
 721
 722     assert(!row->old && !row->new);
 723     row->old = row->new = xmalloc(class->n_columns * sizeof *row->old);
 724     for (i = 0; i < class->n_columns; i++) {
 725         ovsdb_datum_init_default(&row->old[i], &class->columns[i].type);
 726     }
 727     ovsdb_idl_row_update(row, row_json);
 728     ovsdb_idl_row_parse(row);
 729
 730     ovsdb_idl_row_reparse_backrefs(row);
 731 }
 732
 733 static void
 734 ovsdb_idl_delete_row(struct ovsdb_idl_row *row)
 735 {
 736     ovsdb_idl_row_unparse(row);
 737     ovsdb_idl_row_clear_arcs(row, true);
 738     ovsdb_idl_row_clear_old(row);
 739     if (list_is_empty(&row->dst_arcs)) {
 740         ovsdb_idl_row_destroy(row);
 741     } else {
 742         ovsdb_idl_row_reparse_backrefs(row);
 743     }
 744 }
 745
 746 static void
 747 ovsdb_idl_modify_row(struct ovsdb_idl_row *row, const struct json *row_json)
 748 {
 749     ovsdb_idl_row_unparse(row);
 750     ovsdb_idl_row_clear_arcs(row, true);
 751     ovsdb_idl_row_update(row, row_json);
 752     ovsdb_idl_row_parse(row);
 753 }
 754
 755 static bool
 756 may_add_arc(const struct ovsdb_idl_row *src, const struct ovsdb_idl_row *dst)
 757 {
 758     const struct ovsdb_idl_arc *arc;
 759
 760     /* No self-arcs. */
 761     if (src == dst) {
 762         return false;
 763     }
 764
 765     /* No duplicate arcs.
 766      *
 767      * We only need to test whether the first arc in dst->dst_arcs originates
 768      * at 'src', since we add all of the arcs from a given source in a clump
 769      * (in a single call to ovsdb_idl_row_parse()) and new arcs are always
 770      * added at the front of the dst_arcs list. */
 771     if (list_is_empty(&dst->dst_arcs)) {
 772         return true;
 773     }
 774     arc = CONTAINER_OF(dst->dst_arcs.next, struct ovsdb_idl_arc, dst_node);
 775     return arc->src != src;
 776 }
 777
 778 static struct ovsdb_idl_table *
 779 ovsdb_idl_table_from_class(const struct ovsdb_idl *idl,
 780                            const struct ovsdb_idl_table_class *table_class)
 781 {
 782     return &idl->tables[table_class - idl->class->tables];
 783 }
 784
 785 struct ovsdb_idl_row *
 786 ovsdb_idl_get_row_arc(struct ovsdb_idl_row *src,
 787                       struct ovsdb_idl_table_class *dst_table_class,
 788                       const struct uuid *dst_uuid)
 789 {
 790     struct ovsdb_idl *idl = src->table->idl;
 791     struct ovsdb_idl_table *dst_table;
 792     struct ovsdb_idl_arc *arc;
 793     struct ovsdb_idl_row *dst;
 794
 795     dst_table = ovsdb_idl_table_from_class(idl, dst_table_class);
 796     dst = ovsdb_idl_get_row(dst_table, dst_uuid);
 797     if (idl->txn) {
 798         /* We're being called from ovsdb_idl_txn_write().  We must not update
 799          * any arcs, because the transaction will be backed out at commit or
 800          * abort time and we don't want our graph screwed up.
 801          *
 802          * Just return the destination row, if there is one and it has not been
 803          * deleted. */
 804         if (dst && (hmap_node_is_null(&dst->txn_node) || dst->new)) {
 805             return dst;
 806         }
 807         return NULL;
 808     } else {
 809         /* We're being called from some other context.  Update the graph. */
 810         if (!dst) {
 811             dst = ovsdb_idl_row_create(dst_table, dst_uuid);
 812         }
 813
 814         /* Add a new arc, if it wouldn't be a self-arc or a duplicate arc. */
 815         if (may_add_arc(src, dst)) {
 816             /* The arc *must* be added at the front of the dst_arcs list.  See
 817              * ovsdb_idl_row_reparse_backrefs() for details. */
 818             arc = xmalloc(sizeof *arc);
 819             list_push_front(&src->src_arcs, &arc->src_node);
 820             list_push_front(&dst->dst_arcs, &arc->dst_node);
 821             arc->src = src;
 822             arc->dst = dst;
 823         }
 824
 825         return !ovsdb_idl_row_is_orphan(dst) ? dst : NULL;
 826     }
 827 }
 828
 829 const struct ovsdb_idl_row *
 830 ovsdb_idl_get_row_for_uuid(const struct ovsdb_idl *idl,
 831                            const struct ovsdb_idl_table_class *tc,
 832                            const struct uuid *uuid)
 833 {
 834     return ovsdb_idl_get_row(ovsdb_idl_table_from_class(idl, tc), uuid);
 835 }
 836
 837 static struct ovsdb_idl_row *
 838 next_real_row(struct ovsdb_idl_table *table, struct hmap_node *node)
 839 {
 840     for (; node; node = hmap_next(&table->rows, node)) {
 841         struct ovsdb_idl_row *row;
 842
 843         row = CONTAINER_OF(node, struct ovsdb_idl_row, hmap_node);
 844         if (ovsdb_idl_row_exists(row)) {
 845             return row;
 846         }
 847     }
 848     return NULL;
 849 }
 850
 851 const struct ovsdb_idl_row *
 852 ovsdb_idl_first_row(const struct ovsdb_idl *idl,
 853                     const struct ovsdb_idl_table_class *table_class)
 854 {
 855     struct ovsdb_idl_table *table
 856         = ovsdb_idl_table_from_class(idl, table_class);
 857     return next_real_row(table, hmap_first(&table->rows));
 858 }
 859
 860 const struct ovsdb_idl_row *
 861 ovsdb_idl_next_row(const struct ovsdb_idl_row *row)
 862 {
 863     struct ovsdb_idl_table *table = row->table;
 864
 865     return next_real_row(table, hmap_next(&table->rows, &row->hmap_node));
 866 }
 867 \f
 868 /* Transactions. */
 869
 870 static void ovsdb_idl_txn_complete(struct ovsdb_idl_txn *txn,
 871                                    enum ovsdb_idl_txn_status);
 872
 873 const char *
 874 ovsdb_idl_txn_status_to_string(enum ovsdb_idl_txn_status status)
 875 {
 876     switch (status) {
 877     case TXN_UNCHANGED:
 878         return "unchanged";
 879     case TXN_INCOMPLETE:
 880         return "incomplete";
 881     case TXN_ABORTED:
 882         return "aborted";
 883     case TXN_SUCCESS:
 884         return "success";
 885     case TXN_TRY_AGAIN:
 886         return "try again";
 887     case TXN_ERROR:
 888         return "error";
 889     }
 890     return "<unknown>";
 891 }
 892
 893 struct ovsdb_idl_txn *
 894 ovsdb_idl_txn_create(struct ovsdb_idl *idl)
 895 {
 896     struct ovsdb_idl_txn *txn;
 897
 898     assert(!idl->txn);
 899     idl->txn = txn = xmalloc(sizeof *txn);
 900     txn->request_id = NULL;
 901     txn->idl = idl;
 902     hmap_init(&txn->txn_rows);
 903     txn->status = TXN_INCOMPLETE;
 904     txn->error = NULL;
 905     txn->dry_run = false;
 906     ds_init(&txn->comment);
 907
 908     txn->inc_table = NULL;
 909     txn->inc_column = NULL;
 910     txn->inc_where = NULL;
 911
 912     hmap_init(&txn->inserted_rows);
 913
 914     return txn;
 915 }
 916
 917 void
 918 ovsdb_idl_txn_add_comment(struct ovsdb_idl_txn *txn, const char *s)
 919 {
 920     if (txn->comment.length) {
 921         ds_put_char(&txn->comment, '\n');
 922     }
 923     ds_put_cstr(&txn->comment, s);
 924 }
 925
 926 void
 927 ovsdb_idl_txn_set_dry_run(struct ovsdb_idl_txn *txn)
 928 {
 929     txn->dry_run = true;
 930 }
 931
 932 void
 933 ovsdb_idl_txn_increment(struct ovsdb_idl_txn *txn, const char *table,
 934                         const char *column, const struct json *where)
 935 {
 936     assert(!txn->inc_table);
 937     txn->inc_table = xstrdup(table);
 938     txn->inc_column = xstrdup(column);
 939     txn->inc_where = where ? json_clone(where) : json_array_create_empty();
 940 }
 941
 942 void
 943 ovsdb_idl_txn_destroy(struct ovsdb_idl_txn *txn)
 944 {
 945     struct ovsdb_idl_txn_insert *insert, *next;
 946
 947     json_destroy(txn->request_id);
 948     if (txn->status == TXN_INCOMPLETE) {
 949         hmap_remove(&txn->idl->outstanding_txns, &txn->hmap_node);
 950     }
 951     ovsdb_idl_txn_abort(txn);
 952     ds_destroy(&txn->comment);
 953     free(txn->error);
 954     free(txn->inc_table);
 955     free(txn->inc_column);
 956     json_destroy(txn->inc_where);
 957     HMAP_FOR_EACH_SAFE (insert, next, struct ovsdb_idl_txn_insert, hmap_node,
 958                         &txn->inserted_rows) {
 959         free(insert);
 960     }
 961     hmap_destroy(&txn->inserted_rows);
 962     free(txn);
 963 }
 964
 965 void
 966 ovsdb_idl_txn_wait(const struct ovsdb_idl_txn *txn)
 967 {
 968     if (txn->status != TXN_INCOMPLETE) {
 969         poll_immediate_wake();
 970     }
 971 }
 972
 973 static struct json *
 974 where_uuid_equals(const struct uuid *uuid)
 975 {
 976     return
 977         json_array_create_1(
 978             json_array_create_3(
 979                 json_string_create("_uuid"),
 980                 json_string_create("=="),
 981                 json_array_create_2(
 982                     json_string_create("uuid"),
 983                     json_string_create_nocopy(
 984                         xasprintf(UUID_FMT, UUID_ARGS(uuid))))));
 985 }
 986
 987 static char *
 988 uuid_name_from_uuid(const struct uuid *uuid)
 989 {
 990     char *name;
 991     char *p;
 992
 993     name = xasprintf("row"UUID_FMT, UUID_ARGS(uuid));
 994     for (p = name; *p != '\0'; p++) {
 995         if (*p == '-') {
 996             *p = '_';
 997         }
 998     }
 999
1000     return name;
1001 }
1002
1003 static const struct ovsdb_idl_row *
1004 ovsdb_idl_txn_get_row(const struct ovsdb_idl_txn *txn, const struct uuid *uuid)
1005 {
1006     const struct ovsdb_idl_row *row;
1007
1008     HMAP_FOR_EACH_WITH_HASH (row, struct ovsdb_idl_row, txn_node,
1009                              uuid_hash(uuid), &txn->txn_rows) {
1010         if (uuid_equals(&row->uuid, uuid)) {
1011             return row;
1012         }
1013     }
1014     return NULL;
1015 }
1016
1017 /* XXX there must be a cleaner way to do this */
1018 static struct json *
1019 substitute_uuids(struct json *json, const struct ovsdb_idl_txn *txn)
1020 {
1021     if (json->type == JSON_ARRAY) {
1022         struct uuid uuid;
1023         size_t i;
1024
1025         if (json->u.array.n == 2
1026             && json->u.array.elems[0]->type == JSON_STRING
1027             && json->u.array.elems[1]->type == JSON_STRING
1028             && !strcmp(json->u.array.elems[0]->u.string, "uuid")
1029             && uuid_from_string(&uuid, json->u.array.elems[1]->u.string)) {
1030             const struct ovsdb_idl_row *row;
1031
1032             row = ovsdb_idl_txn_get_row(txn, &uuid);
1033             if (row && !row->old && row->new) {
1034                 json_destroy(json);
1035
1036                 return json_array_create_2(
1037                     json_string_create("named-uuid"),
1038                     json_string_create_nocopy(uuid_name_from_uuid(&uuid)));
1039             }
1040         }
1041
1042         for (i = 0; i < json->u.array.n; i++) {
1043             json->u.array.elems[i] = substitute_uuids(json->u.array.elems[i],
1044                                                       txn);
1045         }
1046     } else if (json->type == JSON_OBJECT) {
1047         struct shash_node *node;
1048
1049         SHASH_FOR_EACH (node, json_object(json)) {
1050             node->data = substitute_uuids(node->data, txn);
1051         }
1052     }
1053     return json;
1054 }
1055
1056 static void
1057 ovsdb_idl_txn_disassemble(struct ovsdb_idl_txn *txn)
1058 {
1059     struct ovsdb_idl_row *row, *next;
1060
1061     /* This must happen early.  Otherwise, ovsdb_idl_row_parse() will call an
1062      * ovsdb_idl_column's 'parse' function, which will call
1063      * ovsdb_idl_get_row_arc(), which will seen that the IDL is in a
1064      * transaction and fail to update the graph.  */
1065     txn->idl->txn = NULL;
1066
1067     HMAP_FOR_EACH_SAFE (row, next, struct ovsdb_idl_row, txn_node,
1068                         &txn->txn_rows) {
1069         if (row->old) {
1070             if (row->written) {
1071                 ovsdb_idl_row_unparse(row);
1072                 ovsdb_idl_row_clear_arcs(row, false);
1073                 ovsdb_idl_row_parse(row);
1074             }
1075         } else {
1076             ovsdb_idl_row_unparse(row);
1077         }
1078         ovsdb_idl_row_clear_new(row);
1079
1080         free(row->prereqs);
1081         row->prereqs = NULL;
1082
1083         free(row->written);
1084         row->written = NULL;
1085
1086         hmap_remove(&txn->txn_rows, &row->txn_node);
1087         hmap_node_nullify(&row->txn_node);
1088         if (!row->old) {
1089             hmap_remove(&row->table->rows, &row->hmap_node);
1090             free(row);
1091         }
1092     }
1093     hmap_destroy(&txn->txn_rows);
1094     hmap_init(&txn->txn_rows);
1095 }
1096
1097 enum ovsdb_idl_txn_status
1098 ovsdb_idl_txn_commit(struct ovsdb_idl_txn *txn)
1099 {
1100     struct ovsdb_idl_row *row;
1101     struct json *operations;
1102     bool any_updates;
1103
1104     if (txn != txn->idl->txn) {
1105         return txn->status;
1106     }
1107
1108     operations = json_array_create_1(
1109         json_string_create(txn->idl->class->database));
1110
1111     /* Add prerequisites and declarations of new rows. */
1112     HMAP_FOR_EACH (row, struct ovsdb_idl_row, txn_node, &txn->txn_rows) {
1113         /* XXX check that deleted rows exist even if no prereqs? */
1114         if (row->prereqs) {
1115             const struct ovsdb_idl_table_class *class = row->table->class;
1116             size_t n_columns = class->n_columns;
1117             struct json *op, *columns, *row_json;
1118             size_t idx;
1119
1120             op = json_object_create();
1121             json_array_add(operations, op);
1122             json_object_put_string(op, "op", "wait");
1123             json_object_put_string(op, "table", class->name);
1124             json_object_put(op, "timeout", json_integer_create(0));
1125             json_object_put(op, "where", where_uuid_equals(&row->uuid));
1126             json_object_put_string(op, "until", "==");
1127             columns = json_array_create_empty();
1128             json_object_put(op, "columns", columns);
1129             row_json = json_object_create();
1130             json_object_put(op, "rows", json_array_create_1(row_json));
1131
1132             BITMAP_FOR_EACH_1 (idx, n_columns, row->prereqs) {
1133                 const struct ovsdb_idl_column *column = &class->columns[idx];
1134                 json_array_add(columns, json_string_create(column->name));
1135                 json_object_put(row_json, column->name,
1136                                 ovsdb_datum_to_json(&row->old[idx],
1137                                                     &column->type));
1138             }
1139         }
1140     }
1141
1142     /* Add updates. */
1143     any_updates = false;
1144     HMAP_FOR_EACH (row, struct ovsdb_idl_row, txn_node, &txn->txn_rows) {
1145         const struct ovsdb_idl_table_class *class = row->table->class;
1146
1147         if (row->old == row->new) {
1148             continue;
1149         } else if (!row->new) {
1150             struct json *op = json_object_create();
1151             json_object_put_string(op, "op", "delete");
1152             json_object_put_string(op, "table", class->name);
1153             json_object_put(op, "where", where_uuid_equals(&row->uuid));
1154             json_array_add(operations, op);
1155             any_updates = true;
1156         } else {
1157             struct json *row_json;
1158             struct json *op;
1159             size_t idx;
1160
1161             op = json_object_create();
1162             json_object_put_string(op, "op", row->old ? "update" : "insert");
1163             json_object_put_string(op, "table", class->name);
1164             if (row->old) {
1165                 json_object_put(op, "where", where_uuid_equals(&row->uuid));
1166             } else {
1167                 struct ovsdb_idl_txn_insert *insert;
1168
1169                 json_object_put(op, "uuid-name",
1170                                 json_string_create_nocopy(
1171                                     uuid_name_from_uuid(&row->uuid)));
1172
1173                 insert = xmalloc(sizeof *insert);
1174                 insert->dummy = row->uuid;
1175                 insert->op_index = operations->u.array.n - 1;
1176                 uuid_zero(&insert->real);
1177                 hmap_insert(&txn->inserted_rows, &insert->hmap_node,
1178                             uuid_hash(&insert->dummy));
1179             }
1180             row_json = json_object_create();
1181             json_object_put(op, "row", row_json);
1182
1183             BITMAP_FOR_EACH_1 (idx, class->n_columns, row->written) {
1184                 const struct ovsdb_idl_column *column = &class->columns[idx];
1185
1186                 if (row->old
1187                     ? !ovsdb_datum_equals(&row->old[idx], &row->new[idx],
1188                                           &column->type)
1189                     : !ovsdb_datum_is_default(&row->new[idx], &column->type)) {
1190                     json_object_put(row_json, column->name,
1191                                     substitute_uuids(
1192                                         ovsdb_datum_to_json(&row->new[idx],
1193                                                             &column->type),
1194                                         txn));
1195                 }
1196             }
1197
1198             if (!row->old || !shash_is_empty(json_object(row_json))) {
1199                 json_array_add(operations, op);
1200                 any_updates = true;
1201             } else {
1202                 json_destroy(op);
1203             }
1204         }
1205     }
1206
1207     /* Add increment. */
1208     if (txn->inc_table && any_updates) {
1209         struct json *op;
1210
1211         txn->inc_index = operations->u.array.n - 1;
1212
1213         op = json_object_create();
1214         json_object_put_string(op, "op", "mutate");
1215         json_object_put_string(op, "table", txn->inc_table);
1216         json_object_put(op, "where",
1217                         substitute_uuids(json_clone(txn->inc_where), txn));
1218         json_object_put(op, "mutations",
1219                         json_array_create_1(
1220                             json_array_create_3(
1221                                 json_string_create(txn->inc_column),
1222                                 json_string_create("+="),
1223                                 json_integer_create(1))));
1224         json_array_add(operations, op);
1225
1226         op = json_object_create();
1227         json_object_put_string(op, "op", "select");
1228         json_object_put_string(op, "table", txn->inc_table);
1229         json_object_put(op, "where",
1230                         substitute_uuids(json_clone(txn->inc_where), txn));
1231         json_object_put(op, "columns",
1232                         json_array_create_1(json_string_create(
1233                                                 txn->inc_column)));
1234         json_array_add(operations, op);
1235     }
1236
1237     if (txn->comment.length) {
1238         struct json *op = json_object_create();
1239         json_object_put_string(op, "op", "comment");
1240         json_object_put_string(op, "comment", ds_cstr(&txn->comment));
1241         json_array_add(operations, op);
1242     }
1243
1244     if (txn->dry_run) {
1245         struct json *op = json_object_create();
1246         json_object_put_string(op, "op", "abort");
1247         json_array_add(operations, op);
1248     }
1249
1250     if (!any_updates) {
1251         txn->status = TXN_UNCHANGED;
1252         json_destroy(operations);
1253     } else if (!jsonrpc_session_send(
1254                    txn->idl->session,
1255                    jsonrpc_create_request(
1256                        "transact", operations, &txn->request_id))) {
1257         hmap_insert(&txn->idl->outstanding_txns, &txn->hmap_node,
1258                     json_hash(txn->request_id, 0));
1259     } else {
1260         txn->status = TXN_TRY_AGAIN;
1261     }
1262
1263     ovsdb_idl_txn_disassemble(txn);
1264     return txn->status;
1265 }
1266
1267 int64_t
1268 ovsdb_idl_txn_get_increment_new_value(const struct ovsdb_idl_txn *txn)
1269 {
1270     assert(txn->status == TXN_SUCCESS);
1271     return txn->inc_new_value;
1272 }
1273
1274 void
1275 ovsdb_idl_txn_abort(struct ovsdb_idl_txn *txn)
1276 {
1277     ovsdb_idl_txn_disassemble(txn);
1278     if (txn->status == TXN_INCOMPLETE) {
1279         txn->status = TXN_ABORTED;
1280     }
1281 }
1282
1283 const char *
1284 ovsdb_idl_txn_get_error(const struct ovsdb_idl_txn *txn)
1285 {
1286     if (txn->status != TXN_ERROR) {
1287         return ovsdb_idl_txn_status_to_string(txn->status);
1288     } else if (txn->error) {
1289         return txn->error;
1290     } else {
1291         return "no error details available";
1292     }
1293 }
1294
1295 static void
1296 ovsdb_idl_txn_set_error_json(struct ovsdb_idl_txn *txn,
1297                              const struct json *json)
1298 {
1299     if (txn->error == NULL) {
1300         txn->error = json_to_string(json, JSSF_SORT);
1301     }
1302 }
1303
1304 /* For transaction 'txn' that completed successfully, finds and returns the
1305  * permanent UUID that the database assigned to a newly inserted row, given the
1306  * 'uuid' that ovsdb_idl_txn_insert() assigned locally to that row.
1307  *
1308  * Returns NULL if 'uuid' is not a UUID assigned by ovsdb_idl_txn_insert() or
1309  * if it was assigned by that function and then deleted by
1310  * ovsdb_idl_txn_delete() within the same transaction.  (Rows that are inserted
1311  * and then deleted within a single transaction are never sent to the database
1312  * server, so it never assigns them a permanent UUID.) */
1313 const struct uuid *
1314 ovsdb_idl_txn_get_insert_uuid(const struct ovsdb_idl_txn *txn,
1315                               const struct uuid *uuid)
1316 {
1317     const struct ovsdb_idl_txn_insert *insert;
1318
1319     assert(txn->status == TXN_SUCCESS || txn->status == TXN_UNCHANGED);
1320     HMAP_FOR_EACH_IN_BUCKET (insert, struct ovsdb_idl_txn_insert, hmap_node,
1321                              uuid_hash(uuid), &txn->inserted_rows) {
1322         if (uuid_equals(uuid, &insert->dummy)) {
1323             return &insert->real;
1324         }
1325     }
1326     return NULL;
1327 }
1328
1329 static void
1330 ovsdb_idl_txn_complete(struct ovsdb_idl_txn *txn,
1331                        enum ovsdb_idl_txn_status status)
1332 {
1333     txn->status = status;
1334     hmap_remove(&txn->idl->outstanding_txns, &txn->hmap_node);
1335 }
1336
1337 void
1338 ovsdb_idl_txn_read(const struct ovsdb_idl_row *row,
1339                    const struct ovsdb_idl_column *column,
1340                    struct ovsdb_datum *datum)
1341 {
1342     const struct ovsdb_idl_table_class *class = row->table->class;
1343     size_t column_idx = column - class->columns;
1344
1345     assert(row->new != NULL);
1346     if (row->written && bitmap_is_set(row->written, column_idx)) {
1347         ovsdb_datum_clone(datum, &row->new[column_idx], &column->type);
1348     } else if (row->old) {
1349         ovsdb_datum_clone(datum, &row->old[column_idx], &column->type);
1350     } else {
1351         ovsdb_datum_init_default(datum, &column->type);
1352     }
1353 }
1354
1355 void
1356 ovsdb_idl_txn_write(const struct ovsdb_idl_row *row_,
1357                     const struct ovsdb_idl_column *column,
1358                     struct ovsdb_datum *datum)
1359 {
1360     struct ovsdb_idl_row *row = (struct ovsdb_idl_row *) row_;
1361     const struct ovsdb_idl_table_class *class = row->table->class;
1362     size_t column_idx = column - class->columns;
1363
1364     assert(row->new != NULL);
1365     assert(column_idx < class->n_columns);
1366     if (hmap_node_is_null(&row->txn_node)) {
1367         hmap_insert(&row->table->idl->txn->txn_rows, &row->txn_node,
1368                     uuid_hash(&row->uuid));
1369     }
1370     if (row->old == row->new) {
1371         row->new = xmalloc(class->n_columns * sizeof *row->new);
1372     }
1373     if (!row->written) {
1374         row->written = bitmap_allocate(class->n_columns);
1375     }
1376     if (bitmap_is_set(row->written, column_idx)) {
1377         ovsdb_datum_destroy(&row->new[column_idx], &column->type);
1378     } else {
1379         bitmap_set1(row->written, column_idx);
1380     }
1381     row->new[column_idx] = *datum;
1382     (column->unparse)(row);
1383     (column->parse)(row, &row->new[column_idx]);
1384 }
1385
1386 void
1387 ovsdb_idl_txn_verify(const struct ovsdb_idl_row *row_,
1388                      const struct ovsdb_idl_column *column)
1389 {
1390     struct ovsdb_idl_row *row = (struct ovsdb_idl_row *) row_;
1391     const struct ovsdb_idl_table_class *class = row->table->class;
1392     size_t column_idx = column - class->columns;
1393
1394     assert(row->new != NULL);
1395     if (!row->old
1396         || (row->written && bitmap_is_set(row->written, column_idx))) {
1397         return;
1398     }
1399
1400     if (hmap_node_is_null(&row->txn_node)) {
1401         hmap_insert(&row->table->idl->txn->txn_rows, &row->txn_node,
1402                     uuid_hash(&row->uuid));
1403     }
1404     if (!row->prereqs) {
1405         row->prereqs = bitmap_allocate(class->n_columns);
1406     }
1407     bitmap_set1(row->prereqs, column_idx);
1408 }
1409
1410 void
1411 ovsdb_idl_txn_delete(const struct ovsdb_idl_row *row_)
1412 {
1413     struct ovsdb_idl_row *row = (struct ovsdb_idl_row *) row_;
1414
1415     assert(row->new != NULL);
1416     if (!row->old) {
1417         ovsdb_idl_row_unparse(row);
1418         ovsdb_idl_row_clear_new(row);
1419         assert(!row->prereqs);
1420         hmap_remove(&row->table->rows, &row->hmap_node);
1421         hmap_remove(&row->table->idl->txn->txn_rows, &row->txn_node);
1422         free(row);
1423         return;
1424     }
1425     if (hmap_node_is_null(&row->txn_node)) {
1426         hmap_insert(&row->table->idl->txn->txn_rows, &row->txn_node,
1427                     uuid_hash(&row->uuid));
1428     }
1429     ovsdb_idl_row_clear_new(row);
1430     row->new = NULL;
1431 }
1432
1433 const struct ovsdb_idl_row *
1434 ovsdb_idl_txn_insert(struct ovsdb_idl_txn *txn,
1435                      const struct ovsdb_idl_table_class *class)
1436 {
1437     struct ovsdb_idl_row *row = ovsdb_idl_row_create__(class);
1438     uuid_generate(&row->uuid);
1439     row->table = ovsdb_idl_table_from_class(txn->idl, class);
1440     row->new = xmalloc(class->n_columns * sizeof *row->new);
1441     row->written = bitmap_allocate(class->n_columns);
1442     hmap_insert(&row->table->rows, &row->hmap_node, uuid_hash(&row->uuid));
1443     hmap_insert(&txn->txn_rows, &row->txn_node, uuid_hash(&row->uuid));
1444     return row;
1445 }
1446
1447 static void
1448 ovsdb_idl_txn_abort_all(struct ovsdb_idl *idl)
1449 {
1450     struct ovsdb_idl_txn *txn;
1451
1452     HMAP_FOR_EACH (txn, struct ovsdb_idl_txn, hmap_node,
1453                    &idl->outstanding_txns) {
1454         ovsdb_idl_txn_complete(txn, TXN_TRY_AGAIN);
1455     }
1456 }
1457
1458 static struct ovsdb_idl_txn *
1459 ovsdb_idl_txn_find(struct ovsdb_idl *idl, const struct json *id)
1460 {
1461     struct ovsdb_idl_txn *txn;
1462
1463     HMAP_FOR_EACH_WITH_HASH (txn, struct ovsdb_idl_txn, hmap_node,
1464                              json_hash(id, 0), &idl->outstanding_txns) {
1465         if (json_equal(id, txn->request_id)) {
1466             return txn;
1467         }
1468     }
1469     return NULL;
1470 }
1471
1472 static bool
1473 check_json_type(const struct json *json, enum json_type type, const char *name)
1474 {
1475     if (!json) {
1476         VLOG_WARN_RL(&syntax_rl, "%s is missing", name);
1477         return false;
1478     } else if (json->type != type) {
1479         VLOG_WARN_RL(&syntax_rl, "%s is %s instead of %s",
1480                      name, json_type_to_string(json->type),
1481                      json_type_to_string(type));
1482         return false;
1483     } else {
1484         return true;
1485     }
1486 }
1487
1488 static bool
1489 ovsdb_idl_txn_process_inc_reply(struct ovsdb_idl_txn *txn,
1490                                 const struct json_array *results)
1491 {
1492     struct json *count, *rows, *row, *column;
1493     struct shash *mutate, *select;
1494
1495     if (txn->inc_index + 2 > results->n) {
1496         VLOG_WARN_RL(&syntax_rl, "reply does not contain enough operations "
1497                      "for increment (has %u, needs %u)",
1498                      results->n, txn->inc_index + 2);
1499         return false;
1500     }
1501
1502     /* We know that this is a JSON object because the loop in
1503      * ovsdb_idl_txn_process_reply() checked. */
1504     mutate = json_object(results->elems[txn->inc_index]);
1505     count = shash_find_data(mutate, "count");
1506     if (!check_json_type(count, JSON_INTEGER, "\"mutate\" reply \"count\"")) {
1507         return false;
1508     }
1509     if (count->u.integer != 1) {
1510         VLOG_WARN_RL(&syntax_rl,
1511                      "\"mutate\" reply \"count\" is %"PRId64" instead of 1",
1512                      count->u.integer);
1513         return false;
1514     }
1515
1516     select = json_object(results->elems[txn->inc_index + 1]);
1517     rows = shash_find_data(select, "rows");
1518     if (!check_json_type(rows, JSON_ARRAY, "\"select\" reply \"rows\"")) {
1519         return false;
1520     }
1521     if (rows->u.array.n != 1) {
1522         VLOG_WARN_RL(&syntax_rl, "\"select\" reply \"rows\" has %u elements "
1523                      "instead of 1",
1524                      rows->u.array.n);
1525         return false;
1526     }
1527     row = rows->u.array.elems[0];
1528     if (!check_json_type(row, JSON_OBJECT, "\"select\" reply row")) {
1529         return false;
1530     }
1531     column = shash_find_data(json_object(row), txn->inc_column);
1532     if (!check_json_type(column, JSON_INTEGER,
1533                          "\"select\" reply inc column")) {
1534         return false;
1535     }
1536     txn->inc_new_value = column->u.integer;
1537     return true;
1538 }
1539
1540 static bool
1541 ovsdb_idl_txn_process_insert_reply(struct ovsdb_idl_txn_insert *insert,
1542                                    const struct json_array *results)
1543 {
1544     static const struct ovsdb_base_type uuid_type = OVSDB_BASE_UUID_INIT;
1545     struct ovsdb_error *error;
1546     struct json *json_uuid;
1547     union ovsdb_atom uuid;
1548     struct shash *reply;
1549
1550     if (insert->op_index >= results->n) {
1551         VLOG_WARN_RL(&syntax_rl, "reply does not contain enough operations "
1552                      "for insert (has %u, needs %u)",
1553                      results->n, insert->op_index);
1554         return false;
1555     }
1556
1557     /* We know that this is a JSON object because the loop in
1558      * ovsdb_idl_txn_process_reply() checked. */
1559     reply = json_object(results->elems[insert->op_index]);
1560     json_uuid = shash_find_data(reply, "uuid");
1561     if (!check_json_type(json_uuid, JSON_ARRAY, "\"insert\" reply \"uuid\"")) {
1562         return false;
1563     }
1564
1565     error = ovsdb_atom_from_json(&uuid, &uuid_type, json_uuid, NULL);
1566     if (error) {
1567         char *s = ovsdb_error_to_string(error);
1568         VLOG_WARN_RL(&syntax_rl, "\"insert\" reply \"uuid\" is not a JSON "
1569                      "UUID: %s", s);
1570         free(s);
1571         return false;
1572     }
1573
1574     insert->real = uuid.uuid;
1575
1576     return true;
1577 }
1578
1579 static bool
1580 ovsdb_idl_txn_process_reply(struct ovsdb_idl *idl,
1581                             const struct jsonrpc_msg *msg)
1582 {
1583     struct ovsdb_idl_txn *txn;
1584     enum ovsdb_idl_txn_status status;
1585
1586     txn = ovsdb_idl_txn_find(idl, msg->id);
1587     if (!txn) {
1588         return false;
1589     }
1590
1591     if (msg->type == JSONRPC_ERROR) {
1592         status = TXN_ERROR;
1593     } else if (msg->result->type != JSON_ARRAY) {
1594         VLOG_WARN_RL(&syntax_rl, "reply to \"transact\" is not JSON array");
1595         status = TXN_ERROR;
1596     } else {
1597         struct json_array *ops = &msg->result->u.array;
1598         int hard_errors = 0;
1599         int soft_errors = 0;
1600         size_t i;
1601
1602         for (i = 0; i < ops->n; i++) {
1603             struct json *op = ops->elems[i];
1604
1605             if (op->type == JSON_NULL) {
1606                 /* This isn't an error in itself but indicates that some prior
1607                  * operation failed, so make sure that we know about it. */
1608                 soft_errors++;
1609             } else if (op->type == JSON_OBJECT) {
1610                 struct json *error;
1611
1612                 error = shash_find_data(json_object(op), "error");
1613                 if (error) {
1614                     if (error->type == JSON_STRING) {
1615                         if (!strcmp(error->u.string, "timed out")) {
1616                             soft_errors++;
1617                         } else if (strcmp(error->u.string, "aborted")) {
1618                             hard_errors++;
1619                             ovsdb_idl_txn_set_error_json(txn, op);
1620                         }
1621                     } else {
1622                         hard_errors++;
1623                         ovsdb_idl_txn_set_error_json(txn, op);
1624                         VLOG_WARN_RL(&syntax_rl,
1625                                      "\"error\" in reply is not JSON string");
1626                     }
1627                 }
1628             } else {
1629                 hard_errors++;
1630                 ovsdb_idl_txn_set_error_json(txn, op);
1631                 VLOG_WARN_RL(&syntax_rl,
1632                              "operation reply is not JSON null or object");
1633             }
1634         }
1635
1636         if (!soft_errors && !hard_errors) {
1637             struct ovsdb_idl_txn_insert *insert;
1638
1639             if (txn->inc_table && !ovsdb_idl_txn_process_inc_reply(txn, ops)) {
1640                 hard_errors++;
1641             }
1642
1643             HMAP_FOR_EACH (insert, struct ovsdb_idl_txn_insert, hmap_node,
1644                            &txn->inserted_rows) {
1645                 if (!ovsdb_idl_txn_process_insert_reply(insert, ops)) {
1646                     hard_errors++;
1647                 }
1648             }
1649         }
1650
1651         status = (hard_errors ? TXN_ERROR
1652                   : soft_errors ? TXN_TRY_AGAIN
1653                   : TXN_SUCCESS);
1654     }
1655
1656     ovsdb_idl_txn_complete(txn, status);
1657     return true;
1658 }
1659
1660 struct ovsdb_idl_txn *
1661 ovsdb_idl_txn_get(const struct ovsdb_idl_row *row)
1662 {
1663     struct ovsdb_idl_txn *txn = row->table->idl->txn;
1664     assert(txn != NULL);
1665     return txn;
1666 }