7 sys.path.insert(0, "@abs_top_srcdir@/ovsdb")
8 import simplejson as json
12 class Error(Exception):
13 def __init__(self, msg):
14 Exception.__init__(self)
17 def getMember(json, name, validTypes, description, default=None):
20 if type(member) not in validTypes:
21 raise Error("%s: type mismatch for '%s' member"
22 % (description, name))
26 def mustGetMember(json, name, expectedType, description):
27 member = getMember(json, name, expectedType, description)
29 raise Error("%s: missing '%s' member" % (description, name))
33 def __init__(self, name, comment, tables, idlPrefix, idlHeader):
35 self.comment = comment
37 self.idlPrefix = idlPrefix
38 self.idlHeader = idlHeader
42 name = mustGetMember(json, 'name', [unicode], 'database')
43 comment = getMember(json, 'comment', [unicode], 'database')
44 tablesJson = mustGetMember(json, 'tables', [dict], 'database')
46 for name, tableJson in tablesJson.iteritems():
47 tables[name] = TableSchema.fromJson(tableJson, "%s table" % name)
48 idlPrefix = mustGetMember(json, 'idlPrefix', [unicode], 'database')
49 idlHeader = mustGetMember(json, 'idlHeader', [unicode], 'database')
50 return DbSchema(name, comment, tables, idlPrefix, idlHeader)
53 d = {"name": self.name,
55 for name, table in self.tables.iteritems():
56 d["tables"][name] = table.toJson()
57 if self.comment != None:
58 d["comment"] = self.comment
62 def __init__(self, comment, columns):
63 self.comment = comment
64 self.columns = columns
67 def fromJson(json, description):
68 comment = getMember(json, 'comment', [unicode], description)
69 columnsJson = mustGetMember(json, 'columns', [dict], description)
71 for name, json in columnsJson.iteritems():
72 columns[name] = ColumnSchema.fromJson(
73 json, "column %s in %s" % (name, description))
74 return TableSchema(comment, columns)
78 for name, column in self.columns.iteritems():
79 d["columns"][name] = column.toJson()
80 if self.comment != None:
81 d["comment"] = self.comment
85 def __init__(self, comment, type, persistent):
86 self.comment = comment
88 self.persistent = persistent
91 def fromJson(json, description):
92 comment = getMember(json, 'comment', [unicode], description)
93 type = Type.fromJson(mustGetMember(json, 'type', [dict, unicode],
95 'type of %s' % description)
96 ephemeral = getMember(json, 'ephemeral', [True,False], description)
97 persistent = ephemeral != True
98 return ColumnSchema(comment, type, persistent)
101 d = {"type": self.type.toJson()}
102 if self.persistent == False:
103 d["ephemeral"] = True
104 if self.comment != None:
105 d["comment"] = self.comment
109 def __init__(self, key, keyRefTable=None, value=None, valueRefTable=None,
112 self.keyRefTable = keyRefTable
114 self.valueRefTable = valueRefTable
119 def fromJson(json, description):
120 if type(json) == unicode:
123 key = mustGetMember(json, 'key', [unicode], description)
124 keyRefTable = getMember(json, 'keyRefTable', [unicode], description)
125 value = getMember(json, 'value', [unicode], description)
126 valueRefTable = getMember(json, 'valueRefTable', [unicode], description)
127 min = getMember(json, 'min', [int], description, 1)
128 max = getMember(json, 'max', [int, unicode], description, 1)
129 return Type(key, keyRefTable, value, valueRefTable, min, max)
132 if self.value == None and self.min == 1 and self.max == 1:
135 d = {"key": self.key}
136 if self.value != None:
137 d["value"] = self.value
144 def parseSchema(filename):
145 file = open(filename, "r")
148 if not line.startswith('//'):
150 return DbSchema.fromJson(json.loads(s))
152 def cBaseType(prefix, type, refTable=None):
153 if type == 'uuid' and refTable:
154 return "struct %s%s *" % (prefix, refTable.lower())
156 return {'integer': 'int64_t ',
158 'uuid': 'struct uuid ',
160 'string': 'char *'}[type]
162 def typeIsOptionalPointer(type):
163 return (type.min == 0 and type.max == 1 and not type.value
164 and (type.key == 'string'
165 or (type.key == 'uuid' and type.keyRefTable)))
167 def cDeclComment(type):
168 if type.min == 1 and type.max == 1 and type.key == "string":
169 return "\t/* Always nonnull. */"
173 def printCIDLHeader(schema):
174 prefix = schema.idlPrefix
176 /* Generated automatically -- do not modify! -*- buffer-read-only: t -*- */
178 #ifndef %(prefix)sIDL_HEADER
179 #define %(prefix)sIDL_HEADER 1
184 #include "ovsdb-idl-provider.h"
185 #include "uuid.h"''' % {'prefix': prefix.upper()}
186 for tableName, table in schema.tables.iteritems():
188 print "/* %s table. */" % tableName
189 structName = "%s%s" % (prefix, tableName.lower())
190 print "struct %s {" % structName
191 print "\tstruct ovsdb_idl_row header_;"
192 for columnName, column in table.columns.iteritems():
193 print "\n\t/* %s column. */" % columnName
195 if type.min == 1 and type.max == 1:
200 if typeIsOptionalPointer(type):
205 print "\t%s%skey_%s;" % (cBaseType(prefix, type.key, type.keyRefTable), pointer, columnName)
206 print "\t%s%svalue_%s;" % (cBaseType(prefix, type.value, type.valueRefTable), pointer, columnName)
208 print "\t%s%s%s;%s" % (cBaseType(prefix, type.key, type.keyRefTable), pointer, columnName, cDeclComment(type))
209 if not singleton and not typeIsOptionalPointer(type):
210 print "\tsize_t n_%s;" % columnName
214 const struct %(s)s *%(s)s_first(const struct ovsdb_idl *);
215 const struct %(s)s *%(s)s_next(const struct %(s)s *);
216 #define %(S)s_FOR_EACH(ROW, IDL) for ((ROW) = %(s)s_first(IDL); (ROW); (ROW) = %(s)s_next(ROW))''' % {'s': structName, 'S': structName.upper()}
217 print "\nextern struct ovsdb_idl_class %sidl_class;" % prefix
218 print "\n#endif /* %(prefix)sIDL_HEADER */" % {'prefix': prefix.upper()}
220 def printEnum(members):
221 if len(members) == 0:
225 for member in members[:-1]:
226 print " %s," % member
227 print " %s" % members[-1]
230 def printCIDLSource(schema):
231 prefix = schema.idlPrefix
233 /* Generated automatically -- do not modify! -*- buffer-read-only: t -*- */
238 #include "ovsdb-data.h"''' % schema.idlHeader
241 printEnum(["%sTABLE_%s" % (prefix.upper(), tableName.upper()) for tableName in schema.tables] + ["%sN_TABLES" % prefix.upper()])
242 print "\nstatic struct ovsdb_idl_table_class %stable_classes[%sN_TABLES];" % (prefix, prefix.upper())
245 for tableName, table in schema.tables.iteritems():
246 structName = "%s%s" % (prefix, tableName.lower())
248 static struct %(s)s *
249 %(s)s_cast(struct ovsdb_idl_row *row)
251 return row ? CONTAINER_OF(row, struct %(s)s, header_) : NULL;
253 ''' % {'s': structName}
256 for tableName, table in schema.tables.iteritems():
257 structName = "%s%s" % (prefix, tableName.lower())
259 if table.comment != None:
260 print "/* %s table (%s). */" % (tableName, table.comment)
262 print "/* %s table. */" % (tableName)
265 printEnum(["%s_COL_%s" % (structName.upper(), columnName.upper())
266 for columnName in table.columns]
267 + ["%s_N_COLUMNS" % structName.upper()])
272 %s_parse(struct ovsdb_idl_row *row_)
274 struct %s *row = %s_cast(row_);
275 const struct ovsdb_datum *datum;
278 memset(row_ + 1, 0, sizeof *row - sizeof *row_);''' % (structName, structName, structName)
281 for columnName, column in table.columns.iteritems():
283 refKey = type.key == "uuid" and type.keyRefTable
284 refValue = type.value == "uuid" and type.valueRefTable
286 print " datum = &row_->fields[%s_COL_%s];" % (structName.upper(), columnName.upper())
288 keyVar = "row->key_%s" % columnName
289 valueVar = "row->value_%s" % columnName
291 keyVar = "row->%s" % columnName
294 if (type.min == 1 and type.max == 1) or typeIsOptionalPointer(type):
295 print " if (datum->n >= 1) {"
297 print " %s = datum->keys[0].%s;" % (keyVar, type.key)
299 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())
303 print " %s = datum->values[0].%s;" % (valueVar, type.value)
305 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())
306 if (not typeIsOptionalPointer(type) and
307 (type.key == "string" or type.value == "string")):
309 if type.key == "string":
310 print " %s = \"\";" % keyVar
311 if type.value == "string":
312 print " %s = \"\";" % valueVar
316 if type.max != 'unlimited':
317 nMax = "MIN(%d, datum->n)" % type.max
320 print " for (i = 0; i < %s; i++) {" % nMax
323 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())
325 refs.append('keyRow')
327 keySrc = "datum->keys[i].%s" % type.key
329 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())
330 valueSrc = "valueRow"
331 refs.append('valueRow')
333 valueSrc = "datum->values[i].%s" % type.value
335 print " if (%s) {" % ' && '.join(refs)
339 print "%sif (!row->n_%s) {" % (indent, columnName)
340 print "%s %s = xmalloc(%s * sizeof *%s);" % (indent, keyVar, nMax, keyVar)
342 print "%s %s = xmalloc(%s * sizeof %s);" % (indent, valueVar, nMax, valueVar)
344 print "%s%s[row->n_%s] = %s;" % (indent, keyVar, columnName, keySrc)
346 print "%s%s[row->n_%s] = %s;" % (indent, valueVar, columnName, valueSrc)
347 print "%srow->n_%s++;" % (indent, columnName)
355 for columnName, column in table.columns.iteritems():
357 if (type.min != 1 or type.max != 1) and not typeIsOptionalPointer(type):
361 %s_unparse(struct ovsdb_idl_row *row_)
363 struct %s *row = %s_cast(row_);
364 ''' % (structName, structName, structName)
366 keyVar = "row->key_%s" % columnName
367 valueVar = "row->value_%s" % columnName
369 keyVar = "row->%s" % columnName
371 print " free(%s);" % keyVar
373 print " free(%s);" % valueVar
378 %s_unparse(struct ovsdb_idl_row *row UNUSED)
382 # First, next functions.
385 %(s)s_first(const struct ovsdb_idl *idl)
387 return %(s)s_cast(ovsdb_idl_first_row(idl, &%(p)stable_classes[%(P)sTABLE_%(T)s]));
391 %(s)s_next(const struct %(s)s *row)
393 return %(s)s_cast(ovsdb_idl_next_row(&row->header_));
394 }''' % {'s': structName, 'p': prefix, 'P': prefix.upper(), 'T': tableName.upper()}
397 print "\nstatic struct ovsdb_idl_column %s_columns[%s_N_COLUMNS] = {" % (
398 structName, structName.upper())
399 for columnName, column in table.columns.iteritems():
403 valueTypeName = type.value.upper()
405 valueTypeName = "VOID"
406 if type.max == "unlimited":
410 print " {\"%s\", {OVSDB_TYPE_%s, OVSDB_TYPE_%s, %d, %s}}," % (
411 columnName, type.key.upper(), valueTypeName,
417 print "static struct ovsdb_idl_table_class %stable_classes[%sN_TABLES] = {" % (prefix, prefix.upper())
418 for tableName, table in schema.tables.iteritems():
419 structName = "%s%s" % (prefix, tableName.lower())
420 print " {\"%s\"," % tableName
421 print " %s_columns, ARRAY_SIZE(%s_columns)," % (
422 structName, structName)
423 print " sizeof(struct %s)," % structName
424 print " %s_parse," % structName
425 print " %s_unparse}," % structName
429 print "\nstruct ovsdb_idl_class %sidl_class = {" % prefix
430 print " %stable_classes, ARRAY_SIZE(%stable_classes)" % (prefix, prefix)
433 def ovsdb_escape(string):
437 raise Error("strings may not contain null bytes")
451 return '\\x%02x' % ord(c)
452 return re.sub(r'["\\\000-\037]', escape, string)
454 def printOVSDBSchema(schema):
455 json.dump(schema.toJson(), sys.stdout, sort_keys=True, indent=2)
459 %(argv0)s: ovsdb schema compiler
460 usage: %(argv0)s [OPTIONS] ACTION SCHEMA
461 where SCHEMA is the ovsdb schema to read (in JSON format).
463 One of the following actions must specified:
464 validate validate schema without taking any other action
465 c-idl-header print C header file for IDL
466 c-idl-source print C source file for IDL implementation
467 ovsdb-schema print ovsdb parseable schema
469 The following options are also available:
470 -h, --help display this help message
471 -V, --version display version information\
472 """ % {'argv0': argv0}
475 if __name__ == "__main__":
478 options, args = getopt.gnu_getopt(sys.argv[1:], 'hV',
481 except getopt.GetoptError, geo:
482 sys.stderr.write("%s: %s\n" % (argv0, geo.msg))
485 optKeys = [key for key, value in options]
486 if '-h' in optKeys or '--help' in optKeys:
488 elif '-V' in optKeys or '--version' in optKeys:
489 print "ovsdb-idlc (Open vSwitch) @VERSION@"
493 sys.stderr.write("%s: exactly two non-option arguments are "
494 "required (use --help for help)\n" % argv0)
497 action, inputFile = args
498 schema = parseSchema(inputFile)
499 if action == 'validate':
501 elif action == 'ovsdb-schema':
502 printOVSDBSchema(schema)
503 elif action == 'c-idl-header':
504 printCIDLHeader(schema)
505 elif action == 'c-idl-source':
506 printCIDLSource(schema)
509 "%s: unknown action '%s' (use --help for help)\n" %
513 sys.stderr.write("%s: %s\n" % (argv0, e.msg))