LLVM  10.0.0svn
Remark.h
Go to the documentation of this file.
1 //===-- llvm/Remarks/Remark.h - The remark type -----------------*- C++/-*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file defines an abstraction for handling remarks.
10 //
11 //===----------------------------------------------------------------------===//
12
13 #ifndef LLVM_REMARKS_REMARK_H
14 #define LLVM_REMARKS_REMARK_H
15
16 #include "llvm-c/Remarks.h"
21 #include <string>
22
23 namespace llvm {
24 namespace remarks {
25
26 /// The current version of the remark entry.
27 constexpr uint64_t CurrentRemarkVersion = 0;
28
29 /// The debug location used to track a remark back to the source file.
31  /// Absolute path of the source file corresponding to this remark.
33  unsigned SourceLine;
34  unsigned SourceColumn;
35 };
36
37 // Create wrappers for C Binding types (see CBindingWrapping.h).
39
40 /// A key-value pair with a debug location that is used to display the remarks
41 /// at the right place in the source.
42 struct Argument {
44  // FIXME: We might want to be able to store other types than strings here.
46  // If set, the debug location corresponding to the value.
48 };
49
50 // Create wrappers for C Binding types (see CBindingWrapping.h).
52
53 /// The type of the remark.
54 enum class Type {
55  Unknown,
56  Passed,
57  Missed,
58  Analysis,
61  Failure,
62  First = Unknown,
63  Last = Failure
64 };
65
66 /// A remark type used for both emission and parsing.
67 struct Remark {
68  /// The type of the remark.
69  Type RemarkType = Type::Unknown;
70
71  /// Name of the pass that triggers the emission of this remark.
73
74  /// Textual identifier for the remark (single-word, camel-case). Can be used
75  /// by external tools reading the output file for remarks to identify the
76  /// remark.
78
79  /// Mangled name of the function that triggers the emssion of this remark.
81
82  /// The location in the source file of the remark.
84
85  /// If profile information is available, this is the number of times the
86  /// corresponding code was executed in a profile instrumentation run.
88
89  /// Arguments collected via the streaming interface.
91
92  Remark() = default;
93  Remark(Remark &&) = default;
94  Remark &operator=(Remark &&) = default;
95
96  /// Return a message composed from the arguments as a string.
97  std::string getArgsAsMsg() const;
98
99  /// Clone this remark to explicitly ask for a copy.
100  Remark clone() const { return *this; }
101
102 private:
103  /// In order to avoid unwanted copies, "delete" the copy constructor.
104  /// If a copy is needed, it should be done through Remark::clone().
105  Remark(const Remark &) = default;
106  Remark& operator=(const Remark &) = default;
107 };
108
109 // Create wrappers for C Binding types (see CBindingWrapping.h).
111
112 } // end namespace remarks
113 } // end namespace llvm
114
115 #endif /* LLVM_REMARKS_REMARK_H */
This class represents lattice values for constants.
Definition: AllocatorList.h:23
StringRef PassName
Name of the pass that triggers the emission of this remark.
Definition: Remark.h:72
Optional< uint64_t > Hotness
If profile information is available, this is the number of times the corresponding code was executed ...
Definition: Remark.h:87
A remark type used for both emission and parsing.
Definition: Remark.h:67
#define DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref)
StringRef RemarkName
Textual identifier for the remark (single-word, camel-case).
Definition: Remark.h:77
Optional< RemarkLocation > Loc
Definition: Remark.h:47
struct LLVMRemarkOpaqueArg * LLVMRemarkArgRef
Element of the "Args" list.
Definition: Remarks.h:106
Optional< RemarkLocation > Loc
The location in the source file of the remark.
Definition: Remark.h:83
Type
The type of the remark.
Definition: Remark.h:54
struct LLVMRemarkOpaqueDebugLoc * LLVMRemarkDebugLocRef
DebugLoc containing File, Line and Column.
Definition: Remarks.h:75
The debug location used to track a remark back to the source file.
Definition: Remark.h:30
StringRef SourceFilePath
Absolute path of the source file corresponding to this remark.
Definition: Remark.h:32
Remark clone() const
Clone this remark to explicitly ask for a copy.
Definition: Remark.h:100
This is a &#39;vector&#39; (really, a variable-sized array), optimized for the case when the array is small...
Definition: SmallVector.h:837
A key-value pair with a debug location that is used to display the remarks at the right place in the ...
Definition: Remark.h:42
StringRef FunctionName
Mangled name of the function that triggers the emssion of this remark.
Definition: Remark.h:80
SmallVector< Argument, 5 > Args
Arguments collected via the streaming interface.
Definition: Remark.h:90
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:48
constexpr uint64_t CurrentRemarkVersion
The current version of the remark entry.
Definition: Remark.h:27
struct LLVMRemarkOpaqueEntry * LLVMRemarkEntryRef
A remark emitted by the compiler.
Definition: Remarks.h:137