[Visualizers] Add natvis visualizers for various internal llvm classes

[Trass3r]

Summary

Also improve DisplayStrings for array and string types.

[Trass3r]

@curdeius I built these up over time and would like to upstream them.
Some of them may be out of date now and some things were tricky like the Uses/User stuff so I could use some feedback in general to polish it.

[RKSimon]

llvm/utils/LLVMVisualizers/llvm.natvis

32

Any chance that we can have ArrayRef and SmallVectorImpl show a more similar representation?

[Trass3r]

llvm/utils/LLVMVisualizers/llvm.natvis

32

You mean simplifying SmallVector?
Or changing this one?

[RKSimon]

llvm/utils/LLVMVisualizers/llvm.natvis

32

Whichever is easier would be fine

[aaron.ballman]

FWIW, the changes look reasonable to me. I don't do a whole lot of debugging in LLVM though, so I don't have a good feel for how well the visualizers work in practice.

[RKSimon]

llvm/utils/LLVMVisualizers/llvm.natvis

374

Don't we already have a APInt entry near the top?

[Trass3r]

llvm/utils/LLVMVisualizers/llvm.natvis

374

Good catch. Back then it didn't exist.

[Trass3r]

remove duplicate APInt
update SmallVector

[RKSimon]

Cheers - LGTM with a couple of minors - setting "Tools->Options->Debugging->Ouput Window.NatvisDiagnosticMessages" to verbose seems to be (mostly) happy.

I'm wondering whether this needs to be sorted better (alphanumerically or by context) to make it easier to keep track of all the classes, but its not really that important.

llvm/utils/LLVMVisualizers/llvm.natvis

32

I'm seeing a NatVis verbose warning from this:

Natvis: E:\llvm\llvm-project\llvm\utils\LLVMVisualizers\llvm.natvis(30,4): Warning: Unable to load a visualized preview for type 'llvm::ArrayRef<int>' because the conditions of all <DisplayString> elements were false.

305

Does this work? It always seems to display "{llvm::SDNode ???}" for me

[Trass3r]

llvm/utils/LLVMVisualizers/llvm.natvis

32

Hmm the conditions do cover all values.
Do we perhaps need a <DisplayString>Uninitialized</DisplayString> like above?

305

The method still exists, maybe something goes wrong when it tries to call it?

[RKSimon]

llvm/utils/LLVMVisualizers/llvm.natvis

305

Does it work for you? I'm using VS2022 here.

Otherwise maybe we just cast to (llvm::ISD::NodeType) if < BUILTIN_OP_END ? We can keep the getOperationName call as the fallback

[Trass3r]

change SDNode DisplayString

[Trass3r]

add this-> to make it clear

[Trass3r]

llvm/utils/LLVMVisualizers/llvm.natvis

305

It may have been an unfinished experiment. I replaced it with the NodeType to keep it simple.

[Trass3r]

add fallback DisplayString for ArrayRef

[RKSimon]

cheers

[Trass3r]

Thanks, could you also commit it? I don't have the rights.

llvm/utils/LLVMVisualizers/llvm.natvis

 <?xml version="1.0" encoding="utf-8"?>
 <!--
 Visual Studio Native Debugging Visualizers for LLVM
 
-For Visual Studio 2013 only, put this file into 
+For Visual Studio 2013 only, put this file into
 "%USERPROFILE%\Documents\Visual Studio 2013\Visualizers" or create a symbolic link so it updates automatically.
 
 For later versions of Visual Studio, no setup is required.
 -->
 <AutoVisualizer xmlns="http://schemas.microsoft.com/vstudio/debugger/natvis/2010">
   <Type Name="llvm::SmallVectorImpl&lt;*&gt;">
-    <DisplayString IncludeView ="elt0" Condition="Size == 0"></DisplayString>
-    <DisplayString IncludeView ="elt0">{((value_type*)BeginX)[0]}{*this,view(elt1)}</DisplayString>
-    <DisplayString IncludeView ="elt1" Condition="Size == 1"></DisplayString>
-    <DisplayString IncludeView ="elt1">, {((value_type*)BeginX)[1]}{*this,view(elt2)}</DisplayString>
-    <DisplayString IncludeView ="elt2" Condition="Size == 2"></DisplayString>
-    <DisplayString IncludeView ="elt2">, {((value_type*)BeginX)[2]}{*this,view(elt3)}</DisplayString>
-    <DisplayString IncludeView ="elt3" Condition="Size == 3"></DisplayString>
-    <DisplayString IncludeView ="elt3">, {((value_type*)BeginX)[3]}{*this,view(elt4)}</DisplayString>
-    <DisplayString IncludeView ="elt4" Condition="Size == 4"></DisplayString>
-    <DisplayString IncludeView ="elt4">, /* {Size - 4} more*/ </DisplayString>
     <DisplayString Condition="Size == 0">empty</DisplayString>
-    <DisplayString Condition="Size != 0">{{{*this,view(elt0)}}}</DisplayString>
+    <DisplayString Condition="Size &amp;&amp; Size &lt; 4">{(value_type*)BeginX,[Size]}</DisplayString>
+    <DisplayString Condition="Size &gt; 3">{Size} elements</DisplayString>
     <DisplayString>Uninitialized</DisplayString>
     <Expand>
       <Item Name="[size]">Size</Item>
       <Item Name="[capacity]">Capacity</Item>
       <ArrayItems>
         <Size>Size</Size>
         <ValuePointer>(value_type*)BeginX</ValuePointer>
       </ArrayItems>
     </Expand>
   </Type>
   <Type Name="llvm::APInt">
     <!-- For now, only handle up to 64-bit unsigned ints -->
     <DisplayString Condition="BitWidth &lt;= 64">{U.VAL}</DisplayString>
     <DisplayString>Cannot visualize APInts longer than 64 bits</DisplayString>
   </Type>
   <Type Name="llvm::ArrayRef&lt;*&gt;">
-    <DisplayString Condition="Length == 0">empty</DisplayString>
-    <DisplayString Condition="Length != 0">{{ size={Length} }}</DisplayString>
+    <DisplayString Condition="Length &lt; 4">{Data,[Length]}</DisplayString>
+    <DisplayString Condition="Length &gt; 3">{Length} elements</DisplayString>
+    <DisplayString>Uninitialized</DisplayString>
     <Expand>
       <Item Name="[size]">Length</Item>
       <ArrayItems>
         <Size>Length</Size>
         <ValuePointer>Data</ValuePointer>
       </ArrayItems>
     </Expand>
   </Type>
   <Type Name="llvm::SmallString&lt;*&gt;">
-    <DisplayString>{(const char*)BeginX,[Size] na}</DisplayString>
+    <DisplayString>{(const char*)BeginX,[Size]s8}</DisplayString>
     <StringView>(const char*)BeginX,[Size]</StringView>
     <Expand>
       <Item Name="[size]">Size</Item>
       <Item Name="[capacity]">Capacity</Item>
       <ArrayItems>
         <Size>Size</Size>
         <ValuePointer>(char*)BeginX</ValuePointer>
       </ArrayItems>
     </Expand>
   </Type>
 
   <Type Name="StringView">
-    <DisplayString>{First,[Last - First]s}</DisplayString>
+    <DisplayString>{First,[Last - First]s8}</DisplayString>
   </Type>
-  
   <Type Name="llvm::StringRef">
-    <DisplayString>{Data,[Length]s}</DisplayString>
-    <StringView>Data,[Length]s</StringView>
+    <DisplayString>{Data,[Length]s8}</DisplayString>
+    <StringView>Data,[Length]s8</StringView>
     <Expand>
       <Item Name="[size]">Length</Item>
       <ArrayItems>
         <Size>Length</Size>
         <ValuePointer>Data</ValuePointer>
       </ArrayItems>
     </Expand>
   </Type>
<Expand>
         ($T6)(Val.Value &amp; $T2::InfoTy::PointerBitMask)
       </Item>
       <Item Name="[Holds]" Condition="((Val.Value&gt;&gt;$T2::InfoTy::IntShift) &amp; $T2::InfoTy::IntMask) == 3">"$T6",s8b</Item>
       <Item Name="[Ptr]" Optional="true"  Condition="((Val.Value&gt;&gt;$T2::InfoTy::IntShift) &amp; $T2::InfoTy::IntMask) == 3">
         ($T7)(Val.Value &amp; $T2::InfoTy::PointerBitMask)
       </Item>
     </Expand>
   </Type>
- 
   <Type Name="llvm::iplist&lt;*,*&gt;">
     <DisplayString Condition="Head == 0">{{ empty }}</DisplayString>
     <DisplayString Condition="Head != 0">{{ head={Head} }}</DisplayString>
     <Expand>
       <LinkedListItems>
         <HeadPointer>Head</HeadPointer>
         <NextPointer>Next</NextPointer>
         <ValueNode>this</ValueNode>
<Expand>
         <Size>NumBuckets</Size>
         <ValuePointer>(MapEntryTy**)TheTable</ValuePointer>
       </ArrayItems>
     </Expand>
   </Type>
 
   <Type Name="llvm::StringMapEntry&lt;*&gt;">
     <DisplayString Condition="StrLen == 0">empty</DisplayString>
-    <DisplayString Condition="StrLen != 0">({this+1,s}, {second})</DisplayString>
+    <DisplayString Condition="StrLen != 0">({this+1,s8}, {second})</DisplayString>
     <Expand>
       <Item Name="[key]">this+1,s</Item>
       <Item Name="[value]" Condition="StrLen != 0">second</Item>
     </Expand>
   </Type>
 
   <Type Name="llvm::Triple">
     <DisplayString>{Data}</DisplayString>
   </Type>
-  
   <Type Name="llvm::Optional&lt;*&gt;">
     <DisplayString Condition="!Storage.hasVal">None</DisplayString>
     <DisplayString Condition="Storage.hasVal">{Storage.value}</DisplayString>
     <Expand>
       <Item Name="[underlying]" Condition="Storage.hasVal">Storage.value</Item>
     </Expand>
   </Type>
 
<Type Name="llvm::support::detail::packed_endian_specific_integral&lt;*,*,1&gt;">
     <DisplayString>{{little endian value = {*(($T1*)(unsigned char *)Value.buffer)} }}</DisplayString>
     <Expand>
       <Item Name="[Raw Bytes]" Condition="sizeof($T1)==1">(unsigned char *)Value.buffer,1</Item>
       <Item Name="[Raw Bytes]" Condition="sizeof($T1)==2">(unsigned char *)Value.buffer,2</Item>
       <Item Name="[Raw Bytes]" Condition="sizeof($T1)==4">(unsigned char *)Value.buffer,4</Item>
       <Item Name="[Raw Bytes]" Condition="sizeof($T1)==8">(unsigned char *)Value.buffer,8</Item>
     </Expand>
   </Type>
-  
   <!-- Now handle the hard case of big endian.  We need to do the swizzling here, but
        we need to specialize it based on the size of the value type. -->
   <Type Name="llvm::support::detail::packed_endian_specific_integral&lt;*,0,1&gt;">
     <DisplayString Condition="sizeof($T1)==1">{{ big endian value = {*(unsigned char *)Value.buffer} }}</DisplayString>
-    <DisplayString Condition="sizeof($T1)==2">{{ big endian value = {(($T1)(*(unsigned char *)Value.buffer) &lt;&lt; 8) 
+    <DisplayString Condition="sizeof($T1)==2">{{ big endian value = {(($T1)(*(unsigned char *)Value.buffer) &lt;&lt; 8)
                                                                     | ($T1)(*((unsigned char *)Value.buffer+1))} }}</DisplayString>
-    <DisplayString Condition="sizeof($T1)==4">{{ big endian value = {(($T1)(*(unsigned char *)Value.buffer) &lt;&lt; 24) 
-                                                                    | (($T1)(*((unsigned char *)Value.buffer+1)) &lt;&lt; 16) 
-                                                                    | (($T1)(*((unsigned char *)Value.buffer+2)) &lt;&lt; 8) 
+    <DisplayString Condition="sizeof($T1)==4">{{ big endian value = {(($T1)(*(unsigned char *)Value.buffer) &lt;&lt; 24)
+                                                                    | (($T1)(*((unsigned char *)Value.buffer+1)) &lt;&lt; 16)
+                                                                    | (($T1)(*((unsigned char *)Value.buffer+2)) &lt;&lt; 8)
                                                                     |  ($T1)(*((unsigned char *)Value.buffer+3))} }}</DisplayString>
-    <DisplayString Condition="sizeof($T1)==8">{{ big endian value = {(($T1)(*(unsigned char *)Value.buffer) &lt;&lt; 56) 
-                                                                    | (($T1)(*((unsigned char *)Value.buffer+1)) &lt;&lt; 48) 
-                                                                    | (($T1)(*((unsigned char *)Value.buffer+2)) &lt;&lt; 40) 
-                                                                    | (($T1)(*((unsigned char *)Value.buffer+3)) &lt;&lt; 32) 
-                                                                    | (($T1)(*((unsigned char *)Value.buffer+4)) &lt;&lt; 24) 
-                                                                    | (($T1)(*((unsigned char *)Value.buffer+5)) &lt;&lt; 16) 
-                                                                    | (($T1)(*((unsigned char *)Value.buffer+6)) &lt;&lt; 8) 
+    <DisplayString Condition="sizeof($T1)==8">{{ big endian value = {(($T1)(*(unsigned char *)Value.buffer) &lt;&lt; 56)
+                                                                    | (($T1)(*((unsigned char *)Value.buffer+1)) &lt;&lt; 48)
+                                                                    | (($T1)(*((unsigned char *)Value.buffer+2)) &lt;&lt; 40)
+                                                                    | (($T1)(*((unsigned char *)Value.buffer+3)) &lt;&lt; 32)
+                                                                    | (($T1)(*((unsigned char *)Value.buffer+4)) &lt;&lt; 24)
+                                                                    | (($T1)(*((unsigned char *)Value.buffer+5)) &lt;&lt; 16)
+                                                                    | (($T1)(*((unsigned char *)Value.buffer+6)) &lt;&lt; 8)
                                                                     |  ($T1)(*((unsigned char *)Value.buffer+7))} }}</DisplayString>
     <Expand>
       <Item Name="[Raw Bytes]" Condition="sizeof($T1)==1">(unsigned char *)Value.buffer,1</Item>
       <Item Name="[Raw Bytes]" Condition="sizeof($T1)==2">(unsigned char *)Value.buffer,2</Item>
       <Item Name="[Raw Bytes]" Condition="sizeof($T1)==4">(unsigned char *)Value.buffer,4</Item>
       <Item Name="[Raw Bytes]" Condition="sizeof($T1)==8">(unsigned char *)Value.buffer,8</Item>
     </Expand>
   </Type>
<Expand>
       <Item Name="MinNumElements" Condition="ID == llvm::Type::TypeID::ScalableVectorTyID">((llvm::VectorType*)this)->ElementQuantity</Item>
 
       <Item Name="AddressSpace" Condition="ID == llvm::Type::TypeID::PointerTyID">SubclassData</Item>
       <Item Name="PointeeType" Condition="ID == llvm::Type::TypeID::PointerTyID">*ContainedTys</Item>
 
       <Item Name="Context">Context</Item>
     </Expand>
   </Type>
+
+  <Type Name="llvm::ConstantSDNode">
+    <DisplayString>$(Type) {*Value}</DisplayString>
+  </Type>
+
+  <Type Name="llvm::SDNode">
+    <DisplayString>$(Type) {(llvm::ISD::NodeType)this->NodeType}</DisplayString>
+    <Expand>
+      <ArrayItems>
+        <Size>NumOperands</Size>
+        <ValuePointer>OperandList</ValuePointer>
+      </ArrayItems>
+    </Expand>
+  </Type>
+
+  <Type Name="llvm::ConstantInt">
+    <DisplayString>i{Val.BitWidth} {Val.VAL}</DisplayString>
+  </Type>
+
+  <Type Name="llvm::IntegerType">
+    <DisplayString>{IDAndSubclassData >> 8}bit integer type</DisplayString>
+  </Type>
+
+  <Type Name="llvm::Value">
+    <DisplayString Condition="HasName">$(Type) {*VTy} {this->getName()} {SubclassData}</DisplayString>
+    <DisplayString Condition="!HasName">$(Type) {*VTy} anon {SubclassData}</DisplayString>
+    <Expand>
+      <Item Name="[Inst]" Condition="SubclassID > InstructionVal">(Instruction*)this</Item>
+      <Item Name="Operands">(User*)this</Item>
+      <LinkedListItems>
+        <HeadPointer>UseList</HeadPointer>
+        <NextPointer>Next</NextPointer>
+        <ValueNode>Prev.Value &amp; 3 == 3 ? (User*)(this + 1) : (User*)(this + 2)</ValueNode>
+      </LinkedListItems>
+    </Expand>
+  </Type>
+
+  <Type Name="llvm::Use">
+    <Expand>
+      <Item Name="Value">Val</Item>
+      <!--
+      <LinkedListItems>
+        <HeadPointer>this</HeadPointer>
+        <NextPointer>Next</NextPointer>
+        <ValueNode>Prev.Value &amp; 3 == 3 ? (User*)(this + 1) : (User*)(this + 2)</ValueNode>
+      </LinkedListItems>
+      -->
+    </Expand>
+  </Type>
+
+  <!-- uses other values, like Operands -->
+  <Type Name="llvm::User">
+    <DisplayString Condition="HasName">$(Type) {*VTy} {this->getName()} {SubclassData}</DisplayString>
+    <DisplayString Condition="!HasName">$(Type) {*VTy} anon {SubclassData}</DisplayString>
+    <Expand>
+      <Item Name="[Value]">(Value*)this,nd</Item>
+      <Item Name="[Type]">*VTy</Item>
+      <ArrayItems Condition="!HasHungOffUses">
+        <Size>NumUserOperands</Size>
+        <ValuePointer>(llvm::Use*)this - NumUserOperands</ValuePointer>
+      </ArrayItems>
+      <ArrayItems Condition="HasHungOffUses">
+        <Size>NumUserOperands</Size>
+        <ValuePointer>*((llvm::Use**)this - 1)</ValuePointer>
+      </ArrayItems>
+    </Expand>
+  </Type>
+
+  <Type Name="llvm::Instruction">
+    <DisplayString>{getOpcodeName(SubclassID - InstructionVal)}</DisplayString>
+    <Expand>
+      <Item Name="[User]">(User*)this,nd</Item>
+    </Expand>
+  </Type>
+
+  <Type Name="llvm::GlobalValue">
+    <DisplayString>{this->getName()} {(LinkageTypes)Linkage} {(VisibilityTypes)Visibility} {(DLLStorageClassTypes)DllStorageClass} {(llvm::GlobalValue::ThreadLocalMode) ThreadLocal}</DisplayString>
+  </Type>
+
+  <!-- TODO doesn't work cause it doesn't know the dynamic type -->
+  <Type Name="llvm::ilist_node">
+    <Expand>
+      <LinkedListItems>
+        <HeadPointer>this</HeadPointer>
+        <NextPointer>Next</NextPointer>
+        <ValueNode>this</ValueNode>
+      </LinkedListItems>
+    </Expand>
+  </Type>
+
+  <Type Name="llvm::LLVMContext">
+    <Expand>
+      <ExpandedItem>pImpl</ExpandedItem>
+    </Expand>
+  </Type>
+
+  <Type Name="llvm::Module">
+    <DisplayString>{ModuleID,s8} {TargetTriple}</DisplayString>
+  </Type>
+
+  <Type Name="llvm::Pass">
+    <DisplayString>$(Type) {PassID} {Kind}</DisplayString>
+  </Type>
 </AutoVisualizer>