1 //===- llvm/IR/DiagnosticInfo.h - Diagnostic Declaration --------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file declares the different classes involved in low level diagnostics.
12 // Diagnostics reporting is still done as part of the LLVMContext.
13 //===----------------------------------------------------------------------===//
15 #ifndef LLVM_IR_DIAGNOSTICINFO_H
16 #define LLVM_IR_DIAGNOSTICINFO_H
18 #include "llvm-c/Types.h"
19 #include "llvm/ADT/Optional.h"
20 #include "llvm/ADT/SmallVector.h"
21 #include "llvm/ADT/StringRef.h"
22 #include "llvm/ADT/Twine.h"
23 #include "llvm/IR/DebugLoc.h"
24 #include "llvm/Support/CBindingWrapping.h"
25 #include "llvm/Support/YAMLTraits.h"
34 // Forward declarations.
35 class DiagnosticPrinter;
42 /// \brief Defines the different supported severity of a diagnostic.
43 enum DiagnosticSeverity : char {
47 // A note attaches additional information to one of the previous diagnostic
52 /// \brief Defines the different supported kind of a diagnostic.
53 /// This enum should be extended with a new ID for each added concrete subclass.
59 DK_DebugMetadataVersion,
60 DK_DebugMetadataInvalid,
63 DK_OptimizationRemark,
64 DK_OptimizationRemarkMissed,
65 DK_OptimizationRemarkAnalysis,
66 DK_OptimizationRemarkAnalysisFPCommute,
67 DK_OptimizationRemarkAnalysisAliasing,
68 DK_OptimizationFailure,
69 DK_FirstRemark = DK_OptimizationRemark,
70 DK_LastRemark = DK_OptimizationFailure,
71 DK_MachineOptimizationRemark,
72 DK_MachineOptimizationRemarkMissed,
73 DK_MachineOptimizationRemarkAnalysis,
74 DK_FirstMachineRemark = DK_MachineOptimizationRemark,
75 DK_LastMachineRemark = DK_MachineOptimizationRemarkAnalysis,
82 /// \brief Get the next available kind ID for a plugin diagnostic.
83 /// Each time this function is called, it returns a different number.
84 /// Therefore, a plugin that wants to "identify" its own classes
85 /// with a dynamic identifier, just have to use this method to get a new ID
86 /// and assign it to each of its classes.
87 /// The returned ID will be greater than or equal to DK_FirstPluginKind.
88 /// Thus, the plugin identifiers will not conflict with the
89 /// DiagnosticKind values.
90 int getNextAvailablePluginDiagnosticKind();
92 /// \brief This is the base abstract class for diagnostic reporting in
94 /// The print method must be overloaded by the subclasses to print a
95 /// user-friendly message in the client of the backend (let us call it a
97 class DiagnosticInfo {
99 /// Kind defines the kind of report this is about.
100 const /* DiagnosticKind */ int Kind;
101 /// Severity gives the severity of the diagnostic.
102 const DiagnosticSeverity Severity;
105 DiagnosticInfo(/* DiagnosticKind */ int Kind, DiagnosticSeverity Severity)
106 : Kind(Kind), Severity(Severity) {}
108 virtual ~DiagnosticInfo() = default;
110 /* DiagnosticKind */ int getKind() const { return Kind; }
111 DiagnosticSeverity getSeverity() const { return Severity; }
113 /// Print using the given \p DP a user-friendly message.
114 /// This is the default message that will be printed to the user.
115 /// It is used when the frontend does not directly take advantage
116 /// of the information contained in fields of the subclasses.
117 /// The printed message must not end with '.' nor start with a severity
119 virtual void print(DiagnosticPrinter &DP) const = 0;
122 using DiagnosticHandlerFunction = std::function<void(const DiagnosticInfo &)>;
124 /// Diagnostic information for inline asm reporting.
125 /// This is basically a message and an optional location.
126 class DiagnosticInfoInlineAsm : public DiagnosticInfo {
128 /// Optional line information. 0 if not set.
129 unsigned LocCookie = 0;
130 /// Message to be reported.
132 /// Optional origin of the problem.
133 const Instruction *Instr = nullptr;
136 /// \p MsgStr is the message to be reported to the frontend.
137 /// This class does not copy \p MsgStr, therefore the reference must be valid
138 /// for the whole life time of the Diagnostic.
139 DiagnosticInfoInlineAsm(const Twine &MsgStr,
140 DiagnosticSeverity Severity = DS_Error)
141 : DiagnosticInfo(DK_InlineAsm, Severity), MsgStr(MsgStr) {}
143 /// \p LocCookie if non-zero gives the line number for this report.
144 /// \p MsgStr gives the message.
145 /// This class does not copy \p MsgStr, therefore the reference must be valid
146 /// for the whole life time of the Diagnostic.
147 DiagnosticInfoInlineAsm(unsigned LocCookie, const Twine &MsgStr,
148 DiagnosticSeverity Severity = DS_Error)
149 : DiagnosticInfo(DK_InlineAsm, Severity), LocCookie(LocCookie),
152 /// \p Instr gives the original instruction that triggered the diagnostic.
153 /// \p MsgStr gives the message.
154 /// This class does not copy \p MsgStr, therefore the reference must be valid
155 /// for the whole life time of the Diagnostic.
157 DiagnosticInfoInlineAsm(const Instruction &I, const Twine &MsgStr,
158 DiagnosticSeverity Severity = DS_Error);
160 unsigned getLocCookie() const { return LocCookie; }
161 const Twine &getMsgStr() const { return MsgStr; }
162 const Instruction *getInstruction() const { return Instr; }
164 /// \see DiagnosticInfo::print.
165 void print(DiagnosticPrinter &DP) const override;
167 static bool classof(const DiagnosticInfo *DI) {
168 return DI->getKind() == DK_InlineAsm;
172 /// Diagnostic information for stack size etc. reporting.
173 /// This is basically a function and a size.
174 class DiagnosticInfoResourceLimit : public DiagnosticInfo {
176 /// The function that is concerned by this resource limit diagnostic.
179 /// Description of the resource type (e.g. stack size)
180 const char *ResourceName;
182 /// The computed size usage
183 uint64_t ResourceSize;
186 uint64_t ResourceLimit;
189 /// \p The function that is concerned by this stack size diagnostic.
190 /// \p The computed stack size.
191 DiagnosticInfoResourceLimit(const Function &Fn, const char *ResourceName,
192 uint64_t ResourceSize,
193 DiagnosticSeverity Severity = DS_Warning,
194 DiagnosticKind Kind = DK_ResourceLimit,
195 uint64_t ResourceLimit = 0)
196 : DiagnosticInfo(Kind, Severity), Fn(Fn), ResourceName(ResourceName),
197 ResourceSize(ResourceSize), ResourceLimit(ResourceLimit) {}
199 const Function &getFunction() const { return Fn; }
200 const char *getResourceName() const { return ResourceName; }
201 uint64_t getResourceSize() const { return ResourceSize; }
202 uint64_t getResourceLimit() const { return ResourceLimit; }
204 /// \see DiagnosticInfo::print.
205 void print(DiagnosticPrinter &DP) const override;
207 static bool classof(const DiagnosticInfo *DI) {
208 return DI->getKind() == DK_ResourceLimit || DI->getKind() == DK_StackSize;
212 class DiagnosticInfoStackSize : public DiagnosticInfoResourceLimit {
214 DiagnosticInfoStackSize(const Function &Fn, uint64_t StackSize,
215 DiagnosticSeverity Severity = DS_Warning,
216 uint64_t StackLimit = 0)
217 : DiagnosticInfoResourceLimit(Fn, "stack size", StackSize, Severity,
218 DK_StackSize, StackLimit) {}
220 uint64_t getStackSize() const { return getResourceSize(); }
221 uint64_t getStackLimit() const { return getResourceLimit(); }
223 static bool classof(const DiagnosticInfo *DI) {
224 return DI->getKind() == DK_StackSize;
228 /// Diagnostic information for debug metadata version reporting.
229 /// This is basically a module and a version.
230 class DiagnosticInfoDebugMetadataVersion : public DiagnosticInfo {
232 /// The module that is concerned by this debug metadata version diagnostic.
234 /// The actual metadata version.
235 unsigned MetadataVersion;
238 /// \p The module that is concerned by this debug metadata version diagnostic.
239 /// \p The actual metadata version.
240 DiagnosticInfoDebugMetadataVersion(const Module &M, unsigned MetadataVersion,
241 DiagnosticSeverity Severity = DS_Warning)
242 : DiagnosticInfo(DK_DebugMetadataVersion, Severity), M(M),
243 MetadataVersion(MetadataVersion) {}
245 const Module &getModule() const { return M; }
246 unsigned getMetadataVersion() const { return MetadataVersion; }
248 /// \see DiagnosticInfo::print.
249 void print(DiagnosticPrinter &DP) const override;
251 static bool classof(const DiagnosticInfo *DI) {
252 return DI->getKind() == DK_DebugMetadataVersion;
256 /// Diagnostic information for stripping invalid debug metadata.
257 class DiagnosticInfoIgnoringInvalidDebugMetadata : public DiagnosticInfo {
259 /// The module that is concerned by this debug metadata version diagnostic.
263 /// \p The module that is concerned by this debug metadata version diagnostic.
264 DiagnosticInfoIgnoringInvalidDebugMetadata(
265 const Module &M, DiagnosticSeverity Severity = DS_Warning)
266 : DiagnosticInfo(DK_DebugMetadataVersion, Severity), M(M) {}
268 const Module &getModule() const { return M; }
270 /// \see DiagnosticInfo::print.
271 void print(DiagnosticPrinter &DP) const override;
273 static bool classof(const DiagnosticInfo *DI) {
274 return DI->getKind() == DK_DebugMetadataInvalid;
278 /// Diagnostic information for the sample profiler.
279 class DiagnosticInfoSampleProfile : public DiagnosticInfo {
281 DiagnosticInfoSampleProfile(StringRef FileName, unsigned LineNum,
283 DiagnosticSeverity Severity = DS_Error)
284 : DiagnosticInfo(DK_SampleProfile, Severity), FileName(FileName),
285 LineNum(LineNum), Msg(Msg) {}
286 DiagnosticInfoSampleProfile(StringRef FileName, const Twine &Msg,
287 DiagnosticSeverity Severity = DS_Error)
288 : DiagnosticInfo(DK_SampleProfile, Severity), FileName(FileName),
290 DiagnosticInfoSampleProfile(const Twine &Msg,
291 DiagnosticSeverity Severity = DS_Error)
292 : DiagnosticInfo(DK_SampleProfile, Severity), Msg(Msg) {}
294 /// \see DiagnosticInfo::print.
295 void print(DiagnosticPrinter &DP) const override;
297 static bool classof(const DiagnosticInfo *DI) {
298 return DI->getKind() == DK_SampleProfile;
301 StringRef getFileName() const { return FileName; }
302 unsigned getLineNum() const { return LineNum; }
303 const Twine &getMsg() const { return Msg; }
306 /// Name of the input file associated with this diagnostic.
309 /// Line number where the diagnostic occurred. If 0, no line number will
310 /// be emitted in the message.
311 unsigned LineNum = 0;
313 /// Message to report.
317 /// Diagnostic information for the PGO profiler.
318 class DiagnosticInfoPGOProfile : public DiagnosticInfo {
320 DiagnosticInfoPGOProfile(const char *FileName, const Twine &Msg,
321 DiagnosticSeverity Severity = DS_Error)
322 : DiagnosticInfo(DK_PGOProfile, Severity), FileName(FileName), Msg(Msg) {}
324 /// \see DiagnosticInfo::print.
325 void print(DiagnosticPrinter &DP) const override;
327 static bool classof(const DiagnosticInfo *DI) {
328 return DI->getKind() == DK_PGOProfile;
331 const char *getFileName() const { return FileName; }
332 const Twine &getMsg() const { return Msg; }
335 /// Name of the input file associated with this diagnostic.
336 const char *FileName;
338 /// Message to report.
342 class DiagnosticLocation {
348 DiagnosticLocation() = default;
349 DiagnosticLocation(const DebugLoc &DL);
350 DiagnosticLocation(const DISubprogram *SP);
352 bool isValid() const { return !Filename.empty(); }
353 StringRef getFilename() const { return Filename; }
354 unsigned getLine() const { return Line; }
355 unsigned getColumn() const { return Column; }
358 /// Common features for diagnostics with an associated location.
359 class DiagnosticInfoWithLocationBase : public DiagnosticInfo {
361 /// \p Fn is the function where the diagnostic is being emitted. \p Loc is
362 /// the location information to use in the diagnostic.
363 DiagnosticInfoWithLocationBase(enum DiagnosticKind Kind,
364 enum DiagnosticSeverity Severity,
366 const DiagnosticLocation &Loc)
367 : DiagnosticInfo(Kind, Severity), Fn(Fn), Loc(Loc) {}
369 /// Return true if location information is available for this diagnostic.
370 bool isLocationAvailable() const { return Loc.isValid(); }
372 /// Return a string with the location information for this diagnostic
373 /// in the format "file:line:col". If location information is not available,
374 /// it returns "<unknown>:0:0".
375 const std::string getLocationStr() const;
377 /// Return location information for this diagnostic in three parts:
378 /// the source file name, line number and column.
379 void getLocation(StringRef *Filename, unsigned *Line, unsigned *Column) const;
381 const Function &getFunction() const { return Fn; }
382 DiagnosticLocation getLocation() const { return Loc; }
385 /// Function where this diagnostic is triggered.
388 /// Debug location where this diagnostic is triggered.
389 DiagnosticLocation Loc;
392 /// \brief Common features for diagnostics dealing with optimization remarks
393 /// that are used by both IR and MIR passes.
394 class DiagnosticInfoOptimizationBase : public DiagnosticInfoWithLocationBase {
396 /// \brief Used to set IsVerbose via the stream interface.
397 struct setIsVerbose {};
399 /// \brief When an instance of this is inserted into the stream, the arguments
400 /// following will not appear in the remark printed in the compiler output
401 /// (-Rpass) but only in the optimization record file
402 /// (-fsave-optimization-record).
403 struct setExtraArgs {};
405 /// \brief Used in the streaming interface as the general argument type. It
406 /// internally converts everything into a key-value pair.
410 // If set, the debug location corresponding to the value.
411 DiagnosticLocation Loc;
413 explicit Argument(StringRef Str = "") : Key("String"), Val(Str) {}
414 Argument(StringRef Key, const Value *V);
415 Argument(StringRef Key, const Type *T);
416 Argument(StringRef Key, StringRef S);
417 Argument(StringRef Key, int N);
418 Argument(StringRef Key, long N);
419 Argument(StringRef Key, long long N);
420 Argument(StringRef Key, unsigned N);
421 Argument(StringRef Key, unsigned long N);
422 Argument(StringRef Key, unsigned long long N);
423 Argument(StringRef Key, bool B) : Key(Key), Val(B ? "true" : "false") {}
424 Argument(StringRef Key, DebugLoc dl);
427 /// \p PassName is the name of the pass emitting this diagnostic. \p
428 /// RemarkName is a textual identifier for the remark (single-word,
429 /// camel-case). \p Fn is the function where the diagnostic is being emitted.
430 /// \p Loc is the location information to use in the diagnostic. If line table
431 /// information is available, the diagnostic will include the source code
433 DiagnosticInfoOptimizationBase(enum DiagnosticKind Kind,
434 enum DiagnosticSeverity Severity,
435 const char *PassName, StringRef RemarkName,
437 const DiagnosticLocation &Loc)
438 : DiagnosticInfoWithLocationBase(Kind, Severity, Fn, Loc),
439 PassName(PassName), RemarkName(RemarkName) {}
441 DiagnosticInfoOptimizationBase &operator<<(StringRef S);
442 DiagnosticInfoOptimizationBase &operator<<(Argument A);
443 DiagnosticInfoOptimizationBase &operator<<(setIsVerbose V);
444 DiagnosticInfoOptimizationBase &operator<<(setExtraArgs EA);
446 /// \see DiagnosticInfo::print.
447 void print(DiagnosticPrinter &DP) const override;
449 /// Return true if this optimization remark is enabled by one of
450 /// of the LLVM command line flags (-pass-remarks, -pass-remarks-missed,
451 /// or -pass-remarks-analysis). Note that this only handles the LLVM
452 /// flags. We cannot access Clang flags from here (they are handled
453 /// in BackendConsumer::OptimizationRemarkHandler).
454 virtual bool isEnabled() const = 0;
456 StringRef getPassName() const { return PassName; }
457 std::string getMsg() const;
458 Optional<uint64_t> getHotness() const { return Hotness; }
459 void setHotness(Optional<uint64_t> H) { Hotness = H; }
461 bool isVerbose() const { return IsVerbose; }
463 static bool classof(const DiagnosticInfo *DI) {
464 return (DI->getKind() >= DK_FirstRemark &&
465 DI->getKind() <= DK_LastRemark) ||
466 (DI->getKind() >= DK_FirstMachineRemark &&
467 DI->getKind() <= DK_LastMachineRemark);
470 bool isPassed() const {
471 return (getKind() == DK_OptimizationRemark ||
472 getKind() == DK_MachineOptimizationRemark);
475 bool isMissed() const {
476 return (getKind() == DK_OptimizationRemarkMissed ||
477 getKind() == DK_MachineOptimizationRemarkMissed);
480 bool isAnalysis() const {
481 return (getKind() == DK_OptimizationRemarkAnalysis ||
482 getKind() == DK_MachineOptimizationRemarkAnalysis);
486 /// Name of the pass that triggers this report. If this matches the
487 /// regular expression given in -Rpass=regexp, then the remark will
489 const char *PassName;
491 /// Textual identifier for the remark (single-word, camel-case). Can be used
492 /// by external tools reading the YAML output file for optimization remarks to
493 /// identify the remark.
494 StringRef RemarkName;
496 /// If profile information is available, this is the number of times the
497 /// corresponding code was executed in a profile instrumentation run.
498 Optional<uint64_t> Hotness;
500 /// Arguments collected via the streaming interface.
501 SmallVector<Argument, 4> Args;
503 /// The remark is expected to be noisy.
504 bool IsVerbose = false;
506 /// \brief If positive, the index of the first argument that only appear in
507 /// the optimization records and not in the remark printed in the compiler
509 int FirstExtraArgIndex = -1;
511 friend struct yaml::MappingTraits<DiagnosticInfoOptimizationBase *>;
514 /// \brief Common features for diagnostics dealing with optimization remarks
515 /// that are used by IR passes.
516 class DiagnosticInfoIROptimization : public DiagnosticInfoOptimizationBase {
518 /// \p PassName is the name of the pass emitting this diagnostic. \p
519 /// RemarkName is a textual identifier for the remark (single-word,
520 /// camel-case). \p Fn is the function where the diagnostic is being emitted.
521 /// \p Loc is the location information to use in the diagnostic. If line table
522 /// information is available, the diagnostic will include the source code
523 /// location. \p CodeRegion is IR value (currently basic block) that the
524 /// optimization operates on. This is currently used to provide run-time
525 /// hotness information with PGO.
526 DiagnosticInfoIROptimization(enum DiagnosticKind Kind,
527 enum DiagnosticSeverity Severity,
528 const char *PassName, StringRef RemarkName,
530 const DiagnosticLocation &Loc,
531 const Value *CodeRegion = nullptr)
532 : DiagnosticInfoOptimizationBase(Kind, Severity, PassName, RemarkName, Fn,
534 CodeRegion(CodeRegion) {}
536 /// \brief This is ctor variant allows a pass to build an optimization remark
537 /// from an existing remark.
539 /// This is useful when a transformation pass (e.g LV) wants to emit a remark
540 /// (\p Orig) generated by one of its analyses (e.g. LAA) as its own analysis
541 /// remark. The string \p Prepend will be emitted before the original
543 DiagnosticInfoIROptimization(const char *PassName, StringRef Prepend,
544 const DiagnosticInfoIROptimization &Orig)
545 : DiagnosticInfoOptimizationBase(
546 (DiagnosticKind)Orig.getKind(), Orig.getSeverity(), PassName,
547 Orig.RemarkName, Orig.getFunction(), Orig.getLocation()),
548 CodeRegion(Orig.getCodeRegion()) {
550 std::copy(Orig.Args.begin(), Orig.Args.end(), std::back_inserter(Args));
553 /// Legacy interface.
554 /// \p PassName is the name of the pass emitting this diagnostic.
555 /// \p Fn is the function where the diagnostic is being emitted. \p Loc is
556 /// the location information to use in the diagnostic. If line table
557 /// information is available, the diagnostic will include the source code
558 /// location. \p Msg is the message to show. Note that this class does not
559 /// copy this message, so this reference must be valid for the whole life time
560 /// of the diagnostic.
561 DiagnosticInfoIROptimization(enum DiagnosticKind Kind,
562 enum DiagnosticSeverity Severity,
563 const char *PassName, const Function &Fn,
564 const DiagnosticLocation &Loc, const Twine &Msg)
565 : DiagnosticInfoOptimizationBase(Kind, Severity, PassName, "", Fn, Loc) {
569 const Value *getCodeRegion() const { return CodeRegion; }
571 static bool classof(const DiagnosticInfo *DI) {
572 return DI->getKind() >= DK_FirstRemark && DI->getKind() <= DK_LastRemark;
576 /// The IR value (currently basic block) that the optimization operates on.
577 /// This is currently used to provide run-time hotness information with PGO.
578 const Value *CodeRegion;
581 /// Diagnostic information for applied optimization remarks.
582 class OptimizationRemark : public DiagnosticInfoIROptimization {
584 /// \p PassName is the name of the pass emitting this diagnostic. If this name
585 /// matches the regular expression given in -Rpass=, then the diagnostic will
586 /// be emitted. \p RemarkName is a textual identifier for the remark (single-
587 /// word, camel-case). \p Loc is the debug location and \p CodeRegion is the
588 /// region that the optimization operates on (currently only block is
590 OptimizationRemark(const char *PassName, StringRef RemarkName,
591 const DiagnosticLocation &Loc, const Value *CodeRegion);
593 /// Same as above, but the debug location and code region are derived from \p
595 OptimizationRemark(const char *PassName, StringRef RemarkName,
596 const Instruction *Inst);
598 /// Same as above, but the debug location and code region are derived from \p
600 OptimizationRemark(const char *PassName, StringRef RemarkName,
601 const Function *Func);
603 static bool classof(const DiagnosticInfo *DI) {
604 return DI->getKind() == DK_OptimizationRemark;
607 /// \see DiagnosticInfoOptimizationBase::isEnabled.
608 bool isEnabled() const override;
611 /// This is deprecated now and only used by the function API below.
612 /// \p PassName is the name of the pass emitting this diagnostic. If
613 /// this name matches the regular expression given in -Rpass=, then the
614 /// diagnostic will be emitted. \p Fn is the function where the diagnostic
615 /// is being emitted. \p Loc is the location information to use in the
616 /// diagnostic. If line table information is available, the diagnostic
617 /// will include the source code location. \p Msg is the message to show.
618 /// Note that this class does not copy this message, so this reference
619 /// must be valid for the whole life time of the diagnostic.
620 OptimizationRemark(const char *PassName, const Function &Fn,
621 const DiagnosticLocation &Loc, const Twine &Msg)
622 : DiagnosticInfoIROptimization(DK_OptimizationRemark, DS_Remark, PassName,
626 /// Diagnostic information for missed-optimization remarks.
627 class OptimizationRemarkMissed : public DiagnosticInfoIROptimization {
629 /// \p PassName is the name of the pass emitting this diagnostic. If this name
630 /// matches the regular expression given in -Rpass-missed=, then the
631 /// diagnostic will be emitted. \p RemarkName is a textual identifier for the
632 /// remark (single-word, camel-case). \p Loc is the debug location and \p
633 /// CodeRegion is the region that the optimization operates on (currently only
634 /// block is supported).
635 OptimizationRemarkMissed(const char *PassName, StringRef RemarkName,
636 const DiagnosticLocation &Loc,
637 const Value *CodeRegion);
639 /// \brief Same as above but \p Inst is used to derive code region and debug
641 OptimizationRemarkMissed(const char *PassName, StringRef RemarkName,
642 const Instruction *Inst);
644 static bool classof(const DiagnosticInfo *DI) {
645 return DI->getKind() == DK_OptimizationRemarkMissed;
648 /// \see DiagnosticInfoOptimizationBase::isEnabled.
649 bool isEnabled() const override;
652 /// This is deprecated now and only used by the function API below.
653 /// \p PassName is the name of the pass emitting this diagnostic. If
654 /// this name matches the regular expression given in -Rpass-missed=, then the
655 /// diagnostic will be emitted. \p Fn is the function where the diagnostic
656 /// is being emitted. \p Loc is the location information to use in the
657 /// diagnostic. If line table information is available, the diagnostic
658 /// will include the source code location. \p Msg is the message to show.
659 /// Note that this class does not copy this message, so this reference
660 /// must be valid for the whole life time of the diagnostic.
661 OptimizationRemarkMissed(const char *PassName, const Function &Fn,
662 const DiagnosticLocation &Loc, const Twine &Msg)
663 : DiagnosticInfoIROptimization(DK_OptimizationRemarkMissed, DS_Remark,
664 PassName, Fn, Loc, Msg) {}
667 /// Diagnostic information for optimization analysis remarks.
668 class OptimizationRemarkAnalysis : public DiagnosticInfoIROptimization {
670 /// \p PassName is the name of the pass emitting this diagnostic. If this name
671 /// matches the regular expression given in -Rpass-analysis=, then the
672 /// diagnostic will be emitted. \p RemarkName is a textual identifier for the
673 /// remark (single-word, camel-case). \p Loc is the debug location and \p
674 /// CodeRegion is the region that the optimization operates on (currently only
675 /// block is supported).
676 OptimizationRemarkAnalysis(const char *PassName, StringRef RemarkName,
677 const DiagnosticLocation &Loc,
678 const Value *CodeRegion);
680 /// \brief This is ctor variant allows a pass to build an optimization remark
681 /// from an existing remark.
683 /// This is useful when a transformation pass (e.g LV) wants to emit a remark
684 /// (\p Orig) generated by one of its analyses (e.g. LAA) as its own analysis
685 /// remark. The string \p Prepend will be emitted before the original
687 OptimizationRemarkAnalysis(const char *PassName, StringRef Prepend,
688 const OptimizationRemarkAnalysis &Orig)
689 : DiagnosticInfoIROptimization(PassName, Prepend, Orig) {}
691 /// \brief Same as above but \p Inst is used to derive code region and debug
693 OptimizationRemarkAnalysis(const char *PassName, StringRef RemarkName,
694 const Instruction *Inst);
696 static bool classof(const DiagnosticInfo *DI) {
697 return DI->getKind() == DK_OptimizationRemarkAnalysis;
700 /// \see DiagnosticInfoOptimizationBase::isEnabled.
701 bool isEnabled() const override;
703 static const char *AlwaysPrint;
705 bool shouldAlwaysPrint() const { return getPassName() == AlwaysPrint; }
708 OptimizationRemarkAnalysis(enum DiagnosticKind Kind, const char *PassName,
709 const Function &Fn, const DiagnosticLocation &Loc,
711 : DiagnosticInfoIROptimization(Kind, DS_Remark, PassName, Fn, Loc, Msg) {}
713 OptimizationRemarkAnalysis(enum DiagnosticKind Kind, const char *PassName,
714 StringRef RemarkName,
715 const DiagnosticLocation &Loc,
716 const Value *CodeRegion);
719 /// This is deprecated now and only used by the function API below.
720 /// \p PassName is the name of the pass emitting this diagnostic. If
721 /// this name matches the regular expression given in -Rpass-analysis=, then
722 /// the diagnostic will be emitted. \p Fn is the function where the diagnostic
723 /// is being emitted. \p Loc is the location information to use in the
724 /// diagnostic. If line table information is available, the diagnostic will
725 /// include the source code location. \p Msg is the message to show. Note that
726 /// this class does not copy this message, so this reference must be valid for
727 /// the whole life time of the diagnostic.
728 OptimizationRemarkAnalysis(const char *PassName, const Function &Fn,
729 const DiagnosticLocation &Loc, const Twine &Msg)
730 : DiagnosticInfoIROptimization(DK_OptimizationRemarkAnalysis, DS_Remark,
731 PassName, Fn, Loc, Msg) {}
734 /// Diagnostic information for optimization analysis remarks related to
735 /// floating-point non-commutativity.
736 class OptimizationRemarkAnalysisFPCommute : public OptimizationRemarkAnalysis {
738 /// \p PassName is the name of the pass emitting this diagnostic. If this name
739 /// matches the regular expression given in -Rpass-analysis=, then the
740 /// diagnostic will be emitted. \p RemarkName is a textual identifier for the
741 /// remark (single-word, camel-case). \p Loc is the debug location and \p
742 /// CodeRegion is the region that the optimization operates on (currently only
743 /// block is supported). The front-end will append its own message related to
744 /// options that address floating-point non-commutativity.
745 OptimizationRemarkAnalysisFPCommute(const char *PassName,
746 StringRef RemarkName,
747 const DiagnosticLocation &Loc,
748 const Value *CodeRegion)
749 : OptimizationRemarkAnalysis(DK_OptimizationRemarkAnalysisFPCommute,
750 PassName, RemarkName, Loc, CodeRegion) {}
752 static bool classof(const DiagnosticInfo *DI) {
753 return DI->getKind() == DK_OptimizationRemarkAnalysisFPCommute;
757 /// This is deprecated now and only used by the function API below.
758 /// \p PassName is the name of the pass emitting this diagnostic. If
759 /// this name matches the regular expression given in -Rpass-analysis=, then
760 /// the diagnostic will be emitted. \p Fn is the function where the diagnostic
761 /// is being emitted. \p Loc is the location information to use in the
762 /// diagnostic. If line table information is available, the diagnostic will
763 /// include the source code location. \p Msg is the message to show. The
764 /// front-end will append its own message related to options that address
765 /// floating-point non-commutativity. Note that this class does not copy this
766 /// message, so this reference must be valid for the whole life time of the
768 OptimizationRemarkAnalysisFPCommute(const char *PassName, const Function &Fn,
769 const DiagnosticLocation &Loc,
771 : OptimizationRemarkAnalysis(DK_OptimizationRemarkAnalysisFPCommute,
772 PassName, Fn, Loc, Msg) {}
775 /// Diagnostic information for optimization analysis remarks related to
776 /// pointer aliasing.
777 class OptimizationRemarkAnalysisAliasing : public OptimizationRemarkAnalysis {
779 /// \p PassName is the name of the pass emitting this diagnostic. If this name
780 /// matches the regular expression given in -Rpass-analysis=, then the
781 /// diagnostic will be emitted. \p RemarkName is a textual identifier for the
782 /// remark (single-word, camel-case). \p Loc is the debug location and \p
783 /// CodeRegion is the region that the optimization operates on (currently only
784 /// block is supported). The front-end will append its own message related to
785 /// options that address pointer aliasing legality.
786 OptimizationRemarkAnalysisAliasing(const char *PassName, StringRef RemarkName,
787 const DiagnosticLocation &Loc,
788 const Value *CodeRegion)
789 : OptimizationRemarkAnalysis(DK_OptimizationRemarkAnalysisAliasing,
790 PassName, RemarkName, Loc, CodeRegion) {}
792 static bool classof(const DiagnosticInfo *DI) {
793 return DI->getKind() == DK_OptimizationRemarkAnalysisAliasing;
797 /// This is deprecated now and only used by the function API below.
798 /// \p PassName is the name of the pass emitting this diagnostic. If
799 /// this name matches the regular expression given in -Rpass-analysis=, then
800 /// the diagnostic will be emitted. \p Fn is the function where the diagnostic
801 /// is being emitted. \p Loc is the location information to use in the
802 /// diagnostic. If line table information is available, the diagnostic will
803 /// include the source code location. \p Msg is the message to show. The
804 /// front-end will append its own message related to options that address
805 /// pointer aliasing legality. Note that this class does not copy this
806 /// message, so this reference must be valid for the whole life time of the
808 OptimizationRemarkAnalysisAliasing(const char *PassName, const Function &Fn,
809 const DiagnosticLocation &Loc,
811 : OptimizationRemarkAnalysis(DK_OptimizationRemarkAnalysisAliasing,
812 PassName, Fn, Loc, Msg) {}
815 /// Diagnostic information for machine IR parser.
816 class DiagnosticInfoMIRParser : public DiagnosticInfo {
817 const SMDiagnostic &Diagnostic;
820 DiagnosticInfoMIRParser(DiagnosticSeverity Severity,
821 const SMDiagnostic &Diagnostic)
822 : DiagnosticInfo(DK_MIRParser, Severity), Diagnostic(Diagnostic) {}
824 const SMDiagnostic &getDiagnostic() const { return Diagnostic; }
826 void print(DiagnosticPrinter &DP) const override;
828 static bool classof(const DiagnosticInfo *DI) {
829 return DI->getKind() == DK_MIRParser;
833 /// Diagnostic information for ISel fallback path.
834 class DiagnosticInfoISelFallback : public DiagnosticInfo {
835 /// The function that is concerned by this diagnostic.
839 DiagnosticInfoISelFallback(const Function &Fn,
840 DiagnosticSeverity Severity = DS_Warning)
841 : DiagnosticInfo(DK_ISelFallback, Severity), Fn(Fn) {}
843 const Function &getFunction() const { return Fn; }
845 void print(DiagnosticPrinter &DP) const override;
847 static bool classof(const DiagnosticInfo *DI) {
848 return DI->getKind() == DK_ISelFallback;
852 // Create wrappers for C Binding types (see CBindingWrapping.h).
853 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(DiagnosticInfo, LLVMDiagnosticInfoRef)
855 /// Diagnostic information for optimization failures.
856 class DiagnosticInfoOptimizationFailure : public DiagnosticInfoIROptimization {
858 /// \p Fn is the function where the diagnostic is being emitted. \p Loc is
859 /// the location information to use in the diagnostic. If line table
860 /// information is available, the diagnostic will include the source code
861 /// location. \p Msg is the message to show. Note that this class does not
862 /// copy this message, so this reference must be valid for the whole life time
863 /// of the diagnostic.
864 DiagnosticInfoOptimizationFailure(const Function &Fn,
865 const DiagnosticLocation &Loc,
867 : DiagnosticInfoIROptimization(DK_OptimizationFailure, DS_Warning,
868 nullptr, Fn, Loc, Msg) {}
870 /// \p PassName is the name of the pass emitting this diagnostic. \p
871 /// RemarkName is a textual identifier for the remark (single-word,
872 /// camel-case). \p Loc is the debug location and \p CodeRegion is the
873 /// region that the optimization operates on (currently basic block is
875 DiagnosticInfoOptimizationFailure(const char *PassName, StringRef RemarkName,
876 const DiagnosticLocation &Loc,
877 const Value *CodeRegion);
879 static bool classof(const DiagnosticInfo *DI) {
880 return DI->getKind() == DK_OptimizationFailure;
883 /// \see DiagnosticInfoOptimizationBase::isEnabled.
884 bool isEnabled() const override;
887 /// Diagnostic information for unsupported feature in backend.
888 class DiagnosticInfoUnsupported : public DiagnosticInfoWithLocationBase {
893 /// \p Fn is the function where the diagnostic is being emitted. \p Loc is
894 /// the location information to use in the diagnostic. If line table
895 /// information is available, the diagnostic will include the source code
896 /// location. \p Msg is the message to show. Note that this class does not
897 /// copy this message, so this reference must be valid for the whole life time
898 /// of the diagnostic.
899 DiagnosticInfoUnsupported(
900 const Function &Fn, const Twine &Msg,
901 const DiagnosticLocation &Loc = DiagnosticLocation(),
902 DiagnosticSeverity Severity = DS_Error)
903 : DiagnosticInfoWithLocationBase(DK_Unsupported, Severity, Fn, Loc),
906 static bool classof(const DiagnosticInfo *DI) {
907 return DI->getKind() == DK_Unsupported;
910 const Twine &getMessage() const { return Msg; }
912 void print(DiagnosticPrinter &DP) const override;
915 } // end namespace llvm
917 #endif // LLVM_IR_DIAGNOSTICINFO_H