8 sys.path.insert(0, "@abs_top_srcdir@/ovsdb")
9 import simplejson as json
13 class Error(Exception):
14 def __init__(self, msg):
15 Exception.__init__(self)
18 def getMember(json, name, validTypes, description, default=None):
21 if type(member) not in validTypes:
22 raise Error("%s: type mismatch for '%s' member"
23 % (description, name))
27 def mustGetMember(json, name, expectedType, description):
28 member = getMember(json, name, expectedType, description)
30 raise Error("%s: missing '%s' member" % (description, name))
34 def __init__(self, name, comment, tables):
36 self.comment = comment
41 name = mustGetMember(json, 'name', [unicode], 'database')
42 comment = getMember(json, 'comment', [unicode], 'database')
43 tablesJson = mustGetMember(json, 'tables', [dict], 'database')
45 for name, json in tablesJson.iteritems():
46 tables[name] = TableSchema.fromJson(json, "%s table" % name)
47 return DbSchema(name, comment, tables)
50 d = {"name": self.name,
52 for name, table in self.tables.iteritems():
53 d["tables"][name] = table.toJson()
54 if self.comment != None:
55 d["comment"] = self.comment
59 def __init__(self, comment, columns):
60 self.comment = comment
61 self.columns = columns
64 def fromJson(json, description):
65 comment = getMember(json, 'comment', [unicode], description)
66 columnsJson = mustGetMember(json, 'columns', [dict], description)
68 for name, json in columnsJson.iteritems():
69 columns[name] = ColumnSchema.fromJson(
70 json, "column %s in %s" % (name, description))
71 return TableSchema(comment, columns)
75 for name, column in self.columns.iteritems():
76 d["columns"][name] = column.toJson()
77 if self.comment != None:
78 d["comment"] = self.comment
82 def __init__(self, comment, type, persistent):
83 self.comment = comment
85 self.persistent = persistent
88 def fromJson(json, description):
89 comment = getMember(json, 'comment', [unicode], description)
90 type = Type.fromJson(mustGetMember(json, 'type', [dict, unicode],
92 'type of %s' % description)
93 ephemeral = getMember(json, 'ephemeral', [True,False], description)
94 persistent = ephemeral != True
95 return ColumnSchema(comment, type, persistent)
98 d = {"type": self.type.toJson()}
99 if self.persistent == False:
100 d["ephemeral"] = True
101 if self.comment != None:
102 d["comment"] = self.comment
106 def __init__(self, key, keyRefTable=None, value=None, valueRefTable=None,
109 self.keyRefTable = keyRefTable
111 self.valueRefTable = valueRefTable
116 def fromJson(json, description):
117 if type(json) == unicode:
120 key = mustGetMember(json, 'key', [unicode], description)
121 keyRefTable = getMember(json, 'keyRefTable', [unicode], description)
122 value = getMember(json, 'value', [unicode], description)
123 valueRefTable = getMember(json, 'valueRefTable', [unicode], description)
124 min = getMember(json, 'min', [int], description, 1)
125 max = getMember(json, 'max', [int, unicode], description, 1)
126 return Type(key, keyRefTable, value, valueRefTable, min, max)
129 if self.value == None and self.min == 1 and self.max == 1:
132 d = {"key": self.key}
133 if self.value != None:
134 d["value"] = self.value
141 def parseSchema(filename):
142 file = open(filename, "r")
145 if not line.startswith('//'):
147 return DbSchema.fromJson(json.loads(s))
149 def cBaseType(prefix, type, refTable=None):
150 if type == 'uuid' and refTable:
151 return "struct %s%s *" % (prefix, refTable.lower())
153 return {'integer': 'int64_t ',
155 'uuid': 'struct uuid ',
157 'string': 'char *'}[type]
159 def printCIDLHeader(schema):
162 /* Generated automatically -- do not modify! -*- buffer-read-only: t -*- */
164 #ifndef %(prefix)sIDL_HEADER
165 #define %(prefix)sIDL_HEADER 1
170 #include "uuid.h"''' % {'prefix': prefix.upper()}
171 for tableName, table in schema.tables.iteritems():
173 if table.comment != None:
174 print "/* %s table (%s). */" % (tableName, table.comment)
176 print "/* %s table. */" % (tableName)
177 print "struct %s%s {" % (prefix, tableName.lower())
178 print "\t/* Columns automatically included in every table. */"
179 print "\tstruct uuid uuid_;"
180 print "\tstruct uuid version_;"
181 for columnName, column in table.columns.iteritems():
182 print "\n\t/* %s column. */" % columnName
184 if type.min == 1 and type.max == 1:
191 print "\tkey_%s%s%s;" % (cBaseType(prefix, type.key, type.keyRefTable), pointer, columnName)
192 print "\tvalue_%s%s%s;" % (cBaseType(prefix, type.value, type.valueRefTable), pointer, columnName)
194 print "\t%s%s%s;" % (cBaseType(prefix, type.key, type.keyRefTable), pointer, columnName)
196 print "\tsize_t n_%s;" % columnName
199 print "#endif /* %(prefix)sIDL_HEADER */" % {'prefix': prefix.upper()}
201 def ovsdb_escape(string):
205 raise Error("strings may not contain null bytes")
219 return '\\x%02x' % ord(c)
220 return re.sub(r'["\\\000-\037]', escape, string)
222 def printOVSDBSchema(schema):
223 json.dump(schema.toJson(), sys.stdout, sort_keys=True, indent=2)
227 %(argv0)s: ovsdb schema compiler
228 usage: %(argv0)s [OPTIONS] ACTION SCHEMA
229 where SCHEMA is the ovsdb schema to read (in JSON format).
231 One of the following actions must specified:
232 validate validate schema without taking any other action
233 c-idl-header print C header file for IDL
234 c-idl-source print C source file for IDL implementation
235 ovsdb-schema print ovsdb parseable schema
237 The following options are also available:
238 -h, --help display this help message
239 -V, --version display version information\
240 """ % {'argv0': argv0}
243 if __name__ == "__main__":
246 options, args = getopt.gnu_getopt(sys.argv[1:], 'hV',
249 except getopt.GetoptError, geo:
250 sys.stderr.write("%s: %s\n" % (argv0, geo.msg))
253 optKeys = [key for key, value in options]
254 if '-h' in optKeys or '--help' in optKeys:
256 elif '-V' in optKeys or '--version' in optKeys:
257 print "ovsdb-idlc (Open vSwitch) @VERSION@"
261 sys.stderr.write("%s: exactly two non-option arguments are "
262 "required (use --help for help)\n" % argv0)
265 action, inputFile = args
266 schema = parseSchema(inputFile)
267 if action == 'validate':
269 elif action == 'ovsdb-schema':
270 printOVSDBSchema(schema)
271 elif action == 'c-idl-header':
272 printCIDLHeader(schema)
273 elif action == 'c-idl-source':
274 printCIDLSource(schema)
277 "%s: unknown action '%s' (use --help for help)\n" %
281 sys.stderr.write("%s: %s\n" % (argv0, e.msg))