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"
67 * Abstract base class for all buffer managers.
72 (*destroy
)( struct pb_manager
*mgr
);
75 (*create_buffer
)( struct pb_manager
*mgr
,
77 const struct pb_desc
*desc
);
80 * Flush all temporary-held buffers.
82 * Used mostly to aid debugging memory issues or to clean up resources when
83 * the drivers are long lived.
86 (*flush
)( struct pb_manager
*mgr
);
91 * Malloc buffer provider.
93 * Simple wrapper around pb_malloc_buffer_create for convenience.
96 pb_malloc_bufmgr_create(void);
100 * Static buffer pool sub-allocator.
102 * Manages the allocation of equally sized buffers. It does so by allocating
103 * a single big buffer and divide it equally sized buffers.
105 * It is meant to manage the allocation of batch buffer pools.
108 pool_bufmgr_create(struct pb_manager
*provider
,
109 size_t n
, size_t size
,
110 const struct pb_desc
*desc
);
114 * Static sub-allocator based the old memory manager.
116 * It managers buffers of different sizes. It does so by allocating a buffer
117 * with the size of the heap, and then using the old mm memory manager to manage
121 mm_bufmgr_create(struct pb_manager
*provider
,
122 size_t size
, size_t align2
);
125 * Same as mm_bufmgr_create.
127 * Buffer will be release when the manager is destroyed.
130 mm_bufmgr_create_from_buffer(struct pb_buffer
*buffer
,
131 size_t size
, size_t align2
);
135 * Slab sub-allocator.
138 pb_slab_manager_create(struct pb_manager
*provider
,
141 const struct pb_desc
*desc
);
144 * Allow a range of buffer size, by aggregating multiple slabs sub-allocators
145 * with different bucket sizes.
148 pb_slab_range_manager_create(struct pb_manager
*provider
,
152 const struct pb_desc
*desc
);
156 * Time-based buffer cache.
158 * This manager keeps a cache of destroyed buffers during a time interval.
161 pb_cache_manager_create(struct pb_manager
*provider
,
168 * Fenced buffer manager.
170 * This manager is just meant for convenience. It wraps the buffers returned
171 * by another manager in fenced buffers, so that
173 * NOTE: the buffer manager that provides the buffers will be destroyed
177 fenced_bufmgr_create(struct pb_manager
*provider
,
178 struct pb_fence_ops
*ops
);
182 pb_alt_manager_create(struct pb_manager
*provider1
,
183 struct pb_manager
*provider2
);
187 * Ondemand buffer manager.
189 * Buffers are created in malloc'ed memory (fast and cached), and the constents
190 * is transfered to a buffer from the provider (typically in slow uncached
191 * memory) when there is an attempt to validate the buffer.
193 * Ideal for situations where one does not know before hand whether a given
194 * buffer will effectively be used by the hardware or not.
197 pb_ondemand_manager_create(struct pb_manager
*provider
);
201 * Debug buffer manager to detect buffer under- and overflows.
203 * Under/overflow sizes should be a multiple of the largest alignment
206 pb_debug_manager_create(struct pb_manager
*provider
,
207 size_t underflow_size
, size_t overflow_size
);
214 #endif /*PB_BUFMGR_H_*/