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, size_t NameLen, LLVMTypeRef Ty) {
133 StringRef NameRef(Name, NameLen);
134 return wrap(unwrap(M)->getOrInsertGlobal(NameRef, unwrap(Ty)));
137 extern "C" LLVMValueRef
138 LLVMRustInsertPrivateGlobal(LLVMModuleRef M, LLVMTypeRef Ty) {
139 return wrap(new GlobalVariable(*unwrap(M),
142 GlobalValue::PrivateLinkage,
146 extern "C" LLVMTypeRef LLVMRustMetadataTypeInContext(LLVMContextRef C) {
147 return wrap(Type::getMetadataTy(*unwrap(C)));
150 static Attribute::AttrKind fromRust(LLVMRustAttribute Kind) {
153 return Attribute::AlwaysInline;
155 return Attribute::ByVal;
157 return Attribute::Cold;
159 return Attribute::InlineHint;
161 return Attribute::MinSize;
163 return Attribute::Naked;
165 return Attribute::NoAlias;
167 return Attribute::NoCapture;
169 return Attribute::NoInline;
171 return Attribute::NonNull;
173 return Attribute::NoRedZone;
175 return Attribute::NoReturn;
177 return Attribute::NoUnwind;
178 case OptimizeForSize:
179 return Attribute::OptimizeForSize;
181 return Attribute::ReadOnly;
183 return Attribute::SExt;
185 return Attribute::StructRet;
187 return Attribute::UWTable;
189 return Attribute::ZExt;
191 return Attribute::InReg;
193 return Attribute::SanitizeThread;
194 case SanitizeAddress:
195 return Attribute::SanitizeAddress;
197 return Attribute::SanitizeMemory;
199 return Attribute::NonLazyBind;
201 return Attribute::OptimizeNone;
203 return Attribute::ReturnsTwice;
205 report_fatal_error("bad AttributeKind");
208 extern "C" void LLVMRustAddCallSiteAttribute(LLVMValueRef Instr, unsigned Index,
209 LLVMRustAttribute RustAttr) {
210 CallSite Call = CallSite(unwrap<Instruction>(Instr));
211 Attribute Attr = Attribute::get(Call->getContext(), fromRust(RustAttr));
212 Call.addAttribute(Index, Attr);
215 extern "C" void LLVMRustAddAlignmentCallSiteAttr(LLVMValueRef Instr,
218 CallSite Call = CallSite(unwrap<Instruction>(Instr));
220 B.addAlignmentAttr(Bytes);
221 Call.setAttributes(Call.getAttributes().addAttributes(
222 Call->getContext(), Index, B));
225 extern "C" void LLVMRustAddDereferenceableCallSiteAttr(LLVMValueRef Instr,
228 CallSite Call = CallSite(unwrap<Instruction>(Instr));
230 B.addDereferenceableAttr(Bytes);
231 Call.setAttributes(Call.getAttributes().addAttributes(
232 Call->getContext(), Index, B));
235 extern "C" void LLVMRustAddDereferenceableOrNullCallSiteAttr(LLVMValueRef Instr,
238 CallSite Call = CallSite(unwrap<Instruction>(Instr));
240 B.addDereferenceableOrNullAttr(Bytes);
241 Call.setAttributes(Call.getAttributes().addAttributes(
242 Call->getContext(), Index, B));
245 extern "C" void LLVMRustAddByValCallSiteAttr(LLVMValueRef Instr, unsigned Index,
247 CallSite Call = CallSite(unwrap<Instruction>(Instr));
248 #if LLVM_VERSION_GE(9, 0)
249 Attribute Attr = Attribute::getWithByValType(Call->getContext(), unwrap(Ty));
251 Attribute Attr = Attribute::get(Call->getContext(), Attribute::ByVal);
253 Call.addAttribute(Index, Attr);
256 extern "C" void LLVMRustAddFunctionAttribute(LLVMValueRef Fn, unsigned Index,
257 LLVMRustAttribute RustAttr) {
258 Function *A = unwrap<Function>(Fn);
259 Attribute Attr = Attribute::get(A->getContext(), fromRust(RustAttr));
261 A->addAttributes(Index, B);
264 extern "C" void LLVMRustAddAlignmentAttr(LLVMValueRef Fn,
267 Function *A = unwrap<Function>(Fn);
269 B.addAlignmentAttr(Bytes);
270 A->addAttributes(Index, B);
273 extern "C" void LLVMRustAddDereferenceableAttr(LLVMValueRef Fn, unsigned Index,
275 Function *A = unwrap<Function>(Fn);
277 B.addDereferenceableAttr(Bytes);
278 A->addAttributes(Index, B);
281 extern "C" void LLVMRustAddDereferenceableOrNullAttr(LLVMValueRef Fn,
284 Function *A = unwrap<Function>(Fn);
286 B.addDereferenceableOrNullAttr(Bytes);
287 A->addAttributes(Index, B);
290 extern "C" void LLVMRustAddByValAttr(LLVMValueRef Fn, unsigned Index,
292 Function *F = unwrap<Function>(Fn);
293 #if LLVM_VERSION_GE(9, 0)
294 Attribute Attr = Attribute::getWithByValType(F->getContext(), unwrap(Ty));
296 Attribute Attr = Attribute::get(F->getContext(), Attribute::ByVal);
298 F->addAttribute(Index, Attr);
301 extern "C" void LLVMRustAddFunctionAttrStringValue(LLVMValueRef Fn,
305 Function *F = unwrap<Function>(Fn);
307 B.addAttribute(Name, Value);
308 F->addAttributes(Index, B);
311 extern "C" void LLVMRustRemoveFunctionAttributes(LLVMValueRef Fn,
313 LLVMRustAttribute RustAttr) {
314 Function *F = unwrap<Function>(Fn);
315 Attribute Attr = Attribute::get(F->getContext(), fromRust(RustAttr));
317 auto PAL = F->getAttributes();
318 auto PALNew = PAL.removeAttributes(F->getContext(), Index, B);
319 F->setAttributes(PALNew);
322 // enable fpmath flag UnsafeAlgebra
323 extern "C" void LLVMRustSetHasUnsafeAlgebra(LLVMValueRef V) {
324 if (auto I = dyn_cast<Instruction>(unwrap<Value>(V))) {
329 extern "C" LLVMValueRef
330 LLVMRustBuildAtomicLoad(LLVMBuilderRef B, LLVMValueRef Source, const char *Name,
331 LLVMAtomicOrdering Order) {
332 LoadInst *LI = new LoadInst(unwrap(Source));
333 LI->setAtomic(fromRust(Order));
334 return wrap(unwrap(B)->Insert(LI, Name));
337 extern "C" LLVMValueRef LLVMRustBuildAtomicStore(LLVMBuilderRef B,
340 LLVMAtomicOrdering Order) {
341 StoreInst *SI = new StoreInst(unwrap(V), unwrap(Target));
342 SI->setAtomic(fromRust(Order));
343 return wrap(unwrap(B)->Insert(SI));
346 extern "C" LLVMValueRef
347 LLVMRustBuildAtomicCmpXchg(LLVMBuilderRef B, LLVMValueRef Target,
348 LLVMValueRef Old, LLVMValueRef Source,
349 LLVMAtomicOrdering Order,
350 LLVMAtomicOrdering FailureOrder, LLVMBool Weak) {
351 AtomicCmpXchgInst *ACXI = unwrap(B)->CreateAtomicCmpXchg(
352 unwrap(Target), unwrap(Old), unwrap(Source), fromRust(Order),
353 fromRust(FailureOrder));
358 enum class LLVMRustSynchronizationScope {
364 static SyncScope::ID fromRust(LLVMRustSynchronizationScope Scope) {
366 case LLVMRustSynchronizationScope::SingleThread:
367 return SyncScope::SingleThread;
368 case LLVMRustSynchronizationScope::CrossThread:
369 return SyncScope::System;
371 report_fatal_error("bad SynchronizationScope.");
375 extern "C" LLVMValueRef
376 LLVMRustBuildAtomicFence(LLVMBuilderRef B, LLVMAtomicOrdering Order,
377 LLVMRustSynchronizationScope Scope) {
378 return wrap(unwrap(B)->CreateFence(fromRust(Order), fromRust(Scope)));
381 enum class LLVMRustAsmDialect {
387 static InlineAsm::AsmDialect fromRust(LLVMRustAsmDialect Dialect) {
389 case LLVMRustAsmDialect::Att:
390 return InlineAsm::AD_ATT;
391 case LLVMRustAsmDialect::Intel:
392 return InlineAsm::AD_Intel;
394 report_fatal_error("bad AsmDialect.");
398 extern "C" LLVMValueRef LLVMRustInlineAsm(LLVMTypeRef Ty, char *AsmString,
400 LLVMBool HasSideEffects,
401 LLVMBool IsAlignStack,
402 LLVMRustAsmDialect Dialect) {
403 return wrap(InlineAsm::get(unwrap<FunctionType>(Ty), AsmString, Constraints,
404 HasSideEffects, IsAlignStack, fromRust(Dialect)));
407 extern "C" bool LLVMRustInlineAsmVerify(LLVMTypeRef Ty,
409 return InlineAsm::Verify(unwrap<FunctionType>(Ty), Constraints);
412 extern "C" void LLVMRustAppendModuleInlineAsm(LLVMModuleRef M, const char *Asm) {
413 unwrap(M)->appendModuleInlineAsm(StringRef(Asm));
416 typedef DIBuilder *LLVMRustDIBuilderRef;
418 template <typename DIT> DIT *unwrapDIPtr(LLVMMetadataRef Ref) {
419 return (DIT *)(Ref ? unwrap<MDNode>(Ref) : nullptr);
422 #define DIDescriptor DIScope
423 #define DIArray DINodeArray
424 #define unwrapDI unwrapDIPtr
426 // These values **must** match debuginfo::DIFlags! They also *happen*
427 // to match LLVM, but that isn't required as we do giant sets of
428 // matching below. The value shouldn't be directly passed to LLVM.
429 enum class LLVMRustDIFlags : uint32_t {
434 FlagFwdDecl = (1 << 2),
435 FlagAppleBlock = (1 << 3),
436 FlagBlockByrefStruct = (1 << 4),
437 FlagVirtual = (1 << 5),
438 FlagArtificial = (1 << 6),
439 FlagExplicit = (1 << 7),
440 FlagPrototyped = (1 << 8),
441 FlagObjcClassComplete = (1 << 9),
442 FlagObjectPointer = (1 << 10),
443 FlagVector = (1 << 11),
444 FlagStaticMember = (1 << 12),
445 FlagLValueReference = (1 << 13),
446 FlagRValueReference = (1 << 14),
447 FlagExternalTypeRef = (1 << 15),
448 FlagIntroducedVirtual = (1 << 18),
449 FlagBitField = (1 << 19),
450 FlagNoReturn = (1 << 20),
451 // Do not add values that are not supported by the minimum LLVM
452 // version we support! see llvm/include/llvm/IR/DebugInfoFlags.def
455 inline LLVMRustDIFlags operator&(LLVMRustDIFlags A, LLVMRustDIFlags B) {
456 return static_cast<LLVMRustDIFlags>(static_cast<uint32_t>(A) &
457 static_cast<uint32_t>(B));
460 inline LLVMRustDIFlags operator|(LLVMRustDIFlags A, LLVMRustDIFlags B) {
461 return static_cast<LLVMRustDIFlags>(static_cast<uint32_t>(A) |
462 static_cast<uint32_t>(B));
465 inline LLVMRustDIFlags &operator|=(LLVMRustDIFlags &A, LLVMRustDIFlags B) {
469 inline bool isSet(LLVMRustDIFlags F) { return F != LLVMRustDIFlags::FlagZero; }
471 inline LLVMRustDIFlags visibility(LLVMRustDIFlags F) {
472 return static_cast<LLVMRustDIFlags>(static_cast<uint32_t>(F) & 0x3);
475 static DINode::DIFlags fromRust(LLVMRustDIFlags Flags) {
476 DINode::DIFlags Result = DINode::DIFlags::FlagZero;
478 switch (visibility(Flags)) {
479 case LLVMRustDIFlags::FlagPrivate:
480 Result |= DINode::DIFlags::FlagPrivate;
482 case LLVMRustDIFlags::FlagProtected:
483 Result |= DINode::DIFlags::FlagProtected;
485 case LLVMRustDIFlags::FlagPublic:
486 Result |= DINode::DIFlags::FlagPublic;
489 // The rest are handled below
493 if (isSet(Flags & LLVMRustDIFlags::FlagFwdDecl)) {
494 Result |= DINode::DIFlags::FlagFwdDecl;
496 if (isSet(Flags & LLVMRustDIFlags::FlagAppleBlock)) {
497 Result |= DINode::DIFlags::FlagAppleBlock;
499 if (isSet(Flags & LLVMRustDIFlags::FlagBlockByrefStruct)) {
500 Result |= DINode::DIFlags::FlagBlockByrefStruct;
502 if (isSet(Flags & LLVMRustDIFlags::FlagVirtual)) {
503 Result |= DINode::DIFlags::FlagVirtual;
505 if (isSet(Flags & LLVMRustDIFlags::FlagArtificial)) {
506 Result |= DINode::DIFlags::FlagArtificial;
508 if (isSet(Flags & LLVMRustDIFlags::FlagExplicit)) {
509 Result |= DINode::DIFlags::FlagExplicit;
511 if (isSet(Flags & LLVMRustDIFlags::FlagPrototyped)) {
512 Result |= DINode::DIFlags::FlagPrototyped;
514 if (isSet(Flags & LLVMRustDIFlags::FlagObjcClassComplete)) {
515 Result |= DINode::DIFlags::FlagObjcClassComplete;
517 if (isSet(Flags & LLVMRustDIFlags::FlagObjectPointer)) {
518 Result |= DINode::DIFlags::FlagObjectPointer;
520 if (isSet(Flags & LLVMRustDIFlags::FlagVector)) {
521 Result |= DINode::DIFlags::FlagVector;
523 if (isSet(Flags & LLVMRustDIFlags::FlagStaticMember)) {
524 Result |= DINode::DIFlags::FlagStaticMember;
526 if (isSet(Flags & LLVMRustDIFlags::FlagLValueReference)) {
527 Result |= DINode::DIFlags::FlagLValueReference;
529 if (isSet(Flags & LLVMRustDIFlags::FlagRValueReference)) {
530 Result |= DINode::DIFlags::FlagRValueReference;
532 if (isSet(Flags & LLVMRustDIFlags::FlagIntroducedVirtual)) {
533 Result |= DINode::DIFlags::FlagIntroducedVirtual;
535 if (isSet(Flags & LLVMRustDIFlags::FlagBitField)) {
536 Result |= DINode::DIFlags::FlagBitField;
538 if (isSet(Flags & LLVMRustDIFlags::FlagNoReturn)) {
539 Result |= DINode::DIFlags::FlagNoReturn;
545 // These values **must** match debuginfo::DISPFlags! They also *happen*
546 // to match LLVM, but that isn't required as we do giant sets of
547 // matching below. The value shouldn't be directly passed to LLVM.
548 enum class LLVMRustDISPFlags : uint32_t {
551 SPFlagPureVirtual = 2,
552 SPFlagLocalToUnit = (1 << 2),
553 SPFlagDefinition = (1 << 3),
554 SPFlagOptimized = (1 << 4),
555 SPFlagMainSubprogram = (1 << 5),
556 // Do not add values that are not supported by the minimum LLVM
557 // version we support! see llvm/include/llvm/IR/DebugInfoFlags.def
558 // (In LLVM < 8, createFunction supported these as separate bool arguments.)
561 inline LLVMRustDISPFlags operator&(LLVMRustDISPFlags A, LLVMRustDISPFlags B) {
562 return static_cast<LLVMRustDISPFlags>(static_cast<uint32_t>(A) &
563 static_cast<uint32_t>(B));
566 inline LLVMRustDISPFlags operator|(LLVMRustDISPFlags A, LLVMRustDISPFlags B) {
567 return static_cast<LLVMRustDISPFlags>(static_cast<uint32_t>(A) |
568 static_cast<uint32_t>(B));
571 inline LLVMRustDISPFlags &operator|=(LLVMRustDISPFlags &A, LLVMRustDISPFlags B) {
575 inline bool isSet(LLVMRustDISPFlags F) { return F != LLVMRustDISPFlags::SPFlagZero; }
577 inline LLVMRustDISPFlags virtuality(LLVMRustDISPFlags F) {
578 return static_cast<LLVMRustDISPFlags>(static_cast<uint32_t>(F) & 0x3);
581 #if LLVM_VERSION_GE(8, 0)
582 static DISubprogram::DISPFlags fromRust(LLVMRustDISPFlags SPFlags) {
583 DISubprogram::DISPFlags Result = DISubprogram::DISPFlags::SPFlagZero;
585 switch (virtuality(SPFlags)) {
586 case LLVMRustDISPFlags::SPFlagVirtual:
587 Result |= DISubprogram::DISPFlags::SPFlagVirtual;
589 case LLVMRustDISPFlags::SPFlagPureVirtual:
590 Result |= DISubprogram::DISPFlags::SPFlagPureVirtual;
593 // The rest are handled below
597 if (isSet(SPFlags & LLVMRustDISPFlags::SPFlagLocalToUnit)) {
598 Result |= DISubprogram::DISPFlags::SPFlagLocalToUnit;
600 if (isSet(SPFlags & LLVMRustDISPFlags::SPFlagDefinition)) {
601 Result |= DISubprogram::DISPFlags::SPFlagDefinition;
603 if (isSet(SPFlags & LLVMRustDISPFlags::SPFlagOptimized)) {
604 Result |= DISubprogram::DISPFlags::SPFlagOptimized;
606 #if LLVM_VERSION_GE(9, 0)
607 if (isSet(SPFlags & LLVMRustDISPFlags::SPFlagMainSubprogram)) {
608 Result |= DISubprogram::DISPFlags::SPFlagMainSubprogram;
616 enum class LLVMRustDebugEmissionKind {
622 static DICompileUnit::DebugEmissionKind fromRust(LLVMRustDebugEmissionKind Kind) {
624 case LLVMRustDebugEmissionKind::NoDebug:
625 return DICompileUnit::DebugEmissionKind::NoDebug;
626 case LLVMRustDebugEmissionKind::FullDebug:
627 return DICompileUnit::DebugEmissionKind::FullDebug;
628 case LLVMRustDebugEmissionKind::LineTablesOnly:
629 return DICompileUnit::DebugEmissionKind::LineTablesOnly;
631 report_fatal_error("bad DebugEmissionKind.");
635 extern "C" uint32_t LLVMRustDebugMetadataVersion() {
636 return DEBUG_METADATA_VERSION;
639 extern "C" uint32_t LLVMRustVersionMinor() { return LLVM_VERSION_MINOR; }
641 extern "C" uint32_t LLVMRustVersionMajor() { return LLVM_VERSION_MAJOR; }
643 extern "C" void LLVMRustAddModuleFlag(LLVMModuleRef M, const char *Name,
645 unwrap(M)->addModuleFlag(Module::Warning, Name, Value);
648 extern "C" LLVMValueRef LLVMRustMetadataAsValue(LLVMContextRef C, LLVMMetadataRef MD) {
649 return wrap(MetadataAsValue::get(*unwrap(C), unwrap(MD)));
652 extern "C" LLVMRustDIBuilderRef LLVMRustDIBuilderCreate(LLVMModuleRef M) {
653 return new DIBuilder(*unwrap(M));
656 extern "C" void LLVMRustDIBuilderDispose(LLVMRustDIBuilderRef Builder) {
660 extern "C" void LLVMRustDIBuilderFinalize(LLVMRustDIBuilderRef Builder) {
664 extern "C" LLVMMetadataRef LLVMRustDIBuilderCreateCompileUnit(
665 LLVMRustDIBuilderRef Builder, unsigned Lang, LLVMMetadataRef FileRef,
666 const char *Producer, bool isOptimized, const char *Flags,
667 unsigned RuntimeVer, const char *SplitName,
668 LLVMRustDebugEmissionKind Kind) {
669 auto *File = unwrapDI<DIFile>(FileRef);
671 return wrap(Builder->createCompileUnit(Lang, File, Producer, isOptimized,
672 Flags, RuntimeVer, SplitName,
676 extern "C" LLVMMetadataRef
677 LLVMRustDIBuilderCreateFile(LLVMRustDIBuilderRef Builder, const char *Filename,
678 const char *Directory) {
679 return wrap(Builder->createFile(Filename, Directory));
682 extern "C" LLVMMetadataRef
683 LLVMRustDIBuilderCreateSubroutineType(LLVMRustDIBuilderRef Builder,
684 LLVMMetadataRef File,
685 LLVMMetadataRef ParameterTypes) {
686 return wrap(Builder->createSubroutineType(
687 DITypeRefArray(unwrap<MDTuple>(ParameterTypes))));
690 extern "C" LLVMMetadataRef LLVMRustDIBuilderCreateFunction(
691 LLVMRustDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
692 const char *LinkageName, LLVMMetadataRef File, unsigned LineNo,
693 LLVMMetadataRef Ty, unsigned ScopeLine, LLVMRustDIFlags Flags,
694 LLVMRustDISPFlags SPFlags, LLVMValueRef Fn, LLVMMetadataRef TParam,
695 LLVMMetadataRef Decl) {
696 DITemplateParameterArray TParams =
697 DITemplateParameterArray(unwrap<MDTuple>(TParam));
698 #if LLVM_VERSION_GE(8, 0)
699 DISubprogram::DISPFlags llvmSPFlags = fromRust(SPFlags);
700 DINode::DIFlags llvmFlags = fromRust(Flags);
701 #if LLVM_VERSION_LT(9, 0)
702 if (isSet(SPFlags & LLVMRustDISPFlags::SPFlagMainSubprogram))
703 llvmFlags |= DINode::DIFlags::FlagMainSubprogram;
705 DISubprogram *Sub = Builder->createFunction(
706 unwrapDI<DIScope>(Scope), Name, LinkageName, unwrapDI<DIFile>(File),
707 LineNo, unwrapDI<DISubroutineType>(Ty), ScopeLine, llvmFlags,
708 llvmSPFlags, TParams, unwrapDIPtr<DISubprogram>(Decl));
710 bool IsLocalToUnit = isSet(SPFlags & LLVMRustDISPFlags::SPFlagLocalToUnit);
711 bool IsDefinition = isSet(SPFlags & LLVMRustDISPFlags::SPFlagDefinition);
712 bool IsOptimized = isSet(SPFlags & LLVMRustDISPFlags::SPFlagOptimized);
713 DINode::DIFlags llvmFlags = fromRust(Flags);
714 if (isSet(SPFlags & LLVMRustDISPFlags::SPFlagMainSubprogram))
715 llvmFlags |= DINode::DIFlags::FlagMainSubprogram;
716 DISubprogram *Sub = Builder->createFunction(
717 unwrapDI<DIScope>(Scope), Name, LinkageName, unwrapDI<DIFile>(File),
718 LineNo, unwrapDI<DISubroutineType>(Ty), IsLocalToUnit, IsDefinition,
719 ScopeLine, llvmFlags, IsOptimized, TParams,
720 unwrapDIPtr<DISubprogram>(Decl));
722 unwrap<Function>(Fn)->setSubprogram(Sub);
726 extern "C" LLVMMetadataRef
727 LLVMRustDIBuilderCreateBasicType(LLVMRustDIBuilderRef Builder, const char *Name,
728 uint64_t SizeInBits, uint32_t AlignInBits,
730 return wrap(Builder->createBasicType(Name, SizeInBits, Encoding));
733 extern "C" LLVMMetadataRef LLVMRustDIBuilderCreatePointerType(
734 LLVMRustDIBuilderRef Builder, LLVMMetadataRef PointeeTy,
735 uint64_t SizeInBits, uint32_t AlignInBits, const char *Name) {
736 return wrap(Builder->createPointerType(unwrapDI<DIType>(PointeeTy),
737 SizeInBits, AlignInBits,
738 /* DWARFAddressSpace */ None,
742 extern "C" LLVMMetadataRef LLVMRustDIBuilderCreateStructType(
743 LLVMRustDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
744 LLVMMetadataRef File, unsigned LineNumber, uint64_t SizeInBits,
745 uint32_t AlignInBits, LLVMRustDIFlags Flags,
746 LLVMMetadataRef DerivedFrom, LLVMMetadataRef Elements,
747 unsigned RunTimeLang, LLVMMetadataRef VTableHolder,
748 const char *UniqueId) {
749 return wrap(Builder->createStructType(
750 unwrapDI<DIDescriptor>(Scope), Name, unwrapDI<DIFile>(File), LineNumber,
751 SizeInBits, AlignInBits, fromRust(Flags), unwrapDI<DIType>(DerivedFrom),
752 DINodeArray(unwrapDI<MDTuple>(Elements)), RunTimeLang,
753 unwrapDI<DIType>(VTableHolder), UniqueId));
756 extern "C" LLVMMetadataRef LLVMRustDIBuilderCreateVariantPart(
757 LLVMRustDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
758 LLVMMetadataRef File, unsigned LineNumber, uint64_t SizeInBits,
759 uint32_t AlignInBits, LLVMRustDIFlags Flags, LLVMMetadataRef Discriminator,
760 LLVMMetadataRef Elements, const char *UniqueId) {
761 return wrap(Builder->createVariantPart(
762 unwrapDI<DIDescriptor>(Scope), Name, unwrapDI<DIFile>(File), LineNumber,
763 SizeInBits, AlignInBits, fromRust(Flags), unwrapDI<DIDerivedType>(Discriminator),
764 DINodeArray(unwrapDI<MDTuple>(Elements)), UniqueId));
767 extern "C" LLVMMetadataRef LLVMRustDIBuilderCreateMemberType(
768 LLVMRustDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
769 LLVMMetadataRef File, unsigned LineNo, uint64_t SizeInBits,
770 uint32_t AlignInBits, uint64_t OffsetInBits, LLVMRustDIFlags Flags,
771 LLVMMetadataRef Ty) {
772 return wrap(Builder->createMemberType(unwrapDI<DIDescriptor>(Scope), Name,
773 unwrapDI<DIFile>(File), LineNo,
774 SizeInBits, AlignInBits, OffsetInBits,
775 fromRust(Flags), unwrapDI<DIType>(Ty)));
778 extern "C" LLVMMetadataRef LLVMRustDIBuilderCreateVariantMemberType(
779 LLVMRustDIBuilderRef Builder, LLVMMetadataRef Scope,
780 const char *Name, LLVMMetadataRef File, unsigned LineNo, uint64_t SizeInBits,
781 uint32_t AlignInBits, uint64_t OffsetInBits, LLVMValueRef Discriminant,
782 LLVMRustDIFlags Flags, LLVMMetadataRef Ty) {
783 llvm::ConstantInt* D = nullptr;
785 D = unwrap<llvm::ConstantInt>(Discriminant);
787 return wrap(Builder->createVariantMemberType(unwrapDI<DIDescriptor>(Scope), Name,
788 unwrapDI<DIFile>(File), LineNo,
789 SizeInBits, AlignInBits, OffsetInBits, D,
790 fromRust(Flags), unwrapDI<DIType>(Ty)));
793 extern "C" LLVMMetadataRef LLVMRustDIBuilderCreateLexicalBlock(
794 LLVMRustDIBuilderRef Builder, LLVMMetadataRef Scope,
795 LLVMMetadataRef File, unsigned Line, unsigned Col) {
796 return wrap(Builder->createLexicalBlock(unwrapDI<DIDescriptor>(Scope),
797 unwrapDI<DIFile>(File), Line, Col));
800 extern "C" LLVMMetadataRef
801 LLVMRustDIBuilderCreateLexicalBlockFile(LLVMRustDIBuilderRef Builder,
802 LLVMMetadataRef Scope,
803 LLVMMetadataRef File) {
804 return wrap(Builder->createLexicalBlockFile(unwrapDI<DIDescriptor>(Scope),
805 unwrapDI<DIFile>(File)));
808 extern "C" LLVMMetadataRef LLVMRustDIBuilderCreateStaticVariable(
809 LLVMRustDIBuilderRef Builder, LLVMMetadataRef Context, const char *Name,
810 const char *LinkageName, LLVMMetadataRef File, unsigned LineNo,
811 LLVMMetadataRef Ty, bool IsLocalToUnit, LLVMValueRef V,
812 LLVMMetadataRef Decl = nullptr, uint32_t AlignInBits = 0) {
813 llvm::GlobalVariable *InitVal = cast<llvm::GlobalVariable>(unwrap(V));
815 llvm::DIExpression *InitExpr = nullptr;
816 if (llvm::ConstantInt *IntVal = llvm::dyn_cast<llvm::ConstantInt>(InitVal)) {
817 InitExpr = Builder->createConstantValueExpression(
818 IntVal->getValue().getSExtValue());
819 } else if (llvm::ConstantFP *FPVal =
820 llvm::dyn_cast<llvm::ConstantFP>(InitVal)) {
821 InitExpr = Builder->createConstantValueExpression(
822 FPVal->getValueAPF().bitcastToAPInt().getZExtValue());
825 llvm::DIGlobalVariableExpression *VarExpr = Builder->createGlobalVariableExpression(
826 unwrapDI<DIDescriptor>(Context), Name, LinkageName,
827 unwrapDI<DIFile>(File), LineNo, unwrapDI<DIType>(Ty), IsLocalToUnit,
828 InitExpr, unwrapDIPtr<MDNode>(Decl),
829 #if LLVM_VERSION_GE(8, 0)
830 /* templateParams */ nullptr,
834 InitVal->setMetadata("dbg", VarExpr);
836 return wrap(VarExpr);
839 extern "C" LLVMMetadataRef LLVMRustDIBuilderCreateVariable(
840 LLVMRustDIBuilderRef Builder, unsigned Tag, LLVMMetadataRef Scope,
841 const char *Name, LLVMMetadataRef File, unsigned LineNo,
842 LLVMMetadataRef Ty, bool AlwaysPreserve, LLVMRustDIFlags Flags,
843 unsigned ArgNo, uint32_t AlignInBits) {
844 if (Tag == 0x100) { // DW_TAG_auto_variable
845 return wrap(Builder->createAutoVariable(
846 unwrapDI<DIDescriptor>(Scope), Name, unwrapDI<DIFile>(File), LineNo,
847 unwrapDI<DIType>(Ty), AlwaysPreserve, fromRust(Flags), AlignInBits));
849 return wrap(Builder->createParameterVariable(
850 unwrapDI<DIDescriptor>(Scope), Name, ArgNo, unwrapDI<DIFile>(File),
851 LineNo, unwrapDI<DIType>(Ty), AlwaysPreserve, fromRust(Flags)));
855 extern "C" LLVMMetadataRef
856 LLVMRustDIBuilderCreateArrayType(LLVMRustDIBuilderRef Builder, uint64_t Size,
857 uint32_t AlignInBits, LLVMMetadataRef Ty,
858 LLVMMetadataRef Subscripts) {
860 Builder->createArrayType(Size, AlignInBits, unwrapDI<DIType>(Ty),
861 DINodeArray(unwrapDI<MDTuple>(Subscripts))));
864 extern "C" LLVMMetadataRef
865 LLVMRustDIBuilderGetOrCreateSubrange(LLVMRustDIBuilderRef Builder, int64_t Lo,
867 return wrap(Builder->getOrCreateSubrange(Lo, Count));
870 extern "C" LLVMMetadataRef
871 LLVMRustDIBuilderGetOrCreateArray(LLVMRustDIBuilderRef Builder,
872 LLVMMetadataRef *Ptr, unsigned Count) {
873 Metadata **DataValue = unwrap(Ptr);
875 Builder->getOrCreateArray(ArrayRef<Metadata *>(DataValue, Count)).get());
878 extern "C" LLVMValueRef LLVMRustDIBuilderInsertDeclareAtEnd(
879 LLVMRustDIBuilderRef Builder, LLVMValueRef V, LLVMMetadataRef VarInfo,
880 int64_t *AddrOps, unsigned AddrOpsCount, LLVMValueRef DL,
881 LLVMBasicBlockRef InsertAtEnd) {
882 return wrap(Builder->insertDeclare(
883 unwrap(V), unwrap<DILocalVariable>(VarInfo),
884 Builder->createExpression(llvm::ArrayRef<int64_t>(AddrOps, AddrOpsCount)),
885 DebugLoc(cast<MDNode>(unwrap<MetadataAsValue>(DL)->getMetadata())),
886 unwrap(InsertAtEnd)));
889 extern "C" LLVMMetadataRef
890 LLVMRustDIBuilderCreateEnumerator(LLVMRustDIBuilderRef Builder,
891 const char *Name, uint64_t Val) {
892 return wrap(Builder->createEnumerator(Name, Val));
895 extern "C" LLVMMetadataRef LLVMRustDIBuilderCreateEnumerationType(
896 LLVMRustDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
897 LLVMMetadataRef File, unsigned LineNumber, uint64_t SizeInBits,
898 uint32_t AlignInBits, LLVMMetadataRef Elements,
899 LLVMMetadataRef ClassTy, bool IsScoped) {
900 return wrap(Builder->createEnumerationType(
901 unwrapDI<DIDescriptor>(Scope), Name, unwrapDI<DIFile>(File), LineNumber,
902 SizeInBits, AlignInBits, DINodeArray(unwrapDI<MDTuple>(Elements)),
903 unwrapDI<DIType>(ClassTy), "", IsScoped));
906 extern "C" LLVMMetadataRef LLVMRustDIBuilderCreateUnionType(
907 LLVMRustDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
908 LLVMMetadataRef File, unsigned LineNumber, uint64_t SizeInBits,
909 uint32_t AlignInBits, LLVMRustDIFlags Flags, LLVMMetadataRef Elements,
910 unsigned RunTimeLang, const char *UniqueId) {
911 return wrap(Builder->createUnionType(
912 unwrapDI<DIDescriptor>(Scope), Name, unwrapDI<DIFile>(File), LineNumber,
913 SizeInBits, AlignInBits, fromRust(Flags),
914 DINodeArray(unwrapDI<MDTuple>(Elements)), RunTimeLang, UniqueId));
917 extern "C" LLVMMetadataRef LLVMRustDIBuilderCreateTemplateTypeParameter(
918 LLVMRustDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
919 LLVMMetadataRef Ty, LLVMMetadataRef File, unsigned LineNo,
921 return wrap(Builder->createTemplateTypeParameter(
922 unwrapDI<DIDescriptor>(Scope), Name, unwrapDI<DIType>(Ty)));
925 extern "C" LLVMMetadataRef
926 LLVMRustDIBuilderCreateNameSpace(LLVMRustDIBuilderRef Builder,
927 LLVMMetadataRef Scope, const char *Name,
928 LLVMMetadataRef File, unsigned LineNo) {
929 return wrap(Builder->createNameSpace(
930 unwrapDI<DIDescriptor>(Scope), Name,
931 false // ExportSymbols (only relevant for C++ anonymous namespaces)
936 LLVMRustDICompositeTypeReplaceArrays(LLVMRustDIBuilderRef Builder,
937 LLVMMetadataRef CompositeTy,
938 LLVMMetadataRef Elements,
939 LLVMMetadataRef Params) {
940 DICompositeType *Tmp = unwrapDI<DICompositeType>(CompositeTy);
941 Builder->replaceArrays(Tmp, DINodeArray(unwrap<MDTuple>(Elements)),
942 DINodeArray(unwrap<MDTuple>(Params)));
945 extern "C" LLVMValueRef
946 LLVMRustDIBuilderCreateDebugLocation(LLVMContextRef ContextRef, unsigned Line,
947 unsigned Column, LLVMMetadataRef Scope,
948 LLVMMetadataRef InlinedAt) {
949 LLVMContext &Context = *unwrap(ContextRef);
951 DebugLoc debug_loc = DebugLoc::get(Line, Column, unwrapDIPtr<MDNode>(Scope),
952 unwrapDIPtr<MDNode>(InlinedAt));
954 return wrap(MetadataAsValue::get(Context, debug_loc.getAsMDNode()));
957 extern "C" int64_t LLVMRustDIBuilderCreateOpDeref() {
958 return dwarf::DW_OP_deref;
961 extern "C" int64_t LLVMRustDIBuilderCreateOpPlusUconst() {
962 return dwarf::DW_OP_plus_uconst;
965 extern "C" void LLVMRustWriteTypeToString(LLVMTypeRef Ty, RustStringRef Str) {
966 RawRustStringOstream OS(Str);
967 unwrap<llvm::Type>(Ty)->print(OS);
970 extern "C" void LLVMRustWriteValueToString(LLVMValueRef V,
972 RawRustStringOstream OS(Str);
977 unwrap<llvm::Value>(V)->getType()->print(OS);
979 unwrap<llvm::Value>(V)->print(OS);
984 // Note that the two following functions look quite similar to the
985 // LLVMGetSectionName function. Sadly, it appears that this function only
986 // returns a char* pointer, which isn't guaranteed to be null-terminated. The
987 // function provided by LLVM doesn't return the length, so we've created our own
988 // function which returns the length as well as the data pointer.
990 // For an example of this not returning a null terminated string, see
991 // lib/Object/COFFObjectFile.cpp in the getSectionName function. One of the
992 // branches explicitly creates a StringRef without a null terminator, and then
995 inline section_iterator *unwrap(LLVMSectionIteratorRef SI) {
996 return reinterpret_cast<section_iterator *>(SI);
999 extern "C" size_t LLVMRustGetSectionName(LLVMSectionIteratorRef SI,
1002 if (std::error_code EC = (*unwrap(SI))->getName(Ret))
1003 report_fatal_error(EC.message());
1008 // LLVMArrayType function does not support 64-bit ElementCount
1009 extern "C" LLVMTypeRef LLVMRustArrayType(LLVMTypeRef ElementTy,
1010 uint64_t ElementCount) {
1011 return wrap(ArrayType::get(unwrap(ElementTy), ElementCount));
1014 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Twine, LLVMTwineRef)
1016 extern "C" void LLVMRustWriteTwineToString(LLVMTwineRef T, RustStringRef Str) {
1017 RawRustStringOstream OS(Str);
1018 unwrap(T)->print(OS);
1021 extern "C" void LLVMRustUnpackOptimizationDiagnostic(
1022 LLVMDiagnosticInfoRef DI, RustStringRef PassNameOut,
1023 LLVMValueRef *FunctionOut, unsigned* Line, unsigned* Column,
1024 RustStringRef FilenameOut, RustStringRef MessageOut) {
1025 // Undefined to call this not on an optimization diagnostic!
1026 llvm::DiagnosticInfoOptimizationBase *Opt =
1027 static_cast<llvm::DiagnosticInfoOptimizationBase *>(unwrap(DI));
1029 RawRustStringOstream PassNameOS(PassNameOut);
1030 PassNameOS << Opt->getPassName();
1031 *FunctionOut = wrap(&Opt->getFunction());
1033 RawRustStringOstream FilenameOS(FilenameOut);
1034 DiagnosticLocation loc = Opt->getLocation();
1035 if (loc.isValid()) {
1036 *Line = loc.getLine();
1037 *Column = loc.getColumn();
1038 #if LLVM_VERSION_GE(8, 0)
1039 FilenameOS << loc.getAbsolutePath();
1041 FilenameOS << loc.getFilename();
1045 RawRustStringOstream MessageOS(MessageOut);
1046 MessageOS << Opt->getMsg();
1050 LLVMRustUnpackInlineAsmDiagnostic(LLVMDiagnosticInfoRef DI, unsigned *CookieOut,
1051 LLVMTwineRef *MessageOut,
1052 LLVMValueRef *InstructionOut) {
1053 // Undefined to call this not on an inline assembly diagnostic!
1054 llvm::DiagnosticInfoInlineAsm *IA =
1055 static_cast<llvm::DiagnosticInfoInlineAsm *>(unwrap(DI));
1057 *CookieOut = IA->getLocCookie();
1058 *MessageOut = wrap(&IA->getMsgStr());
1059 *InstructionOut = wrap(IA->getInstruction());
1062 extern "C" void LLVMRustWriteDiagnosticInfoToString(LLVMDiagnosticInfoRef DI,
1063 RustStringRef Str) {
1064 RawRustStringOstream OS(Str);
1065 DiagnosticPrinterRawOStream DP(OS);
1066 unwrap(DI)->print(DP);
1069 enum class LLVMRustDiagnosticKind {
1073 DebugMetadataVersion,
1076 OptimizationRemarkMissed,
1077 OptimizationRemarkAnalysis,
1078 OptimizationRemarkAnalysisFPCommute,
1079 OptimizationRemarkAnalysisAliasing,
1080 OptimizationRemarkOther,
1081 OptimizationFailure,
1086 static LLVMRustDiagnosticKind toRust(DiagnosticKind Kind) {
1089 return LLVMRustDiagnosticKind::InlineAsm;
1091 return LLVMRustDiagnosticKind::StackSize;
1092 case DK_DebugMetadataVersion:
1093 return LLVMRustDiagnosticKind::DebugMetadataVersion;
1094 case DK_SampleProfile:
1095 return LLVMRustDiagnosticKind::SampleProfile;
1096 case DK_OptimizationRemark:
1097 return LLVMRustDiagnosticKind::OptimizationRemark;
1098 case DK_OptimizationRemarkMissed:
1099 return LLVMRustDiagnosticKind::OptimizationRemarkMissed;
1100 case DK_OptimizationRemarkAnalysis:
1101 return LLVMRustDiagnosticKind::OptimizationRemarkAnalysis;
1102 case DK_OptimizationRemarkAnalysisFPCommute:
1103 return LLVMRustDiagnosticKind::OptimizationRemarkAnalysisFPCommute;
1104 case DK_OptimizationRemarkAnalysisAliasing:
1105 return LLVMRustDiagnosticKind::OptimizationRemarkAnalysisAliasing;
1107 return LLVMRustDiagnosticKind::PGOProfile;
1109 return LLVMRustDiagnosticKind::Linker;
1111 return (Kind >= DK_FirstRemark && Kind <= DK_LastRemark)
1112 ? LLVMRustDiagnosticKind::OptimizationRemarkOther
1113 : LLVMRustDiagnosticKind::Other;
1117 extern "C" LLVMRustDiagnosticKind
1118 LLVMRustGetDiagInfoKind(LLVMDiagnosticInfoRef DI) {
1119 return toRust((DiagnosticKind)unwrap(DI)->getKind());
1121 // This is kept distinct from LLVMGetTypeKind, because when
1122 // a new type kind is added, the Rust-side enum must be
1123 // updated or UB will result.
1124 extern "C" LLVMTypeKind LLVMRustGetTypeKind(LLVMTypeRef Ty) {
1125 switch (unwrap(Ty)->getTypeID()) {
1126 case Type::VoidTyID:
1127 return LLVMVoidTypeKind;
1128 case Type::HalfTyID:
1129 return LLVMHalfTypeKind;
1130 case Type::FloatTyID:
1131 return LLVMFloatTypeKind;
1132 case Type::DoubleTyID:
1133 return LLVMDoubleTypeKind;
1134 case Type::X86_FP80TyID:
1135 return LLVMX86_FP80TypeKind;
1136 case Type::FP128TyID:
1137 return LLVMFP128TypeKind;
1138 case Type::PPC_FP128TyID:
1139 return LLVMPPC_FP128TypeKind;
1140 case Type::LabelTyID:
1141 return LLVMLabelTypeKind;
1142 case Type::MetadataTyID:
1143 return LLVMMetadataTypeKind;
1144 case Type::IntegerTyID:
1145 return LLVMIntegerTypeKind;
1146 case Type::FunctionTyID:
1147 return LLVMFunctionTypeKind;
1148 case Type::StructTyID:
1149 return LLVMStructTypeKind;
1150 case Type::ArrayTyID:
1151 return LLVMArrayTypeKind;
1152 case Type::PointerTyID:
1153 return LLVMPointerTypeKind;
1154 case Type::VectorTyID:
1155 return LLVMVectorTypeKind;
1156 case Type::X86_MMXTyID:
1157 return LLVMX86_MMXTypeKind;
1158 case Type::TokenTyID:
1159 return LLVMTokenTypeKind;
1161 report_fatal_error("Unhandled TypeID.");
1164 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(SMDiagnostic, LLVMSMDiagnosticRef)
1166 extern "C" void LLVMRustSetInlineAsmDiagnosticHandler(
1167 LLVMContextRef C, LLVMContext::InlineAsmDiagHandlerTy H, void *CX) {
1168 unwrap(C)->setInlineAsmDiagnosticHandler(H, CX);
1171 extern "C" void LLVMRustWriteSMDiagnosticToString(LLVMSMDiagnosticRef D,
1172 RustStringRef Str) {
1173 RawRustStringOstream OS(Str);
1174 unwrap(D)->print("", OS);
1177 extern "C" LLVMValueRef LLVMRustBuildCleanupPad(LLVMBuilderRef B,
1178 LLVMValueRef ParentPad,
1180 LLVMValueRef *LLArgs,
1182 Value **Args = unwrap(LLArgs);
1183 if (ParentPad == nullptr) {
1184 Type *Ty = Type::getTokenTy(unwrap(B)->getContext());
1185 ParentPad = wrap(Constant::getNullValue(Ty));
1187 return wrap(unwrap(B)->CreateCleanupPad(
1188 unwrap(ParentPad), ArrayRef<Value *>(Args, ArgCount), Name));
1191 extern "C" LLVMValueRef LLVMRustBuildCleanupRet(LLVMBuilderRef B,
1192 LLVMValueRef CleanupPad,
1193 LLVMBasicBlockRef UnwindBB) {
1194 CleanupPadInst *Inst = cast<CleanupPadInst>(unwrap(CleanupPad));
1195 return wrap(unwrap(B)->CreateCleanupRet(Inst, unwrap(UnwindBB)));
1198 extern "C" LLVMValueRef
1199 LLVMRustBuildCatchPad(LLVMBuilderRef B, LLVMValueRef ParentPad,
1200 unsigned ArgCount, LLVMValueRef *LLArgs, const char *Name) {
1201 Value **Args = unwrap(LLArgs);
1202 return wrap(unwrap(B)->CreateCatchPad(
1203 unwrap(ParentPad), ArrayRef<Value *>(Args, ArgCount), Name));
1206 extern "C" LLVMValueRef LLVMRustBuildCatchRet(LLVMBuilderRef B,
1208 LLVMBasicBlockRef BB) {
1209 return wrap(unwrap(B)->CreateCatchRet(cast<CatchPadInst>(unwrap(Pad)),
1213 extern "C" LLVMValueRef LLVMRustBuildCatchSwitch(LLVMBuilderRef B,
1214 LLVMValueRef ParentPad,
1215 LLVMBasicBlockRef BB,
1216 unsigned NumHandlers,
1218 if (ParentPad == nullptr) {
1219 Type *Ty = Type::getTokenTy(unwrap(B)->getContext());
1220 ParentPad = wrap(Constant::getNullValue(Ty));
1222 return wrap(unwrap(B)->CreateCatchSwitch(unwrap(ParentPad), unwrap(BB),
1223 NumHandlers, Name));
1226 extern "C" void LLVMRustAddHandler(LLVMValueRef CatchSwitchRef,
1227 LLVMBasicBlockRef Handler) {
1228 Value *CatchSwitch = unwrap(CatchSwitchRef);
1229 cast<CatchSwitchInst>(CatchSwitch)->addHandler(unwrap(Handler));
1232 extern "C" OperandBundleDef *LLVMRustBuildOperandBundleDef(const char *Name,
1233 LLVMValueRef *Inputs,
1234 unsigned NumInputs) {
1235 return new OperandBundleDef(Name, makeArrayRef(unwrap(Inputs), NumInputs));
1238 extern "C" void LLVMRustFreeOperandBundleDef(OperandBundleDef *Bundle) {
1242 extern "C" LLVMValueRef LLVMRustBuildCall(LLVMBuilderRef B, LLVMValueRef Fn,
1243 LLVMValueRef *Args, unsigned NumArgs,
1244 OperandBundleDef *Bundle,
1246 unsigned Len = Bundle ? 1 : 0;
1247 ArrayRef<OperandBundleDef> Bundles = makeArrayRef(Bundle, Len);
1248 return wrap(unwrap(B)->CreateCall(
1249 unwrap(Fn), makeArrayRef(unwrap(Args), NumArgs), Bundles, Name));
1252 extern "C" LLVMValueRef LLVMRustBuildMemCpy(LLVMBuilderRef B,
1253 LLVMValueRef Dst, unsigned DstAlign,
1254 LLVMValueRef Src, unsigned SrcAlign,
1255 LLVMValueRef Size, bool IsVolatile) {
1256 return wrap(unwrap(B)->CreateMemCpy(
1257 unwrap(Dst), DstAlign,
1258 unwrap(Src), SrcAlign,
1259 unwrap(Size), IsVolatile));
1262 extern "C" LLVMValueRef LLVMRustBuildMemMove(LLVMBuilderRef B,
1263 LLVMValueRef Dst, unsigned DstAlign,
1264 LLVMValueRef Src, unsigned SrcAlign,
1265 LLVMValueRef Size, bool IsVolatile) {
1266 return wrap(unwrap(B)->CreateMemMove(
1267 unwrap(Dst), DstAlign,
1268 unwrap(Src), SrcAlign,
1269 unwrap(Size), IsVolatile));
1272 extern "C" LLVMValueRef
1273 LLVMRustBuildInvoke(LLVMBuilderRef B, LLVMValueRef Fn, LLVMValueRef *Args,
1274 unsigned NumArgs, LLVMBasicBlockRef Then,
1275 LLVMBasicBlockRef Catch, OperandBundleDef *Bundle,
1277 unsigned Len = Bundle ? 1 : 0;
1278 ArrayRef<OperandBundleDef> Bundles = makeArrayRef(Bundle, Len);
1279 return wrap(unwrap(B)->CreateInvoke(unwrap(Fn), unwrap(Then), unwrap(Catch),
1280 makeArrayRef(unwrap(Args), NumArgs),
1284 extern "C" void LLVMRustPositionBuilderAtStart(LLVMBuilderRef B,
1285 LLVMBasicBlockRef BB) {
1286 auto Point = unwrap(BB)->getFirstInsertionPt();
1287 unwrap(B)->SetInsertPoint(unwrap(BB), Point);
1290 extern "C" void LLVMRustSetComdat(LLVMModuleRef M, LLVMValueRef V,
1291 const char *Name, size_t NameLen) {
1292 Triple TargetTriple(unwrap(M)->getTargetTriple());
1293 GlobalObject *GV = unwrap<GlobalObject>(V);
1294 if (!TargetTriple.isOSBinFormatMachO()) {
1295 StringRef NameRef(Name, NameLen);
1296 GV->setComdat(unwrap(M)->getOrInsertComdat(NameRef));
1300 extern "C" void LLVMRustUnsetComdat(LLVMValueRef V) {
1301 GlobalObject *GV = unwrap<GlobalObject>(V);
1302 GV->setComdat(nullptr);
1305 enum class LLVMRustLinkage {
1306 ExternalLinkage = 0,
1307 AvailableExternallyLinkage = 1,
1308 LinkOnceAnyLinkage = 2,
1309 LinkOnceODRLinkage = 3,
1312 AppendingLinkage = 6,
1313 InternalLinkage = 7,
1315 ExternalWeakLinkage = 9,
1319 static LLVMRustLinkage toRust(LLVMLinkage Linkage) {
1321 case LLVMExternalLinkage:
1322 return LLVMRustLinkage::ExternalLinkage;
1323 case LLVMAvailableExternallyLinkage:
1324 return LLVMRustLinkage::AvailableExternallyLinkage;
1325 case LLVMLinkOnceAnyLinkage:
1326 return LLVMRustLinkage::LinkOnceAnyLinkage;
1327 case LLVMLinkOnceODRLinkage:
1328 return LLVMRustLinkage::LinkOnceODRLinkage;
1329 case LLVMWeakAnyLinkage:
1330 return LLVMRustLinkage::WeakAnyLinkage;
1331 case LLVMWeakODRLinkage:
1332 return LLVMRustLinkage::WeakODRLinkage;
1333 case LLVMAppendingLinkage:
1334 return LLVMRustLinkage::AppendingLinkage;
1335 case LLVMInternalLinkage:
1336 return LLVMRustLinkage::InternalLinkage;
1337 case LLVMPrivateLinkage:
1338 return LLVMRustLinkage::PrivateLinkage;
1339 case LLVMExternalWeakLinkage:
1340 return LLVMRustLinkage::ExternalWeakLinkage;
1341 case LLVMCommonLinkage:
1342 return LLVMRustLinkage::CommonLinkage;
1344 report_fatal_error("Invalid LLVMRustLinkage value!");
1348 static LLVMLinkage fromRust(LLVMRustLinkage Linkage) {
1350 case LLVMRustLinkage::ExternalLinkage:
1351 return LLVMExternalLinkage;
1352 case LLVMRustLinkage::AvailableExternallyLinkage:
1353 return LLVMAvailableExternallyLinkage;
1354 case LLVMRustLinkage::LinkOnceAnyLinkage:
1355 return LLVMLinkOnceAnyLinkage;
1356 case LLVMRustLinkage::LinkOnceODRLinkage:
1357 return LLVMLinkOnceODRLinkage;
1358 case LLVMRustLinkage::WeakAnyLinkage:
1359 return LLVMWeakAnyLinkage;
1360 case LLVMRustLinkage::WeakODRLinkage:
1361 return LLVMWeakODRLinkage;
1362 case LLVMRustLinkage::AppendingLinkage:
1363 return LLVMAppendingLinkage;
1364 case LLVMRustLinkage::InternalLinkage:
1365 return LLVMInternalLinkage;
1366 case LLVMRustLinkage::PrivateLinkage:
1367 return LLVMPrivateLinkage;
1368 case LLVMRustLinkage::ExternalWeakLinkage:
1369 return LLVMExternalWeakLinkage;
1370 case LLVMRustLinkage::CommonLinkage:
1371 return LLVMCommonLinkage;
1373 report_fatal_error("Invalid LLVMRustLinkage value!");
1376 extern "C" LLVMRustLinkage LLVMRustGetLinkage(LLVMValueRef V) {
1377 return toRust(LLVMGetLinkage(V));
1380 extern "C" void LLVMRustSetLinkage(LLVMValueRef V,
1381 LLVMRustLinkage RustLinkage) {
1382 LLVMSetLinkage(V, fromRust(RustLinkage));
1385 // Returns true if both high and low were successfully set. Fails in case constant wasn’t any of
1386 // the common sizes (1, 8, 16, 32, 64, 128 bits)
1387 extern "C" bool LLVMRustConstInt128Get(LLVMValueRef CV, bool sext, uint64_t *high, uint64_t *low)
1389 auto C = unwrap<llvm::ConstantInt>(CV);
1390 if (C->getBitWidth() > 128) { return false; }
1393 AP = C->getValue().sextOrSelf(128);
1395 AP = C->getValue().zextOrSelf(128);
1397 *low = AP.getLoBits(64).getZExtValue();
1398 *high = AP.getHiBits(64).getZExtValue();
1402 enum class LLVMRustVisibility {
1408 static LLVMRustVisibility toRust(LLVMVisibility Vis) {
1410 case LLVMDefaultVisibility:
1411 return LLVMRustVisibility::Default;
1412 case LLVMHiddenVisibility:
1413 return LLVMRustVisibility::Hidden;
1414 case LLVMProtectedVisibility:
1415 return LLVMRustVisibility::Protected;
1417 report_fatal_error("Invalid LLVMRustVisibility value!");
1420 static LLVMVisibility fromRust(LLVMRustVisibility Vis) {
1422 case LLVMRustVisibility::Default:
1423 return LLVMDefaultVisibility;
1424 case LLVMRustVisibility::Hidden:
1425 return LLVMHiddenVisibility;
1426 case LLVMRustVisibility::Protected:
1427 return LLVMProtectedVisibility;
1429 report_fatal_error("Invalid LLVMRustVisibility value!");
1432 extern "C" LLVMRustVisibility LLVMRustGetVisibility(LLVMValueRef V) {
1433 return toRust(LLVMGetVisibility(V));
1436 // Oh hey, a binding that makes sense for once? (because LLVM’s own do not)
1437 extern "C" LLVMValueRef LLVMRustBuildIntCast(LLVMBuilderRef B, LLVMValueRef Val,
1438 LLVMTypeRef DestTy, bool isSigned) {
1439 return wrap(unwrap(B)->CreateIntCast(unwrap(Val), unwrap(DestTy), isSigned, ""));
1442 extern "C" void LLVMRustSetVisibility(LLVMValueRef V,
1443 LLVMRustVisibility RustVisibility) {
1444 LLVMSetVisibility(V, fromRust(RustVisibility));
1447 struct LLVMRustModuleBuffer {
1451 extern "C" LLVMRustModuleBuffer*
1452 LLVMRustModuleBufferCreate(LLVMModuleRef M) {
1453 auto Ret = llvm::make_unique<LLVMRustModuleBuffer>();
1455 raw_string_ostream OS(Ret->data);
1457 legacy::PassManager PM;
1458 PM.add(createBitcodeWriterPass(OS));
1462 return Ret.release();
1466 LLVMRustModuleBufferFree(LLVMRustModuleBuffer *Buffer) {
1470 extern "C" const void*
1471 LLVMRustModuleBufferPtr(const LLVMRustModuleBuffer *Buffer) {
1472 return Buffer->data.data();
1476 LLVMRustModuleBufferLen(const LLVMRustModuleBuffer *Buffer) {
1477 return Buffer->data.length();
1481 LLVMRustModuleCost(LLVMModuleRef M) {
1482 auto f = unwrap(M)->functions();
1483 return std::distance(std::begin(f), std::end(f));
1486 // Vector reductions:
1487 extern "C" LLVMValueRef
1488 LLVMRustBuildVectorReduceFAdd(LLVMBuilderRef B, LLVMValueRef Acc, LLVMValueRef Src) {
1489 return wrap(unwrap(B)->CreateFAddReduce(unwrap(Acc),unwrap(Src)));
1491 extern "C" LLVMValueRef
1492 LLVMRustBuildVectorReduceFMul(LLVMBuilderRef B, LLVMValueRef Acc, LLVMValueRef Src) {
1493 return wrap(unwrap(B)->CreateFMulReduce(unwrap(Acc),unwrap(Src)));
1495 extern "C" LLVMValueRef
1496 LLVMRustBuildVectorReduceAdd(LLVMBuilderRef B, LLVMValueRef Src) {
1497 return wrap(unwrap(B)->CreateAddReduce(unwrap(Src)));
1499 extern "C" LLVMValueRef
1500 LLVMRustBuildVectorReduceMul(LLVMBuilderRef B, LLVMValueRef Src) {
1501 return wrap(unwrap(B)->CreateMulReduce(unwrap(Src)));
1503 extern "C" LLVMValueRef
1504 LLVMRustBuildVectorReduceAnd(LLVMBuilderRef B, LLVMValueRef Src) {
1505 return wrap(unwrap(B)->CreateAndReduce(unwrap(Src)));
1507 extern "C" LLVMValueRef
1508 LLVMRustBuildVectorReduceOr(LLVMBuilderRef B, LLVMValueRef Src) {
1509 return wrap(unwrap(B)->CreateOrReduce(unwrap(Src)));
1511 extern "C" LLVMValueRef
1512 LLVMRustBuildVectorReduceXor(LLVMBuilderRef B, LLVMValueRef Src) {
1513 return wrap(unwrap(B)->CreateXorReduce(unwrap(Src)));
1515 extern "C" LLVMValueRef
1516 LLVMRustBuildVectorReduceMin(LLVMBuilderRef B, LLVMValueRef Src, bool IsSigned) {
1517 return wrap(unwrap(B)->CreateIntMinReduce(unwrap(Src), IsSigned));
1519 extern "C" LLVMValueRef
1520 LLVMRustBuildVectorReduceMax(LLVMBuilderRef B, LLVMValueRef Src, bool IsSigned) {
1521 return wrap(unwrap(B)->CreateIntMaxReduce(unwrap(Src), IsSigned));
1523 extern "C" LLVMValueRef
1524 LLVMRustBuildVectorReduceFMin(LLVMBuilderRef B, LLVMValueRef Src, bool NoNaN) {
1525 return wrap(unwrap(B)->CreateFPMinReduce(unwrap(Src), NoNaN));
1527 extern "C" LLVMValueRef
1528 LLVMRustBuildVectorReduceFMax(LLVMBuilderRef B, LLVMValueRef Src, bool NoNaN) {
1529 return wrap(unwrap(B)->CreateFPMaxReduce(unwrap(Src), NoNaN));
1532 extern "C" LLVMValueRef
1533 LLVMRustBuildMinNum(LLVMBuilderRef B, LLVMValueRef LHS, LLVMValueRef RHS) {
1534 return wrap(unwrap(B)->CreateMinNum(unwrap(LHS),unwrap(RHS)));
1536 extern "C" LLVMValueRef
1537 LLVMRustBuildMaxNum(LLVMBuilderRef B, LLVMValueRef LHS, LLVMValueRef RHS) {
1538 return wrap(unwrap(B)->CreateMaxNum(unwrap(LHS),unwrap(RHS)));