blob: f2f3ec9aab4482f69c3973f36623c5426412d8ff [file] [log] [blame]
Chris Lattnercf3056d2003-10-13 03:32:08 +00001//===-- Function.cpp - Implement the Global object classes ----------------===//
Misha Brukmanfd939082005-04-21 23:48:37 +00002//
John Criswellb576c942003-10-20 19:43:21 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattner4ee451d2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Misha Brukmanfd939082005-04-21 23:48:37 +00007//
John Criswellb576c942003-10-20 19:43:21 +00008//===----------------------------------------------------------------------===//
Chris Lattner00950542001-06-06 20:29:01 +00009//
Chandler Carruthc2c50cd2013-01-02 09:10:48 +000010// This file implements the Function class for the IR library.
Chris Lattner00950542001-06-06 20:29:01 +000011//
12//===----------------------------------------------------------------------===//
13
Chandler Carruth0b8c9a82013-01-02 11:36:10 +000014#include "llvm/IR/Function.h"
Chris Lattner7e708292002-06-25 16:13:24 +000015#include "SymbolTableListTraitsImpl.h"
Gordon Henriksen80a75bf2007-12-10 03:18:06 +000016#include "llvm/ADT/DenseMap.h"
Rafael Espindola0e00c6c2011-05-16 03:05:33 +000017#include "llvm/ADT/STLExtras.h"
Chris Lattnercaa4ae72004-12-05 06:43:27 +000018#include "llvm/ADT/StringExtras.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000019#include "llvm/CodeGen/ValueTypes.h"
Chandler Carruth0b8c9a82013-01-02 11:36:10 +000020#include "llvm/IR/DerivedTypes.h"
21#include "llvm/IR/IntrinsicInst.h"
22#include "llvm/IR/LLVMContext.h"
23#include "llvm/IR/Module.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000024#include "llvm/Support/CallSite.h"
25#include "llvm/Support/InstIterator.h"
26#include "llvm/Support/LeakDetector.h"
27#include "llvm/Support/ManagedStatic.h"
28#include "llvm/Support/RWMutex.h"
29#include "llvm/Support/StringPool.h"
30#include "llvm/Support/Threading.h"
Chris Lattner31f84992003-11-21 20:23:48 +000031using namespace llvm;
Brian Gaeked0fde302003-11-11 22:41:34 +000032
Chris Lattner7e708292002-06-25 16:13:24 +000033// Explicit instantiations of SymbolTableListTraits since some of the methods
34// are not in the public header file...
John McCallc63ca0a2009-12-19 00:55:12 +000035template class llvm::SymbolTableListTraits<Argument, Function>;
36template class llvm::SymbolTableListTraits<BasicBlock, Function>;
Chris Lattner00950542001-06-06 20:29:01 +000037
Chris Lattner70cc3392001-09-10 07:58:01 +000038//===----------------------------------------------------------------------===//
Chris Lattner80dd50b2002-04-09 19:39:35 +000039// Argument Implementation
40//===----------------------------------------------------------------------===//
41
David Blaikie2d24e2a2011-12-20 02:50:00 +000042void Argument::anchor() { }
43
Chris Lattnerdb125cf2011-07-18 04:54:35 +000044Argument::Argument(Type *Ty, const Twine &Name, Function *Par)
Chris Lattnerdec628e2007-02-12 05:18:08 +000045 : Value(Ty, Value::ArgumentVal) {
Chris Lattnerbded1322002-09-06 21:33:15 +000046 Parent = 0;
Chris Lattnerd1e693f2002-09-08 18:59:35 +000047
48 // Make sure that we get added to a function
49 LeakDetector::addGarbageObject(this);
50
Chris Lattnerbded1322002-09-06 21:33:15 +000051 if (Par)
52 Par->getArgumentList().push_back(this);
Chris Lattnerdec628e2007-02-12 05:18:08 +000053 setName(Name);
Chris Lattnerbded1322002-09-06 21:33:15 +000054}
55
Chris Lattnerbded1322002-09-06 21:33:15 +000056void Argument::setParent(Function *parent) {
Chris Lattnerd1e693f2002-09-08 18:59:35 +000057 if (getParent())
58 LeakDetector::addGarbageObject(this);
Chris Lattnerbded1322002-09-06 21:33:15 +000059 Parent = parent;
Chris Lattnerd1e693f2002-09-08 18:59:35 +000060 if (getParent())
61 LeakDetector::removeGarbageObject(this);
Chris Lattnerbded1322002-09-06 21:33:15 +000062}
63
Chris Lattnerde6fa5f2008-01-24 17:47:11 +000064/// getArgNo - Return the index of this formal argument in its containing
Michael Ilseman0f47e7e2012-12-17 20:37:55 +000065/// function. For example in "void foo(int a, float b)" a is 0 and b is 1.
Chris Lattnerde6fa5f2008-01-24 17:47:11 +000066unsigned Argument::getArgNo() const {
67 const Function *F = getParent();
68 assert(F && "Argument is not in a function");
Michael Ilseman0f47e7e2012-12-17 20:37:55 +000069
Chris Lattnerde6fa5f2008-01-24 17:47:11 +000070 Function::const_arg_iterator AI = F->arg_begin();
71 unsigned ArgIdx = 0;
72 for (; &*AI != this; ++AI)
73 ++ArgIdx;
74
75 return ArgIdx;
76}
77
78/// hasByValAttr - Return true if this argument has the byval attribute on it
79/// in its containing function.
80bool Argument::hasByValAttr() const {
Duncan Sands1df98592010-02-16 11:11:14 +000081 if (!getType()->isPointerTy()) return false;
Bill Wendling39cd0c82012-12-30 12:45:13 +000082 return getParent()->getAttributes().
83 hasAttribute(getArgNo()+1, Attribute::ByVal);
Chris Lattnerde6fa5f2008-01-24 17:47:11 +000084}
85
Chris Lattnerae441cc2011-05-22 23:57:23 +000086unsigned Argument::getParamAlignment() const {
87 assert(getType()->isPointerTy() && "Only pointers have alignments");
88 return getParent()->getParamAlignment(getArgNo()+1);
Michael Ilseman0f47e7e2012-12-17 20:37:55 +000089
Chris Lattnerae441cc2011-05-22 23:57:23 +000090}
91
Duncan Sandsbe1ce0a2009-12-11 08:36:17 +000092/// hasNestAttr - Return true if this argument has the nest attribute on
93/// it in its containing function.
94bool Argument::hasNestAttr() const {
Duncan Sands1df98592010-02-16 11:11:14 +000095 if (!getType()->isPointerTy()) return false;
Bill Wendling39cd0c82012-12-30 12:45:13 +000096 return getParent()->getAttributes().
97 hasAttribute(getArgNo()+1, Attribute::Nest);
Duncan Sandsbe1ce0a2009-12-11 08:36:17 +000098}
99
Chris Lattnerde6fa5f2008-01-24 17:47:11 +0000100/// hasNoAliasAttr - Return true if this argument has the noalias attribute on
101/// it in its containing function.
102bool Argument::hasNoAliasAttr() const {
Duncan Sands1df98592010-02-16 11:11:14 +0000103 if (!getType()->isPointerTy()) return false;
Bill Wendling39cd0c82012-12-30 12:45:13 +0000104 return getParent()->getAttributes().
105 hasAttribute(getArgNo()+1, Attribute::NoAlias);
Chris Lattnerde6fa5f2008-01-24 17:47:11 +0000106}
107
Duncan Sands17da06f2008-12-31 18:08:59 +0000108/// hasNoCaptureAttr - Return true if this argument has the nocapture attribute
109/// on it in its containing function.
110bool Argument::hasNoCaptureAttr() const {
Duncan Sands1df98592010-02-16 11:11:14 +0000111 if (!getType()->isPointerTy()) return false;
Bill Wendling39cd0c82012-12-30 12:45:13 +0000112 return getParent()->getAttributes().
113 hasAttribute(getArgNo()+1, Attribute::NoCapture);
Duncan Sands17da06f2008-12-31 18:08:59 +0000114}
115
Owen Anderson7d542542008-02-17 23:22:28 +0000116/// hasSRetAttr - Return true if this argument has the sret attribute on
117/// it in its containing function.
118bool Argument::hasStructRetAttr() const {
Duncan Sands1df98592010-02-16 11:11:14 +0000119 if (!getType()->isPointerTy()) return false;
Gabor Greifb1dbcd82008-05-15 10:04:30 +0000120 if (this != getParent()->arg_begin())
121 return false; // StructRet param must be first param
Bill Wendling39cd0c82012-12-30 12:45:13 +0000122 return getParent()->getAttributes().
123 hasAttribute(1, Attribute::StructRet);
Owen Anderson7d542542008-02-17 23:22:28 +0000124}
125
Devang Patel05988662008-09-25 21:00:45 +0000126/// addAttr - Add a Attribute to an argument
Bill Wendling034b94b2012-12-19 07:18:57 +0000127void Argument::addAttr(Attribute attr) {
Bill Wendling70d2ca02013-01-23 00:20:53 +0000128 AttrBuilder B(attr);
129 getParent()->addAttributes(getArgNo() + 1,
130 AttributeSet::get(getParent()->getContext(),
131 getArgNo() + 1, B));
Gordon Henriksene2435da2008-04-28 17:37:06 +0000132}
Chris Lattnerde6fa5f2008-01-24 17:47:11 +0000133
Devang Patel05988662008-09-25 21:00:45 +0000134/// removeAttr - Remove a Attribute from an argument
Bill Wendling034b94b2012-12-19 07:18:57 +0000135void Argument::removeAttr(Attribute attr) {
Bill Wendling8246df62013-01-23 00:45:55 +0000136 AttrBuilder B(attr);
137 getParent()->removeAttributes(getArgNo() + 1,
138 AttributeSet::get(getParent()->getContext(),
139 getArgNo() + 1, B));
Duncan Sandscfa3c232008-07-08 09:41:30 +0000140}
Chris Lattnerde6fa5f2008-01-24 17:47:11 +0000141
142
Chris Lattner80dd50b2002-04-09 19:39:35 +0000143//===----------------------------------------------------------------------===//
Chris Lattner50ee9dd2008-01-02 23:42:30 +0000144// Helper Methods in Function
Reid Spencer4746ecf2007-04-09 15:01:12 +0000145//===----------------------------------------------------------------------===//
146
Owen Andersone922c022009-07-22 00:24:57 +0000147LLVMContext &Function::getContext() const {
148 return getType()->getContext();
Owen Anderson62fabf52009-07-02 18:03:58 +0000149}
150
Chris Lattner1afcace2011-07-09 17:41:24 +0000151FunctionType *Function::getFunctionType() const {
Chris Lattner50ee9dd2008-01-02 23:42:30 +0000152 return cast<FunctionType>(getType()->getElementType());
Reid Spencer4746ecf2007-04-09 15:01:12 +0000153}
154
Chris Lattner50ee9dd2008-01-02 23:42:30 +0000155bool Function::isVarArg() const {
156 return getFunctionType()->isVarArg();
Reid Spencer4746ecf2007-04-09 15:01:12 +0000157}
158
Chris Lattner1afcace2011-07-09 17:41:24 +0000159Type *Function::getReturnType() const {
Chris Lattner50ee9dd2008-01-02 23:42:30 +0000160 return getFunctionType()->getReturnType();
Duncan Sands827cde12007-11-25 14:10:56 +0000161}
162
Chris Lattner50ee9dd2008-01-02 23:42:30 +0000163void Function::removeFromParent() {
164 getParent()->getFunctionList().remove(this);
Duncan Sands827cde12007-11-25 14:10:56 +0000165}
166
Chris Lattner50ee9dd2008-01-02 23:42:30 +0000167void Function::eraseFromParent() {
168 getParent()->getFunctionList().erase(this);
Reid Spencer4746ecf2007-04-09 15:01:12 +0000169}
170
Reid Spencer4746ecf2007-04-09 15:01:12 +0000171//===----------------------------------------------------------------------===//
Chris Lattner79df7c02002-03-26 18:01:55 +0000172// Function Implementation
Chris Lattner70cc3392001-09-10 07:58:01 +0000173//===----------------------------------------------------------------------===//
174
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000175Function::Function(FunctionType *Ty, LinkageTypes Linkage,
Daniel Dunbar6e0d1cb2009-07-25 04:41:11 +0000176 const Twine &name, Module *ParentModule)
Michael Ilseman0f47e7e2012-12-17 20:37:55 +0000177 : GlobalValue(PointerType::getUnqual(Ty),
Chris Lattner58d74912008-03-12 17:45:29 +0000178 Value::FunctionVal, 0, 0, Linkage, name) {
Chris Lattnerc8e222b2009-01-05 07:58:59 +0000179 assert(FunctionType::isValidReturnType(getReturnType()) &&
Chris Lattner1afcace2011-07-09 17:41:24 +0000180 "invalid return type");
Reid Spenceref9b9a72007-02-05 20:47:22 +0000181 SymTab = new ValueSymbolTable();
Chris Lattner48270152002-09-06 20:46:32 +0000182
Chris Lattner0162c182007-08-18 06:14:52 +0000183 // If the function has arguments, mark them as lazily built.
184 if (Ty->getNumParams())
Chris Lattnercafe9bb2009-12-29 02:14:09 +0000185 setValueSubclassData(1); // Set the "has lazy arguments" bit.
Michael Ilseman0f47e7e2012-12-17 20:37:55 +0000186
Chris Lattnerd1e693f2002-09-08 18:59:35 +0000187 // Make sure that we get added to a function
188 LeakDetector::addGarbageObject(this);
189
Chris Lattner48270152002-09-06 20:46:32 +0000190 if (ParentModule)
191 ParentModule->getFunctionList().push_back(this);
Duncan Sands79ab3e82008-04-07 13:39:11 +0000192
193 // Ensure intrinsics have the right parameter attributes.
Dale Johannesen49de9822009-02-05 01:49:45 +0000194 if (unsigned IID = getIntrinsicID())
Bill Wendlingcb3de0b2012-10-15 04:46:55 +0000195 setAttributes(Intrinsic::getAttributes(getContext(), Intrinsic::ID(IID)));
Devang Patel81b2ab82008-09-02 20:51:15 +0000196
Chris Lattner00950542001-06-06 20:29:01 +0000197}
198
Gordon Henriksenafba8fe2007-12-10 02:14:30 +0000199Function::~Function() {
200 dropAllReferences(); // After this it is safe to delete instructions.
Chris Lattner00950542001-06-06 20:29:01 +0000201
Chris Lattner00950542001-06-06 20:29:01 +0000202 // Delete all of the method arguments and unlink from symbol table...
Gordon Henriksenafba8fe2007-12-10 02:14:30 +0000203 ArgumentList.clear();
204 delete SymTab;
Reid Spencerb90909e2007-04-22 17:28:03 +0000205
Gordon Henriksen5eca0752008-08-17 18:44:35 +0000206 // Remove the function from the on-the-side GC table.
207 clearGC();
Chris Lattner00950542001-06-06 20:29:01 +0000208}
209
Chris Lattner0162c182007-08-18 06:14:52 +0000210void Function::BuildLazyArguments() const {
211 // Create the arguments vector, all arguments start out unnamed.
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000212 FunctionType *FT = getFunctionType();
Chris Lattner0162c182007-08-18 06:14:52 +0000213 for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) {
Benjamin Kramerf0127052010-01-05 13:12:22 +0000214 assert(!FT->getParamType(i)->isVoidTy() &&
Chris Lattner0162c182007-08-18 06:14:52 +0000215 "Cannot have void typed arguments!");
216 ArgumentList.push_back(new Argument(FT->getParamType(i)));
217 }
Michael Ilseman0f47e7e2012-12-17 20:37:55 +0000218
Chris Lattner0162c182007-08-18 06:14:52 +0000219 // Clear the lazy arguments bit.
Chris Lattnercafe9bb2009-12-29 02:14:09 +0000220 unsigned SDC = getSubclassDataFromValue();
221 const_cast<Function*>(this)->setValueSubclassData(SDC &= ~1);
Chris Lattner0162c182007-08-18 06:14:52 +0000222}
223
224size_t Function::arg_size() const {
225 return getFunctionType()->getNumParams();
226}
227bool Function::arg_empty() const {
228 return getFunctionType()->getNumParams() == 0;
229}
230
Chris Lattnere7506a32002-03-23 22:51:58 +0000231void Function::setParent(Module *parent) {
Chris Lattnerd1e693f2002-09-08 18:59:35 +0000232 if (getParent())
233 LeakDetector::addGarbageObject(this);
Chris Lattner00950542001-06-06 20:29:01 +0000234 Parent = parent;
Chris Lattnerd1e693f2002-09-08 18:59:35 +0000235 if (getParent())
236 LeakDetector::removeGarbageObject(this);
Chris Lattner00950542001-06-06 20:29:01 +0000237}
238
Chris Lattner00950542001-06-06 20:29:01 +0000239// dropAllReferences() - This function causes all the subinstructions to "let
240// go" of all references that they are maintaining. This allows one to
241// 'delete' a whole class at a time, even though there may be circular
242// references... first all references are dropped, and all use counts go to
Misha Brukman6b634522003-10-10 17:54:14 +0000243// zero. Then everything is deleted for real. Note that no operations are
Misha Brukmanfd939082005-04-21 23:48:37 +0000244// valid on an object that has "dropped all references", except operator
Chris Lattner00950542001-06-06 20:29:01 +0000245// delete.
246//
Chris Lattnere7506a32002-03-23 22:51:58 +0000247void Function::dropAllReferences() {
Chris Lattner7e708292002-06-25 16:13:24 +0000248 for (iterator I = begin(), E = end(); I != E; ++I)
249 I->dropAllReferences();
Michael Ilseman0f47e7e2012-12-17 20:37:55 +0000250
Dan Gohmana6399ae2010-12-07 19:56:51 +0000251 // Delete all basic blocks. They are now unused, except possibly by
252 // blockaddresses, but BasicBlock's destructor takes care of those.
253 while (!BasicBlocks.empty())
254 BasicBlocks.begin()->eraseFromParent();
Chris Lattner00950542001-06-06 20:29:01 +0000255}
Chris Lattner70cc3392001-09-10 07:58:01 +0000256
Bill Wendling70d2ca02013-01-23 00:20:53 +0000257void Function::addAttribute(unsigned i, Attribute::AttrKind attr) {
Bill Wendling99faa3b2012-12-07 23:16:57 +0000258 AttributeSet PAL = getAttributes();
Bill Wendling70d2ca02013-01-23 00:20:53 +0000259 PAL = PAL.addAttribute(getContext(), i, attr);
Devang Patel05988662008-09-25 21:00:45 +0000260 setAttributes(PAL);
Eric Christopher0bf7b412008-05-16 20:39:43 +0000261}
262
Bill Wendling70d2ca02013-01-23 00:20:53 +0000263void Function::addAttributes(unsigned i, AttributeSet attrs) {
Bill Wendling99faa3b2012-12-07 23:16:57 +0000264 AttributeSet PAL = getAttributes();
Bill Wendling70d2ca02013-01-23 00:20:53 +0000265 PAL = PAL.addAttributes(getContext(), i, attrs);
266 setAttributes(PAL);
267}
268
Bill Wendling8246df62013-01-23 00:45:55 +0000269void Function::removeAttributes(unsigned i, AttributeSet attrs) {
Bill Wendling70d2ca02013-01-23 00:20:53 +0000270 AttributeSet PAL = getAttributes();
Bill Wendling8246df62013-01-23 00:45:55 +0000271 PAL = PAL.removeAttributes(getContext(), i, attrs);
Devang Patel05988662008-09-25 21:00:45 +0000272 setAttributes(PAL);
Duncan Sandscfa3c232008-07-08 09:41:30 +0000273}
274
Gordon Henriksen5eca0752008-08-17 18:44:35 +0000275// Maintain the GC name for each function in an on-the-side table. This saves
276// allocating an additional word in Function for programs which do not use GC
277// (i.e., most programs) at the cost of increased overhead for clients which do
278// use GC.
Owen Andersonbf5ec1b2009-06-17 23:49:06 +0000279static DenseMap<const Function*,PooledStringPtr> *GCNames;
280static StringPool *GCNamePool;
Owen Andersonb2c0fe42009-06-18 20:56:48 +0000281static ManagedStatic<sys::SmartRWMutex<true> > GCLock;
Gordon Henriksen80a75bf2007-12-10 03:18:06 +0000282
Gordon Henriksen5eca0752008-08-17 18:44:35 +0000283bool Function::hasGC() const {
Owen Andersona9d1f2c2009-07-07 18:33:04 +0000284 sys::SmartScopedReader<true> Reader(*GCLock);
Owen Andersonb2c0fe42009-06-18 20:56:48 +0000285 return GCNames && GCNames->count(this);
Gordon Henriksen80a75bf2007-12-10 03:18:06 +0000286}
287
Gordon Henriksen5eca0752008-08-17 18:44:35 +0000288const char *Function::getGC() const {
289 assert(hasGC() && "Function has no collector");
Owen Andersona9d1f2c2009-07-07 18:33:04 +0000290 sys::SmartScopedReader<true> Reader(*GCLock);
Owen Andersonb2c0fe42009-06-18 20:56:48 +0000291 return *(*GCNames)[this];
Gordon Henriksen80a75bf2007-12-10 03:18:06 +0000292}
293
Gordon Henriksen5eca0752008-08-17 18:44:35 +0000294void Function::setGC(const char *Str) {
Owen Andersona9d1f2c2009-07-07 18:33:04 +0000295 sys::SmartScopedWriter<true> Writer(*GCLock);
Owen Andersonbf5ec1b2009-06-17 23:49:06 +0000296 if (!GCNamePool)
297 GCNamePool = new StringPool();
298 if (!GCNames)
299 GCNames = new DenseMap<const Function*,PooledStringPtr>();
300 (*GCNames)[this] = GCNamePool->intern(Str);
Gordon Henriksen80a75bf2007-12-10 03:18:06 +0000301}
302
Gordon Henriksen5eca0752008-08-17 18:44:35 +0000303void Function::clearGC() {
Owen Andersona9d1f2c2009-07-07 18:33:04 +0000304 sys::SmartScopedWriter<true> Writer(*GCLock);
Owen Andersonbf5ec1b2009-06-17 23:49:06 +0000305 if (GCNames) {
Gordon Henriksen5eca0752008-08-17 18:44:35 +0000306 GCNames->erase(this);
Owen Andersonbf5ec1b2009-06-17 23:49:06 +0000307 if (GCNames->empty()) {
308 delete GCNames;
309 GCNames = 0;
310 if (GCNamePool->empty()) {
311 delete GCNamePool;
312 GCNamePool = 0;
313 }
314 }
315 }
Gordon Henriksen80a75bf2007-12-10 03:18:06 +0000316}
317
Duncan Sands28c3cff2008-05-26 19:58:59 +0000318/// copyAttributesFrom - copy all additional attributes (those not needed to
319/// create a Function) from the Function Src to this one.
320void Function::copyAttributesFrom(const GlobalValue *Src) {
321 assert(isa<Function>(Src) && "Expected a Function!");
322 GlobalValue::copyAttributesFrom(Src);
323 const Function *SrcF = cast<Function>(Src);
324 setCallingConv(SrcF->getCallingConv());
Devang Patel05988662008-09-25 21:00:45 +0000325 setAttributes(SrcF->getAttributes());
Gordon Henriksen5eca0752008-08-17 18:44:35 +0000326 if (SrcF->hasGC())
327 setGC(SrcF->getGC());
328 else
329 clearGC();
Duncan Sands28c3cff2008-05-26 19:58:59 +0000330}
331
Chris Lattnerdd035d12003-05-08 03:47:33 +0000332/// getIntrinsicID - This method returns the ID number of the specified
Brian Gaeked0fde302003-11-11 22:41:34 +0000333/// function, or Intrinsic::not_intrinsic if the function is not an
Misha Brukman6b634522003-10-10 17:54:14 +0000334/// intrinsic, or if the pointer is null. This value is always defined to be
Chris Lattnerdd035d12003-05-08 03:47:33 +0000335/// zero to allow easy checking for whether a function is intrinsic or not. The
336/// particular intrinsic functions which correspond to this value are defined in
337/// llvm/Intrinsics.h.
338///
Dale Johannesen49de9822009-02-05 01:49:45 +0000339unsigned Function::getIntrinsicID() const {
Chris Lattner3b515802007-02-15 19:17:16 +0000340 const ValueName *ValName = this->getValueName();
Michael Ilsemanf846f162012-12-19 23:17:20 +0000341 if (!ValName || !isIntrinsic())
Reid Spencer085659f2007-04-16 07:08:44 +0000342 return 0;
Chris Lattner3b515802007-02-15 19:17:16 +0000343 unsigned Len = ValName->getKeyLength();
344 const char *Name = ValName->getKeyData();
Michael Ilseman0f47e7e2012-12-17 20:37:55 +0000345
Chris Lattner9a016ff2006-03-09 20:35:01 +0000346#define GET_FUNCTION_RECOGNIZER
Chandler Carruth351ba142013-01-02 12:09:16 +0000347#include "llvm/IR/Intrinsics.gen"
Chris Lattner9a016ff2006-03-09 20:35:01 +0000348#undef GET_FUNCTION_RECOGNIZER
Chris Lattnerdd035d12003-05-08 03:47:33 +0000349 return 0;
350}
351
Benjamin Kramereb9a85f2011-07-14 17:45:39 +0000352std::string Intrinsic::getName(ID id, ArrayRef<Type*> Tys) {
Chris Lattnerb8474232006-03-25 06:32:47 +0000353 assert(id < num_intrinsics && "Invalid intrinsic ID!");
Chris Lattner607b8eb2011-04-25 22:14:33 +0000354 static const char * const Table[] = {
Chris Lattnerb8474232006-03-25 06:32:47 +0000355 "not_intrinsic",
356#define GET_INTRINSIC_NAME_TABLE
Chandler Carruth351ba142013-01-02 12:09:16 +0000357#include "llvm/IR/Intrinsics.gen"
Chris Lattnerb8474232006-03-25 06:32:47 +0000358#undef GET_INTRINSIC_NAME_TABLE
359 };
Benjamin Kramereb9a85f2011-07-14 17:45:39 +0000360 if (Tys.empty())
Reid Spencer1437a092007-04-01 07:25:33 +0000361 return Table[id];
362 std::string Result(Table[id]);
Benjamin Kramereb9a85f2011-07-14 17:45:39 +0000363 for (unsigned i = 0; i < Tys.size(); ++i) {
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000364 if (PointerType* PTyp = dyn_cast<PointerType>(Tys[i])) {
Michael Ilseman0f47e7e2012-12-17 20:37:55 +0000365 Result += ".p" + llvm::utostr(PTyp->getAddressSpace()) +
Owen Andersone50ed302009-08-10 22:56:29 +0000366 EVT::getEVT(PTyp->getElementType()).getEVTString();
Mon P Wange3b3a722008-07-30 04:36:53 +0000367 }
368 else if (Tys[i])
Owen Andersone50ed302009-08-10 22:56:29 +0000369 Result += "." + EVT::getEVT(Tys[i]).getEVTString();
Mon P Wange3b3a722008-07-30 04:36:53 +0000370 }
Reid Spencer1437a092007-04-01 07:25:33 +0000371 return Result;
Chris Lattnerb8474232006-03-25 06:32:47 +0000372}
373
Chris Lattnera98aa6a2012-05-16 06:34:44 +0000374
Chris Lattner908a8312012-05-27 18:28:35 +0000375/// IIT_Info - These are enumerators that describe the entries returned by the
376/// getIntrinsicInfoTableEntries function.
377///
378/// NOTE: This must be kept in synch with the copy in TblGen/IntrinsicEmitter!
379enum IIT_Info {
380 // Common values should be encoded with 0-15.
381 IIT_Done = 0,
382 IIT_I1 = 1,
383 IIT_I8 = 2,
384 IIT_I16 = 3,
385 IIT_I32 = 4,
386 IIT_I64 = 5,
Michael Ilseman4d0b4a42013-01-11 01:45:05 +0000387 IIT_F16 = 6,
388 IIT_F32 = 7,
389 IIT_F64 = 8,
390 IIT_V2 = 9,
391 IIT_V4 = 10,
392 IIT_V8 = 11,
393 IIT_V16 = 12,
394 IIT_V32 = 13,
Chris Lattner908a8312012-05-27 18:28:35 +0000395 IIT_PTR = 14,
396 IIT_ARG = 15,
Michael Ilseman0f47e7e2012-12-17 20:37:55 +0000397
Chris Lattner908a8312012-05-27 18:28:35 +0000398 // Values from 16+ are only encodable with the inefficient encoding.
Michael Ilseman4d0b4a42013-01-11 01:45:05 +0000399 IIT_MMX = 16,
400 IIT_METADATA = 17,
401 IIT_EMPTYSTRUCT = 18,
402 IIT_STRUCT2 = 19,
403 IIT_STRUCT3 = 20,
404 IIT_STRUCT4 = 21,
405 IIT_STRUCT5 = 22,
406 IIT_EXTEND_VEC_ARG = 23,
407 IIT_TRUNC_VEC_ARG = 24,
408 IIT_ANYPTR = 25
Chris Lattner908a8312012-05-27 18:28:35 +0000409};
410
411
412static void DecodeIITType(unsigned &NextElt, ArrayRef<unsigned char> Infos,
413 SmallVectorImpl<Intrinsic::IITDescriptor> &OutputTable) {
Chris Lattner626b1082012-05-17 05:13:57 +0000414 IIT_Info Info = IIT_Info(Infos[NextElt++]);
Chris Lattnerd7cf5eb2012-05-17 05:03:24 +0000415 unsigned StructElts = 2;
Chris Lattner908a8312012-05-27 18:28:35 +0000416 using namespace Intrinsic;
Michael Ilseman0f47e7e2012-12-17 20:37:55 +0000417
Chris Lattner626b1082012-05-17 05:13:57 +0000418 switch (Info) {
Chris Lattner908a8312012-05-27 18:28:35 +0000419 case IIT_Done:
420 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Void, 0));
421 return;
422 case IIT_MMX:
423 OutputTable.push_back(IITDescriptor::get(IITDescriptor::MMX, 0));
424 return;
425 case IIT_METADATA:
426 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Metadata, 0));
427 return;
Michael Ilseman4d0b4a42013-01-11 01:45:05 +0000428 case IIT_F16:
429 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Half, 0));
430 return;
Chris Lattner908a8312012-05-27 18:28:35 +0000431 case IIT_F32:
432 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Float, 0));
433 return;
434 case IIT_F64:
435 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Double, 0));
436 return;
437 case IIT_I1:
438 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer, 1));
439 return;
440 case IIT_I8:
441 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer, 8));
442 return;
443 case IIT_I16:
444 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer,16));
445 return;
446 case IIT_I32:
447 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer, 32));
448 return;
449 case IIT_I64:
450 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer, 64));
451 return;
Chris Lattner46aaf692012-05-17 04:30:58 +0000452 case IIT_V2:
Chris Lattner908a8312012-05-27 18:28:35 +0000453 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 2));
454 DecodeIITType(NextElt, Infos, OutputTable);
455 return;
Chris Lattner46aaf692012-05-17 04:30:58 +0000456 case IIT_V4:
Chris Lattner908a8312012-05-27 18:28:35 +0000457 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 4));
458 DecodeIITType(NextElt, Infos, OutputTable);
459 return;
Chris Lattner46aaf692012-05-17 04:30:58 +0000460 case IIT_V8:
Chris Lattner908a8312012-05-27 18:28:35 +0000461 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 8));
462 DecodeIITType(NextElt, Infos, OutputTable);
463 return;
Chris Lattner46aaf692012-05-17 04:30:58 +0000464 case IIT_V16:
Chris Lattner908a8312012-05-27 18:28:35 +0000465 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 16));
466 DecodeIITType(NextElt, Infos, OutputTable);
467 return;
Chris Lattnerd7cf5eb2012-05-17 05:03:24 +0000468 case IIT_V32:
Chris Lattner908a8312012-05-27 18:28:35 +0000469 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 32));
470 DecodeIITType(NextElt, Infos, OutputTable);
471 return;
Chris Lattnera48289a2012-05-23 05:19:18 +0000472 case IIT_PTR:
Chris Lattner908a8312012-05-27 18:28:35 +0000473 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Pointer, 0));
474 DecodeIITType(NextElt, Infos, OutputTable);
475 return;
Chris Lattnera48289a2012-05-23 05:19:18 +0000476 case IIT_ANYPTR: { // [ANYPTR addrspace, subtype]
Michael Ilseman0f47e7e2012-12-17 20:37:55 +0000477 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Pointer,
Chris Lattner908a8312012-05-27 18:28:35 +0000478 Infos[NextElt++]));
479 DecodeIITType(NextElt, Infos, OutputTable);
480 return;
Pete Cooperb4285112012-05-21 23:21:28 +0000481 }
Chris Lattner908a8312012-05-27 18:28:35 +0000482 case IIT_ARG: {
483 unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
484 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Argument, ArgInfo));
485 return;
486 }
487 case IIT_EXTEND_VEC_ARG: {
488 unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
489 OutputTable.push_back(IITDescriptor::get(IITDescriptor::ExtendVecArgument,
490 ArgInfo));
491 return;
492 }
Chris Lattnerd7cf5eb2012-05-17 05:03:24 +0000493 case IIT_TRUNC_VEC_ARG: {
Chris Lattner908a8312012-05-27 18:28:35 +0000494 unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
495 OutputTable.push_back(IITDescriptor::get(IITDescriptor::TruncVecArgument,
496 ArgInfo));
497 return;
Chris Lattnerd7cf5eb2012-05-17 05:03:24 +0000498 }
Chris Lattner908a8312012-05-27 18:28:35 +0000499 case IIT_EMPTYSTRUCT:
500 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Struct, 0));
501 return;
Chris Lattnerd7cf5eb2012-05-17 05:03:24 +0000502 case IIT_STRUCT5: ++StructElts; // FALL THROUGH.
503 case IIT_STRUCT4: ++StructElts; // FALL THROUGH.
504 case IIT_STRUCT3: ++StructElts; // FALL THROUGH.
505 case IIT_STRUCT2: {
Chris Lattner908a8312012-05-27 18:28:35 +0000506 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Struct,StructElts));
507
Chris Lattnerd7cf5eb2012-05-17 05:03:24 +0000508 for (unsigned i = 0; i != StructElts; ++i)
Chris Lattner908a8312012-05-27 18:28:35 +0000509 DecodeIITType(NextElt, Infos, OutputTable);
510 return;
Chris Lattner46aaf692012-05-17 04:30:58 +0000511 }
Chris Lattnera98aa6a2012-05-16 06:34:44 +0000512 }
513 llvm_unreachable("unhandled");
514}
Chris Lattnera98aa6a2012-05-16 06:34:44 +0000515
Chris Lattner908a8312012-05-27 18:28:35 +0000516
517#define GET_INTRINSIC_GENERATOR_GLOBAL
Chandler Carruth351ba142013-01-02 12:09:16 +0000518#include "llvm/IR/Intrinsics.gen"
Chris Lattner908a8312012-05-27 18:28:35 +0000519#undef GET_INTRINSIC_GENERATOR_GLOBAL
520
Michael Ilseman0f47e7e2012-12-17 20:37:55 +0000521void Intrinsic::getIntrinsicInfoTableEntries(ID id,
Chris Lattner908a8312012-05-27 18:28:35 +0000522 SmallVectorImpl<IITDescriptor> &T){
Chris Lattnera98aa6a2012-05-16 06:34:44 +0000523 // Check to see if the intrinsic's type was expressible by the table.
524 unsigned TableVal = IIT_Table[id-1];
Michael Ilseman0f47e7e2012-12-17 20:37:55 +0000525
Chris Lattner387c9dc2012-05-17 15:55:41 +0000526 // Decode the TableVal into an array of IITValues.
527 SmallVector<unsigned char, 8> IITValues;
528 ArrayRef<unsigned char> IITEntries;
529 unsigned NextElt = 0;
530 if ((TableVal >> 31) != 0) {
531 // This is an offset into the IIT_LongEncodingTable.
532 IITEntries = IIT_LongEncodingTable;
Michael Ilseman0f47e7e2012-12-17 20:37:55 +0000533
Chris Lattner387c9dc2012-05-17 15:55:41 +0000534 // Strip sentinel bit.
535 NextElt = (TableVal << 1) >> 1;
536 } else {
Chris Lattner908a8312012-05-27 18:28:35 +0000537 // Decode the TableVal into an array of IITValues. If the entry was encoded
538 // into a single word in the table itself, decode it now.
Chris Lattner626b1082012-05-17 05:13:57 +0000539 do {
540 IITValues.push_back(TableVal & 0xF);
541 TableVal >>= 4;
542 } while (TableVal);
Michael Ilseman0f47e7e2012-12-17 20:37:55 +0000543
Chris Lattner387c9dc2012-05-17 15:55:41 +0000544 IITEntries = IITValues;
545 NextElt = 0;
Chris Lattnera98aa6a2012-05-16 06:34:44 +0000546 }
Chris Lattner908a8312012-05-27 18:28:35 +0000547
548 // Okay, decode the table into the output vector of IITDescriptors.
549 DecodeIITType(NextElt, IITEntries, T);
550 while (NextElt != IITEntries.size() && IITEntries[NextElt] != 0)
551 DecodeIITType(NextElt, IITEntries, T);
552}
553
554
555static Type *DecodeFixedType(ArrayRef<Intrinsic::IITDescriptor> &Infos,
556 ArrayRef<Type*> Tys, LLVMContext &Context) {
557 using namespace Intrinsic;
558 IITDescriptor D = Infos.front();
559 Infos = Infos.slice(1);
Michael Ilseman0f47e7e2012-12-17 20:37:55 +0000560
Chris Lattner908a8312012-05-27 18:28:35 +0000561 switch (D.Kind) {
562 case IITDescriptor::Void: return Type::getVoidTy(Context);
563 case IITDescriptor::MMX: return Type::getX86_MMXTy(Context);
564 case IITDescriptor::Metadata: return Type::getMetadataTy(Context);
Michael Ilseman4d0b4a42013-01-11 01:45:05 +0000565 case IITDescriptor::Half: return Type::getHalfTy(Context);
Chris Lattner908a8312012-05-27 18:28:35 +0000566 case IITDescriptor::Float: return Type::getFloatTy(Context);
567 case IITDescriptor::Double: return Type::getDoubleTy(Context);
Michael Ilseman0f47e7e2012-12-17 20:37:55 +0000568
Chris Lattner908a8312012-05-27 18:28:35 +0000569 case IITDescriptor::Integer:
570 return IntegerType::get(Context, D.Integer_Width);
571 case IITDescriptor::Vector:
572 return VectorType::get(DecodeFixedType(Infos, Tys, Context),D.Vector_Width);
573 case IITDescriptor::Pointer:
574 return PointerType::get(DecodeFixedType(Infos, Tys, Context),
575 D.Pointer_AddressSpace);
576 case IITDescriptor::Struct: {
577 Type *Elts[5];
578 assert(D.Struct_NumElements <= 5 && "Can't handle this yet");
579 for (unsigned i = 0, e = D.Struct_NumElements; i != e; ++i)
580 Elts[i] = DecodeFixedType(Infos, Tys, Context);
581 return StructType::get(Context, ArrayRef<Type*>(Elts,D.Struct_NumElements));
582 }
583
584 case IITDescriptor::Argument:
585 return Tys[D.getArgumentNumber()];
586 case IITDescriptor::ExtendVecArgument:
587 return VectorType::getExtendedElementVectorType(cast<VectorType>(
588 Tys[D.getArgumentNumber()]));
Michael Ilseman0f47e7e2012-12-17 20:37:55 +0000589
Chris Lattner908a8312012-05-27 18:28:35 +0000590 case IITDescriptor::TruncVecArgument:
591 return VectorType::getTruncatedElementVectorType(cast<VectorType>(
592 Tys[D.getArgumentNumber()]));
593 }
594 llvm_unreachable("unhandled");
595}
596
597
598
599FunctionType *Intrinsic::getType(LLVMContext &Context,
600 ID id, ArrayRef<Type*> Tys) {
601 SmallVector<IITDescriptor, 8> Table;
602 getIntrinsicInfoTableEntries(id, Table);
Michael Ilseman0f47e7e2012-12-17 20:37:55 +0000603
Chris Lattner908a8312012-05-27 18:28:35 +0000604 ArrayRef<IITDescriptor> TableRef = Table;
605 Type *ResultTy = DecodeFixedType(TableRef, Tys, Context);
Michael Ilseman0f47e7e2012-12-17 20:37:55 +0000606
Chris Lattner387c9dc2012-05-17 15:55:41 +0000607 SmallVector<Type*, 8> ArgTys;
Chris Lattner908a8312012-05-27 18:28:35 +0000608 while (!TableRef.empty())
609 ArgTys.push_back(DecodeFixedType(TableRef, Tys, Context));
Jim Laskey95af5922007-02-07 20:38:26 +0000610
Michael Ilseman0f47e7e2012-12-17 20:37:55 +0000611 return FunctionType::get(ResultTy, ArgTys, false);
Jim Laskey95af5922007-02-07 20:38:26 +0000612}
613
Mon P Wang0d52ff12009-02-24 23:17:49 +0000614bool Intrinsic::isOverloaded(ID id) {
Mon P Wang0d52ff12009-02-24 23:17:49 +0000615#define GET_INTRINSIC_OVERLOAD_TABLE
Chandler Carruth351ba142013-01-02 12:09:16 +0000616#include "llvm/IR/Intrinsics.gen"
Mon P Wang0d52ff12009-02-24 23:17:49 +0000617#undef GET_INTRINSIC_OVERLOAD_TABLE
Mon P Wang0d52ff12009-02-24 23:17:49 +0000618}
619
Chris Lattner048ffb22009-01-12 01:18:58 +0000620/// This defines the "Intrinsic::getAttributes(ID id)" method.
Duncan Sandsa3355ff2007-12-03 20:06:50 +0000621#define GET_INTRINSIC_ATTRIBUTES
Chandler Carruth351ba142013-01-02 12:09:16 +0000622#include "llvm/IR/Intrinsics.gen"
Duncan Sandsa3355ff2007-12-03 20:06:50 +0000623#undef GET_INTRINSIC_ATTRIBUTES
624
Benjamin Kramereb9a85f2011-07-14 17:45:39 +0000625Function *Intrinsic::getDeclaration(Module *M, ID id, ArrayRef<Type*> Tys) {
Duncan Sandsa3355ff2007-12-03 20:06:50 +0000626 // There can never be multiple globals with the same name of different types,
627 // because intrinsics must be a specific type.
Duncan Sands79ab3e82008-04-07 13:39:11 +0000628 return
Benjamin Kramereb9a85f2011-07-14 17:45:39 +0000629 cast<Function>(M->getOrInsertFunction(getName(id, Tys),
630 getType(M->getContext(), id, Tys)));
Jim Laskey95af5922007-02-07 20:38:26 +0000631}
632
Dale Johannesen49de9822009-02-05 01:49:45 +0000633// This defines the "Intrinsic::getIntrinsicForGCCBuiltin()" method.
634#define GET_LLVM_INTRINSIC_FOR_GCC_BUILTIN
Chandler Carruth351ba142013-01-02 12:09:16 +0000635#include "llvm/IR/Intrinsics.gen"
Dale Johannesen49de9822009-02-05 01:49:45 +0000636#undef GET_LLVM_INTRINSIC_FOR_GCC_BUILTIN
637
Gabor Greif0054c7a2010-03-23 14:40:20 +0000638/// hasAddressTaken - returns true if there are any uses of this function
639/// other than direct calls or invokes to it.
Gabor Greifc9f75002010-03-24 13:21:49 +0000640bool Function::hasAddressTaken(const User* *PutOffender) const {
Gabor Greif60ad7812010-03-25 23:06:16 +0000641 for (Value::const_use_iterator I = use_begin(), E = use_end(); I != E; ++I) {
Gabor Greifc9f75002010-03-24 13:21:49 +0000642 const User *U = *I;
Jay Foadb7454fd2012-05-12 08:30:16 +0000643 if (isa<BlockAddress>(U))
644 continue;
Gabor Greifc9f75002010-03-24 13:21:49 +0000645 if (!isa<CallInst>(U) && !isa<InvokeInst>(U))
646 return PutOffender ? (*PutOffender = U, true) : true;
Gabor Greifc8b82cc2010-04-01 08:21:08 +0000647 ImmutableCallSite CS(cast<Instruction>(U));
Gabor Greifc9f75002010-03-24 13:21:49 +0000648 if (!CS.isCallee(I))
649 return PutOffender ? (*PutOffender = U, true) : true;
Jay Foad757068f2009-06-10 08:41:11 +0000650 }
651 return false;
652}
653
Eli Friedmanc6633052011-10-20 05:23:42 +0000654bool Function::isDefTriviallyDead() const {
655 // Check the linkage
656 if (!hasLinkOnceLinkage() && !hasLocalLinkage() &&
657 !hasAvailableExternallyLinkage())
658 return false;
659
660 // Check if the function is used by anything other than a blockaddress.
661 for (Value::const_use_iterator I = use_begin(), E = use_end(); I != E; ++I)
662 if (!isa<BlockAddress>(*I))
663 return false;
664
665 return true;
666}
667
Bill Wendling3c5e6092011-10-17 18:43:40 +0000668/// callsFunctionThatReturnsTwice - Return true if the function has a call to
669/// setjmp or other function that gcc recognizes as "returning twice".
670bool Function::callsFunctionThatReturnsTwice() const {
671 for (const_inst_iterator
672 I = inst_begin(this), E = inst_end(this); I != E; ++I) {
673 const CallInst* callInst = dyn_cast<CallInst>(&*I);
674 if (!callInst)
675 continue;
676 if (callInst->canReturnTwice())
677 return true;
678 }
679
680 return false;
681}
682