1 //===-- llvm/IntegersSubset.h - The subset of integers ----------*- C++ -*-===//
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 //===----------------------------------------------------------------------===//
11 /// This file contains class that implements constant set of ranges:
12 /// [<Low0,High0>,...,<LowN,HighN>]. Initially, this class was created for
13 /// SwitchInst and was used for case value representation that may contain
14 /// multiple ranges for a single successor.
16 //===----------------------------------------------------------------------===//
18 #ifndef CONSTANTRANGESSET_H_
19 #define CONSTANTRANGESSET_H_
23 #include "llvm/Constants.h"
24 #include "llvm/DerivedTypes.h"
25 #include "llvm/LLVMContext.h"
29 // The IntItem is a wrapper for APInt.
30 // 1. It determines sign of integer, it allows to use
31 // comparison operators >,<,>=,<=, and as result we got shorter and cleaner
33 // 2. It helps to implement PR1255 (case ranges) as a series of small patches.
34 // 3. Currently we can interpret IntItem both as ConstantInt and as APInt.
35 // It allows to provide SwitchInst methods that works with ConstantInt for
36 // non-updated passes. And it allows to use APInt interface for new methods.
37 // 4. IntItem can be easily replaced with APInt.
39 // The set of macros that allows to propagate APInt operators to the IntItem.
41 #define INT_ITEM_DEFINE_COMPARISON(op,func) \
42 bool operator op (const APInt& RHS) const { \
43 return getAPIntValue().func(RHS); \
46 #define INT_ITEM_DEFINE_UNARY_OP(op) \
47 IntItem operator op () const { \
48 APInt res = op(getAPIntValue()); \
49 Constant *NewVal = ConstantInt::get(ConstantIntVal->getContext(), res); \
50 return IntItem(cast<ConstantInt>(NewVal)); \
53 #define INT_ITEM_DEFINE_BINARY_OP(op) \
54 IntItem operator op (const APInt& RHS) const { \
55 APInt res = getAPIntValue() op RHS; \
56 Constant *NewVal = ConstantInt::get(ConstantIntVal->getContext(), res); \
57 return IntItem(cast<ConstantInt>(NewVal)); \
60 #define INT_ITEM_DEFINE_ASSIGNMENT_BY_OP(op) \
61 IntItem& operator op (const APInt& RHS) {\
62 APInt res = getAPIntValue();\
64 Constant *NewVal = ConstantInt::get(ConstantIntVal->getContext(), res); \
65 ConstantIntVal = cast<ConstantInt>(NewVal); \
69 #define INT_ITEM_DEFINE_PREINCDEC(op) \
70 IntItem& operator op () { \
71 APInt res = getAPIntValue(); \
73 Constant *NewVal = ConstantInt::get(ConstantIntVal->getContext(), res); \
74 ConstantIntVal = cast<ConstantInt>(NewVal); \
78 #define INT_ITEM_DEFINE_POSTINCDEC(op) \
79 IntItem& operator op (int) { \
80 APInt res = getAPIntValue();\
82 Constant *NewVal = ConstantInt::get(ConstantIntVal->getContext(), res); \
83 OldConstantIntVal = ConstantIntVal; \
84 ConstantIntVal = cast<ConstantInt>(NewVal); \
85 return IntItem(OldConstantIntVal); \
88 #define INT_ITEM_DEFINE_OP_STANDARD_INT(RetTy, op, IntTy) \
89 RetTy operator op (IntTy RHS) const { \
90 return (*this) op APInt(getAPIntValue().getBitWidth(), RHS); \
94 ConstantInt *ConstantIntVal;
95 const APInt* APIntVal;
96 IntItem(const ConstantInt *V) :
97 ConstantIntVal(const_cast<ConstantInt*>(V)),
98 APIntVal(&ConstantIntVal->getValue()){}
99 const APInt& getAPIntValue() const {
106 operator const APInt&() const {
107 return getAPIntValue();
110 // Propagate APInt operators.
112 // /,/=,>>,>>= are not implemented in APInt.
113 // <<= is implemented for unsigned RHS, but not implemented for APInt RHS.
115 INT_ITEM_DEFINE_COMPARISON(<, ult)
116 INT_ITEM_DEFINE_COMPARISON(>, ugt)
117 INT_ITEM_DEFINE_COMPARISON(<=, ule)
118 INT_ITEM_DEFINE_COMPARISON(>=, uge)
120 INT_ITEM_DEFINE_COMPARISON(==, eq)
121 INT_ITEM_DEFINE_OP_STANDARD_INT(bool,==,uint64_t)
123 INT_ITEM_DEFINE_COMPARISON(!=, ne)
124 INT_ITEM_DEFINE_OP_STANDARD_INT(bool,!=,uint64_t)
126 INT_ITEM_DEFINE_BINARY_OP(*)
127 INT_ITEM_DEFINE_BINARY_OP(+)
128 INT_ITEM_DEFINE_OP_STANDARD_INT(IntItem,+,uint64_t)
129 INT_ITEM_DEFINE_BINARY_OP(-)
130 INT_ITEM_DEFINE_OP_STANDARD_INT(IntItem,-,uint64_t)
131 INT_ITEM_DEFINE_BINARY_OP(<<)
132 INT_ITEM_DEFINE_OP_STANDARD_INT(IntItem,<<,unsigned)
133 INT_ITEM_DEFINE_BINARY_OP(&)
134 INT_ITEM_DEFINE_BINARY_OP(^)
135 INT_ITEM_DEFINE_BINARY_OP(|)
137 INT_ITEM_DEFINE_ASSIGNMENT_BY_OP(*=)
138 INT_ITEM_DEFINE_ASSIGNMENT_BY_OP(+=)
139 INT_ITEM_DEFINE_ASSIGNMENT_BY_OP(-=)
140 INT_ITEM_DEFINE_ASSIGNMENT_BY_OP(&=)
141 INT_ITEM_DEFINE_ASSIGNMENT_BY_OP(^=)
142 INT_ITEM_DEFINE_ASSIGNMENT_BY_OP(|=)
144 // Special case for <<=
145 IntItem& operator <<= (unsigned RHS) {
146 APInt res = getAPIntValue();
148 Constant *NewVal = ConstantInt::get(ConstantIntVal->getContext(), res);
149 ConstantIntVal = cast<ConstantInt>(NewVal);
153 INT_ITEM_DEFINE_UNARY_OP(-)
154 INT_ITEM_DEFINE_UNARY_OP(~)
156 INT_ITEM_DEFINE_PREINCDEC(++)
157 INT_ITEM_DEFINE_PREINCDEC(--)
159 // The set of workarounds, since currently we use ConstantInt implemented
162 static IntItem fromConstantInt(const ConstantInt *V) {
165 static IntItem fromType(Type* Ty, const APInt& V) {
166 ConstantInt *C = cast<ConstantInt>(ConstantInt::get(Ty, V));
167 return fromConstantInt(C);
169 static IntItem withImplLikeThis(const IntItem& LikeThis, const APInt& V) {
170 ConstantInt *C = cast<ConstantInt>(ConstantInt::get(
171 LikeThis.ConstantIntVal->getContext(), V));
172 return fromConstantInt(C);
174 ConstantInt *toConstantInt() const {
175 return ConstantIntVal;
179 template<class IntType>
185 bool IsSingleNumber : 1;
188 typedef IntRange<IntType> self;
189 typedef std::pair<self, self> SubRes;
191 IntRange() : IsEmpty(true) {}
192 IntRange(const self &RHS) :
193 Low(RHS.Low), High(RHS.High),
194 IsEmpty(RHS.IsEmpty), IsSingleNumber(RHS.IsSingleNumber) {}
195 IntRange(const IntType &C) :
196 Low(C), High(C), IsEmpty(false), IsSingleNumber(true) {}
198 IntRange(const IntType &L, const IntType &H) : Low(L), High(H),
199 IsEmpty(false), IsSingleNumber(Low == High) {}
201 bool isEmpty() const { return IsEmpty; }
202 bool isSingleNumber() const { return IsSingleNumber; }
204 const IntType& getLow() const {
205 assert(!IsEmpty && "Range is empty.");
208 const IntType& getHigh() const {
209 assert(!IsEmpty && "Range is empty.");
213 bool operator<(const self &RHS) const {
214 assert(!IsEmpty && "Left range is empty.");
215 assert(!RHS.IsEmpty && "Right range is empty.");
216 if (Low == RHS.Low) {
226 bool operator==(const self &RHS) const {
227 assert(!IsEmpty && "Left range is empty.");
228 assert(!RHS.IsEmpty && "Right range is empty.");
229 return Low == RHS.Low && High == RHS.High;
232 bool operator!=(const self &RHS) const {
233 return !operator ==(RHS);
236 static bool LessBySize(const self &LHS, const self &RHS) {
237 return (LHS.High - LHS.Low) < (RHS.High - RHS.Low);
240 bool isInRange(const IntType &IntVal) const {
241 assert(!IsEmpty && "Range is empty.");
242 return IntVal >= Low && IntVal <= High;
245 SubRes sub(const self &RHS) const {
248 // RHS is either more global and includes this range or
249 // if it doesn't intersected with this range.
250 if (!isInRange(RHS.Low) && !isInRange(RHS.High)) {
252 // If RHS more global (it is enough to check
253 // only one border in this case.
254 if (RHS.isInRange(Low))
255 return std::make_pair(self(Low, High), self());
262 IntType NewHigh = RHS.Low;
264 Res.first.High = NewHigh;
266 if (High > RHS.High) {
267 IntType NewLow = RHS.High;
269 Res.second.Low = NewLow;
270 Res.second.High = High;
276 //===----------------------------------------------------------------------===//
277 /// IntegersSubsetGeneric - class that implements the subset of integers. It
278 /// consists from ranges and single numbers.
279 template <class IntTy>
280 class IntegersSubsetGeneric {
282 // Use Chris Lattner idea, that was initially described here:
283 // http://lists.cs.uiuc.edu/pipermail/llvm-commits/Week-of-Mon-20120213/136954.html
284 // In short, for more compact memory consumption we can store flat
285 // numbers collection, and define range as pair of indices.
286 // In that case we can safe some memory on 32 bit machines.
287 typedef std::vector<IntTy> FlatCollectionTy;
288 typedef std::pair<IntTy*, IntTy*> RangeLinkTy;
289 typedef std::vector<RangeLinkTy> RangeLinksTy;
290 typedef typename RangeLinksTy::const_iterator RangeLinksConstIt;
292 typedef IntegersSubsetGeneric<IntTy> self;
296 FlatCollectionTy FlatCollection;
297 RangeLinksTy RangeLinks;
300 bool IsSingleNumbersOnly;
304 template<class RangesCollectionTy>
305 explicit IntegersSubsetGeneric(const RangesCollectionTy& Links) {
306 assert(Links.size() && "Empty ranges are not allowed.");
308 // In case of big set of single numbers consumes additional RAM space,
309 // but allows to avoid additional reallocation.
310 FlatCollection.reserve(Links.size() * 2);
311 RangeLinks.reserve(Links.size());
312 IsSingleNumbersOnly = true;
313 for (typename RangesCollectionTy::const_iterator i = Links.begin(),
314 e = Links.end(); i != e; ++i) {
315 RangeLinkTy RangeLink;
316 FlatCollection.push_back(i->getLow());
317 RangeLink.first = &FlatCollection.back();
318 if (i->getLow() != i->getHigh()) {
319 FlatCollection.push_back(i->getHigh());
320 IsSingleNumbersOnly = false;
322 RangeLink.second = &FlatCollection.back();
323 RangeLinks.push_back(RangeLink);
325 IsSingleNumber = IsSingleNumbersOnly && RangeLinks.size() == 1;
328 IntegersSubsetGeneric(const self& RHS) {
332 self& operator=(const self& RHS) {
333 FlatCollection.clear();
335 FlatCollection.reserve(RHS.RangeLinks.size() * 2);
336 RangeLinks.reserve(RHS.RangeLinks.size());
337 for (RangeLinksConstIt i = RHS.RangeLinks.begin(), e = RHS.RangeLinks.end();
339 RangeLinkTy RangeLink;
340 FlatCollection.push_back(*(i->first));
341 RangeLink.first = &FlatCollection.back();
342 if (i->first != i->second)
343 FlatCollection.push_back(*(i->second));
344 RangeLink.second = &FlatCollection.back();
345 RangeLinks.push_back(RangeLink);
347 IsSingleNumber = RHS.IsSingleNumber;
348 IsSingleNumbersOnly = RHS.IsSingleNumbersOnly;
352 typedef IntRange<IntTy> Range;
354 /// Checks is the given constant satisfies this case. Returns
355 /// true if it equals to one of contained values or belongs to the one of
356 /// contained ranges.
357 bool isSatisfies(const IntTy &CheckingVal) const {
359 return FlatCollection.front() == CheckingVal;
360 if (IsSingleNumbersOnly)
361 return std::find(FlatCollection.begin(),
362 FlatCollection.end(),
363 CheckingVal) != FlatCollection.end();
365 for (unsigned i = 0, e = getNumItems(); i < e; ++i) {
366 if (RangeLinks[i].first == RangeLinks[i].second) {
367 if (*RangeLinks[i].first == CheckingVal)
369 } else if (*RangeLinks[i].first <= CheckingVal &&
370 *RangeLinks[i].second >= CheckingVal)
376 /// Returns set's item with given index.
377 Range getItem(unsigned idx) const {
378 const RangeLinkTy &Link = RangeLinks[idx];
379 if (Link.first != Link.second)
380 return Range(*Link.first, *Link.second);
382 return Range(*Link.first);
385 /// Return number of items (ranges) stored in set.
386 unsigned getNumItems() const {
387 return RangeLinks.size();
390 /// Returns true if whole subset contains single element.
391 bool isSingleNumber() const {
392 return IsSingleNumber;
395 /// Returns true if whole subset contains only single numbers, no ranges.
396 bool isSingleNumbersOnly() const {
397 return IsSingleNumbersOnly;
400 /// Does the same like getItem(idx).isSingleNumber(), but
401 /// works faster, since we avoid creation of temporary range object.
402 bool isSingleNumber(unsigned idx) const {
403 return RangeLinks[idx].first == RangeLinks[idx].second;
406 /// Returns set the size, that equals number of all values + sizes of all
408 /// Ranges set is considered as flat numbers collection.
409 /// E.g.: for range [<0>, <1>, <4,8>] the size will 7;
410 /// for range [<0>, <1>, <5>] the size will 3
411 unsigned getSize() const {
412 APInt sz(((const APInt&)getItem(0).getLow()).getBitWidth(), 0);
413 for (unsigned i = 0, e = getNumItems(); i != e; ++i) {
414 const APInt &Low = getItem(i).getLow();
415 const APInt &High = getItem(i).getHigh();
416 APInt S = High - Low + 1;
419 return sz.getZExtValue();
422 /// Allows to access single value even if it belongs to some range.
423 /// Ranges set is considered as flat numbers collection.
424 /// [<1>, <4,8>] is considered as [1,4,5,6,7,8]
425 /// For range [<1>, <4,8>] getSingleValue(3) returns 6.
426 APInt getSingleValue(unsigned idx) const {
427 APInt sz(((const APInt&)getItem(0).getLow()).getBitWidth(), 0);
428 for (unsigned i = 0, e = getNumItems(); i != e; ++i) {
429 const APInt &Low = getItem(i).getLow();
430 const APInt &High = getItem(i).getHigh();
431 APInt S = High - Low + 1;
436 APInt Offset(oldSz.getBitWidth(), idx);
442 assert(0 && "Index exceeds high border.");
446 /// Does the same as getSingleValue, but works only if subset contains
447 /// single numbers only.
448 const IntTy& getSingleNumber(unsigned idx) const {
449 assert(IsSingleNumbersOnly && "This method works properly if subset "
450 "contains single numbers only.");
451 return FlatCollection[idx];
455 //===----------------------------------------------------------------------===//
456 /// IntegersSubset - currently is extension of IntegersSubsetGeneric
457 /// that also supports conversion to/from Constant* object.
458 class IntegersSubset : public IntegersSubsetGeneric<IntItem> {
460 typedef IntegersSubsetGeneric<IntItem> ParentTy;
464 static unsigned getNumItemsFromConstant(Constant *C) {
465 return cast<ArrayType>(C->getType())->getNumElements();
468 static Range getItemFromConstant(Constant *C, unsigned idx) {
469 const Constant *CV = C->getAggregateElement(idx);
471 unsigned NumEls = cast<VectorType>(CV->getType())->getNumElements();
474 return Range(IntItem::fromConstantInt(
475 cast<ConstantInt>(CV->getAggregateElement(0U))),
476 IntItem::fromConstantInt(cast<ConstantInt>(
477 cast<ConstantInt>(CV->getAggregateElement(0U)))));
479 return Range(IntItem::fromConstantInt(
480 cast<ConstantInt>(CV->getAggregateElement(0U))),
481 IntItem::fromConstantInt(
482 cast<ConstantInt>(CV->getAggregateElement(1))));
484 assert(0 && "Only pairs and single numbers are allowed here.");
489 std::vector<Range> rangesFromConstant(Constant *C) {
490 unsigned NumItems = getNumItemsFromConstant(C);
491 std::vector<Range> r;
493 for (unsigned i = 0, e = NumItems; i != e; ++i)
494 r.push_back(getItemFromConstant(C, i));
500 explicit IntegersSubset(Constant *C) : ParentTy(rangesFromConstant(C)),
503 template<class RangesCollectionTy>
504 explicit IntegersSubset(const RangesCollectionTy& Src) : ParentTy(Src) {
505 std::vector<Constant*> Elts;
506 Elts.reserve(Src.size());
507 for (typename RangesCollectionTy::const_iterator i = Src.begin(),
508 e = Src.end(); i != e; ++i) {
510 std::vector<Constant*> r;
511 if (R.isSingleNumber()) {
513 // FIXME: Since currently we have ConstantInt based numbers
514 // use hack-conversion of IntItem to ConstantInt
515 r.push_back(R.getLow().toConstantInt());
516 r.push_back(R.getHigh().toConstantInt());
519 r.push_back(R.getLow().toConstantInt());
521 Constant *CV = ConstantVector::get(r);
525 ArrayType::get(Elts.front()->getType(), (uint64_t)Elts.size());
526 Holder = ConstantArray::get(ArrTy, Elts);
529 operator Constant*() { return Holder; }
530 operator const Constant*() const { return Holder; }
531 Constant *operator->() { return Holder; }
532 const Constant *operator->() const { return Holder; }
537 #endif /* CONSTANTRANGESSET_H_ */