sfa/managers/slice_manager.py

   1 import sys
   2 import time
   3 import traceback
   4 from StringIO import StringIO
   5 from copy import copy
   6 from lxml import etree
   7
   8 from sfa.trust.sfaticket import SfaTicket
   9 from sfa.trust.credential import Credential
  10
  11 from sfa.util.sfalogging import logger
  12 from sfa.util.xrn import Xrn, urn_to_hrn
  13 from sfa.util.version import version_core
  14 from sfa.util.callids import Callids
  15 from sfa.server.threadmanager import ThreadManager
  16 from sfa.rspecs.rspec_converter import RSpecConverter
  17 from sfa.rspecs.version_manager import VersionManager
  18 from sfa.rspecs.rspec import RSpec
  19 from sfa.client.client_helper import sfa_to_pg_users_arg
  20 from sfa.client.return_value import ReturnValue
  21
  22 class SliceManager:
  23     def __init__ (self):
  24         # xxx todo should be configurable
  25         # self.caching=False
  26         self.caching=True
  27
  28     def _options_supported(self, api, server):
  29         """
  30         Returns true if server supports the extra 'options' arg. to API calls
  31         """
  32         server_version = api.get_cached_server_version(server)
  33         return server_version.has_key ('options_support')
  34
  35     def GetVersion(self, api, options={}):
  36         # peers explicitly in aggregates.xml
  37         peers =dict ([ (peername,interface.get_url()) for (peername,interface) in api.aggregates.iteritems()
  38                        if peername != api.hrn])
  39         version_manager = VersionManager()
  40         ad_rspec_versions = []
  41         request_rspec_versions = []
  42         for rspec_version in version_manager.versions:
  43             if rspec_version.content_type in ['*', 'ad']:
  44                 ad_rspec_versions.append(rspec_version.to_dict())
  45             if rspec_version.content_type in ['*', 'request']:
  46                 request_rspec_versions.append(rspec_version.to_dict())
  47         xrn=Xrn(api.hrn, 'authority+sa')
  48         version_more = {'interface':'slicemgr',
  49                         'sfa': 1,
  50                         'geni_api': api.config.SFA_AGGREGATE_API_VERSION,
  51                         'hrn' : xrn.get_hrn(),
  52                         'urn' : xrn.get_urn(),
  53                         'peers': peers,
  54                         'geni_request_rspec_versions': request_rspec_versions,
  55                         'geni_ad_rspec_versions': ad_rspec_versions,
  56                     }
  57         sm_version=version_core(version_more)
  58         # local aggregate if present needs to have localhost resolved
  59         if api.hrn in api.aggregates:
  60             local_am_url=api.aggregates[api.hrn].get_url()
  61             sm_version['peers'][api.hrn]=local_am_url.replace('localhost',sm_version['hostname'])
  62         return sm_version
  63
  64     def drop_slicemgr_stats(self, rspec):
  65         try:
  66             stats_elements = rspec.xml.xpath('//statistics')
  67             for node in stats_elements:
  68                 node.getparent().remove(node)
  69         except Exception, e:
  70             logger.warn("drop_slicemgr_stats failed: %s " % (str(e)))
  71
  72     def add_slicemgr_stat(self, rspec, callname, aggname, elapsed, status, exc_info=None):
  73         try:
  74             stats_tags = rspec.xml.xpath('//statistics[@call="%s"]' % callname)
  75             if stats_tags:
  76                 stats_tag = stats_tags[0]
  77             else:
  78                 stats_tag = rspec.xml.root.add_element("statistics", call=callname)
  79
  80             stat_tag = stats_tag.add_element("aggregate", name=str(aggname), elapsed=str(elapsed), status=str(status))
  81
  82             if exc_info:
  83                 exc_tag = stat_tag.add_element("exc_info", name=str(exc_info[1]))
  84
  85                 # formats the traceback as one big text blob
  86                 #exc_tag.text = "\n".join(traceback.format_exception(exc_info[0], exc_info[1], exc_info[2]))
  87
  88                 # formats the traceback as a set of xml elements
  89                 tb = traceback.extract_tb(exc_info[2])
  90                 for item in tb:
  91                     exc_frame = exc_tag.add_element("tb_frame", filename=str(item[0]), line=str(item[1]), func=str(item[2]), code=str(item[3]))
  92
  93         except Exception, e:
  94             logger.warn("add_slicemgr_stat failed on  %s: %s" %(aggname, str(e)))
  95
  96     def ListResources(self, api, creds, options={}):
  97         version_manager = VersionManager()
  98         def _ListResources(aggregate, server, credential, opts={}):
  99
 100             my_opts = copy(opts)
 101             args = [credential, my_opts]
 102             tStart = time.time()
 103             try:
 104                 version = api.get_cached_server_version(server)
 105                 # force ProtoGENI aggregates to give us a v2 RSpec
 106                 if 'sfa' in version.keys():
 107                     my_opts['rspec_version'] = version_manager.get_version('SFA 1').to_dict()
 108                 else:
 109                     my_opts['rspec_version'] = version_manager.get_version('ProtoGENI 2').to_dict()
 110                 rspec = server.ListResources(*args)
 111                 return {"aggregate": aggregate, "rspec": rspec, "elapsed": time.time()-tStart, "status": "success"}
 112             except Exception, e:
 113                 api.logger.log_exc("ListResources failed at %s" %(server.url))
 114                 return {"aggregate": aggregate, "elapsed": time.time()-tStart, "status": "exception", "exc_info": sys.exc_info()}
 115         call_id = options.get('call_id')
 116         if Callids().already_handled(call_id): return ""
 117
 118         # get slice's hrn from options
 119         xrn = options.get('geni_slice_urn', '')
 120         (hrn, type) = urn_to_hrn(xrn)
 121         if 'geni_compressed' in options:
 122             del(options['geni_compressed'])
 123
 124         # get the rspec's return format from options
 125         rspec_version = version_manager.get_version(options.get('geni_rspec_version'))
 126         version_string = "rspec_%s" % (rspec_version)
 127
 128         # look in cache first
 129         if self.caching and api.cache and not xrn:
 130             rspec =  api.cache.get(version_string)
 131             if rspec:
 132                 return rspec
 133
 134         # get the callers hrn
 135         valid_cred = api.auth.checkCredentials(creds, 'listnodes', hrn)[0]
 136         caller_hrn = Credential(string=valid_cred).get_gid_caller().get_hrn()
 137
 138         # attempt to use delegated credential first
 139         cred = api.getDelegatedCredential(creds)
 140         if not cred:
 141             cred = api.getCredential()
 142         threads = ThreadManager()
 143         for aggregate in api.aggregates:
 144             # prevent infinite loop. Dont send request back to caller
 145             # unless the caller is the aggregate's SM
 146             if caller_hrn == aggregate and aggregate != api.hrn:
 147                 continue
 148
 149             # get the rspec from the aggregate
 150             interface = api.aggregates[aggregate]
 151             server = api.server_proxy(interface, cred)
 152             threads.run(_ListResources, aggregate, server, [cred], options)
 153
 154
 155         results = threads.get_results()
 156         rspec_version = version_manager.get_version(options.get('geni_rspec_version'))
 157         if xrn:
 158             result_version = version_manager._get_version(rspec_version.type, rspec_version.version, 'manifest')
 159         else:
 160             result_version = version_manager._get_version(rspec_version.type, rspec_version.version, 'ad')
 161         rspec = RSpec(version=result_version)
 162         for result in results:
 163             self.add_slicemgr_stat(rspec, "ListResources", result["aggregate"], result["elapsed"], result["status"], result.get("exc_info",None))
 164             if result["status"]=="success":
 165                 try:
 166                     rspec.version.merge(ReturnValue.get_value(result["rspec"]))
 167                 except:
 168                     api.logger.log_exc("SM.ListResources: Failed to merge aggregate rspec")
 169
 170         # cache the result
 171         if self.caching and api.cache and not xrn:
 172             api.cache.add(version_string, rspec.toxml())
 173
 174         return rspec.toxml()
 175
 176
 177     def CreateSliver(self, api, xrn, creds, rspec_str, users, options={}):
 178
 179         version_manager = VersionManager()
 180         def _CreateSliver(aggregate, server, xrn, credential, rspec, users, options={}):
 181             tStart = time.time()
 182             try:
 183                 # Need to call GetVersion at an aggregate to determine the supported
 184                 # rspec type/format beofre calling CreateSliver at an Aggregate.
 185                 server_version = api.get_cached_server_version(server)
 186                 requested_users = users
 187                 if 'sfa' not in server_version and 'geni_api' in server_version:
 188                     # sfa aggregtes support both sfa and pg rspecs, no need to convert
 189                     # if aggregate supports sfa rspecs. otherwise convert to pg rspec
 190                     rspec = RSpec(RSpecConverter.to_pg_rspec(rspec, 'request'))
 191                     filter = {'component_manager_id': server_version['urn']}
 192                     rspec.filter(filter)
 193                     rspec = rspec.toxml()
 194                     requested_users = sfa_to_pg_users_arg(users)
 195                 args = [xrn, credential, rspec, requested_users]
 196                 if self._options_supported(api, server):
 197                     args.append(options)
 198                 rspec = server.CreateSliver(*args)
 199                 return {"aggregate": aggregate, "rspec": rspec, "elapsed": time.time()-tStart, "status": "success"}
 200             except:
 201                 logger.log_exc('Something wrong in _CreateSliver with URL %s'%server.url)
 202                 return {"aggregate": aggregate, "elapsed": time.time()-tStart, "status": "exception", "exc_info": sys.exc_info()}
 203
 204         call_id = options.get('call_id')
 205         if Callids().already_handled(call_id): return ""
 206         # Validate the RSpec against PlanetLab's schema --disabled for now
 207         # The schema used here needs to aggregate the PL and VINI schemas
 208         # schema = "/var/www/html/schemas/pl.rng"
 209         rspec = RSpec(rspec_str)
 210     #    schema = None
 211     #    if schema:
 212     #        rspec.validate(schema)
 213
 214         # if there is a <statistics> section, the aggregates don't care about it,
 215         # so delete it.
 216         self.drop_slicemgr_stats(rspec)
 217
 218         # attempt to use delegated credential first
 219         cred = api.getDelegatedCredential(creds)
 220         if not cred:
 221             cred = api.getCredential()
 222
 223         # get the callers hrn
 224         hrn, type = urn_to_hrn(xrn)
 225         valid_cred = api.auth.checkCredentials(creds, 'createsliver', hrn)[0]
 226         caller_hrn = Credential(string=valid_cred).get_gid_caller().get_hrn()
 227         threads = ThreadManager()
 228         for aggregate in api.aggregates:
 229             # prevent infinite loop. Dont send request back to caller
 230             # unless the caller is the aggregate's SM
 231             if caller_hrn == aggregate and aggregate != api.hrn:
 232                 continue
 233             interface = api.aggregates[aggregate]
 234             server = api.server_proxy(interface, cred)
 235             # Just send entire RSpec to each aggregate
 236             threads.run(_CreateSliver, aggregate, server, xrn, [cred], rspec.toxml(), users, call_id)
 237
 238         results = threads.get_results()
 239         manifest_version = version_manager._get_version(rspec.version.type, rspec.version.version, 'manifest')
 240         result_rspec = RSpec(version=manifest_version)
 241         for result in results:
 242             self.add_slicemgr_stat(result_rspec, "CreateSliver", result["aggregate"], result["elapsed"], result["status"], result.get("exc_info",None))
 243             if result["status"]=="success":
 244                 try:
 245                     result_rspec.version.merge(ReturnValue.get_value(result["rspec"]))
 246                 except:
 247                     api.logger.log_exc("SM.CreateSliver: Failed to merge aggregate rspec")
 248         return result_rspec.toxml()
 249
 250     def RenewSliver(self, api, xrn, creds, expiration_time, options={}):
 251         def _RenewSliver(server, xrn, creds, expiration_time, options={}):
 252             server_version = api.get_cached_server_version(server)
 253             args =  [xrn, creds, expiration_time]
 254             if self._options_supported(api, server):
 255                 args.append(options)
 256             return server.RenewSliver(*args)
 257
 258         call_id = options.get('call_id')
 259         if Callids().already_handled(call_id): return True
 260
 261         (hrn, type) = urn_to_hrn(xrn)
 262         # get the callers hrn
 263         valid_cred = api.auth.checkCredentials(creds, 'renewsliver', hrn)[0]
 264         caller_hrn = Credential(string=valid_cred).get_gid_caller().get_hrn()
 265
 266         # attempt to use delegated credential first
 267         cred = api.getDelegatedCredential(creds)
 268         if not cred:
 269             cred = api.getCredential()
 270         threads = ThreadManager()
 271         for aggregate in api.aggregates:
 272             # prevent infinite loop. Dont send request back to caller
 273             # unless the caller is the aggregate's SM
 274             if caller_hrn == aggregate and aggregate != api.hrn:
 275                 continue
 276             interface = api.aggregates[aggregate]
 277             server = api.server_proxy(interface, cred)
 278             threads.run(_RenewSliver, server, xrn, [cred], expiration_time, call_id)
 279         # 'and' the results
 280         results = [ReturnValue.get_value(result) for result in threads.get_results()]
 281         return reduce (lambda x,y: x and y, results , True)
 282
 283     def DeleteSliver(self, api, xrn, creds, options={}):
 284         def _DeleteSliver(server, xrn, creds, options={}):
 285             server_version = api.get_cached_server_version(server)
 286             args =  [xrn, creds]
 287             if self._options_supported(api, server):
 288                 args.append(options)
 289             return server.DeleteSliver(*args)
 290
 291         call_id = options.get('call_id')
 292         if Callids().already_handled(call_id): return ""
 293         (hrn, type) = urn_to_hrn(xrn)
 294         # get the callers hrn
 295         valid_cred = api.auth.checkCredentials(creds, 'deletesliver', hrn)[0]
 296         caller_hrn = Credential(string=valid_cred).get_gid_caller().get_hrn()
 297
 298         # attempt to use delegated credential first
 299         cred = api.getDelegatedCredential(creds)
 300         if not cred:
 301             cred = api.getCredential()
 302         threads = ThreadManager()
 303         for aggregate in api.aggregates:
 304             # prevent infinite loop. Dont send request back to caller
 305             # unless the caller is the aggregate's SM
 306             if caller_hrn == aggregate and aggregate != api.hrn:
 307                 continue
 308             interface = api.aggregates[aggregate]
 309             server = api.server_proxy(interface, cred)
 310             threads.run(_DeleteSliver, server, xrn, [cred], call_id)
 311         threads.get_results()
 312         return 1
 313
 314
 315     # first draft at a merging SliverStatus
 316     def SliverStatus(self, api, slice_xrn, creds, options={}):
 317         def _SliverStatus(server, xrn, creds, options={}):
 318             server_version = api.get_cached_server_version(server)
 319             args =  [xrn, creds]
 320             if self._options_supported(api, server):
 321                 args.append(options)
 322             return server.SliverStatus(*args)
 323
 324         call_id = options.get('call_id')
 325         if Callids().already_handled(call_id): return {}
 326         # attempt to use delegated credential first
 327         cred = api.getDelegatedCredential(creds)
 328         if not cred:
 329             cred = api.getCredential()
 330         threads = ThreadManager()
 331         for aggregate in api.aggregates:
 332             interface = api.aggregates[aggregate]
 333             server = api.server_proxy(interface, cred)
 334             threads.run (_SliverStatus, server, slice_xrn, [cred], call_id)
 335         results = [ReturnValue.get_value(result) for result in threads.get_results()]
 336
 337         # get rid of any void result - e.g. when call_id was hit where by convention we return {}
 338         results = [ result for result in results if result and result['geni_resources']]
 339
 340         # do not try to combine if there's no result
 341         if not results : return {}
 342
 343         # otherwise let's merge stuff
 344         overall = {}
 345
 346         # mmh, it is expected that all results carry the same urn
 347         overall['geni_urn'] = results[0]['geni_urn']
 348         overall['pl_login'] = results[0]['pl_login']
 349         # append all geni_resources
 350         overall['geni_resources'] = \
 351             reduce (lambda x,y: x+y, [ result['geni_resources'] for result in results] , [])
 352         overall['status'] = 'unknown'
 353         if overall['geni_resources']:
 354             overall['status'] = 'ready'
 355
 356         return overall
 357
 358     def ListSlices(self, api, creds, options={}):
 359         def _ListSlices(server, creds, options={}):
 360             server_version = api.get_cached_server_version(server)
 361             args =  [creds]
 362             if self._options_supported(api, server):
 363                 args.append(options)
 364             return server.ListSlices(*args)
 365
 366         call_id = options.get('call_id')
 367         if Callids().already_handled(call_id): return []
 368
 369         # look in cache first
 370         if self.caching and api.cache:
 371             slices = api.cache.get('slices')
 372             if slices:
 373                 return slices
 374
 375         # get the callers hrn
 376         valid_cred = api.auth.checkCredentials(creds, 'listslices', None)[0]
 377         caller_hrn = Credential(string=valid_cred).get_gid_caller().get_hrn()
 378
 379         # attempt to use delegated credential first
 380         cred= api.getDelegatedCredential(creds)
 381         if not cred:
 382             cred = api.getCredential()
 383         threads = ThreadManager()
 384         # fetch from aggregates
 385         for aggregate in api.aggregates:
 386             # prevent infinite loop. Dont send request back to caller
 387             # unless the caller is the aggregate's SM
 388             if caller_hrn == aggregate and aggregate != api.hrn:
 389                 continue
 390             interface = api.aggregates[aggregate]
 391             server = api.server_proxy(interface, cred)
 392             threads.run(_ListSlices, server, [cred], options)
 393
 394         # combime results
 395         results = [ReturnValue.get_value(result) for result in threads.get_results()]
 396         slices = []
 397         for result in results:
 398             slices.extend(result)
 399
 400         # cache the result
 401         if self.caching and api.cache:
 402             api.cache.add('slices', slices)
 403
 404         return slices
 405
 406
 407     def GetTicket(self, api, xrn, creds, rspec, users, options={}):
 408         slice_hrn, type = urn_to_hrn(xrn)
 409         # get the netspecs contained within the clients rspec
 410         aggregate_rspecs = {}
 411         tree= etree.parse(StringIO(rspec))
 412         elements = tree.findall('./network')
 413         for element in elements:
 414             aggregate_hrn = element.values()[0]
 415             aggregate_rspecs[aggregate_hrn] = rspec
 416
 417         # get the callers hrn
 418         valid_cred = api.auth.checkCredentials(creds, 'getticket', slice_hrn)[0]
 419         caller_hrn = Credential(string=valid_cred).get_gid_caller().get_hrn()
 420
 421         # attempt to use delegated credential first
 422         cred = api.getDelegatedCredential(creds)
 423         if not cred:
 424             cred = api.getCredential()
 425         threads = ThreadManager()
 426         for (aggregate, aggregate_rspec) in aggregate_rspecs.iteritems():
 427             # prevent infinite loop. Dont send request back to caller
 428             # unless the caller is the aggregate's SM
 429             if caller_hrn == aggregate and aggregate != api.hrn:
 430                 continue
 431
 432             interface = api.aggregates[aggregate]
 433             server = api.server_proxy(interface, cred)
 434             threads.run(server.GetTicket, xrn, [cred], aggregate_rspec, users, options)
 435
 436         results = threads.get_results()
 437
 438         # gather information from each ticket
 439         rspec = None
 440         initscripts = []
 441         slivers = []
 442         object_gid = None
 443         for result in results:
 444             agg_ticket = SfaTicket(string=result)
 445             attrs = agg_ticket.get_attributes()
 446             if not object_gid:
 447                 object_gid = agg_ticket.get_gid_object()
 448             if not rspec:
 449                 rspec = RSpec(agg_ticket.get_rspec())
 450             else:
 451                 rspec.version.merge(agg_ticket.get_rspec())
 452             initscripts.extend(attrs.get('initscripts', []))
 453             slivers.extend(attrs.get('slivers', []))
 454
 455         # merge info
 456         attributes = {'initscripts': initscripts,
 457                      'slivers': slivers}
 458
 459         # create a new ticket
 460         ticket = SfaTicket(subject = slice_hrn)
 461         ticket.set_gid_caller(api.auth.client_gid)
 462         ticket.set_issuer(key=api.key, subject=api.hrn)
 463         ticket.set_gid_object(object_gid)
 464         ticket.set_pubkey(object_gid.get_pubkey())
 465         #new_ticket.set_parent(api.auth.hierarchy.get_auth_ticket(auth_hrn))
 466         ticket.set_attributes(attributes)
 467         ticket.set_rspec(rspec.toxml())
 468         ticket.encode()
 469         ticket.sign()
 470         return ticket.save_to_string(save_parents=True)
 471
 472     def start_slice(self, api, xrn, creds):
 473         hrn, type = urn_to_hrn(xrn)
 474
 475         # get the callers hrn
 476         valid_cred = api.auth.checkCredentials(creds, 'startslice', hrn)[0]
 477         caller_hrn = Credential(string=valid_cred).get_gid_caller().get_hrn()
 478
 479         # attempt to use delegated credential first
 480         cred = api.getDelegatedCredential(creds)
 481         if not cred:
 482             cred = api.getCredential()
 483         threads = ThreadManager()
 484         for aggregate in api.aggregates:
 485             # prevent infinite loop. Dont send request back to caller
 486             # unless the caller is the aggregate's SM
 487             if caller_hrn == aggregate and aggregate != api.hrn:
 488                 continue
 489             interface = api.aggregates[aggregate]
 490             server = api.server_proxy(interface, cred)
 491             threads.run(server.Start, xrn, cred)
 492         threads.get_results()
 493         return 1
 494
 495     def stop_slice(self, api, xrn, creds):
 496         hrn, type = urn_to_hrn(xrn)
 497
 498         # get the callers hrn
 499         valid_cred = api.auth.checkCredentials(creds, 'stopslice', hrn)[0]
 500         caller_hrn = Credential(string=valid_cred).get_gid_caller().get_hrn()
 501
 502         # attempt to use delegated credential first
 503         cred = api.getDelegatedCredential(creds)
 504         if not cred:
 505             cred = api.getCredential()
 506         threads = ThreadManager()
 507         for aggregate in api.aggregates:
 508             # prevent infinite loop. Dont send request back to caller
 509             # unless the caller is the aggregate's SM
 510             if caller_hrn == aggregate and aggregate != api.hrn:
 511                 continue
 512             interface = api.aggregates[aggregate]
 513             server = api.server_proxy(interface, cred)
 514             threads.run(server.Stop, xrn, cred)
 515         threads.get_results()
 516         return 1
 517
 518     def reset_slice(self, api, xrn):
 519         """
 520         Not implemented
 521         """
 522         return 1
 523
 524     def shutdown(self, api, xrn, creds):
 525         """
 526         Not implemented
 527         """
 528         return 1
 529
 530     def status(self, api, xrn, creds):
 531         """
 532         Not implemented
 533         """
 534         return 1
 535