[mesa.git] / src / gallium / drivers / freedreno / freedreno_resource.c

/* -*- mode: C; c-file-style: "k&r"; tab-width 4; indent-tabs-mode: t; -*- */

/*
 * Copyright (C) 2012 Rob Clark <robclark@freedesktop.org>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice (including the next
 * paragraph) shall be included in all copies or substantial portions of the
 * Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 *
 * Authors:
 *    Rob Clark <robclark@freedesktop.org>
 */

#include "util/u_format.h"
#include "util/u_inlines.h"
#include "util/u_transfer.h"
#include "util/u_string.h"
#include "util/u_surface.h"

#include "freedreno_resource.h"
#include "freedreno_screen.h"
#include "freedreno_surface.h"
#include "freedreno_context.h"
#include "freedreno_query_hw.h"
#include "freedreno_util.h"

#include <errno.h>

static void
realloc_bo(struct fd_resource *rsc, uint32_t size)
{
        struct fd_screen *screen = fd_screen(rsc->base.b.screen);
        uint32_t flags = DRM_FREEDRENO_GEM_CACHE_WCOMBINE |
                        DRM_FREEDRENO_GEM_TYPE_KMEM; /* TODO */

        /* if we start using things other than write-combine,
         * be sure to check for PIPE_RESOURCE_FLAG_MAP_COHERENT
         */

        if (rsc->bo)
                fd_bo_del(rsc->bo);

        rsc->bo = fd_bo_new(screen->dev, size, flags);
        rsc->timestamp = 0;
        rsc->dirty = false;
}

static void fd_resource_transfer_flush_region(struct pipe_context *pctx,
                struct pipe_transfer *ptrans,
                const struct pipe_box *box)
{
        struct fd_context *ctx = fd_context(pctx);
        struct fd_resource *rsc = fd_resource(ptrans->resource);

        if (rsc->dirty)
                fd_context_render(pctx);

        if (rsc->timestamp) {
                fd_pipe_wait(ctx->screen->pipe, rsc->timestamp);
                rsc->timestamp = 0;
        }
}

static void
fd_resource_transfer_unmap(struct pipe_context *pctx,
                struct pipe_transfer *ptrans)
{
        struct fd_context *ctx = fd_context(pctx);
        struct fd_resource *rsc = fd_resource(ptrans->resource);
        if (!(ptrans->usage & PIPE_TRANSFER_UNSYNCHRONIZED))
                fd_bo_cpu_fini(rsc->bo);
        pipe_resource_reference(&ptrans->resource, NULL);
        util_slab_free(&ctx->transfer_pool, ptrans);
}

static void *
fd_resource_transfer_map(struct pipe_context *pctx,
                struct pipe_resource *prsc,
                unsigned level, unsigned usage,
                const struct pipe_box *box,
                struct pipe_transfer **pptrans)
{
        struct fd_context *ctx = fd_context(pctx);
        struct fd_resource *rsc = fd_resource(prsc);
        struct fd_resource_slice *slice = fd_resource_slice(rsc, level);
        struct pipe_transfer *ptrans;
        enum pipe_format format = prsc->format;
        uint32_t op = 0;
        char *buf;
        int ret = 0;

        ptrans = util_slab_alloc(&ctx->transfer_pool);
        if (!ptrans)
                return NULL;

        /* util_slab_alloc() doesn't zero: */
        memset(ptrans, 0, sizeof(*ptrans));

        pipe_resource_reference(&ptrans->resource, prsc);
        ptrans->level = level;
        ptrans->usage = usage;
        ptrans->box = *box;
        ptrans->stride = slice->pitch * rsc->cpp;
        ptrans->layer_stride = ptrans->stride;

        if (usage & PIPE_TRANSFER_READ)
                op |= DRM_FREEDRENO_PREP_READ;

        if (usage & PIPE_TRANSFER_WRITE)
                op |= DRM_FREEDRENO_PREP_WRITE;

        if (usage & PIPE_TRANSFER_DISCARD_WHOLE_RESOURCE)
                op |= DRM_FREEDRENO_PREP_NOSYNC;

        /* some state trackers (at least XA) don't do this.. */
        if (!(usage & (PIPE_TRANSFER_FLUSH_EXPLICIT | PIPE_TRANSFER_DISCARD_WHOLE_RESOURCE)))
                fd_resource_transfer_flush_region(pctx, ptrans, box);

        if (!(usage & PIPE_TRANSFER_UNSYNCHRONIZED)) {
                ret = fd_bo_cpu_prep(rsc->bo, ctx->screen->pipe, op);
                if ((ret == -EBUSY) && (usage & PIPE_TRANSFER_DISCARD_WHOLE_RESOURCE))
                        realloc_bo(rsc, fd_bo_size(rsc->bo));
                else if (ret)
                        goto fail;
        }

        buf = fd_bo_map(rsc->bo);
        if (!buf) {
                fd_resource_transfer_unmap(pctx, ptrans);
                return NULL;
        }

        *pptrans = ptrans;

        return buf + slice->offset +
                box->y / util_format_get_blockheight(format) * ptrans->stride +
                box->x / util_format_get_blockwidth(format) * rsc->cpp +
                box->z * slice->size0;

fail:
        fd_resource_transfer_unmap(pctx, ptrans);
        return NULL;
}

static void
fd_resource_destroy(struct pipe_screen *pscreen,
                struct pipe_resource *prsc)
{
        struct fd_resource *rsc = fd_resource(prsc);
        if (rsc->bo)
                fd_bo_del(rsc->bo);
        FREE(rsc);
}

static boolean
fd_resource_get_handle(struct pipe_screen *pscreen,
                struct pipe_resource *prsc,
                struct winsys_handle *handle)
{
        struct fd_resource *rsc = fd_resource(prsc);

        return fd_screen_bo_get_handle(pscreen, rsc->bo,
                        rsc->slices[0].pitch * rsc->cpp, handle);
}


static const struct u_resource_vtbl fd_resource_vtbl = {
                .resource_get_handle      = fd_resource_get_handle,
                .resource_destroy         = fd_resource_destroy,
                .transfer_map             = fd_resource_transfer_map,
                .transfer_flush_region    = fd_resource_transfer_flush_region,
                .transfer_unmap           = fd_resource_transfer_unmap,
                .transfer_inline_write    = u_default_transfer_inline_write,
};

static uint32_t
setup_slices(struct fd_resource *rsc)
{
        struct pipe_resource *prsc = &rsc->base.b;
        uint32_t level, size = 0;
        uint32_t width = prsc->width0;
        uint32_t height = prsc->height0;
        uint32_t depth = prsc->depth0;

        for (level = 0; level <= prsc->last_level; level++) {
                struct fd_resource_slice *slice = fd_resource_slice(rsc, level);
                uint32_t aligned_width = align(width, 32);

                slice->pitch = aligned_width;
                slice->offset = size;
                slice->size0 = slice->pitch * height * rsc->cpp;

                size += slice->size0 * depth * prsc->array_size;

                width = u_minify(width, 1);
                height = u_minify(height, 1);
                depth = u_minify(depth, 1);
        }

        return size;
}

/**
 * Create a new texture object, using the given template info.
 */
static struct pipe_resource *
fd_resource_create(struct pipe_screen *pscreen,
                const struct pipe_resource *tmpl)
{
        struct fd_resource *rsc = CALLOC_STRUCT(fd_resource);
        struct pipe_resource *prsc = &rsc->base.b;
        uint32_t size;

        DBG("target=%d, format=%s, %ux%ux%u, array_size=%u, last_level=%u, "
                        "nr_samples=%u, usage=%u, bind=%x, flags=%x",
                        tmpl->target, util_format_name(tmpl->format),
                        tmpl->width0, tmpl->height0, tmpl->depth0,
                        tmpl->array_size, tmpl->last_level, tmpl->nr_samples,
                        tmpl->usage, tmpl->bind, tmpl->flags);

        if (!rsc)
                return NULL;

        *prsc = *tmpl;

        pipe_reference_init(&prsc->reference, 1);
        prsc->screen = pscreen;

        rsc->base.vtbl = &fd_resource_vtbl;
        rsc->cpp = util_format_get_blocksize(tmpl->format);

        assert(rsc->cpp);

        size = setup_slices(rsc);

        realloc_bo(rsc, size);
        if (!rsc->bo)
                goto fail;

        return prsc;
fail:
        fd_resource_destroy(pscreen, prsc);
        return NULL;
}

/**
 * Create a texture from a winsys_handle. The handle is often created in
 * another process by first creating a pipe texture and then calling
 * resource_get_handle.
 */
static struct pipe_resource *
fd_resource_from_handle(struct pipe_screen *pscreen,
                const struct pipe_resource *tmpl,
                struct winsys_handle *handle)
{
        struct fd_resource *rsc = CALLOC_STRUCT(fd_resource);
        struct fd_resource_slice *slice = &rsc->slices[0];
        struct pipe_resource *prsc = &rsc->base.b;

        DBG("target=%d, format=%s, %ux%ux%u, array_size=%u, last_level=%u, "
                        "nr_samples=%u, usage=%u, bind=%x, flags=%x",
                        tmpl->target, util_format_name(tmpl->format),
                        tmpl->width0, tmpl->height0, tmpl->depth0,
                        tmpl->array_size, tmpl->last_level, tmpl->nr_samples,
                        tmpl->usage, tmpl->bind, tmpl->flags);

        if (!rsc)
                return NULL;

        *prsc = *tmpl;

        pipe_reference_init(&prsc->reference, 1);
        prsc->screen = pscreen;

        rsc->bo = fd_screen_bo_from_handle(pscreen, handle, &slice->pitch);
        if (!rsc->bo)
                goto fail;

        rsc->base.vtbl = &fd_resource_vtbl;
        rsc->cpp = util_format_get_blocksize(tmpl->format);
        slice->pitch /= rsc->cpp;

        assert(rsc->cpp);

        return prsc;

fail:
        fd_resource_destroy(pscreen, prsc);
        return NULL;
}

static bool render_blit(struct pipe_context *pctx, struct pipe_blit_info *info);

/**
 * Copy a block of pixels from one resource to another.
 * The resource must be of the same format.
 * Resources with nr_samples > 1 are not allowed.
 */
static void
fd_resource_copy_region(struct pipe_context *pctx,
                struct pipe_resource *dst,
                unsigned dst_level,
                unsigned dstx, unsigned dsty, unsigned dstz,
                struct pipe_resource *src,
                unsigned src_level,
                const struct pipe_box *src_box)
{
        /* TODO if we have 2d core, or other DMA engine that could be used
         * for simple copies and reasonably easily synchronized with the 3d
         * core, this is where we'd plug it in..
         */
        struct pipe_blit_info info = {
                .dst = {
                        .resource = dst,
                        .box = {
                                .x      = dstx,
                                .y      = dsty,
                                .z      = dstz,
                                .width  = src_box->width,
                                .height = src_box->height,
                                .depth  = src_box->depth,
                        },
                        .format = util_format_linear(dst->format),
                },
                .src = {
                        .resource = src,
                        .box      = *src_box,
                        .format   = util_format_linear(src->format),
                },
                .mask = PIPE_MASK_RGBA,
                .filter = PIPE_TEX_FILTER_NEAREST,
        };
        render_blit(pctx, &info);
}

/* Optimal hardware path for blitting pixels.
 * Scaling, format conversion, up- and downsampling (resolve) are allowed.
 */
static void
fd_blit(struct pipe_context *pctx, const struct pipe_blit_info *blit_info)
{
        struct pipe_blit_info info = *blit_info;

        if (info.src.resource->nr_samples > 1 &&
                        info.dst.resource->nr_samples <= 1 &&
                        !util_format_is_depth_or_stencil(info.src.resource->format) &&
                        !util_format_is_pure_integer(info.src.resource->format)) {
                DBG("color resolve unimplemented");
                return;
        }

        if (util_try_blit_via_copy_region(pctx, &info)) {
                return; /* done */
        }

        if (info.mask & PIPE_MASK_S) {
                DBG("cannot blit stencil, skipping");
                info.mask &= ~PIPE_MASK_S;
        }

        render_blit(pctx, &info);
}

static bool
render_blit(struct pipe_context *pctx, struct pipe_blit_info *info)
{
        struct fd_context *ctx = fd_context(pctx);

        if (!util_blitter_is_blit_supported(ctx->blitter, info)) {
                DBG("blit unsupported %s -> %s",
                                util_format_short_name(info->src.resource->format),
                                util_format_short_name(info->dst.resource->format));
                return false;
        }

        util_blitter_save_vertex_buffer_slot(ctx->blitter, ctx->vertexbuf.vb);
        util_blitter_save_vertex_elements(ctx->blitter, ctx->vtx);
        util_blitter_save_vertex_shader(ctx->blitter, ctx->prog.vp);
        util_blitter_save_rasterizer(ctx->blitter, ctx->rasterizer);
        util_blitter_save_viewport(ctx->blitter, &ctx->viewport);
        util_blitter_save_scissor(ctx->blitter, &ctx->scissor);
        util_blitter_save_fragment_shader(ctx->blitter, ctx->prog.fp);
        util_blitter_save_blend(ctx->blitter, ctx->blend);
        util_blitter_save_depth_stencil_alpha(ctx->blitter, ctx->zsa);
        util_blitter_save_stencil_ref(ctx->blitter, &ctx->stencil_ref);
        util_blitter_save_sample_mask(ctx->blitter, ctx->sample_mask);
        util_blitter_save_framebuffer(ctx->blitter, &ctx->framebuffer);
        util_blitter_save_fragment_sampler_states(ctx->blitter,
                        ctx->fragtex.num_samplers,
                        (void **)ctx->fragtex.samplers);
        util_blitter_save_fragment_sampler_views(ctx->blitter,
                        ctx->fragtex.num_textures, ctx->fragtex.textures);

        fd_hw_query_set_stage(ctx, ctx->ring, FD_STAGE_BLIT);
        util_blitter_blit(ctx->blitter, info);
        fd_hw_query_set_stage(ctx, ctx->ring, FD_STAGE_NULL);

        return true;
}

static void
fd_flush_resource(struct pipe_context *ctx, struct pipe_resource *resource)
{
}

void
fd_resource_screen_init(struct pipe_screen *pscreen)
{
        pscreen->resource_create = fd_resource_create;
        pscreen->resource_from_handle = fd_resource_from_handle;
        pscreen->resource_get_handle = u_resource_get_handle_vtbl;
        pscreen->resource_destroy = u_resource_destroy_vtbl;
}

void
fd_resource_context_init(struct pipe_context *pctx)
{
        pctx->transfer_map = u_transfer_map_vtbl;
        pctx->transfer_flush_region = u_transfer_flush_region_vtbl;
        pctx->transfer_unmap = u_transfer_unmap_vtbl;
        pctx->transfer_inline_write = u_transfer_inline_write_vtbl;
        pctx->create_surface = fd_create_surface;
        pctx->surface_destroy = fd_surface_destroy;
        pctx->resource_copy_region = fd_resource_copy_region;
        pctx->blit = fd_blit;
        pctx->flush_resource = fd_flush_resource;
}