84e80979b5
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
57 lines
2.3 KiB
C++
57 lines
2.3 KiB
C++
//===- RemarkSerializer.cpp -----------------------------------------------===//
|
|
//
|
|
// 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 file provides tools for serializing remarks.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "llvm/Remarks/RemarkSerializer.h"
|
|
#include "llvm/Remarks/BitstreamRemarkSerializer.h"
|
|
#include "llvm/Remarks/YAMLRemarkSerializer.h"
|
|
|
|
using namespace llvm;
|
|
using namespace llvm::remarks;
|
|
|
|
Expected<std::unique_ptr<RemarkSerializer>>
|
|
remarks::createRemarkSerializer(Format RemarksFormat, SerializerMode Mode,
|
|
raw_ostream &OS) {
|
|
switch (RemarksFormat) {
|
|
case Format::Unknown:
|
|
return createStringError(std::errc::invalid_argument,
|
|
"Unknown remark serializer format.");
|
|
case Format::YAML:
|
|
return llvm::make_unique<YAMLRemarkSerializer>(OS, Mode);
|
|
case Format::YAMLStrTab:
|
|
return llvm::make_unique<YAMLStrTabRemarkSerializer>(OS, Mode);
|
|
case Format::Bitstream:
|
|
return llvm::make_unique<BitstreamRemarkSerializer>(OS, Mode);
|
|
}
|
|
llvm_unreachable("Unknown remarks::Format enum");
|
|
}
|
|
|
|
Expected<std::unique_ptr<RemarkSerializer>>
|
|
remarks::createRemarkSerializer(Format RemarksFormat, SerializerMode Mode,
|
|
raw_ostream &OS, remarks::StringTable StrTab) {
|
|
switch (RemarksFormat) {
|
|
case Format::Unknown:
|
|
return createStringError(std::errc::invalid_argument,
|
|
"Unknown remark serializer format.");
|
|
case Format::YAML:
|
|
return createStringError(std::errc::invalid_argument,
|
|
"Unable to use a string table with the yaml "
|
|
"format. Use 'yaml-strtab' instead.");
|
|
case Format::YAMLStrTab:
|
|
return llvm::make_unique<YAMLStrTabRemarkSerializer>(OS, Mode,
|
|
std::move(StrTab));
|
|
case Format::Bitstream:
|
|
return llvm::make_unique<BitstreamRemarkSerializer>(OS, Mode,
|
|
std::move(StrTab));
|
|
}
|
|
llvm_unreachable("Unknown remarks::Format enum");
|
|
}
|