1 //===-- TargetData.cpp - Data size & alignment routines --------------------==//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines target properties related to datatype size/offset/alignment
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.
17 //===----------------------------------------------------------------------===//
19 #include "llvm/Target/TargetData.h"
20 #include "llvm/Constants.h"
21 #include "llvm/DerivedTypes.h"
22 #include "llvm/Module.h"
23 #include "llvm/Support/GetElementPtrTypeIterator.h"
24 #include "llvm/Support/MathExtras.h"
25 #include "llvm/Support/ManagedStatic.h"
26 #include "llvm/Support/ErrorHandling.h"
27 #include "llvm/Support/raw_ostream.h"
28 #include "llvm/Support/Mutex.h"
29 #include "llvm/ADT/DenseMap.h"
34 // Handle the Pass registration stuff necessary to use TargetData's.
36 // Register the default SparcV9 implementation...
37 INITIALIZE_PASS(TargetData
, "targetdata", "Target Data Layout", false, true)
38 char TargetData::ID
= 0;
40 //===----------------------------------------------------------------------===//
41 // Support for StructLayout
42 //===----------------------------------------------------------------------===//
44 StructLayout::StructLayout(const StructType
*ST
, const TargetData
&TD
) {
45 assert(!ST
->isOpaque() && "Cannot get layout of opaque structs");
48 NumElements
= ST
->getNumElements();
50 // Loop over each of the elements, placing them in memory.
51 for (unsigned i
= 0, e
= NumElements
; i
!= e
; ++i
) {
52 const Type
*Ty
= ST
->getElementType(i
);
53 unsigned TyAlign
= ST
->isPacked() ? 1 : TD
.getABITypeAlignment(Ty
);
55 // Add padding if necessary to align the data element properly.
56 if ((StructSize
& (TyAlign
-1)) != 0)
57 StructSize
= TargetData::RoundUpAlignment(StructSize
, TyAlign
);
59 // Keep track of maximum alignment constraint.
60 StructAlignment
= std::max(TyAlign
, StructAlignment
);
62 MemberOffsets
[i
] = StructSize
;
63 StructSize
+= TD
.getTypeAllocSize(Ty
); // Consume space for this data item
66 // Empty structures have alignment of 1 byte.
67 if (StructAlignment
== 0) StructAlignment
= 1;
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.
71 if ((StructSize
& (StructAlignment
-1)) != 0)
72 StructSize
= TargetData::RoundUpAlignment(StructSize
, StructAlignment
);
76 /// getElementContainingOffset - Given a valid offset into the structure,
77 /// return the structure index that contains it.
78 unsigned StructLayout::getElementContainingOffset(uint64_t Offset
) const {
80 std::upper_bound(&MemberOffsets
[0], &MemberOffsets
[NumElements
], Offset
);
81 assert(SI
!= &MemberOffsets
[0] && "Offset not in structure type!");
83 assert(*SI
<= Offset
&& "upper_bound didn't work");
84 assert((SI
== &MemberOffsets
[0] || *(SI
-1) <= Offset
) &&
85 (SI
+1 == &MemberOffsets
[NumElements
] || *(SI
+1) > Offset
) &&
86 "Upper bound didn't work!");
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.
93 return SI
-&MemberOffsets
[0];
96 //===----------------------------------------------------------------------===//
97 // TargetAlignElem, TargetAlign support
98 //===----------------------------------------------------------------------===//
101 TargetAlignElem::get(AlignTypeEnum align_type
, unsigned abi_align
,
102 unsigned pref_align
, uint32_t bit_width
) {
103 assert(abi_align
<= pref_align
&& "Preferred alignment worse than ABI!");
104 TargetAlignElem retval
;
105 retval
.AlignType
= align_type
;
106 retval
.ABIAlign
= abi_align
;
107 retval
.PrefAlign
= pref_align
;
108 retval
.TypeBitWidth
= bit_width
;
113 TargetAlignElem::operator==(const TargetAlignElem
&rhs
) const {
114 return (AlignType
== rhs
.AlignType
115 && ABIAlign
== rhs
.ABIAlign
116 && PrefAlign
== rhs
.PrefAlign
117 && TypeBitWidth
== rhs
.TypeBitWidth
);
120 const TargetAlignElem
TargetData::InvalidAlignmentElem
=
121 TargetAlignElem::get((AlignTypeEnum
) -1, 0, 0, 0);
123 //===----------------------------------------------------------------------===//
124 // TargetData Class Implementation
125 //===----------------------------------------------------------------------===//
127 /// getInt - Get an integer ignoring errors.
128 static unsigned getInt(StringRef R
) {
130 R
.getAsInteger(10, Result
);
134 void TargetData::init(StringRef Desc
) {
135 initializeTargetDataPass(*PassRegistry::getPassRegistry());
138 LittleEndian
= false;
141 PointerPrefAlign
= PointerABIAlign
;
143 // Default alignments
144 setAlignment(INTEGER_ALIGN
, 1, 1, 1); // i1
145 setAlignment(INTEGER_ALIGN
, 1, 1, 8); // i8
146 setAlignment(INTEGER_ALIGN
, 2, 2, 16); // i16
147 setAlignment(INTEGER_ALIGN
, 4, 4, 32); // i32
148 setAlignment(INTEGER_ALIGN
, 4, 8, 64); // i64
149 setAlignment(FLOAT_ALIGN
, 4, 4, 32); // float
150 setAlignment(FLOAT_ALIGN
, 8, 8, 64); // double
151 setAlignment(VECTOR_ALIGN
, 8, 8, 64); // v2i32, v1i64, ...
152 setAlignment(VECTOR_ALIGN
, 16, 16, 128); // v16i8, v8i16, v4i32, ...
153 setAlignment(AGGREGATE_ALIGN
, 0, 8, 0); // struct
155 while (!Desc
.empty()) {
156 std::pair
<StringRef
, StringRef
> Split
= Desc
.split('-');
157 StringRef Token
= Split
.first
;
163 Split
= Token
.split(':');
164 StringRef Specifier
= Split
.first
;
165 Token
= Split
.second
;
167 assert(!Specifier
.empty() && "Can't be empty here");
169 switch (Specifier
[0]) {
171 LittleEndian
= false;
177 Split
= Token
.split(':');
178 PointerMemSize
= getInt(Split
.first
) / 8;
179 Split
= Split
.second
.split(':');
180 PointerABIAlign
= getInt(Split
.first
) / 8;
181 Split
= Split
.second
.split(':');
182 PointerPrefAlign
= getInt(Split
.first
) / 8;
183 if (PointerPrefAlign
== 0)
184 PointerPrefAlign
= PointerABIAlign
;
191 AlignTypeEnum AlignType
;
192 switch (Specifier
[0]) {
194 case 'i': AlignType
= INTEGER_ALIGN
; break;
195 case 'v': AlignType
= VECTOR_ALIGN
; break;
196 case 'f': AlignType
= FLOAT_ALIGN
; break;
197 case 'a': AlignType
= AGGREGATE_ALIGN
; break;
198 case 's': AlignType
= STACK_ALIGN
; break;
200 unsigned Size
= getInt(Specifier
.substr(1));
201 Split
= Token
.split(':');
202 unsigned ABIAlign
= getInt(Split
.first
) / 8;
204 Split
= Split
.second
.split(':');
205 unsigned PrefAlign
= getInt(Split
.first
) / 8;
207 PrefAlign
= ABIAlign
;
208 setAlignment(AlignType
, ABIAlign
, PrefAlign
, Size
);
211 case 'n': // Native integer types.
212 Specifier
= Specifier
.substr(1);
214 if (unsigned Width
= getInt(Specifier
))
215 LegalIntWidths
.push_back(Width
);
216 Split
= Token
.split(':');
217 Specifier
= Split
.first
;
218 Token
= Split
.second
;
219 } while (!Specifier
.empty() || !Token
.empty());
230 /// @note This has to exist, because this is a pass, but it should never be
232 TargetData::TargetData() : ImmutablePass(ID
) {
233 report_fatal_error("Bad TargetData ctor used. "
234 "Tool did not specify a TargetData to use?");
237 TargetData::TargetData(const Module
*M
)
238 : ImmutablePass(ID
) {
239 init(M
->getDataLayout());
243 TargetData::setAlignment(AlignTypeEnum align_type
, unsigned abi_align
,
244 unsigned pref_align
, uint32_t bit_width
) {
245 assert(abi_align
<= pref_align
&& "Preferred alignment worse than ABI!");
246 for (unsigned i
= 0, e
= Alignments
.size(); i
!= e
; ++i
) {
247 if (Alignments
[i
].AlignType
== align_type
&&
248 Alignments
[i
].TypeBitWidth
== bit_width
) {
249 // Update the abi, preferred alignments.
250 Alignments
[i
].ABIAlign
= abi_align
;
251 Alignments
[i
].PrefAlign
= pref_align
;
256 Alignments
.push_back(TargetAlignElem::get(align_type
, abi_align
,
257 pref_align
, bit_width
));
260 /// getAlignmentInfo - Return the alignment (either ABI if ABIInfo = true or
261 /// preferred if ABIInfo = false) the target wants for the specified datatype.
262 unsigned TargetData::getAlignmentInfo(AlignTypeEnum AlignType
,
263 uint32_t BitWidth
, bool ABIInfo
,
264 const Type
*Ty
) const {
265 // Check to see if we have an exact match and remember the best match we see.
266 int BestMatchIdx
= -1;
268 for (unsigned i
= 0, e
= Alignments
.size(); i
!= e
; ++i
) {
269 if (Alignments
[i
].AlignType
== AlignType
&&
270 Alignments
[i
].TypeBitWidth
== BitWidth
)
271 return ABIInfo
? Alignments
[i
].ABIAlign
: Alignments
[i
].PrefAlign
;
273 // The best match so far depends on what we're looking for.
274 if (AlignType
== INTEGER_ALIGN
&&
275 Alignments
[i
].AlignType
== INTEGER_ALIGN
) {
276 // The "best match" for integers is the smallest size that is larger than
277 // the BitWidth requested.
278 if (Alignments
[i
].TypeBitWidth
> BitWidth
&& (BestMatchIdx
== -1 ||
279 Alignments
[i
].TypeBitWidth
< Alignments
[BestMatchIdx
].TypeBitWidth
))
281 // However, if there isn't one that's larger, then we must use the
282 // largest one we have (see below)
283 if (LargestInt
== -1 ||
284 Alignments
[i
].TypeBitWidth
> Alignments
[LargestInt
].TypeBitWidth
)
289 // Okay, we didn't find an exact solution. Fall back here depending on what
290 // is being looked for.
291 if (BestMatchIdx
== -1) {
292 // If we didn't find an integer alignment, fall back on most conservative.
293 if (AlignType
== INTEGER_ALIGN
) {
294 BestMatchIdx
= LargestInt
;
296 assert(AlignType
== VECTOR_ALIGN
&& "Unknown alignment type!");
298 // By default, use natural alignment for vector types. This is consistent
299 // with what clang and llvm-gcc do.
300 unsigned Align
= getTypeAllocSize(cast
<VectorType
>(Ty
)->getElementType());
301 Align
*= cast
<VectorType
>(Ty
)->getNumElements();
302 // If the alignment is not a power of 2, round up to the next power of 2.
303 // This happens for non-power-of-2 length vectors.
304 if (Align
& (Align
-1))
305 Align
= llvm::NextPowerOf2(Align
);
310 // Since we got a "best match" index, just return it.
311 return ABIInfo
? Alignments
[BestMatchIdx
].ABIAlign
312 : Alignments
[BestMatchIdx
].PrefAlign
;
317 class StructLayoutMap
{
318 typedef DenseMap
<const StructType
*, StructLayout
*> LayoutInfoTy
;
319 LayoutInfoTy LayoutInfo
;
322 virtual ~StructLayoutMap() {
323 // Remove any layouts.
324 for (LayoutInfoTy::iterator I
= LayoutInfo
.begin(), E
= LayoutInfo
.end();
326 StructLayout
*Value
= I
->second
;
327 Value
->~StructLayout();
332 void InvalidateEntry(const StructType
*Ty
) {
333 LayoutInfoTy::iterator I
= LayoutInfo
.find(Ty
);
334 if (I
== LayoutInfo
.end()) return;
336 I
->second
->~StructLayout();
341 StructLayout
*&operator[](const StructType
*STy
) {
342 return LayoutInfo
[STy
];
346 virtual void dump() const {}
349 } // end anonymous namespace
351 TargetData::~TargetData() {
352 delete static_cast<StructLayoutMap
*>(LayoutMap
);
355 const StructLayout
*TargetData::getStructLayout(const StructType
*Ty
) const {
357 LayoutMap
= new StructLayoutMap();
359 StructLayoutMap
*STM
= static_cast<StructLayoutMap
*>(LayoutMap
);
360 StructLayout
*&SL
= (*STM
)[Ty
];
363 // Otherwise, create the struct layout. Because it is variable length, we
364 // malloc it, then use placement new.
365 int NumElts
= Ty
->getNumElements();
367 (StructLayout
*)malloc(sizeof(StructLayout
)+(NumElts
-1) * sizeof(uint64_t));
369 // Set SL before calling StructLayout's ctor. The ctor could cause other
370 // entries to be added to TheMap, invalidating our reference.
373 new (L
) StructLayout(Ty
, *this);
378 /// InvalidateStructLayoutInfo - TargetData speculatively caches StructLayout
379 /// objects. If a TargetData object is alive when types are being refined and
380 /// removed, this method must be called whenever a StructType is removed to
381 /// avoid a dangling pointer in this cache.
382 void TargetData::InvalidateStructLayoutInfo(const StructType
*Ty
) const {
383 if (!LayoutMap
) return; // No cache.
385 static_cast<StructLayoutMap
*>(LayoutMap
)->InvalidateEntry(Ty
);
388 std::string
TargetData::getStringRepresentation() const {
390 raw_string_ostream
OS(Result
);
392 OS
<< (LittleEndian
? "e" : "E")
393 << "-p:" << PointerMemSize
*8 << ':' << PointerABIAlign
*8
394 << ':' << PointerPrefAlign
*8;
395 for (unsigned i
= 0, e
= Alignments
.size(); i
!= e
; ++i
) {
396 const TargetAlignElem
&AI
= Alignments
[i
];
397 OS
<< '-' << (char)AI
.AlignType
<< AI
.TypeBitWidth
<< ':'
398 << AI
.ABIAlign
*8 << ':' << AI
.PrefAlign
*8;
401 if (!LegalIntWidths
.empty()) {
402 OS
<< "-n" << (unsigned)LegalIntWidths
[0];
404 for (unsigned i
= 1, e
= LegalIntWidths
.size(); i
!= e
; ++i
)
405 OS
<< ':' << (unsigned)LegalIntWidths
[i
];
411 uint64_t TargetData::getTypeSizeInBits(const Type
*Ty
) const {
412 assert(Ty
->isSized() && "Cannot getTypeInfo() on a type that is unsized!");
413 switch (Ty
->getTypeID()) {
414 case Type::LabelTyID
:
415 case Type::PointerTyID
:
416 return getPointerSizeInBits();
417 case Type::ArrayTyID
: {
418 const ArrayType
*ATy
= cast
<ArrayType
>(Ty
);
419 return getTypeAllocSizeInBits(ATy
->getElementType())*ATy
->getNumElements();
421 case Type::StructTyID
:
422 // Get the layout annotation... which is lazily created on demand.
423 return getStructLayout(cast
<StructType
>(Ty
))->getSizeInBits();
424 case Type::IntegerTyID
:
425 return cast
<IntegerType
>(Ty
)->getBitWidth();
428 case Type::FloatTyID
:
430 case Type::DoubleTyID
:
431 case Type::X86_MMXTyID
:
433 case Type::PPC_FP128TyID
:
434 case Type::FP128TyID
:
436 // In memory objects this is always aligned to a higher boundary, but
437 // only 80 bits contain information.
438 case Type::X86_FP80TyID
:
440 case Type::VectorTyID
:
441 return cast
<VectorType
>(Ty
)->getBitWidth();
443 llvm_unreachable("TargetData::getTypeSizeInBits(): Unsupported type");
450 \param abi_or_pref Flag that determines which alignment is returned. true
451 returns the ABI alignment, false returns the preferred alignment.
452 \param Ty The underlying type for which alignment is determined.
454 Get the ABI (\a abi_or_pref == true) or preferred alignment (\a abi_or_pref
455 == false) for the requested type \a Ty.
457 unsigned TargetData::getAlignment(const Type
*Ty
, bool abi_or_pref
) const {
460 assert(Ty
->isSized() && "Cannot getTypeInfo() on a type that is unsized!");
461 switch (Ty
->getTypeID()) {
462 // Early escape for the non-numeric types.
463 case Type::LabelTyID
:
464 case Type::PointerTyID
:
466 ? getPointerABIAlignment()
467 : getPointerPrefAlignment());
468 case Type::ArrayTyID
:
469 return getAlignment(cast
<ArrayType
>(Ty
)->getElementType(), abi_or_pref
);
471 case Type::StructTyID
: {
472 // Packed structure types always have an ABI alignment of one.
473 if (cast
<StructType
>(Ty
)->isPacked() && abi_or_pref
)
476 // Get the layout annotation... which is lazily created on demand.
477 const StructLayout
*Layout
= getStructLayout(cast
<StructType
>(Ty
));
478 unsigned Align
= getAlignmentInfo(AGGREGATE_ALIGN
, 0, abi_or_pref
, Ty
);
479 return std::max(Align
, Layout
->getAlignment());
481 case Type::IntegerTyID
:
483 AlignType
= INTEGER_ALIGN
;
485 case Type::FloatTyID
:
486 case Type::DoubleTyID
:
487 // PPC_FP128TyID and FP128TyID have different data contents, but the
488 // same size and alignment, so they look the same here.
489 case Type::PPC_FP128TyID
:
490 case Type::FP128TyID
:
491 case Type::X86_FP80TyID
:
492 AlignType
= FLOAT_ALIGN
;
494 case Type::X86_MMXTyID
:
495 case Type::VectorTyID
:
496 AlignType
= VECTOR_ALIGN
;
499 llvm_unreachable("Bad type for getAlignment!!!");
503 return getAlignmentInfo((AlignTypeEnum
)AlignType
, getTypeSizeInBits(Ty
),
507 unsigned TargetData::getABITypeAlignment(const Type
*Ty
) const {
508 return getAlignment(Ty
, true);
511 /// getABIIntegerTypeAlignment - Return the minimum ABI-required alignment for
512 /// an integer type of the specified bitwidth.
513 unsigned TargetData::getABIIntegerTypeAlignment(unsigned BitWidth
) const {
514 return getAlignmentInfo(INTEGER_ALIGN
, BitWidth
, true, 0);
518 unsigned TargetData::getCallFrameTypeAlignment(const Type
*Ty
) const {
519 for (unsigned i
= 0, e
= Alignments
.size(); i
!= e
; ++i
)
520 if (Alignments
[i
].AlignType
== STACK_ALIGN
)
521 return Alignments
[i
].ABIAlign
;
523 return getABITypeAlignment(Ty
);
526 unsigned TargetData::getPrefTypeAlignment(const Type
*Ty
) const {
527 return getAlignment(Ty
, false);
530 unsigned TargetData::getPreferredTypeAlignmentShift(const Type
*Ty
) const {
531 unsigned Align
= getPrefTypeAlignment(Ty
);
532 assert(!(Align
& (Align
-1)) && "Alignment is not a power of two!");
533 return Log2_32(Align
);
536 /// getIntPtrType - Return an unsigned integer type that is the same size or
537 /// greater to the host pointer size.
538 const IntegerType
*TargetData::getIntPtrType(LLVMContext
&C
) const {
539 return IntegerType::get(C
, getPointerSizeInBits());
543 uint64_t TargetData::getIndexedOffset(const Type
*ptrTy
, Value
* const* Indices
,
544 unsigned NumIndices
) const {
545 const Type
*Ty
= ptrTy
;
546 assert(Ty
->isPointerTy() && "Illegal argument for getIndexedOffset()");
549 generic_gep_type_iterator
<Value
* const*>
550 TI
= gep_type_begin(ptrTy
, Indices
, Indices
+NumIndices
);
551 for (unsigned CurIDX
= 0; CurIDX
!= NumIndices
; ++CurIDX
, ++TI
) {
552 if (const StructType
*STy
= dyn_cast
<StructType
>(*TI
)) {
553 assert(Indices
[CurIDX
]->getType() ==
554 Type::getInt32Ty(ptrTy
->getContext()) &&
555 "Illegal struct idx");
556 unsigned FieldNo
= cast
<ConstantInt
>(Indices
[CurIDX
])->getZExtValue();
558 // Get structure layout information...
559 const StructLayout
*Layout
= getStructLayout(STy
);
561 // Add in the offset, as calculated by the structure layout info...
562 Result
+= Layout
->getElementOffset(FieldNo
);
564 // Update Ty to refer to current element
565 Ty
= STy
->getElementType(FieldNo
);
567 // Update Ty to refer to current element
568 Ty
= cast
<SequentialType
>(Ty
)->getElementType();
570 // Get the array index and the size of each array element.
571 if (int64_t arrayIdx
= cast
<ConstantInt
>(Indices
[CurIDX
])->getSExtValue())
572 Result
+= (uint64_t)arrayIdx
* getTypeAllocSize(Ty
);
579 /// getPreferredAlignment - Return the preferred alignment of the specified
580 /// global. This includes an explicitly requested alignment (if the global
582 unsigned TargetData::getPreferredAlignment(const GlobalVariable
*GV
) const {
583 const Type
*ElemType
= GV
->getType()->getElementType();
584 unsigned Alignment
= getPrefTypeAlignment(ElemType
);
585 unsigned GVAlignment
= GV
->getAlignment();
586 if (GVAlignment
>= Alignment
) {
587 Alignment
= GVAlignment
;
588 } else if (GVAlignment
!= 0) {
589 Alignment
= std::max(GVAlignment
, getABITypeAlignment(ElemType
));
592 if (GV
->hasInitializer() && GVAlignment
== 0) {
593 if (Alignment
< 16) {
594 // If the global is not external, see if it is large. If so, give it a
596 if (getTypeSizeInBits(ElemType
) > 128)
597 Alignment
= 16; // 16-byte alignment.
603 /// getPreferredAlignmentLog - Return the preferred alignment of the
604 /// specified global, returned in log form. This includes an explicitly
605 /// requested alignment (if the global has one).
606 unsigned TargetData::getPreferredAlignmentLog(const GlobalVariable
*GV
) const {
607 return Log2_32(getPreferredAlignment(GV
));