Background: The yaml-strtab format looks just like the yaml format, except that the values in the key/value pairs of the remarks are deduplicated and replaced by indices into a string table (see removed test cases for examples). The motivation behind this format was to reduce size of the remarks files. However, it was quickly superseded by the bitstream format. Therefore, remove the yaml-strtab format, as it doesn't have a good usecase anymore: - It isn't particularly efficient - It isn't human-readable - It isn't straightforward to parse in external tools that can't use the remarks library. We don't even support it in opt-viewer. llvm-remarkutil is also missing options to parse/convert yaml-strtab, so the chance that anyone is actually using this format is low.
48 lines
1.8 KiB
C++
48 lines
1.8 KiB
C++
//===- RemarkFormat.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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// Implementation of utilities to handle the different remark formats.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "llvm/Remarks/RemarkFormat.h"
|
|
#include "llvm/ADT/StringSwitch.h"
|
|
#include "llvm/Remarks/BitstreamRemarkContainer.h"
|
|
|
|
using namespace llvm;
|
|
using namespace llvm::remarks;
|
|
|
|
Expected<Format> llvm::remarks::parseFormat(StringRef FormatStr) {
|
|
auto Result = StringSwitch<Format>(FormatStr)
|
|
.Cases("", "yaml", Format::YAML)
|
|
.Case("bitstream", Format::Bitstream)
|
|
.Default(Format::Unknown);
|
|
|
|
if (Result == Format::Unknown)
|
|
return createStringError(std::make_error_code(std::errc::invalid_argument),
|
|
"Unknown remark format: '%s'",
|
|
FormatStr.data());
|
|
|
|
return Result;
|
|
}
|
|
|
|
Expected<Format> llvm::remarks::magicToFormat(StringRef MagicStr) {
|
|
auto Result =
|
|
StringSwitch<Format>(MagicStr)
|
|
.StartsWith("--- ", Format::YAML) // This is only an assumption.
|
|
.StartsWith(remarks::Magic,
|
|
Format::YAML) // Needed for remark meta section
|
|
.StartsWith(remarks::ContainerMagic, Format::Bitstream)
|
|
.Default(Format::Unknown);
|
|
|
|
if (Result == Format::Unknown)
|
|
return createStringError(std::make_error_code(std::errc::invalid_argument),
|
|
"Unknown remark magic: '%s'", MagicStr.data());
|
|
return Result;
|
|
}
|