path: root/src/gallium/drivers/vc5/vc5_draw.c

/*
 * Copyright © 2014-2017 Broadcom
 *
 * 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.
 */

#include "util/u_blitter.h"
#include "util/u_prim.h"
#include "util/u_format.h"
#include "util/u_pack_color.h"
#include "util/u_prim_restart.h"
#include "util/u_upload_mgr.h"
#include "indices/u_primconvert.h"

#include "vc5_context.h"
#include "vc5_resource.h"
#include "vc5_cl.h"
#include "broadcom/cle/v3d_packet_v33_pack.h"
#include "broadcom/compiler/v3d_compiler.h"

/**
 * Does the initial bining command list setup for drawing to a given FBO.
 */
static void
vc5_start_draw(struct vc5_context *vc5)
{
        struct vc5_job *job = vc5->job;

        if (job->needs_flush)
                return;

        /* Get space to emit our BCL state, using a branch to jump to a new BO
         * if necessary.
         */
        vc5_cl_ensure_space_with_branch(&job->bcl, 256 /* XXX */);

        job->submit.bcl_start = job->bcl.bo->offset;
        vc5_job_add_bo(job, job->bcl.bo);

        job->tile_alloc = vc5_bo_alloc(vc5->screen, 1024 * 1024, "tile alloc");
        struct vc5_bo *tsda = vc5_bo_alloc(vc5->screen,
                                           job->draw_tiles_y *
                                           job->draw_tiles_x *
                                           64,
                                           "TSDA");

        /* "Binning mode lists start with a Tile Binning Mode Configuration
         * item (120)"
         *
         * Part1 signals the end of binning config setup.
         */
        cl_emit(&job->bcl, TILE_BINNING_MODE_CONFIGURATION_PART2, config) {
                config.tile_allocation_memory_address =
                        cl_address(job->tile_alloc, 0);
                config.tile_allocation_memory_size = job->tile_alloc->size;
        }

        cl_emit(&job->bcl, TILE_BINNING_MODE_CONFIGURATION_PART1, config) {
                config.tile_state_data_array_base_address =
                        cl_address(tsda, 0);

                config.width_in_tiles = job->draw_tiles_x;
                config.height_in_tiles = job->draw_tiles_y;

                /* Must be >= 1 */
                config.number_of_render_targets = 1;

                config.multisample_mode_4x = job->msaa;

                config.maximum_bpp_of_all_render_targets = job->internal_bpp;
        }

        vc5_bo_unreference(&tsda);

        /* There's definitely nothing in the VCD cache we want. */
        cl_emit(&job->bcl, FLUSH_VCD_CACHE, bin);

        /* "Binning mode lists must have a Start Tile Binning item (6) after
         *  any prefix state data before the binning list proper starts."
         */
        cl_emit(&job->bcl, START_TILE_BINNING, bin);

        cl_emit(&job->bcl, PRIMITIVE_LIST_FORMAT, fmt) {
                fmt.data_type = LIST_INDEXED;
                fmt.primitive_type = LIST_TRIANGLES;
        }

        job->needs_flush = true;
        job->draw_width = vc5->framebuffer.width;
        job->draw_height = vc5->framebuffer.height;
}

static void
vc5_predraw_check_textures(struct pipe_context *pctx,
                           struct vc5_texture_stateobj *stage_tex)
{
        struct vc5_context *vc5 = vc5_context(pctx);

        for (int i = 0; i < stage_tex->num_textures; i++) {
                struct pipe_sampler_view *view = stage_tex->textures[i];
                if (!view)
                        continue;

                vc5_flush_jobs_writing_resource(vc5, view->texture);
        }
}

static struct vc5_cl_reloc
vc5_get_default_values(struct vc5_context *vc5)
{
        struct vc5_job *job = vc5->job;

        /* VC5_DIRTY_VTXSTATE */
        struct vc5_vertex_stateobj *vtx = vc5->vtx;

        /* Set up the default values for attributes. */
        vc5_cl_ensure_space(&job->indirect, 4 * 4 * vtx->num_elements, 4);
        struct vc5_cl_reloc default_values =
                cl_address(job->indirect.bo, cl_offset(&job->indirect));
        vc5_bo_reference(default_values.bo);

        struct vc5_cl_out *defaults = cl_start(&job->indirect);
        for (int i = 0; i < vtx->num_elements; i++) {
                cl_aligned_f(&defaults, 0.0);
                cl_aligned_f(&defaults, 0.0);
                cl_aligned_f(&defaults, 0.0);
                cl_aligned_f(&defaults, 1.0);
        }
        cl_end(&job->indirect, defaults);

        return default_values;
}

static void
vc5_emit_gl_shader_state(struct vc5_context *vc5,
                         const struct pipe_draw_info *info)
{
        struct vc5_job *job = vc5->job;
        /* VC5_DIRTY_VTXSTATE */
        struct vc5_vertex_stateobj *vtx = vc5->vtx;
        /* VC5_DIRTY_VTXBUF */
        struct vc5_vertexbuf_stateobj *vertexbuf = &vc5->vertexbuf;

        /* Upload the uniforms to the indirect CL first */
        struct vc5_cl_reloc fs_uniforms =
                vc5_write_uniforms(vc5, vc5->prog.fs,
                                   &vc5->constbuf[PIPE_SHADER_FRAGMENT],
                                   &vc5->fragtex);
        struct vc5_cl_reloc vs_uniforms =
                vc5_write_uniforms(vc5, vc5->prog.vs,
                                   &vc5->constbuf[PIPE_SHADER_VERTEX],
                                   &vc5->verttex);
        struct vc5_cl_reloc cs_uniforms =
                vc5_write_uniforms(vc5, vc5->prog.cs,
                                   &vc5->constbuf[PIPE_SHADER_VERTEX],
                                   &vc5->verttex);
        struct vc5_cl_reloc default_values = vc5_get_default_values(vc5);

        uint32_t shader_rec_offset =
                vc5_cl_ensure_space(&job->indirect,
                                    cl_packet_length(GL_SHADER_STATE_RECORD) +
                                    vtx->num_elements *
                                    cl_packet_length(GL_SHADER_STATE_ATTRIBUTE_RECORD),
                                    32);

        cl_emit(&job->indirect, GL_SHADER_STATE_RECORD, shader) {
                shader.enable_clipping = true;
                /* VC5_DIRTY_PRIM_MODE | VC5_DIRTY_RASTERIZER */
                shader.point_size_in_shaded_vertex_data =
                        (info->mode == PIPE_PRIM_POINTS &&
                         vc5->rasterizer->base.point_size_per_vertex);

                /* Must be set if the shader modifies Z, discards, or modifies
                 * the sample mask.  For any of these cases, the fragment
                 * shader needs to write the Z value (even just discards).
                 */
                shader.fragment_shader_does_z_writes =
                        (vc5->prog.fs->prog_data.fs->writes_z ||
                         vc5->prog.fs->prog_data.fs->discard);

                shader.number_of_varyings_in_fragment_shader =
                        vc5->prog.fs->prog_data.base->num_inputs;

                shader.propagate_nans = true;

                shader.coordinate_shader_code_address =
                        cl_address(vc5->prog.cs->bo, 0);
                shader.vertex_shader_code_address =
                        cl_address(vc5->prog.vs->bo, 0);
                shader.fragment_shader_code_address =
                        cl_address(vc5->prog.fs->bo, 0);

                /* XXX: Use combined input/output size flag in the common
                 * case.
                 */
                shader.coordinate_shader_has_separate_input_and_output_vpm_blocks = true;
                shader.vertex_shader_has_separate_input_and_output_vpm_blocks = true;
                shader.coordinate_shader_input_vpm_segment_size =
                        vc5->prog.cs->prog_data.vs->vpm_input_size;
                shader.vertex_shader_input_vpm_segment_size =
                        vc5->prog.vs->prog_data.vs->vpm_input_size;

                shader.coordinate_shader_output_vpm_segment_size =
                        vc5->prog.cs->prog_data.vs->vpm_output_size;
                shader.vertex_shader_output_vpm_segment_size =
                        vc5->prog.vs->prog_data.vs->vpm_output_size;

                shader.coordinate_shader_uniforms_address = cs_uniforms;
                shader.vertex_shader_uniforms_address = vs_uniforms;
                shader.fragment_shader_uniforms_address = fs_uniforms;

                shader.vertex_id_read_by_coordinate_shader =
                        vc5->prog.cs->prog_data.vs->uses_vid;
                shader.instance_id_read_by_coordinate_shader =
                        vc5->prog.cs->prog_data.vs->uses_iid;
                shader.vertex_id_read_by_vertex_shader =
                        vc5->prog.vs->prog_data.vs->uses_vid;
                shader.instance_id_read_by_vertex_shader =
                        vc5->prog.vs->prog_data.vs->uses_iid;

                shader.address_of_default_attribute_values = default_values;
        }

        for (int i = 0; i < vtx->num_elements; i++) {
                struct pipe_vertex_element *elem = &vtx->pipe[i];
                struct pipe_vertex_buffer *vb =
                        &vertexbuf->vb[elem->vertex_buffer_index];
                struct vc5_resource *rsc = vc5_resource(vb->buffer.resource);
                const struct util_format_description *desc =
                        util_format_description(elem->src_format);

                uint32_t offset = vb->buffer_offset + elem->src_offset;

                cl_emit(&job->indirect, GL_SHADER_STATE_ATTRIBUTE_RECORD, attr) {
                        uint32_t r_size = desc->channel[0].size;

                        /* vec_size == 0 means 4 */
                        attr.vec_size = desc->nr_channels & 3;

                        switch (desc->channel[0].type) {
                        case UTIL_FORMAT_TYPE_FLOAT:
                                if (r_size == 32) {
                                        attr.type = ATTRIBUTE_FLOAT;
                                } else {
                                        assert(r_size == 16);
                                        attr.type = ATTRIBUTE_HALF_FLOAT;
                                }
                                break;

                        case UTIL_FORMAT_TYPE_SIGNED:
                        case UTIL_FORMAT_TYPE_UNSIGNED:
                                switch (r_size) {
                                case 32:
                                        attr.type = ATTRIBUTE_INT;
                                        break;
                                case 16:
                                        attr.type = ATTRIBUTE_SHORT;
                                        break;
                                case 10:
                                        attr.type = ATTRIBUTE_INT2_10_10_10;
                                        break;
                                case 8:
                                        attr.type = ATTRIBUTE_BYTE;
                                        break;
                                default:
                                        fprintf(stderr,
                                                "format %s unsupported\n",
                                                desc->name);
                                        attr.type = ATTRIBUTE_BYTE;
                                        abort();
                                }
                                break;

                        default:
                                fprintf(stderr,
                                        "format %s unsupported\n",
                                        desc->name);
                                abort();
                        }

                        attr.signed_int_type =
                                desc->channel[0].type == UTIL_FORMAT_TYPE_SIGNED;

                        attr.normalized_int_type = desc->channel[0].normalized;
                        attr.read_as_int_uint = desc->channel[0].pure_integer;
                        attr.address = cl_address(rsc->bo, offset);
                        attr.stride = vb->stride;
                        attr.instance_divisor = elem->instance_divisor;
                        attr.number_of_values_read_by_coordinate_shader =
                                vc5->prog.cs->prog_data.vs->vattr_sizes[i];
                        attr.number_of_values_read_by_vertex_shader =
                                vc5->prog.vs->prog_data.vs->vattr_sizes[i];
                }
        }

        cl_emit(&job->bcl, GL_SHADER_STATE, state) {
                state.address = cl_address(job->indirect.bo, shader_rec_offset);
                state.number_of_attribute_arrays = vtx->num_elements;
        }

        vc5_bo_unreference(&cs_uniforms.bo);
        vc5_bo_unreference(&vs_uniforms.bo);
        vc5_bo_unreference(&fs_uniforms.bo);
        vc5_bo_unreference(&default_values.bo);

        job->shader_rec_count++;
}

static void
vc5_draw_vbo(struct pipe_context *pctx, const struct pipe_draw_info *info)
{
        struct vc5_context *vc5 = vc5_context(pctx);

        if (!info->count_from_stream_output && !info->indirect &&
            !info->primitive_restart &&
            !u_trim_pipe_prim(info->mode, (unsigned*)&info->count))
                return;

        /* Fall back for weird desktop GL primitive restart values. */
        if (info->primitive_restart &&
            info->index_size) {
                uint32_t mask = ~0;

                switch (info->index_size) {
                case 2:
                        mask = 0xffff;
                        break;
                case 1:
                        mask = 0xff;
                        break;
                }

                if (info->restart_index != mask) {
                        util_draw_vbo_without_prim_restart(pctx, info);
                        return;
                }
        }

        if (info->mode >= PIPE_PRIM_QUADS) {
                util_primconvert_save_rasterizer_state(vc5->primconvert, &vc5->rasterizer->base);
                util_primconvert_draw_vbo(vc5->primconvert, info);
                perf_debug("Fallback conversion for %d %s vertices\n",
                           info->count, u_prim_name(info->mode));
                return;
        }

        /* Before setting up the draw, flush anything writing to the textures
         * that we read from.
         */
        vc5_predraw_check_textures(pctx, &vc5->verttex);
        vc5_predraw_check_textures(pctx, &vc5->fragtex);

        struct vc5_job *job = vc5_get_job_for_fbo(vc5);

        /* Get space to emit our draw call into the BCL, using a branch to
         * jump to a new BO if necessary.
         */
        vc5_cl_ensure_space_with_branch(&job->bcl, 256 /* XXX */);

        if (vc5->prim_mode != info->mode) {
                vc5->prim_mode = info->mode;
                vc5->dirty |= VC5_DIRTY_PRIM_MODE;
        }

        vc5_start_draw(vc5);
        vc5_update_compiled_shaders(vc5, info->mode);

        vc5_emit_state(pctx);

        if (vc5->dirty & (VC5_DIRTY_VTXBUF |
                          VC5_DIRTY_VTXSTATE |
                          VC5_DIRTY_PRIM_MODE |
                          VC5_DIRTY_RASTERIZER |
                          VC5_DIRTY_COMPILED_CS |
                          VC5_DIRTY_COMPILED_VS |
                          VC5_DIRTY_COMPILED_FS |
                          vc5->prog.cs->uniform_dirty_bits |
                          vc5->prog.vs->uniform_dirty_bits |
                          vc5->prog.fs->uniform_dirty_bits)) {
                vc5_emit_gl_shader_state(vc5, info);
        }

        vc5->dirty = 0;

        /* The Base Vertex/Base Instance packet sets those values to nonzero
         * for the next draw call only.
         */
        if (info->index_bias || info->start_instance) {
                cl_emit(&job->bcl, BASE_VERTEX_BASE_INSTANCE, base) {
                        base.base_instance = info->start_instance;
                        base.base_vertex = info->index_bias;
                }
        }

        /* Note that the primitive type fields match with OpenGL/gallium
         * definitions, up to but not including QUADS.
         */
        if (info->index_size) {
                uint32_t index_size = info->index_size;
                uint32_t offset = info->start * index_size;
                struct pipe_resource *prsc;
                if (info->has_user_indices) {
                        prsc = NULL;
                        u_upload_data(vc5->uploader, 0,
                                      info->count * info->index_size, 4,
                                      info->index.user,
                                      &offset, &prsc);
                } else {
                        prsc = info->index.resource;
                }
                struct vc5_resource *rsc = vc5_resource(prsc);

                if (info->instance_count > 1) {
                        cl_emit(&job->bcl, INDEXED_INSTANCED_PRIMITIVE_LIST, prim) {
                                prim.index_type = ffs(info->index_size) - 1;
                                prim.maximum_index = (1u << 31) - 1; /* XXX */
                                prim.address_of_indices_list =
                                        cl_address(rsc->bo, offset);
                                prim.mode = info->mode;
                                prim.enable_primitive_restarts = info->primitive_restart;

                                prim.number_of_instances = info->instance_count;
                                prim.instance_length = info->count;
                        }
                } else {
                        cl_emit(&job->bcl, INDEXED_PRIMITIVE_LIST, prim) {
                                prim.index_type = ffs(info->index_size) - 1;
                                prim.length = info->count;
                                prim.maximum_index = (1u << 31) - 1; /* XXX */
                                prim.address_of_indices_list =
                                        cl_address(rsc->bo, offset);
                                prim.mode = info->mode;
                                prim.enable_primitive_restarts = info->primitive_restart;
                        }
                }

                job->draw_calls_queued++;

                if (info->has_user_indices)
                        pipe_resource_reference(&prsc, NULL);
        } else {
                if (info->instance_count > 1) {
                        cl_emit(&job->bcl, VERTEX_ARRAY_INSTANCED_PRIMITIVES, prim) {
                                prim.mode = info->mode;
                                prim.index_of_first_vertex = info->start;
                                prim.number_of_instances = info->instance_count;
                                prim.instance_length = info->count;
                        }
                } else {
                        cl_emit(&job->bcl, VERTEX_ARRAY_PRIMITIVES, prim) {
                                prim.mode = info->mode;
                                prim.length = info->count;
                                prim.index_of_first_vertex = info->start;
                        }
                }
        }
        job->draw_calls_queued++;

        if (vc5->zsa && job->zsbuf &&
            (vc5->zsa->base.depth.enabled ||
             vc5->zsa->base.stencil[0].enabled)) {
                struct vc5_resource *rsc = vc5_resource(job->zsbuf->texture);
                vc5_job_add_bo(job, rsc->bo);

                if (vc5->zsa->base.depth.enabled) {
                        job->resolve |= PIPE_CLEAR_DEPTH;
                        rsc->initialized_buffers = PIPE_CLEAR_DEPTH;

                        if (vc5->zsa->early_z_enable)
                                job->uses_early_z = true;
                }

                if (vc5->zsa->base.stencil[0].enabled) {
                        job->resolve |= PIPE_CLEAR_STENCIL;
                        rsc->initialized_buffers |= PIPE_CLEAR_STENCIL;
                }
        }

        for (int i = 0; i < VC5_MAX_DRAW_BUFFERS; i++) {
                uint32_t bit = PIPE_CLEAR_COLOR0 << i;

                if (job->resolve & bit || !job->cbufs[i])
                        continue;
                struct vc5_resource *rsc = vc5_resource(job->cbufs[i]->texture);

                job->resolve |= bit;
                vc5_job_add_bo(job, rsc->bo);
        }

        if (V3D_DEBUG & V3D_DEBUG_ALWAYS_FLUSH)
                vc5_flush(pctx);
}

static uint32_t
pack_rgba(enum pipe_format format, const float *rgba)
{
        union util_color uc;
        util_pack_color(rgba, format, &uc);
        if (util_format_get_blocksize(format) == 2)
                return uc.us;
        else
                return uc.ui[0];
}

static void
vc5_clear(struct pipe_context *pctx, unsigned buffers,
          const union pipe_color_union *color, double depth, unsigned stencil)
{
        struct vc5_context *vc5 = vc5_context(pctx);
        struct vc5_job *job = vc5_get_job_for_fbo(vc5);

        /* We can't flag new buffers for clearing once we've queued draws.  We
         * could avoid this by using the 3d engine to clear.
         */
        if (job->draw_calls_queued) {
                perf_debug("Flushing rendering to process new clear.\n");
                vc5_job_submit(vc5, job);
                job = vc5_get_job_for_fbo(vc5);
        }

        if (buffers & PIPE_CLEAR_COLOR0) {
                struct vc5_resource *rsc =
                        vc5_resource(vc5->framebuffer.cbufs[0]->texture);
                uint32_t clear_color;

#if 0
                if (vc5_rt_format_is_565(vc5->framebuffer.cbufs[0]->format)) {
                        /* In 565 mode, the hardware will be packing our color
                         * for us.
                         */
                        clear_color = pack_rgba(PIPE_FORMAT_R8G8B8A8_UNORM,
                                                color->f);
                } else {
                        /* Otherwise, we need to do this packing because we
                         * support multiple swizzlings of RGBA8888.
                         */
                        clear_color =
                                pack_rgba(vc5->framebuffer.cbufs[0]->format,
                                          color->f);
                }
#endif
                clear_color = pack_rgba(vc5->framebuffer.cbufs[0]->format,
                                        color->f);

                job->clear_color[0] = job->clear_color[1] = clear_color;
                rsc->initialized_buffers |= (buffers & PIPE_CLEAR_COLOR0);
        }

        unsigned zsclear = buffers & PIPE_CLEAR_DEPTHSTENCIL;
        if (zsclear) {
                struct vc5_resource *rsc =
                        vc5_resource(vc5->framebuffer.zsbuf->texture);

                if (zsclear & PIPE_CLEAR_DEPTH)
                        job->clear_z = depth;
                if (zsclear & PIPE_CLEAR_STENCIL)
                        job->clear_s = stencil;

                rsc->initialized_buffers |= zsclear;
        }

        job->draw_min_x = 0;
        job->draw_min_y = 0;
        job->draw_max_x = vc5->framebuffer.width;
        job->draw_max_y = vc5->framebuffer.height;
        job->cleared |= buffers;
        job->resolve |= buffers;

        vc5_start_draw(vc5);
}

static void
vc5_clear_render_target(struct pipe_context *pctx, struct pipe_surface *ps,
                        const union pipe_color_union *color,
                        unsigned x, unsigned y, unsigned w, unsigned h,
                        bool render_condition_enabled)
{
        fprintf(stderr, "unimpl: clear RT\n");
}

static void
vc5_clear_depth_stencil(struct pipe_context *pctx, struct pipe_surface *ps,
                        unsigned buffers, double depth, unsigned stencil,
                        unsigned x, unsigned y, unsigned w, unsigned h,
                        bool render_condition_enabled)
{
        fprintf(stderr, "unimpl: clear DS\n");
}

void
vc5_draw_init(struct pipe_context *pctx)
{
        pctx->draw_vbo = vc5_draw_vbo;
        pctx->clear = vc5_clear;
        pctx->clear_render_target = vc5_clear_render_target;
        pctx->clear_depth_stencil = vc5_clear_depth_stencil;
}