blob: abee2e192446c0073f2e5215ee2910209a7cf1bd [file] [log] [blame]
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001//===-- TargetData.cpp - Data size & alignment routines --------------------==//
2//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner081ce942007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Dan Gohmanf17a25c2007-07-18 16:29:46 +00007//
8//===----------------------------------------------------------------------===//
9//
10// This file defines target properties related to datatype size/offset/alignment
11// information.
12//
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
19#include "llvm/Target/TargetData.h"
Dan Gohmanf17a25c2007-07-18 16:29:46 +000020#include "llvm/Constants.h"
Bill Wendlingc3bd98752009-11-18 01:03:56 +000021#include "llvm/DerivedTypes.h"
22#include "llvm/Module.h"
Dan Gohmanf17a25c2007-07-18 16:29:46 +000023#include "llvm/Support/GetElementPtrTypeIterator.h"
24#include "llvm/Support/MathExtras.h"
25#include "llvm/Support/ManagedStatic.h"
Edwin Török675d5622009-07-11 20:10:48 +000026#include "llvm/Support/ErrorHandling.h"
Chris Lattner044fe3e2009-11-07 09:13:23 +000027#include "llvm/Support/raw_ostream.h"
Owen Anderson9b43b972009-08-20 23:51:44 +000028#include "llvm/System/Mutex.h"
Dan Gohmanf17a25c2007-07-18 16:29:46 +000029#include "llvm/ADT/DenseMap.h"
Dan Gohmanf17a25c2007-07-18 16:29:46 +000030#include <algorithm>
31#include <cstdlib>
Dan Gohmanf17a25c2007-07-18 16:29:46 +000032using namespace llvm;
33
34// Handle the Pass registration stuff necessary to use TargetData's.
Dan Gohman089efff2008-05-13 00:00:25 +000035
36// Register the default SparcV9 implementation...
37static RegisterPass<TargetData> X("targetdata", "Target Data Layout", false,
38 true);
Dan Gohmanf17a25c2007-07-18 16:29:46 +000039char TargetData::ID = 0;
40
41//===----------------------------------------------------------------------===//
42// Support for StructLayout
43//===----------------------------------------------------------------------===//
44
45StructLayout::StructLayout(const StructType *ST, const TargetData &TD) {
46 StructAlignment = 0;
47 StructSize = 0;
48 NumElements = ST->getNumElements();
49
Chris Lattner97c1e142008-12-08 07:11:56 +000050 // Loop over each of the elements, placing them in memory.
Dan Gohmanf17a25c2007-07-18 16:29:46 +000051 for (unsigned i = 0, e = NumElements; i != e; ++i) {
52 const Type *Ty = ST->getElementType(i);
Duncan Sands4afc5752008-06-04 08:21:45 +000053 unsigned TyAlign = ST->isPacked() ? 1 : TD.getABITypeAlignment(Ty);
Dan Gohmanf17a25c2007-07-18 16:29:46 +000054
Chris Lattner97c1e142008-12-08 07:11:56 +000055 // Add padding if necessary to align the data element properly.
Duncan Sands79c36992008-12-09 09:58:11 +000056 if ((StructSize & (TyAlign-1)) != 0)
Chris Lattner97c1e142008-12-08 07:11:56 +000057 StructSize = TargetData::RoundUpAlignment(StructSize, TyAlign);
Dan Gohmanf17a25c2007-07-18 16:29:46 +000058
Chris Lattner97c1e142008-12-08 07:11:56 +000059 // Keep track of maximum alignment constraint.
Dan Gohmanf17a25c2007-07-18 16:29:46 +000060 StructAlignment = std::max(TyAlign, StructAlignment);
61
62 MemberOffsets[i] = StructSize;
Duncan Sandsec4f97d2009-05-09 07:06:46 +000063 StructSize += TD.getTypeAllocSize(Ty); // Consume space for this data item
Dan Gohmanf17a25c2007-07-18 16:29:46 +000064 }
65
66 // Empty structures have alignment of 1 byte.
67 if (StructAlignment == 0) StructAlignment = 1;
68
69 // 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 Lattner700a35b2008-12-08 07:21:39 +000071 if ((StructSize & (StructAlignment-1)) != 0)
Chris Lattner97c1e142008-12-08 07:11:56 +000072 StructSize = TargetData::RoundUpAlignment(StructSize, StructAlignment);
Dan Gohmanf17a25c2007-07-18 16:29:46 +000073}
74
75
76/// getElementContainingOffset - Given a valid offset into the structure,
77/// return the structure index that contains it.
78unsigned StructLayout::getElementContainingOffset(uint64_t Offset) const {
79 const uint64_t *SI =
80 std::upper_bound(&MemberOffsets[0], &MemberOffsets[NumElements], Offset);
81 assert(SI != &MemberOffsets[0] && "Offset not in structure type!");
82 --SI;
83 assert(*SI <= Offset && "upper_bound didn't work");
Chris Lattner49d6b242007-10-29 02:40:02 +000084 assert((SI == &MemberOffsets[0] || *(SI-1) <= Offset) &&
Dan Gohmanf17a25c2007-07-18 16:29:46 +000085 (SI+1 == &MemberOffsets[NumElements] || *(SI+1) > Offset) &&
86 "Upper bound didn't work!");
Chris Lattner49d6b242007-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.
Dan Gohmanf17a25c2007-07-18 16:29:46 +000093 return SI-&MemberOffsets[0];
94}
95
96//===----------------------------------------------------------------------===//
97// TargetAlignElem, TargetAlign support
98//===----------------------------------------------------------------------===//
99
100TargetAlignElem
101TargetAlignElem::get(AlignTypeEnum align_type, unsigned char abi_align,
102 unsigned char pref_align, uint32_t bit_width) {
Duncan Sands935686e2008-01-29 06:23:44 +0000103 assert(abi_align <= pref_align && "Preferred alignment worse than ABI!");
Dan Gohmanf17a25c2007-07-18 16:29:46 +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
113TargetAlignElem::operator==(const TargetAlignElem &rhs) const {
114 return (AlignType == rhs.AlignType
115 && ABIAlign == rhs.ABIAlign
116 && PrefAlign == rhs.PrefAlign
117 && TypeBitWidth == rhs.TypeBitWidth);
118}
119
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000120const TargetAlignElem TargetData::InvalidAlignmentElem =
121 TargetAlignElem::get((AlignTypeEnum) -1, 0, 0, 0);
122
123//===----------------------------------------------------------------------===//
124// TargetData Class Implementation
125//===----------------------------------------------------------------------===//
126
Chris Lattner044fe3e2009-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 Lattner044fe3e2009-11-07 09:13:23 +0000134void TargetData::init(StringRef Desc) {
Owen Andersond40ee772009-08-21 19:59:12 +0000135 LayoutMap = 0;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000136 LittleEndian = false;
137 PointerMemSize = 8;
Chris Lattner044fe3e2009-11-07 09:13:23 +0000138 PointerABIAlign = 8;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000139 PointerPrefAlign = PointerABIAlign;
140
141 // Default alignments
Dan Gohman02b1d022009-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
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000147 setAlignment(FLOAT_ALIGN, 4, 4, 32); // float
148 setAlignment(FLOAT_ALIGN, 8, 8, 64); // double
Dan Gohman70146382009-08-20 16:27:10 +0000149 setAlignment(VECTOR_ALIGN, 8, 8, 64); // v2i32, v1i64, ...
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000150 setAlignment(VECTOR_ALIGN, 16, 16, 128); // v16i8, v8i16, v4i32, ...
Dan Gohman70146382009-08-20 16:27:10 +0000151 setAlignment(AGGREGATE_ALIGN, 0, 8, 0); // struct
Rafael Espindolab5c5df42007-09-07 14:52:14 +0000152
Chris Lattner044fe3e2009-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 Lattnerece41802009-11-07 09:35:34 +0000167 switch (Specifier[0]) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000168 case 'E':
169 LittleEndian = false;
170 break;
171 case 'e':
172 LittleEndian = true;
173 break;
174 case 'p':
Chris Lattner044fe3e2009-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;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000181 if (PointerPrefAlign == 0)
182 PointerPrefAlign = PointerABIAlign;
183 break;
184 case 'i':
185 case 'v':
186 case 'f':
Rafael Espindolab5c5df42007-09-07 14:52:14 +0000187 case 'a':
188 case 's': {
Chris Lattner044fe3e2009-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 Espindolab5c5df42007-09-07 14:52:14 +0000197 }
Chris Lattner044fe3e2009-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);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000207 break;
208 }
Chris Lattnerece41802009-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
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000220 default:
221 break;
222 }
223 }
224}
225
Chris Lattner683309f2009-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 Lattner8316f2d2010-04-07 22:58:41 +0000231 report_fatal_error("Bad TargetData ctor used. "
Chris Lattner683309f2009-11-07 09:23:04 +0000232 "Tool did not specify a TargetData to use?");
233}
234
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000235TargetData::TargetData(const Module *M)
Dan Gohman26f8c272008-09-04 17:05:41 +0000236 : ImmutablePass(&ID) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000237 init(M->getDataLayout());
238}
239
240void
241TargetData::setAlignment(AlignTypeEnum align_type, unsigned char abi_align,
242 unsigned char pref_align, uint32_t bit_width) {
Duncan Sands935686e2008-01-29 06:23:44 +0000243 assert(abi_align <= pref_align && "Preferred alignment worse than ABI!");
Dan Gohmanf17a25c2007-07-18 16:29:46 +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));
256}
257
258/// getAlignmentInfo - Return the alignment (either ABI if ABIInfo = true or
259/// preferred if ABIInfo = false) the target wants for the specified datatype.
260unsigned TargetData::getAlignmentInfo(AlignTypeEnum AlignType,
Chris Lattner6fdfffb2008-01-10 00:30:57 +0000261 uint32_t BitWidth, bool ABIInfo,
262 const Type *Ty) const {
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000263 // Check to see if we have an exact match and remember the best match we see.
264 int BestMatchIdx = -1;
265 int LargestInt = -1;
266 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.
Duncan Sandsb3412482007-12-21 20:18:41 +0000272 if (AlignType == VECTOR_ALIGN && Alignments[i].AlignType == VECTOR_ALIGN) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000273 // If this is a specification for a smaller vector type, we will fall back
274 // to it. This happens because <128 x double> can be implemented in terms
275 // of 64 <2 x double>.
Duncan Sandsb3412482007-12-21 20:18:41 +0000276 if (Alignments[i].TypeBitWidth < BitWidth) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000277 // Verify that we pick the biggest of the fallbacks.
278 if (BestMatchIdx == -1 ||
Duncan Sandsb3412482007-12-21 20:18:41 +0000279 Alignments[BestMatchIdx].TypeBitWidth < Alignments[i].TypeBitWidth)
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000280 BestMatchIdx = i;
281 }
282 } else if (AlignType == INTEGER_ALIGN &&
283 Alignments[i].AlignType == INTEGER_ALIGN) {
284 // The "best match" for integers is the smallest size that is larger than
285 // the BitWidth requested.
286 if (Alignments[i].TypeBitWidth > BitWidth && (BestMatchIdx == -1 ||
287 Alignments[i].TypeBitWidth < Alignments[BestMatchIdx].TypeBitWidth))
288 BestMatchIdx = i;
289 // However, if there isn't one that's larger, then we must use the
290 // largest one we have (see below)
291 if (LargestInt == -1 ||
292 Alignments[i].TypeBitWidth > Alignments[LargestInt].TypeBitWidth)
293 LargestInt = i;
294 }
295 }
296
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000297 // Okay, we didn't find an exact solution. Fall back here depending on what
298 // is being looked for.
Chris Lattner6fdfffb2008-01-10 00:30:57 +0000299 if (BestMatchIdx == -1) {
300 // If we didn't find an integer alignment, fall back on most conservative.
301 if (AlignType == INTEGER_ALIGN) {
302 BestMatchIdx = LargestInt;
303 } else {
304 assert(AlignType == VECTOR_ALIGN && "Unknown alignment type!");
Dan Gohmand7138742009-02-16 23:14:14 +0000305
Chris Lattner6fdfffb2008-01-10 00:30:57 +0000306 // If we didn't find a vector size that is smaller or equal to this type,
307 // then we will end up scalarizing this to its element type. Just return
308 // the alignment of the element.
309 return getAlignment(cast<VectorType>(Ty)->getElementType(), ABIInfo);
Dan Gohmand7138742009-02-16 23:14:14 +0000310 }
Chris Lattner6fdfffb2008-01-10 00:30:57 +0000311 }
Dan Gohmand7138742009-02-16 23:14:14 +0000312
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000313 // Since we got a "best match" index, just return it.
314 return ABIInfo ? Alignments[BestMatchIdx].ABIAlign
315 : Alignments[BestMatchIdx].PrefAlign;
316}
317
Bill Wendling56eb1082009-12-03 00:17:12 +0000318namespace {
Bill Wendlingc3bd98752009-11-18 01:03:56 +0000319
320class StructLayoutMap : public AbstractTypeUser {
Bill Wendlingc4619712009-12-04 21:03:02 +0000321 typedef DenseMap<const StructType*, StructLayout*> LayoutInfoTy;
Bill Wendlingc3bd98752009-11-18 01:03:56 +0000322 LayoutInfoTy LayoutInfo;
323
Chris Lattner21338852009-12-17 20:00:21 +0000324 void RemoveEntry(LayoutInfoTy::iterator I, bool WasAbstract) {
325 I->second->~StructLayout();
326 free(I->second);
327 if (WasAbstract)
328 I->first->removeAbstractTypeUser(this);
329 LayoutInfo.erase(I);
330 }
331
332
Bill Wendlingc3bd98752009-11-18 01:03:56 +0000333 /// refineAbstractType - The callback method invoked when an abstract type is
334 /// resolved to another type. An object must override this method to update
335 /// its internal state to reference NewType instead of OldType.
336 ///
337 virtual void refineAbstractType(const DerivedType *OldTy,
338 const Type *) {
Chris Lattner21338852009-12-17 20:00:21 +0000339 LayoutInfoTy::iterator I = LayoutInfo.find(cast<const StructType>(OldTy));
340 assert(I != LayoutInfo.end() && "Using type but not in map?");
341 RemoveEntry(I, true);
Bill Wendlingc3bd98752009-11-18 01:03:56 +0000342 }
343
344 /// typeBecameConcrete - The other case which AbstractTypeUsers must be aware
345 /// of is when a type makes the transition from being abstract (where it has
346 /// clients on its AbstractTypeUsers list) to concrete (where it does not).
347 /// This method notifies ATU's when this occurs for a type.
348 ///
349 virtual void typeBecameConcrete(const DerivedType *AbsTy) {
Chris Lattner21338852009-12-17 20:00:21 +0000350 LayoutInfoTy::iterator I = LayoutInfo.find(cast<const StructType>(AbsTy));
351 assert(I != LayoutInfo.end() && "Using type but not in map?");
352 RemoveEntry(I, true);
Bill Wendlingc3bd98752009-11-18 01:03:56 +0000353 }
354
Bill Wendlingc3bd98752009-11-18 01:03:56 +0000355public:
356 virtual ~StructLayoutMap() {
357 // Remove any layouts.
358 for (LayoutInfoTy::iterator
Bill Wendling56eb1082009-12-03 00:17:12 +0000359 I = LayoutInfo.begin(), E = LayoutInfo.end(); I != E; ++I) {
360 const Type *Key = I->first;
361 StructLayout *Value = I->second;
362
Bill Wendlingc4619712009-12-04 21:03:02 +0000363 if (Key->isAbstract())
Bill Wendling56eb1082009-12-03 00:17:12 +0000364 Key->removeAbstractTypeUser(this);
365
Bill Wendlingc4619712009-12-04 21:03:02 +0000366 Value->~StructLayout();
367 free(Value);
Bill Wendling56eb1082009-12-03 00:17:12 +0000368 }
Bill Wendlingc3bd98752009-11-18 01:03:56 +0000369 }
370
Bill Wendling1ce8b252009-12-05 01:43:33 +0000371 void InvalidateEntry(const StructType *Ty) {
Bill Wendling7ea7e172009-12-05 01:46:01 +0000372 LayoutInfoTy::iterator I = LayoutInfo.find(Ty);
373 if (I == LayoutInfo.end()) return;
Chris Lattner21338852009-12-17 20:00:21 +0000374 RemoveEntry(I, Ty->isAbstract());
Bill Wendling1ce8b252009-12-05 01:43:33 +0000375 }
376
Bill Wendling56eb1082009-12-03 00:17:12 +0000377 StructLayout *&operator[](const StructType *STy) {
Bill Wendlingc3bd98752009-11-18 01:03:56 +0000378 return LayoutInfo[STy];
379 }
380
381 // for debugging...
382 virtual void dump() const {}
383};
384
Bill Wendlingc4619712009-12-04 21:03:02 +0000385} // end anonymous namespace
Owen Anderson9b43b972009-08-20 23:51:44 +0000386
387TargetData::~TargetData() {
Bill Wendling56eb1082009-12-03 00:17:12 +0000388 delete static_cast<StructLayoutMap*>(LayoutMap);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000389}
390
391const StructLayout *TargetData::getStructLayout(const StructType *Ty) const {
Owen Andersond40ee772009-08-21 19:59:12 +0000392 if (!LayoutMap)
Bill Wendlingc3bd98752009-11-18 01:03:56 +0000393 LayoutMap = new StructLayoutMap();
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000394
Bill Wendling56eb1082009-12-03 00:17:12 +0000395 StructLayoutMap *STM = static_cast<StructLayoutMap*>(LayoutMap);
396 StructLayout *&SL = (*STM)[Ty];
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000397 if (SL) return SL;
398
399 // Otherwise, create the struct layout. Because it is variable length, we
400 // malloc it, then use placement new.
401 int NumElts = Ty->getNumElements();
402 StructLayout *L =
Bill Wendlingc3bd98752009-11-18 01:03:56 +0000403 (StructLayout *)malloc(sizeof(StructLayout)+(NumElts-1) * sizeof(uint64_t));
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000404
405 // Set SL before calling StructLayout's ctor. The ctor could cause other
406 // entries to be added to TheMap, invalidating our reference.
407 SL = L;
408
409 new (L) StructLayout(Ty, *this);
Bill Wendling56eb1082009-12-03 00:17:12 +0000410
411 if (Ty->isAbstract())
412 Ty->addAbstractTypeUser(STM);
413
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000414 return L;
415}
416
417/// InvalidateStructLayoutInfo - TargetData speculatively caches StructLayout
418/// objects. If a TargetData object is alive when types are being refined and
419/// removed, this method must be called whenever a StructType is removed to
420/// avoid a dangling pointer in this cache.
421void TargetData::InvalidateStructLayoutInfo(const StructType *Ty) const {
Owen Andersond40ee772009-08-21 19:59:12 +0000422 if (!LayoutMap) return; // No cache.
Bill Wendlingff1f7f72009-12-03 01:54:07 +0000423
Chris Lattner21338852009-12-17 20:00:21 +0000424 static_cast<StructLayoutMap*>(LayoutMap)->InvalidateEntry(Ty);
Bill Wendling56eb1082009-12-03 00:17:12 +0000425}
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000426
427std::string TargetData::getStringRepresentation() const {
Chris Lattner044fe3e2009-11-07 09:13:23 +0000428 std::string Result;
429 raw_string_ostream OS(Result);
430
431 OS << (LittleEndian ? "e" : "E")
432 << "-p:" << PointerMemSize*8 << ':' << PointerABIAlign*8
433 << ':' << PointerPrefAlign*8;
Chris Lattner683309f2009-11-07 09:23:04 +0000434 for (unsigned i = 0, e = Alignments.size(); i != e; ++i) {
435 const TargetAlignElem &AI = Alignments[i];
436 OS << '-' << (char)AI.AlignType << AI.TypeBitWidth << ':'
437 << AI.ABIAlign*8 << ':' << AI.PrefAlign*8;
438 }
Chris Lattnerc97274f2009-11-08 02:32:01 +0000439
440 if (!LegalIntWidths.empty()) {
441 OS << "-n" << (unsigned)LegalIntWidths[0];
442
443 for (unsigned i = 1, e = LegalIntWidths.size(); i != e; ++i)
444 OS << ':' << (unsigned)LegalIntWidths[i];
445 }
Chris Lattner044fe3e2009-11-07 09:13:23 +0000446 return OS.str();
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000447}
448
449
Duncan Sandsf99fdc62007-11-01 20:53:16 +0000450uint64_t TargetData::getTypeSizeInBits(const Type *Ty) const {
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000451 assert(Ty->isSized() && "Cannot getTypeInfo() on a type that is unsized!");
452 switch (Ty->getTypeID()) {
453 case Type::LabelTyID:
454 case Type::PointerTyID:
Duncan Sandsf99fdc62007-11-01 20:53:16 +0000455 return getPointerSizeInBits();
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000456 case Type::ArrayTyID: {
457 const ArrayType *ATy = cast<ArrayType>(Ty);
Dan Gohman2576a8e2010-02-25 15:20:39 +0000458 return getTypeAllocSizeInBits(ATy->getElementType())*ATy->getNumElements();
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000459 }
Chris Lattner97c1e142008-12-08 07:11:56 +0000460 case Type::StructTyID:
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000461 // Get the layout annotation... which is lazily created on demand.
Chris Lattner97c1e142008-12-08 07:11:56 +0000462 return getStructLayout(cast<StructType>(Ty))->getSizeInBits();
Chris Lattner535969b2010-03-16 21:25:55 +0000463 case Type::UnionTyID: {
464 const UnionType *UnTy = cast<UnionType>(Ty);
465 uint64_t Size = 0;
466 for (UnionType::element_iterator i = UnTy->element_begin(),
467 e = UnTy->element_end(); i != e; ++i) {
468 Size = std::max(Size, getTypeSizeInBits(*i));
469 }
470 return Size;
471 }
Duncan Sandsf99fdc62007-11-01 20:53:16 +0000472 case Type::IntegerTyID:
473 return cast<IntegerType>(Ty)->getBitWidth();
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000474 case Type::VoidTyID:
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000475 return 8;
Duncan Sandsf99fdc62007-11-01 20:53:16 +0000476 case Type::FloatTyID:
477 return 32;
478 case Type::DoubleTyID:
479 return 64;
Dale Johannesen4c39f712007-08-03 20:20:50 +0000480 case Type::PPC_FP128TyID:
481 case Type::FP128TyID:
Duncan Sandsf99fdc62007-11-01 20:53:16 +0000482 return 128;
Dale Johannesen4c39f712007-08-03 20:20:50 +0000483 // In memory objects this is always aligned to a higher boundary, but
Duncan Sandsf99fdc62007-11-01 20:53:16 +0000484 // only 80 bits contain information.
Dale Johannesen4c39f712007-08-03 20:20:50 +0000485 case Type::X86_FP80TyID:
Duncan Sandsf99fdc62007-11-01 20:53:16 +0000486 return 80;
Chris Lattner97c1e142008-12-08 07:11:56 +0000487 case Type::VectorTyID:
488 return cast<VectorType>(Ty)->getBitWidth();
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000489 default:
Edwin Törökbd448e32009-07-14 16:55:14 +0000490 llvm_unreachable("TargetData::getTypeSizeInBits(): Unsupported type");
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000491 break;
492 }
493 return 0;
494}
495
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000496/*!
497 \param abi_or_pref Flag that determines which alignment is returned. true
498 returns the ABI alignment, false returns the preferred alignment.
499 \param Ty The underlying type for which alignment is determined.
500
501 Get the ABI (\a abi_or_pref == true) or preferred alignment (\a abi_or_pref
502 == false) for the requested type \a Ty.
503 */
504unsigned char TargetData::getAlignment(const Type *Ty, bool abi_or_pref) const {
505 int AlignType = -1;
506
507 assert(Ty->isSized() && "Cannot getTypeInfo() on a type that is unsized!");
508 switch (Ty->getTypeID()) {
Chris Lattner97c1e142008-12-08 07:11:56 +0000509 // Early escape for the non-numeric types.
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000510 case Type::LabelTyID:
511 case Type::PointerTyID:
512 return (abi_or_pref
513 ? getPointerABIAlignment()
514 : getPointerPrefAlignment());
515 case Type::ArrayTyID:
516 return getAlignment(cast<ArrayType>(Ty)->getElementType(), abi_or_pref);
Dan Gohmand7138742009-02-16 23:14:14 +0000517
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000518 case Type::StructTyID: {
519 // Packed structure types always have an ABI alignment of one.
520 if (cast<StructType>(Ty)->isPacked() && abi_or_pref)
521 return 1;
Dan Gohmand7138742009-02-16 23:14:14 +0000522
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000523 // Get the layout annotation... which is lazily created on demand.
524 const StructLayout *Layout = getStructLayout(cast<StructType>(Ty));
Chris Lattner6fdfffb2008-01-10 00:30:57 +0000525 unsigned Align = getAlignmentInfo(AGGREGATE_ALIGN, 0, abi_or_pref, Ty);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000526 return std::max(Align, (unsigned)Layout->getAlignment());
527 }
Chris Lattner535969b2010-03-16 21:25:55 +0000528 case Type::UnionTyID: {
529 const UnionType *UnTy = cast<UnionType>(Ty);
530 unsigned Align = 1;
531
532 // Unions need the maximum alignment of all their entries
533 for (UnionType::element_iterator i = UnTy->element_begin(),
534 e = UnTy->element_end(); i != e; ++i) {
535 Align = std::max(Align, (unsigned)getAlignment(*i, abi_or_pref));
536 }
537 return Align;
538 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000539 case Type::IntegerTyID:
540 case Type::VoidTyID:
541 AlignType = INTEGER_ALIGN;
542 break;
543 case Type::FloatTyID:
544 case Type::DoubleTyID:
Dale Johannesen4c39f712007-08-03 20:20:50 +0000545 // PPC_FP128TyID and FP128TyID have different data contents, but the
546 // same size and alignment, so they look the same here.
547 case Type::PPC_FP128TyID:
548 case Type::FP128TyID:
549 case Type::X86_FP80TyID:
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000550 AlignType = FLOAT_ALIGN;
551 break;
Chris Lattner6fdfffb2008-01-10 00:30:57 +0000552 case Type::VectorTyID:
553 AlignType = VECTOR_ALIGN;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000554 break;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000555 default:
Edwin Törökbd448e32009-07-14 16:55:14 +0000556 llvm_unreachable("Bad type for getAlignment!!!");
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000557 break;
558 }
559
Duncan Sandsf99fdc62007-11-01 20:53:16 +0000560 return getAlignmentInfo((AlignTypeEnum)AlignType, getTypeSizeInBits(Ty),
Chris Lattner6fdfffb2008-01-10 00:30:57 +0000561 abi_or_pref, Ty);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000562}
563
564unsigned char TargetData::getABITypeAlignment(const Type *Ty) const {
565 return getAlignment(Ty, true);
566}
567
Chris Lattner32a2e712010-01-25 23:18:11 +0000568/// getABIIntegerTypeAlignment - Return the minimum ABI-required alignment for
569/// an integer type of the specified bitwidth.
570unsigned char TargetData::getABIIntegerTypeAlignment(unsigned BitWidth) const {
571 return getAlignmentInfo(INTEGER_ALIGN, BitWidth, true, 0);
572}
573
574
Rafael Espindolab5c5df42007-09-07 14:52:14 +0000575unsigned char TargetData::getCallFrameTypeAlignment(const Type *Ty) const {
576 for (unsigned i = 0, e = Alignments.size(); i != e; ++i)
577 if (Alignments[i].AlignType == STACK_ALIGN)
578 return Alignments[i].ABIAlign;
579
580 return getABITypeAlignment(Ty);
581}
582
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000583unsigned char TargetData::getPrefTypeAlignment(const Type *Ty) const {
584 return getAlignment(Ty, false);
585}
586
587unsigned char TargetData::getPreferredTypeAlignmentShift(const Type *Ty) const {
588 unsigned Align = (unsigned) getPrefTypeAlignment(Ty);
589 assert(!(Align & (Align-1)) && "Alignment is not a power of two!");
590 return Log2_32(Align);
591}
592
593/// getIntPtrType - Return an unsigned integer type that is the same size or
594/// greater to the host pointer size.
Owen Anderson35b47072009-08-13 21:58:54 +0000595const IntegerType *TargetData::getIntPtrType(LLVMContext &C) const {
596 return IntegerType::get(C, getPointerSizeInBits());
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000597}
598
599
600uint64_t TargetData::getIndexedOffset(const Type *ptrTy, Value* const* Indices,
601 unsigned NumIndices) const {
602 const Type *Ty = ptrTy;
Duncan Sands10343d92010-02-16 11:11:14 +0000603 assert(Ty->isPointerTy() && "Illegal argument for getIndexedOffset()");
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000604 uint64_t Result = 0;
605
606 generic_gep_type_iterator<Value* const*>
607 TI = gep_type_begin(ptrTy, Indices, Indices+NumIndices);
608 for (unsigned CurIDX = 0; CurIDX != NumIndices; ++CurIDX, ++TI) {
609 if (const StructType *STy = dyn_cast<StructType>(*TI)) {
Owen Anderson35b47072009-08-13 21:58:54 +0000610 assert(Indices[CurIDX]->getType() ==
611 Type::getInt32Ty(ptrTy->getContext()) &&
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000612 "Illegal struct idx");
613 unsigned FieldNo = cast<ConstantInt>(Indices[CurIDX])->getZExtValue();
614
615 // Get structure layout information...
616 const StructLayout *Layout = getStructLayout(STy);
617
618 // Add in the offset, as calculated by the structure layout info...
619 Result += Layout->getElementOffset(FieldNo);
620
621 // Update Ty to refer to current element
622 Ty = STy->getElementType(FieldNo);
Chris Lattner535969b2010-03-16 21:25:55 +0000623 } else if (const UnionType *UnTy = dyn_cast<UnionType>(*TI)) {
624 unsigned FieldNo = cast<ConstantInt>(Indices[CurIDX])->getZExtValue();
625
626 // Offset into union is canonically 0, but type changes
627 Ty = UnTy->getElementType(FieldNo);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000628 } else {
629 // Update Ty to refer to current element
630 Ty = cast<SequentialType>(Ty)->getElementType();
631
632 // Get the array index and the size of each array element.
633 int64_t arrayIdx = cast<ConstantInt>(Indices[CurIDX])->getSExtValue();
Duncan Sandsec4f97d2009-05-09 07:06:46 +0000634 Result += arrayIdx * (int64_t)getTypeAllocSize(Ty);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000635 }
636 }
637
638 return Result;
639}
640
Duncan Sands935686e2008-01-29 06:23:44 +0000641/// getPreferredAlignment - Return the preferred alignment of the specified
642/// global. This includes an explicitly requested alignment (if the global
643/// has one).
644unsigned TargetData::getPreferredAlignment(const GlobalVariable *GV) const {
645 const Type *ElemType = GV->getType()->getElementType();
646 unsigned Alignment = getPrefTypeAlignment(ElemType);
647 if (GV->getAlignment() > Alignment)
648 Alignment = GV->getAlignment();
649
650 if (GV->hasInitializer()) {
651 if (Alignment < 16) {
652 // If the global is not external, see if it is large. If so, give it a
653 // larger alignment.
Dan Gohman3ed470d2010-04-02 03:04:37 +0000654 if (getTypeSizeInBits(ElemType) > 128)
Duncan Sands935686e2008-01-29 06:23:44 +0000655 Alignment = 16; // 16-byte alignment.
656 }
657 }
658 return Alignment;
659}
660
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000661/// getPreferredAlignmentLog - Return the preferred alignment of the
662/// specified global, returned in log form. This includes an explicitly
663/// requested alignment (if the global has one).
664unsigned TargetData::getPreferredAlignmentLog(const GlobalVariable *GV) const {
Duncan Sands935686e2008-01-29 06:23:44 +0000665 return Log2_32(getPreferredAlignment(GV));
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000666}