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