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 spawining 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 contigous
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.
118 #define BRW_FALLBACK_TEXTURE 0x1
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_INPUT_VARYING 0x200
133 #define BRW_NEW_PSP 0x800
134 #define BRW_NEW_METAOPS 0x1000
135 #define BRW_NEW_FENCE 0x2000
136 #define BRW_NEW_INDICES 0x4000
137 #define BRW_NEW_VERTICES 0x8000
139 * Used for any batch entry with a relocated pointer that will be used
140 * by any 3D rendering.
142 #define BRW_NEW_BATCH 0x10000
143 /** brw->depth_region updated */
144 #define BRW_NEW_DEPTH_BUFFER 0x20000
145 #define BRW_NEW_NR_SURFACES 0x40000
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 */
158 struct brw_vertex_program
{
159 struct gl_vertex_program program
;
165 struct brw_fragment_program
{
166 struct gl_fragment_program program
;
173 /* Data about a particular attempt to compile a program. Note that
174 * there can be many of these, each in a different GL state
175 * corresponding to a different brw_wm_prog_key struct, with different
178 struct brw_wm_prog_data
{
179 GLuint curb_read_length
;
180 GLuint urb_read_length
;
182 GLuint first_curbe_grf
;
184 GLuint total_scratch
;
189 /* Pointer to tracked values (only valid once
190 * _mesa_load_state_parameters has been called at runtime).
192 const GLfloat
*param
[BRW_MAX_CURBE
];
195 struct brw_sf_prog_data
{
196 GLuint urb_read_length
;
199 /* Each vertex may have upto 12 attributes, 4 components each,
200 * except WPOS which requires only 2. (11*4 + 2) == 44 ==> 11
203 * Actually we use 4 for each, so call it 12 rows.
205 GLuint urb_entry_size
;
208 struct brw_clip_prog_data
{
209 GLuint curb_read_length
; /* user planes? */
211 GLuint urb_read_length
;
215 struct brw_gs_prog_data
{
216 GLuint urb_read_length
;
220 struct brw_vs_prog_data
{
221 GLuint curb_read_length
;
222 GLuint urb_read_length
;
224 GLuint outputs_written
;
228 /* Used for calculating urb partitions:
230 GLuint urb_entry_size
;
234 /* Size == 0 if output either not written, or always [0,0,0,1]
236 struct brw_vs_ouput_sizes
{
237 GLubyte output_size
[VERT_RESULT_MAX
];
241 #define BRW_MAX_TEX_UNIT 8
242 #define BRW_WM_MAX_SURF BRW_MAX_TEX_UNIT + MAX_DRAW_BUFFERS
248 BRW_SAMPLER_DEFAULT_COLOR
,
267 struct brw_cache_item
{
269 * Effectively part of the key, cache_id identifies what kind of state
270 * buffer is involved, and also which brw->state.dirty.cache flag should
271 * be set when this cache item is chosen.
273 enum brw_cache_id cache_id
;
274 /** 32-bit hash of the key data */
276 GLuint key_size
; /* for variable-sized keys */
279 GLuint nr_reloc_bufs
;
284 struct brw_cache_item
*next
;
290 struct brw_context
*brw
;
292 struct brw_cache_item
**items
;
293 GLuint size
, n_items
;
295 GLuint key_size
[BRW_MAX_CACHE
]; /* for fixed-size keys */
296 GLuint aux_size
[BRW_MAX_CACHE
];
297 char *name
[BRW_MAX_CACHE
];
299 /* Record of the last BOs chosen for each cache_id. Used to set
300 * brw->state.dirty.cache when a new cache item is chosen.
302 dri_bo
*last_bo
[BRW_MAX_CACHE
];
307 struct brw_state_pointers
{
308 struct gl_colorbuffer_attrib
*Color
;
309 struct gl_depthbuffer_attrib
*Depth
;
310 struct gl_fog_attrib
*Fog
;
311 struct gl_hint_attrib
*Hint
;
312 struct gl_light_attrib
*Light
;
313 struct gl_line_attrib
*Line
;
314 struct gl_point_attrib
*Point
;
315 struct gl_polygon_attrib
*Polygon
;
316 GLuint
*PolygonStipple
;
317 struct gl_scissor_attrib
*Scissor
;
318 struct gl_stencil_attrib
*Stencil
;
319 struct gl_texture_attrib
*Texture
;
320 struct gl_transform_attrib
*Transform
;
321 struct gl_viewport_attrib
*Viewport
;
322 struct gl_vertex_program_state
*VertexProgram
;
323 struct gl_fragment_program_state
*FragmentProgram
;
326 /* Considered adding a member to this struct to document which flags
327 * an update might raise so that ordering of the state atoms can be
328 * checked or derived at runtime. Dropped the idea in favor of having
329 * a debug mode where the state is monitored for flags which are
330 * raised that have already been tested against.
332 struct brw_tracked_state
{
333 struct brw_state_flags dirty
;
334 void (*prepare
)( struct brw_context
*brw
);
335 void (*emit
)( struct brw_context
*brw
);
338 /* Flags for brw->state.cache.
340 #define CACHE_NEW_CC_VP (1<<BRW_CC_VP)
341 #define CACHE_NEW_CC_UNIT (1<<BRW_CC_UNIT)
342 #define CACHE_NEW_WM_PROG (1<<BRW_WM_PROG)
343 #define CACHE_NEW_SAMPLER_DEFAULT_COLOR (1<<BRW_SAMPLER_DEFAULT_COLOR)
344 #define CACHE_NEW_SAMPLER (1<<BRW_SAMPLER)
345 #define CACHE_NEW_WM_UNIT (1<<BRW_WM_UNIT)
346 #define CACHE_NEW_SF_PROG (1<<BRW_SF_PROG)
347 #define CACHE_NEW_SF_VP (1<<BRW_SF_VP)
348 #define CACHE_NEW_SF_UNIT (1<<BRW_SF_UNIT)
349 #define CACHE_NEW_VS_UNIT (1<<BRW_VS_UNIT)
350 #define CACHE_NEW_VS_PROG (1<<BRW_VS_PROG)
351 #define CACHE_NEW_GS_UNIT (1<<BRW_GS_UNIT)
352 #define CACHE_NEW_GS_PROG (1<<BRW_GS_PROG)
353 #define CACHE_NEW_CLIP_VP (1<<BRW_CLIP_VP)
354 #define CACHE_NEW_CLIP_UNIT (1<<BRW_CLIP_UNIT)
355 #define CACHE_NEW_CLIP_PROG (1<<BRW_CLIP_PROG)
356 #define CACHE_NEW_SURFACE (1<<BRW_SS_SURFACE)
357 #define CACHE_NEW_SURF_BIND (1<<BRW_SS_SURF_BIND)
359 struct brw_cached_batch_item
{
360 struct header
*header
;
362 struct brw_cached_batch_item
*next
;
367 /* Protect against a future where VERT_ATTRIB_MAX > 32. Wouldn't life
368 * be easier if C allowed arrays of packed elements?
370 #define ATTRIB_BIT_DWORDS ((VERT_ATTRIB_MAX+31)/32)
372 struct brw_vertex_element
{
373 const struct gl_client_array
*glarray
;
375 /** Size of a complete element */
377 /** Number of uploaded elements for this input. */
379 /** Byte stride between elements in the uploaded array */
381 /** Offset of the first element within the buffer object */
383 /** Buffer object containing the uploaded vertex data */
389 struct brw_vertex_info
{
390 GLuint varying
; /* varying:1[VERT_ATTRIB_MAX] */
391 GLuint sizes
[ATTRIB_BIT_DWORDS
* 2]; /* sizes:2[VERT_ATTRIB_MAX] */
397 /* Cache for TNL programs.
399 struct brw_tnl_cache_item
{
403 struct brw_tnl_cache_item
*next
;
406 struct brw_tnl_cache
{
407 struct brw_tnl_cache_item
**items
;
408 GLuint size
, n_items
;
411 struct brw_query_object
{
412 struct gl_query_object Base
;
414 /** Doubly linked list of active query objects in the context. */
415 struct brw_query_object
*prev
, *next
;
417 /** Last query BO associated with this query. */
419 /** First index in bo with query data for this object. */
421 /** Last index in bo with query data for this object. */
424 /* Total count of pixels from previous BOs */
430 struct intel_context intel
;
433 GLboolean emit_state_always
;
434 GLboolean tmp_fallback
;
435 GLboolean no_batch_wrap
;
438 struct brw_state_flags dirty
;
439 struct brw_tracked_state
**atoms
;
442 GLuint nr_draw_regions
;
443 struct intel_region
*draw_regions
[MAX_DRAW_BUFFERS
];
444 struct intel_region
*depth_region
;
447 * List of buffers accumulated in brw_validate_state to receive
448 * dri_bo_check_aperture treatment before exec, so we can know if we
449 * should flush the batch and try again before emitting primitives.
451 * This can be a fixed number as we only have a limited number of
452 * objects referenced from the batchbuffer in a primitive emit,
453 * consisting of the vertex buffers, pipelined state pointers,
454 * the CURBE, the depth buffer, and a query BO.
456 dri_bo
*validated_bos
[VERT_ATTRIB_MAX
+ 16];
457 int validated_bo_count
;
460 struct brw_state_pointers attribs
;
461 struct brw_cache cache
;
462 struct brw_cached_batch_item
*cached_batch_items
;
465 struct brw_vertex_element inputs
[VERT_ATTRIB_MAX
];
467 #define BRW_NR_UPLOAD_BUFS 17
468 #define BRW_UPLOAD_INIT_SIZE (128*1024)
475 /* Summary of size and varying of active arrays, so we can check
476 * for changes to this state:
478 struct brw_vertex_info info
;
479 unsigned int min_index
, max_index
;
484 * Index buffer for this draw_prims call.
486 * Updates are signaled by BRW_NEW_INDICES.
488 const struct _mesa_index_buffer
*ib
;
495 /* Will be allocated on demand if needed.
497 struct brw_state_pointers attribs
;
498 struct gl_vertex_program
*vp
;
499 struct gl_fragment_program
*fp
, *fp_tex
;
501 struct gl_buffer_object
*vbo
;
503 struct intel_region
*saved_draw_region
;
504 GLuint saved_nr_draw_regions
;
505 struct intel_region
*saved_depth_region
;
507 GLuint restore_draw_buffers
[MAX_DRAW_BUFFERS
];
508 GLuint restore_num_draw_buffers
;
510 struct gl_fragment_program
*restore_fp
;
516 /* Active vertex program:
518 const struct gl_vertex_program
*vertex_program
;
519 const struct gl_fragment_program
*fragment_program
;
522 /* For populating the gtt:
524 GLuint next_free_page
;
527 /* BRW_NEW_URB_ALLOCATIONS:
530 GLuint vsize
; /* vertex size plus header in urb registers */
531 GLuint csize
; /* constant buffer size in urb registers */
532 GLuint sfsize
; /* setup data size in urb registers */
534 GLboolean constrained
;
536 GLuint nr_vs_entries
;
537 GLuint nr_gs_entries
;
538 GLuint nr_clip_entries
;
539 GLuint nr_sf_entries
;
540 GLuint nr_cs_entries
;
542 /* GLuint vs_size; */
543 /* GLuint gs_size; */
544 /* GLuint clip_size; */
545 /* GLuint sf_size; */
546 /* GLuint cs_size; */
556 /* BRW_NEW_CURBE_OFFSETS:
567 /* Dynamic tracker which changes to reflect the state referenced
568 * by active fp and vp program parameters:
570 struct brw_tracked_state tracked_state
;
573 /** Offset within curbe_bo of space for current curbe entry */
575 /** Offset within curbe_bo of space for next curbe entry */
576 GLuint curbe_next_offset
;
581 * Whether we should create a new bo instead of reusing the old one
582 * (if we just dispatch the batch pointing at the old one.
584 GLboolean need_new_bo
;
588 struct brw_vs_prog_data
*prog_data
;
595 struct brw_gs_prog_data
*prog_data
;
597 GLboolean prog_active
;
603 struct brw_clip_prog_data
*prog_data
;
612 struct brw_sf_prog_data
*prog_data
;
620 struct brw_wm_prog_data
*prog_data
;
621 struct brw_wm_compile
*compile_data
;
623 /* Input sizes, calculated from active vertex program:
625 GLuint input_size_masks
[4];
627 /** Array of surface default colors (texture border color) */
628 dri_bo
*sdc_bo
[BRW_MAX_TEX_UNIT
];
634 dri_bo
*scratch_buffer
;
636 GLuint sampler_count
;
639 /** Binding table of pointers to surf_bo entries */
641 dri_bo
*surf_bo
[BRW_WM_MAX_SURF
];
655 struct brw_query_object active_head
;
660 /* Used to give every program string a unique id
666 #define BRW_PACKCOLOR8888(r,g,b,a) ((r<<24) | (g<<16) | (b<<8) | a)
670 /*======================================================================
673 void brwInitVtbl( struct brw_context
*brw
);
674 void brw_do_flush( struct brw_context
*brw
,
677 /*======================================================================
680 GLboolean
brwCreateContext( const __GLcontextModes
*mesaVis
,
681 __DRIcontextPrivate
*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 brwUpdateTextureState( struct intel_context
*intel
);
701 void brw_FrameBufferTexInit( struct brw_context
*brw
,
702 struct intel_region
*region
);
703 void brw_FrameBufferTexDestroy( struct brw_context
*brw
);
704 void brw_validate_textures( struct brw_context
*brw
);
706 /*======================================================================
710 void brw_init_metaops( struct brw_context
*brw
);
711 void brw_destroy_metaops( struct brw_context
*brw
);
714 /*======================================================================
717 void brwInitFragProgFuncs( struct dd_function_table
*functions
);
722 void brw_upload_urb_fence(struct brw_context
*brw
);
724 void brw_upload_constant_buffer_state(struct brw_context
*brw
);
727 /*======================================================================
728 * Inline conversion functions. These are better-typed than the
729 * macros used previously:
731 static INLINE
struct brw_context
*
732 brw_context( GLcontext
*ctx
)
734 return (struct brw_context
*)ctx
;
737 #define DO_SETUP_BITS ((1<<(FRAG_ATTRIB_MAX)) - 1)