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