X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=ovsdb%2Fovsdb-idlc.in;h=d70e5ebb618770a51a411b157f579129b309a053;hb=7943cd51e7eba1442846a853b6ed62e89a05d110;hp=68cb4ce6fa9f58f6ebc7d1ec6595c6f0dcbe1e4c;hpb=58fda1dab104041fc693032475ec4662c1a52849;p=openvswitch

diff --git a/ovsdb/ovsdb-idlc.in b/ovsdb/ovsdb-idlc.in
index 68cb4ce6..d70e5ebb 100755
--- a/ovsdb/ovsdb-idlc.in
+++ b/ovsdb/ovsdb-idlc.in
@@ -43,8 +43,9 @@ class DbSchema:
         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)
+        for tableName, tableJson in tablesJson.iteritems():
+            tables[tableName] = TableSchema.fromJson(tableJson,
+                                                     "%s table" % tableName)
         idlPrefix = mustGetMember(json, 'idlPrefix', [unicode], 'database')
         idlHeader = mustGetMember(json, 'idlHeader', [unicode], 'database')
         return DbSchema(name, comment, tables, idlPrefix, idlHeader)
@@ -93,7 +94,7 @@ class ColumnSchema:
         type = Type.fromJson(mustGetMember(json, 'type', [dict, unicode],
                                            description),
                              'type of %s' % description)
-        ephemeral = getMember(json, 'ephemeral', [True,False], description)
+        ephemeral = getMember(json, 'ephemeral', [bool], description)
         persistent = ephemeral != True
         return ColumnSchema(comment, type, persistent)
 
@@ -141,6 +142,47 @@ class Type:
                 d["max"] = self.max
             return d
 
+    def isScalar(self):
+        return self.min == 1 and self.max == 1 and not self.value
+
+    def isOptional(self):
+        return self.min == 0 and self.max == 1
+
+    def toEnglish(self):
+        keyName = atomicTypeToEnglish(self.key, self.keyRefTable)
+        if self.value:
+            valueName = atomicTypeToEnglish(self.value, self.valueRefTable)
+
+        if self.isScalar():
+            return atomicTypeToEnglish(self.key, self.keyRefTable)
+        elif self.isOptional():
+            if self.value:
+                return "optional %s-%s pair" % (keyName, valueName)
+            else:
+                return "optional %s" % keyName
+        else:
+            if self.max == "unlimited":
+                if self.min:
+                    quantity = "%d or more " % self.min
+                else:
+                    quantity = ""
+            elif self.min:
+                quantity = "%d to %d " % (self.min, self.max)
+            else:
+                quantity = "up to %d " % self.max
+
+            if self.value:
+                return "map of %s%s-%s pairs" % (quantity, keyName, valueName)
+            else:
+                return "set of %s%s" % (quantity, keyName)
+                
+
+def atomicTypeToEnglish(base, refTable):
+    if base == 'uuid' and refTable:
+        return refTable
+    else:
+        return base
+
 def parseSchema(filename):
     file = open(filename, "r")
     s = ""
@@ -159,6 +201,70 @@ def cBaseType(prefix, type, refTable=None):
                 'boolean': 'bool ',
                 'string': 'char *'}[type]
 
+def cCopyType(indent, dstVar, dst, src, type, refTable=None):
+    args = {'indent': indent,
+            'dstVar': dstVar,
+            'dst': dst,
+            'src': src}
+    if type == 'uuid' and refTable:
+        return ("%(indent)s%(dstVar)s = %(src)s;\n" +
+                "%(indent)s%(dst)s = %(src)s->header_.uuid;") % args
+    elif type == 'string':
+        return "%(indent)s%(dstVar)s = %(dst)s = xstrdup(%(src)s);" % args
+    else:
+        return "%(dstVar)s = %(dst)s = %(src)s;" % args
+
+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 cDeclComment(type):
+    if type.min == 1 and type.max == 1 and type.key == "string":
+        return "\t/* Always nonnull. */"
+    else:
+        return ""
+
+def constify(cType, const):
+    if (const
+        and cType.endswith('*') and not cType.endswith('**')
+        and (cType.startswith('struct uuid') or cType.startswith('char'))):
+        return 'const %s' % cType
+    else:
+        return cType
+
+def cMembers(prefix, columnName, column, const):
+    type = column.type
+    if type.min == 1 and type.max == 1:
+        singleton = True
+        pointer = ''
+    else:
+        singleton = False
+        if typeIsOptionalPointer(type):
+            pointer = ''
+        else:
+            pointer = '*'
+
+    if type.value:
+        key = {'name': "key_%s" % columnName,
+               'type': constify(cBaseType(prefix, type.key, type.keyRefTable) + pointer, const),
+               'comment': ''}
+        value = {'name': "value_%s" % columnName,
+                 'type': constify(cBaseType(prefix, type.value, type.valueRefTable) + pointer, const),
+                 'comment': ''}
+        members = [key, value]
+    else:
+        m = {'name': columnName,
+             'type': constify(cBaseType(prefix, type.key, type.keyRefTable) + pointer, const),
+             'comment': cDeclComment(type)}
+        members = [m]
+
+    if not singleton and not typeIsOptionalPointer(type):
+        members.append({'name': 'n_%s' % columnName,
+                        'type': 'size_t ',
+                        'comment': ''})
+    return members
+
 def printCIDLHeader(schema):
     prefix = schema.idlPrefix
     print '''\
@@ -174,35 +280,36 @@ def printCIDLHeader(schema):
 #include "uuid.h"''' % {'prefix': prefix.upper()}
     for tableName, table in schema.tables.iteritems():
         print
-        if table.comment != None:
-            print "/* %s table (%s). */" % (tableName, table.comment)
-        else:
-            print "/* %s table. */" % (tableName)
+        print "/* %s table. */" % tableName
         structName = "%s%s" % (prefix, tableName.lower())
         print "struct %s {" % structName
         print "\tstruct ovsdb_idl_row header_;"
         for columnName, column in table.columns.iteritems():
             print "\n\t/* %s column. */" % columnName
-            type = column.type
-            if type.min == 1 and type.max == 1:
-                singleton = True
-                pointer = ''
-            else:
-                singleton = False
-                pointer = '*'
-            if type.value:
-                print "\tkey_%s%s%s;" % (cBaseType(prefix, type.key, type.keyRefTable), pointer, columnName)
-                print "\tvalue_%s%s%s;" % (cBaseType(prefix, type.value, type.valueRefTable), pointer, columnName)
-            else:
-                print "\t%s%s%s;" % (cBaseType(prefix, type.key, type.keyRefTable), pointer, columnName)
-            if not singleton:
-                print "\tsize_t n_%s;" % columnName
-        print '''
+            for member in cMembers(prefix, columnName, column, False):
+                print "\t%(type)s%(name)s;%(comment)s" % member
+        print '''\
 };
 
 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))''' % {'s': structName, 'S': structName.upper()}
+#define %(S)s_FOR_EACH(ROW, IDL) for ((ROW) = %(s)s_first(IDL); (ROW); (ROW) = %(s)s_next(ROW))
+
+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():
+            print 'void %(s)s_verify_%(c)s(const struct %(s)s *);' % {'s': structName, 'c': columnName}
+
+        print
+        for columnName, column in 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, True)]
+            print '%s);' % ', '.join(args)
+
     print "\nextern struct ovsdb_idl_class %sidl_class;" % prefix
     print "\n#endif /* %(prefix)sIDL_HEADER */" % {'prefix': prefix.upper()}
 
@@ -230,6 +337,18 @@ def printCIDLSource(schema):
     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())
 
+    # Cast functions.
+    for tableName, table in schema.tables.iteritems():
+        structName = "%s%s" % (prefix, tableName.lower())
+        print '''
+static struct %(s)s *
+%(s)s_cast(struct ovsdb_idl_row *row)
+{
+    return row ? CONTAINER_OF(row, struct %(s)s, header_) : NULL;
+}\
+''' % {'s': structName}
+
+
     for tableName, table in schema.tables.iteritems():
         structName = "%s%s" % (prefix, tableName.lower())
         print ""
@@ -243,12 +362,14 @@ def printCIDLSource(schema):
                    for columnName in table.columns]
                   + ["%s_N_COLUMNS" % structName.upper()])
 
+        print "\nstatic struct ovsdb_idl_column %s_columns[];" % structName
+
         # Parse function.
         print '''
 static void
 %s_parse(struct ovsdb_idl_row *row_)
 {
-    struct %s *row = (struct %s *) row_;
+    struct %s *row = %s_cast(row_);
     const struct ovsdb_datum *datum;
     size_t i UNUSED;
 
@@ -260,7 +381,7 @@ static void
             refKey = type.key == "uuid" and type.keyRefTable
             refValue = type.value == "uuid" and type.valueRefTable
             print
-            print "    datum = &row_->fields[%s_COL_%s];" % (structName.upper(), columnName.upper())
+            print "    datum = &row_->old[%s_COL_%s];" % (structName.upper(), columnName.upper())
             if type.value:
                 keyVar = "row->key_%s" % columnName
                 valueVar = "row->value_%s" % columnName
@@ -268,19 +389,27 @@ static void
                 keyVar = "row->%s" % columnName
                 valueVar = None
 
-            if type.min == 1 and type.max == 1:
+            if (type.min == 1 and type.max == 1) or typeIsOptionalPointer(type):
                 print "    if (datum->n >= 1) {"
                 if not refKey:
                     print "        %s = datum->keys[0].%s;" % (keyVar, type.key)
                 else:
-                    print "        %s = (struct %s%s *) 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.keyRefTable.lower(), prefix, prefix.upper(), type.keyRefTable.upper())
 
                 if valueVar:
                     if refValue:
                         print "        %s = datum->values[0].%s;" % (valueVar, type.value)
                     else:
-                        print "        %s = (struct %s%s *) 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())
+                        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 "    }"
+
             else:
                 if type.max != 'unlimited':
                     nMax = "MIN(%d, datum->n)" % type.max
@@ -289,13 +418,13 @@ static void
                 print "    for (i = 0; i < %s; i++) {" % nMax
                 refs = []
                 if refKey:
-                    print "        struct %s%s *keyRow = (struct %s%s *) 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())
+                    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())
                     keySrc = "keyRow"
                     refs.append('keyRow')
                 else:
                     keySrc = "datum->keys[i].%s" % type.key
                 if refValue:
-                    print "        struct %s%s *valueRow = (struct %s%s *) 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())
+                    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())
                     valueSrc = "valueRow"
                     refs.append('valueRow')
                 elif valueVar:
@@ -308,11 +437,11 @@ static void
                 print "%sif (!row->n_%s) {" % (indent, columnName)
                 print "%s    %s = xmalloc(%s * sizeof *%s);" % (indent, keyVar, nMax, keyVar)
                 if valueVar:
-                    print "%s    %s = xmalloc(%s * sizeof %%s);" % (indent, valueVar, nMax, valueVar)
+                    print "%s    %s = xmalloc(%s * sizeof %s);" % (indent, valueVar, nMax, valueVar)
                 print "%s}" % indent
                 print "%s%s[row->n_%s] = %s;" % (indent, keyVar, columnName, keySrc)
                 if valueVar:
-                    print "%s[row->n_%s] = %s;" % (indent, valueVar, columnName, valueSrc)
+                    print "%s%s[row->n_%s] = %s;" % (indent, valueVar, columnName, valueSrc)
                 print "%srow->n_%s++;" % (indent, columnName)
                 if refs:
                     print "        }"
@@ -323,13 +452,13 @@ static void
         nArrays = 0
         for columnName, column in table.columns.iteritems():
             type = column.type
-            if type.min != 1 or type.max != 1:
+            if (type.min != 1 or type.max != 1) and not typeIsOptionalPointer(type):
                 if not nArrays:
                     print '''
 static void
 %s_unparse(struct ovsdb_idl_row *row_)
 {
-    struct %s *row = (struct %s *) row_;
+    struct %s *row = %s_cast(row_);
 ''' % (structName, structName, structName)
                 if type.value:
                     keyVar = "row->key_%s" % columnName
@@ -350,15 +479,119 @@ static void
 
         # First, next functions.
         print '''
-const struct %(s)s *%(s)s_first(const struct ovsdb_idl *idl)
+const struct %(s)s *
+%(s)s_first(const struct ovsdb_idl *idl)
 {
-    return (const struct %(s)s *) ovsdb_idl_first_row(idl, &%(p)stable_classes[%(P)sTABLE_%(T)s]);
+    return %(s)s_cast(ovsdb_idl_first_row(idl, &%(p)stable_classes[%(P)sTABLE_%(T)s]));
 }
 
-const struct %(s)s *%(s)s_next(const struct %(s)s *row)
+const struct %(s)s *
+%(s)s_next(const struct %(s)s *row)
 {
-    return (const struct %(s)s *) ovsdb_idl_next_row(&row->header_);
-}''' % {'s': structName, 'p': prefix, 'P': prefix.upper(), 'T': tableName.upper()}
+    return %(s)s_cast(ovsdb_idl_next_row(&row->header_));
+}''' % {'s': structName,
+        'p': prefix,
+        'P': prefix.upper(),
+        'T': tableName.upper()}
+
+        print '''
+void
+%(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]));
+}
+''' % {'s': structName,
+       'p': prefix,
+       'P': prefix.upper(),
+       'T': tableName.upper()}
+
+        # Verify functions.
+        for columnName, column in table.columns.iteritems():
+            print '''
+void
+%(s)s_verify_%(c)s(const struct %(s)s *row)
+{
+    ovsdb_idl_txn_verify(&row->header_, &%(s)s_columns[%(S)s_COL_%(C)s]);
+}''' % {'s': structName,
+        'S': structName.upper(),
+        'c': columnName,
+        'C': columnName.upper()}
+
+        # Set functions.
+        for columnName, column in table.columns.iteritems():
+            type = column.type
+            print '\nvoid'
+            members = cMembers(prefix, columnName, column, True)
+            keyVar = members[0]['name']
+            nVar = None
+            valueVar = None
+            if type.value:
+                valueVar = members[1]['name']
+                if len(members) > 2:
+                    nVar = members[2]['name']
+            else:
+                if len(members) > 1:
+                    nVar = members[1]['name']
+            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:
+                print
+                print "    datum.n = 1;"
+                print "    datum.keys = xmalloc(sizeof *datum.keys);"
+                print cCopyType("    ", "row->%s" % keyVar, "datum.keys[0].%s" % type.key, keyVar, type.key, type.keyRefTable)
+                if type.value:
+                    print "    datum.values = xmalloc(sizeof *datum.values);"
+                    print cCopyType("    ", "row->%s" % valueVar, "datum.values[0].%s" % type.value, valueVar, type.value, type.valueRefTable)
+                else:
+                    print "    datum.values = NULL;"
+            elif typeIsOptionalPointer(type):
+                print
+                print "    if (%s) {" % keyVar
+                print "        datum.n = 1;"
+                print "        datum.keys = xmalloc(sizeof *datum.keys);"
+                print cCopyType("        ", "row->%s" % keyVar, "datum.keys[0].%s" % type.key, keyVar, type.key, type.keyRefTable)
+                print "    } else {"
+                print "        datum.n = 0;"
+                print "        datum.keys = NULL;"
+                print "        row->%s = NULL;" % keyVar
+                print "    }"
+                print "    datum.values = NULL;"
+            else:
+                print "    size_t i;"
+                print
+                print "    free(row->%s);" % keyVar
+                print "    row->%s = %s ? xmalloc(%s * sizeof *row->%s) : NULL;" % (keyVar, nVar, nVar, keyVar)
+                print "    row->%s = %s;" % (nVar, nVar)
+                if type.value:
+                    print "    free(row->%s);" % valueVar
+                    print "    row->%s = xmalloc(%s * sizeof *row->%s);" % (valueVar, nVar, valueVar)
+                print "    datum.n = %s;" % nVar
+                print "    datum.keys = xmalloc(%s * sizeof *datum.keys);" % 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 cCopyType("        ", "row->%s[i]" % keyVar, "datum.keys[i].%s" % type.key, "%s[i]" % keyVar, type.key, type.keyRefTable)
+                if type.value:
+                    print cCopyType("        ", "row->%s[i]" % valueVar, "datum.values[i].%s" % type.value, "%s[i]" % valueVar, type.value, type.valueRefTable)
+                print "    }"
+            print "    ovsdb_idl_txn_write(&row->header_, &%(s)s_columns[%(S)s_COL_%(C)s], &datum);" \
+                % {'s': structName,
+                   'S': structName.upper(),
+                   'C': columnName.upper()}
+            print "}"
 
         # Table columns.
         print "\nstatic struct ovsdb_idl_column %s_columns[%s_N_COLUMNS] = {" % (
@@ -421,6 +654,25 @@ def ovsdb_escape(string):
 def printOVSDBSchema(schema):
     json.dump(schema.toJson(), sys.stdout, sort_keys=True, indent=2)
 
+def printDoc(schema):
+    print schema.name
+    if schema.comment:
+        print schema.comment
+
+    for tableName, table in schema.tables.iteritems():
+        title = "%s table" % tableName
+        print
+        print title
+        print '-' * len(title)
+        if table.comment:
+            print table.comment
+
+        for columnName, column in table.columns.iteritems():
+            print
+            print "%s (%s)" % (columnName, column.type.toEnglish())
+            if column.comment:
+                print "\t%s" % column.comment
+
 def usage():
     print """\
 %(argv0)s: ovsdb schema compiler
@@ -432,6 +684,7 @@ One of the following actions must specified:
   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
+  doc                         print schema documentation
 
 The following options are also available:
   -h, --help                  display this help message
@@ -471,6 +724,8 @@ if __name__ == "__main__":
             printCIDLHeader(schema)
         elif action == 'c-idl-source':
             printCIDLSource(schema)
+        elif action == 'doc':
+            printDoc(schema)
         else:
             sys.stderr.write(
                 "%s: unknown action '%s' (use --help for help)\n" %