xenserver: Always update the bridge ID in ovs-xapi-sync.
[sliver-openvswitch.git] / xenserver / usr_share_openvswitch_scripts_ovs-xapi-sync
index 91ada47..43af406 100755 (executable)
@@ -1,5 +1,5 @@
 #!/usr/bin/python
-# Copyright (c) 2009, 2010, 2011 Nicira Networks
+# Copyright (c) 2009, 2010, 2011, 2012 Nicira Networks
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 #   - Set the "iface-id" key in the Interface table.
 #   - Set the fail-mode on internal bridges.
 
-import getopt
-import logging, logging.handlers
+import argparse
 import os
 import signal
-import subprocess
 import sys
 import time
 
@@ -35,15 +33,15 @@ import XenAPI
 import ovs.dirs
 from ovs.db import error
 from ovs.db import types
-import ovs.util
 import ovs.daemon
 import ovs.db.idl
 
-s_log = logging.getLogger("ovs-xapi-sync")
-vsctl="/usr/bin/ovs-vsctl"
+root_prefix = ''                # Prefix for absolute file names, for testing.
+vlog = ovs.vlog.Vlog("ovs-xapi-sync")
 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
@@ -57,16 +55,17 @@ def init_session():
     try:
         session = XenAPI.xapi_local()
         session.xenapi.login_with_password("", "")
-    except:
+    except XenAPI.Failure, e:
         session = None
-        s_log.warning("Couldn't login to XAPI")
+        vlog.warn("Couldn't login to XAPI (%s)" % e)
         return False
 
     return True
 
+
 def get_network_by_bridge(br_name):
     if not init_session():
-        s_log.warning("Failed to get bridge id %s because"
+        vlog.warn("Failed to get bridge id %s because"
                 " XAPI session could not be initialized" % br_name)
         return None
 
@@ -77,6 +76,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
@@ -88,6 +88,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
@@ -99,7 +100,7 @@ def get_iface_id(if_name, xs_vif_uuid):
         return xs_vif_uuid
 
     if not init_session():
-        s_log.warning("Failed to get interface id %s because"
+        vlog.warn("Failed to get interface id %s because"
                 " XAPI session could not be initialized" % if_name)
         return xs_vif_uuid
 
@@ -108,14 +109,9 @@ def get_iface_id(if_name, xs_vif_uuid):
         rec = session.xenapi.VIF.get_record(vif)
         return rec['other_config'].get('nicira-iface-id', xs_vif_uuid)
     except XenAPI.Failure:
-        s_log.warning("Could not find XAPI entry for VIF %s" % if_name)
+        vlog.warn("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_or_delete(d, key, value):
     if value is None:
@@ -128,11 +124,13 @@ def set_or_delete(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(row):
@@ -146,7 +144,8 @@ def update_fail_mode(row):
         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'
@@ -154,6 +153,7 @@ def update_fail_mode(row):
     if row.fail_mode != fail_mode:
         row.fail_mode = fail_mode
 
+
 def update_in_band_mgmt(row):
     rec = get_network_by_bridge(row.name)
     if not rec:
@@ -163,11 +163,12 @@ def update_in_band_mgmt(row):
 
     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))
+        vlog.warn('"%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
 
+
 def update_bridge_id(row):
     id_ = get_bridge_id(row.name, row.external_ids.get("xs-network-uuids"))
     if not id_:
@@ -175,6 +176,7 @@ def update_bridge_id(row):
 
     set_external_id(row, "bridge-id", id_.split(";")[0])
 
+
 def keep_table_columns(schema, table_name, columns):
     table = schema.tables.get(table_name)
     if not table:
@@ -190,12 +192,8 @@ def keep_table_columns(schema, table_name, columns):
     table.columns = new_columns
     return table
 
-def prune_schema(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 = {}
     new_tables["Bridge"] = keep_table_columns(
         schema, "Bridge", ("name", "external_ids", "other_config",
@@ -204,50 +202,34 @@ def prune_schema(schema):
         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."
-    ovs.daemon.usage()
-    print "Other options:"
-    print "  -h, --help               display this help message"
-    sys.exit(0)
 
 def handler(signum, _):
     global force_run
     if (signum == signal.SIGHUP):
         force_run = True
 
-def main(argv):
+
+def main():
     global force_run
 
-    l_handler = logging.handlers.RotatingFileHandler(
-            "/var/log/openvswitch/ovs-xapi-sync.log")
-    l_formatter = logging.Formatter('%(filename)s: %(levelname)s: %(message)s')
-    l_handler.setFormatter(l_formatter)
-    s_log.addHandler(l_handler)
-    s_log.setLevel(logging.INFO)
+    parser = argparse.ArgumentParser()
+    parser.add_argument("database", metavar="DATABASE",
+            help="A socket on which ovsdb-server is listening.")
+    parser.add_argument("--root-prefix", metavar="DIR",
+                        help="Use DIR as alternate root directory"
+                        " (for testing).")
 
-    try:
-        options, args = getopt.gnu_getopt(
-            argv[1:], 'h', ['help'] + ovs.daemon.LONG_OPTIONS)
-    except getopt.GetoptError, geo:
-        sys.stderr.write("%s: %s\n" % (ovs.util.PROGRAM_NAME, geo.msg))
-        sys.exit(1)
-
-    for key, value in options:
-        if key in ['-h', '--help']:
-            usage()
-        elif not ovs.daemon.parse_opt(key, value):
-            sys.stderr.write("%s: unhandled option %s\n"
-                             % (ovs.util.PROGRAM_NAME, key))
-            sys.exit(1)
-
-    if len(args) != 1:
-        sys.stderr.write("%s: exactly one nonoption argument is required "
-                         "(use --help for help)\n" % ovs.util.PROGRAM_NAME)
-        sys.exit(1)
-
-    remote = args[0]
+    ovs.vlog.add_args(parser)
+    ovs.daemon.add_args(parser)
+    args = parser.parse_args()
+    ovs.vlog.handle_args(args)
+    ovs.daemon.handle_args(args)
+
+    global root_prefix
+    if args.root_prefix:
+        root_prefix = args.root_prefix
+
+    remote = args.database
     schema_file = "%s/vswitch.ovsschema" % ovs.dirs.PKGDATADIR
     schema = ovs.db.schema.DbSchema.from_json(ovs.json.from_file(schema_file))
     prune_schema(schema)
@@ -257,13 +239,14 @@ def main(argv):
 
     # This daemon is usually started before XAPI, but to complete our
     # tasks, we need it.  Wait here until it's up.
-    while not os.path.exists("/var/run/xapi_init_complete.cookie"):
+    cookie_file = root_prefix + "/var/run/xapi_init_complete.cookie"
+    while not os.path.exists(cookie_file):
         time.sleep(1)
 
     signal.signal(signal.SIGHUP, handler)
 
     bridges = {}                # Map from bridge name to xs_network_uuids
-    interfaces = {}             # Map from interface name to 
+    iface_ids = {}              # Map from xs-vif-uuid to iface-id
     while True:
         if not force_run and not idl.run():
             poller = ovs.poller.Poller()
@@ -272,10 +255,10 @@ def main(argv):
             continue
 
         if force_run:
-            s_log.info("Forced to re-run as the result of a SIGHUP")
-            bridges    = {}
-            interfaces = {}
-            force_run  = False
+            vlog.info("Forced to re-run as the result of a SIGHUP")
+            bridges = {}
+            iface_ids = {}
+            force_run = False
 
         txn = ovs.db.idl.Transaction(idl)
 
@@ -287,9 +270,8 @@ def main(argv):
                 # 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)
+
+            update_bridge_id(row)
             new_bridges[row.name] = new_xnu
         bridges = new_bridges
 
@@ -297,7 +279,7 @@ def main(argv):
         for row in idl.tables["Interface"].rows.itervalues():
             iface_by_name[row.name] = row
 
-        new_interfaces = {}
+        new_iface_ids = {}
         for row in idl.tables["Interface"].rows.itervalues():
             # Match up paired vif and tap devices.
             if row.name.startswith("vif"):
@@ -318,17 +300,20 @@ def main(argv):
                 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.
+            # Map from xs-vif-uuid to iface-id.
             #
             # (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)
+            xvu = row.external_ids.get("xs-vif-uuid")
+            if xvu:
+                iface_id = (new_iface_ids.get(xvu)
+                            or iface_ids.get(xvu)
+                            or get_iface_id(row.name, xvu))
+                new_iface_ids[xvu] = iface_id
+            else:
+                # No xs-vif-uuid therefore no iface-id.
+                iface_id = None
+            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.
@@ -343,18 +328,17 @@ def main(argv):
                 set_external_id(vif, "iface-status", "active")
             else:
                 set_external_id(row, "iface-status", None)
-
-            new_interfaces[row.name] = new_xvu
-        interfaces = new_interfaces
+        iface_ids = new_iface_ids
 
         txn.commit_block()
 
+
 if __name__ == '__main__':
     try:
-        main(sys.argv)
+        main()
     except SystemExit:
         # Let system.exit() calls complete normally
         raise
     except:
-        s_log.exception("traceback")
+        vlog.exception("traceback")
         sys.exit(ovs.daemon.RESTART_EXIT_CODE)