2019-07-25 00:36:35 +08:00
|
|
|
//===- 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"
|
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 08:13:51 +08:00
|
|
|
#include "llvm/Remarks/BitstreamRemarkSerializer.h"
|
2019-07-25 00:36:35 +08:00
|
|
|
#include "llvm/Remarks/YAMLRemarkSerializer.h"
|
|
|
|
|
|
|
|
using namespace llvm;
|
|
|
|
using namespace llvm::remarks;
|
|
|
|
|
2019-07-25 03:47:57 +08:00
|
|
|
Expected<std::unique_ptr<RemarkSerializer>>
|
2019-07-31 00:01:40 +08:00
|
|
|
remarks::createRemarkSerializer(Format RemarksFormat, SerializerMode Mode,
|
|
|
|
raw_ostream &OS) {
|
2019-07-25 00:36:35 +08:00
|
|
|
switch (RemarksFormat) {
|
|
|
|
case Format::Unknown:
|
|
|
|
return createStringError(std::errc::invalid_argument,
|
|
|
|
"Unknown remark serializer format.");
|
|
|
|
case Format::YAML:
|
2019-08-15 23:54:37 +08:00
|
|
|
return std::make_unique<YAMLRemarkSerializer>(OS, Mode);
|
2019-07-25 00:36:35 +08:00
|
|
|
case Format::YAMLStrTab:
|
2019-08-15 23:54:37 +08:00
|
|
|
return std::make_unique<YAMLStrTabRemarkSerializer>(OS, Mode);
|
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 08:13:51 +08:00
|
|
|
case Format::Bitstream:
|
2019-08-15 23:54:37 +08:00
|
|
|
return std::make_unique<BitstreamRemarkSerializer>(OS, Mode);
|
2019-07-25 00:36:35 +08:00
|
|
|
}
|
|
|
|
llvm_unreachable("Unknown remarks::Format enum");
|
|
|
|
}
|
|
|
|
|
2019-07-25 03:47:57 +08:00
|
|
|
Expected<std::unique_ptr<RemarkSerializer>>
|
2019-07-31 00:01:40 +08:00
|
|
|
remarks::createRemarkSerializer(Format RemarksFormat, SerializerMode Mode,
|
|
|
|
raw_ostream &OS, remarks::StringTable StrTab) {
|
2019-07-25 00:36:35 +08:00
|
|
|
switch (RemarksFormat) {
|
|
|
|
case Format::Unknown:
|
|
|
|
return createStringError(std::errc::invalid_argument,
|
|
|
|
"Unknown remark serializer format.");
|
|
|
|
case Format::YAML:
|
2019-09-17 06:45:17 +08:00
|
|
|
return std::make_unique<YAMLRemarkSerializer>(OS, Mode, std::move(StrTab));
|
2019-07-25 00:36:35 +08:00
|
|
|
case Format::YAMLStrTab:
|
2019-08-15 23:54:37 +08:00
|
|
|
return std::make_unique<YAMLStrTabRemarkSerializer>(OS, Mode,
|
2019-09-17 06:45:17 +08:00
|
|
|
std::move(StrTab));
|
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 08:13:51 +08:00
|
|
|
case Format::Bitstream:
|
2019-08-15 23:54:37 +08:00
|
|
|
return std::make_unique<BitstreamRemarkSerializer>(OS, Mode,
|
2019-09-17 06:45:17 +08:00
|
|
|
std::move(StrTab));
|
2019-07-25 00:36:35 +08:00
|
|
|
}
|
|
|
|
llvm_unreachable("Unknown remarks::Format enum");
|
|
|
|
}
|