radeon_compiler.h revision 707f0679157f83ac45127e41647b96ed924d45c9 
1/*
2 * Copyright 2009 Nicolai Hähnle <nhaehnle@gmail.com>
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 * on the rights to use, copy, modify, merge, publish, distribute, sub
8 * license, and/or sell copies of the Software, and to permit persons to whom
9 * the 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 NON-INFRINGEMENT. IN NO EVENT SHALL
18 * THE AUTHOR(S) AND/OR THEIR SUPPLIERS BE LIABLE FOR ANY CLAIM,
19 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
20 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
21 * USE OR OTHER DEALINGS IN THE SOFTWARE. */
22
23#ifndef RADEON_COMPILER_H
24#define RADEON_COMPILER_H
25
26#include "main/compiler.h"
27
28#include "memory_pool.h"
29#include "radeon_code.h"
30#include "radeon_program.h"
31#include "radeon_emulate_loops.h"
32
33#define RC_DBG_LOG        (1 << 0)
34#define RC_DBG_STATS      (1 << 1)
35
36struct rc_swizzle_caps;
37
38enum rc_program_type {
39	RC_VERTEX_PROGRAM,
40	RC_FRAGMENT_PROGRAM,
41	RC_NUM_PROGRAM_TYPES
42};
43
44struct radeon_compiler {
45	struct memory_pool Pool;
46	struct rc_program Program;
47	enum rc_program_type type;
48	unsigned Debug:2;
49	unsigned Error:1;
50	char * ErrorMsg;
51
52	/* Hardware specification. */
53	unsigned is_r400:1;
54	unsigned is_r500:1;
55	unsigned has_half_swizzles:1;
56	unsigned has_presub:1;
57	unsigned has_omod:1;
58	unsigned disable_optimizations:1;
59	unsigned max_temp_regs;
60	unsigned max_constants;
61	int max_alu_insts;
62	unsigned max_tex_insts;
63
64	/* Whether to remove unused constants and empty holes in constant space. */
65	unsigned remove_unused_constants:1;
66
67	/**
68	 * Variables used internally, not be touched by callers
69	 * of the compiler
70	 */
71	/*@{*/
72	struct rc_swizzle_caps * SwizzleCaps;
73	/*@}*/
74
75	struct emulate_loop_state loop_state;
76
77	unsigned initial_num_insts; /* Number of instructions at start. */
78};
79
80void rc_init(struct radeon_compiler * c);
81void rc_destroy(struct radeon_compiler * c);
82
83void rc_debug(struct radeon_compiler * c, const char * fmt, ...);
84void rc_error(struct radeon_compiler * c, const char * fmt, ...);
85
86int rc_if_fail_helper(struct radeon_compiler * c, const char * file, int line, const char * assertion);
87
88/**
89 * This macro acts like an if-statement that can be used to implement
90 * non-aborting assertions in the compiler.
91 *
92 * It checks whether \p cond is true. If not, an internal compiler error is
93 * flagged and the if-clause is run.
94 *
95 * A typical use-case would be:
96 *
97 *  if (rc_assert(c, condition-that-must-be-true))
98 *  	return;
99 */
100#define rc_assert(c, cond) \
101	(!(cond) && rc_if_fail_helper(c, __FILE__, __LINE__, #cond))
102
103void rc_calculate_inputs_outputs(struct radeon_compiler * c);
104
105void rc_move_input(struct radeon_compiler * c, unsigned input, struct rc_src_register new_input);
106void rc_move_output(struct radeon_compiler * c, unsigned output, unsigned new_output, unsigned writemask);
107void rc_copy_output(struct radeon_compiler * c, unsigned output, unsigned dup_output);
108void rc_transform_fragment_wpos(struct radeon_compiler * c, unsigned wpos, unsigned new_input,
109                                int full_vtransform);
110void rc_transform_fragment_face(struct radeon_compiler *c, unsigned face);
111
112struct r300_fragment_program_compiler {
113	struct radeon_compiler Base;
114	struct rX00_fragment_program_code *code;
115	/* Optional transformations and features. */
116	struct r300_fragment_program_external_state state;
117	/* Register corresponding to the depthbuffer. */
118	unsigned OutputDepth;
119	/* Registers corresponding to the four colorbuffers. */
120	unsigned OutputColor[4];
121
122	void * UserData;
123	void (*AllocateHwInputs)(
124		struct r300_fragment_program_compiler * c,
125		void (*allocate)(void * data, unsigned input, unsigned hwreg),
126		void * mydata);
127};
128
129void r3xx_compile_fragment_program(struct r300_fragment_program_compiler* c);
130
131struct r300_vertex_program_compiler {
132	struct radeon_compiler Base;
133	struct r300_vertex_program_code *code;
134	uint32_t RequiredOutputs;
135
136	void * UserData;
137	void (*SetHwInputOutput)(struct r300_vertex_program_compiler * c);
138
139};
140
141void r3xx_compile_vertex_program(struct r300_vertex_program_compiler* c);
142void rc_vert_fc(struct radeon_compiler *compiler, void *user);
143void r300_vertex_program_dump(struct radeon_compiler *compiler, void *user);
144
145struct radeon_compiler_pass {
146	const char *name;	/* Name of the pass. */
147	int dump;		/* Dump the program if Debug == 1? */
148	int predicate;		/* Run this pass? */
149	void (*run)(struct radeon_compiler *c, void *user); /* The main entrypoint. */
150	void *user;		/* Optional parameter which is passed to the run function. */
151};
152
153struct rc_program_stats {
154	unsigned num_insts;
155	unsigned num_fc_insts;
156	unsigned num_tex_insts;
157	unsigned num_rgb_insts;
158	unsigned num_alpha_insts;
159	unsigned num_presub_ops;
160	unsigned num_temp_regs;
161	unsigned num_omod_ops;
162	unsigned num_inline_literals;
163};
164
165void rc_get_stats(struct radeon_compiler *c, struct rc_program_stats *s);
166
167/* Executes a list of compiler passes given in the parameter 'list'. */
168void rc_run_compiler_passes(struct radeon_compiler *c, struct radeon_compiler_pass *list);
169void rc_run_compiler(struct radeon_compiler *c, struct radeon_compiler_pass *list);
170void rc_validate_final_shader(struct radeon_compiler *c, void *user);
171
172#endif /* RADEON_COMPILER_H */
173