2 * Copyright © 2015 Intel Corporation
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:
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
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
30 #include <drm_fourcc.h>
32 #include "anv_private.h"
33 #include "util/debug.h"
36 #include "vk_format_info.h"
38 static isl_surf_usage_flags_t
39 choose_isl_surf_usage(VkImageCreateFlags vk_create_flags
,
40 VkImageUsageFlags vk_usage
,
41 isl_surf_usage_flags_t isl_extra_usage
,
42 VkImageAspectFlagBits aspect
)
44 isl_surf_usage_flags_t isl_usage
= isl_extra_usage
;
46 if (vk_usage
& VK_IMAGE_USAGE_SAMPLED_BIT
)
47 isl_usage
|= ISL_SURF_USAGE_TEXTURE_BIT
;
49 if (vk_usage
& VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT
)
50 isl_usage
|= ISL_SURF_USAGE_TEXTURE_BIT
;
52 if (vk_usage
& VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT
)
53 isl_usage
|= ISL_SURF_USAGE_RENDER_TARGET_BIT
;
55 if (vk_create_flags
& VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT
)
56 isl_usage
|= ISL_SURF_USAGE_CUBE_BIT
;
58 /* Even if we're only using it for transfer operations, clears to depth and
59 * stencil images happen as depth and stencil so they need the right ISL
60 * usage bits or else things will fall apart.
63 case VK_IMAGE_ASPECT_DEPTH_BIT
:
64 isl_usage
|= ISL_SURF_USAGE_DEPTH_BIT
;
66 case VK_IMAGE_ASPECT_STENCIL_BIT
:
67 isl_usage
|= ISL_SURF_USAGE_STENCIL_BIT
;
69 case VK_IMAGE_ASPECT_COLOR_BIT
:
70 case VK_IMAGE_ASPECT_PLANE_0_BIT
:
71 case VK_IMAGE_ASPECT_PLANE_1_BIT
:
72 case VK_IMAGE_ASPECT_PLANE_2_BIT
:
75 unreachable("bad VkImageAspect");
78 if (vk_usage
& VK_IMAGE_USAGE_TRANSFER_SRC_BIT
) {
79 /* blorp implements transfers by sampling from the source image. */
80 isl_usage
|= ISL_SURF_USAGE_TEXTURE_BIT
;
83 if (vk_usage
& VK_IMAGE_USAGE_TRANSFER_DST_BIT
&&
84 aspect
== VK_IMAGE_ASPECT_COLOR_BIT
) {
85 /* blorp implements transfers by rendering into the destination image.
86 * Only request this with color images, as we deal with depth/stencil
87 * formats differently. */
88 isl_usage
|= ISL_SURF_USAGE_RENDER_TARGET_BIT
;
94 static isl_tiling_flags_t
95 choose_isl_tiling_flags(const struct anv_image_create_info
*anv_info
,
96 const struct isl_drm_modifier_info
*isl_mod_info
,
99 const VkImageCreateInfo
*base_info
= anv_info
->vk_info
;
100 isl_tiling_flags_t flags
= 0;
102 switch (base_info
->tiling
) {
104 unreachable("bad VkImageTiling");
105 case VK_IMAGE_TILING_OPTIMAL
:
106 flags
= ISL_TILING_ANY_MASK
;
108 case VK_IMAGE_TILING_LINEAR
:
109 flags
= ISL_TILING_LINEAR_BIT
;
113 if (anv_info
->isl_tiling_flags
)
114 flags
&= anv_info
->isl_tiling_flags
;
117 flags
&= ISL_TILING_LINEAR_BIT
| ISL_TILING_X_BIT
;
120 flags
&= 1 << isl_mod_info
->tiling
;
127 static struct anv_surface
*
128 get_surface(struct anv_image
*image
, VkImageAspectFlagBits aspect
)
130 uint32_t plane
= anv_image_aspect_to_plane(image
->aspects
, aspect
);
131 return &image
->planes
[plane
].surface
;
135 add_surface(struct anv_image
*image
, struct anv_surface
*surf
, uint32_t plane
)
137 assert(surf
->isl
.size
> 0); /* isl surface must be initialized */
139 if (image
->disjoint
) {
140 surf
->offset
= align_u32(image
->planes
[plane
].size
, surf
->isl
.alignment
);
141 /* Plane offset is always 0 when it's disjoint. */
143 surf
->offset
= align_u32(image
->size
, surf
->isl
.alignment
);
144 /* Determine plane's offset only once when the first surface is added. */
145 if (image
->planes
[plane
].size
== 0)
146 image
->planes
[plane
].offset
= image
->size
;
149 image
->size
= surf
->offset
+ surf
->isl
.size
;
150 image
->planes
[plane
].size
= (surf
->offset
+ surf
->isl
.size
) - image
->planes
[plane
].offset
;
152 image
->alignment
= MAX2(image
->alignment
, surf
->isl
.alignment
);
153 image
->planes
[plane
].alignment
= MAX2(image
->planes
[plane
].alignment
,
154 surf
->isl
.alignment
);
159 all_formats_ccs_e_compatible(const struct gen_device_info
*devinfo
,
160 const struct VkImageCreateInfo
*vk_info
)
162 enum isl_format format
=
163 anv_get_isl_format(devinfo
, vk_info
->format
,
164 VK_IMAGE_ASPECT_COLOR_BIT
, vk_info
->tiling
);
166 if (!isl_format_supports_ccs_e(devinfo
, format
))
169 if (!(vk_info
->flags
& VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT
))
172 const VkImageFormatListCreateInfoKHR
*fmt_list
=
173 vk_find_struct_const(vk_info
->pNext
, IMAGE_FORMAT_LIST_CREATE_INFO_KHR
);
175 if (!fmt_list
|| fmt_list
->viewFormatCount
== 0)
178 for (uint32_t i
= 0; i
< fmt_list
->viewFormatCount
; i
++) {
179 enum isl_format view_format
=
180 anv_get_isl_format(devinfo
, fmt_list
->pViewFormats
[i
],
181 VK_IMAGE_ASPECT_COLOR_BIT
, vk_info
->tiling
);
183 if (!isl_formats_are_ccs_e_compatible(devinfo
, format
, view_format
))
191 * For color images that have an auxiliary surface, request allocation for an
192 * additional buffer that mainly stores fast-clear values. Use of this buffer
193 * allows us to access the image's subresources while being aware of their
194 * fast-clear values in non-trivial cases (e.g., outside of a render pass in
195 * which a fast clear has occurred).
197 * In order to avoid having multiple clear colors for a single plane of an
198 * image (hence a single RENDER_SURFACE_STATE), we only allow fast-clears on
199 * the first slice (level 0, layer 0). At the time of our testing (Jan 17,
200 * 2018), there were no known applications which would benefit from fast-
201 * clearing more than just the first slice.
203 * The fast clear portion of the image is laid out in the following order:
205 * * 1 or 4 dwords (depending on hardware generation) for the clear color
206 * * 1 dword for the anv_fast_clear_type of the clear color
207 * * On gen9+, 1 dword per level and layer of the image (3D levels count
208 * multiple layers) in level-major order for compression state.
210 * For the purpose of discoverability, the algorithm used to manage
211 * compression and fast-clears is described here:
213 * * On a transition from UNDEFINED or PREINITIALIZED to a defined layout,
214 * all of the values in the fast clear portion of the image are initialized
217 * * On fast-clear, the clear value is written into surface state and also
218 * into the buffer and the fast clear type is set appropriately. Both
219 * setting the fast-clear value in the buffer and setting the fast-clear
220 * type happen from the GPU using MI commands.
222 * * Whenever a render or blorp operation is performed with CCS_E, we call
223 * genX(cmd_buffer_mark_image_written) to set the compression state to
224 * true (which is represented by UINT32_MAX).
226 * * On pipeline barrier transitions, the worst-case transition is computed
227 * from the image layouts. The command streamer inspects the fast clear
228 * type and compression state dwords and constructs a predicate. The
229 * worst-case resolve is performed with the given predicate and the fast
230 * clear and compression state is set accordingly.
232 * See anv_layout_to_aux_usage and anv_layout_to_fast_clear_type functions for
233 * details on exactly what is allowed in what layouts.
235 * On gen7-9, we do not have a concept of indirect clear colors in hardware.
236 * In order to deal with this, we have to do some clear color management.
238 * * For LOAD_OP_LOAD at the top of a renderpass, we have to copy the clear
239 * value from the buffer into the surface state with MI commands.
241 * * For any blorp operations, we pass the address to the clear value into
242 * blorp and it knows to copy the clear color.
245 add_aux_state_tracking_buffer(struct anv_image
*image
,
246 VkImageAspectFlagBits aspect
,
248 const struct anv_device
*device
)
250 assert(image
&& device
);
251 assert(image
->planes
[plane
].aux_surface
.isl
.size
> 0 &&
252 image
->aspects
& VK_IMAGE_ASPECT_ANY_COLOR_BIT_ANV
);
254 /* Compressed images must be tiled and therefore everything should be 4K
255 * aligned. The CCS has the same alignment requirements. This is good
256 * because we need at least dword-alignment for MI_LOAD/STORE operations.
258 assert(image
->alignment
% 4 == 0);
259 assert((image
->planes
[plane
].offset
+ image
->planes
[plane
].size
) % 4 == 0);
261 /* This buffer should be at the very end of the plane. */
262 if (image
->disjoint
) {
263 assert(image
->planes
[plane
].size
==
264 (image
->planes
[plane
].offset
+ image
->planes
[plane
].size
));
266 assert(image
->size
==
267 (image
->planes
[plane
].offset
+ image
->planes
[plane
].size
));
270 const unsigned clear_color_state_size
= device
->info
.gen
>= 10 ?
271 device
->isl_dev
.ss
.clear_color_state_size
:
272 device
->isl_dev
.ss
.clear_value_size
;
274 /* Clear color and fast clear type */
275 unsigned state_size
= clear_color_state_size
+ 4;
277 /* We only need to track compression on CCS_E surfaces. */
278 if (image
->planes
[plane
].aux_usage
== ISL_AUX_USAGE_CCS_E
) {
279 if (image
->type
== VK_IMAGE_TYPE_3D
) {
280 for (uint32_t l
= 0; l
< image
->levels
; l
++)
281 state_size
+= anv_minify(image
->extent
.depth
, l
) * 4;
283 state_size
+= image
->levels
* image
->array_size
* 4;
287 image
->planes
[plane
].fast_clear_state_offset
=
288 image
->planes
[plane
].offset
+ image
->planes
[plane
].size
;
290 image
->planes
[plane
].size
+= state_size
;
291 image
->size
+= state_size
;
295 * Initialize the anv_image::*_surface selected by \a aspect. Then update the
296 * image's memory requirements (that is, the image's size and alignment).
299 make_surface(const struct anv_device
*dev
,
300 struct anv_image
*image
,
301 const struct anv_image_create_info
*anv_info
,
302 isl_tiling_flags_t tiling_flags
,
303 VkImageAspectFlagBits aspect
)
305 const VkImageCreateInfo
*vk_info
= anv_info
->vk_info
;
308 static const enum isl_surf_dim vk_to_isl_surf_dim
[] = {
309 [VK_IMAGE_TYPE_1D
] = ISL_SURF_DIM_1D
,
310 [VK_IMAGE_TYPE_2D
] = ISL_SURF_DIM_2D
,
311 [VK_IMAGE_TYPE_3D
] = ISL_SURF_DIM_3D
,
314 image
->extent
= anv_sanitize_image_extent(vk_info
->imageType
,
317 const unsigned plane
= anv_image_aspect_to_plane(image
->aspects
, aspect
);
318 const struct anv_format_plane plane_format
=
319 anv_get_format_plane(&dev
->info
, image
->vk_format
, aspect
, image
->tiling
);
320 struct anv_surface
*anv_surf
= &image
->planes
[plane
].surface
;
322 const isl_surf_usage_flags_t usage
=
323 choose_isl_surf_usage(vk_info
->flags
, image
->usage
,
324 anv_info
->isl_extra_usage_flags
, aspect
);
326 /* If an image is created as BLOCK_TEXEL_VIEW_COMPATIBLE, then we need to
327 * fall back to linear on Broadwell and earlier because we aren't
328 * guaranteed that we can handle offsets correctly. On Sky Lake, the
329 * horizontal and vertical alignments are sufficiently high that we can
330 * just use RENDER_SURFACE_STATE::X/Y Offset.
332 bool needs_shadow
= false;
333 if (dev
->info
.gen
<= 8 &&
334 (vk_info
->flags
& VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT
) &&
335 vk_info
->tiling
== VK_IMAGE_TILING_OPTIMAL
) {
336 assert(isl_format_is_compressed(plane_format
.isl_format
));
337 tiling_flags
= ISL_TILING_LINEAR_BIT
;
341 ok
= isl_surf_init(&dev
->isl_dev
, &anv_surf
->isl
,
342 .dim
= vk_to_isl_surf_dim
[vk_info
->imageType
],
343 .format
= plane_format
.isl_format
,
344 .width
= image
->extent
.width
/ plane_format
.denominator_scales
[0],
345 .height
= image
->extent
.height
/ plane_format
.denominator_scales
[1],
346 .depth
= image
->extent
.depth
,
347 .levels
= vk_info
->mipLevels
,
348 .array_len
= vk_info
->arrayLayers
,
349 .samples
= vk_info
->samples
,
351 .row_pitch
= anv_info
->stride
,
353 .tiling_flags
= tiling_flags
);
356 return VK_ERROR_OUT_OF_DEVICE_MEMORY
;
358 image
->planes
[plane
].aux_usage
= ISL_AUX_USAGE_NONE
;
360 add_surface(image
, anv_surf
, plane
);
362 /* If an image is created as BLOCK_TEXEL_VIEW_COMPATIBLE, then we need to
363 * create an identical tiled shadow surface for use while texturing so we
364 * don't get garbage performance.
367 assert(aspect
== VK_IMAGE_ASPECT_COLOR_BIT
);
368 assert(tiling_flags
== ISL_TILING_LINEAR_BIT
);
370 ok
= isl_surf_init(&dev
->isl_dev
, &image
->planes
[plane
].shadow_surface
.isl
,
371 .dim
= vk_to_isl_surf_dim
[vk_info
->imageType
],
372 .format
= plane_format
.isl_format
,
373 .width
= image
->extent
.width
,
374 .height
= image
->extent
.height
,
375 .depth
= image
->extent
.depth
,
376 .levels
= vk_info
->mipLevels
,
377 .array_len
= vk_info
->arrayLayers
,
378 .samples
= vk_info
->samples
,
380 .row_pitch
= anv_info
->stride
,
382 .tiling_flags
= ISL_TILING_ANY_MASK
);
384 /* isl_surf_init() will fail only if provided invalid input. Invalid input
385 * is illegal in Vulkan.
389 add_surface(image
, &image
->planes
[plane
].shadow_surface
, plane
);
392 /* Add a HiZ surface to a depth buffer that will be used for rendering.
394 if (aspect
== VK_IMAGE_ASPECT_DEPTH_BIT
) {
395 /* We don't advertise that depth buffers could be used as storage
398 assert(!(image
->usage
& VK_IMAGE_USAGE_STORAGE_BIT
));
400 /* Allow the user to control HiZ enabling. Disable by default on gen7
401 * because resolves are not currently implemented pre-BDW.
403 if (!(image
->usage
& VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT
)) {
404 /* It will never be used as an attachment, HiZ is pointless. */
405 } else if (dev
->info
.gen
== 7) {
406 anv_perf_warn(dev
->instance
, image
, "Implement gen7 HiZ");
407 } else if (vk_info
->mipLevels
> 1) {
408 anv_perf_warn(dev
->instance
, image
, "Enable multi-LOD HiZ");
409 } else if (vk_info
->arrayLayers
> 1) {
410 anv_perf_warn(dev
->instance
, image
,
411 "Implement multi-arrayLayer HiZ clears and resolves");
412 } else if (dev
->info
.gen
== 8 && vk_info
->samples
> 1) {
413 anv_perf_warn(dev
->instance
, image
, "Enable gen8 multisampled HiZ");
414 } else if (!unlikely(INTEL_DEBUG
& DEBUG_NO_HIZ
)) {
415 assert(image
->planes
[plane
].aux_surface
.isl
.size
== 0);
416 ok
= isl_surf_get_hiz_surf(&dev
->isl_dev
,
417 &image
->planes
[plane
].surface
.isl
,
418 &image
->planes
[plane
].aux_surface
.isl
);
420 add_surface(image
, &image
->planes
[plane
].aux_surface
, plane
);
421 image
->planes
[plane
].aux_usage
= ISL_AUX_USAGE_HIZ
;
423 } else if ((aspect
& VK_IMAGE_ASPECT_ANY_COLOR_BIT_ANV
) && vk_info
->samples
== 1) {
424 /* TODO: Disallow compression with :
426 * 1) non multiplanar images (We appear to hit a sampler bug with
427 * CCS & R16G16 format. Putting the clear state a page/4096bytes
428 * further fixes the issue).
430 * 2) alias images, because they might be aliases of images
433 * 3) compression disabled by debug
435 const bool allow_compression
=
436 image
->n_planes
== 1 &&
437 (vk_info
->flags
& VK_IMAGE_CREATE_ALIAS_BIT
) == 0 &&
438 likely((INTEL_DEBUG
& DEBUG_NO_RBC
) == 0);
440 if (allow_compression
) {
441 assert(image
->planes
[plane
].aux_surface
.isl
.size
== 0);
442 ok
= isl_surf_get_ccs_surf(&dev
->isl_dev
,
443 &image
->planes
[plane
].surface
.isl
,
444 &image
->planes
[plane
].aux_surface
.isl
, 0);
447 /* Disable CCS when it is not useful (i.e., when you can't render
448 * to the image with CCS enabled).
450 if (!isl_format_supports_rendering(&dev
->info
,
451 plane_format
.isl_format
)) {
452 /* While it may be technically possible to enable CCS for this
453 * image, we currently don't have things hooked up to get it
456 anv_perf_warn(dev
->instance
, image
,
457 "This image format doesn't support rendering. "
458 "Not allocating an CCS buffer.");
459 image
->planes
[plane
].aux_surface
.isl
.size
= 0;
463 add_surface(image
, &image
->planes
[plane
].aux_surface
, plane
);
464 add_aux_state_tracking_buffer(image
, aspect
, plane
, dev
);
466 /* For images created without MUTABLE_FORMAT_BIT set, we know that
467 * they will always be used with the original format. In
468 * particular, they will always be used with a format that
469 * supports color compression. If it's never used as a storage
470 * image, then it will only be used through the sampler or the as
471 * a render target. This means that it's safe to just leave
472 * compression on at all times for these formats.
474 if (!(vk_info
->usage
& VK_IMAGE_USAGE_STORAGE_BIT
) &&
475 all_formats_ccs_e_compatible(&dev
->info
, vk_info
)) {
476 image
->planes
[plane
].aux_usage
= ISL_AUX_USAGE_CCS_E
;
480 } else if ((aspect
& VK_IMAGE_ASPECT_ANY_COLOR_BIT_ANV
) && vk_info
->samples
> 1) {
481 assert(!(vk_info
->usage
& VK_IMAGE_USAGE_STORAGE_BIT
));
482 assert(image
->planes
[plane
].aux_surface
.isl
.size
== 0);
483 ok
= isl_surf_get_mcs_surf(&dev
->isl_dev
,
484 &image
->planes
[plane
].surface
.isl
,
485 &image
->planes
[plane
].aux_surface
.isl
);
487 add_surface(image
, &image
->planes
[plane
].aux_surface
, plane
);
488 add_aux_state_tracking_buffer(image
, aspect
, plane
, dev
);
489 image
->planes
[plane
].aux_usage
= ISL_AUX_USAGE_MCS
;
493 assert((image
->planes
[plane
].offset
+ image
->planes
[plane
].size
) == image
->size
);
495 /* Upper bound of the last surface should be smaller than the plane's
498 assert((MAX2(image
->planes
[plane
].surface
.offset
,
499 image
->planes
[plane
].aux_surface
.offset
) +
500 (image
->planes
[plane
].aux_surface
.isl
.size
> 0 ?
501 image
->planes
[plane
].aux_surface
.isl
.size
:
502 image
->planes
[plane
].surface
.isl
.size
)) <=
503 (image
->planes
[plane
].offset
+ image
->planes
[plane
].size
));
505 if (image
->planes
[plane
].aux_surface
.isl
.size
) {
506 /* assert(image->planes[plane].fast_clear_state_offset == */
507 /* (image->planes[plane].aux_surface.offset + image->planes[plane].aux_surface.isl.size)); */
508 assert(image
->planes
[plane
].fast_clear_state_offset
<
509 (image
->planes
[plane
].offset
+ image
->planes
[plane
].size
));
516 score_drm_format_mod(uint64_t modifier
)
519 case DRM_FORMAT_MOD_LINEAR
: return 1;
520 case I915_FORMAT_MOD_X_TILED
: return 2;
521 case I915_FORMAT_MOD_Y_TILED
: return 3;
522 default: unreachable("bad DRM format modifier");
526 static const struct isl_drm_modifier_info
*
527 choose_drm_format_mod(const struct anv_physical_device
*device
,
528 uint32_t modifier_count
, const uint64_t *modifiers
)
530 uint64_t best_mod
= UINT64_MAX
;
531 uint32_t best_score
= 0;
533 for (uint32_t i
= 0; i
< modifier_count
; ++i
) {
534 uint32_t score
= score_drm_format_mod(modifiers
[i
]);
535 if (score
> best_score
) {
536 best_mod
= modifiers
[i
];
542 return isl_drm_modifier_get_info(best_mod
);
548 anv_image_create(VkDevice _device
,
549 const struct anv_image_create_info
*create_info
,
550 const VkAllocationCallbacks
* alloc
,
553 ANV_FROM_HANDLE(anv_device
, device
, _device
);
554 const VkImageCreateInfo
*pCreateInfo
= create_info
->vk_info
;
555 const struct isl_drm_modifier_info
*isl_mod_info
= NULL
;
556 struct anv_image
*image
= NULL
;
559 assert(pCreateInfo
->sType
== VK_STRUCTURE_TYPE_IMAGE_CREATE_INFO
);
561 const struct wsi_image_create_info
*wsi_info
=
562 vk_find_struct_const(pCreateInfo
->pNext
, WSI_IMAGE_CREATE_INFO_MESA
);
563 if (wsi_info
&& wsi_info
->modifier_count
> 0) {
564 isl_mod_info
= choose_drm_format_mod(&device
->instance
->physicalDevice
,
565 wsi_info
->modifier_count
,
566 wsi_info
->modifiers
);
567 assert(isl_mod_info
);
570 anv_assert(pCreateInfo
->mipLevels
> 0);
571 anv_assert(pCreateInfo
->arrayLayers
> 0);
572 anv_assert(pCreateInfo
->samples
> 0);
573 anv_assert(pCreateInfo
->extent
.width
> 0);
574 anv_assert(pCreateInfo
->extent
.height
> 0);
575 anv_assert(pCreateInfo
->extent
.depth
> 0);
577 image
= vk_zalloc2(&device
->alloc
, alloc
, sizeof(*image
), 8,
578 VK_SYSTEM_ALLOCATION_SCOPE_OBJECT
);
580 return vk_error(VK_ERROR_OUT_OF_HOST_MEMORY
);
582 image
->type
= pCreateInfo
->imageType
;
583 image
->extent
= pCreateInfo
->extent
;
584 image
->vk_format
= pCreateInfo
->format
;
585 image
->format
= anv_get_format(pCreateInfo
->format
);
586 image
->aspects
= vk_format_aspects(image
->vk_format
);
587 image
->levels
= pCreateInfo
->mipLevels
;
588 image
->array_size
= pCreateInfo
->arrayLayers
;
589 image
->samples
= pCreateInfo
->samples
;
590 image
->usage
= pCreateInfo
->usage
;
591 image
->tiling
= pCreateInfo
->tiling
;
592 image
->disjoint
= pCreateInfo
->flags
& VK_IMAGE_CREATE_DISJOINT_BIT
;
593 image
->needs_set_tiling
= wsi_info
&& wsi_info
->scanout
;
594 image
->drm_format_mod
= isl_mod_info
? isl_mod_info
->modifier
:
595 DRM_FORMAT_MOD_INVALID
;
597 const struct anv_format
*format
= anv_get_format(image
->vk_format
);
598 assert(format
!= NULL
);
600 const isl_tiling_flags_t isl_tiling_flags
=
601 choose_isl_tiling_flags(create_info
, isl_mod_info
,
602 image
->needs_set_tiling
);
604 image
->n_planes
= format
->n_planes
;
607 for_each_bit(b
, image
->aspects
) {
608 r
= make_surface(device
, image
, create_info
, isl_tiling_flags
,
614 *pImage
= anv_image_to_handle(image
);
620 vk_free2(&device
->alloc
, alloc
, image
);
626 anv_CreateImage(VkDevice device
,
627 const VkImageCreateInfo
*pCreateInfo
,
628 const VkAllocationCallbacks
*pAllocator
,
632 const VkNativeBufferANDROID
*gralloc_info
=
633 vk_find_struct_const(pCreateInfo
->pNext
, NATIVE_BUFFER_ANDROID
);
636 return anv_image_from_gralloc(device
, pCreateInfo
, gralloc_info
,
640 return anv_image_create(device
,
641 &(struct anv_image_create_info
) {
642 .vk_info
= pCreateInfo
,
649 anv_DestroyImage(VkDevice _device
, VkImage _image
,
650 const VkAllocationCallbacks
*pAllocator
)
652 ANV_FROM_HANDLE(anv_device
, device
, _device
);
653 ANV_FROM_HANDLE(anv_image
, image
, _image
);
658 for (uint32_t p
= 0; p
< image
->n_planes
; ++p
) {
659 if (image
->planes
[p
].bo_is_owned
) {
660 assert(image
->planes
[p
].bo
!= NULL
);
661 anv_bo_cache_release(device
, &device
->bo_cache
, image
->planes
[p
].bo
);
665 vk_free2(&device
->alloc
, pAllocator
, image
);
668 static void anv_image_bind_memory_plane(struct anv_device
*device
,
669 struct anv_image
*image
,
671 struct anv_device_memory
*memory
,
672 uint32_t memory_offset
)
674 assert(!image
->planes
[plane
].bo_is_owned
);
677 image
->planes
[plane
].bo
= NULL
;
678 image
->planes
[plane
].bo_offset
= 0;
682 image
->planes
[plane
].bo
= memory
->bo
;
683 image
->planes
[plane
].bo_offset
= memory_offset
;
686 VkResult
anv_BindImageMemory(
689 VkDeviceMemory _memory
,
690 VkDeviceSize memoryOffset
)
692 ANV_FROM_HANDLE(anv_device
, device
, _device
);
693 ANV_FROM_HANDLE(anv_device_memory
, mem
, _memory
);
694 ANV_FROM_HANDLE(anv_image
, image
, _image
);
697 anv_foreach_image_aspect_bit(aspect_bit
, image
, image
->aspects
) {
699 anv_image_aspect_to_plane(image
->aspects
, 1UL << aspect_bit
);
700 anv_image_bind_memory_plane(device
, image
, plane
, mem
, memoryOffset
);
706 VkResult
anv_BindImageMemory2(
708 uint32_t bindInfoCount
,
709 const VkBindImageMemoryInfo
* pBindInfos
)
711 ANV_FROM_HANDLE(anv_device
, device
, _device
);
713 for (uint32_t i
= 0; i
< bindInfoCount
; i
++) {
714 const VkBindImageMemoryInfo
*bind_info
= &pBindInfos
[i
];
715 ANV_FROM_HANDLE(anv_device_memory
, mem
, bind_info
->memory
);
716 ANV_FROM_HANDLE(anv_image
, image
, bind_info
->image
);
717 VkImageAspectFlags aspects
= image
->aspects
;
719 vk_foreach_struct_const(s
, bind_info
->pNext
) {
721 case VK_STRUCTURE_TYPE_BIND_IMAGE_PLANE_MEMORY_INFO
: {
722 const VkBindImagePlaneMemoryInfo
*plane_info
=
723 (const VkBindImagePlaneMemoryInfo
*) s
;
725 aspects
= plane_info
->planeAspect
;
729 anv_debug_ignored_stype(s
->sType
);
735 anv_foreach_image_aspect_bit(aspect_bit
, image
, aspects
) {
737 anv_image_aspect_to_plane(image
->aspects
, 1UL << aspect_bit
);
738 anv_image_bind_memory_plane(device
, image
, plane
,
739 mem
, bind_info
->memoryOffset
);
746 void anv_GetImageSubresourceLayout(
749 const VkImageSubresource
* subresource
,
750 VkSubresourceLayout
* layout
)
752 ANV_FROM_HANDLE(anv_image
, image
, _image
);
753 const struct anv_surface
*surface
=
754 get_surface(image
, subresource
->aspectMask
);
756 assert(__builtin_popcount(subresource
->aspectMask
) == 1);
758 /* If we are on a non-zero mip level or array slice, we need to
759 * calculate a real offset.
761 anv_assert(subresource
->mipLevel
== 0);
762 anv_assert(subresource
->arrayLayer
== 0);
764 layout
->offset
= surface
->offset
;
765 layout
->rowPitch
= surface
->isl
.row_pitch
;
766 layout
->depthPitch
= isl_surf_get_array_pitch(&surface
->isl
);
767 layout
->arrayPitch
= isl_surf_get_array_pitch(&surface
->isl
);
768 layout
->size
= surface
->isl
.size
;
772 * This function determines the optimal buffer to use for a given
773 * VkImageLayout and other pieces of information needed to make that
774 * determination. This does not determine the optimal buffer to use
775 * during a resolve operation.
777 * @param devinfo The device information of the Intel GPU.
778 * @param image The image that may contain a collection of buffers.
779 * @param aspect The aspect of the image to be accessed.
780 * @param layout The current layout of the image aspect(s).
782 * @return The primary buffer that should be used for the given layout.
785 anv_layout_to_aux_usage(const struct gen_device_info
* const devinfo
,
786 const struct anv_image
* const image
,
787 const VkImageAspectFlagBits aspect
,
788 const VkImageLayout layout
)
790 /* Validate the inputs. */
792 /* The devinfo is needed as the optimal buffer varies across generations. */
793 assert(devinfo
!= NULL
);
795 /* The layout of a NULL image is not properly defined. */
796 assert(image
!= NULL
);
798 /* The aspect must be exactly one of the image aspects. */
799 assert(_mesa_bitcount(aspect
) == 1 && (aspect
& image
->aspects
));
801 /* Determine the optimal buffer. */
803 uint32_t plane
= anv_image_aspect_to_plane(image
->aspects
, aspect
);
805 /* If there is no auxiliary surface allocated, we must use the one and only
808 if (image
->planes
[plane
].aux_surface
.isl
.size
== 0)
809 return ISL_AUX_USAGE_NONE
;
811 /* All images that use an auxiliary surface are required to be tiled. */
812 assert(image
->tiling
== VK_IMAGE_TILING_OPTIMAL
);
814 /* Stencil has no aux */
815 assert(aspect
!= VK_IMAGE_ASPECT_STENCIL_BIT
);
819 /* Invalid Layouts */
820 case VK_IMAGE_LAYOUT_RANGE_SIZE
:
821 case VK_IMAGE_LAYOUT_MAX_ENUM
:
822 unreachable("Invalid image layout.");
826 * The pre-initialized layout is equivalent to the undefined layout for
827 * optimally-tiled images. We can only do color compression (CCS or HiZ)
830 case VK_IMAGE_LAYOUT_UNDEFINED
:
831 case VK_IMAGE_LAYOUT_PREINITIALIZED
:
832 return ISL_AUX_USAGE_NONE
;
837 case VK_IMAGE_LAYOUT_GENERAL
:
838 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL
:
839 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL
:
840 if (aspect
== VK_IMAGE_ASPECT_DEPTH_BIT
) {
841 /* This buffer could be a depth buffer used in a transfer operation.
842 * BLORP currently doesn't use HiZ for transfer operations so we must
843 * use the main buffer for this layout. TODO: Enable HiZ in BLORP.
845 assert(image
->planes
[plane
].aux_usage
== ISL_AUX_USAGE_HIZ
);
846 return ISL_AUX_USAGE_NONE
;
848 assert(image
->aspects
& VK_IMAGE_ASPECT_ANY_COLOR_BIT_ANV
);
849 return image
->planes
[plane
].aux_usage
;
853 /* Sampling Layouts */
854 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL
:
855 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL
:
856 assert((image
->aspects
& VK_IMAGE_ASPECT_ANY_COLOR_BIT_ANV
) == 0);
858 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL
:
859 if (aspect
== VK_IMAGE_ASPECT_DEPTH_BIT
) {
860 if (anv_can_sample_with_hiz(devinfo
, image
))
861 return ISL_AUX_USAGE_HIZ
;
863 return ISL_AUX_USAGE_NONE
;
865 return image
->planes
[plane
].aux_usage
;
869 case VK_IMAGE_LAYOUT_PRESENT_SRC_KHR
:
870 assert(image
->aspects
== VK_IMAGE_ASPECT_COLOR_BIT
);
872 /* On SKL+, the render buffer can be decompressed by the presentation
873 * engine. Support for this feature has not yet landed in the wider
874 * ecosystem. TODO: Update this code when support lands.
876 * From the BDW PRM, Vol 7, Render Target Resolve:
878 * If the MCS is enabled on a non-multisampled render target, the
879 * render target must be resolved before being used for other
880 * purposes (display, texture, CPU lock) The clear value from
881 * SURFACE_STATE is written into pixels in the render target
882 * indicated as clear in the MCS.
884 * Pre-SKL, the render buffer must be resolved before being used for
885 * presentation. We can infer that the auxiliary buffer is not used.
887 return ISL_AUX_USAGE_NONE
;
890 /* Rendering Layouts */
891 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL
:
892 assert(aspect
& VK_IMAGE_ASPECT_ANY_COLOR_BIT_ANV
);
893 if (image
->planes
[plane
].aux_usage
== ISL_AUX_USAGE_NONE
) {
894 assert(image
->samples
== 1);
895 return ISL_AUX_USAGE_CCS_D
;
897 assert(image
->planes
[plane
].aux_usage
!= ISL_AUX_USAGE_CCS_D
);
898 return image
->planes
[plane
].aux_usage
;
901 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL
:
902 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL
:
903 assert(aspect
== VK_IMAGE_ASPECT_DEPTH_BIT
);
904 return ISL_AUX_USAGE_HIZ
;
906 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
:
907 unreachable("VK_KHR_shared_presentable_image is unsupported");
910 /* If the layout isn't recognized in the exhaustive switch above, the
911 * VkImageLayout value is not defined in vulkan.h.
913 unreachable("layout is not a VkImageLayout enumeration member.");
917 * This function returns the level of unresolved fast-clear support of the
918 * given image in the given VkImageLayout.
920 * @param devinfo The device information of the Intel GPU.
921 * @param image The image that may contain a collection of buffers.
922 * @param aspect The aspect of the image to be accessed.
923 * @param layout The current layout of the image aspect(s).
925 enum anv_fast_clear_type
926 anv_layout_to_fast_clear_type(const struct gen_device_info
* const devinfo
,
927 const struct anv_image
* const image
,
928 const VkImageAspectFlagBits aspect
,
929 const VkImageLayout layout
)
931 /* The aspect must be exactly one of the image aspects. */
932 assert(_mesa_bitcount(aspect
) == 1 && (aspect
& image
->aspects
));
934 uint32_t plane
= anv_image_aspect_to_plane(image
->aspects
, aspect
);
936 /* If there is no auxiliary surface allocated, there are no fast-clears */
937 if (image
->planes
[plane
].aux_surface
.isl
.size
== 0)
938 return ANV_FAST_CLEAR_NONE
;
940 /* All images that use an auxiliary surface are required to be tiled. */
941 assert(image
->tiling
== VK_IMAGE_TILING_OPTIMAL
);
943 /* Stencil has no aux */
944 assert(aspect
!= VK_IMAGE_ASPECT_STENCIL_BIT
);
946 if (aspect
== VK_IMAGE_ASPECT_DEPTH_BIT
) {
947 /* For depth images (with HiZ), the layout supports fast-clears if and
948 * only if it supports HiZ. However, we only support fast-clears to the
949 * default depth value.
951 enum isl_aux_usage aux_usage
=
952 anv_layout_to_aux_usage(devinfo
, image
, aspect
, layout
);
953 return aux_usage
== ISL_AUX_USAGE_HIZ
?
954 ANV_FAST_CLEAR_DEFAULT_VALUE
: ANV_FAST_CLEAR_NONE
;
957 assert(image
->aspects
& VK_IMAGE_ASPECT_ANY_COLOR_BIT_ANV
);
959 /* We don't support MSAA fast-clears on Ivybridge or Bay Trail because they
960 * lack the MI ALU which we need to determine the predicates.
962 if (devinfo
->gen
== 7 && !devinfo
->is_haswell
&& image
->samples
> 1)
963 return ANV_FAST_CLEAR_NONE
;
966 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL
:
967 return ANV_FAST_CLEAR_ANY
;
969 case VK_IMAGE_LAYOUT_PRESENT_SRC_KHR
:
970 return ANV_FAST_CLEAR_NONE
;
973 /* If the image has MCS or CCS_E enabled all the time then we can use
974 * fast-clear as long as the clear color is the default value of zero
975 * since this is the default value we program into every surface state
976 * used for texturing.
978 if (image
->planes
[plane
].aux_usage
== ISL_AUX_USAGE_MCS
||
979 image
->planes
[plane
].aux_usage
== ISL_AUX_USAGE_CCS_E
)
980 return ANV_FAST_CLEAR_DEFAULT_VALUE
;
982 return ANV_FAST_CLEAR_NONE
;
987 static struct anv_state
988 alloc_surface_state(struct anv_device
*device
)
990 return anv_state_pool_alloc(&device
->surface_state_pool
, 64, 64);
993 static enum isl_channel_select
994 remap_swizzle(VkComponentSwizzle swizzle
, VkComponentSwizzle component
,
995 struct isl_swizzle format_swizzle
)
997 if (swizzle
== VK_COMPONENT_SWIZZLE_IDENTITY
)
1001 case VK_COMPONENT_SWIZZLE_ZERO
: return ISL_CHANNEL_SELECT_ZERO
;
1002 case VK_COMPONENT_SWIZZLE_ONE
: return ISL_CHANNEL_SELECT_ONE
;
1003 case VK_COMPONENT_SWIZZLE_R
: return format_swizzle
.r
;
1004 case VK_COMPONENT_SWIZZLE_G
: return format_swizzle
.g
;
1005 case VK_COMPONENT_SWIZZLE_B
: return format_swizzle
.b
;
1006 case VK_COMPONENT_SWIZZLE_A
: return format_swizzle
.a
;
1008 unreachable("Invalid swizzle");
1013 anv_image_fill_surface_state(struct anv_device
*device
,
1014 const struct anv_image
*image
,
1015 VkImageAspectFlagBits aspect
,
1016 const struct isl_view
*view_in
,
1017 isl_surf_usage_flags_t view_usage
,
1018 enum isl_aux_usage aux_usage
,
1019 const union isl_color_value
*clear_color
,
1020 enum anv_image_view_state_flags flags
,
1021 struct anv_surface_state
*state_inout
,
1022 struct brw_image_param
*image_param_out
)
1024 uint32_t plane
= anv_image_aspect_to_plane(image
->aspects
, aspect
);
1026 const struct anv_surface
*surface
= &image
->planes
[plane
].surface
,
1027 *aux_surface
= &image
->planes
[plane
].aux_surface
;
1029 struct isl_view view
= *view_in
;
1030 view
.usage
|= view_usage
;
1032 /* For texturing with VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL from a
1033 * compressed surface with a shadow surface, we use the shadow instead of
1034 * the primary surface. The shadow surface will be tiled, unlike the main
1035 * surface, so it should get significantly better performance.
1037 if (image
->planes
[plane
].shadow_surface
.isl
.size
> 0 &&
1038 isl_format_is_compressed(view
.format
) &&
1039 (flags
& ANV_IMAGE_VIEW_STATE_TEXTURE_OPTIMAL
)) {
1040 assert(isl_format_is_compressed(surface
->isl
.format
));
1041 assert(surface
->isl
.tiling
== ISL_TILING_LINEAR
);
1042 assert(image
->planes
[plane
].shadow_surface
.isl
.tiling
!= ISL_TILING_LINEAR
);
1043 surface
= &image
->planes
[plane
].shadow_surface
;
1046 if (view_usage
== ISL_SURF_USAGE_RENDER_TARGET_BIT
)
1047 view
.swizzle
= anv_swizzle_for_render(view
.swizzle
);
1049 /* If this is a HiZ buffer we can sample from with a programmable clear
1050 * value (SKL+), define the clear value to the optimal constant.
1052 union isl_color_value default_clear_color
= { .u32
= { 0, } };
1053 if (device
->info
.gen
>= 9 && aux_usage
== ISL_AUX_USAGE_HIZ
)
1054 default_clear_color
.f32
[0] = ANV_HZ_FC_VAL
;
1056 clear_color
= &default_clear_color
;
1058 const uint64_t address
= image
->planes
[plane
].bo_offset
+ surface
->offset
;
1059 const uint64_t aux_address
= aux_usage
== ISL_AUX_USAGE_NONE
?
1060 0 : (image
->planes
[plane
].bo_offset
+ aux_surface
->offset
);
1062 if (view_usage
== ISL_SURF_USAGE_STORAGE_BIT
&&
1063 !(flags
& ANV_IMAGE_VIEW_STATE_STORAGE_WRITE_ONLY
) &&
1064 !isl_has_matching_typed_storage_image_format(&device
->info
,
1066 /* In this case, we are a writeable storage buffer which needs to be
1067 * lowered to linear. All tiling and offset calculations will be done in
1070 assert(aux_usage
== ISL_AUX_USAGE_NONE
);
1071 isl_buffer_fill_state(&device
->isl_dev
, state_inout
->state
.map
,
1073 .size
= surface
->isl
.size
,
1074 .format
= ISL_FORMAT_RAW
,
1076 .mocs
= device
->default_mocs
);
1077 state_inout
->address
= address
,
1078 state_inout
->aux_address
= 0;
1080 if (view_usage
== ISL_SURF_USAGE_STORAGE_BIT
&&
1081 !(flags
& ANV_IMAGE_VIEW_STATE_STORAGE_WRITE_ONLY
)) {
1082 /* Typed surface reads support a very limited subset of the shader
1083 * image formats. Translate it into the closest format the hardware
1086 assert(aux_usage
== ISL_AUX_USAGE_NONE
);
1087 view
.format
= isl_lower_storage_image_format(&device
->info
,
1091 const struct isl_surf
*isl_surf
= &surface
->isl
;
1093 struct isl_surf tmp_surf
;
1094 uint32_t offset_B
= 0, tile_x_sa
= 0, tile_y_sa
= 0;
1095 if (isl_format_is_compressed(surface
->isl
.format
) &&
1096 !isl_format_is_compressed(view
.format
)) {
1097 /* We're creating an uncompressed view of a compressed surface. This
1098 * is allowed but only for a single level/layer.
1100 assert(surface
->isl
.samples
== 1);
1101 assert(view
.levels
== 1);
1102 assert(view
.array_len
== 1);
1104 isl_surf_get_image_surf(&device
->isl_dev
, isl_surf
,
1106 surface
->isl
.dim
== ISL_SURF_DIM_3D
?
1107 0 : view
.base_array_layer
,
1108 surface
->isl
.dim
== ISL_SURF_DIM_3D
?
1109 view
.base_array_layer
: 0,
1111 &offset_B
, &tile_x_sa
, &tile_y_sa
);
1113 /* The newly created image represents the one subimage we're
1114 * referencing with this view so it only has one array slice and
1117 view
.base_array_layer
= 0;
1118 view
.base_level
= 0;
1120 /* We're making an uncompressed view here. The image dimensions need
1121 * to be scaled down by the block size.
1123 const struct isl_format_layout
*fmtl
=
1124 isl_format_get_layout(surface
->isl
.format
);
1125 tmp_surf
.format
= view
.format
;
1126 tmp_surf
.logical_level0_px
.width
=
1127 DIV_ROUND_UP(tmp_surf
.logical_level0_px
.width
, fmtl
->bw
);
1128 tmp_surf
.logical_level0_px
.height
=
1129 DIV_ROUND_UP(tmp_surf
.logical_level0_px
.height
, fmtl
->bh
);
1130 tmp_surf
.phys_level0_sa
.width
/= fmtl
->bw
;
1131 tmp_surf
.phys_level0_sa
.height
/= fmtl
->bh
;
1132 tile_x_sa
/= fmtl
->bw
;
1133 tile_y_sa
/= fmtl
->bh
;
1135 isl_surf
= &tmp_surf
;
1137 if (device
->info
.gen
<= 8) {
1138 assert(surface
->isl
.tiling
== ISL_TILING_LINEAR
);
1139 assert(tile_x_sa
== 0);
1140 assert(tile_y_sa
== 0);
1144 isl_surf_fill_state(&device
->isl_dev
, state_inout
->state
.map
,
1147 .address
= address
+ offset_B
,
1148 .clear_color
= *clear_color
,
1149 .aux_surf
= &aux_surface
->isl
,
1150 .aux_usage
= aux_usage
,
1151 .aux_address
= aux_address
,
1152 .mocs
= device
->default_mocs
,
1153 .x_offset_sa
= tile_x_sa
,
1154 .y_offset_sa
= tile_y_sa
);
1155 state_inout
->address
= address
+ offset_B
;
1157 /* With the exception of gen8, the bottom 12 bits of the MCS base address
1158 * are used to store other information. This should be ok, however,
1159 * because the surface buffer addresses are always 4K page aligned.
1161 uint32_t *aux_addr_dw
= state_inout
->state
.map
+
1162 device
->isl_dev
.ss
.aux_addr_offset
;
1163 assert((aux_address
& 0xfff) == 0);
1164 assert(aux_address
== (*aux_addr_dw
& 0xfffff000));
1165 state_inout
->aux_address
= *aux_addr_dw
;
1168 anv_state_flush(device
, state_inout
->state
);
1170 if (image_param_out
) {
1171 assert(view_usage
== ISL_SURF_USAGE_STORAGE_BIT
);
1172 isl_surf_fill_image_param(&device
->isl_dev
, image_param_out
,
1173 &surface
->isl
, &view
);
1177 static VkImageAspectFlags
1178 remap_aspect_flags(VkImageAspectFlags view_aspects
)
1180 if (view_aspects
& VK_IMAGE_ASPECT_ANY_COLOR_BIT_ANV
) {
1181 if (_mesa_bitcount(view_aspects
) == 1)
1182 return VK_IMAGE_ASPECT_COLOR_BIT
;
1184 VkImageAspectFlags color_aspects
= 0;
1185 for (uint32_t i
= 0; i
< _mesa_bitcount(view_aspects
); i
++)
1186 color_aspects
|= VK_IMAGE_ASPECT_PLANE_0_BIT
<< i
;
1187 return color_aspects
;
1189 /* No special remapping needed for depth & stencil aspects. */
1190 return view_aspects
;
1194 anv_CreateImageView(VkDevice _device
,
1195 const VkImageViewCreateInfo
*pCreateInfo
,
1196 const VkAllocationCallbacks
*pAllocator
,
1199 ANV_FROM_HANDLE(anv_device
, device
, _device
);
1200 ANV_FROM_HANDLE(anv_image
, image
, pCreateInfo
->image
);
1201 struct anv_image_view
*iview
;
1203 iview
= vk_zalloc2(&device
->alloc
, pAllocator
, sizeof(*iview
), 8,
1204 VK_SYSTEM_ALLOCATION_SCOPE_OBJECT
);
1206 return vk_error(VK_ERROR_OUT_OF_HOST_MEMORY
);
1208 const VkImageSubresourceRange
*range
= &pCreateInfo
->subresourceRange
;
1210 assert(range
->layerCount
> 0);
1211 assert(range
->baseMipLevel
< image
->levels
);
1213 const VkImageViewUsageCreateInfo
*usage_info
=
1214 vk_find_struct_const(pCreateInfo
, IMAGE_VIEW_USAGE_CREATE_INFO
);
1215 VkImageUsageFlags view_usage
= usage_info
? usage_info
->usage
: image
->usage
;
1216 /* View usage should be a subset of image usage */
1217 assert((view_usage
& ~image
->usage
) == 0);
1218 assert(view_usage
& (VK_IMAGE_USAGE_SAMPLED_BIT
|
1219 VK_IMAGE_USAGE_STORAGE_BIT
|
1220 VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT
|
1221 VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT
|
1222 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT
));
1224 switch (image
->type
) {
1226 unreachable("bad VkImageType");
1227 case VK_IMAGE_TYPE_1D
:
1228 case VK_IMAGE_TYPE_2D
:
1229 assert(range
->baseArrayLayer
+ anv_get_layerCount(image
, range
) - 1 <= image
->array_size
);
1231 case VK_IMAGE_TYPE_3D
:
1232 assert(range
->baseArrayLayer
+ anv_get_layerCount(image
, range
) - 1
1233 <= anv_minify(image
->extent
.depth
, range
->baseMipLevel
));
1237 /* First expand aspects to the image's ones (for example
1238 * VK_IMAGE_ASPECT_COLOR_BIT will be converted to
1239 * VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT |
1240 * VK_IMAGE_ASPECT_PLANE_2_BIT for an image of format
1241 * VK_FORMAT_G8_B8_R8_3PLANE_420_UNORM_KHR.
1243 VkImageAspectFlags expanded_aspects
=
1244 anv_image_expand_aspects(image
, range
->aspectMask
);
1246 iview
->image
= image
;
1248 /* Remap the expanded aspects for the image view. For example if only
1249 * VK_IMAGE_ASPECT_PLANE_1_BIT was given in range->aspectMask, we will
1250 * convert it to VK_IMAGE_ASPECT_COLOR_BIT since from the point of view of
1251 * the image view, it only has a single plane.
1253 iview
->aspect_mask
= remap_aspect_flags(expanded_aspects
);
1254 iview
->n_planes
= anv_image_aspect_get_planes(iview
->aspect_mask
);
1255 iview
->vk_format
= pCreateInfo
->format
;
1257 iview
->extent
= (VkExtent3D
) {
1258 .width
= anv_minify(image
->extent
.width
, range
->baseMipLevel
),
1259 .height
= anv_minify(image
->extent
.height
, range
->baseMipLevel
),
1260 .depth
= anv_minify(image
->extent
.depth
, range
->baseMipLevel
),
1263 /* Now go through the underlying image selected planes (computed in
1264 * expanded_aspects) and map them to planes in the image view.
1266 uint32_t iaspect_bit
, vplane
= 0;
1267 anv_foreach_image_aspect_bit(iaspect_bit
, image
, expanded_aspects
) {
1269 anv_image_aspect_to_plane(expanded_aspects
, 1UL << iaspect_bit
);
1270 VkImageAspectFlags vplane_aspect
=
1271 anv_plane_to_aspect(iview
->aspect_mask
, vplane
);
1272 struct anv_format_plane format
=
1273 anv_get_format_plane(&device
->info
, pCreateInfo
->format
,
1274 vplane_aspect
, image
->tiling
);
1276 iview
->planes
[vplane
].image_plane
= iplane
;
1278 iview
->planes
[vplane
].isl
= (struct isl_view
) {
1279 .format
= format
.isl_format
,
1280 .base_level
= range
->baseMipLevel
,
1281 .levels
= anv_get_levelCount(image
, range
),
1282 .base_array_layer
= range
->baseArrayLayer
,
1283 .array_len
= anv_get_layerCount(image
, range
),
1285 .r
= remap_swizzle(pCreateInfo
->components
.r
,
1286 VK_COMPONENT_SWIZZLE_R
, format
.swizzle
),
1287 .g
= remap_swizzle(pCreateInfo
->components
.g
,
1288 VK_COMPONENT_SWIZZLE_G
, format
.swizzle
),
1289 .b
= remap_swizzle(pCreateInfo
->components
.b
,
1290 VK_COMPONENT_SWIZZLE_B
, format
.swizzle
),
1291 .a
= remap_swizzle(pCreateInfo
->components
.a
,
1292 VK_COMPONENT_SWIZZLE_A
, format
.swizzle
),
1296 if (pCreateInfo
->viewType
== VK_IMAGE_VIEW_TYPE_3D
) {
1297 iview
->planes
[vplane
].isl
.base_array_layer
= 0;
1298 iview
->planes
[vplane
].isl
.array_len
= iview
->extent
.depth
;
1301 if (pCreateInfo
->viewType
== VK_IMAGE_VIEW_TYPE_CUBE
||
1302 pCreateInfo
->viewType
== VK_IMAGE_VIEW_TYPE_CUBE_ARRAY
) {
1303 iview
->planes
[vplane
].isl
.usage
= ISL_SURF_USAGE_CUBE_BIT
;
1305 iview
->planes
[vplane
].isl
.usage
= 0;
1308 if (view_usage
& VK_IMAGE_USAGE_SAMPLED_BIT
||
1309 (view_usage
& VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT
&&
1310 !(iview
->aspect_mask
& VK_IMAGE_ASPECT_COLOR_BIT
))) {
1311 iview
->planes
[vplane
].optimal_sampler_surface_state
.state
= alloc_surface_state(device
);
1312 iview
->planes
[vplane
].general_sampler_surface_state
.state
= alloc_surface_state(device
);
1314 enum isl_aux_usage general_aux_usage
=
1315 anv_layout_to_aux_usage(&device
->info
, image
, 1UL << iaspect_bit
,
1316 VK_IMAGE_LAYOUT_GENERAL
);
1317 enum isl_aux_usage optimal_aux_usage
=
1318 anv_layout_to_aux_usage(&device
->info
, image
, 1UL << iaspect_bit
,
1319 VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL
);
1321 anv_image_fill_surface_state(device
, image
, 1ULL << iaspect_bit
,
1322 &iview
->planes
[vplane
].isl
,
1323 ISL_SURF_USAGE_TEXTURE_BIT
,
1324 optimal_aux_usage
, NULL
,
1325 ANV_IMAGE_VIEW_STATE_TEXTURE_OPTIMAL
,
1326 &iview
->planes
[vplane
].optimal_sampler_surface_state
,
1329 anv_image_fill_surface_state(device
, image
, 1ULL << iaspect_bit
,
1330 &iview
->planes
[vplane
].isl
,
1331 ISL_SURF_USAGE_TEXTURE_BIT
,
1332 general_aux_usage
, NULL
,
1334 &iview
->planes
[vplane
].general_sampler_surface_state
,
1338 /* NOTE: This one needs to go last since it may stomp isl_view.format */
1339 if (view_usage
& VK_IMAGE_USAGE_STORAGE_BIT
) {
1340 iview
->planes
[vplane
].storage_surface_state
.state
= alloc_surface_state(device
);
1341 iview
->planes
[vplane
].writeonly_storage_surface_state
.state
= alloc_surface_state(device
);
1343 anv_image_fill_surface_state(device
, image
, 1ULL << iaspect_bit
,
1344 &iview
->planes
[vplane
].isl
,
1345 ISL_SURF_USAGE_STORAGE_BIT
,
1346 ISL_AUX_USAGE_NONE
, NULL
,
1348 &iview
->planes
[vplane
].storage_surface_state
,
1349 &iview
->planes
[vplane
].storage_image_param
);
1351 anv_image_fill_surface_state(device
, image
, 1ULL << iaspect_bit
,
1352 &iview
->planes
[vplane
].isl
,
1353 ISL_SURF_USAGE_STORAGE_BIT
,
1354 ISL_AUX_USAGE_NONE
, NULL
,
1355 ANV_IMAGE_VIEW_STATE_STORAGE_WRITE_ONLY
,
1356 &iview
->planes
[vplane
].writeonly_storage_surface_state
,
1363 *pView
= anv_image_view_to_handle(iview
);
1369 anv_DestroyImageView(VkDevice _device
, VkImageView _iview
,
1370 const VkAllocationCallbacks
*pAllocator
)
1372 ANV_FROM_HANDLE(anv_device
, device
, _device
);
1373 ANV_FROM_HANDLE(anv_image_view
, iview
, _iview
);
1378 for (uint32_t plane
= 0; plane
< iview
->n_planes
; plane
++) {
1379 if (iview
->planes
[plane
].optimal_sampler_surface_state
.state
.alloc_size
> 0) {
1380 anv_state_pool_free(&device
->surface_state_pool
,
1381 iview
->planes
[plane
].optimal_sampler_surface_state
.state
);
1384 if (iview
->planes
[plane
].general_sampler_surface_state
.state
.alloc_size
> 0) {
1385 anv_state_pool_free(&device
->surface_state_pool
,
1386 iview
->planes
[plane
].general_sampler_surface_state
.state
);
1389 if (iview
->planes
[plane
].storage_surface_state
.state
.alloc_size
> 0) {
1390 anv_state_pool_free(&device
->surface_state_pool
,
1391 iview
->planes
[plane
].storage_surface_state
.state
);
1394 if (iview
->planes
[plane
].writeonly_storage_surface_state
.state
.alloc_size
> 0) {
1395 anv_state_pool_free(&device
->surface_state_pool
,
1396 iview
->planes
[plane
].writeonly_storage_surface_state
.state
);
1400 vk_free2(&device
->alloc
, pAllocator
, iview
);
1405 anv_CreateBufferView(VkDevice _device
,
1406 const VkBufferViewCreateInfo
*pCreateInfo
,
1407 const VkAllocationCallbacks
*pAllocator
,
1408 VkBufferView
*pView
)
1410 ANV_FROM_HANDLE(anv_device
, device
, _device
);
1411 ANV_FROM_HANDLE(anv_buffer
, buffer
, pCreateInfo
->buffer
);
1412 struct anv_buffer_view
*view
;
1414 view
= vk_alloc2(&device
->alloc
, pAllocator
, sizeof(*view
), 8,
1415 VK_SYSTEM_ALLOCATION_SCOPE_OBJECT
);
1417 return vk_error(VK_ERROR_OUT_OF_HOST_MEMORY
);
1419 /* TODO: Handle the format swizzle? */
1421 view
->format
= anv_get_isl_format(&device
->info
, pCreateInfo
->format
,
1422 VK_IMAGE_ASPECT_COLOR_BIT
,
1423 VK_IMAGE_TILING_LINEAR
);
1424 const uint32_t format_bs
= isl_format_get_layout(view
->format
)->bpb
/ 8;
1425 view
->bo
= buffer
->bo
;
1426 view
->offset
= buffer
->offset
+ pCreateInfo
->offset
;
1427 view
->range
= anv_buffer_get_range(buffer
, pCreateInfo
->offset
,
1428 pCreateInfo
->range
);
1429 view
->range
= align_down_npot_u32(view
->range
, format_bs
);
1431 if (buffer
->usage
& VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT
) {
1432 view
->surface_state
= alloc_surface_state(device
);
1434 anv_fill_buffer_surface_state(device
, view
->surface_state
,
1436 view
->offset
, view
->range
, format_bs
);
1438 view
->surface_state
= (struct anv_state
){ 0 };
1441 if (buffer
->usage
& VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT
) {
1442 view
->storage_surface_state
= alloc_surface_state(device
);
1443 view
->writeonly_storage_surface_state
= alloc_surface_state(device
);
1445 enum isl_format storage_format
=
1446 isl_has_matching_typed_storage_image_format(&device
->info
,
1448 isl_lower_storage_image_format(&device
->info
, view
->format
) :
1451 anv_fill_buffer_surface_state(device
, view
->storage_surface_state
,
1453 view
->offset
, view
->range
,
1454 (storage_format
== ISL_FORMAT_RAW
? 1 :
1455 isl_format_get_layout(storage_format
)->bpb
/ 8));
1457 /* Write-only accesses should use the original format. */
1458 anv_fill_buffer_surface_state(device
, view
->writeonly_storage_surface_state
,
1460 view
->offset
, view
->range
,
1461 isl_format_get_layout(view
->format
)->bpb
/ 8);
1463 isl_buffer_fill_image_param(&device
->isl_dev
,
1464 &view
->storage_image_param
,
1465 view
->format
, view
->range
);
1467 view
->storage_surface_state
= (struct anv_state
){ 0 };
1468 view
->writeonly_storage_surface_state
= (struct anv_state
){ 0 };
1471 *pView
= anv_buffer_view_to_handle(view
);
1477 anv_DestroyBufferView(VkDevice _device
, VkBufferView bufferView
,
1478 const VkAllocationCallbacks
*pAllocator
)
1480 ANV_FROM_HANDLE(anv_device
, device
, _device
);
1481 ANV_FROM_HANDLE(anv_buffer_view
, view
, bufferView
);
1486 if (view
->surface_state
.alloc_size
> 0)
1487 anv_state_pool_free(&device
->surface_state_pool
,
1488 view
->surface_state
);
1490 if (view
->storage_surface_state
.alloc_size
> 0)
1491 anv_state_pool_free(&device
->surface_state_pool
,
1492 view
->storage_surface_state
);
1494 if (view
->writeonly_storage_surface_state
.alloc_size
> 0)
1495 anv_state_pool_free(&device
->surface_state_pool
,
1496 view
->writeonly_storage_surface_state
);
1498 vk_free2(&device
->alloc
, pAllocator
, view
);
1501 const struct anv_surface
*
1502 anv_image_get_surface_for_aspect_mask(const struct anv_image
*image
,
1503 VkImageAspectFlags aspect_mask
)
1505 VkImageAspectFlags sanitized_mask
;
1507 switch (aspect_mask
) {
1508 case VK_IMAGE_ASPECT_COLOR_BIT
:
1509 assert(image
->aspects
== VK_IMAGE_ASPECT_COLOR_BIT
);
1510 sanitized_mask
= VK_IMAGE_ASPECT_COLOR_BIT
;
1512 case VK_IMAGE_ASPECT_DEPTH_BIT
:
1513 assert(image
->aspects
& VK_IMAGE_ASPECT_DEPTH_BIT
);
1514 sanitized_mask
= VK_IMAGE_ASPECT_DEPTH_BIT
;
1516 case VK_IMAGE_ASPECT_STENCIL_BIT
:
1517 assert(image
->aspects
& VK_IMAGE_ASPECT_STENCIL_BIT
);
1518 sanitized_mask
= VK_IMAGE_ASPECT_STENCIL_BIT
;
1520 case VK_IMAGE_ASPECT_DEPTH_BIT
| VK_IMAGE_ASPECT_STENCIL_BIT
:
1521 /* FINISHME: The Vulkan spec (git a511ba2) requires support for
1522 * combined depth stencil formats. Specifically, it states:
1524 * At least one of ename:VK_FORMAT_D24_UNORM_S8_UINT or
1525 * ename:VK_FORMAT_D32_SFLOAT_S8_UINT must be supported.
1527 * Image views with both depth and stencil aspects are only valid for
1528 * render target attachments, in which case
1529 * cmd_buffer_emit_depth_stencil() will pick out both the depth and
1530 * stencil surfaces from the underlying surface.
1532 if (image
->aspects
& VK_IMAGE_ASPECT_DEPTH_BIT
) {
1533 sanitized_mask
= VK_IMAGE_ASPECT_DEPTH_BIT
;
1535 assert(image
->aspects
== VK_IMAGE_ASPECT_STENCIL_BIT
);
1536 sanitized_mask
= VK_IMAGE_ASPECT_STENCIL_BIT
;
1539 case VK_IMAGE_ASPECT_PLANE_0_BIT
:
1540 assert((image
->aspects
& ~VK_IMAGE_ASPECT_ANY_COLOR_BIT_ANV
) == 0);
1541 sanitized_mask
= VK_IMAGE_ASPECT_PLANE_0_BIT
;
1543 case VK_IMAGE_ASPECT_PLANE_1_BIT
:
1544 assert((image
->aspects
& ~VK_IMAGE_ASPECT_ANY_COLOR_BIT_ANV
) == 0);
1545 sanitized_mask
= VK_IMAGE_ASPECT_PLANE_1_BIT
;
1547 case VK_IMAGE_ASPECT_PLANE_2_BIT
:
1548 assert((image
->aspects
& ~VK_IMAGE_ASPECT_ANY_COLOR_BIT_ANV
) == 0);
1549 sanitized_mask
= VK_IMAGE_ASPECT_PLANE_2_BIT
;
1552 unreachable("image does not have aspect");
1556 uint32_t plane
= anv_image_aspect_to_plane(image
->aspects
, sanitized_mask
);
1557 return &image
->planes
[plane
].surface
;