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 <stdbool.h>
27
28#include "memory_pool.h"
29#include "radeon_code.h"
30#include "radeon_program.h"
31
32#define RC_DBG_LOG        (1 << 0)
33
34struct rc_swizzle_caps;
35
36enum rc_program_type {
37	RC_VERTEX_PROGRAM,
38	RC_FRAGMENT_PROGRAM,
39	RC_NUM_PROGRAM_TYPES
40};
41
42struct radeon_compiler {
43	struct memory_pool Pool;
44	struct rc_program Program;
45	const struct rc_regalloc_state *regalloc_state;
46	struct util_debug_callback *debug;
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 needs_trig_input_transform:1;
60	unsigned max_temp_regs;
61	unsigned max_constants;
62	int max_alu_insts;
63	unsigned max_tex_insts;
64
65	/* Whether to remove unused constants and empty holes in constant space. */
66	unsigned remove_unused_constants:1;
67
68	/**
69	 * Variables used internally, not be touched by callers
70	 * of the compiler
71	 */
72	/*@{*/
73	const struct rc_swizzle_caps * SwizzleCaps;
74	/*@}*/
75};
76
77void rc_init(struct radeon_compiler * c, const struct rc_regalloc_state *rs);
78void rc_destroy(struct radeon_compiler * c);
79
80void rc_debug(struct radeon_compiler * c, const char * fmt, ...);
81void rc_error(struct radeon_compiler * c, const char * fmt, ...);
82
83int rc_if_fail_helper(struct radeon_compiler * c, const char * file, int line, const char * assertion);
84
85/**
86 * This macro acts like an if-statement that can be used to implement
87 * non-aborting assertions in the compiler.
88 *
89 * It checks whether \p cond is true. If not, an internal compiler error is
90 * flagged and the if-clause is run.
91 *
92 * A typical use-case would be:
93 *
94 *  if (rc_assert(c, condition-that-must-be-true))
95 *  	return;
96 */
97#define rc_assert(c, cond) \
98	(!(cond) && rc_if_fail_helper(c, __FILE__, __LINE__, #cond))
99
100void rc_calculate_inputs_outputs(struct radeon_compiler * c);
101
102void rc_copy_output(struct radeon_compiler * c, unsigned output, unsigned dup_output);
103void rc_transform_fragment_wpos(struct radeon_compiler * c, unsigned wpos, unsigned new_input,
104                                int full_vtransform);
105void rc_transform_fragment_face(struct radeon_compiler *c, unsigned face);
106
107struct r300_fragment_program_compiler {
108	struct radeon_compiler Base;
109	struct rX00_fragment_program_code *code;
110	/* Optional transformations and features. */
111	struct r300_fragment_program_external_state state;
112	/* Register corresponding to the depthbuffer. */
113	unsigned OutputDepth;
114	/* Registers corresponding to the four colorbuffers. */
115	unsigned OutputColor[4];
116
117	void * UserData;
118	void (*AllocateHwInputs)(
119		struct r300_fragment_program_compiler * c,
120		void (*allocate)(void * data, unsigned input, unsigned hwreg),
121		void * mydata);
122};
123
124void r3xx_compile_fragment_program(struct r300_fragment_program_compiler* c);
125
126struct r300_vertex_program_compiler {
127	struct radeon_compiler Base;
128	struct r300_vertex_program_code *code;
129	uint32_t RequiredOutputs;
130
131	void * UserData;
132	void (*SetHwInputOutput)(struct r300_vertex_program_compiler * c);
133
134};
135
136void r3xx_compile_vertex_program(struct r300_vertex_program_compiler* c);
137void rc_vert_fc(struct radeon_compiler *compiler, void *user);
138void r300_vertex_program_dump(struct radeon_compiler *compiler, void *user);
139
140struct radeon_compiler_pass {
141	const char *name;	/* Name of the pass. */
142	int dump;		/* Dump the program if Debug == 1? */
143	int predicate;		/* Run this pass? */
144	void (*run)(struct radeon_compiler *c, void *user); /* The main entrypoint. */
145	void *user;		/* Optional parameter which is passed to the run function. */
146};
147
148struct rc_program_stats {
149	unsigned num_consts;
150	unsigned num_insts;
151	unsigned num_fc_insts;
152	unsigned num_tex_insts;
153	unsigned num_rgb_insts;
154	unsigned num_alpha_insts;
155	unsigned num_pred_insts;
156	unsigned num_presub_ops;
157	unsigned num_temp_regs;
158	unsigned num_omod_ops;
159	unsigned num_inline_literals;
160	unsigned num_loops;
161};
162
163void rc_get_stats(struct radeon_compiler *c, struct rc_program_stats *s);
164
165/* Executes a list of compiler passes given in the parameter 'list'. */
166bool rc_run_compiler_passes(struct radeon_compiler *c, struct radeon_compiler_pass *list);
167void rc_run_compiler(struct radeon_compiler *c, struct radeon_compiler_pass *list);
168void rc_validate_final_shader(struct radeon_compiler *c, void *user);
169
170#endif /* RADEON_COMPILER_H */
171