pb_bufmgr.h revision 0c5b1a8ffb21f72fcde64a7daa13d5dab5b90425 
1/**************************************************************************
2 *
3 * Copyright 2007 Tungsten Graphics, Inc., Cedar Park, Texas.
4 * All Rights Reserved.
5 *
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:
13 *
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
16 * of the Software.
17 *
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.
25 *
26 **************************************************************************/
27
28/**
29 * \file
30 * Buffer management.
31 *
32 * A buffer manager does only one basic thing: it creates buffers. Actually,
33 * "buffer factory" would probably a more accurate description.
34 *
35 * You can chain buffer managers so that you can have a finer grained memory
36 * management and pooling.
37 *
38 * For example, for a simple batch buffer manager you would chain:
39 * - the native buffer manager, which provides DMA memory from the graphics
40 * memory space;
41 * - the pool buffer manager, which keep around a pool of equally sized buffers
42 * to avoid latency associated with the native buffer manager;
43 * - the fenced buffer manager, which will delay buffer destruction until the
44 * the moment the card finishing processing it.
45 *
46 * \author José Fonseca <jrfonseca@tungstengraphics.com>
47 */
48
49#ifndef PB_BUFMGR_H_
50#define PB_BUFMGR_H_
51
52
53#include "pipe/p_compiler.h"
54#include "pipe/p_error.h"
55
56
57#ifdef __cplusplus
58extern "C" {
59#endif
60
61
62struct pb_desc;
63struct pipe_buffer;
64struct pipe_winsys;
65
66
67/**
68 * Abstract base class for all buffer managers.
69 */
70struct pb_manager
71{
72   struct pb_buffer *
73   (*create_buffer)( struct pb_manager *mgr,
74	             size_t size,
75	             const struct pb_desc *desc);
76
77   void
78   (*destroy)( struct pb_manager *mgr );
79};
80
81
82/**
83 * Malloc buffer provider.
84 *
85 * Simple wrapper around pb_malloc_buffer_create for convenience.
86 */
87struct pb_manager *
88pb_malloc_bufmgr_create(void);
89
90
91/**
92 * Static buffer pool sub-allocator.
93 *
94 * Manages the allocation of equally sized buffers. It does so by allocating
95 * a single big buffer and divide it equally sized buffers.
96 *
97 * It is meant to manage the allocation of batch buffer pools.
98 */
99struct pb_manager *
100pool_bufmgr_create(struct pb_manager *provider,
101                   size_t n, size_t size,
102                   const struct pb_desc *desc);
103
104
105/**
106 * Static sub-allocator based the old memory manager.
107 *
108 * It managers buffers of different sizes. It does so by allocating a buffer
109 * with the size of the heap, and then using the old mm memory manager to manage
110 * that heap.
111 */
112struct pb_manager *
113mm_bufmgr_create(struct pb_manager *provider,
114                 size_t size, size_t align2);
115
116/**
117 * Same as mm_bufmgr_create.
118 *
119 * Buffer will be release when the manager is destroyed.
120 */
121struct pb_manager *
122mm_bufmgr_create_from_buffer(struct pb_buffer *buffer,
123                             size_t size, size_t align2);
124
125
126/**
127 * Slab sub-allocator.
128 */
129struct pb_manager *
130pb_slab_manager_create(struct pb_manager *provider,
131                       size_t bufSize,
132                       size_t slabSize,
133                       const struct pb_desc *desc);
134
135/**
136 * Allow a range of buffer size, by aggregating multiple slabs sub-allocators
137 * with different bucket sizes.
138 */
139struct pb_manager *
140pb_slab_range_manager_create(struct pb_manager *provider,
141                             size_t minBufSize,
142                             size_t maxBufSize,
143                             size_t slabSize,
144                             const struct pb_desc *desc);
145
146
147/**
148 * Time-based buffer cache.
149 *
150 * This manager keeps a cache of destroyed buffers during a time interval.
151 */
152struct pb_manager *
153pb_cache_manager_create(struct pb_manager *provider,
154                     	unsigned usecs);
155
156void
157pb_cache_flush(struct pb_manager *mgr);
158
159
160/**
161 * Fenced buffer manager.
162 *
163 * This manager is just meant for convenience. It wraps the buffers returned
164 * by another manager in fenced buffers, so that
165 *
166 * NOTE: the buffer manager that provides the buffers will be destroyed
167 * at the same time.
168 */
169struct pb_manager *
170fenced_bufmgr_create(struct pb_manager *provider,
171                     struct pipe_winsys *winsys);
172
173
174struct pb_manager *
175pb_alt_manager_create(struct pb_manager *provider1,
176                      struct pb_manager *provider2);
177
178
179#ifdef __cplusplus
180}
181#endif
182
183#endif /*PB_BUFMGR_H_*/
184