include/llvm/Bitcode/Serialize.h

   1 //==- Serialize.h - Generic Object Serialization to Bitcode -------*- C++ -*-=//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by Ted Kremenek and is distributed under the
   6 // University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file defines the interface for generic object serialization to
  11 // LLVM bitcode.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_BITCODE_SERIALIZE_OUTPUT
  16 #define LLVM_BITCODE_SERIALIZE_OUTPUT
  17
  18 #include "llvm/Bitcode/Serialization.h"
  19 #include "llvm/Bitcode/BitstreamWriter.h"
  20 #include "llvm/ADT/SmallVector.h"
  21 #include "llvm/ADT/DenseMap.h"
  22
  23 namespace llvm {
  24
  25 class Serializer {
  26   BitstreamWriter& Stream;
  27   SmallVector<uint64_t,10> Record;
  28   unsigned BlockLevel;
  29
  30   typedef DenseMap<const void*,unsigned> MapTy;
  31   MapTy PtrMap;
  32
  33 public:
  34   explicit Serializer(BitstreamWriter& stream);
  35   ~Serializer();
  36
  37   template <typename T>
  38   inline void Emit(const T& X) { SerializeTrait<T>::Emit(*this,X); }
  39
  40   void EmitInt(uint64_t X);
  41   void EmitSInt(int64_t X);
  42
  43   void EmitBool(bool X) { EmitInt(X); }
  44   void EmitCStr(const char* beg, const char* end);
  45   void EmitCStr(const char* cstr);
  46
  47   void EmitPtr(const void* ptr) { EmitInt(getPtrId(ptr)); }
  48
  49   template <typename T>
  50   void EmitRef(const T& ref) { EmitPtr(&ref); }
  51
  52   template <typename T>
  53   void EmitOwnedPtr(T* ptr) {
  54     EmitPtr(ptr);
  55     if (ptr) SerializeTrait<T>::Emit(*this,*ptr);
  56   }
  57
  58   template <typename T1, typename T2>
  59   void BatchEmitOwnedPtrs(T1* p1, T2* p2) {
  60     EmitPtr(p1);
  61     EmitPtr(p2);
  62     if (p1) SerializeTrait<T1>::Emit(*this,*p1);
  63     if (p2) SerializeTrait<T2>::Emit(*this,*p2);
  64   }
  65
  66   template <typename T1, typename T2, typename T3>
  67   void BatchEmitOwnedPtrs(T1* p1, T2* p2, T3* p3) {
  68     EmitPtr(p1);
  69     EmitPtr(p2);
  70     EmitPtr(p3);
  71     if (p1) SerializeTrait<T1>::Emit(*this,*p1);
  72     if (p2) SerializeTrait<T2>::Emit(*this,*p2);
  73     if (p3) SerializeTrait<T3>::Emit(*this,*p3);
  74   }
  75
  76   template <typename T1, typename T2, typename T3, typename T4>
  77   void BatchEmitOwnedPtrs(T1* p1, T2* p2, T3* p3, T4& p4) {
  78     EmitPtr(p1);
  79     EmitPtr(p2);
  80     EmitPtr(p3);
  81     EmitPtr(p4);
  82     if (p1) SerializeTrait<T1>::Emit(*this,*p1);
  83     if (p2) SerializeTrait<T2>::Emit(*this,*p2);
  84     if (p3) SerializeTrait<T3>::Emit(*this,*p3);
  85     if (p4) SerializeTrait<T4>::Emit(*this,*p4);
  86   }
  87
  88   template <typename T>
  89   void BatchEmitOwnedPtrs(unsigned NumPtrs, T* const * Ptrs) {
  90     for (unsigned i = 0; i < NumPtrs; ++i)
  91       EmitPtr(Ptrs[i]);
  92
  93     for (unsigned i = 0; i < NumPtrs; ++i)
  94       if (Ptrs[i]) SerializeTrait<T>::Emit(*this,*Ptrs[i]);
  95   }
  96
  97   template <typename T1, typename T2>
  98   void BatchEmitOwnedPtrs(unsigned NumT1Ptrs, T1* const * Ptrs, T2* p2) {
  99
 100     for (unsigned i = 0; i < NumT1Ptrs; ++i)
 101       EmitPtr(Ptrs[i]);
 102
 103     EmitPtr(p2);
 104
 105     for (unsigned i = 0; i < NumT1Ptrs; ++i)
 106       if (Ptrs[i]) SerializeTrait<T1>::Emit(*this,*Ptrs[i]);
 107
 108     if (p2) SerializeTrait<T2>::Emit(*this,*p2);
 109   }
 110
 111   template <typename T1, typename T2, typename T3>
 112   void BatchEmitOwnedPtrs(unsigned NumT1Ptrs, T1* const * Ptrs,
 113                           T2* p2, T3* p3) {
 114
 115     for (unsigned i = 0; i < NumT1Ptrs; ++i)
 116       EmitPtr(Ptrs[i]);
 117
 118     EmitPtr(p2);
 119     EmitPtr(p3);
 120
 121     for (unsigned i = 0; i < NumT1Ptrs; ++i)
 122       if (Ptrs[i]) SerializeTrait<T1>::Emit(*this,*Ptrs[i]);
 123
 124     if (p2) SerializeTrait<T2>::Emit(*this,*p2);
 125     if (p3) SerializeTrait<T3>::Emit(*this,*p3);
 126   }
 127
 128   bool isRegistered(const void* p) const;
 129
 130   void FlushRecord() { if (inRecord()) EmitRecord(); }
 131   void EnterBlock(unsigned BlockID = 8, unsigned CodeLen = 3);
 132   void ExitBlock();
 133
 134 private:
 135   void EmitRecord();
 136   inline bool inRecord() { return Record.size() > 0; }
 137   SerializedPtrID getPtrId(const void* ptr);
 138 };
 139
 140 } // end namespace llvm
 141 #endif