blob: e1f5fdea44e4ebd71b7a1998fed4069284d7f006 [file] [log] [blame]
Chris Lattner44d2c352003-10-13 03:32:08 +00001//===-- Function.cpp - Implement the Global object classes ----------------===//
Misha Brukmanb1c93172005-04-21 23:48:37 +00002//
John Criswell482202a2003-10-20 19:43:21 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattnerf3ebc3f2007-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 Brukmanb1c93172005-04-21 23:48:37 +00007//
John Criswell482202a2003-10-20 19:43:21 +00008//===----------------------------------------------------------------------===//
Chris Lattner2f7c9632001-06-06 20:29:01 +00009//
Chandler Carruthef860a22013-01-02 09:10:48 +000010// This file implements the Function class for the IR library.
Chris Lattner2f7c9632001-06-06 20:29:01 +000011//
12//===----------------------------------------------------------------------===//
13
Chandler Carruth9fb823b2013-01-02 11:36:10 +000014#include "llvm/IR/Function.h"
Michael Ilseman516d7032013-03-01 18:48:54 +000015#include "LLVMContextImpl.h"
Chris Lattner113f4f42002-06-25 16:13:24 +000016#include "SymbolTableListTraitsImpl.h"
Rafael Espindola2050af82011-05-16 03:05:33 +000017#include "llvm/ADT/STLExtras.h"
Chris Lattnerb392d302004-12-05 06:43:27 +000018#include "llvm/ADT/StringExtras.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000019#include "llvm/CodeGen/ValueTypes.h"
Chandler Carruth219b89b2014-03-04 11:01:28 +000020#include "llvm/IR/CallSite.h"
Diego Novillo2567f3d2015-05-13 15:13:45 +000021#include "llvm/IR/Constants.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000022#include "llvm/IR/DerivedTypes.h"
Chandler Carruth83948572014-03-04 10:30:26 +000023#include "llvm/IR/InstIterator.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000024#include "llvm/IR/IntrinsicInst.h"
25#include "llvm/IR/LLVMContext.h"
Diego Novillo2567f3d2015-05-13 15:13:45 +000026#include "llvm/IR/MDBuilder.h"
27#include "llvm/IR/Metadata.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000028#include "llvm/IR/Module.h"
Chris Lattner189d19f2003-11-21 20:23:48 +000029using namespace llvm;
Brian Gaeke960707c2003-11-11 22:41:34 +000030
Chris Lattner113f4f42002-06-25 16:13:24 +000031// Explicit instantiations of SymbolTableListTraits since some of the methods
32// are not in the public header file...
Duncan P. N. Exon Smith37bf6782015-10-07 20:05:10 +000033template class llvm::SymbolTableListTraits<BasicBlock>;
Chris Lattner2f7c9632001-06-06 20:29:01 +000034
Chris Lattnerda975502001-09-10 07:58:01 +000035//===----------------------------------------------------------------------===//
Chris Lattnerd255ae22002-04-09 19:39:35 +000036// Argument Implementation
37//===----------------------------------------------------------------------===//
38
David Blaikiea379b1812011-12-20 02:50:00 +000039void Argument::anchor() { }
40
Reid Kleckner56d028d2017-03-17 17:16:39 +000041Argument::Argument(Type *Ty, const Twine &Name, Function *Par, unsigned ArgNo)
42 : Value(Ty, Value::ArgumentVal), Parent(Par), ArgNo(ArgNo) {
Chris Lattner32ab6432007-02-12 05:18:08 +000043 setName(Name);
Chris Lattner9ed7aef2002-09-06 21:33:15 +000044}
45
Chris Lattner9ed7aef2002-09-06 21:33:15 +000046void Argument::setParent(Function *parent) {
47 Parent = parent;
48}
49
Nick Lewyckyd52b1522014-05-20 01:23:40 +000050bool Argument::hasNonNullAttr() const {
51 if (!getType()->isPointerTy()) return false;
Reid Klecknerf021fab2017-04-13 23:12:13 +000052 if (getParent()->hasParamAttribute(getArgNo(), Attribute::NonNull))
Hal Finkelb0407ba2014-07-18 15:51:28 +000053 return true;
54 else if (getDereferenceableBytes() > 0 &&
55 getType()->getPointerAddressSpace() == 0)
56 return true;
57 return false;
Nick Lewyckyd52b1522014-05-20 01:23:40 +000058}
59
Chris Lattnere30f09d2008-01-24 17:47:11 +000060bool Argument::hasByValAttr() const {
Duncan Sands19d0b472010-02-16 11:11:14 +000061 if (!getType()->isPointerTy()) return false;
Amaury Sechet7b05a4c2016-03-14 01:37:29 +000062 return hasAttribute(Attribute::ByVal);
Chris Lattnere30f09d2008-01-24 17:47:11 +000063}
64
Manman Renf46262e2016-03-29 17:37:21 +000065bool Argument::hasSwiftSelfAttr() const {
Reid Klecknerf021fab2017-04-13 23:12:13 +000066 return getParent()->hasParamAttribute(getArgNo(), Attribute::SwiftSelf);
Manman Renf46262e2016-03-29 17:37:21 +000067}
68
Manman Ren9bfd0d02016-04-01 21:41:15 +000069bool Argument::hasSwiftErrorAttr() const {
Reid Klecknerf021fab2017-04-13 23:12:13 +000070 return getParent()->hasParamAttribute(getArgNo(), Attribute::SwiftError);
Manman Ren9bfd0d02016-04-01 21:41:15 +000071}
72
Reid Klecknera534a382013-12-19 02:14:12 +000073bool Argument::hasInAllocaAttr() const {
74 if (!getType()->isPointerTy()) return false;
Amaury Sechet7b05a4c2016-03-14 01:37:29 +000075 return hasAttribute(Attribute::InAlloca);
Reid Klecknera534a382013-12-19 02:14:12 +000076}
77
Reid Kleckner436c42e2014-01-17 23:58:17 +000078bool Argument::hasByValOrInAllocaAttr() const {
79 if (!getType()->isPointerTy()) return false;
Reid Klecknerb5180542017-03-21 16:57:19 +000080 AttributeList Attrs = getParent()->getAttributes();
Reid Klecknerf021fab2017-04-13 23:12:13 +000081 return Attrs.hasParamAttribute(getArgNo(), Attribute::ByVal) ||
82 Attrs.hasParamAttribute(getArgNo(), Attribute::InAlloca);
Reid Kleckner436c42e2014-01-17 23:58:17 +000083}
84
Chris Lattner4d37d992011-05-22 23:57:23 +000085unsigned Argument::getParamAlignment() const {
86 assert(getType()->isPointerTy() && "Only pointers have alignments");
87 return getParent()->getParamAlignment(getArgNo()+1);
Michael Ilsemanacdb76d2012-12-17 20:37:55 +000088
Chris Lattner4d37d992011-05-22 23:57:23 +000089}
90
Hal Finkelb0407ba2014-07-18 15:51:28 +000091uint64_t Argument::getDereferenceableBytes() const {
92 assert(getType()->isPointerTy() &&
93 "Only pointers have dereferenceable bytes");
94 return getParent()->getDereferenceableBytes(getArgNo()+1);
95}
96
Sanjoy Das06cf33f2015-05-06 17:41:54 +000097uint64_t Argument::getDereferenceableOrNullBytes() const {
98 assert(getType()->isPointerTy() &&
99 "Only pointers have dereferenceable bytes");
100 return getParent()->getDereferenceableOrNullBytes(getArgNo()+1);
101}
102
Duncan Sands5d96f3f2009-12-11 08:36:17 +0000103bool Argument::hasNestAttr() const {
Duncan Sands19d0b472010-02-16 11:11:14 +0000104 if (!getType()->isPointerTy()) return false;
Amaury Sechet7b05a4c2016-03-14 01:37:29 +0000105 return hasAttribute(Attribute::Nest);
Duncan Sands5d96f3f2009-12-11 08:36:17 +0000106}
107
Chris Lattnere30f09d2008-01-24 17:47:11 +0000108bool Argument::hasNoAliasAttr() const {
Duncan Sands19d0b472010-02-16 11:11:14 +0000109 if (!getType()->isPointerTy()) return false;
Amaury Sechet7b05a4c2016-03-14 01:37:29 +0000110 return hasAttribute(Attribute::NoAlias);
Chris Lattnere30f09d2008-01-24 17:47:11 +0000111}
112
Duncan Sandsdf128eb2008-12-31 18:08:59 +0000113bool Argument::hasNoCaptureAttr() const {
Duncan Sands19d0b472010-02-16 11:11:14 +0000114 if (!getType()->isPointerTy()) return false;
Amaury Sechet7b05a4c2016-03-14 01:37:29 +0000115 return hasAttribute(Attribute::NoCapture);
Duncan Sandsdf128eb2008-12-31 18:08:59 +0000116}
117
Owen Andersonc64dfb42008-02-17 23:22:28 +0000118bool Argument::hasStructRetAttr() const {
Duncan Sands19d0b472010-02-16 11:11:14 +0000119 if (!getType()->isPointerTy()) return false;
Amaury Sechet7b05a4c2016-03-14 01:37:29 +0000120 return hasAttribute(Attribute::StructRet);
Owen Andersonc64dfb42008-02-17 23:22:28 +0000121}
122
Stephen Linb8bd2322013-04-20 05:14:40 +0000123bool Argument::hasReturnedAttr() const {
Amaury Sechet7b05a4c2016-03-14 01:37:29 +0000124 return hasAttribute(Attribute::Returned);
Stephen Linb8bd2322013-04-20 05:14:40 +0000125}
126
Juergen Ributzka384c3b52014-08-05 05:43:41 +0000127bool Argument::hasZExtAttr() const {
Amaury Sechet7b05a4c2016-03-14 01:37:29 +0000128 return hasAttribute(Attribute::ZExt);
Juergen Ributzka384c3b52014-08-05 05:43:41 +0000129}
130
Juergen Ributzka384c3b52014-08-05 05:43:41 +0000131bool Argument::hasSExtAttr() const {
Amaury Sechet7b05a4c2016-03-14 01:37:29 +0000132 return hasAttribute(Attribute::SExt);
Juergen Ributzka384c3b52014-08-05 05:43:41 +0000133}
134
Nick Lewyckyc2ec0722013-07-06 00:29:58 +0000135bool Argument::onlyReadsMemory() const {
Reid Klecknerf021fab2017-04-13 23:12:13 +0000136 AttributeList Attrs = getParent()->getAttributes();
137 return Attrs.hasParamAttribute(getArgNo(), Attribute::ReadOnly) ||
138 Attrs.hasParamAttribute(getArgNo(), Attribute::ReadNone);
Nick Lewyckyc2ec0722013-07-06 00:29:58 +0000139}
140
Reid Kleckner9d16fa02017-04-19 17:28:52 +0000141void Argument::addAttrs(AttrBuilder &B) {
142 AttributeList AL = getParent()->getAttributes();
143 AL = AL.addAttributes(Parent->getContext(), getArgNo() + 1, B);
144 getParent()->setAttributes(AL);
145}
146
147void Argument::addAttr(Attribute::AttrKind Kind) {
148 getParent()->addAttribute(getArgNo() + 1, Kind);
149}
150
151void Argument::addAttr(Attribute Attr) {
152 getParent()->addAttribute(getArgNo() + 1, Attr);
Gordon Henriksen2d9cc212008-04-28 17:37:06 +0000153}
Chris Lattnere30f09d2008-01-24 17:47:11 +0000154
Reid Klecknerb5180542017-03-21 16:57:19 +0000155void Argument::removeAttr(AttributeList AS) {
Bill Wendlingefbbbfd2013-02-21 19:46:51 +0000156 assert(AS.getNumSlots() <= 1 &&
Bill Wendling1c20ff02013-02-20 23:04:11 +0000157 "Trying to remove more than one attribute set from an argument!");
158 AttrBuilder B(AS, AS.getSlotIndex(0));
Reid Klecknerb5180542017-03-21 16:57:19 +0000159 getParent()->removeAttributes(
160 getArgNo() + 1,
161 AttributeList::get(Parent->getContext(), getArgNo() + 1, B));
Duncan Sands66336db2008-07-08 09:41:30 +0000162}
Chris Lattnere30f09d2008-01-24 17:47:11 +0000163
Reid Kleckner9d16fa02017-04-19 17:28:52 +0000164void Argument::removeAttr(Attribute::AttrKind Kind) {
165 getParent()->removeAttribute(getArgNo() + 1, Kind);
166}
167
Amaury Sechet7b05a4c2016-03-14 01:37:29 +0000168bool Argument::hasAttribute(Attribute::AttrKind Kind) const {
Reid Klecknerf021fab2017-04-13 23:12:13 +0000169 return getParent()->hasParamAttribute(getArgNo(), Kind);
Amaury Sechet7b05a4c2016-03-14 01:37:29 +0000170}
171
Chris Lattnerd255ae22002-04-09 19:39:35 +0000172//===----------------------------------------------------------------------===//
Chris Lattner3e13b8c2008-01-02 23:42:30 +0000173// Helper Methods in Function
Reid Spencer019c8862007-04-09 15:01:12 +0000174//===----------------------------------------------------------------------===//
175
Owen Anderson47db9412009-07-22 00:24:57 +0000176LLVMContext &Function::getContext() const {
177 return getType()->getContext();
Owen Anderson0a2c4582009-07-02 18:03:58 +0000178}
179
Chris Lattner3e13b8c2008-01-02 23:42:30 +0000180void Function::removeFromParent() {
Duncan P. N. Exon Smith52888a62015-10-08 23:49:46 +0000181 getParent()->getFunctionList().remove(getIterator());
Duncan Sands185eeac2007-11-25 14:10:56 +0000182}
183
Chris Lattner3e13b8c2008-01-02 23:42:30 +0000184void Function::eraseFromParent() {
Duncan P. N. Exon Smith52888a62015-10-08 23:49:46 +0000185 getParent()->getFunctionList().erase(getIterator());
Reid Spencer019c8862007-04-09 15:01:12 +0000186}
187
Reid Spencer019c8862007-04-09 15:01:12 +0000188//===----------------------------------------------------------------------===//
Chris Lattner57698e22002-03-26 18:01:55 +0000189// Function Implementation
Chris Lattnerda975502001-09-10 07:58:01 +0000190//===----------------------------------------------------------------------===//
191
Rafael Espindola1b47a282014-10-23 15:20:05 +0000192Function::Function(FunctionType *Ty, LinkageTypes Linkage, const Twine &name,
193 Module *ParentModule)
David Blaikied583b192015-08-21 21:35:28 +0000194 : GlobalObject(Ty, Value::FunctionVal,
Reid Kleckner56d028d2017-03-17 17:16:39 +0000195 OperandTraits<Function>::op_begin(this), 0, Linkage, name),
196 Arguments(nullptr), NumArgs(Ty->getNumParams()) {
Chris Lattner654695b2009-01-05 07:58:59 +0000197 assert(FunctionType::isValidReturnType(getReturnType()) &&
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000198 "invalid return type");
Duncan P. N. Exon Smith4472b772015-04-24 20:47:23 +0000199 setGlobalObjectSubClassData(0);
Mehdi Aminia53d49e2016-09-17 06:00:02 +0000200
201 // We only need a symbol table for a function if the context keeps value names
202 if (!getContext().shouldDiscardValueNames())
203 SymTab = make_unique<ValueSymbolTable>();
Chris Lattner6213ae02002-09-06 20:46:32 +0000204
Chris Lattnere2de9082007-08-18 06:14:52 +0000205 // If the function has arguments, mark them as lazily built.
206 if (Ty->getNumParams())
Chris Lattnerb9c86512009-12-29 02:14:09 +0000207 setValueSubclassData(1); // Set the "has lazy arguments" bit.
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000208
Chris Lattner6213ae02002-09-06 20:46:32 +0000209 if (ParentModule)
210 ParentModule->getFunctionList().push_back(this);
Duncan Sandsa8ff6ca2008-04-07 13:39:11 +0000211
Justin Lebar291abd32016-12-28 22:59:45 +0000212 HasLLVMReservedName = getName().startswith("llvm.");
Duncan Sandsa8ff6ca2008-04-07 13:39:11 +0000213 // Ensure intrinsics have the right parameter attributes.
Pete Coopera7c0c182015-05-19 00:24:26 +0000214 // Note, the IntID field will have been set in Value::setName if this function
215 // name is a valid intrinsic ID.
216 if (IntID)
217 setAttributes(Intrinsic::getAttributes(getContext(), IntID));
Chris Lattner2f7c9632001-06-06 20:29:01 +0000218}
219
Gordon Henriksen14a55692007-12-10 02:14:30 +0000220Function::~Function() {
221 dropAllReferences(); // After this it is safe to delete instructions.
Chris Lattner2f7c9632001-06-06 20:29:01 +0000222
Chris Lattner2f7c9632001-06-06 20:29:01 +0000223 // Delete all of the method arguments and unlink from symbol table...
Reid Kleckner56d028d2017-03-17 17:16:39 +0000224 if (Arguments)
225 clearArguments();
Reid Spencerc6a83842007-04-22 17:28:03 +0000226
Gordon Henriksend930f912008-08-17 18:44:35 +0000227 // Remove the function from the on-the-side GC table.
228 clearGC();
Chris Lattner2f7c9632001-06-06 20:29:01 +0000229}
230
Chris Lattnere2de9082007-08-18 06:14:52 +0000231void Function::BuildLazyArguments() const {
232 // Create the arguments vector, all arguments start out unnamed.
Reid Kleckner56d028d2017-03-17 17:16:39 +0000233 auto *FT = getFunctionType();
234 if (NumArgs > 0) {
235 Arguments = std::allocator<Argument>().allocate(NumArgs);
236 for (unsigned i = 0, e = NumArgs; i != e; ++i) {
237 Type *ArgTy = FT->getParamType(i);
238 assert(!ArgTy->isVoidTy() && "Cannot have void typed arguments!");
239 new (Arguments + i) Argument(ArgTy, "", const_cast<Function *>(this), i);
240 }
Chris Lattnere2de9082007-08-18 06:14:52 +0000241 }
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000242
Chris Lattnere2de9082007-08-18 06:14:52 +0000243 // Clear the lazy arguments bit.
Chris Lattnerb9c86512009-12-29 02:14:09 +0000244 unsigned SDC = getSubclassDataFromValue();
Peter Collingbourne51d2de72014-12-03 02:08:38 +0000245 const_cast<Function*>(this)->setValueSubclassData(SDC &= ~(1<<0));
Reid Kleckner56d028d2017-03-17 17:16:39 +0000246 assert(!hasLazyArguments());
247}
248
249static MutableArrayRef<Argument> makeArgArray(Argument *Args, size_t Count) {
250 return MutableArrayRef<Argument>(Args, Count);
251}
252
253void Function::clearArguments() {
254 for (Argument &A : makeArgArray(Arguments, NumArgs)) {
255 A.setName("");
256 A.~Argument();
257 }
258 std::allocator<Argument>().deallocate(Arguments, NumArgs);
259 Arguments = nullptr;
Chris Lattnere2de9082007-08-18 06:14:52 +0000260}
261
Duncan P. N. Exon Smithbdfc9842016-04-06 06:38:15 +0000262void Function::stealArgumentListFrom(Function &Src) {
263 assert(isDeclaration() && "Expected no references to current arguments");
264
265 // Drop the current arguments, if any, and set the lazy argument bit.
266 if (!hasLazyArguments()) {
Reid Kleckner56d028d2017-03-17 17:16:39 +0000267 assert(llvm::all_of(makeArgArray(Arguments, NumArgs),
Duncan P. N. Exon Smithbdfc9842016-04-06 06:38:15 +0000268 [](const Argument &A) { return A.use_empty(); }) &&
269 "Expected arguments to be unused in declaration");
Reid Kleckner56d028d2017-03-17 17:16:39 +0000270 clearArguments();
Duncan P. N. Exon Smithbdfc9842016-04-06 06:38:15 +0000271 setValueSubclassData(getSubclassDataFromValue() | (1 << 0));
272 }
273
274 // Nothing to steal if Src has lazy arguments.
275 if (Src.hasLazyArguments())
276 return;
277
278 // Steal arguments from Src, and fix the lazy argument bits.
Reid Kleckner56d028d2017-03-17 17:16:39 +0000279 assert(arg_size() == Src.arg_size());
280 Arguments = Src.Arguments;
281 Src.Arguments = nullptr;
282 for (Argument &A : makeArgArray(Arguments, NumArgs)) {
283 // FIXME: This does the work of transferNodesFromList inefficiently.
284 SmallString<128> Name;
285 if (A.hasName())
286 Name = A.getName();
287 if (!Name.empty())
288 A.setName("");
289 A.setParent(this);
290 if (!Name.empty())
291 A.setName(Name);
292 }
293
Duncan P. N. Exon Smithbdfc9842016-04-06 06:38:15 +0000294 setValueSubclassData(getSubclassDataFromValue() & ~(1 << 0));
Reid Kleckner56d028d2017-03-17 17:16:39 +0000295 assert(!hasLazyArguments());
Duncan P. N. Exon Smithbdfc9842016-04-06 06:38:15 +0000296 Src.setValueSubclassData(Src.getSubclassDataFromValue() | (1 << 0));
297}
298
Chris Lattner2f7c9632001-06-06 20:29:01 +0000299// dropAllReferences() - This function causes all the subinstructions to "let
300// go" of all references that they are maintaining. This allows one to
301// 'delete' a whole class at a time, even though there may be circular
302// references... first all references are dropped, and all use counts go to
Misha Brukmanfa100532003-10-10 17:54:14 +0000303// zero. Then everything is deleted for real. Note that no operations are
Misha Brukmanb1c93172005-04-21 23:48:37 +0000304// valid on an object that has "dropped all references", except operator
Chris Lattner2f7c9632001-06-06 20:29:01 +0000305// delete.
306//
Chris Lattner4e8c4872002-03-23 22:51:58 +0000307void Function::dropAllReferences() {
Rafael Espindolad4bcefc2014-10-24 18:13:04 +0000308 setIsMaterializable(false);
309
Benjamin Krameraf28e7d2016-06-26 14:10:56 +0000310 for (BasicBlock &BB : *this)
311 BB.dropAllReferences();
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000312
Dan Gohmanf844b3b2010-12-07 19:56:51 +0000313 // Delete all basic blocks. They are now unused, except possibly by
314 // blockaddresses, but BasicBlock's destructor takes care of those.
315 while (!BasicBlocks.empty())
316 BasicBlocks.begin()->eraseFromParent();
Peter Collingbourne3fa50f92013-09-16 01:08:15 +0000317
Vedant Kumar3a63fb32015-12-19 08:52:49 +0000318 // Drop uses of any optional data (real or placeholder).
319 if (getNumOperands()) {
320 User::dropAllReferences();
321 setNumHungOffUseOperands(0);
322 setValueSubclassData(getSubclassDataFromValue() & ~0xe);
323 }
Duncan P. N. Exon Smithe2510cd2015-04-24 21:51:02 +0000324
325 // Metadata is stored in a side-table.
326 clearMetadata();
Chris Lattner2f7c9632001-06-06 20:29:01 +0000327}
Chris Lattnerda975502001-09-10 07:58:01 +0000328
Amaury Sechet392638d2016-06-14 20:27:35 +0000329void Function::addAttribute(unsigned i, Attribute::AttrKind Kind) {
Reid Klecknerb5180542017-03-21 16:57:19 +0000330 AttributeList PAL = getAttributes();
Amaury Sechet392638d2016-06-14 20:27:35 +0000331 PAL = PAL.addAttribute(getContext(), i, Kind);
Devang Patel4c758ea2008-09-25 21:00:45 +0000332 setAttributes(PAL);
Eric Christopher901b1a72008-05-16 20:39:43 +0000333}
334
Amaury Sechet5db224e2016-06-12 06:17:24 +0000335void Function::addAttribute(unsigned i, Attribute Attr) {
Reid Klecknerb5180542017-03-21 16:57:19 +0000336 AttributeList PAL = getAttributes();
Amaury Sechet5db224e2016-06-12 06:17:24 +0000337 PAL = PAL.addAttribute(getContext(), i, Attr);
338 setAttributes(PAL);
339}
340
Reid Klecknerb5180542017-03-21 16:57:19 +0000341void Function::addAttributes(unsigned i, AttributeList Attrs) {
342 AttributeList PAL = getAttributes();
Amaury Sechet392638d2016-06-14 20:27:35 +0000343 PAL = PAL.addAttributes(getContext(), i, Attrs);
Bill Wendlingc0e2a1f2013-01-23 00:20:53 +0000344 setAttributes(PAL);
345}
346
Amaury Sechet392638d2016-06-14 20:27:35 +0000347void Function::removeAttribute(unsigned i, Attribute::AttrKind Kind) {
Reid Klecknerb5180542017-03-21 16:57:19 +0000348 AttributeList PAL = getAttributes();
Amaury Sechet392638d2016-06-14 20:27:35 +0000349 PAL = PAL.removeAttribute(getContext(), i, Kind);
Amaury Sechet7b05a4c2016-03-14 01:37:29 +0000350 setAttributes(PAL);
351}
352
Amaury Sechet6100adf2016-06-15 17:50:39 +0000353void Function::removeAttribute(unsigned i, StringRef Kind) {
Reid Klecknerb5180542017-03-21 16:57:19 +0000354 AttributeList PAL = getAttributes();
Amaury Sechet6100adf2016-06-15 17:50:39 +0000355 PAL = PAL.removeAttribute(getContext(), i, Kind);
356 setAttributes(PAL);
357}
358
Reid Klecknerb5180542017-03-21 16:57:19 +0000359void Function::removeAttributes(unsigned i, AttributeList Attrs) {
360 AttributeList PAL = getAttributes();
Amaury Sechet392638d2016-06-14 20:27:35 +0000361 PAL = PAL.removeAttributes(getContext(), i, Attrs);
Devang Patel4c758ea2008-09-25 21:00:45 +0000362 setAttributes(PAL);
Duncan Sands66336db2008-07-08 09:41:30 +0000363}
364
Ramkumar Ramachandra8fcb4982015-02-14 19:37:54 +0000365void Function::addDereferenceableAttr(unsigned i, uint64_t Bytes) {
Reid Klecknerb5180542017-03-21 16:57:19 +0000366 AttributeList PAL = getAttributes();
Ramkumar Ramachandra8fcb4982015-02-14 19:37:54 +0000367 PAL = PAL.addDereferenceableAttr(getContext(), i, Bytes);
368 setAttributes(PAL);
369}
370
Sanjoy Das31ea6d12015-04-16 20:29:50 +0000371void Function::addDereferenceableOrNullAttr(unsigned i, uint64_t Bytes) {
Reid Klecknerb5180542017-03-21 16:57:19 +0000372 AttributeList PAL = getAttributes();
Sanjoy Das31ea6d12015-04-16 20:29:50 +0000373 PAL = PAL.addDereferenceableOrNullAttr(getContext(), i, Bytes);
374 setAttributes(PAL);
375}
376
Mehdi Amini599ebf22016-01-08 02:28:20 +0000377const std::string &Function::getGC() const {
Gordon Henriksend930f912008-08-17 18:44:35 +0000378 assert(hasGC() && "Function has no collector");
Mehdi Amini599ebf22016-01-08 02:28:20 +0000379 return getContext().getGC(*this);
Gordon Henriksen71183b62007-12-10 03:18:06 +0000380}
381
Benjamin Kramer728f4442016-05-29 10:46:35 +0000382void Function::setGC(std::string Str) {
Mehdi Amini599ebf22016-01-08 02:28:20 +0000383 setValueSubclassDataBit(14, !Str.empty());
384 getContext().setGC(*this, std::move(Str));
Gordon Henriksen71183b62007-12-10 03:18:06 +0000385}
386
Gordon Henriksend930f912008-08-17 18:44:35 +0000387void Function::clearGC() {
Mehdi Amini599ebf22016-01-08 02:28:20 +0000388 if (!hasGC())
389 return;
390 getContext().deleteGC(*this);
391 setValueSubclassDataBit(14, false);
Gordon Henriksen71183b62007-12-10 03:18:06 +0000392}
393
Rafael Espindola769efe62015-12-02 20:03:17 +0000394/// Copy all additional attributes (those not needed to create a Function) from
395/// the Function Src to this one.
Duncan Sandsdd7daee2008-05-26 19:58:59 +0000396void Function::copyAttributesFrom(const GlobalValue *Src) {
Rafael Espindola99e05cf2014-05-13 18:45:48 +0000397 GlobalObject::copyAttributesFrom(Src);
Rafael Espindola769efe62015-12-02 20:03:17 +0000398 const Function *SrcF = dyn_cast<Function>(Src);
399 if (!SrcF)
400 return;
401
Duncan Sandsdd7daee2008-05-26 19:58:59 +0000402 setCallingConv(SrcF->getCallingConv());
Devang Patel4c758ea2008-09-25 21:00:45 +0000403 setAttributes(SrcF->getAttributes());
Gordon Henriksend930f912008-08-17 18:44:35 +0000404 if (SrcF->hasGC())
405 setGC(SrcF->getGC());
406 else
407 clearGC();
Vedant Kumar44dd9872015-12-19 08:48:43 +0000408 if (SrcF->hasPersonalityFn())
409 setPersonalityFn(SrcF->getPersonalityFn());
Vedant Kumar3a63fb32015-12-19 08:52:49 +0000410 if (SrcF->hasPrefixData())
411 setPrefixData(SrcF->getPrefixData());
412 if (SrcF->hasPrologueData())
413 setPrologueData(SrcF->getPrologueData());
Duncan Sandsdd7daee2008-05-26 19:58:59 +0000414}
415
Reid Kleckner0b5220d2016-01-26 02:06:41 +0000416/// Table of string intrinsic names indexed by enum value.
417static const char * const IntrinsicNameTable[] = {
418 "not_intrinsic",
419#define GET_INTRINSIC_NAME_TABLE
420#include "llvm/IR/Intrinsics.gen"
421#undef GET_INTRINSIC_NAME_TABLE
422};
423
Justin Bogner92a8c612016-07-15 16:31:37 +0000424/// Table of per-target intrinsic name tables.
425#define GET_INTRINSIC_TARGET_DATA
426#include "llvm/IR/Intrinsics.gen"
427#undef GET_INTRINSIC_TARGET_DATA
428
429/// Find the segment of \c IntrinsicNameTable for intrinsics with the same
430/// target as \c Name, or the generic table if \c Name is not target specific.
431///
432/// Returns the relevant slice of \c IntrinsicNameTable
433static ArrayRef<const char *> findTargetSubtable(StringRef Name) {
434 assert(Name.startswith("llvm."));
435
436 ArrayRef<IntrinsicTargetInfo> Targets(TargetInfos);
437 // Drop "llvm." and take the first dotted component. That will be the target
438 // if this is target specific.
439 StringRef Target = Name.drop_front(5).split('.').first;
440 auto It = std::lower_bound(Targets.begin(), Targets.end(), Target,
441 [](const IntrinsicTargetInfo &TI,
442 StringRef Target) { return TI.Name < Target; });
443 // We've either found the target or just fall back to the generic set, which
444 // is always first.
445 const auto &TI = It != Targets.end() && It->Name == Target ? *It : Targets[0];
446 return makeArrayRef(&IntrinsicNameTable[1] + TI.Offset, TI.Count);
447}
448
Pete Cooper21241132015-05-19 00:02:25 +0000449/// \brief This does the actual lookup of an intrinsic ID which
450/// matches the given function name.
Tim Northover6b3bd612016-07-29 20:32:59 +0000451Intrinsic::ID Function::lookupIntrinsicID(StringRef Name) {
Justin Bogner92a8c612016-07-15 16:31:37 +0000452 ArrayRef<const char *> NameTable = findTargetSubtable(Name);
Reid Klecknerc2752da2016-01-26 22:33:19 +0000453 int Idx = Intrinsic::lookupLLVMIntrinsicByName(NameTable, Name);
Justin Bogner92a8c612016-07-15 16:31:37 +0000454 if (Idx == -1)
455 return Intrinsic::not_intrinsic;
456
457 // Intrinsic IDs correspond to the location in IntrinsicNameTable, but we have
458 // an index into a sub-table.
459 int Adjust = NameTable.data() - IntrinsicNameTable;
460 Intrinsic::ID ID = static_cast<Intrinsic::ID>(Idx + Adjust);
Pete Cooper21241132015-05-19 00:02:25 +0000461
Reid Kleckner0b5220d2016-01-26 02:06:41 +0000462 // If the intrinsic is not overloaded, require an exact match. If it is
463 // overloaded, require a prefix match.
464 bool IsPrefixMatch = Name.size() > strlen(NameTable[Idx]);
465 return IsPrefixMatch == isOverloaded(ID) ? ID : Intrinsic::not_intrinsic;
Pete Cooper21241132015-05-19 00:02:25 +0000466}
467
Pete Coopera7c0c182015-05-19 00:24:26 +0000468void Function::recalculateIntrinsicID() {
Justin Lebar291abd32016-12-28 22:59:45 +0000469 StringRef Name = getName();
470 if (!Name.startswith("llvm.")) {
471 HasLLVMReservedName = false;
Pete Coopera7c0c182015-05-19 00:24:26 +0000472 IntID = Intrinsic::not_intrinsic;
473 return;
Michael Ilseman516d7032013-03-01 18:48:54 +0000474 }
Justin Lebar291abd32016-12-28 22:59:45 +0000475 HasLLVMReservedName = true;
476 IntID = lookupIntrinsicID(Name);
Michael Ilseman516d7032013-03-01 18:48:54 +0000477}
478
Philip Reames319c48e2014-11-12 00:21:51 +0000479/// Returns a stable mangling for the type specified for use in the name
Philip Reames059ecbf2014-11-24 23:24:24 +0000480/// mangling scheme used by 'any' types in intrinsic signatures. The mangling
481/// of named types is simply their name. Manglings for unnamed types consist
482/// of a prefix ('p' for pointers, 'a' for arrays, 'f_' for functions)
483/// combined with the mangling of their component types. A vararg function
484/// type will have a suffix of 'vararg'. Since function types can contain
485/// other function types, we close a function type mangling with suffix 'f'
486/// which can't be confused with it's prefix. This ensures we don't have
487/// collisions between two unrelated function types. Otherwise, you might
488/// parse ffXX as f(fXX) or f(fX)X. (X is a placeholder for any other type.)
Philip Reames8d5d68f2015-01-14 23:05:17 +0000489/// Manglings of integers, floats, and vectors ('i', 'f', and 'v' prefix in most
490/// cases) fall back to the MVT codepath, where they could be mangled to
491/// 'x86mmx', for example; matching on derived types is not sufficient to mangle
492/// everything.
Philip Reames319c48e2014-11-12 00:21:51 +0000493static std::string getMangledTypeStr(Type* Ty) {
494 std::string Result;
495 if (PointerType* PTyp = dyn_cast<PointerType>(Ty)) {
496 Result += "p" + llvm::utostr(PTyp->getAddressSpace()) +
497 getMangledTypeStr(PTyp->getElementType());
498 } else if (ArrayType* ATyp = dyn_cast<ArrayType>(Ty)) {
499 Result += "a" + llvm::utostr(ATyp->getNumElements()) +
500 getMangledTypeStr(ATyp->getElementType());
Daniel Berlin3c1432f2017-02-15 23:16:20 +0000501 } else if (StructType *STyp = dyn_cast<StructType>(Ty)) {
502 if (!STyp->isLiteral()) {
503 Result += "s_";
504 Result += STyp->getName();
505 } else {
506 Result += "sl_";
507 for (auto Elem : STyp->elements())
508 Result += getMangledTypeStr(Elem);
509 }
510 // Ensure nested structs are distinguishable.
511 Result += "s";
512 } else if (FunctionType *FT = dyn_cast<FunctionType>(Ty)) {
Philip Reames319c48e2014-11-12 00:21:51 +0000513 Result += "f_" + getMangledTypeStr(FT->getReturnType());
514 for (size_t i = 0; i < FT->getNumParams(); i++)
515 Result += getMangledTypeStr(FT->getParamType(i));
516 if (FT->isVarArg())
517 Result += "vararg";
Philip Reames059ecbf2014-11-24 23:24:24 +0000518 // Ensure nested function types are distinguishable.
519 Result += "f";
Elena Demikhovsky1ca72e12015-11-19 07:17:16 +0000520 } else if (isa<VectorType>(Ty))
521 Result += "v" + utostr(Ty->getVectorNumElements()) +
522 getMangledTypeStr(Ty->getVectorElementType());
523 else if (Ty)
Philip Reames319c48e2014-11-12 00:21:51 +0000524 Result += EVT::getEVT(Ty).getEVTString();
525 return Result;
526}
527
Pete Coopera8db71e2016-08-18 18:30:54 +0000528StringRef Intrinsic::getName(ID id) {
529 assert(id < num_intrinsics && "Invalid intrinsic ID!");
Pete Coopera5f8c722016-08-22 20:18:28 +0000530 assert(!isOverloaded(id) &&
531 "This version of getName does not support overloading");
Pete Coopera8db71e2016-08-18 18:30:54 +0000532 return IntrinsicNameTable[id];
533}
534
Benjamin Kramere6e19332011-07-14 17:45:39 +0000535std::string Intrinsic::getName(ID id, ArrayRef<Type*> Tys) {
Chris Lattner71b8c982006-03-25 06:32:47 +0000536 assert(id < num_intrinsics && "Invalid intrinsic ID!");
Reid Kleckner0b5220d2016-01-26 02:06:41 +0000537 std::string Result(IntrinsicNameTable[id]);
Benjamin Krameraf28e7d2016-06-26 14:10:56 +0000538 for (Type *Ty : Tys) {
539 Result += "." + getMangledTypeStr(Ty);
Mon P Wang2c839d42008-07-30 04:36:53 +0000540 }
Reid Spencer2a2117c2007-04-01 07:25:33 +0000541 return Result;
Chris Lattner71b8c982006-03-25 06:32:47 +0000542}
543
Chris Lattner7f0e7ba2012-05-16 06:34:44 +0000544
Chris Lattnerf39c2782012-05-27 18:28:35 +0000545/// IIT_Info - These are enumerators that describe the entries returned by the
546/// getIntrinsicInfoTableEntries function.
547///
548/// NOTE: This must be kept in synch with the copy in TblGen/IntrinsicEmitter!
549enum IIT_Info {
Robert Khasanov65c27562014-10-20 19:25:05 +0000550 // Common values should be encoded with 0-15.
Chris Lattnerf39c2782012-05-27 18:28:35 +0000551 IIT_Done = 0,
552 IIT_I1 = 1,
553 IIT_I8 = 2,
554 IIT_I16 = 3,
555 IIT_I32 = 4,
556 IIT_I64 = 5,
Michael Ilseman6c6d7152013-01-11 01:45:05 +0000557 IIT_F16 = 6,
558 IIT_F32 = 7,
559 IIT_F64 = 8,
560 IIT_V2 = 9,
561 IIT_V4 = 10,
562 IIT_V8 = 11,
563 IIT_V16 = 12,
564 IIT_V32 = 13,
Robert Khasanov65c27562014-10-20 19:25:05 +0000565 IIT_PTR = 14,
566 IIT_ARG = 15,
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000567
Robert Khasanov65c27562014-10-20 19:25:05 +0000568 // Values from 16+ are only encodable with the inefficient encoding.
569 IIT_V64 = 16,
Robert Khasanovb25e5622014-09-30 11:32:22 +0000570 IIT_MMX = 17,
Joseph Tremoulet917c7382015-09-02 13:36:25 +0000571 IIT_TOKEN = 18,
572 IIT_METADATA = 19,
573 IIT_EMPTYSTRUCT = 20,
574 IIT_STRUCT2 = 21,
575 IIT_STRUCT3 = 22,
576 IIT_STRUCT4 = 23,
577 IIT_STRUCT5 = 24,
578 IIT_EXTEND_ARG = 25,
579 IIT_TRUNC_ARG = 26,
580 IIT_ANYPTR = 27,
581 IIT_V1 = 28,
582 IIT_VARARG = 29,
583 IIT_HALF_VEC_ARG = 30,
584 IIT_SAME_VEC_WIDTH_ARG = 31,
585 IIT_PTR_TO_ARG = 32,
Elena Demikhovskycaaceef2016-11-03 03:23:55 +0000586 IIT_PTR_TO_ELT = 33,
587 IIT_VEC_OF_PTRS_TO_ELT = 34,
588 IIT_I128 = 35,
589 IIT_V512 = 36,
590 IIT_V1024 = 37
Chris Lattnerf39c2782012-05-27 18:28:35 +0000591};
592
593
594static void DecodeIITType(unsigned &NextElt, ArrayRef<unsigned char> Infos,
595 SmallVectorImpl<Intrinsic::IITDescriptor> &OutputTable) {
Chris Lattnera57c7972012-05-17 05:13:57 +0000596 IIT_Info Info = IIT_Info(Infos[NextElt++]);
Chris Lattner3e34a7b2012-05-17 05:03:24 +0000597 unsigned StructElts = 2;
Chris Lattnerf39c2782012-05-27 18:28:35 +0000598 using namespace Intrinsic;
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000599
Chris Lattnera57c7972012-05-17 05:13:57 +0000600 switch (Info) {
Chris Lattnerf39c2782012-05-27 18:28:35 +0000601 case IIT_Done:
602 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Void, 0));
603 return;
Andrew Tricka2efd992013-10-31 17:18:11 +0000604 case IIT_VARARG:
605 OutputTable.push_back(IITDescriptor::get(IITDescriptor::VarArg, 0));
606 return;
Chris Lattnerf39c2782012-05-27 18:28:35 +0000607 case IIT_MMX:
608 OutputTable.push_back(IITDescriptor::get(IITDescriptor::MMX, 0));
609 return;
Joseph Tremoulet917c7382015-09-02 13:36:25 +0000610 case IIT_TOKEN:
611 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Token, 0));
612 return;
Chris Lattnerf39c2782012-05-27 18:28:35 +0000613 case IIT_METADATA:
614 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Metadata, 0));
615 return;
Michael Ilseman6c6d7152013-01-11 01:45:05 +0000616 case IIT_F16:
617 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Half, 0));
618 return;
Chris Lattnerf39c2782012-05-27 18:28:35 +0000619 case IIT_F32:
620 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Float, 0));
621 return;
622 case IIT_F64:
623 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Double, 0));
624 return;
625 case IIT_I1:
626 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer, 1));
627 return;
628 case IIT_I8:
629 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer, 8));
630 return;
631 case IIT_I16:
632 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer,16));
633 return;
634 case IIT_I32:
635 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer, 32));
636 return;
637 case IIT_I64:
638 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer, 64));
639 return;
Kit Barton66460332015-05-25 15:49:26 +0000640 case IIT_I128:
641 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer, 128));
642 return;
Jiangning Liu63dc8402013-09-24 02:47:27 +0000643 case IIT_V1:
644 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 1));
645 DecodeIITType(NextElt, Infos, OutputTable);
646 return;
Chris Lattner827b2532012-05-17 04:30:58 +0000647 case IIT_V2:
Chris Lattnerf39c2782012-05-27 18:28:35 +0000648 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 2));
649 DecodeIITType(NextElt, Infos, OutputTable);
650 return;
Chris Lattner827b2532012-05-17 04:30:58 +0000651 case IIT_V4:
Chris Lattnerf39c2782012-05-27 18:28:35 +0000652 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 4));
653 DecodeIITType(NextElt, Infos, OutputTable);
654 return;
Chris Lattner827b2532012-05-17 04:30:58 +0000655 case IIT_V8:
Chris Lattnerf39c2782012-05-27 18:28:35 +0000656 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 8));
657 DecodeIITType(NextElt, Infos, OutputTable);
658 return;
Chris Lattner827b2532012-05-17 04:30:58 +0000659 case IIT_V16:
Chris Lattnerf39c2782012-05-27 18:28:35 +0000660 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 16));
661 DecodeIITType(NextElt, Infos, OutputTable);
662 return;
Chris Lattner3e34a7b2012-05-17 05:03:24 +0000663 case IIT_V32:
Chris Lattnerf39c2782012-05-27 18:28:35 +0000664 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 32));
665 DecodeIITType(NextElt, Infos, OutputTable);
666 return;
Robert Khasanovb25e5622014-09-30 11:32:22 +0000667 case IIT_V64:
668 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 64));
669 DecodeIITType(NextElt, Infos, OutputTable);
670 return;
Krzysztof Parzyszekb8bb90b2015-11-24 16:28:14 +0000671 case IIT_V512:
672 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 512));
673 DecodeIITType(NextElt, Infos, OutputTable);
674 return;
675 case IIT_V1024:
676 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 1024));
677 DecodeIITType(NextElt, Infos, OutputTable);
678 return;
Chris Lattner4f18aa82012-05-23 05:19:18 +0000679 case IIT_PTR:
Chris Lattnerf39c2782012-05-27 18:28:35 +0000680 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Pointer, 0));
681 DecodeIITType(NextElt, Infos, OutputTable);
682 return;
Chris Lattner4f18aa82012-05-23 05:19:18 +0000683 case IIT_ANYPTR: { // [ANYPTR addrspace, subtype]
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000684 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Pointer,
Chris Lattnerf39c2782012-05-27 18:28:35 +0000685 Infos[NextElt++]));
686 DecodeIITType(NextElt, Infos, OutputTable);
687 return;
Pete Cooper243efd72012-05-21 23:21:28 +0000688 }
Chris Lattnerf39c2782012-05-27 18:28:35 +0000689 case IIT_ARG: {
690 unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
691 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Argument, ArgInfo));
692 return;
693 }
Tim Northoveraa3cf1e2014-03-28 12:31:39 +0000694 case IIT_EXTEND_ARG: {
Chris Lattnerf39c2782012-05-27 18:28:35 +0000695 unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
Tim Northoveraa3cf1e2014-03-28 12:31:39 +0000696 OutputTable.push_back(IITDescriptor::get(IITDescriptor::ExtendArgument,
Chris Lattnerf39c2782012-05-27 18:28:35 +0000697 ArgInfo));
698 return;
699 }
Tim Northoveraa3cf1e2014-03-28 12:31:39 +0000700 case IIT_TRUNC_ARG: {
Chris Lattnerf39c2782012-05-27 18:28:35 +0000701 unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
Tim Northoveraa3cf1e2014-03-28 12:31:39 +0000702 OutputTable.push_back(IITDescriptor::get(IITDescriptor::TruncArgument,
Chris Lattnerf39c2782012-05-27 18:28:35 +0000703 ArgInfo));
704 return;
Chris Lattner3e34a7b2012-05-17 05:03:24 +0000705 }
Tim Northover4516de32014-03-29 07:04:54 +0000706 case IIT_HALF_VEC_ARG: {
707 unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
708 OutputTable.push_back(IITDescriptor::get(IITDescriptor::HalfVecArgument,
709 ArgInfo));
710 return;
711 }
Elena Demikhovskyf1de34b2014-12-04 09:40:44 +0000712 case IIT_SAME_VEC_WIDTH_ARG: {
713 unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
714 OutputTable.push_back(IITDescriptor::get(IITDescriptor::SameVecWidthArgument,
715 ArgInfo));
716 return;
717 }
Elena Demikhovskyfb81b932014-12-25 07:49:20 +0000718 case IIT_PTR_TO_ARG: {
719 unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
720 OutputTable.push_back(IITDescriptor::get(IITDescriptor::PtrToArgument,
721 ArgInfo));
722 return;
723 }
Elena Demikhovskycaaceef2016-11-03 03:23:55 +0000724 case IIT_PTR_TO_ELT: {
725 unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
726 OutputTable.push_back(IITDescriptor::get(IITDescriptor::PtrToElt, ArgInfo));
727 return;
728 }
Elena Demikhovsky23a485a2015-02-08 08:27:19 +0000729 case IIT_VEC_OF_PTRS_TO_ELT: {
730 unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
731 OutputTable.push_back(IITDescriptor::get(IITDescriptor::VecOfPtrsToElt,
732 ArgInfo));
733 return;
734 }
Chris Lattnerf39c2782012-05-27 18:28:35 +0000735 case IIT_EMPTYSTRUCT:
736 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Struct, 0));
737 return;
Justin Bognercd1d5aa2016-08-17 20:30:52 +0000738 case IIT_STRUCT5: ++StructElts; LLVM_FALLTHROUGH;
739 case IIT_STRUCT4: ++StructElts; LLVM_FALLTHROUGH;
740 case IIT_STRUCT3: ++StructElts; LLVM_FALLTHROUGH;
Chris Lattner3e34a7b2012-05-17 05:03:24 +0000741 case IIT_STRUCT2: {
Chris Lattnerf39c2782012-05-27 18:28:35 +0000742 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Struct,StructElts));
743
Chris Lattner3e34a7b2012-05-17 05:03:24 +0000744 for (unsigned i = 0; i != StructElts; ++i)
Chris Lattnerf39c2782012-05-27 18:28:35 +0000745 DecodeIITType(NextElt, Infos, OutputTable);
746 return;
Chris Lattner827b2532012-05-17 04:30:58 +0000747 }
Chris Lattner7f0e7ba2012-05-16 06:34:44 +0000748 }
749 llvm_unreachable("unhandled");
750}
Chris Lattner7f0e7ba2012-05-16 06:34:44 +0000751
Chris Lattnerf39c2782012-05-27 18:28:35 +0000752
753#define GET_INTRINSIC_GENERATOR_GLOBAL
Chandler Carruthdb25c6c2013-01-02 12:09:16 +0000754#include "llvm/IR/Intrinsics.gen"
Chris Lattnerf39c2782012-05-27 18:28:35 +0000755#undef GET_INTRINSIC_GENERATOR_GLOBAL
756
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000757void Intrinsic::getIntrinsicInfoTableEntries(ID id,
Chris Lattnerf39c2782012-05-27 18:28:35 +0000758 SmallVectorImpl<IITDescriptor> &T){
Chris Lattner7f0e7ba2012-05-16 06:34:44 +0000759 // Check to see if the intrinsic's type was expressible by the table.
760 unsigned TableVal = IIT_Table[id-1];
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000761
Chris Lattnera3b0f522012-05-17 15:55:41 +0000762 // Decode the TableVal into an array of IITValues.
763 SmallVector<unsigned char, 8> IITValues;
764 ArrayRef<unsigned char> IITEntries;
765 unsigned NextElt = 0;
766 if ((TableVal >> 31) != 0) {
767 // This is an offset into the IIT_LongEncodingTable.
768 IITEntries = IIT_LongEncodingTable;
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000769
Chris Lattnera3b0f522012-05-17 15:55:41 +0000770 // Strip sentinel bit.
771 NextElt = (TableVal << 1) >> 1;
772 } else {
Chris Lattnerf39c2782012-05-27 18:28:35 +0000773 // Decode the TableVal into an array of IITValues. If the entry was encoded
774 // into a single word in the table itself, decode it now.
Chris Lattnera57c7972012-05-17 05:13:57 +0000775 do {
776 IITValues.push_back(TableVal & 0xF);
777 TableVal >>= 4;
778 } while (TableVal);
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000779
Chris Lattnera3b0f522012-05-17 15:55:41 +0000780 IITEntries = IITValues;
781 NextElt = 0;
Chris Lattner7f0e7ba2012-05-16 06:34:44 +0000782 }
Chris Lattnerf39c2782012-05-27 18:28:35 +0000783
784 // Okay, decode the table into the output vector of IITDescriptors.
785 DecodeIITType(NextElt, IITEntries, T);
786 while (NextElt != IITEntries.size() && IITEntries[NextElt] != 0)
787 DecodeIITType(NextElt, IITEntries, T);
788}
789
790
791static Type *DecodeFixedType(ArrayRef<Intrinsic::IITDescriptor> &Infos,
792 ArrayRef<Type*> Tys, LLVMContext &Context) {
793 using namespace Intrinsic;
794 IITDescriptor D = Infos.front();
795 Infos = Infos.slice(1);
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000796
Chris Lattnerf39c2782012-05-27 18:28:35 +0000797 switch (D.Kind) {
798 case IITDescriptor::Void: return Type::getVoidTy(Context);
Andrew Tricka2efd992013-10-31 17:18:11 +0000799 case IITDescriptor::VarArg: return Type::getVoidTy(Context);
Chris Lattnerf39c2782012-05-27 18:28:35 +0000800 case IITDescriptor::MMX: return Type::getX86_MMXTy(Context);
Joseph Tremoulet917c7382015-09-02 13:36:25 +0000801 case IITDescriptor::Token: return Type::getTokenTy(Context);
Chris Lattnerf39c2782012-05-27 18:28:35 +0000802 case IITDescriptor::Metadata: return Type::getMetadataTy(Context);
Michael Ilseman6c6d7152013-01-11 01:45:05 +0000803 case IITDescriptor::Half: return Type::getHalfTy(Context);
Chris Lattnerf39c2782012-05-27 18:28:35 +0000804 case IITDescriptor::Float: return Type::getFloatTy(Context);
805 case IITDescriptor::Double: return Type::getDoubleTy(Context);
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000806
Chris Lattnerf39c2782012-05-27 18:28:35 +0000807 case IITDescriptor::Integer:
808 return IntegerType::get(Context, D.Integer_Width);
809 case IITDescriptor::Vector:
810 return VectorType::get(DecodeFixedType(Infos, Tys, Context),D.Vector_Width);
811 case IITDescriptor::Pointer:
812 return PointerType::get(DecodeFixedType(Infos, Tys, Context),
813 D.Pointer_AddressSpace);
814 case IITDescriptor::Struct: {
815 Type *Elts[5];
816 assert(D.Struct_NumElements <= 5 && "Can't handle this yet");
817 for (unsigned i = 0, e = D.Struct_NumElements; i != e; ++i)
818 Elts[i] = DecodeFixedType(Infos, Tys, Context);
Craig Toppere1d12942014-08-27 05:25:25 +0000819 return StructType::get(Context, makeArrayRef(Elts,D.Struct_NumElements));
Chris Lattnerf39c2782012-05-27 18:28:35 +0000820 }
821
822 case IITDescriptor::Argument:
823 return Tys[D.getArgumentNumber()];
Tim Northoveraa3cf1e2014-03-28 12:31:39 +0000824 case IITDescriptor::ExtendArgument: {
825 Type *Ty = Tys[D.getArgumentNumber()];
826 if (VectorType *VTy = dyn_cast<VectorType>(Ty))
827 return VectorType::getExtendedElementVectorType(VTy);
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000828
Tim Northoveraa3cf1e2014-03-28 12:31:39 +0000829 return IntegerType::get(Context, 2 * cast<IntegerType>(Ty)->getBitWidth());
830 }
831 case IITDescriptor::TruncArgument: {
832 Type *Ty = Tys[D.getArgumentNumber()];
833 if (VectorType *VTy = dyn_cast<VectorType>(Ty))
834 return VectorType::getTruncatedElementVectorType(VTy);
835
836 IntegerType *ITy = cast<IntegerType>(Ty);
837 assert(ITy->getBitWidth() % 2 == 0);
838 return IntegerType::get(Context, ITy->getBitWidth() / 2);
839 }
Tim Northover4516de32014-03-29 07:04:54 +0000840 case IITDescriptor::HalfVecArgument:
841 return VectorType::getHalfElementsVectorType(cast<VectorType>(
842 Tys[D.getArgumentNumber()]));
Elena Demikhovskyfb81b932014-12-25 07:49:20 +0000843 case IITDescriptor::SameVecWidthArgument: {
Elena Demikhovskyf1de34b2014-12-04 09:40:44 +0000844 Type *EltTy = DecodeFixedType(Infos, Tys, Context);
845 Type *Ty = Tys[D.getArgumentNumber()];
846 if (VectorType *VTy = dyn_cast<VectorType>(Ty)) {
847 return VectorType::get(EltTy, VTy->getNumElements());
848 }
849 llvm_unreachable("unhandled");
Elena Demikhovskyfb81b932014-12-25 07:49:20 +0000850 }
851 case IITDescriptor::PtrToArgument: {
852 Type *Ty = Tys[D.getArgumentNumber()];
853 return PointerType::getUnqual(Ty);
854 }
Elena Demikhovskycaaceef2016-11-03 03:23:55 +0000855 case IITDescriptor::PtrToElt: {
856 Type *Ty = Tys[D.getArgumentNumber()];
857 VectorType *VTy = dyn_cast<VectorType>(Ty);
858 if (!VTy)
859 llvm_unreachable("Expected an argument of Vector Type");
860 Type *EltTy = VTy->getVectorElementType();
861 return PointerType::getUnqual(EltTy);
862 }
Elena Demikhovsky23a485a2015-02-08 08:27:19 +0000863 case IITDescriptor::VecOfPtrsToElt: {
864 Type *Ty = Tys[D.getArgumentNumber()];
865 VectorType *VTy = dyn_cast<VectorType>(Ty);
866 if (!VTy)
867 llvm_unreachable("Expected an argument of Vector Type");
868 Type *EltTy = VTy->getVectorElementType();
869 return VectorType::get(PointerType::getUnqual(EltTy),
870 VTy->getNumElements());
871 }
Elena Demikhovskyf1de34b2014-12-04 09:40:44 +0000872 }
Chris Lattnerf39c2782012-05-27 18:28:35 +0000873 llvm_unreachable("unhandled");
874}
875
876
877
878FunctionType *Intrinsic::getType(LLVMContext &Context,
879 ID id, ArrayRef<Type*> Tys) {
880 SmallVector<IITDescriptor, 8> Table;
881 getIntrinsicInfoTableEntries(id, Table);
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000882
Chris Lattnerf39c2782012-05-27 18:28:35 +0000883 ArrayRef<IITDescriptor> TableRef = Table;
884 Type *ResultTy = DecodeFixedType(TableRef, Tys, Context);
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000885
Chris Lattnera3b0f522012-05-17 15:55:41 +0000886 SmallVector<Type*, 8> ArgTys;
Chris Lattnerf39c2782012-05-27 18:28:35 +0000887 while (!TableRef.empty())
888 ArgTys.push_back(DecodeFixedType(TableRef, Tys, Context));
Jim Laskey2682ea62007-02-07 20:38:26 +0000889
Steven Wud05affc2014-10-20 15:47:24 +0000890 // DecodeFixedType returns Void for IITDescriptor::Void and IITDescriptor::VarArg
891 // If we see void type as the type of the last argument, it is vararg intrinsic
892 if (!ArgTys.empty() && ArgTys.back()->isVoidTy()) {
893 ArgTys.pop_back();
894 return FunctionType::get(ResultTy, ArgTys, true);
895 }
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000896 return FunctionType::get(ResultTy, ArgTys, false);
Jim Laskey2682ea62007-02-07 20:38:26 +0000897}
898
Mon P Wangb4024932009-02-24 23:17:49 +0000899bool Intrinsic::isOverloaded(ID id) {
Mon P Wangb4024932009-02-24 23:17:49 +0000900#define GET_INTRINSIC_OVERLOAD_TABLE
Chandler Carruthdb25c6c2013-01-02 12:09:16 +0000901#include "llvm/IR/Intrinsics.gen"
Mon P Wangb4024932009-02-24 23:17:49 +0000902#undef GET_INTRINSIC_OVERLOAD_TABLE
Mon P Wangb4024932009-02-24 23:17:49 +0000903}
904
Sanjoy Dasc65d43e2015-06-18 19:28:26 +0000905bool Intrinsic::isLeaf(ID id) {
906 switch (id) {
907 default:
908 return true;
909
910 case Intrinsic::experimental_gc_statepoint:
911 case Intrinsic::experimental_patchpoint_void:
912 case Intrinsic::experimental_patchpoint_i64:
913 return false;
914 }
915}
916
Chris Lattner49b7ee12009-01-12 01:18:58 +0000917/// This defines the "Intrinsic::getAttributes(ID id)" method.
Duncan Sands38ef3a82007-12-03 20:06:50 +0000918#define GET_INTRINSIC_ATTRIBUTES
Chandler Carruthdb25c6c2013-01-02 12:09:16 +0000919#include "llvm/IR/Intrinsics.gen"
Duncan Sands38ef3a82007-12-03 20:06:50 +0000920#undef GET_INTRINSIC_ATTRIBUTES
921
Benjamin Kramere6e19332011-07-14 17:45:39 +0000922Function *Intrinsic::getDeclaration(Module *M, ID id, ArrayRef<Type*> Tys) {
Duncan Sands38ef3a82007-12-03 20:06:50 +0000923 // There can never be multiple globals with the same name of different types,
924 // because intrinsics must be a specific type.
Duncan Sandsa8ff6ca2008-04-07 13:39:11 +0000925 return
Benjamin Kramere6e19332011-07-14 17:45:39 +0000926 cast<Function>(M->getOrInsertFunction(getName(id, Tys),
927 getType(M->getContext(), id, Tys)));
Jim Laskey2682ea62007-02-07 20:38:26 +0000928}
929
Dale Johannesenb842d522009-02-05 01:49:45 +0000930// This defines the "Intrinsic::getIntrinsicForGCCBuiltin()" method.
931#define GET_LLVM_INTRINSIC_FOR_GCC_BUILTIN
Chandler Carruthdb25c6c2013-01-02 12:09:16 +0000932#include "llvm/IR/Intrinsics.gen"
Dale Johannesenb842d522009-02-05 01:49:45 +0000933#undef GET_LLVM_INTRINSIC_FOR_GCC_BUILTIN
934
Saleem Abdulrasool4e63fc42014-07-04 18:42:25 +0000935// This defines the "Intrinsic::getIntrinsicForMSBuiltin()" method.
936#define GET_LLVM_INTRINSIC_FOR_MS_BUILTIN
937#include "llvm/IR/Intrinsics.gen"
938#undef GET_LLVM_INTRINSIC_FOR_MS_BUILTIN
939
Artur Pilipenkobc552272016-06-22 14:56:33 +0000940bool Intrinsic::matchIntrinsicType(Type *Ty, ArrayRef<Intrinsic::IITDescriptor> &Infos,
941 SmallVectorImpl<Type*> &ArgTys) {
942 using namespace Intrinsic;
943
944 // If we ran out of descriptors, there are too many arguments.
945 if (Infos.empty()) return true;
946 IITDescriptor D = Infos.front();
947 Infos = Infos.slice(1);
948
949 switch (D.Kind) {
950 case IITDescriptor::Void: return !Ty->isVoidTy();
951 case IITDescriptor::VarArg: return true;
952 case IITDescriptor::MMX: return !Ty->isX86_MMXTy();
953 case IITDescriptor::Token: return !Ty->isTokenTy();
954 case IITDescriptor::Metadata: return !Ty->isMetadataTy();
955 case IITDescriptor::Half: return !Ty->isHalfTy();
956 case IITDescriptor::Float: return !Ty->isFloatTy();
957 case IITDescriptor::Double: return !Ty->isDoubleTy();
958 case IITDescriptor::Integer: return !Ty->isIntegerTy(D.Integer_Width);
959 case IITDescriptor::Vector: {
960 VectorType *VT = dyn_cast<VectorType>(Ty);
961 return !VT || VT->getNumElements() != D.Vector_Width ||
962 matchIntrinsicType(VT->getElementType(), Infos, ArgTys);
963 }
964 case IITDescriptor::Pointer: {
965 PointerType *PT = dyn_cast<PointerType>(Ty);
966 return !PT || PT->getAddressSpace() != D.Pointer_AddressSpace ||
967 matchIntrinsicType(PT->getElementType(), Infos, ArgTys);
968 }
969
970 case IITDescriptor::Struct: {
971 StructType *ST = dyn_cast<StructType>(Ty);
972 if (!ST || ST->getNumElements() != D.Struct_NumElements)
973 return true;
974
975 for (unsigned i = 0, e = D.Struct_NumElements; i != e; ++i)
976 if (matchIntrinsicType(ST->getElementType(i), Infos, ArgTys))
977 return true;
978 return false;
979 }
980
981 case IITDescriptor::Argument:
982 // Two cases here - If this is the second occurrence of an argument, verify
983 // that the later instance matches the previous instance.
984 if (D.getArgumentNumber() < ArgTys.size())
985 return Ty != ArgTys[D.getArgumentNumber()];
986
987 // Otherwise, if this is the first instance of an argument, record it and
988 // verify the "Any" kind.
989 assert(D.getArgumentNumber() == ArgTys.size() && "Table consistency error");
990 ArgTys.push_back(Ty);
991
992 switch (D.getArgumentKind()) {
993 case IITDescriptor::AK_Any: return false; // Success
994 case IITDescriptor::AK_AnyInteger: return !Ty->isIntOrIntVectorTy();
995 case IITDescriptor::AK_AnyFloat: return !Ty->isFPOrFPVectorTy();
996 case IITDescriptor::AK_AnyVector: return !isa<VectorType>(Ty);
997 case IITDescriptor::AK_AnyPointer: return !isa<PointerType>(Ty);
998 }
999 llvm_unreachable("all argument kinds not covered");
1000
1001 case IITDescriptor::ExtendArgument: {
1002 // This may only be used when referring to a previous vector argument.
1003 if (D.getArgumentNumber() >= ArgTys.size())
1004 return true;
1005
1006 Type *NewTy = ArgTys[D.getArgumentNumber()];
1007 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
1008 NewTy = VectorType::getExtendedElementVectorType(VTy);
1009 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
1010 NewTy = IntegerType::get(ITy->getContext(), 2 * ITy->getBitWidth());
1011 else
1012 return true;
1013
1014 return Ty != NewTy;
1015 }
1016 case IITDescriptor::TruncArgument: {
1017 // This may only be used when referring to a previous vector argument.
1018 if (D.getArgumentNumber() >= ArgTys.size())
1019 return true;
1020
1021 Type *NewTy = ArgTys[D.getArgumentNumber()];
1022 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
1023 NewTy = VectorType::getTruncatedElementVectorType(VTy);
1024 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
1025 NewTy = IntegerType::get(ITy->getContext(), ITy->getBitWidth() / 2);
1026 else
1027 return true;
1028
1029 return Ty != NewTy;
1030 }
1031 case IITDescriptor::HalfVecArgument:
1032 // This may only be used when referring to a previous vector argument.
1033 return D.getArgumentNumber() >= ArgTys.size() ||
1034 !isa<VectorType>(ArgTys[D.getArgumentNumber()]) ||
1035 VectorType::getHalfElementsVectorType(
1036 cast<VectorType>(ArgTys[D.getArgumentNumber()])) != Ty;
1037 case IITDescriptor::SameVecWidthArgument: {
1038 if (D.getArgumentNumber() >= ArgTys.size())
1039 return true;
1040 VectorType * ReferenceType =
Elena Demikhovskycaaceef2016-11-03 03:23:55 +00001041 dyn_cast<VectorType>(ArgTys[D.getArgumentNumber()]);
Artur Pilipenkobc552272016-06-22 14:56:33 +00001042 VectorType *ThisArgType = dyn_cast<VectorType>(Ty);
1043 if (!ThisArgType || !ReferenceType ||
1044 (ReferenceType->getVectorNumElements() !=
1045 ThisArgType->getVectorNumElements()))
1046 return true;
1047 return matchIntrinsicType(ThisArgType->getVectorElementType(),
1048 Infos, ArgTys);
1049 }
1050 case IITDescriptor::PtrToArgument: {
1051 if (D.getArgumentNumber() >= ArgTys.size())
1052 return true;
1053 Type * ReferenceType = ArgTys[D.getArgumentNumber()];
1054 PointerType *ThisArgType = dyn_cast<PointerType>(Ty);
1055 return (!ThisArgType || ThisArgType->getElementType() != ReferenceType);
1056 }
Elena Demikhovskycaaceef2016-11-03 03:23:55 +00001057 case IITDescriptor::PtrToElt: {
1058 if (D.getArgumentNumber() >= ArgTys.size())
1059 return true;
1060 VectorType * ReferenceType =
1061 dyn_cast<VectorType> (ArgTys[D.getArgumentNumber()]);
1062 PointerType *ThisArgType = dyn_cast<PointerType>(Ty);
1063
1064 return (!ThisArgType || !ReferenceType ||
1065 ThisArgType->getElementType() != ReferenceType->getElementType());
1066 }
Artur Pilipenkobc552272016-06-22 14:56:33 +00001067 case IITDescriptor::VecOfPtrsToElt: {
1068 if (D.getArgumentNumber() >= ArgTys.size())
1069 return true;
1070 VectorType * ReferenceType =
1071 dyn_cast<VectorType> (ArgTys[D.getArgumentNumber()]);
1072 VectorType *ThisArgVecTy = dyn_cast<VectorType>(Ty);
1073 if (!ThisArgVecTy || !ReferenceType ||
1074 (ReferenceType->getVectorNumElements() !=
1075 ThisArgVecTy->getVectorNumElements()))
1076 return true;
1077 PointerType *ThisArgEltTy =
1078 dyn_cast<PointerType>(ThisArgVecTy->getVectorElementType());
1079 if (!ThisArgEltTy)
1080 return true;
1081 return ThisArgEltTy->getElementType() !=
1082 ReferenceType->getVectorElementType();
1083 }
1084 }
1085 llvm_unreachable("unhandled");
1086}
1087
Artur Pilipenkob68b8212016-06-24 14:47:27 +00001088bool
1089Intrinsic::matchIntrinsicVarArg(bool isVarArg,
1090 ArrayRef<Intrinsic::IITDescriptor> &Infos) {
1091 // If there are no descriptors left, then it can't be a vararg.
1092 if (Infos.empty())
1093 return isVarArg;
1094
1095 // There should be only one descriptor remaining at this point.
1096 if (Infos.size() != 1)
1097 return true;
1098
1099 // Check and verify the descriptor.
1100 IITDescriptor D = Infos.front();
1101 Infos = Infos.slice(1);
1102 if (D.Kind == IITDescriptor::VarArg)
1103 return !isVarArg;
1104
1105 return true;
1106}
1107
Artur Pilipenko6c7a8ab2016-06-24 15:10:29 +00001108Optional<Function*> Intrinsic::remangleIntrinsicFunction(Function *F) {
1109 Intrinsic::ID ID = F->getIntrinsicID();
1110 if (!ID)
1111 return None;
1112
1113 FunctionType *FTy = F->getFunctionType();
1114 // Accumulate an array of overloaded types for the given intrinsic
1115 SmallVector<Type *, 4> ArgTys;
1116 {
1117 SmallVector<Intrinsic::IITDescriptor, 8> Table;
1118 getIntrinsicInfoTableEntries(ID, Table);
1119 ArrayRef<Intrinsic::IITDescriptor> TableRef = Table;
1120
1121 // If we encounter any problems matching the signature with the descriptor
1122 // just give up remangling. It's up to verifier to report the discrepancy.
1123 if (Intrinsic::matchIntrinsicType(FTy->getReturnType(), TableRef, ArgTys))
1124 return None;
1125 for (auto Ty : FTy->params())
1126 if (Intrinsic::matchIntrinsicType(Ty, TableRef, ArgTys))
1127 return None;
1128 if (Intrinsic::matchIntrinsicVarArg(FTy->isVarArg(), TableRef))
1129 return None;
1130 }
1131
1132 StringRef Name = F->getName();
1133 if (Name == Intrinsic::getName(ID, ArgTys))
1134 return None;
1135
1136 auto NewDecl = Intrinsic::getDeclaration(F->getParent(), ID, ArgTys);
1137 NewDecl->setCallingConv(F->getCallingConv());
1138 assert(NewDecl->getFunctionType() == FTy && "Shouldn't change the signature");
1139 return NewDecl;
1140}
1141
Gabor Greif161cb042010-03-23 14:40:20 +00001142/// hasAddressTaken - returns true if there are any uses of this function
1143/// other than direct calls or invokes to it.
Gabor Greifa2fbc0a2010-03-24 13:21:49 +00001144bool Function::hasAddressTaken(const User* *PutOffender) const {
Chandler Carruthcdf47882014-03-09 03:16:01 +00001145 for (const Use &U : uses()) {
1146 const User *FU = U.getUser();
1147 if (isa<BlockAddress>(FU))
Jay Foadca0c4992012-05-12 08:30:16 +00001148 continue;
Richard Trieu7a083812016-02-18 22:09:30 +00001149 if (!isa<CallInst>(FU) && !isa<InvokeInst>(FU)) {
1150 if (PutOffender)
1151 *PutOffender = FU;
1152 return true;
1153 }
Chandler Carruthcdf47882014-03-09 03:16:01 +00001154 ImmutableCallSite CS(cast<Instruction>(FU));
Richard Trieu7a083812016-02-18 22:09:30 +00001155 if (!CS.isCallee(&U)) {
1156 if (PutOffender)
1157 *PutOffender = FU;
1158 return true;
1159 }
Jay Foad557169d2009-06-10 08:41:11 +00001160 }
1161 return false;
1162}
1163
Eli Friedman1923a332011-10-20 05:23:42 +00001164bool Function::isDefTriviallyDead() const {
1165 // Check the linkage
1166 if (!hasLinkOnceLinkage() && !hasLocalLinkage() &&
1167 !hasAvailableExternallyLinkage())
1168 return false;
1169
1170 // Check if the function is used by anything other than a blockaddress.
Chandler Carruthcdf47882014-03-09 03:16:01 +00001171 for (const User *U : users())
1172 if (!isa<BlockAddress>(U))
Eli Friedman1923a332011-10-20 05:23:42 +00001173 return false;
1174
1175 return true;
1176}
1177
Bill Wendling63a4ea12011-10-17 18:43:40 +00001178/// callsFunctionThatReturnsTwice - Return true if the function has a call to
1179/// setjmp or other function that gcc recognizes as "returning twice".
1180bool Function::callsFunctionThatReturnsTwice() const {
1181 for (const_inst_iterator
1182 I = inst_begin(this), E = inst_end(this); I != E; ++I) {
Mark Seaborn82711182014-01-14 04:20:01 +00001183 ImmutableCallSite CS(&*I);
1184 if (CS && CS.hasFnAttr(Attribute::ReturnsTwice))
Bill Wendling63a4ea12011-10-17 18:43:40 +00001185 return true;
1186 }
1187
1188 return false;
1189}
Peter Collingbourne3fa50f92013-09-16 01:08:15 +00001190
Vedant Kumar3a63fb32015-12-19 08:52:49 +00001191Constant *Function::getPersonalityFn() const {
1192 assert(hasPersonalityFn() && getNumOperands());
1193 return cast<Constant>(Op<0>());
Vedant Kumar1ab5ea52015-10-06 20:31:57 +00001194}
1195
Vedant Kumar3a63fb32015-12-19 08:52:49 +00001196void Function::setPersonalityFn(Constant *Fn) {
Keno Fischer9bc46b12015-12-23 18:27:23 +00001197 setHungoffOperand<0>(Fn);
Vedant Kumar3a63fb32015-12-19 08:52:49 +00001198 setValueSubclassDataBit(3, Fn != nullptr);
Vedant Kumar1ab5ea52015-10-06 20:31:57 +00001199}
1200
Peter Collingbourne3fa50f92013-09-16 01:08:15 +00001201Constant *Function::getPrefixData() const {
Vedant Kumar3a63fb32015-12-19 08:52:49 +00001202 assert(hasPrefixData() && getNumOperands());
1203 return cast<Constant>(Op<1>());
Peter Collingbourne3fa50f92013-09-16 01:08:15 +00001204}
1205
1206void Function::setPrefixData(Constant *PrefixData) {
Keno Fischer9bc46b12015-12-23 18:27:23 +00001207 setHungoffOperand<1>(PrefixData);
Vedant Kumar3a63fb32015-12-19 08:52:49 +00001208 setValueSubclassDataBit(1, PrefixData != nullptr);
Peter Collingbourne3fa50f92013-09-16 01:08:15 +00001209}
Peter Collingbourne51d2de72014-12-03 02:08:38 +00001210
1211Constant *Function::getPrologueData() const {
Vedant Kumar3a63fb32015-12-19 08:52:49 +00001212 assert(hasPrologueData() && getNumOperands());
1213 return cast<Constant>(Op<2>());
Peter Collingbourne51d2de72014-12-03 02:08:38 +00001214}
1215
1216void Function::setPrologueData(Constant *PrologueData) {
Keno Fischer9bc46b12015-12-23 18:27:23 +00001217 setHungoffOperand<2>(PrologueData);
Vedant Kumar3a63fb32015-12-19 08:52:49 +00001218 setValueSubclassDataBit(2, PrologueData != nullptr);
1219}
1220
1221void Function::allocHungoffUselist() {
1222 // If we've already allocated a uselist, stop here.
1223 if (getNumOperands())
Peter Collingbourne51d2de72014-12-03 02:08:38 +00001224 return;
1225
Vedant Kumar3a63fb32015-12-19 08:52:49 +00001226 allocHungoffUses(3, /*IsPhi=*/ false);
1227 setNumHungOffUseOperands(3);
1228
1229 // Initialize the uselist with placeholder operands to allow traversal.
1230 auto *CPN = ConstantPointerNull::get(Type::getInt1PtrTy(getContext(), 0));
1231 Op<0>().set(CPN);
1232 Op<1>().set(CPN);
1233 Op<2>().set(CPN);
1234}
1235
1236template <int Idx>
1237void Function::setHungoffOperand(Constant *C) {
Keno Fischer9bc46b12015-12-23 18:27:23 +00001238 if (C) {
1239 allocHungoffUselist();
1240 Op<Idx>().set(C);
1241 } else if (getNumOperands()) {
1242 Op<Idx>().set(
1243 ConstantPointerNull::get(Type::getInt1PtrTy(getContext(), 0)));
1244 }
Vedant Kumar3a63fb32015-12-19 08:52:49 +00001245}
1246
1247void Function::setValueSubclassDataBit(unsigned Bit, bool On) {
1248 assert(Bit < 16 && "SubclassData contains only 16 bits");
1249 if (On)
1250 setValueSubclassData(getSubclassDataFromValue() | (1 << Bit));
1251 else
1252 setValueSubclassData(getSubclassDataFromValue() & ~(1 << Bit));
Peter Collingbourne51d2de72014-12-03 02:08:38 +00001253}
Akira Hatanaka3058d0f2015-05-06 23:54:14 +00001254
Dehao Chena60cdd32017-02-28 18:09:44 +00001255void Function::setEntryCount(uint64_t Count,
1256 const DenseSet<GlobalValue::GUID> *S) {
Diego Novillo2567f3d2015-05-13 15:13:45 +00001257 MDBuilder MDB(getContext());
Dehao Chena60cdd32017-02-28 18:09:44 +00001258 setMetadata(LLVMContext::MD_prof, MDB.createFunctionEntryCount(Count, S));
Diego Novillo2567f3d2015-05-13 15:13:45 +00001259}
1260
1261Optional<uint64_t> Function::getEntryCount() const {
1262 MDNode *MD = getMetadata(LLVMContext::MD_prof);
1263 if (MD && MD->getOperand(0))
1264 if (MDString *MDS = dyn_cast<MDString>(MD->getOperand(0)))
1265 if (MDS->getString().equals("function_entry_count")) {
1266 ConstantInt *CI = mdconst::extract<ConstantInt>(MD->getOperand(1));
David Callahanc1c810d2016-08-05 18:38:19 +00001267 uint64_t Count = CI->getValue().getZExtValue();
1268 if (Count == 0)
1269 return None;
1270 return Count;
Diego Novillo2567f3d2015-05-13 15:13:45 +00001271 }
1272 return None;
1273}
Dehao Chen302b69c2016-10-18 20:42:47 +00001274
Dehao Chena60cdd32017-02-28 18:09:44 +00001275DenseSet<GlobalValue::GUID> Function::getImportGUIDs() const {
1276 DenseSet<GlobalValue::GUID> R;
1277 if (MDNode *MD = getMetadata(LLVMContext::MD_prof))
1278 if (MDString *MDS = dyn_cast<MDString>(MD->getOperand(0)))
1279 if (MDS->getString().equals("function_entry_count"))
1280 for (unsigned i = 2; i < MD->getNumOperands(); i++)
1281 R.insert(mdconst::extract<ConstantInt>(MD->getOperand(i))
1282 ->getValue()
1283 .getZExtValue());
1284 return R;
1285}
1286
Dehao Chen302b69c2016-10-18 20:42:47 +00001287void Function::setSectionPrefix(StringRef Prefix) {
1288 MDBuilder MDB(getContext());
1289 setMetadata(LLVMContext::MD_section_prefix,
1290 MDB.createFunctionSectionPrefix(Prefix));
1291}
1292
1293Optional<StringRef> Function::getSectionPrefix() const {
1294 if (MDNode *MD = getMetadata(LLVMContext::MD_section_prefix)) {
1295 assert(dyn_cast<MDString>(MD->getOperand(0))
1296 ->getString()
1297 .equals("function_section_prefix") &&
1298 "Metadata not match");
1299 return dyn_cast<MDString>(MD->getOperand(1))->getString();
1300 }
1301 return None;
1302}