1 //==- Serialize.h - Generic Object Serialization to Bitcode -------*- C++ -*-=//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines the interface for generic object serialization to
13 //===----------------------------------------------------------------------===//
15 #ifndef LLVM_BITCODE_SERIALIZE_OUTPUT
16 #define LLVM_BITCODE_SERIALIZE_OUTPUT
18 #include "llvm/Bitcode/Serialization.h"
19 #include "llvm/Bitcode/BitstreamWriter.h"
20 #include "llvm/ADT/SmallVector.h"
21 #include "llvm/ADT/DenseMap.h"
26 BitstreamWriter& Stream;
27 SmallVector<uint64_t,10> Record;
30 typedef DenseMap<const void*,unsigned> MapTy;
34 explicit Serializer(BitstreamWriter& stream);
37 //==------------------------------------------------==//
38 // Template-based dispatch to emit arbitrary types.
39 //==------------------------------------------------==//
42 inline void Emit(const T& X) { SerializeTrait<T>::Emit(*this,X); }
44 //==------------------------------------------------==//
45 // Methods to emit primitive types.
46 //==------------------------------------------------==//
48 void EmitInt(uint64_t X);
49 void EmitSInt(int64_t X);
51 inline void EmitBool(bool X) { EmitInt(X); }
52 void EmitCStr(const char* beg, const char* end);
53 void EmitCStr(const char* cstr);
55 void EmitPtr(const void* ptr) { EmitInt(getPtrId(ptr)); }
58 inline void EmitRef(const T& ref) { EmitPtr(&ref); }
60 // Emit a pointer and the object pointed to. (This has no relation to the
61 // OwningPtr<> class.)
63 inline void EmitOwnedPtr(T* ptr) {
65 if (ptr) SerializeTrait<T>::Emit(*this,*ptr);
69 //==------------------------------------------------==//
70 // Batch emission of pointers.
71 //==------------------------------------------------==//
73 template <typename T1, typename T2>
74 void BatchEmitOwnedPtrs(T1* p1, T2* p2) {
77 if (p1) SerializeTrait<T1>::Emit(*this,*p1);
78 if (p2) SerializeTrait<T2>::Emit(*this,*p2);
81 template <typename T1, typename T2, typename T3>
82 void BatchEmitOwnedPtrs(T1* p1, T2* p2, T3* p3) {
86 if (p1) SerializeTrait<T1>::Emit(*this,*p1);
87 if (p2) SerializeTrait<T2>::Emit(*this,*p2);
88 if (p3) SerializeTrait<T3>::Emit(*this,*p3);
91 template <typename T1, typename T2, typename T3, typename T4>
92 void BatchEmitOwnedPtrs(T1* p1, T2* p2, T3* p3, T4& p4) {
97 if (p1) SerializeTrait<T1>::Emit(*this,*p1);
98 if (p2) SerializeTrait<T2>::Emit(*this,*p2);
99 if (p3) SerializeTrait<T3>::Emit(*this,*p3);
100 if (p4) SerializeTrait<T4>::Emit(*this,*p4);
103 template <typename T>
104 void BatchEmitOwnedPtrs(unsigned NumPtrs, T* const * Ptrs) {
105 for (unsigned i = 0; i < NumPtrs; ++i)
108 for (unsigned i = 0; i < NumPtrs; ++i)
109 if (Ptrs[i]) SerializeTrait<T>::Emit(*this,*Ptrs[i]);
112 template <typename T1, typename T2>
113 void BatchEmitOwnedPtrs(unsigned NumT1Ptrs, T1* const * Ptrs, T2* p2) {
115 for (unsigned i = 0; i < NumT1Ptrs; ++i)
120 for (unsigned i = 0; i < NumT1Ptrs; ++i)
121 if (Ptrs[i]) SerializeTrait<T1>::Emit(*this,*Ptrs[i]);
123 if (p2) SerializeTrait<T2>::Emit(*this,*p2);
126 template <typename T1, typename T2, typename T3>
127 void BatchEmitOwnedPtrs(unsigned NumT1Ptrs, T1* const * Ptrs,
130 for (unsigned i = 0; i < NumT1Ptrs; ++i)
136 for (unsigned i = 0; i < NumT1Ptrs; ++i)
137 if (Ptrs[i]) SerializeTrait<T1>::Emit(*this,*Ptrs[i]);
139 if (p2) SerializeTrait<T2>::Emit(*this,*p2);
140 if (p3) SerializeTrait<T3>::Emit(*this,*p3);
143 //==------------------------------------------------==//
145 //==------------------------------------------------==//
147 template <typename T>
150 Emitter0(Serializer& s) : S(s) {}
151 void operator()(const T& x) const {
152 SerializeTrait<T>::Emit(S,x);
156 template <typename T, typename Arg1>
161 Emitter1(Serializer& s, Arg1 a1) : S(s), A1(a1) {}
162 void operator()(const T& x) const {
163 SerializeTrait<T>::Emit(S,x,A1);
167 template <typename T, typename Arg1, typename Arg2>
173 Emitter2(Serializer& s, Arg1 a1, Arg2 a2) : S(s), A1(a1), A2(a2) {}
174 void operator()(const T& x) const {
175 SerializeTrait<T>::Emit(S,x,A1,A2);
179 template <typename T>
180 Emitter0<T> MakeEmitter() {
181 return Emitter0<T>(*this);
184 template <typename T, typename Arg1>
185 Emitter1<T,Arg1> MakeEmitter(Arg1 a1) {
186 return Emitter1<T,Arg1>(*this,a1);
189 template <typename T, typename Arg1, typename Arg2>
190 Emitter2<T,Arg1,Arg2> MakeEmitter(Arg1 a1, Arg2 a2) {
191 return Emitter2<T,Arg1,Arg2>(*this,a1,a2);
194 //==------------------------------------------------==//
195 // Misc. query and block/record manipulation methods.
196 //==------------------------------------------------==//
198 bool isRegistered(const void* p) const;
200 void FlushRecord() { if (inRecord()) EmitRecord(); }
201 void EnterBlock(unsigned BlockID = 8, unsigned CodeLen = 3);
206 inline bool inRecord() { return Record.size() > 0; }
207 SerializedPtrID getPtrId(const void* ptr);
210 } // end namespace llvm