blob: 5870d8a87004d2fe178e836f8ea582ef40741587 [file] [log] [blame]
Chris Lattnere7fb3602001-08-27 16:00:15 +00001//===-- TargetData.cpp - Data size & alignment routines --------------------==//
Misha Brukmanf976c852005-04-21 22:55:34 +00002//
John Criswellb576c942003-10-20 19:43:21 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattner4ee451d2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Misha Brukmanf976c852005-04-21 22:55:34 +00007//
John Criswellb576c942003-10-20 19:43:21 +00008//===----------------------------------------------------------------------===//
Chris Lattnere7fb3602001-08-27 16:00:15 +00009//
10// This file defines target properties related to datatype size/offset/alignment
Chris Lattner0e7ac162004-02-26 08:02:17 +000011// information.
Chris Lattnere7fb3602001-08-27 16:00:15 +000012//
13// This structure should be created once, filled in if the defaults are not
14// correct and then passed around by const&. None of the members functions
15// require modification to the object.
16//
17//===----------------------------------------------------------------------===//
18
Vikram S. Adve0799fc42001-09-18 12:58:33 +000019#include "llvm/Target/TargetData.h"
Chris Lattner31bcdb82002-04-28 19:55:58 +000020#include "llvm/Constants.h"
Bill Wendling5eea3422009-11-18 01:03:56 +000021#include "llvm/DerivedTypes.h"
22#include "llvm/Module.h"
Chris Lattner28977af2004-04-05 01:30:19 +000023#include "llvm/Support/GetElementPtrTypeIterator.h"
Reid Spencer551ccae2004-09-01 22:55:40 +000024#include "llvm/Support/MathExtras.h"
Chris Lattnerec6478b2007-02-10 19:43:18 +000025#include "llvm/Support/ManagedStatic.h"
Torok Edwinc25e7582009-07-11 20:10:48 +000026#include "llvm/Support/ErrorHandling.h"
Chris Lattnerb7aadfa2009-11-07 09:13:23 +000027#include "llvm/Support/raw_ostream.h"
Owen Anderson2ea20152009-08-20 23:51:44 +000028#include "llvm/System/Mutex.h"
Chris Lattnerf6ca09a2007-02-10 20:26:17 +000029#include "llvm/ADT/DenseMap.h"
Chris Lattnere7ea48c2005-03-13 19:04:41 +000030#include <algorithm>
Owen Anderson8f60c562006-05-12 05:49:47 +000031#include <cstdlib>
Chris Lattnerf0453282003-12-22 05:01:15 +000032using namespace llvm;
Brian Gaeked0fde302003-11-11 22:41:34 +000033
Misha Brukman5560c9d2003-08-18 14:43:39 +000034// Handle the Pass registration stuff necessary to use TargetData's.
Dan Gohman844731a2008-05-13 00:00:25 +000035
36// Register the default SparcV9 implementation...
37static RegisterPass<TargetData> X("targetdata", "Target Data Layout", false,
38 true);
Devang Patel19974732007-05-03 01:11:54 +000039char TargetData::ID = 0;
Chris Lattneraa31ad02002-09-25 23:46:55 +000040
Chris Lattnere7fb3602001-08-27 16:00:15 +000041//===----------------------------------------------------------------------===//
Chris Lattner0e7ac162004-02-26 08:02:17 +000042// Support for StructLayout
Chris Lattnere7fb3602001-08-27 16:00:15 +000043//===----------------------------------------------------------------------===//
44
Chris Lattner0e7ac162004-02-26 08:02:17 +000045StructLayout::StructLayout(const StructType *ST, const TargetData &TD) {
Chris Lattnere7fb3602001-08-27 16:00:15 +000046 StructAlignment = 0;
47 StructSize = 0;
Chris Lattner9182e3f2007-02-10 20:15:41 +000048 NumElements = ST->getNumElements();
Chris Lattnere7fb3602001-08-27 16:00:15 +000049
Chris Lattnerbedb8c12008-12-08 07:11:56 +000050 // Loop over each of the elements, placing them in memory.
Chris Lattner9182e3f2007-02-10 20:15:41 +000051 for (unsigned i = 0, e = NumElements; i != e; ++i) {
52 const Type *Ty = ST->getElementType(i);
Duncan Sandsa0fcc082008-06-04 08:21:45 +000053 unsigned TyAlign = ST->isPacked() ? 1 : TD.getABITypeAlignment(Ty);
Chris Lattnere7fb3602001-08-27 16:00:15 +000054
Chris Lattnerbedb8c12008-12-08 07:11:56 +000055 // Add padding if necessary to align the data element properly.
Duncan Sands677a7ec2008-12-09 09:58:11 +000056 if ((StructSize & (TyAlign-1)) != 0)
Chris Lattnerbedb8c12008-12-08 07:11:56 +000057 StructSize = TargetData::RoundUpAlignment(StructSize, TyAlign);
Chris Lattnere7fb3602001-08-27 16:00:15 +000058
Chris Lattnerbedb8c12008-12-08 07:11:56 +000059 // Keep track of maximum alignment constraint.
Chris Lattner697954c2002-01-20 22:54:45 +000060 StructAlignment = std::max(TyAlign, StructAlignment);
Chris Lattnere7fb3602001-08-27 16:00:15 +000061
Chris Lattner9182e3f2007-02-10 20:15:41 +000062 MemberOffsets[i] = StructSize;
Duncan Sands777d2302009-05-09 07:06:46 +000063 StructSize += TD.getTypeAllocSize(Ty); // Consume space for this data item
Chris Lattnere7fb3602001-08-27 16:00:15 +000064 }
65
Chris Lattner4e840d42003-05-21 18:08:44 +000066 // Empty structures have alignment of 1 byte.
67 if (StructAlignment == 0) StructAlignment = 1;
68
Chris Lattnere7fb3602001-08-27 16:00:15 +000069 // Add padding to the end of the struct so that it could be put in an array
70 // and all array elements would be aligned correctly.
Chris Lattner59779c52008-12-08 07:21:39 +000071 if ((StructSize & (StructAlignment-1)) != 0)
Chris Lattnerbedb8c12008-12-08 07:11:56 +000072 StructSize = TargetData::RoundUpAlignment(StructSize, StructAlignment);
Chris Lattnere7fb3602001-08-27 16:00:15 +000073}
74
Chris Lattnere7ea48c2005-03-13 19:04:41 +000075
76/// getElementContainingOffset - Given a valid offset into the structure,
77/// return the structure index that contains it.
78unsigned StructLayout::getElementContainingOffset(uint64_t Offset) const {
Chris Lattner9182e3f2007-02-10 20:15:41 +000079 const uint64_t *SI =
80 std::upper_bound(&MemberOffsets[0], &MemberOffsets[NumElements], Offset);
81 assert(SI != &MemberOffsets[0] && "Offset not in structure type!");
Chris Lattnere7ea48c2005-03-13 19:04:41 +000082 --SI;
83 assert(*SI <= Offset && "upper_bound didn't work");
Chris Lattnerb361ec32007-10-29 02:40:02 +000084 assert((SI == &MemberOffsets[0] || *(SI-1) <= Offset) &&
Chris Lattner9182e3f2007-02-10 20:15:41 +000085 (SI+1 == &MemberOffsets[NumElements] || *(SI+1) > Offset) &&
Chris Lattnere7ea48c2005-03-13 19:04:41 +000086 "Upper bound didn't work!");
Chris Lattnerb361ec32007-10-29 02:40:02 +000087
88 // Multiple fields can have the same offset if any of them are zero sized.
89 // For example, in { i32, [0 x i32], i32 }, searching for offset 4 will stop
90 // at the i32 element, because it is the last element at that offset. This is
91 // the right one to return, because anything after it will have a higher
92 // offset, implying that this element is non-empty.
Chris Lattner9182e3f2007-02-10 20:15:41 +000093 return SI-&MemberOffsets[0];
Chris Lattnere7ea48c2005-03-13 19:04:41 +000094}
95
Chris Lattnere7fb3602001-08-27 16:00:15 +000096//===----------------------------------------------------------------------===//
Chris Lattnerd2b7cec2007-02-14 05:52:17 +000097// TargetAlignElem, TargetAlign support
98//===----------------------------------------------------------------------===//
99
100TargetAlignElem
101TargetAlignElem::get(AlignTypeEnum align_type, unsigned char abi_align,
Reid Spencerf734ea22007-02-19 22:35:00 +0000102 unsigned char pref_align, uint32_t bit_width) {
Duncan Sandsd1025932008-01-29 06:23:44 +0000103 assert(abi_align <= pref_align && "Preferred alignment worse than ABI!");
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000104 TargetAlignElem retval;
105 retval.AlignType = align_type;
106 retval.ABIAlign = abi_align;
107 retval.PrefAlign = pref_align;
108 retval.TypeBitWidth = bit_width;
109 return retval;
110}
111
112bool
Reid Spencerb7d61102007-02-15 02:11:06 +0000113TargetAlignElem::operator==(const TargetAlignElem &rhs) const {
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000114 return (AlignType == rhs.AlignType
115 && ABIAlign == rhs.ABIAlign
116 && PrefAlign == rhs.PrefAlign
117 && TypeBitWidth == rhs.TypeBitWidth);
118}
119
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000120const TargetAlignElem TargetData::InvalidAlignmentElem =
121 TargetAlignElem::get((AlignTypeEnum) -1, 0, 0, 0);
122
123//===----------------------------------------------------------------------===//
Chris Lattnere7fb3602001-08-27 16:00:15 +0000124// TargetData Class Implementation
125//===----------------------------------------------------------------------===//
126
Chris Lattnerb7aadfa2009-11-07 09:13:23 +0000127/// getInt - Get an integer ignoring errors.
128static unsigned getInt(StringRef R) {
129 unsigned Result = 0;
130 R.getAsInteger(10, Result);
131 return Result;
132}
133
Chris Lattnerb7aadfa2009-11-07 09:13:23 +0000134void TargetData::init(StringRef Desc) {
Owen Anderson90857502009-08-21 19:59:12 +0000135 LayoutMap = 0;
Owen Anderson8f60c562006-05-12 05:49:47 +0000136 LittleEndian = false;
Chris Lattner58092e32007-01-20 22:35:55 +0000137 PointerMemSize = 8;
Chris Lattnerb7aadfa2009-11-07 09:13:23 +0000138 PointerABIAlign = 8;
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000139 PointerPrefAlign = PointerABIAlign;
140
141 // Default alignments
Dan Gohman77c5b0d2009-04-01 18:10:16 +0000142 setAlignment(INTEGER_ALIGN, 1, 1, 1); // i1
143 setAlignment(INTEGER_ALIGN, 1, 1, 8); // i8
144 setAlignment(INTEGER_ALIGN, 2, 2, 16); // i16
145 setAlignment(INTEGER_ALIGN, 4, 4, 32); // i32
146 setAlignment(INTEGER_ALIGN, 4, 8, 64); // i64
Reid Spencerb7d61102007-02-15 02:11:06 +0000147 setAlignment(FLOAT_ALIGN, 4, 4, 32); // float
148 setAlignment(FLOAT_ALIGN, 8, 8, 64); // double
Dan Gohmand35626e2009-08-20 16:27:10 +0000149 setAlignment(VECTOR_ALIGN, 8, 8, 64); // v2i32, v1i64, ...
Reid Spencer1f437872007-02-15 22:07:05 +0000150 setAlignment(VECTOR_ALIGN, 16, 16, 128); // v16i8, v8i16, v4i32, ...
Dan Gohmand35626e2009-08-20 16:27:10 +0000151 setAlignment(AGGREGATE_ALIGN, 0, 8, 0); // struct
Rafael Espindola588af2f2007-09-07 14:52:14 +0000152
Chris Lattnerb7aadfa2009-11-07 09:13:23 +0000153 while (!Desc.empty()) {
154 std::pair<StringRef, StringRef> Split = Desc.split('-');
155 StringRef Token = Split.first;
156 Desc = Split.second;
157
158 if (Token.empty())
159 continue;
160
161 Split = Token.split(':');
162 StringRef Specifier = Split.first;
163 Token = Split.second;
164
165 assert(!Specifier.empty() && "Can't be empty here");
166
Chris Lattnere82bdc42009-11-07 09:35:34 +0000167 switch (Specifier[0]) {
Owen Anderson8f60c562006-05-12 05:49:47 +0000168 case 'E':
Owen Anderson571a13f2006-05-12 06:06:55 +0000169 LittleEndian = false;
170 break;
Owen Anderson8f60c562006-05-12 05:49:47 +0000171 case 'e':
Owen Anderson571a13f2006-05-12 06:06:55 +0000172 LittleEndian = true;
173 break;
Owen Anderson8f60c562006-05-12 05:49:47 +0000174 case 'p':
Chris Lattnerb7aadfa2009-11-07 09:13:23 +0000175 Split = Token.split(':');
176 PointerMemSize = getInt(Split.first) / 8;
177 Split = Split.second.split(':');
178 PointerABIAlign = getInt(Split.first) / 8;
179 Split = Split.second.split(':');
180 PointerPrefAlign = getInt(Split.first) / 8;
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000181 if (PointerPrefAlign == 0)
182 PointerPrefAlign = PointerABIAlign;
Owen Anderson571a13f2006-05-12 06:06:55 +0000183 break;
Owen Anderson8f60c562006-05-12 05:49:47 +0000184 case 'i':
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000185 case 'v':
186 case 'f':
Rafael Espindola588af2f2007-09-07 14:52:14 +0000187 case 'a':
188 case 's': {
Chris Lattnerb7aadfa2009-11-07 09:13:23 +0000189 AlignTypeEnum AlignType;
190 switch (Specifier[0]) {
191 default:
192 case 'i': AlignType = INTEGER_ALIGN; break;
193 case 'v': AlignType = VECTOR_ALIGN; break;
194 case 'f': AlignType = FLOAT_ALIGN; break;
195 case 'a': AlignType = AGGREGATE_ALIGN; break;
196 case 's': AlignType = STACK_ALIGN; break;
Rafael Espindola588af2f2007-09-07 14:52:14 +0000197 }
Chris Lattnerb7aadfa2009-11-07 09:13:23 +0000198 unsigned Size = getInt(Specifier.substr(1));
199 Split = Token.split(':');
200 unsigned char ABIAlign = getInt(Split.first) / 8;
201
202 Split = Split.second.split(':');
203 unsigned char PrefAlign = getInt(Split.first) / 8;
204 if (PrefAlign == 0)
205 PrefAlign = ABIAlign;
206 setAlignment(AlignType, ABIAlign, PrefAlign, Size);
Owen Anderson571a13f2006-05-12 06:06:55 +0000207 break;
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000208 }
Chris Lattnere82bdc42009-11-07 09:35:34 +0000209 case 'n': // Native integer types.
210 Specifier = Specifier.substr(1);
211 do {
212 if (unsigned Width = getInt(Specifier))
213 LegalIntWidths.push_back(Width);
214 Split = Token.split(':');
215 Specifier = Split.first;
216 Token = Split.second;
217 } while (!Specifier.empty() || !Token.empty());
218 break;
219
Owen Anderson8f60c562006-05-12 05:49:47 +0000220 default:
Owen Anderson571a13f2006-05-12 06:06:55 +0000221 break;
Owen Anderson8f60c562006-05-12 05:49:47 +0000222 }
223 }
224}
225
Chris Lattner2e074942009-11-07 09:23:04 +0000226/// Default ctor.
227///
228/// @note This has to exist, because this is a pass, but it should never be
229/// used.
230TargetData::TargetData() : ImmutablePass(&ID) {
Chris Lattner75361b62010-04-07 22:58:41 +0000231 report_fatal_error("Bad TargetData ctor used. "
Chris Lattner2e074942009-11-07 09:23:04 +0000232 "Tool did not specify a TargetData to use?");
233}
234
Devang Patel794fd752007-05-01 21:15:47 +0000235TargetData::TargetData(const Module *M)
Dan Gohmanae73dc12008-09-04 17:05:41 +0000236 : ImmutablePass(&ID) {
Reid Spencer26f23852007-01-26 08:11:39 +0000237 init(M->getDataLayout());
Chris Lattner53a0c382003-04-24 19:09:05 +0000238}
239
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000240void
241TargetData::setAlignment(AlignTypeEnum align_type, unsigned char abi_align,
Reid Spencerf734ea22007-02-19 22:35:00 +0000242 unsigned char pref_align, uint32_t bit_width) {
Duncan Sandsd1025932008-01-29 06:23:44 +0000243 assert(abi_align <= pref_align && "Preferred alignment worse than ABI!");
Chris Lattneraffeb562007-02-17 00:41:42 +0000244 for (unsigned i = 0, e = Alignments.size(); i != e; ++i) {
245 if (Alignments[i].AlignType == align_type &&
246 Alignments[i].TypeBitWidth == bit_width) {
247 // Update the abi, preferred alignments.
248 Alignments[i].ABIAlign = abi_align;
249 Alignments[i].PrefAlign = pref_align;
250 return;
251 }
252 }
253
254 Alignments.push_back(TargetAlignElem::get(align_type, abi_align,
255 pref_align, bit_width));
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000256}
257
Chris Lattneraffeb562007-02-17 00:41:42 +0000258/// getAlignmentInfo - Return the alignment (either ABI if ABIInfo = true or
259/// preferred if ABIInfo = false) the target wants for the specified datatype.
Reid Spencerf734ea22007-02-19 22:35:00 +0000260unsigned TargetData::getAlignmentInfo(AlignTypeEnum AlignType,
Chris Lattner9c4428b2008-01-10 00:30:57 +0000261 uint32_t BitWidth, bool ABIInfo,
262 const Type *Ty) const {
Chris Lattneraffeb562007-02-17 00:41:42 +0000263 // Check to see if we have an exact match and remember the best match we see.
264 int BestMatchIdx = -1;
Reid Spencerf734ea22007-02-19 22:35:00 +0000265 int LargestInt = -1;
Chris Lattneraffeb562007-02-17 00:41:42 +0000266 for (unsigned i = 0, e = Alignments.size(); i != e; ++i) {
267 if (Alignments[i].AlignType == AlignType &&
268 Alignments[i].TypeBitWidth == BitWidth)
269 return ABIInfo ? Alignments[i].ABIAlign : Alignments[i].PrefAlign;
270
271 // The best match so far depends on what we're looking for.
Dan Gohman6e8fd902010-04-23 19:41:15 +0000272 if (AlignType == INTEGER_ALIGN &&
273 Alignments[i].AlignType == INTEGER_ALIGN) {
Reid Spencerf734ea22007-02-19 22:35:00 +0000274 // The "best match" for integers is the smallest size that is larger than
275 // the BitWidth requested.
276 if (Alignments[i].TypeBitWidth > BitWidth && (BestMatchIdx == -1 ||
277 Alignments[i].TypeBitWidth < Alignments[BestMatchIdx].TypeBitWidth))
278 BestMatchIdx = i;
279 // However, if there isn't one that's larger, then we must use the
280 // largest one we have (see below)
281 if (LargestInt == -1 ||
282 Alignments[i].TypeBitWidth > Alignments[LargestInt].TypeBitWidth)
283 LargestInt = i;
Chris Lattneraffeb562007-02-17 00:41:42 +0000284 }
Chris Lattneraffeb562007-02-17 00:41:42 +0000285 }
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000286
Chris Lattneraffeb562007-02-17 00:41:42 +0000287 // Okay, we didn't find an exact solution. Fall back here depending on what
288 // is being looked for.
Chris Lattner9c4428b2008-01-10 00:30:57 +0000289 if (BestMatchIdx == -1) {
290 // If we didn't find an integer alignment, fall back on most conservative.
291 if (AlignType == INTEGER_ALIGN) {
292 BestMatchIdx = LargestInt;
293 } else {
294 assert(AlignType == VECTOR_ALIGN && "Unknown alignment type!");
Dan Gohman9fbb52d2009-02-16 23:14:14 +0000295
Dan Gohman6e8fd902010-04-23 19:41:15 +0000296 // By default, use natural alignment for vector types. This is consistent
297 // with what clang and llvm-gcc do.
298 unsigned Align = getTypeAllocSize(cast<VectorType>(Ty)->getElementType());
299 Align *= cast<VectorType>(Ty)->getNumElements();
300 // If the alignment is not a power of 2, round up to the next power of 2.
301 // This happens for non-power-of-2 length vectors.
302 if (Align & (Align-1))
303 Align = llvm::NextPowerOf2(Align);
304 return Align;
Dan Gohman9fbb52d2009-02-16 23:14:14 +0000305 }
Chris Lattner9c4428b2008-01-10 00:30:57 +0000306 }
Dan Gohman9fbb52d2009-02-16 23:14:14 +0000307
Reid Spencerf734ea22007-02-19 22:35:00 +0000308 // Since we got a "best match" index, just return it.
Chris Lattneraffeb562007-02-17 00:41:42 +0000309 return ABIInfo ? Alignments[BestMatchIdx].ABIAlign
310 : Alignments[BestMatchIdx].PrefAlign;
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000311}
312
Bill Wendlingdd5eb022009-12-03 00:17:12 +0000313namespace {
Bill Wendling5eea3422009-11-18 01:03:56 +0000314
315class StructLayoutMap : public AbstractTypeUser {
Bill Wendling1500c4f2009-12-04 21:03:02 +0000316 typedef DenseMap<const StructType*, StructLayout*> LayoutInfoTy;
Bill Wendling5eea3422009-11-18 01:03:56 +0000317 LayoutInfoTy LayoutInfo;
318
Chris Lattner551dec52009-12-17 20:00:21 +0000319 void RemoveEntry(LayoutInfoTy::iterator I, bool WasAbstract) {
320 I->second->~StructLayout();
321 free(I->second);
322 if (WasAbstract)
323 I->first->removeAbstractTypeUser(this);
324 LayoutInfo.erase(I);
325 }
326
327
Bill Wendling5eea3422009-11-18 01:03:56 +0000328 /// refineAbstractType - The callback method invoked when an abstract type is
329 /// resolved to another type. An object must override this method to update
330 /// its internal state to reference NewType instead of OldType.
331 ///
332 virtual void refineAbstractType(const DerivedType *OldTy,
333 const Type *) {
Chris Lattner551dec52009-12-17 20:00:21 +0000334 LayoutInfoTy::iterator I = LayoutInfo.find(cast<const StructType>(OldTy));
335 assert(I != LayoutInfo.end() && "Using type but not in map?");
336 RemoveEntry(I, true);
Bill Wendling5eea3422009-11-18 01:03:56 +0000337 }
338
339 /// typeBecameConcrete - The other case which AbstractTypeUsers must be aware
340 /// of is when a type makes the transition from being abstract (where it has
341 /// clients on its AbstractTypeUsers list) to concrete (where it does not).
342 /// This method notifies ATU's when this occurs for a type.
343 ///
344 virtual void typeBecameConcrete(const DerivedType *AbsTy) {
Chris Lattner551dec52009-12-17 20:00:21 +0000345 LayoutInfoTy::iterator I = LayoutInfo.find(cast<const StructType>(AbsTy));
346 assert(I != LayoutInfo.end() && "Using type but not in map?");
347 RemoveEntry(I, true);
Bill Wendling5eea3422009-11-18 01:03:56 +0000348 }
349
Bill Wendling5eea3422009-11-18 01:03:56 +0000350public:
351 virtual ~StructLayoutMap() {
352 // Remove any layouts.
353 for (LayoutInfoTy::iterator
Bill Wendlingdd5eb022009-12-03 00:17:12 +0000354 I = LayoutInfo.begin(), E = LayoutInfo.end(); I != E; ++I) {
355 const Type *Key = I->first;
356 StructLayout *Value = I->second;
357
Bill Wendling1500c4f2009-12-04 21:03:02 +0000358 if (Key->isAbstract())
Bill Wendlingdd5eb022009-12-03 00:17:12 +0000359 Key->removeAbstractTypeUser(this);
360
Bill Wendling1500c4f2009-12-04 21:03:02 +0000361 Value->~StructLayout();
362 free(Value);
Bill Wendlingdd5eb022009-12-03 00:17:12 +0000363 }
Bill Wendling5eea3422009-11-18 01:03:56 +0000364 }
365
Bill Wendling56816892009-12-05 01:43:33 +0000366 void InvalidateEntry(const StructType *Ty) {
Bill Wendling688da282009-12-05 01:46:01 +0000367 LayoutInfoTy::iterator I = LayoutInfo.find(Ty);
368 if (I == LayoutInfo.end()) return;
Chris Lattner551dec52009-12-17 20:00:21 +0000369 RemoveEntry(I, Ty->isAbstract());
Bill Wendling56816892009-12-05 01:43:33 +0000370 }
371
Bill Wendlingdd5eb022009-12-03 00:17:12 +0000372 StructLayout *&operator[](const StructType *STy) {
Bill Wendling5eea3422009-11-18 01:03:56 +0000373 return LayoutInfo[STy];
374 }
375
376 // for debugging...
377 virtual void dump() const {}
378};
379
Bill Wendling1500c4f2009-12-04 21:03:02 +0000380} // end anonymous namespace
Owen Anderson2ea20152009-08-20 23:51:44 +0000381
382TargetData::~TargetData() {
Bill Wendlingdd5eb022009-12-03 00:17:12 +0000383 delete static_cast<StructLayoutMap*>(LayoutMap);
Chris Lattner0e7ac162004-02-26 08:02:17 +0000384}
385
Chris Lattner9182e3f2007-02-10 20:15:41 +0000386const StructLayout *TargetData::getStructLayout(const StructType *Ty) const {
Owen Anderson90857502009-08-21 19:59:12 +0000387 if (!LayoutMap)
Bill Wendling5eea3422009-11-18 01:03:56 +0000388 LayoutMap = new StructLayoutMap();
Chris Lattner9182e3f2007-02-10 20:15:41 +0000389
Bill Wendlingdd5eb022009-12-03 00:17:12 +0000390 StructLayoutMap *STM = static_cast<StructLayoutMap*>(LayoutMap);
391 StructLayout *&SL = (*STM)[Ty];
Chris Lattnerf6ca09a2007-02-10 20:26:17 +0000392 if (SL) return SL;
Chris Lattner9182e3f2007-02-10 20:15:41 +0000393
394 // Otherwise, create the struct layout. Because it is variable length, we
395 // malloc it, then use placement new.
Jeff Cohen44f5fb42007-04-09 19:26:30 +0000396 int NumElts = Ty->getNumElements();
Chris Lattner9182e3f2007-02-10 20:15:41 +0000397 StructLayout *L =
Bill Wendling5eea3422009-11-18 01:03:56 +0000398 (StructLayout *)malloc(sizeof(StructLayout)+(NumElts-1) * sizeof(uint64_t));
Chris Lattnerf6ca09a2007-02-10 20:26:17 +0000399
400 // Set SL before calling StructLayout's ctor. The ctor could cause other
401 // entries to be added to TheMap, invalidating our reference.
402 SL = L;
403
Chris Lattner9182e3f2007-02-10 20:15:41 +0000404 new (L) StructLayout(Ty, *this);
Bill Wendlingdd5eb022009-12-03 00:17:12 +0000405
406 if (Ty->isAbstract())
407 Ty->addAbstractTypeUser(STM);
408
Chris Lattner9182e3f2007-02-10 20:15:41 +0000409 return L;
410}
411
412/// InvalidateStructLayoutInfo - TargetData speculatively caches StructLayout
413/// objects. If a TargetData object is alive when types are being refined and
414/// removed, this method must be called whenever a StructType is removed to
415/// avoid a dangling pointer in this cache.
416void TargetData::InvalidateStructLayoutInfo(const StructType *Ty) const {
Owen Anderson90857502009-08-21 19:59:12 +0000417 if (!LayoutMap) return; // No cache.
Bill Wendlingcb064032009-12-03 01:54:07 +0000418
Chris Lattner551dec52009-12-17 20:00:21 +0000419 static_cast<StructLayoutMap*>(LayoutMap)->InvalidateEntry(Ty);
Bill Wendlingdd5eb022009-12-03 00:17:12 +0000420}
Chris Lattner9182e3f2007-02-10 20:15:41 +0000421
Owen Anderson2577c222006-05-12 07:01:44 +0000422std::string TargetData::getStringRepresentation() const {
Chris Lattnerb7aadfa2009-11-07 09:13:23 +0000423 std::string Result;
424 raw_string_ostream OS(Result);
425
426 OS << (LittleEndian ? "e" : "E")
427 << "-p:" << PointerMemSize*8 << ':' << PointerABIAlign*8
428 << ':' << PointerPrefAlign*8;
Chris Lattner2e074942009-11-07 09:23:04 +0000429 for (unsigned i = 0, e = Alignments.size(); i != e; ++i) {
430 const TargetAlignElem &AI = Alignments[i];
431 OS << '-' << (char)AI.AlignType << AI.TypeBitWidth << ':'
432 << AI.ABIAlign*8 << ':' << AI.PrefAlign*8;
433 }
Chris Lattner7e897382009-11-08 02:32:01 +0000434
435 if (!LegalIntWidths.empty()) {
436 OS << "-n" << (unsigned)LegalIntWidths[0];
437
438 for (unsigned i = 1, e = LegalIntWidths.size(); i != e; ++i)
439 OS << ':' << (unsigned)LegalIntWidths[i];
440 }
Chris Lattnerb7aadfa2009-11-07 09:13:23 +0000441 return OS.str();
Owen Anderson2577c222006-05-12 07:01:44 +0000442}
443
Chris Lattner8dff24f2006-01-14 00:07:34 +0000444
Duncan Sands514ab342007-11-01 20:53:16 +0000445uint64_t TargetData::getTypeSizeInBits(const Type *Ty) const {
Chris Lattnerf59ce922001-12-13 00:46:11 +0000446 assert(Ty->isSized() && "Cannot getTypeInfo() on a type that is unsized!");
Chris Lattnerf70c22b2004-06-17 18:19:28 +0000447 switch (Ty->getTypeID()) {
Chris Lattnere7fb3602001-08-27 16:00:15 +0000448 case Type::LabelTyID:
449 case Type::PointerTyID:
Duncan Sands514ab342007-11-01 20:53:16 +0000450 return getPointerSizeInBits();
Chris Lattnere7fb3602001-08-27 16:00:15 +0000451 case Type::ArrayTyID: {
Chris Lattner59b00672004-07-01 17:32:59 +0000452 const ArrayType *ATy = cast<ArrayType>(Ty);
Dan Gohmanaa9d8542010-02-25 15:20:39 +0000453 return getTypeAllocSizeInBits(ATy->getElementType())*ATy->getNumElements();
Chris Lattner527efc62004-12-01 17:14:28 +0000454 }
Chris Lattnerbedb8c12008-12-08 07:11:56 +0000455 case Type::StructTyID:
Chris Lattnere7fb3602001-08-27 16:00:15 +0000456 // Get the layout annotation... which is lazily created on demand.
Chris Lattnerbedb8c12008-12-08 07:11:56 +0000457 return getStructLayout(cast<StructType>(Ty))->getSizeInBits();
Chris Lattner93b122d2010-03-16 21:25:55 +0000458 case Type::UnionTyID: {
459 const UnionType *UnTy = cast<UnionType>(Ty);
460 uint64_t Size = 0;
461 for (UnionType::element_iterator i = UnTy->element_begin(),
462 e = UnTy->element_end(); i != e; ++i) {
463 Size = std::max(Size, getTypeSizeInBits(*i));
464 }
465 return Size;
466 }
Duncan Sands514ab342007-11-01 20:53:16 +0000467 case Type::IntegerTyID:
468 return cast<IntegerType>(Ty)->getBitWidth();
Chris Lattner58092e32007-01-20 22:35:55 +0000469 case Type::VoidTyID:
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000470 return 8;
Duncan Sands514ab342007-11-01 20:53:16 +0000471 case Type::FloatTyID:
472 return 32;
473 case Type::DoubleTyID:
474 return 64;
Dale Johannesen8c1e6a12007-08-03 20:20:50 +0000475 case Type::PPC_FP128TyID:
476 case Type::FP128TyID:
Duncan Sands514ab342007-11-01 20:53:16 +0000477 return 128;
Dale Johannesen8c1e6a12007-08-03 20:20:50 +0000478 // In memory objects this is always aligned to a higher boundary, but
Duncan Sands514ab342007-11-01 20:53:16 +0000479 // only 80 bits contain information.
Dale Johannesen8c1e6a12007-08-03 20:20:50 +0000480 case Type::X86_FP80TyID:
Duncan Sands514ab342007-11-01 20:53:16 +0000481 return 80;
Chris Lattnerbedb8c12008-12-08 07:11:56 +0000482 case Type::VectorTyID:
483 return cast<VectorType>(Ty)->getBitWidth();
Chris Lattner58092e32007-01-20 22:35:55 +0000484 default:
Torok Edwinc23197a2009-07-14 16:55:14 +0000485 llvm_unreachable("TargetData::getTypeSizeInBits(): Unsupported type");
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000486 break;
Chris Lattner58092e32007-01-20 22:35:55 +0000487 }
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000488 return 0;
Chris Lattnere7fb3602001-08-27 16:00:15 +0000489}
490
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000491/*!
492 \param abi_or_pref Flag that determines which alignment is returned. true
493 returns the ABI alignment, false returns the preferred alignment.
494 \param Ty The underlying type for which alignment is determined.
495
496 Get the ABI (\a abi_or_pref == true) or preferred alignment (\a abi_or_pref
497 == false) for the requested type \a Ty.
498 */
Chris Lattnerae6f1fa2007-02-16 22:25:34 +0000499unsigned char TargetData::getAlignment(const Type *Ty, bool abi_or_pref) const {
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000500 int AlignType = -1;
501
502 assert(Ty->isSized() && "Cannot getTypeInfo() on a type that is unsized!");
503 switch (Ty->getTypeID()) {
Chris Lattnerbedb8c12008-12-08 07:11:56 +0000504 // Early escape for the non-numeric types.
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000505 case Type::LabelTyID:
506 case Type::PointerTyID:
507 return (abi_or_pref
508 ? getPointerABIAlignment()
509 : getPointerPrefAlignment());
Chris Lattnerae6f1fa2007-02-16 22:25:34 +0000510 case Type::ArrayTyID:
511 return getAlignment(cast<ArrayType>(Ty)->getElementType(), abi_or_pref);
Dan Gohman9fbb52d2009-02-16 23:14:14 +0000512
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000513 case Type::StructTyID: {
Chris Lattnerae6f1fa2007-02-16 22:25:34 +0000514 // Packed structure types always have an ABI alignment of one.
Chris Lattner3ebb2e02007-02-16 23:11:51 +0000515 if (cast<StructType>(Ty)->isPacked() && abi_or_pref)
Chris Lattnerae6f1fa2007-02-16 22:25:34 +0000516 return 1;
Dan Gohman9fbb52d2009-02-16 23:14:14 +0000517
Chris Lattnerae6f1fa2007-02-16 22:25:34 +0000518 // Get the layout annotation... which is lazily created on demand.
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000519 const StructLayout *Layout = getStructLayout(cast<StructType>(Ty));
Chris Lattner9c4428b2008-01-10 00:30:57 +0000520 unsigned Align = getAlignmentInfo(AGGREGATE_ALIGN, 0, abi_or_pref, Ty);
Chris Lattneraffeb562007-02-17 00:41:42 +0000521 return std::max(Align, (unsigned)Layout->getAlignment());
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000522 }
Chris Lattner93b122d2010-03-16 21:25:55 +0000523 case Type::UnionTyID: {
524 const UnionType *UnTy = cast<UnionType>(Ty);
525 unsigned Align = 1;
526
527 // Unions need the maximum alignment of all their entries
528 for (UnionType::element_iterator i = UnTy->element_begin(),
529 e = UnTy->element_end(); i != e; ++i) {
530 Align = std::max(Align, (unsigned)getAlignment(*i, abi_or_pref));
531 }
532 return Align;
533 }
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000534 case Type::IntegerTyID:
535 case Type::VoidTyID:
536 AlignType = INTEGER_ALIGN;
537 break;
538 case Type::FloatTyID:
539 case Type::DoubleTyID:
Dale Johannesen8c1e6a12007-08-03 20:20:50 +0000540 // PPC_FP128TyID and FP128TyID have different data contents, but the
541 // same size and alignment, so they look the same here.
542 case Type::PPC_FP128TyID:
543 case Type::FP128TyID:
544 case Type::X86_FP80TyID:
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000545 AlignType = FLOAT_ALIGN;
546 break;
Chris Lattner9c4428b2008-01-10 00:30:57 +0000547 case Type::VectorTyID:
548 AlignType = VECTOR_ALIGN;
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000549 break;
550 default:
Torok Edwinc23197a2009-07-14 16:55:14 +0000551 llvm_unreachable("Bad type for getAlignment!!!");
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000552 break;
553 }
554
Duncan Sands514ab342007-11-01 20:53:16 +0000555 return getAlignmentInfo((AlignTypeEnum)AlignType, getTypeSizeInBits(Ty),
Chris Lattner9c4428b2008-01-10 00:30:57 +0000556 abi_or_pref, Ty);
Chris Lattner58092e32007-01-20 22:35:55 +0000557}
558
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000559unsigned char TargetData::getABITypeAlignment(const Type *Ty) const {
560 return getAlignment(Ty, true);
561}
562
Chris Lattnerda63b3a2010-01-25 23:18:11 +0000563/// getABIIntegerTypeAlignment - Return the minimum ABI-required alignment for
564/// an integer type of the specified bitwidth.
565unsigned char TargetData::getABIIntegerTypeAlignment(unsigned BitWidth) const {
566 return getAlignmentInfo(INTEGER_ALIGN, BitWidth, true, 0);
567}
568
569
Rafael Espindola588af2f2007-09-07 14:52:14 +0000570unsigned char TargetData::getCallFrameTypeAlignment(const Type *Ty) const {
571 for (unsigned i = 0, e = Alignments.size(); i != e; ++i)
572 if (Alignments[i].AlignType == STACK_ALIGN)
573 return Alignments[i].ABIAlign;
574
575 return getABITypeAlignment(Ty);
576}
577
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000578unsigned char TargetData::getPrefTypeAlignment(const Type *Ty) const {
579 return getAlignment(Ty, false);
Chris Lattnere7fb3602001-08-27 16:00:15 +0000580}
581
Evan Chengde268f72007-01-24 07:03:39 +0000582unsigned char TargetData::getPreferredTypeAlignmentShift(const Type *Ty) const {
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000583 unsigned Align = (unsigned) getPrefTypeAlignment(Ty);
Chris Lattnerd2b0bb42004-08-17 19:13:00 +0000584 assert(!(Align & (Align-1)) && "Alignment is not a power of two!");
Chris Lattner0561b3f2005-08-02 19:26:06 +0000585 return Log2_32(Align);
Chris Lattnerd2b0bb42004-08-17 19:13:00 +0000586}
587
Chris Lattnerf0453282003-12-22 05:01:15 +0000588/// getIntPtrType - Return an unsigned integer type that is the same size or
589/// greater to the host pointer size.
Owen Anderson1d0be152009-08-13 21:58:54 +0000590const IntegerType *TargetData::getIntPtrType(LLVMContext &C) const {
591 return IntegerType::get(C, getPointerSizeInBits());
Chris Lattnerf0453282003-12-22 05:01:15 +0000592}
593
594
Chris Lattnerddce8d22007-02-10 19:33:15 +0000595uint64_t TargetData::getIndexedOffset(const Type *ptrTy, Value* const* Indices,
596 unsigned NumIndices) const {
Vikram S. Adveed0030e2002-08-04 20:52:39 +0000597 const Type *Ty = ptrTy;
Duncan Sands1df98592010-02-16 11:11:14 +0000598 assert(Ty->isPointerTy() && "Illegal argument for getIndexedOffset()");
Vikram S. Advef66723f2002-05-19 15:28:02 +0000599 uint64_t Result = 0;
Chris Lattnere7fb3602001-08-27 16:00:15 +0000600
Chris Lattnerddce8d22007-02-10 19:33:15 +0000601 generic_gep_type_iterator<Value* const*>
602 TI = gep_type_begin(ptrTy, Indices, Indices+NumIndices);
603 for (unsigned CurIDX = 0; CurIDX != NumIndices; ++CurIDX, ++TI) {
Chris Lattner28977af2004-04-05 01:30:19 +0000604 if (const StructType *STy = dyn_cast<StructType>(*TI)) {
Owen Anderson1d0be152009-08-13 21:58:54 +0000605 assert(Indices[CurIDX]->getType() ==
606 Type::getInt32Ty(ptrTy->getContext()) &&
Reid Spencer1ede29c2007-03-01 19:48:16 +0000607 "Illegal struct idx");
Chris Lattnerddce8d22007-02-10 19:33:15 +0000608 unsigned FieldNo = cast<ConstantInt>(Indices[CurIDX])->getZExtValue();
Chris Lattnere7fb3602001-08-27 16:00:15 +0000609
610 // Get structure layout information...
611 const StructLayout *Layout = getStructLayout(STy);
612
613 // Add in the offset, as calculated by the structure layout info...
Chris Lattnerb1919e22007-02-10 19:55:17 +0000614 Result += Layout->getElementOffset(FieldNo);
Vikram S. Adveed0030e2002-08-04 20:52:39 +0000615
Chris Lattnere7fb3602001-08-27 16:00:15 +0000616 // Update Ty to refer to current element
Chris Lattnerd21cd802004-02-09 04:37:31 +0000617 Ty = STy->getElementType(FieldNo);
Chris Lattner93b122d2010-03-16 21:25:55 +0000618 } else if (const UnionType *UnTy = dyn_cast<UnionType>(*TI)) {
619 unsigned FieldNo = cast<ConstantInt>(Indices[CurIDX])->getZExtValue();
620
621 // Offset into union is canonically 0, but type changes
622 Ty = UnTy->getElementType(FieldNo);
Chris Lattner28977af2004-04-05 01:30:19 +0000623 } else {
624 // Update Ty to refer to current element
625 Ty = cast<SequentialType>(Ty)->getElementType();
626
627 // Get the array index and the size of each array element.
Chris Lattner34e9d172010-04-17 19:02:33 +0000628 if (int64_t arrayIdx = cast<ConstantInt>(Indices[CurIDX])->getSExtValue())
629 Result += arrayIdx * (int64_t)getTypeAllocSize(Ty);
Chris Lattnere7fb3602001-08-27 16:00:15 +0000630 }
631 }
632
633 return Result;
634}
Brian Gaeked0fde302003-11-11 22:41:34 +0000635
Duncan Sandsd1025932008-01-29 06:23:44 +0000636/// getPreferredAlignment - Return the preferred alignment of the specified
637/// global. This includes an explicitly requested alignment (if the global
638/// has one).
639unsigned TargetData::getPreferredAlignment(const GlobalVariable *GV) const {
640 const Type *ElemType = GV->getType()->getElementType();
641 unsigned Alignment = getPrefTypeAlignment(ElemType);
642 if (GV->getAlignment() > Alignment)
643 Alignment = GV->getAlignment();
644
645 if (GV->hasInitializer()) {
646 if (Alignment < 16) {
647 // If the global is not external, see if it is large. If so, give it a
648 // larger alignment.
Dan Gohmanf860db22010-04-02 03:04:37 +0000649 if (getTypeSizeInBits(ElemType) > 128)
Duncan Sandsd1025932008-01-29 06:23:44 +0000650 Alignment = 16; // 16-byte alignment.
651 }
652 }
653 return Alignment;
654}
655
Devang Patelf9c197e2006-10-24 20:32:14 +0000656/// getPreferredAlignmentLog - Return the preferred alignment of the
657/// specified global, returned in log form. This includes an explicitly
658/// requested alignment (if the global has one).
659unsigned TargetData::getPreferredAlignmentLog(const GlobalVariable *GV) const {
Duncan Sandsd1025932008-01-29 06:23:44 +0000660 return Log2_32(getPreferredAlignment(GV));
Devang Patelf9c197e2006-10-24 20:32:14 +0000661}