u_upload_mgr.c revision 8f6c207024c1458a70da3cbc9a9c9f48cf1a41df
1f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org/************************************************************************** 2f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * 3f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * Copyright 2009 VMware, Inc. 4f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * All Rights Reserved. 5f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * 6f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * Permission is hereby granted, free of charge, to any person obtaining a 7f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * copy of this software and associated documentation files (the 8f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * "Software"), to deal in the Software without restriction, including 9f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * without limitation the rights to use, copy, modify, merge, publish, 10f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * distribute, sub license, and/or sell copies of the Software, and to 11f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * permit persons to whom the Software is furnished to do so, subject to 12f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * the following conditions: 13f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * 14f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * The above copyright notice and this permission notice (including the 15f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * next paragraph) shall be included in all copies or substantial portions 16f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * of the Software. 17f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * 18f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS 19f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 20f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. 21f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS BE LIABLE FOR 22f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, 23f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 24f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 25f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * 26f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org **************************************************************************/ 27f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org 28f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org/* Helper utility for uploading user buffers & other data, and 29f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * coalescing small buffers into larger ones. 30f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org */ 31f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org 32f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org#include "pipe/p_defines.h" 33f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org#include "util/u_inlines.h" 34f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org#include "pipe/p_context.h" 35f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org#include "util/u_memory.h" 36f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org#include "util/u_math.h" 37f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org 38f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org#include "u_upload_mgr.h" 39f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org 40f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org 41f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.orgstruct u_upload_mgr { 42f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org struct pipe_context *pipe; 43f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org 44f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org unsigned default_size; /* Minimum size of the upload buffer, in bytes. */ 45f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org unsigned alignment; /* Alignment of each sub-allocation. */ 46f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org unsigned bind; /* Bitmask of PIPE_BIND_* flags. */ 47f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org 48f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org struct pipe_resource *buffer; /* Upload buffer. */ 49f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org struct pipe_transfer *transfer; /* Transfer object for the upload buffer. */ 50f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org uint8_t *map; /* Pointer to the mapped upload buffer. */ 51f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org unsigned size; /* Actual size of the upload buffer. */ 52f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org unsigned offset; /* Aligned offset to the upload buffer, pointing 53f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * at the first unused byte. */ 54f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org}; 55f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org 56f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org 57f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.orgstruct u_upload_mgr *u_upload_create( struct pipe_context *pipe, 58f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org unsigned default_size, 59f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org unsigned alignment, 60f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org unsigned bind ) 61f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org{ 62f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org struct u_upload_mgr *upload = CALLOC_STRUCT( u_upload_mgr ); 63f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org if (!upload) 64f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org return NULL; 65f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org 66f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org upload->pipe = pipe; 67f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org upload->default_size = default_size; 68f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org upload->alignment = alignment; 69f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org upload->bind = bind; 70f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org upload->buffer = NULL; 71f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org 72f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org return upload; 73f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org} 74f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org 75f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.orgvoid u_upload_unmap( struct u_upload_mgr *upload ) 76f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org{ 77f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org if (upload->transfer) { 78f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org struct pipe_box *box = &upload->transfer->box; 79f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org if (upload->offset > box->x) { 80f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org 81f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org pipe_buffer_flush_mapped_range(upload->pipe, upload->transfer, 82f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org box->x, upload->offset - box->x); 83f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org } 84f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org pipe_transfer_unmap(upload->pipe, upload->transfer); 85f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org pipe_transfer_destroy(upload->pipe, upload->transfer); 86f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org upload->transfer = NULL; 87 upload->map = NULL; 88 } 89} 90 91/* Release old buffer. 92 * 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. 96 * 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. 99 */ 100void u_upload_flush( struct u_upload_mgr *upload ) 101{ 102 /* Unmap and unreference the upload buffer. */ 103 u_upload_unmap(upload); 104 pipe_resource_reference( &upload->buffer, NULL ); 105 upload->size = 0; 106} 107 108 109void u_upload_destroy( struct u_upload_mgr *upload ) 110{ 111 u_upload_flush( upload ); 112 FREE( upload ); 113} 114 115 116static enum pipe_error 117u_upload_alloc_buffer( struct u_upload_mgr *upload, 118 unsigned min_size ) 119{ 120 unsigned size; 121 122 /* Release the old buffer, if present: 123 */ 124 u_upload_flush( upload ); 125 126 /* Allocate a new one: 127 */ 128 size = align(MAX2(upload->default_size, min_size), 4096); 129 130 upload->buffer = pipe_buffer_create( upload->pipe->screen, 131 upload->bind, 132 PIPE_USAGE_STREAM, 133 size ); 134 if (upload->buffer == NULL) 135 goto fail; 136 137 /* Map the new buffer. */ 138 upload->map = pipe_buffer_map_range(upload->pipe, upload->buffer, 139 0, size, 140 PIPE_TRANSFER_WRITE | 141 PIPE_TRANSFER_FLUSH_EXPLICIT, 142 &upload->transfer); 143 144 upload->size = size; 145 146 upload->offset = 0; 147 return 0; 148 149fail: 150 if (upload->buffer) 151 pipe_resource_reference( &upload->buffer, NULL ); 152 153 return PIPE_ERROR_OUT_OF_MEMORY; 154} 155 156enum pipe_error u_upload_alloc( struct u_upload_mgr *upload, 157 unsigned min_out_offset, 158 unsigned size, 159 unsigned *out_offset, 160 struct pipe_resource **outbuf, 161 boolean *flushed, 162 void **ptr ) 163{ 164 unsigned alloc_size = align( size, upload->alignment ); 165 unsigned alloc_offset = align(min_out_offset, upload->alignment); 166 unsigned offset; 167 168 /* Make sure we have enough space in the upload buffer 169 * for the sub-allocation. */ 170 if (MAX2(upload->offset, alloc_offset) + alloc_size > upload->size) { 171 enum pipe_error ret = u_upload_alloc_buffer(upload, 172 alloc_offset + alloc_size); 173 if (ret) 174 return ret; 175 176 *flushed = TRUE; 177 } else { 178 *flushed = FALSE; 179 } 180 181 offset = MAX2(upload->offset, alloc_offset); 182 183 if (!upload->map) { 184 upload->map = pipe_buffer_map_range(upload->pipe, upload->buffer, 185 offset, upload->size - offset, 186 PIPE_TRANSFER_WRITE | 187 PIPE_TRANSFER_FLUSH_EXPLICIT | 188 PIPE_TRANSFER_UNSYNCHRONIZED, 189 &upload->transfer); 190 } 191 192 assert(offset < upload->buffer->width0); 193 assert(offset + size <= upload->buffer->width0); 194 assert(size); 195 196 /* Emit the return values: */ 197 *ptr = upload->map + offset; 198 pipe_resource_reference( outbuf, upload->buffer ); 199 *out_offset = offset; 200 201 upload->offset = offset + alloc_size; 202 return PIPE_OK; 203} 204 205enum pipe_error u_upload_data( struct u_upload_mgr *upload, 206 unsigned min_out_offset, 207 unsigned size, 208 const void *data, 209 unsigned *out_offset, 210 struct pipe_resource **outbuf, 211 boolean *flushed ) 212{ 213 uint8_t *ptr; 214 enum pipe_error ret = u_upload_alloc(upload, min_out_offset, size, 215 out_offset, outbuf, flushed, 216 (void**)&ptr); 217 if (ret) 218 return ret; 219 220 memcpy(ptr, data, size); 221 return PIPE_OK; 222} 223 224 225/* As above, but upload the full contents of a buffer. Useful for 226 * uploading user buffers, avoids generating an explosion of GPU 227 * buffers if you have an app that does lots of small vertex buffer 228 * renders or DrawElements calls. 229 */ 230enum pipe_error u_upload_buffer( struct u_upload_mgr *upload, 231 unsigned min_out_offset, 232 unsigned offset, 233 unsigned size, 234 struct pipe_resource *inbuf, 235 unsigned *out_offset, 236 struct pipe_resource **outbuf, 237 boolean *flushed ) 238{ 239 enum pipe_error ret = PIPE_OK; 240 struct pipe_transfer *transfer = NULL; 241 const char *map = NULL; 242 243 map = (const char *)pipe_buffer_map_range(upload->pipe, 244 inbuf, 245 offset, size, 246 PIPE_TRANSFER_READ, 247 &transfer); 248 249 if (map == NULL) { 250 ret = PIPE_ERROR_OUT_OF_MEMORY; 251 goto done; 252 } 253 254 if (0) 255 debug_printf("upload ptr %p ofs %d sz %d\n", map, offset, size); 256 257 ret = u_upload_data( upload, 258 min_out_offset, 259 size, 260 map + offset, 261 out_offset, 262 outbuf, flushed ); 263 264done: 265 if (map) 266 pipe_buffer_unmap( upload->pipe, transfer ); 267 268 return ret; 269} 270