lib/Bytecode/Writer/SlotCalculator.h

   1 //===-- llvm/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_SLOTCALCULATOR_H
  21 #define LLVM_SLOTCALCULATOR_H
  22
  23 #include <vector>
  24 #include <map>
  25 #include <cassert>
  26
  27 namespace llvm {
  28
  29 class Value;
  30 class Module;
  31 class Function;
  32 class SymbolTable;
  33 class ConstantArray;
  34
  35 class SlotCalculator {
  36   const Module *TheModule;
  37
  38   /// BuildBytecodeInfo - If true, this is the creating information for the
  39   /// bytecode writer, if false, we are building information for the assembly
  40   /// emitter.  The assembly emitter doesn't need named objects numbered, among
  41   /// other differences.
  42   bool BuildBytecodeInfo;
  43
  44   typedef std::vector<const Value*> TypePlane;
  45   std::vector<TypePlane> Table;
  46   std::map<const Value*, unsigned> NodeMap;
  47
  48   /// ConstantStrings - If we are indexing for a bytecode file, this keeps track
  49   /// of all of the constants strings that need to be emitted.
  50   std::vector<const ConstantArray*> ConstantStrings;
  51
  52   /// ModuleLevel - Used to keep track of which values belong to the module,
  53   /// and which values belong to the currently incorporated function.
  54   ///
  55   std::vector<unsigned> ModuleLevel;
  56
  57   /// ModuleContainsAllFunctionConstants - This flag is set to true if all
  58   /// function constants are incorporated into the module constant table.  This
  59   /// is only possible if building information for a bytecode file.
  60   bool ModuleContainsAllFunctionConstants;
  61
  62   /// CompactionTable/NodeMap - When function compaction has been performed,
  63   /// these entries provide a compacted view of the namespace needed to emit
  64   /// instructions in a function body.  The 'getSlot()' method automatically
  65   /// returns these entries if applicable, or the global entries if not.
  66   std::vector<TypePlane> CompactionTable;
  67   std::map<const Value*, unsigned> CompactionNodeMap;
  68
  69   SlotCalculator(const SlotCalculator &);  // DO NOT IMPLEMENT
  70   void operator=(const SlotCalculator &);  // DO NOT IMPLEMENT
  71 public:
  72   SlotCalculator(const Module *M, bool BuildBytecodeInfo);
  73   // Start out in incorp state
  74   SlotCalculator(const Function *F, bool BuildBytecodeInfo);
  75
  76   /// getSlot - Return the slot number of the specified value in it's type
  77   /// plane.  This returns < 0 on error!
  78   ///
  79   int getSlot(const Value *V) const;
  80
  81   /// getGlobalSlot - Return a slot number from the global table.  This can only
  82   /// be used when a compaction table is active.
  83   unsigned getGlobalSlot(const Value *V) const;
  84
  85   inline unsigned getNumPlanes() const {
  86     if (CompactionTable.empty())
  87       return Table.size();
  88     else
  89       return CompactionTable.size();
  90   }
  91   inline unsigned getModuleLevel(unsigned Plane) const {
  92     return Plane < ModuleLevel.size() ? ModuleLevel[Plane] : 0;
  93   }
  94
  95   inline const TypePlane &getPlane(unsigned Plane) const {
  96     if (CompactionTable.empty() || CompactionTable.size() <= Plane ||
  97         CompactionTable[Plane].empty())
  98       return Table[Plane];
  99     else
 100       return CompactionTable[Plane];
 101   }
 102
 103   /// incorporateFunction/purgeFunction - If you'd like to deal with a function,
 104   /// use these two methods to get its data into the SlotCalculator!
 105   ///
 106   void incorporateFunction(const Function *F);
 107   void purgeFunction();
 108
 109   /// string_iterator/string_begin/end - Access the list of module-level
 110   /// constant strings that have been incorporated.  This is only applicable to
 111   /// bytecode files.
 112   typedef std::vector<const ConstantArray*>::const_iterator string_iterator;
 113   string_iterator string_begin() const { return ConstantStrings.begin(); }
 114   string_iterator string_end() const   { return ConstantStrings.end(); }
 115
 116   const std::vector<TypePlane> &getCompactionTable() const {
 117     return CompactionTable;
 118   }
 119
 120 private:
 121   // getOrCreateSlot - Values can be crammed into here at will... if
 122   // they haven't been inserted already, they get inserted, otherwise
 123   // they are ignored.
 124   //
 125   int getOrCreateSlot(const Value *D);
 126
 127   // insertValue - Insert a value into the value table... Return the
 128   // slot that it occupies, or -1 if the declaration is to be ignored
 129   // because of the IgnoreNamedNodes flag.
 130   //
 131   int insertValue(const Value *D, bool dontIgnore = false);
 132
 133   // doInsertValue - Small helper function to be called only be insertVal.
 134   int doInsertValue(const Value *D);
 135
 136   // processModule - Process all of the module level function declarations and
 137   // types that are available.
 138   //
 139   void processModule();
 140
 141   // processSymbolTable - Insert all of the values in the specified symbol table
 142   // into the values table...
 143   //
 144   void processSymbolTable(const SymbolTable *ST);
 145   void processSymbolTableConstants(const SymbolTable *ST);
 146
 147   void buildCompactionTable(const Function *F);
 148   unsigned getOrCreateCompactionTableSlot(const Value *V);
 149 };
 150
 151 } // End llvm namespace
 152
 153 #endif