include/llvm/Analysis/SlotCalculator.h

   1 //===-- Analysis/SlotCalculator.h - Calculate value slots -------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This class calculates the slots that values will land in.  This is useful for
  11 // when writing bytecode or assembly out, because you have to know these things.
  12 //
  13 // Specifically, this class calculates the "type plane numbering" that you see
  14 // for a function if you strip out all of the symbols in it.  For assembly
  15 // writing, this is used when a symbol does not have a name.  For bytecode
  16 // writing, this is always used, and the symbol table is added on later.
  17 //
  18 //===----------------------------------------------------------------------===//
  19
  20 #ifndef LLVM_ANALYSIS_SLOTCALCULATOR_H
  21 #define LLVM_ANALYSIS_SLOTCALCULATOR_H
  22
  23 #include <vector>
  24 #include <map>
  25
  26 namespace llvm {
  27
  28 class Value;
  29 class Module;
  30 class Function;
  31 class SymbolTable;
  32 class ConstantArray;
  33
  34 class SlotCalculator {
  35   const Module *TheModule;
  36
  37   typedef std::vector<const Value*> TypePlane;
  38   std::vector<TypePlane> Table;
  39   std::map<const Value*, unsigned> NodeMap;
  40
  41   /// ConstantStrings - If we are indexing for a bytecode file, this keeps track
  42   /// of all of the constants strings that need to be emitted.
  43   std::vector<const ConstantArray*> ConstantStrings;
  44
  45   /// ModuleLevel - Used to keep track of which values belong to the module,
  46   /// and which values belong to the currently incorporated function.
  47   ///
  48   std::vector<unsigned> ModuleLevel;
  49
  50   /// ModuleContainsAllFunctionConstants - This flag is set to true if all
  51   /// function constants are incorporated into the module constant table.  This
  52   /// is only possible if building information for a bytecode file.
  53   bool ModuleContainsAllFunctionConstants;
  54
  55   /// CompactionTable/NodeMap - When function compaction has been performed,
  56   /// these entries provide a compacted view of the namespace needed to emit
  57   /// instructions in a function body.  The 'getSlot()' method automatically
  58   /// returns these entries if applicable, or the global entries if not.
  59   std::vector<TypePlane> CompactionTable;
  60   std::map<const Value*, unsigned> CompactionNodeMap;
  61
  62   SlotCalculator(const SlotCalculator &);  // DO NOT IMPLEMENT
  63   void operator=(const SlotCalculator &);  // DO NOT IMPLEMENT
  64 public:
  65   SlotCalculator(const Module *M);
  66   // Start out in incorp state
  67   SlotCalculator(const Function *F);
  68
  69   /// getSlot - Return the slot number of the specified value in it's type
  70   /// plane.  This returns < 0 on error!
  71   ///
  72   int getSlot(const Value *V) const;
  73
  74   /// getGlobalSlot - Return a slot number from the global table.  This can only
  75   /// be used when a compaction table is active.
  76   unsigned getGlobalSlot(const Value *V) const;
  77
  78   inline unsigned getNumPlanes() const {
  79     if (CompactionTable.empty())
  80       return Table.size();
  81     else
  82       return CompactionTable.size();
  83   }
  84   inline unsigned getModuleLevel(unsigned Plane) const {
  85     return Plane < ModuleLevel.size() ? ModuleLevel[Plane] : 0;
  86   }
  87
  88   TypePlane &getPlane(unsigned Plane);
  89
  90   /// incorporateFunction/purgeFunction - If you'd like to deal with a function,
  91   /// use these two methods to get its data into the SlotCalculator!
  92   ///
  93   void incorporateFunction(const Function *F);
  94   void purgeFunction();
  95
  96   /// string_iterator/string_begin/end - Access the list of module-level
  97   /// constant strings that have been incorporated.  This is only applicable to
  98   /// bytecode files.
  99   typedef std::vector<const ConstantArray*>::const_iterator string_iterator;
 100   string_iterator string_begin() const { return ConstantStrings.begin(); }
 101   string_iterator string_end() const   { return ConstantStrings.end(); }
 102
 103   const std::vector<TypePlane> &getCompactionTable() const {
 104     return CompactionTable;
 105   }
 106
 107 private:
 108   // getOrCreateSlot - Values can be crammed into here at will... if
 109   // they haven't been inserted already, they get inserted, otherwise
 110   // they are ignored.
 111   //
 112   int getOrCreateSlot(const Value *D);
 113
 114   // insertValue - Insert a value into the value table... Return the
 115   // slot that it occupies, or -1 if the declaration is to be ignored
 116   // because of the IgnoreNamedNodes flag.
 117   //
 118   int insertValue(const Value *D, bool dontIgnore = false);
 119
 120   // doInsertValue - Small helper function to be called only be insertVal.
 121   int doInsertValue(const Value *D);
 122
 123   // processModule - Process all of the module level function declarations and
 124   // types that are available.
 125   //
 126   void processModule();
 127
 128   // processSymbolTable - Insert all of the values in the specified symbol table
 129   // into the values table...
 130   //
 131   void processSymbolTable(const SymbolTable *ST);
 132   void processSymbolTableConstants(const SymbolTable *ST);
 133
 134   void buildCompactionTable(const Function *F);
 135   unsigned getOrCreateCompactionTableSlot(const Value *V);
 136   void pruneCompactionTable();
 137 };
 138
 139 } // End llvm namespace
 140
 141 #endif