ovs-xapi-sync: Style cleanup.
[sliver-openvswitch.git] / xenserver / usr_share_openvswitch_scripts_ovs-xapi-sync
index 57dc2e3..7109609 100755 (executable)
@@ -23,7 +23,8 @@
 #   - Set the fail-mode on internal bridges.
 
 import getopt
-import logging, logging.handlers
+import logging
+import logging.handlers
 import os
 import signal
 import subprocess
@@ -32,6 +33,7 @@ import time
 
 import XenAPI
 
+import ovs.dirs
 from ovs.db import error
 from ovs.db import types
 import ovs.util
@@ -39,10 +41,11 @@ import ovs.daemon
 import ovs.db.idl
 
 s_log = logging.getLogger("ovs-xapi-sync")
-vsctl="/usr/bin/ovs-vsctl"
+vsctl = "/usr/bin/ovs-vsctl"
 session = None
 force_run = False
 
+
 # Set up a session to interact with XAPI.
 #
 # On system start-up, OVS comes up before XAPI, so we can't log into the
@@ -63,6 +66,7 @@ def init_session():
 
     return True
 
+
 def get_network_by_bridge(br_name):
     if not init_session():
         s_log.warning("Failed to get bridge id %s because"
@@ -76,6 +80,7 @@ def get_network_by_bridge(br_name):
 
     return None
 
+
 # By default, the "bridge-id" external id in the Bridge table is the
 # same as "xs-network-uuids".  This may be overridden by defining a
 # "nicira-bridge-id" key in the "other_config" field of the network
@@ -87,6 +92,7 @@ def get_bridge_id(br_name, default=None):
         return rec['other_config'].get('nicira-bridge-id', default)
     return None
 
+
 # By default, the "iface-id" external id in the Interface table is the
 # same as "xs-vif-uuid".  This may be overridden by defining a
 # "nicira-iface-id" key in the "other_config" field of the VIF
@@ -110,25 +116,36 @@ def get_iface_id(if_name, xs_vif_uuid):
         s_log.warning("Could not find XAPI entry for VIF %s" % if_name)
         return xs_vif_uuid
 
+
 def call_vsctl(args):
     cmd = [vsctl, "--timeout=30", "-vANY:console:off"] + args
     exitcode = subprocess.call(cmd)
     if exitcode != 0:
         s_log.warning("Couldn't call ovs-vsctl")
 
-def set_external_id(table, record, key, value):
-    if value:
-        col = 'external-ids:"%s"="%s"' % (key, value)
-        call_vsctl(["set", table, record, col])
+
+def set_or_delete(d, key, value):
+    if value is None:
+        if key in d:
+            del d[key]
+            return True
     else:
-        call_vsctl(["remove", table, record, "external-ids", key])
+        if d.get(key) != value:
+            d[key] = value
+            return True
+    return False
+
+
+def set_external_id(row, key, value):
+    external_ids = row.external_ids
+    if set_or_delete(external_ids, key, value):
+        row.external_ids = external_ids
 
 
 # XenServer does not call interface-reconfigure on internal networks,
 # which is where the fail-mode would normally be set.
-def update_fail_mode(name):
-    rec = get_network_by_bridge(name)
-
+def update_fail_mode(row):
+    rec = get_network_by_bridge(row.name)
     if not rec:
         return
 
@@ -138,87 +155,65 @@ def update_fail_mode(name):
         pools = session.xenapi.pool.get_all()
         if len(pools) == 1:
             prec = session.xenapi.pool.get_record(pools[0])
-            fail_mode = prec['other_config'].get('vswitch-controller-fail-mode')
+            fail_mode = prec['other_config'].get(
+                    'vswitch-controller-fail-mode')
 
     if fail_mode not in ['standalone', 'secure']:
         fail_mode = 'standalone'
 
-    call_vsctl(["set", "bridge", name, "fail_mode=" + fail_mode])
+    if row.fail_mode != fail_mode:
+        row.fail_mode = fail_mode
 
-def update_in_band_mgmt(name):
-    rec = get_network_by_bridge(name)
 
+def update_in_band_mgmt(row):
+    rec = get_network_by_bridge(row.name)
     if not rec:
         return
 
     dib = rec['other_config'].get('vswitch-disable-in-band')
-    if not dib:
-        call_vsctl(['remove', 'bridge', name, 'other_config',
-                    'disable-in-band'])
-    elif dib in ['true', 'false']:
-        call_vsctl(['set', 'bridge', name,
-                    'other_config:disable-in-band=' + dib])
-    else:
-        s_log.warning('"' + dib + '"'
-                      "isn't a valid setting for other_config:disable-in-band on " +
-                      name)
 
-def update_bridge_id(name, ids):
-    id = get_bridge_id(name, ids.get("xs-network-uuids"))
+    other_config = row.other_config
+    if dib and dib not in ['true', 'false']:
+        s_log.warning('"%s" isn\'t a valid setting for '
+                      "other_config:disable-in-band on %s" % (dib, row.name))
+    elif set_or_delete(other_config, 'disable-in-band', dib):
+        row.other_config = other_config
 
-    if not id:
-        return
 
-    primary_id = id.split(";")[0]
-
-    if ids.get("bridge-id") != primary_id:
-        set_external_id("Bridge", name, "bridge-id", primary_id)
-        ids["bridge-id"] = primary_id
+def update_bridge_id(row):
+    id_ = get_bridge_id(row.name, row.external_ids.get("xs-network-uuids"))
+    if not id_:
+        return
 
-def update_iface(name, ids):
-    id = get_iface_id(name, ids.get("xs-vif-uuid"))
-    if ids.get("iface-id") != id and id:
-        set_external_id("Interface", name, "iface-id", id)
-        ids["iface-id"] = id
+    set_external_id(row, "bridge-id", id_.split(";")[0])
 
-    status = ids.get("iface-status")
-    if status:
-        set_external_id("Interface", name, "iface-status", status)
 
-def keep_table_columns(schema, table_name, column_types):
+def keep_table_columns(schema, table_name, columns):
     table = schema.tables.get(table_name)
     if not table:
         raise error.Error("schema has no %s table" % table_name)
 
     new_columns = {}
-    for column_name, column_type in column_types.iteritems():
+    for column_name in columns:
         column = table.columns.get(column_name)
         if not column:
             raise error.Error("%s table schema lacks %s column"
                               % (table_name, column_name))
-        if column.type != column_type:
-            raise error.Error("%s column in %s table has type \"%s\", "
-                              "expected type \"%s\""
-                              % (column_name, table_name,
-                                 column.type.toEnglish(),
-                                 column_type.toEnglish()))
         new_columns[column_name] = column
     table.columns = new_columns
     return table
 
-def monitor_uuid_schema_cb(schema):
-    string_type = types.Type(types.BaseType(types.StringType))
-    string_map_type = types.Type(types.BaseType(types.StringType),
-                                 types.BaseType(types.StringType),
-                                 0, sys.maxint)
 
+def prune_schema(schema):
     new_tables = {}
-    for table_name in ("Bridge", "Interface"):
-        new_tables[table_name] = keep_table_columns(
-            schema, table_name, {"name": string_type,
-                                 "external_ids": string_map_type})
+    new_tables["Bridge"] = keep_table_columns(
+        schema, "Bridge", ("name", "external_ids", "other_config",
+                           "fail_mode"))
+    new_tables["Interface"] = keep_table_columns(
+        schema, "Interface", ("name", "external_ids"))
     schema.tables = new_tables
 
+
 def usage():
     print "usage: %s [OPTIONS] DATABASE" % sys.argv[0]
     print "where DATABASE is a socket on which ovsdb-server is listening."
@@ -227,31 +222,12 @@ def usage():
     print "  -h, --help               display this help message"
     sys.exit(0)
 
-def handler(signum, frame):
+
+def handler(signum, _):
     global force_run
     if (signum == signal.SIGHUP):
         force_run = True
 
-def update_tap_from_vif(idl, tap_name, vif_name):
-    ifaces = idl.data["Interface"]
-    tap = None
-    vif = None
-
-    for i in ifaces.values():
-        name = i.name.as_scalar().strip('"')
-        if name == tap_name:
-            tap = i
-        elif name == vif_name:
-            vif = i
-
-    if vif and tap:
-        vxid = vif.external_ids
-        txid = tap.external_ids
-
-        keys = ["attached-mac", "xs-network-uuid", "xs-vif-uuid", "xs-vm-uuid"]
-        for k in keys:
-            if vxid.get(k) != txid.get(k):
-                set_external_id("Interface", tap_name, k, vxid.get(k))
 
 def main(argv):
     global force_run
@@ -284,7 +260,10 @@ def main(argv):
         sys.exit(1)
 
     remote = args[0]
-    idl = ovs.db.idl.Idl(remote, "Open_vSwitch", monitor_uuid_schema_cb)
+    schema_file = "%s/vswitch.ovsschema" % ovs.dirs.PKGDATADIR
+    schema = ovs.db.schema.DbSchema.from_json(ovs.json.from_file(schema_file))
+    prune_schema(schema)
+    idl = ovs.db.idl.Idl(remote, schema)
 
     ovs.daemon.daemonize()
 
@@ -295,8 +274,8 @@ def main(argv):
 
     signal.signal(signal.SIGHUP, handler)
 
-    bridges = {}
-    interfaces = {}
+    bridges = {}                # Map from bridge name to xs_network_uuids
+    interfaces = {}             # Map from interface name to xs-vif-uuid
     while True:
         if not force_run and not idl.run():
             poller = ovs.poller.Poller()
@@ -306,62 +285,82 @@ def main(argv):
 
         if force_run:
             s_log.info("Forced to re-run as the result of a SIGHUP")
-            bridges    = {}
+            bridges = {}
             interfaces = {}
-            force_run  = False
+            force_run = False
+
+        txn = ovs.db.idl.Transaction(idl)
 
         new_bridges = {}
-        for rec in idl.data["Bridge"].itervalues():
-            name = rec.name.as_scalar()
-            xs_network_uuids = rec.external_ids.get("xs-network-uuids")
-            bridge_id = rec.external_ids.get("bridge-id")
-            new_bridges[name] = {"xs-network-uuids": xs_network_uuids,
-                                 "bridge-id": bridge_id}
+        for row in idl.tables["Bridge"].rows.itervalues():
+            old_xnu = bridges.get(row.name)
+            new_xnu = row.external_ids.get("xs-network-uuids", "")
+            if old_xnu is None:
+                # New bridge.
+                update_fail_mode(row)
+                update_in_band_mgmt(row)
+            if new_xnu != old_xnu:
+                # New bridge or bridge's xs-network-uuids has changed.
+                update_bridge_id(row)
+            new_bridges[row.name] = new_xnu
+        bridges = new_bridges
+
+        iface_by_name = {}
+        for row in idl.tables["Interface"].rows.itervalues():
+            iface_by_name[row.name] = row
 
         new_interfaces = {}
-        for rec in idl.data["Interface"].itervalues():
-            name = rec.name.as_scalar()
-            xs_vif_uuid = rec.external_ids.get("xs-vif-uuid")
-            iface_id = rec.external_ids.get("iface-id")
-            new_interfaces[name] = {"xs-vif-uuid": xs_vif_uuid,
-                                    "iface-id": iface_id}
-
-            if name.startswith("vif"):
-                new_interfaces[name]["iface-status"] = "active"
-
-        #Tap devices take their xs-vif-uuid from their corresponding vif and
-        #cause that vif to be labled inactive.
-        for name in new_interfaces:
-            if not name.startswith("tap"):
-                continue
-
-            vif = name.replace("tap", "vif", 1)
-
-            if vif in new_interfaces:
-                xs_vif_uuid = new_interfaces[vif]["xs-vif-uuid"]
-                new_interfaces[name]["xs-vif-uuid"] = xs_vif_uuid
-
-                new_interfaces[vif]["iface-status"] = "inactive"
-                new_interfaces[name]["iface-status"] = "active"
-
-                update_tap_from_vif(idl, name, vif)
-
-        if bridges != new_bridges:
-            for name,ids in new_bridges.items():
-                if name not in bridges:
-                    update_fail_mode(name)
-                    update_in_band_mgmt(name)
-
-                if (name not in bridges) or (bridges[name] != ids):
-                    update_bridge_id(name, ids)
-
-            bridges = new_bridges
+        for row in idl.tables["Interface"].rows.itervalues():
+            # Match up paired vif and tap devices.
+            if row.name.startswith("vif"):
+                vif = row
+                tap = iface_by_name.get("tap%s" % row.name[3:])
+            elif row.name.startswith("tap"):
+                tap = row
+                vif = iface_by_name.get("vif%s" % row.name[3:])
+            else:
+                tap = vif = None
+
+            # Several tap external-ids need to be copied from the vif.
+            if row == tap and vif:
+                keys = ["attached-mac",
+                        "xs-network-uuid",
+                        "xs-vif-uuid",
+                        "xs-vm-uuid"]
+                for k in keys:
+                    set_external_id(row, k, vif.external_ids.get(k))
+
+            # If it's a new interface or its xs-vif-uuid has changed, then
+            # obtain the iface-id from XAPI.
+            #
+            # (A tap's xs-vif-uuid comes from its vif.  That falls out
+            # naturally from the copy loop above.)
+            new_xvu = row.external_ids.get("xs-vif-uuid", "")
+            old_xvu = interfaces.get(row.name)
+            if old_xvu != new_xvu:
+                iface_id = get_iface_id(row.name, new_xvu)
+                if iface_id and row.external_ids.get("iface-id") != iface_id:
+                    set_external_id(row, "iface-id", iface_id)
+
+            # When there's a vif and a tap, the tap is active (used for
+            # traffic).  When there's just a vif, the vif is active.
+            #
+            # A tap on its own shouldn't happen, and we don't know
+            # anything about other kinds of devices, so we don't use
+            # an iface-status for those devices at all.
+            if vif and tap:
+                set_external_id(tap, "iface-status", "active")
+                set_external_id(vif, "iface-status", "inactive")
+            elif vif:
+                set_external_id(vif, "iface-status", "active")
+            else:
+                set_external_id(row, "iface-status", None)
+
+            new_interfaces[row.name] = new_xvu
+        interfaces = new_interfaces
+
+        txn.commit_block()
 
-        if interfaces != new_interfaces:
-            for name,ids in new_interfaces.items():
-                if (name not in interfaces) or (interfaces[name] != ids):
-                    update_iface(name, ids)
-            interfaces = new_interfaces
 
 if __name__ == '__main__':
     try: