src/gallium/auxiliary/util/u_upload_mgr.c

   1 /**************************************************************************
   2  *
   3  * Copyright 2009 VMware, Inc.
   4  * All Rights Reserved.
   5  *
   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:
  13  *
  14  * The above copyright notice and this permission notice (including the
  15  * next paragraph) shall be included in all copies or substantial portions
  16  * of the Software.
  17  *
  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.
  25  *
  26  **************************************************************************/
  27
  28 /* Helper utility for uploading user buffers & other data, and
  29  * coalescing small buffers into larger ones.
  30  */
  31
  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"
  37
  38 #include "u_upload_mgr.h"
  39
  40
  41 struct u_upload_mgr {
  42    struct pipe_context *pipe;
  43
  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. */
  47
  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. */
  54 };
  55
  56
  57 struct u_upload_mgr *u_upload_create( struct pipe_context *pipe,
  58                                       unsigned default_size,
  59                                       unsigned alignment,
  60                                       unsigned bind )
  61 {
  62    struct u_upload_mgr *upload = CALLOC_STRUCT( u_upload_mgr );
  63    if (!upload)
  64       return NULL;
  65
  66    upload->pipe = pipe;
  67    upload->default_size = default_size;
  68    upload->alignment = alignment;
  69    upload->bind = bind;
  70    upload->buffer = NULL;
  71
  72    return upload;
  73 }
  74
  75 /* Release old buffer.
  76  *
  77  * This must usually be called prior to firing the command stream
  78  * which references the upload buffer, as many memory managers will
  79  * cause subsequent maps of a fired buffer to wait.
  80  *
  81  * Can improve this with a change to pipe_buffer_write to use the
  82  * DONT_WAIT bit, but for now, it's easiest just to grab a new buffer.
  83  */
  84 void u_upload_flush( struct u_upload_mgr *upload )
  85 {
  86    /* Unmap and unreference the upload buffer. */
  87    if (upload->transfer) {
  88       if (upload->size) {
  89          pipe_buffer_flush_mapped_range(upload->pipe, upload->transfer,
  90                                         0, upload->size);
  91       }
  92       pipe_transfer_unmap(upload->pipe, upload->transfer);
  93       pipe_transfer_destroy(upload->pipe, upload->transfer);
  94       upload->transfer = NULL;
  95    }
  96    pipe_resource_reference( &upload->buffer, NULL );
  97    upload->size = 0;
  98 }
  99
 100
 101 void u_upload_destroy( struct u_upload_mgr *upload )
 102 {
 103    u_upload_flush( upload );
 104    FREE( upload );
 105 }
 106
 107
 108 static enum pipe_error
 109 u_upload_alloc_buffer( struct u_upload_mgr *upload,
 110                        unsigned min_size )
 111 {
 112    unsigned size;
 113
 114    /* Release the old buffer, if present:
 115     */
 116    u_upload_flush( upload );
 117
 118    /* Allocate a new one:
 119     */
 120    size = align(MAX2(upload->default_size, min_size), 4096);
 121
 122    upload->buffer = pipe_buffer_create( upload->pipe->screen,
 123                                         upload->bind,
 124                                         size );
 125    if (upload->buffer == NULL)
 126       goto fail;
 127
 128    /* Map the new buffer. */
 129    upload->map = pipe_buffer_map_range(upload->pipe, upload->buffer,
 130                                        0, size,
 131                                        PIPE_TRANSFER_WRITE |
 132                                        PIPE_TRANSFER_FLUSH_EXPLICIT,
 133                                        &upload->transfer);
 134
 135    upload->size = size;
 136
 137    upload->offset = 0;
 138    return 0;
 139
 140 fail:
 141    if (upload->buffer)
 142       pipe_resource_reference( &upload->buffer, NULL );
 143
 144    return PIPE_ERROR_OUT_OF_MEMORY;
 145 }
 146
 147 enum pipe_error u_upload_alloc( struct u_upload_mgr *upload,
 148                                 unsigned min_out_offset,
 149                                 unsigned size,
 150                                 unsigned *out_offset,
 151                                 struct pipe_resource **outbuf,
 152                                 boolean *flushed,
 153                                 void **ptr )
 154 {
 155    unsigned alloc_size = align( size, upload->alignment );
 156    unsigned alloc_offset = align(min_out_offset, upload->alignment);
 157    unsigned offset;
 158
 159    /* Make sure we have enough space in the upload buffer
 160     * for the sub-allocation. */
 161    if (MAX2(upload->offset, alloc_offset) + alloc_size > upload->size) {
 162       enum pipe_error ret = u_upload_alloc_buffer(upload,
 163                                                   alloc_offset + alloc_size);
 164       if (ret)
 165          return ret;
 166
 167       *flushed = TRUE;
 168    } else {
 169       *flushed = FALSE;
 170    }
 171
 172    offset = MAX2(upload->offset, alloc_offset);
 173
 174    assert(offset < upload->buffer->width0);
 175    assert(offset + size <= upload->buffer->width0);
 176    assert(size);
 177
 178    /* Emit the return values: */
 179    *ptr = upload->map + offset;
 180    pipe_resource_reference( outbuf, upload->buffer );
 181    *out_offset = offset;
 182
 183    upload->offset = offset + alloc_size;
 184    return PIPE_OK;
 185 }
 186
 187 enum pipe_error u_upload_data( struct u_upload_mgr *upload,
 188                                unsigned min_out_offset,
 189                                unsigned size,
 190                                const void *data,
 191                                unsigned *out_offset,
 192                                struct pipe_resource **outbuf,
 193                                boolean *flushed )
 194 {
 195    uint8_t *ptr;
 196    enum pipe_error ret = u_upload_alloc(upload, min_out_offset, size,
 197                                         out_offset, outbuf, flushed,
 198                                         (void**)&ptr);
 199    if (ret)
 200       return ret;
 201
 202    memcpy(ptr, data, size);
 203    return PIPE_OK;
 204 }
 205
 206
 207 /* As above, but upload the full contents of a buffer.  Useful for
 208  * uploading user buffers, avoids generating an explosion of GPU
 209  * buffers if you have an app that does lots of small vertex buffer
 210  * renders or DrawElements calls.
 211  */
 212 enum pipe_error u_upload_buffer( struct u_upload_mgr *upload,
 213                                  unsigned min_out_offset,
 214                                  unsigned offset,
 215                                  unsigned size,
 216                                  struct pipe_resource *inbuf,
 217                                  unsigned *out_offset,
 218                                  struct pipe_resource **outbuf,
 219                                  boolean *flushed )
 220 {
 221    enum pipe_error ret = PIPE_OK;
 222    struct pipe_transfer *transfer = NULL;
 223    const char *map = NULL;
 224
 225    map = (const char *)pipe_buffer_map(upload->pipe,
 226                                        inbuf,
 227                                        PIPE_TRANSFER_READ,
 228                                        &transfer);
 229
 230    if (map == NULL) {
 231       ret = PIPE_ERROR_OUT_OF_MEMORY;
 232       goto done;
 233    }
 234
 235    if (0)
 236       debug_printf("upload ptr %p ofs %d sz %d\n", map, offset, size);
 237
 238    ret = u_upload_data( upload,
 239                         min_out_offset,
 240                         size,
 241                         map + offset,
 242                         out_offset,
 243                         outbuf, flushed );
 244
 245 done:
 246    if (map)
 247       pipe_buffer_unmap( upload->pipe, transfer );
 248
 249    return ret;
 250 }