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