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
44struct lp_rasterizer;
45struct lp_scene;
46struct lp_fence;
47struct cmd_bin;
48
49/** For sub-pixel positioning */
50#define FIXED_ORDER 4
51#define FIXED_ONE (1<<FIXED_ORDER)
52
53
54struct lp_rasterizer_task;
55
56
57/**
58 * Rasterization state.
59 * Objects of this type are put into the shared data bin and pointed
60 * to by commands in the per-tile bins.
61 */
62struct lp_rast_state {
63   /* State for the shader.  This also contains state which feeds into
64    * the fragment shader, such as blend color and alpha ref value.
65    */
66   struct lp_jit_context jit_context;
67
68   /* The shader itself.  Probably we also need to pass a pointer to
69    * the tile color/z/stencil data somehow
70     */
71   struct lp_fragment_shader_variant *variant;
72};
73
74
75/**
76 * Coefficients necessary to run the shader at a given location.
77 * First coefficient is position.
78 * These pointers point into the bin data buffer.
79 */
80struct lp_rast_shader_inputs {
81   unsigned frontfacing:1;      /** True for front-facing */
82   unsigned disable:1;          /** Partially binned, disable this command */
83   unsigned opaque:1;           /** Is opaque */
84   unsigned pad0:29;            /* wasted space */
85   unsigned stride;             /* how much to advance data between a0, dadx, dady */
86   unsigned pad2;               /* wasted space */
87   unsigned pad3;               /* wasted space */
88   /* followed by a0, dadx, dady and planes[] */
89};
90
91/* Note: the order of these values is important as they are loaded by
92 * sse code in rasterization:
93 */
94struct lp_rast_plane {
95   /* edge function values at minx,miny ?? */
96   int c;
97
98   int dcdx;
99   int dcdy;
100
101   /* one-pixel sized trivial reject offsets for each plane */
102   int eo;
103};
104
105/**
106 * Rasterization information for a triangle known to be in this bin,
107 * plus inputs to run the shader:
108 * These fields are tile- and bin-independent.
109 * Objects of this type are put into the lp_setup_context::data buffer.
110 */
111struct lp_rast_triangle {
112#ifdef DEBUG
113   float v[3][2];
114   float pad0;
115   float pad1;
116#endif
117
118   /* inputs for the shader */
119   struct lp_rast_shader_inputs inputs;
120   /* planes are also allocated here */
121};
122
123
124#define GET_A0(inputs) ((float (*)[4])((inputs)+1))
125#define GET_DADX(inputs) ((float (*)[4])((char *)((inputs) + 1) + (inputs)->stride))
126#define GET_DADY(inputs) ((float (*)[4])((char *)((inputs) + 1) + 2 * (inputs)->stride))
127#define GET_PLANES(tri) ((struct lp_rast_plane *)((char *)(&(tri)->inputs + 1) + 3 * (tri)->inputs.stride))
128
129
130
131struct lp_rasterizer *
132lp_rast_create( unsigned num_threads );
133
134void
135lp_rast_destroy( struct lp_rasterizer * );
136
137unsigned
138lp_rast_get_num_threads( struct lp_rasterizer * );
139
140void
141lp_rast_queue_scene( struct lp_rasterizer *rast,
142                     struct lp_scene *scene );
143
144void
145lp_rast_finish( struct lp_rasterizer *rast );
146
147
148union lp_rast_cmd_arg {
149   const struct lp_rast_shader_inputs *shade_tile;
150   struct {
151      const struct lp_rast_triangle *tri;
152      unsigned plane_mask;
153   } triangle;
154   const struct lp_rast_state *set_state;
155   uint8_t clear_color[4];
156   struct {
157      uint32_t value;
158      uint32_t mask;
159   } clear_zstencil;
160   const struct lp_rast_state *state;
161   struct lp_fence *fence;
162   struct llvmpipe_query *query_obj;
163};
164
165
166/* Cast wrappers.  Hopefully these compile to noops!
167 */
168static INLINE union lp_rast_cmd_arg
169lp_rast_arg_inputs( const struct lp_rast_shader_inputs *shade_tile )
170{
171   union lp_rast_cmd_arg arg;
172   arg.shade_tile = shade_tile;
173   return arg;
174}
175
176static INLINE union lp_rast_cmd_arg
177lp_rast_arg_triangle( const struct lp_rast_triangle *triangle,
178                      unsigned plane_mask)
179{
180   union lp_rast_cmd_arg arg;
181   arg.triangle.tri = triangle;
182   arg.triangle.plane_mask = plane_mask;
183   return arg;
184}
185
186/**
187 * Build argument for a contained triangle.
188 *
189 * All planes are enabled, so instead of the plane mask we pass the upper
190 * left coordinates of the a block that fully encloses the triangle.
191 */
192static INLINE union lp_rast_cmd_arg
193lp_rast_arg_triangle_contained( const struct lp_rast_triangle *triangle,
194                                unsigned x, unsigned y)
195{
196   union lp_rast_cmd_arg arg;
197   arg.triangle.tri = triangle;
198   arg.triangle.plane_mask = x | (y << 8);
199   return arg;
200}
201
202static INLINE union lp_rast_cmd_arg
203lp_rast_arg_state( const struct lp_rast_state *state )
204{
205   union lp_rast_cmd_arg arg;
206   arg.set_state = state;
207   return arg;
208}
209
210static INLINE union lp_rast_cmd_arg
211lp_rast_arg_fence( struct lp_fence *fence )
212{
213   union lp_rast_cmd_arg arg;
214   arg.fence = fence;
215   return arg;
216}
217
218
219static INLINE union lp_rast_cmd_arg
220lp_rast_arg_clearzs( unsigned value, unsigned mask )
221{
222   union lp_rast_cmd_arg arg;
223   arg.clear_zstencil.value = value;
224   arg.clear_zstencil.mask = mask;
225   return arg;
226}
227
228
229static INLINE union lp_rast_cmd_arg
230lp_rast_arg_query( struct llvmpipe_query *pq )
231{
232   union lp_rast_cmd_arg arg;
233   arg.query_obj = pq;
234   return arg;
235}
236
237static INLINE union lp_rast_cmd_arg
238lp_rast_arg_null( void )
239{
240   union lp_rast_cmd_arg arg;
241   arg.set_state = NULL;
242   return arg;
243}
244
245
246/**
247 * Binnable Commands.
248 * These get put into bins by the setup code and are called when
249 * the bins are executed.
250 */
251#define LP_RAST_OP_CLEAR_COLOR       0x0
252#define LP_RAST_OP_CLEAR_ZSTENCIL    0x1
253#define LP_RAST_OP_TRIANGLE_1        0x2
254#define LP_RAST_OP_TRIANGLE_2        0x3
255#define LP_RAST_OP_TRIANGLE_3        0x4
256#define LP_RAST_OP_TRIANGLE_4        0x5
257#define LP_RAST_OP_TRIANGLE_5        0x6
258#define LP_RAST_OP_TRIANGLE_6        0x7
259#define LP_RAST_OP_TRIANGLE_7        0x8
260#define LP_RAST_OP_TRIANGLE_8        0x9
261#define LP_RAST_OP_TRIANGLE_3_4      0xa
262#define LP_RAST_OP_TRIANGLE_3_16     0xb
263#define LP_RAST_OP_TRIANGLE_4_16     0xc
264#define LP_RAST_OP_SHADE_TILE        0xd
265#define LP_RAST_OP_SHADE_TILE_OPAQUE 0xe
266#define LP_RAST_OP_BEGIN_QUERY       0xf
267#define LP_RAST_OP_END_QUERY         0x10
268#define LP_RAST_OP_SET_STATE         0x11
269
270#define LP_RAST_OP_MAX               0x12
271#define LP_RAST_OP_MASK              0xff
272
273void
274lp_debug_bins( struct lp_scene *scene );
275void
276lp_debug_draw_bins_by_cmd_length( struct lp_scene *scene );
277void
278lp_debug_draw_bins_by_coverage( struct lp_scene *scene );
279
280
281#endif
282