[ovs-dev] [PATCH 05/13] Cleanly separate IDL annotations from OVSDB schema information.
Ben Pfaff
blp at nicira.com
Mon Jan 25 18:18:51 UTC 2010
Until now, the OVSDB IDL annotations have been glommed together with the
schema information in a single file, and then we've used ovsdb-idlc to
extract the schema from that file. This commit reverses the process:
the schema and the annotations are stored separately and then glommed
together as necessary at build time.
This new arrangement has a few advantages:
- We can now easily have multiple different sets of IDL annotations
for a single OVSDB schema. For example, some users may not need
access to columns that other users do.
- Bugs in ovsdb-idlc cannot screw up the underlying schema (as shown
by a recent commit).
---
Makefile.am | 1 +
debian/openvswitch-common.install | 2 +-
debian/rules | 4 -
ovsdb/automake.mk | 23 ++++-
ovsdb/ovsdb-idlc.1 | 51 +++++-----
ovsdb/ovsdb-idlc.in | 100 ++++++++++---------
tests/.gitignore | 2 +-
tests/automake.mk | 21 +++--
tests/idltest.ann | 13 +++
tests/{idltest.ovsidl => idltest.ovsschema} | 19 +---
tests/ovsdb-idl.at | 13 +--
tests/ovsdb-macros.at | 2 +-
vswitchd/.gitignore | 2 +-
vswitchd/automake.mk | 23 ++---
vswitchd/vswitch-idl.ann | 20 ++++
vswitchd/{vswitch-idl.ovsidl => vswitch.ovsschema} | 32 ++----
16 files changed, 174 insertions(+), 154 deletions(-)
create mode 100644 tests/idltest.ann
rename tests/{idltest.ovsidl => idltest.ovsschema} (54%)
create mode 100644 vswitchd/vswitch-idl.ann
rename vswitchd/{vswitch-idl.ovsidl => vswitch.ovsschema} (92%)
diff --git a/Makefile.am b/Makefile.am
index bfba76f..bb8245e 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -48,6 +48,7 @@ noinst_HEADERS =
noinst_LIBRARIES =
noinst_PROGRAMS =
noinst_SCRIPTS =
+OVSIDL_BUILT =
SUFFIXES =
EXTRA_DIST += soexpand.pl
diff --git a/debian/openvswitch-common.install b/debian/openvswitch-common.install
index 314c762..c46d9be 100644
--- a/debian/openvswitch-common.install
+++ b/debian/openvswitch-common.install
@@ -4,4 +4,4 @@ _debian/utilities/ovs-appctl usr/sbin
_debian/utilities/ovs-ofctl usr/sbin
_debian/utilities/ovs-parse-leaks usr/bin
_debian/utilities/ovs-pki usr/sbin
-_debian/vswitchd/vswitch-idl.ovsschema usr/share/openvswitch
+vswitchd/vswitch-idl.ovsschema usr/share/openvswitch
diff --git a/debian/rules b/debian/rules
index 99d1f09..0d0abf1 100755
--- a/debian/rules
+++ b/debian/rules
@@ -85,10 +85,6 @@ install-arch: build-arch
$(MAKE) -C _debian DESTDIR=$(CURDIR)/debian/openvswitch install
cp debian/openvswitch-switch-config.overrides debian/openvswitch-switch-config/usr/share/lintian/overrides/openvswitch-switch-config
cp debian/openvswitch-switch.template debian/openvswitch-switch/usr/share/openvswitch/switch/default.template
- @# If we are working from a "make dist" tarball then make sure that
- @# the ovsschema file is available in the build directory.
- test -e _debian/vswitchd/vswitch-idl.ovsschema || \
- cp vswitchd/vswitch-idl.ovsschema _debian/vswitchd/vswitch-idl.ovsschema
dh_install -s
env TERMINFO=debian/openvswitch-switchui/usr/share/terminfo tic -x extras/ezio/ezio3.ti
diff --git a/ovsdb/automake.mk b/ovsdb/automake.mk
index 1596a4b..8605410 100644
--- a/ovsdb/automake.mk
+++ b/ovsdb/automake.mk
@@ -88,15 +88,26 @@ EXTRA_DIST += \
ovsdb/ovsdb-idlc.1
DISTCLEANFILES += ovsdb/ovsdb-idlc
SUFFIXES += .ovsidl .txt
+OVSDB_IDLC = $(PYTHON) $(srcdir)/ovsdb/ovsdb-idlc.in
.ovsidl.c:
- $(PYTHON) $(srcdir)/ovsdb/ovsdb-idlc.in c-idl-source $< > $@.tmp
+ $(OVSDB_IDLC) c-idl-source $< > $@.tmp
mv $@.tmp $@
.ovsidl.h:
- $(PYTHON) $(srcdir)/ovsdb/ovsdb-idlc.in c-idl-header $< > $@.tmp
- mv $@.tmp $@
-.ovsidl.ovsschema:
- $(PYTHON) $(srcdir)/ovsdb/ovsdb-idlc.in ovsdb-schema $< > $@.tmp
+ $(OVSDB_IDLC) c-idl-header $< > $@.tmp
mv $@.tmp $@
.ovsidl.txt:
- $(PYTHON) $(srcdir)/ovsdb/ovsdb-idlc.in doc $< | fmt -s > $@.tmp
+ $(OVSDB_IDLC) doc $< | fmt -s > $@.tmp
mv $@.tmp $@
+
+EXTRA_DIST += $(OVSIDL_BUILT)
+BUILT_SOURCES += $(OVSIDL_BUILT)
+
+# This must be done late: macros in targets are expanded when the
+# target line is read, so if this file were to be included before some
+# other file that added to OVSIDL_BUILT, then those files wouldn't get
+# the dependency.
+#
+# However, current versions of Automake seem to output all variable
+# assignments before any targets, so it doesn't seem to be a problem,
+# at least for now.
+$(OVSIDL_BUILT): ovsdb/ovsdb-idlc.in
diff --git a/ovsdb/ovsdb-idlc.1 b/ovsdb/ovsdb-idlc.1
index 1311759..1a7e804 100644
--- a/ovsdb/ovsdb-idlc.1
+++ b/ovsdb/ovsdb-idlc.1
@@ -6,13 +6,11 @@
ovsdb\-idlc \- Open vSwitch IDL (Interface Definition Language) compiler
.
.SH SYNOPSIS
-\fBovsdb\-idlc \fBvalidate\fI schema\fR
+\fBovsdb\-idlc \fBannotate\fI schema annotations\fR
.br
-\fBovsdb\-idlc \fBovsdb\-schema\fI schema\fR
+\fBovsdb\-idlc \fBc\-idl\-header\fI idl\fR
.br
-\fBovsdb\-idlc \fBc\-idl\-header\fI schema\fR
-.br
-\fBovsdb\-idlc \fBc\-idl\-source\fI schema\fR
+\fBovsdb\-idlc \fBc\-idl\-source\fI idl\fR
.br
\fBovsdb\-idlc --help\fR
.br
@@ -26,13 +24,9 @@ installation or configuration time. Thus, it is not normally
installed as part of Open vSwitch.
.
.PP
-The \fIschema\fR files used as \fBovsdb\-idlc\fR input have the same
-format as the OVSDB schemas, specified in the OVSDB specification,
-with a few additions:
-.
-.IP "\fB//\fR comments"
-Lines that begin with \fB//\fR (two forward slashes) are ignored and
-thus can be used for comments.
+The \fIidl\fR files used as input for most \fBovsdb\-idlc\fR commands
+have the same format as the OVSDB schemas, specified in the OVSDB
+specification, with a few additions:
.
.IP "\fB""\fBidlPrefix\fR"" member of <database-schema>"
This member, which is required, specifies a string that is prefixed to
@@ -57,29 +51,34 @@ the given type.
Analogous to \fB"keyRefTable"\fR in meaning and effect, except that it
applies to the \fB"value"\fR member of the <type>.
.SS "Commands"
-.
-.IP "\fBvalidate\fI schema\fR"
-Reads \fIschema\fR and checks its format, without producing any output.
-.
-.IP "\fBovsdb\-schema\fI schema\fR"
-Reads \fIschema\fR and prints it on standard output with the parts
-that are not part of the OVSDB schema specification stripped out.
-.
-.IP "\fBc\-idl\-header\fI schema\fR"
-Reads \fIschema\fR and prints on standard output a C header file that
+.IP "\fBannotate\fI schema annotations\fR"
+Reads \fIschema\fR, which should be a file in JSON format (ordinarily
+an OVSDB schema file), then reads and executes the Python syntax
+fragment in \fIannotations\fR. The Python syntax fragment is passed
+the JSON object as a local variable named \fBs\fR. It may modify this
+data in any way. After the Python code returns, the object as
+modified is re-serialized as JSON on standard output.
+.
+.IP "\fBc\-idl\-header\fI idl\fR"
+Reads \fIidl\fR and prints on standard output a C header file that
defines a structure for each table defined by the schema.
.
-.IP "\fBc\-idl\-source\fI schema\fR"
-Reads \fIschema\fR and prints on standard output a C source file that
+.IP "\fBc\-idl\-source\fI idl\fR"
+Reads \fIidl\fR and prints on standard output a C source file that
implements C bindings for the database defined by the schema.
.
+.IP "\fBdoc\fI idl\fR"
+Reads \fIidl\fR and prints on standard output a text file that
+documents the schema. The output may have very long lines, so it
+makes sense to pipe it through, e.g. \fBfmt \-s\fR.
+.
.SS "Options"
.so lib/common.man
.
.SH "BUGS"
\fBovsdb\-idlc\fR is more lenient about the format of OVSDB schemas
-than other OVSDB tools, so the \fBovsdb\-schema\fR command may output
-schemas that other programs refuse to read.
+than other OVSDB tools. It may successfully parse schemas that, e.g.,
+\fBovsdb\-tool\fR rejects.
.
.SH "SEE ALSO"
The OVSDB specification.
diff --git a/ovsdb/ovsdb-idlc.in b/ovsdb/ovsdb-idlc.in
index c77eae3..10be351 100755
--- a/ovsdb/ovsdb-idlc.in
+++ b/ovsdb/ovsdb-idlc.in
@@ -1,6 +1,7 @@
#! @PYTHON@
import getopt
+import os
import re
import sys
@@ -184,12 +185,12 @@ def atomicTypeToEnglish(base, refTable):
return base
def parseSchema(filename):
- file = open(filename, "r")
- s = ""
- for line in file:
- if not line.startswith('//'):
- s += line
- return DbSchema.fromJson(json.loads(s))
+ return DbSchema.fromJson(json.load(open(filename, "r")))
+
+def annotateSchema(schemaFile, annotationFile):
+ schemaJson = json.load(open(schemaFile, "r"))
+ execfile(annotationFile, globals(), {"s": schemaJson})
+ json.dump(schemaJson, sys.stdout)
def cBaseType(prefix, type, refTable=None):
if type == 'uuid' and refTable:
@@ -265,7 +266,8 @@ def cMembers(prefix, columnName, column, const):
'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 -*- */
@@ -323,7 +325,8 @@ 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 -*- */
@@ -651,10 +654,8 @@ def ovsdb_escape(string):
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 printDoc(schema):
+def printDoc(schemaFile):
+ schema = parseSchema(schemaFile)
print schema.name
if schema.comment:
print schema.comment
@@ -678,15 +679,13 @@ def printDoc(schema):
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
- doc print schema documentation
+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
+ doc IDL print schema documentation
The following options are also available:
-h, --help display this help message
@@ -697,42 +696,49 @@ The following options are also available:
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)
- elif action == 'doc':
- printDoc(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),
+ "doc": (printDoc, 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)
+
+ 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 Error, e:
sys.stderr.write("%s: %s\n" % (argv0, e.msg))
sys.exit(1)
diff --git a/tests/.gitignore b/tests/.gitignore
index 3d9b76e..c987014 100644
--- a/tests/.gitignore
+++ b/tests/.gitignore
@@ -4,7 +4,7 @@
/atlocal
/idltest.c
/idltest.h
-/idltest.ovsschema
+/idltest.ovsidl
/test-aes128
/test-classifier
/test-csum
diff --git a/tests/automake.mk b/tests/automake.mk
index e498eee..bae313d 100644
--- a/tests/automake.mk
+++ b/tests/automake.mk
@@ -111,15 +111,22 @@ tests_test_lockfile_SOURCES = tests/test-lockfile.c
tests_test_lockfile_LDADD = lib/libopenvswitch.a
noinst_PROGRAMS += tests/test-ovsdb
-tests_test_ovsdb_SOURCES = tests/test-ovsdb.c tests/idltest.c tests/idltest.h
+tests_test_ovsdb_SOURCES = \
+ tests/test-ovsdb.c \
+ tests/idltest.c \
+ tests/idltest.h
+EXTRA_DIST += tests/uuidfilt.pl
tests_test_ovsdb_LDADD = ovsdb/libovsdb.a lib/libopenvswitch.a $(SSL_LIBS)
-EXTRA_DIST += tests/uuidfilt.pl tests/idltest.ovsidl
-BUILT_SOURCES += tests/idltest.c tests/idltest.h
-noinst_DATA += tests/idltest.ovsschema
-DISTCLEANFILES += tests/idltest.ovsschema
-tests/idltest.c tests/idltest.h tests/idltest.ovsschema: ovsdb/ovsdb-idlc.in
+
+# idltest schema and IDL
+OVSIDL_BUILT += tests/idltest.c tests/idltest.h tests/idltest.ovsidl
+IDLTEST_IDL_FILES = tests/idltest.ovsschema tests/idltest.ann
+EXTRA_DIST += $(IDLTEST_IDL_FILES)
+tests/idltest.ovsidl: $(IDLTEST_IDL_FILES)
+ $(OVSDB_IDLC) -C $(srcdir) annotate $(IDLTEST_IDL_FILES) > $@.tmp
+ mv $@.tmp $@
+
tests/idltest.c: tests/idltest.h
-EXTRA_DIST += tests/idltest.c tests/idltest.h tests/idltest.ovsschema
noinst_PROGRAMS += tests/test-reconnect
tests_test_reconnect_SOURCES = tests/test-reconnect.c
diff --git a/tests/idltest.ann b/tests/idltest.ann
new file mode 100644
index 0000000..2ffd1af
--- /dev/null
+++ b/tests/idltest.ann
@@ -0,0 +1,13 @@
+# -*- python -*-
+
+# This code, when invoked by "ovsdb-idlc annotate" (by the build
+# process), annotates idltest.ovsschema with additional data that give
+# the ovsdb-idl engine information about the types involved, so that
+# it can generate more programmer-friendly data structures.
+
+s["idlPrefix"] = "idltest_"
+s["idlHeader"] = "\"tests/idltest.h\""
+s["tables"]["link1"]["columns"]["k"]["type"]["keyRefTable"] = "link1"
+s["tables"]["link1"]["columns"]["ka"]["type"]["keyRefTable"] = "link1"
+s["tables"]["link1"]["columns"]["l2"]["type"]["keyRefTable"] = "link2"
+s["tables"]["link2"]["columns"]["l1"]["type"]["keyRefTable"] = "link1"
diff --git a/tests/idltest.ovsidl b/tests/idltest.ovsschema
similarity index 54%
rename from tests/idltest.ovsidl
rename to tests/idltest.ovsschema
index 75d50ef..239a343 100644
--- a/tests/idltest.ovsidl
+++ b/tests/idltest.ovsschema
@@ -1,13 +1,4 @@
-//
-// This is an ovsdb-idl schema. The OVSDB IDL compiler, ovsdb-idlc,
-// can translate it into an OVSDB schema (which simply entails
-// deleting some members from the schema) or C headers or source for
-// use with the IDL at runtime.
-//
-
{"name": "idltest",
- "idlPrefix": "idltest_",
- "idlHeader": "\"tests/idltest.h\"",
"tables": {
"simple": {
"columns": {
@@ -24,13 +15,11 @@
"link1": {
"columns": {
"i": {"type": "integer"},
- "k": {"type": {"key": "uuid", "keyRefTable": "link1"}},
- "ka": {"type": {"key": "uuid", "keyRefTable": "link1",
+ "k": {"type": {"key": "uuid"}},
+ "ka": {"type": {"key": "uuid",
"min": 0, "max": "unlimited"}},
- "l2": {"type": {"key": "uuid", "keyRefTable": "link2",
- "min": 0, "max": 1}}}},
+ "l2": {"type": {"key": "uuid", "min": 0, "max": 1}}}},
"link2": {
"columns": {
"i": {"type": "integer"},
- "l1": {"type": {"key": "uuid", "keyRefTable": "link1",
- "min": 0, "max": 1}}}}}}
+ "l1": {"type": {"key": "uuid", "min": 0, "max": 1}}}}}}
diff --git a/tests/ovsdb-idl.at b/tests/ovsdb-idl.at
index 0ce6535..d16982b 100644
--- a/tests/ovsdb-idl.at
+++ b/tests/ovsdb-idl.at
@@ -17,17 +17,8 @@ AT_BANNER([OVSDB -- interface description language (IDL)])
m4_define([OVSDB_CHECK_IDL],
[AT_SETUP([$1])
AT_KEYWORDS([ovsdb server idl positive $5])
- OVS_CHECK_LCOV(
- [SCHEMA=$abs_builddir/idltest.ovsschema
- if test ! -e $SCHEMA; then
- SCHEMA=$abs_srcdir/idltest.ovsschema
- if test ! -e $SCHEMA; then
- echo 'Failed to find idltest.ovsschema'
- exit 1
- fi
- fi
- ovsdb-tool create db $SCHEMA],
- [0], [stdout], [ignore])
+ OVS_CHECK_LCOV([ovsdb-tool create db $abs_srcdir/idltest.ovsschema],
+ [0], [stdout], [ignore])
AT_CHECK([ovsdb-server '-vPATTERN:console:ovsdb-server|%c|%m' --detach --pidfile=$PWD/server-pid --remote=punix:socket --unixctl=$PWD/unixctl db], [0], [ignore], [ignore])
m4_if([$2], [], [],
[OVS_CHECK_LCOV([ovsdb-client transact unix:socket $2], [0], [ignore], [ignore], [kill `cat server-pid`])])
diff --git a/tests/ovsdb-macros.at b/tests/ovsdb-macros.at
index 96c273e..c0033b3 100644
--- a/tests/ovsdb-macros.at
+++ b/tests/ovsdb-macros.at
@@ -11,7 +11,7 @@ m4_define([OVSDB_INIT],
exit 1
fi
fi
- ovsdb-tool create $1 $SCHEMA],
+ ovsdb-tool create $1 $abs_top_srcdir/vswitchd/vswitch.ovsschema],
[0], [stdout], [ignore])
OVS_CHECK_LCOV(
[[ovsdb-tool transact $1 \
diff --git a/vswitchd/.gitignore b/vswitchd/.gitignore
index 1943444..872a726 100644
--- a/vswitchd/.gitignore
+++ b/vswitchd/.gitignore
@@ -7,5 +7,5 @@
/ovs-vswitchd.conf.5
/vswitch-idl.c
/vswitch-idl.h
-/vswitch-idl.ovsschema
+/vswitch-idl.ovsidl
/vswitch-idl.txt
diff --git a/vswitchd/automake.mk b/vswitchd/automake.mk
index f39a032..9121169 100644
--- a/vswitchd/automake.mk
+++ b/vswitchd/automake.mk
@@ -32,18 +32,15 @@ EXTRA_DIST += \
vswitchd/ovs-vswitchd.8.in \
vswitchd/ovs-brcompatd.8.in
-EXTRA_DIST += vswitchd/vswitch-idl.ovsidl
-BUILT_SOURCES += vswitchd/vswitch-idl.c vswitchd/vswitch-idl.h
-DISTCLEANFILES += vswitchd/vswitch-idl.c vswitchd/vswitch-idl.h
-noinst_DATA += vswitchd/vswitch-idl.ovsschema vswitchd/vswitch-idl.txt
-DISTCLEANFILES += vswitchd/vswitch-idl.ovsschema vswitchd/vswitch-idl.txt
-vswitchd/vswitch-idl.c vswitchd/vswitch-idl.h \
-vswitchd/vswitch-idl.ovsschema vswitchd/vswitch-idl.txt: \
- ovsdb/ovsdb-idlc.in
-vswitchd/vswitch-idl.c: vswitchd/vswitch-idl.h
-EXTRA_DIST += \
+
+# vswitch schema and IDL
+OVSIDL_BUILT += \
vswitchd/vswitch-idl.c \
vswitchd/vswitch-idl.h \
- vswitchd/vswitch-idl.ovsschema \
- vswitchd/vswitch-idl.txt
-
+ vswitchd/vswitch-idl.ovsidl
+VSWITCH_IDL_FILES = vswitchd/vswitch.ovsschema vswitchd/vswitch-idl.ann
+noinst_DATA += vswitchd/vswitch-idl.txt
+EXTRA_DIST += $(VSWITCH_IDL_FILES) vswitchd/vswitch-idl.txt
+vswitchd/vswitch-idl.ovsidl: $(VSWITCH_IDL_FILES)
+ $(OVSDB_IDLC) -C $(srcdir) annotate $(VSWITCH_IDL_FILES) > $@.tmp
+ mv $@.tmp $@
diff --git a/vswitchd/vswitch-idl.ann b/vswitchd/vswitch-idl.ann
new file mode 100644
index 0000000..ff5766a
--- /dev/null
+++ b/vswitchd/vswitch-idl.ann
@@ -0,0 +1,20 @@
+# -*- python -*-
+
+# This code, when invoked by "ovsdb-idlc annotate" (by the build
+# process), annotates vswitch.ovsschema with additional data that give
+# the ovsdb-idl engine information about the types involved, so that
+# it can generate more programmer-friendly data structures.
+
+s["idlPrefix"] = "ovsrec_"
+s["idlHeader"] = "\"vswitchd/vswitch-idl.h\""
+s["tables"]["Open_vSwitch"]["columns"]["bridges"]["type"]["keyRefTable"] = "Bridge"
+s["tables"]["Open_vSwitch"]["columns"]["controller"]["type"]["keyRefTable"] = "Controller"
+s["tables"]["Open_vSwitch"]["columns"]["ssl"]["type"]["keyRefTable"] = "SSL"
+s["tables"]["Bridge"]["columns"]["ports"]["type"]["keyRefTable"] = "Port"
+s["tables"]["Bridge"]["columns"]["mirrors"]["type"]["keyRefTable"] = "Mirror"
+s["tables"]["Bridge"]["columns"]["netflow"]["type"]["keyRefTable"] = "NetFlow"
+s["tables"]["Bridge"]["columns"]["controller"]["type"]["keyRefTable"] = "Controller"
+s["tables"]["Port"]["columns"]["interfaces"]["type"]["keyRefTable"] = "Interface"
+s["tables"]["Mirror"]["columns"]["select_src_port"]["type"]["keyRefTable"] = "Port"
+s["tables"]["Mirror"]["columns"]["select_dst_port"]["type"]["keyRefTable"] = "Port"
+s["tables"]["Mirror"]["columns"]["output_port"]["type"]["keyRefTable"] = "Port"
diff --git a/vswitchd/vswitch-idl.ovsidl b/vswitchd/vswitch.ovsschema
similarity index 92%
rename from vswitchd/vswitch-idl.ovsidl
rename to vswitchd/vswitch.ovsschema
index 8726ba3..2c7fdf1 100644
--- a/vswitchd/vswitch-idl.ovsidl
+++ b/vswitchd/vswitch.ovsschema
@@ -1,34 +1,24 @@
-//
-// This is an ovsdb-idl schema. The OVSDB IDL compiler, ovsdb-idlc,
-// can translate it into an OVSDB schema (which simply entails
-// deleting some members from the schema) or C headers or source for
-// use with the IDL at runtime.
-//
-
{"name": "ovs_vswitchd_db",
"comment": "Configuration for one Open vSwitch daemon.",
- "idlPrefix": "ovsrec_",
- "idlHeader": "\"vswitchd/vswitch-idl.h\"",
"tables": {
"Open_vSwitch": {
"comment": "Configuration for an Open vSwitch daemon.",
"columns": {
"bridges": {
"comment": "Set of bridges managed by the daemon.",
- "type": {"key": "uuid", "keyRefTable": "Bridge",
- "min": 0, "max": "unlimited"}},
+ "type": {"key": "uuid", "min": 0, "max": "unlimited"}},
"management_id": {
"comment": "Exactly 12 hex digits that identify the daemon.",
"type": "string"},
"controller": {
"comment": "Default Controller used by bridges.",
- "type": {"key": "uuid", "keyRefTable": "Controller", "min": 0, "max": 1}},
+ "type": {"key": "uuid", "min": 0, "max": 1}},
"managers": {
"comment": "Remote database clients to which the Open vSwitch's database server should connect or to which it should listen.",
"type": {"key": "string", "min": 0, "max": "unlimited"}},
"ssl": {
"comment": "SSL used globally by the daemon.",
- "type": {"key": "uuid", "keyRefTable": "SSL", "min": 0, "max": 1}},
+ "type": {"key": "uuid", "min": 0, "max": 1}},
"next_cfg": {
"comment": "Sequence number for client to increment when it modifies the configuration and wishes to wait for Open vSwitch to finish applying the changes.",
"type": "integer"},
@@ -47,16 +37,16 @@
"ephemeral": true},
"ports": {
"comment": "Ports included in the bridge.",
- "type": {"key": "uuid", "keyRefTable": "Port", "min": 0, "max": "unlimited"}},
+ "type": {"key": "uuid", "min": 0, "max": "unlimited"}},
"mirrors": {
"comment": "Port mirroring configuration.",
- "type": {"key": "uuid", "keyRefTable": "Mirror", "min": 0, "max": "unlimited"}},
+ "type": {"key": "uuid", "min": 0, "max": "unlimited"}},
"netflow": {
"comment": "NetFlow configuration.",
- "type": {"key": "uuid", "keyRefTable": "NetFlow", "min": 0, "max": 1}},
+ "type": {"key": "uuid", "min": 0, "max": 1}},
"controller": {
"comment": "OpenFlow controller. If unset, defaults to that specified by the parent Open_vSwitch.",
- "type": {"key": "uuid", "keyRefTable": "Controller", "min": 0, "max": 1}},
+ "type": {"key": "uuid", "min": 0, "max": 1}},
"other_config": {
"comment": "Key-value pairs for configuring rarely used bridge features. The currently defined key-value pairs are: \"datapath-id\", exactly 12 hex digits to set the OpenFlow datapath ID to a specific value; \"hwaddr\", exactly 12 hex digits in the form \"XX:XX:XX:XX:XX:XX\" to set the hardware address of the local port and influence the datapath ID.",
"type": {"key": "string", "value": "string", "min": 0, "max": "unlimited"}},
@@ -75,7 +65,7 @@
"type": "string"},
"interfaces": {
"comment": "The Port's Interfaces. If there is more than one, this is a bonded Port.",
- "type": {"key": "uuid", "keyRefTable": "Interface", "min": 1, "max": "unlimited"}},
+ "type": {"key": "uuid", "min": 1, "max": "unlimited"}},
"trunks": {
"comment": "The 802.1Q VLAN(s) that this port trunks. Should be empty if this port trunks all VLAN(s) or if this is not a trunk port.",
"type": {"key": "integer", "min": 0, "max": 4096}},
@@ -139,16 +129,16 @@
"type": "string"},
"select_src_port": {
"comment": "Ports on which arriving packets are selected for mirroring.",
- "type": {"key": "uuid", "keyRefTable": "Port", "min": 0, "max": "unlimited"}},
+ "type": {"key": "uuid", "min": 0, "max": "unlimited"}},
"select_dst_port": {
"comment": "Ports on which departing packets are selected for mirroring.",
- "type": {"key": "uuid", "keyRefTable": "Port", "min": 0, "max": "unlimited"}},
+ "type": {"key": "uuid", "min": 0, "max": "unlimited"}},
"select_vlan": {
"comment": "VLANs on which packets are selected for mirroring.",
"type": {"key": "integer", "min": 0, "max": 4096}},
"output_port": {
"comment": "Output port for selected packets. Mutually exclusive with output_vlan.",
- "type": {"key": "uuid", "keyRefTable": "Port", "min": 0, "max": 1}},
+ "type": {"key": "uuid", "min": 0, "max": 1}},
"output_vlan": {
"comment": "Output VLAN for selected packets. Mutually exclusive with output_port.",
"type": {"key": "integer", "min": 0, "max": 1}}}},
--
1.6.3.3
More information about the dev
mailing list