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 cCopyType(dst, src, type, refTable=None):
163 if type == 'uuid' and refTable:
164 return "%s = %s->header_.uuid;" % (dst, src)
165 elif type == 'string':
166 return "%s = xstrdup(%s);" % (dst, src)
168 return "%s = %s;" % (dst, src)
170 def typeIsOptionalPointer(type):
171 return (type.min == 0 and type.max == 1 and not type.value
172 and (type.key == 'string'
173 or (type.key == 'uuid' and type.keyRefTable)))
175 def cDeclComment(type):
176 if type.min == 1 and type.max == 1 and type.key == "string":
177 return "\t/* Always nonnull. */"
181 def cMembers(prefix, columnName, column):
183 if type.min == 1 and type.max == 1:
188 if typeIsOptionalPointer(type):
194 key = {'name': "key_%s" % columnName,
195 'type': cBaseType(prefix, type.key, type.keyRefTable) + pointer,
197 value = {'name': "value_%s" % columnName,
198 'type': (cBaseType(prefix, type.value, type.valueRefTable)
201 members = [key, value]
203 m = {'name': columnName,
204 'type': cBaseType(prefix, type.key, type.keyRefTable) + pointer,
205 'comment': cDeclComment(type)}
208 if not singleton and not typeIsOptionalPointer(type):
209 members.append({'name': 'n_%s' % columnName,
214 def printCIDLHeader(schema):
215 prefix = schema.idlPrefix
217 /* Generated automatically -- do not modify! -*- buffer-read-only: t -*- */
219 #ifndef %(prefix)sIDL_HEADER
220 #define %(prefix)sIDL_HEADER 1
225 #include "ovsdb-idl-provider.h"
226 #include "uuid.h"''' % {'prefix': prefix.upper()}
227 for tableName, table in schema.tables.iteritems():
229 print "/* %s table. */" % tableName
230 structName = "%s%s" % (prefix, tableName.lower())
231 print "struct %s {" % structName
232 print "\tstruct ovsdb_idl_row header_;"
233 for columnName, column in table.columns.iteritems():
234 print "\n\t/* %s column. */" % columnName
235 for member in cMembers(prefix, columnName, column):
236 print "\t%(type)s%(name)s;%(comment)s" % member
240 const struct %(s)s *%(s)s_first(const struct ovsdb_idl *);
241 const struct %(s)s *%(s)s_next(const struct %(s)s *);
242 #define %(S)s_FOR_EACH(ROW, IDL) for ((ROW) = %(s)s_first(IDL); (ROW); (ROW) = %(s)s_next(ROW))
244 void %(s)s_delete(const struct %(s)s *);
245 struct %(s)s *%(s)s_insert(struct ovsdb_idl_txn *);
246 ''' % {'s': structName, 'S': structName.upper()}
248 for columnName, column in table.columns.iteritems():
249 print 'void %(s)s_verify_%(c)s(const struct %(s)s *);' % {'s': structName, 'c': columnName}
252 for columnName, column in table.columns.iteritems():
254 print 'void %(s)s_set_%(c)s(const struct %(s)s *,' % {'s': structName, 'c': columnName},
255 args = ['%(type)s%(name)s' % member for member
256 in cMembers(prefix, columnName, column)]
257 print '%s);' % ', '.join(args)
259 print "\nextern struct ovsdb_idl_class %sidl_class;" % prefix
260 print "\n#endif /* %(prefix)sIDL_HEADER */" % {'prefix': prefix.upper()}
262 def printEnum(members):
263 if len(members) == 0:
267 for member in members[:-1]:
268 print " %s," % member
269 print " %s" % members[-1]
272 def printCIDLSource(schema):
273 prefix = schema.idlPrefix
275 /* Generated automatically -- do not modify! -*- buffer-read-only: t -*- */
280 #include "ovsdb-data.h"''' % schema.idlHeader
283 printEnum(["%sTABLE_%s" % (prefix.upper(), tableName.upper()) for tableName in schema.tables] + ["%sN_TABLES" % prefix.upper()])
284 print "\nstatic struct ovsdb_idl_table_class %stable_classes[%sN_TABLES];" % (prefix, prefix.upper())
287 for tableName, table in schema.tables.iteritems():
288 structName = "%s%s" % (prefix, tableName.lower())
290 static struct %(s)s *
291 %(s)s_cast(struct ovsdb_idl_row *row)
293 return row ? CONTAINER_OF(row, struct %(s)s, header_) : NULL;
295 ''' % {'s': structName}
298 for tableName, table in schema.tables.iteritems():
299 structName = "%s%s" % (prefix, tableName.lower())
301 if table.comment != None:
302 print "/* %s table (%s). */" % (tableName, table.comment)
304 print "/* %s table. */" % (tableName)
307 printEnum(["%s_COL_%s" % (structName.upper(), columnName.upper())
308 for columnName in table.columns]
309 + ["%s_N_COLUMNS" % structName.upper()])
311 print "\nstatic struct ovsdb_idl_column %s_columns[];" % structName
316 %s_parse(struct ovsdb_idl_row *row_)
318 struct %s *row = %s_cast(row_);
319 const struct ovsdb_datum *datum;
322 memset(row_ + 1, 0, sizeof *row - sizeof *row_);''' % (structName, structName, structName)
325 for columnName, column in table.columns.iteritems():
327 refKey = type.key == "uuid" and type.keyRefTable
328 refValue = type.value == "uuid" and type.valueRefTable
330 print " datum = &row_->old[%s_COL_%s];" % (structName.upper(), columnName.upper())
332 keyVar = "row->key_%s" % columnName
333 valueVar = "row->value_%s" % columnName
335 keyVar = "row->%s" % columnName
338 if (type.min == 1 and type.max == 1) or typeIsOptionalPointer(type):
339 print " if (datum->n >= 1) {"
341 print " %s = datum->keys[0].%s;" % (keyVar, type.key)
343 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())
347 print " %s = datum->values[0].%s;" % (valueVar, type.value)
349 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())
350 if (not typeIsOptionalPointer(type) and
351 (type.key == "string" or type.value == "string")):
353 if type.key == "string":
354 print " %s = \"\";" % keyVar
355 if type.value == "string":
356 print " %s = \"\";" % valueVar
360 if type.max != 'unlimited':
361 nMax = "MIN(%d, datum->n)" % type.max
364 print " for (i = 0; i < %s; i++) {" % nMax
367 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())
369 refs.append('keyRow')
371 keySrc = "datum->keys[i].%s" % type.key
373 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())
374 valueSrc = "valueRow"
375 refs.append('valueRow')
377 valueSrc = "datum->values[i].%s" % type.value
379 print " if (%s) {" % ' && '.join(refs)
383 print "%sif (!row->n_%s) {" % (indent, columnName)
384 print "%s %s = xmalloc(%s * sizeof *%s);" % (indent, keyVar, nMax, keyVar)
386 print "%s %s = xmalloc(%s * sizeof %s);" % (indent, valueVar, nMax, valueVar)
388 print "%s%s[row->n_%s] = %s;" % (indent, keyVar, columnName, keySrc)
390 print "%s%s[row->n_%s] = %s;" % (indent, valueVar, columnName, valueSrc)
391 print "%srow->n_%s++;" % (indent, columnName)
399 for columnName, column in table.columns.iteritems():
401 if (type.min != 1 or type.max != 1) and not typeIsOptionalPointer(type):
405 %s_unparse(struct ovsdb_idl_row *row_)
407 struct %s *row = %s_cast(row_);
408 ''' % (structName, structName, structName)
410 keyVar = "row->key_%s" % columnName
411 valueVar = "row->value_%s" % columnName
413 keyVar = "row->%s" % columnName
415 print " free(%s);" % keyVar
417 print " free(%s);" % valueVar
422 %s_unparse(struct ovsdb_idl_row *row UNUSED)
426 # First, next functions.
429 %(s)s_first(const struct ovsdb_idl *idl)
431 return %(s)s_cast(ovsdb_idl_first_row(idl, &%(p)stable_classes[%(P)sTABLE_%(T)s]));
435 %(s)s_next(const struct %(s)s *row)
437 return %(s)s_cast(ovsdb_idl_next_row(&row->header_));
438 }''' % {'s': structName,
441 'T': tableName.upper()}
445 %(s)s_delete(const struct %(s)s *row_)
447 struct %(s)s *row = (struct %(s)s *) row_;
448 ovsdb_idl_txn_delete(&row->header_);
452 %(s)s_insert(struct ovsdb_idl_txn *txn)
454 return %(s)s_cast(ovsdb_idl_txn_insert(txn, &%(p)stable_classes[%(P)sTABLE_%(T)s]));
456 ''' % {'s': structName,
459 'T': tableName.upper()}
462 for columnName, column in table.columns.iteritems():
465 %(s)s_verify_%(c)s(const struct %(s)s *row)
467 ovsdb_idl_txn_verify(&row->header_, &%(s)s_columns[%(S)s_COL_%(C)s]);
468 }''' % {'s': structName,
469 'S': structName.upper(),
471 'C': columnName.upper()}
474 for columnName, column in table.columns.iteritems():
477 members = cMembers(prefix, columnName, column)
478 keyVar = members[0]['name']
482 valueVar = members[1]['name']
484 nVar = members[2]['name']
487 nVar = members[1]['name']
488 print '%(s)s_set_%(c)s(const struct %(s)s *row_, %(args)s)' % \
489 {'s': structName, 'c': columnName,
490 'args': ', '.join(['%(type)s%(name)s' % m for m in members])}
492 print " struct %(s)s *row = (struct %(s)s *) row_;" % {'s': structName}
493 print " struct ovsdb_datum datum;"
494 if type.min == 1 and type.max == 1:
496 print " datum.n = 1;"
497 print " datum.keys = xmalloc(sizeof *datum.keys);"
498 print " %s" % cCopyType("datum.keys[0].%s" % type.key, keyVar, type.key, type.keyRefTable)
500 print " datum.values = xmalloc(sizeof *datum.values);"
501 print " %s" % cCopyType("datum.values[0].%s" % type.value, valueVar, type.value, type.valueRefTable)
503 print " datum.values = NULL;"
504 elif typeIsOptionalPointer(type):
506 print " if (%s) {" % keyVar
507 print " datum.n = 1;"
508 print " datum.keys = xmalloc(sizeof *datum.keys);"
509 print " %s" % cCopyType("datum.keys[0].%s" % type.key, keyVar, type.key, type.keyRefTable)
511 print " datum.n = 0;"
512 print " datum.keys = NULL;"
514 print " datum.values = NULL;"
518 print " datum.n = %s;" % nVar
519 print " datum.keys = xmalloc(%s * sizeof *datum.keys);" % nVar
521 print " datum.values = xmalloc(%s * sizeof *datum.values);" % nVar
523 print " datum.values = NULL;"
524 print " for (i = 0; i < %s; i++) {" % nVar
525 print " %s" % cCopyType("datum.keys[i].%s" % type.key, "%s[i]" % keyVar, type.key, type.keyRefTable)
527 print " %s" % cCopyType("datum.values[i].%s" % type.value, "%s[i]" % valueVar, type.value, type.valueRefTable)
529 print " ovsdb_idl_txn_write(&row->header_, &%(s)s_columns[%(S)s_COL_%(C)s], &datum);" \
531 'S': structName.upper(),
532 'C': columnName.upper()}
536 print "\nstatic struct ovsdb_idl_column %s_columns[%s_N_COLUMNS] = {" % (
537 structName, structName.upper())
538 for columnName, column in table.columns.iteritems():
542 valueTypeName = type.value.upper()
544 valueTypeName = "VOID"
545 if type.max == "unlimited":
549 print " {\"%s\", {OVSDB_TYPE_%s, OVSDB_TYPE_%s, %d, %s}}," % (
550 columnName, type.key.upper(), valueTypeName,
556 print "static struct ovsdb_idl_table_class %stable_classes[%sN_TABLES] = {" % (prefix, prefix.upper())
557 for tableName, table in schema.tables.iteritems():
558 structName = "%s%s" % (prefix, tableName.lower())
559 print " {\"%s\"," % tableName
560 print " %s_columns, ARRAY_SIZE(%s_columns)," % (
561 structName, structName)
562 print " sizeof(struct %s)," % structName
563 print " %s_parse," % structName
564 print " %s_unparse}," % structName
568 print "\nstruct ovsdb_idl_class %sidl_class = {" % prefix
569 print " %stable_classes, ARRAY_SIZE(%stable_classes)" % (prefix, prefix)
572 def ovsdb_escape(string):
576 raise Error("strings may not contain null bytes")
590 return '\\x%02x' % ord(c)
591 return re.sub(r'["\\\000-\037]', escape, string)
593 def printOVSDBSchema(schema):
594 json.dump(schema.toJson(), sys.stdout, sort_keys=True, indent=2)
598 %(argv0)s: ovsdb schema compiler
599 usage: %(argv0)s [OPTIONS] ACTION SCHEMA
600 where SCHEMA is the ovsdb schema to read (in JSON format).
602 One of the following actions must specified:
603 validate validate schema without taking any other action
604 c-idl-header print C header file for IDL
605 c-idl-source print C source file for IDL implementation
606 ovsdb-schema print ovsdb parseable schema
608 The following options are also available:
609 -h, --help display this help message
610 -V, --version display version information\
611 """ % {'argv0': argv0}
614 if __name__ == "__main__":
617 options, args = getopt.gnu_getopt(sys.argv[1:], 'hV',
620 except getopt.GetoptError, geo:
621 sys.stderr.write("%s: %s\n" % (argv0, geo.msg))
624 optKeys = [key for key, value in options]
625 if '-h' in optKeys or '--help' in optKeys:
627 elif '-V' in optKeys or '--version' in optKeys:
628 print "ovsdb-idlc (Open vSwitch) @VERSION@"
632 sys.stderr.write("%s: exactly two non-option arguments are "
633 "required (use --help for help)\n" % argv0)
636 action, inputFile = args
637 schema = parseSchema(inputFile)
638 if action == 'validate':
640 elif action == 'ovsdb-schema':
641 printOVSDBSchema(schema)
642 elif action == 'c-idl-header':
643 printCIDLHeader(schema)
644 elif action == 'c-idl-source':
645 printCIDLSource(schema)
648 "%s: unknown action '%s' (use --help for help)\n" %
652 sys.stderr.write("%s: %s\n" % (argv0, e.msg))