clang  6.0.0svn
Builtins.cpp
Go to the documentation of this file.
1 //===--- Builtins.cpp - Builtin function implementation -------------------===//
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 various things for builtin functions.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "clang/Basic/Builtins.h"
17 #include "clang/Basic/TargetInfo.h"
18 #include "llvm/ADT/StringRef.h"
19 using namespace clang;
20 
21 static const Builtin::Info BuiltinInfo[] = {
22  { "not a builtin function", nullptr, nullptr, nullptr, ALL_LANGUAGES,nullptr},
23 #define BUILTIN(ID, TYPE, ATTRS) \
24  { #ID, TYPE, ATTRS, nullptr, ALL_LANGUAGES, nullptr },
25 #define LANGBUILTIN(ID, TYPE, ATTRS, LANGS) \
26  { #ID, TYPE, ATTRS, nullptr, LANGS, nullptr },
27 #define LIBBUILTIN(ID, TYPE, ATTRS, HEADER, LANGS) \
28  { #ID, TYPE, ATTRS, HEADER, LANGS, nullptr },
29 #include "clang/Basic/Builtins.def"
30 };
31 
32 const Builtin::Info &Builtin::Context::getRecord(unsigned ID) const {
33  if (ID < Builtin::FirstTSBuiltin)
34  return BuiltinInfo[ID];
35  assert(((ID - Builtin::FirstTSBuiltin) <
36  (TSRecords.size() + AuxTSRecords.size())) &&
37  "Invalid builtin ID!");
38  if (isAuxBuiltinID(ID))
39  return AuxTSRecords[getAuxBuiltinID(ID) - Builtin::FirstTSBuiltin];
40  return TSRecords[ID - Builtin::FirstTSBuiltin];
41 }
42 
44  const TargetInfo *AuxTarget) {
45  assert(TSRecords.empty() && "Already initialized target?");
46  TSRecords = Target.getTargetBuiltins();
47  if (AuxTarget)
48  AuxTSRecords = AuxTarget->getTargetBuiltins();
49 }
50 
51 bool Builtin::Context::isBuiltinFunc(const char *Name) {
52  StringRef FuncName(Name);
53  for (unsigned i = Builtin::NotBuiltin + 1; i != Builtin::FirstTSBuiltin; ++i)
54  if (FuncName.equals(BuiltinInfo[i].Name))
55  return strchr(BuiltinInfo[i].Attributes, 'f') != nullptr;
56 
57  return false;
58 }
59 
60 bool Builtin::Context::builtinIsSupported(const Builtin::Info &BuiltinInfo,
61  const LangOptions &LangOpts) {
62  bool BuiltinsUnsupported =
63  (LangOpts.NoBuiltin || LangOpts.isNoBuiltinFunc(BuiltinInfo.Name)) &&
64  strchr(BuiltinInfo.Attributes, 'f');
65  bool MathBuiltinsUnsupported =
66  LangOpts.NoMathBuiltin && BuiltinInfo.HeaderName &&
67  llvm::StringRef(BuiltinInfo.HeaderName).equals("math.h");
68  bool GnuModeUnsupported = !LangOpts.GNUMode && (BuiltinInfo.Langs & GNU_LANG);
69  bool MSModeUnsupported =
70  !LangOpts.MicrosoftExt && (BuiltinInfo.Langs & MS_LANG);
71  bool ObjCUnsupported = !LangOpts.ObjC1 && BuiltinInfo.Langs == OBJC_LANG;
72  bool OclC1Unsupported = (LangOpts.OpenCLVersion / 100) != 1 &&
73  (BuiltinInfo.Langs & ALL_OCLC_LANGUAGES ) == OCLC1X_LANG;
74  bool OclC2Unsupported = LangOpts.OpenCLVersion != 200 &&
75  (BuiltinInfo.Langs & ALL_OCLC_LANGUAGES) == OCLC20_LANG;
76  bool OclCUnsupported = !LangOpts.OpenCL &&
77  (BuiltinInfo.Langs & ALL_OCLC_LANGUAGES);
78  bool OpenMPUnsupported = !LangOpts.OpenMP && BuiltinInfo.Langs == OMP_LANG;
79  return !BuiltinsUnsupported && !MathBuiltinsUnsupported && !OclCUnsupported &&
80  !OclC1Unsupported && !OclC2Unsupported && !OpenMPUnsupported &&
81  !GnuModeUnsupported && !MSModeUnsupported && !ObjCUnsupported;
82 }
83 
84 /// initializeBuiltins - Mark the identifiers for all the builtins with their
85 /// appropriate builtin ID # and mark any non-portable builtin identifiers as
86 /// such.
88  const LangOptions& LangOpts) {
89  // Step #1: mark all target-independent builtins with their ID's.
90  for (unsigned i = Builtin::NotBuiltin+1; i != Builtin::FirstTSBuiltin; ++i)
91  if (builtinIsSupported(BuiltinInfo[i], LangOpts)) {
92  Table.get(BuiltinInfo[i].Name).setBuiltinID(i);
93  }
94 
95  // Step #2: Register target-specific builtins.
96  for (unsigned i = 0, e = TSRecords.size(); i != e; ++i)
97  if (builtinIsSupported(TSRecords[i], LangOpts))
98  Table.get(TSRecords[i].Name).setBuiltinID(i + Builtin::FirstTSBuiltin);
99 
100  // Step #3: Register target-specific builtins for AuxTarget.
101  for (unsigned i = 0, e = AuxTSRecords.size(); i != e; ++i)
102  Table.get(AuxTSRecords[i].Name)
103  .setBuiltinID(i + Builtin::FirstTSBuiltin + TSRecords.size());
104 }
105 
107  Table.get(getRecord(ID).Name).setBuiltinID(0);
108 }
109 
110 bool Builtin::Context::isLike(unsigned ID, unsigned &FormatIdx,
111  bool &HasVAListArg, const char *Fmt) const {
112  assert(Fmt && "Not passed a format string");
113  assert(::strlen(Fmt) == 2 &&
114  "Format string needs to be two characters long");
115  assert(::toupper(Fmt[0]) == Fmt[1] &&
116  "Format string is not in the form \"xX\"");
117 
118  const char *Like = ::strpbrk(getRecord(ID).Attributes, Fmt);
119  if (!Like)
120  return false;
121 
122  HasVAListArg = (*Like == Fmt[1]);
123 
124  ++Like;
125  assert(*Like == ':' && "Format specifier must be followed by a ':'");
126  ++Like;
127 
128  assert(::strchr(Like, ':') && "Format specifier must end with a ':'");
129  FormatIdx = ::strtol(Like, nullptr, 10);
130  return true;
131 }
132 
133 bool Builtin::Context::isPrintfLike(unsigned ID, unsigned &FormatIdx,
134  bool &HasVAListArg) {
135  return isLike(ID, FormatIdx, HasVAListArg, "pP");
136 }
137 
138 bool Builtin::Context::isScanfLike(unsigned ID, unsigned &FormatIdx,
139  bool &HasVAListArg) {
140  return isLike(ID, FormatIdx, HasVAListArg, "sS");
141 }
bool isNoBuiltinFunc(StringRef Name) const
Is this a libc/libm function that is no longer recognized as a builtin because a -fno-builtin-* optio...
Definition: LangOptions.cpp:41
const char * Attributes
Definition: Builtins.h:57
static const Builtin::Info BuiltinInfo[]
Definition: Builtins.cpp:21
static bool isBuiltinFunc(const char *Name)
Returns true if this is a libc/libm function without the &#39;__builtin_&#39; prefix.
Definition: Builtins.cpp:51
void forgetBuiltin(unsigned ID, IdentifierTable &Table)
Completely forget that the given ID was ever considered a builtin, e.g., because the user provided a ...
Definition: Builtins.cpp:106
bool isPrintfLike(unsigned ID, unsigned &FormatIdx, bool &HasVAListArg)
Determine whether this builtin is like printf in its formatting rules and, if so, set the index to th...
Definition: Builtins.cpp:133
const char * Name
Definition: Builtins.h:57
Keeps track of the various options that can be enabled, which controls the dialect of C or C++ that i...
Definition: LangOptions.h:48
unsigned getAuxBuiltinID(unsigned ID) const
Return real buitin ID (i.e.
Definition: Builtins.h:209
LanguageID Langs
Definition: Builtins.h:58
Exposes information about the current target.
Definition: TargetInfo.h:54
Defines the clang::LangOptions interface.
Implements an efficient mapping from strings to IdentifierInfo nodes.
Defines the clang::IdentifierInfo, clang::IdentifierTable, and clang::Selector interfaces.
const char * HeaderName
Definition: Builtins.h:57
bool isAuxBuiltinID(unsigned ID) const
Return true if builtin ID belongs to AuxTarget.
Definition: Builtins.h:203
IdentifierInfo & get(StringRef Name)
Return the identifier token info for the specified named identifier.
void initializeBuiltins(IdentifierTable &Table, const LangOptions &LangOpts)
Mark the identifiers for all the builtins with their appropriate builtin ID # and mark any non-portab...
Definition: Builtins.cpp:87
virtual ArrayRef< Builtin::Info > getTargetBuiltins() const =0
Return information about target-specific builtins for the current primary target, and info about whic...
bool isScanfLike(unsigned ID, unsigned &FormatIdx, bool &HasVAListArg)
Determine whether this builtin is like scanf in its formatting rules and, if so, set the index to the...
Definition: Builtins.cpp:138
Dataflow Directional Tag Classes.
void setBuiltinID(unsigned ID)
Defines the clang::TargetInfo interface.
void InitializeTarget(const TargetInfo &Target, const TargetInfo *AuxTarget)
Perform target-specific initialization.
Definition: Builtins.cpp:43
Defines enum values for all the target-independent builtin functions.