1//===------------ DebugInfo.h - LLVM C API Debug Info API -----------------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8///
9/// This file declares the C API endpoints for generating DWARF Debug Info
10///
11/// Note: This interface is experimental. It is *NOT* stable, and may be
12/// changed without warning.
13///
14//===----------------------------------------------------------------------===//
15
16#ifndef LLVM_C_DEBUGINFO_H
17#define LLVM_C_DEBUGINFO_H
18
19#include "llvm-c/ExternC.h"
20#include "llvm-c/Types.h"
21#include "llvm-c/Visibility.h"
22
23LLVM_C_EXTERN_C_BEGIN
24
25/**
26 * @defgroup LLVMCCoreDebugInfo Debug Information
27 * @ingroup LLVMCCore
28 *
29 * @{
30 */
31
32/**
33 * Debug info flags.
34 */
35typedef enum {
36 LLVMDIFlagZero = 0,
37 LLVMDIFlagPrivate = 1,
38 LLVMDIFlagProtected = 2,
39 LLVMDIFlagPublic = 3,
40 LLVMDIFlagFwdDecl = 1 << 2,
41 LLVMDIFlagAppleBlock = 1 << 3,
42 LLVMDIFlagReservedBit4 = 1 << 4,
43 LLVMDIFlagVirtual = 1 << 5,
44 LLVMDIFlagArtificial = 1 << 6,
45 LLVMDIFlagExplicit = 1 << 7,
46 LLVMDIFlagPrototyped = 1 << 8,
47 LLVMDIFlagObjcClassComplete = 1 << 9,
48 LLVMDIFlagObjectPointer = 1 << 10,
49 LLVMDIFlagVector = 1 << 11,
50 LLVMDIFlagStaticMember = 1 << 12,
51 LLVMDIFlagLValueReference = 1 << 13,
52 LLVMDIFlagRValueReference = 1 << 14,
53 LLVMDIFlagReserved = 1 << 15,
54 LLVMDIFlagSingleInheritance = 1 << 16,
55 LLVMDIFlagMultipleInheritance = 2 << 16,
56 LLVMDIFlagVirtualInheritance = 3 << 16,
57 LLVMDIFlagIntroducedVirtual = 1 << 18,
58 LLVMDIFlagBitField = 1 << 19,
59 LLVMDIFlagNoReturn = 1 << 20,
60 LLVMDIFlagTypePassByValue = 1 << 22,
61 LLVMDIFlagTypePassByReference = 1 << 23,
62 LLVMDIFlagEnumClass = 1 << 24,
63 LLVMDIFlagFixedEnum = LLVMDIFlagEnumClass, // Deprecated.
64 LLVMDIFlagThunk = 1 << 25,
65 LLVMDIFlagNonTrivial = 1 << 26,
66 LLVMDIFlagBigEndian = 1 << 27,
67 LLVMDIFlagLittleEndian = 1 << 28,
68 LLVMDIFlagIndirectVirtualBase = (1 << 2) | (1 << 5),
69 LLVMDIFlagAccessibility = LLVMDIFlagPrivate | LLVMDIFlagProtected |
70 LLVMDIFlagPublic,
71 LLVMDIFlagPtrToMemberRep = LLVMDIFlagSingleInheritance |
72 LLVMDIFlagMultipleInheritance |
73 LLVMDIFlagVirtualInheritance
74} LLVMDIFlags;
75
76/**
77 * Source languages known by DWARF.
78 */
79typedef enum {
80 LLVMDWARFSourceLanguageC89,
81 LLVMDWARFSourceLanguageC,
82 LLVMDWARFSourceLanguageAda83,
83 LLVMDWARFSourceLanguageC_plus_plus,
84 LLVMDWARFSourceLanguageCobol74,
85 LLVMDWARFSourceLanguageCobol85,
86 LLVMDWARFSourceLanguageFortran77,
87 LLVMDWARFSourceLanguageFortran90,
88 LLVMDWARFSourceLanguagePascal83,
89 LLVMDWARFSourceLanguageModula2,
90 // New in DWARF v3:
91 LLVMDWARFSourceLanguageJava,
92 LLVMDWARFSourceLanguageC99,
93 LLVMDWARFSourceLanguageAda95,
94 LLVMDWARFSourceLanguageFortran95,
95 LLVMDWARFSourceLanguagePLI,
96 LLVMDWARFSourceLanguageObjC,
97 LLVMDWARFSourceLanguageObjC_plus_plus,
98 LLVMDWARFSourceLanguageUPC,
99 LLVMDWARFSourceLanguageD,
100 // New in DWARF v4:
101 LLVMDWARFSourceLanguagePython,
102 // New in DWARF v5:
103 LLVMDWARFSourceLanguageOpenCL,
104 LLVMDWARFSourceLanguageGo,
105 LLVMDWARFSourceLanguageModula3,
106 LLVMDWARFSourceLanguageHaskell,
107 LLVMDWARFSourceLanguageC_plus_plus_03,
108 LLVMDWARFSourceLanguageC_plus_plus_11,
109 LLVMDWARFSourceLanguageOCaml,
110 LLVMDWARFSourceLanguageRust,
111 LLVMDWARFSourceLanguageC11,
112 LLVMDWARFSourceLanguageSwift,
113 LLVMDWARFSourceLanguageJulia,
114 LLVMDWARFSourceLanguageDylan,
115 LLVMDWARFSourceLanguageC_plus_plus_14,
116 LLVMDWARFSourceLanguageFortran03,
117 LLVMDWARFSourceLanguageFortran08,
118 LLVMDWARFSourceLanguageRenderScript,
119 LLVMDWARFSourceLanguageBLISS,
120 LLVMDWARFSourceLanguageKotlin,
121 LLVMDWARFSourceLanguageZig,
122 LLVMDWARFSourceLanguageCrystal,
123 LLVMDWARFSourceLanguageC_plus_plus_17,
124 LLVMDWARFSourceLanguageC_plus_plus_20,
125 LLVMDWARFSourceLanguageC17,
126 LLVMDWARFSourceLanguageFortran18,
127 LLVMDWARFSourceLanguageAda2005,
128 LLVMDWARFSourceLanguageAda2012,
129 LLVMDWARFSourceLanguageHIP,
130 LLVMDWARFSourceLanguageAssembly,
131 LLVMDWARFSourceLanguageC_sharp,
132 LLVMDWARFSourceLanguageMojo,
133 LLVMDWARFSourceLanguageGLSL,
134 LLVMDWARFSourceLanguageGLSL_ES,
135 LLVMDWARFSourceLanguageHLSL,
136 LLVMDWARFSourceLanguageOpenCL_CPP,
137 LLVMDWARFSourceLanguageCPP_for_OpenCL,
138 LLVMDWARFSourceLanguageSYCL,
139 LLVMDWARFSourceLanguageRuby,
140 LLVMDWARFSourceLanguageMove,
141 LLVMDWARFSourceLanguageHylo,
142 LLVMDWARFSourceLanguageMetal,
143 LLVMDWARFSourceLanguageC_plus_plus_23,
144 LLVMDWARFSourceLanguageOdin,
145 LLVMDWARFSourceLanguageP4,
146 LLVMDWARFSourceLanguageC23,
147 LLVMDWARFSourceLanguageFortran23,
148 LLVMDWARFSourceLanguageV,
149 LLVMDWARFSourceLanguageAlgol68,
150 LLVMDWARFSourceLanguageNim,
151 LLVMDWARFSourceLanguageErlang,
152 LLVMDWARFSourceLanguageElixir,
153 LLVMDWARFSourceLanguageGleam,
154
155 // Vendor extensions:
156 LLVMDWARFSourceLanguageMips_Assembler,
157 LLVMDWARFSourceLanguageGOOGLE_RenderScript,
158 LLVMDWARFSourceLanguageBORLAND_Delphi
159} LLVMDWARFSourceLanguage;
160
161/**
162 * The amount of debug information to emit.
163 */
164typedef enum {
165 LLVMDWARFEmissionNone = 0,
166 LLVMDWARFEmissionFull,
167 LLVMDWARFEmissionLineTablesOnly
168} LLVMDWARFEmissionKind;
169
170/**
171 * The kind of metadata nodes.
172 */
173// NOTE: New entries should always be appended instead of matching the order
174// in Metadata.def.
175enum {
176 LLVMMDStringMetadataKind,
177 LLVMConstantAsMetadataMetadataKind,
178 LLVMLocalAsMetadataMetadataKind,
179 LLVMDistinctMDOperandPlaceholderMetadataKind,
180 LLVMMDTupleMetadataKind,
181 LLVMDILocationMetadataKind,
182 LLVMDIExpressionMetadataKind,
183 LLVMDIGlobalVariableExpressionMetadataKind,
184 LLVMGenericDINodeMetadataKind,
185 LLVMDISubrangeMetadataKind,
186 LLVMDIEnumeratorMetadataKind,
187 LLVMDIBasicTypeMetadataKind,
188 LLVMDIDerivedTypeMetadataKind,
189 LLVMDICompositeTypeMetadataKind,
190 LLVMDISubroutineTypeMetadataKind,
191 LLVMDIFileMetadataKind,
192 LLVMDICompileUnitMetadataKind,
193 LLVMDISubprogramMetadataKind,
194 LLVMDILexicalBlockMetadataKind,
195 LLVMDILexicalBlockFileMetadataKind,
196 LLVMDINamespaceMetadataKind,
197 LLVMDIModuleMetadataKind,
198 LLVMDITemplateTypeParameterMetadataKind,
199 LLVMDITemplateValueParameterMetadataKind,
200 LLVMDIGlobalVariableMetadataKind,
201 LLVMDILocalVariableMetadataKind,
202 LLVMDILabelMetadataKind,
203 LLVMDIObjCPropertyMetadataKind,
204 LLVMDIImportedEntityMetadataKind,
205 LLVMDIMacroMetadataKind,
206 LLVMDIMacroFileMetadataKind,
207 LLVMDICommonBlockMetadataKind,
208 LLVMDIStringTypeMetadataKind,
209 LLVMDIGenericSubrangeMetadataKind,
210 LLVMDIArgListMetadataKind,
211 LLVMDIAssignIDMetadataKind,
212 LLVMDISubrangeTypeMetadataKind,
213 LLVMDIFixedPointTypeMetadataKind,
214 LLVMDIPropertyMetadataKind,
215};
216typedef unsigned LLVMMetadataKind;
217
218/**
219 * The kind of checksum to emit.
220 */
221typedef enum { CSK_MD5, CSK_SHA1, CSK_SHA256 } LLVMChecksumKind;
222
223/**
224 * An LLVM DWARF type encoding.
225 */
226typedef unsigned LLVMDWARFTypeEncoding;
227
228/**
229 * Describes the kind of macro declaration used for LLVMDIBuilderCreateMacro.
230 * @see llvm::dwarf::MacinfoRecordType
231 * @note Values are from DW_MACINFO_* constants in the DWARF specification.
232 */
233typedef enum {
234 LLVMDWARFMacinfoRecordTypeDefine = 0x01,
235 LLVMDWARFMacinfoRecordTypeMacro = 0x02,
236 LLVMDWARFMacinfoRecordTypeStartFile = 0x03,
237 LLVMDWARFMacinfoRecordTypeEndFile = 0x04,
238 LLVMDWARFMacinfoRecordTypeVendorExt = 0xff
239} LLVMDWARFMacinfoRecordType;
240
241/**
242 * The current debug metadata version number.
243 */
244LLVM_C_ABI unsigned LLVMDebugMetadataVersion(void);
245
246/**
247 * The version of debug metadata that's present in the provided \c Module.
248 */
249LLVM_C_ABI unsigned LLVMGetModuleDebugMetadataVersion(LLVMModuleRef Module);
250
251/**
252 * Strip debug info in the module if it exists.
253 * To do this, we remove all calls to the debugger intrinsics and any named
254 * metadata for debugging. We also remove debug locations for instructions.
255 * Return true if module is modified.
256 */
257LLVM_C_ABI LLVMBool LLVMStripModuleDebugInfo(LLVMModuleRef Module);
258
259/**
260 * Construct a builder for a module, and do not allow for unresolved nodes
261 * attached to the module.
262 */
263LLVM_C_ABI LLVMDIBuilderRef
264LLVMCreateDIBuilderDisallowUnresolved(LLVMModuleRef M);
265
266/**
267 * Construct a builder for a module and collect unresolved nodes attached
268 * to the module in order to resolve cycles during a call to
269 * \c LLVMDIBuilderFinalize.
270 */
271LLVM_C_ABI LLVMDIBuilderRef LLVMCreateDIBuilder(LLVMModuleRef M);
272
273/**
274 * Deallocates the \c DIBuilder and everything it owns.
275 * @note You must call \c LLVMDIBuilderFinalize before this
276 */
277LLVM_C_ABI void LLVMDisposeDIBuilder(LLVMDIBuilderRef Builder);
278
279/**
280 * Construct any deferred debug info descriptors.
281 */
282LLVM_C_ABI void LLVMDIBuilderFinalize(LLVMDIBuilderRef Builder);
283
284/**
285 * Finalize a specific subprogram.
286 * No new variables may be added to this subprogram afterwards.
287 */
288LLVM_C_ABI void LLVMDIBuilderFinalizeSubprogram(LLVMDIBuilderRef Builder,
289 LLVMMetadataRef Subprogram);
290
291/**
292 * A CompileUnit provides an anchor for all debugging
293 * information generated during this instance of compilation.
294 * \param Lang Source programming language, eg.
295 * \c LLVMDWARFSourceLanguageC99
296 * \param FileRef File info.
297 * \param Producer Identify the producer of debugging information
298 * and code. Usually this is a compiler
299 * version string.
300 * \param ProducerLen The length of the C string passed to \c Producer.
301 * \param isOptimized A boolean flag which indicates whether optimization
302 * is enabled or not.
303 * \param Flags This string lists command line options. This
304 * string is directly embedded in debug info
305 * output which may be used by a tool
306 * analyzing generated debugging information.
307 * \param FlagsLen The length of the C string passed to \c Flags.
308 * \param RuntimeVer This indicates runtime version for languages like
309 * Objective-C.
310 * \param SplitName The name of the file that we'll split debug info
311 * out into.
312 * \param SplitNameLen The length of the C string passed to \c SplitName.
313 * \param Kind The kind of debug information to generate.
314 * \param DWOId The DWOId if this is a split skeleton compile unit.
315 * \param SplitDebugInlining Whether to emit inline debug info.
316 * \param DebugInfoForProfiling Whether to emit extra debug info for
317 * profile collection.
318 * \param SysRoot The Clang system root (value of -isysroot).
319 * \param SysRootLen The length of the C string passed to \c SysRoot.
320 * \param SDK The SDK. On Darwin, the last component of the sysroot.
321 * \param SDKLen The length of the C string passed to \c SDK.
322 */
323LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreateCompileUnit(
324 LLVMDIBuilderRef Builder, LLVMDWARFSourceLanguage Lang,
325 LLVMMetadataRef FileRef, const char *Producer, size_t ProducerLen,
326 LLVMBool isOptimized, const char *Flags, size_t FlagsLen,
327 unsigned RuntimeVer, const char *SplitName, size_t SplitNameLen,
328 LLVMDWARFEmissionKind Kind, unsigned DWOId, LLVMBool SplitDebugInlining,
329 LLVMBool DebugInfoForProfiling, const char *SysRoot, size_t SysRootLen,
330 const char *SDK, size_t SDKLen);
331
332/**
333 * Create a file descriptor to hold debugging information for a file.
334 * \param Builder The \c DIBuilder.
335 * \param Filename File name.
336 * \param FilenameLen The length of the C string passed to \c Filename.
337 * \param Directory Directory.
338 * \param DirectoryLen The length of the C string passed to \c Directory.
339 */
340LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreateFile(LLVMDIBuilderRef Builder,
341 const char *Filename,
342 size_t FilenameLen,
343 const char *Directory,
344 size_t DirectoryLen);
345
346/**
347 * Create a file descriptor to hold debugging information for a file.
348 * \param Builder The \c DIBuilder.
349 * \param Filename File name.
350 * \param FilenameLen The length of the C string passed to \c Filename.
351 * \param Directory Directory.
352 * \param DirectoryLen The length of the C string passed to \c Directory.
353 * \param ChecksumKind The kind of checksum. eg MD5, SHA256
354 * \param Checksum The checksum.
355 * \param ChecksumLen The length of the checksum.
356 * \param Souce The embedded source.
357 * \param SourceLen The length of the source.
358 */
359LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreateFileWithChecksum(
360 LLVMDIBuilderRef Builder, const char *Filename, size_t FilenameLen,
361 const char *Directory, size_t DirectoryLen, LLVMChecksumKind ChecksumKind,
362 const char *Checksum, size_t ChecksumLen, const char *Source,
363 size_t SourceLen);
364
365/**
366 * Creates a new descriptor for a module with the specified parent scope.
367 * \param Builder The \c DIBuilder.
368 * \param ParentScope The parent scope containing this module declaration.
369 * \param Name Module name.
370 * \param NameLen The length of the C string passed to \c Name.
371 * \param ConfigMacros A space-separated shell-quoted list of -D macro
372 definitions as they would appear on a command line.
373 * \param ConfigMacrosLen The length of the C string passed to \c ConfigMacros.
374 * \param IncludePath The path to the module map file.
375 * \param IncludePathLen The length of the C string passed to \c IncludePath.
376 * \param APINotesFile The path to an API notes file for the module.
377 * \param APINotesFileLen The length of the C string passed to \c APINotestFile.
378 */
379LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreateModule(
380 LLVMDIBuilderRef Builder, LLVMMetadataRef ParentScope, const char *Name,
381 size_t NameLen, const char *ConfigMacros, size_t ConfigMacrosLen,
382 const char *IncludePath, size_t IncludePathLen, const char *APINotesFile,
383 size_t APINotesFileLen);
384
385/**
386 * Creates a new descriptor for a namespace with the specified parent scope.
387 * \param Builder The \c DIBuilder.
388 * \param ParentScope The parent scope containing this module declaration.
389 * \param Name NameSpace name.
390 * \param NameLen The length of the C string passed to \c Name.
391 * \param ExportSymbols Whether or not the namespace exports symbols, e.g.
392 * this is true of C++ inline namespaces.
393 */
394LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreateNameSpace(
395 LLVMDIBuilderRef Builder, LLVMMetadataRef ParentScope, const char *Name,
396 size_t NameLen, LLVMBool ExportSymbols);
397
398/**
399 * Create a new descriptor for the specified subprogram.
400 * \param Builder The \c DIBuilder.
401 * \param Scope Function scope.
402 * \param Name Function name.
403 * \param NameLen Length of enumeration name.
404 * \param LinkageName Mangled function name.
405 * \param LinkageNameLen Length of linkage name.
406 * \param File File where this variable is defined.
407 * \param LineNo Line number.
408 * \param Ty Function type.
409 * \param IsLocalToUnit True if this function is not externally visible.
410 * \param IsDefinition True if this is a function definition.
411 * \param ScopeLine Set to the beginning of the scope this starts
412 * \param Flags E.g.: \c LLVMDIFlagLValueReference. These flags are
413 * used to emit dwarf attributes.
414 * \param IsOptimized True if optimization is ON.
415 */
416LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreateFunction(
417 LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
418 size_t NameLen, const char *LinkageName, size_t LinkageNameLen,
419 LLVMMetadataRef File, unsigned LineNo, LLVMMetadataRef Ty,
420 LLVMBool IsLocalToUnit, LLVMBool IsDefinition, unsigned ScopeLine,
421 LLVMDIFlags Flags, LLVMBool IsOptimized);
422
423/**
424 * Create a descriptor for a lexical block with the specified parent context.
425 * \param Builder The \c DIBuilder.
426 * \param Scope Parent lexical block.
427 * \param File Source file.
428 * \param Line The line in the source file.
429 * \param Column The column in the source file.
430 */
431LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreateLexicalBlock(
432 LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, LLVMMetadataRef File,
433 unsigned Line, unsigned Column);
434
435/**
436 * Create a descriptor for a lexical block with a new file attached.
437 * \param Builder The \c DIBuilder.
438 * \param Scope Lexical block.
439 * \param File Source file.
440 * \param Discriminator DWARF path discriminator value.
441 */
442LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreateLexicalBlockFile(
443 LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, LLVMMetadataRef File,
444 unsigned Discriminator);
445
446/**
447 * Create a descriptor for an imported namespace. Suitable for e.g. C++
448 * using declarations.
449 * \param Builder The \c DIBuilder.
450 * \param Scope The scope this module is imported into
451 * \param File File where the declaration is located.
452 * \param Line Line number of the declaration.
453 */
454LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreateImportedModuleFromNamespace(
455 LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, LLVMMetadataRef NS,
456 LLVMMetadataRef File, unsigned Line);
457
458/**
459 * Create a descriptor for an imported module that aliases another
460 * imported entity descriptor.
461 * \param Builder The \c DIBuilder.
462 * \param Scope The scope this module is imported into
463 * \param ImportedEntity Previous imported entity to alias.
464 * \param File File where the declaration is located.
465 * \param Line Line number of the declaration.
466 * \param Elements Renamed elements.
467 * \param NumElements Number of renamed elements.
468 */
469LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreateImportedModuleFromAlias(
470 LLVMDIBuilderRef Builder, LLVMMetadataRef Scope,
471 LLVMMetadataRef ImportedEntity, LLVMMetadataRef File, unsigned Line,
472 LLVMMetadataRef *Elements, unsigned NumElements);
473
474/**
475 * Create a descriptor for an imported module.
476 * \param Builder The \c DIBuilder.
477 * \param Scope The scope this module is imported into
478 * \param M The module being imported here
479 * \param File File where the declaration is located.
480 * \param Line Line number of the declaration.
481 * \param Elements Renamed elements.
482 * \param NumElements Number of renamed elements.
483 */
484LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreateImportedModuleFromModule(
485 LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, LLVMMetadataRef M,
486 LLVMMetadataRef File, unsigned Line, LLVMMetadataRef *Elements,
487 unsigned NumElements);
488
489/**
490 * Create a descriptor for an imported function, type, or variable. Suitable
491 * for e.g. FORTRAN-style USE declarations.
492 * \param Builder The DIBuilder.
493 * \param Scope The scope this module is imported into.
494 * \param Decl The declaration (or definition) of a function, type,
495 or variable.
496 * \param File File where the declaration is located.
497 * \param Line Line number of the declaration.
498 * \param Name A name that uniquely identifies this imported
499 declaration.
500 * \param NameLen The length of the C string passed to \c Name.
501 * \param Elements Renamed elements.
502 * \param NumElements Number of renamed elements.
503 */
504LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreateImportedDeclaration(
505 LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, LLVMMetadataRef Decl,
506 LLVMMetadataRef File, unsigned Line, const char *Name, size_t NameLen,
507 LLVMMetadataRef *Elements, unsigned NumElements);
508
509/**
510 * Creates a new DebugLocation that describes a source location.
511 * \param Line The line in the source file.
512 * \param Column The column in the source file.
513 * \param Scope The scope in which the location resides.
514 * \param InlinedAt The scope where this location was inlined, if at all.
515 * (optional).
516 * \note If the item to which this location is attached cannot be
517 * attributed to a source line, pass 0 for the line and column.
518 */
519LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreateDebugLocation(
520 LLVMContextRef Ctx, unsigned Line, unsigned Column, LLVMMetadataRef Scope,
521 LLVMMetadataRef InlinedAt);
522
523/**
524 * Get the line number of this debug location.
525 * \param Location The debug location.
526 *
527 * @see DILocation::getLine()
528 */
529LLVM_C_ABI unsigned LLVMDILocationGetLine(LLVMMetadataRef Location);
530
531/**
532 * Get the column number of this debug location.
533 * \param Location The debug location.
534 *
535 * @see DILocation::getColumn()
536 */
537LLVM_C_ABI unsigned LLVMDILocationGetColumn(LLVMMetadataRef Location);
538
539/**
540 * Get the local scope associated with this debug location.
541 * \param Location The debug location.
542 *
543 * @see DILocation::getScope()
544 */
545LLVM_C_ABI LLVMMetadataRef LLVMDILocationGetScope(LLVMMetadataRef Location);
546
547/**
548 * Get the "inline at" location associated with this debug location.
549 * \param Location The debug location.
550 *
551 * @see DILocation::getInlinedAt()
552 */
553LLVM_C_ABI LLVMMetadataRef LLVMDILocationGetInlinedAt(LLVMMetadataRef Location);
554
555/**
556 * Get the metadata of the file associated with a given scope.
557 * \param Scope The scope object.
558 *
559 * @see DIScope::getFile()
560 */
561LLVM_C_ABI LLVMMetadataRef LLVMDIScopeGetFile(LLVMMetadataRef Scope);
562
563/**
564 * Get the directory of a given file.
565 * \param File The file object.
566 * \param Len The length of the returned string.
567 *
568 * @see DIFile::getDirectory()
569 */
570LLVM_C_ABI const char *LLVMDIFileGetDirectory(LLVMMetadataRef File,
571 unsigned *Len);
572
573/**
574 * Get the name of a given file.
575 * \param File The file object.
576 * \param Len The length of the returned string.
577 *
578 * @see DIFile::getFilename()
579 */
580LLVM_C_ABI const char *LLVMDIFileGetFilename(LLVMMetadataRef File,
581 unsigned *Len);
582
583/**
584 * Get the source of a given file.
585 * \param File The file object.
586 * \param Len The length of the returned string.
587 *
588 * @see DIFile::getSource()
589 */
590LLVM_C_ABI const char *LLVMDIFileGetSource(LLVMMetadataRef File, unsigned *Len);
591
592/**
593 * Create a type array.
594 * \param Builder The DIBuilder.
595 * \param Data The type elements.
596 * \param NumElements Number of type elements.
597 */
598LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderGetOrCreateTypeArray(
599 LLVMDIBuilderRef Builder, LLVMMetadataRef *Data, size_t NumElements);
600
601/**
602 * Create subroutine type.
603 * \param Builder The DIBuilder.
604 * \param File The file in which the subroutine resides.
605 * \param ParameterTypes An array of subroutine parameter types. This
606 * includes return type at 0th index.
607 * \param NumParameterTypes The number of parameter types in \c ParameterTypes
608 * \param Flags E.g.: \c LLVMDIFlagLValueReference.
609 * These flags are used to emit dwarf attributes.
610 */
611LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreateSubroutineType(
612 LLVMDIBuilderRef Builder, LLVMMetadataRef File,
613 LLVMMetadataRef *ParameterTypes, unsigned NumParameterTypes,
614 LLVMDIFlags Flags);
615
616/**
617 * Create debugging information entry for a macro.
618 * @param Builder The DIBuilder.
619 * @param ParentMacroFile Macro parent (could be NULL).
620 * @param Line Source line number where the macro is defined.
621 * @param RecordType DW_MACINFO_define or DW_MACINFO_undef.
622 * @param Name Macro name.
623 * @param NameLen Macro name length.
624 * @param Value Macro value.
625 * @param ValueLen Macro value length.
626 */
627LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreateMacro(
628 LLVMDIBuilderRef Builder, LLVMMetadataRef ParentMacroFile, unsigned Line,
629 LLVMDWARFMacinfoRecordType RecordType, const char *Name, size_t NameLen,
630 const char *Value, size_t ValueLen);
631
632/**
633 * Create debugging information temporary entry for a macro file.
634 * List of macro node direct children will be calculated by DIBuilder,
635 * using the \p ParentMacroFile relationship.
636 * @param Builder The DIBuilder.
637 * @param ParentMacroFile Macro parent (could be NULL).
638 * @param Line Source line number where the macro file is included.
639 * @param File File descriptor containing the name of the macro file.
640 */
641LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreateTempMacroFile(
642 LLVMDIBuilderRef Builder, LLVMMetadataRef ParentMacroFile, unsigned Line,
643 LLVMMetadataRef File);
644
645/**
646 * Create debugging information entry for an enumerator.
647 * @param Builder The DIBuilder.
648 * @param Name Enumerator name.
649 * @param NameLen Length of enumerator name.
650 * @param Value Enumerator value.
651 * @param IsUnsigned True if the value is unsigned.
652 */
653LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreateEnumerator(
654 LLVMDIBuilderRef Builder, const char *Name, size_t NameLen, int64_t Value,
655 LLVMBool IsUnsigned);
656
657/**
658 * Create debugging information entry for an enumerator of arbitrary precision.
659 * @param Builder The DIBuilder.
660 * @param Name Enumerator name.
661 * @param NameLen Length of enumerator name.
662 * @param SizeInBits Number of bits of the value.
663 * @param Words The words that make up the value.
664 * @param IsUnsigned True if the value is unsigned.
665 */
666LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreateEnumeratorOfArbitraryPrecision(
667 LLVMDIBuilderRef Builder, const char *Name, size_t NameLen,
668 uint64_t SizeInBits, const uint64_t Words[], LLVMBool IsUnsigned);
669
670/**
671 * Create debugging information entry for an enumeration.
672 * \param Builder The DIBuilder.
673 * \param Scope Scope in which this enumeration is defined.
674 * \param Name Enumeration name.
675 * \param NameLen Length of enumeration name.
676 * \param File File where this member is defined.
677 * \param LineNumber Line number.
678 * \param SizeInBits Member size.
679 * \param AlignInBits Member alignment.
680 * \param Elements Enumeration elements.
681 * \param NumElements Number of enumeration elements.
682 * \param ClassTy Underlying type of a C++11/ObjC fixed enum.
683 */
684LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreateEnumerationType(
685 LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
686 size_t NameLen, LLVMMetadataRef File, unsigned LineNumber,
687 uint64_t SizeInBits, uint32_t AlignInBits, LLVMMetadataRef *Elements,
688 unsigned NumElements, LLVMMetadataRef ClassTy);
689
690/**
691 * Create debugging information entry for a union.
692 * \param Builder The DIBuilder.
693 * \param Scope Scope in which this union is defined.
694 * \param Name Union name.
695 * \param NameLen Length of union name.
696 * \param File File where this member is defined.
697 * \param LineNumber Line number.
698 * \param SizeInBits Member size.
699 * \param AlignInBits Member alignment.
700 * \param Flags Flags to encode member attribute, e.g. private
701 * \param Elements Union elements.
702 * \param NumElements Number of union elements.
703 * \param RunTimeLang Optional parameter, Objective-C runtime version.
704 * \param UniqueId A unique identifier for the union.
705 * \param UniqueIdLen Length of unique identifier.
706 */
707LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreateUnionType(
708 LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
709 size_t NameLen, LLVMMetadataRef File, unsigned LineNumber,
710 uint64_t SizeInBits, uint32_t AlignInBits, LLVMDIFlags Flags,
711 LLVMMetadataRef *Elements, unsigned NumElements, unsigned RunTimeLang,
712 const char *UniqueId, size_t UniqueIdLen);
713
714/**
715 * Create debugging information entry for an array.
716 * \param Builder The DIBuilder.
717 * \param Size Array size.
718 * \param AlignInBits Alignment.
719 * \param Ty Element type.
720 * \param Subscripts Subscripts.
721 * \param NumSubscripts Number of subscripts.
722 */
723LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreateArrayType(
724 LLVMDIBuilderRef Builder, uint64_t Size, uint32_t AlignInBits,
725 LLVMMetadataRef Ty, LLVMMetadataRef *Subscripts, unsigned NumSubscripts);
726
727/**
728 * Create debugging information entry for a set.
729 * \param Builder The DIBuilder.
730 * \param Scope The scope in which the set is defined.
731 * \param Name A name that uniquely identifies this set.
732 * \param NameLen The length of the C string passed to \c Name.
733 * \param File File where the set is located.
734 * \param Line Line number of the declaration.
735 * \param SizeInBits Set size.
736 * \param AlignInBits Set alignment.
737 * \param BaseTy The base type of the set.
738 */
739LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreateSetType(
740 LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
741 size_t NameLen, LLVMMetadataRef File, unsigned LineNumber,
742 uint64_t SizeInBits, uint32_t AlignInBits, LLVMMetadataRef BaseTy);
743
744/**
745 * Create a descriptor for a subrange with dynamic bounds.
746 * \param Builder The DIBuilder.
747 * \param Scope The scope in which the subrange is defined.
748 * \param Name A name that uniquely identifies this subrange.
749 * \param NameLen The length of the C string passed to \c Name.
750 * \param LineNo Line number.
751 * \param File File where the subrange is located.
752 * \param SizeInBits Member size.
753 * \param AlignInBits Member alignment.
754 * \param Flags Flags.
755 * \param BaseTy The base type of the subrange. eg integer or enumeration
756 * \param LowerBound Lower bound of the subrange.
757 * \param UpperBound Upper bound of the subrange.
758 * \param Stride Stride of the subrange.
759 * \param Bias Bias of the subrange.
760 */
761LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreateSubrangeType(
762 LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
763 size_t NameLen, unsigned LineNo, LLVMMetadataRef File, uint64_t SizeInBits,
764 uint32_t AlignInBits, LLVMDIFlags Flags, LLVMMetadataRef BaseTy,
765 LLVMMetadataRef LowerBound, LLVMMetadataRef UpperBound,
766 LLVMMetadataRef Stride, LLVMMetadataRef Bias);
767
768/**
769 * Create debugging information entry for a dynamic array.
770 * \param Builder The DIBuilder.
771 * \param Size Array size.
772 * \param AlignInBits Alignment.
773 * \param Ty Element type.
774 * \param Subscripts Subscripts.
775 * \param NumSubscripts Number of subscripts.
776 * \param DataLocation DataLocation. (DIVariable, DIExpression or NULL)
777 * \param Associated Associated. (DIVariable, DIExpression or NULL)
778 * \param Allocated Allocated. (DIVariable, DIExpression or NULL)
779 * \param Rank Rank. (DIVariable, DIExpression or NULL)
780 * \param BitStride BitStride.
781 */
782LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreateDynamicArrayType(
783 LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
784 size_t NameLen, unsigned LineNo, LLVMMetadataRef File, uint64_t Size,
785 uint32_t AlignInBits, LLVMMetadataRef Ty, LLVMMetadataRef *Subscripts,
786 unsigned NumSubscripts, LLVMMetadataRef DataLocation,
787 LLVMMetadataRef Associated, LLVMMetadataRef Allocated, LLVMMetadataRef Rank,
788 LLVMMetadataRef BitStride);
789
790/**
791 * Replace arrays.
792 *
793 * @see DIBuilder::replaceArrays()
794 */
795LLVM_C_ABI void LLVMReplaceArrays(LLVMDIBuilderRef Builder, LLVMMetadataRef *T,
796 LLVMMetadataRef *Elements,
797 unsigned NumElements);
798
799/**
800 * Create debugging information entry for a vector type.
801 * \param Builder The DIBuilder.
802 * \param Size Vector size.
803 * \param AlignInBits Alignment.
804 * \param Ty Element type.
805 * \param Subscripts Subscripts.
806 * \param NumSubscripts Number of subscripts.
807 */
808LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreateVectorType(
809 LLVMDIBuilderRef Builder, uint64_t Size, uint32_t AlignInBits,
810 LLVMMetadataRef Ty, LLVMMetadataRef *Subscripts, unsigned NumSubscripts);
811
812/**
813 * Create a DWARF unspecified type.
814 * \param Builder The DIBuilder.
815 * \param Name The unspecified type's name.
816 * \param NameLen Length of type name.
817 */
818LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreateUnspecifiedType(
819 LLVMDIBuilderRef Builder, const char *Name, size_t NameLen);
820
821/**
822 * Create debugging information entry for a basic
823 * type.
824 * \param Builder The DIBuilder.
825 * \param Name Type name.
826 * \param NameLen Length of type name.
827 * \param SizeInBits Size of the type.
828 * \param Encoding DWARF encoding code, e.g. \c LLVMDWARFTypeEncoding_float.
829 * \param Flags Flags to encode optional attribute like endianity
830 */
831LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreateBasicType(
832 LLVMDIBuilderRef Builder, const char *Name, size_t NameLen,
833 uint64_t SizeInBits, LLVMDWARFTypeEncoding Encoding, LLVMDIFlags Flags);
834
835/**
836 * Create debugging information entry for a pointer.
837 * \param Builder The DIBuilder.
838 * \param PointeeTy Type pointed by this pointer.
839 * \param SizeInBits Size.
840 * \param AlignInBits Alignment. (optional, pass 0 to ignore)
841 * \param AddressSpace DWARF address space. (optional, pass 0 to ignore)
842 * \param Name Pointer type name. (optional)
843 * \param NameLen Length of pointer type name. (optional)
844 */
845LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreatePointerType(
846 LLVMDIBuilderRef Builder, LLVMMetadataRef PointeeTy, uint64_t SizeInBits,
847 uint32_t AlignInBits, unsigned AddressSpace, const char *Name,
848 size_t NameLen);
849
850/**
851 * Create debugging information entry for a struct.
852 * \param Builder The DIBuilder.
853 * \param Scope Scope in which this struct is defined.
854 * \param Name Struct name.
855 * \param NameLen Struct name length.
856 * \param File File where this member is defined.
857 * \param LineNumber Line number.
858 * \param SizeInBits Member size.
859 * \param AlignInBits Member alignment.
860 * \param Flags Flags to encode member attribute, e.g. private
861 * \param Elements Struct elements.
862 * \param NumElements Number of struct elements.
863 * \param RunTimeLang Optional parameter, Objective-C runtime version.
864 * \param VTableHolder The object containing the vtable for the struct.
865 * \param UniqueId A unique identifier for the struct.
866 * \param UniqueIdLen Length of the unique identifier for the struct.
867 */
868LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreateStructType(
869 LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
870 size_t NameLen, LLVMMetadataRef File, unsigned LineNumber,
871 uint64_t SizeInBits, uint32_t AlignInBits, LLVMDIFlags Flags,
872 LLVMMetadataRef DerivedFrom, LLVMMetadataRef *Elements,
873 unsigned NumElements, unsigned RunTimeLang, LLVMMetadataRef VTableHolder,
874 const char *UniqueId, size_t UniqueIdLen);
875
876/**
877 * Create debugging information entry for a member.
878 * \param Builder The DIBuilder.
879 * \param Scope Member scope.
880 * \param Name Member name.
881 * \param NameLen Length of member name.
882 * \param File File where this member is defined.
883 * \param LineNo Line number.
884 * \param SizeInBits Member size.
885 * \param AlignInBits Member alignment.
886 * \param OffsetInBits Member offset.
887 * \param Flags Flags to encode member attribute, e.g. private
888 * \param Ty Parent type.
889 */
890LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreateMemberType(
891 LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
892 size_t NameLen, LLVMMetadataRef File, unsigned LineNo, uint64_t SizeInBits,
893 uint32_t AlignInBits, uint64_t OffsetInBits, LLVMDIFlags Flags,
894 LLVMMetadataRef Ty);
895
896/**
897 * Create debugging information entry for a
898 * C++ static data member.
899 * \param Builder The DIBuilder.
900 * \param Scope Member scope.
901 * \param Name Member name.
902 * \param NameLen Length of member name.
903 * \param File File where this member is declared.
904 * \param LineNumber Line number.
905 * \param Type Type of the static member.
906 * \param Flags Flags to encode member attribute, e.g. private.
907 * \param ConstantVal Const initializer of the member.
908 * \param AlignInBits Member alignment.
909 */
910LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreateStaticMemberType(
911 LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
912 size_t NameLen, LLVMMetadataRef File, unsigned LineNumber,
913 LLVMMetadataRef Type, LLVMDIFlags Flags, LLVMValueRef ConstantVal,
914 uint32_t AlignInBits);
915
916/**
917 * Create debugging information entry for a pointer to member.
918 * \param Builder The DIBuilder.
919 * \param PointeeType Type pointed to by this pointer.
920 * \param ClassType Type for which this pointer points to members of.
921 * \param SizeInBits Size.
922 * \param AlignInBits Alignment.
923 * \param Flags Flags.
924 */
925LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreateMemberPointerType(
926 LLVMDIBuilderRef Builder, LLVMMetadataRef PointeeType,
927 LLVMMetadataRef ClassType, uint64_t SizeInBits, uint32_t AlignInBits,
928 LLVMDIFlags Flags);
929/**
930 * Create debugging information entry for Objective-C instance variable.
931 * \param Builder The DIBuilder.
932 * \param Name Member name.
933 * \param NameLen The length of the C string passed to \c Name.
934 * \param File File where this member is defined.
935 * \param LineNo Line number.
936 * \param SizeInBits Member size.
937 * \param AlignInBits Member alignment.
938 * \param OffsetInBits Member offset.
939 * \param Flags Flags to encode member attribute, e.g. private
940 * \param Ty Parent type.
941 * \param PropertyNode Property associated with this ivar.
942 */
943LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreateObjCIVar(
944 LLVMDIBuilderRef Builder, const char *Name, size_t NameLen,
945 LLVMMetadataRef File, unsigned LineNo, uint64_t SizeInBits,
946 uint32_t AlignInBits, uint64_t OffsetInBits, LLVMDIFlags Flags,
947 LLVMMetadataRef Ty, LLVMMetadataRef PropertyNode);
948
949/**
950 * Create debugging information entry for Objective-C property.
951 * \param Builder The DIBuilder.
952 * \param Name Property name.
953 * \param NameLen The length of the C string passed to \c Name.
954 * \param File File where this property is defined.
955 * \param LineNo Line number.
956 * \param GetterName Name of the Objective C property getter selector.
957 * \param GetterNameLen The length of the C string passed to \c GetterName.
958 * \param SetterName Name of the Objective C property setter selector.
959 * \param SetterNameLen The length of the C string passed to \c SetterName.
960 * \param PropertyAttributes Objective C property attributes.
961 * \param Ty Type.
962 */
963LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreateObjCProperty(
964 LLVMDIBuilderRef Builder, const char *Name, size_t NameLen,
965 LLVMMetadataRef File, unsigned LineNo, const char *GetterName,
966 size_t GetterNameLen, const char *SetterName, size_t SetterNameLen,
967 unsigned PropertyAttributes, LLVMMetadataRef Ty);
968
969/**
970 * Create a uniqued DIType* clone with FlagObjectPointer. If \c Implicit
971 * is true, then also set FlagArtificial.
972 * \param Builder The DIBuilder.
973 * \param Type The underlying type to which this pointer points.
974 * \param Implicit Indicates whether this pointer was implicitly generated
975 * (i.e., not spelled out in source).
976 */
977LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreateObjectPointerType(
978 LLVMDIBuilderRef Builder, LLVMMetadataRef Type, LLVMBool Implicit);
979
980/**
981 * Create debugging information entry for a qualified
982 * type, e.g. 'const int'.
983 * \param Builder The DIBuilder.
984 * \param Tag Tag identifying type,
985 * e.g. LLVMDWARFTypeQualifier_volatile_type
986 * \param Type Base Type.
987 */
988LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreateQualifiedType(
989 LLVMDIBuilderRef Builder, unsigned Tag, LLVMMetadataRef Type);
990
991/**
992 * Create debugging information entry for a c++
993 * style reference or rvalue reference type.
994 * \param Builder The DIBuilder.
995 * \param Tag Tag identifying type,
996 * \param Type Base Type.
997 */
998LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreateReferenceType(
999 LLVMDIBuilderRef Builder, unsigned Tag, LLVMMetadataRef Type);
1000
1001/**
1002 * Create C++11 nullptr type.
1003 * \param Builder The DIBuilder.
1004 */
1005LLVM_C_ABI LLVMMetadataRef
1006LLVMDIBuilderCreateNullPtrType(LLVMDIBuilderRef Builder);
1007
1008/**
1009 * Create debugging information entry for a typedef.
1010 * \param Builder The DIBuilder.
1011 * \param Type Original type.
1012 * \param Name Typedef name.
1013 * \param File File where this type is defined.
1014 * \param LineNo Line number.
1015 * \param Scope The surrounding context for the typedef.
1016 */
1017LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreateTypedef(
1018 LLVMDIBuilderRef Builder, LLVMMetadataRef Type, const char *Name,
1019 size_t NameLen, LLVMMetadataRef File, unsigned LineNo,
1020 LLVMMetadataRef Scope, uint32_t AlignInBits);
1021
1022/**
1023 * Create debugging information entry to establish inheritance relationship
1024 * between two types.
1025 * \param Builder The DIBuilder.
1026 * \param Ty Original type.
1027 * \param BaseTy Base type. Ty is inherits from base.
1028 * \param BaseOffset Base offset.
1029 * \param VBPtrOffset Virtual base pointer offset.
1030 * \param Flags Flags to describe inheritance attribute, e.g. private
1031 */
1032LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreateInheritance(
1033 LLVMDIBuilderRef Builder, LLVMMetadataRef Ty, LLVMMetadataRef BaseTy,
1034 uint64_t BaseOffset, uint32_t VBPtrOffset, LLVMDIFlags Flags);
1035
1036/**
1037 * Create a permanent forward-declared type.
1038 * \param Builder The DIBuilder.
1039 * \param Tag A unique tag for this type.
1040 * \param Name Type name.
1041 * \param NameLen Length of type name.
1042 * \param Scope Type scope.
1043 * \param File File where this type is defined.
1044 * \param Line Line number where this type is defined.
1045 * \param RuntimeLang Indicates runtime version for languages like
1046 * Objective-C.
1047 * \param SizeInBits Member size.
1048 * \param AlignInBits Member alignment.
1049 * \param UniqueIdentifier A unique identifier for the type.
1050 * \param UniqueIdentifierLen Length of the unique identifier.
1051 */
1052LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreateForwardDecl(
1053 LLVMDIBuilderRef Builder, unsigned Tag, const char *Name, size_t NameLen,
1054 LLVMMetadataRef Scope, LLVMMetadataRef File, unsigned Line,
1055 unsigned RuntimeLang, uint64_t SizeInBits, uint32_t AlignInBits,
1056 const char *UniqueIdentifier, size_t UniqueIdentifierLen);
1057
1058/**
1059 * Create a temporary forward-declared type.
1060 * \param Builder The DIBuilder.
1061 * \param Tag A unique tag for this type.
1062 * \param Name Type name.
1063 * \param NameLen Length of type name.
1064 * \param Scope Type scope.
1065 * \param File File where this type is defined.
1066 * \param Line Line number where this type is defined.
1067 * \param RuntimeLang Indicates runtime version for languages like
1068 * Objective-C.
1069 * \param SizeInBits Member size.
1070 * \param AlignInBits Member alignment.
1071 * \param Flags Flags.
1072 * \param UniqueIdentifier A unique identifier for the type.
1073 * \param UniqueIdentifierLen Length of the unique identifier.
1074 */
1075LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreateReplaceableCompositeType(
1076 LLVMDIBuilderRef Builder, unsigned Tag, const char *Name, size_t NameLen,
1077 LLVMMetadataRef Scope, LLVMMetadataRef File, unsigned Line,
1078 unsigned RuntimeLang, uint64_t SizeInBits, uint32_t AlignInBits,
1079 LLVMDIFlags Flags, const char *UniqueIdentifier,
1080 size_t UniqueIdentifierLen);
1081
1082/**
1083 * Create debugging information entry for a bit field member.
1084 * \param Builder The DIBuilder.
1085 * \param Scope Member scope.
1086 * \param Name Member name.
1087 * \param NameLen Length of member name.
1088 * \param File File where this member is defined.
1089 * \param LineNumber Line number.
1090 * \param SizeInBits Member size.
1091 * \param OffsetInBits Member offset.
1092 * \param StorageOffsetInBits Member storage offset.
1093 * \param Flags Flags to encode member attribute.
1094 * \param Type Parent type.
1095 */
1096LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreateBitFieldMemberType(
1097 LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
1098 size_t NameLen, LLVMMetadataRef File, unsigned LineNumber,
1099 uint64_t SizeInBits, uint64_t OffsetInBits, uint64_t StorageOffsetInBits,
1100 LLVMDIFlags Flags, LLVMMetadataRef Type);
1101
1102/**
1103 * Create debugging information entry for a class.
1104 * \param Scope Scope in which this class is defined.
1105 * \param Name Class name.
1106 * \param NameLen The length of the C string passed to \c Name.
1107 * \param File File where this member is defined.
1108 * \param LineNumber Line number.
1109 * \param SizeInBits Member size.
1110 * \param AlignInBits Member alignment.
1111 * \param OffsetInBits Member offset.
1112 * \param Flags Flags to encode member attribute, e.g. private.
1113 * \param DerivedFrom Debug info of the base class of this type.
1114 * \param Elements Class members.
1115 * \param NumElements Number of class elements.
1116 * \param VTableHolder Debug info of the base class that contains vtable
1117 * for this type. This is used in
1118 * DW_AT_containing_type. See DWARF documentation
1119 * for more info.
1120 * \param TemplateParamsNode Template type parameters.
1121 * \param UniqueIdentifier A unique identifier for the type.
1122 * \param UniqueIdentifierLen Length of the unique identifier.
1123 */
1124LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreateClassType(
1125 LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
1126 size_t NameLen, LLVMMetadataRef File, unsigned LineNumber,
1127 uint64_t SizeInBits, uint32_t AlignInBits, uint64_t OffsetInBits,
1128 LLVMDIFlags Flags, LLVMMetadataRef DerivedFrom, LLVMMetadataRef *Elements,
1129 unsigned NumElements, LLVMMetadataRef VTableHolder,
1130 LLVMMetadataRef TemplateParamsNode, const char *UniqueIdentifier,
1131 size_t UniqueIdentifierLen);
1132
1133/**
1134 * Create a uniqued DIType* clone with FlagArtificial set.
1135 * \param Builder The DIBuilder.
1136 * \param Type The underlying type.
1137 */
1138LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreateArtificialType(
1139 LLVMDIBuilderRef Builder, LLVMMetadataRef Type);
1140
1141/**
1142 * Get the name of this DIType.
1143 * \param DType The DIType.
1144 * \param Length The length of the returned string.
1145 *
1146 * @see DIType::getName()
1147 */
1148LLVM_C_ABI const char *LLVMDITypeGetName(LLVMMetadataRef DType, size_t *Length);
1149
1150/**
1151 * Get the size of this DIType in bits.
1152 * \param DType The DIType.
1153 *
1154 * @see DIType::getSizeInBits()
1155 */
1156LLVM_C_ABI uint64_t LLVMDITypeGetSizeInBits(LLVMMetadataRef DType);
1157
1158/**
1159 * Get the offset of this DIType in bits.
1160 * \param DType The DIType.
1161 *
1162 * @see DIType::getOffsetInBits()
1163 */
1164LLVM_C_ABI uint64_t LLVMDITypeGetOffsetInBits(LLVMMetadataRef DType);
1165
1166/**
1167 * Get the alignment of this DIType in bits.
1168 * \param DType The DIType.
1169 *
1170 * @see DIType::getAlignInBits()
1171 */
1172LLVM_C_ABI uint32_t LLVMDITypeGetAlignInBits(LLVMMetadataRef DType);
1173
1174/**
1175 * Get the source line where this DIType is declared.
1176 * \param DType The DIType.
1177 *
1178 * @see DIType::getLine()
1179 */
1180LLVM_C_ABI unsigned LLVMDITypeGetLine(LLVMMetadataRef DType);
1181
1182/**
1183 * Get the flags associated with this DIType.
1184 * \param DType The DIType.
1185 *
1186 * @see DIType::getFlags()
1187 */
1188LLVM_C_ABI LLVMDIFlags LLVMDITypeGetFlags(LLVMMetadataRef DType);
1189
1190/**
1191 * Create a descriptor for a value range.
1192 * \param Builder The DIBuilder.
1193 * \param LowerBound Lower bound of the subrange, e.g. 0 for C, 1 for Fortran.
1194 * \param Count Count of elements in the subrange.
1195 */
1196LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderGetOrCreateSubrange(
1197 LLVMDIBuilderRef Builder, int64_t LowerBound, int64_t Count);
1198
1199/**
1200 * Create an array of DI Nodes.
1201 * \param Builder The DIBuilder.
1202 * \param Data The DI Node elements.
1203 * \param NumElements Number of DI Node elements.
1204 */
1205LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderGetOrCreateArray(
1206 LLVMDIBuilderRef Builder, LLVMMetadataRef *Data, size_t NumElements);
1207
1208/**
1209 * Create a new descriptor for the specified variable which has a complex
1210 * address expression for its address.
1211 * \param Builder The DIBuilder.
1212 * \param Addr An array of complex address operations.
1213 * \param Length Length of the address operation array.
1214 */
1215LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreateExpression(
1216 LLVMDIBuilderRef Builder, uint64_t *Addr, size_t Length);
1217
1218/**
1219 * Create a new descriptor for the specified variable that does not have an
1220 * address, but does have a constant value.
1221 * \param Builder The DIBuilder.
1222 * \param Value The constant value.
1223 */
1224LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreateConstantValueExpression(
1225 LLVMDIBuilderRef Builder, uint64_t Value);
1226
1227/**
1228 * Create a new descriptor for the specified variable.
1229 * \param Scope Variable scope.
1230 * \param Name Name of the variable.
1231 * \param NameLen The length of the C string passed to \c Name.
1232 * \param Linkage Mangled name of the variable.
1233 * \param LinkLen The length of the C string passed to \c Linkage.
1234 * \param File File where this variable is defined.
1235 * \param LineNo Line number.
1236 * \param Ty Variable Type.
1237 * \param LocalToUnit Boolean flag indicate whether this variable is
1238 * externally visible or not.
1239 * \param Expr The location of the global relative to the attached
1240 * GlobalVariable.
1241 * \param Decl Reference to the corresponding declaration.
1242 * variables.
1243 * \param AlignInBits Variable alignment(or 0 if no alignment attr was
1244 * specified)
1245 */
1246LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreateGlobalVariableExpression(
1247 LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
1248 size_t NameLen, const char *Linkage, size_t LinkLen, LLVMMetadataRef File,
1249 unsigned LineNo, LLVMMetadataRef Ty, LLVMBool LocalToUnit,
1250 LLVMMetadataRef Expr, LLVMMetadataRef Decl, uint32_t AlignInBits);
1251
1252/**
1253 * Get the dwarf::Tag of a DINode
1254 */
1255LLVM_C_ABI uint16_t LLVMGetDINodeTag(LLVMMetadataRef MD);
1256
1257/**
1258 * Retrieves the \c DIVariable associated with this global variable expression.
1259 * \param GVE The global variable expression.
1260 *
1261 * @see llvm::DIGlobalVariableExpression::getVariable()
1262 */
1263LLVM_C_ABI LLVMMetadataRef
1264LLVMDIGlobalVariableExpressionGetVariable(LLVMMetadataRef GVE);
1265
1266/**
1267 * Retrieves the \c DIExpression associated with this global variable expression.
1268 * \param GVE The global variable expression.
1269 *
1270 * @see llvm::DIGlobalVariableExpression::getExpression()
1271 */
1272LLVM_C_ABI LLVMMetadataRef
1273LLVMDIGlobalVariableExpressionGetExpression(LLVMMetadataRef GVE);
1274
1275/**
1276 * Get the metadata of the file associated with a given variable.
1277 * \param Var The variable object.
1278 *
1279 * @see DIVariable::getFile()
1280 */
1281LLVM_C_ABI LLVMMetadataRef LLVMDIVariableGetFile(LLVMMetadataRef Var);
1282
1283/**
1284 * Get the metadata of the scope associated with a given variable.
1285 * \param Var The variable object.
1286 *
1287 * @see DIVariable::getScope()
1288 */
1289LLVM_C_ABI LLVMMetadataRef LLVMDIVariableGetScope(LLVMMetadataRef Var);
1290
1291/**
1292 * Get the source line where this \c DIVariable is declared.
1293 * \param Var The DIVariable.
1294 *
1295 * @see DIVariable::getLine()
1296 */
1297LLVM_C_ABI unsigned LLVMDIVariableGetLine(LLVMMetadataRef Var);
1298
1299/**
1300 * Create a new temporary \c MDNode. Suitable for use in constructing cyclic
1301 * \c MDNode structures. A temporary \c MDNode is not uniqued, may be RAUW'd,
1302 * and must be manually deleted with \c LLVMDisposeTemporaryMDNode.
1303 * \param Ctx The context in which to construct the temporary node.
1304 * \param Data The metadata elements.
1305 * \param NumElements Number of metadata elements.
1306 */
1307LLVM_C_ABI LLVMMetadataRef LLVMTemporaryMDNode(LLVMContextRef Ctx,
1308 LLVMMetadataRef *Data,
1309 size_t NumElements);
1310
1311/**
1312 * Deallocate a temporary node.
1313 *
1314 * Calls \c replaceAllUsesWith(nullptr) before deleting, so any remaining
1315 * references will be reset.
1316 * \param TempNode The temporary metadata node.
1317 */
1318LLVM_C_ABI void LLVMDisposeTemporaryMDNode(LLVMMetadataRef TempNode);
1319
1320/**
1321 * Replace all uses of temporary metadata.
1322 * \param TempTargetMetadata The temporary metadata node.
1323 * \param Replacement The replacement metadata node.
1324 */
1325LLVM_C_ABI void
1326LLVMMetadataReplaceAllUsesWith(LLVMMetadataRef TempTargetMetadata,
1327 LLVMMetadataRef Replacement);
1328
1329/**
1330 * Create a new descriptor for the specified global variable that is temporary
1331 * and meant to be RAUWed.
1332 * \param Scope Variable scope.
1333 * \param Name Name of the variable.
1334 * \param NameLen The length of the C string passed to \c Name.
1335 * \param Linkage Mangled name of the variable.
1336 * \param LnkLen The length of the C string passed to \c Linkage.
1337 * \param File File where this variable is defined.
1338 * \param LineNo Line number.
1339 * \param Ty Variable Type.
1340 * \param LocalToUnit Boolean flag indicate whether this variable is
1341 * externally visible or not.
1342 * \param Decl Reference to the corresponding declaration.
1343 * \param AlignInBits Variable alignment(or 0 if no alignment attr was
1344 * specified)
1345 */
1346LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreateTempGlobalVariableFwdDecl(
1347 LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
1348 size_t NameLen, const char *Linkage, size_t LnkLen, LLVMMetadataRef File,
1349 unsigned LineNo, LLVMMetadataRef Ty, LLVMBool LocalToUnit,
1350 LLVMMetadataRef Decl, uint32_t AlignInBits);
1351
1352/**
1353 * Only use in "new debug format" (LLVMIsNewDbgInfoFormat() is true).
1354 * See https://llvm.org/docs/RemoveDIsDebugInfo.html#c-api-changes
1355 *
1356 * The debug format can be switched later after inserting the records using
1357 * LLVMSetIsNewDbgInfoFormat, if needed for legacy or transitionary reasons.
1358 *
1359 * Insert a Declare DbgRecord before the given instruction.
1360 * \param Builder The DIBuilder.
1361 * \param Storage The storage of the variable to declare.
1362 * \param VarInfo The variable's debug info descriptor.
1363 * \param Expr A complex location expression for the variable.
1364 * \param DebugLoc Debug info location.
1365 * \param Instr Instruction acting as a location for the new record.
1366 */
1367LLVM_C_ABI LLVMDbgRecordRef LLVMDIBuilderInsertDeclareRecordBefore(
1368 LLVMDIBuilderRef Builder, LLVMValueRef Storage, LLVMMetadataRef VarInfo,
1369 LLVMMetadataRef Expr, LLVMMetadataRef DebugLoc, LLVMValueRef Instr);
1370
1371/**
1372 * Only use in "new debug format" (LLVMIsNewDbgInfoFormat() is true).
1373 * See https://llvm.org/docs/RemoveDIsDebugInfo.html#c-api-changes
1374 *
1375 * The debug format can be switched later after inserting the records using
1376 * LLVMSetIsNewDbgInfoFormat, if needed for legacy or transitionary reasons.
1377 *
1378 * Insert a Declare DbgRecord at the end of the given basic block. If the basic
1379 * block has a terminator instruction, the record is inserted before that
1380 * terminator instruction.
1381 * \param Builder The DIBuilder.
1382 * \param Storage The storage of the variable to declare.
1383 * \param VarInfo The variable's debug info descriptor.
1384 * \param Expr A complex location expression for the variable.
1385 * \param DebugLoc Debug info location.
1386 * \param Block Basic block acting as a location for the new record.
1387 */
1388LLVM_C_ABI LLVMDbgRecordRef LLVMDIBuilderInsertDeclareRecordAtEnd(
1389 LLVMDIBuilderRef Builder, LLVMValueRef Storage, LLVMMetadataRef VarInfo,
1390 LLVMMetadataRef Expr, LLVMMetadataRef DebugLoc, LLVMBasicBlockRef Block);
1391
1392/**
1393 * Only use in "new debug format" (LLVMIsNewDbgInfoFormat() is true).
1394 * See https://llvm.org/docs/RemoveDIsDebugInfo.html#c-api-changes
1395 *
1396 * The debug format can be switched later after inserting the records using
1397 * LLVMSetIsNewDbgInfoFormat, if needed for legacy or transitionary reasons.
1398 *
1399 * Insert a new debug record before the given instruction.
1400 * \param Builder The DIBuilder.
1401 * \param Val The value of the variable.
1402 * \param VarInfo The variable's debug info descriptor.
1403 * \param Expr A complex location expression for the variable.
1404 * \param DebugLoc Debug info location.
1405 * \param Instr Instruction acting as a location for the new record.
1406 */
1407LLVM_C_ABI LLVMDbgRecordRef LLVMDIBuilderInsertDbgValueRecordBefore(
1408 LLVMDIBuilderRef Builder, LLVMValueRef Val, LLVMMetadataRef VarInfo,
1409 LLVMMetadataRef Expr, LLVMMetadataRef DebugLoc, LLVMValueRef Instr);
1410
1411/**
1412 * Only use in "new debug format" (LLVMIsNewDbgInfoFormat() is true).
1413 * See https://llvm.org/docs/RemoveDIsDebugInfo.html#c-api-changes
1414 *
1415 * The debug format can be switched later after inserting the records using
1416 * LLVMSetIsNewDbgInfoFormat, if needed for legacy or transitionary reasons.
1417 *
1418 * Insert a new debug record at the end of the given basic block. If the
1419 * basic block has a terminator instruction, the record is inserted before
1420 * that terminator instruction.
1421 * \param Builder The DIBuilder.
1422 * \param Val The value of the variable.
1423 * \param VarInfo The variable's debug info descriptor.
1424 * \param Expr A complex location expression for the variable.
1425 * \param DebugLoc Debug info location.
1426 * \param Block Basic block acting as a location for the new record.
1427 */
1428LLVM_C_ABI LLVMDbgRecordRef LLVMDIBuilderInsertDbgValueRecordAtEnd(
1429 LLVMDIBuilderRef Builder, LLVMValueRef Val, LLVMMetadataRef VarInfo,
1430 LLVMMetadataRef Expr, LLVMMetadataRef DebugLoc, LLVMBasicBlockRef Block);
1431
1432/**
1433 * Create a new descriptor for a local auto variable.
1434 * \param Builder The DIBuilder.
1435 * \param Scope The local scope the variable is declared in.
1436 * \param Name Variable name.
1437 * \param NameLen Length of variable name.
1438 * \param File File where this variable is defined.
1439 * \param LineNo Line number.
1440 * \param Ty Metadata describing the type of the variable.
1441 * \param AlwaysPreserve If true, this descriptor will survive optimizations.
1442 * \param Flags Flags.
1443 * \param AlignInBits Variable alignment.
1444 */
1445LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreateAutoVariable(
1446 LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
1447 size_t NameLen, LLVMMetadataRef File, unsigned LineNo, LLVMMetadataRef Ty,
1448 LLVMBool AlwaysPreserve, LLVMDIFlags Flags, uint32_t AlignInBits);
1449
1450/**
1451 * Create a new descriptor for a function parameter variable.
1452 * \param Builder The DIBuilder.
1453 * \param Scope The local scope the variable is declared in.
1454 * \param Name Variable name.
1455 * \param NameLen Length of variable name.
1456 * \param ArgNo Unique argument number for this variable; starts at 1.
1457 * \param File File where this variable is defined.
1458 * \param LineNo Line number.
1459 * \param Ty Metadata describing the type of the variable.
1460 * \param AlwaysPreserve If true, this descriptor will survive optimizations.
1461 * \param Flags Flags.
1462 */
1463LLVM_C_ABI LLVMMetadataRef LLVMDIBuilderCreateParameterVariable(
1464 LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
1465 size_t NameLen, unsigned ArgNo, LLVMMetadataRef File, unsigned LineNo,
1466 LLVMMetadataRef Ty, LLVMBool AlwaysPreserve, LLVMDIFlags Flags);
1467
1468/**
1469 * Get the metadata of the subprogram attached to a function.
1470 *
1471 * @see llvm::Function::getSubprogram()
1472 */
1473LLVM_C_ABI LLVMMetadataRef LLVMGetSubprogram(LLVMValueRef Func);
1474
1475/**
1476 * Set the subprogram attached to a function.
1477 *
1478 * @see llvm::Function::setSubprogram()
1479 */
1480LLVM_C_ABI void LLVMSetSubprogram(LLVMValueRef Func, LLVMMetadataRef SP);
1481
1482/**
1483 * Get the line associated with a given subprogram.
1484 * \param Subprogram The subprogram object.
1485 *
1486 * @see DISubprogram::getLine()
1487 */
1488LLVM_C_ABI unsigned LLVMDISubprogramGetLine(LLVMMetadataRef Subprogram);
1489
1490/**
1491 * Replace the subprogram subroutine type.
1492 * \param Subprogram The subprogram object.
1493 * \param SubroutineType The new subroutine type.
1494 *
1495 * @see DISubprogram::replaceType()
1496 */
1497LLVM_C_ABI void LLVMDISubprogramReplaceType(LLVMMetadataRef Subprogram,
1498 LLVMMetadataRef SubroutineType);
1499
1500/**
1501 * Get the debug location for the given instruction.
1502 *
1503 * @see llvm::Instruction::getDebugLoc()
1504 */
1505LLVM_C_ABI LLVMMetadataRef LLVMInstructionGetDebugLoc(LLVMValueRef Inst);
1506
1507/**
1508 * Set the debug location for the given instruction.
1509 *
1510 * To clear the location metadata of the given instruction, pass NULL to \p Loc.
1511 *
1512 * @see llvm::Instruction::setDebugLoc()
1513 */
1514LLVM_C_ABI void LLVMInstructionSetDebugLoc(LLVMValueRef Inst,
1515 LLVMMetadataRef Loc);
1516
1517/**
1518 * Create a new descriptor for a label
1519 *
1520 * \param Builder The DIBuilder.
1521 * \param Scope The scope to create the label in.
1522 * \param Name Variable name.
1523 * \param NameLen Length of variable name.
1524 * \param File The file to create the label in.
1525 * \param LineNo Line Number.
1526 * \param AlwaysPreserve Preserve the label regardless of optimization.
1527 *
1528 * @see llvm::DIBuilder::createLabel()
1529 */
1530LLVM_C_ABI LLVMMetadataRef
1531LLVMDIBuilderCreateLabel(LLVMDIBuilderRef Builder, LLVMMetadataRef Context,
1532 const char *Name, size_t NameLen, LLVMMetadataRef File,
1533 unsigned LineNo, LLVMBool AlwaysPreserve);
1534
1535/**
1536 * Insert a new llvm.dbg.label intrinsic call
1537 *
1538 * \param Builder The DIBuilder.
1539 * \param LabelInfo The Label's debug info descriptor
1540 * \param Location The debug info location
1541 * \param InsertBefore Location for the new intrinsic.
1542 *
1543 * @see llvm::DIBuilder::insertLabel()
1544 */
1545LLVM_C_ABI LLVMDbgRecordRef LLVMDIBuilderInsertLabelBefore(
1546 LLVMDIBuilderRef Builder, LLVMMetadataRef LabelInfo,
1547 LLVMMetadataRef Location, LLVMValueRef InsertBefore);
1548
1549/**
1550 * Insert a new llvm.dbg.label intrinsic call
1551 *
1552 * \param Builder The DIBuilder.
1553 * \param LabelInfo The Label's debug info descriptor
1554 * \param Location The debug info location
1555 * \param InsertAtEnd Location for the new intrinsic.
1556 *
1557 * @see llvm::DIBuilder::insertLabel()
1558 */
1559LLVM_C_ABI LLVMDbgRecordRef LLVMDIBuilderInsertLabelAtEnd(
1560 LLVMDIBuilderRef Builder, LLVMMetadataRef LabelInfo,
1561 LLVMMetadataRef Location, LLVMBasicBlockRef InsertAtEnd);
1562
1563/**
1564 * Obtain the enumerated type of a Metadata instance.
1565 *
1566 * @see llvm::Metadata::getMetadataID()
1567 */
1568LLVM_C_ABI LLVMMetadataKind LLVMGetMetadataKind(LLVMMetadataRef Metadata);
1569
1570/**
1571 * @}
1572 */
1573
1574LLVM_C_EXTERN_C_END
1575
1576#endif
1577