1 /**************************************************************************
3 * Copyright 2007-2008 VMware, Inc.
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the
8 * "Software"), to deal in the Software without restriction, including
9 * without limitation the rights to use, copy, modify, merge, publish,
10 * distribute, sub license, and/or sell copies of the Software, and to
11 * permit persons to whom the Software is furnished to do so, subject to
12 * the following conditions:
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
21 * IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS BE LIABLE FOR
22 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
23 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
24 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
26 **************************************************************************/
32 * \author Jose Fonseca <jfonseca-at-vmware-dot-com>
33 * \author Thomas Hellström <thellstrom-at-vmware-dot-com>
37 #include "pipe/p_compiler.h"
38 #include "util/u_debug.h"
39 #include "os/os_thread.h"
40 #include "util/u_memory.h"
41 #include "util/list.h"
43 #include "pb_buffer.h"
44 #include "pb_bufmgr.h"
49 * Wrapper around a pipe buffer which adds delayed destruction.
51 struct pb_cache_buffer
53 struct pb_buffer base
;
54 struct pb_buffer
*buffer
;
55 struct pb_cache_manager
*mgr
;
56 struct pb_cache_entry cache_entry
;
60 struct pb_cache_manager
62 struct pb_manager base
;
63 struct pb_manager
*provider
;
64 struct pb_cache cache
;
68 static inline struct pb_cache_buffer
*
69 pb_cache_buffer(struct pb_buffer
*buf
)
72 return (struct pb_cache_buffer
*)buf
;
76 static inline struct pb_cache_manager
*
77 pb_cache_manager(struct pb_manager
*mgr
)
80 return (struct pb_cache_manager
*)mgr
;
85 pb_cache_manager_remove_buffer(struct pb_buffer
*pb_buf
)
87 struct pb_cache_buffer
*buf
= pb_cache_buffer(pb_buf
);
89 /* the buffer won't be added if mgr is NULL */
94 * Actually destroy the buffer.
97 _pb_cache_buffer_destroy(struct pb_buffer
*pb_buf
)
99 struct pb_cache_buffer
*buf
= pb_cache_buffer(pb_buf
);
101 assert(!pipe_is_referenced(&buf
->base
.reference
));
102 pb_reference(&buf
->buffer
, NULL
);
108 pb_cache_buffer_destroy(struct pb_buffer
*_buf
)
110 struct pb_cache_buffer
*buf
= pb_cache_buffer(_buf
);
111 struct pb_cache_manager
*mgr
= buf
->mgr
;
114 pb_reference(&buf
->buffer
, NULL
);
119 pb_cache_add_buffer(&buf
->cache_entry
);
124 pb_cache_buffer_map(struct pb_buffer
*_buf
,
125 unsigned flags
, void *flush_ctx
)
127 struct pb_cache_buffer
*buf
= pb_cache_buffer(_buf
);
128 return pb_map(buf
->buffer
, flags
, flush_ctx
);
133 pb_cache_buffer_unmap(struct pb_buffer
*_buf
)
135 struct pb_cache_buffer
*buf
= pb_cache_buffer(_buf
);
136 pb_unmap(buf
->buffer
);
140 static enum pipe_error
141 pb_cache_buffer_validate(struct pb_buffer
*_buf
,
142 struct pb_validate
*vl
,
145 struct pb_cache_buffer
*buf
= pb_cache_buffer(_buf
);
146 return pb_validate(buf
->buffer
, vl
, flags
);
151 pb_cache_buffer_fence(struct pb_buffer
*_buf
,
152 struct pipe_fence_handle
*fence
)
154 struct pb_cache_buffer
*buf
= pb_cache_buffer(_buf
);
155 pb_fence(buf
->buffer
, fence
);
160 pb_cache_buffer_get_base_buffer(struct pb_buffer
*_buf
,
161 struct pb_buffer
**base_buf
,
164 struct pb_cache_buffer
*buf
= pb_cache_buffer(_buf
);
165 pb_get_base_buffer(buf
->buffer
, base_buf
, offset
);
170 pb_cache_buffer_vtbl
= {
171 pb_cache_buffer_destroy
,
173 pb_cache_buffer_unmap
,
174 pb_cache_buffer_validate
,
175 pb_cache_buffer_fence
,
176 pb_cache_buffer_get_base_buffer
181 pb_cache_can_reclaim_buffer(struct pb_buffer
*_buf
)
183 struct pb_cache_buffer
*buf
= pb_cache_buffer(_buf
);
185 if (buf
->mgr
->provider
->is_buffer_busy
) {
186 if (buf
->mgr
->provider
->is_buffer_busy(buf
->mgr
->provider
, buf
->buffer
))
189 void *ptr
= pb_map(buf
->buffer
, PB_USAGE_DONTBLOCK
, NULL
);
194 pb_unmap(buf
->buffer
);
201 static struct pb_buffer
*
202 pb_cache_manager_create_buffer(struct pb_manager
*_mgr
,
204 const struct pb_desc
*desc
)
206 struct pb_cache_manager
*mgr
= pb_cache_manager(_mgr
);
207 struct pb_cache_buffer
*buf
;
209 /* get a buffer from the cache */
210 buf
= (struct pb_cache_buffer
*)
211 pb_cache_reclaim_buffer(&mgr
->cache
, size
, desc
->alignment
,
216 /* create a new one */
217 buf
= CALLOC_STRUCT(pb_cache_buffer
);
221 buf
->buffer
= mgr
->provider
->create_buffer(mgr
->provider
, size
, desc
);
223 /* Empty the cache and try again. */
225 pb_cache_release_all_buffers(&mgr
->cache
);
226 buf
->buffer
= mgr
->provider
->create_buffer(mgr
->provider
, size
, desc
);
234 assert(pipe_is_referenced(&buf
->buffer
->reference
));
235 assert(pb_check_alignment(desc
->alignment
, buf
->buffer
->alignment
));
236 assert(buf
->buffer
->size
>= size
);
238 pipe_reference_init(&buf
->base
.reference
, 1);
239 buf
->base
.alignment
= buf
->buffer
->alignment
;
240 buf
->base
.usage
= buf
->buffer
->usage
;
241 buf
->base
.size
= buf
->buffer
->size
;
243 buf
->base
.vtbl
= &pb_cache_buffer_vtbl
;
245 pb_cache_init_entry(&mgr
->cache
, &buf
->cache_entry
, &buf
->base
, 0);
252 pb_cache_manager_flush(struct pb_manager
*_mgr
)
254 struct pb_cache_manager
*mgr
= pb_cache_manager(_mgr
);
256 pb_cache_release_all_buffers(&mgr
->cache
);
258 assert(mgr
->provider
->flush
);
259 if(mgr
->provider
->flush
)
260 mgr
->provider
->flush(mgr
->provider
);
265 pb_cache_manager_destroy(struct pb_manager
*_mgr
)
267 struct pb_cache_manager
*mgr
= pb_cache_manager(_mgr
);
269 pb_cache_deinit(&mgr
->cache
);
274 * Create a caching buffer manager
276 * @param provider The buffer manager to which cache miss buffer requests
277 * should be redirected.
278 * @param usecs Unused buffers may be released from the cache after this
280 * @param size_factor Declare buffers that are size_factor times bigger than
281 * the requested size as cache hits.
282 * @param bypass_usage Bitmask. If (requested usage & bypass_usage) != 0,
283 * buffer allocation requests are redirected to the provider.
284 * @param maximum_cache_size Maximum size of all unused buffers the cache can
288 pb_cache_manager_create(struct pb_manager
*provider
,
291 unsigned bypass_usage
,
292 uint64_t maximum_cache_size
)
294 struct pb_cache_manager
*mgr
;
299 mgr
= CALLOC_STRUCT(pb_cache_manager
);
303 mgr
->base
.destroy
= pb_cache_manager_destroy
;
304 mgr
->base
.create_buffer
= pb_cache_manager_create_buffer
;
305 mgr
->base
.flush
= pb_cache_manager_flush
;
306 mgr
->provider
= provider
;
307 pb_cache_init(&mgr
->cache
, 1, usecs
, size_factor
, bypass_usage
,
309 _pb_cache_buffer_destroy
,
310 pb_cache_can_reclaim_buffer
);