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