#! @PYTHON@ import getopt import os import re import sys sys.path.insert(0, "@abs_top_srcdir@/ovsdb") import simplejson as json 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) 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 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) 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 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 toJson(self): d = {"type": self.type.toJson()} if self.persistent == False: d["ephemeral"] = True if self.comment != None: d["comment"] = self.comment return d class Type: def __init__(self, key, keyRefTable=None, value=None, valueRefTable=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) 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) min = getMember(json, 'min', [int], description, 1) max = getMember(json, 'max', [int, unicode], description, 1) return Type(key, keyRefTable, value, valueRefTable, min, max) def toJson(self): if self.value == None and self.min == 1 and self.max == 1: return self.key 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 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 toEnglish(self): keyName = atomicTypeToEnglish(self.key, self.keyRefTable) if self.value: valueName = atomicTypeToEnglish(self.value, self.valueRefTable) if self.isScalar(): return atomicTypeToEnglish(self.key, self.keyRefTable) 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 atomicTypeToEnglish(base, refTable): if base == 'uuid' and refTable: return refTable else: return base def parseSchema(filename): 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 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 cCopyType(indent, dstVar, dst, src, type, refTable=None): args = {'indent': indent, 'dstVar': dstVar, 'dst': dst, 'src': src} if type == 'uuid' and refTable: return ("%(indent)s%(dstVar)s = %(src)s;\n" + "%(indent)s%(dst)s = %(src)s->header_.uuid;") % args elif type == 'string': return "%(indent)s%(dstVar)s = %(dst)s = xstrdup(%(src)s);" % args else: return "%(dstVar)s = %(dst)s = %(src)s;" % args 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. */" else: return "" 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 cType def cMembers(prefix, columnName, column, const): 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: key = {'name': "key_%s" % columnName, 'type': constify(cBaseType(prefix, type.key, type.keyRefTable) + pointer, const), 'comment': ''} value = {'name': "value_%s" % columnName, 'type': constify(cBaseType(prefix, type.value, type.valueRefTable) + pointer, const), 'comment': ''} members = [key, value] else: m = {'name': columnName, 'type': constify(cBaseType(prefix, type.key, type.keyRefTable) + pointer, const), 'comment': cDeclComment(type)} members = [m] if not singleton and not typeIsOptionalPointer(type): 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 -*- */ #ifndef %(prefix)sIDL_HEADER #define %(prefix)sIDL_HEADER 1 #include #include #include #include "ovsdb-idl-provider.h" #include "uuid.h"''' % {'prefix': prefix.upper()} for tableName, table in schema.tables.iteritems(): print print "/* %s table. */" % tableName structName = "%s%s" % (prefix, tableName.lower()) print "struct %s {" % structName print "\tstruct ovsdb_idl_row header_;" for columnName, column in table.columns.iteritems(): print "\n\t/* %s column. */" % columnName for member in cMembers(prefix, columnName, column, False): print "\t%(type)s%(name)s;%(comment)s" % member 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)) 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 table.columns.iteritems(): print 'void %(s)s_verify_%(c)s(const struct %(s)s *);' % {'s': structName, 'c': columnName} print for columnName, column in 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) print "\nextern struct ovsdb_idl_class %sidl_class;" % prefix print "\n#endif /* %(prefix)sIDL_HEADER */" % {'prefix': prefix.upper()} def printEnum(members): if len(members) == 0: return print "\nenum {"; for member in members[:-1]: print " %s," % member print " %s" % members[-1] print "};" def printCIDLSource(schemaFile): schema = parseSchema(schemaFile) prefix = schema.idlPrefix print '''\ /* Generated automatically -- do not modify! -*- buffer-read-only: t -*- */ #include #include %s #include #include "ovsdb-data.h"''' % schema.idlHeader # 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()) # Cast functions. for tableName, table in schema.tables.iteritems(): structName = "%s%s" % (prefix, tableName.lower()) print ''' static struct %(s)s * %(s)s_cast(struct ovsdb_idl_row *row) { return row ? CONTAINER_OF(row, struct %(s)s, header_) : NULL; }\ ''' % {'s': structName} for tableName, table in 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) # Column indexes. printEnum(["%s_COL_%s" % (structName.upper(), columnName.upper()) for columnName in table.columns] + ["%s_N_COLUMNS" % structName.upper()]) print "\nstatic struct ovsdb_idl_column %s_columns[];" % structName # Parse function. print ''' static void %s_parse(struct ovsdb_idl_row *row_) { struct %s *row = %s_cast(row_); const struct ovsdb_datum *datum; size_t i UNUSED; 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_->old[%s_COL_%s];" % (structName.upper(), columnName.upper()) if type.value: keyVar = "row->key_%s" % columnName valueVar = "row->value_%s" % columnName else: keyVar = "row->%s" % columnName valueVar = None if (type.min == 1 and type.max == 1) or typeIsOptionalPointer(type): print " if (datum->n >= 1) {" if not refKey: print " %s = datum->keys[0].%s;" % (keyVar, type.key) 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()) if valueVar: if refValue: print " %s = datum->values[0].%s;" % (valueVar, type.value) 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 " }" else: if type.max != 'unlimited': nMax = "MIN(%d, datum->n)" % type.max else: nMax = "datum->n" 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()) 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()) valueSrc = "valueRow" refs.append('valueRow') elif valueVar: valueSrc = "datum->values[i].%s" % type.value 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) if valueVar: print "%s %s = xmalloc(%s * sizeof %s);" % (indent, valueVar, nMax, valueVar) print "%s}" % indent print "%s%s[row->n_%s] = %s;" % (indent, keyVar, columnName, keySrc) if valueVar: print "%s%s[row->n_%s] = %s;" % (indent, valueVar, columnName, valueSrc) print "%srow->n_%s++;" % (indent, columnName) if refs: print " }" print " }" print "}" # Unparse function. nArrays = 0 for columnName, column in table.columns.iteritems(): type = column.type if (type.min != 1 or type.max != 1) and not typeIsOptionalPointer(type): if not nArrays: print ''' static void %s_unparse(struct ovsdb_idl_row *row_) { struct %s *row = %s_cast(row_); ''' % (structName, structName, structName) 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 nArrays += 1 if not nArrays: print ''' static void %s_unparse(struct ovsdb_idl_row *row UNUSED) {''' % (structName) print "}" # First, next functions. print ''' 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])); } 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()} print ''' void %(s)s_delete(const struct %(s)s *row_) { struct %(s)s *row = (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 table.columns.iteritems(): print ''' void %(s)s_verify_%(c)s(const struct %(s)s *row) { 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 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: valueVar = members[1]['name'] if len(members) > 2: nVar = members[2]['name'] else: 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 %(s)s *row = (struct %(s)s *) row_;" % {'s': structName} print " struct ovsdb_datum datum;" if type.min == 1 and type.max == 1: print print " datum.n = 1;" print " datum.keys = xmalloc(sizeof *datum.keys);" print cCopyType(" ", "row->%s" % keyVar, "datum.keys[0].%s" % type.key, keyVar, type.key, type.keyRefTable) if type.value: print " datum.values = xmalloc(sizeof *datum.values);" print cCopyType(" ", "row->%s" % valueVar, "datum.values[0].%s" % type.value, valueVar, type.value, type.valueRefTable) else: print " datum.values = NULL;" elif typeIsOptionalPointer(type): print print " if (%s) {" % keyVar print " datum.n = 1;" print " datum.keys = xmalloc(sizeof *datum.keys);" print cCopyType(" ", "row->%s" % keyVar, "datum.keys[0].%s" % type.key, keyVar, type.key, type.keyRefTable) print " } else {" print " datum.n = 0;" print " datum.keys = NULL;" print " row->%s = NULL;" % keyVar print " }" print " datum.values = NULL;" else: print " size_t i;" print print " free(row->%s);" % keyVar print " row->%s = %s ? xmalloc(%s * sizeof *row->%s) : NULL;" % (keyVar, nVar, nVar, keyVar) print " row->%s = %s;" % (nVar, nVar) if type.value: print " free(row->%s);" % valueVar print " row->%s = xmalloc(%s * sizeof *row->%s);" % (valueVar, nVar, valueVar) 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 cCopyType(" ", "row->%s[i]" % keyVar, "datum.keys[i].%s" % type.key, "%s[i]" % keyVar, type.key, type.keyRefTable) if type.value: print cCopyType(" ", "row->%s[i]" % valueVar, "datum.values[i].%s" % type.value, "%s[i]" % valueVar, type.value, type.valueRefTable) 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 "\nstatic struct ovsdb_idl_column %s_columns[%s_N_COLUMNS] = {" % ( structName, structName.upper()) for columnName, column in table.columns.iteritems(): type = column.type if type.value: valueTypeName = type.value.upper() else: valueTypeName = "VOID" if type.max == "unlimited": max = "UINT_MAX" else: max = type.max print " {\"%s\", {OVSDB_TYPE_%s, OVSDB_TYPE_%s, %d, %s}}," % ( columnName, type.key.upper(), valueTypeName, type.min, max) 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(): 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 "};" # IDL class. print "\nstruct ovsdb_idl_class %sidl_class = {" % prefix print " %stable_classes, ARRAY_SIZE(%stable_classes)" % (prefix, prefix) print "};" def ovsdb_escape(string): def escape(match): c = match.group(0) if c == '\0': raise Error("strings may not contain null bytes") elif c == '\\': return '\\\\' elif c == '\n': return '\\n' elif c == '\r': return '\\r' elif c == '\t': return '\\t' elif c == '\b': return '\\b' elif c == '\a': return '\\a' else: 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 usage: %(argv0)s [OPTIONS] COMMAND ARG... 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 -V, --version display version information\ """ % {'argv0': argv0} sys.exit(0) if __name__ == "__main__": try: try: 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 not args: sys.stderr.write("%s: missing command argument " "(use --help for help)\n" % argv0) sys.exit(1) 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) # Local variables: # mode: python # End: