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   template <typename T>
  41   struct Emitter {
  42     Serializer &S;
  43
  44     Emitter(Serializer& s) : S(s) {}
  45     void operator()(const T& x) const { S.Emit(x); }
  46   };
  47
  48   template <typename T>
  49   Emitter<T> MakeEmitter() { return Emitter<T>(*this); }
  50
  51   void EmitInt(uint64_t X);
  52   void EmitSInt(int64_t X);
  53
  54   void EmitBool(bool X) { EmitInt(X); }
  55   void EmitCStr(const char* beg, const char* end);
  56   void EmitCStr(const char* cstr);
  57
  58   void EmitPtr(const void* ptr) { EmitInt(getPtrId(ptr)); }
  59
  60   template <typename T>
  61   void EmitRef(const T& ref) { EmitPtr(&ref); }
  62
  63   template <typename T>
  64   void EmitOwnedPtr(T* ptr) {
  65     EmitPtr(ptr);
  66     if (ptr) SerializeTrait<T>::Emit(*this,*ptr);
  67   }
  68
  69   template <typename T1, typename T2>
  70   void BatchEmitOwnedPtrs(T1* p1, T2* p2) {
  71     EmitPtr(p1);
  72     EmitPtr(p2);
  73     if (p1) SerializeTrait<T1>::Emit(*this,*p1);
  74     if (p2) SerializeTrait<T2>::Emit(*this,*p2);
  75   }
  76
  77   template <typename T1, typename T2, typename T3>
  78   void BatchEmitOwnedPtrs(T1* p1, T2* p2, T3* p3) {
  79     EmitPtr(p1);
  80     EmitPtr(p2);
  81     EmitPtr(p3);
  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   }
  86
  87   template <typename T1, typename T2, typename T3, typename T4>
  88   void BatchEmitOwnedPtrs(T1* p1, T2* p2, T3* p3, T4& p4) {
  89     EmitPtr(p1);
  90     EmitPtr(p2);
  91     EmitPtr(p3);
  92     EmitPtr(p4);
  93     if (p1) SerializeTrait<T1>::Emit(*this,*p1);
  94     if (p2) SerializeTrait<T2>::Emit(*this,*p2);
  95     if (p3) SerializeTrait<T3>::Emit(*this,*p3);
  96     if (p4) SerializeTrait<T4>::Emit(*this,*p4);
  97   }
  98
  99   template <typename T>
 100   void BatchEmitOwnedPtrs(unsigned NumPtrs, T* const * Ptrs) {
 101     for (unsigned i = 0; i < NumPtrs; ++i)
 102       EmitPtr(Ptrs[i]);
 103
 104     for (unsigned i = 0; i < NumPtrs; ++i)
 105       if (Ptrs[i]) SerializeTrait<T>::Emit(*this,*Ptrs[i]);
 106   }
 107
 108   template <typename T1, typename T2>
 109   void BatchEmitOwnedPtrs(unsigned NumT1Ptrs, T1* const * Ptrs, T2* p2) {
 110
 111     for (unsigned i = 0; i < NumT1Ptrs; ++i)
 112       EmitPtr(Ptrs[i]);
 113
 114     EmitPtr(p2);
 115
 116     for (unsigned i = 0; i < NumT1Ptrs; ++i)
 117       if (Ptrs[i]) SerializeTrait<T1>::Emit(*this,*Ptrs[i]);
 118
 119     if (p2) SerializeTrait<T2>::Emit(*this,*p2);
 120   }
 121
 122   template <typename T1, typename T2, typename T3>
 123   void BatchEmitOwnedPtrs(unsigned NumT1Ptrs, T1* const * Ptrs,
 124                           T2* p2, T3* p3) {
 125
 126     for (unsigned i = 0; i < NumT1Ptrs; ++i)
 127       EmitPtr(Ptrs[i]);
 128
 129     EmitPtr(p2);
 130     EmitPtr(p3);
 131
 132     for (unsigned i = 0; i < NumT1Ptrs; ++i)
 133       if (Ptrs[i]) SerializeTrait<T1>::Emit(*this,*Ptrs[i]);
 134
 135     if (p2) SerializeTrait<T2>::Emit(*this,*p2);
 136     if (p3) SerializeTrait<T3>::Emit(*this,*p3);
 137   }
 138
 139   bool isRegistered(const void* p) const;
 140
 141   void FlushRecord() { if (inRecord()) EmitRecord(); }
 142   void EnterBlock(unsigned BlockID = 8, unsigned CodeLen = 3);
 143   void ExitBlock();
 144
 145 private:
 146   void EmitRecord();
 147   inline bool inRecord() { return Record.size() > 0; }
 148   SerializedPtrID getPtrId(const void* ptr);
 149 };
 150
 151 } // end namespace llvm
 152 #endif