LLVM 20.0.0git
Error.cpp
Go to the documentation of this file.
1//===- Error.cpp - tblgen error handling helper routines --------*- 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 contains error handling helper routines to pretty-print diagnostic
10// messages from tblgen.
11//
12//===----------------------------------------------------------------------===//
13
14#include "llvm/ADT/Twine.h"
18#include "llvm/TableGen/Error.h"
20#include <cstdlib>
21
22namespace llvm {
23
25unsigned ErrorsPrinted = 0;
26
28 const Twine &Msg) {
29 // Count the total number of errors printed.
30 // This is used to exit with an error code if there were any errors.
31 if (Kind == SourceMgr::DK_Error)
33
34 SMLoc NullLoc;
35 if (Loc.empty())
36 Loc = NullLoc;
37 SrcMgr.PrintMessage(Loc.front(), Kind, Msg);
38 for (unsigned i = 1; i < Loc.size(); ++i)
40 "instantiated from multiclass");
41}
42
43// Functions to print notes.
44
45void PrintNote(const Twine &Msg) {
46 WithColor::note() << Msg << "\n";
47}
48
49void PrintNote(ArrayRef<SMLoc> NoteLoc, const Twine &Msg) {
50 PrintMessage(NoteLoc, SourceMgr::DK_Note, Msg);
51}
52
53// Functions to print fatal notes.
54
55void PrintFatalNote(const Twine &Msg) {
56 PrintNote(Msg);
57 // The following call runs the file cleanup handlers.
59 std::exit(1);
60}
61
62void PrintFatalNote(ArrayRef<SMLoc> NoteLoc, const Twine &Msg) {
63 PrintNote(NoteLoc, Msg);
64 // The following call runs the file cleanup handlers.
66 std::exit(1);
67}
68
69// This method takes a Record and uses the source location
70// stored in it.
71void PrintFatalNote(const Record *Rec, const Twine &Msg) {
72 PrintNote(Rec->getLoc(), Msg);
73 // The following call runs the file cleanup handlers.
75 std::exit(1);
76}
77
78// This method takes a RecordVal and uses the source location
79// stored in it.
80void PrintFatalNote(const RecordVal *RecVal, const Twine &Msg) {
81 PrintNote(RecVal->getLoc(), Msg);
82 // The following call runs the file cleanup handlers.
84 std::exit(1);
85}
86
87// Functions to print warnings.
88
89void PrintWarning(const Twine &Msg) { WithColor::warning() << Msg << "\n"; }
90
91void PrintWarning(ArrayRef<SMLoc> WarningLoc, const Twine &Msg) {
92 PrintMessage(WarningLoc, SourceMgr::DK_Warning, Msg);
93}
94
95void PrintWarning(const char *Loc, const Twine &Msg) {
97}
98
99// Functions to print errors.
100
101void PrintError(const Twine &Msg) { WithColor::error() << Msg << "\n"; }
102
103void PrintError(ArrayRef<SMLoc> ErrorLoc, const Twine &Msg) {
104 PrintMessage(ErrorLoc, SourceMgr::DK_Error, Msg);
105}
106
107void PrintError(const char *Loc, const Twine &Msg) {
109}
110
111// This method takes a Record and uses the source location
112// stored in it.
113void PrintError(const Record *Rec, const Twine &Msg) {
115}
116
117// This method takes a RecordVal and uses the source location
118// stored in it.
119void PrintError(const RecordVal *RecVal, const Twine &Msg) {
120 PrintMessage(RecVal->getLoc(), SourceMgr::DK_Error, Msg);
121}
122
123// Functions to print fatal errors.
124
125void PrintFatalError(const Twine &Msg) {
126 PrintError(Msg);
127 // The following call runs the file cleanup handlers.
129 std::exit(1);
130}
131
132void PrintFatalError(ArrayRef<SMLoc> ErrorLoc, const Twine &Msg) {
133 PrintError(ErrorLoc, Msg);
134 // The following call runs the file cleanup handlers.
136 std::exit(1);
137}
138
139// This method takes a Record and uses the source location
140// stored in it.
141void PrintFatalError(const Record *Rec, const Twine &Msg) {
142 PrintError(Rec->getLoc(), Msg);
143 // The following call runs the file cleanup handlers.
145 std::exit(1);
146}
147
148// This method takes a RecordVal and uses the source location
149// stored in it.
150void PrintFatalError(const RecordVal *RecVal, const Twine &Msg) {
151 PrintError(RecVal->getLoc(), Msg);
152 // The following call runs the file cleanup handlers.
154 std::exit(1);
155}
156
157// Check an assertion: Obtain the condition value and be sure it is true.
158// If not, print a nonfatal error along with the message.
159void CheckAssert(SMLoc Loc, Init *Condition, Init *Message) {
160 auto *CondValue = dyn_cast_or_null<IntInit>(Condition->convertInitializerTo(
161 IntRecTy::get(Condition->getRecordKeeper())));
162 if (!CondValue)
163 PrintError(Loc, "assert condition must of type bit, bits, or int.");
164 else if (!CondValue->getValue()) {
165 PrintError(Loc, "assertion failed");
166 if (auto *MessageInit = dyn_cast<StringInit>(Message))
167 PrintNote(MessageInit->getValue());
168 else
169 PrintNote("(assert message is not a string)");
170 }
171}
172
173// Dump a message to stderr.
174void dumpMessage(SMLoc Loc, Init *Message) {
175 auto *MessageInit = dyn_cast<StringInit>(Message);
176 assert(MessageInit && "no debug message to print");
177 PrintNote(Loc, MessageInit->getValue());
178}
179
180} // end namespace llvm
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory),...
Definition: ArrayRef.h:41
const T & front() const
front - Get the first element.
Definition: ArrayRef.h:168
size_t size() const
size - Get the array size.
Definition: ArrayRef.h:165
bool empty() const
empty - Check if the array is empty.
Definition: ArrayRef.h:160
RecordKeeper & getRecordKeeper() const
Get the record keeper that initialized this Init.
Definition: Record.cpp:349
virtual Init * convertInitializerTo(RecTy *Ty) const =0
Convert to a value whose type is Ty, or return null if this is not possible.
static IntRecTy * get(RecordKeeper &RK)
Definition: Record.cpp:153
This class represents a field in a record, including its name, type, value, and source location.
Definition: Record.h:1543
const SMLoc & getLoc() const
Get the source location of the point where the field was defined.
Definition: Record.h:1582
ArrayRef< SMLoc > getLoc() const
Definition: Record.h:1723
Represents a location in source code.
Definition: SMLoc.h:23
static SMLoc getFromPointer(const char *Ptr)
Definition: SMLoc.h:36
This owns the files read by a parser, handles include stacks, and handles diagnostic wrangling.
Definition: SourceMgr.h:31
void PrintMessage(raw_ostream &OS, SMLoc Loc, DiagKind Kind, const Twine &Msg, ArrayRef< SMRange > Ranges={}, ArrayRef< SMFixIt > FixIts={}, bool ShowColors=true) const
Emit a message about the specified location with the specified string.
Definition: SourceMgr.cpp:352
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
Definition: Twine.h:81
static raw_ostream & warning()
Convenience method for printing "warning: " to stderr.
Definition: WithColor.cpp:85
static raw_ostream & error()
Convenience method for printing "error: " to stderr.
Definition: WithColor.cpp:83
static raw_ostream & note()
Convenience method for printing "note: " to stderr.
Definition: WithColor.cpp:87
void RunInterruptHandlers()
This function runs all the registered interrupt handlers, including the removal of files registered b...
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
unsigned ErrorsPrinted
Definition: Error.cpp:25
void PrintFatalError(const Twine &Msg)
Definition: Error.cpp:125
void PrintError(const Twine &Msg)
Definition: Error.cpp:101
SourceMgr SrcMgr
Definition: Error.cpp:24
void PrintWarning(const Twine &Msg)
Definition: Error.cpp:89
void CheckAssert(SMLoc Loc, Init *Condition, Init *Message)
Definition: Error.cpp:159
static void PrintMessage(ArrayRef< SMLoc > Loc, SourceMgr::DiagKind Kind, const Twine &Msg)
Definition: Error.cpp:27
void dumpMessage(SMLoc Loc, Init *Message)
Definition: Error.cpp:174
void PrintNote(const Twine &Msg)
Definition: Error.cpp:45
void PrintFatalNote(const Twine &Msg)
Definition: Error.cpp:55