draw: fix/improve dirty state validation
[mesa.git] / src / gallium / auxiliary / draw / draw_pt.c
1 /**************************************************************************
2 *
3 * Copyright 2007 Tungsten Graphics, Inc., Cedar Park, Texas.
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 TUNGSTEN GRAPHICS 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 * Authors:
30 * Keith Whitwell <keith@tungstengraphics.com>
31 */
32
33 #include "draw/draw_context.h"
34 #include "draw/draw_gs.h"
35 #include "draw/draw_private.h"
36 #include "draw/draw_pt.h"
37 #include "draw/draw_vs.h"
38 #include "tgsi/tgsi_dump.h"
39 #include "util/u_math.h"
40 #include "util/u_prim.h"
41 #include "util/u_format.h"
42 #include "util/u_draw.h"
43
44
45 DEBUG_GET_ONCE_BOOL_OPTION(draw_fse, "DRAW_FSE", FALSE)
46 DEBUG_GET_ONCE_BOOL_OPTION(draw_no_fse, "DRAW_NO_FSE", FALSE)
47
48 /* Overall we split things into:
49 * - frontend -- prepare fetch_elts, draw_elts - eg vsplit
50 * - middle -- fetch, shade, cliptest, viewport
51 * - pipeline -- the prim pipeline: clipping, wide lines, etc
52 * - backend -- the vbuf_render provided by the driver.
53 */
54 static boolean
55 draw_pt_arrays(struct draw_context *draw,
56 unsigned prim,
57 unsigned start,
58 unsigned count)
59 {
60 struct draw_pt_front_end *frontend = NULL;
61 struct draw_pt_middle_end *middle = NULL;
62 unsigned opt = 0;
63
64 /* Sanitize primitive length:
65 */
66 {
67 unsigned first, incr;
68 draw_pt_split_prim(prim, &first, &incr);
69 count = draw_pt_trim_count(count, first, incr);
70 if (count < first)
71 return TRUE;
72 }
73
74 if (!draw->force_passthrough) {
75 unsigned gs_out_prim = (draw->gs.geometry_shader ?
76 draw->gs.geometry_shader->output_primitive :
77 prim);
78
79 if (!draw->render) {
80 opt |= PT_PIPELINE;
81 }
82
83 if (draw_need_pipeline(draw,
84 draw->rasterizer,
85 gs_out_prim)) {
86 opt |= PT_PIPELINE;
87 }
88
89 if ((draw->clip_xy ||
90 draw->clip_z ||
91 draw->clip_user) && !draw->pt.test_fse) {
92 opt |= PT_CLIPTEST;
93 }
94
95 opt |= PT_SHADE;
96 }
97
98 if (draw->pt.middle.llvm) {
99 middle = draw->pt.middle.llvm;
100 } else {
101 if (opt == 0)
102 middle = draw->pt.middle.fetch_emit;
103 else if (opt == PT_SHADE && !draw->pt.no_fse)
104 middle = draw->pt.middle.fetch_shade_emit;
105 else
106 middle = draw->pt.middle.general;
107 }
108
109 frontend = draw->pt.frontend;
110
111 if (frontend ) {
112 if (draw->pt.prim != prim || draw->pt.opt != opt) {
113 /* In certain conditions switching primitives requires us to flush
114 * and validate the different stages. One example is when smooth
115 * lines are active but first drawn with triangles and then with
116 * lines.
117 */
118 draw_do_flush( draw, DRAW_FLUSH_STATE_CHANGE );
119 frontend = NULL;
120 } else if (draw->pt.eltSize != draw->pt.user.eltSize) {
121 /* Flush draw state if eltSize changed.
122 * This could be improved so only the frontend is flushed since it
123 * converts all indices to ushorts and the fetch part of the middle
124 * always prepares both linear and indexed.
125 */
126 frontend->flush( frontend, DRAW_FLUSH_STATE_CHANGE );
127 frontend = NULL;
128 }
129 }
130
131 if (!frontend) {
132 frontend = draw->pt.front.vsplit;
133
134 frontend->prepare( frontend, prim, middle, opt );
135
136 draw->pt.frontend = frontend;
137 draw->pt.eltSize = draw->pt.user.eltSize;
138 draw->pt.prim = prim;
139 draw->pt.opt = opt;
140 }
141
142 if (draw->pt.rebind_parameters) {
143 /* update constants, viewport dims, clip planes, etc */
144 middle->bind_parameters(middle);
145 draw->pt.rebind_parameters = FALSE;
146 }
147
148 frontend->run( frontend, start, count );
149
150 return TRUE;
151 }
152
153 void draw_pt_flush( struct draw_context *draw, unsigned flags )
154 {
155 assert(flags);
156
157 if (draw->pt.frontend) {
158 draw->pt.frontend->flush( draw->pt.frontend, flags );
159
160 /* don't prepare if we only are flushing the backend */
161 if (flags & DRAW_FLUSH_STATE_CHANGE)
162 draw->pt.frontend = NULL;
163 }
164
165 if (flags & DRAW_FLUSH_PARAMETER_CHANGE) {
166 draw->pt.rebind_parameters = TRUE;
167 }
168 }
169
170
171
172 boolean draw_pt_init( struct draw_context *draw )
173 {
174 draw->pt.test_fse = debug_get_option_draw_fse();
175 draw->pt.no_fse = debug_get_option_draw_no_fse();
176
177 draw->pt.front.vsplit = draw_pt_vsplit(draw);
178 if (!draw->pt.front.vsplit)
179 return FALSE;
180
181 draw->pt.middle.fetch_emit = draw_pt_fetch_emit( draw );
182 if (!draw->pt.middle.fetch_emit)
183 return FALSE;
184
185 draw->pt.middle.fetch_shade_emit = draw_pt_middle_fse( draw );
186 if (!draw->pt.middle.fetch_shade_emit)
187 return FALSE;
188
189 draw->pt.middle.general = draw_pt_fetch_pipeline_or_emit( draw );
190 if (!draw->pt.middle.general)
191 return FALSE;
192
193 #if HAVE_LLVM
194 if (draw->llvm)
195 draw->pt.middle.llvm = draw_pt_fetch_pipeline_or_emit_llvm( draw );
196 #endif
197
198 return TRUE;
199 }
200
201
202 void draw_pt_destroy( struct draw_context *draw )
203 {
204 if (draw->pt.middle.llvm) {
205 draw->pt.middle.llvm->destroy( draw->pt.middle.llvm );
206 draw->pt.middle.llvm = NULL;
207 }
208
209 if (draw->pt.middle.general) {
210 draw->pt.middle.general->destroy( draw->pt.middle.general );
211 draw->pt.middle.general = NULL;
212 }
213
214 if (draw->pt.middle.fetch_emit) {
215 draw->pt.middle.fetch_emit->destroy( draw->pt.middle.fetch_emit );
216 draw->pt.middle.fetch_emit = NULL;
217 }
218
219 if (draw->pt.middle.fetch_shade_emit) {
220 draw->pt.middle.fetch_shade_emit->destroy( draw->pt.middle.fetch_shade_emit );
221 draw->pt.middle.fetch_shade_emit = NULL;
222 }
223
224 if (draw->pt.front.vsplit) {
225 draw->pt.front.vsplit->destroy( draw->pt.front.vsplit );
226 draw->pt.front.vsplit = NULL;
227 }
228 }
229
230
231 /**
232 * Debug- print the first 'count' vertices.
233 */
234 static void
235 draw_print_arrays(struct draw_context *draw, uint prim, int start, uint count)
236 {
237 uint i;
238
239 debug_printf("Draw arrays(prim = %u, start = %u, count = %u)\n",
240 prim, start, count);
241
242 for (i = 0; i < count; i++) {
243 uint ii = 0;
244 uint j;
245
246 if (draw->pt.user.eltSize) {
247 /* indexed arrays */
248
249 switch (draw->pt.user.eltSize) {
250 case 1:
251 {
252 const ubyte *elem = (const ubyte *) draw->pt.user.elts;
253 ii = elem[start + i];
254 }
255 break;
256 case 2:
257 {
258 const ushort *elem = (const ushort *) draw->pt.user.elts;
259 ii = elem[start + i];
260 }
261 break;
262 case 4:
263 {
264 const uint *elem = (const uint *) draw->pt.user.elts;
265 ii = elem[start + i];
266 }
267 break;
268 default:
269 assert(0);
270 return;
271 }
272 ii += draw->pt.user.eltBias;
273 debug_printf("Element[%u + %u] + %i -> Vertex %u:\n", start, i,
274 draw->pt.user.eltBias, ii);
275 }
276 else {
277 /* non-indexed arrays */
278 ii = start + i;
279 debug_printf("Vertex %u:\n", ii);
280 }
281
282 for (j = 0; j < draw->pt.nr_vertex_elements; j++) {
283 uint buf = draw->pt.vertex_element[j].vertex_buffer_index;
284 ubyte *ptr = (ubyte *) draw->pt.user.vbuffer[buf];
285
286 if (draw->pt.vertex_element[j].instance_divisor) {
287 ii = draw->instance_id / draw->pt.vertex_element[j].instance_divisor;
288 }
289
290 ptr += draw->pt.vertex_buffer[buf].buffer_offset;
291 ptr += draw->pt.vertex_buffer[buf].stride * ii;
292 ptr += draw->pt.vertex_element[j].src_offset;
293
294 debug_printf(" Attr %u: ", j);
295 switch (draw->pt.vertex_element[j].src_format) {
296 case PIPE_FORMAT_R32_FLOAT:
297 {
298 float *v = (float *) ptr;
299 debug_printf("R %f @ %p\n", v[0], (void *) v);
300 }
301 break;
302 case PIPE_FORMAT_R32G32_FLOAT:
303 {
304 float *v = (float *) ptr;
305 debug_printf("RG %f %f @ %p\n", v[0], v[1], (void *) v);
306 }
307 break;
308 case PIPE_FORMAT_R32G32B32_FLOAT:
309 {
310 float *v = (float *) ptr;
311 debug_printf("RGB %f %f %f @ %p\n", v[0], v[1], v[2], (void *) v);
312 }
313 break;
314 case PIPE_FORMAT_R32G32B32A32_FLOAT:
315 {
316 float *v = (float *) ptr;
317 debug_printf("RGBA %f %f %f %f @ %p\n", v[0], v[1], v[2], v[3],
318 (void *) v);
319 }
320 break;
321 case PIPE_FORMAT_B8G8R8A8_UNORM:
322 {
323 ubyte *u = (ubyte *) ptr;
324 debug_printf("BGRA %d %d %d %d @ %p\n", u[0], u[1], u[2], u[3],
325 (void *) u);
326 }
327 break;
328 default:
329 debug_printf("other format %s (fix me)\n",
330 util_format_name(draw->pt.vertex_element[j].src_format));
331 }
332 }
333 }
334 }
335
336
337 /** Helper code for below */
338 #define PRIM_RESTART_LOOP(elements) \
339 do { \
340 for (i = start; i < end; i++) { \
341 if (elements[i] == info->restart_index) { \
342 if (cur_count > 0) { \
343 /* draw elts up to prev pos */ \
344 draw_pt_arrays(draw, prim, cur_start, cur_count); \
345 } \
346 /* begin new prim at next elt */ \
347 cur_start = i + 1; \
348 cur_count = 0; \
349 } \
350 else { \
351 cur_count++; \
352 } \
353 } \
354 if (cur_count > 0) { \
355 draw_pt_arrays(draw, prim, cur_start, cur_count); \
356 } \
357 } while (0)
358
359
360 /**
361 * For drawing prims with primitive restart enabled.
362 * Scan for restart indexes and draw the runs of elements/vertices between
363 * the restarts.
364 */
365 static void
366 draw_pt_arrays_restart(struct draw_context *draw,
367 const struct pipe_draw_info *info)
368 {
369 const unsigned prim = info->mode;
370 const unsigned start = info->start;
371 const unsigned count = info->count;
372 const unsigned end = start + count;
373 unsigned i, cur_start, cur_count;
374
375 assert(info->primitive_restart);
376
377 if (draw->pt.user.eltSize) {
378 /* indexed prims (draw_elements) */
379 cur_start = start;
380 cur_count = 0;
381
382 switch (draw->pt.user.eltSize) {
383 case 1:
384 {
385 const ubyte *elt_ub = (const ubyte *) draw->pt.user.elts;
386 PRIM_RESTART_LOOP(elt_ub);
387 }
388 break;
389 case 2:
390 {
391 const ushort *elt_us = (const ushort *) draw->pt.user.elts;
392 PRIM_RESTART_LOOP(elt_us);
393 }
394 break;
395 case 4:
396 {
397 const uint *elt_ui = (const uint *) draw->pt.user.elts;
398 PRIM_RESTART_LOOP(elt_ui);
399 }
400 break;
401 default:
402 assert(0 && "bad eltSize in draw_arrays()");
403 }
404 }
405 else {
406 /* Non-indexed prims (draw_arrays).
407 * Primitive restart should have been handled in the state tracker.
408 */
409 draw_pt_arrays(draw, prim, start, count);
410 }
411 }
412
413
414
415 /**
416 * Non-instanced drawing.
417 * \sa draw_arrays_instanced
418 */
419 void
420 draw_arrays(struct draw_context *draw, unsigned prim,
421 unsigned start, unsigned count)
422 {
423 draw_arrays_instanced(draw, prim, start, count, 0, 1);
424 }
425
426
427 /**
428 * Instanced drawing.
429 * \sa draw_vbo
430 */
431 void
432 draw_arrays_instanced(struct draw_context *draw,
433 unsigned mode,
434 unsigned start,
435 unsigned count,
436 unsigned startInstance,
437 unsigned instanceCount)
438 {
439 struct pipe_draw_info info;
440
441 util_draw_init_info(&info);
442
443 info.mode = mode;
444 info.start = start;
445 info.count = count;
446 info.start_instance = startInstance;
447 info.instance_count = instanceCount;
448 info.min_index = start;
449 info.max_index = start + count - 1;
450
451 draw_vbo(draw, &info);
452 }
453
454
455 /**
456 * Draw vertex arrays.
457 * This is the main entrypoint into the drawing module. If drawing an indexed
458 * primitive, the draw_set_indexes() function should have already been called
459 * to specify the element/index buffer information.
460 */
461 void
462 draw_vbo(struct draw_context *draw,
463 const struct pipe_draw_info *info)
464 {
465 unsigned instance;
466 unsigned index_limit;
467
468 assert(info->instance_count > 0);
469 if (info->indexed)
470 assert(draw->pt.user.elts);
471
472 draw->pt.user.eltBias = info->index_bias;
473 draw->pt.user.min_index = info->min_index;
474 draw->pt.user.max_index = info->max_index;
475 draw->pt.user.eltSize = info->indexed ? draw->pt.user.eltSizeIB : 0;
476
477 if (0)
478 debug_printf("draw_vbo(mode=%u start=%u count=%u):\n",
479 info->mode, info->start, info->count);
480
481 if (0)
482 tgsi_dump(draw->vs.vertex_shader->state.tokens, 0);
483
484 if (0) {
485 unsigned int i;
486 debug_printf("Elements:\n");
487 for (i = 0; i < draw->pt.nr_vertex_elements; i++) {
488 debug_printf(" %u: src_offset=%u inst_div=%u vbuf=%u format=%s\n",
489 i,
490 draw->pt.vertex_element[i].src_offset,
491 draw->pt.vertex_element[i].instance_divisor,
492 draw->pt.vertex_element[i].vertex_buffer_index,
493 util_format_name(draw->pt.vertex_element[i].src_format));
494 }
495 debug_printf("Buffers:\n");
496 for (i = 0; i < draw->pt.nr_vertex_buffers; i++) {
497 debug_printf(" %u: stride=%u offset=%u ptr=%p\n",
498 i,
499 draw->pt.vertex_buffer[i].stride,
500 draw->pt.vertex_buffer[i].buffer_offset,
501 draw->pt.user.vbuffer[i]);
502 }
503 }
504
505 if (0)
506 draw_print_arrays(draw, info->mode, info->start, MIN2(info->count, 20));
507
508 index_limit = util_draw_max_index(draw->pt.vertex_buffer,
509 draw->pt.vertex_element,
510 draw->pt.nr_vertex_elements,
511 info);
512
513 if (index_limit == 0) {
514 /* one of the buffers is too small to do any valid drawing */
515 debug_warning("draw: VBO too small to draw anything\n");
516 return;
517 }
518
519 draw->pt.max_index = index_limit - 1;
520
521
522 /*
523 * TODO: We could use draw->pt.max_index to further narrow
524 * the min_index/max_index hints given by the state tracker.
525 */
526
527 for (instance = 0; instance < info->instance_count; instance++) {
528 draw->instance_id = instance + info->start_instance;
529
530 if (info->primitive_restart) {
531 draw_pt_arrays_restart(draw, info);
532 }
533 else {
534 draw_pt_arrays(draw, info->mode, info->start, info->count);
535 }
536 }
537 }