PLC/NodeNetworks.py

   1 #
   2 # Functions for interacting with the nodenetworks table in the database
   3 #
   4 # Mark Huang <mlhuang@cs.princeton.edu>
   5 # Copyright (C) 2006 The Trustees of Princeton University
   6 #
   7 # $Id: NodeNetworks.py,v 1.3 2006/09/19 19:35:05 mlhuang Exp $
   8 #
   9
  10 from types import StringTypes
  11 import socket
  12 import struct
  13
  14 from PLC.Faults import *
  15 from PLC.Parameter import Parameter
  16 from PLC.Debug import profile
  17 from PLC.Table import Row, Table
  18 import PLC.Nodes
  19
  20 def in_same_network(address1, address2, netmask):
  21     """
  22     Returns True if two IPv4 addresses are in the same network. Faults
  23     if an address is invalid.
  24     """
  25
  26     address1 = struct.unpack('>L', socket.inet_aton(address1))[0]
  27     address2 = struct.unpack('>L', socket.inet_aton(address2))[0]
  28     netmask = struct.unpack('>L', socket.inet_aton(netmask))[0]
  29
  30     return (address1 & netmask) == (address2 & netmask)
  31
  32 class NodeNetwork(Row):
  33     """
  34     Representation of a row in the nodenetworks table. To use, optionally
  35     instantiate with a dict of values. Update as you would a
  36     dict. Commit to the database with sync().
  37     """
  38
  39     fields = {
  40         'nodenetwork_id': Parameter(int, "Node interface identifier"),
  41         'method': Parameter(str, "Addressing method (e.g., 'static' or 'dhcp')"),
  42         'type': Parameter(str, "Address type (e.g., 'ipv4')"),
  43         'ip': Parameter(str, "IP address"),
  44         'mac': Parameter(str, "MAC address"),
  45         'gateway': Parameter(str, "IP address of primary gateway"),
  46         'network': Parameter(str, "Subnet address"),
  47         'broadcast': Parameter(str, "Network broadcast address"),
  48         'netmask': Parameter(str, "Subnet mask"),
  49         'dns1': Parameter(str, "IP address of primary DNS server"),
  50         'dns2': Parameter(str, "IP address of secondary DNS server"),
  51         # XXX Should be an int (bps)
  52         'bwlimit': Parameter(str, "Bandwidth limit"),
  53         'hostname': Parameter(str, "(Optional) Hostname"),
  54         'node_id': Parameter(int, "Node associated with this interface (if any)"),
  55         'is_primary': Parameter(bool, "Is the primary interface for this node"),
  56         }
  57
  58     methods = ['static', 'dhcp', 'proxy', 'tap', 'ipmi', 'unknown']
  59
  60     types = ['ipv4']
  61
  62     bwlimits = ['-1',
  63                 '100kbit', '250kbit', '500kbit',
  64                 '1mbit', '2mbit', '5mbit',
  65                 '10mbit', '20mbit', '50mbit',
  66                 '100mbit']
  67
  68     def __init__(self, api, fields):
  69         Row.__init__(self, fields)
  70         self.api = api
  71
  72     def validate_method(self, method):
  73         if method not in self.methods:
  74             raise PLCInvalidArgument, "Invalid addressing method"
  75         return method
  76
  77     def validate_type(self, type):
  78         if type not in self.types:
  79             raise PLCInvalidArgument, "Invalid address type"
  80         return type
  81
  82     def validate_ip(self, ip):
  83         if ip:
  84             try:
  85                 ip = socket.inet_ntoa(socket.inet_aton(ip))
  86             except socket.error:
  87                 raise PLCInvalidArgument, "Invalid IP address " + ip
  88
  89         return ip
  90
  91     def validate_mac(self, mac):
  92         try:
  93             bytes = mac.split(":")
  94             if len(bytes) < 6:
  95                 raise Exception
  96             for i, byte in enumerate(bytes):
  97                 byte = int(byte, 16)
  98                 if byte < 0 or byte > 255:
  99                     raise Exception
 100                 bytes[i] = "%02x" % byte
 101             mac = ":".join(bytes)
 102         except:
 103             raise PLCInvalidArgument, "Invalid MAC address"
 104
 105         return mac
 106
 107     validate_gateway = validate_ip
 108     validate_network = validate_ip
 109     validate_broadcast = validate_ip
 110     validate_netmask = validate_ip
 111     validate_dns1 = validate_ip
 112     validate_dns2 = validate_ip
 113
 114     def validate_bwlimit(self, bwlimit):
 115         if bwlimit not in self.bwlimits:
 116             raise PLCInvalidArgument, "Invalid bandwidth limit"
 117         return bwlimit
 118
 119     def validate_hostname(self, hostname):
 120         # Optional
 121         if not hostname:
 122             return hostname
 123
 124         # Validate hostname, and check for conflicts with a node hostname
 125         return PLC.Nodes.Node.validate_hostname(self, hostname)
 126
 127     def sync(self, commit = True):
 128         """
 129         Flush changes back to the database.
 130         """
 131
 132         # Validate all specified fields
 133         self.validate()
 134
 135         try:
 136             method = self['method']
 137             self['type']
 138         except KeyError:
 139             raise PLCInvalidArgument, "method and type must both be specified"
 140
 141         if method == "proxy" or method == "tap":
 142             if 'mac' in self and self['mac']:
 143                 raise PLCInvalidArgument, "For %s method, mac should not be specified" % method
 144             if 'ip' not in self or not self['ip']:
 145                 raise PLCInvalidArgument, "For %s method, ip is required" % method
 146             if method == "tap" and ('gateway' not in self or not self['gateway']):
 147                 raise PLCInvalidArgument, "For tap method, gateway is required and should be " \
 148                       "the IP address of the node that proxies for this address"
 149             # Should check that the proxy address is reachable, but
 150             # there's no way to tell if the only primary interface is
 151             # DHCP!
 152
 153         elif method == "static":
 154             for key in ['ip', 'gateway', 'network', 'broadcast', 'netmask', 'dns1']:
 155                 if key not in self or not self[key]:
 156                     raise PLCInvalidArgument, "For static method, %s is required" % key
 157                 globals()[key] = self[key]
 158             if not in_same_network(ip, network, netmask):
 159                 raise PLCInvalidArgument, "IP address %s is inconsistent with network %s/%s" % \
 160                       (ip, network, netmask)
 161             if not in_same_network(broadcast, network, netmask):
 162                 raise PLCInvalidArgument, "Broadcast address %s is inconsistent with network %s/%s" % \
 163                       (broadcast, network, netmask)
 164             if not in_same_network(ip, gateway, netmask):
 165                 raise PLCInvalidArgument, "Gateway %s is not reachable from %s/%s" % \
 166                       (gateway, ip, netmask)
 167
 168         elif method == "ipmi":
 169             if 'ip' not in self or not self['ip']:
 170                 raise PLCInvalidArgument, "For ipmi method, ip is required"
 171
 172         # Fetch a new nodenetwork_id if necessary
 173         if 'nodenetwork_id' not in self:
 174             rows = self.api.db.selectall("SELECT NEXTVAL('nodenetworks_nodenetwork_id_seq') AS nodenetwork_id")
 175             if not rows:
 176                 raise PLCDBError("Unable to fetch new nodenetwork_id")
 177             self['nodenetwork_id'] = rows[0]['nodenetwork_id']
 178             insert = True
 179         else:
 180             insert = False
 181
 182         # Filter out fields that cannot be set or updated directly
 183         nodenetworks_fields = self.api.db.fields('nodenetworks')
 184         fields = dict(filter(lambda (key, value): key in nodenetworks_fields,
 185                              self.items()))
 186
 187         # Parameterize for safety
 188         keys = fields.keys()
 189         values = [self.api.db.param(key, value) for (key, value) in fields.items()]
 190
 191         if insert:
 192             # Insert new row in nodenetworks table
 193             sql = "INSERT INTO nodenetworks (%s) VALUES (%s)" % \
 194                   (", ".join(keys), ", ".join(values))
 195         else:
 196             # Update existing row in sites table
 197             columns = ["%s = %s" % (key, value) for (key, value) in zip(keys, values)]
 198             sql = "UPDATE nodenetworks SET " + \
 199                   ", ".join(columns) + \
 200                   " WHERE nodenetwork_id = %(nodenetwork_id)d"
 201
 202         self.api.db.do(sql, fields)
 203
 204         if commit:
 205             self.api.db.commit()
 206
 207     def delete(self, commit = True):
 208         """
 209         Delete existing nodenetwork.
 210         """
 211
 212         assert 'nodenetwork_id' in self
 213
 214         # Delete ourself
 215         self.api.db.do("DELETE FROM nodenetworks" \
 216                        " WHERE nodenetwork_id = %d" % \
 217                        self['nodenetwork_id'])
 218
 219         if commit:
 220             self.api.db.commit()
 221
 222 class NodeNetworks(Table):
 223     """
 224     Representation of row(s) from the nodenetworks table in the
 225     database.
 226     """
 227
 228     def __init__(self, api, nodenetwork_id_or_hostname_list = None):
 229         self.api = api
 230
 231         # N.B.: Node IDs returned may be deleted.
 232         sql = "SELECT * FROM nodenetworks"
 233
 234         if nodenetwork_id_or_hostname_list:
 235             # Separate the list into integers and strings
 236             nodenetwork_ids = filter(lambda nodenetwork_id: isinstance(nodenetwork_id, (int, long)),
 237                                      nodenetwork_id_or_hostname_list)
 238             hostnames = filter(lambda hostname: isinstance(hostname, StringTypes),
 239                                nodenetwork_id_or_hostname_list)
 240             sql += " WHERE (False"
 241             if nodenetwork_ids:
 242                 sql += " OR nodenetwork_id IN (%s)" % ", ".join(map(str, nodenetwork_ids))
 243             if hostnames:
 244                 sql += " OR hostname IN (%s)" % ", ".join(api.db.quote(hostnames)).lower()
 245             sql += ")"
 246
 247         rows = self.api.db.selectall(sql)
 248
 249         for row in rows:
 250             self[row['nodenetwork_id']] = NodeNetwork(api, row)