include/llvm/Transforms/MutateStructTypes.h

   1 //===- llvm/Transforms/MutateStructTypes.h - Change struct defns -*- C++ -*--=//
   2 //
   3 // This pass is used to change structure accesses and type definitions in some
   4 // way.  It can be used to arbitrarily permute structure fields, safely, without
   5 // breaking code.  A transformation may only be done on a type if that type has
   6 // been found to be "safe" by the 'FindUnsafePointerTypes' pass.  This pass will
   7 // assert and die if you try to do an illegal transformation.
   8 //
   9 // This is an interprocedural pass that requires the entire program to do a
  10 // transformation.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_TRANSFORMS_MUTATESTRUCTTYPES_H
  15 #define LLVM_TRANSFORMS_MUTATESTRUCTTYPES_H
  16
  17 #include "llvm/Pass.h"
  18 #include <map>
  19
  20 class StructType;
  21 class CompositeType;
  22 class GlobalValue;
  23
  24 class MutateStructTypes : public Pass {
  25   // TransformType - Representation of the destination type for a particular
  26   // incoming structure.  The first member is the destination type that we are
  27   // mapping to, and the second member is the destination slot # to put each
  28   // incoming slot [or negative if the specified incoming slot should be
  29   // removed].
  30   //
  31   typedef std::pair<const StructType*, std::vector<int> > TransformType;
  32
  33   // Transforms to do for each structure type...
  34   std::map<const StructType*, TransformType> Transforms;
  35
  36   // Mapping of old type to new types...
  37   std::map<const Type *, PATypeHolder<Type> > TypeMap;
  38
  39   // Mapping from global value of old type, to a global value of the new type...
  40   std::map<const GlobalValue*, GlobalValue*> GlobalMap;
  41
  42   // Mapping from intra method value to intra method value
  43   std::map<const Value*, Value*> LocalValueMap;
  44
  45 public:
  46   // Ctor - Take a map that specifies what transformation to do for each field
  47   // of the specified structure types.  There is one element of the vector for
  48   // each field of the structure.  The value specified indicates which slot of
  49   // the destination structure the field should end up in.  A negative value
  50   // indicates that the field should be deleted entirely.
  51   //
  52   typedef std::map<const StructType*, std::vector<int> > TransformsType;
  53
  54   MutateStructTypes(const TransformsType &Transforms);
  55
  56
  57   // doPassInitialization - This loops over global constants defined in the
  58   // module, converting them to their new type.  Also this creates placeholder
  59   // methods for methods than need to be copied because they have a new
  60   // signature type.
  61   //
  62   bool doPassInitialization(Module *M);
  63
  64   // doPerMethodWork - This transforms the instructions of the method to use the
  65   // new types.
  66   //
  67   bool doPerMethodWork(Method *M);
  68
  69   // doPassFinalization - This removes the old versions of methods that are no
  70   // longer needed.
  71   //
  72   virtual bool doPassFinalization(Module *M);
  73
  74 private:
  75   // ConvertType - Convert from the old type system to the new one...
  76   const Type *ConvertType(const Type *Ty);
  77
  78   // ConvertValue - Convert from the old value in the old type system to the new
  79   // type system.
  80   //
  81   Value *ConvertValue(const Value *V);
  82
  83   // AdjustIndices - Convert the indexes specifed by Idx to the new changed form
  84   // using the specified OldTy as the base type being indexed into.
  85   //
  86   void AdjustIndices(const CompositeType *OldTy, std::vector<Value*> &Idx,
  87                      unsigned idx = 0);
  88 };
  89
  90 #endif