include/llvm/IR/UseListOrder.h

   1 //===- llvm/IR/UseListOrder.h - LLVM Use List Order functions ---*- 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 // This file has functions to modify the use-list order and to verify that it
  11 // doesn't change after serialization.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_IR_USELISTORDER_H
  16 #define LLVM_IR_USELISTORDER_H
  17
  18 #include "llvm/ADT/ArrayRef.h"
  19 #include "llvm/ADT/SmallVector.h"
  20 #include <vector>
  21
  22 namespace llvm {
  23
  24 class Module;
  25 class Function;
  26 class Value;
  27
  28 /// \brief Structure to hold a use-list shuffle vector.
  29 ///
  30 /// Stores most use-lists locally, but large use-lists use an extra heap entry.
  31 /// Costs two fewer pointers than the equivalent \a SmallVector.
  32 class UseListShuffleVector {
  33   unsigned Size;
  34   union {
  35     unsigned *Ptr;
  36     unsigned Array[6];
  37   } Storage;
  38
  39   bool isSmall() const { return Size <= 6; }
  40   unsigned *data() { return isSmall() ? Storage.Array : Storage.Ptr; }
  41   const unsigned *data() const {
  42     return isSmall() ? Storage.Array : Storage.Ptr;
  43   }
  44
  45   void destroy() {
  46     if (!isSmall())
  47       delete[] Storage.Ptr;
  48   }
  49   void moveUnchecked(UseListShuffleVector &X) {
  50     std::memcpy(this, &X, sizeof(UseListShuffleVector));
  51     X.Size = 0;
  52   }
  53
  54 public:
  55   UseListShuffleVector() : Size(0) {}
  56   UseListShuffleVector(UseListShuffleVector &&X) { moveUnchecked(X); }
  57   UseListShuffleVector(const UseListShuffleVector &X) {
  58     std::memcpy(this, &X, sizeof(UseListShuffleVector));
  59     if (!isSmall()) {
  60       Storage.Ptr = new unsigned[Size];
  61       std::memcpy(Storage.Ptr, X.Storage.Ptr, Size * sizeof(*Storage.Ptr));
  62     }
  63   }
  64   explicit UseListShuffleVector(size_t Size) : Size(Size) {
  65     if (!isSmall())
  66       Storage.Ptr = new unsigned[Size];
  67   }
  68   ~UseListShuffleVector() { destroy(); }
  69
  70   typedef unsigned *iterator;
  71   typedef const unsigned *const_iterator;
  72
  73   size_t size() const { return Size; }
  74   iterator begin() { return data(); }
  75   iterator end() { return begin() + size(); }
  76   const_iterator begin() const { return data(); }
  77   const_iterator end() const { return begin() + size(); }
  78   unsigned &operator[](size_t I) { return data()[I]; }
  79   unsigned operator[](size_t I) const { return data()[I]; }
  80 };
  81
  82 /// \brief Structure to hold a use-list order.
  83 struct UseListOrder {
  84   const Value *V;
  85   const Function *F;
  86   UseListShuffleVector Shuffle;
  87
  88   UseListOrder(const Value *V, const Function *F, size_t ShuffleSize)
  89       : V(V), F(F), Shuffle(ShuffleSize) {}
  90 };
  91
  92 typedef std::vector<UseListOrder> UseListOrderStack;
  93
  94 /// \brief Whether to preserve use-list ordering.
  95 bool shouldPreserveBitcodeUseListOrder();
  96 bool shouldPreserveAssemblyUseListOrder();
  97
  98 /// \brief Shuffle all use-lists in a module.
  99 ///
 100 /// Adds \c SeedOffset to the default seed for the random number generator.
 101 void shuffleUseLists(Module &M, unsigned SeedOffset = 0);
 102
 103 } // end namespace llvm
 104
 105 #endif