blob: 39de4b0a97fad1ca3d92f65e545dc148827dcc82 [file] [log] [blame]
Eugene Zelenkoeba7e4e2017-05-10 23:41:30 +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
Michael Ilseman516d7032013-03-01 18:48:54 +000014#include "LLVMContextImpl.h"
Chris Lattner113f4f42002-06-25 16:13:24 +000015#include "SymbolTableListTraitsImpl.h"
Eugene Zelenkoeba7e4e2017-05-10 23:41:30 +000016#include "llvm/ADT/ArrayRef.h"
17#include "llvm/ADT/DenseSet.h"
18#include "llvm/ADT/None.h"
19#include "llvm/ADT/SmallString.h"
20#include "llvm/ADT/SmallVector.h"
Rafael Espindola2050af82011-05-16 03:05:33 +000021#include "llvm/ADT/STLExtras.h"
Chris Lattnerb392d302004-12-05 06:43:27 +000022#include "llvm/ADT/StringExtras.h"
Eugene Zelenkoeba7e4e2017-05-10 23:41:30 +000023#include "llvm/ADT/StringRef.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000024#include "llvm/CodeGen/ValueTypes.h"
Eugene Zelenkoeba7e4e2017-05-10 23:41:30 +000025#include "llvm/IR/Argument.h"
26#include "llvm/IR/Attributes.h"
27#include "llvm/IR/BasicBlock.h"
Chandler Carruth219b89b2014-03-04 11:01:28 +000028#include "llvm/IR/CallSite.h"
Eugene Zelenkoeba7e4e2017-05-10 23:41:30 +000029#include "llvm/IR/Constant.h"
Diego Novillo2567f3d2015-05-13 15:13:45 +000030#include "llvm/IR/Constants.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000031#include "llvm/IR/DerivedTypes.h"
Eugene Zelenkoeba7e4e2017-05-10 23:41:30 +000032#include "llvm/IR/Function.h"
33#include "llvm/IR/GlobalValue.h"
Chandler Carruth83948572014-03-04 10:30:26 +000034#include "llvm/IR/InstIterator.h"
Eugene Zelenkoeba7e4e2017-05-10 23:41:30 +000035#include "llvm/IR/Instruction.h"
36#include "llvm/IR/Instructions.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000037#include "llvm/IR/IntrinsicInst.h"
Eugene Zelenkoeba7e4e2017-05-10 23:41:30 +000038#include "llvm/IR/Intrinsics.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000039#include "llvm/IR/LLVMContext.h"
Diego Novillo2567f3d2015-05-13 15:13:45 +000040#include "llvm/IR/MDBuilder.h"
41#include "llvm/IR/Metadata.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000042#include "llvm/IR/Module.h"
Eugene Zelenkoeba7e4e2017-05-10 23:41:30 +000043#include "llvm/IR/SymbolTableListTraits.h"
44#include "llvm/IR/Type.h"
45#include "llvm/IR/Use.h"
46#include "llvm/IR/User.h"
47#include "llvm/IR/Value.h"
48#include "llvm/IR/ValueSymbolTable.h"
49#include "llvm/Support/Casting.h"
50#include "llvm/Support/Compiler.h"
51#include "llvm/Support/ErrorHandling.h"
52#include <algorithm>
53#include <cassert>
54#include <cstddef>
55#include <cstdint>
56#include <cstring>
57#include <string>
58
Chris Lattner189d19f2003-11-21 20:23:48 +000059using namespace llvm;
Brian Gaeke960707c2003-11-11 22:41:34 +000060
Chris Lattner113f4f42002-06-25 16:13:24 +000061// Explicit instantiations of SymbolTableListTraits since some of the methods
62// are not in the public header file...
Duncan P. N. Exon Smith37bf6782015-10-07 20:05:10 +000063template class llvm::SymbolTableListTraits<BasicBlock>;
Chris Lattner2f7c9632001-06-06 20:29:01 +000064
Chris Lattnerda975502001-09-10 07:58:01 +000065//===----------------------------------------------------------------------===//
Chris Lattnerd255ae22002-04-09 19:39:35 +000066// Argument Implementation
67//===----------------------------------------------------------------------===//
68
Reid Kleckner56d028d2017-03-17 17:16:39 +000069Argument::Argument(Type *Ty, const Twine &Name, Function *Par, unsigned ArgNo)
70 : Value(Ty, Value::ArgumentVal), Parent(Par), ArgNo(ArgNo) {
Chris Lattner32ab6432007-02-12 05:18:08 +000071 setName(Name);
Chris Lattner9ed7aef2002-09-06 21:33:15 +000072}
73
Chris Lattner9ed7aef2002-09-06 21:33:15 +000074void Argument::setParent(Function *parent) {
75 Parent = parent;
76}
77
Nick Lewyckyd52b1522014-05-20 01:23:40 +000078bool Argument::hasNonNullAttr() const {
79 if (!getType()->isPointerTy()) return false;
Reid Klecknerf021fab2017-04-13 23:12:13 +000080 if (getParent()->hasParamAttribute(getArgNo(), Attribute::NonNull))
Hal Finkelb0407ba2014-07-18 15:51:28 +000081 return true;
82 else if (getDereferenceableBytes() > 0 &&
83 getType()->getPointerAddressSpace() == 0)
84 return true;
85 return false;
Nick Lewyckyd52b1522014-05-20 01:23:40 +000086}
87
Chris Lattnere30f09d2008-01-24 17:47:11 +000088bool Argument::hasByValAttr() const {
Duncan Sands19d0b472010-02-16 11:11:14 +000089 if (!getType()->isPointerTy()) return false;
Amaury Sechet7b05a4c2016-03-14 01:37:29 +000090 return hasAttribute(Attribute::ByVal);
Chris Lattnere30f09d2008-01-24 17:47:11 +000091}
92
Manman Renf46262e2016-03-29 17:37:21 +000093bool Argument::hasSwiftSelfAttr() const {
Reid Klecknerf021fab2017-04-13 23:12:13 +000094 return getParent()->hasParamAttribute(getArgNo(), Attribute::SwiftSelf);
Manman Renf46262e2016-03-29 17:37:21 +000095}
96
Manman Ren9bfd0d02016-04-01 21:41:15 +000097bool Argument::hasSwiftErrorAttr() const {
Reid Klecknerf021fab2017-04-13 23:12:13 +000098 return getParent()->hasParamAttribute(getArgNo(), Attribute::SwiftError);
Manman Ren9bfd0d02016-04-01 21:41:15 +000099}
100
Reid Klecknera534a382013-12-19 02:14:12 +0000101bool Argument::hasInAllocaAttr() const {
102 if (!getType()->isPointerTy()) return false;
Amaury Sechet7b05a4c2016-03-14 01:37:29 +0000103 return hasAttribute(Attribute::InAlloca);
Reid Klecknera534a382013-12-19 02:14:12 +0000104}
105
Reid Kleckner436c42e2014-01-17 23:58:17 +0000106bool Argument::hasByValOrInAllocaAttr() const {
107 if (!getType()->isPointerTy()) return false;
Reid Klecknerb5180542017-03-21 16:57:19 +0000108 AttributeList Attrs = getParent()->getAttributes();
Reid Klecknerf021fab2017-04-13 23:12:13 +0000109 return Attrs.hasParamAttribute(getArgNo(), Attribute::ByVal) ||
110 Attrs.hasParamAttribute(getArgNo(), Attribute::InAlloca);
Reid Kleckner436c42e2014-01-17 23:58:17 +0000111}
112
Chris Lattner4d37d992011-05-22 23:57:23 +0000113unsigned Argument::getParamAlignment() const {
114 assert(getType()->isPointerTy() && "Only pointers have alignments");
Reid Kleckner859f8b52017-04-28 20:34:27 +0000115 return getParent()->getParamAlignment(getArgNo());
Chris Lattner4d37d992011-05-22 23:57:23 +0000116}
117
Hal Finkelb0407ba2014-07-18 15:51:28 +0000118uint64_t Argument::getDereferenceableBytes() const {
119 assert(getType()->isPointerTy() &&
120 "Only pointers have dereferenceable bytes");
Reid Klecknera0b45f42017-05-03 18:17:31 +0000121 return getParent()->getDereferenceableBytes(getArgNo() +
122 AttributeList::FirstArgIndex);
Hal Finkelb0407ba2014-07-18 15:51:28 +0000123}
124
Sanjoy Das06cf33f2015-05-06 17:41:54 +0000125uint64_t Argument::getDereferenceableOrNullBytes() const {
126 assert(getType()->isPointerTy() &&
127 "Only pointers have dereferenceable bytes");
Reid Klecknera0b45f42017-05-03 18:17:31 +0000128 return getParent()->getDereferenceableOrNullBytes(
129 getArgNo() + AttributeList::FirstArgIndex);
Sanjoy Das06cf33f2015-05-06 17:41:54 +0000130}
131
Duncan Sands5d96f3f2009-12-11 08:36:17 +0000132bool Argument::hasNestAttr() const {
Duncan Sands19d0b472010-02-16 11:11:14 +0000133 if (!getType()->isPointerTy()) return false;
Amaury Sechet7b05a4c2016-03-14 01:37:29 +0000134 return hasAttribute(Attribute::Nest);
Duncan Sands5d96f3f2009-12-11 08:36:17 +0000135}
136
Chris Lattnere30f09d2008-01-24 17:47:11 +0000137bool Argument::hasNoAliasAttr() const {
Duncan Sands19d0b472010-02-16 11:11:14 +0000138 if (!getType()->isPointerTy()) return false;
Amaury Sechet7b05a4c2016-03-14 01:37:29 +0000139 return hasAttribute(Attribute::NoAlias);
Chris Lattnere30f09d2008-01-24 17:47:11 +0000140}
141
Duncan Sandsdf128eb2008-12-31 18:08:59 +0000142bool Argument::hasNoCaptureAttr() const {
Duncan Sands19d0b472010-02-16 11:11:14 +0000143 if (!getType()->isPointerTy()) return false;
Amaury Sechet7b05a4c2016-03-14 01:37:29 +0000144 return hasAttribute(Attribute::NoCapture);
Duncan Sandsdf128eb2008-12-31 18:08:59 +0000145}
146
Owen Andersonc64dfb42008-02-17 23:22:28 +0000147bool Argument::hasStructRetAttr() const {
Duncan Sands19d0b472010-02-16 11:11:14 +0000148 if (!getType()->isPointerTy()) return false;
Amaury Sechet7b05a4c2016-03-14 01:37:29 +0000149 return hasAttribute(Attribute::StructRet);
Owen Andersonc64dfb42008-02-17 23:22:28 +0000150}
151
Stephen Linb8bd2322013-04-20 05:14:40 +0000152bool Argument::hasReturnedAttr() const {
Amaury Sechet7b05a4c2016-03-14 01:37:29 +0000153 return hasAttribute(Attribute::Returned);
Stephen Linb8bd2322013-04-20 05:14:40 +0000154}
155
Juergen Ributzka384c3b52014-08-05 05:43:41 +0000156bool Argument::hasZExtAttr() const {
Amaury Sechet7b05a4c2016-03-14 01:37:29 +0000157 return hasAttribute(Attribute::ZExt);
Juergen Ributzka384c3b52014-08-05 05:43:41 +0000158}
159
Juergen Ributzka384c3b52014-08-05 05:43:41 +0000160bool Argument::hasSExtAttr() const {
Amaury Sechet7b05a4c2016-03-14 01:37:29 +0000161 return hasAttribute(Attribute::SExt);
Juergen Ributzka384c3b52014-08-05 05:43:41 +0000162}
163
Nick Lewyckyc2ec0722013-07-06 00:29:58 +0000164bool Argument::onlyReadsMemory() const {
Reid Klecknerf021fab2017-04-13 23:12:13 +0000165 AttributeList Attrs = getParent()->getAttributes();
166 return Attrs.hasParamAttribute(getArgNo(), Attribute::ReadOnly) ||
167 Attrs.hasParamAttribute(getArgNo(), Attribute::ReadNone);
Nick Lewyckyc2ec0722013-07-06 00:29:58 +0000168}
169
Reid Kleckner9d16fa02017-04-19 17:28:52 +0000170void Argument::addAttrs(AttrBuilder &B) {
171 AttributeList AL = getParent()->getAttributes();
Reid Klecknera0b45f42017-05-03 18:17:31 +0000172 AL = AL.addAttributes(Parent->getContext(),
173 getArgNo() + AttributeList::FirstArgIndex, B);
Reid Kleckner9d16fa02017-04-19 17:28:52 +0000174 getParent()->setAttributes(AL);
175}
176
177void Argument::addAttr(Attribute::AttrKind Kind) {
Reid Klecknera0b45f42017-05-03 18:17:31 +0000178 getParent()->addAttribute(getArgNo() + AttributeList::FirstArgIndex, Kind);
Reid Kleckner9d16fa02017-04-19 17:28:52 +0000179}
180
181void Argument::addAttr(Attribute Attr) {
Reid Klecknera0b45f42017-05-03 18:17:31 +0000182 getParent()->addAttribute(getArgNo() + AttributeList::FirstArgIndex, Attr);
Gordon Henriksen2d9cc212008-04-28 17:37:06 +0000183}
Chris Lattnere30f09d2008-01-24 17:47:11 +0000184
Reid Kleckner9d16fa02017-04-19 17:28:52 +0000185void Argument::removeAttr(Attribute::AttrKind Kind) {
Reid Klecknera0b45f42017-05-03 18:17:31 +0000186 getParent()->removeAttribute(getArgNo() + AttributeList::FirstArgIndex, Kind);
Reid Kleckner9d16fa02017-04-19 17:28:52 +0000187}
188
Amaury Sechet7b05a4c2016-03-14 01:37:29 +0000189bool Argument::hasAttribute(Attribute::AttrKind Kind) const {
Reid Klecknerf021fab2017-04-13 23:12:13 +0000190 return getParent()->hasParamAttribute(getArgNo(), Kind);
Amaury Sechet7b05a4c2016-03-14 01:37:29 +0000191}
192
Chris Lattnerd255ae22002-04-09 19:39:35 +0000193//===----------------------------------------------------------------------===//
Chris Lattner3e13b8c2008-01-02 23:42:30 +0000194// Helper Methods in Function
Reid Spencer019c8862007-04-09 15:01:12 +0000195//===----------------------------------------------------------------------===//
196
Owen Anderson47db9412009-07-22 00:24:57 +0000197LLVMContext &Function::getContext() const {
198 return getType()->getContext();
Owen Anderson0a2c4582009-07-02 18:03:58 +0000199}
200
Chris Lattner3e13b8c2008-01-02 23:42:30 +0000201void Function::removeFromParent() {
Duncan P. N. Exon Smith52888a62015-10-08 23:49:46 +0000202 getParent()->getFunctionList().remove(getIterator());
Duncan Sands185eeac2007-11-25 14:10:56 +0000203}
204
Chris Lattner3e13b8c2008-01-02 23:42:30 +0000205void Function::eraseFromParent() {
Duncan P. N. Exon Smith52888a62015-10-08 23:49:46 +0000206 getParent()->getFunctionList().erase(getIterator());
Reid Spencer019c8862007-04-09 15:01:12 +0000207}
208
Reid Spencer019c8862007-04-09 15:01:12 +0000209//===----------------------------------------------------------------------===//
Chris Lattner57698e22002-03-26 18:01:55 +0000210// Function Implementation
Chris Lattnerda975502001-09-10 07:58:01 +0000211//===----------------------------------------------------------------------===//
212
Rafael Espindola1b47a282014-10-23 15:20:05 +0000213Function::Function(FunctionType *Ty, LinkageTypes Linkage, const Twine &name,
214 Module *ParentModule)
David Blaikied583b192015-08-21 21:35:28 +0000215 : GlobalObject(Ty, Value::FunctionVal,
Reid Kleckner56d028d2017-03-17 17:16:39 +0000216 OperandTraits<Function>::op_begin(this), 0, Linkage, name),
Eugene Zelenkoeba7e4e2017-05-10 23:41:30 +0000217 NumArgs(Ty->getNumParams()) {
Chris Lattner654695b2009-01-05 07:58:59 +0000218 assert(FunctionType::isValidReturnType(getReturnType()) &&
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000219 "invalid return type");
Duncan P. N. Exon Smith4472b772015-04-24 20:47:23 +0000220 setGlobalObjectSubClassData(0);
Mehdi Aminia53d49e2016-09-17 06:00:02 +0000221
222 // We only need a symbol table for a function if the context keeps value names
223 if (!getContext().shouldDiscardValueNames())
224 SymTab = make_unique<ValueSymbolTable>();
Chris Lattner6213ae02002-09-06 20:46:32 +0000225
Chris Lattnere2de9082007-08-18 06:14:52 +0000226 // If the function has arguments, mark them as lazily built.
227 if (Ty->getNumParams())
Chris Lattnerb9c86512009-12-29 02:14:09 +0000228 setValueSubclassData(1); // Set the "has lazy arguments" bit.
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000229
Chris Lattner6213ae02002-09-06 20:46:32 +0000230 if (ParentModule)
231 ParentModule->getFunctionList().push_back(this);
Duncan Sandsa8ff6ca2008-04-07 13:39:11 +0000232
Justin Lebar291abd32016-12-28 22:59:45 +0000233 HasLLVMReservedName = getName().startswith("llvm.");
Duncan Sandsa8ff6ca2008-04-07 13:39:11 +0000234 // Ensure intrinsics have the right parameter attributes.
Pete Coopera7c0c182015-05-19 00:24:26 +0000235 // Note, the IntID field will have been set in Value::setName if this function
236 // name is a valid intrinsic ID.
237 if (IntID)
238 setAttributes(Intrinsic::getAttributes(getContext(), IntID));
Chris Lattner2f7c9632001-06-06 20:29:01 +0000239}
240
Gordon Henriksen14a55692007-12-10 02:14:30 +0000241Function::~Function() {
242 dropAllReferences(); // After this it is safe to delete instructions.
Chris Lattner2f7c9632001-06-06 20:29:01 +0000243
Chris Lattner2f7c9632001-06-06 20:29:01 +0000244 // Delete all of the method arguments and unlink from symbol table...
Reid Kleckner56d028d2017-03-17 17:16:39 +0000245 if (Arguments)
246 clearArguments();
Reid Spencerc6a83842007-04-22 17:28:03 +0000247
Gordon Henriksend930f912008-08-17 18:44:35 +0000248 // Remove the function from the on-the-side GC table.
249 clearGC();
Chris Lattner2f7c9632001-06-06 20:29:01 +0000250}
251
Chris Lattnere2de9082007-08-18 06:14:52 +0000252void Function::BuildLazyArguments() const {
253 // Create the arguments vector, all arguments start out unnamed.
Reid Kleckner56d028d2017-03-17 17:16:39 +0000254 auto *FT = getFunctionType();
255 if (NumArgs > 0) {
256 Arguments = std::allocator<Argument>().allocate(NumArgs);
257 for (unsigned i = 0, e = NumArgs; i != e; ++i) {
258 Type *ArgTy = FT->getParamType(i);
259 assert(!ArgTy->isVoidTy() && "Cannot have void typed arguments!");
260 new (Arguments + i) Argument(ArgTy, "", const_cast<Function *>(this), i);
261 }
Chris Lattnere2de9082007-08-18 06:14:52 +0000262 }
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000263
Chris Lattnere2de9082007-08-18 06:14:52 +0000264 // Clear the lazy arguments bit.
Chris Lattnerb9c86512009-12-29 02:14:09 +0000265 unsigned SDC = getSubclassDataFromValue();
Peter Collingbourne51d2de72014-12-03 02:08:38 +0000266 const_cast<Function*>(this)->setValueSubclassData(SDC &= ~(1<<0));
Reid Kleckner56d028d2017-03-17 17:16:39 +0000267 assert(!hasLazyArguments());
268}
269
270static MutableArrayRef<Argument> makeArgArray(Argument *Args, size_t Count) {
271 return MutableArrayRef<Argument>(Args, Count);
272}
273
274void Function::clearArguments() {
275 for (Argument &A : makeArgArray(Arguments, NumArgs)) {
276 A.setName("");
277 A.~Argument();
278 }
279 std::allocator<Argument>().deallocate(Arguments, NumArgs);
280 Arguments = nullptr;
Chris Lattnere2de9082007-08-18 06:14:52 +0000281}
282
Duncan P. N. Exon Smithbdfc9842016-04-06 06:38:15 +0000283void Function::stealArgumentListFrom(Function &Src) {
284 assert(isDeclaration() && "Expected no references to current arguments");
285
286 // Drop the current arguments, if any, and set the lazy argument bit.
287 if (!hasLazyArguments()) {
Reid Kleckner56d028d2017-03-17 17:16:39 +0000288 assert(llvm::all_of(makeArgArray(Arguments, NumArgs),
Duncan P. N. Exon Smithbdfc9842016-04-06 06:38:15 +0000289 [](const Argument &A) { return A.use_empty(); }) &&
290 "Expected arguments to be unused in declaration");
Reid Kleckner56d028d2017-03-17 17:16:39 +0000291 clearArguments();
Duncan P. N. Exon Smithbdfc9842016-04-06 06:38:15 +0000292 setValueSubclassData(getSubclassDataFromValue() | (1 << 0));
293 }
294
295 // Nothing to steal if Src has lazy arguments.
296 if (Src.hasLazyArguments())
297 return;
298
299 // Steal arguments from Src, and fix the lazy argument bits.
Reid Kleckner56d028d2017-03-17 17:16:39 +0000300 assert(arg_size() == Src.arg_size());
301 Arguments = Src.Arguments;
302 Src.Arguments = nullptr;
303 for (Argument &A : makeArgArray(Arguments, NumArgs)) {
304 // FIXME: This does the work of transferNodesFromList inefficiently.
305 SmallString<128> Name;
306 if (A.hasName())
307 Name = A.getName();
308 if (!Name.empty())
309 A.setName("");
310 A.setParent(this);
311 if (!Name.empty())
312 A.setName(Name);
313 }
314
Duncan P. N. Exon Smithbdfc9842016-04-06 06:38:15 +0000315 setValueSubclassData(getSubclassDataFromValue() & ~(1 << 0));
Reid Kleckner56d028d2017-03-17 17:16:39 +0000316 assert(!hasLazyArguments());
Duncan P. N. Exon Smithbdfc9842016-04-06 06:38:15 +0000317 Src.setValueSubclassData(Src.getSubclassDataFromValue() | (1 << 0));
318}
319
Chris Lattner2f7c9632001-06-06 20:29:01 +0000320// dropAllReferences() - This function causes all the subinstructions to "let
321// go" of all references that they are maintaining. This allows one to
322// 'delete' a whole class at a time, even though there may be circular
323// references... first all references are dropped, and all use counts go to
Misha Brukmanfa100532003-10-10 17:54:14 +0000324// zero. Then everything is deleted for real. Note that no operations are
Misha Brukmanb1c93172005-04-21 23:48:37 +0000325// valid on an object that has "dropped all references", except operator
Chris Lattner2f7c9632001-06-06 20:29:01 +0000326// delete.
327//
Chris Lattner4e8c4872002-03-23 22:51:58 +0000328void Function::dropAllReferences() {
Rafael Espindolad4bcefc2014-10-24 18:13:04 +0000329 setIsMaterializable(false);
330
Benjamin Krameraf28e7d2016-06-26 14:10:56 +0000331 for (BasicBlock &BB : *this)
332 BB.dropAllReferences();
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000333
Dan Gohmanf844b3b2010-12-07 19:56:51 +0000334 // Delete all basic blocks. They are now unused, except possibly by
335 // blockaddresses, but BasicBlock's destructor takes care of those.
336 while (!BasicBlocks.empty())
337 BasicBlocks.begin()->eraseFromParent();
Peter Collingbourne3fa50f92013-09-16 01:08:15 +0000338
Vedant Kumar3a63fb32015-12-19 08:52:49 +0000339 // Drop uses of any optional data (real or placeholder).
340 if (getNumOperands()) {
341 User::dropAllReferences();
342 setNumHungOffUseOperands(0);
343 setValueSubclassData(getSubclassDataFromValue() & ~0xe);
344 }
Duncan P. N. Exon Smithe2510cd2015-04-24 21:51:02 +0000345
346 // Metadata is stored in a side-table.
347 clearMetadata();
Chris Lattner2f7c9632001-06-06 20:29:01 +0000348}
Chris Lattnerda975502001-09-10 07:58:01 +0000349
Amaury Sechet392638d2016-06-14 20:27:35 +0000350void Function::addAttribute(unsigned i, Attribute::AttrKind Kind) {
Reid Klecknerb5180542017-03-21 16:57:19 +0000351 AttributeList PAL = getAttributes();
Amaury Sechet392638d2016-06-14 20:27:35 +0000352 PAL = PAL.addAttribute(getContext(), i, Kind);
Devang Patel4c758ea2008-09-25 21:00:45 +0000353 setAttributes(PAL);
Eric Christopher901b1a72008-05-16 20:39:43 +0000354}
355
Amaury Sechet5db224e2016-06-12 06:17:24 +0000356void Function::addAttribute(unsigned i, Attribute Attr) {
Reid Klecknerb5180542017-03-21 16:57:19 +0000357 AttributeList PAL = getAttributes();
Amaury Sechet5db224e2016-06-12 06:17:24 +0000358 PAL = PAL.addAttribute(getContext(), i, Attr);
359 setAttributes(PAL);
360}
361
Reid Kleckneree4930b2017-05-02 22:07:37 +0000362void Function::addAttributes(unsigned i, const AttrBuilder &Attrs) {
Reid Klecknerb5180542017-03-21 16:57:19 +0000363 AttributeList PAL = getAttributes();
Amaury Sechet392638d2016-06-14 20:27:35 +0000364 PAL = PAL.addAttributes(getContext(), i, Attrs);
Bill Wendlingc0e2a1f2013-01-23 00:20:53 +0000365 setAttributes(PAL);
366}
367
Amaury Sechet392638d2016-06-14 20:27:35 +0000368void Function::removeAttribute(unsigned i, Attribute::AttrKind Kind) {
Reid Klecknerb5180542017-03-21 16:57:19 +0000369 AttributeList PAL = getAttributes();
Amaury Sechet392638d2016-06-14 20:27:35 +0000370 PAL = PAL.removeAttribute(getContext(), i, Kind);
Amaury Sechet7b05a4c2016-03-14 01:37:29 +0000371 setAttributes(PAL);
372}
373
Amaury Sechet6100adf2016-06-15 17:50:39 +0000374void Function::removeAttribute(unsigned i, StringRef Kind) {
Reid Klecknerb5180542017-03-21 16:57:19 +0000375 AttributeList PAL = getAttributes();
Amaury Sechet6100adf2016-06-15 17:50:39 +0000376 PAL = PAL.removeAttribute(getContext(), i, Kind);
377 setAttributes(PAL);
378}
379
Reid Kleckneree4930b2017-05-02 22:07:37 +0000380void Function::removeAttributes(unsigned i, const AttrBuilder &Attrs) {
Reid Klecknerb5180542017-03-21 16:57:19 +0000381 AttributeList PAL = getAttributes();
Amaury Sechet392638d2016-06-14 20:27:35 +0000382 PAL = PAL.removeAttributes(getContext(), i, Attrs);
Devang Patel4c758ea2008-09-25 21:00:45 +0000383 setAttributes(PAL);
Duncan Sands66336db2008-07-08 09:41:30 +0000384}
385
Ramkumar Ramachandra8fcb4982015-02-14 19:37:54 +0000386void Function::addDereferenceableAttr(unsigned i, uint64_t Bytes) {
Reid Klecknerb5180542017-03-21 16:57:19 +0000387 AttributeList PAL = getAttributes();
Ramkumar Ramachandra8fcb4982015-02-14 19:37:54 +0000388 PAL = PAL.addDereferenceableAttr(getContext(), i, Bytes);
389 setAttributes(PAL);
390}
391
Sanjoy Das31ea6d12015-04-16 20:29:50 +0000392void Function::addDereferenceableOrNullAttr(unsigned i, uint64_t Bytes) {
Reid Klecknerb5180542017-03-21 16:57:19 +0000393 AttributeList PAL = getAttributes();
Sanjoy Das31ea6d12015-04-16 20:29:50 +0000394 PAL = PAL.addDereferenceableOrNullAttr(getContext(), i, Bytes);
395 setAttributes(PAL);
396}
397
Mehdi Amini599ebf22016-01-08 02:28:20 +0000398const std::string &Function::getGC() const {
Gordon Henriksend930f912008-08-17 18:44:35 +0000399 assert(hasGC() && "Function has no collector");
Mehdi Amini599ebf22016-01-08 02:28:20 +0000400 return getContext().getGC(*this);
Gordon Henriksen71183b62007-12-10 03:18:06 +0000401}
402
Benjamin Kramer728f4442016-05-29 10:46:35 +0000403void Function::setGC(std::string Str) {
Mehdi Amini599ebf22016-01-08 02:28:20 +0000404 setValueSubclassDataBit(14, !Str.empty());
405 getContext().setGC(*this, std::move(Str));
Gordon Henriksen71183b62007-12-10 03:18:06 +0000406}
407
Gordon Henriksend930f912008-08-17 18:44:35 +0000408void Function::clearGC() {
Mehdi Amini599ebf22016-01-08 02:28:20 +0000409 if (!hasGC())
410 return;
411 getContext().deleteGC(*this);
412 setValueSubclassDataBit(14, false);
Gordon Henriksen71183b62007-12-10 03:18:06 +0000413}
414
Rafael Espindola769efe62015-12-02 20:03:17 +0000415/// Copy all additional attributes (those not needed to create a Function) from
416/// the Function Src to this one.
Reid Klecknere7c78542017-05-11 21:14:29 +0000417void Function::copyAttributesFrom(const Function *Src) {
Rafael Espindola99e05cf2014-05-13 18:45:48 +0000418 GlobalObject::copyAttributesFrom(Src);
Reid Klecknere7c78542017-05-11 21:14:29 +0000419 setCallingConv(Src->getCallingConv());
420 setAttributes(Src->getAttributes());
421 if (Src->hasGC())
422 setGC(Src->getGC());
Gordon Henriksend930f912008-08-17 18:44:35 +0000423 else
424 clearGC();
Reid Klecknere7c78542017-05-11 21:14:29 +0000425 if (Src->hasPersonalityFn())
426 setPersonalityFn(Src->getPersonalityFn());
427 if (Src->hasPrefixData())
428 setPrefixData(Src->getPrefixData());
429 if (Src->hasPrologueData())
430 setPrologueData(Src->getPrologueData());
Duncan Sandsdd7daee2008-05-26 19:58:59 +0000431}
432
Reid Kleckner0b5220d2016-01-26 02:06:41 +0000433/// Table of string intrinsic names indexed by enum value.
434static const char * const IntrinsicNameTable[] = {
435 "not_intrinsic",
436#define GET_INTRINSIC_NAME_TABLE
437#include "llvm/IR/Intrinsics.gen"
438#undef GET_INTRINSIC_NAME_TABLE
439};
440
Justin Bogner92a8c612016-07-15 16:31:37 +0000441/// Table of per-target intrinsic name tables.
442#define GET_INTRINSIC_TARGET_DATA
443#include "llvm/IR/Intrinsics.gen"
444#undef GET_INTRINSIC_TARGET_DATA
445
446/// Find the segment of \c IntrinsicNameTable for intrinsics with the same
447/// target as \c Name, or the generic table if \c Name is not target specific.
448///
449/// Returns the relevant slice of \c IntrinsicNameTable
450static ArrayRef<const char *> findTargetSubtable(StringRef Name) {
451 assert(Name.startswith("llvm."));
452
453 ArrayRef<IntrinsicTargetInfo> Targets(TargetInfos);
454 // Drop "llvm." and take the first dotted component. That will be the target
455 // if this is target specific.
456 StringRef Target = Name.drop_front(5).split('.').first;
457 auto It = std::lower_bound(Targets.begin(), Targets.end(), Target,
458 [](const IntrinsicTargetInfo &TI,
459 StringRef Target) { return TI.Name < Target; });
460 // We've either found the target or just fall back to the generic set, which
461 // is always first.
462 const auto &TI = It != Targets.end() && It->Name == Target ? *It : Targets[0];
463 return makeArrayRef(&IntrinsicNameTable[1] + TI.Offset, TI.Count);
464}
465
Pete Cooper21241132015-05-19 00:02:25 +0000466/// \brief This does the actual lookup of an intrinsic ID which
467/// matches the given function name.
Tim Northover6b3bd612016-07-29 20:32:59 +0000468Intrinsic::ID Function::lookupIntrinsicID(StringRef Name) {
Justin Bogner92a8c612016-07-15 16:31:37 +0000469 ArrayRef<const char *> NameTable = findTargetSubtable(Name);
Reid Klecknerc2752da2016-01-26 22:33:19 +0000470 int Idx = Intrinsic::lookupLLVMIntrinsicByName(NameTable, Name);
Justin Bogner92a8c612016-07-15 16:31:37 +0000471 if (Idx == -1)
472 return Intrinsic::not_intrinsic;
473
474 // Intrinsic IDs correspond to the location in IntrinsicNameTable, but we have
475 // an index into a sub-table.
476 int Adjust = NameTable.data() - IntrinsicNameTable;
477 Intrinsic::ID ID = static_cast<Intrinsic::ID>(Idx + Adjust);
Pete Cooper21241132015-05-19 00:02:25 +0000478
Reid Kleckner0b5220d2016-01-26 02:06:41 +0000479 // If the intrinsic is not overloaded, require an exact match. If it is
480 // overloaded, require a prefix match.
481 bool IsPrefixMatch = Name.size() > strlen(NameTable[Idx]);
482 return IsPrefixMatch == isOverloaded(ID) ? ID : Intrinsic::not_intrinsic;
Pete Cooper21241132015-05-19 00:02:25 +0000483}
484
Pete Coopera7c0c182015-05-19 00:24:26 +0000485void Function::recalculateIntrinsicID() {
Justin Lebar291abd32016-12-28 22:59:45 +0000486 StringRef Name = getName();
487 if (!Name.startswith("llvm.")) {
488 HasLLVMReservedName = false;
Pete Coopera7c0c182015-05-19 00:24:26 +0000489 IntID = Intrinsic::not_intrinsic;
490 return;
Michael Ilseman516d7032013-03-01 18:48:54 +0000491 }
Justin Lebar291abd32016-12-28 22:59:45 +0000492 HasLLVMReservedName = true;
493 IntID = lookupIntrinsicID(Name);
Michael Ilseman516d7032013-03-01 18:48:54 +0000494}
495
Philip Reames319c48e2014-11-12 00:21:51 +0000496/// Returns a stable mangling for the type specified for use in the name
Philip Reames059ecbf2014-11-24 23:24:24 +0000497/// mangling scheme used by 'any' types in intrinsic signatures. The mangling
498/// of named types is simply their name. Manglings for unnamed types consist
499/// of a prefix ('p' for pointers, 'a' for arrays, 'f_' for functions)
500/// combined with the mangling of their component types. A vararg function
501/// type will have a suffix of 'vararg'. Since function types can contain
502/// other function types, we close a function type mangling with suffix 'f'
503/// which can't be confused with it's prefix. This ensures we don't have
504/// collisions between two unrelated function types. Otherwise, you might
505/// parse ffXX as f(fXX) or f(fX)X. (X is a placeholder for any other type.)
Philip Reames8d5d68f2015-01-14 23:05:17 +0000506/// Manglings of integers, floats, and vectors ('i', 'f', and 'v' prefix in most
507/// cases) fall back to the MVT codepath, where they could be mangled to
508/// 'x86mmx', for example; matching on derived types is not sufficient to mangle
509/// everything.
Philip Reames319c48e2014-11-12 00:21:51 +0000510static std::string getMangledTypeStr(Type* Ty) {
511 std::string Result;
512 if (PointerType* PTyp = dyn_cast<PointerType>(Ty)) {
Eugene Zelenkoeba7e4e2017-05-10 23:41:30 +0000513 Result += "p" + utostr(PTyp->getAddressSpace()) +
Philip Reames319c48e2014-11-12 00:21:51 +0000514 getMangledTypeStr(PTyp->getElementType());
515 } else if (ArrayType* ATyp = dyn_cast<ArrayType>(Ty)) {
Eugene Zelenkoeba7e4e2017-05-10 23:41:30 +0000516 Result += "a" + utostr(ATyp->getNumElements()) +
Philip Reames319c48e2014-11-12 00:21:51 +0000517 getMangledTypeStr(ATyp->getElementType());
Daniel Berlin3c1432f2017-02-15 23:16:20 +0000518 } else if (StructType *STyp = dyn_cast<StructType>(Ty)) {
519 if (!STyp->isLiteral()) {
520 Result += "s_";
521 Result += STyp->getName();
522 } else {
523 Result += "sl_";
524 for (auto Elem : STyp->elements())
525 Result += getMangledTypeStr(Elem);
526 }
527 // Ensure nested structs are distinguishable.
528 Result += "s";
529 } else if (FunctionType *FT = dyn_cast<FunctionType>(Ty)) {
Philip Reames319c48e2014-11-12 00:21:51 +0000530 Result += "f_" + getMangledTypeStr(FT->getReturnType());
531 for (size_t i = 0; i < FT->getNumParams(); i++)
532 Result += getMangledTypeStr(FT->getParamType(i));
533 if (FT->isVarArg())
534 Result += "vararg";
Philip Reames059ecbf2014-11-24 23:24:24 +0000535 // Ensure nested function types are distinguishable.
536 Result += "f";
Elena Demikhovsky1ca72e12015-11-19 07:17:16 +0000537 } else if (isa<VectorType>(Ty))
538 Result += "v" + utostr(Ty->getVectorNumElements()) +
539 getMangledTypeStr(Ty->getVectorElementType());
540 else if (Ty)
Philip Reames319c48e2014-11-12 00:21:51 +0000541 Result += EVT::getEVT(Ty).getEVTString();
542 return Result;
543}
544
Pete Coopera8db71e2016-08-18 18:30:54 +0000545StringRef Intrinsic::getName(ID id) {
546 assert(id < num_intrinsics && "Invalid intrinsic ID!");
Pete Coopera5f8c722016-08-22 20:18:28 +0000547 assert(!isOverloaded(id) &&
548 "This version of getName does not support overloading");
Pete Coopera8db71e2016-08-18 18:30:54 +0000549 return IntrinsicNameTable[id];
550}
551
Benjamin Kramere6e19332011-07-14 17:45:39 +0000552std::string Intrinsic::getName(ID id, ArrayRef<Type*> Tys) {
Chris Lattner71b8c982006-03-25 06:32:47 +0000553 assert(id < num_intrinsics && "Invalid intrinsic ID!");
Reid Kleckner0b5220d2016-01-26 02:06:41 +0000554 std::string Result(IntrinsicNameTable[id]);
Benjamin Krameraf28e7d2016-06-26 14:10:56 +0000555 for (Type *Ty : Tys) {
556 Result += "." + getMangledTypeStr(Ty);
Mon P Wang2c839d42008-07-30 04:36:53 +0000557 }
Reid Spencer2a2117c2007-04-01 07:25:33 +0000558 return Result;
Chris Lattner71b8c982006-03-25 06:32:47 +0000559}
560
Chris Lattnerf39c2782012-05-27 18:28:35 +0000561/// IIT_Info - These are enumerators that describe the entries returned by the
562/// getIntrinsicInfoTableEntries function.
563///
564/// NOTE: This must be kept in synch with the copy in TblGen/IntrinsicEmitter!
565enum IIT_Info {
Robert Khasanov65c27562014-10-20 19:25:05 +0000566 // Common values should be encoded with 0-15.
Chris Lattnerf39c2782012-05-27 18:28:35 +0000567 IIT_Done = 0,
568 IIT_I1 = 1,
569 IIT_I8 = 2,
570 IIT_I16 = 3,
571 IIT_I32 = 4,
572 IIT_I64 = 5,
Michael Ilseman6c6d7152013-01-11 01:45:05 +0000573 IIT_F16 = 6,
574 IIT_F32 = 7,
575 IIT_F64 = 8,
576 IIT_V2 = 9,
577 IIT_V4 = 10,
578 IIT_V8 = 11,
579 IIT_V16 = 12,
580 IIT_V32 = 13,
Robert Khasanov65c27562014-10-20 19:25:05 +0000581 IIT_PTR = 14,
582 IIT_ARG = 15,
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000583
Robert Khasanov65c27562014-10-20 19:25:05 +0000584 // Values from 16+ are only encodable with the inefficient encoding.
585 IIT_V64 = 16,
Robert Khasanovb25e5622014-09-30 11:32:22 +0000586 IIT_MMX = 17,
Joseph Tremoulet917c7382015-09-02 13:36:25 +0000587 IIT_TOKEN = 18,
588 IIT_METADATA = 19,
589 IIT_EMPTYSTRUCT = 20,
590 IIT_STRUCT2 = 21,
591 IIT_STRUCT3 = 22,
592 IIT_STRUCT4 = 23,
593 IIT_STRUCT5 = 24,
594 IIT_EXTEND_ARG = 25,
595 IIT_TRUNC_ARG = 26,
596 IIT_ANYPTR = 27,
597 IIT_V1 = 28,
598 IIT_VARARG = 29,
599 IIT_HALF_VEC_ARG = 30,
600 IIT_SAME_VEC_WIDTH_ARG = 31,
601 IIT_PTR_TO_ARG = 32,
Elena Demikhovskycaaceef2016-11-03 03:23:55 +0000602 IIT_PTR_TO_ELT = 33,
Elad Cohenef5798a2017-05-03 12:28:54 +0000603 IIT_VEC_OF_ANYPTRS_TO_ELT = 34,
Elena Demikhovskycaaceef2016-11-03 03:23:55 +0000604 IIT_I128 = 35,
605 IIT_V512 = 36,
606 IIT_V1024 = 37
Chris Lattnerf39c2782012-05-27 18:28:35 +0000607};
608
Chris Lattnerf39c2782012-05-27 18:28:35 +0000609static void DecodeIITType(unsigned &NextElt, ArrayRef<unsigned char> Infos,
610 SmallVectorImpl<Intrinsic::IITDescriptor> &OutputTable) {
Eugene Zelenkoeba7e4e2017-05-10 23:41:30 +0000611 using namespace Intrinsic;
612
Chris Lattnera57c7972012-05-17 05:13:57 +0000613 IIT_Info Info = IIT_Info(Infos[NextElt++]);
Chris Lattner3e34a7b2012-05-17 05:03:24 +0000614 unsigned StructElts = 2;
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000615
Chris Lattnera57c7972012-05-17 05:13:57 +0000616 switch (Info) {
Chris Lattnerf39c2782012-05-27 18:28:35 +0000617 case IIT_Done:
618 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Void, 0));
619 return;
Andrew Tricka2efd992013-10-31 17:18:11 +0000620 case IIT_VARARG:
621 OutputTable.push_back(IITDescriptor::get(IITDescriptor::VarArg, 0));
622 return;
Chris Lattnerf39c2782012-05-27 18:28:35 +0000623 case IIT_MMX:
624 OutputTable.push_back(IITDescriptor::get(IITDescriptor::MMX, 0));
625 return;
Joseph Tremoulet917c7382015-09-02 13:36:25 +0000626 case IIT_TOKEN:
627 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Token, 0));
628 return;
Chris Lattnerf39c2782012-05-27 18:28:35 +0000629 case IIT_METADATA:
630 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Metadata, 0));
631 return;
Michael Ilseman6c6d7152013-01-11 01:45:05 +0000632 case IIT_F16:
633 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Half, 0));
634 return;
Chris Lattnerf39c2782012-05-27 18:28:35 +0000635 case IIT_F32:
636 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Float, 0));
637 return;
638 case IIT_F64:
639 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Double, 0));
640 return;
641 case IIT_I1:
642 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer, 1));
643 return;
644 case IIT_I8:
645 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer, 8));
646 return;
647 case IIT_I16:
648 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer,16));
649 return;
650 case IIT_I32:
651 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer, 32));
652 return;
653 case IIT_I64:
654 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer, 64));
655 return;
Kit Barton66460332015-05-25 15:49:26 +0000656 case IIT_I128:
657 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer, 128));
658 return;
Jiangning Liu63dc8402013-09-24 02:47:27 +0000659 case IIT_V1:
660 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 1));
661 DecodeIITType(NextElt, Infos, OutputTable);
662 return;
Chris Lattner827b2532012-05-17 04:30:58 +0000663 case IIT_V2:
Chris Lattnerf39c2782012-05-27 18:28:35 +0000664 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 2));
665 DecodeIITType(NextElt, Infos, OutputTable);
666 return;
Chris Lattner827b2532012-05-17 04:30:58 +0000667 case IIT_V4:
Chris Lattnerf39c2782012-05-27 18:28:35 +0000668 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 4));
669 DecodeIITType(NextElt, Infos, OutputTable);
670 return;
Chris Lattner827b2532012-05-17 04:30:58 +0000671 case IIT_V8:
Chris Lattnerf39c2782012-05-27 18:28:35 +0000672 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 8));
673 DecodeIITType(NextElt, Infos, OutputTable);
674 return;
Chris Lattner827b2532012-05-17 04:30:58 +0000675 case IIT_V16:
Chris Lattnerf39c2782012-05-27 18:28:35 +0000676 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 16));
677 DecodeIITType(NextElt, Infos, OutputTable);
678 return;
Chris Lattner3e34a7b2012-05-17 05:03:24 +0000679 case IIT_V32:
Chris Lattnerf39c2782012-05-27 18:28:35 +0000680 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 32));
681 DecodeIITType(NextElt, Infos, OutputTable);
682 return;
Robert Khasanovb25e5622014-09-30 11:32:22 +0000683 case IIT_V64:
684 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 64));
685 DecodeIITType(NextElt, Infos, OutputTable);
686 return;
Krzysztof Parzyszekb8bb90b2015-11-24 16:28:14 +0000687 case IIT_V512:
688 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 512));
689 DecodeIITType(NextElt, Infos, OutputTable);
690 return;
691 case IIT_V1024:
692 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 1024));
693 DecodeIITType(NextElt, Infos, OutputTable);
694 return;
Chris Lattner4f18aa82012-05-23 05:19:18 +0000695 case IIT_PTR:
Chris Lattnerf39c2782012-05-27 18:28:35 +0000696 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Pointer, 0));
697 DecodeIITType(NextElt, Infos, OutputTable);
698 return;
Chris Lattner4f18aa82012-05-23 05:19:18 +0000699 case IIT_ANYPTR: { // [ANYPTR addrspace, subtype]
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000700 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Pointer,
Chris Lattnerf39c2782012-05-27 18:28:35 +0000701 Infos[NextElt++]));
702 DecodeIITType(NextElt, Infos, OutputTable);
703 return;
Pete Cooper243efd72012-05-21 23:21:28 +0000704 }
Chris Lattnerf39c2782012-05-27 18:28:35 +0000705 case IIT_ARG: {
706 unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
707 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Argument, ArgInfo));
708 return;
709 }
Tim Northoveraa3cf1e2014-03-28 12:31:39 +0000710 case IIT_EXTEND_ARG: {
Chris Lattnerf39c2782012-05-27 18:28:35 +0000711 unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
Tim Northoveraa3cf1e2014-03-28 12:31:39 +0000712 OutputTable.push_back(IITDescriptor::get(IITDescriptor::ExtendArgument,
Chris Lattnerf39c2782012-05-27 18:28:35 +0000713 ArgInfo));
714 return;
715 }
Tim Northoveraa3cf1e2014-03-28 12:31:39 +0000716 case IIT_TRUNC_ARG: {
Chris Lattnerf39c2782012-05-27 18:28:35 +0000717 unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
Tim Northoveraa3cf1e2014-03-28 12:31:39 +0000718 OutputTable.push_back(IITDescriptor::get(IITDescriptor::TruncArgument,
Chris Lattnerf39c2782012-05-27 18:28:35 +0000719 ArgInfo));
720 return;
Chris Lattner3e34a7b2012-05-17 05:03:24 +0000721 }
Tim Northover4516de32014-03-29 07:04:54 +0000722 case IIT_HALF_VEC_ARG: {
723 unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
724 OutputTable.push_back(IITDescriptor::get(IITDescriptor::HalfVecArgument,
725 ArgInfo));
726 return;
727 }
Elena Demikhovskyf1de34b2014-12-04 09:40:44 +0000728 case IIT_SAME_VEC_WIDTH_ARG: {
729 unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
730 OutputTable.push_back(IITDescriptor::get(IITDescriptor::SameVecWidthArgument,
731 ArgInfo));
732 return;
733 }
Elena Demikhovskyfb81b932014-12-25 07:49:20 +0000734 case IIT_PTR_TO_ARG: {
735 unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
736 OutputTable.push_back(IITDescriptor::get(IITDescriptor::PtrToArgument,
737 ArgInfo));
738 return;
739 }
Elena Demikhovskycaaceef2016-11-03 03:23:55 +0000740 case IIT_PTR_TO_ELT: {
741 unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
742 OutputTable.push_back(IITDescriptor::get(IITDescriptor::PtrToElt, ArgInfo));
743 return;
744 }
Elad Cohenef5798a2017-05-03 12:28:54 +0000745 case IIT_VEC_OF_ANYPTRS_TO_ELT: {
746 unsigned short ArgNo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
747 unsigned short RefNo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
748 OutputTable.push_back(
749 IITDescriptor::get(IITDescriptor::VecOfAnyPtrsToElt, ArgNo, RefNo));
Elena Demikhovsky23a485a2015-02-08 08:27:19 +0000750 return;
751 }
Chris Lattnerf39c2782012-05-27 18:28:35 +0000752 case IIT_EMPTYSTRUCT:
753 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Struct, 0));
754 return;
Justin Bognercd1d5aa2016-08-17 20:30:52 +0000755 case IIT_STRUCT5: ++StructElts; LLVM_FALLTHROUGH;
756 case IIT_STRUCT4: ++StructElts; LLVM_FALLTHROUGH;
757 case IIT_STRUCT3: ++StructElts; LLVM_FALLTHROUGH;
Chris Lattner3e34a7b2012-05-17 05:03:24 +0000758 case IIT_STRUCT2: {
Chris Lattnerf39c2782012-05-27 18:28:35 +0000759 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Struct,StructElts));
760
Chris Lattner3e34a7b2012-05-17 05:03:24 +0000761 for (unsigned i = 0; i != StructElts; ++i)
Chris Lattnerf39c2782012-05-27 18:28:35 +0000762 DecodeIITType(NextElt, Infos, OutputTable);
763 return;
Chris Lattner827b2532012-05-17 04:30:58 +0000764 }
Chris Lattner7f0e7ba2012-05-16 06:34:44 +0000765 }
766 llvm_unreachable("unhandled");
767}
Chris Lattner7f0e7ba2012-05-16 06:34:44 +0000768
Chris Lattnerf39c2782012-05-27 18:28:35 +0000769#define GET_INTRINSIC_GENERATOR_GLOBAL
Chandler Carruthdb25c6c2013-01-02 12:09:16 +0000770#include "llvm/IR/Intrinsics.gen"
Chris Lattnerf39c2782012-05-27 18:28:35 +0000771#undef GET_INTRINSIC_GENERATOR_GLOBAL
772
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000773void Intrinsic::getIntrinsicInfoTableEntries(ID id,
Chris Lattnerf39c2782012-05-27 18:28:35 +0000774 SmallVectorImpl<IITDescriptor> &T){
Chris Lattner7f0e7ba2012-05-16 06:34:44 +0000775 // Check to see if the intrinsic's type was expressible by the table.
776 unsigned TableVal = IIT_Table[id-1];
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000777
Chris Lattnera3b0f522012-05-17 15:55:41 +0000778 // Decode the TableVal into an array of IITValues.
779 SmallVector<unsigned char, 8> IITValues;
780 ArrayRef<unsigned char> IITEntries;
781 unsigned NextElt = 0;
782 if ((TableVal >> 31) != 0) {
783 // This is an offset into the IIT_LongEncodingTable.
784 IITEntries = IIT_LongEncodingTable;
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000785
Chris Lattnera3b0f522012-05-17 15:55:41 +0000786 // Strip sentinel bit.
787 NextElt = (TableVal << 1) >> 1;
788 } else {
Chris Lattnerf39c2782012-05-27 18:28:35 +0000789 // Decode the TableVal into an array of IITValues. If the entry was encoded
790 // into a single word in the table itself, decode it now.
Chris Lattnera57c7972012-05-17 05:13:57 +0000791 do {
792 IITValues.push_back(TableVal & 0xF);
793 TableVal >>= 4;
794 } while (TableVal);
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000795
Chris Lattnera3b0f522012-05-17 15:55:41 +0000796 IITEntries = IITValues;
797 NextElt = 0;
Chris Lattner7f0e7ba2012-05-16 06:34:44 +0000798 }
Chris Lattnerf39c2782012-05-27 18:28:35 +0000799
800 // Okay, decode the table into the output vector of IITDescriptors.
801 DecodeIITType(NextElt, IITEntries, T);
802 while (NextElt != IITEntries.size() && IITEntries[NextElt] != 0)
803 DecodeIITType(NextElt, IITEntries, T);
804}
805
Chris Lattnerf39c2782012-05-27 18:28:35 +0000806static Type *DecodeFixedType(ArrayRef<Intrinsic::IITDescriptor> &Infos,
807 ArrayRef<Type*> Tys, LLVMContext &Context) {
808 using namespace Intrinsic;
Eugene Zelenkoeba7e4e2017-05-10 23:41:30 +0000809
Chris Lattnerf39c2782012-05-27 18:28:35 +0000810 IITDescriptor D = Infos.front();
811 Infos = Infos.slice(1);
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000812
Chris Lattnerf39c2782012-05-27 18:28:35 +0000813 switch (D.Kind) {
814 case IITDescriptor::Void: return Type::getVoidTy(Context);
Andrew Tricka2efd992013-10-31 17:18:11 +0000815 case IITDescriptor::VarArg: return Type::getVoidTy(Context);
Chris Lattnerf39c2782012-05-27 18:28:35 +0000816 case IITDescriptor::MMX: return Type::getX86_MMXTy(Context);
Joseph Tremoulet917c7382015-09-02 13:36:25 +0000817 case IITDescriptor::Token: return Type::getTokenTy(Context);
Chris Lattnerf39c2782012-05-27 18:28:35 +0000818 case IITDescriptor::Metadata: return Type::getMetadataTy(Context);
Michael Ilseman6c6d7152013-01-11 01:45:05 +0000819 case IITDescriptor::Half: return Type::getHalfTy(Context);
Chris Lattnerf39c2782012-05-27 18:28:35 +0000820 case IITDescriptor::Float: return Type::getFloatTy(Context);
821 case IITDescriptor::Double: return Type::getDoubleTy(Context);
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000822
Chris Lattnerf39c2782012-05-27 18:28:35 +0000823 case IITDescriptor::Integer:
824 return IntegerType::get(Context, D.Integer_Width);
825 case IITDescriptor::Vector:
826 return VectorType::get(DecodeFixedType(Infos, Tys, Context),D.Vector_Width);
827 case IITDescriptor::Pointer:
828 return PointerType::get(DecodeFixedType(Infos, Tys, Context),
829 D.Pointer_AddressSpace);
830 case IITDescriptor::Struct: {
831 Type *Elts[5];
832 assert(D.Struct_NumElements <= 5 && "Can't handle this yet");
833 for (unsigned i = 0, e = D.Struct_NumElements; i != e; ++i)
834 Elts[i] = DecodeFixedType(Infos, Tys, Context);
Craig Toppere1d12942014-08-27 05:25:25 +0000835 return StructType::get(Context, makeArrayRef(Elts,D.Struct_NumElements));
Chris Lattnerf39c2782012-05-27 18:28:35 +0000836 }
Chris Lattnerf39c2782012-05-27 18:28:35 +0000837 case IITDescriptor::Argument:
838 return Tys[D.getArgumentNumber()];
Tim Northoveraa3cf1e2014-03-28 12:31:39 +0000839 case IITDescriptor::ExtendArgument: {
840 Type *Ty = Tys[D.getArgumentNumber()];
841 if (VectorType *VTy = dyn_cast<VectorType>(Ty))
842 return VectorType::getExtendedElementVectorType(VTy);
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000843
Tim Northoveraa3cf1e2014-03-28 12:31:39 +0000844 return IntegerType::get(Context, 2 * cast<IntegerType>(Ty)->getBitWidth());
845 }
846 case IITDescriptor::TruncArgument: {
847 Type *Ty = Tys[D.getArgumentNumber()];
848 if (VectorType *VTy = dyn_cast<VectorType>(Ty))
849 return VectorType::getTruncatedElementVectorType(VTy);
850
851 IntegerType *ITy = cast<IntegerType>(Ty);
852 assert(ITy->getBitWidth() % 2 == 0);
853 return IntegerType::get(Context, ITy->getBitWidth() / 2);
854 }
Tim Northover4516de32014-03-29 07:04:54 +0000855 case IITDescriptor::HalfVecArgument:
856 return VectorType::getHalfElementsVectorType(cast<VectorType>(
857 Tys[D.getArgumentNumber()]));
Elena Demikhovskyfb81b932014-12-25 07:49:20 +0000858 case IITDescriptor::SameVecWidthArgument: {
Elena Demikhovskyf1de34b2014-12-04 09:40:44 +0000859 Type *EltTy = DecodeFixedType(Infos, Tys, Context);
860 Type *Ty = Tys[D.getArgumentNumber()];
861 if (VectorType *VTy = dyn_cast<VectorType>(Ty)) {
862 return VectorType::get(EltTy, VTy->getNumElements());
863 }
864 llvm_unreachable("unhandled");
Elena Demikhovskyfb81b932014-12-25 07:49:20 +0000865 }
866 case IITDescriptor::PtrToArgument: {
867 Type *Ty = Tys[D.getArgumentNumber()];
868 return PointerType::getUnqual(Ty);
869 }
Elena Demikhovskycaaceef2016-11-03 03:23:55 +0000870 case IITDescriptor::PtrToElt: {
871 Type *Ty = Tys[D.getArgumentNumber()];
872 VectorType *VTy = dyn_cast<VectorType>(Ty);
873 if (!VTy)
874 llvm_unreachable("Expected an argument of Vector Type");
875 Type *EltTy = VTy->getVectorElementType();
876 return PointerType::getUnqual(EltTy);
877 }
Elad Cohenef5798a2017-05-03 12:28:54 +0000878 case IITDescriptor::VecOfAnyPtrsToElt:
879 // Return the overloaded type (which determines the pointers address space)
880 return Tys[D.getOverloadArgNumber()];
Eugene Zelenkoeba7e4e2017-05-10 23:41:30 +0000881 }
Chris Lattnerf39c2782012-05-27 18:28:35 +0000882 llvm_unreachable("unhandled");
883}
884
Chris Lattnerf39c2782012-05-27 18:28:35 +0000885FunctionType *Intrinsic::getType(LLVMContext &Context,
886 ID id, ArrayRef<Type*> Tys) {
887 SmallVector<IITDescriptor, 8> Table;
888 getIntrinsicInfoTableEntries(id, Table);
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000889
Chris Lattnerf39c2782012-05-27 18:28:35 +0000890 ArrayRef<IITDescriptor> TableRef = Table;
891 Type *ResultTy = DecodeFixedType(TableRef, Tys, Context);
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000892
Chris Lattnera3b0f522012-05-17 15:55:41 +0000893 SmallVector<Type*, 8> ArgTys;
Chris Lattnerf39c2782012-05-27 18:28:35 +0000894 while (!TableRef.empty())
895 ArgTys.push_back(DecodeFixedType(TableRef, Tys, Context));
Jim Laskey2682ea62007-02-07 20:38:26 +0000896
Steven Wud05affc2014-10-20 15:47:24 +0000897 // DecodeFixedType returns Void for IITDescriptor::Void and IITDescriptor::VarArg
898 // If we see void type as the type of the last argument, it is vararg intrinsic
899 if (!ArgTys.empty() && ArgTys.back()->isVoidTy()) {
900 ArgTys.pop_back();
901 return FunctionType::get(ResultTy, ArgTys, true);
902 }
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000903 return FunctionType::get(ResultTy, ArgTys, false);
Jim Laskey2682ea62007-02-07 20:38:26 +0000904}
905
Mon P Wangb4024932009-02-24 23:17:49 +0000906bool Intrinsic::isOverloaded(ID id) {
Mon P Wangb4024932009-02-24 23:17:49 +0000907#define GET_INTRINSIC_OVERLOAD_TABLE
Chandler Carruthdb25c6c2013-01-02 12:09:16 +0000908#include "llvm/IR/Intrinsics.gen"
Mon P Wangb4024932009-02-24 23:17:49 +0000909#undef GET_INTRINSIC_OVERLOAD_TABLE
Mon P Wangb4024932009-02-24 23:17:49 +0000910}
911
Sanjoy Dasc65d43e2015-06-18 19:28:26 +0000912bool Intrinsic::isLeaf(ID id) {
913 switch (id) {
914 default:
915 return true;
916
917 case Intrinsic::experimental_gc_statepoint:
918 case Intrinsic::experimental_patchpoint_void:
919 case Intrinsic::experimental_patchpoint_i64:
920 return false;
921 }
922}
923
Chris Lattner49b7ee12009-01-12 01:18:58 +0000924/// This defines the "Intrinsic::getAttributes(ID id)" method.
Duncan Sands38ef3a82007-12-03 20:06:50 +0000925#define GET_INTRINSIC_ATTRIBUTES
Chandler Carruthdb25c6c2013-01-02 12:09:16 +0000926#include "llvm/IR/Intrinsics.gen"
Duncan Sands38ef3a82007-12-03 20:06:50 +0000927#undef GET_INTRINSIC_ATTRIBUTES
928
Benjamin Kramere6e19332011-07-14 17:45:39 +0000929Function *Intrinsic::getDeclaration(Module *M, ID id, ArrayRef<Type*> Tys) {
Duncan Sands38ef3a82007-12-03 20:06:50 +0000930 // There can never be multiple globals with the same name of different types,
931 // because intrinsics must be a specific type.
Duncan Sandsa8ff6ca2008-04-07 13:39:11 +0000932 return
Benjamin Kramere6e19332011-07-14 17:45:39 +0000933 cast<Function>(M->getOrInsertFunction(getName(id, Tys),
934 getType(M->getContext(), id, Tys)));
Jim Laskey2682ea62007-02-07 20:38:26 +0000935}
936
Dale Johannesenb842d522009-02-05 01:49:45 +0000937// This defines the "Intrinsic::getIntrinsicForGCCBuiltin()" method.
938#define GET_LLVM_INTRINSIC_FOR_GCC_BUILTIN
Chandler Carruthdb25c6c2013-01-02 12:09:16 +0000939#include "llvm/IR/Intrinsics.gen"
Dale Johannesenb842d522009-02-05 01:49:45 +0000940#undef GET_LLVM_INTRINSIC_FOR_GCC_BUILTIN
941
Saleem Abdulrasool4e63fc42014-07-04 18:42:25 +0000942// This defines the "Intrinsic::getIntrinsicForMSBuiltin()" method.
943#define GET_LLVM_INTRINSIC_FOR_MS_BUILTIN
944#include "llvm/IR/Intrinsics.gen"
945#undef GET_LLVM_INTRINSIC_FOR_MS_BUILTIN
946
Artur Pilipenkobc552272016-06-22 14:56:33 +0000947bool Intrinsic::matchIntrinsicType(Type *Ty, ArrayRef<Intrinsic::IITDescriptor> &Infos,
948 SmallVectorImpl<Type*> &ArgTys) {
949 using namespace Intrinsic;
950
951 // If we ran out of descriptors, there are too many arguments.
952 if (Infos.empty()) return true;
953 IITDescriptor D = Infos.front();
954 Infos = Infos.slice(1);
955
956 switch (D.Kind) {
957 case IITDescriptor::Void: return !Ty->isVoidTy();
958 case IITDescriptor::VarArg: return true;
959 case IITDescriptor::MMX: return !Ty->isX86_MMXTy();
960 case IITDescriptor::Token: return !Ty->isTokenTy();
961 case IITDescriptor::Metadata: return !Ty->isMetadataTy();
962 case IITDescriptor::Half: return !Ty->isHalfTy();
963 case IITDescriptor::Float: return !Ty->isFloatTy();
964 case IITDescriptor::Double: return !Ty->isDoubleTy();
965 case IITDescriptor::Integer: return !Ty->isIntegerTy(D.Integer_Width);
966 case IITDescriptor::Vector: {
967 VectorType *VT = dyn_cast<VectorType>(Ty);
968 return !VT || VT->getNumElements() != D.Vector_Width ||
969 matchIntrinsicType(VT->getElementType(), Infos, ArgTys);
970 }
971 case IITDescriptor::Pointer: {
972 PointerType *PT = dyn_cast<PointerType>(Ty);
973 return !PT || PT->getAddressSpace() != D.Pointer_AddressSpace ||
974 matchIntrinsicType(PT->getElementType(), Infos, ArgTys);
975 }
976
977 case IITDescriptor::Struct: {
978 StructType *ST = dyn_cast<StructType>(Ty);
979 if (!ST || ST->getNumElements() != D.Struct_NumElements)
980 return true;
981
982 for (unsigned i = 0, e = D.Struct_NumElements; i != e; ++i)
983 if (matchIntrinsicType(ST->getElementType(i), Infos, ArgTys))
984 return true;
985 return false;
986 }
987
988 case IITDescriptor::Argument:
989 // Two cases here - If this is the second occurrence of an argument, verify
990 // that the later instance matches the previous instance.
991 if (D.getArgumentNumber() < ArgTys.size())
992 return Ty != ArgTys[D.getArgumentNumber()];
993
994 // Otherwise, if this is the first instance of an argument, record it and
995 // verify the "Any" kind.
996 assert(D.getArgumentNumber() == ArgTys.size() && "Table consistency error");
997 ArgTys.push_back(Ty);
998
999 switch (D.getArgumentKind()) {
1000 case IITDescriptor::AK_Any: return false; // Success
1001 case IITDescriptor::AK_AnyInteger: return !Ty->isIntOrIntVectorTy();
1002 case IITDescriptor::AK_AnyFloat: return !Ty->isFPOrFPVectorTy();
1003 case IITDescriptor::AK_AnyVector: return !isa<VectorType>(Ty);
1004 case IITDescriptor::AK_AnyPointer: return !isa<PointerType>(Ty);
1005 }
1006 llvm_unreachable("all argument kinds not covered");
1007
1008 case IITDescriptor::ExtendArgument: {
1009 // This may only be used when referring to a previous vector argument.
1010 if (D.getArgumentNumber() >= ArgTys.size())
1011 return true;
1012
1013 Type *NewTy = ArgTys[D.getArgumentNumber()];
1014 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
1015 NewTy = VectorType::getExtendedElementVectorType(VTy);
1016 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
1017 NewTy = IntegerType::get(ITy->getContext(), 2 * ITy->getBitWidth());
1018 else
1019 return true;
1020
1021 return Ty != NewTy;
1022 }
1023 case IITDescriptor::TruncArgument: {
1024 // This may only be used when referring to a previous vector argument.
1025 if (D.getArgumentNumber() >= ArgTys.size())
1026 return true;
1027
1028 Type *NewTy = ArgTys[D.getArgumentNumber()];
1029 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
1030 NewTy = VectorType::getTruncatedElementVectorType(VTy);
1031 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
1032 NewTy = IntegerType::get(ITy->getContext(), ITy->getBitWidth() / 2);
1033 else
1034 return true;
1035
1036 return Ty != NewTy;
1037 }
1038 case IITDescriptor::HalfVecArgument:
1039 // This may only be used when referring to a previous vector argument.
1040 return D.getArgumentNumber() >= ArgTys.size() ||
1041 !isa<VectorType>(ArgTys[D.getArgumentNumber()]) ||
1042 VectorType::getHalfElementsVectorType(
1043 cast<VectorType>(ArgTys[D.getArgumentNumber()])) != Ty;
1044 case IITDescriptor::SameVecWidthArgument: {
1045 if (D.getArgumentNumber() >= ArgTys.size())
1046 return true;
1047 VectorType * ReferenceType =
Elena Demikhovskycaaceef2016-11-03 03:23:55 +00001048 dyn_cast<VectorType>(ArgTys[D.getArgumentNumber()]);
Artur Pilipenkobc552272016-06-22 14:56:33 +00001049 VectorType *ThisArgType = dyn_cast<VectorType>(Ty);
1050 if (!ThisArgType || !ReferenceType ||
1051 (ReferenceType->getVectorNumElements() !=
1052 ThisArgType->getVectorNumElements()))
1053 return true;
1054 return matchIntrinsicType(ThisArgType->getVectorElementType(),
1055 Infos, ArgTys);
1056 }
1057 case IITDescriptor::PtrToArgument: {
1058 if (D.getArgumentNumber() >= ArgTys.size())
1059 return true;
1060 Type * ReferenceType = ArgTys[D.getArgumentNumber()];
1061 PointerType *ThisArgType = dyn_cast<PointerType>(Ty);
1062 return (!ThisArgType || ThisArgType->getElementType() != ReferenceType);
1063 }
Elena Demikhovskycaaceef2016-11-03 03:23:55 +00001064 case IITDescriptor::PtrToElt: {
1065 if (D.getArgumentNumber() >= ArgTys.size())
1066 return true;
1067 VectorType * ReferenceType =
1068 dyn_cast<VectorType> (ArgTys[D.getArgumentNumber()]);
1069 PointerType *ThisArgType = dyn_cast<PointerType>(Ty);
1070
1071 return (!ThisArgType || !ReferenceType ||
1072 ThisArgType->getElementType() != ReferenceType->getElementType());
1073 }
Elad Cohenef5798a2017-05-03 12:28:54 +00001074 case IITDescriptor::VecOfAnyPtrsToElt: {
1075 unsigned RefArgNumber = D.getRefArgNumber();
1076
1077 // This may only be used when referring to a previous argument.
1078 if (RefArgNumber >= ArgTys.size())
Artur Pilipenkobc552272016-06-22 14:56:33 +00001079 return true;
Elad Cohenef5798a2017-05-03 12:28:54 +00001080
1081 // Record the overloaded type
1082 assert(D.getOverloadArgNumber() == ArgTys.size() &&
1083 "Table consistency error");
1084 ArgTys.push_back(Ty);
1085
1086 // Verify the overloaded type "matches" the Ref type.
1087 // i.e. Ty is a vector with the same width as Ref.
1088 // Composed of pointers to the same element type as Ref.
1089 VectorType *ReferenceType = dyn_cast<VectorType>(ArgTys[RefArgNumber]);
Artur Pilipenkobc552272016-06-22 14:56:33 +00001090 VectorType *ThisArgVecTy = dyn_cast<VectorType>(Ty);
1091 if (!ThisArgVecTy || !ReferenceType ||
1092 (ReferenceType->getVectorNumElements() !=
1093 ThisArgVecTy->getVectorNumElements()))
1094 return true;
1095 PointerType *ThisArgEltTy =
1096 dyn_cast<PointerType>(ThisArgVecTy->getVectorElementType());
1097 if (!ThisArgEltTy)
1098 return true;
1099 return ThisArgEltTy->getElementType() !=
1100 ReferenceType->getVectorElementType();
1101 }
1102 }
1103 llvm_unreachable("unhandled");
1104}
1105
Artur Pilipenkob68b8212016-06-24 14:47:27 +00001106bool
1107Intrinsic::matchIntrinsicVarArg(bool isVarArg,
1108 ArrayRef<Intrinsic::IITDescriptor> &Infos) {
1109 // If there are no descriptors left, then it can't be a vararg.
1110 if (Infos.empty())
1111 return isVarArg;
1112
1113 // There should be only one descriptor remaining at this point.
1114 if (Infos.size() != 1)
1115 return true;
1116
1117 // Check and verify the descriptor.
1118 IITDescriptor D = Infos.front();
1119 Infos = Infos.slice(1);
1120 if (D.Kind == IITDescriptor::VarArg)
1121 return !isVarArg;
1122
1123 return true;
1124}
1125
Artur Pilipenko6c7a8ab2016-06-24 15:10:29 +00001126Optional<Function*> Intrinsic::remangleIntrinsicFunction(Function *F) {
1127 Intrinsic::ID ID = F->getIntrinsicID();
1128 if (!ID)
1129 return None;
1130
1131 FunctionType *FTy = F->getFunctionType();
1132 // Accumulate an array of overloaded types for the given intrinsic
1133 SmallVector<Type *, 4> ArgTys;
1134 {
1135 SmallVector<Intrinsic::IITDescriptor, 8> Table;
1136 getIntrinsicInfoTableEntries(ID, Table);
1137 ArrayRef<Intrinsic::IITDescriptor> TableRef = Table;
1138
1139 // If we encounter any problems matching the signature with the descriptor
1140 // just give up remangling. It's up to verifier to report the discrepancy.
1141 if (Intrinsic::matchIntrinsicType(FTy->getReturnType(), TableRef, ArgTys))
1142 return None;
1143 for (auto Ty : FTy->params())
1144 if (Intrinsic::matchIntrinsicType(Ty, TableRef, ArgTys))
1145 return None;
1146 if (Intrinsic::matchIntrinsicVarArg(FTy->isVarArg(), TableRef))
1147 return None;
1148 }
1149
1150 StringRef Name = F->getName();
1151 if (Name == Intrinsic::getName(ID, ArgTys))
1152 return None;
1153
1154 auto NewDecl = Intrinsic::getDeclaration(F->getParent(), ID, ArgTys);
1155 NewDecl->setCallingConv(F->getCallingConv());
1156 assert(NewDecl->getFunctionType() == FTy && "Shouldn't change the signature");
1157 return NewDecl;
1158}
1159
Gabor Greif161cb042010-03-23 14:40:20 +00001160/// hasAddressTaken - returns true if there are any uses of this function
1161/// other than direct calls or invokes to it.
Gabor Greifa2fbc0a2010-03-24 13:21:49 +00001162bool Function::hasAddressTaken(const User* *PutOffender) const {
Chandler Carruthcdf47882014-03-09 03:16:01 +00001163 for (const Use &U : uses()) {
1164 const User *FU = U.getUser();
1165 if (isa<BlockAddress>(FU))
Jay Foadca0c4992012-05-12 08:30:16 +00001166 continue;
Richard Trieu7a083812016-02-18 22:09:30 +00001167 if (!isa<CallInst>(FU) && !isa<InvokeInst>(FU)) {
1168 if (PutOffender)
1169 *PutOffender = FU;
1170 return true;
1171 }
Chandler Carruthcdf47882014-03-09 03:16:01 +00001172 ImmutableCallSite CS(cast<Instruction>(FU));
Richard Trieu7a083812016-02-18 22:09:30 +00001173 if (!CS.isCallee(&U)) {
1174 if (PutOffender)
1175 *PutOffender = FU;
1176 return true;
1177 }
Jay Foad557169d2009-06-10 08:41:11 +00001178 }
1179 return false;
1180}
1181
Eli Friedman1923a332011-10-20 05:23:42 +00001182bool Function::isDefTriviallyDead() const {
1183 // Check the linkage
1184 if (!hasLinkOnceLinkage() && !hasLocalLinkage() &&
1185 !hasAvailableExternallyLinkage())
1186 return false;
1187
1188 // Check if the function is used by anything other than a blockaddress.
Chandler Carruthcdf47882014-03-09 03:16:01 +00001189 for (const User *U : users())
1190 if (!isa<BlockAddress>(U))
Eli Friedman1923a332011-10-20 05:23:42 +00001191 return false;
1192
1193 return true;
1194}
1195
Bill Wendling63a4ea12011-10-17 18:43:40 +00001196/// callsFunctionThatReturnsTwice - Return true if the function has a call to
1197/// setjmp or other function that gcc recognizes as "returning twice".
1198bool Function::callsFunctionThatReturnsTwice() const {
1199 for (const_inst_iterator
1200 I = inst_begin(this), E = inst_end(this); I != E; ++I) {
Mark Seaborn82711182014-01-14 04:20:01 +00001201 ImmutableCallSite CS(&*I);
1202 if (CS && CS.hasFnAttr(Attribute::ReturnsTwice))
Bill Wendling63a4ea12011-10-17 18:43:40 +00001203 return true;
1204 }
1205
1206 return false;
1207}
Peter Collingbourne3fa50f92013-09-16 01:08:15 +00001208
Vedant Kumar3a63fb32015-12-19 08:52:49 +00001209Constant *Function::getPersonalityFn() const {
1210 assert(hasPersonalityFn() && getNumOperands());
1211 return cast<Constant>(Op<0>());
Vedant Kumar1ab5ea52015-10-06 20:31:57 +00001212}
1213
Vedant Kumar3a63fb32015-12-19 08:52:49 +00001214void Function::setPersonalityFn(Constant *Fn) {
Keno Fischer9bc46b12015-12-23 18:27:23 +00001215 setHungoffOperand<0>(Fn);
Vedant Kumar3a63fb32015-12-19 08:52:49 +00001216 setValueSubclassDataBit(3, Fn != nullptr);
Vedant Kumar1ab5ea52015-10-06 20:31:57 +00001217}
1218
Peter Collingbourne3fa50f92013-09-16 01:08:15 +00001219Constant *Function::getPrefixData() const {
Vedant Kumar3a63fb32015-12-19 08:52:49 +00001220 assert(hasPrefixData() && getNumOperands());
1221 return cast<Constant>(Op<1>());
Peter Collingbourne3fa50f92013-09-16 01:08:15 +00001222}
1223
1224void Function::setPrefixData(Constant *PrefixData) {
Keno Fischer9bc46b12015-12-23 18:27:23 +00001225 setHungoffOperand<1>(PrefixData);
Vedant Kumar3a63fb32015-12-19 08:52:49 +00001226 setValueSubclassDataBit(1, PrefixData != nullptr);
Peter Collingbourne3fa50f92013-09-16 01:08:15 +00001227}
Peter Collingbourne51d2de72014-12-03 02:08:38 +00001228
1229Constant *Function::getPrologueData() const {
Vedant Kumar3a63fb32015-12-19 08:52:49 +00001230 assert(hasPrologueData() && getNumOperands());
1231 return cast<Constant>(Op<2>());
Peter Collingbourne51d2de72014-12-03 02:08:38 +00001232}
1233
1234void Function::setPrologueData(Constant *PrologueData) {
Keno Fischer9bc46b12015-12-23 18:27:23 +00001235 setHungoffOperand<2>(PrologueData);
Vedant Kumar3a63fb32015-12-19 08:52:49 +00001236 setValueSubclassDataBit(2, PrologueData != nullptr);
1237}
1238
1239void Function::allocHungoffUselist() {
1240 // If we've already allocated a uselist, stop here.
1241 if (getNumOperands())
Peter Collingbourne51d2de72014-12-03 02:08:38 +00001242 return;
1243
Vedant Kumar3a63fb32015-12-19 08:52:49 +00001244 allocHungoffUses(3, /*IsPhi=*/ false);
1245 setNumHungOffUseOperands(3);
1246
1247 // Initialize the uselist with placeholder operands to allow traversal.
1248 auto *CPN = ConstantPointerNull::get(Type::getInt1PtrTy(getContext(), 0));
1249 Op<0>().set(CPN);
1250 Op<1>().set(CPN);
1251 Op<2>().set(CPN);
1252}
1253
1254template <int Idx>
1255void Function::setHungoffOperand(Constant *C) {
Keno Fischer9bc46b12015-12-23 18:27:23 +00001256 if (C) {
1257 allocHungoffUselist();
1258 Op<Idx>().set(C);
1259 } else if (getNumOperands()) {
1260 Op<Idx>().set(
1261 ConstantPointerNull::get(Type::getInt1PtrTy(getContext(), 0)));
1262 }
Vedant Kumar3a63fb32015-12-19 08:52:49 +00001263}
1264
1265void Function::setValueSubclassDataBit(unsigned Bit, bool On) {
1266 assert(Bit < 16 && "SubclassData contains only 16 bits");
1267 if (On)
1268 setValueSubclassData(getSubclassDataFromValue() | (1 << Bit));
1269 else
1270 setValueSubclassData(getSubclassDataFromValue() & ~(1 << Bit));
Peter Collingbourne51d2de72014-12-03 02:08:38 +00001271}
Akira Hatanaka3058d0f2015-05-06 23:54:14 +00001272
Dehao Chena60cdd32017-02-28 18:09:44 +00001273void Function::setEntryCount(uint64_t Count,
1274 const DenseSet<GlobalValue::GUID> *S) {
Diego Novillo2567f3d2015-05-13 15:13:45 +00001275 MDBuilder MDB(getContext());
Dehao Chena60cdd32017-02-28 18:09:44 +00001276 setMetadata(LLVMContext::MD_prof, MDB.createFunctionEntryCount(Count, S));
Diego Novillo2567f3d2015-05-13 15:13:45 +00001277}
1278
1279Optional<uint64_t> Function::getEntryCount() const {
1280 MDNode *MD = getMetadata(LLVMContext::MD_prof);
1281 if (MD && MD->getOperand(0))
1282 if (MDString *MDS = dyn_cast<MDString>(MD->getOperand(0)))
1283 if (MDS->getString().equals("function_entry_count")) {
1284 ConstantInt *CI = mdconst::extract<ConstantInt>(MD->getOperand(1));
David Callahanc1c810d2016-08-05 18:38:19 +00001285 uint64_t Count = CI->getValue().getZExtValue();
1286 if (Count == 0)
1287 return None;
1288 return Count;
Diego Novillo2567f3d2015-05-13 15:13:45 +00001289 }
1290 return None;
1291}
Dehao Chen302b69c2016-10-18 20:42:47 +00001292
Dehao Chena60cdd32017-02-28 18:09:44 +00001293DenseSet<GlobalValue::GUID> Function::getImportGUIDs() const {
1294 DenseSet<GlobalValue::GUID> R;
1295 if (MDNode *MD = getMetadata(LLVMContext::MD_prof))
1296 if (MDString *MDS = dyn_cast<MDString>(MD->getOperand(0)))
1297 if (MDS->getString().equals("function_entry_count"))
1298 for (unsigned i = 2; i < MD->getNumOperands(); i++)
1299 R.insert(mdconst::extract<ConstantInt>(MD->getOperand(i))
1300 ->getValue()
1301 .getZExtValue());
1302 return R;
1303}
1304
Dehao Chen302b69c2016-10-18 20:42:47 +00001305void Function::setSectionPrefix(StringRef Prefix) {
1306 MDBuilder MDB(getContext());
1307 setMetadata(LLVMContext::MD_section_prefix,
1308 MDB.createFunctionSectionPrefix(Prefix));
1309}
1310
1311Optional<StringRef> Function::getSectionPrefix() const {
1312 if (MDNode *MD = getMetadata(LLVMContext::MD_section_prefix)) {
1313 assert(dyn_cast<MDString>(MD->getOperand(0))
1314 ->getString()
1315 .equals("function_section_prefix") &&
1316 "Metadata not match");
1317 return dyn_cast<MDString>(MD->getOperand(1))->getString();
1318 }
1319 return None;
1320}