lib/Analysis/TargetLibraryInfo.cpp

   1 //===-- TargetLibraryInfo.cpp - Runtime library information ----------------==//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements the TargetLibraryInfo class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/Analysis/TargetLibraryInfo.h"
  15 #include "llvm/ADT/Triple.h"
  16 using namespace llvm;
  17
  18 const char *const TargetLibraryInfoImpl::StandardNames[LibFunc::NumLibFuncs] = {
  19 #define TLI_DEFINE_STRING
  20 #include "llvm/Analysis/TargetLibraryInfo.def"
  21 };
  22
  23 static bool hasSinCosPiStret(const Triple &T) {
  24   // Only Darwin variants have _stret versions of combined trig functions.
  25   if (!T.isOSDarwin())
  26     return false;
  27
  28   // The ABI is rather complicated on x86, so don't do anything special there.
  29   if (T.getArch() == Triple::x86)
  30     return false;
  31
  32   if (T.isMacOSX() && T.isMacOSXVersionLT(10, 9))
  33     return false;
  34
  35   if (T.isiOS() && T.isOSVersionLT(7, 0))
  36     return false;
  37
  38   return true;
  39 }
  40
  41 /// initialize - Initialize the set of available library functions based on the
  42 /// specified target triple.  This should be carefully written so that a missing
  43 /// target triple gets a sane set of defaults.
  44 static void initialize(TargetLibraryInfoImpl &TLI, const Triple &T,
  45                        const char *const *StandardNames) {
  46 #ifndef NDEBUG
  47   // Verify that the StandardNames array is in alphabetical order.
  48   for (unsigned F = 1; F < LibFunc::NumLibFuncs; ++F) {
  49     if (strcmp(StandardNames[F-1], StandardNames[F]) >= 0)
  50       llvm_unreachable("TargetLibraryInfoImpl function names must be sorted");
  51   }
  52 #endif // !NDEBUG
  53
  54   // There are no library implementations of mempcy and memset for AMD gpus and
  55   // these can be difficult to lower in the backend.
  56   if (T.getArch() == Triple::r600 ||
  57       T.getArch() == Triple::amdgcn) {
  58     TLI.setUnavailable(LibFunc::memcpy);
  59     TLI.setUnavailable(LibFunc::memset);
  60     TLI.setUnavailable(LibFunc::memset_pattern16);
  61     return;
  62   }
  63
  64   // memset_pattern16 is only available on iOS 3.0 and Mac OS X 10.5 and later.
  65   if (T.isMacOSX()) {
  66     if (T.isMacOSXVersionLT(10, 5))
  67       TLI.setUnavailable(LibFunc::memset_pattern16);
  68   } else if (T.isiOS()) {
  69     if (T.isOSVersionLT(3, 0))
  70       TLI.setUnavailable(LibFunc::memset_pattern16);
  71   } else {
  72     TLI.setUnavailable(LibFunc::memset_pattern16);
  73   }
  74
  75   if (!hasSinCosPiStret(T)) {
  76     TLI.setUnavailable(LibFunc::sinpi);
  77     TLI.setUnavailable(LibFunc::sinpif);
  78     TLI.setUnavailable(LibFunc::cospi);
  79     TLI.setUnavailable(LibFunc::cospif);
  80     TLI.setUnavailable(LibFunc::sincospi_stret);
  81     TLI.setUnavailable(LibFunc::sincospif_stret);
  82   }
  83
  84   if (T.isMacOSX() && T.getArch() == Triple::x86 &&
  85       !T.isMacOSXVersionLT(10, 7)) {
  86     // x86-32 OSX has a scheme where fwrite and fputs (and some other functions
  87     // we don't care about) have two versions; on recent OSX, the one we want
  88     // has a $UNIX2003 suffix. The two implementations are identical except
  89     // for the return value in some edge cases.  However, we don't want to
  90     // generate code that depends on the old symbols.
  91     TLI.setAvailableWithName(LibFunc::fwrite, "fwrite$UNIX2003");
  92     TLI.setAvailableWithName(LibFunc::fputs, "fputs$UNIX2003");
  93   }
  94
  95   // iprintf and friends are only available on XCore and TCE.
  96   if (T.getArch() != Triple::xcore && T.getArch() != Triple::tce) {
  97     TLI.setUnavailable(LibFunc::iprintf);
  98     TLI.setUnavailable(LibFunc::siprintf);
  99     TLI.setUnavailable(LibFunc::fiprintf);
 100   }
 101
 102   if (T.isOSWindows() && !T.isOSCygMing()) {
 103     // Win32 does not support long double
 104     TLI.setUnavailable(LibFunc::acosl);
 105     TLI.setUnavailable(LibFunc::asinl);
 106     TLI.setUnavailable(LibFunc::atanl);
 107     TLI.setUnavailable(LibFunc::atan2l);
 108     TLI.setUnavailable(LibFunc::ceill);
 109     TLI.setUnavailable(LibFunc::copysignl);
 110     TLI.setUnavailable(LibFunc::cosl);
 111     TLI.setUnavailable(LibFunc::coshl);
 112     TLI.setUnavailable(LibFunc::expl);
 113     TLI.setUnavailable(LibFunc::fabsf); // Win32 and Win64 both lack fabsf
 114     TLI.setUnavailable(LibFunc::fabsl);
 115     TLI.setUnavailable(LibFunc::floorl);
 116     TLI.setUnavailable(LibFunc::fmaxl);
 117     TLI.setUnavailable(LibFunc::fminl);
 118     TLI.setUnavailable(LibFunc::fmodl);
 119     TLI.setUnavailable(LibFunc::frexpl);
 120     TLI.setUnavailable(LibFunc::ldexpf);
 121     TLI.setUnavailable(LibFunc::ldexpl);
 122     TLI.setUnavailable(LibFunc::logl);
 123     TLI.setUnavailable(LibFunc::modfl);
 124     TLI.setUnavailable(LibFunc::powl);
 125     TLI.setUnavailable(LibFunc::sinl);
 126     TLI.setUnavailable(LibFunc::sinhl);
 127     TLI.setUnavailable(LibFunc::sqrtl);
 128     TLI.setUnavailable(LibFunc::tanl);
 129     TLI.setUnavailable(LibFunc::tanhl);
 130
 131     // Win32 only has C89 math
 132     TLI.setUnavailable(LibFunc::acosh);
 133     TLI.setUnavailable(LibFunc::acoshf);
 134     TLI.setUnavailable(LibFunc::acoshl);
 135     TLI.setUnavailable(LibFunc::asinh);
 136     TLI.setUnavailable(LibFunc::asinhf);
 137     TLI.setUnavailable(LibFunc::asinhl);
 138     TLI.setUnavailable(LibFunc::atanh);
 139     TLI.setUnavailable(LibFunc::atanhf);
 140     TLI.setUnavailable(LibFunc::atanhl);
 141     TLI.setUnavailable(LibFunc::cbrt);
 142     TLI.setUnavailable(LibFunc::cbrtf);
 143     TLI.setUnavailable(LibFunc::cbrtl);
 144     TLI.setUnavailable(LibFunc::exp2);
 145     TLI.setUnavailable(LibFunc::exp2f);
 146     TLI.setUnavailable(LibFunc::exp2l);
 147     TLI.setUnavailable(LibFunc::expm1);
 148     TLI.setUnavailable(LibFunc::expm1f);
 149     TLI.setUnavailable(LibFunc::expm1l);
 150     TLI.setUnavailable(LibFunc::log2);
 151     TLI.setUnavailable(LibFunc::log2f);
 152     TLI.setUnavailable(LibFunc::log2l);
 153     TLI.setUnavailable(LibFunc::log1p);
 154     TLI.setUnavailable(LibFunc::log1pf);
 155     TLI.setUnavailable(LibFunc::log1pl);
 156     TLI.setUnavailable(LibFunc::logb);
 157     TLI.setUnavailable(LibFunc::logbf);
 158     TLI.setUnavailable(LibFunc::logbl);
 159     TLI.setUnavailable(LibFunc::nearbyint);
 160     TLI.setUnavailable(LibFunc::nearbyintf);
 161     TLI.setUnavailable(LibFunc::nearbyintl);
 162     TLI.setUnavailable(LibFunc::rint);
 163     TLI.setUnavailable(LibFunc::rintf);
 164     TLI.setUnavailable(LibFunc::rintl);
 165     TLI.setUnavailable(LibFunc::round);
 166     TLI.setUnavailable(LibFunc::roundf);
 167     TLI.setUnavailable(LibFunc::roundl);
 168     TLI.setUnavailable(LibFunc::trunc);
 169     TLI.setUnavailable(LibFunc::truncf);
 170     TLI.setUnavailable(LibFunc::truncl);
 171
 172     // Win32 provides some C99 math with mangled names
 173     TLI.setAvailableWithName(LibFunc::copysign, "_copysign");
 174
 175     if (T.getArch() == Triple::x86) {
 176       // Win32 on x86 implements single-precision math functions as macros
 177       TLI.setUnavailable(LibFunc::acosf);
 178       TLI.setUnavailable(LibFunc::asinf);
 179       TLI.setUnavailable(LibFunc::atanf);
 180       TLI.setUnavailable(LibFunc::atan2f);
 181       TLI.setUnavailable(LibFunc::ceilf);
 182       TLI.setUnavailable(LibFunc::copysignf);
 183       TLI.setUnavailable(LibFunc::cosf);
 184       TLI.setUnavailable(LibFunc::coshf);
 185       TLI.setUnavailable(LibFunc::expf);
 186       TLI.setUnavailable(LibFunc::floorf);
 187       TLI.setUnavailable(LibFunc::fminf);
 188       TLI.setUnavailable(LibFunc::fmaxf);
 189       TLI.setUnavailable(LibFunc::fmodf);
 190       TLI.setUnavailable(LibFunc::logf);
 191       TLI.setUnavailable(LibFunc::powf);
 192       TLI.setUnavailable(LibFunc::sinf);
 193       TLI.setUnavailable(LibFunc::sinhf);
 194       TLI.setUnavailable(LibFunc::sqrtf);
 195       TLI.setUnavailable(LibFunc::tanf);
 196       TLI.setUnavailable(LibFunc::tanhf);
 197     }
 198
 199     // Win32 does *not* provide provide these functions, but they are
 200     // generally available on POSIX-compliant systems:
 201     TLI.setUnavailable(LibFunc::access);
 202     TLI.setUnavailable(LibFunc::bcmp);
 203     TLI.setUnavailable(LibFunc::bcopy);
 204     TLI.setUnavailable(LibFunc::bzero);
 205     TLI.setUnavailable(LibFunc::chmod);
 206     TLI.setUnavailable(LibFunc::chown);
 207     TLI.setUnavailable(LibFunc::closedir);
 208     TLI.setUnavailable(LibFunc::ctermid);
 209     TLI.setUnavailable(LibFunc::fdopen);
 210     TLI.setUnavailable(LibFunc::ffs);
 211     TLI.setUnavailable(LibFunc::fileno);
 212     TLI.setUnavailable(LibFunc::flockfile);
 213     TLI.setUnavailable(LibFunc::fseeko);
 214     TLI.setUnavailable(LibFunc::fstat);
 215     TLI.setUnavailable(LibFunc::fstatvfs);
 216     TLI.setUnavailable(LibFunc::ftello);
 217     TLI.setUnavailable(LibFunc::ftrylockfile);
 218     TLI.setUnavailable(LibFunc::funlockfile);
 219     TLI.setUnavailable(LibFunc::getc_unlocked);
 220     TLI.setUnavailable(LibFunc::getitimer);
 221     TLI.setUnavailable(LibFunc::getlogin_r);
 222     TLI.setUnavailable(LibFunc::getpwnam);
 223     TLI.setUnavailable(LibFunc::gettimeofday);
 224     TLI.setUnavailable(LibFunc::htonl);
 225     TLI.setUnavailable(LibFunc::htons);
 226     TLI.setUnavailable(LibFunc::lchown);
 227     TLI.setUnavailable(LibFunc::lstat);
 228     TLI.setUnavailable(LibFunc::memccpy);
 229     TLI.setUnavailable(LibFunc::mkdir);
 230     TLI.setUnavailable(LibFunc::ntohl);
 231     TLI.setUnavailable(LibFunc::ntohs);
 232     TLI.setUnavailable(LibFunc::open);
 233     TLI.setUnavailable(LibFunc::opendir);
 234     TLI.setUnavailable(LibFunc::pclose);
 235     TLI.setUnavailable(LibFunc::popen);
 236     TLI.setUnavailable(LibFunc::pread);
 237     TLI.setUnavailable(LibFunc::pwrite);
 238     TLI.setUnavailable(LibFunc::read);
 239     TLI.setUnavailable(LibFunc::readlink);
 240     TLI.setUnavailable(LibFunc::realpath);
 241     TLI.setUnavailable(LibFunc::rmdir);
 242     TLI.setUnavailable(LibFunc::setitimer);
 243     TLI.setUnavailable(LibFunc::stat);
 244     TLI.setUnavailable(LibFunc::statvfs);
 245     TLI.setUnavailable(LibFunc::stpcpy);
 246     TLI.setUnavailable(LibFunc::stpncpy);
 247     TLI.setUnavailable(LibFunc::strcasecmp);
 248     TLI.setUnavailable(LibFunc::strncasecmp);
 249     TLI.setUnavailable(LibFunc::times);
 250     TLI.setUnavailable(LibFunc::uname);
 251     TLI.setUnavailable(LibFunc::unlink);
 252     TLI.setUnavailable(LibFunc::unsetenv);
 253     TLI.setUnavailable(LibFunc::utime);
 254     TLI.setUnavailable(LibFunc::utimes);
 255     TLI.setUnavailable(LibFunc::write);
 256
 257     // Win32 does *not* provide provide these functions, but they are
 258     // specified by C99:
 259     TLI.setUnavailable(LibFunc::atoll);
 260     TLI.setUnavailable(LibFunc::frexpf);
 261     TLI.setUnavailable(LibFunc::llabs);
 262   }
 263
 264   switch (T.getOS()) {
 265   case Triple::MacOSX:
 266     // exp10 and exp10f are not available on OS X until 10.9 and iOS until 7.0
 267     // and their names are __exp10 and __exp10f. exp10l is not available on
 268     // OS X or iOS.
 269     TLI.setUnavailable(LibFunc::exp10l);
 270     if (T.isMacOSXVersionLT(10, 9)) {
 271       TLI.setUnavailable(LibFunc::exp10);
 272       TLI.setUnavailable(LibFunc::exp10f);
 273     } else {
 274       TLI.setAvailableWithName(LibFunc::exp10, "__exp10");
 275       TLI.setAvailableWithName(LibFunc::exp10f, "__exp10f");
 276     }
 277     break;
 278   case Triple::IOS:
 279     TLI.setUnavailable(LibFunc::exp10l);
 280     if (T.isOSVersionLT(7, 0)) {
 281       TLI.setUnavailable(LibFunc::exp10);
 282       TLI.setUnavailable(LibFunc::exp10f);
 283     } else {
 284       TLI.setAvailableWithName(LibFunc::exp10, "__exp10");
 285       TLI.setAvailableWithName(LibFunc::exp10f, "__exp10f");
 286     }
 287     break;
 288   case Triple::Linux:
 289     // exp10, exp10f, exp10l is available on Linux (GLIBC) but are extremely
 290     // buggy prior to glibc version 2.18. Until this version is widely deployed
 291     // or we have a reasonable detection strategy, we cannot use exp10 reliably
 292     // on Linux.
 293     //
 294     // Fall through to disable all of them.
 295   default:
 296     TLI.setUnavailable(LibFunc::exp10);
 297     TLI.setUnavailable(LibFunc::exp10f);
 298     TLI.setUnavailable(LibFunc::exp10l);
 299   }
 300
 301   // ffsl is available on at least Darwin, Mac OS X, iOS, FreeBSD, and
 302   // Linux (GLIBC):
 303   // http://developer.apple.com/library/mac/#documentation/Darwin/Reference/ManPages/man3/ffsl.3.html
 304   // http://svn.freebsd.org/base/user/eri/pf45/head/lib/libc/string/ffsl.c
 305   // http://www.gnu.org/software/gnulib/manual/html_node/ffsl.html
 306   switch (T.getOS()) {
 307   case Triple::Darwin:
 308   case Triple::MacOSX:
 309   case Triple::IOS:
 310   case Triple::FreeBSD:
 311   case Triple::Linux:
 312     break;
 313   default:
 314     TLI.setUnavailable(LibFunc::ffsl);
 315   }
 316
 317   // ffsll is available on at least FreeBSD and Linux (GLIBC):
 318   // http://svn.freebsd.org/base/user/eri/pf45/head/lib/libc/string/ffsll.c
 319   // http://www.gnu.org/software/gnulib/manual/html_node/ffsll.html
 320   switch (T.getOS()) {
 321   case Triple::FreeBSD:
 322   case Triple::Linux:
 323     break;
 324   default:
 325     TLI.setUnavailable(LibFunc::ffsll);
 326   }
 327
 328   // The following functions are available on at least Linux:
 329   if (!T.isOSLinux()) {
 330     TLI.setUnavailable(LibFunc::dunder_strdup);
 331     TLI.setUnavailable(LibFunc::dunder_strtok_r);
 332     TLI.setUnavailable(LibFunc::dunder_isoc99_scanf);
 333     TLI.setUnavailable(LibFunc::dunder_isoc99_sscanf);
 334     TLI.setUnavailable(LibFunc::under_IO_getc);
 335     TLI.setUnavailable(LibFunc::under_IO_putc);
 336     TLI.setUnavailable(LibFunc::memalign);
 337     TLI.setUnavailable(LibFunc::fopen64);
 338     TLI.setUnavailable(LibFunc::fseeko64);
 339     TLI.setUnavailable(LibFunc::fstat64);
 340     TLI.setUnavailable(LibFunc::fstatvfs64);
 341     TLI.setUnavailable(LibFunc::ftello64);
 342     TLI.setUnavailable(LibFunc::lstat64);
 343     TLI.setUnavailable(LibFunc::open64);
 344     TLI.setUnavailable(LibFunc::stat64);
 345     TLI.setUnavailable(LibFunc::statvfs64);
 346     TLI.setUnavailable(LibFunc::tmpfile64);
 347   }
 348 }
 349
 350 TargetLibraryInfoImpl::TargetLibraryInfoImpl() {
 351   // Default to everything being available.
 352   memset(AvailableArray, -1, sizeof(AvailableArray));
 353
 354   initialize(*this, Triple(), StandardNames);
 355 }
 356
 357 TargetLibraryInfoImpl::TargetLibraryInfoImpl(const Triple &T) {
 358   // Default to everything being available.
 359   memset(AvailableArray, -1, sizeof(AvailableArray));
 360
 361   initialize(*this, T, StandardNames);
 362 }
 363
 364 TargetLibraryInfoImpl::TargetLibraryInfoImpl(const TargetLibraryInfoImpl &TLI)
 365     : CustomNames(TLI.CustomNames) {
 366   memcpy(AvailableArray, TLI.AvailableArray, sizeof(AvailableArray));
 367 }
 368
 369 TargetLibraryInfoImpl::TargetLibraryInfoImpl(TargetLibraryInfoImpl &&TLI)
 370     : CustomNames(std::move(TLI.CustomNames)) {
 371   std::move(std::begin(TLI.AvailableArray), std::end(TLI.AvailableArray),
 372             AvailableArray);
 373 }
 374
 375 TargetLibraryInfoImpl &TargetLibraryInfoImpl::operator=(const TargetLibraryInfoImpl &TLI) {
 376   CustomNames = TLI.CustomNames;
 377   memcpy(AvailableArray, TLI.AvailableArray, sizeof(AvailableArray));
 378   return *this;
 379 }
 380
 381 TargetLibraryInfoImpl &TargetLibraryInfoImpl::operator=(TargetLibraryInfoImpl &&TLI) {
 382   CustomNames = std::move(TLI.CustomNames);
 383   std::move(std::begin(TLI.AvailableArray), std::end(TLI.AvailableArray),
 384             AvailableArray);
 385   return *this;
 386 }
 387
 388 static StringRef sanitizeFunctionName(StringRef funcName) {
 389   // Filter out empty names and names containing null bytes, those can't be in
 390   // our table.
 391   if (funcName.empty() || funcName.find('\0') != StringRef::npos)
 392     return StringRef();
 393
 394   // Check for \01 prefix that is used to mangle __asm declarations and
 395   // strip it if present.
 396   if (funcName.front() == '\01')
 397     funcName = funcName.substr(1);
 398   return funcName;
 399 }
 400
 401 bool TargetLibraryInfoImpl::getLibFunc(StringRef funcName,
 402                                    LibFunc::Func &F) const {
 403   const char *const *Start = &StandardNames[0];
 404   const char *const *End = &StandardNames[LibFunc::NumLibFuncs];
 405
 406   funcName = sanitizeFunctionName(funcName);
 407   if (funcName.empty())
 408     return false;
 409
 410   const char *const *I = std::lower_bound(
 411       Start, End, funcName, [](const char *LHS, StringRef RHS) {
 412         return std::strncmp(LHS, RHS.data(), RHS.size()) < 0;
 413       });
 414   if (I != End && *I == funcName) {
 415     F = (LibFunc::Func)(I - Start);
 416     return true;
 417   }
 418   return false;
 419 }
 420
 421 void TargetLibraryInfoImpl::disableAllFunctions() {
 422   memset(AvailableArray, 0, sizeof(AvailableArray));
 423 }
 424
 425 TargetLibraryInfo TargetLibraryAnalysis::run(Module &M) {
 426   if (PresetInfoImpl)
 427     return TargetLibraryInfo(*PresetInfoImpl);
 428
 429   return TargetLibraryInfo(lookupInfoImpl(Triple(M.getTargetTriple())));
 430 }
 431
 432 TargetLibraryInfo TargetLibraryAnalysis::run(Function &F) {
 433   if (PresetInfoImpl)
 434     return TargetLibraryInfo(*PresetInfoImpl);
 435
 436   return TargetLibraryInfo(
 437       lookupInfoImpl(Triple(F.getParent()->getTargetTriple())));
 438 }
 439
 440 TargetLibraryInfoImpl &TargetLibraryAnalysis::lookupInfoImpl(Triple T) {
 441   std::unique_ptr<TargetLibraryInfoImpl> &Impl =
 442       Impls[T.normalize()];
 443   if (!Impl)
 444     Impl.reset(new TargetLibraryInfoImpl(T));
 445
 446   return *Impl;
 447 }
 448
 449
 450 TargetLibraryInfoWrapperPass::TargetLibraryInfoWrapperPass()
 451     : ImmutablePass(ID), TLIImpl(), TLI(TLIImpl) {
 452   initializeTargetLibraryInfoWrapperPassPass(*PassRegistry::getPassRegistry());
 453 }
 454
 455 TargetLibraryInfoWrapperPass::TargetLibraryInfoWrapperPass(const Triple &T)
 456     : ImmutablePass(ID), TLIImpl(T), TLI(TLIImpl) {
 457   initializeTargetLibraryInfoWrapperPassPass(*PassRegistry::getPassRegistry());
 458 }
 459
 460 TargetLibraryInfoWrapperPass::TargetLibraryInfoWrapperPass(
 461     const TargetLibraryInfoImpl &TLIImpl)
 462     : ImmutablePass(ID), TLIImpl(TLIImpl), TLI(this->TLIImpl) {
 463   initializeTargetLibraryInfoWrapperPassPass(*PassRegistry::getPassRegistry());
 464 }
 465
 466 char TargetLibraryAnalysis::PassID;
 467
 468 // Register the basic pass.
 469 INITIALIZE_PASS(TargetLibraryInfoWrapperPass, "targetlibinfo",
 470                 "Target Library Information", false, true)
 471 char TargetLibraryInfoWrapperPass::ID = 0;
 472
 473 void TargetLibraryInfoWrapperPass::anchor() {}