/* * Copyright 2018 Collabora Ltd. * * Permission is hereby granted, free of charge, to any person obtaining a * copy of this software and associated documentation files (the "Software"), * to deal in the Software without restriction, including without limitation * on the rights to use, copy, modify, merge, publish, distribute, sub * license, and/or sell copies of the Software, and to permit persons to whom * the Software is furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice (including the next * paragraph) shall be included in all copies or substantial portions of the * Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL * THE AUTHOR(S) AND/OR THEIR SUPPLIERS BE LIABLE FOR ANY CLAIM, * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE * USE OR OTHER DEALINGS IN THE SOFTWARE. */ #include "zink_context.h" #include "zink_framebuffer.h" #include "zink_format.h" #include "zink_resource.h" #include "zink_screen.h" #include "zink_surface.h" #include "zink_kopper.h" #include "util/format/u_format.h" #include "util/u_inlines.h" #include "util/u_memory.h" VkImageViewCreateInfo create_ivci(struct zink_screen *screen, struct zink_resource *res, const struct pipe_surface *templ, enum pipe_texture_target target) { VkImageViewCreateInfo ivci; /* zero holes since this is hashed */ memset(&ivci, 0, sizeof(VkImageViewCreateInfo)); ivci.sType = VK_STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO; ivci.image = res->obj->image; switch (target) { case PIPE_TEXTURE_1D: ivci.viewType = res->need_2D ? VK_IMAGE_VIEW_TYPE_2D : VK_IMAGE_VIEW_TYPE_1D; break; case PIPE_TEXTURE_1D_ARRAY: ivci.viewType = res->need_2D ? VK_IMAGE_VIEW_TYPE_2D_ARRAY : VK_IMAGE_VIEW_TYPE_1D_ARRAY; break; case PIPE_TEXTURE_2D: case PIPE_TEXTURE_RECT: ivci.viewType = VK_IMAGE_VIEW_TYPE_2D; break; case PIPE_TEXTURE_2D_ARRAY: ivci.viewType = VK_IMAGE_VIEW_TYPE_2D_ARRAY; break; case PIPE_TEXTURE_CUBE: ivci.viewType = VK_IMAGE_VIEW_TYPE_CUBE; break; case PIPE_TEXTURE_CUBE_ARRAY: ivci.viewType = VK_IMAGE_VIEW_TYPE_CUBE_ARRAY; break; case PIPE_TEXTURE_3D: ivci.viewType = VK_IMAGE_VIEW_TYPE_3D; break; default: unreachable("unsupported target"); } ivci.format = res->base.b.format == PIPE_FORMAT_A8_UNORM ? res->format : zink_get_format(screen, templ->format); assert(ivci.format != VK_FORMAT_UNDEFINED); /* TODO: it's currently illegal to use non-identity swizzles for framebuffer attachments, * but if that ever changes, this will be useful const struct util_format_description *desc = util_format_description(templ->format); ivci.components.r = zink_component_mapping(zink_clamp_void_swizzle(desc, PIPE_SWIZZLE_X)); ivci.components.g = zink_component_mapping(zink_clamp_void_swizzle(desc, PIPE_SWIZZLE_Y)); ivci.components.b = zink_component_mapping(zink_clamp_void_swizzle(desc, PIPE_SWIZZLE_Z)); ivci.components.a = zink_component_mapping(zink_clamp_void_swizzle(desc, PIPE_SWIZZLE_W)); */ ivci.components.r = VK_COMPONENT_SWIZZLE_R; ivci.components.g = VK_COMPONENT_SWIZZLE_G; ivci.components.b = VK_COMPONENT_SWIZZLE_B; ivci.components.a = VK_COMPONENT_SWIZZLE_A; ivci.subresourceRange.aspectMask = res->aspect; ivci.subresourceRange.baseMipLevel = templ->u.tex.level; ivci.subresourceRange.levelCount = 1; ivci.subresourceRange.baseArrayLayer = templ->u.tex.first_layer; ivci.subresourceRange.layerCount = 1 + templ->u.tex.last_layer - templ->u.tex.first_layer; assert(ivci.viewType != VK_IMAGE_VIEW_TYPE_3D || ivci.subresourceRange.baseArrayLayer == 0); assert(ivci.viewType != VK_IMAGE_VIEW_TYPE_3D || ivci.subresourceRange.layerCount == 1); /* ensure cube image types get clamped to 2D/2D_ARRAY as expected for partial views */ ivci.viewType = zink_surface_clamp_viewtype(ivci.viewType, templ->u.tex.first_layer, templ->u.tex.last_layer, res->base.b.array_size); return ivci; } /* this is used for framebuffer attachments to set up imageless framebuffers */ static void init_surface_info(struct zink_screen *screen, struct zink_surface *surface, struct zink_resource *res, VkImageViewCreateInfo *ivci) { VkImageViewUsageCreateInfo *usage_info = (VkImageViewUsageCreateInfo *)ivci->pNext; surface->info.flags = res->obj->vkflags; surface->info.usage = usage_info ? usage_info->usage : res->obj->vkusage; surface->info.width = surface->base.width; surface->info.height = surface->base.height; surface->info.layerCount = ivci->subresourceRange.layerCount; surface->info.format[0] = ivci->format; if (res->obj->dt) { struct kopper_displaytarget *cdt = res->obj->dt; if (zink_kopper_has_srgb(cdt)) surface->info.format[1] = ivci->format == cdt->formats[0] ? cdt->formats[1] : cdt->formats[0]; } else { enum pipe_format srgb = util_format_is_srgb(surface->base.format) ? util_format_linear(surface->base.format) : util_format_srgb(surface->base.format); if (srgb == surface->base.format) srgb = PIPE_FORMAT_NONE; if (srgb) { VkFormat format = zink_get_format(screen, srgb); if (format) surface->info.format[1] = format; } } } static void init_pipe_surface_info(struct pipe_context *pctx, struct pipe_surface *psurf, const struct pipe_surface *templ, const struct pipe_resource *pres) { unsigned int level = templ->u.tex.level; psurf->context = pctx; psurf->format = templ->format; psurf->width = u_minify(pres->width0, level); assert(psurf->width); psurf->height = u_minify(pres->height0, level); assert(psurf->height); psurf->nr_samples = templ->nr_samples; psurf->u.tex.level = level; psurf->u.tex.first_layer = templ->u.tex.first_layer; psurf->u.tex.last_layer = templ->u.tex.last_layer; } static void apply_view_usage_for_format(struct zink_screen *screen, struct zink_resource *res, struct zink_surface *surface, enum pipe_format format, VkImageViewCreateInfo *ivci) { VkFormatFeatureFlags feats = res->linear ? screen->format_props[format].linearTilingFeatures : screen->format_props[format].optimalTilingFeatures; VkImageUsageFlags attachment = (VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT); surface->usage_info.usage = res->obj->vkusage & ~attachment; if (res->obj->modifier_aspect) { feats = res->obj->vkfeats; /* intersect format features for current modifier */ for (unsigned i = 0; i < screen->modifier_props[format].drmFormatModifierCount; i++) { if (res->obj->modifier == screen->modifier_props[format].pDrmFormatModifierProperties[i].drmFormatModifier) feats &= screen->modifier_props[format].pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures; } } /* if the format features don't support framebuffer attachment, use VkImageViewUsageCreateInfo to remove it */ if ((res->obj->vkusage & attachment) && !(feats & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) { ivci->pNext = &surface->usage_info; } } static struct zink_surface * create_surface(struct pipe_context *pctx, struct pipe_resource *pres, const struct pipe_surface *templ, VkImageViewCreateInfo *ivci, bool actually) { struct zink_screen *screen = zink_screen(pctx->screen); struct zink_resource *res = zink_resource(pres); struct zink_surface *surface = CALLOC_STRUCT(zink_surface); if (!surface) return NULL; surface->usage_info.sType = VK_STRUCTURE_TYPE_IMAGE_VIEW_USAGE_CREATE_INFO; surface->usage_info.pNext = NULL; apply_view_usage_for_format(screen, res, surface, templ->format, ivci); pipe_resource_reference(&surface->base.texture, pres); pipe_reference_init(&surface->base.reference, 1); init_pipe_surface_info(pctx, &surface->base, templ, pres); surface->obj = zink_resource(pres)->obj; init_surface_info(screen, surface, res, ivci); if (!actually) return surface; assert(ivci->image); VkResult result = VKSCR(CreateImageView)(screen->dev, ivci, NULL, &surface->image_view); if (result != VK_SUCCESS) { mesa_loge("ZINK: vkCreateImageView failed (%s)", vk_Result_to_str(result)); FREE(surface); return NULL; } return surface; } static uint32_t hash_ivci(const void *key) { return _mesa_hash_data((char*)key + offsetof(VkImageViewCreateInfo, flags), sizeof(VkImageViewCreateInfo) - offsetof(VkImageViewCreateInfo, flags)); } static struct zink_surface * do_create_surface(struct pipe_context *pctx, struct pipe_resource *pres, const struct pipe_surface *templ, VkImageViewCreateInfo *ivci, uint32_t hash, bool actually) { /* create a new surface */ struct zink_surface *surface = create_surface(pctx, pres, templ, ivci, actually); /* only transient surfaces have nr_samples set */ surface->base.nr_samples = zink_screen(pctx->screen)->info.have_EXT_multisampled_render_to_single_sampled ? templ->nr_samples : 0; surface->hash = hash; surface->ivci = *ivci; return surface; } /* get a cached surface for a shader descriptor */ struct zink_surface * zink_get_surface(struct zink_context *ctx, struct pipe_resource *pres, const struct pipe_surface *templ, VkImageViewCreateInfo *ivci) { struct zink_surface *surface = NULL; struct zink_resource *res = zink_resource(pres); uint32_t hash = hash_ivci(ivci); simple_mtx_lock(&res->surface_mtx); struct hash_entry *entry = _mesa_hash_table_search_pre_hashed(&res->surface_cache, hash, ivci); if (!entry) { /* create a new surface, but don't actually create the imageview if mutable isn't set and the format is different; * mutable will be set later and the imageview will be filled in */ bool actually = !zink_format_needs_mutable(pres->format, templ->format) || (pres->bind & ZINK_BIND_MUTABLE); surface = do_create_surface(&ctx->base, pres, templ, ivci, hash, actually); entry = _mesa_hash_table_insert_pre_hashed(&res->surface_cache, hash, &surface->ivci, surface); if (!entry) { simple_mtx_unlock(&res->surface_mtx); return NULL; } surface = entry->data; } else { surface = entry->data; p_atomic_inc(&surface->base.reference.count); } simple_mtx_unlock(&res->surface_mtx); return surface; } /* wrap a surface for use as a framebuffer attachment * Takes ownership of surface */ static struct zink_ctx_surface * wrap_surface(struct pipe_context *pctx, struct zink_surface *surface, const struct pipe_surface *templ) { struct zink_ctx_surface *csurf = CALLOC_STRUCT(zink_ctx_surface); if (!csurf) { zink_surface_reference (zink_screen(pctx->screen), &surface, NULL); return NULL; } csurf->base = *templ; pipe_reference_init(&csurf->base.reference, 1); csurf->surf = surface; csurf->base.context = pctx; return csurf; } /* this is the context hook, so only zink_ctx_surfaces will reach it */ static void zink_surface_destroy(struct pipe_context *pctx, struct pipe_surface *psurface) { struct zink_ctx_surface *csurf = (struct zink_ctx_surface *)psurface; if (csurf->needs_mutable) /* this has an extra resource ref */ pipe_resource_reference(&csurf->base.texture, NULL); zink_surface_reference(zink_screen(pctx->screen), &csurf->surf, NULL); pipe_surface_release(pctx, (struct pipe_surface**)&csurf->transient); FREE(csurf); } /* this the context hook that returns a zink_ctx_surface */ static struct pipe_surface * zink_create_surface(struct pipe_context *pctx, struct pipe_resource *pres, const struct pipe_surface *templ) { struct zink_resource *res = zink_resource(pres); struct zink_screen *screen = zink_screen(pctx->screen); bool is_array = templ->u.tex.last_layer != templ->u.tex.first_layer; bool needs_mutable = false; enum pipe_texture_target target_2d[] = {PIPE_TEXTURE_2D, PIPE_TEXTURE_2D_ARRAY}; if (!res->obj->dt && zink_format_needs_mutable(pres->format, templ->format)) { /* mutable not set by default */ needs_mutable = !(res->base.b.bind & ZINK_BIND_MUTABLE); /* VUID-VkImageViewCreateInfo-image-07072 If image was created with the VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT flag and format is a non-compressed format, the levelCount and layerCount members of subresourceRange must both be 1 ...but this is allowed with a maintenance6 property */ if (util_format_is_compressed(pres->format) && templ->u.tex.first_layer != templ->u.tex.last_layer && (!screen->info.have_KHR_maintenance6 || !screen->info.maint6_props.blockTexelViewCompatibleMultipleLayers)) return NULL; } if (!screen->threaded && needs_mutable) { /* this is fine without tc */ needs_mutable = false; zink_resource_object_init_mutable(zink_context(pctx), res); } if (!zink_get_format(screen, templ->format)) return NULL; VkImageViewCreateInfo ivci = create_ivci(screen, res, templ, pres->target == PIPE_TEXTURE_3D ? target_2d[is_array] : pres->target); struct zink_surface *surface = NULL; if (res->obj->dt) { /* don't cache swapchain surfaces. that's weird. */ surface = do_create_surface(pctx, pres, templ, &ivci, 0, false); if (unlikely(!surface)) { mesa_loge("ZINK: failed do_create_surface!"); return NULL; } surface->is_swapchain = true; } else if (!needs_mutable) { surface = zink_get_surface(zink_context(pctx), pres, templ, &ivci); if (unlikely(!surface)) { mesa_loge("ZINK: failed to get non-mutable surface!"); return NULL; } } struct zink_ctx_surface *csurf = wrap_surface(pctx, surface, needs_mutable ? templ : &surface->base); /* move ownership of surface */ if (!unlikely (csurf)) { mesa_loge("ZINK: failed to allocate csurf!"); return NULL; } csurf->needs_mutable = needs_mutable; if (needs_mutable) { pipe_resource_reference(&csurf->base.texture, pres); init_pipe_surface_info(pctx, &csurf->base, templ, pres); } if (templ->nr_samples && !screen->info.have_EXT_multisampled_render_to_single_sampled) { /* transient fb attachment: not cached */ struct pipe_resource rtempl = *pres; rtempl.nr_samples = templ->nr_samples; rtempl.bind |= ZINK_BIND_TRANSIENT; struct zink_resource *transient = zink_resource(pctx->screen->resource_create(pctx->screen, &rtempl)); if (unlikely(!transient)) { mesa_loge("ZINK: failed to create transient resource!"); goto fail; } ivci.image = transient->obj->image; struct zink_surface *tsurf = create_surface(pctx, &transient->base.b, templ, &ivci, true); pipe_resource_reference((struct pipe_resource**)&transient, NULL); if (unlikely(!tsurf)) { mesa_loge("ZINK: failed to create transient surface!"); goto fail; } csurf->transient = wrap_surface(pctx, tsurf, &tsurf->base); /* move ownership of tsurf */ if (unlikely(!csurf->transient)) { mesa_loge("ZINK: failed to wrap transient surface!"); goto fail; } } return &csurf->base; fail: zink_surface_destroy(pctx, &csurf->base); return NULL; } void zink_destroy_surface(struct zink_screen *screen, struct pipe_surface *psurface) { struct zink_surface *surface = zink_surface(psurface); struct zink_resource *res = zink_resource(psurface->texture); if ((!psurface->nr_samples || screen->info.have_EXT_multisampled_render_to_single_sampled) && !surface->is_swapchain) { simple_mtx_lock(&res->surface_mtx); if (psurface->reference.count) { /* a different context got a cache hit during deletion: this surface is alive again */ simple_mtx_unlock(&res->surface_mtx); return; } struct hash_entry *he = _mesa_hash_table_search_pre_hashed(&res->surface_cache, surface->hash, &surface->ivci); assert(he); assert(he->data == surface); _mesa_hash_table_remove(&res->surface_cache, he); simple_mtx_unlock(&res->surface_mtx); } /* this surface is dead now */ simple_mtx_lock(&res->obj->view_lock); /* imageviews are never destroyed directly to ensure lifetimes for in-use surfaces */ if (surface->is_swapchain) { for (unsigned i = 0; i < surface->swapchain_size; i++) util_dynarray_append(&res->obj->views, VkImageView, surface->swapchain[i]); free(surface->swapchain); } else util_dynarray_append(&res->obj->views, VkImageView, surface->image_view); simple_mtx_unlock(&res->obj->view_lock); pipe_resource_reference(&psurface->texture, NULL); FREE(surface); } /* this is called when a surface is rebound for mutable/storage use */ bool zink_rebind_surface(struct zink_context *ctx, struct pipe_surface **psurface) { struct zink_surface *surface = zink_surface(*psurface); struct zink_resource *res = zink_resource((*psurface)->texture); struct zink_screen *screen = zink_screen(ctx->base.screen); if (surface->obj == res->obj) return false; assert(!res->obj->dt); VkImageViewCreateInfo ivci = surface->ivci; ivci.image = res->obj->image; uint32_t hash = hash_ivci(&ivci); simple_mtx_lock(&res->surface_mtx); struct hash_entry *new_entry = _mesa_hash_table_search_pre_hashed(&res->surface_cache, hash, &ivci); if (new_entry) { /* reuse existing surface; old one will be cleaned up naturally */ struct zink_surface *new_surface = new_entry->data; simple_mtx_unlock(&res->surface_mtx); zink_surface_reference(screen, (struct zink_surface**)psurface, new_surface); return true; } struct hash_entry *entry = _mesa_hash_table_search_pre_hashed(&res->surface_cache, surface->hash, &surface->ivci); assert(entry); _mesa_hash_table_remove(&res->surface_cache, entry); VkImageView image_view; apply_view_usage_for_format(screen, res, surface, surface->base.format, &ivci); VkResult result = VKSCR(CreateImageView)(screen->dev, &ivci, NULL, &image_view); if (result != VK_SUCCESS) { mesa_loge("ZINK: failed to create new imageview (%s)", vk_Result_to_str(result)); simple_mtx_unlock(&res->surface_mtx); return false; } surface->hash = hash; surface->ivci = ivci; entry = _mesa_hash_table_insert_pre_hashed(&res->surface_cache, surface->hash, &surface->ivci, surface); assert(entry); simple_mtx_lock(&res->obj->view_lock); util_dynarray_append(&res->obj->views, VkImageView, surface->image_view); simple_mtx_unlock(&res->obj->view_lock); surface->image_view = image_view; surface->obj = zink_resource(surface->base.texture)->obj; /* update for imageless fb */ surface->info.flags = res->obj->vkflags; surface->info.usage = res->obj->vkusage; simple_mtx_unlock(&res->surface_mtx); return true; } /* dummy surfaces are used for null framebuffer/descriptors */ struct pipe_surface * zink_surface_create_null(struct zink_context *ctx, enum pipe_texture_target target, unsigned width, unsigned height, unsigned samples) { struct pipe_surface surf_templ = {0}; struct pipe_resource *pres; struct pipe_resource templ = {0}; templ.width0 = width; templ.height0 = height; templ.depth0 = 1; templ.format = PIPE_FORMAT_R8G8B8A8_UNORM; templ.target = target; templ.bind = PIPE_BIND_RENDER_TARGET | PIPE_BIND_SAMPLER_VIEW; if (samples < 2) templ.bind |= PIPE_BIND_SHADER_IMAGE; templ.nr_samples = samples; pres = ctx->base.screen->resource_create(ctx->base.screen, &templ); if (!pres) return NULL; surf_templ.format = PIPE_FORMAT_R8G8B8A8_UNORM; surf_templ.nr_samples = 0; struct pipe_surface *psurf = ctx->base.create_surface(&ctx->base, pres, &surf_templ); pipe_resource_reference(&pres, NULL); return psurf; } void zink_context_surface_init(struct pipe_context *context) { context->create_surface = zink_create_surface; context->surface_destroy = zink_surface_destroy; } /* must be called before a swapchain image is used to ensure correct imageview is used */ void zink_surface_swapchain_update(struct zink_context *ctx, struct zink_surface *surface) { struct zink_screen *screen = zink_screen(ctx->base.screen); struct zink_resource *res = zink_resource(surface->base.texture); struct kopper_displaytarget *cdt = res->obj->dt; if (!cdt) return; //dead swapchain if (cdt->swapchain != surface->dt_swapchain) { /* new swapchain: clear out previous swapchain imageviews/array and setup a new one; * old views will be pruned normally in zink_batch or on object destruction */ simple_mtx_lock(&res->obj->view_lock); for (unsigned i = 0; i < surface->swapchain_size; i++) util_dynarray_append(&res->obj->views, VkImageView, surface->swapchain[i]); simple_mtx_unlock(&res->obj->view_lock); free(surface->swapchain); surface->swapchain_size = cdt->swapchain->num_images; surface->swapchain = calloc(surface->swapchain_size, sizeof(VkImageView)); if (!surface->swapchain) { mesa_loge("ZINK: failed to allocate surface->swapchain!"); return; } surface->base.width = res->base.b.width0; surface->base.height = res->base.b.height0; init_surface_info(screen, surface, res, &surface->ivci); surface->dt_swapchain = cdt->swapchain; } if (!surface->swapchain[res->obj->dt_idx]) { /* no current swapchain imageview exists: create it */ assert(res->obj->image && cdt->swapchain->images[res->obj->dt_idx].image == res->obj->image); surface->ivci.image = res->obj->image; assert(surface->ivci.image); VKSCR(CreateImageView)(screen->dev, &surface->ivci, NULL, &surface->swapchain[res->obj->dt_idx]); } /* the current swapchain imageview is now the view for the current swapchain image */ surface->image_view = surface->swapchain[res->obj->dt_idx]; }