xref: /openbsd-src/gnu/llvm/llvm/utils/LLVMVisualizers/llvm.natvis (revision d415bd752c734aee168c4ee86ff32e8cc249eb16)
1<?xml version="1.0" encoding="utf-8"?>
2<!--
3Visual Studio Native Debugging Visualizers for LLVM
4
5For Visual Studio 2013 only, put this file into
6"%USERPROFILE%\Documents\Visual Studio 2013\Visualizers" or create a symbolic link so it updates automatically.
7
8For later versions of Visual Studio, no setup is required.
9-->
10<AutoVisualizer xmlns="http://schemas.microsoft.com/vstudio/debugger/natvis/2010">
11  <Type Name="llvm::SmallVectorImpl&lt;*&gt;">
12    <DisplayString Condition="Size == 0">empty</DisplayString>
13    <DisplayString Condition="Size &amp;&amp; Size &lt; 4">{(value_type*)BeginX,[Size]}</DisplayString>
14    <DisplayString Condition="Size &gt; 3">{Size} elements</DisplayString>
15    <DisplayString>Uninitialized</DisplayString>
16    <Expand>
17      <Item Name="[size]">Size</Item>
18      <Item Name="[capacity]">Capacity</Item>
19      <ArrayItems>
20        <Size>Size</Size>
21        <ValuePointer>(value_type*)BeginX</ValuePointer>
22      </ArrayItems>
23    </Expand>
24  </Type>
25  <Type Name="llvm::APInt">
26    <!-- For now, only handle up to 64-bit unsigned ints -->
27    <DisplayString Condition="BitWidth &lt;= 64">{U.VAL}</DisplayString>
28    <DisplayString>Cannot visualize APInts longer than 64 bits</DisplayString>
29  </Type>
30  <Type Name="llvm::ArrayRef&lt;*&gt;">
31    <DisplayString Condition="Length &lt; 4">{Data,[Length]}</DisplayString>
32    <DisplayString Condition="Length &gt; 3">{Length} elements</DisplayString>
33    <DisplayString>Uninitialized</DisplayString>
34    <Expand>
35      <Item Name="[size]">Length</Item>
36      <ArrayItems>
37        <Size>Length</Size>
38        <ValuePointer>Data</ValuePointer>
39      </ArrayItems>
40    </Expand>
41  </Type>
42  <Type Name="llvm::SmallString&lt;*&gt;">
43    <DisplayString>{(const char*)BeginX,[Size]s8}</DisplayString>
44    <StringView>(const char*)BeginX,[Size]</StringView>
45    <Expand>
46      <Item Name="[size]">Size</Item>
47      <Item Name="[capacity]">Capacity</Item>
48      <ArrayItems>
49        <Size>Size</Size>
50        <ValuePointer>(char*)BeginX</ValuePointer>
51      </ArrayItems>
52    </Expand>
53  </Type>
54
55  <Type Name="StringView">
56    <DisplayString>{First,[Last - First]s8}</DisplayString>
57  </Type>
58
59  <Type Name="llvm::StringRef">
60    <DisplayString>{Data,[Length]s8}</DisplayString>
61    <StringView>Data,[Length]s8</StringView>
62    <Expand>
63      <Item Name="[size]">Length</Item>
64      <ArrayItems>
65        <Size>Length</Size>
66        <ValuePointer>Data</ValuePointer>
67      </ArrayItems>
68    </Expand>
69  </Type>
70
71  <!-- PointerIntPair. In addition to the regular view, it is possible to view just the pointer or just the int
72    The same code is duplicated from the regular viewer to improve the performance of the common case -->
73  <Type Name="llvm::PointerIntPair&lt;*&gt;">
74    <DisplayString IncludeView="ptr">{($T1)(Value &amp; $T5::PointerBitMask)}</DisplayString>
75    <DisplayString IncludeView="int">{($T3)((Value &gt;&gt; $T5::IntShift) &amp; $T5::IntMask)}</DisplayString>
76    <DisplayString>{$T5::IntMask}: {($T1)(Value &amp; $T5::PointerBitMask)} [{($T3)((Value &gt;&gt; $T5::IntShift) &amp; $T5::IntMask)}]</DisplayString>
77    <Expand>
78      <Item Name="[ptr]">($T1)(Value &amp; $T5::PointerBitMask)</Item>
79      <Item Name="[int]">($T3)((Value &gt;&gt; $T5::IntShift) &amp; $T5::IntMask)</Item>
80    </Expand>
81  </Type>
82  <!-- PointerUnion types -->
83  <Type Name="llvm::pointer_union_detail::PointerUnionMembers&lt;*&gt;">
84    <DisplayString Optional="true" Condition="((Val.Value&gt;&gt;$T2::InfoTy::IntShift) &amp; $T2::InfoTy::IntMask) == 0">
85      {($T4)(Val.Value &amp; $T2::InfoTy::PointerBitMask)}
86    </DisplayString>
87    <DisplayString Optional="true" Condition="((Val.Value&gt;&gt;$T2::InfoTy::IntShift) &amp; $T2::InfoTy::IntMask) == 1">
88      {($T5)(Val.Value &amp; $T2::InfoTy::PointerBitMask)}
89    </DisplayString>
90    <DisplayString Optional="true" Condition="((Val.Value&gt;&gt;$T2::InfoTy::IntShift) &amp; $T2::InfoTy::IntMask) == 2">
91      {($T6)(Val.Value &amp; $T2::InfoTy::PointerBitMask)}
92    </DisplayString>
93    <DisplayString Optional="true" Condition="((Val.Value&gt;&gt;$T2::InfoTy::IntShift) &amp; $T2::InfoTy::IntMask) == 3">
94      {($T7)(Val.Value &amp; $T2::InfoTy::PointerBitMask)}
95    </DisplayString>
96    <DisplayString>Unexpected index in PointerUnion: {(Val.Value&gt;&gt;$T2::InfoTy::IntShift) &amp; $T2::InfoTy::IntMask}</DisplayString>
97    <Expand>
98      <Item Name="[Holds]" Condition="((Val.Value&gt;&gt;$T2::InfoTy::IntShift) &amp; $T2::InfoTy::IntMask) == 0">"$T4",s8b</Item>
99      <Item Name="[Ptr]" Optional="true"  Condition="((Val.Value&gt;&gt;$T2::InfoTy::IntShift) &amp; $T2::InfoTy::IntMask) == 0">
100        ($T4)(Val.Value &amp; $T2::InfoTy::PointerBitMask)
101      </Item>
102      <Item Name="[Holds]" Condition="((Val.Value&gt;&gt;$T2::InfoTy::IntShift) &amp; $T2::InfoTy::IntMask) == 1">"$T5",s8b</Item>
103      <Item Name="[Ptr]" Optional="true"  Condition="((Val.Value&gt;&gt;$T2::InfoTy::IntShift) &amp; $T2::InfoTy::IntMask) == 1">
104        ($T5)(Val.Value &amp; $T2::InfoTy::PointerBitMask)
105      </Item>
106      <Item Name="[Holds]" Condition="((Val.Value&gt;&gt;$T2::InfoTy::IntShift) &amp; $T2::InfoTy::IntMask) == 2">"$T6",s8b</Item>
107      <Item Name="[Ptr]" Optional="true"  Condition="((Val.Value&gt;&gt;$T2::InfoTy::IntShift) &amp; $T2::InfoTy::IntMask) == 2">
108        ($T6)(Val.Value &amp; $T2::InfoTy::PointerBitMask)
109      </Item>
110      <Item Name="[Holds]" Condition="((Val.Value&gt;&gt;$T2::InfoTy::IntShift) &amp; $T2::InfoTy::IntMask) == 3">"$T6",s8b</Item>
111      <Item Name="[Ptr]" Optional="true"  Condition="((Val.Value&gt;&gt;$T2::InfoTy::IntShift) &amp; $T2::InfoTy::IntMask) == 3">
112        ($T7)(Val.Value &amp; $T2::InfoTy::PointerBitMask)
113      </Item>
114    </Expand>
115  </Type>
116
117  <Type Name="llvm::iplist&lt;*,*&gt;">
118    <DisplayString Condition="Head == 0">{{ empty }}</DisplayString>
119    <DisplayString Condition="Head != 0">{{ head={Head} }}</DisplayString>
120    <Expand>
121      <LinkedListItems>
122        <HeadPointer>Head</HeadPointer>
123        <NextPointer>Next</NextPointer>
124        <ValueNode>this</ValueNode>
125      </LinkedListItems>
126    </Expand>
127  </Type>
128
129  <Type Name="llvm::IntrusiveRefCntPtr&lt;*&gt;">
130    <DisplayString Condition="Obj == 0">empty</DisplayString>
131    <DisplayString Condition="(Obj != 0) &amp;&amp; (Obj-&gt;RefCount == 1)">RefPtr [1 ref] {*Obj}</DisplayString>
132    <DisplayString Condition="(Obj != 0) &amp;&amp; (Obj-&gt;RefCount != 1)">RefPtr [{Obj-&gt;RefCount} refs] {*Obj}</DisplayString>
133    <Expand>
134      <Item Condition="Obj != 0" Name="[refs]">Obj-&gt;RefCount</Item>
135      <ExpandedItem Condition="Obj != 0">Obj</ExpandedItem>
136    </Expand>
137  </Type>
138
139  <Type Name="llvm::SmallPtrSet&lt;*,*&gt;">
140    <DisplayString Condition="CurArray == SmallArray">{{ [Small Mode] size={NumNonEmpty}, capacity={CurArraySize} }}</DisplayString>
141    <DisplayString Condition="CurArray != SmallArray">{{ [Big Mode] size={NumNonEmpty}, capacity={CurArraySize} }}</DisplayString>
142    <Expand>
143      <Item Name="[size]">NumNonEmpty</Item>
144      <Item Name="[capacity]">CurArraySize</Item>
145      <ArrayItems>
146        <Size>NumNonEmpty</Size>
147        <ValuePointer>($T1*)CurArray</ValuePointer>
148      </ArrayItems>
149    </Expand>
150  </Type>
151
152  <Type Name="llvm::DenseMap&lt;*,*,*&gt;">
153    <DisplayString Condition="NumEntries == 0">empty</DisplayString>
154    <DisplayString Condition="NumEntries != 0">{{ size={NumEntries}, buckets={NumBuckets} }}</DisplayString>
155    <Expand>
156      <Item Name="[size]">NumEntries</Item>
157      <Item Name="[buckets]">NumBuckets</Item>
158      <ArrayItems>
159        <Size>NumBuckets</Size>
160        <ValuePointer>Buckets</ValuePointer>
161      </ArrayItems>
162    </Expand>
163  </Type>
164
165  <Type Name="llvm::StringMap&lt;*,*&gt;">
166    <DisplayString>{{ size={NumItems}, buckets={NumBuckets} }}</DisplayString>
167    <Expand>
168      <Item Name="[size]">NumItems</Item>
169      <Item Name="[buckets]">NumBuckets</Item>
170      <ArrayItems>
171        <Size>NumBuckets</Size>
172        <ValuePointer>(MapEntryTy**)TheTable</ValuePointer>
173      </ArrayItems>
174    </Expand>
175  </Type>
176
177  <Type Name="llvm::StringMapEntry&lt;*&gt;">
178    <DisplayString Condition="StrLen == 0">empty</DisplayString>
179    <DisplayString Condition="StrLen != 0">({this+1,s8}, {second})</DisplayString>
180    <Expand>
181      <Item Name="[key]">this+1,s</Item>
182      <Item Name="[value]" Condition="StrLen != 0">second</Item>
183    </Expand>
184  </Type>
185
186  <Type Name="llvm::Triple">
187    <DisplayString>{Data}</DisplayString>
188  </Type>
189
190  <Type Name="llvm::Optional&lt;*&gt;">
191    <DisplayString Condition="!Storage.hasVal">None</DisplayString>
192    <DisplayString Condition="Storage.hasVal">{Storage.value}</DisplayString>
193    <Expand>
194      <Item Name="[underlying]" Condition="Storage.hasVal">Storage.value</Item>
195    </Expand>
196  </Type>
197
198  <Type Name="llvm::Expected&lt;*&gt;">
199    <DisplayString Condition="HasError">Error</DisplayString>
200    <DisplayString Condition="!HasError">{*((storage_type *)TStorage.buffer)}</DisplayString>
201    <Expand>
202      <Item Name="[value]" Condition="!HasError">*((storage_type *)TStorage.buffer)</Item>
203      <Item Name="[error]" Condition="HasError">*((error_type *)ErrorStorage.buffer)</Item>
204    </Expand>
205  </Type>
206
207
208  <!-- Since we're in MSVC, we can assume that the system is little endian.  Therefore
209       the little and native cases just require a cast.  Handle this easy case first. Use
210       a wildcard for the second template argument (the endianness), but we will use a
211       specific value of 0 later on for the big endian to give it priority for being a
212       better match.  -->
213  <Type Name="llvm::support::detail::packed_endian_specific_integral&lt;*,*,1&gt;">
214    <DisplayString>{{little endian value = {*(($T1*)(unsigned char *)Value.buffer)} }}</DisplayString>
215    <Expand>
216      <Item Name="[Raw Bytes]" Condition="sizeof($T1)==1">(unsigned char *)Value.buffer,1</Item>
217      <Item Name="[Raw Bytes]" Condition="sizeof($T1)==2">(unsigned char *)Value.buffer,2</Item>
218      <Item Name="[Raw Bytes]" Condition="sizeof($T1)==4">(unsigned char *)Value.buffer,4</Item>
219      <Item Name="[Raw Bytes]" Condition="sizeof($T1)==8">(unsigned char *)Value.buffer,8</Item>
220    </Expand>
221  </Type>
222
223  <!-- Now handle the hard case of big endian.  We need to do the swizzling here, but
224       we need to specialize it based on the size of the value type. -->
225  <Type Name="llvm::support::detail::packed_endian_specific_integral&lt;*,0,1&gt;">
226    <DisplayString Condition="sizeof($T1)==1">{{ big endian value = {*(unsigned char *)Value.buffer} }}</DisplayString>
227    <DisplayString Condition="sizeof($T1)==2">{{ big endian value = {(($T1)(*(unsigned char *)Value.buffer) &lt;&lt; 8)
228                                                                    | ($T1)(*((unsigned char *)Value.buffer+1))} }}</DisplayString>
229    <DisplayString Condition="sizeof($T1)==4">{{ big endian value = {(($T1)(*(unsigned char *)Value.buffer) &lt;&lt; 24)
230                                                                    | (($T1)(*((unsigned char *)Value.buffer+1)) &lt;&lt; 16)
231                                                                    | (($T1)(*((unsigned char *)Value.buffer+2)) &lt;&lt; 8)
232                                                                    |  ($T1)(*((unsigned char *)Value.buffer+3))} }}</DisplayString>
233    <DisplayString Condition="sizeof($T1)==8">{{ big endian value = {(($T1)(*(unsigned char *)Value.buffer) &lt;&lt; 56)
234                                                                    | (($T1)(*((unsigned char *)Value.buffer+1)) &lt;&lt; 48)
235                                                                    | (($T1)(*((unsigned char *)Value.buffer+2)) &lt;&lt; 40)
236                                                                    | (($T1)(*((unsigned char *)Value.buffer+3)) &lt;&lt; 32)
237                                                                    | (($T1)(*((unsigned char *)Value.buffer+4)) &lt;&lt; 24)
238                                                                    | (($T1)(*((unsigned char *)Value.buffer+5)) &lt;&lt; 16)
239                                                                    | (($T1)(*((unsigned char *)Value.buffer+6)) &lt;&lt; 8)
240                                                                    |  ($T1)(*((unsigned char *)Value.buffer+7))} }}</DisplayString>
241    <Expand>
242      <Item Name="[Raw Bytes]" Condition="sizeof($T1)==1">(unsigned char *)Value.buffer,1</Item>
243      <Item Name="[Raw Bytes]" Condition="sizeof($T1)==2">(unsigned char *)Value.buffer,2</Item>
244      <Item Name="[Raw Bytes]" Condition="sizeof($T1)==4">(unsigned char *)Value.buffer,4</Item>
245      <Item Name="[Raw Bytes]" Condition="sizeof($T1)==8">(unsigned char *)Value.buffer,8</Item>
246    </Expand>
247  </Type>
248  <!-- llvm::Type has two fields, SubclassData and ContainedTys, the meaning of which change depending on the TypeID.
249       This visualiser decodes those fields based on the value of ID.
250  -->
251  <Type Name="llvm::Type">
252    <DisplayString>{ID}</DisplayString>
253    <Expand>
254      <Item Name="ID">ID</Item>
255
256      <Item Name="NumBits" Condition="ID == llvm::Type::TypeID::IntegerTyID">SubclassData</Item>
257
258      <Item Name="ReturnType" Condition="ID == llvm::Type::TypeID::FunctionTyID">*ContainedTys</Item>
259      <Synthetic Name="Arguments" Condition="ID == llvm::Type::TypeID::FunctionTyID">
260        <DisplayString>{NumContainedTys - 1}</DisplayString>
261        <Expand>
262        <ArrayItems>
263          <Size>NumContainedTys - 1</Size>
264          <ValuePointer>ContainedTys + 1</ValuePointer>
265        </ArrayItems>
266        </Expand>
267      </Synthetic>
268      <Item Name="IsVarArg" Condition="ID == llvm::Type::TypeID::FunctionTyID">SubclassData == 1</Item>
269
270      <Item Name="HasBody" Condition="ID == llvm::Type::TypeID::StructTyID">(SubclassData 	&amp; llvm::StructType::SCDB_HasBody) != 0</Item>
271      <Item Name="Packed" Condition="ID == llvm::Type::TypeID::StructTyID">(SubclassData 	&amp; llvm::StructType::SCDB_Packed) != 0</Item>
272      <Item Name="IsLiteral" Condition="ID == llvm::Type::TypeID::StructTyID">(SubclassData 	&amp; llvm::StructType::SCDB_IsLiteral) != 0</Item>
273      <Item Name="IsSized" Condition="ID == llvm::Type::TypeID::StructTyID">(SubclassData 	&amp; llvm::StructType::SCDB_IsSized) != 0</Item>
274      <Synthetic Name="Members" Condition="ID == llvm::Type::TypeID::StructTyID">
275        <DisplayString>{NumContainedTys}</DisplayString>
276        <Expand>
277          <ArrayItems>
278            <Size>NumContainedTys</Size>
279            <ValuePointer>ContainedTys</ValuePointer>
280          </ArrayItems>
281        </Expand>
282      </Synthetic>
283
284      <Item Name="ElementType" Condition="ID == llvm::Type::TypeID::ArrayTyID">*ContainedTys</Item>
285      <Item Name="NumElements" Condition="ID == llvm::Type::TypeID::ArrayTyID">((llvm::ArrayType*)this)->NumElements</Item>
286
287      <Item Name="ElementType" Condition="ID == llvm::Type::TypeID::FixedVectorTyID">*ContainedTys</Item>
288      <Item Name="NumElements" Condition="ID == llvm::Type::TypeID::FixedVectorTyID">((llvm::VectorType*)this)->ElementQuantity</Item>
289
290      <Item Name="ElementType" Condition="ID == llvm::Type::TypeID::ScalableVectorTyID">*ContainedTys</Item>
291      <Item Name="MinNumElements" Condition="ID == llvm::Type::TypeID::ScalableVectorTyID">((llvm::VectorType*)this)->ElementQuantity</Item>
292
293      <Item Name="AddressSpace" Condition="ID == llvm::Type::TypeID::PointerTyID">SubclassData</Item>
294      <Item Name="PointeeType" Condition="ID == llvm::Type::TypeID::PointerTyID">*ContainedTys</Item>
295
296      <Item Name="Context">Context</Item>
297    </Expand>
298  </Type>
299
300  <Type Name="llvm::ConstantSDNode">
301    <DisplayString>$(Type) {*Value}</DisplayString>
302  </Type>
303
304  <Type Name="llvm::SDNode">
305    <DisplayString>$(Type) {(llvm::ISD::NodeType)this->NodeType}</DisplayString>
306    <Expand>
307      <ArrayItems>
308        <Size>NumOperands</Size>
309        <ValuePointer>OperandList</ValuePointer>
310      </ArrayItems>
311    </Expand>
312  </Type>
313
314  <Type Name="llvm::ConstantInt">
315    <DisplayString>i{Val.BitWidth} {Val.VAL}</DisplayString>
316  </Type>
317
318  <Type Name="llvm::IntegerType">
319    <DisplayString>{IDAndSubclassData >> 8}bit integer type</DisplayString>
320  </Type>
321
322  <Type Name="llvm::Value">
323    <DisplayString Condition="HasName">$(Type) {*VTy} {this->getName()} {SubclassData}</DisplayString>
324    <DisplayString Condition="!HasName">$(Type) {*VTy} anon {SubclassData}</DisplayString>
325    <Expand>
326      <Item Name="[Inst]" Condition="SubclassID > InstructionVal">(Instruction*)this</Item>
327      <Item Name="Operands">(User*)this</Item>
328      <LinkedListItems>
329        <HeadPointer>UseList</HeadPointer>
330        <NextPointer>Next</NextPointer>
331        <ValueNode>Prev.Value &amp; 3 == 3 ? (User*)(this + 1) : (User*)(this + 2)</ValueNode>
332      </LinkedListItems>
333    </Expand>
334  </Type>
335
336  <Type Name="llvm::Use">
337    <Expand>
338      <Item Name="Value">Val</Item>
339      <!--
340      <LinkedListItems>
341        <HeadPointer>this</HeadPointer>
342        <NextPointer>Next</NextPointer>
343        <ValueNode>Prev.Value &amp; 3 == 3 ? (User*)(this + 1) : (User*)(this + 2)</ValueNode>
344      </LinkedListItems>
345      -->
346    </Expand>
347  </Type>
348
349  <!-- uses other values, like Operands -->
350  <Type Name="llvm::User">
351    <DisplayString Condition="HasName">$(Type) {*VTy} {this->getName()} {SubclassData}</DisplayString>
352    <DisplayString Condition="!HasName">$(Type) {*VTy} anon {SubclassData}</DisplayString>
353    <Expand>
354      <Item Name="[Value]">(Value*)this,nd</Item>
355      <Item Name="[Type]">*VTy</Item>
356      <ArrayItems Condition="!HasHungOffUses">
357        <Size>NumUserOperands</Size>
358        <ValuePointer>(llvm::Use*)this - NumUserOperands</ValuePointer>
359      </ArrayItems>
360      <ArrayItems Condition="HasHungOffUses">
361        <Size>NumUserOperands</Size>
362        <ValuePointer>*((llvm::Use**)this - 1)</ValuePointer>
363      </ArrayItems>
364    </Expand>
365  </Type>
366
367  <Type Name="llvm::Instruction">
368    <DisplayString>{getOpcodeName(SubclassID - InstructionVal)}</DisplayString>
369    <Expand>
370      <Item Name="[User]">(User*)this,nd</Item>
371    </Expand>
372  </Type>
373
374  <Type Name="llvm::GlobalValue">
375    <DisplayString>{this->getName()} {(LinkageTypes)Linkage} {(VisibilityTypes)Visibility} {(DLLStorageClassTypes)DllStorageClass} {(llvm::GlobalValue::ThreadLocalMode) ThreadLocal}</DisplayString>
376  </Type>
377
378  <!-- TODO doesn't work cause it doesn't know the dynamic type -->
379  <Type Name="llvm::ilist_node">
380    <Expand>
381      <LinkedListItems>
382        <HeadPointer>this</HeadPointer>
383        <NextPointer>Next</NextPointer>
384        <ValueNode>this</ValueNode>
385      </LinkedListItems>
386    </Expand>
387  </Type>
388
389  <Type Name="llvm::LLVMContext">
390    <Expand>
391      <ExpandedItem>pImpl</ExpandedItem>
392    </Expand>
393  </Type>
394
395  <Type Name="llvm::Module">
396    <DisplayString>{ModuleID,s8} {TargetTriple}</DisplayString>
397  </Type>
398
399  <Type Name="llvm::Pass">
400    <DisplayString>$(Type) {PassID} {Kind}</DisplayString>
401  </Type>
402</AutoVisualizer>
403