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 "main/imports.h"
  35 #include "main/mtypes.h"
  36 #include "main/arrayobj.h"
  37 #include "main/bufferobj.h"
  38
  39 #include "st_context.h"
  40 #include "st_cb_bufferobjects.h"
  41 #include "st_debug.h"
  42
  43 #include "pipe/p_context.h"
  44 #include "pipe/p_defines.h"
  45 #include "util/u_inlines.h"
  46
  47
  48 /**
  49  * There is some duplication between mesa's bufferobjects and our
  50  * bufmgr buffers.  Both have an integer handle and a hashtable to
  51  * lookup an opaque structure.  It would be nice if the handles and
  52  * internal structure where somehow shared.
  53  */
  54 static struct gl_buffer_object *
  55 st_bufferobj_alloc(struct gl_context *ctx, GLuint name, GLenum target)
  56 {
  57    struct st_buffer_object *st_obj = ST_CALLOC_STRUCT(st_buffer_object);
  58
  59    if (!st_obj)
  60       return NULL;
  61
  62    _mesa_initialize_buffer_object(ctx, &st_obj->Base, name, target);
  63
  64    return &st_obj->Base;
  65 }
  66
  67
  68
  69 /**
  70  * Deallocate/free a vertex/pixel buffer object.
  71  * Called via glDeleteBuffersARB().
  72  */
  73 static void
  74 st_bufferobj_free(struct gl_context *ctx, struct gl_buffer_object *obj)
  75 {
  76    struct st_buffer_object *st_obj = st_buffer_object(obj);
  77
  78    assert(obj->RefCount == 0);
  79    assert(st_obj->transfer == NULL);
  80
  81    if (st_obj->buffer)
  82       pipe_resource_reference(&st_obj->buffer, NULL);
  83
  84    free(st_obj->Base.Label);
  85    free(st_obj);
  86 }
  87
  88
  89
  90 /**
  91  * Replace data in a subrange of buffer object.  If the data range
  92  * specified by size + offset extends beyond the end of the buffer or
  93  * if data is NULL, no copy is performed.
  94  * Called via glBufferSubDataARB().
  95  */
  96 static void
  97 st_bufferobj_subdata(struct gl_context *ctx,
  98                      GLintptrARB offset,
  99                      GLsizeiptrARB size,
 100                      const GLvoid * data, struct gl_buffer_object *obj)
 101 {
 102    struct st_buffer_object *st_obj = st_buffer_object(obj);
 103
 104    /* we may be called from VBO code, so double-check params here */
 105    ASSERT(offset >= 0);
 106    ASSERT(size >= 0);
 107    ASSERT(offset + size <= obj->Size);
 108
 109    if (!size)
 110       return;
 111
 112    /*
 113     * According to ARB_vertex_buffer_object specification, if data is null,
 114     * then the contents of the buffer object's data store is undefined. We just
 115     * ignore, and leave it unchanged.
 116     */
 117    if (!data)
 118       return;
 119
 120    if (!st_obj->buffer) {
 121       /* we probably ran out of memory during buffer allocation */
 122       return;
 123    }
 124
 125    /* Now that transfers are per-context, we don't have to figure out
 126     * flushing here.  Usually drivers won't need to flush in this case
 127     * even if the buffer is currently referenced by hardware - they
 128     * just queue the upload as dma rather than mapping the underlying
 129     * buffer directly.
 130     */
 131    pipe_buffer_write(st_context(ctx)->pipe,
 132                      st_obj->buffer,
 133                      offset, size, data);
 134 }
 135
 136
 137 /**
 138  * Called via glGetBufferSubDataARB().
 139  */
 140 static void
 141 st_bufferobj_get_subdata(struct gl_context *ctx,
 142                          GLintptrARB offset,
 143                          GLsizeiptrARB size,
 144                          GLvoid * data, struct gl_buffer_object *obj)
 145 {
 146    struct st_buffer_object *st_obj = st_buffer_object(obj);
 147
 148    /* we may be called from VBO code, so double-check params here */
 149    ASSERT(offset >= 0);
 150    ASSERT(size >= 0);
 151    ASSERT(offset + size <= obj->Size);
 152
 153    if (!size)
 154       return;
 155
 156    if (!st_obj->buffer) {
 157       /* we probably ran out of memory during buffer allocation */
 158       return;
 159    }
 160
 161    pipe_buffer_read(st_context(ctx)->pipe, st_obj->buffer,
 162                     offset, size, data);
 163 }
 164
 165
 166 /**
 167  * Allocate space for and store data in a buffer object.  Any data that was
 168  * previously stored in the buffer object is lost.  If data is NULL,
 169  * memory will be allocated, but no copy will occur.
 170  * Called via ctx->Driver.BufferData().
 171  * \return GL_TRUE for success, GL_FALSE if out of memory
 172  */
 173 static GLboolean
 174 st_bufferobj_data(struct gl_context *ctx,
 175                   GLenum target,
 176                   GLsizeiptrARB size,
 177                   const GLvoid * data,
 178                   GLenum usage,
 179                   struct gl_buffer_object *obj)
 180 {
 181    struct st_context *st = st_context(ctx);
 182    struct pipe_context *pipe = st->pipe;
 183    struct st_buffer_object *st_obj = st_buffer_object(obj);
 184    unsigned bind, pipe_usage;
 185
 186    if (size && data && st_obj->buffer &&
 187        st_obj->Base.Size == size && st_obj->Base.Usage == usage) {
 188       /* Just discard the old contents and write new data.
 189        * This should be the same as creating a new buffer, but we avoid
 190        * a lot of validation in Mesa.
 191        */
 192       struct pipe_box box;
 193
 194       u_box_1d(0, size, &box);
 195       pipe->transfer_inline_write(pipe, st_obj->buffer, 0,
 196                                   PIPE_TRANSFER_DISCARD_WHOLE_RESOURCE,
 197                                   &box, data, 0, 0);
 198       return GL_TRUE;
 199    }
 200
 201    st_obj->Base.Size = size;
 202    st_obj->Base.Usage = usage;
 203
 204    switch (target) {
 205    case GL_PIXEL_PACK_BUFFER_ARB:
 206    case GL_PIXEL_UNPACK_BUFFER_ARB:
 207       bind = PIPE_BIND_RENDER_TARGET | PIPE_BIND_SAMPLER_VIEW;
 208       break;
 209    case GL_ARRAY_BUFFER_ARB:
 210       bind = PIPE_BIND_VERTEX_BUFFER;
 211       break;
 212    case GL_ELEMENT_ARRAY_BUFFER_ARB:
 213       bind = PIPE_BIND_INDEX_BUFFER;
 214       break;
 215    case GL_TEXTURE_BUFFER:
 216       bind = PIPE_BIND_SAMPLER_VIEW;
 217       break;
 218    case GL_TRANSFORM_FEEDBACK_BUFFER:
 219       bind = PIPE_BIND_STREAM_OUTPUT;
 220       break;
 221    case GL_UNIFORM_BUFFER:
 222       bind = PIPE_BIND_CONSTANT_BUFFER;
 223       break;
 224    default:
 225       bind = 0;
 226    }
 227
 228    switch (usage) {
 229    case GL_STATIC_DRAW:
 230    case GL_STATIC_READ:
 231    case GL_STATIC_COPY:
 232    default:
 233       pipe_usage = PIPE_USAGE_DEFAULT;
 234       break;
 235    case GL_DYNAMIC_DRAW:
 236    case GL_DYNAMIC_READ:
 237    case GL_DYNAMIC_COPY:
 238       pipe_usage = PIPE_USAGE_DYNAMIC;
 239       break;
 240    case GL_STREAM_DRAW:
 241    case GL_STREAM_READ:
 242    case GL_STREAM_COPY:
 243       pipe_usage = PIPE_USAGE_STREAM;
 244       break;
 245    }
 246
 247    pipe_resource_reference( &st_obj->buffer, NULL );
 248
 249    if (ST_DEBUG & DEBUG_BUFFER) {
 250       debug_printf("Create buffer size %td bind 0x%x\n", size, bind);
 251    }
 252
 253    if (size != 0) {
 254       st_obj->buffer = pipe_buffer_create(pipe->screen, bind,
 255                                           pipe_usage, size);
 256
 257       if (!st_obj->buffer) {
 258          /* out of memory */
 259          st_obj->Base.Size = 0;
 260          return GL_FALSE;
 261       }
 262
 263       if (data)
 264          pipe_buffer_write(pipe, st_obj->buffer, 0, size, data);
 265    }
 266
 267    /* BufferData may change an array or uniform buffer, need to update it */
 268    st->dirty.st |= ST_NEW_VERTEX_ARRAYS | ST_NEW_UNIFORM_BUFFER;
 269
 270    return GL_TRUE;
 271 }
 272
 273
 274 /**
 275  * Called via glMapBufferRange().
 276  */
 277 static void *
 278 st_bufferobj_map_range(struct gl_context *ctx,
 279                        GLintptr offset, GLsizeiptr length, GLbitfield access,
 280                        struct gl_buffer_object *obj)
 281 {
 282    struct pipe_context *pipe = st_context(ctx)->pipe;
 283    struct st_buffer_object *st_obj = st_buffer_object(obj);
 284    enum pipe_transfer_usage flags = 0x0;
 285
 286    if (access & GL_MAP_WRITE_BIT)
 287       flags |= PIPE_TRANSFER_WRITE;
 288
 289    if (access & GL_MAP_READ_BIT)
 290       flags |= PIPE_TRANSFER_READ;
 291
 292    if (access & GL_MAP_FLUSH_EXPLICIT_BIT)
 293       flags |= PIPE_TRANSFER_FLUSH_EXPLICIT;
 294
 295    if (access & GL_MAP_INVALIDATE_BUFFER_BIT) {
 296       flags |= PIPE_TRANSFER_DISCARD_WHOLE_RESOURCE;
 297    }
 298    else if (access & GL_MAP_INVALIDATE_RANGE_BIT) {
 299       if (offset == 0 && length == obj->Size)
 300          flags |= PIPE_TRANSFER_DISCARD_WHOLE_RESOURCE;
 301       else
 302          flags |= PIPE_TRANSFER_DISCARD_RANGE;
 303    }
 304
 305    if (access & GL_MAP_UNSYNCHRONIZED_BIT)
 306       flags |= PIPE_TRANSFER_UNSYNCHRONIZED;
 307
 308    /* ... other flags ...
 309     */
 310
 311    if (access & MESA_MAP_NOWAIT_BIT)
 312       flags |= PIPE_TRANSFER_DONTBLOCK;
 313
 314    assert(offset >= 0);
 315    assert(length >= 0);
 316    assert(offset < obj->Size);
 317    assert(offset + length <= obj->Size);
 318
 319    obj->Pointer = pipe_buffer_map_range(pipe,
 320                                         st_obj->buffer,
 321                                         offset, length,
 322                                         flags,
 323                                         &st_obj->transfer);
 324    if (obj->Pointer) {
 325       obj->Offset = offset;
 326       obj->Length = length;
 327       obj->AccessFlags = access;
 328    }
 329    else {
 330       st_obj->transfer = NULL;
 331    }
 332
 333    return obj->Pointer;
 334 }
 335
 336
 337 static void
 338 st_bufferobj_flush_mapped_range(struct gl_context *ctx,
 339                                 GLintptr offset, GLsizeiptr length,
 340                                 struct gl_buffer_object *obj)
 341 {
 342    struct pipe_context *pipe = st_context(ctx)->pipe;
 343    struct st_buffer_object *st_obj = st_buffer_object(obj);
 344
 345    /* Subrange is relative to mapped range */
 346    assert(offset >= 0);
 347    assert(length >= 0);
 348    assert(offset + length <= obj->Length);
 349    assert(obj->Pointer);
 350
 351    if (!length)
 352       return;
 353
 354    pipe_buffer_flush_mapped_range(pipe, st_obj->transfer,
 355                                   obj->Offset + offset, length);
 356 }
 357
 358
 359 /**
 360  * Called via glUnmapBufferARB().
 361  */
 362 static GLboolean
 363 st_bufferobj_unmap(struct gl_context *ctx, struct gl_buffer_object *obj)
 364 {
 365    struct pipe_context *pipe = st_context(ctx)->pipe;
 366    struct st_buffer_object *st_obj = st_buffer_object(obj);
 367
 368    if (obj->Length)
 369       pipe_buffer_unmap(pipe, st_obj->transfer);
 370
 371    st_obj->transfer = NULL;
 372    obj->Pointer = NULL;
 373    obj->Offset = 0;
 374    obj->Length = 0;
 375    return GL_TRUE;
 376 }
 377
 378
 379 /**
 380  * Called via glCopyBufferSubData().
 381  */
 382 static void
 383 st_copy_buffer_subdata(struct gl_context *ctx,
 384                        struct gl_buffer_object *src,
 385                        struct gl_buffer_object *dst,
 386                        GLintptr readOffset, GLintptr writeOffset,
 387                        GLsizeiptr size)
 388 {
 389    struct pipe_context *pipe = st_context(ctx)->pipe;
 390    struct st_buffer_object *srcObj = st_buffer_object(src);
 391    struct st_buffer_object *dstObj = st_buffer_object(dst);
 392    struct pipe_box box;
 393
 394    if (!size)
 395       return;
 396
 397    /* buffer should not already be mapped */
 398    assert(!src->Pointer);
 399    assert(!dst->Pointer);
 400
 401    u_box_1d(readOffset, size, &box);
 402
 403    pipe->resource_copy_region(pipe, dstObj->buffer, 0, writeOffset, 0, 0,
 404                               srcObj->buffer, 0, &box);
 405 }
 406
 407
 408 /* TODO: if buffer wasn't created with appropriate usage flags, need
 409  * to recreate it now and copy contents -- or possibly create a
 410  * gallium entrypoint to extend the usage flags and let the driver
 411  * decide if a copy is necessary.
 412  */
 413 void
 414 st_bufferobj_validate_usage(struct st_context *st,
 415                             struct st_buffer_object *obj,
 416                             unsigned usage)
 417 {
 418 }
 419
 420
 421 void
 422 st_init_bufferobject_functions(struct dd_function_table *functions)
 423 {
 424    /* plug in default driver fallbacks (such as for ClearBufferSubData) */
 425    _mesa_init_buffer_object_functions(functions);
 426
 427    functions->NewBufferObject = st_bufferobj_alloc;
 428    functions->DeleteBuffer = st_bufferobj_free;
 429    functions->BufferData = st_bufferobj_data;
 430    functions->BufferSubData = st_bufferobj_subdata;
 431    functions->GetBufferSubData = st_bufferobj_get_subdata;
 432    functions->MapBufferRange = st_bufferobj_map_range;
 433    functions->FlushMappedBufferRange = st_bufferobj_flush_mapped_range;
 434    functions->UnmapBuffer = st_bufferobj_unmap;
 435    functions->CopyBufferSubData = st_copy_buffer_subdata;
 436
 437    /* For GL_APPLE_vertex_array_object */
 438    functions->NewArrayObject = _mesa_new_vao;
 439    functions->DeleteArrayObject = _mesa_delete_vao;
 440 }