8 sys.path.insert(0, "@abs_top_srcdir@/ovsdb")
9 import simplejson as json
16 def __init__(self, type, values):
21 def fromJson(type_, json):
23 if len(json) == 2 and json[0] == "set":
25 for atomJson in json[1]:
26 values += [Atom.fromJson(type_.key, atomJson)]
28 values = [Atom.fromJson(type_.key, json)]
30 if len(json) != 2 or json[0] != "map":
31 raise Error("%s is not valid JSON for a map" % json)
33 for pairJson in json[1]:
34 values += [(Atom.fromJson(type_.key, pairJson[0]),
35 Atom.fromJson(type_.value, pairJson[1]))]
36 return Datum(type_, values)
38 def cInitDatum(self, var):
39 if len(self.values) == 0:
40 return ["ovsdb_datum_init_empty(%s);" % var]
42 s = ["%s->n = %d;" % (var, len(self.values))]
43 s += ["%s->keys = xmalloc(%d * sizeof *%s->keys);"
44 % (var, len(self.values), var)]
46 for i in range(len(self.values)):
50 s += key.cInitAtom("%s->keys[%d]" % (var, i))
53 s += ["%s->values = xmalloc(%d * sizeof *%s->values);"
54 % (var, len(self.values), var)]
55 for i in range(len(self.values)):
56 value = self.values[i][1]
57 s += key.cInitAtom("%s->values[%d]" % (var, i))
59 s += ["%s->values = NULL;" % var]
61 if len(self.values) > 1:
62 s += ["ovsdb_datum_sort_assert(%s, OVSDB_TYPE_%s);"
63 % (var, self.type.key.upper())]
67 def parseSchema(filename):
68 return IdlSchema.fromJson(json.load(open(filename, "r")))
70 def annotateSchema(schemaFile, annotationFile):
71 schemaJson = json.load(open(schemaFile, "r"))
72 execfile(annotationFile, globals(), {"s": schemaJson})
73 json.dump(schemaJson, sys.stdout)
75 def constify(cType, const):
77 and cType.endswith('*') and not cType.endswith('**')
78 and (cType.startswith('struct uuid') or cType.startswith('char'))):
79 return 'const %s' % cType
83 def cMembers(prefix, columnName, column, const):
85 if type.min == 1 and type.max == 1:
90 if type.isOptionalPointer():
96 key = {'name': "key_%s" % columnName,
97 'type': constify(type.key.toCType(prefix) + pointer, const),
99 value = {'name': "value_%s" % columnName,
100 'type': constify(type.value.toCType(prefix) + pointer, const),
102 members = [key, value]
104 m = {'name': columnName,
105 'type': constify(type.key.toCType(prefix) + pointer, const),
106 'comment': type.cDeclComment()}
109 if not singleton and not type.isOptionalPointer():
110 members.append({'name': 'n_%s' % columnName,
115 def printCIDLHeader(schemaFile):
116 schema = parseSchema(schemaFile)
117 prefix = schema.idlPrefix
119 /* Generated automatically -- do not modify! -*- buffer-read-only: t -*- */
121 #ifndef %(prefix)sIDL_HEADER
122 #define %(prefix)sIDL_HEADER 1
127 #include "ovsdb-idl-provider.h"
128 #include "uuid.h"''' % {'prefix': prefix.upper()}
130 for tableName, table in sorted(schema.tables.iteritems()):
131 structName = "%s%s" % (prefix, tableName.lower())
134 print "/* %s table. */" % tableName
135 print "struct %s {" % structName
136 print "\tstruct ovsdb_idl_row header_;"
137 for columnName, column in sorted(table.columns.iteritems()):
138 print "\n\t/* %s column. */" % columnName
139 for member in cMembers(prefix, columnName, column, False):
140 print "\t%(type)s%(name)s;%(comment)s" % member
144 printEnum(["%s_COL_%s" % (structName.upper(), columnName.upper())
145 for columnName in sorted(table.columns)]
146 + ["%s_N_COLUMNS" % structName.upper()])
149 for columnName in table.columns:
150 print "#define %(s)s_col_%(c)s (%(s)s_columns[%(S)s_COL_%(C)s])" % {
152 'S': structName.upper(),
154 'C': columnName.upper()}
156 print "\nextern struct ovsdb_idl_column %s_columns[%s_N_COLUMNS];" % (structName, structName.upper())
159 const struct %(s)s *%(s)s_first(const struct ovsdb_idl *);
160 const struct %(s)s *%(s)s_next(const struct %(s)s *);
161 #define %(S)s_FOR_EACH(ROW, IDL) \\
162 for ((ROW) = %(s)s_first(IDL); \\
164 (ROW) = %(s)s_next(ROW))
165 #define %(S)s_FOR_EACH_SAFE(ROW, NEXT, IDL) \\
166 for ((ROW) = %(s)s_first(IDL); \\
167 (ROW) ? ((NEXT) = %(s)s_next(ROW), 1) : 0; \\
170 void %(s)s_delete(const struct %(s)s *);
171 struct %(s)s *%(s)s_insert(struct ovsdb_idl_txn *);
172 ''' % {'s': structName, 'S': structName.upper()}
174 for columnName, column in sorted(table.columns.iteritems()):
175 print 'void %(s)s_verify_%(c)s(const struct %(s)s *);' % {'s': structName, 'c': columnName}
178 for columnName, column in sorted(table.columns.iteritems()):
180 print 'void %(s)s_set_%(c)s(const struct %(s)s *,' % {'s': structName, 'c': columnName},
181 args = ['%(type)s%(name)s' % member for member
182 in cMembers(prefix, columnName, column, True)]
183 print '%s);' % ', '.join(args)
186 printEnum(["%sTABLE_%s" % (prefix.upper(), tableName.upper()) for tableName in sorted(schema.tables)] + ["%sN_TABLES" % prefix.upper()])
188 for tableName in schema.tables:
189 print "#define %(p)stable_%(t)s (%(p)stable_classes[%(P)sTABLE_%(T)s])" % {
192 't': tableName.lower(),
193 'T': tableName.upper()}
194 print "\nextern struct ovsdb_idl_table_class %stable_classes[%sN_TABLES];" % (prefix, prefix.upper())
196 print "\nextern struct ovsdb_idl_class %sidl_class;" % prefix
197 print "\nvoid %sinit(void);" % prefix
198 print "\n#endif /* %(prefix)sIDL_HEADER */" % {'prefix': prefix.upper()}
200 def printEnum(members):
201 if len(members) == 0:
205 for member in members[:-1]:
206 print " %s," % member
207 print " %s" % members[-1]
210 def printCIDLSource(schemaFile):
211 schema = parseSchema(schemaFile)
212 prefix = schema.idlPrefix
214 /* Generated automatically -- do not modify! -*- buffer-read-only: t -*- */
220 #include "ovsdb-data.h"
221 #include "ovsdb-error.h"
224 ''' % schema.idlHeader
227 for tableName, table in sorted(schema.tables.iteritems()):
228 structName = "%s%s" % (prefix, tableName.lower())
230 static struct %(s)s *
231 %(s)s_cast(const struct ovsdb_idl_row *row)
233 return row ? CONTAINER_OF(row, struct %(s)s, header_) : NULL;
235 ''' % {'s': structName}
238 for tableName, table in sorted(schema.tables.iteritems()):
239 structName = "%s%s" % (prefix, tableName.lower())
241 print "/* %s table. */" % (tableName)
244 for columnName, column in sorted(table.columns.iteritems()):
247 %(s)s_parse_%(c)s(struct ovsdb_idl_row *row_, const struct ovsdb_datum *datum)
249 struct %(s)s *row = %(s)s_cast(row_);''' % {'s': structName,
254 keyVar = "row->key_%s" % columnName
255 valueVar = "row->value_%s" % columnName
257 keyVar = "row->%s" % columnName
260 if (type.min == 1 and type.max == 1) or type.isOptionalPointer():
262 print " assert(inited);"
263 print " if (datum->n >= 1) {"
264 if not type.key.refTable:
265 print " %s = datum->keys[0].%s;" % (keyVar, type.key.type)
267 print " %s = %s%s_cast(ovsdb_idl_get_row_arc(row_, &%stable_classes[%sTABLE_%s], &datum->keys[0].uuid));" % (keyVar, prefix, type.key.refTable.lower(), prefix, prefix.upper(), type.key.refTable.upper())
270 if type.value.refTable:
271 print " %s = datum->values[0].%s;" % (valueVar, type.value.type)
273 print " %s = %s%s_cast(ovsdb_idl_get_row_arc(row_, &%stable_classes[%sTABLE_%s], &datum->values[0].uuid));" % (valueVar, prefix, type.value.refTable.lower(), prefix, prefix.upper(), type.value.refTable.upper())
275 print " %s" % type.key.initCDefault(keyVar, type.min == 0)
277 print " %s" % type.value.initCDefault(valueVar, type.min == 0)
280 if type.max != 'unlimited':
281 print " size_t n = MIN(%d, datum->n);" % type.max
287 print " assert(inited);"
288 print " %s = NULL;" % keyVar
290 print " %s = NULL;" % valueVar
291 print " row->n_%s = 0;" % columnName
292 print " for (i = 0; i < %s; i++) {" % nMax
294 if type.key.refTable:
295 print " struct %s%s *keyRow = %s%s_cast(ovsdb_idl_get_row_arc(row_, &%stable_classes[%sTABLE_%s], &datum->keys[i].uuid));" % (prefix, type.key.refTable.lower(), prefix, type.key.refTable.lower(), prefix, prefix.upper(), type.key.refTable.upper())
297 refs.append('keyRow')
299 keySrc = "datum->keys[i].%s" % type.key.type
300 if type.value and type.value.refTable:
301 print " struct %s%s *valueRow = %s%s_cast(ovsdb_idl_get_row_arc(row_, &%stable_classes[%sTABLE_%s], &datum->values[i].uuid));" % (prefix, type.value.refTable.lower(), prefix, type.value.refTable.lower(), prefix, prefix.upper(), type.value.refTable.upper())
302 valueSrc = "valueRow"
303 refs.append('valueRow')
305 valueSrc = "datum->values[i].%s" % type.value.type
307 print " if (%s) {" % ' && '.join(refs)
311 print "%sif (!row->n_%s) {" % (indent, columnName)
312 print "%s %s = xmalloc(%s * sizeof *%s);" % (indent, keyVar, nMax, keyVar)
314 print "%s %s = xmalloc(%s * sizeof *%s);" % (indent, valueVar, nMax, valueVar)
316 print "%s%s[row->n_%s] = %s;" % (indent, keyVar, columnName, keySrc)
318 print "%s%s[row->n_%s] = %s;" % (indent, valueVar, columnName, valueSrc)
319 print "%srow->n_%s++;" % (indent, columnName)
326 for columnName, column in sorted(table.columns.iteritems()):
328 if (type.min != 1 or type.max != 1) and not type.isOptionalPointer():
331 %(s)s_unparse_%(c)s(struct ovsdb_idl_row *row_)
333 struct %(s)s *row = %(s)s_cast(row_);
335 assert(inited);''' % {'s': structName, 'c': columnName}
337 keyVar = "row->key_%s" % columnName
338 valueVar = "row->value_%s" % columnName
340 keyVar = "row->%s" % columnName
342 print " free(%s);" % keyVar
344 print " free(%s);" % valueVar
349 %(s)s_unparse_%(c)s(struct ovsdb_idl_row *row OVS_UNUSED)
352 }''' % {'s': structName, 'c': columnName}
354 # First, next functions.
357 %(s)s_first(const struct ovsdb_idl *idl)
359 return %(s)s_cast(ovsdb_idl_first_row(idl, &%(p)stable_classes[%(P)sTABLE_%(T)s]));
363 %(s)s_next(const struct %(s)s *row)
365 return %(s)s_cast(ovsdb_idl_next_row(&row->header_));
366 }''' % {'s': structName,
369 'T': tableName.upper()}
373 %(s)s_delete(const struct %(s)s *row)
375 ovsdb_idl_txn_delete(&row->header_);
379 %(s)s_insert(struct ovsdb_idl_txn *txn)
381 return %(s)s_cast(ovsdb_idl_txn_insert(txn, &%(p)stable_classes[%(P)sTABLE_%(T)s], NULL));
383 ''' % {'s': structName,
386 'T': tableName.upper()}
389 for columnName, column in sorted(table.columns.iteritems()):
392 %(s)s_verify_%(c)s(const struct %(s)s *row)
395 ovsdb_idl_txn_verify(&row->header_, &%(s)s_columns[%(S)s_COL_%(C)s]);
396 }''' % {'s': structName,
397 'S': structName.upper(),
399 'C': columnName.upper()}
402 for columnName, column in sorted(table.columns.iteritems()):
405 members = cMembers(prefix, columnName, column, True)
406 keyVar = members[0]['name']
410 valueVar = members[1]['name']
412 nVar = members[2]['name']
415 nVar = members[1]['name']
416 print '%(s)s_set_%(c)s(const struct %(s)s *row, %(args)s)' % \
417 {'s': structName, 'c': columnName,
418 'args': ', '.join(['%(type)s%(name)s' % m for m in members])}
420 print " struct ovsdb_datum datum;"
421 if type.min == 1 and type.max == 1:
423 print " assert(inited);"
424 print " datum.n = 1;"
425 print " datum.keys = xmalloc(sizeof *datum.keys);"
426 print " " + type.key.copyCValue("datum.keys[0].%s" % type.key.type, keyVar)
428 print " datum.values = xmalloc(sizeof *datum.values);"
429 print " "+ type.value.copyCValue("datum.values[0].%s" % type.value.type, valueVar)
431 print " datum.values = NULL;"
432 elif type.isOptionalPointer():
434 print " assert(inited);"
435 print " if (%s) {" % keyVar
436 print " datum.n = 1;"
437 print " datum.keys = xmalloc(sizeof *datum.keys);"
438 print " " + type.key.copyCValue("datum.keys[0].%s" % type.key.type, keyVar)
440 print " datum.n = 0;"
441 print " datum.keys = NULL;"
443 print " datum.values = NULL;"
447 print " assert(inited);"
448 print " datum.n = %s;" % nVar
449 print " datum.keys = xmalloc(%s * sizeof *datum.keys);" % nVar
451 print " datum.values = xmalloc(%s * sizeof *datum.values);" % nVar
453 print " datum.values = NULL;"
454 print " for (i = 0; i < %s; i++) {" % nVar
455 print " " + type.key.copyCValue("datum.keys[i].%s" % type.key.type, "%s[i]" % keyVar)
457 print " " + type.value.copyCValue("datum.values[i].%s" % type.value.type, "%s[i]" % valueVar)
459 print " ovsdb_idl_txn_write(&row->header_, &%(s)s_columns[%(S)s_COL_%(C)s], &datum);" \
461 'S': structName.upper(),
462 'C': columnName.upper()}
466 print "\nstruct ovsdb_idl_column %s_columns[%s_N_COLUMNS];" % (
467 structName, structName.upper())
469 static void\n%s_columns_init(void)
471 struct ovsdb_idl_column *c;\
473 for columnName, column in sorted(table.columns.iteritems()):
474 cs = "%s_col_%s" % (structName, columnName)
475 d = {'cs': cs, 'c': columnName, 's': structName}
477 print " /* Initialize %(cs)s. */" % d
478 print " c = &%(cs)s;" % d
479 print " c->name = \"%(c)s\";" % d
480 print column.type.cInitType(" ", "c->type")
481 print " c->parse = %(s)s_parse_%(c)s;" % d
482 print " c->unparse = %(s)s_unparse_%(c)s;" % d
487 print "struct ovsdb_idl_table_class %stable_classes[%sN_TABLES] = {" % (prefix, prefix.upper())
488 for tableName, table in sorted(schema.tables.iteritems()):
489 structName = "%s%s" % (prefix, tableName.lower())
490 print " {\"%s\"," % tableName
491 print " %s_columns, ARRAY_SIZE(%s_columns)," % (
492 structName, structName)
493 print " sizeof(struct %s)}," % structName
497 print "\nstruct ovsdb_idl_class %sidl_class = {" % prefix
498 print " \"%s\", %stable_classes, ARRAY_SIZE(%stable_classes)" % (
499 schema.name, prefix, prefix)
502 # global init function
512 for tableName, table in sorted(schema.tables.iteritems()):
513 structName = "%s%s" % (prefix, tableName.lower())
514 print " %s_columns_init();" % structName
517 def ovsdb_escape(string):
521 raise Error("strings may not contain null bytes")
535 return '\\x%02x' % ord(c)
536 return re.sub(r'["\\\000-\037]', escape, string)
542 %(argv0)s: ovsdb schema compiler
543 usage: %(argv0)s [OPTIONS] COMMAND ARG...
545 The following commands are supported:
546 annotate SCHEMA ANNOTATIONS print SCHEMA combined with ANNOTATIONS
547 c-idl-header IDL print C header file for IDL
548 c-idl-source IDL print C source file for IDL implementation
549 nroff IDL print schema documentation in nroff format
551 The following options are also available:
552 -h, --help display this help message
553 -V, --version display version information\
554 """ % {'argv0': argv0}
557 if __name__ == "__main__":
560 options, args = getopt.gnu_getopt(sys.argv[1:], 'C:hV',
564 except getopt.GetoptError, geo:
565 sys.stderr.write("%s: %s\n" % (argv0, geo.msg))
568 for key, value in options:
569 if key in ['-h', '--help']:
571 elif key in ['-V', '--version']:
572 print "ovsdb-idlc (Open vSwitch) @VERSION@"
573 elif key in ['-C', '--directory']:
578 optKeys = [key for key, value in options]
581 sys.stderr.write("%s: missing command argument "
582 "(use --help for help)\n" % argv0)
585 commands = {"annotate": (annotateSchema, 2),
586 "c-idl-header": (printCIDLHeader, 1),
587 "c-idl-source": (printCIDLSource, 1)}
589 if not args[0] in commands:
590 sys.stderr.write("%s: unknown command \"%s\" "
591 "(use --help for help)\n" % (argv0, args[0]))
594 func, n_args = commands[args[0]]
595 if len(args) - 1 != n_args:
596 sys.stderr.write("%s: \"%s\" requires %d arguments but %d "
598 % (argv0, args[0], n_args, len(args) - 1))
603 sys.stderr.write("%s: %s\n" % (argv0, e.msg))