1 /**************************************************************************
3 * Copyright 2006-2008 Tungsten Graphics, Inc., Cedar Park, TX., USA
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 SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
17 * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
18 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
19 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 * USE OR OTHER DEALINGS IN THE SOFTWARE.
22 * The above copyright notice and this permission notice (including the
23 * next paragraph) shall be included in all copies or substantial portions
27 **************************************************************************/
31 * S-lab pool implementation.
33 * @sa http://en.wikipedia.org/wiki/Slab_allocation
35 * @author Thomas Hellstrom <thomas-at-tungstengraphics-dot-com>
36 * @author Jose Fonseca <jrfonseca@tungstengraphics.com>
39 #include "pipe/p_compiler.h"
40 #include "pipe/p_error.h"
41 #include "pipe/p_debug.h"
42 #include "pipe/p_thread.h"
43 #include "pipe/p_defines.h"
44 #include "util/u_memory.h"
45 #include "util/u_double_list.h"
46 #include "util/u_time.h"
48 #include "pb_buffer.h"
49 #include "pb_bufmgr.h"
58 * Sub-allocation of a contiguous buffer.
62 struct pb_buffer base
;
66 struct list_head head
;
70 /** Offset relative to the start of the slab buffer. */
73 /** Use when validating, to signal that all mappings are finished */
74 /* TODO: Actually validation does not reach this stage yet */
80 * Slab -- a contiguous piece of memory.
84 struct list_head head
;
85 struct list_head freeBuffers
;
89 struct pb_slab_buffer
*buffers
;
90 struct pb_slab_manager
*mgr
;
92 /** Buffer from the provider */
100 * It adds/removes slabs as needed in order to meet the allocation/destruction
101 * of individual buffers.
103 struct pb_slab_manager
105 struct pb_manager base
;
107 /** From where we get our buffers */
108 struct pb_manager
*provider
;
110 /** Size of the buffers we hand on downstream */
113 /** Size of the buffers we request upstream */
117 * Alignment, usage to be used to allocate the slab buffers.
119 * We can only provide buffers which are consistent (in alignment, usage)
120 * with this description.
127 * Full slabs are not stored in any list. Empty slabs are destroyed
130 struct list_head slabs
;
137 * Wrapper around several slabs, therefore capable of handling buffers of
140 * This buffer manager just dispatches buffer allocations to the appropriate slab
141 * manager, according to the requested buffer size, or by passes the slab
142 * managers altogether for even greater sizes.
144 * The data of this structure remains constant after
145 * initialization and thus needs no mutex protection.
147 struct pb_slab_range_manager
149 struct pb_manager base
;
151 struct pb_manager
*provider
;
156 /** @sa pb_slab_manager::desc */
162 /** Array of pb_slab_manager, one for each bucket size */
163 struct pb_manager
**buckets
;
167 static INLINE
struct pb_slab_buffer
*
168 pb_slab_buffer(struct pb_buffer
*buf
)
171 return (struct pb_slab_buffer
*)buf
;
175 static INLINE
struct pb_slab_manager
*
176 pb_slab_manager(struct pb_manager
*mgr
)
179 return (struct pb_slab_manager
*)mgr
;
183 static INLINE
struct pb_slab_range_manager
*
184 pb_slab_range_manager(struct pb_manager
*mgr
)
187 return (struct pb_slab_range_manager
*)mgr
;
192 * Delete a buffer from the slab delayed list and put
193 * it on the slab FREE list.
196 pb_slab_buffer_destroy(struct pb_buffer
*_buf
)
198 struct pb_slab_buffer
*buf
= pb_slab_buffer(_buf
);
199 struct pb_slab
*slab
= buf
->slab
;
200 struct pb_slab_manager
*mgr
= slab
->mgr
;
201 struct list_head
*list
= &buf
->head
;
203 pipe_mutex_lock(mgr
->mutex
);
205 assert(buf
->base
.base
.refcount
== 0);
210 LIST_ADDTAIL(list
, &slab
->freeBuffers
);
213 if (slab
->head
.next
== &slab
->head
)
214 LIST_ADDTAIL(&slab
->head
, &mgr
->slabs
);
216 /* If the slab becomes totally empty, free it */
217 if (slab
->numFree
== slab
->numBuffers
) {
220 pb_reference(&slab
->bo
, NULL
);
225 pipe_mutex_unlock(mgr
->mutex
);
230 pb_slab_buffer_map(struct pb_buffer
*_buf
,
233 struct pb_slab_buffer
*buf
= pb_slab_buffer(_buf
);
236 return (void *) ((uint8_t *) buf
->slab
->virtual + buf
->start
);
241 pb_slab_buffer_unmap(struct pb_buffer
*_buf
)
243 struct pb_slab_buffer
*buf
= pb_slab_buffer(_buf
);
246 if (buf
->mapCount
== 0)
247 pipe_condvar_broadcast(buf
->event
);
251 static enum pipe_error
252 pb_slab_buffer_validate(struct pb_buffer
*_buf
,
253 struct pb_validate
*vl
,
256 struct pb_slab_buffer
*buf
= pb_slab_buffer(_buf
);
257 return pb_validate(buf
->slab
->bo
, vl
, flags
);
262 pb_slab_buffer_fence(struct pb_buffer
*_buf
,
263 struct pipe_fence_handle
*fence
)
265 struct pb_slab_buffer
*buf
= pb_slab_buffer(_buf
);
266 pb_fence(buf
->slab
->bo
, fence
);
271 pb_slab_buffer_get_base_buffer(struct pb_buffer
*_buf
,
272 struct pb_buffer
**base_buf
,
275 struct pb_slab_buffer
*buf
= pb_slab_buffer(_buf
);
276 pb_get_base_buffer(buf
->slab
->bo
, base_buf
, offset
);
277 *offset
+= buf
->start
;
281 static const struct pb_vtbl
282 pb_slab_buffer_vtbl
= {
283 pb_slab_buffer_destroy
,
285 pb_slab_buffer_unmap
,
286 pb_slab_buffer_validate
,
287 pb_slab_buffer_fence
,
288 pb_slab_buffer_get_base_buffer
295 * Called when we ran out of free slabs.
297 static enum pipe_error
298 pb_slab_create(struct pb_slab_manager
*mgr
)
300 struct pb_slab
*slab
;
301 struct pb_slab_buffer
*buf
;
306 slab
= CALLOC_STRUCT(pb_slab
);
308 return PIPE_ERROR_OUT_OF_MEMORY
;
310 slab
->bo
= mgr
->provider
->create_buffer(mgr
->provider
, mgr
->slabSize
, &mgr
->desc
);
312 ret
= PIPE_ERROR_OUT_OF_MEMORY
;
316 /* Note down the slab virtual address. All mappings are accessed directly
317 * through this address so it is required that the buffer is pinned. */
318 slab
->virtual = pb_map(slab
->bo
,
319 PIPE_BUFFER_USAGE_CPU_READ
|
320 PIPE_BUFFER_USAGE_CPU_WRITE
);
322 ret
= PIPE_ERROR_OUT_OF_MEMORY
;
327 numBuffers
= slab
->bo
->base
.size
/ mgr
->bufSize
;
329 slab
->buffers
= CALLOC(numBuffers
, sizeof(*slab
->buffers
));
330 if (!slab
->buffers
) {
331 ret
= PIPE_ERROR_OUT_OF_MEMORY
;
335 LIST_INITHEAD(&slab
->head
);
336 LIST_INITHEAD(&slab
->freeBuffers
);
337 slab
->numBuffers
= numBuffers
;
342 for (i
=0; i
< numBuffers
; ++i
) {
343 buf
->base
.base
.refcount
= 0;
344 buf
->base
.base
.size
= mgr
->bufSize
;
345 buf
->base
.base
.alignment
= 0;
346 buf
->base
.base
.usage
= 0;
347 buf
->base
.vtbl
= &pb_slab_buffer_vtbl
;
349 buf
->start
= i
* mgr
->bufSize
;
351 pipe_condvar_init(buf
->event
);
352 LIST_ADDTAIL(&buf
->head
, &slab
->freeBuffers
);
357 /* Add this slab to the list of partial slabs */
358 LIST_ADDTAIL(&slab
->head
, &mgr
->slabs
);
363 pb_reference(&slab
->bo
, NULL
);
370 static struct pb_buffer
*
371 pb_slab_manager_create_buffer(struct pb_manager
*_mgr
,
373 const struct pb_desc
*desc
)
375 struct pb_slab_manager
*mgr
= pb_slab_manager(_mgr
);
376 static struct pb_slab_buffer
*buf
;
377 struct pb_slab
*slab
;
378 struct list_head
*list
;
381 assert(size
<= mgr
->bufSize
);
382 if(size
> mgr
->bufSize
)
385 /* check if we can provide the requested alignment */
386 assert(pb_check_alignment(desc
->alignment
, mgr
->desc
.alignment
));
387 if(!pb_check_alignment(desc
->alignment
, mgr
->desc
.alignment
))
389 assert(pb_check_alignment(desc
->alignment
, mgr
->bufSize
));
390 if(!pb_check_alignment(desc
->alignment
, mgr
->bufSize
))
393 assert(pb_check_usage(desc
->usage
, mgr
->desc
.usage
));
394 if(!pb_check_usage(desc
->usage
, mgr
->desc
.usage
))
397 pipe_mutex_lock(mgr
->mutex
);
399 /* Create a new slab, if we run out of partial slabs */
400 if (mgr
->slabs
.next
== &mgr
->slabs
) {
401 (void) pb_slab_create(mgr
);
402 if (mgr
->slabs
.next
== &mgr
->slabs
) {
403 pipe_mutex_unlock(mgr
->mutex
);
408 /* Allocate the buffer from a partial (or just created) slab */
409 list
= mgr
->slabs
.next
;
410 slab
= LIST_ENTRY(struct pb_slab
, list
, head
);
412 /* If totally full remove from the partial slab list */
413 if (--slab
->numFree
== 0)
416 list
= slab
->freeBuffers
.next
;
419 pipe_mutex_unlock(mgr
->mutex
);
420 buf
= LIST_ENTRY(struct pb_slab_buffer
, list
, head
);
422 ++buf
->base
.base
.refcount
;
423 buf
->base
.base
.alignment
= desc
->alignment
;
424 buf
->base
.base
.usage
= desc
->usage
;
431 pb_slab_manager_flush(struct pb_manager
*_mgr
)
433 struct pb_slab_manager
*mgr
= pb_slab_manager(_mgr
);
435 assert(mgr
->provider
->flush
);
436 if(mgr
->provider
->flush
)
437 mgr
->provider
->flush(mgr
->provider
);
442 pb_slab_manager_destroy(struct pb_manager
*_mgr
)
444 struct pb_slab_manager
*mgr
= pb_slab_manager(_mgr
);
446 /* TODO: cleanup all allocated buffers */
452 pb_slab_manager_create(struct pb_manager
*provider
,
455 const struct pb_desc
*desc
)
457 struct pb_slab_manager
*mgr
;
459 mgr
= CALLOC_STRUCT(pb_slab_manager
);
463 mgr
->base
.destroy
= pb_slab_manager_destroy
;
464 mgr
->base
.create_buffer
= pb_slab_manager_create_buffer
;
465 mgr
->base
.flush
= pb_slab_manager_flush
;
467 mgr
->provider
= provider
;
468 mgr
->bufSize
= bufSize
;
469 mgr
->slabSize
= slabSize
;
472 LIST_INITHEAD(&mgr
->slabs
);
474 pipe_mutex_init(mgr
->mutex
);
480 static struct pb_buffer
*
481 pb_slab_range_manager_create_buffer(struct pb_manager
*_mgr
,
483 const struct pb_desc
*desc
)
485 struct pb_slab_range_manager
*mgr
= pb_slab_range_manager(_mgr
);
489 bufSize
= mgr
->minBufSize
;
490 for (i
= 0; i
< mgr
->numBuckets
; ++i
) {
492 return mgr
->buckets
[i
]->create_buffer(mgr
->buckets
[i
], size
, desc
);
496 /* Fall back to allocate a buffer object directly from the provider. */
497 return mgr
->provider
->create_buffer(mgr
->provider
, size
, desc
);
502 pb_slab_range_manager_flush(struct pb_manager
*_mgr
)
504 struct pb_slab_range_manager
*mgr
= pb_slab_range_manager(_mgr
);
506 /* Individual slabs don't hold any temporary buffers so no need to call them */
508 assert(mgr
->provider
->flush
);
509 if(mgr
->provider
->flush
)
510 mgr
->provider
->flush(mgr
->provider
);
515 pb_slab_range_manager_destroy(struct pb_manager
*_mgr
)
517 struct pb_slab_range_manager
*mgr
= pb_slab_range_manager(_mgr
);
520 for (i
= 0; i
< mgr
->numBuckets
; ++i
)
521 mgr
->buckets
[i
]->destroy(mgr
->buckets
[i
]);
523 FREE(mgr
->bucketSizes
);
529 pb_slab_range_manager_create(struct pb_manager
*provider
,
533 const struct pb_desc
*desc
)
535 struct pb_slab_range_manager
*mgr
;
542 mgr
= CALLOC_STRUCT(pb_slab_range_manager
);
546 mgr
->base
.destroy
= pb_slab_range_manager_destroy
;
547 mgr
->base
.create_buffer
= pb_slab_range_manager_create_buffer
;
548 mgr
->base
.flush
= pb_slab_range_manager_flush
;
550 mgr
->provider
= provider
;
551 mgr
->minBufSize
= minBufSize
;
552 mgr
->maxBufSize
= maxBufSize
;
555 bufSize
= minBufSize
;
556 while(bufSize
< maxBufSize
) {
561 mgr
->buckets
= CALLOC(mgr
->numBuckets
, sizeof(*mgr
->buckets
));
565 bufSize
= minBufSize
;
566 for (i
= 0; i
< mgr
->numBuckets
; ++i
) {
567 mgr
->buckets
[i
] = pb_slab_manager_create(provider
, bufSize
, slabSize
, desc
);
576 for (i
= 0; i
< mgr
->numBuckets
; ++i
)
578 mgr
->buckets
[i
]->destroy(mgr
->buckets
[i
]);