i#6662 public traces, part 2: encoding_filter

clients/drcachesim/CMakeLists.txt

@@ -199,7 +199,8 @@ add_exported_library(drmemtrace_record_filter STATIC
   tools/filter/type_filter.h
   tools/filter/encodings2regdeps.h
   tools/filter/null_filter.h)
-target_link_libraries(drmemtrace_record_filter drmemtrace_simulator dynamorio)
+target_link_libraries(drmemtrace_record_filter drmemtrace_simulator)
+configure_DynamoRIO_standalone(drmemtrace_record_filter)
 
 add_exported_library(directory_iterator STATIC common/directory_iterator.cpp)
 add_dependencies(directory_iterator api_headers)

clients/drcachesim/common/trace_entry.h

@@ -476,8 +476,11 @@ typedef enum {
     TRACE_MARKER_TYPE_CHUNK_INSTR_COUNT,
 
     /**
-     * Marks the end of a chunk.  The final chunk does not have such a marker
-     * but instead relies on the #TRACE_TYPE_FOOTER entry.
+     * Marks the end of a chunk.  The value of this marker is the chunk ordinal, which
+     * is an increasing counter set by #dynamorio::drmemtrace::record_filter_t starting
+     * from 0.
+     * The final chunk does not have such a marker but instead relies on the
+     * #TRACE_TYPE_FOOTER entry.
      */
     TRACE_MARKER_TYPE_CHUNK_FOOTER,
 

clients/drcachesim/tests/record_filter_unit_tests.cpp

@@ -292,6 +292,9 @@ process_entries_and_check_result(test_record_filter_t *record_filter,
 static bool
 test_encodings2regdeps_filter()
 {
+    constexpr addr_t PC = 0x7f6fdd3ec360;
+    constexpr addr_t ENCODING_REAL_ISA = 0xe78948;
+    constexpr addr_t ENCODING_REGDEPS_ISA = 0x0006090600010011;
     std::vector<test_case_t> entries = {
         // Trace shard header.
         { { TRACE_TYPE_HEADER, 0, { 0x1 } }, true, { true } },
@@ -314,27 +317,46 @@ test_encodings2regdeps_filter()
         { { TRACE_TYPE_MARKER, TRACE_MARKER_TYPE_CACHE_LINE_SIZE, { 0x6 } },
           true,
           { true } },
-        // Unit header.
+        { { TRACE_TYPE_MARKER, TRACE_MARKER_TYPE_CHUNK_INSTR_COUNT, { 0x3 } },
+          true,
+          { true } },
+
+        // Chunk 1.
         { { TRACE_TYPE_MARKER, TRACE_MARKER_TYPE_TIMESTAMP, { 0x7 } }, true, { true } },
         { { TRACE_TYPE_MARKER, TRACE_MARKER_TYPE_CPU_ID, { 0x8 } }, true, { true } },
         // Encoding, modified by the record_filter encodings2regdeps.
-        { { TRACE_TYPE_ENCODING, 4, { 0xe78948 } }, true, { false } },
-        { { TRACE_TYPE_ENCODING, 8, { 0x0006090600010011 } }, false, { true } },
-        { { TRACE_TYPE_INSTR, 3, { 0x7f6fdd3ec360 } }, true, { true } },
-        // Same instr same chunk.
-        { { TRACE_TYPE_INSTR, 3, { 0x7f6fdd3ec360 } }, true, { true } },
-        // Unit header.
-        { { TRACE_TYPE_MARKER, TRACE_MARKER_TYPE_TIMESTAMP, { 0xc } }, true, { true } },
-        { { TRACE_TYPE_MARKER, TRACE_MARKER_TYPE_CPU_ID, { 0xd } }, true, { true } },
+        { { TRACE_TYPE_ENCODING, 3, { ENCODING_REAL_ISA } }, true, { false } },
+        { { TRACE_TYPE_ENCODING, 8, { ENCODING_REGDEPS_ISA } }, false, { true } },
+        { { TRACE_TYPE_INSTR, 3, { PC } }, true, { true } },
+        { { TRACE_TYPE_INSTR, 3, { PC } }, true, { true } },
+        { { TRACE_TYPE_INSTR, 3, { PC } }, true, { true } },
+        { { TRACE_TYPE_MARKER, TRACE_MARKER_TYPE_CHUNK_FOOTER, { 0 } }, true, { true } },
+
+        // Chunk 2.
+        { { TRACE_TYPE_MARKER, TRACE_MARKER_TYPE_RECORD_ORDINAL, { 0xa } },
+          true,
+          { true } },
+        { { TRACE_TYPE_MARKER, TRACE_MARKER_TYPE_TIMESTAMP, { 0x7 } }, true, { true } },
+        { { TRACE_TYPE_MARKER, TRACE_MARKER_TYPE_CPU_ID, { 0x8 } }, true, { true } },
         // Duplicated encoding across chunk boundary.
-        { { TRACE_TYPE_ENCODING, 4, { 0xe78948 } }, true, { false } },
-        { { TRACE_TYPE_ENCODING, 8, { 0x0006090600010011 } }, false, { true } },
-        { { TRACE_TYPE_INSTR, 3, { 0x7f6fdd3ec360 } }, true, { true } },
-        // Unit header.
-        { { TRACE_TYPE_MARKER, TRACE_MARKER_TYPE_TIMESTAMP, { 0xe } }, true, { true } },
-        { { TRACE_TYPE_MARKER, TRACE_MARKER_TYPE_CPU_ID, { 0xf } }, true, { true } },
-        // Same instr in different chunk.
-        { { TRACE_TYPE_INSTR, 3, { 0x7f6fdd3ec360 } }, true, { true } },
+        { { TRACE_TYPE_ENCODING, 3, { ENCODING_REAL_ISA } }, true, { false } },
+        { { TRACE_TYPE_ENCODING, 8, { ENCODING_REGDEPS_ISA } }, false, { true } },
+        { { TRACE_TYPE_INSTR, 3, { PC } }, true, { true } },
+        { { TRACE_TYPE_INSTR, 3, { PC } }, true, { true } },
+        { { TRACE_TYPE_INSTR, 3, { PC } }, true, { true } },
+        { { TRACE_TYPE_MARKER, TRACE_MARKER_TYPE_CHUNK_FOOTER, { 1 } }, true, { true } },
+
+        // Chunk 3.
+        { { TRACE_TYPE_MARKER, TRACE_MARKER_TYPE_RECORD_ORDINAL, { 0xe } },
+          true,
+          { true } },
+        { { TRACE_TYPE_MARKER, TRACE_MARKER_TYPE_TIMESTAMP, { 0x7 } }, true, { true } },
+        { { TRACE_TYPE_MARKER, TRACE_MARKER_TYPE_CPU_ID, { 0x8 } }, true, { true } },
+        // Same instr in different chunk. We expect record_filter to add
+        // ENCODING_REGDEPS_ISA here (not ENCODING_REAL_ISA).
+        { { TRACE_TYPE_ENCODING, 8, { ENCODING_REGDEPS_ISA } }, false, { true } },
+        { { TRACE_TYPE_INSTR, 3, { PC } }, true, { true } },
+        { { TRACE_TYPE_INSTR, 3, { PC } }, true, { true } },
         // Trace shard footer.
         { { TRACE_TYPE_FOOTER, 0, { 0x0 } }, true, { true } },
     };
@@ -350,7 +372,7 @@ test_encodings2regdeps_filter()
     }
     filters.push_back(std::move(encodings2regdeps_filter));
     auto record_filter = std::unique_ptr<test_record_filter_t>(
-        new test_record_filter_t(std::move(filters), 0));
+        new test_record_filter_t(std::move(filters), 0, /*write_archive=*/true));
     if (!process_entries_and_check_result(record_filter.get(), entries, 0))
         return false;