pb_bufmgr.h revision 7822f99193cd26558bff29ff8d6d23db2d3a1048 
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 Jose Fonseca <jrfonseca@tungstengraphics.com>
47 */
48
49#ifndef PB_BUFMGR_H_
50#define PB_BUFMGR_H_
51
52
53#include "pb_buffer.h"
54
55
56#ifdef __cplusplus
57extern "C" {
58#endif
59
60
61struct pb_desc;
62
63
64/**
65 * Abstract base class for all buffer managers.
66 */
67struct pb_manager
68{
69   void
70   (*destroy)( struct pb_manager *mgr );
71
72   struct pb_buffer *
73   (*create_buffer)( struct pb_manager *mgr,
74	             pb_size size,
75	             const struct pb_desc *desc);
76
77   /**
78    * Flush all temporary-held buffers.
79    *
80    * Used mostly to aid debugging memory issues or to clean up resources when
81    * the drivers are long lived.
82    */
83   void
84   (*flush)( struct pb_manager *mgr );
85};
86
87
88/**
89 * Malloc buffer provider.
90 *
91 * Simple wrapper around pb_malloc_buffer_create for convenience.
92 */
93struct pb_manager *
94pb_malloc_bufmgr_create(void);
95
96
97/**
98 * Static buffer pool sub-allocator.
99 *
100 * Manages the allocation of equally sized buffers. It does so by allocating
101 * a single big buffer and divide it equally sized buffers.
102 *
103 * It is meant to manage the allocation of batch buffer pools.
104 */
105struct pb_manager *
106pool_bufmgr_create(struct pb_manager *provider,
107                   pb_size n, pb_size size,
108                   const struct pb_desc *desc);
109
110
111/**
112 * Static sub-allocator based the old memory manager.
113 *
114 * It managers buffers of different sizes. It does so by allocating a buffer
115 * with the size of the heap, and then using the old mm memory manager to manage
116 * that heap.
117 */
118struct pb_manager *
119mm_bufmgr_create(struct pb_manager *provider,
120                 pb_size size, pb_size align2);
121
122/**
123 * Same as mm_bufmgr_create.
124 *
125 * Buffer will be release when the manager is destroyed.
126 */
127struct pb_manager *
128mm_bufmgr_create_from_buffer(struct pb_buffer *buffer,
129                             pb_size size, pb_size align2);
130
131
132/**
133 * Slab sub-allocator.
134 */
135struct pb_manager *
136pb_slab_manager_create(struct pb_manager *provider,
137                       pb_size bufSize,
138                       pb_size slabSize,
139                       const struct pb_desc *desc);
140
141/**
142 * Allow a range of buffer size, by aggregating multiple slabs sub-allocators
143 * with different bucket sizes.
144 */
145struct pb_manager *
146pb_slab_range_manager_create(struct pb_manager *provider,
147                             pb_size minBufSize,
148                             pb_size maxBufSize,
149                             pb_size slabSize,
150                             const struct pb_desc *desc);
151
152
153/**
154 * Time-based buffer cache.
155 *
156 * This manager keeps a cache of destroyed buffers during a time interval.
157 */
158struct pb_manager *
159pb_cache_manager_create(struct pb_manager *provider,
160                     	unsigned usecs);
161
162
163struct pb_fence_ops;
164
165/**
166 * Fenced buffer manager.
167 *
168 * This manager is just meant for convenience. It wraps the buffers returned
169 * by another manager in fenced buffers, so that
170 *
171 * NOTE: the buffer manager that provides the buffers will be destroyed
172 * at the same time.
173 */
174struct pb_manager *
175fenced_bufmgr_create(struct pb_manager *provider,
176                     struct pb_fence_ops *ops,
177                     pb_size max_buffer_size,
178                     pb_size max_cpu_total_size);
179
180
181struct pb_manager *
182pb_alt_manager_create(struct pb_manager *provider1,
183                      struct pb_manager *provider2);
184
185
186/**
187 * Ondemand buffer manager.
188 *
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.
192 *
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.
195 */
196struct pb_manager *
197pb_ondemand_manager_create(struct pb_manager *provider);
198
199
200/**
201 * Debug buffer manager to detect buffer under- and overflows.
202 *
203 * Under/overflow sizes should be a multiple of the largest alignment
204 */
205struct pb_manager *
206pb_debug_manager_create(struct pb_manager *provider,
207                        pb_size underflow_size, pb_size overflow_size);
208
209
210#ifdef __cplusplus
211}
212#endif
213
214#endif /*PB_BUFMGR_H_*/
215