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