1 /**************************************************************************
3 * Copyright 2009 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 **************************************************************************/
28 /* Helper utility for uploading user buffers & other data, and
29 * coalescing small buffers into larger ones.
32 #include "pipe/p_defines.h"
33 #include "util/u_inlines.h"
34 #include "pipe/p_context.h"
35 #include "util/u_memory.h"
36 #include "util/u_math.h"
38 #include "u_upload_mgr.h"
42 struct pipe_context
*pipe
;
44 unsigned default_size
; /* Minimum size of the upload buffer, in bytes. */
45 unsigned alignment
; /* Alignment of each sub-allocation. */
46 unsigned bind
; /* Bitmask of PIPE_BIND_* flags. */
48 struct pipe_resource
*buffer
; /* Upload buffer. */
49 struct pipe_transfer
*transfer
; /* Transfer object for the upload buffer. */
50 uint8_t *map
; /* Pointer to the mapped upload buffer. */
51 unsigned size
; /* Actual size of the upload buffer. */
52 unsigned offset
; /* Aligned offset to the upload buffer, pointing
53 * at the first unused byte. */
57 struct u_upload_mgr
*u_upload_create( struct pipe_context
*pipe
,
58 unsigned default_size
,
62 struct u_upload_mgr
*upload
= CALLOC_STRUCT( u_upload_mgr
);
67 upload
->default_size
= default_size
;
68 upload
->alignment
= alignment
;
70 upload
->buffer
= NULL
;
75 void u_upload_unmap( struct u_upload_mgr
*upload
)
77 if (upload
->transfer
) {
78 struct pipe_box
*box
= &upload
->transfer
->box
;
79 if (upload
->offset
> box
->x
) {
81 pipe_buffer_flush_mapped_range(upload
->pipe
, upload
->transfer
,
82 box
->x
, upload
->offset
- box
->x
);
84 pipe_transfer_unmap(upload
->pipe
, upload
->transfer
);
85 pipe_transfer_destroy(upload
->pipe
, upload
->transfer
);
86 upload
->transfer
= NULL
;
91 /* Release old buffer.
93 * This must usually be called prior to firing the command stream
94 * which references the upload buffer, as many memory managers will
95 * cause subsequent maps of a fired buffer to wait.
97 * Can improve this with a change to pipe_buffer_write to use the
98 * DONT_WAIT bit, but for now, it's easiest just to grab a new buffer.
100 void u_upload_flush( struct u_upload_mgr
*upload
)
102 /* Unmap and unreference the upload buffer. */
103 u_upload_unmap(upload
);
104 pipe_resource_reference( &upload
->buffer
, NULL
);
109 void u_upload_destroy( struct u_upload_mgr
*upload
)
111 u_upload_flush( upload
);
116 static enum pipe_error
117 u_upload_alloc_buffer( struct u_upload_mgr
*upload
,
122 /* Release the old buffer, if present:
124 u_upload_flush( upload
);
126 /* Allocate a new one:
128 size
= align(MAX2(upload
->default_size
, min_size
), 4096);
130 upload
->buffer
= pipe_buffer_create( upload
->pipe
->screen
,
134 if (upload
->buffer
== NULL
) {
135 return PIPE_ERROR_OUT_OF_MEMORY
;
138 /* Map the new buffer. */
139 upload
->map
= pipe_buffer_map_range(upload
->pipe
, upload
->buffer
,
141 PIPE_TRANSFER_WRITE
|
142 PIPE_TRANSFER_FLUSH_EXPLICIT
,
144 if (upload
->map
== NULL
) {
146 pipe_resource_reference(&upload
->buffer
, NULL
);
147 return PIPE_ERROR_OUT_OF_MEMORY
;
156 enum pipe_error
u_upload_alloc( struct u_upload_mgr
*upload
,
157 unsigned min_out_offset
,
159 unsigned *out_offset
,
160 struct pipe_resource
**outbuf
,
163 unsigned alloc_size
= align( size
, upload
->alignment
);
164 unsigned alloc_offset
= align(min_out_offset
, upload
->alignment
);
167 /* Make sure we have enough space in the upload buffer
168 * for the sub-allocation. */
169 if (MAX2(upload
->offset
, alloc_offset
) + alloc_size
> upload
->size
) {
170 enum pipe_error ret
= u_upload_alloc_buffer(upload
,
171 alloc_offset
+ alloc_size
);
176 offset
= MAX2(upload
->offset
, alloc_offset
);
179 upload
->map
= pipe_buffer_map_range(upload
->pipe
, upload
->buffer
,
180 offset
, upload
->size
- offset
,
181 PIPE_TRANSFER_WRITE
|
182 PIPE_TRANSFER_FLUSH_EXPLICIT
|
183 PIPE_TRANSFER_UNSYNCHRONIZED
,
186 pipe_resource_reference(outbuf
, NULL
);
188 return PIPE_ERROR_OUT_OF_MEMORY
;
191 upload
->map
-= offset
;
194 assert(offset
< upload
->buffer
->width0
);
195 assert(offset
+ size
<= upload
->buffer
->width0
);
198 /* Emit the return values: */
199 *ptr
= upload
->map
+ offset
;
200 pipe_resource_reference( outbuf
, upload
->buffer
);
201 *out_offset
= offset
;
203 upload
->offset
= offset
+ alloc_size
;
207 enum pipe_error
u_upload_data( struct u_upload_mgr
*upload
,
208 unsigned min_out_offset
,
211 unsigned *out_offset
,
212 struct pipe_resource
**outbuf
)
215 enum pipe_error ret
= u_upload_alloc(upload
, min_out_offset
, size
,
221 memcpy(ptr
, data
, size
);
226 /* As above, but upload the full contents of a buffer. Useful for
227 * uploading user buffers, avoids generating an explosion of GPU
228 * buffers if you have an app that does lots of small vertex buffer
229 * renders or DrawElements calls.
231 enum pipe_error
u_upload_buffer( struct u_upload_mgr
*upload
,
232 unsigned min_out_offset
,
235 struct pipe_resource
*inbuf
,
236 unsigned *out_offset
,
237 struct pipe_resource
**outbuf
)
239 enum pipe_error ret
= PIPE_OK
;
240 struct pipe_transfer
*transfer
= NULL
;
241 const char *map
= NULL
;
243 map
= (const char *)pipe_buffer_map_range(upload
->pipe
,
250 return PIPE_ERROR_OUT_OF_MEMORY
;
254 debug_printf("upload ptr %p ofs %d sz %d\n", map
, offset
, size
);
256 ret
= u_upload_data( upload
,
263 pipe_buffer_unmap( upload
->pipe
, transfer
);