1 /**************************************************************************
3 * Copyright 2007 VMware, Inc.
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 VMWARE 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 <jfonseca@vmware.com>
47 #include "pipe/p_compiler.h"
48 #include "util/u_debug.h"
49 #include "util/u_inlines.h"
50 #include "pipe/p_defines.h"
60 struct pipe_fence_handle
;
63 #define PB_USAGE_CPU_READ (1 << 0)
64 #define PB_USAGE_CPU_WRITE (1 << 1)
65 #define PB_USAGE_GPU_READ (1 << 2)
66 #define PB_USAGE_GPU_WRITE (1 << 3)
67 #define PB_USAGE_UNSYNCHRONIZED (1 << 10)
68 #define PB_USAGE_DONTBLOCK (1 << 9)
70 #define PB_USAGE_CPU_READ_WRITE \
71 ( PB_USAGE_CPU_READ | PB_USAGE_CPU_WRITE )
72 #define PB_USAGE_GPU_READ_WRITE \
73 ( PB_USAGE_GPU_READ | PB_USAGE_GPU_WRITE )
74 #define PB_USAGE_WRITE \
75 ( PB_USAGE_CPU_WRITE | PB_USAGE_GPU_WRITE )
80 * Used when allocating the buffer.
90 * Size. Regular (32bit) unsigned for now.
92 typedef unsigned pb_size
;
96 * Base class for all pb_* buffers.
100 struct pipe_reference reference
;
106 * Pointer to the virtual function table.
108 * Avoid accessing this table directly. Use the inline functions below
109 * instead to avoid mistakes.
111 const struct pb_vtbl
*vtbl
;
116 * Virtual function table for the buffer storage operations.
118 * Note that creation is not done through this table.
122 void (*destroy
)( struct pb_buffer
*buf
);
125 * Map the entire data store of a buffer object into the client's address.
126 * flags is bitmask of PB_USAGE_CPU_READ/WRITE.
128 void *(*map
)( struct pb_buffer
*buf
,
129 unsigned flags
, void *flush_ctx
);
131 void (*unmap
)( struct pb_buffer
*buf
);
133 enum pipe_error (*validate
)( struct pb_buffer
*buf
,
134 struct pb_validate
*vl
,
137 void (*fence
)( struct pb_buffer
*buf
,
138 struct pipe_fence_handle
*fence
);
141 * Get the base buffer and the offset.
143 * A buffer can be subdivided in smaller buffers. This method should return
144 * the underlaying buffer, and the relative offset.
146 * Buffers without an underlaying base buffer should return themselves, with
149 * Note that this will increase the reference count of the base buffer.
151 void (*get_base_buffer
)( struct pb_buffer
*buf
,
152 struct pb_buffer
**base_buf
,
159 /* Accessor functions for pb->vtbl:
162 pb_map(struct pb_buffer
*buf
,
163 unsigned flags
, void *flush_ctx
)
168 assert(pipe_is_referenced(&buf
->reference
));
169 return buf
->vtbl
->map(buf
, flags
, flush_ctx
);
174 pb_unmap(struct pb_buffer
*buf
)
179 assert(pipe_is_referenced(&buf
->reference
));
180 buf
->vtbl
->unmap(buf
);
185 pb_get_base_buffer( struct pb_buffer
*buf
,
186 struct pb_buffer
**base_buf
,
195 assert(pipe_is_referenced(&buf
->reference
));
196 assert(buf
->vtbl
->get_base_buffer
);
197 buf
->vtbl
->get_base_buffer(buf
, base_buf
, offset
);
199 assert(*offset
< (*base_buf
)->size
);
203 static inline enum pipe_error
204 pb_validate(struct pb_buffer
*buf
, struct pb_validate
*vl
, unsigned flags
)
209 assert(buf
->vtbl
->validate
);
210 return buf
->vtbl
->validate(buf
, vl
, flags
);
215 pb_fence(struct pb_buffer
*buf
, struct pipe_fence_handle
*fence
)
220 assert(buf
->vtbl
->fence
);
221 buf
->vtbl
->fence(buf
, fence
);
226 pb_destroy(struct pb_buffer
*buf
)
231 assert(!pipe_is_referenced(&buf
->reference
));
232 buf
->vtbl
->destroy(buf
);
236 pb_reference(struct pb_buffer
**dst
,
237 struct pb_buffer
*src
)
239 struct pb_buffer
*old
= *dst
;
241 if (pipe_reference(&(*dst
)->reference
, &src
->reference
))
248 * Utility function to check whether the provided alignment is consistent with
249 * the requested or not.
251 static inline boolean
252 pb_check_alignment(pb_size requested
, pb_size provided
)
256 if(requested
> provided
)
258 if(provided
% requested
!= 0)
265 * Utility function to check whether the provided alignment is consistent with
266 * the requested or not.
268 static inline boolean
269 pb_check_usage(unsigned requested
, unsigned provided
)
271 return (requested
& provided
) == requested
? TRUE
: FALSE
;
276 * Malloc-based buffer to store data that can't be used by the graphics
280 pb_malloc_buffer_create(pb_size size
,
281 const struct pb_desc
*desc
);
288 #endif /*PB_BUFFER_H_*/