1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
|
#pragma once
#ifdef __GNUC__
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wunused-parameter"
#endif
//===-- llvm/Remarks/Remark.h - The remark type -----------------*- 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 defines an abstraction for handling remarks.
//
//===----------------------------------------------------------------------===//
#ifndef LLVM_REMARKS_REMARK_H
#define LLVM_REMARKS_REMARK_H
#include "llvm-c/Remarks.h"
#include "llvm/ADT/SmallVector.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/Support/CBindingWrapping.h"
#include <optional>
#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).
DEFINE_SIMPLE_CONVERSION_FUNCTIONS(RemarkLocation, LLVMRemarkDebugLocRef)
/// 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.
std::optional<RemarkLocation> Loc;
};
// Create wrappers for C Binding types (see CBindingWrapping.h).
DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Argument, LLVMRemarkArgRef)
/// The type of the remark.
enum class Type {
Unknown,
Passed,
Missed,
Analysis,
AnalysisFPCommute,
AnalysisAliasing,
Failure,
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.
std::optional<RemarkLocation> Loc;
/// If profile information is available, this is the number of times the
/// corresponding code was executed in a profile instrumentation run.
std::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; }
private:
/// 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).
DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Remark, LLVMRemarkEntryRef)
/// Comparison operators for Remark objects and dependent objects.
template <typename T>
bool operator<(const std::optional<T> &LHS, const std::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
#endif /* LLVM_REMARKS_REMARK_H */
#ifdef __GNUC__
#pragma GCC diagnostic pop
#endif
|
