25static std::optional<const char *>
31 return "BLOCKINFO_BLOCK";
38 if (!
Info->Name.empty())
39 return Info->Name.c_str();
49 return "OPERAND_BUNDLE_TAGS_BLOCK";
51 return "MODULE_BLOCK";
53 return "PARAMATTR_BLOCK";
55 return "PARAMATTR_GROUP_BLOCK_ID";
57 return "TYPE_BLOCK_ID";
59 return "CONSTANTS_BLOCK";
61 return "FUNCTION_BLOCK";
63 return "IDENTIFICATION_BLOCK_ID";
65 return "VALUE_SYMTAB";
67 return "METADATA_BLOCK";
69 return "METADATA_KIND_BLOCK";
71 return "METADATA_ATTACHMENT_BLOCK";
73 return "USELIST_BLOCK_ID";
75 return "GLOBALVAL_SUMMARY_BLOCK";
77 return "FULL_LTO_GLOBALVAL_SUMMARY_BLOCK";
79 return "MODULE_STRTAB_BLOCK";
81 return "STRTAB_BLOCK";
83 return "SYMTAB_BLOCK";
88static std::optional<const char *>
103 return "SETRECORDNAME";
112 for (
const std::pair<unsigned, std::string> &RN :
Info->RecordNames)
113 if (RN.first == CodeID)
114 return RN.second.c_str();
120#define STRINGIFY_CODE(PREFIX, CODE) \
121 case bitc::PREFIX##_##CODE: \
227 return "CST_CODE_BLOCKADDRESS";
393 return "USELIST_CODE_DEFAULT";
395 return "USELIST_CODE_BB";
403 return "OPERAND_BUNDLE_TAG";
424 OS <<
format(
"%.2f/%.2fB/%luW", Bits, Bits / 8, (
unsigned long)(Bits / 32));
427 OS <<
format(
"%lub/%.2fB/%luW", (
unsigned long)Bits, (
double)Bits / 8,
428 (
unsigned long)(Bits / 32));
432 auto tryRead = [&Stream](
char &Dest,
size_t size) ->
Error {
434 Dest = MaybeWord.get();
436 return MaybeWord.takeError();
441 if (
Error Err = tryRead(Signature[0], 8))
442 return std::move(Err);
443 if (
Error Err = tryRead(Signature[1], 8))
444 return std::move(Err);
447 if (Signature[0] ==
'C' && Signature[1] ==
'P') {
448 if (
Error Err = tryRead(Signature[2], 8))
449 return std::move(Err);
450 if (
Error Err = tryRead(Signature[3], 8))
451 return std::move(Err);
452 if (Signature[2] ==
'C' && Signature[3] ==
'H')
454 }
else if (Signature[0] ==
'D' && Signature[1] ==
'I') {
455 if (
Error Err = tryRead(Signature[2], 8))
456 return std::move(Err);
457 if (
Error Err = tryRead(Signature[3], 8))
458 return std::move(Err);
459 if (Signature[2] ==
'A' && Signature[3] ==
'G')
461 }
else if (Signature[0] ==
'R' && Signature[1] ==
'M') {
462 if (
Error Err = tryRead(Signature[2], 8))
463 return std::move(Err);
464 if (
Error Err = tryRead(Signature[3], 8))
465 return std::move(Err);
466 if (Signature[2] ==
'R' && Signature[3] ==
'K')
469 if (
Error Err = tryRead(Signature[2], 4))
470 return std::move(Err);
471 if (
Error Err = tryRead(Signature[3], 4))
472 return std::move(Err);
473 if (
Error Err = tryRead(Signature[4], 4))
474 return std::move(Err);
475 if (
Error Err = tryRead(Signature[5], 4))
476 return std::move(Err);
477 if (Signature[0] ==
'B' && Signature[1] ==
'C' && Signature[2] == 0x0 &&
478 Signature[3] == 0xC && Signature[4] == 0xE && Signature[5] == 0xD)
487 const unsigned char *BufPtr = (
const unsigned char *)Bytes.
data();
488 const unsigned char *EndBufPtr = BufPtr + Bytes.
size();
494 return reportError(
"Invalid bitcode wrapper header");
503 O->OS <<
"<BITCODE_WRAPPER_HEADER"
508 <<
" CPUType=" <<
format_hex(CPUType, 10) <<
"/>\n";
512 return reportError(
"Invalid bitcode wrapper header");
534 "Decoding metadata strings blob needs two record entries.");
536 unsigned NumStrings =
Record[0];
537 unsigned StringsOffset =
Record[1];
538 OS <<
" num-strings = " << NumStrings <<
" {\n";
544 if (
R.AtEndOfStream())
550 if (Strings.size() <
Size)
553 OS << Indent <<
" '";
556 Strings = Strings.drop_front(
Size);
557 }
while (--NumStrings);
559 OS << Indent <<
" }";
564 std::optional<StringRef> BlockInfoBuffer)
567 BlockInfoStream.emplace(*BlockInfoBuffer);
571 std::optional<StringRef> CheckHash) {
579 if (BlockInfoStream) {
589 return reportError(
"Invalid record at top-level in block info file");
595 std::optional<BitstreamBlockInfo> NewBlockInfo;
598 .moveInto(NewBlockInfo))
601 return reportError(
"Malformed BlockInfoBlock in block info file");
602 BlockInfo = std::move(*NewBlockInfo);
623 if (
Error E = parseBlock(MaybeBlockID.
get(), 0, O, CheckHash))
632 std::optional<StringRef> Filename) {
637 O.OS <<
"of " << Filename->data() <<
":\n";
638 O.OS <<
" Total size: ";
641 O.OS <<
" Stream type: ";
642 switch (CurStreamType) {
650 O.OS <<
"Clang Serialized AST\n";
653 O.OS <<
"Clang Serialized Diagnostics\n";
656 O.OS <<
"LLVM Remarks\n";
659 O.OS <<
" # Toplevel Blocks: " << NumTopBlocks <<
"\n";
663 O.OS <<
"Per-block Summary:\n";
664 for (
const auto &Stat : BlockIDStats) {
665 O.OS <<
" Block ID #" << Stat.first;
666 if (std::optional<const char *> BlockName =
668 O.OS <<
" (" << *BlockName <<
")";
671 const PerBlockIDStats &
Stats = Stat.second;
672 O.OS <<
" Num Instances: " <<
Stats.NumInstances <<
"\n";
673 O.OS <<
" Total Size: ";
676 double pct = (
Stats.NumBits * 100.0) / BufferSizeBits;
677 O.OS <<
" Percent of file: " <<
format(
"%2.4f%%", pct) <<
"\n";
678 if (
Stats.NumInstances > 1) {
679 O.OS <<
" Average Size: ";
682 O.OS <<
" Tot/Avg SubBlocks: " <<
Stats.NumSubBlocks <<
"/"
683 <<
Stats.NumSubBlocks / (double)
Stats.NumInstances <<
"\n";
684 O.OS <<
" Tot/Avg Abbrevs: " <<
Stats.NumAbbrevs <<
"/"
685 <<
Stats.NumAbbrevs / (
double)
Stats.NumInstances <<
"\n";
686 O.OS <<
" Tot/Avg Records: " <<
Stats.NumRecords <<
"/"
687 <<
Stats.NumRecords / (double)
Stats.NumInstances <<
"\n";
689 O.OS <<
" Num SubBlocks: " <<
Stats.NumSubBlocks <<
"\n";
690 O.OS <<
" Num Abbrevs: " <<
Stats.NumAbbrevs <<
"\n";
691 O.OS <<
" Num Records: " <<
Stats.NumRecords <<
"\n";
693 if (
Stats.NumRecords) {
694 double pct = (
Stats.NumAbbreviatedRecords * 100.0) /
Stats.NumRecords;
695 O.OS <<
" Percent Abbrevs: " <<
format(
"%2.4f%%", pct) <<
"\n";
700 if (O.Histogram && !
Stats.CodeFreq.empty()) {
701 std::vector<std::pair<unsigned, unsigned>> FreqPairs;
702 for (
unsigned i = 0, e =
Stats.CodeFreq.size(); i != e; ++i)
703 if (
unsigned Freq =
Stats.CodeFreq[i].NumInstances)
704 FreqPairs.push_back(std::make_pair(Freq, i));
706 std::reverse(FreqPairs.begin(), FreqPairs.end());
708 O.OS <<
"\tRecord Histogram:\n";
709 O.OS <<
"\t\t Count # Bits b/Rec % Abv Record Kind\n";
710 for (
const auto &FreqPair : FreqPairs) {
711 const PerRecordStats &RecStats =
Stats.CodeFreq[FreqPair.second];
713 O.OS <<
format(
"\t\t%7d %9lu", RecStats.NumInstances,
714 (
unsigned long)RecStats.TotalBits);
716 if (RecStats.NumInstances > 1)
718 (
double)RecStats.TotalBits / RecStats.NumInstances);
722 if (RecStats.NumAbbrev)
723 O.OS <<
format(
" %7.2f", (
double)RecStats.NumAbbrev /
724 RecStats.NumInstances * 100);
729 if (std::optional<const char *> CodeName =
GetCodeName(
730 FreqPair.second, Stat.first, BlockInfo, CurStreamType))
731 O.OS << *CodeName <<
"\n";
733 O.OS <<
"UnknownCode" << FreqPair.second <<
"\n";
740Error BitcodeAnalyzer::parseBlock(
unsigned BlockID,
unsigned IndentLevel,
741 std::optional<BCDumpOptions> O,
742 std::optional<StringRef> CheckHash) {
743 std::string Indent(IndentLevel * 2,
' ');
747 PerBlockIDStats &BlockStats = BlockIDStats[BlockID];
749 BlockStats.NumInstances++;
752 bool DumpRecords = O.has_value();
754 if (O && !O->DumpBlockinfo)
755 O->OS << Indent <<
"<BLOCKINFO_BLOCK/>\n";
756 std::optional<BitstreamBlockInfo> NewBlockInfo;
758 .moveInto(NewBlockInfo))
762 BlockInfo = std::move(*NewBlockInfo);
767 DumpRecords = O && O->DumpBlockinfo;
770 unsigned NumWords = 0;
777 std::optional<const char *> BlockName;
779 O->OS << Indent <<
"<";
780 if ((BlockName =
GetBlockName(BlockID, BlockInfo, CurStreamType)))
783 O->OS <<
"UnknownBlock" << BlockID;
785 if (!O->Symbolic && BlockName)
786 O->OS <<
" BlockID=" << BlockID;
788 O->OS <<
" NumWords=" << NumWords
809 switch (
Entry.Kind) {
814 BlockStats.NumBits += BlockBitEnd - BlockBitStart;
816 O->OS << Indent <<
"</";
818 O->OS << *BlockName <<
">\n";
820 O->OS <<
"UnknownBlock" << BlockID <<
">\n";
827 if (
Error E = parseBlock(
Entry.ID, IndentLevel + 1, O, CheckHash))
829 ++BlockStats.NumSubBlocks;
833 BlockBitStart += SubBlockBitEnd - SubBlockBitStart;
844 ++BlockStats.NumAbbrevs;
850 ++BlockStats.NumRecords;
859 if (BlockStats.CodeFreq.size() <= Code)
860 BlockStats.CodeFreq.resize(Code + 1);
861 BlockStats.CodeFreq[
Code].NumInstances++;
862 BlockStats.CodeFreq[
Code].TotalBits +=
865 BlockStats.CodeFreq[
Code].NumAbbrev++;
866 ++BlockStats.NumAbbreviatedRecords;
870 O->OS << Indent <<
" <";
871 std::optional<const char *> CodeName =
872 GetCodeName(Code, BlockID, BlockInfo, CurStreamType);
876 O->OS <<
"UnknownCode" <<
Code;
877 if (!
O->Symbolic && CodeName)
878 O->OS <<
" codeid=" <<
Code;
884 Abbv = MaybeAbbv.
get();
885 O->OS <<
" abbrevid=" <<
Entry.ID;
888 for (
unsigned i = 0, e =
Record.size(); i != e; ++i)
889 O->OS <<
" op" << i <<
"=" << (int64_t)
Record[i];
896 O->OS <<
"(Invalid record)";
903 O->OS <<
" (offset ";
904 if (MetadataIndexOffset == RecordStartBit)
907 O->OS <<
"mismatch: " << MetadataIndexOffset <<
" vs "
908 << RecordStartBit <<
")";
916 O->OS <<
" (invalid)";
920 std::array<uint8_t, 20> Hash;
921 Hasher.
update(*CheckHash);
923 int BlockSize = (CurrentRecordPos / 8) - BlockEntryPos;
926 Hash = Hasher.result();
928 std::array<uint8_t, 20> RecordedHash;
930 for (
auto &Val :
Record) {
931 assert(!(Val >> 32) &&
"Unexpected high bits set");
935 if (Hash == RecordedHash)
938 O->OS <<
" (!mismatch!)";
949 assert(i + 2 == e &&
"Array op not second to last");
951 bool ArrayIsPrintable =
true;
952 for (
unsigned j = i - 1, je =
Record.size(); j != je; ++j) {
954 ArrayIsPrintable =
false;
959 if (ArrayIsPrintable)
960 O->OS <<
" record string = '" << Str <<
"'";
967 if (
Error E = decodeMetadataStringsBlob(Indent,
Record, Blob,
O->OS))
970 O->OS <<
" blob data = ";
971 if (
O->ShowBinaryBlobs) {
973 O->OS.write_escaped(Blob,
true) <<
"'";
975 bool BlobIsPrintable =
true;
977 if (!
isPrint(
static_cast<unsigned char>(
C))) {
978 BlobIsPrintable =
false;
983 O->OS <<
"'" << Blob <<
"'";
985 O->OS <<
"unprintable, " << Blob.size() <<
" bytes.";
994 if (
Error Err = Stream.JumpToBit(CurrentRecordPos))
999 return Skipped.takeError();
#define STRINGIFY_CODE(PREFIX, CODE)
static bool canDecodeBlob(unsigned Code, unsigned BlockID)
static std::optional< const char * > GetBlockName(unsigned BlockID, const BitstreamBlockInfo &BlockInfo, CurStreamTypeType CurStreamType)
Return a symbolic block name if known, otherwise return null.
static Expected< CurStreamTypeType > ReadSignature(BitstreamCursor &Stream)
static std::optional< const char * > GetCodeName(unsigned CodeID, unsigned BlockID, const BitstreamBlockInfo &BlockInfo, CurStreamTypeType CurStreamType)
Return a symbolic code name if known, otherwise return null.
static void printSize(raw_ostream &OS, double Bits)
static Expected< CurStreamTypeType > analyzeHeader(std::optional< BCDumpOptions > O, BitstreamCursor &Stream)
static Error reportError(StringRef Message)
Analysis containing CSE Info
#define FUNCTION(NAME, NARG, ROUND_MODE, INTRINSIC)
#define KIND(ENUM, FIELD)
#define ENTRY(ASMNAME, ENUM)
block placement Basic Block Placement Stats
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
static const int BlockSize
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory),...
size_t size() const
size - Get the array size.
BitCodeAbbrevOp - This describes one or more operands in an abbreviation.
BitCodeAbbrev - This class represents an abbreviation record.
unsigned getNumOperandInfos() const
const BitCodeAbbrevOp & getOperandInfo(unsigned N) const
BitcodeAnalyzer(StringRef Buffer, std::optional< StringRef > BlockInfoBuffer=std::nullopt)
Error analyze(std::optional< BCDumpOptions > O=std::nullopt, std::optional< StringRef > CheckHash=std::nullopt)
Analyze the bitcode file.
void printStats(BCDumpOptions O, std::optional< StringRef > Filename=std::nullopt)
Print stats about the bitcode file.
This class maintains the abbreviations read from a block info block.
const BlockInfo * getBlockInfo(unsigned BlockID) const
If there is block info for the specified ID, return it, otherwise return null.
This represents a position within a bitcode file, implemented on top of a SimpleBitstreamCursor.
Error JumpToBit(uint64_t BitNo)
Reset the stream to the specified bit number.
uint64_t GetCurrentBitNo() const
Return the bit # of the bit we are reading.
Expected< unsigned > ReadSubBlockID()
Having read the ENTER_SUBBLOCK code, read the BlockID for the block.
ArrayRef< uint8_t > getBitcodeBytes() const
Expected< word_t > Read(unsigned NumBits)
Expected< BitstreamEntry > advance(unsigned Flags=0)
Advance the current bitstream, returning the next entry in the stream.
Expected< const BitCodeAbbrev * > getAbbrev(unsigned AbbrevID)
Return the abbreviation for the specified AbbrevId.
void setBlockInfo(BitstreamBlockInfo *BI)
Set the block info to be used by this BitstreamCursor to interpret abbreviated records.
const uint8_t * getPointerToByte(uint64_t ByteNo, uint64_t NumBytes)
Get a pointer into the bitstream at the specified byte offset.
Expected< unsigned > readRecord(unsigned AbbrevID, SmallVectorImpl< uint64_t > &Vals, StringRef *Blob=nullptr)
Error EnterSubBlock(unsigned BlockID, unsigned *NumWordsP=nullptr)
Having read the ENTER_SUBBLOCK abbrevid, and enter the block.
@ AF_DontAutoprocessAbbrevs
If this flag is used, abbrev entries are returned just like normal records.
Error SkipBlock()
Having read the ENTER_SUBBLOCK abbrevid and a BlockID, skip over the body of this block.
uint64_t getCurrentByteNo() const
Expected< unsigned > ReadCode()
Expected< std::optional< BitstreamBlockInfo > > ReadBlockInfoBlock(bool ReadBlockInfoNames=false)
Read and return a block info block from the bitstream.
unsigned getAbbrevIDWidth() const
Return the number of bits used to encode an abbrev #.
This class represents an Operation in the Expression.
Lightweight error class with error context and mandatory checking.
static ErrorSuccess success()
Create a success value.
Tagged union holding either a T or a Error.
Error takeError()
Take ownership of the stored error.
reference get()
Returns a reference to the stored T value.
A class that wrap the SHA1 algorithm.
void update(ArrayRef< uint8_t > Data)
Digest more data.
This represents a position within a bitstream.
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
StringRef - Represent a constant reference to a string, i.e.
constexpr bool empty() const
empty - Check if the string is empty.
StringRef drop_front(size_t N=1) const
Return a StringRef equal to 'this' but with the first N elements dropped.
StringRef slice(size_t Start, size_t End) const
Return a reference to the substring from [Start, End).
constexpr const char * data() const
data - Get a pointer to the start of the string (which may not be null terminated).
This class implements an extremely fast bulk output stream that can only output to a stream.
raw_ostream & write_escaped(StringRef Str, bool UseHexEscapes=false)
Output Str, turning '\', '\t', ' ', '"', and anything that doesn't satisfy llvm::isPrint into an esca...
@ C
The default llvm calling convention, compatible with C.
@ BLOCKINFO_CODE_BLOCKNAME
@ BLOCKINFO_CODE_SETRECORDNAME
@ PARAMATTR_GROUP_BLOCK_ID
@ IDENTIFICATION_BLOCK_ID
@ GLOBALVAL_SUMMARY_BLOCK_ID
@ FULL_LTO_GLOBALVAL_SUMMARY_BLOCK_ID
@ OPERAND_BUNDLE_TAGS_BLOCK_ID
@ BLOCKINFO_BLOCK_ID
BLOCKINFO_BLOCK is used to define metadata about blocks, for example, standard abbrevs that should be...
@ FIRST_APPLICATION_BLOCKID
@ DEFINE_ABBREV
DEFINE_ABBREV - Defines an abbrev for the current block.
@ PARAMATTR_CODE_ENTRY_OLD
@ PARAMATTR_GRP_CODE_ENTRY
NodeAddr< CodeNode * > Code
void write32be(void *P, uint32_t V)
uint32_t read32le(const void *P)
This is an optimization pass for GlobalISel generic memory operations.
void stable_sort(R &&Range)
auto size(R &&Range, std::enable_if_t< std::is_base_of< std::random_access_iterator_tag, typename std::iterator_traits< decltype(Range.begin())>::iterator_category >::value, void > *=nullptr)
Get the size of a range.
Error createStringError(std::error_code EC, char const *Fmt, const Ts &... Vals)
Create formatted StringError object.
FormattedNumber format_hex(uint64_t N, unsigned Width, bool Upper=false)
format_hex - Output N as a fixed width hexadecimal.
format_object< Ts... > format(const char *Fmt, const Ts &... Vals)
These are helper functions used to produce formatted output.
CurStreamTypeType
CurStreamTypeType - A type for CurStreamType.
@ ClangSerializedDiagnosticsBitstream
@ ClangSerializedASTBitstream
bool SkipBitcodeWrapperHeader(const unsigned char *&BufPtr, const unsigned char *&BufEnd, bool VerifyBufferSize)
SkipBitcodeWrapperHeader - Some systems wrap bc files with a special header for padding or other reas...
bool isBitcodeWrapper(const unsigned char *BufPtr, const unsigned char *BufEnd)
isBitcodeWrapper - Return true if the given bytes are the magic bytes for an LLVM IR bitcode wrapper.
This contains information emitted to BLOCKINFO_BLOCK blocks.
When advancing through a bitstream cursor, each advance can discover a few different kinds of entries...