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,
192 const char *ResourceName,
193 uint64_t ResourceSize,
194 DiagnosticSeverity Severity = DS_Warning,
195 DiagnosticKind Kind = DK_ResourceLimit,
196 uint64_t ResourceLimit = 0)
197 : DiagnosticInfo(Kind, Severity),
199 ResourceName(ResourceName),
200 ResourceSize(ResourceSize),
201 ResourceLimit(ResourceLimit) {}
203 const Function &getFunction() const { return Fn; }
204 const char *getResourceName() const { return ResourceName; }
205 uint64_t getResourceSize() const { return ResourceSize; }
206 uint64_t getResourceLimit() const { return ResourceLimit; }
208 /// \see DiagnosticInfo::print.
209 void print(DiagnosticPrinter &DP) const override;
211 static bool classof(const DiagnosticInfo *DI) {
212 return DI->getKind() == DK_ResourceLimit ||
213 DI->getKind() == DK_StackSize;
217 class DiagnosticInfoStackSize : public DiagnosticInfoResourceLimit {
219 DiagnosticInfoStackSize(const Function &Fn,
221 DiagnosticSeverity Severity = DS_Warning,
222 uint64_t StackLimit = 0)
223 : DiagnosticInfoResourceLimit(Fn, "stack size", StackSize,
224 Severity, DK_StackSize, StackLimit) {}
226 uint64_t getStackSize() const { return getResourceSize(); }
227 uint64_t getStackLimit() const { return getResourceLimit(); }
229 static bool classof(const DiagnosticInfo *DI) {
230 return DI->getKind() == DK_StackSize;
234 /// Diagnostic information for debug metadata version reporting.
235 /// This is basically a module and a version.
236 class DiagnosticInfoDebugMetadataVersion : public DiagnosticInfo {
238 /// The module that is concerned by this debug metadata version diagnostic.
240 /// The actual metadata version.
241 unsigned MetadataVersion;
244 /// \p The module that is concerned by this debug metadata version diagnostic.
245 /// \p The actual metadata version.
246 DiagnosticInfoDebugMetadataVersion(const Module &M, unsigned MetadataVersion,
247 DiagnosticSeverity Severity = DS_Warning)
248 : DiagnosticInfo(DK_DebugMetadataVersion, Severity), M(M),
249 MetadataVersion(MetadataVersion) {}
251 const Module &getModule() const { return M; }
252 unsigned getMetadataVersion() const { return MetadataVersion; }
254 /// \see DiagnosticInfo::print.
255 void print(DiagnosticPrinter &DP) const override;
257 static bool classof(const DiagnosticInfo *DI) {
258 return DI->getKind() == DK_DebugMetadataVersion;
262 /// Diagnostic information for stripping invalid debug metadata.
263 class DiagnosticInfoIgnoringInvalidDebugMetadata : public DiagnosticInfo {
265 /// The module that is concerned by this debug metadata version diagnostic.
269 /// \p The module that is concerned by this debug metadata version diagnostic.
270 DiagnosticInfoIgnoringInvalidDebugMetadata(
271 const Module &M, DiagnosticSeverity Severity = DS_Warning)
272 : DiagnosticInfo(DK_DebugMetadataVersion, Severity), M(M) {}
274 const Module &getModule() const { return M; }
276 /// \see DiagnosticInfo::print.
277 void print(DiagnosticPrinter &DP) const override;
279 static bool classof(const DiagnosticInfo *DI) {
280 return DI->getKind() == DK_DebugMetadataInvalid;
284 /// Diagnostic information for the sample profiler.
285 class DiagnosticInfoSampleProfile : public DiagnosticInfo {
287 DiagnosticInfoSampleProfile(StringRef FileName, unsigned LineNum,
289 DiagnosticSeverity Severity = DS_Error)
290 : DiagnosticInfo(DK_SampleProfile, Severity), FileName(FileName),
291 LineNum(LineNum), Msg(Msg) {}
292 DiagnosticInfoSampleProfile(StringRef FileName, const Twine &Msg,
293 DiagnosticSeverity Severity = DS_Error)
294 : DiagnosticInfo(DK_SampleProfile, Severity), FileName(FileName),
296 DiagnosticInfoSampleProfile(const Twine &Msg,
297 DiagnosticSeverity Severity = DS_Error)
298 : DiagnosticInfo(DK_SampleProfile, Severity), Msg(Msg) {}
300 /// \see DiagnosticInfo::print.
301 void print(DiagnosticPrinter &DP) const override;
303 static bool classof(const DiagnosticInfo *DI) {
304 return DI->getKind() == DK_SampleProfile;
307 StringRef getFileName() const { return FileName; }
308 unsigned getLineNum() const { return LineNum; }
309 const Twine &getMsg() const { return Msg; }
312 /// Name of the input file associated with this diagnostic.
315 /// Line number where the diagnostic occurred. If 0, no line number will
316 /// be emitted in the message.
317 unsigned LineNum = 0;
319 /// Message to report.
323 /// Diagnostic information for the PGO profiler.
324 class DiagnosticInfoPGOProfile : public DiagnosticInfo {
326 DiagnosticInfoPGOProfile(const char *FileName, const Twine &Msg,
327 DiagnosticSeverity Severity = DS_Error)
328 : DiagnosticInfo(DK_PGOProfile, Severity), FileName(FileName), Msg(Msg) {}
330 /// \see DiagnosticInfo::print.
331 void print(DiagnosticPrinter &DP) const override;
333 static bool classof(const DiagnosticInfo *DI) {
334 return DI->getKind() == DK_PGOProfile;
337 const char *getFileName() const { return FileName; }
338 const Twine &getMsg() const { return Msg; }
341 /// Name of the input file associated with this diagnostic.
342 const char *FileName;
344 /// Message to report.
348 class DiagnosticLocation {
354 DiagnosticLocation() = default;
355 DiagnosticLocation(const DebugLoc &DL);
356 DiagnosticLocation(const DISubprogram *SP);
358 bool isValid() const { return !Filename.empty(); }
359 StringRef getFilename() const { return Filename; }
360 unsigned getLine() const { return Line; }
361 unsigned getColumn() const { return Column; }
364 /// Common features for diagnostics with an associated location.
365 class DiagnosticInfoWithLocationBase : public DiagnosticInfo {
367 /// \p Fn is the function where the diagnostic is being emitted. \p Loc is
368 /// the location information to use in the diagnostic.
369 DiagnosticInfoWithLocationBase(enum DiagnosticKind Kind,
370 enum DiagnosticSeverity Severity,
372 const DiagnosticLocation &Loc)
373 : DiagnosticInfo(Kind, Severity), Fn(Fn), Loc(Loc) {}
375 /// Return true if location information is available for this diagnostic.
376 bool isLocationAvailable() const { return Loc.isValid(); }
378 /// Return a string with the location information for this diagnostic
379 /// in the format "file:line:col". If location information is not available,
380 /// it returns "<unknown>:0:0".
381 const std::string getLocationStr() const;
383 /// Return location information for this diagnostic in three parts:
384 /// the source file name, line number and column.
385 void getLocation(StringRef *Filename, unsigned *Line, unsigned *Column) const;
387 const Function &getFunction() const { return Fn; }
388 DiagnosticLocation getLocation() const { return Loc; }
391 /// Function where this diagnostic is triggered.
394 /// Debug location where this diagnostic is triggered.
395 DiagnosticLocation Loc;
398 /// \brief Common features for diagnostics dealing with optimization remarks
399 /// that are used by both IR and MIR passes.
400 class DiagnosticInfoOptimizationBase : public DiagnosticInfoWithLocationBase {
402 /// \brief Used to set IsVerbose via the stream interface.
403 struct setIsVerbose {};
405 /// \brief When an instance of this is inserted into the stream, the arguments
406 /// following will not appear in the remark printed in the compiler output
407 /// (-Rpass) but only in the optimization record file
408 /// (-fsave-optimization-record).
409 struct setExtraArgs {};
411 /// \brief Used in the streaming interface as the general argument type. It
412 /// internally converts everything into a key-value pair.
416 // If set, the debug location corresponding to the value.
417 DiagnosticLocation Loc;
419 explicit Argument(StringRef Str = "") : Key("String"), Val(Str) {}
420 Argument(StringRef Key, const Value *V);
421 Argument(StringRef Key, const Type *T);
422 Argument(StringRef Key, int N);
423 Argument(StringRef Key, unsigned N);
424 Argument(StringRef Key, bool B) : Key(Key), Val(B ? "true" : "false") {}
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 static bool isEnabled(StringRef PassName);
609 /// \see DiagnosticInfoOptimizationBase::isEnabled.
610 bool isEnabled() const override { return isEnabled(getPassName()); }
613 /// This is deprecated now and only used by the function API below.
614 /// \p PassName is the name of the pass emitting this diagnostic. If
615 /// this name matches the regular expression given in -Rpass=, then the
616 /// diagnostic will be emitted. \p Fn is the function where the diagnostic
617 /// is being emitted. \p Loc is the location information to use in the
618 /// diagnostic. If line table information is available, the diagnostic
619 /// will include the source code location. \p Msg is the message to show.
620 /// Note that this class does not copy this message, so this reference
621 /// must be valid for the whole life time of the diagnostic.
622 OptimizationRemark(const char *PassName, const Function &Fn,
623 const DiagnosticLocation &Loc, const Twine &Msg)
624 : DiagnosticInfoIROptimization(DK_OptimizationRemark, DS_Remark, PassName,
627 friend void emitOptimizationRemark(LLVMContext &Ctx, const char *PassName,
629 const DiagnosticLocation &Loc,
633 /// Diagnostic information for missed-optimization remarks.
634 class OptimizationRemarkMissed : public DiagnosticInfoIROptimization {
636 /// \p PassName is the name of the pass emitting this diagnostic. If this name
637 /// matches the regular expression given in -Rpass-missed=, then the
638 /// diagnostic will be emitted. \p RemarkName is a textual identifier for the
639 /// remark (single-word, camel-case). \p Loc is the debug location and \p
640 /// CodeRegion is the region that the optimization operates on (currently only
641 /// block is supported).
642 OptimizationRemarkMissed(const char *PassName, StringRef RemarkName,
643 const DiagnosticLocation &Loc,
644 const Value *CodeRegion);
646 /// \brief Same as above but \p Inst is used to derive code region and debug
648 OptimizationRemarkMissed(const char *PassName, StringRef RemarkName,
649 const Instruction *Inst);
651 static bool classof(const DiagnosticInfo *DI) {
652 return DI->getKind() == DK_OptimizationRemarkMissed;
655 static bool isEnabled(StringRef PassName);
657 /// \see DiagnosticInfoOptimizationBase::isEnabled.
658 bool isEnabled() const override { return isEnabled(getPassName()); }
661 /// This is deprecated now and only used by the function API below.
662 /// \p PassName is the name of the pass emitting this diagnostic. If
663 /// this name matches the regular expression given in -Rpass-missed=, then the
664 /// diagnostic will be emitted. \p Fn is the function where the diagnostic
665 /// is being emitted. \p Loc is the location information to use in the
666 /// diagnostic. If line table information is available, the diagnostic
667 /// will include the source code location. \p Msg is the message to show.
668 /// Note that this class does not copy this message, so this reference
669 /// must be valid for the whole life time of the diagnostic.
670 OptimizationRemarkMissed(const char *PassName, const Function &Fn,
671 const DiagnosticLocation &Loc, const Twine &Msg)
672 : DiagnosticInfoIROptimization(DK_OptimizationRemarkMissed, DS_Remark,
673 PassName, Fn, Loc, Msg) {}
675 friend void emitOptimizationRemarkMissed(LLVMContext &Ctx,
676 const char *PassName,
678 const DiagnosticLocation &Loc,
682 /// Diagnostic information for optimization analysis remarks.
683 class OptimizationRemarkAnalysis : public DiagnosticInfoIROptimization {
685 /// \p PassName is the name of the pass emitting this diagnostic. If this name
686 /// matches the regular expression given in -Rpass-analysis=, then the
687 /// diagnostic will be emitted. \p RemarkName is a textual identifier for the
688 /// remark (single-word, camel-case). \p Loc is the debug location and \p
689 /// CodeRegion is the region that the optimization operates on (currently only
690 /// block is supported).
691 OptimizationRemarkAnalysis(const char *PassName, StringRef RemarkName,
692 const DiagnosticLocation &Loc,
693 const Value *CodeRegion);
695 /// \brief This is ctor variant allows a pass to build an optimization remark
696 /// from an existing remark.
698 /// This is useful when a transformation pass (e.g LV) wants to emit a remark
699 /// (\p Orig) generated by one of its analyses (e.g. LAA) as its own analysis
700 /// remark. The string \p Prepend will be emitted before the original
702 OptimizationRemarkAnalysis(const char *PassName, StringRef Prepend,
703 const OptimizationRemarkAnalysis &Orig)
704 : DiagnosticInfoIROptimization(PassName, Prepend, Orig) {}
706 /// \brief Same as above but \p Inst is used to derive code region and debug
708 OptimizationRemarkAnalysis(const char *PassName, StringRef RemarkName,
709 const Instruction *Inst);
711 static bool classof(const DiagnosticInfo *DI) {
712 return DI->getKind() == DK_OptimizationRemarkAnalysis;
715 static bool isEnabled(StringRef PassName);
717 /// \see DiagnosticInfoOptimizationBase::isEnabled.
718 bool isEnabled() const override {
719 return shouldAlwaysPrint() || isEnabled(getPassName());
722 static const char *AlwaysPrint;
724 bool shouldAlwaysPrint() const { return getPassName() == AlwaysPrint; }
727 OptimizationRemarkAnalysis(enum DiagnosticKind Kind, const char *PassName,
728 const Function &Fn, const DiagnosticLocation &Loc,
730 : DiagnosticInfoIROptimization(Kind, DS_Remark, PassName, Fn, Loc, Msg) {}
732 OptimizationRemarkAnalysis(enum DiagnosticKind Kind, const char *PassName,
733 StringRef RemarkName,
734 const DiagnosticLocation &Loc,
735 const Value *CodeRegion);
738 /// This is deprecated now and only used by the function API below.
739 /// \p PassName is the name of the pass emitting this diagnostic. If
740 /// this name matches the regular expression given in -Rpass-analysis=, then
741 /// the diagnostic will be emitted. \p Fn is the function where the diagnostic
742 /// is being emitted. \p Loc is the location information to use in the
743 /// diagnostic. If line table information is available, the diagnostic will
744 /// include the source code location. \p Msg is the message to show. Note that
745 /// this class does not copy this message, so this reference must be valid for
746 /// the whole life time of the diagnostic.
747 OptimizationRemarkAnalysis(const char *PassName, const Function &Fn,
748 const DiagnosticLocation &Loc, const Twine &Msg)
749 : DiagnosticInfoIROptimization(DK_OptimizationRemarkAnalysis, DS_Remark,
750 PassName, Fn, Loc, Msg) {}
752 friend void emitOptimizationRemarkAnalysis(LLVMContext &Ctx,
753 const char *PassName,
755 const DiagnosticLocation &Loc,
759 /// Diagnostic information for optimization analysis remarks related to
760 /// floating-point non-commutativity.
761 class OptimizationRemarkAnalysisFPCommute : public OptimizationRemarkAnalysis {
763 /// \p PassName is the name of the pass emitting this diagnostic. If this name
764 /// matches the regular expression given in -Rpass-analysis=, then the
765 /// diagnostic will be emitted. \p RemarkName is a textual identifier for the
766 /// remark (single-word, camel-case). \p Loc is the debug location and \p
767 /// CodeRegion is the region that the optimization operates on (currently only
768 /// block is supported). The front-end will append its own message related to
769 /// options that address floating-point non-commutativity.
770 OptimizationRemarkAnalysisFPCommute(const char *PassName,
771 StringRef RemarkName,
772 const DiagnosticLocation &Loc,
773 const Value *CodeRegion)
774 : OptimizationRemarkAnalysis(DK_OptimizationRemarkAnalysisFPCommute,
775 PassName, RemarkName, Loc, CodeRegion) {}
777 static bool classof(const DiagnosticInfo *DI) {
778 return DI->getKind() == DK_OptimizationRemarkAnalysisFPCommute;
782 /// This is deprecated now and only used by the function API below.
783 /// \p PassName is the name of the pass emitting this diagnostic. If
784 /// this name matches the regular expression given in -Rpass-analysis=, then
785 /// the diagnostic will be emitted. \p Fn is the function where the diagnostic
786 /// is being emitted. \p Loc is the location information to use in the
787 /// diagnostic. If line table information is available, the diagnostic will
788 /// include the source code location. \p Msg is the message to show. The
789 /// front-end will append its own message related to options that address
790 /// floating-point non-commutativity. Note that this class does not copy this
791 /// message, so this reference must be valid for the whole life time of the
793 OptimizationRemarkAnalysisFPCommute(const char *PassName, const Function &Fn,
794 const DiagnosticLocation &Loc,
796 : OptimizationRemarkAnalysis(DK_OptimizationRemarkAnalysisFPCommute,
797 PassName, Fn, Loc, Msg) {}
799 friend void emitOptimizationRemarkAnalysisFPCommute(
800 LLVMContext &Ctx, const char *PassName, const Function &Fn,
801 const DiagnosticLocation &Loc, const Twine &Msg);
804 /// Diagnostic information for optimization analysis remarks related to
805 /// pointer aliasing.
806 class OptimizationRemarkAnalysisAliasing : public OptimizationRemarkAnalysis {
808 /// \p PassName is the name of the pass emitting this diagnostic. If this name
809 /// matches the regular expression given in -Rpass-analysis=, then the
810 /// diagnostic will be emitted. \p RemarkName is a textual identifier for the
811 /// remark (single-word, camel-case). \p Loc is the debug location and \p
812 /// CodeRegion is the region that the optimization operates on (currently only
813 /// block is supported). The front-end will append its own message related to
814 /// options that address pointer aliasing legality.
815 OptimizationRemarkAnalysisAliasing(const char *PassName, StringRef RemarkName,
816 const DiagnosticLocation &Loc,
817 const Value *CodeRegion)
818 : OptimizationRemarkAnalysis(DK_OptimizationRemarkAnalysisAliasing,
819 PassName, RemarkName, Loc, CodeRegion) {}
821 static bool classof(const DiagnosticInfo *DI) {
822 return DI->getKind() == DK_OptimizationRemarkAnalysisAliasing;
826 /// This is deprecated now and only used by the function API below.
827 /// \p PassName is the name of the pass emitting this diagnostic. If
828 /// this name matches the regular expression given in -Rpass-analysis=, then
829 /// the diagnostic will be emitted. \p Fn is the function where the diagnostic
830 /// is being emitted. \p Loc is the location information to use in the
831 /// diagnostic. If line table information is available, the diagnostic will
832 /// include the source code location. \p Msg is the message to show. The
833 /// front-end will append its own message related to options that address
834 /// pointer aliasing legality. Note that this class does not copy this
835 /// message, so this reference must be valid for the whole life time of the
837 OptimizationRemarkAnalysisAliasing(const char *PassName, const Function &Fn,
838 const DiagnosticLocation &Loc,
840 : OptimizationRemarkAnalysis(DK_OptimizationRemarkAnalysisAliasing,
841 PassName, Fn, Loc, Msg) {}
843 friend void emitOptimizationRemarkAnalysisAliasing(
844 LLVMContext &Ctx, const char *PassName, const Function &Fn,
845 const DiagnosticLocation &Loc, const Twine &Msg);
848 /// Diagnostic information for machine IR parser.
849 class DiagnosticInfoMIRParser : public DiagnosticInfo {
850 const SMDiagnostic &Diagnostic;
853 DiagnosticInfoMIRParser(DiagnosticSeverity Severity,
854 const SMDiagnostic &Diagnostic)
855 : DiagnosticInfo(DK_MIRParser, Severity), Diagnostic(Diagnostic) {}
857 const SMDiagnostic &getDiagnostic() const { return Diagnostic; }
859 void print(DiagnosticPrinter &DP) const override;
861 static bool classof(const DiagnosticInfo *DI) {
862 return DI->getKind() == DK_MIRParser;
866 /// Diagnostic information for ISel fallback path.
867 class DiagnosticInfoISelFallback : public DiagnosticInfo {
868 /// The function that is concerned by this diagnostic.
872 DiagnosticInfoISelFallback(const Function &Fn,
873 DiagnosticSeverity Severity = DS_Warning)
874 : DiagnosticInfo(DK_ISelFallback, Severity), Fn(Fn) {}
876 const Function &getFunction() const { return Fn; }
878 void print(DiagnosticPrinter &DP) const override;
880 static bool classof(const DiagnosticInfo *DI) {
881 return DI->getKind() == DK_ISelFallback;
885 // Create wrappers for C Binding types (see CBindingWrapping.h).
886 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(DiagnosticInfo, LLVMDiagnosticInfoRef)
888 /// \brief Legacy interface to emit an optimization-applied message. Use
889 /// (Machine)OptimizationRemarkEmitter instead.
891 /// \p PassName is the name of the pass emitting the message. If -Rpass= is
892 /// given and \p PassName matches the regular expression in -Rpass, then the
893 /// remark will be emitted. \p Fn is the function triggering the remark, \p Loc
894 /// is the debug location where the diagnostic is generated. \p Msg is the
895 /// message string to use.
896 void emitOptimizationRemark(LLVMContext &Ctx, const char *PassName,
897 const Function &Fn, const DiagnosticLocation &Loc,
900 /// \brief Legacy interface to emit an optimization-missed message. Use
901 /// (Machine)OptimizationRemarkEmitter instead.
903 /// \p PassName is the name of the pass emitting the message. If -Rpass-missed=
904 /// is given and \p PassName matches the regular expression in -Rpass, then the
905 /// remark will be emitted. \p Fn is the function triggering the remark, \p Loc
906 /// is the debug location where the diagnostic is generated. \p Msg is the
907 /// message string to use.
908 void emitOptimizationRemarkMissed(LLVMContext &Ctx, const char *PassName,
910 const DiagnosticLocation &Loc,
913 /// \brief Legacy interface to emit an optimization analysis remark message.
914 /// Use (Machine)OptimizationRemarkEmitter instead.
916 /// \p PassName is the name of the pass emitting the message. If
917 /// -Rpass-analysis= is given and \p PassName matches the regular expression in
918 /// -Rpass, then the remark will be emitted. \p Fn is the function triggering
919 /// the remark, \p Loc is the debug location where the diagnostic is
920 /// generated. \p Msg is the message string to use.
921 void emitOptimizationRemarkAnalysis(LLVMContext &Ctx, const char *PassName,
923 const DiagnosticLocation &Loc,
926 /// \brief Legacy interface to emit an optimization analysis remark related to
927 /// messages about floating-point non-commutativity. Use
928 /// (Machine)OptimizationRemarkEmitter instead.
930 /// \p PassName is the name of the pass emitting the message. If
931 /// -Rpass-analysis= is given and \p PassName matches the regular expression in
932 /// -Rpass, then the remark will be emitted. \p Fn is the function triggering
933 /// the remark, \p Loc is the debug location where the diagnostic is
934 /// generated. \p Msg is the message string to use.
935 void emitOptimizationRemarkAnalysisFPCommute(LLVMContext &Ctx,
936 const char *PassName,
938 const DiagnosticLocation &Loc,
941 /// \brief Legacy interface to emit an optimization analysis remark related to
942 /// messages about pointer aliasing. Use (Machine)OptimizationRemarkEmitter
945 /// \p PassName is the name of the pass emitting the message.
946 /// If -Rpass-analysis= is given and \p PassName matches the regular expression
947 /// in -Rpass, then the remark will be emitted. \p Fn is the function triggering
948 /// the remark, \p Loc is the debug location where the diagnostic is generated.
949 /// \p Msg is the message string to use.
950 void emitOptimizationRemarkAnalysisAliasing(LLVMContext &Ctx,
951 const char *PassName,
953 const DiagnosticLocation &Loc,
956 /// Diagnostic information for optimization failures.
957 class DiagnosticInfoOptimizationFailure : public DiagnosticInfoIROptimization {
959 /// \p Fn is the function where the diagnostic is being emitted. \p Loc is
960 /// the location information to use in the diagnostic. If line table
961 /// information is available, the diagnostic will include the source code
962 /// location. \p Msg is the message to show. Note that this class does not
963 /// copy this message, so this reference must be valid for the whole life time
964 /// of the diagnostic.
965 DiagnosticInfoOptimizationFailure(const Function &Fn,
966 const DiagnosticLocation &Loc,
968 : DiagnosticInfoIROptimization(DK_OptimizationFailure, DS_Warning,
969 nullptr, Fn, Loc, Msg) {}
971 /// \p PassName is the name of the pass emitting this diagnostic. \p
972 /// RemarkName is a textual identifier for the remark (single-word,
973 /// camel-case). \p Loc is the debug location and \p CodeRegion is the
974 /// region that the optimization operates on (currently basic block is
976 DiagnosticInfoOptimizationFailure(const char *PassName, StringRef RemarkName,
977 const DiagnosticLocation &Loc,
978 const Value *CodeRegion);
980 static bool classof(const DiagnosticInfo *DI) {
981 return DI->getKind() == DK_OptimizationFailure;
984 /// \see DiagnosticInfoOptimizationBase::isEnabled.
985 bool isEnabled() const override;
988 /// Diagnostic information for unsupported feature in backend.
989 class DiagnosticInfoUnsupported : public DiagnosticInfoWithLocationBase {
994 /// \p Fn is the function where the diagnostic is being emitted. \p Loc is
995 /// the location information to use in the diagnostic. If line table
996 /// information is available, the diagnostic will include the source code
997 /// location. \p Msg is the message to show. Note that this class does not
998 /// copy this message, so this reference must be valid for the whole life time
999 /// of the diagnostic.
1000 DiagnosticInfoUnsupported(
1001 const Function &Fn, const Twine &Msg,
1002 const DiagnosticLocation &Loc = DiagnosticLocation(),
1003 DiagnosticSeverity Severity = DS_Error)
1004 : DiagnosticInfoWithLocationBase(DK_Unsupported, Severity, Fn, Loc),
1007 static bool classof(const DiagnosticInfo *DI) {
1008 return DI->getKind() == DK_Unsupported;
1011 const Twine &getMessage() const { return Msg; }
1013 void print(DiagnosticPrinter &DP) const override;
1016 } // end namespace llvm
1018 #endif // LLVM_IR_DIAGNOSTICINFO_H