src/gallium/drivers/panfrost/pan_resource.c

   1 /**************************************************************************
   2  *
   3  * Copyright 2008 VMware, Inc.
   4  * Copyright 2014 Broadcom
   5  * Copyright 2018 Alyssa Rosenzweig
   6  * All Rights Reserved.
   7  *
   8  * Permission is hereby granted, free of charge, to any person obtaining a
   9  * copy of this software and associated documentation files (the
  10  * "Software"), to deal in the Software without restriction, including
  11  * without limitation the rights to use, copy, modify, merge, publish,
  12  * distribute, sub license, and/or sell copies of the Software, and to
  13  * permit persons to whom the Software is furnished to do so, subject to
  14  * the following conditions:
  15  *
  16  * The above copyright notice and this permission notice (including the
  17  * next paragraph) shall be included in all copies or substantial portions
  18  * of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  21  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  23  * IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS BE LIABLE FOR
  24  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  25  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  26  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  27  *
  28  **************************************************************************/
  29
  30 #include <xf86drm.h>
  31 #include <fcntl.h>
  32 #include "drm-uapi/drm_fourcc.h"
  33
  34 #include "state_tracker/winsys_handle.h"
  35 #include "util/u_format.h"
  36 #include "util/u_memory.h"
  37 #include "util/u_surface.h"
  38 #include "util/u_transfer.h"
  39 #include "util/u_transfer_helper.h"
  40
  41 #include "pan_context.h"
  42 #include "pan_screen.h"
  43 #include "pan_resource.h"
  44 #include "pan_swizzle.h"
  45
  46 static struct pipe_resource *
  47 panfrost_resource_from_handle(struct pipe_screen *pscreen,
  48                               const struct pipe_resource *templat,
  49                               struct winsys_handle *whandle,
  50                               unsigned usage)
  51 {
  52         struct panfrost_screen *screen = pan_screen(pscreen);
  53         struct panfrost_resource *rsc;
  54         struct pipe_resource *prsc;
  55
  56         assert(whandle->type == WINSYS_HANDLE_TYPE_FD);
  57
  58         rsc = CALLOC_STRUCT(panfrost_resource);
  59         if (!rsc)
  60                 return NULL;
  61
  62         prsc = &rsc->base;
  63
  64         *prsc = *templat;
  65
  66         pipe_reference_init(&prsc->reference, 1);
  67         prsc->screen = pscreen;
  68
  69         rsc->bo = screen->driver->import_bo(screen, whandle);
  70
  71         return prsc;
  72 }
  73
  74 static boolean
  75 panfrost_resource_get_handle(struct pipe_screen *pscreen,
  76                              struct pipe_context *ctx,
  77                              struct pipe_resource *pt,
  78                              struct winsys_handle *handle,
  79                              unsigned usage)
  80 {
  81         struct panfrost_screen *screen = pan_screen(pscreen);
  82         struct panfrost_resource *rsrc = (struct panfrost_resource *) pt;
  83         struct renderonly_scanout *scanout = rsrc->scanout;
  84         int bytes_per_pixel = util_format_get_blocksize(rsrc->base.format);
  85         int stride = bytes_per_pixel * rsrc->base.width0; /* TODO: Alignment? */
  86
  87         handle->stride = stride;
  88         handle->modifier = DRM_FORMAT_MOD_INVALID;
  89
  90         if (handle->type == WINSYS_HANDLE_TYPE_SHARED) {
  91                 printf("Missed shared handle\n");
  92                 return FALSE;
  93         } else if (handle->type == WINSYS_HANDLE_TYPE_KMS) {
  94                 if (renderonly_get_handle(scanout, handle)) {
  95                         return TRUE;
  96                 } else {
  97                         printf("Missed nonrenderonly KMS handle for resource %p with scanout %p\n", pt, scanout);
  98                         return FALSE;
  99                 }
 100         } else if (handle->type == WINSYS_HANDLE_TYPE_FD) {
 101                 if (scanout) {
 102                         struct drm_prime_handle args = {
 103                                 .handle = scanout->handle,
 104                                 .flags = DRM_CLOEXEC,
 105                         };
 106
 107                         int ret = drmIoctl(screen->ro->kms_fd, DRM_IOCTL_PRIME_HANDLE_TO_FD, &args);
 108                         if (ret == -1)
 109                                 return FALSE;
 110
 111                         handle->handle = args.fd;
 112
 113                         return TRUE;
 114                 } else {
 115                         printf("Missed nonscanout FD handle\n");
 116                         assert(0);
 117                         return FALSE;
 118                 }
 119         }
 120
 121         return FALSE;
 122 }
 123
 124 static void
 125 panfrost_flush_resource(struct pipe_context *pctx, struct pipe_resource *prsc)
 126 {
 127         //fprintf(stderr, "TODO %s\n", __func__);
 128 }
 129
 130 static void
 131 panfrost_blit(struct pipe_context *pipe,
 132               const struct pipe_blit_info *info)
 133 {
 134         /* STUB */
 135         printf("Skipping blit XXX\n");
 136         return;
 137 }
 138
 139 static struct pipe_surface *
 140 panfrost_create_surface(struct pipe_context *pipe,
 141                         struct pipe_resource *pt,
 142                         const struct pipe_surface *surf_tmpl)
 143 {
 144         struct pipe_surface *ps = NULL;
 145
 146         ps = CALLOC_STRUCT(pipe_surface);
 147
 148         if (ps) {
 149                 pipe_reference_init(&ps->reference, 1);
 150                 pipe_resource_reference(&ps->texture, pt);
 151                 ps->context = pipe;
 152                 ps->format = surf_tmpl->format;
 153
 154                 if (pt->target != PIPE_BUFFER) {
 155                         assert(surf_tmpl->u.tex.level <= pt->last_level);
 156                         ps->width = u_minify(pt->width0, surf_tmpl->u.tex.level);
 157                         ps->height = u_minify(pt->height0, surf_tmpl->u.tex.level);
 158                         ps->u.tex.level = surf_tmpl->u.tex.level;
 159                         ps->u.tex.first_layer = surf_tmpl->u.tex.first_layer;
 160                         ps->u.tex.last_layer = surf_tmpl->u.tex.last_layer;
 161                 } else {
 162                         /* setting width as number of elements should get us correct renderbuffer width */
 163                         ps->width = surf_tmpl->u.buf.last_element - surf_tmpl->u.buf.first_element + 1;
 164                         ps->height = pt->height0;
 165                         ps->u.buf.first_element = surf_tmpl->u.buf.first_element;
 166                         ps->u.buf.last_element = surf_tmpl->u.buf.last_element;
 167                         assert(ps->u.buf.first_element <= ps->u.buf.last_element);
 168                         assert(ps->u.buf.last_element < ps->width);
 169                 }
 170         }
 171
 172         return ps;
 173 }
 174
 175 static void
 176 panfrost_surface_destroy(struct pipe_context *pipe,
 177                          struct pipe_surface *surf)
 178 {
 179         assert(surf->texture);
 180         pipe_resource_reference(&surf->texture, NULL);
 181         free(surf);
 182 }
 183
 184 static struct panfrost_bo *
 185 panfrost_create_bo(struct panfrost_screen *screen, const struct pipe_resource *template)
 186 {
 187         struct panfrost_bo *bo = CALLOC_STRUCT(panfrost_bo);
 188
 189         /* Calculate the size of the bo */
 190
 191         int bytes_per_pixel = util_format_get_blocksize(template->format);
 192         int stride = bytes_per_pixel * template->width0; /* TODO: Alignment? */
 193         size_t sz = stride;
 194
 195         if (template->height0) sz *= template->height0;
 196         if (template->depth0) sz *= template->depth0;
 197
 198         /* Tiling textures is almost always faster, unless we only use it once */
 199         bo->tiled = (template->usage != PIPE_USAGE_STREAM) && (template->bind & PIPE_BIND_SAMPLER_VIEW);
 200
 201         if (bo->tiled) {
 202                 /* For tiled, we don't map directly, so just malloc any old buffer */
 203
 204                 for (int l = 0; l < (template->last_level + 1); ++l) {
 205                         bo->cpu[l] = malloc(sz);
 206                         sz >>= 2;
 207                 }
 208         } else {
 209                 /* But for linear, we can! */
 210
 211                 struct pb_slab_entry *entry = pb_slab_alloc(&screen->slabs, sz, HEAP_TEXTURE);
 212                 struct panfrost_memory_entry *p_entry = (struct panfrost_memory_entry *) entry;
 213                 struct panfrost_memory *backing = (struct panfrost_memory *) entry->slab;
 214                 bo->entry[0] = p_entry;
 215                 bo->cpu[0] = backing->cpu + p_entry->offset;
 216                 bo->gpu[0] = backing->gpu + p_entry->offset;
 217
 218                 /* TODO: Mipmap */
 219         }
 220
 221         return bo;
 222 }
 223
 224 static struct pipe_resource *
 225 panfrost_resource_create(struct pipe_screen *screen,
 226                          const struct pipe_resource *template)
 227 {
 228         struct panfrost_resource *so = CALLOC_STRUCT(panfrost_resource);
 229         struct panfrost_screen *pscreen = (struct panfrost_screen *) screen;
 230
 231         so->base = *template;
 232         so->base.screen = screen;
 233
 234         pipe_reference_init(&so->base.reference, 1);
 235
 236         /* Make sure we're familiar */
 237         switch (template->target) {
 238                 case PIPE_BUFFER:
 239                 case PIPE_TEXTURE_1D:
 240                 case PIPE_TEXTURE_2D:
 241                 case PIPE_TEXTURE_3D:
 242                 case PIPE_TEXTURE_RECT:
 243                         break;
 244                 default:
 245                         fprintf(stderr, "Unknown texture target %d\n", template->target);
 246                         assert(0);
 247         }
 248
 249         if ((template->bind & PIPE_BIND_RENDER_TARGET) || (template->bind & PIPE_BIND_DEPTH_STENCIL)) {
 250                 if (template->bind & PIPE_BIND_DISPLAY_TARGET ||
 251                     template->bind & PIPE_BIND_SCANOUT ||
 252                     template->bind & PIPE_BIND_SHARED) {
 253                         struct pipe_resource scanout_templat = *template;
 254                         struct renderonly_scanout *scanout;
 255                         struct winsys_handle handle;
 256
 257                         /* TODO: align width0 and height0? */
 258
 259                         scanout = renderonly_scanout_for_resource(&scanout_templat,
 260                                                                   pscreen->ro, &handle);
 261                         if (!scanout)
 262                                 return NULL;
 263
 264                         assert(handle.type == WINSYS_HANDLE_TYPE_FD);
 265                         /* TODO: handle modifiers? */
 266                         so = pan_resource(screen->resource_from_handle(screen, template,
 267                                                                          &handle,
 268                                                                          PIPE_HANDLE_USAGE_FRAMEBUFFER_WRITE));
 269                         close(handle.handle);
 270                         if (!so)
 271                                 return NULL;
 272
 273                         so->scanout = scanout;
 274                         pscreen->display_target = so;
 275                 } else {
 276                         so->bo = panfrost_create_bo(pscreen, template);
 277                 }
 278         } else {
 279                 so->bo = panfrost_create_bo(pscreen, template);
 280         }
 281
 282         return (struct pipe_resource *)so;
 283 }
 284
 285 static void
 286 panfrost_destroy_bo(struct panfrost_screen *screen, struct panfrost_bo *pbo)
 287 {
 288         struct panfrost_bo *bo = (struct panfrost_bo *)pbo;
 289
 290         for (int l = 0; l < MAX_MIP_LEVELS; ++l) {
 291                 if (bo->entry[l] != NULL) {
 292                         /* Most allocations have an entry to free */
 293                         bo->entry[l]->freed = true;
 294                         pb_slab_free(&screen->slabs, &bo->entry[l]->base);
 295                 }
 296         }
 297
 298         if (bo->tiled) {
 299                 /* Tiled has a malloc'd CPU, so just plain ol' free needed */
 300
 301                 for (int l = 0; l < MAX_MIP_LEVELS; ++l) {
 302                         free(bo->cpu[l]);
 303                 }
 304         }
 305
 306         if (bo->has_afbc) {
 307                 /* TODO */
 308                 printf("--leaking afbc (%d bytes)--\n", bo->afbc_metadata_size);
 309         }
 310
 311         if (bo->has_checksum) {
 312                 /* TODO */
 313                 printf("--leaking checksum (%zd bytes)--\n", bo->checksum_slab.size);
 314         }
 315 }
 316
 317 static void
 318 panfrost_resource_destroy(struct pipe_screen *screen,
 319                           struct pipe_resource *pt)
 320 {
 321         struct panfrost_screen *pscreen = panfrost_screen(screen);
 322         struct panfrost_resource *rsrc = (struct panfrost_resource *) pt;
 323
 324         if (rsrc->scanout)
 325                 renderonly_scanout_destroy(rsrc->scanout, pscreen->ro);
 326
 327         if (rsrc->bo)
 328                 panfrost_destroy_bo(pscreen, rsrc->bo);
 329
 330         FREE(rsrc);
 331 }
 332
 333 static uint8_t *
 334 panfrost_map_bo(struct panfrost_context *ctx, struct pipe_transfer *transfer)
 335 {
 336         struct panfrost_bo *bo = (struct panfrost_bo *)pan_resource(transfer->resource)->bo;
 337
 338         /* If non-zero level, it's a mipmapped resource and needs to be treated as such */
 339         bo->is_mipmap |= transfer->level;
 340
 341         if (transfer->usage & PIPE_TRANSFER_MAP_DIRECTLY && bo->tiled) {
 342                 /* We cannot directly map tiled textures */
 343                 return NULL;
 344         }
 345
 346         if (transfer->resource->bind & PIPE_BIND_DEPTH_STENCIL) {
 347                 /* Mipmapped readpixels?! */
 348                 assert(transfer->level == 0);
 349
 350                 /* Set the CPU mapping to that of the depth/stencil buffer in memory, untiled */
 351                 bo->cpu[transfer->level] = ctx->depth_stencil_buffer.cpu;
 352         }
 353
 354         return bo->cpu[transfer->level];
 355 }
 356
 357 static void *
 358 panfrost_transfer_map(struct pipe_context *pctx,
 359                       struct pipe_resource *resource,
 360                       unsigned level,
 361                       unsigned usage,  /* a combination of PIPE_TRANSFER_x */
 362                       const struct pipe_box *box,
 363                       struct pipe_transfer **out_transfer)
 364 {
 365         struct panfrost_context *ctx = pan_context(pctx);
 366         int bytes_per_pixel = util_format_get_blocksize(resource->format);
 367         int stride = bytes_per_pixel * resource->width0; /* TODO: Alignment? */
 368         uint8_t *cpu;
 369
 370         struct pipe_transfer *transfer = CALLOC_STRUCT(pipe_transfer);
 371         transfer->level = level;
 372         transfer->usage = usage;
 373         transfer->box = *box;
 374         transfer->stride = stride;
 375         assert(!transfer->box.z);
 376
 377         pipe_resource_reference(&transfer->resource, resource);
 378
 379         *out_transfer = transfer;
 380
 381         if (resource->bind & PIPE_BIND_DISPLAY_TARGET ||
 382             resource->bind & PIPE_BIND_SCANOUT ||
 383             resource->bind & PIPE_BIND_SHARED) {
 384                 /* Mipmapped readpixels?! */
 385                 assert(level == 0);
 386
 387                 /* Force a flush -- kill the pipeline */
 388                 panfrost_flush(pctx, NULL, PIPE_FLUSH_END_OF_FRAME);
 389         }
 390
 391         cpu = panfrost_map_bo(ctx, transfer);
 392         if (cpu == NULL)
 393                 return NULL;
 394
 395         return cpu + transfer->box.x * bytes_per_pixel + transfer->box.y * stride;
 396 }
 397
 398 static void
 399 panfrost_tile_texture(struct panfrost_screen *screen, struct panfrost_resource *rsrc, int level)
 400 {
 401         struct panfrost_bo *bo = (struct panfrost_bo *)rsrc->bo;
 402         int bytes_per_pixel = util_format_get_blocksize(rsrc->base.format);
 403         int stride = bytes_per_pixel * rsrc->base.width0; /* TODO: Alignment? */
 404
 405         int width = rsrc->base.width0 >> level;
 406         int height = rsrc->base.height0 >> level;
 407
 408         /* Estimate swizzled bitmap size. Slight overestimates are fine.
 409          * Underestimates will result in memory corruption or worse. */
 410
 411         int swizzled_sz = panfrost_swizzled_size(width, height, bytes_per_pixel);
 412
 413         /* Allocate the transfer given that known size but do not copy */
 414         struct pb_slab_entry *entry = pb_slab_alloc(&screen->slabs, swizzled_sz, HEAP_TEXTURE);
 415         struct panfrost_memory_entry *p_entry = (struct panfrost_memory_entry *) entry;
 416         struct panfrost_memory *backing = (struct panfrost_memory *) entry->slab;
 417         uint8_t *swizzled = backing->cpu + p_entry->offset;
 418
 419         /* Save the entry. But if there was already an entry here (from a
 420          * previous upload of the resource), free that one so we don't leak */
 421
 422         if (bo->entry[level] != NULL) {
 423                 bo->entry[level]->freed = true;
 424                 pb_slab_free(&screen->slabs, &bo->entry[level]->base);
 425         }
 426
 427         bo->entry[level] = p_entry;
 428         bo->gpu[level] = backing->gpu + p_entry->offset;
 429
 430         /* Run actual texture swizzle, writing directly to the mapped
 431          * GPU chunk we allocated */
 432
 433         panfrost_texture_swizzle(width, height, bytes_per_pixel, stride, bo->cpu[level], swizzled);
 434 }
 435
 436 static void
 437 panfrost_unmap_bo(struct panfrost_context *ctx,
 438                          struct pipe_transfer *transfer)
 439 {
 440         struct panfrost_bo *bo = (struct panfrost_bo *)pan_resource(transfer->resource)->bo;
 441
 442         if (transfer->usage & PIPE_TRANSFER_WRITE) {
 443                 if (transfer->resource->target == PIPE_TEXTURE_2D) {
 444                         struct panfrost_resource *prsrc = (struct panfrost_resource *) transfer->resource;
 445
 446                         /* Gallium thinks writeback happens here; instead, this is our cue to tile */
 447                         if (bo->has_afbc) {
 448                                 printf("Warning: writes to afbc surface can't possibly work out well for you...\n");
 449                         } else if (bo->tiled) {
 450                                 struct pipe_context *gallium = (struct pipe_context *) ctx;
 451                                 struct panfrost_screen *screen = pan_screen(gallium->screen);
 452                                 panfrost_tile_texture(screen, prsrc, transfer->level);
 453                         }
 454                 }
 455         }
 456 }
 457
 458 static void
 459 panfrost_transfer_unmap(struct pipe_context *pctx,
 460                         struct pipe_transfer *transfer)
 461 {
 462         struct panfrost_context *ctx = pan_context(pctx);
 463
 464         panfrost_unmap_bo(ctx, transfer);
 465
 466         /* Derefence the resource */
 467         pipe_resource_reference(&transfer->resource, NULL);
 468
 469         /* Transfer itself is CALLOCed at the moment */
 470         free(transfer);
 471 }
 472
 473 static struct pb_slab *
 474 panfrost_slab_alloc(void *priv, unsigned heap, unsigned entry_size, unsigned group_index)
 475 {
 476         struct panfrost_screen *screen = (struct panfrost_screen *) priv;
 477         struct panfrost_memory *mem = CALLOC_STRUCT(panfrost_memory);
 478
 479         size_t slab_size = (1 << (MAX_SLAB_ENTRY_SIZE + 1));
 480
 481         mem->slab.num_entries = slab_size / entry_size;
 482         mem->slab.num_free = mem->slab.num_entries;
 483
 484         LIST_INITHEAD(&mem->slab.free);
 485         for (unsigned i = 0; i < mem->slab.num_entries; ++i) {
 486                 /* Create a slab entry */
 487                 struct panfrost_memory_entry *entry = CALLOC_STRUCT(panfrost_memory_entry);
 488                 entry->offset = entry_size * i;
 489
 490                 entry->base.slab = &mem->slab;
 491                 entry->base.group_index = group_index;
 492
 493                 LIST_ADDTAIL(&entry->base.head, &mem->slab.free);
 494         }
 495
 496         /* Actually allocate the memory from kernel-space. Mapped, same_va, no
 497          * special flags */
 498
 499         screen->driver->allocate_slab(screen, mem, slab_size / 4096, true, 0, 0, 0);
 500
 501         return &mem->slab;
 502 }
 503
 504 static bool
 505 panfrost_slab_can_reclaim(void *priv, struct pb_slab_entry *entry)
 506 {
 507         struct panfrost_memory_entry *p_entry = (struct panfrost_memory_entry *) entry;
 508         return p_entry->freed;
 509 }
 510
 511 static void
 512 panfrost_slab_free(void *priv, struct pb_slab *slab)
 513 {
 514         struct panfrost_memory *mem = (struct panfrost_memory *) slab;
 515         struct panfrost_screen *screen = (struct panfrost_screen *) priv;
 516
 517         screen->driver->free_slab(screen, mem);
 518 }
 519
 520 static void
 521 panfrost_invalidate_resource(struct pipe_context *pctx, struct pipe_resource *prsc)
 522 {
 523         //fprintf(stderr, "TODO %s\n", __func__);
 524 }
 525
 526 static const struct u_transfer_vtbl transfer_vtbl = {
 527         .resource_create          = panfrost_resource_create,
 528         .resource_destroy         = panfrost_resource_destroy,
 529         .transfer_map             = panfrost_transfer_map,
 530         .transfer_unmap           = panfrost_transfer_unmap,
 531         .transfer_flush_region    = u_default_transfer_flush_region,
 532         //.get_internal_format      = panfrost_resource_get_internal_format,
 533         //.set_stencil              = panfrost_resource_set_stencil,
 534         //.get_stencil              = panfrost_resource_get_stencil,
 535 };
 536
 537 void
 538 panfrost_resource_screen_init(struct panfrost_screen *pscreen)
 539 {
 540         //pscreen->base.resource_create_with_modifiers =
 541         //        panfrost_resource_create_with_modifiers;
 542         pscreen->base.resource_create = u_transfer_helper_resource_create;
 543         pscreen->base.resource_destroy = u_transfer_helper_resource_destroy;
 544         pscreen->base.resource_from_handle = panfrost_resource_from_handle;
 545         pscreen->base.resource_get_handle = panfrost_resource_get_handle;
 546         pscreen->base.transfer_helper = u_transfer_helper_create(&transfer_vtbl,
 547                                                             true, true,
 548                                                             true, true);
 549
 550         pb_slabs_init(&pscreen->slabs,
 551                         MIN_SLAB_ENTRY_SIZE,
 552                         MAX_SLAB_ENTRY_SIZE,
 553
 554                         3, /* Number of heaps */
 555
 556                         pscreen,
 557
 558                         panfrost_slab_can_reclaim,
 559                         panfrost_slab_alloc,
 560                         panfrost_slab_free);
 561 }
 562
 563 void
 564 panfrost_resource_context_init(struct pipe_context *pctx)
 565 {
 566         pctx->transfer_map = u_transfer_helper_transfer_map;
 567         pctx->transfer_flush_region = u_transfer_helper_transfer_flush_region;
 568         pctx->transfer_unmap = u_transfer_helper_transfer_unmap;
 569         pctx->buffer_subdata = u_default_buffer_subdata;
 570         pctx->create_surface = panfrost_create_surface;
 571         pctx->surface_destroy = panfrost_surface_destroy;
 572         pctx->resource_copy_region = util_resource_copy_region;
 573         pctx->blit = panfrost_blit;
 574         //pctx->generate_mipmap = panfrost_generate_mipmap;
 575         pctx->flush_resource = panfrost_flush_resource;
 576         pctx->invalidate_resource = panfrost_invalidate_resource;
 577         pctx->transfer_flush_region = u_transfer_helper_transfer_flush_region;
 578         pctx->buffer_subdata = u_default_buffer_subdata;
 579         pctx->texture_subdata = u_default_texture_subdata;
 580 }