src/gallium/drivers/virgl/virgl_texture.c

   1 /*
   2  * Copyright 2014, 2015 Red Hat.
   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 #include "util/u_format.h"
  24 #include "util/u_inlines.h"
  25 #include "util/u_memory.h"
  26
  27 #include "virgl_context.h"
  28 #include "virgl_encode.h"
  29 #include "virgl_resource.h"
  30 #include "virgl_screen.h"
  31
  32 static void virgl_copy_region_with_blit(struct pipe_context *pipe,
  33                                         struct pipe_resource *dst,
  34                                         unsigned dst_level,
  35                                         const struct pipe_box *dst_box,
  36                                         struct pipe_resource *src,
  37                                         unsigned src_level,
  38                                         const struct pipe_box *src_box)
  39 {
  40    struct pipe_blit_info blit;
  41
  42    memset(&blit, 0, sizeof(blit));
  43    blit.src.resource = src;
  44    blit.src.format = src->format;
  45    blit.src.level = src_level;
  46    blit.src.box = *src_box;
  47    blit.dst.resource = dst;
  48    blit.dst.format = dst->format;
  49    blit.dst.level = dst_level;
  50    blit.dst.box.x = dst_box->x;
  51    blit.dst.box.y = dst_box->y;
  52    blit.dst.box.z = dst_box->z;
  53    blit.dst.box.width = dst_box->width;
  54    blit.dst.box.height = dst_box->height;
  55    blit.dst.box.depth = dst_box->depth;
  56    blit.mask = util_format_get_mask(src->format) &
  57       util_format_get_mask(dst->format);
  58    blit.filter = PIPE_TEX_FILTER_NEAREST;
  59
  60    if (blit.mask) {
  61       pipe->blit(pipe, &blit);
  62    }
  63 }
  64
  65 static unsigned temp_bind(unsigned orig)
  66 {
  67    unsigned warn = ~(PIPE_BIND_RENDER_TARGET | PIPE_BIND_DEPTH_STENCIL |
  68                      PIPE_BIND_SAMPLER_VIEW | PIPE_BIND_DISPLAY_TARGET);
  69    if (orig & warn)
  70       debug_printf("VIRGL: Warning, possibly unhandled bind: %x\n",
  71                    orig & warn);
  72
  73    return orig & (PIPE_BIND_DEPTH_STENCIL | PIPE_BIND_RENDER_TARGET);
  74 }
  75
  76 static void virgl_init_temp_resource_from_box(struct pipe_resource *res,
  77                                               struct pipe_resource *orig,
  78                                               const struct pipe_box *box,
  79                                               unsigned level, unsigned flags,
  80                                               enum pipe_format fmt)
  81 {
  82    memset(res, 0, sizeof(*res));
  83    res->bind = temp_bind(orig->bind);
  84    res->format = fmt;
  85    res->width0 = box->width;
  86    res->height0 = box->height;
  87    res->depth0 = 1;
  88    res->array_size = 1;
  89    res->usage = PIPE_USAGE_STAGING;
  90    res->flags = flags;
  91
  92    /* We must set the correct texture target and dimensions for a 3D box. */
  93    if (box->depth > 1 && util_max_layer(orig, level) > 0)
  94       res->target = orig->target;
  95    else
  96       res->target = PIPE_TEXTURE_2D;
  97
  98    if (res->target != PIPE_BUFFER)
  99       res->bind = PIPE_BIND_RENDER_TARGET;
 100
 101    switch (res->target) {
 102    case PIPE_TEXTURE_1D_ARRAY:
 103    case PIPE_TEXTURE_2D_ARRAY:
 104    case PIPE_TEXTURE_CUBE_ARRAY:
 105       res->array_size = box->depth;
 106       break;
 107    case PIPE_TEXTURE_3D:
 108       res->depth0 = box->depth;
 109       break;
 110    default:
 111       break;
 112    }
 113 }
 114
 115 static void *texture_transfer_map_plain(struct pipe_context *ctx,
 116                                         struct pipe_resource *resource,
 117                                         unsigned level,
 118                                         unsigned usage,
 119                                         const struct pipe_box *box,
 120                                         struct pipe_transfer **transfer)
 121 {
 122    struct virgl_context *vctx = virgl_context(ctx);
 123    struct virgl_winsys *vws = virgl_screen(ctx->screen)->vws;
 124    struct virgl_resource *vtex = virgl_resource(resource);
 125    struct virgl_transfer *trans;
 126    enum virgl_transfer_map_type map_type;
 127    void *map_addr;
 128
 129    trans = virgl_resource_create_transfer(vctx, resource,
 130                                           &vtex->metadata, level, usage, box);
 131    trans->resolve_transfer = NULL;
 132
 133    assert(resource->nr_samples <= 1);
 134
 135    map_type = virgl_resource_transfer_prepare(vctx, trans);
 136    switch (map_type) {
 137    case VIRGL_TRANSFER_MAP_REALLOC:
 138       if (!virgl_resource_realloc(vctx, vtex)) {
 139          map_addr = NULL;
 140          break;
 141       }
 142       vws->resource_reference(vws, &trans->hw_res, vtex->hw_res);
 143       /* fall through */
 144    case VIRGL_TRANSFER_MAP_HW_RES:
 145       trans->hw_res_map = vws->resource_map(vws, vtex->hw_res);
 146       if (trans->hw_res_map)
 147          map_addr = trans->hw_res_map + trans->offset;
 148       else
 149          map_addr = NULL;
 150       break;
 151    case VIRGL_TRANSFER_MAP_STAGING:
 152       map_addr = virgl_staging_map(vctx, trans);
 153       /* Copy transfers don't make use of hw_res_map at the moment. */
 154       trans->hw_res_map = NULL;
 155       break;
 156    case VIRGL_TRANSFER_MAP_ERROR:
 157    default:
 158       trans->hw_res_map = NULL;
 159       map_addr = NULL;
 160       break;
 161    }
 162
 163    if (!map_addr) {
 164       virgl_resource_destroy_transfer(vctx, trans);
 165       return NULL;
 166    }
 167
 168    *transfer = &trans->base;
 169    return map_addr;
 170 }
 171
 172 static void *texture_transfer_map_resolve(struct pipe_context *ctx,
 173                                           struct pipe_resource *resource,
 174                                           unsigned level,
 175                                           unsigned usage,
 176                                           const struct pipe_box *box,
 177                                           struct pipe_transfer **transfer)
 178 {
 179    struct virgl_context *vctx = virgl_context(ctx);
 180    struct virgl_resource *vtex = virgl_resource(resource);
 181    struct pipe_resource templ, *resolve_tmp;
 182    struct virgl_transfer *trans;
 183
 184    trans = virgl_resource_create_transfer(vctx, resource,
 185                                           &vtex->metadata, level, usage, box);
 186    if (!trans)
 187       return NULL;
 188
 189    enum pipe_format fmt = resource->format;
 190    if (!virgl_has_readback_format(ctx->screen, fmt)) {
 191       if (util_format_fits_8unorm(util_format_description(fmt)))
 192          fmt = PIPE_FORMAT_R8G8B8A8_UNORM;
 193       else if (util_format_is_pure_sint(fmt))
 194          fmt = PIPE_FORMAT_R32G32B32A32_SINT;
 195       else if (util_format_is_pure_uint(fmt))
 196          fmt = PIPE_FORMAT_R32G32B32A32_UINT;
 197       else
 198          fmt = PIPE_FORMAT_R32G32B32A32_FLOAT;
 199       assert(virgl_has_readback_format(ctx->screen, fmt));
 200    }
 201
 202    struct pipe_box dst_box = *box;
 203    dst_box.x = dst_box.y = dst_box.z = 0;
 204    if (usage & PIPE_TRANSFER_READ) {
 205       /* readback should scale to the block size */
 206       dst_box.width = align(dst_box.width,
 207             util_format_get_blockwidth(resource->format));
 208       dst_box.height = align(dst_box.height,
 209             util_format_get_blockheight(resource->format));
 210    }
 211
 212    virgl_init_temp_resource_from_box(&templ, resource, &dst_box, level, 0, fmt);
 213
 214    resolve_tmp = ctx->screen->resource_create(ctx->screen, &templ);
 215    if (!resolve_tmp)
 216       return NULL;
 217
 218    if (usage & PIPE_TRANSFER_READ) {
 219       virgl_copy_region_with_blit(ctx, resolve_tmp, 0, &dst_box, resource,
 220                                   level, box);
 221       ctx->flush(ctx, NULL, 0);
 222    }
 223
 224    void *ptr = texture_transfer_map_plain(ctx, resolve_tmp, 0, usage, &dst_box,
 225                                           &trans->resolve_transfer);
 226    if (!ptr)
 227       goto fail;
 228
 229    *transfer = &trans->base;
 230    if (fmt == resource->format) {
 231       trans->base.stride = trans->resolve_transfer->stride;
 232       trans->base.layer_stride = trans->resolve_transfer->layer_stride;
 233       return ptr;
 234    } else {
 235       if (usage & PIPE_TRANSFER_READ) {
 236          struct virgl_winsys *vws = virgl_screen(ctx->screen)->vws;
 237          void *src = ptr;
 238          ptr = vws->resource_map(vws, vtex->hw_res);
 239          if (!ptr)
 240             goto fail;
 241
 242          if (!util_format_translate_3d(resource->format,
 243                                        ptr + vtex->metadata.level_offset[level],
 244                                        trans->base.stride,
 245                                        trans->base.layer_stride,
 246                                        box->x, box->y, box->z,
 247                                        fmt,
 248                                        src,
 249                                        trans->resolve_transfer->stride,
 250                                        trans->resolve_transfer->layer_stride,
 251                                        0, 0, 0,
 252                                        dst_box.width,
 253                                        dst_box.height,
 254                                        dst_box.depth)) {
 255             debug_printf("failed to translate format %s to %s\n",
 256                          util_format_short_name(fmt),
 257                          util_format_short_name(resource->format));
 258             goto fail;
 259          }
 260       }
 261
 262       if ((usage & PIPE_TRANSFER_WRITE) == 0)
 263          pipe_resource_reference(&trans->resolve_transfer->resource, NULL);
 264
 265       return ptr + trans->offset;
 266    }
 267
 268 fail:
 269    pipe_resource_reference(&resolve_tmp, NULL);
 270    virgl_resource_destroy_transfer(vctx, trans);
 271    return NULL;
 272 }
 273
 274 static bool needs_resolve(struct pipe_screen *screen,
 275                           struct pipe_resource *resource, unsigned usage)
 276 {
 277    if (resource->nr_samples > 1)
 278       return true;
 279
 280    if (usage & PIPE_TRANSFER_READ)
 281       return !util_format_is_depth_or_stencil(resource->format) &&
 282              !virgl_has_readback_format(screen, resource->format);
 283
 284    return false;
 285 }
 286
 287 static void *virgl_texture_transfer_map(struct pipe_context *ctx,
 288                                         struct pipe_resource *resource,
 289                                         unsigned level,
 290                                         unsigned usage,
 291                                         const struct pipe_box *box,
 292                                         struct pipe_transfer **transfer)
 293 {
 294    if (needs_resolve(ctx->screen, resource, usage))
 295       return texture_transfer_map_resolve(ctx, resource, level, usage, box,
 296                                           transfer);
 297
 298    return texture_transfer_map_plain(ctx, resource, level, usage, box, transfer);
 299 }
 300
 301 static void flush_data(struct pipe_context *ctx,
 302                        struct virgl_transfer *trans,
 303                        const struct pipe_box *box)
 304 {
 305    struct virgl_winsys *vws = virgl_screen(ctx->screen)->vws;
 306    vws->transfer_put(vws, trans->hw_res, box,
 307                      trans->base.stride, trans->l_stride, trans->offset,
 308                      trans->base.level);
 309 }
 310
 311 static void virgl_texture_transfer_unmap(struct pipe_context *ctx,
 312                                          struct pipe_transfer *transfer)
 313 {
 314    struct virgl_context *vctx = virgl_context(ctx);
 315    struct virgl_transfer *trans = virgl_transfer(transfer);
 316    bool queue_unmap = false;
 317
 318    if (transfer->usage & PIPE_TRANSFER_WRITE &&
 319        (transfer->usage & PIPE_TRANSFER_FLUSH_EXPLICIT) == 0) {
 320
 321       if (trans->resolve_transfer && (trans->base.resource->format ==
 322           trans->resolve_transfer->resource->format)) {
 323          flush_data(ctx, virgl_transfer(trans->resolve_transfer),
 324                     &trans->resolve_transfer->box);
 325
 326          /* FINISHME: In case the destination format isn't renderable here, the
 327           * blit here will currently fail. This could for instance happen if the
 328           * mapped resource is of a compressed format, and it's mapped with both
 329           * read and write usage.
 330           */
 331
 332          virgl_copy_region_with_blit(ctx,
 333                                      trans->base.resource, trans->base.level,
 334                                      &transfer->box,
 335                                      trans->resolve_transfer->resource, 0,
 336                                      &trans->resolve_transfer->box);
 337          ctx->flush(ctx, NULL, 0);
 338       } else
 339          queue_unmap = true;
 340    }
 341
 342    if (trans->resolve_transfer) {
 343       pipe_resource_reference(&trans->resolve_transfer->resource, NULL);
 344       virgl_resource_destroy_transfer(vctx,
 345                                       virgl_transfer(trans->resolve_transfer));
 346    }
 347
 348    if (queue_unmap) {
 349       if (trans->copy_src_hw_res) {
 350          virgl_encode_copy_transfer(vctx, trans);
 351          virgl_resource_destroy_transfer(vctx, trans);
 352       } else {
 353          virgl_transfer_queue_unmap(&vctx->queue, trans);
 354       }
 355    } else {
 356       virgl_resource_destroy_transfer(vctx, trans);
 357    }
 358 }
 359
 360 static const struct u_resource_vtbl virgl_texture_vtbl =
 361 {
 362    virgl_resource_get_handle,           /* get_handle */
 363    virgl_resource_destroy,              /* resource_destroy */
 364    virgl_texture_transfer_map,          /* transfer_map */
 365    NULL,                                /* transfer_flush_region */
 366    virgl_texture_transfer_unmap,        /* transfer_unmap */
 367 };
 368
 369 void virgl_texture_init(struct virgl_resource *res)
 370 {
 371    res->u.vtbl = &virgl_texture_vtbl;
 372 }