Coverage Report

Created: 2021-01-19 06:58

/Users/buildslave/jenkins/workspace/coverage/llvm-project/clang/include/clang/Basic/Builtins.h
Line
Count
Source
1
//===--- Builtins.h - Builtin function header -------------------*- C++ -*-===//
2
//
3
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4
// See https://llvm.org/LICENSE.txt for license information.
5
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6
//
7
//===----------------------------------------------------------------------===//
8
///
9
/// \file
10
/// Defines enum values for all the target-independent builtin
11
/// functions.
12
///
13
//===----------------------------------------------------------------------===//
14
15
#ifndef LLVM_CLANG_BASIC_BUILTINS_H
16
#define LLVM_CLANG_BASIC_BUILTINS_H
17
18
#include "llvm/ADT/ArrayRef.h"
19
#include <cstring>
20
21
// VC++ defines 'alloca' as an object-like macro, which interferes with our
22
// builtins.
23
#undef alloca
24
25
namespace clang {
26
class TargetInfo;
27
class IdentifierTable;
28
class LangOptions;
29
30
enum LanguageID {
31
  GNU_LANG = 0x1,     // builtin requires GNU mode.
32
  C_LANG = 0x2,       // builtin for c only.
33
  CXX_LANG = 0x4,     // builtin for cplusplus only.
34
  OBJC_LANG = 0x8,    // builtin for objective-c and objective-c++
35
  MS_LANG = 0x10,     // builtin requires MS mode.
36
  OCLC20_LANG = 0x20, // builtin for OpenCL C 2.0 only.
37
  OCLC1X_LANG = 0x40, // builtin for OpenCL C 1.x only.
38
  OMP_LANG = 0x80,    // builtin requires OpenMP.
39
  ALL_LANGUAGES = C_LANG | CXX_LANG | OBJC_LANG, // builtin for all languages.
40
  ALL_GNU_LANGUAGES = ALL_LANGUAGES | GNU_LANG,  // builtin requires GNU mode.
41
  ALL_MS_LANGUAGES = ALL_LANGUAGES | MS_LANG,    // builtin requires MS mode.
42
  ALL_OCLC_LANGUAGES = OCLC1X_LANG | OCLC20_LANG // builtin for OCLC languages.
43
};
44
45
namespace Builtin {
46
enum ID {
47
  NotBuiltin  = 0,      // This is not a builtin function.
48
#define BUILTIN(ID, TYPE, ATTRS) BI##ID,
49
#include "clang/Basic/Builtins.def"
50
  FirstTSBuiltin
51
};
52
53
struct Info {
54
  const char *Name, *Type, *Attributes, *HeaderName;
55
  LanguageID Langs;
56
  const char *Features;
57
};
58
59
/// Holds information about both target-independent and
60
/// target-specific builtins, allowing easy queries by clients.
61
///
62
/// Builtins from an optional auxiliary target are stored in
63
/// AuxTSRecords. Their IDs are shifted up by TSRecords.size() and need to
64
/// be translated back with getAuxBuiltinID() before use.
65
class Context {
66
  llvm::ArrayRef<Info> TSRecords;
67
  llvm::ArrayRef<Info> AuxTSRecords;
68
69
public:
70
91.7k
  Context() {}
71
72
  /// Perform target-specific initialization
73
  /// \param AuxTarget Target info to incorporate builtins from. May be nullptr.
74
  void InitializeTarget(const TargetInfo &Target, const TargetInfo *AuxTarget);
75
76
  /// Mark the identifiers for all the builtins with their
77
  /// appropriate builtin ID # and mark any non-portable builtin identifiers as
78
  /// such.
79
  void initializeBuiltins(IdentifierTable &Table, const LangOptions& LangOpts);
80
81
  /// Return the identifier name for the specified builtin,
82
  /// e.g. "__builtin_abs".
83
119k
  const char *getName(unsigned ID) const {
84
119k
    return getRecord(ID).Name;
85
119k
  }
86
87
  /// Get the type descriptor string for the specified builtin.
88
2.49M
  const char *getTypeString(unsigned ID) const {
89
2.49M
    return getRecord(ID).Type;
90
2.49M
  }
91
92
  /// Return true if this function is a target-specific builtin.
93
1.44M
  bool isTSBuiltin(unsigned ID) const {
94
1.44M
    return ID >= Builtin::FirstTSBuiltin;
95
1.44M
  }
96
97
  /// Return true if this function has no side effects.
98
8.47M
  bool isPure(unsigned ID) const {
99
8.47M
    return strchr(getRecord(ID).Attributes, 'U') != nullptr;
100
8.47M
  }
101
102
  /// Return true if this function has no side effects and doesn't
103
  /// read memory.
104
8.47M
  bool isConst(unsigned ID) const {
105
8.47M
    return strchr(getRecord(ID).Attributes, 'c') != nullptr;
106
8.47M
  }
107
108
  /// Return true if we know this builtin never throws an exception.
109
8.79M
  bool isNoThrow(unsigned ID) const {
110
8.79M
    return strchr(getRecord(ID).Attributes, 'n') != nullptr;
111
8.79M
  }
112
113
  /// Return true if we know this builtin never returns.
114
2.44M
  bool isNoReturn(unsigned ID) const {
115
2.44M
    return strchr(getRecord(ID).Attributes, 'r') != nullptr;
116
2.44M
  }
117
118
  /// Return true if we know this builtin can return twice.
119
8.47M
  bool isReturnsTwice(unsigned ID) const {
120
8.47M
    return strchr(getRecord(ID).Attributes, 'j') != nullptr;
121
8.47M
  }
122
123
  /// Returns true if this builtin does not perform the side-effects
124
  /// of its arguments.
125
1.45M
  bool isUnevaluated(unsigned ID) const {
126
1.45M
    return strchr(getRecord(ID).Attributes, 'u') != nullptr;
127
1.45M
  }
128
129
  /// Return true if this is a builtin for a libc/libm function,
130
  /// with a "__builtin_" prefix (e.g. __builtin_abs).
131
57.8k
  bool isLibFunction(unsigned ID) const {
132
57.8k
    return strchr(getRecord(ID).Attributes, 'F') != nullptr;
133
57.8k
  }
134
135
  /// Determines whether this builtin is a predefined libc/libm
136
  /// function, such as "malloc", where we know the signature a
137
  /// priori.
138
62.4M
  bool isPredefinedLibFunction(unsigned ID) const {
139
62.4M
    return strchr(getRecord(ID).Attributes, 'f') != nullptr;
140
62.4M
  }
141
142
  /// Returns true if this builtin requires appropriate header in other
143
  /// compilers. In Clang it will work even without including it, but we can emit
144
  /// a warning about missing header.
145
718k
  bool isHeaderDependentFunction(unsigned ID) const {
146
718k
    return strchr(getRecord(ID).Attributes, 'h') != nullptr;
147
718k
  }
148
149
  /// Determines whether this builtin is a predefined compiler-rt/libgcc
150
  /// function, such as "__clear_cache", where we know the signature a
151
  /// priori.
152
3
  bool isPredefinedRuntimeFunction(unsigned ID) const {
153
3
    return strchr(getRecord(ID).Attributes, 'i') != nullptr;
154
3
  }
155
156
  /// Determines whether this builtin has custom typechecking.
157
40.8M
  bool hasCustomTypechecking(unsigned ID) const {
158
40.8M
    return strchr(getRecord(ID).Attributes, 't') != nullptr;
159
40.8M
  }
160
161
  /// Determines whether a declaration of this builtin should be recognized
162
  /// even if the type doesn't match the specified signature.
163
26.6k
  bool allowTypeMismatch(unsigned ID) const {
164
26.6k
    return strchr(getRecord(ID).Attributes, 'T') != nullptr ||
165
26.6k
           hasCustomTypechecking(ID);
166
26.6k
  }
167
168
  /// Determines whether this builtin has a result or any arguments which
169
  /// are pointer types.
170
1.59M
  bool hasPtrArgsOrResult(unsigned ID) const {
171
1.59M
    return strchr(getRecord(ID).Type, '*') != nullptr;
172
1.59M
  }
173
174
  /// Return true if this builtin has a result or any arguments which are
175
  /// reference types.
176
36.1M
  bool hasReferenceArgsOrResult(unsigned ID) const {
177
36.1M
    return strchr(getRecord(ID).Type, '&') != nullptr ||
178
36.1M
           strchr(getRecord(ID).Type, 'A') != nullptr;
179
36.1M
  }
180
181
  /// Completely forget that the given ID was ever considered a builtin,
182
  /// e.g., because the user provided a conflicting signature.
183
  void forgetBuiltin(unsigned ID, IdentifierTable &Table);
184
185
  /// If this is a library function that comes from a specific
186
  /// header, retrieve that header name.
187
1.48k
  const char *getHeaderName(unsigned ID) const {
188
1.48k
    return getRecord(ID).HeaderName;
189
1.48k
  }
190
191
  /// Determine whether this builtin is like printf in its
192
  /// formatting rules and, if so, set the index to the format string
193
  /// argument and whether this function as a va_list argument.
194
  bool isPrintfLike(unsigned ID, unsigned &FormatIdx, bool &HasVAListArg);
195
196
  /// Determine whether this builtin is like scanf in its
197
  /// formatting rules and, if so, set the index to the format string
198
  /// argument and whether this function as a va_list argument.
199
  bool isScanfLike(unsigned ID, unsigned &FormatIdx, bool &HasVAListArg);
200
201
  /// Determine whether this builtin has callback behavior (see
202
  /// llvm::AbstractCallSites for details). If so, add the index to the
203
  /// callback callee argument and the callback payload arguments.
204
  bool performsCallback(unsigned ID,
205
                        llvm::SmallVectorImpl<int> &Encoding) const;
206
207
  /// Return true if this function has no side effects and doesn't
208
  /// read memory, except for possibly errno.
209
  ///
210
  /// Such functions can be const when the MathErrno lang option is disabled.
211
8.45M
  bool isConstWithoutErrno(unsigned ID) const {
212
8.45M
    return strchr(getRecord(ID).Attributes, 'e') != nullptr;
213
8.45M
  }
214
215
53.5k
  const char *getRequiredFeatures(unsigned ID) const {
216
53.5k
    return getRecord(ID).Features;
217
53.5k
  }
218
219
  unsigned getRequiredVectorWidth(unsigned ID) const;
220
221
  /// Return true if builtin ID belongs to AuxTarget.
222
250M
  bool isAuxBuiltinID(unsigned ID) const {
223
250M
    return ID >= (Builtin::FirstTSBuiltin + TSRecords.size());
224
250M
  }
225
226
  /// Return real builtin ID (i.e. ID it would have during compilation
227
  /// for AuxTarget).
228
210
  unsigned getAuxBuiltinID(unsigned ID) const { return ID - TSRecords.size(); }
229
230
  /// Returns true if this is a libc/libm function without the '__builtin_'
231
  /// prefix.
232
  static bool isBuiltinFunc(llvm::StringRef Name);
233
234
  /// Returns true if this is a builtin that can be redeclared.  Returns true
235
  /// for non-builtins.
236
  bool canBeRedeclared(unsigned ID) const;
237
238
private:
239
  const Info &getRecord(unsigned ID) const;
240
241
  /// Is this builtin supported according to the given language options?
242
  bool builtinIsSupported(const Builtin::Info &BuiltinInfo,
243
                          const LangOptions &LangOpts);
244
245
  /// Helper function for isPrintfLike and isScanfLike.
246
  bool isLike(unsigned ID, unsigned &FormatIdx, bool &HasVAListArg,
247
              const char *Fmt) const;
248
};
249
250
}
251
252
/// Kinds of BuiltinTemplateDecl.
253
enum BuiltinTemplateKind : int {
254
  /// This names the __make_integer_seq BuiltinTemplateDecl.
255
  BTK__make_integer_seq,
256
257
  /// This names the __type_pack_element BuiltinTemplateDecl.
258
  BTK__type_pack_element
259
};
260
261
} // end namespace clang
262
#endif