1 /**************************************************************************
3 * Copyright 2007 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 * A buffer manager does only one basic thing: it creates buffers. Actually,
33 * "buffer factory" would probably a more accurate description.
35 * You can chain buffer managers so that you can have a finer grained memory
36 * management and pooling.
38 * For example, for a simple batch buffer manager you would chain:
39 * - the native buffer manager, which provides DMA memory from the graphics
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.
46 * \author Jose Fonseca <jrfonseca@tungstengraphics.com>
53 #include "pipe/p_compiler.h"
54 #include "pipe/p_error.h"
68 * Abstract base class for all buffer managers.
73 (*destroy
)( struct pb_manager
*mgr
);
76 (*create_buffer
)( struct pb_manager
*mgr
,
78 const struct pb_desc
*desc
);
81 * Flush all temporary-held buffers.
83 * Used mostly to aid debugging memory issues or to clean up resources when
84 * the drivers are long lived.
87 (*flush
)( struct pb_manager
*mgr
);
92 * Malloc buffer provider.
94 * Simple wrapper around pb_malloc_buffer_create for convenience.
97 pb_malloc_bufmgr_create(void);
101 * Static buffer pool sub-allocator.
103 * Manages the allocation of equally sized buffers. It does so by allocating
104 * a single big buffer and divide it equally sized buffers.
106 * It is meant to manage the allocation of batch buffer pools.
109 pool_bufmgr_create(struct pb_manager
*provider
,
110 size_t n
, size_t size
,
111 const struct pb_desc
*desc
);
115 * Static sub-allocator based the old memory manager.
117 * It managers buffers of different sizes. It does so by allocating a buffer
118 * with the size of the heap, and then using the old mm memory manager to manage
122 mm_bufmgr_create(struct pb_manager
*provider
,
123 size_t size
, size_t align2
);
126 * Same as mm_bufmgr_create.
128 * Buffer will be release when the manager is destroyed.
131 mm_bufmgr_create_from_buffer(struct pb_buffer
*buffer
,
132 size_t size
, size_t align2
);
136 * Slab sub-allocator.
139 pb_slab_manager_create(struct pb_manager
*provider
,
142 const struct pb_desc
*desc
);
145 * Allow a range of buffer size, by aggregating multiple slabs sub-allocators
146 * with different bucket sizes.
149 pb_slab_range_manager_create(struct pb_manager
*provider
,
153 const struct pb_desc
*desc
);
157 * Time-based buffer cache.
159 * This manager keeps a cache of destroyed buffers during a time interval.
162 pb_cache_manager_create(struct pb_manager
*provider
,
167 * Fenced buffer manager.
169 * This manager is just meant for convenience. It wraps the buffers returned
170 * by another manager in fenced buffers, so that
172 * NOTE: the buffer manager that provides the buffers will be destroyed
176 fenced_bufmgr_create(struct pb_manager
*provider
,
177 struct pipe_winsys
*winsys
);
181 pb_alt_manager_create(struct pb_manager
*provider1
,
182 struct pb_manager
*provider2
);
186 * Ondemand buffer manager.
188 * Buffers are created in malloc'ed memory (fast and cached), and the constents
189 * is transfered to a buffer from the provider (typically in slow uncached
190 * memory) when there is an attempt to validate the buffer.
192 * Ideal for situations where one does not know before hand whether a given
193 * buffer will effectively be used by the hardware or not.
196 pb_ondemand_manager_create(struct pb_manager
*provider
);
200 * Debug buffer manager to detect buffer under- and overflows.
202 * Band size should be a multiple of the largest alignment
205 pb_debug_manager_create(struct pb_manager
*provider
, size_t band_size
);
212 #endif /*PB_BUFMGR_H_*/