llvm-project/llvm/tools/llvm-remarkutil/RemarkUtilHelpers.h
Zain Jaffal 30d8e0837d [RemarkUtil] Refactor remarkutil tool to use a command registry.
In preperation to move all remark utilities into one tool. We use
command registry to breakdown each utility into a separate file.

For now we have 3 utilities for remarks
1. Convert: which is responsible for converting yaml remarks to
   bitstream and vice-versa
2. Count: Analyse remarks and report count. This currently only supports
   asm-remarks and annotation-summary remarks.
3. Diff remarks: Currently we only have a diff for size remarks using
   `llvm-remark-size-diff`

The first two utilites have been simplified and seperated into two
files. The following commit will move `llvm-remark-size-diff` and fold
it to be inside `llvm-remarkutil` as a subcommand

Differential Revision: https://reviews.llvm.org/D156416
2023-07-28 09:21:29 +01:00

60 lines
2.9 KiB
C++

//===- RemarkUtilHelpers.h ------------------------------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//
//
// Helpers for remark utilites
//
//===----------------------------------------------------------------------===//
#include "llvm-c/Remarks.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/Remarks/Remark.h"
#include "llvm/Remarks/RemarkFormat.h"
#include "llvm/Remarks/RemarkParser.h"
#include "llvm/Remarks/YAMLRemarkSerializer.h"
#include "llvm/Support/Error.h"
#include "llvm/Support/FileSystem.h"
#include "llvm/Support/MemoryBuffer.h"
#include "llvm/Support/ToolOutputFile.h"
// Keep input + output help + names consistent across the various modes via a
// hideous macro.
#define INPUT_OUTPUT_COMMAND_LINE_OPTIONS(SUBOPT) \
static cl::opt<std::string> InputFileName(cl::Positional, cl::init("-"), \
cl::desc("<input file>"), \
cl::sub(SUBOPT)); \
static cl::opt<std::string> OutputFileName( \
"o", cl::init("-"), cl::desc("Output"), cl::value_desc("filename"), \
cl::sub(SUBOPT));
// Keep Input format and names consistent accross the modes via a macro.
#define INPUT_FORMAT_COMMAND_LINE_OPTIONS(SUBOPT) \
static cl::opt<Format> InputFormat( \
"parser", cl::desc("Input remark format to parse"), \
cl::values(clEnumValN(Format::YAML, "yaml", "YAML"), \
clEnumValN(Format::Bitstream, "bitstream", "Bitstream")), \
cl::sub(SUBOPT));
#define DEBUG_LOC_INFO_COMMAND_LINE_OPTIONS(SUBOPT) \
static cl::opt<bool> UseDebugLoc( \
"use-debug-loc", \
cl::desc( \
"Add debug loc information when generating tables for " \
"functions. The loc is represented as (path:line number:column " \
"number)"), \
cl::init(false), cl::sub(SUBOPT));
namespace llvm {
namespace remarks {
Expected<std::unique_ptr<MemoryBuffer>>
getInputMemoryBuffer(StringRef InputFileName);
Expected<std::unique_ptr<ToolOutputFile>>
getOutputFileWithFlags(StringRef OutputFileName, sys::fs::OpenFlags Flags);
Expected<std::unique_ptr<ToolOutputFile>>
getOutputFileForRemarks(StringRef OutputFileName, Format OutputFormat);
} // namespace remarks
} // namespace llvm