blob: 6e1b4765270cfdb0154b4f5fedf8049fd294678f [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<Argument>;
34template class llvm::SymbolTableListTraits<BasicBlock>;
Chris Lattner2f7c9632001-06-06 20:29:01 +000035
Chris Lattnerda975502001-09-10 07:58:01 +000036//===----------------------------------------------------------------------===//
Chris Lattnerd255ae22002-04-09 19:39:35 +000037// Argument Implementation
38//===----------------------------------------------------------------------===//
39
David Blaikiea379b1812011-12-20 02:50:00 +000040void Argument::anchor() { }
41
Reid Klecknerc9a392b2017-03-16 22:58:56 +000042Argument::Argument(Type *Ty, const Twine &Name, unsigned ArgNo)
43 : Value(Ty, Value::ArgumentVal), Parent(nullptr), ArgNo(ArgNo) {
Chris Lattner32ab6432007-02-12 05:18:08 +000044 setName(Name);
Chris Lattner9ed7aef2002-09-06 21:33:15 +000045}
46
Chris Lattner9ed7aef2002-09-06 21:33:15 +000047void Argument::setParent(Function *parent) {
48 Parent = parent;
49}
50
Nick Lewyckyd52b1522014-05-20 01:23:40 +000051bool Argument::hasNonNullAttr() const {
52 if (!getType()->isPointerTy()) return false;
Hal Finkelb0407ba2014-07-18 15:51:28 +000053 if (getParent()->getAttributes().
54 hasAttribute(getArgNo()+1, Attribute::NonNull))
55 return true;
56 else if (getDereferenceableBytes() > 0 &&
57 getType()->getPointerAddressSpace() == 0)
58 return true;
59 return false;
Nick Lewyckyd52b1522014-05-20 01:23:40 +000060}
61
Chris Lattnere30f09d2008-01-24 17:47:11 +000062bool Argument::hasByValAttr() const {
Duncan Sands19d0b472010-02-16 11:11:14 +000063 if (!getType()->isPointerTy()) return false;
Amaury Sechet7b05a4c2016-03-14 01:37:29 +000064 return hasAttribute(Attribute::ByVal);
Chris Lattnere30f09d2008-01-24 17:47:11 +000065}
66
Manman Renf46262e2016-03-29 17:37:21 +000067bool Argument::hasSwiftSelfAttr() const {
68 return getParent()->getAttributes().
69 hasAttribute(getArgNo()+1, Attribute::SwiftSelf);
70}
71
Manman Ren9bfd0d02016-04-01 21:41:15 +000072bool Argument::hasSwiftErrorAttr() const {
73 return getParent()->getAttributes().
74 hasAttribute(getArgNo()+1, Attribute::SwiftError);
75}
76
Reid Klecknera534a382013-12-19 02:14:12 +000077bool Argument::hasInAllocaAttr() const {
78 if (!getType()->isPointerTy()) return false;
Amaury Sechet7b05a4c2016-03-14 01:37:29 +000079 return hasAttribute(Attribute::InAlloca);
Reid Klecknera534a382013-12-19 02:14:12 +000080}
81
Reid Kleckner436c42e2014-01-17 23:58:17 +000082bool Argument::hasByValOrInAllocaAttr() const {
83 if (!getType()->isPointerTy()) return false;
84 AttributeSet Attrs = getParent()->getAttributes();
85 return Attrs.hasAttribute(getArgNo() + 1, Attribute::ByVal) ||
86 Attrs.hasAttribute(getArgNo() + 1, Attribute::InAlloca);
87}
88
Chris Lattner4d37d992011-05-22 23:57:23 +000089unsigned Argument::getParamAlignment() const {
90 assert(getType()->isPointerTy() && "Only pointers have alignments");
91 return getParent()->getParamAlignment(getArgNo()+1);
Michael Ilsemanacdb76d2012-12-17 20:37:55 +000092
Chris Lattner4d37d992011-05-22 23:57:23 +000093}
94
Hal Finkelb0407ba2014-07-18 15:51:28 +000095uint64_t Argument::getDereferenceableBytes() const {
96 assert(getType()->isPointerTy() &&
97 "Only pointers have dereferenceable bytes");
98 return getParent()->getDereferenceableBytes(getArgNo()+1);
99}
100
Sanjoy Das06cf33f2015-05-06 17:41:54 +0000101uint64_t Argument::getDereferenceableOrNullBytes() const {
102 assert(getType()->isPointerTy() &&
103 "Only pointers have dereferenceable bytes");
104 return getParent()->getDereferenceableOrNullBytes(getArgNo()+1);
105}
106
Duncan Sands5d96f3f2009-12-11 08:36:17 +0000107bool Argument::hasNestAttr() const {
Duncan Sands19d0b472010-02-16 11:11:14 +0000108 if (!getType()->isPointerTy()) return false;
Amaury Sechet7b05a4c2016-03-14 01:37:29 +0000109 return hasAttribute(Attribute::Nest);
Duncan Sands5d96f3f2009-12-11 08:36:17 +0000110}
111
Chris Lattnere30f09d2008-01-24 17:47:11 +0000112bool Argument::hasNoAliasAttr() const {
Duncan Sands19d0b472010-02-16 11:11:14 +0000113 if (!getType()->isPointerTy()) return false;
Amaury Sechet7b05a4c2016-03-14 01:37:29 +0000114 return hasAttribute(Attribute::NoAlias);
Chris Lattnere30f09d2008-01-24 17:47:11 +0000115}
116
Duncan Sandsdf128eb2008-12-31 18:08:59 +0000117bool Argument::hasNoCaptureAttr() const {
Duncan Sands19d0b472010-02-16 11:11:14 +0000118 if (!getType()->isPointerTy()) return false;
Amaury Sechet7b05a4c2016-03-14 01:37:29 +0000119 return hasAttribute(Attribute::NoCapture);
Duncan Sandsdf128eb2008-12-31 18:08:59 +0000120}
121
Owen Andersonc64dfb42008-02-17 23:22:28 +0000122bool Argument::hasStructRetAttr() const {
Duncan Sands19d0b472010-02-16 11:11:14 +0000123 if (!getType()->isPointerTy()) return false;
Amaury Sechet7b05a4c2016-03-14 01:37:29 +0000124 return hasAttribute(Attribute::StructRet);
Owen Andersonc64dfb42008-02-17 23:22:28 +0000125}
126
Stephen Linb8bd2322013-04-20 05:14:40 +0000127bool Argument::hasReturnedAttr() const {
Amaury Sechet7b05a4c2016-03-14 01:37:29 +0000128 return hasAttribute(Attribute::Returned);
Stephen Linb8bd2322013-04-20 05:14:40 +0000129}
130
Juergen Ributzka384c3b52014-08-05 05:43:41 +0000131bool Argument::hasZExtAttr() const {
Amaury Sechet7b05a4c2016-03-14 01:37:29 +0000132 return hasAttribute(Attribute::ZExt);
Juergen Ributzka384c3b52014-08-05 05:43:41 +0000133}
134
Juergen Ributzka384c3b52014-08-05 05:43:41 +0000135bool Argument::hasSExtAttr() const {
Amaury Sechet7b05a4c2016-03-14 01:37:29 +0000136 return hasAttribute(Attribute::SExt);
Juergen Ributzka384c3b52014-08-05 05:43:41 +0000137}
138
Nick Lewyckyc2ec0722013-07-06 00:29:58 +0000139bool Argument::onlyReadsMemory() const {
140 return getParent()->getAttributes().
141 hasAttribute(getArgNo()+1, Attribute::ReadOnly) ||
142 getParent()->getAttributes().
143 hasAttribute(getArgNo()+1, Attribute::ReadNone);
144}
145
Bill Wendling49bc76c2013-01-23 06:14:59 +0000146void Argument::addAttr(AttributeSet AS) {
Bill Wendlingefbbbfd2013-02-21 19:46:51 +0000147 assert(AS.getNumSlots() <= 1 &&
Bill Wendling1c20ff02013-02-20 23:04:11 +0000148 "Trying to add more than one attribute set to an argument!");
149 AttrBuilder B(AS, AS.getSlotIndex(0));
150 getParent()->addAttributes(getArgNo() + 1,
151 AttributeSet::get(Parent->getContext(),
152 getArgNo() + 1, B));
Gordon Henriksen2d9cc212008-04-28 17:37:06 +0000153}
Chris Lattnere30f09d2008-01-24 17:47:11 +0000154
Bill Wendling49bc76c2013-01-23 06:14:59 +0000155void Argument::removeAttr(AttributeSet AS) {
Bill Wendlingefbbbfd2013-02-21 19:46:51 +0000156 assert(AS.getNumSlots() <= 1 &&
Bill Wendling1c20ff02013-02-20 23:04:11 +0000157 "Trying to remove more than one attribute set from an argument!");
158 AttrBuilder B(AS, AS.getSlotIndex(0));
159 getParent()->removeAttributes(getArgNo() + 1,
160 AttributeSet::get(Parent->getContext(),
161 getArgNo() + 1, B));
Duncan Sands66336db2008-07-08 09:41:30 +0000162}
Chris Lattnere30f09d2008-01-24 17:47:11 +0000163
Amaury Sechet7b05a4c2016-03-14 01:37:29 +0000164bool Argument::hasAttribute(Attribute::AttrKind Kind) const {
165 return getParent()->hasAttribute(getArgNo() + 1, Kind);
166}
167
Chris Lattnerd255ae22002-04-09 19:39:35 +0000168//===----------------------------------------------------------------------===//
Chris Lattner3e13b8c2008-01-02 23:42:30 +0000169// Helper Methods in Function
Reid Spencer019c8862007-04-09 15:01:12 +0000170//===----------------------------------------------------------------------===//
171
Owen Anderson47db9412009-07-22 00:24:57 +0000172LLVMContext &Function::getContext() const {
173 return getType()->getContext();
Owen Anderson0a2c4582009-07-02 18:03:58 +0000174}
175
Chris Lattner3e13b8c2008-01-02 23:42:30 +0000176void Function::removeFromParent() {
Duncan P. N. Exon Smith52888a62015-10-08 23:49:46 +0000177 getParent()->getFunctionList().remove(getIterator());
Duncan Sands185eeac2007-11-25 14:10:56 +0000178}
179
Chris Lattner3e13b8c2008-01-02 23:42:30 +0000180void Function::eraseFromParent() {
Duncan P. N. Exon Smith52888a62015-10-08 23:49:46 +0000181 getParent()->getFunctionList().erase(getIterator());
Reid Spencer019c8862007-04-09 15:01:12 +0000182}
183
Reid Spencer019c8862007-04-09 15:01:12 +0000184//===----------------------------------------------------------------------===//
Chris Lattner57698e22002-03-26 18:01:55 +0000185// Function Implementation
Chris Lattnerda975502001-09-10 07:58:01 +0000186//===----------------------------------------------------------------------===//
187
Rafael Espindola1b47a282014-10-23 15:20:05 +0000188Function::Function(FunctionType *Ty, LinkageTypes Linkage, const Twine &name,
189 Module *ParentModule)
David Blaikied583b192015-08-21 21:35:28 +0000190 : GlobalObject(Ty, Value::FunctionVal,
David Blaikieab105bb2016-01-15 23:07:58 +0000191 OperandTraits<Function>::op_begin(this), 0, Linkage, name) {
Chris Lattner654695b2009-01-05 07:58:59 +0000192 assert(FunctionType::isValidReturnType(getReturnType()) &&
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000193 "invalid return type");
Duncan P. N. Exon Smith4472b772015-04-24 20:47:23 +0000194 setGlobalObjectSubClassData(0);
Mehdi Aminia53d49e2016-09-17 06:00:02 +0000195
196 // We only need a symbol table for a function if the context keeps value names
197 if (!getContext().shouldDiscardValueNames())
198 SymTab = make_unique<ValueSymbolTable>();
Chris Lattner6213ae02002-09-06 20:46:32 +0000199
Chris Lattnere2de9082007-08-18 06:14:52 +0000200 // If the function has arguments, mark them as lazily built.
201 if (Ty->getNumParams())
Chris Lattnerb9c86512009-12-29 02:14:09 +0000202 setValueSubclassData(1); // Set the "has lazy arguments" bit.
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000203
Chris Lattner6213ae02002-09-06 20:46:32 +0000204 if (ParentModule)
205 ParentModule->getFunctionList().push_back(this);
Duncan Sandsa8ff6ca2008-04-07 13:39:11 +0000206
Justin Lebar291abd32016-12-28 22:59:45 +0000207 HasLLVMReservedName = getName().startswith("llvm.");
Duncan Sandsa8ff6ca2008-04-07 13:39:11 +0000208 // Ensure intrinsics have the right parameter attributes.
Pete Coopera7c0c182015-05-19 00:24:26 +0000209 // Note, the IntID field will have been set in Value::setName if this function
210 // name is a valid intrinsic ID.
211 if (IntID)
212 setAttributes(Intrinsic::getAttributes(getContext(), IntID));
Chris Lattner2f7c9632001-06-06 20:29:01 +0000213}
214
Gordon Henriksen14a55692007-12-10 02:14:30 +0000215Function::~Function() {
216 dropAllReferences(); // After this it is safe to delete instructions.
Chris Lattner2f7c9632001-06-06 20:29:01 +0000217
Chris Lattner2f7c9632001-06-06 20:29:01 +0000218 // Delete all of the method arguments and unlink from symbol table...
Gordon Henriksen14a55692007-12-10 02:14:30 +0000219 ArgumentList.clear();
Reid Spencerc6a83842007-04-22 17:28:03 +0000220
Gordon Henriksend930f912008-08-17 18:44:35 +0000221 // Remove the function from the on-the-side GC table.
222 clearGC();
Chris Lattner2f7c9632001-06-06 20:29:01 +0000223}
224
Chris Lattnere2de9082007-08-18 06:14:52 +0000225void Function::BuildLazyArguments() const {
226 // Create the arguments vector, all arguments start out unnamed.
Chris Lattner229907c2011-07-18 04:54:35 +0000227 FunctionType *FT = getFunctionType();
Chris Lattnere2de9082007-08-18 06:14:52 +0000228 for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) {
Benjamin Kramerccce8ba2010-01-05 13:12:22 +0000229 assert(!FT->getParamType(i)->isVoidTy() &&
Chris Lattnere2de9082007-08-18 06:14:52 +0000230 "Cannot have void typed arguments!");
Reid Klecknereb549092017-03-16 22:25:45 +0000231 ArgumentList.push_back(
Reid Klecknerc9a392b2017-03-16 22:58:56 +0000232 new Argument(FT->getParamType(i), "", i));
Chris Lattnere2de9082007-08-18 06:14:52 +0000233 }
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000234
Chris Lattnere2de9082007-08-18 06:14:52 +0000235 // Clear the lazy arguments bit.
Chris Lattnerb9c86512009-12-29 02:14:09 +0000236 unsigned SDC = getSubclassDataFromValue();
Peter Collingbourne51d2de72014-12-03 02:08:38 +0000237 const_cast<Function*>(this)->setValueSubclassData(SDC &= ~(1<<0));
Chris Lattnere2de9082007-08-18 06:14:52 +0000238}
239
Duncan P. N. Exon Smithbdfc9842016-04-06 06:38:15 +0000240void Function::stealArgumentListFrom(Function &Src) {
241 assert(isDeclaration() && "Expected no references to current arguments");
242
243 // Drop the current arguments, if any, and set the lazy argument bit.
244 if (!hasLazyArguments()) {
245 assert(llvm::all_of(ArgumentList,
246 [](const Argument &A) { return A.use_empty(); }) &&
247 "Expected arguments to be unused in declaration");
248 ArgumentList.clear();
249 setValueSubclassData(getSubclassDataFromValue() | (1 << 0));
250 }
251
252 // Nothing to steal if Src has lazy arguments.
253 if (Src.hasLazyArguments())
254 return;
255
256 // Steal arguments from Src, and fix the lazy argument bits.
257 ArgumentList.splice(ArgumentList.end(), Src.ArgumentList);
258 setValueSubclassData(getSubclassDataFromValue() & ~(1 << 0));
259 Src.setValueSubclassData(Src.getSubclassDataFromValue() | (1 << 0));
260}
261
Chris Lattner2f7c9632001-06-06 20:29:01 +0000262// dropAllReferences() - This function causes all the subinstructions to "let
263// go" of all references that they are maintaining. This allows one to
264// 'delete' a whole class at a time, even though there may be circular
265// references... first all references are dropped, and all use counts go to
Misha Brukmanfa100532003-10-10 17:54:14 +0000266// zero. Then everything is deleted for real. Note that no operations are
Misha Brukmanb1c93172005-04-21 23:48:37 +0000267// valid on an object that has "dropped all references", except operator
Chris Lattner2f7c9632001-06-06 20:29:01 +0000268// delete.
269//
Chris Lattner4e8c4872002-03-23 22:51:58 +0000270void Function::dropAllReferences() {
Rafael Espindolad4bcefc2014-10-24 18:13:04 +0000271 setIsMaterializable(false);
272
Benjamin Krameraf28e7d2016-06-26 14:10:56 +0000273 for (BasicBlock &BB : *this)
274 BB.dropAllReferences();
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000275
Dan Gohmanf844b3b2010-12-07 19:56:51 +0000276 // Delete all basic blocks. They are now unused, except possibly by
277 // blockaddresses, but BasicBlock's destructor takes care of those.
278 while (!BasicBlocks.empty())
279 BasicBlocks.begin()->eraseFromParent();
Peter Collingbourne3fa50f92013-09-16 01:08:15 +0000280
Vedant Kumar3a63fb32015-12-19 08:52:49 +0000281 // Drop uses of any optional data (real or placeholder).
282 if (getNumOperands()) {
283 User::dropAllReferences();
284 setNumHungOffUseOperands(0);
285 setValueSubclassData(getSubclassDataFromValue() & ~0xe);
286 }
Duncan P. N. Exon Smithe2510cd2015-04-24 21:51:02 +0000287
288 // Metadata is stored in a side-table.
289 clearMetadata();
Chris Lattner2f7c9632001-06-06 20:29:01 +0000290}
Chris Lattnerda975502001-09-10 07:58:01 +0000291
Amaury Sechet392638d2016-06-14 20:27:35 +0000292void Function::addAttribute(unsigned i, Attribute::AttrKind Kind) {
Bill Wendlinge94d8432012-12-07 23:16:57 +0000293 AttributeSet PAL = getAttributes();
Amaury Sechet392638d2016-06-14 20:27:35 +0000294 PAL = PAL.addAttribute(getContext(), i, Kind);
Devang Patel4c758ea2008-09-25 21:00:45 +0000295 setAttributes(PAL);
Eric Christopher901b1a72008-05-16 20:39:43 +0000296}
297
Amaury Sechet5db224e2016-06-12 06:17:24 +0000298void Function::addAttribute(unsigned i, Attribute Attr) {
299 AttributeSet PAL = getAttributes();
300 PAL = PAL.addAttribute(getContext(), i, Attr);
301 setAttributes(PAL);
302}
303
Amaury Sechet392638d2016-06-14 20:27:35 +0000304void Function::addAttributes(unsigned i, AttributeSet Attrs) {
Bill Wendlinge94d8432012-12-07 23:16:57 +0000305 AttributeSet PAL = getAttributes();
Amaury Sechet392638d2016-06-14 20:27:35 +0000306 PAL = PAL.addAttributes(getContext(), i, Attrs);
Bill Wendlingc0e2a1f2013-01-23 00:20:53 +0000307 setAttributes(PAL);
308}
309
Amaury Sechet392638d2016-06-14 20:27:35 +0000310void Function::removeAttribute(unsigned i, Attribute::AttrKind Kind) {
Amaury Sechet7b05a4c2016-03-14 01:37:29 +0000311 AttributeSet PAL = getAttributes();
Amaury Sechet392638d2016-06-14 20:27:35 +0000312 PAL = PAL.removeAttribute(getContext(), i, Kind);
Amaury Sechet7b05a4c2016-03-14 01:37:29 +0000313 setAttributes(PAL);
314}
315
Amaury Sechet6100adf2016-06-15 17:50:39 +0000316void Function::removeAttribute(unsigned i, StringRef Kind) {
317 AttributeSet PAL = getAttributes();
318 PAL = PAL.removeAttribute(getContext(), i, Kind);
319 setAttributes(PAL);
320}
321
Amaury Sechet392638d2016-06-14 20:27:35 +0000322void Function::removeAttributes(unsigned i, AttributeSet Attrs) {
Bill Wendlingc0e2a1f2013-01-23 00:20:53 +0000323 AttributeSet PAL = getAttributes();
Amaury Sechet392638d2016-06-14 20:27:35 +0000324 PAL = PAL.removeAttributes(getContext(), i, Attrs);
Devang Patel4c758ea2008-09-25 21:00:45 +0000325 setAttributes(PAL);
Duncan Sands66336db2008-07-08 09:41:30 +0000326}
327
Ramkumar Ramachandra8fcb4982015-02-14 19:37:54 +0000328void Function::addDereferenceableAttr(unsigned i, uint64_t Bytes) {
329 AttributeSet PAL = getAttributes();
330 PAL = PAL.addDereferenceableAttr(getContext(), i, Bytes);
331 setAttributes(PAL);
332}
333
Sanjoy Das31ea6d12015-04-16 20:29:50 +0000334void Function::addDereferenceableOrNullAttr(unsigned i, uint64_t Bytes) {
335 AttributeSet PAL = getAttributes();
336 PAL = PAL.addDereferenceableOrNullAttr(getContext(), i, Bytes);
337 setAttributes(PAL);
338}
339
Mehdi Amini599ebf22016-01-08 02:28:20 +0000340const std::string &Function::getGC() const {
Gordon Henriksend930f912008-08-17 18:44:35 +0000341 assert(hasGC() && "Function has no collector");
Mehdi Amini599ebf22016-01-08 02:28:20 +0000342 return getContext().getGC(*this);
Gordon Henriksen71183b62007-12-10 03:18:06 +0000343}
344
Benjamin Kramer728f4442016-05-29 10:46:35 +0000345void Function::setGC(std::string Str) {
Mehdi Amini599ebf22016-01-08 02:28:20 +0000346 setValueSubclassDataBit(14, !Str.empty());
347 getContext().setGC(*this, std::move(Str));
Gordon Henriksen71183b62007-12-10 03:18:06 +0000348}
349
Gordon Henriksend930f912008-08-17 18:44:35 +0000350void Function::clearGC() {
Mehdi Amini599ebf22016-01-08 02:28:20 +0000351 if (!hasGC())
352 return;
353 getContext().deleteGC(*this);
354 setValueSubclassDataBit(14, false);
Gordon Henriksen71183b62007-12-10 03:18:06 +0000355}
356
Rafael Espindola769efe62015-12-02 20:03:17 +0000357/// Copy all additional attributes (those not needed to create a Function) from
358/// the Function Src to this one.
Duncan Sandsdd7daee2008-05-26 19:58:59 +0000359void Function::copyAttributesFrom(const GlobalValue *Src) {
Rafael Espindola99e05cf2014-05-13 18:45:48 +0000360 GlobalObject::copyAttributesFrom(Src);
Rafael Espindola769efe62015-12-02 20:03:17 +0000361 const Function *SrcF = dyn_cast<Function>(Src);
362 if (!SrcF)
363 return;
364
Duncan Sandsdd7daee2008-05-26 19:58:59 +0000365 setCallingConv(SrcF->getCallingConv());
Devang Patel4c758ea2008-09-25 21:00:45 +0000366 setAttributes(SrcF->getAttributes());
Gordon Henriksend930f912008-08-17 18:44:35 +0000367 if (SrcF->hasGC())
368 setGC(SrcF->getGC());
369 else
370 clearGC();
Vedant Kumar44dd9872015-12-19 08:48:43 +0000371 if (SrcF->hasPersonalityFn())
372 setPersonalityFn(SrcF->getPersonalityFn());
Vedant Kumar3a63fb32015-12-19 08:52:49 +0000373 if (SrcF->hasPrefixData())
374 setPrefixData(SrcF->getPrefixData());
375 if (SrcF->hasPrologueData())
376 setPrologueData(SrcF->getPrologueData());
Duncan Sandsdd7daee2008-05-26 19:58:59 +0000377}
378
Reid Kleckner0b5220d2016-01-26 02:06:41 +0000379/// Table of string intrinsic names indexed by enum value.
380static const char * const IntrinsicNameTable[] = {
381 "not_intrinsic",
382#define GET_INTRINSIC_NAME_TABLE
383#include "llvm/IR/Intrinsics.gen"
384#undef GET_INTRINSIC_NAME_TABLE
385};
386
Justin Bogner92a8c612016-07-15 16:31:37 +0000387/// Table of per-target intrinsic name tables.
388#define GET_INTRINSIC_TARGET_DATA
389#include "llvm/IR/Intrinsics.gen"
390#undef GET_INTRINSIC_TARGET_DATA
391
392/// Find the segment of \c IntrinsicNameTable for intrinsics with the same
393/// target as \c Name, or the generic table if \c Name is not target specific.
394///
395/// Returns the relevant slice of \c IntrinsicNameTable
396static ArrayRef<const char *> findTargetSubtable(StringRef Name) {
397 assert(Name.startswith("llvm."));
398
399 ArrayRef<IntrinsicTargetInfo> Targets(TargetInfos);
400 // Drop "llvm." and take the first dotted component. That will be the target
401 // if this is target specific.
402 StringRef Target = Name.drop_front(5).split('.').first;
403 auto It = std::lower_bound(Targets.begin(), Targets.end(), Target,
404 [](const IntrinsicTargetInfo &TI,
405 StringRef Target) { return TI.Name < Target; });
406 // We've either found the target or just fall back to the generic set, which
407 // is always first.
408 const auto &TI = It != Targets.end() && It->Name == Target ? *It : Targets[0];
409 return makeArrayRef(&IntrinsicNameTable[1] + TI.Offset, TI.Count);
410}
411
Pete Cooper21241132015-05-19 00:02:25 +0000412/// \brief This does the actual lookup of an intrinsic ID which
413/// matches the given function name.
Tim Northover6b3bd612016-07-29 20:32:59 +0000414Intrinsic::ID Function::lookupIntrinsicID(StringRef Name) {
Justin Bogner92a8c612016-07-15 16:31:37 +0000415 ArrayRef<const char *> NameTable = findTargetSubtable(Name);
Reid Klecknerc2752da2016-01-26 22:33:19 +0000416 int Idx = Intrinsic::lookupLLVMIntrinsicByName(NameTable, Name);
Justin Bogner92a8c612016-07-15 16:31:37 +0000417 if (Idx == -1)
418 return Intrinsic::not_intrinsic;
419
420 // Intrinsic IDs correspond to the location in IntrinsicNameTable, but we have
421 // an index into a sub-table.
422 int Adjust = NameTable.data() - IntrinsicNameTable;
423 Intrinsic::ID ID = static_cast<Intrinsic::ID>(Idx + Adjust);
Pete Cooper21241132015-05-19 00:02:25 +0000424
Reid Kleckner0b5220d2016-01-26 02:06:41 +0000425 // If the intrinsic is not overloaded, require an exact match. If it is
426 // overloaded, require a prefix match.
427 bool IsPrefixMatch = Name.size() > strlen(NameTable[Idx]);
428 return IsPrefixMatch == isOverloaded(ID) ? ID : Intrinsic::not_intrinsic;
Pete Cooper21241132015-05-19 00:02:25 +0000429}
430
Pete Coopera7c0c182015-05-19 00:24:26 +0000431void Function::recalculateIntrinsicID() {
Justin Lebar291abd32016-12-28 22:59:45 +0000432 StringRef Name = getName();
433 if (!Name.startswith("llvm.")) {
434 HasLLVMReservedName = false;
Pete Coopera7c0c182015-05-19 00:24:26 +0000435 IntID = Intrinsic::not_intrinsic;
436 return;
Michael Ilseman516d7032013-03-01 18:48:54 +0000437 }
Justin Lebar291abd32016-12-28 22:59:45 +0000438 HasLLVMReservedName = true;
439 IntID = lookupIntrinsicID(Name);
Michael Ilseman516d7032013-03-01 18:48:54 +0000440}
441
Philip Reames319c48e2014-11-12 00:21:51 +0000442/// Returns a stable mangling for the type specified for use in the name
Philip Reames059ecbf2014-11-24 23:24:24 +0000443/// mangling scheme used by 'any' types in intrinsic signatures. The mangling
444/// of named types is simply their name. Manglings for unnamed types consist
445/// of a prefix ('p' for pointers, 'a' for arrays, 'f_' for functions)
446/// combined with the mangling of their component types. A vararg function
447/// type will have a suffix of 'vararg'. Since function types can contain
448/// other function types, we close a function type mangling with suffix 'f'
449/// which can't be confused with it's prefix. This ensures we don't have
450/// collisions between two unrelated function types. Otherwise, you might
451/// parse ffXX as f(fXX) or f(fX)X. (X is a placeholder for any other type.)
Philip Reames8d5d68f2015-01-14 23:05:17 +0000452/// Manglings of integers, floats, and vectors ('i', 'f', and 'v' prefix in most
453/// cases) fall back to the MVT codepath, where they could be mangled to
454/// 'x86mmx', for example; matching on derived types is not sufficient to mangle
455/// everything.
Philip Reames319c48e2014-11-12 00:21:51 +0000456static std::string getMangledTypeStr(Type* Ty) {
457 std::string Result;
458 if (PointerType* PTyp = dyn_cast<PointerType>(Ty)) {
459 Result += "p" + llvm::utostr(PTyp->getAddressSpace()) +
460 getMangledTypeStr(PTyp->getElementType());
461 } else if (ArrayType* ATyp = dyn_cast<ArrayType>(Ty)) {
462 Result += "a" + llvm::utostr(ATyp->getNumElements()) +
463 getMangledTypeStr(ATyp->getElementType());
Daniel Berlin3c1432f2017-02-15 23:16:20 +0000464 } else if (StructType *STyp = dyn_cast<StructType>(Ty)) {
465 if (!STyp->isLiteral()) {
466 Result += "s_";
467 Result += STyp->getName();
468 } else {
469 Result += "sl_";
470 for (auto Elem : STyp->elements())
471 Result += getMangledTypeStr(Elem);
472 }
473 // Ensure nested structs are distinguishable.
474 Result += "s";
475 } else if (FunctionType *FT = dyn_cast<FunctionType>(Ty)) {
Philip Reames319c48e2014-11-12 00:21:51 +0000476 Result += "f_" + getMangledTypeStr(FT->getReturnType());
477 for (size_t i = 0; i < FT->getNumParams(); i++)
478 Result += getMangledTypeStr(FT->getParamType(i));
479 if (FT->isVarArg())
480 Result += "vararg";
Philip Reames059ecbf2014-11-24 23:24:24 +0000481 // Ensure nested function types are distinguishable.
482 Result += "f";
Elena Demikhovsky1ca72e12015-11-19 07:17:16 +0000483 } else if (isa<VectorType>(Ty))
484 Result += "v" + utostr(Ty->getVectorNumElements()) +
485 getMangledTypeStr(Ty->getVectorElementType());
486 else if (Ty)
Philip Reames319c48e2014-11-12 00:21:51 +0000487 Result += EVT::getEVT(Ty).getEVTString();
488 return Result;
489}
490
Pete Coopera8db71e2016-08-18 18:30:54 +0000491StringRef Intrinsic::getName(ID id) {
492 assert(id < num_intrinsics && "Invalid intrinsic ID!");
Pete Coopera5f8c722016-08-22 20:18:28 +0000493 assert(!isOverloaded(id) &&
494 "This version of getName does not support overloading");
Pete Coopera8db71e2016-08-18 18:30:54 +0000495 return IntrinsicNameTable[id];
496}
497
Benjamin Kramere6e19332011-07-14 17:45:39 +0000498std::string Intrinsic::getName(ID id, ArrayRef<Type*> Tys) {
Chris Lattner71b8c982006-03-25 06:32:47 +0000499 assert(id < num_intrinsics && "Invalid intrinsic ID!");
Reid Kleckner0b5220d2016-01-26 02:06:41 +0000500 std::string Result(IntrinsicNameTable[id]);
Benjamin Krameraf28e7d2016-06-26 14:10:56 +0000501 for (Type *Ty : Tys) {
502 Result += "." + getMangledTypeStr(Ty);
Mon P Wang2c839d42008-07-30 04:36:53 +0000503 }
Reid Spencer2a2117c2007-04-01 07:25:33 +0000504 return Result;
Chris Lattner71b8c982006-03-25 06:32:47 +0000505}
506
Chris Lattner7f0e7ba2012-05-16 06:34:44 +0000507
Chris Lattnerf39c2782012-05-27 18:28:35 +0000508/// IIT_Info - These are enumerators that describe the entries returned by the
509/// getIntrinsicInfoTableEntries function.
510///
511/// NOTE: This must be kept in synch with the copy in TblGen/IntrinsicEmitter!
512enum IIT_Info {
Robert Khasanov65c27562014-10-20 19:25:05 +0000513 // Common values should be encoded with 0-15.
Chris Lattnerf39c2782012-05-27 18:28:35 +0000514 IIT_Done = 0,
515 IIT_I1 = 1,
516 IIT_I8 = 2,
517 IIT_I16 = 3,
518 IIT_I32 = 4,
519 IIT_I64 = 5,
Michael Ilseman6c6d7152013-01-11 01:45:05 +0000520 IIT_F16 = 6,
521 IIT_F32 = 7,
522 IIT_F64 = 8,
523 IIT_V2 = 9,
524 IIT_V4 = 10,
525 IIT_V8 = 11,
526 IIT_V16 = 12,
527 IIT_V32 = 13,
Robert Khasanov65c27562014-10-20 19:25:05 +0000528 IIT_PTR = 14,
529 IIT_ARG = 15,
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000530
Robert Khasanov65c27562014-10-20 19:25:05 +0000531 // Values from 16+ are only encodable with the inefficient encoding.
532 IIT_V64 = 16,
Robert Khasanovb25e5622014-09-30 11:32:22 +0000533 IIT_MMX = 17,
Joseph Tremoulet917c7382015-09-02 13:36:25 +0000534 IIT_TOKEN = 18,
535 IIT_METADATA = 19,
536 IIT_EMPTYSTRUCT = 20,
537 IIT_STRUCT2 = 21,
538 IIT_STRUCT3 = 22,
539 IIT_STRUCT4 = 23,
540 IIT_STRUCT5 = 24,
541 IIT_EXTEND_ARG = 25,
542 IIT_TRUNC_ARG = 26,
543 IIT_ANYPTR = 27,
544 IIT_V1 = 28,
545 IIT_VARARG = 29,
546 IIT_HALF_VEC_ARG = 30,
547 IIT_SAME_VEC_WIDTH_ARG = 31,
548 IIT_PTR_TO_ARG = 32,
Elena Demikhovskycaaceef2016-11-03 03:23:55 +0000549 IIT_PTR_TO_ELT = 33,
550 IIT_VEC_OF_PTRS_TO_ELT = 34,
551 IIT_I128 = 35,
552 IIT_V512 = 36,
553 IIT_V1024 = 37
Chris Lattnerf39c2782012-05-27 18:28:35 +0000554};
555
556
557static void DecodeIITType(unsigned &NextElt, ArrayRef<unsigned char> Infos,
558 SmallVectorImpl<Intrinsic::IITDescriptor> &OutputTable) {
Chris Lattnera57c7972012-05-17 05:13:57 +0000559 IIT_Info Info = IIT_Info(Infos[NextElt++]);
Chris Lattner3e34a7b2012-05-17 05:03:24 +0000560 unsigned StructElts = 2;
Chris Lattnerf39c2782012-05-27 18:28:35 +0000561 using namespace Intrinsic;
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000562
Chris Lattnera57c7972012-05-17 05:13:57 +0000563 switch (Info) {
Chris Lattnerf39c2782012-05-27 18:28:35 +0000564 case IIT_Done:
565 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Void, 0));
566 return;
Andrew Tricka2efd992013-10-31 17:18:11 +0000567 case IIT_VARARG:
568 OutputTable.push_back(IITDescriptor::get(IITDescriptor::VarArg, 0));
569 return;
Chris Lattnerf39c2782012-05-27 18:28:35 +0000570 case IIT_MMX:
571 OutputTable.push_back(IITDescriptor::get(IITDescriptor::MMX, 0));
572 return;
Joseph Tremoulet917c7382015-09-02 13:36:25 +0000573 case IIT_TOKEN:
574 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Token, 0));
575 return;
Chris Lattnerf39c2782012-05-27 18:28:35 +0000576 case IIT_METADATA:
577 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Metadata, 0));
578 return;
Michael Ilseman6c6d7152013-01-11 01:45:05 +0000579 case IIT_F16:
580 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Half, 0));
581 return;
Chris Lattnerf39c2782012-05-27 18:28:35 +0000582 case IIT_F32:
583 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Float, 0));
584 return;
585 case IIT_F64:
586 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Double, 0));
587 return;
588 case IIT_I1:
589 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer, 1));
590 return;
591 case IIT_I8:
592 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer, 8));
593 return;
594 case IIT_I16:
595 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer,16));
596 return;
597 case IIT_I32:
598 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer, 32));
599 return;
600 case IIT_I64:
601 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer, 64));
602 return;
Kit Barton66460332015-05-25 15:49:26 +0000603 case IIT_I128:
604 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer, 128));
605 return;
Jiangning Liu63dc8402013-09-24 02:47:27 +0000606 case IIT_V1:
607 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 1));
608 DecodeIITType(NextElt, Infos, OutputTable);
609 return;
Chris Lattner827b2532012-05-17 04:30:58 +0000610 case IIT_V2:
Chris Lattnerf39c2782012-05-27 18:28:35 +0000611 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 2));
612 DecodeIITType(NextElt, Infos, OutputTable);
613 return;
Chris Lattner827b2532012-05-17 04:30:58 +0000614 case IIT_V4:
Chris Lattnerf39c2782012-05-27 18:28:35 +0000615 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 4));
616 DecodeIITType(NextElt, Infos, OutputTable);
617 return;
Chris Lattner827b2532012-05-17 04:30:58 +0000618 case IIT_V8:
Chris Lattnerf39c2782012-05-27 18:28:35 +0000619 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 8));
620 DecodeIITType(NextElt, Infos, OutputTable);
621 return;
Chris Lattner827b2532012-05-17 04:30:58 +0000622 case IIT_V16:
Chris Lattnerf39c2782012-05-27 18:28:35 +0000623 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 16));
624 DecodeIITType(NextElt, Infos, OutputTable);
625 return;
Chris Lattner3e34a7b2012-05-17 05:03:24 +0000626 case IIT_V32:
Chris Lattnerf39c2782012-05-27 18:28:35 +0000627 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 32));
628 DecodeIITType(NextElt, Infos, OutputTable);
629 return;
Robert Khasanovb25e5622014-09-30 11:32:22 +0000630 case IIT_V64:
631 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 64));
632 DecodeIITType(NextElt, Infos, OutputTable);
633 return;
Krzysztof Parzyszekb8bb90b2015-11-24 16:28:14 +0000634 case IIT_V512:
635 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 512));
636 DecodeIITType(NextElt, Infos, OutputTable);
637 return;
638 case IIT_V1024:
639 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 1024));
640 DecodeIITType(NextElt, Infos, OutputTable);
641 return;
Chris Lattner4f18aa82012-05-23 05:19:18 +0000642 case IIT_PTR:
Chris Lattnerf39c2782012-05-27 18:28:35 +0000643 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Pointer, 0));
644 DecodeIITType(NextElt, Infos, OutputTable);
645 return;
Chris Lattner4f18aa82012-05-23 05:19:18 +0000646 case IIT_ANYPTR: { // [ANYPTR addrspace, subtype]
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000647 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Pointer,
Chris Lattnerf39c2782012-05-27 18:28:35 +0000648 Infos[NextElt++]));
649 DecodeIITType(NextElt, Infos, OutputTable);
650 return;
Pete Cooper243efd72012-05-21 23:21:28 +0000651 }
Chris Lattnerf39c2782012-05-27 18:28:35 +0000652 case IIT_ARG: {
653 unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
654 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Argument, ArgInfo));
655 return;
656 }
Tim Northoveraa3cf1e2014-03-28 12:31:39 +0000657 case IIT_EXTEND_ARG: {
Chris Lattnerf39c2782012-05-27 18:28:35 +0000658 unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
Tim Northoveraa3cf1e2014-03-28 12:31:39 +0000659 OutputTable.push_back(IITDescriptor::get(IITDescriptor::ExtendArgument,
Chris Lattnerf39c2782012-05-27 18:28:35 +0000660 ArgInfo));
661 return;
662 }
Tim Northoveraa3cf1e2014-03-28 12:31:39 +0000663 case IIT_TRUNC_ARG: {
Chris Lattnerf39c2782012-05-27 18:28:35 +0000664 unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
Tim Northoveraa3cf1e2014-03-28 12:31:39 +0000665 OutputTable.push_back(IITDescriptor::get(IITDescriptor::TruncArgument,
Chris Lattnerf39c2782012-05-27 18:28:35 +0000666 ArgInfo));
667 return;
Chris Lattner3e34a7b2012-05-17 05:03:24 +0000668 }
Tim Northover4516de32014-03-29 07:04:54 +0000669 case IIT_HALF_VEC_ARG: {
670 unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
671 OutputTable.push_back(IITDescriptor::get(IITDescriptor::HalfVecArgument,
672 ArgInfo));
673 return;
674 }
Elena Demikhovskyf1de34b2014-12-04 09:40:44 +0000675 case IIT_SAME_VEC_WIDTH_ARG: {
676 unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
677 OutputTable.push_back(IITDescriptor::get(IITDescriptor::SameVecWidthArgument,
678 ArgInfo));
679 return;
680 }
Elena Demikhovskyfb81b932014-12-25 07:49:20 +0000681 case IIT_PTR_TO_ARG: {
682 unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
683 OutputTable.push_back(IITDescriptor::get(IITDescriptor::PtrToArgument,
684 ArgInfo));
685 return;
686 }
Elena Demikhovskycaaceef2016-11-03 03:23:55 +0000687 case IIT_PTR_TO_ELT: {
688 unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
689 OutputTable.push_back(IITDescriptor::get(IITDescriptor::PtrToElt, ArgInfo));
690 return;
691 }
Elena Demikhovsky23a485a2015-02-08 08:27:19 +0000692 case IIT_VEC_OF_PTRS_TO_ELT: {
693 unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
694 OutputTable.push_back(IITDescriptor::get(IITDescriptor::VecOfPtrsToElt,
695 ArgInfo));
696 return;
697 }
Chris Lattnerf39c2782012-05-27 18:28:35 +0000698 case IIT_EMPTYSTRUCT:
699 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Struct, 0));
700 return;
Justin Bognercd1d5aa2016-08-17 20:30:52 +0000701 case IIT_STRUCT5: ++StructElts; LLVM_FALLTHROUGH;
702 case IIT_STRUCT4: ++StructElts; LLVM_FALLTHROUGH;
703 case IIT_STRUCT3: ++StructElts; LLVM_FALLTHROUGH;
Chris Lattner3e34a7b2012-05-17 05:03:24 +0000704 case IIT_STRUCT2: {
Chris Lattnerf39c2782012-05-27 18:28:35 +0000705 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Struct,StructElts));
706
Chris Lattner3e34a7b2012-05-17 05:03:24 +0000707 for (unsigned i = 0; i != StructElts; ++i)
Chris Lattnerf39c2782012-05-27 18:28:35 +0000708 DecodeIITType(NextElt, Infos, OutputTable);
709 return;
Chris Lattner827b2532012-05-17 04:30:58 +0000710 }
Chris Lattner7f0e7ba2012-05-16 06:34:44 +0000711 }
712 llvm_unreachable("unhandled");
713}
Chris Lattner7f0e7ba2012-05-16 06:34:44 +0000714
Chris Lattnerf39c2782012-05-27 18:28:35 +0000715
716#define GET_INTRINSIC_GENERATOR_GLOBAL
Chandler Carruthdb25c6c2013-01-02 12:09:16 +0000717#include "llvm/IR/Intrinsics.gen"
Chris Lattnerf39c2782012-05-27 18:28:35 +0000718#undef GET_INTRINSIC_GENERATOR_GLOBAL
719
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000720void Intrinsic::getIntrinsicInfoTableEntries(ID id,
Chris Lattnerf39c2782012-05-27 18:28:35 +0000721 SmallVectorImpl<IITDescriptor> &T){
Chris Lattner7f0e7ba2012-05-16 06:34:44 +0000722 // Check to see if the intrinsic's type was expressible by the table.
723 unsigned TableVal = IIT_Table[id-1];
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000724
Chris Lattnera3b0f522012-05-17 15:55:41 +0000725 // Decode the TableVal into an array of IITValues.
726 SmallVector<unsigned char, 8> IITValues;
727 ArrayRef<unsigned char> IITEntries;
728 unsigned NextElt = 0;
729 if ((TableVal >> 31) != 0) {
730 // This is an offset into the IIT_LongEncodingTable.
731 IITEntries = IIT_LongEncodingTable;
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000732
Chris Lattnera3b0f522012-05-17 15:55:41 +0000733 // Strip sentinel bit.
734 NextElt = (TableVal << 1) >> 1;
735 } else {
Chris Lattnerf39c2782012-05-27 18:28:35 +0000736 // Decode the TableVal into an array of IITValues. If the entry was encoded
737 // into a single word in the table itself, decode it now.
Chris Lattnera57c7972012-05-17 05:13:57 +0000738 do {
739 IITValues.push_back(TableVal & 0xF);
740 TableVal >>= 4;
741 } while (TableVal);
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000742
Chris Lattnera3b0f522012-05-17 15:55:41 +0000743 IITEntries = IITValues;
744 NextElt = 0;
Chris Lattner7f0e7ba2012-05-16 06:34:44 +0000745 }
Chris Lattnerf39c2782012-05-27 18:28:35 +0000746
747 // Okay, decode the table into the output vector of IITDescriptors.
748 DecodeIITType(NextElt, IITEntries, T);
749 while (NextElt != IITEntries.size() && IITEntries[NextElt] != 0)
750 DecodeIITType(NextElt, IITEntries, T);
751}
752
753
754static Type *DecodeFixedType(ArrayRef<Intrinsic::IITDescriptor> &Infos,
755 ArrayRef<Type*> Tys, LLVMContext &Context) {
756 using namespace Intrinsic;
757 IITDescriptor D = Infos.front();
758 Infos = Infos.slice(1);
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000759
Chris Lattnerf39c2782012-05-27 18:28:35 +0000760 switch (D.Kind) {
761 case IITDescriptor::Void: return Type::getVoidTy(Context);
Andrew Tricka2efd992013-10-31 17:18:11 +0000762 case IITDescriptor::VarArg: return Type::getVoidTy(Context);
Chris Lattnerf39c2782012-05-27 18:28:35 +0000763 case IITDescriptor::MMX: return Type::getX86_MMXTy(Context);
Joseph Tremoulet917c7382015-09-02 13:36:25 +0000764 case IITDescriptor::Token: return Type::getTokenTy(Context);
Chris Lattnerf39c2782012-05-27 18:28:35 +0000765 case IITDescriptor::Metadata: return Type::getMetadataTy(Context);
Michael Ilseman6c6d7152013-01-11 01:45:05 +0000766 case IITDescriptor::Half: return Type::getHalfTy(Context);
Chris Lattnerf39c2782012-05-27 18:28:35 +0000767 case IITDescriptor::Float: return Type::getFloatTy(Context);
768 case IITDescriptor::Double: return Type::getDoubleTy(Context);
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000769
Chris Lattnerf39c2782012-05-27 18:28:35 +0000770 case IITDescriptor::Integer:
771 return IntegerType::get(Context, D.Integer_Width);
772 case IITDescriptor::Vector:
773 return VectorType::get(DecodeFixedType(Infos, Tys, Context),D.Vector_Width);
774 case IITDescriptor::Pointer:
775 return PointerType::get(DecodeFixedType(Infos, Tys, Context),
776 D.Pointer_AddressSpace);
777 case IITDescriptor::Struct: {
778 Type *Elts[5];
779 assert(D.Struct_NumElements <= 5 && "Can't handle this yet");
780 for (unsigned i = 0, e = D.Struct_NumElements; i != e; ++i)
781 Elts[i] = DecodeFixedType(Infos, Tys, Context);
Craig Toppere1d12942014-08-27 05:25:25 +0000782 return StructType::get(Context, makeArrayRef(Elts,D.Struct_NumElements));
Chris Lattnerf39c2782012-05-27 18:28:35 +0000783 }
784
785 case IITDescriptor::Argument:
786 return Tys[D.getArgumentNumber()];
Tim Northoveraa3cf1e2014-03-28 12:31:39 +0000787 case IITDescriptor::ExtendArgument: {
788 Type *Ty = Tys[D.getArgumentNumber()];
789 if (VectorType *VTy = dyn_cast<VectorType>(Ty))
790 return VectorType::getExtendedElementVectorType(VTy);
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000791
Tim Northoveraa3cf1e2014-03-28 12:31:39 +0000792 return IntegerType::get(Context, 2 * cast<IntegerType>(Ty)->getBitWidth());
793 }
794 case IITDescriptor::TruncArgument: {
795 Type *Ty = Tys[D.getArgumentNumber()];
796 if (VectorType *VTy = dyn_cast<VectorType>(Ty))
797 return VectorType::getTruncatedElementVectorType(VTy);
798
799 IntegerType *ITy = cast<IntegerType>(Ty);
800 assert(ITy->getBitWidth() % 2 == 0);
801 return IntegerType::get(Context, ITy->getBitWidth() / 2);
802 }
Tim Northover4516de32014-03-29 07:04:54 +0000803 case IITDescriptor::HalfVecArgument:
804 return VectorType::getHalfElementsVectorType(cast<VectorType>(
805 Tys[D.getArgumentNumber()]));
Elena Demikhovskyfb81b932014-12-25 07:49:20 +0000806 case IITDescriptor::SameVecWidthArgument: {
Elena Demikhovskyf1de34b2014-12-04 09:40:44 +0000807 Type *EltTy = DecodeFixedType(Infos, Tys, Context);
808 Type *Ty = Tys[D.getArgumentNumber()];
809 if (VectorType *VTy = dyn_cast<VectorType>(Ty)) {
810 return VectorType::get(EltTy, VTy->getNumElements());
811 }
812 llvm_unreachable("unhandled");
Elena Demikhovskyfb81b932014-12-25 07:49:20 +0000813 }
814 case IITDescriptor::PtrToArgument: {
815 Type *Ty = Tys[D.getArgumentNumber()];
816 return PointerType::getUnqual(Ty);
817 }
Elena Demikhovskycaaceef2016-11-03 03:23:55 +0000818 case IITDescriptor::PtrToElt: {
819 Type *Ty = Tys[D.getArgumentNumber()];
820 VectorType *VTy = dyn_cast<VectorType>(Ty);
821 if (!VTy)
822 llvm_unreachable("Expected an argument of Vector Type");
823 Type *EltTy = VTy->getVectorElementType();
824 return PointerType::getUnqual(EltTy);
825 }
Elena Demikhovsky23a485a2015-02-08 08:27:19 +0000826 case IITDescriptor::VecOfPtrsToElt: {
827 Type *Ty = Tys[D.getArgumentNumber()];
828 VectorType *VTy = dyn_cast<VectorType>(Ty);
829 if (!VTy)
830 llvm_unreachable("Expected an argument of Vector Type");
831 Type *EltTy = VTy->getVectorElementType();
832 return VectorType::get(PointerType::getUnqual(EltTy),
833 VTy->getNumElements());
834 }
Elena Demikhovskyf1de34b2014-12-04 09:40:44 +0000835 }
Chris Lattnerf39c2782012-05-27 18:28:35 +0000836 llvm_unreachable("unhandled");
837}
838
839
840
841FunctionType *Intrinsic::getType(LLVMContext &Context,
842 ID id, ArrayRef<Type*> Tys) {
843 SmallVector<IITDescriptor, 8> Table;
844 getIntrinsicInfoTableEntries(id, Table);
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000845
Chris Lattnerf39c2782012-05-27 18:28:35 +0000846 ArrayRef<IITDescriptor> TableRef = Table;
847 Type *ResultTy = DecodeFixedType(TableRef, Tys, Context);
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000848
Chris Lattnera3b0f522012-05-17 15:55:41 +0000849 SmallVector<Type*, 8> ArgTys;
Chris Lattnerf39c2782012-05-27 18:28:35 +0000850 while (!TableRef.empty())
851 ArgTys.push_back(DecodeFixedType(TableRef, Tys, Context));
Jim Laskey2682ea62007-02-07 20:38:26 +0000852
Steven Wud05affc2014-10-20 15:47:24 +0000853 // DecodeFixedType returns Void for IITDescriptor::Void and IITDescriptor::VarArg
854 // If we see void type as the type of the last argument, it is vararg intrinsic
855 if (!ArgTys.empty() && ArgTys.back()->isVoidTy()) {
856 ArgTys.pop_back();
857 return FunctionType::get(ResultTy, ArgTys, true);
858 }
Michael Ilsemanacdb76d2012-12-17 20:37:55 +0000859 return FunctionType::get(ResultTy, ArgTys, false);
Jim Laskey2682ea62007-02-07 20:38:26 +0000860}
861
Mon P Wangb4024932009-02-24 23:17:49 +0000862bool Intrinsic::isOverloaded(ID id) {
Mon P Wangb4024932009-02-24 23:17:49 +0000863#define GET_INTRINSIC_OVERLOAD_TABLE
Chandler Carruthdb25c6c2013-01-02 12:09:16 +0000864#include "llvm/IR/Intrinsics.gen"
Mon P Wangb4024932009-02-24 23:17:49 +0000865#undef GET_INTRINSIC_OVERLOAD_TABLE
Mon P Wangb4024932009-02-24 23:17:49 +0000866}
867
Sanjoy Dasc65d43e2015-06-18 19:28:26 +0000868bool Intrinsic::isLeaf(ID id) {
869 switch (id) {
870 default:
871 return true;
872
873 case Intrinsic::experimental_gc_statepoint:
874 case Intrinsic::experimental_patchpoint_void:
875 case Intrinsic::experimental_patchpoint_i64:
876 return false;
877 }
878}
879
Chris Lattner49b7ee12009-01-12 01:18:58 +0000880/// This defines the "Intrinsic::getAttributes(ID id)" method.
Duncan Sands38ef3a82007-12-03 20:06:50 +0000881#define GET_INTRINSIC_ATTRIBUTES
Chandler Carruthdb25c6c2013-01-02 12:09:16 +0000882#include "llvm/IR/Intrinsics.gen"
Duncan Sands38ef3a82007-12-03 20:06:50 +0000883#undef GET_INTRINSIC_ATTRIBUTES
884
Benjamin Kramere6e19332011-07-14 17:45:39 +0000885Function *Intrinsic::getDeclaration(Module *M, ID id, ArrayRef<Type*> Tys) {
Duncan Sands38ef3a82007-12-03 20:06:50 +0000886 // There can never be multiple globals with the same name of different types,
887 // because intrinsics must be a specific type.
Duncan Sandsa8ff6ca2008-04-07 13:39:11 +0000888 return
Benjamin Kramere6e19332011-07-14 17:45:39 +0000889 cast<Function>(M->getOrInsertFunction(getName(id, Tys),
890 getType(M->getContext(), id, Tys)));
Jim Laskey2682ea62007-02-07 20:38:26 +0000891}
892
Dale Johannesenb842d522009-02-05 01:49:45 +0000893// This defines the "Intrinsic::getIntrinsicForGCCBuiltin()" method.
894#define GET_LLVM_INTRINSIC_FOR_GCC_BUILTIN
Chandler Carruthdb25c6c2013-01-02 12:09:16 +0000895#include "llvm/IR/Intrinsics.gen"
Dale Johannesenb842d522009-02-05 01:49:45 +0000896#undef GET_LLVM_INTRINSIC_FOR_GCC_BUILTIN
897
Saleem Abdulrasool4e63fc42014-07-04 18:42:25 +0000898// This defines the "Intrinsic::getIntrinsicForMSBuiltin()" method.
899#define GET_LLVM_INTRINSIC_FOR_MS_BUILTIN
900#include "llvm/IR/Intrinsics.gen"
901#undef GET_LLVM_INTRINSIC_FOR_MS_BUILTIN
902
Artur Pilipenkobc552272016-06-22 14:56:33 +0000903bool Intrinsic::matchIntrinsicType(Type *Ty, ArrayRef<Intrinsic::IITDescriptor> &Infos,
904 SmallVectorImpl<Type*> &ArgTys) {
905 using namespace Intrinsic;
906
907 // If we ran out of descriptors, there are too many arguments.
908 if (Infos.empty()) return true;
909 IITDescriptor D = Infos.front();
910 Infos = Infos.slice(1);
911
912 switch (D.Kind) {
913 case IITDescriptor::Void: return !Ty->isVoidTy();
914 case IITDescriptor::VarArg: return true;
915 case IITDescriptor::MMX: return !Ty->isX86_MMXTy();
916 case IITDescriptor::Token: return !Ty->isTokenTy();
917 case IITDescriptor::Metadata: return !Ty->isMetadataTy();
918 case IITDescriptor::Half: return !Ty->isHalfTy();
919 case IITDescriptor::Float: return !Ty->isFloatTy();
920 case IITDescriptor::Double: return !Ty->isDoubleTy();
921 case IITDescriptor::Integer: return !Ty->isIntegerTy(D.Integer_Width);
922 case IITDescriptor::Vector: {
923 VectorType *VT = dyn_cast<VectorType>(Ty);
924 return !VT || VT->getNumElements() != D.Vector_Width ||
925 matchIntrinsicType(VT->getElementType(), Infos, ArgTys);
926 }
927 case IITDescriptor::Pointer: {
928 PointerType *PT = dyn_cast<PointerType>(Ty);
929 return !PT || PT->getAddressSpace() != D.Pointer_AddressSpace ||
930 matchIntrinsicType(PT->getElementType(), Infos, ArgTys);
931 }
932
933 case IITDescriptor::Struct: {
934 StructType *ST = dyn_cast<StructType>(Ty);
935 if (!ST || ST->getNumElements() != D.Struct_NumElements)
936 return true;
937
938 for (unsigned i = 0, e = D.Struct_NumElements; i != e; ++i)
939 if (matchIntrinsicType(ST->getElementType(i), Infos, ArgTys))
940 return true;
941 return false;
942 }
943
944 case IITDescriptor::Argument:
945 // Two cases here - If this is the second occurrence of an argument, verify
946 // that the later instance matches the previous instance.
947 if (D.getArgumentNumber() < ArgTys.size())
948 return Ty != ArgTys[D.getArgumentNumber()];
949
950 // Otherwise, if this is the first instance of an argument, record it and
951 // verify the "Any" kind.
952 assert(D.getArgumentNumber() == ArgTys.size() && "Table consistency error");
953 ArgTys.push_back(Ty);
954
955 switch (D.getArgumentKind()) {
956 case IITDescriptor::AK_Any: return false; // Success
957 case IITDescriptor::AK_AnyInteger: return !Ty->isIntOrIntVectorTy();
958 case IITDescriptor::AK_AnyFloat: return !Ty->isFPOrFPVectorTy();
959 case IITDescriptor::AK_AnyVector: return !isa<VectorType>(Ty);
960 case IITDescriptor::AK_AnyPointer: return !isa<PointerType>(Ty);
961 }
962 llvm_unreachable("all argument kinds not covered");
963
964 case IITDescriptor::ExtendArgument: {
965 // This may only be used when referring to a previous vector argument.
966 if (D.getArgumentNumber() >= ArgTys.size())
967 return true;
968
969 Type *NewTy = ArgTys[D.getArgumentNumber()];
970 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
971 NewTy = VectorType::getExtendedElementVectorType(VTy);
972 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
973 NewTy = IntegerType::get(ITy->getContext(), 2 * ITy->getBitWidth());
974 else
975 return true;
976
977 return Ty != NewTy;
978 }
979 case IITDescriptor::TruncArgument: {
980 // This may only be used when referring to a previous vector argument.
981 if (D.getArgumentNumber() >= ArgTys.size())
982 return true;
983
984 Type *NewTy = ArgTys[D.getArgumentNumber()];
985 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
986 NewTy = VectorType::getTruncatedElementVectorType(VTy);
987 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
988 NewTy = IntegerType::get(ITy->getContext(), ITy->getBitWidth() / 2);
989 else
990 return true;
991
992 return Ty != NewTy;
993 }
994 case IITDescriptor::HalfVecArgument:
995 // This may only be used when referring to a previous vector argument.
996 return D.getArgumentNumber() >= ArgTys.size() ||
997 !isa<VectorType>(ArgTys[D.getArgumentNumber()]) ||
998 VectorType::getHalfElementsVectorType(
999 cast<VectorType>(ArgTys[D.getArgumentNumber()])) != Ty;
1000 case IITDescriptor::SameVecWidthArgument: {
1001 if (D.getArgumentNumber() >= ArgTys.size())
1002 return true;
1003 VectorType * ReferenceType =
Elena Demikhovskycaaceef2016-11-03 03:23:55 +00001004 dyn_cast<VectorType>(ArgTys[D.getArgumentNumber()]);
Artur Pilipenkobc552272016-06-22 14:56:33 +00001005 VectorType *ThisArgType = dyn_cast<VectorType>(Ty);
1006 if (!ThisArgType || !ReferenceType ||
1007 (ReferenceType->getVectorNumElements() !=
1008 ThisArgType->getVectorNumElements()))
1009 return true;
1010 return matchIntrinsicType(ThisArgType->getVectorElementType(),
1011 Infos, ArgTys);
1012 }
1013 case IITDescriptor::PtrToArgument: {
1014 if (D.getArgumentNumber() >= ArgTys.size())
1015 return true;
1016 Type * ReferenceType = ArgTys[D.getArgumentNumber()];
1017 PointerType *ThisArgType = dyn_cast<PointerType>(Ty);
1018 return (!ThisArgType || ThisArgType->getElementType() != ReferenceType);
1019 }
Elena Demikhovskycaaceef2016-11-03 03:23:55 +00001020 case IITDescriptor::PtrToElt: {
1021 if (D.getArgumentNumber() >= ArgTys.size())
1022 return true;
1023 VectorType * ReferenceType =
1024 dyn_cast<VectorType> (ArgTys[D.getArgumentNumber()]);
1025 PointerType *ThisArgType = dyn_cast<PointerType>(Ty);
1026
1027 return (!ThisArgType || !ReferenceType ||
1028 ThisArgType->getElementType() != ReferenceType->getElementType());
1029 }
Artur Pilipenkobc552272016-06-22 14:56:33 +00001030 case IITDescriptor::VecOfPtrsToElt: {
1031 if (D.getArgumentNumber() >= ArgTys.size())
1032 return true;
1033 VectorType * ReferenceType =
1034 dyn_cast<VectorType> (ArgTys[D.getArgumentNumber()]);
1035 VectorType *ThisArgVecTy = dyn_cast<VectorType>(Ty);
1036 if (!ThisArgVecTy || !ReferenceType ||
1037 (ReferenceType->getVectorNumElements() !=
1038 ThisArgVecTy->getVectorNumElements()))
1039 return true;
1040 PointerType *ThisArgEltTy =
1041 dyn_cast<PointerType>(ThisArgVecTy->getVectorElementType());
1042 if (!ThisArgEltTy)
1043 return true;
1044 return ThisArgEltTy->getElementType() !=
1045 ReferenceType->getVectorElementType();
1046 }
1047 }
1048 llvm_unreachable("unhandled");
1049}
1050
Artur Pilipenkob68b8212016-06-24 14:47:27 +00001051bool
1052Intrinsic::matchIntrinsicVarArg(bool isVarArg,
1053 ArrayRef<Intrinsic::IITDescriptor> &Infos) {
1054 // If there are no descriptors left, then it can't be a vararg.
1055 if (Infos.empty())
1056 return isVarArg;
1057
1058 // There should be only one descriptor remaining at this point.
1059 if (Infos.size() != 1)
1060 return true;
1061
1062 // Check and verify the descriptor.
1063 IITDescriptor D = Infos.front();
1064 Infos = Infos.slice(1);
1065 if (D.Kind == IITDescriptor::VarArg)
1066 return !isVarArg;
1067
1068 return true;
1069}
1070
Artur Pilipenko6c7a8ab2016-06-24 15:10:29 +00001071Optional<Function*> Intrinsic::remangleIntrinsicFunction(Function *F) {
1072 Intrinsic::ID ID = F->getIntrinsicID();
1073 if (!ID)
1074 return None;
1075
1076 FunctionType *FTy = F->getFunctionType();
1077 // Accumulate an array of overloaded types for the given intrinsic
1078 SmallVector<Type *, 4> ArgTys;
1079 {
1080 SmallVector<Intrinsic::IITDescriptor, 8> Table;
1081 getIntrinsicInfoTableEntries(ID, Table);
1082 ArrayRef<Intrinsic::IITDescriptor> TableRef = Table;
1083
1084 // If we encounter any problems matching the signature with the descriptor
1085 // just give up remangling. It's up to verifier to report the discrepancy.
1086 if (Intrinsic::matchIntrinsicType(FTy->getReturnType(), TableRef, ArgTys))
1087 return None;
1088 for (auto Ty : FTy->params())
1089 if (Intrinsic::matchIntrinsicType(Ty, TableRef, ArgTys))
1090 return None;
1091 if (Intrinsic::matchIntrinsicVarArg(FTy->isVarArg(), TableRef))
1092 return None;
1093 }
1094
1095 StringRef Name = F->getName();
1096 if (Name == Intrinsic::getName(ID, ArgTys))
1097 return None;
1098
1099 auto NewDecl = Intrinsic::getDeclaration(F->getParent(), ID, ArgTys);
1100 NewDecl->setCallingConv(F->getCallingConv());
1101 assert(NewDecl->getFunctionType() == FTy && "Shouldn't change the signature");
1102 return NewDecl;
1103}
1104
Gabor Greif161cb042010-03-23 14:40:20 +00001105/// hasAddressTaken - returns true if there are any uses of this function
1106/// other than direct calls or invokes to it.
Gabor Greifa2fbc0a2010-03-24 13:21:49 +00001107bool Function::hasAddressTaken(const User* *PutOffender) const {
Chandler Carruthcdf47882014-03-09 03:16:01 +00001108 for (const Use &U : uses()) {
1109 const User *FU = U.getUser();
1110 if (isa<BlockAddress>(FU))
Jay Foadca0c4992012-05-12 08:30:16 +00001111 continue;
Richard Trieu7a083812016-02-18 22:09:30 +00001112 if (!isa<CallInst>(FU) && !isa<InvokeInst>(FU)) {
1113 if (PutOffender)
1114 *PutOffender = FU;
1115 return true;
1116 }
Chandler Carruthcdf47882014-03-09 03:16:01 +00001117 ImmutableCallSite CS(cast<Instruction>(FU));
Richard Trieu7a083812016-02-18 22:09:30 +00001118 if (!CS.isCallee(&U)) {
1119 if (PutOffender)
1120 *PutOffender = FU;
1121 return true;
1122 }
Jay Foad557169d2009-06-10 08:41:11 +00001123 }
1124 return false;
1125}
1126
Eli Friedman1923a332011-10-20 05:23:42 +00001127bool Function::isDefTriviallyDead() const {
1128 // Check the linkage
1129 if (!hasLinkOnceLinkage() && !hasLocalLinkage() &&
1130 !hasAvailableExternallyLinkage())
1131 return false;
1132
1133 // Check if the function is used by anything other than a blockaddress.
Chandler Carruthcdf47882014-03-09 03:16:01 +00001134 for (const User *U : users())
1135 if (!isa<BlockAddress>(U))
Eli Friedman1923a332011-10-20 05:23:42 +00001136 return false;
1137
1138 return true;
1139}
1140
Bill Wendling63a4ea12011-10-17 18:43:40 +00001141/// callsFunctionThatReturnsTwice - Return true if the function has a call to
1142/// setjmp or other function that gcc recognizes as "returning twice".
1143bool Function::callsFunctionThatReturnsTwice() const {
1144 for (const_inst_iterator
1145 I = inst_begin(this), E = inst_end(this); I != E; ++I) {
Mark Seaborn82711182014-01-14 04:20:01 +00001146 ImmutableCallSite CS(&*I);
1147 if (CS && CS.hasFnAttr(Attribute::ReturnsTwice))
Bill Wendling63a4ea12011-10-17 18:43:40 +00001148 return true;
1149 }
1150
1151 return false;
1152}
Peter Collingbourne3fa50f92013-09-16 01:08:15 +00001153
Vedant Kumar3a63fb32015-12-19 08:52:49 +00001154Constant *Function::getPersonalityFn() const {
1155 assert(hasPersonalityFn() && getNumOperands());
1156 return cast<Constant>(Op<0>());
Vedant Kumar1ab5ea52015-10-06 20:31:57 +00001157}
1158
Vedant Kumar3a63fb32015-12-19 08:52:49 +00001159void Function::setPersonalityFn(Constant *Fn) {
Keno Fischer9bc46b12015-12-23 18:27:23 +00001160 setHungoffOperand<0>(Fn);
Vedant Kumar3a63fb32015-12-19 08:52:49 +00001161 setValueSubclassDataBit(3, Fn != nullptr);
Vedant Kumar1ab5ea52015-10-06 20:31:57 +00001162}
1163
Peter Collingbourne3fa50f92013-09-16 01:08:15 +00001164Constant *Function::getPrefixData() const {
Vedant Kumar3a63fb32015-12-19 08:52:49 +00001165 assert(hasPrefixData() && getNumOperands());
1166 return cast<Constant>(Op<1>());
Peter Collingbourne3fa50f92013-09-16 01:08:15 +00001167}
1168
1169void Function::setPrefixData(Constant *PrefixData) {
Keno Fischer9bc46b12015-12-23 18:27:23 +00001170 setHungoffOperand<1>(PrefixData);
Vedant Kumar3a63fb32015-12-19 08:52:49 +00001171 setValueSubclassDataBit(1, PrefixData != nullptr);
Peter Collingbourne3fa50f92013-09-16 01:08:15 +00001172}
Peter Collingbourne51d2de72014-12-03 02:08:38 +00001173
1174Constant *Function::getPrologueData() const {
Vedant Kumar3a63fb32015-12-19 08:52:49 +00001175 assert(hasPrologueData() && getNumOperands());
1176 return cast<Constant>(Op<2>());
Peter Collingbourne51d2de72014-12-03 02:08:38 +00001177}
1178
1179void Function::setPrologueData(Constant *PrologueData) {
Keno Fischer9bc46b12015-12-23 18:27:23 +00001180 setHungoffOperand<2>(PrologueData);
Vedant Kumar3a63fb32015-12-19 08:52:49 +00001181 setValueSubclassDataBit(2, PrologueData != nullptr);
1182}
1183
1184void Function::allocHungoffUselist() {
1185 // If we've already allocated a uselist, stop here.
1186 if (getNumOperands())
Peter Collingbourne51d2de72014-12-03 02:08:38 +00001187 return;
1188
Vedant Kumar3a63fb32015-12-19 08:52:49 +00001189 allocHungoffUses(3, /*IsPhi=*/ false);
1190 setNumHungOffUseOperands(3);
1191
1192 // Initialize the uselist with placeholder operands to allow traversal.
1193 auto *CPN = ConstantPointerNull::get(Type::getInt1PtrTy(getContext(), 0));
1194 Op<0>().set(CPN);
1195 Op<1>().set(CPN);
1196 Op<2>().set(CPN);
1197}
1198
1199template <int Idx>
1200void Function::setHungoffOperand(Constant *C) {
Keno Fischer9bc46b12015-12-23 18:27:23 +00001201 if (C) {
1202 allocHungoffUselist();
1203 Op<Idx>().set(C);
1204 } else if (getNumOperands()) {
1205 Op<Idx>().set(
1206 ConstantPointerNull::get(Type::getInt1PtrTy(getContext(), 0)));
1207 }
Vedant Kumar3a63fb32015-12-19 08:52:49 +00001208}
1209
1210void Function::setValueSubclassDataBit(unsigned Bit, bool On) {
1211 assert(Bit < 16 && "SubclassData contains only 16 bits");
1212 if (On)
1213 setValueSubclassData(getSubclassDataFromValue() | (1 << Bit));
1214 else
1215 setValueSubclassData(getSubclassDataFromValue() & ~(1 << Bit));
Peter Collingbourne51d2de72014-12-03 02:08:38 +00001216}
Akira Hatanaka3058d0f2015-05-06 23:54:14 +00001217
Dehao Chena60cdd32017-02-28 18:09:44 +00001218void Function::setEntryCount(uint64_t Count,
1219 const DenseSet<GlobalValue::GUID> *S) {
Diego Novillo2567f3d2015-05-13 15:13:45 +00001220 MDBuilder MDB(getContext());
Dehao Chena60cdd32017-02-28 18:09:44 +00001221 setMetadata(LLVMContext::MD_prof, MDB.createFunctionEntryCount(Count, S));
Diego Novillo2567f3d2015-05-13 15:13:45 +00001222}
1223
1224Optional<uint64_t> Function::getEntryCount() const {
1225 MDNode *MD = getMetadata(LLVMContext::MD_prof);
1226 if (MD && MD->getOperand(0))
1227 if (MDString *MDS = dyn_cast<MDString>(MD->getOperand(0)))
1228 if (MDS->getString().equals("function_entry_count")) {
1229 ConstantInt *CI = mdconst::extract<ConstantInt>(MD->getOperand(1));
David Callahanc1c810d2016-08-05 18:38:19 +00001230 uint64_t Count = CI->getValue().getZExtValue();
1231 if (Count == 0)
1232 return None;
1233 return Count;
Diego Novillo2567f3d2015-05-13 15:13:45 +00001234 }
1235 return None;
1236}
Dehao Chen302b69c2016-10-18 20:42:47 +00001237
Dehao Chena60cdd32017-02-28 18:09:44 +00001238DenseSet<GlobalValue::GUID> Function::getImportGUIDs() const {
1239 DenseSet<GlobalValue::GUID> R;
1240 if (MDNode *MD = getMetadata(LLVMContext::MD_prof))
1241 if (MDString *MDS = dyn_cast<MDString>(MD->getOperand(0)))
1242 if (MDS->getString().equals("function_entry_count"))
1243 for (unsigned i = 2; i < MD->getNumOperands(); i++)
1244 R.insert(mdconst::extract<ConstantInt>(MD->getOperand(i))
1245 ->getValue()
1246 .getZExtValue());
1247 return R;
1248}
1249
Dehao Chen302b69c2016-10-18 20:42:47 +00001250void Function::setSectionPrefix(StringRef Prefix) {
1251 MDBuilder MDB(getContext());
1252 setMetadata(LLVMContext::MD_section_prefix,
1253 MDB.createFunctionSectionPrefix(Prefix));
1254}
1255
1256Optional<StringRef> Function::getSectionPrefix() const {
1257 if (MDNode *MD = getMetadata(LLVMContext::MD_section_prefix)) {
1258 assert(dyn_cast<MDString>(MD->getOperand(0))
1259 ->getString()
1260 .equals("function_section_prefix") &&
1261 "Metadata not match");
1262 return dyn_cast<MDString>(MD->getOperand(1))->getString();
1263 }
1264 return None;
1265}