blob: 58c060550322a8d74dc88af9c1fcba14b5e8806d [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");
Reid Kleckner859f8b52017-04-28 20:34:27 +000087 return getParent()->getParamAlignment(getArgNo());
Chris Lattner4d37d992011-05-22 23:57:23 +000088}
89
Hal Finkelb0407ba2014-07-18 15:51:28 +000090uint64_t Argument::getDereferenceableBytes() const {
91 assert(getType()->isPointerTy() &&
92 "Only pointers have dereferenceable bytes");
Reid Klecknera0b45f42017-05-03 18:17:31 +000093 return getParent()->getDereferenceableBytes(getArgNo() +
94 AttributeList::FirstArgIndex);
Hal Finkelb0407ba2014-07-18 15:51:28 +000095}
96
Sanjoy Das06cf33f2015-05-06 17:41:54 +000097uint64_t Argument::getDereferenceableOrNullBytes() const {
98 assert(getType()->isPointerTy() &&
99 "Only pointers have dereferenceable bytes");
Reid Klecknera0b45f42017-05-03 18:17:31 +0000100 return getParent()->getDereferenceableOrNullBytes(
101 getArgNo() + AttributeList::FirstArgIndex);
Sanjoy Das06cf33f2015-05-06 17:41:54 +0000102}
103
Duncan Sands5d96f3f2009-12-11 08:36:17 +0000104bool Argument::hasNestAttr() const {
Duncan Sands19d0b472010-02-16 11:11:14 +0000105 if (!getType()->isPointerTy()) return false;
Amaury Sechet7b05a4c2016-03-14 01:37:29 +0000106 return hasAttribute(Attribute::Nest);
Duncan Sands5d96f3f2009-12-11 08:36:17 +0000107}
108
Chris Lattnere30f09d2008-01-24 17:47:11 +0000109bool Argument::hasNoAliasAttr() const {
Duncan Sands19d0b472010-02-16 11:11:14 +0000110 if (!getType()->isPointerTy()) return false;
Amaury Sechet7b05a4c2016-03-14 01:37:29 +0000111 return hasAttribute(Attribute::NoAlias);
Chris Lattnere30f09d2008-01-24 17:47:11 +0000112}
113
Duncan Sandsdf128eb2008-12-31 18:08:59 +0000114bool Argument::hasNoCaptureAttr() const {
Duncan Sands19d0b472010-02-16 11:11:14 +0000115 if (!getType()->isPointerTy()) return false;
Amaury Sechet7b05a4c2016-03-14 01:37:29 +0000116 return hasAttribute(Attribute::NoCapture);
Duncan Sandsdf128eb2008-12-31 18:08:59 +0000117}
118
Owen Andersonc64dfb42008-02-17 23:22:28 +0000119bool Argument::hasStructRetAttr() const {
Duncan Sands19d0b472010-02-16 11:11:14 +0000120 if (!getType()->isPointerTy()) return false;
Amaury Sechet7b05a4c2016-03-14 01:37:29 +0000121 return hasAttribute(Attribute::StructRet);
Owen Andersonc64dfb42008-02-17 23:22:28 +0000122}
123
Stephen Linb8bd2322013-04-20 05:14:40 +0000124bool Argument::hasReturnedAttr() const {
Amaury Sechet7b05a4c2016-03-14 01:37:29 +0000125 return hasAttribute(Attribute::Returned);
Stephen Linb8bd2322013-04-20 05:14:40 +0000126}
127
Juergen Ributzka384c3b52014-08-05 05:43:41 +0000128bool Argument::hasZExtAttr() const {
Amaury Sechet7b05a4c2016-03-14 01:37:29 +0000129 return hasAttribute(Attribute::ZExt);
Juergen Ributzka384c3b52014-08-05 05:43:41 +0000130}
131
Juergen Ributzka384c3b52014-08-05 05:43:41 +0000132bool Argument::hasSExtAttr() const {
Amaury Sechet7b05a4c2016-03-14 01:37:29 +0000133 return hasAttribute(Attribute::SExt);
Juergen Ributzka384c3b52014-08-05 05:43:41 +0000134}
135
Nick Lewyckyc2ec0722013-07-06 00:29:58 +0000136bool Argument::onlyReadsMemory() const {
Reid Klecknerf021fab2017-04-13 23:12:13 +0000137 AttributeList Attrs = getParent()->getAttributes();
138 return Attrs.hasParamAttribute(getArgNo(), Attribute::ReadOnly) ||
139 Attrs.hasParamAttribute(getArgNo(), Attribute::ReadNone);
Nick Lewyckyc2ec0722013-07-06 00:29:58 +0000140}
141
Reid Kleckner9d16fa02017-04-19 17:28:52 +0000142void Argument::addAttrs(AttrBuilder &B) {
143 AttributeList AL = getParent()->getAttributes();
Reid Klecknera0b45f42017-05-03 18:17:31 +0000144 AL = AL.addAttributes(Parent->getContext(),
145 getArgNo() + AttributeList::FirstArgIndex, B);
Reid Kleckner9d16fa02017-04-19 17:28:52 +0000146 getParent()->setAttributes(AL);
147}
148
149void Argument::addAttr(Attribute::AttrKind Kind) {
Reid Klecknera0b45f42017-05-03 18:17:31 +0000150 getParent()->addAttribute(getArgNo() + AttributeList::FirstArgIndex, Kind);
Reid Kleckner9d16fa02017-04-19 17:28:52 +0000151}
152
153void Argument::addAttr(Attribute Attr) {
Reid Klecknera0b45f42017-05-03 18:17:31 +0000154 getParent()->addAttribute(getArgNo() + AttributeList::FirstArgIndex, Attr);
Gordon Henriksen2d9cc212008-04-28 17:37:06 +0000155}
Chris Lattnere30f09d2008-01-24 17:47:11 +0000156
Reid Kleckner9d16fa02017-04-19 17:28:52 +0000157void Argument::removeAttr(Attribute::AttrKind Kind) {
Reid Klecknera0b45f42017-05-03 18:17:31 +0000158 getParent()->removeAttribute(getArgNo() + AttributeList::FirstArgIndex, Kind);
Reid Kleckner9d16fa02017-04-19 17:28:52 +0000159}
160
Amaury Sechet7b05a4c2016-03-14 01:37:29 +0000161bool Argument::hasAttribute(Attribute::AttrKind Kind) const {
Reid Klecknerf021fab2017-04-13 23:12:13 +0000162 return getParent()->hasParamAttribute(getArgNo(), Kind);
Amaury Sechet7b05a4c2016-03-14 01:37:29 +0000163}
164
Chris Lattnerd255ae22002-04-09 19:39:35 +0000165//===----------------------------------------------------------------------===//
Chris Lattner3e13b8c2008-01-02 23:42:30 +0000166// Helper Methods in Function
Reid Spencer019c8862007-04-09 15:01:12 +0000167//===----------------------------------------------------------------------===//
168
Owen Anderson47db9412009-07-22 00:24:57 +0000169LLVMContext &Function::getContext() const {
170 return getType()->getContext();
Owen Anderson0a2c4582009-07-02 18:03:58 +0000171}
172
Chris Lattner3e13b8c2008-01-02 23:42:30 +0000173void Function::removeFromParent() {
Duncan P. N. Exon Smith52888a62015-10-08 23:49:46 +0000174 getParent()->getFunctionList().remove(getIterator());
Duncan Sands185eeac2007-11-25 14:10:56 +0000175}
176
Chris Lattner3e13b8c2008-01-02 23:42:30 +0000177void Function::eraseFromParent() {
Duncan P. N. Exon Smith52888a62015-10-08 23:49:46 +0000178 getParent()->getFunctionList().erase(getIterator());
Reid Spencer019c8862007-04-09 15:01:12 +0000179}
180
Reid Spencer019c8862007-04-09 15:01:12 +0000181//===----------------------------------------------------------------------===//
Chris Lattner57698e22002-03-26 18:01:55 +0000182// Function Implementation
Chris Lattnerda975502001-09-10 07:58:01 +0000183//===----------------------------------------------------------------------===//
184
Rafael Espindola1b47a282014-10-23 15:20:05 +0000185Function::Function(FunctionType *Ty, LinkageTypes Linkage, const Twine &name,
186 Module *ParentModule)
David Blaikied583b192015-08-21 21:35:28 +0000187 : GlobalObject(Ty, Value::FunctionVal,
Reid Kleckner56d028d2017-03-17 17:16:39 +0000188 OperandTraits<Function>::op_begin(this), 0, Linkage, name),
189 Arguments(nullptr), NumArgs(Ty->getNumParams()) {
Chris Lattner654695b2009-01-05 07:58:59 +0000190 assert(FunctionType::isValidReturnType(getReturnType()) &&
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000191 "invalid return type");
Duncan P. N. Exon Smith4472b772015-04-24 20:47:23 +0000192 setGlobalObjectSubClassData(0);
Mehdi Aminia53d49e2016-09-17 06:00:02 +0000193
194 // We only need a symbol table for a function if the context keeps value names
195 if (!getContext().shouldDiscardValueNames())
196 SymTab = make_unique<ValueSymbolTable>();
Chris Lattner6213ae02002-09-06 20:46:32 +0000197
Chris Lattnere2de9082007-08-18 06:14:52 +0000198 // If the function has arguments, mark them as lazily built.
199 if (Ty->getNumParams())
Chris Lattnerb9c86512009-12-29 02:14:09 +0000200 setValueSubclassData(1); // Set the "has lazy arguments" bit.
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000201
Chris Lattner6213ae02002-09-06 20:46:32 +0000202 if (ParentModule)
203 ParentModule->getFunctionList().push_back(this);
Duncan Sandsa8ff6ca2008-04-07 13:39:11 +0000204
Justin Lebar291abd32016-12-28 22:59:45 +0000205 HasLLVMReservedName = getName().startswith("llvm.");
Duncan Sandsa8ff6ca2008-04-07 13:39:11 +0000206 // Ensure intrinsics have the right parameter attributes.
Pete Coopera7c0c182015-05-19 00:24:26 +0000207 // Note, the IntID field will have been set in Value::setName if this function
208 // name is a valid intrinsic ID.
209 if (IntID)
210 setAttributes(Intrinsic::getAttributes(getContext(), IntID));
Chris Lattner2f7c9632001-06-06 20:29:01 +0000211}
212
Gordon Henriksen14a55692007-12-10 02:14:30 +0000213Function::~Function() {
214 dropAllReferences(); // After this it is safe to delete instructions.
Chris Lattner2f7c9632001-06-06 20:29:01 +0000215
Chris Lattner2f7c9632001-06-06 20:29:01 +0000216 // Delete all of the method arguments and unlink from symbol table...
Reid Kleckner56d028d2017-03-17 17:16:39 +0000217 if (Arguments)
218 clearArguments();
Reid Spencerc6a83842007-04-22 17:28:03 +0000219
Gordon Henriksend930f912008-08-17 18:44:35 +0000220 // Remove the function from the on-the-side GC table.
221 clearGC();
Chris Lattner2f7c9632001-06-06 20:29:01 +0000222}
223
Chris Lattnere2de9082007-08-18 06:14:52 +0000224void Function::BuildLazyArguments() const {
225 // Create the arguments vector, all arguments start out unnamed.
Reid Kleckner56d028d2017-03-17 17:16:39 +0000226 auto *FT = getFunctionType();
227 if (NumArgs > 0) {
228 Arguments = std::allocator<Argument>().allocate(NumArgs);
229 for (unsigned i = 0, e = NumArgs; i != e; ++i) {
230 Type *ArgTy = FT->getParamType(i);
231 assert(!ArgTy->isVoidTy() && "Cannot have void typed arguments!");
232 new (Arguments + i) Argument(ArgTy, "", const_cast<Function *>(this), i);
233 }
Chris Lattnere2de9082007-08-18 06:14:52 +0000234 }
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000235
Chris Lattnere2de9082007-08-18 06:14:52 +0000236 // Clear the lazy arguments bit.
Chris Lattnerb9c86512009-12-29 02:14:09 +0000237 unsigned SDC = getSubclassDataFromValue();
Peter Collingbourne51d2de72014-12-03 02:08:38 +0000238 const_cast<Function*>(this)->setValueSubclassData(SDC &= ~(1<<0));
Reid Kleckner56d028d2017-03-17 17:16:39 +0000239 assert(!hasLazyArguments());
240}
241
242static MutableArrayRef<Argument> makeArgArray(Argument *Args, size_t Count) {
243 return MutableArrayRef<Argument>(Args, Count);
244}
245
246void Function::clearArguments() {
247 for (Argument &A : makeArgArray(Arguments, NumArgs)) {
248 A.setName("");
249 A.~Argument();
250 }
251 std::allocator<Argument>().deallocate(Arguments, NumArgs);
252 Arguments = nullptr;
Chris Lattnere2de9082007-08-18 06:14:52 +0000253}
254
Duncan P. N. Exon Smithbdfc9842016-04-06 06:38:15 +0000255void Function::stealArgumentListFrom(Function &Src) {
256 assert(isDeclaration() && "Expected no references to current arguments");
257
258 // Drop the current arguments, if any, and set the lazy argument bit.
259 if (!hasLazyArguments()) {
Reid Kleckner56d028d2017-03-17 17:16:39 +0000260 assert(llvm::all_of(makeArgArray(Arguments, NumArgs),
Duncan P. N. Exon Smithbdfc9842016-04-06 06:38:15 +0000261 [](const Argument &A) { return A.use_empty(); }) &&
262 "Expected arguments to be unused in declaration");
Reid Kleckner56d028d2017-03-17 17:16:39 +0000263 clearArguments();
Duncan P. N. Exon Smithbdfc9842016-04-06 06:38:15 +0000264 setValueSubclassData(getSubclassDataFromValue() | (1 << 0));
265 }
266
267 // Nothing to steal if Src has lazy arguments.
268 if (Src.hasLazyArguments())
269 return;
270
271 // Steal arguments from Src, and fix the lazy argument bits.
Reid Kleckner56d028d2017-03-17 17:16:39 +0000272 assert(arg_size() == Src.arg_size());
273 Arguments = Src.Arguments;
274 Src.Arguments = nullptr;
275 for (Argument &A : makeArgArray(Arguments, NumArgs)) {
276 // FIXME: This does the work of transferNodesFromList inefficiently.
277 SmallString<128> Name;
278 if (A.hasName())
279 Name = A.getName();
280 if (!Name.empty())
281 A.setName("");
282 A.setParent(this);
283 if (!Name.empty())
284 A.setName(Name);
285 }
286
Duncan P. N. Exon Smithbdfc9842016-04-06 06:38:15 +0000287 setValueSubclassData(getSubclassDataFromValue() & ~(1 << 0));
Reid Kleckner56d028d2017-03-17 17:16:39 +0000288 assert(!hasLazyArguments());
Duncan P. N. Exon Smithbdfc9842016-04-06 06:38:15 +0000289 Src.setValueSubclassData(Src.getSubclassDataFromValue() | (1 << 0));
290}
291
Chris Lattner2f7c9632001-06-06 20:29:01 +0000292// dropAllReferences() - This function causes all the subinstructions to "let
293// go" of all references that they are maintaining. This allows one to
294// 'delete' a whole class at a time, even though there may be circular
295// references... first all references are dropped, and all use counts go to
Misha Brukmanfa100532003-10-10 17:54:14 +0000296// zero. Then everything is deleted for real. Note that no operations are
Misha Brukmanb1c93172005-04-21 23:48:37 +0000297// valid on an object that has "dropped all references", except operator
Chris Lattner2f7c9632001-06-06 20:29:01 +0000298// delete.
299//
Chris Lattner4e8c4872002-03-23 22:51:58 +0000300void Function::dropAllReferences() {
Rafael Espindolad4bcefc2014-10-24 18:13:04 +0000301 setIsMaterializable(false);
302
Benjamin Krameraf28e7d2016-06-26 14:10:56 +0000303 for (BasicBlock &BB : *this)
304 BB.dropAllReferences();
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000305
Dan Gohmanf844b3b2010-12-07 19:56:51 +0000306 // Delete all basic blocks. They are now unused, except possibly by
307 // blockaddresses, but BasicBlock's destructor takes care of those.
308 while (!BasicBlocks.empty())
309 BasicBlocks.begin()->eraseFromParent();
Peter Collingbourne3fa50f92013-09-16 01:08:15 +0000310
Vedant Kumar3a63fb32015-12-19 08:52:49 +0000311 // Drop uses of any optional data (real or placeholder).
312 if (getNumOperands()) {
313 User::dropAllReferences();
314 setNumHungOffUseOperands(0);
315 setValueSubclassData(getSubclassDataFromValue() & ~0xe);
316 }
Duncan P. N. Exon Smithe2510cd2015-04-24 21:51:02 +0000317
318 // Metadata is stored in a side-table.
319 clearMetadata();
Chris Lattner2f7c9632001-06-06 20:29:01 +0000320}
Chris Lattnerda975502001-09-10 07:58:01 +0000321
Amaury Sechet392638d2016-06-14 20:27:35 +0000322void Function::addAttribute(unsigned i, Attribute::AttrKind Kind) {
Reid Klecknerb5180542017-03-21 16:57:19 +0000323 AttributeList PAL = getAttributes();
Amaury Sechet392638d2016-06-14 20:27:35 +0000324 PAL = PAL.addAttribute(getContext(), i, Kind);
Devang Patel4c758ea2008-09-25 21:00:45 +0000325 setAttributes(PAL);
Eric Christopher901b1a72008-05-16 20:39:43 +0000326}
327
Amaury Sechet5db224e2016-06-12 06:17:24 +0000328void Function::addAttribute(unsigned i, Attribute Attr) {
Reid Klecknerb5180542017-03-21 16:57:19 +0000329 AttributeList PAL = getAttributes();
Amaury Sechet5db224e2016-06-12 06:17:24 +0000330 PAL = PAL.addAttribute(getContext(), i, Attr);
331 setAttributes(PAL);
332}
333
Reid Kleckneree4930b2017-05-02 22:07:37 +0000334void Function::addAttributes(unsigned i, const AttrBuilder &Attrs) {
Reid Klecknerb5180542017-03-21 16:57:19 +0000335 AttributeList PAL = getAttributes();
Amaury Sechet392638d2016-06-14 20:27:35 +0000336 PAL = PAL.addAttributes(getContext(), i, Attrs);
Bill Wendlingc0e2a1f2013-01-23 00:20:53 +0000337 setAttributes(PAL);
338}
339
Amaury Sechet392638d2016-06-14 20:27:35 +0000340void Function::removeAttribute(unsigned i, Attribute::AttrKind Kind) {
Reid Klecknerb5180542017-03-21 16:57:19 +0000341 AttributeList PAL = getAttributes();
Amaury Sechet392638d2016-06-14 20:27:35 +0000342 PAL = PAL.removeAttribute(getContext(), i, Kind);
Amaury Sechet7b05a4c2016-03-14 01:37:29 +0000343 setAttributes(PAL);
344}
345
Amaury Sechet6100adf2016-06-15 17:50:39 +0000346void Function::removeAttribute(unsigned i, StringRef Kind) {
Reid Klecknerb5180542017-03-21 16:57:19 +0000347 AttributeList PAL = getAttributes();
Amaury Sechet6100adf2016-06-15 17:50:39 +0000348 PAL = PAL.removeAttribute(getContext(), i, Kind);
349 setAttributes(PAL);
350}
351
Reid Kleckneree4930b2017-05-02 22:07:37 +0000352void Function::removeAttributes(unsigned i, const AttrBuilder &Attrs) {
Reid Klecknerb5180542017-03-21 16:57:19 +0000353 AttributeList PAL = getAttributes();
Amaury Sechet392638d2016-06-14 20:27:35 +0000354 PAL = PAL.removeAttributes(getContext(), i, Attrs);
Devang Patel4c758ea2008-09-25 21:00:45 +0000355 setAttributes(PAL);
Duncan Sands66336db2008-07-08 09:41:30 +0000356}
357
Ramkumar Ramachandra8fcb4982015-02-14 19:37:54 +0000358void Function::addDereferenceableAttr(unsigned i, uint64_t Bytes) {
Reid Klecknerb5180542017-03-21 16:57:19 +0000359 AttributeList PAL = getAttributes();
Ramkumar Ramachandra8fcb4982015-02-14 19:37:54 +0000360 PAL = PAL.addDereferenceableAttr(getContext(), i, Bytes);
361 setAttributes(PAL);
362}
363
Sanjoy Das31ea6d12015-04-16 20:29:50 +0000364void Function::addDereferenceableOrNullAttr(unsigned i, uint64_t Bytes) {
Reid Klecknerb5180542017-03-21 16:57:19 +0000365 AttributeList PAL = getAttributes();
Sanjoy Das31ea6d12015-04-16 20:29:50 +0000366 PAL = PAL.addDereferenceableOrNullAttr(getContext(), i, Bytes);
367 setAttributes(PAL);
368}
369
Mehdi Amini599ebf22016-01-08 02:28:20 +0000370const std::string &Function::getGC() const {
Gordon Henriksend930f912008-08-17 18:44:35 +0000371 assert(hasGC() && "Function has no collector");
Mehdi Amini599ebf22016-01-08 02:28:20 +0000372 return getContext().getGC(*this);
Gordon Henriksen71183b62007-12-10 03:18:06 +0000373}
374
Benjamin Kramer728f4442016-05-29 10:46:35 +0000375void Function::setGC(std::string Str) {
Mehdi Amini599ebf22016-01-08 02:28:20 +0000376 setValueSubclassDataBit(14, !Str.empty());
377 getContext().setGC(*this, std::move(Str));
Gordon Henriksen71183b62007-12-10 03:18:06 +0000378}
379
Gordon Henriksend930f912008-08-17 18:44:35 +0000380void Function::clearGC() {
Mehdi Amini599ebf22016-01-08 02:28:20 +0000381 if (!hasGC())
382 return;
383 getContext().deleteGC(*this);
384 setValueSubclassDataBit(14, false);
Gordon Henriksen71183b62007-12-10 03:18:06 +0000385}
386
Rafael Espindola769efe62015-12-02 20:03:17 +0000387/// Copy all additional attributes (those not needed to create a Function) from
388/// the Function Src to this one.
Duncan Sandsdd7daee2008-05-26 19:58:59 +0000389void Function::copyAttributesFrom(const GlobalValue *Src) {
Rafael Espindola99e05cf2014-05-13 18:45:48 +0000390 GlobalObject::copyAttributesFrom(Src);
Rafael Espindola769efe62015-12-02 20:03:17 +0000391 const Function *SrcF = dyn_cast<Function>(Src);
392 if (!SrcF)
393 return;
394
Duncan Sandsdd7daee2008-05-26 19:58:59 +0000395 setCallingConv(SrcF->getCallingConv());
Devang Patel4c758ea2008-09-25 21:00:45 +0000396 setAttributes(SrcF->getAttributes());
Gordon Henriksend930f912008-08-17 18:44:35 +0000397 if (SrcF->hasGC())
398 setGC(SrcF->getGC());
399 else
400 clearGC();
Vedant Kumar44dd9872015-12-19 08:48:43 +0000401 if (SrcF->hasPersonalityFn())
402 setPersonalityFn(SrcF->getPersonalityFn());
Vedant Kumar3a63fb32015-12-19 08:52:49 +0000403 if (SrcF->hasPrefixData())
404 setPrefixData(SrcF->getPrefixData());
405 if (SrcF->hasPrologueData())
406 setPrologueData(SrcF->getPrologueData());
Duncan Sandsdd7daee2008-05-26 19:58:59 +0000407}
408
Reid Kleckner0b5220d2016-01-26 02:06:41 +0000409/// Table of string intrinsic names indexed by enum value.
410static const char * const IntrinsicNameTable[] = {
411 "not_intrinsic",
412#define GET_INTRINSIC_NAME_TABLE
413#include "llvm/IR/Intrinsics.gen"
414#undef GET_INTRINSIC_NAME_TABLE
415};
416
Justin Bogner92a8c612016-07-15 16:31:37 +0000417/// Table of per-target intrinsic name tables.
418#define GET_INTRINSIC_TARGET_DATA
419#include "llvm/IR/Intrinsics.gen"
420#undef GET_INTRINSIC_TARGET_DATA
421
422/// Find the segment of \c IntrinsicNameTable for intrinsics with the same
423/// target as \c Name, or the generic table if \c Name is not target specific.
424///
425/// Returns the relevant slice of \c IntrinsicNameTable
426static ArrayRef<const char *> findTargetSubtable(StringRef Name) {
427 assert(Name.startswith("llvm."));
428
429 ArrayRef<IntrinsicTargetInfo> Targets(TargetInfos);
430 // Drop "llvm." and take the first dotted component. That will be the target
431 // if this is target specific.
432 StringRef Target = Name.drop_front(5).split('.').first;
433 auto It = std::lower_bound(Targets.begin(), Targets.end(), Target,
434 [](const IntrinsicTargetInfo &TI,
435 StringRef Target) { return TI.Name < Target; });
436 // We've either found the target or just fall back to the generic set, which
437 // is always first.
438 const auto &TI = It != Targets.end() && It->Name == Target ? *It : Targets[0];
439 return makeArrayRef(&IntrinsicNameTable[1] + TI.Offset, TI.Count);
440}
441
Pete Cooper21241132015-05-19 00:02:25 +0000442/// \brief This does the actual lookup of an intrinsic ID which
443/// matches the given function name.
Tim Northover6b3bd612016-07-29 20:32:59 +0000444Intrinsic::ID Function::lookupIntrinsicID(StringRef Name) {
Justin Bogner92a8c612016-07-15 16:31:37 +0000445 ArrayRef<const char *> NameTable = findTargetSubtable(Name);
Reid Klecknerc2752da2016-01-26 22:33:19 +0000446 int Idx = Intrinsic::lookupLLVMIntrinsicByName(NameTable, Name);
Justin Bogner92a8c612016-07-15 16:31:37 +0000447 if (Idx == -1)
448 return Intrinsic::not_intrinsic;
449
450 // Intrinsic IDs correspond to the location in IntrinsicNameTable, but we have
451 // an index into a sub-table.
452 int Adjust = NameTable.data() - IntrinsicNameTable;
453 Intrinsic::ID ID = static_cast<Intrinsic::ID>(Idx + Adjust);
Pete Cooper21241132015-05-19 00:02:25 +0000454
Reid Kleckner0b5220d2016-01-26 02:06:41 +0000455 // If the intrinsic is not overloaded, require an exact match. If it is
456 // overloaded, require a prefix match.
457 bool IsPrefixMatch = Name.size() > strlen(NameTable[Idx]);
458 return IsPrefixMatch == isOverloaded(ID) ? ID : Intrinsic::not_intrinsic;
Pete Cooper21241132015-05-19 00:02:25 +0000459}
460
Pete Coopera7c0c182015-05-19 00:24:26 +0000461void Function::recalculateIntrinsicID() {
Justin Lebar291abd32016-12-28 22:59:45 +0000462 StringRef Name = getName();
463 if (!Name.startswith("llvm.")) {
464 HasLLVMReservedName = false;
Pete Coopera7c0c182015-05-19 00:24:26 +0000465 IntID = Intrinsic::not_intrinsic;
466 return;
Michael Ilseman516d7032013-03-01 18:48:54 +0000467 }
Justin Lebar291abd32016-12-28 22:59:45 +0000468 HasLLVMReservedName = true;
469 IntID = lookupIntrinsicID(Name);
Michael Ilseman516d7032013-03-01 18:48:54 +0000470}
471
Philip Reames319c48e2014-11-12 00:21:51 +0000472/// Returns a stable mangling for the type specified for use in the name
Philip Reames059ecbf2014-11-24 23:24:24 +0000473/// mangling scheme used by 'any' types in intrinsic signatures. The mangling
474/// of named types is simply their name. Manglings for unnamed types consist
475/// of a prefix ('p' for pointers, 'a' for arrays, 'f_' for functions)
476/// combined with the mangling of their component types. A vararg function
477/// type will have a suffix of 'vararg'. Since function types can contain
478/// other function types, we close a function type mangling with suffix 'f'
479/// which can't be confused with it's prefix. This ensures we don't have
480/// collisions between two unrelated function types. Otherwise, you might
481/// parse ffXX as f(fXX) or f(fX)X. (X is a placeholder for any other type.)
Philip Reames8d5d68f2015-01-14 23:05:17 +0000482/// Manglings of integers, floats, and vectors ('i', 'f', and 'v' prefix in most
483/// cases) fall back to the MVT codepath, where they could be mangled to
484/// 'x86mmx', for example; matching on derived types is not sufficient to mangle
485/// everything.
Philip Reames319c48e2014-11-12 00:21:51 +0000486static std::string getMangledTypeStr(Type* Ty) {
487 std::string Result;
488 if (PointerType* PTyp = dyn_cast<PointerType>(Ty)) {
489 Result += "p" + llvm::utostr(PTyp->getAddressSpace()) +
490 getMangledTypeStr(PTyp->getElementType());
491 } else if (ArrayType* ATyp = dyn_cast<ArrayType>(Ty)) {
492 Result += "a" + llvm::utostr(ATyp->getNumElements()) +
493 getMangledTypeStr(ATyp->getElementType());
Daniel Berlin3c1432f2017-02-15 23:16:20 +0000494 } else if (StructType *STyp = dyn_cast<StructType>(Ty)) {
495 if (!STyp->isLiteral()) {
496 Result += "s_";
497 Result += STyp->getName();
498 } else {
499 Result += "sl_";
500 for (auto Elem : STyp->elements())
501 Result += getMangledTypeStr(Elem);
502 }
503 // Ensure nested structs are distinguishable.
504 Result += "s";
505 } else if (FunctionType *FT = dyn_cast<FunctionType>(Ty)) {
Philip Reames319c48e2014-11-12 00:21:51 +0000506 Result += "f_" + getMangledTypeStr(FT->getReturnType());
507 for (size_t i = 0; i < FT->getNumParams(); i++)
508 Result += getMangledTypeStr(FT->getParamType(i));
509 if (FT->isVarArg())
510 Result += "vararg";
Philip Reames059ecbf2014-11-24 23:24:24 +0000511 // Ensure nested function types are distinguishable.
512 Result += "f";
Elena Demikhovsky1ca72e12015-11-19 07:17:16 +0000513 } else if (isa<VectorType>(Ty))
514 Result += "v" + utostr(Ty->getVectorNumElements()) +
515 getMangledTypeStr(Ty->getVectorElementType());
516 else if (Ty)
Philip Reames319c48e2014-11-12 00:21:51 +0000517 Result += EVT::getEVT(Ty).getEVTString();
518 return Result;
519}
520
Pete Coopera8db71e2016-08-18 18:30:54 +0000521StringRef Intrinsic::getName(ID id) {
522 assert(id < num_intrinsics && "Invalid intrinsic ID!");
Pete Coopera5f8c722016-08-22 20:18:28 +0000523 assert(!isOverloaded(id) &&
524 "This version of getName does not support overloading");
Pete Coopera8db71e2016-08-18 18:30:54 +0000525 return IntrinsicNameTable[id];
526}
527
Benjamin Kramere6e19332011-07-14 17:45:39 +0000528std::string Intrinsic::getName(ID id, ArrayRef<Type*> Tys) {
Chris Lattner71b8c982006-03-25 06:32:47 +0000529 assert(id < num_intrinsics && "Invalid intrinsic ID!");
Reid Kleckner0b5220d2016-01-26 02:06:41 +0000530 std::string Result(IntrinsicNameTable[id]);
Benjamin Krameraf28e7d2016-06-26 14:10:56 +0000531 for (Type *Ty : Tys) {
532 Result += "." + getMangledTypeStr(Ty);
Mon P Wang2c839d42008-07-30 04:36:53 +0000533 }
Reid Spencer2a2117c2007-04-01 07:25:33 +0000534 return Result;
Chris Lattner71b8c982006-03-25 06:32:47 +0000535}
536
Chris Lattner7f0e7ba2012-05-16 06:34:44 +0000537
Chris Lattnerf39c2782012-05-27 18:28:35 +0000538/// IIT_Info - These are enumerators that describe the entries returned by the
539/// getIntrinsicInfoTableEntries function.
540///
541/// NOTE: This must be kept in synch with the copy in TblGen/IntrinsicEmitter!
542enum IIT_Info {
Robert Khasanov65c27562014-10-20 19:25:05 +0000543 // Common values should be encoded with 0-15.
Chris Lattnerf39c2782012-05-27 18:28:35 +0000544 IIT_Done = 0,
545 IIT_I1 = 1,
546 IIT_I8 = 2,
547 IIT_I16 = 3,
548 IIT_I32 = 4,
549 IIT_I64 = 5,
Michael Ilseman6c6d7152013-01-11 01:45:05 +0000550 IIT_F16 = 6,
551 IIT_F32 = 7,
552 IIT_F64 = 8,
553 IIT_V2 = 9,
554 IIT_V4 = 10,
555 IIT_V8 = 11,
556 IIT_V16 = 12,
557 IIT_V32 = 13,
Robert Khasanov65c27562014-10-20 19:25:05 +0000558 IIT_PTR = 14,
559 IIT_ARG = 15,
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000560
Robert Khasanov65c27562014-10-20 19:25:05 +0000561 // Values from 16+ are only encodable with the inefficient encoding.
562 IIT_V64 = 16,
Robert Khasanovb25e5622014-09-30 11:32:22 +0000563 IIT_MMX = 17,
Joseph Tremoulet917c7382015-09-02 13:36:25 +0000564 IIT_TOKEN = 18,
565 IIT_METADATA = 19,
566 IIT_EMPTYSTRUCT = 20,
567 IIT_STRUCT2 = 21,
568 IIT_STRUCT3 = 22,
569 IIT_STRUCT4 = 23,
570 IIT_STRUCT5 = 24,
571 IIT_EXTEND_ARG = 25,
572 IIT_TRUNC_ARG = 26,
573 IIT_ANYPTR = 27,
574 IIT_V1 = 28,
575 IIT_VARARG = 29,
576 IIT_HALF_VEC_ARG = 30,
577 IIT_SAME_VEC_WIDTH_ARG = 31,
578 IIT_PTR_TO_ARG = 32,
Elena Demikhovskycaaceef2016-11-03 03:23:55 +0000579 IIT_PTR_TO_ELT = 33,
Elad Cohenef5798a2017-05-03 12:28:54 +0000580 IIT_VEC_OF_ANYPTRS_TO_ELT = 34,
Elena Demikhovskycaaceef2016-11-03 03:23:55 +0000581 IIT_I128 = 35,
582 IIT_V512 = 36,
583 IIT_V1024 = 37
Chris Lattnerf39c2782012-05-27 18:28:35 +0000584};
585
Chris Lattnerf39c2782012-05-27 18:28:35 +0000586static void DecodeIITType(unsigned &NextElt, ArrayRef<unsigned char> Infos,
587 SmallVectorImpl<Intrinsic::IITDescriptor> &OutputTable) {
Chris Lattnera57c7972012-05-17 05:13:57 +0000588 IIT_Info Info = IIT_Info(Infos[NextElt++]);
Chris Lattner3e34a7b2012-05-17 05:03:24 +0000589 unsigned StructElts = 2;
Chris Lattnerf39c2782012-05-27 18:28:35 +0000590 using namespace Intrinsic;
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000591
Chris Lattnera57c7972012-05-17 05:13:57 +0000592 switch (Info) {
Chris Lattnerf39c2782012-05-27 18:28:35 +0000593 case IIT_Done:
594 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Void, 0));
595 return;
Andrew Tricka2efd992013-10-31 17:18:11 +0000596 case IIT_VARARG:
597 OutputTable.push_back(IITDescriptor::get(IITDescriptor::VarArg, 0));
598 return;
Chris Lattnerf39c2782012-05-27 18:28:35 +0000599 case IIT_MMX:
600 OutputTable.push_back(IITDescriptor::get(IITDescriptor::MMX, 0));
601 return;
Joseph Tremoulet917c7382015-09-02 13:36:25 +0000602 case IIT_TOKEN:
603 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Token, 0));
604 return;
Chris Lattnerf39c2782012-05-27 18:28:35 +0000605 case IIT_METADATA:
606 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Metadata, 0));
607 return;
Michael Ilseman6c6d7152013-01-11 01:45:05 +0000608 case IIT_F16:
609 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Half, 0));
610 return;
Chris Lattnerf39c2782012-05-27 18:28:35 +0000611 case IIT_F32:
612 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Float, 0));
613 return;
614 case IIT_F64:
615 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Double, 0));
616 return;
617 case IIT_I1:
618 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer, 1));
619 return;
620 case IIT_I8:
621 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer, 8));
622 return;
623 case IIT_I16:
624 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer,16));
625 return;
626 case IIT_I32:
627 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer, 32));
628 return;
629 case IIT_I64:
630 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer, 64));
631 return;
Kit Barton66460332015-05-25 15:49:26 +0000632 case IIT_I128:
633 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer, 128));
634 return;
Jiangning Liu63dc8402013-09-24 02:47:27 +0000635 case IIT_V1:
636 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 1));
637 DecodeIITType(NextElt, Infos, OutputTable);
638 return;
Chris Lattner827b2532012-05-17 04:30:58 +0000639 case IIT_V2:
Chris Lattnerf39c2782012-05-27 18:28:35 +0000640 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 2));
641 DecodeIITType(NextElt, Infos, OutputTable);
642 return;
Chris Lattner827b2532012-05-17 04:30:58 +0000643 case IIT_V4:
Chris Lattnerf39c2782012-05-27 18:28:35 +0000644 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 4));
645 DecodeIITType(NextElt, Infos, OutputTable);
646 return;
Chris Lattner827b2532012-05-17 04:30:58 +0000647 case IIT_V8:
Chris Lattnerf39c2782012-05-27 18:28:35 +0000648 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 8));
649 DecodeIITType(NextElt, Infos, OutputTable);
650 return;
Chris Lattner827b2532012-05-17 04:30:58 +0000651 case IIT_V16:
Chris Lattnerf39c2782012-05-27 18:28:35 +0000652 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 16));
653 DecodeIITType(NextElt, Infos, OutputTable);
654 return;
Chris Lattner3e34a7b2012-05-17 05:03:24 +0000655 case IIT_V32:
Chris Lattnerf39c2782012-05-27 18:28:35 +0000656 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 32));
657 DecodeIITType(NextElt, Infos, OutputTable);
658 return;
Robert Khasanovb25e5622014-09-30 11:32:22 +0000659 case IIT_V64:
660 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 64));
661 DecodeIITType(NextElt, Infos, OutputTable);
662 return;
Krzysztof Parzyszekb8bb90b2015-11-24 16:28:14 +0000663 case IIT_V512:
664 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 512));
665 DecodeIITType(NextElt, Infos, OutputTable);
666 return;
667 case IIT_V1024:
668 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 1024));
669 DecodeIITType(NextElt, Infos, OutputTable);
670 return;
Chris Lattner4f18aa82012-05-23 05:19:18 +0000671 case IIT_PTR:
Chris Lattnerf39c2782012-05-27 18:28:35 +0000672 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Pointer, 0));
673 DecodeIITType(NextElt, Infos, OutputTable);
674 return;
Chris Lattner4f18aa82012-05-23 05:19:18 +0000675 case IIT_ANYPTR: { // [ANYPTR addrspace, subtype]
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000676 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Pointer,
Chris Lattnerf39c2782012-05-27 18:28:35 +0000677 Infos[NextElt++]));
678 DecodeIITType(NextElt, Infos, OutputTable);
679 return;
Pete Cooper243efd72012-05-21 23:21:28 +0000680 }
Chris Lattnerf39c2782012-05-27 18:28:35 +0000681 case IIT_ARG: {
682 unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
683 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Argument, ArgInfo));
684 return;
685 }
Tim Northoveraa3cf1e2014-03-28 12:31:39 +0000686 case IIT_EXTEND_ARG: {
Chris Lattnerf39c2782012-05-27 18:28:35 +0000687 unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
Tim Northoveraa3cf1e2014-03-28 12:31:39 +0000688 OutputTable.push_back(IITDescriptor::get(IITDescriptor::ExtendArgument,
Chris Lattnerf39c2782012-05-27 18:28:35 +0000689 ArgInfo));
690 return;
691 }
Tim Northoveraa3cf1e2014-03-28 12:31:39 +0000692 case IIT_TRUNC_ARG: {
Chris Lattnerf39c2782012-05-27 18:28:35 +0000693 unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
Tim Northoveraa3cf1e2014-03-28 12:31:39 +0000694 OutputTable.push_back(IITDescriptor::get(IITDescriptor::TruncArgument,
Chris Lattnerf39c2782012-05-27 18:28:35 +0000695 ArgInfo));
696 return;
Chris Lattner3e34a7b2012-05-17 05:03:24 +0000697 }
Tim Northover4516de32014-03-29 07:04:54 +0000698 case IIT_HALF_VEC_ARG: {
699 unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
700 OutputTable.push_back(IITDescriptor::get(IITDescriptor::HalfVecArgument,
701 ArgInfo));
702 return;
703 }
Elena Demikhovskyf1de34b2014-12-04 09:40:44 +0000704 case IIT_SAME_VEC_WIDTH_ARG: {
705 unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
706 OutputTable.push_back(IITDescriptor::get(IITDescriptor::SameVecWidthArgument,
707 ArgInfo));
708 return;
709 }
Elena Demikhovskyfb81b932014-12-25 07:49:20 +0000710 case IIT_PTR_TO_ARG: {
711 unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
712 OutputTable.push_back(IITDescriptor::get(IITDescriptor::PtrToArgument,
713 ArgInfo));
714 return;
715 }
Elena Demikhovskycaaceef2016-11-03 03:23:55 +0000716 case IIT_PTR_TO_ELT: {
717 unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
718 OutputTable.push_back(IITDescriptor::get(IITDescriptor::PtrToElt, ArgInfo));
719 return;
720 }
Elad Cohenef5798a2017-05-03 12:28:54 +0000721 case IIT_VEC_OF_ANYPTRS_TO_ELT: {
722 unsigned short ArgNo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
723 unsigned short RefNo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
724 OutputTable.push_back(
725 IITDescriptor::get(IITDescriptor::VecOfAnyPtrsToElt, ArgNo, RefNo));
Elena Demikhovsky23a485a2015-02-08 08:27:19 +0000726 return;
727 }
Chris Lattnerf39c2782012-05-27 18:28:35 +0000728 case IIT_EMPTYSTRUCT:
729 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Struct, 0));
730 return;
Justin Bognercd1d5aa2016-08-17 20:30:52 +0000731 case IIT_STRUCT5: ++StructElts; LLVM_FALLTHROUGH;
732 case IIT_STRUCT4: ++StructElts; LLVM_FALLTHROUGH;
733 case IIT_STRUCT3: ++StructElts; LLVM_FALLTHROUGH;
Chris Lattner3e34a7b2012-05-17 05:03:24 +0000734 case IIT_STRUCT2: {
Chris Lattnerf39c2782012-05-27 18:28:35 +0000735 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Struct,StructElts));
736
Chris Lattner3e34a7b2012-05-17 05:03:24 +0000737 for (unsigned i = 0; i != StructElts; ++i)
Chris Lattnerf39c2782012-05-27 18:28:35 +0000738 DecodeIITType(NextElt, Infos, OutputTable);
739 return;
Chris Lattner827b2532012-05-17 04:30:58 +0000740 }
Chris Lattner7f0e7ba2012-05-16 06:34:44 +0000741 }
742 llvm_unreachable("unhandled");
743}
Chris Lattner7f0e7ba2012-05-16 06:34:44 +0000744
Chris Lattnerf39c2782012-05-27 18:28:35 +0000745
746#define GET_INTRINSIC_GENERATOR_GLOBAL
Chandler Carruthdb25c6c2013-01-02 12:09:16 +0000747#include "llvm/IR/Intrinsics.gen"
Chris Lattnerf39c2782012-05-27 18:28:35 +0000748#undef GET_INTRINSIC_GENERATOR_GLOBAL
749
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000750void Intrinsic::getIntrinsicInfoTableEntries(ID id,
Chris Lattnerf39c2782012-05-27 18:28:35 +0000751 SmallVectorImpl<IITDescriptor> &T){
Chris Lattner7f0e7ba2012-05-16 06:34:44 +0000752 // Check to see if the intrinsic's type was expressible by the table.
753 unsigned TableVal = IIT_Table[id-1];
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000754
Chris Lattnera3b0f522012-05-17 15:55:41 +0000755 // Decode the TableVal into an array of IITValues.
756 SmallVector<unsigned char, 8> IITValues;
757 ArrayRef<unsigned char> IITEntries;
758 unsigned NextElt = 0;
759 if ((TableVal >> 31) != 0) {
760 // This is an offset into the IIT_LongEncodingTable.
761 IITEntries = IIT_LongEncodingTable;
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000762
Chris Lattnera3b0f522012-05-17 15:55:41 +0000763 // Strip sentinel bit.
764 NextElt = (TableVal << 1) >> 1;
765 } else {
Chris Lattnerf39c2782012-05-27 18:28:35 +0000766 // Decode the TableVal into an array of IITValues. If the entry was encoded
767 // into a single word in the table itself, decode it now.
Chris Lattnera57c7972012-05-17 05:13:57 +0000768 do {
769 IITValues.push_back(TableVal & 0xF);
770 TableVal >>= 4;
771 } while (TableVal);
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000772
Chris Lattnera3b0f522012-05-17 15:55:41 +0000773 IITEntries = IITValues;
774 NextElt = 0;
Chris Lattner7f0e7ba2012-05-16 06:34:44 +0000775 }
Chris Lattnerf39c2782012-05-27 18:28:35 +0000776
777 // Okay, decode the table into the output vector of IITDescriptors.
778 DecodeIITType(NextElt, IITEntries, T);
779 while (NextElt != IITEntries.size() && IITEntries[NextElt] != 0)
780 DecodeIITType(NextElt, IITEntries, T);
781}
782
783
784static Type *DecodeFixedType(ArrayRef<Intrinsic::IITDescriptor> &Infos,
785 ArrayRef<Type*> Tys, LLVMContext &Context) {
786 using namespace Intrinsic;
787 IITDescriptor D = Infos.front();
788 Infos = Infos.slice(1);
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000789
Chris Lattnerf39c2782012-05-27 18:28:35 +0000790 switch (D.Kind) {
791 case IITDescriptor::Void: return Type::getVoidTy(Context);
Andrew Tricka2efd992013-10-31 17:18:11 +0000792 case IITDescriptor::VarArg: return Type::getVoidTy(Context);
Chris Lattnerf39c2782012-05-27 18:28:35 +0000793 case IITDescriptor::MMX: return Type::getX86_MMXTy(Context);
Joseph Tremoulet917c7382015-09-02 13:36:25 +0000794 case IITDescriptor::Token: return Type::getTokenTy(Context);
Chris Lattnerf39c2782012-05-27 18:28:35 +0000795 case IITDescriptor::Metadata: return Type::getMetadataTy(Context);
Michael Ilseman6c6d7152013-01-11 01:45:05 +0000796 case IITDescriptor::Half: return Type::getHalfTy(Context);
Chris Lattnerf39c2782012-05-27 18:28:35 +0000797 case IITDescriptor::Float: return Type::getFloatTy(Context);
798 case IITDescriptor::Double: return Type::getDoubleTy(Context);
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000799
Chris Lattnerf39c2782012-05-27 18:28:35 +0000800 case IITDescriptor::Integer:
801 return IntegerType::get(Context, D.Integer_Width);
802 case IITDescriptor::Vector:
803 return VectorType::get(DecodeFixedType(Infos, Tys, Context),D.Vector_Width);
804 case IITDescriptor::Pointer:
805 return PointerType::get(DecodeFixedType(Infos, Tys, Context),
806 D.Pointer_AddressSpace);
807 case IITDescriptor::Struct: {
808 Type *Elts[5];
809 assert(D.Struct_NumElements <= 5 && "Can't handle this yet");
810 for (unsigned i = 0, e = D.Struct_NumElements; i != e; ++i)
811 Elts[i] = DecodeFixedType(Infos, Tys, Context);
Craig Toppere1d12942014-08-27 05:25:25 +0000812 return StructType::get(Context, makeArrayRef(Elts,D.Struct_NumElements));
Chris Lattnerf39c2782012-05-27 18:28:35 +0000813 }
Chris Lattnerf39c2782012-05-27 18:28:35 +0000814 case IITDescriptor::Argument:
815 return Tys[D.getArgumentNumber()];
Tim Northoveraa3cf1e2014-03-28 12:31:39 +0000816 case IITDescriptor::ExtendArgument: {
817 Type *Ty = Tys[D.getArgumentNumber()];
818 if (VectorType *VTy = dyn_cast<VectorType>(Ty))
819 return VectorType::getExtendedElementVectorType(VTy);
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000820
Tim Northoveraa3cf1e2014-03-28 12:31:39 +0000821 return IntegerType::get(Context, 2 * cast<IntegerType>(Ty)->getBitWidth());
822 }
823 case IITDescriptor::TruncArgument: {
824 Type *Ty = Tys[D.getArgumentNumber()];
825 if (VectorType *VTy = dyn_cast<VectorType>(Ty))
826 return VectorType::getTruncatedElementVectorType(VTy);
827
828 IntegerType *ITy = cast<IntegerType>(Ty);
829 assert(ITy->getBitWidth() % 2 == 0);
830 return IntegerType::get(Context, ITy->getBitWidth() / 2);
831 }
Tim Northover4516de32014-03-29 07:04:54 +0000832 case IITDescriptor::HalfVecArgument:
833 return VectorType::getHalfElementsVectorType(cast<VectorType>(
834 Tys[D.getArgumentNumber()]));
Elena Demikhovskyfb81b932014-12-25 07:49:20 +0000835 case IITDescriptor::SameVecWidthArgument: {
Elena Demikhovskyf1de34b2014-12-04 09:40:44 +0000836 Type *EltTy = DecodeFixedType(Infos, Tys, Context);
837 Type *Ty = Tys[D.getArgumentNumber()];
838 if (VectorType *VTy = dyn_cast<VectorType>(Ty)) {
839 return VectorType::get(EltTy, VTy->getNumElements());
840 }
841 llvm_unreachable("unhandled");
Elena Demikhovskyfb81b932014-12-25 07:49:20 +0000842 }
843 case IITDescriptor::PtrToArgument: {
844 Type *Ty = Tys[D.getArgumentNumber()];
845 return PointerType::getUnqual(Ty);
846 }
Elena Demikhovskycaaceef2016-11-03 03:23:55 +0000847 case IITDescriptor::PtrToElt: {
848 Type *Ty = Tys[D.getArgumentNumber()];
849 VectorType *VTy = dyn_cast<VectorType>(Ty);
850 if (!VTy)
851 llvm_unreachable("Expected an argument of Vector Type");
852 Type *EltTy = VTy->getVectorElementType();
853 return PointerType::getUnqual(EltTy);
854 }
Elad Cohenef5798a2017-05-03 12:28:54 +0000855 case IITDescriptor::VecOfAnyPtrsToElt:
856 // Return the overloaded type (which determines the pointers address space)
857 return Tys[D.getOverloadArgNumber()];
Elena Demikhovskyf1de34b2014-12-04 09:40:44 +0000858 }
Chris Lattnerf39c2782012-05-27 18:28:35 +0000859 llvm_unreachable("unhandled");
860}
861
862
863
864FunctionType *Intrinsic::getType(LLVMContext &Context,
865 ID id, ArrayRef<Type*> Tys) {
866 SmallVector<IITDescriptor, 8> Table;
867 getIntrinsicInfoTableEntries(id, Table);
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000868
Chris Lattnerf39c2782012-05-27 18:28:35 +0000869 ArrayRef<IITDescriptor> TableRef = Table;
870 Type *ResultTy = DecodeFixedType(TableRef, Tys, Context);
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000871
Chris Lattnera3b0f522012-05-17 15:55:41 +0000872 SmallVector<Type*, 8> ArgTys;
Chris Lattnerf39c2782012-05-27 18:28:35 +0000873 while (!TableRef.empty())
874 ArgTys.push_back(DecodeFixedType(TableRef, Tys, Context));
Jim Laskey2682ea62007-02-07 20:38:26 +0000875
Steven Wud05affc2014-10-20 15:47:24 +0000876 // DecodeFixedType returns Void for IITDescriptor::Void and IITDescriptor::VarArg
877 // If we see void type as the type of the last argument, it is vararg intrinsic
878 if (!ArgTys.empty() && ArgTys.back()->isVoidTy()) {
879 ArgTys.pop_back();
880 return FunctionType::get(ResultTy, ArgTys, true);
881 }
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000882 return FunctionType::get(ResultTy, ArgTys, false);
Jim Laskey2682ea62007-02-07 20:38:26 +0000883}
884
Mon P Wangb4024932009-02-24 23:17:49 +0000885bool Intrinsic::isOverloaded(ID id) {
Mon P Wangb4024932009-02-24 23:17:49 +0000886#define GET_INTRINSIC_OVERLOAD_TABLE
Chandler Carruthdb25c6c2013-01-02 12:09:16 +0000887#include "llvm/IR/Intrinsics.gen"
Mon P Wangb4024932009-02-24 23:17:49 +0000888#undef GET_INTRINSIC_OVERLOAD_TABLE
Mon P Wangb4024932009-02-24 23:17:49 +0000889}
890
Sanjoy Dasc65d43e2015-06-18 19:28:26 +0000891bool Intrinsic::isLeaf(ID id) {
892 switch (id) {
893 default:
894 return true;
895
896 case Intrinsic::experimental_gc_statepoint:
897 case Intrinsic::experimental_patchpoint_void:
898 case Intrinsic::experimental_patchpoint_i64:
899 return false;
900 }
901}
902
Chris Lattner49b7ee12009-01-12 01:18:58 +0000903/// This defines the "Intrinsic::getAttributes(ID id)" method.
Duncan Sands38ef3a82007-12-03 20:06:50 +0000904#define GET_INTRINSIC_ATTRIBUTES
Chandler Carruthdb25c6c2013-01-02 12:09:16 +0000905#include "llvm/IR/Intrinsics.gen"
Duncan Sands38ef3a82007-12-03 20:06:50 +0000906#undef GET_INTRINSIC_ATTRIBUTES
907
Benjamin Kramere6e19332011-07-14 17:45:39 +0000908Function *Intrinsic::getDeclaration(Module *M, ID id, ArrayRef<Type*> Tys) {
Duncan Sands38ef3a82007-12-03 20:06:50 +0000909 // There can never be multiple globals with the same name of different types,
910 // because intrinsics must be a specific type.
Duncan Sandsa8ff6ca2008-04-07 13:39:11 +0000911 return
Benjamin Kramere6e19332011-07-14 17:45:39 +0000912 cast<Function>(M->getOrInsertFunction(getName(id, Tys),
913 getType(M->getContext(), id, Tys)));
Jim Laskey2682ea62007-02-07 20:38:26 +0000914}
915
Dale Johannesenb842d522009-02-05 01:49:45 +0000916// This defines the "Intrinsic::getIntrinsicForGCCBuiltin()" method.
917#define GET_LLVM_INTRINSIC_FOR_GCC_BUILTIN
Chandler Carruthdb25c6c2013-01-02 12:09:16 +0000918#include "llvm/IR/Intrinsics.gen"
Dale Johannesenb842d522009-02-05 01:49:45 +0000919#undef GET_LLVM_INTRINSIC_FOR_GCC_BUILTIN
920
Saleem Abdulrasool4e63fc42014-07-04 18:42:25 +0000921// This defines the "Intrinsic::getIntrinsicForMSBuiltin()" method.
922#define GET_LLVM_INTRINSIC_FOR_MS_BUILTIN
923#include "llvm/IR/Intrinsics.gen"
924#undef GET_LLVM_INTRINSIC_FOR_MS_BUILTIN
925
Artur Pilipenkobc552272016-06-22 14:56:33 +0000926bool Intrinsic::matchIntrinsicType(Type *Ty, ArrayRef<Intrinsic::IITDescriptor> &Infos,
927 SmallVectorImpl<Type*> &ArgTys) {
928 using namespace Intrinsic;
929
930 // If we ran out of descriptors, there are too many arguments.
931 if (Infos.empty()) return true;
932 IITDescriptor D = Infos.front();
933 Infos = Infos.slice(1);
934
935 switch (D.Kind) {
936 case IITDescriptor::Void: return !Ty->isVoidTy();
937 case IITDescriptor::VarArg: return true;
938 case IITDescriptor::MMX: return !Ty->isX86_MMXTy();
939 case IITDescriptor::Token: return !Ty->isTokenTy();
940 case IITDescriptor::Metadata: return !Ty->isMetadataTy();
941 case IITDescriptor::Half: return !Ty->isHalfTy();
942 case IITDescriptor::Float: return !Ty->isFloatTy();
943 case IITDescriptor::Double: return !Ty->isDoubleTy();
944 case IITDescriptor::Integer: return !Ty->isIntegerTy(D.Integer_Width);
945 case IITDescriptor::Vector: {
946 VectorType *VT = dyn_cast<VectorType>(Ty);
947 return !VT || VT->getNumElements() != D.Vector_Width ||
948 matchIntrinsicType(VT->getElementType(), Infos, ArgTys);
949 }
950 case IITDescriptor::Pointer: {
951 PointerType *PT = dyn_cast<PointerType>(Ty);
952 return !PT || PT->getAddressSpace() != D.Pointer_AddressSpace ||
953 matchIntrinsicType(PT->getElementType(), Infos, ArgTys);
954 }
955
956 case IITDescriptor::Struct: {
957 StructType *ST = dyn_cast<StructType>(Ty);
958 if (!ST || ST->getNumElements() != D.Struct_NumElements)
959 return true;
960
961 for (unsigned i = 0, e = D.Struct_NumElements; i != e; ++i)
962 if (matchIntrinsicType(ST->getElementType(i), Infos, ArgTys))
963 return true;
964 return false;
965 }
966
967 case IITDescriptor::Argument:
968 // Two cases here - If this is the second occurrence of an argument, verify
969 // that the later instance matches the previous instance.
970 if (D.getArgumentNumber() < ArgTys.size())
971 return Ty != ArgTys[D.getArgumentNumber()];
972
973 // Otherwise, if this is the first instance of an argument, record it and
974 // verify the "Any" kind.
975 assert(D.getArgumentNumber() == ArgTys.size() && "Table consistency error");
976 ArgTys.push_back(Ty);
977
978 switch (D.getArgumentKind()) {
979 case IITDescriptor::AK_Any: return false; // Success
980 case IITDescriptor::AK_AnyInteger: return !Ty->isIntOrIntVectorTy();
981 case IITDescriptor::AK_AnyFloat: return !Ty->isFPOrFPVectorTy();
982 case IITDescriptor::AK_AnyVector: return !isa<VectorType>(Ty);
983 case IITDescriptor::AK_AnyPointer: return !isa<PointerType>(Ty);
984 }
985 llvm_unreachable("all argument kinds not covered");
986
987 case IITDescriptor::ExtendArgument: {
988 // This may only be used when referring to a previous vector argument.
989 if (D.getArgumentNumber() >= ArgTys.size())
990 return true;
991
992 Type *NewTy = ArgTys[D.getArgumentNumber()];
993 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
994 NewTy = VectorType::getExtendedElementVectorType(VTy);
995 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
996 NewTy = IntegerType::get(ITy->getContext(), 2 * ITy->getBitWidth());
997 else
998 return true;
999
1000 return Ty != NewTy;
1001 }
1002 case IITDescriptor::TruncArgument: {
1003 // This may only be used when referring to a previous vector argument.
1004 if (D.getArgumentNumber() >= ArgTys.size())
1005 return true;
1006
1007 Type *NewTy = ArgTys[D.getArgumentNumber()];
1008 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
1009 NewTy = VectorType::getTruncatedElementVectorType(VTy);
1010 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
1011 NewTy = IntegerType::get(ITy->getContext(), ITy->getBitWidth() / 2);
1012 else
1013 return true;
1014
1015 return Ty != NewTy;
1016 }
1017 case IITDescriptor::HalfVecArgument:
1018 // This may only be used when referring to a previous vector argument.
1019 return D.getArgumentNumber() >= ArgTys.size() ||
1020 !isa<VectorType>(ArgTys[D.getArgumentNumber()]) ||
1021 VectorType::getHalfElementsVectorType(
1022 cast<VectorType>(ArgTys[D.getArgumentNumber()])) != Ty;
1023 case IITDescriptor::SameVecWidthArgument: {
1024 if (D.getArgumentNumber() >= ArgTys.size())
1025 return true;
1026 VectorType * ReferenceType =
Elena Demikhovskycaaceef2016-11-03 03:23:55 +00001027 dyn_cast<VectorType>(ArgTys[D.getArgumentNumber()]);
Artur Pilipenkobc552272016-06-22 14:56:33 +00001028 VectorType *ThisArgType = dyn_cast<VectorType>(Ty);
1029 if (!ThisArgType || !ReferenceType ||
1030 (ReferenceType->getVectorNumElements() !=
1031 ThisArgType->getVectorNumElements()))
1032 return true;
1033 return matchIntrinsicType(ThisArgType->getVectorElementType(),
1034 Infos, ArgTys);
1035 }
1036 case IITDescriptor::PtrToArgument: {
1037 if (D.getArgumentNumber() >= ArgTys.size())
1038 return true;
1039 Type * ReferenceType = ArgTys[D.getArgumentNumber()];
1040 PointerType *ThisArgType = dyn_cast<PointerType>(Ty);
1041 return (!ThisArgType || ThisArgType->getElementType() != ReferenceType);
1042 }
Elena Demikhovskycaaceef2016-11-03 03:23:55 +00001043 case IITDescriptor::PtrToElt: {
1044 if (D.getArgumentNumber() >= ArgTys.size())
1045 return true;
1046 VectorType * ReferenceType =
1047 dyn_cast<VectorType> (ArgTys[D.getArgumentNumber()]);
1048 PointerType *ThisArgType = dyn_cast<PointerType>(Ty);
1049
1050 return (!ThisArgType || !ReferenceType ||
1051 ThisArgType->getElementType() != ReferenceType->getElementType());
1052 }
Elad Cohenef5798a2017-05-03 12:28:54 +00001053 case IITDescriptor::VecOfAnyPtrsToElt: {
1054 unsigned RefArgNumber = D.getRefArgNumber();
1055
1056 // This may only be used when referring to a previous argument.
1057 if (RefArgNumber >= ArgTys.size())
Artur Pilipenkobc552272016-06-22 14:56:33 +00001058 return true;
Elad Cohenef5798a2017-05-03 12:28:54 +00001059
1060 // Record the overloaded type
1061 assert(D.getOverloadArgNumber() == ArgTys.size() &&
1062 "Table consistency error");
1063 ArgTys.push_back(Ty);
1064
1065 // Verify the overloaded type "matches" the Ref type.
1066 // i.e. Ty is a vector with the same width as Ref.
1067 // Composed of pointers to the same element type as Ref.
1068 VectorType *ReferenceType = dyn_cast<VectorType>(ArgTys[RefArgNumber]);
Artur Pilipenkobc552272016-06-22 14:56:33 +00001069 VectorType *ThisArgVecTy = dyn_cast<VectorType>(Ty);
1070 if (!ThisArgVecTy || !ReferenceType ||
1071 (ReferenceType->getVectorNumElements() !=
1072 ThisArgVecTy->getVectorNumElements()))
1073 return true;
1074 PointerType *ThisArgEltTy =
1075 dyn_cast<PointerType>(ThisArgVecTy->getVectorElementType());
1076 if (!ThisArgEltTy)
1077 return true;
1078 return ThisArgEltTy->getElementType() !=
1079 ReferenceType->getVectorElementType();
1080 }
1081 }
1082 llvm_unreachable("unhandled");
1083}
1084
Artur Pilipenkob68b8212016-06-24 14:47:27 +00001085bool
1086Intrinsic::matchIntrinsicVarArg(bool isVarArg,
1087 ArrayRef<Intrinsic::IITDescriptor> &Infos) {
1088 // If there are no descriptors left, then it can't be a vararg.
1089 if (Infos.empty())
1090 return isVarArg;
1091
1092 // There should be only one descriptor remaining at this point.
1093 if (Infos.size() != 1)
1094 return true;
1095
1096 // Check and verify the descriptor.
1097 IITDescriptor D = Infos.front();
1098 Infos = Infos.slice(1);
1099 if (D.Kind == IITDescriptor::VarArg)
1100 return !isVarArg;
1101
1102 return true;
1103}
1104
Artur Pilipenko6c7a8ab2016-06-24 15:10:29 +00001105Optional<Function*> Intrinsic::remangleIntrinsicFunction(Function *F) {
1106 Intrinsic::ID ID = F->getIntrinsicID();
1107 if (!ID)
1108 return None;
1109
1110 FunctionType *FTy = F->getFunctionType();
1111 // Accumulate an array of overloaded types for the given intrinsic
1112 SmallVector<Type *, 4> ArgTys;
1113 {
1114 SmallVector<Intrinsic::IITDescriptor, 8> Table;
1115 getIntrinsicInfoTableEntries(ID, Table);
1116 ArrayRef<Intrinsic::IITDescriptor> TableRef = Table;
1117
1118 // If we encounter any problems matching the signature with the descriptor
1119 // just give up remangling. It's up to verifier to report the discrepancy.
1120 if (Intrinsic::matchIntrinsicType(FTy->getReturnType(), TableRef, ArgTys))
1121 return None;
1122 for (auto Ty : FTy->params())
1123 if (Intrinsic::matchIntrinsicType(Ty, TableRef, ArgTys))
1124 return None;
1125 if (Intrinsic::matchIntrinsicVarArg(FTy->isVarArg(), TableRef))
1126 return None;
1127 }
1128
1129 StringRef Name = F->getName();
1130 if (Name == Intrinsic::getName(ID, ArgTys))
1131 return None;
1132
1133 auto NewDecl = Intrinsic::getDeclaration(F->getParent(), ID, ArgTys);
1134 NewDecl->setCallingConv(F->getCallingConv());
1135 assert(NewDecl->getFunctionType() == FTy && "Shouldn't change the signature");
1136 return NewDecl;
1137}
1138
Gabor Greif161cb042010-03-23 14:40:20 +00001139/// hasAddressTaken - returns true if there are any uses of this function
1140/// other than direct calls or invokes to it.
Gabor Greifa2fbc0a2010-03-24 13:21:49 +00001141bool Function::hasAddressTaken(const User* *PutOffender) const {
Chandler Carruthcdf47882014-03-09 03:16:01 +00001142 for (const Use &U : uses()) {
1143 const User *FU = U.getUser();
1144 if (isa<BlockAddress>(FU))
Jay Foadca0c4992012-05-12 08:30:16 +00001145 continue;
Richard Trieu7a083812016-02-18 22:09:30 +00001146 if (!isa<CallInst>(FU) && !isa<InvokeInst>(FU)) {
1147 if (PutOffender)
1148 *PutOffender = FU;
1149 return true;
1150 }
Chandler Carruthcdf47882014-03-09 03:16:01 +00001151 ImmutableCallSite CS(cast<Instruction>(FU));
Richard Trieu7a083812016-02-18 22:09:30 +00001152 if (!CS.isCallee(&U)) {
1153 if (PutOffender)
1154 *PutOffender = FU;
1155 return true;
1156 }
Jay Foad557169d2009-06-10 08:41:11 +00001157 }
1158 return false;
1159}
1160
Eli Friedman1923a332011-10-20 05:23:42 +00001161bool Function::isDefTriviallyDead() const {
1162 // Check the linkage
1163 if (!hasLinkOnceLinkage() && !hasLocalLinkage() &&
1164 !hasAvailableExternallyLinkage())
1165 return false;
1166
1167 // Check if the function is used by anything other than a blockaddress.
Chandler Carruthcdf47882014-03-09 03:16:01 +00001168 for (const User *U : users())
1169 if (!isa<BlockAddress>(U))
Eli Friedman1923a332011-10-20 05:23:42 +00001170 return false;
1171
1172 return true;
1173}
1174
Bill Wendling63a4ea12011-10-17 18:43:40 +00001175/// callsFunctionThatReturnsTwice - Return true if the function has a call to
1176/// setjmp or other function that gcc recognizes as "returning twice".
1177bool Function::callsFunctionThatReturnsTwice() const {
1178 for (const_inst_iterator
1179 I = inst_begin(this), E = inst_end(this); I != E; ++I) {
Mark Seaborn82711182014-01-14 04:20:01 +00001180 ImmutableCallSite CS(&*I);
1181 if (CS && CS.hasFnAttr(Attribute::ReturnsTwice))
Bill Wendling63a4ea12011-10-17 18:43:40 +00001182 return true;
1183 }
1184
1185 return false;
1186}
Peter Collingbourne3fa50f92013-09-16 01:08:15 +00001187
Vedant Kumar3a63fb32015-12-19 08:52:49 +00001188Constant *Function::getPersonalityFn() const {
1189 assert(hasPersonalityFn() && getNumOperands());
1190 return cast<Constant>(Op<0>());
Vedant Kumar1ab5ea52015-10-06 20:31:57 +00001191}
1192
Vedant Kumar3a63fb32015-12-19 08:52:49 +00001193void Function::setPersonalityFn(Constant *Fn) {
Keno Fischer9bc46b12015-12-23 18:27:23 +00001194 setHungoffOperand<0>(Fn);
Vedant Kumar3a63fb32015-12-19 08:52:49 +00001195 setValueSubclassDataBit(3, Fn != nullptr);
Vedant Kumar1ab5ea52015-10-06 20:31:57 +00001196}
1197
Peter Collingbourne3fa50f92013-09-16 01:08:15 +00001198Constant *Function::getPrefixData() const {
Vedant Kumar3a63fb32015-12-19 08:52:49 +00001199 assert(hasPrefixData() && getNumOperands());
1200 return cast<Constant>(Op<1>());
Peter Collingbourne3fa50f92013-09-16 01:08:15 +00001201}
1202
1203void Function::setPrefixData(Constant *PrefixData) {
Keno Fischer9bc46b12015-12-23 18:27:23 +00001204 setHungoffOperand<1>(PrefixData);
Vedant Kumar3a63fb32015-12-19 08:52:49 +00001205 setValueSubclassDataBit(1, PrefixData != nullptr);
Peter Collingbourne3fa50f92013-09-16 01:08:15 +00001206}
Peter Collingbourne51d2de72014-12-03 02:08:38 +00001207
1208Constant *Function::getPrologueData() const {
Vedant Kumar3a63fb32015-12-19 08:52:49 +00001209 assert(hasPrologueData() && getNumOperands());
1210 return cast<Constant>(Op<2>());
Peter Collingbourne51d2de72014-12-03 02:08:38 +00001211}
1212
1213void Function::setPrologueData(Constant *PrologueData) {
Keno Fischer9bc46b12015-12-23 18:27:23 +00001214 setHungoffOperand<2>(PrologueData);
Vedant Kumar3a63fb32015-12-19 08:52:49 +00001215 setValueSubclassDataBit(2, PrologueData != nullptr);
1216}
1217
1218void Function::allocHungoffUselist() {
1219 // If we've already allocated a uselist, stop here.
1220 if (getNumOperands())
Peter Collingbourne51d2de72014-12-03 02:08:38 +00001221 return;
1222
Vedant Kumar3a63fb32015-12-19 08:52:49 +00001223 allocHungoffUses(3, /*IsPhi=*/ false);
1224 setNumHungOffUseOperands(3);
1225
1226 // Initialize the uselist with placeholder operands to allow traversal.
1227 auto *CPN = ConstantPointerNull::get(Type::getInt1PtrTy(getContext(), 0));
1228 Op<0>().set(CPN);
1229 Op<1>().set(CPN);
1230 Op<2>().set(CPN);
1231}
1232
1233template <int Idx>
1234void Function::setHungoffOperand(Constant *C) {
Keno Fischer9bc46b12015-12-23 18:27:23 +00001235 if (C) {
1236 allocHungoffUselist();
1237 Op<Idx>().set(C);
1238 } else if (getNumOperands()) {
1239 Op<Idx>().set(
1240 ConstantPointerNull::get(Type::getInt1PtrTy(getContext(), 0)));
1241 }
Vedant Kumar3a63fb32015-12-19 08:52:49 +00001242}
1243
1244void Function::setValueSubclassDataBit(unsigned Bit, bool On) {
1245 assert(Bit < 16 && "SubclassData contains only 16 bits");
1246 if (On)
1247 setValueSubclassData(getSubclassDataFromValue() | (1 << Bit));
1248 else
1249 setValueSubclassData(getSubclassDataFromValue() & ~(1 << Bit));
Peter Collingbourne51d2de72014-12-03 02:08:38 +00001250}
Akira Hatanaka3058d0f2015-05-06 23:54:14 +00001251
Dehao Chena60cdd32017-02-28 18:09:44 +00001252void Function::setEntryCount(uint64_t Count,
1253 const DenseSet<GlobalValue::GUID> *S) {
Diego Novillo2567f3d2015-05-13 15:13:45 +00001254 MDBuilder MDB(getContext());
Dehao Chena60cdd32017-02-28 18:09:44 +00001255 setMetadata(LLVMContext::MD_prof, MDB.createFunctionEntryCount(Count, S));
Diego Novillo2567f3d2015-05-13 15:13:45 +00001256}
1257
1258Optional<uint64_t> Function::getEntryCount() const {
1259 MDNode *MD = getMetadata(LLVMContext::MD_prof);
1260 if (MD && MD->getOperand(0))
1261 if (MDString *MDS = dyn_cast<MDString>(MD->getOperand(0)))
1262 if (MDS->getString().equals("function_entry_count")) {
1263 ConstantInt *CI = mdconst::extract<ConstantInt>(MD->getOperand(1));
David Callahanc1c810d2016-08-05 18:38:19 +00001264 uint64_t Count = CI->getValue().getZExtValue();
1265 if (Count == 0)
1266 return None;
1267 return Count;
Diego Novillo2567f3d2015-05-13 15:13:45 +00001268 }
1269 return None;
1270}
Dehao Chen302b69c2016-10-18 20:42:47 +00001271
Dehao Chena60cdd32017-02-28 18:09:44 +00001272DenseSet<GlobalValue::GUID> Function::getImportGUIDs() const {
1273 DenseSet<GlobalValue::GUID> R;
1274 if (MDNode *MD = getMetadata(LLVMContext::MD_prof))
1275 if (MDString *MDS = dyn_cast<MDString>(MD->getOperand(0)))
1276 if (MDS->getString().equals("function_entry_count"))
1277 for (unsigned i = 2; i < MD->getNumOperands(); i++)
1278 R.insert(mdconst::extract<ConstantInt>(MD->getOperand(i))
1279 ->getValue()
1280 .getZExtValue());
1281 return R;
1282}
1283
Dehao Chen302b69c2016-10-18 20:42:47 +00001284void Function::setSectionPrefix(StringRef Prefix) {
1285 MDBuilder MDB(getContext());
1286 setMetadata(LLVMContext::MD_section_prefix,
1287 MDB.createFunctionSectionPrefix(Prefix));
1288}
1289
1290Optional<StringRef> Function::getSectionPrefix() const {
1291 if (MDNode *MD = getMetadata(LLVMContext::MD_section_prefix)) {
1292 assert(dyn_cast<MDString>(MD->getOperand(0))
1293 ->getString()
1294 .equals("function_section_prefix") &&
1295 "Metadata not match");
1296 return dyn_cast<MDString>(MD->getOperand(1))->getString();
1297 }
1298 return None;
1299}