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   UseListShuffleVector(const UseListShuffleVector &X) LLVM_DELETED_FUNCTION;
  55   UseListShuffleVector &
  56   operator=(const UseListShuffleVector &X) LLVM_DELETED_FUNCTION;
  57   UseListShuffleVector &
  58   operator=(UseListShuffleVector &&X) LLVM_DELETED_FUNCTION;
  59
  60 public:
  61   UseListShuffleVector() : Size(0) {}
  62   UseListShuffleVector(UseListShuffleVector &&X) { moveUnchecked(X); }
  63   explicit UseListShuffleVector(size_t Size) : Size(Size) {
  64     if (!isSmall())
  65       Storage.Ptr = new unsigned[Size];
  66   }
  67   ~UseListShuffleVector() { destroy(); }
  68
  69   typedef unsigned *iterator;
  70   typedef const unsigned *const_iterator;
  71
  72   size_t size() const { return Size; }
  73   iterator begin() { return data(); }
  74   iterator end() { return begin() + size(); }
  75   const_iterator begin() const { return data(); }
  76   const_iterator end() const { return begin() + size(); }
  77   unsigned &operator[](size_t I) { return data()[I]; }
  78   unsigned operator[](size_t I) const { return data()[I]; }
  79 };
  80
  81 /// \brief Structure to hold a use-list order.
  82 struct UseListOrder {
  83   const Value *V;
  84   const Function *F;
  85   UseListShuffleVector Shuffle;
  86
  87   UseListOrder(const Value *V, const Function *F, size_t ShuffleSize)
  88       : V(V), F(F), Shuffle(ShuffleSize) {}
  89
  90   UseListOrder() : V(0), F(0) {}
  91   UseListOrder(UseListOrder &&X)
  92       : V(X.V), F(X.F), Shuffle(std::move(X.Shuffle)) {}
  93
  94 private:
  95   UseListOrder(const UseListOrder &X) LLVM_DELETED_FUNCTION;
  96   UseListOrder &operator=(const UseListOrder &X) LLVM_DELETED_FUNCTION;
  97   UseListOrder &operator=(UseListOrder &&X) LLVM_DELETED_FUNCTION;
  98 };
  99
 100 typedef std::vector<UseListOrder> UseListOrderStack;
 101
 102 /// \brief Whether to preserve use-list ordering.
 103 bool shouldPreserveBitcodeUseListOrder();
 104 bool shouldPreserveAssemblyUseListOrder();
 105
 106 /// \brief Shuffle all use-lists in a module.
 107 ///
 108 /// Adds \c SeedOffset to the default seed for the random number generator.
 109 void shuffleUseLists(Module &M, unsigned SeedOffset = 0);
 110
 111 } // end namespace llvm
 112
 113 #endif