last plc-dependent code moved to PlDriver
[sfa.git] / sfa / managers / slice_manager.py
index 24fc7a4..be6cc7e 100644 (file)
@@ -12,27 +12,30 @@ from sfa.util.sfalogging import logger
 from sfa.util.xrn import Xrn, urn_to_hrn
 from sfa.util.version import version_core
 from sfa.util.callids import Callids
+from sfa.util.cache import Cache
+
 from sfa.server.threadmanager import ThreadManager
+
 from sfa.rspecs.rspec_converter import RSpecConverter
 from sfa.rspecs.version_manager import VersionManager
 from sfa.rspecs.rspec import RSpec 
+
 from sfa.client.client_helper import sfa_to_pg_users_arg
 from sfa.client.return_value import ReturnValue
 
 class SliceManager:
-    def __init__ (self):
-        # xxx todo should be configurable 
-        # self.caching=False
-        self.caching=True
+
+    # the cache instance is a class member so it survives across incoming requests
+    cache = None
+
+    def __init__ (self, config):
+        self.cache=None
+        if config.SFA_SM_CACHING:
+            if SliceManager.cache is None:
+                SliceManager.cache = Cache()
+            self.cache = SliceManager.cache
         
-    def _options_supported(self, api, server):
-        """
-        Returns true if server supports the extra 'options' arg. to API calls
-        """
-        server_version = api.get_cached_server_version(server)
-        return server_version.has_key ('options_support')
-    
-    def GetVersion(self, api, options={}):
+    def GetVersion(self, api, options):
         # peers explicitly in aggregates.xml
         peers =dict ([ (peername,interface.get_url()) for (peername,interface) in api.aggregates.iteritems()
                        if peername != api.hrn])
@@ -46,8 +49,8 @@ class SliceManager:
                 request_rspec_versions.append(rspec_version.to_dict())
         xrn=Xrn(api.hrn, 'authority+sa')
         version_more = {'interface':'slicemgr',
-                        'sfa': 1,
-                        'geni_api': api.config.SFA_AGGREGATE_API_VERSION,
+                        'sfa': 2,
+                        'geni_api': 2,
                         'hrn' : xrn.get_hrn(),
                         'urn' : xrn.get_urn(),
                         'peers': peers,
@@ -77,7 +80,8 @@ class SliceManager:
             else:
                 stats_tag = rspec.xml.root.add_element("statistics", call=callname)
 
-            stat_tag = stats_tag.add_element("aggregate", name=str(aggname), elapsed=str(elapsed), status=str(status))
+            stat_tag = stats_tag.add_element("aggregate", name=str(aggname), 
+                                             elapsed=str(elapsed), status=str(status))
 
             if exc_info:
                 exc_tag = stat_tag.add_element("exc_info", name=str(exc_info[1]))
@@ -88,32 +92,33 @@ class SliceManager:
                 # formats the traceback as a set of xml elements
                 tb = traceback.extract_tb(exc_info[2])
                 for item in tb:
-                    exc_frame = exc_tag.add_element("tb_frame", filename=str(item[0]), line=str(item[1]), func=str(item[2]), code=str(item[3]))
+                    exc_frame = exc_tag.add_element("tb_frame", filename=str(item[0]), 
+                                                    line=str(item[1]), func=str(item[2]), code=str(item[3]))
 
         except Exception, e:
             logger.warn("add_slicemgr_stat failed on  %s: %s" %(aggname, str(e)))
     
-    def ListResources(self, api, creds, options={}):
+    def ListResources(self, api, creds, options):
+        call_id = options.get('call_id') 
+        if Callids().already_handled(call_id): return ""
+
         version_manager = VersionManager()
-        def _ListResources(aggregate, server, credential, opts={}):
-    
-            my_opts = copy(opts)
-            args = [credential, my_opts]
+
+        def _ListResources(aggregate, server, credential, options):
+            forward_options = copy(options)
             tStart = time.time()
             try:
                 version = api.get_cached_server_version(server)
                 # force ProtoGENI aggregates to give us a v2 RSpec
                 if 'sfa' in version.keys():
-                    my_opts['rspec_version'] = version_manager.get_version('SFA 1').to_dict()
+                    forward_options['rspec_version'] = version_manager.get_version('SFA 1').to_dict()
                 else:
-                    my_opts['rspec_version'] = version_manager.get_version('ProtoGENI 2').to_dict()
-                rspec = server.ListResources(*args)
+                    forward_options['rspec_version'] = version_manager.get_version('ProtoGENI 2').to_dict()
+                rspec = server.ListResources(credential, forward_options)
                 return {"aggregate": aggregate, "rspec": rspec, "elapsed": time.time()-tStart, "status": "success"}
             except Exception, e:
                 api.logger.log_exc("ListResources failed at %s" %(server.url))
                 return {"aggregate": aggregate, "elapsed": time.time()-tStart, "status": "exception", "exc_info": sys.exc_info()}
-        call_id = options.get('call_id') 
-        if Callids().already_handled(call_id): return ""
     
         # get slice's hrn from options
         xrn = options.get('geni_slice_urn', '')
@@ -126,9 +131,10 @@ class SliceManager:
         version_string = "rspec_%s" % (rspec_version)
     
         # look in cache first
-        if self.caching and api.cache and not xrn:
-            rspec =  api.cache.get(version_string)
+        if self.cache and not xrn:
+            rspec =  self.cache.get(version_string)
             if rspec:
+                api.logger.debug("SliceManager.ListResources returns cached advertisement")
                 return rspec
     
         # get the callers hrn
@@ -160,7 +166,8 @@ class SliceManager:
             result_version = version_manager._get_version(rspec_version.type, rspec_version.version, 'ad')
         rspec = RSpec(version=result_version)
         for result in results:
-            self.add_slicemgr_stat(rspec, "ListResources", result["aggregate"], result["elapsed"], result["status"], result.get("exc_info",None))
+            self.add_slicemgr_stat(rspec, "ListResources", result["aggregate"], result["elapsed"], 
+                                   result["status"], result.get("exc_info",None))
             if result["status"]=="success":
                 try:
                     rspec.version.merge(ReturnValue.get_value(result["rspec"]))
@@ -168,16 +175,19 @@ class SliceManager:
                     api.logger.log_exc("SM.ListResources: Failed to merge aggregate rspec")
     
         # cache the result
-        if self.caching and api.cache and not xrn:
-            api.cache.add(version_string, rspec.toxml())
+        if self.cache and not xrn:
+            api.logger.debug("SliceManager.ListResources caches advertisement")
+            self.cache.add(version_string, rspec.toxml())
     
         return rspec.toxml()
-    
-    
-    def CreateSliver(self, api, xrn, creds, rspec_str, users, options={}):
+
+
+    def CreateSliver(self, api, xrn, creds, rspec_str, users, options):
+        call_id = options.get('call_id')
+        if Callids().already_handled(call_id): return ""
     
         version_manager = VersionManager()
-        def _CreateSliver(aggregate, server, xrn, credential, rspec, users, options={}):
+        def _CreateSliver(aggregate, server, xrn, credential, rspec, users, options):
             tStart = time.time()
             try:
                 # Need to call GetVersion at an aggregate to determine the supported
@@ -192,17 +202,12 @@ class SliceManager:
                     rspec.filter(filter)
                     rspec = rspec.toxml()
                     requested_users = sfa_to_pg_users_arg(users)
-                args = [xrn, credential, rspec, requested_users]
-                if self._options_supported(api, server):
-                    args.append(options)
-                rspec = server.CreateSliver(*args)
+                rspec = server.CreateSliver(xrn, credential, rspec, requested_users, options)
                 return {"aggregate": aggregate, "rspec": rspec, "elapsed": time.time()-tStart, "status": "success"}
             except:
                 logger.log_exc('Something wrong in _CreateSliver with URL %s'%server.url)
                 return {"aggregate": aggregate, "elapsed": time.time()-tStart, "status": "exception", "exc_info": sys.exc_info()}
 
-        call_id = options.get('call_id')
-        if Callids().already_handled(call_id): return ""
         # Validate the RSpec against PlanetLab's schema --disabled for now
         # The schema used here needs to aggregate the PL and VINI schemas
         # schema = "/var/www/html/schemas/pl.rng"
@@ -239,7 +244,8 @@ class SliceManager:
         manifest_version = version_manager._get_version(rspec.version.type, rspec.version.version, 'manifest')
         result_rspec = RSpec(version=manifest_version)
         for result in results:
-            self.add_slicemgr_stat(result_rspec, "CreateSliver", result["aggregate"], result["elapsed"], result["status"], result.get("exc_info",None))
+            self.add_slicemgr_stat(result_rspec, "CreateSliver", result["aggregate"], result["elapsed"], 
+                                   result["status"], result.get("exc_info",None))
             if result["status"]=="success":
                 try:
                     result_rspec.version.merge(ReturnValue.get_value(result["rspec"]))
@@ -247,16 +253,12 @@ class SliceManager:
                     api.logger.log_exc("SM.CreateSliver: Failed to merge aggregate rspec")
         return result_rspec.toxml()
     
-    def RenewSliver(self, api, xrn, creds, expiration_time, options={}):
-        def _RenewSliver(server, xrn, creds, expiration_time, options={}):
-            server_version = api.get_cached_server_version(server)
-            args =  [xrn, creds, expiration_time]
-            if self._options_supported(api, server):
-                args.append(options)
-            return server.RenewSliver(*args)
-    
+    def RenewSliver(self, api, xrn, creds, expiration_time, options):
         call_id = options.get('call_id')
         if Callids().already_handled(call_id): return True
+
+        def _RenewSliver(server, xrn, creds, expiration_time, options):
+            return server.RenewSliver(xrn, creds, expiration_time, options)
     
         (hrn, type) = urn_to_hrn(xrn)
         # get the callers hrn
@@ -280,16 +282,13 @@ class SliceManager:
         results = [ReturnValue.get_value(result) for result in threads.get_results()]
         return reduce (lambda x,y: x and y, results , True)
     
-    def DeleteSliver(self, api, xrn, creds, options={}):
-        def _DeleteSliver(server, xrn, creds, options={}):
-            server_version = api.get_cached_server_version(server)
-            args =  [xrn, creds]
-            if self._options_supported(api, server):
-                args.append(options)
-            return server.DeleteSliver(*args)
-
+    def DeleteSliver(self, api, xrn, creds, options):
         call_id = options.get('call_id') 
         if Callids().already_handled(call_id): return ""
+
+        def _DeleteSliver(server, xrn, creds, options):
+            return server.DeleteSliver(xrn, creds, options)
+
         (hrn, type) = urn_to_hrn(xrn)
         # get the callers hrn
         valid_cred = api.auth.checkCredentials(creds, 'deletesliver', hrn)[0]
@@ -313,13 +312,9 @@ class SliceManager:
     
     
     # first draft at a merging SliverStatus
-    def SliverStatus(self, api, slice_xrn, creds, options={}):
-        def _SliverStatus(server, xrn, creds, options={}):
-            server_version = api.get_cached_server_version(server)
-            args =  [xrn, creds]
-            if self._options_supported(api, server):
-                args.append(options)
-            return server.SliverStatus(*args)
+    def SliverStatus(self, api, slice_xrn, creds, options):
+        def _SliverStatus(server, xrn, creds, options):
+            return server.SliverStatus(xrn, creds, options)
 
         call_id = options.get('call_id') 
         if Callids().already_handled(call_id): return {}
@@ -334,7 +329,7 @@ class SliceManager:
             threads.run (_SliverStatus, server, slice_xrn, [cred], options)
         results = [ReturnValue.get_value(result) for result in threads.get_results()]
     
-        # get rid of any void result - e.g. when call_id was hit where by convention we return {}
+        # get rid of any void result - e.g. when call_id was hit, where by convention we return {}
         results = [ result for result in results if result and result['geni_resources']]
     
         # do not try to combine if there's no result
@@ -355,21 +350,19 @@ class SliceManager:
     
         return overall
     
-    def ListSlices(self, api, creds, options={}):
-        def _ListSlices(server, creds, options={}):
-            server_version = api.get_cached_server_version(server)
-            args =  [creds]
-            if self._options_supported(api, server):
-                args.append(options)
-            return server.ListSlices(*args)
-
+    def ListSlices(self, api, creds, options):
         call_id = options.get('call_id') 
         if Callids().already_handled(call_id): return []
     
+        def _ListSlices(server, creds, options):
+            return server.ListSlices(creds, options)
+
         # look in cache first
-        if self.caching and api.cache:
-            slices = api.cache.get('slices')
+        # xxx is this really frequent enough that it is worth being cached ?
+        if self.cache:
+            slices = self.cache.get('slices')
             if slices:
+                api.logger.debug("SliceManager.ListSlices returns from cache")
                 return slices
     
         # get the callers hrn
@@ -398,13 +391,14 @@ class SliceManager:
             slices.extend(result)
     
         # cache the result
-        if self.caching and api.cache:
-            api.cache.add('slices', slices)
+        if self.cache:
+            api.logger.debug("SliceManager.ListSlices caches value")
+            self.cache.add('slices', slices)
     
         return slices
     
     
-    def GetTicket(self, api, xrn, creds, rspec, users, options={}):
+    def GetTicket(self, api, xrn, creds, rspec, users, options):
         slice_hrn, type = urn_to_hrn(xrn)
         # get the netspecs contained within the clients rspec
         aggregate_rspecs = {}
@@ -424,6 +418,7 @@ class SliceManager:
             cred = api.getCredential() 
         threads = ThreadManager()
         for (aggregate, aggregate_rspec) in aggregate_rspecs.iteritems():
+            # xxx sounds like using call_id here would be safer
             # prevent infinite loop. Dont send request back to caller
             # unless the caller is the aggregate's SM
             if caller_hrn == aggregate and aggregate != api.hrn: