src/gallium/drivers/zink/zink_resource.c

   1 /*
   2  * Copyright 2018 Collabora Ltd.
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the "Software"),
   6  * to deal in the Software without restriction, including without limitation
   7  * on the rights to use, copy, modify, merge, publish, distribute, sub
   8  * license, and/or sell copies of the Software, and to permit persons to whom
   9  * the Software is furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice (including the next
  12  * paragraph) shall be included in all copies or substantial portions of the
  13  * Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
  18  * THE AUTHOR(S) AND/OR THEIR SUPPLIERS BE LIABLE FOR ANY CLAIM,
  19  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
  20  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
  21  * USE OR OTHER DEALINGS IN THE SOFTWARE.
  22  */
  23
  24 #include "zink_resource.h"
  25
  26 #include "zink_batch.h"
  27 #include "zink_context.h"
  28 #include "zink_screen.h"
  29
  30 #include "util/slab.h"
  31 #include "util/u_debug.h"
  32 #include "util/u_format.h"
  33 #include "util/u_inlines.h"
  34 #include "util/u_memory.h"
  35
  36 #include "state_tracker/sw_winsys.h"
  37
  38 static void
  39 zink_resource_destroy(struct pipe_screen *pscreen,
  40                       struct pipe_resource *pres)
  41 {
  42    struct zink_screen *screen = zink_screen(pscreen);
  43    struct zink_resource *res = zink_resource(pres);
  44    if (pres->target == PIPE_BUFFER)
  45       vkDestroyBuffer(screen->dev, res->buffer, NULL);
  46    else
  47       vkDestroyImage(screen->dev, res->image, NULL);
  48
  49    vkFreeMemory(screen->dev, res->mem, NULL);
  50    FREE(res);
  51 }
  52
  53 static uint32_t
  54 get_memory_type_index(struct zink_screen *screen,
  55                       const VkMemoryRequirements *reqs,
  56                       VkMemoryPropertyFlags props)
  57 {
  58    for (uint32_t i = 0u; i < VK_MAX_MEMORY_TYPES; i++) {
  59       if (((reqs->memoryTypeBits >> i) & 1) == 1) {
  60          if ((screen->mem_props.memoryTypes[i].propertyFlags & props) == props) {
  61             return i;
  62             break;
  63          }
  64       }
  65    }
  66
  67    unreachable("Unsupported memory-type");
  68    return 0;
  69 }
  70
  71 static VkImageAspectFlags
  72 aspect_from_format(enum pipe_format fmt)
  73 {
  74    if (util_format_is_depth_or_stencil(fmt)) {
  75       VkImageAspectFlags aspect = 0;
  76       const struct util_format_description *desc = util_format_description(fmt);
  77       if (util_format_has_depth(desc))
  78          aspect |= VK_IMAGE_ASPECT_DEPTH_BIT;
  79       if (util_format_has_stencil(desc))
  80          aspect |= VK_IMAGE_ASPECT_STENCIL_BIT;
  81       return aspect;
  82    } else
  83      return VK_IMAGE_ASPECT_COLOR_BIT;
  84 }
  85
  86 static struct pipe_resource *
  87 zink_resource_create(struct pipe_screen *pscreen,
  88                      const struct pipe_resource *templ)
  89 {
  90    struct zink_screen *screen = zink_screen(pscreen);
  91    struct zink_resource *res = CALLOC_STRUCT(zink_resource);
  92
  93    res->base = *templ;
  94
  95    pipe_reference_init(&res->base.reference, 1);
  96    res->base.screen = pscreen;
  97
  98    VkMemoryRequirements reqs;
  99    VkMemoryPropertyFlags flags = 0;
 100    if (templ->target == PIPE_BUFFER) {
 101       VkBufferCreateInfo bci = {};
 102       bci.sType = VK_STRUCTURE_TYPE_BUFFER_CREATE_INFO;
 103       bci.size = templ->width0;
 104
 105       bci.usage = 0;
 106
 107       if (templ->bind & PIPE_BIND_VERTEX_BUFFER)
 108          bci.usage |= VK_BUFFER_USAGE_VERTEX_BUFFER_BIT;
 109
 110       if (templ->bind & PIPE_BIND_INDEX_BUFFER)
 111          bci.usage |= VK_BUFFER_USAGE_INDEX_BUFFER_BIT;
 112
 113       if (templ->bind & PIPE_BIND_CONSTANT_BUFFER)
 114          bci.usage |= VK_BUFFER_USAGE_UNIFORM_BUFFER_BIT;
 115
 116       if (templ->bind & PIPE_BIND_SHADER_BUFFER)
 117          bci.usage |= VK_BUFFER_USAGE_STORAGE_BUFFER_BIT;
 118
 119       if (templ->bind & PIPE_BIND_COMMAND_ARGS_BUFFER)
 120          bci.usage |= VK_BUFFER_USAGE_INDIRECT_BUFFER_BIT;
 121
 122       if (templ->usage == PIPE_USAGE_STAGING)
 123          bci.usage |= VK_BUFFER_USAGE_TRANSFER_SRC_BIT | VK_BUFFER_USAGE_TRANSFER_DST_BIT;
 124
 125       if (vkCreateBuffer(screen->dev, &bci, NULL, &res->buffer) !=
 126           VK_SUCCESS) {
 127          FREE(res);
 128          return NULL;
 129       }
 130
 131       vkGetBufferMemoryRequirements(screen->dev, res->buffer, &reqs);
 132       flags |= VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT;
 133    } else {
 134       res->format = zink_get_format(templ->format);
 135
 136       VkImageCreateInfo ici = {};
 137       ici.sType = VK_STRUCTURE_TYPE_IMAGE_CREATE_INFO;
 138
 139       switch (templ->target) {
 140       case PIPE_TEXTURE_1D:
 141       case PIPE_TEXTURE_1D_ARRAY:
 142          ici.imageType = VK_IMAGE_TYPE_1D;
 143          break;
 144
 145       case PIPE_TEXTURE_CUBE:
 146       case PIPE_TEXTURE_CUBE_ARRAY:
 147          ici.flags = VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT;
 148          /* fall-through */
 149       case PIPE_TEXTURE_2D:
 150       case PIPE_TEXTURE_2D_ARRAY:
 151       case PIPE_TEXTURE_RECT:
 152          ici.imageType = VK_IMAGE_TYPE_2D;
 153          break;
 154
 155       case PIPE_TEXTURE_3D:
 156          ici.imageType = VK_IMAGE_TYPE_3D;
 157          if (templ->bind & PIPE_BIND_RENDER_TARGET)
 158             ici.flags = VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT;
 159          break;
 160
 161       case PIPE_BUFFER:
 162          unreachable("PIPE_BUFFER should already be handled");
 163
 164       default:
 165          unreachable("Unknown target");
 166       }
 167
 168       ici.format = res->format;
 169       ici.extent.width = templ->width0;
 170       ici.extent.height = templ->height0;
 171       ici.extent.depth = templ->depth0;
 172       ici.mipLevels = templ->last_level + 1;
 173       ici.arrayLayers = templ->array_size;
 174       ici.samples = templ->nr_samples ? templ->nr_samples : VK_SAMPLE_COUNT_1_BIT;
 175       ici.tiling = templ->bind & PIPE_BIND_LINEAR ? VK_IMAGE_TILING_LINEAR : VK_IMAGE_TILING_OPTIMAL;
 176
 177       if (templ->target == PIPE_TEXTURE_CUBE ||
 178           templ->target == PIPE_TEXTURE_CUBE_ARRAY)
 179          ici.arrayLayers *= 6;
 180
 181       if (templ->bind & (PIPE_BIND_DISPLAY_TARGET |
 182                          PIPE_BIND_SCANOUT |
 183                          PIPE_BIND_SHARED)) {
 184          // assert(ici.tiling == VK_IMAGE_TILING_LINEAR);
 185          ici.tiling = VK_IMAGE_TILING_LINEAR;
 186       }
 187
 188       if (templ->usage == PIPE_USAGE_STAGING)
 189          ici.tiling = VK_IMAGE_TILING_LINEAR;
 190
 191       /* sadly, gallium doesn't let us know if it'll ever need this, so we have to assume */
 192       ici.usage = VK_IMAGE_USAGE_TRANSFER_SRC_BIT | VK_IMAGE_USAGE_TRANSFER_DST_BIT;
 193
 194       if (templ->bind & PIPE_BIND_SAMPLER_VIEW)
 195          ici.usage |= VK_IMAGE_USAGE_SAMPLED_BIT;
 196
 197       if (templ->bind & PIPE_BIND_SHADER_IMAGE)
 198          ici.usage |= VK_IMAGE_USAGE_STORAGE_BIT;
 199
 200       if (templ->bind & PIPE_BIND_RENDER_TARGET)
 201          ici.usage |= VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT;
 202
 203       if (templ->bind & PIPE_BIND_DEPTH_STENCIL)
 204          ici.usage |= VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT;
 205
 206       if (templ->flags & PIPE_RESOURCE_FLAG_SPARSE)
 207          ici.usage |= VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT;
 208
 209       if (templ->bind & PIPE_BIND_STREAM_OUTPUT)
 210          ici.usage |= VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
 211
 212       ici.sharingMode = VK_SHARING_MODE_EXCLUSIVE;
 213       ici.initialLayout = VK_IMAGE_LAYOUT_UNDEFINED;
 214       res->layout = VK_IMAGE_LAYOUT_UNDEFINED;
 215
 216       VkResult result = vkCreateImage(screen->dev, &ici, NULL, &res->image);
 217       if (result != VK_SUCCESS) {
 218          FREE(res);
 219          return NULL;
 220       }
 221
 222       res->optimial_tiling = ici.tiling != VK_IMAGE_TILING_LINEAR;
 223       res->aspect = aspect_from_format(templ->format);
 224
 225       vkGetImageMemoryRequirements(screen->dev, res->image, &reqs);
 226       if (templ->usage == PIPE_USAGE_STAGING || (screen->winsys && (templ->bind & (PIPE_BIND_SCANOUT|PIPE_BIND_DISPLAY_TARGET|PIPE_BIND_SHARED))))
 227         flags |= VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT;
 228       else
 229         flags |= VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT;
 230    }
 231
 232    VkMemoryAllocateInfo mai = {};
 233    mai.sType = VK_STRUCTURE_TYPE_MEMORY_ALLOCATE_INFO;
 234    mai.allocationSize = reqs.size;
 235    mai.memoryTypeIndex = get_memory_type_index(screen, &reqs, flags);
 236
 237    VkExportMemoryAllocateInfo emai = {};
 238    if (templ->bind & PIPE_BIND_SHARED) {
 239       emai.sType = VK_STRUCTURE_TYPE_EXPORT_MEMORY_ALLOCATE_INFO;
 240       emai.handleTypes = VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_FD_BIT;
 241       mai.pNext = &emai;
 242    }
 243
 244    if (vkAllocateMemory(screen->dev, &mai, NULL, &res->mem) != VK_SUCCESS)
 245       goto fail;
 246
 247    res->offset = 0;
 248    res->size = reqs.size;
 249
 250    if (templ->target == PIPE_BUFFER)
 251       vkBindBufferMemory(screen->dev, res->buffer, res->mem, res->offset);
 252    else
 253       vkBindImageMemory(screen->dev, res->image, res->mem, res->offset);
 254
 255    if (screen->winsys && (templ->bind & (PIPE_BIND_DISPLAY_TARGET |
 256                                          PIPE_BIND_SCANOUT |
 257                                          PIPE_BIND_SHARED))) {
 258       struct sw_winsys *winsys = screen->winsys;
 259       res->dt = winsys->displaytarget_create(screen->winsys,
 260                                              res->base.bind,
 261                                              res->base.format,
 262                                              templ->width0,
 263                                              templ->height0,
 264                                              64, NULL,
 265                                              &res->dt_stride);
 266    }
 267
 268    return &res->base;
 269
 270 fail:
 271    if (templ->target == PIPE_BUFFER)
 272       vkDestroyBuffer(screen->dev, res->buffer, NULL);
 273    else
 274       vkDestroyImage(screen->dev, res->image, NULL);
 275
 276    FREE(res);
 277
 278    return NULL;
 279 }
 280
 281 static bool
 282 zink_resource_get_handle(struct pipe_screen *pscreen,
 283                          struct pipe_context *context,
 284                          struct pipe_resource *tex,
 285                          struct winsys_handle *whandle,
 286                          unsigned usage)
 287 {
 288    struct zink_resource *res = zink_resource(tex);
 289    struct zink_screen *screen = zink_screen(pscreen);
 290    VkMemoryGetFdInfoKHR fd_info = {};
 291    int fd;
 292
 293    if (res->base.target != PIPE_BUFFER) {
 294       VkImageSubresource sub_res = {};
 295       VkSubresourceLayout sub_res_layout = {};
 296
 297       sub_res.aspectMask = res->aspect;
 298
 299       vkGetImageSubresourceLayout(screen->dev, res->image, &sub_res, &sub_res_layout);
 300
 301       whandle->stride = sub_res_layout.rowPitch;
 302    }
 303
 304    if (whandle->type == WINSYS_HANDLE_TYPE_FD) {
 305
 306       if (!screen->vk_GetMemoryFdKHR)
 307          screen->vk_GetMemoryFdKHR = (PFN_vkGetMemoryFdKHR)vkGetDeviceProcAddr(screen->dev, "vkGetMemoryFdKHR");
 308       if (!screen->vk_GetMemoryFdKHR)
 309          return false;
 310       fd_info.sType = VK_STRUCTURE_TYPE_MEMORY_GET_FD_INFO_KHR;
 311       fd_info.memory = res->mem;
 312       fd_info.handleType = VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_FD_BIT;
 313       VkResult result = (*screen->vk_GetMemoryFdKHR)(screen->dev, &fd_info, &fd);
 314       if (result != VK_SUCCESS)
 315          return false;
 316       whandle->handle = fd;
 317    }
 318    return true;
 319 }
 320
 321 static struct pipe_resource *
 322 zink_resource_from_handle(struct pipe_screen *pscreen,
 323                  const struct pipe_resource *templat,
 324                  struct winsys_handle *whandle,
 325                  unsigned usage)
 326 {
 327    return NULL;
 328 }
 329
 330 void
 331 zink_screen_resource_init(struct pipe_screen *pscreen)
 332 {
 333    pscreen->resource_create = zink_resource_create;
 334    pscreen->resource_destroy = zink_resource_destroy;
 335    pscreen->resource_get_handle = zink_resource_get_handle;
 336    pscreen->resource_from_handle = zink_resource_from_handle;
 337 }
 338
 339 static bool
 340 zink_transfer_copy_bufimage(struct zink_context *ctx,
 341                             struct zink_resource *res,
 342                             struct zink_resource *staging_res,
 343                             struct zink_transfer *trans,
 344                             bool buf2img)
 345 {
 346    struct zink_batch *batch = zink_batch_no_rp(ctx);
 347
 348    if (res->layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL &&
 349        res->layout != VK_IMAGE_LAYOUT_GENERAL) {
 350       zink_resource_barrier(batch->cmdbuf, res, res->aspect,
 351                             VK_IMAGE_LAYOUT_GENERAL);
 352       res->layout = VK_IMAGE_LAYOUT_GENERAL;
 353    }
 354
 355    VkBufferImageCopy copyRegion = {};
 356    copyRegion.bufferOffset = staging_res->offset;
 357    copyRegion.bufferRowLength = 0;
 358    copyRegion.bufferImageHeight = 0;
 359    copyRegion.imageSubresource.mipLevel = trans->base.level;
 360    copyRegion.imageSubresource.layerCount = 1;
 361    if (res->base.array_size > 1) {
 362       copyRegion.imageSubresource.baseArrayLayer = trans->base.box.z;
 363       copyRegion.imageSubresource.layerCount = trans->base.box.depth;
 364       copyRegion.imageExtent.depth = 1;
 365    } else {
 366       copyRegion.imageOffset.z = trans->base.box.z;
 367       copyRegion.imageExtent.depth = trans->base.box.depth;
 368    }
 369    copyRegion.imageOffset.x = trans->base.box.x;
 370    copyRegion.imageOffset.y = trans->base.box.y;
 371
 372    copyRegion.imageExtent.width = trans->base.box.width;
 373    copyRegion.imageExtent.height = trans->base.box.height;
 374
 375    zink_batch_reference_resoure(batch, res);
 376    zink_batch_reference_resoure(batch, staging_res);
 377
 378    unsigned aspects = res->aspect;
 379    while (aspects) {
 380       int aspect = 1 << u_bit_scan(&aspects);
 381       copyRegion.imageSubresource.aspectMask = aspect;
 382
 383       if (buf2img)
 384          vkCmdCopyBufferToImage(batch->cmdbuf, staging_res->buffer, res->image, res->layout, 1, &copyRegion);
 385       else
 386          vkCmdCopyImageToBuffer(batch->cmdbuf, res->image, res->layout, staging_res->buffer, 1, &copyRegion);
 387    }
 388
 389    return true;
 390 }
 391
 392 static void *
 393 zink_transfer_map(struct pipe_context *pctx,
 394                   struct pipe_resource *pres,
 395                   unsigned level,
 396                   unsigned usage,
 397                   const struct pipe_box *box,
 398                   struct pipe_transfer **transfer)
 399 {
 400    struct zink_context *ctx = zink_context(pctx);
 401    struct zink_screen *screen = zink_screen(pctx->screen);
 402    struct zink_resource *res = zink_resource(pres);
 403
 404    struct zink_transfer *trans = slab_alloc(&ctx->transfer_pool);
 405    if (!trans)
 406       return NULL;
 407
 408    memset(trans, 0, sizeof(*trans));
 409    pipe_resource_reference(&trans->base.resource, pres);
 410
 411    trans->base.resource = pres;
 412    trans->base.level = level;
 413    trans->base.usage = usage;
 414    trans->base.box = *box;
 415
 416    void *ptr;
 417    if (pres->target == PIPE_BUFFER) {
 418       VkResult result = vkMapMemory(screen->dev, res->mem, res->offset, res->size, 0, &ptr);
 419       if (result != VK_SUCCESS)
 420          return NULL;
 421
 422       trans->base.stride = 0;
 423       trans->base.layer_stride = 0;
 424       ptr = ((uint8_t *)ptr) + box->x;
 425    } else {
 426       if (res->optimial_tiling || ((res->base.usage != PIPE_USAGE_STAGING))) {
 427          trans->base.stride = util_format_get_stride(pres->format, box->width);
 428          trans->base.layer_stride = util_format_get_2d_size(pres->format,
 429                                                             trans->base.stride,
 430                                                             box->height);
 431
 432          struct pipe_resource templ = *pres;
 433          templ.usage = PIPE_USAGE_STAGING;
 434          templ.target = PIPE_BUFFER;
 435          templ.bind = 0;
 436          templ.width0 = trans->base.layer_stride * box->depth;
 437          templ.height0 = templ.depth0 = 0;
 438          templ.last_level = 0;
 439          templ.array_size = 1;
 440          templ.flags = 0;
 441
 442          trans->staging_res = zink_resource_create(pctx->screen, &templ);
 443          if (!trans->staging_res)
 444             return NULL;
 445
 446          struct zink_resource *staging_res = zink_resource(trans->staging_res);
 447
 448          if (usage & PIPE_TRANSFER_READ) {
 449             struct zink_context *ctx = zink_context(pctx);
 450             bool ret = zink_transfer_copy_bufimage(ctx, res,
 451                                                    staging_res, trans,
 452                                                    false);
 453             if (ret == false)
 454                return NULL;
 455
 456             /* need to wait for rendering to finish */
 457             struct pipe_fence_handle *fence = NULL;
 458             pctx->flush(pctx, &fence, PIPE_FLUSH_HINT_FINISH);
 459             if (fence) {
 460                pctx->screen->fence_finish(pctx->screen, NULL, fence,
 461                                           PIPE_TIMEOUT_INFINITE);
 462                pctx->screen->fence_reference(pctx->screen, &fence, NULL);
 463             }
 464          }
 465
 466          VkResult result = vkMapMemory(screen->dev, staging_res->mem,
 467                                        staging_res->offset,
 468                                        staging_res->size, 0, &ptr);
 469          if (result != VK_SUCCESS)
 470             return NULL;
 471
 472       } else {
 473          assert(!res->optimial_tiling);
 474          VkResult result = vkMapMemory(screen->dev, res->mem, res->offset, res->size, 0, &ptr);
 475          if (result != VK_SUCCESS)
 476             return NULL;
 477          VkImageSubresource isr = {
 478             res->aspect,
 479             level,
 480             0
 481          };
 482          VkSubresourceLayout srl;
 483          vkGetImageSubresourceLayout(screen->dev, res->image, &isr, &srl);
 484          trans->base.stride = srl.rowPitch;
 485          trans->base.layer_stride = srl.arrayPitch;
 486          ptr = ((uint8_t *)ptr) + box->z * srl.depthPitch +
 487                                   box->y * srl.rowPitch +
 488                                   box->x;
 489       }
 490    }
 491
 492    *transfer = &trans->base;
 493    return ptr;
 494 }
 495
 496 static void
 497 zink_transfer_unmap(struct pipe_context *pctx,
 498                     struct pipe_transfer *ptrans)
 499 {
 500    struct zink_context *ctx = zink_context(pctx);
 501    struct zink_screen *screen = zink_screen(pctx->screen);
 502    struct zink_resource *res = zink_resource(ptrans->resource);
 503    struct zink_transfer *trans = (struct zink_transfer *)ptrans;
 504    if (trans->staging_res) {
 505       struct zink_resource *staging_res = zink_resource(trans->staging_res);
 506       vkUnmapMemory(screen->dev, staging_res->mem);
 507
 508       if (trans->base.usage & PIPE_TRANSFER_WRITE) {
 509          struct zink_context *ctx = zink_context(pctx);
 510
 511          zink_transfer_copy_bufimage(ctx, res, staging_res, trans, true);
 512       }
 513
 514       pipe_resource_reference(&trans->staging_res, NULL);
 515    } else
 516       vkUnmapMemory(screen->dev, res->mem);
 517
 518    pipe_resource_reference(&trans->base.resource, NULL);
 519    slab_free(&ctx->transfer_pool, ptrans);
 520 }
 521
 522 void
 523 zink_context_resource_init(struct pipe_context *pctx)
 524 {
 525    pctx->transfer_map = zink_transfer_map;
 526    pctx->transfer_unmap = zink_transfer_unmap;
 527
 528    pctx->transfer_flush_region = u_default_transfer_flush_region;
 529    pctx->buffer_subdata = u_default_buffer_subdata;
 530    pctx->texture_subdata = u_default_texture_subdata;
 531 }