src/intel/vulkan/anv_image.c

   1 /*
   2  * Copyright © 2015 Intel Corporation
   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  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * 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 NONINFRINGEMENT.  IN NO EVENT SHALL
  18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  21  * IN THE SOFTWARE.
  22  */
  23
  24 #include <assert.h>
  25 #include <stdbool.h>
  26 #include <string.h>
  27 #include <unistd.h>
  28 #include <fcntl.h>
  29
  30 #include "anv_private.h"
  31 #include "util/debug.h"
  32
  33 #include "vk_format_info.h"
  34
  35 /**
  36  * Exactly one bit must be set in \a aspect.
  37  */
  38 static isl_surf_usage_flags_t
  39 choose_isl_surf_usage(VkImageUsageFlags vk_usage,
  40                       VkImageAspectFlags aspect)
  41 {
  42    isl_surf_usage_flags_t isl_usage = 0;
  43
  44    /* FINISHME: Support aux surfaces */
  45    isl_usage |= ISL_SURF_USAGE_DISABLE_AUX_BIT;
  46
  47    if (vk_usage & VK_IMAGE_USAGE_SAMPLED_BIT)
  48       isl_usage |= ISL_SURF_USAGE_TEXTURE_BIT;
  49
  50    if (vk_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)
  51       isl_usage |= ISL_SURF_USAGE_TEXTURE_BIT;
  52
  53    if (vk_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)
  54       isl_usage |= ISL_SURF_USAGE_RENDER_TARGET_BIT;
  55
  56    if (vk_usage & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)
  57       isl_usage |= ISL_SURF_USAGE_CUBE_BIT;
  58
  59    if (vk_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) {
  60       switch (aspect) {
  61       default:
  62          unreachable("bad VkImageAspect");
  63       case VK_IMAGE_ASPECT_DEPTH_BIT:
  64          isl_usage &= ~ISL_SURF_USAGE_DISABLE_AUX_BIT;
  65          isl_usage |= ISL_SURF_USAGE_DEPTH_BIT;
  66          break;
  67       case VK_IMAGE_ASPECT_STENCIL_BIT:
  68          isl_usage |= ISL_SURF_USAGE_STENCIL_BIT;
  69          break;
  70       }
  71    }
  72
  73    if (vk_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) {
  74       /* Meta implements transfers by sampling from the source image. */
  75       isl_usage |= ISL_SURF_USAGE_TEXTURE_BIT;
  76    }
  77
  78    if (vk_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) {
  79       /* Meta implements transfers by rendering into the destination image. */
  80       isl_usage |= ISL_SURF_USAGE_RENDER_TARGET_BIT;
  81    }
  82
  83    return isl_usage;
  84 }
  85
  86 /**
  87  * Exactly one bit must be set in \a aspect.
  88  */
  89 static struct anv_surface *
  90 get_surface(struct anv_image *image, VkImageAspectFlags aspect)
  91 {
  92    switch (aspect) {
  93    default:
  94       unreachable("bad VkImageAspect");
  95    case VK_IMAGE_ASPECT_COLOR_BIT:
  96       return &image->color_surface;
  97    case VK_IMAGE_ASPECT_DEPTH_BIT:
  98       return &image->depth_surface;
  99    case VK_IMAGE_ASPECT_STENCIL_BIT:
 100       return &image->stencil_surface;
 101    }
 102 }
 103
 104 static void
 105 add_surface(struct anv_image *image, struct anv_surface *surf)
 106 {
 107    assert(surf->isl.size > 0); /* isl surface must be initialized */
 108
 109    surf->offset = align_u32(image->size, surf->isl.alignment);
 110    image->size = surf->offset + surf->isl.size;
 111    image->alignment = MAX(image->alignment, surf->isl.alignment);
 112 }
 113
 114 /**
 115  * Initialize the anv_image::*_surface selected by \a aspect. Then update the
 116  * image's memory requirements (that is, the image's size and alignment).
 117  *
 118  * Exactly one bit must be set in \a aspect.
 119  */
 120 static VkResult
 121 make_surface(const struct anv_device *dev,
 122              struct anv_image *image,
 123              const struct anv_image_create_info *anv_info,
 124              VkImageAspectFlags aspect)
 125 {
 126    const VkImageCreateInfo *vk_info = anv_info->vk_info;
 127    bool ok UNUSED;
 128
 129    static const enum isl_surf_dim vk_to_isl_surf_dim[] = {
 130       [VK_IMAGE_TYPE_1D] = ISL_SURF_DIM_1D,
 131       [VK_IMAGE_TYPE_2D] = ISL_SURF_DIM_2D,
 132       [VK_IMAGE_TYPE_3D] = ISL_SURF_DIM_3D,
 133    };
 134
 135    /* Translate the Vulkan tiling to an equivalent ISL tiling, then filter the
 136     * result with an optionally provided ISL tiling argument.
 137     */
 138    isl_tiling_flags_t tiling_flags =
 139       (vk_info->tiling == VK_IMAGE_TILING_LINEAR) ?
 140       ISL_TILING_LINEAR_BIT : ISL_TILING_ANY_MASK;
 141
 142    if (anv_info->isl_tiling_flags)
 143       tiling_flags &= anv_info->isl_tiling_flags;
 144
 145    assert(tiling_flags);
 146
 147    struct anv_surface *anv_surf = get_surface(image, aspect);
 148
 149    image->extent = anv_sanitize_image_extent(vk_info->imageType,
 150                                              vk_info->extent);
 151
 152    enum isl_format format = anv_get_isl_format(&dev->info, vk_info->format,
 153                                                aspect, vk_info->tiling);
 154    assert(format != ISL_FORMAT_UNSUPPORTED);
 155
 156    ok = isl_surf_init(&dev->isl_dev, &anv_surf->isl,
 157       .dim = vk_to_isl_surf_dim[vk_info->imageType],
 158       .format = format,
 159       .width = image->extent.width,
 160       .height = image->extent.height,
 161       .depth = image->extent.depth,
 162       .levels = vk_info->mipLevels,
 163       .array_len = vk_info->arrayLayers,
 164       .samples = vk_info->samples,
 165       .min_alignment = 0,
 166       .min_pitch = anv_info->stride,
 167       .usage = choose_isl_surf_usage(image->usage, aspect),
 168       .tiling_flags = tiling_flags);
 169
 170    /* isl_surf_init() will fail only if provided invalid input. Invalid input
 171     * is illegal in Vulkan.
 172     */
 173    assert(ok);
 174
 175    add_surface(image, anv_surf);
 176
 177    /* Add a HiZ surface to a depth buffer that will be used for rendering.
 178     */
 179    if (aspect == VK_IMAGE_ASPECT_DEPTH_BIT &&
 180        (image->usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
 181
 182       /* Allow the user to control HiZ enabling. Disable by default on gen7
 183        * because resolves are not currently implemented pre-BDW.
 184        */
 185       if (!env_var_as_boolean("INTEL_VK_HIZ", dev->info.gen >= 8)) {
 186          anv_finishme("Implement gen7 HiZ");
 187       } else if (vk_info->mipLevels > 1) {
 188          anv_finishme("Test multi-LOD HiZ");
 189       } else if (dev->info.gen == 8 && vk_info->samples > 1) {
 190          anv_finishme("Test gen8 multisampled HiZ");
 191       } else {
 192          isl_surf_get_hiz_surf(&dev->isl_dev, &image->depth_surface.isl,
 193                                &image->hiz_surface.isl);
 194          add_surface(image, &image->hiz_surface);
 195       }
 196    }
 197
 198    return VK_SUCCESS;
 199 }
 200
 201 /**
 202  * Parameter @a format is required and overrides VkImageCreateInfo::format.
 203  */
 204 static VkImageUsageFlags
 205 anv_image_get_full_usage(const VkImageCreateInfo *info,
 206                          VkImageAspectFlags aspects)
 207 {
 208    VkImageUsageFlags usage = info->usage;
 209
 210    if (info->samples > 1 &&
 211        (usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
 212       /* Meta will resolve the image by binding it as a texture. */
 213       usage |= VK_IMAGE_USAGE_SAMPLED_BIT;
 214    }
 215
 216    if (usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) {
 217       /* Meta will transfer from the image by binding it as a texture. */
 218       usage |= VK_IMAGE_USAGE_SAMPLED_BIT;
 219    }
 220
 221    if (usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) {
 222       /* For non-clear transfer operations, meta will transfer to the image by
 223        * binding it as a color attachment, even if the image format is not
 224        * a color format.
 225        */
 226       usage |= VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT;
 227
 228       if (aspects & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
 229          /* vkCmdClearDepthStencilImage() only requires that
 230           * VK_IMAGE_USAGE_TRANSFER_SRC_BIT be set. In particular, it does
 231           * not require VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT. Meta
 232           * clears the image, though, by binding it as a depthstencil
 233           * attachment.
 234           */
 235          usage |= VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT;
 236       }
 237    }
 238
 239    return usage;
 240 }
 241
 242 VkResult
 243 anv_image_create(VkDevice _device,
 244                  const struct anv_image_create_info *create_info,
 245                  const VkAllocationCallbacks* alloc,
 246                  VkImage *pImage)
 247 {
 248    ANV_FROM_HANDLE(anv_device, device, _device);
 249    const VkImageCreateInfo *pCreateInfo = create_info->vk_info;
 250    struct anv_image *image = NULL;
 251    VkResult r;
 252
 253    assert(pCreateInfo->sType == VK_STRUCTURE_TYPE_IMAGE_CREATE_INFO);
 254
 255    anv_assert(pCreateInfo->mipLevels > 0);
 256    anv_assert(pCreateInfo->arrayLayers > 0);
 257    anv_assert(pCreateInfo->samples > 0);
 258    anv_assert(pCreateInfo->extent.width > 0);
 259    anv_assert(pCreateInfo->extent.height > 0);
 260    anv_assert(pCreateInfo->extent.depth > 0);
 261
 262    image = anv_alloc2(&device->alloc, alloc, sizeof(*image), 8,
 263                       VK_SYSTEM_ALLOCATION_SCOPE_OBJECT);
 264    if (!image)
 265       return vk_error(VK_ERROR_OUT_OF_HOST_MEMORY);
 266
 267    memset(image, 0, sizeof(*image));
 268    image->type = pCreateInfo->imageType;
 269    image->extent = pCreateInfo->extent;
 270    image->vk_format = pCreateInfo->format;
 271    image->aspects = vk_format_aspects(image->vk_format);
 272    image->levels = pCreateInfo->mipLevels;
 273    image->array_size = pCreateInfo->arrayLayers;
 274    image->samples = pCreateInfo->samples;
 275    image->usage = anv_image_get_full_usage(pCreateInfo, image->aspects);
 276    image->tiling = pCreateInfo->tiling;
 277
 278    uint32_t b;
 279    for_each_bit(b, image->aspects) {
 280       r = make_surface(device, image, create_info, (1 << b));
 281       if (r != VK_SUCCESS)
 282          goto fail;
 283    }
 284
 285    *pImage = anv_image_to_handle(image);
 286
 287    return VK_SUCCESS;
 288
 289 fail:
 290    if (image)
 291       anv_free2(&device->alloc, alloc, image);
 292
 293    return r;
 294 }
 295
 296 VkResult
 297 anv_CreateImage(VkDevice device,
 298                 const VkImageCreateInfo *pCreateInfo,
 299                 const VkAllocationCallbacks *pAllocator,
 300                 VkImage *pImage)
 301 {
 302    return anv_image_create(device,
 303       &(struct anv_image_create_info) {
 304          .vk_info = pCreateInfo,
 305       },
 306       pAllocator,
 307       pImage);
 308 }
 309
 310 void
 311 anv_DestroyImage(VkDevice _device, VkImage _image,
 312                  const VkAllocationCallbacks *pAllocator)
 313 {
 314    ANV_FROM_HANDLE(anv_device, device, _device);
 315
 316    anv_free2(&device->alloc, pAllocator, anv_image_from_handle(_image));
 317 }
 318
 319 VkResult anv_BindImageMemory(
 320     VkDevice                                    _device,
 321     VkImage                                     _image,
 322     VkDeviceMemory                              _memory,
 323     VkDeviceSize                                memoryOffset)
 324 {
 325    ANV_FROM_HANDLE(anv_device, device, _device);
 326    ANV_FROM_HANDLE(anv_device_memory, mem, _memory);
 327    ANV_FROM_HANDLE(anv_image, image, _image);
 328
 329    if (mem) {
 330       image->bo = &mem->bo;
 331       image->offset = memoryOffset;
 332    } else {
 333       image->bo = NULL;
 334       image->offset = 0;
 335    }
 336
 337    if (anv_image_has_hiz(image)) {
 338
 339       /* The offset and size must be a multiple of 4K or else the
 340        * anv_gem_mmap call below will return NULL.
 341        */
 342       assert((image->offset + image->hiz_surface.offset) % 4096 == 0);
 343       assert(image->hiz_surface.isl.size % 4096 == 0);
 344
 345       /* HiZ surfaces need to have their memory cleared to 0 before they
 346        * can be used.  If we let it have garbage data, it can cause GPU
 347        * hangs on some hardware.
 348        */
 349       void *map = anv_gem_mmap(device, image->bo->gem_handle,
 350                                image->offset + image->hiz_surface.offset,
 351                                image->hiz_surface.isl.size,
 352                                device->info.has_llc ? 0 : I915_MMAP_WC);
 353
 354       /* If anv_gem_mmap returns NULL, it's likely that the kernel was
 355        * not able to find space on the host to create a proper mapping.
 356        */
 357       if (map == NULL)
 358          return vk_error(VK_ERROR_OUT_OF_HOST_MEMORY);
 359
 360       memset(map, 0, image->hiz_surface.isl.size);
 361
 362       anv_gem_munmap(map, image->hiz_surface.isl.size);
 363    }
 364
 365    return VK_SUCCESS;
 366 }
 367
 368 static void
 369 anv_surface_get_subresource_layout(struct anv_image *image,
 370                                    struct anv_surface *surface,
 371                                    const VkImageSubresource *subresource,
 372                                    VkSubresourceLayout *layout)
 373 {
 374    /* If we are on a non-zero mip level or array slice, we need to
 375     * calculate a real offset.
 376     */
 377    anv_assert(subresource->mipLevel == 0);
 378    anv_assert(subresource->arrayLayer == 0);
 379
 380    layout->offset = surface->offset;
 381    layout->rowPitch = surface->isl.row_pitch;
 382    layout->depthPitch = isl_surf_get_array_pitch(&surface->isl);
 383    layout->arrayPitch = isl_surf_get_array_pitch(&surface->isl);
 384    layout->size = surface->isl.size;
 385 }
 386
 387 void anv_GetImageSubresourceLayout(
 388     VkDevice                                    device,
 389     VkImage                                     _image,
 390     const VkImageSubresource*                   pSubresource,
 391     VkSubresourceLayout*                        pLayout)
 392 {
 393    ANV_FROM_HANDLE(anv_image, image, _image);
 394
 395    assert(__builtin_popcount(pSubresource->aspectMask) == 1);
 396
 397    switch (pSubresource->aspectMask) {
 398    case VK_IMAGE_ASPECT_COLOR_BIT:
 399       anv_surface_get_subresource_layout(image, &image->color_surface,
 400                                          pSubresource, pLayout);
 401       break;
 402    case VK_IMAGE_ASPECT_DEPTH_BIT:
 403       anv_surface_get_subresource_layout(image, &image->depth_surface,
 404                                          pSubresource, pLayout);
 405       break;
 406    case VK_IMAGE_ASPECT_STENCIL_BIT:
 407       anv_surface_get_subresource_layout(image, &image->stencil_surface,
 408                                          pSubresource, pLayout);
 409       break;
 410    default:
 411       assert(!"Invalid image aspect");
 412    }
 413 }
 414
 415 static struct anv_state
 416 alloc_surface_state(struct anv_device *device,
 417                     struct anv_cmd_buffer *cmd_buffer)
 418 {
 419       if (cmd_buffer) {
 420          return anv_cmd_buffer_alloc_surface_state(cmd_buffer);
 421       } else {
 422          return anv_state_pool_alloc(&device->surface_state_pool, 64, 64);
 423       }
 424 }
 425
 426 static enum isl_channel_select
 427 remap_swizzle(VkComponentSwizzle swizzle, VkComponentSwizzle component,
 428               struct isl_swizzle format_swizzle)
 429 {
 430    if (swizzle == VK_COMPONENT_SWIZZLE_IDENTITY)
 431       swizzle = component;
 432
 433    switch (swizzle) {
 434    case VK_COMPONENT_SWIZZLE_ZERO:  return ISL_CHANNEL_SELECT_ZERO;
 435    case VK_COMPONENT_SWIZZLE_ONE:   return ISL_CHANNEL_SELECT_ONE;
 436    case VK_COMPONENT_SWIZZLE_R:     return format_swizzle.r;
 437    case VK_COMPONENT_SWIZZLE_G:     return format_swizzle.g;
 438    case VK_COMPONENT_SWIZZLE_B:     return format_swizzle.b;
 439    case VK_COMPONENT_SWIZZLE_A:     return format_swizzle.a;
 440    default:
 441       unreachable("Invalid swizzle");
 442    }
 443 }
 444
 445 void
 446 anv_image_view_init(struct anv_image_view *iview,
 447                     struct anv_device *device,
 448                     const VkImageViewCreateInfo* pCreateInfo,
 449                     struct anv_cmd_buffer *cmd_buffer,
 450                     VkImageUsageFlags usage_mask)
 451 {
 452    ANV_FROM_HANDLE(anv_image, image, pCreateInfo->image);
 453    const VkImageSubresourceRange *range = &pCreateInfo->subresourceRange;
 454
 455    assert(range->layerCount > 0);
 456    assert(range->baseMipLevel < image->levels);
 457    assert(image->usage & (VK_IMAGE_USAGE_SAMPLED_BIT |
 458                           VK_IMAGE_USAGE_STORAGE_BIT |
 459                           VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
 460                           VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT));
 461
 462    switch (image->type) {
 463    default:
 464       unreachable("bad VkImageType");
 465    case VK_IMAGE_TYPE_1D:
 466    case VK_IMAGE_TYPE_2D:
 467       assert(range->baseArrayLayer + anv_get_layerCount(image, range) - 1 <= image->array_size);
 468       break;
 469    case VK_IMAGE_TYPE_3D:
 470       assert(range->baseArrayLayer + anv_get_layerCount(image, range) - 1
 471              <= anv_minify(image->extent.depth, range->baseMipLevel));
 472       break;
 473    }
 474
 475    const struct anv_surface *surface =
 476       anv_image_get_surface_for_aspect_mask(image, range->aspectMask);
 477
 478    iview->image = image;
 479    iview->bo = image->bo;
 480    iview->offset = image->offset + surface->offset;
 481
 482    iview->aspect_mask = pCreateInfo->subresourceRange.aspectMask;
 483    iview->vk_format = pCreateInfo->format;
 484
 485    struct anv_format format = anv_get_format(&device->info, pCreateInfo->format,
 486                                              range->aspectMask, image->tiling);
 487
 488    iview->base_layer = range->baseArrayLayer;
 489    iview->base_mip = range->baseMipLevel;
 490
 491    struct isl_view isl_view = {
 492       .format = format.isl_format,
 493       .base_level = range->baseMipLevel,
 494       .levels = anv_get_levelCount(image, range),
 495       .base_array_layer = range->baseArrayLayer,
 496       .array_len = anv_get_layerCount(image, range),
 497       .swizzle = {
 498          .r = remap_swizzle(pCreateInfo->components.r,
 499                             VK_COMPONENT_SWIZZLE_R, format.swizzle),
 500          .g = remap_swizzle(pCreateInfo->components.g,
 501                             VK_COMPONENT_SWIZZLE_G, format.swizzle),
 502          .b = remap_swizzle(pCreateInfo->components.b,
 503                             VK_COMPONENT_SWIZZLE_B, format.swizzle),
 504          .a = remap_swizzle(pCreateInfo->components.a,
 505                             VK_COMPONENT_SWIZZLE_A, format.swizzle),
 506       },
 507    };
 508
 509    iview->extent = (VkExtent3D) {
 510       .width  = anv_minify(image->extent.width , range->baseMipLevel),
 511       .height = anv_minify(image->extent.height, range->baseMipLevel),
 512       .depth  = anv_minify(image->extent.depth , range->baseMipLevel),
 513    };
 514
 515    if (image->type == VK_IMAGE_TYPE_3D &&
 516        usage_mask != VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) {
 517       /* Meta renders to 3D texture slices.  When it does so, it passes
 518        * usage_mask == VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.  Since meta is the
 519        * only thing that uses a non-zero usage_mask, this lets us easily
 520        * detect the one case where we actually want an array range used for
 521        * 3-D textures.
 522        */
 523       isl_view.base_array_layer = 0;
 524       isl_view.array_len = iview->extent.depth;
 525    }
 526
 527    isl_surf_usage_flags_t cube_usage;
 528    if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE ||
 529        pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
 530       cube_usage = ISL_SURF_USAGE_CUBE_BIT;
 531    } else {
 532       cube_usage = 0;
 533    }
 534
 535    if (image->usage & usage_mask & VK_IMAGE_USAGE_SAMPLED_BIT) {
 536       iview->sampler_surface_state = alloc_surface_state(device, cmd_buffer);
 537
 538       isl_view.usage = cube_usage | ISL_SURF_USAGE_TEXTURE_BIT;
 539       isl_surf_fill_state(&device->isl_dev,
 540                           iview->sampler_surface_state.map,
 541                           .surf = &surface->isl,
 542                           .view = &isl_view,
 543                           .mocs = device->default_mocs);
 544
 545       if (!device->info.has_llc)
 546          anv_state_clflush(iview->sampler_surface_state);
 547    } else {
 548       iview->sampler_surface_state.alloc_size = 0;
 549    }
 550
 551    /* This is kind-of hackish.  It is possible, due to get_full_usage above,
 552     * to get a surface state with a non-renderable format but with
 553     * VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.  This happens in particular for
 554     * formats which aren't renderable but where we want to use Vulkan copy
 555     * commands so VK_IMAGE_USAGE_TRANSFER_DST_BIT is set.  In the case of a
 556     * copy, meta will use a format that we can render to, but most of the rest
 557     * of the time, we don't want to create those surface states.  Once we
 558     * start using blorp for copies, this problem will go away and we can
 559     * remove a lot of hacks.
 560     */
 561    if ((image->usage & usage_mask & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
 562        isl_format_supports_rendering(&device->info, isl_view.format)) {
 563       iview->color_rt_surface_state = alloc_surface_state(device, cmd_buffer);
 564
 565       isl_view.usage = cube_usage | ISL_SURF_USAGE_RENDER_TARGET_BIT;
 566       isl_surf_fill_state(&device->isl_dev,
 567                           iview->color_rt_surface_state.map,
 568                           .surf = &surface->isl,
 569                           .view = &isl_view,
 570                           .mocs = device->default_mocs);
 571
 572       if (!device->info.has_llc)
 573          anv_state_clflush(iview->color_rt_surface_state);
 574    } else {
 575       iview->color_rt_surface_state.alloc_size = 0;
 576    }
 577
 578    /* NOTE: This one needs to go last since it may stomp isl_view.format */
 579    if (image->usage & usage_mask & VK_IMAGE_USAGE_STORAGE_BIT) {
 580       iview->storage_surface_state = alloc_surface_state(device, cmd_buffer);
 581
 582       if (isl_has_matching_typed_storage_image_format(&device->info,
 583                                                       format.isl_format)) {
 584          isl_view.usage = cube_usage | ISL_SURF_USAGE_STORAGE_BIT;
 585          isl_view.format = isl_lower_storage_image_format(&device->info,
 586                                                           isl_view.format);
 587          isl_surf_fill_state(&device->isl_dev,
 588                              iview->storage_surface_state.map,
 589                              .surf = &surface->isl,
 590                              .view = &isl_view,
 591                              .mocs = device->default_mocs);
 592       } else {
 593          anv_fill_buffer_surface_state(device, iview->storage_surface_state,
 594                                        ISL_FORMAT_RAW,
 595                                        iview->offset,
 596                                        iview->bo->size - iview->offset, 1);
 597       }
 598
 599       isl_surf_fill_image_param(&device->isl_dev,
 600                                 &iview->storage_image_param,
 601                                 &surface->isl, &isl_view);
 602
 603       if (!device->info.has_llc)
 604          anv_state_clflush(iview->storage_surface_state);
 605    } else {
 606       iview->storage_surface_state.alloc_size = 0;
 607    }
 608 }
 609
 610 VkResult
 611 anv_CreateImageView(VkDevice _device,
 612                     const VkImageViewCreateInfo *pCreateInfo,
 613                     const VkAllocationCallbacks *pAllocator,
 614                     VkImageView *pView)
 615 {
 616    ANV_FROM_HANDLE(anv_device, device, _device);
 617    struct anv_image_view *view;
 618
 619    view = anv_alloc2(&device->alloc, pAllocator, sizeof(*view), 8,
 620                      VK_SYSTEM_ALLOCATION_SCOPE_OBJECT);
 621    if (view == NULL)
 622       return vk_error(VK_ERROR_OUT_OF_HOST_MEMORY);
 623
 624    anv_image_view_init(view, device, pCreateInfo, NULL, ~0);
 625
 626    *pView = anv_image_view_to_handle(view);
 627
 628    return VK_SUCCESS;
 629 }
 630
 631 void
 632 anv_DestroyImageView(VkDevice _device, VkImageView _iview,
 633                      const VkAllocationCallbacks *pAllocator)
 634 {
 635    ANV_FROM_HANDLE(anv_device, device, _device);
 636    ANV_FROM_HANDLE(anv_image_view, iview, _iview);
 637
 638    if (iview->color_rt_surface_state.alloc_size > 0) {
 639       anv_state_pool_free(&device->surface_state_pool,
 640                           iview->color_rt_surface_state);
 641    }
 642
 643    if (iview->sampler_surface_state.alloc_size > 0) {
 644       anv_state_pool_free(&device->surface_state_pool,
 645                           iview->sampler_surface_state);
 646    }
 647
 648    if (iview->storage_surface_state.alloc_size > 0) {
 649       anv_state_pool_free(&device->surface_state_pool,
 650                           iview->storage_surface_state);
 651    }
 652
 653    anv_free2(&device->alloc, pAllocator, iview);
 654 }
 655
 656
 657 void anv_buffer_view_init(struct anv_buffer_view *view,
 658                           struct anv_device *device,
 659                           const VkBufferViewCreateInfo* pCreateInfo,
 660                           struct anv_cmd_buffer *cmd_buffer)
 661 {
 662    ANV_FROM_HANDLE(anv_buffer, buffer, pCreateInfo->buffer);
 663
 664    /* TODO: Handle the format swizzle? */
 665
 666    view->format = anv_get_isl_format(&device->info, pCreateInfo->format,
 667                                      VK_IMAGE_ASPECT_COLOR_BIT,
 668                                      VK_IMAGE_TILING_LINEAR);
 669    const uint32_t format_bs = isl_format_get_layout(view->format)->bpb / 8;
 670    view->bo = buffer->bo;
 671    view->offset = buffer->offset + pCreateInfo->offset;
 672    view->range = pCreateInfo->range == VK_WHOLE_SIZE ?
 673                  buffer->size - pCreateInfo->offset : pCreateInfo->range;
 674    view->range = align_down_npot_u32(view->range, format_bs);
 675
 676    if (buffer->usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
 677       view->surface_state = alloc_surface_state(device, cmd_buffer);
 678
 679       anv_fill_buffer_surface_state(device, view->surface_state,
 680                                     view->format,
 681                                     view->offset, view->range, format_bs);
 682    } else {
 683       view->surface_state = (struct anv_state){ 0 };
 684    }
 685
 686    if (buffer->usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
 687       view->storage_surface_state = alloc_surface_state(device, cmd_buffer);
 688
 689       enum isl_format storage_format =
 690          isl_has_matching_typed_storage_image_format(&device->info,
 691                                                      view->format) ?
 692          isl_lower_storage_image_format(&device->info, view->format) :
 693          ISL_FORMAT_RAW;
 694
 695       anv_fill_buffer_surface_state(device, view->storage_surface_state,
 696                                     storage_format,
 697                                     view->offset, view->range,
 698                                     (storage_format == ISL_FORMAT_RAW ? 1 :
 699                                      isl_format_get_layout(storage_format)->bpb / 8));
 700
 701       isl_buffer_fill_image_param(&device->isl_dev,
 702                                   &view->storage_image_param,
 703                                   view->format, view->range);
 704    } else {
 705       view->storage_surface_state = (struct anv_state){ 0 };
 706    }
 707 }
 708
 709 VkResult
 710 anv_CreateBufferView(VkDevice _device,
 711                      const VkBufferViewCreateInfo *pCreateInfo,
 712                      const VkAllocationCallbacks *pAllocator,
 713                      VkBufferView *pView)
 714 {
 715    ANV_FROM_HANDLE(anv_device, device, _device);
 716    struct anv_buffer_view *view;
 717
 718    view = anv_alloc2(&device->alloc, pAllocator, sizeof(*view), 8,
 719                      VK_SYSTEM_ALLOCATION_SCOPE_OBJECT);
 720    if (!view)
 721       return vk_error(VK_ERROR_OUT_OF_HOST_MEMORY);
 722
 723    anv_buffer_view_init(view, device, pCreateInfo, NULL);
 724
 725    *pView = anv_buffer_view_to_handle(view);
 726
 727    return VK_SUCCESS;
 728 }
 729
 730 void
 731 anv_DestroyBufferView(VkDevice _device, VkBufferView bufferView,
 732                       const VkAllocationCallbacks *pAllocator)
 733 {
 734    ANV_FROM_HANDLE(anv_device, device, _device);
 735    ANV_FROM_HANDLE(anv_buffer_view, view, bufferView);
 736
 737    if (view->surface_state.alloc_size > 0)
 738       anv_state_pool_free(&device->surface_state_pool,
 739                           view->surface_state);
 740
 741    if (view->storage_surface_state.alloc_size > 0)
 742       anv_state_pool_free(&device->surface_state_pool,
 743                           view->storage_surface_state);
 744
 745    anv_free2(&device->alloc, pAllocator, view);
 746 }
 747
 748 const struct anv_surface *
 749 anv_image_get_surface_for_aspect_mask(const struct anv_image *image,
 750                                       VkImageAspectFlags aspect_mask)
 751 {
 752    switch (aspect_mask) {
 753    case VK_IMAGE_ASPECT_COLOR_BIT:
 754       /* Dragons will eat you.
 755        *
 756        * Meta attaches all destination surfaces as color render targets. Guess
 757        * what surface the Meta Dragons really want.
 758        */
 759       if (image->aspects & VK_IMAGE_ASPECT_DEPTH_BIT) {
 760          return &image->depth_surface;
 761       } else if (image->aspects & VK_IMAGE_ASPECT_STENCIL_BIT) {
 762          return &image->stencil_surface;
 763       } else {
 764          assert(image->aspects == VK_IMAGE_ASPECT_COLOR_BIT);
 765          return &image->color_surface;
 766       }
 767       break;
 768    case VK_IMAGE_ASPECT_DEPTH_BIT:
 769       assert(image->aspects & VK_IMAGE_ASPECT_DEPTH_BIT);
 770       return &image->depth_surface;
 771    case VK_IMAGE_ASPECT_STENCIL_BIT:
 772       assert(image->aspects & VK_IMAGE_ASPECT_STENCIL_BIT);
 773       return &image->stencil_surface;
 774    case VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT:
 775       /* FINISHME: The Vulkan spec (git a511ba2) requires support for
 776        * combined depth stencil formats. Specifically, it states:
 777        *
 778        *    At least one of ename:VK_FORMAT_D24_UNORM_S8_UINT or
 779        *    ename:VK_FORMAT_D32_SFLOAT_S8_UINT must be supported.
 780        *
 781        * Image views with both depth and stencil aspects are only valid for
 782        * render target attachments, in which case
 783        * cmd_buffer_emit_depth_stencil() will pick out both the depth and
 784        * stencil surfaces from the underlying surface.
 785        */
 786       if (image->aspects & VK_IMAGE_ASPECT_DEPTH_BIT) {
 787          return &image->depth_surface;
 788       } else {
 789          assert(image->aspects == VK_IMAGE_ASPECT_STENCIL_BIT);
 790          return &image->stencil_surface;
 791       }
 792     default:
 793        unreachable("image does not have aspect");
 794        return NULL;
 795    }
 796 }