/* Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017 Nicira, Inc. * Copyright (C) 2016 Hewlett Packard Enterprise Development LP * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at: * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ #include #include "ovsdb-idl.h" #include #include #include #include #include "bitmap.h" #include "coverage.h" #include "hash.h" #include "openvswitch/dynamic-string.h" #include "fatal-signal.h" #include "openvswitch/json.h" #include "jsonrpc.h" #include "ovsdb/ovsdb.h" #include "ovsdb/table.h" #include "ovsdb-cs.h" #include "ovsdb-data.h" #include "ovsdb-error.h" #include "ovsdb-idl-provider.h" #include "ovsdb-parser.h" #include "ovsdb-server-idl.h" #include "ovsdb-session.h" #include "openvswitch/poll-loop.h" #include "openvswitch/shash.h" #include "skiplist.h" #include "simap.h" #include "sset.h" #include "svec.h" #include "util.h" #include "uuid.h" #include "openvswitch/vlog.h" VLOG_DEFINE_THIS_MODULE(ovsdb_idl); COVERAGE_DEFINE(txn_uncommitted); COVERAGE_DEFINE(txn_unchanged); COVERAGE_DEFINE(txn_incomplete); COVERAGE_DEFINE(txn_aborted); COVERAGE_DEFINE(txn_success); COVERAGE_DEFINE(txn_try_again); COVERAGE_DEFINE(txn_not_locked); COVERAGE_DEFINE(txn_error); /* An arc from one idl_row to another. When row A contains a UUID that * references row B, this is represented by an arc from A (the source) to B * (the destination). * * Arcs from a row to itself are omitted, that is, src and dst are always * different. * * Arcs are never duplicated, that is, even if there are multiple references * from A to B, there is only a single arc from A to B. * * Arcs are directed: an arc from A to B is the converse of an an arc from B to * A. Both an arc and its converse may both be present, if each row refers * to the other circularly. * * The source and destination row may be in the same table or in different * tables. */ struct ovsdb_idl_arc { struct ovs_list src_node; /* In src->src_arcs list. */ struct ovs_list dst_node; /* In dst->dst_arcs list. */ struct ovsdb_idl_row *src; /* Source row. */ struct ovsdb_idl_row *dst; /* Destination row. */ }; struct ovsdb_idl { struct ovsdb_cs *cs; const struct ovsdb_idl_class *class_; struct shash table_by_name; /* Contains "struct ovsdb_idl_table *"s.*/ struct ovsdb_idl_table *tables; /* Array of ->class_->n_tables elements. */ unsigned int change_seqno; struct ovsdb_idl_txn *txn; struct hmap outstanding_txns; bool verify_write_only; struct ovs_list deleted_untracked_rows; /* Stores rows deleted in the * current run, that are not yet * added to the track_list. */ struct ovs_list rows_to_reparse; /* Stores rows that might need to be * re-parsed due to insertion of a * referenced row. */ }; static struct ovsdb_cs_ops ovsdb_idl_cs_ops; struct ovsdb_idl_txn { struct hmap_node hmap_node; struct json *request_id; struct ovsdb_idl *idl; struct hmap txn_rows; enum ovsdb_idl_txn_status status; char *error; bool dry_run; struct ds comment; /* Increments. */ const char *inc_table; const char *inc_column; struct uuid inc_row; bool inc_force; unsigned int inc_index; int64_t inc_new_value; /* Inserted rows. */ struct hmap inserted_rows; /* Contains "struct ovsdb_idl_txn_insert"s. */ }; struct ovsdb_idl_txn_insert { struct hmap_node hmap_node; /* In struct ovsdb_idl_txn's inserted_rows. */ struct uuid dummy; /* Dummy UUID used locally. */ int op_index; /* Index into transaction's operation array. */ struct uuid real; /* Real UUID used by database server. */ }; static struct vlog_rate_limit syntax_rl = VLOG_RATE_LIMIT_INIT(1, 5); static struct vlog_rate_limit semantic_rl = VLOG_RATE_LIMIT_INIT(1, 5); static struct vlog_rate_limit other_rl = VLOG_RATE_LIMIT_INIT(1, 5); enum update_result { OVSDB_IDL_UPDATE_DB_CHANGED, OVSDB_IDL_UPDATE_NO_CHANGES, OVSDB_IDL_UPDATE_INCONSISTENT, }; static void ovsdb_idl_clear(struct ovsdb_idl *); static enum update_result ovsdb_idl_process_update( struct ovsdb_idl_table *, const struct ovsdb_cs_row_update *); static void ovsdb_idl_insert_row(struct ovsdb_idl_row *, const struct shash *values); static void ovsdb_idl_delete_row(struct ovsdb_idl_row *); static bool ovsdb_idl_modify_row(struct ovsdb_idl_row *, const struct shash *values, bool xor); static void ovsdb_idl_parse_update(struct ovsdb_idl *, const struct ovsdb_cs_update_event *); static void ovsdb_idl_reparse_deleted(struct ovsdb_idl *); static void ovsdb_idl_reparse_refs_to_inserted(struct ovsdb_idl *); static void ovsdb_idl_txn_process_reply(struct ovsdb_idl *, const struct jsonrpc_msg *); static bool ovsdb_idl_row_is_orphan(const struct ovsdb_idl_row *); static struct ovsdb_idl_row *ovsdb_idl_row_create__( const struct ovsdb_idl_table_class *); static struct ovsdb_idl_row *ovsdb_idl_row_create(struct ovsdb_idl_table *, const struct uuid *); static void ovsdb_idl_row_destroy(struct ovsdb_idl_row *); static void ovsdb_idl_row_destroy_postprocess(struct ovsdb_idl *); static void ovsdb_idl_destroy_all_map_op_lists(struct ovsdb_idl_row *); static void ovsdb_idl_destroy_all_set_op_lists(struct ovsdb_idl_row *); static void ovsdb_idl_row_parse(struct ovsdb_idl_row *); static void ovsdb_idl_row_unparse(struct ovsdb_idl_row *); static void ovsdb_idl_row_clear_old(struct ovsdb_idl_row *); static void ovsdb_idl_row_clear_new(struct ovsdb_idl_row *); static void ovsdb_idl_row_clear_arcs(struct ovsdb_idl_row *, bool destroy_dsts); static void ovsdb_idl_row_reparse_backrefs(struct ovsdb_idl_row *); static void ovsdb_idl_row_mark_backrefs_for_reparsing(struct ovsdb_idl_row *); static void ovsdb_idl_row_track_change(struct ovsdb_idl_row *, enum ovsdb_idl_change); static void ovsdb_idl_row_untrack_change(struct ovsdb_idl_row *); static void ovsdb_idl_txn_abort_all(struct ovsdb_idl *); static bool ovsdb_idl_txn_extract_mutations(struct ovsdb_idl_row *, struct json *); static void ovsdb_idl_txn_add_map_op(struct ovsdb_idl_row *, const struct ovsdb_idl_column *, struct ovsdb_datum *, enum map_op_type); static void ovsdb_idl_txn_add_set_op(struct ovsdb_idl_row *, const struct ovsdb_idl_column *, struct ovsdb_datum *, enum set_op_type); static struct ovsdb_idl_table * ovsdb_idl_table_from_class(const struct ovsdb_idl *, const struct ovsdb_idl_table_class *); static struct ovsdb_idl_table * ovsdb_idl_table_from_class(const struct ovsdb_idl *, const struct ovsdb_idl_table_class *); static void ovsdb_idl_track_clear__(struct ovsdb_idl *, bool flush_all); static void ovsdb_idl_destroy_indexes(struct ovsdb_idl_table *); static void ovsdb_idl_add_to_indexes(const struct ovsdb_idl_row *); static void ovsdb_idl_remove_from_indexes(const struct ovsdb_idl_row *); static int ovsdb_idl_try_commit_loop_txn(struct ovsdb_idl_loop *loop, bool *may_need_wakeup); static void add_tracked_change_for_references(struct ovsdb_idl_row *); /* Creates and returns a connection to database 'remote', which should be in a * form acceptable to jsonrpc_session_open(). The connection will maintain an * in-memory replica of the remote database whose schema is described by * 'class'. (Ordinarily 'class' is compiled from an OVSDB schema automatically * by ovsdb-idlc.) * * Passes 'retry' to jsonrpc_session_open(). See that function for * documentation. * * If 'monitor_everything_by_default' is true, then everything in the remote * database will be replicated by default. ovsdb_idl_omit() and * ovsdb_idl_omit_alert() may be used to selectively drop some columns from * monitoring. * * If 'monitor_everything_by_default' is false, then no columns or tables will * be replicated by default. ovsdb_idl_add_column() and ovsdb_idl_add_table() * must be used to choose some columns or tables to replicate. */ struct ovsdb_idl * ovsdb_idl_create(const char *remote, const struct ovsdb_idl_class *class, bool monitor_everything_by_default, bool retry) { struct ovsdb_idl *idl = ovsdb_idl_create_unconnected( class, monitor_everything_by_default); ovsdb_idl_set_remote(idl, remote, retry); return idl; } /* Creates and returns a connection to an in-memory replica of the remote * database whose schema is described by 'class'. (Ordinarily 'class' is * compiled from an OVSDB schema automatically by ovsdb-idlc.) * * Use ovsdb_idl_set_remote() to configure the database to which to connect. * Until a remote is configured, no data can be retrieved. * * If 'monitor_everything_by_default' is true, then everything in the remote * database will be replicated by default. ovsdb_idl_omit() and * ovsdb_idl_omit_alert() may be used to selectively drop some columns from * monitoring. * * If 'monitor_everything_by_default' is false, then no columns or tables will * be replicated by default. ovsdb_idl_add_column() and ovsdb_idl_add_table() * must be used to choose some columns or tables to replicate. */ struct ovsdb_idl * ovsdb_idl_create_unconnected(const struct ovsdb_idl_class *class, bool monitor_everything_by_default) { struct ovsdb_idl *idl = xmalloc(sizeof *idl); *idl = (struct ovsdb_idl) { .cs = ovsdb_cs_create(class->database, 3, &ovsdb_idl_cs_ops, idl), .class_ = class, .table_by_name = SHASH_INITIALIZER(&idl->table_by_name), .tables = xmalloc(class->n_tables * sizeof *idl->tables), .change_seqno = 0, .txn = NULL, .outstanding_txns = HMAP_INITIALIZER(&idl->outstanding_txns), .verify_write_only = false, .deleted_untracked_rows = OVS_LIST_INITIALIZER(&idl->deleted_untracked_rows), .rows_to_reparse = OVS_LIST_INITIALIZER(&idl->rows_to_reparse), }; uint8_t default_mode = (monitor_everything_by_default ? OVSDB_IDL_MONITOR | OVSDB_IDL_ALERT : 0); for (size_t i = 0; i < class->n_tables; i++) { const struct ovsdb_idl_table_class *tc = &class->tables[i]; struct ovsdb_idl_table *table = &idl->tables[i]; shash_add_assert(&idl->table_by_name, tc->name, table); table->class_ = tc; table->modes = xmalloc(tc->n_columns); memset(table->modes, default_mode, tc->n_columns); table->need_table = false; shash_init(&table->columns); ovs_list_init(&table->indexes); for (size_t j = 0; j < tc->n_columns; j++) { const struct ovsdb_idl_column *column = &tc->columns[j]; shash_add_assert(&table->columns, column->name, column); } hmap_init(&table->rows); ovs_list_init(&table->track_list); table->change_seqno[OVSDB_IDL_CHANGE_INSERT] = table->change_seqno[OVSDB_IDL_CHANGE_MODIFY] = table->change_seqno[OVSDB_IDL_CHANGE_DELETE] = 0; table->idl = idl; table->in_server_schema = false; sset_init(&table->schema_columns); } return idl; } /* Changes the remote and creates a new session. * * If 'retry' is true, the connection to the remote will automatically retry * when it fails. If 'retry' is false, the connection is one-time. */ void ovsdb_idl_set_remote(struct ovsdb_idl *idl, const char *remote, bool retry) { ovsdb_cs_set_remote(idl->cs, remote, retry); } /* Set whether the order of remotes should be shuffled, when there * are more than one remotes. The setting doesn't take effect * until the next time when ovsdb_idl_set_remote() is called. */ void ovsdb_idl_set_shuffle_remotes(struct ovsdb_idl *idl, bool shuffle) { ovsdb_cs_set_shuffle_remotes(idl->cs, shuffle); } /* Passes 'set_db_change_aware' to ovsdb_cs_set_db_change_aware(). See that * function for documentation. */ void ovsdb_idl_set_db_change_aware(struct ovsdb_idl *idl, bool set_db_change_aware) { ovsdb_cs_set_db_change_aware(idl->cs, set_db_change_aware); } /* Reset min_index to 0. This prevents a situation where the client * thinks all databases have stale data, when they actually have all * been destroyed and rebuilt from scratch. */ void ovsdb_idl_reset_min_index(struct ovsdb_idl *idl) { ovsdb_cs_reset_min_index(idl->cs); } /* Destroys 'idl' and all of the data structures that it manages. */ void ovsdb_idl_destroy(struct ovsdb_idl *idl) { if (idl) { ovs_assert(!idl->txn); ovsdb_idl_txn_abort_all(idl); hmap_destroy(&idl->outstanding_txns); ovsdb_idl_clear(idl); ovsdb_cs_destroy(idl->cs); for (size_t i = 0; i < idl->class_->n_tables; i++) { struct ovsdb_idl_table *table = &idl->tables[i]; ovsdb_idl_destroy_indexes(table); shash_destroy(&table->columns); sset_destroy(&table->schema_columns); hmap_destroy(&table->rows); free(table->modes); } shash_destroy(&idl->table_by_name); free(idl->tables); free(idl); } } /* By default, or if 'leader_only' is true, when 'idl' connects to a clustered * database, the IDL will avoid servers other than the cluster leader. This * ensures that any data that it reads and reports is up-to-date. If * 'leader_only' is false, the IDL will accept any server in the cluster, which * means that for read-only transactions it can report and act on stale data * (transactions that modify the database are always serialized even with false * 'leader_only'). Refer to Understanding Cluster Consistency in ovsdb(7) for * more information. */ void ovsdb_idl_set_leader_only(struct ovsdb_idl *idl, bool leader_only) { ovsdb_cs_set_leader_only(idl->cs, leader_only); } static void ovsdb_idl_clear(struct ovsdb_idl *db) { /* Process deleted rows, removing them from the 'deleted_untracked_rows' * list and reparsing their backrefs. */ ovsdb_idl_reparse_deleted(db); /* Process backrefs of inserted rows, removing them from the * 'rows_to_reparse' list. */ ovsdb_idl_reparse_refs_to_inserted(db); /* Cleanup all rows; each row gets added to its own table's * 'track_list'. */ for (size_t i = 0; i < db->class_->n_tables; i++) { struct ovsdb_idl_table *table = &db->tables[i]; struct ovsdb_idl_row *row; if (hmap_is_empty(&table->rows)) { continue; } HMAP_FOR_EACH_SAFE (row, hmap_node, &table->rows) { struct ovsdb_idl_arc *arc; if (!ovsdb_idl_row_is_orphan(row)) { ovsdb_idl_remove_from_indexes(row); ovsdb_idl_row_unparse(row); } LIST_FOR_EACH_SAFE (arc, src_node, &row->src_arcs) { ovs_list_remove(&arc->src_node); ovs_list_remove(&arc->dst_node); free(arc); } LIST_FOR_EACH_SAFE (arc, dst_node, &row->dst_arcs) { ovs_list_remove(&arc->src_node); ovs_list_remove(&arc->dst_node); free(arc); } ovsdb_idl_row_destroy(row); } } /* Free rows deleted from tables with change tracking disabled. */ ovsdb_idl_row_destroy_postprocess(db); /* Free rows deleted from tables with change tracking enabled. */ ovsdb_idl_track_clear__(db, true); ovs_assert(ovs_list_is_empty(&db->deleted_untracked_rows)); ovs_assert(ovs_list_is_empty(&db->rows_to_reparse)); db->change_seqno++; } /* Processes a batch of messages from the database server on 'idl'. This may * cause the IDL's contents to change. The client may check for that with * ovsdb_idl_get_seqno(). */ void ovsdb_idl_run(struct ovsdb_idl *idl) { ovs_assert(!idl->txn); struct ovs_list events; ovsdb_cs_run(idl->cs, &events); struct ovsdb_cs_event *event; LIST_FOR_EACH_POP (event, list_node, &events) { switch (event->type) { case OVSDB_CS_EVENT_TYPE_RECONNECT: ovsdb_idl_txn_abort_all(idl); break; case OVSDB_CS_EVENT_TYPE_LOCKED: if (ovsdb_cs_may_send_transaction(idl->cs)) { /* If the client couldn't run a transaction because it didn't * have the lock, this will encourage it to try again. */ idl->change_seqno++; } else { /* We're setting up a session, so don't signal that the * database changed. Finalizing the session will increment * change_seqno anyhow. */ } break; case OVSDB_CS_EVENT_TYPE_UPDATE: ovsdb_idl_parse_update(idl, &event->update); break; case OVSDB_CS_EVENT_TYPE_TXN_REPLY: ovsdb_idl_txn_process_reply(idl, event->txn_reply); break; } ovsdb_cs_event_destroy(event); } ovsdb_idl_reparse_refs_to_inserted(idl); ovsdb_idl_reparse_deleted(idl); ovsdb_idl_row_destroy_postprocess(idl); } /* Arranges for poll_block() to wake up when ovsdb_idl_run() has something to * do or when activity occurs on a transaction on 'idl'. */ void ovsdb_idl_wait(struct ovsdb_idl *idl) { ovsdb_cs_wait(idl->cs); } /* Returns memory usage statistics. */ void ovsdb_idl_get_memory_usage(struct ovsdb_idl *idl, struct simap *usage) { unsigned int cells = 0; if (!idl) { return; } for (size_t i = 0; i < idl->class_->n_tables; i++) { struct ovsdb_idl_table *table = &idl->tables[i]; unsigned int n_columns = table->class_->n_columns; unsigned int n_rows = hmap_count(&table->rows); cells += n_rows * n_columns; } struct { const char *name; unsigned int val; } idl_mem_stats[] = { {"idl-outstanding-txns", hmap_count(&idl->outstanding_txns)}, {"idl-cells", cells}, }; for (size_t i = 0; i < ARRAY_SIZE(idl_mem_stats); i++) { char *stat_name = xasprintf("%s-%s", idl_mem_stats[i].name, idl->class_->database); simap_increase(usage, stat_name, idl_mem_stats[i].val); free(stat_name); } } /* Returns a "sequence number" that represents the state of 'idl'. When * ovsdb_idl_run() changes the database, the sequence number changes. The * initial fetch of the entire contents of the remote database is considered to * be one kind of change. Successfully acquiring a lock, if one has been * configured with ovsdb_idl_set_lock(), is also considered to be a change. * * As long as the sequence number does not change, the client may continue to * use any data structures it obtains from 'idl'. But when it changes, the * client must not access any of these data structures again, because they * could have freed or reused for other purposes. * * The sequence number can occasionally change even if the database does not. * This happens if the connection to the database drops and reconnects, which * causes the database contents to be reloaded even if they didn't change. (It * could also happen if the database server sends out a "change" that reflects * what the IDL already thought was in the database. The database server is * not supposed to do that, but bugs could in theory cause it to do so.) */ unsigned int ovsdb_idl_get_seqno(const struct ovsdb_idl *idl) { return idl->change_seqno; } /* Returns a "sequence number" that represents the number of conditional * monitoring updates successfully received by the OVSDB server of an IDL * connection. * * ovsdb_idl_set_condition() sets a new condition that is different from * the current condtion, the next expected "sequence number" is returned. * * Whenever ovsdb_idl_get_cond_seqno() returns a value that matches * the return value of ovsdb_idl_set_condition(), The client is * assured that: * - The ovsdb_idl_set_condition() changes has been acknowledged by * the OVSDB sever. * * - 'idl' now contains the content matches the new conditions. */ unsigned int ovsdb_idl_get_condition_seqno(const struct ovsdb_idl *idl) { return ovsdb_cs_get_condition_seqno(idl->cs); } /* Returns true if 'idl' successfully connected to the remote database and * retrieved its contents (even if the connection subsequently dropped and is * in the process of reconnecting). If so, then 'idl' contains an atomic * snapshot of the database's contents (but it might be arbitrarily old if the * connection dropped). * * Returns false if 'idl' has never connected or retrieved the database's * contents. If so, 'idl' is empty. */ bool ovsdb_idl_has_ever_connected(const struct ovsdb_idl *idl) { return ovsdb_idl_get_seqno(idl) != 0; } /* Reconfigures 'idl' so that it would reconnect to the database, if * connection was dropped. */ void ovsdb_idl_enable_reconnect(struct ovsdb_idl *idl) { ovsdb_cs_enable_reconnect(idl->cs); } /* Forces 'idl' to drop its connection to the database and reconnect. In the * meantime, the contents of 'idl' will not change. */ void ovsdb_idl_force_reconnect(struct ovsdb_idl *idl) { ovsdb_cs_force_reconnect(idl->cs); } /* Some IDL users should only write to write-only columns. Furthermore, * writing to a column which is not write-only can cause serious performance * degradations for these users. This function causes 'idl' to reject writes * to columns which are not marked write only using ovsdb_idl_omit_alert(). */ void ovsdb_idl_verify_write_only(struct ovsdb_idl *idl) { idl->verify_write_only = true; } /* Returns true if 'idl' is currently connected or trying to connect * and a negative response to a schema request has not been received */ bool ovsdb_idl_is_alive(const struct ovsdb_idl *idl) { return ovsdb_cs_is_alive(idl->cs); } bool ovsdb_idl_is_connected(const struct ovsdb_idl *idl) { return ovsdb_cs_is_connected(idl->cs); } /* Returns the last error reported on a connection by 'idl'. The return value * is 0 only if no connection made by 'idl' has ever encountered an error and * a negative response to a schema request has never been received. See * jsonrpc_get_status() for jsonrpc_session_get_last_error() return value * interpretation. */ int ovsdb_idl_get_last_error(const struct ovsdb_idl *idl) { return ovsdb_cs_get_last_error(idl->cs); } /* Sets the "probe interval" for 'idl->session' to 'probe_interval', in * milliseconds. */ void ovsdb_idl_set_probe_interval(const struct ovsdb_idl *idl, int probe_interval) { ovsdb_cs_set_probe_interval(idl->cs, probe_interval); } static size_t find_uuid_in_array(const struct uuid *target, const struct uuid *array, size_t n) { for (size_t i = 0; i < n; i++) { if (uuid_equals(&array[i], target)) { return i; } } return SIZE_MAX; } static size_t array_contains_uuid(const struct uuid *target, const struct uuid *array, size_t n) { return find_uuid_in_array(target, array, n) != SIZE_MAX; } static bool remove_uuid_from_array(const struct uuid *target, struct uuid *array, size_t *n) { size_t i = find_uuid_in_array(target, array, *n); if (i != SIZE_MAX) { array[i] = array[--*n]; return true; } else { return false; } } static void add_row_references(const struct ovsdb_base_type *type, const union ovsdb_atom *atoms, size_t n_atoms, const struct uuid *exclude_uuid, struct uuid **dstsp, size_t *n_dstsp, size_t *allocated_dstsp) { if (type->type != OVSDB_TYPE_UUID || !type->uuid.refTableName) { return; } for (size_t i = 0; i < n_atoms; i++) { const struct uuid *uuid = &atoms[i].uuid; if (!uuid_equals(uuid, exclude_uuid) && !array_contains_uuid(uuid, *dstsp, *n_dstsp)) { if (*n_dstsp >= *allocated_dstsp) { *dstsp = x2nrealloc(*dstsp, allocated_dstsp, sizeof **dstsp); } (*dstsp)[*n_dstsp] = *uuid; ++*n_dstsp; } } } /* Checks for consistency in 'idl''s graph of arcs between database rows. Each * reference from one row to a different row should be reflected as a "struct * ovsdb_idl_arc" between those rows. * * This function is slow, big-O wise, and aborts if it finds an inconsistency, * thus it is only for use in test programs. */ void ovsdb_idl_check_consistency(const struct ovsdb_idl *idl) { /* Consistency is broken while a transaction is in progress. */ if (!idl->txn) { return; } bool ok = true; struct uuid *dsts = NULL; size_t allocated_dsts = 0; for (size_t i = 0; i < idl->class_->n_tables; i++) { const struct ovsdb_idl_table *table = &idl->tables[i]; const struct ovsdb_idl_table_class *class = table->class_; const struct ovsdb_idl_row *row; HMAP_FOR_EACH (row, hmap_node, &table->rows) { size_t n_dsts = 0; if (row->new_datum) { size_t n_columns = shash_count(&row->table->columns); for (size_t j = 0; j < n_columns; j++) { const struct ovsdb_type *type = &class->columns[j].type; const struct ovsdb_datum *datum = &row->new_datum[j]; add_row_references(&type->key, datum->keys, datum->n, &row->uuid, &dsts, &n_dsts, &allocated_dsts); add_row_references(&type->value, datum->values, datum->n, &row->uuid, &dsts, &n_dsts, &allocated_dsts); } } const struct ovsdb_idl_arc *arc; LIST_FOR_EACH (arc, src_node, &row->src_arcs) { if (!remove_uuid_from_array(&arc->dst->uuid, dsts, &n_dsts)) { VLOG_ERR("unexpected arc from %s row "UUID_FMT" to %s " "row "UUID_FMT, table->class_->name, UUID_ARGS(&row->uuid), arc->dst->table->class_->name, UUID_ARGS(&arc->dst->uuid)); ok = false; } } for (size_t j = 0; j < n_dsts; j++) { VLOG_ERR("%s row "UUID_FMT" missing arc to row "UUID_FMT, table->class_->name, UUID_ARGS(&row->uuid), UUID_ARGS(&dsts[j])); ok = false; } } } free(dsts); ovs_assert(ok); } static struct json * ovsdb_idl_compose_monitor_request(const struct json *schema_json, void *idl_) { struct ovsdb_idl *idl = idl_; struct shash *schema = ovsdb_cs_parse_schema(schema_json); struct json *monitor_requests = json_object_create(); for (size_t i = 0; i < idl->class_->n_tables; i++) { struct ovsdb_idl_table *table = &idl->tables[i]; const struct ovsdb_idl_table_class *tc = table->class_; struct json *monitor_request; const struct sset *table_schema = schema ? shash_find_data(schema, table->class_->name) : NULL; struct json *columns = table->need_table ? json_array_create_empty() : NULL; sset_clear(&table->schema_columns); for (size_t j = 0; j < tc->n_columns; j++) { const struct ovsdb_idl_column *column = &tc->columns[j]; bool idl_has_column = (table_schema && sset_contains(table_schema, column->name)); if (idl_has_column) { sset_add(&table->schema_columns, column->name); } if (column->is_synthetic) { if (idl_has_column) { VLOG_WARN("%s table in %s database has synthetic " "column %s", table->class_->name, idl->class_->database, column->name); } } else if (table->modes[j] & OVSDB_IDL_MONITOR) { if (table_schema && !idl_has_column) { VLOG_WARN("%s table in %s database lacks %s column " "(database needs upgrade?)", table->class_->name, idl->class_->database, column->name); continue; } if (!columns) { columns = json_array_create_empty(); } json_array_add(columns, json_string_create(column->name)); } } if (columns) { if (schema && !table_schema) { VLOG_WARN("%s database lacks %s table " "(database needs upgrade?)", idl->class_->database, table->class_->name); json_destroy(columns); table->in_server_schema = false; continue; } else if (schema && table_schema) { table->in_server_schema = true; } monitor_request = json_object_create(); json_object_put(monitor_request, "columns", columns); json_object_put(monitor_requests, tc->name, json_array_create_1(monitor_request)); } } ovsdb_cs_free_schema(schema); return monitor_requests; } static struct ovsdb_cs_ops ovsdb_idl_cs_ops = { ovsdb_idl_compose_monitor_request, }; const struct ovsdb_idl_class * ovsdb_idl_get_class(const struct ovsdb_idl *idl) { return idl->class_; } /* Given 'column' in some table in 'class', returns the table's class. */ const struct ovsdb_idl_table_class * ovsdb_idl_table_class_from_column(const struct ovsdb_idl_class *class, const struct ovsdb_idl_column *column) { for (size_t i = 0; i < class->n_tables; i++) { const struct ovsdb_idl_table_class *tc = &class->tables[i]; if (column >= tc->columns && column < &tc->columns[tc->n_columns]) { return tc; } } OVS_NOT_REACHED(); } /* Given 'column' in some table in 'idl', returns the table. */ static struct ovsdb_idl_table * ovsdb_idl_table_from_column(const struct ovsdb_idl *idl, const struct ovsdb_idl_column *column) { const struct ovsdb_idl_table_class *tc = ovsdb_idl_table_class_from_column(idl->class_, column); return &idl->tables[tc - idl->class_->tables]; } static unsigned char * ovsdb_idl_get_mode(struct ovsdb_idl *idl, const struct ovsdb_idl_column *column) { ovs_assert(!idl->change_seqno); const struct ovsdb_idl_table *table = ovsdb_idl_table_from_column(idl, column); return &table->modes[column - table->class_->columns]; } static void ovsdb_idl_set_mode(struct ovsdb_idl *idl, const struct ovsdb_idl_column *column, unsigned char mode) { const struct ovsdb_idl_table *table = ovsdb_idl_table_from_column(idl, column); size_t column_idx = column - table->class_->columns; if (table->modes[column_idx] != mode) { *ovsdb_idl_get_mode(idl, column) = mode; } } static void add_ref_table(struct ovsdb_idl *idl, const struct ovsdb_base_type *base) { if (base->type == OVSDB_TYPE_UUID && base->uuid.refTableName) { struct ovsdb_idl_table *table; table = shash_find_data(&idl->table_by_name, base->uuid.refTableName); if (table) { table->need_table = true; } else { VLOG_WARN("%s IDL class missing referenced table %s", idl->class_->database, base->uuid.refTableName); } } } /* Turns on OVSDB_IDL_MONITOR and OVSDB_IDL_ALERT for 'column' in 'idl'. Also * ensures that any tables referenced by 'column' will be replicated, even if * no columns in that table are selected for replication (see * ovsdb_idl_add_table() for more information). * * This function is only useful if 'monitor_everything_by_default' was false in * the call to ovsdb_idl_create(). This function should be called between * ovsdb_idl_create() and the first call to ovsdb_idl_run(). */ void ovsdb_idl_add_column(struct ovsdb_idl *idl, const struct ovsdb_idl_column *column) { ovsdb_idl_set_mode(idl, column, OVSDB_IDL_MONITOR | OVSDB_IDL_ALERT); add_ref_table(idl, &column->type.key); add_ref_table(idl, &column->type.value); } /* Ensures that the table with class 'tc' will be replicated on 'idl' even if * no columns are selected for replication. Just the necessary data for table * references will be replicated (the UUID of the rows, for instance), any * columns not selected for replication will remain unreplicated. * This can be useful because it allows 'idl' to keep track of what rows in the * table actually exist, which in turn allows columns that reference the table * to have accurate contents. (The IDL presents the database with references to * rows that do not exist removed.) * * This function is only useful if 'monitor_everything_by_default' was false in * the call to ovsdb_idl_create(). This function should be called between * ovsdb_idl_create() and the first call to ovsdb_idl_run(). */ void ovsdb_idl_add_table(struct ovsdb_idl *idl, const struct ovsdb_idl_table_class *tc) { for (size_t i = 0; i < idl->class_->n_tables; i++) { struct ovsdb_idl_table *table = &idl->tables[i]; if (table->class_ == tc) { table->need_table = true; return; } } OVS_NOT_REACHED(); } /* Returns 'true' if the 'idl' has seen the table for the 'table_class' * in the schema reported by the server. Returns 'false' otherwise. * * Always returns 'false' if idl has never been connected. * * Please see ovsdb_idl_compose_monitor_request() which sets * 'struct ovsdb_idl_table *'->in_server_schema accordingly. * * Usually this function is used indirectly through one of the * "server_has_table" functions generated by ovsdb-idlc. */ bool ovsdb_idl_server_has_table(const struct ovsdb_idl *idl, const struct ovsdb_idl_table_class *table_class) { const struct ovsdb_idl_table *table = ovsdb_idl_table_from_class(idl, table_class); return (table && table->in_server_schema); } /* Returns 'true' if the 'idl' has seen the 'column' in the schema * reported by the server. Returns 'false' otherwise. * * Always returns 'false' if idl has never been connected. * * Please see ovsdb_idl_compose_monitor_request() which sets * 'struct ovsdb_idl_table *'->schema_columns accordingly. * * Usually this function is used indirectly through one of the * "server_has_column" functions generated by ovsdb-idlc. */ bool ovsdb_idl_server_has_column(const struct ovsdb_idl *idl, const struct ovsdb_idl_column *column) { const struct ovsdb_idl_table *table = ovsdb_idl_table_from_column(idl, column); return (table->in_server_schema && sset_find(&table->schema_columns, column->name)); } /* A single clause within an ovsdb_idl_condition. */ struct ovsdb_idl_clause { struct hmap_node hmap_node; /* In struct ovsdb_idl_condition. */ enum ovsdb_function function; /* Never OVSDB_F_TRUE or OVSDB_F_FALSE. */ const struct ovsdb_idl_column *column; /* Must be nonnull. */ struct ovsdb_datum arg; /* Has ovsdb_type ->column->type. */ }; static uint32_t ovsdb_idl_clause_hash(const struct ovsdb_idl_clause *clause) { uint32_t hash = hash_pointer(clause->column, clause->function); return ovsdb_datum_hash(&clause->arg, &clause->column->type, hash); } static int ovsdb_idl_clause_equals(const struct ovsdb_idl_clause *a, const struct ovsdb_idl_clause *b) { return (a->function == b->function && a->column == b->column && ovsdb_datum_equals(&a->arg, &b->arg, &a->column->type)); } static struct json * ovsdb_idl_clause_to_json(const struct ovsdb_idl_clause *clause) { const char *function = ovsdb_function_to_string(clause->function); return json_array_create_3(json_string_create(clause->column->name), json_string_create(function), ovsdb_datum_to_json(&clause->arg, &clause->column->type)); } static void ovsdb_idl_clause_destroy(struct ovsdb_idl_clause *clause) { if (clause) { ovsdb_datum_destroy(&clause->arg, &clause->column->type); free(clause); } } /* ovsdb_idl_condition. */ void ovsdb_idl_condition_init(struct ovsdb_idl_condition *cnd) { hmap_init(&cnd->clauses); cnd->is_true = false; } void ovsdb_idl_condition_destroy(struct ovsdb_idl_condition *cond) { if (cond) { ovsdb_idl_condition_clear(cond); hmap_destroy(&cond->clauses); } } void ovsdb_idl_condition_clear(struct ovsdb_idl_condition *cond) { struct ovsdb_idl_clause *clause; HMAP_FOR_EACH_SAFE (clause, hmap_node, &cond->clauses) { hmap_remove(&cond->clauses, &clause->hmap_node); ovsdb_idl_clause_destroy(clause); } cond->is_true = false; } bool ovsdb_idl_condition_is_true(const struct ovsdb_idl_condition *condition) { return condition->is_true; } static struct ovsdb_idl_clause * ovsdb_idl_condition_find_clause(const struct ovsdb_idl_condition *condition, const struct ovsdb_idl_clause *target, uint32_t hash) { struct ovsdb_idl_clause *clause; HMAP_FOR_EACH_WITH_HASH (clause, hmap_node, hash, &condition->clauses) { if (ovsdb_idl_clause_equals(clause, target)) { return clause; } } return NULL; } static void ovsdb_idl_condition_add_clause__(struct ovsdb_idl_condition *condition, const struct ovsdb_idl_clause *src, uint32_t hash) { struct ovsdb_idl_clause *clause = xmalloc(sizeof *clause); clause->function = src->function; clause->column = src->column; ovsdb_datum_clone(&clause->arg, &src->arg); hmap_insert(&condition->clauses, &clause->hmap_node, hash); } /* Adds a clause to the condition for replicating the table with class 'tc' in * 'idl'. * * The IDL replicates only rows in a table that satisfy at least one clause in * the table's condition. The default condition for a table has a single * clause with function OVSDB_F_TRUE, so that the IDL replicates all rows in * the table. When the IDL client replaces the default condition by one of its * own, the condition can have any number of clauses. If it has no conditions, * then no rows are replicated. * * Two distinct of clauses can usefully be added: * * - A 'function' of OVSDB_F_TRUE. A "true" clause causes every row to be * replicated, regardless of whether other clauses exist. 'column' and * 'arg' are ignored. * * - Binary 'functions' add a clause of the form " * ", e.g. "column == 5" or "column <= 10". In this case, 'arg' must * have a type that is compatible with 'column'. */ void ovsdb_idl_condition_add_clause(struct ovsdb_idl_condition *condition, enum ovsdb_function function, const struct ovsdb_idl_column *column, const struct ovsdb_datum *arg) { if (condition->is_true) { /* Adding a clause to an always-true condition has no effect. */ } else if (function == OVSDB_F_TRUE) { ovsdb_idl_condition_add_clause_true(condition); } else if (function == OVSDB_F_FALSE) { /* Adding a "false" clause never has any effect. */ } else { struct ovsdb_idl_clause clause = { .function = function, .column = column, }; ovsdb_datum_clone(&clause.arg, arg); uint32_t hash = ovsdb_idl_clause_hash(&clause); if (!ovsdb_idl_condition_find_clause(condition, &clause, hash)) { ovsdb_idl_condition_add_clause__(condition, &clause, hash); } ovsdb_datum_destroy(&clause.arg, &column->type); } } void ovsdb_idl_condition_add_clause_true(struct ovsdb_idl_condition *condition) { if (!condition->is_true) { ovsdb_idl_condition_clear(condition); condition->is_true = true; } } static struct json * ovsdb_idl_condition_to_json(const struct ovsdb_idl_condition *cnd) { if (cnd->is_true) { return NULL; } size_t n = hmap_count(&cnd->clauses); if (!n) { return json_array_create_1(json_boolean_create(false)); } struct json **clauses = xmalloc(n * sizeof *clauses); const struct ovsdb_idl_clause *clause; size_t i = 0; HMAP_FOR_EACH (clause, hmap_node, &cnd->clauses) { clauses[i++] = ovsdb_idl_clause_to_json(clause); } ovs_assert(i == n); return json_array_create(clauses, n); } /* Sets the replication condition for 'tc' in 'idl' to 'condition' and * arranges to send the new condition to the database server. * * Return the next conditional update sequence number. When this * value and ovsdb_idl_get_condition_seqno() matches, the 'idl' * contains rows that match the 'condition'. */ unsigned int ovsdb_idl_set_condition(struct ovsdb_idl *idl, const struct ovsdb_idl_table_class *tc, const struct ovsdb_idl_condition *condition) { struct json *cond_json = ovsdb_idl_condition_to_json(condition); unsigned int seqno = ovsdb_cs_set_condition(idl->cs, tc->name, cond_json); json_destroy(cond_json); return seqno; } /* Turns off OVSDB_IDL_ALERT and OVSDB_IDL_TRACK for 'column' in 'idl'. * * This function should be called between ovsdb_idl_create() and the first call * to ovsdb_idl_run(). */ void ovsdb_idl_omit_alert(struct ovsdb_idl *idl, const struct ovsdb_idl_column *column) { *ovsdb_idl_get_mode(idl, column) &= ~(OVSDB_IDL_ALERT | OVSDB_IDL_TRACK); } /* Sets the mode for 'column' in 'idl' to 0. See the big comment above * OVSDB_IDL_MONITOR for details. * * This function should be called between ovsdb_idl_create() and the first call * to ovsdb_idl_run(). */ void ovsdb_idl_omit(struct ovsdb_idl *idl, const struct ovsdb_idl_column *column) { *ovsdb_idl_get_mode(idl, column) = 0; } /* Returns the most recent IDL change sequence number that caused a * insert, modify or delete update to the table with class 'table_class'. */ unsigned int ovsdb_idl_table_get_seqno(const struct ovsdb_idl *idl, const struct ovsdb_idl_table_class *table_class) { struct ovsdb_idl_table *table = ovsdb_idl_table_from_class(idl, table_class); unsigned int max_seqno = table->change_seqno[OVSDB_IDL_CHANGE_INSERT]; if (max_seqno < table->change_seqno[OVSDB_IDL_CHANGE_MODIFY]) { max_seqno = table->change_seqno[OVSDB_IDL_CHANGE_MODIFY]; } if (max_seqno < table->change_seqno[OVSDB_IDL_CHANGE_DELETE]) { max_seqno = table->change_seqno[OVSDB_IDL_CHANGE_DELETE]; } return max_seqno; } /* For each row that contains tracked columns, IDL stores the most * recent IDL change sequence numbers associateed with insert, modify * and delete updates to the table. */ unsigned int ovsdb_idl_row_get_seqno(const struct ovsdb_idl_row *row, enum ovsdb_idl_change change) { return row->change_seqno[change]; } /* Turns on OVSDB_IDL_TRACK for 'column' in 'idl', ensuring that * all rows whose 'column' is modified are traced. Similarly, insert * or delete of rows having 'column' are tracked. Clients are able * to retrieve the tracked rows with the ovsdb_idl_track_get_*() * functions. * * This function should be called between ovsdb_idl_create() and * the first call to ovsdb_idl_run(). The column to be tracked * should have OVSDB_IDL_ALERT turned on. */ void ovsdb_idl_track_add_column(struct ovsdb_idl *idl, const struct ovsdb_idl_column *column) { if (!(*ovsdb_idl_get_mode(idl, column) & OVSDB_IDL_ALERT)) { ovsdb_idl_add_column(idl, column); } *ovsdb_idl_get_mode(idl, column) |= OVSDB_IDL_TRACK; } void ovsdb_idl_track_add_all(struct ovsdb_idl *idl) { size_t i, j; for (i = 0; i < idl->class_->n_tables; i++) { const struct ovsdb_idl_table_class *tc = &idl->class_->tables[i]; for (j = 0; j < tc->n_columns; j++) { const struct ovsdb_idl_column *column = &tc->columns[j]; ovsdb_idl_track_add_column(idl, column); } } } /* Returns true if 'table' has any tracked column. */ bool ovsdb_idl_track_is_set(struct ovsdb_idl_table *table) { size_t i; for (i = 0; i < table->class_->n_columns; i++) { if (table->modes[i] & OVSDB_IDL_TRACK) { return true; } } return false; } /* Returns the first tracked row in table with class 'table_class' * for the specified 'idl'. Returns NULL if there are no tracked rows. * Pure orphan rows, i.e. rows that never had any datum, are skipped. */ const struct ovsdb_idl_row * ovsdb_idl_track_get_first(const struct ovsdb_idl *idl, const struct ovsdb_idl_table_class *table_class) { struct ovsdb_idl_table *table = ovsdb_idl_table_from_class(idl, table_class); struct ovsdb_idl_row *row; LIST_FOR_EACH (row, track_node, &table->track_list) { if (!ovsdb_idl_row_is_orphan(row) || row->tracked_old_datum) { return row; } } return NULL; } /* Returns the next tracked row in table after the specified 'row' * (in no particular order). Returns NULL if there are no tracked rows. * Pure orphan rows, i.e. rows that never had any datum, are skipped. */ const struct ovsdb_idl_row * ovsdb_idl_track_get_next(const struct ovsdb_idl_row *row) { struct ovsdb_idl_table *table = row->table; LIST_FOR_EACH_CONTINUE (row, track_node, &table->track_list) { if (!ovsdb_idl_row_is_orphan(row) || row->tracked_old_datum) { return row; } } return NULL; } /* Returns true if a tracked 'column' in 'row' was updated by IDL, false * otherwise. The tracking data is cleared by ovsdb_idl_track_clear() * * Function returns false if 'column' is not tracked (see * ovsdb_idl_track_add_column()). */ bool ovsdb_idl_track_is_updated(const struct ovsdb_idl_row *row, const struct ovsdb_idl_column *column) { const struct ovsdb_idl_table_class *class; size_t column_idx; class = row->table->class_; column_idx = column - class->columns; if (row->updated && bitmap_is_set(row->updated, column_idx)) { return true; } else { return false; } } static void ovsdb_idl_track_clear__(struct ovsdb_idl *idl, bool flush_all) { size_t i; for (i = 0; i < idl->class_->n_tables; i++) { struct ovsdb_idl_table *table = &idl->tables[i]; if (!ovs_list_is_empty(&table->track_list)) { struct ovsdb_idl_row *row; LIST_FOR_EACH_SAFE (row, track_node, &table->track_list) { if (row->updated) { free(row->updated); row->updated = NULL; } ovsdb_idl_row_untrack_change(row); if (ovsdb_idl_row_is_orphan(row)) { ovsdb_idl_row_unparse(row); if (row->tracked_old_datum) { const struct ovsdb_idl_table_class *class = row->table->class_; for (size_t c = 0; c < class->n_columns; c++) { ovsdb_datum_destroy(&row->tracked_old_datum[c], &class->columns[c].type); } free(row->tracked_old_datum); row->tracked_old_datum = NULL; } /* Rows that were reused as orphan after being processed * for deletion are still in the table hmap and will be * cleaned up when their src arcs are removed. These rows * will not be reported anymore as "deleted" to IDL * clients. * * The exception is when 'destroy' is explicitly set to * 'true' which usually happens when the complete IDL * contents are being flushed. */ if (flush_all || ovs_list_is_empty(&row->dst_arcs)) { free(row); } } } } } } /* Flushes the tracked rows. Client calls this function after calling * ovsdb_idl_run() and read all tracked rows with the ovsdb_idl_track_get_*() * functions. This is usually done at the end of the client's processing * loop when it is ready to do ovsdb_idl_run() again. */ void ovsdb_idl_track_clear(struct ovsdb_idl *idl) { ovsdb_idl_track_clear__(idl, false); } /* Sets or clears (depending on 'enable') OVSDB_IDL_WRITE_CHANGED_ONLY * for 'column' in 'idl', ensuring that the column will be included in a * transaction only if its value has actually changed locally. Normally * read/write columns that are written to are always included in the * transaction but, in specific cases, when the application doesn't * require atomicity of writes across different columns, the ones that * don't change value may be skipped. * * This function should be called between ovsdb_idl_create() and * the first call to ovsdb_idl_run(). */ void ovsdb_idl_set_write_changed_only(struct ovsdb_idl *idl, const struct ovsdb_idl_column *column, bool enable) { if (enable) { *ovsdb_idl_get_mode(idl, column) |= OVSDB_IDL_WRITE_CHANGED_ONLY; } else { *ovsdb_idl_get_mode(idl, column) &= ~OVSDB_IDL_WRITE_CHANGED_ONLY; } } /* Helper function to wrap calling ovsdb_idl_set_write_changed_only() for * all columns that are part of 'idl'. */ void ovsdb_idl_set_write_changed_only_all(struct ovsdb_idl *idl, bool enable) { for (size_t i = 0; i < idl->class_->n_tables; i++) { const struct ovsdb_idl_table_class *tc = &idl->class_->tables[i]; for (size_t j = 0; j < tc->n_columns; j++) { const struct ovsdb_idl_column *column = &tc->columns[j]; ovsdb_idl_set_write_changed_only(idl, column, enable); } } } static void log_parse_update_error(struct ovsdb_error *error) { if (!VLOG_DROP_WARN(&syntax_rl)) { char *s = ovsdb_error_to_string(error); VLOG_WARN_RL(&syntax_rl, "%s", s); free(s); } ovsdb_error_destroy(error); } static struct ovsdb_error * ovsdb_idl_parse_update__(struct ovsdb_idl *idl, const struct ovsdb_cs_db_update *du) { for (size_t i = 0; i < du->n; i++) { const struct ovsdb_cs_table_update *tu = &du->table_updates[i]; struct ovsdb_idl_table *table = shash_find_data(&idl->table_by_name, tu->table_name); if (!table) { return ovsdb_syntax_error( NULL, NULL, "update to unknown table \"%s\"", tu->table_name); } for (size_t j = 0; j < tu->n; j++) { const struct ovsdb_cs_row_update *ru = &tu->row_updates[j]; switch (ovsdb_idl_process_update(table, ru)) { case OVSDB_IDL_UPDATE_DB_CHANGED: idl->change_seqno++; break; case OVSDB_IDL_UPDATE_NO_CHANGES: break; case OVSDB_IDL_UPDATE_INCONSISTENT: ovsdb_cs_flag_inconsistency(idl->cs); return ovsdb_error(NULL, "row update received for inconsistent " "IDL: reconnecting IDL and resync all " "data"); } } } return NULL; } static void ovsdb_idl_parse_update(struct ovsdb_idl *idl, const struct ovsdb_cs_update_event *update) { if (update->monitor_reply) { /* XXX This isn't semantically required, because we only need to * increment change_seqno if there's a real change, which we'll do * below, but older versions of the IDL always incremented change_seqno * when a monitor reply was received and if we don't do it then tests * will fail. */ idl->change_seqno++; } struct ovsdb_cs_db_update *du; struct ovsdb_error *error = ovsdb_cs_parse_db_update( update->table_updates, update->version, &du); if (!error) { if (update->clear) { ovsdb_idl_clear(idl); } error = ovsdb_idl_parse_update__(idl, du); } ovsdb_cs_db_update_destroy(du); if (error) { log_parse_update_error(error); } } /* Reparses references to rows that have been deleted in the current IDL run. * * To ensure that reference sources that are deleted are not reparsed, * this function must be called after all updates have been processed in * the current IDL run, i.e., after all calls to ovsdb_idl_parse_update(). */ static void ovsdb_idl_reparse_deleted(struct ovsdb_idl *db) { struct ovsdb_idl_row *row; LIST_FOR_EACH_SAFE (row, track_node, &db->deleted_untracked_rows) { ovsdb_idl_row_untrack_change(row); add_tracked_change_for_references(row); ovsdb_idl_row_reparse_backrefs(row); /* Orphan rows that are still unreferenced or are part of tables that * have change tracking enabled should be added to their table's * 'track_list'. */ if (ovs_list_is_empty(&row->dst_arcs) || ovsdb_idl_track_is_set(row->table)) { ovsdb_idl_row_track_change(row, OVSDB_IDL_CHANGE_DELETE); } } } /* Reparses rows that refer to rows that were inserted in the * current IDL run. */ static void ovsdb_idl_reparse_refs_to_inserted(struct ovsdb_idl *db) { struct ovsdb_idl_row *row; LIST_FOR_EACH_POP (row, reparse_node, &db->rows_to_reparse) { ovs_list_init(&row->reparse_node); /* Skip rows that have been deleted in the meantime. */ if (ovsdb_idl_row_is_orphan(row)) { continue; } ovsdb_idl_row_unparse(row); ovsdb_idl_row_clear_arcs(row, false); ovsdb_idl_row_parse(row); } } static struct ovsdb_idl_row * ovsdb_idl_get_row(struct ovsdb_idl_table *table, const struct uuid *uuid) { struct ovsdb_idl_row *row; HMAP_FOR_EACH_WITH_HASH (row, hmap_node, uuid_hash(uuid), &table->rows) { if (uuid_equals(&row->uuid, uuid)) { return row; } } return NULL; } /* Returns OVSDB_IDL_UPDATE_DB_CHANGED if a column with mode * OVSDB_IDL_MODE_RW changed. * * Some IDL inconsistencies can be detected when processing updates: * - trying to insert an already existing row * - trying to update a missing row * - trying to delete a non existent row * * In such cases OVSDB_IDL_UPDATE_INCONSISTENT is returned. * Even though the IDL client could recover, it's best to report the * inconsistent state because the state the server is in is unknown so the * safest thing to do is to retry (potentially connecting to a new server). * * Returns OVSDB_IDL_UPDATE_NO_CHANGES otherwise. */ static enum update_result ovsdb_idl_process_update(struct ovsdb_idl_table *table, const struct ovsdb_cs_row_update *ru) { const struct uuid *uuid = &ru->row_uuid; struct ovsdb_idl_row *row = ovsdb_idl_get_row(table, uuid); switch (ru->type) { case OVSDB_CS_ROW_DELETE: if (row && !ovsdb_idl_row_is_orphan(row)) { /* XXX perhaps we should check the 'old' values? */ ovsdb_idl_delete_row(row); } else { VLOG_ERR_RL(&semantic_rl, "cannot delete missing row "UUID_FMT" " "from table %s", UUID_ARGS(uuid), table->class_->name); return OVSDB_IDL_UPDATE_INCONSISTENT; } break; case OVSDB_CS_ROW_INSERT: if (!row) { ovsdb_idl_insert_row(ovsdb_idl_row_create(table, uuid), ru->columns); } else if (ovsdb_idl_row_is_orphan(row)) { ovsdb_idl_row_untrack_change(row); ovsdb_idl_insert_row(row, ru->columns); } else { VLOG_ERR_RL(&semantic_rl, "cannot add existing row "UUID_FMT" to " "table %s", UUID_ARGS(uuid), table->class_->name); return OVSDB_IDL_UPDATE_INCONSISTENT; } break; case OVSDB_CS_ROW_UPDATE: case OVSDB_CS_ROW_XOR: if (row) { if (!ovsdb_idl_row_is_orphan(row)) { return ovsdb_idl_modify_row(row, ru->columns, ru->type == OVSDB_CS_ROW_XOR) ? OVSDB_IDL_UPDATE_DB_CHANGED : OVSDB_IDL_UPDATE_NO_CHANGES; } else { VLOG_ERR_RL(&semantic_rl, "cannot modify missing but " "referenced row "UUID_FMT" in table %s", UUID_ARGS(uuid), table->class_->name); return OVSDB_IDL_UPDATE_INCONSISTENT; } } else { VLOG_ERR_RL(&semantic_rl, "cannot modify missing row "UUID_FMT" " "in table %s", UUID_ARGS(uuid), table->class_->name); return OVSDB_IDL_UPDATE_INCONSISTENT; } break; default: OVS_NOT_REACHED(); } return OVSDB_IDL_UPDATE_DB_CHANGED; } /* Recursively add rows to tracked change lists for all rows that reference 'row'. */ static void add_tracked_change_for_references(struct ovsdb_idl_row *row) { const struct ovsdb_idl_arc *arc; LIST_FOR_EACH (arc, dst_node, &row->dst_arcs) { struct ovsdb_idl_row *ref = arc->src; if (ovs_list_is_empty(&ref->track_node) && ovsdb_idl_track_is_set(ref->table)) { ovsdb_idl_row_track_change(ref, OVSDB_IDL_CHANGE_MODIFY); add_tracked_change_for_references(ref); } } } /* Returns true if a column with mode OVSDB_IDL_MODE_RW changed, false * otherwise. * * Change 'row' either with the content of 'row_json' or by apply 'diff'. * Caller needs to provide either valid 'row_json' or 'diff', but not * both. */ static bool ovsdb_idl_row_change(struct ovsdb_idl_row *row, const struct shash *values, bool xor, enum ovsdb_idl_change change) { struct ovsdb_idl_table *table = row->table; const struct ovsdb_idl_table_class *class = table->class_; struct shash_node *node; bool changed = false; SHASH_FOR_EACH (node, values) { const char *column_name = node->name; const struct ovsdb_idl_column *column; struct ovsdb_error *error; unsigned int column_idx; struct ovsdb_datum *old; bool datum_changed = false; column = shash_find_data(&table->columns, column_name); if (!column) { VLOG_WARN_RL(&syntax_rl, "unknown column %s updating row "UUID_FMT, column_name, UUID_ARGS(&row->uuid)); continue; } column_idx = column - table->class_->columns; old = &row->old_datum[column_idx]; if (xor) { struct ovsdb_datum diff; error = ovsdb_transient_datum_from_json(&diff, &column->type, node->data); if (!error) { error = ovsdb_datum_apply_diff_in_place(old, &diff, &column->type); ovsdb_datum_destroy(&diff, &column->type); datum_changed = true; } } else { struct ovsdb_datum datum; error = ovsdb_datum_from_json(&datum, &column->type, node->data, NULL); if (!error) { if (!ovsdb_datum_equals(old, &datum, &column->type)) { ovsdb_datum_swap(old, &datum); datum_changed = true; } ovsdb_datum_destroy(&datum, &column->type); } } if (error) { char *s = ovsdb_error_to_string_free(error); VLOG_WARN_RL(&syntax_rl, "error parsing column %s in row "UUID_FMT " in table %s: %s", column_name, UUID_ARGS(&row->uuid), table->class_->name, s); free(s); continue; } if (datum_changed && table->modes[column_idx] & OVSDB_IDL_ALERT) { changed = true; row->change_seqno[change] = row->table->change_seqno[change] = row->table->idl->change_seqno + 1; if (table->modes[column_idx] & OVSDB_IDL_TRACK) { if (ovs_list_is_empty(&row->track_node) && ovsdb_idl_track_is_set(row->table)) { ovs_list_push_back(&row->table->track_list, &row->track_node); } add_tracked_change_for_references(row); if (!row->updated) { row->updated = bitmap_allocate(class->n_columns); } bitmap_set1(row->updated, column_idx); } } } return changed; } /* When a row A refers to row B through a column with a "refTable" constraint, * but row B does not exist, row B is called an "orphan row". Orphan rows * should not persist, because the database enforces referential integrity, but * they can appear transiently as changes from the database are received (the * database doesn't try to topologically sort them and circular references mean * it isn't always possible anyhow). * * This function returns true if 'row' is an orphan row, otherwise false. */ static bool ovsdb_idl_row_is_orphan(const struct ovsdb_idl_row *row) { return !row->old_datum && !row->new_datum; } /* Returns true if 'row' is conceptually part of the database as modified by * the current transaction (if any), false otherwise. * * This function will return true if 'row' is not an orphan (see the comment on * ovsdb_idl_row_is_orphan()) and: * * - 'row' exists in the database and has not been deleted within the * current transaction (if any). * * - 'row' was inserted within the current transaction and has not been * deleted. (In the latter case you should not have passed 'row' in at * all, because ovsdb_idl_txn_delete() freed it.) * * This function will return false if 'row' is an orphan or if 'row' was * deleted within the current transaction. */ static bool ovsdb_idl_row_exists(const struct ovsdb_idl_row *row) { return row->new_datum != NULL; } static void ovsdb_idl_row_parse(struct ovsdb_idl_row *row) { const struct ovsdb_idl_table_class *class = row->table->class_; size_t i; if (row->parsed) { ovsdb_idl_row_unparse(row); } for (i = 0; i < class->n_columns; i++) { const struct ovsdb_idl_column *c = &class->columns[i]; (c->parse)(row, &row->old_datum[i]); } row->parsed = true; } static void ovsdb_idl_row_unparse(struct ovsdb_idl_row *row) { const struct ovsdb_idl_table_class *class = row->table->class_; size_t i; if (!row->parsed) { return; } for (i = 0; i < class->n_columns; i++) { const struct ovsdb_idl_column *c = &class->columns[i]; (c->unparse)(row); } row->parsed = false; } /* The OVSDB-IDL Compound Indexes feature allows for the creation of custom * table indexes over one or more columns in the IDL. These indexes provide * the ability to retrieve rows matching a particular search criteria and to * iterate over a subset of rows in a defined order. */ /* Generic comparator that can compare each index, using the custom * configuration (an struct ovsdb_idl_index) passed to it. * Not intended for direct usage. */ static int ovsdb_idl_index_generic_comparer(const void *a, const void *b, const void *conf) { const struct ovsdb_idl_column *column; const struct ovsdb_idl_index *index; size_t i; index = CONST_CAST(struct ovsdb_idl_index *, conf); if (a == b) { return 0; } for (i = 0; i < index->n_columns; i++) { int val; if (index->columns[i].comparer) { val = index->columns[i].comparer(a, b); } else { column = index->columns[i].column; const struct ovsdb_idl_row *row_a, *row_b; row_a = CONST_CAST(struct ovsdb_idl_row *, a); row_b = CONST_CAST(struct ovsdb_idl_row *, b); const struct ovsdb_datum *datum_a, *datum_b; datum_a = ovsdb_idl_read(row_a, column); datum_b = ovsdb_idl_read(row_b, column); val = ovsdb_datum_compare_3way(datum_a, datum_b, &column->type); } if (val) { return index->columns[i].order == OVSDB_INDEX_ASC ? val : -val; } } /* If ins_del is true then a row is being inserted into or deleted from * the index list. In this case, we augment the search key with * additional values (row UUID and memory address) to create a unique * search key in order to locate the correct entry efficiently and to * ensure that the correct entry is deleted in the case of a "delete" * operation. */ if (index->ins_del) { const struct ovsdb_idl_row *row_a, *row_b; row_a = (const struct ovsdb_idl_row *) a; row_b = (const struct ovsdb_idl_row *) b; int value = uuid_compare_3way(&row_a->uuid, &row_b->uuid); return value ? value : (a < b) - (a > b); } else { return 0; } } /* Creates a new index for the given 'idl' and with the 'n' specified * 'columns'. * * All indexes must be created before the first call to ovsdb_idl_run(). */ struct ovsdb_idl_index * ovsdb_idl_index_create(struct ovsdb_idl *idl, const struct ovsdb_idl_index_column *columns, size_t n) { ovs_assert(n > 0); struct ovsdb_idl_index *index = xzalloc(sizeof *index); index->table = ovsdb_idl_table_from_column(idl, columns[0].column); for (size_t i = 0; i < n; i++) { const struct ovsdb_idl_index_column *c = &columns[i]; ovs_assert(ovsdb_idl_table_from_column(idl, c->column) == index->table); ovs_assert(*ovsdb_idl_get_mode(idl, c->column) & OVSDB_IDL_MONITOR); } index->columns = xmemdup(columns, n * sizeof *columns); index->n_columns = n; index->skiplist = skiplist_create(ovsdb_idl_index_generic_comparer, index); ovs_list_push_back(&index->table->indexes, &index->node); return index; } struct ovsdb_idl_index * ovsdb_idl_index_create1(struct ovsdb_idl *idl, const struct ovsdb_idl_column *column1) { const struct ovsdb_idl_index_column columns[] = { { .column = column1 }, }; return ovsdb_idl_index_create(idl, columns, ARRAY_SIZE(columns)); } struct ovsdb_idl_index * ovsdb_idl_index_create2(struct ovsdb_idl *idl, const struct ovsdb_idl_column *column1, const struct ovsdb_idl_column *column2) { const struct ovsdb_idl_index_column columns[] = { { .column = column1 }, { .column = column2 }, }; return ovsdb_idl_index_create(idl, columns, ARRAY_SIZE(columns)); } static void ovsdb_idl_destroy_indexes(struct ovsdb_idl_table *table) { struct ovsdb_idl_index *index; LIST_FOR_EACH_SAFE (index, node, &table->indexes) { skiplist_destroy(index->skiplist, NULL); free(index->columns); free(index); } } static void ovsdb_idl_add_to_indexes(const struct ovsdb_idl_row *row) { struct ovsdb_idl_table *table = row->table; struct ovsdb_idl_index *index; LIST_FOR_EACH (index, node, &table->indexes) { index->ins_del = true; skiplist_insert(index->skiplist, row); index->ins_del = false; } } static void ovsdb_idl_remove_from_indexes(const struct ovsdb_idl_row *row) { struct ovsdb_idl_table *table = row->table; struct ovsdb_idl_index *index; LIST_FOR_EACH (index, node, &table->indexes) { index->ins_del = true; skiplist_delete(index->skiplist, row); index->ins_del = false; } } /* Writes a datum in an ovsdb_idl_row, and updates the corresponding field in * the table record. Not intended for direct usage. */ void ovsdb_idl_index_write(struct ovsdb_idl_row *const_row, const struct ovsdb_idl_column *column, struct ovsdb_datum *datum, const struct ovsdb_idl_table_class *class) { struct ovsdb_idl_row *row = CONST_CAST(struct ovsdb_idl_row *, const_row); size_t column_idx = column - class->columns; if (bitmap_is_set(row->written, column_idx)) { free(row->new_datum[column_idx].values); free(row->new_datum[column_idx].keys); } else { bitmap_set1(row->written, column_idx); } row->new_datum[column_idx] = *datum; (column->unparse)(row); (column->parse)(row, &row->new_datum[column_idx]); } /* Magic UUID for index rows */ static const struct uuid index_row_uuid = { .parts = {0xdeadbeef, 0xdeadbeef, 0xdeadbeef, 0xdeadbeef}}; /* Check if a row is an index row */ static bool is_index_row(const struct ovsdb_idl_row *row) { return uuid_equals(&row->uuid, &index_row_uuid); } /* Initializes a row for use in an indexed query. * Not intended for direct usage. */ struct ovsdb_idl_row * ovsdb_idl_index_init_row(struct ovsdb_idl_index *index) { const struct ovsdb_idl_table_class *class = index->table->class_; struct ovsdb_idl_row *row = xzalloc(class->allocation_size); class->row_init(row); row->uuid = index_row_uuid; row->new_datum = xmalloc(class->n_columns * sizeof *row->new_datum); row->written = bitmap_allocate(class->n_columns); row->table = index->table; /* arcs are not used for index row, but it doesn't harm to initialize */ ovs_list_init(&row->src_arcs); ovs_list_init(&row->dst_arcs); return row; } /* Destroys 'row_' and frees all associated memory. This function is intended * to be used indirectly through one of the "index_destroy_row" functions * generated by ovsdb-idlc. */ void ovsdb_idl_index_destroy_row(const struct ovsdb_idl_row *row_) { struct ovsdb_idl_row *row = CONST_CAST(struct ovsdb_idl_row *, row_); const struct ovsdb_idl_table_class *class = row->table->class_; const struct ovsdb_idl_column *c; size_t i; ovs_assert(is_index_row(row_)); ovs_assert(ovs_list_is_empty(&row_->src_arcs)); ovs_assert(ovs_list_is_empty(&row_->dst_arcs)); BITMAP_FOR_EACH_1 (i, class->n_columns, row->written) { c = &class->columns[i]; (c->unparse) (row); ovsdb_datum_destroy(&row->new_datum[i], &c->type); } free(row->new_datum); free(row->written); free(row); } struct ovsdb_idl_row * ovsdb_idl_index_find(struct ovsdb_idl_index *index, const struct ovsdb_idl_row *target) { return skiplist_get_data(skiplist_find(index->skiplist, target)); } struct ovsdb_idl_cursor ovsdb_idl_cursor_first(struct ovsdb_idl_index *index) { struct skiplist_node *node = skiplist_first(index->skiplist); return (struct ovsdb_idl_cursor) { index, node }; } struct ovsdb_idl_cursor ovsdb_idl_cursor_first_eq(struct ovsdb_idl_index *index, const struct ovsdb_idl_row *target) { struct skiplist_node *node = skiplist_find(index->skiplist, target); return (struct ovsdb_idl_cursor) { index, node }; } struct ovsdb_idl_cursor ovsdb_idl_cursor_first_ge(struct ovsdb_idl_index *index, const struct ovsdb_idl_row *target) { struct skiplist_node *node = (target ? skiplist_forward_to(index->skiplist, target) : skiplist_first(index->skiplist)); return (struct ovsdb_idl_cursor) { index, node }; } void ovsdb_idl_cursor_next(struct ovsdb_idl_cursor *cursor) { cursor->position = skiplist_next(cursor->position); } void ovsdb_idl_cursor_next_eq(struct ovsdb_idl_cursor *cursor) { struct ovsdb_idl_row *data = skiplist_get_data(cursor->position); struct skiplist_node *next_position = skiplist_next(cursor->position); struct ovsdb_idl_row *next_data = skiplist_get_data(next_position); cursor->position = (!ovsdb_idl_index_compare(cursor->index, data, next_data) ? next_position : NULL); } struct ovsdb_idl_row * ovsdb_idl_cursor_data(struct ovsdb_idl_cursor *cursor) { return skiplist_get_data(cursor->position); } /* Returns the result of comparing two rows using the comparison function * for this index. * Returns: * < 0 if a < b * 0 if a == b * > 0 if a > b * When the pointer to either row is NULL, this function considers NULL to be * greater than any other value, and NULL == NULL. */ int ovsdb_idl_index_compare(struct ovsdb_idl_index *index, const struct ovsdb_idl_row *a, const struct ovsdb_idl_row *b) { if (a && b) { return ovsdb_idl_index_generic_comparer(a, b, index); } else if (!a && !b) { return 0; } else if (a) { return -1; } else { return 1; } } static void ovsdb_idl_row_clear_old(struct ovsdb_idl_row *row) { ovs_assert(row->old_datum == row->new_datum); if (!ovsdb_idl_row_is_orphan(row)) { if (ovsdb_idl_track_is_set(row->table) && !row->tracked_old_datum) { row->tracked_old_datum = row->old_datum; } else { const struct ovsdb_idl_table_class *class = row->table->class_; size_t i; for (i = 0; i < class->n_columns; i++) { ovsdb_datum_destroy(&row->old_datum[i], &class->columns[i].type); } free(row->old_datum); } row->old_datum = row->new_datum = NULL; } } static void ovsdb_idl_row_clear_new(struct ovsdb_idl_row *row) { if (row->old_datum != row->new_datum) { if (row->new_datum) { const struct ovsdb_idl_table_class *class = row->table->class_; size_t i; if (row->written) { BITMAP_FOR_EACH_1 (i, class->n_columns, row->written) { ovsdb_datum_destroy(&row->new_datum[i], &class->columns[i].type); } } free(row->new_datum); free(row->written); row->written = NULL; } row->new_datum = row->old_datum; } } static void ovsdb_idl_row_clear_arcs(struct ovsdb_idl_row *row, bool destroy_dsts) { struct ovsdb_idl_arc *arc; /* Delete all forward arcs. If 'destroy_dsts', destroy any orphaned rows * that this causes to be unreferenced. */ LIST_FOR_EACH_SAFE (arc, src_node, &row->src_arcs) { ovs_list_remove(&arc->dst_node); if (destroy_dsts && ovsdb_idl_row_is_orphan(arc->dst) && ovs_list_is_empty(&arc->dst->dst_arcs)) { ovsdb_idl_row_destroy(arc->dst); } free(arc); } ovs_list_init(&row->src_arcs); } /* Force nodes that reference 'row' to reparse. */ static void ovsdb_idl_row_reparse_backrefs(struct ovsdb_idl_row *row) { struct ovsdb_idl_arc *arc; /* This is trickier than it looks. ovsdb_idl_row_clear_arcs() will destroy * 'arc', so we need to use the "safe" variant of list traversal. However, * calling an ovsdb_idl_column's 'parse' function will add an arc * equivalent to 'arc' to row->arcs. That could be a problem for * traversal, but it adds it at the beginning of the list to prevent us * from stumbling upon it again. * * (If duplicate arcs were possible then we would need to make sure that * 'next' didn't also point into 'arc''s destination, but we forbid * duplicate arcs.) */ LIST_FOR_EACH_SAFE (arc, dst_node, &row->dst_arcs) { struct ovsdb_idl_row *ref = arc->src; ovsdb_idl_row_unparse(ref); ovsdb_idl_row_clear_arcs(ref, false); ovsdb_idl_row_parse(ref); } } /* Add all backrefs of a row to the 'rows_to_reparse' list, so they can be * re-parsed later. */ static void ovsdb_idl_row_mark_backrefs_for_reparsing(struct ovsdb_idl_row *row) { struct ovsdb_idl_arc *arc; LIST_FOR_EACH (arc, dst_node, &row->dst_arcs) { struct ovsdb_idl_row *ref = arc->src; if (ovs_list_is_empty(&ref->reparse_node)) { ovs_list_push_back(&ref->table->idl->rows_to_reparse, &ref->reparse_node); } } } static void ovsdb_idl_row_track_change(struct ovsdb_idl_row *row, enum ovsdb_idl_change change) { row->change_seqno[change] = row->table->change_seqno[change] = row->table->idl->change_seqno + 1; if (ovs_list_is_empty(&row->track_node)) { ovs_list_push_back(&row->table->track_list, &row->track_node); } } static void ovsdb_idl_row_untrack_change(struct ovsdb_idl_row *row) { if (ovs_list_is_empty(&row->track_node)) { return; } row->change_seqno[OVSDB_IDL_CHANGE_INSERT] = row->change_seqno[OVSDB_IDL_CHANGE_MODIFY] = row->change_seqno[OVSDB_IDL_CHANGE_DELETE] = 0; ovs_list_remove(&row->track_node); ovs_list_init(&row->track_node); } static struct ovsdb_idl_row * ovsdb_idl_row_create__(const struct ovsdb_idl_table_class *class) { struct ovsdb_idl_row *row = xzalloc(class->allocation_size); class->row_init(row); ovs_list_init(&row->src_arcs); ovs_list_init(&row->dst_arcs); ovs_list_init(&row->reparse_node); hmap_node_nullify(&row->txn_node); ovs_list_init(&row->track_node); return row; } static struct ovsdb_idl_row * ovsdb_idl_row_create(struct ovsdb_idl_table *table, const struct uuid *uuid) { struct ovsdb_idl_row *row = ovsdb_idl_row_create__(table->class_); hmap_insert(&table->rows, &row->hmap_node, uuid_hash(uuid)); row->uuid = *uuid; row->table = table; row->map_op_written = NULL; row->map_op_lists = NULL; row->set_op_written = NULL; row->set_op_lists = NULL; return row; } /* If 'row' is not referenced anymore, removes 'row' from the table hmap, * clears the old datum and adds 'row' to the table's track_list. * * If 'row' is still referenced, i.e., became "orphan", queues 'row' for * reparsing after all updates have been processed by adding it to the * 'deleted_untracked_rows' list. */ static void ovsdb_idl_row_destroy(struct ovsdb_idl_row *row) { ovsdb_idl_row_clear_old(row); if (ovs_list_is_empty(&row->dst_arcs)) { hmap_remove(&row->table->rows, &row->hmap_node); ovsdb_idl_destroy_all_map_op_lists(row); ovsdb_idl_destroy_all_set_op_lists(row); ovsdb_idl_row_track_change(row, OVSDB_IDL_CHANGE_DELETE); } else { ovsdb_idl_row_untrack_change(row); ovs_list_push_back(&row->table->idl->deleted_untracked_rows, &row->track_node); } } static void ovsdb_idl_destroy_all_map_op_lists(struct ovsdb_idl_row *row) { if (row->map_op_written) { /* Clear Map Operation Lists */ size_t idx, n_columns; const struct ovsdb_idl_column *columns; const struct ovsdb_type *type; n_columns = row->table->class_->n_columns; columns = row->table->class_->columns; BITMAP_FOR_EACH_1 (idx, n_columns, row->map_op_written) { type = &columns[idx].type; map_op_list_destroy(row->map_op_lists[idx], type); } free(row->map_op_lists); bitmap_free(row->map_op_written); row->map_op_lists = NULL; row->map_op_written = NULL; } } static void ovsdb_idl_destroy_all_set_op_lists(struct ovsdb_idl_row *row) { if (row->set_op_written) { /* Clear Set Operation Lists */ size_t idx, n_columns; const struct ovsdb_idl_column *columns; const struct ovsdb_type *type; n_columns = row->table->class_->n_columns; columns = row->table->class_->columns; BITMAP_FOR_EACH_1 (idx, n_columns, row->set_op_written) { type = &columns[idx].type; set_op_list_destroy(row->set_op_lists[idx], type); } free(row->set_op_lists); bitmap_free(row->set_op_written); row->set_op_lists = NULL; row->set_op_written = NULL; } } static void ovsdb_idl_row_destroy_postprocess(struct ovsdb_idl *idl) { for (size_t i = 0; i < idl->class_->n_tables; i++) { struct ovsdb_idl_table *table = &idl->tables[i]; if (!ovs_list_is_empty(&table->track_list)) { struct ovsdb_idl_row *row; LIST_FOR_EACH_SAFE (row, track_node, &table->track_list) { if (!ovsdb_idl_track_is_set(row->table)) { ovs_list_remove(&row->track_node); ovsdb_idl_row_unparse(row); free(row); } } } } } static void ovsdb_idl_insert_row(struct ovsdb_idl_row *row, const struct shash *data) { const struct ovsdb_idl_table_class *class = row->table->class_; size_t i, datum_size; ovs_assert(!row->old_datum && !row->new_datum); datum_size = class->n_columns * sizeof *row->old_datum; row->old_datum = row->new_datum = xmalloc(datum_size); for (i = 0; i < class->n_columns; i++) { ovsdb_datum_init_default(&row->old_datum[i], &class->columns[i].type); } ovsdb_idl_row_change(row, data, false, OVSDB_IDL_CHANGE_INSERT); ovsdb_idl_row_parse(row); /* Backrefs will be re-parsed after all updates processed to avoid * re-parsing same rows more than once if they are referencing more * than one inserted row. */ ovsdb_idl_row_mark_backrefs_for_reparsing(row); ovsdb_idl_add_to_indexes(row); } static void ovsdb_idl_delete_row(struct ovsdb_idl_row *row) { /* If row has to be reparsed, reparse it before it's deleted. */ if (!ovs_list_is_empty(&row->reparse_node)) { ovsdb_idl_row_parse(row); } ovsdb_idl_remove_from_indexes(row); ovsdb_idl_row_clear_arcs(row, true); ovsdb_idl_row_destroy(row); } /* Returns true if a column with mode OVSDB_IDL_MODE_RW changed, false * otherwise. */ static bool ovsdb_idl_modify_row(struct ovsdb_idl_row *row, const struct shash *values, bool xor) { ovsdb_idl_remove_from_indexes(row); ovsdb_idl_row_unparse(row); ovsdb_idl_row_clear_arcs(row, true); bool changed = ovsdb_idl_row_change(row, values, xor, OVSDB_IDL_CHANGE_MODIFY); ovsdb_idl_row_parse(row); ovsdb_idl_add_to_indexes(row); return changed; } static bool may_add_arc(const struct ovsdb_idl_row *src, const struct ovsdb_idl_row *dst) { const struct ovsdb_idl_arc *arc; /* No self-arcs. */ if (src == dst) { return false; } /* No duplicate arcs. * * We only need to test whether the first arc in dst->dst_arcs originates * at 'src', since we add all of the arcs from a given source in a clump * (in a single call to ovsdb_idl_row_parse()) and new arcs are always * added at the front of the dst_arcs list. */ if (ovs_list_is_empty(&dst->dst_arcs)) { return true; } arc = CONTAINER_OF(dst->dst_arcs.next, struct ovsdb_idl_arc, dst_node); return arc->src != src; } static struct ovsdb_idl_table * ovsdb_idl_table_from_class(const struct ovsdb_idl *idl, const struct ovsdb_idl_table_class *table_class) { ptrdiff_t idx = table_class - idl->class_->tables; return idx >= 0 && idx < idl->class_->n_tables ? &idl->tables[idx] : NULL; } /* Called by ovsdb-idlc generated code. */ struct ovsdb_idl_row * ovsdb_idl_get_row_arc(struct ovsdb_idl_row *src, const struct ovsdb_idl_table_class *dst_table_class, const struct uuid *dst_uuid) { struct ovsdb_idl *idl = src->table->idl; struct ovsdb_idl_table *dst_table; struct ovsdb_idl_arc *arc; struct ovsdb_idl_row *dst; dst_table = ovsdb_idl_table_from_class(idl, dst_table_class); dst = ovsdb_idl_get_row(dst_table, dst_uuid); if (idl->txn || is_index_row(src)) { /* There are two cases we should not update any arcs: * * 1. We're being called from ovsdb_idl_txn_write(). We must not update * any arcs, because the transaction will be backed out at commit or * abort time and we don't want our graph screwed up. * * 2. The row is used as an index for querying purpose only. * * In these cases, just return the destination row, if there is one and * it has not been deleted. */ if (dst && (hmap_node_is_null(&dst->txn_node) || dst->new_datum)) { return dst; } return NULL; } else { /* We're being called from some other context. Update the graph. */ if (!dst) { dst = ovsdb_idl_row_create(dst_table, dst_uuid); } /* Add a new arc, if it wouldn't be a self-arc or a duplicate arc. */ if (may_add_arc(src, dst)) { /* The arc *must* be added at the front of the dst_arcs list. See * ovsdb_idl_row_reparse_backrefs() for details. */ arc = xmalloc(sizeof *arc); ovs_list_push_front(&src->src_arcs, &arc->src_node); ovs_list_push_front(&dst->dst_arcs, &arc->dst_node); arc->src = src; arc->dst = dst; } return !ovsdb_idl_row_is_orphan(dst) ? dst : NULL; } } /* Searches 'tc''s table in 'idl' for a row with UUID 'uuid'. Returns a * pointer to the row if there is one, otherwise a null pointer. */ const struct ovsdb_idl_row * ovsdb_idl_get_row_for_uuid(const struct ovsdb_idl *idl, const struct ovsdb_idl_table_class *tc, const struct uuid *uuid) { return ovsdb_idl_get_row(ovsdb_idl_table_from_class(idl, tc), uuid); } static struct ovsdb_idl_row * next_real_row(struct ovsdb_idl_table *table, struct hmap_node *node) { for (; node; node = hmap_next(&table->rows, node)) { struct ovsdb_idl_row *row; row = CONTAINER_OF(node, struct ovsdb_idl_row, hmap_node); if (ovsdb_idl_row_exists(row)) { return row; } } return NULL; } /* Returns a row in 'table_class''s table in 'idl', or a null pointer if that * table is empty. * * Database tables are internally maintained as hash tables, so adding or * removing rows while traversing the same table can cause some rows to be * visited twice or not at apply. */ const struct ovsdb_idl_row * ovsdb_idl_first_row(const struct ovsdb_idl *idl, const struct ovsdb_idl_table_class *table_class) { struct ovsdb_idl_table *table = ovsdb_idl_table_from_class(idl, table_class); return next_real_row(table, hmap_first(&table->rows)); } /* Returns a row following 'row' within its table, or a null pointer if 'row' * is the last row in its table. */ const struct ovsdb_idl_row * ovsdb_idl_next_row(const struct ovsdb_idl_row *row) { struct ovsdb_idl_table *table = row->table; return next_real_row(table, hmap_next(&table->rows, &row->hmap_node)); } /* Reads and returns the value of 'column' within 'row'. If an ongoing * transaction has changed 'column''s value, the modified value is returned. * * The caller must not modify or free the returned value. * * Various kinds of changes can invalidate the returned value: writing to the * same 'column' in 'row' (e.g. with ovsdb_idl_txn_write()), deleting 'row' * (e.g. with ovsdb_idl_txn_delete()), or completing an ongoing transaction * (e.g. with ovsdb_idl_txn_commit() or ovsdb_idl_txn_abort()). If the * returned value is needed for a long time, it is best to make a copy of it * with ovsdb_datum_clone(). */ const struct ovsdb_datum * ovsdb_idl_read(const struct ovsdb_idl_row *row, const struct ovsdb_idl_column *column) { const struct ovsdb_idl_table_class *class; size_t column_idx; ovs_assert(!ovsdb_idl_row_is_synthetic(row)); class = row->table->class_; column_idx = column - class->columns; ovs_assert(row->new_datum != NULL); ovs_assert(column_idx < class->n_columns); if (row->written && bitmap_is_set(row->written, column_idx)) { return &row->new_datum[column_idx]; } else if (row->old_datum) { return &row->old_datum[column_idx]; } else { return ovsdb_datum_default(&column->type); } } /* Same as ovsdb_idl_read(), except that it also asserts that 'column' has key * type 'key_type' and value type 'value_type'. (Scalar and set types will * have a value type of OVSDB_TYPE_VOID.) * * This is useful in code that "knows" that a particular column has a given * type, so that it will abort if someone changes the column's type without * updating the code that uses it. */ const struct ovsdb_datum * ovsdb_idl_get(const struct ovsdb_idl_row *row, const struct ovsdb_idl_column *column, enum ovsdb_atomic_type key_type OVS_UNUSED, enum ovsdb_atomic_type value_type OVS_UNUSED) { ovs_assert(column->type.key.type == key_type); ovs_assert(column->type.value.type == value_type); return ovsdb_idl_read(row, column); } /* Returns true if the field represented by 'column' in 'row' may be modified, * false if it is immutable. * * Normally, whether a field is mutable is controlled by its column's schema. * However, an immutable column can be set to any initial value at the time of * insertion, so if 'row' is a new row (one that is being added as part of the * current transaction, supposing that a transaction is in progress) then even * its "immutable" fields are actually mutable. */ bool ovsdb_idl_is_mutable(const struct ovsdb_idl_row *row, const struct ovsdb_idl_column *column) { return column->is_mutable || (row->new_datum && !row->old_datum); } /* Returns false if 'row' was obtained from the IDL, true if it was initialized * to all-zero-bits by some other entity. If 'row' was set up some other way * then the return value is indeterminate. */ bool ovsdb_idl_row_is_synthetic(const struct ovsdb_idl_row *row) { return row->table == NULL; } /* Transactions. */ static void ovsdb_idl_txn_complete(struct ovsdb_idl_txn *txn, enum ovsdb_idl_txn_status); /* Returns a string representation of 'status'. The caller must not modify or * free the returned string. * * The return value is probably useful only for debug log messages and unit * tests. */ const char * ovsdb_idl_txn_status_to_string(enum ovsdb_idl_txn_status status) { switch (status) { case TXN_UNCOMMITTED: return "uncommitted"; case TXN_UNCHANGED: return "unchanged"; case TXN_INCOMPLETE: return "incomplete"; case TXN_ABORTED: return "aborted"; case TXN_SUCCESS: return "success"; case TXN_TRY_AGAIN: return "try again"; case TXN_NOT_LOCKED: return "not locked"; case TXN_ERROR: return "error"; } return ""; } /* Starts a new transaction on 'idl'. A given ovsdb_idl may only have a single * active transaction at a time. See the large comment in ovsdb-idl.h for * general information on transactions. */ struct ovsdb_idl_txn * ovsdb_idl_txn_create(struct ovsdb_idl *idl) { struct ovsdb_idl_txn *txn; ovs_assert(!idl->txn); idl->txn = txn = xmalloc(sizeof *txn); txn->request_id = NULL; txn->idl = idl; hmap_init(&txn->txn_rows); txn->status = TXN_UNCOMMITTED; txn->error = NULL; txn->dry_run = false; ds_init(&txn->comment); txn->inc_table = NULL; txn->inc_column = NULL; hmap_init(&txn->inserted_rows); return txn; } /* Appends 's', which is treated as a printf()-type format string, to the * comments that will be passed to the OVSDB server when 'txn' is committed. * (The comment will be committed to the OVSDB log, which "ovsdb-tool * show-log" can print in a relatively human-readable form.) */ void ovsdb_idl_txn_add_comment(struct ovsdb_idl_txn *txn, const char *s, ...) { va_list args; if (txn->comment.length) { ds_put_char(&txn->comment, '\n'); } va_start(args, s); ds_put_format_valist(&txn->comment, s, args); va_end(args); } /* Marks 'txn' as a transaction that will not actually modify the database. In * almost every way, the transaction is treated like other transactions. It * must be committed or aborted like other transactions, it will be sent to the * database server like other transactions, and so on. The only difference is * that the operations sent to the database server will include, as the last * step, an "abort" operation, so that any changes made by the transaction will * not actually take effect. */ void ovsdb_idl_txn_set_dry_run(struct ovsdb_idl_txn *txn) { txn->dry_run = true; } /* Causes 'txn', when committed, to increment the value of 'column' within * 'row' by 1. 'column' must have an integer type. After 'txn' commits * successfully, the client may retrieve the final (incremented) value of * 'column' with ovsdb_idl_txn_get_increment_new_value(). * * If at time of commit the transaction is otherwise empty, that is, it doesn't * change the database, then 'force' is important. If 'force' is false in this * case, the IDL suppresses the increment and skips a round trip to the * database server. If 'force' is true, the IDL will still increment the * column. * * The client could accomplish something similar with ovsdb_idl_read(), * ovsdb_idl_txn_verify() and ovsdb_idl_txn_write(), or with ovsdb-idlc * generated wrappers for these functions. However, ovsdb_idl_txn_increment() * will never (by itself) fail because of a verify error. * * The intended use is for incrementing the "next_cfg" column in the * Open_vSwitch table. */ void ovsdb_idl_txn_increment(struct ovsdb_idl_txn *txn, const struct ovsdb_idl_row *row, const struct ovsdb_idl_column *column, bool force) { ovs_assert(!txn->inc_table); ovs_assert(column->type.key.type == OVSDB_TYPE_INTEGER); ovs_assert(column->type.value.type == OVSDB_TYPE_VOID); txn->inc_table = row->table->class_->name; txn->inc_column = column->name; txn->inc_row = row->uuid; txn->inc_force = force; } /* Destroys 'txn' and frees all associated memory. If ovsdb_idl_txn_commit() * has been called for 'txn' but the commit is still incomplete (that is, the * last call returned TXN_INCOMPLETE) then the transaction may or may not still * end up committing at the database server, but the client will not be able to * get any further status information back. */ void ovsdb_idl_txn_destroy(struct ovsdb_idl_txn *txn) { struct ovsdb_idl_txn_insert *insert; if (txn->status == TXN_INCOMPLETE) { ovsdb_cs_forget_transaction(txn->idl->cs, txn->request_id); hmap_remove(&txn->idl->outstanding_txns, &txn->hmap_node); } json_destroy(txn->request_id); ovsdb_idl_txn_abort(txn); ds_destroy(&txn->comment); free(txn->error); HMAP_FOR_EACH_SAFE (insert, hmap_node, &txn->inserted_rows) { free(insert); } hmap_destroy(&txn->inserted_rows); free(txn); } /* Causes poll_block() to wake up if 'txn' has completed committing. */ void ovsdb_idl_txn_wait(const struct ovsdb_idl_txn *txn) { if (txn->status != TXN_UNCOMMITTED && txn->status != TXN_INCOMPLETE) { poll_immediate_wake(); } } static struct json * where_uuid_equals(const struct uuid *uuid) { return json_array_create_1( json_array_create_3( json_string_create("_uuid"), json_string_create("=="), json_array_create_2( json_string_create("uuid"), json_string_create_nocopy( xasprintf(UUID_FMT, UUID_ARGS(uuid)))))); } static const struct ovsdb_idl_row * ovsdb_idl_txn_get_row(const struct ovsdb_idl_txn *txn, const struct uuid *uuid) { const struct ovsdb_idl_row *row; HMAP_FOR_EACH_WITH_HASH (row, txn_node, uuid_hash(uuid), &txn->txn_rows) { if (uuid_equals(&row->uuid, uuid)) { return row; } } return NULL; } /* XXX there must be a cleaner way to do this */ static struct json * substitute_uuids(struct json *json, const struct ovsdb_idl_txn *txn) { if (json->type == JSON_ARRAY) { struct uuid uuid; size_t i; if (json->array.n == 2 && json->array.elems[0]->type == JSON_STRING && json->array.elems[1]->type == JSON_STRING && !strcmp(json->array.elems[0]->string, "uuid") && uuid_from_string(&uuid, json->array.elems[1]->string)) { const struct ovsdb_idl_row *row; row = ovsdb_idl_txn_get_row(txn, &uuid); if (row && !row->old_datum && row->new_datum) { if (row->persist_uuid) { return json; } else { json_destroy(json); return json_array_create_2( json_string_create("named-uuid"), json_string_create_nocopy(ovsdb_data_row_name(&uuid))); } } } for (i = 0; i < json->array.n; i++) { json->array.elems[i] = substitute_uuids(json->array.elems[i], txn); } } else if (json->type == JSON_OBJECT) { struct shash_node *node; SHASH_FOR_EACH (node, json_object(json)) { node->data = substitute_uuids(node->data, txn); } } return json; } static void ovsdb_idl_txn_disassemble(struct ovsdb_idl_txn *txn) { struct ovsdb_idl_row *row; /* This must happen early. Otherwise, ovsdb_idl_row_parse() will call an * ovsdb_idl_column's 'parse' function, which will call * ovsdb_idl_get_row_arc(), which will seen that the IDL is in a * transaction and fail to update the graph. */ txn->idl->txn = NULL; HMAP_FOR_EACH_SAFE (row, txn_node, &txn->txn_rows) { enum { INSERTED, MODIFIED, DELETED } op = (!row->new_datum ? DELETED : !row->old_datum ? INSERTED : MODIFIED); if (op != DELETED) { ovsdb_idl_remove_from_indexes(row); } ovsdb_idl_destroy_all_map_op_lists(row); ovsdb_idl_destroy_all_set_op_lists(row); if (op != INSERTED) { if (row->written) { ovsdb_idl_row_unparse(row); ovsdb_idl_row_clear_arcs(row, false); ovsdb_idl_row_parse(row); } } else { ovsdb_idl_row_unparse(row); } ovsdb_idl_row_clear_new(row); free(row->prereqs); row->prereqs = NULL; free(row->written); row->written = NULL; hmap_remove(&txn->txn_rows, &row->txn_node); hmap_node_nullify(&row->txn_node); if (op != INSERTED) { ovsdb_idl_add_to_indexes(row); } else { hmap_remove(&row->table->rows, &row->hmap_node); free(row); } } hmap_destroy(&txn->txn_rows); hmap_init(&txn->txn_rows); } static bool ovsdb_idl_txn_extract_mutations(struct ovsdb_idl_row *row, struct json *mutations) { const struct ovsdb_idl_table_class *class = row->table->class_; size_t idx; bool any_mutations = false; if (row->map_op_written) { BITMAP_FOR_EACH_1(idx, class->n_columns, row->map_op_written) { struct map_op_list *map_op_list; const struct ovsdb_idl_column *column; const struct ovsdb_datum *old_datum; enum ovsdb_atomic_type key_type, value_type; struct json *mutation, *map, *col_name, *mutator; struct json *del_set, *ins_map; bool any_del, any_ins; map_op_list = row->map_op_lists[idx]; column = &class->columns[idx]; key_type = column->type.key.type; value_type = column->type.value.type; /* Get the value to be changed */ if (row->new_datum && row->written && bitmap_is_set(row->written,idx)) { old_datum = &row->new_datum[idx]; } else if (row->old_datum != NULL) { old_datum = &row->old_datum[idx]; } else { old_datum = ovsdb_datum_default(&column->type); } del_set = json_array_create_empty(); ins_map = json_array_create_empty(); any_del = false; any_ins = false; for (struct map_op *map_op = map_op_list_first(map_op_list); map_op; map_op = map_op_list_next(map_op_list, map_op)) { if (map_op_type(map_op) == MAP_OP_UPDATE) { /* Find out if value really changed. */ struct ovsdb_datum *new_datum; unsigned int pos; new_datum = map_op_datum(map_op); ovsdb_datum_find_key(old_datum, &new_datum->keys[0], key_type, &pos); if (ovsdb_atom_equals(&new_datum->values[0], &old_datum->values[pos], value_type)) { /* No change in value. Move on to next update. */ continue; } } else if (map_op_type(map_op) == MAP_OP_DELETE){ /* Verify that there is a key to delete. */ if (!ovsdb_datum_find_key(old_datum, &map_op_datum(map_op)->keys[0], key_type, NULL)) { /* No key to delete. Move on to next update. */ VLOG_WARN("Trying to delete a key that doesn't " "exist in the map."); continue; } } if (map_op_type(map_op) == MAP_OP_INSERT) { map = json_array_create_2( ovsdb_atom_to_json(&map_op_datum(map_op)->keys[0], key_type), ovsdb_atom_to_json(&map_op_datum(map_op)->values[0], value_type)); json_array_add(ins_map, map); any_ins = true; } else { /* MAP_OP_UPDATE or MAP_OP_DELETE */ map = ovsdb_atom_to_json(&map_op_datum(map_op)->keys[0], key_type); json_array_add(del_set, map); any_del = true; } /* Generate an additional insert mutate for updates. */ if (map_op_type(map_op) == MAP_OP_UPDATE) { map = json_array_create_2( ovsdb_atom_to_json(&map_op_datum(map_op)->keys[0], key_type), ovsdb_atom_to_json(&map_op_datum(map_op)->values[0], value_type)); json_array_add(ins_map, map); any_ins = true; } } if (any_del) { col_name = json_string_create(column->name); mutator = json_string_create("delete"); map = json_array_create_2(json_string_create("set"), del_set); mutation = json_array_create_3(col_name, mutator, map); json_array_add(mutations, mutation); any_mutations = true; } else { json_destroy(del_set); } if (any_ins) { col_name = json_string_create(column->name); mutator = json_string_create("insert"); map = json_array_create_2(json_string_create("map"), ins_map); mutation = json_array_create_3(col_name, mutator, map); json_array_add(mutations, mutation); any_mutations = true; } else { json_destroy(ins_map); } } } if (row->set_op_written) { BITMAP_FOR_EACH_1(idx, class->n_columns, row->set_op_written) { struct set_op_list *set_op_list; const struct ovsdb_idl_column *column; const struct ovsdb_datum *old_datum; enum ovsdb_atomic_type key_type; struct json *mutation, *set, *col_name, *mutator; struct json *del_set, *ins_set; bool any_del, any_ins; set_op_list = row->set_op_lists[idx]; column = &class->columns[idx]; key_type = column->type.key.type; /* Get the value to be changed */ if (row->new_datum && row->written && bitmap_is_set(row->written,idx)) { old_datum = &row->new_datum[idx]; } else if (row->old_datum != NULL) { old_datum = &row->old_datum[idx]; } else { old_datum = ovsdb_datum_default(&column->type); } del_set = json_array_create_empty(); ins_set = json_array_create_empty(); any_del = false; any_ins = false; for (struct set_op *set_op = set_op_list_first(set_op_list); set_op; set_op = set_op_list_next(set_op_list, set_op)) { if (set_op_type(set_op) == SET_OP_INSERT) { set = ovsdb_atom_to_json(&set_op_datum(set_op)->keys[0], key_type); json_array_add(ins_set, set); any_ins = true; } else { /* SETP_OP_DELETE */ /* Verify that there is a key to delete. */ if (!ovsdb_datum_find_key(old_datum, &set_op_datum(set_op)->keys[0], key_type, NULL)) { /* No key to delete. Move on to next update. */ VLOG_WARN("Trying to delete a key that doesn't " "exist in the set."); continue; } set = ovsdb_atom_to_json(&set_op_datum(set_op)->keys[0], key_type); json_array_add(del_set, set); any_del = true; } } if (any_del) { col_name = json_string_create(column->name); mutator = json_string_create("delete"); set = json_array_create_2(json_string_create("set"), del_set); mutation = json_array_create_3(col_name, mutator, set); json_array_add(mutations, mutation); any_mutations = true; } else { json_destroy(del_set); } if (any_ins) { col_name = json_string_create(column->name); mutator = json_string_create("insert"); set = json_array_create_2(json_string_create("set"), ins_set); mutation = json_array_create_3(col_name, mutator, set); json_array_add(mutations, mutation); any_mutations = true; } else { json_destroy(ins_set); } } } return any_mutations; } /* Attempts to commit 'txn'. Returns the status of the commit operation, one * of the following TXN_* constants: * * TXN_INCOMPLETE: * * The transaction is in progress, but not yet complete. The caller * should call again later, after calling ovsdb_idl_run() to let the IDL * do OVSDB protocol processing. * * TXN_UNCHANGED: * * The transaction is complete. (It didn't actually change the database, * so the IDL didn't send any request to the database server.) * * TXN_ABORTED: * * The caller previously called ovsdb_idl_txn_abort(). * * TXN_SUCCESS: * * The transaction was successful. The update made by the transaction * (and possibly other changes made by other database clients) should * already be visible in the IDL. * * TXN_TRY_AGAIN: * * The transaction failed for some transient reason, e.g. because a * "verify" operation reported an inconsistency or due to a network * problem. The caller should wait for a change to the database, then * compose a new transaction, and commit the new transaction. * * Use the return value of ovsdb_idl_get_seqno() to wait for a change in * the database. It is important to use its return value *before* the * initial call to ovsdb_idl_txn_commit() as the baseline for this * purpose, because the change that one should wait for can happen after * the initial call but before the call that returns TXN_TRY_AGAIN, and * using some other baseline value in that situation could cause an * indefinite wait if the database rarely changes. * * TXN_NOT_LOCKED: * * The transaction failed because the IDL has been configured to require * a database lock (with ovsdb_idl_set_lock()) but didn't get it yet or * has already lost it. * * Committing a transaction rolls back all of the changes that it made to the * IDL's copy of the database. If the transaction commits successfully, then * the database server will send an update and, thus, the IDL will be updated * with the committed changes. */ enum ovsdb_idl_txn_status ovsdb_idl_txn_commit(struct ovsdb_idl_txn *txn) { struct ovsdb_idl *idl = txn->idl; if (txn != idl->txn) { goto coverage_out; } else if (!ovsdb_cs_may_send_transaction(idl->cs)) { txn->status = TXN_TRY_AGAIN; goto disassemble_out; } else if (ovsdb_cs_get_lock(idl->cs) && !ovsdb_cs_has_lock(idl->cs)) { txn->status = TXN_NOT_LOCKED; goto disassemble_out; } struct json *operations = json_array_create_1( json_string_create(idl->class_->database)); /* Add prerequisites and declarations of new rows. */ struct ovsdb_idl_row *row; HMAP_FOR_EACH (row, txn_node, &txn->txn_rows) { /* XXX check that deleted rows exist even if no prereqs? */ if (row->prereqs) { const struct ovsdb_idl_table_class *class = row->table->class_; size_t n_columns = class->n_columns; struct json *op, *columns, *row_json; size_t idx; op = json_object_create(); json_array_add(operations, op); json_object_put_string(op, "op", "wait"); json_object_put_string(op, "table", class->name); json_object_put(op, "timeout", json_integer_create(0)); json_object_put(op, "where", where_uuid_equals(&row->uuid)); json_object_put_string(op, "until", "=="); columns = json_array_create_empty(); json_object_put(op, "columns", columns); row_json = json_object_create(); json_object_put(op, "rows", json_array_create_1(row_json)); BITMAP_FOR_EACH_1 (idx, n_columns, row->prereqs) { const struct ovsdb_idl_column *column = &class->columns[idx]; json_array_add(columns, json_string_create(column->name)); json_object_put(row_json, column->name, ovsdb_datum_to_json(&row->old_datum[idx], &column->type)); } } } /* Add updates. */ bool any_updates = false; /* For tables constrained to have only a single row (a fairly common OVSDB * pattern for storing global data), identify whether we're inserting a * row. If so, then verify that the table is empty before inserting the * row. This gives us a clear verification-related failure if there was an * insertion race with another client. */ for (size_t i = 0; i < idl->class_->n_tables; i++) { struct ovsdb_idl_table *table = &idl->tables[i]; if (table->class_->is_singleton) { /* Count the number of rows in the table before and after our * transaction commits. This is O(n) in the number of rows in the * table, but that's OK since we know that the table should only * have one row. */ size_t initial_rows = 0; size_t final_rows = 0; HMAP_FOR_EACH (row, hmap_node, &table->rows) { initial_rows += row->old_datum != NULL; final_rows += row->new_datum != NULL; } if (initial_rows == 0 && final_rows == 1) { struct json *op = json_object_create(); json_array_add(operations, op); json_object_put_string(op, "op", "wait"); json_object_put_string(op, "table", table->class_->name); json_object_put(op, "where", json_array_create_empty()); json_object_put(op, "timeout", json_integer_create(0)); json_object_put_string(op, "until", "=="); json_object_put(op, "rows", json_array_create_empty()); } } } HMAP_FOR_EACH (row, txn_node, &txn->txn_rows) { const struct ovsdb_idl_table_class *class = row->table->class_; if (!row->new_datum) { if (class->is_root) { struct json *op = json_object_create(); json_object_put_string(op, "op", "delete"); json_object_put_string(op, "table", class->name); json_object_put(op, "where", where_uuid_equals(&row->uuid)); json_array_add(operations, op); any_updates = true; } else { /* Let ovsdb-server decide whether to really delete it. */ } } else if (row->old_datum != row->new_datum) { struct json *row_json; size_t idx; struct json *op = json_object_create(); json_object_put_string(op, "op", row->old_datum ? "update" : "insert"); json_object_put_string(op, "table", class->name); if (row->old_datum) { json_object_put(op, "where", where_uuid_equals(&row->uuid)); } else { struct ovsdb_idl_txn_insert *insert; any_updates = true; char *uuid_json; struct json *value; if (row->persist_uuid) { uuid_json = "uuid"; value = json_string_create_nocopy( xasprintf(UUID_FMT, UUID_ARGS(&row->uuid))); } else { uuid_json = "uuid-name"; value = json_string_create_nocopy( ovsdb_data_row_name(&row->uuid)); } json_object_put(op, uuid_json, value); insert = xmalloc(sizeof *insert); insert->dummy = row->uuid; insert->op_index = operations->array.n - 1; uuid_zero(&insert->real); hmap_insert(&txn->inserted_rows, &insert->hmap_node, uuid_hash(&insert->dummy)); } row_json = json_object_create(); json_object_put(op, "row", row_json); if (row->written) { BITMAP_FOR_EACH_1 (idx, class->n_columns, row->written) { const struct ovsdb_idl_column *column = &class->columns[idx]; if (row->old_datum || !ovsdb_datum_is_default(&row->new_datum[idx], &column->type)) { struct json *value; value = ovsdb_datum_to_json(&row->new_datum[idx], &column->type); json_object_put(row_json, column->name, substitute_uuids(value, txn)); /* If anything really changed, consider it an update. * We can't suppress not-really-changed values earlier * or transactions would become nonatomic (see the big * comment inside ovsdb_idl_txn_write()). */ if (!any_updates && row->old_datum && !ovsdb_datum_equals(&row->old_datum[idx], &row->new_datum[idx], &column->type)) { any_updates = true; } } } } if (!row->old_datum || !shash_is_empty(json_object(row_json))) { json_array_add(operations, op); } else { json_destroy(op); } } /* Add mutate operation, for partial map or partial set updates. */ if (row->map_op_written || row->set_op_written) { struct json *op, *mutations; bool any_mutations; op = json_object_create(); json_object_put_string(op, "op", "mutate"); json_object_put_string(op, "table", class->name); json_object_put(op, "where", where_uuid_equals(&row->uuid)); mutations = json_array_create_empty(); any_mutations = ovsdb_idl_txn_extract_mutations(row, mutations); json_object_put(op, "mutations", mutations); if (any_mutations) { op = substitute_uuids(op, txn); json_array_add(operations, op); any_updates = true; } else { json_destroy(op); } } } /* Add increment. */ if (txn->inc_table && (any_updates || txn->inc_force)) { any_updates = true; txn->inc_index = operations->array.n - 1; struct json *op = json_object_create(); json_object_put_string(op, "op", "mutate"); json_object_put_string(op, "table", txn->inc_table); json_object_put(op, "where", substitute_uuids(where_uuid_equals(&txn->inc_row), txn)); json_object_put(op, "mutations", json_array_create_1( json_array_create_3( json_string_create(txn->inc_column), json_string_create("+="), json_integer_create(1)))); json_array_add(operations, op); op = json_object_create(); json_object_put_string(op, "op", "select"); json_object_put_string(op, "table", txn->inc_table); json_object_put(op, "where", substitute_uuids(where_uuid_equals(&txn->inc_row), txn)); json_object_put(op, "columns", json_array_create_1(json_string_create( txn->inc_column))); json_array_add(operations, op); } if (txn->comment.length) { struct json *op = json_object_create(); json_object_put_string(op, "op", "comment"); json_object_put_string(op, "comment", ds_cstr(&txn->comment)); json_array_add(operations, op); } if (txn->dry_run) { struct json *op = json_object_create(); json_object_put_string(op, "op", "abort"); json_array_add(operations, op); } if (!any_updates) { txn->status = TXN_UNCHANGED; json_destroy(operations); } else { txn->request_id = ovsdb_cs_send_transaction(idl->cs, operations); if (txn->request_id) { hmap_insert(&idl->outstanding_txns, &txn->hmap_node, json_hash(txn->request_id, 0)); txn->status = TXN_INCOMPLETE; } else { txn->status = TXN_TRY_AGAIN; } } disassemble_out: ovsdb_idl_txn_disassemble(txn); coverage_out: switch (txn->status) { case TXN_UNCOMMITTED: COVERAGE_INC(txn_uncommitted); break; case TXN_UNCHANGED: COVERAGE_INC(txn_unchanged); break; case TXN_INCOMPLETE: COVERAGE_INC(txn_incomplete); break; case TXN_ABORTED: COVERAGE_INC(txn_aborted); break; case TXN_SUCCESS: COVERAGE_INC(txn_success); break; case TXN_TRY_AGAIN: COVERAGE_INC(txn_try_again); break; case TXN_NOT_LOCKED: COVERAGE_INC(txn_not_locked); break; case TXN_ERROR: COVERAGE_INC(txn_error); break; } return txn->status; } /* Attempts to commit 'txn', blocking until the commit either succeeds or * fails. Returns the final commit status, which may be any TXN_* value other * than TXN_INCOMPLETE. * * This function calls ovsdb_idl_run() on 'txn''s IDL, so it may cause the * return value of ovsdb_idl_get_seqno() to change. */ enum ovsdb_idl_txn_status ovsdb_idl_txn_commit_block(struct ovsdb_idl_txn *txn) { enum ovsdb_idl_txn_status status; fatal_signal_run(); while ((status = ovsdb_idl_txn_commit(txn)) == TXN_INCOMPLETE) { ovsdb_idl_run(txn->idl); ovsdb_idl_wait(txn->idl); ovsdb_idl_txn_wait(txn); poll_block(); } return status; } /* Returns the final (incremented) value of the column in 'txn' that was set to * be incremented by ovsdb_idl_txn_increment(). 'txn' must have committed * successfully. */ int64_t ovsdb_idl_txn_get_increment_new_value(const struct ovsdb_idl_txn *txn) { ovs_assert(txn->status == TXN_SUCCESS); return txn->inc_new_value; } /* Aborts 'txn' without sending it to the database server. This is effective * only if ovsdb_idl_txn_commit() has not yet been called for 'txn'. * Otherwise, it has no effect. * * Aborting a transaction doesn't free its memory. Use * ovsdb_idl_txn_destroy() to do that. */ void ovsdb_idl_txn_abort(struct ovsdb_idl_txn *txn) { ovsdb_idl_txn_disassemble(txn); if (txn->status == TXN_UNCOMMITTED || txn->status == TXN_INCOMPLETE) { txn->status = TXN_ABORTED; } } /* Returns a string that reports the error status for 'txn'. The caller must * not modify or free the returned string. A call to ovsdb_idl_txn_destroy() * for 'txn' may free the returned string. * * The return value is ordinarily one of the strings that * ovsdb_idl_txn_status_to_string() would return, but if the transaction failed * due to an error reported by the database server, the return value is that * error. */ const char * ovsdb_idl_txn_get_error(const struct ovsdb_idl_txn *txn) { if (txn->status != TXN_ERROR) { return ovsdb_idl_txn_status_to_string(txn->status); } else if (txn->error) { return txn->error; } else { return "no error details available"; } } static void ovsdb_idl_txn_set_error_json(struct ovsdb_idl_txn *txn, const struct json *json) { if (json && txn->error == NULL) { txn->error = json_to_string(json, JSSF_SORT); } } /* For transaction 'txn' that completed successfully, finds and returns the * permanent UUID that the database assigned to a newly inserted row, given the * 'uuid' that ovsdb_idl_txn_insert() assigned locally to that row. * * Returns NULL if 'uuid' is not a UUID assigned by ovsdb_idl_txn_insert() or * if it was assigned by that function and then deleted by * ovsdb_idl_txn_delete() within the same transaction. (Rows that are inserted * and then deleted within a single transaction are never sent to the database * server, so it never assigns them a permanent UUID.) */ const struct uuid * ovsdb_idl_txn_get_insert_uuid(const struct ovsdb_idl_txn *txn, const struct uuid *uuid) { const struct ovsdb_idl_txn_insert *insert; ovs_assert(txn->status == TXN_SUCCESS || txn->status == TXN_UNCHANGED); HMAP_FOR_EACH_IN_BUCKET (insert, hmap_node, uuid_hash(uuid), &txn->inserted_rows) { if (uuid_equals(uuid, &insert->dummy)) { return &insert->real; } } return NULL; } static void ovsdb_idl_txn_complete(struct ovsdb_idl_txn *txn, enum ovsdb_idl_txn_status status) { txn->status = status; hmap_remove(&txn->idl->outstanding_txns, &txn->hmap_node); } static void ovsdb_idl_txn_write__(const struct ovsdb_idl_row *row_, const struct ovsdb_idl_column *column, struct ovsdb_datum *datum, bool owns_datum) { struct ovsdb_idl_row *row = CONST_CAST(struct ovsdb_idl_row *, row_); const struct ovsdb_idl_table_class *class; unsigned char column_mode; bool optimize_rewritten; size_t column_idx; bool write_only; ovs_assert(!column->is_synthetic); if (ovsdb_idl_row_is_synthetic(row)) { goto discard_datum; } class = row->table->class_; column_idx = column - class->columns; column_mode = row->table->modes[column_idx]; write_only = column_mode == OVSDB_IDL_MONITOR; optimize_rewritten = write_only || (column_mode & OVSDB_IDL_WRITE_CHANGED_ONLY); ovs_assert(row->new_datum != NULL); ovs_assert(column_idx < class->n_columns); ovs_assert(row->old_datum == NULL || column_mode & OVSDB_IDL_MONITOR); if (row->table->idl->verify_write_only && !write_only) { VLOG_ERR("Bug: Attempt to write to a read/write column (%s:%s) when" " explicitly configured not to.", class->name, column->name); goto discard_datum; } /* If this is a write-only column and the datum being written is the same * as the one already there, just skip the update entirely. This is worth * optimizing because we have a lot of columns that get periodically * refreshed into the database but don't actually change that often. * * We don't do this for read/write columns because that would break * atomicity of transactions--some other client might have written a * different value in that column since we read it. (But if a whole * transaction only does writes of existing values, without making any real * changes, we will drop the whole transaction later in * ovsdb_idl_txn_commit().) * * The application may choose to bypass this restriction and always * optimize by setting OVSDB_IDL_WRITE_CHANGED_ONLY. */ if (optimize_rewritten && ovsdb_datum_equals(ovsdb_idl_read(row, column), datum, &column->type)) { goto discard_datum; } bool index_row = is_index_row(row); if (!index_row) { ovsdb_idl_remove_from_indexes(row); } if (hmap_node_is_null(&row->txn_node)) { hmap_insert(&row->table->idl->txn->txn_rows, &row->txn_node, uuid_hash(&row->uuid)); } if (row->old_datum == row->new_datum) { row->new_datum = xmalloc(class->n_columns * sizeof *row->new_datum); } if (!row->written) { row->written = bitmap_allocate(class->n_columns); } if (bitmap_is_set(row->written, column_idx)) { ovsdb_datum_destroy(&row->new_datum[column_idx], &column->type); } else { bitmap_set1(row->written, column_idx); } if (owns_datum) { row->new_datum[column_idx] = *datum; } else { ovsdb_datum_clone(&row->new_datum[column_idx], datum); } (column->unparse)(row); (column->parse)(row, &row->new_datum[column_idx]); row->parsed = true; if (!index_row) { ovsdb_idl_add_to_indexes(row); } return; discard_datum: if (owns_datum) { ovsdb_datum_destroy(datum, &column->type); } } /* Writes 'datum' to the specified 'column' in 'row_'. Updates both 'row_' * itself and the structs derived from it (e.g. the "struct ovsrec_*", for * ovs-vswitchd). * * 'datum' must have the correct type for its column, but it needs not be * sorted or unique because this function will take care of that. The IDL does * not check that it meets schema constraints, but ovsdb-server will do so at * commit time so it had better be correct. * * A transaction must be in progress. Replication of 'column' must not have * been disabled (by calling ovsdb_idl_omit()). * * Usually this function is used indirectly through one of the "set" functions * generated by ovsdb-idlc. * * Takes ownership of what 'datum' points to (and in some cases destroys that * data before returning) but makes a copy of 'datum' itself. (Commonly * 'datum' is on the caller's stack.) */ void ovsdb_idl_txn_write(const struct ovsdb_idl_row *row, const struct ovsdb_idl_column *column, struct ovsdb_datum *datum) { ovsdb_datum_sort_unique(datum, &column->type); ovsdb_idl_txn_write__(row, column, datum, true); } /* Similar to ovsdb_idl_txn_write(), except: * * - The caller retains ownership of 'datum' and what it points to. * * - The caller must ensure that 'datum' is sorted and unique (e.g. via * ovsdb_datum_sort_unique().) */ void ovsdb_idl_txn_write_clone(const struct ovsdb_idl_row *row, const struct ovsdb_idl_column *column, const struct ovsdb_datum *datum) { ovsdb_idl_txn_write__(row, column, CONST_CAST(struct ovsdb_datum *, datum), false); } /* Causes the original contents of 'column' in 'row_' to be verified as a * prerequisite to completing the transaction. That is, if 'column' in 'row_' * changed (or if 'row_' was deleted) between the time that the IDL originally * read its contents and the time that the transaction commits, then the * transaction aborts and ovsdb_idl_txn_commit() returns TXN_TRY_AGAIN. * * The intention is that, to ensure that no transaction commits based on dirty * reads, an application should call ovsdb_idl_txn_verify() on each data item * read as part of a read-modify-write operation. * * In some cases ovsdb_idl_txn_verify() reduces to a no-op, because the current * value of 'column' is already known: * * - If 'row_' is a row created by the current transaction (returned by * ovsdb_idl_txn_insert()). * * - If 'column' has already been modified (with ovsdb_idl_txn_write()) * within the current transaction. * * Because of the latter property, always call ovsdb_idl_txn_verify() *before* * ovsdb_idl_txn_write() for a given read-modify-write. * * A transaction must be in progress. * * Usually this function is used indirectly through one of the "verify" * functions generated by ovsdb-idlc. */ void ovsdb_idl_txn_verify(const struct ovsdb_idl_row *row_, const struct ovsdb_idl_column *column) { struct ovsdb_idl_row *row = CONST_CAST(struct ovsdb_idl_row *, row_); const struct ovsdb_idl_table_class *class; size_t column_idx; if (ovsdb_idl_row_is_synthetic(row)) { return; } class = row->table->class_; column_idx = column - class->columns; ovs_assert(row->new_datum != NULL); ovs_assert(row->old_datum == NULL || row->table->modes[column_idx] & OVSDB_IDL_MONITOR); if (!row->old_datum || (row->written && bitmap_is_set(row->written, column_idx))) { return; } if (hmap_node_is_null(&row->txn_node)) { hmap_insert(&row->table->idl->txn->txn_rows, &row->txn_node, uuid_hash(&row->uuid)); } if (!row->prereqs) { row->prereqs = bitmap_allocate(class->n_columns); } bitmap_set1(row->prereqs, column_idx); } /* Deletes 'row_' from its table. May free 'row_', so it must not be * accessed afterward. * * A transaction must be in progress. * * Usually this function is used indirectly through one of the "delete" * functions generated by ovsdb-idlc. */ void ovsdb_idl_txn_delete(const struct ovsdb_idl_row *row_) { struct ovsdb_idl_row *row = CONST_CAST(struct ovsdb_idl_row *, row_); if (ovsdb_idl_row_is_synthetic(row)) { return; } ovs_assert(row->new_datum != NULL); ovs_assert(!is_index_row(row_)); ovsdb_idl_remove_from_indexes(row_); if (!row->old_datum) { ovsdb_idl_row_unparse(row); ovsdb_idl_row_clear_new(row); ovs_assert(!row->prereqs); hmap_remove(&row->table->rows, &row->hmap_node); hmap_remove(&row->table->idl->txn->txn_rows, &row->txn_node); free(row); return; } if (hmap_node_is_null(&row->txn_node)) { hmap_insert(&row->table->idl->txn->txn_rows, &row->txn_node, uuid_hash(&row->uuid)); } ovsdb_idl_row_clear_new(row); row->new_datum = NULL; } static const struct ovsdb_idl_row * ovsdb_idl_txn_insert__(struct ovsdb_idl_txn *txn, const struct ovsdb_idl_table_class *class, const struct uuid *uuid, bool persist_uuid) { struct ovsdb_idl_row *row = ovsdb_idl_row_create__(class); ovs_assert(uuid || !persist_uuid); if (uuid) { ovs_assert(!ovsdb_idl_txn_get_row(txn, uuid)); row->uuid = *uuid; } else { uuid_generate(&row->uuid); } row->persist_uuid = persist_uuid; row->table = ovsdb_idl_table_from_class(txn->idl, class); row->new_datum = xmalloc(class->n_columns * sizeof *row->new_datum); hmap_insert(&row->table->rows, &row->hmap_node, uuid_hash(&row->uuid)); hmap_insert(&txn->txn_rows, &row->txn_node, uuid_hash(&row->uuid)); ovsdb_idl_add_to_indexes(row); return row; } /* Inserts and returns a new row in the table with the specified 'class' in the * database with open transaction 'txn'. * * The new row is assigned a provisional UUID. If 'uuid' is null then one is * randomly generated; otherwise 'uuid' should specify a randomly generated * UUID not otherwise in use. ovsdb-server will assign a different UUID when * 'txn' is committed, but the IDL will replace any uses of the provisional * UUID in the data to be to be committed by the UUID assigned by * ovsdb-server. * * Usually this function is used indirectly through one of the "insert" * functions generated by ovsdb-idlc. */ const struct ovsdb_idl_row * ovsdb_idl_txn_insert(struct ovsdb_idl_txn *txn, const struct ovsdb_idl_table_class *class, const struct uuid *uuid) { return ovsdb_idl_txn_insert__(txn, class, uuid, false); } /* Inserts and returns a new row in the table with the specified 'class' in the * database with open transaction 'txn'. * * The new row is assigned the specified UUID (which cannot be null). * * Usually this function is used indirectly through one of the * "insert_persist_uuid" functions generated by ovsdb-idlc. */ const struct ovsdb_idl_row * ovsdb_idl_txn_insert_persist_uuid(struct ovsdb_idl_txn *txn, const struct ovsdb_idl_table_class *class, const struct uuid *uuid) { ovs_assert(uuid); return ovsdb_idl_txn_insert__(txn, class, uuid, true); } static void ovsdb_idl_txn_abort_all(struct ovsdb_idl *idl) { struct ovsdb_idl_txn *txn; HMAP_FOR_EACH (txn, hmap_node, &idl->outstanding_txns) { ovsdb_idl_txn_complete(txn, TXN_TRY_AGAIN); } } static struct ovsdb_idl_txn * ovsdb_idl_txn_find(struct ovsdb_idl *idl, const struct json *id) { struct ovsdb_idl_txn *txn; HMAP_FOR_EACH_WITH_HASH (txn, hmap_node, json_hash(id, 0), &idl->outstanding_txns) { if (json_equal(id, txn->request_id)) { return txn; } } return NULL; } static bool check_json_type(const struct json *json, enum json_type type, const char *name) { if (!json) { VLOG_WARN_RL(&syntax_rl, "%s is missing", name); return false; } else if (json->type != type) { VLOG_WARN_RL(&syntax_rl, "%s is %s instead of %s", name, json_type_to_string(json->type), json_type_to_string(type)); return false; } else { return true; } } static bool ovsdb_idl_txn_process_inc_reply(struct ovsdb_idl_txn *txn, const struct json_array *results) { struct json *count, *rows, *row, *column; struct shash *mutate, *select; if (txn->inc_index + 2 > results->n) { VLOG_WARN_RL(&syntax_rl, "reply does not contain enough operations " "for increment (has %"PRIuSIZE", needs %u)", results->n, txn->inc_index + 2); return false; } /* We know that this is a JSON object because the loop in * ovsdb_idl_txn_process_reply() checked. */ mutate = json_object(results->elems[txn->inc_index]); count = shash_find_data(mutate, "count"); if (!check_json_type(count, JSON_INTEGER, "\"mutate\" reply \"count\"")) { return false; } if (count->integer != 1) { VLOG_WARN_RL(&syntax_rl, "\"mutate\" reply \"count\" is %lld instead of 1", count->integer); return false; } select = json_object(results->elems[txn->inc_index + 1]); rows = shash_find_data(select, "rows"); if (!check_json_type(rows, JSON_ARRAY, "\"select\" reply \"rows\"")) { return false; } if (rows->array.n != 1) { VLOG_WARN_RL(&syntax_rl, "\"select\" reply \"rows\" has %"PRIuSIZE" elements " "instead of 1", rows->array.n); return false; } row = rows->array.elems[0]; if (!check_json_type(row, JSON_OBJECT, "\"select\" reply row")) { return false; } column = shash_find_data(json_object(row), txn->inc_column); if (!check_json_type(column, JSON_INTEGER, "\"select\" reply inc column")) { return false; } txn->inc_new_value = column->integer; return true; } static bool ovsdb_idl_txn_process_insert_reply(struct ovsdb_idl_txn_insert *insert, const struct json_array *results) { static const struct ovsdb_base_type uuid_type = OVSDB_BASE_UUID_INIT; struct ovsdb_error *error; struct json *json_uuid; union ovsdb_atom uuid; struct shash *reply; if (insert->op_index >= results->n) { VLOG_WARN_RL(&syntax_rl, "reply does not contain enough operations " "for insert (has %"PRIuSIZE", needs %u)", results->n, insert->op_index); return false; } /* We know that this is a JSON object because the loop in * ovsdb_idl_txn_process_reply() checked. */ reply = json_object(results->elems[insert->op_index]); json_uuid = shash_find_data(reply, "uuid"); if (!check_json_type(json_uuid, JSON_ARRAY, "\"insert\" reply \"uuid\"")) { return false; } error = ovsdb_atom_from_json(&uuid, &uuid_type, json_uuid, NULL); if (error) { char *s = ovsdb_error_to_string_free(error); VLOG_WARN_RL(&syntax_rl, "\"insert\" reply \"uuid\" is not a JSON " "UUID: %s", s); free(s); return false; } insert->real = uuid.uuid; return true; } static void ovsdb_idl_txn_process_reply(struct ovsdb_idl *idl, const struct jsonrpc_msg *msg) { struct ovsdb_idl_txn *txn = ovsdb_idl_txn_find(idl, msg->id); if (!txn) { return; } enum ovsdb_idl_txn_status status; if (msg->type == JSONRPC_ERROR) { if (msg->error && msg->error->type == JSON_STRING && !strcmp(json_string(msg->error), "canceled")) { /* ovsdb-server uses this error message to indicate that the * transaction was canceled because the database in question was * removed, converted, etc. */ status = TXN_TRY_AGAIN; } else { status = TXN_ERROR; ovsdb_idl_txn_set_error_json(txn, msg->error); } } else if (msg->result->type != JSON_ARRAY) { VLOG_WARN_RL(&syntax_rl, "reply to \"transact\" is not JSON array"); status = TXN_ERROR; ovsdb_idl_txn_set_error_json(txn, msg->result); } else { struct json_array *ops = &msg->result->array; int hard_errors = 0; int soft_errors = 0; int lock_errors = 0; size_t i; for (i = 0; i < ops->n; i++) { struct json *op = ops->elems[i]; if (op->type == JSON_NULL) { /* This isn't an error in itself but indicates that some prior * operation failed, so make sure that we know about it. */ soft_errors++; } else if (op->type == JSON_OBJECT) { struct json *error; error = shash_find_data(json_object(op), "error"); if (error) { if (error->type == JSON_STRING) { if (!strcmp(error->string, "timed out")) { soft_errors++; } else if (!strcmp(error->string, "unknown database")) { ovsdb_cs_flag_inconsistency(idl->cs); soft_errors++; } else if (!strcmp(error->string, "not owner")) { lock_errors++; } else if (!strcmp(error->string, "not allowed")) { hard_errors++; ovsdb_idl_txn_set_error_json(txn, op); } else if (strcmp(error->string, "aborted")) { hard_errors++; ovsdb_idl_txn_set_error_json(txn, op); VLOG_WARN_RL(&other_rl, "transaction error: %s", txn->error); } } else { hard_errors++; ovsdb_idl_txn_set_error_json(txn, op); VLOG_WARN_RL(&syntax_rl, "\"error\" in reply is not JSON string"); } } } else { hard_errors++; ovsdb_idl_txn_set_error_json(txn, op); VLOG_WARN_RL(&syntax_rl, "operation reply is not JSON null or object"); } } if (!soft_errors && !hard_errors && !lock_errors) { struct ovsdb_idl_txn_insert *insert; if (txn->inc_table && !ovsdb_idl_txn_process_inc_reply(txn, ops)) { hard_errors++; } HMAP_FOR_EACH (insert, hmap_node, &txn->inserted_rows) { if (!ovsdb_idl_txn_process_insert_reply(insert, ops)) { hard_errors++; } } } status = (hard_errors ? TXN_ERROR : lock_errors ? TXN_NOT_LOCKED : soft_errors ? TXN_TRY_AGAIN : TXN_SUCCESS); } ovsdb_idl_txn_complete(txn, status); } /* Returns the transaction currently active for 'row''s IDL. A transaction * must currently be active. */ struct ovsdb_idl_txn * ovsdb_idl_txn_get(const struct ovsdb_idl_row *row) { struct ovsdb_idl_txn *txn = row->table->idl->txn; ovs_assert(txn != NULL); return txn; } /* Returns the IDL on which 'txn' acts. */ struct ovsdb_idl * ovsdb_idl_txn_get_idl (struct ovsdb_idl_txn *txn) { return txn->idl; } /* Blocks until 'idl' successfully connects to the remote database and * retrieves its contents. */ void ovsdb_idl_get_initial_snapshot(struct ovsdb_idl *idl) { while (1) { ovsdb_idl_run(idl); if (ovsdb_idl_has_ever_connected(idl)) { return; } ovsdb_idl_wait(idl); poll_block(); } } /* If 'lock_name' is nonnull, configures 'idl' to obtain the named lock from * the database server and to avoid modifying the database when the lock cannot * be acquired (that is, when another client has the same lock). * * If 'lock_name' is NULL, drops the locking requirement and releases the * lock. */ void ovsdb_idl_set_lock(struct ovsdb_idl *idl, const char *lock_name) { ovsdb_cs_set_lock(idl->cs, lock_name); } /* Returns true if 'idl' is configured to obtain a lock and owns that lock. * * Locking and unlocking happens asynchronously from the database client's * point of view, so the information is only useful for optimization (e.g. if * the client doesn't have the lock then there's no point in trying to write to * the database). */ bool ovsdb_idl_has_lock(const struct ovsdb_idl *idl) { return ovsdb_cs_has_lock(idl->cs); } /* Returns true if 'idl' is configured to obtain a lock but the database server * has indicated that some other client already owns the requested lock. */ bool ovsdb_idl_is_lock_contended(const struct ovsdb_idl *idl) { return ovsdb_cs_is_lock_contended(idl->cs); } /* Inserts a new Map Operation into current transaction. */ static void ovsdb_idl_txn_add_map_op(struct ovsdb_idl_row *row, const struct ovsdb_idl_column *column, struct ovsdb_datum *datum, enum map_op_type op_type) { const struct ovsdb_idl_table_class *class; size_t column_idx; struct map_op *map_op; class = row->table->class_; column_idx = column - class->columns; /* Check if a map operation list exists for this column. */ if (!row->map_op_written) { row->map_op_written = bitmap_allocate(class->n_columns); row->map_op_lists = xzalloc(class->n_columns * sizeof *row->map_op_lists); } if (!row->map_op_lists[column_idx]) { row->map_op_lists[column_idx] = map_op_list_create(); } /* Add a map operation to the corresponding list. */ map_op = map_op_create(datum, op_type); bitmap_set1(row->map_op_written, column_idx); map_op_list_add(row->map_op_lists[column_idx], map_op, &column->type); /* Add this row to transaction's list of rows. */ if (hmap_node_is_null(&row->txn_node)) { hmap_insert(&row->table->idl->txn->txn_rows, &row->txn_node, uuid_hash(&row->uuid)); } } /* Inserts a new Set Operation into current transaction. */ static void ovsdb_idl_txn_add_set_op(struct ovsdb_idl_row *row, const struct ovsdb_idl_column *column, struct ovsdb_datum *datum, enum set_op_type op_type) { const struct ovsdb_idl_table_class *class; size_t column_idx; struct set_op *set_op; class = row->table->class_; column_idx = column - class->columns; /* Check if a set operation list exists for this column. */ if (!row->set_op_written) { row->set_op_written = bitmap_allocate(class->n_columns); row->set_op_lists = xzalloc(class->n_columns * sizeof *row->set_op_lists); } if (!row->set_op_lists[column_idx]) { row->set_op_lists[column_idx] = set_op_list_create(); } /* Add a set operation to the corresponding list. */ set_op = set_op_create(datum, op_type); bitmap_set1(row->set_op_written, column_idx); set_op_list_add(row->set_op_lists[column_idx], set_op, &column->type); /* Add this row to the transactions's list of rows. */ if (hmap_node_is_null(&row->txn_node)) { hmap_insert(&row->table->idl->txn->txn_rows, &row->txn_node, uuid_hash(&row->uuid)); } } static bool is_valid_partial_update(const struct ovsdb_idl_row *row, const struct ovsdb_idl_column *column, struct ovsdb_datum *datum) { /* Verify that this column is being monitored. */ unsigned int column_idx = column - row->table->class_->columns; if (!(row->table->modes[column_idx] & OVSDB_IDL_MONITOR)) { VLOG_WARN("cannot partially update non-monitored column"); return false; } /* Verify that the update affects a single element. */ if (datum->n != 1) { VLOG_WARN("invalid datum for partial update"); return false; } return true; } /* Inserts the value described in 'datum' into the map in 'column' in * 'row_'. If the value doesn't already exist in 'column' then it's value * is added. The value in 'datum' must be of the same type as the values * in 'column'. This function takes ownership of 'datum'. * * Usually this function is used indirectly through one of the "update" * functions generated by vswitch-idl. */ void ovsdb_idl_txn_write_partial_set(const struct ovsdb_idl_row *row_, const struct ovsdb_idl_column *column, struct ovsdb_datum *datum) { struct ovsdb_idl_row *row = CONST_CAST(struct ovsdb_idl_row *, row_); enum set_op_type op_type; if (!is_valid_partial_update(row, column, datum)) { ovsdb_datum_destroy(datum, &column->type); free(datum); return; } op_type = SET_OP_INSERT; ovsdb_idl_txn_add_set_op(row, column, datum, op_type); } /* Deletes the value specified in 'datum' from the set in 'column' in 'row_'. * The value in 'datum' must be of the same type as the keys in 'column'. * This function takes ownership of 'datum'. * * Usually this function is used indirectly through one of the "update" * functions generated by vswitch-idl. */ void ovsdb_idl_txn_delete_partial_set(const struct ovsdb_idl_row *row_, const struct ovsdb_idl_column *column, struct ovsdb_datum *datum) { struct ovsdb_idl_row *row = CONST_CAST(struct ovsdb_idl_row *, row_); if (!is_valid_partial_update(row, column, datum)) { struct ovsdb_type type_ = column->type; type_.value.type = OVSDB_TYPE_VOID; ovsdb_datum_destroy(datum, &type_); free(datum); return; } ovsdb_idl_txn_add_set_op(row, column, datum, SET_OP_DELETE); } /* Inserts the key-value specified in 'datum' into the map in 'column' in * 'row_'. If the key already exist in 'column', then it's value is updated * with the value in 'datum'. The key-value in 'datum' must be of the same type * as the keys-values in 'column'. This function takes ownership of 'datum'. * * Usually this function is used indirectly through one of the "update" * functions generated by vswitch-idl. */ void ovsdb_idl_txn_write_partial_map(const struct ovsdb_idl_row *row_, const struct ovsdb_idl_column *column, struct ovsdb_datum *datum) { struct ovsdb_idl_row *row = CONST_CAST(struct ovsdb_idl_row *, row_); enum ovsdb_atomic_type key_type; enum map_op_type op_type; const struct ovsdb_datum *old_datum; if (!is_valid_partial_update(row, column, datum)) { ovsdb_datum_destroy(datum, &column->type); free(datum); return; } /* Find out if this is an insert or an update. */ key_type = column->type.key.type; old_datum = ovsdb_idl_read(row, column); if (ovsdb_datum_find_key(old_datum, &datum->keys[0], key_type, NULL)) { op_type = MAP_OP_UPDATE; } else { op_type = MAP_OP_INSERT; } ovsdb_idl_txn_add_map_op(row, column, datum, op_type); } /* Deletes the key specified in 'datum' from the map in 'column' in 'row_'. * The key in 'datum' must be of the same type as the keys in 'column'. * The value in 'datum' must be NULL. This function takes ownership of * 'datum'. * * Usually this function is used indirectly through one of the "update" * functions generated by vswitch-idl. */ void ovsdb_idl_txn_delete_partial_map(const struct ovsdb_idl_row *row_, const struct ovsdb_idl_column *column, struct ovsdb_datum *datum) { struct ovsdb_idl_row *row = CONST_CAST(struct ovsdb_idl_row *, row_); if (!is_valid_partial_update(row, column, datum)) { struct ovsdb_type type_ = column->type; type_.value.type = OVSDB_TYPE_VOID; ovsdb_datum_destroy(datum, &type_); free(datum); return; } ovsdb_idl_txn_add_map_op(row, column, datum, MAP_OP_DELETE); } void ovsdb_idl_loop_destroy(struct ovsdb_idl_loop *loop) { if (loop) { if (loop->committing_txn) { ovsdb_idl_txn_destroy(loop->committing_txn); } ovsdb_idl_destroy(loop->idl); } } struct ovsdb_idl_txn * ovsdb_idl_loop_run(struct ovsdb_idl_loop *loop) { ovsdb_idl_run(loop->idl); /* See if the 'committing_txn' succeeded in the meantime. */ if (loop->committing_txn && loop->committing_txn->status == TXN_SUCCESS) { ovsdb_idl_try_commit_loop_txn(loop, NULL); } loop->open_txn = (loop->committing_txn || ovsdb_idl_get_seqno(loop->idl) == loop->skip_seqno ? NULL : ovsdb_idl_txn_create(loop->idl)); if (loop->open_txn) { ovsdb_idl_txn_add_comment(loop->open_txn, "%s", program_name); } return loop->open_txn; } /* Attempts to commit the current transaction, if one is open. * * If a transaction was open, in this or a previous iteration of the main loop, * and had not before finished committing (successfully or unsuccessfully), the * return value is one of: * * 1: The transaction committed successfully (or it did not change anything in * the database). * 0: The transaction failed. * -1: The commit is still in progress. * * Thus, the return value is -1 if the transaction is in progress and otherwise * true for success, false for failure. * * (In the corner case where the IDL sends a transaction to the database and * the database commits it, and the connection between the IDL and the database * drops before the IDL receives the message confirming the commit, this * function can return 0 even though the transaction succeeded.) */ static int ovsdb_idl_try_commit_loop_txn(struct ovsdb_idl_loop *loop, bool *may_need_wakeup) { if (!loop->committing_txn) { /* Not a meaningful return value: no transaction was in progress. */ return 1; } int retval; struct ovsdb_idl_txn *txn = loop->committing_txn; enum ovsdb_idl_txn_status status = ovsdb_idl_txn_commit(txn); if (status != TXN_INCOMPLETE) { switch (status) { case TXN_TRY_AGAIN: /* We want to re-evaluate the database when it's changed from * the contents that it had when we started the commit. (That * might have already happened.) */ loop->skip_seqno = loop->precommit_seqno; if (ovsdb_idl_get_seqno(loop->idl) != loop->skip_seqno && may_need_wakeup) { *may_need_wakeup = true; } retval = 0; break; case TXN_SUCCESS: /* Possibly some work on the database was deferred because no * further transaction could proceed. Wake up again. */ retval = 1; loop->cur_cfg = loop->next_cfg; if (may_need_wakeup) { *may_need_wakeup = true; } break; case TXN_UNCHANGED: retval = 1; loop->cur_cfg = loop->next_cfg; break; case TXN_ABORTED: case TXN_NOT_LOCKED: case TXN_ERROR: retval = 0; break; case TXN_UNCOMMITTED: case TXN_INCOMPLETE: default: OVS_NOT_REACHED(); } ovsdb_idl_txn_destroy(txn); loop->committing_txn = NULL; } else { retval = -1; } return retval; } /* Attempts to commit the current transaction, if one is open, and sets up the * poll loop to wake up when some more work might be needed. * * If a transaction was open, in this or a previous iteration of the main loop, * and had not before finished committing (successfully or unsuccessfully), the * return value is one of: * * 1: The transaction committed successfully (or it did not change anything in * the database). * 0: The transaction failed. * -1: The commit is still in progress. * * Thus, the return value is -1 if the transaction is in progress and otherwise * true for success, false for failure. * * (In the corner case where the IDL sends a transaction to the database and * the database commits it, and the connection between the IDL and the database * drops before the IDL receives the message confirming the commit, this * function can return 0 even though the transaction succeeded.) */ int ovsdb_idl_loop_commit_and_wait(struct ovsdb_idl_loop *loop) { if (loop->open_txn) { loop->committing_txn = loop->open_txn; loop->open_txn = NULL; loop->precommit_seqno = ovsdb_idl_get_seqno(loop->idl); } bool may_need_wakeup = false; int retval = ovsdb_idl_try_commit_loop_txn(loop, &may_need_wakeup); if (may_need_wakeup) { poll_immediate_wake(); } ovsdb_idl_wait(loop->idl); return retval; }