/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Bitcode/BitstreamReader.h

Bug Summary

File:	include/llvm/Bitcode/BitstreamReader.h
Warning:	line 210, column 39 The result of the right shift is undefined due to shifting by '64', which is greater or equal to the width of type 'llvm::SimpleBitstreamCursor::word_t'

Annotated Source Code

Press '?' to see keyboard shortcuts

Show analyzer invocation

clang -cc1 -triple x86_64-pc-linux-gnu -analyze -disable-free -disable-llvm-verifier -discard-value-names -main-file-name llvm-bcanalyzer.cpp -analyzer-store=region -analyzer-opt-analyze-nested-blocks -analyzer-checker=core -analyzer-checker=apiModeling -analyzer-checker=unix -analyzer-checker=deadcode -analyzer-checker=cplusplus -analyzer-checker=security.insecureAPI.UncheckedReturn -analyzer-checker=security.insecureAPI.getpw -analyzer-checker=security.insecureAPI.gets -analyzer-checker=security.insecureAPI.mktemp -analyzer-checker=security.insecureAPI.mkstemp -analyzer-checker=security.insecureAPI.vfork -analyzer-checker=nullability.NullPassedToNonnull -analyzer-checker=nullability.NullReturnedFromNonnull -analyzer-output plist -w -mrelocation-model pic -pic-level 2 -mthread-model posix -fmath-errno -masm-verbose -mconstructor-aliases -munwind-tables -fuse-init-array -target-cpu x86-64 -dwarf-column-info -debugger-tuning=gdb -momit-leaf-frame-pointer -ffunction-sections -fdata-sections -resource-dir /usr/lib/llvm-8/lib/clang/8.0.0 -D _DEBUG -D _GNU_SOURCE -D __STDC_CONSTANT_MACROS -D __STDC_FORMAT_MACROS -D __STDC_LIMIT_MACROS -I /build/llvm-toolchain-snapshot-8~svn345461/build-llvm/tools/llvm-bcanalyzer -I /build/llvm-toolchain-snapshot-8~svn345461/tools/llvm-bcanalyzer -I /build/llvm-toolchain-snapshot-8~svn345461/build-llvm/include -I /build/llvm-toolchain-snapshot-8~svn345461/include -U NDEBUG -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/c++/6.3.0 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/x86_64-linux-gnu/c++/6.3.0 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/x86_64-linux-gnu/c++/6.3.0 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/c++/6.3.0/backward -internal-isystem /usr/include/clang/8.0.0/include/ -internal-isystem /usr/local/include -internal-isystem /usr/lib/llvm-8/lib/clang/8.0.0/include -internal-externc-isystem /usr/include/x86_64-linux-gnu -internal-externc-isystem /include -internal-externc-isystem /usr/include -O2 -Wno-unused-parameter -Wwrite-strings -Wno-missing-field-initializers -Wno-long-long -Wno-maybe-uninitialized -Wno-comment -std=c++11 -fdeprecated-macro -fdebug-compilation-dir /build/llvm-toolchain-snapshot-8~svn345461/build-llvm/tools/llvm-bcanalyzer -ferror-limit 19 -fmessage-length 0 -fvisibility-inlines-hidden -fobjc-runtime=gcc -fdiagnostics-show-option -vectorize-loops -vectorize-slp -analyzer-output=html -analyzer-config stable-report-filename=true -o /tmp/scan-build-2018-10-27-211344-32123-1 -x c++ /build/llvm-toolchain-snapshot-8~svn345461/tools/llvm-bcanalyzer/llvm-bcanalyzer.cpp -faddrsig

/build/llvm-toolchain-snapshot-8~svn345461/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//===----------------------------------------------------------------------===//

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/Support/CommandLine.h"
35#include "llvm/Support/Format.h"
36#include "llvm/Support/InitLLVM.h"
37#include "llvm/Support/ManagedStatic.h"
38#include "llvm/Support/MemoryBuffer.h"
39#include "llvm/Support/SHA1.h"
40#include "llvm/Support/WithColor.h"
41#include "llvm/Support/raw_ostream.h"
42using namespace llvm;

44static cl::opt<std::string>
InputFilename(cl::Positional, cl::desc("<input bitcode>"), cl::init("-"));

47static cl::opt<bool> Dump("dump", cl::desc("Dump low level bitcode trace"));

49//===----------------------------------------------------------------------===//
50// Bitcode specific analysis.
51//===----------------------------------------------------------------------===//

53static cl::opt<bool> NoHistogram("disable-histogram",
                               cl::desc("Do not print per-code histogram"));

56static cl::opt<bool>
57NonSymbolic("non-symbolic",
          cl::desc("Emit numeric info in dump even if"
                   " symbolic info is available"));

61static cl::opt<std::string>
BlockInfoFilename("block-info",
                  cl::desc("Use the BLOCK_INFO from the given file"));

65static cl::opt<bool>
ShowBinaryBlobs("show-binary-blobs",
                cl::desc("Print binary blobs using hex escapes"));

69static cl::opt<std::string> CheckHash(
  "check-hash",
  cl::desc("Check module hash using the argument as a string table"));

73namespace {

75/// CurStreamTypeType - A type for CurStreamType
76enum CurStreamTypeType {
UnknownBitstream,
LLVMIRBitstream,
ClangSerializedASTBitstream,
ClangSerializedDiagnosticsBitstream,
81};

83}

85/// GetBlockName - Return a symbolic block name if known, otherwise return
86/// null.
87static const char *GetBlockName(unsigned BlockID,
                              const BitstreamBlockInfo &BlockInfo,
                              CurStreamTypeType CurStreamType) {
// Standard blocks for all bitcode files.
if (BlockID < bitc::FIRST_APPLICATION_BLOCKID) {
  if (BlockID == bitc::BLOCKINFO_BLOCK_ID)
    return "BLOCKINFO_BLOCK";
  return nullptr;
}

// Check to see if we have a blockinfo record for this block, with a name.
if (const BitstreamBlockInfo::BlockInfo *Info =
        BlockInfo.getBlockInfo(BlockID)) {
  if (!Info->Name.empty())
    return Info->Name.c_str();
}


if (CurStreamType != LLVMIRBitstream) return nullptr;

switch (BlockID) {
default:                                 return nullptr;
case bitc::OPERAND_BUNDLE_TAGS_BLOCK_ID: return "OPERAND_BUNDLE_TAGS_BLOCK";
case bitc::MODULE_BLOCK_ID:              return "MODULE_BLOCK";
case bitc::PARAMATTR_BLOCK_ID:           return "PARAMATTR_BLOCK";
case bitc::PARAMATTR_GROUP_BLOCK_ID:     return "PARAMATTR_GROUP_BLOCK_ID";
case bitc::TYPE_BLOCK_ID_NEW:            return "TYPE_BLOCK_ID";
case bitc::CONSTANTS_BLOCK_ID:           return "CONSTANTS_BLOCK";
case bitc::FUNCTION_BLOCK_ID:            return "FUNCTION_BLOCK";
case bitc::IDENTIFICATION_BLOCK_ID:
                                         return "IDENTIFICATION_BLOCK_ID";
case bitc::VALUE_SYMTAB_BLOCK_ID:        return "VALUE_SYMTAB";
case bitc::METADATA_BLOCK_ID:            return "METADATA_BLOCK";
case bitc::METADATA_KIND_BLOCK_ID:       return "METADATA_KIND_BLOCK";
case bitc::METADATA_ATTACHMENT_ID:       return "METADATA_ATTACHMENT_BLOCK";
case bitc::USELIST_BLOCK_ID:             return "USELIST_BLOCK_ID";
case bitc::GLOBALVAL_SUMMARY_BLOCK_ID:
                                         return "GLOBALVAL_SUMMARY_BLOCK";
case bitc::FULL_LTO_GLOBALVAL_SUMMARY_BLOCK_ID:
                                    return "FULL_LTO_GLOBALVAL_SUMMARY_BLOCK";
case bitc::MODULE_STRTAB_BLOCK_ID:       return "MODULE_STRTAB_BLOCK";
case bitc::STRTAB_BLOCK_ID:              return "STRTAB_BLOCK";
case bitc::SYMTAB_BLOCK_ID:              return "SYMTAB_BLOCK";
}
131}

133/// GetCodeName - Return a symbolic code name if known, otherwise return
134/// null.
135static const char *GetCodeName(unsigned CodeID, unsigned BlockID,
                             const BitstreamBlockInfo &BlockInfo,
                             CurStreamTypeType CurStreamType) {
// Standard blocks for all bitcode files.
if (BlockID < bitc::FIRST_APPLICATION_BLOCKID) {
  if (BlockID == bitc::BLOCKINFO_BLOCK_ID) {
    switch (CodeID) {
    default: return nullptr;
    case bitc::BLOCKINFO_CODE_SETBID:        return "SETBID";
    case bitc::BLOCKINFO_CODE_BLOCKNAME:     return "BLOCKNAME";
    case bitc::BLOCKINFO_CODE_SETRECORDNAME: return "SETRECORDNAME";
    }
  }
  return nullptr;
}

// Check to see if we have a blockinfo record for this record, with a name.
if (const BitstreamBlockInfo::BlockInfo *Info =
      BlockInfo.getBlockInfo(BlockID)) {
  for (unsigned i = 0, e = Info->RecordNames.size(); i != e; ++i)
    if (Info->RecordNames[i].first == CodeID)
      return Info->RecordNames[i].second.c_str();
}


if (CurStreamType != LLVMIRBitstream) return nullptr;

162#define STRINGIFY_CODE(PREFIX, CODE)                                           \
case bitc::PREFIX##_##CODE:                                                  \
  return #CODE;
switch (BlockID) {
default: return nullptr;
case bitc::MODULE_BLOCK_ID:
  switch (CodeID) {
  default: return nullptr;
    STRINGIFY_CODE(MODULE_CODE, VERSION)
    STRINGIFY_CODE(MODULE_CODE, TRIPLE)
    STRINGIFY_CODE(MODULE_CODE, DATALAYOUT)
    STRINGIFY_CODE(MODULE_CODE, ASM)
    STRINGIFY_CODE(MODULE_CODE, SECTIONNAME)
    STRINGIFY_CODE(MODULE_CODE, DEPLIB) // FIXME: Remove in 4.0
    STRINGIFY_CODE(MODULE_CODE, GLOBALVAR)
    STRINGIFY_CODE(MODULE_CODE, FUNCTION)
    STRINGIFY_CODE(MODULE_CODE, ALIAS)
    STRINGIFY_CODE(MODULE_CODE, GCNAME)
    STRINGIFY_CODE(MODULE_CODE, VSTOFFSET)
    STRINGIFY_CODE(MODULE_CODE, METADATA_VALUES_UNUSED)
    STRINGIFY_CODE(MODULE_CODE, SOURCE_FILENAME)
    STRINGIFY_CODE(MODULE_CODE, HASH)
  }
case bitc::IDENTIFICATION_BLOCK_ID:
  switch (CodeID) {
  default:
    return nullptr;
    STRINGIFY_CODE(IDENTIFICATION_CODE, STRING)
    STRINGIFY_CODE(IDENTIFICATION_CODE, EPOCH)
  }
case bitc::PARAMATTR_BLOCK_ID:
  switch (CodeID) {
  default: return nullptr;
  // FIXME: Should these be different?
  case bitc::PARAMATTR_CODE_ENTRY_OLD: return "ENTRY";
  case bitc::PARAMATTR_CODE_ENTRY:     return "ENTRY";
  }
case bitc::PARAMATTR_GROUP_BLOCK_ID:
  switch (CodeID) {
  default: return nullptr;
  case bitc::PARAMATTR_GRP_CODE_ENTRY: return "ENTRY";
  }
case bitc::TYPE_BLOCK_ID_NEW:
  switch (CodeID) {
  default: return nullptr;
    STRINGIFY_CODE(TYPE_CODE, NUMENTRY)
    STRINGIFY_CODE(TYPE_CODE, VOID)
    STRINGIFY_CODE(TYPE_CODE, FLOAT)
    STRINGIFY_CODE(TYPE_CODE, DOUBLE)
    STRINGIFY_CODE(TYPE_CODE, LABEL)
    STRINGIFY_CODE(TYPE_CODE, OPAQUE)
    STRINGIFY_CODE(TYPE_CODE, INTEGER)
    STRINGIFY_CODE(TYPE_CODE, POINTER)
    STRINGIFY_CODE(TYPE_CODE, ARRAY)
    STRINGIFY_CODE(TYPE_CODE, VECTOR)
    STRINGIFY_CODE(TYPE_CODE, X86_FP80)
    STRINGIFY_CODE(TYPE_CODE, FP128)
    STRINGIFY_CODE(TYPE_CODE, PPC_FP128)
    STRINGIFY_CODE(TYPE_CODE, METADATA)
    STRINGIFY_CODE(TYPE_CODE, STRUCT_ANON)
    STRINGIFY_CODE(TYPE_CODE, STRUCT_NAME)
    STRINGIFY_CODE(TYPE_CODE, STRUCT_NAMED)
    STRINGIFY_CODE(TYPE_CODE, FUNCTION)
  }

case bitc::CONSTANTS_BLOCK_ID:
  switch (CodeID) {
  default: return nullptr;
    STRINGIFY_CODE(CST_CODE, SETTYPE)
    STRINGIFY_CODE(CST_CODE, NULL__null)
    STRINGIFY_CODE(CST_CODE, UNDEF)
    STRINGIFY_CODE(CST_CODE, INTEGER)
    STRINGIFY_CODE(CST_CODE, WIDE_INTEGER)
    STRINGIFY_CODE(CST_CODE, FLOAT)
    STRINGIFY_CODE(CST_CODE, AGGREGATE)
    STRINGIFY_CODE(CST_CODE, STRING)
    STRINGIFY_CODE(CST_CODE, CSTRING)
    STRINGIFY_CODE(CST_CODE, CE_BINOP)
    STRINGIFY_CODE(CST_CODE, CE_CAST)
    STRINGIFY_CODE(CST_CODE, CE_GEP)
    STRINGIFY_CODE(CST_CODE, CE_INBOUNDS_GEP)
    STRINGIFY_CODE(CST_CODE, CE_SELECT)
    STRINGIFY_CODE(CST_CODE, CE_EXTRACTELT)
    STRINGIFY_CODE(CST_CODE, CE_INSERTELT)
    STRINGIFY_CODE(CST_CODE, CE_SHUFFLEVEC)
    STRINGIFY_CODE(CST_CODE, CE_CMP)
    STRINGIFY_CODE(CST_CODE, INLINEASM)
    STRINGIFY_CODE(CST_CODE, CE_SHUFVEC_EX)
  case bitc::CST_CODE_BLOCKADDRESS:    return "CST_CODE_BLOCKADDRESS";
    STRINGIFY_CODE(CST_CODE, DATA)
  }
case bitc::FUNCTION_BLOCK_ID:
  switch (CodeID) {
  default: return nullptr;
    STRINGIFY_CODE(FUNC_CODE, DECLAREBLOCKS)
    STRINGIFY_CODE(FUNC_CODE, INST_BINOP)
    STRINGIFY_CODE(FUNC_CODE, INST_CAST)
    STRINGIFY_CODE(FUNC_CODE, INST_GEP_OLD)
    STRINGIFY_CODE(FUNC_CODE, INST_INBOUNDS_GEP_OLD)
    STRINGIFY_CODE(FUNC_CODE, INST_SELECT)
    STRINGIFY_CODE(FUNC_CODE, INST_EXTRACTELT)
    STRINGIFY_CODE(FUNC_CODE, INST_INSERTELT)
    STRINGIFY_CODE(FUNC_CODE, INST_SHUFFLEVEC)
    STRINGIFY_CODE(FUNC_CODE, INST_CMP)
    STRINGIFY_CODE(FUNC_CODE, INST_RET)
    STRINGIFY_CODE(FUNC_CODE, INST_BR)
    STRINGIFY_CODE(FUNC_CODE, INST_SWITCH)
    STRINGIFY_CODE(FUNC_CODE, INST_INVOKE)
    STRINGIFY_CODE(FUNC_CODE, INST_UNREACHABLE)
    STRINGIFY_CODE(FUNC_CODE, INST_CLEANUPRET)
    STRINGIFY_CODE(FUNC_CODE, INST_CATCHRET)
    STRINGIFY_CODE(FUNC_CODE, INST_CATCHPAD)
    STRINGIFY_CODE(FUNC_CODE, INST_PHI)
    STRINGIFY_CODE(FUNC_CODE, INST_ALLOCA)
    STRINGIFY_CODE(FUNC_CODE, INST_LOAD)
    STRINGIFY_CODE(FUNC_CODE, INST_VAARG)
    STRINGIFY_CODE(FUNC_CODE, INST_STORE)
    STRINGIFY_CODE(FUNC_CODE, INST_EXTRACTVAL)
    STRINGIFY_CODE(FUNC_CODE, INST_INSERTVAL)
    STRINGIFY_CODE(FUNC_CODE, INST_CMP2)
    STRINGIFY_CODE(FUNC_CODE, INST_VSELECT)
    STRINGIFY_CODE(FUNC_CODE, DEBUG_LOC_AGAIN)
    STRINGIFY_CODE(FUNC_CODE, INST_CALL)
    STRINGIFY_CODE(FUNC_CODE, DEBUG_LOC)
    STRINGIFY_CODE(FUNC_CODE, INST_GEP)
    STRINGIFY_CODE(FUNC_CODE, OPERAND_BUNDLE)
    STRINGIFY_CODE(FUNC_CODE, INST_FENCE)
    STRINGIFY_CODE(FUNC_CODE, INST_ATOMICRMW)
    STRINGIFY_CODE(FUNC_CODE, INST_LOADATOMIC)
    STRINGIFY_CODE(FUNC_CODE, INST_STOREATOMIC)
    STRINGIFY_CODE(FUNC_CODE, INST_CMPXCHG)
  }
case bitc::VALUE_SYMTAB_BLOCK_ID:
  switch (CodeID) {
  default: return nullptr;
  STRINGIFY_CODE(VST_CODE, ENTRY)
  STRINGIFY_CODE(VST_CODE, BBENTRY)
  STRINGIFY_CODE(VST_CODE, FNENTRY)
  STRINGIFY_CODE(VST_CODE, COMBINED_ENTRY)
  }
case bitc::MODULE_STRTAB_BLOCK_ID:
  switch (CodeID) {
  default:
    return nullptr;
    STRINGIFY_CODE(MST_CODE, ENTRY)
    STRINGIFY_CODE(MST_CODE, HASH)
  }
case bitc::GLOBALVAL_SUMMARY_BLOCK_ID:
case bitc::FULL_LTO_GLOBALVAL_SUMMARY_BLOCK_ID:
  switch (CodeID) {
  default:
    return nullptr;
    STRINGIFY_CODE(FS, PERMODULE)
    STRINGIFY_CODE(FS, PERMODULE_PROFILE)
    STRINGIFY_CODE(FS, PERMODULE_RELBF)
    STRINGIFY_CODE(FS, PERMODULE_GLOBALVAR_INIT_REFS)
    STRINGIFY_CODE(FS, COMBINED)
    STRINGIFY_CODE(FS, COMBINED_PROFILE)
    STRINGIFY_CODE(FS, COMBINED_GLOBALVAR_INIT_REFS)
    STRINGIFY_CODE(FS, ALIAS)
    STRINGIFY_CODE(FS, COMBINED_ALIAS)
    STRINGIFY_CODE(FS, COMBINED_ORIGINAL_NAME)
    STRINGIFY_CODE(FS, VERSION)
    STRINGIFY_CODE(FS, FLAGS)
    STRINGIFY_CODE(FS, TYPE_TESTS)
    STRINGIFY_CODE(FS, TYPE_TEST_ASSUME_VCALLS)
    STRINGIFY_CODE(FS, TYPE_CHECKED_LOAD_VCALLS)
    STRINGIFY_CODE(FS, TYPE_TEST_ASSUME_CONST_VCALL)
    STRINGIFY_CODE(FS, TYPE_CHECKED_LOAD_CONST_VCALL)
    STRINGIFY_CODE(FS, VALUE_GUID)
    STRINGIFY_CODE(FS, CFI_FUNCTION_DEFS)
    STRINGIFY_CODE(FS, CFI_FUNCTION_DECLS)
    STRINGIFY_CODE(FS, TYPE_ID)
  }
case bitc::METADATA_ATTACHMENT_ID:
  switch(CodeID) {
  default:return nullptr;
    STRINGIFY_CODE(METADATA, ATTACHMENT)
  }
case bitc::METADATA_BLOCK_ID:
  switch(CodeID) {
  default:return nullptr;
    STRINGIFY_CODE(METADATA, STRING_OLD)
    STRINGIFY_CODE(METADATA, VALUE)
    STRINGIFY_CODE(METADATA, NODE)
    STRINGIFY_CODE(METADATA, NAME)
    STRINGIFY_CODE(METADATA, DISTINCT_NODE)
    STRINGIFY_CODE(METADATA, KIND) // Older bitcode has it in a MODULE_BLOCK
    STRINGIFY_CODE(METADATA, LOCATION)
    STRINGIFY_CODE(METADATA, OLD_NODE)
    STRINGIFY_CODE(METADATA, OLD_FN_NODE)
    STRINGIFY_CODE(METADATA, NAMED_NODE)
    STRINGIFY_CODE(METADATA, GENERIC_DEBUG)
    STRINGIFY_CODE(METADATA, SUBRANGE)
    STRINGIFY_CODE(METADATA, ENUMERATOR)
    STRINGIFY_CODE(METADATA, BASIC_TYPE)
    STRINGIFY_CODE(METADATA, FILE)
    STRINGIFY_CODE(METADATA, DERIVED_TYPE)
    STRINGIFY_CODE(METADATA, COMPOSITE_TYPE)
    STRINGIFY_CODE(METADATA, SUBROUTINE_TYPE)
    STRINGIFY_CODE(METADATA, COMPILE_UNIT)
    STRINGIFY_CODE(METADATA, SUBPROGRAM)
    STRINGIFY_CODE(METADATA, LEXICAL_BLOCK)
    STRINGIFY_CODE(METADATA, LEXICAL_BLOCK_FILE)
    STRINGIFY_CODE(METADATA, NAMESPACE)
    STRINGIFY_CODE(METADATA, TEMPLATE_TYPE)
    STRINGIFY_CODE(METADATA, TEMPLATE_VALUE)
    STRINGIFY_CODE(METADATA, GLOBAL_VAR)
    STRINGIFY_CODE(METADATA, LOCAL_VAR)
    STRINGIFY_CODE(METADATA, EXPRESSION)
    STRINGIFY_CODE(METADATA, OBJC_PROPERTY)
    STRINGIFY_CODE(METADATA, IMPORTED_ENTITY)
    STRINGIFY_CODE(METADATA, MODULE)
    STRINGIFY_CODE(METADATA, MACRO)
    STRINGIFY_CODE(METADATA, MACRO_FILE)
    STRINGIFY_CODE(METADATA, STRINGS)
    STRINGIFY_CODE(METADATA, GLOBAL_DECL_ATTACHMENT)
    STRINGIFY_CODE(METADATA, GLOBAL_VAR_EXPR)
    STRINGIFY_CODE(METADATA, INDEX_OFFSET)
    STRINGIFY_CODE(METADATA, INDEX)
  }
case bitc::METADATA_KIND_BLOCK_ID:
  switch (CodeID) {
  default:
    return nullptr;
    STRINGIFY_CODE(METADATA, KIND)
  }
case bitc::USELIST_BLOCK_ID:
  switch(CodeID) {
  default:return nullptr;
  case bitc::USELIST_CODE_DEFAULT: return "USELIST_CODE_DEFAULT";
  case bitc::USELIST_CODE_BB:      return "USELIST_CODE_BB";
  }

case bitc::OPERAND_BUNDLE_TAGS_BLOCK_ID:
  switch(CodeID) {
  default: return nullptr;
  case bitc::OPERAND_BUNDLE_TAG: return "OPERAND_BUNDLE_TAG";
  }
case bitc::STRTAB_BLOCK_ID:
  switch(CodeID) {
  default: return nullptr;
  case bitc::STRTAB_BLOB: return "BLOB";
  }
case bitc::SYMTAB_BLOCK_ID:
  switch(CodeID) {
  default: return nullptr;
  case bitc::SYMTAB_BLOB: return "BLOB";
  }
}
412#undef STRINGIFY_CODE
413}

415struct PerRecordStats {
unsigned NumInstances;
unsigned NumAbbrev;
uint64_t TotalBits;

PerRecordStats() : NumInstances(0), NumAbbrev(0), TotalBits(0) {}
421};

423struct PerBlockIDStats {
/// NumInstances - This the number of times this block ID has been seen.
unsigned NumInstances;

/// NumBits - The total size in bits of all of these blocks.
uint64_t NumBits;

/// NumSubBlocks - The total number of blocks these blocks contain.
unsigned NumSubBlocks;

/// NumAbbrevs - The total number of abbreviations.
unsigned NumAbbrevs;

/// NumRecords - The total number of records these blocks contain, and the
/// number that are abbreviated.
unsigned NumRecords, NumAbbreviatedRecords;

/// CodeFreq - Keep track of the number of times we see each code.
std::vector<PerRecordStats> CodeFreq;

PerBlockIDStats()
  : NumInstances(0), NumBits(0),
    NumSubBlocks(0), NumAbbrevs(0), NumRecords(0), NumAbbreviatedRecords(0) {}
446};

448static std::map<unsigned, PerBlockIDStats> BlockIDStats;



452/// ReportError - All bitcode analysis errors go through this function, making this a
453/// good place to breakpoint if debugging.
454static bool ReportError(const Twine &Err) {
WithColor::error() << Err << "\n";
return true;
457}

459static bool decodeMetadataStringsBlob(StringRef Indent,
                                    ArrayRef<uint64_t> Record,
                                    StringRef Blob) {
if (Blob.empty())
  return true;

if (Record.size() != 2)
  return true;

unsigned NumStrings = Record[0];
unsigned StringsOffset = Record[1];
outs() << " num-strings = " << NumStrings << " {\n";

StringRef Lengths = Blob.slice(0, StringsOffset);
SimpleBitstreamCursor R(Lengths);
StringRef Strings = Blob.drop_front(StringsOffset);
do {
  if (R.AtEndOfStream())
    return ReportError("bad length");

  unsigned Size = R.ReadVBR(6);
  if (Strings.size() < Size)
    return ReportError("truncated chars");

  outs() << Indent << "    '";
  outs().write_escaped(Strings.slice(0, Size), /*hex=*/true);
  outs() << "'\n";
  Strings = Strings.drop_front(Size);
} while (--NumStrings);

outs() << Indent << "  }";
return false;
491}

493static bool decodeBlob(unsigned Code, unsigned BlockID, StringRef Indent,
                     ArrayRef<uint64_t> Record, StringRef Blob) {
if (BlockID != bitc::METADATA_BLOCK_ID)
  return true;
if (Code != bitc::METADATA_STRINGS)
  return true;

return decodeMetadataStringsBlob(Indent, Record, Blob);
501}

503/// ParseBlock - Read a block, updating statistics, etc.
504static bool ParseBlock(BitstreamCursor &Stream, BitstreamBlockInfo &BlockInfo,
                     unsigned BlockID, unsigned IndentLevel,
                     CurStreamTypeType CurStreamType) {
std::string Indent(IndentLevel*2, ' ');
uint64_t BlockBitStart = Stream.GetCurrentBitNo();

// Get the statistics for this BlockID.
PerBlockIDStats &BlockStats = BlockIDStats[BlockID];

BlockStats.NumInstances++;

// BLOCKINFO is a special part of the stream.
bool DumpRecords = Dump;
if (BlockID == bitc::BLOCKINFO_BLOCK_ID) {
  if (Dump) outs() << Indent << "<BLOCKINFO_BLOCK/>\n";
  Optional<BitstreamBlockInfo> NewBlockInfo =
      Stream.ReadBlockInfoBlock(/*ReadBlockInfoNames=*/true);
  if (!NewBlockInfo)
    return ReportError("Malformed BlockInfoBlock");
  BlockInfo = std::move(*NewBlockInfo);
  Stream.JumpToBit(BlockBitStart);
  // It's not really interesting to dump the contents of the blockinfo block.
  DumpRecords = false;
}

unsigned NumWords = 0;
if (Stream.EnterSubBlock(BlockID, &NumWords))
  return ReportError("Malformed block record");

// Keep it for later, when we see a MODULE_HASH record
uint64_t BlockEntryPos = Stream.getCurrentByteNo();

const char *BlockName = nullptr;
if (DumpRecords) {
  outs() << Indent << "<";
  if ((BlockName = GetBlockName(BlockID, BlockInfo, CurStreamType)))
    outs() << BlockName;
  else
    outs() << "UnknownBlock" << BlockID;

  if (NonSymbolic && BlockName)
    outs() << " BlockID=" << BlockID;

  outs() << " NumWords=" << NumWords
         << " BlockCodeSize=" << Stream.getAbbrevIDWidth() << ">\n";
}

SmallVector<uint64_t, 64> Record;

// Keep the offset to the metadata index if seen.
uint64_t MetadataIndexOffset = 0;

// Read all the records for this block.
while (1) {
  if (Stream.AtEndOfStream())
    return ReportError("Premature end of bitstream");

  uint64_t RecordStartBit = Stream.GetCurrentBitNo();

  BitstreamEntry Entry =
    Stream.advance(BitstreamCursor::AF_DontAutoprocessAbbrevs);
  
  switch (Entry.Kind) {
  case BitstreamEntry::Error:
    return ReportError("malformed bitcode file");
  case BitstreamEntry::EndBlock: {
    uint64_t BlockBitEnd = Stream.GetCurrentBitNo();
    BlockStats.NumBits += BlockBitEnd-BlockBitStart;
    if (DumpRecords) {
      outs() << Indent << "</";
      if (BlockName)
        outs() << BlockName << ">\n";
      else
        outs() << "UnknownBlock" << BlockID << ">\n";
    }
    return false;
  }
      
  case BitstreamEntry::SubBlock: {
    uint64_t SubBlockBitStart = Stream.GetCurrentBitNo();
    if (ParseBlock(Stream, BlockInfo, Entry.ID, IndentLevel + 1,
                   CurStreamType))
      return true;
    ++BlockStats.NumSubBlocks;
    uint64_t SubBlockBitEnd = Stream.GetCurrentBitNo();
    
    // Don't include subblock sizes in the size of this block.
    BlockBitStart += SubBlockBitEnd-SubBlockBitStart;
    continue;
  }
  case BitstreamEntry::Record:
    // The interesting case.
    break;
  }

  if (Entry.ID == bitc::DEFINE_ABBREV) {
    Stream.ReadAbbrevRecord();
    ++BlockStats.NumAbbrevs;
    continue;
  }
  
  Record.clear();

  ++BlockStats.NumRecords;

  StringRef Blob;
  uint64_t CurrentRecordPos = Stream.GetCurrentBitNo();
  unsigned Code = Stream.readRecord(Entry.ID, Record, &Blob);

  // Increment the # occurrences of this code.
  if (BlockStats.CodeFreq.size() <= Code)
    BlockStats.CodeFreq.resize(Code+1);
  BlockStats.CodeFreq[Code].NumInstances++;
  BlockStats.CodeFreq[Code].TotalBits +=
    Stream.GetCurrentBitNo()-RecordStartBit;
  if (Entry.ID != bitc::UNABBREV_RECORD) {
    BlockStats.CodeFreq[Code].NumAbbrev++;
    ++BlockStats.NumAbbreviatedRecords;
  }

  if (DumpRecords) {
    outs() << Indent << "  <";
    if (const char *CodeName =
            GetCodeName(Code, BlockID, BlockInfo, CurStreamType))
      outs() << CodeName;
    else
      outs() << "UnknownCode" << Code;
    if (NonSymbolic && GetCodeName(Code, BlockID, BlockInfo, CurStreamType))
      outs() << " codeid=" << Code;
    const BitCodeAbbrev *Abbv = nullptr;
    if (Entry.ID != bitc::UNABBREV_RECORD) {
      Abbv = Stream.getAbbrev(Entry.ID);
      outs() << " abbrevid=" << Entry.ID;
    }

    for (unsigned i = 0, e = Record.size(); i != e; ++i)
      outs() << " op" << i << "=" << (int64_t)Record[i];

    // If we found a metadata index, let's verify that we had an offset before
    // and validate its forward reference offset was correct!
    if (BlockID == bitc::METADATA_BLOCK_ID) {
      if (Code == bitc::METADATA_INDEX_OFFSET) {
        if (Record.size() != 2)
          outs() << "(Invalid record)";
        else {
          auto Offset = Record[0] + (Record[1] << 32);
          MetadataIndexOffset = Stream.GetCurrentBitNo() + Offset;
        }
      }
      if (Code == bitc::METADATA_INDEX) {
        outs() << " (offset ";
        if (MetadataIndexOffset == RecordStartBit)
          outs() << "match)";
        else
          outs() << "mismatch: " << MetadataIndexOffset << " vs "
                 << RecordStartBit << ")";
      }
    }

    // If we found a module hash, let's verify that it matches!
    if (BlockID == bitc::MODULE_BLOCK_ID && Code == bitc::MODULE_CODE_HASH &&
        !CheckHash.empty()) {
      if (Record.size() != 5)
        outs() << " (invalid)";
      else {
        // Recompute the hash and compare it to the one in the bitcode
        SHA1 Hasher;
        StringRef Hash;
        Hasher.update(CheckHash);
        {
          int BlockSize = (CurrentRecordPos / 8) - BlockEntryPos;
          auto Ptr = Stream.getPointerToByte(BlockEntryPos, BlockSize);
          Hasher.update(ArrayRef<uint8_t>(Ptr, BlockSize));
          Hash = Hasher.result();
        }
        SmallString<20> RecordedHash;
        RecordedHash.resize(20);
        int Pos = 0;
        for (auto &Val : Record) {
          assert(!(Val >> 32) && "Unexpected high bits set")((!(Val >> 32) && "Unexpected high bits set") ?
 static_cast<void> (0) : __assert_fail ("!(Val >> 32) && \"Unexpected high bits set\""
, "/build/llvm-toolchain-snapshot-8~svn345461/tools/llvm-bcanalyzer/llvm-bcanalyzer.cpp"
, 683, __PRETTY_FUNCTION__));
          RecordedHash[Pos++] = (Val >> 24) & 0xFF;
          RecordedHash[Pos++] = (Val >> 16) & 0xFF;
          RecordedHash[Pos++] = (Val >> 8) & 0xFF;
          RecordedHash[Pos++] = (Val >> 0) & 0xFF;
        }
        if (Hash == RecordedHash)
          outs() << " (match)";
        else
          outs() << " (!mismatch!)";
      }
    }

    outs() << "/>";

    if (Abbv) {
      for (unsigned i = 1, e = Abbv->getNumOperandInfos(); i != e; ++i) {
        const BitCodeAbbrevOp &Op = Abbv->getOperandInfo(i);
        if (!Op.isEncoding() || Op.getEncoding() != BitCodeAbbrevOp::Array)
          continue;
        assert(i + 2 == e && "Array op not second to last")((i + 2 == e && "Array op not second to last") ? static_cast
<void> (0) : __assert_fail ("i + 2 == e && \"Array op not second to last\""
, "/build/llvm-toolchain-snapshot-8~svn345461/tools/llvm-bcanalyzer/llvm-bcanalyzer.cpp"
, 703, __PRETTY_FUNCTION__));
        std::string Str;
        bool ArrayIsPrintable = true;
        for (unsigned j = i - 1, je = Record.size(); j != je; ++j) {
          if (!isPrint(static_cast<unsigned char>(Record[j]))) {
            ArrayIsPrintable = false;
            break;
          }
          Str += (char)Record[j];
        }
        if (ArrayIsPrintable)
          outs() << " record string = '" << Str << "'";
        break;
      }
    }

    if (Blob.data() && decodeBlob(Code, BlockID, Indent, Record, Blob)) {
      outs() << " blob data = ";
      if (ShowBinaryBlobs) {
        outs() << "'";
        outs().write_escaped(Blob, /*hex=*/true) << "'";
      } else {
        bool BlobIsPrintable = true;
        for (unsigned i = 0, e = Blob.size(); i != e; ++i)
          if (!isPrint(static_cast<unsigned char>(Blob[i]))) {
            BlobIsPrintable = false;
            break;
          }

        if (BlobIsPrintable)
          outs() << "'" << Blob << "'";
        else
          outs() << "unprintable, " << Blob.size() << " bytes.";          
      }
    }

    outs() << "\n";
  }

  // Make sure that we can skip the current record.
  Stream.JumpToBit(CurrentRecordPos);
  Stream.skipRecord(Entry.ID);
}
746}

748static void PrintSize(double Bits) {
outs() << format("%.2f/%.2fB/%luW", Bits, Bits/8,(unsigned long)(Bits/32));
750}
751static void PrintSize(uint64_t Bits) {
outs() << format("%lub/%.2fB/%luW", (unsigned long)Bits,
                 (double)Bits/8, (unsigned long)(Bits/32));
754}

756static CurStreamTypeType ReadSignature(BitstreamCursor &Stream) {
char Signature[6];
Signature[0] = Stream.Read(8);
8
←
Calling 'SimpleBitstreamCursor::Read'→
Signature[1] = Stream.Read(8);

// Autodetect the file contents, if it is one we know.
if (Signature[0] == 'C' && Signature[1] == 'P') {
  Signature[2] = Stream.Read(8);
  Signature[3] = Stream.Read(8);
  if (Signature[2] == 'C' && Signature[3] == 'H')
    return ClangSerializedASTBitstream;
} else if (Signature[0] == 'D' && Signature[1] == 'I') {
  Signature[2] = Stream.Read(8);
  Signature[3] = Stream.Read(8);
  if (Signature[2] == 'A' && Signature[3] == 'G')
    return ClangSerializedDiagnosticsBitstream;
} else {
  Signature[2] = Stream.Read(4);
  Signature[3] = Stream.Read(4);
  Signature[4] = Stream.Read(4);
  Signature[5] = Stream.Read(4);
  if (Signature[0] == 'B' && Signature[1] == 'C' &&
      Signature[2] == 0x0 && Signature[3] == 0xC &&
      Signature[4] == 0xE && Signature[5] == 0xD)
    return LLVMIRBitstream;
}
return UnknownBitstream;
783}

785static bool openBitcodeFile(StringRef Path,
                          std::unique_ptr<MemoryBuffer> &MemBuf,
                          BitstreamCursor &Stream,
                          CurStreamTypeType &CurStreamType) {
// Read the input file.
ErrorOr<std::unique_ptr<MemoryBuffer>> MemBufOrErr =
    MemoryBuffer::getFileOrSTDIN(Path);
if (std::error_code EC = MemBufOrErr.getError())
3
←
Taking false branch→
  return ReportError(Twine("ReportError reading '") + Path + "': " + EC.message());
MemBuf = std::move(MemBufOrErr.get());

if (MemBuf->getBufferSize() & 3)
4
←
Assuming the condition is false→
5
←
Taking false branch→
  return ReportError("Bitcode stream should be a multiple of 4 bytes in length");

const unsigned char *BufPtr = (const unsigned char *)MemBuf->getBufferStart();
const unsigned char *EndBufPtr = BufPtr + MemBuf->getBufferSize();

// If we have a wrapper header, parse it and ignore the non-bc file contents.
// The magic number is 0x0B17C0DE stored in little endian.
if (isBitcodeWrapper(BufPtr, EndBufPtr)) {
6
←
Taking false branch→
  if (MemBuf->getBufferSize() < BWH_HeaderSize)
    return ReportError("Invalid bitcode wrapper header");

  if (Dump) {
    unsigned Magic = support::endian::read32le(&BufPtr[BWH_MagicField]);
    unsigned Version = support::endian::read32le(&BufPtr[BWH_VersionField]);
    unsigned Offset = support::endian::read32le(&BufPtr[BWH_OffsetField]);
    unsigned Size = support::endian::read32le(&BufPtr[BWH_SizeField]);
    unsigned CPUType = support::endian::read32le(&BufPtr[BWH_CPUTypeField]);

    outs() << "<BITCODE_WRAPPER_HEADER"
           << " Magic=" << format_hex(Magic, 10)
           << " Version=" << format_hex(Version, 10)
           << " Offset=" << format_hex(Offset, 10)
           << " Size=" << format_hex(Size, 10)
           << " CPUType=" << format_hex(CPUType, 10) << "/>\n";
  }

  if (SkipBitcodeWrapperHeader(BufPtr, EndBufPtr, true))
    return ReportError("Invalid bitcode wrapper header");
}

Stream = BitstreamCursor(ArrayRef<uint8_t>(BufPtr, EndBufPtr));
CurStreamType = ReadSignature(Stream);
7
←
Calling 'ReadSignature'→

return false;
831}

833/// AnalyzeBitcode - Analyze the bitcode file specified by InputFilename.
834static int AnalyzeBitcode() {
std::unique_ptr<MemoryBuffer> StreamBuffer;
BitstreamCursor Stream;
BitstreamBlockInfo BlockInfo;
CurStreamTypeType CurStreamType;
if (openBitcodeFile(InputFilename, StreamBuffer, Stream, CurStreamType))
2
←
Calling 'openBitcodeFile'→
  return true;
Stream.setBlockInfo(&BlockInfo);

// Read block info from BlockInfoFilename, if specified.
// The block info must be a top-level block.
if (!BlockInfoFilename.empty()) {
  std::unique_ptr<MemoryBuffer> BlockInfoBuffer;
  BitstreamCursor BlockInfoCursor;
  CurStreamTypeType BlockInfoStreamType;
  if (openBitcodeFile(BlockInfoFilename, BlockInfoBuffer, BlockInfoCursor,
                      BlockInfoStreamType))
    return true;

  while (!BlockInfoCursor.AtEndOfStream()) {
    unsigned Code = BlockInfoCursor.ReadCode();
    if (Code != bitc::ENTER_SUBBLOCK)
      return ReportError("Invalid record at top-level in block info file");

    unsigned BlockID = BlockInfoCursor.ReadSubBlockID();
    if (BlockID == bitc::BLOCKINFO_BLOCK_ID) {
      Optional<BitstreamBlockInfo> NewBlockInfo =
          BlockInfoCursor.ReadBlockInfoBlock(/*ReadBlockInfoNames=*/true);
      if (!NewBlockInfo)
        return ReportError("Malformed BlockInfoBlock in block info file");
      BlockInfo = std::move(*NewBlockInfo);
      break;
    }

    BlockInfoCursor.SkipBlock();
  }
}

unsigned NumTopBlocks = 0;

// Parse the top-level structure.  We only allow blocks at the top-level.
while (!Stream.AtEndOfStream()) {
  unsigned Code = Stream.ReadCode();
  if (Code != bitc::ENTER_SUBBLOCK)
    return ReportError("Invalid record at top-level");

  unsigned BlockID = Stream.ReadSubBlockID();

  if (ParseBlock(Stream, BlockInfo, BlockID, 0, CurStreamType))
    return true;
  ++NumTopBlocks;
}

if (Dump) outs() << "\n\n";

uint64_t BufferSizeBits = Stream.getBitcodeBytes().size() * CHAR_BIT8;
// Print a summary of the read file.
outs() << "Summary of " << InputFilename << ":\n";
outs() << "         Total size: ";
PrintSize(BufferSizeBits);
outs() << "\n";
outs() << "        Stream type: ";
switch (CurStreamType) {
case UnknownBitstream:
  outs() << "unknown\n";
  break;
case LLVMIRBitstream:
  outs() << "LLVM IR\n";
  break;
case ClangSerializedASTBitstream:
  outs() << "Clang Serialized AST\n";
  break;
case ClangSerializedDiagnosticsBitstream:
  outs() << "Clang Serialized Diagnostics\n";
  break;
}
outs() << "  # Toplevel Blocks: " << NumTopBlocks << "\n";
outs() << "\n";

// Emit per-block stats.
outs() << "Per-block Summary:\n";
for (std::map<unsigned, PerBlockIDStats>::iterator I = BlockIDStats.begin(),
     E = BlockIDStats.end(); I != E; ++I) {
  outs() << "  Block ID #" << I->first;
  if (const char *BlockName =
          GetBlockName(I->first, BlockInfo, CurStreamType))
    outs() << " (" << BlockName << ")";
  outs() << ":\n";

  const PerBlockIDStats &Stats = I->second;
  outs() << "      Num Instances: " << Stats.NumInstances << "\n";
  outs() << "         Total Size: ";
  PrintSize(Stats.NumBits);
  outs() << "\n";
  double pct = (Stats.NumBits * 100.0) / BufferSizeBits;
  outs() << "    Percent of file: " << format("%2.4f%%", pct) << "\n";
  if (Stats.NumInstances > 1) {
    outs() << "       Average Size: ";
    PrintSize(Stats.NumBits/(double)Stats.NumInstances);
    outs() << "\n";
    outs() << "  Tot/Avg SubBlocks: " << Stats.NumSubBlocks << "/"
           << Stats.NumSubBlocks/(double)Stats.NumInstances << "\n";
    outs() << "    Tot/Avg Abbrevs: " << Stats.NumAbbrevs << "/"
           << Stats.NumAbbrevs/(double)Stats.NumInstances << "\n";
    outs() << "    Tot/Avg Records: " << Stats.NumRecords << "/"
           << Stats.NumRecords/(double)Stats.NumInstances << "\n";
  } else {
    outs() << "      Num SubBlocks: " << Stats.NumSubBlocks << "\n";
    outs() << "        Num Abbrevs: " << Stats.NumAbbrevs << "\n";
    outs() << "        Num Records: " << Stats.NumRecords << "\n";
  }
  if (Stats.NumRecords) {
    double pct = (Stats.NumAbbreviatedRecords * 100.0) / Stats.NumRecords;
    outs() << "    Percent Abbrevs: " << format("%2.4f%%", pct) << "\n";
  }
  outs() << "\n";

  // Print a histogram of the codes we see.
  if (!NoHistogram && !Stats.CodeFreq.empty()) {
    std::vector<std::pair<unsigned, unsigned> > FreqPairs;  // <freq,code>
    for (unsigned i = 0, e = Stats.CodeFreq.size(); i != e; ++i)
      if (unsigned Freq = Stats.CodeFreq[i].NumInstances)
        FreqPairs.push_back(std::make_pair(Freq, i));
    std::stable_sort(FreqPairs.begin(), FreqPairs.end());
    std::reverse(FreqPairs.begin(), FreqPairs.end());

    outs() << "\tRecord Histogram:\n";
    outs() << "\t\t  Count    # Bits     b/Rec   % Abv  Record Kind\n";
    for (unsigned i = 0, e = FreqPairs.size(); i != e; ++i) {
      const PerRecordStats &RecStats = Stats.CodeFreq[FreqPairs[i].second];

      outs() << format("\t\t%7d %9lu",
                       RecStats.NumInstances,
                       (unsigned long)RecStats.TotalBits);

      if (RecStats.NumInstances > 1)
        outs() << format(" %9.1f",
                         (double)RecStats.TotalBits/RecStats.NumInstances);
      else
        outs() << "          ";

      if (RecStats.NumAbbrev)
        outs() <<
            format(" %7.2f",
                   (double)RecStats.NumAbbrev/RecStats.NumInstances*100);
      else
        outs() << "        ";

      outs() << "  ";
      if (const char *CodeName = GetCodeName(FreqPairs[i].second, I->first,
                                             BlockInfo, CurStreamType))
        outs() << CodeName << "\n";
      else
        outs() << "UnknownCode" << FreqPairs[i].second << "\n";
    }
    outs() << "\n";

  }
}
return 0;
994}


997int main(int argc, char **argv) {
InitLLVM X(argc, argv);
cl::ParseCommandLineOptions(argc, argv, "llvm-bcanalyzer file analyzer\n");
return AnalyzeBitcode();
1
Calling 'AnalyzeBitcode'→
1001}

←

/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Bitcode/BitstreamReader.h

1//===- BitstreamReader.h - Low-level bitstream reader interface -*- C++ -*-===//
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 header defines the BitstreamReader class.  This class can be used to
11// read an arbitrary bitstream, regardless of its contents.
12//
13//===----------------------------------------------------------------------===//

15#ifndef LLVM_BITCODE_BITSTREAMREADER_H
16#define LLVM_BITCODE_BITSTREAMREADER_H

18#include "llvm/ADT/ArrayRef.h"
19#include "llvm/ADT/SmallVector.h"
20#include "llvm/Bitcode/BitCodes.h"
21#include "llvm/Support/Endian.h"
22#include "llvm/Support/ErrorHandling.h"
23#include "llvm/Support/MathExtras.h"
24#include "llvm/Support/MemoryBuffer.h"
25#include <algorithm>
26#include <cassert>
27#include <climits>
28#include <cstddef>
29#include <cstdint>
30#include <memory>
31#include <string>
32#include <utility>
33#include <vector>

35namespace llvm {

37/// This class maintains the abbreviations read from a block info block.
38class BitstreamBlockInfo {
39public:
/// This contains information emitted to BLOCKINFO_BLOCK blocks. These
/// describe abbreviations that all blocks of the specified ID inherit.
struct BlockInfo {
  unsigned BlockID;
  std::vector<std::shared_ptr<BitCodeAbbrev>> Abbrevs;
  std::string Name;
  std::vector<std::pair<unsigned, std::string>> RecordNames;
};

49private:
std::vector<BlockInfo> BlockInfoRecords;

52public:
/// If there is block info for the specified ID, return it, otherwise return
/// null.
const BlockInfo *getBlockInfo(unsigned BlockID) const {
  // Common case, the most recent entry matches BlockID.
  if (!BlockInfoRecords.empty() && BlockInfoRecords.back().BlockID == BlockID)
    return &BlockInfoRecords.back();

  for (unsigned i = 0, e = static_cast<unsigned>(BlockInfoRecords.size());
       i != e; ++i)
    if (BlockInfoRecords[i].BlockID == BlockID)
      return &BlockInfoRecords[i];
  return nullptr;
}

BlockInfo &getOrCreateBlockInfo(unsigned BlockID) {
  if (const BlockInfo *BI = getBlockInfo(BlockID))
    return *const_cast<BlockInfo*>(BI);

  // Otherwise, add a new record.
  BlockInfoRecords.emplace_back();
  BlockInfoRecords.back().BlockID = BlockID;
  return BlockInfoRecords.back();
}
76};

78/// This represents a position within a bitstream. There may be multiple
79/// independent cursors reading within one bitstream, each maintaining their
80/// own local state.
81class SimpleBitstreamCursor {
ArrayRef<uint8_t> BitcodeBytes;
size_t NextChar = 0;

85public:
/// This is the current data we have pulled from the stream but have not
/// returned to the client. This is specifically and intentionally defined to
/// follow the word size of the host machine for efficiency. We use word_t in
/// places that are aware of this to make it perfectly explicit what is going
/// on.
using word_t = size_t;

93private:
word_t CurWord = 0;

/// This is the number of bits in CurWord that are valid. This is always from
/// [0...bits_of(size_t)-1] inclusive.
unsigned BitsInCurWord = 0;

100public:
static const size_t MaxChunkSize = sizeof(word_t) * 8;

SimpleBitstreamCursor() = default;
explicit SimpleBitstreamCursor(ArrayRef<uint8_t> BitcodeBytes)
    : BitcodeBytes(BitcodeBytes) {}
explicit SimpleBitstreamCursor(StringRef BitcodeBytes)
    : BitcodeBytes(reinterpret_cast<const uint8_t *>(BitcodeBytes.data()),
                   BitcodeBytes.size()) {}
explicit SimpleBitstreamCursor(MemoryBufferRef BitcodeBytes)
    : SimpleBitstreamCursor(BitcodeBytes.getBuffer()) {}

bool canSkipToPos(size_t pos) const {
  // pos can be skipped to if it is a valid address or one byte past the end.
  return pos <= BitcodeBytes.size();
}

bool AtEndOfStream() {
  return BitsInCurWord == 0 && BitcodeBytes.size() <= NextChar;
}

/// Return the bit # of the bit we are reading.
uint64_t GetCurrentBitNo() const {
  return NextChar*CHAR_BIT8 - BitsInCurWord;
}

// Return the byte # of the current bit.
uint64_t getCurrentByteNo() const { return GetCurrentBitNo() / 8; }

ArrayRef<uint8_t> getBitcodeBytes() const { return BitcodeBytes; }

/// Reset the stream to the specified bit number.
void JumpToBit(uint64_t BitNo) {
  size_t ByteNo = size_t(BitNo/8) & ~(sizeof(word_t)-1);
  unsigned WordBitNo = unsigned(BitNo & (sizeof(word_t)*8-1));
  assert(canSkipToPos(ByteNo) && "Invalid location")((canSkipToPos(ByteNo) && "Invalid location") ? static_cast
<void> (0) : __assert_fail ("canSkipToPos(ByteNo) && \"Invalid location\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Bitcode/BitstreamReader.h"
, 135, __PRETTY_FUNCTION__));

  // Move the cursor to the right word.
  NextChar = ByteNo;
  BitsInCurWord = 0;

  // Skip over any bits that are already consumed.
  if (WordBitNo)
    Read(WordBitNo);
}

/// Get a pointer into the bitstream at the specified byte offset.
const uint8_t *getPointerToByte(uint64_t ByteNo, uint64_t NumBytes) {
  return BitcodeBytes.data() + ByteNo;
}

/// Get a pointer into the bitstream at the specified bit offset.
///
/// The bit offset must be on a byte boundary.
const uint8_t *getPointerToBit(uint64_t BitNo, uint64_t NumBytes) {
  assert(!(BitNo % 8) && "Expected bit on byte boundary")((!(BitNo % 8) && "Expected bit on byte boundary") ? static_cast
<void> (0) : __assert_fail ("!(BitNo % 8) && \"Expected bit on byte boundary\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Bitcode/BitstreamReader.h"
, 155, __PRETTY_FUNCTION__));
  return getPointerToByte(BitNo / 8, NumBytes);
}

void fillCurWord() {
  if (NextChar >= BitcodeBytes.size())
    report_fatal_error("Unexpected end of file");

  // Read the next word from the stream.
  const uint8_t *NextCharPtr = BitcodeBytes.data() + NextChar;
  unsigned BytesRead;
  if (BitcodeBytes.size() >= NextChar + sizeof(word_t)) {
    BytesRead = sizeof(word_t);
    CurWord =
        support::endian::read<word_t, support::little, support::unaligned>(
            NextCharPtr);
  } else {
    // Short read.
    BytesRead = BitcodeBytes.size() - NextChar;
    CurWord = 0;
    for (unsigned B = 0; B != BytesRead; ++B)
      CurWord |= uint64_t(NextCharPtr[B]) << (B * 8);
  }
  NextChar += BytesRead;
  BitsInCurWord = BytesRead * 8;
}

word_t Read(unsigned NumBits) {
  static const unsigned BitsInWord = MaxChunkSize;

  assert(NumBits && NumBits <= BitsInWord &&((NumBits && NumBits <= BitsInWord && "Cannot return zero or more than BitsInWord bits!"
) ? static_cast<void> (0) : __assert_fail ("NumBits && NumBits <= BitsInWord && \"Cannot return zero or more than BitsInWord bits!\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Bitcode/BitstreamReader.h"
, 186, __PRETTY_FUNCTION__))
         "Cannot return zero or more than BitsInWord bits!")((NumBits && NumBits <= BitsInWord && "Cannot return zero or more than BitsInWord bits!"
) ? static_cast<void> (0) : __assert_fail ("NumBits && NumBits <= BitsInWord && \"Cannot return zero or more than BitsInWord bits!\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Bitcode/BitstreamReader.h"
, 186, __PRETTY_FUNCTION__));

  static const unsigned Mask = sizeof(word_t) > 4 ? 0x3f : 0x1f;
9
←
'?' condition is true→

  // If the field is fully contained by CurWord, return it quickly.
  if (BitsInCurWord >= NumBits) {
10
←
Assuming the condition is false→
11
←
Taking false branch→
    word_t R = CurWord & (~word_t(0) >> (BitsInWord - NumBits));

    // Use a mask to avoid undefined behavior.
    CurWord >>= (NumBits & Mask);

    BitsInCurWord -= NumBits;
    return R;
  }

  word_t R = BitsInCurWord ? CurWord : 0;
12
←
Assuming the condition is true→
13
←
'?' condition is true→
  unsigned BitsLeft = NumBits - BitsInCurWord;

  fillCurWord();

  // If we run out of data, abort.
  if (BitsLeft > BitsInCurWord)
14
←
Assuming the condition is false→
15
←
Taking false branch→
    report_fatal_error("Unexpected end of file");

  word_t R2 = CurWord & (~word_t(0) >> (BitsInWord - BitsLeft));
16
←
The result of the right shift is undefined due to shifting by '64', which is greater or equal to the width of type 'llvm::SimpleBitstreamCursor::word_t'

  // Use a mask to avoid undefined behavior.
  CurWord >>= (BitsLeft & Mask);

  BitsInCurWord -= BitsLeft;

  R |= R2 << (NumBits - BitsLeft);

  return R;
}

uint32_t ReadVBR(unsigned NumBits) {
  uint32_t Piece = Read(NumBits);
  if ((Piece & (1U << (NumBits-1))) == 0)
    return Piece;

  uint32_t Result = 0;
  unsigned NextBit = 0;
  while (true) {
    Result |= (Piece & ((1U << (NumBits-1))-1)) << NextBit;

    if ((Piece & (1U << (NumBits-1))) == 0)
      return Result;

    NextBit += NumBits-1;
    Piece = Read(NumBits);
  }
}

// Read a VBR that may have a value up to 64-bits in size. The chunk size of
// the VBR must still be <= 32 bits though.
uint64_t ReadVBR64(unsigned NumBits) {
  uint32_t Piece = Read(NumBits);
  if ((Piece & (1U << (NumBits-1))) == 0)
    return uint64_t(Piece);

  uint64_t Result = 0;
  unsigned NextBit = 0;
  while (true) {
    Result |= uint64_t(Piece & ((1U << (NumBits-1))-1)) << NextBit;

    if ((Piece & (1U << (NumBits-1))) == 0)
      return Result;

    NextBit += NumBits-1;
    Piece = Read(NumBits);
  }
}

void SkipToFourByteBoundary() {
  // If word_t is 64-bits and if we've read less than 32 bits, just dump
  // the bits we have up to the next 32-bit boundary.
  if (sizeof(word_t) > 4 &&
      BitsInCurWord >= 32) {
    CurWord >>= BitsInCurWord-32;
    BitsInCurWord = 32;
    return;
  }

  BitsInCurWord = 0;
}

/// Skip to the end of the file.
void skipToEnd() { NextChar = BitcodeBytes.size(); }
275};

277/// When advancing through a bitstream cursor, each advance can discover a few
278/// different kinds of entries:
279struct BitstreamEntry {
enum {
  Error,    // Malformed bitcode was found.
  EndBlock, // We've reached the end of the current block, (or the end of the
            // file, which is treated like a series of EndBlock records.
  SubBlock, // This is the start of a new subblock of a specific ID.
  Record    // This is a record with a specific AbbrevID.
} Kind;

unsigned ID;

static BitstreamEntry getError() {
  BitstreamEntry E; E.Kind = Error; return E;
}

static BitstreamEntry getEndBlock() {
  BitstreamEntry E; E.Kind = EndBlock; return E;
}

static BitstreamEntry getSubBlock(unsigned ID) {
  BitstreamEntry E; E.Kind = SubBlock; E.ID = ID; return E;
}

static BitstreamEntry getRecord(unsigned AbbrevID) {
  BitstreamEntry E; E.Kind = Record; E.ID = AbbrevID; return E;
}
305};

307/// This represents a position within a bitcode file, implemented on top of a
308/// SimpleBitstreamCursor.
309///
310/// Unlike iterators, BitstreamCursors are heavy-weight objects that should not
311/// be passed by value.
312class BitstreamCursor : SimpleBitstreamCursor {
// This is the declared size of code values used for the current block, in
// bits.
unsigned CurCodeSize = 2;

/// Abbrevs installed at in this block.
std::vector<std::shared_ptr<BitCodeAbbrev>> CurAbbrevs;

struct Block {
  unsigned PrevCodeSize;
  std::vector<std::shared_ptr<BitCodeAbbrev>> PrevAbbrevs;

  explicit Block(unsigned PCS) : PrevCodeSize(PCS) {}
};

/// This tracks the codesize of parent blocks.
SmallVector<Block, 8> BlockScope;

BitstreamBlockInfo *BlockInfo = nullptr;

332public:
static const size_t MaxChunkSize = sizeof(word_t) * 8;

BitstreamCursor() = default;
explicit BitstreamCursor(ArrayRef<uint8_t> BitcodeBytes)
    : SimpleBitstreamCursor(BitcodeBytes) {}
explicit BitstreamCursor(StringRef BitcodeBytes)
    : SimpleBitstreamCursor(BitcodeBytes) {}
explicit BitstreamCursor(MemoryBufferRef BitcodeBytes)
    : SimpleBitstreamCursor(BitcodeBytes) {}

using SimpleBitstreamCursor::canSkipToPos;
using SimpleBitstreamCursor::AtEndOfStream;
using SimpleBitstreamCursor::getBitcodeBytes;
using SimpleBitstreamCursor::GetCurrentBitNo;
using SimpleBitstreamCursor::getCurrentByteNo;
using SimpleBitstreamCursor::getPointerToByte;
using SimpleBitstreamCursor::JumpToBit;
using SimpleBitstreamCursor::fillCurWord;
using SimpleBitstreamCursor::Read;
using SimpleBitstreamCursor::ReadVBR;
using SimpleBitstreamCursor::ReadVBR64;

/// Return the number of bits used to encode an abbrev #.
unsigned getAbbrevIDWidth() const { return CurCodeSize; }

/// Flags that modify the behavior of advance().
enum {
  /// If this flag is used, the advance() method does not automatically pop
  /// the block scope when the end of a block is reached.
  AF_DontPopBlockAtEnd = 1,

  /// If this flag is used, abbrev entries are returned just like normal
  /// records.
  AF_DontAutoprocessAbbrevs = 2
};

/// Advance the current bitstream, returning the next entry in the stream.
BitstreamEntry advance(unsigned Flags = 0) {
  while (true) {
    if (AtEndOfStream())
      return BitstreamEntry::getError();

    unsigned Code = ReadCode();
    if (Code == bitc::END_BLOCK) {
      // Pop the end of the block unless Flags tells us not to.
      if (!(Flags & AF_DontPopBlockAtEnd) && ReadBlockEnd())
        return BitstreamEntry::getError();
      return BitstreamEntry::getEndBlock();
    }

    if (Code == bitc::ENTER_SUBBLOCK)
      return BitstreamEntry::getSubBlock(ReadSubBlockID());

    if (Code == bitc::DEFINE_ABBREV &&
        !(Flags & AF_DontAutoprocessAbbrevs)) {
      // We read and accumulate abbrev's, the client can't do anything with
      // them anyway.
      ReadAbbrevRecord();
      continue;
    }

    return BitstreamEntry::getRecord(Code);
  }
}

/// This is a convenience function for clients that don't expect any
/// subblocks. This just skips over them automatically.
BitstreamEntry advanceSkippingSubblocks(unsigned Flags = 0) {
  while (true) {
    // If we found a normal entry, return it.
    BitstreamEntry Entry = advance(Flags);
    if (Entry.Kind != BitstreamEntry::SubBlock)
      return Entry;

    // If we found a sub-block, just skip over it and check the next entry.
    if (SkipBlock())
      return BitstreamEntry::getError();
  }
}

unsigned ReadCode() {
  return Read(CurCodeSize);
}

// Block header:
//    [ENTER_SUBBLOCK, blockid, newcodelen, <align4bytes>, blocklen]

/// Having read the ENTER_SUBBLOCK code, read the BlockID for the block.
unsigned ReadSubBlockID() {
  return ReadVBR(bitc::BlockIDWidth);
}

/// Having read the ENTER_SUBBLOCK abbrevid and a BlockID, skip over the body
/// of this block. If the block record is malformed, return true.
bool SkipBlock() {
  // Read and ignore the codelen value.  Since we are skipping this block, we
  // don't care what code widths are used inside of it.
  ReadVBR(bitc::CodeLenWidth);
  SkipToFourByteBoundary();
  size_t NumFourBytes = Read(bitc::BlockSizeWidth);

  // Check that the block wasn't partially defined, and that the offset isn't
  // bogus.
  size_t SkipTo = GetCurrentBitNo() + NumFourBytes*4*8;
  if (AtEndOfStream() || !canSkipToPos(SkipTo/8))
    return true;

  JumpToBit(SkipTo);
  return false;
}

/// Having read the ENTER_SUBBLOCK abbrevid, enter the block, and return true
/// if the block has an error.
bool EnterSubBlock(unsigned BlockID, unsigned *NumWordsP = nullptr);

bool ReadBlockEnd() {
  if (BlockScope.empty()) return true;

  // Block tail:
  //    [END_BLOCK, <align4bytes>]
  SkipToFourByteBoundary();

  popBlockScope();
  return false;
}

459private:
void popBlockScope() {
  CurCodeSize = BlockScope.back().PrevCodeSize;

  CurAbbrevs = std::move(BlockScope.back().PrevAbbrevs);
  BlockScope.pop_back();
}

//===--------------------------------------------------------------------===//
// Record Processing
//===--------------------------------------------------------------------===//

471public:
/// Return the abbreviation for the specified AbbrevId.
const BitCodeAbbrev *getAbbrev(unsigned AbbrevID) {
  unsigned AbbrevNo = AbbrevID - bitc::FIRST_APPLICATION_ABBREV;
  if (AbbrevNo >= CurAbbrevs.size())
    report_fatal_error("Invalid abbrev number");
  return CurAbbrevs[AbbrevNo].get();
}

/// Read the current record and discard it, returning the code for the record.
unsigned skipRecord(unsigned AbbrevID);

unsigned readRecord(unsigned AbbrevID, SmallVectorImpl<uint64_t> &Vals,
                    StringRef *Blob = nullptr);

//===--------------------------------------------------------------------===//
// Abbrev Processing
//===--------------------------------------------------------------------===//
void ReadAbbrevRecord();

/// Read and return a block info block from the bitstream. If an error was
/// encountered, return None.
///
/// \param ReadBlockInfoNames Whether to read block/record name information in
/// the BlockInfo block. Only llvm-bcanalyzer uses this.
Optional<BitstreamBlockInfo>
ReadBlockInfoBlock(bool ReadBlockInfoNames = false);

/// Set the block info to be used by this BitstreamCursor to interpret
/// abbreviated records.
void setBlockInfo(BitstreamBlockInfo *BI) { BlockInfo = BI; }
502};

504} // end llvm namespace

506#endif // LLVM_BITCODE_BITSTREAMREADER_H