Base Instrumenter (#66)

Add an abstract base class for the instrumenters.

Author: AndreasGocht

scorep/instrumenters/base_instrumenter.py

@@ -0,0 +1,104 @@
+__all__ = ['BaseInstrumenter']
+
+import abc
+import os
+import sys
+
+
+def get_module_name(frame):
+    modulename = frame.f_globals.get('__name__', None)
+    if modulename is None:
+        # this is a NUMPY special situation, see NEP-18, and Score-P Issue
+        # issues #63
+        if frame.f_code.co_filename == "<__array_function__ internals>":
+            modulename = "numpy.__array_function__"
+        else:
+            modulename = "unkown"
+    return modulename
+
+
+def get_file_name(frame):
+    file_name = frame.f_code.co_filename
+    if file_name is not None:
+        full_file_name = os.path.abspath(file_name)
+    else:
+        full_file_name = "None"
+    return full_file_name
+
+
+if sys.version_info >= (3, 4):
+    class _BaseInstrumenter(abc.ABC):
+        pass
+else:
+    class _BaseInstrumenter():
+        __metaclass__ = abc.ABCMeta
+
+
+class BaseInstrumenter(_BaseInstrumenter):
+    @abc.abstractmethod
+    def register(self):
+        pass
+
+    @abc.abstractmethod
+    def unregister(self):
+        pass
+
+    @abc.abstractmethod
+    def get_registered(self):
+        return None
+
+    @abc.abstractmethod
+    def run(self, cmd):
+        pass
+
+    @abc.abstractmethod
+    def runctx(self, cmd, globals=None, locals=None):
+        pass
+
+    @abc.abstractmethod
+    def runfunc(self, func, *args, **kw):
+        pass
+
+    @abc.abstractmethod
+    def region_begin(self, module_name, function_name, file_name, line_number):
+        pass
+
+    @abc.abstractmethod
+    def region_end(self, module_name, function_name):
+        pass
+
+    @abc.abstractmethod
+    def rewind_begin(self, name, file_name=None, line_number=None):
+        pass
+
+    @abc.abstractmethod
+    def rewind_end(self, name, value):
+        pass
+
+    @abc.abstractmethod
+    def oa_region_begin(self, name, file_name=None, line_number=None):
+        pass
+
+    @abc.abstractmethod
+    def oa_region_end(self, name):
+        pass
+
+    @abc.abstractmethod
+    def user_enable_recording(self):
+        pass
+
+    @abc.abstractmethod
+    def user_disable_recording(self):
+        pass
+
+    @abc.abstractmethod
+    def user_parameter_int(self, name, val):
+        pass
+
+    @abc.abstractmethod
+    def user_parameter_uint(self, name, val):
+        pass
+
+    @abc.abstractmethod
+    def user_parameter_string(self, name, string):
+        pass

scorep/instrumenters/dummy.py

@@ -1,7 +1,8 @@
 __all__ = ['ScorepDummy']
 
+import scorep.instrumenters.base_instrumenter as base_instrumenter
 
-class ScorepDummy:
+class ScorepDummy(base_instrumenter.BaseInstrumenter):
     def __init__(self, scorep_bindings=None, enable_instrumenter=True):
         pass
 

scorep/instrumenters/scorep_profile.py

@@ -1,7 +1,9 @@
 __all__ = ['ScorepProfile']
+
 import sys
 import inspect
 import os.path
+import scorep.instrumenters.base_instrumenter as base_instrumenter
 
 try:
     import threading
@@ -21,7 +23,7 @@ def _unsetprofile():
         threading.setprofile(None)
 
 
-class ScorepProfile:
+class ScorepProfile(base_instrumenter.BaseInstrumenter):
     def __init__(self, scorep_bindings, enable_instrumenter=True):
         """
         @param enable_instrumenter true if the tracing shall be initialised.
@@ -79,32 +81,16 @@ def globaltrace_lt(self, frame, why, arg):
         """
         if why == 'call':
             code = frame.f_code
-            modulename = frame.f_globals.get('__name__', None)
-            if modulename is None:
-                # this is a NUMPY special situation, see NEP-18, and Score-P Issue issues #63
-                if code.co_filename == "<__array_function__ internals>":
-                    modulename = "numpy.__array_function__"
-                else:
-                    modulename = "unkown"
+            modulename = base_instrumenter.get_module_name(frame)
             if not code.co_name == "_unsetprofile" and not modulename[:6] == "scorep":
-                file_name = code.co_filename
-                if file_name is not None:
-                    full_file_name = os.path.abspath(file_name)
-                else:
-                    full_file_name = "None"
+                full_file_name = base_instrumenter.get_file_name(frame)
                 line_number = code.co_firstlineno
                 self.scorep_bindings.region_begin(
                     modulename, code.co_name, full_file_name, line_number)
             return
         elif why == 'return':
             code = frame.f_code
-            modulename = frame.f_globals.get('__name__', None)
-            if modulename is None:
-                # this is a NUMPY special situation, see NEP-18, and Score-P Issue issues #63
-                if code.co_filename == "<__array_function__ internals>":
-                    modulename = "numpy.__array_function__"
-                else:
-                    modulename = "unkown"
+            modulename = base_instrumenter.get_module_name(frame)
             if not code.co_name == "_unsetprofile" and not modulename[:6] == "scorep":
                 self.scorep_bindings.region_end(modulename, code.co_name)
         else:

scorep/instrumenters/scorep_trace.py

@@ -1,7 +1,9 @@
 __all__ = ['ScorepTrace']
+
 import sys
 import inspect
 import os.path
+import scorep.instrumenters.base_instrumenter as base_instrumenter
 
 try:
     import threading
@@ -21,7 +23,7 @@ def _unsettrace():
         threading.settrace(None)
 
 
-class ScorepTrace:
+class ScorepTrace(base_instrumenter.BaseInstrumenter):
     def __init__(self, scorep_bindings, enable_instrumenter=True):
         """
         @param enable_instrumenter true if the tracing shall be initialised.
@@ -78,19 +80,9 @@ def globaltrace_lt(self, frame, why, arg):
         """
         if why == 'call':
             code = frame.f_code
-            modulename = frame.f_globals.get('__name__', None)
-            if modulename is None:
-                # this is a NUMPY special situation, see NEP-18, and Score-P Issue issues #63
-                if code.co_filename == "<__array_function__ internals>":
-                    modulename = "numpy.__array_function__"
-                else:
-                    modulename = "unkown"
+            modulename = base_instrumenter.get_module_name(frame)
             if not code.co_name == "_unsettrace" and not modulename[:6] == "scorep":
-                file_name = code.co_filename
-                if file_name is not None:
-                    full_file_name = os.path.abspath(file_name)
-                else:
-                    full_file_name = "None"
+                full_file_name = base_instrumenter.get_file_name(frame)
                 line_number = code.co_firstlineno
                 self.scorep_bindings.region_begin(
                     modulename, code.co_name, full_file_name, line_number)
@@ -100,13 +92,7 @@ def globaltrace_lt(self, frame, why, arg):
     def localtrace_trace(self, frame, why, arg):
         if why == 'return':
             code = frame.f_code
-            modulename = frame.f_globals.get('__name__', None)
-            if modulename is None:
-                # this is a NUMPY special situation, see NEP-18, and Score-P Issue issues #63
-                if code.co_filename == "<__array_function__ internals>":
-                    modulename = "numpy.__array_function__"
-                else:
-                    modulename = "unkown"
+            modulename = base_instrumenter.get_module_name(frame)
             self.scorep_bindings.region_end(modulename, code.co_name)
         return self.localtrace