r300g: cleanup texture debug logging
[mesa.git] / src / gallium / drivers / r300 / r300_context.h
1 /*
2 * Copyright 2008 Corbin Simpson <MostAwesomeDude@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 R300_CONTEXT_H
24 #define R300_CONTEXT_H
25
26 #include "draw/draw_vertex.h"
27
28 #include "util/u_blitter.h"
29
30 #include "pipe/p_context.h"
31 #include "util/u_inlines.h"
32 #include "util/u_transfer.h"
33
34 #include "translate/translate_cache.h"
35
36 #include "r300_defines.h"
37 #include "r300_screen.h"
38
39 struct u_upload_mgr;
40 struct r300_context;
41 struct r300_fragment_shader;
42 struct r300_vertex_shader;
43 struct r300_stencilref_context;
44
45 struct r300_atom {
46 /* List pointers. */
47 struct r300_atom *prev, *next;
48 /* Name, for debugging. */
49 const char* name;
50 /* Stat counter. */
51 uint64_t counter;
52 /* Opaque state. */
53 void* state;
54 /* Emit the state to the context. */
55 void (*emit)(struct r300_context*, unsigned, void*);
56 /* Upper bound on number of dwords to emit. */
57 unsigned size;
58 /* Whether this atom should be emitted. */
59 boolean dirty;
60 /* Whether this atom may be emitted with state == NULL. */
61 boolean allow_null_state;
62 };
63
64 struct r300_aa_state {
65 struct r300_surface *dest;
66
67 uint32_t aa_config;
68 uint32_t aaresolve_ctl;
69 };
70
71 struct r300_blend_state {
72 uint32_t cb[8];
73 uint32_t cb_no_readwrite[8];
74 };
75
76 struct r300_blend_color_state {
77 uint32_t cb[3];
78 };
79
80 struct r300_clip_state {
81 struct pipe_clip_state clip;
82
83 uint32_t cb[29];
84 };
85
86 struct r300_dsa_state {
87 struct pipe_depth_stencil_alpha_state dsa;
88
89 /* This is actually a command buffer with named dwords. */
90 uint32_t cb_begin;
91 uint32_t alpha_function; /* R300_FG_ALPHA_FUNC: 0x4bd4 */
92 uint32_t cb_reg_seq;
93 uint32_t z_buffer_control; /* R300_ZB_CNTL: 0x4f00 */
94 uint32_t z_stencil_control; /* R300_ZB_ZSTENCILCNTL: 0x4f04 */
95 uint32_t stencil_ref_mask; /* R300_ZB_STENCILREFMASK: 0x4f08 */
96 uint32_t cb_reg;
97 uint32_t stencil_ref_bf; /* R500_ZB_STENCILREFMASK_BF: 0x4fd4 */
98
99 /* The second command buffer disables zbuffer reads and writes. */
100 uint32_t cb_no_readwrite[8];
101
102 /* Whether a two-sided stencil is enabled. */
103 boolean two_sided;
104 /* Whether a fallback should be used for a two-sided stencil ref value. */
105 boolean two_sided_stencil_ref;
106 };
107
108 struct r300_hyperz_state {
109 /* This is actually a command buffer with named dwords. */
110 uint32_t cb_begin;
111 uint32_t zb_bw_cntl; /* R300_ZB_BW_CNTL */
112 uint32_t cb_reg1;
113 uint32_t zb_depthclearvalue; /* R300_ZB_DEPTHCLEARVALUE */
114 uint32_t cb_reg2;
115 uint32_t sc_hyperz; /* R300_SC_HYPERZ */
116 };
117
118 struct r300_gpu_flush {
119 uint32_t cb_flush_clean[6];
120 };
121
122 struct r300_rs_state {
123 /* Original rasterizer state. */
124 struct pipe_rasterizer_state rs;
125 /* Draw-specific rasterizer state. */
126 struct pipe_rasterizer_state rs_draw;
127
128 /* Command buffers. */
129 uint32_t cb_main[25];
130 uint32_t cb_poly_offset_zb16[5];
131 uint32_t cb_poly_offset_zb24[5];
132
133 /* The index to cb_main where the cull_mode register value resides. */
134 unsigned cull_mode_index;
135
136 /* Whether polygon offset is enabled. */
137 boolean polygon_offset_enable;
138
139 /* This is emitted in the draw function. */
140 uint32_t color_control; /* R300_GA_COLOR_CONTROL: 0x4278 */
141 };
142
143 struct r300_rs_block {
144 uint32_t vap_vtx_state_cntl; /* R300_VAP_VTX_STATE_CNTL: 0x2180 */
145 uint32_t vap_vsm_vtx_assm; /* R300_VAP_VSM_VTX_ASSM: 0x2184 */
146 uint32_t vap_out_vtx_fmt[2]; /* R300_VAP_OUTPUT_VTX_FMT_[0-1]: 0x2090 */
147
148 uint32_t ip[8]; /* R300_RS_IP_[0-7], R500_RS_IP_[0-7] */
149 uint32_t count; /* R300_RS_COUNT */
150 uint32_t inst_count; /* R300_RS_INST_COUNT */
151 uint32_t inst[8]; /* R300_RS_INST_[0-7] */
152 };
153
154 struct r300_sampler_state {
155 struct pipe_sampler_state state;
156
157 uint32_t filter0; /* R300_TX_FILTER0: 0x4400 */
158 uint32_t filter1; /* R300_TX_FILTER1: 0x4440 */
159 uint32_t border_color; /* R300_TX_BORDER_COLOR: 0x45c0 */
160
161 /* Min/max LOD must be clamped to [0, last_level], thus
162 * it's dependent on a currently bound texture */
163 unsigned min_lod, max_lod;
164 };
165
166 struct r300_texture_format_state {
167 uint32_t format0; /* R300_TX_FORMAT0: 0x4480 */
168 uint32_t format1; /* R300_TX_FORMAT1: 0x44c0 */
169 uint32_t format2; /* R300_TX_FORMAT2: 0x4500 */
170 uint32_t tile_config; /* R300_TX_OFFSET (subset thereof) */
171 };
172
173 struct r300_sampler_view {
174 struct pipe_sampler_view base;
175
176 /* Swizzles in the UTIL_FORMAT_SWIZZLE_* representation,
177 * derived from base. */
178 unsigned char swizzle[4];
179
180 /* Copy of r300_texture::texture_format_state with format-specific bits
181 * added. */
182 struct r300_texture_format_state format;
183
184 /* The texture cache region for this texture. */
185 uint32_t texcache_region;
186 };
187
188 struct r300_texture_fb_state {
189 uint32_t pitch[R300_MAX_TEXTURE_LEVELS]; /* COLORPITCH or DEPTHPITCH. */
190 uint32_t format; /* US_OUT_FMT or R300_ZB_FORMAT */
191 };
192
193 struct r300_texture_sampler_state {
194 struct r300_texture_format_state format;
195 uint32_t filter0; /* R300_TX_FILTER0: 0x4400 */
196 uint32_t filter1; /* R300_TX_FILTER1: 0x4440 */
197 uint32_t border_color; /* R300_TX_BORDER_COLOR: 0x45c0 */
198 };
199
200 struct r300_textures_state {
201 /* Textures. */
202 struct r300_sampler_view *sampler_views[16];
203 int sampler_view_count;
204 /* Sampler states. */
205 struct r300_sampler_state *sampler_states[16];
206 int sampler_state_count;
207
208 /* This is the merge of the texture and sampler states. */
209 unsigned count;
210 uint32_t tx_enable; /* R300_TX_ENABLE: 0x4101 */
211 struct r300_texture_sampler_state regs[16];
212 };
213
214 struct r300_vertex_stream_state {
215 /* R300_VAP_PROG_STREAK_CNTL_[0-7] */
216 uint32_t vap_prog_stream_cntl[8];
217 /* R300_VAP_PROG_STREAK_CNTL_EXT_[0-7] */
218 uint32_t vap_prog_stream_cntl_ext[8];
219
220 unsigned count;
221 };
222
223 struct r300_invariant_state {
224 uint32_t cb[20];
225 };
226
227 struct r300_vap_invariant_state {
228 uint32_t cb[9];
229 };
230
231 struct r300_viewport_state {
232 float xscale; /* R300_VAP_VPORT_XSCALE: 0x2098 */
233 float xoffset; /* R300_VAP_VPORT_XOFFSET: 0x209c */
234 float yscale; /* R300_VAP_VPORT_YSCALE: 0x20a0 */
235 float yoffset; /* R300_VAP_VPORT_YOFFSET: 0x20a4 */
236 float zscale; /* R300_VAP_VPORT_ZSCALE: 0x20a8 */
237 float zoffset; /* R300_VAP_VPORT_ZOFFSET: 0x20ac */
238 uint32_t vte_control; /* R300_VAP_VTE_CNTL: 0x20b0 */
239 };
240
241 struct r300_ztop_state {
242 uint32_t z_buffer_top; /* R300_ZB_ZTOP: 0x4f14 */
243 };
244
245 /* The next several objects are not pure Radeon state; they inherit from
246 * various Gallium classes. */
247
248 struct r300_constant_buffer {
249 /* Buffer of constants */
250 uint32_t *ptr;
251 /* Total number of vec4s */
252 unsigned count;
253 };
254
255 /* Query object.
256 *
257 * This is not a subclass of pipe_query because pipe_query is never
258 * actually fully defined. So, rather than have it as a member, and do
259 * subclass-style casting, we treat pipe_query as an opaque, and just
260 * trust that our state tracker does not ever mess up query objects.
261 */
262 struct r300_query {
263 /* The kind of query. Currently only OQ is supported. */
264 unsigned type;
265 /* The number of pipes where query results are stored. */
266 unsigned num_pipes;
267 /* How many results have been written, in dwords. It's incremented
268 * after end_query and flush. */
269 unsigned num_results;
270 /* if we've flushed the query */
271 boolean flushed;
272 /* if begin has been emitted */
273 boolean begin_emitted;
274
275 /* The buffer where query results are stored. */
276 struct r300_winsys_buffer *buffer;
277 /* The size of the buffer. */
278 unsigned buffer_size;
279 /* The domain of the buffer. */
280 enum r300_buffer_domain domain;
281
282 /* Linked list members. */
283 struct r300_query* prev;
284 struct r300_query* next;
285 };
286
287 /* Fence object.
288 *
289 * This is a fake fence. Instead of syncing with the fence, we sync
290 * with the context, which is inefficient but compliant.
291 *
292 * This is not a subclass of pipe_fence_handle because pipe_fence_handle is
293 * never actually fully defined. So, rather than have it as a member, and do
294 * subclass-style casting, we treat pipe_fence_handle as an opaque, and just
295 * trust that our state tracker does not ever mess up fence objects.
296 */
297 struct r300_fence {
298 struct pipe_reference reference;
299 struct r300_context *ctx;
300 boolean signalled;
301 };
302
303 struct r300_surface {
304 struct pipe_surface base;
305
306 /* Winsys buffer backing the texture. */
307 struct r300_winsys_buffer *buffer;
308
309 enum r300_buffer_domain domain;
310
311 uint32_t offset; /* COLOROFFSET or DEPTHOFFSET. */
312 uint32_t pitch; /* COLORPITCH or DEPTHPITCH. */
313 uint32_t format; /* US_OUT_FMT or ZB_FORMAT. */
314
315 /* Parameters dedicated to the CBZB clear. */
316 uint32_t cbzb_width; /* Aligned width. */
317 uint32_t cbzb_height; /* Half of the height. */
318 uint32_t cbzb_midpoint_offset; /* DEPTHOFFSET. */
319 uint32_t cbzb_pitch; /* DEPTHPITCH. */
320 uint32_t cbzb_format; /* ZB_FORMAT. */
321 };
322
323 struct r300_texture {
324 /* Parent class */
325 struct u_resource b;
326
327 enum r300_buffer_domain domain;
328
329 /* Offsets into the buffer. */
330 unsigned offset[R300_MAX_TEXTURE_LEVELS];
331
332 /* A pitch for each mip-level */
333 unsigned pitch[R300_MAX_TEXTURE_LEVELS];
334
335 /* A pitch multiplied by blockwidth as hardware wants
336 * the number of pixels instead of the number of blocks. */
337 unsigned hwpitch[R300_MAX_TEXTURE_LEVELS];
338
339 /* Size of one zslice or face based on the texture target */
340 unsigned layer_size[R300_MAX_TEXTURE_LEVELS];
341
342 /* Whether the mipmap level is macrotiled. */
343 enum r300_buffer_tiling mip_macrotile[R300_MAX_TEXTURE_LEVELS];
344
345 /**
346 * If non-zero, override the natural texture layout with
347 * a custom stride (in bytes).
348 *
349 * \note Mipmapping fails for textures with a non-natural layout!
350 *
351 * \sa r300_texture_get_stride
352 */
353 unsigned stride_override;
354
355 /* Total size of this texture, in bytes. */
356 unsigned size;
357
358 /* Whether this texture has non-power-of-two dimensions
359 * or a user-specified pitch.
360 * It can be either a regular texture or a rectangle one.
361 */
362 boolean uses_pitch;
363
364 /* Pipe buffer backing this texture. */
365 struct r300_winsys_buffer *buffer;
366
367 /* Registers carrying texture format data. */
368 /* Only format-independent bits should be filled in. */
369 struct r300_texture_format_state tx_format;
370 /* All bits should be filled in. */
371 struct r300_texture_fb_state fb_state;
372
373 /* Buffer tiling */
374 enum r300_buffer_tiling microtile, macrotile;
375
376 /* This is the level tiling flags were last time set for.
377 * It's used to prevent redundant tiling-flags changes from happening.*/
378 unsigned surface_level;
379 };
380
381 struct r300_vertex_element_state {
382 unsigned count;
383 struct pipe_vertex_element velem[PIPE_MAX_ATTRIBS];
384
385 /* If (velem[i].src_format != hw_format[i]), the vertex buffer
386 * referenced by this vertex element cannot be used for rendering and
387 * its vertex data must be translated to hw_format[i]. */
388 enum pipe_format hw_format[PIPE_MAX_ATTRIBS];
389 unsigned hw_format_size[PIPE_MAX_ATTRIBS];
390
391 /* The size of the vertex, in dwords. */
392 unsigned vertex_size_dwords;
393
394 /* This might mean two things:
395 * - src_format != hw_format, as discussed above.
396 * - src_offset % 4 != 0. */
397 boolean incompatible_layout;
398
399 struct r300_vertex_stream_state vertex_stream;
400 };
401
402 struct r300_translate_context {
403 /* Translate cache for incompatible vertex offset/stride/format fallback. */
404 struct translate_cache *translate_cache;
405
406 /* The vertex buffer slot containing the translated buffer. */
407 unsigned vb_slot;
408
409 /* Saved and new vertex element state. */
410 void *saved_velems, *new_velems;
411 };
412
413 struct r300_context {
414 /* Parent class */
415 struct pipe_context context;
416
417 /* The interface to the windowing system, etc. */
418 struct r300_winsys_screen *rws;
419 /* The command stream. */
420 struct r300_winsys_cs *cs;
421 /* Screen. */
422 struct r300_screen *screen;
423 /* Draw module. Used mostly for SW TCL. */
424 struct draw_context* draw;
425 /* Accelerated blit support. */
426 struct blitter_context* blitter;
427 /* Stencil two-sided reference value fallback. */
428 struct r300_stencilref_context *stencilref_fallback;
429 /* For translating vertex buffers having incompatible vertex layout. */
430 struct r300_translate_context tran;
431
432 /* Vertex buffer for rendering. */
433 struct pipe_resource* vbo;
434 /* The KIL opcode needs the first texture unit to be enabled
435 * on r3xx-r4xx. In order to calm down the CS checker, we bind this
436 * dummy texture there. */
437 struct r300_sampler_view *texkill_sampler;
438 /* Offset into the VBO. */
439 size_t vbo_offset;
440
441 /* The currently active query. */
442 struct r300_query *query_current;
443 /* The saved query for blitter operations. */
444 struct r300_query *blitter_saved_query;
445 /* Query list. */
446 struct r300_query query_list;
447
448 /* Various CSO state objects. */
449 /* Beginning of atom list. */
450 struct r300_atom atom_list;
451 /* Anti-aliasing (MSAA) state. */
452 struct r300_atom aa_state;
453 /* Blend state. */
454 struct r300_atom blend_state;
455 /* Blend color state. */
456 struct r300_atom blend_color_state;
457 /* User clip planes. */
458 struct r300_atom clip_state;
459 /* Depth, stencil, and alpha state. */
460 struct r300_atom dsa_state;
461 /* Fragment shader. */
462 struct r300_atom fs;
463 /* Fragment shader RC_CONSTANT_STATE variables. */
464 struct r300_atom fs_rc_constant_state;
465 /* Fragment shader constant buffer. */
466 struct r300_atom fs_constants;
467 /* Framebuffer state. */
468 struct r300_atom fb_state;
469 /* Framebuffer state (pipelined regs). */
470 struct r300_atom fb_state_pipelined;
471 /* HyperZ state (various SC/ZB bits). */
472 struct r300_atom hyperz_state;
473 /* Occlusion query. */
474 struct r300_atom query_start;
475 /* Rasterizer state. */
476 struct r300_atom rs_state;
477 /* RS block state + VAP (vertex shader) output mapping state. */
478 struct r300_atom rs_block_state;
479 /* Scissor state. */
480 struct r300_atom scissor_state;
481 /* Textures state. */
482 struct r300_atom textures_state;
483 /* Vertex stream formatting state. */
484 struct r300_atom vertex_stream_state;
485 /* Vertex shader. */
486 struct r300_atom vs_state;
487 /* Vertex shader constant buffer. */
488 struct r300_atom vs_constants;
489 /* Viewport state. */
490 struct r300_atom viewport_state;
491 /* ZTOP state. */
492 struct r300_atom ztop_state;
493 /* PVS flush. */
494 struct r300_atom pvs_flush;
495 /* VAP invariant state. */
496 struct r300_atom vap_invariant_state;
497 /* Texture cache invalidate. */
498 struct r300_atom texture_cache_inval;
499 /* GPU flush. */
500 struct r300_atom gpu_flush;
501
502 /* Invariant state. This must be emitted to get the engine started. */
503 struct r300_atom invariant_state;
504
505 /* Vertex buffers for Gallium. */
506 struct pipe_vertex_buffer vertex_buffer[PIPE_MAX_ATTRIBS];
507 int vertex_buffer_count;
508 int vertex_buffer_max_index;
509 /* Vertex elements for Gallium. */
510 struct r300_vertex_element_state *velems;
511 bool any_user_vbs;
512
513 /* Vertex info for Draw. */
514 struct vertex_info vertex_info;
515
516 struct pipe_stencil_ref stencil_ref;
517 struct pipe_viewport_state viewport;
518
519 /* Stream locations for SWTCL. */
520 int stream_loc_notcl[16];
521
522 /* Flag indicating whether or not the HW is dirty. */
523 uint32_t dirty_hw;
524 /* Whether polygon offset is enabled. */
525 boolean polygon_offset_enabled;
526 /* Z buffer bit depth. */
527 uint32_t zbuffer_bpp;
528 /* Whether rendering is conditional and should be skipped. */
529 boolean skip_rendering;
530 /* Point sprites texcoord index, 1 bit per texcoord */
531 int sprite_coord_enable;
532 /* Whether two-sided color selection is enabled (AKA light_twoside). */
533 boolean two_sided_color;
534 /* Incompatible vertex buffer layout? (misaligned stride or buffer_offset) */
535 boolean incompatible_vb_layout;
536
537 boolean cbzb_clear;
538 /* upload managers */
539 struct u_upload_mgr *upload_vb;
540 struct u_upload_mgr *upload_ib;
541
542 struct util_mempool pool_transfers;
543
544 /* Stat counter. */
545 uint64_t flush_counter;
546 };
547
548 /* Convenience cast wrappers. */
549 static INLINE struct r300_query* r300_query(struct pipe_query* q)
550 {
551 return (struct r300_query*)q;
552 }
553
554 static INLINE struct r300_surface* r300_surface(struct pipe_surface* surf)
555 {
556 return (struct r300_surface*)surf;
557 }
558
559 static INLINE struct r300_texture* r300_texture(struct pipe_resource* tex)
560 {
561 return (struct r300_texture*)tex;
562 }
563
564 static INLINE struct r300_context* r300_context(struct pipe_context* context)
565 {
566 return (struct r300_context*)context;
567 }
568
569 static INLINE struct r300_fragment_shader *r300_fs(struct r300_context *r300)
570 {
571 return (struct r300_fragment_shader*)r300->fs.state;
572 }
573
574 struct pipe_context* r300_create_context(struct pipe_screen* screen,
575 void *priv);
576
577 void r300_finish(struct r300_context *r300);
578 void r300_flush_cb(void *data);
579
580 /* Context initialization. */
581 struct draw_stage* r300_draw_stage(struct r300_context* r300);
582 void r300_init_blit_functions(struct r300_context *r300);
583 void r300_init_flush_functions(struct r300_context* r300);
584 void r300_init_query_functions(struct r300_context* r300);
585 void r300_init_render_functions(struct r300_context *r300);
586 void r300_init_state_functions(struct r300_context* r300);
587 void r300_init_resource_functions(struct r300_context* r300);
588
589 /* r300_query.c */
590 void r300_resume_query(struct r300_context *r300,
591 struct r300_query *query);
592 void r300_stop_query(struct r300_context *r300);
593
594 /* r300_render_translate.c */
595 void r300_begin_vertex_translate(struct r300_context *r300);
596 void r300_end_vertex_translate(struct r300_context *r300);
597 void r300_translate_index_buffer(struct r300_context *r300,
598 struct pipe_resource **index_buffer,
599 unsigned *index_size, unsigned index_offset,
600 unsigned *start, unsigned count);
601
602 /* r300_render_stencilref.c */
603 void r300_plug_in_stencil_ref_fallback(struct r300_context *r300);
604
605 /* r300_state.c */
606 enum r300_fb_state_change {
607 R300_CHANGED_FB_STATE = 0,
608 R300_CHANGED_CBZB_FLAG
609 };
610
611 void r300_mark_fb_state_dirty(struct r300_context *r300,
612 enum r300_fb_state_change change);
613 void r300_mark_fs_code_dirty(struct r300_context *r300);
614
615 /* r300_debug.c */
616 void r500_dump_rs_block(struct r300_rs_block *rs);
617
618
619 static INLINE boolean CTX_DBG_ON(struct r300_context * ctx, unsigned flags)
620 {
621 return SCREEN_DBG_ON(ctx->screen, flags);
622 }
623
624 static INLINE void CTX_DBG(struct r300_context * ctx, unsigned flags,
625 const char * fmt, ...)
626 {
627 if (CTX_DBG_ON(ctx, flags)) {
628 va_list va;
629 va_start(va, fmt);
630 vfprintf(stderr, fmt, va);
631 va_end(va);
632 }
633 }
634
635 #define DBG_ON CTX_DBG_ON
636 #define DBG CTX_DBG
637
638 #endif /* R300_CONTEXT_H */