1 /**************************************************************************
3 * Copyright 2011-2012 Advanced Micro Devices, Inc.
4 * Copyright 2009 VMware, Inc.
7 * Permission is hereby granted, free of charge, to any person obtaining a
8 * copy of this software and associated documentation files (the
9 * "Software"), to deal in the Software without restriction, including
10 * without limitation the rights to use, copy, modify, merge, publish,
11 * distribute, sub license, and/or sell copies of the Software, and to
12 * permit persons to whom the Software is furnished to do so, subject to
13 * the following conditions:
15 * The above copyright notice and this permission notice (including the
16 * next paragraph) shall be included in all copies or substantial portions
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
20 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
21 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
22 * IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS BE LIABLE FOR
23 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
24 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
25 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
27 **************************************************************************/
31 * TGSI to LLVM IR translation.
33 * @author Jose Fonseca <jfonseca@vmware.com>
34 * @author Tom Stellard <thomas.stellard@amd.com>
40 #include "gallivm/lp_bld.h"
41 #include "gallivm/lp_bld_tgsi_action.h"
42 #include "gallivm/lp_bld_limits.h"
43 #include "gallivm/lp_bld_sample.h"
44 #include "lp_bld_type.h"
45 #include "pipe/p_compiler.h"
46 #include "pipe/p_state.h"
47 #include "tgsi/tgsi_exec.h"
48 #include "tgsi/tgsi_scan.h"
49 #include "tgsi/tgsi_info.h"
51 #define LP_CHAN_ALL ~0
53 #define LP_MAX_INSTRUCTIONS 256
55 struct tgsi_full_declaration
;
56 struct tgsi_full_immediate
;
57 struct tgsi_full_instruction
;
58 struct tgsi_full_src_register
;
59 struct tgsi_opcode_info
;
61 struct tgsi_shader_info
;
62 struct lp_build_mask_context
;
64 struct lp_derivatives
;
65 struct lp_build_tgsi_gs_iface
;
68 enum lp_build_tex_modifier
{
69 LP_BLD_TEX_MODIFIER_NONE
= 0,
70 LP_BLD_TEX_MODIFIER_PROJECTED
,
71 LP_BLD_TEX_MODIFIER_LOD_BIAS
,
72 LP_BLD_TEX_MODIFIER_EXPLICIT_LOD
,
73 LP_BLD_TEX_MODIFIER_EXPLICIT_DERIV
,
74 LP_BLD_TEX_MODIFIER_LOD_ZERO
79 * Describe a channel of a register.
82 * - immediate value (i.e. derived from a IMM register)
85 * - undetermined (when .file == TGSI_FILE_NULL)
87 * This is one of the analysis results, and is used to described
88 * the output color in terms of inputs.
90 struct lp_tgsi_channel_info
92 unsigned file
:4; /* TGSI_FILE_* */
93 unsigned swizzle
:3; /* PIPE_SWIZZLE_x */
96 float value
; /* for TGSI_FILE_IMMEDIATE */
102 * Describe a texture sampler interpolator.
104 * The interpolation is described in terms of regular inputs.
106 struct lp_tgsi_texture_info
108 struct lp_tgsi_channel_info coord
[4];
109 unsigned target
:8; /* TGSI_TEXTURE_* */
110 unsigned sampler_unit
:8; /* Sampler unit */
111 unsigned texture_unit
:8; /* Texture unit */
112 unsigned modifier
:8; /* LP_BLD_TEX_MODIFIER_* */
118 struct tgsi_shader_info base
;
121 * Whether any of the texture opcodes access a register file other than
124 * We could also handle TGSI_FILE_CONST/IMMEDIATE here, but there is little
127 unsigned indirect_textures
:1;
130 * Whether any immediate values are outside the range of 0 and 1
132 unsigned unclamped_immediates
:1;
135 * Texture opcode description. Aimed at detecting and described direct
139 struct lp_tgsi_texture_info tex
[PIPE_MAX_SAMPLERS
];
142 * Output description. Aimed at detecting and describing simple blit
145 struct lp_tgsi_channel_info output
[PIPE_MAX_SHADER_OUTPUTS
][4];
148 * Shortcut pointers into the above (for fragment shaders).
150 const struct lp_tgsi_channel_info
*cbuf
[PIPE_MAX_COLOR_BUFS
];
154 * Reference to system values.
156 struct lp_bld_tgsi_system_values
{
157 LLVMValueRef instance_id
;
158 LLVMValueRef vertex_id
;
159 LLVMValueRef prim_id
;
164 * Sampler code generation interface.
166 * Although texture sampling is a requirement for TGSI translation, it is
167 * a very different problem with several different approaches to it. This
168 * structure establishes an interface for texture sampling code generation, so
169 * that we can easily use different texture sampling strategies.
171 struct lp_build_sampler_soa
174 (*destroy
)( struct lp_build_sampler_soa
*sampler
);
177 (*emit_fetch_texel
)( const struct lp_build_sampler_soa
*sampler
,
178 struct gallivm_state
*gallivm
,
181 unsigned texture_index
,
182 unsigned sampler_index
,
183 const LLVMValueRef
*coords
,
184 const LLVMValueRef
*offsets
,
185 const struct lp_derivatives
*derivs
,
186 LLVMValueRef lod_bias
, /* optional */
187 LLVMValueRef explicit_lod
, /* optional */
188 enum lp_sampler_lod_property
,
189 LLVMValueRef
*texel
);
192 (*emit_size_query
)( const struct lp_build_sampler_soa
*sampler
,
193 struct gallivm_state
*gallivm
,
197 boolean need_nr_mips
,
198 enum lp_sampler_lod_property
,
199 LLVMValueRef explicit_lod
, /* optional */
200 LLVMValueRef
*sizes_out
);
204 struct lp_build_sampler_aos
207 (*emit_fetch_texel
)( struct lp_build_sampler_aos
*sampler
,
208 struct lp_build_context
*bld
,
209 unsigned target
, /* TGSI_TEXTURE_* */
212 const struct lp_derivatives derivs
,
213 enum lp_build_tex_modifier modifier
);
218 lp_build_tgsi_info(const struct tgsi_token
*tokens
,
219 struct lp_tgsi_info
*info
);
223 lp_build_tgsi_soa(struct gallivm_state
*gallivm
,
224 const struct tgsi_token
*tokens
,
226 struct lp_build_mask_context
*mask
,
227 LLVMValueRef consts_ptr
,
228 const struct lp_bld_tgsi_system_values
*system_values
,
229 const LLVMValueRef (*inputs
)[4],
230 LLVMValueRef (*outputs
)[4],
231 struct lp_build_sampler_soa
*sampler
,
232 const struct tgsi_shader_info
*info
,
233 const struct lp_build_tgsi_gs_iface
*gs_iface
);
237 lp_build_tgsi_aos(struct gallivm_state
*gallivm
,
238 const struct tgsi_token
*tokens
,
240 const unsigned char swizzles
[4],
241 LLVMValueRef consts_ptr
,
242 const LLVMValueRef
*inputs
,
243 LLVMValueRef
*outputs
,
244 struct lp_build_sampler_aos
*sampler
,
245 const struct tgsi_shader_info
*info
);
248 enum lp_exec_mask_break_type
{
249 LP_EXEC_MASK_BREAK_TYPE_LOOP
,
250 LP_EXEC_MASK_BREAK_TYPE_SWITCH
254 struct lp_exec_mask
{
255 struct lp_build_context
*bld
;
260 LLVMTypeRef int_vec_type
;
262 LLVMValueRef cond_stack
[LP_MAX_TGSI_NESTING
];
264 LLVMValueRef cond_mask
;
266 /* keep track if break belongs to switch or loop */
267 enum lp_exec_mask_break_type break_type_stack
[LP_MAX_TGSI_NESTING
];
268 enum lp_exec_mask_break_type break_type
;
271 LLVMValueRef switch_val
;
272 LLVMValueRef switch_mask
;
273 LLVMValueRef switch_mask_default
;
274 boolean switch_in_default
;
276 } switch_stack
[LP_MAX_TGSI_NESTING
];
277 int switch_stack_size
;
278 LLVMValueRef switch_val
;
279 LLVMValueRef switch_mask
; /* current switch exec mask */
280 LLVMValueRef switch_mask_default
; /* reverse of switch mask used for default */
281 boolean switch_in_default
; /* if switch exec is currently in default */
282 unsigned switch_pc
; /* when used points to default or endswitch-1 */
284 LLVMBasicBlockRef loop_block
;
285 LLVMValueRef cont_mask
;
286 LLVMValueRef break_mask
;
287 LLVMValueRef break_var
;
289 LLVMBasicBlockRef loop_block
;
290 LLVMValueRef cont_mask
;
291 LLVMValueRef break_mask
;
292 LLVMValueRef break_var
;
293 } loop_stack
[LP_MAX_TGSI_NESTING
];
296 LLVMValueRef ret_mask
;
299 LLVMValueRef ret_mask
;
300 } call_stack
[LP_MAX_TGSI_NESTING
];
303 LLVMValueRef exec_mask
;
304 LLVMValueRef loop_limiter
;
307 struct lp_build_tgsi_inst_list
309 struct tgsi_full_instruction
*instructions
;
310 uint max_instructions
;
311 uint num_instructions
;
314 unsigned lp_bld_tgsi_list_init(struct lp_build_tgsi_context
* bld_base
);
317 unsigned lp_bld_tgsi_add_instruction(
318 struct lp_build_tgsi_context
* bld_base
,
319 struct tgsi_full_instruction
*inst_to_add
);
322 struct lp_build_tgsi_context
;
325 typedef LLVMValueRef (*lp_build_emit_fetch_fn
)(struct lp_build_tgsi_context
*,
326 const struct tgsi_full_src_register
*,
327 enum tgsi_opcode_type
,
330 struct lp_build_tgsi_context
332 struct lp_build_context base
;
334 struct lp_build_context uint_bld
;
335 struct lp_build_context int_bld
;
337 /** This array stores functions that are used to transform TGSI opcodes to
340 struct lp_build_tgsi_action op_actions
[TGSI_OPCODE_LAST
];
342 /* TGSI_OPCODE_RSQ is defined as 1 / sqrt( abs(src0.x) ), rsq_action
343 * should compute 1 / sqrt (src0.x) */
344 struct lp_build_tgsi_action rsq_action
;
346 struct lp_build_tgsi_action sqrt_action
;
348 const struct tgsi_shader_info
*info
;
350 lp_build_emit_fetch_fn emit_fetch_funcs
[TGSI_FILE_COUNT
];
352 LLVMValueRef (*emit_swizzle
)(struct lp_build_tgsi_context
*,
353 LLVMValueRef
, unsigned, unsigned, unsigned, unsigned);
356 void (*emit_debug
)(struct lp_build_tgsi_context
*,
357 const struct tgsi_full_instruction
*,
358 const struct tgsi_opcode_info
*);
360 void (*emit_store
)(struct lp_build_tgsi_context
*,
361 const struct tgsi_full_instruction
*,
362 const struct tgsi_opcode_info
*,
363 LLVMValueRef dst
[4]);
365 void (*emit_declaration
)(struct lp_build_tgsi_context
*,
366 const struct tgsi_full_declaration
*decl
);
368 void (*emit_immediate
)(struct lp_build_tgsi_context
*,
369 const struct tgsi_full_immediate
*imm
);
372 /* Allow the user to store data in this structure rather than passing it
373 * to every function. */
380 struct tgsi_full_instruction
*instructions
;
381 uint max_instructions
;
382 uint num_instructions
;
384 /** This function allows the user to insert some instructions at the
385 * beginning of the program. It is optional and does not need to be
388 void (*emit_prologue
)(struct lp_build_tgsi_context
*);
390 /** This function allows the user to insert some instructions at the end of
391 * the program. This callback is intended to be used for emitting
392 * instructions to handle the export for the output registers, but it can
393 * be used for any purpose. Implementing this function is optiona, but
396 void (*emit_epilogue
)(struct lp_build_tgsi_context
*);
399 struct lp_build_tgsi_gs_iface
401 LLVMValueRef (*fetch_input
)(const struct lp_build_tgsi_gs_iface
*gs_iface
,
402 struct lp_build_tgsi_context
* bld_base
,
403 boolean is_vindex_indirect
,
404 LLVMValueRef vertex_index
,
405 boolean is_aindex_indirect
,
406 LLVMValueRef attrib_index
,
407 LLVMValueRef swizzle_index
);
408 void (*emit_vertex
)(const struct lp_build_tgsi_gs_iface
*gs_iface
,
409 struct lp_build_tgsi_context
* bld_base
,
410 LLVMValueRef (*outputs
)[4],
411 LLVMValueRef emitted_vertices_vec
);
412 void (*end_primitive
)(const struct lp_build_tgsi_gs_iface
*gs_iface
,
413 struct lp_build_tgsi_context
* bld_base
,
414 LLVMValueRef verts_per_prim_vec
,
415 LLVMValueRef emitted_prims_vec
);
416 void (*gs_epilogue
)(const struct lp_build_tgsi_gs_iface
*gs_iface
,
417 struct lp_build_tgsi_context
* bld_base
,
418 LLVMValueRef total_emitted_vertices_vec
,
419 LLVMValueRef emitted_prims_vec
);
422 struct lp_build_tgsi_soa_context
424 struct lp_build_tgsi_context bld_base
;
426 /* Builder for scalar elements of shader's data type (float) */
427 struct lp_build_context elem_bld
;
429 const struct lp_build_tgsi_gs_iface
*gs_iface
;
430 LLVMValueRef emitted_prims_vec_ptr
;
431 LLVMValueRef total_emitted_vertices_vec_ptr
;
432 LLVMValueRef emitted_vertices_vec_ptr
;
433 LLVMValueRef max_output_vertices_vec
;
435 LLVMValueRef consts_ptr
;
436 const LLVMValueRef (*inputs
)[TGSI_NUM_CHANNELS
];
437 LLVMValueRef (*outputs
)[TGSI_NUM_CHANNELS
];
439 const struct lp_build_sampler_soa
*sampler
;
441 struct tgsi_declaration_sampler_view sv
[PIPE_MAX_SHADER_SAMPLER_VIEWS
];
443 LLVMValueRef immediates
[LP_MAX_TGSI_IMMEDIATES
][TGSI_NUM_CHANNELS
];
444 LLVMValueRef temps
[LP_MAX_TGSI_TEMPS
][TGSI_NUM_CHANNELS
];
445 LLVMValueRef addr
[LP_MAX_TGSI_ADDRS
][TGSI_NUM_CHANNELS
];
446 LLVMValueRef preds
[LP_MAX_TGSI_PREDS
][TGSI_NUM_CHANNELS
];
448 /* We allocate/use this array of temps if (1 << TGSI_FILE_TEMPORARY) is
449 * set in the indirect_files field.
450 * The temps[] array above is unused then.
452 LLVMValueRef temps_array
;
454 /* We allocate/use this array of output if (1 << TGSI_FILE_OUTPUT) is
455 * set in the indirect_files field.
456 * The outputs[] array above is unused then.
458 LLVMValueRef outputs_array
;
460 /* We allocate/use this array of inputs if (1 << TGSI_FILE_INPUT) is
461 * set in the indirect_files field.
462 * The inputs[] array above is unused then.
464 LLVMValueRef inputs_array
;
466 /* We allocate/use this array of temps if (1 << TGSI_FILE_IMMEDIATE) is
467 * set in the indirect_files field.
469 LLVMValueRef imms_array
;
472 struct lp_bld_tgsi_system_values system_values
;
474 /** bitmask indicating which register files are accessed indirectly */
475 unsigned indirect_files
;
477 struct lp_build_mask_context
*mask
;
478 struct lp_exec_mask exec_mask
;
485 lp_emit_declaration_soa(
486 struct lp_build_tgsi_context
*bld
,
487 const struct tgsi_full_declaration
*decl
);
489 void lp_emit_immediate_soa(
490 struct lp_build_tgsi_context
*bld_base
,
491 const struct tgsi_full_immediate
*imm
);
494 lp_emit_instruction_soa(
495 struct lp_build_tgsi_soa_context
*bld
,
496 const struct tgsi_full_instruction
*inst
,
497 const struct tgsi_opcode_info
*info
);
502 struct lp_build_tgsi_soa_context
*bld
,
508 struct lp_build_tgsi_soa_context
*bld
,
512 struct lp_build_tgsi_aos_context
514 struct lp_build_tgsi_context bld_base
;
516 /* Builder for integer masks and indices */
517 struct lp_build_context int_bld
;
521 * - swizzles[0] = red index
522 * - swizzles[1] = green index
523 * - swizzles[2] = blue index
524 * - swizzles[3] = alpha index
526 unsigned char swizzles
[4];
527 unsigned char inv_swizzles
[4];
529 LLVMValueRef consts_ptr
;
530 const LLVMValueRef
*inputs
;
531 LLVMValueRef
*outputs
;
533 struct lp_build_sampler_aos
*sampler
;
535 LLVMValueRef immediates
[LP_MAX_TGSI_IMMEDIATES
];
536 LLVMValueRef temps
[LP_MAX_TGSI_TEMPS
];
537 LLVMValueRef addr
[LP_MAX_TGSI_ADDRS
];
538 LLVMValueRef preds
[LP_MAX_TGSI_PREDS
];
540 /* We allocate/use this array of temps if (1 << TGSI_FILE_TEMPORARY) is
541 * set in the indirect_files field.
542 * The temps[] array above is unused then.
544 LLVMValueRef temps_array
;
546 /** bitmask indicating which register files are accessed indirectly */
547 unsigned indirect_files
;
551 static INLINE
struct lp_build_tgsi_soa_context
*
552 lp_soa_context(struct lp_build_tgsi_context
*bld_base
)
554 return (struct lp_build_tgsi_soa_context
*)bld_base
;
557 static INLINE
struct lp_build_tgsi_aos_context
*
558 lp_aos_context(struct lp_build_tgsi_context
*bld_base
)
560 return (struct lp_build_tgsi_aos_context
*)bld_base
;
564 lp_emit_declaration_aos(
565 struct lp_build_tgsi_aos_context
*bld
,
566 const struct tgsi_full_declaration
*decl
);
570 lp_emit_instruction_aos(
571 struct lp_build_tgsi_aos_context
*bld
,
572 const struct tgsi_full_instruction
*inst
,
573 const struct tgsi_opcode_info
*info
,
578 struct lp_build_tgsi_aos_context
*bld
,
579 const struct tgsi_full_instruction
*inst
,
583 void lp_build_fetch_args(
584 struct lp_build_tgsi_context
* bld_base
,
585 struct lp_build_emit_data
* emit_data
);
588 lp_build_tgsi_inst_llvm_aos(
589 struct lp_build_tgsi_context
* bld_base
,
590 const struct tgsi_full_instruction
*inst
);
593 lp_build_tgsi_intrinsic(
594 const struct lp_build_tgsi_action
* action
,
595 struct lp_build_tgsi_context
* bld_base
,
596 struct lp_build_emit_data
* emit_data
);
600 struct lp_build_tgsi_context
*bld_base
,
601 unsigned tgsi_opcode
,
602 struct lp_build_emit_data
* emit_data
);
605 lp_build_emit_llvm_unary(
606 struct lp_build_tgsi_context
*bld_base
,
607 unsigned tgsi_opcode
,
611 lp_build_emit_llvm_binary(
612 struct lp_build_tgsi_context
*bld_base
,
613 unsigned tgsi_opcode
,
618 lp_build_emit_llvm_ternary(
619 struct lp_build_tgsi_context
*bld_base
,
620 unsigned tgsi_opcode
,
626 lp_build_tgsi_inst_llvm(
627 struct lp_build_tgsi_context
* bld_base
,
628 const struct tgsi_full_instruction
*inst
);
632 struct lp_build_tgsi_context
*bld_base
,
633 const struct tgsi_full_instruction
*inst
,
635 const unsigned chan_index
);
639 lp_build_emit_fetch_texoffset(
640 struct lp_build_tgsi_context
*bld_base
,
641 const struct tgsi_full_instruction
*inst
,
643 const unsigned chan_index
);
647 struct lp_build_tgsi_context
* bld_base
,
648 const struct tgsi_token
*tokens
);
650 #endif /* LP_BLD_TGSI_H */