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