blob: fc71bc3ab1fe06de9a704bc0c8cd98d465d93bc6 [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
120std::ostream &
Reid Spencerb7d61102007-02-15 02:11:06 +0000121TargetAlignElem::dump(std::ostream &os) const {
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000122 return os << AlignType
123 << TypeBitWidth
124 << ":" << (int) (ABIAlign * 8)
125 << ":" << (int) (PrefAlign * 8);
126}
127
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000128const TargetAlignElem TargetData::InvalidAlignmentElem =
129 TargetAlignElem::get((AlignTypeEnum) -1, 0, 0, 0);
130
131//===----------------------------------------------------------------------===//
Chris Lattnere7fb3602001-08-27 16:00:15 +0000132// TargetData Class Implementation
133//===----------------------------------------------------------------------===//
134
Chris Lattnerb7aadfa2009-11-07 09:13:23 +0000135/// getInt - Get an integer ignoring errors.
136static unsigned getInt(StringRef R) {
137 unsigned Result = 0;
138 R.getAsInteger(10, Result);
139 return Result;
140}
141
Chris Lattnerb7aadfa2009-11-07 09:13:23 +0000142void TargetData::init(StringRef Desc) {
Owen Anderson90857502009-08-21 19:59:12 +0000143 LayoutMap = 0;
Owen Anderson8f60c562006-05-12 05:49:47 +0000144 LittleEndian = false;
Chris Lattner58092e32007-01-20 22:35:55 +0000145 PointerMemSize = 8;
Chris Lattnerb7aadfa2009-11-07 09:13:23 +0000146 PointerABIAlign = 8;
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000147 PointerPrefAlign = PointerABIAlign;
148
149 // Default alignments
Dan Gohman77c5b0d2009-04-01 18:10:16 +0000150 setAlignment(INTEGER_ALIGN, 1, 1, 1); // i1
151 setAlignment(INTEGER_ALIGN, 1, 1, 8); // i8
152 setAlignment(INTEGER_ALIGN, 2, 2, 16); // i16
153 setAlignment(INTEGER_ALIGN, 4, 4, 32); // i32
154 setAlignment(INTEGER_ALIGN, 4, 8, 64); // i64
Reid Spencerb7d61102007-02-15 02:11:06 +0000155 setAlignment(FLOAT_ALIGN, 4, 4, 32); // float
156 setAlignment(FLOAT_ALIGN, 8, 8, 64); // double
Dan Gohmand35626e2009-08-20 16:27:10 +0000157 setAlignment(VECTOR_ALIGN, 8, 8, 64); // v2i32, v1i64, ...
Reid Spencer1f437872007-02-15 22:07:05 +0000158 setAlignment(VECTOR_ALIGN, 16, 16, 128); // v16i8, v8i16, v4i32, ...
Dan Gohmand35626e2009-08-20 16:27:10 +0000159 setAlignment(AGGREGATE_ALIGN, 0, 8, 0); // struct
Rafael Espindola588af2f2007-09-07 14:52:14 +0000160
Chris Lattnerb7aadfa2009-11-07 09:13:23 +0000161 while (!Desc.empty()) {
162 std::pair<StringRef, StringRef> Split = Desc.split('-');
163 StringRef Token = Split.first;
164 Desc = Split.second;
165
166 if (Token.empty())
167 continue;
168
169 Split = Token.split(':');
170 StringRef Specifier = Split.first;
171 Token = Split.second;
172
173 assert(!Specifier.empty() && "Can't be empty here");
174
Chris Lattnere82bdc42009-11-07 09:35:34 +0000175 switch (Specifier[0]) {
Owen Anderson8f60c562006-05-12 05:49:47 +0000176 case 'E':
Owen Anderson571a13f2006-05-12 06:06:55 +0000177 LittleEndian = false;
178 break;
Owen Anderson8f60c562006-05-12 05:49:47 +0000179 case 'e':
Owen Anderson571a13f2006-05-12 06:06:55 +0000180 LittleEndian = true;
181 break;
Owen Anderson8f60c562006-05-12 05:49:47 +0000182 case 'p':
Chris Lattnerb7aadfa2009-11-07 09:13:23 +0000183 Split = Token.split(':');
184 PointerMemSize = getInt(Split.first) / 8;
185 Split = Split.second.split(':');
186 PointerABIAlign = getInt(Split.first) / 8;
187 Split = Split.second.split(':');
188 PointerPrefAlign = getInt(Split.first) / 8;
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000189 if (PointerPrefAlign == 0)
190 PointerPrefAlign = PointerABIAlign;
Owen Anderson571a13f2006-05-12 06:06:55 +0000191 break;
Owen Anderson8f60c562006-05-12 05:49:47 +0000192 case 'i':
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000193 case 'v':
194 case 'f':
Rafael Espindola588af2f2007-09-07 14:52:14 +0000195 case 'a':
196 case 's': {
Chris Lattnerb7aadfa2009-11-07 09:13:23 +0000197 AlignTypeEnum AlignType;
198 switch (Specifier[0]) {
199 default:
200 case 'i': AlignType = INTEGER_ALIGN; break;
201 case 'v': AlignType = VECTOR_ALIGN; break;
202 case 'f': AlignType = FLOAT_ALIGN; break;
203 case 'a': AlignType = AGGREGATE_ALIGN; break;
204 case 's': AlignType = STACK_ALIGN; break;
Rafael Espindola588af2f2007-09-07 14:52:14 +0000205 }
Chris Lattnerb7aadfa2009-11-07 09:13:23 +0000206 unsigned Size = getInt(Specifier.substr(1));
207 Split = Token.split(':');
208 unsigned char ABIAlign = getInt(Split.first) / 8;
209
210 Split = Split.second.split(':');
211 unsigned char PrefAlign = getInt(Split.first) / 8;
212 if (PrefAlign == 0)
213 PrefAlign = ABIAlign;
214 setAlignment(AlignType, ABIAlign, PrefAlign, Size);
Owen Anderson571a13f2006-05-12 06:06:55 +0000215 break;
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000216 }
Chris Lattnere82bdc42009-11-07 09:35:34 +0000217 case 'n': // Native integer types.
218 Specifier = Specifier.substr(1);
219 do {
220 if (unsigned Width = getInt(Specifier))
221 LegalIntWidths.push_back(Width);
222 Split = Token.split(':');
223 Specifier = Split.first;
224 Token = Split.second;
225 } while (!Specifier.empty() || !Token.empty());
226 break;
227
Owen Anderson8f60c562006-05-12 05:49:47 +0000228 default:
Owen Anderson571a13f2006-05-12 06:06:55 +0000229 break;
Owen Anderson8f60c562006-05-12 05:49:47 +0000230 }
231 }
232}
233
Chris Lattner2e074942009-11-07 09:23:04 +0000234/// Default ctor.
235///
236/// @note This has to exist, because this is a pass, but it should never be
237/// used.
238TargetData::TargetData() : ImmutablePass(&ID) {
239 llvm_report_error("Bad TargetData ctor used. "
240 "Tool did not specify a TargetData to use?");
241}
242
Devang Patel794fd752007-05-01 21:15:47 +0000243TargetData::TargetData(const Module *M)
Dan Gohmanae73dc12008-09-04 17:05:41 +0000244 : ImmutablePass(&ID) {
Reid Spencer26f23852007-01-26 08:11:39 +0000245 init(M->getDataLayout());
Chris Lattner53a0c382003-04-24 19:09:05 +0000246}
247
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000248void
249TargetData::setAlignment(AlignTypeEnum align_type, unsigned char abi_align,
Reid Spencerf734ea22007-02-19 22:35:00 +0000250 unsigned char pref_align, uint32_t bit_width) {
Duncan Sandsd1025932008-01-29 06:23:44 +0000251 assert(abi_align <= pref_align && "Preferred alignment worse than ABI!");
Chris Lattneraffeb562007-02-17 00:41:42 +0000252 for (unsigned i = 0, e = Alignments.size(); i != e; ++i) {
253 if (Alignments[i].AlignType == align_type &&
254 Alignments[i].TypeBitWidth == bit_width) {
255 // Update the abi, preferred alignments.
256 Alignments[i].ABIAlign = abi_align;
257 Alignments[i].PrefAlign = pref_align;
258 return;
259 }
260 }
261
262 Alignments.push_back(TargetAlignElem::get(align_type, abi_align,
263 pref_align, bit_width));
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000264}
265
Chris Lattneraffeb562007-02-17 00:41:42 +0000266/// getAlignmentInfo - Return the alignment (either ABI if ABIInfo = true or
267/// preferred if ABIInfo = false) the target wants for the specified datatype.
Reid Spencerf734ea22007-02-19 22:35:00 +0000268unsigned TargetData::getAlignmentInfo(AlignTypeEnum AlignType,
Chris Lattner9c4428b2008-01-10 00:30:57 +0000269 uint32_t BitWidth, bool ABIInfo,
270 const Type *Ty) const {
Chris Lattneraffeb562007-02-17 00:41:42 +0000271 // Check to see if we have an exact match and remember the best match we see.
272 int BestMatchIdx = -1;
Reid Spencerf734ea22007-02-19 22:35:00 +0000273 int LargestInt = -1;
Chris Lattneraffeb562007-02-17 00:41:42 +0000274 for (unsigned i = 0, e = Alignments.size(); i != e; ++i) {
275 if (Alignments[i].AlignType == AlignType &&
276 Alignments[i].TypeBitWidth == BitWidth)
277 return ABIInfo ? Alignments[i].ABIAlign : Alignments[i].PrefAlign;
278
279 // The best match so far depends on what we're looking for.
Duncan Sands58197992007-12-21 20:18:41 +0000280 if (AlignType == VECTOR_ALIGN && Alignments[i].AlignType == VECTOR_ALIGN) {
Chris Lattneraffeb562007-02-17 00:41:42 +0000281 // If this is a specification for a smaller vector type, we will fall back
282 // to it. This happens because <128 x double> can be implemented in terms
283 // of 64 <2 x double>.
Duncan Sands58197992007-12-21 20:18:41 +0000284 if (Alignments[i].TypeBitWidth < BitWidth) {
Chris Lattneraffeb562007-02-17 00:41:42 +0000285 // Verify that we pick the biggest of the fallbacks.
286 if (BestMatchIdx == -1 ||
Duncan Sands58197992007-12-21 20:18:41 +0000287 Alignments[BestMatchIdx].TypeBitWidth < Alignments[i].TypeBitWidth)
Chris Lattneraffeb562007-02-17 00:41:42 +0000288 BestMatchIdx = i;
289 }
Reid Spencerf734ea22007-02-19 22:35:00 +0000290 } else if (AlignType == INTEGER_ALIGN &&
291 Alignments[i].AlignType == INTEGER_ALIGN) {
292 // The "best match" for integers is the smallest size that is larger than
293 // the BitWidth requested.
294 if (Alignments[i].TypeBitWidth > BitWidth && (BestMatchIdx == -1 ||
295 Alignments[i].TypeBitWidth < Alignments[BestMatchIdx].TypeBitWidth))
296 BestMatchIdx = i;
297 // However, if there isn't one that's larger, then we must use the
298 // largest one we have (see below)
299 if (LargestInt == -1 ||
300 Alignments[i].TypeBitWidth > Alignments[LargestInt].TypeBitWidth)
301 LargestInt = i;
Chris Lattneraffeb562007-02-17 00:41:42 +0000302 }
Chris Lattneraffeb562007-02-17 00:41:42 +0000303 }
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000304
Chris Lattneraffeb562007-02-17 00:41:42 +0000305 // Okay, we didn't find an exact solution. Fall back here depending on what
306 // is being looked for.
Chris Lattner9c4428b2008-01-10 00:30:57 +0000307 if (BestMatchIdx == -1) {
308 // If we didn't find an integer alignment, fall back on most conservative.
309 if (AlignType == INTEGER_ALIGN) {
310 BestMatchIdx = LargestInt;
311 } else {
312 assert(AlignType == VECTOR_ALIGN && "Unknown alignment type!");
Dan Gohman9fbb52d2009-02-16 23:14:14 +0000313
Chris Lattner9c4428b2008-01-10 00:30:57 +0000314 // If we didn't find a vector size that is smaller or equal to this type,
315 // then we will end up scalarizing this to its element type. Just return
316 // the alignment of the element.
317 return getAlignment(cast<VectorType>(Ty)->getElementType(), ABIInfo);
Dan Gohman9fbb52d2009-02-16 23:14:14 +0000318 }
Chris Lattner9c4428b2008-01-10 00:30:57 +0000319 }
Dan Gohman9fbb52d2009-02-16 23:14:14 +0000320
Reid Spencerf734ea22007-02-19 22:35:00 +0000321 // Since we got a "best match" index, just return it.
Chris Lattneraffeb562007-02-17 00:41:42 +0000322 return ABIInfo ? Alignments[BestMatchIdx].ABIAlign
323 : Alignments[BestMatchIdx].PrefAlign;
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000324}
325
Bill Wendling5eea3422009-11-18 01:03:56 +0000326typedef DenseMap<const StructType*, StructLayout*> LayoutInfoTy;
327
328namespace llvm {
329
330class StructLayoutMap : public AbstractTypeUser {
331 LayoutInfoTy LayoutInfo;
332
333 /// 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 *) {
339 const StructType *STy = dyn_cast<const StructType>(OldTy);
340 if (!STy) {
341 OldTy->removeAbstractTypeUser(this);
342 return;
343 }
344
345 StructLayout *SL = LayoutInfo[STy];
346 if (SL) {
347 SL->~StructLayout();
348 free(SL);
349 LayoutInfo[STy] = NULL;
350 }
351
352 OldTy->removeAbstractTypeUser(this);
353 }
354
355 /// typeBecameConcrete - The other case which AbstractTypeUsers must be aware
356 /// of is when a type makes the transition from being abstract (where it has
357 /// clients on its AbstractTypeUsers list) to concrete (where it does not).
358 /// This method notifies ATU's when this occurs for a type.
359 ///
360 virtual void typeBecameConcrete(const DerivedType *AbsTy) {
361 const StructType *STy = dyn_cast<const StructType>(AbsTy);
362 if (!STy) {
363 AbsTy->removeAbstractTypeUser(this);
364 return;
365 }
366
367 StructLayout *SL = LayoutInfo[STy];
368 if (SL) {
369 SL->~StructLayout();
370 free(SL);
371 LayoutInfo[STy] = NULL;
372 }
373
374 AbsTy->removeAbstractTypeUser(this);
375 }
376
377 bool insert(const Type *Ty) {
378 if (Ty->isAbstract())
379 Ty->addAbstractTypeUser(this);
380 return true;
381 }
382
383public:
384 virtual ~StructLayoutMap() {
385 // Remove any layouts.
386 for (LayoutInfoTy::iterator
387 I = LayoutInfo.begin(), E = LayoutInfo.end(); I != E; ++I)
388 if (StructLayout *SL = I->second) {
389 SL->~StructLayout();
390 free(SL);
391 }
392 }
393
394 inline LayoutInfoTy::iterator begin() {
395 return LayoutInfo.begin();
396 }
397 inline LayoutInfoTy::iterator end() {
398 return LayoutInfo.end();
399 }
400 inline LayoutInfoTy::const_iterator begin() const {
401 return LayoutInfo.begin();
402 }
403 inline LayoutInfoTy::const_iterator end() const {
404 return LayoutInfo.end();
405 }
406
407 LayoutInfoTy::iterator find(const StructType *&Val) {
408 return LayoutInfo.find(Val);
409 }
410 LayoutInfoTy::const_iterator find(const StructType *&Val) const {
411 return LayoutInfo.find(Val);
412 }
413
414 bool erase(const StructType *&Val) {
415 return LayoutInfo.erase(Val);
416 }
417 bool erase(LayoutInfoTy::iterator I) {
418 return LayoutInfo.erase(I);
419 }
420
421 StructLayout *&operator[](const Type *Key) {
422 const StructType *STy = dyn_cast<const StructType>(Key);
423 assert(STy && "Trying to access the struct layout map with a non-struct!");
424 insert(STy);
425 return LayoutInfo[STy];
426 }
427
428 // for debugging...
429 virtual void dump() const {}
430};
431
432} // end namespace llvm
Owen Anderson2ea20152009-08-20 23:51:44 +0000433
434TargetData::~TargetData() {
Bill Wendling5eea3422009-11-18 01:03:56 +0000435 delete LayoutMap;
Chris Lattner0e7ac162004-02-26 08:02:17 +0000436}
437
Chris Lattner9182e3f2007-02-10 20:15:41 +0000438const StructLayout *TargetData::getStructLayout(const StructType *Ty) const {
Owen Anderson90857502009-08-21 19:59:12 +0000439 if (!LayoutMap)
Bill Wendling5eea3422009-11-18 01:03:56 +0000440 LayoutMap = new StructLayoutMap();
Chris Lattner9182e3f2007-02-10 20:15:41 +0000441
Bill Wendling5eea3422009-11-18 01:03:56 +0000442 StructLayout *&SL = (*LayoutMap)[Ty];
Chris Lattnerf6ca09a2007-02-10 20:26:17 +0000443 if (SL) return SL;
Chris Lattner9182e3f2007-02-10 20:15:41 +0000444
445 // Otherwise, create the struct layout. Because it is variable length, we
446 // malloc it, then use placement new.
Jeff Cohen44f5fb42007-04-09 19:26:30 +0000447 int NumElts = Ty->getNumElements();
Chris Lattner9182e3f2007-02-10 20:15:41 +0000448 StructLayout *L =
Bill Wendling5eea3422009-11-18 01:03:56 +0000449 (StructLayout *)malloc(sizeof(StructLayout)+(NumElts-1) * sizeof(uint64_t));
Chris Lattnerf6ca09a2007-02-10 20:26:17 +0000450
451 // Set SL before calling StructLayout's ctor. The ctor could cause other
452 // entries to be added to TheMap, invalidating our reference.
453 SL = L;
454
Chris Lattner9182e3f2007-02-10 20:15:41 +0000455 new (L) StructLayout(Ty, *this);
Chris Lattner9182e3f2007-02-10 20:15:41 +0000456 return L;
457}
458
459/// InvalidateStructLayoutInfo - TargetData speculatively caches StructLayout
460/// objects. If a TargetData object is alive when types are being refined and
461/// removed, this method must be called whenever a StructType is removed to
462/// avoid a dangling pointer in this cache.
463void TargetData::InvalidateStructLayoutInfo(const StructType *Ty) const {
Owen Anderson90857502009-08-21 19:59:12 +0000464 if (!LayoutMap) return; // No cache.
Owen Anderson2ea20152009-08-20 23:51:44 +0000465
Bill Wendling5eea3422009-11-18 01:03:56 +0000466 DenseMap<const StructType*, StructLayout*>::iterator I = LayoutMap->find(Ty);
467 if (I == LayoutMap->end()) return;
Chris Lattnerbedb8c12008-12-08 07:11:56 +0000468
469 I->second->~StructLayout();
470 free(I->second);
Bill Wendling5eea3422009-11-18 01:03:56 +0000471 LayoutMap->erase(I);
Chris Lattner9182e3f2007-02-10 20:15:41 +0000472}
473
474
Owen Anderson2577c222006-05-12 07:01:44 +0000475std::string TargetData::getStringRepresentation() const {
Chris Lattnerb7aadfa2009-11-07 09:13:23 +0000476 std::string Result;
477 raw_string_ostream OS(Result);
478
479 OS << (LittleEndian ? "e" : "E")
480 << "-p:" << PointerMemSize*8 << ':' << PointerABIAlign*8
481 << ':' << PointerPrefAlign*8;
Chris Lattner2e074942009-11-07 09:23:04 +0000482 for (unsigned i = 0, e = Alignments.size(); i != e; ++i) {
483 const TargetAlignElem &AI = Alignments[i];
484 OS << '-' << (char)AI.AlignType << AI.TypeBitWidth << ':'
485 << AI.ABIAlign*8 << ':' << AI.PrefAlign*8;
486 }
Chris Lattner7e897382009-11-08 02:32:01 +0000487
488 if (!LegalIntWidths.empty()) {
489 OS << "-n" << (unsigned)LegalIntWidths[0];
490
491 for (unsigned i = 1, e = LegalIntWidths.size(); i != e; ++i)
492 OS << ':' << (unsigned)LegalIntWidths[i];
493 }
Chris Lattnerb7aadfa2009-11-07 09:13:23 +0000494 return OS.str();
Owen Anderson2577c222006-05-12 07:01:44 +0000495}
496
Chris Lattner8dff24f2006-01-14 00:07:34 +0000497
Duncan Sands514ab342007-11-01 20:53:16 +0000498uint64_t TargetData::getTypeSizeInBits(const Type *Ty) const {
Chris Lattnerf59ce922001-12-13 00:46:11 +0000499 assert(Ty->isSized() && "Cannot getTypeInfo() on a type that is unsized!");
Chris Lattnerf70c22b2004-06-17 18:19:28 +0000500 switch (Ty->getTypeID()) {
Chris Lattnere7fb3602001-08-27 16:00:15 +0000501 case Type::LabelTyID:
502 case Type::PointerTyID:
Duncan Sands514ab342007-11-01 20:53:16 +0000503 return getPointerSizeInBits();
Chris Lattnere7fb3602001-08-27 16:00:15 +0000504 case Type::ArrayTyID: {
Chris Lattner59b00672004-07-01 17:32:59 +0000505 const ArrayType *ATy = cast<ArrayType>(Ty);
Duncan Sands777d2302009-05-09 07:06:46 +0000506 return getTypeAllocSizeInBits(ATy->getElementType())*ATy->getNumElements();
Chris Lattner527efc62004-12-01 17:14:28 +0000507 }
Chris Lattnerbedb8c12008-12-08 07:11:56 +0000508 case Type::StructTyID:
Chris Lattnere7fb3602001-08-27 16:00:15 +0000509 // Get the layout annotation... which is lazily created on demand.
Chris Lattnerbedb8c12008-12-08 07:11:56 +0000510 return getStructLayout(cast<StructType>(Ty))->getSizeInBits();
Duncan Sands514ab342007-11-01 20:53:16 +0000511 case Type::IntegerTyID:
512 return cast<IntegerType>(Ty)->getBitWidth();
Chris Lattner58092e32007-01-20 22:35:55 +0000513 case Type::VoidTyID:
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000514 return 8;
Duncan Sands514ab342007-11-01 20:53:16 +0000515 case Type::FloatTyID:
516 return 32;
517 case Type::DoubleTyID:
518 return 64;
Dale Johannesen8c1e6a12007-08-03 20:20:50 +0000519 case Type::PPC_FP128TyID:
520 case Type::FP128TyID:
Duncan Sands514ab342007-11-01 20:53:16 +0000521 return 128;
Dale Johannesen8c1e6a12007-08-03 20:20:50 +0000522 // In memory objects this is always aligned to a higher boundary, but
Duncan Sands514ab342007-11-01 20:53:16 +0000523 // only 80 bits contain information.
Dale Johannesen8c1e6a12007-08-03 20:20:50 +0000524 case Type::X86_FP80TyID:
Duncan Sands514ab342007-11-01 20:53:16 +0000525 return 80;
Chris Lattnerbedb8c12008-12-08 07:11:56 +0000526 case Type::VectorTyID:
527 return cast<VectorType>(Ty)->getBitWidth();
Chris Lattner58092e32007-01-20 22:35:55 +0000528 default:
Torok Edwinc23197a2009-07-14 16:55:14 +0000529 llvm_unreachable("TargetData::getTypeSizeInBits(): Unsupported type");
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000530 break;
Chris Lattner58092e32007-01-20 22:35:55 +0000531 }
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000532 return 0;
Chris Lattnere7fb3602001-08-27 16:00:15 +0000533}
534
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000535/*!
536 \param abi_or_pref Flag that determines which alignment is returned. true
537 returns the ABI alignment, false returns the preferred alignment.
538 \param Ty The underlying type for which alignment is determined.
539
540 Get the ABI (\a abi_or_pref == true) or preferred alignment (\a abi_or_pref
541 == false) for the requested type \a Ty.
542 */
Chris Lattnerae6f1fa2007-02-16 22:25:34 +0000543unsigned char TargetData::getAlignment(const Type *Ty, bool abi_or_pref) const {
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000544 int AlignType = -1;
545
546 assert(Ty->isSized() && "Cannot getTypeInfo() on a type that is unsized!");
547 switch (Ty->getTypeID()) {
Chris Lattnerbedb8c12008-12-08 07:11:56 +0000548 // Early escape for the non-numeric types.
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000549 case Type::LabelTyID:
550 case Type::PointerTyID:
551 return (abi_or_pref
552 ? getPointerABIAlignment()
553 : getPointerPrefAlignment());
Chris Lattnerae6f1fa2007-02-16 22:25:34 +0000554 case Type::ArrayTyID:
555 return getAlignment(cast<ArrayType>(Ty)->getElementType(), abi_or_pref);
Dan Gohman9fbb52d2009-02-16 23:14:14 +0000556
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000557 case Type::StructTyID: {
Chris Lattnerae6f1fa2007-02-16 22:25:34 +0000558 // Packed structure types always have an ABI alignment of one.
Chris Lattner3ebb2e02007-02-16 23:11:51 +0000559 if (cast<StructType>(Ty)->isPacked() && abi_or_pref)
Chris Lattnerae6f1fa2007-02-16 22:25:34 +0000560 return 1;
Dan Gohman9fbb52d2009-02-16 23:14:14 +0000561
Chris Lattnerae6f1fa2007-02-16 22:25:34 +0000562 // Get the layout annotation... which is lazily created on demand.
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000563 const StructLayout *Layout = getStructLayout(cast<StructType>(Ty));
Chris Lattner9c4428b2008-01-10 00:30:57 +0000564 unsigned Align = getAlignmentInfo(AGGREGATE_ALIGN, 0, abi_or_pref, Ty);
Chris Lattneraffeb562007-02-17 00:41:42 +0000565 return std::max(Align, (unsigned)Layout->getAlignment());
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000566 }
567 case Type::IntegerTyID:
568 case Type::VoidTyID:
569 AlignType = INTEGER_ALIGN;
570 break;
571 case Type::FloatTyID:
572 case Type::DoubleTyID:
Dale Johannesen8c1e6a12007-08-03 20:20:50 +0000573 // PPC_FP128TyID and FP128TyID have different data contents, but the
574 // same size and alignment, so they look the same here.
575 case Type::PPC_FP128TyID:
576 case Type::FP128TyID:
577 case Type::X86_FP80TyID:
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000578 AlignType = FLOAT_ALIGN;
579 break;
Chris Lattner9c4428b2008-01-10 00:30:57 +0000580 case Type::VectorTyID:
581 AlignType = VECTOR_ALIGN;
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000582 break;
583 default:
Torok Edwinc23197a2009-07-14 16:55:14 +0000584 llvm_unreachable("Bad type for getAlignment!!!");
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000585 break;
586 }
587
Duncan Sands514ab342007-11-01 20:53:16 +0000588 return getAlignmentInfo((AlignTypeEnum)AlignType, getTypeSizeInBits(Ty),
Chris Lattner9c4428b2008-01-10 00:30:57 +0000589 abi_or_pref, Ty);
Chris Lattner58092e32007-01-20 22:35:55 +0000590}
591
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000592unsigned char TargetData::getABITypeAlignment(const Type *Ty) const {
593 return getAlignment(Ty, true);
594}
595
Rafael Espindola588af2f2007-09-07 14:52:14 +0000596unsigned char TargetData::getCallFrameTypeAlignment(const Type *Ty) const {
597 for (unsigned i = 0, e = Alignments.size(); i != e; ++i)
598 if (Alignments[i].AlignType == STACK_ALIGN)
599 return Alignments[i].ABIAlign;
600
601 return getABITypeAlignment(Ty);
602}
603
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000604unsigned char TargetData::getPrefTypeAlignment(const Type *Ty) const {
605 return getAlignment(Ty, false);
Chris Lattnere7fb3602001-08-27 16:00:15 +0000606}
607
Evan Chengde268f72007-01-24 07:03:39 +0000608unsigned char TargetData::getPreferredTypeAlignmentShift(const Type *Ty) const {
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000609 unsigned Align = (unsigned) getPrefTypeAlignment(Ty);
Chris Lattnerd2b0bb42004-08-17 19:13:00 +0000610 assert(!(Align & (Align-1)) && "Alignment is not a power of two!");
Chris Lattner0561b3f2005-08-02 19:26:06 +0000611 return Log2_32(Align);
Chris Lattnerd2b0bb42004-08-17 19:13:00 +0000612}
613
Chris Lattnerf0453282003-12-22 05:01:15 +0000614/// getIntPtrType - Return an unsigned integer type that is the same size or
615/// greater to the host pointer size.
Owen Anderson1d0be152009-08-13 21:58:54 +0000616const IntegerType *TargetData::getIntPtrType(LLVMContext &C) const {
617 return IntegerType::get(C, getPointerSizeInBits());
Chris Lattnerf0453282003-12-22 05:01:15 +0000618}
619
620
Chris Lattnerddce8d22007-02-10 19:33:15 +0000621uint64_t TargetData::getIndexedOffset(const Type *ptrTy, Value* const* Indices,
622 unsigned NumIndices) const {
Vikram S. Adveed0030e2002-08-04 20:52:39 +0000623 const Type *Ty = ptrTy;
624 assert(isa<PointerType>(Ty) && "Illegal argument for getIndexedOffset()");
Vikram S. Advef66723f2002-05-19 15:28:02 +0000625 uint64_t Result = 0;
Chris Lattnere7fb3602001-08-27 16:00:15 +0000626
Chris Lattnerddce8d22007-02-10 19:33:15 +0000627 generic_gep_type_iterator<Value* const*>
628 TI = gep_type_begin(ptrTy, Indices, Indices+NumIndices);
629 for (unsigned CurIDX = 0; CurIDX != NumIndices; ++CurIDX, ++TI) {
Chris Lattner28977af2004-04-05 01:30:19 +0000630 if (const StructType *STy = dyn_cast<StructType>(*TI)) {
Owen Anderson1d0be152009-08-13 21:58:54 +0000631 assert(Indices[CurIDX]->getType() ==
632 Type::getInt32Ty(ptrTy->getContext()) &&
Reid Spencer1ede29c2007-03-01 19:48:16 +0000633 "Illegal struct idx");
Chris Lattnerddce8d22007-02-10 19:33:15 +0000634 unsigned FieldNo = cast<ConstantInt>(Indices[CurIDX])->getZExtValue();
Chris Lattnere7fb3602001-08-27 16:00:15 +0000635
636 // Get structure layout information...
637 const StructLayout *Layout = getStructLayout(STy);
638
639 // Add in the offset, as calculated by the structure layout info...
Chris Lattnerb1919e22007-02-10 19:55:17 +0000640 Result += Layout->getElementOffset(FieldNo);
Vikram S. Adveed0030e2002-08-04 20:52:39 +0000641
Chris Lattnere7fb3602001-08-27 16:00:15 +0000642 // Update Ty to refer to current element
Chris Lattnerd21cd802004-02-09 04:37:31 +0000643 Ty = STy->getElementType(FieldNo);
Chris Lattner28977af2004-04-05 01:30:19 +0000644 } else {
645 // Update Ty to refer to current element
646 Ty = cast<SequentialType>(Ty)->getElementType();
647
648 // Get the array index and the size of each array element.
Chris Lattnerddce8d22007-02-10 19:33:15 +0000649 int64_t arrayIdx = cast<ConstantInt>(Indices[CurIDX])->getSExtValue();
Duncan Sands777d2302009-05-09 07:06:46 +0000650 Result += arrayIdx * (int64_t)getTypeAllocSize(Ty);
Chris Lattnere7fb3602001-08-27 16:00:15 +0000651 }
652 }
653
654 return Result;
655}
Brian Gaeked0fde302003-11-11 22:41:34 +0000656
Duncan Sandsd1025932008-01-29 06:23:44 +0000657/// getPreferredAlignment - Return the preferred alignment of the specified
658/// global. This includes an explicitly requested alignment (if the global
659/// has one).
660unsigned TargetData::getPreferredAlignment(const GlobalVariable *GV) const {
661 const Type *ElemType = GV->getType()->getElementType();
662 unsigned Alignment = getPrefTypeAlignment(ElemType);
663 if (GV->getAlignment() > Alignment)
664 Alignment = GV->getAlignment();
665
666 if (GV->hasInitializer()) {
667 if (Alignment < 16) {
668 // If the global is not external, see if it is large. If so, give it a
669 // larger alignment.
670 if (getTypeSizeInBits(ElemType) > 128)
671 Alignment = 16; // 16-byte alignment.
672 }
673 }
674 return Alignment;
675}
676
Devang Patelf9c197e2006-10-24 20:32:14 +0000677/// getPreferredAlignmentLog - Return the preferred alignment of the
678/// specified global, returned in log form. This includes an explicitly
679/// requested alignment (if the global has one).
680unsigned TargetData::getPreferredAlignmentLog(const GlobalVariable *GV) const {
Duncan Sandsd1025932008-01-29 06:23:44 +0000681 return Log2_32(getPreferredAlignment(GV));
Devang Patelf9c197e2006-10-24 20:32:14 +0000682}