LLVM  9.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.
4 // See https://llvm.org/LICENSE.txt for license information.
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"
17 #include "llvm/ADT/ArrayRef.h"
18 #include "llvm/ADT/Optional.h"
19 #include "llvm/ADT/StringRef.h"
21 #include <string>
22 
23 namespace llvm {
24 namespace remarks {
25 
26 constexpr uint64_t Version = 0;
27 constexpr StringRef Magic("REMARKS", 7);
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  LastTypeValue = Failure
63 };
64 
65 /// A remark type used for both emission and parsing.
66 struct Remark {
67  /// The type of the remark.
68  Type RemarkType = Type::Unknown;
69 
70  /// Name of the pass that triggers the emission of this remark.
72 
73  /// Textual identifier for the remark (single-word, camel-case). Can be used
74  /// by external tools reading the output file for remarks to identify the
75  /// remark.
77 
78  /// Mangled name of the function that triggers the emssion of this remark.
80 
81  /// The location in the source file of the remark.
83 
84  /// If profile information is available, this is the number of times the
85  /// corresponding code was executed in a profile instrumentation run.
87 
88  /// Arguments collected via the streaming interface.
90 
91  /// Return a message composed from the arguments as a string.
92  std::string getArgsAsMsg() const;
93 };
94 
95 // Create wrappers for C Binding types (see CBindingWrapping.h).
97 
98 } // end namespace remarks
99 } // end namespace llvm
100 
101 #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:71
Optional< uint64_t > Hotness
If profile information is available, this is the number of times the corresponding code was executed ...
Definition: Remark.h:86
constexpr uint64_t Version
Definition: Remark.h:26
A remark type used for both emission and parsing.
Definition: Remark.h:66
#define DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref)
StringRef RemarkName
Textual identifier for the remark (single-word, camel-case).
Definition: Remark.h:76
Optional< RemarkLocation > Loc
Definition: Remark.h:47
struct LLVMRemarkOpaqueArg * LLVMRemarkArgRef
Element of the "Args" list.
Definition: Remarks.h:106
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory)...
Definition: APInt.h:32
Optional< RemarkLocation > Loc
The location in the source file of the remark.
Definition: Remark.h:82
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
ArrayRef< Argument > Args
Arguments collected via the streaming interface.
Definition: Remark.h:89
constexpr StringRef Magic("REMARKS", 7)
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:79
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:48
struct LLVMRemarkOpaqueEntry * LLVMRemarkEntryRef
A remark emitted by the compiler.
Definition: Remarks.h:137