sfa/plc/slices.py

   1 ### $Id$
   2 ### $URL$
   3
   4 import datetime
   5 import time
   6 import traceback
   7 import sys
   8
   9 from types import StringTypes
  10 from sfa.util.namespace import *
  11 from sfa.util.rspec import *
  12 from sfa.util.specdict import *
  13 from sfa.util.faults import *
  14 from sfa.util.record import SfaRecord
  15 from sfa.util.policy import Policy
  16 from sfa.util.prefixTree import prefixTree
  17 from sfa.util.debug import log
  18
  19 MAXINT =  2L**31-1
  20
  21 class Slices:
  22
  23     rspec_to_slice_tag = {'max_rate':'net_max_rate'}
  24
  25     def __init__(self, api, ttl = .5, origin_hrn=None):
  26         self.api = api
  27         #filepath = path + os.sep + filename
  28         self.policy = Policy(self.api)
  29         self.origin_hrn = origin_hrn
  30
  31     def get_slivers(self, xrn, node=None):
  32         hrn, type = urn_to_hrn(xrn)
  33
  34         slice_name = hrn_to_pl_slicename(hrn)
  35         # XX Should we just call PLCAPI.GetSliceTicket(slice_name) instead
  36         # of doing all of this?
  37         #return self.api.GetSliceTicket(self.auth, slice_name)
  38
  39         # from PLCAPI.GetSlivers.get_slivers()
  40         slice_fields = ['slice_id', 'name', 'instantiation', 'expires', 'person_ids', 'slice_tag_ids']
  41         slices = self.api.plshell.GetSlices(self.api.plauth, slice_name, slice_fields)
  42         # Build up list of users and slice attributes
  43         person_ids = set()
  44         all_slice_tag_ids = set()
  45         for slice in slices:
  46             person_ids.update(slice['person_ids'])
  47             all_slice_tag_ids.update(slice['slice_tag_ids'])
  48         person_ids = list(person_ids)
  49         all_slice_tag_ids = list(all_slice_tag_ids)
  50         # Get user information
  51         all_persons_list = self.api.plshell.GetPersons(self.api.plauth, {'person_id':person_ids,'enabled':True}, ['person_id', 'enabled', 'key_ids'])
  52         all_persons = {}
  53         for person in all_persons_list:
  54             all_persons[person['person_id']] = person
  55
  56         # Build up list of keys
  57         key_ids = set()
  58         for person in all_persons.values():
  59             key_ids.update(person['key_ids'])
  60         key_ids = list(key_ids)
  61         # Get user account keys
  62         all_keys_list = self.api.plshell.GetKeys(self.api.plauth, key_ids, ['key_id', 'key', 'key_type'])
  63         all_keys = {}
  64         for key in all_keys_list:
  65             all_keys[key['key_id']] = key
  66         # Get slice attributes
  67         all_slice_tags_list = self.api.plshell.GetSliceTags(self.api.plauth, all_slice_tag_ids)
  68         all_slice_tags = {}
  69         for slice_tag in all_slice_tags_list:
  70             all_slice_tags[slice_tag['slice_tag_id']] = slice_tag
  71
  72         slivers = []
  73         for slice in slices:
  74             keys = []
  75             for person_id in slice['person_ids']:
  76                 if person_id in all_persons:
  77                     person = all_persons[person_id]
  78                     if not person['enabled']:
  79                         continue
  80                     for key_id in person['key_ids']:
  81                         if key_id in all_keys:
  82                             key = all_keys[key_id]
  83                             keys += [{'key_type': key['key_type'],
  84                                     'key': key['key']}]
  85             attributes = []
  86             # All (per-node and global) attributes for this slice
  87             slice_tags = []
  88             for slice_tag_id in slice['slice_tag_ids']:
  89                 if slice_tag_id in all_slice_tags:
  90                     slice_tags.append(all_slice_tags[slice_tag_id])
  91             # Per-node sliver attributes take precedence over global
  92             # slice attributes, so set them first.
  93             # Then comes nodegroup slice attributes
  94             # Followed by global slice attributes
  95             sliver_attributes = []
  96
  97             if node is not None:
  98                 for sliver_attribute in filter(lambda a: a['node_id'] == node['node_id'], slice_tags):
  99                     sliver_attributes.append(sliver_attribute['tagname'])
 100                     attributes.append({'tagname': sliver_attribute['tagname'],
 101                                     'value': sliver_attribute['value']})
 102
 103             # set nodegroup slice attributes
 104             for slice_tag in filter(lambda a: a['nodegroup_id'] in node['nodegroup_ids'], slice_tags):
 105                 # Do not set any nodegroup slice attributes for
 106                 # which there is at least one sliver attribute
 107                 # already set.
 108                 if slice_tag not in slice_tags:
 109                     attributes.append({'tagname': slice_tag['tagname'],
 110                         'value': slice_tag['value']})
 111
 112             for slice_tag in filter(lambda a: a['node_id'] is None, slice_tags):
 113                 # Do not set any global slice attributes for
 114                 # which there is at least one sliver attribute
 115                 # already set.
 116                 if slice_tag['tagname'] not in sliver_attributes:
 117                     attributes.append({'tagname': slice_tag['tagname'],
 118                                    'value': slice_tag['value']})
 119
 120             # XXX Sanity check; though technically this should be a system invariant
 121             # checked with an assertion
 122             if slice['expires'] > MAXINT:  slice['expires']= MAXINT
 123
 124             slivers.append({
 125                 'hrn': hrn,
 126                 'name': slice['name'],
 127                 'slice_id': slice['slice_id'],
 128                 'instantiation': slice['instantiation'],
 129                 'expires': slice['expires'],
 130                 'keys': keys,
 131                 'attributes': attributes
 132             })
 133
 134         return slivers
 135
 136     def get_peer(self, xrn):
 137         hrn, type = urn_to_hrn(xrn)
 138         # Becaues of myplc federation,  we first need to determine if this
 139         # slice belongs to out local plc or a myplc peer. We will assume it
 140         # is a local site, unless we find out otherwise
 141         peer = None
 142
 143         # get this slice's authority (site)
 144         slice_authority = get_authority(hrn)
 145
 146         # get this site's authority (sfa root authority or sub authority)
 147         site_authority = get_authority(slice_authority).lower()
 148
 149         # check if we are already peered with this site_authority, if so
 150         peers = self.api.plshell.GetPeers(self.api.plauth, {}, ['peer_id', 'peername', 'shortname', 'hrn_root'])
 151         for peer_record in peers:
 152             names = [name.lower() for name in peer_record.values() if isinstance(name, StringTypes)]
 153             if site_authority in names:
 154                 peer = peer_record['shortname']
 155
 156         return peer
 157
 158     def get_sfa_peer(self, xrn):
 159         hrn, type = urn_to_hrn(xrn)
 160
 161         # return the authority for this hrn or None if we are the authority
 162         sfa_peer = None
 163         slice_authority = get_authority(hrn)
 164         site_authority = get_authority(slice_authority)
 165
 166         if site_authority != self.api.hrn:
 167             sfa_peer = site_authority
 168
 169         return sfa_peer
 170
 171     def verify_site(self, registry, credential, slice_hrn, peer, sfa_peer, reg_objects=None):
 172         authority = get_authority(slice_hrn)
 173         authority_urn = hrn_to_urn(authority, 'authority')
 174         login_base = None
 175         if reg_objects:
 176             site = reg_objects['site']
 177             login_base = site['login_base']
 178         else:
 179             site_records = registry.Resolve(authority_urn, [credential])
 180             site = {}
 181             for site_record in site_records:
 182                 if site_record['type'] == 'authority':
 183                     site = site_record
 184             if not site:
 185                 raise RecordNotFound(authority)
 186
 187         remote_site_id = site.pop('site_id')
 188
 189         if login_base is None:
 190             login_base = get_leaf(authority)
 191         sites = self.api.plshell.GetSites(self.api.plauth, login_base)
 192
 193         if not sites:
 194             site_id = self.api.plshell.AddSite(self.api.plauth, site)
 195             if peer:
 196                 try:
 197                     self.api.plshell.BindObjectToPeer(self.api.plauth, 'site', site_id, peer, remote_site_id)
 198                 except Exception,e:
 199                     self.api.plshell.DeleteSite(self.api.plauth, site_id)
 200                     raise e
 201             # mark this site as an sfa peer record
 202             if sfa_peer and not reg_objects:
 203                 peer_dict = {'type': 'authority', 'hrn': authority, 'peer_authority': sfa_peer, 'pointer': site_id}
 204                 registry.register_peer_object(credential, peer_dict)
 205         else:
 206             site_id = sites[0]['site_id']
 207             remote_site_id = sites[0]['peer_site_id']
 208
 209             old_site = sites[0]
 210             #the site is already on the remote agg. Let us update(e.g. max_slices field) it with the latest info.
 211             self.sync_site(old_site, site, peer)
 212
 213
 214         return (site_id, remote_site_id)
 215
 216     def verify_slice(self, registry, credential, slice_hrn, site_id, remote_site_id, peer, sfa_peer, reg_objects=None):
 217         slice = {}
 218         slice_record = None
 219         authority = get_authority(slice_hrn)
 220
 221         if reg_objects:
 222             slice_record = reg_objects['slice_record']
 223         else:
 224             slice_records = registry.Resolve(slice_hrn, [credential])
 225
 226             for record in slice_records:
 227                 if record['type'] in ['slice']:
 228                     slice_record = record
 229             if not slice_record:
 230                 raise RecordNotFound(hrn)
 231
 232
 233         slicename = hrn_to_pl_slicename(slice_hrn)
 234         parts = slicename.split("_")
 235         login_base = parts[0]
 236         slices = self.api.plshell.GetSlices(self.api.plauth, [slicename])
 237         if not slices:
 238             slice_fields = {}
 239             slice_keys = ['name', 'url', 'description']
 240             for key in slice_keys:
 241                 if key in slice_record and slice_record[key]:
 242                     slice_fields[key] = slice_record[key]
 243             # add the slice
 244             slice_id = self.api.plshell.AddSlice(self.api.plauth, slice_fields)
 245             slice = slice_fields
 246             slice['slice_id'] = slice_id
 247
 248             # mark this slice as an sfa peer record
 249             if sfa_peer:
 250                 peer_dict = {'type': 'slice', 'hrn': slice_hrn, 'peer_authority': sfa_peer, 'pointer': slice_id}
 251                 registry.register_peer_object(credential, peer_dict)
 252
 253             #this belongs to a peer
 254             if peer:
 255                 try:
 256                     self.api.plshell.BindObjectToPeer(self.api.plauth, 'slice', slice_id, peer, slice_record['pointer'])
 257                 except Exception,e:
 258                     self.api.plshell.DeleteSlice(self.api.plauth,slice_id)
 259                     raise e
 260             slice['node_ids'] = []
 261         else:
 262             slice = slices[0]
 263             slice_id = slice['slice_id']
 264             site_id = slice['site_id']
 265             #the slice is alredy on the remote agg. Let us update(e.g. expires field) it with the latest info.
 266             self.sync_slice(slice, slice_record, peer)
 267
 268         slice['peer_slice_id'] = slice_record['pointer']
 269         self.verify_persons(registry, credential, slice_record, site_id, remote_site_id, peer, sfa_peer, reg_objects)
 270
 271         return slice
 272
 273     def verify_persons(self, registry, credential, slice_record, site_id, remote_site_id, peer, sfa_peer, reg_objects=None):
 274         # get the list of valid slice users from the registry and make
 275         # sure they are added to the slice
 276         slicename = hrn_to_pl_slicename(slice_record['hrn'])
 277         if reg_objects:
 278             researchers = reg_objects['users'].keys()
 279         else:
 280             researchers = slice_record.get('researcher', [])
 281         for researcher in researchers:
 282             if reg_objects:
 283                 person_dict = reg_objects['users'][researcher]
 284             else:
 285                 person_records = registry.Resolve(researcher, [credential])
 286                 for record in person_records:
 287                     if record['type'] in ['user'] and record['enabled']:
 288                         person_record = record
 289                 if not person_record:
 290                     return 1
 291                 person_dict = person_record
 292
 293             local_person=False
 294             if peer:
 295                 peer_id = self.api.plshell.GetPeers(self.api.plauth, {'shortname': peer}, ['peer_id'])[0]['peer_id']
 296                 persons = self.api.plshell.GetPersons(self.api.plauth, {'email': [person_dict['email']], 'peer_id': peer_id}, ['person_id', 'key_ids'])
 297                 if not persons:
 298                     persons = self.api.plshell.GetPersons(self.api.plauth, [person_dict['email']], ['person_id', 'key_ids'])
 299                     if persons:
 300                         local_person=True
 301
 302             else:
 303                 persons = self.api.plshell.GetPersons(self.api.plauth, [person_dict['email']], ['person_id', 'key_ids'])
 304
 305             if not persons:
 306                 person_id=self.api.plshell.AddPerson(self.api.plauth, person_dict)
 307                 self.api.plshell.UpdatePerson(self.api.plauth, person_id, {'enabled' : True})
 308
 309                 # mark this person as an sfa peer record
 310                 if sfa_peer:
 311                     peer_dict = {'type': 'user', 'hrn': researcher, 'peer_authority': sfa_peer, 'pointer': person_id}
 312                     registry.register_peer_object(credential, peer_dict)
 313
 314                 if peer:
 315                     try:
 316                         self.api.plshell.BindObjectToPeer(self.api.plauth, 'person', person_id, peer, person_dict['pointer'])
 317                     except Exception,e:
 318                         self.api.plshell.DeletePerson(self.api.plauth,person_id)
 319                         raise e
 320                 key_ids = []
 321             else:
 322                 person_id = persons[0]['person_id']
 323                 key_ids = persons[0]['key_ids']
 324
 325
 326             # if this is a peer person, we must unbind them from the peer or PLCAPI will throw
 327             # an error
 328             try:
 329                 if peer and not local_person:
 330                     self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'person', person_id, peer)
 331                 if peer:
 332                     self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'site', site_id,  peer)
 333
 334                 self.api.plshell.AddPersonToSlice(self.api.plauth, person_dict['email'], slicename)
 335                 self.api.plshell.AddPersonToSite(self.api.plauth, person_dict['email'], site_id)
 336             finally:
 337                 if peer:
 338                     try: self.api.plshell.BindObjectToPeer(self.api.plauth, 'site', site_id, peer, remote_site_id)
 339                     except: pass
 340                 if peer and not local_person:
 341                     try: self.api.plshell.BindObjectToPeer(self.api.plauth, 'person', person_id, peer, person_dict['pointer'])
 342                     except: pass
 343
 344             self.verify_keys(registry, credential, person_dict, key_ids, person_id, peer, local_person)
 345
 346     def verify_keys(self, registry, credential, person_dict, key_ids, person_id,  peer, local_person):
 347         keylist = self.api.plshell.GetKeys(self.api.plauth, key_ids, ['key'])
 348         keys = [key['key'] for key in keylist]
 349
 350         #add keys that arent already there
 351         key_ids = person_dict['key_ids']
 352         for personkey in person_dict['keys']:
 353             if personkey not in keys:
 354                 key = {'key_type': 'ssh', 'key': personkey}
 355                 try:
 356                     if peer:
 357                         self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'person', person_id, peer)
 358                     key_id = self.api.plshell.AddPersonKey(self.api.plauth, person_dict['email'], key)
 359                 finally:
 360                     if peer and not local_person:
 361                         self.api.plshell.BindObjectToPeer(self.api.plauth, 'person', person_id, peer, person_dict['pointer'])
 362                     if peer:
 363                         # xxx - thierry how are we getting the peer_key_id in here ?
 364                         try: self.api.plshell.BindObjectToPeer(self.api.plauth, 'key', key_id, peer, key_ids.pop(0))
 365                         except: pass
 366
 367     def create_slice_aggregate(self, xrn, rspec):
 368         hrn, type = urn_to_hrn(xrn)
 369         # Determine if this is a peer slice
 370         peer = self.get_peer(hrn)
 371         sfa_peer = self.get_sfa_peer(hrn)
 372
 373         spec = RSpec(rspec)
 374         # Get the slice record from sfa
 375         slicename = hrn_to_pl_slicename(hrn)
 376         slice = {}
 377         slice_record = None
 378         registry = self.api.registries[self.api.hrn]
 379         credential = self.api.getCredential()
 380
 381         site_id, remote_site_id = self.verify_site(registry, credential, hrn, peer, sfa_peer)
 382         slice = self.verify_slice(registry, credential, hrn, site_id, remote_site_id, peer, sfa_peer)
 383
 384         # find out where this slice is currently running
 385         nodelist = self.api.plshell.GetNodes(self.api.plauth, slice['node_ids'], ['hostname'])
 386         hostnames = [node['hostname'] for node in nodelist]
 387
 388         # get netspec details
 389         nodespecs = spec.getDictsByTagName('NodeSpec')
 390
 391         # dict in which to store slice attributes to set for the nodes
 392         nodes = {}
 393         for nodespec in nodespecs:
 394             if isinstance(nodespec['name'], list):
 395                 for nodename in nodespec['name']:
 396                     nodes[nodename] = {}
 397                     for k in nodespec.keys():
 398                         rspec_attribute_value = nodespec[k]
 399                         if (self.rspec_to_slice_tag.has_key(k)):
 400                             slice_tag_name = self.rspec_to_slice_tag[k]
 401                             nodes[nodename][slice_tag_name] = rspec_attribute_value
 402             elif isinstance(nodespec['name'], StringTypes):
 403                 nodename = nodespec['name']
 404                 nodes[nodename] = {}
 405                 for k in nodespec.keys():
 406                     rspec_attribute_value = nodespec[k]
 407                     if (self.rspec_to_slice_tag.has_key(k)):
 408                         slice_tag_name = self.rspec_to_slice_tag[k]
 409                         nodes[nodename][slice_tag_name] = rspec_attribute_value
 410
 411                 for k in nodespec.keys():
 412                     rspec_attribute_value = nodespec[k]
 413                     if (self.rspec_to_slice_tag.has_key(k)):
 414                         slice_tag_name = self.rspec_to_slice_tag[k]
 415                         nodes[nodename][slice_tag_name] = rspec_attribute_value
 416
 417         node_names = nodes.keys()
 418         # remove nodes not in rspec
 419         deleted_nodes = list(set(hostnames).difference(node_names))
 420         # add nodes from rspec
 421         added_nodes = list(set(node_names).difference(hostnames))
 422
 423         try:
 424             if peer:
 425                 self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'slice', slice['slice_id'], peer)
 426
 427             self.api.plshell.AddSliceToNodes(self.api.plauth, slicename, added_nodes)
 428
 429             # Add recognized slice tags
 430             for node_name in node_names:
 431                 node = nodes[node_name]
 432                 for slice_tag in node.keys():
 433                     value = node[slice_tag]
 434                     if (isinstance(value, list)):
 435                         value = value[0]
 436
 437                     self.api.plshell.AddSliceTag(self.api.plauth, slicename, slice_tag, value, node_name)
 438
 439             self.api.plshell.DeleteSliceFromNodes(self.api.plauth, slicename, deleted_nodes)
 440         finally:
 441             if peer:
 442                 self.api.plshell.BindObjectToPeer(self.api.plauth, 'slice', slice['slice_id'], peer, slice['peer_slice_id'])
 443
 444         return 1
 445
 446     def sync_site(self, old_record, new_record, peer):
 447         if old_record['max_slices'] != new_record['max_slices'] or old_record['max_slivers'] != new_record['max_slivers']:
 448             try:
 449                 if peer:
 450                     self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'site', old_record['site_id'], peer)
 451                 if old_record['max_slices'] != new_record['max_slices']:
 452                     self.api.plshell.UpdateSite(self.api.plauth, old_record['site_id'], {'max_slices' : new_record['max_slices']})
 453                 if old_record['max_slivers'] != new_record['max_slivers']:
 454                     self.api.plshell.UpdateSite(self.api.plauth, old_record['site_id'], {'max_slivers' : new_record['max_slivers']})
 455             finally:
 456                 if peer:
 457                     self.api.plshell.BindObjectToPeer(self.api.plauth, 'site', old_record['site_id'], peer, old_record['peer_site_id'])
 458         return 1
 459
 460     def sync_slice(self, old_record, new_record, peer):
 461         if old_record['expires'] != new_record['expires']:
 462             try:
 463                 if peer:
 464                     self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'slice', old_record['slice_id'], peer)
 465                 self.api.plshell.UpdateSlice(self.api.plauth, old_record['slice_id'], {'expires' : new_record['expires']})
 466             finally:
 467                 if peer:
 468                     self.api.plshell.BindObjectToPeer(self.api.plauth, 'slice', old_record['slice_id'], peer, old_record['peer_slice_id'])
 469         return 1