blob: 6211db4a8e96ed54b4efc3b456894d7a7e4dc22b [file] [log] [blame]
//===-- llvm/Remarks/Remark.h - The remark type -----------------*- C++/-*-===//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
// This file defines an abstraction for handling remarks.
#include "llvm-c/Remarks.h"
#include "llvm/ADT/ArrayRef.h"
#include "llvm/ADT/Optional.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/Support/CBindingWrapping.h"
#include <string>
namespace llvm {
namespace remarks {
/// The current version of the remark entry.
constexpr uint64_t CurrentRemarkVersion = 0;
/// The debug location used to track a remark back to the source file.
struct RemarkLocation {
/// Absolute path of the source file corresponding to this remark.
StringRef SourceFilePath;
unsigned SourceLine = 0;
unsigned SourceColumn = 0;
// Create wrappers for C Binding types (see CBindingWrapping.h).
/// A key-value pair with a debug location that is used to display the remarks
/// at the right place in the source.
struct Argument {
StringRef Key;
// FIXME: We might want to be able to store other types than strings here.
StringRef Val;
// If set, the debug location corresponding to the value.
Optional<RemarkLocation> Loc;
// Create wrappers for C Binding types (see CBindingWrapping.h).
/// The type of the remark.
enum class Type {
First = Unknown,
Last = Failure
/// A remark type used for both emission and parsing.
struct Remark {
/// The type of the remark.
Type RemarkType = Type::Unknown;
/// Name of the pass that triggers the emission of this remark.
StringRef PassName;
/// Textual identifier for the remark (single-word, camel-case). Can be used
/// by external tools reading the output file for remarks to identify the
/// remark.
StringRef RemarkName;
/// Mangled name of the function that triggers the emssion of this remark.
StringRef FunctionName;
/// The location in the source file of the remark.
Optional<RemarkLocation> Loc;
/// If profile information is available, this is the number of times the
/// corresponding code was executed in a profile instrumentation run.
Optional<uint64_t> Hotness;
/// Arguments collected via the streaming interface.
SmallVector<Argument, 5> Args;
Remark() = default;
Remark(Remark &&) = default;
Remark &operator=(Remark &&) = default;
/// Return a message composed from the arguments as a string.
std::string getArgsAsMsg() const;
/// Clone this remark to explicitly ask for a copy.
Remark clone() const { return *this; }
/// In order to avoid unwanted copies, "delete" the copy constructor.
/// If a copy is needed, it should be done through `Remark::clone()`.
Remark(const Remark &) = default;
Remark& operator=(const Remark &) = default;
// Create wrappers for C Binding types (see CBindingWrapping.h).
/// Comparison operators for Remark objects and dependent objects.
template <typename T>
bool operator<(const Optional<T> &LHS, const Optional<T> &RHS) {
// Sorting based on optionals should result in all `None` entries to appear
// before the valid entries. For example, remarks with no debug location will
// appear first.
if (!LHS && !RHS)
return false;
if (!LHS && RHS)
return true;
if (LHS && !RHS)
return false;
return *LHS < *RHS;
inline bool operator==(const RemarkLocation &LHS, const RemarkLocation &RHS) {
return LHS.SourceFilePath == RHS.SourceFilePath &&
LHS.SourceLine == RHS.SourceLine &&
LHS.SourceColumn == RHS.SourceColumn;
inline bool operator!=(const RemarkLocation &LHS, const RemarkLocation &RHS) {
return !(LHS == RHS);
inline bool operator<(const RemarkLocation &LHS, const RemarkLocation &RHS) {
return std::make_tuple(LHS.SourceFilePath, LHS.SourceLine, LHS.SourceColumn) <
std::make_tuple(RHS.SourceFilePath, RHS.SourceLine, RHS.SourceColumn);
inline bool operator==(const Argument &LHS, const Argument &RHS) {
return LHS.Key == RHS.Key && LHS.Val == RHS.Val && LHS.Loc == RHS.Loc;
inline bool operator!=(const Argument &LHS, const Argument &RHS) {
return !(LHS == RHS);
inline bool operator<(const Argument &LHS, const Argument &RHS) {
return std::make_tuple(LHS.Key, LHS.Val, LHS.Loc) <
std::make_tuple(RHS.Key, RHS.Val, RHS.Loc);
inline bool operator==(const Remark &LHS, const Remark &RHS) {
return LHS.RemarkType == RHS.RemarkType && LHS.PassName == RHS.PassName &&
LHS.RemarkName == RHS.RemarkName &&
LHS.FunctionName == RHS.FunctionName && LHS.Loc == RHS.Loc &&
LHS.Hotness == RHS.Hotness && LHS.Args == RHS.Args;
inline bool operator!=(const Remark &LHS, const Remark &RHS) {
return !(LHS == RHS);
inline bool operator<(const Remark &LHS, const Remark &RHS) {
return std::make_tuple(LHS.RemarkType, LHS.PassName, LHS.RemarkName,
LHS.FunctionName, LHS.Loc, LHS.Hotness, LHS.Args) <
std::make_tuple(RHS.RemarkType, RHS.PassName, RHS.RemarkName,
RHS.FunctionName, RHS.Loc, RHS.Hotness, RHS.Args);
} // end namespace remarks
} // end namespace llvm