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" unsigned int LLVMRustGetInstructionCount(LLVMModuleRef M) {
91 return unwrap(M)->getInstructionCount();
94 extern "C" void LLVMRustSetLastError(const char *Err) {
95 free((void *)LastError);
96 LastError = strdup(Err);
99 extern "C" LLVMContextRef LLVMRustContextCreate(bool shouldDiscardNames) {
100 auto ctx = new LLVMContext();
101 ctx->setDiscardValueNames(shouldDiscardNames);
105 extern "C" void LLVMRustSetNormalizedTarget(LLVMModuleRef M,
106 const char *Triple) {
107 unwrap(M)->setTargetTriple(Triple::normalize(Triple));
110 extern "C" void LLVMRustPrintPassTimings() {
111 raw_fd_ostream OS(2, false); // stderr.
112 TimerGroup::printAll(OS);
115 extern "C" LLVMValueRef LLVMRustGetNamedValue(LLVMModuleRef M,
117 return wrap(unwrap(M)->getNamedValue(Name));
120 extern "C" LLVMValueRef LLVMRustGetOrInsertFunction(LLVMModuleRef M,
122 LLVMTypeRef FunctionTy) {
124 unwrap(M)->getOrInsertFunction(Name, unwrap<FunctionType>(FunctionTy))
125 #if LLVM_VERSION_GE(9, 0)
131 extern "C" LLVMValueRef
132 LLVMRustGetOrInsertGlobal(LLVMModuleRef M, const char *Name, LLVMTypeRef Ty) {
133 return wrap(unwrap(M)->getOrInsertGlobal(Name, unwrap(Ty)));
136 extern "C" LLVMValueRef
137 LLVMRustInsertPrivateGlobal(LLVMModuleRef M, LLVMTypeRef Ty) {
138 return wrap(new GlobalVariable(*unwrap(M),
141 GlobalValue::PrivateLinkage,
145 extern "C" LLVMTypeRef LLVMRustMetadataTypeInContext(LLVMContextRef C) {
146 return wrap(Type::getMetadataTy(*unwrap(C)));
149 static Attribute::AttrKind fromRust(LLVMRustAttribute Kind) {
152 return Attribute::AlwaysInline;
154 return Attribute::ByVal;
156 return Attribute::Cold;
158 return Attribute::InlineHint;
160 return Attribute::MinSize;
162 return Attribute::Naked;
164 return Attribute::NoAlias;
166 return Attribute::NoCapture;
168 return Attribute::NoInline;
170 return Attribute::NonNull;
172 return Attribute::NoRedZone;
174 return Attribute::NoReturn;
176 return Attribute::NoUnwind;
177 case OptimizeForSize:
178 return Attribute::OptimizeForSize;
180 return Attribute::ReadOnly;
182 return Attribute::SExt;
184 return Attribute::StructRet;
186 return Attribute::UWTable;
188 return Attribute::ZExt;
190 return Attribute::InReg;
192 return Attribute::SanitizeThread;
193 case SanitizeAddress:
194 return Attribute::SanitizeAddress;
196 return Attribute::SanitizeMemory;
198 return Attribute::NonLazyBind;
200 return Attribute::OptimizeNone;
202 return Attribute::ReturnsTwice;
204 report_fatal_error("bad AttributeKind");
207 extern "C" void LLVMRustAddCallSiteAttribute(LLVMValueRef Instr, unsigned Index,
208 LLVMRustAttribute RustAttr) {
209 CallSite Call = CallSite(unwrap<Instruction>(Instr));
210 Attribute Attr = Attribute::get(Call->getContext(), fromRust(RustAttr));
211 Call.addAttribute(Index, Attr);
214 extern "C" void LLVMRustAddAlignmentCallSiteAttr(LLVMValueRef Instr,
217 CallSite Call = CallSite(unwrap<Instruction>(Instr));
219 B.addAlignmentAttr(Bytes);
220 Call.setAttributes(Call.getAttributes().addAttributes(
221 Call->getContext(), Index, B));
224 extern "C" void LLVMRustAddDereferenceableCallSiteAttr(LLVMValueRef Instr,
227 CallSite Call = CallSite(unwrap<Instruction>(Instr));
229 B.addDereferenceableAttr(Bytes);
230 Call.setAttributes(Call.getAttributes().addAttributes(
231 Call->getContext(), Index, B));
234 extern "C" void LLVMRustAddDereferenceableOrNullCallSiteAttr(LLVMValueRef Instr,
237 CallSite Call = CallSite(unwrap<Instruction>(Instr));
239 B.addDereferenceableOrNullAttr(Bytes);
240 Call.setAttributes(Call.getAttributes().addAttributes(
241 Call->getContext(), Index, B));
244 extern "C" void LLVMRustAddByValCallSiteAttr(LLVMValueRef Instr, unsigned Index,
246 CallSite Call = CallSite(unwrap<Instruction>(Instr));
247 #if LLVM_VERSION_GE(9, 0)
248 Attribute Attr = Attribute::getWithByValType(Call->getContext(), unwrap(Ty));
250 Attribute Attr = Attribute::get(Call->getContext(), Attribute::ByVal);
252 Call.addAttribute(Index, Attr);
255 extern "C" void LLVMRustAddFunctionAttribute(LLVMValueRef Fn, unsigned Index,
256 LLVMRustAttribute RustAttr) {
257 Function *A = unwrap<Function>(Fn);
258 Attribute Attr = Attribute::get(A->getContext(), fromRust(RustAttr));
260 A->addAttributes(Index, B);
263 extern "C" void LLVMRustAddAlignmentAttr(LLVMValueRef Fn,
266 Function *A = unwrap<Function>(Fn);
268 B.addAlignmentAttr(Bytes);
269 A->addAttributes(Index, B);
272 extern "C" void LLVMRustAddDereferenceableAttr(LLVMValueRef Fn, unsigned Index,
274 Function *A = unwrap<Function>(Fn);
276 B.addDereferenceableAttr(Bytes);
277 A->addAttributes(Index, B);
280 extern "C" void LLVMRustAddDereferenceableOrNullAttr(LLVMValueRef Fn,
283 Function *A = unwrap<Function>(Fn);
285 B.addDereferenceableOrNullAttr(Bytes);
286 A->addAttributes(Index, B);
289 extern "C" void LLVMRustAddByValAttr(LLVMValueRef Fn, unsigned Index,
291 Function *F = unwrap<Function>(Fn);
292 #if LLVM_VERSION_GE(9, 0)
293 Attribute Attr = Attribute::getWithByValType(F->getContext(), unwrap(Ty));
295 Attribute Attr = Attribute::get(F->getContext(), Attribute::ByVal);
297 F->addAttribute(Index, Attr);
300 extern "C" void LLVMRustAddFunctionAttrStringValue(LLVMValueRef Fn,
304 Function *F = unwrap<Function>(Fn);
306 B.addAttribute(Name, Value);
307 F->addAttributes(Index, B);
310 extern "C" void LLVMRustRemoveFunctionAttributes(LLVMValueRef Fn,
312 LLVMRustAttribute RustAttr) {
313 Function *F = unwrap<Function>(Fn);
314 Attribute Attr = Attribute::get(F->getContext(), fromRust(RustAttr));
316 auto PAL = F->getAttributes();
317 auto PALNew = PAL.removeAttributes(F->getContext(), Index, B);
318 F->setAttributes(PALNew);
321 // enable fpmath flag UnsafeAlgebra
322 extern "C" void LLVMRustSetHasUnsafeAlgebra(LLVMValueRef V) {
323 if (auto I = dyn_cast<Instruction>(unwrap<Value>(V))) {
328 extern "C" LLVMValueRef
329 LLVMRustBuildAtomicLoad(LLVMBuilderRef B, LLVMValueRef Source, const char *Name,
330 LLVMAtomicOrdering Order) {
331 LoadInst *LI = new LoadInst(unwrap(Source));
332 LI->setAtomic(fromRust(Order));
333 return wrap(unwrap(B)->Insert(LI, Name));
336 extern "C" LLVMValueRef LLVMRustBuildAtomicStore(LLVMBuilderRef B,
339 LLVMAtomicOrdering Order) {
340 StoreInst *SI = new StoreInst(unwrap(V), unwrap(Target));
341 SI->setAtomic(fromRust(Order));
342 return wrap(unwrap(B)->Insert(SI));
345 extern "C" LLVMValueRef
346 LLVMRustBuildAtomicCmpXchg(LLVMBuilderRef B, LLVMValueRef Target,
347 LLVMValueRef Old, LLVMValueRef Source,
348 LLVMAtomicOrdering Order,
349 LLVMAtomicOrdering FailureOrder, LLVMBool Weak) {
350 AtomicCmpXchgInst *ACXI = unwrap(B)->CreateAtomicCmpXchg(
351 unwrap(Target), unwrap(Old), unwrap(Source), fromRust(Order),
352 fromRust(FailureOrder));
357 enum class LLVMRustSynchronizationScope {
363 static SyncScope::ID fromRust(LLVMRustSynchronizationScope Scope) {
365 case LLVMRustSynchronizationScope::SingleThread:
366 return SyncScope::SingleThread;
367 case LLVMRustSynchronizationScope::CrossThread:
368 return SyncScope::System;
370 report_fatal_error("bad SynchronizationScope.");
374 extern "C" LLVMValueRef
375 LLVMRustBuildAtomicFence(LLVMBuilderRef B, LLVMAtomicOrdering Order,
376 LLVMRustSynchronizationScope Scope) {
377 return wrap(unwrap(B)->CreateFence(fromRust(Order), fromRust(Scope)));
380 enum class LLVMRustAsmDialect {
386 static InlineAsm::AsmDialect fromRust(LLVMRustAsmDialect Dialect) {
388 case LLVMRustAsmDialect::Att:
389 return InlineAsm::AD_ATT;
390 case LLVMRustAsmDialect::Intel:
391 return InlineAsm::AD_Intel;
393 report_fatal_error("bad AsmDialect.");
397 extern "C" LLVMValueRef LLVMRustInlineAsm(LLVMTypeRef Ty, char *AsmString,
399 LLVMBool HasSideEffects,
400 LLVMBool IsAlignStack,
401 LLVMRustAsmDialect Dialect) {
402 return wrap(InlineAsm::get(unwrap<FunctionType>(Ty), AsmString, Constraints,
403 HasSideEffects, IsAlignStack, fromRust(Dialect)));
406 extern "C" bool LLVMRustInlineAsmVerify(LLVMTypeRef Ty,
408 return InlineAsm::Verify(unwrap<FunctionType>(Ty), Constraints);
411 extern "C" void LLVMRustAppendModuleInlineAsm(LLVMModuleRef M, const char *Asm) {
412 unwrap(M)->appendModuleInlineAsm(StringRef(Asm));
415 typedef DIBuilder *LLVMRustDIBuilderRef;
417 template <typename DIT> DIT *unwrapDIPtr(LLVMMetadataRef Ref) {
418 return (DIT *)(Ref ? unwrap<MDNode>(Ref) : nullptr);
421 #define DIDescriptor DIScope
422 #define DIArray DINodeArray
423 #define unwrapDI unwrapDIPtr
425 // These values **must** match debuginfo::DIFlags! They also *happen*
426 // to match LLVM, but that isn't required as we do giant sets of
427 // matching below. The value shouldn't be directly passed to LLVM.
428 enum class LLVMRustDIFlags : uint32_t {
433 FlagFwdDecl = (1 << 2),
434 FlagAppleBlock = (1 << 3),
435 FlagBlockByrefStruct = (1 << 4),
436 FlagVirtual = (1 << 5),
437 FlagArtificial = (1 << 6),
438 FlagExplicit = (1 << 7),
439 FlagPrototyped = (1 << 8),
440 FlagObjcClassComplete = (1 << 9),
441 FlagObjectPointer = (1 << 10),
442 FlagVector = (1 << 11),
443 FlagStaticMember = (1 << 12),
444 FlagLValueReference = (1 << 13),
445 FlagRValueReference = (1 << 14),
446 FlagExternalTypeRef = (1 << 15),
447 FlagIntroducedVirtual = (1 << 18),
448 FlagBitField = (1 << 19),
449 FlagNoReturn = (1 << 20),
450 // Do not add values that are not supported by the minimum LLVM
451 // version we support! see llvm/include/llvm/IR/DebugInfoFlags.def
454 inline LLVMRustDIFlags operator&(LLVMRustDIFlags A, LLVMRustDIFlags B) {
455 return static_cast<LLVMRustDIFlags>(static_cast<uint32_t>(A) &
456 static_cast<uint32_t>(B));
459 inline LLVMRustDIFlags operator|(LLVMRustDIFlags A, LLVMRustDIFlags B) {
460 return static_cast<LLVMRustDIFlags>(static_cast<uint32_t>(A) |
461 static_cast<uint32_t>(B));
464 inline LLVMRustDIFlags &operator|=(LLVMRustDIFlags &A, LLVMRustDIFlags B) {
468 inline bool isSet(LLVMRustDIFlags F) { return F != LLVMRustDIFlags::FlagZero; }
470 inline LLVMRustDIFlags visibility(LLVMRustDIFlags F) {
471 return static_cast<LLVMRustDIFlags>(static_cast<uint32_t>(F) & 0x3);
474 static DINode::DIFlags fromRust(LLVMRustDIFlags Flags) {
475 DINode::DIFlags Result = DINode::DIFlags::FlagZero;
477 switch (visibility(Flags)) {
478 case LLVMRustDIFlags::FlagPrivate:
479 Result |= DINode::DIFlags::FlagPrivate;
481 case LLVMRustDIFlags::FlagProtected:
482 Result |= DINode::DIFlags::FlagProtected;
484 case LLVMRustDIFlags::FlagPublic:
485 Result |= DINode::DIFlags::FlagPublic;
488 // The rest are handled below
492 if (isSet(Flags & LLVMRustDIFlags::FlagFwdDecl)) {
493 Result |= DINode::DIFlags::FlagFwdDecl;
495 if (isSet(Flags & LLVMRustDIFlags::FlagAppleBlock)) {
496 Result |= DINode::DIFlags::FlagAppleBlock;
498 if (isSet(Flags & LLVMRustDIFlags::FlagBlockByrefStruct)) {
499 Result |= DINode::DIFlags::FlagBlockByrefStruct;
501 if (isSet(Flags & LLVMRustDIFlags::FlagVirtual)) {
502 Result |= DINode::DIFlags::FlagVirtual;
504 if (isSet(Flags & LLVMRustDIFlags::FlagArtificial)) {
505 Result |= DINode::DIFlags::FlagArtificial;
507 if (isSet(Flags & LLVMRustDIFlags::FlagExplicit)) {
508 Result |= DINode::DIFlags::FlagExplicit;
510 if (isSet(Flags & LLVMRustDIFlags::FlagPrototyped)) {
511 Result |= DINode::DIFlags::FlagPrototyped;
513 if (isSet(Flags & LLVMRustDIFlags::FlagObjcClassComplete)) {
514 Result |= DINode::DIFlags::FlagObjcClassComplete;
516 if (isSet(Flags & LLVMRustDIFlags::FlagObjectPointer)) {
517 Result |= DINode::DIFlags::FlagObjectPointer;
519 if (isSet(Flags & LLVMRustDIFlags::FlagVector)) {
520 Result |= DINode::DIFlags::FlagVector;
522 if (isSet(Flags & LLVMRustDIFlags::FlagStaticMember)) {
523 Result |= DINode::DIFlags::FlagStaticMember;
525 if (isSet(Flags & LLVMRustDIFlags::FlagLValueReference)) {
526 Result |= DINode::DIFlags::FlagLValueReference;
528 if (isSet(Flags & LLVMRustDIFlags::FlagRValueReference)) {
529 Result |= DINode::DIFlags::FlagRValueReference;
531 if (isSet(Flags & LLVMRustDIFlags::FlagIntroducedVirtual)) {
532 Result |= DINode::DIFlags::FlagIntroducedVirtual;
534 if (isSet(Flags & LLVMRustDIFlags::FlagBitField)) {
535 Result |= DINode::DIFlags::FlagBitField;
537 if (isSet(Flags & LLVMRustDIFlags::FlagNoReturn)) {
538 Result |= DINode::DIFlags::FlagNoReturn;
544 // These values **must** match debuginfo::DISPFlags! They also *happen*
545 // to match LLVM, but that isn't required as we do giant sets of
546 // matching below. The value shouldn't be directly passed to LLVM.
547 enum class LLVMRustDISPFlags : uint32_t {
550 SPFlagPureVirtual = 2,
551 SPFlagLocalToUnit = (1 << 2),
552 SPFlagDefinition = (1 << 3),
553 SPFlagOptimized = (1 << 4),
554 SPFlagMainSubprogram = (1 << 5),
555 // Do not add values that are not supported by the minimum LLVM
556 // version we support! see llvm/include/llvm/IR/DebugInfoFlags.def
557 // (In LLVM < 8, createFunction supported these as separate bool arguments.)
560 inline LLVMRustDISPFlags operator&(LLVMRustDISPFlags A, LLVMRustDISPFlags B) {
561 return static_cast<LLVMRustDISPFlags>(static_cast<uint32_t>(A) &
562 static_cast<uint32_t>(B));
565 inline LLVMRustDISPFlags operator|(LLVMRustDISPFlags A, LLVMRustDISPFlags B) {
566 return static_cast<LLVMRustDISPFlags>(static_cast<uint32_t>(A) |
567 static_cast<uint32_t>(B));
570 inline LLVMRustDISPFlags &operator|=(LLVMRustDISPFlags &A, LLVMRustDISPFlags B) {
574 inline bool isSet(LLVMRustDISPFlags F) { return F != LLVMRustDISPFlags::SPFlagZero; }
576 inline LLVMRustDISPFlags virtuality(LLVMRustDISPFlags F) {
577 return static_cast<LLVMRustDISPFlags>(static_cast<uint32_t>(F) & 0x3);
580 #if LLVM_VERSION_GE(8, 0)
581 static DISubprogram::DISPFlags fromRust(LLVMRustDISPFlags SPFlags) {
582 DISubprogram::DISPFlags Result = DISubprogram::DISPFlags::SPFlagZero;
584 switch (virtuality(SPFlags)) {
585 case LLVMRustDISPFlags::SPFlagVirtual:
586 Result |= DISubprogram::DISPFlags::SPFlagVirtual;
588 case LLVMRustDISPFlags::SPFlagPureVirtual:
589 Result |= DISubprogram::DISPFlags::SPFlagPureVirtual;
592 // The rest are handled below
596 if (isSet(SPFlags & LLVMRustDISPFlags::SPFlagLocalToUnit)) {
597 Result |= DISubprogram::DISPFlags::SPFlagLocalToUnit;
599 if (isSet(SPFlags & LLVMRustDISPFlags::SPFlagDefinition)) {
600 Result |= DISubprogram::DISPFlags::SPFlagDefinition;
602 if (isSet(SPFlags & LLVMRustDISPFlags::SPFlagOptimized)) {
603 Result |= DISubprogram::DISPFlags::SPFlagOptimized;
605 #if LLVM_VERSION_GE(9, 0)
606 if (isSet(SPFlags & LLVMRustDISPFlags::SPFlagMainSubprogram)) {
607 Result |= DISubprogram::DISPFlags::SPFlagMainSubprogram;
615 enum class LLVMRustDebugEmissionKind {
621 static DICompileUnit::DebugEmissionKind fromRust(LLVMRustDebugEmissionKind Kind) {
623 case LLVMRustDebugEmissionKind::NoDebug:
624 return DICompileUnit::DebugEmissionKind::NoDebug;
625 case LLVMRustDebugEmissionKind::FullDebug:
626 return DICompileUnit::DebugEmissionKind::FullDebug;
627 case LLVMRustDebugEmissionKind::LineTablesOnly:
628 return DICompileUnit::DebugEmissionKind::LineTablesOnly;
630 report_fatal_error("bad DebugEmissionKind.");
634 extern "C" uint32_t LLVMRustDebugMetadataVersion() {
635 return DEBUG_METADATA_VERSION;
638 extern "C" uint32_t LLVMRustVersionMinor() { return LLVM_VERSION_MINOR; }
640 extern "C" uint32_t LLVMRustVersionMajor() { return LLVM_VERSION_MAJOR; }
642 extern "C" void LLVMRustAddModuleFlag(LLVMModuleRef M, const char *Name,
644 unwrap(M)->addModuleFlag(Module::Warning, Name, Value);
647 extern "C" LLVMValueRef LLVMRustMetadataAsValue(LLVMContextRef C, LLVMMetadataRef MD) {
648 return wrap(MetadataAsValue::get(*unwrap(C), unwrap(MD)));
651 extern "C" LLVMRustDIBuilderRef LLVMRustDIBuilderCreate(LLVMModuleRef M) {
652 return new DIBuilder(*unwrap(M));
655 extern "C" void LLVMRustDIBuilderDispose(LLVMRustDIBuilderRef Builder) {
659 extern "C" void LLVMRustDIBuilderFinalize(LLVMRustDIBuilderRef Builder) {
663 extern "C" LLVMMetadataRef LLVMRustDIBuilderCreateCompileUnit(
664 LLVMRustDIBuilderRef Builder, unsigned Lang, LLVMMetadataRef FileRef,
665 const char *Producer, bool isOptimized, const char *Flags,
666 unsigned RuntimeVer, const char *SplitName,
667 LLVMRustDebugEmissionKind Kind) {
668 auto *File = unwrapDI<DIFile>(FileRef);
670 return wrap(Builder->createCompileUnit(Lang, File, Producer, isOptimized,
671 Flags, RuntimeVer, SplitName,
675 extern "C" LLVMMetadataRef
676 LLVMRustDIBuilderCreateFile(LLVMRustDIBuilderRef Builder, const char *Filename,
677 const char *Directory) {
678 return wrap(Builder->createFile(Filename, Directory));
681 extern "C" LLVMMetadataRef
682 LLVMRustDIBuilderCreateSubroutineType(LLVMRustDIBuilderRef Builder,
683 LLVMMetadataRef File,
684 LLVMMetadataRef ParameterTypes) {
685 return wrap(Builder->createSubroutineType(
686 DITypeRefArray(unwrap<MDTuple>(ParameterTypes))));
689 extern "C" LLVMMetadataRef LLVMRustDIBuilderCreateFunction(
690 LLVMRustDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
691 const char *LinkageName, LLVMMetadataRef File, unsigned LineNo,
692 LLVMMetadataRef Ty, unsigned ScopeLine, LLVMRustDIFlags Flags,
693 LLVMRustDISPFlags SPFlags, LLVMValueRef Fn, LLVMMetadataRef TParam,
694 LLVMMetadataRef Decl) {
695 DITemplateParameterArray TParams =
696 DITemplateParameterArray(unwrap<MDTuple>(TParam));
697 #if LLVM_VERSION_GE(8, 0)
698 DISubprogram::DISPFlags llvmSPFlags = fromRust(SPFlags);
699 DINode::DIFlags llvmFlags = fromRust(Flags);
700 #if LLVM_VERSION_LT(9, 0)
701 if (isSet(SPFlags & LLVMRustDISPFlags::SPFlagMainSubprogram))
702 llvmFlags |= DINode::DIFlags::FlagMainSubprogram;
704 DISubprogram *Sub = Builder->createFunction(
705 unwrapDI<DIScope>(Scope), Name, LinkageName, unwrapDI<DIFile>(File),
706 LineNo, unwrapDI<DISubroutineType>(Ty), ScopeLine, llvmFlags,
707 llvmSPFlags, TParams, unwrapDIPtr<DISubprogram>(Decl));
709 bool IsLocalToUnit = isSet(SPFlags & LLVMRustDISPFlags::SPFlagLocalToUnit);
710 bool IsDefinition = isSet(SPFlags & LLVMRustDISPFlags::SPFlagDefinition);
711 bool IsOptimized = isSet(SPFlags & LLVMRustDISPFlags::SPFlagOptimized);
712 DINode::DIFlags llvmFlags = fromRust(Flags);
713 if (isSet(SPFlags & LLVMRustDISPFlags::SPFlagMainSubprogram))
714 llvmFlags |= DINode::DIFlags::FlagMainSubprogram;
715 DISubprogram *Sub = Builder->createFunction(
716 unwrapDI<DIScope>(Scope), Name, LinkageName, unwrapDI<DIFile>(File),
717 LineNo, unwrapDI<DISubroutineType>(Ty), IsLocalToUnit, IsDefinition,
718 ScopeLine, llvmFlags, IsOptimized, TParams,
719 unwrapDIPtr<DISubprogram>(Decl));
721 unwrap<Function>(Fn)->setSubprogram(Sub);
725 extern "C" LLVMMetadataRef
726 LLVMRustDIBuilderCreateBasicType(LLVMRustDIBuilderRef Builder, const char *Name,
727 uint64_t SizeInBits, uint32_t AlignInBits,
729 return wrap(Builder->createBasicType(Name, SizeInBits, Encoding));
732 extern "C" LLVMMetadataRef LLVMRustDIBuilderCreatePointerType(
733 LLVMRustDIBuilderRef Builder, LLVMMetadataRef PointeeTy,
734 uint64_t SizeInBits, uint32_t AlignInBits, const char *Name) {
735 return wrap(Builder->createPointerType(unwrapDI<DIType>(PointeeTy),
736 SizeInBits, AlignInBits,
737 /* DWARFAddressSpace */ None,
741 extern "C" LLVMMetadataRef LLVMRustDIBuilderCreateStructType(
742 LLVMRustDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
743 LLVMMetadataRef File, unsigned LineNumber, uint64_t SizeInBits,
744 uint32_t AlignInBits, LLVMRustDIFlags Flags,
745 LLVMMetadataRef DerivedFrom, LLVMMetadataRef Elements,
746 unsigned RunTimeLang, LLVMMetadataRef VTableHolder,
747 const char *UniqueId) {
748 return wrap(Builder->createStructType(
749 unwrapDI<DIDescriptor>(Scope), Name, unwrapDI<DIFile>(File), LineNumber,
750 SizeInBits, AlignInBits, fromRust(Flags), unwrapDI<DIType>(DerivedFrom),
751 DINodeArray(unwrapDI<MDTuple>(Elements)), RunTimeLang,
752 unwrapDI<DIType>(VTableHolder), UniqueId));
755 extern "C" LLVMMetadataRef LLVMRustDIBuilderCreateVariantPart(
756 LLVMRustDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
757 LLVMMetadataRef File, unsigned LineNumber, uint64_t SizeInBits,
758 uint32_t AlignInBits, LLVMRustDIFlags Flags, LLVMMetadataRef Discriminator,
759 LLVMMetadataRef Elements, const char *UniqueId) {
760 return wrap(Builder->createVariantPart(
761 unwrapDI<DIDescriptor>(Scope), Name, unwrapDI<DIFile>(File), LineNumber,
762 SizeInBits, AlignInBits, fromRust(Flags), unwrapDI<DIDerivedType>(Discriminator),
763 DINodeArray(unwrapDI<MDTuple>(Elements)), UniqueId));
766 extern "C" LLVMMetadataRef LLVMRustDIBuilderCreateMemberType(
767 LLVMRustDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
768 LLVMMetadataRef File, unsigned LineNo, uint64_t SizeInBits,
769 uint32_t AlignInBits, uint64_t OffsetInBits, LLVMRustDIFlags Flags,
770 LLVMMetadataRef Ty) {
771 return wrap(Builder->createMemberType(unwrapDI<DIDescriptor>(Scope), Name,
772 unwrapDI<DIFile>(File), LineNo,
773 SizeInBits, AlignInBits, OffsetInBits,
774 fromRust(Flags), unwrapDI<DIType>(Ty)));
777 extern "C" LLVMMetadataRef LLVMRustDIBuilderCreateVariantMemberType(
778 LLVMRustDIBuilderRef Builder, LLVMMetadataRef Scope,
779 const char *Name, LLVMMetadataRef File, unsigned LineNo, uint64_t SizeInBits,
780 uint32_t AlignInBits, uint64_t OffsetInBits, LLVMValueRef Discriminant,
781 LLVMRustDIFlags Flags, LLVMMetadataRef Ty) {
782 llvm::ConstantInt* D = nullptr;
784 D = unwrap<llvm::ConstantInt>(Discriminant);
786 return wrap(Builder->createVariantMemberType(unwrapDI<DIDescriptor>(Scope), Name,
787 unwrapDI<DIFile>(File), LineNo,
788 SizeInBits, AlignInBits, OffsetInBits, D,
789 fromRust(Flags), unwrapDI<DIType>(Ty)));
792 extern "C" LLVMMetadataRef LLVMRustDIBuilderCreateLexicalBlock(
793 LLVMRustDIBuilderRef Builder, LLVMMetadataRef Scope,
794 LLVMMetadataRef File, unsigned Line, unsigned Col) {
795 return wrap(Builder->createLexicalBlock(unwrapDI<DIDescriptor>(Scope),
796 unwrapDI<DIFile>(File), Line, Col));
799 extern "C" LLVMMetadataRef
800 LLVMRustDIBuilderCreateLexicalBlockFile(LLVMRustDIBuilderRef Builder,
801 LLVMMetadataRef Scope,
802 LLVMMetadataRef File) {
803 return wrap(Builder->createLexicalBlockFile(unwrapDI<DIDescriptor>(Scope),
804 unwrapDI<DIFile>(File)));
807 extern "C" LLVMMetadataRef LLVMRustDIBuilderCreateStaticVariable(
808 LLVMRustDIBuilderRef Builder, LLVMMetadataRef Context, const char *Name,
809 const char *LinkageName, LLVMMetadataRef File, unsigned LineNo,
810 LLVMMetadataRef Ty, bool IsLocalToUnit, LLVMValueRef V,
811 LLVMMetadataRef Decl = nullptr, uint32_t AlignInBits = 0) {
812 llvm::GlobalVariable *InitVal = cast<llvm::GlobalVariable>(unwrap(V));
814 llvm::DIExpression *InitExpr = nullptr;
815 if (llvm::ConstantInt *IntVal = llvm::dyn_cast<llvm::ConstantInt>(InitVal)) {
816 InitExpr = Builder->createConstantValueExpression(
817 IntVal->getValue().getSExtValue());
818 } else if (llvm::ConstantFP *FPVal =
819 llvm::dyn_cast<llvm::ConstantFP>(InitVal)) {
820 InitExpr = Builder->createConstantValueExpression(
821 FPVal->getValueAPF().bitcastToAPInt().getZExtValue());
824 llvm::DIGlobalVariableExpression *VarExpr = Builder->createGlobalVariableExpression(
825 unwrapDI<DIDescriptor>(Context), Name, LinkageName,
826 unwrapDI<DIFile>(File), LineNo, unwrapDI<DIType>(Ty), IsLocalToUnit,
827 InitExpr, unwrapDIPtr<MDNode>(Decl),
828 #if LLVM_VERSION_GE(8, 0)
829 /* templateParams */ nullptr,
833 InitVal->setMetadata("dbg", VarExpr);
835 return wrap(VarExpr);
838 extern "C" LLVMMetadataRef LLVMRustDIBuilderCreateVariable(
839 LLVMRustDIBuilderRef Builder, unsigned Tag, LLVMMetadataRef Scope,
840 const char *Name, LLVMMetadataRef File, unsigned LineNo,
841 LLVMMetadataRef Ty, bool AlwaysPreserve, LLVMRustDIFlags Flags,
842 unsigned ArgNo, uint32_t AlignInBits) {
843 if (Tag == 0x100) { // DW_TAG_auto_variable
844 return wrap(Builder->createAutoVariable(
845 unwrapDI<DIDescriptor>(Scope), Name, unwrapDI<DIFile>(File), LineNo,
846 unwrapDI<DIType>(Ty), AlwaysPreserve, fromRust(Flags), AlignInBits));
848 return wrap(Builder->createParameterVariable(
849 unwrapDI<DIDescriptor>(Scope), Name, ArgNo, unwrapDI<DIFile>(File),
850 LineNo, unwrapDI<DIType>(Ty), AlwaysPreserve, fromRust(Flags)));
854 extern "C" LLVMMetadataRef
855 LLVMRustDIBuilderCreateArrayType(LLVMRustDIBuilderRef Builder, uint64_t Size,
856 uint32_t AlignInBits, LLVMMetadataRef Ty,
857 LLVMMetadataRef Subscripts) {
859 Builder->createArrayType(Size, AlignInBits, unwrapDI<DIType>(Ty),
860 DINodeArray(unwrapDI<MDTuple>(Subscripts))));
863 extern "C" LLVMMetadataRef
864 LLVMRustDIBuilderGetOrCreateSubrange(LLVMRustDIBuilderRef Builder, int64_t Lo,
866 return wrap(Builder->getOrCreateSubrange(Lo, Count));
869 extern "C" LLVMMetadataRef
870 LLVMRustDIBuilderGetOrCreateArray(LLVMRustDIBuilderRef Builder,
871 LLVMMetadataRef *Ptr, unsigned Count) {
872 Metadata **DataValue = unwrap(Ptr);
874 Builder->getOrCreateArray(ArrayRef<Metadata *>(DataValue, Count)).get());
877 extern "C" LLVMValueRef LLVMRustDIBuilderInsertDeclareAtEnd(
878 LLVMRustDIBuilderRef Builder, LLVMValueRef V, LLVMMetadataRef VarInfo,
879 int64_t *AddrOps, unsigned AddrOpsCount, LLVMValueRef DL,
880 LLVMBasicBlockRef InsertAtEnd) {
881 return wrap(Builder->insertDeclare(
882 unwrap(V), unwrap<DILocalVariable>(VarInfo),
883 Builder->createExpression(llvm::ArrayRef<int64_t>(AddrOps, AddrOpsCount)),
884 DebugLoc(cast<MDNode>(unwrap<MetadataAsValue>(DL)->getMetadata())),
885 unwrap(InsertAtEnd)));
888 extern "C" LLVMMetadataRef
889 LLVMRustDIBuilderCreateEnumerator(LLVMRustDIBuilderRef Builder,
890 const char *Name, uint64_t Val) {
891 return wrap(Builder->createEnumerator(Name, Val));
894 extern "C" LLVMMetadataRef LLVMRustDIBuilderCreateEnumerationType(
895 LLVMRustDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
896 LLVMMetadataRef File, unsigned LineNumber, uint64_t SizeInBits,
897 uint32_t AlignInBits, LLVMMetadataRef Elements,
898 LLVMMetadataRef ClassTy, bool IsScoped) {
899 return wrap(Builder->createEnumerationType(
900 unwrapDI<DIDescriptor>(Scope), Name, unwrapDI<DIFile>(File), LineNumber,
901 SizeInBits, AlignInBits, DINodeArray(unwrapDI<MDTuple>(Elements)),
902 unwrapDI<DIType>(ClassTy), "", IsScoped));
905 extern "C" LLVMMetadataRef LLVMRustDIBuilderCreateUnionType(
906 LLVMRustDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
907 LLVMMetadataRef File, unsigned LineNumber, uint64_t SizeInBits,
908 uint32_t AlignInBits, LLVMRustDIFlags Flags, LLVMMetadataRef Elements,
909 unsigned RunTimeLang, const char *UniqueId) {
910 return wrap(Builder->createUnionType(
911 unwrapDI<DIDescriptor>(Scope), Name, unwrapDI<DIFile>(File), LineNumber,
912 SizeInBits, AlignInBits, fromRust(Flags),
913 DINodeArray(unwrapDI<MDTuple>(Elements)), RunTimeLang, UniqueId));
916 extern "C" LLVMMetadataRef LLVMRustDIBuilderCreateTemplateTypeParameter(
917 LLVMRustDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
918 LLVMMetadataRef Ty, LLVMMetadataRef File, unsigned LineNo,
920 return wrap(Builder->createTemplateTypeParameter(
921 unwrapDI<DIDescriptor>(Scope), Name, unwrapDI<DIType>(Ty)));
924 extern "C" LLVMMetadataRef
925 LLVMRustDIBuilderCreateNameSpace(LLVMRustDIBuilderRef Builder,
926 LLVMMetadataRef Scope, const char *Name,
927 LLVMMetadataRef File, unsigned LineNo) {
928 return wrap(Builder->createNameSpace(
929 unwrapDI<DIDescriptor>(Scope), Name,
930 false // ExportSymbols (only relevant for C++ anonymous namespaces)
935 LLVMRustDICompositeTypeReplaceArrays(LLVMRustDIBuilderRef Builder,
936 LLVMMetadataRef CompositeTy,
937 LLVMMetadataRef Elements,
938 LLVMMetadataRef Params) {
939 DICompositeType *Tmp = unwrapDI<DICompositeType>(CompositeTy);
940 Builder->replaceArrays(Tmp, DINodeArray(unwrap<MDTuple>(Elements)),
941 DINodeArray(unwrap<MDTuple>(Params)));
944 extern "C" LLVMValueRef
945 LLVMRustDIBuilderCreateDebugLocation(LLVMContextRef ContextRef, unsigned Line,
946 unsigned Column, LLVMMetadataRef Scope,
947 LLVMMetadataRef InlinedAt) {
948 LLVMContext &Context = *unwrap(ContextRef);
950 DebugLoc debug_loc = DebugLoc::get(Line, Column, unwrapDIPtr<MDNode>(Scope),
951 unwrapDIPtr<MDNode>(InlinedAt));
953 return wrap(MetadataAsValue::get(Context, debug_loc.getAsMDNode()));
956 extern "C" int64_t LLVMRustDIBuilderCreateOpDeref() {
957 return dwarf::DW_OP_deref;
960 extern "C" int64_t LLVMRustDIBuilderCreateOpPlusUconst() {
961 return dwarf::DW_OP_plus_uconst;
964 extern "C" void LLVMRustWriteTypeToString(LLVMTypeRef Ty, RustStringRef Str) {
965 RawRustStringOstream OS(Str);
966 unwrap<llvm::Type>(Ty)->print(OS);
969 extern "C" void LLVMRustWriteValueToString(LLVMValueRef V,
971 RawRustStringOstream OS(Str);
976 unwrap<llvm::Value>(V)->getType()->print(OS);
978 unwrap<llvm::Value>(V)->print(OS);
983 // Note that the two following functions look quite similar to the
984 // LLVMGetSectionName function. Sadly, it appears that this function only
985 // returns a char* pointer, which isn't guaranteed to be null-terminated. The
986 // function provided by LLVM doesn't return the length, so we've created our own
987 // function which returns the length as well as the data pointer.
989 // For an example of this not returning a null terminated string, see
990 // lib/Object/COFFObjectFile.cpp in the getSectionName function. One of the
991 // branches explicitly creates a StringRef without a null terminator, and then
994 inline section_iterator *unwrap(LLVMSectionIteratorRef SI) {
995 return reinterpret_cast<section_iterator *>(SI);
998 extern "C" size_t LLVMRustGetSectionName(LLVMSectionIteratorRef SI,
1001 if (std::error_code EC = (*unwrap(SI))->getName(Ret))
1002 report_fatal_error(EC.message());
1007 // LLVMArrayType function does not support 64-bit ElementCount
1008 extern "C" LLVMTypeRef LLVMRustArrayType(LLVMTypeRef ElementTy,
1009 uint64_t ElementCount) {
1010 return wrap(ArrayType::get(unwrap(ElementTy), ElementCount));
1013 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Twine, LLVMTwineRef)
1015 extern "C" void LLVMRustWriteTwineToString(LLVMTwineRef T, RustStringRef Str) {
1016 RawRustStringOstream OS(Str);
1017 unwrap(T)->print(OS);
1020 extern "C" void LLVMRustUnpackOptimizationDiagnostic(
1021 LLVMDiagnosticInfoRef DI, RustStringRef PassNameOut,
1022 LLVMValueRef *FunctionOut, unsigned* Line, unsigned* Column,
1023 RustStringRef FilenameOut, RustStringRef MessageOut) {
1024 // Undefined to call this not on an optimization diagnostic!
1025 llvm::DiagnosticInfoOptimizationBase *Opt =
1026 static_cast<llvm::DiagnosticInfoOptimizationBase *>(unwrap(DI));
1028 RawRustStringOstream PassNameOS(PassNameOut);
1029 PassNameOS << Opt->getPassName();
1030 *FunctionOut = wrap(&Opt->getFunction());
1032 RawRustStringOstream FilenameOS(FilenameOut);
1033 DiagnosticLocation loc = Opt->getLocation();
1034 if (loc.isValid()) {
1035 *Line = loc.getLine();
1036 *Column = loc.getColumn();
1037 #if LLVM_VERSION_GE(8, 0)
1038 FilenameOS << loc.getAbsolutePath();
1040 FilenameOS << loc.getFilename();
1044 RawRustStringOstream MessageOS(MessageOut);
1045 MessageOS << Opt->getMsg();
1049 LLVMRustUnpackInlineAsmDiagnostic(LLVMDiagnosticInfoRef DI, unsigned *CookieOut,
1050 LLVMTwineRef *MessageOut,
1051 LLVMValueRef *InstructionOut) {
1052 // Undefined to call this not on an inline assembly diagnostic!
1053 llvm::DiagnosticInfoInlineAsm *IA =
1054 static_cast<llvm::DiagnosticInfoInlineAsm *>(unwrap(DI));
1056 *CookieOut = IA->getLocCookie();
1057 *MessageOut = wrap(&IA->getMsgStr());
1058 *InstructionOut = wrap(IA->getInstruction());
1061 extern "C" void LLVMRustWriteDiagnosticInfoToString(LLVMDiagnosticInfoRef DI,
1062 RustStringRef Str) {
1063 RawRustStringOstream OS(Str);
1064 DiagnosticPrinterRawOStream DP(OS);
1065 unwrap(DI)->print(DP);
1068 enum class LLVMRustDiagnosticKind {
1072 DebugMetadataVersion,
1075 OptimizationRemarkMissed,
1076 OptimizationRemarkAnalysis,
1077 OptimizationRemarkAnalysisFPCommute,
1078 OptimizationRemarkAnalysisAliasing,
1079 OptimizationRemarkOther,
1080 OptimizationFailure,
1085 static LLVMRustDiagnosticKind toRust(DiagnosticKind Kind) {
1088 return LLVMRustDiagnosticKind::InlineAsm;
1090 return LLVMRustDiagnosticKind::StackSize;
1091 case DK_DebugMetadataVersion:
1092 return LLVMRustDiagnosticKind::DebugMetadataVersion;
1093 case DK_SampleProfile:
1094 return LLVMRustDiagnosticKind::SampleProfile;
1095 case DK_OptimizationRemark:
1096 return LLVMRustDiagnosticKind::OptimizationRemark;
1097 case DK_OptimizationRemarkMissed:
1098 return LLVMRustDiagnosticKind::OptimizationRemarkMissed;
1099 case DK_OptimizationRemarkAnalysis:
1100 return LLVMRustDiagnosticKind::OptimizationRemarkAnalysis;
1101 case DK_OptimizationRemarkAnalysisFPCommute:
1102 return LLVMRustDiagnosticKind::OptimizationRemarkAnalysisFPCommute;
1103 case DK_OptimizationRemarkAnalysisAliasing:
1104 return LLVMRustDiagnosticKind::OptimizationRemarkAnalysisAliasing;
1106 return LLVMRustDiagnosticKind::PGOProfile;
1108 return LLVMRustDiagnosticKind::Linker;
1110 return (Kind >= DK_FirstRemark && Kind <= DK_LastRemark)
1111 ? LLVMRustDiagnosticKind::OptimizationRemarkOther
1112 : LLVMRustDiagnosticKind::Other;
1116 extern "C" LLVMRustDiagnosticKind
1117 LLVMRustGetDiagInfoKind(LLVMDiagnosticInfoRef DI) {
1118 return toRust((DiagnosticKind)unwrap(DI)->getKind());
1120 // This is kept distinct from LLVMGetTypeKind, because when
1121 // a new type kind is added, the Rust-side enum must be
1122 // updated or UB will result.
1123 extern "C" LLVMTypeKind LLVMRustGetTypeKind(LLVMTypeRef Ty) {
1124 switch (unwrap(Ty)->getTypeID()) {
1125 case Type::VoidTyID:
1126 return LLVMVoidTypeKind;
1127 case Type::HalfTyID:
1128 return LLVMHalfTypeKind;
1129 case Type::FloatTyID:
1130 return LLVMFloatTypeKind;
1131 case Type::DoubleTyID:
1132 return LLVMDoubleTypeKind;
1133 case Type::X86_FP80TyID:
1134 return LLVMX86_FP80TypeKind;
1135 case Type::FP128TyID:
1136 return LLVMFP128TypeKind;
1137 case Type::PPC_FP128TyID:
1138 return LLVMPPC_FP128TypeKind;
1139 case Type::LabelTyID:
1140 return LLVMLabelTypeKind;
1141 case Type::MetadataTyID:
1142 return LLVMMetadataTypeKind;
1143 case Type::IntegerTyID:
1144 return LLVMIntegerTypeKind;
1145 case Type::FunctionTyID:
1146 return LLVMFunctionTypeKind;
1147 case Type::StructTyID:
1148 return LLVMStructTypeKind;
1149 case Type::ArrayTyID:
1150 return LLVMArrayTypeKind;
1151 case Type::PointerTyID:
1152 return LLVMPointerTypeKind;
1153 case Type::VectorTyID:
1154 return LLVMVectorTypeKind;
1155 case Type::X86_MMXTyID:
1156 return LLVMX86_MMXTypeKind;
1157 case Type::TokenTyID:
1158 return LLVMTokenTypeKind;
1160 report_fatal_error("Unhandled TypeID.");
1163 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(SMDiagnostic, LLVMSMDiagnosticRef)
1165 extern "C" void LLVMRustSetInlineAsmDiagnosticHandler(
1166 LLVMContextRef C, LLVMContext::InlineAsmDiagHandlerTy H, void *CX) {
1167 unwrap(C)->setInlineAsmDiagnosticHandler(H, CX);
1170 extern "C" void LLVMRustWriteSMDiagnosticToString(LLVMSMDiagnosticRef D,
1171 RustStringRef Str) {
1172 RawRustStringOstream OS(Str);
1173 unwrap(D)->print("", OS);
1176 extern "C" LLVMValueRef LLVMRustBuildCleanupPad(LLVMBuilderRef B,
1177 LLVMValueRef ParentPad,
1179 LLVMValueRef *LLArgs,
1181 Value **Args = unwrap(LLArgs);
1182 if (ParentPad == nullptr) {
1183 Type *Ty = Type::getTokenTy(unwrap(B)->getContext());
1184 ParentPad = wrap(Constant::getNullValue(Ty));
1186 return wrap(unwrap(B)->CreateCleanupPad(
1187 unwrap(ParentPad), ArrayRef<Value *>(Args, ArgCount), Name));
1190 extern "C" LLVMValueRef LLVMRustBuildCleanupRet(LLVMBuilderRef B,
1191 LLVMValueRef CleanupPad,
1192 LLVMBasicBlockRef UnwindBB) {
1193 CleanupPadInst *Inst = cast<CleanupPadInst>(unwrap(CleanupPad));
1194 return wrap(unwrap(B)->CreateCleanupRet(Inst, unwrap(UnwindBB)));
1197 extern "C" LLVMValueRef
1198 LLVMRustBuildCatchPad(LLVMBuilderRef B, LLVMValueRef ParentPad,
1199 unsigned ArgCount, LLVMValueRef *LLArgs, const char *Name) {
1200 Value **Args = unwrap(LLArgs);
1201 return wrap(unwrap(B)->CreateCatchPad(
1202 unwrap(ParentPad), ArrayRef<Value *>(Args, ArgCount), Name));
1205 extern "C" LLVMValueRef LLVMRustBuildCatchRet(LLVMBuilderRef B,
1207 LLVMBasicBlockRef BB) {
1208 return wrap(unwrap(B)->CreateCatchRet(cast<CatchPadInst>(unwrap(Pad)),
1212 extern "C" LLVMValueRef LLVMRustBuildCatchSwitch(LLVMBuilderRef B,
1213 LLVMValueRef ParentPad,
1214 LLVMBasicBlockRef BB,
1215 unsigned NumHandlers,
1217 if (ParentPad == nullptr) {
1218 Type *Ty = Type::getTokenTy(unwrap(B)->getContext());
1219 ParentPad = wrap(Constant::getNullValue(Ty));
1221 return wrap(unwrap(B)->CreateCatchSwitch(unwrap(ParentPad), unwrap(BB),
1222 NumHandlers, Name));
1225 extern "C" void LLVMRustAddHandler(LLVMValueRef CatchSwitchRef,
1226 LLVMBasicBlockRef Handler) {
1227 Value *CatchSwitch = unwrap(CatchSwitchRef);
1228 cast<CatchSwitchInst>(CatchSwitch)->addHandler(unwrap(Handler));
1231 extern "C" OperandBundleDef *LLVMRustBuildOperandBundleDef(const char *Name,
1232 LLVMValueRef *Inputs,
1233 unsigned NumInputs) {
1234 return new OperandBundleDef(Name, makeArrayRef(unwrap(Inputs), NumInputs));
1237 extern "C" void LLVMRustFreeOperandBundleDef(OperandBundleDef *Bundle) {
1241 extern "C" LLVMValueRef LLVMRustBuildCall(LLVMBuilderRef B, LLVMValueRef Fn,
1242 LLVMValueRef *Args, unsigned NumArgs,
1243 OperandBundleDef *Bundle,
1245 unsigned Len = Bundle ? 1 : 0;
1246 ArrayRef<OperandBundleDef> Bundles = makeArrayRef(Bundle, Len);
1247 return wrap(unwrap(B)->CreateCall(
1248 unwrap(Fn), makeArrayRef(unwrap(Args), NumArgs), Bundles, Name));
1251 extern "C" LLVMValueRef LLVMRustBuildMemCpy(LLVMBuilderRef B,
1252 LLVMValueRef Dst, unsigned DstAlign,
1253 LLVMValueRef Src, unsigned SrcAlign,
1254 LLVMValueRef Size, bool IsVolatile) {
1255 return wrap(unwrap(B)->CreateMemCpy(
1256 unwrap(Dst), DstAlign,
1257 unwrap(Src), SrcAlign,
1258 unwrap(Size), IsVolatile));
1261 extern "C" LLVMValueRef LLVMRustBuildMemMove(LLVMBuilderRef B,
1262 LLVMValueRef Dst, unsigned DstAlign,
1263 LLVMValueRef Src, unsigned SrcAlign,
1264 LLVMValueRef Size, bool IsVolatile) {
1265 return wrap(unwrap(B)->CreateMemMove(
1266 unwrap(Dst), DstAlign,
1267 unwrap(Src), SrcAlign,
1268 unwrap(Size), IsVolatile));
1271 extern "C" LLVMValueRef
1272 LLVMRustBuildInvoke(LLVMBuilderRef B, LLVMValueRef Fn, LLVMValueRef *Args,
1273 unsigned NumArgs, LLVMBasicBlockRef Then,
1274 LLVMBasicBlockRef Catch, OperandBundleDef *Bundle,
1276 unsigned Len = Bundle ? 1 : 0;
1277 ArrayRef<OperandBundleDef> Bundles = makeArrayRef(Bundle, Len);
1278 return wrap(unwrap(B)->CreateInvoke(unwrap(Fn), unwrap(Then), unwrap(Catch),
1279 makeArrayRef(unwrap(Args), NumArgs),
1283 extern "C" void LLVMRustPositionBuilderAtStart(LLVMBuilderRef B,
1284 LLVMBasicBlockRef BB) {
1285 auto Point = unwrap(BB)->getFirstInsertionPt();
1286 unwrap(B)->SetInsertPoint(unwrap(BB), Point);
1289 extern "C" void LLVMRustSetComdat(LLVMModuleRef M, LLVMValueRef V,
1291 Triple TargetTriple(unwrap(M)->getTargetTriple());
1292 GlobalObject *GV = unwrap<GlobalObject>(V);
1293 if (!TargetTriple.isOSBinFormatMachO()) {
1294 GV->setComdat(unwrap(M)->getOrInsertComdat(Name));
1298 extern "C" void LLVMRustUnsetComdat(LLVMValueRef V) {
1299 GlobalObject *GV = unwrap<GlobalObject>(V);
1300 GV->setComdat(nullptr);
1303 enum class LLVMRustLinkage {
1304 ExternalLinkage = 0,
1305 AvailableExternallyLinkage = 1,
1306 LinkOnceAnyLinkage = 2,
1307 LinkOnceODRLinkage = 3,
1310 AppendingLinkage = 6,
1311 InternalLinkage = 7,
1313 ExternalWeakLinkage = 9,
1317 static LLVMRustLinkage toRust(LLVMLinkage Linkage) {
1319 case LLVMExternalLinkage:
1320 return LLVMRustLinkage::ExternalLinkage;
1321 case LLVMAvailableExternallyLinkage:
1322 return LLVMRustLinkage::AvailableExternallyLinkage;
1323 case LLVMLinkOnceAnyLinkage:
1324 return LLVMRustLinkage::LinkOnceAnyLinkage;
1325 case LLVMLinkOnceODRLinkage:
1326 return LLVMRustLinkage::LinkOnceODRLinkage;
1327 case LLVMWeakAnyLinkage:
1328 return LLVMRustLinkage::WeakAnyLinkage;
1329 case LLVMWeakODRLinkage:
1330 return LLVMRustLinkage::WeakODRLinkage;
1331 case LLVMAppendingLinkage:
1332 return LLVMRustLinkage::AppendingLinkage;
1333 case LLVMInternalLinkage:
1334 return LLVMRustLinkage::InternalLinkage;
1335 case LLVMPrivateLinkage:
1336 return LLVMRustLinkage::PrivateLinkage;
1337 case LLVMExternalWeakLinkage:
1338 return LLVMRustLinkage::ExternalWeakLinkage;
1339 case LLVMCommonLinkage:
1340 return LLVMRustLinkage::CommonLinkage;
1342 report_fatal_error("Invalid LLVMRustLinkage value!");
1346 static LLVMLinkage fromRust(LLVMRustLinkage Linkage) {
1348 case LLVMRustLinkage::ExternalLinkage:
1349 return LLVMExternalLinkage;
1350 case LLVMRustLinkage::AvailableExternallyLinkage:
1351 return LLVMAvailableExternallyLinkage;
1352 case LLVMRustLinkage::LinkOnceAnyLinkage:
1353 return LLVMLinkOnceAnyLinkage;
1354 case LLVMRustLinkage::LinkOnceODRLinkage:
1355 return LLVMLinkOnceODRLinkage;
1356 case LLVMRustLinkage::WeakAnyLinkage:
1357 return LLVMWeakAnyLinkage;
1358 case LLVMRustLinkage::WeakODRLinkage:
1359 return LLVMWeakODRLinkage;
1360 case LLVMRustLinkage::AppendingLinkage:
1361 return LLVMAppendingLinkage;
1362 case LLVMRustLinkage::InternalLinkage:
1363 return LLVMInternalLinkage;
1364 case LLVMRustLinkage::PrivateLinkage:
1365 return LLVMPrivateLinkage;
1366 case LLVMRustLinkage::ExternalWeakLinkage:
1367 return LLVMExternalWeakLinkage;
1368 case LLVMRustLinkage::CommonLinkage:
1369 return LLVMCommonLinkage;
1371 report_fatal_error("Invalid LLVMRustLinkage value!");
1374 extern "C" LLVMRustLinkage LLVMRustGetLinkage(LLVMValueRef V) {
1375 return toRust(LLVMGetLinkage(V));
1378 extern "C" void LLVMRustSetLinkage(LLVMValueRef V,
1379 LLVMRustLinkage RustLinkage) {
1380 LLVMSetLinkage(V, fromRust(RustLinkage));
1383 // Returns true if both high and low were successfully set. Fails in case constant wasn’t any of
1384 // the common sizes (1, 8, 16, 32, 64, 128 bits)
1385 extern "C" bool LLVMRustConstInt128Get(LLVMValueRef CV, bool sext, uint64_t *high, uint64_t *low)
1387 auto C = unwrap<llvm::ConstantInt>(CV);
1388 if (C->getBitWidth() > 128) { return false; }
1391 AP = C->getValue().sextOrSelf(128);
1393 AP = C->getValue().zextOrSelf(128);
1395 *low = AP.getLoBits(64).getZExtValue();
1396 *high = AP.getHiBits(64).getZExtValue();
1400 enum class LLVMRustVisibility {
1406 static LLVMRustVisibility toRust(LLVMVisibility Vis) {
1408 case LLVMDefaultVisibility:
1409 return LLVMRustVisibility::Default;
1410 case LLVMHiddenVisibility:
1411 return LLVMRustVisibility::Hidden;
1412 case LLVMProtectedVisibility:
1413 return LLVMRustVisibility::Protected;
1415 report_fatal_error("Invalid LLVMRustVisibility value!");
1418 static LLVMVisibility fromRust(LLVMRustVisibility Vis) {
1420 case LLVMRustVisibility::Default:
1421 return LLVMDefaultVisibility;
1422 case LLVMRustVisibility::Hidden:
1423 return LLVMHiddenVisibility;
1424 case LLVMRustVisibility::Protected:
1425 return LLVMProtectedVisibility;
1427 report_fatal_error("Invalid LLVMRustVisibility value!");
1430 extern "C" LLVMRustVisibility LLVMRustGetVisibility(LLVMValueRef V) {
1431 return toRust(LLVMGetVisibility(V));
1434 // Oh hey, a binding that makes sense for once? (because LLVM’s own do not)
1435 extern "C" LLVMValueRef LLVMRustBuildIntCast(LLVMBuilderRef B, LLVMValueRef Val,
1436 LLVMTypeRef DestTy, bool isSigned) {
1437 return wrap(unwrap(B)->CreateIntCast(unwrap(Val), unwrap(DestTy), isSigned, ""));
1440 extern "C" void LLVMRustSetVisibility(LLVMValueRef V,
1441 LLVMRustVisibility RustVisibility) {
1442 LLVMSetVisibility(V, fromRust(RustVisibility));
1445 struct LLVMRustModuleBuffer {
1449 extern "C" LLVMRustModuleBuffer*
1450 LLVMRustModuleBufferCreate(LLVMModuleRef M) {
1451 auto Ret = llvm::make_unique<LLVMRustModuleBuffer>();
1453 raw_string_ostream OS(Ret->data);
1455 legacy::PassManager PM;
1456 PM.add(createBitcodeWriterPass(OS));
1460 return Ret.release();
1464 LLVMRustModuleBufferFree(LLVMRustModuleBuffer *Buffer) {
1468 extern "C" const void*
1469 LLVMRustModuleBufferPtr(const LLVMRustModuleBuffer *Buffer) {
1470 return Buffer->data.data();
1474 LLVMRustModuleBufferLen(const LLVMRustModuleBuffer *Buffer) {
1475 return Buffer->data.length();
1479 LLVMRustModuleCost(LLVMModuleRef M) {
1480 auto f = unwrap(M)->functions();
1481 return std::distance(std::begin(f), std::end(f));
1484 // Vector reductions:
1485 extern "C" LLVMValueRef
1486 LLVMRustBuildVectorReduceFAdd(LLVMBuilderRef B, LLVMValueRef Acc, LLVMValueRef Src) {
1487 return wrap(unwrap(B)->CreateFAddReduce(unwrap(Acc),unwrap(Src)));
1489 extern "C" LLVMValueRef
1490 LLVMRustBuildVectorReduceFMul(LLVMBuilderRef B, LLVMValueRef Acc, LLVMValueRef Src) {
1491 return wrap(unwrap(B)->CreateFMulReduce(unwrap(Acc),unwrap(Src)));
1493 extern "C" LLVMValueRef
1494 LLVMRustBuildVectorReduceAdd(LLVMBuilderRef B, LLVMValueRef Src) {
1495 return wrap(unwrap(B)->CreateAddReduce(unwrap(Src)));
1497 extern "C" LLVMValueRef
1498 LLVMRustBuildVectorReduceMul(LLVMBuilderRef B, LLVMValueRef Src) {
1499 return wrap(unwrap(B)->CreateMulReduce(unwrap(Src)));
1501 extern "C" LLVMValueRef
1502 LLVMRustBuildVectorReduceAnd(LLVMBuilderRef B, LLVMValueRef Src) {
1503 return wrap(unwrap(B)->CreateAndReduce(unwrap(Src)));
1505 extern "C" LLVMValueRef
1506 LLVMRustBuildVectorReduceOr(LLVMBuilderRef B, LLVMValueRef Src) {
1507 return wrap(unwrap(B)->CreateOrReduce(unwrap(Src)));
1509 extern "C" LLVMValueRef
1510 LLVMRustBuildVectorReduceXor(LLVMBuilderRef B, LLVMValueRef Src) {
1511 return wrap(unwrap(B)->CreateXorReduce(unwrap(Src)));
1513 extern "C" LLVMValueRef
1514 LLVMRustBuildVectorReduceMin(LLVMBuilderRef B, LLVMValueRef Src, bool IsSigned) {
1515 return wrap(unwrap(B)->CreateIntMinReduce(unwrap(Src), IsSigned));
1517 extern "C" LLVMValueRef
1518 LLVMRustBuildVectorReduceMax(LLVMBuilderRef B, LLVMValueRef Src, bool IsSigned) {
1519 return wrap(unwrap(B)->CreateIntMaxReduce(unwrap(Src), IsSigned));
1521 extern "C" LLVMValueRef
1522 LLVMRustBuildVectorReduceFMin(LLVMBuilderRef B, LLVMValueRef Src, bool NoNaN) {
1523 return wrap(unwrap(B)->CreateFPMinReduce(unwrap(Src), NoNaN));
1525 extern "C" LLVMValueRef
1526 LLVMRustBuildVectorReduceFMax(LLVMBuilderRef B, LLVMValueRef Src, bool NoNaN) {
1527 return wrap(unwrap(B)->CreateFPMaxReduce(unwrap(Src), NoNaN));
1530 extern "C" LLVMValueRef
1531 LLVMRustBuildMinNum(LLVMBuilderRef B, LLVMValueRef LHS, LLVMValueRef RHS) {
1532 return wrap(unwrap(B)->CreateMinNum(unwrap(LHS),unwrap(RHS)));
1534 extern "C" LLVMValueRef
1535 LLVMRustBuildMaxNum(LLVMBuilderRef B, LLVMValueRef LHS, LLVMValueRef RHS) {
1536 return wrap(unwrap(B)->CreateMaxNum(unwrap(LHS),unwrap(RHS)));