ovsdb/transaction.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 "transaction.h"
  19
  20 #include <assert.h>
  21
  22 #include "bitmap.h"
  23 #include "dynamic-string.h"
  24 #include "hash.h"
  25 #include "hmap.h"
  26 #include "json.h"
  27 #include "list.h"
  28 #include "ovsdb-error.h"
  29 #include "ovsdb.h"
  30 #include "row.h"
  31 #include "table.h"
  32 #include "uuid.h"
  33
  34 struct ovsdb_txn {
  35     struct ovsdb *db;
  36     struct list txn_tables;     /* Contains "struct ovsdb_txn_table"s. */
  37     struct ds comment;
  38 };
  39
  40 /* A table modified by a transaction. */
  41 struct ovsdb_txn_table {
  42     struct list node;           /* Element in ovsdb_txn's txn_tables list. */
  43     struct ovsdb_table *table;
  44     struct hmap txn_rows;       /* Contains "struct ovsdb_txn_row"s. */
  45
  46     /* Used by for_each_txn_row(). */
  47     unsigned int serial;        /* Serial number of in-progress iteration. */
  48     unsigned int n_processed;   /* Number of rows processed. */
  49 };
  50
  51 /* A row modified by the transaction:
  52  *
  53  *      - A row added by a transaction will have null 'old' and non-null 'new'.
  54  *
  55  *      - A row deleted by a transaction will have non-null 'old' and null
  56  *        'new'.
  57  *
  58  *      - A row modified by a transaction will have non-null 'old' and 'new'.
  59  *
  60  *      - 'old' and 'new' both null is invalid.  It would indicate that a row
  61  *        was added then deleted within a single transaction, but we instead
  62  *        handle that case by deleting the txn_row entirely.
  63  */
  64 struct ovsdb_txn_row {
  65     struct hmap_node hmap_node; /* In ovsdb_txn_table's txn_rows hmap. */
  66     struct ovsdb_row *old;      /* The old row. */
  67     struct ovsdb_row *new;      /* The new row. */
  68     size_t n_refs;              /* Number of remaining references. */
  69
  70     /* Used by for_each_txn_row(). */
  71     unsigned int serial;        /* Serial number of in-progress commit. */
  72
  73     unsigned long changed[];    /* Bits set to 1 for columns that changed. */
  74 };
  75
  76 static void ovsdb_txn_row_prefree(struct ovsdb_txn_row *);
  77 static struct ovsdb_error * WARN_UNUSED_RESULT
  78 for_each_txn_row(struct ovsdb_txn *txn,
  79                       struct ovsdb_error *(*)(struct ovsdb_txn *,
  80                                               struct ovsdb_txn_row *));
  81
  82 /* Used by for_each_txn_row() to track tables and rows that have been
  83  * processed.  */
  84 static unsigned int serial;
  85
  86 struct ovsdb_txn *
  87 ovsdb_txn_create(struct ovsdb *db)
  88 {
  89     struct ovsdb_txn *txn = xmalloc(sizeof *txn);
  90     txn->db = db;
  91     list_init(&txn->txn_tables);
  92     ds_init(&txn->comment);
  93     return txn;
  94 }
  95
  96 static void
  97 ovsdb_txn_free(struct ovsdb_txn *txn)
  98 {
  99     assert(list_is_empty(&txn->txn_tables));
 100     ds_destroy(&txn->comment);
 101     free(txn);
 102 }
 103
 104 static struct ovsdb_error *
 105 ovsdb_txn_row_abort(struct ovsdb_txn *txn OVS_UNUSED,
 106                     struct ovsdb_txn_row *txn_row)
 107 {
 108     struct ovsdb_row *old = txn_row->old;
 109     struct ovsdb_row *new = txn_row->new;
 110
 111     ovsdb_txn_row_prefree(txn_row);
 112     if (!old) {
 113         hmap_remove(&new->table->rows, &new->hmap_node);
 114     } else if (!new) {
 115         hmap_insert(&old->table->rows, &old->hmap_node, ovsdb_row_hash(old));
 116     } else {
 117         hmap_replace(&new->table->rows, &new->hmap_node, &old->hmap_node);
 118     }
 119     ovsdb_row_destroy(new);
 120     free(txn_row);
 121
 122     return NULL;
 123 }
 124
 125 void
 126 ovsdb_txn_abort(struct ovsdb_txn *txn)
 127 {
 128     ovsdb_error_assert(for_each_txn_row(txn, ovsdb_txn_row_abort));
 129     ovsdb_txn_free(txn);
 130 }
 131
 132 static struct ovsdb_txn_row *
 133 find_txn_row(const struct ovsdb_table *table, const struct uuid *uuid)
 134 {
 135     struct ovsdb_txn_row *txn_row;
 136
 137     if (!table->txn_table) {
 138         return NULL;
 139     }
 140
 141     HMAP_FOR_EACH_WITH_HASH (txn_row, hmap_node,
 142                              uuid_hash(uuid), &table->txn_table->txn_rows) {
 143         const struct ovsdb_row *row;
 144
 145         row = txn_row->old ? txn_row->old : txn_row->new;
 146         if (uuid_equals(uuid, ovsdb_row_get_uuid(row))) {
 147             return txn_row;
 148         }
 149     }
 150
 151     return NULL;
 152 }
 153
 154 static struct ovsdb_error * WARN_UNUSED_RESULT
 155 ovsdb_txn_adjust_atom_refs(struct ovsdb_txn *txn, const struct ovsdb_row *r,
 156                            const struct ovsdb_column *c,
 157                            const struct ovsdb_base_type *base,
 158                            const union ovsdb_atom *atoms, unsigned int n,
 159                            int delta)
 160 {
 161     const struct ovsdb_table *table;
 162     unsigned int i;
 163
 164     if (!ovsdb_base_type_is_strong_ref(base)) {
 165         return NULL;
 166     }
 167
 168     table = base->u.uuid.refTable;
 169     for (i = 0; i < n; i++) {
 170         const struct uuid *uuid = &atoms[i].uuid;
 171         struct ovsdb_txn_row *txn_row = find_txn_row(table, uuid);
 172         if (!txn_row) {
 173             const struct ovsdb_row *row = ovsdb_table_get_row(table, uuid);
 174             if (row) {
 175                 txn_row = ovsdb_txn_row_modify(txn, row)->txn_row;
 176             } else {
 177                 return ovsdb_error("referential integrity violation",
 178                                    "Table %s column %s row "UUID_FMT" "
 179                                    "references nonexistent row "UUID_FMT" in "
 180                                    "table %s.",
 181                                    r->table->schema->name, c->name,
 182                                    UUID_ARGS(ovsdb_row_get_uuid(r)),
 183                                    UUID_ARGS(uuid), table->schema->name);
 184             }
 185         }
 186         txn_row->n_refs += delta;
 187     }
 188
 189     return NULL;
 190 }
 191
 192 static struct ovsdb_error * WARN_UNUSED_RESULT
 193 ovsdb_txn_adjust_row_refs(struct ovsdb_txn *txn, const struct ovsdb_row *r,
 194                           const struct ovsdb_column *column, int delta)
 195 {
 196     const struct ovsdb_datum *field = &r->fields[column->index];
 197     struct ovsdb_error *error;
 198
 199     error = ovsdb_txn_adjust_atom_refs(txn, r, column, &column->type.key,
 200                                        field->keys, field->n, delta);
 201     if (!error) {
 202         error = ovsdb_txn_adjust_atom_refs(txn, r, column, &column->type.value,
 203                                            field->values, field->n, delta);
 204     }
 205     return error;
 206 }
 207
 208 static struct ovsdb_error * WARN_UNUSED_RESULT
 209 update_row_ref_count(struct ovsdb_txn *txn, struct ovsdb_txn_row *r)
 210 {
 211     struct ovsdb_table *table = r->old ? r->old->table : r->new->table;
 212     struct shash_node *node;
 213
 214     SHASH_FOR_EACH (node, &table->schema->columns) {
 215         const struct ovsdb_column *column = node->data;
 216         struct ovsdb_error *error;
 217
 218         if (r->old) {
 219             error = ovsdb_txn_adjust_row_refs(txn, r->old, column, -1);
 220             if (error) {
 221                 ovsdb_error_destroy(error);
 222                 return OVSDB_BUG("error decreasing refcount");
 223             }
 224         }
 225         if (r->new) {
 226             error = ovsdb_txn_adjust_row_refs(txn, r->new, column, 1);
 227             if (error) {
 228                 return error;
 229             }
 230         }
 231     }
 232
 233     return NULL;
 234 }
 235
 236 static struct ovsdb_error * WARN_UNUSED_RESULT
 237 check_ref_count(struct ovsdb_txn *txn OVS_UNUSED, struct ovsdb_txn_row *r)
 238 {
 239     if (r->new || !r->n_refs) {
 240         return NULL;
 241     } else {
 242         return ovsdb_error("referential integrity violation",
 243                            "cannot delete %s row "UUID_FMT" because "
 244                            "of %zu remaining reference(s)",
 245                            r->old->table->schema->name,
 246                            UUID_ARGS(ovsdb_row_get_uuid(r->old)),
 247                            r->n_refs);
 248     }
 249 }
 250
 251 static struct ovsdb_error * WARN_UNUSED_RESULT
 252 update_ref_counts(struct ovsdb_txn *txn)
 253 {
 254     struct ovsdb_error *error;
 255
 256     error = for_each_txn_row(txn, update_row_ref_count);
 257     if (error) {
 258         return error;
 259     }
 260
 261     return for_each_txn_row(txn, check_ref_count);
 262 }
 263
 264 static struct ovsdb_error *
 265 ovsdb_txn_row_commit(struct ovsdb_txn *txn OVS_UNUSED,
 266                      struct ovsdb_txn_row *txn_row)
 267 {
 268     ovsdb_txn_row_prefree(txn_row);
 269     if (txn_row->new) {
 270         txn_row->new->n_refs = txn_row->n_refs;
 271     }
 272     ovsdb_row_destroy(txn_row->old);
 273     free(txn_row);
 274
 275     return NULL;
 276 }
 277
 278 static void
 279 add_weak_ref(struct ovsdb_txn *txn,
 280              const struct ovsdb_row *src_, const struct ovsdb_row *dst_)
 281 {
 282     struct ovsdb_row *src = (struct ovsdb_row *) src_;
 283     struct ovsdb_row *dst = (struct ovsdb_row *) dst_;
 284     struct ovsdb_weak_ref *weak;
 285
 286     if (src == dst) {
 287         return;
 288     }
 289
 290     dst = ovsdb_txn_row_modify(txn, dst);
 291
 292     if (!list_is_empty(&dst->dst_refs)) {
 293         /* Omit duplicates. */
 294         weak = CONTAINER_OF(list_back(&dst->dst_refs),
 295                             struct ovsdb_weak_ref, dst_node);
 296         if (weak->src == src) {
 297             return;
 298         }
 299     }
 300
 301     weak = xmalloc(sizeof *weak);
 302     weak->src = src;
 303     list_push_back(&dst->dst_refs, &weak->dst_node);
 304     list_push_back(&src->src_refs, &weak->src_node);
 305 }
 306
 307 static struct ovsdb_error * WARN_UNUSED_RESULT
 308 assess_weak_refs(struct ovsdb_txn *txn, struct ovsdb_txn_row *txn_row)
 309 {
 310     struct ovsdb_table *table;
 311     struct shash_node *node;
 312
 313     if (txn_row->old) {
 314         /* Mark rows that have weak references to 'txn_row' as modified, so
 315          * that their weak references will get reassessed. */
 316         struct ovsdb_weak_ref *weak, *next;
 317
 318         LIST_FOR_EACH_SAFE (weak, next, dst_node, &txn_row->old->dst_refs) {
 319             if (!weak->src->txn_row) {
 320                 ovsdb_txn_row_modify(txn, weak->src);
 321             }
 322         }
 323     }
 324
 325     if (!txn_row->new) {
 326         /* We don't have to do anything about references that originate at
 327          * 'txn_row', because ovsdb_row_destroy() will remove those weak
 328          * references. */
 329         return NULL;
 330     }
 331
 332     table = txn_row->new->table;
 333     SHASH_FOR_EACH (node, &table->schema->columns) {
 334         const struct ovsdb_column *column = node->data;
 335         struct ovsdb_datum *datum = &txn_row->new->fields[column->index];
 336         unsigned int orig_n, i;
 337         bool zero = false;
 338
 339         orig_n = datum->n;
 340
 341         if (ovsdb_base_type_is_weak_ref(&column->type.key)) {
 342             for (i = 0; i < datum->n; ) {
 343                 const struct ovsdb_row *row;
 344
 345                 row = ovsdb_table_get_row(column->type.key.u.uuid.refTable,
 346                                           &datum->keys[i].uuid);
 347                 if (row) {
 348                     add_weak_ref(txn, txn_row->new, row);
 349                     i++;
 350                 } else {
 351                     if (uuid_is_zero(&datum->keys[i].uuid)) {
 352                         zero = true;
 353                     }
 354                     ovsdb_datum_remove_unsafe(datum, i, &column->type);
 355                 }
 356             }
 357         }
 358
 359         if (ovsdb_base_type_is_weak_ref(&column->type.value)) {
 360             for (i = 0; i < datum->n; ) {
 361                 const struct ovsdb_row *row;
 362
 363                 row = ovsdb_table_get_row(column->type.value.u.uuid.refTable,
 364                                           &datum->values[i].uuid);
 365                 if (row) {
 366                     add_weak_ref(txn, txn_row->new, row);
 367                     i++;
 368                 } else {
 369                     if (uuid_is_zero(&datum->values[i].uuid)) {
 370                         zero = true;
 371                     }
 372                     ovsdb_datum_remove_unsafe(datum, i, &column->type);
 373                 }
 374             }
 375         }
 376
 377         if (datum->n != orig_n) {
 378             bitmap_set1(txn_row->changed, column->index);
 379             ovsdb_datum_sort_assert(datum, column->type.key.type);
 380             if (datum->n < column->type.n_min) {
 381                 const struct uuid *row_uuid = ovsdb_row_get_uuid(txn_row->new);
 382                 if (zero && !txn_row->old) {
 383                     return ovsdb_error(
 384                         "constraint violation",
 385                         "Weak reference column \"%s\" in \"%s\" row "UUID_FMT
 386                         " (inserted within this transaction) contained "
 387                         "all-zeros UUID (probably as the default value for "
 388                         "this column) but deleting this value caused a "
 389                         "constraint volation because this column is not "
 390                         "allowed to be empty.", column->name,
 391                         table->schema->name, UUID_ARGS(row_uuid));
 392                 } else {
 393                     return ovsdb_error(
 394                         "constraint violation",
 395                         "Deletion of %u weak reference(s) to deleted (or "
 396                         "never-existing) rows from column \"%s\" in \"%s\" "
 397                         "row "UUID_FMT" %scaused this column to become empty, "
 398                         "but constraints on this column disallow an "
 399                         "empty column.",
 400                         orig_n - datum->n, column->name, table->schema->name,
 401                         UUID_ARGS(row_uuid),
 402                         (txn_row->old
 403                          ? ""
 404                          : "(inserted within this transaction) "));
 405                 }
 406             }
 407         }
 408     }
 409
 410     return NULL;
 411 }
 412
 413 static struct ovsdb_error * WARN_UNUSED_RESULT
 414 determine_changes(struct ovsdb_txn *txn, struct ovsdb_txn_row *txn_row)
 415 {
 416     struct ovsdb_table *table;
 417
 418     table = (txn_row->old ? txn_row->old : txn_row->new)->table;
 419     if (txn_row->old && txn_row->new) {
 420         struct shash_node *node;
 421         bool changed = false;
 422
 423         SHASH_FOR_EACH (node, &table->schema->columns) {
 424             const struct ovsdb_column *column = node->data;
 425             const struct ovsdb_type *type = &column->type;
 426             unsigned int idx = column->index;
 427
 428             if (!ovsdb_datum_equals(&txn_row->old->fields[idx],
 429                                     &txn_row->new->fields[idx],
 430                                     type)) {
 431                 bitmap_set1(txn_row->changed, idx);
 432                 changed = true;
 433             }
 434         }
 435
 436         if (!changed) {
 437             /* Nothing actually changed in this row, so drop it. */
 438             ovsdb_txn_row_abort(txn, txn_row);
 439         }
 440     } else {
 441         bitmap_set_multiple(txn_row->changed, 0,
 442                             shash_count(&table->schema->columns), 1);
 443     }
 444
 445     return NULL;
 446 }
 447
 448 static struct ovsdb_error * WARN_UNUSED_RESULT
 449 check_max_rows(struct ovsdb_txn *txn)
 450 {
 451     struct ovsdb_txn_table *t;
 452
 453     LIST_FOR_EACH (t, node, &txn->txn_tables) {
 454         size_t n_rows = hmap_count(&t->table->rows);
 455         unsigned int max_rows = t->table->schema->max_rows;
 456
 457         if (n_rows > max_rows) {
 458             return ovsdb_error("constraint violation",
 459                                "transaction causes \"%s\" table to contain "
 460                                "%zu rows, greater than the schema-defined "
 461                                "limit of %u row(s)",
 462                                t->table->schema->name, n_rows, max_rows);
 463         }
 464     }
 465
 466     return NULL;
 467 }
 468
 469 struct ovsdb_error *
 470 ovsdb_txn_commit(struct ovsdb_txn *txn, bool durable)
 471 {
 472     struct ovsdb_replica *replica;
 473     struct ovsdb_error *error;
 474
 475     /* Figure out what actually changed, and abort early if the transaction
 476      * was really a no-op. */
 477     error = for_each_txn_row(txn, determine_changes);
 478     if (error) {
 479         ovsdb_error_destroy(error);
 480         return OVSDB_BUG("can't happen");
 481     }
 482     if (list_is_empty(&txn->txn_tables)) {
 483         ovsdb_txn_abort(txn);
 484         return NULL;
 485     }
 486
 487     /* Check maximum rows table constraints. */
 488     error = check_max_rows(txn);
 489     if (error) {
 490         ovsdb_txn_abort(txn);
 491         return error;
 492     }
 493
 494     /* Update reference counts and check referential integrity. */
 495     error = update_ref_counts(txn);
 496     if (error) {
 497         ovsdb_txn_abort(txn);
 498         return error;
 499     }
 500
 501     /* Check reference counts and remove bad reference for "weak" referential
 502      * integrity. */
 503     error = for_each_txn_row(txn, assess_weak_refs);
 504     if (error) {
 505         ovsdb_txn_abort(txn);
 506         return error;
 507     }
 508
 509     /* Send the commit to each replica. */
 510     LIST_FOR_EACH (replica, node, &txn->db->replicas) {
 511         error = (replica->class->commit)(replica, txn, durable);
 512         if (error) {
 513             /* We don't support two-phase commit so only the first replica is
 514              * allowed to report an error. */
 515             assert(&replica->node == txn->db->replicas.next);
 516
 517             ovsdb_txn_abort(txn);
 518             return error;
 519         }
 520     }
 521
 522     /* Finalize commit. */
 523     txn->db->run_triggers = true;
 524     ovsdb_error_assert(for_each_txn_row(txn, ovsdb_txn_row_commit));
 525     ovsdb_txn_free(txn);
 526
 527     return NULL;
 528 }
 529
 530 void
 531 ovsdb_txn_for_each_change(const struct ovsdb_txn *txn,
 532                           ovsdb_txn_row_cb_func *cb, void *aux)
 533 {
 534     struct ovsdb_txn_table *t;
 535     struct ovsdb_txn_row *r;
 536
 537     LIST_FOR_EACH (t, node, &txn->txn_tables) {
 538         HMAP_FOR_EACH (r, hmap_node, &t->txn_rows) {
 539             if (!cb(r->old, r->new, r->changed, aux)) {
 540                 break;
 541             }
 542         }
 543    }
 544 }
 545
 546 static struct ovsdb_txn_table *
 547 ovsdb_txn_create_txn_table(struct ovsdb_txn *txn, struct ovsdb_table *table)
 548 {
 549     if (!table->txn_table) {
 550         struct ovsdb_txn_table *txn_table;
 551
 552         table->txn_table = txn_table = xmalloc(sizeof *table->txn_table);
 553         txn_table->table = table;
 554         hmap_init(&txn_table->txn_rows);
 555         txn_table->serial = serial - 1;
 556         list_push_back(&txn->txn_tables, &txn_table->node);
 557     }
 558     return table->txn_table;
 559 }
 560
 561 static struct ovsdb_txn_row *
 562 ovsdb_txn_row_create(struct ovsdb_txn *txn, struct ovsdb_table *table,
 563                      const struct ovsdb_row *old_, struct ovsdb_row *new)
 564 {
 565     struct ovsdb_row *old = (struct ovsdb_row *) old_;
 566     size_t n_columns = shash_count(&table->schema->columns);
 567     struct ovsdb_txn_table *txn_table;
 568     struct ovsdb_txn_row *txn_row;
 569
 570     txn_row = xzalloc(offsetof(struct ovsdb_txn_row, changed)
 571                       + bitmap_n_bytes(n_columns));
 572     txn_row->old = (struct ovsdb_row *) old;
 573     txn_row->new = new;
 574     txn_row->n_refs = old ? old->n_refs : 0;
 575     txn_row->serial = serial - 1;
 576
 577     if (old) {
 578         old->txn_row = txn_row;
 579     }
 580     if (new) {
 581         new->txn_row = txn_row;
 582     }
 583
 584     txn_table = ovsdb_txn_create_txn_table(txn, table);
 585     hmap_insert(&txn_table->txn_rows, &txn_row->hmap_node,
 586                 ovsdb_row_hash(old ? old : new));
 587
 588     return txn_row;
 589 }
 590
 591 struct ovsdb_row *
 592 ovsdb_txn_row_modify(struct ovsdb_txn *txn, const struct ovsdb_row *ro_row_)
 593 {
 594     struct ovsdb_row *ro_row = (struct ovsdb_row *) ro_row_;
 595
 596     if (ro_row->txn_row) {
 597         assert(ro_row == ro_row->txn_row->new);
 598         return ro_row;
 599     } else {
 600         struct ovsdb_table *table = ro_row->table;
 601         struct ovsdb_row *rw_row;
 602
 603         rw_row = ovsdb_row_clone(ro_row);
 604         rw_row->n_refs = ro_row->n_refs;
 605         uuid_generate(ovsdb_row_get_version_rw(rw_row));
 606         ovsdb_txn_row_create(txn, table, ro_row, rw_row);
 607         hmap_replace(&table->rows, &ro_row->hmap_node, &rw_row->hmap_node);
 608
 609         return rw_row;
 610     }
 611 }
 612
 613 void
 614 ovsdb_txn_row_insert(struct ovsdb_txn *txn, struct ovsdb_row *row)
 615 {
 616     uint32_t hash = ovsdb_row_hash(row);
 617     struct ovsdb_table *table = row->table;
 618
 619     uuid_generate(ovsdb_row_get_version_rw(row));
 620
 621     ovsdb_txn_row_create(txn, table, NULL, row);
 622     hmap_insert(&table->rows, &row->hmap_node, hash);
 623 }
 624
 625 /* 'row' must be assumed destroyed upon return; the caller must not reference
 626  * it again. */
 627 void
 628 ovsdb_txn_row_delete(struct ovsdb_txn *txn, const struct ovsdb_row *row_)
 629 {
 630     struct ovsdb_row *row = (struct ovsdb_row *) row_;
 631     struct ovsdb_table *table = row->table;
 632     struct ovsdb_txn_row *txn_row = row->txn_row;
 633
 634     hmap_remove(&table->rows, &row->hmap_node);
 635
 636     if (!txn_row) {
 637         ovsdb_txn_row_create(txn, table, row, NULL);
 638     } else {
 639         assert(txn_row->new == row);
 640         if (txn_row->old) {
 641             txn_row->new = NULL;
 642         } else {
 643             hmap_remove(&table->txn_table->txn_rows, &txn_row->hmap_node);
 644             free(txn_row);
 645         }
 646         ovsdb_row_destroy(row);
 647     }
 648 }
 649
 650 void
 651 ovsdb_txn_add_comment(struct ovsdb_txn *txn, const char *s)
 652 {
 653     if (txn->comment.length) {
 654         ds_put_char(&txn->comment, '\n');
 655     }
 656     ds_put_cstr(&txn->comment, s);
 657 }
 658
 659 const char *
 660 ovsdb_txn_get_comment(const struct ovsdb_txn *txn)
 661 {
 662     return txn->comment.length ? ds_cstr_ro(&txn->comment) : NULL;
 663 }
 664 \f
 665 static void
 666 ovsdb_txn_row_prefree(struct ovsdb_txn_row *txn_row)
 667 {
 668     struct ovsdb_row *row = txn_row->old ? txn_row->old : txn_row->new;
 669     struct ovsdb_txn_table *txn_table = row->table->txn_table;
 670
 671     txn_table->n_processed--;
 672     hmap_remove(&txn_table->txn_rows, &txn_row->hmap_node);
 673
 674     if (txn_row->old) {
 675         txn_row->old->txn_row = NULL;
 676     }
 677     if (txn_row->new) {
 678         txn_row->new->txn_row = NULL;
 679     }
 680 }
 681
 682 static void
 683 ovsdb_txn_table_destroy(struct ovsdb_txn_table *txn_table)
 684 {
 685     assert(hmap_is_empty(&txn_table->txn_rows));
 686     txn_table->table->txn_table = NULL;
 687     hmap_destroy(&txn_table->txn_rows);
 688     list_remove(&txn_table->node);
 689     free(txn_table);
 690 }
 691
 692 /* Calls 'cb' for every txn_row within 'txn'.  If 'cb' returns nonnull, this
 693  * aborts the iteration and for_each_txn_row() passes the error up.  Otherwise,
 694  * returns a null pointer after iteration is complete.
 695  *
 696  * 'cb' may insert new txn_rows and new txn_tables into 'txn'.  It may delete
 697  * the txn_row that it is passed in, or txn_rows in txn_tables other than the
 698  * one passed to 'cb'.  It may *not* delete txn_rows other than the one passed
 699  * in within the same txn_table.  It may *not* delete any txn_tables.  As long
 700  * as these rules are followed, 'cb' will be called exactly once for each
 701  * txn_row in 'txn', even those added by 'cb'.
 702  */
 703 static struct ovsdb_error * WARN_UNUSED_RESULT
 704 for_each_txn_row(struct ovsdb_txn *txn,
 705                  struct ovsdb_error *(*cb)(struct ovsdb_txn *,
 706                                            struct ovsdb_txn_row *))
 707 {
 708     bool any_work;
 709
 710     serial++;
 711
 712     do {
 713         struct ovsdb_txn_table *t, *next_txn_table;
 714
 715         any_work = false;
 716         LIST_FOR_EACH_SAFE (t, next_txn_table, node, &txn->txn_tables) {
 717             if (t->serial != serial) {
 718                 t->serial = serial;
 719                 t->n_processed = 0;
 720             }
 721
 722             while (t->n_processed < hmap_count(&t->txn_rows)) {
 723                 struct ovsdb_txn_row *r, *next_txn_row;
 724
 725                 HMAP_FOR_EACH_SAFE (r, next_txn_row, hmap_node, &t->txn_rows) {
 726                     if (r->serial != serial) {
 727                         struct ovsdb_error *error;
 728
 729                         r->serial = serial;
 730                         t->n_processed++;
 731                         any_work = true;
 732
 733                         error = cb(txn, r);
 734                         if (error) {
 735                             return error;
 736                         }
 737                     }
 738                 }
 739             }
 740             if (hmap_is_empty(&t->txn_rows)) {
 741                 /* Table is empty.  Drop it. */
 742                 ovsdb_txn_table_destroy(t);
 743             }
 744         }
 745     } while (any_work);
 746
 747     return NULL;
 748 }