blob: 65f514c26474e8e021f122b7465dab6f9d5ba9da [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...
Owen Andersond13db2c2010-07-21 22:09:45 +000037INITIALIZE_PASS(TargetData, "targetdata", "Target Data Layout", false, true);
Devang Patel19974732007-05-03 01:11:54 +000038char TargetData::ID = 0;
Chris Lattneraa31ad02002-09-25 23:46:55 +000039
Chris Lattnere7fb3602001-08-27 16:00:15 +000040//===----------------------------------------------------------------------===//
Chris Lattner0e7ac162004-02-26 08:02:17 +000041// Support for StructLayout
Chris Lattnere7fb3602001-08-27 16:00:15 +000042//===----------------------------------------------------------------------===//
43
Chris Lattner0e7ac162004-02-26 08:02:17 +000044StructLayout::StructLayout(const StructType *ST, const TargetData &TD) {
Chris Lattnere7fb3602001-08-27 16:00:15 +000045 StructAlignment = 0;
46 StructSize = 0;
Chris Lattner9182e3f2007-02-10 20:15:41 +000047 NumElements = ST->getNumElements();
Chris Lattnere7fb3602001-08-27 16:00:15 +000048
Chris Lattnerbedb8c12008-12-08 07:11:56 +000049 // Loop over each of the elements, placing them in memory.
Chris Lattner9182e3f2007-02-10 20:15:41 +000050 for (unsigned i = 0, e = NumElements; i != e; ++i) {
51 const Type *Ty = ST->getElementType(i);
Duncan Sandsa0fcc082008-06-04 08:21:45 +000052 unsigned TyAlign = ST->isPacked() ? 1 : TD.getABITypeAlignment(Ty);
Chris Lattnere7fb3602001-08-27 16:00:15 +000053
Chris Lattnerbedb8c12008-12-08 07:11:56 +000054 // Add padding if necessary to align the data element properly.
Duncan Sands677a7ec2008-12-09 09:58:11 +000055 if ((StructSize & (TyAlign-1)) != 0)
Chris Lattnerbedb8c12008-12-08 07:11:56 +000056 StructSize = TargetData::RoundUpAlignment(StructSize, TyAlign);
Chris Lattnere7fb3602001-08-27 16:00:15 +000057
Chris Lattnerbedb8c12008-12-08 07:11:56 +000058 // Keep track of maximum alignment constraint.
Chris Lattner697954c2002-01-20 22:54:45 +000059 StructAlignment = std::max(TyAlign, StructAlignment);
Chris Lattnere7fb3602001-08-27 16:00:15 +000060
Chris Lattner9182e3f2007-02-10 20:15:41 +000061 MemberOffsets[i] = StructSize;
Duncan Sands777d2302009-05-09 07:06:46 +000062 StructSize += TD.getTypeAllocSize(Ty); // Consume space for this data item
Chris Lattnere7fb3602001-08-27 16:00:15 +000063 }
64
Chris Lattner4e840d42003-05-21 18:08:44 +000065 // Empty structures have alignment of 1 byte.
66 if (StructAlignment == 0) StructAlignment = 1;
67
Chris Lattnere7fb3602001-08-27 16:00:15 +000068 // Add padding to the end of the struct so that it could be put in an array
69 // and all array elements would be aligned correctly.
Chris Lattner59779c52008-12-08 07:21:39 +000070 if ((StructSize & (StructAlignment-1)) != 0)
Chris Lattnerbedb8c12008-12-08 07:11:56 +000071 StructSize = TargetData::RoundUpAlignment(StructSize, StructAlignment);
Chris Lattnere7fb3602001-08-27 16:00:15 +000072}
73
Chris Lattnere7ea48c2005-03-13 19:04:41 +000074
75/// getElementContainingOffset - Given a valid offset into the structure,
76/// return the structure index that contains it.
77unsigned StructLayout::getElementContainingOffset(uint64_t Offset) const {
Chris Lattner9182e3f2007-02-10 20:15:41 +000078 const uint64_t *SI =
79 std::upper_bound(&MemberOffsets[0], &MemberOffsets[NumElements], Offset);
80 assert(SI != &MemberOffsets[0] && "Offset not in structure type!");
Chris Lattnere7ea48c2005-03-13 19:04:41 +000081 --SI;
82 assert(*SI <= Offset && "upper_bound didn't work");
Chris Lattnerb361ec32007-10-29 02:40:02 +000083 assert((SI == &MemberOffsets[0] || *(SI-1) <= Offset) &&
Chris Lattner9182e3f2007-02-10 20:15:41 +000084 (SI+1 == &MemberOffsets[NumElements] || *(SI+1) > Offset) &&
Chris Lattnere7ea48c2005-03-13 19:04:41 +000085 "Upper bound didn't work!");
Chris Lattnerb361ec32007-10-29 02:40:02 +000086
87 // Multiple fields can have the same offset if any of them are zero sized.
88 // For example, in { i32, [0 x i32], i32 }, searching for offset 4 will stop
89 // at the i32 element, because it is the last element at that offset. This is
90 // the right one to return, because anything after it will have a higher
91 // offset, implying that this element is non-empty.
Chris Lattner9182e3f2007-02-10 20:15:41 +000092 return SI-&MemberOffsets[0];
Chris Lattnere7ea48c2005-03-13 19:04:41 +000093}
94
Chris Lattnere7fb3602001-08-27 16:00:15 +000095//===----------------------------------------------------------------------===//
Chris Lattnerd2b7cec2007-02-14 05:52:17 +000096// TargetAlignElem, TargetAlign support
97//===----------------------------------------------------------------------===//
98
99TargetAlignElem
100TargetAlignElem::get(AlignTypeEnum align_type, unsigned char abi_align,
Reid Spencerf734ea22007-02-19 22:35:00 +0000101 unsigned char pref_align, uint32_t bit_width) {
Duncan Sandsd1025932008-01-29 06:23:44 +0000102 assert(abi_align <= pref_align && "Preferred alignment worse than ABI!");
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000103 TargetAlignElem retval;
104 retval.AlignType = align_type;
105 retval.ABIAlign = abi_align;
106 retval.PrefAlign = pref_align;
107 retval.TypeBitWidth = bit_width;
108 return retval;
109}
110
111bool
Reid Spencerb7d61102007-02-15 02:11:06 +0000112TargetAlignElem::operator==(const TargetAlignElem &rhs) const {
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000113 return (AlignType == rhs.AlignType
114 && ABIAlign == rhs.ABIAlign
115 && PrefAlign == rhs.PrefAlign
116 && TypeBitWidth == rhs.TypeBitWidth);
117}
118
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000119const TargetAlignElem TargetData::InvalidAlignmentElem =
120 TargetAlignElem::get((AlignTypeEnum) -1, 0, 0, 0);
121
122//===----------------------------------------------------------------------===//
Chris Lattnere7fb3602001-08-27 16:00:15 +0000123// TargetData Class Implementation
124//===----------------------------------------------------------------------===//
125
Chris Lattnerb7aadfa2009-11-07 09:13:23 +0000126/// getInt - Get an integer ignoring errors.
127static unsigned getInt(StringRef R) {
128 unsigned Result = 0;
129 R.getAsInteger(10, Result);
130 return Result;
131}
132
Chris Lattnerb7aadfa2009-11-07 09:13:23 +0000133void TargetData::init(StringRef Desc) {
Owen Anderson90857502009-08-21 19:59:12 +0000134 LayoutMap = 0;
Owen Anderson8f60c562006-05-12 05:49:47 +0000135 LittleEndian = false;
Chris Lattner58092e32007-01-20 22:35:55 +0000136 PointerMemSize = 8;
Chris Lattnerb7aadfa2009-11-07 09:13:23 +0000137 PointerABIAlign = 8;
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000138 PointerPrefAlign = PointerABIAlign;
139
140 // Default alignments
Dan Gohman77c5b0d2009-04-01 18:10:16 +0000141 setAlignment(INTEGER_ALIGN, 1, 1, 1); // i1
142 setAlignment(INTEGER_ALIGN, 1, 1, 8); // i8
143 setAlignment(INTEGER_ALIGN, 2, 2, 16); // i16
144 setAlignment(INTEGER_ALIGN, 4, 4, 32); // i32
145 setAlignment(INTEGER_ALIGN, 4, 8, 64); // i64
Reid Spencerb7d61102007-02-15 02:11:06 +0000146 setAlignment(FLOAT_ALIGN, 4, 4, 32); // float
147 setAlignment(FLOAT_ALIGN, 8, 8, 64); // double
Dan Gohmand35626e2009-08-20 16:27:10 +0000148 setAlignment(VECTOR_ALIGN, 8, 8, 64); // v2i32, v1i64, ...
Reid Spencer1f437872007-02-15 22:07:05 +0000149 setAlignment(VECTOR_ALIGN, 16, 16, 128); // v16i8, v8i16, v4i32, ...
Dan Gohmand35626e2009-08-20 16:27:10 +0000150 setAlignment(AGGREGATE_ALIGN, 0, 8, 0); // struct
Rafael Espindola588af2f2007-09-07 14:52:14 +0000151
Chris Lattnerb7aadfa2009-11-07 09:13:23 +0000152 while (!Desc.empty()) {
153 std::pair<StringRef, StringRef> Split = Desc.split('-');
154 StringRef Token = Split.first;
155 Desc = Split.second;
156
157 if (Token.empty())
158 continue;
159
160 Split = Token.split(':');
161 StringRef Specifier = Split.first;
162 Token = Split.second;
163
164 assert(!Specifier.empty() && "Can't be empty here");
165
Chris Lattnere82bdc42009-11-07 09:35:34 +0000166 switch (Specifier[0]) {
Owen Anderson8f60c562006-05-12 05:49:47 +0000167 case 'E':
Owen Anderson571a13f2006-05-12 06:06:55 +0000168 LittleEndian = false;
169 break;
Owen Anderson8f60c562006-05-12 05:49:47 +0000170 case 'e':
Owen Anderson571a13f2006-05-12 06:06:55 +0000171 LittleEndian = true;
172 break;
Owen Anderson8f60c562006-05-12 05:49:47 +0000173 case 'p':
Chris Lattnerb7aadfa2009-11-07 09:13:23 +0000174 Split = Token.split(':');
175 PointerMemSize = getInt(Split.first) / 8;
176 Split = Split.second.split(':');
177 PointerABIAlign = getInt(Split.first) / 8;
178 Split = Split.second.split(':');
179 PointerPrefAlign = getInt(Split.first) / 8;
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000180 if (PointerPrefAlign == 0)
181 PointerPrefAlign = PointerABIAlign;
Owen Anderson571a13f2006-05-12 06:06:55 +0000182 break;
Owen Anderson8f60c562006-05-12 05:49:47 +0000183 case 'i':
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000184 case 'v':
185 case 'f':
Rafael Espindola588af2f2007-09-07 14:52:14 +0000186 case 'a':
187 case 's': {
Chris Lattnerb7aadfa2009-11-07 09:13:23 +0000188 AlignTypeEnum AlignType;
189 switch (Specifier[0]) {
190 default:
191 case 'i': AlignType = INTEGER_ALIGN; break;
192 case 'v': AlignType = VECTOR_ALIGN; break;
193 case 'f': AlignType = FLOAT_ALIGN; break;
194 case 'a': AlignType = AGGREGATE_ALIGN; break;
195 case 's': AlignType = STACK_ALIGN; break;
Rafael Espindola588af2f2007-09-07 14:52:14 +0000196 }
Chris Lattnerb7aadfa2009-11-07 09:13:23 +0000197 unsigned Size = getInt(Specifier.substr(1));
198 Split = Token.split(':');
199 unsigned char ABIAlign = getInt(Split.first) / 8;
200
201 Split = Split.second.split(':');
202 unsigned char PrefAlign = getInt(Split.first) / 8;
203 if (PrefAlign == 0)
204 PrefAlign = ABIAlign;
205 setAlignment(AlignType, ABIAlign, PrefAlign, Size);
Owen Anderson571a13f2006-05-12 06:06:55 +0000206 break;
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000207 }
Chris Lattnere82bdc42009-11-07 09:35:34 +0000208 case 'n': // Native integer types.
209 Specifier = Specifier.substr(1);
210 do {
211 if (unsigned Width = getInt(Specifier))
212 LegalIntWidths.push_back(Width);
213 Split = Token.split(':');
214 Specifier = Split.first;
215 Token = Split.second;
216 } while (!Specifier.empty() || !Token.empty());
217 break;
218
Owen Anderson8f60c562006-05-12 05:49:47 +0000219 default:
Owen Anderson571a13f2006-05-12 06:06:55 +0000220 break;
Owen Anderson8f60c562006-05-12 05:49:47 +0000221 }
222 }
223}
224
Chris Lattner2e074942009-11-07 09:23:04 +0000225/// Default ctor.
226///
227/// @note This has to exist, because this is a pass, but it should never be
228/// used.
Owen Anderson1f745902010-08-06 00:23:35 +0000229TargetData::TargetData() : ImmutablePass(&ID) {
Chris Lattner75361b62010-04-07 22:58:41 +0000230 report_fatal_error("Bad TargetData ctor used. "
Chris Lattner2e074942009-11-07 09:23:04 +0000231 "Tool did not specify a TargetData to use?");
232}
233
Devang Patel794fd752007-05-01 21:15:47 +0000234TargetData::TargetData(const Module *M)
Owen Anderson1f745902010-08-06 00:23:35 +0000235 : ImmutablePass(&ID) {
Reid Spencer26f23852007-01-26 08:11:39 +0000236 init(M->getDataLayout());
Chris Lattner53a0c382003-04-24 19:09:05 +0000237}
238
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000239void
240TargetData::setAlignment(AlignTypeEnum align_type, unsigned char abi_align,
Reid Spencerf734ea22007-02-19 22:35:00 +0000241 unsigned char pref_align, uint32_t bit_width) {
Duncan Sandsd1025932008-01-29 06:23:44 +0000242 assert(abi_align <= pref_align && "Preferred alignment worse than ABI!");
Chris Lattneraffeb562007-02-17 00:41:42 +0000243 for (unsigned i = 0, e = Alignments.size(); i != e; ++i) {
244 if (Alignments[i].AlignType == align_type &&
245 Alignments[i].TypeBitWidth == bit_width) {
246 // Update the abi, preferred alignments.
247 Alignments[i].ABIAlign = abi_align;
248 Alignments[i].PrefAlign = pref_align;
249 return;
250 }
251 }
252
253 Alignments.push_back(TargetAlignElem::get(align_type, abi_align,
254 pref_align, bit_width));
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000255}
256
Chris Lattneraffeb562007-02-17 00:41:42 +0000257/// getAlignmentInfo - Return the alignment (either ABI if ABIInfo = true or
258/// preferred if ABIInfo = false) the target wants for the specified datatype.
Reid Spencerf734ea22007-02-19 22:35:00 +0000259unsigned TargetData::getAlignmentInfo(AlignTypeEnum AlignType,
Chris Lattner9c4428b2008-01-10 00:30:57 +0000260 uint32_t BitWidth, bool ABIInfo,
261 const Type *Ty) const {
Chris Lattneraffeb562007-02-17 00:41:42 +0000262 // Check to see if we have an exact match and remember the best match we see.
263 int BestMatchIdx = -1;
Reid Spencerf734ea22007-02-19 22:35:00 +0000264 int LargestInt = -1;
Chris Lattneraffeb562007-02-17 00:41:42 +0000265 for (unsigned i = 0, e = Alignments.size(); i != e; ++i) {
266 if (Alignments[i].AlignType == AlignType &&
267 Alignments[i].TypeBitWidth == BitWidth)
268 return ABIInfo ? Alignments[i].ABIAlign : Alignments[i].PrefAlign;
269
270 // The best match so far depends on what we're looking for.
Dan Gohman6e8fd902010-04-23 19:41:15 +0000271 if (AlignType == INTEGER_ALIGN &&
272 Alignments[i].AlignType == INTEGER_ALIGN) {
Reid Spencerf734ea22007-02-19 22:35:00 +0000273 // The "best match" for integers is the smallest size that is larger than
274 // the BitWidth requested.
275 if (Alignments[i].TypeBitWidth > BitWidth && (BestMatchIdx == -1 ||
276 Alignments[i].TypeBitWidth < Alignments[BestMatchIdx].TypeBitWidth))
277 BestMatchIdx = i;
278 // However, if there isn't one that's larger, then we must use the
279 // largest one we have (see below)
280 if (LargestInt == -1 ||
281 Alignments[i].TypeBitWidth > Alignments[LargestInt].TypeBitWidth)
282 LargestInt = i;
Chris Lattneraffeb562007-02-17 00:41:42 +0000283 }
Chris Lattneraffeb562007-02-17 00:41:42 +0000284 }
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000285
Chris Lattneraffeb562007-02-17 00:41:42 +0000286 // Okay, we didn't find an exact solution. Fall back here depending on what
287 // is being looked for.
Chris Lattner9c4428b2008-01-10 00:30:57 +0000288 if (BestMatchIdx == -1) {
289 // If we didn't find an integer alignment, fall back on most conservative.
290 if (AlignType == INTEGER_ALIGN) {
291 BestMatchIdx = LargestInt;
292 } else {
293 assert(AlignType == VECTOR_ALIGN && "Unknown alignment type!");
Dan Gohman9fbb52d2009-02-16 23:14:14 +0000294
Dan Gohman6e8fd902010-04-23 19:41:15 +0000295 // By default, use natural alignment for vector types. This is consistent
296 // with what clang and llvm-gcc do.
297 unsigned Align = getTypeAllocSize(cast<VectorType>(Ty)->getElementType());
298 Align *= cast<VectorType>(Ty)->getNumElements();
299 // If the alignment is not a power of 2, round up to the next power of 2.
300 // This happens for non-power-of-2 length vectors.
301 if (Align & (Align-1))
302 Align = llvm::NextPowerOf2(Align);
303 return Align;
Dan Gohman9fbb52d2009-02-16 23:14:14 +0000304 }
Chris Lattner9c4428b2008-01-10 00:30:57 +0000305 }
Dan Gohman9fbb52d2009-02-16 23:14:14 +0000306
Reid Spencerf734ea22007-02-19 22:35:00 +0000307 // Since we got a "best match" index, just return it.
Chris Lattneraffeb562007-02-17 00:41:42 +0000308 return ABIInfo ? Alignments[BestMatchIdx].ABIAlign
309 : Alignments[BestMatchIdx].PrefAlign;
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000310}
311
Bill Wendlingdd5eb022009-12-03 00:17:12 +0000312namespace {
Bill Wendling5eea3422009-11-18 01:03:56 +0000313
314class StructLayoutMap : public AbstractTypeUser {
Bill Wendling1500c4f2009-12-04 21:03:02 +0000315 typedef DenseMap<const StructType*, StructLayout*> LayoutInfoTy;
Bill Wendling5eea3422009-11-18 01:03:56 +0000316 LayoutInfoTy LayoutInfo;
317
Chris Lattner551dec52009-12-17 20:00:21 +0000318 void RemoveEntry(LayoutInfoTy::iterator I, bool WasAbstract) {
319 I->second->~StructLayout();
320 free(I->second);
321 if (WasAbstract)
322 I->first->removeAbstractTypeUser(this);
323 LayoutInfo.erase(I);
324 }
325
326
Bill Wendling5eea3422009-11-18 01:03:56 +0000327 /// refineAbstractType - The callback method invoked when an abstract type is
328 /// resolved to another type. An object must override this method to update
329 /// its internal state to reference NewType instead of OldType.
330 ///
331 virtual void refineAbstractType(const DerivedType *OldTy,
332 const Type *) {
Chris Lattner551dec52009-12-17 20:00:21 +0000333 LayoutInfoTy::iterator I = LayoutInfo.find(cast<const StructType>(OldTy));
334 assert(I != LayoutInfo.end() && "Using type but not in map?");
335 RemoveEntry(I, true);
Bill Wendling5eea3422009-11-18 01:03:56 +0000336 }
337
338 /// typeBecameConcrete - The other case which AbstractTypeUsers must be aware
339 /// of is when a type makes the transition from being abstract (where it has
340 /// clients on its AbstractTypeUsers list) to concrete (where it does not).
341 /// This method notifies ATU's when this occurs for a type.
342 ///
343 virtual void typeBecameConcrete(const DerivedType *AbsTy) {
Chris Lattner551dec52009-12-17 20:00:21 +0000344 LayoutInfoTy::iterator I = LayoutInfo.find(cast<const StructType>(AbsTy));
345 assert(I != LayoutInfo.end() && "Using type but not in map?");
346 RemoveEntry(I, true);
Bill Wendling5eea3422009-11-18 01:03:56 +0000347 }
348
Bill Wendling5eea3422009-11-18 01:03:56 +0000349public:
350 virtual ~StructLayoutMap() {
351 // Remove any layouts.
352 for (LayoutInfoTy::iterator
Bill Wendlingdd5eb022009-12-03 00:17:12 +0000353 I = LayoutInfo.begin(), E = LayoutInfo.end(); I != E; ++I) {
354 const Type *Key = I->first;
355 StructLayout *Value = I->second;
356
Bill Wendling1500c4f2009-12-04 21:03:02 +0000357 if (Key->isAbstract())
Bill Wendlingdd5eb022009-12-03 00:17:12 +0000358 Key->removeAbstractTypeUser(this);
359
Bill Wendling1500c4f2009-12-04 21:03:02 +0000360 Value->~StructLayout();
361 free(Value);
Bill Wendlingdd5eb022009-12-03 00:17:12 +0000362 }
Bill Wendling5eea3422009-11-18 01:03:56 +0000363 }
364
Bill Wendling56816892009-12-05 01:43:33 +0000365 void InvalidateEntry(const StructType *Ty) {
Bill Wendling688da282009-12-05 01:46:01 +0000366 LayoutInfoTy::iterator I = LayoutInfo.find(Ty);
367 if (I == LayoutInfo.end()) return;
Chris Lattner551dec52009-12-17 20:00:21 +0000368 RemoveEntry(I, Ty->isAbstract());
Bill Wendling56816892009-12-05 01:43:33 +0000369 }
370
Bill Wendlingdd5eb022009-12-03 00:17:12 +0000371 StructLayout *&operator[](const StructType *STy) {
Bill Wendling5eea3422009-11-18 01:03:56 +0000372 return LayoutInfo[STy];
373 }
374
375 // for debugging...
376 virtual void dump() const {}
377};
378
Bill Wendling1500c4f2009-12-04 21:03:02 +0000379} // end anonymous namespace
Owen Anderson2ea20152009-08-20 23:51:44 +0000380
381TargetData::~TargetData() {
Bill Wendlingdd5eb022009-12-03 00:17:12 +0000382 delete static_cast<StructLayoutMap*>(LayoutMap);
Chris Lattner0e7ac162004-02-26 08:02:17 +0000383}
384
Chris Lattner9182e3f2007-02-10 20:15:41 +0000385const StructLayout *TargetData::getStructLayout(const StructType *Ty) const {
Owen Anderson90857502009-08-21 19:59:12 +0000386 if (!LayoutMap)
Bill Wendling5eea3422009-11-18 01:03:56 +0000387 LayoutMap = new StructLayoutMap();
Chris Lattner9182e3f2007-02-10 20:15:41 +0000388
Bill Wendlingdd5eb022009-12-03 00:17:12 +0000389 StructLayoutMap *STM = static_cast<StructLayoutMap*>(LayoutMap);
390 StructLayout *&SL = (*STM)[Ty];
Chris Lattnerf6ca09a2007-02-10 20:26:17 +0000391 if (SL) return SL;
Chris Lattner9182e3f2007-02-10 20:15:41 +0000392
393 // Otherwise, create the struct layout. Because it is variable length, we
394 // malloc it, then use placement new.
Jeff Cohen44f5fb42007-04-09 19:26:30 +0000395 int NumElts = Ty->getNumElements();
Chris Lattner9182e3f2007-02-10 20:15:41 +0000396 StructLayout *L =
Bill Wendling5eea3422009-11-18 01:03:56 +0000397 (StructLayout *)malloc(sizeof(StructLayout)+(NumElts-1) * sizeof(uint64_t));
Chris Lattnerf6ca09a2007-02-10 20:26:17 +0000398
399 // Set SL before calling StructLayout's ctor. The ctor could cause other
400 // entries to be added to TheMap, invalidating our reference.
401 SL = L;
402
Chris Lattner9182e3f2007-02-10 20:15:41 +0000403 new (L) StructLayout(Ty, *this);
Bill Wendlingdd5eb022009-12-03 00:17:12 +0000404
405 if (Ty->isAbstract())
406 Ty->addAbstractTypeUser(STM);
407
Chris Lattner9182e3f2007-02-10 20:15:41 +0000408 return L;
409}
410
411/// InvalidateStructLayoutInfo - TargetData speculatively caches StructLayout
412/// objects. If a TargetData object is alive when types are being refined and
413/// removed, this method must be called whenever a StructType is removed to
414/// avoid a dangling pointer in this cache.
415void TargetData::InvalidateStructLayoutInfo(const StructType *Ty) const {
Owen Anderson90857502009-08-21 19:59:12 +0000416 if (!LayoutMap) return; // No cache.
Bill Wendlingcb064032009-12-03 01:54:07 +0000417
Chris Lattner551dec52009-12-17 20:00:21 +0000418 static_cast<StructLayoutMap*>(LayoutMap)->InvalidateEntry(Ty);
Bill Wendlingdd5eb022009-12-03 00:17:12 +0000419}
Chris Lattner9182e3f2007-02-10 20:15:41 +0000420
Owen Anderson2577c222006-05-12 07:01:44 +0000421std::string TargetData::getStringRepresentation() const {
Chris Lattnerb7aadfa2009-11-07 09:13:23 +0000422 std::string Result;
423 raw_string_ostream OS(Result);
424
425 OS << (LittleEndian ? "e" : "E")
426 << "-p:" << PointerMemSize*8 << ':' << PointerABIAlign*8
427 << ':' << PointerPrefAlign*8;
Chris Lattner2e074942009-11-07 09:23:04 +0000428 for (unsigned i = 0, e = Alignments.size(); i != e; ++i) {
429 const TargetAlignElem &AI = Alignments[i];
430 OS << '-' << (char)AI.AlignType << AI.TypeBitWidth << ':'
431 << AI.ABIAlign*8 << ':' << AI.PrefAlign*8;
432 }
Chris Lattner7e897382009-11-08 02:32:01 +0000433
434 if (!LegalIntWidths.empty()) {
435 OS << "-n" << (unsigned)LegalIntWidths[0];
436
437 for (unsigned i = 1, e = LegalIntWidths.size(); i != e; ++i)
438 OS << ':' << (unsigned)LegalIntWidths[i];
439 }
Chris Lattnerb7aadfa2009-11-07 09:13:23 +0000440 return OS.str();
Owen Anderson2577c222006-05-12 07:01:44 +0000441}
442
Chris Lattner8dff24f2006-01-14 00:07:34 +0000443
Duncan Sands514ab342007-11-01 20:53:16 +0000444uint64_t TargetData::getTypeSizeInBits(const Type *Ty) const {
Chris Lattnerf59ce922001-12-13 00:46:11 +0000445 assert(Ty->isSized() && "Cannot getTypeInfo() on a type that is unsized!");
Chris Lattnerf70c22b2004-06-17 18:19:28 +0000446 switch (Ty->getTypeID()) {
Chris Lattnere7fb3602001-08-27 16:00:15 +0000447 case Type::LabelTyID:
448 case Type::PointerTyID:
Duncan Sands514ab342007-11-01 20:53:16 +0000449 return getPointerSizeInBits();
Chris Lattnere7fb3602001-08-27 16:00:15 +0000450 case Type::ArrayTyID: {
Chris Lattner59b00672004-07-01 17:32:59 +0000451 const ArrayType *ATy = cast<ArrayType>(Ty);
Dan Gohmanaa9d8542010-02-25 15:20:39 +0000452 return getTypeAllocSizeInBits(ATy->getElementType())*ATy->getNumElements();
Chris Lattner527efc62004-12-01 17:14:28 +0000453 }
Chris Lattnerbedb8c12008-12-08 07:11:56 +0000454 case Type::StructTyID:
Chris Lattnere7fb3602001-08-27 16:00:15 +0000455 // Get the layout annotation... which is lazily created on demand.
Chris Lattnerbedb8c12008-12-08 07:11:56 +0000456 return getStructLayout(cast<StructType>(Ty))->getSizeInBits();
Chris Lattner93b122d2010-03-16 21:25:55 +0000457 case Type::UnionTyID: {
458 const UnionType *UnTy = cast<UnionType>(Ty);
459 uint64_t Size = 0;
460 for (UnionType::element_iterator i = UnTy->element_begin(),
461 e = UnTy->element_end(); i != e; ++i) {
462 Size = std::max(Size, getTypeSizeInBits(*i));
463 }
464 return Size;
465 }
Duncan Sands514ab342007-11-01 20:53:16 +0000466 case Type::IntegerTyID:
467 return cast<IntegerType>(Ty)->getBitWidth();
Chris Lattner58092e32007-01-20 22:35:55 +0000468 case Type::VoidTyID:
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000469 return 8;
Duncan Sands514ab342007-11-01 20:53:16 +0000470 case Type::FloatTyID:
471 return 32;
472 case Type::DoubleTyID:
473 return 64;
Dale Johannesen8c1e6a12007-08-03 20:20:50 +0000474 case Type::PPC_FP128TyID:
475 case Type::FP128TyID:
Duncan Sands514ab342007-11-01 20:53:16 +0000476 return 128;
Dale Johannesen8c1e6a12007-08-03 20:20:50 +0000477 // In memory objects this is always aligned to a higher boundary, but
Duncan Sands514ab342007-11-01 20:53:16 +0000478 // only 80 bits contain information.
Dale Johannesen8c1e6a12007-08-03 20:20:50 +0000479 case Type::X86_FP80TyID:
Duncan Sands514ab342007-11-01 20:53:16 +0000480 return 80;
Chris Lattnerbedb8c12008-12-08 07:11:56 +0000481 case Type::VectorTyID:
482 return cast<VectorType>(Ty)->getBitWidth();
Chris Lattner58092e32007-01-20 22:35:55 +0000483 default:
Torok Edwinc23197a2009-07-14 16:55:14 +0000484 llvm_unreachable("TargetData::getTypeSizeInBits(): Unsupported type");
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000485 break;
Chris Lattner58092e32007-01-20 22:35:55 +0000486 }
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000487 return 0;
Chris Lattnere7fb3602001-08-27 16:00:15 +0000488}
489
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000490/*!
491 \param abi_or_pref Flag that determines which alignment is returned. true
492 returns the ABI alignment, false returns the preferred alignment.
493 \param Ty The underlying type for which alignment is determined.
494
495 Get the ABI (\a abi_or_pref == true) or preferred alignment (\a abi_or_pref
496 == false) for the requested type \a Ty.
497 */
Chris Lattnerae6f1fa2007-02-16 22:25:34 +0000498unsigned char TargetData::getAlignment(const Type *Ty, bool abi_or_pref) const {
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000499 int AlignType = -1;
500
501 assert(Ty->isSized() && "Cannot getTypeInfo() on a type that is unsized!");
502 switch (Ty->getTypeID()) {
Chris Lattnerbedb8c12008-12-08 07:11:56 +0000503 // Early escape for the non-numeric types.
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000504 case Type::LabelTyID:
505 case Type::PointerTyID:
506 return (abi_or_pref
507 ? getPointerABIAlignment()
508 : getPointerPrefAlignment());
Chris Lattnerae6f1fa2007-02-16 22:25:34 +0000509 case Type::ArrayTyID:
510 return getAlignment(cast<ArrayType>(Ty)->getElementType(), abi_or_pref);
Dan Gohman9fbb52d2009-02-16 23:14:14 +0000511
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000512 case Type::StructTyID: {
Chris Lattnerae6f1fa2007-02-16 22:25:34 +0000513 // Packed structure types always have an ABI alignment of one.
Chris Lattner3ebb2e02007-02-16 23:11:51 +0000514 if (cast<StructType>(Ty)->isPacked() && abi_or_pref)
Chris Lattnerae6f1fa2007-02-16 22:25:34 +0000515 return 1;
Dan Gohman9fbb52d2009-02-16 23:14:14 +0000516
Chris Lattnerae6f1fa2007-02-16 22:25:34 +0000517 // Get the layout annotation... which is lazily created on demand.
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000518 const StructLayout *Layout = getStructLayout(cast<StructType>(Ty));
Chris Lattner9c4428b2008-01-10 00:30:57 +0000519 unsigned Align = getAlignmentInfo(AGGREGATE_ALIGN, 0, abi_or_pref, Ty);
Chris Lattneraffeb562007-02-17 00:41:42 +0000520 return std::max(Align, (unsigned)Layout->getAlignment());
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000521 }
Chris Lattner93b122d2010-03-16 21:25:55 +0000522 case Type::UnionTyID: {
523 const UnionType *UnTy = cast<UnionType>(Ty);
524 unsigned Align = 1;
525
526 // Unions need the maximum alignment of all their entries
527 for (UnionType::element_iterator i = UnTy->element_begin(),
528 e = UnTy->element_end(); i != e; ++i) {
529 Align = std::max(Align, (unsigned)getAlignment(*i, abi_or_pref));
530 }
531 return Align;
532 }
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000533 case Type::IntegerTyID:
534 case Type::VoidTyID:
535 AlignType = INTEGER_ALIGN;
536 break;
537 case Type::FloatTyID:
538 case Type::DoubleTyID:
Dale Johannesen8c1e6a12007-08-03 20:20:50 +0000539 // PPC_FP128TyID and FP128TyID have different data contents, but the
540 // same size and alignment, so they look the same here.
541 case Type::PPC_FP128TyID:
542 case Type::FP128TyID:
543 case Type::X86_FP80TyID:
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000544 AlignType = FLOAT_ALIGN;
545 break;
Chris Lattner9c4428b2008-01-10 00:30:57 +0000546 case Type::VectorTyID:
547 AlignType = VECTOR_ALIGN;
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000548 break;
549 default:
Torok Edwinc23197a2009-07-14 16:55:14 +0000550 llvm_unreachable("Bad type for getAlignment!!!");
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000551 break;
552 }
553
Duncan Sands514ab342007-11-01 20:53:16 +0000554 return getAlignmentInfo((AlignTypeEnum)AlignType, getTypeSizeInBits(Ty),
Chris Lattner9c4428b2008-01-10 00:30:57 +0000555 abi_or_pref, Ty);
Chris Lattner58092e32007-01-20 22:35:55 +0000556}
557
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000558unsigned char TargetData::getABITypeAlignment(const Type *Ty) const {
559 return getAlignment(Ty, true);
560}
561
Chris Lattnerda63b3a2010-01-25 23:18:11 +0000562/// getABIIntegerTypeAlignment - Return the minimum ABI-required alignment for
563/// an integer type of the specified bitwidth.
564unsigned char TargetData::getABIIntegerTypeAlignment(unsigned BitWidth) const {
565 return getAlignmentInfo(INTEGER_ALIGN, BitWidth, true, 0);
566}
567
568
Rafael Espindola588af2f2007-09-07 14:52:14 +0000569unsigned char TargetData::getCallFrameTypeAlignment(const Type *Ty) const {
570 for (unsigned i = 0, e = Alignments.size(); i != e; ++i)
571 if (Alignments[i].AlignType == STACK_ALIGN)
572 return Alignments[i].ABIAlign;
573
574 return getABITypeAlignment(Ty);
575}
576
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000577unsigned char TargetData::getPrefTypeAlignment(const Type *Ty) const {
578 return getAlignment(Ty, false);
Chris Lattnere7fb3602001-08-27 16:00:15 +0000579}
580
Evan Chengde268f72007-01-24 07:03:39 +0000581unsigned char TargetData::getPreferredTypeAlignmentShift(const Type *Ty) const {
Chris Lattnerd2b7cec2007-02-14 05:52:17 +0000582 unsigned Align = (unsigned) getPrefTypeAlignment(Ty);
Chris Lattnerd2b0bb42004-08-17 19:13:00 +0000583 assert(!(Align & (Align-1)) && "Alignment is not a power of two!");
Chris Lattner0561b3f2005-08-02 19:26:06 +0000584 return Log2_32(Align);
Chris Lattnerd2b0bb42004-08-17 19:13:00 +0000585}
586
Chris Lattnerf0453282003-12-22 05:01:15 +0000587/// getIntPtrType - Return an unsigned integer type that is the same size or
588/// greater to the host pointer size.
Owen Anderson1d0be152009-08-13 21:58:54 +0000589const IntegerType *TargetData::getIntPtrType(LLVMContext &C) const {
590 return IntegerType::get(C, getPointerSizeInBits());
Chris Lattnerf0453282003-12-22 05:01:15 +0000591}
592
593
Chris Lattnerddce8d22007-02-10 19:33:15 +0000594uint64_t TargetData::getIndexedOffset(const Type *ptrTy, Value* const* Indices,
595 unsigned NumIndices) const {
Vikram S. Adveed0030e2002-08-04 20:52:39 +0000596 const Type *Ty = ptrTy;
Duncan Sands1df98592010-02-16 11:11:14 +0000597 assert(Ty->isPointerTy() && "Illegal argument for getIndexedOffset()");
Vikram S. Advef66723f2002-05-19 15:28:02 +0000598 uint64_t Result = 0;
Chris Lattnere7fb3602001-08-27 16:00:15 +0000599
Chris Lattnerddce8d22007-02-10 19:33:15 +0000600 generic_gep_type_iterator<Value* const*>
601 TI = gep_type_begin(ptrTy, Indices, Indices+NumIndices);
602 for (unsigned CurIDX = 0; CurIDX != NumIndices; ++CurIDX, ++TI) {
Chris Lattner28977af2004-04-05 01:30:19 +0000603 if (const StructType *STy = dyn_cast<StructType>(*TI)) {
Owen Anderson1d0be152009-08-13 21:58:54 +0000604 assert(Indices[CurIDX]->getType() ==
605 Type::getInt32Ty(ptrTy->getContext()) &&
Reid Spencer1ede29c2007-03-01 19:48:16 +0000606 "Illegal struct idx");
Chris Lattnerddce8d22007-02-10 19:33:15 +0000607 unsigned FieldNo = cast<ConstantInt>(Indices[CurIDX])->getZExtValue();
Chris Lattnere7fb3602001-08-27 16:00:15 +0000608
609 // Get structure layout information...
610 const StructLayout *Layout = getStructLayout(STy);
611
612 // Add in the offset, as calculated by the structure layout info...
Chris Lattnerb1919e22007-02-10 19:55:17 +0000613 Result += Layout->getElementOffset(FieldNo);
Vikram S. Adveed0030e2002-08-04 20:52:39 +0000614
Chris Lattnere7fb3602001-08-27 16:00:15 +0000615 // Update Ty to refer to current element
Chris Lattnerd21cd802004-02-09 04:37:31 +0000616 Ty = STy->getElementType(FieldNo);
Chris Lattner93b122d2010-03-16 21:25:55 +0000617 } else if (const UnionType *UnTy = dyn_cast<UnionType>(*TI)) {
618 unsigned FieldNo = cast<ConstantInt>(Indices[CurIDX])->getZExtValue();
619
620 // Offset into union is canonically 0, but type changes
621 Ty = UnTy->getElementType(FieldNo);
Chris Lattner28977af2004-04-05 01:30:19 +0000622 } else {
623 // Update Ty to refer to current element
624 Ty = cast<SequentialType>(Ty)->getElementType();
625
626 // Get the array index and the size of each array element.
Chris Lattner34e9d172010-04-17 19:02:33 +0000627 if (int64_t arrayIdx = cast<ConstantInt>(Indices[CurIDX])->getSExtValue())
Dan Gohman67d04982010-07-28 17:11:36 +0000628 Result += (uint64_t)arrayIdx * getTypeAllocSize(Ty);
Chris Lattnere7fb3602001-08-27 16:00:15 +0000629 }
630 }
631
632 return Result;
633}
Brian Gaeked0fde302003-11-11 22:41:34 +0000634
Duncan Sandsd1025932008-01-29 06:23:44 +0000635/// getPreferredAlignment - Return the preferred alignment of the specified
636/// global. This includes an explicitly requested alignment (if the global
637/// has one).
638unsigned TargetData::getPreferredAlignment(const GlobalVariable *GV) const {
639 const Type *ElemType = GV->getType()->getElementType();
640 unsigned Alignment = getPrefTypeAlignment(ElemType);
641 if (GV->getAlignment() > Alignment)
642 Alignment = GV->getAlignment();
643
644 if (GV->hasInitializer()) {
645 if (Alignment < 16) {
646 // If the global is not external, see if it is large. If so, give it a
647 // larger alignment.
Dan Gohmanf860db22010-04-02 03:04:37 +0000648 if (getTypeSizeInBits(ElemType) > 128)
Duncan Sandsd1025932008-01-29 06:23:44 +0000649 Alignment = 16; // 16-byte alignment.
650 }
651 }
652 return Alignment;
653}
654
Devang Patelf9c197e2006-10-24 20:32:14 +0000655/// getPreferredAlignmentLog - Return the preferred alignment of the
656/// specified global, returned in log form. This includes an explicitly
657/// requested alignment (if the global has one).
658unsigned TargetData::getPreferredAlignmentLog(const GlobalVariable *GV) const {
Duncan Sandsd1025932008-01-29 06:23:44 +0000659 return Log2_32(getPreferredAlignment(GV));
Devang Patelf9c197e2006-10-24 20:32:14 +0000660}