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