src/rustllvm/RustWrapper.cpp

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