Merge pull request #50 from score-p/issue-49

Implement a decorator to manually instrument functions

* decorator can be used to specify user region names
* if no region name is specified the region is only added if the instrumenter is disabled
* fix a bug in the dummy instrumenter, which did not even lunch the program

Author: AndreasGocht

README.md

@@ -53,17 +53,39 @@ with scorep.user.region("region_name"):
     do_something()
 ```
 
-The traditional calls to  define a region and log some parameters, still exists:
+Since version 2.1 the python bindings support also decorators for functions:
+
+```
+@scorep.user.region("region_name")
+def do_something():
+    #do some things
+```
+If no region name is given, the function name will be used e.g.:
+
+```
+@scorep.user.region()
+def do_something():
+    #do some things
+```
+
+will result in `__main__:do_something`.
+
+The traditional calls to define a region still exists, but the usage is discouraged:
+
+```
+scorep.user.region_begin("region_name")
+scorep.user.region_end("region_name")
+```
+
+User parameters can be used in any case:
 
 ```
-scorep.user.region_begin(name)
 scorep.user.parameter_int(name, val)
 scorep.user.parameter_uint(name, val)
 scorep.user.parameter_string(name, string)
-scorep.user.region_end(name)
 ```
 
-`name` defines the name of the parameter or region, while `val` or `string` represents the value that is passed to Score-P. 
+where `name` defines the name of the parameter or region, while `val` or `string` represents the value that is passed to Score-P. 
 
 Disabeling the recording with Score-P is still also possilbe:
 
@@ -72,7 +94,7 @@ scorep.user.enable_recording()
 scorep.user.disable_recording()
 ```
 
-However, please be aware that the runtime impact is rather small, as the instrumenter is still active. For details about the instrumenter, please see [Instrumenter](#Instrumenter).  
+However, please be aware that the runtime impact of disabeling Score-P is rather small, as the instrumenter is still active. For details about the instrumenter, please see [Instrumenter](#Instrumenter).  
 
 ### Instrumenter
 With version 2.0 of the python bindings, the term "instrumenter" is introduced. The instrumenter describes the class that maps the Python `trace` or `profile` events to Score-P. Please be aware, that `trace` and `profile` does not refer to the traditional Score-P terms of tracing and profiling, but to the Python functions [sys.settrace](https://docs.python.org/3/library/sys.html#sys.settrace) and [sys.setprofile](https://docs.python.org/3/library/sys.html#sys.setprofile).

scorep/instrumenter.py

@@ -65,10 +65,13 @@ def __init__(self):
         pass
 
     def __enter__(self):
-        self.tracer_registered = get_instrumenter().register()
+        self.tracer_registered = scorep.instrumenter.get_instrumenter().get_registered()
+        if not self.tracer_registered:
+            scorep.instrumenter.get_instrumenter().register()
 
     def __exit__(self, exc_type, exc_value, traceback):
-        self.tracer_registered = get_instrumenter().unregister()
+        if not self.tracer_registered:
+            scorep.instrumenter.get_instrumenter().unregister()
 
 
 class disable():
@@ -85,7 +88,10 @@ def __init__(self):
         pass
 
     def __enter__(self):
-        self.tracer_registered = get_instrumenter().unregister()
+        self.tracer_registered = scorep.instrumenter.get_instrumenter().get_registered()
+        if self.tracer_registered:
+            scorep.instrumenter.get_instrumenter().unregister()
 
     def __exit__(self, exc_type, exc_value, traceback):
-        self.tracer_registered = get_instrumenter().register()
+        if self.tracer_registered:
+            scorep.instrumenter.get_instrumenter().register()

scorep/instrumenters/dummy.py

@@ -18,15 +18,19 @@ def run(self, cmd):
         pass
 
     def runctx(self, cmd, globals=None, locals=None):
-        pass
+        if globals is None:
+            globals = {}
+        if locals is None:
+            locals = {}
+        exec(cmd, globals, locals)
 
     def runfunc(self, func, *args, **kw):
         pass
 
-    def user_region_begin(self, name, file_name=None, line_number=None):
+    def region_begin(self, module_name, function_name, file_name, line_number):
         pass
 
-    def user_region_end(self, name):
+    def region_end(self, module_name, function_name):
         pass
 
     def rewind_begin(self, name, file_name=None, line_number=None):

scorep/instrumenters/scorep_profile.py

@@ -102,28 +102,12 @@ def globaltrace_lt(self, frame, why, arg):
         else:
             return
 
-    def user_region_begin(self, name, file_name=None, line_number=None):
-        """
-        Begin of an User region. If file_name or line_number is None, both will
-        bet determined automatically
-        @param name name of the user region
-        @param file_name file name of the user region
-        @param line_number line number of the user region
-        """
-        if file_name is None or line_number is None:
-            frame = inspect.currentframe().f_back
-            file_name = frame.f_globals.get('__file__', None)
-            line_number = frame.f_lineno
-        if file_name is not None:
-            full_file_name = os.path.abspath(file_name)
-        else:
-            full_file_name = "None"
-
+    def region_begin(self, module_name, function_name, file_name, line_number):
         self.scorep_bindings.region_begin(
-            "user", name, full_file_name, line_number)
+            module_name, function_name, file_name, line_number)
 
-    def user_region_end(self, name):
-        self.scorep_bindings.region_end("user", name)
+    def region_end(self, module_name, function_name):
+        self.scorep_bindings.region_end(module_name, function_name)
 
     def rewind_begin(self, name, file_name=None, line_number=None):
         """

scorep/instrumenters/scorep_trace.py

@@ -102,28 +102,12 @@ def localtrace_trace(self, frame, why, arg):
             self.scorep_bindings.region_end(modulename, code.co_name)
         return self.localtrace
 
-    def user_region_begin(self, name, file_name=None, line_number=None):
-        """
-        Begin of an User region. If file_name or line_number is None, both will
-        bet determined automatically
-        @param name name of the user region
-        @param file_name file name of the user region
-        @param line_number line number of the user region
-        """
-        if file_name is None or line_number is None:
-            frame = inspect.currentframe().f_back
-            file_name = frame.f_globals.get('__file__', None)
-            line_number = frame.f_lineno
-        if file_name is not None:
-            full_file_name = os.path.abspath(file_name)
-        else:
-            full_file_name = "None"
-
+    def region_begin(self, module_name, function_name, file_name, line_number):
         self.scorep_bindings.region_begin(
-            "user", name, full_file_name, line_number)
+            module_name, function_name, file_name, line_number)
 
-    def user_region_end(self, name):
-        self.scorep_bindings.region_end("user", name)
+    def region_end(self, module_name, function_name):
+        self.scorep_bindings.region_end(module_name, function_name)
 
     def rewind_begin(self, name, file_name=None, line_number=None):
         """