2 * Copyright (C) 2008 Nicolai Haehnle.
6 * Permission is hereby granted, free of charge, to any person obtaining
7 * a copy of this software and associated documentation files (the
8 * "Software"), to deal in the Software without restriction, including
9 * without limitation the rights to use, copy, modify, merge, publish,
10 * distribute, sublicense, and/or sell copies of the Software, and to
11 * permit persons to whom the Software is furnished to do so, subject to
12 * the following conditions:
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial
16 * portions of the Software.
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
19 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
21 * IN NO EVENT SHALL THE COPYRIGHT OWNER(S) AND/OR ITS SUPPLIERS BE
22 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
23 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
24 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
28 #ifndef __RADEON_PROGRAM_H_
29 #define __RADEON_PROGRAM_H_
34 #include "radeon_opcodes.h"
35 #include "radeon_code.h"
36 #include "radeon_program_constants.h"
37 #include "radeon_program_pair.h"
39 struct radeon_compiler
;
41 struct rc_src_register
{
44 /** Negative values may be used for relative addressing. */
45 signed int Index
:(RC_REGISTER_INDEX_BITS
+1);
46 unsigned int RelAddr
:1;
48 unsigned int Swizzle
:12;
50 /** Take the component-wise absolute value */
53 /** Post-Abs negation. */
54 unsigned int Negate
:4;
57 struct rc_dst_register
{
60 /** Negative values may be used for relative addressing. */
61 signed int Index
:(RC_REGISTER_INDEX_BITS
+1);
62 unsigned int RelAddr
:1;
64 unsigned int WriteMask
:4;
67 struct rc_presub_instruction
{
68 rc_presubtract_op Opcode
;
69 struct rc_src_register SrcReg
[2];
73 * Instructions are maintained by the compiler in a doubly linked list
74 * of these structures.
76 * This instruction format is intended to be expanded for hardware-specific
77 * trickery. At different stages of compilation, a different set of
78 * instruction types may be valid.
80 struct rc_sub_instruction
{
81 struct rc_src_register SrcReg
[3];
82 struct rc_dst_register DstReg
;
85 * Opcode of this instruction, according to \ref rc_opcode enums.
87 unsigned int Opcode
:8;
90 * Saturate each value of the result to the range [0,1] or [-1,1],
91 * according to \ref rc_saturate_mode enums.
93 unsigned int SaturateMode
:2;
96 * Writing to the special register RC_SPECIAL_ALU_RESULT
99 unsigned int WriteALUResult
:2;
100 unsigned int ALUResultCompare
:3;
104 * \name Extra fields for TEX, TXB, TXD, TXL, TXP instructions.
107 /** Source texture unit. */
108 unsigned int TexSrcUnit
:5;
110 /** Source texture target, one of the \ref rc_texture_target enums */
111 unsigned int TexSrcTarget
:3;
113 /** True if tex instruction should do shadow comparison */
114 unsigned int TexShadow
:1;
117 /** This holds information about the presubtract operation used by
118 * this instruction. */
119 struct rc_presub_instruction PreSub
;
123 RC_INSTRUCTION_NORMAL
= 0,
125 } rc_instruction_type
;
127 struct rc_instruction
{
128 struct rc_instruction
* Prev
;
129 struct rc_instruction
* Next
;
131 rc_instruction_type Type
;
133 struct rc_sub_instruction I
;
134 struct rc_pair_instruction P
;
138 * Warning: IPs are not stable. If you want to use them,
139 * you need to recompute them at the beginning of each pass
140 * using \ref rc_recompute_ips
147 * Instructions.Next points to the first instruction,
148 * Instructions.Prev points to the last instruction.
150 struct rc_instruction Instructions
;
152 /* Long term, we should probably remove InputsRead & OutputsWritten,
153 * since updating dependent state can be fragile, and they aren't
154 * actually used very often. */
156 uint32_t OutputsWritten
;
157 uint32_t ShadowSamplers
; /**< Texture units used for shadow sampling. */
159 struct rc_constant_list Constants
;
163 * A transformation that can be passed to \ref rc_local_transform.
165 * The function will be called once for each instruction.
166 * It has to either emit the appropriate transformed code for the instruction
167 * and return true, or return false if it doesn't understand the
170 * The function gets passed the userData as last parameter.
172 struct radeon_program_transformation
{
174 struct radeon_compiler
*,
175 struct rc_instruction
*,
180 void rc_local_transform(
181 struct radeon_compiler
*c
,
184 void rc_get_used_temporaries(
185 struct radeon_compiler
* c
,
186 unsigned char * used
,
187 unsigned int used_length
);
189 int rc_find_free_temporary_list(
190 struct radeon_compiler
* c
,
191 unsigned char * used
,
192 unsigned int used_length
,
195 unsigned int rc_find_free_temporary(struct radeon_compiler
* c
);
197 struct rc_instruction
*rc_alloc_instruction(struct radeon_compiler
* c
);
198 struct rc_instruction
*rc_insert_new_instruction(struct radeon_compiler
* c
, struct rc_instruction
* after
);
199 void rc_insert_instruction(struct rc_instruction
* after
, struct rc_instruction
* inst
);
200 void rc_remove_instruction(struct rc_instruction
* inst
);
202 unsigned int rc_recompute_ips(struct radeon_compiler
* c
);
204 void rc_print_program(const struct rc_program
*prog
);
206 rc_swizzle
rc_mask_to_swizzle(unsigned int mask
);