pintos-os.org Git - openvswitch/blob - xenserver/opt_xensource_libexec_interface-reconfigure

   1 #!/usr/bin/python
   2 #
   3 # Copyright (c) 2008,2009 Citrix Systems, Inc. All rights reserved.
   4 # Copyright (c) 2009 Nicira Networks.
   5 #
   6 """Usage:
   7
   8     %(command-name)s --session <SESSION-REF> --pif <PIF-REF> [up|down|rewrite]
   9     %(command-name)s --force <BRIDGE> [up|down|rewrite <CONFIG>]
  10     %(command-name)s --force all down
  11
  12     where,
  13           <CONFIG> = --device=<INTERFACE> --mode=dhcp
  14           <CONFIG> = --device=<INTERFACE> --mode=static --ip=<IPADDR> --netmask=<NM> [--gateway=<GW>]
  15
  16   Options:
  17     --session           A session reference to use to access the xapi DB
  18     --pif               A PIF reference.
  19     --force-interface   An interface name. Mutually exclusive with --session/--pif.
  20
  21   Either both --session and --pif  or just --pif-uuid.
  22
  23   <ACTION> is either "up" or "down" or "rewrite"
  24 """
  25
  26 #
  27 # Undocumented parameters for test & dev:
  28 #
  29 #  --output-directory=<DIR>     Write configuration to <DIR>. Also disables actually
  30 #                               raising/lowering the interfaces
  31 #  --pif-uuid                   A PIF UUID, use instead of --session/--pif.
  32 #
  33 #
  34 #
  35 # Notes:
  36 # 1. Every pif belongs to exactly one network
  37 # 2. Every network has zero or one pifs
  38 # 3. A network may have an associated bridge, allowing vifs to be attached
  39 # 4. A network may be bridgeless (there's no point having a bridge over a storage pif)
  40
  41 # XXX: --force-interface=all down
  42
  43 # XXX: --force-interface rewrite
  44
  45 # XXX: Sometimes this leaves "orphaned" datapaths, e.g. a datapath whose
  46 #      only port is the local port.  Should delete those.
  47
  48 # XXX: This can leave crud in ovs-vswitchd.conf in this scenario:
  49 #      - Create bond in XenCenter.
  50 #      - Create VLAN on bond in XenCenter.
  51 #      - Attempt to delete bond in XenCenter (this will fail because there
  52 #        is a VLAN on the bond, although the error may not be reported
  53 #        until the next step)
  54 #      - Delete VLAN in XenCenter.
  55 #      - Delete bond in XenCenter.
  56 # At this point there will still be some configuration data for the bond
  57 # or the VLAN in ovs-vswitchd.conf.
  58
  59 import XenAPI
  60 import os, sys, getopt, time, signal
  61 import syslog
  62 import traceback
  63 import time
  64 import re
  65 import pickle
  66 import random
  67
  68 output_directory = None
  69
  70 db = None
  71 management_pif = None
  72
  73 dbcache_file = "/etc/ovs-vswitch.dbcache"
  74 vswitch_config_dir = "/etc/openvswitch"
  75
  76 class Usage(Exception):
  77     def __init__(self, msg):
  78         Exception.__init__(self)
  79         self.msg = msg
  80
  81 class Error(Exception):
  82     def __init__(self, msg):
  83         Exception.__init__(self)
  84         self.msg = msg
  85
  86 class ConfigurationFile(object):
  87     """Write a file, tracking old and new versions.
  88
  89     Supports writing a new version of a file and applying and
  90     reverting those changes.
  91     """
  92
  93     __STATE = {"OPEN":"OPEN",
  94                "NOT-APPLIED":"NOT-APPLIED", "APPLIED":"APPLIED",
  95                "REVERTED":"REVERTED", "COMMITTED": "COMMITTED"}
  96
  97     def __init__(self, fname, path="/etc/sysconfig/network-scripts"):
  98
  99         self.__state = self.__STATE['OPEN']
 100         self.__fname = fname
 101         self.__children = []
 102
 103         if debug_mode():
 104             dirname = output_directory
 105         else:
 106             dirname = path
 107
 108         self.__path    = os.path.join(dirname, fname)
 109         self.__oldpath = os.path.join(dirname, "." + fname + ".xapi-old")
 110         self.__newpath = os.path.join(dirname, "." + fname + ".xapi-new")
 111         self.__unlink = False
 112
 113         self.__f = open(self.__newpath, "w")
 114
 115     def attach_child(self, child):
 116         self.__children.append(child)
 117
 118     def path(self):
 119         return self.__path
 120
 121     def readlines(self):
 122         try:
 123             return open(self.path()).readlines()
 124         except:
 125             return ""
 126
 127     def write(self, args):
 128         if self.__state != self.__STATE['OPEN']:
 129             raise Error("Attempt to write to file in state %s" % self.__state)
 130         self.__f.write(args)
 131
 132     def unlink(self):
 133         if self.__state != self.__STATE['OPEN']:
 134             raise Error("Attempt to unlink file in state %s" % self.__state)
 135         self.__unlink = True
 136         self.__f.close()
 137         self.__state = self.__STATE['NOT-APPLIED']
 138
 139     def close(self):
 140         if self.__state != self.__STATE['OPEN']:
 141             raise Error("Attempt to close file in state %s" % self.__state)
 142
 143         self.__f.close()
 144         self.__state = self.__STATE['NOT-APPLIED']
 145
 146     def changed(self):
 147         if self.__state != self.__STATE['NOT-APPLIED']:
 148             raise Error("Attempt to compare file in state %s" % self.__state)
 149
 150         return True
 151
 152     def apply(self):
 153         if self.__state != self.__STATE['NOT-APPLIED']:
 154             raise Error("Attempt to apply configuration from state %s" % self.__state)
 155
 156         for child in self.__children:
 157             child.apply()
 158
 159         log("Applying changes to %s configuration" % self.__fname)
 160
 161         # Remove previous backup.
 162         if os.access(self.__oldpath, os.F_OK):
 163             os.unlink(self.__oldpath)
 164
 165         # Save current configuration.
 166         if os.access(self.__path, os.F_OK):
 167             os.link(self.__path, self.__oldpath)
 168             os.unlink(self.__path)
 169
 170         # Apply new configuration.
 171         assert(os.path.exists(self.__newpath))
 172         if not self.__unlink:
 173             os.link(self.__newpath, self.__path)
 174         else:
 175             pass # implicit unlink of original file
 176
 177         # Remove temporary file.
 178         os.unlink(self.__newpath)
 179
 180         self.__state = self.__STATE['APPLIED']
 181
 182     def revert(self):
 183         if self.__state != self.__STATE['APPLIED']:
 184             raise Error("Attempt to revert configuration from state %s" % self.__state)
 185
 186         for child in self.__children:
 187             child.revert()
 188
 189         log("Reverting changes to %s configuration" % self.__fname)
 190
 191         # Remove existing new configuration
 192         if os.access(self.__newpath, os.F_OK):
 193             os.unlink(self.__newpath)
 194
 195         # Revert new configuration.
 196         if os.access(self.__path, os.F_OK):
 197             os.link(self.__path, self.__newpath)
 198             os.unlink(self.__path)
 199
 200         # Revert to old configuration.
 201         if os.access(self.__oldpath, os.F_OK):
 202             os.link(self.__oldpath, self.__path)
 203             os.unlink(self.__oldpath)
 204
 205         # Leave .*.xapi-new as an aid to debugging.
 206
 207         self.__state = self.__STATE['REVERTED']
 208
 209     def commit(self):
 210         if self.__state != self.__STATE['APPLIED']:
 211             raise Error("Attempt to commit configuration from state %s" % self.__state)
 212
 213         for child in self.__children:
 214             child.commit()
 215
 216         log("Committing changes to %s configuration" % self.__fname)
 217
 218         if os.access(self.__oldpath, os.F_OK):
 219             os.unlink(self.__oldpath)
 220         if os.access(self.__newpath, os.F_OK):
 221             os.unlink(self.__newpath)
 222
 223         self.__state = self.__STATE['COMMITTED']
 224
 225 def debug_mode():
 226     return output_directory is not None
 227
 228 def log(s):
 229     if debug_mode():
 230         print >>sys.stderr, s
 231     else:
 232         syslog.syslog(s)
 233
 234 def check_allowed(pif):
 235     pifrec = db.get_pif_record(pif)
 236     try:
 237         f = open("/proc/ardence")
 238         macline = filter(lambda x: x.startswith("HWaddr:"), f.readlines())
 239         f.close()
 240         if len(macline) == 1:
 241             p = re.compile(".*\s%(MAC)s\s.*" % pifrec, re.IGNORECASE)
 242             if p.match(macline[0]):
 243                 log("Skipping PVS device %(device)s (%(MAC)s)" % pifrec)
 244                 return False
 245     except IOError:
 246         pass
 247     return True
 248
 249 def interface_exists(i):
 250     return os.path.exists("/sys/class/net/" + i)
 251
 252 def get_netdev_mac(device):
 253     try:
 254         return read_first_line_of_file("/sys/class/net/%s/address" % device)
 255     except:
 256         # Probably no such device.
 257         return None
 258
 259 def get_netdev_tx_queue_len(device):
 260     try:
 261         return int(read_first_line_of_file("/sys/class/net/%s/tx_queue_len"
 262                                            % device))
 263     except:
 264         # Probably no such device.
 265         return None
 266
 267 def get_netdev_by_mac(mac):
 268     maybe = None
 269     for device in os.listdir("/sys/class/net"):
 270         dev_mac = get_netdev_mac(device)
 271         if dev_mac and mac.lower() == dev_mac.lower():
 272             if get_netdev_tx_queue_len(device):
 273                 return device
 274             if not maybe:
 275                 # Probably a datapath internal port.
 276                 maybe = device
 277     return maybe
 278
 279 class DatabaseCache(object):
 280     def __init__(self, session_ref=None, cache_file=None):
 281         if session_ref and cache_file:
 282             raise Error("can't specify session reference and cache file")
 283
 284         if cache_file == None:
 285             session = XenAPI.xapi_local()
 286
 287             if not session_ref:
 288                 log("No session ref given on command line, logging in.")
 289                 session.xenapi.login_with_password("root", "")
 290             else:
 291                 session._session = session_ref
 292
 293             try:
 294                 self.__vlans = session.xenapi.VLAN.get_all_records()
 295                 self.__bonds = session.xenapi.Bond.get_all_records()
 296                 self.__pifs = session.xenapi.PIF.get_all_records()
 297                 self.__networks = session.xenapi.network.get_all_records()
 298             finally:
 299                 if not session_ref:
 300                     session.xenapi.session.logout()
 301         else:
 302             log("Loading xapi database cache from %s" % cache_file)
 303             f = open(cache_file, 'r')
 304             members = pickle.load(f)
 305             self.extras = pickle.load(f)
 306             f.close()
 307
 308             self.__vlans = members['vlans']
 309             self.__bonds = members['bonds']
 310             self.__pifs = members['pifs']
 311             self.__networks = members['networks']
 312
 313     def save(self, cache_file, extras):
 314         f = open(cache_file, 'w')
 315         pickle.dump({'vlans': self.__vlans,
 316                      'bonds': self.__bonds,
 317                      'pifs': self.__pifs,
 318                      'networks': self.__networks}, f)
 319         pickle.dump(extras, f)
 320         f.close()
 321
 322     def get_pif_by_uuid(self, uuid):
 323         pifs = map(lambda (ref,rec): ref,
 324                   filter(lambda (ref,rec): uuid == rec['uuid'],
 325                          self.__pifs.items()))
 326         if len(pifs) == 0:
 327             raise Error("Unknown PIF \"%s\"" % uuid)
 328         elif len(pifs) > 1:
 329             raise Error("Non-unique PIF \"%s\"" % uuid)
 330
 331         return pifs[0]
 332
 333     def get_pifs_by_record(self, record):
 334         """record is partial pif record.
 335         Get the pif(s) whose record matches.
 336         """
 337         def match(pifrec):
 338             for key in record:
 339                 if record[key] != pifrec[key]:
 340                     return False
 341             return True
 342
 343         return map(lambda (ref,rec): ref,
 344                    filter(lambda (ref,rec): match(rec),
 345                           self.__pifs.items()))
 346
 347     def get_pif_by_record(self, record):
 348         """record is partial pif record.
 349         Get the pif whose record matches.
 350         """
 351         pifs = self.get_pifs_by_record(record)
 352         if len(pifs) == 0:
 353             raise Error("No matching PIF \"%s\"" % str(record))
 354         elif len(pifs) > 1:
 355             raise Error("Multiple matching PIFs \"%s\"" % str(record))
 356
 357         return pifs[0]
 358
 359     def get_pif_by_bridge(self, host, bridge):
 360         networks = map(lambda (ref,rec): ref,
 361                        filter(lambda (ref,rec): rec['bridge'] == bridge,
 362                               self.__networks.items()))
 363         if len(networks) == 0:
 364             raise Error("No matching network \"%s\"")
 365
 366         answer = None
 367         for network in networks:
 368             nwrec = self.get_network_record(network)
 369             for pif in nwrec['PIFs']:
 370                 pifrec = self.get_pif_record(pif)
 371                 if pifrec['host'] != host:
 372                     continue
 373                 if answer:
 374                     raise Error("Multiple PIFs on %s for network %s" % (host, bridge))
 375                 answer = pif
 376         if not answer:
 377             raise Error("No PIF on %s for network %s" % (host, bridge))
 378         return answer
 379
 380     def get_pif_record(self, pif):
 381         if self.__pifs.has_key(pif):
 382             return self.__pifs[pif]
 383         raise Error("Unknown PIF \"%s\"" % pif)
 384     def get_all_pifs(self):
 385         return self.__pifs
 386     def pif_exists(self, pif):
 387         return self.__pifs.has_key(pif)
 388
 389     def get_management_pif(self, host):
 390         """ Returns the management pif on host
 391         """
 392         all = self.get_all_pifs()
 393         for pif in all:
 394             pifrec = self.get_pif_record(pif)
 395             if pifrec['management'] and pifrec['host'] == host :
 396                 return pif
 397         return None
 398
 399     def get_network_record(self, network):
 400         if self.__networks.has_key(network):
 401             return self.__networks[network]
 402         raise Error("Unknown network \"%s\"" % network)
 403     def get_all_networks(self):
 404         return self.__networks
 405
 406     def get_bond_record(self, bond):
 407         if self.__bonds.has_key(bond):
 408             return self.__bonds[bond]
 409         else:
 410             return None
 411
 412     def get_vlan_record(self, vlan):
 413         if self.__vlans.has_key(vlan):
 414             return self.__vlans[vlan]
 415         else:
 416             return None
 417
 418 def bridge_name(pif):
 419     """Return the bridge name associated with pif, or None if network is bridgeless"""
 420     pifrec = db.get_pif_record(pif)
 421     nwrec = db.get_network_record(pifrec['network'])
 422
 423     if nwrec['bridge']:
 424         # TODO: sanity check that nwrec['bridgeless'] != 'true'
 425         return nwrec['bridge']
 426     else:
 427         # TODO: sanity check that nwrec['bridgeless'] == 'true'
 428         return None
 429
 430 def interface_name(pif):
 431     """Construct an interface name from the given PIF record."""
 432
 433     pifrec = db.get_pif_record(pif)
 434
 435     if pifrec['VLAN'] == '-1':
 436         return pifrec['device']
 437     else:
 438         return "%(device)s.%(VLAN)s" % pifrec
 439
 440 def datapath_name(pif):
 441     """Return the OpenFlow datapath name associated with pif.
 442 For a non-VLAN PIF, the datapath name is the bridge name.
 443 For a VLAN PIF, the datapath name is the bridge name for the PIF's VLAN slave.
 444 (xapi will create a datapath named with the bridge name even though we won't
 445 use it.)
 446 """
 447
 448     pifrec = db.get_pif_record(pif)
 449
 450     if pifrec['VLAN'] == '-1':
 451         return bridge_name(pif)
 452     else:
 453         return bridge_name(get_vlan_slave_of_pif(pif))
 454
 455 def ipdev_name(pif):
 456     """Return the the name of the network device that carries the
 457 IP configuration (if any) associated with pif.
 458 The ipdev name is the same as the bridge name.
 459 """
 460
 461     pifrec = db.get_pif_record(pif)
 462     return bridge_name(pif)
 463
 464 def physdev_pifs(pif):
 465     """Return the PIFs for the physical network device(s) associated with pif.
 466 For a VLAN PIF, this is the VLAN slave's physical device PIF.
 467 For a bond master PIF, these are the bond slave PIFs.
 468 For a non-VLAN, non-bond master PIF, the PIF is its own physical device PIF.
 469 """
 470
 471     pifrec = db.get_pif_record(pif)
 472
 473     if pifrec['VLAN'] != '-1':
 474         return [get_vlan_slave_of_pif(pif)]
 475     elif len(pifrec['bond_master_of']) != 0:
 476         return get_bond_slaves_of_pif(pif)
 477     else:
 478         return [pif]
 479
 480 def physdev_names(pif):
 481     """Return the name(s) of the physical network device(s) associated with pif.
 482 For a VLAN PIF, the physical devices are the VLAN slave's physical devices.
 483 For a bond master PIF, the physical devices are the bond slaves.
 484 For a non-VLAN, non-bond master PIF, the physical device is the PIF itself.
 485 """
 486
 487     return [db.get_pif_record(phys)['device'] for phys in physdev_pifs(pif)]
 488
 489 def log_pif_action(action, pif):
 490     pifrec = db.get_pif_record(pif)
 491     pifrec['action'] = action
 492     pifrec['interface-name'] = interface_name(pif)
 493     if action == "rewrite":
 494         pifrec['message'] = "Rewrite PIF %(uuid)s configuration" % pifrec
 495     else:
 496         pifrec['message'] = "Bring %(action)s PIF %(uuid)s" % pifrec
 497     log("%(message)s: %(interface-name)s configured as %(ip_configuration_mode)s" % pifrec)
 498
 499 def get_bond_masters_of_pif(pif):
 500     """Returns a list of PIFs which are bond masters of this PIF"""
 501
 502     pifrec = db.get_pif_record(pif)
 503
 504     bso = pifrec['bond_slave_of']
 505
 506     # bond-slave-of is currently a single reference but in principle a
 507     # PIF could be a member of several bonds which are not
 508     # concurrently attached. Be robust to this possibility.
 509     if not bso or bso == "OpaqueRef:NULL":
 510         bso = []
 511     elif not type(bso) == list:
 512         bso = [bso]
 513
 514     bondrecs = [db.get_bond_record(bond) for bond in bso]
 515     bondrecs = [rec for rec in bondrecs if rec]
 516
 517     return [bond['master'] for bond in bondrecs]
 518
 519 def get_bond_slaves_of_pif(pif):
 520     """Returns a list of PIFs which make up the given bonded pif."""
 521
 522     pifrec = db.get_pif_record(pif)
 523     host = pifrec['host']
 524
 525     bmo = pifrec['bond_master_of']
 526     if len(bmo) > 1:
 527         raise Error("Bond-master-of contains too many elements")
 528
 529     if len(bmo) == 0:
 530         return []
 531
 532     bondrec = db.get_bond_record(bmo[0])
 533     if not bondrec:
 534         raise Error("No bond record for bond master PIF")
 535
 536     return bondrec['slaves']
 537
 538 def get_vlan_slave_of_pif(pif):
 539     """Find the PIF which is the VLAN slave of pif.
 540
 541 Returns the 'physical' PIF underneath the a VLAN PIF @pif."""
 542
 543     pifrec = db.get_pif_record(pif)
 544
 545     vlan = pifrec['VLAN_master_of']
 546     if not vlan or vlan == "OpaqueRef:NULL":
 547         raise Error("PIF is not a VLAN master")
 548
 549     vlanrec = db.get_vlan_record(vlan)
 550     if not vlanrec:
 551         raise Error("No VLAN record found for PIF")
 552
 553     return vlanrec['tagged_PIF']
 554
 555 def get_vlan_masters_of_pif(pif):
 556     """Returns a list of PIFs which are VLANs on top of the given pif."""
 557
 558     pifrec = db.get_pif_record(pif)
 559     vlans = [db.get_vlan_record(v) for v in pifrec['VLAN_slave_of']]
 560     return [v['untagged_PIF'] for v in vlans if v and db.pif_exists(v['untagged_PIF'])]
 561
 562 def interface_deconfigure_commands(interface):
 563     # The use of [!0-9] keeps an interface of 'eth0' from matching
 564     # VLANs attached to eth0 (such as 'eth0.123'), which are distinct
 565     # interfaces.
 566     return ['--del-match=bridge.*.port=%s' % interface,
 567             '--del-match=bonding.%s.[!0-9]*' % interface,
 568             '--del-match=bonding.*.slave=%s' % interface,
 569             '--del-match=vlan.%s.[!0-9]*' % interface,
 570             '--del-match=port.%s.[!0-9]*' % interface,
 571             '--del-match=iface.%s.[!0-9]*' % interface]
 572
 573 def run_command(command):
 574     log("Running command: " + ' '.join(command))
 575     if os.spawnl(os.P_WAIT, command[0], *command) != 0:
 576         log("Command failed: " + ' '.join(command))
 577         return False
 578     return True
 579
 580 def rename_netdev(old_name, new_name):
 581     log("Changing the name of %s to %s" % (old_name, new_name))
 582     run_command(['/sbin/ifconfig', old_name, 'down'])
 583     if not run_command(['/sbin/ip', 'link', 'set', old_name,
 584                         'name', new_name]):
 585         raise Error("Could not rename %s to %s" % (old_name, new_name))
 586
 587 # Check whether 'pif' exists and has the correct MAC.
 588 # If not, try to find a device with the correct MAC and rename it.
 589 # 'already_renamed' is used to avoid infinite recursion.
 590 def remap_pif(pif, already_renamed=[]):
 591     pifrec = db.get_pif_record(pif)
 592     device = pifrec['device']
 593     mac = pifrec['MAC']
 594
 595     # Is there a network device named 'device' at all?
 596     device_exists = interface_exists(device)
 597     if device_exists:
 598         # Yes.  Does it have MAC 'mac'?
 599         found_mac = get_netdev_mac(device)
 600         if found_mac and mac.lower() == found_mac.lower():
 601             # Yes, everything checks out the way we want.  Nothing to do.
 602             return
 603     else:
 604         log("No network device %s" % device)
 605
 606     # What device has MAC 'mac'?
 607     cur_device = get_netdev_by_mac(mac)
 608     if not cur_device:
 609         log("No network device has MAC %s" % mac)
 610         return
 611
 612     # First rename 'device', if it exists, to get it out of the way
 613     # for 'cur_device' to replace it.
 614     if device_exists:
 615         rename_netdev(device, "dev%d" % random.getrandbits(24))
 616
 617     # Rename 'cur_device' to 'device'.
 618     rename_netdev(cur_device, device)
 619
 620 def read_first_line_of_file(name):
 621     file = None
 622     try:
 623         file = open(name, 'r')
 624         return file.readline().rstrip('\n')
 625     finally:
 626         if file != None:
 627             file.close()
 628
 629 def down_netdev(interface, deconfigure=True):
 630     if not interface_exists(interface):
 631         log("down_netdev: interface %s does not exist, ignoring" % interface)
 632         return
 633     if deconfigure:
 634         # Kill dhclient.
 635         pidfile_name = '/var/run/dhclient-%s.pid' % interface
 636         try:
 637             os.kill(int(read_first_line_of_file(pidfile_name)), signal.SIGTERM)
 638         except:
 639             pass
 640
 641         # Remove dhclient pidfile.
 642         try:
 643             os.remove(pidfile_name)
 644         except:
 645             pass
 646
 647         run_command(["/sbin/ifconfig", interface, '0.0.0.0'])
 648
 649     run_command(["/sbin/ifconfig", interface, 'down'])
 650
 651 def up_netdev(interface):
 652     run_command(["/sbin/ifconfig", interface, 'up'])
 653
 654 def find_distinguished_pifs(pif):
 655     """Returns the PIFs on host that own DNS and the default route.
 656 The peerdns pif will be the one with pif::other-config:peerdns=true, or the mgmt pif if none have this set.
 657 The gateway pif will be the one with pif::other-config:defaultroute=true, or the mgmt pif if none have this set.
 658
 659 Note: we prune out the bond master pif (if it exists).
 660 This is because when we are called to bring up an interface with a bond master, it is implicit that
 661 we should bring down that master."""
 662
 663     pifrec = db.get_pif_record(pif)
 664     host = pifrec['host']
 665
 666     pifs_on_host = [ __pif for __pif in db.get_all_pifs() if
 667                      db.get_pif_record(__pif)['host'] == host and
 668                      (not  __pif in get_bond_masters_of_pif(pif)) ]
 669
 670     peerdns_pif = None
 671     defaultroute_pif = None
 672
 673     # loop through all the pifs on this host looking for one with
 674     #   other-config:peerdns = true, and one with
 675     #   other-config:default-route=true
 676     for __pif in pifs_on_host:
 677         __pifrec = db.get_pif_record(__pif)
 678         __oc = __pifrec['other_config']
 679         if __oc.has_key('peerdns') and __oc['peerdns'] == 'true':
 680             if peerdns_pif == None:
 681                 peerdns_pif = __pif
 682             else:
 683                 log('Warning: multiple pifs with "peerdns=true" - choosing %s and ignoring %s' % \
 684                         (db.get_pif_record(peerdns_pif)['device'], __pifrec['device']))
 685         if __oc.has_key('defaultroute') and __oc['defaultroute'] == 'true':
 686             if defaultroute_pif == None:
 687                 defaultroute_pif = __pif
 688             else:
 689                 log('Warning: multiple pifs with "defaultroute=true" - choosing %s and ignoring %s' % \
 690                         (db.get_pif_record(defaultroute_pif)['device'], __pifrec['device']))
 691
 692     # If no pif is explicitly specified then use the mgmt pif for peerdns/defaultroute
 693     if peerdns_pif == None:
 694         peerdns_pif = management_pif
 695     if defaultroute_pif == None:
 696         defaultroute_pif = management_pif
 697
 698     return peerdns_pif, defaultroute_pif
 699
 700 def ethtool_settings(oc):
 701     # Options for "ethtool -s"
 702     settings = []
 703     if oc.has_key('ethtool-speed'):
 704         val = oc['ethtool-speed']
 705         if val in ["10", "100", "1000"]:
 706             settings += ['speed', val]
 707         else:
 708             log("Invalid value for ethtool-speed = %s. Must be 10|100|1000." % val)
 709     if oc.has_key('ethtool-duplex'):
 710         val = oc['ethtool-duplex']
 711         if val in ["10", "100", "1000"]:
 712             settings += ['duplex', 'val']
 713         else:
 714             log("Invalid value for ethtool-duplex = %s. Must be half|full." % val)
 715     if oc.has_key('ethtool-autoneg'):
 716         val = oc['ethtool-autoneg']
 717         if val in ["true", "on"]:
 718             settings += ['autoneg', 'on']
 719         elif val in ["false", "off"]:
 720             settings += ['autoneg', 'off']
 721         else:
 722             log("Invalid value for ethtool-autoneg = %s. Must be on|true|off|false." % val)
 723
 724     # Options for "ethtool -K"
 725     offload = []
 726     for opt in ("rx", "tx", "sg", "tso", "ufo", "gso"):
 727         if oc.has_key("ethtool-" + opt):
 728             val = oc["ethtool-" + opt]
 729             if val in ["true", "on"]:
 730                 offload += [opt, 'on']
 731             elif val in ["false", "off"]:
 732                 offload += [opt, 'off']
 733             else:
 734                 log("Invalid value for ethtool-%s = %s. Must be on|true|off|false." % (opt, val))
 735
 736     return settings, offload
 737
 738 def configure_netdev(pif):
 739     pifrec = db.get_pif_record(pif)
 740     datapath = datapath_name(pif)
 741     ipdev = ipdev_name(pif)
 742
 743     host = pifrec['host']
 744     nw = pifrec['network']
 745     nwrec = db.get_network_record(nw)
 746
 747     ifconfig_argv = ['/sbin/ifconfig', ipdev, 'up']
 748     gateway = ''
 749     if pifrec['ip_configuration_mode'] == "DHCP":
 750         pass
 751     elif pifrec['ip_configuration_mode'] == "Static":
 752         ifconfig_argv += [pifrec['IP']]
 753         ifconfig_argv += ['netmask', pifrec['netmask']]
 754         gateway = pifrec['gateway']
 755     elif pifrec['ip_configuration_mode'] == "None":
 756         # Nothing to do.
 757         pass
 758     else:
 759         raise Error("Unknown IP-configuration-mode %s" % pifrec['ip_configuration_mode'])
 760
 761     oc = pifrec['other_config']
 762     if oc.has_key('mtu'):
 763         try:
 764             int(oc['mtu'])      # Check that the value is an integer
 765             ifconfig_argv += ['mtu', oc['mtu']]
 766         except ValueError, x:
 767             log("Invalid value for mtu = %s" % mtu)
 768
 769     run_command(ifconfig_argv)
 770
 771     (peerdns_pif, defaultroute_pif) = find_distinguished_pifs(pif)
 772
 773     if peerdns_pif == pif:
 774         f = ConfigurationFile('resolv.conf', "/etc")
 775         if oc.has_key('domain'):
 776             f.write("search %s\n" % oc['domain'])
 777         for dns in pifrec['DNS'].split(","):
 778             f.write("nameserver %s\n" % dns)
 779         f.close()
 780         f.apply()
 781         f.commit()
 782
 783     if defaultroute_pif == pif and gateway != '':
 784         run_command(['/sbin/ip', 'route', 'replace', 'default',
 785                      'via', gateway, 'dev', ipdev])
 786
 787     if oc.has_key('static-routes'):
 788         for line in oc['static-routes'].split(','):
 789             network, masklen, gateway = line.split('/')
 790             run_command(['/sbin/ip', 'route', 'add',
 791                          '%s/%s' % (netmask, masklen), 'via', gateway,
 792                          'dev', ipdev])
 793
 794     settings, offload = ethtool_settings(oc)
 795     if settings:
 796         run_command(['/sbin/ethtool', '-s', ipdev] + settings)
 797     if offload:
 798         run_command(['/sbin/ethtool', '-K', ipdev] + offload)
 799
 800     if pifrec['ip_configuration_mode'] == "DHCP":
 801         print
 802         print "Determining IP information for %s..." % ipdev,
 803         argv = ['/sbin/dhclient', '-q',
 804                 '-lf', '/var/lib/dhclient/dhclient-%s.leases' % ipdev,
 805                 '-pf', '/var/run/dhclient-%s.pid' % ipdev,
 806                 ipdev]
 807         if run_command(argv):
 808             print 'done.'
 809         else:
 810             print 'failed.'
 811
 812 def modify_config(commands):
 813     run_command(['/root/vswitch/bin/ovs-cfg-mod', '-vANY:console:emer',
 814                  '-F', '/etc/ovs-vswitchd.conf']
 815                 + commands + ['-c'])
 816     run_command(['/sbin/service', 'vswitch', 'reload'])
 817
 818 def is_bond_pif(pif):
 819     pifrec = db.get_pif_record(pif)
 820     return len(pifrec['bond_master_of']) != 0
 821
 822 def configure_bond(pif):
 823     pifrec = db.get_pif_record(pif)
 824     interface = interface_name(pif)
 825     ipdev = ipdev_name(pif)
 826     datapath = datapath_name(pif)
 827     physdevs = physdev_names(pif)
 828
 829     argv = ['--del-match=bonding.%s.[!0-9]*' % interface]
 830     argv += ["--add=bonding.%s.slave=%s" % (interface, slave)
 831              for slave in physdevs]
 832
 833     if pifrec['MAC'] != "":
 834         argv += ['--add=port.%s.mac=%s' % (interface, pifrec['MAC'])]
 835
 836     # Bonding options.
 837     bond_options = {
 838         "mode":   "balance-slb",
 839         "miimon": "100",
 840         "downdelay": "200",
 841         "updelay": "31000",
 842         "use_carrier": "1",
 843         }
 844     # override defaults with values from other-config whose keys
 845     # being with "bond-"
 846     oc = pifrec['other_config']
 847     overrides = filter(lambda (key,val):
 848                            key.startswith("bond-"), oc.items())
 849     overrides = map(lambda (key,val): (key[5:], val), overrides)
 850     bond_options.update(overrides)
 851     for (name,val) in bond_options.items():
 852         argv += ["--add=bonding.%s.%s=%s" % (interface, name, val)]
 853     return argv
 854
 855 def action_up(pif):
 856     pifrec = db.get_pif_record(pif)
 857
 858     bridge = bridge_name(pif)
 859     interface = interface_name(pif)
 860     ipdev = ipdev_name(pif)
 861     datapath = datapath_name(pif)
 862     physdevs = physdev_names(pif)
 863     vlan_slave = None
 864     if pifrec['VLAN'] != '-1':
 865         vlan_slave = get_vlan_slave_of_pif(pif)
 866     if vlan_slave and is_bond_pif(vlan_slave):
 867         bond_master = vlan_slave
 868     elif is_bond_pif(pif):
 869         bond_master = pif
 870     else:
 871         bond_master = None
 872     if bond_master:
 873         bond_slaves = get_bond_slaves_of_pif(bond_master)
 874     else:
 875         bond_slaves = []
 876     bond_masters = get_bond_masters_of_pif(pif)
 877
 878     # Support "rpm -e vswitch" gracefully by keeping Centos configuration
 879     # files up-to-date, even though we don't use them or need them.
 880     f = configure_pif(pif)
 881     mode = pifrec['ip_configuration_mode']
 882     if bridge:
 883         log("Configuring %s using %s configuration" % (bridge, mode))
 884         br = open_network_ifcfg(pif)
 885         configure_network(pif, br)
 886         br.close()
 887         f.attach_child(br)
 888     else:
 889         log("Configuring %s using %s configuration" % (interface, mode))
 890         configure_network(pif, f)
 891     f.close()
 892     for master in bond_masters:
 893         master_bridge = bridge_name(master)
 894         removed = unconfigure_pif(master)
 895         f.attach_child(removed)
 896         if master_bridge:
 897             removed = open_network_ifcfg(master)
 898             log("Unlinking stale file %s" % removed.path())
 899             removed.unlink()
 900             f.attach_child(removed)
 901
 902     # /etc/xensource/scripts/vif needs to know where to add VIFs.
 903     if vlan_slave:
 904         if not os.path.exists(vswitch_config_dir):
 905             os.mkdir(vswitch_config_dir)
 906         br = ConfigurationFile("br-%s" % bridge, vswitch_config_dir)
 907         br.write("VLAN_SLAVE=%s\n" % datapath)
 908         br.write("VLAN_VID=%s\n" % pifrec['VLAN'])
 909         br.close()
 910         f.attach_child(br)
 911
 912     # Update all configuration files (both ours and Centos's).
 913     f.apply()
 914     f.commit()
 915
 916     # Check the MAC address of each network device and remap if
 917     # necessary to make names match our expectations.
 918     for physdev_pif in physdev_pifs(pif):
 919         remap_pif(physdev_pif)
 920
 921     # "ifconfig down" the network device and delete its IP address, etc.
 922     down_netdev(ipdev)
 923     for physdev in physdevs:
 924         down_netdev(physdev)
 925
 926     # If we are bringing up a bond, remove IP addresses from the
 927     # slaves (because we are implicitly being asked to take them down).
 928     #
 929     # Conversely, if we are bringing up an interface that has bond
 930     # masters, remove IP addresses from the bond master (because we
 931     # are implicitly being asked to take it down).
 932     for bond_pif in bond_slaves + bond_masters:
 933         run_command(["/sbin/ifconfig", ipdev_name(bond_pif), '0.0.0.0'])
 934
 935     # Remove all keys related to pif and any bond masters linked to PIF.
 936     del_ports = [ipdev] + physdevs + bond_masters
 937     if vlan_slave and bond_master:
 938         del_ports += [interface_name(bond_master)]
 939
 940     # What ports do we need to add to the datapath?
 941     #
 942     # We definitely need the ipdev, and ordinarily we want the
 943     # physical devices too, but for bonds we need the bond as bridge
 944     # port.
 945     add_ports = [ipdev, datapath]
 946     if not bond_master:
 947         add_ports += physdevs
 948     else:
 949         add_ports += [interface_name(bond_master)]
 950
 951     # What ports do we need to delete?
 952     #
 953     #  - All the ports that we add, to avoid duplication and to drop
 954     #    them from another datapath in case they're misassigned.
 955     #
 956     #  - The physical devices, since they will either be in add_ports
 957     #    or added to the bonding device (see below).
 958     #
 959     #  - The bond masters for pif.  (Ordinarily pif shouldn't have any
 960     #    bond masters.  If it does then interface-reconfigure is
 961     #    implicitly being asked to take them down.)
 962     del_ports = add_ports + physdevs + bond_masters
 963
 964     # What networks does this datapath carry?
 965     #
 966     # - The network corresponding to the datapath's PIF.
 967     #
 968     # - The networks corresponding to any VLANs attached to the
 969     #   datapath's PIF.
 970     network_uuids = []
 971     for nwpif in db.get_pifs_by_record({'device': pifrec['device'],
 972                                         'host': pifrec['host']}):
 973         net = db.get_pif_record(nwpif)['network']
 974         network_uuids += [db.get_network_record(net)['uuid']]
 975
 976     # Bring up bond slaves early, because ovs-vswitchd initially
 977     # enables or disables bond slaves based on whether carrier is
 978     # detected when they are added, and a network device that is down
 979     # always reports "no carrier".
 980     bond_slave_physdevs = []
 981     for slave in bond_slaves:
 982         bond_slave_physdevs += physdev_names(slave)
 983     for slave_physdev in bond_slave_physdevs:
 984         up_netdev(slave_physdev)
 985
 986     # Now modify the ovs-vswitchd config file.
 987     argv = []
 988     for port in set(del_ports):
 989         argv += interface_deconfigure_commands(port)
 990     for port in set(add_ports):
 991         argv += ['--add=bridge.%s.port=%s' % (datapath, port)]
 992     if vlan_slave:
 993         argv += ['--add=vlan.%s.tag=%s' % (ipdev, pifrec['VLAN'])]
 994         argv += ['--add=iface.%s.internal=true' % (ipdev)]
 995
 996         # xapi creates a bridge by the name of the ipdev and requires
 997         # that the IP address will be on it.  We need to delete this
 998         # bridge because we need that device to be a member of our
 999         # datapath.
1000         argv += ['--del-match=bridge.%s.[!0-9]*' % ipdev]
1001
1002         # xapi insists that its attempts to create the bridge succeed,
1003         # so force that to happen.
1004         argv += ['--add=iface.%s.fake-bridge=true' % (ipdev)]
1005     else:
1006         try:
1007             os.unlink("%s/br-%s" % (vswitch_config_dir, bridge))
1008         except OSError:
1009             pass
1010     argv += ['--del-match=bridge.%s.xs-network-uuids=*' % datapath]
1011     argv += ['--add=bridge.%s.xs-network-uuids=%s' % (datapath, uuid)
1012              for uuid in set(network_uuids)]
1013     if bond_master:
1014         argv += configure_bond(bond_master)
1015     modify_config(argv)
1016
1017     # Configure network devices.
1018     configure_netdev(pif)
1019
1020     # Bring up VLAN slave, plus physical devices other than bond
1021     # slaves (which we brought up earlier).
1022     if vlan_slave:
1023         up_netdev(ipdev_name(vlan_slave))
1024     for physdev in set(physdevs) - set(bond_slave_physdevs):
1025         up_netdev(physdev)
1026
1027     # Update /etc/issue (which contains the IP address of the management interface)
1028     os.system("/sbin/update-issue")
1029
1030     if bond_slaves:
1031         # There seems to be a race somewhere: without this sleep, using
1032         # XenCenter to create a bond that becomes the management interface
1033         # fails with "The underlying connection was closed: A connection that
1034         # was expected to be kept alive was closed by the server." on every
1035         # second or third try, even though /var/log/messages doesn't show
1036         # anything unusual.
1037         #
1038         # The race is probably present even without vswitch, but bringing up a
1039         # bond without vswitch involves a built-in pause of 10 seconds or more
1040         # to wait for the bond to transition from learning to forwarding state.
1041         time.sleep(5)
1042
1043 def action_down(pif):
1044     rec = db.get_pif_record(pif)
1045     interface = interface_name(pif)
1046     bridge = bridge_name(pif)
1047     ipdev = ipdev_name(pif)
1048
1049     # Support "rpm -e vswitch" gracefully by keeping Centos configuration
1050     # files up-to-date, even though we don't use them or need them.
1051     f = unconfigure_pif(pif)
1052     if bridge:
1053         br = open_network_ifcfg(pif)
1054         log("Unlinking stale file %s" % br.path())
1055         br.unlink()
1056         f.attach_child(br)
1057     try:
1058         f.apply()
1059         f.commit()
1060     except Error, e:
1061         log("action_down failed to apply changes: %s" % e.msg)
1062         f.revert()
1063         raise
1064
1065     argv = []
1066     if rec['VLAN'] != '-1':
1067         # Get rid of the VLAN device itself.
1068         down_netdev(ipdev)
1069         argv += interface_deconfigure_commands(ipdev)
1070
1071         # If the VLAN's slave is attached, stop here.
1072         slave = get_vlan_slave_of_pif(pif)
1073         if db.get_pif_record(slave)['currently_attached']:
1074             log("VLAN slave is currently attached")
1075             modify_config(argv)
1076             return
1077
1078         # If the VLAN's slave has other VLANs that are attached, stop here.
1079         masters = get_vlan_masters_of_pif(slave)
1080         for m in masters:
1081             if m != pif and db.get_pif_record(m)['currently_attached']:
1082                 log("VLAN slave has other master %s" % interface_naem(m))
1083                 modify_config(argv)
1084                 return
1085
1086         # Otherwise, take down the VLAN's slave too.
1087         log("No more masters, bring down vlan slave %s" % interface_name(slave))
1088         pif = slave
1089     else:
1090         # Stop here if this PIF has attached VLAN masters.
1091         vlan_masters = get_vlan_masters_of_pif(pif)
1092         log("VLAN masters of %s - %s" % (rec['device'], [interface_name(m) for m in vlan_masters]))
1093         for m in vlan_masters:
1094             if db.get_pif_record(m)['currently_attached']:
1095                 log("Leaving %s up due to currently attached VLAN master %s" % (interface, interface_name(m)))
1096                 return
1097
1098     # pif is now either a bond or a physical device which needs to be
1099     # brought down.  pif might have changed so re-check all its attributes.
1100     rec = db.get_pif_record(pif)
1101     interface = interface_name(pif)
1102     bridge = bridge_name(pif)
1103     ipdev = ipdev_name(pif)
1104
1105
1106     bond_slaves = get_bond_slaves_of_pif(pif)
1107     log("bond slaves of %s - %s" % (rec['device'], [interface_name(s) for s in bond_slaves]))
1108     for slave in bond_slaves:
1109         slave_interface = interface_name(slave)
1110         log("bring down bond slave %s" % slave_interface)
1111         argv += interface_deconfigure_commands(slave_interface)
1112         down_netdev(slave_interface)
1113
1114     argv += interface_deconfigure_commands(ipdev)
1115     down_netdev(ipdev)
1116
1117     argv += ['--del-match', 'bridge.%s.*' % datapath_name(pif)]
1118     argv += ['--del-match', 'bonding.%s.[!0-9]*' % interface]
1119     modify_config(argv)
1120
1121 def action_rewrite(pif):
1122     # Support "rpm -e vswitch" gracefully by keeping Centos configuration
1123     # files up-to-date, even though we don't use them or need them.
1124     pifrec = db.get_pif_record(pif)
1125     f = configure_pif(pif)
1126     interface = interface_name(pif)
1127     bridge = bridge_name(pif)
1128     mode = pifrec['ip_configuration_mode']
1129     if bridge:
1130         log("Configuring %s using %s configuration" % (bridge, mode))
1131         br = open_network_ifcfg(pif)
1132         configure_network(pif, br)
1133         br.close()
1134         f.attach_child(br)
1135     else:
1136         log("Configuring %s using %s configuration" % (interface, mode))
1137         configure_network(pif, f)
1138     f.close()
1139     try:
1140         f.apply()
1141         f.commit()
1142     except Error, e:
1143         log("failed to apply changes: %s" % e.msg)
1144         f.revert()
1145         raise
1146
1147     # We have no code of our own to run here.
1148     pass
1149
1150 def main(argv=None):
1151     global output_directory, management_pif
1152
1153     session = None
1154     pif_uuid = None
1155     pif = None
1156
1157     force_interface = None
1158     force_management = False
1159
1160     if argv is None:
1161         argv = sys.argv
1162
1163     try:
1164         try:
1165             shortops = "h"
1166             longops = [ "output-directory=",
1167                         "pif=", "pif-uuid=",
1168                         "session=",
1169                         "force=",
1170                         "force-interface=",
1171                         "management",
1172                         "test-mode",
1173                         "device=", "mode=", "ip=", "netmask=", "gateway=",
1174                         "help" ]
1175             arglist, args = getopt.gnu_getopt(argv[1:], shortops, longops)
1176         except getopt.GetoptError, msg:
1177             raise Usage(msg)
1178
1179         force_rewrite_config = {}
1180
1181         for o,a in arglist:
1182             if o == "--output-directory":
1183                 output_directory = a
1184             elif o == "--pif":
1185                 pif = a
1186             elif o == "--pif-uuid":
1187                 pif_uuid = a
1188             elif o == "--session":
1189                 session = a
1190             elif o == "--force-interface" or o == "--force":
1191                 force_interface = a
1192             elif o == "--management":
1193                 force_management = True
1194             elif o in ["--device", "--mode", "--ip", "--netmask", "--gateway"]:
1195                 force_rewrite_config[o[2:]] = a
1196             elif o == "-h" or o == "--help":
1197                 print __doc__ % {'command-name': os.path.basename(argv[0])}
1198                 return 0
1199
1200         if not debug_mode():
1201             syslog.openlog(os.path.basename(argv[0]))
1202             log("Called as " + str.join(" ", argv))
1203         if len(args) < 1:
1204             raise Usage("Required option <action> not present")
1205         if len(args) > 1:
1206             raise Usage("Too many arguments")
1207
1208         action = args[0]
1209         # backwards compatibility
1210         if action == "rewrite-configuration": action = "rewrite"
1211
1212         if output_directory and ( session or pif ):
1213             raise Usage("--session/--pif cannot be used with --output-directory")
1214         if ( session or pif ) and pif_uuid:
1215             raise Usage("--session/--pif and --pif-uuid are mutually exclusive.")
1216         if ( session and not pif ) or ( not session and pif ):
1217             raise Usage("--session and --pif must be used together.")
1218         if force_interface and ( session or pif or pif_uuid ):
1219             raise Usage("--force is mutually exclusive with --session, --pif and --pif-uuid")
1220         if len(force_rewrite_config) and not (force_interface and action == "rewrite"):
1221             raise Usage("\"--force rewrite\" needed for --device, --mode, --ip, --netmask, and --gateway")
1222
1223         global db
1224         if force_interface:
1225             log("Force interface %s %s" % (force_interface, action))
1226
1227             if action == "rewrite":
1228                 action_force_rewrite(force_interface, force_rewrite_config)
1229             else:
1230                 db = DatabaseCache(cache_file=dbcache_file)
1231                 host = db.extras['host']
1232                 pif = db.get_pif_by_bridge(host, force_interface)
1233                 management_pif = db.get_management_pif(host)
1234
1235                 if action == "up":
1236                     action_up(pif)
1237                 elif action == "down":
1238                     action_down(pif)
1239                 else:
1240                     raise Usage("Unknown action %s"  % action)
1241         else:
1242             db = DatabaseCache(session_ref=session)
1243
1244             if pif_uuid:
1245                 pif = db.get_pif_by_uuid(pif_uuid)
1246
1247             if not pif:
1248                 raise Usage("No PIF given")
1249
1250             if force_management:
1251                 # pif is going to be the management pif
1252                 management_pif = pif
1253             else:
1254                 # pif is not going to be the management pif.
1255                 # Search DB cache for pif on same host with management=true
1256                 pifrec = db.get_pif_record(pif)
1257                 host = pifrec['host']
1258                 management_pif = db.get_management_pif(host)
1259
1260             log_pif_action(action, pif)
1261
1262             if not check_allowed(pif):
1263                 return 0
1264
1265             if action == "up":
1266                 action_up(pif)
1267             elif action == "down":
1268                 action_down(pif)
1269             elif action == "rewrite":
1270                 action_rewrite(pif)
1271             else:
1272                 raise Usage("Unknown action %s"  % action)
1273
1274             # Save cache.
1275             pifrec = db.get_pif_record(pif)
1276             db.save(dbcache_file, {'host': pifrec['host']})
1277
1278     except Usage, err:
1279         print >>sys.stderr, err.msg
1280         print >>sys.stderr, "For help use --help."
1281         return 2
1282     except Error, err:
1283         log(err.msg)
1284         return 1
1285
1286     return 0
1287 \f
1288 # The following code allows interface-reconfigure to keep Centos
1289 # network configuration files up-to-date, even though the vswitch
1290 # never uses them.  In turn, that means that "rpm -e vswitch" does not
1291 # have to update any configuration files.
1292
1293 def configure_ethtool(oc, f):
1294     # Options for "ethtool -s"
1295     settings = None
1296     setting_opts = ["autoneg", "speed", "duplex"]
1297     # Options for "ethtool -K"
1298     offload = None
1299     offload_opts = ["rx", "tx", "sg", "tso", "ufo", "gso"]
1300
1301     for opt in [opt for opt in setting_opts + offload_opts if oc.has_key("ethtool-" + opt)]:
1302         val = oc["ethtool-" + opt]
1303
1304         if opt in ["speed"]:
1305             if val in ["10", "100", "1000"]:
1306                 val = "speed " + val
1307             else:
1308                 log("Invalid value for ethtool-speed = %s. Must be 10|100|1000." % val)
1309                 val = None
1310         elif opt in ["duplex"]:
1311             if val in ["half", "full"]:
1312                 val = "duplex " + val
1313             else:
1314                 log("Invalid value for ethtool-duplex = %s. Must be half|full." % val)
1315                 val = None
1316         elif opt in ["autoneg"] + offload_opts:
1317             if val in ["true", "on"]:
1318                 val = opt + " on"
1319             elif val in ["false", "off"]:
1320                 val = opt + " off"
1321             else:
1322                 log("Invalid value for ethtool-%s = %s. Must be on|true|off|false." % (opt, val))
1323                 val = None
1324
1325         if opt in setting_opts:
1326             if val and settings:
1327                 settings = settings + " " + val
1328             else:
1329                 settings = val
1330         elif opt in offload_opts:
1331             if val and offload:
1332                 offload = offload + " " + val
1333             else:
1334                 offload = val
1335
1336     if settings:
1337         f.write("ETHTOOL_OPTS=\"%s\"\n" % settings)
1338     if offload:
1339         f.write("ETHTOOL_OFFLOAD_OPTS=\"%s\"\n" % offload)
1340
1341 def configure_mtu(oc, f):
1342     if not oc.has_key('mtu'):
1343         return
1344
1345     try:
1346         mtu = int(oc['mtu'])
1347         f.write("MTU=%d\n" % mtu)
1348     except ValueError, x:
1349         log("Invalid value for mtu = %s" % mtu)
1350
1351 def configure_static_routes(interface, oc, f):
1352     """Open a route-<interface> file for static routes.
1353
1354     Opens the static routes configuration file for interface and writes one
1355     line for each route specified in the network's other config "static-routes" value.
1356     E.g. if
1357            interface ( RO): xenbr1
1358            other-config (MRW): static-routes: 172.16.0.0/15/192.168.0.3,172.18.0.0/16/192.168.0.4;...
1359
1360     Then route-xenbr1 should be
1361           172.16.0.0/15 via 192.168.0.3 dev xenbr1
1362           172.18.0.0/16 via 192.168.0.4 dev xenbr1
1363     """
1364     fname = "route-%s" % interface
1365     if oc.has_key('static-routes'):
1366         # The key is present - extract comma seperates entries
1367         lines = oc['static-routes'].split(',')
1368     else:
1369         # The key is not present, i.e. there are no static routes
1370         lines = []
1371
1372     child = ConfigurationFile(fname)
1373     child.write("# DO NOT EDIT: This file (%s) was autogenerated by %s\n" % \
1374             (os.path.basename(child.path()), os.path.basename(sys.argv[0])))
1375
1376     try:
1377         for l in lines:
1378             network, masklen, gateway = l.split('/')
1379             child.write("%s/%s via %s dev %s\n" % (network, masklen, gateway, interface))
1380
1381         f.attach_child(child)
1382         child.close()
1383
1384     except ValueError, e:
1385         log("Error in other-config['static-routes'] format for network %s: %s" % (interface, e))
1386
1387 def __open_ifcfg(interface):
1388     """Open a network interface configuration file.
1389
1390     Opens the configuration file for interface, writes a header and
1391     common options and returns the file object.
1392     """
1393     fname = "ifcfg-%s" % interface
1394     f = ConfigurationFile(fname)
1395
1396     f.write("# DO NOT EDIT: This file (%s) was autogenerated by %s\n" % \
1397             (os.path.basename(f.path()), os.path.basename(sys.argv[0])))
1398     f.write("XEMANAGED=yes\n")
1399     f.write("DEVICE=%s\n" % interface)
1400     f.write("ONBOOT=no\n")
1401
1402     return f
1403
1404 def open_network_ifcfg(pif):
1405     bridge = bridge_name(pif)
1406     interface = interface_name(pif)
1407     if bridge:
1408         return __open_ifcfg(bridge)
1409     else:
1410         return __open_ifcfg(interface)
1411
1412
1413 def open_pif_ifcfg(pif):
1414     pifrec = db.get_pif_record(pif)
1415
1416     log("Configuring %s (%s)" % (interface_name(pif), pifrec['MAC']))
1417
1418     f = __open_ifcfg(interface_name(pif))
1419
1420     if pifrec.has_key('other_config'):
1421         configure_ethtool(pifrec['other_config'], f)
1422         configure_mtu(pifrec['other_config'], f)
1423
1424     return f
1425
1426 def configure_network(pif, f):
1427     """Write the configuration file for a network.
1428
1429     Writes configuration derived from the network object into the relevant
1430     ifcfg file.  The configuration file is passed in, but if the network is
1431     bridgeless it will be ifcfg-<interface>, otherwise it will be ifcfg-<bridge>.
1432
1433     This routine may also write ifcfg files of the networks corresponding to other PIFs
1434     in order to maintain consistency.
1435
1436     params:
1437         pif:  Opaque_ref of pif
1438         f :   ConfigurationFile(/path/to/ifcfg) to which we append network configuration
1439     """
1440
1441     pifrec = db.get_pif_record(pif)
1442     host = pifrec['host']
1443     nw = pifrec['network']
1444     nwrec = db.get_network_record(nw)
1445     oc = None
1446     bridge = bridge_name(pif)
1447     interface = interface_name(pif)
1448     if bridge:
1449         device = bridge
1450     else:
1451         device = interface
1452
1453     if nwrec.has_key('other_config'):
1454         configure_ethtool(nwrec['other_config'], f)
1455         configure_mtu(nwrec['other_config'], f)
1456         configure_static_routes(device, nwrec['other_config'], f)
1457
1458
1459     if pifrec.has_key('other_config'):
1460         oc = pifrec['other_config']
1461
1462     if device == bridge:
1463         f.write("TYPE=Bridge\n")
1464         f.write("DELAY=0\n")
1465         f.write("STP=off\n")
1466         f.write("PIFDEV=%s\n" % interface_name(pif))
1467
1468     if pifrec['ip_configuration_mode'] == "DHCP":
1469         f.write("BOOTPROTO=dhcp\n")
1470         f.write("PERSISTENT_DHCLIENT=yes\n")
1471     elif pifrec['ip_configuration_mode'] == "Static":
1472         f.write("BOOTPROTO=none\n")
1473         f.write("NETMASK=%(netmask)s\n" % pifrec)
1474         f.write("IPADDR=%(IP)s\n" % pifrec)
1475         f.write("GATEWAY=%(gateway)s\n" % pifrec)
1476     elif pifrec['ip_configuration_mode'] == "None":
1477         f.write("BOOTPROTO=none\n")
1478     else:
1479         raise Error("Unknown ip-configuration-mode %s" % pifrec['ip_configuration_mode'])
1480
1481     if pifrec.has_key('DNS') and pifrec['DNS'] != "":
1482         ServerList = pifrec['DNS'].split(",")
1483         for i in range(len(ServerList)): f.write("DNS%d=%s\n" % (i+1, ServerList[i]))
1484     if oc and oc.has_key('domain'):
1485         f.write("DOMAIN='%s'\n" % oc['domain'].replace(',', ' '))
1486
1487     # We only allow one ifcfg-xenbr* to have PEERDNS=yes and there can be only one GATEWAYDEV in /etc/sysconfig/network.
1488     # The peerdns pif will be the one with pif::other-config:peerdns=true, or the mgmt pif if none have this set.
1489     # The gateway pif will be the one with pif::other-config:defaultroute=true, or the mgmt pif if none have this set.
1490
1491     # Work out which pif on this host should be the one with PEERDNS=yes and which should be the GATEWAYDEV
1492     #
1493     # Note: we prune out the bond master pif (if it exists).
1494     # This is because when we are called to bring up an interface with a bond master, it is implicit that
1495     # we should bring down that master.
1496     pifs_on_host = [ __pif for __pif in db.get_all_pifs() if
1497                      db.get_pif_record(__pif)['host'] == host and
1498                      (not  __pif in get_bond_masters_of_pif(pif)) ]
1499     other_pifs_on_host = [ __pif for __pif in pifs_on_host if __pif != pif ]
1500
1501     peerdns_pif = None
1502     defaultroute_pif = None
1503
1504     # loop through all the pifs on this host looking for one with
1505     #   other-config:peerdns = true, and one with
1506     #   other-config:default-route=true
1507     for __pif in pifs_on_host:
1508         __pifrec = db.get_pif_record(__pif)
1509         __oc = __pifrec['other_config']
1510         if __oc.has_key('peerdns') and __oc['peerdns'] == 'true':
1511             if peerdns_pif == None:
1512                 peerdns_pif = __pif
1513             else:
1514                 log('Warning: multiple pifs with "peerdns=true" - choosing %s and ignoring %s' % \
1515                         (db.get_pif_record(peerdns_pif)['device'], __pifrec['device']))
1516         if __oc.has_key('defaultroute') and __oc['defaultroute'] == 'true':
1517             if defaultroute_pif == None:
1518                 defaultroute_pif = __pif
1519             else:
1520                 log('Warning: multiple pifs with "defaultroute=true" - choosing %s and ignoring %s' % \
1521                         (db.get_pif_record(defaultroute_pif)['device'], __pifrec['device']))
1522
1523     # If no pif is explicitly specified then use the mgmt pif for peerdns/defaultroute
1524     if peerdns_pif == None:
1525         peerdns_pif = management_pif
1526     if defaultroute_pif == None:
1527         defaultroute_pif = management_pif
1528
1529     # Update all the other network's ifcfg files and ensure consistency
1530     for __pif in other_pifs_on_host:
1531         __f = open_network_ifcfg(__pif)
1532         peerdns_line_wanted = 'PEERDNS=%s\n' % ((__pif == peerdns_pif) and 'yes' or 'no')
1533         lines =  __f.readlines()
1534
1535         if not peerdns_line_wanted in lines:
1536             # the PIF selected for DNS has changed and as a result this ifcfg file needs rewriting
1537             for line in lines:
1538                 if not line.lstrip().startswith('PEERDNS'):
1539                     __f.write(line)
1540             log("Setting %s in %s" % (peerdns_line_wanted.strip(), __f.path()))
1541             __f.write(peerdns_line_wanted)
1542             __f.close()
1543             f.attach_child(__f)
1544
1545         else:
1546             # There is no need to change this ifcfg file.  So don't attach_child.
1547             pass
1548
1549     # ... and for this pif too
1550     f.write('PEERDNS=%s\n' % ((pif == peerdns_pif) and 'yes' or 'no'))
1551
1552     # Update gatewaydev
1553     fnetwork = ConfigurationFile("network", "/etc/sysconfig")
1554     for line in fnetwork.readlines():
1555         if line.lstrip().startswith('GATEWAY') :
1556             continue
1557         fnetwork.write(line)
1558     if defaultroute_pif:
1559         gatewaydev = bridge_name(defaultroute_pif)
1560         if not gatewaydev:
1561             gatewaydev = interface_name(defaultroute_pif)
1562         fnetwork.write('GATEWAYDEV=%s\n' % gatewaydev)
1563     fnetwork.close()
1564     f.attach_child(fnetwork)
1565
1566     return
1567
1568
1569 def configure_physical_interface(pif):
1570     """Write the configuration for a physical interface.
1571
1572     Writes the configuration file for the physical interface described by
1573     the pif object.
1574
1575     Returns the open file handle for the interface configuration file.
1576     """
1577
1578     pifrec = db.get_pif_record(pif)
1579
1580     f = open_pif_ifcfg(pif)
1581
1582     f.write("TYPE=Ethernet\n")
1583     f.write("HWADDR=%(MAC)s\n" % pifrec)
1584
1585     return f
1586
1587 def configure_bond_interface(pif):
1588     """Write the configuration for a bond interface.
1589
1590     Writes the configuration file for the bond interface described by
1591     the pif object. Handles writing the configuration for the slave
1592     interfaces.
1593
1594     Returns the open file handle for the bond interface configuration
1595     file.
1596     """
1597
1598     pifrec = db.get_pif_record(pif)
1599     oc = pifrec['other_config']
1600     f = open_pif_ifcfg(pif)
1601
1602     if pifrec['MAC'] != "":
1603         f.write("MACADDR=%s\n" % pifrec['MAC'])
1604
1605     for slave in get_bond_slaves_of_pif(pif):
1606         s = configure_physical_interface(slave)
1607         s.write("MASTER=%(device)s\n" % pifrec)
1608         s.write("SLAVE=yes\n")
1609         s.close()
1610         f.attach_child(s)
1611
1612     # The bond option defaults
1613     bond_options = {
1614         "mode":   "balance-slb",
1615         "miimon": "100",
1616         "downdelay": "200",
1617         "updelay": "31000",
1618         "use_carrier": "1",
1619         }
1620
1621     # override defaults with values from other-config whose keys being with "bond-"
1622     overrides = filter(lambda (key,val): key.startswith("bond-"), oc.items())
1623     overrides = map(lambda (key,val): (key[5:], val), overrides)
1624     bond_options.update(overrides)
1625
1626     # write the bond options to ifcfg-bondX
1627     f.write('BONDING_OPTS="')
1628     for (name,val) in bond_options.items():
1629         f.write("%s=%s " % (name,val))
1630     f.write('"\n')
1631     return f
1632
1633 def configure_vlan_interface(pif):
1634     """Write the configuration for a VLAN interface.
1635
1636     Writes the configuration file for the VLAN interface described by
1637     the pif object. Handles writing the configuration for the master
1638     interface if necessary.
1639
1640     Returns the open file handle for the VLAN interface configuration
1641     file.
1642     """
1643
1644     slave = configure_pif(get_vlan_slave_of_pif(pif))
1645     slave.close()
1646
1647     f = open_pif_ifcfg(pif)
1648     f.write("VLAN=yes\n")
1649     f.attach_child(slave)
1650
1651     return f
1652
1653 def configure_pif(pif):
1654     """Write the configuration for a PIF object.
1655
1656     Writes the configuration file the PIF and all dependent
1657     interfaces (bond slaves and VLAN masters etc).
1658
1659     Returns the open file handle for the interface configuration file.
1660     """
1661
1662     pifrec = db.get_pif_record(pif)
1663
1664     if pifrec['VLAN'] != '-1':
1665         f = configure_vlan_interface(pif)
1666     elif len(pifrec['bond_master_of']) != 0:
1667         f = configure_bond_interface(pif)
1668     else:
1669         f = configure_physical_interface(pif)
1670
1671     bridge = bridge_name(pif)
1672     if bridge:
1673         f.write("BRIDGE=%s\n" % bridge)
1674
1675     return f
1676
1677 def unconfigure_pif(pif):
1678     """Clear up the files created by configure_pif"""
1679     f = open_pif_ifcfg(pif)
1680     log("Unlinking stale file %s" % f.path())
1681     f.unlink()
1682     return f
1683 \f
1684 if __name__ == "__main__":
1685     rc = 1
1686     try:
1687         rc = main()
1688     except:
1689         ex = sys.exc_info()
1690         err = traceback.format_exception(*ex)
1691         for exline in err:
1692             log(exline)
1693
1694     if not debug_mode():
1695         syslog.closelog()
1696
1697     sys.exit(rc)