Builtins.cpp revision 998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4
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"
165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#include "clang/Basic/TargetInfo.h"
1767aba816901503d9cf7ba699525fa62cc7f8e5e4Fariborz Jahanian#include "clang/Basic/LangOptions.h"
185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerusing namespace clang;
195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerstatic const Builtin::Info BuiltinInfo[] = {
21e7e66f72221d6233bdad3b87a717e7382acd477bEli Friedman  { "not a builtin function", 0, 0, 0, ALL_LANGUAGES },
22e7e66f72221d6233bdad3b87a717e7382acd477bEli Friedman#define BUILTIN(ID, TYPE, ATTRS) { #ID, TYPE, ATTRS, 0, ALL_LANGUAGES },
2367aba816901503d9cf7ba699525fa62cc7f8e5e4Fariborz Jahanian#define LIBBUILTIN(ID, TYPE, ATTRS, HEADER, BUILTIN_LANG) { #ID, TYPE, ATTRS, HEADER,\
24e7e66f72221d6233bdad3b87a717e7382acd477bEli Friedman                                                            BUILTIN_LANG },
256b15cdc1312f8fc45c86ee75e2a85106700e97f6Chris Lattner#include "clang/Basic/Builtins.def"
265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer};
275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerconst Builtin::Info &Builtin::Context::GetRecord(unsigned ID) const {
295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  if (ID < Builtin::FirstTSBuiltin)
305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer    return BuiltinInfo[ID];
315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  assert(ID - Builtin::FirstTSBuiltin < NumTSRecords && "Invalid builtin ID!");
325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  return TSRecords[ID - Builtin::FirstTSBuiltin];
335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}
345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
35998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas GregorBuiltin::Context::Context() {
36030e8fe5aabe6a50ed7da3182df8cbce446bfeabChris Lattner  // Get the target specific builtins from the target.
37ff1d4d97a191ca84a703ef8d6c71ef6934090c4dChris Lattner  TSRecords = 0;
38ff1d4d97a191ca84a703ef8d6c71ef6934090c4dChris Lattner  NumTSRecords = 0;
39998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor}
40998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor
41998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregorvoid Builtin::Context::InitializeTarget(const TargetInfo &Target) {
42998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor  assert(NumTSRecords == 0 && "Already initialized target?");
43998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor  Target.getTargetBuiltins(TSRecords, NumTSRecords);
44030e8fe5aabe6a50ed7da3182df8cbce446bfeabChris Lattner}
45030e8fe5aabe6a50ed7da3182df8cbce446bfeabChris Lattner
465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// InitializeBuiltins - Mark the identifiers for all the builtins with their
475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// appropriate builtin ID # and mark any non-portable builtin identifiers as
485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// such.
495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencervoid Builtin::Context::InitializeBuiltins(IdentifierTable &Table,
5067aba816901503d9cf7ba699525fa62cc7f8e5e4Fariborz Jahanian                                          const LangOptions& LangOpts) {
515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  // Step #1: mark all target-independent builtins with their ID's.
525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  for (unsigned i = Builtin::NotBuiltin+1; i != Builtin::FirstTSBuiltin; ++i)
53e7e66f72221d6233bdad3b87a717e7382acd477bEli Friedman    if (!LangOpts.NoBuiltin || !strchr(BuiltinInfo[i].Attributes, 'f')) {
5467aba816901503d9cf7ba699525fa62cc7f8e5e4Fariborz Jahanian      if (LangOpts.ObjC1 ||
5567aba816901503d9cf7ba699525fa62cc7f8e5e4Fariborz Jahanian          BuiltinInfo[i].builtin_lang != clang::OBJC_LANG)
5667aba816901503d9cf7ba699525fa62cc7f8e5e4Fariborz Jahanian        Table.get(BuiltinInfo[i].Name).setBuiltinID(i);
5767aba816901503d9cf7ba699525fa62cc7f8e5e4Fariborz Jahanian    }
581b63e4f732dbc73d90abf886b4d21f8e3a165f6dChris Lattner
5971dfdb9bc91b5d81b124e6091c903e4efd87149dDouglas Gregor  // Step #2: Register target-specific builtins.
605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  for (unsigned i = 0, e = NumTSRecords; i != e; ++i)
61e7e66f72221d6233bdad3b87a717e7382acd477bEli Friedman    if (!LangOpts.NoBuiltin || !strchr(TSRecords[i].Attributes, 'f'))
623573c0c0b44a1ac8f76a00af1bc75e94ca03d704Douglas Gregor      Table.get(TSRecords[i].Name).setBuiltinID(i+Builtin::FirstTSBuiltin);
635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}
645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumpvoid
665f9e272e632e951b1efe824cd16acb4d96077930Chris LattnerBuiltin::Context::GetBuiltinNames(SmallVectorImpl<const char *> &Names,
672deaea37a637dd01221d0cced343702a39d8132cDouglas Gregor                                  bool NoBuiltins) {
682deaea37a637dd01221d0cced343702a39d8132cDouglas Gregor  // Final all target-independent names
692deaea37a637dd01221d0cced343702a39d8132cDouglas Gregor  for (unsigned i = Builtin::NotBuiltin+1; i != Builtin::FirstTSBuiltin; ++i)
70e7e66f72221d6233bdad3b87a717e7382acd477bEli Friedman    if (!NoBuiltins || !strchr(BuiltinInfo[i].Attributes, 'f'))
712deaea37a637dd01221d0cced343702a39d8132cDouglas Gregor      Names.push_back(BuiltinInfo[i].Name);
721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
732deaea37a637dd01221d0cced343702a39d8132cDouglas Gregor  // Find target-specific names.
742deaea37a637dd01221d0cced343702a39d8132cDouglas Gregor  for (unsigned i = 0, e = NumTSRecords; i != e; ++i)
75e7e66f72221d6233bdad3b87a717e7382acd477bEli Friedman    if (!NoBuiltins || !strchr(TSRecords[i].Attributes, 'f'))
762deaea37a637dd01221d0cced343702a39d8132cDouglas Gregor      Names.push_back(TSRecords[i].Name);
772deaea37a637dd01221d0cced343702a39d8132cDouglas Gregor}
782deaea37a637dd01221d0cced343702a39d8132cDouglas Gregor
79b68e39930d06ed81a2b431dc09e4cb97e5c0d57aDouglas Gregorvoid Builtin::Context::ForgetBuiltin(unsigned ID, IdentifierTable &Table) {
80b68e39930d06ed81a2b431dc09e4cb97e5c0d57aDouglas Gregor  Table.get(GetRecord(ID).Name).setBuiltinID(0);
81b68e39930d06ed81a2b431dc09e4cb97e5c0d57aDouglas Gregor}
82b68e39930d06ed81a2b431dc09e4cb97e5c0d57aDouglas Gregor
831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumpbool
841eb4433ac451dc16f4133a88af2d002ac26c58efMike StumpBuiltin::Context::isPrintfLike(unsigned ID, unsigned &FormatIdx,
85a316e7b735b12ce6b34961a9dcfaae34f4b08d29Douglas Gregor                               bool &HasVAListArg) {
86ea684e699ea84e61711e279f5fa7a1b9f3d46bc2Cedric Venet  const char *Printf = strpbrk(GetRecord(ID).Attributes, "pP");
87a316e7b735b12ce6b34961a9dcfaae34f4b08d29Douglas Gregor  if (!Printf)
88a316e7b735b12ce6b34961a9dcfaae34f4b08d29Douglas Gregor    return false;
89a316e7b735b12ce6b34961a9dcfaae34f4b08d29Douglas Gregor
90a316e7b735b12ce6b34961a9dcfaae34f4b08d29Douglas Gregor  HasVAListArg = (*Printf == 'P');
91a316e7b735b12ce6b34961a9dcfaae34f4b08d29Douglas Gregor
92a316e7b735b12ce6b34961a9dcfaae34f4b08d29Douglas Gregor  ++Printf;
93a316e7b735b12ce6b34961a9dcfaae34f4b08d29Douglas Gregor  assert(*Printf == ':' && "p or P specifier must have be followed by a ':'");
94a316e7b735b12ce6b34961a9dcfaae34f4b08d29Douglas Gregor  ++Printf;
95a316e7b735b12ce6b34961a9dcfaae34f4b08d29Douglas Gregor
968a778d6c95b1f937e3158c638793ad06c14e6a37Chris Lattner  assert(strchr(Printf, ':') && "printf specifier must end with a ':'");
97a316e7b735b12ce6b34961a9dcfaae34f4b08d29Douglas Gregor  FormatIdx = strtol(Printf, 0, 10);
98a316e7b735b12ce6b34961a9dcfaae34f4b08d29Douglas Gregor  return true;
99a316e7b735b12ce6b34961a9dcfaae34f4b08d29Douglas Gregor}
100a316e7b735b12ce6b34961a9dcfaae34f4b08d29Douglas Gregor
101bee05c1206dcd525e0a1f066d166ad3e972a500eTed Kremenek// FIXME: Refactor with isPrintfLike.
102bee05c1206dcd525e0a1f066d166ad3e972a500eTed Kremenekbool
103bee05c1206dcd525e0a1f066d166ad3e972a500eTed KremenekBuiltin::Context::isScanfLike(unsigned ID, unsigned &FormatIdx,
104bee05c1206dcd525e0a1f066d166ad3e972a500eTed Kremenek                              bool &HasVAListArg) {
105bee05c1206dcd525e0a1f066d166ad3e972a500eTed Kremenek  const char *Scanf = strpbrk(GetRecord(ID).Attributes, "sS");
106bee05c1206dcd525e0a1f066d166ad3e972a500eTed Kremenek  if (!Scanf)
107bee05c1206dcd525e0a1f066d166ad3e972a500eTed Kremenek    return false;
108bee05c1206dcd525e0a1f066d166ad3e972a500eTed Kremenek
109bee05c1206dcd525e0a1f066d166ad3e972a500eTed Kremenek  HasVAListArg = (*Scanf == 'S');
110bee05c1206dcd525e0a1f066d166ad3e972a500eTed Kremenek
111bee05c1206dcd525e0a1f066d166ad3e972a500eTed Kremenek  ++Scanf;
112bee05c1206dcd525e0a1f066d166ad3e972a500eTed Kremenek  assert(*Scanf == ':' && "s or S specifier must have be followed by a ':'");
113bee05c1206dcd525e0a1f066d166ad3e972a500eTed Kremenek  ++Scanf;
114bee05c1206dcd525e0a1f066d166ad3e972a500eTed Kremenek
115bee05c1206dcd525e0a1f066d166ad3e972a500eTed Kremenek  assert(strchr(Scanf, ':') && "printf specifier must end with a ':'");
116bee05c1206dcd525e0a1f066d166ad3e972a500eTed Kremenek  FormatIdx = strtol(Scanf, 0, 10);
117bee05c1206dcd525e0a1f066d166ad3e972a500eTed Kremenek  return true;
118bee05c1206dcd525e0a1f066d166ad3e972a500eTed Kremenek}
119bee05c1206dcd525e0a1f066d166ad3e972a500eTed Kremenek
120