include/llvm/SlotCalculator.h

   1 //===-- llvm/Analysis/SlotCalculator.h - Calculate value slots ---*- C++ -*-==//
   2 //
   3 // This ModuleAnalyzer subclass calculates the slots that values will land in.
   4 // This is useful for when writing bytecode or assembly out, because you have
   5 // to know these things.
   6 //
   7 //===----------------------------------------------------------------------===//
   8
   9 #ifndef LLVM_ANALYSIS_SLOTCALCULATOR_H
  10 #define LLVM_ANALYSIS_SLOTCALCULATOR_H
  11
  12 #include "llvm/SymTabValue.h"
  13 #include <vector>
  14 #include <map>
  15 class Value;
  16 class Module;
  17 class Function;
  18
  19 class SlotCalculator {
  20   const Module *TheModule;
  21   bool IgnoreNamedNodes;     // Shall we not count named nodes?
  22
  23   typedef std::vector<const Value*> TypePlane;
  24   std::vector<TypePlane> Table;
  25   std::map<const Value *, unsigned> NodeMap;
  26
  27   // ModuleLevel - Used to keep track of which values belong to the module,
  28   // and which values belong to the currently incorporated method.
  29   //
  30   std::vector<unsigned> ModuleLevel;
  31
  32 public:
  33   SlotCalculator(const Module *M, bool IgnoreNamed);
  34   // Start out in incorp state
  35   SlotCalculator(const Function *M, bool IgnoreNamed);
  36   inline ~SlotCalculator() {}
  37
  38   // getValSlot returns < 0 on error!
  39   int getValSlot(const Value *D) const;
  40
  41   inline unsigned getNumPlanes() const { return Table.size(); }
  42   inline unsigned getModuleLevel(unsigned Plane) const {
  43     return Plane < ModuleLevel.size() ? ModuleLevel[Plane] : 0;
  44   }
  45
  46   inline const TypePlane &getPlane(unsigned Plane) const {
  47     return Table[Plane];
  48   }
  49
  50   // If you'd like to deal with a method, use these two methods to get its data
  51   // into the SlotCalculator!
  52   //
  53   void incorporateMethod(const Function *F);
  54   void purgeMethod();
  55
  56 protected:
  57   // insertVal - Insert a value into the value table... Return the slot that it
  58   // occupies, or -1 if the declaration is to be ignored because of the
  59   // IgnoreNamedNodes flag.
  60   //
  61   int insertVal(const Value *D, bool dontIgnore = false);
  62
  63   // insertValue - Values can be crammed into here at will... if they haven't
  64   // been inserted already, they get inserted, otherwise they are ignored.
  65   //
  66   int insertValue(const Value *D);
  67
  68   // doInsertVal - Small helper function to be called only be insertVal.
  69   int doInsertVal(const Value *D);
  70
  71   // processModule - Process all of the module level method declarations and
  72   // types that are available.
  73   //
  74   void processModule();
  75
  76   // processSymbolTable - Insert all of the values in the specified symbol table
  77   // into the values table...
  78   //
  79   void processSymbolTable(const SymbolTable *ST);
  80   void processSymbolTableConstants(const SymbolTable *ST);
  81 };
  82
  83 #endif