Merge branch 'blender2.7'
[blender.git] / intern / memutil / MEM_CacheLimiterC-Api.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 /** \file \ingroup memutil
18  */
19
20
21 #ifndef __MEM_CACHELIMITERC_API_H__
22 #define __MEM_CACHELIMITERC_API_H__
23
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27
28 struct MEM_CacheLimiter_s;
29 struct MEM_CacheLimiterHandle_s;
30
31 typedef struct MEM_CacheLimiter_s MEM_CacheLimiterC;
32 typedef struct MEM_CacheLimiterHandle_s MEM_CacheLimiterHandleC;
33
34 /* function used to remove data from memory */
35 typedef void (*MEM_CacheLimiter_Destruct_Func)(void*);
36
37 /* function used to measure stored data element size */
38 typedef size_t (*MEM_CacheLimiter_DataSize_Func) (void*);
39
40 /* function used to measure priority of item when freeing memory */
41 typedef int (*MEM_CacheLimiter_ItemPriority_Func) (void*, int);
42
43 /* function to check whether item could be destroyed */
44 typedef bool (*MEM_CacheLimiter_ItemDestroyable_Func) (void*);
45
46 #ifndef __MEM_CACHELIMITER_H__
47 void MEM_CacheLimiter_set_maximum(size_t m);
48 size_t MEM_CacheLimiter_get_maximum(void);
49 void MEM_CacheLimiter_set_disabled(bool disabled);
50 bool MEM_CacheLimiter_is_disabled(void);
51 #endif /* __MEM_CACHELIMITER_H__ */
52
53 /**
54  * Create new MEM_CacheLimiter object
55  * managed objects are destructed with the data_destructor
56  *
57  * \param data_destructor
58  * \return A new MEM_CacheLimter object
59  */
60
61 MEM_CacheLimiterC *new_MEM_CacheLimiter(MEM_CacheLimiter_Destruct_Func data_destructor,
62                                          MEM_CacheLimiter_DataSize_Func data_size);
63
64 /**
65  * Delete MEM_CacheLimiter
66  *
67  * Frees the memory of the CacheLimiter but does not touch managed objects!
68  *
69  * \param This "This" pointer
70  */
71
72 void delete_MEM_CacheLimiter(MEM_CacheLimiterC *This);
73
74 /**
75  * Manage object
76  *
77  * \param This "This" pointer, data data object to manage
78  * \return CacheLimiterHandle to ref, unref, touch the managed object
79  */
80
81 MEM_CacheLimiterHandleC *MEM_CacheLimiter_insert(MEM_CacheLimiterC *This, void *data);
82
83 /**
84  * Free objects until memory constraints are satisfied
85  *
86  * \param This "This" pointer
87  */
88
89 void MEM_CacheLimiter_enforce_limits(MEM_CacheLimiterC *This);
90
91 /**
92  * Unmanage object previously inserted object.
93  * Does _not_ delete managed object!
94  *
95  * \param handle of object
96  */
97
98 void MEM_CacheLimiter_unmanage(MEM_CacheLimiterHandleC *handle);
99
100
101 /**
102  * Raise priority of object (put it at the tail of the deletion chain)
103  *
104  * \param handle of object
105  */
106
107 void MEM_CacheLimiter_touch(MEM_CacheLimiterHandleC *handle);
108
109 /**
110  * Increment reference counter. Objects with reference counter != 0 are _not_
111  * deleted.
112  *
113  * \param handle of object
114  */
115
116 void MEM_CacheLimiter_ref(MEM_CacheLimiterHandleC *handle);
117
118 /**
119  * Decrement reference counter. Objects with reference counter != 0 are _not_
120  * deleted.
121  *
122  * \param handle of object
123  */
124
125 void MEM_CacheLimiter_unref(MEM_CacheLimiterHandleC *handle);
126
127 /**
128  * Get reference counter.
129  *
130  * \param handle of object
131  */
132
133 int MEM_CacheLimiter_get_refcount(MEM_CacheLimiterHandleC *handle);
134
135 /**
136  * Get pointer to managed object
137  *
138  * \param handle of object
139  */
140
141 void *MEM_CacheLimiter_get(MEM_CacheLimiterHandleC *handle);
142
143 void MEM_CacheLimiter_ItemPriority_Func_set(MEM_CacheLimiterC *This,
144                                             MEM_CacheLimiter_ItemPriority_Func item_priority_func);
145
146 void MEM_CacheLimiter_ItemDestroyable_Func_set(MEM_CacheLimiterC *This,
147                                                MEM_CacheLimiter_ItemDestroyable_Func item_destroyable_func);
148
149 size_t MEM_CacheLimiter_get_memory_in_use(MEM_CacheLimiterC *This);
150
151 #ifdef __cplusplus
152 }
153 #endif
154
155
156 #endif // __MEM_CACHELIMITERC_API_H__