include/llvm/Support/IntegersSubset.h

   1 //===-- llvm/IntegersSubset.h - The subset of integers ----------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 /// @file
  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.
  15 //
  16 //===----------------------------------------------------------------------===//
  17
  18 #ifndef CONSTANTRANGESSET_H_
  19 #define CONSTANTRANGESSET_H_
  20
  21 #include <list>
  22
  23 #include "llvm/Constants.h"
  24 #include "llvm/DerivedTypes.h"
  25 #include "llvm/LLVMContext.h"
  26
  27 namespace llvm {
  28
  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
  32   //    constructions.
  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.
  38
  39   // The set of macros that allows to propagate APInt operators to the IntItem.
  40
  41 #define INT_ITEM_DEFINE_COMPARISON(op,func) \
  42   bool operator op (const APInt& RHS) const { \
  43     return getAPIntValue().func(RHS); \
  44   }
  45
  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)); \
  51   }
  52
  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)); \
  58   }
  59
  60 #define INT_ITEM_DEFINE_ASSIGNMENT_BY_OP(op) \
  61   IntItem& operator op (const APInt& RHS) {\
  62     APInt res = getAPIntValue();\
  63     res op RHS; \
  64     Constant *NewVal = ConstantInt::get(ConstantIntVal->getContext(), res); \
  65     ConstantIntVal = cast<ConstantInt>(NewVal); \
  66     return *this; \
  67   }
  68
  69 #define INT_ITEM_DEFINE_PREINCDEC(op) \
  70     IntItem& operator op () { \
  71       APInt res = getAPIntValue(); \
  72       op(res); \
  73       Constant *NewVal = ConstantInt::get(ConstantIntVal->getContext(), res); \
  74       ConstantIntVal = cast<ConstantInt>(NewVal); \
  75       return *this; \
  76     }
  77
  78 #define INT_ITEM_DEFINE_POSTINCDEC(op) \
  79     IntItem& operator op (int) { \
  80       APInt res = getAPIntValue();\
  81       op(res); \
  82       Constant *NewVal = ConstantInt::get(ConstantIntVal->getContext(), res); \
  83       OldConstantIntVal = ConstantIntVal; \
  84       ConstantIntVal = cast<ConstantInt>(NewVal); \
  85       return IntItem(OldConstantIntVal); \
  86     }
  87
  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); \
  91   }
  92
  93 class IntItem {
  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 {
 100     return *APIntVal;
 101   }
 102 public:
 103
 104   IntItem() {}
 105
 106   operator const APInt&() const {
 107     return getAPIntValue();
 108   }
 109
 110   // Propagate APInt operators.
 111   // Note, that
 112   // /,/=,>>,>>= are not implemented in APInt.
 113   // <<= is implemented for unsigned RHS, but not implemented for APInt RHS.
 114
 115   INT_ITEM_DEFINE_COMPARISON(<, ult)
 116   INT_ITEM_DEFINE_COMPARISON(>, ugt)
 117   INT_ITEM_DEFINE_COMPARISON(<=, ule)
 118   INT_ITEM_DEFINE_COMPARISON(>=, uge)
 119
 120   INT_ITEM_DEFINE_COMPARISON(==, eq)
 121   INT_ITEM_DEFINE_OP_STANDARD_INT(bool,==,uint64_t)
 122
 123   INT_ITEM_DEFINE_COMPARISON(!=, ne)
 124   INT_ITEM_DEFINE_OP_STANDARD_INT(bool,!=,uint64_t)
 125
 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(|)
 136
 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(|=)
 143
 144   // Special case for <<=
 145   IntItem& operator <<= (unsigned RHS) {
 146     APInt res = getAPIntValue();
 147     res <<= RHS;
 148     Constant *NewVal = ConstantInt::get(ConstantIntVal->getContext(), res);
 149     ConstantIntVal = cast<ConstantInt>(NewVal);
 150     return *this;
 151   }
 152
 153   INT_ITEM_DEFINE_UNARY_OP(-)
 154   INT_ITEM_DEFINE_UNARY_OP(~)
 155
 156   INT_ITEM_DEFINE_PREINCDEC(++)
 157   INT_ITEM_DEFINE_PREINCDEC(--)
 158
 159   // The set of workarounds, since currently we use ConstantInt implemented
 160   // integer.
 161
 162   static IntItem fromConstantInt(const ConstantInt *V) {
 163     return IntItem(V);
 164   }
 165   static IntItem fromType(Type* Ty, const APInt& V) {
 166     ConstantInt *C = cast<ConstantInt>(ConstantInt::get(Ty, V));
 167     return fromConstantInt(C);
 168   }
 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);
 173   }
 174   ConstantInt *toConstantInt() const {
 175     return ConstantIntVal;
 176   }
 177 };
 178
 179 template<class IntType>
 180 class IntRange {
 181 protected:
 182     IntType Low;
 183     IntType High;
 184     bool IsEmpty : 1;
 185     enum Type {
 186       SINGLE_NUMBER,
 187       RANGE,
 188       UNKNOWN
 189     };
 190     Type RangeType;
 191
 192 public:
 193     typedef IntRange<IntType> self;
 194     typedef std::pair<self, self> SubRes;
 195
 196     IntRange() : IsEmpty(true) {}
 197     IntRange(const self &RHS) :
 198       Low(RHS.Low), High(RHS.High),
 199       IsEmpty(RHS.IsEmpty), RangeType(RHS.RangeType) {}
 200     IntRange(const IntType &C) :
 201       Low(C), High(C), IsEmpty(false), RangeType(SINGLE_NUMBER) {}
 202
 203     IntRange(const IntType &L, const IntType &H) : Low(L), High(H),
 204       IsEmpty(false), RangeType(UNKNOWN) {}
 205
 206     bool isEmpty() const { return IsEmpty; }
 207     bool isSingleNumber() const {
 208       switch (RangeType) {
 209       case SINGLE_NUMBER:
 210         return true;
 211       case RANGE:
 212         return false;
 213       default: // UNKNOWN
 214         if (Low == High) {
 215           const_cast<Type&>(RangeType) = SINGLE_NUMBER;
 216           return true;
 217         }
 218         const_cast<Type&>(RangeType) = RANGE;
 219         return false;
 220       }
 221     }
 222
 223     const IntType& getLow() const {
 224       assert(!IsEmpty && "Range is empty.");
 225       return Low;
 226     }
 227     const IntType& getHigh() const {
 228       assert(!IsEmpty && "Range is empty.");
 229       return High;
 230     }
 231
 232     bool operator<(const self &RHS) const {
 233       assert(!IsEmpty && "Left range is empty.");
 234       assert(!RHS.IsEmpty && "Right range is empty.");
 235       if (Low < RHS.Low)
 236         return true;
 237       if (Low == RHS.Low) {
 238         if (High > RHS.High)
 239           return true;
 240         return false;
 241       }
 242       return false;
 243     }
 244
 245     bool operator==(const self &RHS) const {
 246       assert(!IsEmpty && "Left range is empty.");
 247       assert(!RHS.IsEmpty && "Right range is empty.");
 248       return Low == RHS.Low && High == RHS.High;
 249     }
 250
 251     bool operator!=(const self &RHS) const {
 252       return !operator ==(RHS);
 253     }
 254
 255     static bool LessBySize(const self &LHS, const self &RHS) {
 256       return (LHS.High - LHS.Low) < (RHS.High - RHS.Low);
 257     }
 258
 259     bool isInRange(const IntType &IntVal) const {
 260       assert(!IsEmpty && "Range is empty.");
 261       return IntVal >= Low && IntVal <= High;
 262     }
 263
 264     SubRes sub(const self &RHS) const {
 265       SubRes Res;
 266
 267       // RHS is either more global and includes this range or
 268       // if it doesn't intersected with this range.
 269       if (!isInRange(RHS.Low) && !isInRange(RHS.High)) {
 270
 271         // If RHS more global (it is enough to check
 272         // only one border in this case.
 273         if (RHS.isInRange(Low))
 274           return std::make_pair(self(Low, High), self());
 275
 276         return Res;
 277       }
 278
 279       if (Low < RHS.Low) {
 280         Res.first.Low = Low;
 281         IntType NewHigh = RHS.Low;
 282         --NewHigh;
 283         Res.first.High = NewHigh;
 284       }
 285       if (High > RHS.High) {
 286         IntType NewLow = RHS.High;
 287         ++NewLow;
 288         Res.second.Low = NewLow;
 289         Res.second.High = High;
 290       }
 291       return Res;
 292     }
 293   };
 294
 295 //===----------------------------------------------------------------------===//
 296 /// IntegersSubsetGeneric - class that implements the subset of integers. It
 297 /// consists from ranges and single numbers.
 298 template <class IntTy>
 299 class IntegersSubsetGeneric {
 300 public:
 301   // Use Chris Lattner idea, that was initially described here:
 302   // http://lists.cs.uiuc.edu/pipermail/llvm-commits/Week-of-Mon-20120213/136954.html
 303   // In short, for more compact memory consumption we can store flat
 304   // numbers collection, and define range as pair of indices.
 305   // In that case we can safe some memory on 32 bit machines.
 306   typedef std::vector<IntTy> FlatCollectionTy;
 307   typedef std::pair<IntTy*, IntTy*> RangeLinkTy;
 308   typedef std::vector<RangeLinkTy> RangeLinksTy;
 309   typedef typename RangeLinksTy::const_iterator RangeLinksConstIt;
 310
 311   typedef IntegersSubsetGeneric<IntTy> self;
 312
 313 protected:
 314
 315   FlatCollectionTy FlatCollection;
 316   RangeLinksTy RangeLinks;
 317
 318   bool IsSingleNumber;
 319   bool IsSingleNumbersOnly;
 320
 321 public:
 322
 323   template<class RangesCollectionTy>
 324   explicit IntegersSubsetGeneric(const RangesCollectionTy& Links) {
 325     assert(Links.size() && "Empty ranges are not allowed.");
 326
 327     // In case of big set of single numbers consumes additional RAM space,
 328     // but allows to avoid additional reallocation.
 329     FlatCollection.reserve(Links.size() * 2);
 330     RangeLinks.reserve(Links.size());
 331     IsSingleNumbersOnly = true;
 332     for (typename RangesCollectionTy::const_iterator i = Links.begin(),
 333          e = Links.end(); i != e; ++i) {
 334       RangeLinkTy RangeLink;
 335       FlatCollection.push_back(i->getLow());
 336       RangeLink.first = &FlatCollection.back();
 337       if (i->getLow() != i->getHigh()) {
 338         FlatCollection.push_back(i->getHigh());
 339         IsSingleNumbersOnly = false;
 340       }
 341       RangeLink.second = &FlatCollection.back();
 342       RangeLinks.push_back(RangeLink);
 343     }
 344     IsSingleNumber = IsSingleNumbersOnly && RangeLinks.size() == 1;
 345   }
 346
 347   IntegersSubsetGeneric(const self& RHS) {
 348     *this = RHS;
 349   }
 350
 351   self& operator=(const self& RHS) {
 352     FlatCollection.clear();
 353     RangeLinks.clear();
 354     FlatCollection.reserve(RHS.RangeLinks.size() * 2);
 355     RangeLinks.reserve(RHS.RangeLinks.size());
 356     for (RangeLinksConstIt i = RHS.RangeLinks.begin(), e = RHS.RangeLinks.end();
 357          i != e; ++i) {
 358       RangeLinkTy RangeLink;
 359       FlatCollection.push_back(*(i->first));
 360       RangeLink.first = &FlatCollection.back();
 361       if (i->first != i->second)
 362         FlatCollection.push_back(*(i->second));
 363       RangeLink.second = &FlatCollection.back();
 364       RangeLinks.push_back(RangeLink);
 365     }
 366     IsSingleNumber = RHS.IsSingleNumber;
 367     IsSingleNumbersOnly = RHS.IsSingleNumbersOnly;
 368     return *this;
 369   }
 370
 371   typedef IntRange<IntTy> Range;
 372
 373   /// Checks is the given constant satisfies this case. Returns
 374   /// true if it equals to one of contained values or belongs to the one of
 375   /// contained ranges.
 376   bool isSatisfies(const IntTy &CheckingVal) const {
 377     if (IsSingleNumber)
 378       return FlatCollection.front() == CheckingVal;
 379     if (IsSingleNumbersOnly)
 380       return std::find(FlatCollection.begin(),
 381                        FlatCollection.end(),
 382                        CheckingVal) != FlatCollection.end();
 383
 384     for (unsigned i = 0, e = getNumItems(); i < e; ++i) {
 385       if (RangeLinks[i].first == RangeLinks[i].second) {
 386         if (*RangeLinks[i].first == CheckingVal)
 387           return true;
 388       } else if (*RangeLinks[i].first <= CheckingVal &&
 389                  *RangeLinks[i].second >= CheckingVal)
 390         return true;
 391     }
 392     return false;
 393   }
 394
 395   /// Returns set's item with given index.
 396   Range getItem(unsigned idx) const {
 397     const RangeLinkTy &Link = RangeLinks[idx];
 398     if (Link.first != Link.second)
 399       return Range(*Link.first, *Link.second);
 400     else
 401       return Range(*Link.first);
 402   }
 403
 404   /// Return number of items (ranges) stored in set.
 405   unsigned getNumItems() const {
 406     return RangeLinks.size();
 407   }
 408
 409   /// Returns true if whole subset contains single element.
 410   bool isSingleNumber() const {
 411     return IsSingleNumber;
 412   }
 413
 414   /// Returns true if whole subset contains only single numbers, no ranges.
 415   bool isSingleNumbersOnly() const {
 416     return IsSingleNumbersOnly;
 417   }
 418
 419   /// Does the same like getItem(idx).isSingleNumber(), but
 420   /// works faster, since we avoid creation of temporary range object.
 421   bool isSingleNumber(unsigned idx) const {
 422     return RangeLinks[idx].first == RangeLinks[idx].second;
 423   }
 424
 425   /// Returns set the size, that equals number of all values + sizes of all
 426   /// ranges.
 427   /// Ranges set is considered as flat numbers collection.
 428   /// E.g.: for range [<0>, <1>, <4,8>] the size will 7;
 429   ///       for range [<0>, <1>, <5>] the size will 3
 430   unsigned getSize() const {
 431     APInt sz(((const APInt&)getItem(0).getLow()).getBitWidth(), 0);
 432     for (unsigned i = 0, e = getNumItems(); i != e; ++i) {
 433       const APInt &Low = getItem(i).getLow();
 434       const APInt &High = getItem(i).getHigh();
 435       APInt S = High - Low + 1;
 436       sz += S;
 437     }
 438     return sz.getZExtValue();
 439   }
 440
 441   /// Allows to access single value even if it belongs to some range.
 442   /// Ranges set is considered as flat numbers collection.
 443   /// [<1>, <4,8>] is considered as [1,4,5,6,7,8]
 444   /// For range [<1>, <4,8>] getSingleValue(3) returns 6.
 445   APInt getSingleValue(unsigned idx) const {
 446     APInt sz(((const APInt&)getItem(0).getLow()).getBitWidth(), 0);
 447     for (unsigned i = 0, e = getNumItems(); i != e; ++i) {
 448       const APInt &Low = getItem(i).getLow();
 449       const APInt &High = getItem(i).getHigh();
 450       APInt S = High - Low + 1;
 451       APInt oldSz = sz;
 452       sz += S;
 453       if (sz.ugt(idx)) {
 454         APInt Res = Low;
 455         APInt Offset(oldSz.getBitWidth(), idx);
 456         Offset -= oldSz;
 457         Res += Offset;
 458         return Res;
 459       }
 460     }
 461     assert(0 && "Index exceeds high border.");
 462     return sz;
 463   }
 464
 465   /// Does the same as getSingleValue, but works only if subset contains
 466   /// single numbers only.
 467   const IntTy& getSingleNumber(unsigned idx) const {
 468     assert(IsSingleNumbersOnly && "This method works properly if subset "
 469                                   "contains single numbers only.");
 470     return FlatCollection[idx];
 471   }
 472 };
 473
 474 //===----------------------------------------------------------------------===//
 475 /// IntegersSubset - currently is extension of IntegersSubsetGeneric
 476 /// that also supports conversion to/from Constant* object.
 477 class IntegersSubset : public IntegersSubsetGeneric<IntItem> {
 478
 479   typedef IntegersSubsetGeneric<IntItem> ParentTy;
 480
 481   Constant *Holder;
 482
 483   static unsigned getNumItemsFromConstant(Constant *C) {
 484     return cast<ArrayType>(C->getType())->getNumElements();
 485   }
 486
 487   static Range getItemFromConstant(Constant *C, unsigned idx) {
 488     const Constant *CV = C->getAggregateElement(idx);
 489
 490     unsigned NumEls = cast<VectorType>(CV->getType())->getNumElements();
 491     switch (NumEls) {
 492     case 1:
 493       return Range(IntItem::fromConstantInt(
 494                      cast<ConstantInt>(CV->getAggregateElement(0U))),
 495                    IntItem::fromConstantInt(cast<ConstantInt>(
 496                      cast<ConstantInt>(CV->getAggregateElement(0U)))));
 497     case 2:
 498       return Range(IntItem::fromConstantInt(
 499                      cast<ConstantInt>(CV->getAggregateElement(0U))),
 500                    IntItem::fromConstantInt(
 501                    cast<ConstantInt>(CV->getAggregateElement(1))));
 502     default:
 503       assert(0 && "Only pairs and single numbers are allowed here.");
 504       return Range();
 505     }
 506   }
 507
 508   std::vector<Range> rangesFromConstant(Constant *C) {
 509     unsigned NumItems = getNumItemsFromConstant(C);
 510     std::vector<Range> r;
 511     r.reserve(NumItems);
 512     for (unsigned i = 0, e = NumItems; i != e; ++i)
 513       r.push_back(getItemFromConstant(C, i));
 514     return r;
 515   }
 516
 517 public:
 518
 519   explicit IntegersSubset(Constant *C) : ParentTy(rangesFromConstant(C)),
 520                           Holder(C) {}
 521
 522   IntegersSubset(const IntegersSubset& RHS) :
 523     ParentTy(*(const ParentTy *)&RHS), // FIXME: tweak for msvc.
 524     Holder(RHS.Holder) {}
 525
 526   template<class RangesCollectionTy>
 527   explicit IntegersSubset(const RangesCollectionTy& Src) : ParentTy(Src) {
 528     std::vector<Constant*> Elts;
 529     Elts.reserve(Src.size());
 530     for (typename RangesCollectionTy::const_iterator i = Src.begin(),
 531          e = Src.end(); i != e; ++i) {
 532       const Range &R = *i;
 533       std::vector<Constant*> r;
 534       if (!R.isSingleNumber()) {
 535         r.reserve(2);
 536         // FIXME: Since currently we have ConstantInt based numbers
 537         // use hack-conversion of IntItem to ConstantInt
 538         r.push_back(R.getLow().toConstantInt());
 539         r.push_back(R.getHigh().toConstantInt());
 540       } else {
 541         r.reserve(1);
 542         r.push_back(R.getLow().toConstantInt());
 543       }
 544       Constant *CV = ConstantVector::get(r);
 545       Elts.push_back(CV);
 546     }
 547     ArrayType *ArrTy =
 548         ArrayType::get(Elts.front()->getType(), (uint64_t)Elts.size());
 549     Holder = ConstantArray::get(ArrTy, Elts);
 550   }
 551
 552   operator Constant*() { return Holder; }
 553   operator const Constant*() const { return Holder; }
 554   Constant *operator->() { return Holder; }
 555   const Constant *operator->() const { return Holder; }
 556 };
 557
 558 }
 559
 560 #endif /* CONSTANTRANGESSET_H_ */