#! @PYTHON@
import getopt
+import os
import re
import sys
-sys.path.insert(0, "@abs_top_srcdir@/ovsdb")
-import simplejson as json
+import ovs.json
+import ovs.db.error
+import ovs.db.schema
argv0 = sys.argv[0]
-class Error(Exception):
- def __init__(self, msg):
- Exception.__init__(self)
- self.msg = msg
-
-def getMember(json, name, validTypes, description, default=None):
- if name in json:
- member = json[name]
- if type(member) not in validTypes:
- raise Error("%s: type mismatch for '%s' member"
- % (description, name))
- return member
- return default
-
-def mustGetMember(json, name, expectedType, description):
- member = getMember(json, name, expectedType, description)
- if member == None:
- raise Error("%s: missing '%s' member" % (description, name))
- return member
-
-class DbSchema:
- def __init__(self, name, comment, tables, idlPrefix, idlHeader):
- self.name = name
- self.comment = comment
- self.tables = tables
- self.idlPrefix = idlPrefix
- self.idlHeader = idlHeader
-
- @staticmethod
- def fromJson(json):
- name = mustGetMember(json, 'name', [unicode], 'database')
- comment = getMember(json, 'comment', [unicode], 'database')
- tablesJson = mustGetMember(json, 'tables', [dict], 'database')
- tables = {}
- for name, tableJson in tablesJson.iteritems():
- tables[name] = TableSchema.fromJson(tableJson, "%s table" % name)
- idlPrefix = mustGetMember(json, 'idlPrefix', [unicode], 'database')
- idlHeader = mustGetMember(json, 'idlHeader', [unicode], 'database')
- return DbSchema(name, comment, tables, idlPrefix, idlHeader)
-
- def toJson(self):
- d = {"name": self.name,
- "tables": {}}
- for name, table in self.tables.iteritems():
- d["tables"][name] = table.toJson()
- if self.comment != None:
- d["comment"] = self.comment
- return d
-
-class TableSchema:
- def __init__(self, comment, columns):
- self.comment = comment
- self.columns = columns
-
- @staticmethod
- def fromJson(json, description):
- comment = getMember(json, 'comment', [unicode], description)
- columnsJson = mustGetMember(json, 'columns', [dict], description)
- columns = {}
- for name, json in columnsJson.iteritems():
- columns[name] = ColumnSchema.fromJson(
- json, "column %s in %s" % (name, description))
- return TableSchema(comment, columns)
-
- def toJson(self):
- d = {"columns": {}}
- for name, column in self.columns.iteritems():
- d["columns"][name] = column.toJson()
- if self.comment != None:
- d["comment"] = self.comment
- return d
-
-class ColumnSchema:
- def __init__(self, comment, type, persistent):
- self.comment = comment
- self.type = type
- self.persistent = persistent
-
- @staticmethod
- def fromJson(json, description):
- comment = getMember(json, 'comment', [unicode], description)
- type = Type.fromJson(mustGetMember(json, 'type', [dict, unicode],
- description),
- 'type of %s' % description)
- ephemeral = getMember(json, 'ephemeral', [True,False], description)
- persistent = ephemeral != True
- return ColumnSchema(comment, type, persistent)
-
- def toJson(self):
- d = {"type": self.type.toJson()}
- if self.persistent == False:
- d["ephemeral"] = True
- if self.comment != None:
- d["comment"] = self.comment
- return d
-
-class Type:
- def __init__(self, key, keyRefTable=None, value=None, valueRefTable=None,
- min=1, max=1):
- self.key = key
- self.keyRefTable = keyRefTable
- self.value = value
- self.valueRefTable = valueRefTable
- self.min = min
- self.max = max
-
- @staticmethod
- def fromJson(json, description):
- if type(json) == unicode:
- return Type(json)
- else:
- key = mustGetMember(json, 'key', [unicode], description)
- keyRefTable = getMember(json, 'keyRefTable', [unicode], description)
- value = getMember(json, 'value', [unicode], description)
- valueRefTable = getMember(json, 'valueRefTable', [unicode], description)
- min = getMember(json, 'min', [int], description, 1)
- max = getMember(json, 'max', [int, unicode], description, 1)
- return Type(key, keyRefTable, value, valueRefTable, min, max)
-
- def toJson(self):
- if self.value == None and self.min == 1 and self.max == 1:
- return self.key
- else:
- d = {"key": self.key}
- if self.value != None:
- d["value"] = self.value
- if self.min != 1:
- d["min"] = self.min
- if self.max != 1:
- d["max"] = self.max
- return d
-
def parseSchema(filename):
- file = open(filename, "r")
- s = ""
- for line in file:
- if not line.startswith('//'):
- s += line
- return DbSchema.fromJson(json.loads(s))
-
-def cBaseType(prefix, type, refTable=None):
- if type == 'uuid' and refTable:
- return "struct %s%s *" % (prefix, refTable.lower())
- else:
- return {'integer': 'int64_t ',
- 'real': 'double ',
- 'uuid': 'struct uuid ',
- 'boolean': 'bool ',
- 'string': 'char *'}[type]
-
-def cCopyType(dst, src, type, refTable=None):
- if type == 'uuid' and refTable:
- return "%s = %s->header_.uuid;" % (dst, src)
- elif type == 'string':
- return "%s = xstrdup(%s);" % (dst, src)
- else:
- return "%s = %s;" % (dst, src)
+ return ovs.db.schema.IdlSchema.from_json(ovs.json.from_file(filename))
-def typeIsOptionalPointer(type):
- return (type.min == 0 and type.max == 1 and not type.value
- and (type.key == 'string'
- or (type.key == 'uuid' and type.keyRefTable)))
+def annotateSchema(schemaFile, annotationFile):
+ schemaJson = ovs.json.from_file(schemaFile)
+ execfile(annotationFile, globals(), {"s": schemaJson})
+ ovs.json.to_stream(schemaJson, sys.stdout)
+ sys.stdout.write('\n')
-def cDeclComment(type):
- if type.min == 1 and type.max == 1 and type.key == "string":
- return "\t/* Always nonnull. */"
+def constify(cType, const):
+ if (const and cType.endswith('*') and not cType.endswith('**')):
+ return 'const %s' % cType
else:
- return ""
+ return cType
-def cMembers(prefix, columnName, column):
+def cMembers(prefix, columnName, column, const):
type = column.type
- if type.min == 1 and type.max == 1:
+
+ if type.is_smap():
+ return [{'name': columnName,
+ 'type': 'struct smap ',
+ 'comment': ''}]
+
+ if type.n_min == 1 and type.n_max == 1:
singleton = True
pointer = ''
else:
singleton = False
- if typeIsOptionalPointer(type):
+ if type.is_optional_pointer():
pointer = ''
else:
pointer = '*'
if type.value:
key = {'name': "key_%s" % columnName,
- 'type': cBaseType(prefix, type.key, type.keyRefTable) + pointer,
+ 'type': constify(type.key.toCType(prefix) + pointer, const),
'comment': ''}
value = {'name': "value_%s" % columnName,
- 'type': (cBaseType(prefix, type.value, type.valueRefTable)
- + pointer),
+ 'type': constify(type.value.toCType(prefix) + pointer, const),
'comment': ''}
members = [key, value]
else:
m = {'name': columnName,
- 'type': cBaseType(prefix, type.key, type.keyRefTable) + pointer,
- 'comment': cDeclComment(type)}
+ 'type': constify(type.key.toCType(prefix) + pointer, const),
+ 'comment': type.cDeclComment()}
members = [m]
- if not singleton and not typeIsOptionalPointer(type):
+ if not singleton and not type.is_optional_pointer():
members.append({'name': 'n_%s' % columnName,
'type': 'size_t ',
'comment': ''})
return members
-def printCIDLHeader(schema):
+def printCIDLHeader(schemaFile):
+ schema = parseSchema(schemaFile)
prefix = schema.idlPrefix
print '''\
/* Generated automatically -- do not modify! -*- buffer-read-only: t -*- */
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
+#include "ovsdb-data.h"
#include "ovsdb-idl-provider.h"
+#include "smap.h"
#include "uuid.h"''' % {'prefix': prefix.upper()}
- for tableName, table in schema.tables.iteritems():
- print
- print "/* %s table. */" % tableName
+
+ for tableName, table in sorted(schema.tables.iteritems()):
structName = "%s%s" % (prefix, tableName.lower())
+
+ print "\f"
+ print "/* %s table. */" % tableName
print "struct %s {" % structName
print "\tstruct ovsdb_idl_row header_;"
- for columnName, column in table.columns.iteritems():
+ for columnName, column in sorted(table.columns.iteritems()):
print "\n\t/* %s column. */" % columnName
- for member in cMembers(prefix, columnName, column):
+ for member in cMembers(prefix, columnName, column, False):
print "\t%(type)s%(name)s;%(comment)s" % member
- print '''\
-};
+ print "};"
+
+ # Column indexes.
+ printEnum(["%s_COL_%s" % (structName.upper(), columnName.upper())
+ for columnName in sorted(table.columns)]
+ + ["%s_N_COLUMNS" % structName.upper()])
+
+ print
+ for columnName in table.columns:
+ print "#define %(s)s_col_%(c)s (%(s)s_columns[%(S)s_COL_%(C)s])" % {
+ 's': structName,
+ 'S': structName.upper(),
+ 'c': columnName,
+ 'C': columnName.upper()}
+ print "\nextern struct ovsdb_idl_column %s_columns[%s_N_COLUMNS];" % (structName, structName.upper())
+
+ print '''
+const struct %(s)s *%(s)s_get_for_uuid(const struct ovsdb_idl *, const struct uuid *);
const struct %(s)s *%(s)s_first(const struct ovsdb_idl *);
const struct %(s)s *%(s)s_next(const struct %(s)s *);
-#define %(S)s_FOR_EACH(ROW, IDL) for ((ROW) = %(s)s_first(IDL); (ROW); (ROW) = %(s)s_next(ROW))
-
+#define %(S)s_FOR_EACH(ROW, IDL) \\
+ for ((ROW) = %(s)s_first(IDL); \\
+ (ROW); \\
+ (ROW) = %(s)s_next(ROW))
+#define %(S)s_FOR_EACH_SAFE(ROW, NEXT, IDL) \\
+ for ((ROW) = %(s)s_first(IDL); \\
+ (ROW) ? ((NEXT) = %(s)s_next(ROW), 1) : 0; \\
+ (ROW) = (NEXT))
+
+void %(s)s_init(struct %(s)s *);
void %(s)s_delete(const struct %(s)s *);
struct %(s)s *%(s)s_insert(struct ovsdb_idl_txn *);
''' % {'s': structName, 'S': structName.upper()}
- for columnName, column in table.columns.iteritems():
+ for columnName, column in sorted(table.columns.iteritems()):
print 'void %(s)s_verify_%(c)s(const struct %(s)s *);' % {'s': structName, 'c': columnName}
- print
- for columnName, column in table.columns.iteritems():
+ print """
+/* Functions for fetching columns as \"struct ovsdb_datum\"s. (This is
+ rarely useful. More often, it is easier to access columns by using
+ the members of %(s)s directly.) */""" % {'s': structName}
+ for columnName, column in sorted(table.columns.iteritems()):
+ if column.type.value:
+ valueParam = ', enum ovsdb_atomic_type value_type'
+ else:
+ valueParam = ''
+ print 'const struct ovsdb_datum *%(s)s_get_%(c)s(const struct %(s)s *, enum ovsdb_atomic_type key_type%(v)s);' % {
+ 's': structName, 'c': columnName, 'v': valueParam}
+ print
+ for columnName, column in sorted(table.columns.iteritems()):
print 'void %(s)s_set_%(c)s(const struct %(s)s *,' % {'s': structName, 'c': columnName},
- args = ['%(type)s%(name)s' % member for member
- in cMembers(prefix, columnName, column)]
+ if column.type.is_smap():
+ args = ['const struct smap *']
+ else:
+ args = ['%(type)s%(name)s' % member for member
+ in cMembers(prefix, columnName, column, True)]
print '%s);' % ', '.join(args)
+ print
+
+ # Table indexes.
+ printEnum(["%sTABLE_%s" % (prefix.upper(), tableName.upper()) for tableName in sorted(schema.tables)] + ["%sN_TABLES" % prefix.upper()])
+ print
+ for tableName in schema.tables:
+ print "#define %(p)stable_%(t)s (%(p)stable_classes[%(P)sTABLE_%(T)s])" % {
+ 'p': prefix,
+ 'P': prefix.upper(),
+ 't': tableName.lower(),
+ 'T': tableName.upper()}
+ print "\nextern struct ovsdb_idl_table_class %stable_classes[%sN_TABLES];" % (prefix, prefix.upper())
+
print "\nextern struct ovsdb_idl_class %sidl_class;" % prefix
+ print "\nvoid %sinit(void);" % prefix
+
+ print "\nconst char * %sget_db_version(void);" % prefix
print "\n#endif /* %(prefix)sIDL_HEADER */" % {'prefix': prefix.upper()}
def printEnum(members):
print " %s" % members[-1]
print "};"
-def printCIDLSource(schema):
+def printCIDLSource(schemaFile):
+ schema = parseSchema(schemaFile)
prefix = schema.idlPrefix
print '''\
/* Generated automatically -- do not modify! -*- buffer-read-only: t -*- */
#include <config.h>
#include %s
#include <limits.h>
-#include "ovsdb-data.h"''' % schema.idlHeader
+#include "ovs-thread.h"
+#include "ovsdb-data.h"
+#include "ovsdb-error.h"
+#include "util.h"
- # Table indexes.
- printEnum(["%sTABLE_%s" % (prefix.upper(), tableName.upper()) for tableName in schema.tables] + ["%sN_TABLES" % prefix.upper()])
- print "\nstatic struct ovsdb_idl_table_class %stable_classes[%sN_TABLES];" % (prefix, prefix.upper())
+#ifdef __CHECKER__
+/* Sparse dislikes sizeof(bool) ("warning: expression using sizeof bool"). */
+enum { sizeof_bool = 1 };
+#else
+enum { sizeof_bool = sizeof(bool) };
+#endif
+
+static bool inited;
+''' % schema.idlHeader
# Cast functions.
- for tableName, table in schema.tables.iteritems():
+ for tableName, table in sorted(schema.tables.iteritems()):
structName = "%s%s" % (prefix, tableName.lower())
print '''
static struct %(s)s *
-%(s)s_cast(struct ovsdb_idl_row *row)
+%(s)s_cast(const struct ovsdb_idl_row *row)
{
return row ? CONTAINER_OF(row, struct %(s)s, header_) : NULL;
}\
''' % {'s': structName}
- for tableName, table in schema.tables.iteritems():
+ for tableName, table in sorted(schema.tables.iteritems()):
structName = "%s%s" % (prefix, tableName.lower())
print "\f"
- if table.comment != None:
- print "/* %s table (%s). */" % (tableName, table.comment)
- else:
- print "/* %s table. */" % (tableName)
-
- # Column indexes.
- printEnum(["%s_COL_%s" % (structName.upper(), columnName.upper())
- for columnName in table.columns]
- + ["%s_N_COLUMNS" % structName.upper()])
-
- print "\nstatic struct ovsdb_idl_column %s_columns[];" % structName
+ print "/* %s table. */" % (tableName)
- # Parse function.
- print '''
+ # Parse functions.
+ for columnName, column in sorted(table.columns.iteritems()):
+ print '''
static void
-%s_parse(struct ovsdb_idl_row *row_)
+%(s)s_parse_%(c)s(struct ovsdb_idl_row *row_, const struct ovsdb_datum *datum)
{
- struct %s *row = %s_cast(row_);
- const struct ovsdb_datum *datum;
- size_t i UNUSED;
-
- memset(row_ + 1, 0, sizeof *row - sizeof *row_);''' % (structName, structName, structName)
-
-
- for columnName, column in table.columns.iteritems():
+ struct %(s)s *row = %(s)s_cast(row_);''' % {'s': structName,
+ 'c': columnName}
type = column.type
- refKey = type.key == "uuid" and type.keyRefTable
- refValue = type.value == "uuid" and type.valueRefTable
- print
- print " datum = &row_->old[%s_COL_%s];" % (structName.upper(), columnName.upper())
if type.value:
keyVar = "row->key_%s" % columnName
valueVar = "row->value_%s" % columnName
keyVar = "row->%s" % columnName
valueVar = None
- if (type.min == 1 and type.max == 1) or typeIsOptionalPointer(type):
+ if type.is_smap():
+ print " size_t i;"
+ print
+ print " ovs_assert(inited);"
+ print " smap_init(&row->%s);" % columnName
+ print " for (i = 0; i < datum->n; i++) {"
+ print " smap_add(&row->%s," % columnName
+ print " datum->keys[i].string,"
+ print " datum->values[i].string);"
+ print " }"
+ elif (type.n_min == 1 and type.n_max == 1) or type.is_optional_pointer():
+ print
+ print " ovs_assert(inited);"
print " if (datum->n >= 1) {"
- if not refKey:
- print " %s = datum->keys[0].%s;" % (keyVar, type.key)
+ if not type.key.ref_table:
+ print " %s = datum->keys[0].%s;" % (keyVar, type.key.type.to_string())
else:
- 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())
+ 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.name.lower(), prefix, prefix.upper(), type.key.ref_table.name.upper())
if valueVar:
- if refValue:
- print " %s = datum->values[0].%s;" % (valueVar, type.value)
+ if type.value.ref_table:
+ print " %s = datum->values[0].%s;" % (valueVar, type.value.type.to_string())
else:
- 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())
- if (not typeIsOptionalPointer(type) and
- (type.key == "string" or type.value == "string")):
- print " } else {"
- if type.key == "string":
- print " %s = \"\";" % keyVar
- if type.value == "string":
- print " %s = \"\";" % valueVar
+ 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.name.lower(), prefix, prefix.upper(), type.value.ref_table.name.upper())
+ print " } else {"
+ print " %s" % type.key.initCDefault(keyVar, type.n_min == 0)
+ if valueVar:
+ print " %s" % type.value.initCDefault(valueVar, type.n_min == 0)
print " }"
-
else:
- if type.max != 'unlimited':
- nMax = "MIN(%d, datum->n)" % type.max
+ if type.n_max != sys.maxint:
+ print " size_t n = MIN(%d, datum->n);" % type.n_max
+ nMax = "n"
else:
nMax = "datum->n"
+ print " size_t i;"
+ print
+ print " ovs_assert(inited);"
+ print " %s = NULL;" % keyVar
+ if valueVar:
+ print " %s = NULL;" % valueVar
+ print " row->n_%s = 0;" % columnName
print " for (i = 0; i < %s; i++) {" % nMax
refs = []
- if refKey:
- 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())
+ if type.key.ref_table:
+ 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.name.lower(), prefix, type.key.ref_table.name.lower(), prefix, prefix.upper(), type.key.ref_table.name.upper())
keySrc = "keyRow"
refs.append('keyRow')
else:
- keySrc = "datum->keys[i].%s" % type.key
- if refValue:
- 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())
+ keySrc = "datum->keys[i].%s" % type.key.type.to_string()
+ if type.value and type.value.ref_table:
+ 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.name.lower(), prefix, type.value.ref_table.name.lower(), prefix, prefix.upper(), type.value.ref_table.name.upper())
valueSrc = "valueRow"
refs.append('valueRow')
elif valueVar:
- valueSrc = "datum->values[i].%s" % type.value
+ valueSrc = "datum->values[i].%s" % type.value.type.to_string()
if refs:
print " if (%s) {" % ' && '.join(refs)
indent = " "
else:
indent = " "
print "%sif (!row->n_%s) {" % (indent, columnName)
- print "%s %s = xmalloc(%s * sizeof *%s);" % (indent, keyVar, nMax, keyVar)
+
+ # Special case for boolean types. This is only here because
+ # sparse does not like the "normal" case ("warning: expression
+ # using sizeof bool").
+ if type.key.type == ovs.db.types.BooleanType:
+ sizeof = "sizeof_bool"
+ else:
+ sizeof = "sizeof *%s" % keyVar
+ print "%s %s = xmalloc(%s * %s);" % (indent, keyVar, nMax,
+ sizeof)
if valueVar:
- print "%s %s = xmalloc(%s * sizeof %s);" % (indent, valueVar, nMax, valueVar)
+ # Special case for boolean types (see above).
+ if type.value.type == ovs.db.types.BooleanType:
+ sizeof = " * sizeof_bool"
+ else:
+ sizeof = "sizeof *%s" % valueVar
+ print "%s %s = xmalloc(%s * %s);" % (indent, valueVar,
+ nMax, sizeof)
print "%s}" % indent
print "%s%s[row->n_%s] = %s;" % (indent, keyVar, columnName, keySrc)
if valueVar:
if refs:
print " }"
print " }"
- print "}"
+ print "}"
- # Unparse function.
- nArrays = 0
- for columnName, column in table.columns.iteritems():
+ # Unparse functions.
+ for columnName, column in sorted(table.columns.iteritems()):
type = column.type
- if (type.min != 1 or type.max != 1) and not typeIsOptionalPointer(type):
- if not nArrays:
- print '''
+ if type.is_smap() or (type.n_min != 1 or type.n_max != 1) and not type.is_optional_pointer():
+ print '''
static void
-%s_unparse(struct ovsdb_idl_row *row_)
+%(s)s_unparse_%(c)s(struct ovsdb_idl_row *row_)
{
- struct %s *row = %s_cast(row_);
-''' % (structName, structName, structName)
- if type.value:
- keyVar = "row->key_%s" % columnName
- valueVar = "row->value_%s" % columnName
+ struct %(s)s *row = %(s)s_cast(row_);
+
+ ovs_assert(inited);''' % {'s': structName, 'c': columnName}
+
+ if type.is_smap():
+ print " smap_destroy(&row->%s);" % columnName
else:
- keyVar = "row->%s" % columnName
- valueVar = None
- print " free(%s);" % keyVar
- if valueVar:
- print " free(%s);" % valueVar
- nArrays += 1
- if not nArrays:
- print '''
+ if type.value:
+ keyVar = "row->key_%s" % columnName
+ valueVar = "row->value_%s" % columnName
+ else:
+ keyVar = "row->%s" % columnName
+ valueVar = None
+ print " free(%s);" % keyVar
+ if valueVar:
+ print " free(%s);" % valueVar
+ print '}'
+ else:
+ print '''
+static void
+%(s)s_unparse_%(c)s(struct ovsdb_idl_row *row OVS_UNUSED)
+{
+ /* Nothing to do. */
+}''' % {'s': structName, 'c': columnName}
+
+ # Generic Row Initialization function.
+ print """
static void
-%s_unparse(struct ovsdb_idl_row *row UNUSED)
-{''' % (structName)
+%(s)s_init__(struct ovsdb_idl_row *row)
+{
+ %(s)s_init(%(s)s_cast(row));
+}""" % {'s': structName}
+
+ # Row Initialization function.
+ print """
+void
+%(s)s_init(struct %(s)s *row)
+{
+ memset(row, 0, sizeof *row); """ % {'s': structName}
+ for columnName, column in sorted(table.columns.iteritems()):
+ if column.type.is_smap():
+ print " smap_init(&row->%s);" % columnName
print "}"
# First, next functions.
print '''
+const struct %(s)s *
+%(s)s_get_for_uuid(const struct ovsdb_idl *idl, const struct uuid *uuid)
+{
+ return %(s)s_cast(ovsdb_idl_get_row_for_uuid(idl, &%(p)stable_classes[%(P)sTABLE_%(T)s], uuid));
+}
+
const struct %(s)s *
%(s)s_first(const struct ovsdb_idl *idl)
{
print '''
void
-%(s)s_delete(const struct %(s)s *row_)
+%(s)s_delete(const struct %(s)s *row)
{
- struct %(s)s *row = (struct %(s)s *) row_;
ovsdb_idl_txn_delete(&row->header_);
}
struct %(s)s *
%(s)s_insert(struct ovsdb_idl_txn *txn)
{
- return %(s)s_cast(ovsdb_idl_txn_insert(txn, &%(p)stable_classes[%(P)sTABLE_%(T)s]));
+ return %(s)s_cast(ovsdb_idl_txn_insert(txn, &%(p)stable_classes[%(P)sTABLE_%(T)s], NULL));
}
''' % {'s': structName,
'p': prefix,
'T': tableName.upper()}
# Verify functions.
- for columnName, column in table.columns.iteritems():
+ for columnName, column in sorted(table.columns.iteritems()):
print '''
void
%(s)s_verify_%(c)s(const struct %(s)s *row)
{
+ ovs_assert(inited);
ovsdb_idl_txn_verify(&row->header_, &%(s)s_columns[%(S)s_COL_%(C)s]);
}''' % {'s': structName,
'S': structName.upper(),
'c': columnName,
'C': columnName.upper()}
+ # Get functions.
+ for columnName, column in sorted(table.columns.iteritems()):
+ if column.type.value:
+ valueParam = ',\n\tenum ovsdb_atomic_type value_type OVS_UNUSED'
+ valueType = '\n ovs_assert(value_type == %s);' % column.type.value.toAtomicType()
+ valueComment = "\n * 'value_type' must be %s." % column.type.value.toAtomicType()
+ else:
+ valueParam = ''
+ valueType = ''
+ valueComment = ''
+ print """
+/* Returns the %(c)s column's value in 'row' as a struct ovsdb_datum.
+ * This is useful occasionally: for example, ovsdb_datum_find_key() is an
+ * easier and more efficient way to search for a given key than implementing
+ * the same operation on the "cooked" form in 'row'.
+ *
+ * 'key_type' must be %(kt)s.%(vc)s
+ * (This helps to avoid silent bugs if someone changes %(c)s's
+ * type without updating the caller.)
+ *
+ * The caller must not modify or free the returned value.
+ *
+ * Various kinds of changes can invalidate the returned value: modifying
+ * 'column' within 'row', deleting 'row', or completing an ongoing transaction.
+ * If the returned value is needed for a long time, it is best to make a copy
+ * of it with ovsdb_datum_clone(). */
+const struct ovsdb_datum *
+%(s)s_get_%(c)s(const struct %(s)s *row,
+\tenum ovsdb_atomic_type key_type OVS_UNUSED%(v)s)
+{
+ ovs_assert(key_type == %(kt)s);%(vt)s
+ return ovsdb_idl_read(&row->header_, &%(s)s_col_%(c)s);
+}""" % {'s': structName, 'c': columnName,
+ 'kt': column.type.key.toAtomicType(),
+ 'v': valueParam, 'vt': valueType, 'vc': valueComment}
+
# Set functions.
- for columnName, column in table.columns.iteritems():
+ for columnName, column in sorted(table.columns.iteritems()):
type = column.type
+
+ if type.is_smap():
+ print """
+void
+%(s)s_set_%(c)s(const struct %(s)s *row, const struct smap *smap)
+{
+ struct ovsdb_datum datum;
+
+ ovs_assert(inited);
+ if (smap) {
+ struct smap_node *node;
+ size_t i;
+
+ datum.n = smap_count(smap);
+ datum.keys = xmalloc(datum.n * sizeof *datum.keys);
+ datum.values = xmalloc(datum.n * sizeof *datum.values);
+
+ i = 0;
+ SMAP_FOR_EACH (node, smap) {
+ datum.keys[i].string = xstrdup(node->key);
+ datum.values[i].string = xstrdup(node->value);
+ i++;
+ }
+ ovsdb_datum_sort_unique(&datum, OVSDB_TYPE_STRING, OVSDB_TYPE_STRING);
+ } else {
+ ovsdb_datum_init_empty(&datum);
+ }
+ ovsdb_idl_txn_write(&row->header_,
+ &%(s)s_columns[%(S)s_COL_%(C)s],
+ &datum);
+}
+""" % {'s': structName,
+ 'S': structName.upper(),
+ 'c': columnName,
+ 'C': columnName.upper()}
+ continue
+
+
print '\nvoid'
- members = cMembers(prefix, columnName, column)
+ members = cMembers(prefix, columnName, column, True)
keyVar = members[0]['name']
nVar = None
valueVar = None
else:
if len(members) > 1:
nVar = members[1]['name']
- print '%(s)s_set_%(c)s(const struct %(s)s *row_, %(args)s)' % \
+ print '%(s)s_set_%(c)s(const struct %(s)s *row, %(args)s)' % \
{'s': structName, 'c': columnName,
'args': ', '.join(['%(type)s%(name)s' % m for m in members])}
print "{"
- print " struct %(s)s *row = (struct %(s)s *) row_;" % {'s': structName}
print " struct ovsdb_datum datum;"
- if type.min == 1 and type.max == 1:
+ if type.n_min == 1 and type.n_max == 1:
+ print " union ovsdb_atom key;"
+ if type.value:
+ print " union ovsdb_atom value;"
print
+ print " ovs_assert(inited);"
print " datum.n = 1;"
- print " datum.keys = xmalloc(sizeof *datum.keys);"
- print " %s" % cCopyType("datum.keys[0].%s" % type.key, keyVar, type.key, type.keyRefTable)
+ print " datum.keys = &key;"
+ print " " + type.key.assign_c_value_casting_away_const("key.%s" % type.key.type.to_string(), keyVar)
if type.value:
- print " datum.values = xmalloc(sizeof *datum.values);"
- print " %s" % cCopyType("datum.values[0].%s" % type.value, valueVar, type.value, type.valueRefTable)
+ print " datum.values = &value;"
+ print " "+ type.value.assign_c_value_casting_away_const("value.%s" % type.value.type.to_string(), valueVar)
else:
print " datum.values = NULL;"
- elif typeIsOptionalPointer(type):
+ txn_write_func = "ovsdb_idl_txn_write_clone"
+ elif type.is_optional_pointer():
+ print " union ovsdb_atom key;"
print
+ print " ovs_assert(inited);"
print " if (%s) {" % keyVar
print " datum.n = 1;"
- print " datum.keys = xmalloc(sizeof *datum.keys);"
- print " %s" % cCopyType("datum.keys[0].%s" % type.key, keyVar, type.key, type.keyRefTable)
+ print " datum.keys = &key;"
+ print " " + type.key.assign_c_value_casting_away_const("key.%s" % type.key.type.to_string(), keyVar)
+ print " } else {"
+ print " datum.n = 0;"
+ print " datum.keys = NULL;"
+ print " }"
+ print " datum.values = NULL;"
+ txn_write_func = "ovsdb_idl_txn_write_clone"
+ elif type.n_max == 1:
+ print " union ovsdb_atom key;"
+ print
+ print " ovs_assert(inited);"
+ print " if (%s) {" % nVar
+ print " datum.n = 1;"
+ print " datum.keys = &key;"
+ print " " + type.key.assign_c_value_casting_away_const("key.%s" % type.key.type.to_string(), "*" + keyVar)
print " } else {"
print " datum.n = 0;"
print " datum.keys = NULL;"
print " }"
print " datum.values = NULL;"
+ txn_write_func = "ovsdb_idl_txn_write_clone"
else:
print " size_t i;"
print
+ print " ovs_assert(inited);"
print " datum.n = %s;" % nVar
- print " datum.keys = xmalloc(%s * sizeof *datum.keys);" % nVar
+ print " datum.keys = %s ? xmalloc(%s * sizeof *datum.keys) : NULL;" % (nVar, nVar)
if type.value:
print " datum.values = xmalloc(%s * sizeof *datum.values);" % nVar
else:
print " datum.values = NULL;"
print " for (i = 0; i < %s; i++) {" % nVar
- print " %s" % cCopyType("datum.keys[i].%s" % type.key, "%s[i]" % keyVar, type.key, type.keyRefTable)
+ print " " + type.key.copyCValue("datum.keys[i].%s" % type.key.type.to_string(), "%s[i]" % keyVar)
if type.value:
- print " %s" % cCopyType("datum.values[i].%s" % type.value, "%s[i]" % valueVar, type.value, type.valueRefTable)
+ print " " + type.value.copyCValue("datum.values[i].%s" % type.value.type.to_string(), "%s[i]" % valueVar)
print " }"
- print " ovsdb_idl_txn_write(&row->header_, &%(s)s_columns[%(S)s_COL_%(C)s], &datum);" \
- % {'s': structName,
+ if type.value:
+ valueType = type.value.toAtomicType()
+ else:
+ valueType = "OVSDB_TYPE_VOID"
+ print " ovsdb_datum_sort_unique(&datum, %s, %s);" % (
+ type.key.toAtomicType(), valueType)
+ txn_write_func = "ovsdb_idl_txn_write"
+ print " %(f)s(&row->header_, &%(s)s_columns[%(S)s_COL_%(C)s], &datum);" \
+ % {'f': txn_write_func,
+ 's': structName,
'S': structName.upper(),
'C': columnName.upper()}
print "}"
# Table columns.
- print "\nstatic struct ovsdb_idl_column %s_columns[%s_N_COLUMNS] = {" % (
+ print "\nstruct ovsdb_idl_column %s_columns[%s_N_COLUMNS];" % (
structName, structName.upper())
- for columnName, column in table.columns.iteritems():
- type = column.type
-
- if type.value:
- valueTypeName = type.value.upper()
- else:
- valueTypeName = "VOID"
- if type.max == "unlimited":
- max = "UINT_MAX"
+ print """
+static void\n%s_columns_init(void)
+{
+ struct ovsdb_idl_column *c;\
+""" % structName
+ for columnName, column in sorted(table.columns.iteritems()):
+ cs = "%s_col_%s" % (structName, columnName)
+ d = {'cs': cs, 'c': columnName, 's': structName}
+ if column.mutable:
+ mutable = "true"
else:
- max = type.max
- print " {\"%s\", {OVSDB_TYPE_%s, OVSDB_TYPE_%s, %d, %s}}," % (
- columnName, type.key.upper(), valueTypeName,
- type.min, max)
- print "};"
+ mutable = "false"
+ print
+ print " /* Initialize %(cs)s. */" % d
+ print " c = &%(cs)s;" % d
+ print " c->name = \"%(c)s\";" % d
+ print column.type.cInitType(" ", "c->type")
+ print " c->mutable = %s;" % mutable
+ print " c->parse = %(s)s_parse_%(c)s;" % d
+ print " c->unparse = %(s)s_unparse_%(c)s;" % d
+ print "}"
# Table classes.
print "\f"
- print "static struct ovsdb_idl_table_class %stable_classes[%sN_TABLES] = {" % (prefix, prefix.upper())
- for tableName, table in schema.tables.iteritems():
+ print "struct ovsdb_idl_table_class %stable_classes[%sN_TABLES] = {" % (prefix, prefix.upper())
+ for tableName, table in sorted(schema.tables.iteritems()):
structName = "%s%s" % (prefix, tableName.lower())
- print " {\"%s\"," % tableName
+ if table.is_root:
+ is_root = "true"
+ else:
+ is_root = "false"
+ print " {\"%s\", %s," % (tableName, is_root)
print " %s_columns, ARRAY_SIZE(%s_columns)," % (
structName, structName)
- print " sizeof(struct %s)," % structName
- print " %s_parse," % structName
- print " %s_unparse}," % structName
+ print " sizeof(struct %s), %s_init__}," % (structName, structName)
print "};"
# IDL class.
print "\nstruct ovsdb_idl_class %sidl_class = {" % prefix
- print " %stable_classes, ARRAY_SIZE(%stable_classes)" % (prefix, prefix)
+ print " \"%s\", %stable_classes, ARRAY_SIZE(%stable_classes)" % (
+ schema.name, prefix, prefix)
print "};"
+ # global init function
+ print """
+void
+%sinit(void)
+{
+ if (inited) {
+ return;
+ }
+ assert_single_threaded();
+ inited = true;
+""" % prefix
+ for tableName, table in sorted(schema.tables.iteritems()):
+ structName = "%s%s" % (prefix, tableName.lower())
+ print " %s_columns_init();" % structName
+ print "}"
+
+ print """
+/* Return the schema version. The caller must not free the returned value. */
+const char *
+%sget_db_version(void)
+{
+ return "%s";
+}
+""" % (prefix, schema.version)
+
+
+
def ovsdb_escape(string):
def escape(match):
c = match.group(0)
if c == '\0':
- raise Error("strings may not contain null bytes")
+ raise ovs.db.error.Error("strings may not contain null bytes")
elif c == '\\':
return '\\\\'
elif c == '\n':
return '\\x%02x' % ord(c)
return re.sub(r'["\\\000-\037]', escape, string)
-def printOVSDBSchema(schema):
- json.dump(schema.toJson(), sys.stdout, sort_keys=True, indent=2)
-
def usage():
print """\
%(argv0)s: ovsdb schema compiler
-usage: %(argv0)s [OPTIONS] ACTION SCHEMA
-where SCHEMA is the ovsdb schema to read (in JSON format).
+usage: %(argv0)s [OPTIONS] COMMAND ARG...
-One of the following actions must specified:
- validate validate schema without taking any other action
- c-idl-header print C header file for IDL
- c-idl-source print C source file for IDL implementation
- ovsdb-schema print ovsdb parseable schema
+The following commands are supported:
+ annotate SCHEMA ANNOTATIONS print SCHEMA combined with ANNOTATIONS
+ c-idl-header IDL print C header file for IDL
+ c-idl-source IDL print C source file for IDL implementation
+ nroff IDL print schema documentation in nroff format
The following options are also available:
-h, --help display this help message
if __name__ == "__main__":
try:
try:
- options, args = getopt.gnu_getopt(sys.argv[1:], 'hV',
- ['help',
+ options, args = getopt.gnu_getopt(sys.argv[1:], 'C:hV',
+ ['directory',
+ 'help',
'version'])
except getopt.GetoptError, geo:
sys.stderr.write("%s: %s\n" % (argv0, geo.msg))
sys.exit(1)
-
+
+ for key, value in options:
+ if key in ['-h', '--help']:
+ usage()
+ elif key in ['-V', '--version']:
+ print "ovsdb-idlc (Open vSwitch) @VERSION@"
+ elif key in ['-C', '--directory']:
+ os.chdir(value)
+ else:
+ sys.exit(0)
+
optKeys = [key for key, value in options]
- if '-h' in optKeys or '--help' in optKeys:
- usage()
- elif '-V' in optKeys or '--version' in optKeys:
- print "ovsdb-idlc (Open vSwitch) @VERSION@"
- sys.exit(0)
-
- if len(args) != 2:
- sys.stderr.write("%s: exactly two non-option arguments are "
- "required (use --help for help)\n" % argv0)
+
+ if not args:
+ sys.stderr.write("%s: missing command argument "
+ "(use --help for help)\n" % argv0)
sys.exit(1)
- action, inputFile = args
- schema = parseSchema(inputFile)
- if action == 'validate':
- pass
- elif action == 'ovsdb-schema':
- printOVSDBSchema(schema)
- elif action == 'c-idl-header':
- printCIDLHeader(schema)
- elif action == 'c-idl-source':
- printCIDLSource(schema)
- else:
- sys.stderr.write(
- "%s: unknown action '%s' (use --help for help)\n" %
- (argv0, action))
+ commands = {"annotate": (annotateSchema, 2),
+ "c-idl-header": (printCIDLHeader, 1),
+ "c-idl-source": (printCIDLSource, 1)}
+
+ if not args[0] in commands:
+ sys.stderr.write("%s: unknown command \"%s\" "
+ "(use --help for help)\n" % (argv0, args[0]))
sys.exit(1)
- except Error, e:
- sys.stderr.write("%s: %s\n" % (argv0, e.msg))
+
+ func, n_args = commands[args[0]]
+ if len(args) - 1 != n_args:
+ sys.stderr.write("%s: \"%s\" requires %d arguments but %d "
+ "provided\n"
+ % (argv0, args[0], n_args, len(args) - 1))
+ sys.exit(1)
+
+ func(*args[1:])
+ except ovs.db.error.Error, e:
+ sys.stderr.write("%s: %s\n" % (argv0, e))
sys.exit(1)
# Local variables:
git://git.onelab.eu / sliver-openvswitch.git / blobdiff