schemaJson = ovs.json.from_file(schemaFile)
execfile(annotationFile, globals(), {"s": schemaJson})
ovs.json.to_stream(schemaJson, sys.stdout)
+ sys.stdout.write('\n')
def constify(cType, const):
- if (const and cType.endswith('*') and not cType.endswith('**')):
+ if (const
+ and cType.endswith('*') and
+ (cType == 'char **' or not cType.endswith('**'))):
return 'const %s' % cType
else:
return cType
print "\nextern struct ovsdb_idl_column %s_columns[%s_N_COLUMNS];" % (structName, structName.upper())
print '''
+const struct %(s)s *%(s)s_get_for_uuid(const struct ovsdb_idl *, const struct uuid *);
const struct %(s)s *%(s)s_first(const struct ovsdb_idl *);
const struct %(s)s *%(s)s_next(const struct %(s)s *);
#define %(S)s_FOR_EACH(ROW, IDL) \\
print "\nextern struct ovsdb_idl_class %sidl_class;" % prefix
print "\nvoid %sinit(void);" % prefix
+
+ print "\nconst char * %sget_db_version(void);" % prefix
print "\n#endif /* %(prefix)sIDL_HEADER */" % {'prefix': prefix.upper()}
def printEnum(members):
#include <config.h>
#include %s
-#include <assert.h>
#include <limits.h>
+#include "ovs-thread.h"
#include "ovsdb-data.h"
#include "ovsdb-error.h"
+#include "util.h"
#ifdef __CHECKER__
/* Sparse dislikes sizeof(bool) ("warning: expression using sizeof bool"). */
if type.is_smap():
print " size_t i;"
print
- print " assert(inited);"
+ print " ovs_assert(inited);"
print " smap_init(&row->%s);" % columnName
print " for (i = 0; i < datum->n; i++) {"
print " smap_add(&row->%s," % columnName
print " }"
elif (type.n_min == 1 and type.n_max == 1) or type.is_optional_pointer():
print
- print " assert(inited);"
+ print " ovs_assert(inited);"
print " if (datum->n >= 1) {"
if not type.key.ref_table:
print " %s = datum->keys[0].%s;" % (keyVar, type.key.type.to_string())
nMax = "datum->n"
print " size_t i;"
print
- print " assert(inited);"
+ print " ovs_assert(inited);"
print " %s = NULL;" % keyVar
if valueVar:
print " %s = NULL;" % valueVar
{
struct %(s)s *row = %(s)s_cast(row_);
- assert(inited);''' % {'s': structName, 'c': columnName}
+ ovs_assert(inited);''' % {'s': structName, 'c': columnName}
if type.is_smap():
print " smap_destroy(&row->%s);" % columnName
# Row Initialization function.
print """
+/* Clears the contents of 'row' in table "%(t)s". */
void
%(s)s_init(struct %(s)s *row)
{
- memset(row, 0, sizeof *row); """ % {'s': structName}
+ memset(row, 0, sizeof *row); """ % {'s': structName, 't': tableName}
for columnName, column in sorted(table.columns.iteritems()):
if column.type.is_smap():
print " smap_init(&row->%s);" % columnName
# First, next functions.
print '''
+/* Searches table "%(t)s" in 'idl' for a row with UUID 'uuid'. Returns
+ * a pointer to the row if there is one, otherwise a null pointer. */
+const struct %(s)s *
+%(s)s_get_for_uuid(const struct ovsdb_idl *idl, const struct uuid *uuid)
+{
+ return %(s)s_cast(ovsdb_idl_get_row_for_uuid(idl, &%(p)stable_classes[%(P)sTABLE_%(T)s], uuid));
+}
+
+/* Returns a row in table "%(t)s" 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 %(s)s *
%(s)s_first(const struct ovsdb_idl *idl)
{
return %(s)s_cast(ovsdb_idl_first_row(idl, &%(p)stable_classes[%(P)sTABLE_%(T)s]));
}
+/* Returns a row following 'row' within its table, or a null pointer if 'row'
+ * is the last row in its table. */
const struct %(s)s *
%(s)s_next(const struct %(s)s *row)
{
}''' % {'s': structName,
'p': prefix,
'P': prefix.upper(),
+ 't': tableName,
'T': tableName.upper()}
print '''
+/* Deletes 'row' from table "%(t)s". 'row' may be freed, so it must not be
+ * accessed afterward.
+ *
+ * The caller must have started a transaction with ovsdb_idl_txn_create(). */
void
%(s)s_delete(const struct %(s)s *row)
{
ovsdb_idl_txn_delete(&row->header_);
}
+/* Inserts and returns a new row in the table "%(t)s" in the database
+ * with open transaction 'txn'.
+ *
+ * The new row is assigned a randomly generated provisional UUID.
+ * 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. */
struct %(s)s *
%(s)s_insert(struct ovsdb_idl_txn *txn)
{
return %(s)s_cast(ovsdb_idl_txn_insert(txn, &%(p)stable_classes[%(P)sTABLE_%(T)s], NULL));
-}
-''' % {'s': structName,
- 'p': prefix,
- 'P': prefix.upper(),
- 'T': tableName.upper()}
+}''' % {'s': structName,
+ 'p': prefix,
+ 'P': prefix.upper(),
+ 't': tableName,
+ 'T': tableName.upper()}
# Verify functions.
for columnName, column in sorted(table.columns.iteritems()):
print '''
+/* Causes the original contents of column "%(c)s" in 'row' to be
+ * verified as a prerequisite to completing the transaction. That is, if
+ * "%(c)s" 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_AGAIN_WAIT or TXN_AGAIN_NOW (depending on whether the database
+ * change has already been received).
+ *
+ * The intention is that, to ensure that no transaction commits based on dirty
+ * reads, an application should call this function any time "%(c)s" is
+ * read as part of a read-modify-write operation.
+ *
+ * In some cases this function reduces to a no-op, because the current value
+ * of "%(c)s" is already known:
+ *
+ * - If 'row' is a row created by the current transaction (returned by
+ * %(s)s_insert()).
+ *
+ * - If "%(c)s" has already been modified (with
+ * %(s)s_set_%(c)s()) within the current transaction.
+ *
+ * Because of the latter property, always call this function *before*
+ * %(s)s_set_%(c)s() for a given read-modify-write.
+ *
+ * The caller must have started a transaction with ovsdb_idl_txn_create(). */
void
%(s)s_verify_%(c)s(const struct %(s)s *row)
{
- assert(inited);
+ ovs_assert(inited);
ovsdb_idl_txn_verify(&row->header_, &%(s)s_columns[%(S)s_COL_%(C)s]);
}''' % {'s': structName,
'S': structName.upper(),
for columnName, column in sorted(table.columns.iteritems()):
if column.type.value:
valueParam = ',\n\tenum ovsdb_atomic_type value_type OVS_UNUSED'
- valueType = '\n assert(value_type == %s);' % column.type.value.toAtomicType()
+ valueType = '\n ovs_assert(value_type == %s);' % column.type.value.toAtomicType()
valueComment = "\n * 'value_type' must be %s." % column.type.value.toAtomicType()
else:
valueParam = ''
valueType = ''
valueComment = ''
print """
-/* Returns the %(c)s column's value in 'row' as a struct ovsdb_datum.
- * This is useful occasionally: for example, ovsdb_datum_find_key() is an
- * easier and more efficient way to search for a given key than implementing
- * the same operation on the "cooked" form in 'row'.
+/* Returns the "%(c)s" column's value from the "%(t)s" table in 'row'
+ * as a struct ovsdb_datum. This is useful occasionally: for example,
+ * ovsdb_datum_find_key() is an easier and more efficient way to search
+ * for a given key than implementing the same operation on the "cooked"
+ * form in 'row'.
*
* 'key_type' must be %(kt)s.%(vc)s
* (This helps to avoid silent bugs if someone changes %(c)s's
* Various kinds of changes can invalidate the returned value: modifying
* 'column' within 'row', deleting 'row', or completing an ongoing transaction.
* If the returned value is needed for a long time, it is best to make a copy
- * of it with ovsdb_datum_clone(). */
+ * of it with ovsdb_datum_clone().
+ *
+ * This function is rarely useful, since it is easier to access the value
+ * directly through the "%(c)s" member in %(s)s. */
const struct ovsdb_datum *
%(s)s_get_%(c)s(const struct %(s)s *row,
\tenum ovsdb_atomic_type key_type OVS_UNUSED%(v)s)
{
- assert(key_type == %(kt)s);%(vt)s
+ ovs_assert(key_type == %(kt)s);%(vt)s
return ovsdb_idl_read(&row->header_, &%(s)s_col_%(c)s);
-}""" % {'s': structName, 'c': columnName,
+}""" % {'t': tableName, 's': structName, 'c': columnName,
'kt': column.type.key.toAtomicType(),
'v': valueParam, 'vt': valueType, 'vc': valueComment}
if type.is_smap():
print """
void
-%(s)s_set_%(c)s(const struct %(s)s *row, const struct smap *smap)
+%(s)s_set_%(c)s(const struct %(s)s *row, const struct smap *%(c)s)
{
struct ovsdb_datum datum;
- assert(inited);
- if (smap) {
+ ovs_assert(inited);
+ if (%(c)s) {
struct smap_node *node;
size_t i;
- datum.n = smap_count(smap);
+ datum.n = smap_count(%(c)s);
datum.keys = xmalloc(datum.n * sizeof *datum.keys);
datum.values = xmalloc(datum.n * sizeof *datum.values);
i = 0;
- SMAP_FOR_EACH (node, smap) {
+ SMAP_FOR_EACH (node, %(c)s) {
datum.keys[i].string = xstrdup(node->key);
datum.values[i].string = xstrdup(node->value);
i++;
print "{"
print " struct ovsdb_datum datum;"
if type.n_min == 1 and type.n_max == 1:
+ print " union ovsdb_atom key;"
+ if type.value:
+ print " union ovsdb_atom value;"
print
- print " assert(inited);"
+ print " ovs_assert(inited);"
print " datum.n = 1;"
- print " datum.keys = xmalloc(sizeof *datum.keys);"
- print " " + type.key.copyCValue("datum.keys[0].%s" % type.key.type.to_string(), keyVar)
+ print " datum.keys = &key;"
+ print " " + type.key.assign_c_value_casting_away_const("key.%s" % type.key.type.to_string(), keyVar)
if type.value:
- print " datum.values = xmalloc(sizeof *datum.values);"
- print " "+ type.value.copyCValue("datum.values[0].%s" % type.value.type.to_string(), valueVar)
+ print " datum.values = &value;"
+ print " "+ type.value.assign_c_value_casting_away_const("value.%s" % type.value.type.to_string(), valueVar)
else:
print " datum.values = NULL;"
+ txn_write_func = "ovsdb_idl_txn_write_clone"
elif type.is_optional_pointer():
+ print " union ovsdb_atom key;"
print
- print " assert(inited);"
+ print " ovs_assert(inited);"
print " if (%s) {" % keyVar
print " datum.n = 1;"
- print " datum.keys = xmalloc(sizeof *datum.keys);"
- print " " + type.key.copyCValue("datum.keys[0].%s" % type.key.type.to_string(), keyVar)
+ print " datum.keys = &key;"
+ print " " + type.key.assign_c_value_casting_away_const("key.%s" % type.key.type.to_string(), keyVar)
+ print " } else {"
+ print " datum.n = 0;"
+ print " datum.keys = NULL;"
+ print " }"
+ print " datum.values = NULL;"
+ txn_write_func = "ovsdb_idl_txn_write_clone"
+ elif type.n_max == 1:
+ print " union ovsdb_atom key;"
+ print
+ print " ovs_assert(inited);"
+ print " if (%s) {" % nVar
+ print " datum.n = 1;"
+ print " datum.keys = &key;"
+ print " " + type.key.assign_c_value_casting_away_const("key.%s" % type.key.type.to_string(), "*" + keyVar)
print " } else {"
print " datum.n = 0;"
print " datum.keys = NULL;"
print " }"
print " datum.values = NULL;"
+ txn_write_func = "ovsdb_idl_txn_write_clone"
else:
print " size_t i;"
print
- print " assert(inited);"
+ print " ovs_assert(inited);"
print " datum.n = %s;" % nVar
- print " datum.keys = xmalloc(%s * sizeof *datum.keys);" % nVar
+ print " datum.keys = %s ? xmalloc(%s * sizeof *datum.keys) : NULL;" % (nVar, nVar)
if type.value:
print " datum.values = xmalloc(%s * sizeof *datum.values);" % nVar
else:
valueType = "OVSDB_TYPE_VOID"
print " ovsdb_datum_sort_unique(&datum, %s, %s);" % (
type.key.toAtomicType(), valueType)
- print " ovsdb_idl_txn_write(&row->header_, &%(s)s_columns[%(S)s_COL_%(C)s], &datum);" \
- % {'s': structName,
+ txn_write_func = "ovsdb_idl_txn_write"
+ print " %(f)s(&row->header_, &%(s)s_columns[%(S)s_COL_%(C)s], &datum);" \
+ % {'f': txn_write_func,
+ 's': structName,
'S': structName.upper(),
'C': columnName.upper()}
print "}"
if (inited) {
return;
}
+ assert_single_threaded();
inited = true;
""" % prefix
for tableName, table in sorted(schema.tables.iteritems()):
print " %s_columns_init();" % structName
print "}"
+ print """
+/* Return the schema version. The caller must not free the returned value. */
+const char *
+%sget_db_version(void)
+{
+ return "%s";
+}
+""" % (prefix, schema.version)
+
+
def ovsdb_escape(string):
def escape(match):
projects / cascardo / ovs.git / blobdiff