i#6934: Initial commit for Memory trace synthesis framework from Instruction Replay, useful for kernel memtracing and beyond

clients/drcachesim/CMakeLists.txt

@@ -168,6 +168,11 @@ add_exported_library(drmemtrace_func_view STATIC tools/func_view.cpp)
 add_exported_library(drmemtrace_invariant_checker STATIC tools/invariant_checker.cpp)
 add_exported_library(drmemtrace_schedule_stats STATIC tools/schedule_stats.cpp)
 add_exported_library(drmemtrace_schedule_file STATIC common/schedule_file.cpp)
+add_exported_library(drmemtrace_access_region STATIC tools/access_region.cpp)
+add_exported_library(drmemtrace_reuse_pattern STATIC tools/reuse_pattern.cpp)
+
+add_subdirectory(mirage)
+target_link_libraries(drmemtrace_reuse_pattern mirage)
 
 target_link_libraries(drmemtrace_invariant_checker drdecode drmemtrace_schedule_file)
 
@@ -213,6 +218,7 @@ if (BUILD_PT_POST_PROCESSOR)
   add_subdirectory(drpt2trace)
 endif (BUILD_PT_POST_PROCESSOR)
 
+
 set(raw2trace_srcs
   tracer/raw2trace.cpp
   tracer/raw2trace_shared.cpp
@@ -284,7 +290,7 @@ target_link_libraries(drmemtrace_launcher drmemtrace_simulator drmemtrace_reuse_
   drmemtrace_histogram drmemtrace_reuse_time drmemtrace_basic_counts
   drmemtrace_opcode_mix drmemtrace_syscall_mix drmemtrace_view drmemtrace_func_view
   drmemtrace_raw2trace directory_iterator drmemtrace_invariant_checker
-  drmemtrace_schedule_stats drmemtrace_record_filter)
+  drmemtrace_schedule_stats drmemtrace_record_filter drmemtrace_access_region drmemtrace_reuse_pattern)
 if (UNIX)
     target_link_libraries(drmemtrace_launcher dl)
 endif ()
@@ -316,6 +322,7 @@ include_directories(${CMAKE_CURRENT_SOURCE_DIR})
 if (BUILD_PT_POST_PROCESSOR)
   include_directories(${CMAKE_CURRENT_SOURCE_DIR}/drpt2trace)
 endif (BUILD_PT_POST_PROCESSOR)
+include_directories(${CMAKE_CURRENT_SOURCE_DIR}/mirage)
 
 add_exported_library(drmemtrace_analyzer STATIC
   analyzer.cpp
@@ -366,6 +373,8 @@ install_client_nonDR_header(drmemtrace tools/view_create.h)
 install_client_nonDR_header(drmemtrace tools/func_view_create.h)
 install_client_nonDR_header(drmemtrace tools/filter/record_filter_create.h)
 install_client_nonDR_header(drmemtrace tools/filter/record_filter.h)
+install_client_nonDR_header(drmemtrace tools/access_region_create.h)
+install_client_nonDR_header(drmemtrace tools/reuse_pattern_create.h)
 # TODO i#6412: Create a separate directory for non-tracer headers so that
 # we can more cleanly separate tracer and raw2trace code.
 install_client_nonDR_header(drmemtrace tracer/raw2trace.h)
@@ -596,6 +605,8 @@ restore_nonclient_flags(drmemtrace_analyzer)
 restore_nonclient_flags(drmemtrace_invariant_checker)
 restore_nonclient_flags(drmemtrace_schedule_stats)
 restore_nonclient_flags(drmemtrace_schedule_file)
+restore_nonclient_flags(drmemtrace_access_region)
+restore_nonclient_flags(drmemtrace_reuse_pattern)
 
 # We need to pass /EHsc and we pull in libcmtd into drcachesim from a dep lib.
 # Thus we need to override the /MT with /MTd.
@@ -664,6 +675,8 @@ add_win32_flags(drmemtrace_invariant_checker)
 add_win32_flags(drmemtrace_schedule_stats)
 add_win32_flags(drmemtrace_schedule_file)
 add_win32_flags(directory_iterator)
+add_win32_flags(drmemtrace_access_region)
+add_win32_flags(drmemtrace_reuse_pattern)
 add_win32_flags(test_helpers)
 if (WIN32 AND DEBUG)
   get_target_property(sim_srcs drmemtrace_launcher SOURCES)
@@ -849,7 +862,8 @@ if (BUILD_TESTS)
     drmemtrace_histogram drmemtrace_reuse_time drmemtrace_basic_counts
     drmemtrace_opcode_mix drmemtrace_syscall_mix drmemtrace_view drmemtrace_func_view
     drmemtrace_raw2trace directory_iterator drmemtrace_invariant_checker
-    drmemtrace_schedule_stats drmemtrace_analyzer drmemtrace_record_filter)
+    drmemtrace_schedule_stats drmemtrace_analyzer drmemtrace_record_filter drmemtrace_access_region
+    drmemtrace_reuse_pattern)
   if (UNIX)
     target_link_libraries(tool.drcachesim.core_sharded dl)
   endif ()

clients/drcachesim/analyzer_multi.cpp

@@ -67,6 +67,8 @@
 #include "tools/loader/external_config_file.h"
 #include "tools/loader/external_tool_creator.h"
 #include "tools/filter/record_filter_create.h"
+#include "tools/access_region_create.h"
+#include "tools/reuse_pattern_create.h"
 
 namespace dynamorio {
 namespace drmemtrace {
@@ -270,6 +272,14 @@ analyzer_multi_t::create_analysis_tool_from_options(const std::string &tool)
     } else if (tool == SCHEDULE_STATS) {
         return schedule_stats_tool_create(op_schedule_stats_print_every.get_value(),
                                           op_verbose.get_value());
+    } else if (tool == ACCESS_REGION) {
+        return access_region_tool_create(op_access_region_stack_start.get_value(),
+                                         op_access_region_stack_end.get_value(),
+                                         op_access_region_heap_start.get_value(),
+                                         op_access_region_heap_end.get_value());
+
+    } else if (tool == REUSE_PATTERN) {
+        return reuse_pattern_tool_create();
     } else {
         auto ext_tool = create_external_tool(tool);
         if (ext_tool == nullptr) {

clients/drcachesim/common/options.cpp

@@ -1053,5 +1053,24 @@ droption_t<bool> op_abort_on_invariant_error(
     "total invariant error count is printed at the end; a non-zero error count does not "
     "affect the exit code of the analyzer.");
 
+droption_t<uint64_t> op_access_region_stack_start(
+    DROPTION_SCOPE_ALL, "access_region_stack_start", 0x8000000000000000,
+    "Start of the stack region to analyze",
+    "Specifies the start of the stack region");
+
+droption_t<uint64_t> op_access_region_stack_end(
+    DROPTION_SCOPE_ALL, "access_region_stack_end", 0x7000000000000000,
+    "End of the stack region to analyze",
+    "Specifies the end of the stack region");
+
+droption_t<uint64_t> op_access_region_heap_start(
+    DROPTION_SCOPE_ALL, "access_region_heap_start", 0x5000000000000000, 
+    "Start of the heap region to analyze",
+    "Specifies the start of the heap region");
+
+droption_t<uint64_t> op_access_region_heap_end(
+    DROPTION_SCOPE_ALL, "access_region_heap_end",  0x6000000000000000,
+    "End of the heap region to analyze",
+    "Specifies the end of the heap region");
 } // namespace drmemtrace
 } // namespace dynamorio

clients/drcachesim/common/options.h

@@ -53,7 +53,8 @@
 #define INVARIANT_CHECKER "invariant_checker"
 #define SCHEDULE_STATS "schedule_stats"
 #define RECORD_FILTER "record_filter"
-
+#define ACCESS_REGION "access_region"
+#define REUSE_PATTERN "reuse_pattern"
 // Constants used by specific tools.
 #define REPLACE_POLICY_NON_SPECIFIED ""
 #define REPLACE_POLICY_LRU "LRU"
@@ -224,6 +225,10 @@ extern dynamorio::droption::droption_t<uint64_t> op_trim_before_timestamp;
 extern dynamorio::droption::droption_t<uint64_t> op_trim_after_timestamp;
 extern dynamorio::droption::droption_t<bool> op_abort_on_invariant_error;
 
+extern dynamorio::droption::droption_t<uint64_t> op_access_region_stack_start;
+extern dynamorio::droption::droption_t<uint64_t> op_access_region_stack_end;
+extern dynamorio::droption::droption_t<uint64_t> op_access_region_heap_start;
+extern dynamorio::droption::droption_t<uint64_t> op_access_region_heap_end;
 } // namespace drmemtrace
 } // namespace dynamorio
 

clients/drcachesim/mirage/CMakeLists.txt

@@ -0,0 +1,40 @@
+cmake_minimum_required(VERSION 3.7)
+
+include (../../../make/policies.cmake NO_POLICY_SCOPE)
+
+if (NOT LINUX OR NOT X86 OR NOT X64)
+  message(FATAL_ERROR "This is only for Linux x86_64.")
+endif ()
+
+add_dr_defines()
+
+set(mirage_srcs
+    dr_mir_api.cpp
+    # common - shared code
+    ./common/list.cpp
+    ./common/bitmap.cpp
+    # frontend - translating DRIR to MIR
+    ./fe/gen_ops.cpp
+    ./fe/gen_opnd_api.cpp
+    ./fe/translate_context.cpp
+    # backend - interpreting MIR
+    # ./be/*.cpp
+    # interpreter - MIR specification
+    ./ir/mir_insn.cpp
+)
+
+add_library(mirage STATIC ${mirage_srcs})
+
+target_include_directories(mirage PUBLIC
+    $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/common>
+    $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/fe>
+    $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/ir>
+    $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/be>
+)
+
+configure_DynamoRIO_decoder(mirage)
+add_dependencies(mirage api_headers)
+target_link_libraries(mirage)
+install_client_nonDR_header(drmemtrace dr_mir_api.h)
+DR_export_target(mirage)
+install_exported_target(mirage ${INSTALL_CLIENTS_LIB})

clients/drcachesim/mirage/common/bitmap.cpp

@@ -0,0 +1,21 @@
+#include "bitmap.h"
+
+struct bitmap_t *bitmap_create(uint32_t size) {
+    struct bitmap_t* b = (struct bitmap_t*)malloc(sizeof(struct bitmap_t));
+    assert(b != NULL);
+    b->size = size;
+    b->bits = (bool*)calloc(size, sizeof(bool)); 
+    assert(b->bits != NULL);
+    return b;
+}
+
+int bitmap_acquire(struct bitmap_t *bitmap) {
+    // find the first available bit
+    for (uint32_t i = 0; i < bitmap->size; i++) {
+        if (bitmap->bits[i] == false) {
+            bitmap->bits[i] = true;
+            return i;
+        }
+    }
+    return -1;
+}

clients/drcachesim/mirage/common/bitmap.h

@@ -0,0 +1,19 @@
+#ifndef __BITMAP_H__
+#define __BITMAP_H__
+
+// a simple bitmap implementation
+#include <stdint.h>
+#include <stdbool.h>
+#include <stdlib.h>
+#include "assert.h"
+
+
+struct bitmap_t {
+    uint32_t size;
+    bool *bits;
+};
+
+struct bitmap_t *bitmap_create(uint32_t size);
+int bitmap_acquire(struct bitmap_t *bitmap);
+
+#endif // __BITMAP_H__