]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - contrib/llvm/tools/llvm-bcanalyzer/llvm-bcanalyzer.cpp
Merge llvm, clang, lld, lldb, compiler-rt and libc++ r306956, and update
[FreeBSD/FreeBSD.git] / contrib / llvm / tools / llvm-bcanalyzer / llvm-bcanalyzer.cpp
1 //===-- llvm-bcanalyzer.cpp - Bitcode Analyzer --------------------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This tool may be invoked in the following manner:
11 //  llvm-bcanalyzer [options]      - Read LLVM bitcode from stdin
12 //  llvm-bcanalyzer [options] x.bc - Read LLVM bitcode from the x.bc file
13 //
14 //  Options:
15 //      --help      - Output information about command line switches
16 //      --dump      - Dump low-level bitcode structure in readable format
17 //
18 // This tool provides analytical information about a bitcode file. It is
19 // intended as an aid to developers of bitcode reading and writing software. It
20 // produces on std::out a summary of the bitcode file that shows various
21 // statistics about the contents of the file. By default this information is
22 // detailed and contains information about individual bitcode blocks and the
23 // functions in the module.
24 // The tool is also able to print a bitcode file in a straight forward text
25 // format that shows the containment and relationships of the information in
26 // the bitcode file (-dump option).
27 //
28 //===----------------------------------------------------------------------===//
29
30 #include "llvm/ADT/StringExtras.h"
31 #include "llvm/Bitcode/BitcodeReader.h"
32 #include "llvm/Bitcode/BitstreamReader.h"
33 #include "llvm/Bitcode/LLVMBitCodes.h"
34 #include "llvm/IR/Verifier.h"
35 #include "llvm/Support/CommandLine.h"
36 #include "llvm/Support/Format.h"
37 #include "llvm/Support/ManagedStatic.h"
38 #include "llvm/Support/MemoryBuffer.h"
39 #include "llvm/Support/PrettyStackTrace.h"
40 #include "llvm/Support/SHA1.h"
41 #include "llvm/Support/Signals.h"
42 #include "llvm/Support/raw_ostream.h"
43 #include <algorithm>
44 #include <cctype>
45 #include <map>
46 #include <system_error>
47 using namespace llvm;
48
49 static cl::opt<std::string>
50   InputFilename(cl::Positional, cl::desc("<input bitcode>"), cl::init("-"));
51
52 static cl::opt<bool> Dump("dump", cl::desc("Dump low level bitcode trace"));
53
54 //===----------------------------------------------------------------------===//
55 // Bitcode specific analysis.
56 //===----------------------------------------------------------------------===//
57
58 static cl::opt<bool> NoHistogram("disable-histogram",
59                                  cl::desc("Do not print per-code histogram"));
60
61 static cl::opt<bool>
62 NonSymbolic("non-symbolic",
63             cl::desc("Emit numeric info in dump even if"
64                      " symbolic info is available"));
65
66 static cl::opt<std::string>
67   BlockInfoFilename("block-info",
68                     cl::desc("Use the BLOCK_INFO from the given file"));
69
70 static cl::opt<bool>
71   ShowBinaryBlobs("show-binary-blobs",
72                   cl::desc("Print binary blobs using hex escapes"));
73
74 namespace {
75
76 /// CurStreamTypeType - A type for CurStreamType
77 enum CurStreamTypeType {
78   UnknownBitstream,
79   LLVMIRBitstream
80 };
81
82 }
83
84 /// GetBlockName - Return a symbolic block name if known, otherwise return
85 /// null.
86 static const char *GetBlockName(unsigned BlockID,
87                                 const BitstreamBlockInfo &BlockInfo,
88                                 CurStreamTypeType CurStreamType) {
89   // Standard blocks for all bitcode files.
90   if (BlockID < bitc::FIRST_APPLICATION_BLOCKID) {
91     if (BlockID == bitc::BLOCKINFO_BLOCK_ID)
92       return "BLOCKINFO_BLOCK";
93     return nullptr;
94   }
95
96   // Check to see if we have a blockinfo record for this block, with a name.
97   if (const BitstreamBlockInfo::BlockInfo *Info =
98           BlockInfo.getBlockInfo(BlockID)) {
99     if (!Info->Name.empty())
100       return Info->Name.c_str();
101   }
102
103
104   if (CurStreamType != LLVMIRBitstream) return nullptr;
105
106   switch (BlockID) {
107   default:                                 return nullptr;
108   case bitc::OPERAND_BUNDLE_TAGS_BLOCK_ID: return "OPERAND_BUNDLE_TAGS_BLOCK";
109   case bitc::MODULE_BLOCK_ID:              return "MODULE_BLOCK";
110   case bitc::PARAMATTR_BLOCK_ID:           return "PARAMATTR_BLOCK";
111   case bitc::PARAMATTR_GROUP_BLOCK_ID:     return "PARAMATTR_GROUP_BLOCK_ID";
112   case bitc::TYPE_BLOCK_ID_NEW:            return "TYPE_BLOCK_ID";
113   case bitc::CONSTANTS_BLOCK_ID:           return "CONSTANTS_BLOCK";
114   case bitc::FUNCTION_BLOCK_ID:            return "FUNCTION_BLOCK";
115   case bitc::IDENTIFICATION_BLOCK_ID:
116                                            return "IDENTIFICATION_BLOCK_ID";
117   case bitc::VALUE_SYMTAB_BLOCK_ID:        return "VALUE_SYMTAB";
118   case bitc::METADATA_BLOCK_ID:            return "METADATA_BLOCK";
119   case bitc::METADATA_KIND_BLOCK_ID:       return "METADATA_KIND_BLOCK";
120   case bitc::METADATA_ATTACHMENT_ID:       return "METADATA_ATTACHMENT_BLOCK";
121   case bitc::USELIST_BLOCK_ID:             return "USELIST_BLOCK_ID";
122   case bitc::GLOBALVAL_SUMMARY_BLOCK_ID:
123                                            return "GLOBALVAL_SUMMARY_BLOCK";
124   case bitc::FULL_LTO_GLOBALVAL_SUMMARY_BLOCK_ID:
125                                       return "FULL_LTO_GLOBALVAL_SUMMARY_BLOCK";
126   case bitc::MODULE_STRTAB_BLOCK_ID:       return "MODULE_STRTAB_BLOCK";
127   case bitc::STRTAB_BLOCK_ID:              return "STRTAB_BLOCK";
128   case bitc::SYMTAB_BLOCK_ID:              return "SYMTAB_BLOCK";
129   }
130 }
131
132 /// GetCodeName - Return a symbolic code name if known, otherwise return
133 /// null.
134 static const char *GetCodeName(unsigned CodeID, unsigned BlockID,
135                                const BitstreamBlockInfo &BlockInfo,
136                                CurStreamTypeType CurStreamType) {
137   // Standard blocks for all bitcode files.
138   if (BlockID < bitc::FIRST_APPLICATION_BLOCKID) {
139     if (BlockID == bitc::BLOCKINFO_BLOCK_ID) {
140       switch (CodeID) {
141       default: return nullptr;
142       case bitc::BLOCKINFO_CODE_SETBID:        return "SETBID";
143       case bitc::BLOCKINFO_CODE_BLOCKNAME:     return "BLOCKNAME";
144       case bitc::BLOCKINFO_CODE_SETRECORDNAME: return "SETRECORDNAME";
145       }
146     }
147     return nullptr;
148   }
149
150   // Check to see if we have a blockinfo record for this record, with a name.
151   if (const BitstreamBlockInfo::BlockInfo *Info =
152         BlockInfo.getBlockInfo(BlockID)) {
153     for (unsigned i = 0, e = Info->RecordNames.size(); i != e; ++i)
154       if (Info->RecordNames[i].first == CodeID)
155         return Info->RecordNames[i].second.c_str();
156   }
157
158
159   if (CurStreamType != LLVMIRBitstream) return nullptr;
160
161 #define STRINGIFY_CODE(PREFIX, CODE)                                           \
162   case bitc::PREFIX##_##CODE:                                                  \
163     return #CODE;
164   switch (BlockID) {
165   default: return nullptr;
166   case bitc::MODULE_BLOCK_ID:
167     switch (CodeID) {
168     default: return nullptr;
169       STRINGIFY_CODE(MODULE_CODE, VERSION)
170       STRINGIFY_CODE(MODULE_CODE, TRIPLE)
171       STRINGIFY_CODE(MODULE_CODE, DATALAYOUT)
172       STRINGIFY_CODE(MODULE_CODE, ASM)
173       STRINGIFY_CODE(MODULE_CODE, SECTIONNAME)
174       STRINGIFY_CODE(MODULE_CODE, DEPLIB) // FIXME: Remove in 4.0
175       STRINGIFY_CODE(MODULE_CODE, GLOBALVAR)
176       STRINGIFY_CODE(MODULE_CODE, FUNCTION)
177       STRINGIFY_CODE(MODULE_CODE, ALIAS)
178       STRINGIFY_CODE(MODULE_CODE, GCNAME)
179       STRINGIFY_CODE(MODULE_CODE, VSTOFFSET)
180       STRINGIFY_CODE(MODULE_CODE, METADATA_VALUES_UNUSED)
181       STRINGIFY_CODE(MODULE_CODE, SOURCE_FILENAME)
182       STRINGIFY_CODE(MODULE_CODE, HASH)
183     }
184   case bitc::IDENTIFICATION_BLOCK_ID:
185     switch (CodeID) {
186     default:
187       return nullptr;
188       STRINGIFY_CODE(IDENTIFICATION_CODE, STRING)
189       STRINGIFY_CODE(IDENTIFICATION_CODE, EPOCH)
190     }
191   case bitc::PARAMATTR_BLOCK_ID:
192     switch (CodeID) {
193     default: return nullptr;
194     // FIXME: Should these be different?
195     case bitc::PARAMATTR_CODE_ENTRY_OLD: return "ENTRY";
196     case bitc::PARAMATTR_CODE_ENTRY:     return "ENTRY";
197     }
198   case bitc::PARAMATTR_GROUP_BLOCK_ID:
199     switch (CodeID) {
200     default: return nullptr;
201     case bitc::PARAMATTR_GRP_CODE_ENTRY: return "ENTRY";
202     }
203   case bitc::TYPE_BLOCK_ID_NEW:
204     switch (CodeID) {
205     default: return nullptr;
206       STRINGIFY_CODE(TYPE_CODE, NUMENTRY)
207       STRINGIFY_CODE(TYPE_CODE, VOID)
208       STRINGIFY_CODE(TYPE_CODE, FLOAT)
209       STRINGIFY_CODE(TYPE_CODE, DOUBLE)
210       STRINGIFY_CODE(TYPE_CODE, LABEL)
211       STRINGIFY_CODE(TYPE_CODE, OPAQUE)
212       STRINGIFY_CODE(TYPE_CODE, INTEGER)
213       STRINGIFY_CODE(TYPE_CODE, POINTER)
214       STRINGIFY_CODE(TYPE_CODE, ARRAY)
215       STRINGIFY_CODE(TYPE_CODE, VECTOR)
216       STRINGIFY_CODE(TYPE_CODE, X86_FP80)
217       STRINGIFY_CODE(TYPE_CODE, FP128)
218       STRINGIFY_CODE(TYPE_CODE, PPC_FP128)
219       STRINGIFY_CODE(TYPE_CODE, METADATA)
220       STRINGIFY_CODE(TYPE_CODE, STRUCT_ANON)
221       STRINGIFY_CODE(TYPE_CODE, STRUCT_NAME)
222       STRINGIFY_CODE(TYPE_CODE, STRUCT_NAMED)
223       STRINGIFY_CODE(TYPE_CODE, FUNCTION)
224     }
225
226   case bitc::CONSTANTS_BLOCK_ID:
227     switch (CodeID) {
228     default: return nullptr;
229       STRINGIFY_CODE(CST_CODE, SETTYPE)
230       STRINGIFY_CODE(CST_CODE, NULL)
231       STRINGIFY_CODE(CST_CODE, UNDEF)
232       STRINGIFY_CODE(CST_CODE, INTEGER)
233       STRINGIFY_CODE(CST_CODE, WIDE_INTEGER)
234       STRINGIFY_CODE(CST_CODE, FLOAT)
235       STRINGIFY_CODE(CST_CODE, AGGREGATE)
236       STRINGIFY_CODE(CST_CODE, STRING)
237       STRINGIFY_CODE(CST_CODE, CSTRING)
238       STRINGIFY_CODE(CST_CODE, CE_BINOP)
239       STRINGIFY_CODE(CST_CODE, CE_CAST)
240       STRINGIFY_CODE(CST_CODE, CE_GEP)
241       STRINGIFY_CODE(CST_CODE, CE_INBOUNDS_GEP)
242       STRINGIFY_CODE(CST_CODE, CE_SELECT)
243       STRINGIFY_CODE(CST_CODE, CE_EXTRACTELT)
244       STRINGIFY_CODE(CST_CODE, CE_INSERTELT)
245       STRINGIFY_CODE(CST_CODE, CE_SHUFFLEVEC)
246       STRINGIFY_CODE(CST_CODE, CE_CMP)
247       STRINGIFY_CODE(CST_CODE, INLINEASM)
248       STRINGIFY_CODE(CST_CODE, CE_SHUFVEC_EX)
249     case bitc::CST_CODE_BLOCKADDRESS:    return "CST_CODE_BLOCKADDRESS";
250       STRINGIFY_CODE(CST_CODE, DATA)
251     }
252   case bitc::FUNCTION_BLOCK_ID:
253     switch (CodeID) {
254     default: return nullptr;
255       STRINGIFY_CODE(FUNC_CODE, DECLAREBLOCKS)
256       STRINGIFY_CODE(FUNC_CODE, INST_BINOP)
257       STRINGIFY_CODE(FUNC_CODE, INST_CAST)
258       STRINGIFY_CODE(FUNC_CODE, INST_GEP_OLD)
259       STRINGIFY_CODE(FUNC_CODE, INST_INBOUNDS_GEP_OLD)
260       STRINGIFY_CODE(FUNC_CODE, INST_SELECT)
261       STRINGIFY_CODE(FUNC_CODE, INST_EXTRACTELT)
262       STRINGIFY_CODE(FUNC_CODE, INST_INSERTELT)
263       STRINGIFY_CODE(FUNC_CODE, INST_SHUFFLEVEC)
264       STRINGIFY_CODE(FUNC_CODE, INST_CMP)
265       STRINGIFY_CODE(FUNC_CODE, INST_RET)
266       STRINGIFY_CODE(FUNC_CODE, INST_BR)
267       STRINGIFY_CODE(FUNC_CODE, INST_SWITCH)
268       STRINGIFY_CODE(FUNC_CODE, INST_INVOKE)
269       STRINGIFY_CODE(FUNC_CODE, INST_UNREACHABLE)
270       STRINGIFY_CODE(FUNC_CODE, INST_CLEANUPRET)
271       STRINGIFY_CODE(FUNC_CODE, INST_CATCHRET)
272       STRINGIFY_CODE(FUNC_CODE, INST_CATCHPAD)
273       STRINGIFY_CODE(FUNC_CODE, INST_PHI)
274       STRINGIFY_CODE(FUNC_CODE, INST_ALLOCA)
275       STRINGIFY_CODE(FUNC_CODE, INST_LOAD)
276       STRINGIFY_CODE(FUNC_CODE, INST_VAARG)
277       STRINGIFY_CODE(FUNC_CODE, INST_STORE)
278       STRINGIFY_CODE(FUNC_CODE, INST_EXTRACTVAL)
279       STRINGIFY_CODE(FUNC_CODE, INST_INSERTVAL)
280       STRINGIFY_CODE(FUNC_CODE, INST_CMP2)
281       STRINGIFY_CODE(FUNC_CODE, INST_VSELECT)
282       STRINGIFY_CODE(FUNC_CODE, DEBUG_LOC_AGAIN)
283       STRINGIFY_CODE(FUNC_CODE, INST_CALL)
284       STRINGIFY_CODE(FUNC_CODE, DEBUG_LOC)
285       STRINGIFY_CODE(FUNC_CODE, INST_GEP)
286       STRINGIFY_CODE(FUNC_CODE, OPERAND_BUNDLE)
287     }
288   case bitc::VALUE_SYMTAB_BLOCK_ID:
289     switch (CodeID) {
290     default: return nullptr;
291     STRINGIFY_CODE(VST_CODE, ENTRY)
292     STRINGIFY_CODE(VST_CODE, BBENTRY)
293     STRINGIFY_CODE(VST_CODE, FNENTRY)
294     STRINGIFY_CODE(VST_CODE, COMBINED_ENTRY)
295     }
296   case bitc::MODULE_STRTAB_BLOCK_ID:
297     switch (CodeID) {
298     default:
299       return nullptr;
300       STRINGIFY_CODE(MST_CODE, ENTRY)
301       STRINGIFY_CODE(MST_CODE, HASH)
302     }
303   case bitc::GLOBALVAL_SUMMARY_BLOCK_ID:
304   case bitc::FULL_LTO_GLOBALVAL_SUMMARY_BLOCK_ID:
305     switch (CodeID) {
306     default:
307       return nullptr;
308       STRINGIFY_CODE(FS, PERMODULE)
309       STRINGIFY_CODE(FS, PERMODULE_PROFILE)
310       STRINGIFY_CODE(FS, PERMODULE_GLOBALVAR_INIT_REFS)
311       STRINGIFY_CODE(FS, COMBINED)
312       STRINGIFY_CODE(FS, COMBINED_PROFILE)
313       STRINGIFY_CODE(FS, COMBINED_GLOBALVAR_INIT_REFS)
314       STRINGIFY_CODE(FS, ALIAS)
315       STRINGIFY_CODE(FS, COMBINED_ALIAS)
316       STRINGIFY_CODE(FS, COMBINED_ORIGINAL_NAME)
317       STRINGIFY_CODE(FS, VERSION)
318       STRINGIFY_CODE(FS, TYPE_TESTS)
319       STRINGIFY_CODE(FS, TYPE_TEST_ASSUME_VCALLS)
320       STRINGIFY_CODE(FS, TYPE_CHECKED_LOAD_VCALLS)
321       STRINGIFY_CODE(FS, TYPE_TEST_ASSUME_CONST_VCALL)
322       STRINGIFY_CODE(FS, TYPE_CHECKED_LOAD_CONST_VCALL)
323       STRINGIFY_CODE(FS, VALUE_GUID)
324       STRINGIFY_CODE(FS, CFI_FUNCTION_DEFS)
325       STRINGIFY_CODE(FS, CFI_FUNCTION_DECLS)
326     }
327   case bitc::METADATA_ATTACHMENT_ID:
328     switch(CodeID) {
329     default:return nullptr;
330       STRINGIFY_CODE(METADATA, ATTACHMENT)
331     }
332   case bitc::METADATA_BLOCK_ID:
333     switch(CodeID) {
334     default:return nullptr;
335       STRINGIFY_CODE(METADATA, STRING_OLD)
336       STRINGIFY_CODE(METADATA, VALUE)
337       STRINGIFY_CODE(METADATA, NODE)
338       STRINGIFY_CODE(METADATA, NAME)
339       STRINGIFY_CODE(METADATA, DISTINCT_NODE)
340       STRINGIFY_CODE(METADATA, KIND) // Older bitcode has it in a MODULE_BLOCK
341       STRINGIFY_CODE(METADATA, LOCATION)
342       STRINGIFY_CODE(METADATA, OLD_NODE)
343       STRINGIFY_CODE(METADATA, OLD_FN_NODE)
344       STRINGIFY_CODE(METADATA, NAMED_NODE)
345       STRINGIFY_CODE(METADATA, GENERIC_DEBUG)
346       STRINGIFY_CODE(METADATA, SUBRANGE)
347       STRINGIFY_CODE(METADATA, ENUMERATOR)
348       STRINGIFY_CODE(METADATA, BASIC_TYPE)
349       STRINGIFY_CODE(METADATA, FILE)
350       STRINGIFY_CODE(METADATA, DERIVED_TYPE)
351       STRINGIFY_CODE(METADATA, COMPOSITE_TYPE)
352       STRINGIFY_CODE(METADATA, SUBROUTINE_TYPE)
353       STRINGIFY_CODE(METADATA, COMPILE_UNIT)
354       STRINGIFY_CODE(METADATA, SUBPROGRAM)
355       STRINGIFY_CODE(METADATA, LEXICAL_BLOCK)
356       STRINGIFY_CODE(METADATA, LEXICAL_BLOCK_FILE)
357       STRINGIFY_CODE(METADATA, NAMESPACE)
358       STRINGIFY_CODE(METADATA, TEMPLATE_TYPE)
359       STRINGIFY_CODE(METADATA, TEMPLATE_VALUE)
360       STRINGIFY_CODE(METADATA, GLOBAL_VAR)
361       STRINGIFY_CODE(METADATA, LOCAL_VAR)
362       STRINGIFY_CODE(METADATA, EXPRESSION)
363       STRINGIFY_CODE(METADATA, OBJC_PROPERTY)
364       STRINGIFY_CODE(METADATA, IMPORTED_ENTITY)
365       STRINGIFY_CODE(METADATA, MODULE)
366       STRINGIFY_CODE(METADATA, MACRO)
367       STRINGIFY_CODE(METADATA, MACRO_FILE)
368       STRINGIFY_CODE(METADATA, STRINGS)
369       STRINGIFY_CODE(METADATA, GLOBAL_DECL_ATTACHMENT)
370       STRINGIFY_CODE(METADATA, GLOBAL_VAR_EXPR)
371       STRINGIFY_CODE(METADATA, INDEX_OFFSET)
372       STRINGIFY_CODE(METADATA, INDEX)
373     }
374   case bitc::METADATA_KIND_BLOCK_ID:
375     switch (CodeID) {
376     default:
377       return nullptr;
378       STRINGIFY_CODE(METADATA, KIND)
379     }
380   case bitc::USELIST_BLOCK_ID:
381     switch(CodeID) {
382     default:return nullptr;
383     case bitc::USELIST_CODE_DEFAULT: return "USELIST_CODE_DEFAULT";
384     case bitc::USELIST_CODE_BB:      return "USELIST_CODE_BB";
385     }
386
387   case bitc::OPERAND_BUNDLE_TAGS_BLOCK_ID:
388     switch(CodeID) {
389     default: return nullptr;
390     case bitc::OPERAND_BUNDLE_TAG: return "OPERAND_BUNDLE_TAG";
391     }
392   case bitc::STRTAB_BLOCK_ID:
393     switch(CodeID) {
394     default: return nullptr;
395     case bitc::STRTAB_BLOB: return "BLOB";
396     }
397   case bitc::SYMTAB_BLOCK_ID:
398     switch(CodeID) {
399     default: return nullptr;
400     case bitc::SYMTAB_BLOB: return "BLOB";
401     }
402   }
403 #undef STRINGIFY_CODE
404 }
405
406 struct PerRecordStats {
407   unsigned NumInstances;
408   unsigned NumAbbrev;
409   uint64_t TotalBits;
410
411   PerRecordStats() : NumInstances(0), NumAbbrev(0), TotalBits(0) {}
412 };
413
414 struct PerBlockIDStats {
415   /// NumInstances - This the number of times this block ID has been seen.
416   unsigned NumInstances;
417
418   /// NumBits - The total size in bits of all of these blocks.
419   uint64_t NumBits;
420
421   /// NumSubBlocks - The total number of blocks these blocks contain.
422   unsigned NumSubBlocks;
423
424   /// NumAbbrevs - The total number of abbreviations.
425   unsigned NumAbbrevs;
426
427   /// NumRecords - The total number of records these blocks contain, and the
428   /// number that are abbreviated.
429   unsigned NumRecords, NumAbbreviatedRecords;
430
431   /// CodeFreq - Keep track of the number of times we see each code.
432   std::vector<PerRecordStats> CodeFreq;
433
434   PerBlockIDStats()
435     : NumInstances(0), NumBits(0),
436       NumSubBlocks(0), NumAbbrevs(0), NumRecords(0), NumAbbreviatedRecords(0) {}
437 };
438
439 static std::map<unsigned, PerBlockIDStats> BlockIDStats;
440
441
442
443 /// ReportError - All bitcode analysis errors go through this function, making this a
444 /// good place to breakpoint if debugging.
445 static bool ReportError(const Twine &Err) {
446   errs() << Err << "\n";
447   return true;
448 }
449
450 static bool decodeMetadataStringsBlob(StringRef Indent,
451                                       ArrayRef<uint64_t> Record,
452                                       StringRef Blob) {
453   if (Blob.empty())
454     return true;
455
456   if (Record.size() != 2)
457     return true;
458
459   unsigned NumStrings = Record[0];
460   unsigned StringsOffset = Record[1];
461   outs() << " num-strings = " << NumStrings << " {\n";
462
463   StringRef Lengths = Blob.slice(0, StringsOffset);
464   SimpleBitstreamCursor R(Lengths);
465   StringRef Strings = Blob.drop_front(StringsOffset);
466   do {
467     if (R.AtEndOfStream())
468       return ReportError("bad length");
469
470     unsigned Size = R.ReadVBR(6);
471     if (Strings.size() < Size)
472       return ReportError("truncated chars");
473
474     outs() << Indent << "    '";
475     outs().write_escaped(Strings.slice(0, Size), /*hex=*/true);
476     outs() << "'\n";
477     Strings = Strings.drop_front(Size);
478   } while (--NumStrings);
479
480   outs() << Indent << "  }";
481   return false;
482 }
483
484 static bool decodeBlob(unsigned Code, unsigned BlockID, StringRef Indent,
485                        ArrayRef<uint64_t> Record, StringRef Blob) {
486   if (BlockID != bitc::METADATA_BLOCK_ID)
487     return true;
488   if (Code != bitc::METADATA_STRINGS)
489     return true;
490
491   return decodeMetadataStringsBlob(Indent, Record, Blob);
492 }
493
494 /// ParseBlock - Read a block, updating statistics, etc.
495 static bool ParseBlock(BitstreamCursor &Stream, BitstreamBlockInfo &BlockInfo,
496                        unsigned BlockID, unsigned IndentLevel,
497                        CurStreamTypeType CurStreamType) {
498   std::string Indent(IndentLevel*2, ' ');
499   uint64_t BlockBitStart = Stream.GetCurrentBitNo();
500
501   // Get the statistics for this BlockID.
502   PerBlockIDStats &BlockStats = BlockIDStats[BlockID];
503
504   BlockStats.NumInstances++;
505
506   // BLOCKINFO is a special part of the stream.
507   bool DumpRecords = Dump;
508   if (BlockID == bitc::BLOCKINFO_BLOCK_ID) {
509     if (Dump) outs() << Indent << "<BLOCKINFO_BLOCK/>\n";
510     Optional<BitstreamBlockInfo> NewBlockInfo =
511         Stream.ReadBlockInfoBlock(/*ReadBlockInfoNames=*/true);
512     if (!NewBlockInfo)
513       return ReportError("Malformed BlockInfoBlock");
514     BlockInfo = std::move(*NewBlockInfo);
515     Stream.JumpToBit(BlockBitStart);
516     // It's not really interesting to dump the contents of the blockinfo block.
517     DumpRecords = false;
518   }
519
520   unsigned NumWords = 0;
521   if (Stream.EnterSubBlock(BlockID, &NumWords))
522     return ReportError("Malformed block record");
523
524   // Keep it for later, when we see a MODULE_HASH record
525   uint64_t BlockEntryPos = Stream.getCurrentByteNo();
526
527   const char *BlockName = nullptr;
528   if (DumpRecords) {
529     outs() << Indent << "<";
530     if ((BlockName = GetBlockName(BlockID, BlockInfo, CurStreamType)))
531       outs() << BlockName;
532     else
533       outs() << "UnknownBlock" << BlockID;
534
535     if (NonSymbolic && BlockName)
536       outs() << " BlockID=" << BlockID;
537
538     outs() << " NumWords=" << NumWords
539            << " BlockCodeSize=" << Stream.getAbbrevIDWidth() << ">\n";
540   }
541
542   SmallVector<uint64_t, 64> Record;
543
544   // Keep the offset to the metadata index if seen.
545   uint64_t MetadataIndexOffset = 0;
546
547   // Read all the records for this block.
548   while (1) {
549     if (Stream.AtEndOfStream())
550       return ReportError("Premature end of bitstream");
551
552     uint64_t RecordStartBit = Stream.GetCurrentBitNo();
553
554     BitstreamEntry Entry =
555       Stream.advance(BitstreamCursor::AF_DontAutoprocessAbbrevs);
556     
557     switch (Entry.Kind) {
558     case BitstreamEntry::Error:
559       return ReportError("malformed bitcode file");
560     case BitstreamEntry::EndBlock: {
561       uint64_t BlockBitEnd = Stream.GetCurrentBitNo();
562       BlockStats.NumBits += BlockBitEnd-BlockBitStart;
563       if (DumpRecords) {
564         outs() << Indent << "</";
565         if (BlockName)
566           outs() << BlockName << ">\n";
567         else
568           outs() << "UnknownBlock" << BlockID << ">\n";
569       }
570       return false;
571     }
572         
573     case BitstreamEntry::SubBlock: {
574       uint64_t SubBlockBitStart = Stream.GetCurrentBitNo();
575       if (ParseBlock(Stream, BlockInfo, Entry.ID, IndentLevel + 1,
576                      CurStreamType))
577         return true;
578       ++BlockStats.NumSubBlocks;
579       uint64_t SubBlockBitEnd = Stream.GetCurrentBitNo();
580       
581       // Don't include subblock sizes in the size of this block.
582       BlockBitStart += SubBlockBitEnd-SubBlockBitStart;
583       continue;
584     }
585     case BitstreamEntry::Record:
586       // The interesting case.
587       break;
588     }
589
590     if (Entry.ID == bitc::DEFINE_ABBREV) {
591       Stream.ReadAbbrevRecord();
592       ++BlockStats.NumAbbrevs;
593       continue;
594     }
595     
596     Record.clear();
597
598     ++BlockStats.NumRecords;
599
600     StringRef Blob;
601     unsigned CurrentRecordPos = Stream.GetCurrentBitNo();
602     unsigned Code = Stream.readRecord(Entry.ID, Record, &Blob);
603
604     // Increment the # occurrences of this code.
605     if (BlockStats.CodeFreq.size() <= Code)
606       BlockStats.CodeFreq.resize(Code+1);
607     BlockStats.CodeFreq[Code].NumInstances++;
608     BlockStats.CodeFreq[Code].TotalBits +=
609       Stream.GetCurrentBitNo()-RecordStartBit;
610     if (Entry.ID != bitc::UNABBREV_RECORD) {
611       BlockStats.CodeFreq[Code].NumAbbrev++;
612       ++BlockStats.NumAbbreviatedRecords;
613     }
614
615     if (DumpRecords) {
616       outs() << Indent << "  <";
617       if (const char *CodeName =
618               GetCodeName(Code, BlockID, BlockInfo, CurStreamType))
619         outs() << CodeName;
620       else
621         outs() << "UnknownCode" << Code;
622       if (NonSymbolic && GetCodeName(Code, BlockID, BlockInfo, CurStreamType))
623         outs() << " codeid=" << Code;
624       const BitCodeAbbrev *Abbv = nullptr;
625       if (Entry.ID != bitc::UNABBREV_RECORD) {
626         Abbv = Stream.getAbbrev(Entry.ID);
627         outs() << " abbrevid=" << Entry.ID;
628       }
629
630       for (unsigned i = 0, e = Record.size(); i != e; ++i)
631         outs() << " op" << i << "=" << (int64_t)Record[i];
632
633       // If we found a metadata index, let's verify that we had an offset before
634       // and validate its forward reference offset was correct!
635       if (BlockID == bitc::METADATA_BLOCK_ID) {
636         if (Code == bitc::METADATA_INDEX_OFFSET) {
637           if (Record.size() != 2)
638             outs() << "(Invalid record)";
639           else {
640             auto Offset = Record[0] + (Record[1] << 32);
641             MetadataIndexOffset = Stream.GetCurrentBitNo() + Offset;
642           }
643         }
644         if (Code == bitc::METADATA_INDEX) {
645           outs() << " (offset ";
646           if (MetadataIndexOffset == RecordStartBit)
647             outs() << "match)";
648           else
649             outs() << "mismatch: " << MetadataIndexOffset << " vs "
650                    << RecordStartBit << ")";
651         }
652       }
653
654       // If we found a module hash, let's verify that it matches!
655       if (BlockID == bitc::MODULE_BLOCK_ID && Code == bitc::MODULE_CODE_HASH) {
656         if (Record.size() != 5)
657           outs() << " (invalid)";
658         else {
659           // Recompute the hash and compare it to the one in the bitcode
660           SHA1 Hasher;
661           StringRef Hash;
662           {
663             int BlockSize = (CurrentRecordPos / 8) - BlockEntryPos;
664             auto Ptr = Stream.getPointerToByte(BlockEntryPos, BlockSize);
665             Hasher.update(ArrayRef<uint8_t>(Ptr, BlockSize));
666             Hash = Hasher.result();
667           }
668           SmallString<20> RecordedHash;
669           RecordedHash.resize(20);
670           int Pos = 0;
671           for (auto &Val : Record) {
672             assert(!(Val >> 32) && "Unexpected high bits set");
673             RecordedHash[Pos++] = (Val >> 24) & 0xFF;
674             RecordedHash[Pos++] = (Val >> 16) & 0xFF;
675             RecordedHash[Pos++] = (Val >> 8) & 0xFF;
676             RecordedHash[Pos++] = (Val >> 0) & 0xFF;
677           }
678           if (Hash == RecordedHash)
679             outs() << " (match)";
680           else
681             outs() << " (!mismatch!)";
682         }
683       }
684
685       outs() << "/>";
686
687       if (Abbv) {
688         for (unsigned i = 1, e = Abbv->getNumOperandInfos(); i != e; ++i) {
689           const BitCodeAbbrevOp &Op = Abbv->getOperandInfo(i);
690           if (!Op.isEncoding() || Op.getEncoding() != BitCodeAbbrevOp::Array)
691             continue;
692           assert(i + 2 == e && "Array op not second to last");
693           std::string Str;
694           bool ArrayIsPrintable = true;
695           for (unsigned j = i - 1, je = Record.size(); j != je; ++j) {
696             if (!isprint(static_cast<unsigned char>(Record[j]))) {
697               ArrayIsPrintable = false;
698               break;
699             }
700             Str += (char)Record[j];
701           }
702           if (ArrayIsPrintable)
703             outs() << " record string = '" << Str << "'";
704           break;
705         }
706       }
707
708       if (Blob.data() && decodeBlob(Code, BlockID, Indent, Record, Blob)) {
709         outs() << " blob data = ";
710         if (ShowBinaryBlobs) {
711           outs() << "'";
712           outs().write_escaped(Blob, /*hex=*/true) << "'";
713         } else {
714           bool BlobIsPrintable = true;
715           for (unsigned i = 0, e = Blob.size(); i != e; ++i)
716             if (!isprint(static_cast<unsigned char>(Blob[i]))) {
717               BlobIsPrintable = false;
718               break;
719             }
720
721           if (BlobIsPrintable)
722             outs() << "'" << Blob << "'";
723           else
724             outs() << "unprintable, " << Blob.size() << " bytes.";          
725         }
726       }
727
728       outs() << "\n";
729     }
730
731     // Make sure that we can skip the current record.
732     Stream.JumpToBit(CurrentRecordPos);
733     Stream.skipRecord(Entry.ID);
734   }
735 }
736
737 static void PrintSize(double Bits) {
738   outs() << format("%.2f/%.2fB/%luW", Bits, Bits/8,(unsigned long)(Bits/32));
739 }
740 static void PrintSize(uint64_t Bits) {
741   outs() << format("%lub/%.2fB/%luW", (unsigned long)Bits,
742                    (double)Bits/8, (unsigned long)(Bits/32));
743 }
744
745 static bool openBitcodeFile(StringRef Path,
746                             std::unique_ptr<MemoryBuffer> &MemBuf,
747                             BitstreamCursor &Stream,
748                             CurStreamTypeType &CurStreamType) {
749   // Read the input file.
750   ErrorOr<std::unique_ptr<MemoryBuffer>> MemBufOrErr =
751       MemoryBuffer::getFileOrSTDIN(Path);
752   if (std::error_code EC = MemBufOrErr.getError())
753     return ReportError(Twine("ReportError reading '") + Path + "': " + EC.message());
754   MemBuf = std::move(MemBufOrErr.get());
755
756   if (MemBuf->getBufferSize() & 3)
757     return ReportError("Bitcode stream should be a multiple of 4 bytes in length");
758
759   const unsigned char *BufPtr = (const unsigned char *)MemBuf->getBufferStart();
760   const unsigned char *EndBufPtr = BufPtr + MemBuf->getBufferSize();
761
762   // If we have a wrapper header, parse it and ignore the non-bc file contents.
763   // The magic number is 0x0B17C0DE stored in little endian.
764   if (isBitcodeWrapper(BufPtr, EndBufPtr)) {
765     if (MemBuf->getBufferSize() < BWH_HeaderSize)
766       return ReportError("Invalid bitcode wrapper header");
767
768     if (Dump) {
769       unsigned Magic = support::endian::read32le(&BufPtr[BWH_MagicField]);
770       unsigned Version = support::endian::read32le(&BufPtr[BWH_VersionField]);
771       unsigned Offset = support::endian::read32le(&BufPtr[BWH_OffsetField]);
772       unsigned Size = support::endian::read32le(&BufPtr[BWH_SizeField]);
773       unsigned CPUType = support::endian::read32le(&BufPtr[BWH_CPUTypeField]);
774
775       outs() << "<BITCODE_WRAPPER_HEADER"
776              << " Magic=" << format_hex(Magic, 10)
777              << " Version=" << format_hex(Version, 10)
778              << " Offset=" << format_hex(Offset, 10)
779              << " Size=" << format_hex(Size, 10)
780              << " CPUType=" << format_hex(CPUType, 10) << "/>\n";
781     }
782
783     if (SkipBitcodeWrapperHeader(BufPtr, EndBufPtr, true))
784       return ReportError("Invalid bitcode wrapper header");
785   }
786
787   Stream = BitstreamCursor(ArrayRef<uint8_t>(BufPtr, EndBufPtr));
788
789   // Read the stream signature.
790   char Signature[6];
791   Signature[0] = Stream.Read(8);
792   Signature[1] = Stream.Read(8);
793   Signature[2] = Stream.Read(4);
794   Signature[3] = Stream.Read(4);
795   Signature[4] = Stream.Read(4);
796   Signature[5] = Stream.Read(4);
797
798   // Autodetect the file contents, if it is one we know.
799   CurStreamType = UnknownBitstream;
800   if (Signature[0] == 'B' && Signature[1] == 'C' &&
801       Signature[2] == 0x0 && Signature[3] == 0xC &&
802       Signature[4] == 0xE && Signature[5] == 0xD)
803     CurStreamType = LLVMIRBitstream;
804
805   return false;
806 }
807
808 /// AnalyzeBitcode - Analyze the bitcode file specified by InputFilename.
809 static int AnalyzeBitcode() {
810   std::unique_ptr<MemoryBuffer> StreamBuffer;
811   BitstreamCursor Stream;
812   BitstreamBlockInfo BlockInfo;
813   CurStreamTypeType CurStreamType;
814   if (openBitcodeFile(InputFilename, StreamBuffer, Stream, CurStreamType))
815     return true;
816   Stream.setBlockInfo(&BlockInfo);
817
818   // Read block info from BlockInfoFilename, if specified.
819   // The block info must be a top-level block.
820   if (!BlockInfoFilename.empty()) {
821     std::unique_ptr<MemoryBuffer> BlockInfoBuffer;
822     BitstreamCursor BlockInfoCursor;
823     CurStreamTypeType BlockInfoStreamType;
824     if (openBitcodeFile(BlockInfoFilename, BlockInfoBuffer, BlockInfoCursor,
825                         BlockInfoStreamType))
826       return true;
827
828     while (!BlockInfoCursor.AtEndOfStream()) {
829       unsigned Code = BlockInfoCursor.ReadCode();
830       if (Code != bitc::ENTER_SUBBLOCK)
831         return ReportError("Invalid record at top-level in block info file");
832
833       unsigned BlockID = BlockInfoCursor.ReadSubBlockID();
834       if (BlockID == bitc::BLOCKINFO_BLOCK_ID) {
835         Optional<BitstreamBlockInfo> NewBlockInfo =
836             BlockInfoCursor.ReadBlockInfoBlock(/*ReadBlockInfoNames=*/true);
837         if (!NewBlockInfo)
838           return ReportError("Malformed BlockInfoBlock in block info file");
839         BlockInfo = std::move(*NewBlockInfo);
840         break;
841       }
842
843       BlockInfoCursor.SkipBlock();
844     }
845   }
846
847   unsigned NumTopBlocks = 0;
848
849   // Parse the top-level structure.  We only allow blocks at the top-level.
850   while (!Stream.AtEndOfStream()) {
851     unsigned Code = Stream.ReadCode();
852     if (Code != bitc::ENTER_SUBBLOCK)
853       return ReportError("Invalid record at top-level");
854
855     unsigned BlockID = Stream.ReadSubBlockID();
856
857     if (ParseBlock(Stream, BlockInfo, BlockID, 0, CurStreamType))
858       return true;
859     ++NumTopBlocks;
860   }
861
862   if (Dump) outs() << "\n\n";
863
864   uint64_t BufferSizeBits = Stream.getBitcodeBytes().size() * CHAR_BIT;
865   // Print a summary of the read file.
866   outs() << "Summary of " << InputFilename << ":\n";
867   outs() << "         Total size: ";
868   PrintSize(BufferSizeBits);
869   outs() << "\n";
870   outs() << "        Stream type: ";
871   switch (CurStreamType) {
872   case UnknownBitstream: outs() << "unknown\n"; break;
873   case LLVMIRBitstream:  outs() << "LLVM IR\n"; break;
874   }
875   outs() << "  # Toplevel Blocks: " << NumTopBlocks << "\n";
876   outs() << "\n";
877
878   // Emit per-block stats.
879   outs() << "Per-block Summary:\n";
880   for (std::map<unsigned, PerBlockIDStats>::iterator I = BlockIDStats.begin(),
881        E = BlockIDStats.end(); I != E; ++I) {
882     outs() << "  Block ID #" << I->first;
883     if (const char *BlockName =
884             GetBlockName(I->first, BlockInfo, CurStreamType))
885       outs() << " (" << BlockName << ")";
886     outs() << ":\n";
887
888     const PerBlockIDStats &Stats = I->second;
889     outs() << "      Num Instances: " << Stats.NumInstances << "\n";
890     outs() << "         Total Size: ";
891     PrintSize(Stats.NumBits);
892     outs() << "\n";
893     double pct = (Stats.NumBits * 100.0) / BufferSizeBits;
894     outs() << "    Percent of file: " << format("%2.4f%%", pct) << "\n";
895     if (Stats.NumInstances > 1) {
896       outs() << "       Average Size: ";
897       PrintSize(Stats.NumBits/(double)Stats.NumInstances);
898       outs() << "\n";
899       outs() << "  Tot/Avg SubBlocks: " << Stats.NumSubBlocks << "/"
900              << Stats.NumSubBlocks/(double)Stats.NumInstances << "\n";
901       outs() << "    Tot/Avg Abbrevs: " << Stats.NumAbbrevs << "/"
902              << Stats.NumAbbrevs/(double)Stats.NumInstances << "\n";
903       outs() << "    Tot/Avg Records: " << Stats.NumRecords << "/"
904              << Stats.NumRecords/(double)Stats.NumInstances << "\n";
905     } else {
906       outs() << "      Num SubBlocks: " << Stats.NumSubBlocks << "\n";
907       outs() << "        Num Abbrevs: " << Stats.NumAbbrevs << "\n";
908       outs() << "        Num Records: " << Stats.NumRecords << "\n";
909     }
910     if (Stats.NumRecords) {
911       double pct = (Stats.NumAbbreviatedRecords * 100.0) / Stats.NumRecords;
912       outs() << "    Percent Abbrevs: " << format("%2.4f%%", pct) << "\n";
913     }
914     outs() << "\n";
915
916     // Print a histogram of the codes we see.
917     if (!NoHistogram && !Stats.CodeFreq.empty()) {
918       std::vector<std::pair<unsigned, unsigned> > FreqPairs;  // <freq,code>
919       for (unsigned i = 0, e = Stats.CodeFreq.size(); i != e; ++i)
920         if (unsigned Freq = Stats.CodeFreq[i].NumInstances)
921           FreqPairs.push_back(std::make_pair(Freq, i));
922       std::stable_sort(FreqPairs.begin(), FreqPairs.end());
923       std::reverse(FreqPairs.begin(), FreqPairs.end());
924
925       outs() << "\tRecord Histogram:\n";
926       outs() << "\t\t  Count    # Bits     b/Rec   % Abv  Record Kind\n";
927       for (unsigned i = 0, e = FreqPairs.size(); i != e; ++i) {
928         const PerRecordStats &RecStats = Stats.CodeFreq[FreqPairs[i].second];
929
930         outs() << format("\t\t%7d %9lu",
931                          RecStats.NumInstances,
932                          (unsigned long)RecStats.TotalBits);
933
934         if (RecStats.NumInstances > 1)
935           outs() << format(" %9.1f",
936                            (double)RecStats.TotalBits/RecStats.NumInstances);
937         else
938           outs() << "          ";
939
940         if (RecStats.NumAbbrev)
941           outs() <<
942               format(" %7.2f",
943                      (double)RecStats.NumAbbrev/RecStats.NumInstances*100);
944         else
945           outs() << "        ";
946
947         outs() << "  ";
948         if (const char *CodeName = GetCodeName(FreqPairs[i].second, I->first,
949                                                BlockInfo, CurStreamType))
950           outs() << CodeName << "\n";
951         else
952           outs() << "UnknownCode" << FreqPairs[i].second << "\n";
953       }
954       outs() << "\n";
955
956     }
957   }
958   return 0;
959 }
960
961
962 int main(int argc, char **argv) {
963   // Print a stack trace if we signal out.
964   sys::PrintStackTraceOnErrorSignal(argv[0]);
965   PrettyStackTraceProgram X(argc, argv);
966   llvm_shutdown_obj Y;  // Call llvm_shutdown() on exit.
967   cl::ParseCommandLineOptions(argc, argv, "llvm-bcanalyzer file analyzer\n");
968
969   return AnalyzeBitcode();
970 }