src/rustllvm/RustWrapper.cpp

   1 // Copyright 2013 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 #include "rustllvm.h"
  12 #include "llvm/IR/DiagnosticInfo.h"
  13 #include "llvm/IR/DiagnosticPrinter.h"
  14 #include "llvm/IR/Instructions.h"
  15 #include "llvm/Object/Archive.h"
  16 #include "llvm/Object/ObjectFile.h"
  17
  18 #include "llvm/IR/CallSite.h"
  19
  20 //===----------------------------------------------------------------------===
  21 //
  22 // This file defines alternate interfaces to core functions that are more
  23 // readily callable by Rust's FFI.
  24 //
  25 //===----------------------------------------------------------------------===
  26
  27 using namespace llvm;
  28 using namespace llvm::sys;
  29 using namespace llvm::object;
  30
  31 // LLVMAtomicOrdering is already an enum - don't create another
  32 // one.
  33 static AtomicOrdering fromRust(LLVMAtomicOrdering Ordering) {
  34   switch (Ordering) {
  35   case LLVMAtomicOrderingNotAtomic:
  36     return AtomicOrdering::NotAtomic;
  37   case LLVMAtomicOrderingUnordered:
  38     return AtomicOrdering::Unordered;
  39   case LLVMAtomicOrderingMonotonic:
  40     return AtomicOrdering::Monotonic;
  41   case LLVMAtomicOrderingAcquire:
  42     return AtomicOrdering::Acquire;
  43   case LLVMAtomicOrderingRelease:
  44     return AtomicOrdering::Release;
  45   case LLVMAtomicOrderingAcquireRelease:
  46     return AtomicOrdering::AcquireRelease;
  47   case LLVMAtomicOrderingSequentiallyConsistent:
  48     return AtomicOrdering::SequentiallyConsistent;
  49   }
  50
  51   llvm_unreachable("Invalid LLVMAtomicOrdering value!");
  52 }
  53
  54 static char *LastError;
  55
  56 extern "C" LLVMMemoryBufferRef
  57 LLVMRustCreateMemoryBufferWithContentsOfFile(const char *Path) {
  58   ErrorOr<std::unique_ptr<MemoryBuffer>> BufOr =
  59       MemoryBuffer::getFile(Path, -1, false);
  60   if (!BufOr) {
  61     LLVMRustSetLastError(BufOr.getError().message().c_str());
  62     return nullptr;
  63   }
  64   return wrap(BufOr.get().release());
  65 }
  66
  67 extern "C" char *LLVMRustGetLastError(void) {
  68   char *Ret = LastError;
  69   LastError = nullptr;
  70   return Ret;
  71 }
  72
  73 void LLVMRustSetLastError(const char *Err) {
  74   free((void *)LastError);
  75   LastError = strdup(Err);
  76 }
  77
  78 extern "C" void LLVMRustSetNormalizedTarget(LLVMModuleRef M,
  79                                             const char *Triple) {
  80   unwrap(M)->setTargetTriple(Triple::normalize(Triple));
  81 }
  82
  83 extern "C" void LLVMRustPrintPassTimings() {
  84   raw_fd_ostream OS(2, false); // stderr.
  85   TimerGroup::printAll(OS);
  86 }
  87
  88 extern "C" LLVMValueRef LLVMRustGetNamedValue(LLVMModuleRef M,
  89                                               const char *Name) {
  90   return wrap(unwrap(M)->getNamedValue(Name));
  91 }
  92
  93 extern "C" LLVMValueRef LLVMRustGetOrInsertFunction(LLVMModuleRef M,
  94                                                     const char *Name,
  95                                                     LLVMTypeRef FunctionTy) {
  96   return wrap(
  97       unwrap(M)->getOrInsertFunction(Name, unwrap<FunctionType>(FunctionTy)));
  98 }
  99
 100 extern "C" LLVMValueRef
 101 LLVMRustGetOrInsertGlobal(LLVMModuleRef M, const char *Name, LLVMTypeRef Ty) {
 102   return wrap(unwrap(M)->getOrInsertGlobal(Name, unwrap(Ty)));
 103 }
 104
 105 extern "C" LLVMTypeRef LLVMRustMetadataTypeInContext(LLVMContextRef C) {
 106   return wrap(Type::getMetadataTy(*unwrap(C)));
 107 }
 108
 109 static Attribute::AttrKind fromRust(LLVMRustAttribute Kind) {
 110   switch (Kind) {
 111   case AlwaysInline:
 112     return Attribute::AlwaysInline;
 113   case ByVal:
 114     return Attribute::ByVal;
 115   case Cold:
 116     return Attribute::Cold;
 117   case InlineHint:
 118     return Attribute::InlineHint;
 119   case MinSize:
 120     return Attribute::MinSize;
 121   case Naked:
 122     return Attribute::Naked;
 123   case NoAlias:
 124     return Attribute::NoAlias;
 125   case NoCapture:
 126     return Attribute::NoCapture;
 127   case NoInline:
 128     return Attribute::NoInline;
 129   case NonNull:
 130     return Attribute::NonNull;
 131   case NoRedZone:
 132     return Attribute::NoRedZone;
 133   case NoReturn:
 134     return Attribute::NoReturn;
 135   case NoUnwind:
 136     return Attribute::NoUnwind;
 137   case OptimizeForSize:
 138     return Attribute::OptimizeForSize;
 139   case ReadOnly:
 140     return Attribute::ReadOnly;
 141   case SExt:
 142     return Attribute::SExt;
 143   case StructRet:
 144     return Attribute::StructRet;
 145   case UWTable:
 146     return Attribute::UWTable;
 147   case ZExt:
 148     return Attribute::ZExt;
 149   case InReg:
 150     return Attribute::InReg;
 151   }
 152   llvm_unreachable("bad AttributeKind");
 153 }
 154
 155 extern "C" void LLVMRustAddCallSiteAttribute(LLVMValueRef Instr, unsigned Index,
 156                                              LLVMRustAttribute RustAttr) {
 157   CallSite Call = CallSite(unwrap<Instruction>(Instr));
 158   Attribute Attr = Attribute::get(Call->getContext(), fromRust(RustAttr));
 159   AttrBuilder B(Attr);
 160   Call.setAttributes(Call.getAttributes().addAttributes(
 161       Call->getContext(), Index,
 162       AttributeSet::get(Call->getContext(), Index, B)));
 163 }
 164
 165 extern "C" void LLVMRustAddDereferenceableCallSiteAttr(LLVMValueRef Instr,
 166                                                        unsigned Index,
 167                                                        uint64_t Bytes) {
 168   CallSite Call = CallSite(unwrap<Instruction>(Instr));
 169   AttrBuilder B;
 170   B.addDereferenceableAttr(Bytes);
 171   Call.setAttributes(Call.getAttributes().addAttributes(
 172       Call->getContext(), Index,
 173       AttributeSet::get(Call->getContext(), Index, B)));
 174 }
 175
 176 extern "C" void LLVMRustAddFunctionAttribute(LLVMValueRef Fn, unsigned Index,
 177                                              LLVMRustAttribute RustAttr) {
 178   Function *A = unwrap<Function>(Fn);
 179   Attribute Attr = Attribute::get(A->getContext(), fromRust(RustAttr));
 180   AttrBuilder B(Attr);
 181   A->addAttributes(Index, AttributeSet::get(A->getContext(), Index, B));
 182 }
 183
 184 extern "C" void LLVMRustAddDereferenceableAttr(LLVMValueRef Fn, unsigned Index,
 185                                                uint64_t Bytes) {
 186   Function *A = unwrap<Function>(Fn);
 187   AttrBuilder B;
 188   B.addDereferenceableAttr(Bytes);
 189   A->addAttributes(Index, AttributeSet::get(A->getContext(), Index, B));
 190 }
 191
 192 extern "C" void LLVMRustAddFunctionAttrStringValue(LLVMValueRef Fn,
 193                                                    unsigned Index,
 194                                                    const char *Name,
 195                                                    const char *Value) {
 196   Function *F = unwrap<Function>(Fn);
 197   AttrBuilder B;
 198   B.addAttribute(Name, Value);
 199   F->addAttributes(Index, AttributeSet::get(F->getContext(), Index, B));
 200 }
 201
 202 extern "C" void LLVMRustRemoveFunctionAttributes(LLVMValueRef Fn,
 203                                                  unsigned Index,
 204                                                  LLVMRustAttribute RustAttr) {
 205   Function *F = unwrap<Function>(Fn);
 206   const AttributeSet PAL = F->getAttributes();
 207   Attribute Attr = Attribute::get(F->getContext(), fromRust(RustAttr));
 208   AttrBuilder B(Attr);
 209   const AttributeSet PALNew = PAL.removeAttributes(
 210       F->getContext(), Index, AttributeSet::get(F->getContext(), Index, B));
 211   F->setAttributes(PALNew);
 212 }
 213
 214 // enable fpmath flag UnsafeAlgebra
 215 extern "C" void LLVMRustSetHasUnsafeAlgebra(LLVMValueRef V) {
 216   if (auto I = dyn_cast<Instruction>(unwrap<Value>(V))) {
 217     I->setHasUnsafeAlgebra(true);
 218   }
 219 }
 220
 221 extern "C" LLVMValueRef
 222 LLVMRustBuildAtomicLoad(LLVMBuilderRef B, LLVMValueRef Source, const char *Name,
 223                         LLVMAtomicOrdering Order, unsigned Alignment) {
 224   LoadInst *LI = new LoadInst(unwrap(Source), 0);
 225   LI->setAtomic(fromRust(Order));
 226   LI->setAlignment(Alignment);
 227   return wrap(unwrap(B)->Insert(LI, Name));
 228 }
 229
 230 extern "C" LLVMValueRef LLVMRustBuildAtomicStore(LLVMBuilderRef B,
 231                                                  LLVMValueRef V,
 232                                                  LLVMValueRef Target,
 233                                                  LLVMAtomicOrdering Order,
 234                                                  unsigned Alignment) {
 235   StoreInst *SI = new StoreInst(unwrap(V), unwrap(Target));
 236   SI->setAtomic(fromRust(Order));
 237   SI->setAlignment(Alignment);
 238   return wrap(unwrap(B)->Insert(SI));
 239 }
 240
 241 extern "C" LLVMValueRef
 242 LLVMRustBuildAtomicCmpXchg(LLVMBuilderRef B, LLVMValueRef Target,
 243                            LLVMValueRef Old, LLVMValueRef Source,
 244                            LLVMAtomicOrdering Order,
 245                            LLVMAtomicOrdering FailureOrder, LLVMBool Weak) {
 246   AtomicCmpXchgInst *ACXI = unwrap(B)->CreateAtomicCmpXchg(
 247       unwrap(Target), unwrap(Old), unwrap(Source), fromRust(Order),
 248       fromRust(FailureOrder));
 249   ACXI->setWeak(Weak);
 250   return wrap(ACXI);
 251 }
 252
 253 enum class LLVMRustSynchronizationScope {
 254   Other,
 255   SingleThread,
 256   CrossThread,
 257 };
 258
 259 static SynchronizationScope fromRust(LLVMRustSynchronizationScope Scope) {
 260   switch (Scope) {
 261   case LLVMRustSynchronizationScope::SingleThread:
 262     return SingleThread;
 263   case LLVMRustSynchronizationScope::CrossThread:
 264     return CrossThread;
 265   default:
 266     llvm_unreachable("bad SynchronizationScope.");
 267   }
 268 }
 269
 270 extern "C" LLVMValueRef
 271 LLVMRustBuildAtomicFence(LLVMBuilderRef B, LLVMAtomicOrdering Order,
 272                          LLVMRustSynchronizationScope Scope) {
 273   return wrap(unwrap(B)->CreateFence(fromRust(Order), fromRust(Scope)));
 274 }
 275
 276 extern "C" void LLVMRustSetDebug(int Enabled) {
 277 #ifndef NDEBUG
 278   DebugFlag = Enabled;
 279 #endif
 280 }
 281
 282 enum class LLVMRustAsmDialect {
 283   Other,
 284   Att,
 285   Intel,
 286 };
 287
 288 static InlineAsm::AsmDialect fromRust(LLVMRustAsmDialect Dialect) {
 289   switch (Dialect) {
 290   case LLVMRustAsmDialect::Att:
 291     return InlineAsm::AD_ATT;
 292   case LLVMRustAsmDialect::Intel:
 293     return InlineAsm::AD_Intel;
 294   default:
 295     llvm_unreachable("bad AsmDialect.");
 296   }
 297 }
 298
 299 extern "C" LLVMValueRef LLVMRustInlineAsm(LLVMTypeRef Ty, char *AsmString,
 300                                           char *Constraints,
 301                                           LLVMBool HasSideEffects,
 302                                           LLVMBool IsAlignStack,
 303                                           LLVMRustAsmDialect Dialect) {
 304   return wrap(InlineAsm::get(unwrap<FunctionType>(Ty), AsmString, Constraints,
 305                              HasSideEffects, IsAlignStack, fromRust(Dialect)));
 306 }
 307
 308 typedef DIBuilder *LLVMRustDIBuilderRef;
 309
 310 typedef struct LLVMOpaqueMetadata *LLVMRustMetadataRef;
 311
 312 namespace llvm {
 313 DEFINE_ISA_CONVERSION_FUNCTIONS(Metadata, LLVMRustMetadataRef)
 314
 315 inline Metadata **unwrap(LLVMRustMetadataRef *Vals) {
 316   return reinterpret_cast<Metadata **>(Vals);
 317 }
 318 }
 319
 320 template <typename DIT> DIT *unwrapDIPtr(LLVMRustMetadataRef Ref) {
 321   return (DIT *)(Ref ? unwrap<MDNode>(Ref) : nullptr);
 322 }
 323
 324 #define DIDescriptor DIScope
 325 #define DIArray DINodeArray
 326 #define unwrapDI unwrapDIPtr
 327
 328 // These values **must** match debuginfo::DIFlags! They also *happen*
 329 // to match LLVM, but that isn't required as we do giant sets of
 330 // matching below. The value shouldn't be directly passed to LLVM.
 331 enum class LLVMRustDIFlags : uint32_t {
 332   FlagZero = 0,
 333   FlagPrivate = 1,
 334   FlagProtected = 2,
 335   FlagPublic = 3,
 336   FlagFwdDecl = (1 << 2),
 337   FlagAppleBlock = (1 << 3),
 338   FlagBlockByrefStruct = (1 << 4),
 339   FlagVirtual = (1 << 5),
 340   FlagArtificial = (1 << 6),
 341   FlagExplicit = (1 << 7),
 342   FlagPrototyped = (1 << 8),
 343   FlagObjcClassComplete = (1 << 9),
 344   FlagObjectPointer = (1 << 10),
 345   FlagVector = (1 << 11),
 346   FlagStaticMember = (1 << 12),
 347   FlagLValueReference = (1 << 13),
 348   FlagRValueReference = (1 << 14),
 349   // Do not add values that are not supported by the minimum LLVM
 350   // version we support!
 351 };
 352
 353 inline LLVMRustDIFlags operator&(LLVMRustDIFlags A, LLVMRustDIFlags B) {
 354   return static_cast<LLVMRustDIFlags>(static_cast<uint32_t>(A) &
 355                                       static_cast<uint32_t>(B));
 356 }
 357
 358 inline LLVMRustDIFlags operator|(LLVMRustDIFlags A, LLVMRustDIFlags B) {
 359   return static_cast<LLVMRustDIFlags>(static_cast<uint32_t>(A) |
 360                                       static_cast<uint32_t>(B));
 361 }
 362
 363 inline LLVMRustDIFlags &operator|=(LLVMRustDIFlags &A, LLVMRustDIFlags B) {
 364   return A = A | B;
 365 }
 366
 367 inline bool isSet(LLVMRustDIFlags F) { return F != LLVMRustDIFlags::FlagZero; }
 368
 369 inline LLVMRustDIFlags visibility(LLVMRustDIFlags F) {
 370   return static_cast<LLVMRustDIFlags>(static_cast<uint32_t>(F) & 0x3);
 371 }
 372
 373 #if LLVM_VERSION_GE(4, 0)
 374 static DINode::DIFlags fromRust(LLVMRustDIFlags Flags) {
 375   DINode::DIFlags Result = DINode::DIFlags::FlagZero;
 376 #else
 377 static unsigned fromRust(LLVMRustDIFlags Flags) {
 378   unsigned Result = 0;
 379 #endif
 380
 381   switch (visibility(Flags)) {
 382   case LLVMRustDIFlags::FlagPrivate:
 383     Result |= DINode::DIFlags::FlagPrivate;
 384     break;
 385   case LLVMRustDIFlags::FlagProtected:
 386     Result |= DINode::DIFlags::FlagProtected;
 387     break;
 388   case LLVMRustDIFlags::FlagPublic:
 389     Result |= DINode::DIFlags::FlagPublic;
 390     break;
 391   default:
 392     // The rest are handled below
 393     break;
 394   }
 395
 396   if (isSet(Flags & LLVMRustDIFlags::FlagFwdDecl)) {
 397     Result |= DINode::DIFlags::FlagFwdDecl;
 398   }
 399   if (isSet(Flags & LLVMRustDIFlags::FlagAppleBlock)) {
 400     Result |= DINode::DIFlags::FlagAppleBlock;
 401   }
 402   if (isSet(Flags & LLVMRustDIFlags::FlagBlockByrefStruct)) {
 403     Result |= DINode::DIFlags::FlagBlockByrefStruct;
 404   }
 405   if (isSet(Flags & LLVMRustDIFlags::FlagVirtual)) {
 406     Result |= DINode::DIFlags::FlagVirtual;
 407   }
 408   if (isSet(Flags & LLVMRustDIFlags::FlagArtificial)) {
 409     Result |= DINode::DIFlags::FlagArtificial;
 410   }
 411   if (isSet(Flags & LLVMRustDIFlags::FlagExplicit)) {
 412     Result |= DINode::DIFlags::FlagExplicit;
 413   }
 414   if (isSet(Flags & LLVMRustDIFlags::FlagPrototyped)) {
 415     Result |= DINode::DIFlags::FlagPrototyped;
 416   }
 417   if (isSet(Flags & LLVMRustDIFlags::FlagObjcClassComplete)) {
 418     Result |= DINode::DIFlags::FlagObjcClassComplete;
 419   }
 420   if (isSet(Flags & LLVMRustDIFlags::FlagObjectPointer)) {
 421     Result |= DINode::DIFlags::FlagObjectPointer;
 422   }
 423   if (isSet(Flags & LLVMRustDIFlags::FlagVector)) {
 424     Result |= DINode::DIFlags::FlagVector;
 425   }
 426   if (isSet(Flags & LLVMRustDIFlags::FlagStaticMember)) {
 427     Result |= DINode::DIFlags::FlagStaticMember;
 428   }
 429   if (isSet(Flags & LLVMRustDIFlags::FlagLValueReference)) {
 430     Result |= DINode::DIFlags::FlagLValueReference;
 431   }
 432   if (isSet(Flags & LLVMRustDIFlags::FlagRValueReference)) {
 433     Result |= DINode::DIFlags::FlagRValueReference;
 434   }
 435
 436   return Result;
 437 }
 438
 439 extern "C" uint32_t LLVMRustDebugMetadataVersion() {
 440   return DEBUG_METADATA_VERSION;
 441 }
 442
 443 extern "C" uint32_t LLVMRustVersionMinor() { return LLVM_VERSION_MINOR; }
 444
 445 extern "C" uint32_t LLVMRustVersionMajor() { return LLVM_VERSION_MAJOR; }
 446
 447 extern "C" void LLVMRustAddModuleFlag(LLVMModuleRef M, const char *Name,
 448                                       uint32_t Value) {
 449   unwrap(M)->addModuleFlag(Module::Warning, Name, Value);
 450 }
 451
 452 extern "C" LLVMRustDIBuilderRef LLVMRustDIBuilderCreate(LLVMModuleRef M) {
 453   return new DIBuilder(*unwrap(M));
 454 }
 455
 456 extern "C" void LLVMRustDIBuilderDispose(LLVMRustDIBuilderRef Builder) {
 457   delete Builder;
 458 }
 459
 460 extern "C" void LLVMRustDIBuilderFinalize(LLVMRustDIBuilderRef Builder) {
 461   Builder->finalize();
 462 }
 463
 464 extern "C" LLVMRustMetadataRef LLVMRustDIBuilderCreateCompileUnit(
 465     LLVMRustDIBuilderRef Builder, unsigned Lang, const char *File,
 466     const char *Dir, const char *Producer, bool isOptimized, const char *Flags,
 467     unsigned RuntimeVer, const char *SplitName) {
 468   return wrap(Builder->createCompileUnit(Lang, File, Dir, Producer, isOptimized,
 469                                          Flags, RuntimeVer, SplitName));
 470 }
 471
 472 extern "C" LLVMRustMetadataRef
 473 LLVMRustDIBuilderCreateFile(LLVMRustDIBuilderRef Builder, const char *Filename,
 474                             const char *Directory) {
 475   return wrap(Builder->createFile(Filename, Directory));
 476 }
 477
 478 extern "C" LLVMRustMetadataRef
 479 LLVMRustDIBuilderCreateSubroutineType(LLVMRustDIBuilderRef Builder,
 480                                       LLVMRustMetadataRef File,
 481                                       LLVMRustMetadataRef ParameterTypes) {
 482   return wrap(Builder->createSubroutineType(
 483 #if LLVM_VERSION_EQ(3, 7)
 484       unwrapDI<DIFile>(File),
 485 #endif
 486       DITypeRefArray(unwrap<MDTuple>(ParameterTypes))));
 487 }
 488
 489 extern "C" LLVMRustMetadataRef LLVMRustDIBuilderCreateFunction(
 490     LLVMRustDIBuilderRef Builder, LLVMRustMetadataRef Scope, const char *Name,
 491     const char *LinkageName, LLVMRustMetadataRef File, unsigned LineNo,
 492     LLVMRustMetadataRef Ty, bool IsLocalToUnit, bool IsDefinition,
 493     unsigned ScopeLine, LLVMRustDIFlags Flags, bool IsOptimized,
 494     LLVMValueRef Fn, LLVMRustMetadataRef TParam, LLVMRustMetadataRef Decl) {
 495 #if LLVM_VERSION_GE(3, 8)
 496   DITemplateParameterArray TParams =
 497       DITemplateParameterArray(unwrap<MDTuple>(TParam));
 498   DISubprogram *Sub = Builder->createFunction(
 499       unwrapDI<DIScope>(Scope), Name, LinkageName, unwrapDI<DIFile>(File),
 500       LineNo, unwrapDI<DISubroutineType>(Ty), IsLocalToUnit, IsDefinition,
 501       ScopeLine, fromRust(Flags), IsOptimized, TParams,
 502       unwrapDIPtr<DISubprogram>(Decl));
 503   unwrap<Function>(Fn)->setSubprogram(Sub);
 504   return wrap(Sub);
 505 #else
 506   return wrap(Builder->createFunction(
 507       unwrapDI<DIScope>(Scope), Name, LinkageName, unwrapDI<DIFile>(File),
 508       LineNo, unwrapDI<DISubroutineType>(Ty), IsLocalToUnit, IsDefinition,
 509       ScopeLine, fromRust(Flags), IsOptimized, unwrap<Function>(Fn),
 510       unwrapDIPtr<MDNode>(TParam), unwrapDIPtr<MDNode>(Decl)));
 511 #endif
 512 }
 513
 514 extern "C" LLVMRustMetadataRef
 515 LLVMRustDIBuilderCreateBasicType(LLVMRustDIBuilderRef Builder, const char *Name,
 516                                  uint64_t SizeInBits, uint64_t AlignInBits,
 517                                  unsigned Encoding) {
 518   return wrap(Builder->createBasicType(Name, SizeInBits,
 519 #if LLVM_VERSION_LE(3, 9)
 520                                        AlignInBits,
 521 #endif
 522                                        Encoding));
 523 }
 524
 525 extern "C" LLVMRustMetadataRef LLVMRustDIBuilderCreatePointerType(
 526     LLVMRustDIBuilderRef Builder, LLVMRustMetadataRef PointeeTy,
 527     uint64_t SizeInBits, uint64_t AlignInBits, const char *Name) {
 528   return wrap(Builder->createPointerType(unwrapDI<DIType>(PointeeTy),
 529                                          SizeInBits, AlignInBits, Name));
 530 }
 531
 532 extern "C" LLVMRustMetadataRef LLVMRustDIBuilderCreateStructType(
 533     LLVMRustDIBuilderRef Builder, LLVMRustMetadataRef Scope, const char *Name,
 534     LLVMRustMetadataRef File, unsigned LineNumber, uint64_t SizeInBits,
 535     uint64_t AlignInBits, LLVMRustDIFlags Flags,
 536     LLVMRustMetadataRef DerivedFrom, LLVMRustMetadataRef Elements,
 537     unsigned RunTimeLang, LLVMRustMetadataRef VTableHolder,
 538     const char *UniqueId) {
 539   return wrap(Builder->createStructType(
 540       unwrapDI<DIDescriptor>(Scope), Name, unwrapDI<DIFile>(File), LineNumber,
 541       SizeInBits, AlignInBits, fromRust(Flags), unwrapDI<DIType>(DerivedFrom),
 542       DINodeArray(unwrapDI<MDTuple>(Elements)), RunTimeLang,
 543       unwrapDI<DIType>(VTableHolder), UniqueId));
 544 }
 545
 546 extern "C" LLVMRustMetadataRef LLVMRustDIBuilderCreateMemberType(
 547     LLVMRustDIBuilderRef Builder, LLVMRustMetadataRef Scope, const char *Name,
 548     LLVMRustMetadataRef File, unsigned LineNo, uint64_t SizeInBits,
 549     uint64_t AlignInBits, uint64_t OffsetInBits, LLVMRustDIFlags Flags,
 550     LLVMRustMetadataRef Ty) {
 551   return wrap(Builder->createMemberType(unwrapDI<DIDescriptor>(Scope), Name,
 552                                         unwrapDI<DIFile>(File), LineNo,
 553                                         SizeInBits, AlignInBits, OffsetInBits,
 554                                         fromRust(Flags), unwrapDI<DIType>(Ty)));
 555 }
 556
 557 extern "C" LLVMRustMetadataRef LLVMRustDIBuilderCreateLexicalBlock(
 558     LLVMRustDIBuilderRef Builder, LLVMRustMetadataRef Scope,
 559     LLVMRustMetadataRef File, unsigned Line, unsigned Col) {
 560   return wrap(Builder->createLexicalBlock(unwrapDI<DIDescriptor>(Scope),
 561                                           unwrapDI<DIFile>(File), Line, Col));
 562 }
 563
 564 extern "C" LLVMRustMetadataRef
 565 LLVMRustDIBuilderCreateLexicalBlockFile(LLVMRustDIBuilderRef Builder,
 566                                         LLVMRustMetadataRef Scope,
 567                                         LLVMRustMetadataRef File) {
 568   return wrap(Builder->createLexicalBlockFile(unwrapDI<DIDescriptor>(Scope),
 569                                               unwrapDI<DIFile>(File)));
 570 }
 571
 572 extern "C" LLVMRustMetadataRef LLVMRustDIBuilderCreateStaticVariable(
 573     LLVMRustDIBuilderRef Builder, LLVMRustMetadataRef Context, const char *Name,
 574     const char *LinkageName, LLVMRustMetadataRef File, unsigned LineNo,
 575     LLVMRustMetadataRef Ty, bool IsLocalToUnit, LLVMValueRef V,
 576     LLVMRustMetadataRef Decl = nullptr, uint64_t AlignInBits = 0) {
 577   Constant *InitVal = cast<Constant>(unwrap(V));
 578
 579 #if LLVM_VERSION_GE(4, 0)
 580   llvm::DIExpression *InitExpr = nullptr;
 581   if (llvm::ConstantInt *IntVal = llvm::dyn_cast<llvm::ConstantInt>(InitVal)) {
 582     InitExpr = Builder->createConstantValueExpression(
 583         IntVal->getValue().getSExtValue());
 584   } else if (llvm::ConstantFP *FPVal =
 585                  llvm::dyn_cast<llvm::ConstantFP>(InitVal)) {
 586     InitExpr = Builder->createConstantValueExpression(
 587         FPVal->getValueAPF().bitcastToAPInt().getZExtValue());
 588   }
 589 #endif
 590
 591   return wrap(Builder->createGlobalVariable(
 592       unwrapDI<DIDescriptor>(Context), Name, LinkageName,
 593       unwrapDI<DIFile>(File), LineNo, unwrapDI<DIType>(Ty), IsLocalToUnit,
 594 #if LLVM_VERSION_GE(4, 0)
 595       InitExpr,
 596 #else
 597       InitVal,
 598 #endif
 599       unwrapDIPtr<MDNode>(Decl)
 600 #if LLVM_VERSION_GE(4, 0)
 601       ,
 602       AlignInBits
 603 #endif
 604       ));
 605 }
 606
 607 extern "C" LLVMRustMetadataRef LLVMRustDIBuilderCreateVariable(
 608     LLVMRustDIBuilderRef Builder, unsigned Tag, LLVMRustMetadataRef Scope,
 609     const char *Name, LLVMRustMetadataRef File, unsigned LineNo,
 610     LLVMRustMetadataRef Ty, bool AlwaysPreserve, LLVMRustDIFlags Flags,
 611     unsigned ArgNo, uint64_t AlignInBits) {
 612 #if LLVM_VERSION_GE(3, 8)
 613   if (Tag == 0x100) { // DW_TAG_auto_variable
 614     return wrap(Builder->createAutoVariable(
 615         unwrapDI<DIDescriptor>(Scope), Name, unwrapDI<DIFile>(File), LineNo,
 616         unwrapDI<DIType>(Ty), AlwaysPreserve, fromRust(Flags)
 617 #if LLVM_VERSION_GE(4, 0)
 618         ,
 619         AlignInBits
 620 #endif
 621         ));
 622   } else {
 623     return wrap(Builder->createParameterVariable(
 624         unwrapDI<DIDescriptor>(Scope), Name, ArgNo, unwrapDI<DIFile>(File),
 625         LineNo, unwrapDI<DIType>(Ty), AlwaysPreserve, fromRust(Flags)));
 626   }
 627 #else
 628   return wrap(Builder->createLocalVariable(
 629       Tag, unwrapDI<DIDescriptor>(Scope), Name, unwrapDI<DIFile>(File), LineNo,
 630       unwrapDI<DIType>(Ty), AlwaysPreserve, fromRust(Flags), ArgNo));
 631 #endif
 632 }
 633
 634 extern "C" LLVMRustMetadataRef
 635 LLVMRustDIBuilderCreateArrayType(LLVMRustDIBuilderRef Builder, uint64_t Size,
 636                                  uint64_t AlignInBits, LLVMRustMetadataRef Ty,
 637                                  LLVMRustMetadataRef Subscripts) {
 638   return wrap(
 639       Builder->createArrayType(Size, AlignInBits, unwrapDI<DIType>(Ty),
 640                                DINodeArray(unwrapDI<MDTuple>(Subscripts))));
 641 }
 642
 643 extern "C" LLVMRustMetadataRef
 644 LLVMRustDIBuilderCreateVectorType(LLVMRustDIBuilderRef Builder, uint64_t Size,
 645                                   uint64_t AlignInBits, LLVMRustMetadataRef Ty,
 646                                   LLVMRustMetadataRef Subscripts) {
 647   return wrap(
 648       Builder->createVectorType(Size, AlignInBits, unwrapDI<DIType>(Ty),
 649                                 DINodeArray(unwrapDI<MDTuple>(Subscripts))));
 650 }
 651
 652 extern "C" LLVMRustMetadataRef
 653 LLVMRustDIBuilderGetOrCreateSubrange(LLVMRustDIBuilderRef Builder, int64_t Lo,
 654                                      int64_t Count) {
 655   return wrap(Builder->getOrCreateSubrange(Lo, Count));
 656 }
 657
 658 extern "C" LLVMRustMetadataRef
 659 LLVMRustDIBuilderGetOrCreateArray(LLVMRustDIBuilderRef Builder,
 660                                   LLVMRustMetadataRef *Ptr, unsigned Count) {
 661   Metadata **DataValue = unwrap(Ptr);
 662   return wrap(
 663       Builder->getOrCreateArray(ArrayRef<Metadata *>(DataValue, Count)).get());
 664 }
 665
 666 extern "C" LLVMValueRef LLVMRustDIBuilderInsertDeclareAtEnd(
 667     LLVMRustDIBuilderRef Builder, LLVMValueRef V, LLVMRustMetadataRef VarInfo,
 668     int64_t *AddrOps, unsigned AddrOpsCount, LLVMValueRef DL,
 669     LLVMBasicBlockRef InsertAtEnd) {
 670   return wrap(Builder->insertDeclare(
 671       unwrap(V), unwrap<DILocalVariable>(VarInfo),
 672       Builder->createExpression(llvm::ArrayRef<int64_t>(AddrOps, AddrOpsCount)),
 673       DebugLoc(cast<MDNode>(unwrap<MetadataAsValue>(DL)->getMetadata())),
 674       unwrap(InsertAtEnd)));
 675 }
 676
 677 extern "C" LLVMRustMetadataRef
 678 LLVMRustDIBuilderCreateEnumerator(LLVMRustDIBuilderRef Builder,
 679                                   const char *Name, uint64_t Val) {
 680   return wrap(Builder->createEnumerator(Name, Val));
 681 }
 682
 683 extern "C" LLVMRustMetadataRef LLVMRustDIBuilderCreateEnumerationType(
 684     LLVMRustDIBuilderRef Builder, LLVMRustMetadataRef Scope, const char *Name,
 685     LLVMRustMetadataRef File, unsigned LineNumber, uint64_t SizeInBits,
 686     uint64_t AlignInBits, LLVMRustMetadataRef Elements,
 687     LLVMRustMetadataRef ClassTy) {
 688   return wrap(Builder->createEnumerationType(
 689       unwrapDI<DIDescriptor>(Scope), Name, unwrapDI<DIFile>(File), LineNumber,
 690       SizeInBits, AlignInBits, DINodeArray(unwrapDI<MDTuple>(Elements)),
 691       unwrapDI<DIType>(ClassTy)));
 692 }
 693
 694 extern "C" LLVMRustMetadataRef LLVMRustDIBuilderCreateUnionType(
 695     LLVMRustDIBuilderRef Builder, LLVMRustMetadataRef Scope, const char *Name,
 696     LLVMRustMetadataRef File, unsigned LineNumber, uint64_t SizeInBits,
 697     uint64_t AlignInBits, LLVMRustDIFlags Flags, LLVMRustMetadataRef Elements,
 698     unsigned RunTimeLang, const char *UniqueId) {
 699   return wrap(Builder->createUnionType(
 700       unwrapDI<DIDescriptor>(Scope), Name, unwrapDI<DIFile>(File), LineNumber,
 701       SizeInBits, AlignInBits, fromRust(Flags),
 702       DINodeArray(unwrapDI<MDTuple>(Elements)), RunTimeLang, UniqueId));
 703 }
 704
 705 extern "C" LLVMRustMetadataRef LLVMRustDIBuilderCreateTemplateTypeParameter(
 706     LLVMRustDIBuilderRef Builder, LLVMRustMetadataRef Scope, const char *Name,
 707     LLVMRustMetadataRef Ty, LLVMRustMetadataRef File, unsigned LineNo,
 708     unsigned ColumnNo) {
 709   return wrap(Builder->createTemplateTypeParameter(
 710       unwrapDI<DIDescriptor>(Scope), Name, unwrapDI<DIType>(Ty)));
 711 }
 712
 713 extern "C" LLVMRustMetadataRef
 714 LLVMRustDIBuilderCreateNameSpace(LLVMRustDIBuilderRef Builder,
 715                                  LLVMRustMetadataRef Scope, const char *Name,
 716                                  LLVMRustMetadataRef File, unsigned LineNo) {
 717   return wrap(Builder->createNameSpace(
 718       unwrapDI<DIDescriptor>(Scope), Name, unwrapDI<DIFile>(File), LineNo
 719 #if LLVM_VERSION_GE(4, 0)
 720       ,
 721       false // ExportSymbols (only relevant for C++ anonymous namespaces)
 722 #endif
 723       ));
 724 }
 725
 726 extern "C" void
 727 LLVMRustDICompositeTypeSetTypeArray(LLVMRustDIBuilderRef Builder,
 728                                     LLVMRustMetadataRef CompositeTy,
 729                                     LLVMRustMetadataRef TyArray) {
 730   DICompositeType *Tmp = unwrapDI<DICompositeType>(CompositeTy);
 731   Builder->replaceArrays(Tmp, DINodeArray(unwrap<MDTuple>(TyArray)));
 732 }
 733
 734 extern "C" LLVMValueRef
 735 LLVMRustDIBuilderCreateDebugLocation(LLVMContextRef ContextRef, unsigned Line,
 736                                      unsigned Column, LLVMRustMetadataRef Scope,
 737                                      LLVMRustMetadataRef InlinedAt) {
 738   LLVMContext &Context = *unwrap(ContextRef);
 739
 740   DebugLoc debug_loc = DebugLoc::get(Line, Column, unwrapDIPtr<MDNode>(Scope),
 741                                      unwrapDIPtr<MDNode>(InlinedAt));
 742
 743   return wrap(MetadataAsValue::get(Context, debug_loc.getAsMDNode()));
 744 }
 745
 746 extern "C" int64_t LLVMRustDIBuilderCreateOpDeref() {
 747   return dwarf::DW_OP_deref;
 748 }
 749
 750 extern "C" int64_t LLVMRustDIBuilderCreateOpPlus() { return dwarf::DW_OP_plus; }
 751
 752 extern "C" void LLVMRustWriteTypeToString(LLVMTypeRef Ty, RustStringRef Str) {
 753   RawRustStringOstream OS(Str);
 754   unwrap<llvm::Type>(Ty)->print(OS);
 755 }
 756
 757 extern "C" void LLVMRustWriteValueToString(LLVMValueRef V,
 758                                            RustStringRef Str) {
 759   RawRustStringOstream OS(Str);
 760   OS << "(";
 761   unwrap<llvm::Value>(V)->getType()->print(OS);
 762   OS << ":";
 763   unwrap<llvm::Value>(V)->print(OS);
 764   OS << ")";
 765 }
 766
 767 extern "C" bool LLVMRustLinkInExternalBitcode(LLVMModuleRef DstRef, char *BC,
 768                                               size_t Len) {
 769   Module *Dst = unwrap(DstRef);
 770
 771   std::unique_ptr<MemoryBuffer> Buf =
 772       MemoryBuffer::getMemBufferCopy(StringRef(BC, Len));
 773
 774 #if LLVM_VERSION_GE(4, 0)
 775   Expected<std::unique_ptr<Module>> SrcOrError =
 776       llvm::getLazyBitcodeModule(Buf->getMemBufferRef(), Dst->getContext());
 777   if (!SrcOrError) {
 778     LLVMRustSetLastError(toString(SrcOrError.takeError()).c_str());
 779     return false;
 780   }
 781
 782   auto Src = std::move(*SrcOrError);
 783 #else
 784   ErrorOr<std::unique_ptr<Module>> Src =
 785       llvm::getLazyBitcodeModule(std::move(Buf), Dst->getContext());
 786   if (!Src) {
 787     LLVMRustSetLastError(Src.getError().message().c_str());
 788     return false;
 789   }
 790 #endif
 791
 792   std::string Err;
 793
 794   raw_string_ostream Stream(Err);
 795   DiagnosticPrinterRawOStream DP(Stream);
 796 #if LLVM_VERSION_GE(4, 0)
 797   if (Linker::linkModules(*Dst, std::move(Src))) {
 798 #elif LLVM_VERSION_GE(3, 8)
 799   if (Linker::linkModules(*Dst, std::move(Src.get()))) {
 800 #else
 801   if (Linker::LinkModules(Dst, Src->get(),
 802                           [&](const DiagnosticInfo &DI) { DI.print(DP); })) {
 803 #endif
 804     LLVMRustSetLastError(Err.c_str());
 805     return false;
 806   }
 807   return true;
 808 }
 809
 810 // Note that the two following functions look quite similar to the
 811 // LLVMGetSectionName function. Sadly, it appears that this function only
 812 // returns a char* pointer, which isn't guaranteed to be null-terminated. The
 813 // function provided by LLVM doesn't return the length, so we've created our own
 814 // function which returns the length as well as the data pointer.
 815 //
 816 // For an example of this not returning a null terminated string, see
 817 // lib/Object/COFFObjectFile.cpp in the getSectionName function. One of the
 818 // branches explicitly creates a StringRef without a null terminator, and then
 819 // that's returned.
 820
 821 inline section_iterator *unwrap(LLVMSectionIteratorRef SI) {
 822   return reinterpret_cast<section_iterator *>(SI);
 823 }
 824
 825 extern "C" size_t LLVMRustGetSectionName(LLVMSectionIteratorRef SI,
 826                                          const char **Ptr) {
 827   StringRef Ret;
 828   if (std::error_code EC = (*unwrap(SI))->getName(Ret))
 829     report_fatal_error(EC.message());
 830   *Ptr = Ret.data();
 831   return Ret.size();
 832 }
 833
 834 // LLVMArrayType function does not support 64-bit ElementCount
 835 extern "C" LLVMTypeRef LLVMRustArrayType(LLVMTypeRef ElementTy,
 836                                          uint64_t ElementCount) {
 837   return wrap(ArrayType::get(unwrap(ElementTy), ElementCount));
 838 }
 839
 840 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Twine, LLVMTwineRef)
 841 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(DebugLoc, LLVMDebugLocRef)
 842
 843 extern "C" void LLVMRustWriteTwineToString(LLVMTwineRef T, RustStringRef Str) {
 844   RawRustStringOstream OS(Str);
 845   unwrap(T)->print(OS);
 846 }
 847
 848 extern "C" void LLVMRustUnpackOptimizationDiagnostic(
 849     LLVMDiagnosticInfoRef DI, RustStringRef PassNameOut,
 850     LLVMValueRef *FunctionOut, LLVMDebugLocRef *DebugLocOut,
 851     RustStringRef MessageOut) {
 852   // Undefined to call this not on an optimization diagnostic!
 853   llvm::DiagnosticInfoOptimizationBase *Opt =
 854       static_cast<llvm::DiagnosticInfoOptimizationBase *>(unwrap(DI));
 855
 856   RawRustStringOstream PassNameOS(PassNameOut);
 857   PassNameOS << Opt->getPassName();
 858   *FunctionOut = wrap(&Opt->getFunction());
 859   *DebugLocOut = wrap(&Opt->getDebugLoc());
 860   RawRustStringOstream MessageOS(MessageOut);
 861   MessageOS << Opt->getMsg();
 862 }
 863
 864 extern "C" void
 865 LLVMRustUnpackInlineAsmDiagnostic(LLVMDiagnosticInfoRef DI, unsigned *CookieOut,
 866                                   LLVMTwineRef *MessageOut,
 867                                   LLVMValueRef *InstructionOut) {
 868   // Undefined to call this not on an inline assembly diagnostic!
 869   llvm::DiagnosticInfoInlineAsm *IA =
 870       static_cast<llvm::DiagnosticInfoInlineAsm *>(unwrap(DI));
 871
 872   *CookieOut = IA->getLocCookie();
 873   *MessageOut = wrap(&IA->getMsgStr());
 874   *InstructionOut = wrap(IA->getInstruction());
 875 }
 876
 877 extern "C" void LLVMRustWriteDiagnosticInfoToString(LLVMDiagnosticInfoRef DI,
 878                                                     RustStringRef Str) {
 879   RawRustStringOstream OS(Str);
 880   DiagnosticPrinterRawOStream DP(OS);
 881   unwrap(DI)->print(DP);
 882 }
 883
 884 enum class LLVMRustDiagnosticKind {
 885   Other,
 886   InlineAsm,
 887   StackSize,
 888   DebugMetadataVersion,
 889   SampleProfile,
 890   OptimizationRemark,
 891   OptimizationRemarkMissed,
 892   OptimizationRemarkAnalysis,
 893   OptimizationRemarkAnalysisFPCommute,
 894   OptimizationRemarkAnalysisAliasing,
 895   OptimizationRemarkOther,
 896   OptimizationFailure,
 897 };
 898
 899 static LLVMRustDiagnosticKind toRust(DiagnosticKind Kind) {
 900   switch (Kind) {
 901   case DK_InlineAsm:
 902     return LLVMRustDiagnosticKind::InlineAsm;
 903   case DK_StackSize:
 904     return LLVMRustDiagnosticKind::StackSize;
 905   case DK_DebugMetadataVersion:
 906     return LLVMRustDiagnosticKind::DebugMetadataVersion;
 907   case DK_SampleProfile:
 908     return LLVMRustDiagnosticKind::SampleProfile;
 909   case DK_OptimizationRemark:
 910     return LLVMRustDiagnosticKind::OptimizationRemark;
 911   case DK_OptimizationRemarkMissed:
 912     return LLVMRustDiagnosticKind::OptimizationRemarkMissed;
 913   case DK_OptimizationRemarkAnalysis:
 914     return LLVMRustDiagnosticKind::OptimizationRemarkAnalysis;
 915 #if LLVM_VERSION_GE(3, 8)
 916   case DK_OptimizationRemarkAnalysisFPCommute:
 917     return LLVMRustDiagnosticKind::OptimizationRemarkAnalysisFPCommute;
 918   case DK_OptimizationRemarkAnalysisAliasing:
 919     return LLVMRustDiagnosticKind::OptimizationRemarkAnalysisAliasing;
 920 #endif
 921   default:
 922 #if LLVM_VERSION_GE(3, 9)
 923     return (Kind >= DK_FirstRemark && Kind <= DK_LastRemark)
 924                ? LLVMRustDiagnosticKind::OptimizationRemarkOther
 925                : LLVMRustDiagnosticKind::Other;
 926 #else
 927     return LLVMRustDiagnosticKind::Other;
 928 #endif
 929   }
 930 }
 931
 932 extern "C" LLVMRustDiagnosticKind
 933 LLVMRustGetDiagInfoKind(LLVMDiagnosticInfoRef DI) {
 934   return toRust((DiagnosticKind)unwrap(DI)->getKind());
 935 }
 936 // This is kept distinct from LLVMGetTypeKind, because when
 937 // a new type kind is added, the Rust-side enum must be
 938 // updated or UB will result.
 939 extern "C" LLVMTypeKind LLVMRustGetTypeKind(LLVMTypeRef Ty) {
 940   switch (unwrap(Ty)->getTypeID()) {
 941   case Type::VoidTyID:
 942     return LLVMVoidTypeKind;
 943   case Type::HalfTyID:
 944     return LLVMHalfTypeKind;
 945   case Type::FloatTyID:
 946     return LLVMFloatTypeKind;
 947   case Type::DoubleTyID:
 948     return LLVMDoubleTypeKind;
 949   case Type::X86_FP80TyID:
 950     return LLVMX86_FP80TypeKind;
 951   case Type::FP128TyID:
 952     return LLVMFP128TypeKind;
 953   case Type::PPC_FP128TyID:
 954     return LLVMPPC_FP128TypeKind;
 955   case Type::LabelTyID:
 956     return LLVMLabelTypeKind;
 957   case Type::MetadataTyID:
 958     return LLVMMetadataTypeKind;
 959   case Type::IntegerTyID:
 960     return LLVMIntegerTypeKind;
 961   case Type::FunctionTyID:
 962     return LLVMFunctionTypeKind;
 963   case Type::StructTyID:
 964     return LLVMStructTypeKind;
 965   case Type::ArrayTyID:
 966     return LLVMArrayTypeKind;
 967   case Type::PointerTyID:
 968     return LLVMPointerTypeKind;
 969   case Type::VectorTyID:
 970     return LLVMVectorTypeKind;
 971   case Type::X86_MMXTyID:
 972     return LLVMX86_MMXTypeKind;
 973 #if LLVM_VERSION_GE(3, 8)
 974   case Type::TokenTyID:
 975     return LLVMTokenTypeKind;
 976 #endif
 977   }
 978   llvm_unreachable("Unhandled TypeID.");
 979 }
 980
 981 extern "C" void LLVMRustWriteDebugLocToString(LLVMContextRef C,
 982                                               LLVMDebugLocRef DL,
 983                                               RustStringRef Str) {
 984   RawRustStringOstream OS(Str);
 985   unwrap(DL)->print(OS);
 986 }
 987
 988 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(SMDiagnostic, LLVMSMDiagnosticRef)
 989
 990 extern "C" void LLVMRustSetInlineAsmDiagnosticHandler(
 991     LLVMContextRef C, LLVMContext::InlineAsmDiagHandlerTy H, void *CX) {
 992   unwrap(C)->setInlineAsmDiagnosticHandler(H, CX);
 993 }
 994
 995 extern "C" void LLVMRustWriteSMDiagnosticToString(LLVMSMDiagnosticRef D,
 996                                                   RustStringRef Str) {
 997   RawRustStringOstream OS(Str);
 998   unwrap(D)->print("", OS);
 999 }
1000
1001 extern "C" LLVMValueRef
1002 LLVMRustBuildLandingPad(LLVMBuilderRef B, LLVMTypeRef Ty,
1003                         LLVMValueRef PersFn, unsigned NumClauses,
1004                         const char *Name, LLVMValueRef F) {
1005   return LLVMBuildLandingPad(B, Ty, PersFn, NumClauses, Name);
1006 }
1007
1008 extern "C" LLVMValueRef LLVMRustBuildCleanupPad(LLVMBuilderRef B,
1009                                                 LLVMValueRef ParentPad,
1010                                                 unsigned ArgCount,
1011                                                 LLVMValueRef *LLArgs,
1012                                                 const char *Name) {
1013 #if LLVM_VERSION_GE(3, 8)
1014   Value **Args = unwrap(LLArgs);
1015   if (ParentPad == nullptr) {
1016     Type *Ty = Type::getTokenTy(unwrap(B)->getContext());
1017     ParentPad = wrap(Constant::getNullValue(Ty));
1018   }
1019   return wrap(unwrap(B)->CreateCleanupPad(
1020       unwrap(ParentPad), ArrayRef<Value *>(Args, ArgCount), Name));
1021 #else
1022   return nullptr;
1023 #endif
1024 }
1025
1026 extern "C" LLVMValueRef LLVMRustBuildCleanupRet(LLVMBuilderRef B,
1027                                                 LLVMValueRef CleanupPad,
1028                                                 LLVMBasicBlockRef UnwindBB) {
1029 #if LLVM_VERSION_GE(3, 8)
1030   CleanupPadInst *Inst = cast<CleanupPadInst>(unwrap(CleanupPad));
1031   return wrap(unwrap(B)->CreateCleanupRet(Inst, unwrap(UnwindBB)));
1032 #else
1033   return nullptr;
1034 #endif
1035 }
1036
1037 extern "C" LLVMValueRef
1038 LLVMRustBuildCatchPad(LLVMBuilderRef B, LLVMValueRef ParentPad,
1039                       unsigned ArgCount, LLVMValueRef *LLArgs, const char *Name) {
1040 #if LLVM_VERSION_GE(3, 8)
1041   Value **Args = unwrap(LLArgs);
1042   return wrap(unwrap(B)->CreateCatchPad(
1043       unwrap(ParentPad), ArrayRef<Value *>(Args, ArgCount), Name));
1044 #else
1045   return nullptr;
1046 #endif
1047 }
1048
1049 extern "C" LLVMValueRef LLVMRustBuildCatchRet(LLVMBuilderRef B,
1050                                               LLVMValueRef Pad,
1051                                               LLVMBasicBlockRef BB) {
1052 #if LLVM_VERSION_GE(3, 8)
1053   return wrap(unwrap(B)->CreateCatchRet(cast<CatchPadInst>(unwrap(Pad)),
1054                                               unwrap(BB)));
1055 #else
1056   return nullptr;
1057 #endif
1058 }
1059
1060 extern "C" LLVMValueRef LLVMRustBuildCatchSwitch(LLVMBuilderRef B,
1061                                                  LLVMValueRef ParentPad,
1062                                                  LLVMBasicBlockRef BB,
1063                                                  unsigned NumHandlers,
1064                                                  const char *Name) {
1065 #if LLVM_VERSION_GE(3, 8)
1066   if (ParentPad == nullptr) {
1067     Type *Ty = Type::getTokenTy(unwrap(B)->getContext());
1068     ParentPad = wrap(Constant::getNullValue(Ty));
1069   }
1070   return wrap(unwrap(B)->CreateCatchSwitch(unwrap(ParentPad), unwrap(BB),
1071                                                  NumHandlers, Name));
1072 #else
1073   return nullptr;
1074 #endif
1075 }
1076
1077 extern "C" void LLVMRustAddHandler(LLVMValueRef CatchSwitchRef,
1078                                    LLVMBasicBlockRef Handler) {
1079 #if LLVM_VERSION_GE(3, 8)
1080   Value *CatchSwitch = unwrap(CatchSwitchRef);
1081   cast<CatchSwitchInst>(CatchSwitch)->addHandler(unwrap(Handler));
1082 #endif
1083 }
1084
1085 #if LLVM_VERSION_GE(3, 8)
1086 extern "C" OperandBundleDef *LLVMRustBuildOperandBundleDef(const char *Name,
1087                                                            LLVMValueRef *Inputs,
1088                                                            unsigned NumInputs) {
1089   return new OperandBundleDef(Name, makeArrayRef(unwrap(Inputs), NumInputs));
1090 }
1091
1092 extern "C" void LLVMRustFreeOperandBundleDef(OperandBundleDef *Bundle) {
1093   delete Bundle;
1094 }
1095
1096 extern "C" LLVMValueRef LLVMRustBuildCall(LLVMBuilderRef B, LLVMValueRef Fn,
1097                                           LLVMValueRef *Args, unsigned NumArgs,
1098                                           OperandBundleDef *Bundle,
1099                                           const char *Name) {
1100   unsigned Len = Bundle ? 1 : 0;
1101   ArrayRef<OperandBundleDef> Bundles = makeArrayRef(Bundle, Len);
1102   return wrap(unwrap(B)->CreateCall(
1103       unwrap(Fn), makeArrayRef(unwrap(Args), NumArgs), Bundles, Name));
1104 }
1105
1106 extern "C" LLVMValueRef
1107 LLVMRustBuildInvoke(LLVMBuilderRef B, LLVMValueRef Fn, LLVMValueRef *Args,
1108                     unsigned NumArgs, LLVMBasicBlockRef Then,
1109                     LLVMBasicBlockRef Catch, OperandBundleDef *Bundle,
1110                     const char *Name) {
1111   unsigned Len = Bundle ? 1 : 0;
1112   ArrayRef<OperandBundleDef> Bundles = makeArrayRef(Bundle, Len);
1113   return wrap(unwrap(B)->CreateInvoke(unwrap(Fn), unwrap(Then), unwrap(Catch),
1114                                       makeArrayRef(unwrap(Args), NumArgs),
1115                                       Bundles, Name));
1116 }
1117 #else
1118 extern "C" void *LLVMRustBuildOperandBundleDef(const char *Name,
1119                                                LLVMValueRef *Inputs,
1120                                                unsigned NumInputs) {
1121   return nullptr;
1122 }
1123
1124 extern "C" void LLVMRustFreeOperandBundleDef(void *Bundle) {}
1125
1126 extern "C" LLVMValueRef LLVMRustBuildCall(LLVMBuilderRef B, LLVMValueRef Fn,
1127                                           LLVMValueRef *Args, unsigned NumArgs,
1128                                           void *Bundle, const char *Name) {
1129   return LLVMBuildCall(B, Fn, Args, NumArgs, Name);
1130 }
1131
1132 extern "C" LLVMValueRef
1133 LLVMRustBuildInvoke(LLVMBuilderRef B, LLVMValueRef Fn, LLVMValueRef *Args,
1134                     unsigned NumArgs, LLVMBasicBlockRef Then,
1135                     LLVMBasicBlockRef Catch, void *Bundle, const char *Name) {
1136   return LLVMBuildInvoke(B, Fn, Args, NumArgs, Then, Catch, Name);
1137 }
1138 #endif
1139
1140 extern "C" void LLVMRustPositionBuilderAtStart(LLVMBuilderRef B,
1141                                                LLVMBasicBlockRef BB) {
1142   auto Point = unwrap(BB)->getFirstInsertionPt();
1143   unwrap(B)->SetInsertPoint(unwrap(BB), Point);
1144 }
1145
1146 extern "C" void LLVMRustSetComdat(LLVMModuleRef M, LLVMValueRef V,
1147                                   const char *Name) {
1148   Triple TargetTriple(unwrap(M)->getTargetTriple());
1149   GlobalObject *GV = unwrap<GlobalObject>(V);
1150   if (!TargetTriple.isOSBinFormatMachO()) {
1151     GV->setComdat(unwrap(M)->getOrInsertComdat(Name));
1152   }
1153 }
1154
1155 extern "C" void LLVMRustUnsetComdat(LLVMValueRef V) {
1156   GlobalObject *GV = unwrap<GlobalObject>(V);
1157   GV->setComdat(nullptr);
1158 }
1159
1160 enum class LLVMRustLinkage {
1161   ExternalLinkage = 0,
1162   AvailableExternallyLinkage = 1,
1163   LinkOnceAnyLinkage = 2,
1164   LinkOnceODRLinkage = 3,
1165   WeakAnyLinkage = 4,
1166   WeakODRLinkage = 5,
1167   AppendingLinkage = 6,
1168   InternalLinkage = 7,
1169   PrivateLinkage = 8,
1170   ExternalWeakLinkage = 9,
1171   CommonLinkage = 10,
1172 };
1173
1174 static LLVMRustLinkage toRust(LLVMLinkage Linkage) {
1175   switch (Linkage) {
1176   case LLVMExternalLinkage:
1177     return LLVMRustLinkage::ExternalLinkage;
1178   case LLVMAvailableExternallyLinkage:
1179     return LLVMRustLinkage::AvailableExternallyLinkage;
1180   case LLVMLinkOnceAnyLinkage:
1181     return LLVMRustLinkage::LinkOnceAnyLinkage;
1182   case LLVMLinkOnceODRLinkage:
1183     return LLVMRustLinkage::LinkOnceODRLinkage;
1184   case LLVMWeakAnyLinkage:
1185     return LLVMRustLinkage::WeakAnyLinkage;
1186   case LLVMWeakODRLinkage:
1187     return LLVMRustLinkage::WeakODRLinkage;
1188   case LLVMAppendingLinkage:
1189     return LLVMRustLinkage::AppendingLinkage;
1190   case LLVMInternalLinkage:
1191     return LLVMRustLinkage::InternalLinkage;
1192   case LLVMPrivateLinkage:
1193     return LLVMRustLinkage::PrivateLinkage;
1194   case LLVMExternalWeakLinkage:
1195     return LLVMRustLinkage::ExternalWeakLinkage;
1196   case LLVMCommonLinkage:
1197     return LLVMRustLinkage::CommonLinkage;
1198   default:
1199     llvm_unreachable("Invalid LLVMRustLinkage value!");
1200   }
1201 }
1202
1203 static LLVMLinkage fromRust(LLVMRustLinkage Linkage) {
1204   switch (Linkage) {
1205   case LLVMRustLinkage::ExternalLinkage:
1206     return LLVMExternalLinkage;
1207   case LLVMRustLinkage::AvailableExternallyLinkage:
1208     return LLVMAvailableExternallyLinkage;
1209   case LLVMRustLinkage::LinkOnceAnyLinkage:
1210     return LLVMLinkOnceAnyLinkage;
1211   case LLVMRustLinkage::LinkOnceODRLinkage:
1212     return LLVMLinkOnceODRLinkage;
1213   case LLVMRustLinkage::WeakAnyLinkage:
1214     return LLVMWeakAnyLinkage;
1215   case LLVMRustLinkage::WeakODRLinkage:
1216     return LLVMWeakODRLinkage;
1217   case LLVMRustLinkage::AppendingLinkage:
1218     return LLVMAppendingLinkage;
1219   case LLVMRustLinkage::InternalLinkage:
1220     return LLVMInternalLinkage;
1221   case LLVMRustLinkage::PrivateLinkage:
1222     return LLVMPrivateLinkage;
1223   case LLVMRustLinkage::ExternalWeakLinkage:
1224     return LLVMExternalWeakLinkage;
1225   case LLVMRustLinkage::CommonLinkage:
1226     return LLVMCommonLinkage;
1227   }
1228   llvm_unreachable("Invalid LLVMRustLinkage value!");
1229 }
1230
1231 extern "C" LLVMRustLinkage LLVMRustGetLinkage(LLVMValueRef V) {
1232   return toRust(LLVMGetLinkage(V));
1233 }
1234
1235 extern "C" void LLVMRustSetLinkage(LLVMValueRef V,
1236                                    LLVMRustLinkage RustLinkage) {
1237   LLVMSetLinkage(V, fromRust(RustLinkage));
1238 }
1239
1240 // Returns true if both high and low were successfully set. Fails in case constant wasn’t any of
1241 // the common sizes (1, 8, 16, 32, 64, 128 bits)
1242 extern "C" bool LLVMRustConstInt128Get(LLVMValueRef CV, bool sext, uint64_t *high, uint64_t *low)
1243 {
1244     auto C = unwrap<llvm::ConstantInt>(CV);
1245     if (C->getBitWidth() > 128) { return false; }
1246     APInt AP;
1247     if (sext) {
1248         AP = C->getValue().sextOrSelf(128);
1249     } else {
1250         AP = C->getValue().zextOrSelf(128);
1251     }
1252     *low = AP.getLoBits(64).getZExtValue();
1253     *high = AP.getHiBits(64).getZExtValue();
1254     return true;
1255 }
1256
1257 extern "C" LLVMContextRef LLVMRustGetValueContext(LLVMValueRef V) {
1258   return wrap(&unwrap(V)->getContext());
1259 }
1260
1261 enum class LLVMRustVisibility {
1262   Default = 0,
1263   Hidden = 1,
1264   Protected = 2,
1265 };
1266
1267 static LLVMRustVisibility toRust(LLVMVisibility Vis) {
1268   switch (Vis) {
1269   case LLVMDefaultVisibility:
1270     return LLVMRustVisibility::Default;
1271   case LLVMHiddenVisibility:
1272     return LLVMRustVisibility::Hidden;
1273   case LLVMProtectedVisibility:
1274     return LLVMRustVisibility::Protected;
1275   }
1276   llvm_unreachable("Invalid LLVMRustVisibility value!");
1277 }
1278
1279 static LLVMVisibility fromRust(LLVMRustVisibility Vis) {
1280   switch (Vis) {
1281   case LLVMRustVisibility::Default:
1282     return LLVMDefaultVisibility;
1283   case LLVMRustVisibility::Hidden:
1284     return LLVMHiddenVisibility;
1285   case LLVMRustVisibility::Protected:
1286     return LLVMProtectedVisibility;
1287   }
1288   llvm_unreachable("Invalid LLVMRustVisibility value!");
1289 }
1290
1291 extern "C" LLVMRustVisibility LLVMRustGetVisibility(LLVMValueRef V) {
1292   return toRust(LLVMGetVisibility(V));
1293 }
1294
1295 extern "C" void LLVMRustSetVisibility(LLVMValueRef V,
1296                                       LLVMRustVisibility RustVisibility) {
1297   LLVMSetVisibility(V, fromRust(RustVisibility));
1298 }