X-Git-Url: http://git.cascardo.eti.br/?a=blobdiff_plain;f=ovsdb%2Fovsdb-idlc.in;h=26b0de44519dc781d02ee071195b856e07b14570;hb=880f5c03f8641f2670d05376f5dbdda439e0cc1b;hp=a0f4a56dca62c3fc987f76f33d7c0eccd43e4106;hpb=9cb53f2613d0194b85dddfdafc11d7193d6561e3;p=cascardo%2Fovs.git diff --git a/ovsdb/ovsdb-idlc.in b/ovsdb/ovsdb-idlc.in index a0f4a56dc..26b0de445 100755 --- a/ovsdb/ovsdb-idlc.in +++ b/ovsdb/ovsdb-idlc.in @@ -5,341 +5,117 @@ import os import re import sys -sys.path.insert(0, "@abs_top_srcdir@/ovsdb") -import simplejson as json +import ovs.json +import ovs.db.error +import ovs.db.schema argv0 = sys.argv[0] -class Error(Exception): - def __init__(self, msg): - Exception.__init__(self) - self.msg = msg - -def getMember(json, name, validTypes, description, default=None): - if name in json: - member = json[name] - if type(member) not in validTypes: - raise Error("%s: type mismatch for '%s' member" - % (description, name)) - return member - return default - -def mustGetMember(json, name, expectedType, description): - member = getMember(json, name, expectedType, description) - if member == None: - raise Error("%s: missing '%s' member" % (description, name)) - return member - -class DbSchema: - def __init__(self, name, comment, tables, idlPrefix, idlHeader): - self.name = name - self.comment = comment - self.tables = tables - self.idlPrefix = idlPrefix - self.idlHeader = idlHeader - - @staticmethod - def fromJson(json): - name = mustGetMember(json, 'name', [unicode], 'database') - comment = getMember(json, 'comment', [unicode], 'database') - tablesJson = mustGetMember(json, 'tables', [dict], 'database') - tables = {} - for tableName, tableJson in tablesJson.iteritems(): - tables[tableName] = TableSchema.fromJson(tableJson, - "%s table" % tableName) - idlPrefix = mustGetMember(json, 'idlPrefix', [unicode], 'database') - idlHeader = mustGetMember(json, 'idlHeader', [unicode], 'database') - return DbSchema(name, comment, tables, idlPrefix, idlHeader) - -class TableSchema: - def __init__(self, comment, columns): - self.comment = comment - self.columns = columns - - @staticmethod - def fromJson(json, description): - comment = getMember(json, 'comment', [unicode], description) - columnsJson = mustGetMember(json, 'columns', [dict], description) - columns = {} - for name, json in columnsJson.iteritems(): - columns[name] = ColumnSchema.fromJson( - json, "column %s in %s" % (name, description)) - return TableSchema(comment, columns) - -class ColumnSchema: - def __init__(self, comment, type, persistent): - self.comment = comment - self.type = type - self.persistent = persistent - - @staticmethod - def fromJson(json, description): - comment = getMember(json, 'comment', [unicode], description) - type = Type.fromJson(mustGetMember(json, 'type', [dict, unicode], - description), - 'type of %s' % description) - ephemeral = getMember(json, 'ephemeral', [bool], description) - persistent = ephemeral != True - return ColumnSchema(comment, type, persistent) - -def escapeCString(src): - dst = "" - for c in src: - if c in "\\\"": - dst += "\\" + c - elif ord(c) < 32: - if c == '\n': - dst += '\\n' - elif c == '\r': - dst += '\\r' - elif c == '\a': - dst += '\\a' - elif c == '\b': - dst += '\\b' - elif c == '\f': - dst += '\\f' - elif c == '\t': - dst += '\\t' - elif c == '\v': - dst += '\\v' - else: - dst += '\\%03o' % ord(c) - else: - dst += c - return dst - -class BaseType: - def __init__(self, type, refTable=None, minInteger=None, maxInteger=None, - minReal=None, maxReal=None, reMatch=None, reComment=None, - minLength=None, maxLength=None): - self.type = type - self.refTable = refTable - self.minInteger = minInteger - self.maxInteger = maxInteger - self.minReal = minReal - self.maxReal = maxReal - self.reMatch = reMatch - self.reComment = reComment - self.minLength = minLength - self.maxLength = maxLength - - @staticmethod - def fromJson(json, description): - if type(json) == unicode: - return BaseType(json) - else: - atomicType = mustGetMember(json, 'type', [unicode], description) - refTable = getMember(json, 'refTable', [unicode], description) - minInteger = getMember(json, 'minInteger', [int, long], description) - maxInteger = getMember(json, 'maxInteger', [int, long], description) - minReal = getMember(json, 'minReal', [int, long, float], description) - maxReal = getMember(json, 'maxReal', [int, long, float], description) - reMatch = getMember(json, 'reMatch', [unicode], description) - reComment = getMember(json, 'reComment', [unicode], description) - minLength = getMember(json, 'minLength', [int], description) - maxLength = getMember(json, 'minLength', [int], description) - return BaseType(atomicType, refTable, minInteger, maxInteger, minReal, maxReal, reMatch, reComment, minLength, maxLength) - - def toEnglish(self): - if self.type == 'uuid' and self.refTable: - return self.refTable - else: - return self.type - - def toCType(self, prefix): - if self.refTable: - return "struct %s%s *" % (prefix, self.refTable.lower()) - else: - return {'integer': 'int64_t ', - 'real': 'double ', - 'uuid': 'struct uuid ', - 'boolean': 'bool ', - 'string': 'char *'}[self.type] - - def copyCValue(self, dst, src): - args = {'dst': dst, 'src': src} - if self.refTable: - return ("%(dst)s = %(src)s->header_.uuid;") % args - elif self.type == 'string': - return "%(dst)s = xstrdup(%(src)s);" % args - else: - return "%(dst)s = %(src)s;" % args - - def initCDefault(self, var, isOptional): - if self.refTable: - return "%s = NULL;" % var - elif self.type == 'string' and not isOptional: - return "%s = \"\";" % var - else: - return {'integer': '%s = 0;', - 'real': '%s = 0.0;', - 'uuid': 'uuid_zero(&%s);', - 'boolean': '%s = false;', - 'string': '%s = NULL;'}[self.type] % var - - def cInitBaseType(self, indent, var): - stmts = [] - stmts.append('ovsdb_base_type_init(&%s, OVSDB_TYPE_%s);' % ( - var, self.type.upper()),) - if self.type == 'integer': - if self.minInteger != None: - stmts.append('%s.u.integer.min = %d;' % (var, self.minInteger)) - if self.maxInteger != None: - stmts.append('%s.u.integer.max = %d;' % (var, self.maxInteger)) - elif self.type == 'real': - if self.minReal != None: - stmts.append('%s.u.real.min = %d;' % (var, self.minReal)) - if self.maxReal != None: - stmts.append('%s.u.real.max = %d;' % (var, self.maxReal)) - elif self.type == 'string': - if self.reMatch != None: - if self.reComment != None: - reComment = '"%s"' % escapeCString(self.reComment) - else: - reComment = NULL - stmts.append('do_set_regex(&%s, "%s", %s);' % ( - var, escapeCString(self.reMatch), reComment)) - if self.minLength != None: - stmts.append('%s.u.string.minLen = %d;' % (var, self.minLength)) - if self.maxLength != None: - stmts.append('%s.u.string.maxLen = %d;' % (var, self.maxLength)) - elif self.type == 'uuid': - if self.refTable != None: - stmts.append('%s.u.uuid.refTableName = "%s";' % (var, escapeCString(self.refTable))) - return '\n'.join([indent + stmt for stmt in stmts]) - -class Type: - def __init__(self, key, value=None, min=1, max=1): - self.key = key - self.value = value - self.min = min - self.max = max - - @staticmethod - def fromJson(json, description): - if type(json) == unicode: - return Type(BaseType(json)) - else: - keyJson = mustGetMember(json, 'key', [dict, unicode], description) - key = BaseType.fromJson(keyJson, 'key in %s' % description) - - valueJson = getMember(json, 'value', [dict, unicode], description) - if valueJson: - value = BaseType.fromJson(valueJson, - 'value in %s' % description) - else: - value = None - - min = getMember(json, 'min', [int], description, 1) - max = getMember(json, 'max', [int, unicode], description, 1) - return Type(key, value, min, max) - - def isScalar(self): - return self.min == 1 and self.max == 1 and not self.value - - def isOptional(self): - return self.min == 0 and self.max == 1 - - def isOptionalPointer(self): - return (self.min == 0 and self.max == 1 and not self.value - and (self.key.type == 'string' or self.key.refTable)) - - def toEnglish(self): - keyName = self.key.toEnglish() - if self.value: - valueName = self.value.toEnglish() - - if self.isScalar(): - return keyName - elif self.isOptional(): - if self.value: - return "optional %s-%s pair" % (keyName, valueName) - else: - return "optional %s" % keyName - else: - if self.max == "unlimited": - if self.min: - quantity = "%d or more " % self.min - else: - quantity = "" - elif self.min: - quantity = "%d to %d " % (self.min, self.max) - else: - quantity = "up to %d " % self.max - - if self.value: - return "map of %s%s-%s pairs" % (quantity, keyName, valueName) - else: - return "set of %s%s" % (quantity, keyName) - - def cDeclComment(self): - if self.min == 1 and self.max == 1 and self.key.type == "string": - return "\t/* Always nonnull. */" - else: - return "" - - def cInitType(self, indent, var): - initKey = self.key.cInitBaseType(indent, "%s.key" % var) - if self.value: - initValue = self.value.cInitBaseType(indent, "%s.value" % var) - else: - initValue = ('%sovsdb_base_type_init(&%s.value, ' - 'OVSDB_TYPE_VOID);' % (indent, var)) - initMin = "%s%s.n_min = %s;" % (indent, var, self.min) - if self.max == "unlimited": - max = "UINT_MAX" - else: - max = self.max - initMax = "%s%s.n_max = %s;" % (indent, var, max) - return "\n".join((initKey, initValue, initMin, initMax)) - def parseSchema(filename): - return DbSchema.fromJson(json.load(open(filename, "r"))) + return ovs.db.schema.IdlSchema.from_json(ovs.json.from_file(filename)) def annotateSchema(schemaFile, annotationFile): - schemaJson = json.load(open(schemaFile, "r")) + schemaJson = ovs.json.from_file(schemaFile) execfile(annotationFile, globals(), {"s": schemaJson}) - json.dump(schemaJson, sys.stdout) + ovs.json.to_stream(schemaJson, sys.stdout) + sys.stdout.write('\n') def constify(cType, const): if (const - and cType.endswith('*') and not cType.endswith('**') - and (cType.startswith('struct uuid') or cType.startswith('char'))): + and cType.endswith('*') and + (cType == 'char **' or not cType.endswith('**'))): return 'const %s' % cType else: return cType -def cMembers(prefix, columnName, column, const): +def cMembers(prefix, tableName, columnName, column, const): + comment = "" type = column.type - if type.min == 1 and type.max == 1: + + if type.is_smap(): + comment = """ +/* Sets the "%(c)s" column's value from the "%(t)s" table in 'row' + * to '%(c)s'. + * + * The caller retains ownership of '%(c)s' and everything in it. */""" \ + % {'c': columnName, + 't': tableName} + return (comment, [{'name': columnName, + 'type': 'struct smap ', + 'comment': ''}]) + + comment = """\n/* Sets the "%s" column from the "%s" table in """\ + """'row' to\n""" % (columnName, tableName) + + if type.n_min == 1 and type.n_max == 1: singleton = True pointer = '' else: singleton = False - if type.isOptionalPointer(): + if type.is_optional_pointer(): pointer = '' else: pointer = '*' + if type.value: - key = {'name': "key_%s" % columnName, + keyName = "key_%s" % columnName + valueName = "value_%s" % columnName + + key = {'name': keyName, 'type': constify(type.key.toCType(prefix) + pointer, const), 'comment': ''} - value = {'name': "value_%s" % columnName, + value = {'name': valueName, 'type': constify(type.value.toCType(prefix) + pointer, const), 'comment': ''} + + if singleton: + comment += " * the map with key '%s' and value '%s'\n *" \ + % (keyName, valueName) + else: + comment += " * the map with keys '%s' and values '%s'\n *" \ + % (keyName, valueName) members = [key, value] else: m = {'name': columnName, 'type': constify(type.key.toCType(prefix) + pointer, const), 'comment': type.cDeclComment()} + + if singleton: + comment += " * '%s'" % columnName + else: + comment += " * the '%s' set" % columnName members = [m] - if not singleton and not type.isOptionalPointer(): - members.append({'name': 'n_%s' % columnName, + if not singleton and not type.is_optional_pointer(): + sizeName = "n_%s" % columnName + + comment += " with '%s' entries" % sizeName + members.append({'name': sizeName, 'type': 'size_t ', 'comment': ''}) - return members + + comment += ".\n" + + if type.is_optional() and not type.is_optional_pointer(): + comment += """ * + * '%s' may be 0 or 1; if it is 0, then '%s' + * may be NULL.\n""" \ + % ("n_%s" % columnName, columnName) + + if type.is_optional_pointer(): + comment += """ * + * If "%s" is null, the column will be the empty set, + * otherwise it will contain the specified value.\n""" % columnName + + if type.constraintsToEnglish(): + comment += """ * + * Argument constraints: %s\n""" \ + % type.constraintsToEnglish(lambda s : '"%s"' % s) + + comment += " *\n * The caller retains ownership of the arguments. */" + + return (comment, members) def printCIDLHeader(schemaFile): schema = parseSchema(schemaFile) @@ -353,7 +129,9 @@ def printCIDLHeader(schemaFile): #include #include #include +#include "ovsdb-data.h" #include "ovsdb-idl-provider.h" +#include "smap.h" #include "uuid.h"''' % {'prefix': prefix.upper()} for tableName, table in sorted(schema.tables.iteritems()): @@ -365,12 +143,14 @@ def printCIDLHeader(schemaFile): print "\tstruct ovsdb_idl_row header_;" for columnName, column in sorted(table.columns.iteritems()): print "\n\t/* %s column. */" % columnName - for member in cMembers(prefix, columnName, column, False): + comment, members = cMembers(prefix, tableName, + columnName, column, False) + for member in members: print "\t%(type)s%(name)s;%(comment)s" % member print "};" # Column indexes. - printEnum(["%s_COL_%s" % (structName.upper(), columnName.upper()) + printEnum("%s_column_id" % structName.lower(), ["%s_COL_%s" % (structName.upper(), columnName.upper()) for columnName in sorted(table.columns)] + ["%s_N_COLUMNS" % structName.upper()]) @@ -385,12 +165,31 @@ def printCIDLHeader(schemaFile): 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) for ((ROW) = %(s)s_first(IDL); (ROW); (ROW) = %(s)s_next(ROW)) - +#define %(S)s_FOR_EACH(ROW, IDL) \\ + for ((ROW) = %(s)s_first(IDL); \\ + (ROW); \\ + (ROW) = %(s)s_next(ROW)) +#define %(S)s_FOR_EACH_SAFE(ROW, NEXT, IDL) \\ + for ((ROW) = %(s)s_first(IDL); \\ + (ROW) ? ((NEXT) = %(s)s_next(ROW), 1) : 0; \\ + (ROW) = (NEXT)) + +unsigned int %(s)s_get_seqno(const struct ovsdb_idl *); +unsigned int %(s)s_row_get_seqno(const struct %(s)s *row, enum ovsdb_idl_change change); +const struct %(s)s *%(s)s_track_get_first(const struct ovsdb_idl *); +const struct %(s)s *%(s)s_track_get_next(const struct %(s)s *); +#define %(S)s_FOR_EACH_TRACKED(ROW, IDL) \\ + for ((ROW) = %(s)s_track_get_first(IDL); \\ + (ROW); \\ + (ROW) = %(s)s_track_get_next(ROW)) + +void %(s)s_init(struct %(s)s *); void %(s)s_delete(const struct %(s)s *); struct %(s)s *%(s)s_insert(struct ovsdb_idl_txn *); +bool %(s)s_is_updated(const struct %(s)s *, enum %(s)s_column_id); ''' % {'s': structName, 'S': structName.upper()} for columnName, column in sorted(table.columns.iteritems()): @@ -398,14 +197,28 @@ struct %(s)s *%(s)s_insert(struct ovsdb_idl_txn *); print for columnName, column in sorted(table.columns.iteritems()): + if column.type.value: + valueParam = ', enum ovsdb_atomic_type value_type' + else: + valueParam = '' + print 'const struct ovsdb_datum *%(s)s_get_%(c)s(const struct %(s)s *, enum ovsdb_atomic_type key_type%(v)s);' % { + 's': structName, 'c': columnName, 'v': valueParam} + print + for columnName, column in sorted(table.columns.iteritems()): print 'void %(s)s_set_%(c)s(const struct %(s)s *,' % {'s': structName, 'c': columnName}, - args = ['%(type)s%(name)s' % member for member - in cMembers(prefix, columnName, column, True)] + if column.type.is_smap(): + args = ['const struct smap *'] + else: + comment, members = cMembers(prefix, tableName, columnName, + column, True) + args = ['%(type)s%(name)s' % member for member in members] print '%s);' % ', '.join(args) + print + # Table indexes. - printEnum(["%sTABLE_%s" % (prefix.upper(), tableName.upper()) for tableName in sorted(schema.tables)] + ["%sN_TABLES" % prefix.upper()]) + printEnum("%stable_id" % prefix.lower(), ["%sTABLE_%s" % (prefix.upper(), tableName.upper()) for tableName in sorted(schema.tables)] + ["%sN_TABLES" % prefix.upper()]) print for tableName in schema.tables: print "#define %(p)stable_%(t)s (%(p)stable_classes[%(P)sTABLE_%(T)s])" % { @@ -417,13 +230,15 @@ struct %(s)s *%(s)s_insert(struct ovsdb_idl_txn *); 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): +def printEnum(type, members): if len(members) == 0: return - print "\nenum {"; + print "\nenum %s {" % type for member in members[:-1]: print " %s," % member print " %s" % members[-1] @@ -437,27 +252,21 @@ def printCIDLSource(schemaFile): #include #include %s -#include #include +#include "ovs-thread.h" #include "ovsdb-data.h" #include "ovsdb-error.h" +#include "util.h" -static bool inited; +#ifdef __CHECKER__ +/* Sparse dislikes sizeof(bool) ("warning: expression using sizeof bool"). */ +enum { sizeof_bool = 1 }; +#else +enum { sizeof_bool = sizeof(bool) }; +#endif -static void UNUSED -do_set_regex(struct ovsdb_base_type *base, const char *reMatch, - const char *reComment) -{ - struct ovsdb_error *error; - - error = ovsdb_base_type_set_regex(base, reMatch, reComment); - if (error) { - char *s = ovsdb_error_to_string(error); - ovs_error(0, "%%s", s); - free(s); - ovsdb_error_destroy(error); - } -}''' % schema.idlHeader +static bool inited; +''' % schema.idlHeader # Cast functions. for tableName, table in sorted(schema.tables.iteritems()): @@ -474,10 +283,7 @@ static struct %(s)s * for tableName, table in sorted(schema.tables.iteritems()): structName = "%s%s" % (prefix, tableName.lower()) print " " - if table.comment != None: - print "/* %s table (%s). */" % (tableName, table.comment) - else: - print "/* %s table. */" % (tableName) + print "/* %s table. */" % (tableName) # Parse functions. for columnName, column in sorted(table.columns.iteritems()): @@ -487,7 +293,6 @@ static void { struct %(s)s *row = %(s)s_cast(row_);''' % {'s': structName, 'c': columnName} - type = column.type if type.value: keyVar = "row->key_%s" % columnName @@ -496,61 +301,86 @@ static void keyVar = "row->%s" % columnName valueVar = None - if (type.min == 1 and type.max == 1) or type.isOptionalPointer(): + if type.is_smap(): + print " size_t i;" + print + 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 " datum->keys[i].string," + print " datum->values[i].string);" + 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.refTable: - print " %s = datum->keys[0].%s;" % (keyVar, type.key.type) + if not type.key.ref_table: + print " %s = datum->keys[0].%s;" % (keyVar, type.key.type.to_string()) else: - print " %s = %s%s_cast(ovsdb_idl_get_row_arc(row_, &%stable_classes[%sTABLE_%s], &datum->keys[0].uuid));" % (keyVar, prefix, type.key.refTable.lower(), prefix, prefix.upper(), type.key.refTable.upper()) + print " %s = %s%s_cast(ovsdb_idl_get_row_arc(row_, &%stable_classes[%sTABLE_%s], &datum->keys[0].uuid));" % (keyVar, prefix, type.key.ref_table.name.lower(), prefix, prefix.upper(), type.key.ref_table.name.upper()) if valueVar: - if type.value.refTable: - print " %s = datum->values[0].%s;" % (valueVar, type.value.type) + if type.value.ref_table: + print " %s = datum->values[0].%s;" % (valueVar, type.value.type.to_string()) else: - print " %s = %s%s_cast(ovsdb_idl_get_row_arc(row_, &%stable_classes[%sTABLE_%s], &datum->values[0].uuid));" % (valueVar, prefix, type.value.refTable.lower(), prefix, prefix.upper(), type.value.refTable.upper()) + print " %s = %s%s_cast(ovsdb_idl_get_row_arc(row_, &%stable_classes[%sTABLE_%s], &datum->values[0].uuid));" % (valueVar, prefix, type.value.ref_table.name.lower(), prefix, prefix.upper(), type.value.ref_table.name.upper()) print " } else {" - print " %s" % type.key.initCDefault(keyVar, type.min == 0) + print " %s" % type.key.initCDefault(keyVar, type.n_min == 0) if valueVar: - print " %s" % type.value.initCDefault(valueVar, type.min == 0) + print " %s" % type.value.initCDefault(valueVar, type.n_min == 0) print " }" else: - if type.max != 'unlimited': - print " size_t n = MIN(%d, datum->n);" % type.max + if type.n_max != sys.maxint: + print " size_t n = MIN(%d, datum->n);" % type.n_max nMax = "n" else: 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 print " row->n_%s = 0;" % columnName print " for (i = 0; i < %s; i++) {" % nMax refs = [] - if type.key.refTable: - print " struct %s%s *keyRow = %s%s_cast(ovsdb_idl_get_row_arc(row_, &%stable_classes[%sTABLE_%s], &datum->keys[i].uuid));" % (prefix, type.key.refTable.lower(), prefix, type.key.refTable.lower(), prefix, prefix.upper(), type.key.refTable.upper()) + if type.key.ref_table: + print " struct %s%s *keyRow = %s%s_cast(ovsdb_idl_get_row_arc(row_, &%stable_classes[%sTABLE_%s], &datum->keys[i].uuid));" % (prefix, type.key.ref_table.name.lower(), prefix, type.key.ref_table.name.lower(), prefix, prefix.upper(), type.key.ref_table.name.upper()) keySrc = "keyRow" refs.append('keyRow') else: - keySrc = "datum->keys[i].%s" % type.key.type - if type.value and type.value.refTable: - print " struct %s%s *valueRow = %s%s_cast(ovsdb_idl_get_row_arc(row_, &%stable_classes[%sTABLE_%s], &datum->values[i].uuid));" % (prefix, type.value.refTable.lower(), prefix, type.value.refTable.lower(), prefix, prefix.upper(), type.value.refTable.upper()) + keySrc = "datum->keys[i].%s" % type.key.type.to_string() + if type.value and type.value.ref_table: + print " struct %s%s *valueRow = %s%s_cast(ovsdb_idl_get_row_arc(row_, &%stable_classes[%sTABLE_%s], &datum->values[i].uuid));" % (prefix, type.value.ref_table.name.lower(), prefix, type.value.ref_table.name.lower(), prefix, prefix.upper(), type.value.ref_table.name.upper()) valueSrc = "valueRow" refs.append('valueRow') elif valueVar: - valueSrc = "datum->values[i].%s" % type.value.type + valueSrc = "datum->values[i].%s" % type.value.type.to_string() if refs: print " if (%s) {" % ' && '.join(refs) indent = " " else: indent = " " print "%sif (!row->n_%s) {" % (indent, columnName) - print "%s %s = xmalloc(%s * sizeof *%s);" % (indent, keyVar, nMax, keyVar) + + # Special case for boolean types. This is only here because + # sparse does not like the "normal" case ("warning: expression + # using sizeof bool"). + if type.key.type == ovs.db.types.BooleanType: + sizeof = "sizeof_bool" + else: + sizeof = "sizeof *%s" % keyVar + print "%s %s = xmalloc(%s * %s);" % (indent, keyVar, nMax, + sizeof) if valueVar: - print "%s %s = xmalloc(%s * sizeof %s);" % (indent, valueVar, nMax, valueVar) + # Special case for boolean types (see above). + if type.value.type == ovs.db.types.BooleanType: + sizeof = " * sizeof_bool" + else: + sizeof = "sizeof *%s" % valueVar + print "%s %s = xmalloc(%s * %s);" % (indent, valueVar, + nMax, sizeof) print "%s}" % indent print "%s%s[row->n_%s] = %s;" % (indent, keyVar, columnName, keySrc) if valueVar: @@ -564,84 +394,269 @@ static void # Unparse functions. for columnName, column in sorted(table.columns.iteritems()): type = column.type - if (type.min != 1 or type.max != 1) and not type.isOptionalPointer(): + if type.is_smap() or (type.n_min != 1 or type.n_max != 1) and not type.is_optional_pointer(): print ''' static void %(s)s_unparse_%(c)s(struct ovsdb_idl_row *row_) { struct %(s)s *row = %(s)s_cast(row_); - assert(inited);''' % {'s': structName, 'c': columnName} - if type.value: - keyVar = "row->key_%s" % columnName - valueVar = "row->value_%s" % columnName + ovs_assert(inited);''' % {'s': structName, 'c': columnName} + + if type.is_smap(): + print " smap_destroy(&row->%s);" % columnName else: - keyVar = "row->%s" % columnName - valueVar = None - print " free(%s);" % keyVar - if valueVar: - print " free(%s);" % valueVar + if type.value: + keyVar = "row->key_%s" % columnName + valueVar = "row->value_%s" % columnName + else: + keyVar = "row->%s" % columnName + valueVar = None + print " free(%s);" % keyVar + if valueVar: + print " free(%s);" % valueVar print '}' else: print ''' static void -%(s)s_unparse_%(c)s(struct ovsdb_idl_row *row UNUSED) +%(s)s_unparse_%(c)s(struct ovsdb_idl_row *row OVS_UNUSED) { /* Nothing to do. */ }''' % {'s': structName, 'c': columnName} - + + # Generic Row Initialization function. + print """ +static void +%(s)s_init__(struct ovsdb_idl_row *row) +{ + %(s)s_init(%(s)s_cast(row)); +}""" % {'s': structName} + + # 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, 't': tableName} + for columnName, column in sorted(table.columns.iteritems()): + if column.type.is_smap(): + print " smap_init(&row->%s);" % columnName + print "}" + # 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) { return %(s)s_cast(ovsdb_idl_next_row(&row->header_)); +} + +unsigned int %(s)s_get_seqno(const struct ovsdb_idl *idl) +{ + return ovsdb_idl_table_get_seqno(idl, &%(p)stable_classes[%(P)sTABLE_%(T)s]); +} + +unsigned int %(s)s_row_get_seqno(const struct %(s)s *row, enum ovsdb_idl_change change) +{ + return ovsdb_idl_row_get_seqno(&row->header_, change); +} + +const struct %(s)s * +%(s)s_track_get_first(const struct ovsdb_idl *idl) +{ + return %(s)s_cast(ovsdb_idl_track_get_first(idl, &%(p)stable_classes[%(P)sTABLE_%(T)s])); +} + +const struct %(s)s +*%(s)s_track_get_next(const struct %(s)s *row) +{ + return %(s)s_cast(ovsdb_idl_track_get_next(&row->header_)); }''' % {'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])); + 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()} + +bool +%(s)s_is_updated(const struct %(s)s *row, enum %(s)s_column_id column) +{ + return ovsdb_idl_track_is_updated(&row->header_, &%(s)s_columns[column]); +}''' % {'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(), 'c': columnName, 'C': columnName.upper()} + # Get functions. + for columnName, column in sorted(table.columns.iteritems()): + if column.type.value: + valueParam = ',\n\tenum ovsdb_atomic_type value_type OVS_UNUSED' + 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 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 + * type without updating the caller.) + * + * The caller must not modify or free the returned value. + * + * 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(). + * + * 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) +{ + ovs_assert(key_type == %(kt)s);%(vt)s + return ovsdb_idl_read(&row->header_, &%(s)s_col_%(c)s); +}""" % {'t': tableName, 's': structName, 'c': columnName, + 'kt': column.type.key.toAtomicType(), + 'v': valueParam, 'vt': valueType, 'vc': valueComment} + # Set functions. for columnName, column in sorted(table.columns.iteritems()): type = column.type - print '\nvoid' - members = cMembers(prefix, columnName, column, True) + + comment, members = cMembers(prefix, tableName, columnName, + column, True) + + if type.is_smap(): + print comment + print """void +%(s)s_set_%(c)s(const struct %(s)s *row, const struct smap *%(c)s) +{ + struct ovsdb_datum datum; + + ovs_assert(inited); + if (%(c)s) { + struct smap_node *node; + size_t i; + + 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, %(c)s) { + datum.keys[i].string = xstrdup(node->key); + datum.values[i].string = xstrdup(node->value); + i++; + } + ovsdb_datum_sort_unique(&datum, OVSDB_TYPE_STRING, OVSDB_TYPE_STRING); + } else { + ovsdb_datum_init_empty(&datum); + } + ovsdb_idl_txn_write(&row->header_, + &%(s)s_columns[%(S)s_COL_%(C)s], + &datum); +} +""" % {'t': tableName, + 's': structName, + 'S': structName.upper(), + 'c': columnName, + 'C': columnName.upper()} + continue + keyVar = members[0]['name'] nVar = None valueVar = None @@ -652,51 +667,82 @@ void else: if len(members) > 1: nVar = members[1]['name'] + + print comment + print 'void' print '%(s)s_set_%(c)s(const struct %(s)s *row, %(args)s)' % \ {'s': structName, 'c': columnName, 'args': ', '.join(['%(type)s%(name)s' % m for m in members])} print "{" print " struct ovsdb_datum datum;" - if type.min == 1 and type.max == 1: + 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, 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, 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;" - elif type.isOptionalPointer(): + 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, 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: print " datum.values = NULL;" print " for (i = 0; i < %s; i++) {" % nVar - print " " + type.key.copyCValue("datum.keys[i].%s" % type.key.type, "%s[i]" % keyVar) + print " " + type.key.copyCValue("datum.keys[i].%s" % type.key.type.to_string(), "%s[i]" % keyVar) if type.value: - print " " + type.value.copyCValue("datum.values[i].%s" % type.value.type, "%s[i]" % valueVar) + print " " + type.value.copyCValue("datum.values[i].%s" % type.value.type.to_string(), "%s[i]" % valueVar) print " }" - print " ovsdb_idl_txn_write(&row->header_, &%(s)s_columns[%(S)s_COL_%(C)s], &datum);" \ - % {'s': structName, + if type.value: + valueType = type.value.toAtomicType() + else: + valueType = "OVSDB_TYPE_VOID" + print " ovsdb_datum_sort_unique(&datum, %s, %s);" % ( + type.key.toAtomicType(), valueType) + 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 "}" @@ -712,11 +758,16 @@ static void\n%s_columns_init(void) for columnName, column in sorted(table.columns.iteritems()): cs = "%s_col_%s" % (structName, columnName) d = {'cs': cs, 'c': columnName, 's': structName} + if column.mutable: + mutable = "true" + else: + mutable = "false" print print " /* Initialize %(cs)s. */" % d print " c = &%(cs)s;" % d print " c->name = \"%(c)s\";" % d print column.type.cInitType(" ", "c->type") + print " c->mutable = %s;" % mutable print " c->parse = %(s)s_parse_%(c)s;" % d print " c->unparse = %(s)s_unparse_%(c)s;" % d print "}" @@ -726,10 +777,14 @@ static void\n%s_columns_init(void) print "struct ovsdb_idl_table_class %stable_classes[%sN_TABLES] = {" % (prefix, prefix.upper()) for tableName, table in sorted(schema.tables.iteritems()): structName = "%s%s" % (prefix, tableName.lower()) - print " {\"%s\"," % tableName + if table.is_root: + is_root = "true" + else: + is_root = "false" + print " {\"%s\", %s," % (tableName, is_root) print " %s_columns, ARRAY_SIZE(%s_columns)," % ( structName, structName) - print " sizeof(struct %s)}," % structName + print " sizeof(struct %s), %s_init__}," % (structName, structName) print "};" # IDL class. @@ -746,6 +801,7 @@ void if (inited) { return; } + assert_single_threaded(); inited = true; """ % prefix for tableName, table in sorted(schema.tables.iteritems()): @@ -753,11 +809,22 @@ void 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): c = match.group(0) if c == '\0': - raise Error("strings may not contain null bytes") + raise ovs.db.error.Error("strings may not contain null bytes") elif c == '\\': return '\\\\' elif c == '\n': @@ -774,26 +841,6 @@ def ovsdb_escape(string): return '\\x%02x' % ord(c) return re.sub(r'["\\\000-\037]', escape, string) -def printDoc(schemaFile): - schema = parseSchema(schemaFile) - print schema.name - if schema.comment: - print schema.comment - - for tableName, table in sorted(schema.tables.iteritems()): - title = "%s table" % tableName - print - print title - print '-' * len(title) - if table.comment: - print table.comment - - for columnName, column in sorted(table.columns.iteritems()): - print - print "%s (%s)" % (columnName, column.type.toEnglish()) - if column.comment: - print "\t%s" % column.comment - def usage(): print """\ %(argv0)s: ovsdb schema compiler @@ -803,7 +850,7 @@ The following commands are supported: annotate SCHEMA ANNOTATIONS print SCHEMA combined with ANNOTATIONS c-idl-header IDL print C header file for IDL c-idl-source IDL print C source file for IDL implementation - doc IDL print schema documentation + nroff IDL print schema documentation in nroff format The following options are also available: -h, --help display this help message @@ -821,7 +868,7 @@ if __name__ == "__main__": except getopt.GetoptError, geo: sys.stderr.write("%s: %s\n" % (argv0, geo.msg)) sys.exit(1) - + for key, value in options: if key in ['-h', '--help']: usage() @@ -831,7 +878,7 @@ if __name__ == "__main__": os.chdir(value) else: sys.exit(0) - + optKeys = [key for key, value in options] if not args: @@ -841,8 +888,7 @@ if __name__ == "__main__": commands = {"annotate": (annotateSchema, 2), "c-idl-header": (printCIDLHeader, 1), - "c-idl-source": (printCIDLSource, 1), - "doc": (printDoc, 1)} + "c-idl-source": (printCIDLSource, 1)} if not args[0] in commands: sys.stderr.write("%s: unknown command \"%s\" " @@ -857,8 +903,8 @@ if __name__ == "__main__": sys.exit(1) func(*args[1:]) - except Error, e: - sys.stderr.write("%s: %s\n" % (argv0, e.msg)) + except ovs.db.error.Error, e: + sys.stderr.write("%s: %s\n" % (argv0, e)) sys.exit(1) # Local variables: