dlls/wined3d/resource.c

   1 /*
   2  * Copyright 2002-2004 Jason Edmeades
   3  * Copyright 2003-2004 Raphael Junqueira
   4  * Copyright 2004 Christian Costa
   5  * Copyright 2005 Oliver Stieber
   6  * Copyright 2009-2010 Henri Verbeet for CodeWeavers
   7  * Copyright 2006-2008, 2013 Stefan Dösinger for CodeWeavers
   8  *
   9  * This library is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public
  11  * License as published by the Free Software Foundation; either
  12  * version 2.1 of the License, or (at your option) any later version.
  13  *
  14  * This library is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with this library; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  22  */
  23
  24 #include "config.h"
  25 #include "wine/port.h"
  26 #include "wined3d_private.h"
  27
  28 WINE_DEFAULT_DEBUG_CHANNEL(d3d);
  29
  30 struct private_data
  31 {
  32     struct list entry;
  33
  34     GUID tag;
  35     DWORD flags; /* DDSPD_* */
  36
  37     union
  38     {
  39         void *data;
  40         IUnknown *object;
  41     } ptr;
  42
  43     DWORD size;
  44 };
  45
  46 static DWORD resource_access_from_pool(enum wined3d_pool pool)
  47 {
  48     switch (pool)
  49     {
  50         case WINED3D_POOL_DEFAULT:
  51             return WINED3D_RESOURCE_ACCESS_GPU;
  52
  53         case WINED3D_POOL_MANAGED:
  54             return WINED3D_RESOURCE_ACCESS_GPU | WINED3D_RESOURCE_ACCESS_CPU;
  55
  56         case WINED3D_POOL_SCRATCH:
  57         case WINED3D_POOL_SYSTEM_MEM:
  58             return WINED3D_RESOURCE_ACCESS_CPU;
  59
  60         default:
  61             FIXME("Unhandled pool %#x.\n", pool);
  62             return 0;
  63     }
  64 }
  65
  66 static void resource_check_usage(DWORD usage)
  67 {
  68     static const DWORD handled = WINED3DUSAGE_RENDERTARGET
  69             | WINED3DUSAGE_DEPTHSTENCIL
  70             | WINED3DUSAGE_DYNAMIC
  71             | WINED3DUSAGE_AUTOGENMIPMAP
  72             | WINED3DUSAGE_STATICDECL
  73             | WINED3DUSAGE_OVERLAY;
  74
  75     if (usage & ~handled)
  76         FIXME("Unhandled usage flags %#x.\n", usage & ~handled);
  77 }
  78
  79 HRESULT resource_init(struct wined3d_resource *resource, struct wined3d_device *device,
  80         enum wined3d_resource_type type, const struct wined3d_format *format,
  81         enum wined3d_multisample_type multisample_type, UINT multisample_quality,
  82         DWORD usage, enum wined3d_pool pool, UINT width, UINT height, UINT depth, UINT size,
  83         void *parent, const struct wined3d_parent_ops *parent_ops,
  84         const struct wined3d_resource_ops *resource_ops)
  85 {
  86     const struct wined3d *d3d = device->wined3d;
  87
  88     resource->ref = 1;
  89     resource->device = device;
  90     resource->type = type;
  91     resource->format = format;
  92     resource->multisample_type = multisample_type;
  93     resource->multisample_quality = multisample_quality;
  94     resource->usage = usage;
  95     resource->pool = pool;
  96     resource->access_flags = resource_access_from_pool(pool);
  97     if (usage & WINED3DUSAGE_DYNAMIC)
  98         resource->access_flags |= WINED3D_RESOURCE_ACCESS_CPU;
  99     resource->width = width;
 100     resource->height = height;
 101     resource->depth = depth;
 102     resource->size = size;
 103     resource->priority = 0;
 104     resource->parent = parent;
 105     resource->parent_ops = parent_ops;
 106     resource->resource_ops = resource_ops;
 107     list_init(&resource->privateData);
 108
 109     resource_check_usage(usage);
 110
 111     if (size)
 112     {
 113         resource->heap_memory = wined3d_resource_allocate_sysmem(size);
 114         if (!resource->heap_memory)
 115         {
 116             ERR("Out of memory!\n");
 117             return WINED3DERR_OUTOFVIDEOMEMORY;
 118         }
 119     }
 120     else
 121     {
 122         resource->heap_memory = NULL;
 123     }
 124     resource->allocatedMemory = resource->heap_memory;
 125
 126     /* Check that we have enough video ram left */
 127     if (pool == WINED3D_POOL_DEFAULT && d3d->flags & WINED3D_VIDMEM_ACCOUNTING)
 128     {
 129         if (size > wined3d_device_get_available_texture_mem(device))
 130         {
 131             ERR("Out of adapter memory\n");
 132             wined3d_resource_free_sysmem(resource->heap_memory);
 133             return WINED3DERR_OUTOFVIDEOMEMORY;
 134         }
 135         adapter_adjust_memory(device->adapter, size);
 136     }
 137
 138     device_resource_add(device, resource);
 139
 140     return WINED3D_OK;
 141 }
 142
 143 void resource_cleanup(struct wined3d_resource *resource)
 144 {
 145     const struct wined3d *d3d = resource->device->wined3d;
 146     struct private_data *data;
 147     struct list *e1, *e2;
 148     HRESULT hr;
 149
 150     TRACE("Cleaning up resource %p.\n", resource);
 151
 152     if (resource->pool == WINED3D_POOL_DEFAULT && d3d->flags & WINED3D_VIDMEM_ACCOUNTING)
 153     {
 154         TRACE("Decrementing device memory pool by %u.\n", resource->size);
 155         adapter_adjust_memory(resource->device->adapter, 0 - resource->size);
 156     }
 157
 158     LIST_FOR_EACH_SAFE(e1, e2, &resource->privateData)
 159     {
 160         data = LIST_ENTRY(e1, struct private_data, entry);
 161         hr = wined3d_resource_free_private_data(resource, &data->tag);
 162         if (FAILED(hr))
 163             ERR("Failed to free private data when destroying resource %p, hr = %#x.\n", resource, hr);
 164     }
 165
 166     wined3d_resource_free_sysmem(resource->heap_memory);
 167     resource->allocatedMemory = NULL;
 168     resource->heap_memory = NULL;
 169
 170     device_resource_released(resource->device, resource);
 171 }
 172
 173 void resource_unload(struct wined3d_resource *resource)
 174 {
 175     if (resource->map_count)
 176         ERR("Resource %p is being unloaded while mapped.\n", resource);
 177
 178     context_resource_unloaded(resource->device,
 179             resource, resource->type);
 180 }
 181
 182 static struct private_data *resource_find_private_data(const struct wined3d_resource *resource, REFGUID tag)
 183 {
 184     struct private_data *data;
 185     struct list *entry;
 186
 187     TRACE("Searching for private data %s\n", debugstr_guid(tag));
 188     LIST_FOR_EACH(entry, &resource->privateData)
 189     {
 190         data = LIST_ENTRY(entry, struct private_data, entry);
 191         if (IsEqualGUID(&data->tag, tag)) {
 192             TRACE("Found %p\n", data);
 193             return data;
 194         }
 195     }
 196     TRACE("Not found\n");
 197     return NULL;
 198 }
 199
 200 HRESULT CDECL wined3d_resource_set_private_data(struct wined3d_resource *resource, REFGUID guid,
 201         const void *data, DWORD data_size, DWORD flags)
 202 {
 203     struct private_data *d;
 204
 205     TRACE("resource %p, riid %s, data %p, data_size %u, flags %#x.\n",
 206             resource, debugstr_guid(guid), data, data_size, flags);
 207
 208     wined3d_resource_free_private_data(resource, guid);
 209
 210     d = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(*d));
 211     if (!d) return E_OUTOFMEMORY;
 212
 213     d->tag = *guid;
 214     d->flags = flags;
 215
 216     if (flags & WINED3DSPD_IUNKNOWN)
 217     {
 218         if (data_size != sizeof(IUnknown *))
 219         {
 220             WARN("IUnknown data with size %u, returning WINED3DERR_INVALIDCALL.\n", data_size);
 221             HeapFree(GetProcessHeap(), 0, d);
 222             return WINED3DERR_INVALIDCALL;
 223         }
 224         d->ptr.object = (IUnknown *)data;
 225         d->size = sizeof(IUnknown *);
 226         IUnknown_AddRef(d->ptr.object);
 227     }
 228     else
 229     {
 230         d->ptr.data = HeapAlloc(GetProcessHeap(), 0, data_size);
 231         if (!d->ptr.data)
 232         {
 233             HeapFree(GetProcessHeap(), 0, d);
 234             return E_OUTOFMEMORY;
 235         }
 236         d->size = data_size;
 237         memcpy(d->ptr.data, data, data_size);
 238     }
 239     list_add_tail(&resource->privateData, &d->entry);
 240
 241     return WINED3D_OK;
 242 }
 243
 244 HRESULT CDECL wined3d_resource_get_private_data(const struct wined3d_resource *resource, REFGUID guid,
 245         void *data, DWORD *data_size)
 246 {
 247     const struct private_data *d;
 248
 249     TRACE("resource %p, guid %s, data %p, data_size %p.\n",
 250             resource, debugstr_guid(guid), data, data_size);
 251
 252     d = resource_find_private_data(resource, guid);
 253     if (!d) return WINED3DERR_NOTFOUND;
 254
 255     if (*data_size < d->size)
 256     {
 257         *data_size = d->size;
 258         return WINED3DERR_MOREDATA;
 259     }
 260
 261     if (d->flags & WINED3DSPD_IUNKNOWN)
 262     {
 263         *(IUnknown **)data = d->ptr.object;
 264         if (resource->device->wined3d->dxVersion != 7)
 265         {
 266             /* D3D8 and D3D9 addref the private data, DDraw does not. This
 267              * can't be handled in ddraw because it doesn't know if the
 268              * pointer returned is an IUnknown * or just a blob. */
 269             IUnknown_AddRef(d->ptr.object);
 270         }
 271     }
 272     else
 273     {
 274         memcpy(data, d->ptr.data, d->size);
 275     }
 276
 277     return WINED3D_OK;
 278 }
 279 HRESULT CDECL wined3d_resource_free_private_data(struct wined3d_resource *resource, REFGUID guid)
 280 {
 281     struct private_data *data;
 282
 283     TRACE("resource %p, guid %s.\n", resource, debugstr_guid(guid));
 284
 285     data = resource_find_private_data(resource, guid);
 286     if (!data) return WINED3DERR_NOTFOUND;
 287
 288     if (data->flags & WINED3DSPD_IUNKNOWN)
 289     {
 290         if (data->ptr.object)
 291             IUnknown_Release(data->ptr.object);
 292     }
 293     else
 294     {
 295         HeapFree(GetProcessHeap(), 0, data->ptr.data);
 296     }
 297     list_remove(&data->entry);
 298
 299     HeapFree(GetProcessHeap(), 0, data);
 300
 301     return WINED3D_OK;
 302 }
 303
 304 DWORD resource_set_priority(struct wined3d_resource *resource, DWORD priority)
 305 {
 306     DWORD prev = resource->priority;
 307     resource->priority = priority;
 308     TRACE("resource %p, new priority %u, returning old priority %u.\n", resource, priority, prev);
 309     return prev;
 310 }
 311
 312 DWORD resource_get_priority(const struct wined3d_resource *resource)
 313 {
 314     TRACE("resource %p, returning %u.\n", resource, resource->priority);
 315     return resource->priority;
 316 }
 317
 318 void * CDECL wined3d_resource_get_parent(const struct wined3d_resource *resource)
 319 {
 320     return resource->parent;
 321 }
 322
 323 void CDECL wined3d_resource_get_desc(const struct wined3d_resource *resource, struct wined3d_resource_desc *desc)
 324 {
 325     desc->resource_type = resource->type;
 326     desc->format = resource->format->id;
 327     desc->multisample_type = resource->multisample_type;
 328     desc->multisample_quality = resource->multisample_quality;
 329     desc->usage = resource->usage;
 330     desc->pool = resource->pool;
 331     desc->width = resource->width;
 332     desc->height = resource->height;
 333     desc->depth = resource->depth;
 334     desc->size = resource->size;
 335 }
 336
 337 void *wined3d_resource_allocate_sysmem(SIZE_T size)
 338 {
 339     void **p;
 340     SIZE_T align = RESOURCE_ALIGNMENT - 1 + sizeof(*p);
 341     void *mem;
 342
 343     if (!(mem = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, size + align)))
 344         return NULL;
 345
 346     p = (void **)(((ULONG_PTR)mem + align) & ~(RESOURCE_ALIGNMENT - 1)) - 1;
 347     *p = mem;
 348
 349     return ++p;
 350 }
 351
 352 void wined3d_resource_free_sysmem(void *mem)
 353 {
 354     void **p = mem;
 355
 356     if (!mem)
 357         return;
 358
 359     HeapFree(GetProcessHeap(), 0, *(--p));
 360 }
 361
 362 DWORD wined3d_resource_sanitize_map_flags(const struct wined3d_resource *resource, DWORD flags)
 363 {
 364     /* Not all flags make sense together, but Windows never returns an error.
 365      * Catch the cases that could cause issues. */
 366     if (flags & WINED3D_MAP_READONLY)
 367     {
 368         if (flags & WINED3D_MAP_DISCARD)
 369         {
 370             WARN("WINED3D_MAP_READONLY combined with WINED3D_MAP_DISCARD, ignoring flags.\n");
 371             return 0;
 372         }
 373         if (flags & WINED3D_MAP_NOOVERWRITE)
 374         {
 375             WARN("WINED3D_MAP_READONLY combined with WINED3D_MAP_NOOVERWRITE, ignoring flags.\n");
 376             return 0;
 377         }
 378     }
 379     else if ((flags & (WINED3D_MAP_DISCARD | WINED3D_MAP_NOOVERWRITE))
 380             == (WINED3D_MAP_DISCARD | WINED3D_MAP_NOOVERWRITE))
 381     {
 382         WARN("WINED3D_MAP_DISCARD and WINED3D_MAP_NOOVERWRITE used together, ignoring.\n");
 383         return 0;
 384     }
 385     else if (flags & (WINED3D_MAP_DISCARD | WINED3D_MAP_NOOVERWRITE)
 386             && !(resource->usage & WINED3DUSAGE_DYNAMIC))
 387     {
 388         WARN("DISCARD or NOOVERWRITE map on non-dynamic buffer, ignoring.\n");
 389         return 0;
 390     }
 391
 392     return flags;
 393 }
 394
 395 GLbitfield wined3d_resource_gl_map_flags(DWORD d3d_flags)
 396 {
 397     GLbitfield ret = 0;
 398
 399     if (!(d3d_flags & WINED3D_MAP_READONLY))
 400         ret |= GL_MAP_WRITE_BIT | GL_MAP_FLUSH_EXPLICIT_BIT;
 401     if (!(d3d_flags & (WINED3D_MAP_DISCARD | WINED3D_MAP_NOOVERWRITE)))
 402         ret |= GL_MAP_READ_BIT;
 403
 404     if (d3d_flags & WINED3D_MAP_DISCARD)
 405         ret |= GL_MAP_INVALIDATE_BUFFER_BIT;
 406     if (d3d_flags & WINED3D_MAP_NOOVERWRITE)
 407         ret |= GL_MAP_UNSYNCHRONIZED_BIT;
 408
 409     return ret;
 410 }