src/mesa/state_tracker/st_cb_bufferobjects.c

   1 /**************************************************************************
   2  *
   3  * Copyright 2007 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
  29 /**
  30  * Functions for pixel buffer objects and vertex/element buffer objects.
  31  */
  32
  33
  34 #include <inttypes.h>  /* for PRId64 macro */
  35
  36 #include "main/imports.h"
  37 #include "main/mtypes.h"
  38 #include "main/arrayobj.h"
  39 #include "main/bufferobj.h"
  40
  41 #include "st_context.h"
  42 #include "st_cb_bufferobjects.h"
  43 #include "st_debug.h"
  44
  45 #include "pipe/p_context.h"
  46 #include "pipe/p_defines.h"
  47 #include "util/u_inlines.h"
  48
  49
  50 /**
  51  * There is some duplication between mesa's bufferobjects and our
  52  * bufmgr buffers.  Both have an integer handle and a hashtable to
  53  * lookup an opaque structure.  It would be nice if the handles and
  54  * internal structure where somehow shared.
  55  */
  56 static struct gl_buffer_object *
  57 st_bufferobj_alloc(struct gl_context *ctx, GLuint name)
  58 {
  59    struct st_buffer_object *st_obj = ST_CALLOC_STRUCT(st_buffer_object);
  60
  61    if (!st_obj)
  62       return NULL;
  63
  64    _mesa_initialize_buffer_object(ctx, &st_obj->Base, name);
  65
  66    return &st_obj->Base;
  67 }
  68
  69
  70
  71 /**
  72  * Deallocate/free a vertex/pixel buffer object.
  73  * Called via glDeleteBuffersARB().
  74  */
  75 static void
  76 st_bufferobj_free(struct gl_context *ctx, struct gl_buffer_object *obj)
  77 {
  78    struct st_buffer_object *st_obj = st_buffer_object(obj);
  79
  80    assert(obj->RefCount == 0);
  81    _mesa_buffer_unmap_all_mappings(ctx, obj);
  82
  83    if (st_obj->buffer)
  84       pipe_resource_reference(&st_obj->buffer, NULL);
  85
  86    _mesa_delete_buffer_object(ctx, obj);
  87 }
  88
  89
  90
  91 /**
  92  * Replace data in a subrange of buffer object.  If the data range
  93  * specified by size + offset extends beyond the end of the buffer or
  94  * if data is NULL, no copy is performed.
  95  * Called via glBufferSubDataARB().
  96  */
  97 static void
  98 st_bufferobj_subdata(struct gl_context *ctx,
  99                      GLintptrARB offset,
 100                      GLsizeiptrARB size,
 101                      const GLvoid * data, struct gl_buffer_object *obj)
 102 {
 103    struct st_buffer_object *st_obj = st_buffer_object(obj);
 104
 105    /* we may be called from VBO code, so double-check params here */
 106    assert(offset >= 0);
 107    assert(size >= 0);
 108    assert(offset + size <= obj->Size);
 109
 110    if (!size)
 111       return;
 112
 113    /*
 114     * According to ARB_vertex_buffer_object specification, if data is null,
 115     * then the contents of the buffer object's data store is undefined. We just
 116     * ignore, and leave it unchanged.
 117     */
 118    if (!data)
 119       return;
 120
 121    if (!st_obj->buffer) {
 122       /* we probably ran out of memory during buffer allocation */
 123       return;
 124    }
 125
 126    /* Now that transfers are per-context, we don't have to figure out
 127     * flushing here.  Usually drivers won't need to flush in this case
 128     * even if the buffer is currently referenced by hardware - they
 129     * just queue the upload as dma rather than mapping the underlying
 130     * buffer directly.
 131     */
 132    pipe_buffer_write(st_context(ctx)->pipe,
 133                      st_obj->buffer,
 134                      offset, size, data);
 135 }
 136
 137
 138 /**
 139  * Called via glGetBufferSubDataARB().
 140  */
 141 static void
 142 st_bufferobj_get_subdata(struct gl_context *ctx,
 143                          GLintptrARB offset,
 144                          GLsizeiptrARB size,
 145                          GLvoid * data, struct gl_buffer_object *obj)
 146 {
 147    struct st_buffer_object *st_obj = st_buffer_object(obj);
 148
 149    /* we may be called from VBO code, so double-check params here */
 150    assert(offset >= 0);
 151    assert(size >= 0);
 152    assert(offset + size <= obj->Size);
 153
 154    if (!size)
 155       return;
 156
 157    if (!st_obj->buffer) {
 158       /* we probably ran out of memory during buffer allocation */
 159       return;
 160    }
 161
 162    pipe_buffer_read(st_context(ctx)->pipe, st_obj->buffer,
 163                     offset, size, data);
 164 }
 165
 166
 167 /**
 168  * Allocate space for and store data in a buffer object.  Any data that was
 169  * previously stored in the buffer object is lost.  If data is NULL,
 170  * memory will be allocated, but no copy will occur.
 171  * Called via ctx->Driver.BufferData().
 172  * \return GL_TRUE for success, GL_FALSE if out of memory
 173  */
 174 static GLboolean
 175 st_bufferobj_data(struct gl_context *ctx,
 176                   GLenum target,
 177                   GLsizeiptrARB size,
 178                   const GLvoid * data,
 179                   GLenum usage,
 180                   GLbitfield storageFlags,
 181                   struct gl_buffer_object *obj)
 182 {
 183    struct st_context *st = st_context(ctx);
 184    struct pipe_context *pipe = st->pipe;
 185    struct pipe_screen *screen = pipe->screen;
 186    struct st_buffer_object *st_obj = st_buffer_object(obj);
 187    unsigned bind, pipe_usage, pipe_flags = 0;
 188
 189    if (target != GL_EXTERNAL_VIRTUAL_MEMORY_BUFFER_AMD &&
 190        size && st_obj->buffer &&
 191        st_obj->Base.Size == size &&
 192        st_obj->Base.Usage == usage &&
 193        st_obj->Base.StorageFlags == storageFlags) {
 194       if (data) {
 195          /* Just discard the old contents and write new data.
 196           * This should be the same as creating a new buffer, but we avoid
 197           * a lot of validation in Mesa.
 198           */
 199          struct pipe_box box;
 200
 201          u_box_1d(0, size, &box);
 202          pipe->transfer_inline_write(pipe, st_obj->buffer, 0,
 203                                     PIPE_TRANSFER_DISCARD_WHOLE_RESOURCE,
 204                                     &box, data, 0, 0);
 205          return GL_TRUE;
 206       } else if (screen->get_param(screen, PIPE_CAP_INVALIDATE_BUFFER)) {
 207          pipe->invalidate_resource(pipe, st_obj->buffer);
 208          return GL_TRUE;
 209       }
 210    }
 211
 212    st_obj->Base.Size = size;
 213    st_obj->Base.Usage = usage;
 214    st_obj->Base.StorageFlags = storageFlags;
 215
 216    switch (target) {
 217    case GL_PIXEL_PACK_BUFFER_ARB:
 218    case GL_PIXEL_UNPACK_BUFFER_ARB:
 219       bind = PIPE_BIND_RENDER_TARGET | PIPE_BIND_SAMPLER_VIEW;
 220       break;
 221    case GL_ARRAY_BUFFER_ARB:
 222       bind = PIPE_BIND_VERTEX_BUFFER;
 223       break;
 224    case GL_ELEMENT_ARRAY_BUFFER_ARB:
 225       bind = PIPE_BIND_INDEX_BUFFER;
 226       break;
 227    case GL_TEXTURE_BUFFER:
 228       bind = PIPE_BIND_SAMPLER_VIEW;
 229       break;
 230    case GL_TRANSFORM_FEEDBACK_BUFFER:
 231       bind = PIPE_BIND_STREAM_OUTPUT;
 232       break;
 233    case GL_UNIFORM_BUFFER:
 234       bind = PIPE_BIND_CONSTANT_BUFFER;
 235       break;
 236    case GL_DRAW_INDIRECT_BUFFER:
 237    case GL_PARAMETER_BUFFER_ARB:
 238       bind = PIPE_BIND_COMMAND_ARGS_BUFFER;
 239       break;
 240    case GL_ATOMIC_COUNTER_BUFFER:
 241    case GL_SHADER_STORAGE_BUFFER:
 242       bind = PIPE_BIND_SHADER_BUFFER;
 243       break;
 244    case GL_QUERY_BUFFER:
 245       bind = PIPE_BIND_QUERY_BUFFER;
 246       break;
 247    default:
 248       bind = 0;
 249    }
 250
 251    /* Set usage. */
 252    if (st_obj->Base.Immutable) {
 253       /* BufferStorage */
 254       if (storageFlags & GL_CLIENT_STORAGE_BIT)
 255          pipe_usage = PIPE_USAGE_STAGING;
 256       else
 257          pipe_usage = PIPE_USAGE_DEFAULT;
 258    }
 259    else {
 260       /* BufferData */
 261       switch (usage) {
 262       case GL_STATIC_DRAW:
 263       case GL_STATIC_COPY:
 264       default:
 265          pipe_usage = PIPE_USAGE_DEFAULT;
 266          break;
 267       case GL_DYNAMIC_DRAW:
 268       case GL_DYNAMIC_COPY:
 269          pipe_usage = PIPE_USAGE_DYNAMIC;
 270          break;
 271       case GL_STREAM_DRAW:
 272       case GL_STREAM_COPY:
 273          /* XXX: Remove this test and fall-through when we have PBO unpacking
 274           * acceleration. Right now, PBO unpacking is done by the CPU, so we
 275           * have to make sure CPU reads are fast.
 276           */
 277          if (target != GL_PIXEL_UNPACK_BUFFER_ARB) {
 278             pipe_usage = PIPE_USAGE_STREAM;
 279             break;
 280          }
 281          /* fall through */
 282       case GL_STATIC_READ:
 283       case GL_DYNAMIC_READ:
 284       case GL_STREAM_READ:
 285          pipe_usage = PIPE_USAGE_STAGING;
 286          break;
 287       }
 288    }
 289
 290    /* Set flags. */
 291    if (storageFlags & GL_MAP_PERSISTENT_BIT)
 292       pipe_flags |= PIPE_RESOURCE_FLAG_MAP_PERSISTENT;
 293    if (storageFlags & GL_MAP_COHERENT_BIT)
 294       pipe_flags |= PIPE_RESOURCE_FLAG_MAP_COHERENT;
 295
 296    pipe_resource_reference( &st_obj->buffer, NULL );
 297
 298    if (ST_DEBUG & DEBUG_BUFFER) {
 299       debug_printf("Create buffer size %" PRId64 " bind 0x%x\n",
 300                    (int64_t) size, bind);
 301    }
 302
 303    if (size != 0) {
 304       struct pipe_resource buffer;
 305
 306       memset(&buffer, 0, sizeof buffer);
 307       buffer.target = PIPE_BUFFER;
 308       buffer.format = PIPE_FORMAT_R8_UNORM; /* want TYPELESS or similar */
 309       buffer.bind = bind;
 310       buffer.usage = pipe_usage;
 311       buffer.flags = pipe_flags;
 312       buffer.width0 = size;
 313       buffer.height0 = 1;
 314       buffer.depth0 = 1;
 315       buffer.array_size = 1;
 316
 317       if (target == GL_EXTERNAL_VIRTUAL_MEMORY_BUFFER_AMD) {
 318          st_obj->buffer =
 319             screen->resource_from_user_memory(screen, &buffer, (void*)data);
 320       }
 321       else {
 322          st_obj->buffer = screen->resource_create(screen, &buffer);
 323
 324          if (st_obj->buffer && data)
 325             pipe_buffer_write(pipe, st_obj->buffer, 0, size, data);
 326       }
 327
 328       if (!st_obj->buffer) {
 329          /* out of memory */
 330          st_obj->Base.Size = 0;
 331          return GL_FALSE;
 332       }
 333    }
 334
 335    /* BufferData may change an array or uniform buffer, need to update it */
 336    st->dirty.st |= ST_NEW_VERTEX_ARRAYS | ST_NEW_UNIFORM_BUFFER;
 337
 338    return GL_TRUE;
 339 }
 340
 341
 342 /**
 343  * Called via glInvalidateBuffer(Sub)Data.
 344  */
 345 static void
 346 st_bufferobj_invalidate(struct gl_context *ctx,
 347                         struct gl_buffer_object *obj,
 348                         GLintptr offset,
 349                         GLsizeiptr size)
 350 {
 351    struct st_context *st = st_context(ctx);
 352    struct pipe_context *pipe = st->pipe;
 353    struct st_buffer_object *st_obj = st_buffer_object(obj);
 354
 355    /* We ignore partial invalidates. */
 356    if (offset != 0 || size != obj->Size)
 357       return;
 358
 359    /* Nothing to invalidate. */
 360    if (!st_obj->buffer)
 361       return;
 362
 363    pipe->invalidate_resource(pipe, st_obj->buffer);
 364 }
 365
 366
 367 /**
 368  * Called via glMapBufferRange().
 369  */
 370 static void *
 371 st_bufferobj_map_range(struct gl_context *ctx,
 372                        GLintptr offset, GLsizeiptr length, GLbitfield access,
 373                        struct gl_buffer_object *obj,
 374                        gl_map_buffer_index index)
 375 {
 376    struct pipe_context *pipe = st_context(ctx)->pipe;
 377    struct st_buffer_object *st_obj = st_buffer_object(obj);
 378    enum pipe_transfer_usage flags = 0x0;
 379
 380    if (access & GL_MAP_WRITE_BIT)
 381       flags |= PIPE_TRANSFER_WRITE;
 382
 383    if (access & GL_MAP_READ_BIT)
 384       flags |= PIPE_TRANSFER_READ;
 385
 386    if (access & GL_MAP_FLUSH_EXPLICIT_BIT)
 387       flags |= PIPE_TRANSFER_FLUSH_EXPLICIT;
 388
 389    if (access & GL_MAP_INVALIDATE_BUFFER_BIT) {
 390       flags |= PIPE_TRANSFER_DISCARD_WHOLE_RESOURCE;
 391    }
 392    else if (access & GL_MAP_INVALIDATE_RANGE_BIT) {
 393       if (offset == 0 && length == obj->Size)
 394          flags |= PIPE_TRANSFER_DISCARD_WHOLE_RESOURCE;
 395       else
 396          flags |= PIPE_TRANSFER_DISCARD_RANGE;
 397    }
 398
 399    if (access & GL_MAP_UNSYNCHRONIZED_BIT)
 400       flags |= PIPE_TRANSFER_UNSYNCHRONIZED;
 401
 402    if (access & GL_MAP_PERSISTENT_BIT)
 403       flags |= PIPE_TRANSFER_PERSISTENT;
 404
 405    if (access & GL_MAP_COHERENT_BIT)
 406       flags |= PIPE_TRANSFER_COHERENT;
 407
 408    /* ... other flags ...
 409     */
 410
 411    if (access & MESA_MAP_NOWAIT_BIT)
 412       flags |= PIPE_TRANSFER_DONTBLOCK;
 413
 414    assert(offset >= 0);
 415    assert(length >= 0);
 416    assert(offset < obj->Size);
 417    assert(offset + length <= obj->Size);
 418
 419    obj->Mappings[index].Pointer = pipe_buffer_map_range(pipe,
 420                                         st_obj->buffer,
 421                                         offset, length,
 422                                         flags,
 423                                         &st_obj->transfer[index]);
 424    if (obj->Mappings[index].Pointer) {
 425       obj->Mappings[index].Offset = offset;
 426       obj->Mappings[index].Length = length;
 427       obj->Mappings[index].AccessFlags = access;
 428    }
 429    else {
 430       st_obj->transfer[index] = NULL;
 431    }
 432
 433    return obj->Mappings[index].Pointer;
 434 }
 435
 436
 437 static void
 438 st_bufferobj_flush_mapped_range(struct gl_context *ctx,
 439                                 GLintptr offset, GLsizeiptr length,
 440                                 struct gl_buffer_object *obj,
 441                                 gl_map_buffer_index index)
 442 {
 443    struct pipe_context *pipe = st_context(ctx)->pipe;
 444    struct st_buffer_object *st_obj = st_buffer_object(obj);
 445
 446    /* Subrange is relative to mapped range */
 447    assert(offset >= 0);
 448    assert(length >= 0);
 449    assert(offset + length <= obj->Mappings[index].Length);
 450    assert(obj->Mappings[index].Pointer);
 451
 452    if (!length)
 453       return;
 454
 455    pipe_buffer_flush_mapped_range(pipe, st_obj->transfer[index],
 456                                   obj->Mappings[index].Offset + offset,
 457                                   length);
 458 }
 459
 460
 461 /**
 462  * Called via glUnmapBufferARB().
 463  */
 464 static GLboolean
 465 st_bufferobj_unmap(struct gl_context *ctx, struct gl_buffer_object *obj,
 466                    gl_map_buffer_index index)
 467 {
 468    struct pipe_context *pipe = st_context(ctx)->pipe;
 469    struct st_buffer_object *st_obj = st_buffer_object(obj);
 470
 471    if (obj->Mappings[index].Length)
 472       pipe_buffer_unmap(pipe, st_obj->transfer[index]);
 473
 474    st_obj->transfer[index] = NULL;
 475    obj->Mappings[index].Pointer = NULL;
 476    obj->Mappings[index].Offset = 0;
 477    obj->Mappings[index].Length = 0;
 478    return GL_TRUE;
 479 }
 480
 481
 482 /**
 483  * Called via glCopyBufferSubData().
 484  */
 485 static void
 486 st_copy_buffer_subdata(struct gl_context *ctx,
 487                        struct gl_buffer_object *src,
 488                        struct gl_buffer_object *dst,
 489                        GLintptr readOffset, GLintptr writeOffset,
 490                        GLsizeiptr size)
 491 {
 492    struct pipe_context *pipe = st_context(ctx)->pipe;
 493    struct st_buffer_object *srcObj = st_buffer_object(src);
 494    struct st_buffer_object *dstObj = st_buffer_object(dst);
 495    struct pipe_box box;
 496
 497    if (!size)
 498       return;
 499
 500    /* buffer should not already be mapped */
 501    assert(!_mesa_check_disallowed_mapping(src));
 502    assert(!_mesa_check_disallowed_mapping(dst));
 503
 504    u_box_1d(readOffset, size, &box);
 505
 506    pipe->resource_copy_region(pipe, dstObj->buffer, 0, writeOffset, 0, 0,
 507                               srcObj->buffer, 0, &box);
 508 }
 509
 510 /**
 511  * Called via glClearBufferSubData().
 512  */
 513 static void
 514 st_clear_buffer_subdata(struct gl_context *ctx,
 515                         GLintptr offset, GLsizeiptr size,
 516                         const GLvoid *clearValue,
 517                         GLsizeiptr clearValueSize,
 518                         struct gl_buffer_object *bufObj)
 519 {
 520    struct pipe_context *pipe = st_context(ctx)->pipe;
 521    struct st_buffer_object *buf = st_buffer_object(bufObj);
 522    static const char zeros[16] = {0};
 523
 524    if (!pipe->clear_buffer) {
 525       _mesa_ClearBufferSubData_sw(ctx, offset, size,
 526                                   clearValue, clearValueSize, bufObj);
 527       return;
 528    }
 529
 530    if (!clearValue)
 531       clearValue = zeros;
 532
 533    pipe->clear_buffer(pipe, buf->buffer, offset, size,
 534                       clearValue, clearValueSize);
 535 }
 536
 537
 538 /* TODO: if buffer wasn't created with appropriate usage flags, need
 539  * to recreate it now and copy contents -- or possibly create a
 540  * gallium entrypoint to extend the usage flags and let the driver
 541  * decide if a copy is necessary.
 542  */
 543 void
 544 st_bufferobj_validate_usage(struct st_context *st,
 545                             struct st_buffer_object *obj,
 546                             unsigned usage)
 547 {
 548 }
 549
 550
 551 void
 552 st_init_bufferobject_functions(struct pipe_screen *screen,
 553                                struct dd_function_table *functions)
 554 {
 555    /* plug in default driver fallbacks (such as for ClearBufferSubData) */
 556    _mesa_init_buffer_object_functions(functions);
 557
 558    functions->NewBufferObject = st_bufferobj_alloc;
 559    functions->DeleteBuffer = st_bufferobj_free;
 560    functions->BufferData = st_bufferobj_data;
 561    functions->BufferSubData = st_bufferobj_subdata;
 562    functions->GetBufferSubData = st_bufferobj_get_subdata;
 563    functions->MapBufferRange = st_bufferobj_map_range;
 564    functions->FlushMappedBufferRange = st_bufferobj_flush_mapped_range;
 565    functions->UnmapBuffer = st_bufferobj_unmap;
 566    functions->CopyBufferSubData = st_copy_buffer_subdata;
 567    functions->ClearBufferSubData = st_clear_buffer_subdata;
 568
 569    if (screen->get_param(screen, PIPE_CAP_INVALIDATE_BUFFER))
 570       functions->InvalidateBufferSubData = st_bufferobj_invalidate;
 571 }