2 Copyright (C) Intel Corp. 2006. All Rights Reserved.
3 Intel funded Tungsten Graphics (http://www.tungstengraphics.com) to
4 develop this 3D driver.
6 Permission is hereby granted, free of charge, to any person obtaining
7 a 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, sublicense, 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:
14 The above copyright notice and this permission notice (including the
15 next paragraph) shall be included in all copies or substantial
16 portions of the Software.
18 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
19 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
21 IN NO EVENT SHALL THE COPYRIGHT OWNER(S) AND/OR ITS SUPPLIERS BE
22 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
23 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
24 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
26 **********************************************************************/
29 * Keith Whitwell <keith@tungstengraphics.com>
33 #ifndef BRWCONTEXT_INC
34 #define BRWCONTEXT_INC
36 #include "intel_context.h"
37 #include "brw_structs.h"
38 #include "main/imports.h"
43 * URB - uniform resource buffer. A mid-sized buffer which is
44 * partitioned between the fixed function units and used for passing
45 * values (vertices, primitives, constants) between them.
47 * CURBE - constant URB entry. An urb region (entry) used to hold
48 * constant values which the fixed function units can be instructed to
49 * preload into the GRF when spawning a thread.
51 * VUE - vertex URB entry. An urb entry holding a vertex and usually
52 * a vertex header. The header contains control information and
53 * things like primitive type, Begin/end flags and clip codes.
55 * PUE - primitive URB entry. An urb entry produced by the setup (SF)
56 * unit holding rasterization and interpolation parameters.
58 * GRF - general register file. One of several register files
59 * addressable by programmed threads. The inputs (r0, payload, curbe,
60 * urb) of the thread are preloaded to this area before the thread is
61 * spawned. The registers are individually 8 dwords wide and suitable
62 * for general usage. Registers holding thread input values are not
63 * special and may be overwritten.
65 * MRF - message register file. Threads communicate (and terminate)
66 * by sending messages. Message parameters are placed in contiguous
67 * MRF registers. All program output is via these messages. URB
68 * entries are populated by sending a message to the shared URB
69 * function containing the new data, together with a control word,
70 * often an unmodified copy of R0.
72 * R0 - GRF register 0. Typically holds control information used when
73 * sending messages to other threads.
75 * EU or GEN4 EU: The name of the programmable subsystem of the
76 * i965 hardware. Threads are executed by the EU, the registers
77 * described above are part of the EU architecture.
79 * Fixed function units:
81 * CS - Command streamer. Notional first unit, little software
82 * interaction. Holds the URB entries used for constant data, ie the
85 * VF/VS - Vertex Fetch / Vertex Shader. The fixed function part of
86 * this unit is responsible for pulling vertices out of vertex buffers
87 * in vram and injecting them into the processing pipe as VUEs. If
88 * enabled, it first passes them to a VS thread which is a good place
89 * for the driver to implement any active vertex shader.
91 * GS - Geometry Shader. This corresponds to a new DX10 concept. If
92 * enabled, incoming strips etc are passed to GS threads in individual
93 * line/triangle/point units. The GS thread may perform arbitary
94 * computation and emit whatever primtives with whatever vertices it
95 * chooses. This makes GS an excellent place to implement GL's
96 * unfilled polygon modes, though of course it is capable of much
97 * more. Additionally, GS is used to translate away primitives not
98 * handled by latter units, including Quads and Lineloops.
100 * CS - Clipper. Mesa's clipping algorithms are imported to run on
101 * this unit. The fixed function part performs cliptesting against
102 * the 6 fixed clipplanes and makes descisions on whether or not the
103 * incoming primitive needs to be passed to a thread for clipping.
104 * User clip planes are handled via cooperation with the VS thread.
106 * SF - Strips Fans or Setup: Triangles are prepared for
107 * rasterization. Interpolation coefficients are calculated.
108 * Flatshading and two-side lighting usually performed here.
110 * WM - Windower. Interpolation of vertex attributes performed here.
111 * Fragment shader implemented here. SIMD aspects of EU taken full
112 * advantage of, as pixels are processed in blocks of 16.
114 * CC - Color Calculator. No EU threads associated with this unit.
115 * Handles blending and (presumably) depth and stencil testing.
119 #define BRW_MAX_CURBE (32*16)
123 #define BRW_NEW_URB_FENCE 0x1
124 #define BRW_NEW_FRAGMENT_PROGRAM 0x2
125 #define BRW_NEW_VERTEX_PROGRAM 0x4
126 #define BRW_NEW_INPUT_DIMENSIONS 0x8
127 #define BRW_NEW_CURBE_OFFSETS 0x10
128 #define BRW_NEW_REDUCED_PRIMITIVE 0x20
129 #define BRW_NEW_PRIMITIVE 0x40
130 #define BRW_NEW_CONTEXT 0x80
131 #define BRW_NEW_WM_INPUT_DIMENSIONS 0x100
132 #define BRW_NEW_PSP 0x800
133 #define BRW_NEW_WM_SURFACES 0x1000
134 #define BRW_NEW_INDICES 0x4000
135 #define BRW_NEW_VERTICES 0x8000
137 * Used for any batch entry with a relocated pointer that will be used
138 * by any 3D rendering.
140 #define BRW_NEW_BATCH 0x10000
141 /** brw->depth_region updated */
142 #define BRW_NEW_DEPTH_BUFFER 0x20000
143 #define BRW_NEW_NR_WM_SURFACES 0x40000
144 #define BRW_NEW_NR_VS_SURFACES 0x80000
145 #define BRW_NEW_INDEX_BUFFER 0x100000
147 struct brw_state_flags
{
148 /** State update flags signalled by mesa internals */
151 * State update flags signalled as the result of brw_tracked_state updates
154 /** State update flags signalled by brw_state_cache.c searches */
159 /** Subclass of Mesa vertex program */
160 struct brw_vertex_program
{
161 struct gl_vertex_program program
;
163 dri_bo
*const_buffer
; /** Program constant buffer/surface */
164 GLboolean use_const_buffer
;
168 /** Subclass of Mesa fragment program */
169 struct brw_fragment_program
{
170 struct gl_fragment_program program
;
171 GLuint id
; /**< serial no. to identify frag progs, never re-used */
172 GLboolean isGLSL
; /**< really, any IF/LOOP/CONT/BREAK instructions */
174 GLboolean use_const_buffer
;
175 dri_bo
*const_buffer
; /** Program constant buffer/surface */
177 /** for debugging, which texture units are referenced */
178 GLbitfield tex_units_used
;
182 /* Data about a particular attempt to compile a program. Note that
183 * there can be many of these, each in a different GL state
184 * corresponding to a different brw_wm_prog_key struct, with different
187 struct brw_wm_prog_data
{
188 GLuint curb_read_length
;
189 GLuint urb_read_length
;
191 GLuint first_curbe_grf
;
193 GLuint total_scratch
;
195 GLuint nr_params
; /**< number of float params/constants */
198 /* Pointer to tracked values (only valid once
199 * _mesa_load_state_parameters has been called at runtime).
201 const GLfloat
*param
[BRW_MAX_CURBE
];
204 struct brw_sf_prog_data
{
205 GLuint urb_read_length
;
208 /* Each vertex may have upto 12 attributes, 4 components each,
209 * except WPOS which requires only 2. (11*4 + 2) == 44 ==> 11
212 * Actually we use 4 for each, so call it 12 rows.
214 GLuint urb_entry_size
;
217 struct brw_clip_prog_data
{
218 GLuint curb_read_length
; /* user planes? */
220 GLuint urb_read_length
;
224 struct brw_gs_prog_data
{
225 GLuint urb_read_length
;
229 struct brw_vs_prog_data
{
230 GLuint curb_read_length
;
231 GLuint urb_read_length
;
233 GLbitfield64 outputs_written
;
234 GLuint nr_params
; /**< number of float params/constants */
238 /* Used for calculating urb partitions:
240 GLuint urb_entry_size
;
244 /* Size == 0 if output either not written, or always [0,0,0,1]
246 struct brw_vs_ouput_sizes
{
247 GLubyte output_size
[VERT_RESULT_MAX
];
251 /** Number of texture sampler units */
252 #define BRW_MAX_TEX_UNIT 16
254 /** Max number of render targets in a shader */
255 #define BRW_MAX_DRAW_BUFFERS 4
258 * Size of our surface binding table for the WM.
259 * This contains pointers to the drawing surfaces and current texture
260 * objects and shader constant buffers (+2).
262 #define BRW_WM_MAX_SURF (BRW_MAX_DRAW_BUFFERS + BRW_MAX_TEX_UNIT + 1)
265 * Helpers to convert drawing buffers, textures and constant buffers
266 * to surface binding table indexes, for WM.
268 #define SURF_INDEX_DRAW(d) (d)
269 #define SURF_INDEX_FRAG_CONST_BUFFER (BRW_MAX_DRAW_BUFFERS)
270 #define SURF_INDEX_TEXTURE(t) (BRW_MAX_DRAW_BUFFERS + 1 + (t))
273 * Size of surface binding table for the VS.
274 * Only one constant buffer for now.
276 #define BRW_VS_MAX_SURF 1
279 * Only a VS constant buffer
281 #define SURF_INDEX_VERT_CONST_BUFFER 0
288 BRW_SAMPLER_DEFAULT_COLOR
,
307 struct brw_cache_item
{
309 * Effectively part of the key, cache_id identifies what kind of state
310 * buffer is involved, and also which brw->state.dirty.cache flag should
311 * be set when this cache item is chosen.
313 enum brw_cache_id cache_id
;
314 /** 32-bit hash of the key data */
316 GLuint key_size
; /* for variable-sized keys */
319 GLuint nr_reloc_bufs
;
323 struct brw_cache_item
*next
;
329 struct brw_context
*brw
;
331 struct brw_cache_item
**items
;
332 GLuint size
, n_items
;
334 char *name
[BRW_MAX_CACHE
];
336 /* Record of the last BOs chosen for each cache_id. Used to set
337 * brw->state.dirty.cache when a new cache item is chosen.
339 dri_bo
*last_bo
[BRW_MAX_CACHE
];
343 /* Considered adding a member to this struct to document which flags
344 * an update might raise so that ordering of the state atoms can be
345 * checked or derived at runtime. Dropped the idea in favor of having
346 * a debug mode where the state is monitored for flags which are
347 * raised that have already been tested against.
349 struct brw_tracked_state
{
350 struct brw_state_flags dirty
;
351 void (*prepare
)( struct brw_context
*brw
);
352 void (*emit
)( struct brw_context
*brw
);
355 /* Flags for brw->state.cache.
357 #define CACHE_NEW_CC_VP (1<<BRW_CC_VP)
358 #define CACHE_NEW_CC_UNIT (1<<BRW_CC_UNIT)
359 #define CACHE_NEW_WM_PROG (1<<BRW_WM_PROG)
360 #define CACHE_NEW_SAMPLER_DEFAULT_COLOR (1<<BRW_SAMPLER_DEFAULT_COLOR)
361 #define CACHE_NEW_SAMPLER (1<<BRW_SAMPLER)
362 #define CACHE_NEW_WM_UNIT (1<<BRW_WM_UNIT)
363 #define CACHE_NEW_SF_PROG (1<<BRW_SF_PROG)
364 #define CACHE_NEW_SF_VP (1<<BRW_SF_VP)
365 #define CACHE_NEW_SF_UNIT (1<<BRW_SF_UNIT)
366 #define CACHE_NEW_VS_UNIT (1<<BRW_VS_UNIT)
367 #define CACHE_NEW_VS_PROG (1<<BRW_VS_PROG)
368 #define CACHE_NEW_GS_UNIT (1<<BRW_GS_UNIT)
369 #define CACHE_NEW_GS_PROG (1<<BRW_GS_PROG)
370 #define CACHE_NEW_CLIP_VP (1<<BRW_CLIP_VP)
371 #define CACHE_NEW_CLIP_UNIT (1<<BRW_CLIP_UNIT)
372 #define CACHE_NEW_CLIP_PROG (1<<BRW_CLIP_PROG)
373 #define CACHE_NEW_SURFACE (1<<BRW_SS_SURFACE)
374 #define CACHE_NEW_SURF_BIND (1<<BRW_SS_SURF_BIND)
376 struct brw_cached_batch_item
{
377 struct header
*header
;
379 struct brw_cached_batch_item
*next
;
384 /* Protect against a future where VERT_ATTRIB_MAX > 32. Wouldn't life
385 * be easier if C allowed arrays of packed elements?
387 #define ATTRIB_BIT_DWORDS ((VERT_ATTRIB_MAX+31)/32)
389 struct brw_vertex_element
{
390 const struct gl_client_array
*glarray
;
392 /** The corresponding Mesa vertex attribute */
393 gl_vert_attrib attrib
;
394 /** Size of a complete element */
396 /** Number of uploaded elements for this input. */
398 /** Byte stride between elements in the uploaded array */
400 /** Offset of the first element within the buffer object */
402 /** Buffer object containing the uploaded vertex data */
408 struct brw_vertex_info
{
409 GLuint sizes
[ATTRIB_BIT_DWORDS
* 2]; /* sizes:2[VERT_ATTRIB_MAX] */
412 struct brw_query_object
{
413 struct gl_query_object Base
;
415 /** Doubly linked list of active query objects in the context. */
416 struct brw_query_object
*prev
, *next
;
418 /** Last query BO associated with this query. */
420 /** First index in bo with query data for this object. */
422 /** Last index in bo with query data for this object. */
425 /* Total count of pixels from previous BOs */
431 * brw_context is derived from intel_context.
435 struct intel_context intel
; /**< base class, must be first field */
438 GLboolean emit_state_always
;
439 GLboolean has_surface_tile_offset
;
440 GLboolean has_compr4
;
441 GLboolean has_negative_rhw_bug
;
442 GLboolean has_aa_line_parameters
;
445 struct brw_state_flags dirty
;
447 GLuint nr_color_regions
;
448 struct intel_region
*color_regions
[MAX_DRAW_BUFFERS
];
449 struct intel_region
*depth_region
;
452 * List of buffers accumulated in brw_validate_state to receive
453 * dri_bo_check_aperture treatment before exec, so we can know if we
454 * should flush the batch and try again before emitting primitives.
456 * This can be a fixed number as we only have a limited number of
457 * objects referenced from the batchbuffer in a primitive emit,
458 * consisting of the vertex buffers, pipelined state pointers,
459 * the CURBE, the depth buffer, and a query BO.
461 dri_bo
*validated_bos
[VERT_ATTRIB_MAX
+ 16];
462 int validated_bo_count
;
465 struct brw_cache cache
; /** non-surface items */
466 struct brw_cache surface_cache
; /* surface items */
467 struct brw_cached_batch_item
*cached_batch_items
;
470 struct brw_vertex_element inputs
[VERT_ATTRIB_MAX
];
472 struct brw_vertex_element
*enabled
[VERT_ATTRIB_MAX
];
475 #define BRW_NR_UPLOAD_BUFS 17
476 #define BRW_UPLOAD_INIT_SIZE (128*1024)
483 /* Summary of size and varying of active arrays, so we can check
484 * for changes to this state:
486 struct brw_vertex_info info
;
487 unsigned int min_index
, max_index
;
492 * Index buffer for this draw_prims call.
494 * Updates are signaled by BRW_NEW_INDICES.
496 const struct _mesa_index_buffer
*ib
;
498 /* Updates to these fields are signaled by BRW_NEW_INDEX_BUFFER. */
502 /* Offset to index buffer index to use in CMD_3D_PRIM so that we can
503 * avoid re-uploading the IB packet over and over if we're actually
504 * referencing the same index buffer.
506 unsigned int start_vertex_offset
;
509 /* Active vertex program:
511 const struct gl_vertex_program
*vertex_program
;
512 const struct gl_fragment_program
*fragment_program
;
515 /* For populating the gtt:
517 GLuint next_free_page
;
519 /* hw-dependent 3DSTATE_VF_STATISTICS opcode */
520 uint32_t CMD_VF_STATISTICS
;
521 /* hw-dependent 3DSTATE_PIPELINE_SELECT opcode */
522 uint32_t CMD_PIPELINE_SELECT
;
526 /* BRW_NEW_URB_ALLOCATIONS:
529 GLuint vsize
; /* vertex size plus header in urb registers */
530 GLuint csize
; /* constant buffer size in urb registers */
531 GLuint sfsize
; /* setup data size in urb registers */
533 GLboolean constrained
;
535 GLuint nr_vs_entries
;
536 GLuint nr_gs_entries
;
537 GLuint nr_clip_entries
;
538 GLuint nr_sf_entries
;
539 GLuint nr_cs_entries
;
541 /* GLuint vs_size; */
542 /* GLuint gs_size; */
543 /* GLuint clip_size; */
544 /* GLuint sf_size; */
545 /* GLuint cs_size; */
552 GLuint size
; /* Hardware URB size, in KB. */
556 /* BRW_NEW_CURBE_OFFSETS:
559 GLuint wm_start
; /**< pos of first wm const in CURBE buffer */
560 GLuint wm_size
; /**< number of float[4] consts, multiple of 16 */
568 /** Offset within curbe_bo of space for current curbe entry */
570 /** Offset within curbe_bo of space for next curbe entry */
571 GLuint curbe_next_offset
;
576 * Whether we should create a new bo instead of reusing the old one
577 * (if we just dispatch the batch pointing at the old one.
579 GLboolean need_new_bo
;
583 struct brw_vs_prog_data
*prog_data
;
584 int8_t *constant_map
; /* variable array following prog_data */
589 /** Binding table of pointers to surf_bo entries */
591 dri_bo
*surf_bo
[BRW_VS_MAX_SURF
];
596 struct brw_gs_prog_data
*prog_data
;
598 GLboolean prog_active
;
604 struct brw_clip_prog_data
*prog_data
;
613 struct brw_sf_prog_data
*prog_data
;
621 struct brw_wm_prog_data
*prog_data
;
622 struct brw_wm_compile
*compile_data
;
624 /** Input sizes, calculated from active vertex program.
625 * One bit per fragment program input attribute.
627 GLbitfield input_size_masks
[4];
629 /** Array of surface default colors (texture border color) */
630 dri_bo
*sdc_bo
[BRW_MAX_TEX_UNIT
];
638 GLuint sampler_count
;
641 /** Binding table of pointers to surf_bo entries */
643 dri_bo
*surf_bo
[BRW_WM_MAX_SURF
];
657 struct brw_query_object active_head
;
662 /* Used to give every program string a unique id
668 #define BRW_PACKCOLOR8888(r,g,b,a) ((r<<24) | (g<<16) | (b<<8) | a)
672 /*======================================================================
675 void brwInitVtbl( struct brw_context
*brw
);
677 /*======================================================================
680 GLboolean
brwCreateContext( const __GLcontextModes
*mesaVis
,
681 __DRIcontext
*driContextPriv
,
682 void *sharedContextPrivate
);
684 /*======================================================================
687 void brw_init_queryobj_functions(struct dd_function_table
*functions
);
688 void brw_prepare_query_begin(struct brw_context
*brw
);
689 void brw_emit_query_begin(struct brw_context
*brw
);
690 void brw_emit_query_end(struct brw_context
*brw
);
692 /*======================================================================
695 void brw_debug_batch(struct intel_context
*intel
);
697 /*======================================================================
700 void brw_validate_textures( struct brw_context
*brw
);
703 /*======================================================================
706 void brwInitFragProgFuncs( struct dd_function_table
*functions
);
711 void brw_upload_urb_fence(struct brw_context
*brw
);
715 void brw_upload_cs_urb_state(struct brw_context
*brw
);
718 int brw_disasm (FILE *file
, struct brw_instruction
*inst
);
720 /*======================================================================
721 * Inline conversion functions. These are better-typed than the
722 * macros used previously:
724 static INLINE
struct brw_context
*
725 brw_context( GLcontext
*ctx
)
727 return (struct brw_context
*)ctx
;
730 static INLINE
struct brw_vertex_program
*
731 brw_vertex_program(struct gl_vertex_program
*p
)
733 return (struct brw_vertex_program
*) p
;
736 static INLINE
const struct brw_vertex_program
*
737 brw_vertex_program_const(const struct gl_vertex_program
*p
)
739 return (const struct brw_vertex_program
*) p
;
742 static INLINE
struct brw_fragment_program
*
743 brw_fragment_program(struct gl_fragment_program
*p
)
745 return (struct brw_fragment_program
*) p
;
748 static INLINE
const struct brw_fragment_program
*
749 brw_fragment_program_const(const struct gl_fragment_program
*p
)
751 return (const struct brw_fragment_program
*) p
;