Builtins.cpp revision f2941ec5bfcce36feffac514582d168b4e0ef811
15f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===--- Builtins.cpp - Builtin function implementation -------------------===//
25f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//
35f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//                     The LLVM Compiler Infrastructure
45f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//
50bc735ffcfb223c0186419547abaa5c84482663eChris Lattner// This file is distributed under the University of Illinois Open Source
60bc735ffcfb223c0186419547abaa5c84482663eChris Lattner// License. See LICENSE.TXT for details.
75f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//
85f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===----------------------------------------------------------------------===//
95f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//
105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//  This file implements various things for builtin functions.
115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//
125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===----------------------------------------------------------------------===//
135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
146b15cdc1312f8fc45c86ee75e2a85106700e97f6Chris Lattner#include "clang/Basic/Builtins.h"
15c7229c338c21ef26b01ef3ecf9eec4fd373fa9ecChris Lattner#include "clang/Basic/IdentifierTable.h"
1667aba816901503d9cf7ba699525fa62cc7f8e5e4Fariborz Jahanian#include "clang/Basic/LangOptions.h"
1755fc873017f10f6f566b182b70f6fc22aefa3464Chandler Carruth#include "clang/Basic/TargetInfo.h"
188fe83e1df954d72c0f4ffc15d20a5222ec151c21Benjamin Kramer#include "llvm/ADT/SmallVector.h"
19264d206244bde858471e4b6211aeba28fd8ce7cbEli Bendersky#include "llvm/ADT/StringRef.h"
205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerusing namespace clang;
215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerstatic const Builtin::Info BuiltinInfo[] = {
23e7e66f72221d6233bdad3b87a717e7382acd477bEli Friedman  { "not a builtin function", 0, 0, 0, ALL_LANGUAGES },
24e7e66f72221d6233bdad3b87a717e7382acd477bEli Friedman#define BUILTIN(ID, TYPE, ATTRS) { #ID, TYPE, ATTRS, 0, ALL_LANGUAGES },
25f2941ec5bfcce36feffac514582d168b4e0ef811Reid Kleckner#define LANGBUILTIN(ID, TYPE, ATTRS, BUILTIN_LANG) { #ID, TYPE, ATTRS, 0, BUILTIN_LANG },
2667aba816901503d9cf7ba699525fa62cc7f8e5e4Fariborz Jahanian#define LIBBUILTIN(ID, TYPE, ATTRS, HEADER, BUILTIN_LANG) { #ID, TYPE, ATTRS, HEADER,\
27e7e66f72221d6233bdad3b87a717e7382acd477bEli Friedman                                                            BUILTIN_LANG },
286b15cdc1312f8fc45c86ee75e2a85106700e97f6Chris Lattner#include "clang/Basic/Builtins.def"
295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer};
305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerconst Builtin::Info &Builtin::Context::GetRecord(unsigned ID) const {
325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  if (ID < Builtin::FirstTSBuiltin)
335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer    return BuiltinInfo[ID];
345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  assert(ID - Builtin::FirstTSBuiltin < NumTSRecords && "Invalid builtin ID!");
355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  return TSRecords[ID - Builtin::FirstTSBuiltin];
365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}
375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
38998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas GregorBuiltin::Context::Context() {
39030e8fe5aabe6a50ed7da3182df8cbce446bfeabChris Lattner  // Get the target specific builtins from the target.
40ff1d4d97a191ca84a703ef8d6c71ef6934090c4dChris Lattner  TSRecords = 0;
41ff1d4d97a191ca84a703ef8d6c71ef6934090c4dChris Lattner  NumTSRecords = 0;
42998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor}
43998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor
44998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregorvoid Builtin::Context::InitializeTarget(const TargetInfo &Target) {
45998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor  assert(NumTSRecords == 0 && "Already initialized target?");
46998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor  Target.getTargetBuiltins(TSRecords, NumTSRecords);
47030e8fe5aabe6a50ed7da3182df8cbce446bfeabChris Lattner}
48030e8fe5aabe6a50ed7da3182df8cbce446bfeabChris Lattner
49264d206244bde858471e4b6211aeba28fd8ce7cbEli Benderskybool Builtin::Context::BuiltinIsSupported(const Builtin::Info &BuiltinInfo,
50264d206244bde858471e4b6211aeba28fd8ce7cbEli Bendersky                                          const LangOptions &LangOpts) {
51264d206244bde858471e4b6211aeba28fd8ce7cbEli Bendersky  bool BuiltinsUnsupported = LangOpts.NoBuiltin &&
52264d206244bde858471e4b6211aeba28fd8ce7cbEli Bendersky                             strchr(BuiltinInfo.Attributes, 'f');
53264d206244bde858471e4b6211aeba28fd8ce7cbEli Bendersky  bool MathBuiltinsUnsupported =
54264d206244bde858471e4b6211aeba28fd8ce7cbEli Bendersky    LangOpts.NoMathBuiltin && BuiltinInfo.HeaderName &&
55264d206244bde858471e4b6211aeba28fd8ce7cbEli Bendersky    llvm::StringRef(BuiltinInfo.HeaderName).equals("math.h");
56264d206244bde858471e4b6211aeba28fd8ce7cbEli Bendersky  bool GnuModeUnsupported = !LangOpts.GNUMode &&
57264d206244bde858471e4b6211aeba28fd8ce7cbEli Bendersky                            (BuiltinInfo.builtin_lang & GNU_LANG);
58f2941ec5bfcce36feffac514582d168b4e0ef811Reid Kleckner  bool MSModeUnsupported = !LangOpts.MicrosoftExt &&
59f2941ec5bfcce36feffac514582d168b4e0ef811Reid Kleckner                           (BuiltinInfo.builtin_lang & MS_LANG);
60264d206244bde858471e4b6211aeba28fd8ce7cbEli Bendersky  bool ObjCUnsupported = !LangOpts.ObjC1 &&
61264d206244bde858471e4b6211aeba28fd8ce7cbEli Bendersky                         BuiltinInfo.builtin_lang == OBJC_LANG;
62264d206244bde858471e4b6211aeba28fd8ce7cbEli Bendersky  return !BuiltinsUnsupported && !MathBuiltinsUnsupported &&
63f2941ec5bfcce36feffac514582d168b4e0ef811Reid Kleckner         !GnuModeUnsupported && !MSModeUnsupported && !ObjCUnsupported;
64264d206244bde858471e4b6211aeba28fd8ce7cbEli Bendersky}
65264d206244bde858471e4b6211aeba28fd8ce7cbEli Bendersky
665f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// InitializeBuiltins - Mark the identifiers for all the builtins with their
675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// appropriate builtin ID # and mark any non-portable builtin identifiers as
685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// such.
695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencervoid Builtin::Context::InitializeBuiltins(IdentifierTable &Table,
7067aba816901503d9cf7ba699525fa62cc7f8e5e4Fariborz Jahanian                                          const LangOptions& LangOpts) {
715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  // Step #1: mark all target-independent builtins with their ID's.
725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  for (unsigned i = Builtin::NotBuiltin+1; i != Builtin::FirstTSBuiltin; ++i)
73264d206244bde858471e4b6211aeba28fd8ce7cbEli Bendersky    if (BuiltinIsSupported(BuiltinInfo[i], LangOpts)) {
74c89f02afb018316a0c36bf62b2cb75d420f2fff3Benjamin Kramer      Table.get(BuiltinInfo[i].Name).setBuiltinID(i);
75264d206244bde858471e4b6211aeba28fd8ce7cbEli Bendersky    }
761b63e4f732dbc73d90abf886b4d21f8e3a165f6dChris Lattner
7771dfdb9bc91b5d81b124e6091c903e4efd87149dDouglas Gregor  // Step #2: Register target-specific builtins.
785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  for (unsigned i = 0, e = NumTSRecords; i != e; ++i)
79ad017fa7a4df7389d245d02a49b3c79ed70bedb9Bill Wendling    if (!LangOpts.NoBuiltin || !strchr(TSRecords[i].Attributes, 'f'))
803573c0c0b44a1ac8f76a00af1bc75e94ca03d704Douglas Gregor      Table.get(TSRecords[i].Name).setBuiltinID(i+Builtin::FirstTSBuiltin);
815f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}
825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumpvoid
8497a03cf921ccc16ef9d16d965a5ef28631090f6aEli BenderskyBuiltin::Context::GetBuiltinNames(SmallVectorImpl<const char *> &Names) {
852deaea37a637dd01221d0cced343702a39d8132cDouglas Gregor  // Final all target-independent names
862deaea37a637dd01221d0cced343702a39d8132cDouglas Gregor  for (unsigned i = Builtin::NotBuiltin+1; i != Builtin::FirstTSBuiltin; ++i)
8797a03cf921ccc16ef9d16d965a5ef28631090f6aEli Bendersky    if (!strchr(BuiltinInfo[i].Attributes, 'f'))
882deaea37a637dd01221d0cced343702a39d8132cDouglas Gregor      Names.push_back(BuiltinInfo[i].Name);
891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
902deaea37a637dd01221d0cced343702a39d8132cDouglas Gregor  // Find target-specific names.
912deaea37a637dd01221d0cced343702a39d8132cDouglas Gregor  for (unsigned i = 0, e = NumTSRecords; i != e; ++i)
9297a03cf921ccc16ef9d16d965a5ef28631090f6aEli Bendersky    if (!strchr(TSRecords[i].Attributes, 'f'))
932deaea37a637dd01221d0cced343702a39d8132cDouglas Gregor      Names.push_back(TSRecords[i].Name);
942deaea37a637dd01221d0cced343702a39d8132cDouglas Gregor}
952deaea37a637dd01221d0cced343702a39d8132cDouglas Gregor
96b68e39930d06ed81a2b431dc09e4cb97e5c0d57aDouglas Gregorvoid Builtin::Context::ForgetBuiltin(unsigned ID, IdentifierTable &Table) {
97b68e39930d06ed81a2b431dc09e4cb97e5c0d57aDouglas Gregor  Table.get(GetRecord(ID).Name).setBuiltinID(0);
98b68e39930d06ed81a2b431dc09e4cb97e5c0d57aDouglas Gregor}
99b68e39930d06ed81a2b431dc09e4cb97e5c0d57aDouglas Gregor
1001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumpbool
1011eb4433ac451dc16f4133a88af2d002ac26c58efMike StumpBuiltin::Context::isPrintfLike(unsigned ID, unsigned &FormatIdx,
102a316e7b735b12ce6b34961a9dcfaae34f4b08d29Douglas Gregor                               bool &HasVAListArg) {
103ad017fa7a4df7389d245d02a49b3c79ed70bedb9Bill Wendling  const char *Printf = strpbrk(GetRecord(ID).Attributes, "pP");
104a316e7b735b12ce6b34961a9dcfaae34f4b08d29Douglas Gregor  if (!Printf)
105a316e7b735b12ce6b34961a9dcfaae34f4b08d29Douglas Gregor    return false;
106a316e7b735b12ce6b34961a9dcfaae34f4b08d29Douglas Gregor
107a316e7b735b12ce6b34961a9dcfaae34f4b08d29Douglas Gregor  HasVAListArg = (*Printf == 'P');
108a316e7b735b12ce6b34961a9dcfaae34f4b08d29Douglas Gregor
109a316e7b735b12ce6b34961a9dcfaae34f4b08d29Douglas Gregor  ++Printf;
110a316e7b735b12ce6b34961a9dcfaae34f4b08d29Douglas Gregor  assert(*Printf == ':' && "p or P specifier must have be followed by a ':'");
111a316e7b735b12ce6b34961a9dcfaae34f4b08d29Douglas Gregor  ++Printf;
112a316e7b735b12ce6b34961a9dcfaae34f4b08d29Douglas Gregor
1138a778d6c95b1f937e3158c638793ad06c14e6a37Chris Lattner  assert(strchr(Printf, ':') && "printf specifier must end with a ':'");
114a316e7b735b12ce6b34961a9dcfaae34f4b08d29Douglas Gregor  FormatIdx = strtol(Printf, 0, 10);
115a316e7b735b12ce6b34961a9dcfaae34f4b08d29Douglas Gregor  return true;
116a316e7b735b12ce6b34961a9dcfaae34f4b08d29Douglas Gregor}
117a316e7b735b12ce6b34961a9dcfaae34f4b08d29Douglas Gregor
118bee05c1206dcd525e0a1f066d166ad3e972a500eTed Kremenek// FIXME: Refactor with isPrintfLike.
119bee05c1206dcd525e0a1f066d166ad3e972a500eTed Kremenekbool
120bee05c1206dcd525e0a1f066d166ad3e972a500eTed KremenekBuiltin::Context::isScanfLike(unsigned ID, unsigned &FormatIdx,
121bee05c1206dcd525e0a1f066d166ad3e972a500eTed Kremenek                              bool &HasVAListArg) {
122ad017fa7a4df7389d245d02a49b3c79ed70bedb9Bill Wendling  const char *Scanf = strpbrk(GetRecord(ID).Attributes, "sS");
123bee05c1206dcd525e0a1f066d166ad3e972a500eTed Kremenek  if (!Scanf)
124bee05c1206dcd525e0a1f066d166ad3e972a500eTed Kremenek    return false;
125bee05c1206dcd525e0a1f066d166ad3e972a500eTed Kremenek
126bee05c1206dcd525e0a1f066d166ad3e972a500eTed Kremenek  HasVAListArg = (*Scanf == 'S');
127bee05c1206dcd525e0a1f066d166ad3e972a500eTed Kremenek
128bee05c1206dcd525e0a1f066d166ad3e972a500eTed Kremenek  ++Scanf;
129bee05c1206dcd525e0a1f066d166ad3e972a500eTed Kremenek  assert(*Scanf == ':' && "s or S specifier must have be followed by a ':'");
130bee05c1206dcd525e0a1f066d166ad3e972a500eTed Kremenek  ++Scanf;
131bee05c1206dcd525e0a1f066d166ad3e972a500eTed Kremenek
132bee05c1206dcd525e0a1f066d166ad3e972a500eTed Kremenek  assert(strchr(Scanf, ':') && "printf specifier must end with a ':'");
133bee05c1206dcd525e0a1f066d166ad3e972a500eTed Kremenek  FormatIdx = strtol(Scanf, 0, 10);
134bee05c1206dcd525e0a1f066d166ad3e972a500eTed Kremenek  return true;
135bee05c1206dcd525e0a1f066d166ad3e972a500eTed Kremenek}
136bee05c1206dcd525e0a1f066d166ad3e972a500eTed Kremenek
137