util: Move gallium's PIPE_FORMAT utils to /util/format/
[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/format/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 = VK_BUFFER_USAGE_TRANSFER_SRC_BIT |
108 VK_BUFFER_USAGE_TRANSFER_DST_BIT;
109
110 if (templ->bind & PIPE_BIND_VERTEX_BUFFER)
111 bci.usage |= VK_BUFFER_USAGE_VERTEX_BUFFER_BIT;
112
113 if (templ->bind & PIPE_BIND_INDEX_BUFFER)
114 bci.usage |= VK_BUFFER_USAGE_INDEX_BUFFER_BIT;
115
116 if (templ->bind & PIPE_BIND_CONSTANT_BUFFER)
117 bci.usage |= VK_BUFFER_USAGE_UNIFORM_BUFFER_BIT;
118
119 if (templ->bind & PIPE_BIND_SHADER_BUFFER)
120 bci.usage |= VK_BUFFER_USAGE_STORAGE_BUFFER_BIT;
121
122 if (templ->bind & PIPE_BIND_COMMAND_ARGS_BUFFER)
123 bci.usage |= VK_BUFFER_USAGE_INDIRECT_BUFFER_BIT;
124
125 if (vkCreateBuffer(screen->dev, &bci, NULL, &res->buffer) !=
126 VK_SUCCESS) {
127 FREE(res);
128 return NULL;
129 }
130
131 vkGetBufferMemoryRequirements(screen->dev, res->buffer, &reqs);
132 flags |= VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT;
133 } else {
134 res->format = zink_get_format(screen, templ->format);
135
136 VkImageCreateInfo ici = {};
137 ici.sType = VK_STRUCTURE_TYPE_IMAGE_CREATE_INFO;
138 ici.flags = VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT;
139
140 switch (templ->target) {
141 case PIPE_TEXTURE_1D:
142 case PIPE_TEXTURE_1D_ARRAY:
143 ici.imageType = VK_IMAGE_TYPE_1D;
144 break;
145
146 case PIPE_TEXTURE_CUBE:
147 case PIPE_TEXTURE_CUBE_ARRAY:
148 ici.flags |= VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT;
149 /* fall-through */
150 case PIPE_TEXTURE_2D:
151 case PIPE_TEXTURE_2D_ARRAY:
152 case PIPE_TEXTURE_RECT:
153 ici.imageType = VK_IMAGE_TYPE_2D;
154 break;
155
156 case PIPE_TEXTURE_3D:
157 ici.imageType = VK_IMAGE_TYPE_3D;
158 if (templ->bind & PIPE_BIND_RENDER_TARGET)
159 ici.flags |= VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT;
160 break;
161
162 case PIPE_BUFFER:
163 unreachable("PIPE_BUFFER should already be handled");
164
165 default:
166 unreachable("Unknown target");
167 }
168
169 ici.format = res->format;
170 ici.extent.width = templ->width0;
171 ici.extent.height = templ->height0;
172 ici.extent.depth = templ->depth0;
173 ici.mipLevels = templ->last_level + 1;
174 ici.arrayLayers = templ->array_size;
175 ici.samples = templ->nr_samples ? templ->nr_samples : VK_SAMPLE_COUNT_1_BIT;
176 ici.tiling = templ->bind & PIPE_BIND_LINEAR ? VK_IMAGE_TILING_LINEAR : VK_IMAGE_TILING_OPTIMAL;
177
178 if (templ->target == PIPE_TEXTURE_CUBE ||
179 templ->target == PIPE_TEXTURE_CUBE_ARRAY)
180 ici.arrayLayers *= 6;
181
182 if (templ->bind & (PIPE_BIND_DISPLAY_TARGET |
183 PIPE_BIND_SCANOUT |
184 PIPE_BIND_SHARED)) {
185 // assert(ici.tiling == VK_IMAGE_TILING_LINEAR);
186 ici.tiling = VK_IMAGE_TILING_LINEAR;
187 }
188
189 if (templ->usage == PIPE_USAGE_STAGING)
190 ici.tiling = VK_IMAGE_TILING_LINEAR;
191
192 /* sadly, gallium doesn't let us know if it'll ever need this, so we have to assume */
193 ici.usage = VK_IMAGE_USAGE_TRANSFER_SRC_BIT |
194 VK_IMAGE_USAGE_TRANSFER_DST_BIT |
195 VK_IMAGE_USAGE_SAMPLED_BIT;
196
197 if (templ->bind & PIPE_BIND_SHADER_IMAGE)
198 ici.usage |= VK_IMAGE_USAGE_STORAGE_BIT;
199
200 if (templ->bind & PIPE_BIND_RENDER_TARGET)
201 ici.usage |= VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT;
202
203 if (templ->bind & PIPE_BIND_DEPTH_STENCIL)
204 ici.usage |= VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT;
205
206 if (templ->flags & PIPE_RESOURCE_FLAG_SPARSE)
207 ici.usage |= VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT;
208
209 if (templ->bind & PIPE_BIND_STREAM_OUTPUT)
210 ici.usage |= VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
211
212 ici.sharingMode = VK_SHARING_MODE_EXCLUSIVE;
213 ici.initialLayout = VK_IMAGE_LAYOUT_UNDEFINED;
214 res->layout = VK_IMAGE_LAYOUT_UNDEFINED;
215
216 VkResult result = vkCreateImage(screen->dev, &ici, NULL, &res->image);
217 if (result != VK_SUCCESS) {
218 FREE(res);
219 return NULL;
220 }
221
222 res->optimial_tiling = ici.tiling != VK_IMAGE_TILING_LINEAR;
223 res->aspect = aspect_from_format(templ->format);
224
225 vkGetImageMemoryRequirements(screen->dev, res->image, &reqs);
226 if (templ->usage == PIPE_USAGE_STAGING || (screen->winsys && (templ->bind & (PIPE_BIND_SCANOUT|PIPE_BIND_DISPLAY_TARGET|PIPE_BIND_SHARED))))
227 flags |= VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT;
228 else
229 flags |= VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT;
230 }
231
232 VkMemoryAllocateInfo mai = {};
233 mai.sType = VK_STRUCTURE_TYPE_MEMORY_ALLOCATE_INFO;
234 mai.allocationSize = reqs.size;
235 mai.memoryTypeIndex = get_memory_type_index(screen, &reqs, flags);
236
237 VkExportMemoryAllocateInfo emai = {};
238 if (templ->bind & PIPE_BIND_SHARED) {
239 emai.sType = VK_STRUCTURE_TYPE_EXPORT_MEMORY_ALLOCATE_INFO;
240 emai.handleTypes = VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_FD_BIT;
241 mai.pNext = &emai;
242 }
243
244 VkImportMemoryFdInfoKHR imfi = {
245 VK_STRUCTURE_TYPE_IMPORT_MEMORY_FD_INFO_KHR,
246 NULL,
247 };
248
249 if (whandle && whandle->type == WINSYS_HANDLE_TYPE_FD) {
250 imfi.sType = VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_FD_BIT;
251 imfi.pNext = NULL;
252 imfi.handleType = VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_FD_BIT;
253 imfi.fd = whandle->handle;
254
255 emai.pNext = &imfi;
256 }
257
258 if (vkAllocateMemory(screen->dev, &mai, NULL, &res->mem) != VK_SUCCESS)
259 goto fail;
260
261 res->offset = 0;
262 res->size = reqs.size;
263
264 if (templ->target == PIPE_BUFFER)
265 vkBindBufferMemory(screen->dev, res->buffer, res->mem, res->offset);
266 else
267 vkBindImageMemory(screen->dev, res->image, res->mem, res->offset);
268
269 if (screen->winsys && (templ->bind & (PIPE_BIND_DISPLAY_TARGET |
270 PIPE_BIND_SCANOUT |
271 PIPE_BIND_SHARED))) {
272 struct sw_winsys *winsys = screen->winsys;
273 res->dt = winsys->displaytarget_create(screen->winsys,
274 res->base.bind,
275 res->base.format,
276 templ->width0,
277 templ->height0,
278 64, NULL,
279 &res->dt_stride);
280 }
281
282 return &res->base;
283
284 fail:
285 if (templ->target == PIPE_BUFFER)
286 vkDestroyBuffer(screen->dev, res->buffer, NULL);
287 else
288 vkDestroyImage(screen->dev, res->image, NULL);
289
290 FREE(res);
291
292 return NULL;
293 }
294
295 static struct pipe_resource *
296 zink_resource_create(struct pipe_screen *pscreen,
297 const struct pipe_resource *templ)
298 {
299 return resource_create(pscreen, templ, NULL, 0);
300 }
301
302 static bool
303 zink_resource_get_handle(struct pipe_screen *pscreen,
304 struct pipe_context *context,
305 struct pipe_resource *tex,
306 struct winsys_handle *whandle,
307 unsigned usage)
308 {
309 struct zink_resource *res = zink_resource(tex);
310 struct zink_screen *screen = zink_screen(pscreen);
311 VkMemoryGetFdInfoKHR fd_info = {};
312 int fd;
313
314 if (res->base.target != PIPE_BUFFER) {
315 VkImageSubresource sub_res = {};
316 VkSubresourceLayout sub_res_layout = {};
317
318 sub_res.aspectMask = res->aspect;
319
320 vkGetImageSubresourceLayout(screen->dev, res->image, &sub_res, &sub_res_layout);
321
322 whandle->stride = sub_res_layout.rowPitch;
323 }
324
325 if (whandle->type == WINSYS_HANDLE_TYPE_FD) {
326
327 if (!screen->vk_GetMemoryFdKHR)
328 screen->vk_GetMemoryFdKHR = (PFN_vkGetMemoryFdKHR)vkGetDeviceProcAddr(screen->dev, "vkGetMemoryFdKHR");
329 if (!screen->vk_GetMemoryFdKHR)
330 return false;
331 fd_info.sType = VK_STRUCTURE_TYPE_MEMORY_GET_FD_INFO_KHR;
332 fd_info.memory = res->mem;
333 fd_info.handleType = VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_FD_BIT;
334 VkResult result = (*screen->vk_GetMemoryFdKHR)(screen->dev, &fd_info, &fd);
335 if (result != VK_SUCCESS)
336 return false;
337 whandle->handle = fd;
338 }
339 return true;
340 }
341
342 static struct pipe_resource *
343 zink_resource_from_handle(struct pipe_screen *pscreen,
344 const struct pipe_resource *templ,
345 struct winsys_handle *whandle,
346 unsigned usage)
347 {
348 return resource_create(pscreen, templ, whandle, usage);
349 }
350
351 void
352 zink_screen_resource_init(struct pipe_screen *pscreen)
353 {
354 pscreen->resource_create = zink_resource_create;
355 pscreen->resource_destroy = zink_resource_destroy;
356
357 if (zink_screen(pscreen)->have_KHR_external_memory_fd) {
358 pscreen->resource_get_handle = zink_resource_get_handle;
359 pscreen->resource_from_handle = zink_resource_from_handle;
360 }
361 }
362
363 static bool
364 zink_transfer_copy_bufimage(struct zink_context *ctx,
365 struct zink_resource *res,
366 struct zink_resource *staging_res,
367 struct zink_transfer *trans,
368 bool buf2img)
369 {
370 struct zink_batch *batch = zink_batch_no_rp(ctx);
371
372 if (buf2img) {
373 if (res->layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
374 zink_resource_barrier(batch->cmdbuf, res, res->aspect,
375 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL);
376 }
377 } else {
378 if (res->layout != VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL) {
379 zink_resource_barrier(batch->cmdbuf, res, res->aspect,
380 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL);
381 }
382 }
383
384 VkBufferImageCopy copyRegion = {};
385 copyRegion.bufferOffset = staging_res->offset;
386 copyRegion.bufferRowLength = 0;
387 copyRegion.bufferImageHeight = 0;
388 copyRegion.imageSubresource.mipLevel = trans->base.level;
389 copyRegion.imageSubresource.layerCount = 1;
390 if (res->base.array_size > 1) {
391 copyRegion.imageSubresource.baseArrayLayer = trans->base.box.z;
392 copyRegion.imageSubresource.layerCount = trans->base.box.depth;
393 copyRegion.imageExtent.depth = 1;
394 } else {
395 copyRegion.imageOffset.z = trans->base.box.z;
396 copyRegion.imageExtent.depth = trans->base.box.depth;
397 }
398 copyRegion.imageOffset.x = trans->base.box.x;
399 copyRegion.imageOffset.y = trans->base.box.y;
400
401 copyRegion.imageExtent.width = trans->base.box.width;
402 copyRegion.imageExtent.height = trans->base.box.height;
403
404 zink_batch_reference_resoure(batch, res);
405 zink_batch_reference_resoure(batch, staging_res);
406
407 unsigned aspects = res->aspect;
408 while (aspects) {
409 int aspect = 1 << u_bit_scan(&aspects);
410 copyRegion.imageSubresource.aspectMask = aspect;
411
412 if (buf2img)
413 vkCmdCopyBufferToImage(batch->cmdbuf, staging_res->buffer, res->image, res->layout, 1, &copyRegion);
414 else
415 vkCmdCopyImageToBuffer(batch->cmdbuf, res->image, res->layout, staging_res->buffer, 1, &copyRegion);
416 }
417
418 return true;
419 }
420
421 static void *
422 zink_transfer_map(struct pipe_context *pctx,
423 struct pipe_resource *pres,
424 unsigned level,
425 unsigned usage,
426 const struct pipe_box *box,
427 struct pipe_transfer **transfer)
428 {
429 struct zink_context *ctx = zink_context(pctx);
430 struct zink_screen *screen = zink_screen(pctx->screen);
431 struct zink_resource *res = zink_resource(pres);
432
433 struct zink_transfer *trans = slab_alloc(&ctx->transfer_pool);
434 if (!trans)
435 return NULL;
436
437 memset(trans, 0, sizeof(*trans));
438 pipe_resource_reference(&trans->base.resource, pres);
439
440 trans->base.resource = pres;
441 trans->base.level = level;
442 trans->base.usage = usage;
443 trans->base.box = *box;
444
445 void *ptr;
446 if (pres->target == PIPE_BUFFER) {
447 VkResult result = vkMapMemory(screen->dev, res->mem, res->offset, res->size, 0, &ptr);
448 if (result != VK_SUCCESS)
449 return NULL;
450
451 trans->base.stride = 0;
452 trans->base.layer_stride = 0;
453 ptr = ((uint8_t *)ptr) + box->x;
454 } else {
455 if (res->optimial_tiling || ((res->base.usage != PIPE_USAGE_STAGING))) {
456 trans->base.stride = util_format_get_stride(pres->format, box->width);
457 trans->base.layer_stride = util_format_get_2d_size(pres->format,
458 trans->base.stride,
459 box->height);
460
461 struct pipe_resource templ = *pres;
462 templ.usage = PIPE_USAGE_STAGING;
463 templ.target = PIPE_BUFFER;
464 templ.bind = 0;
465 templ.width0 = trans->base.layer_stride * box->depth;
466 templ.height0 = templ.depth0 = 0;
467 templ.last_level = 0;
468 templ.array_size = 1;
469 templ.flags = 0;
470
471 trans->staging_res = zink_resource_create(pctx->screen, &templ);
472 if (!trans->staging_res)
473 return NULL;
474
475 struct zink_resource *staging_res = zink_resource(trans->staging_res);
476
477 if (usage & PIPE_TRANSFER_READ) {
478 struct zink_context *ctx = zink_context(pctx);
479 bool ret = zink_transfer_copy_bufimage(ctx, res,
480 staging_res, trans,
481 false);
482 if (ret == false)
483 return NULL;
484
485 /* need to wait for rendering to finish */
486 struct pipe_fence_handle *fence = NULL;
487 pctx->flush(pctx, &fence, PIPE_FLUSH_HINT_FINISH);
488 if (fence) {
489 pctx->screen->fence_finish(pctx->screen, NULL, fence,
490 PIPE_TIMEOUT_INFINITE);
491 pctx->screen->fence_reference(pctx->screen, &fence, NULL);
492 }
493 }
494
495 VkResult result = vkMapMemory(screen->dev, staging_res->mem,
496 staging_res->offset,
497 staging_res->size, 0, &ptr);
498 if (result != VK_SUCCESS)
499 return NULL;
500
501 } else {
502 assert(!res->optimial_tiling);
503 VkResult result = vkMapMemory(screen->dev, res->mem, res->offset, res->size, 0, &ptr);
504 if (result != VK_SUCCESS)
505 return NULL;
506 VkImageSubresource isr = {
507 res->aspect,
508 level,
509 0
510 };
511 VkSubresourceLayout srl;
512 vkGetImageSubresourceLayout(screen->dev, res->image, &isr, &srl);
513 trans->base.stride = srl.rowPitch;
514 trans->base.layer_stride = srl.arrayPitch;
515 ptr = ((uint8_t *)ptr) + box->z * srl.depthPitch +
516 box->y * srl.rowPitch +
517 box->x;
518 }
519 }
520
521 *transfer = &trans->base;
522 return ptr;
523 }
524
525 static void
526 zink_transfer_unmap(struct pipe_context *pctx,
527 struct pipe_transfer *ptrans)
528 {
529 struct zink_context *ctx = zink_context(pctx);
530 struct zink_screen *screen = zink_screen(pctx->screen);
531 struct zink_resource *res = zink_resource(ptrans->resource);
532 struct zink_transfer *trans = (struct zink_transfer *)ptrans;
533 if (trans->staging_res) {
534 struct zink_resource *staging_res = zink_resource(trans->staging_res);
535 vkUnmapMemory(screen->dev, staging_res->mem);
536
537 if (trans->base.usage & PIPE_TRANSFER_WRITE) {
538 struct zink_context *ctx = zink_context(pctx);
539
540 zink_transfer_copy_bufimage(ctx, res, staging_res, trans, true);
541 }
542
543 pipe_resource_reference(&trans->staging_res, NULL);
544 } else
545 vkUnmapMemory(screen->dev, res->mem);
546
547 pipe_resource_reference(&trans->base.resource, NULL);
548 slab_free(&ctx->transfer_pool, ptrans);
549 }
550
551 void
552 zink_context_resource_init(struct pipe_context *pctx)
553 {
554 pctx->transfer_map = zink_transfer_map;
555 pctx->transfer_unmap = zink_transfer_unmap;
556
557 pctx->transfer_flush_region = u_default_transfer_flush_region;
558 pctx->buffer_subdata = u_default_buffer_subdata;
559 pctx->texture_subdata = u_default_texture_subdata;
560 }