Merge pull request #127 from AndreasGocht/master

Add a decorator for instrumenter handling and add check for exec rights

Author: AndreasGocht

scorep/instrumenter.py

@@ -2,6 +2,7 @@
 import os
 import platform
 import sys
+import functools
 
 global_instrumenter = None
 
@@ -74,13 +75,29 @@ class enable():
     If a region name is given, the region the contextmanager is active will be marked in the trace or profile
     """
 
-    def __init__(self, region_name=None):
+    def __init__(self, region_name=""):
         self.region_name = region_name
+        if region_name == "":
+            self.user_region_name = False
+        else:
+            self.user_region_name = True
+        self.module_name = ""
+
+    def _recreate_cm(self):
+        return self
+
+    def __call__(self, func):
+        with disable():
+            @functools.wraps(func)
+            def inner(*args, **kwds):
+                with self._recreate_cm():
+                    return func(*args, **kwds)
+        return inner
 
     def __enter__(self):
         self.tracer_registered = get_instrumenter().get_registered()
         if not self.tracer_registered:
-            if self.region_name:
+            if self.user_region_name:
                 self.module_name = "user_instrumenter"
                 frame = inspect.currentframe().f_back
                 file_name = frame.f_globals.get('__file__', None)
@@ -96,11 +113,11 @@ def __enter__(self):
 
             get_instrumenter().register()
 
-    def __exit__(self, exc_type, exc_value, traceback):
+    def __exit__(self, exc_type=None, exc_value=None, traceback=None):
         if not self.tracer_registered:
             get_instrumenter().unregister()
 
-            if self.region_name is not None:
+            if self.user_region_name:
                 get_instrumenter().region_end(
                     self.module_name, self.region_name)
 
@@ -116,15 +133,35 @@ class disable():
     If a region name is given, the region the contextmanager is active will be marked in the trace or profile
     """
 
-    def __init__(self, region_name=None):
+    def __init__(self, region_name=""):
         self.region_name = region_name
+        if region_name == "":
+            self.user_region_name = False
+        else:
+            self.user_region_name = True
+        self.module_name = ""
+        self.func = None
+
+    def _recreate_cm(self):
+        return self
+
+    def __call__(self, func):
+        self.__enter__()
+        try:
+            @functools.wraps(func)
+            def inner(*args, **kwds):
+                with self._recreate_cm():
+                    return func(*args, **kwds)
+        finally:
+            self.__exit__()
+        return inner
 
     def __enter__(self):
         self.tracer_registered = get_instrumenter().get_registered()
         if self.tracer_registered:
             get_instrumenter().unregister()
 
-            if self.region_name is not None:
+            if self.user_region_name:
                 self.module_name = "user_instrumenter"
                 frame = inspect.currentframe().f_back
                 file_name = frame.f_globals.get('__file__', None)
@@ -138,9 +175,9 @@ def __enter__(self):
                     self.module_name, self.region_name, full_file_name,
                     line_number)
 
-    def __exit__(self, exc_type, exc_value, traceback):
+    def __exit__(self, exc_type=None, exc_value=None, traceback=None):
         if self.tracer_registered:
-            if self.region_name is not None:
+            if self.user_region_name:
                 get_instrumenter().region_end(
                     self.module_name, self.region_name)
 

test/cases/user_instrumentation.py

@@ -4,9 +4,16 @@
 
 def foo():
     print("hello world")
-    instrumentation2.baz()
     instrumentation2.bar()
 
 
+@scorep.instrumenter.enable()
+def foo2():
+    print("hello world2")
+    instrumentation2.baz()
+
+
 with scorep.instrumenter.enable():
     foo()
+
+foo2()

test/test_scorep.py

@@ -234,13 +234,19 @@ def test_user_instrumentation(scorep_env, instrumenter):
     )
 
     assert std_err == ""
-    assert std_out == "hello world\nbaz\nbar\n"
+    assert std_out == "hello world\nbar\nhello world2\nbaz\n"
 
     std_out, std_err = call(["otf2-print", trace_path])
 
     assert std_err == ""
     assert re.search('ENTER[ ]*[0-9 ]*[0-9 ]*Region: "__main__:foo"', std_out)
     assert re.search('LEAVE[ ]*[0-9 ]*[0-9 ]*Region: "__main__:foo"', std_out)
+    assert re.search('ENTER[ ]*[0-9 ]*[0-9 ]*Region: "__main__:foo2"', std_out)
+    assert re.search('LEAVE[ ]*[0-9 ]*[0-9 ]*Region: "__main__:foo2"', std_out)
+    assert re.search('ENTER[ ]*[0-9 ]*[0-9 ]*Region: "instrumentation2:bar"', std_out)
+    assert re.search('LEAVE[ ]*[0-9 ]*[0-9 ]*Region: "instrumentation2:bar"', std_out)
+    assert re.search('ENTER[ ]*[0-9 ]*[0-9 ]*Region: "instrumentation2:baz"', std_out)
+    assert re.search('LEAVE[ ]*[0-9 ]*[0-9 ]*Region: "instrumentation2:baz"', std_out)
 
 
 @foreach_instrumenter