2 #include "llvm/IR/CallSite.h"
3 #include "llvm/IR/DebugInfoMetadata.h"
4 #include "llvm/IR/DiagnosticInfo.h"
5 #include "llvm/IR/DiagnosticPrinter.h"
6 #include "llvm/IR/GlobalVariable.h"
7 #include "llvm/IR/Instructions.h"
8 #include "llvm/Object/Archive.h"
9 #include "llvm/Object/ObjectFile.h"
10 #include "llvm/Bitcode/BitcodeWriterPass.h"
11 #include "llvm/Support/Signals.h"
12 #include "llvm/ADT/Optional.h"
16 //===----------------------------------------------------------------------===
18 // This file defines alternate interfaces to core functions that are more
19 // readily callable by Rust's FFI.
21 //===----------------------------------------------------------------------===
24 using namespace llvm::sys;
25 using namespace llvm::object;
27 // LLVMAtomicOrdering is already an enum - don't create another
29 static AtomicOrdering fromRust(LLVMAtomicOrdering Ordering) {
31 case LLVMAtomicOrderingNotAtomic:
32 return AtomicOrdering::NotAtomic;
33 case LLVMAtomicOrderingUnordered:
34 return AtomicOrdering::Unordered;
35 case LLVMAtomicOrderingMonotonic:
36 return AtomicOrdering::Monotonic;
37 case LLVMAtomicOrderingAcquire:
38 return AtomicOrdering::Acquire;
39 case LLVMAtomicOrderingRelease:
40 return AtomicOrdering::Release;
41 case LLVMAtomicOrderingAcquireRelease:
42 return AtomicOrdering::AcquireRelease;
43 case LLVMAtomicOrderingSequentiallyConsistent:
44 return AtomicOrdering::SequentiallyConsistent;
47 report_fatal_error("Invalid LLVMAtomicOrdering value!");
50 static LLVM_THREAD_LOCAL char *LastError;
52 // Custom error handler for fatal LLVM errors.
54 // Notably it exits the process with code 101, unlike LLVM's default of 1.
55 static void FatalErrorHandler(void *UserData,
56 const std::string& Reason,
58 // Do the same thing that the default error handler does.
59 std::cerr << "LLVM ERROR: " << Reason << std::endl;
61 // Since this error handler exits the process, we have to run any cleanup that
62 // LLVM would run after handling the error. This might change with an LLVM
64 sys::RunInterruptHandlers();
69 extern "C" void LLVMRustInstallFatalErrorHandler() {
70 install_fatal_error_handler(FatalErrorHandler);
73 extern "C" LLVMMemoryBufferRef
74 LLVMRustCreateMemoryBufferWithContentsOfFile(const char *Path) {
75 ErrorOr<std::unique_ptr<MemoryBuffer>> BufOr =
76 MemoryBuffer::getFile(Path, -1, false);
78 LLVMRustSetLastError(BufOr.getError().message().c_str());
81 return wrap(BufOr.get().release());
84 extern "C" char *LLVMRustGetLastError(void) {
85 char *Ret = LastError;
90 extern "C" void LLVMRustSetLastError(const char *Err) {
91 free((void *)LastError);
92 LastError = strdup(Err);
95 extern "C" LLVMContextRef LLVMRustContextCreate(bool shouldDiscardNames) {
96 auto ctx = new LLVMContext();
97 ctx->setDiscardValueNames(shouldDiscardNames);
101 extern "C" void LLVMRustSetNormalizedTarget(LLVMModuleRef M,
102 const char *Triple) {
103 unwrap(M)->setTargetTriple(Triple::normalize(Triple));
106 extern "C" void LLVMRustPrintPassTimings() {
107 raw_fd_ostream OS(2, false); // stderr.
108 TimerGroup::printAll(OS);
111 extern "C" LLVMValueRef LLVMRustGetNamedValue(LLVMModuleRef M,
113 return wrap(unwrap(M)->getNamedValue(Name));
116 extern "C" LLVMValueRef LLVMRustGetOrInsertFunction(LLVMModuleRef M,
118 LLVMTypeRef FunctionTy) {
120 unwrap(M)->getOrInsertFunction(Name, unwrap<FunctionType>(FunctionTy))
121 #if LLVM_VERSION_GE(9, 0)
127 extern "C" LLVMValueRef
128 LLVMRustGetOrInsertGlobal(LLVMModuleRef M, const char *Name, LLVMTypeRef Ty) {
129 return wrap(unwrap(M)->getOrInsertGlobal(Name, unwrap(Ty)));
132 extern "C" LLVMValueRef
133 LLVMRustInsertPrivateGlobal(LLVMModuleRef M, LLVMTypeRef Ty) {
134 return wrap(new GlobalVariable(*unwrap(M),
137 GlobalValue::PrivateLinkage,
141 extern "C" LLVMTypeRef LLVMRustMetadataTypeInContext(LLVMContextRef C) {
142 return wrap(Type::getMetadataTy(*unwrap(C)));
145 static Attribute::AttrKind fromRust(LLVMRustAttribute Kind) {
148 return Attribute::AlwaysInline;
150 return Attribute::ByVal;
152 return Attribute::Cold;
154 return Attribute::InlineHint;
156 return Attribute::MinSize;
158 return Attribute::Naked;
160 return Attribute::NoAlias;
162 return Attribute::NoCapture;
164 return Attribute::NoInline;
166 return Attribute::NonNull;
168 return Attribute::NoRedZone;
170 return Attribute::NoReturn;
172 return Attribute::NoUnwind;
173 case OptimizeForSize:
174 return Attribute::OptimizeForSize;
176 return Attribute::ReadOnly;
178 return Attribute::SExt;
180 return Attribute::StructRet;
182 return Attribute::UWTable;
184 return Attribute::ZExt;
186 return Attribute::InReg;
188 return Attribute::SanitizeThread;
189 case SanitizeAddress:
190 return Attribute::SanitizeAddress;
192 return Attribute::SanitizeMemory;
194 return Attribute::NonLazyBind;
196 return Attribute::OptimizeNone;
198 return Attribute::ReturnsTwice;
200 report_fatal_error("bad AttributeKind");
203 extern "C" void LLVMRustAddCallSiteAttribute(LLVMValueRef Instr, unsigned Index,
204 LLVMRustAttribute RustAttr) {
205 CallSite Call = CallSite(unwrap<Instruction>(Instr));
206 Attribute Attr = Attribute::get(Call->getContext(), fromRust(RustAttr));
207 Call.addAttribute(Index, Attr);
210 extern "C" void LLVMRustAddAlignmentCallSiteAttr(LLVMValueRef Instr,
213 CallSite Call = CallSite(unwrap<Instruction>(Instr));
215 B.addAlignmentAttr(Bytes);
216 Call.setAttributes(Call.getAttributes().addAttributes(
217 Call->getContext(), Index, B));
220 extern "C" void LLVMRustAddDereferenceableCallSiteAttr(LLVMValueRef Instr,
223 CallSite Call = CallSite(unwrap<Instruction>(Instr));
225 B.addDereferenceableAttr(Bytes);
226 Call.setAttributes(Call.getAttributes().addAttributes(
227 Call->getContext(), Index, B));
230 extern "C" void LLVMRustAddDereferenceableOrNullCallSiteAttr(LLVMValueRef Instr,
233 CallSite Call = CallSite(unwrap<Instruction>(Instr));
235 B.addDereferenceableOrNullAttr(Bytes);
236 Call.setAttributes(Call.getAttributes().addAttributes(
237 Call->getContext(), Index, B));
240 extern "C" void LLVMRustAddFunctionAttribute(LLVMValueRef Fn, unsigned Index,
241 LLVMRustAttribute RustAttr) {
242 Function *A = unwrap<Function>(Fn);
243 Attribute Attr = Attribute::get(A->getContext(), fromRust(RustAttr));
245 A->addAttributes(Index, B);
248 extern "C" void LLVMRustAddAlignmentAttr(LLVMValueRef Fn,
251 Function *A = unwrap<Function>(Fn);
253 B.addAlignmentAttr(Bytes);
254 A->addAttributes(Index, B);
257 extern "C" void LLVMRustAddDereferenceableAttr(LLVMValueRef Fn, unsigned Index,
259 Function *A = unwrap<Function>(Fn);
261 B.addDereferenceableAttr(Bytes);
262 A->addAttributes(Index, B);
265 extern "C" void LLVMRustAddDereferenceableOrNullAttr(LLVMValueRef Fn,
268 Function *A = unwrap<Function>(Fn);
270 B.addDereferenceableOrNullAttr(Bytes);
271 A->addAttributes(Index, B);
274 extern "C" void LLVMRustAddFunctionAttrStringValue(LLVMValueRef Fn,
278 Function *F = unwrap<Function>(Fn);
280 B.addAttribute(Name, Value);
281 F->addAttributes(Index, B);
284 extern "C" void LLVMRustRemoveFunctionAttributes(LLVMValueRef Fn,
286 LLVMRustAttribute RustAttr) {
287 Function *F = unwrap<Function>(Fn);
288 Attribute Attr = Attribute::get(F->getContext(), fromRust(RustAttr));
290 auto PAL = F->getAttributes();
291 auto PALNew = PAL.removeAttributes(F->getContext(), Index, B);
292 F->setAttributes(PALNew);
295 // enable fpmath flag UnsafeAlgebra
296 extern "C" void LLVMRustSetHasUnsafeAlgebra(LLVMValueRef V) {
297 if (auto I = dyn_cast<Instruction>(unwrap<Value>(V))) {
302 extern "C" LLVMValueRef
303 LLVMRustBuildAtomicLoad(LLVMBuilderRef B, LLVMValueRef Source, const char *Name,
304 LLVMAtomicOrdering Order) {
305 LoadInst *LI = new LoadInst(unwrap(Source));
306 LI->setAtomic(fromRust(Order));
307 return wrap(unwrap(B)->Insert(LI, Name));
310 extern "C" LLVMValueRef LLVMRustBuildAtomicStore(LLVMBuilderRef B,
313 LLVMAtomicOrdering Order) {
314 StoreInst *SI = new StoreInst(unwrap(V), unwrap(Target));
315 SI->setAtomic(fromRust(Order));
316 return wrap(unwrap(B)->Insert(SI));
319 extern "C" LLVMValueRef
320 LLVMRustBuildAtomicCmpXchg(LLVMBuilderRef B, LLVMValueRef Target,
321 LLVMValueRef Old, LLVMValueRef Source,
322 LLVMAtomicOrdering Order,
323 LLVMAtomicOrdering FailureOrder, LLVMBool Weak) {
324 AtomicCmpXchgInst *ACXI = unwrap(B)->CreateAtomicCmpXchg(
325 unwrap(Target), unwrap(Old), unwrap(Source), fromRust(Order),
326 fromRust(FailureOrder));
331 enum class LLVMRustSynchronizationScope {
337 static SyncScope::ID fromRust(LLVMRustSynchronizationScope Scope) {
339 case LLVMRustSynchronizationScope::SingleThread:
340 return SyncScope::SingleThread;
341 case LLVMRustSynchronizationScope::CrossThread:
342 return SyncScope::System;
344 report_fatal_error("bad SynchronizationScope.");
348 extern "C" LLVMValueRef
349 LLVMRustBuildAtomicFence(LLVMBuilderRef B, LLVMAtomicOrdering Order,
350 LLVMRustSynchronizationScope Scope) {
351 return wrap(unwrap(B)->CreateFence(fromRust(Order), fromRust(Scope)));
354 enum class LLVMRustAsmDialect {
360 static InlineAsm::AsmDialect fromRust(LLVMRustAsmDialect Dialect) {
362 case LLVMRustAsmDialect::Att:
363 return InlineAsm::AD_ATT;
364 case LLVMRustAsmDialect::Intel:
365 return InlineAsm::AD_Intel;
367 report_fatal_error("bad AsmDialect.");
371 extern "C" LLVMValueRef LLVMRustInlineAsm(LLVMTypeRef Ty, char *AsmString,
373 LLVMBool HasSideEffects,
374 LLVMBool IsAlignStack,
375 LLVMRustAsmDialect Dialect) {
376 return wrap(InlineAsm::get(unwrap<FunctionType>(Ty), AsmString, Constraints,
377 HasSideEffects, IsAlignStack, fromRust(Dialect)));
380 extern "C" bool LLVMRustInlineAsmVerify(LLVMTypeRef Ty,
382 return InlineAsm::Verify(unwrap<FunctionType>(Ty), Constraints);
385 extern "C" void LLVMRustAppendModuleInlineAsm(LLVMModuleRef M, const char *Asm) {
386 unwrap(M)->appendModuleInlineAsm(StringRef(Asm));
389 typedef DIBuilder *LLVMRustDIBuilderRef;
391 template <typename DIT> DIT *unwrapDIPtr(LLVMMetadataRef Ref) {
392 return (DIT *)(Ref ? unwrap<MDNode>(Ref) : nullptr);
395 #define DIDescriptor DIScope
396 #define DIArray DINodeArray
397 #define unwrapDI unwrapDIPtr
399 // These values **must** match debuginfo::DIFlags! They also *happen*
400 // to match LLVM, but that isn't required as we do giant sets of
401 // matching below. The value shouldn't be directly passed to LLVM.
402 enum class LLVMRustDIFlags : uint32_t {
407 FlagFwdDecl = (1 << 2),
408 FlagAppleBlock = (1 << 3),
409 FlagBlockByrefStruct = (1 << 4),
410 FlagVirtual = (1 << 5),
411 FlagArtificial = (1 << 6),
412 FlagExplicit = (1 << 7),
413 FlagPrototyped = (1 << 8),
414 FlagObjcClassComplete = (1 << 9),
415 FlagObjectPointer = (1 << 10),
416 FlagVector = (1 << 11),
417 FlagStaticMember = (1 << 12),
418 FlagLValueReference = (1 << 13),
419 FlagRValueReference = (1 << 14),
420 FlagExternalTypeRef = (1 << 15),
421 FlagIntroducedVirtual = (1 << 18),
422 FlagBitField = (1 << 19),
423 FlagNoReturn = (1 << 20),
424 // Do not add values that are not supported by the minimum LLVM
425 // version we support! see llvm/include/llvm/IR/DebugInfoFlags.def
428 inline LLVMRustDIFlags operator&(LLVMRustDIFlags A, LLVMRustDIFlags B) {
429 return static_cast<LLVMRustDIFlags>(static_cast<uint32_t>(A) &
430 static_cast<uint32_t>(B));
433 inline LLVMRustDIFlags operator|(LLVMRustDIFlags A, LLVMRustDIFlags B) {
434 return static_cast<LLVMRustDIFlags>(static_cast<uint32_t>(A) |
435 static_cast<uint32_t>(B));
438 inline LLVMRustDIFlags &operator|=(LLVMRustDIFlags &A, LLVMRustDIFlags B) {
442 inline bool isSet(LLVMRustDIFlags F) { return F != LLVMRustDIFlags::FlagZero; }
444 inline LLVMRustDIFlags visibility(LLVMRustDIFlags F) {
445 return static_cast<LLVMRustDIFlags>(static_cast<uint32_t>(F) & 0x3);
448 static DINode::DIFlags fromRust(LLVMRustDIFlags Flags) {
449 DINode::DIFlags Result = DINode::DIFlags::FlagZero;
451 switch (visibility(Flags)) {
452 case LLVMRustDIFlags::FlagPrivate:
453 Result |= DINode::DIFlags::FlagPrivate;
455 case LLVMRustDIFlags::FlagProtected:
456 Result |= DINode::DIFlags::FlagProtected;
458 case LLVMRustDIFlags::FlagPublic:
459 Result |= DINode::DIFlags::FlagPublic;
462 // The rest are handled below
466 if (isSet(Flags & LLVMRustDIFlags::FlagFwdDecl)) {
467 Result |= DINode::DIFlags::FlagFwdDecl;
469 if (isSet(Flags & LLVMRustDIFlags::FlagAppleBlock)) {
470 Result |= DINode::DIFlags::FlagAppleBlock;
472 if (isSet(Flags & LLVMRustDIFlags::FlagBlockByrefStruct)) {
473 Result |= DINode::DIFlags::FlagBlockByrefStruct;
475 if (isSet(Flags & LLVMRustDIFlags::FlagVirtual)) {
476 Result |= DINode::DIFlags::FlagVirtual;
478 if (isSet(Flags & LLVMRustDIFlags::FlagArtificial)) {
479 Result |= DINode::DIFlags::FlagArtificial;
481 if (isSet(Flags & LLVMRustDIFlags::FlagExplicit)) {
482 Result |= DINode::DIFlags::FlagExplicit;
484 if (isSet(Flags & LLVMRustDIFlags::FlagPrototyped)) {
485 Result |= DINode::DIFlags::FlagPrototyped;
487 if (isSet(Flags & LLVMRustDIFlags::FlagObjcClassComplete)) {
488 Result |= DINode::DIFlags::FlagObjcClassComplete;
490 if (isSet(Flags & LLVMRustDIFlags::FlagObjectPointer)) {
491 Result |= DINode::DIFlags::FlagObjectPointer;
493 if (isSet(Flags & LLVMRustDIFlags::FlagVector)) {
494 Result |= DINode::DIFlags::FlagVector;
496 if (isSet(Flags & LLVMRustDIFlags::FlagStaticMember)) {
497 Result |= DINode::DIFlags::FlagStaticMember;
499 if (isSet(Flags & LLVMRustDIFlags::FlagLValueReference)) {
500 Result |= DINode::DIFlags::FlagLValueReference;
502 if (isSet(Flags & LLVMRustDIFlags::FlagRValueReference)) {
503 Result |= DINode::DIFlags::FlagRValueReference;
505 if (isSet(Flags & LLVMRustDIFlags::FlagIntroducedVirtual)) {
506 Result |= DINode::DIFlags::FlagIntroducedVirtual;
508 if (isSet(Flags & LLVMRustDIFlags::FlagBitField)) {
509 Result |= DINode::DIFlags::FlagBitField;
511 if (isSet(Flags & LLVMRustDIFlags::FlagNoReturn)) {
512 Result |= DINode::DIFlags::FlagNoReturn;
518 // These values **must** match debuginfo::DISPFlags! They also *happen*
519 // to match LLVM, but that isn't required as we do giant sets of
520 // matching below. The value shouldn't be directly passed to LLVM.
521 enum class LLVMRustDISPFlags : uint32_t {
524 SPFlagPureVirtual = 2,
525 SPFlagLocalToUnit = (1 << 2),
526 SPFlagDefinition = (1 << 3),
527 SPFlagOptimized = (1 << 4),
528 SPFlagMainSubprogram = (1 << 5),
529 // Do not add values that are not supported by the minimum LLVM
530 // version we support! see llvm/include/llvm/IR/DebugInfoFlags.def
531 // (In LLVM < 8, createFunction supported these as separate bool arguments.)
534 inline LLVMRustDISPFlags operator&(LLVMRustDISPFlags A, LLVMRustDISPFlags B) {
535 return static_cast<LLVMRustDISPFlags>(static_cast<uint32_t>(A) &
536 static_cast<uint32_t>(B));
539 inline LLVMRustDISPFlags operator|(LLVMRustDISPFlags A, LLVMRustDISPFlags B) {
540 return static_cast<LLVMRustDISPFlags>(static_cast<uint32_t>(A) |
541 static_cast<uint32_t>(B));
544 inline LLVMRustDISPFlags &operator|=(LLVMRustDISPFlags &A, LLVMRustDISPFlags B) {
548 inline bool isSet(LLVMRustDISPFlags F) { return F != LLVMRustDISPFlags::SPFlagZero; }
550 inline LLVMRustDISPFlags virtuality(LLVMRustDISPFlags F) {
551 return static_cast<LLVMRustDISPFlags>(static_cast<uint32_t>(F) & 0x3);
554 #if LLVM_VERSION_GE(8, 0)
555 static DISubprogram::DISPFlags fromRust(LLVMRustDISPFlags SPFlags) {
556 DISubprogram::DISPFlags Result = DISubprogram::DISPFlags::SPFlagZero;
558 switch (virtuality(SPFlags)) {
559 case LLVMRustDISPFlags::SPFlagVirtual:
560 Result |= DISubprogram::DISPFlags::SPFlagVirtual;
562 case LLVMRustDISPFlags::SPFlagPureVirtual:
563 Result |= DISubprogram::DISPFlags::SPFlagPureVirtual;
566 // The rest are handled below
570 if (isSet(SPFlags & LLVMRustDISPFlags::SPFlagLocalToUnit)) {
571 Result |= DISubprogram::DISPFlags::SPFlagLocalToUnit;
573 if (isSet(SPFlags & LLVMRustDISPFlags::SPFlagDefinition)) {
574 Result |= DISubprogram::DISPFlags::SPFlagDefinition;
576 if (isSet(SPFlags & LLVMRustDISPFlags::SPFlagOptimized)) {
577 Result |= DISubprogram::DISPFlags::SPFlagOptimized;
579 #if LLVM_VERSION_GE(9, 0)
580 if (isSet(SPFlags & LLVMRustDISPFlags::SPFlagMainSubprogram)) {
581 Result |= DISubprogram::DISPFlags::SPFlagMainSubprogram;
589 enum class LLVMRustDebugEmissionKind {
595 static DICompileUnit::DebugEmissionKind fromRust(LLVMRustDebugEmissionKind Kind) {
597 case LLVMRustDebugEmissionKind::NoDebug:
598 return DICompileUnit::DebugEmissionKind::NoDebug;
599 case LLVMRustDebugEmissionKind::FullDebug:
600 return DICompileUnit::DebugEmissionKind::FullDebug;
601 case LLVMRustDebugEmissionKind::LineTablesOnly:
602 return DICompileUnit::DebugEmissionKind::LineTablesOnly;
604 report_fatal_error("bad DebugEmissionKind.");
608 extern "C" uint32_t LLVMRustDebugMetadataVersion() {
609 return DEBUG_METADATA_VERSION;
612 extern "C" uint32_t LLVMRustVersionMinor() { return LLVM_VERSION_MINOR; }
614 extern "C" uint32_t LLVMRustVersionMajor() { return LLVM_VERSION_MAJOR; }
616 extern "C" void LLVMRustAddModuleFlag(LLVMModuleRef M, const char *Name,
618 unwrap(M)->addModuleFlag(Module::Warning, Name, Value);
621 extern "C" LLVMValueRef LLVMRustMetadataAsValue(LLVMContextRef C, LLVMMetadataRef MD) {
622 return wrap(MetadataAsValue::get(*unwrap(C), unwrap(MD)));
625 extern "C" LLVMRustDIBuilderRef LLVMRustDIBuilderCreate(LLVMModuleRef M) {
626 return new DIBuilder(*unwrap(M));
629 extern "C" void LLVMRustDIBuilderDispose(LLVMRustDIBuilderRef Builder) {
633 extern "C" void LLVMRustDIBuilderFinalize(LLVMRustDIBuilderRef Builder) {
637 extern "C" LLVMMetadataRef LLVMRustDIBuilderCreateCompileUnit(
638 LLVMRustDIBuilderRef Builder, unsigned Lang, LLVMMetadataRef FileRef,
639 const char *Producer, bool isOptimized, const char *Flags,
640 unsigned RuntimeVer, const char *SplitName,
641 LLVMRustDebugEmissionKind Kind) {
642 auto *File = unwrapDI<DIFile>(FileRef);
644 return wrap(Builder->createCompileUnit(Lang, File, Producer, isOptimized,
645 Flags, RuntimeVer, SplitName,
649 extern "C" LLVMMetadataRef
650 LLVMRustDIBuilderCreateFile(LLVMRustDIBuilderRef Builder, const char *Filename,
651 const char *Directory) {
652 return wrap(Builder->createFile(Filename, Directory));
655 extern "C" LLVMMetadataRef
656 LLVMRustDIBuilderCreateSubroutineType(LLVMRustDIBuilderRef Builder,
657 LLVMMetadataRef File,
658 LLVMMetadataRef ParameterTypes) {
659 return wrap(Builder->createSubroutineType(
660 DITypeRefArray(unwrap<MDTuple>(ParameterTypes))));
663 extern "C" LLVMMetadataRef LLVMRustDIBuilderCreateFunction(
664 LLVMRustDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
665 const char *LinkageName, LLVMMetadataRef File, unsigned LineNo,
666 LLVMMetadataRef Ty, unsigned ScopeLine, LLVMRustDIFlags Flags,
667 LLVMRustDISPFlags SPFlags, LLVMValueRef Fn, LLVMMetadataRef TParam,
668 LLVMMetadataRef Decl) {
669 DITemplateParameterArray TParams =
670 DITemplateParameterArray(unwrap<MDTuple>(TParam));
671 #if LLVM_VERSION_GE(8, 0)
672 DISubprogram::DISPFlags llvmSPFlags = fromRust(SPFlags);
673 DINode::DIFlags llvmFlags = fromRust(Flags);
674 #if LLVM_VERSION_LT(9, 0)
675 if (isSet(SPFlags & LLVMRustDISPFlags::SPFlagMainSubprogram))
676 llvmFlags |= DINode::DIFlags::FlagMainSubprogram;
678 DISubprogram *Sub = Builder->createFunction(
679 unwrapDI<DIScope>(Scope), Name, LinkageName, unwrapDI<DIFile>(File),
680 LineNo, unwrapDI<DISubroutineType>(Ty), ScopeLine, llvmFlags,
681 llvmSPFlags, TParams, unwrapDIPtr<DISubprogram>(Decl));
683 bool IsLocalToUnit = isSet(SPFlags & LLVMRustDISPFlags::SPFlagLocalToUnit);
684 bool IsDefinition = isSet(SPFlags & LLVMRustDISPFlags::SPFlagDefinition);
685 bool IsOptimized = isSet(SPFlags & LLVMRustDISPFlags::SPFlagOptimized);
686 DINode::DIFlags llvmFlags = fromRust(Flags);
687 if (isSet(SPFlags & LLVMRustDISPFlags::SPFlagMainSubprogram))
688 llvmFlags |= DINode::DIFlags::FlagMainSubprogram;
689 DISubprogram *Sub = Builder->createFunction(
690 unwrapDI<DIScope>(Scope), Name, LinkageName, unwrapDI<DIFile>(File),
691 LineNo, unwrapDI<DISubroutineType>(Ty), IsLocalToUnit, IsDefinition,
692 ScopeLine, llvmFlags, IsOptimized, TParams,
693 unwrapDIPtr<DISubprogram>(Decl));
695 unwrap<Function>(Fn)->setSubprogram(Sub);
699 extern "C" LLVMMetadataRef
700 LLVMRustDIBuilderCreateBasicType(LLVMRustDIBuilderRef Builder, const char *Name,
701 uint64_t SizeInBits, uint32_t AlignInBits,
703 return wrap(Builder->createBasicType(Name, SizeInBits, Encoding));
706 extern "C" LLVMMetadataRef LLVMRustDIBuilderCreatePointerType(
707 LLVMRustDIBuilderRef Builder, LLVMMetadataRef PointeeTy,
708 uint64_t SizeInBits, uint32_t AlignInBits, const char *Name) {
709 return wrap(Builder->createPointerType(unwrapDI<DIType>(PointeeTy),
710 SizeInBits, AlignInBits,
711 /* DWARFAddressSpace */ None,
715 extern "C" LLVMMetadataRef LLVMRustDIBuilderCreateStructType(
716 LLVMRustDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
717 LLVMMetadataRef File, unsigned LineNumber, uint64_t SizeInBits,
718 uint32_t AlignInBits, LLVMRustDIFlags Flags,
719 LLVMMetadataRef DerivedFrom, LLVMMetadataRef Elements,
720 unsigned RunTimeLang, LLVMMetadataRef VTableHolder,
721 const char *UniqueId) {
722 return wrap(Builder->createStructType(
723 unwrapDI<DIDescriptor>(Scope), Name, unwrapDI<DIFile>(File), LineNumber,
724 SizeInBits, AlignInBits, fromRust(Flags), unwrapDI<DIType>(DerivedFrom),
725 DINodeArray(unwrapDI<MDTuple>(Elements)), RunTimeLang,
726 unwrapDI<DIType>(VTableHolder), UniqueId));
729 extern "C" LLVMMetadataRef LLVMRustDIBuilderCreateVariantPart(
730 LLVMRustDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
731 LLVMMetadataRef File, unsigned LineNumber, uint64_t SizeInBits,
732 uint32_t AlignInBits, LLVMRustDIFlags Flags, LLVMMetadataRef Discriminator,
733 LLVMMetadataRef Elements, const char *UniqueId) {
734 #if LLVM_VERSION_GE(7, 0)
735 return wrap(Builder->createVariantPart(
736 unwrapDI<DIDescriptor>(Scope), Name, unwrapDI<DIFile>(File), LineNumber,
737 SizeInBits, AlignInBits, fromRust(Flags), unwrapDI<DIDerivedType>(Discriminator),
738 DINodeArray(unwrapDI<MDTuple>(Elements)), UniqueId));
744 extern "C" LLVMMetadataRef LLVMRustDIBuilderCreateMemberType(
745 LLVMRustDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
746 LLVMMetadataRef File, unsigned LineNo, uint64_t SizeInBits,
747 uint32_t AlignInBits, uint64_t OffsetInBits, LLVMRustDIFlags Flags,
748 LLVMMetadataRef Ty) {
749 return wrap(Builder->createMemberType(unwrapDI<DIDescriptor>(Scope), Name,
750 unwrapDI<DIFile>(File), LineNo,
751 SizeInBits, AlignInBits, OffsetInBits,
752 fromRust(Flags), unwrapDI<DIType>(Ty)));
755 extern "C" LLVMMetadataRef LLVMRustDIBuilderCreateVariantMemberType(
756 LLVMRustDIBuilderRef Builder, LLVMMetadataRef Scope,
757 const char *Name, LLVMMetadataRef File, unsigned LineNo, uint64_t SizeInBits,
758 uint32_t AlignInBits, uint64_t OffsetInBits, LLVMValueRef Discriminant,
759 LLVMRustDIFlags Flags, LLVMMetadataRef Ty) {
760 #if LLVM_VERSION_GE(7, 0)
761 llvm::ConstantInt* D = nullptr;
763 D = unwrap<llvm::ConstantInt>(Discriminant);
765 return wrap(Builder->createVariantMemberType(unwrapDI<DIDescriptor>(Scope), Name,
766 unwrapDI<DIFile>(File), LineNo,
767 SizeInBits, AlignInBits, OffsetInBits, D,
768 fromRust(Flags), unwrapDI<DIType>(Ty)));
770 return wrap(Builder->createMemberType(unwrapDI<DIDescriptor>(Scope), Name,
771 unwrapDI<DIFile>(File), LineNo,
772 SizeInBits, AlignInBits, OffsetInBits,
773 fromRust(Flags), unwrapDI<DIType>(Ty)));
777 extern "C" LLVMMetadataRef LLVMRustDIBuilderCreateLexicalBlock(
778 LLVMRustDIBuilderRef Builder, LLVMMetadataRef Scope,
779 LLVMMetadataRef File, unsigned Line, unsigned Col) {
780 return wrap(Builder->createLexicalBlock(unwrapDI<DIDescriptor>(Scope),
781 unwrapDI<DIFile>(File), Line, Col));
784 extern "C" LLVMMetadataRef
785 LLVMRustDIBuilderCreateLexicalBlockFile(LLVMRustDIBuilderRef Builder,
786 LLVMMetadataRef Scope,
787 LLVMMetadataRef File) {
788 return wrap(Builder->createLexicalBlockFile(unwrapDI<DIDescriptor>(Scope),
789 unwrapDI<DIFile>(File)));
792 extern "C" LLVMMetadataRef LLVMRustDIBuilderCreateStaticVariable(
793 LLVMRustDIBuilderRef Builder, LLVMMetadataRef Context, const char *Name,
794 const char *LinkageName, LLVMMetadataRef File, unsigned LineNo,
795 LLVMMetadataRef Ty, bool IsLocalToUnit, LLVMValueRef V,
796 LLVMMetadataRef Decl = nullptr, uint32_t AlignInBits = 0) {
797 llvm::GlobalVariable *InitVal = cast<llvm::GlobalVariable>(unwrap(V));
799 llvm::DIExpression *InitExpr = nullptr;
800 if (llvm::ConstantInt *IntVal = llvm::dyn_cast<llvm::ConstantInt>(InitVal)) {
801 InitExpr = Builder->createConstantValueExpression(
802 IntVal->getValue().getSExtValue());
803 } else if (llvm::ConstantFP *FPVal =
804 llvm::dyn_cast<llvm::ConstantFP>(InitVal)) {
805 InitExpr = Builder->createConstantValueExpression(
806 FPVal->getValueAPF().bitcastToAPInt().getZExtValue());
809 llvm::DIGlobalVariableExpression *VarExpr = Builder->createGlobalVariableExpression(
810 unwrapDI<DIDescriptor>(Context), Name, LinkageName,
811 unwrapDI<DIFile>(File), LineNo, unwrapDI<DIType>(Ty), IsLocalToUnit,
812 InitExpr, unwrapDIPtr<MDNode>(Decl),
813 #if LLVM_VERSION_GE(8, 0)
814 /* templateParams */ nullptr,
818 InitVal->setMetadata("dbg", VarExpr);
820 return wrap(VarExpr);
823 extern "C" LLVMMetadataRef LLVMRustDIBuilderCreateVariable(
824 LLVMRustDIBuilderRef Builder, unsigned Tag, LLVMMetadataRef Scope,
825 const char *Name, LLVMMetadataRef File, unsigned LineNo,
826 LLVMMetadataRef Ty, bool AlwaysPreserve, LLVMRustDIFlags Flags,
827 unsigned ArgNo, uint32_t AlignInBits) {
828 if (Tag == 0x100) { // DW_TAG_auto_variable
829 return wrap(Builder->createAutoVariable(
830 unwrapDI<DIDescriptor>(Scope), Name, unwrapDI<DIFile>(File), LineNo,
831 unwrapDI<DIType>(Ty), AlwaysPreserve, fromRust(Flags), AlignInBits));
833 return wrap(Builder->createParameterVariable(
834 unwrapDI<DIDescriptor>(Scope), Name, ArgNo, unwrapDI<DIFile>(File),
835 LineNo, unwrapDI<DIType>(Ty), AlwaysPreserve, fromRust(Flags)));
839 extern "C" LLVMMetadataRef
840 LLVMRustDIBuilderCreateArrayType(LLVMRustDIBuilderRef Builder, uint64_t Size,
841 uint32_t AlignInBits, LLVMMetadataRef Ty,
842 LLVMMetadataRef Subscripts) {
844 Builder->createArrayType(Size, AlignInBits, unwrapDI<DIType>(Ty),
845 DINodeArray(unwrapDI<MDTuple>(Subscripts))));
848 extern "C" LLVMMetadataRef
849 LLVMRustDIBuilderGetOrCreateSubrange(LLVMRustDIBuilderRef Builder, int64_t Lo,
851 return wrap(Builder->getOrCreateSubrange(Lo, Count));
854 extern "C" LLVMMetadataRef
855 LLVMRustDIBuilderGetOrCreateArray(LLVMRustDIBuilderRef Builder,
856 LLVMMetadataRef *Ptr, unsigned Count) {
857 Metadata **DataValue = unwrap(Ptr);
859 Builder->getOrCreateArray(ArrayRef<Metadata *>(DataValue, Count)).get());
862 extern "C" LLVMValueRef LLVMRustDIBuilderInsertDeclareAtEnd(
863 LLVMRustDIBuilderRef Builder, LLVMValueRef V, LLVMMetadataRef VarInfo,
864 int64_t *AddrOps, unsigned AddrOpsCount, LLVMValueRef DL,
865 LLVMBasicBlockRef InsertAtEnd) {
866 return wrap(Builder->insertDeclare(
867 unwrap(V), unwrap<DILocalVariable>(VarInfo),
868 Builder->createExpression(llvm::ArrayRef<int64_t>(AddrOps, AddrOpsCount)),
869 DebugLoc(cast<MDNode>(unwrap<MetadataAsValue>(DL)->getMetadata())),
870 unwrap(InsertAtEnd)));
873 extern "C" LLVMMetadataRef
874 LLVMRustDIBuilderCreateEnumerator(LLVMRustDIBuilderRef Builder,
875 const char *Name, uint64_t Val) {
876 return wrap(Builder->createEnumerator(Name, Val));
879 extern "C" LLVMMetadataRef LLVMRustDIBuilderCreateEnumerationType(
880 LLVMRustDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
881 LLVMMetadataRef File, unsigned LineNumber, uint64_t SizeInBits,
882 uint32_t AlignInBits, LLVMMetadataRef Elements,
883 LLVMMetadataRef ClassTy, bool IsScoped) {
884 #if LLVM_VERSION_GE(7, 0)
885 return wrap(Builder->createEnumerationType(
886 unwrapDI<DIDescriptor>(Scope), Name, unwrapDI<DIFile>(File), LineNumber,
887 SizeInBits, AlignInBits, DINodeArray(unwrapDI<MDTuple>(Elements)),
888 unwrapDI<DIType>(ClassTy), "", IsScoped));
890 // Ignore IsScoped on older LLVM.
891 return wrap(Builder->createEnumerationType(
892 unwrapDI<DIDescriptor>(Scope), Name, unwrapDI<DIFile>(File), LineNumber,
893 SizeInBits, AlignInBits, DINodeArray(unwrapDI<MDTuple>(Elements)),
894 unwrapDI<DIType>(ClassTy), ""));
898 extern "C" LLVMMetadataRef LLVMRustDIBuilderCreateUnionType(
899 LLVMRustDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
900 LLVMMetadataRef File, unsigned LineNumber, uint64_t SizeInBits,
901 uint32_t AlignInBits, LLVMRustDIFlags Flags, LLVMMetadataRef Elements,
902 unsigned RunTimeLang, const char *UniqueId) {
903 return wrap(Builder->createUnionType(
904 unwrapDI<DIDescriptor>(Scope), Name, unwrapDI<DIFile>(File), LineNumber,
905 SizeInBits, AlignInBits, fromRust(Flags),
906 DINodeArray(unwrapDI<MDTuple>(Elements)), RunTimeLang, UniqueId));
909 extern "C" LLVMMetadataRef LLVMRustDIBuilderCreateTemplateTypeParameter(
910 LLVMRustDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
911 LLVMMetadataRef Ty, LLVMMetadataRef File, unsigned LineNo,
913 return wrap(Builder->createTemplateTypeParameter(
914 unwrapDI<DIDescriptor>(Scope), Name, unwrapDI<DIType>(Ty)));
917 extern "C" LLVMMetadataRef
918 LLVMRustDIBuilderCreateNameSpace(LLVMRustDIBuilderRef Builder,
919 LLVMMetadataRef Scope, const char *Name,
920 LLVMMetadataRef File, unsigned LineNo) {
921 return wrap(Builder->createNameSpace(
922 unwrapDI<DIDescriptor>(Scope), Name,
923 false // ExportSymbols (only relevant for C++ anonymous namespaces)
928 LLVMRustDICompositeTypeReplaceArrays(LLVMRustDIBuilderRef Builder,
929 LLVMMetadataRef CompositeTy,
930 LLVMMetadataRef Elements,
931 LLVMMetadataRef Params) {
932 DICompositeType *Tmp = unwrapDI<DICompositeType>(CompositeTy);
933 Builder->replaceArrays(Tmp, DINodeArray(unwrap<MDTuple>(Elements)),
934 DINodeArray(unwrap<MDTuple>(Params)));
937 extern "C" LLVMValueRef
938 LLVMRustDIBuilderCreateDebugLocation(LLVMContextRef ContextRef, unsigned Line,
939 unsigned Column, LLVMMetadataRef Scope,
940 LLVMMetadataRef InlinedAt) {
941 LLVMContext &Context = *unwrap(ContextRef);
943 DebugLoc debug_loc = DebugLoc::get(Line, Column, unwrapDIPtr<MDNode>(Scope),
944 unwrapDIPtr<MDNode>(InlinedAt));
946 return wrap(MetadataAsValue::get(Context, debug_loc.getAsMDNode()));
949 extern "C" int64_t LLVMRustDIBuilderCreateOpDeref() {
950 return dwarf::DW_OP_deref;
953 extern "C" int64_t LLVMRustDIBuilderCreateOpPlusUconst() {
954 return dwarf::DW_OP_plus_uconst;
957 extern "C" void LLVMRustWriteTypeToString(LLVMTypeRef Ty, RustStringRef Str) {
958 RawRustStringOstream OS(Str);
959 unwrap<llvm::Type>(Ty)->print(OS);
962 extern "C" void LLVMRustWriteValueToString(LLVMValueRef V,
964 RawRustStringOstream OS(Str);
969 unwrap<llvm::Value>(V)->getType()->print(OS);
971 unwrap<llvm::Value>(V)->print(OS);
976 // Note that the two following functions look quite similar to the
977 // LLVMGetSectionName function. Sadly, it appears that this function only
978 // returns a char* pointer, which isn't guaranteed to be null-terminated. The
979 // function provided by LLVM doesn't return the length, so we've created our own
980 // function which returns the length as well as the data pointer.
982 // For an example of this not returning a null terminated string, see
983 // lib/Object/COFFObjectFile.cpp in the getSectionName function. One of the
984 // branches explicitly creates a StringRef without a null terminator, and then
987 inline section_iterator *unwrap(LLVMSectionIteratorRef SI) {
988 return reinterpret_cast<section_iterator *>(SI);
991 extern "C" size_t LLVMRustGetSectionName(LLVMSectionIteratorRef SI,
994 if (std::error_code EC = (*unwrap(SI))->getName(Ret))
995 report_fatal_error(EC.message());
1000 // LLVMArrayType function does not support 64-bit ElementCount
1001 extern "C" LLVMTypeRef LLVMRustArrayType(LLVMTypeRef ElementTy,
1002 uint64_t ElementCount) {
1003 return wrap(ArrayType::get(unwrap(ElementTy), ElementCount));
1006 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Twine, LLVMTwineRef)
1008 extern "C" void LLVMRustWriteTwineToString(LLVMTwineRef T, RustStringRef Str) {
1009 RawRustStringOstream OS(Str);
1010 unwrap(T)->print(OS);
1013 extern "C" void LLVMRustUnpackOptimizationDiagnostic(
1014 LLVMDiagnosticInfoRef DI, RustStringRef PassNameOut,
1015 LLVMValueRef *FunctionOut, unsigned* Line, unsigned* Column,
1016 RustStringRef FilenameOut, RustStringRef MessageOut) {
1017 // Undefined to call this not on an optimization diagnostic!
1018 llvm::DiagnosticInfoOptimizationBase *Opt =
1019 static_cast<llvm::DiagnosticInfoOptimizationBase *>(unwrap(DI));
1021 RawRustStringOstream PassNameOS(PassNameOut);
1022 PassNameOS << Opt->getPassName();
1023 *FunctionOut = wrap(&Opt->getFunction());
1025 RawRustStringOstream FilenameOS(FilenameOut);
1026 DiagnosticLocation loc = Opt->getLocation();
1027 if (loc.isValid()) {
1028 *Line = loc.getLine();
1029 *Column = loc.getColumn();
1030 #if LLVM_VERSION_GE(8, 0)
1031 FilenameOS << loc.getAbsolutePath();
1033 FilenameOS << loc.getFilename();
1037 RawRustStringOstream MessageOS(MessageOut);
1038 MessageOS << Opt->getMsg();
1042 LLVMRustUnpackInlineAsmDiagnostic(LLVMDiagnosticInfoRef DI, unsigned *CookieOut,
1043 LLVMTwineRef *MessageOut,
1044 LLVMValueRef *InstructionOut) {
1045 // Undefined to call this not on an inline assembly diagnostic!
1046 llvm::DiagnosticInfoInlineAsm *IA =
1047 static_cast<llvm::DiagnosticInfoInlineAsm *>(unwrap(DI));
1049 *CookieOut = IA->getLocCookie();
1050 *MessageOut = wrap(&IA->getMsgStr());
1051 *InstructionOut = wrap(IA->getInstruction());
1054 extern "C" void LLVMRustWriteDiagnosticInfoToString(LLVMDiagnosticInfoRef DI,
1055 RustStringRef Str) {
1056 RawRustStringOstream OS(Str);
1057 DiagnosticPrinterRawOStream DP(OS);
1058 unwrap(DI)->print(DP);
1061 enum class LLVMRustDiagnosticKind {
1065 DebugMetadataVersion,
1068 OptimizationRemarkMissed,
1069 OptimizationRemarkAnalysis,
1070 OptimizationRemarkAnalysisFPCommute,
1071 OptimizationRemarkAnalysisAliasing,
1072 OptimizationRemarkOther,
1073 OptimizationFailure,
1078 static LLVMRustDiagnosticKind toRust(DiagnosticKind Kind) {
1081 return LLVMRustDiagnosticKind::InlineAsm;
1083 return LLVMRustDiagnosticKind::StackSize;
1084 case DK_DebugMetadataVersion:
1085 return LLVMRustDiagnosticKind::DebugMetadataVersion;
1086 case DK_SampleProfile:
1087 return LLVMRustDiagnosticKind::SampleProfile;
1088 case DK_OptimizationRemark:
1089 return LLVMRustDiagnosticKind::OptimizationRemark;
1090 case DK_OptimizationRemarkMissed:
1091 return LLVMRustDiagnosticKind::OptimizationRemarkMissed;
1092 case DK_OptimizationRemarkAnalysis:
1093 return LLVMRustDiagnosticKind::OptimizationRemarkAnalysis;
1094 case DK_OptimizationRemarkAnalysisFPCommute:
1095 return LLVMRustDiagnosticKind::OptimizationRemarkAnalysisFPCommute;
1096 case DK_OptimizationRemarkAnalysisAliasing:
1097 return LLVMRustDiagnosticKind::OptimizationRemarkAnalysisAliasing;
1099 return LLVMRustDiagnosticKind::PGOProfile;
1101 return LLVMRustDiagnosticKind::Linker;
1103 return (Kind >= DK_FirstRemark && Kind <= DK_LastRemark)
1104 ? LLVMRustDiagnosticKind::OptimizationRemarkOther
1105 : LLVMRustDiagnosticKind::Other;
1109 extern "C" LLVMRustDiagnosticKind
1110 LLVMRustGetDiagInfoKind(LLVMDiagnosticInfoRef DI) {
1111 return toRust((DiagnosticKind)unwrap(DI)->getKind());
1113 // This is kept distinct from LLVMGetTypeKind, because when
1114 // a new type kind is added, the Rust-side enum must be
1115 // updated or UB will result.
1116 extern "C" LLVMTypeKind LLVMRustGetTypeKind(LLVMTypeRef Ty) {
1117 switch (unwrap(Ty)->getTypeID()) {
1118 case Type::VoidTyID:
1119 return LLVMVoidTypeKind;
1120 case Type::HalfTyID:
1121 return LLVMHalfTypeKind;
1122 case Type::FloatTyID:
1123 return LLVMFloatTypeKind;
1124 case Type::DoubleTyID:
1125 return LLVMDoubleTypeKind;
1126 case Type::X86_FP80TyID:
1127 return LLVMX86_FP80TypeKind;
1128 case Type::FP128TyID:
1129 return LLVMFP128TypeKind;
1130 case Type::PPC_FP128TyID:
1131 return LLVMPPC_FP128TypeKind;
1132 case Type::LabelTyID:
1133 return LLVMLabelTypeKind;
1134 case Type::MetadataTyID:
1135 return LLVMMetadataTypeKind;
1136 case Type::IntegerTyID:
1137 return LLVMIntegerTypeKind;
1138 case Type::FunctionTyID:
1139 return LLVMFunctionTypeKind;
1140 case Type::StructTyID:
1141 return LLVMStructTypeKind;
1142 case Type::ArrayTyID:
1143 return LLVMArrayTypeKind;
1144 case Type::PointerTyID:
1145 return LLVMPointerTypeKind;
1146 case Type::VectorTyID:
1147 return LLVMVectorTypeKind;
1148 case Type::X86_MMXTyID:
1149 return LLVMX86_MMXTypeKind;
1150 case Type::TokenTyID:
1151 return LLVMTokenTypeKind;
1153 report_fatal_error("Unhandled TypeID.");
1156 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(SMDiagnostic, LLVMSMDiagnosticRef)
1158 extern "C" void LLVMRustSetInlineAsmDiagnosticHandler(
1159 LLVMContextRef C, LLVMContext::InlineAsmDiagHandlerTy H, void *CX) {
1160 unwrap(C)->setInlineAsmDiagnosticHandler(H, CX);
1163 extern "C" void LLVMRustWriteSMDiagnosticToString(LLVMSMDiagnosticRef D,
1164 RustStringRef Str) {
1165 RawRustStringOstream OS(Str);
1166 unwrap(D)->print("", OS);
1169 extern "C" LLVMValueRef LLVMRustBuildCleanupPad(LLVMBuilderRef B,
1170 LLVMValueRef ParentPad,
1172 LLVMValueRef *LLArgs,
1174 Value **Args = unwrap(LLArgs);
1175 if (ParentPad == nullptr) {
1176 Type *Ty = Type::getTokenTy(unwrap(B)->getContext());
1177 ParentPad = wrap(Constant::getNullValue(Ty));
1179 return wrap(unwrap(B)->CreateCleanupPad(
1180 unwrap(ParentPad), ArrayRef<Value *>(Args, ArgCount), Name));
1183 extern "C" LLVMValueRef LLVMRustBuildCleanupRet(LLVMBuilderRef B,
1184 LLVMValueRef CleanupPad,
1185 LLVMBasicBlockRef UnwindBB) {
1186 CleanupPadInst *Inst = cast<CleanupPadInst>(unwrap(CleanupPad));
1187 return wrap(unwrap(B)->CreateCleanupRet(Inst, unwrap(UnwindBB)));
1190 extern "C" LLVMValueRef
1191 LLVMRustBuildCatchPad(LLVMBuilderRef B, LLVMValueRef ParentPad,
1192 unsigned ArgCount, LLVMValueRef *LLArgs, const char *Name) {
1193 Value **Args = unwrap(LLArgs);
1194 return wrap(unwrap(B)->CreateCatchPad(
1195 unwrap(ParentPad), ArrayRef<Value *>(Args, ArgCount), Name));
1198 extern "C" LLVMValueRef LLVMRustBuildCatchRet(LLVMBuilderRef B,
1200 LLVMBasicBlockRef BB) {
1201 return wrap(unwrap(B)->CreateCatchRet(cast<CatchPadInst>(unwrap(Pad)),
1205 extern "C" LLVMValueRef LLVMRustBuildCatchSwitch(LLVMBuilderRef B,
1206 LLVMValueRef ParentPad,
1207 LLVMBasicBlockRef BB,
1208 unsigned NumHandlers,
1210 if (ParentPad == nullptr) {
1211 Type *Ty = Type::getTokenTy(unwrap(B)->getContext());
1212 ParentPad = wrap(Constant::getNullValue(Ty));
1214 return wrap(unwrap(B)->CreateCatchSwitch(unwrap(ParentPad), unwrap(BB),
1215 NumHandlers, Name));
1218 extern "C" void LLVMRustAddHandler(LLVMValueRef CatchSwitchRef,
1219 LLVMBasicBlockRef Handler) {
1220 Value *CatchSwitch = unwrap(CatchSwitchRef);
1221 cast<CatchSwitchInst>(CatchSwitch)->addHandler(unwrap(Handler));
1224 extern "C" OperandBundleDef *LLVMRustBuildOperandBundleDef(const char *Name,
1225 LLVMValueRef *Inputs,
1226 unsigned NumInputs) {
1227 return new OperandBundleDef(Name, makeArrayRef(unwrap(Inputs), NumInputs));
1230 extern "C" void LLVMRustFreeOperandBundleDef(OperandBundleDef *Bundle) {
1234 extern "C" LLVMValueRef LLVMRustBuildCall(LLVMBuilderRef B, LLVMValueRef Fn,
1235 LLVMValueRef *Args, unsigned NumArgs,
1236 OperandBundleDef *Bundle,
1238 unsigned Len = Bundle ? 1 : 0;
1239 ArrayRef<OperandBundleDef> Bundles = makeArrayRef(Bundle, Len);
1240 return wrap(unwrap(B)->CreateCall(
1241 unwrap(Fn), makeArrayRef(unwrap(Args), NumArgs), Bundles, Name));
1244 extern "C" LLVMValueRef LLVMRustBuildMemCpy(LLVMBuilderRef B,
1245 LLVMValueRef Dst, unsigned DstAlign,
1246 LLVMValueRef Src, unsigned SrcAlign,
1247 LLVMValueRef Size, bool IsVolatile) {
1248 #if LLVM_VERSION_GE(7, 0)
1249 return wrap(unwrap(B)->CreateMemCpy(
1250 unwrap(Dst), DstAlign,
1251 unwrap(Src), SrcAlign,
1252 unwrap(Size), IsVolatile));
1254 unsigned Align = std::min(DstAlign, SrcAlign);
1255 return wrap(unwrap(B)->CreateMemCpy(
1256 unwrap(Dst), unwrap(Src),
1257 unwrap(Size), Align, IsVolatile));
1261 extern "C" LLVMValueRef LLVMRustBuildMemMove(LLVMBuilderRef B,
1262 LLVMValueRef Dst, unsigned DstAlign,
1263 LLVMValueRef Src, unsigned SrcAlign,
1264 LLVMValueRef Size, bool IsVolatile) {
1265 #if LLVM_VERSION_GE(7, 0)
1266 return wrap(unwrap(B)->CreateMemMove(
1267 unwrap(Dst), DstAlign,
1268 unwrap(Src), SrcAlign,
1269 unwrap(Size), IsVolatile));
1271 unsigned Align = std::min(DstAlign, SrcAlign);
1272 return wrap(unwrap(B)->CreateMemMove(
1273 unwrap(Dst), unwrap(Src),
1274 unwrap(Size), Align, IsVolatile));
1278 extern "C" LLVMValueRef
1279 LLVMRustBuildInvoke(LLVMBuilderRef B, LLVMValueRef Fn, LLVMValueRef *Args,
1280 unsigned NumArgs, LLVMBasicBlockRef Then,
1281 LLVMBasicBlockRef Catch, OperandBundleDef *Bundle,
1283 unsigned Len = Bundle ? 1 : 0;
1284 ArrayRef<OperandBundleDef> Bundles = makeArrayRef(Bundle, Len);
1285 return wrap(unwrap(B)->CreateInvoke(unwrap(Fn), unwrap(Then), unwrap(Catch),
1286 makeArrayRef(unwrap(Args), NumArgs),
1290 extern "C" void LLVMRustPositionBuilderAtStart(LLVMBuilderRef B,
1291 LLVMBasicBlockRef BB) {
1292 auto Point = unwrap(BB)->getFirstInsertionPt();
1293 unwrap(B)->SetInsertPoint(unwrap(BB), Point);
1296 extern "C" void LLVMRustSetComdat(LLVMModuleRef M, LLVMValueRef V,
1298 Triple TargetTriple(unwrap(M)->getTargetTriple());
1299 GlobalObject *GV = unwrap<GlobalObject>(V);
1300 if (!TargetTriple.isOSBinFormatMachO()) {
1301 GV->setComdat(unwrap(M)->getOrInsertComdat(Name));
1305 extern "C" void LLVMRustUnsetComdat(LLVMValueRef V) {
1306 GlobalObject *GV = unwrap<GlobalObject>(V);
1307 GV->setComdat(nullptr);
1310 enum class LLVMRustLinkage {
1311 ExternalLinkage = 0,
1312 AvailableExternallyLinkage = 1,
1313 LinkOnceAnyLinkage = 2,
1314 LinkOnceODRLinkage = 3,
1317 AppendingLinkage = 6,
1318 InternalLinkage = 7,
1320 ExternalWeakLinkage = 9,
1324 static LLVMRustLinkage toRust(LLVMLinkage Linkage) {
1326 case LLVMExternalLinkage:
1327 return LLVMRustLinkage::ExternalLinkage;
1328 case LLVMAvailableExternallyLinkage:
1329 return LLVMRustLinkage::AvailableExternallyLinkage;
1330 case LLVMLinkOnceAnyLinkage:
1331 return LLVMRustLinkage::LinkOnceAnyLinkage;
1332 case LLVMLinkOnceODRLinkage:
1333 return LLVMRustLinkage::LinkOnceODRLinkage;
1334 case LLVMWeakAnyLinkage:
1335 return LLVMRustLinkage::WeakAnyLinkage;
1336 case LLVMWeakODRLinkage:
1337 return LLVMRustLinkage::WeakODRLinkage;
1338 case LLVMAppendingLinkage:
1339 return LLVMRustLinkage::AppendingLinkage;
1340 case LLVMInternalLinkage:
1341 return LLVMRustLinkage::InternalLinkage;
1342 case LLVMPrivateLinkage:
1343 return LLVMRustLinkage::PrivateLinkage;
1344 case LLVMExternalWeakLinkage:
1345 return LLVMRustLinkage::ExternalWeakLinkage;
1346 case LLVMCommonLinkage:
1347 return LLVMRustLinkage::CommonLinkage;
1349 report_fatal_error("Invalid LLVMRustLinkage value!");
1353 static LLVMLinkage fromRust(LLVMRustLinkage Linkage) {
1355 case LLVMRustLinkage::ExternalLinkage:
1356 return LLVMExternalLinkage;
1357 case LLVMRustLinkage::AvailableExternallyLinkage:
1358 return LLVMAvailableExternallyLinkage;
1359 case LLVMRustLinkage::LinkOnceAnyLinkage:
1360 return LLVMLinkOnceAnyLinkage;
1361 case LLVMRustLinkage::LinkOnceODRLinkage:
1362 return LLVMLinkOnceODRLinkage;
1363 case LLVMRustLinkage::WeakAnyLinkage:
1364 return LLVMWeakAnyLinkage;
1365 case LLVMRustLinkage::WeakODRLinkage:
1366 return LLVMWeakODRLinkage;
1367 case LLVMRustLinkage::AppendingLinkage:
1368 return LLVMAppendingLinkage;
1369 case LLVMRustLinkage::InternalLinkage:
1370 return LLVMInternalLinkage;
1371 case LLVMRustLinkage::PrivateLinkage:
1372 return LLVMPrivateLinkage;
1373 case LLVMRustLinkage::ExternalWeakLinkage:
1374 return LLVMExternalWeakLinkage;
1375 case LLVMRustLinkage::CommonLinkage:
1376 return LLVMCommonLinkage;
1378 report_fatal_error("Invalid LLVMRustLinkage value!");
1381 extern "C" LLVMRustLinkage LLVMRustGetLinkage(LLVMValueRef V) {
1382 return toRust(LLVMGetLinkage(V));
1385 extern "C" void LLVMRustSetLinkage(LLVMValueRef V,
1386 LLVMRustLinkage RustLinkage) {
1387 LLVMSetLinkage(V, fromRust(RustLinkage));
1390 // Returns true if both high and low were successfully set. Fails in case constant wasn’t any of
1391 // the common sizes (1, 8, 16, 32, 64, 128 bits)
1392 extern "C" bool LLVMRustConstInt128Get(LLVMValueRef CV, bool sext, uint64_t *high, uint64_t *low)
1394 auto C = unwrap<llvm::ConstantInt>(CV);
1395 if (C->getBitWidth() > 128) { return false; }
1398 AP = C->getValue().sextOrSelf(128);
1400 AP = C->getValue().zextOrSelf(128);
1402 *low = AP.getLoBits(64).getZExtValue();
1403 *high = AP.getHiBits(64).getZExtValue();
1407 enum class LLVMRustVisibility {
1413 static LLVMRustVisibility toRust(LLVMVisibility Vis) {
1415 case LLVMDefaultVisibility:
1416 return LLVMRustVisibility::Default;
1417 case LLVMHiddenVisibility:
1418 return LLVMRustVisibility::Hidden;
1419 case LLVMProtectedVisibility:
1420 return LLVMRustVisibility::Protected;
1422 report_fatal_error("Invalid LLVMRustVisibility value!");
1425 static LLVMVisibility fromRust(LLVMRustVisibility Vis) {
1427 case LLVMRustVisibility::Default:
1428 return LLVMDefaultVisibility;
1429 case LLVMRustVisibility::Hidden:
1430 return LLVMHiddenVisibility;
1431 case LLVMRustVisibility::Protected:
1432 return LLVMProtectedVisibility;
1434 report_fatal_error("Invalid LLVMRustVisibility value!");
1437 extern "C" LLVMRustVisibility LLVMRustGetVisibility(LLVMValueRef V) {
1438 return toRust(LLVMGetVisibility(V));
1441 // Oh hey, a binding that makes sense for once? (because LLVM’s own do not)
1442 extern "C" LLVMValueRef LLVMRustBuildIntCast(LLVMBuilderRef B, LLVMValueRef Val,
1443 LLVMTypeRef DestTy, bool isSigned) {
1444 return wrap(unwrap(B)->CreateIntCast(unwrap(Val), unwrap(DestTy), isSigned, ""));
1447 extern "C" void LLVMRustSetVisibility(LLVMValueRef V,
1448 LLVMRustVisibility RustVisibility) {
1449 LLVMSetVisibility(V, fromRust(RustVisibility));
1452 struct LLVMRustModuleBuffer {
1456 extern "C" LLVMRustModuleBuffer*
1457 LLVMRustModuleBufferCreate(LLVMModuleRef M) {
1458 auto Ret = llvm::make_unique<LLVMRustModuleBuffer>();
1460 raw_string_ostream OS(Ret->data);
1462 legacy::PassManager PM;
1463 PM.add(createBitcodeWriterPass(OS));
1467 return Ret.release();
1471 LLVMRustModuleBufferFree(LLVMRustModuleBuffer *Buffer) {
1475 extern "C" const void*
1476 LLVMRustModuleBufferPtr(const LLVMRustModuleBuffer *Buffer) {
1477 return Buffer->data.data();
1481 LLVMRustModuleBufferLen(const LLVMRustModuleBuffer *Buffer) {
1482 return Buffer->data.length();
1486 LLVMRustModuleCost(LLVMModuleRef M) {
1487 auto f = unwrap(M)->functions();
1488 return std::distance(std::begin(f), std::end(f));
1491 // Vector reductions:
1492 extern "C" LLVMValueRef
1493 LLVMRustBuildVectorReduceFAdd(LLVMBuilderRef B, LLVMValueRef Acc, LLVMValueRef Src) {
1494 return wrap(unwrap(B)->CreateFAddReduce(unwrap(Acc),unwrap(Src)));
1496 extern "C" LLVMValueRef
1497 LLVMRustBuildVectorReduceFMul(LLVMBuilderRef B, LLVMValueRef Acc, LLVMValueRef Src) {
1498 return wrap(unwrap(B)->CreateFMulReduce(unwrap(Acc),unwrap(Src)));
1500 extern "C" LLVMValueRef
1501 LLVMRustBuildVectorReduceAdd(LLVMBuilderRef B, LLVMValueRef Src) {
1502 return wrap(unwrap(B)->CreateAddReduce(unwrap(Src)));
1504 extern "C" LLVMValueRef
1505 LLVMRustBuildVectorReduceMul(LLVMBuilderRef B, LLVMValueRef Src) {
1506 return wrap(unwrap(B)->CreateMulReduce(unwrap(Src)));
1508 extern "C" LLVMValueRef
1509 LLVMRustBuildVectorReduceAnd(LLVMBuilderRef B, LLVMValueRef Src) {
1510 return wrap(unwrap(B)->CreateAndReduce(unwrap(Src)));
1512 extern "C" LLVMValueRef
1513 LLVMRustBuildVectorReduceOr(LLVMBuilderRef B, LLVMValueRef Src) {
1514 return wrap(unwrap(B)->CreateOrReduce(unwrap(Src)));
1516 extern "C" LLVMValueRef
1517 LLVMRustBuildVectorReduceXor(LLVMBuilderRef B, LLVMValueRef Src) {
1518 return wrap(unwrap(B)->CreateXorReduce(unwrap(Src)));
1520 extern "C" LLVMValueRef
1521 LLVMRustBuildVectorReduceMin(LLVMBuilderRef B, LLVMValueRef Src, bool IsSigned) {
1522 return wrap(unwrap(B)->CreateIntMinReduce(unwrap(Src), IsSigned));
1524 extern "C" LLVMValueRef
1525 LLVMRustBuildVectorReduceMax(LLVMBuilderRef B, LLVMValueRef Src, bool IsSigned) {
1526 return wrap(unwrap(B)->CreateIntMaxReduce(unwrap(Src), IsSigned));
1528 extern "C" LLVMValueRef
1529 LLVMRustBuildVectorReduceFMin(LLVMBuilderRef B, LLVMValueRef Src, bool NoNaN) {
1530 return wrap(unwrap(B)->CreateFPMinReduce(unwrap(Src), NoNaN));
1532 extern "C" LLVMValueRef
1533 LLVMRustBuildVectorReduceFMax(LLVMBuilderRef B, LLVMValueRef Src, bool NoNaN) {
1534 return wrap(unwrap(B)->CreateFPMaxReduce(unwrap(Src), NoNaN));
1537 extern "C" LLVMValueRef
1538 LLVMRustBuildMinNum(LLVMBuilderRef B, LLVMValueRef LHS, LLVMValueRef RHS) {
1539 return wrap(unwrap(B)->CreateMinNum(unwrap(LHS),unwrap(RHS)));
1541 extern "C" LLVMValueRef
1542 LLVMRustBuildMaxNum(LLVMBuilderRef B, LLVMValueRef LHS, LLVMValueRef RHS) {
1543 return wrap(unwrap(B)->CreateMaxNum(unwrap(LHS),unwrap(RHS)));