dfbd76bda0
Currently there are two serialization modes for bitstream Remarks: standalone and separate. The separate mode splits remark metadata (e.g. the string table) from actual remark data. The metadata is written into the object file by the AsmPrinter, while the remark data is stored in a separate remarks file. This means we can't use bitstream remarks with tools like opt that don't generate an object file. Also, it is confusing to post-process bitstream remarks files, because only the standalone files can be read by llvm-remarkutil. We always need to use dsymutil to convert the separate files to standalone files, which only works for MachO. It is not possible for clang/opt to directly emit bitstream remark files in standalone mode, because the string table can only be serialized after all remarks were emitted. Therefore, this change completely removes the separate serialization mode. Instead, the remark string table is now always written to the end of the remarks file. This requires us to tell the serializer when to finalize remark serialization. This automatically happens when the serializer goes out of scope. However, often the remark file goes out of scope before the serializer is destroyed. To diagnose this, I have added an assert to alert users that they need to explicitly call finalizeLLVMOptimizationRemarks. This change paves the way for further improvements to the remark infrastructure, including more tooling (e.g. #159784), size optimizations for bitstream remarks, and more. Pull Request: https://github.com/llvm/llvm-project/pull/156715
73 lines
2.4 KiB
C++
73 lines
2.4 KiB
C++
//===- llvm/Remarks/RemarkStreamer.cpp - Remark Streamer -*- 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 file contains the implementation of the main remark streamer.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "llvm/Remarks/RemarkStreamer.h"
|
|
#include "llvm/Support/CommandLine.h"
|
|
#include <cassert>
|
|
#include <optional>
|
|
|
|
using namespace llvm;
|
|
using namespace llvm::remarks;
|
|
|
|
static cl::opt<cl::boolOrDefault> EnableRemarksSection(
|
|
"remarks-section",
|
|
cl::desc(
|
|
"Emit a section containing remark diagnostics metadata. By default, "
|
|
"this is enabled for the following formats: bitstream."),
|
|
cl::init(cl::BOU_UNSET), cl::Hidden);
|
|
|
|
RemarkStreamer::RemarkStreamer(
|
|
std::unique_ptr<remarks::RemarkSerializer> RemarkSerializer,
|
|
std::optional<StringRef> FilenameIn)
|
|
: RemarkSerializer(std::move(RemarkSerializer)),
|
|
Filename(FilenameIn ? std::optional<std::string>(FilenameIn->str())
|
|
: std::nullopt) {}
|
|
|
|
RemarkStreamer::~RemarkStreamer() {
|
|
// Ensure that llvm::finalizeOptimizationRemarks was called before the
|
|
// RemarkStreamer is destroyed.
|
|
assert(!RemarkSerializer &&
|
|
"RemarkSerializer must be released before RemarkStreamer is "
|
|
"destroyed. Ensure llvm::finalizeOptimizationRemarks is called.");
|
|
}
|
|
|
|
Error RemarkStreamer::setFilter(StringRef Filter) {
|
|
Regex R = Regex(Filter);
|
|
std::string RegexError;
|
|
if (!R.isValid(RegexError))
|
|
return createStringError(std::make_error_code(std::errc::invalid_argument),
|
|
RegexError.data());
|
|
PassFilter = std::move(R);
|
|
return Error::success();
|
|
}
|
|
|
|
bool RemarkStreamer::matchesFilter(StringRef Str) {
|
|
if (PassFilter)
|
|
return PassFilter->match(Str);
|
|
// No filter means all strings pass.
|
|
return true;
|
|
}
|
|
|
|
bool RemarkStreamer::needsSection() const {
|
|
if (EnableRemarksSection == cl::BOU_TRUE)
|
|
return true;
|
|
|
|
if (EnableRemarksSection == cl::BOU_FALSE)
|
|
return false;
|
|
|
|
assert(EnableRemarksSection == cl::BOU_UNSET);
|
|
|
|
// Enable remark sections by default for bitstream remarks (so dsymutil can
|
|
// find all remarks for a linked binary)
|
|
return RemarkSerializer->SerializerFormat == Format::Bitstream;
|
|
}
|