src/nepi/testbeds/planetlab/node.py

   1 #!/usr/bin/env python
   2 # -*- coding: utf-8 -*-
   3
   4 from constants import TESTBED_ID
   5 import plcapi
   6 import operator
   7 import rspawn
   8 import time
   9 import os
  10
  11 class Node(object):
  12     BASEFILTERS = {
  13         # Map Node attribute to plcapi filter name
  14         'hostname' : 'hostname',
  15     }
  16
  17     TAGFILTERS = {
  18         # Map Node attribute to (<tag name>, <plcapi filter expression>)
  19         #   There are replacements that are applied with string formatting,
  20         #   so '%' has to be escaped as '%%'.
  21         'architecture' : ('arch','value'),
  22         'operating_system' : ('fcdistro','value'),
  23         'pl_distro' : ('pldistro','value'),
  24         'min_reliability' : ('reliability%(timeframe)s', ']value'),
  25         'max_reliability' : ('reliability%(timeframe)s', '[value'),
  26         'min_bandwidth' : ('bw%(timeframe)s', ']value'),
  27         'max_bandwidth' : ('bw%(timeframe)s', '[value'),
  28     }
  29
  30     def __init__(self, api=None):
  31         if not api:
  32             api = plcapi.PLCAPI()
  33         self._api = api
  34
  35         # Attributes
  36         self.hostname = None
  37         self.architecture = None
  38         self.operating_system = None
  39         self.pl_distro = None
  40         self.site = None
  41         self.emulation = None
  42         self.min_reliability = None
  43         self.max_reliability = None
  44         self.min_bandwidth = None
  45         self.max_bandwidth = None
  46         self.min_num_external_ifaces = None
  47         self.max_num_external_ifaces = None
  48         self.timeframe = 'm'
  49
  50         # Applications add requirements to connected nodes
  51         self.required_packages = set()
  52
  53         # Testbed-derived attributes
  54         self.slicename = None
  55         self.ident_path = None
  56         self.home_path = None
  57
  58         # Those are filled when an actual node is allocated
  59         self._node_id = None
  60
  61     def build_filters(self, target_filters, filter_map):
  62         for attr, tag in filter_map.iteritems():
  63             value = getattr(self, attr, None)
  64             if value is not None:
  65                 target_filters[tag] = value
  66         return target_filters
  67
  68     @property
  69     def applicable_filters(self):
  70         has = lambda att : getattr(self,att,None) is not None
  71         return (
  72             filter(has, self.BASEFILTERS.iterkeys())
  73             + filter(has, self.TAGFILTERS.iterkeys())
  74         )
  75
  76     def find_candidates(self, filter_slice_id=None):
  77         fields = ('node_id',)
  78         replacements = {'timeframe':self.timeframe}
  79
  80         # get initial candidates (no tag filters)
  81         basefilters = self.build_filters({}, self.BASEFILTERS)
  82         if filter_slice_id:
  83             basefilters['|slice_ids'] = (filter_slice_id,)
  84
  85         # keyword-only "pseudofilters"
  86         extra = {}
  87         if self.site:
  88             extra['peer'] = self.site
  89
  90         candidates = set(map(operator.itemgetter('node_id'),
  91             self._api.GetNodes(filters=basefilters, fields=fields, **extra)))
  92
  93         # filter by tag, one tag at a time
  94         applicable = self.applicable_filters
  95         for tagfilter in self.TAGFILTERS.iteritems():
  96             attr, (tagname, expr) = tagfilter
  97
  98             # don't bother if there's no filter defined
  99             if attr in applicable:
 100                 tagfilter = basefilters.copy()
 101                 tagfilter['tagname'] = tagname % replacements
 102                 tagfilter[expr % replacements] = getattr(self,attr)
 103                 tagfilter['node_id'] = list(candidates)
 104
 105                 candidates &= set(map(operator.itemgetter('node_id'),
 106                     self._api.GetNodeTags(filters=tagfilter, fields=fields)))
 107
 108         # filter by iface count
 109         if self.min_num_external_ifaces is not None or self.max_num_external_ifaces is not None:
 110             # fetch interfaces for all, in one go
 111             filters = basefilters.copy()
 112             filters['node_id'] = list(candidates)
 113             ifaces = dict(map(operator.itemgetter('node_id','interface_ids'),
 114                 self._api.GetNodes(filters=basefilters, fields=('node_id','interface_ids')) ))
 115
 116             # filter candidates by interface count
 117             if self.min_num_external_ifaces is not None and self.max_num_external_ifaces is not None:
 118                 predicate = ( lambda node_id :
 119                     self.min_num_external_ifaces <= len(ifaces.get(node_id,())) <= self.max_num_external_ifaces )
 120             elif self.min_num_external_ifaces is not None:
 121                 predicate = ( lambda node_id :
 122                     self.min_num_external_ifaces <= len(ifaces.get(node_id,())) )
 123             else:
 124                 predicate = ( lambda node_id :
 125                     len(ifaces.get(node_id,())) <= self.max_num_external_ifaces )
 126
 127             candidates = set(filter(predicate, candidates))
 128
 129         return candidates
 130
 131     def assign_node_id(self, node_id):
 132         self._node_id = node_id
 133         self.fetch_node_info()
 134
 135     def fetch_node_info(self):
 136         info = self._api.GetNodes(self._node_id)
 137         tags = dict( (t['tagname'],t['value'])
 138                      for t in self._api.GetNodeTags(node_id=self._node_id, fields=('tagname','value')) )
 139
 140         self.min_num_external_ifaces = None
 141         self.max_num_external_ifaces = None
 142         self.timeframe = 'm'
 143
 144         replacements = {'timeframe':self.timeframe}
 145         for attr, tag in self.BASEFILTERS.iteritems():
 146             if tag in info:
 147                 value = info[tag]
 148                 setattr(self, attr, value)
 149         for attr, (tag,_) in self.TAGFILTERS.iteritems():
 150             tag = tag % replacements
 151             if tag in tags:
 152                 value = tags[tag]
 153                 setattr(self, attr, value)
 154
 155         if 'peer_id' in info:
 156             self.site = self._api.peer_map[info['peer_id']]
 157
 158         if 'interface_ids' in info:
 159             self.min_num_external_ifaces = \
 160             self.max_num_external_ifaces = len(info['interface_ids'])
 161
 162     def validate(self):
 163         if self.home_path is None:
 164             raise AssertionError, "Misconfigured node: missing home path"
 165         if self.ident_path is None or not os.access(self.ident_path, os.R_OK):
 166             raise AssertionError, "Misconfigured node: missing slice SSH key"
 167         if self.slicename is None:
 168             raise AssertionError, "Misconfigured node: unspecified slice"
 169
 170     def install_dependencies(self):
 171         if self.required_packages:
 172             # TODO: make dependant on the experiment somehow...
 173             pidfile = '/tmp/nepi-depends.pid'
 174             logfile = '/tmp/nepi-depends.log'
 175
 176             # Start process in a "daemonized" way, using nohup and heavy
 177             # stdin/out redirection to avoid connection issues
 178             (out,err),proc = rspawn.remote_spawn(
 179                 "yum -y install %(packages)s" % {
 180                     'packages' : ' '.join(self.required_packages),
 181                 },
 182                 pidfile = pidfile,
 183                 stdout = logfile,
 184                 stderr = rspawn.STDOUT,
 185
 186                 host = self.hostname,
 187                 port = None,
 188                 user = self.slicename,
 189                 agent = None,
 190                 ident_key = self.ident_path,
 191                 sudo = True
 192                 )
 193
 194             if proc.wait():
 195                 raise RuntimeError, "Failed to set up application: %s %s" % (out,err,)
 196
 197     def wait_dependencies(self, pidprobe=1, probe=10, pidmax=10):
 198         if self.required_packages:
 199             # get PID
 200             pid = ppid = None
 201             for probenum in xrange(pidmax):
 202                 pidtuple = rspawn.remote_check_pid(
 203                     pidfile = pidfile,
 204                     host = self.hostname,
 205                     port = None,
 206                     user = self.slicename,
 207                     agent = None,
 208                     ident_key = self.ident_path
 209                     )
 210                 if pidtuple:
 211                     pid, ppid = pidtuple
 212                     break
 213                 else:
 214                     time.sleep(pidprobe)
 215             else:
 216                 raise RuntimeError, "Failed to obtain pidfile for dependency installer"
 217
 218             # wait for it to finish
 219             while rspawn.RUNNING is rspawn.remote_status(
 220                     pid, ppid,
 221                     host = self.hostname,
 222                     port = None,
 223                     user = self.slicename,
 224                     agent = None,
 225                     ident_key = self.ident_path
 226                     ):
 227                 time.sleep(probe)
 228
 229
 230