/*
 * Copyright © 2014 Rob Clark <robclark@freedesktop.org>
 * SPDX-License-Identifier: MIT
 *
 * Authors:
 *    Rob Clark <robclark@freedesktop.org>
 */

#include "util/format/u_format.h"
#include "util/u_atomic.h"
#include "util/u_math.h"
#include "util/u_memory.h"
#include "util/u_string.h"

#include "drm/freedreno_drmif.h"

#include "ir3_assembler.h"
#include "ir3_compiler.h"
#include "ir3_nir.h"
#include "ir3_parser.h"
#include "ir3_shader.h"

#include "freedreno/isa/ir3-isa.h"
#include "isa/isa.h"

#include "disasm.h"

bool
ir3_const_ensure_imm_size(struct ir3_shader_variant *v, unsigned size)
{
   struct ir3_imm_const_state *imm_state = &v->imm_state;

   if (size <= imm_state->size) {
      return true;
   }

   /* Immediates are uploaded in units of vec4 so make sure our buffer is large
    * enough.
    */
   size = align(size, 4);

   /* Pre-a7xx, the immediates that get lowered to const registers are
    * emitted as part of the const state so the total size of immediates
    * should be the same for the binning and non-binning variants. Make sure
    * we don't increase the size beyond that of the non-binning variant.
    */
   if (v->binning_pass && !v->compiler->load_shader_consts_via_preamble &&
       size > v->nonbinning->imm_state.size) {
      return false;
   }

   imm_state->values =
      rerzalloc(v, imm_state->values, __typeof__(imm_state->values[0]),
                imm_state->size, size);
   imm_state->size = size;

   /* Note that ir3 printing relies on having groups of 4 dwords, so we fill the
    * unused slots with a dummy value.
    */
   for (int i = imm_state->count; i < imm_state->size; i++) {
      imm_state->values[i] = 0xd0d0d0d0;
   }

   return true;
}

uint16_t
ir3_const_imm_index_to_reg(const struct ir3_const_state *const_state,
                           unsigned i)
{
   return i + (4 * const_state->allocs.max_const_offset_vec4);
}

uint16_t
ir3_const_find_imm(struct ir3_shader_variant *v, uint32_t imm)
{
   const struct ir3_const_state *const_state = ir3_const_state(v);
   const struct ir3_imm_const_state *imm_state = &v->imm_state;

   for (unsigned i = 0; i < imm_state->count; i++) {
      if (imm_state->values[i] == imm)
         return ir3_const_imm_index_to_reg(const_state, i);
   }

   return INVALID_CONST_REG;
}

uint16_t
ir3_const_add_imm(struct ir3_shader_variant *v, uint32_t imm)
{
   const struct ir3_const_state *const_state = ir3_const_state(v);
   struct ir3_imm_const_state *imm_state = &v->imm_state;

   /* Reallocate for 4 more elements whenever it's necessary. */
   if (imm_state->count == imm_state->size) {
      if (!ir3_const_ensure_imm_size(v, imm_state->size + 4)) {
         return INVALID_CONST_REG;
      }
   }

   /* Add on a new immediate to be pushed, if we have space left in the
    * constbuf.
    */
   if (const_state->allocs.max_const_offset_vec4 + imm_state->count / 4 >=
       ir3_max_const(v)) {
      return INVALID_CONST_REG;
   }

   imm_state->values[imm_state->count] = imm;
   return ir3_const_imm_index_to_reg(const_state, imm_state->count++);
}

int
ir3_glsl_type_size(const struct glsl_type *type, bool bindless)
{
   return glsl_count_attribute_slots(type, false);
}

/* wrapper for ir3_assemble() which does some info fixup based on
 * shader state.  Non-static since used by ir3_cmdline too.
 */
void *
ir3_shader_assemble(struct ir3_shader_variant *v)
{
   const struct ir3_compiler *compiler = v->compiler;
   struct ir3_info *info = &v->info;
   uint32_t *bin;

   ir3_collect_info(v);

   if (v->constant_data_size) {
      /* Make sure that where we're about to place the constant_data is safe
       * to indirectly upload from.
       */
      info->constant_data_offset =
         align(info->size, v->compiler->const_upload_unit * 16);
      info->size = info->constant_data_offset + v->constant_data_size;
   }

   /* Pad out the size so that when turnip uploads the shaders in
    * sequence, the starting offset of the next one is properly aligned.
    */
   info->size = align(info->size, compiler->instr_align * sizeof(uint64_t));

   bin = isa_assemble(v);
   if (!bin)
      return NULL;

   /* Append the immediates after the end of the program.  This lets us emit
    * the immediates as an indirect load, while avoiding creating another BO.
    */
   if (v->constant_data_size)
      memcpy(&bin[info->constant_data_offset / 4], v->constant_data,
             v->constant_data_size);

   /* NOTE: if relative addressing is used, we set constlen in
    * the compiler (to worst-case value) since we don't know in
    * the assembler what the max addr reg value can be:
    */
   v->constlen = MAX2(v->constlen, info->max_const + 1);

   const struct ir3_const_state *const_state = ir3_const_state(v);
   if (ir3_const_can_upload(&const_state->allocs, IR3_CONST_ALLOC_DRIVER_PARAMS,
                            v->constlen) ||
       (const_state->driver_params_ubo.idx >= 0))
      v->need_driver_params = true;

   /* On a4xx and newer, constlen must be a multiple of 16 dwords even though
    * uploads are in units of 4 dwords. Round it up here to make calculations
    * regarding the shared constlen simpler.
    */
   if (compiler->gen >= 4)
      v->constlen = align(v->constlen, 4);

   info->constlen = v->constlen;

   /* Use the per-wave layout by default on a6xx for compute shaders. It
    * should result in better performance when loads/stores are to a uniform
    * index.
    */
   v->pvtmem_per_wave = compiler->gen >= 6 && !info->multi_dword_ldp_stp &&
                        ((v->type == MESA_SHADER_COMPUTE) ||
                         (v->type == MESA_SHADER_KERNEL));

   return bin;
}

static bool
try_override_shader_variant(struct ir3_shader_variant *v,
                            const char *identifier)
{
   assert(ir3_shader_override_path);

   char *name =
      ralloc_asprintf(NULL, "%s/%s.asm", ir3_shader_override_path, identifier);

   FILE *f = fopen(name, "r");

   if (!f) {
      ralloc_free(name);
      return false;
   }

   struct ir3_kernel_info info;
   info.numwg = INVALID_REG;
   v->ir = ir3_parse(v, &info, f);

   fclose(f);

   if (!v->ir) {
      fprintf(stderr, "Failed to parse %s\n", name);
      exit(1);
   }

   v->bin = ir3_shader_assemble(v);
   if (!v->bin) {
      fprintf(stderr, "Failed to assemble %s\n", name);
      exit(1);
   }

   ralloc_free(name);
   return true;
}

struct disasm_context {
   FILE *stream;
   uint8_t *mismatch_array;
};

static void
disasm_pre_instr_cb(void *cbdata, unsigned n, void *instr)
{
   struct disasm_context *context = (struct disasm_context *)cbdata;
   bool mismatch = context->mismatch_array && context->mismatch_array[n];
   uint32_t *dwords = (uint32_t *)instr;
   fprintf(context->stream, " %s [%03d] [%08x_%08x] ",
      mismatch ? "!!" : "  ", n, dwords[1], dwords[0]);
}

static void
disasm_no_match_cb(FILE *stream, const BITSET_WORD *dwords, size_t size)
{
   fprintf(stream, " XX [000] raw 0x%X%X\n", dwords[0], dwords[1]);
}

static char *
disasm_collect(struct ir3_shader_variant *v, uint8_t *mismatch_array,
               uint32_t *binary_data, uint32_t binary_size)
{
   char *stream_data = NULL;
   size_t stream_size = 0;
   FILE *stream = open_memstream(&stream_data, &stream_size);

   struct disasm_context context = {
      .stream = stream,
      .mismatch_array = mismatch_array,
   };

   struct isa_decode_options decode_options = {
      .gpu_id = v->ir->compiler->gen * 100,
      .show_errors = true,
      .branch_labels = true,
      .cbdata = &context,
      .pre_instr_cb = disasm_pre_instr_cb,
      .no_match_cb = disasm_no_match_cb,
   };

   ir3_isa_disasm(binary_data, binary_size, stream, &decode_options);

   fclose(stream);
   return stream_data;
}

static uint16_t
variant_unpadded_binary_size(struct ir3_shader_variant *v)
{
   /* This helper returns the size (in dwords) of variant's binary after
    * the padding nops at the end are ignored.
    */
   uint16_t size = v->info.sizedwords;

   for (uint16_t i = 0; i < v->info.sizedwords; i += 2) {
      uint32_t *dword = &v->bin[v->info.sizedwords - 2 - i];
      if (!!dword[0] || !!dword[1])
         break;

      size -= 2;
   }

   return size;
}

static void
validate_print_disasm(struct ir3_shader_variant *v, uint8_t *mismatch_array)
{
   char *disasm = disasm_collect(v, mismatch_array,
                                 v->bin, variant_unpadded_binary_size(v) * 4);
   mesa_loge("\n%s", disasm);
   free(disasm);
}

static bool
validate_roundtrip_variant_binary(struct ir3_shader_variant *rt_v, struct ir3_shader_variant *v)
{
   /* Ignoring padding nops in both variants, compare the binary data.
    * If there's a mismatch, print both disassemblies with highlighted
    * points of difference.
    */
   uint16_t v_sizedwords = variant_unpadded_binary_size(v);
   uint16_t rt_v_sizedwords = variant_unpadded_binary_size(rt_v);
   if (v_sizedwords == rt_v_sizedwords &&
       !memcmp(v->bin, rt_v->bin, v_sizedwords * 4))
      return true;

   mesa_loge("validate_roundtrip_variant_binary: mismatch between initial and reassembled binary\n");

   uint32_t max_sizedwords = MAX2(v_sizedwords, rt_v_sizedwords);
   uint8_t *mismatch_array = calloc(max_sizedwords / 2, sizeof(uint8_t));

   for (uint32_t i = 0; i < max_sizedwords; i += 2) {
      if (i >= v_sizedwords || i >= rt_v_sizedwords) {
         mismatch_array[i / 2] = 0xff;
         continue;
      }

      uint32_t *v_dword = &v->bin[i];
      uint32_t *rt_v_dword = &rt_v->bin[i];
      if (v_dword[0] != rt_v_dword[0] || v_dword[1] != rt_v_dword[1])
         mismatch_array[i / 2] = 0xff;
   }

   mesa_loge("  disassembly of initial binary:");
   validate_print_disasm(v, mismatch_array);

   mesa_loge("  disassembly of reassembled binary:");
   validate_print_disasm(rt_v, mismatch_array);

   free(mismatch_array);
   return false;
}

static struct ir3_shader_variant *
alloc_variant(struct ir3_shader *shader, const struct ir3_shader_key *key,
              struct ir3_shader_variant *nonbinning, void *mem_ctx);

static struct ir3_shader_variant *
create_roundtrip_variant(struct ir3_shader *shader, struct ir3_shader_variant *v)
{
   struct ir3_shader_variant *rt_v = alloc_variant(shader, &v->key, NULL, NULL);
   if (!rt_v)
      return NULL;

   /* Dump variant's disassembly into a memory stream, then read and
    * parse from that stream to assemble the roundtrip variant.
    */
   char *disasm_data = NULL;
   size_t disasm_size = 0;
   FILE *disasm_stream = open_memstream(&disasm_data, &disasm_size);
   ir3_shader_disasm(v, v->bin, disasm_stream);
   fflush(disasm_stream);

   struct ir3_kernel_info info;
   memset(&info, 0, sizeof(info));
   info.numwg = INVALID_REG;

   fseek(disasm_stream, 0, SEEK_SET);
   rt_v->ir = ir3_parse(rt_v, &info, disasm_stream);

   fclose(disasm_stream);
   free(disasm_data);

   if (!rt_v->ir) {
      mesa_loge("create_roundtrip_variant: failed to parse initial disassembly");
      goto fail;
   }

   rt_v->bin = ir3_shader_assemble(rt_v);
   if (!rt_v->bin) {
      mesa_loge("create_roundtrip_variant: failed to assemble parsed initial disassembly");
      goto fail;
   }

   if (!validate_roundtrip_variant_binary(rt_v, v))
      goto fail;

   return rt_v;

fail:
   ralloc_free(rt_v);
   return NULL;
}

static void
assemble_variant(struct ir3_shader_variant *v, bool internal)
{
   v->bin = ir3_shader_assemble(v);

   unsigned char sha1[SHA1_DIGEST_LENGTH + 1];

   struct mesa_sha1 ctx;

   _mesa_sha1_init(&ctx);
   _mesa_sha1_update(&ctx, v->bin, v->info.size);
   _mesa_sha1_update(&ctx, &v->info.double_threadsize,
                     sizeof(v->info.double_threadsize));
   _mesa_sha1_final(&ctx, sha1);
   _mesa_sha1_format(v->sha1_str, sha1);

   bool dbg_enabled = shader_debug_enabled(v->type, internal) ||
                      ir3_shader_bisect_disasm_select(v);
   if (dbg_enabled || ir3_shader_override_path || v->disasm_info.write_disasm) {
      bool shader_overridden =
         ir3_shader_override_path && try_override_shader_variant(v, v->sha1_str);

      if (v->disasm_info.write_disasm) {
         char *stream_data = NULL;
         size_t stream_size = 0;
         FILE *stream = open_memstream(&stream_data, &stream_size);

         fprintf(stream,
                 "Native code%s for unnamed %s shader %s with sha1 %s:\n",
                 shader_overridden ? " (overridden)" : "", ir3_shader_stage(v),
                 v->name, v->sha1_str);
         ir3_shader_disasm(v, v->bin, stream);

         fclose(stream);

         v->disasm_info.disasm = ralloc_size(v, stream_size + 1);
         memcpy(v->disasm_info.disasm, stream_data, stream_size);
         v->disasm_info.disasm[stream_size] = 0;
         free(stream_data);
      }

      if (dbg_enabled || shader_overridden) {
         char *stream_data = NULL;
         size_t stream_size = 0;
         FILE *stream = open_memstream(&stream_data, &stream_size);

         fprintf(stream,
                 "Native code%s for unnamed %s shader %s with sha1 %s:\n",
                 shader_overridden ? " (overridden)" : "", ir3_shader_stage(v),
                 v->name, v->sha1_str);
         if (v->type == MESA_SHADER_FRAGMENT)
            fprintf(stream, "SIMD0\n");
         ir3_shader_disasm(v, v->bin, stream);
         fclose(stream);

         mesa_log_multiline(MESA_LOG_INFO, stream_data);
         free(stream_data);
      }
   }
}

static bool
compile_variant(struct ir3_shader *shader, struct ir3_shader_variant *v)
{
   int ret = ir3_compile_shader_nir(shader->compiler, shader, v);
   if (ret) {
      mesa_loge("compile failed! (%s:%s)", shader->nir->info.name,
                shader->nir->info.label);
      return false;
   }

   assemble_variant(v, shader->nir->info.internal);
   if (!v->bin) {
      mesa_loge("assemble failed! (%s:%s)", shader->nir->info.name,
                shader->nir->info.label);
      return false;
   }

   if (ir3_shader_debug & IR3_DBG_ASM_ROUNDTRIP) {
      struct ir3_shader_variant *rt_v = create_roundtrip_variant(shader, v);
      if (!rt_v)
         return false;

      /* TODO: the roundtrip variant could replace the initial variant
       * to also test the gathered variant information that's then emitted
       * into shader state. Some known problems:
       * - parsing from assembly will lack constant data that's filled
       *   in ir3_nir_lower_load_constant during compilation
       * - parsing from assembly will also lack metadata (e.g. writemasks)
       *   that's used to determine register footprint
       */
      ralloc_free(rt_v);
   }

   /* no need to keep the ir around beyond this point: */
   ir3_destroy(v->ir);
   v->ir = NULL;

   return true;
}

/*
 * For creating normal shader variants, 'nonbinning' is NULL.  For
 * creating binning pass shader, it is link to corresponding normal
 * (non-binning) variant.
 */
static struct ir3_shader_variant *
alloc_variant(struct ir3_shader *shader, const struct ir3_shader_key *key,
              struct ir3_shader_variant *nonbinning, void *mem_ctx)
{
   /* hang the binning variant off it's non-binning counterpart instead
    * of the shader, to simplify the error cleanup paths
    */
   if (nonbinning)
      mem_ctx = nonbinning;
   struct ir3_shader_variant *v = rzalloc_size(mem_ctx, sizeof(*v));

   if (!v)
      return NULL;

   v->id = ++shader->variant_count;
   v->shader = shader;
   v->shader_id = shader->id;
   v->binning_pass = !!nonbinning;
   v->nonbinning = nonbinning;
   v->key = *key;
   v->type = shader->type;
   v->compiler = shader->compiler;
   v->mergedregs = shader->compiler->mergedregs;
   v->stream_output = shader->stream_output;

   v->name = ralloc_strdup(v, shader->nir->info.name);

   struct shader_info *info = &shader->nir->info;
   switch (v->type) {
   case MESA_SHADER_TESS_CTRL:
   case MESA_SHADER_TESS_EVAL:
      v->tess.primitive_mode = info->tess._primitive_mode;
      v->tess.tcs_vertices_out = info->tess.tcs_vertices_out;
      v->tess.spacing = info->tess.spacing;
      v->tess.ccw = info->tess.ccw;
      v->tess.point_mode = info->tess.point_mode;
      break;

   case MESA_SHADER_GEOMETRY:
      v->gs.output_primitive = info->gs.output_primitive;
      v->gs.vertices_out = info->gs.vertices_out;
      v->gs.invocations = info->gs.invocations;
      v->gs.vertices_in = info->gs.vertices_in;
      break;

   case MESA_SHADER_FRAGMENT:
      v->fs.early_fragment_tests = info->fs.early_fragment_tests;
      v->fs.color_is_dual_source = info->fs.color_is_dual_source;
      v->fs.uses_fbfetch_output  = info->fs.uses_fbfetch_output;
      v->fs.fbfetch_coherent     = info->fs.fbfetch_coherent;
      break;

   case MESA_SHADER_COMPUTE:
   case MESA_SHADER_KERNEL:
      v->cs.req_local_mem = shader->cs.req_local_mem;
      break;

   default:
      break;
   }

   v->num_ssbos = info->num_ssbos;
   v->num_uavs = info->num_ssbos + info->num_images;
   v->shader_options = shader->options;

   if (!v->binning_pass) {
      v->const_state = rzalloc_size(v, sizeof(*v->const_state));
      v->const_state->allocs = shader->options.const_allocs;
      v->const_state->push_consts_type = shader->options.push_consts_type;
      v->const_state->consts_ubo.idx = -1;
      v->const_state->driver_params_ubo.idx = -1;
      v->const_state->primitive_map_ubo.idx = -1;
      v->const_state->primitive_param_ubo.idx = -1;
   }

   return v;
}

static bool
needs_binning_variant(struct ir3_shader_variant *v)
{
   if ((v->type == MESA_SHADER_VERTEX) && ir3_has_binning_vs(&v->key))
      return true;
   return false;
}

static struct ir3_shader_variant *
create_variant(struct ir3_shader *shader, const struct ir3_shader_key *key,
               bool write_disasm, void *mem_ctx)
{
   struct ir3_shader_variant *v = alloc_variant(shader, key, NULL, mem_ctx);

   if (!v)
      goto fail;

   v->disasm_info.write_disasm = write_disasm;

   if (needs_binning_variant(v)) {
      v->binning = alloc_variant(shader, key, v, mem_ctx);
      if (!v->binning)
         goto fail;
      v->binning->disasm_info.write_disasm = write_disasm;
   }

   if (ir3_disk_cache_retrieve(shader, v))
      return v;

   if (!shader->nir_finalized) {
      ir3_nir_post_finalize(shader);

      if (ir3_shader_debug & IR3_DBG_DISASM) {
         mesa_logi("dump nir%d: type=%d", shader->id, shader->type);
         nir_log_shaderi(shader->nir);
      }

      if (v->disasm_info.write_disasm) {
         v->disasm_info.nir = nir_shader_as_str(shader->nir, v);
      }

      shader->nir_finalized = true;
   }

   if (v->type == MESA_SHADER_COMPUTE ||
       v->type == MESA_SHADER_KERNEL) {
      v->cs.force_linear_dispatch = shader->cs.force_linear_dispatch;

      v->local_size[0] = shader->nir->info.workgroup_size[0];
      v->local_size[1] = shader->nir->info.workgroup_size[1];
      v->local_size[2] = shader->nir->info.workgroup_size[2];
      v->local_size_variable = shader->nir->info.workgroup_size_variable;
   }

   struct ir3_const_state *const_state = ir3_const_state_mut(v);
   const_state->num_app_ubos = MAX2(1, shader->nir->info.num_ubos);

   if (!compile_variant(shader, v))
      goto fail;

   if (needs_binning_variant(v) && !compile_variant(shader, v->binning))
      goto fail;

   ir3_disk_cache_store(shader, v);

   return v;

fail:
   ralloc_free(v);
   return NULL;
}

struct ir3_shader_variant *
ir3_shader_create_variant(struct ir3_shader *shader,
                          const struct ir3_shader_key *key,
                          bool keep_ir)
{
   return create_variant(shader, key, keep_ir, NULL);
}

static inline struct ir3_shader_variant *
shader_variant(struct ir3_shader *shader, const struct ir3_shader_key *key)
{
   struct ir3_shader_variant *v;

   for (v = shader->variants; v; v = v->next)
      if (ir3_shader_key_equal(key, &v->key))
         return v;

   return NULL;
}

struct ir3_shader_variant *
ir3_shader_get_variant(struct ir3_shader *shader,
                       const struct ir3_shader_key *key, bool binning_pass,
                       bool write_disasm, bool *created)
{
   MESA_TRACE_FUNC();

   mtx_lock(&shader->variants_lock);
   struct ir3_shader_variant *v = shader_variant(shader, key);

   if (!v) {
      /* compile new variant if it doesn't exist already: */
      v = create_variant(shader, key, write_disasm, shader);
      if (v) {
         v->next = shader->variants;
         shader->variants = v;
         *created = true;
      }
   }

   if (v && binning_pass) {
      v = v->binning;
      assert(v);
   }

   mtx_unlock(&shader->variants_lock);

   return v;
}

struct ir3_shader *
ir3_shader_passthrough_tcs(struct ir3_shader *vs, unsigned patch_vertices)
{
   assert(vs->type == MESA_SHADER_VERTEX);
   assert(patch_vertices > 0);
   assert(patch_vertices <= 32);

   unsigned n = patch_vertices - 1;
   if (!vs->vs.passthrough_tcs[n]) {
      const nir_shader_compiler_options *options =
            ir3_get_compiler_options(vs->compiler);
      nir_shader *tcs =
            nir_create_passthrough_tcs(options, vs->nir, patch_vertices);

      /* Technically it is an internal shader but it is confusing to
       * not have it show up in debug output
       */
      tcs->info.internal = false;

      nir_assign_io_var_locations(tcs, nir_var_shader_in);
      nir_assign_io_var_locations(tcs, nir_var_shader_out);

      NIR_PASS(_, tcs, nir_lower_system_values);

      nir_shader_gather_info(tcs, nir_shader_get_entrypoint(tcs));

      struct ir3_shader_options ir3_options = {};

      ir3_finalize_nir(vs->compiler, &ir3_options.nir_options, tcs);

      vs->vs.passthrough_tcs[n] =
            ir3_shader_from_nir(vs->compiler, tcs, &ir3_options, NULL);

      vs->vs.passthrough_tcs_compiled |= BITFIELD_BIT(n);
   }

   return vs->vs.passthrough_tcs[n];
}

void
ir3_shader_destroy(struct ir3_shader *shader)
{
   if (shader->type == MESA_SHADER_VERTEX) {
      u_foreach_bit (b, shader->vs.passthrough_tcs_compiled) {
         ir3_shader_destroy(shader->vs.passthrough_tcs[b]);
      }
   }
   ralloc_free(shader->nir);
   mtx_destroy(&shader->variants_lock);
   ralloc_free(shader);
}

/**
 * Creates a bitmask of the used bits of the shader key by this particular
 * shader.  Used by the gallium driver to skip state-dependent recompiles when
 * possible.
 */
static void
ir3_setup_used_key(struct ir3_shader *shader)
{
   nir_shader *nir = shader->nir;
   struct shader_info *info = &nir->info;
   struct ir3_shader_key *key = &shader->key_mask;

   /* This key flag is just used to make for a cheaper ir3_shader_key_equal
    * check in the common case.
    */
   key->has_per_samp = true;

   key->safe_constlen = true;

   /* When clip/cull distances are natively supported, we only use
    * ucp_enables to determine whether to lower legacy clip planes to
    * gl_ClipDistance.
    */
   if (info->stage != MESA_SHADER_COMPUTE && (info->stage != MESA_SHADER_FRAGMENT || !shader->compiler->has_clip_cull))
      key->ucp_enables = 0xff;

   if (info->stage == MESA_SHADER_FRAGMENT) {
      key->fastc_srgb = ~0;
      key->fsamples = ~0;
      memset(key->fsampler_swizzles, 0xff, sizeof(key->fsampler_swizzles));

      if (info->inputs_read & VARYING_BITS_COLOR) {
         key->rasterflat = true;
      }

      /* Only used for deciding on behavior of
       * nir_intrinsic_load_barycentric_sample and the centroid demotion
       * on older HW.
       */
      key->msaa = shader->compiler->gen < 6 &&
                  (info->fs.uses_sample_qualifier ||
                   (BITSET_TEST(info->system_values_read,
                                SYSTEM_VALUE_BARYCENTRIC_PERSP_CENTROID) ||
                    BITSET_TEST(info->system_values_read,
                                SYSTEM_VALUE_BARYCENTRIC_LINEAR_CENTROID)));

      /* Only enable this shader key bit if "dual_color_blend_by_location" is
       * enabled:
       */
      key->force_dual_color_blend = shader->compiler->options.dual_color_blend_by_location;
   } else if (info->stage == MESA_SHADER_COMPUTE) {
      key->fastc_srgb = ~0;
      key->fsamples = ~0;
      memset(key->fsampler_swizzles, 0xff, sizeof(key->fsampler_swizzles));
   } else {
      key->tessellation = ~0;
      key->has_gs = true;

      if (info->stage == MESA_SHADER_VERTEX) {
         key->vastc_srgb = ~0;
         key->vsamples = ~0;
         memset(key->vsampler_swizzles, 0xff, sizeof(key->vsampler_swizzles));
      }

      if (info->stage == MESA_SHADER_TESS_CTRL)
         key->tcs_store_primid = true;
   }
}

/* Given an array of constlen's, decrease some of them so that the sum stays
 * within "combined_limit" while trying to fairly share the reduction. Returns
 * a bitfield of which stages should be trimmed.
 */
static uint32_t
trim_constlens(unsigned *constlens, unsigned first_stage, unsigned last_stage,
               unsigned combined_limit, unsigned safe_limit)
{
   unsigned cur_total = 0;
   for (unsigned i = first_stage; i <= last_stage; i++) {
      cur_total += constlens[i];
   }

   uint32_t trimmed = 0;

   while (cur_total > combined_limit) {
      unsigned max_stage = 0;
      unsigned max_const = 0;

      for (unsigned i = first_stage; i <= last_stage; i++) {
         if (constlens[i] >= max_const) {
            max_stage = i;
            max_const = constlens[i];
         }
      }

      assert(max_const > safe_limit);
      trimmed |= 1 << max_stage;
      cur_total = cur_total - max_const + safe_limit;
      constlens[max_stage] = safe_limit;
   }

   return trimmed;
}

/* Figures out which stages in the pipeline to use the "safe" constlen for, in
 * order to satisfy all shared constlen limits.
 */
uint32_t
ir3_trim_constlen(const struct ir3_shader_variant **variants,
                  const struct ir3_compiler *compiler)
{
   unsigned constlens[MESA_SHADER_STAGES] = {};

   bool shared_consts_enable = false;

   for (unsigned i = 0; i < MESA_SHADER_STAGES; i++) {
      if (variants[i]) {
         constlens[i] = variants[i]->constlen;
         shared_consts_enable =
            ir3_const_state(variants[i])->push_consts_type == IR3_PUSH_CONSTS_SHARED;
      }
   }

   uint32_t trimmed = 0;
   STATIC_ASSERT(MESA_SHADER_STAGES <= 8 * sizeof(trimmed));

   /* Use a hw quirk for geometry shared consts, not matched with actual
    * shared consts size (on a6xx).
    */
   uint32_t shared_consts_size_geom = shared_consts_enable ?
      compiler->geom_shared_consts_size_quirk : 0;

   uint32_t shared_consts_size = shared_consts_enable ?
      compiler->shared_consts_size : 0;

   uint32_t safe_shared_consts_size = shared_consts_enable  ?
      ALIGN_POT(MAX2(DIV_ROUND_UP(shared_consts_size_geom, 4),
                     DIV_ROUND_UP(shared_consts_size, 5)), 4) : 0;

   /* There are two shared limits to take into account, the geometry limit on
    * a6xx and the total limit. The frag limit on a6xx only matters for a
    * single stage, so it's always satisfied with the first variant.
    */
   if (compiler->gen >= 6) {
      trimmed |=
         trim_constlens(constlens, MESA_SHADER_VERTEX, MESA_SHADER_GEOMETRY,
                        compiler->max_const_geom - shared_consts_size_geom,
                        compiler->max_const_safe - safe_shared_consts_size);
   }
   trimmed |=
      trim_constlens(constlens, MESA_SHADER_VERTEX, MESA_SHADER_FRAGMENT,
                     compiler->max_const_pipeline - shared_consts_size,
                     compiler->max_const_safe - safe_shared_consts_size);

   return trimmed;
}

struct ir3_shader *
ir3_shader_from_nir(struct ir3_compiler *compiler, nir_shader *nir,
                    const struct ir3_shader_options *options,
                    struct ir3_stream_output_info *stream_output)
{
   struct ir3_shader *shader = rzalloc_size(NULL, sizeof(*shader));

   mtx_init(&shader->variants_lock, mtx_plain);
   shader->compiler = compiler;
   shader->id = p_atomic_inc_return(&shader->compiler->shader_count);
   shader->type = nir->info.stage;
   if (stream_output)
      memcpy(&shader->stream_output, stream_output,
             sizeof(shader->stream_output));
   shader->options = *options;
   shader->nir = nir;

   ir3_disk_cache_init_shader_key(compiler, shader);

   ir3_setup_used_key(shader);

   return shader;
}

static void
dump_reg(FILE *out, const char *name, uint32_t r)
{
   if (r != regid(63, 0)) {
      const char *reg_type = (r & HALF_REG_ID) ? "hr" : "r";
      fprintf(out, "; %s: %s%d.%c\n", name, reg_type, (r & ~HALF_REG_ID) >> 2,
              "xyzw"[r & 0x3]);
   }
}

static void
dump_output(FILE *out, struct ir3_shader_variant *so, unsigned slot,
            const char *name)
{
   uint32_t regid;
   regid = ir3_find_output_regid(so, slot);
   dump_reg(out, name, regid);
}

static const char *
input_name(struct ir3_shader_variant *so, int i)
{
   if (so->inputs[i].sysval) {
      return gl_system_value_name(so->inputs[i].slot);
   } else if (so->type == MESA_SHADER_VERTEX) {
      return gl_vert_attrib_name(so->inputs[i].slot);
   } else {
      return gl_varying_slot_name_for_stage(so->inputs[i].slot, so->type);
   }
}

static const char *
output_name(struct ir3_shader_variant *so, int i)
{
   if (so->type == MESA_SHADER_FRAGMENT) {
      return gl_frag_result_name(so->outputs[i].slot);
   } else {
      switch (so->outputs[i].slot) {
      case VARYING_SLOT_GS_HEADER_IR3:
         return "GS_HEADER";
      case VARYING_SLOT_GS_VERTEX_FLAGS_IR3:
         return "GS_VERTEX_FLAGS";
      case VARYING_SLOT_TCS_HEADER_IR3:
         return "TCS_HEADER";
      default:
         return gl_varying_slot_name_for_stage(so->outputs[i].slot, so->type);
      }
   }
}

static const char *
ir3_const_alloc_type_to_string(enum ir3_const_alloc_type type)
{
   switch (type) {
   case IR3_CONST_ALLOC_PUSH_CONSTS:
      return "push_consts";
   case IR3_CONST_ALLOC_DYN_DESCRIPTOR_OFFSET:
      return "dyn_descriptor_offset";
   case IR3_CONST_ALLOC_INLINE_UNIFORM_ADDRS:
      return "inline_uniform_addresses";
   case IR3_CONST_ALLOC_DRIVER_PARAMS:
      return "driver_params";
   case IR3_CONST_ALLOC_UBO_RANGES:
      return "ubo_ranges";
   case IR3_CONST_ALLOC_PREAMBLE:
      return "preamble";
   case IR3_CONST_ALLOC_GLOBAL:
      return "global";
   case IR3_CONST_ALLOC_UBO_PTRS:
      return "ubo_ptrs";
   case IR3_CONST_ALLOC_IMAGE_DIMS:
      return "image_dims";
   case IR3_CONST_ALLOC_TFBO:
      return "tfbo";
   case IR3_CONST_ALLOC_PRIMITIVE_PARAM:
      return "primitive_param";
   case IR3_CONST_ALLOC_PRIMITIVE_MAP:
      return "primitive_map";
   default:
      return "unknown";
   }
}

static void
dump_const_state(struct ir3_shader_variant *so, FILE *out)
{
   const struct ir3_const_state *cs = ir3_const_state(so);
   const struct ir3_ubo_analysis_state *us = &cs->ubo_state;

   fprintf(out, "; num_ubos:           %u\n", cs->num_ubos);
   fprintf(out, "; num_driver_params:  %u\n", cs->num_driver_params);
   fprintf(out, "; offsets:\n");

   for (uint32_t i = 0; i < IR3_CONST_ALLOC_MAX; i++) {
      if (cs->allocs.consts[i].size_vec4) {
         fprintf(out, ";   %-26s c%u.x (%u vec4)\n",
                 ir3_const_alloc_type_to_string(i),
                 cs->allocs.consts[i].offset_vec4,
                 cs->allocs.consts[i].size_vec4);
      }
   }

   fprintf(out, "; ubo_state:\n");
   fprintf(out, ";   num_enabled:      %u\n", us->num_enabled);
   for (unsigned i = 0; i < us->num_enabled; i++) {
      const struct ir3_ubo_range *r = &us->range[i];

      assert((r->offset % 16) == 0);

      fprintf(out, ";   range[%u]:\n", i);
      fprintf(out, ";     block:          %u\n", r->ubo.block);
      if (r->ubo.bindless)
         fprintf(out, ";     bindless_base:  %u\n", r->ubo.bindless_base);
      fprintf(out, ";     offset:         c%u.x\n", r->offset/16);

      unsigned size = r->end - r->start;
      assert((size % 16) == 0);

      fprintf(out, ";     size:           %u vec4 (%ub -> %ub)\n", (size/16), r->start, r->end);
   }
}

static uint8_t
find_input_reg_id(struct ir3_shader_variant *so, uint32_t input_idx)
{
   uint8_t reg = so->inputs[input_idx].regid;
   if (so->type != MESA_SHADER_FRAGMENT || !so->ir || VALIDREG(reg))
      return reg;

   reg = INVALID_REG;

   /* In FS we don't know into which register the input is loaded
    * until the shader is scanned for the input load instructions.
    */
   foreach_block (block, &so->ir->block_list) {
      foreach_instr_safe (instr, &block->instr_list) {
         if (instr->opc == OPC_FLAT_B || instr->opc == OPC_BARY_F ||
             instr->opc == OPC_LDLV) {
            if (instr->srcs[0]->flags & IR3_REG_IMMED) {
               unsigned inloc = so->inputs[input_idx].inloc;
               unsigned instr_inloc = instr->srcs[0]->uim_val;
               unsigned size = util_bitcount(so->inputs[input_idx].compmask);

               if (instr_inloc == inloc) {
                  return instr->dsts[0]->num;
               }

               if (instr_inloc > inloc && instr_inloc < (inloc + size)) {
                  reg = MIN2(reg, instr->dsts[0]->num);
               }

               if (instr->dsts[0]->flags & IR3_REG_EI) {
                  return reg;
               }
            }
         }
      }
   }

   return reg;
}

void
print_raw(FILE *out, const BITSET_WORD *data, size_t size) {
   fprintf(out, "raw 0x%X%X\n", data[0], data[1]);
}

static void
pre_instr_cb(void *d, unsigned n, void *instr)
{
   struct ir3_disasm_options *options = d;

   if (options->print_raw) {
      uint32_t *dwords = instr;
      fprintf(options->out, "%3d[%08x_%08x] ", n, dwords[1], dwords[0]);
   }
}

void
ir3_shader_disasm_options(struct ir3_shader_variant *so, uint32_t *bin,
                          struct ir3_disasm_options *options)
{
   FILE *out = options->out;
   struct ir3 *ir = so->ir;
   struct ir3_register *reg;
   const char *type = ir3_shader_stage(so);
   uint8_t regid;
   unsigned i;

   dump_const_state(so, out);

   foreach_input_n (instr, i, ir) {
      reg = instr->dsts[0];
      regid = reg->num;
      fprintf(out, "@in(%sr%d.%c)\tin%d",
              (reg->flags & IR3_REG_HALF) ? "h" : "", (regid >> 2),
              "xyzw"[regid & 0x3], i);
      fprintf(out, " (wrmask=0x%x)", reg->wrmask);
      fprintf(out, "\n");
   }

   /* print pre-dispatch texture fetches: */
   for (i = 0; i < so->num_sampler_prefetch; i++) {
      const struct ir3_sampler_prefetch *fetch = &so->sampler_prefetch[i];
      fprintf(out,
              "@tex(%sr%d.%c)\tsrc=%u, bindless=%u, samp=%u, tex=%u, wrmask=0x%x, opc=%s\n",
              fetch->half_precision ? "h" : "", fetch->dst >> 2,
              "xyzw"[fetch->dst & 0x3], fetch->src, fetch->bindless,
              fetch->bindless ? fetch->samp_bindless_id : fetch->samp_id,
              fetch->bindless ? fetch->tex_bindless_id : fetch->tex_id,
              fetch->wrmask, disasm_a3xx_instr_name(fetch->tex_opc));
   }

   const struct ir3_const_state *const_state = ir3_const_state(so);
   const struct ir3_imm_const_state *imm_state = &so->imm_state;
   for (i = 0; i < DIV_ROUND_UP(imm_state->count, 4); i++) {
      fprintf(out, "@const(c%d.x)\t",
              const_state->allocs.max_const_offset_vec4 + i);
      fprintf(out, "0x%08x, 0x%08x, 0x%08x, 0x%08x\n",
              imm_state->values[i * 4 + 0],
              imm_state->values[i * 4 + 1],
              imm_state->values[i * 4 + 2],
              imm_state->values[i * 4 + 3]);
   }

   ir3_isa_disasm(bin, so->info.sizedwords * 4, out,
                  &(struct isa_decode_options){
                     .gpu_id = ir->compiler->gen * 100,
                     .show_errors = true,
                     .branch_labels = true,
                     .no_match_cb = print_raw,
                     .pre_instr_cb = pre_instr_cb,
                     .cbdata = options,
                  });

   fprintf(out, "; %s: outputs:", type);
   for (i = 0; i < so->outputs_count; i++) {
      uint8_t regid = so->outputs[i].regid;
      const char *reg_type = so->outputs[i].half ? "hr" : "r";
      fprintf(out, " %s%d.%c (%s)", reg_type, (regid >> 2), "xyzw"[regid & 0x3],
              output_name(so, i));
   }
   fprintf(out, "\n");

   fprintf(out, "; %s: inputs:", type);
   for (i = 0; i < so->inputs_count; i++) {
      uint8_t regid = find_input_reg_id(so, i);

      fprintf(out, " r%d.%c (%s slot=%d cm=%x,il=%u,b=%u)", (regid >> 2),
              "xyzw"[regid & 0x3], input_name(so, i), so -> inputs[i].slot,
              so->inputs[i].compmask, so->inputs[i].inloc, so->inputs[i].bary);
   }
   fprintf(out, "\n");

   /* print generic shader info: */
   fprintf(
      out,
      "; %s prog %d/%d: %u instr, %u nops, %u non-nops, %u mov, %u cov, %u dwords\n",
      type, so->shader_id, so->id, so->info.instrs_count, so->info.nops_count,
      so->info.instrs_count - so->info.nops_count, so->info.mov_count,
      so->info.cov_count, so->info.sizedwords);

   fprintf(out,
           "; %s prog %d/%d: %u last-baryf, %u last-helper, %d half, %d full, %u constlen\n",
           type, so->shader_id, so->id, so->info.last_baryf,
           so->info.last_helper, so->info.max_half_reg + 1,
           so->info.max_reg + 1, so->constlen);

   fprintf(
      out,
      "; %s prog %d/%d: %u cat0, %u cat1, %u cat2, %u cat3, %u cat4, %u cat5, %u cat6, %u cat7\n",
      type, so->shader_id, so->id, so->info.instrs_per_cat[0],
      so->info.instrs_per_cat[1], so->info.instrs_per_cat[2],
      so->info.instrs_per_cat[3], so->info.instrs_per_cat[4],
      so->info.instrs_per_cat[5], so->info.instrs_per_cat[6],
      so->info.instrs_per_cat[7]);

   fprintf(
      out,
      "; %s prog %d/%d: %u sstall, %u (ss), %u systall, %u (sy), %d loops\n",
      type, so->shader_id, so->id, so->info.sstall, so->info.ss,
      so->info.systall, so->info.sy, so->loops);

   fprintf(
      out,
      "; %s prog %d/%d: %u max_waves, %u double_threadsize\n",
      type, so->shader_id, so->id, so->info.max_waves, so->info.double_threadsize);

   if (so->info.preamble_instrs_count) {
      fprintf(
         out, "; %u preamble-instr, %d early-preamble\n",
         so->info.preamble_instrs_count, so->info.early_preamble);
   }

   /* print shader type specific info: */
   switch (so->type) {
   case MESA_SHADER_VERTEX:
      dump_output(out, so, VARYING_SLOT_POS, "pos");
      dump_output(out, so, VARYING_SLOT_PSIZ, "psize");
      dump_output(out, so, VARYING_SLOT_PRIMITIVE_SHADING_RATE, "shading_rate");
      break;
   case MESA_SHADER_FRAGMENT:
      dump_reg(out, "pos (ij_pixel)",
               ir3_find_sysval_regid(so, SYSTEM_VALUE_BARYCENTRIC_PERSP_PIXEL));
      dump_reg(
         out, "pos (ij_centroid)",
         ir3_find_sysval_regid(so, SYSTEM_VALUE_BARYCENTRIC_PERSP_CENTROID));
      dump_reg(out, "pos (center_rhw)",
               ir3_find_sysval_regid(so, SYSTEM_VALUE_BARYCENTRIC_PERSP_CENTER_RHW));
      dump_output(out, so, FRAG_RESULT_DEPTH, "posz");
      if (so->color0_mrt) {
         dump_output(out, so, FRAG_RESULT_COLOR, "color");
      } else {
         dump_output(out, so, FRAG_RESULT_DATA0, "data0");
         dump_output(out, so, FRAG_RESULT_DATA1, "data1");
         dump_output(out, so, FRAG_RESULT_DATA2, "data2");
         dump_output(out, so, FRAG_RESULT_DATA3, "data3");
         dump_output(out, so, FRAG_RESULT_DATA4, "data4");
         dump_output(out, so, FRAG_RESULT_DATA5, "data5");
         dump_output(out, so, FRAG_RESULT_DATA6, "data6");
         dump_output(out, so, FRAG_RESULT_DATA7, "data7");
      }
      dump_reg(out, "fragcoord",
               ir3_find_sysval_regid(so, SYSTEM_VALUE_FRAG_COORD));
      dump_reg(out, "fragface",
               ir3_find_sysval_regid(so, SYSTEM_VALUE_FRONT_FACE));
      break;
   default:
      /* TODO */
      break;
   }

   fprintf(out, "\n");
}

void
ir3_shader_disasm(struct ir3_shader_variant *so, uint32_t *bin, FILE *out)
{
   struct ir3_disasm_options options = {
      .out = out,
      .print_raw = false,
   };

   ir3_shader_disasm_options(so, bin, &options);
}

uint64_t
ir3_shader_outputs(const struct ir3_shader *so)
{
   return so->nir->info.outputs_written;
}

void
ir3_shader_get_subgroup_size(const struct ir3_compiler *compiler,
                             const struct ir3_shader_options *options,
                             mesa_shader_stage stage, unsigned *subgroup_size,
                             unsigned *max_subgroup_size)
{
   switch (options->api_wavesize) {
   case IR3_SINGLE_ONLY:
      *subgroup_size = *max_subgroup_size = compiler->threadsize_base;
      break;
   case IR3_DOUBLE_ONLY:
      *subgroup_size = *max_subgroup_size = compiler->threadsize_base * 2;
      break;
   case IR3_SINGLE_OR_DOUBLE:
      /* For vertex stages, we know the wavesize will never be doubled.
       * Lower subgroup_size here, to avoid having to deal with it when
       * translating from NIR. Otherwise use the "real" wavesize obtained as
       * a driver param.
       */
      if (stage != MESA_SHADER_COMPUTE && stage != MESA_SHADER_FRAGMENT) {
         *subgroup_size = *max_subgroup_size = compiler->threadsize_base;
      } else {
         *subgroup_size = 0;
         *max_subgroup_size = compiler->threadsize_base * 2;
      }
      break;
   }
}

/* Add any missing varyings needed for stream-out.  Otherwise varyings not
 * used by fragment shader will be stripped out.
 */
void
ir3_link_stream_out(struct ir3_shader_linkage *l,
                    const struct ir3_shader_variant *v)
{
   const struct ir3_stream_output_info *strmout = &v->stream_output;

   /*
    * First, any stream-out varyings not already in linkage map (ie. also
    * consumed by frag shader) need to be added:
    */
   for (unsigned i = 0; i < strmout->num_outputs; i++) {
      const struct ir3_stream_output *out = &strmout->output[i];
      unsigned k = out->register_index;
      unsigned compmask =
         (1 << (out->num_components + out->start_component)) - 1;
      unsigned idx, nextloc = 0;

      /* psize/pos need to be the last entries in linkage map, and will
       * get added link_stream_out, so skip over them:
       */
      if ((v->outputs[k].slot == VARYING_SLOT_PSIZ) ||
          (v->outputs[k].slot == VARYING_SLOT_POS))
         continue;

      for (idx = 0; idx < l->cnt; idx++) {
         if (l->var[idx].slot == v->outputs[k].slot)
            break;
         nextloc = MAX2(nextloc, l->var[idx].loc + 4);
      }

      /* add if not already in linkage map: */
      if (idx == l->cnt) {
         ir3_link_add(l, v->outputs[k].slot, v->outputs[k].regid,
                      compmask, nextloc);
      }

      /* expand component-mask if needed, ie streaming out all components
       * but frag shader doesn't consume all components:
       */
      if (compmask & ~l->var[idx].compmask) {
         l->var[idx].compmask |= compmask;
         l->max_loc = MAX2(
            l->max_loc, l->var[idx].loc + util_last_bit(l->var[idx].compmask));
      }
   }
}
