forked from apple/swift-lldb
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathvarformats.html
executable file
·1331 lines (1231 loc) · 75.4 KB
/
varformats.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html;
charset=ISO-8859-1">
<link href="style.css" rel="stylesheet" type="text/css">
<title>LLDB Data Formatters</title>
</head>
<body>
<div class="www_title"> The <strong>LLDB</strong> Debugger </div>
<div id="container">
<div id="content">
<!--#include virtual="sidebar.incl"-->
<div id="middle">
<div class="post">
<h1 class="postheader">Variable display</h1>
<div class="postcontent">
<p>LLDB has a data formatters subsystem that allows users to define custom display options for their variables.</p>
<p>Usually, when you type <code>frame variable</code> or
run some <code>expression</code> LLDB will
automatically choose the way to display your results on
a per-type basis, as in the following example:</p>
<p> <code> <b>(lldb)</b> frame variable<br>
(uint8_t) x = 'a'<br>
(intptr_t) y = 124752287<br>
</code> </p>
<p>However, in certain cases, you may want to associate a
different style to the display for certain datatypes.
To do so, you need to give hints to the debugger as to
how variables should be displayed.<br>
The LLDB <b>type</b> command allows you to do just that.<br>
</p>
<p>Using it you can change your visualization to look like this: </p>
<p> <code> <b>(lldb)</b> frame variable<br>
(uint8_t) x = chr='a' dec=65 hex=0x41<br>
(intptr_t) y = 0x76f919f<br>
</code> </p>
<p>There are several features related to data visualization: <span
style="font-style: italic;">formats</span>, <span
style="font-style: italic;">summaries</span>, <span
style="font-style: italic;">filters</span>, <span
style="font-style: italic;">synthetic children</span>.</p>
<p>To reflect this, the <b>type</b> command has five
subcommands:<br>
</p>
<p><code>type format</code></p>
<p><code>type summary</code></p>
<p><code>type filter</code></p>
<p><code>type synthetic</code></p>
<p><code>type category</code></p>
<p>These commands are meant to bind printing options to
types. When variables are printed, LLDB will first check
if custom printing options have been associated to a
variable's type and, if so, use them instead of picking
the default choices.<br>
</p>
<p>Each of the commands (except <code>type category</code>) has four subcommands available:<br>
</p>
<p><code>add</code>: associates a new printing option to one
or more types</p>
<p><code>delete</code>: deletes an existing association</p>
<p><code>list</code>: provides a listing of all
associations</p>
<p><code>clear</code>: deletes all associations</p>
</div>
</div>
<div class="post">
<h1 class="postheader">type format</h1>
<div class="postcontent">
<p>Type formats enable you to quickly override the default
format for displaying primitive types (the usual basic
C/C++/ObjC types: <code><font color="blue">int</font></code>, <code><font color="blue">float</font></code>, <code><font color="blue">char</font></code>, ...).</p>
<p>If for some reason you want all <code>int</code>
variables in your program to print out as hex, you can add
a format to the <code>int</code> type.<br></p>
<p>This is done by typing
<table class="stats" width="620" cellspacing="0">
<td class="content">
<b>(lldb)</b> type format add --format hex int
</td>
<table>
at the LLDB command line.</p>
<p>The <code>--format</code> (which you can shorten to <code>-f</code>) option accepts a <a
href="#formatstable">format name</a>. Then, you provide one or more
types to which you want the new format applied.</p>
<p>A frequent scenario is that your program has a <code>typedef</code>
for a numeric type that you know represents something
that must be printed in a certain way. Again, you can
add a format just to that typedef by using <code>type
format add</code> with the name alias.</p>
<p>But things can quickly get hierarchical. Let's say you
have a situation like the following:</p>
<p><code><font color="blue">typedef int</font> A;<br>
<font color="blue">typedef</font> A B;<br>
<font color="blue">typedef</font> B C;<br>
<font color="blue">typedef</font> C D;<br>
</code></p>
<p>and you want to show all <code>A</code>'s as hex, all
<code>C'</code>s as byte arrays and leave the defaults
untouched for other types (albeit its contrived look, the example is far
from unrealistic in large software systems).</p>
<p>If you simply type <br>
<table class="stats" width="620" cellspacing="0">
<td class="content">
<b>(lldb)</b> type format add -f hex A<br>
<b>(lldb)</b> type format add -f uint8_t[] C
</td>
<table>
<br>
values of type <code>B</code> will be shown as hex
and values of type <code>D</code> as byte arrays, as in:</p>
<p> <code>
<b>(lldb)</b> frame variable -T<br/>
(A) a = 0x00000001<br/>
(B) b = 0x00000002<br/>
(C) c = {0x03 0x00 0x00 0x00}<br/>
(D) d = {0x04 0x00 0x00 0x00}<br/>
</code> </p>
<p>This is because by default LLDB <i>cascades</i>
formats through typedef chains. In order to avoid that
you can use the option <code>-C no</code> to prevent
cascading, thus making the two commands required to
achieve your goal:<br>
<table class="stats" width="620" cellspacing="0">
<td class="content">
<b>(lldb)</b> type format add -C no -f hex A<br>
<b>(lldb)</b> type format add -C no -f uint8_t[] C
</td>
<table>
<p>which provides the desired output:</p>
<p> <code>
<b>(lldb)</b> frame variable -T<br/>
(A) a = 0x00000001<br/>
(B) b = 2<br/>
(C) c = {0x03 0x00 0x00 0x00}<br/>
(D) d = 4<br/>
</code> </p>
<p>Two additional options that you will want to look at
are <code>--skip-pointers</code> (<code>-p</code>) and <code>--skip-references</code> (<code>-r</code>). These two
options prevent LLDB from applying a format for type <code>T</code>
to values of type <code>T*</code> and <code>T&</code>
respectively.</p>
<p> <code> <b>(lldb)</b> type format add -f float32[]
int<br>
<b>(lldb)</b> frame variable pointer *pointer -T<br>
(int *) pointer = {1.46991e-39 1.4013e-45}<br>
(int) *pointer = {1.53302e-42}<br>
<b>(lldb)</b> type format add -f float32[] int -p<br>
<b>(lldb)</b> frame variable pointer *pointer -T<br>
(int *) pointer = 0x0000000100100180<br>
(int) *pointer = {1.53302e-42}<br>
</code> </p>
<p>While they can be applied to pointers and references, formats will make no attempt
to dereference the pointer and extract the value before applying the format, which means you
are effectively formatting the address stored in the pointer rather than the pointee value.
For this reason, you may want to use the <code>-p</code> option when defining formats.</p>
<p>If you need to delete a custom format simply type <code>type
format delete</code> followed by the name of the type
to which the format applies.Even if you
defined the same format for multiple types on the same command,
<code>type format delete</code> will only remove the format for
the type name passed as argument.<br>
</p>
<p>
To delete ALL formats, use
<code>type format clear</code>. To see all the formats
defined, use <code>type format list</code>.</p>
<p>If all you need to do, however, is display one variable
in a custom format, while leaving the others of the same
type untouched, you can simply type:<br>
<br>
<table class="stats" width="620" cellspacing="0">
<td class="content">
<b>(lldb)</b> frame variable counter -f hex
</td>
<table>
<p>This has the effect of displaying the value of <code>counter</code>
as an hexadecimal number, and will keep showing it this
way until you either pick a different format or till you
let your program run again.</p>
<p>Finally, this is a list of formatting options available
out of
which you can pick:</p><a name="formatstable"></a>
<table border="1">
<tbody>
<tr valign="top">
<td width="23%"><b>Format name</b></td>
<td><b>Abbreviation</b></td>
<td><b>Description</b></td>
</tr>
<tr valign="top">
<td><b>default</b></td>
<td><br>
</td>
<td>the default LLDB algorithm is used to pick a
format</td>
</tr>
<tr valign="top">
<td><b>boolean</b></td>
<td>B</td>
<td>show this as a true/false boolean, using the
customary rule that 0 is false and everything else
is true</td>
</tr>
<tr valign="top">
<td><b>binary</b></td>
<td>b</td>
<td>show this as a sequence of bits</td>
</tr>
<tr valign="top">
<td><b>bytes</b></td>
<td>y</td>
<td>show the bytes one after the other<br>
e.g. <code>(int) s.x = 07 00 00 00</code></td>
</tr>
<tr valign="top">
<td><b>bytes with ASCII</b></td>
<td>Y</td>
<td>show the bytes, but try to display them as ASCII
characters as well<br>
e.g. <code>(int *) c.sp.x = 50 f8 bf 5f ff 7f 00
00 P.._....</code></td>
</tr>
<tr valign="top">
<td><b>character</b></td>
<td>c</td>
<td>show the bytes as ASCII characters<br>
e.g. <code>(int *) c.sp.x =
P\xf8\xbf_\xff\x7f\0\0</code></td>
</tr>
<tr valign="top">
<td><b>printable character</b></td>
<td>C</td>
<td>show the bytes as printable ASCII
characters<br>
e.g. <code>(int *) c.sp.x = P.._....</code></td>
</tr>
<tr valign="top">
<td><b>complex float</b></td>
<td>F</td>
<td>interpret this value as the real and imaginary
part of a complex floating-point number<br>
e.g. <code>(int *) c.sp.x = 2.76658e+19 +
4.59163e-41i</code></td>
</tr>
<tr valign="top">
<td><b>c-string</b></td>
<td>s</td>
<td>show this as a 0-terminated C string</td>
</tr>
<tr valign="top">
<td><b>decimal</b></td>
<td>i</td>
<td>show this as a signed integer number (this does
not perform a cast, it simply shows the bytes as
an integer with sign)</td>
</tr>
<tr valign="top">
<td><b>enumeration</b></td>
<td>E</td>
<td>show this as an enumeration, printing the
value's name if available or the integer value
otherwise<br>
e.g. <code>(enum enumType) val_type = eValue2</code></td>
</tr>
<tr valign="top">
<td><b>hex</b></td>
<td>x</td>
<td>show this as in hexadecimal notation (this does
not perform a cast, it simply shows the bytes as
hex)</td>
</tr>
<tr valign="top">
<td><b>float</b></td>
<td>f</td>
<td>show this as a floating-point number (this does
not perform a cast, it simply interprets the bytes
as an IEEE754 floating-point value)</td>
</tr>
<tr valign="top">
<td><b>octal</b></td>
<td>o</td>
<td>show this in octal notation</td>
</tr>
<tr valign="top">
<td><b>OSType</b></td>
<td>O</td>
<td>show this as a MacOS OSType<br>
e.g. <code>(float) x = '\n\x1f\xd7\n'</code></td>
</tr>
<tr valign="top">
<td><b>unicode16</b></td>
<td>U</td>
<td>show this as UTF-16 characters<br>
e.g. <code>(float) x = 0xd70a 0x411f</code></td>
</tr>
<tr valign="top">
<td><b>unicode32</b></td>
<td><br>
</td>
<td>show this as UTF-32 characters<br>
e.g. <code>(float) x = 0x411fd70a</code></td>
</tr>
<tr valign="top">
<td><b>unsigned decimal</b></td>
<td>u</td>
<td>show this as an unsigned integer number (this
does not perform a cast, it simply shows the bytes
as unsigned integer)</td>
</tr>
<tr valign="top">
<td><b>pointer</b></td>
<td>p</td>
<td>show this as a native pointer (unless this is
really a pointer, the resulting address will
probably be invalid)</td>
</tr>
<tr valign="top">
<td><b>char[]</b></td>
<td><br>
</td>
<td>show this as an array of characters<br>
e.g. <code>(char) *c.sp.z = {X}</code></td>
</tr>
<tr valign="top">
<td><b>int8_t[], uint8_t[]<br>
int16_t[], uint16_t[]<br>
int32_t[], uint32_t[]<br>
int64_t[], uint64_t[]<br>
uint128_t[]</b></td>
<td><br>
</td>
<td>show this as an array of the corresponding
integer type<br>
e.g.<br>
<code>(int) x = {1 0 0 0}</code> (with uint8_t[])<br>
<code>(int) y = {0x00000001}</code> (with uint32_t[])</td>
</tr>
<tr valign="top">
<td><b>float32[], float64[]</b></td>
<td><br>
</td>
<td>show this as an array of the corresponding
floating-point type<br>
e.g. <code>(int *) pointer = {1.46991e-39
1.4013e-45}</code></td>
</tr>
<tr valign="top">
<td><b>complex integer</b></td>
<td>I</td>
<td>interpret this value as the real and imaginary
part of a complex integer number<br>
e.g. <code>(int *) pointer = 1048960 + 1i</code></td>
</tr>
<tr valign="top">
<td><b>character array</b></td>
<td>a</td>
<td>show this as a character array<br>
e.g. <code>(int *) pointer =
\x80\x01\x10\0\x01\0\0\0</code></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="post">
<h1 class="postheader">type summary</h1>
<div class="postcontent">
<p>Type formats work by showing a different kind of display for
the value of a variable. However, they only work for basic types.
When you want to display a class or struct in a custom format, you
cannot do that using formats.</p>
<p>A different feature, type summaries, works by extracting
information from classes, structures, ... (<i>aggregate types</i>)
and arranging it in a user-defined format, as in the following example:</p>
<p> <i>before adding a summary...</i><br>
<code> <b>(lldb)</b> frame variable -T one<br>
(i_am_cool) one = {<br>
(int) x = 3<br>
(float) y = 3.14159<br>
(char) z = 'E'<br>
}<br>
</code> <br>
<i>after adding a summary...</i><br>
<code> <b>(lldb)</b> frame variable one<br>
(i_am_cool) one = int = 3, float = 3.14159, char = 69<br>
</code> </p>
<p>There are two ways to use type summaries: the first one is to bind a <i>
summary string</i> to the type; the second is to write a Python script that returns
the string to be used as summary. Both options are enabled by the <code>type summary add</code>
command.</p>
<p>The command to obtain the output shown in the example is:</p>
<table class="stats" width="620" cellspacing="0">
<td class="content">
<b>(lldb)</b> type summary add --summary-string "int = ${var.x}, float = ${var.y}, char = ${var.z%u}" i_am_cool
</td>
<table>
<p>Initially, we will focus on summary strings, and then describe the Python binding
mechanism.</p>
</div>
</div>
<div class="post">
<h1 class="postheader">Summary Strings</h1>
<div class="postcontent">
<p>Summary strings are written using a simple control language, exemplified by the snippet above.
A summary string contains a sequence of tokens that are processed by LLDB to generate the summary.</p>
<p>Summary strings can contain plain text, control characters and
special variables that have access to information about
the current object and the overall program state.</p>
<p>Plain text is any sequence of characters that doesn't contain a <code><b>'{'</b></code>,
<code><b>'}'</b></code>, <code><b>'$'</b></code>, or <code><b>'\'</b></code>
character, which are the syntax control characters.</p>
<p>The special variables are found in between a <code><b>"${"</b></code>
prefix, and end with a <code><b>"}"</b></code> suffix. Variables can be a simple name
or they can refer to complex objects that have subitems themselves.
In other words, a variable looks like <code>"<b>${object}</b>"</code> or
<code>"<b>${object.child.otherchild}</b>"</code>. A variable can also be prefixed or
suffixed with other symbols meant to change the way its value is handled. An example is
<code>"<b>${*var.int_pointer[0-3]}</b>".</code></p>
<p>Basically, the syntax is the same one described <a
href="formats.html">Frame and Thread Formatting</a>
plus additional symbols specific for summary strings. The main of them is <code>${var</code>,
which is used refer to the variable that a summary is being created for.</p>
<p>The simplest thing you can do is grab a member variable
of a class or structure by typing its <i>expression
path</i>. In the previous example, the expression path
for the field <code>float y</code> is simply <code>.y</code>.
Thus, to ask the summary string to display <code>y</code>
you would type <code>${var.y}</code>.</p>
<p>If you have code like the following: <br>
<code> <font color="blue">struct</font> A {<br>
<font color="blue">int</font> x;<br>
<font color="blue">int</font> y;<br>
};<br>
<font color="blue">struct</font> B {<br>
A x;<br>
A y;<br>
<font color="blue">int</font> *z;<br>
};<br>
</code> the expression path for the <code>y</code>
member of the <code>x</code> member of an object of
type <code>B</code> would be <code>.x.y</code> and you
would type <code>${var.x.y}</code> to display it in a
summary string for type <code>B</code>. </p>
<p>By default, a summary defined for type <code>T</code>, also works for types
<code>T*</code> and <code>T&</code> (you can disable this behavior if desired).
For this reason, expression paths do not differentiate between <code>.</code>
and <code>-></code>, and the above expression path <code>.x.y</code>
would be just as good if you were displaying a <code>B*</code>,
or even if the actual definition of <code>B</code>
were: <code><br>
<font color="blue">struct</font> B {<br>
A *x;<br>
A y;<br>
<font color="blue">int</font> *z;<br>
};<br>
</code> </p>
<p>This is unlike the behavior of <code>frame variable</code>
which, on the contrary, will enforce the distinction. As
hinted above, the rationale for this choice is that
waiving this distinction enables you to write a summary
string once for type <code>T</code> and use it for both
<code>T</code> and <code>T*</code> instances. As a
summary string is mostly about extracting nested
members' information, a pointer to an object is just as
good as the object itself for the purpose.</p>
<p>If you need to access the value of the integer pointed to by <code>B::z</code>, you
cannot simply say <code>${var.z}</code> because that symbol refers to the pointer <code>z</code>.
In order to dereference it and get the pointed value, you should say <code>${*var.z}</code>. The <code>${*var</code>
tells LLDB to get the object that the expression paths leads to, and then dereference it. In this example is it
equivalent to <code>*(bObject.z)</code> in C/C++ syntax. Because <code>.</code> and <code>-></code> operators can both be
used, there is no need to have dereferences in the middle of an expression path (e.g. you do not need to type
<code>${*(var.x).x})</code> to read <code>A::x</code> as contained in <code>*(B::x)</code>. To achieve that effect
you can simply write <code>${var.x->x}</code>, or even <code>${var.x.x}</code>. The <code>*</code> operator only binds
to the result of the whole expression path, rather than piecewise, and there is no way to use parentheses to change
that behavior.</p>
<p>Of course, a summary string can contain more than one <code>${var</code> specifier,
and can use <code>${var</code> and <code>${*var</code> specifiers together.</p>
</div>
</div>
<div class="post">
<h1 class="postheader">Formatting summary elements</h1>
<div class="postcontent">
<p>An expression path can include formatting codes.
Much like the type formats discussed previously, you can also customize
the way variables are displayed in summary strings, regardless of the format they have
applied to their types. To do that, you can use <code>%<i>format</i></code> inside an expression path,
as in <code>${var.x->x%u}</code>, which would display the value of <code>x</code> as an unsigned integer.
<p>You can also use some other special format markers, not available
for formats themselves, but which carry a special meaning when used in this
context:</p>
<table border="1">
<tbody>
<tr valign="top">
<td width="23%"><b>Symbol</b></td>
<td><b>Description</b></td>
</tr>
<tr valign="top">
<td><b>%S</b></td>
<td>Use this object's summary (the default for aggregate types)</td>
</tr>
<tr valign="top">
<td><b>%V</b></td>
<td>Use this object's value (the default for non-aggregate types)</td>
</tr>
<tr valign="top">
<td><b>%@</b></td>
<td>Use a language-runtime specific description (for C++ this does nothing,
for Objective-C it calls the NSPrintForDebugger API)</td>
</tr>
<tr valign="top">
<td><b>%L</b></td>
<td>Use this object's location (memory address, register name, ...)</td>
</tr>
<tr valign="top">
<td><b>%#</b></td>
<td>Use the count of the children of this object</td>
</tr>
<tr valign="top">
<td><b>%T</b></td>
<td>Use this object's datatype name</td>
</tr>
<tr valign="top">
<td><b>%N</b></td>
<td>Print the variable's basename</td>
</tr>
<tr valign="top">
<td><b>%></b></td>
<td>Print the expression path for this item</td>
</tr>
</tbody>
</table>
<p>Starting with SVN r228207, you can also specify ${script.var:<i>pythonFuncName</i>}. Previously, back to r220821, this was
specified with a different syntax: ${var.script:<i>pythonFuncName</i>}.
<br/>It is expected that the function name you use specifies a function whose signature is the same
as a Python summary function. The return string from the function will be placed verbatim in the output.
<br/><br/>
You cannot use element access, or formatting symbols, in combination with this syntax. For example the following:
<table class="stats" width="620" cellspacing="0">
<td class="content">
${script.var.element[0]:myFunctionName%@}
</td>
<table>
is not valid and will cause the summary to fail to evaluate.
</p>
</div>
</div>
<div class="post">
<h1 class="postheader">Element inlining</h1>
<div class="postcontent">
<p>Option <code>--inline-children</code> (<code>-c</code>) to <code>type summary add</code>
tells LLDB not to look for a summary string, but instead
to just print a listing of all the object's children on
one line.</p>
<p> As an example, given a type <code>pair</code>:
<code> <br>
<b>(lldb)</b> frame variable --show-types a_pair<br>
(pair) a_pair = {<br>
(int) first = 1;<br/>
(int) second = 2;<br/>
}<br>
</code><br>
If one types the following commands:
<table class="stats" width="620" cellspacing="0">
<td class="content">
<b>(lldb)</b> type summary add --inline-children pair<br>
</td>
<table>
the output becomes: <br><code>
<b>(lldb)</b> frame variable a_pair<br>
(pair) a_pair = (first=1, second=2)<br>
</code> </p>
Of course, one can obtain the same effect by typing
<table class="stats" width="620" cellspacing="0">
<td class="content">
<b>(lldb)</b> type summary add pair --summary-string "(first=${var.first}, second=${var.second})"<br>
</td>
<table>
While the final result is the same, using <code>--inline-children</code> can often save time. If one does not need to
see the names of the variables, but just their values, the option <code>--omit-names</code> (<code>-O</code>, uppercase letter o), can be combined with <code>--inline-children</code> to obtain:
<br><code>
<b>(lldb)</b> frame variable a_pair<br>
(pair) a_pair = (1, 2)<br>
</code> </p>
which is of course the same as
typing
<table class="stats" width="620" cellspacing="0">
<td class="content">
<b>(lldb)</b> type summary add pair --summary-string "(${var.first}, ${var.second})"<br>
</td>
<table>
</div>
</div>
<div class="post">
<h1 class="postheader">Bitfields and array syntax</h1>
<div class="postcontent">
<p>Sometimes, a basic type's value actually represents
several different values packed together in a bitfield.<br/>
With the classical view, there is no way to look at
them. Hexadecimal display can help, but if the bits
actually span nibble boundaries, the help is limited.<br/>
Binary view would show it all without ambiguity, but is
often too detailed and hard to read for real-life
scenarios.
<p>
To cope with the issue, LLDB supports native
bitfield formatting in summary strings. If your
expression paths leads to a so-called <i>scalar type</i>
(the usual int, float, char, double, short, long, long
long, double, long double and unsigned variants), you
can ask LLDB to only grab some bits out of the value and
display them in any format you like. If you only need one bit
you can use the <code>[</code><i>n</i><code>]</code>, just like
indexing an array. To extract multiple bits, you can use
a slice-like syntax: <code>[</code><i>n</i>-<i>m</i><code>]</code>, e.g. <br><p>
<code> <b>(lldb)</b> frame variable float_point<br>
(float) float_point = -3.14159<br> </code>
<table class="stats" width="620" cellspacing="0">
<td class="content">
<b>(lldb)</b> type summary add --summary-string "Sign: ${var[31]%B}
Exponent: ${var[30-23]%x} Mantissa: ${var[0-22]%u}"
float
</td>
</table><br></code>
<code>
<b>(lldb)</b> frame variable float_point<br>
(float) float_point = -3.14159 Sign: true Exponent:
0x00000080 Mantissa: 4788184<br>
</code> In this example, LLDB shows the internal
representation of a <code>float</code> variable by
extracting bitfields out of a float object.</p>
<p> When typing a range, the extremes <i>n</i> and <i>m</i> are always
included, and the order of the indices is irrelevant. </p>
<p>LLDB also allows to use a similar syntax to display
array members inside a summary string. For instance, you
may want to display all arrays of a given type using a
more compact notation than the default, and then just
delve into individual array members that prove
interesting to your debugging task. You can tell
LLDB to format arrays in special ways, possibly
independent of the way the array members' datatype is formatted. <br>
e.g. <br>
<code> <b>(lldb)</b> frame variable sarray<br>
(Simple [3]) sarray = {<br>
[0] = {<br>
x = 1<br>
y = 2<br>
z = '\x03'<br>
}<br>
[1] = {<br>
x = 4<br>
y = 5<br>
z = '\x06'<br>
}<br>
[2] = {<br>
x = 7<br>
y = 8<br>
z = '\t'<br>
}<br>
}<br></code>
<table class="stats" width="620" cellspacing="0">
<td class="content">
<b>(lldb)</b> type summary add --summary-string "${var[].x}" "Simple
[3]"
</td>
<table><br>
<code>
<b>(lldb)</b> frame variable sarray<br>
(Simple [3]) sarray = [1,4,7]<br></code></p>
<p>The <code>[]</code> symbol amounts to: <i>if <code>var</code>
is an array and I know its size, apply this summary
string to every element of the array</i>. Here, we are
asking LLDB to display <code>.x</code> for every
element of the array, and in fact this is what happens.
If you find some of those integers anomalous, you can
then inspect that one item in greater detail, without
the array format getting in the way: <br>
<code> <b>(lldb)</b> frame variable sarray[1]<br>
(Simple) sarray[1] = {<br>
x = 4<br>
y = 5<br>
z = '\x06'<br>
}<br>
</code> </p>
<p>You can also ask LLDB to only print a subset of the
array range by using the same syntax used to extract bit
for bitfields:
<table class="stats" width="620" cellspacing="0">
<td class="content">
<b>(lldb)</b> type summary add --summary-string "${var[1-2].x}" "Simple
[3]"
</td>
<table><br>
<code>
<b>(lldb)</b> frame variable sarray<br>
(Simple [3]) sarray = [4,7]<br></code></p>
<p>If you are dealing with a pointer that you know is an array, you can use this
syntax to display the elements contained in the pointed array instead of just
the pointer value. However, because pointers have no notion of their size, the
empty brackets <code>[]</code> operator does not work, and you must explicitly provide
higher and lower bounds.</p>
<p>In general, LLDB needs the square brackets operator <code>[]</code> in
order to handle arrays and pointers correctly, and for pointers it also
needs a range. However, a few special cases are defined to make your life easier:
<ul>
<li>you can print a 0-terminated string (<i>C-string</i>) using the %s format,
omitting square brackets, as in:
<table class="stats" width="620" cellspacing="0">
<td class="content">
<b>(lldb)</b> type summary add --summary-string "${var%s}" "char *"
</td>
<table>
<p>
This syntax works for <code>char*</code> as well as for <code>char[]</code>
because LLDB can rely on the final <code>\0</code> terminator to know when the string
has ended.</p>
LLDB has default summary strings for <code>char*</code> and <code>char[]</code> that use
this special case. On debugger startup, the following are defined automatically:
<table class="stats" width="620" cellspacing="0">
<td class="content">
<b>(lldb)</b> type summary add --summary-string "${var%s}" "char *"<br/>
<b>(lldb)</b> type summary add --summary-string "${var%s}" -x "char \[[0-9]+]"<br/>
</td>
<table>
</li>
</ul>
<ul>
<li>any of the array formats (<code>int8_t[]</code>,
<code>float32{}</code>, ...), and the <code>y</code>, <code>Y</code>
and <code>a</code> formats
work to print an array of a non-aggregate
type, even if square brackets are omitted.
<table class="stats" width="620" cellspacing="0">
<td class="content">
<b>(lldb)</b> type summary add --summary-string "${var%int32_t[]}" "int [10]"
</td>
<table>
</ul>
This feature, however, is not enabled for pointers because there is no
way for LLDB to detect the end of the pointed data.
<br>
This also does not work for other formats (e.g. <code>boolean</code>), and you must
specify the square brackets operator to get the expected output.
</p>
</div>
</div>
<div class="post">
<h1 class="postheader">Python scripting</h1>
<div class="postcontent">
<p>Most of the times, summary strings prove good enough for the job of summarizing
the contents of a variable. However, as soon as you need to do more than picking
some values and rearranging them for display, summary strings stop being an
effective tool. This is because summary strings lack the power to actually perform
any kind of computation on the value of variables.</p>
<p>To solve this issue, you can bind some Python scripting code as a summary for
your datatype, and that script has the ability to both extract children variables
as the summary strings do and to perform active computation on the extracted
values. As a small example, let's say we have a Rectangle class:</p>
<code>
<font color="blue">class</font> Rectangle<br/>
{<br/>
<font color="blue">private</font>:<br/>
<font color="blue">int</font> height;<br/>
<font color="blue">int</font> width;<br/>
<font color="blue">public</font>:<br/>
Rectangle() : height(3), width(5) {}<br/>
Rectangle(<font color="blue">int</font> H) : height(H), width(H*2-1) {}<br/>
Rectangle(<font color="blue">int</font> H, <font color="blue">int</font> W) : height(H), width(W) {}<br/>
<font color="blue">int</font> GetHeight() { return height; }<br/>
<font color="blue">int</font> GetWidth() { return width; }<br/>
};<br/>
</code>
<p>Summary strings are effective to reduce the screen real estate used by
the default viewing mode, but are not effective if we want to display the
area and perimeter of <code>Rectangle</code> objects</p>
<p>To obtain this, we can simply attach a small Python script to the <code>Rectangle</code>
class, as shown in this example:</p>
<table class="stats" width="620" cellspacing="0">
<td class="content">
<b>(lldb)</b> type summary add -P Rectangle<br/>
Enter your Python command(s). Type 'DONE' to end.<br/>
def function (valobj,internal_dict):<br/>
height_val = valobj.GetChildMemberWithName('height')<br/>
width_val = valobj.GetChildMemberWithName('width')<br/>
height = height_val.GetValueAsUnsigned(0)<br/>
width = width_val.GetValueAsUnsigned(0)<br/>
area = height*width<br/>
perimeter = 2*(height + width)<br/>
return 'Area: ' + str(area) + ', Perimeter: ' + str(perimeter)<br/>
DONE<br/>
<b>(lldb)</b> frame variable<br/>
(Rectangle) r1 = Area: 20, Perimeter: 18<br/>
(Rectangle) r2 = Area: 72, Perimeter: 36<br/>
(Rectangle) r3 = Area: 16, Perimeter: 16<br/>
</td>
</table>
<p>In order to write effective summary scripts, you need to know the LLDB public
API, which is the way Python code can access the LLDB object model. For further
details on the API you should look at <a href="scripting.html">this page</a>, or at
the LLDB <a href="docs.html">API reference documentation</a>.</p>
<p>As a brief introduction, your script is encapsulated into a function that is
passed two parameters: <code>valobj</code> and <code>internal_dict</code>.</p>
<p><code>internal_dict</code> is an internal support parameter used by LLDB and you should
not touch it.<br/><code>valobj</code> is the object encapsulating the actual
variable being displayed, and its type is <a href="http://llvm.org/svn/llvm-project/lldb/trunk/include/lldb/API/SBValue.h">SBValue</a>.
Out of the many possible operations on an SBValue, the basic one is retrieve the children objects
it contains (essentially, the fields of the object wrapped by it), by calling
<code>GetChildMemberWithName()</code>, passing it the child's name as a string.<br/>
If the variable has a value, you can ask for it, and return it as a string using <code>GetValue()</code>,
or as a signed/unsigned number using <code>GetValueAsSigned()</code>, <code>GetValueAsUnsigned()</code>.
It is also possible to retrieve an <a href="http://llvm.org/svn/llvm-project/lldb/trunk/include/lldb/API/SBData.h"><code>SBData</code></a> object by calling <code>GetData()</code> and then read
the object's contents out of the <code>SBData</code>.
<p>If you need to delve into several levels of hierarchy, as you can do with summary
strings, you can use the method <code>GetValueForExpressionPath()</code>, passing it
an expression path just like those you could use for summary strings (one of the differences
is that dereferencing a pointer does not occur by prefixing the path with a <code>*</code>,
but by calling the <code>Dereference()</code> method on the returned SBValue).
If you need to access array slices, you cannot do that (yet) via this method call, and you must
use <code>GetChildAtIndex()</code> querying it for the array items one by one.
Also, handling custom formats is something you have to deal with on your own.
<p>Other than interactively typing a Python script there are two other ways for you
to input a Python script as a summary:
<ul>
<li> using the --python-script option to <code>type summary add </code> and typing the script
code as an option argument; as in: </ul>
<table class="stats" width="620" cellspacing="0">
<td class="content">
<b>(lldb)</b> type summary add --python-script "height =
valobj.GetChildMemberWithName('height').GetValueAsUnsigned(0);width =
valobj.GetChildMemberWithName('width').GetValueAsUnsigned(0);
return 'Area: %d' % (height*width)" Rectangle<br/>
</td>
</table>
<ul>
<li> using the <code>--python-function</code> (<code>-F</code>) option to <code>type summary add </code> and giving the name of a
Python function with the correct prototype. Most probably, you will define (or have
already defined) the function in the interactive interpreter, or somehow
loaded it from a file, using the <code>command script import</code> command. LLDB will emit a warning if it is unable to find the function you passed, but will still register the binding.
</ul>
</p>
<p>Starting in SVN r222593, Python summary formatters can optionally define a third argument: <code>options</code><br/>
This is an object of type lldb.SBTypeSummaryOptions that can be passed into the formatter, allowing for a few customizations of the result.
The decision to adopt or not this third argument - and the meaning of options thereof - is within the individual formatters' writer.<br/>
</div>
</div>
<div class="post">
<h1 class="postheader">Regular expression typenames</h1>
<div class="postcontent">
<p>As you noticed, in order to associate the custom
summary string to the array types, one must give the
array size as part of the typename. This can long become
tiresome when using arrays of different sizes, <code>Simple
[3]</code>, <code>Simple [9]</code>, <code>Simple
[12]</code>, ...</p>
<p>If you use the <code>-x</code> option, type names are
treated as regular expressions instead of type names.
This would let you rephrase the above example
for arrays of type <code>Simple [3]</code> as: <br>
<table class="stats" width="620" cellspacing="0">
<td class="content">
<b>(lldb)</b> type summary add --summary-string "${var[].x}"
-x "Simple \[[0-9]+\]"
</td>
<table>
<code>
<b>(lldb)</b> frame variable<br>
(Simple [3]) sarray = [1,4,7]<br>
(Simple [2]) sother = [3,6]<br>
</code> The above scenario works for <code>Simple [3]</code>
as well as for any other array of <code>Simple</code>
objects. </p>
<p>While this feature is mostly useful for arrays, you
could also use regular expressions to catch other type
sets grouped by name. However, as regular expression
matching is slower than normal name matching, LLDB will
first try to match by name in any way it can, and only
when this fails, will it resort to regular expression
matching. </p>
<p>One of the ways LLDB uses this feature internally, is to match
the names of STL container classes, regardless of the template
arguments provided. The details for this are found at <a href="http://llvm.org/svn/llvm-project/lldb/trunk/source/DataFormatters/FormatManager.cpp">FormatManager.cpp</a></p>
<p>The regular expression language used by LLDB is the <a href="http://en.wikipedia.org/wiki/Regular_expression#POSIX_Extended_Regular_Expressions">POSIX extended language</a>, as defined by the <a href="http://pubs.opengroup.org/onlinepubs/7908799/xsh/regex.h.html">Single UNIX Specification</a>, of which Mac OS X is a
compliant implementation.
</div>
</div>
<div class="post">
<h1 class="postheader">Named summaries</h1>
<div class="postcontent">
<p>For a given type, there may be different meaningful summary
representations. However, currently, only one summary can be associated
to a type at each moment. If you need to temporarily override the association
for a variable, without changing the summary string for to its type,
you can use named summaries.</p>
<p>Named summaries work by attaching a name to a summary when creating
it. Then, when there is a need to attach the summary to a variable, the
<code>frame variable</code> command, supports a <code>--summary</code> option
that tells LLDB to use the named summary given instead of the default one.</p>
<table class="stats" width="620" cellspacing="0">
<td class="content">
<b>(lldb)</b> type summary add --summary-string "x=${var.integer}" --name NamedSummary
</td>
<table>
<code> <b>(lldb)</b> frame variable one<br>
(i_am_cool) one = int = 3, float = 3.14159, char = 69<br>
<b>(lldb)</b> frame variable one --summary NamedSummary<br>
(i_am_cool) one = x=3<br>
</code> </p>
<p>When defining a named summary, binding it to one or more types becomes optional.
Even if you bind the named summary to a type, and later change the summary string
for that type, the named summary will not be changed by that. You can delete
named summaries by using the <code>type summary delete</code> command, as if the
summary name was the datatype that the summary is applied to</p>
<p>A summary attached to a variable using the </code>--summary</code> option,
has the same semantics that a custom format attached using the <code>-f</code>