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_BINDING_TABLE 0x2000
135 #define BRW_NEW_INDICES 0x4000
136 #define BRW_NEW_VERTICES 0x8000
138 * Used for any batch entry with a relocated pointer that will be used
139 * by any 3D rendering.
141 #define BRW_NEW_BATCH 0x10000
142 /** \see brw.state.depth_region */
143 #define BRW_NEW_DEPTH_BUFFER 0x20000
144 #define BRW_NEW_NR_WM_SURFACES 0x40000
145 #define BRW_NEW_NR_VS_SURFACES 0x80000
146 #define BRW_NEW_INDEX_BUFFER 0x100000
147 #define BRW_NEW_VS_CONSTBUF 0x200000
148 #define BRW_NEW_WM_CONSTBUF 0x400000
150 struct brw_state_flags {
151 /** State update flags signalled by mesa internals */
154 * State update flags signalled as the result of brw_tracked_state updates
157 /** State update flags signalled by brw_state_cache.c searches */
162 /** Subclass of Mesa vertex program */
163 struct brw_vertex_program {
164 struct gl_vertex_program program;
166 GLboolean use_const_buffer;
170 /** Subclass of Mesa fragment program */
171 struct brw_fragment_program {
172 struct gl_fragment_program program;
173 GLuint id; /**< serial no. to identify frag progs, never re-used */
175 /** for debugging, which texture units are referenced */
176 GLbitfield tex_units_used;
180 struct gl_shader base;
182 /** Shader IR transformed for native compile, at link time. */
183 struct exec_list *ir;
186 struct brw_shader_program {
187 struct gl_shader_program base;
190 enum param_conversion {
197 /* Data about a particular attempt to compile a program. Note that
198 * there can be many of these, each in a different GL state
199 * corresponding to a different brw_wm_prog_key struct, with different
202 struct brw_wm_prog_data {
203 GLuint curb_read_length;
204 GLuint urb_read_length;
206 GLuint first_curbe_grf;
207 GLuint first_curbe_grf_16;
210 GLuint total_scratch;
212 GLuint nr_params; /**< number of float params/constants */
213 GLuint nr_pull_params;
216 uint32_t prog_offset_16;
218 /* Pointer to tracked values (only valid once
219 * _mesa_load_state_parameters has been called at runtime).
221 const float *param[MAX_UNIFORMS * 4]; /* should be: BRW_MAX_CURBE */
222 enum param_conversion param_convert[MAX_UNIFORMS * 4];
223 const float *pull_param[MAX_UNIFORMS * 4];
224 enum param_conversion pull_param_convert[MAX_UNIFORMS * 4];
227 struct brw_sf_prog_data {
228 GLuint urb_read_length;
231 /* Each vertex may have upto 12 attributes, 4 components each,
232 * except WPOS which requires only 2. (11*4 + 2) == 44 ==> 11
235 * Actually we use 4 for each, so call it 12 rows.
237 GLuint urb_entry_size;
240 struct brw_clip_prog_data {
241 GLuint curb_read_length; /* user planes? */
243 GLuint urb_read_length;
247 struct brw_gs_prog_data {
248 GLuint urb_read_length;
252 struct brw_vs_prog_data {
253 GLuint curb_read_length;
254 GLuint urb_read_length;
256 GLbitfield64 outputs_written;
257 GLuint nr_params; /**< number of float params/constants */
261 /* Used for calculating urb partitions:
263 GLuint urb_entry_size;
267 /* Size == 0 if output either not written, or always [0,0,0,1]
269 struct brw_vs_ouput_sizes {
270 GLubyte output_size[VERT_RESULT_MAX];
274 /** Number of texture sampler units */
275 #define BRW_MAX_TEX_UNIT 16
277 /** Max number of render targets in a shader */
278 #define BRW_MAX_DRAW_BUFFERS 8
281 * Size of our surface binding table for the WM.
282 * This contains pointers to the drawing surfaces and current texture
283 * objects and shader constant buffers (+2).
285 #define BRW_WM_MAX_SURF (BRW_MAX_DRAW_BUFFERS + BRW_MAX_TEX_UNIT + 1)
288 * Helpers to convert drawing buffers, textures and constant buffers
289 * to surface binding table indexes, for WM.
291 #define SURF_INDEX_DRAW(d) (d)
292 #define SURF_INDEX_FRAG_CONST_BUFFER (BRW_MAX_DRAW_BUFFERS)
293 #define SURF_INDEX_TEXTURE(t) (BRW_MAX_DRAW_BUFFERS + 1 + (t))
296 * Size of surface binding table for the VS.
297 * Only one constant buffer for now.
299 #define BRW_VS_MAX_SURF 1
302 * Only a VS constant buffer
304 #define SURF_INDEX_VERT_CONST_BUFFER 0
309 BRW_DEPTH_STENCIL_STATE,
310 BRW_COLOR_CALC_STATE,
318 BRW_SF_UNIT, /* scissor state on gen6 */
330 struct brw_cache_item {
332 * Effectively part of the key, cache_id identifies what kind of state
333 * buffer is involved, and also which brw->state.dirty.cache flag should
334 * be set when this cache item is chosen.
336 enum brw_cache_id cache_id;
337 /** 32-bit hash of the key data */
339 GLuint key_size; /* for variable-sized keys */
341 drm_intel_bo **reloc_bufs;
342 GLuint nr_reloc_bufs;
346 struct brw_cache_item *next;
352 struct brw_context *brw;
354 struct brw_cache_item **items;
355 GLuint size, n_items;
357 char *name[BRW_MAX_CACHE];
359 /* Record of the last BOs chosen for each cache_id. Used to set
360 * brw->state.dirty.cache when a new cache item is chosen.
362 drm_intel_bo *last_bo[BRW_MAX_CACHE];
366 /* Considered adding a member to this struct to document which flags
367 * an update might raise so that ordering of the state atoms can be
368 * checked or derived at runtime. Dropped the idea in favor of having
369 * a debug mode where the state is monitored for flags which are
370 * raised that have already been tested against.
372 struct brw_tracked_state {
373 struct brw_state_flags dirty;
374 void (*prepare)( struct brw_context *brw );
375 void (*emit)( struct brw_context *brw );
378 /* Flags for brw->state.cache.
380 #define CACHE_NEW_BLEND_STATE (1<<BRW_BLEND_STATE)
381 #define CACHE_NEW_DEPTH_STENCIL_STATE (1<<BRW_DEPTH_STENCIL_STATE)
382 #define CACHE_NEW_COLOR_CALC_STATE (1<<BRW_COLOR_CALC_STATE)
383 #define CACHE_NEW_CC_VP (1<<BRW_CC_VP)
384 #define CACHE_NEW_CC_UNIT (1<<BRW_CC_UNIT)
385 #define CACHE_NEW_WM_PROG (1<<BRW_WM_PROG)
386 #define CACHE_NEW_SAMPLER (1<<BRW_SAMPLER)
387 #define CACHE_NEW_WM_UNIT (1<<BRW_WM_UNIT)
388 #define CACHE_NEW_SF_PROG (1<<BRW_SF_PROG)
389 #define CACHE_NEW_SF_VP (1<<BRW_SF_VP)
390 #define CACHE_NEW_SF_UNIT (1<<BRW_SF_UNIT)
391 #define CACHE_NEW_VS_UNIT (1<<BRW_VS_UNIT)
392 #define CACHE_NEW_VS_PROG (1<<BRW_VS_PROG)
393 #define CACHE_NEW_GS_UNIT (1<<BRW_GS_UNIT)
394 #define CACHE_NEW_GS_PROG (1<<BRW_GS_PROG)
395 #define CACHE_NEW_CLIP_VP (1<<BRW_CLIP_VP)
396 #define CACHE_NEW_CLIP_UNIT (1<<BRW_CLIP_UNIT)
397 #define CACHE_NEW_CLIP_PROG (1<<BRW_CLIP_PROG)
399 struct brw_cached_batch_item {
400 struct header *header;
402 struct brw_cached_batch_item *next;
407 /* Protect against a future where VERT_ATTRIB_MAX > 32. Wouldn't life
408 * be easier if C allowed arrays of packed elements?
410 #define ATTRIB_BIT_DWORDS ((VERT_ATTRIB_MAX+31)/32)
412 struct brw_vertex_buffer {
413 /** Buffer object containing the uploaded vertex data */
416 /** Byte stride between elements in the uploaded array */
419 struct brw_vertex_element {
420 const struct gl_client_array *glarray;
424 /** The corresponding Mesa vertex attribute */
425 gl_vert_attrib attrib;
426 /** Size of a complete element */
428 /** Offset of the first element within the buffer object */
434 struct brw_vertex_info {
435 GLuint sizes[ATTRIB_BIT_DWORDS * 2]; /* sizes:2[VERT_ATTRIB_MAX] */
438 struct brw_query_object {
439 struct gl_query_object Base;
441 /** Last query BO associated with this query. */
443 /** First index in bo with query data for this object. */
445 /** Last index in bo with query data for this object. */
451 * brw_context is derived from intel_context.
455 struct intel_context intel; /**< base class, must be first field */
458 GLboolean emit_state_always;
459 GLboolean has_surface_tile_offset;
460 GLboolean has_compr4;
461 GLboolean has_negative_rhw_bug;
462 GLboolean has_aa_line_parameters;
466 struct brw_state_flags dirty;
469 * \name Cached region pointers
471 * When the draw buffer is updated, often the depth buffer is not
472 * changed. Caching the pointer to the buffer's region allows us to
473 * detect when the buffer has in fact changed, and allows us to avoid
474 * updating the buffer's GPU state when it has not.
476 * The original of each cached pointer is an instance of
477 * \c intel_renderbuffer.region.
479 * \see brw_set_draw_region()
484 /** \see struct brw_tracked_state brw_depthbuffer */
485 struct intel_region *depth_region;
490 * List of buffers accumulated in brw_validate_state to receive
491 * drm_intel_bo_check_aperture treatment before exec, so we can
492 * know if we should flush the batch and try again before
493 * emitting primitives.
495 * This can be a fixed number as we only have a limited number of
496 * objects referenced from the batchbuffer in a primitive emit,
497 * consisting of the vertex buffers, pipelined state pointers,
498 * the CURBE, the depth buffer, and a query BO.
500 drm_intel_bo *validated_bos[VERT_ATTRIB_MAX + BRW_WM_MAX_SURF + 16];
501 int validated_bo_count;
504 struct brw_cache cache;
505 struct brw_cached_batch_item *cached_batch_items;
508 struct brw_vertex_element inputs[VERT_ATTRIB_MAX];
509 struct brw_vertex_buffer buffers[VERT_ATTRIB_MAX];
514 } current_buffers[VERT_ATTRIB_MAX];
516 struct brw_vertex_element *enabled[VERT_ATTRIB_MAX];
518 GLuint nr_buffers, nr_current_buffers;
520 /* Summary of size and varying of active arrays, so we can check
521 * for changes to this state:
523 struct brw_vertex_info info;
524 unsigned int min_index, max_index;
526 /* Offset from start of vertex buffer so we can avoid redefining
527 * the same VB packed over and over again.
529 unsigned int start_vertex_bias;
534 * Index buffer for this draw_prims call.
536 * Updates are signaled by BRW_NEW_INDICES.
538 const struct _mesa_index_buffer *ib;
540 /* Updates are signaled by BRW_NEW_INDEX_BUFFER. */
544 /* Offset to index buffer index to use in CMD_3D_PRIM so that we can
545 * avoid re-uploading the IB packet over and over if we're actually
546 * referencing the same index buffer.
548 unsigned int start_vertex_offset;
551 /* Active vertex program:
553 const struct gl_vertex_program *vertex_program;
554 const struct gl_fragment_program *fragment_program;
556 /* hw-dependent 3DSTATE_VF_STATISTICS opcode */
557 uint32_t CMD_VF_STATISTICS;
558 /* hw-dependent 3DSTATE_PIPELINE_SELECT opcode */
559 uint32_t CMD_PIPELINE_SELECT;
563 /* BRW_NEW_URB_ALLOCATIONS:
566 GLuint vsize; /* vertex size plus header in urb registers */
567 GLuint csize; /* constant buffer size in urb registers */
568 GLuint sfsize; /* setup data size in urb registers */
570 GLboolean constrained;
572 GLuint max_vs_handles; /* Maximum number of VS handles */
573 GLuint max_gs_handles; /* Maximum number of GS handles */
575 GLuint nr_vs_entries;
576 GLuint nr_gs_entries;
577 GLuint nr_clip_entries;
578 GLuint nr_sf_entries;
579 GLuint nr_cs_entries;
582 * The length of each URB entry owned by the VS (or GS), as
583 * a number of 1024-bit (128-byte) rows. Should be >= 1.
593 GLuint size; /* Hardware URB size, in KB. */
597 /* BRW_NEW_CURBE_OFFSETS:
600 GLuint wm_start; /**< pos of first wm const in CURBE buffer */
601 GLuint wm_size; /**< number of float[4] consts, multiple of 16 */
608 drm_intel_bo *curbe_bo;
609 /** Offset within curbe_bo of space for current curbe entry */
611 /** Offset within curbe_bo of space for next curbe entry */
612 GLuint curbe_next_offset;
615 * Copy of the last set of CURBEs uploaded. Frequently we'll end up
616 * in brw_curbe.c with the same set of constant data to be uploaded,
617 * so we'd rather not upload new constants in that case (it can cause
618 * a pipeline bubble since only up to 4 can be pipelined at a time).
622 * Allocation for where to calculate the next set of CURBEs.
623 * It's a hot enough path that malloc/free of that data matters.
630 struct brw_vs_prog_data *prog_data;
631 int8_t *constant_map; /* variable array following prog_data */
633 drm_intel_bo *prog_bo;
634 drm_intel_bo *const_bo;
635 uint32_t state_offset;
637 /** Binding table of pointers to surf_bo entries */
638 uint32_t bind_bo_offset;
639 uint32_t surf_offset[BRW_VS_MAX_SURF];
642 uint32_t push_const_offset; /* Offset in the batchbuffer */
643 int push_const_size; /* in 256-bit register increments */
647 struct brw_gs_prog_data *prog_data;
649 GLboolean prog_active;
650 uint32_t state_offset;
651 drm_intel_bo *prog_bo;
655 struct brw_clip_prog_data *prog_data;
657 drm_intel_bo *prog_bo;
659 /* Offset in the batch to the CLIP state on pre-gen6. */
660 uint32_t state_offset;
662 /* As of gen6, this is the offset in the batch to the CLIP VP,
670 struct brw_sf_prog_data *prog_data;
672 drm_intel_bo *prog_bo;
673 uint32_t state_offset;
678 struct brw_wm_prog_data *prog_data;
679 struct brw_wm_compile *compile_data;
681 /** Input sizes, calculated from active vertex program.
682 * One bit per fragment program input attribute.
684 GLbitfield input_size_masks[4];
686 /** offsets in the batch to sampler default colors (texture border color)
688 uint32_t sdc_offset[BRW_MAX_TEX_UNIT];
694 drm_intel_bo *scratch_bo;
696 GLuint sampler_count;
697 uint32_t sampler_offset;
699 /** Binding table of pointers to surf_bo entries */
700 uint32_t bind_bo_offset;
701 uint32_t surf_offset[BRW_WM_MAX_SURF];
702 uint32_t state_offset; /* offset in batchbuffer to pre-gen6 WM state */
704 drm_intel_bo *prog_bo;
705 drm_intel_bo *const_bo; /* pull constant buffer. */
707 * This is offset in the batch to the push constants on gen6.
709 * Pre-gen6, push constants live in the CURBE.
711 uint32_t push_const_offset;
717 drm_intel_bo *prog_bo;
719 uint32_t state_offset;
720 uint32_t blend_state_offset;
721 uint32_t depth_stencil_state_offset;
726 struct brw_query_object *obj;
731 /* Used to give every program string a unique id
735 int num_prepare_atoms, num_emit_atoms;
736 struct brw_tracked_state prepare_atoms[64], emit_atoms[64];
740 #define BRW_PACKCOLOR8888(r,g,b,a) ((r<<24) | (g<<16) | (b<<8) | a)
742 struct brw_instruction_info {
748 extern const struct brw_instruction_info brw_opcodes[128];
750 /*======================================================================
753 void brwInitVtbl( struct brw_context *brw );
755 /*======================================================================
758 GLboolean brwCreateContext( int api,
759 const struct gl_config *mesaVis,
760 __DRIcontext *driContextPriv,
761 void *sharedContextPrivate);
763 /*======================================================================
766 void brw_init_queryobj_functions(struct dd_function_table *functions);
767 void brw_prepare_query_begin(struct brw_context *brw);
768 void brw_emit_query_begin(struct brw_context *brw);
769 void brw_emit_query_end(struct brw_context *brw);
771 /*======================================================================
774 void brw_debug_batch(struct intel_context *intel);
776 /*======================================================================
779 void brw_validate_textures( struct brw_context *brw );
782 /*======================================================================
785 void brwInitFragProgFuncs( struct dd_function_table *functions );
790 void brw_upload_urb_fence(struct brw_context *brw);
794 void brw_upload_cs_urb_state(struct brw_context *brw);
797 int brw_disasm (FILE *file, struct brw_instruction *inst, int gen);
799 /*======================================================================
800 * Inline conversion functions. These are better-typed than the
801 * macros used previously:
803 static INLINE struct brw_context *
804 brw_context( struct gl_context *ctx )
806 return (struct brw_context *)ctx;
809 static INLINE struct brw_vertex_program *
810 brw_vertex_program(struct gl_vertex_program *p)
812 return (struct brw_vertex_program *) p;
815 static INLINE const struct brw_vertex_program *
816 brw_vertex_program_const(const struct gl_vertex_program *p)
818 return (const struct brw_vertex_program *) p;
821 static INLINE struct brw_fragment_program *
822 brw_fragment_program(struct gl_fragment_program *p)
824 return (struct brw_fragment_program *) p;
827 static INLINE const struct brw_fragment_program *
828 brw_fragment_program_const(const struct gl_fragment_program *p)
830 return (const struct brw_fragment_program *) p;
834 float convert_param(enum param_conversion conversion, float param)
842 switch (conversion) {
843 case PARAM_NO_CONVERT:
845 case PARAM_CONVERT_F2I:
848 case PARAM_CONVERT_F2U:
851 case PARAM_CONVERT_F2B:
862 GLboolean brw_do_cubemap_normalize(struct exec_list *instructions);