1 /**************************************************************************
3 * Copyright 2007-2008 Tungsten Graphics, Inc., Cedar Park, Texas.
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 TUNGSTEN GRAPHICS 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 <jrfonseca-at-tungstengraphics-dot-com>
33 * \author Thomas Hellström <thomas-at-tungstengraphics-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/u_double_list.h"
42 #include "util/u_time.h"
44 #include "pb_buffer.h"
45 #include "pb_bufmgr.h"
49 * Convenience macro (type safe).
51 #define SUPER(__derived) (&(__derived)->base)
54 struct pb_cache_manager;
58 * Wrapper around a pipe buffer which adds delayed destruction.
60 struct pb_cache_buffer
62 struct pb_buffer base;
64 struct pb_buffer *buffer;
65 struct pb_cache_manager *mgr;
67 /** Caching time interval */
70 struct list_head head;
74 struct pb_cache_manager
76 struct pb_manager base;
78 struct pb_manager *provider;
83 struct list_head delayed;
88 static INLINE struct pb_cache_buffer *
89 pb_cache_buffer(struct pb_buffer *buf)
92 return (struct pb_cache_buffer *)buf;
96 static INLINE struct pb_cache_manager *
97 pb_cache_manager(struct pb_manager *mgr)
100 return (struct pb_cache_manager *)mgr;
105 * Actually destroy the buffer.
108 _pb_cache_buffer_destroy(struct pb_cache_buffer *buf)
110 struct pb_cache_manager *mgr = buf->mgr;
112 LIST_DEL(&buf->head);
113 assert(mgr->numDelayed);
115 assert(!pipe_is_referenced(&buf->base.base.reference));
116 pb_reference(&buf->buffer, NULL);
122 * Free as many cache buffers from the list head as possible.
125 _pb_cache_buffer_list_check_free(struct pb_cache_manager *mgr)
127 struct list_head *curr, *next;
128 struct pb_cache_buffer *buf;
133 curr = mgr->delayed.next;
135 while(curr != &mgr->delayed) {
136 buf = LIST_ENTRY(struct pb_cache_buffer, curr, head);
138 if(!os_time_timeout(buf->start, buf->end, now))
141 _pb_cache_buffer_destroy(buf);
150 pb_cache_buffer_destroy(struct pb_buffer *_buf)
152 struct pb_cache_buffer *buf = pb_cache_buffer(_buf);
153 struct pb_cache_manager *mgr = buf->mgr;
155 pipe_mutex_lock(mgr->mutex);
156 assert(!pipe_is_referenced(&buf->base.base.reference));
158 _pb_cache_buffer_list_check_free(mgr);
160 buf->start = os_time_get();
161 buf->end = buf->start + mgr->usecs;
162 LIST_ADDTAIL(&buf->head, &mgr->delayed);
164 pipe_mutex_unlock(mgr->mutex);
169 pb_cache_buffer_map(struct pb_buffer *_buf,
172 struct pb_cache_buffer *buf = pb_cache_buffer(_buf);
173 return pb_map(buf->buffer, flags);
178 pb_cache_buffer_unmap(struct pb_buffer *_buf)
180 struct pb_cache_buffer *buf = pb_cache_buffer(_buf);
181 pb_unmap(buf->buffer);
185 static enum pipe_error
186 pb_cache_buffer_validate(struct pb_buffer *_buf,
187 struct pb_validate *vl,
190 struct pb_cache_buffer *buf = pb_cache_buffer(_buf);
191 return pb_validate(buf->buffer, vl, flags);
196 pb_cache_buffer_fence(struct pb_buffer *_buf,
197 struct pipe_fence_handle *fence)
199 struct pb_cache_buffer *buf = pb_cache_buffer(_buf);
200 pb_fence(buf->buffer, fence);
205 pb_cache_buffer_get_base_buffer(struct pb_buffer *_buf,
206 struct pb_buffer **base_buf,
209 struct pb_cache_buffer *buf = pb_cache_buffer(_buf);
210 pb_get_base_buffer(buf->buffer, base_buf, offset);
215 pb_cache_buffer_vtbl = {
216 pb_cache_buffer_destroy,
218 pb_cache_buffer_unmap,
219 pb_cache_buffer_validate,
220 pb_cache_buffer_fence,
221 pb_cache_buffer_get_base_buffer
225 static INLINE boolean
226 pb_cache_is_buffer_compat(struct pb_cache_buffer *buf,
228 const struct pb_desc *desc)
232 if(buf->base.base.size < size)
235 /* be lenient with size */
236 if(buf->base.base.size >= 2*size)
239 if(!pb_check_alignment(desc->alignment, buf->base.base.alignment))
242 if(!pb_check_usage(desc->usage, buf->base.base.usage))
245 map = pb_map(buf->buffer, PIPE_BUFFER_USAGE_DONTBLOCK);
250 pb_unmap(buf->buffer);
256 static struct pb_buffer *
257 pb_cache_manager_create_buffer(struct pb_manager *_mgr,
259 const struct pb_desc *desc)
261 struct pb_cache_manager *mgr = pb_cache_manager(_mgr);
262 struct pb_cache_buffer *buf;
263 struct pb_cache_buffer *curr_buf;
264 struct list_head *curr, *next;
267 pipe_mutex_lock(mgr->mutex);
270 curr = mgr->delayed.next;
273 /* search in the expired buffers, freeing them in the process */
275 while(curr != &mgr->delayed) {
276 curr_buf = LIST_ENTRY(struct pb_cache_buffer, curr, head);
277 if(!buf && pb_cache_is_buffer_compat(curr_buf, size, desc))
279 else if(os_time_timeout(curr_buf->start, curr_buf->end, now))
280 _pb_cache_buffer_destroy(curr_buf);
282 /* This buffer (and all hereafter) are still hot in cache */
288 /* keep searching in the hot buffers */
290 while(curr != &mgr->delayed) {
291 curr_buf = LIST_ENTRY(struct pb_cache_buffer, curr, head);
292 if(pb_cache_is_buffer_compat(curr_buf, size, desc)) {
296 /* no need to check the timeout here */
303 LIST_DEL(&buf->head);
304 pipe_mutex_unlock(mgr->mutex);
305 /* Increase refcount */
306 pipe_reference_init(&buf->base.base.reference, 1);
310 pipe_mutex_unlock(mgr->mutex);
312 buf = CALLOC_STRUCT(pb_cache_buffer);
316 buf->buffer = mgr->provider->create_buffer(mgr->provider, size, desc);
322 assert(pipe_is_referenced(&buf->buffer->base.reference));
323 assert(pb_check_alignment(desc->alignment, buf->buffer->base.alignment));
324 assert(pb_check_usage(desc->usage, buf->buffer->base.usage));
325 assert(buf->buffer->base.size >= size);
327 pipe_reference_init(&buf->base.base.reference, 1);
328 buf->base.base.alignment = buf->buffer->base.alignment;
329 buf->base.base.usage = buf->buffer->base.usage;
330 buf->base.base.size = buf->buffer->base.size;
332 buf->base.vtbl = &pb_cache_buffer_vtbl;
340 pb_cache_manager_flush(struct pb_manager *_mgr)
342 struct pb_cache_manager *mgr = pb_cache_manager(_mgr);
343 struct list_head *curr, *next;
344 struct pb_cache_buffer *buf;
346 pipe_mutex_lock(mgr->mutex);
347 curr = mgr->delayed.next;
349 while(curr != &mgr->delayed) {
350 buf = LIST_ENTRY(struct pb_cache_buffer, curr, head);
351 _pb_cache_buffer_destroy(buf);
355 pipe_mutex_unlock(mgr->mutex);
357 assert(mgr->provider->flush);
358 if(mgr->provider->flush)
359 mgr->provider->flush(mgr->provider);
364 pb_cache_manager_destroy(struct pb_manager *mgr)
366 pb_cache_manager_flush(mgr);
372 pb_cache_manager_create(struct pb_manager *provider,
375 struct pb_cache_manager *mgr;
380 mgr = CALLOC_STRUCT(pb_cache_manager);
384 mgr->base.destroy = pb_cache_manager_destroy;
385 mgr->base.create_buffer = pb_cache_manager_create_buffer;
386 mgr->base.flush = pb_cache_manager_flush;
387 mgr->provider = provider;
389 LIST_INITHEAD(&mgr->delayed);
391 pipe_mutex_init(mgr->mutex);