Parse new LLVM debug info instructions.

Author: rschatz

sulong/projects/com.oracle.truffle.llvm.parser/src/com/oracle/truffle/llvm/parser/listeners/Function.java

@@ -29,12 +29,20 @@
  */
 package com.oracle.truffle.llvm.parser.listeners;
 
+import java.util.ArrayDeque;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+
 import com.oracle.truffle.llvm.parser.metadata.MDBaseNode;
+import com.oracle.truffle.llvm.parser.metadata.MDExpression;
 import com.oracle.truffle.llvm.parser.metadata.MDKind;
+import com.oracle.truffle.llvm.parser.metadata.MDLocalVariable;
 import com.oracle.truffle.llvm.parser.metadata.MDLocation;
 import com.oracle.truffle.llvm.parser.metadata.MDSubprogram;
 import com.oracle.truffle.llvm.parser.metadata.MDValue;
 import com.oracle.truffle.llvm.parser.model.IRScope;
+import com.oracle.truffle.llvm.parser.model.SymbolImpl;
 import com.oracle.truffle.llvm.parser.model.attributes.AttributesCodeEntry;
 import com.oracle.truffle.llvm.parser.model.blocks.InstructionBlock;
 import com.oracle.truffle.llvm.parser.model.functions.FunctionDefinition;
@@ -51,6 +59,8 @@
 import com.oracle.truffle.llvm.parser.model.symbols.instructions.CompareExchangeInstruction;
 import com.oracle.truffle.llvm.parser.model.symbols.instructions.CompareInstruction;
 import com.oracle.truffle.llvm.parser.model.symbols.instructions.ConditionalBranchInstruction;
+import com.oracle.truffle.llvm.parser.model.symbols.instructions.DebugInstruction;
+import com.oracle.truffle.llvm.parser.model.symbols.instructions.DebugInstruction.DebugInstructionKind;
 import com.oracle.truffle.llvm.parser.model.symbols.instructions.ExtractElementInstruction;
 import com.oracle.truffle.llvm.parser.model.symbols.instructions.ExtractValueInstruction;
 import com.oracle.truffle.llvm.parser.model.symbols.instructions.FenceInstruction;
@@ -93,11 +103,6 @@
 import com.oracle.truffle.llvm.runtime.types.VectorType;
 import com.oracle.truffle.llvm.runtime.types.VoidType;
 
-import java.util.ArrayDeque;
-import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.List;
-
 public final class Function implements ParserListener {
 
     // See https://github.com/llvm/llvm-project/blob/main/llvm/include/llvm/Bitcode/LLVMBitCodes.h
@@ -252,12 +257,19 @@ public void record(RecordBuffer buffer) {
                 // since we consume only bitcode after linking, it's safe to ignore
                 return;
 
+            case INSTRUCTION_DEBUG_RECORD_ASSIGN:
+                // https://llvm.org/docs/AssignmentTracking.html
+                // not used by Sulong
+                // parseDebugInstruction(opCode, buffer);
+                return;
+
             case INSTRUCTION_DEBUG_RECORD_VALUE:
             case INSTRUCTION_DEBUG_RECORD_DECLARE:
-            case INSTRUCTION_DEBUG_RECORD_ASSIGN:
             case INSTRUCTION_DEBUG_RECORD_VALUE_SIMPLE:
+                parseDebugInstruction(opCode, buffer);
+                return;
+
             case INSTRUCTION_DEBUG_RECORD_LABEL:
-                // TODO parse debug info
                 return;
 
             default:
@@ -467,6 +479,10 @@ private void emit(VoidInstruction instruction) {
         scope.addInstruction(instruction);
     }
 
+    private void emitDebug(DebugInstruction instruction) {
+        instructionBlock.addDebug(instruction);
+    }
+
     private static final int INVOKE_HASEXPLICITFUNCTIONTYPE_SHIFT = 13;
 
     private void attachOperandBundle(RecordBuffer buffer) {
@@ -851,6 +867,32 @@ private void applyDebugLocation() {
         instructionBlock.getInstruction(lastInstructionIndex).setDebugLocation(lastLocation);
     }
 
+    private void parseDebugInstruction(int opCode, RecordBuffer buffer) {
+        MDLocation dil = (MDLocation) scope.getMetadata().getOrNull(buffer.readInt());
+        MDLocalVariable variable = (MDLocalVariable) scope.getMetadata().getOrNull(buffer.readInt());
+        MDExpression expression = (MDExpression) scope.getMetadata().getOrNull(buffer.readInt());
+
+        MDBaseNode value;
+        if (opCode == INSTRUCTION_DEBUG_RECORD_VALUE_SIMPLE) {
+            // this is never forward referenced, see comment and assert in BitcodeReader.cpp:6517
+            int index = readIndexSkipType(buffer);
+            SymbolImpl symbol = scope.getSymbols().getOrNull(index);
+            value = MDValue.create(symbol);
+        } else {
+            value = scope.getMetadata().getOrNull(buffer.readInt());
+        }
+
+        switch (opCode) {
+            case INSTRUCTION_DEBUG_RECORD_DECLARE:
+                emitDebug(new DebugInstruction(DebugInstructionKind.DECLARE, dil, variable, expression, value));
+                break;
+            case INSTRUCTION_DEBUG_RECORD_VALUE:
+            case INSTRUCTION_DEBUG_RECORD_VALUE_SIMPLE:
+                emitDebug(new DebugInstruction(DebugInstructionKind.VALUE, dil, variable, expression, value));
+                break;
+        }
+    }
+
     private void createAtomicStore(RecordBuffer buffer) {
         int destination = readIndexSkipType(buffer);
         int source = readIndexSkipType(buffer);