AsmWriter/Bitcode: MDCompileUnit
[oota-llvm.git] / include / llvm / IR / DebugInfoMetadata.h
1 //===- llvm/IR/DebugInfoMetadata.h - Debug info metadata --------*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // Declarations for metadata specific to debug info.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #ifndef LLVM_IR_DEBUGINFOMETADATA_H
15 #define LLVM_IR_DEBUGINFOMETADATA_H
16
17 #include "llvm/IR/Metadata.h"
18 #include "llvm/Support/Dwarf.h"
19
20 // Helper macros for defining get() overrides.
21 #define DEFINE_MDNODE_GET_UNPACK_IMPL(...) __VA_ARGS__
22 #define DEFINE_MDNODE_GET_UNPACK(ARGS) DEFINE_MDNODE_GET_UNPACK_IMPL ARGS
23 #define DEFINE_MDNODE_GET(CLASS, FORMAL, ARGS)                                 \
24   static CLASS *get(LLVMContext &Context, DEFINE_MDNODE_GET_UNPACK(FORMAL)) {  \
25     return getImpl(Context, DEFINE_MDNODE_GET_UNPACK(ARGS), Uniqued);          \
26   }                                                                            \
27   static CLASS *getIfExists(LLVMContext &Context,                              \
28                             DEFINE_MDNODE_GET_UNPACK(FORMAL)) {                \
29     return getImpl(Context, DEFINE_MDNODE_GET_UNPACK(ARGS), Uniqued,           \
30                    /* ShouldCreate */ false);                                  \
31   }                                                                            \
32   static CLASS *getDistinct(LLVMContext &Context,                              \
33                             DEFINE_MDNODE_GET_UNPACK(FORMAL)) {                \
34     return getImpl(Context, DEFINE_MDNODE_GET_UNPACK(ARGS), Distinct);         \
35   }                                                                            \
36   static Temp##CLASS getTemporary(LLVMContext &Context,                        \
37                                   DEFINE_MDNODE_GET_UNPACK(FORMAL)) {          \
38     return Temp##CLASS(                                                        \
39         getImpl(Context, DEFINE_MDNODE_GET_UNPACK(ARGS), Temporary));          \
40   }
41
42 namespace llvm {
43
44 /// \brief Debug location.
45 ///
46 /// A debug location in source code, used for debug info and otherwise.
47 class MDLocation : public MDNode {
48   friend class LLVMContextImpl;
49   friend class MDNode;
50
51   MDLocation(LLVMContext &C, StorageType Storage, unsigned Line,
52              unsigned Column, ArrayRef<Metadata *> MDs);
53   ~MDLocation() { dropAllReferences(); }
54
55   static MDLocation *getImpl(LLVMContext &Context, unsigned Line,
56                              unsigned Column, Metadata *Scope,
57                              Metadata *InlinedAt, StorageType Storage,
58                              bool ShouldCreate = true);
59
60   TempMDLocation cloneImpl() const {
61     return getTemporary(getContext(), getLine(), getColumn(), getScope(),
62                         getInlinedAt());
63   }
64
65   // Disallow replacing operands.
66   void replaceOperandWith(unsigned I, Metadata *New) LLVM_DELETED_FUNCTION;
67
68 public:
69   DEFINE_MDNODE_GET(MDLocation,
70                     (unsigned Line, unsigned Column, Metadata *Scope,
71                      Metadata *InlinedAt = nullptr),
72                     (Line, Column, Scope, InlinedAt))
73
74   /// \brief Return a (temporary) clone of this.
75   TempMDLocation clone() const { return cloneImpl(); }
76
77   unsigned getLine() const { return SubclassData32; }
78   unsigned getColumn() const { return SubclassData16; }
79   Metadata *getScope() const { return getOperand(0); }
80   Metadata *getInlinedAt() const {
81     if (getNumOperands() == 2)
82       return getOperand(1);
83     return nullptr;
84   }
85
86   static bool classof(const Metadata *MD) {
87     return MD->getMetadataID() == MDLocationKind;
88   }
89 };
90
91 /// \brief Tagged DWARF-like metadata node.
92 ///
93 /// A metadata node with a DWARF tag (i.e., a constant named \c DW_TAG_*,
94 /// defined in llvm/Support/Dwarf.h).  Called \a DebugNode because it's
95 /// potentially used for non-DWARF output.
96 class DebugNode : public MDNode {
97   friend class LLVMContextImpl;
98   friend class MDNode;
99
100 protected:
101   DebugNode(LLVMContext &C, unsigned ID, StorageType Storage, unsigned Tag,
102             ArrayRef<Metadata *> Ops1, ArrayRef<Metadata *> Ops2 = None)
103       : MDNode(C, ID, Storage, Ops1, Ops2) {
104     assert(Tag < 1u << 16);
105     SubclassData16 = Tag;
106   }
107   ~DebugNode() {}
108
109   template <class Ty> Ty *getOperandAs(unsigned I) const {
110     return cast_or_null<Ty>(getOperand(I));
111   }
112
113   StringRef getStringOperand(unsigned I) const {
114     if (auto *S = getOperandAs<MDString>(I))
115       return S->getString();
116     return StringRef();
117   }
118
119   static MDString *getCanonicalMDString(LLVMContext &Context, StringRef S) {
120     if (S.empty())
121       return nullptr;
122     return MDString::get(Context, S);
123   }
124
125 public:
126   unsigned getTag() const { return SubclassData16; }
127
128   static bool classof(const Metadata *MD) {
129     switch (MD->getMetadataID()) {
130     default:
131       return false;
132     case GenericDebugNodeKind:
133     case MDSubrangeKind:
134     case MDEnumeratorKind:
135     case MDBasicTypeKind:
136     case MDDerivedTypeKind:
137     case MDCompositeTypeKind:
138     case MDSubroutineTypeKind:
139     case MDFileKind:
140     case MDCompileUnitKind:
141     case MDSubprogramKind:
142     case MDLexicalBlockKind:
143     case MDLexicalBlockFileKind:
144     case MDNamespaceKind:
145     case MDTemplateTypeParameterKind:
146     case MDTemplateValueParameterKind:
147     case MDGlobalVariableKind:
148     case MDLocalVariableKind:
149     case MDExpressionKind:
150     case MDObjCPropertyKind:
151     case MDImportedEntityKind:
152       return true;
153     }
154   }
155 };
156
157 /// \brief Generic tagged DWARF-like metadata node.
158 ///
159 /// An un-specialized DWARF-like metadata node.  The first operand is a
160 /// (possibly empty) null-separated \a MDString header that contains arbitrary
161 /// fields.  The remaining operands are \a dwarf_operands(), and are pointers
162 /// to other metadata.
163 class GenericDebugNode : public DebugNode {
164   friend class LLVMContextImpl;
165   friend class MDNode;
166
167   GenericDebugNode(LLVMContext &C, StorageType Storage, unsigned Hash,
168                    unsigned Tag, ArrayRef<Metadata *> Ops1,
169                    ArrayRef<Metadata *> Ops2)
170       : DebugNode(C, GenericDebugNodeKind, Storage, Tag, Ops1, Ops2) {
171     setHash(Hash);
172   }
173   ~GenericDebugNode() { dropAllReferences(); }
174
175   void setHash(unsigned Hash) { SubclassData32 = Hash; }
176   void recalculateHash();
177
178   static GenericDebugNode *getImpl(LLVMContext &Context, unsigned Tag,
179                                    StringRef Header,
180                                    ArrayRef<Metadata *> DwarfOps,
181                                    StorageType Storage,
182                                    bool ShouldCreate = true) {
183     return getImpl(Context, Tag, getCanonicalMDString(Context, Header),
184                    DwarfOps, Storage, ShouldCreate);
185   }
186
187   static GenericDebugNode *getImpl(LLVMContext &Context, unsigned Tag,
188                                    MDString *Header,
189                                    ArrayRef<Metadata *> DwarfOps,
190                                    StorageType Storage,
191                                    bool ShouldCreate = true);
192
193   TempGenericDebugNode cloneImpl() const {
194     return getTemporary(
195         getContext(), getTag(), getHeader(),
196         SmallVector<Metadata *, 4>(dwarf_op_begin(), dwarf_op_end()));
197   }
198
199 public:
200   unsigned getHash() const { return SubclassData32; }
201
202   DEFINE_MDNODE_GET(GenericDebugNode, (unsigned Tag, StringRef Header,
203                                        ArrayRef<Metadata *> DwarfOps),
204                     (Tag, Header, DwarfOps))
205   DEFINE_MDNODE_GET(GenericDebugNode, (unsigned Tag, MDString *Header,
206                                        ArrayRef<Metadata *> DwarfOps),
207                     (Tag, Header, DwarfOps))
208
209   /// \brief Return a (temporary) clone of this.
210   TempGenericDebugNode clone() const { return cloneImpl(); }
211
212   unsigned getTag() const { return SubclassData16; }
213   StringRef getHeader() const { return getStringOperand(0); }
214
215   op_iterator dwarf_op_begin() const { return op_begin() + 1; }
216   op_iterator dwarf_op_end() const { return op_end(); }
217   op_range dwarf_operands() const {
218     return op_range(dwarf_op_begin(), dwarf_op_end());
219   }
220
221   unsigned getNumDwarfOperands() const { return getNumOperands() - 1; }
222   const MDOperand &getDwarfOperand(unsigned I) const {
223     return getOperand(I + 1);
224   }
225   void replaceDwarfOperandWith(unsigned I, Metadata *New) {
226     replaceOperandWith(I + 1, New);
227   }
228
229   static bool classof(const Metadata *MD) {
230     return MD->getMetadataID() == GenericDebugNodeKind;
231   }
232 };
233
234 /// \brief Array subrange.
235 ///
236 /// TODO: Merge into node for DW_TAG_array_type, which should have a custom
237 /// type.
238 class MDSubrange : public DebugNode {
239   friend class LLVMContextImpl;
240   friend class MDNode;
241
242   int64_t Count;
243   int64_t Lo;
244
245   MDSubrange(LLVMContext &C, StorageType Storage, int64_t Count, int64_t Lo)
246       : DebugNode(C, MDSubrangeKind, Storage, dwarf::DW_TAG_subrange_type,
247                   None),
248         Count(Count), Lo(Lo) {}
249   ~MDSubrange() {}
250
251   static MDSubrange *getImpl(LLVMContext &Context, int64_t Count, int64_t Lo,
252                              StorageType Storage, bool ShouldCreate = true);
253
254   TempMDSubrange cloneImpl() const {
255     return getTemporary(getContext(), getCount(), getLo());
256   }
257
258 public:
259   DEFINE_MDNODE_GET(MDSubrange, (int64_t Count, int64_t Lo = 0), (Count, Lo))
260
261   TempMDSubrange clone() const { return cloneImpl(); }
262
263   int64_t getLo() const { return Lo; }
264   int64_t getCount() const { return Count; }
265
266   static bool classof(const Metadata *MD) {
267     return MD->getMetadataID() == MDSubrangeKind;
268   }
269 };
270
271 /// \brief Enumeration value.
272 ///
273 /// TODO: Add a pointer to the context (DW_TAG_enumeration_type) once that no
274 /// longer creates a type cycle.
275 class MDEnumerator : public DebugNode {
276   friend class LLVMContextImpl;
277   friend class MDNode;
278
279   int64_t Value;
280
281   MDEnumerator(LLVMContext &C, StorageType Storage, int64_t Value,
282                ArrayRef<Metadata *> Ops)
283       : DebugNode(C, MDEnumeratorKind, Storage, dwarf::DW_TAG_enumerator, Ops),
284         Value(Value) {}
285   ~MDEnumerator() {}
286
287   static MDEnumerator *getImpl(LLVMContext &Context, int64_t Value,
288                                StringRef Name, StorageType Storage,
289                                bool ShouldCreate = true) {
290     return getImpl(Context, Value, getCanonicalMDString(Context, Name), Storage,
291                    ShouldCreate);
292   }
293   static MDEnumerator *getImpl(LLVMContext &Context, int64_t Value,
294                                MDString *Name, StorageType Storage,
295                                bool ShouldCreate = true);
296
297   TempMDEnumerator cloneImpl() const {
298     return getTemporary(getContext(), getValue(), getName());
299   }
300
301 public:
302   DEFINE_MDNODE_GET(MDEnumerator, (int64_t Value, StringRef Name),
303                     (Value, Name))
304   DEFINE_MDNODE_GET(MDEnumerator, (int64_t Value, MDString *Name),
305                     (Value, Name))
306
307   TempMDEnumerator clone() const { return cloneImpl(); }
308
309   int64_t getValue() const { return Value; }
310   StringRef getName() const { return getStringOperand(0); }
311
312   MDString *getRawName() const { return getOperandAs<MDString>(0); }
313
314   static bool classof(const Metadata *MD) {
315     return MD->getMetadataID() == MDEnumeratorKind;
316   }
317 };
318
319 /// \brief Base class for scope-like contexts.
320 ///
321 /// Base class for lexical scopes and types (which are also declaration
322 /// contexts).
323 ///
324 /// TODO: Separate the concepts of declaration contexts and lexical scopes.
325 class MDScope : public DebugNode {
326 protected:
327   MDScope(LLVMContext &C, unsigned ID, StorageType Storage, unsigned Tag,
328           ArrayRef<Metadata *> Ops)
329       : DebugNode(C, ID, Storage, Tag, Ops) {}
330   ~MDScope() {}
331
332 public:
333   Metadata *getFile() const { return getOperand(0); }
334
335   static bool classof(const Metadata *MD) {
336     switch (MD->getMetadataID()) {
337     default:
338       return false;
339     case MDBasicTypeKind:
340     case MDDerivedTypeKind:
341     case MDCompositeTypeKind:
342     case MDSubroutineTypeKind:
343     case MDFileKind:
344     case MDCompileUnitKind:
345     case MDSubprogramKind:
346     case MDLexicalBlockKind:
347     case MDLexicalBlockFileKind:
348     case MDNamespaceKind:
349       return true;
350     }
351   }
352 };
353
354 /// \brief Base class for types.
355 ///
356 /// TODO: Remove the hardcoded name and context, since many types don't use
357 /// them.
358 /// TODO: Split up flags.
359 class MDType : public MDScope {
360   unsigned Line;
361   unsigned SizeInBits;
362   unsigned AlignInBits;
363   unsigned OffsetInBits;
364   unsigned Flags;
365
366 protected:
367   MDType(LLVMContext &C, unsigned ID, StorageType Storage, unsigned Tag,
368          unsigned Line, unsigned SizeInBits, unsigned AlignInBits,
369          unsigned OffsetInBits, unsigned Flags, ArrayRef<Metadata *> Ops)
370       : MDScope(C, ID, Storage, Tag, Ops), Line(Line), SizeInBits(SizeInBits),
371         AlignInBits(AlignInBits), OffsetInBits(OffsetInBits), Flags(Flags) {}
372   ~MDType() {}
373
374 public:
375   unsigned getLine() const { return Line; }
376   unsigned getSizeInBits() const { return SizeInBits; }
377   unsigned getAlignInBits() const { return AlignInBits; }
378   unsigned getOffsetInBits() const { return OffsetInBits; }
379   unsigned getFlags() const { return Flags; }
380
381   Metadata *getScope() const { return getOperand(1); }
382   StringRef getName() const { return getStringOperand(2); }
383
384   MDString *getRawName() const { return getOperandAs<MDString>(2); }
385
386   static bool classof(const Metadata *MD) {
387     switch (MD->getMetadataID()) {
388     default:
389       return false;
390     case MDBasicTypeKind:
391     case MDDerivedTypeKind:
392     case MDCompositeTypeKind:
393     case MDSubroutineTypeKind:
394       return true;
395     }
396   }
397 };
398
399 /// \brief Basic type.
400 ///
401 /// TODO: Split out DW_TAG_unspecified_type.
402 /// TODO: Drop unused accessors.
403 class MDBasicType : public MDType {
404   friend class LLVMContextImpl;
405   friend class MDNode;
406
407   unsigned Encoding;
408
409   MDBasicType(LLVMContext &C, StorageType Storage, unsigned Tag,
410               unsigned SizeInBits, unsigned AlignInBits, unsigned Encoding,
411               ArrayRef<Metadata *> Ops)
412       : MDType(C, MDBasicTypeKind, Storage, Tag, 0, SizeInBits, AlignInBits, 0,
413                0, Ops),
414         Encoding(Encoding) {}
415   ~MDBasicType() {}
416
417   static MDBasicType *getImpl(LLVMContext &Context, unsigned Tag,
418                               StringRef Name, unsigned SizeInBits,
419                               unsigned AlignInBits, unsigned Encoding,
420                               StorageType Storage, bool ShouldCreate = true) {
421     return getImpl(Context, Tag, getCanonicalMDString(Context, Name),
422                    SizeInBits, AlignInBits, Encoding, Storage, ShouldCreate);
423   }
424   static MDBasicType *getImpl(LLVMContext &Context, unsigned Tag,
425                               MDString *Name, unsigned SizeInBits,
426                               unsigned AlignInBits, unsigned Encoding,
427                               StorageType Storage, bool ShouldCreate = true);
428
429   TempMDBasicType cloneImpl() const {
430     return getTemporary(getContext(), getTag(), getName(), getSizeInBits(),
431                         getAlignInBits(), getEncoding());
432   }
433
434 public:
435   DEFINE_MDNODE_GET(MDBasicType,
436                     (unsigned Tag, StringRef Name, unsigned SizeInBits,
437                      unsigned AlignInBits, unsigned Encoding),
438                     (Tag, Name, SizeInBits, AlignInBits, Encoding))
439   DEFINE_MDNODE_GET(MDBasicType,
440                     (unsigned Tag, MDString *Name, unsigned SizeInBits,
441                      unsigned AlignInBits, unsigned Encoding),
442                     (Tag, Name, SizeInBits, AlignInBits, Encoding))
443
444   TempMDBasicType clone() const { return cloneImpl(); }
445
446   unsigned getEncoding() const { return Encoding; }
447
448   static bool classof(const Metadata *MD) {
449     return MD->getMetadataID() == MDBasicTypeKind;
450   }
451 };
452
453 /// \brief Base class for MDDerivedType and MDCompositeType.
454 ///
455 /// TODO: Delete; they're not really related.
456 class MDDerivedTypeBase : public MDType {
457 protected:
458   MDDerivedTypeBase(LLVMContext &C, unsigned ID, StorageType Storage,
459                     unsigned Tag, unsigned Line, unsigned SizeInBits,
460                     unsigned AlignInBits, unsigned OffsetInBits, unsigned Flags,
461                     ArrayRef<Metadata *> Ops)
462       : MDType(C, ID, Storage, Tag, Line, SizeInBits, AlignInBits, OffsetInBits,
463                Flags, Ops) {}
464   ~MDDerivedTypeBase() {}
465
466 public:
467   Metadata *getBaseType() const { return getOperand(3); }
468
469   static bool classof(const Metadata *MD) {
470     return MD->getMetadataID() == MDDerivedTypeKind ||
471            MD->getMetadataID() == MDCompositeTypeKind ||
472            MD->getMetadataID() == MDSubroutineTypeKind;
473   }
474 };
475
476 /// \brief Derived types.
477 ///
478 /// This includes qualified types, pointers, references, friends, typedefs, and
479 /// class members.
480 ///
481 /// TODO: Split out members (inheritance, fields, methods, etc.).
482 class MDDerivedType : public MDDerivedTypeBase {
483   friend class LLVMContextImpl;
484   friend class MDNode;
485
486   MDDerivedType(LLVMContext &C, StorageType Storage, unsigned Tag,
487                 unsigned Line, unsigned SizeInBits, unsigned AlignInBits,
488                 unsigned OffsetInBits, unsigned Flags, ArrayRef<Metadata *> Ops)
489       : MDDerivedTypeBase(C, MDDerivedTypeKind, Storage, Tag, Line, SizeInBits,
490                           AlignInBits, OffsetInBits, Flags, Ops) {}
491   ~MDDerivedType() {}
492
493   static MDDerivedType *getImpl(LLVMContext &Context, unsigned Tag,
494                                 StringRef Name, Metadata *File, unsigned Line,
495                                 Metadata *Scope, Metadata *BaseType,
496                                 unsigned SizeInBits, unsigned AlignInBits,
497                                 unsigned OffsetInBits, unsigned Flags,
498                                 Metadata *ExtraData, StorageType Storage,
499                                 bool ShouldCreate = true) {
500     return getImpl(Context, Tag, getCanonicalMDString(Context, Name), File,
501                    Line, Scope, BaseType, SizeInBits, AlignInBits, OffsetInBits,
502                    Flags, ExtraData, Storage, ShouldCreate);
503   }
504   static MDDerivedType *getImpl(LLVMContext &Context, unsigned Tag,
505                                 MDString *Name, Metadata *File, unsigned Line,
506                                 Metadata *Scope, Metadata *BaseType,
507                                 unsigned SizeInBits, unsigned AlignInBits,
508                                 unsigned OffsetInBits, unsigned Flags,
509                                 Metadata *ExtraData, StorageType Storage,
510                                 bool ShouldCreate = true);
511
512   TempMDDerivedType cloneImpl() const {
513     return getTemporary(getContext(), getTag(), getName(), getFile(), getLine(),
514                         getScope(), getBaseType(), getSizeInBits(),
515                         getAlignInBits(), getOffsetInBits(), getFlags(),
516                         getExtraData());
517   }
518
519 public:
520   DEFINE_MDNODE_GET(MDDerivedType,
521                     (unsigned Tag, MDString *Name, Metadata *File,
522                      unsigned Line, Metadata *Scope, Metadata *BaseType,
523                      unsigned SizeInBits, unsigned AlignInBits,
524                      unsigned OffsetInBits, unsigned Flags,
525                      Metadata *ExtraData = nullptr),
526                     (Tag, Name, File, Line, Scope, BaseType, SizeInBits,
527                      AlignInBits, OffsetInBits, Flags, ExtraData))
528   DEFINE_MDNODE_GET(MDDerivedType,
529                     (unsigned Tag, StringRef Name, Metadata *File,
530                      unsigned Line, Metadata *Scope, Metadata *BaseType,
531                      unsigned SizeInBits, unsigned AlignInBits,
532                      unsigned OffsetInBits, unsigned Flags,
533                      Metadata *ExtraData = nullptr),
534                     (Tag, Name, File, Line, Scope, BaseType, SizeInBits,
535                      AlignInBits, OffsetInBits, Flags, ExtraData))
536
537   TempMDDerivedType clone() const { return cloneImpl(); }
538
539   /// \brief Get extra data associated with this derived type.
540   ///
541   /// Class type for pointer-to-members, objective-c property node for ivars,
542   /// or global constant wrapper for static members.
543   ///
544   /// TODO: Separate out types that need this extra operand: pointer-to-member
545   /// types and member fields (static members and ivars).
546   Metadata *getExtraData() const { return getOperand(4); }
547
548   static bool classof(const Metadata *MD) {
549     return MD->getMetadataID() == MDDerivedTypeKind;
550   }
551 };
552
553 /// \brief Base class for MDCompositeType and MDSubroutineType.
554 ///
555 /// TODO: Delete; they're not really related.
556 class MDCompositeTypeBase : public MDDerivedTypeBase {
557   unsigned RuntimeLang;
558
559 protected:
560   MDCompositeTypeBase(LLVMContext &C, unsigned ID, StorageType Storage,
561                       unsigned Tag, unsigned Line, unsigned RuntimeLang,
562                       unsigned SizeInBits, unsigned AlignInBits,
563                       unsigned OffsetInBits, unsigned Flags,
564                       ArrayRef<Metadata *> Ops)
565       : MDDerivedTypeBase(C, ID, Storage, Tag, Line, SizeInBits, AlignInBits,
566                           OffsetInBits, Flags, Ops),
567         RuntimeLang(RuntimeLang) {}
568   ~MDCompositeTypeBase() {}
569
570 public:
571   Metadata *getElements() const { return getOperand(4); }
572   Metadata *getVTableHolder() const { return getOperand(5); }
573   Metadata *getTemplateParams() const { return getOperand(6); }
574   StringRef getIdentifier() const { return getStringOperand(7); }
575   unsigned getRuntimeLang() const { return RuntimeLang; }
576
577   MDString *getRawIdentifier() const { return getOperandAs<MDString>(7); }
578
579   static bool classof(const Metadata *MD) {
580     return MD->getMetadataID() == MDCompositeTypeKind ||
581            MD->getMetadataID() == MDSubroutineTypeKind;
582   }
583 };
584
585 /// \brief Composite types.
586 ///
587 /// TODO: Detach from DerivedTypeBase (split out MDEnumType?).
588 /// TODO: Create a custom, unrelated node for DW_TAG_array_type.
589 class MDCompositeType : public MDCompositeTypeBase {
590   friend class LLVMContextImpl;
591   friend class MDNode;
592
593   MDCompositeType(LLVMContext &C, StorageType Storage, unsigned Tag,
594                   unsigned Line, unsigned RuntimeLang, unsigned SizeInBits,
595                   unsigned AlignInBits, unsigned OffsetInBits, unsigned Flags,
596                   ArrayRef<Metadata *> Ops)
597       : MDCompositeTypeBase(C, MDCompositeTypeKind, Storage, Tag, Line,
598                             RuntimeLang, SizeInBits, AlignInBits, OffsetInBits,
599                             Flags, Ops) {}
600   ~MDCompositeType() {}
601
602   static MDCompositeType *
603   getImpl(LLVMContext &Context, unsigned Tag, StringRef Name, Metadata *File,
604           unsigned Line, Metadata *Scope, Metadata *BaseType,
605           unsigned SizeInBits, unsigned AlignInBits, unsigned OffsetInBits,
606           unsigned Flags, Metadata *Elements, unsigned RuntimeLang,
607           Metadata *VTableHolder, Metadata *TemplateParams,
608           StringRef Identifier, StorageType Storage, bool ShouldCreate = true) {
609     return getImpl(Context, Tag, getCanonicalMDString(Context, Name), File,
610                    Line, Scope, BaseType, SizeInBits, AlignInBits, OffsetInBits,
611                    Flags, Elements, RuntimeLang, VTableHolder, TemplateParams,
612                    getCanonicalMDString(Context, Identifier), Storage,
613                    ShouldCreate);
614   }
615   static MDCompositeType *
616   getImpl(LLVMContext &Context, unsigned Tag, MDString *Name, Metadata *File,
617           unsigned Line, Metadata *Scope, Metadata *BaseType,
618           unsigned SizeInBits, unsigned AlignInBits, unsigned OffsetInBits,
619           unsigned Flags, Metadata *Elements, unsigned RuntimeLang,
620           Metadata *VTableHolder, Metadata *TemplateParams,
621           MDString *Identifier, StorageType Storage, bool ShouldCreate = true);
622
623   TempMDCompositeType cloneImpl() const {
624     return getTemporary(getContext(), getTag(), getName(), getFile(), getLine(),
625                         getScope(), getBaseType(), getSizeInBits(),
626                         getAlignInBits(), getOffsetInBits(), getFlags(),
627                         getElements(), getRuntimeLang(), getVTableHolder(),
628                         getTemplateParams(), getIdentifier());
629   }
630
631 public:
632   DEFINE_MDNODE_GET(MDCompositeType,
633                     (unsigned Tag, StringRef Name, Metadata *File,
634                      unsigned Line, Metadata *Scope, Metadata *BaseType,
635                      unsigned SizeInBits, unsigned AlignInBits,
636                      unsigned OffsetInBits, unsigned Flags, Metadata *Elements,
637                      unsigned RuntimeLang, Metadata *VTableHolder,
638                      Metadata *TemplateParams = nullptr,
639                      StringRef Identifier = ""),
640                     (Tag, Name, File, Line, Scope, BaseType, SizeInBits,
641                      AlignInBits, OffsetInBits, Flags, Elements, RuntimeLang,
642                      VTableHolder, TemplateParams, Identifier))
643   DEFINE_MDNODE_GET(MDCompositeType,
644                     (unsigned Tag, MDString *Name, Metadata *File,
645                      unsigned Line, Metadata *Scope, Metadata *BaseType,
646                      unsigned SizeInBits, unsigned AlignInBits,
647                      unsigned OffsetInBits, unsigned Flags, Metadata *Elements,
648                      unsigned RuntimeLang, Metadata *VTableHolder,
649                      Metadata *TemplateParams = nullptr,
650                      MDString *Identifier = nullptr),
651                     (Tag, Name, File, Line, Scope, BaseType, SizeInBits,
652                      AlignInBits, OffsetInBits, Flags, Elements, RuntimeLang,
653                      VTableHolder, TemplateParams, Identifier))
654
655   TempMDCompositeType clone() const { return cloneImpl(); }
656
657   static bool classof(const Metadata *MD) {
658     return MD->getMetadataID() == MDCompositeTypeKind;
659   }
660 };
661
662 /// \brief Type array for a subprogram.
663 ///
664 /// TODO: Detach from CompositeType, and fold the array of types in directly
665 /// as operands.
666 class MDSubroutineType : public MDCompositeTypeBase {
667   friend class LLVMContextImpl;
668   friend class MDNode;
669
670   MDSubroutineType(LLVMContext &C, StorageType Storage, unsigned Flags,
671                    ArrayRef<Metadata *> Ops)
672       : MDCompositeTypeBase(C, MDSubroutineTypeKind, Storage,
673                             dwarf::DW_TAG_subroutine_type, 0, 0, 0, 0, 0, Flags,
674                             Ops) {}
675   ~MDSubroutineType() {}
676
677   static MDSubroutineType *getImpl(LLVMContext &Context, unsigned Flags,
678                                    Metadata *TypeArray, StorageType Storage,
679                                    bool ShouldCreate = true);
680
681   TempMDSubroutineType cloneImpl() const {
682     return getTemporary(getContext(), getFlags(), getTypeArray());
683   }
684
685 public:
686   DEFINE_MDNODE_GET(MDSubroutineType, (unsigned Flags, Metadata *TypeArray),
687                     (Flags, TypeArray))
688
689   TempMDSubroutineType clone() const { return cloneImpl(); }
690
691   Metadata *getTypeArray() const { return getElements(); }
692
693   static bool classof(const Metadata *MD) {
694     return MD->getMetadataID() == MDSubroutineTypeKind;
695   }
696 };
697
698 /// \brief File.
699 ///
700 /// TODO: Merge with directory/file node (including users).
701 /// TODO: Canonicalize paths on creation.
702 class MDFile : public MDScope {
703   friend class LLVMContextImpl;
704   friend class MDNode;
705
706   MDFile(LLVMContext &C, StorageType Storage, ArrayRef<Metadata *> Ops)
707       : MDScope(C, MDFileKind, Storage, dwarf::DW_TAG_file_type, Ops) {}
708   ~MDFile() {}
709
710   static MDFile *getImpl(LLVMContext &Context, StringRef Filename,
711                          StringRef Directory, StorageType Storage,
712                          bool ShouldCreate = true) {
713     return getImpl(Context, getCanonicalMDString(Context, Filename),
714                    getCanonicalMDString(Context, Directory), Storage,
715                    ShouldCreate);
716   }
717   static MDFile *getImpl(LLVMContext &Context, MDString *Filename,
718                          MDString *Directory, StorageType Storage,
719                          bool ShouldCreate = true);
720
721   TempMDFile cloneImpl() const {
722     return getTemporary(getContext(), getFilename(), getDirectory());
723   }
724
725 public:
726   DEFINE_MDNODE_GET(MDFile, (StringRef Filename, StringRef Directory),
727                     (Filename, Directory))
728   DEFINE_MDNODE_GET(MDFile, (MDString * Filename, MDString *Directory),
729                     (Filename, Directory))
730
731   TempMDFile clone() const { return cloneImpl(); }
732
733   MDTuple *getFileNode() const { return cast<MDTuple>(getOperand(0)); }
734
735   StringRef getFilename() const {
736     if (auto *S = getRawFilename())
737       return S->getString();
738     return StringRef();
739   }
740   StringRef getDirectory() const {
741     if (auto *S = getRawDirectory())
742       return S->getString();
743     return StringRef();
744   }
745
746   MDString *getRawFilename() const {
747     return cast_or_null<MDString>(getFileNode()->getOperand(0));
748   }
749   MDString *getRawDirectory() const {
750     return cast_or_null<MDString>(getFileNode()->getOperand(1));
751   }
752
753   static bool classof(const Metadata *MD) {
754     return MD->getMetadataID() == MDFileKind;
755   }
756 };
757
758 /// \brief Compile unit.
759 class MDCompileUnit : public MDScope {
760   friend class LLVMContextImpl;
761   friend class MDNode;
762
763   unsigned SourceLanguage;
764   bool IsOptimized;
765   unsigned RuntimeVersion;
766   unsigned EmissionKind;
767
768   MDCompileUnit(LLVMContext &C, StorageType Storage, unsigned SourceLanguage,
769                 bool IsOptimized, unsigned RuntimeVersion,
770                 unsigned EmissionKind, ArrayRef<Metadata *> Ops)
771       : MDScope(C, MDCompileUnitKind, Storage, dwarf::DW_TAG_compile_unit, Ops),
772         SourceLanguage(SourceLanguage), IsOptimized(IsOptimized),
773         RuntimeVersion(RuntimeVersion), EmissionKind(EmissionKind) {}
774   ~MDCompileUnit() {}
775
776   static MDCompileUnit *
777   getImpl(LLVMContext &Context, unsigned SourceLanguage, Metadata *File,
778           StringRef Producer, bool IsOptimized, StringRef Flags,
779           unsigned RuntimeVersion, StringRef SplitDebugFilename,
780           unsigned EmissionKind, Metadata *EnumTypes, Metadata *RetainedTypes,
781           Metadata *Subprograms, Metadata *GlobalVariables,
782           Metadata *ImportedEntities, StorageType Storage,
783           bool ShouldCreate = true) {
784     return getImpl(Context, SourceLanguage, File,
785                    getCanonicalMDString(Context, Producer), IsOptimized,
786                    getCanonicalMDString(Context, Flags), RuntimeVersion,
787                    getCanonicalMDString(Context, SplitDebugFilename),
788                    EmissionKind, EnumTypes, RetainedTypes, Subprograms,
789                    GlobalVariables, ImportedEntities, Storage, ShouldCreate);
790   }
791   static MDCompileUnit *
792   getImpl(LLVMContext &Context, unsigned SourceLanguage, Metadata *File,
793           MDString *Producer, bool IsOptimized, MDString *Flags,
794           unsigned RuntimeVersion, MDString *SplitDebugFilename,
795           unsigned EmissionKind, Metadata *EnumTypes, Metadata *RetainedTypes,
796           Metadata *Subprograms, Metadata *GlobalVariables,
797           Metadata *ImportedEntities, StorageType Storage,
798           bool ShouldCreate = true);
799
800   TempMDCompileUnit cloneImpl() const {
801     return getTemporary(
802         getContext(), getSourceLanguage(), getFile(), getProducer(),
803         isOptimized(), getFlags(), getRuntimeVersion(), getSplitDebugFilename(),
804         getEmissionKind(), getEnumTypes(), getRetainedTypes(), getSubprograms(),
805         getGlobalVariables(), getImportedEntities());
806   }
807
808 public:
809   DEFINE_MDNODE_GET(MDCompileUnit,
810                     (unsigned SourceLanguage, Metadata *File,
811                      StringRef Producer, bool IsOptimized, StringRef Flags,
812                      unsigned RuntimeVersion, StringRef SplitDebugFilename,
813                      unsigned EmissionKind, Metadata *EnumTypes,
814                      Metadata *RetainedTypes, Metadata *Subprograms,
815                      Metadata *GlobalVariables, Metadata *ImportedEntities),
816                     (SourceLanguage, File, Producer, IsOptimized, Flags,
817                      RuntimeVersion, SplitDebugFilename, EmissionKind,
818                      EnumTypes, RetainedTypes, Subprograms, GlobalVariables,
819                      ImportedEntities))
820   DEFINE_MDNODE_GET(MDCompileUnit,
821                     (unsigned SourceLanguage, Metadata *File,
822                      MDString *Producer, bool IsOptimized, MDString *Flags,
823                      unsigned RuntimeVersion, MDString *SplitDebugFilename,
824                      unsigned EmissionKind, Metadata *EnumTypes,
825                      Metadata *RetainedTypes, Metadata *Subprograms,
826                      Metadata *GlobalVariables, Metadata *ImportedEntities),
827                     (SourceLanguage, File, Producer, IsOptimized, Flags,
828                      RuntimeVersion, SplitDebugFilename, EmissionKind,
829                      EnumTypes, RetainedTypes, Subprograms, GlobalVariables,
830                      ImportedEntities))
831
832   TempMDCompileUnit clone() const { return cloneImpl(); }
833
834   unsigned getSourceLanguage() const { return SourceLanguage; }
835   bool isOptimized() const { return IsOptimized; }
836   unsigned getRuntimeVersion() const { return RuntimeVersion; }
837   unsigned getEmissionKind() const { return EmissionKind; }
838   StringRef getProducer() const { return getStringOperand(1); }
839   StringRef getFlags() const { return getStringOperand(2); }
840   StringRef getSplitDebugFilename() const { return getStringOperand(3); }
841   Metadata *getEnumTypes() const { return getOperand(4); }
842   Metadata *getRetainedTypes() const { return getOperand(5); }
843   Metadata *getSubprograms() const { return getOperand(6); }
844   Metadata *getGlobalVariables() const { return getOperand(7); }
845   Metadata *getImportedEntities() const { return getOperand(8); }
846
847   MDString *getRawProducer() const { return getOperandAs<MDString>(1); }
848   MDString *getRawFlags() const { return getOperandAs<MDString>(2); }
849   MDString *getRawSplitDebugFilename() const {
850     return getOperandAs<MDString>(3);
851   }
852
853   static bool classof(const Metadata *MD) {
854     return MD->getMetadataID() == MDCompileUnitKind;
855   }
856 };
857
858 /// \brief Subprogram description.
859 ///
860 /// TODO: Remove DisplayName.  It's always equal to Name.
861 /// TODO: Split up flags.
862 class MDSubprogram : public MDScope {
863   friend class LLVMContextImpl;
864   friend class MDNode;
865
866   unsigned Line;
867   unsigned ScopeLine;
868   unsigned Virtuality;
869   unsigned VirtualIndex;
870   unsigned Flags;
871   bool IsLocalToUnit;
872   bool IsDefinition;
873   bool IsOptimized;
874
875   MDSubprogram(LLVMContext &C, StorageType Storage, unsigned Line,
876                unsigned ScopeLine, unsigned Virtuality, unsigned VirtualIndex,
877                unsigned Flags, bool IsLocalToUnit, bool IsDefinition,
878                bool IsOptimized, ArrayRef<Metadata *> Ops)
879       : MDScope(C, MDSubprogramKind, Storage, dwarf::DW_TAG_subprogram, Ops),
880         Line(Line), ScopeLine(ScopeLine), Virtuality(Virtuality),
881         VirtualIndex(VirtualIndex), Flags(Flags), IsLocalToUnit(IsLocalToUnit),
882         IsDefinition(IsDefinition), IsOptimized(IsOptimized) {}
883   ~MDSubprogram() {}
884
885   static MDSubprogram *
886   getImpl(LLVMContext &Context, Metadata *Scope, StringRef Name,
887           StringRef LinkageName, Metadata *File, unsigned Line, Metadata *Type,
888           bool IsLocalToUnit, bool IsDefinition, unsigned ScopeLine,
889           Metadata *ContainingType, unsigned Virtuality, unsigned VirtualIndex,
890           unsigned Flags, bool IsOptimized, Metadata *Function,
891           Metadata *TemplateParams, Metadata *Declaration, Metadata *Variables,
892           StorageType Storage, bool ShouldCreate = true) {
893     return getImpl(Context, Scope, getCanonicalMDString(Context, Name),
894                    getCanonicalMDString(Context, LinkageName), File, Line, Type,
895                    IsLocalToUnit, IsDefinition, ScopeLine, ContainingType,
896                    Virtuality, VirtualIndex, Flags, IsOptimized, Function,
897                    TemplateParams, Declaration, Variables, Storage,
898                    ShouldCreate);
899   }
900   static MDSubprogram *
901   getImpl(LLVMContext &Context, Metadata *Scope, MDString *Name,
902           MDString *LinkageName, Metadata *File, unsigned Line, Metadata *Type,
903           bool IsLocalToUnit, bool IsDefinition, unsigned ScopeLine,
904           Metadata *ContainingType, unsigned Virtuality, unsigned VirtualIndex,
905           unsigned Flags, bool IsOptimized, Metadata *Function,
906           Metadata *TemplateParams, Metadata *Declaration, Metadata *Variables,
907           StorageType Storage, bool ShouldCreate = true);
908
909   TempMDSubprogram cloneImpl() const {
910     return getTemporary(getContext(), getScope(), getName(), getLinkageName(),
911                         getFile(), getLine(), getType(), isLocalToUnit(),
912                         isDefinition(), getScopeLine(), getContainingType(),
913                         getVirtuality(), getVirtualIndex(), getFlags(),
914                         isOptimized(), getFunction(), getTemplateParams(),
915                         getDeclaration(), getVariables());
916   }
917
918 public:
919   DEFINE_MDNODE_GET(
920       MDSubprogram,
921       (Metadata * Scope, StringRef Name, StringRef LinkageName, Metadata *File,
922        unsigned Line, Metadata *Type, bool IsLocalToUnit, bool IsDefinition,
923        unsigned ScopeLine, Metadata *ContainingType, unsigned Virtuality,
924        unsigned VirtualIndex, unsigned Flags, bool IsOptimized,
925        Metadata *Function = nullptr, Metadata *TemplateParams = nullptr,
926        Metadata *Declaration = nullptr, Metadata *Variables = nullptr),
927       (Scope, Name, LinkageName, File, Line, Type, IsLocalToUnit, IsDefinition,
928        ScopeLine, ContainingType, Virtuality, VirtualIndex, Flags, IsOptimized,
929        Function, TemplateParams, Declaration, Variables))
930   DEFINE_MDNODE_GET(
931       MDSubprogram,
932       (Metadata * Scope, MDString *Name, MDString *LinkageName, Metadata *File,
933        unsigned Line, Metadata *Type, bool IsLocalToUnit, bool IsDefinition,
934        unsigned ScopeLine, Metadata *ContainingType, unsigned Virtuality,
935        unsigned VirtualIndex, unsigned Flags, bool IsOptimized,
936        Metadata *Function = nullptr, Metadata *TemplateParams = nullptr,
937        Metadata *Declaration = nullptr, Metadata *Variables = nullptr),
938       (Scope, Name, LinkageName, File, Line, Type, IsLocalToUnit, IsDefinition,
939        ScopeLine, ContainingType, Virtuality, VirtualIndex, Flags, IsOptimized,
940        Function, TemplateParams, Declaration, Variables))
941
942   TempMDSubprogram clone() const { return cloneImpl(); }
943
944 public:
945   unsigned getLine() const { return Line; }
946   unsigned getVirtuality() const { return Virtuality; }
947   unsigned getVirtualIndex() const { return VirtualIndex; }
948   unsigned getScopeLine() const { return ScopeLine; }
949   unsigned getFlags() const { return Flags; }
950   bool isLocalToUnit() const { return IsLocalToUnit; }
951   bool isDefinition() const { return IsDefinition; }
952   bool isOptimized() const { return IsOptimized; }
953
954   Metadata *getScope() const { return getOperand(1); }
955
956   StringRef getName() const { return getStringOperand(2); }
957   StringRef getDisplayName() const { return getStringOperand(3); }
958   StringRef getLinkageName() const { return getStringOperand(4); }
959
960   Metadata *getType() const { return getOperand(5); }
961   Metadata *getContainingType() const { return getOperand(6); }
962
963   Metadata *getFunction() const { return getOperand(7); }
964   Metadata *getTemplateParams() const { return getOperand(8); }
965   Metadata *getDeclaration() const { return getOperand(9); }
966   Metadata *getVariables() const { return getOperand(10); }
967
968   static bool classof(const Metadata *MD) {
969     return MD->getMetadataID() == MDSubprogramKind;
970   }
971 };
972
973 class MDLexicalBlockBase : public MDScope {
974 protected:
975   MDLexicalBlockBase(LLVMContext &C, unsigned ID, StorageType Storage,
976                      ArrayRef<Metadata *> Ops)
977       : MDScope(C, ID, Storage, dwarf::DW_TAG_lexical_block, Ops) {}
978   ~MDLexicalBlockBase() {}
979
980 public:
981   Metadata *getScope() const { return getOperand(1); }
982
983   static bool classof(const Metadata *MD) {
984     return MD->getMetadataID() == MDLexicalBlockKind ||
985            MD->getMetadataID() == MDLexicalBlockFileKind;
986   }
987 };
988
989 class MDLexicalBlock : public MDLexicalBlockBase {
990   friend class LLVMContextImpl;
991   friend class MDNode;
992
993   unsigned Line;
994   unsigned Column;
995
996   MDLexicalBlock(LLVMContext &C, StorageType Storage, unsigned Line,
997                  unsigned Column, ArrayRef<Metadata *> Ops)
998       : MDLexicalBlockBase(C, MDLexicalBlockKind, Storage, Ops), Line(Line),
999         Column(Column) {}
1000   ~MDLexicalBlock() {}
1001
1002   static MDLexicalBlock *getImpl(LLVMContext &Context, Metadata *Scope,
1003                                  Metadata *File, unsigned Line, unsigned Column,
1004                                  StorageType Storage, bool ShouldCreate = true);
1005
1006   TempMDLexicalBlock cloneImpl() const {
1007     return getTemporary(getContext(), getScope(), getFile(), getLine(),
1008                         getColumn());
1009   }
1010
1011 public:
1012   DEFINE_MDNODE_GET(MDLexicalBlock, (Metadata * Scope, Metadata *File,
1013                                      unsigned Line, unsigned Column),
1014                     (Scope, File, Line, Column))
1015
1016   TempMDLexicalBlock clone() const { return cloneImpl(); }
1017
1018   unsigned getLine() const { return Line; }
1019   unsigned getColumn() const { return Column; }
1020
1021   static bool classof(const Metadata *MD) {
1022     return MD->getMetadataID() == MDLexicalBlockKind;
1023   }
1024 };
1025
1026 class MDLexicalBlockFile : public MDLexicalBlockBase {
1027   friend class LLVMContextImpl;
1028   friend class MDNode;
1029
1030   unsigned Discriminator;
1031
1032   MDLexicalBlockFile(LLVMContext &C, StorageType Storage,
1033                      unsigned Discriminator, ArrayRef<Metadata *> Ops)
1034       : MDLexicalBlockBase(C, MDLexicalBlockFileKind, Storage, Ops),
1035         Discriminator(Discriminator) {}
1036   ~MDLexicalBlockFile() {}
1037
1038   static MDLexicalBlockFile *getImpl(LLVMContext &Context, Metadata *Scope,
1039                                      Metadata *File, unsigned Discriminator,
1040                                      StorageType Storage,
1041                                      bool ShouldCreate = true);
1042
1043   TempMDLexicalBlockFile cloneImpl() const {
1044     return getTemporary(getContext(), getScope(), getFile(),
1045                         getDiscriminator());
1046   }
1047
1048 public:
1049   DEFINE_MDNODE_GET(MDLexicalBlockFile,
1050                     (Metadata * Scope, Metadata *File, unsigned Discriminator),
1051                     (Scope, File, Discriminator))
1052
1053   TempMDLexicalBlockFile clone() const { return cloneImpl(); }
1054
1055   unsigned getDiscriminator() const { return Discriminator; }
1056
1057   static bool classof(const Metadata *MD) {
1058     return MD->getMetadataID() == MDLexicalBlockFileKind;
1059   }
1060 };
1061
1062 class MDNamespace : public MDScope {
1063   friend class LLVMContextImpl;
1064   friend class MDNode;
1065
1066   unsigned Line;
1067
1068   MDNamespace(LLVMContext &Context, StorageType Storage, unsigned Line,
1069               ArrayRef<Metadata *> Ops)
1070       : MDScope(Context, MDNamespaceKind, Storage, dwarf::DW_TAG_namespace,
1071                 Ops),
1072         Line(Line) {}
1073   ~MDNamespace() {}
1074
1075   static MDNamespace *getImpl(LLVMContext &Context, Metadata *Scope,
1076                               Metadata *File, StringRef Name, unsigned Line,
1077                               StorageType Storage, bool ShouldCreate = true) {
1078     return getImpl(Context, Scope, File, getCanonicalMDString(Context, Name),
1079                    Line, Storage, ShouldCreate);
1080   }
1081   static MDNamespace *getImpl(LLVMContext &Context, Metadata *Scope,
1082                               Metadata *File, MDString *Name, unsigned Line,
1083                               StorageType Storage, bool ShouldCreate = true);
1084
1085   TempMDNamespace cloneImpl() const {
1086     return getTemporary(getContext(), getScope(), getFile(), getName(),
1087                         getLine());
1088   }
1089
1090 public:
1091   DEFINE_MDNODE_GET(MDNamespace, (Metadata * Scope, Metadata *File,
1092                                   StringRef Name, unsigned Line),
1093                     (Scope, File, Name, Line))
1094   DEFINE_MDNODE_GET(MDNamespace, (Metadata * Scope, Metadata *File,
1095                                   MDString *Name, unsigned Line),
1096                     (Scope, File, Name, Line))
1097
1098   TempMDNamespace clone() const { return cloneImpl(); }
1099
1100   unsigned getLine() const { return Line; }
1101   Metadata *getScope() const { return getOperand(1); }
1102   StringRef getName() const { return getStringOperand(2); }
1103
1104   static bool classof(const Metadata *MD) {
1105     return MD->getMetadataID() == MDNamespaceKind;
1106   }
1107 };
1108
1109 /// \brief Base class for template parameters.
1110 ///
1111 /// TODO: Remove the scope.  It's always the compile unit, and never
1112 /// referenced.
1113 /// TODO: Remove File, Line and Column.  They're always 0 and never
1114 /// referenced.
1115 class MDTemplateParameter : public DebugNode {
1116 protected:
1117   MDTemplateParameter(LLVMContext &Context, unsigned ID, StorageType Storage,
1118                       unsigned Tag, ArrayRef<Metadata *> Ops)
1119       : DebugNode(Context, ID, Storage, Tag, Ops) {}
1120   ~MDTemplateParameter() {}
1121
1122 public:
1123   Metadata *getScope() const { return getOperand(0); }
1124   StringRef getName() const { return getStringOperand(1); }
1125   Metadata *getType() const { return getOperand(2); }
1126
1127   static bool classof(const Metadata *MD) {
1128     return MD->getMetadataID() == MDTemplateTypeParameterKind ||
1129            MD->getMetadataID() == MDTemplateValueParameterKind;
1130   }
1131 };
1132
1133 class MDTemplateTypeParameter : public MDTemplateParameter {
1134   friend class LLVMContextImpl;
1135   friend class MDNode;
1136
1137   MDTemplateTypeParameter(LLVMContext &Context, StorageType Storage,
1138                           ArrayRef<Metadata *> Ops)
1139       : MDTemplateParameter(Context, MDTemplateTypeParameterKind, Storage,
1140                             dwarf::DW_TAG_template_type_parameter, Ops) {}
1141   ~MDTemplateTypeParameter() {}
1142
1143   static MDTemplateTypeParameter *getImpl(LLVMContext &Context, Metadata *Scope,
1144                                           StringRef Name, Metadata *Type,
1145                                           StorageType Storage,
1146                                           bool ShouldCreate = true) {
1147     return getImpl(Context, Scope, getCanonicalMDString(Context, Name), Type,
1148                    Storage, ShouldCreate);
1149   }
1150   static MDTemplateTypeParameter *getImpl(LLVMContext &Context, Metadata *Scope,
1151                                           MDString *Name, Metadata *Type,
1152                                           StorageType Storage,
1153                                           bool ShouldCreate = true);
1154
1155   TempMDTemplateTypeParameter cloneImpl() const {
1156     return getTemporary(getContext(), getScope(), getName(), getType());
1157   }
1158
1159 public:
1160   DEFINE_MDNODE_GET(MDTemplateTypeParameter,
1161                     (Metadata * Scope, StringRef Name, Metadata *Type),
1162                     (Scope, Name, Type))
1163   DEFINE_MDNODE_GET(MDTemplateTypeParameter,
1164                     (Metadata * Scope, MDString *Name, Metadata *Type),
1165                     (Scope, Name, Type))
1166
1167   TempMDTemplateTypeParameter clone() const { return cloneImpl(); }
1168
1169   static bool classof(const Metadata *MD) {
1170     return MD->getMetadataID() == MDTemplateTypeParameterKind;
1171   }
1172 };
1173
1174 class MDTemplateValueParameter : public MDTemplateParameter {
1175   friend class LLVMContextImpl;
1176   friend class MDNode;
1177
1178   MDTemplateValueParameter(LLVMContext &Context, StorageType Storage,
1179                            unsigned Tag, ArrayRef<Metadata *> Ops)
1180       : MDTemplateParameter(Context, MDTemplateValueParameterKind, Storage, Tag,
1181                             Ops) {}
1182   ~MDTemplateValueParameter() {}
1183
1184   static MDTemplateValueParameter *getImpl(LLVMContext &Context, unsigned Tag,
1185                                            Metadata *Scope, StringRef Name,
1186                                            Metadata *Type, Metadata *Value,
1187                                            StorageType Storage,
1188                                            bool ShouldCreate = true) {
1189     return getImpl(Context, Tag, Scope, getCanonicalMDString(Context, Name),
1190                    Type, Value, Storage, ShouldCreate);
1191   }
1192   static MDTemplateValueParameter *getImpl(LLVMContext &Context, unsigned Tag,
1193                                            Metadata *Scope, MDString *Name,
1194                                            Metadata *Type, Metadata *Value,
1195                                            StorageType Storage,
1196                                            bool ShouldCreate = true);
1197
1198   TempMDTemplateValueParameter cloneImpl() const {
1199     return getTemporary(getContext(), getTag(), getScope(), getName(),
1200                         getType(), getValue());
1201   }
1202
1203 public:
1204   DEFINE_MDNODE_GET(MDTemplateValueParameter,
1205                     (unsigned Tag, Metadata *Scope, StringRef Name,
1206                      Metadata *Type, Metadata *Value),
1207                     (Tag, Scope, Name, Type, Value))
1208   DEFINE_MDNODE_GET(MDTemplateValueParameter,
1209                     (unsigned Tag, Metadata *Scope, MDString *Name,
1210                      Metadata *Type, Metadata *Value),
1211                     (Tag, Scope, Name, Type, Value))
1212
1213   Metadata *getValue() const { return getOperand(3); }
1214
1215   static bool classof(const Metadata *MD) {
1216     return MD->getMetadataID() == MDTemplateValueParameterKind;
1217   }
1218 };
1219
1220 /// \brief Base class for variables.
1221 ///
1222 /// TODO: Hardcode to DW_TAG_variable.
1223 class MDVariable : public DebugNode {
1224   unsigned Line;
1225
1226 protected:
1227   MDVariable(LLVMContext &C, unsigned ID, StorageType Storage, unsigned Tag,
1228              unsigned Line, ArrayRef<Metadata *> Ops)
1229       : DebugNode(C, ID, Storage, Tag, Ops), Line(Line) {}
1230   ~MDVariable() {}
1231
1232 public:
1233   unsigned getLine() const { return Line; }
1234   Metadata *getScope() const { return getOperand(0); }
1235   StringRef getName() const { return getStringOperand(1); }
1236   Metadata *getFile() const { return getOperand(2); }
1237   Metadata *getType() const { return getOperand(3); }
1238
1239   static bool classof(const Metadata *MD) {
1240     return MD->getMetadataID() == MDLocalVariableKind ||
1241            MD->getMetadataID() == MDGlobalVariableKind;
1242   }
1243 };
1244
1245 /// \brief Global variables.
1246 ///
1247 /// TODO: Remove DisplayName.  It's always equal to Name.
1248 class MDGlobalVariable : public MDVariable {
1249   friend class LLVMContextImpl;
1250   friend class MDNode;
1251
1252   bool IsLocalToUnit;
1253   bool IsDefinition;
1254
1255   MDGlobalVariable(LLVMContext &C, StorageType Storage, unsigned Line,
1256                    bool IsLocalToUnit, bool IsDefinition,
1257                    ArrayRef<Metadata *> Ops)
1258       : MDVariable(C, MDGlobalVariableKind, Storage, dwarf::DW_TAG_variable,
1259                    Line, Ops),
1260         IsLocalToUnit(IsLocalToUnit), IsDefinition(IsDefinition) {}
1261   ~MDGlobalVariable() {}
1262
1263   static MDGlobalVariable *
1264   getImpl(LLVMContext &Context, Metadata *Scope, StringRef Name,
1265           StringRef LinkageName, Metadata *File, unsigned Line, Metadata *Type,
1266           bool IsLocalToUnit, bool IsDefinition, Metadata *Variable,
1267           Metadata *StaticDataMemberDeclaration, StorageType Storage,
1268           bool ShouldCreate = true) {
1269     return getImpl(Context, Scope, getCanonicalMDString(Context, Name),
1270                    getCanonicalMDString(Context, LinkageName), File, Line, Type,
1271                    IsLocalToUnit, IsDefinition, Variable,
1272                    StaticDataMemberDeclaration, Storage, ShouldCreate);
1273   }
1274   static MDGlobalVariable *
1275   getImpl(LLVMContext &Context, Metadata *Scope, MDString *Name,
1276           MDString *LinkageName, Metadata *File, unsigned Line, Metadata *Type,
1277           bool IsLocalToUnit, bool IsDefinition, Metadata *Variable,
1278           Metadata *StaticDataMemberDeclaration, StorageType Storage,
1279           bool ShouldCreate = true);
1280
1281   TempMDGlobalVariable cloneImpl() const {
1282     return getTemporary(getContext(), getScope(), getName(), getLinkageName(),
1283                         getFile(), getLine(), getType(), isLocalToUnit(),
1284                         isDefinition(), getVariable(),
1285                         getStaticDataMemberDeclaration());
1286   }
1287
1288 public:
1289   DEFINE_MDNODE_GET(MDGlobalVariable,
1290                     (Metadata * Scope, StringRef Name, StringRef LinkageName,
1291                      Metadata *File, unsigned Line, Metadata *Type,
1292                      bool IsLocalToUnit, bool IsDefinition, Metadata *Variable,
1293                      Metadata *StaticDataMemberDeclaration),
1294                     (Scope, Name, LinkageName, File, Line, Type, IsLocalToUnit,
1295                      IsDefinition, Variable, StaticDataMemberDeclaration))
1296   DEFINE_MDNODE_GET(MDGlobalVariable,
1297                     (Metadata * Scope, MDString *Name, MDString *LinkageName,
1298                      Metadata *File, unsigned Line, Metadata *Type,
1299                      bool IsLocalToUnit, bool IsDefinition, Metadata *Variable,
1300                      Metadata *StaticDataMemberDeclaration),
1301                     (Scope, Name, LinkageName, File, Line, Type, IsLocalToUnit,
1302                      IsDefinition, Variable, StaticDataMemberDeclaration))
1303
1304   bool isLocalToUnit() const { return IsLocalToUnit; }
1305   bool isDefinition() const { return IsDefinition; }
1306   StringRef getDisplayName() const { return getStringOperand(4); }
1307   StringRef getLinkageName() const { return getStringOperand(5); }
1308   Metadata *getVariable() const { return getOperand(6); }
1309   Metadata *getStaticDataMemberDeclaration() const { return getOperand(7); }
1310
1311   static bool classof(const Metadata *MD) {
1312     return MD->getMetadataID() == MDGlobalVariableKind;
1313   }
1314 };
1315
1316 /// \brief Local variable.
1317 ///
1318 /// TODO: Split between arguments and otherwise.
1319 /// TODO: Use \c DW_TAG_variable instead of fake tags.
1320 /// TODO: Split up flags.
1321 class MDLocalVariable : public MDVariable {
1322   friend class LLVMContextImpl;
1323   friend class MDNode;
1324
1325   unsigned Arg;
1326   unsigned Flags;
1327
1328   MDLocalVariable(LLVMContext &C, StorageType Storage, unsigned Tag,
1329                   unsigned Line, unsigned Arg, unsigned Flags,
1330                   ArrayRef<Metadata *> Ops)
1331       : MDVariable(C, MDLocalVariableKind, Storage, Tag, Line, Ops), Arg(Arg),
1332         Flags(Flags) {}
1333   ~MDLocalVariable() {}
1334
1335   static MDLocalVariable *getImpl(LLVMContext &Context, unsigned Tag,
1336                                   Metadata *Scope, StringRef Name,
1337                                   Metadata *File, unsigned Line, Metadata *Type,
1338                                   unsigned Arg, unsigned Flags,
1339                                   Metadata *InlinedAt, StorageType Storage,
1340                                   bool ShouldCreate = true) {
1341     return getImpl(Context, Tag, Scope, getCanonicalMDString(Context, Name),
1342                    File, Line, Type, Arg, Flags, InlinedAt, Storage,
1343                    ShouldCreate);
1344   }
1345   static MDLocalVariable *getImpl(LLVMContext &Context, unsigned Tag,
1346                                   Metadata *Scope, MDString *Name,
1347                                   Metadata *File, unsigned Line, Metadata *Type,
1348                                   unsigned Arg, unsigned Flags,
1349                                   Metadata *InlinedAt, StorageType Storage,
1350                                   bool ShouldCreate = true);
1351
1352   TempMDLocalVariable cloneImpl() const {
1353     return getTemporary(getContext(), getTag(), getScope(), getName(),
1354                         getFile(), getLine(), getType(), getArg(), getFlags(),
1355                         getInlinedAt());
1356   }
1357
1358 public:
1359   DEFINE_MDNODE_GET(MDLocalVariable,
1360                     (unsigned Tag, Metadata *Scope, StringRef Name,
1361                      Metadata *File, unsigned Line, Metadata *Type,
1362                      unsigned Arg, unsigned Flags,
1363                      Metadata *InlinedAt = nullptr),
1364                     (Tag, Scope, Name, File, Line, Type, Arg, Flags, InlinedAt))
1365   DEFINE_MDNODE_GET(MDLocalVariable,
1366                     (unsigned Tag, Metadata *Scope, MDString *Name,
1367                      Metadata *File, unsigned Line, Metadata *Type,
1368                      unsigned Arg, unsigned Flags,
1369                      Metadata *InlinedAt = nullptr),
1370                     (Tag, Scope, Name, File, Line, Type, Arg, Flags, InlinedAt))
1371
1372   unsigned getArg() const { return Arg; }
1373   unsigned getFlags() const { return Flags; }
1374   Metadata *getInlinedAt() const { return getOperand(4); }
1375
1376   static bool classof(const Metadata *MD) {
1377     return MD->getMetadataID() == MDLocalVariableKind;
1378   }
1379 };
1380
1381 /// \brief DWARF expression.
1382 ///
1383 /// TODO: Co-allocate the expression elements.
1384 /// TODO: Drop fake DW_TAG_expression and separate from DebugNode.
1385 /// TODO: Separate from MDNode, or otherwise drop Distinct and Temporary
1386 /// storage types.
1387 class MDExpression : public DebugNode {
1388   friend class LLVMContextImpl;
1389   friend class MDNode;
1390
1391   std::vector<uint64_t> Elements;
1392
1393   MDExpression(LLVMContext &C, StorageType Storage, ArrayRef<uint64_t> Elements)
1394       : DebugNode(C, MDExpressionKind, Storage, dwarf::DW_TAG_expression, None),
1395         Elements(Elements.begin(), Elements.end()) {}
1396   ~MDExpression() {}
1397
1398   static MDExpression *getImpl(LLVMContext &Context,
1399                                ArrayRef<uint64_t> Elements, StorageType Storage,
1400                                bool ShouldCreate = true);
1401
1402   TempMDExpression cloneImpl() const {
1403     return getTemporary(getContext(), getElements());
1404   }
1405
1406 public:
1407   DEFINE_MDNODE_GET(MDExpression, (ArrayRef<uint64_t> Elements), (Elements))
1408
1409   ArrayRef<uint64_t> getElements() const { return Elements; }
1410
1411   unsigned getNumElements() const { return Elements.size(); }
1412   uint64_t getElement(unsigned I) const {
1413     assert(I < Elements.size() && "Index out of range");
1414     return Elements[I];
1415   }
1416
1417   typedef ArrayRef<uint64_t>::iterator element_iterator;
1418   element_iterator elements_begin() const { return getElements().begin(); }
1419   element_iterator elements_end() const { return getElements().end(); }
1420
1421   /// \brief A lightweight wrapper around an expression operand.
1422   ///
1423   /// TODO: Store arguments directly and change \a MDExpression to store a
1424   /// range of these.
1425   class ExprOperand {
1426     const uint64_t *Op;
1427
1428   public:
1429     explicit ExprOperand(const uint64_t *Op) : Op(Op) {}
1430
1431     const uint64_t *get() const { return Op; }
1432
1433     /// \brief Get the operand code.
1434     uint64_t getOp() const { return *Op; }
1435
1436     /// \brief Get an argument to the operand.
1437     ///
1438     /// Never returns the operand itself.
1439     uint64_t getArg(unsigned I) const { return Op[I + 1]; }
1440
1441     unsigned getNumArgs() const { return getSize() - 1; }
1442
1443     /// \brief Return the size of the operand.
1444     ///
1445     /// Return the number of elements in the operand (1 + args).
1446     unsigned getSize() const;
1447   };
1448
1449   /// \brief An iterator for expression operands.
1450   class expr_op_iterator
1451       : public std::iterator<std::input_iterator_tag, ExprOperand> {
1452     ExprOperand Op;
1453
1454   public:
1455     explicit expr_op_iterator(element_iterator I) : Op(I) {}
1456
1457     element_iterator getBase() const { return Op.get(); }
1458     const ExprOperand &operator*() const { return Op; }
1459     const ExprOperand *operator->() const { return &Op; }
1460
1461     expr_op_iterator &operator++() {
1462       increment();
1463       return *this;
1464     }
1465     expr_op_iterator operator++(int) {
1466       expr_op_iterator T(*this);
1467       increment();
1468       return T;
1469     }
1470
1471     bool operator==(const expr_op_iterator &X) const {
1472       return getBase() == X.getBase();
1473     }
1474     bool operator!=(const expr_op_iterator &X) const {
1475       return getBase() != X.getBase();
1476     }
1477
1478   private:
1479     void increment() { Op = ExprOperand(getBase() + Op.getSize()); }
1480   };
1481
1482   /// \brief Visit the elements via ExprOperand wrappers.
1483   ///
1484   /// These range iterators visit elements through \a ExprOperand wrappers.
1485   /// This is not guaranteed to be a valid range unless \a isValid() gives \c
1486   /// true.
1487   ///
1488   /// \pre \a isValid() gives \c true.
1489   /// @{
1490   expr_op_iterator expr_op_begin() const {
1491     return expr_op_iterator(elements_begin());
1492   }
1493   expr_op_iterator expr_op_end() const {
1494     return expr_op_iterator(elements_end());
1495   }
1496   /// @}
1497
1498   bool isValid() const;
1499
1500   static bool classof(const Metadata *MD) {
1501     return MD->getMetadataID() == MDExpressionKind;
1502   }
1503 };
1504
1505 class MDObjCProperty : public DebugNode {
1506   friend class LLVMContextImpl;
1507   friend class MDNode;
1508
1509   unsigned Line;
1510   unsigned Attributes;
1511
1512   MDObjCProperty(LLVMContext &C, StorageType Storage, unsigned Line,
1513                  unsigned Attributes, ArrayRef<Metadata *> Ops)
1514       : DebugNode(C, MDObjCPropertyKind, Storage, dwarf::DW_TAG_APPLE_property,
1515                   Ops),
1516         Line(Line), Attributes(Attributes) {}
1517   ~MDObjCProperty() {}
1518
1519   static MDObjCProperty *
1520   getImpl(LLVMContext &Context, StringRef Name, Metadata *File, unsigned Line,
1521           StringRef GetterName, StringRef SetterName, unsigned Attributes,
1522           Metadata *Type, StorageType Storage, bool ShouldCreate = true) {
1523     return getImpl(Context, getCanonicalMDString(Context, Name), File, Line,
1524                    getCanonicalMDString(Context, GetterName),
1525                    getCanonicalMDString(Context, SetterName), Attributes, Type,
1526                    Storage, ShouldCreate);
1527   }
1528   static MDObjCProperty *getImpl(LLVMContext &Context, MDString *Name,
1529                                  Metadata *File, unsigned Line,
1530                                  MDString *GetterName, MDString *SetterName,
1531                                  unsigned Attributes, Metadata *Type,
1532                                  StorageType Storage, bool ShouldCreate = true);
1533
1534   TempMDObjCProperty cloneImpl() const {
1535     return getTemporary(getContext(), getName(), getFile(), getLine(),
1536                         getGetterName(), getSetterName(), getAttributes(),
1537                         getType());
1538   }
1539
1540 public:
1541   DEFINE_MDNODE_GET(MDObjCProperty,
1542                     (StringRef Name, Metadata *File, unsigned Line,
1543                      StringRef GetterName, StringRef SetterName,
1544                      unsigned Attributes, Metadata *Type),
1545                     (Name, File, Line, GetterName, SetterName, Attributes,
1546                      Type))
1547   DEFINE_MDNODE_GET(MDObjCProperty,
1548                     (MDString * Name, Metadata *File, unsigned Line,
1549                      MDString *GetterName, MDString *SetterName,
1550                      unsigned Attributes, Metadata *Type),
1551                     (Name, File, Line, GetterName, SetterName, Attributes,
1552                      Type))
1553
1554   unsigned getLine() const { return Line; }
1555   unsigned getAttributes() const { return Attributes; }
1556   StringRef getName() const { return getStringOperand(0); }
1557   Metadata *getFile() const { return getOperand(1); }
1558   StringRef getGetterName() const { return getStringOperand(2); }
1559   StringRef getSetterName() const { return getStringOperand(3); }
1560   Metadata *getType() const { return getOperand(4); }
1561
1562   static bool classof(const Metadata *MD) {
1563     return MD->getMetadataID() == MDObjCPropertyKind;
1564   }
1565 };
1566
1567 class MDImportedEntity : public DebugNode {
1568   friend class LLVMContextImpl;
1569   friend class MDNode;
1570
1571   unsigned Line;
1572
1573   MDImportedEntity(LLVMContext &C, StorageType Storage, unsigned Tag,
1574                    unsigned Line, ArrayRef<Metadata *> Ops)
1575       : DebugNode(C, MDImportedEntityKind, Storage, Tag, Ops), Line(Line) {}
1576   ~MDImportedEntity() {}
1577
1578   static MDImportedEntity *getImpl(LLVMContext &Context, unsigned Tag,
1579                                    Metadata *Scope, Metadata *Entity,
1580                                    unsigned Line, StringRef Name,
1581                                    StorageType Storage,
1582                                    bool ShouldCreate = true) {
1583     return getImpl(Context, Tag, Scope, Entity, Line,
1584                    getCanonicalMDString(Context, Name), Storage, ShouldCreate);
1585   }
1586   static MDImportedEntity *getImpl(LLVMContext &Context, unsigned Tag,
1587                                    Metadata *Scope, Metadata *Entity,
1588                                    unsigned Line, MDString *Name,
1589                                    StorageType Storage,
1590                                    bool ShouldCreate = true);
1591
1592   TempMDImportedEntity cloneImpl() const {
1593     return getTemporary(getContext(), getTag(), getScope(), getEntity(),
1594                         getLine(), getName());
1595   }
1596
1597 public:
1598   DEFINE_MDNODE_GET(MDImportedEntity,
1599                     (unsigned Tag, Metadata *Scope, Metadata *Entity,
1600                      unsigned Line, StringRef Name = ""),
1601                     (Tag, Scope, Entity, Line, Name))
1602   DEFINE_MDNODE_GET(MDImportedEntity,
1603                     (unsigned Tag, Metadata *Scope, Metadata *Entity,
1604                      unsigned Line, MDString *Name),
1605                     (Tag, Scope, Entity, Line, Name))
1606
1607   TempMDImportedEntity clone() const { return cloneImpl(); }
1608
1609   unsigned getLine() const { return Line; }
1610   Metadata *getScope() const { return getOperand(0); }
1611   Metadata *getEntity() const { return getOperand(1); }
1612   StringRef getName() const { return getStringOperand(2); }
1613
1614   static bool classof(const Metadata *MD) {
1615     return MD->getMetadataID() == MDImportedEntityKind;
1616   }
1617 };
1618
1619 } // end namespace llvm
1620
1621 #undef DEFINE_MDNODE_GET_UNPACK_IMPL
1622 #undef DEFINE_MDNODE_GET_UNPACK
1623 #undef DEFINE_MDNODE_GET
1624
1625 #endif