1
0
mirror of https://github.com/RPCS3/llvm-mirror.git synced 2024-11-22 18:54:02 +01:00
llvm-mirror/include/llvm/Bitcode/BitcodeAnalyzer.h
Francis Visoiu Mistrih 75722a7d1f Reland: [Remarks] Add an LLVM-bitstream-based remark serializer
Add a new serializer, using a binary format based on the LLVM bitstream
format.

This format provides a way to serialize the remarks in two modes:

1) Separate mode: the metadata is separate from the remark entries.
2) Standalone mode: the metadata and the remark entries are in the same
file.

The format contains:

* a meta block: container version, container type, string table,
external file path, remark version
* a remark block: type, remark name, pass name, function name, debug
file, debug line, debug column, hotness, arguments (key, value, debug
file, debug line, debug column)

A string table is required for this format, which will be dumped in the
meta block to be consumed before parsing the remark blocks.

On clang itself, we noticed a size reduction of 13.4x compared to YAML,
and a compile-time reduction of between 1.7% and 3.5% on CTMark.

Differential Revision: https://reviews.llvm.org/D63466

Original llvm-svn: 367364
Revert llvm-svn: 367370

llvm-svn: 367372
2019-07-31 00:13:51 +00:00

105 lines
3.4 KiB
C++

//===- llvm/Bitcode/BitcodeAnalyzer.h - Bitcode analyzer --------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
// This header defines interfaces to analyze LLVM bitcode files/streams.
//
//===----------------------------------------------------------------------===//
#ifndef LLVM_BITCODE_BITCODE_ANALYZER_H
#define LLVM_BITCODE_BITCODE_ANALYZER_H
#include "llvm/ADT/ArrayRef.h"
#include "llvm/ADT/Optional.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/Bitstream/BitstreamReader.h"
#include "llvm/Support/Error.h"
#include "llvm/Support/raw_ostream.h"
#include <map>
#include <vector>
namespace llvm {
/// CurStreamTypeType - A type for CurStreamType
enum CurStreamTypeType {
UnknownBitstream,
LLVMIRBitstream,
ClangSerializedASTBitstream,
ClangSerializedDiagnosticsBitstream,
LLVMBitstreamRemarks
};
struct BCDumpOptions {
/// The stream.
raw_ostream &OS;
/// Print per-code histogram.
bool Histogram = false;
/// Don't emit numeric info in dump if symbolic info is available.
bool Symbolic = false;
/// Print binary blobs using hex escapes.
bool ShowBinaryBlobs = false;
BCDumpOptions(raw_ostream &OS) : OS(OS) {}
};
class BitcodeAnalyzer {
BitstreamCursor Stream;
BitstreamBlockInfo BlockInfo;
CurStreamTypeType CurStreamType;
Optional<BitstreamCursor> BlockInfoStream;
unsigned NumTopBlocks = 0;
struct PerRecordStats {
unsigned NumInstances;
unsigned NumAbbrev;
uint64_t TotalBits;
PerRecordStats() : NumInstances(0), NumAbbrev(0), TotalBits(0) {}
};
struct 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) {}
};
std::map<unsigned, PerBlockIDStats> BlockIDStats;
public:
BitcodeAnalyzer(StringRef Buffer, Optional<StringRef> BlockInfoBuffer = None);
/// Analyze the bitcode file.
Error analyze(Optional<BCDumpOptions> O = None,
Optional<StringRef> CheckHash = None);
/// Print stats about the bitcode file.
void printStats(BCDumpOptions O, Optional<StringRef> Filename = None);
private:
/// Read a block, updating statistics, etc.
Error parseBlock(unsigned BlockID, unsigned IndentLevel,
Optional<BCDumpOptions> O = None,
Optional<StringRef> CheckHash = None);
Error decodeMetadataStringsBlob(StringRef Indent, ArrayRef<uint64_t> Record,
StringRef Blob, raw_ostream &OS);
};
} // end namespace llvm
#endif // LLVM_BITCODE_BITCODE_ANALYZER_H