add user rewind support

Author: AndreasGocht

scorep/trace.py

@@ -135,6 +135,34 @@ def user_region_begin(self, name, file_name=None, line_number=None):
 
     def user_region_end(self, name):
         self.scorep_bindings.region_end("user", name)
+        
+    def rewind_begin(self, name, file_name=None, line_number=None):
+        """
+        Begin of an Rewind 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"
+
+        self.scorep_bindings.rewind_begin(name, full_file_name, line_number)
+
+    def rewind_end(self, name, value):
+        """
+        End of an Rewind region.
+        @param name name of the user region
+        @param value True or False, whenether the region shall be rewinded or not.
+        """
+        self.scorep_bindings.rewind_end(name, value)
+        
 
     def oa_region_begin(self, name, file_name=None, line_number=None):
         """

scorep/user.py

@@ -30,6 +30,35 @@ def region_begin(name, file_name=None, line_number=None):
 def region_end(name):
     global_trace.user_region_end(name)
 
+def rewind_begin(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
+    """
+    global_trace.unregister()
+    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"
+
+    global_trace.rewind_begin(name, full_file_name, line_number)
+    global_trace.register()
+
+
+def rewind_end(name, value):
+    """
+    End of an Rewind region.
+    @param name name of the user region
+    @param value True or False, whenether the region shall be rewinded or not.
+    """            
+    global_trace.rewind_end(name, value)
 
 def oa_region_begin(name, file_name=None, line_number=None):
     global_trace.unregister()

src/scorep.cpp

@@ -18,6 +18,7 @@ struct region_handle
 };
 
 static std::unordered_map<std::string, region_handle> regions;
+static std::unordered_map<std::string, region_handle> rewind_regions;
 
 void region_begin(std::string region_name, std::string module, std::string file_name,
                   std::uint64_t line_number)
@@ -41,6 +42,29 @@ void region_end(std::string region_name)
     SCOREP_User_RegionEnd(handle.value);
 }
 
+void rewind_begin(std::string region_name, std::string file_name, std::uint64_t line_number)
+{
+    auto pair = rewind_regions.emplace(make_pair(region_name, region_handle()));
+    bool inserted_new = pair.second;
+    auto& handle = pair.first->second;
+    if (inserted_new)
+    {
+        SCOREP_User_RegionInit(&handle.value, NULL, &SCOREP_User_LastFileHandle,
+                               region_name.c_str(), SCOREP_USER_REGION_TYPE_FUNCTION,
+                               file_name.c_str(), line_number);
+    }
+    SCOREP_User_RewindRegionEnter(handle.value);
+}
+
+void rewind_end(std::string region_name, bool value)
+{
+    auto& handle = rewind_regions[region_name];
+    /* don't call SCOREP_ExitRewindRegion, as
+     * SCOREP_User_RewindRegionEnd does some additional magic
+     * */
+    SCOREP_User_RewindRegionEnd(handle.value, value);
+}
+
 void parameter_int(std::string name, int64_t value)
 {
     static SCOREP_User_ParameterHandle scorep_param = SCOREP_USER_INVALID_PARAMETER;
@@ -140,6 +164,36 @@ extern "C"
         return Py_None;
     }
 
+    static PyObject* rewind_begin(PyObject* self, PyObject* args)
+    {
+        const char* region_name;
+        const char* file_name;
+        std::uint64_t line_number = 0;
+
+        if (!PyArg_ParseTuple(args, "ssK", &region_name, &file_name, &line_number))
+            return NULL;
+
+        scorep::rewind_begin(region_name, file_name, line_number);
+
+        Py_INCREF(Py_None);
+        return Py_None;
+    }
+
+    static PyObject* rewind_end(PyObject* self, PyObject* args)
+    {
+        const char* region_name;
+        PyObject* value; // false C-Style
+
+        if (!PyArg_ParseTuple(args, "sO", &region_name, &value))
+            return NULL;
+
+        // TODO cover PyObject_IsTrue(value) == -1 (error case)
+        scorep::rewind_end(region_name, PyObject_IsTrue(value) == 1);
+
+        Py_INCREF(Py_None);
+        return Py_None;
+    }
+
     static PyObject* oa_region_begin(PyObject* self, PyObject* args)
     {
         const char* region;
@@ -219,6 +273,8 @@ extern "C"
     static PyMethodDef ScorePMethods[] = {
         { "region_begin", region_begin, METH_VARARGS, "enter a region." },
         { "region_end", region_end, METH_VARARGS, "exit a region." },
+        { "rewind_begin", rewind_begin, METH_VARARGS, "rewind begin." },
+        { "rewind_end", rewind_end, METH_VARARGS, "rewind end." },
         { "oa_region_begin", oa_region_begin, METH_VARARGS, "enter an online access region." },
         { "oa_region_end", oa_region_end, METH_VARARGS, "exit an online access region." },
         { "enable_recording", enable_recording, METH_VARARGS, "disable scorep recording." },

test/test.py

@@ -85,6 +85,32 @@ def test_user_regions(self):
         self.assertRegex(std_out,
                          'LEAVE[ ]*[0-9 ]*[0-9 ]*Region: "user:test_region"')
 
+    def test_user_rewind(self):
+        env = self.env
+        env["SCOREP_EXPERIMENT_DIRECTORY"] += "/test_user_rewind"
+        trace_path = env["SCOREP_EXPERIMENT_DIRECTORY"] + "/traces.otf2"
+
+        out = call([self.python,
+                    "-m",
+                    "scorep",                              
+                    "test_user_rewind.py"],
+                    env=env)
+        std_out = out[1]
+        std_err = out[2]
+        
+        self.assertEqual(std_err, self.expected_std_err)
+        self.assertEqual(std_out, "hello world\nhello world\n")
+
+        out = call(["otf2-print", trace_path])
+        std_out = out[1]
+        std_err = out[2]
+        
+        self.assertRegex(std_out,
+                         'MEASUREMENT_ON_OFF[ ]*[0-9 ]*[0-9 ]*Mode: OFF')
+        self.assertRegex(std_out,
+                         'MEASUREMENT_ON_OFF[ ]*[0-9 ]*[0-9 ]*Mode: ON')
+
+
     def test_oa_regions(self):
         env = self.env
         env["SCOREP_EXPERIMENT_DIRECTORY"] += "/test_oa_regions"

test/test_user_rewind.py

@@ -0,0 +1,12 @@
+import scorep.user
+
+def bar():
+    print("hello world")
+
+def foo():
+    bar()
+    scorep.user.rewind_begin("test_region")
+    bar()
+    scorep.user.rewind_end("test_region",True)
+
+foo()