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