src/mesa/drivers/dri/i965/brw_fs.h

   1 /*
   2  * Copyright © 2010 Intel Corporation
   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  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * 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 NONINFRINGEMENT.  IN NO EVENT SHALL
  18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  21  * IN THE SOFTWARE.
  22  *
  23  * Authors:
  24  *    Eric Anholt <eric@anholt.net>
  25  *
  26  */
  27
  28 #pragma once
  29
  30 #include "brw_shader.h"
  31 #include "brw_ir_fs.h"
  32 #include "brw_fs_builder.h"
  33
  34 extern "C" {
  35
  36 #include <sys/types.h>
  37
  38 #include "main/macros.h"
  39 #include "main/shaderobj.h"
  40 #include "main/uniforms.h"
  41 #include "program/prog_parameter.h"
  42 #include "program/prog_print.h"
  43 #include "program/prog_optimize.h"
  44 #include "util/register_allocate.h"
  45 #include "program/hash_table.h"
  46 #include "brw_context.h"
  47 #include "brw_eu.h"
  48 #include "brw_wm.h"
  49 #include "intel_asm_annotation.h"
  50 }
  51 #include "glsl/glsl_types.h"
  52 #include "glsl/ir.h"
  53 #include "glsl/nir/nir.h"
  54 #include "program/sampler.h"
  55
  56 struct bblock_t;
  57 namespace {
  58    struct acp_entry;
  59 }
  60
  61 namespace brw {
  62    class fs_live_variables;
  63 }
  64
  65 static inline fs_reg
  66 offset(fs_reg reg, const brw::fs_builder& bld, unsigned delta)
  67 {
  68    switch (reg.file) {
  69    case BAD_FILE:
  70       break;
  71    case GRF:
  72    case MRF:
  73    case HW_REG:
  74    case ATTR:
  75       return byte_offset(reg,
  76                          delta * reg.component_size(bld.dispatch_width()));
  77    case UNIFORM:
  78       reg.reg_offset += delta;
  79       break;
  80    case IMM:
  81       assert(delta == 0);
  82    }
  83    return reg;
  84 }
  85
  86 /**
  87  * The fragment shader front-end.
  88  *
  89  * Translates either GLSL IR or Mesa IR (for ARB_fragment_program) into FS IR.
  90  */
  91 class fs_visitor : public backend_shader
  92 {
  93 public:
  94    fs_visitor(const struct brw_compiler *compiler, void *log_data,
  95               void *mem_ctx,
  96               gl_shader_stage stage,
  97               const void *key,
  98               struct brw_stage_prog_data *prog_data,
  99               struct gl_shader_program *shader_prog,
 100               struct gl_program *prog,
 101               unsigned dispatch_width,
 102               int shader_time_index);
 103
 104    ~fs_visitor();
 105
 106    fs_reg vgrf(const glsl_type *const type);
 107    void import_uniforms(fs_visitor *v);
 108    void setup_uniform_clipplane_values(gl_clip_plane *clip_planes);
 109    void compute_clip_distance(gl_clip_plane *clip_planes);
 110
 111    uint32_t gather_channel(int orig_chan, uint32_t sampler);
 112    void swizzle_result(ir_texture_opcode op, int dest_components,
 113                        fs_reg orig_val, uint32_t sampler);
 114
 115    int type_size(const struct glsl_type *type);
 116    fs_inst *get_instruction_generating_reg(fs_inst *start,
 117                                            fs_inst *end,
 118                                            const fs_reg &reg);
 119
 120    void VARYING_PULL_CONSTANT_LOAD(const brw::fs_builder &bld,
 121                                    const fs_reg &dst,
 122                                    const fs_reg &surf_index,
 123                                    const fs_reg &varying_offset,
 124                                    uint32_t const_offset);
 125    void DEP_RESOLVE_MOV(const brw::fs_builder &bld, int grf);
 126
 127    bool run_fs(bool do_rep_send);
 128    bool run_vs(gl_clip_plane *clip_planes);
 129    bool run_cs();
 130    void optimize();
 131    void allocate_registers();
 132    void assign_binding_table_offsets();
 133    void setup_payload_gen4();
 134    void setup_payload_gen6();
 135    void setup_vs_payload();
 136    void setup_cs_payload();
 137    void fixup_3src_null_dest();
 138    void assign_curb_setup();
 139    void calculate_urb_setup();
 140    void assign_urb_setup();
 141    void assign_vs_urb_setup();
 142    bool assign_regs(bool allow_spilling);
 143    void assign_regs_trivial();
 144    void setup_payload_interference(struct ra_graph *g, int payload_reg_count,
 145                                    int first_payload_node);
 146    int choose_spill_reg(struct ra_graph *g);
 147    void spill_reg(int spill_reg);
 148    void split_virtual_grfs();
 149    bool compact_virtual_grfs();
 150    void move_uniform_array_access_to_pull_constants();
 151    void assign_constant_locations();
 152    void demote_pull_constants();
 153    void invalidate_live_intervals();
 154    void calculate_live_intervals();
 155    void calculate_register_pressure();
 156    bool opt_algebraic();
 157    bool opt_redundant_discard_jumps();
 158    bool opt_cse();
 159    bool opt_cse_local(bblock_t *block);
 160    bool opt_copy_propagate();
 161    bool try_copy_propagate(fs_inst *inst, int arg, acp_entry *entry);
 162    bool try_constant_propagate(fs_inst *inst, acp_entry *entry);
 163    bool opt_copy_propagate_local(void *mem_ctx, bblock_t *block,
 164                                  exec_list *acp);
 165    bool opt_register_renaming();
 166    bool register_coalesce();
 167    bool compute_to_mrf();
 168    bool eliminate_find_live_channel();
 169    bool dead_code_eliminate();
 170    bool remove_duplicate_mrf_writes();
 171
 172    bool opt_sampler_eot();
 173    bool virtual_grf_interferes(int a, int b);
 174    void schedule_instructions(instruction_scheduler_mode mode);
 175    void insert_gen4_send_dependency_workarounds();
 176    void insert_gen4_pre_send_dependency_workarounds(bblock_t *block,
 177                                                     fs_inst *inst);
 178    void insert_gen4_post_send_dependency_workarounds(bblock_t *block,
 179                                                      fs_inst *inst);
 180    void vfail(const char *msg, va_list args);
 181    void fail(const char *msg, ...);
 182    void no16(const char *msg);
 183    void lower_uniform_pull_constant_loads();
 184    bool lower_load_payload();
 185    bool lower_logical_sends();
 186    bool lower_integer_multiplication();
 187    bool lower_simd_width();
 188    bool opt_combine_constants();
 189
 190    void emit_dummy_fs();
 191    void emit_repclear_shader();
 192    fs_reg *emit_fragcoord_interpolation(bool pixel_center_integer,
 193                                         bool origin_upper_left);
 194    fs_inst *emit_linterp(const fs_reg &attr, const fs_reg &interp,
 195                          glsl_interp_qualifier interpolation_mode,
 196                          bool is_centroid, bool is_sample);
 197    fs_reg *emit_frontfacing_interpolation();
 198    fs_reg *emit_samplepos_setup();
 199    fs_reg *emit_sampleid_setup();
 200    void emit_general_interpolation(fs_reg attr, const char *name,
 201                                    const glsl_type *type,
 202                                    glsl_interp_qualifier interpolation_mode,
 203                                    int location, bool mod_centroid,
 204                                    bool mod_sample);
 205    fs_reg *emit_vs_system_value(int location);
 206    void emit_interpolation_setup_gen4();
 207    void emit_interpolation_setup_gen6();
 208    void compute_sample_position(fs_reg dst, fs_reg int_sample_pos);
 209    fs_reg rescale_texcoord(fs_reg coordinate, int coord_components,
 210                            bool is_rect, uint32_t sampler, int texunit);
 211    fs_inst *emit_texture_gen4(ir_texture_opcode op, fs_reg dst,
 212                               fs_reg coordinate, int coord_components,
 213                               fs_reg shadow_comp,
 214                               fs_reg lod, fs_reg lod2, int grad_components,
 215                               uint32_t sampler);
 216    fs_inst *emit_texture_gen4_simd16(ir_texture_opcode op, fs_reg dst,
 217                                      fs_reg coordinate, int vector_elements,
 218                                      fs_reg shadow_c, fs_reg lod,
 219                                      uint32_t sampler);
 220    fs_inst *emit_texture_gen5(ir_texture_opcode op, fs_reg dst,
 221                               fs_reg coordinate, int coord_components,
 222                               fs_reg shadow_comp,
 223                               fs_reg lod, fs_reg lod2, int grad_components,
 224                               fs_reg sample_index, uint32_t sampler,
 225                               bool has_offset);
 226    fs_inst *emit_texture_gen7(ir_texture_opcode op, fs_reg dst,
 227                               fs_reg coordinate, int coord_components,
 228                               fs_reg shadow_comp,
 229                               fs_reg lod, fs_reg lod2, int grad_components,
 230                               fs_reg sample_index, fs_reg mcs, fs_reg sampler,
 231                               fs_reg offset_value);
 232    void emit_texture(ir_texture_opcode op,
 233                      const glsl_type *dest_type,
 234                      fs_reg coordinate, int components,
 235                      fs_reg shadow_c,
 236                      fs_reg lod, fs_reg dpdy, int grad_components,
 237                      fs_reg sample_index,
 238                      fs_reg offset,
 239                      fs_reg mcs,
 240                      int gather_component,
 241                      bool is_cube_array,
 242                      bool is_rect,
 243                      uint32_t sampler,
 244                      fs_reg sampler_reg,
 245                      int texunit);
 246    fs_reg emit_mcs_fetch(fs_reg coordinate, int components, fs_reg sampler);
 247    void emit_gen6_gather_wa(uint8_t wa, fs_reg dst);
 248    void resolve_source_modifiers(fs_reg *src);
 249    void emit_discard_jump();
 250    bool try_replace_with_sel();
 251    bool opt_peephole_sel();
 252    bool opt_peephole_predicated_break();
 253    bool opt_saturate_propagation();
 254    bool opt_cmod_propagation();
 255    bool opt_zero_samples();
 256    void emit_unspill(bblock_t *block, fs_inst *inst, fs_reg reg,
 257                      uint32_t spill_offset, int count);
 258    void emit_spill(bblock_t *block, fs_inst *inst, fs_reg reg,
 259                    uint32_t spill_offset, int count);
 260
 261    void emit_nir_code();
 262    void nir_setup_inputs(nir_shader *shader);
 263    void nir_setup_outputs(nir_shader *shader);
 264    void nir_setup_uniforms(nir_shader *shader);
 265    void nir_setup_uniform(nir_variable *var);
 266    void nir_setup_builtin_uniform(nir_variable *var);
 267    void nir_emit_system_values(nir_shader *shader);
 268    void nir_emit_impl(nir_function_impl *impl);
 269    void nir_emit_cf_list(exec_list *list);
 270    void nir_emit_if(nir_if *if_stmt);
 271    void nir_emit_loop(nir_loop *loop);
 272    void nir_emit_block(nir_block *block);
 273    void nir_emit_instr(nir_instr *instr);
 274    void nir_emit_alu(const brw::fs_builder &bld, nir_alu_instr *instr);
 275    void nir_emit_load_const(const brw::fs_builder &bld,
 276                             nir_load_const_instr *instr);
 277    void nir_emit_undef(const brw::fs_builder &bld,
 278                        nir_ssa_undef_instr *instr);
 279    void nir_emit_intrinsic(const brw::fs_builder &bld,
 280                            nir_intrinsic_instr *instr);
 281    void nir_emit_texture(const brw::fs_builder &bld,
 282                          nir_tex_instr *instr);
 283    void nir_emit_jump(const brw::fs_builder &bld,
 284                       nir_jump_instr *instr);
 285    fs_reg get_nir_src(nir_src src);
 286    fs_reg get_nir_dest(nir_dest dest);
 287    void emit_percomp(const brw::fs_builder &bld, const fs_inst &inst,
 288                      unsigned wr_mask);
 289
 290    bool optimize_frontfacing_ternary(nir_alu_instr *instr,
 291                                      const fs_reg &result);
 292
 293    void setup_color_payload(fs_reg *dst, fs_reg color, unsigned components,
 294                             unsigned exec_size, bool use_2nd_half);
 295    void emit_alpha_test();
 296    fs_inst *emit_single_fb_write(const brw::fs_builder &bld,
 297                                  fs_reg color1, fs_reg color2,
 298                                  fs_reg src0_alpha, unsigned components,
 299                                  unsigned exec_size, bool use_2nd_half = false);
 300    void emit_fb_writes();
 301    void emit_urb_writes();
 302    void emit_cs_terminate();
 303
 304    void emit_barrier();
 305
 306    void emit_shader_time_begin();
 307    void emit_shader_time_end();
 308    void SHADER_TIME_ADD(const brw::fs_builder &bld,
 309                         int shader_time_subindex,
 310                         fs_reg value);
 311
 312    void emit_untyped_atomic(unsigned atomic_op, unsigned surf_index,
 313                             fs_reg dst, fs_reg offset, fs_reg src0,
 314                             fs_reg src1);
 315
 316    void emit_untyped_surface_read(unsigned surf_index, fs_reg dst,
 317                                   fs_reg offset);
 318
 319    fs_reg get_timestamp(const brw::fs_builder &bld);
 320
 321    struct brw_reg interp_reg(int location, int channel);
 322    int implied_mrf_writes(fs_inst *inst);
 323
 324    virtual void dump_instructions();
 325    virtual void dump_instructions(const char *name);
 326    void dump_instruction(backend_instruction *inst);
 327    void dump_instruction(backend_instruction *inst, FILE *file);
 328
 329    const void *const key;
 330    const struct brw_sampler_prog_key_data *key_tex;
 331
 332    struct brw_stage_prog_data *prog_data;
 333    unsigned int sanity_param_count;
 334
 335    int *param_size;
 336
 337    int *virtual_grf_start;
 338    int *virtual_grf_end;
 339    brw::fs_live_variables *live_intervals;
 340
 341    int *regs_live_at_ip;
 342
 343    /** Number of uniform variable components visited. */
 344    unsigned uniforms;
 345
 346    /** Total number of direct uniforms we can get from NIR */
 347    unsigned num_direct_uniforms;
 348
 349    /** Byte-offset for the next available spot in the scratch space buffer. */
 350    unsigned last_scratch;
 351
 352    /**
 353     * Array mapping UNIFORM register numbers to the pull parameter index,
 354     * or -1 if this uniform register isn't being uploaded as a pull constant.
 355     */
 356    int *pull_constant_loc;
 357
 358    /**
 359     * Array mapping UNIFORM register numbers to the push parameter index,
 360     * or -1 if this uniform register isn't being uploaded as a push constant.
 361     */
 362    int *push_constant_loc;
 363
 364    fs_reg frag_depth;
 365    fs_reg sample_mask;
 366    fs_reg outputs[VARYING_SLOT_MAX];
 367    unsigned output_components[VARYING_SLOT_MAX];
 368    fs_reg dual_src_output;
 369    bool do_dual_src;
 370    int first_non_payload_grf;
 371    /** Either BRW_MAX_GRF or GEN7_MRF_HACK_START */
 372    unsigned max_grf;
 373
 374    fs_reg *nir_locals;
 375    fs_reg *nir_ssa_values;
 376    fs_reg nir_inputs;
 377    fs_reg nir_outputs;
 378    fs_reg *nir_system_values;
 379
 380    bool failed;
 381    char *fail_msg;
 382    bool simd16_unsupported;
 383    char *no16_msg;
 384
 385    /* Result of last visit() method. Still used by emit_texture() */
 386    fs_reg result;
 387
 388    /** Register numbers for thread payload fields. */
 389    struct thread_payload {
 390       uint8_t source_depth_reg;
 391       uint8_t source_w_reg;
 392       uint8_t aa_dest_stencil_reg;
 393       uint8_t dest_depth_reg;
 394       uint8_t sample_pos_reg;
 395       uint8_t sample_mask_in_reg;
 396       uint8_t barycentric_coord_reg[BRW_WM_BARYCENTRIC_INTERP_MODE_COUNT];
 397
 398       /** The number of thread payload registers the hardware will supply. */
 399       uint8_t num_regs;
 400    } payload;
 401
 402    bool source_depth_to_render_target;
 403    bool runtime_check_aads_emit;
 404
 405    fs_reg pixel_x;
 406    fs_reg pixel_y;
 407    fs_reg wpos_w;
 408    fs_reg pixel_w;
 409    fs_reg delta_xy[BRW_WM_BARYCENTRIC_INTERP_MODE_COUNT];
 410    fs_reg shader_start_time;
 411    fs_reg userplane[MAX_CLIP_PLANES];
 412
 413    unsigned grf_used;
 414    bool spilled_any_registers;
 415
 416    const unsigned dispatch_width; /**< 8 or 16 */
 417
 418    int shader_time_index;
 419
 420    unsigned promoted_constants;
 421    brw::fs_builder bld;
 422 };
 423
 424 /**
 425  * The fragment shader code generator.
 426  *
 427  * Translates FS IR to actual i965 assembly code.
 428  */
 429 class fs_generator
 430 {
 431 public:
 432    fs_generator(const struct brw_compiler *compiler, void *log_data,
 433                 void *mem_ctx,
 434                 const void *key,
 435                 struct brw_stage_prog_data *prog_data,
 436                 struct gl_program *fp,
 437                 unsigned promoted_constants,
 438                 bool runtime_check_aads_emit,
 439                 const char *stage_abbrev);
 440    ~fs_generator();
 441
 442    void enable_debug(const char *shader_name);
 443    int generate_code(const cfg_t *cfg, int dispatch_width);
 444    const unsigned *get_assembly(unsigned int *assembly_size);
 445
 446 private:
 447    void fire_fb_write(fs_inst *inst,
 448                       struct brw_reg payload,
 449                       struct brw_reg implied_header,
 450                       GLuint nr);
 451    void generate_fb_write(fs_inst *inst, struct brw_reg payload);
 452    void generate_urb_write(fs_inst *inst, struct brw_reg payload);
 453    void generate_cs_terminate(fs_inst *inst, struct brw_reg payload);
 454    void generate_barrier(fs_inst *inst, struct brw_reg src);
 455    void generate_blorp_fb_write(fs_inst *inst);
 456    void generate_linterp(fs_inst *inst, struct brw_reg dst,
 457                          struct brw_reg *src);
 458    void generate_tex(fs_inst *inst, struct brw_reg dst, struct brw_reg src,
 459                      struct brw_reg sampler_index);
 460    void generate_math_gen6(fs_inst *inst,
 461                            struct brw_reg dst,
 462                            struct brw_reg src0,
 463                            struct brw_reg src1);
 464    void generate_math_gen4(fs_inst *inst,
 465                            struct brw_reg dst,
 466                            struct brw_reg src);
 467    void generate_math_g45(fs_inst *inst,
 468                           struct brw_reg dst,
 469                           struct brw_reg src);
 470    void generate_ddx(enum opcode op, struct brw_reg dst, struct brw_reg src);
 471    void generate_ddy(enum opcode op, struct brw_reg dst, struct brw_reg src,
 472                      bool negate_value);
 473    void generate_scratch_write(fs_inst *inst, struct brw_reg src);
 474    void generate_scratch_read(fs_inst *inst, struct brw_reg dst);
 475    void generate_scratch_read_gen7(fs_inst *inst, struct brw_reg dst);
 476    void generate_uniform_pull_constant_load(fs_inst *inst, struct brw_reg dst,
 477                                             struct brw_reg index,
 478                                             struct brw_reg offset);
 479    void generate_uniform_pull_constant_load_gen7(fs_inst *inst,
 480                                                  struct brw_reg dst,
 481                                                  struct brw_reg surf_index,
 482                                                  struct brw_reg offset);
 483    void generate_varying_pull_constant_load(fs_inst *inst, struct brw_reg dst,
 484                                             struct brw_reg index,
 485                                             struct brw_reg offset);
 486    void generate_varying_pull_constant_load_gen7(fs_inst *inst,
 487                                                  struct brw_reg dst,
 488                                                  struct brw_reg index,
 489                                                  struct brw_reg offset);
 490    void generate_mov_dispatch_to_flags(fs_inst *inst);
 491
 492    void generate_pixel_interpolator_query(fs_inst *inst,
 493                                           struct brw_reg dst,
 494                                           struct brw_reg src,
 495                                           struct brw_reg msg_data,
 496                                           unsigned msg_type);
 497
 498    void generate_set_omask(fs_inst *inst,
 499                            struct brw_reg dst,
 500                            struct brw_reg sample_mask);
 501
 502    void generate_set_sample_id(fs_inst *inst,
 503                                struct brw_reg dst,
 504                                struct brw_reg src0,
 505                                struct brw_reg src1);
 506
 507    void generate_set_simd4x2_offset(fs_inst *inst,
 508                                     struct brw_reg dst,
 509                                     struct brw_reg offset);
 510    void generate_discard_jump(fs_inst *inst);
 511
 512    void generate_pack_half_2x16_split(fs_inst *inst,
 513                                       struct brw_reg dst,
 514                                       struct brw_reg x,
 515                                       struct brw_reg y);
 516    void generate_unpack_half_2x16_split(fs_inst *inst,
 517                                         struct brw_reg dst,
 518                                         struct brw_reg src);
 519
 520    void generate_shader_time_add(fs_inst *inst,
 521                                  struct brw_reg payload,
 522                                  struct brw_reg offset,
 523                                  struct brw_reg value);
 524
 525    bool patch_discard_jumps_to_fb_writes();
 526
 527    const struct brw_compiler *compiler;
 528    void *log_data; /* Passed to compiler->*_log functions */
 529
 530    const struct brw_device_info *devinfo;
 531
 532    struct brw_codegen *p;
 533    const void * const key;
 534    struct brw_stage_prog_data * const prog_data;
 535
 536    const struct gl_program *prog;
 537
 538    unsigned dispatch_width; /**< 8 or 16 */
 539
 540    exec_list discard_halt_patches;
 541    unsigned promoted_constants;
 542    bool runtime_check_aads_emit;
 543    bool debug_flag;
 544    const char *shader_name;
 545    const char *stage_abbrev;
 546    void *mem_ctx;
 547 };
 548
 549 bool brw_do_channel_expressions(struct exec_list *instructions);
 550 bool brw_do_vector_splitting(struct exec_list *instructions);
 551 void brw_setup_tex_for_precompile(struct brw_context *brw,
 552                                   struct brw_sampler_prog_key_data *tex,
 553                                   struct gl_program *prog);