X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=ovsdb%2Fovsdb-idlc.in;h=78a6546215268f12fbc54d23bae245248e592d51;hb=93255bc565f74df887c0278f8e401d3febd7e61a;hp=980773873ee687a7660bcde9158c1c764320df44;hpb=475281c01bd655c49f086d62d0cb4055a8f8d74b;p=openvswitch diff --git a/ovsdb/ovsdb-idlc.in b/ovsdb/ovsdb-idlc.in index 98077387..78a65462 100755 --- a/ovsdb/ovsdb-idlc.in +++ b/ovsdb/ovsdb-idlc.in @@ -1,6 +1,7 @@ #! @PYTHON@ import getopt +import os import re import sys @@ -43,8 +44,9 @@ 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) @@ -93,7 +95,7 @@ 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) @@ -141,13 +143,54 @@ class Type: 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): - file = open(filename, "r") - s = "" - for line in file: - if not line.startswith('//'): - s += line - return DbSchema.fromJson(json.loads(s)) + 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: @@ -159,13 +202,16 @@ def cBaseType(prefix, type, refTable=None): 'boolean': 'bool ', 'string': 'char *'}[type] -def cCopyType(dst, src, type, refTable=None): +def cCopyType(indent, dst, src, type, refTable=None): + args = {'indent': indent, + 'dst': dst, + 'src': src} if type == 'uuid' and refTable: - return "%s = %s->header_.uuid;" % (dst, src) + return ("%(indent)s%(dst)s = %(src)s->header_.uuid;") % args elif type == 'string': - return "%s = xstrdup(%s);" % (dst, src) + return "%(indent)s%(dst)s = xstrdup(%(src)s);" % args else: - return "%s = %s;" % (dst, src) + return "%(indent)s%(dst)s = %(src)s;" % args def typeIsOptionalPointer(type): return (type.min == 0 and type.max == 1 and not type.value @@ -178,7 +224,27 @@ def cDeclComment(type): else: return "" -def cMembers(prefix, columnName, column): +def cInitDefault(var, type, refTable, isOptional): + if type == 'uuid' and refTable: + return "%s = NULL;" % var + elif 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;'}[type] % var + +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 @@ -192,16 +258,15 @@ def cMembers(prefix, columnName, column): if type.value: key = {'name': "key_%s" % columnName, - 'type': cBaseType(prefix, type.key, type.keyRefTable) + pointer, + 'type': constify(cBaseType(prefix, type.key, type.keyRefTable) + pointer, const), 'comment': ''} value = {'name': "value_%s" % columnName, - 'type': (cBaseType(prefix, type.value, type.valueRefTable) - + pointer), + 'type': constify(cBaseType(prefix, type.value, type.valueRefTable) + pointer, const), 'comment': ''} members = [key, value] else: m = {'name': columnName, - 'type': cBaseType(prefix, type.key, type.keyRefTable) + pointer, + 'type': constify(cBaseType(prefix, type.key, type.keyRefTable) + pointer, const), 'comment': cDeclComment(type)} members = [m] @@ -211,7 +276,8 @@ def cMembers(prefix, columnName, column): 'comment': ''}) return members -def printCIDLHeader(schema): +def printCIDLHeader(schemaFile): + schema = parseSchema(schemaFile) prefix = schema.idlPrefix print '''\ /* Generated automatically -- do not modify! -*- buffer-read-only: t -*- */ @@ -224,19 +290,36 @@ 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 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(): print "\n\t/* %s column. */" % columnName - for member in cMembers(prefix, columnName, column): + for member in cMembers(prefix, columnName, column, False): print "\t%(type)s%(name)s;%(comment)s" % member - print '''\ -}; + print "};" + + # Column indexes. + printEnum(["%s_COL_%s" % (structName.upper(), columnName.upper()) + for columnName in 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)) @@ -253,9 +336,20 @@ struct %(s)s *%(s)s_insert(struct ovsdb_idl_txn *); 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)] + in cMembers(prefix, columnName, column, True)] print '%s);' % ', '.join(args) + # Table indexes. + printEnum(["%sTABLE_%s" % (prefix.upper(), tableName.upper()) for tableName in 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 "\n#endif /* %(prefix)sIDL_HEADER */" % {'prefix': prefix.upper()} @@ -269,7 +363,8 @@ 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 -*- */ @@ -279,16 +374,12 @@ def printCIDLSource(schema): #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) +%(s)s_cast(const struct ovsdb_idl_row *row) { return row ? CONTAINER_OF(row, struct %(s)s, header_) : NULL; }\ @@ -303,31 +394,18 @@ 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()]) - - print "\nstatic struct ovsdb_idl_column %s_columns[];" % structName - - # Parse function. - print ''' + # Parse functions. + for columnName, column in 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_->old[%s_COL_%s];" % (structName.upper(), columnName.upper()) if type.value: keyVar = "row->key_%s" % columnName valueVar = "row->value_%s" % columnName @@ -335,7 +413,9 @@ 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 + typeIsOptionalPointer(type)): + print print " if (datum->n >= 1) {" if not refKey: print " %s = datum->keys[0].%s;" % (keyVar, type.key) @@ -347,20 +427,23 @@ static void 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 {" + print " %s" % cInitDefault(keyVar, type.key, type.keyRefTable, type.min == 0) + if valueVar: + print " %s" % cInitDefault(valueVar, type.value, type.valueRefTable, 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 " %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: @@ -392,20 +475,18 @@ static void if refs: print " }" print " }" - print "}" + print "}" - # Unparse function. - nArrays = 0 + # Unparse functions. 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 ''' + 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_); +''' % {'s': structName, 'c': columnName} if type.value: keyVar = "row->key_%s" % columnName valueVar = "row->value_%s" % columnName @@ -415,14 +496,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 UNUSED) +{ + /* Nothing to do. */ +}''' % {'s': structName, 'c': columnName} + # First, next functions. print ''' const struct %(s)s * @@ -474,7 +556,7 @@ void for columnName, column in table.columns.iteritems(): type = column.type print '\nvoid' - members = cMembers(prefix, columnName, column) + members = cMembers(prefix, columnName, column, True) keyVar = members[0]['name'] nVar = None valueVar = None @@ -485,20 +567,19 @@ void else: if len(members) > 1: nVar = members[1]['name'] - print '%(s)s_set_%(c)s(const struct %(s)s *row_, %(args)s)' % \ + 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 " %s" % cCopyType("datum.keys[0].%s" % type.key, keyVar, type.key, type.keyRefTable) + print cCopyType(" ", "datum.keys[0].%s" % type.key, keyVar, type.key, type.keyRefTable) if type.value: print " datum.values = xmalloc(sizeof *datum.values);" - print " %s" % cCopyType("datum.values[0].%s" % type.value, valueVar, type.value, type.valueRefTable) + print cCopyType(" ", "datum.values[0].%s" % type.value, valueVar, type.value, type.valueRefTable) else: print " datum.values = NULL;" elif typeIsOptionalPointer(type): @@ -506,7 +587,7 @@ void print " if (%s) {" % keyVar print " datum.n = 1;" print " datum.keys = xmalloc(sizeof *datum.keys);" - print " %s" % cCopyType("datum.keys[0].%s" % type.key, keyVar, type.key, type.keyRefTable) + print cCopyType(" ", "datum.keys[0].%s" % type.key, keyVar, type.key, type.keyRefTable) print " } else {" print " datum.n = 0;" print " datum.keys = NULL;" @@ -522,9 +603,9 @@ void else: print " datum.values = NULL;" print " for (i = 0; i < %s; i++) {" % nVar - print " %s" % cCopyType("datum.keys[i].%s" % type.key, "%s[i]" % keyVar, type.key, type.keyRefTable) + print cCopyType(" ", "datum.keys[i].%s" % type.key, "%s[i]" % keyVar, type.key, type.keyRefTable) if type.value: - print " %s" % cCopyType("datum.values[i].%s" % type.value, "%s[i]" % valueVar, type.value, type.valueRefTable) + print cCopyType(" ", "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, @@ -533,7 +614,7 @@ void print "}" # Table columns. - print "\nstatic struct ovsdb_idl_column %s_columns[%s_N_COLUMNS] = {" % ( + print "\nstruct ovsdb_idl_column %s_columns[%s_N_COLUMNS] = {" % ( structName, structName.upper()) for columnName, column in table.columns.iteritems(): type = column.type @@ -546,22 +627,27 @@ void 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 """\ + {"%(c)s", + {OVSDB_TYPE_%(kt)s, OVSDB_TYPE_%(vt)s, %(min)s, %(max)s}, + %(s)s_parse_%(c)s, + %(s)s_unparse_%(c)s},""" % {'c': columnName, + 's': structName, + 'kt': type.key.upper(), + 'vt': valueTypeName, + 'min': type.min, + 'max': max} print "};" # Table classes. print " " - print "static struct ovsdb_idl_table_class %stable_classes[%sN_TABLES] = {" % (prefix, prefix.upper()) + print "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 " sizeof(struct %s)}," % structName print "};" # IDL class. @@ -590,20 +676,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 @@ -614,40 +716,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)