X-Git-Url: http://git.cascardo.eti.br/?a=blobdiff_plain;f=lib%2Fovsdb-idl.c;h=4cb1c81a89151290b195f362a063271ccece35d1;hb=5e22917729791c66ea9f5dd74b36858fa73b1b28;hp=3eca2feb320b58a76497cfbe4bec7cf8e99a98fd;hpb=a699f6143e09b1d63ea284b7d8180c74f27dea60;p=cascardo%2Fovs.git diff --git a/lib/ovsdb-idl.c b/lib/ovsdb-idl.c index 3eca2feb3..4cb1c81a8 100644 --- a/lib/ovsdb-idl.c +++ b/lib/ovsdb-idl.c @@ -1,4 +1,4 @@ -/* Copyright (c) 2009, 2010, 2011, 2012 Nicira, Inc. +/* Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016 Nicira, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -17,27 +17,40 @@ #include "ovsdb-idl.h" -#include #include #include #include #include #include "bitmap.h" +#include "coverage.h" #include "dynamic-string.h" #include "fatal-signal.h" #include "json.h" #include "jsonrpc.h" +#include "ovsdb/ovsdb.h" +#include "ovsdb/table.h" #include "ovsdb-data.h" #include "ovsdb-error.h" #include "ovsdb-idl-provider.h" +#include "ovsdb-parser.h" #include "poll-loop.h" #include "shash.h" +#include "sset.h" #include "util.h" -#include "vlog.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). @@ -56,20 +69,33 @@ VLOG_DEFINE_THIS_MODULE(ovsdb_idl); * tables. */ struct ovsdb_idl_arc { - struct list src_node; /* In src->src_arcs list. */ - struct list dst_node; /* In dst->dst_arcs list. */ + 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. */ }; +enum ovsdb_idl_state { + IDL_S_SCHEMA_REQUESTED, + IDL_S_MONITOR_REQUESTED, + IDL_S_MONITORING, + IDL_S_MONITOR2_REQUESTED, + IDL_S_MONITORING2 +}; + struct ovsdb_idl { const struct ovsdb_idl_class *class; struct jsonrpc_session *session; struct shash table_by_name; struct ovsdb_idl_table *tables; /* Contains "struct ovsdb_idl_table *"s.*/ - struct json *monitor_request_id; - unsigned int last_monitor_request_seqno; unsigned int change_seqno; + bool verify_write_only; + + /* Session state. */ + unsigned int state_seqno; + enum ovsdb_idl_state state; + struct json *request_id; + struct json *schema; /* Database locking. */ char *lock_name; /* Name of lock we need, NULL if none. */ @@ -91,7 +117,6 @@ struct ovsdb_idl_txn { char *error; bool dry_run; struct ds comment; - unsigned int commit_seqno; /* Increments. */ const char *inc_table; @@ -111,21 +136,42 @@ struct ovsdb_idl_txn_insert { struct uuid real; /* Real UUID used by database server. */ }; +enum ovsdb_update_version { + OVSDB_UPDATE, /* RFC 7047 "update" method. */ + OVSDB_UPDATE2 /* "update2" Extension to RFC 7047. + See ovsdb-server(1) for more information. */ +}; + +/* Name arrays indexed by 'enum ovsdb_update_version'. */ +static const char *table_updates_names[] = {"table_updates", "table_updates2"}; +static const char *table_update_names[] = {"table_update", "table_update2"}; +static const char *row_update_names[] = {"row_update", "row_update2"}; + 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 void ovsdb_idl_clear(struct ovsdb_idl *); +static void ovsdb_idl_send_schema_request(struct ovsdb_idl *); static void ovsdb_idl_send_monitor_request(struct ovsdb_idl *); -static void ovsdb_idl_parse_update(struct ovsdb_idl *, const struct json *); +static void ovsdb_idl_send_monitor2_request(struct ovsdb_idl *); +static void ovsdb_idl_parse_update(struct ovsdb_idl *, const struct json *, + enum ovsdb_update_version); static struct ovsdb_error *ovsdb_idl_parse_update__(struct ovsdb_idl *, - const struct json *); + const struct json *, + enum ovsdb_update_version); static bool ovsdb_idl_process_update(struct ovsdb_idl_table *, const struct uuid *, const struct json *old, const struct json *new); +static bool ovsdb_idl_process_update2(struct ovsdb_idl_table *, + const struct uuid *, + const char *operation, + const struct json *row); static void ovsdb_idl_insert_row(struct ovsdb_idl_row *, const struct json *); static void ovsdb_idl_delete_row(struct ovsdb_idl_row *); static bool ovsdb_idl_modify_row(struct ovsdb_idl_row *, const struct json *); +static bool ovsdb_idl_modify_row_by_diff(struct ovsdb_idl_row *, + const struct json *); static bool ovsdb_idl_row_is_orphan(const struct ovsdb_idl_row *); static struct ovsdb_idl_row *ovsdb_idl_row_create__( @@ -133,11 +179,13 @@ static struct ovsdb_idl_row *ovsdb_idl_row_create__( 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_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_txn_abort_all(struct ovsdb_idl *); static bool ovsdb_idl_txn_process_reply(struct ovsdb_idl *, @@ -150,6 +198,10 @@ static void ovsdb_idl_parse_lock_reply(struct ovsdb_idl *, static void ovsdb_idl_parse_lock_notify(struct ovsdb_idl *, const struct json *params, bool new_has_lock); +static struct ovsdb_idl_table * +ovsdb_idl_table_from_class(const struct ovsdb_idl *, + const struct ovsdb_idl_table_class *); +static bool ovsdb_idl_track_is_set(struct ovsdb_idl_table *table); /* Creates and returns a connection to database 'remote', which should be in a * form acceptable to jsonrpc_session_open(). The connection will maintain an @@ -157,6 +209,9 @@ static void ovsdb_idl_parse_lock_notify(struct ovsdb_idl *, * '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 @@ -168,7 +223,7 @@ static void ovsdb_idl_parse_lock_notify(struct ovsdb_idl *, */ struct ovsdb_idl * ovsdb_idl_create(const char *remote, const struct ovsdb_idl_class *class, - bool monitor_everything_by_default) + bool monitor_everything_by_default, bool retry) { struct ovsdb_idl *idl; uint8_t default_mode; @@ -180,7 +235,7 @@ ovsdb_idl_create(const char *remote, const struct ovsdb_idl_class *class, idl = xzalloc(sizeof *idl); idl->class = class; - idl->session = jsonrpc_session_open(remote); + idl->session = jsonrpc_session_open(remote, retry); shash_init(&idl->table_by_name); idl->tables = xmalloc(class->n_tables * sizeof *idl->tables); for (i = 0; i < class->n_tables; i++) { @@ -200,9 +255,17 @@ ovsdb_idl_create(const char *remote, const struct ovsdb_idl_class *class, shash_add_assert(&table->columns, column->name, column); } hmap_init(&table->rows); + 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; } - idl->last_monitor_request_seqno = UINT_MAX; + + idl->state_seqno = UINT_MAX; + idl->request_id = NULL; + idl->schema = NULL; + hmap_init(&idl->outstanding_txns); return idl; @@ -215,7 +278,7 @@ ovsdb_idl_destroy(struct ovsdb_idl *idl) if (idl) { size_t i; - assert(!idl->txn); + ovs_assert(!idl->txn); ovsdb_idl_clear(idl); jsonrpc_session_close(idl->session); @@ -227,9 +290,11 @@ ovsdb_idl_destroy(struct ovsdb_idl *idl) } shash_destroy(&idl->table_by_name); free(idl->tables); - json_destroy(idl->monitor_request_id); + json_destroy(idl->request_id); free(idl->lock_name); json_destroy(idl->lock_request_id); + json_destroy(idl->schema); + hmap_destroy(&idl->outstanding_txns); free(idl); } } @@ -261,10 +326,16 @@ ovsdb_idl_clear(struct ovsdb_idl *idl) /* No need to do anything with dst_arcs: some node has those arcs * as forward arcs and will destroy them itself. */ + if (!list_is_empty(&row->track_node)) { + list_remove(&row->track_node); + } + ovsdb_idl_row_destroy(row); } } + ovsdb_idl_track_clear(idl); + if (changed) { idl->change_seqno++; } @@ -278,21 +349,24 @@ ovsdb_idl_run(struct ovsdb_idl *idl) { int i; - assert(!idl->txn); + ovs_assert(!idl->txn); jsonrpc_session_run(idl->session); for (i = 0; jsonrpc_session_is_connected(idl->session) && i < 50; i++) { struct jsonrpc_msg *msg; unsigned int seqno; seqno = jsonrpc_session_get_seqno(idl->session); - if (idl->last_monitor_request_seqno != seqno) { - idl->last_monitor_request_seqno = seqno; + if (idl->state_seqno != seqno) { + idl->state_seqno = seqno; + json_destroy(idl->request_id); + idl->request_id = NULL; ovsdb_idl_txn_abort_all(idl); - ovsdb_idl_send_monitor_request(idl); + + ovsdb_idl_send_schema_request(idl); + idl->state = IDL_S_SCHEMA_REQUESTED; if (idl->lock_name) { ovsdb_idl_send_lock_request(idl); } - break; } msg = jsonrpc_session_recv(idl->session); @@ -301,21 +375,59 @@ ovsdb_idl_run(struct ovsdb_idl *idl) } if (msg->type == JSONRPC_NOTIFY - && !strcmp(msg->method, "update") + && !strcmp(msg->method, "update2") && msg->params->type == JSON_ARRAY && msg->params->u.array.n == 2 && msg->params->u.array.elems[0]->type == JSON_NULL) { /* Database contents changed. */ - ovsdb_idl_parse_update(idl, msg->params->u.array.elems[1]); + ovsdb_idl_parse_update(idl, msg->params->u.array.elems[1], + OVSDB_UPDATE2); } else if (msg->type == JSONRPC_REPLY - && idl->monitor_request_id - && json_equal(idl->monitor_request_id, msg->id)) { - /* Reply to our "monitor" request. */ - idl->change_seqno++; - json_destroy(idl->monitor_request_id); - idl->monitor_request_id = NULL; - ovsdb_idl_clear(idl); - ovsdb_idl_parse_update(idl, msg->result); + && idl->request_id + && json_equal(idl->request_id, msg->id)) { + json_destroy(idl->request_id); + idl->request_id = NULL; + + switch (idl->state) { + case IDL_S_SCHEMA_REQUESTED: + /* Reply to our "get_schema" request. */ + idl->schema = json_clone(msg->result); + ovsdb_idl_send_monitor2_request(idl); + idl->state = IDL_S_MONITOR2_REQUESTED; + break; + + case IDL_S_MONITOR_REQUESTED: + case IDL_S_MONITOR2_REQUESTED: + /* Reply to our "monitor" or "monitor2" request. */ + idl->change_seqno++; + ovsdb_idl_clear(idl); + if (idl->state == IDL_S_MONITOR_REQUESTED) { + idl->state = IDL_S_MONITORING; + ovsdb_idl_parse_update(idl, msg->result, OVSDB_UPDATE); + } else { /* IDL_S_MONITOR2_REQUESTED. */ + idl->state = IDL_S_MONITORING2; + ovsdb_idl_parse_update(idl, msg->result, OVSDB_UPDATE2); + } + + /* Schema is not useful after monitor request is accepted + * by the server. */ + json_destroy(idl->schema); + idl->schema = NULL; + break; + + case IDL_S_MONITORING: + case IDL_S_MONITORING2: + default: + OVS_NOT_REACHED(); + } + } else if (msg->type == JSONRPC_NOTIFY + && !strcmp(msg->method, "update") + && msg->params->type == JSON_ARRAY + && msg->params->u.array.n == 2 + && msg->params->u.array.elems[0]->type == JSON_NULL) { + /* Database contents changed. */ + ovsdb_idl_parse_update(idl, msg->params->u.array.elems[1], + OVSDB_UPDATE); } else if (msg->type == JSONRPC_REPLY && idl->lock_request_id && json_equal(idl->lock_request_id, msg->id)) { @@ -329,9 +441,26 @@ ovsdb_idl_run(struct ovsdb_idl *idl) && !strcmp(msg->method, "stolen")) { /* Someone else stole our lock. */ ovsdb_idl_parse_lock_notify(idl, msg->params, false); - } else if (msg->type == JSONRPC_REPLY && msg->id->type == JSON_STRING - && !strcmp(msg->id->u.string, "echo")) { - /* Reply to our echo request. Ignore it. */ + } else if (msg->type == JSONRPC_ERROR + && idl->state == IDL_S_MONITOR2_REQUESTED + && idl->request_id + && json_equal(idl->request_id, msg->id)) { + if (msg->error && !strcmp(json_string(msg->error), + "unknown method")) { + /* Fall back to using "monitor" method. */ + json_destroy(idl->request_id); + idl->request_id = NULL; + ovsdb_idl_send_monitor_request(idl); + idl->state = IDL_S_MONITOR_REQUESTED; + } + } else if (msg->type == JSONRPC_ERROR + && idl->state == IDL_S_SCHEMA_REQUESTED + && idl->request_id + && json_equal(idl->request_id, msg->id)) { + json_destroy(idl->request_id); + idl->request_id = NULL; + VLOG_ERR("%s: requested schema not found", + jsonrpc_session_get_name(idl->session)); } else if ((msg->type == JSONRPC_ERROR || msg->type == JSONRPC_REPLY) && ovsdb_idl_txn_process_reply(idl, msg)) { @@ -346,6 +475,7 @@ ovsdb_idl_run(struct ovsdb_idl *idl) } jsonrpc_msg_destroy(msg); } + ovsdb_idl_row_destroy_postprocess(idl); } /* Arranges for poll_block() to wake up when ovsdb_idl_run() has something to @@ -394,6 +524,14 @@ 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) +{ + jsonrpc_session_enable_reconnect(idl->session); +} + /* Forces 'idl' to drop its connection to the database and reconnect. In the * meantime, the contents of 'idl' will not change. */ void @@ -401,6 +539,32 @@ ovsdb_idl_force_reconnect(struct ovsdb_idl *idl) { jsonrpc_session_force_reconnect(idl->session); } + +/* 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. */ +bool +ovsdb_idl_is_alive(const struct ovsdb_idl *idl) +{ + return jsonrpc_session_is_alive(idl->session); +} + +/* 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. See + * jsonrpc_get_status() for return value interpretation. */ +int +ovsdb_idl_get_last_error(const struct ovsdb_idl *idl) +{ + return jsonrpc_session_get_last_error(idl->session); +} static unsigned char * ovsdb_idl_get_mode(struct ovsdb_idl *idl, @@ -408,7 +572,7 @@ ovsdb_idl_get_mode(struct ovsdb_idl *idl, { size_t i; - assert(!idl->change_seqno); + ovs_assert(!idl->change_seqno); for (i = 0; i < idl->class->n_tables; i++) { const struct ovsdb_idl_table *table = &idl->tables[i]; @@ -419,7 +583,7 @@ ovsdb_idl_get_mode(struct ovsdb_idl *idl, } } - NOT_REACHED(); + OVS_NOT_REACHED(); } static void @@ -458,11 +622,13 @@ ovsdb_idl_add_column(struct ovsdb_idl *idl, } /* Ensures that the table with class 'tc' will be replicated on 'idl' even if - * no columns are selected for replication. 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.) + * 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 @@ -483,7 +649,7 @@ ovsdb_idl_add_table(struct ovsdb_idl *idl, } } - NOT_REACHED(); + OVS_NOT_REACHED(); } /* Turns off OVSDB_IDL_ALERT for 'column' in 'idl'. @@ -509,25 +675,301 @@ 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 retrive 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. */ +static 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 */ +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); + + if (!list_is_empty(&table->track_list)) { + return CONTAINER_OF(list_front(&table->track_list), struct ovsdb_idl_row, track_node); + } + 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 */ +const struct ovsdb_idl_row * +ovsdb_idl_track_get_next(const struct ovsdb_idl_row *row) +{ + if (row->track_node.next != &row->table->track_list) { + return CONTAINER_OF(row->track_node.next, struct ovsdb_idl_row, track_node); + } + + 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; + } +} + +/* 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(const struct ovsdb_idl *idl) +{ + size_t i; + + for (i = 0; i < idl->class->n_tables; i++) { + struct ovsdb_idl_table *table = &idl->tables[i]; + + if (!list_is_empty(&table->track_list)) { + struct ovsdb_idl_row *row, *next; + + LIST_FOR_EACH_SAFE(row, next, track_node, &table->track_list) { + if (row->updated) { + free(row->updated); + row->updated = NULL; + } + list_remove(&row->track_node); + list_init(&row->track_node); + if (ovsdb_idl_row_is_orphan(row)) { + ovsdb_idl_row_clear_old(row); + free(row); + } + } + } + } +} + static void -ovsdb_idl_send_monitor_request(struct ovsdb_idl *idl) +ovsdb_idl_send_schema_request(struct ovsdb_idl *idl) +{ + struct jsonrpc_msg *msg; + + json_destroy(idl->request_id); + msg = jsonrpc_create_request( + "get_schema", + json_array_create_1(json_string_create(idl->class->database)), + &idl->request_id); + jsonrpc_session_send(idl->session, msg); +} + +static void +log_error(struct ovsdb_error *error) +{ + char *s = ovsdb_error_to_string(error); + VLOG_WARN("error parsing database schema: %s", s); + free(s); + ovsdb_error_destroy(error); +} + +/* Frees 'schema', which is in the format returned by parse_schema(). */ +static void +free_schema(struct shash *schema) +{ + if (schema) { + struct shash_node *node, *next; + + SHASH_FOR_EACH_SAFE (node, next, schema) { + struct sset *sset = node->data; + sset_destroy(sset); + free(sset); + shash_delete(schema, node); + } + shash_destroy(schema); + free(schema); + } +} + +/* Parses 'schema_json', an OVSDB schema in JSON format as described in RFC + * 7047, to obtain the names of its rows and columns. If successful, returns + * an shash whose keys are table names and whose values are ssets, where each + * sset contains the names of its table's columns. On failure (due to a parse + * error), returns NULL. + * + * It would also be possible to use the general-purpose OVSDB schema parser in + * ovsdb-server, but that's overkill, possibly too strict for the current use + * case, and would require restructuring ovsdb-server to separate the schema + * code from the rest. */ +static struct shash * +parse_schema(const struct json *schema_json) +{ + struct ovsdb_parser parser; + const struct json *tables_json; + struct ovsdb_error *error; + struct shash_node *node; + struct shash *schema; + + ovsdb_parser_init(&parser, schema_json, "database schema"); + tables_json = ovsdb_parser_member(&parser, "tables", OP_OBJECT); + error = ovsdb_parser_destroy(&parser); + if (error) { + log_error(error); + return NULL; + } + + schema = xmalloc(sizeof *schema); + shash_init(schema); + SHASH_FOR_EACH (node, json_object(tables_json)) { + const char *table_name = node->name; + const struct json *json = node->data; + const struct json *columns_json; + + ovsdb_parser_init(&parser, json, "table schema for table %s", + table_name); + columns_json = ovsdb_parser_member(&parser, "columns", OP_OBJECT); + error = ovsdb_parser_destroy(&parser); + if (error) { + log_error(error); + free_schema(schema); + return NULL; + } + + struct sset *columns = xmalloc(sizeof *columns); + sset_init(columns); + + struct shash_node *node2; + SHASH_FOR_EACH (node2, json_object(columns_json)) { + const char *column_name = node2->name; + sset_add(columns, column_name); + } + shash_add(schema, table_name, columns); + } + return schema; +} + +static void +ovsdb_idl_send_monitor_request__(struct ovsdb_idl *idl, + const char *method) { + struct shash *schema; struct json *monitor_requests; struct jsonrpc_msg *msg; size_t i; + schema = parse_schema(idl->schema); monitor_requests = json_object_create(); for (i = 0; i < idl->class->n_tables; i++) { const struct ovsdb_idl_table *table = &idl->tables[i]; const struct ovsdb_idl_table_class *tc = table->class; struct json *monitor_request, *columns; + const struct sset *table_schema; size_t j; + table_schema = (schema + ? shash_find_data(schema, table->class->name) + : NULL); + columns = table->need_table ? json_array_create_empty() : NULL; for (j = 0; j < tc->n_columns; j++) { const struct ovsdb_idl_column *column = &tc->columns[j]; if (table->modes[j] & OVSDB_IDL_MONITOR) { + if (table_schema + && !sset_contains(table_schema, column->name)) { + 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(); } @@ -536,45 +978,80 @@ ovsdb_idl_send_monitor_request(struct ovsdb_idl *idl) } 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); + continue; + } + monitor_request = json_object_create(); json_object_put(monitor_request, "columns", columns); json_object_put(monitor_requests, tc->name, monitor_request); } } + free_schema(schema); - json_destroy(idl->monitor_request_id); + json_destroy(idl->request_id); msg = jsonrpc_create_request( - "monitor", + method, json_array_create_3(json_string_create(idl->class->database), json_null_create(), monitor_requests), - &idl->monitor_request_id); + &idl->request_id); jsonrpc_session_send(idl->session, msg); } static void -ovsdb_idl_parse_update(struct ovsdb_idl *idl, const struct json *table_updates) +ovsdb_idl_send_monitor_request(struct ovsdb_idl *idl) +{ + ovsdb_idl_send_monitor_request__(idl, "monitor"); +} + +static void +log_parse_update_error(struct ovsdb_error *error) { - struct ovsdb_error *error = ovsdb_idl_parse_update__(idl, table_updates); - if (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 void +ovsdb_idl_send_monitor2_request(struct ovsdb_idl *idl) +{ + ovsdb_idl_send_monitor_request__(idl, "monitor2"); +} + +static void +ovsdb_idl_parse_update(struct ovsdb_idl *idl, const struct json *table_updates, + enum ovsdb_update_version version) +{ + struct ovsdb_error *error = ovsdb_idl_parse_update__(idl, table_updates, + version); + if (error) { + log_parse_update_error(error); } } static struct ovsdb_error * ovsdb_idl_parse_update__(struct ovsdb_idl *idl, - const struct json *table_updates) + const struct json *table_updates, + enum ovsdb_update_version version) { const struct shash_node *tables_node; + const char *table_updates_name = table_updates_names[version]; + const char *table_update_name = table_update_names[version]; + const char *row_update_name = row_update_names[version]; if (table_updates->type != JSON_OBJECT) { return ovsdb_syntax_error(table_updates, NULL, - " is not an object"); + "<%s> is not an object", + table_updates_name); } + SHASH_FOR_EACH (tables_node, json_object(table_updates)) { const struct json *table_update = tables_node->data; const struct shash_node *table_node; @@ -584,14 +1061,17 @@ ovsdb_idl_parse_update__(struct ovsdb_idl *idl, if (!table) { return ovsdb_syntax_error( table_updates, NULL, - " includes unknown table \"%s\"", + "<%s> includes unknown table \"%s\"", + table_updates_name, tables_node->name); } if (table_update->type != JSON_OBJECT) { return ovsdb_syntax_error(table_update, NULL, - " for table \"%s\" is " - "not an object", table->class->name); + "<%s> for table \"%s\" is " + "not an object", + table_update_name, + table->class->name); } SHASH_FOR_EACH (table_node, json_object(table_update)) { const struct json *row_update = table_node->data; @@ -600,42 +1080,81 @@ ovsdb_idl_parse_update__(struct ovsdb_idl *idl, if (!uuid_from_string(&uuid, table_node->name)) { return ovsdb_syntax_error(table_update, NULL, - " for table \"%s\" " + "<%s> for table \"%s\" " "contains bad UUID " "\"%s\" as member name", + table_update_name, table->class->name, table_node->name); } if (row_update->type != JSON_OBJECT) { return ovsdb_syntax_error(row_update, NULL, - " for table \"%s\" " - "contains for %s that " + "<%s> for table \"%s\" " + "contains <%s> for %s that " "is not an object", + table_update_name, table->class->name, + row_update_name, table_node->name); } - old_json = shash_find_data(json_object(row_update), "old"); - new_json = shash_find_data(json_object(row_update), "new"); - if (old_json && old_json->type != JSON_OBJECT) { - return ovsdb_syntax_error(old_json, NULL, - "\"old\" is not object"); - } else if (new_json && new_json->type != JSON_OBJECT) { - return ovsdb_syntax_error(new_json, NULL, - "\"new\" is not object"); - } else if ((old_json != NULL) + (new_json != NULL) - != shash_count(json_object(row_update))) { - return ovsdb_syntax_error(row_update, NULL, - " contains unexpected " - "member"); - } else if (!old_json && !new_json) { - return ovsdb_syntax_error(row_update, NULL, - " missing \"old\" " - "and \"new\" members"); + switch(version) { + case OVSDB_UPDATE: + old_json = shash_find_data(json_object(row_update), "old"); + new_json = shash_find_data(json_object(row_update), "new"); + if (old_json && old_json->type != JSON_OBJECT) { + return ovsdb_syntax_error(old_json, NULL, + "\"old\" is not object"); + } else if (new_json && new_json->type != JSON_OBJECT) { + return ovsdb_syntax_error(new_json, NULL, + "\"new\" is not object"); + } else if ((old_json != NULL) + (new_json != NULL) + != shash_count(json_object(row_update))) { + return ovsdb_syntax_error(row_update, NULL, + " contains " + "unexpected member"); + } else if (!old_json && !new_json) { + return ovsdb_syntax_error(row_update, NULL, + " missing \"old\" " + "and \"new\" members"); + } + + if (ovsdb_idl_process_update(table, &uuid, old_json, + new_json)) { + idl->change_seqno++; + } + break; + + case OVSDB_UPDATE2: { + const char *ops[] = {"modify", "insert", "delete", "initial"}; + const char *operation; + const struct json *row; + int i; + + for (i = 0; i < ARRAY_SIZE(ops); i++) { + operation = ops[i]; + row = shash_find_data(json_object(row_update), operation); + + if (row) { + if (ovsdb_idl_process_update2(table, &uuid, operation, + row)) { + idl->change_seqno++; + } + break; + } + } + + /* row_update2 should contain one of the objects */ + if (i == ARRAY_SIZE(ops)) { + return ovsdb_syntax_error(row_update, NULL, + " includes unknown " + "object"); + } + break; } - if (ovsdb_idl_process_update(table, &uuid, old_json, new_json)) { - idl->change_seqno++; + default: + OVS_NOT_REACHED(); } } } @@ -713,17 +1232,86 @@ ovsdb_idl_process_update(struct ovsdb_idl_table *table, /* Returns true if a column with mode OVSDB_IDL_MODE_RW changed, false * otherwise. */ static bool -ovsdb_idl_row_update(struct ovsdb_idl_row *row, const struct json *row_json) +ovsdb_idl_process_update2(struct ovsdb_idl_table *table, + const struct uuid *uuid, + const char *operation, + const struct json *json_row) +{ + struct ovsdb_idl_row *row; + + row = ovsdb_idl_get_row(table, uuid); + if (!strcmp(operation, "delete")) { + /* Delete row. */ + if (row && !ovsdb_idl_row_is_orphan(row)) { + ovsdb_idl_delete_row(row); + } else { + VLOG_WARN_RL(&semantic_rl, "cannot delete missing row "UUID_FMT" " + "from table %s", + UUID_ARGS(uuid), table->class->name); + return false; + } + } else if (!strcmp(operation, "insert") || !strcmp(operation, "initial")) { + /* Insert row. */ + if (!row) { + ovsdb_idl_insert_row(ovsdb_idl_row_create(table, uuid), json_row); + } else if (ovsdb_idl_row_is_orphan(row)) { + ovsdb_idl_insert_row(row, json_row); + } else { + VLOG_WARN_RL(&semantic_rl, "cannot add existing row "UUID_FMT" to " + "table %s", UUID_ARGS(uuid), table->class->name); + ovsdb_idl_delete_row(row); + ovsdb_idl_insert_row(row, json_row); + } + } else if (!strcmp(operation, "modify")) { + /* Modify row. */ + if (row) { + if (!ovsdb_idl_row_is_orphan(row)) { + return ovsdb_idl_modify_row_by_diff(row, json_row); + } else { + VLOG_WARN_RL(&semantic_rl, "cannot modify missing but " + "referenced row "UUID_FMT" in table %s", + UUID_ARGS(uuid), table->class->name); + return false; + } + } else { + VLOG_WARN_RL(&semantic_rl, "cannot modify missing row "UUID_FMT" " + "in table %s", UUID_ARGS(uuid), table->class->name); + return false; + } + } else { + VLOG_WARN_RL(&semantic_rl, "unknown operation %s to " + "table %s", operation, table->class->name); + return false; + } + + return true; +} + +/* 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 json *row_json, + const struct json *diff_json, + 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; + bool apply_diff = diff_json != NULL; + const struct json *json = apply_diff ? diff_json : row_json; - SHASH_FOR_EACH (node, json_object(row_json)) { + SHASH_FOR_EACH (node, json_object(json)) { const char *column_name = node->name; const struct ovsdb_idl_column *column; struct ovsdb_datum datum; struct ovsdb_error *error; + unsigned int column_idx; + struct ovsdb_datum *old; column = shash_find_data(&table->columns, column_name); if (!column) { @@ -732,15 +1320,45 @@ ovsdb_idl_row_update(struct ovsdb_idl_row *row, const struct json *row_json) continue; } - error = ovsdb_datum_from_json(&datum, &column->type, node->data, NULL); - if (!error) { - unsigned int column_idx = column - table->class->columns; - struct ovsdb_datum *old = &row->old[column_idx]; + column_idx = column - table->class->columns; + old = &row->old[column_idx]; + + error = NULL; + if (apply_diff) { + struct ovsdb_datum diff; + ovs_assert(!row_json); + error = ovsdb_transient_datum_from_json(&diff, &column->type, + node->data); + if (!error) { + error = ovsdb_datum_apply_diff(&datum, old, &diff, + &column->type); + ovsdb_datum_destroy(&diff, &column->type); + } + } else { + ovs_assert(!diff_json); + 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); if (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 (list_is_empty(&row->track_node)) { + list_push_front(&row->table->track_list, + &row->track_node); + } + if (!row->updated) { + row->updated = bitmap_allocate(class->n_columns); + } + bitmap_set1(row->updated, column_idx); + } } } else { /* Didn't really change but the OVSDB monitor protocol always @@ -760,6 +1378,21 @@ ovsdb_idl_row_update(struct ovsdb_idl_row *row, const struct json *row_json) return changed; } +static bool +ovsdb_idl_row_update(struct ovsdb_idl_row *row, const struct json *row_json, + enum ovsdb_idl_change change) +{ + return ovsdb_idl_row_change__(row, row_json, NULL, change); +} + +static bool +ovsdb_idl_row_apply_diff(struct ovsdb_idl_row *row, + const struct json *diff_json, + enum ovsdb_idl_change change) +{ + return ovsdb_idl_row_change__(row, NULL, diff_json, change); +} + /* 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 @@ -824,7 +1457,7 @@ ovsdb_idl_row_unparse(struct ovsdb_idl_row *row) static void ovsdb_idl_row_clear_old(struct ovsdb_idl_row *row) { - assert(row->old == row->new); + ovs_assert(row->old == row->new); if (!ovsdb_idl_row_is_orphan(row)) { const struct ovsdb_idl_table_class *class = row->table->class; size_t i; @@ -864,7 +1497,10 @@ ovsdb_idl_row_clear_arcs(struct ovsdb_idl_row *row, bool destroy_dsts) struct ovsdb_idl_arc *arc, *next; /* Delete all forward arcs. If 'destroy_dsts', destroy any orphaned rows - * that this causes to be unreferenced. */ + * that this causes to be unreferenced, if tracking is not enabled. + * If tracking is enabled, orphaned nodes are removed from hmap but not + * freed. + */ LIST_FOR_EACH_SAFE (arc, next, src_node, &row->src_arcs) { list_remove(&arc->dst_node); if (destroy_dsts @@ -910,6 +1546,7 @@ ovsdb_idl_row_create__(const struct ovsdb_idl_table_class *class) list_init(&row->src_arcs); list_init(&row->dst_arcs); hmap_node_nullify(&row->txn_node); + list_init(&row->track_node); return row; } @@ -929,7 +1566,35 @@ ovsdb_idl_row_destroy(struct ovsdb_idl_row *row) if (row) { ovsdb_idl_row_clear_old(row); hmap_remove(&row->table->rows, &row->hmap_node); - free(row); + if (ovsdb_idl_track_is_set(row->table)) { + row->change_seqno[OVSDB_IDL_CHANGE_DELETE] + = row->table->change_seqno[OVSDB_IDL_CHANGE_DELETE] + = row->table->idl->change_seqno + 1; + } + if (list_is_empty(&row->track_node)) { + list_push_front(&row->table->track_list, &row->track_node); + } + } +} + +static void +ovsdb_idl_row_destroy_postprocess(struct ovsdb_idl *idl) +{ + size_t i; + + for (i = 0; i < idl->class->n_tables; i++) { + struct ovsdb_idl_table *table = &idl->tables[i]; + + if (!list_is_empty(&table->track_list)) { + struct ovsdb_idl_row *row, *next; + + LIST_FOR_EACH_SAFE(row, next, track_node, &table->track_list) { + if (!ovsdb_idl_track_is_set(row->table)) { + list_remove(&row->track_node); + free(row); + } + } + } } } @@ -939,12 +1604,12 @@ ovsdb_idl_insert_row(struct ovsdb_idl_row *row, const struct json *row_json) const struct ovsdb_idl_table_class *class = row->table->class; size_t i; - assert(!row->old && !row->new); + ovs_assert(!row->old && !row->new); row->old = row->new = xmalloc(class->n_columns * sizeof *row->old); for (i = 0; i < class->n_columns; i++) { ovsdb_datum_init_default(&row->old[i], &class->columns[i].type); } - ovsdb_idl_row_update(row, row_json); + ovsdb_idl_row_update(row, row_json, OVSDB_IDL_CHANGE_INSERT); ovsdb_idl_row_parse(row); ovsdb_idl_row_reparse_backrefs(row); @@ -972,7 +1637,22 @@ ovsdb_idl_modify_row(struct ovsdb_idl_row *row, const struct json *row_json) ovsdb_idl_row_unparse(row); ovsdb_idl_row_clear_arcs(row, true); - changed = ovsdb_idl_row_update(row, row_json); + changed = ovsdb_idl_row_update(row, row_json, OVSDB_IDL_CHANGE_MODIFY); + ovsdb_idl_row_parse(row); + + return changed; +} + +static bool +ovsdb_idl_modify_row_by_diff(struct ovsdb_idl_row *row, + const struct json *diff_json) +{ + bool changed; + + ovsdb_idl_row_unparse(row); + ovsdb_idl_row_clear_arcs(row, true); + changed = ovsdb_idl_row_apply_diff(row, diff_json, + OVSDB_IDL_CHANGE_MODIFY); ovsdb_idl_row_parse(row); return changed; @@ -1120,13 +1800,13 @@ ovsdb_idl_read(const struct ovsdb_idl_row *row, const struct ovsdb_idl_table_class *class; size_t column_idx; - assert(!ovsdb_idl_row_is_synthetic(row)); + ovs_assert(!ovsdb_idl_row_is_synthetic(row)); class = row->table->class; column_idx = column - class->columns; - assert(row->new != NULL); - assert(column_idx < class->n_columns); + ovs_assert(row->new != NULL); + ovs_assert(column_idx < class->n_columns); if (row->written && bitmap_is_set(row->written, column_idx)) { return &row->new[column_idx]; @@ -1150,12 +1830,27 @@ ovsdb_idl_get(const struct ovsdb_idl_row *row, enum ovsdb_atomic_type key_type OVS_UNUSED, enum ovsdb_atomic_type value_type OVS_UNUSED) { - assert(column->type.key.type == key_type); - assert(column->type.value.type == value_type); + 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->mutable || (row->new && !row->old); +} + /* 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. */ @@ -1207,7 +1902,7 @@ ovsdb_idl_txn_create(struct ovsdb_idl *idl) { struct ovsdb_idl_txn *txn; - assert(!idl->txn); + ovs_assert(!idl->txn); idl->txn = txn = xmalloc(sizeof *txn); txn->request_id = NULL; txn->idl = idl; @@ -1216,7 +1911,6 @@ ovsdb_idl_txn_create(struct ovsdb_idl *idl) txn->error = NULL; txn->dry_run = false; ds_init(&txn->comment); - txn->commit_seqno = txn->idl->change_seqno; txn->inc_table = NULL; txn->inc_column = NULL; @@ -1274,9 +1968,9 @@ ovsdb_idl_txn_increment(struct ovsdb_idl_txn *txn, const struct ovsdb_idl_row *row, const struct ovsdb_idl_column *column) { - assert(!txn->inc_table); - assert(column->type.key.type == OVSDB_TYPE_INTEGER); - assert(column->type.value.type == OVSDB_TYPE_VOID); + 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; @@ -1495,14 +2189,13 @@ ovsdb_idl_txn_commit(struct ovsdb_idl_txn *txn) bool any_updates; if (txn != txn->idl->txn) { - return txn->status; + goto coverage_out; } /* If we need a lock but don't have it, give up quickly. */ if (txn->idl->lock_name && !ovsdb_idl_has_lock(txn->idl)) { txn->status = TXN_NOT_LOCKED; - ovsdb_idl_txn_disassemble(txn); - return txn->status; + goto disassemble_out; } operations = json_array_create_1( @@ -1686,7 +2379,20 @@ ovsdb_idl_txn_commit(struct ovsdb_idl_txn *txn) 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; } @@ -1717,7 +2423,7 @@ ovsdb_idl_txn_commit_block(struct ovsdb_idl_txn *txn) int64_t ovsdb_idl_txn_get_increment_new_value(const struct ovsdb_idl_txn *txn) { - assert(txn->status == TXN_SUCCESS); + ovs_assert(txn->status == TXN_SUCCESS); return txn->inc_new_value; } @@ -1780,7 +2486,7 @@ ovsdb_idl_txn_get_insert_uuid(const struct ovsdb_idl_txn *txn, { const struct ovsdb_idl_txn_insert *insert; - assert(txn->status == TXN_SUCCESS || txn->status == TXN_UNCHANGED); + 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)) { @@ -1815,27 +2521,34 @@ ovsdb_idl_txn_complete(struct ovsdb_idl_txn *txn, * 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) +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 = (struct ovsdb_idl_row *) row_; + struct ovsdb_idl_row *row = CONST_CAST(struct ovsdb_idl_row *, row_); const struct ovsdb_idl_table_class *class; size_t column_idx; + bool write_only; if (ovsdb_idl_row_is_synthetic(row)) { - ovsdb_datum_destroy(datum, &column->type); - return; + goto discard_datum; } class = row->table->class; column_idx = column - class->columns; + write_only = row->table->modes[column_idx] == OVSDB_IDL_MONITOR; - assert(row->new != NULL); - assert(column_idx < class->n_columns); - assert(row->old == NULL || - row->table->modes[column_idx] & OVSDB_IDL_MONITOR); + ovs_assert(row->new != NULL); + ovs_assert(column_idx < class->n_columns); + ovs_assert(row->old == NULL || + row->table->modes[column_idx] & 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 @@ -1848,11 +2561,9 @@ ovsdb_idl_txn_write(const struct ovsdb_idl_row *row_, * transaction only does writes of existing values, without making any real * changes, we will drop the whole transaction later in * ovsdb_idl_txn_commit().) */ - if (row->table->modes[column_idx] == OVSDB_IDL_MONITOR - && ovsdb_datum_equals(ovsdb_idl_read(row, column), - datum, &column->type)) { - ovsdb_datum_destroy(datum, &column->type); - return; + if (write_only && ovsdb_datum_equals(ovsdb_idl_read(row, column), + datum, &column->type)) { + goto discard_datum; } if (hmap_node_is_null(&row->txn_node)) { @@ -1870,9 +2581,36 @@ ovsdb_idl_txn_write(const struct ovsdb_idl_row *row_, } else { bitmap_set1(row->written, column_idx); } - row->new[column_idx] = *datum; + if (owns_datum) { + row->new[column_idx] = *datum; + } else { + ovsdb_datum_clone(&row->new[column_idx], datum, &column->type); + } (column->unparse)(row); (column->parse)(row, &row->new[column_idx]); + return; + +discard_datum: + if (owns_datum) { + ovsdb_datum_destroy(datum, &column->type); + } +} + +void +ovsdb_idl_txn_write(const struct ovsdb_idl_row *row, + const struct ovsdb_idl_column *column, + struct ovsdb_datum *datum) +{ + ovsdb_idl_txn_write__(row, column, datum, true); +} + +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 @@ -1907,7 +2645,7 @@ void ovsdb_idl_txn_verify(const struct ovsdb_idl_row *row_, const struct ovsdb_idl_column *column) { - struct ovsdb_idl_row *row = (struct ovsdb_idl_row *) row_; + struct ovsdb_idl_row *row = CONST_CAST(struct ovsdb_idl_row *, row_); const struct ovsdb_idl_table_class *class; size_t column_idx; @@ -1918,9 +2656,9 @@ ovsdb_idl_txn_verify(const struct ovsdb_idl_row *row_, class = row->table->class; column_idx = column - class->columns; - assert(row->new != NULL); - assert(row->old == NULL || - row->table->modes[column_idx] & OVSDB_IDL_MONITOR); + ovs_assert(row->new != NULL); + ovs_assert(row->old == NULL || + row->table->modes[column_idx] & OVSDB_IDL_MONITOR); if (!row->old || (row->written && bitmap_is_set(row->written, column_idx))) { return; @@ -1946,17 +2684,17 @@ ovsdb_idl_txn_verify(const struct ovsdb_idl_row *row_, void ovsdb_idl_txn_delete(const struct ovsdb_idl_row *row_) { - struct ovsdb_idl_row *row = (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; } - assert(row->new != NULL); + ovs_assert(row->new != NULL); if (!row->old) { ovsdb_idl_row_unparse(row); ovsdb_idl_row_clear_new(row); - assert(!row->prereqs); + 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); @@ -1990,7 +2728,7 @@ ovsdb_idl_txn_insert(struct ovsdb_idl_txn *txn, struct ovsdb_idl_row *row = ovsdb_idl_row_create__(class); if (uuid) { - assert(!ovsdb_idl_txn_get_row(txn, uuid)); + ovs_assert(!ovsdb_idl_txn_get_row(txn, uuid)); row->uuid = *uuid; } else { uuid_generate(&row->uuid); @@ -2052,7 +2790,7 @@ ovsdb_idl_txn_process_inc_reply(struct ovsdb_idl_txn *txn, if (txn->inc_index + 2 > results->n) { VLOG_WARN_RL(&syntax_rl, "reply does not contain enough operations " - "for increment (has %zu, needs %u)", + "for increment (has %"PRIuSIZE", needs %u)", results->n, txn->inc_index + 2); return false; } @@ -2077,7 +2815,7 @@ ovsdb_idl_txn_process_inc_reply(struct ovsdb_idl_txn *txn, return false; } if (rows->u.array.n != 1) { - VLOG_WARN_RL(&syntax_rl, "\"select\" reply \"rows\" has %zu elements " + VLOG_WARN_RL(&syntax_rl, "\"select\" reply \"rows\" has %"PRIuSIZE" elements " "instead of 1", rows->u.array.n); return false; @@ -2107,7 +2845,7 @@ ovsdb_idl_txn_process_insert_reply(struct ovsdb_idl_txn_insert *insert, if (insert->op_index >= results->n) { VLOG_WARN_RL(&syntax_rl, "reply does not contain enough operations " - "for insert (has %zu, needs %u)", + "for insert (has %"PRIuSIZE", needs %u)", results->n, insert->op_index); return false; } @@ -2126,6 +2864,7 @@ ovsdb_idl_txn_process_insert_reply(struct ovsdb_idl_txn_insert *insert, VLOG_WARN_RL(&syntax_rl, "\"insert\" reply \"uuid\" is not a JSON " "UUID: %s", s); free(s); + ovsdb_error_destroy(error); return false; } @@ -2224,7 +2963,7 @@ struct ovsdb_idl_txn * ovsdb_idl_txn_get(const struct ovsdb_idl_row *row) { struct ovsdb_idl_txn *txn = row->table->idl->txn; - assert(txn != NULL); + ovs_assert(txn != NULL); return txn; } @@ -2234,6 +2973,21 @@ 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 @@ -2244,8 +2998,8 @@ ovsdb_idl_txn_get_idl (struct ovsdb_idl_txn *txn) void ovsdb_idl_set_lock(struct ovsdb_idl *idl, const char *lock_name) { - assert(!idl->txn); - assert(hmap_is_empty(&idl->outstanding_txns)); + ovs_assert(!idl->txn); + ovs_assert(hmap_is_empty(&idl->outstanding_txns)); if (idl->lock_name && (!lock_name || strcmp(lock_name, idl->lock_name))) { /* Release previous lock. */ @@ -2286,11 +3040,12 @@ static void ovsdb_idl_update_has_lock(struct ovsdb_idl *idl, bool new_has_lock) { if (new_has_lock && !idl->has_lock) { - if (!idl->monitor_request_id) { + if (idl->state == IDL_S_MONITORING || + idl->state == IDL_S_MONITORING2) { idl->change_seqno++; } else { - /* We're waiting for a monitor reply, so don't signal that the - * database changed. The monitor reply will increment change_seqno + /* We're setting up a session, so don't signal that the database + * changed. Finalizing the session will increment change_seqno * anyhow. */ } idl->is_lock_contended = false; @@ -2370,3 +3125,75 @@ ovsdb_idl_parse_lock_notify(struct ovsdb_idl *idl, } } } + +void +ovsdb_idl_loop_destroy(struct ovsdb_idl_loop *loop) +{ + if (loop) { + ovsdb_idl_destroy(loop->idl); + } +} + +struct ovsdb_idl_txn * +ovsdb_idl_loop_run(struct ovsdb_idl_loop *loop) +{ + ovsdb_idl_run(loop->idl); + loop->open_txn = (loop->committing_txn + || ovsdb_idl_get_seqno(loop->idl) == loop->skip_seqno + ? NULL + : ovsdb_idl_txn_create(loop->idl)); + return loop->open_txn; +} + +void +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); + } + + struct ovsdb_idl_txn *txn = loop->committing_txn; + if (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) { + poll_immediate_wake(); + } + break; + + case TXN_SUCCESS: + /* If the database has already changed since we started the + * commit, re-evaluate it immediately to avoid missing a change + * for a while. */ + if (ovsdb_idl_get_seqno(loop->idl) != loop->precommit_seqno) { + poll_immediate_wake(); + } + break; + + case TXN_UNCHANGED: + case TXN_ABORTED: + case TXN_NOT_LOCKED: + case TXN_ERROR: + break; + + case TXN_UNCOMMITTED: + case TXN_INCOMPLETE: + OVS_NOT_REACHED(); + + } + ovsdb_idl_txn_destroy(txn); + loop->committing_txn = NULL; + } + } + + ovsdb_idl_wait(loop->idl); +}