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
|
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>llvm-pdbutil - PDB File forensics and diagnostics — LLVM 13 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/llvm-theme.css" type="text/css" />
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="llvm-profgen - LLVM SPGO profile generation tool" href="llvm-profgen.html" />
<link rel="prev" title="llvm-locstats - calculate statistics on DWARF debug location" href="llvm-locstats.html" />
<style type="text/css">
table.right { float: right; margin-left: 20px; }
table.right td { border: 1px solid #ccc; }
</style>
</head><body>
<div class="logo">
<a href="../index.html">
<img src="../_static/logo.png"
alt="LLVM Logo" width="250" height="88"/></a>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="llvm-profgen.html" title="llvm-profgen - LLVM SPGO profile generation tool"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="llvm-locstats.html" title="llvm-locstats - calculate statistics on DWARF debug location"
accesskey="P">previous</a> |</li>
<li><a href="https://llvm.org/">LLVM Home</a> | </li>
<li><a href="../index.html">Documentation</a>»</li>
<li class="nav-item nav-item-1"><a href="../Reference.html" >Reference</a> »</li>
<li class="nav-item nav-item-2"><a href="index.html" accesskey="U">LLVM Command Guide</a> »</li>
<li class="nav-item nav-item-this"><a href="">llvm-pdbutil - PDB File forensics and diagnostics</a></li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3>Documentation</h3>
<ul class="want-points">
<li><a href="https://llvm.org/docs/GettingStartedTutorials.html">Getting Started/Tutorials</a></li>
<li><a href="https://llvm.org/docs/UserGuides.html">User Guides</a></li>
<li><a href="https://llvm.org/docs/Reference.html">Reference</a></li>
</ul>
<h3>Getting Involved</h3>
<ul class="want-points">
<li><a href="https://llvm.org/docs/Contributing.html">Contributing to LLVM</a></li>
<li><a href="https://llvm.org/docs/HowToSubmitABug.html">Submitting Bug Reports</a></li>
<li><a href="https://llvm.org/docs/GettingInvolved.html#mailing-lists">Mailing Lists</a></li>
<li><a href="https://llvm.org/docs/GettingInvolved.html#irc">IRC</a></li>
<li><a href="https://llvm.org/docs/GettingInvolved.html#meetups-and-social-events">Meetups and Social Events</a></li>
</ul>
<h3>Additional Links</h3>
<ul class="want-points">
<li><a href="https://llvm.org/docs/FAQ.html">FAQ</a></li>
<li><a href="https://llvm.org/docs/Lexicon.html">Glossary</a></li>
<li><a href="https://llvm.org/pubs">Publications</a></li>
<li><a href="https://github.com/llvm/llvm-project//">Github Repository</a></li>
</ul>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/CommandGuide/llvm-pdbutil.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="llvm-pdbutil-pdb-file-forensics-and-diagnostics">
<h1>llvm-pdbutil - PDB File forensics and diagnostics<a class="headerlink" href="#llvm-pdbutil-pdb-file-forensics-and-diagnostics" title="Permalink to this headline">¶</a></h1>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><p><a class="reference internal" href="#synopsis" id="id12">Synopsis</a></p></li>
<li><p><a class="reference internal" href="#description" id="id13">Description</a></p></li>
<li><p><a class="reference internal" href="#subcommands" id="id14">Subcommands</a></p>
<ul>
<li><p><a class="reference internal" href="#pretty" id="id15">pretty</a></p>
<ul>
<li><p><a class="reference internal" href="#summary" id="id16">Summary</a></p></li>
<li><p><a class="reference internal" href="#options" id="id17">Options</a></p>
<ul>
<li><p><a class="reference internal" href="#filtering-and-sorting-options" id="id18">Filtering and Sorting Options</a></p></li>
<li><p><a class="reference internal" href="#symbol-type-options" id="id19">Symbol Type Options</a></p></li>
<li><p><a class="reference internal" href="#other-options" id="id20">Other Options</a></p></li>
</ul>
</li>
</ul>
</li>
<li><p><a class="reference internal" href="#dump" id="id21">dump</a></p>
<ul>
<li><p><a class="reference internal" href="#id1" id="id22">Summary</a></p></li>
<li><p><a class="reference internal" href="#id2" id="id23">Options</a></p>
<ul>
<li><p><a class="reference internal" href="#msf-container-options" id="id24">MSF Container Options</a></p></li>
<li><p><a class="reference internal" href="#module-file-options" id="id25">Module & File Options</a></p></li>
<li><p><a class="reference internal" href="#symbol-options" id="id26">Symbol Options</a></p></li>
<li><p><a class="reference internal" href="#type-record-options" id="id27">Type Record Options</a></p></li>
<li><p><a class="reference internal" href="#miscellaneous-options" id="id28">Miscellaneous Options</a></p></li>
</ul>
</li>
</ul>
</li>
<li><p><a class="reference internal" href="#bytes" id="id29">bytes</a></p>
<ul>
<li><p><a class="reference internal" href="#id3" id="id30">Summary</a></p></li>
<li><p><a class="reference internal" href="#id4" id="id31">Options</a></p>
<ul>
<li><p><a class="reference internal" href="#msf-file-options" id="id32">MSF File Options</a></p></li>
<li><p><a class="reference internal" href="#pdb-stream-options" id="id33">PDB Stream Options</a></p></li>
<li><p><a class="reference internal" href="#dbi-stream-options" id="id34">DBI Stream Options</a></p></li>
<li><p><a class="reference internal" href="#module-options" id="id35">Module Options</a></p></li>
<li><p><a class="reference internal" href="#id5" id="id36">Type Record Options</a></p></li>
</ul>
</li>
</ul>
</li>
<li><p><a class="reference internal" href="#pdb2yaml" id="id37">pdb2yaml</a></p>
<ul>
<li><p><a class="reference internal" href="#id6" id="id38">Summary</a></p></li>
<li><p><a class="reference internal" href="#id7" id="id39">Options</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#yaml2pdb" id="id40">yaml2pdb</a></p>
<ul>
<li><p><a class="reference internal" href="#id8" id="id41">Summary</a></p></li>
<li><p><a class="reference internal" href="#id9" id="id42">Options</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#merge" id="id43">merge</a></p>
<ul>
<li><p><a class="reference internal" href="#id10" id="id44">Summary</a></p></li>
<li><p><a class="reference internal" href="#id11" id="id45">Options</a></p></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="section" id="synopsis">
<h2><a class="toc-backref" href="#id12">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
<p><strong class="program">llvm-pdbutil</strong> [<em>subcommand</em>] [<em>options</em>]</p>
</div>
<div class="section" id="description">
<h2><a class="toc-backref" href="#id13">Description</a><a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
<p>Display types, symbols, CodeView records, and other information from a
PDB file, as well as manipulate and create PDB files. <strong class="program">llvm-pdbutil</strong>
is normally used by FileCheck-based tests to test LLVM’s PDB reading and
writing functionality, but can also be used for general PDB file investigation
and forensics, or as a replacement for cvdump.</p>
</div>
<div class="section" id="subcommands">
<h2><a class="toc-backref" href="#id14">Subcommands</a><a class="headerlink" href="#subcommands" title="Permalink to this headline">¶</a></h2>
<p><strong class="program">llvm-pdbutil</strong> is separated into several subcommands each tailored to
a different purpose. A brief summary of each command follows, with more detail
in the sections that follow.</p>
<blockquote>
<div><ul class="simple">
<li><p><a class="reference internal" href="#pretty-subcommand"><span class="std std-ref">pretty</span></a> - Dump symbol and type information in a format that
tries to look as much like the original source code as possible.</p></li>
<li><p><a class="reference internal" href="#dump-subcommand"><span class="std std-ref">dump</span></a> - Dump low level types and structures from the PDB
file, including CodeView records, hash tables, PDB streams, etc.</p></li>
<li><p><a class="reference internal" href="#bytes-subcommand"><span class="std std-ref">bytes</span></a> - Dump data from the PDB file’s streams, records,
types, symbols, etc as raw bytes.</p></li>
<li><p><a class="reference internal" href="#yaml2pdb-subcommand"><span class="std std-ref">yaml2pdb</span></a> - Given a yaml description of a PDB file, produce
a valid PDB file that matches that description.</p></li>
<li><p><a class="reference internal" href="#pdb2yaml-subcommand"><span class="std std-ref">pdb2yaml</span></a> - For a given PDB file, produce a YAML
description of some or all of the file in a way that the PDB can be
reconstructed.</p></li>
<li><p><a class="reference internal" href="#merge-subcommand"><span class="std std-ref">merge</span></a> - Given two PDBs, produce a third PDB that is the
result of merging the two input PDBs.</p></li>
</ul>
</div></blockquote>
<div class="section" id="pretty">
<span id="pretty-subcommand"></span><h3><a class="toc-backref" href="#id15">pretty</a><a class="headerlink" href="#pretty" title="Permalink to this headline">¶</a></h3>
<div class="admonition important">
<p class="admonition-title">Important</p>
<p>The <strong>pretty</strong> subcommand is built on the Windows DIA SDK, and as such is not
supported on non-Windows platforms.</p>
</div>
<p>USAGE: <strong class="program">llvm-pdbutil</strong> pretty [<em>options</em>] <input PDB file></p>
<div class="section" id="summary">
<h4><a class="toc-backref" href="#id16">Summary</a><a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h4>
<p>The <em>pretty</em> subcommand displays a very high level representation of your
program’s debug info. Since it is built on the Windows DIA SDK which is the
standard API that Windows tools and debuggers query debug information, it
presents a more authoritative view of how a debugger is going to interpret your
debug information than a mode which displays low-level CodeView records.</p>
</div>
<div class="section" id="options">
<h4><a class="toc-backref" href="#id17">Options</a><a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h4>
<div class="section" id="filtering-and-sorting-options">
<h5><a class="toc-backref" href="#id18">Filtering and Sorting Options</a><a class="headerlink" href="#filtering-and-sorting-options" title="Permalink to this headline">¶</a></h5>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><em>exclude</em> filters take priority over <em>include</em> filters. So if a filter
matches both an include and an exclude rule, then it is excluded.</p>
</div>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-pretty-exclude-compilands">
<code class="sig-name descname"><span class="pre">-exclude-compilands</span></code><code class="sig-prename descclassname"><span class="pre">=<string></span></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-pretty-exclude-compilands" title="Permalink to this definition">¶</a></dt>
<dd><p>When dumping compilands, compiland source-file contributions, or per-compiland
symbols, this option instructs <strong>llvm-pdbutil</strong> to omit any compilands that
match the specified regular expression.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-pretty-exclude-symbols">
<code class="sig-name descname"><span class="pre">-exclude-symbols</span></code><code class="sig-prename descclassname"><span class="pre">=<string></span></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-pretty-exclude-symbols" title="Permalink to this definition">¶</a></dt>
<dd><p>When dumping global, public, or per-compiland symbols, this option instructs
<strong>llvm-pdbutil</strong> to omit any symbols that match the specified regular
expression.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-pretty-exclude-types">
<code class="sig-name descname"><span class="pre">-exclude-types</span></code><code class="sig-prename descclassname"><span class="pre">=<string></span></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-pretty-exclude-types" title="Permalink to this definition">¶</a></dt>
<dd><p>When dumping types, this option instructs <strong>llvm-pdbutil</strong> to omit any types
that match the specified regular expression.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-pretty-include-compilands">
<code class="sig-name descname"><span class="pre">-include-compilands</span></code><code class="sig-prename descclassname"><span class="pre">=<string></span></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-pretty-include-compilands" title="Permalink to this definition">¶</a></dt>
<dd><p>When dumping compilands, compiland source-file contributions, or per-compiland
symbols, limit the initial search to only those compilands that match the
specified regular expression.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-pretty-include-symbols">
<code class="sig-name descname"><span class="pre">-include-symbols</span></code><code class="sig-prename descclassname"><span class="pre">=<string></span></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-pretty-include-symbols" title="Permalink to this definition">¶</a></dt>
<dd><p>When dumping global, public, or per-compiland symbols, limit the initial
search to only those symbols that match the specified regular expression.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-pretty-include-types">
<code class="sig-name descname"><span class="pre">-include-types</span></code><code class="sig-prename descclassname"><span class="pre">=<string></span></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-pretty-include-types" title="Permalink to this definition">¶</a></dt>
<dd><p>When dumping types, limit the initial search to only those types that match
the specified regular expression.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-pretty-min-class-padding">
<code class="sig-name descname"><span class="pre">-min-class-padding</span></code><code class="sig-prename descclassname"><span class="pre">=<uint></span></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-pretty-min-class-padding" title="Permalink to this definition">¶</a></dt>
<dd><p>Only display types that have at least the specified amount of alignment
padding, accounting for padding in base classes and aggregate field members.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-pretty-min-class-padding-imm">
<code class="sig-name descname"><span class="pre">-min-class-padding-imm</span></code><code class="sig-prename descclassname"><span class="pre">=<uint></span></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-pretty-min-class-padding-imm" title="Permalink to this definition">¶</a></dt>
<dd><p>Only display types that have at least the specified amount of alignment
padding, ignoring padding in base classes and aggregate field members.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-pretty-min-type-size">
<code class="sig-name descname"><span class="pre">-min-type-size</span></code><code class="sig-prename descclassname"><span class="pre">=<uint></span></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-pretty-min-type-size" title="Permalink to this definition">¶</a></dt>
<dd><p>Only display types T where sizeof(T) is greater than or equal to the specified
amount.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-pretty-no-compiler-generated">
<code class="sig-name descname"><span class="pre">-no-compiler-generated</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-pretty-no-compiler-generated" title="Permalink to this definition">¶</a></dt>
<dd><p>Don’t show compiler generated types and symbols</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-pretty-no-enum-definitions">
<code class="sig-name descname"><span class="pre">-no-enum-definitions</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-pretty-no-enum-definitions" title="Permalink to this definition">¶</a></dt>
<dd><p>When dumping an enum, don’t show the full enum (e.g. the individual enumerator
values).</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-pretty-no-system-libs">
<code class="sig-name descname"><span class="pre">-no-system-libs</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-pretty-no-system-libs" title="Permalink to this definition">¶</a></dt>
<dd><p>Don’t show symbols from system libraries</p>
</dd></dl>
</div>
<div class="section" id="symbol-type-options">
<h5><a class="toc-backref" href="#id19">Symbol Type Options</a><a class="headerlink" href="#symbol-type-options" title="Permalink to this headline">¶</a></h5>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-pretty-all">
<code class="sig-name descname"><span class="pre">-all</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-pretty-all" title="Permalink to this definition">¶</a></dt>
<dd><p>Implies all other options in this category.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-pretty-class-definitions">
<code class="sig-name descname"><span class="pre">-class-definitions</span></code><code class="sig-prename descclassname"><span class="pre">=<format></span></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-pretty-class-definitions" title="Permalink to this definition">¶</a></dt>
<dd><p>Displays class definitions in the specified format.</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>=all - Display all class members including data, constants, typedefs, functions, etc (default)
=layout - Only display members that contribute to class size.
=none - Don't display class definitions (e.g. only display the name and base list)
</pre></div>
</div>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-pretty-class-order">
<code class="sig-name descname"><span class="pre">-class-order</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-pretty-class-order" title="Permalink to this definition">¶</a></dt>
<dd><p>Displays classes in the specified order.</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>=none - Undefined / no particular sort order (default)
=name - Sort classes by name
=size - Sort classes by size
=padding - Sort classes by amount of padding
=padding-pct - Sort classes by percentage of space consumed by padding
=padding-imm - Sort classes by amount of immediate padding
=padding-pct-imm - Sort classes by percentage of space consumed by immediate padding
</pre></div>
</div>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-pretty-class-recurse-depth">
<code class="sig-name descname"><span class="pre">-class-recurse-depth</span></code><code class="sig-prename descclassname"><span class="pre">=<uint></span></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-pretty-class-recurse-depth" title="Permalink to this definition">¶</a></dt>
<dd><p>When dumping class definitions, stop after recursing the specified number of times. The
default is 0, which is no limit.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-pretty-classes">
<code class="sig-name descname"><span class="pre">-classes</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-pretty-classes" title="Permalink to this definition">¶</a></dt>
<dd><p>Display classes</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-pretty-compilands">
<code class="sig-name descname"><span class="pre">-compilands</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-pretty-compilands" title="Permalink to this definition">¶</a></dt>
<dd><p>Display compilands (e.g. object files)</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-pretty-enums">
<code class="sig-name descname"><span class="pre">-enums</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-pretty-enums" title="Permalink to this definition">¶</a></dt>
<dd><p>Display enums</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-pretty-externals">
<code class="sig-name descname"><span class="pre">-externals</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-pretty-externals" title="Permalink to this definition">¶</a></dt>
<dd><p>Dump external (e.g. exported) symbols</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-pretty-globals">
<code class="sig-name descname"><span class="pre">-globals</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-pretty-globals" title="Permalink to this definition">¶</a></dt>
<dd><p>Dump global symbols</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-pretty-lines">
<code class="sig-name descname"><span class="pre">-lines</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-pretty-lines" title="Permalink to this definition">¶</a></dt>
<dd><p>Dump the mappings between source lines and code addresses.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-pretty-module-syms">
<code class="sig-name descname"><span class="pre">-module-syms</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-pretty-module-syms" title="Permalink to this definition">¶</a></dt>
<dd><p>Display symbols (variables, functions, etc) for each compiland</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-pretty-sym-types">
<code class="sig-name descname"><span class="pre">-sym-types</span></code><code class="sig-prename descclassname"><span class="pre">=<types></span></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-pretty-sym-types" title="Permalink to this definition">¶</a></dt>
<dd><p>Type of symbols to dump when -globals, -externals, or -module-syms is
specified. (default all)</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>=thunks - Display thunk symbols
=data - Display data symbols
=funcs - Display function symbols
=all - Display all symbols (default)
</pre></div>
</div>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-pretty-symbol-order">
<code class="sig-name descname"><span class="pre">-symbol-order</span></code><code class="sig-prename descclassname"><span class="pre">=<order></span></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-pretty-symbol-order" title="Permalink to this definition">¶</a></dt>
<dd><p>For symbols dumped via the -module-syms, -globals, or -externals options, sort
the results in specified order.</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>=none - Undefined / no particular sort order
=name - Sort symbols by name
=size - Sort symbols by size
</pre></div>
</div>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-pretty-typedefs">
<code class="sig-name descname"><span class="pre">-typedefs</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-pretty-typedefs" title="Permalink to this definition">¶</a></dt>
<dd><p>Display typedef types</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-pretty-types">
<code class="sig-name descname"><span class="pre">-types</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-pretty-types" title="Permalink to this definition">¶</a></dt>
<dd><p>Display all types (implies -classes, -enums, -typedefs)</p>
</dd></dl>
</div>
<div class="section" id="other-options">
<h5><a class="toc-backref" href="#id20">Other Options</a><a class="headerlink" href="#other-options" title="Permalink to this headline">¶</a></h5>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-pretty-color-output">
<code class="sig-name descname"><span class="pre">-color-output</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-pretty-color-output" title="Permalink to this definition">¶</a></dt>
<dd><p>Force color output on or off. By default, color if used if outputting to a
terminal.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-pretty-load-address">
<code class="sig-name descname"><span class="pre">-load-address</span></code><code class="sig-prename descclassname"><span class="pre">=<uint></span></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-pretty-load-address" title="Permalink to this definition">¶</a></dt>
<dd><p>When displaying relative virtual addresses, assume the process is loaded at the
given address and display what would be the absolute address.</p>
</dd></dl>
</div>
</div>
</div>
<div class="section" id="dump">
<span id="dump-subcommand"></span><h3><a class="toc-backref" href="#id21">dump</a><a class="headerlink" href="#dump" title="Permalink to this headline">¶</a></h3>
<p>USAGE: <strong class="program">llvm-pdbutil</strong> dump [<em>options</em>] <input PDB file></p>
<div class="section" id="id1">
<h4><a class="toc-backref" href="#id22">Summary</a><a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h4>
<p>The <strong>dump</strong> subcommand displays low level information about the structure of a
PDB file. It is used heavily by LLVM’s testing infrastructure, but can also be
used for PDB forensics. It serves a role similar to that of Microsoft’s
<cite>cvdump</cite> tool.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The <strong>dump</strong> subcommand exposes internal details of the file format. As
such, the reader should be familiar with <a class="reference internal" href="../PDB/index.html"><span class="doc">The PDB File Format</span></a> before using this
command.</p>
</div>
</div>
<div class="section" id="id2">
<h4><a class="toc-backref" href="#id23">Options</a><a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h4>
<div class="section" id="msf-container-options">
<h5><a class="toc-backref" href="#id24">MSF Container Options</a><a class="headerlink" href="#msf-container-options" title="Permalink to this headline">¶</a></h5>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-dump-streams">
<code class="sig-name descname"><span class="pre">-streams</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-dump-streams" title="Permalink to this definition">¶</a></dt>
<dd><p>dump a summary of all of the streams in the PDB file.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-dump-stream-blocks">
<code class="sig-name descname"><span class="pre">-stream-blocks</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-dump-stream-blocks" title="Permalink to this definition">¶</a></dt>
<dd><p>In conjunction with <a class="reference internal" href="#cmdoption-llvm-pdbutil-dump-streams"><code class="xref std std-option docutils literal notranslate"><span class="pre">-streams</span></code></a>, add information to the output about
what blocks the specified stream occupies.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-dump-summary">
<code class="sig-name descname"><span class="pre">-summary</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-dump-summary" title="Permalink to this definition">¶</a></dt>
<dd><p>Dump MSF and PDB header information.</p>
</dd></dl>
</div>
<div class="section" id="module-file-options">
<h5><a class="toc-backref" href="#id25">Module & File Options</a><a class="headerlink" href="#module-file-options" title="Permalink to this headline">¶</a></h5>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-dump-modi">
<code class="sig-name descname"><span class="pre">-modi</span></code><code class="sig-prename descclassname"><span class="pre">=<uint></span></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-dump-modi" title="Permalink to this definition">¶</a></dt>
<dd><p>For all options that dump information from each module/compiland, limit to
the specified module.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-dump-files">
<code class="sig-name descname"><span class="pre">-files</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-dump-files" title="Permalink to this definition">¶</a></dt>
<dd><p>Dump the source files that contribute to each displayed module.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-dump-il">
<code class="sig-name descname"><span class="pre">-il</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-dump-il" title="Permalink to this definition">¶</a></dt>
<dd><p>Dump inlinee line information (DEBUG_S_INLINEELINES CodeView subsection)</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-dump-l">
<code class="sig-name descname"><span class="pre">-l</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-dump-l" title="Permalink to this definition">¶</a></dt>
<dd><p>Dump line information (DEBUG_S_LINES CodeView subsection)</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-dump-modules">
<code class="sig-name descname"><span class="pre">-modules</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-dump-modules" title="Permalink to this definition">¶</a></dt>
<dd><p>Dump compiland information</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-dump-xme">
<code class="sig-name descname"><span class="pre">-xme</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-dump-xme" title="Permalink to this definition">¶</a></dt>
<dd><p>Dump cross module exports (DEBUG_S_CROSSSCOPEEXPORTS CodeView subsection)</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-dump-xmi">
<code class="sig-name descname"><span class="pre">-xmi</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-dump-xmi" title="Permalink to this definition">¶</a></dt>
<dd><p>Dump cross module imports (DEBUG_S_CROSSSCOPEIMPORTS CodeView subsection)</p>
</dd></dl>
</div>
<div class="section" id="symbol-options">
<h5><a class="toc-backref" href="#id26">Symbol Options</a><a class="headerlink" href="#symbol-options" title="Permalink to this headline">¶</a></h5>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-dump-globals">
<code class="sig-name descname"><span class="pre">-globals</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-dump-globals" title="Permalink to this definition">¶</a></dt>
<dd><p>dump global symbol records</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-dump-global-extras">
<code class="sig-name descname"><span class="pre">-global-extras</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-dump-global-extras" title="Permalink to this definition">¶</a></dt>
<dd><p>dump additional information about the globals, such as hash buckets and hash
values.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-dump-publics">
<code class="sig-name descname"><span class="pre">-publics</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-dump-publics" title="Permalink to this definition">¶</a></dt>
<dd><p>dump public symbol records</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-dump-public-extras">
<code class="sig-name descname"><span class="pre">-public-extras</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-dump-public-extras" title="Permalink to this definition">¶</a></dt>
<dd><p>dump additional information about the publics, such as hash buckets and hash
values.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-dump-symbols">
<code class="sig-name descname"><span class="pre">-symbols</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-dump-symbols" title="Permalink to this definition">¶</a></dt>
<dd><p>dump symbols (functions, variables, etc) for each module dumped.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-dump-sym-data">
<code class="sig-name descname"><span class="pre">-sym-data</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-dump-sym-data" title="Permalink to this definition">¶</a></dt>
<dd><p>For each symbol record dumped as a result of the <a class="reference internal" href="#cmdoption-llvm-pdbutil-dump-symbols"><code class="xref std std-option docutils literal notranslate"><span class="pre">-symbols</span></code></a> option,
display the full bytes of the record in binary as well.</p>
</dd></dl>
</div>
<div class="section" id="type-record-options">
<h5><a class="toc-backref" href="#id27">Type Record Options</a><a class="headerlink" href="#type-record-options" title="Permalink to this headline">¶</a></h5>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-dump-types">
<code class="sig-name descname"><span class="pre">-types</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-dump-types" title="Permalink to this definition">¶</a></dt>
<dd><p>Dump CodeView type records from TPI stream</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-dump-type-extras">
<code class="sig-name descname"><span class="pre">-type-extras</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-dump-type-extras" title="Permalink to this definition">¶</a></dt>
<dd><p>Dump additional information from the TPI stream, such as hashes and the type
index offsets array.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-dump-type-data">
<code class="sig-name descname"><span class="pre">-type-data</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-dump-type-data" title="Permalink to this definition">¶</a></dt>
<dd><p>For each type record dumped, display the full bytes of the record in binary as
well.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-dump-type-index">
<code class="sig-name descname"><span class="pre">-type-index</span></code><code class="sig-prename descclassname"><span class="pre">=<uint></span></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-dump-type-index" title="Permalink to this definition">¶</a></dt>
<dd><p>Only dump types with the specified type index.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-dump-ids">
<code class="sig-name descname"><span class="pre">-ids</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-dump-ids" title="Permalink to this definition">¶</a></dt>
<dd><p>Dump CodeView type records from IPI stream.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-dump-id-extras">
<code class="sig-name descname"><span class="pre">-id-extras</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-dump-id-extras" title="Permalink to this definition">¶</a></dt>
<dd><p>Dump additional information from the IPI stream, such as hashes and the type
index offsets array.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-dump-id-data">
<code class="sig-name descname"><span class="pre">-id-data</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-dump-id-data" title="Permalink to this definition">¶</a></dt>
<dd><p>For each ID record dumped, display the full bytes of the record in binary as
well.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-dump-id-index">
<code class="sig-name descname"><span class="pre">-id-index</span></code><code class="sig-prename descclassname"><span class="pre">=<uint></span></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-dump-id-index" title="Permalink to this definition">¶</a></dt>
<dd><p>only dump ID records with the specified hexadecimal type index.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-dump-dependents">
<code class="sig-name descname"><span class="pre">-dependents</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-dump-dependents" title="Permalink to this definition">¶</a></dt>
<dd><p>When used in conjunction with <a class="reference internal" href="#cmdoption-llvm-pdbutil-dump-type-index"><code class="xref std std-option docutils literal notranslate"><span class="pre">-type-index</span></code></a> or <a class="reference internal" href="#cmdoption-llvm-pdbutil-dump-id-index"><code class="xref std std-option docutils literal notranslate"><span class="pre">-id-index</span></code></a>,
dumps the entire dependency graph for the specified index instead of just the
single record with the specified index. For example, if type index 0x4000 is
a function whose return type has index 0x3000, and you specify
<cite>-dependents=0x4000</cite>, then this would dump both records (as well as any other
dependents in the tree).</p>
</dd></dl>
</div>
<div class="section" id="miscellaneous-options">
<h5><a class="toc-backref" href="#id28">Miscellaneous Options</a><a class="headerlink" href="#miscellaneous-options" title="Permalink to this headline">¶</a></h5>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-dump-all">
<code class="sig-name descname"><span class="pre">-all</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-dump-all" title="Permalink to this definition">¶</a></dt>
<dd><p>Implies most other options.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-dump-section-contribs">
<code class="sig-name descname"><span class="pre">-section-contribs</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-dump-section-contribs" title="Permalink to this definition">¶</a></dt>
<dd><p>Dump section contributions.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-dump-section-headers">
<code class="sig-name descname"><span class="pre">-section-headers</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-dump-section-headers" title="Permalink to this definition">¶</a></dt>
<dd><p>Dump image section headers.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-dump-section-map">
<code class="sig-name descname"><span class="pre">-section-map</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-dump-section-map" title="Permalink to this definition">¶</a></dt>
<dd><p>Dump section map.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-dump-string-table">
<code class="sig-name descname"><span class="pre">-string-table</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-dump-string-table" title="Permalink to this definition">¶</a></dt>
<dd><p>Dump PDB string table.</p>
</dd></dl>
</div>
</div>
</div>
<div class="section" id="bytes">
<span id="bytes-subcommand"></span><h3><a class="toc-backref" href="#id29">bytes</a><a class="headerlink" href="#bytes" title="Permalink to this headline">¶</a></h3>
<p>USAGE: <strong class="program">llvm-pdbutil</strong> bytes [<em>options</em>] <input PDB file></p>
<div class="section" id="id3">
<h4><a class="toc-backref" href="#id30">Summary</a><a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h4>
<p>Like the <strong>dump</strong> subcommand, the <strong>bytes</strong> subcommand displays low level
information about the structure of a PDB file, but it is used for even deeper
forensics. The <strong>bytes</strong> subcommand finds various structures in a PDB file
based on the command line options specified, and dumps them in hex. Someone
working on support for emitting PDBs would use this heavily, for example, to
compare one PDB against another PDB to ensure byte-for-byte compatibility. It
is not enough to simply compare the bytes of an entire file, or an entire stream
because it’s perfectly fine for the same structure to exist at different
locations in two different PDBs, and “finding” the structure is half the battle.</p>
</div>
<div class="section" id="id4">
<h4><a class="toc-backref" href="#id31">Options</a><a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h4>
<div class="section" id="msf-file-options">
<h5><a class="toc-backref" href="#id32">MSF File Options</a><a class="headerlink" href="#msf-file-options" title="Permalink to this headline">¶</a></h5>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-bytes-block-range">
<code class="sig-name descname"><span class="pre">-block-range</span></code><code class="sig-prename descclassname"><span class="pre">=<start[-end]></span></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-bytes-block-range" title="Permalink to this definition">¶</a></dt>
<dd><p>Dump binary data from specified range of MSF file blocks.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-bytes-byte-range">
<code class="sig-name descname"><span class="pre">-byte-range</span></code><code class="sig-prename descclassname"><span class="pre">=<start[-end]></span></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-bytes-byte-range" title="Permalink to this definition">¶</a></dt>
<dd><p>Dump binary data from specified range of bytes in the file.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-bytes-fpm">
<code class="sig-name descname"><span class="pre">-fpm</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-bytes-fpm" title="Permalink to this definition">¶</a></dt>
<dd><p>Dump the MSF free page map.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-bytes-stream-data">
<code class="sig-name descname"><span class="pre">-stream-data</span></code><code class="sig-prename descclassname"><span class="pre">=<string></span></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-bytes-stream-data" title="Permalink to this definition">¶</a></dt>
<dd><p>Dump binary data from the specified streams. Format is SN[:Start][@Size].
For example, <cite>-stream-data=7:3@12</cite> dumps 12 bytes from stream 7, starting
at offset 3 in the stream.</p>
</dd></dl>
</div>
<div class="section" id="pdb-stream-options">
<h5><a class="toc-backref" href="#id33">PDB Stream Options</a><a class="headerlink" href="#pdb-stream-options" title="Permalink to this headline">¶</a></h5>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-bytes-name-map">
<code class="sig-name descname"><span class="pre">-name-map</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-bytes-name-map" title="Permalink to this definition">¶</a></dt>
<dd><p>Dump bytes of PDB Name Map</p>
</dd></dl>
</div>
<div class="section" id="dbi-stream-options">
<h5><a class="toc-backref" href="#id34">DBI Stream Options</a><a class="headerlink" href="#dbi-stream-options" title="Permalink to this headline">¶</a></h5>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-bytes-ec">
<code class="sig-name descname"><span class="pre">-ec</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-bytes-ec" title="Permalink to this definition">¶</a></dt>
<dd><p>Dump the edit and continue map substream of the DBI stream.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-bytes-files">
<code class="sig-name descname"><span class="pre">-files</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-bytes-files" title="Permalink to this definition">¶</a></dt>
<dd><p>Dump the file info substream of the DBI stream.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-bytes-modi">
<code class="sig-name descname"><span class="pre">-modi</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-bytes-modi" title="Permalink to this definition">¶</a></dt>
<dd><p>Dump the modi substream of the DBI stream.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-bytes-sc">
<code class="sig-name descname"><span class="pre">-sc</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-bytes-sc" title="Permalink to this definition">¶</a></dt>
<dd><p>Dump section contributions substream of the DBI stream.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-bytes-sm">
<code class="sig-name descname"><span class="pre">-sm</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-bytes-sm" title="Permalink to this definition">¶</a></dt>
<dd><p>Dump the section map from the DBI stream.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-bytes-type-server">
<code class="sig-name descname"><span class="pre">-type-server</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-bytes-type-server" title="Permalink to this definition">¶</a></dt>
<dd><p>Dump the type server map from the DBI stream.</p>
</dd></dl>
</div>
<div class="section" id="module-options">
<h5><a class="toc-backref" href="#id35">Module Options</a><a class="headerlink" href="#module-options" title="Permalink to this headline">¶</a></h5>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-bytes-mod">
<code class="sig-name descname"><span class="pre">-mod</span></code><code class="sig-prename descclassname"><span class="pre">=<uint></span></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-bytes-mod" title="Permalink to this definition">¶</a></dt>
<dd><p>Limit all options in this category to the specified module index. By default,
options in this category will dump bytes from all modules.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-bytes-chunks">
<code class="sig-name descname"><span class="pre">-chunks</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-bytes-chunks" title="Permalink to this definition">¶</a></dt>
<dd><p>Dump the bytes of each module’s C13 debug subsection.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-bytes-split-chunks">
<code class="sig-name descname"><span class="pre">-split-chunks</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-bytes-split-chunks" title="Permalink to this definition">¶</a></dt>
<dd><p>When specified with <a class="reference internal" href="#cmdoption-llvm-pdbutil-bytes-chunks"><code class="xref std std-option docutils literal notranslate"><span class="pre">-chunks</span></code></a>, split the C13 debug subsection into a
separate chunk for each subsection type, and dump them separately.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-bytes-syms">
<code class="sig-name descname"><span class="pre">-syms</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-bytes-syms" title="Permalink to this definition">¶</a></dt>
<dd><p>Dump the symbol record substream from each module.</p>
</dd></dl>
</div>
<div class="section" id="id5">
<h5><a class="toc-backref" href="#id36">Type Record Options</a><a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h5>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-bytes-id">
<code class="sig-name descname"><span class="pre">-id</span></code><code class="sig-prename descclassname"><span class="pre">=<uint></span></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-bytes-id" title="Permalink to this definition">¶</a></dt>
<dd><p>Dump the record from the IPI stream with the given type index.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-bytes-type">
<code class="sig-name descname"><span class="pre">-type</span></code><code class="sig-prename descclassname"><span class="pre">=<uint></span></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-bytes-type" title="Permalink to this definition">¶</a></dt>
<dd><p>Dump the record from the TPI stream with the given type index.</p>
</dd></dl>
</div>
</div>
</div>
<div class="section" id="pdb2yaml">
<span id="pdb2yaml-subcommand"></span><h3><a class="toc-backref" href="#id37">pdb2yaml</a><a class="headerlink" href="#pdb2yaml" title="Permalink to this headline">¶</a></h3>
<p>USAGE: <strong class="program">llvm-pdbutil</strong> pdb2yaml [<em>options</em>] <input PDB file></p>
<div class="section" id="id6">
<h4><a class="toc-backref" href="#id38">Summary</a><a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h4>
</div>
<div class="section" id="id7">
<h4><a class="toc-backref" href="#id39">Options</a><a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h4>
</div>
</div>
<div class="section" id="yaml2pdb">
<span id="yaml2pdb-subcommand"></span><h3><a class="toc-backref" href="#id40">yaml2pdb</a><a class="headerlink" href="#yaml2pdb" title="Permalink to this headline">¶</a></h3>
<p>USAGE: <strong class="program">llvm-pdbutil</strong> yaml2pdb [<em>options</em>] <input YAML file></p>
<div class="section" id="id8">
<h4><a class="toc-backref" href="#id41">Summary</a><a class="headerlink" href="#id8" title="Permalink to this headline">¶</a></h4>
<p>Generate a PDB file from a YAML description. The YAML syntax is not described
here. Instead, use <a class="reference internal" href="#pdb2yaml-subcommand"><span class="std std-ref">llvm-pdbutil pdb2yaml</span></a> and
examine the output for an example starting point.</p>
</div>
<div class="section" id="id9">
<h4><a class="toc-backref" href="#id42">Options</a><a class="headerlink" href="#id9" title="Permalink to this headline">¶</a></h4>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-yaml2pdb-pdb">
<code class="sig-name descname"><span class="pre">-pdb</span></code><code class="sig-prename descclassname"><span class="pre">=<file-name></span></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-yaml2pdb-pdb" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<p>Write the resulting PDB to the specified file.</p>
</div>
</div>
<div class="section" id="merge">
<span id="merge-subcommand"></span><h3><a class="toc-backref" href="#id43">merge</a><a class="headerlink" href="#merge" title="Permalink to this headline">¶</a></h3>
<p>USAGE: <strong class="program">llvm-pdbutil</strong> merge [<em>options</em>] <input PDB file 1> <input PDB file 2></p>
<div class="section" id="id10">
<h4><a class="toc-backref" href="#id44">Summary</a><a class="headerlink" href="#id10" title="Permalink to this headline">¶</a></h4>
<p>Merge two PDB files into a single file.</p>
</div>
<div class="section" id="id11">
<h4><a class="toc-backref" href="#id45">Options</a><a class="headerlink" href="#id11" title="Permalink to this headline">¶</a></h4>
<dl class="std option">
<dt id="cmdoption-llvm-pdbutil-merge-pdb">
<code class="sig-name descname"><span class="pre">-pdb</span></code><code class="sig-prename descclassname"><span class="pre">=<file-name></span></code><a class="headerlink" href="#cmdoption-llvm-pdbutil-merge-pdb" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<p>Write the resulting PDB to the specified file.</p>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="llvm-profgen.html" title="llvm-profgen - LLVM SPGO profile generation tool"
>next</a> |</li>
<li class="right" >
<a href="llvm-locstats.html" title="llvm-locstats - calculate statistics on DWARF debug location"
>previous</a> |</li>
<li><a href="https://llvm.org/">LLVM Home</a> | </li>
<li><a href="../index.html">Documentation</a>»</li>
<li class="nav-item nav-item-1"><a href="../Reference.html" >Reference</a> »</li>
<li class="nav-item nav-item-2"><a href="index.html" >LLVM Command Guide</a> »</li>
<li class="nav-item nav-item-this"><a href="">llvm-pdbutil - PDB File forensics and diagnostics</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2003-2021, LLVM Project.
Last updated on 2021-09-18.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.5.4.
</div>
</body>
</html>
|
