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 void * 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                          void * 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 void * 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          pipe->buffer_subdata(pipe, st_obj->buffer,
 200                               PIPE_TRANSFER_DISCARD_WHOLE_RESOURCE,
 201                               0, size, data);
 202          return GL_TRUE;
 203       } else if (screen->get_param(screen, PIPE_CAP_INVALIDATE_BUFFER)) {
 204          pipe->invalidate_resource(pipe, st_obj->buffer);
 205          return GL_TRUE;
 206       }
 207    }
 208
 209    st_obj->Base.Size = size;
 210    st_obj->Base.Usage = usage;
 211    st_obj->Base.StorageFlags = storageFlags;
 212
 213    switch (target) {
 214    case GL_PIXEL_PACK_BUFFER_ARB:
 215    case GL_PIXEL_UNPACK_BUFFER_ARB:
 216       bind = PIPE_BIND_RENDER_TARGET | PIPE_BIND_SAMPLER_VIEW;
 217       break;
 218    case GL_ARRAY_BUFFER_ARB:
 219       bind = PIPE_BIND_VERTEX_BUFFER;
 220       break;
 221    case GL_ELEMENT_ARRAY_BUFFER_ARB:
 222       bind = PIPE_BIND_INDEX_BUFFER;
 223       break;
 224    case GL_TEXTURE_BUFFER:
 225       bind = PIPE_BIND_SAMPLER_VIEW;
 226       break;
 227    case GL_TRANSFORM_FEEDBACK_BUFFER:
 228       bind = PIPE_BIND_STREAM_OUTPUT;
 229       break;
 230    case GL_UNIFORM_BUFFER:
 231       bind = PIPE_BIND_CONSTANT_BUFFER;
 232       break;
 233    case GL_DRAW_INDIRECT_BUFFER:
 234    case GL_PARAMETER_BUFFER_ARB:
 235       bind = PIPE_BIND_COMMAND_ARGS_BUFFER;
 236       break;
 237    case GL_ATOMIC_COUNTER_BUFFER:
 238    case GL_SHADER_STORAGE_BUFFER:
 239       bind = PIPE_BIND_SHADER_BUFFER;
 240       break;
 241    case GL_QUERY_BUFFER:
 242       bind = PIPE_BIND_QUERY_BUFFER;
 243       break;
 244    default:
 245       bind = 0;
 246    }
 247
 248    /* Set usage. */
 249    if (st_obj->Base.Immutable) {
 250       /* BufferStorage */
 251       if (storageFlags & GL_CLIENT_STORAGE_BIT)
 252          pipe_usage = PIPE_USAGE_STAGING;
 253       else
 254          pipe_usage = PIPE_USAGE_DEFAULT;
 255    }
 256    else {
 257       /* BufferData */
 258       switch (usage) {
 259       case GL_STATIC_DRAW:
 260       case GL_STATIC_COPY:
 261       default:
 262          pipe_usage = PIPE_USAGE_DEFAULT;
 263          break;
 264       case GL_DYNAMIC_DRAW:
 265       case GL_DYNAMIC_COPY:
 266          pipe_usage = PIPE_USAGE_DYNAMIC;
 267          break;
 268       case GL_STREAM_DRAW:
 269       case GL_STREAM_COPY:
 270          /* XXX: Remove this test and fall-through when we have PBO unpacking
 271           * acceleration. Right now, PBO unpacking is done by the CPU, so we
 272           * have to make sure CPU reads are fast.
 273           */
 274          if (target != GL_PIXEL_UNPACK_BUFFER_ARB) {
 275             pipe_usage = PIPE_USAGE_STREAM;
 276             break;
 277          }
 278          /* fall through */
 279       case GL_STATIC_READ:
 280       case GL_DYNAMIC_READ:
 281       case GL_STREAM_READ:
 282          pipe_usage = PIPE_USAGE_STAGING;
 283          break;
 284       }
 285    }
 286
 287    /* Set flags. */
 288    if (storageFlags & GL_MAP_PERSISTENT_BIT)
 289       pipe_flags |= PIPE_RESOURCE_FLAG_MAP_PERSISTENT;
 290    if (storageFlags & GL_MAP_COHERENT_BIT)
 291       pipe_flags |= PIPE_RESOURCE_FLAG_MAP_COHERENT;
 292
 293    pipe_resource_reference( &st_obj->buffer, NULL );
 294
 295    if (ST_DEBUG & DEBUG_BUFFER) {
 296       debug_printf("Create buffer size %" PRId64 " bind 0x%x\n",
 297                    (int64_t) size, bind);
 298    }
 299
 300    if (size != 0) {
 301       struct pipe_resource buffer;
 302
 303       memset(&buffer, 0, sizeof buffer);
 304       buffer.target = PIPE_BUFFER;
 305       buffer.format = PIPE_FORMAT_R8_UNORM; /* want TYPELESS or similar */
 306       buffer.bind = bind;
 307       buffer.usage = pipe_usage;
 308       buffer.flags = pipe_flags;
 309       buffer.width0 = size;
 310       buffer.height0 = 1;
 311       buffer.depth0 = 1;
 312       buffer.array_size = 1;
 313
 314       if (target == GL_EXTERNAL_VIRTUAL_MEMORY_BUFFER_AMD) {
 315          st_obj->buffer =
 316             screen->resource_from_user_memory(screen, &buffer, (void*)data);
 317       }
 318       else {
 319          st_obj->buffer = screen->resource_create(screen, &buffer);
 320
 321          if (st_obj->buffer && data)
 322             pipe_buffer_write(pipe, st_obj->buffer, 0, size, data);
 323       }
 324
 325       if (!st_obj->buffer) {
 326          /* out of memory */
 327          st_obj->Base.Size = 0;
 328          return GL_FALSE;
 329       }
 330    }
 331
 332    /* The current buffer may be bound, so we have to revalidate all atoms that
 333     * might be using it.
 334     */
 335    /* TODO: Add arrays to usage history */
 336    st->dirty.st |= ST_NEW_VERTEX_ARRAYS;
 337    if (st_obj->Base.UsageHistory & USAGE_UNIFORM_BUFFER)
 338       st->dirty.st |= ST_NEW_UNIFORM_BUFFER;
 339    if (st_obj->Base.UsageHistory & USAGE_SHADER_STORAGE_BUFFER)
 340       st->dirty.st |= ST_NEW_STORAGE_BUFFER;
 341    if (st_obj->Base.UsageHistory & USAGE_TEXTURE_BUFFER)
 342       st->dirty.st |= ST_NEW_SAMPLER_VIEWS | ST_NEW_IMAGE_UNITS;
 343    if (st_obj->Base.UsageHistory & USAGE_ATOMIC_COUNTER_BUFFER)
 344       st->dirty.st |= ST_NEW_ATOMIC_BUFFER;
 345
 346    return GL_TRUE;
 347 }
 348
 349
 350 /**
 351  * Called via glInvalidateBuffer(Sub)Data.
 352  */
 353 static void
 354 st_bufferobj_invalidate(struct gl_context *ctx,
 355                         struct gl_buffer_object *obj,
 356                         GLintptr offset,
 357                         GLsizeiptr size)
 358 {
 359    struct st_context *st = st_context(ctx);
 360    struct pipe_context *pipe = st->pipe;
 361    struct st_buffer_object *st_obj = st_buffer_object(obj);
 362
 363    /* We ignore partial invalidates. */
 364    if (offset != 0 || size != obj->Size)
 365       return;
 366
 367    /* Nothing to invalidate. */
 368    if (!st_obj->buffer)
 369       return;
 370
 371    pipe->invalidate_resource(pipe, st_obj->buffer);
 372 }
 373
 374
 375 /**
 376  * Called via glMapBufferRange().
 377  */
 378 static void *
 379 st_bufferobj_map_range(struct gl_context *ctx,
 380                        GLintptr offset, GLsizeiptr length, GLbitfield access,
 381                        struct gl_buffer_object *obj,
 382                        gl_map_buffer_index index)
 383 {
 384    struct pipe_context *pipe = st_context(ctx)->pipe;
 385    struct st_buffer_object *st_obj = st_buffer_object(obj);
 386    enum pipe_transfer_usage flags = 0x0;
 387
 388    if (access & GL_MAP_WRITE_BIT)
 389       flags |= PIPE_TRANSFER_WRITE;
 390
 391    if (access & GL_MAP_READ_BIT)
 392       flags |= PIPE_TRANSFER_READ;
 393
 394    if (access & GL_MAP_FLUSH_EXPLICIT_BIT)
 395       flags |= PIPE_TRANSFER_FLUSH_EXPLICIT;
 396
 397    if (access & GL_MAP_INVALIDATE_BUFFER_BIT) {
 398       flags |= PIPE_TRANSFER_DISCARD_WHOLE_RESOURCE;
 399    }
 400    else if (access & GL_MAP_INVALIDATE_RANGE_BIT) {
 401       if (offset == 0 && length == obj->Size)
 402          flags |= PIPE_TRANSFER_DISCARD_WHOLE_RESOURCE;
 403       else
 404          flags |= PIPE_TRANSFER_DISCARD_RANGE;
 405    }
 406
 407    if (access & GL_MAP_UNSYNCHRONIZED_BIT)
 408       flags |= PIPE_TRANSFER_UNSYNCHRONIZED;
 409
 410    if (access & GL_MAP_PERSISTENT_BIT)
 411       flags |= PIPE_TRANSFER_PERSISTENT;
 412
 413    if (access & GL_MAP_COHERENT_BIT)
 414       flags |= PIPE_TRANSFER_COHERENT;
 415
 416    /* ... other flags ...
 417     */
 418
 419    if (access & MESA_MAP_NOWAIT_BIT)
 420       flags |= PIPE_TRANSFER_DONTBLOCK;
 421
 422    assert(offset >= 0);
 423    assert(length >= 0);
 424    assert(offset < obj->Size);
 425    assert(offset + length <= obj->Size);
 426
 427    obj->Mappings[index].Pointer = pipe_buffer_map_range(pipe,
 428                                         st_obj->buffer,
 429                                         offset, length,
 430                                         flags,
 431                                         &st_obj->transfer[index]);
 432    if (obj->Mappings[index].Pointer) {
 433       obj->Mappings[index].Offset = offset;
 434       obj->Mappings[index].Length = length;
 435       obj->Mappings[index].AccessFlags = access;
 436    }
 437    else {
 438       st_obj->transfer[index] = NULL;
 439    }
 440
 441    return obj->Mappings[index].Pointer;
 442 }
 443
 444
 445 static void
 446 st_bufferobj_flush_mapped_range(struct gl_context *ctx,
 447                                 GLintptr offset, GLsizeiptr length,
 448                                 struct gl_buffer_object *obj,
 449                                 gl_map_buffer_index index)
 450 {
 451    struct pipe_context *pipe = st_context(ctx)->pipe;
 452    struct st_buffer_object *st_obj = st_buffer_object(obj);
 453
 454    /* Subrange is relative to mapped range */
 455    assert(offset >= 0);
 456    assert(length >= 0);
 457    assert(offset + length <= obj->Mappings[index].Length);
 458    assert(obj->Mappings[index].Pointer);
 459
 460    if (!length)
 461       return;
 462
 463    pipe_buffer_flush_mapped_range(pipe, st_obj->transfer[index],
 464                                   obj->Mappings[index].Offset + offset,
 465                                   length);
 466 }
 467
 468
 469 /**
 470  * Called via glUnmapBufferARB().
 471  */
 472 static GLboolean
 473 st_bufferobj_unmap(struct gl_context *ctx, struct gl_buffer_object *obj,
 474                    gl_map_buffer_index index)
 475 {
 476    struct pipe_context *pipe = st_context(ctx)->pipe;
 477    struct st_buffer_object *st_obj = st_buffer_object(obj);
 478
 479    if (obj->Mappings[index].Length)
 480       pipe_buffer_unmap(pipe, st_obj->transfer[index]);
 481
 482    st_obj->transfer[index] = NULL;
 483    obj->Mappings[index].Pointer = NULL;
 484    obj->Mappings[index].Offset = 0;
 485    obj->Mappings[index].Length = 0;
 486    return GL_TRUE;
 487 }
 488
 489
 490 /**
 491  * Called via glCopyBufferSubData().
 492  */
 493 static void
 494 st_copy_buffer_subdata(struct gl_context *ctx,
 495                        struct gl_buffer_object *src,
 496                        struct gl_buffer_object *dst,
 497                        GLintptr readOffset, GLintptr writeOffset,
 498                        GLsizeiptr size)
 499 {
 500    struct pipe_context *pipe = st_context(ctx)->pipe;
 501    struct st_buffer_object *srcObj = st_buffer_object(src);
 502    struct st_buffer_object *dstObj = st_buffer_object(dst);
 503    struct pipe_box box;
 504
 505    if (!size)
 506       return;
 507
 508    /* buffer should not already be mapped */
 509    assert(!_mesa_check_disallowed_mapping(src));
 510    assert(!_mesa_check_disallowed_mapping(dst));
 511
 512    u_box_1d(readOffset, size, &box);
 513
 514    pipe->resource_copy_region(pipe, dstObj->buffer, 0, writeOffset, 0, 0,
 515                               srcObj->buffer, 0, &box);
 516 }
 517
 518 /**
 519  * Called via glClearBufferSubData().
 520  */
 521 static void
 522 st_clear_buffer_subdata(struct gl_context *ctx,
 523                         GLintptr offset, GLsizeiptr size,
 524                         const void *clearValue,
 525                         GLsizeiptr clearValueSize,
 526                         struct gl_buffer_object *bufObj)
 527 {
 528    struct pipe_context *pipe = st_context(ctx)->pipe;
 529    struct st_buffer_object *buf = st_buffer_object(bufObj);
 530    static const char zeros[16] = {0};
 531
 532    if (!pipe->clear_buffer) {
 533       _mesa_ClearBufferSubData_sw(ctx, offset, size,
 534                                   clearValue, clearValueSize, bufObj);
 535       return;
 536    }
 537
 538    if (!clearValue)
 539       clearValue = zeros;
 540
 541    pipe->clear_buffer(pipe, buf->buffer, offset, size,
 542                       clearValue, clearValueSize);
 543 }
 544
 545
 546 /* TODO: if buffer wasn't created with appropriate usage flags, need
 547  * to recreate it now and copy contents -- or possibly create a
 548  * gallium entrypoint to extend the usage flags and let the driver
 549  * decide if a copy is necessary.
 550  */
 551 void
 552 st_bufferobj_validate_usage(struct st_context *st,
 553                             struct st_buffer_object *obj,
 554                             unsigned usage)
 555 {
 556 }
 557
 558
 559 void
 560 st_init_bufferobject_functions(struct pipe_screen *screen,
 561                                struct dd_function_table *functions)
 562 {
 563    /* plug in default driver fallbacks (such as for ClearBufferSubData) */
 564    _mesa_init_buffer_object_functions(functions);
 565
 566    functions->NewBufferObject = st_bufferobj_alloc;
 567    functions->DeleteBuffer = st_bufferobj_free;
 568    functions->BufferData = st_bufferobj_data;
 569    functions->BufferSubData = st_bufferobj_subdata;
 570    functions->GetBufferSubData = st_bufferobj_get_subdata;
 571    functions->MapBufferRange = st_bufferobj_map_range;
 572    functions->FlushMappedBufferRange = st_bufferobj_flush_mapped_range;
 573    functions->UnmapBuffer = st_bufferobj_unmap;
 574    functions->CopyBufferSubData = st_copy_buffer_subdata;
 575    functions->ClearBufferSubData = st_clear_buffer_subdata;
 576
 577    if (screen->get_param(screen, PIPE_CAP_INVALIDATE_BUFFER))
 578       functions->InvalidateBufferSubData = st_bufferobj_invalidate;
 579 }