python: Implement write support in Python IDL for OVSDB.
[sliver-openvswitch.git] / ovsdb / ovsdb-idlc.in
index 6c33f07..4e40288 100755 (executable)
@@ -5,89 +5,36 @@ import os
 import re
 import sys
 
-sys.path.insert(0, "@abs_top_srcdir@/ovsdb")
-import simplejson as json
-
-from OVSDB import *
+import ovs.json
+import ovs.db.error
+import ovs.db.schema
 
 argv0 = sys.argv[0]
 
-class Datum:
-    def __init__(self, type, values):
-        self.type = type
-        self.values = values
-
-    @staticmethod
-    def fromJson(type_, json):
-        if not type_.value:
-            if len(json) == 2 and json[0] == "set":
-                values = []
-                for atomJson in json[1]:
-                    values += [Atom.fromJson(type_.key, atomJson)]
-            else:
-                values = [Atom.fromJson(type_.key, json)]
-        else:
-            if len(json) != 2 or json[0] != "map":
-                raise Error("%s is not valid JSON for a map" % json)
-            values = []
-            for pairJson in json[1]:
-                values += [(Atom.fromJson(type_.key, pairJson[0]),
-                            Atom.fromJson(type_.value, pairJson[1]))]
-        return Datum(type_, values)
-
-    def cInitDatum(self, var):
-        if len(self.values) == 0:
-            return ["ovsdb_datum_init_empty(%s);" % var]
-
-        s = ["%s->n = %d;" % (var, len(self.values))]
-        s += ["%s->keys = xmalloc(%d * sizeof *%s->keys);"
-              % (var, len(self.values), var)]
-
-        for i in range(len(self.values)):
-            key = self.values[i]
-            if self.type.value:
-                key = key[0]
-            s += key.cInitAtom("%s->keys[%d]" % (var, i))
-        
-        if self.type.value:
-            s += ["%s->values = xmalloc(%d * sizeof *%s->values);"
-                  % (var, len(self.values), var)]
-            for i in range(len(self.values)):
-                value = self.values[i][1]
-                s += key.cInitAtom("%s->values[%d]" % (var, i))
-        else:
-            s += ["%s->values = NULL;" % var]
-
-        if len(self.values) > 1:
-            s += ["ovsdb_datum_sort_assert(%s, OVSDB_TYPE_%s);"
-                  % (var, self.type.key.upper())]
-
-        return s
-
 def parseSchema(filename):
-    return IdlSchema.fromJson(json.load(open(filename, "r")))
+    return ovs.db.schema.IdlSchema.from_json(ovs.json.from_file(filename))
 
 def annotateSchema(schemaFile, annotationFile):
-    schemaJson = json.load(open(schemaFile, "r"))
+    schemaJson = ovs.json.from_file(schemaFile)
     execfile(annotationFile, globals(), {"s": schemaJson})
-    json.dump(schemaJson, sys.stdout)
+    ovs.json.to_stream(schemaJson, sys.stdout)
 
 def constify(cType, const):
-    if (const
-        and cType.endswith('*') and not cType.endswith('**')
-        and (cType.startswith('struct uuid') or cType.startswith('char'))):
+    if (const and cType.endswith('*') and not cType.endswith('**')):
         return 'const %s' % cType
     else:
         return cType
 
 def cMembers(prefix, columnName, column, const):
     type = column.type
-    if type.min == 1 and type.max == 1:
+    if is_optional_bool(type):
+        const = True
+    if type.n_min == 1 and type.n_max == 1:
         singleton = True
         pointer = ''
     else:
         singleton = False
-        if type.isOptionalPointer():
+        if type.is_optional_pointer():
             pointer = ''
         else:
             pointer = '*'
@@ -106,7 +53,7 @@ def cMembers(prefix, columnName, column, const):
              'comment': type.cDeclComment()}
         members = [m]
 
-    if not singleton and not type.isOptionalPointer():
+    if not singleton and not type.is_optional_pointer():
         members.append({'name': 'n_%s' % columnName,
                         'type': 'size_t ',
                         'comment': ''})
@@ -220,6 +167,10 @@ def printEnum(members):
     print "    %s" % members[-1]
     print "};"
 
+def is_optional_bool(type):
+    return (type.key.type == ovs.db.types.BooleanType and not type.value
+            and type.n_min == 0 and type.n_max == 1)
+
 def printCIDLSource(schemaFile):
     schema = parseSchema(schemaFile)
     prefix = schema.idlPrefix
@@ -270,28 +221,44 @@ static void
                 keyVar = "row->%s" % columnName
                 valueVar = None
 
-            if (type.min == 1 and type.max == 1) or type.isOptionalPointer():
+            if is_optional_bool(type):
+                # Special case for an optional bool.  This is only here because
+                # sparse does not like the "normal" case below ("warning:
+                # expression using sizeof bool").
                 print
                 print "    assert(inited);"
                 print "    if (datum->n >= 1) {"
-                if not type.key.refTable:
-                    print "        %s = datum->keys[0].%s;" % (keyVar, type.key.type)
+                print "        static const bool false_value = false;"
+                print "        static const bool true_value = true;"
+                print
+                print "        row->n_%s = 1;" % columnName
+                print "        %s = datum->keys[0].boolean ? &true_value : &false_value;" % keyVar
+                print "    } else {"
+                print "        row->n_%s = 0;" % columnName
+                print "        %s = NULL;" % keyVar
+                print "    }"
+            elif (type.n_min == 1 and type.n_max == 1) or type.is_optional_pointer():
+                print
+                print "    assert(inited);"
+                print "    if (datum->n >= 1) {"
+                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.key.refTable.lower(), prefix, prefix.upper(), type.key.refTable.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 type.value.refTable:
-                        print "        %s = datum->values[0].%s;" % (valueVar, type.value.type)
+                    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.value.refTable.lower(), prefix, prefix.upper(), type.value.refTable.upper())
+                        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.min == 0)
+                print "        %s" % type.key.initCDefault(keyVar, type.n_min == 0)
                 if valueVar:
-                    print "        %s" % type.value.initCDefault(valueVar, type.min == 0)
+                    print "        %s" % type.value.initCDefault(valueVar, type.n_min == 0)
                 print "    }"
             else:
-                if type.max != 'unlimited':
-                    print "    size_t n = 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"
@@ -304,18 +271,18 @@ static void
                 print "    row->n_%s = 0;" % columnName
                 print "    for (i = 0; i < %s; i++) {" % nMax
                 refs = []
-                if type.key.refTable:
-                    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())
+                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.type
-                if type.value and type.value.refTable:
-                    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())
+                    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.type
+                    valueSrc = "datum->values[i].%s" % type.value.type.to_string()
                 if refs:
                     print "        if (%s) {" % ' && '.join(refs)
                     indent = "            "
@@ -338,7 +305,15 @@ static void
         # Unparse functions.
         for columnName, column in sorted(table.columns.iteritems()):
             type = column.type
-            if (type.min != 1 or type.max != 1) and not type.isOptionalPointer():
+            if (type.key.type == ovs.db.types.BooleanType and not type.value
+                and type.n_min == 0 and type.n_max == 1):
+                print '''
+static void
+%(s)s_unparse_%(c)s(struct ovsdb_idl_row *row OVS_UNUSED)
+{
+    /* Nothing to do. */
+}''' % {'s': structName, 'c': columnName}
+            elif (type.n_min != 1 or type.n_max != 1) and not type.is_optional_pointer():
                 print '''
 static void
 %(s)s_unparse_%(c)s(struct ovsdb_idl_row *row_)
@@ -363,7 +338,7 @@ static void
 {
     /* Nothing to do. */
 }''' % {'s': structName, 'c': columnName}
+
         # First, next functions.
         print '''
 const struct %(s)s *
@@ -467,24 +442,24 @@ const struct ovsdb_datum *
                  'args': ', '.join(['%(type)s%(name)s' % m for m in members])}
             print "{"
             print "    struct ovsdb_datum datum;"
-            if type.min == 1 and type.max == 1:
+            if type.n_min == 1 and type.n_max == 1:
                 print
                 print "    assert(inited);"
                 print "    datum.n = 1;"
                 print "    datum.keys = xmalloc(sizeof *datum.keys);"
-                print "    " + type.key.copyCValue("datum.keys[0].%s" % type.key.type, keyVar)
+                print "    " + type.key.copyCValue("datum.keys[0].%s" % type.key.type.to_string(), keyVar)
                 if type.value:
                     print "    datum.values = xmalloc(sizeof *datum.values);"
-                    print "    "+ type.value.copyCValue("datum.values[0].%s" % type.value.type, valueVar)
+                    print "    "+ type.value.copyCValue("datum.values[0].%s" % type.value.type.to_string(), valueVar)
                 else:
                     print "    datum.values = NULL;"
-            elif type.isOptionalPointer():
+            elif type.is_optional_pointer():
                 print
                 print "    assert(inited);"
                 print "    if (%s) {" % keyVar
                 print "        datum.n = 1;"
                 print "        datum.keys = xmalloc(sizeof *datum.keys);"
-                print "        " + type.key.copyCValue("datum.keys[0].%s" % type.key.type, keyVar)
+                print "        " + type.key.copyCValue("datum.keys[0].%s" % type.key.type.to_string(), keyVar)
                 print "    } else {"
                 print "        datum.n = 0;"
                 print "        datum.keys = NULL;"
@@ -501,9 +476,9 @@ const struct ovsdb_datum *
                 else:
                     print "    datum.values = NULL;"
                 print "    for (i = 0; i < %s; i++) {" % nVar
-                print "        " + type.key.copyCValue("datum.keys[i].%s" % type.key.type, "%s[i]" % keyVar)
+                print "        " + type.key.copyCValue("datum.keys[i].%s" % type.key.type.to_string(), "%s[i]" % keyVar)
                 if type.value:
-                    print "        " + type.value.copyCValue("datum.values[i].%s" % type.value.type, "%s[i]" % valueVar)
+                    print "        " + type.value.copyCValue("datum.values[i].%s" % type.value.type.to_string(), "%s[i]" % valueVar)
                 print "    }"
                 if type.value:
                     valueType = type.value.toAtomicType()
@@ -542,7 +517,11 @@ static void\n%s_columns_init(void)
     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
@@ -569,11 +548,26 @@ void
         print "    %s_columns_init();" % structName
     print "}"
 
+def print_python_module(schema_file):
+    schema = ovs.db.schema.DbSchema.from_json(ovs.json.from_file(schema_file))
+    print """\
+# Generated automatically -- do not modify!    -*- buffer-read-only: t -*-
+
+import ovs.db.schema
+import ovs.json
+
+__schema_json = \"\"\"
+%s
+\"\"\"
+
+schema = ovs.db.schema.DbSchema.from_json(ovs.json.from_string(__schema_json))
+""" % ovs.json.to_string(schema.to_json(), pretty=True)
+
 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':
@@ -590,8 +584,6 @@ def ovsdb_escape(string):
             return '\\x%02x' % ord(c)
     return re.sub(r'["\\\000-\037]', escape, string)
 
-
-
 def usage():
     print """\
 %(argv0)s: ovsdb schema compiler
@@ -601,6 +593,7 @@ 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
+  python-module IDL           print Python module for IDL
   nroff IDL                   print schema documentation in nroff format
 
 The following options are also available:
@@ -619,7 +612,7 @@ if __name__ == "__main__":
         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()
@@ -629,7 +622,7 @@ if __name__ == "__main__":
                 os.chdir(value)
             else:
                 sys.exit(0)
-            
+
         optKeys = [key for key, value in options]
 
         if not args:
@@ -639,7 +632,8 @@ if __name__ == "__main__":
 
         commands = {"annotate": (annotateSchema, 2),
                     "c-idl-header": (printCIDLHeader, 1),
-                    "c-idl-source": (printCIDLSource, 1)}
+                    "c-idl-source": (printCIDLSource, 1),
+                    "python-module": (print_python_module, 1)}
 
         if not args[0] in commands:
             sys.stderr.write("%s: unknown command \"%s\" "
@@ -654,8 +648,8 @@ if __name__ == "__main__":
             sys.exit(1)
 
         func(*args[1:])
-    except Error, e:
-        sys.stderr.write("%s: %s\n" % (argv0, e.msg))
+    except ovs.db.error.Error, e:
+        sys.stderr.write("%s: %s\n" % (argv0, e))
         sys.exit(1)
 
 # Local variables: