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 **************************************************************************/
30 * Generic code for buffers.
32 * Behind a pipe buffle handle there can be DMA buffers, client (or user)
33 * buffers, regular malloced buffers, etc. This file provides an abstract base
34 * buffer handle that allows the driver to cope with all those kinds of buffers
35 * in a more flexible way.
37 * There is no obligation of a winsys driver to use this library. And a pipe
38 * driver should be completly agnostic about it.
40 * \author Jose Fonseca <jrfonseca@tungstengraphics.com>
47 #include "pipe/p_compiler.h"
48 #include "util/u_debug.h"
49 #include "pipe/p_defines.h"
50 #include "pipe/p_state.h"
65 * Used when allocating the buffer.
75 * Size. Regular (32bit) unsigned for now.
77 typedef unsigned pb_size
;
81 * Base class for all pb_* buffers.
85 struct pipe_buffer base
;
88 * Pointer to the virtual function table.
90 * Avoid accessing this table directly. Use the inline functions below
91 * instead to avoid mistakes.
93 const struct pb_vtbl
*vtbl
;
98 * Virtual function table for the buffer storage operations.
100 * Note that creation is not done through this table.
104 void (*destroy
)( struct pb_buffer
*buf
);
107 * Map the entire data store of a buffer object into the client's address.
108 * flags is bitmask of PIPE_BUFFER_FLAG_READ/WRITE.
110 void *(*map
)( struct pb_buffer
*buf
,
113 void (*unmap
)( struct pb_buffer
*buf
);
115 enum pipe_error (*validate
)( struct pb_buffer
*buf
,
116 struct pb_validate
*vl
,
119 void (*fence
)( struct pb_buffer
*buf
,
120 struct pipe_fence_handle
*fence
);
123 * Get the base buffer and the offset.
125 * A buffer can be subdivided in smaller buffers. This method should return
126 * the underlaying buffer, and the relative offset.
128 * Buffers without an underlaying base buffer should return themselves, with
131 * Note that this will increase the reference count of the base buffer.
133 void (*get_base_buffer
)( struct pb_buffer
*buf
,
134 struct pb_buffer
**base_buf
,
140 static INLINE
struct pipe_buffer
*
141 pb_pipe_buffer( struct pb_buffer
*pbuf
)
148 static INLINE
struct pb_buffer
*
149 pb_buffer( struct pipe_buffer
*buf
)
152 /* Could add a magic cookie check on debug builds.
154 return (struct pb_buffer
*)buf
;
158 /* Accessor functions for pb->vtbl:
161 pb_map(struct pb_buffer
*buf
,
167 assert(pipe_is_referenced(&buf
->base
.reference
));
168 return buf
->vtbl
->map(buf
, flags
);
173 pb_unmap(struct pb_buffer
*buf
)
178 assert(pipe_is_referenced(&buf
->base
.reference
));
179 buf
->vtbl
->unmap(buf
);
184 pb_get_base_buffer( struct pb_buffer
*buf
,
185 struct pb_buffer
**base_buf
,
194 assert(pipe_is_referenced(&buf
->base
.reference
));
195 assert(buf
->vtbl
->get_base_buffer
);
196 buf
->vtbl
->get_base_buffer(buf
, base_buf
, offset
);
198 assert(*offset
< (*base_buf
)->base
.size
);
202 static INLINE
enum pipe_error
203 pb_validate(struct pb_buffer
*buf
, struct pb_validate
*vl
, unsigned flags
)
208 assert(buf
->vtbl
->validate
);
209 return buf
->vtbl
->validate(buf
, vl
, flags
);
214 pb_fence(struct pb_buffer
*buf
, struct pipe_fence_handle
*fence
)
219 assert(buf
->vtbl
->fence
);
220 buf
->vtbl
->fence(buf
, fence
);
225 pb_destroy(struct pb_buffer
*buf
)
230 assert(!pipe_is_referenced(&buf
->base
.reference
));
231 buf
->vtbl
->destroy(buf
);
235 pb_reference(struct pb_buffer
**dst
,
236 struct pb_buffer
*src
)
238 struct pb_buffer
*old
= *dst
;
240 if (pipe_reference((struct pipe_reference
**)dst
, &src
->base
.reference
))
246 * Utility function to check whether the provided alignment is consistent with
247 * the requested or not.
249 static INLINE boolean
250 pb_check_alignment(pb_size requested
, pb_size provided
)
254 if(requested
> provided
)
256 if(provided
% requested
!= 0)
263 * Utility function to check whether the provided alignment is consistent with
264 * the requested or not.
266 static INLINE boolean
267 pb_check_usage(unsigned requested
, unsigned provided
)
269 return (requested
& provided
) == requested
? TRUE
: FALSE
;
274 * Malloc-based buffer to store data that can't be used by the graphics
278 pb_malloc_buffer_create(pb_size size
,
279 const struct pb_desc
*desc
);
286 #endif /*PB_BUFFER_H_*/