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 "pipe/p_debug.h"
49 #include "pipe/p_error.h"
50 #include "pipe/p_state.h"
51 #include "pipe/p_inlines.h"
66 * Used when allocating the buffer.
76 * Base class for all pb_* buffers.
80 struct pipe_buffer base;
83 * Pointer to the virtual function table.
85 * Avoid accessing this table directly. Use the inline functions below
86 * instead to avoid mistakes.
88 const struct pb_vtbl *vtbl;
93 * Virtual function table for the buffer storage operations.
95 * Note that creation is not done through this table.
99 void (*destroy)( struct pb_buffer *buf );
102 * Map the entire data store of a buffer object into the client's address.
103 * flags is bitmask of PIPE_BUFFER_FLAG_READ/WRITE.
105 void *(*map)( struct pb_buffer *buf,
108 void (*unmap)( struct pb_buffer *buf );
110 enum pipe_error (*validate)( struct pb_buffer *buf,
111 struct pb_validate *vl,
114 void (*fence)( struct pb_buffer *buf,
115 struct pipe_fence_handle *fence );
118 * Get the base buffer and the offset.
120 * A buffer can be subdivided in smaller buffers. This method should return
121 * the underlaying buffer, and the relative offset.
123 * Buffers without an underlaying base buffer should return themselves, with
126 * Note that this will increase the reference count of the base buffer.
128 void (*get_base_buffer)( struct pb_buffer *buf,
129 struct pb_buffer **base_buf,
135 static INLINE struct pipe_buffer *
136 pb_pipe_buffer( struct pb_buffer *pbuf )
143 static INLINE struct pb_buffer *
144 pb_buffer( struct pipe_buffer *buf )
147 /* Could add a magic cookie check on debug builds.
149 return (struct pb_buffer *)buf;
153 /* Accessor functions for pb->vtbl:
156 pb_map(struct pb_buffer *buf,
162 return buf->vtbl->map(buf, flags);
167 pb_unmap(struct pb_buffer *buf)
172 buf->vtbl->unmap(buf);
177 pb_get_base_buffer( struct pb_buffer *buf,
178 struct pb_buffer **base_buf,
187 assert(buf->vtbl->get_base_buffer);
188 buf->vtbl->get_base_buffer(buf, base_buf, offset);
192 static INLINE enum pipe_error
193 pb_validate(struct pb_buffer *buf, struct pb_validate *vl, unsigned flags)
198 assert(buf->vtbl->validate);
199 return buf->vtbl->validate(buf, vl, flags);
204 pb_fence(struct pb_buffer *buf, struct pipe_fence_handle *fence)
209 assert(buf->vtbl->fence);
210 buf->vtbl->fence(buf, fence);
215 pb_destroy(struct pb_buffer *buf)
220 assert(buf->base.refcount == 0);
221 buf->vtbl->destroy(buf);
225 /* XXX: thread safety issues!
228 pb_reference(struct pb_buffer **dst,
229 struct pb_buffer *src)
232 assert(src->base.refcount);
233 src->base.refcount++;
237 assert((*dst)->base.refcount);
238 if(--(*dst)->base.refcount == 0)
247 * Utility function to check whether the provided alignment is consistent with
248 * the requested or not.
250 static INLINE boolean
251 pb_check_alignment(size_t requested, size_t provided)
253 return requested <= provided && (provided % requested) == 0 ? TRUE : FALSE;
258 * Utility function to check whether the provided alignment is consistent with
259 * the requested or not.
261 static INLINE boolean
262 pb_check_usage(unsigned requested, unsigned provided)
264 return (requested & provided) == requested ? TRUE : FALSE;
269 * Malloc-based buffer to store data that can't be used by the graphics
273 pb_malloc_buffer_create(size_t size,
274 const struct pb_desc *desc);
278 pb_init_winsys(struct pipe_winsys *winsys);
285 #endif /*PB_BUFFER_H_*/