2 * Copyright (c) 2015 Nicira, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
23 #include "dynamic-string.h"
26 #include "ovsdb-error.h"
27 #include "ovsdb-parser.h"
35 #include "transaction.h"
36 #include "jsonrpc-server.h"
38 #include "openvswitch/vlog.h"
41 static const struct ovsdb_replica_class ovsdb_jsonrpc_replica_class;
42 static struct hmap ovsdb_monitors = HMAP_INITIALIZER(&ovsdb_monitors);
46 * ovsdb_monitor keep track of the ovsdb changes.
49 /* A collection of tables being monitored. */
50 struct ovsdb_monitor {
51 struct ovsdb_replica replica;
52 struct shash tables; /* Holds "struct ovsdb_monitor_table"s. */
53 struct ovs_list jsonrpc_monitors; /* Contains "jsonrpc_monitor_node"s. */
55 uint64_t n_transactions; /* Count number of committed transactions. */
56 struct hmap_node hmap_node; /* Elements within ovsdb_monitors. */
57 struct hmap json_cache; /* Contains "ovsdb_monitor_json_cache_node"s.*/
60 /* A json object of updates between 'from_txn' and 'dbmon->n_transactions'
62 struct ovsdb_monitor_json_cache_node {
63 struct hmap_node hmap_node; /* Elements in json cache. */
65 struct json *json; /* Null, or a cloned of json */
68 struct jsonrpc_monitor_node {
69 struct ovsdb_jsonrpc_monitor *jsonrpc_monitor;
73 /* A particular column being monitored. */
74 struct ovsdb_monitor_column {
75 const struct ovsdb_column *column;
76 enum ovsdb_monitor_selection select;
79 /* A row that has changed in a monitored table. */
80 struct ovsdb_monitor_row {
81 struct hmap_node hmap_node; /* In ovsdb_jsonrpc_monitor_table.changes. */
82 struct uuid uuid; /* UUID of row that changed. */
83 struct ovsdb_datum *old; /* Old data, NULL for an inserted row. */
84 struct ovsdb_datum *new; /* New data, NULL for a deleted row. */
87 /* Contains 'struct ovsdb_monitor_row's for rows that have been
88 * updated but not yet flushed to all the jsonrpc connection.
90 * 'n_refs' represent the number of jsonrpc connections that have
91 * not received updates. Generate the update for the last jsonprc
92 * connection will also destroy the whole "struct ovsdb_monitor_changes"
95 * 'transaction' stores the first update's transaction id.
97 struct ovsdb_monitor_changes {
98 struct ovsdb_monitor_table *mt;
101 uint64_t transaction;
102 struct hmap_node hmap_node; /* Element in ovsdb_monitor_tables' changes
106 /* A particular table being monitored. */
107 struct ovsdb_monitor_table {
108 const struct ovsdb_table *table;
110 /* This is the union (bitwise-OR) of the 'select' values in all of the
111 * members of 'columns' below. */
112 enum ovsdb_monitor_selection select;
114 /* Columns being monitored. */
115 struct ovsdb_monitor_column *columns;
118 /* Contains 'ovsdb_monitor_changes' indexed by 'transaction'. */
122 static void ovsdb_monitor_destroy(struct ovsdb_monitor *dbmon);
123 static struct ovsdb_monitor_changes * ovsdb_monitor_table_add_changes(
124 struct ovsdb_monitor_table *mt, uint64_t next_txn);
125 static struct ovsdb_monitor_changes *ovsdb_monitor_table_find_changes(
126 struct ovsdb_monitor_table *mt, uint64_t unflushed);
127 static void ovsdb_monitor_changes_destroy(
128 struct ovsdb_monitor_changes *changes);
129 static void ovsdb_monitor_table_track_changes(struct ovsdb_monitor_table *mt,
132 static struct ovsdb_monitor_json_cache_node *
133 ovsdb_monitor_json_cache_search(const struct ovsdb_monitor *dbmon,
136 struct ovsdb_monitor_json_cache_node *node;
137 uint32_t hash = hash_uint64(from_txn);
139 HMAP_FOR_EACH_WITH_HASH(node, hmap_node, hash, &dbmon->json_cache) {
140 if (node->from_txn == from_txn) {
149 ovsdb_monitor_json_cache_insert(struct ovsdb_monitor *dbmon,
150 uint64_t from_txn, struct json *json)
152 struct ovsdb_monitor_json_cache_node *node;
155 node = xmalloc(sizeof *node);
157 hash = hash_uint64(from_txn);
158 node->from_txn = from_txn;
159 node->json = json ? json_clone(json) : NULL;
161 hmap_insert(&dbmon->json_cache, &node->hmap_node, hash);
165 ovsdb_monitor_json_cache_flush(struct ovsdb_monitor *dbmon)
167 struct ovsdb_monitor_json_cache_node *node, *next;
169 HMAP_FOR_EACH_SAFE(node, next, hmap_node, &dbmon->json_cache) {
170 hmap_remove(&dbmon->json_cache, &node->hmap_node);
171 json_destroy(node->json);
177 compare_ovsdb_monitor_column(const void *a_, const void *b_)
179 const struct ovsdb_monitor_column *a = a_;
180 const struct ovsdb_monitor_column *b = b_;
182 return a->column < b->column ? -1 : a->column > b->column;
185 static struct ovsdb_monitor *
186 ovsdb_monitor_cast(struct ovsdb_replica *replica)
188 ovs_assert(replica->class == &ovsdb_jsonrpc_replica_class);
189 return CONTAINER_OF(replica, struct ovsdb_monitor, replica);
192 /* Finds and returns the ovsdb_monitor_row in 'mt->changes->rows' for the
193 * given 'uuid', or NULL if there is no such row. */
194 static struct ovsdb_monitor_row *
195 ovsdb_monitor_changes_row_find(const struct ovsdb_monitor_changes *changes,
196 const struct uuid *uuid)
198 struct ovsdb_monitor_row *row;
200 HMAP_FOR_EACH_WITH_HASH (row, hmap_node, uuid_hash(uuid),
202 if (uuid_equals(uuid, &row->uuid)) {
209 /* Allocates an array of 'mt->n_columns' ovsdb_datums and initializes them as
210 * copies of the data in 'row' drawn from the columns represented by
211 * mt->columns[]. Returns the array.
213 * If 'row' is NULL, returns NULL. */
214 static struct ovsdb_datum *
215 clone_monitor_row_data(const struct ovsdb_monitor_table *mt,
216 const struct ovsdb_row *row)
218 struct ovsdb_datum *data;
225 data = xmalloc(mt->n_columns * sizeof *data);
226 for (i = 0; i < mt->n_columns; i++) {
227 const struct ovsdb_column *c = mt->columns[i].column;
228 const struct ovsdb_datum *src = &row->fields[c->index];
229 struct ovsdb_datum *dst = &data[i];
230 const struct ovsdb_type *type = &c->type;
232 ovsdb_datum_clone(dst, src, type);
237 /* Replaces the mt->n_columns ovsdb_datums in row[] by copies of the data from
238 * in 'row' drawn from the columns represented by mt->columns[]. */
240 update_monitor_row_data(const struct ovsdb_monitor_table *mt,
241 const struct ovsdb_row *row,
242 struct ovsdb_datum *data)
246 for (i = 0; i < mt->n_columns; i++) {
247 const struct ovsdb_column *c = mt->columns[i].column;
248 const struct ovsdb_datum *src = &row->fields[c->index];
249 struct ovsdb_datum *dst = &data[i];
250 const struct ovsdb_type *type = &c->type;
252 if (!ovsdb_datum_equals(src, dst, type)) {
253 ovsdb_datum_destroy(dst, type);
254 ovsdb_datum_clone(dst, src, type);
259 /* Frees all of the mt->n_columns ovsdb_datums in data[], using the types taken
260 * from mt->columns[], plus 'data' itself. */
262 free_monitor_row_data(const struct ovsdb_monitor_table *mt,
263 struct ovsdb_datum *data)
268 for (i = 0; i < mt->n_columns; i++) {
269 const struct ovsdb_column *c = mt->columns[i].column;
271 ovsdb_datum_destroy(&data[i], &c->type);
277 /* Frees 'row', which must have been created from 'mt'. */
279 ovsdb_monitor_row_destroy(const struct ovsdb_monitor_table *mt,
280 struct ovsdb_monitor_row *row)
283 free_monitor_row_data(mt, row->old);
284 free_monitor_row_data(mt, row->new);
290 ovsdb_monitor_add_jsonrpc_monitor(struct ovsdb_monitor *dbmon,
291 struct ovsdb_jsonrpc_monitor *jsonrpc_monitor)
293 struct jsonrpc_monitor_node *jm;
295 jm = xzalloc(sizeof *jm);
296 jm->jsonrpc_monitor = jsonrpc_monitor;
297 list_push_back(&dbmon->jsonrpc_monitors, &jm->node);
300 struct ovsdb_monitor *
301 ovsdb_monitor_create(struct ovsdb *db,
302 struct ovsdb_jsonrpc_monitor *jsonrpc_monitor)
304 struct ovsdb_monitor *dbmon;
306 dbmon = xzalloc(sizeof *dbmon);
308 ovsdb_replica_init(&dbmon->replica, &ovsdb_jsonrpc_replica_class);
309 ovsdb_add_replica(db, &dbmon->replica);
310 list_init(&dbmon->jsonrpc_monitors);
312 dbmon->n_transactions = 0;
313 shash_init(&dbmon->tables);
314 hmap_node_nullify(&dbmon->hmap_node);
315 hmap_init(&dbmon->json_cache);
317 ovsdb_monitor_add_jsonrpc_monitor(dbmon, jsonrpc_monitor);
322 ovsdb_monitor_add_table(struct ovsdb_monitor *m,
323 const struct ovsdb_table *table)
325 struct ovsdb_monitor_table *mt;
327 mt = xzalloc(sizeof *mt);
329 shash_add(&m->tables, table->schema->name, mt);
330 hmap_init(&mt->changes);
334 ovsdb_monitor_add_column(struct ovsdb_monitor *dbmon,
335 const struct ovsdb_table *table,
336 const struct ovsdb_column *column,
337 enum ovsdb_monitor_selection select,
338 size_t *allocated_columns)
340 struct ovsdb_monitor_table *mt;
341 struct ovsdb_monitor_column *c;
343 mt = shash_find_data(&dbmon->tables, table->schema->name);
345 if (mt->n_columns >= *allocated_columns) {
346 mt->columns = x2nrealloc(mt->columns, allocated_columns,
347 sizeof *mt->columns);
350 mt->select |= select;
351 c = &mt->columns[mt->n_columns++];
356 /* Check for duplicated column names. Return the first
357 * duplicated column's name if found. Otherwise return
359 const char * OVS_WARN_UNUSED_RESULT
360 ovsdb_monitor_table_check_duplicates(struct ovsdb_monitor *m,
361 const struct ovsdb_table *table)
363 struct ovsdb_monitor_table *mt;
366 mt = shash_find_data(&m->tables, table->schema->name);
369 /* Check for duplicate columns. */
370 qsort(mt->columns, mt->n_columns, sizeof *mt->columns,
371 compare_ovsdb_monitor_column);
372 for (i = 1; i < mt->n_columns; i++) {
373 if (mt->columns[i].column == mt->columns[i - 1].column) {
374 return mt->columns[i].column->name;
382 static struct ovsdb_monitor_changes *
383 ovsdb_monitor_table_add_changes(struct ovsdb_monitor_table *mt,
386 struct ovsdb_monitor_changes *changes;
388 changes = xzalloc(sizeof *changes);
390 changes->transaction = next_txn;
393 hmap_init(&changes->rows);
394 hmap_insert(&mt->changes, &changes->hmap_node, hash_uint64(next_txn));
399 static struct ovsdb_monitor_changes *
400 ovsdb_monitor_table_find_changes(struct ovsdb_monitor_table *mt,
401 uint64_t transaction)
403 struct ovsdb_monitor_changes *changes;
404 size_t hash = hash_uint64(transaction);
406 HMAP_FOR_EACH_WITH_HASH(changes, hmap_node, hash, &mt->changes) {
407 if (changes->transaction == transaction) {
415 /* Stop currently tracking changes to table 'mt' since 'transaction'. */
417 ovsdb_monitor_table_untrack_changes(struct ovsdb_monitor_table *mt,
418 uint64_t transaction)
420 struct ovsdb_monitor_changes *changes =
421 ovsdb_monitor_table_find_changes(mt, transaction);
423 if (--changes->n_refs == 0) {
424 hmap_remove(&mt->changes, &changes->hmap_node);
425 ovsdb_monitor_changes_destroy(changes);
430 /* Start tracking changes to table 'mt' begins from 'transaction' inclusive.
433 ovsdb_monitor_table_track_changes(struct ovsdb_monitor_table *mt,
434 uint64_t transaction)
436 struct ovsdb_monitor_changes *changes;
438 changes = ovsdb_monitor_table_find_changes(mt, transaction);
442 ovsdb_monitor_table_add_changes(mt, transaction);
447 ovsdb_monitor_changes_destroy(struct ovsdb_monitor_changes *changes)
449 struct ovsdb_monitor_row *row, *next;
451 HMAP_FOR_EACH_SAFE (row, next, hmap_node, &changes->rows) {
452 hmap_remove(&changes->rows, &row->hmap_node);
453 ovsdb_monitor_row_destroy(changes->mt, row);
455 hmap_destroy(&changes->rows);
459 static enum ovsdb_monitor_selection
460 ovsdb_monitor_row_update_type(bool initial, const bool old, const bool new)
462 return initial ? OJMS_INITIAL
468 /* Returns JSON for a <row-update> (as described in RFC 7047) for 'row' within
469 * 'mt', or NULL if no row update should be sent.
471 * The caller should specify 'initial' as true if the returned JSON is going to
472 * be used as part of the initial reply to a "monitor" request, false if it is
473 * going to be used as part of an "update" notification.
475 * 'changed' must be a scratch buffer for internal use that is at least
476 * bitmap_n_bytes(mt->n_columns) bytes long. */
478 ovsdb_monitor_compose_row_update(
479 const struct ovsdb_monitor_table *mt,
480 const struct ovsdb_monitor_row *row,
481 bool initial, unsigned long int *changed)
483 enum ovsdb_monitor_selection type;
484 struct json *old_json, *new_json;
485 struct json *row_json;
488 type = ovsdb_monitor_row_update_type(initial, row->old, row->new);
489 if (!(mt->select & type)) {
493 if (type == OJMS_MODIFY) {
497 memset(changed, 0, bitmap_n_bytes(mt->n_columns));
498 for (i = 0; i < mt->n_columns; i++) {
499 const struct ovsdb_column *c = mt->columns[i].column;
500 if (!ovsdb_datum_equals(&row->old[i], &row->new[i], &c->type)) {
501 bitmap_set1(changed, i);
506 /* No actual changes: presumably a row changed and then
507 * changed back later. */
512 row_json = json_object_create();
513 old_json = new_json = NULL;
514 if (type & (OJMS_DELETE | OJMS_MODIFY)) {
515 old_json = json_object_create();
516 json_object_put(row_json, "old", old_json);
518 if (type & (OJMS_INITIAL | OJMS_INSERT | OJMS_MODIFY)) {
519 new_json = json_object_create();
520 json_object_put(row_json, "new", new_json);
522 for (i = 0; i < mt->n_columns; i++) {
523 const struct ovsdb_monitor_column *c = &mt->columns[i];
525 if (!(type & c->select)) {
526 /* We don't care about this type of change for this
527 * particular column (but we will care about it for some
532 if ((type == OJMS_MODIFY && bitmap_is_set(changed, i))
533 || type == OJMS_DELETE) {
534 json_object_put(old_json, c->column->name,
535 ovsdb_datum_to_json(&row->old[i],
538 if (type & (OJMS_INITIAL | OJMS_INSERT | OJMS_MODIFY)) {
539 json_object_put(new_json, c->column->name,
540 ovsdb_datum_to_json(&row->new[i],
548 /* Constructs and returns JSON for a <table-updates> object (as described in
549 * RFC 7047) for all the outstanding changes within 'monitor', starting from
552 ovsdb_monitor_compose_update(struct ovsdb_monitor *dbmon,
553 bool initial, uint64_t transaction)
555 struct shash_node *node;
556 unsigned long int *changed;
561 SHASH_FOR_EACH (node, &dbmon->tables) {
562 struct ovsdb_monitor_table *mt = node->data;
564 max_columns = MAX(max_columns, mt->n_columns);
566 changed = xmalloc(bitmap_n_bytes(max_columns));
569 SHASH_FOR_EACH (node, &dbmon->tables) {
570 struct ovsdb_monitor_table *mt = node->data;
571 struct ovsdb_monitor_row *row, *next;
572 struct ovsdb_monitor_changes *changes;
573 struct json *table_json = NULL;
575 changes = ovsdb_monitor_table_find_changes(mt, transaction);
580 HMAP_FOR_EACH_SAFE (row, next, hmap_node, &changes->rows) {
581 struct json *row_json;
583 row_json = ovsdb_monitor_compose_row_update(
584 mt, row, initial, changed);
586 char uuid[UUID_LEN + 1];
588 /* Create JSON object for transaction overall. */
590 json = json_object_create();
593 /* Create JSON object for transaction on this table. */
595 table_json = json_object_create();
596 json_object_put(json, mt->table->schema->name, table_json);
599 /* Add JSON row to JSON table. */
600 snprintf(uuid, sizeof uuid, UUID_FMT, UUID_ARGS(&row->uuid));
601 json_object_put(table_json, uuid, row_json);
610 /* Returns JSON for a <table-updates> object (as described in RFC 7047)
611 * for all the outstanding changes within 'monitor' that starts from
612 * '*unflushed' transaction id.
614 * The caller should specify 'initial' as true if the returned JSON is going to
615 * be used as part of the initial reply to a "monitor" request, false if it is
616 * going to be used as part of an "update" notification. */
618 ovsdb_monitor_get_update(struct ovsdb_monitor *dbmon,
619 bool initial, uint64_t *unflushed)
621 struct ovsdb_monitor_json_cache_node *cache_node;
622 struct shash_node *node;
624 uint64_t prev_txn = *unflushed;
625 uint64_t next_txn = dbmon->n_transactions + 1;
627 /* Return a clone of cached json if one exists. Otherwise,
628 * generate a new one and add it to the cache. */
629 cache_node = ovsdb_monitor_json_cache_search(dbmon, prev_txn);
631 json = cache_node->json ? json_clone(cache_node->json) : NULL;
633 json = ovsdb_monitor_compose_update(dbmon, initial, prev_txn);
634 ovsdb_monitor_json_cache_insert(dbmon, prev_txn, json);
637 /* Maintain transaction id of 'changes'. */
638 SHASH_FOR_EACH (node, &dbmon->tables) {
639 struct ovsdb_monitor_table *mt = node->data;
641 ovsdb_monitor_table_untrack_changes(mt, prev_txn);
642 ovsdb_monitor_table_track_changes(mt, next_txn);
644 *unflushed = next_txn;
650 ovsdb_monitor_needs_flush(struct ovsdb_monitor *dbmon,
651 uint64_t next_transaction)
653 ovs_assert(next_transaction <= dbmon->n_transactions + 1);
654 return (next_transaction <= dbmon->n_transactions);
658 ovsdb_monitor_table_add_select(struct ovsdb_monitor *dbmon,
659 const struct ovsdb_table *table,
660 enum ovsdb_monitor_selection select)
662 struct ovsdb_monitor_table * mt;
664 mt = shash_find_data(&dbmon->tables, table->schema->name);
665 mt->select |= select;
669 * If a row's change type (insert, delete or modify) matches that of
670 * the monitor, they should be sent to the monitor's clients as updates.
671 * Of cause, the monitor should also internally update with this change.
673 * When a change type does not require client side update, the monitor
674 * may still need to keep track of certain changes in order to generate
675 * correct future updates. For example, the monitor internal state should
676 * be updated whenever a new row is inserted, in order to generate the
677 * correct initial state, regardless if a insert change type is being
680 * On the other hand, if a transaction only contains changes to columns
681 * that are not monitored, this transaction can be safely ignored by the
684 * Thus, the order of the declaration is important:
685 * 'OVSDB_CHANGES_REQUIRE_EXTERNAL_UPDATE' always implies
686 * 'OVSDB_CHANGES_REQUIRE_INTERNAL_UPDATE', but not vice versa. */
687 enum ovsdb_monitor_changes_efficacy {
688 OVSDB_CHANGES_NO_EFFECT, /* Monitor does not care about this
690 OVSDB_CHANGES_REQUIRE_INTERNAL_UPDATE, /* Monitor internal updates. */
691 OVSDB_CHANGES_REQUIRE_EXTERNAL_UPDATE, /* Client needs to be updated. */
694 struct ovsdb_monitor_aux {
695 const struct ovsdb_monitor *monitor;
696 struct ovsdb_monitor_table *mt;
697 enum ovsdb_monitor_changes_efficacy efficacy;
701 ovsdb_monitor_init_aux(struct ovsdb_monitor_aux *aux,
702 const struct ovsdb_monitor *m)
706 aux->efficacy = OVSDB_CHANGES_NO_EFFECT;
710 ovsdb_monitor_changes_update(const struct ovsdb_row *old,
711 const struct ovsdb_row *new,
712 const struct ovsdb_monitor_table *mt,
713 struct ovsdb_monitor_changes *changes)
715 const struct uuid *uuid = ovsdb_row_get_uuid(new ? new : old);
716 struct ovsdb_monitor_row *change;
718 change = ovsdb_monitor_changes_row_find(changes, uuid);
720 change = xzalloc(sizeof *change);
721 hmap_insert(&changes->rows, &change->hmap_node, uuid_hash(uuid));
722 change->uuid = *uuid;
723 change->old = clone_monitor_row_data(mt, old);
724 change->new = clone_monitor_row_data(mt, new);
727 update_monitor_row_data(mt, new, change->new);
729 free_monitor_row_data(mt, change->new);
733 /* This row was added then deleted. Forget about it. */
734 hmap_remove(&changes->rows, &change->hmap_node);
742 ovsdb_monitor_columns_changed(const struct ovsdb_monitor_table *mt,
743 const unsigned long int *changed)
747 for (i = 0; i < mt->n_columns; i++) {
748 size_t column_index = mt->columns[i].column->index;
750 if (bitmap_is_set(changed, column_index)) {
758 /* Return the efficacy of a row's change to a monitor table.
760 * Please see the block comment above 'ovsdb_monitor_changes_efficacy'
761 * definition form more information. */
762 static enum ovsdb_monitor_changes_efficacy
763 ovsdb_monitor_changes_classify(enum ovsdb_monitor_selection type,
764 const struct ovsdb_monitor_table *mt,
765 const unsigned long int *changed)
767 if (type == OJMS_MODIFY &&
768 !ovsdb_monitor_columns_changed(mt, changed)) {
769 return OVSDB_CHANGES_NO_EFFECT;
772 return (mt->select & type)
773 ? OVSDB_CHANGES_REQUIRE_EXTERNAL_UPDATE
774 : OVSDB_CHANGES_REQUIRE_INTERNAL_UPDATE;
778 ovsdb_monitor_change_cb(const struct ovsdb_row *old,
779 const struct ovsdb_row *new,
780 const unsigned long int *changed,
783 struct ovsdb_monitor_aux *aux = aux_;
784 const struct ovsdb_monitor *m = aux->monitor;
785 struct ovsdb_table *table = new ? new->table : old->table;
786 struct ovsdb_monitor_table *mt;
787 struct ovsdb_monitor_changes *changes;
789 if (!aux->mt || table != aux->mt->table) {
790 aux->mt = shash_find_data(&m->tables, table->schema->name);
792 /* We don't care about rows in this table at all. Tell the caller
799 HMAP_FOR_EACH(changes, hmap_node, &mt->changes) {
800 enum ovsdb_monitor_changes_efficacy efficacy;
801 enum ovsdb_monitor_selection type;
803 type = ovsdb_monitor_row_update_type(false, old, new);
804 efficacy = ovsdb_monitor_changes_classify(type, mt, changed);
805 if (efficacy > OVSDB_CHANGES_NO_EFFECT) {
806 ovsdb_monitor_changes_update(old, new, mt, changes);
809 if (aux->efficacy < efficacy) {
810 aux->efficacy = efficacy;
818 ovsdb_monitor_get_initial(const struct ovsdb_monitor *dbmon)
820 struct ovsdb_monitor_aux aux;
821 struct shash_node *node;
823 ovsdb_monitor_init_aux(&aux, dbmon);
824 SHASH_FOR_EACH (node, &dbmon->tables) {
825 struct ovsdb_monitor_table *mt = node->data;
827 if (mt->select & OJMS_INITIAL) {
828 struct ovsdb_row *row;
829 struct ovsdb_monitor_changes *changes;
831 changes = ovsdb_monitor_table_find_changes(mt, 0);
833 changes = ovsdb_monitor_table_add_changes(mt, 0);
834 HMAP_FOR_EACH (row, hmap_node, &mt->table->rows) {
835 ovsdb_monitor_changes_update(NULL, row, mt, changes);
845 ovsdb_monitor_remove_jsonrpc_monitor(struct ovsdb_monitor *dbmon,
846 struct ovsdb_jsonrpc_monitor *jsonrpc_monitor)
848 struct jsonrpc_monitor_node *jm;
850 if (list_is_empty(&dbmon->jsonrpc_monitors)) {
851 ovsdb_monitor_destroy(dbmon);
855 /* Find and remove the jsonrpc monitor from the list. */
856 LIST_FOR_EACH(jm, node, &dbmon->jsonrpc_monitors) {
857 if (jm->jsonrpc_monitor == jsonrpc_monitor) {
858 list_remove(&jm->node);
861 /* Destroy ovsdb monitor if this is the last user. */
862 if (list_is_empty(&dbmon->jsonrpc_monitors)) {
863 ovsdb_monitor_destroy(dbmon);
870 /* Should never reach here. jsonrpc_monitor should be on the list. */
875 ovsdb_monitor_table_equal(const struct ovsdb_monitor_table *a,
876 const struct ovsdb_monitor_table *b)
880 if ((a->table != b->table) ||
881 (a->select != b->select) ||
882 (a->n_columns != b->n_columns)) {
886 for (i = 0; i < a->n_columns; i++) {
887 if ((a->columns[i].column != b->columns[i].column) ||
888 (a->columns[i].select != b->columns[i].select)) {
897 ovsdb_monitor_equal(const struct ovsdb_monitor *a,
898 const struct ovsdb_monitor *b)
900 struct shash_node *node;
902 if (shash_count(&a->tables) != shash_count(&b->tables)) {
906 SHASH_FOR_EACH(node, &a->tables) {
907 const struct ovsdb_monitor_table *mta = node->data;
908 const struct ovsdb_monitor_table *mtb;
910 mtb = shash_find_data(&b->tables, node->name);
915 if (!ovsdb_monitor_table_equal(mta, mtb)) {
924 ovsdb_monitor_hash(const struct ovsdb_monitor *dbmon, size_t basis)
926 const struct shash_node **nodes;
929 nodes = shash_sort(&dbmon->tables);
930 n = shash_count(&dbmon->tables);
932 for (i = 0; i < n; i++) {
933 struct ovsdb_monitor_table *mt = nodes[i]->data;
935 basis = hash_pointer(mt->table, basis);
936 basis = hash_3words(mt->select, mt->n_columns, basis);
938 for (j = 0; j < mt->n_columns; j++) {
939 basis = hash_pointer(mt->columns[j].column, basis);
940 basis = hash_2words(mt->columns[j].select, basis);
948 struct ovsdb_monitor *
949 ovsdb_monitor_add(struct ovsdb_monitor *new_dbmon)
951 struct ovsdb_monitor *dbmon;
954 /* New_dbmon should be associated with only one jsonrpc
956 ovs_assert(list_is_singleton(&new_dbmon->jsonrpc_monitors));
958 hash = ovsdb_monitor_hash(new_dbmon, 0);
959 HMAP_FOR_EACH_WITH_HASH(dbmon, hmap_node, hash, &ovsdb_monitors) {
960 if (ovsdb_monitor_equal(dbmon, new_dbmon)) {
965 hmap_insert(&ovsdb_monitors, &new_dbmon->hmap_node, hash);
970 ovsdb_monitor_destroy(struct ovsdb_monitor *dbmon)
972 struct shash_node *node;
974 list_remove(&dbmon->replica.node);
976 if (!hmap_node_is_null(&dbmon->hmap_node)) {
977 hmap_remove(&ovsdb_monitors, &dbmon->hmap_node);
980 ovsdb_monitor_json_cache_flush(dbmon);
981 hmap_destroy(&dbmon->json_cache);
983 SHASH_FOR_EACH (node, &dbmon->tables) {
984 struct ovsdb_monitor_table *mt = node->data;
985 struct ovsdb_monitor_changes *changes, *next;
987 HMAP_FOR_EACH_SAFE (changes, next, hmap_node, &mt->changes) {
988 hmap_remove(&mt->changes, &changes->hmap_node);
989 ovsdb_monitor_changes_destroy(changes);
991 hmap_destroy(&mt->changes);
995 shash_destroy(&dbmon->tables);
999 static struct ovsdb_error *
1000 ovsdb_monitor_commit(struct ovsdb_replica *replica,
1001 const struct ovsdb_txn *txn,
1002 bool durable OVS_UNUSED)
1004 struct ovsdb_monitor *m = ovsdb_monitor_cast(replica);
1005 struct ovsdb_monitor_aux aux;
1007 ovsdb_monitor_init_aux(&aux, m);
1008 ovsdb_txn_for_each_change(txn, ovsdb_monitor_change_cb, &aux);
1010 if (aux.efficacy == OVSDB_CHANGES_REQUIRE_EXTERNAL_UPDATE) {
1011 ovsdb_monitor_json_cache_flush(m);
1012 m->n_transactions++;
1019 ovsdb_monitor_destroy_callback(struct ovsdb_replica *replica)
1021 struct ovsdb_monitor *dbmon = ovsdb_monitor_cast(replica);
1022 struct jsonrpc_monitor_node *jm, *next;
1024 /* Delete all front end monitors. Removing the last front
1025 * end monitor will also destroy the corresponding 'ovsdb_monitor'.
1026 * ovsdb monitor will also be destroied. */
1027 LIST_FOR_EACH_SAFE(jm, next, node, &dbmon->jsonrpc_monitors) {
1028 ovsdb_jsonrpc_monitor_destroy(jm->jsonrpc_monitor);
1032 static const struct ovsdb_replica_class ovsdb_jsonrpc_replica_class = {
1033 ovsdb_monitor_commit,
1034 ovsdb_monitor_destroy_callback,