src/mesa/state_tracker/st_cb_bufferobjects.c

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