Fix to accommodate annotations.

google · Nov 27, 2023 · 8cb7bb1 · 8cb7bb1
1 parent 555ef25
commit 8cb7bb1
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 3 deletions.
diff --git a/gematria/basic_block/basic_block.cc b/gematria/basic_block/basic_block.cc
@@ -329,7 +329,16 @@ std::string Instruction::ToString() const {
   add_operand_list("output_operands", output_operands);
   add_operand_list("implicit_output_operands", implicit_output_operands);
 
-  // TODO(virajbshah): Include instruction annotations at the end of the string.
+  if (!instruction_annotations.empty()) {
+    buffer << "instruction_annotations=(";
+    for (const Annotation& annotation : instruction_annotations) {
+      buffer << annotation.ToString() << ", ";
+    }
+    // Pop only the trailing space. For simplicity, we leave the trailing comma
+    // which is required in case there is only one element.
+    buffer.seekp(-1, std::ios_base::end);
+    buffer << "), ";
+  }
 
   auto msg = buffer.str();
   assert(msg.size() >= 2);

diff --git a/gematria/basic_block/basic_block_test.cc b/gematria/basic_block/basic_block_test.cc
@@ -406,7 +406,8 @@ TEST(InstructionTest, ToString) {
       "InstructionOperand.from_register('RBX'),), "
       "implicit_input_operands=(InstructionOperand.from_register('EFLAGS'),), "
       "output_operands=(InstructionOperand.from_register('RAX'),), "
-      "implicit_output_operands=(InstructionOperand.from_register('EFLAGS'),))";
+      "implicit_output_operands=(InstructionOperand.from_register('EFLAGS'),), "
+      "instruction_annotations=(Annotation(name='MEM_LOAD_RETIRED:L3_MISS', value=0.875),))";
   EXPECT_EQ(instruction.ToString(), kExpectedString);
 }
 
@@ -583,7 +584,8 @@ TEST(BasicBlockTest, ToString) {
       "InstructionOperand.from_register('RBX'),), "
       "implicit_input_operands=(InstructionOperand.from_register('EFLAGS'),), "
       "output_operands=(InstructionOperand.from_register('RAX'),), "
-      "implicit_output_operands=(InstructionOperand.from_register('EFLAGS'),)),"
+      "implicit_output_operands=(InstructionOperand.from_register('EFLAGS'),), "
+      "instruction_annotations=(Annotation(name='MEM_LOAD_RETIRED:L3_MISS', value=0.875),)),"
       ")))";
   EXPECT_EQ(block.ToString(), kExpectedString);
 }