#include "bitmap.h"
#include "dynamic-string.h"
+#include "fatal-signal.h"
#include "json.h"
#include "jsonrpc.h"
#include "ovsdb-data.h"
#include "poll-loop.h"
#include "shash.h"
#include "util.h"
-
-#define THIS_MODULE VLM_ovsdb_idl
#include "vlog.h"
+VLOG_DEFINE_THIS_MODULE(ovsdb_idl)
+
/* 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).
struct ovsdb_idl *idl;
struct hmap txn_rows;
enum ovsdb_idl_txn_status status;
+ char *error;
bool dry_run;
struct ds comment;
struct json *inc_where;
unsigned int inc_index;
int64_t inc_new_value;
+
+ /* Inserted rows. */
+ struct hmap inserted_rows;
+};
+
+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 void ovsdb_idl_parse_update(struct ovsdb_idl *, const struct json *);
static struct ovsdb_error *ovsdb_idl_parse_update__(struct ovsdb_idl *,
const struct json *);
-static void ovsdb_idl_process_update(struct ovsdb_idl_table *,
+static bool ovsdb_idl_process_update(struct ovsdb_idl_table *,
const struct uuid *,
const struct json *old,
const struct json *new);
static void ovsdb_idl_insert_row(struct ovsdb_idl_row *, const struct json *);
static void ovsdb_idl_delete_row(struct ovsdb_idl_row *);
-static void ovsdb_idl_modify_row(struct ovsdb_idl_row *, const struct json *);
+static bool ovsdb_idl_modify_row(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__(
const struct uuid *);
static void ovsdb_idl_row_destroy(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 bool ovsdb_idl_txn_process_reply(struct ovsdb_idl *,
const struct jsonrpc_msg *msg);
+/* 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.) */
struct ovsdb_idl *
ovsdb_idl_create(const char *remote, const struct ovsdb_idl_class *class)
{
struct ovsdb_idl_table *table = &idl->tables[i];
size_t j;
- assert(!shash_find(&idl->table_by_name, tc->name));
- shash_add(&idl->table_by_name, tc->name, table);
+ shash_add_assert(&idl->table_by_name, tc->name, table);
table->class = tc;
+ table->modes = xmalloc(tc->n_columns);
+ memset(table->modes, OVSDB_IDL_MODE_RW, tc->n_columns);
shash_init(&table->columns);
for (j = 0; j < tc->n_columns; j++) {
const struct ovsdb_idl_column *column = &tc->columns[j];
- assert(!shash_find(&table->columns, column->name));
- shash_add(&table->columns, column->name, column);
+ shash_add_assert(&table->columns, column->name, column);
}
hmap_init(&table->rows);
table->idl = idl;
return idl;
}
+/* Destroys 'idl' and all of the data structures that it manages. */
void
ovsdb_idl_destroy(struct ovsdb_idl *idl)
{
struct ovsdb_idl_table *table = &idl->tables[i];
shash_destroy(&table->columns);
hmap_destroy(&table->rows);
+ free(table->modes);
}
shash_destroy(&idl->table_by_name);
free(idl->tables);
struct ovsdb_idl_arc *arc, *next_arc;
if (!ovsdb_idl_row_is_orphan(row)) {
- (row->table->class->unparse)(row);
- ovsdb_idl_row_clear_old(row);
+ ovsdb_idl_row_unparse(row);
}
- hmap_remove(&table->rows, &row->hmap_node);
LIST_FOR_EACH_SAFE (arc, next_arc, struct ovsdb_idl_arc, src_node,
&row->src_arcs) {
free(arc);
/* No need to do anything with dst_arcs: some node has those arcs
* as forward arcs and will destroy them itself. */
- free(row);
+ ovsdb_idl_row_destroy(row);
}
}
}
}
-void
+/* Processes a batch of messages from the database server on 'idl'. Returns
+ * true if the database as seen through 'idl' changed, false if it did not
+ * change. The initial fetch of the entire contents of the remote database is
+ * considered to be one kind of change.
+ *
+ * When this function returns false, the client may continue to use any data
+ * structures it obtained from 'idl' in the past. But when it returns true,
+ * the client must not access any of these data structures again, because they
+ * could have freed or reused for other purposes.
+ *
+ * This function can return occasional false positives, that is, report that
+ * the database changed even though it didn't. 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 we already thought
+ * was in the database, but the database server is not supposed to do that.)
+ *
+ * As an alternative to checking the return value, the client may check for
+ * changes in the value returned by ovsdb_idl_get_seqno().
+ */
+bool
ovsdb_idl_run(struct ovsdb_idl *idl)
{
+ unsigned int initial_change_seqno = idl->change_seqno;
int i;
assert(!idl->txn);
} else if (msg->type == JSONRPC_REPLY
&& idl->monitor_request_id
&& json_equal(idl->monitor_request_id, msg->id)) {
+ idl->change_seqno++;
json_destroy(idl->monitor_request_id);
idl->monitor_request_id = NULL;
ovsdb_idl_clear(idl);
}
jsonrpc_msg_destroy(msg);
}
+
+ return initial_change_seqno != idl->change_seqno;
}
+/* 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)
{
jsonrpc_session_recv_wait(idl->session);
}
+/* Returns a number that represents the state of 'idl'. When 'idl' is updated
+ * (by ovsdb_idl_run()), the return value changes. */
unsigned int
ovsdb_idl_get_seqno(const struct ovsdb_idl *idl)
{
return idl->change_seqno;
}
+/* 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;
}
+/* 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)
{
jsonrpc_session_force_reconnect(idl->session);
}
+
+static void
+ovsdb_idl_set_mode(struct ovsdb_idl *idl,
+ const struct ovsdb_idl_column *column,
+ enum ovsdb_idl_mode mode)
+{
+ size_t i;
+
+ 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;
+
+ if (column >= tc->columns && column < &tc->columns[tc->n_columns]) {
+ unsigned char *modep = &table->modes[column - tc->columns];
+ assert(*modep == OVSDB_IDL_MODE_RW || *modep == mode);
+ *modep = mode;
+ return;
+ }
+ }
+
+ NOT_REACHED();
+}
+
+/* By default, 'idl' replicates all of the columns in the remote database, and
+ * ovsdb_idl_run() returns true upon a change to any column in the database.
+ * Call this function to avoid alerting ovsdb_idl_run()'s caller upon changes
+ * to 'column'.
+ *
+ * This is useful for columns that a client treats as "write-only", that is, it
+ * updates them but doesn't want to get alerted about its own updates. It also
+ * won't be alerted about other clients' updates, so this is suitable only for
+ * use by a client that "owns" a particular column.
+ *
+ * The client must be careful not to retain pointers to data in 'column' across
+ * calls to ovsdb_idl_run(), even when that function returns false, because
+ * the client is not alerted to changes.
+ *
+ * This function should be called after ovsdb_idl_create(), but before the
+ * first call to ovsdb_idl_run(). For any given column, this function may be
+ * called or ovsdb_idl_omit() may be called, but not both. */
+void
+ovsdb_idl_set_write_only(struct ovsdb_idl *idl,
+ const struct ovsdb_idl_column *column)
+{
+ ovsdb_idl_set_mode(idl, column, OVSDB_IDL_MODE_WO);
+}
+
+/* By default, 'idl' replicates all of the columns in the remote database.
+ * Call this function to omit replicating 'column'. This saves CPU time and
+ * bandwidth to the database.
+ *
+ * This function should be called after ovsdb_idl_create(), but before the
+ * first call to ovsdb_idl_run(). For any given column, this function may be
+ * called or ovsdb_idl_set_write_only() may be called, but not both. */
+void
+ovsdb_idl_omit(struct ovsdb_idl *idl, const struct ovsdb_idl_column *column)
+{
+ ovsdb_idl_set_mode(idl, column, OVSDB_IDL_MODE_NONE);
+}
\f
static void
ovsdb_idl_send_monitor_request(struct ovsdb_idl *idl)
columns = json_array_create_empty();
for (i = 0; i < tc->n_columns; i++) {
const struct ovsdb_idl_column *column = &tc->columns[i];
- json_array_add(columns, json_string_create(column->name));
+ if (table->modes[i] != OVSDB_IDL_MODE_NONE) {
+ json_array_add(columns, json_string_create(column->name));
+ }
}
json_object_put(monitor_request, "columns", columns);
json_object_put(monitor_requests, tc->name, monitor_request);
json_destroy(idl->monitor_request_id);
msg = jsonrpc_create_request(
- "monitor", json_array_create_2(json_null_create(), monitor_requests),
+ "monitor",
+ json_array_create_3(json_string_create(idl->class->database),
+ json_null_create(), monitor_requests),
&idl->monitor_request_id);
jsonrpc_session_send(idl->session, msg);
}
static void
ovsdb_idl_parse_update(struct ovsdb_idl *idl, const struct json *table_updates)
{
- struct ovsdb_error *error;
-
- idl->change_seqno++;
-
- error = ovsdb_idl_parse_update__(idl, table_updates);
+ 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);
"and \"new\" members");
}
- ovsdb_idl_process_update(table, &uuid, old_json, new_json);
+ if (ovsdb_idl_process_update(table, &uuid, old_json, new_json)) {
+ idl->change_seqno++;
+ }
}
}
return NULL;
}
-static void
+/* Returns true if a column with mode OVSDB_IDL_MODE_RW changed, false
+ * otherwise. */
+static bool
ovsdb_idl_process_update(struct ovsdb_idl_table *table,
const struct uuid *uuid, const struct json *old,
const struct json *new)
VLOG_WARN_RL(&semantic_rl, "cannot delete missing row "UUID_FMT" "
"from table %s",
UUID_ARGS(uuid), table->class->name);
+ return false;
}
} else if (!old) {
/* Insert row. */
} else {
VLOG_WARN_RL(&semantic_rl, "cannot add existing row "UUID_FMT" to "
"table %s", UUID_ARGS(uuid), table->class->name);
- ovsdb_idl_modify_row(row, new);
+ return ovsdb_idl_modify_row(row, new);
}
} else {
/* Modify row. */
if (row) {
/* XXX perhaps we should check the 'old' values? */
if (!ovsdb_idl_row_is_orphan(row)) {
- ovsdb_idl_modify_row(row, new);
+ return ovsdb_idl_modify_row(row, new);
} else {
VLOG_WARN_RL(&semantic_rl, "cannot modify missing but "
"referenced row "UUID_FMT" in table %s",
ovsdb_idl_insert_row(ovsdb_idl_row_create(table, uuid), new);
}
}
+
+ return true;
}
-static void
+/* 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)
{
struct ovsdb_idl_table *table = row->table;
struct shash_node *node;
+ bool changed = false;
SHASH_FOR_EACH (node, json_object(row_json)) {
const char *column_name = node->name;
error = ovsdb_datum_from_json(&datum, &column->type, node->data, NULL);
if (!error) {
- ovsdb_datum_swap(&row->old[column - table->class->columns],
- &datum);
+ unsigned int column_idx = column - table->class->columns;
+ struct ovsdb_datum *old = &row->old[column_idx];
+
+ if (!ovsdb_datum_equals(old, &datum, &column->type)) {
+ ovsdb_datum_swap(old, &datum);
+ if (table->modes[column_idx] == OVSDB_IDL_MODE_RW) {
+ changed = true;
+ }
+ } else {
+ /* Didn't really change but the OVSDB monitor protocol always
+ * includes every value in a row. */
+ }
+
ovsdb_datum_destroy(&datum, &column->type);
} else {
char *s = ovsdb_error_to_string(error);
ovsdb_error_destroy(error);
}
}
+ 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;
+ return !row->old && !row->new;
+}
+
+/* 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 != 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;
+
+ for (i = 0; i < class->n_columns; i++) {
+ const struct ovsdb_idl_column *c = &class->columns[i];
+ (c->parse)(row, &row->old[i]);
+ }
+}
+
+static void
+ovsdb_idl_row_unparse(struct ovsdb_idl_row *row)
+{
+ const struct ovsdb_idl_table_class *class = row->table->class;
+ size_t i;
+
+ for (i = 0; i < class->n_columns; i++) {
+ const struct ovsdb_idl_column *c = &class->columns[i];
+ (c->unparse)(row);
+ }
}
static void
const struct ovsdb_idl_table_class *class = row->table->class;
size_t i;
- BITMAP_FOR_EACH_1 (i, class->n_columns, row->written) {
- ovsdb_datum_destroy(&row->new[i], &class->columns[i].type);
+ if (row->written) {
+ BITMAP_FOR_EACH_1 (i, class->n_columns, row->written) {
+ ovsdb_datum_destroy(&row->new[i], &class->columns[i].type);
+ }
}
free(row->new);
free(row->written);
/* Force nodes that reference 'row' to reparse. */
static void
-ovsdb_idl_row_reparse_backrefs(struct ovsdb_idl_row *row, bool destroy_dsts)
+ovsdb_idl_row_reparse_backrefs(struct ovsdb_idl_row *row)
{
struct ovsdb_idl_arc *arc, *next;
/* 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 ref->table->class->parse 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.
+ * 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
&row->dst_arcs) {
struct ovsdb_idl_row *ref = arc->src;
- (ref->table->class->unparse)(ref);
- ovsdb_idl_row_clear_arcs(ref, destroy_dsts);
- (ref->table->class->parse)(ref);
+ ovsdb_idl_row_unparse(ref);
+ ovsdb_idl_row_clear_arcs(ref, false);
+ ovsdb_idl_row_parse(ref);
}
}
ovsdb_idl_row_create__(const struct ovsdb_idl_table_class *class)
{
struct ovsdb_idl_row *row = xzalloc(class->allocation_size);
- memset(row, 0, sizeof *row);
list_init(&row->src_arcs);
list_init(&row->dst_arcs);
hmap_node_nullify(&row->txn_node);
ovsdb_datum_init_default(&row->old[i], &class->columns[i].type);
}
ovsdb_idl_row_update(row, row_json);
- (class->parse)(row);
+ ovsdb_idl_row_parse(row);
- ovsdb_idl_row_reparse_backrefs(row, false);
+ ovsdb_idl_row_reparse_backrefs(row);
}
static void
ovsdb_idl_delete_row(struct ovsdb_idl_row *row)
{
- (row->table->class->unparse)(row);
+ ovsdb_idl_row_unparse(row);
ovsdb_idl_row_clear_arcs(row, true);
ovsdb_idl_row_clear_old(row);
if (list_is_empty(&row->dst_arcs)) {
ovsdb_idl_row_destroy(row);
} else {
- ovsdb_idl_row_reparse_backrefs(row, true);
+ ovsdb_idl_row_reparse_backrefs(row);
}
}
-static void
+/* 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 json *row_json)
{
- (row->table->class->unparse)(row);
+ bool changed;
+
+ ovsdb_idl_row_unparse(row);
ovsdb_idl_row_clear_arcs(row, true);
- ovsdb_idl_row_update(row, row_json);
- (row->table->class->parse)(row);
+ changed = ovsdb_idl_row_update(row, row_json);
+ ovsdb_idl_row_parse(row);
+
+ return changed;
}
static bool
*
* 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 a row's ->parse function) and new arcs are always
+ * (in a single call to ovsdb_idl_row_parse()) and new arcs are always
* added at the front of the dst_arcs list. */
if (list_is_empty(&dst->dst_arcs)) {
return true;
dst_table = ovsdb_idl_table_from_class(idl, dst_table_class);
dst = ovsdb_idl_get_row(dst_table, dst_uuid);
- if (!dst) {
- dst = ovsdb_idl_row_create(dst_table, dst_uuid);
- }
+ if (idl->txn) {
+ /* 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.
+ *
+ * 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)) {
+ 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);
- list_push_front(&src->src_arcs, &arc->src_node);
- list_push_front(&dst->dst_arcs, &arc->dst_node);
- arc->src = src;
- arc->dst = dst;
+ /* 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);
+ list_push_front(&src->src_arcs, &arc->src_node);
+ list_push_front(&dst->dst_arcs, &arc->dst_node);
+ arc->src = src;
+ arc->dst = dst;
+ }
+
+ return !ovsdb_idl_row_is_orphan(dst) ? dst : NULL;
}
+}
- return !ovsdb_idl_row_is_orphan(dst) ? dst : NULL;
+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 *
struct ovsdb_idl_row *row;
row = CONTAINER_OF(node, struct ovsdb_idl_row, hmap_node);
- if (!ovsdb_idl_row_is_orphan(row)) {
+ if (ovsdb_idl_row_exists(row)) {
return row;
}
}
return NULL;
}
-struct ovsdb_idl_row *
+const struct ovsdb_idl_row *
ovsdb_idl_first_row(const struct ovsdb_idl *idl,
const struct ovsdb_idl_table_class *table_class)
{
return next_real_row(table, hmap_first(&table->rows));
}
-struct ovsdb_idl_row *
+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 = row->table->class;
+ size_t column_idx = column - class->columns;
+
+ assert(row->new != NULL);
+ assert(column_idx < class->n_columns);
+
+ if (row->written && bitmap_is_set(row->written, column_idx)) {
+ return &row->new[column_idx];
+ } else if (row->old) {
+ return &row->old[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)
+{
+ assert(column->type.key.type == key_type);
+ assert(column->type.value.type == value_type);
+
+ return ovsdb_idl_read(row, column);
+}
\f
/* Transactions. */
assert(!idl->txn);
idl->txn = txn = xmalloc(sizeof *txn);
+ txn->request_id = NULL;
txn->idl = idl;
- txn->status = TXN_INCOMPLETE;
hmap_init(&txn->txn_rows);
+ txn->status = TXN_INCOMPLETE;
+ txn->error = NULL;
txn->dry_run = false;
ds_init(&txn->comment);
+
txn->inc_table = NULL;
txn->inc_column = NULL;
txn->inc_where = 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)
+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');
}
- ds_put_cstr(&txn->comment, s);
+
+ va_start(args, s);
+ ds_put_format_valist(&txn->comment, s, args);
+ va_end(args);
}
void
void
ovsdb_idl_txn_destroy(struct ovsdb_idl_txn *txn)
{
+ struct ovsdb_idl_txn_insert *insert, *next;
+
+ json_destroy(txn->request_id);
if (txn->status == TXN_INCOMPLETE) {
hmap_remove(&txn->idl->outstanding_txns, &txn->hmap_node);
}
ovsdb_idl_txn_abort(txn);
ds_destroy(&txn->comment);
+ free(txn->error);
free(txn->inc_table);
free(txn->inc_column);
json_destroy(txn->inc_where);
+ HMAP_FOR_EACH_SAFE (insert, next, struct ovsdb_idl_txn_insert, hmap_node,
+ &txn->inserted_rows) {
+ free(insert);
+ }
+ hmap_destroy(&txn->inserted_rows);
free(txn);
}
{
struct ovsdb_idl_row *row, *next;
+ /* 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, next, struct ovsdb_idl_row, txn_node,
&txn->txn_rows) {
- if (row->old && row->written) {
- (row->table->class->unparse)(row);
- ovsdb_idl_row_clear_arcs(row, false);
- (row->table->class->parse)(row);
+ if (row->old) {
+ 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);
hmap_remove(&txn->txn_rows, &row->txn_node);
hmap_node_nullify(&row->txn_node);
+ if (!row->old) {
+ hmap_remove(&row->table->rows, &row->hmap_node);
+ free(row);
+ }
}
hmap_destroy(&txn->txn_rows);
hmap_init(&txn->txn_rows);
return txn->status;
}
- operations = json_array_create_empty();
+ operations = json_array_create_1(
+ json_string_create(txn->idl->class->database));
/* Add prerequisites and declarations of new rows. */
HMAP_FOR_EACH (row, struct ovsdb_idl_row, txn_node, &txn->txn_rows) {
&column->type));
}
}
- if (row->new && !row->old) {
- struct json *op;
-
- op = json_object_create();
- json_array_add(operations, op);
- json_object_put_string(op, "op", "declare");
- json_object_put(op, "uuid-name",
- json_string_create_nocopy(
- uuid_name_from_uuid(&row->uuid)));
- }
}
/* Add updates. */
if (row->old) {
json_object_put(op, "where", where_uuid_equals(&row->uuid));
} else {
+ struct ovsdb_idl_txn_insert *insert;
+
json_object_put(op, "uuid-name",
json_string_create_nocopy(
uuid_name_from_uuid(&row->uuid)));
+
+ insert = xmalloc(sizeof *insert);
+ insert->dummy = row->uuid;
+ insert->op_index = operations->u.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);
- BITMAP_FOR_EACH_1 (idx, class->n_columns, row->written) {
- const struct ovsdb_idl_column *column = &class->columns[idx];
-
- if (!row->old || !ovsdb_datum_equals(&row->old[idx],
- &row->new[idx],
- &column->type)) {
- json_object_put(row_json, column->name,
- substitute_uuids(
- ovsdb_datum_to_json(&row->new[idx],
- &column->type),
- txn));
+ 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
+ ? !ovsdb_datum_equals(&row->old[idx], &row->new[idx],
+ &column->type)
+ : !ovsdb_datum_is_default(&row->new[idx],
+ &column->type)) {
+ json_object_put(row_json, column->name,
+ substitute_uuids(
+ ovsdb_datum_to_json(&row->new[idx],
+ &column->type),
+ txn));
+ }
}
}
if (txn->inc_table && any_updates) {
struct json *op;
- txn->inc_index = operations->u.array.n;
+ txn->inc_index = operations->u.array.n - 1;
op = json_object_create();
json_object_put_string(op, "op", "mutate");
hmap_insert(&txn->idl->outstanding_txns, &txn->hmap_node,
json_hash(txn->request_id, 0));
} else {
- txn->status = TXN_INCOMPLETE;
+ txn->status = TXN_TRY_AGAIN;
}
- txn->idl->txn = NULL;
ovsdb_idl_txn_disassemble(txn);
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. */
+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;
+}
+
int64_t
ovsdb_idl_txn_get_increment_new_value(const struct ovsdb_idl_txn *txn)
{
}
}
+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 (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;
+
+ assert(txn->status == TXN_SUCCESS || txn->status == TXN_UNCHANGED);
+ HMAP_FOR_EACH_IN_BUCKET (insert, struct ovsdb_idl_txn_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)
}
void
-ovsdb_idl_txn_write(struct ovsdb_idl_row *row,
+ovsdb_idl_txn_write(const struct ovsdb_idl_row *row_,
const struct ovsdb_idl_column *column,
struct ovsdb_datum *datum)
{
+ struct ovsdb_idl_row *row = (struct ovsdb_idl_row *) row_;
const struct ovsdb_idl_table_class *class = row->table->class;
size_t column_idx = column - class->columns;
- assert(row->new);
+ assert(row->new != NULL);
+ assert(column_idx < class->n_columns);
+ assert(row->table->modes[column_idx] != OVSDB_IDL_MODE_NONE);
+
if (hmap_node_is_null(&row->txn_node)) {
hmap_insert(&row->table->idl->txn->txn_rows, &row->txn_node,
uuid_hash(&row->uuid));
bitmap_set1(row->written, column_idx);
}
row->new[column_idx] = *datum;
+ (column->unparse)(row);
+ (column->parse)(row, &row->new[column_idx]);
}
void
const struct ovsdb_idl_table_class *class = row->table->class;
size_t column_idx = column - class->columns;
- assert(row->new);
+ assert(row->new != NULL);
if (!row->old
|| (row->written && bitmap_is_set(row->written, column_idx))) {
return;
}
void
-ovsdb_idl_txn_delete(struct ovsdb_idl_row *row)
+ovsdb_idl_txn_delete(const struct ovsdb_idl_row *row_)
{
- assert(row->new);
+ struct ovsdb_idl_row *row = (struct ovsdb_idl_row *) row_;
+
+ assert(row->new != NULL);
if (!row->old) {
+ ovsdb_idl_row_unparse(row);
ovsdb_idl_row_clear_new(row);
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;
row->new = NULL;
}
-struct ovsdb_idl_row *
+const struct ovsdb_idl_row *
ovsdb_idl_txn_insert(struct ovsdb_idl_txn *txn,
- const struct ovsdb_idl_table_class *class)
+ const struct ovsdb_idl_table_class *class,
+ const struct uuid *uuid)
{
struct ovsdb_idl_row *row = ovsdb_idl_row_create__(class);
- uuid_generate(&row->uuid);
+
+ if (uuid) {
+ assert(!ovsdb_idl_txn_get_row(txn, uuid));
+ row->uuid = *uuid;
+ } else {
+ uuid_generate(&row->uuid);
+ }
+
row->table = ovsdb_idl_table_from_class(txn->idl, class);
row->new = xmalloc(class->n_columns * sizeof *row->new);
- row->written = bitmap_allocate(class->n_columns);
+ hmap_insert(&row->table->rows, &row->hmap_node, uuid_hash(&row->uuid));
hmap_insert(&txn->txn_rows, &row->txn_node, uuid_hash(&row->uuid));
return row;
}
if (txn->inc_index + 2 > results->n) {
VLOG_WARN_RL(&syntax_rl, "reply does not contain enough operations "
- "for increment (has %u, needs %u)",
+ "for increment (has %zu, needs %u)",
results->n, txn->inc_index + 2);
return false;
}
- /* We know that this is a JSON objects because the loop in
+ /* 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 (count->u.integer != 1) {
VLOG_WARN_RL(&syntax_rl,
- "\"mutate\" reply \"count\" is %"PRId64" instead of 1",
+ "\"mutate\" reply \"count\" is %lld instead of 1",
count->u.integer);
return false;
}
return false;
}
if (rows->u.array.n != 1) {
- VLOG_WARN_RL(&syntax_rl, "\"select\" reply \"rows\" has %u elements "
+ VLOG_WARN_RL(&syntax_rl, "\"select\" reply \"rows\" has %zu elements "
"instead of 1",
rows->u.array.n);
return false;
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 %zu, 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(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 bool
ovsdb_idl_txn_process_reply(struct ovsdb_idl *idl,
VLOG_WARN_RL(&syntax_rl, "reply to \"transact\" is not JSON array");
status = TXN_ERROR;
} else {
+ struct json_array *ops = &msg->result->u.array;
int hard_errors = 0;
int soft_errors = 0;
size_t i;
- for (i = 0; i < msg->result->u.array.n; i++) {
- struct json *json = msg->result->u.array.elems[i];
+ for (i = 0; i < ops->n; i++) {
+ struct json *op = ops->elems[i];
- if (json->type == JSON_NULL) {
+ 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 (json->type == JSON_OBJECT) {
+ } else if (op->type == JSON_OBJECT) {
struct json *error;
- error = shash_find_data(json_object(json), "error");
+ error = shash_find_data(json_object(op), "error");
if (error) {
if (error->type == JSON_STRING) {
if (!strcmp(error->u.string, "timed out")) {
soft_errors++;
} else if (strcmp(error->u.string, "aborted")) {
hard_errors++;
+ ovsdb_idl_txn_set_error_json(txn, op);
}
} 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 (txn->inc_table
- && !soft_errors
- && !hard_errors
- && !ovsdb_idl_txn_process_inc_reply(txn,
- json_array(msg->result))) {
- hard_errors++;
+ if (!soft_errors && !hard_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, struct ovsdb_idl_txn_insert, hmap_node,
+ &txn->inserted_rows) {
+ if (!ovsdb_idl_txn_process_insert_reply(insert, ops)) {
+ hard_errors++;
+ }
+ }
}
status = (hard_errors ? TXN_ERROR
assert(txn != NULL);
return txn;
}
+
+struct ovsdb_idl *
+ovsdb_idl_txn_get_idl (struct ovsdb_idl_txn *txn)
+{
+ return txn->idl;
+}
+
git://git.onelab.eu / sliver-openvswitch.git / blobdiff