14 def parseSchema(filename):
15 return ovs.db.schema.IdlSchema.from_json(ovs.json.from_file(filename))
17 def annotateSchema(schemaFile, annotationFile):
18 schemaJson = ovs.json.from_file(schemaFile)
19 execfile(annotationFile, globals(), {"s": schemaJson})
20 ovs.json.to_stream(schemaJson, sys.stdout)
22 def constify(cType, const):
24 and cType.endswith('*') and not cType.endswith('**')
25 and (cType.startswith('struct uuid') or cType.startswith('char'))):
26 return 'const %s' % cType
30 def cMembers(prefix, columnName, column, const):
32 if type.n_min == 1 and type.n_max == 1:
37 if type.is_optional_pointer():
43 key = {'name': "key_%s" % columnName,
44 'type': constify(type.key.toCType(prefix) + pointer, const),
46 value = {'name': "value_%s" % columnName,
47 'type': constify(type.value.toCType(prefix) + pointer, const),
49 members = [key, value]
51 m = {'name': columnName,
52 'type': constify(type.key.toCType(prefix) + pointer, const),
53 'comment': type.cDeclComment()}
56 if not singleton and not type.is_optional_pointer():
57 members.append({'name': 'n_%s' % columnName,
62 def printCIDLHeader(schemaFile):
63 schema = parseSchema(schemaFile)
64 prefix = schema.idlPrefix
66 /* Generated automatically -- do not modify! -*- buffer-read-only: t -*- */
68 #ifndef %(prefix)sIDL_HEADER
69 #define %(prefix)sIDL_HEADER 1
74 #include "ovsdb-data.h"
75 #include "ovsdb-idl-provider.h"
76 #include "uuid.h"''' % {'prefix': prefix.upper()}
78 for tableName, table in sorted(schema.tables.iteritems()):
79 structName = "%s%s" % (prefix, tableName.lower())
82 print "/* %s table. */" % tableName
83 print "struct %s {" % structName
84 print "\tstruct ovsdb_idl_row header_;"
85 for columnName, column in sorted(table.columns.iteritems()):
86 print "\n\t/* %s column. */" % columnName
87 for member in cMembers(prefix, columnName, column, False):
88 print "\t%(type)s%(name)s;%(comment)s" % member
92 printEnum(["%s_COL_%s" % (structName.upper(), columnName.upper())
93 for columnName in sorted(table.columns)]
94 + ["%s_N_COLUMNS" % structName.upper()])
97 for columnName in table.columns:
98 print "#define %(s)s_col_%(c)s (%(s)s_columns[%(S)s_COL_%(C)s])" % {
100 'S': structName.upper(),
102 'C': columnName.upper()}
104 print "\nextern struct ovsdb_idl_column %s_columns[%s_N_COLUMNS];" % (structName, structName.upper())
107 const struct %(s)s *%(s)s_first(const struct ovsdb_idl *);
108 const struct %(s)s *%(s)s_next(const struct %(s)s *);
109 #define %(S)s_FOR_EACH(ROW, IDL) \\
110 for ((ROW) = %(s)s_first(IDL); \\
112 (ROW) = %(s)s_next(ROW))
113 #define %(S)s_FOR_EACH_SAFE(ROW, NEXT, IDL) \\
114 for ((ROW) = %(s)s_first(IDL); \\
115 (ROW) ? ((NEXT) = %(s)s_next(ROW), 1) : 0; \\
118 void %(s)s_delete(const struct %(s)s *);
119 struct %(s)s *%(s)s_insert(struct ovsdb_idl_txn *);
120 ''' % {'s': structName, 'S': structName.upper()}
122 for columnName, column in sorted(table.columns.iteritems()):
123 print 'void %(s)s_verify_%(c)s(const struct %(s)s *);' % {'s': structName, 'c': columnName}
126 /* Functions for fetching columns as \"struct ovsdb_datum\"s. (This is
127 rarely useful. More often, it is easier to access columns by using
128 the members of %(s)s directly.) */""" % {'s': structName}
129 for columnName, column in sorted(table.columns.iteritems()):
130 if column.type.value:
131 valueParam = ', enum ovsdb_atomic_type value_type'
134 print 'const struct ovsdb_datum *%(s)s_get_%(c)s(const struct %(s)s *, enum ovsdb_atomic_type key_type%(v)s);' % {
135 's': structName, 'c': columnName, 'v': valueParam}
138 for columnName, column in sorted(table.columns.iteritems()):
140 print 'void %(s)s_set_%(c)s(const struct %(s)s *,' % {'s': structName, 'c': columnName},
141 args = ['%(type)s%(name)s' % member for member
142 in cMembers(prefix, columnName, column, True)]
143 print '%s);' % ', '.join(args)
146 printEnum(["%sTABLE_%s" % (prefix.upper(), tableName.upper()) for tableName in sorted(schema.tables)] + ["%sN_TABLES" % prefix.upper()])
148 for tableName in schema.tables:
149 print "#define %(p)stable_%(t)s (%(p)stable_classes[%(P)sTABLE_%(T)s])" % {
152 't': tableName.lower(),
153 'T': tableName.upper()}
154 print "\nextern struct ovsdb_idl_table_class %stable_classes[%sN_TABLES];" % (prefix, prefix.upper())
156 print "\nextern struct ovsdb_idl_class %sidl_class;" % prefix
157 print "\nvoid %sinit(void);" % prefix
158 print "\n#endif /* %(prefix)sIDL_HEADER */" % {'prefix': prefix.upper()}
160 def printEnum(members):
161 if len(members) == 0:
165 for member in members[:-1]:
166 print " %s," % member
167 print " %s" % members[-1]
170 def printCIDLSource(schemaFile):
171 schema = parseSchema(schemaFile)
172 prefix = schema.idlPrefix
174 /* Generated automatically -- do not modify! -*- buffer-read-only: t -*- */
180 #include "ovsdb-data.h"
181 #include "ovsdb-error.h"
184 ''' % schema.idlHeader
187 for tableName, table in sorted(schema.tables.iteritems()):
188 structName = "%s%s" % (prefix, tableName.lower())
190 static struct %(s)s *
191 %(s)s_cast(const struct ovsdb_idl_row *row)
193 return row ? CONTAINER_OF(row, struct %(s)s, header_) : NULL;
195 ''' % {'s': structName}
198 for tableName, table in sorted(schema.tables.iteritems()):
199 structName = "%s%s" % (prefix, tableName.lower())
201 print "/* %s table. */" % (tableName)
204 for columnName, column in sorted(table.columns.iteritems()):
207 %(s)s_parse_%(c)s(struct ovsdb_idl_row *row_, const struct ovsdb_datum *datum)
209 struct %(s)s *row = %(s)s_cast(row_);''' % {'s': structName,
214 keyVar = "row->key_%s" % columnName
215 valueVar = "row->value_%s" % columnName
217 keyVar = "row->%s" % columnName
220 if (type.n_min == 1 and type.n_max == 1) or type.is_optional_pointer():
222 print " assert(inited);"
223 print " if (datum->n >= 1) {"
224 if not type.key.ref_table:
225 print " %s = datum->keys[0].%s;" % (keyVar, type.key.type.to_string())
227 print " %s = %s%s_cast(ovsdb_idl_get_row_arc(row_, &%stable_classes[%sTABLE_%s], &datum->keys[0].uuid));" % (keyVar, prefix, type.key.ref_table.lower(), prefix, prefix.upper(), type.key.ref_table.upper())
230 if type.value.ref_table:
231 print " %s = datum->values[0].%s;" % (valueVar, type.value.type.to_string())
233 print " %s = %s%s_cast(ovsdb_idl_get_row_arc(row_, &%stable_classes[%sTABLE_%s], &datum->values[0].uuid));" % (valueVar, prefix, type.value.ref_table.lower(), prefix, prefix.upper(), type.value.ref_table.upper())
235 print " %s" % type.key.initCDefault(keyVar, type.n_min == 0)
237 print " %s" % type.value.initCDefault(valueVar, type.n_min == 0)
240 if type.n_max != sys.maxint:
241 print " size_t n = MIN(%d, datum->n);" % type.n_max
247 print " assert(inited);"
248 print " %s = NULL;" % keyVar
250 print " %s = NULL;" % valueVar
251 print " row->n_%s = 0;" % columnName
252 print " for (i = 0; i < %s; i++) {" % nMax
254 if type.key.ref_table:
255 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.ref_table.lower(), prefix, type.key.ref_table.lower(), prefix, prefix.upper(), type.key.ref_table.upper())
257 refs.append('keyRow')
259 keySrc = "datum->keys[i].%s" % type.key.type.to_string()
260 if type.value and type.value.ref_table:
261 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.ref_table.lower(), prefix, type.value.ref_table.lower(), prefix, prefix.upper(), type.value.ref_table.upper())
262 valueSrc = "valueRow"
263 refs.append('valueRow')
265 valueSrc = "datum->values[i].%s" % type.value.type.to_string()
267 print " if (%s) {" % ' && '.join(refs)
271 print "%sif (!row->n_%s) {" % (indent, columnName)
272 print "%s %s = xmalloc(%s * sizeof *%s);" % (indent, keyVar, nMax, keyVar)
274 print "%s %s = xmalloc(%s * sizeof *%s);" % (indent, valueVar, nMax, valueVar)
276 print "%s%s[row->n_%s] = %s;" % (indent, keyVar, columnName, keySrc)
278 print "%s%s[row->n_%s] = %s;" % (indent, valueVar, columnName, valueSrc)
279 print "%srow->n_%s++;" % (indent, columnName)
286 for columnName, column in sorted(table.columns.iteritems()):
288 if (type.n_min != 1 or type.n_max != 1) and not type.is_optional_pointer():
291 %(s)s_unparse_%(c)s(struct ovsdb_idl_row *row_)
293 struct %(s)s *row = %(s)s_cast(row_);
295 assert(inited);''' % {'s': structName, 'c': columnName}
297 keyVar = "row->key_%s" % columnName
298 valueVar = "row->value_%s" % columnName
300 keyVar = "row->%s" % columnName
302 print " free(%s);" % keyVar
304 print " free(%s);" % valueVar
309 %(s)s_unparse_%(c)s(struct ovsdb_idl_row *row OVS_UNUSED)
312 }''' % {'s': structName, 'c': columnName}
314 # First, next functions.
317 %(s)s_first(const struct ovsdb_idl *idl)
319 return %(s)s_cast(ovsdb_idl_first_row(idl, &%(p)stable_classes[%(P)sTABLE_%(T)s]));
323 %(s)s_next(const struct %(s)s *row)
325 return %(s)s_cast(ovsdb_idl_next_row(&row->header_));
326 }''' % {'s': structName,
329 'T': tableName.upper()}
333 %(s)s_delete(const struct %(s)s *row)
335 ovsdb_idl_txn_delete(&row->header_);
339 %(s)s_insert(struct ovsdb_idl_txn *txn)
341 return %(s)s_cast(ovsdb_idl_txn_insert(txn, &%(p)stable_classes[%(P)sTABLE_%(T)s], NULL));
343 ''' % {'s': structName,
346 'T': tableName.upper()}
349 for columnName, column in sorted(table.columns.iteritems()):
352 %(s)s_verify_%(c)s(const struct %(s)s *row)
355 ovsdb_idl_txn_verify(&row->header_, &%(s)s_columns[%(S)s_COL_%(C)s]);
356 }''' % {'s': structName,
357 'S': structName.upper(),
359 'C': columnName.upper()}
362 for columnName, column in sorted(table.columns.iteritems()):
363 if column.type.value:
364 valueParam = ',\n\tenum ovsdb_atomic_type value_type OVS_UNUSED'
365 valueType = '\n assert(value_type == %s);' % column.type.value.toAtomicType()
366 valueComment = "\n * 'value_type' must be %s." % column.type.value.toAtomicType()
372 /* Returns the %(c)s column's value in 'row' as a struct ovsdb_datum.
373 * This is useful occasionally: for example, ovsdb_datum_find_key() is an
374 * easier and more efficient way to search for a given key than implementing
375 * the same operation on the "cooked" form in 'row'.
377 * 'key_type' must be %(kt)s.%(vc)s
378 * (This helps to avoid silent bugs if someone changes %(c)s's
379 * type without updating the caller.)
381 * The caller must not modify or free the returned value.
383 * Various kinds of changes can invalidate the returned value: modifying
384 * 'column' within 'row', deleting 'row', or completing an ongoing transaction.
385 * If the returned value is needed for a long time, it is best to make a copy
386 * of it with ovsdb_datum_clone(). */
387 const struct ovsdb_datum *
388 %(s)s_get_%(c)s(const struct %(s)s *row,
389 \tenum ovsdb_atomic_type key_type OVS_UNUSED%(v)s)
391 assert(key_type == %(kt)s);%(vt)s
392 return ovsdb_idl_read(&row->header_, &%(s)s_col_%(c)s);
393 }""" % {'s': structName, 'c': columnName,
394 'kt': column.type.key.toAtomicType(),
395 'v': valueParam, 'vt': valueType, 'vc': valueComment}
398 for columnName, column in sorted(table.columns.iteritems()):
401 members = cMembers(prefix, columnName, column, True)
402 keyVar = members[0]['name']
406 valueVar = members[1]['name']
408 nVar = members[2]['name']
411 nVar = members[1]['name']
412 print '%(s)s_set_%(c)s(const struct %(s)s *row, %(args)s)' % \
413 {'s': structName, 'c': columnName,
414 'args': ', '.join(['%(type)s%(name)s' % m for m in members])}
416 print " struct ovsdb_datum datum;"
417 if type.n_min == 1 and type.n_max == 1:
419 print " assert(inited);"
420 print " datum.n = 1;"
421 print " datum.keys = xmalloc(sizeof *datum.keys);"
422 print " " + type.key.copyCValue("datum.keys[0].%s" % type.key.type.to_string(), keyVar)
424 print " datum.values = xmalloc(sizeof *datum.values);"
425 print " "+ type.value.copyCValue("datum.values[0].%s" % type.value.type.to_string(), valueVar)
427 print " datum.values = NULL;"
428 elif type.is_optional_pointer():
430 print " assert(inited);"
431 print " if (%s) {" % keyVar
432 print " datum.n = 1;"
433 print " datum.keys = xmalloc(sizeof *datum.keys);"
434 print " " + type.key.copyCValue("datum.keys[0].%s" % type.key.type.to_string(), keyVar)
436 print " datum.n = 0;"
437 print " datum.keys = NULL;"
439 print " datum.values = NULL;"
443 print " assert(inited);"
444 print " datum.n = %s;" % nVar
445 print " datum.keys = xmalloc(%s * sizeof *datum.keys);" % nVar
447 print " datum.values = xmalloc(%s * sizeof *datum.values);" % nVar
449 print " datum.values = NULL;"
450 print " for (i = 0; i < %s; i++) {" % nVar
451 print " " + type.key.copyCValue("datum.keys[i].%s" % type.key.type.to_string(), "%s[i]" % keyVar)
453 print " " + type.value.copyCValue("datum.values[i].%s" % type.value.type.to_string(), "%s[i]" % valueVar)
456 valueType = type.value.toAtomicType()
458 valueType = "OVSDB_TYPE_VOID"
459 print " ovsdb_datum_sort_unique(&datum, %s, %s);" % (
460 type.key.toAtomicType(), valueType)
461 print " ovsdb_idl_txn_write(&row->header_, &%(s)s_columns[%(S)s_COL_%(C)s], &datum);" \
463 'S': structName.upper(),
464 'C': columnName.upper()}
468 print "\nstruct ovsdb_idl_column %s_columns[%s_N_COLUMNS];" % (
469 structName, structName.upper())
471 static void\n%s_columns_init(void)
473 struct ovsdb_idl_column *c;\
475 for columnName, column in sorted(table.columns.iteritems()):
476 cs = "%s_col_%s" % (structName, columnName)
477 d = {'cs': cs, 'c': columnName, 's': structName}
479 print " /* Initialize %(cs)s. */" % d
480 print " c = &%(cs)s;" % d
481 print " c->name = \"%(c)s\";" % d
482 print column.type.cInitType(" ", "c->type")
483 print " c->parse = %(s)s_parse_%(c)s;" % d
484 print " c->unparse = %(s)s_unparse_%(c)s;" % d
489 print "struct ovsdb_idl_table_class %stable_classes[%sN_TABLES] = {" % (prefix, prefix.upper())
490 for tableName, table in sorted(schema.tables.iteritems()):
491 structName = "%s%s" % (prefix, tableName.lower())
492 print " {\"%s\"," % tableName
493 print " %s_columns, ARRAY_SIZE(%s_columns)," % (
494 structName, structName)
495 print " sizeof(struct %s)}," % structName
499 print "\nstruct ovsdb_idl_class %sidl_class = {" % prefix
500 print " \"%s\", %stable_classes, ARRAY_SIZE(%stable_classes)" % (
501 schema.name, prefix, prefix)
504 # global init function
514 for tableName, table in sorted(schema.tables.iteritems()):
515 structName = "%s%s" % (prefix, tableName.lower())
516 print " %s_columns_init();" % structName
519 def ovsdb_escape(string):
523 raise ovs.db.error.Error("strings may not contain null bytes")
537 return '\\x%02x' % ord(c)
538 return re.sub(r'["\\\000-\037]', escape, string)
544 %(argv0)s: ovsdb schema compiler
545 usage: %(argv0)s [OPTIONS] COMMAND ARG...
547 The following commands are supported:
548 annotate SCHEMA ANNOTATIONS print SCHEMA combined with ANNOTATIONS
549 c-idl-header IDL print C header file for IDL
550 c-idl-source IDL print C source file for IDL implementation
551 nroff IDL print schema documentation in nroff format
553 The following options are also available:
554 -h, --help display this help message
555 -V, --version display version information\
556 """ % {'argv0': argv0}
559 if __name__ == "__main__":
562 options, args = getopt.gnu_getopt(sys.argv[1:], 'C:hV',
566 except getopt.GetoptError, geo:
567 sys.stderr.write("%s: %s\n" % (argv0, geo.msg))
570 for key, value in options:
571 if key in ['-h', '--help']:
573 elif key in ['-V', '--version']:
574 print "ovsdb-idlc (Open vSwitch) @VERSION@"
575 elif key in ['-C', '--directory']:
580 optKeys = [key for key, value in options]
583 sys.stderr.write("%s: missing command argument "
584 "(use --help for help)\n" % argv0)
587 commands = {"annotate": (annotateSchema, 2),
588 "c-idl-header": (printCIDLHeader, 1),
589 "c-idl-source": (printCIDLSource, 1)}
591 if not args[0] in commands:
592 sys.stderr.write("%s: unknown command \"%s\" "
593 "(use --help for help)\n" % (argv0, args[0]))
596 func, n_args = commands[args[0]]
597 if len(args) - 1 != n_args:
598 sys.stderr.write("%s: \"%s\" requires %d arguments but %d "
600 % (argv0, args[0], n_args, len(args) - 1))
604 except ovs.db.error.Error, e:
605 sys.stderr.write("%s: %s\n" % (argv0, e))