src/gallium/state_trackers/nine/buffer9.c

   1 /*
   2  * Copyright 2011 Joakim Sindholt <opensource@zhasha.com>
   3  * Copyright 2015 Patrick Rudolph <siro@das-labor.org>
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a
   6  * copy of this software and associated documentation files (the "Software"),
   7  * to deal in the Software without restriction, including without limitation
   8  * on the rights to use, copy, modify, merge, publish, distribute, sub
   9  * license, and/or sell copies of the Software, and to permit persons to whom
  10  * the Software is furnished to do so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice (including the next
  13  * paragraph) shall be included in all copies or substantial portions of the
  14  * Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
  19  * THE AUTHOR(S) AND/OR THEIR SUPPLIERS BE LIABLE FOR ANY CLAIM,
  20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
  21  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
  22  * USE OR OTHER DEALINGS IN THE SOFTWARE. */
  23
  24 #include "buffer9.h"
  25 #include "device9.h"
  26 #include "nine_helpers.h"
  27 #include "nine_pipe.h"
  28
  29 #include "pipe/p_screen.h"
  30 #include "pipe/p_context.h"
  31 #include "pipe/p_state.h"
  32 #include "pipe/p_defines.h"
  33 #include "pipe/p_format.h"
  34 #include "util/u_box.h"
  35
  36 #define DBG_CHANNEL (DBG_INDEXBUFFER|DBG_VERTEXBUFFER)
  37
  38 HRESULT
  39 NineBuffer9_ctor( struct NineBuffer9 *This,
  40                         struct NineUnknownParams *pParams,
  41                         D3DRESOURCETYPE Type,
  42                         DWORD Usage,
  43                         UINT Size,
  44                         D3DPOOL Pool )
  45 {
  46     struct pipe_resource *info = &This->base.info;
  47     HRESULT hr;
  48
  49     DBG("This=%p Size=0x%x Usage=%x Pool=%u\n", This, Size, Usage, Pool);
  50
  51     user_assert(Pool != D3DPOOL_SCRATCH, D3DERR_INVALIDCALL);
  52
  53     This->maps = MALLOC(sizeof(struct pipe_transfer *));
  54     if (!This->maps)
  55         return E_OUTOFMEMORY;
  56     This->nmaps = 0;
  57     This->maxmaps = 1;
  58     This->size = Size;
  59
  60     This->pipe = pParams->device->pipe;
  61
  62     info->screen = pParams->device->screen;
  63     info->target = PIPE_BUFFER;
  64     info->format = PIPE_FORMAT_R8_UNORM;
  65     info->width0 = Size;
  66     info->flags = 0;
  67
  68     /* Note: WRITEONLY is just tip for resource placement, the resource
  69      * can still be read (but slower). */
  70     info->bind = PIPE_BIND_VERTEX_BUFFER;
  71
  72     /* It is hard to find clear information on where to place the buffer in
  73      * memory depending on the flag.
  74      * MSDN: resources are static, except for those with DYNAMIC, thus why you
  75      *   can only use DISCARD on them.
  76      * ATI doc: The driver has the liberty it wants for having things static
  77      *   or not.
  78      *   MANAGED: Ram + uploads to Vram copy at unlock (msdn and nvidia doc say
  79      *   at first draw call using the buffer)
  80      *   DEFAULT + Usage = 0 => System memory backing for easy read access
  81      *   (That doc is very unclear on the details, like whether some copies to
  82      *   vram copy are involved or not).
  83      *   DEFAULT + WRITEONLY => Vram
  84      *   DEFAULT + WRITEONLY + DYNAMIC => Either Vram buffer or GTT_WC, depending on what the driver wants.
  85      */
  86     if (Pool == D3DPOOL_SYSTEMMEM)
  87         info->usage = PIPE_USAGE_STAGING;
  88     else if (Pool == D3DPOOL_MANAGED)
  89         info->usage = PIPE_USAGE_DEFAULT;
  90     else if (Usage & D3DUSAGE_DYNAMIC && Usage & D3DUSAGE_WRITEONLY)
  91         info->usage = PIPE_USAGE_STREAM;
  92     else if (Usage & D3DUSAGE_WRITEONLY)
  93         info->usage = PIPE_USAGE_DEFAULT;
  94     /* For the remaining two, PIPE_USAGE_STAGING would probably be
  95      * a good fit according to the doc. However it seems rather a mistake
  96      * from apps to use these (mistakes that do really happen). Try
  97      * to put the flags that are the best compromise between the real
  98      * behaviour and what buggy apps should get for better performance. */
  99     else if (Usage & D3DUSAGE_DYNAMIC)
 100         info->usage = PIPE_USAGE_STREAM;
 101     else
 102         info->usage = PIPE_USAGE_DYNAMIC;
 103
 104     /* if (pDesc->Usage & D3DUSAGE_DONOTCLIP) { } */
 105     /* if (pDesc->Usage & D3DUSAGE_NONSECURE) { } */
 106     /* if (pDesc->Usage & D3DUSAGE_NPATCHES) { } */
 107     /* if (pDesc->Usage & D3DUSAGE_POINTS) { } */
 108     /* if (pDesc->Usage & D3DUSAGE_RTPATCHES) { } */
 109     /* The buffer must be usable with both sw and hw
 110      * vertex processing. It is expected to be slower with hw. */
 111     if (Usage & D3DUSAGE_SOFTWAREPROCESSING)
 112         info->usage = PIPE_USAGE_STAGING;
 113     /* if (pDesc->Usage & D3DUSAGE_TEXTAPI) { } */
 114
 115     info->height0 = 1;
 116     info->depth0 = 1;
 117     info->array_size = 1;
 118     info->last_level = 0;
 119     info->nr_samples = 0;
 120
 121     hr = NineResource9_ctor(&This->base, pParams, NULL, TRUE,
 122                             Type, Pool, Usage);
 123
 124     if (FAILED(hr))
 125         return hr;
 126
 127     if (Pool == D3DPOOL_MANAGED) {
 128         This->managed.data = align_calloc(
 129             nine_format_get_level_alloc_size(This->base.info.format,
 130                                              Size, 1, 0), 32);
 131         if (!This->managed.data)
 132             return E_OUTOFMEMORY;
 133         memset(This->managed.data, 0, Size);
 134         This->managed.dirty = TRUE;
 135         u_box_1d(0, Size, &This->managed.dirty_box);
 136         list_inithead(&This->managed.list);
 137         list_inithead(&This->managed.list2);
 138         list_add(&This->managed.list, &pParams->device->update_buffers);
 139         list_add(&This->managed.list2, &pParams->device->managed_buffers);
 140     }
 141
 142     return D3D_OK;
 143 }
 144
 145 void
 146 NineBuffer9_dtor( struct NineBuffer9 *This )
 147 {
 148     DBG("This=%p\n", This);
 149
 150     if (This->maps) {
 151         while (This->nmaps) {
 152             NineBuffer9_Unlock(This);
 153         }
 154         FREE(This->maps);
 155     }
 156
 157     if (This->base.pool == D3DPOOL_MANAGED) {
 158         if (This->managed.data)
 159             align_free(This->managed.data);
 160         if (This->managed.list.prev != NULL && This->managed.list.next != NULL)
 161             list_del(&This->managed.list);
 162         if (This->managed.list2.prev != NULL && This->managed.list2.next != NULL)
 163             list_del(&This->managed.list2);
 164     }
 165
 166     NineResource9_dtor(&This->base);
 167 }
 168
 169 struct pipe_resource *
 170 NineBuffer9_GetResource( struct NineBuffer9 *This )
 171 {
 172     return NineResource9_GetResource(&This->base);
 173 }
 174
 175 HRESULT NINE_WINAPI
 176 NineBuffer9_Lock( struct NineBuffer9 *This,
 177                         UINT OffsetToLock,
 178                         UINT SizeToLock,
 179                         void **ppbData,
 180                         DWORD Flags )
 181 {
 182     struct pipe_box box;
 183     void *data;
 184     unsigned usage;
 185
 186     DBG("This=%p(pipe=%p) OffsetToLock=0x%x, SizeToLock=0x%x, Flags=0x%x\n",
 187         This, This->base.resource,
 188         OffsetToLock, SizeToLock, Flags);
 189
 190     user_assert(ppbData, E_POINTER);
 191     user_assert(!(Flags & ~(D3DLOCK_DISCARD |
 192                             D3DLOCK_DONOTWAIT |
 193                             D3DLOCK_NO_DIRTY_UPDATE |
 194                             D3DLOCK_NOSYSLOCK |
 195                             D3DLOCK_READONLY |
 196                             D3DLOCK_NOOVERWRITE)), D3DERR_INVALIDCALL);
 197
 198     if (SizeToLock == 0) {
 199         SizeToLock = This->size - OffsetToLock;
 200         user_warn(OffsetToLock != 0);
 201     }
 202
 203     u_box_1d(OffsetToLock, SizeToLock, &box);
 204
 205     if (This->base.pool == D3DPOOL_MANAGED) {
 206         /* READONLY doesn't dirty the buffer */
 207         if (!(Flags & D3DLOCK_READONLY)) {
 208             if (!This->managed.dirty) {
 209                 assert(LIST_IS_EMPTY(&This->managed.list));
 210                 This->managed.dirty = TRUE;
 211                 This->managed.dirty_box = box;
 212             } else {
 213                 u_box_union_2d(&This->managed.dirty_box, &This->managed.dirty_box, &box);
 214                 /* Do not upload while we are locking, we'll add it back later */
 215                 if (!LIST_IS_EMPTY(&This->managed.list))
 216                     list_delinit(&This->managed.list);
 217             }
 218         }
 219         *ppbData = (char *)This->managed.data + OffsetToLock;
 220         DBG("returning pointer %p\n", *ppbData);
 221         This->nmaps++;
 222         return D3D_OK;
 223     }
 224
 225     /* Driver ddi doc: READONLY is never passed to the device. So it can only
 226      * have effect on things handled by the driver (MANAGED pool for example).
 227      * Msdn doc: DISCARD and NOOVERWRITE are only for DYNAMIC.
 228      * ATI doc: You can use DISCARD and NOOVERWRITE without DYNAMIC.
 229      * Msdn doc: D3DLOCK_DONOTWAIT is not among the valid flags for buffers.
 230      * Our tests: On win 7 nvidia, D3DLOCK_DONOTWAIT does return
 231      * D3DERR_WASSTILLDRAWING if the resource is in use, except for DYNAMIC.
 232      * Our tests: some apps do use both DISCARD and NOOVERWRITE at the same
 233      * time. On windows it seems to return different pointer, thus indicating
 234      * DISCARD is taken into account. */
 235
 236     if (Flags & D3DLOCK_DISCARD)
 237         usage = PIPE_TRANSFER_WRITE | PIPE_TRANSFER_DISCARD_WHOLE_RESOURCE;
 238     else if (Flags & D3DLOCK_NOOVERWRITE)
 239         usage = PIPE_TRANSFER_WRITE | PIPE_TRANSFER_UNSYNCHRONIZED;
 240     else
 241         usage = PIPE_TRANSFER_READ_WRITE;
 242     if (Flags & D3DLOCK_DONOTWAIT && !(This->base.usage & D3DUSAGE_DYNAMIC))
 243         usage |= PIPE_TRANSFER_DONTBLOCK;
 244
 245     if (This->nmaps == This->maxmaps) {
 246         struct pipe_transfer **newmaps =
 247             REALLOC(This->maps, sizeof(struct pipe_transfer *)*This->maxmaps,
 248                     sizeof(struct pipe_transfer *)*(This->maxmaps << 1));
 249         if (newmaps == NULL)
 250             return E_OUTOFMEMORY;
 251
 252         This->maxmaps <<= 1;
 253         This->maps = newmaps;
 254     }
 255
 256     data = This->pipe->transfer_map(This->pipe, This->base.resource, 0,
 257                                     usage, &box, &This->maps[This->nmaps]);
 258
 259     if (!data) {
 260         DBG("pipe::transfer_map failed\n"
 261             " usage = %x\n"
 262             " box.x = %u\n"
 263             " box.width = %u\n",
 264             usage, box.x, box.width);
 265
 266         if (Flags & D3DLOCK_DONOTWAIT)
 267             return D3DERR_WASSTILLDRAWING;
 268         return D3DERR_INVALIDCALL;
 269     }
 270
 271     DBG("returning pointer %p\n", data);
 272     This->nmaps++;
 273     *ppbData = data;
 274
 275     return D3D_OK;
 276 }
 277
 278 HRESULT NINE_WINAPI
 279 NineBuffer9_Unlock( struct NineBuffer9 *This )
 280 {
 281     DBG("This=%p\n", This);
 282
 283     user_assert(This->nmaps > 0, D3DERR_INVALIDCALL);
 284     if (This->base.pool != D3DPOOL_MANAGED)
 285         This->pipe->transfer_unmap(This->pipe, This->maps[--(This->nmaps)]);
 286     else {
 287         This->nmaps--;
 288         /* TODO: Fix this to upload at the first draw call needing the data,
 289          * instead of at the next draw call */
 290         if (!This->nmaps && This->managed.dirty && LIST_IS_EMPTY(&This->managed.list))
 291             list_add(&This->managed.list, &This->base.base.device->update_buffers);
 292     }
 293     return D3D_OK;
 294 }
 295
 296 void
 297 NineBuffer9_SetDirty( struct NineBuffer9 *This )
 298 {
 299     assert(This->base.pool == D3DPOOL_MANAGED);
 300
 301     if (!This->managed.dirty) {
 302         assert(LIST_IS_EMPTY(&This->managed.list));
 303         list_add(&This->managed.list, &This->base.base.device->update_buffers);
 304         This->managed.dirty = TRUE;
 305     }
 306     u_box_1d(0, This->size, &This->managed.dirty_box);
 307 }