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