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