43c598d51177c590f30e83f757e0121c3c34a6c0
[mesa.git] / src / gallium / drivers / llvmpipe / lp_rast.h
1 /**************************************************************************
2 *
3 * Copyright 2009 VMware, Inc.
4 * All Rights Reserved.
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * 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, sub license, 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:
13 *
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
16 * of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
21 * IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS BE LIABLE FOR
22 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
23 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
24 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
25 *
26 **************************************************************************/
27
28 /**
29 * The rast code is concerned with rasterization of command bins.
30 * Each screen tile has a bin associated with it. To render the
31 * scene we iterate over the tile bins and execute the commands
32 * in each bin.
33 * We'll do that with multiple threads...
34 */
35
36
37 #ifndef LP_RAST_H
38 #define LP_RAST_H
39
40 #include "pipe/p_compiler.h"
41 #include "lp_jit.h"
42
43
44 struct lp_rasterizer;
45 struct lp_scene;
46 struct lp_fence;
47 struct cmd_bin;
48
49 #define FIXED_TYPE_WIDTH 32
50 /** For sub-pixel positioning */
51 #define FIXED_ORDER 4
52 #define FIXED_ONE (1<<FIXED_ORDER)
53 /** Maximum length of an edge in a primitive in pixels.
54 * If the framebuffer is large we have to think about fixed-point
55 * integer overflow. Coordinates need ((FIXED_TYPE_WIDTH/2) - 1) bits
56 * to be able to fit product of two such coordinates inside
57 * FIXED_TYPE_WIDTH, any larger and we could overflow a
58 * FIXED_TYPE_WIDTH_-bit int.
59 */
60 #define MAX_FIXED_LENGTH (1 << (((FIXED_TYPE_WIDTH/2) - 1) - FIXED_ORDER))
61
62 /* Rasterizer output size going to jit fs, width/height */
63 #define LP_RASTER_BLOCK_SIZE 4
64
65 #define LP_MAX_ACTIVE_BINNED_QUERIES 16
66
67
68 struct lp_rasterizer_task;
69
70
71 /**
72 * Rasterization state.
73 * Objects of this type are put into the shared data bin and pointed
74 * to by commands in the per-tile bins.
75 */
76 struct lp_rast_state {
77 /* State for the shader. This also contains state which feeds into
78 * the fragment shader, such as blend color and alpha ref value.
79 */
80 struct lp_jit_context jit_context;
81
82 /* The shader itself. Probably we also need to pass a pointer to
83 * the tile color/z/stencil data somehow
84 */
85 struct lp_fragment_shader_variant *variant;
86 };
87
88
89 /**
90 * Coefficients necessary to run the shader at a given location.
91 * First coefficient is position.
92 * These pointers point into the bin data buffer.
93 */
94 struct lp_rast_shader_inputs {
95 unsigned frontfacing:1; /** True for front-facing */
96 unsigned disable:1; /** Partially binned, disable this command */
97 unsigned opaque:1; /** Is opaque */
98 unsigned pad0:29; /* wasted space */
99 unsigned stride; /* how much to advance data between a0, dadx, dady */
100 unsigned layer; /* the layer to render to (from gs, already clamped) */
101 unsigned pad2; /* wasted space */
102 /* followed by a0, dadx, dady and planes[] */
103 };
104
105 /* Note: the order of these values is important as they are loaded by
106 * sse code in rasterization:
107 */
108 struct lp_rast_plane {
109 /* edge function values at minx,miny ?? */
110 int c;
111
112 int dcdx;
113 int dcdy;
114
115 /* one-pixel sized trivial reject offsets for each plane */
116 int eo;
117 };
118
119 /**
120 * Rasterization information for a triangle known to be in this bin,
121 * plus inputs to run the shader:
122 * These fields are tile- and bin-independent.
123 * Objects of this type are put into the lp_setup_context::data buffer.
124 */
125 struct lp_rast_triangle {
126 #ifdef DEBUG
127 float v[3][2];
128 float pad0;
129 float pad1;
130 #endif
131
132 /* inputs for the shader */
133 struct lp_rast_shader_inputs inputs;
134 /* planes are also allocated here */
135 };
136
137
138 #define GET_A0(inputs) ((float (*)[4])((inputs)+1))
139 #define GET_DADX(inputs) ((float (*)[4])((char *)((inputs) + 1) + (inputs)->stride))
140 #define GET_DADY(inputs) ((float (*)[4])((char *)((inputs) + 1) + 2 * (inputs)->stride))
141 #define GET_PLANES(tri) ((struct lp_rast_plane *)((char *)(&(tri)->inputs + 1) + 3 * (tri)->inputs.stride))
142
143
144
145 struct lp_rasterizer *
146 lp_rast_create( unsigned num_threads );
147
148 void
149 lp_rast_destroy( struct lp_rasterizer * );
150
151 void
152 lp_rast_queue_scene( struct lp_rasterizer *rast,
153 struct lp_scene *scene );
154
155 void
156 lp_rast_finish( struct lp_rasterizer *rast );
157
158
159 union lp_rast_cmd_arg {
160 const struct lp_rast_shader_inputs *shade_tile;
161 struct {
162 const struct lp_rast_triangle *tri;
163 unsigned plane_mask;
164 } triangle;
165 const struct lp_rast_state *set_state;
166 union pipe_color_union clear_color;
167 struct {
168 uint64_t value;
169 uint64_t mask;
170 } clear_zstencil;
171 const struct lp_rast_state *state;
172 struct lp_fence *fence;
173 struct llvmpipe_query *query_obj;
174 };
175
176
177 /* Cast wrappers. Hopefully these compile to noops!
178 */
179 static INLINE union lp_rast_cmd_arg
180 lp_rast_arg_inputs( const struct lp_rast_shader_inputs *shade_tile )
181 {
182 union lp_rast_cmd_arg arg;
183 arg.shade_tile = shade_tile;
184 return arg;
185 }
186
187 static INLINE union lp_rast_cmd_arg
188 lp_rast_arg_triangle( const struct lp_rast_triangle *triangle,
189 unsigned plane_mask)
190 {
191 union lp_rast_cmd_arg arg;
192 arg.triangle.tri = triangle;
193 arg.triangle.plane_mask = plane_mask;
194 return arg;
195 }
196
197 /**
198 * Build argument for a contained triangle.
199 *
200 * All planes are enabled, so instead of the plane mask we pass the upper
201 * left coordinates of the a block that fully encloses the triangle.
202 */
203 static INLINE union lp_rast_cmd_arg
204 lp_rast_arg_triangle_contained( const struct lp_rast_triangle *triangle,
205 unsigned x, unsigned y)
206 {
207 union lp_rast_cmd_arg arg;
208 arg.triangle.tri = triangle;
209 arg.triangle.plane_mask = x | (y << 8);
210 return arg;
211 }
212
213 static INLINE union lp_rast_cmd_arg
214 lp_rast_arg_state( const struct lp_rast_state *state )
215 {
216 union lp_rast_cmd_arg arg;
217 arg.set_state = state;
218 return arg;
219 }
220
221 static INLINE union lp_rast_cmd_arg
222 lp_rast_arg_fence( struct lp_fence *fence )
223 {
224 union lp_rast_cmd_arg arg;
225 arg.fence = fence;
226 return arg;
227 }
228
229
230 static INLINE union lp_rast_cmd_arg
231 lp_rast_arg_clearzs( uint64_t value, uint64_t mask )
232 {
233 union lp_rast_cmd_arg arg;
234 arg.clear_zstencil.value = value;
235 arg.clear_zstencil.mask = mask;
236 return arg;
237 }
238
239
240 static INLINE union lp_rast_cmd_arg
241 lp_rast_arg_query( struct llvmpipe_query *pq )
242 {
243 union lp_rast_cmd_arg arg;
244 arg.query_obj = pq;
245 return arg;
246 }
247
248 static INLINE union lp_rast_cmd_arg
249 lp_rast_arg_null( void )
250 {
251 union lp_rast_cmd_arg arg;
252 arg.set_state = NULL;
253 return arg;
254 }
255
256
257 /**
258 * Binnable Commands.
259 * These get put into bins by the setup code and are called when
260 * the bins are executed.
261 */
262 #define LP_RAST_OP_CLEAR_COLOR 0x0
263 #define LP_RAST_OP_CLEAR_ZSTENCIL 0x1
264 #define LP_RAST_OP_TRIANGLE_1 0x2
265 #define LP_RAST_OP_TRIANGLE_2 0x3
266 #define LP_RAST_OP_TRIANGLE_3 0x4
267 #define LP_RAST_OP_TRIANGLE_4 0x5
268 #define LP_RAST_OP_TRIANGLE_5 0x6
269 #define LP_RAST_OP_TRIANGLE_6 0x7
270 #define LP_RAST_OP_TRIANGLE_7 0x8
271 #define LP_RAST_OP_TRIANGLE_8 0x9
272 #define LP_RAST_OP_TRIANGLE_3_4 0xa
273 #define LP_RAST_OP_TRIANGLE_3_16 0xb
274 #define LP_RAST_OP_TRIANGLE_4_16 0xc
275 #define LP_RAST_OP_SHADE_TILE 0xd
276 #define LP_RAST_OP_SHADE_TILE_OPAQUE 0xe
277 #define LP_RAST_OP_BEGIN_QUERY 0xf
278 #define LP_RAST_OP_END_QUERY 0x10
279 #define LP_RAST_OP_SET_STATE 0x11
280
281 #define LP_RAST_OP_MAX 0x12
282 #define LP_RAST_OP_MASK 0xff
283
284 void
285 lp_debug_bins( struct lp_scene *scene );
286 void
287 lp_debug_draw_bins_by_cmd_length( struct lp_scene *scene );
288 void
289 lp_debug_draw_bins_by_coverage( struct lp_scene *scene );
290
291
292 #endif