1 //ProgramStateTrait.h - Partial implementations of ProgramStateTrait -*- 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 partial implementations of template specializations of
11 // the class ProgramStateTrait<>. ProgramStateTrait<> is used by ProgramState
12 // to implement set/get methods for manipulating a ProgramState's
15 //===----------------------------------------------------------------------===//
18 #ifndef LLVM_CLANG_GR_PROGRAMSTATETRAIT_H
19 #define LLVM_CLANG_GR_PROGRAMSTATETRAIT_H
21 #include "llvm/Support/DataTypes.h"
24 class BumpPtrAllocator;
25 template <typename K, typename D, typename I> class ImmutableMap;
26 template <typename K, typename I> class ImmutableSet;
27 template <typename T> class ImmutableList;
28 template <typename T> class ImmutableListImpl;
34 template <typename T> struct ProgramStatePartialTrait;
36 /// Declares a program state trait for type \p Type called \p Name, and
37 /// introduce a typedef named \c NameTy.
38 /// The macro should not be used inside namespaces, or for traits that must
39 /// be accessible from more than one translation unit.
40 #define REGISTER_TRAIT_WITH_PROGRAMSTATE(Name, Type) \
43 typedef Type Name ## Ty; \
48 struct ProgramStateTrait<Name> \
49 : public ProgramStatePartialTrait<Name ## Ty> { \
50 static void *GDMIndex() { static int Index; return &Index; } \
56 // Partial-specialization for ImmutableMap.
58 template <typename Key, typename Data, typename Info>
59 struct ProgramStatePartialTrait< llvm::ImmutableMap<Key,Data,Info> > {
60 typedef llvm::ImmutableMap<Key,Data,Info> data_type;
61 typedef typename data_type::Factory& context_type;
63 typedef Data value_type;
64 typedef const value_type* lookup_type;
66 static inline data_type MakeData(void *const* p) {
67 return p ? data_type((typename data_type::TreeTy*) *p) : data_type(0);
69 static inline void *MakeVoidPtr(data_type B) {
72 static lookup_type Lookup(data_type B, key_type K) {
75 static data_type Set(data_type B, key_type K, value_type E,context_type F){
76 return F.add(B, K, E);
79 static data_type Remove(data_type B, key_type K, context_type F) {
80 return F.remove(B, K);
83 static inline context_type MakeContext(void *p) {
84 return *((typename data_type::Factory*) p);
87 static void *CreateContext(llvm::BumpPtrAllocator& Alloc) {
88 return new typename data_type::Factory(Alloc);
91 static void DeleteContext(void *Ctx) {
92 delete (typename data_type::Factory*) Ctx;
96 /// Helper for registering a map trait.
98 /// If the map type were written directly in the invocation of
99 /// REGISTER_TRAIT_WITH_PROGRAMSTATE, the comma in the template arguments
100 /// would be treated as a macro argument separator, which is wrong.
101 /// This allows the user to specify a map type in a way that the preprocessor
103 #define CLANG_ENTO_PROGRAMSTATE_MAP(Key, Value) llvm::ImmutableMap<Key, Value>
106 // Partial-specialization for ImmutableSet.
108 template <typename Key, typename Info>
109 struct ProgramStatePartialTrait< llvm::ImmutableSet<Key,Info> > {
110 typedef llvm::ImmutableSet<Key,Info> data_type;
111 typedef typename data_type::Factory& context_type;
112 typedef Key key_type;
114 static inline data_type MakeData(void *const* p) {
115 return p ? data_type((typename data_type::TreeTy*) *p) : data_type(0);
118 static inline void *MakeVoidPtr(data_type B) {
122 static data_type Add(data_type B, key_type K, context_type F) {
126 static data_type Remove(data_type B, key_type K, context_type F) {
127 return F.remove(B, K);
130 static bool Contains(data_type B, key_type K) {
131 return B.contains(K);
134 static inline context_type MakeContext(void *p) {
135 return *((typename data_type::Factory*) p);
138 static void *CreateContext(llvm::BumpPtrAllocator& Alloc) {
139 return new typename data_type::Factory(Alloc);
142 static void DeleteContext(void *Ctx) {
143 delete (typename data_type::Factory*) Ctx;
148 // Partial-specialization for ImmutableList.
150 template <typename T>
151 struct ProgramStatePartialTrait< llvm::ImmutableList<T> > {
152 typedef llvm::ImmutableList<T> data_type;
154 typedef typename data_type::Factory& context_type;
156 static data_type Add(data_type L, key_type K, context_type F) {
160 static bool Contains(data_type L, key_type K) {
161 return L.contains(K);
164 static inline data_type MakeData(void *const* p) {
165 return p ? data_type((const llvm::ImmutableListImpl<T>*) *p)
169 static inline void *MakeVoidPtr(data_type D) {
170 return const_cast<llvm::ImmutableListImpl<T> *>(D.getInternalPointer());
173 static inline context_type MakeContext(void *p) {
174 return *((typename data_type::Factory*) p);
177 static void *CreateContext(llvm::BumpPtrAllocator& Alloc) {
178 return new typename data_type::Factory(Alloc);
181 static void DeleteContext(void *Ctx) {
182 delete (typename data_type::Factory*) Ctx;
187 // Partial specialization for bool.
188 template <> struct ProgramStatePartialTrait<bool> {
189 typedef bool data_type;
191 static inline data_type MakeData(void *const* p) {
192 return p ? (data_type) (uintptr_t) *p
195 static inline void *MakeVoidPtr(data_type d) {
196 return (void*) (uintptr_t) d;
200 // Partial specialization for unsigned.
201 template <> struct ProgramStatePartialTrait<unsigned> {
202 typedef unsigned data_type;
204 static inline data_type MakeData(void *const* p) {
205 return p ? (data_type) (uintptr_t) *p
208 static inline void *MakeVoidPtr(data_type d) {
209 return (void*) (uintptr_t) d;
213 // Partial specialization for void*.
214 template <> struct ProgramStatePartialTrait<void*> {
215 typedef void *data_type;
217 static inline data_type MakeData(void *const* p) {
221 static inline void *MakeVoidPtr(data_type d) {
226 // Partial specialization for const void *.
227 template <> struct ProgramStatePartialTrait<const void *> {
228 typedef const void *data_type;
230 static inline data_type MakeData(void * const *p) {
231 return p ? *p : data_type();
234 static inline void *MakeVoidPtr(data_type d) {
235 return const_cast<void *>(d);
239 } // end ento namespace
241 } // end clang namespace