X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=ovsdb%2Fovsdb-idlc.in;h=2426e2dacc9d966052e4c3075d0eca6d60dedcb7;hb=5a195c94ae4d663925a99b8dba761b9d961bdf9e;hp=233ec800426cb61d31cab22b5505e9078912d63d;hpb=66095e15866fb7c1f8fdf64814097bb455145fe6;p=openvswitch diff --git a/ovsdb/ovsdb-idlc.in b/ovsdb/ovsdb-idlc.in index 233ec800..2426e2da 100755 --- a/ovsdb/ovsdb-idlc.in +++ b/ovsdb/ovsdb-idlc.in @@ -1,6 +1,7 @@ #! @PYTHON@ import getopt +import os import re import sys @@ -17,7 +18,7 @@ class Error(Exception): def getMember(json, name, validTypes, description, default=None): if name in json: member = json[name] - if type(member) not in validTypes: + if len(validTypes) and type(member) not in validTypes: raise Error("%s: type mismatch for '%s' member" % (description, name)) return member @@ -43,21 +44,13 @@ class DbSchema: comment = getMember(json, 'comment', [unicode], 'database') tablesJson = mustGetMember(json, 'tables', [dict], 'database') tables = {} - for name, tableJson in tablesJson.iteritems(): - tables[name] = TableSchema.fromJson(tableJson, "%s table" % name) + 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) - def toJson(self): - d = {"name": self.name, - "tables": {}} - for name, table in self.tables.iteritems(): - d["tables"][name] = table.toJson() - if self.comment != None: - d["comment"] = self.comment - return d - class TableSchema: def __init__(self, comment, columns): self.comment = comment @@ -73,14 +66,6 @@ class TableSchema: json, "column %s in %s" % (name, description)) return TableSchema(comment, columns) - def toJson(self): - d = {"columns": {}} - for name, column in self.columns.iteritems(): - d["columns"][name] = column.toJson() - if self.comment != None: - d["comment"] = self.comment - return d - class ColumnSchema: def __init__(self, comment, type, persistent): self.comment = comment @@ -93,84 +78,398 @@ class ColumnSchema: type = Type.fromJson(mustGetMember(json, 'type', [dict, unicode], description), 'type of %s' % description) - ephemeral = getMember(json, 'ephemeral', [True,False], 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 UUID: + x = "[0-9a-fA-f]" + uuidRE = re.compile("^(%s{8})-(%s{4})-(%s{4})-(%s{4})-(%s{4})(%s{8})$" + % (x, x, x, x, x, x)) + + def __init__(self, value): + self.value = value + + @staticmethod + def fromString(s): + if not uuidRE.match(s): + raise Error("%s is not a valid UUID" % s) + return UUID(s) + + @staticmethod + def fromJson(json): + if UUID.isValidJson(json): + return UUID(json[1]) + else: + raise Error("%s is not valid JSON for a UUID" % json) + + @staticmethod + def isValidJson(json): + return len(json) == 2 and json[0] == "uuid" and uuidRE.match(json[1]) + def toJson(self): - d = {"type": self.type.toJson()} - if self.persistent == False: - d["ephemeral"] = True - if self.comment != None: - d["comment"] = self.comment - return d + return ["uuid", self.value] + + def cInitUUID(self, var): + m = re.match(self.value) + return ["%s.parts[0] = 0x%s;" % (var, m.group(1)), + "%s.parts[1] = 0x%s%s;" % (var, m.group(2), m.group(3)), + "%s.parts[2] = 0x%s%s;" % (var, m.group(4), m.group(5)), + "%s.parts[3] = 0x%s;" % (var, m.group(6))] + +class Atom: + def __init__(self, type, value): + self.type = type + self.value = value + + @staticmethod + def fromJson(type_, json): + if ((type_ == 'integer' and type(json) in [int, long]) + or (type_ == 'real' and type(json) in [int, long, float]) + or (type_ == 'boolean' and json in [True, False]) + or (type_ == 'string' and type(json) in [str, unicode])): + return Atom(type_, json) + elif type_ == 'uuid': + return UUID.fromJson(json) + else: + raise Error("%s is not valid JSON for type %s" % (json, type_)) + + def toJson(self): + if self.type == 'uuid': + return self.value.toString() + else: + return self.value + + def cInitAtom(self, var): + if self.type == 'integer': + return ['%s.integer = %d;' % (var, self.value)] + elif self.type == 'real': + return ['%s.real = %.15g;' % (var, self.value)] + elif self.type == 'boolean': + if self.value: + return ['%s.boolean = true;'] + else: + return ['%s.boolean = false;'] + elif self.type == 'string': + return ['%s.string = xstrdup("%s");' + % (var, escapeCString(self.value))] + elif self.type == 'uuid': + return self.value.cInitUUID(var) + +class BaseType: + def __init__(self, type, + enum=None, + refTable=None, + minInteger=None, maxInteger=None, + minReal=None, maxReal=None, + minLength=None, maxLength=None): + self.type = type + self.enum = enum + self.refTable = refTable + self.minInteger = minInteger + self.maxInteger = maxInteger + self.minReal = minReal + self.maxReal = maxReal + 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) + enum = getMember(json, 'enum', [], description) + if enum: + enumType = Type(atomicType, None, 0, 'unlimited') + enum = Datum.fromJson(enumType, enum) + 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) + minLength = getMember(json, 'minLength', [int], description) + maxLength = getMember(json, 'minLength', [int], description) + return BaseType(atomicType, enum, refTable, minInteger, maxInteger, minReal, maxReal, 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.enum: + stmts.append("%s.enum_ = xmalloc(sizeof *%s.enum_);" + % (var, var)) + stmts += self.enum.cInitDatum("%s.enum_" % var) + 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.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, keyRefTable=None, value=None, valueRefTable=None, - min=1, max=1): + def __init__(self, key, value=None, min=1, max=1): self.key = key - self.keyRefTable = keyRefTable self.value = value - self.valueRefTable = valueRefTable self.min = min self.max = max @staticmethod def fromJson(json, description): if type(json) == unicode: - return Type(json) + return Type(BaseType(json)) else: - key = mustGetMember(json, 'key', [unicode], description) - keyRefTable = getMember(json, 'keyRefTable', [unicode], description) - value = getMember(json, 'value', [unicode], description) - valueRefTable = getMember(json, 'valueRefTable', [unicode], description) + 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, keyRefTable, value, valueRefTable, min, max) + return Type(key, value, min, max) - def toJson(self): - if self.value == None and self.min == 1 and self.max == 1: - return self.key + 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)) + +class Datum: + def __init__(self, type, values): + self.type = type + self.values = values + + @staticmethod + def fromJson(type_, json): + if not type_.value: + if len(json) == 2 and json[0] == "set": + values = [] + for atomJson in json[1]: + values += [Atom.fromJson(type_.key, atomJson)] + else: + values = [Atom.fromJson(type_.key, json)] else: - d = {"key": self.key} - if self.value != None: - d["value"] = self.value - if self.min != 1: - d["min"] = self.min - if self.max != 1: - d["max"] = self.max - return d + if len(json) != 2 or json[0] != "map": + raise Error("%s is not valid JSON for a map" % json) + values = [] + for pairJson in json[1]: + values += [(Atom.fromJson(type_.key, pairJson[0]), + Atom.fromJson(type_.value, pairJson[1]))] + return Datum(type_, values) + + def cInitDatum(self, var): + if len(self.values) == 0: + return ["ovsdb_datum_init_empty(%s);" % var] + + s = ["%s->n = %d;" % (var, len(self.values))] + s += ["%s->keys = xmalloc(%d * sizeof *%s->keys);" + % (var, len(self.values), var)] + + for i in range(len(self.values)): + key = self.values[i] + if self.type.value: + key = key[0] + s += key.cInitAtom("%s->keys[%d]" % (var, i)) + + if self.type.value: + s += ["%s->values = xmalloc(%d * sizeof *%s->values);" + % (var, len(self.values), var)] + for i in range(len(self.values)): + value = self.values[i][1] + s += key.cInitAtom("%s->values[%d]" % (var, i)) + else: + s += ["%s->values = NULL;" % var] + + if len(self.values) > 1: + s += ["ovsdb_datum_sort_assert(%s, OVSDB_TYPE_%s);" + % (var, self.type.key.upper())] + + return s def parseSchema(filename): - file = open(filename, "r") - s = "" - for line in file: - if not line.startswith('//'): - s += line - return DbSchema.fromJson(json.loads(s)) - -def cBaseType(prefix, type, refTable=None): - if type == 'uuid' and refTable: - return "struct %s%s *" % (prefix, refTable.lower()) - else: - return {'integer': 'int64_t ', - 'real': 'double ', - 'uuid': 'struct uuid ', - 'boolean': 'bool ', - 'string': 'char *'}[type] - -def typeIsOptionalPointer(type): - return (type.min == 0 and type.max == 1 and not type.value - and (type.key == 'string' - or (type.key == 'uuid' and type.keyRefTable))) - -def cDeclComment(type): - if type.min == 1 and type.max == 1 and type.key == "string": - return "\t/* Always nonnull. */" + return DbSchema.fromJson(json.load(open(filename, "r"))) + +def annotateSchema(schemaFile, annotationFile): + schemaJson = json.load(open(schemaFile, "r")) + execfile(annotationFile, globals(), {"s": schemaJson}) + json.dump(schemaJson, sys.stdout) + +def constify(cType, const): + if (const + and cType.endswith('*') and not cType.endswith('**') + and (cType.startswith('struct uuid') or cType.startswith('char'))): + return 'const %s' % cType else: - return "" + return cType -def printCIDLHeader(schema): +def cMembers(prefix, columnName, column, const): + type = column.type + if type.min == 1 and type.max == 1: + singleton = True + pointer = '' + else: + singleton = False + if type.isOptionalPointer(): + pointer = '' + else: + pointer = '*' + + if type.value: + key = {'name': "key_%s" % columnName, + 'type': constify(type.key.toCType(prefix) + pointer, const), + 'comment': ''} + value = {'name': "value_%s" % columnName, + 'type': constify(type.value.toCType(prefix) + pointer, const), + 'comment': ''} + members = [key, value] + else: + m = {'name': columnName, + 'type': constify(type.key.toCType(prefix) + pointer, const), + 'comment': type.cDeclComment()} + members = [m] + + if not singleton and not type.isOptionalPointer(): + members.append({'name': 'n_%s' % columnName, + 'type': 'size_t ', + 'comment': ''}) + return members + +def printCIDLHeader(schemaFile): + schema = parseSchema(schemaFile) prefix = schema.idlPrefix print '''\ /* Generated automatically -- do not modify! -*- buffer-read-only: t -*- */ @@ -183,38 +482,68 @@ def printCIDLHeader(schema): #include #include "ovsdb-idl-provider.h" #include "uuid.h"''' % {'prefix': prefix.upper()} - for tableName, table in schema.tables.iteritems(): - print - print "/* %s table. */" % tableName + + for tableName, table in sorted(schema.tables.iteritems()): structName = "%s%s" % (prefix, tableName.lower()) + + print " " + print "/* %s table. */" % tableName print "struct %s {" % structName print "\tstruct ovsdb_idl_row header_;" - for columnName, column in table.columns.iteritems(): + for columnName, column in sorted(table.columns.iteritems()): print "\n\t/* %s column. */" % columnName - type = column.type - if type.min == 1 and type.max == 1: - singleton = True - pointer = '' - else: - singleton = False - if typeIsOptionalPointer(type): - pointer = '' - else: - pointer = '*' - if type.value: - print "\t%s%skey_%s;" % (cBaseType(prefix, type.key, type.keyRefTable), pointer, columnName) - print "\t%s%svalue_%s;" % (cBaseType(prefix, type.value, type.valueRefTable), pointer, columnName) - else: - print "\t%s%s%s;%s" % (cBaseType(prefix, type.key, type.keyRefTable), pointer, columnName, cDeclComment(type)) - if not singleton and not typeIsOptionalPointer(type): - print "\tsize_t n_%s;" % columnName - print '''\ -}; + for member in cMembers(prefix, columnName, column, False): + print "\t%(type)s%(name)s;%(comment)s" % member + print "};" + + # Column indexes. + printEnum(["%s_COL_%s" % (structName.upper(), columnName.upper()) + for columnName in sorted(table.columns)] + + ["%s_N_COLUMNS" % structName.upper()]) + + print + for columnName in table.columns: + print "#define %(s)s_col_%(c)s (%(s)s_columns[%(S)s_COL_%(C)s])" % { + 's': structName, + 'S': structName.upper(), + 'c': columnName, + 'C': columnName.upper()} + + print "\nextern struct ovsdb_idl_column %s_columns[%s_N_COLUMNS];" % (structName, structName.upper()) + print ''' 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))''' % {'s': structName, 'S': structName.upper()} +#define %(S)s_FOR_EACH(ROW, IDL) for ((ROW) = %(s)s_first(IDL); (ROW); (ROW) = %(s)s_next(ROW)) + +void %(s)s_delete(const struct %(s)s *); +struct %(s)s *%(s)s_insert(struct ovsdb_idl_txn *); +''' % {'s': structName, 'S': structName.upper()} + + for columnName, column in sorted(table.columns.iteritems()): + print 'void %(s)s_verify_%(c)s(const struct %(s)s *);' % {'s': structName, 'c': columnName} + + 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)] + print '%s);' % ', '.join(args) + + # Table indexes. + printEnum(["%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])" % { + 'p': prefix, + 'P': prefix.upper(), + 't': tableName.lower(), + 'T': tableName.upper()} + print "\nextern struct ovsdb_idl_table_class %stable_classes[%sN_TABLES];" % (prefix, prefix.upper()) + print "\nextern struct ovsdb_idl_class %sidl_class;" % prefix + print "\nvoid %sinit(void);" % prefix print "\n#endif /* %(prefix)sIDL_HEADER */" % {'prefix': prefix.upper()} def printEnum(members): @@ -227,33 +556,35 @@ def printEnum(members): print " %s" % members[-1] print "};" -def printCIDLSource(schema): +def printCIDLSource(schemaFile): + schema = parseSchema(schemaFile) prefix = schema.idlPrefix print '''\ /* Generated automatically -- do not modify! -*- buffer-read-only: t -*- */ #include #include %s +#include #include -#include "ovsdb-data.h"''' % schema.idlHeader +#include "ovsdb-data.h" +#include "ovsdb-error.h" - # Table indexes. - printEnum(["%sTABLE_%s" % (prefix.upper(), tableName.upper()) for tableName in schema.tables] + ["%sN_TABLES" % prefix.upper()]) - print "\nstatic struct ovsdb_idl_table_class %stable_classes[%sN_TABLES];" % (prefix, prefix.upper()) +static bool inited; +''' % schema.idlHeader # Cast functions. - for tableName, table in schema.tables.iteritems(): + for tableName, table in sorted(schema.tables.iteritems()): structName = "%s%s" % (prefix, tableName.lower()) print ''' static struct %(s)s * -%(s)s_cast(struct ovsdb_idl_row *row) +%(s)s_cast(const struct ovsdb_idl_row *row) { return row ? CONTAINER_OF(row, struct %(s)s, header_) : NULL; }\ ''' % {'s': structName} - for tableName, table in schema.tables.iteritems(): + for tableName, table in sorted(schema.tables.iteritems()): structName = "%s%s" % (prefix, tableName.lower()) print " " if table.comment != None: @@ -261,29 +592,16 @@ static struct %(s)s * else: print "/* %s table. */" % (tableName) - # Column indexes. - printEnum(["%s_COL_%s" % (structName.upper(), columnName.upper()) - for columnName in table.columns] - + ["%s_N_COLUMNS" % structName.upper()]) - - # Parse function. - print '''\ + # Parse functions. + for columnName, column in sorted(table.columns.iteritems()): + print ''' static void -%s_parse(struct ovsdb_idl_row *row_) +%(s)s_parse_%(c)s(struct ovsdb_idl_row *row_, const struct ovsdb_datum *datum) { - struct %s *row = %s_cast(row_); - const struct ovsdb_datum *datum; - size_t i UNUSED; + struct %(s)s *row = %(s)s_cast(row_);''' % {'s': structName, + 'c': columnName} - memset(row_ + 1, 0, sizeof *row - sizeof *row_);''' % (structName, structName, structName) - - - for columnName, column in table.columns.iteritems(): type = column.type - refKey = type.key == "uuid" and type.keyRefTable - refValue = type.value == "uuid" and type.valueRefTable - print - print " datum = &row_->fields[%s_COL_%s];" % (structName.upper(), columnName.upper()) if type.value: keyVar = "row->key_%s" % columnName valueVar = "row->value_%s" % columnName @@ -291,46 +609,52 @@ static void keyVar = "row->%s" % columnName valueVar = None - if (type.min == 1 and type.max == 1) or typeIsOptionalPointer(type): + if (type.min == 1 and type.max == 1) or type.isOptionalPointer(): + print + print " assert(inited);" print " if (datum->n >= 1) {" - if not refKey: - print " %s = datum->keys[0].%s;" % (keyVar, type.key) + if not type.key.refTable: + print " %s = datum->keys[0].%s;" % (keyVar, type.key.type) else: - print " %s = %s%s_cast(ovsdb_idl_get_row_arc(row_, &%stable_classes[%sTABLE_%s], &datum->keys[0].uuid));" % (keyVar, prefix, type.keyRefTable.lower(), prefix, prefix.upper(), type.keyRefTable.upper()) + 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()) if valueVar: - if refValue: - print " %s = datum->values[0].%s;" % (valueVar, type.value) + if type.value.refTable: + print " %s = datum->values[0].%s;" % (valueVar, type.value.type) else: - print " %s = %s%s_cast(ovsdb_idl_get_row_arc(row_, &%stable_classes[%sTABLE_%s], &datum->values[0].uuid));" % (valueVar, prefix, type.valueRefTable.lower(), prefix, prefix.upper(), type.valueRefTable.upper()) - if (not typeIsOptionalPointer(type) and - (type.key == "string" or type.value == "string")): - print " } else {" - if type.key == "string": - print " %s = \"\";" % keyVar - if type.value == "string": - print " %s = \"\";" % valueVar + 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 " } else {" + print " %s" % type.key.initCDefault(keyVar, type.min == 0) + if valueVar: + print " %s" % type.value.initCDefault(valueVar, type.min == 0) print " }" - else: if type.max != 'unlimited': - nMax = "MIN(%d, datum->n)" % type.max + print " size_t n = MIN(%d, datum->n);" % type.max + nMax = "n" else: nMax = "datum->n" + print " size_t i;" + print + print " 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 refKey: - print " struct %s%s *keyRow = %s%s_cast(ovsdb_idl_get_row_arc(row_, &%stable_classes[%sTABLE_%s], &datum->keys[i].uuid));" % (prefix, type.keyRefTable.lower(), prefix, type.keyRefTable.lower(), prefix, prefix.upper(), type.keyRefTable.upper()) + 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()) keySrc = "keyRow" refs.append('keyRow') else: - keySrc = "datum->keys[i].%s" % type.key - if refValue: - print " struct %s%s *valueRow = %s%s_cast(ovsdb_idl_get_row_arc(row_, &%stable_classes[%sTABLE_%s], &datum->values[i].uuid));" % (prefix, type.valueRefTable.lower(), prefix, type.valueRefTable.lower(), prefix, prefix.upper(), type.valueRefTable.upper()) + 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()) valueSrc = "valueRow" refs.append('valueRow') elif valueVar: - valueSrc = "datum->values[i].%s" % type.value + valueSrc = "datum->values[i].%s" % type.value.type if refs: print " if (%s) {" % ' && '.join(refs) indent = " " @@ -348,20 +672,19 @@ static void if refs: print " }" print " }" - print "}" + print "}" - # Unparse function. - nArrays = 0 - for columnName, column in table.columns.iteritems(): + # Unparse functions. + for columnName, column in sorted(table.columns.iteritems()): type = column.type - if (type.min != 1 or type.max != 1) and not typeIsOptionalPointer(type): - if not nArrays: - print ''' + if (type.min != 1 or type.max != 1) and not type.isOptionalPointer(): + print ''' static void -%s_unparse(struct ovsdb_idl_row *row_) +%(s)s_unparse_%(c)s(struct ovsdb_idl_row *row_) { - struct %s *row = %s_cast(row_); -''' % (structName, structName, structName) + 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 @@ -371,14 +694,15 @@ static void print " free(%s);" % keyVar if valueVar: print " free(%s);" % valueVar - nArrays += 1 - if not nArrays: - print ''' + print '}' + else: + print ''' static void -%s_unparse(struct ovsdb_idl_row *row UNUSED) -{''' % (structName) - print "}" - +%(s)s_unparse_%(c)s(struct ovsdb_idl_row *row OVS_UNUSED) +{ + /* Nothing to do. */ +}''' % {'s': structName, 'c': columnName} + # First, next functions. print ''' const struct %(s)s * @@ -391,45 +715,157 @@ const struct %(s)s * %(s)s_next(const struct %(s)s *row) { return %(s)s_cast(ovsdb_idl_next_row(&row->header_)); -}''' % {'s': structName, 'p': prefix, 'P': prefix.upper(), 'T': tableName.upper()} +}''' % {'s': structName, + 'p': prefix, + 'P': prefix.upper(), + 'T': tableName.upper()} - # Table columns. - print "\nstatic struct ovsdb_idl_column %s_columns[%s_N_COLUMNS] = {" % ( - structName, structName.upper()) - for columnName, column in table.columns.iteritems(): + print ''' +void +%(s)s_delete(const struct %(s)s *row) +{ + ovsdb_idl_txn_delete(&row->header_); +} + +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])); +} +''' % {'s': structName, + 'p': prefix, + 'P': prefix.upper(), + 'T': tableName.upper()} + + # Verify functions. + for columnName, column in sorted(table.columns.iteritems()): + print ''' +void +%(s)s_verify_%(c)s(const struct %(s)s *row) +{ + 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()} + + # Set functions. + for columnName, column in sorted(table.columns.iteritems()): type = column.type - + print '\nvoid' + members = cMembers(prefix, columnName, column, True) + keyVar = members[0]['name'] + nVar = None + valueVar = None if type.value: - valueTypeName = type.value.upper() + valueVar = members[1]['name'] + if len(members) > 2: + nVar = members[2]['name'] else: - valueTypeName = "VOID" - if type.max == "unlimited": - max = "UINT_MAX" + if len(members) > 1: + nVar = members[1]['name'] + 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: + print + print " 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) + if type.value: + print " datum.values = xmalloc(sizeof *datum.values);" + print " "+ type.value.copyCValue("datum.values[0].%s" % type.value.type, valueVar) + else: + print " datum.values = NULL;" + elif type.isOptionalPointer(): + print + print " 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 " } else {" + print " datum.n = 0;" + print " datum.keys = NULL;" + print " }" + print " datum.values = NULL;" else: - max = type.max - print " {\"%s\", {OVSDB_TYPE_%s, OVSDB_TYPE_%s, %d, %s}}," % ( - columnName, type.key.upper(), valueTypeName, - type.min, max) - print "};" + print " size_t i;" + print + print " assert(inited);" + print " datum.n = %s;" % nVar + print " datum.keys = xmalloc(%s * sizeof *datum.keys);" % 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) + if type.value: + print " " + type.value.copyCValue("datum.values[i].%s" % type.value.type, "%s[i]" % valueVar) + print " }" + print " ovsdb_idl_txn_write(&row->header_, &%(s)s_columns[%(S)s_COL_%(C)s], &datum);" \ + % {'s': structName, + 'S': structName.upper(), + 'C': columnName.upper()} + print "}" + + # Table columns. + print "\nstruct ovsdb_idl_column %s_columns[%s_N_COLUMNS];" % ( + structName, structName.upper()) + print """ +static void\n%s_columns_init(void) +{ + struct ovsdb_idl_column *c;\ +""" % structName + for columnName, column in sorted(table.columns.iteritems()): + cs = "%s_col_%s" % (structName, columnName) + d = {'cs': cs, 'c': columnName, 's': structName} + 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->parse = %(s)s_parse_%(c)s;" % d + print " c->unparse = %(s)s_unparse_%(c)s;" % d + print "}" # Table classes. print " " - print "static struct ovsdb_idl_table_class %stable_classes[%sN_TABLES] = {" % (prefix, prefix.upper()) - for tableName, table in schema.tables.iteritems(): + 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 print " %s_columns, ARRAY_SIZE(%s_columns)," % ( structName, structName) - print " sizeof(struct %s)," % structName - print " %s_parse," % structName - print " %s_unparse}," % structName + print " sizeof(struct %s)}," % structName print "};" # IDL class. print "\nstruct ovsdb_idl_class %sidl_class = {" % prefix - print " %stable_classes, ARRAY_SIZE(%stable_classes)" % (prefix, prefix) + print " \"%s\", %stable_classes, ARRAY_SIZE(%stable_classes)" % ( + schema.name, prefix, prefix) print "};" + # global init function + print """ +void +%sinit(void) +{ + if (inited) { + return; + } + inited = true; +""" % prefix + for tableName, table in sorted(schema.tables.iteritems()): + structName = "%s%s" % (prefix, tableName.lower()) + print " %s_columns_init();" % structName + print "}" + def ovsdb_escape(string): def escape(match): c = match.group(0) @@ -451,20 +887,36 @@ def ovsdb_escape(string): return '\\x%02x' % ord(c) return re.sub(r'["\\\000-\037]', escape, string) -def printOVSDBSchema(schema): - json.dump(schema.toJson(), sys.stdout, sort_keys=True, indent=2) +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 -usage: %(argv0)s [OPTIONS] ACTION SCHEMA -where SCHEMA is the ovsdb schema to read (in JSON format). +usage: %(argv0)s [OPTIONS] COMMAND ARG... -One of the following actions must specified: - validate validate schema without taking any other action - c-idl-header print C header file for IDL - c-idl-source print C source file for IDL implementation - ovsdb-schema print ovsdb parseable schema +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 The following options are also available: -h, --help display this help message @@ -475,40 +927,49 @@ The following options are also available: if __name__ == "__main__": try: try: - options, args = getopt.gnu_getopt(sys.argv[1:], 'hV', - ['help', + options, args = getopt.gnu_getopt(sys.argv[1:], 'C:hV', + ['directory', + 'help', 'version']) 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() + elif key in ['-V', '--version']: + print "ovsdb-idlc (Open vSwitch) @VERSION@" + elif key in ['-C', '--directory']: + os.chdir(value) + else: + sys.exit(0) + optKeys = [key for key, value in options] - if '-h' in optKeys or '--help' in optKeys: - usage() - elif '-V' in optKeys or '--version' in optKeys: - print "ovsdb-idlc (Open vSwitch) @VERSION@" - sys.exit(0) - - if len(args) != 2: - sys.stderr.write("%s: exactly two non-option arguments are " - "required (use --help for help)\n" % argv0) + + if not args: + sys.stderr.write("%s: missing command argument " + "(use --help for help)\n" % argv0) sys.exit(1) - action, inputFile = args - schema = parseSchema(inputFile) - if action == 'validate': - pass - elif action == 'ovsdb-schema': - printOVSDBSchema(schema) - elif action == 'c-idl-header': - printCIDLHeader(schema) - elif action == 'c-idl-source': - printCIDLSource(schema) - else: - sys.stderr.write( - "%s: unknown action '%s' (use --help for help)\n" % - (argv0, action)) + commands = {"annotate": (annotateSchema, 2), + "c-idl-header": (printCIDLHeader, 1), + "c-idl-source": (printCIDLSource, 1), + "doc": (printDoc, 1)} + + if not args[0] in commands: + sys.stderr.write("%s: unknown command \"%s\" " + "(use --help for help)\n" % (argv0, args[0])) sys.exit(1) + + func, n_args = commands[args[0]] + if len(args) - 1 != n_args: + sys.stderr.write("%s: \"%s\" requires %d arguments but %d " + "provided\n" + % (argv0, args[0], n_args, len(args) - 1)) + sys.exit(1) + + func(*args[1:]) except Error, e: sys.stderr.write("%s: %s\n" % (argv0, e.msg)) sys.exit(1)