Revert "Revert "Merge branch 'drm-gem'""
[mesa.git] / src / mesa / drivers / dri / i965 / brw_context.h
1 /*
2 Copyright (C) Intel Corp. 2006. All Rights Reserved.
3 Intel funded Tungsten Graphics (http://www.tungstengraphics.com) to
4 develop this 3D driver.
5
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:
13
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.
17
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.
25
26 **********************************************************************/
27 /*
28 * Authors:
29 * Keith Whitwell <keith@tungstengraphics.com>
30 */
31
32
33 #ifndef BRWCONTEXT_INC
34 #define BRWCONTEXT_INC
35
36 #include "intel_context.h"
37 #include "brw_structs.h"
38 #include "imports.h"
39
40
41 /* Glossary:
42 *
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.
46 *
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.
50 *
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.
54 *
55 * PUE - primitive URB entry. An urb entry produced by the setup (SF)
56 * unit holding rasterization and interpolation parameters.
57 *
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.
64 *
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.
71 *
72 * R0 - GRF register 0. Typically holds control information used when
73 * sending messages to other threads.
74 *
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.
78 *
79 * Fixed function units:
80 *
81 * CS - Command streamer. Notional first unit, little software
82 * interaction. Holds the URB entries used for constant data, ie the
83 * CURBEs.
84 *
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.
90 *
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.
99 *
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.
105 *
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.
109 *
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.
113 *
114 * CC - Color Calculator. No EU threads associated with this unit.
115 * Handles blending and (presumably) depth and stencil testing.
116 */
117
118 #define BRW_FALLBACK_TEXTURE 0x1
119 #define BRW_MAX_CURBE (32*16)
120
121 struct brw_context;
122
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_TNL_PROGRAM 0x400
134 #define BRW_NEW_PSP 0x800
135 #define BRW_NEW_METAOPS 0x1000
136 #define BRW_NEW_FENCE 0x2000
137 #define BRW_NEW_LOCK 0x4000
138 #define BRW_NEW_INDICES 0x8000
139 #define BRW_NEW_VERTICES 0x10000
140 /**
141 * Used for any batch entry with a relocated pointer that will be used
142 * by any 3D rendering.
143 */
144 #define BRW_NEW_BATCH 0x8000
145 /** brw->depth_region updated */
146 #define BRW_NEW_DEPTH_BUFFER 0x10000
147
148 struct brw_state_flags {
149 /** State update flags signalled by mesa internals */
150 GLuint mesa;
151 /**
152 * State update flags signalled as the result of brw_tracked_state updates
153 */
154 GLuint brw;
155 /** State update flags signalled by brw_state_cache.c searches */
156 GLuint cache;
157 };
158
159 struct brw_vertex_program {
160 struct gl_vertex_program program;
161 GLuint id;
162 GLuint param_state; /* flags indicating state tracked by params */
163 };
164
165
166
167 struct brw_fragment_program {
168 struct gl_fragment_program program;
169 GLuint id;
170 GLuint param_state; /* flags indicating state tracked by params */
171 };
172
173
174
175
176 /* Data about a particular attempt to compile a program. Note that
177 * there can be many of these, each in a different GL state
178 * corresponding to a different brw_wm_prog_key struct, with different
179 * compiled programs:
180 */
181 struct brw_wm_prog_data {
182 GLuint curb_read_length;
183 GLuint urb_read_length;
184
185 GLuint first_curbe_grf;
186 GLuint total_grf;
187 GLuint total_scratch;
188
189 GLuint nr_params;
190 GLboolean error;
191
192 /* Pointer to tracked values (only valid once
193 * _mesa_load_state_parameters has been called at runtime).
194 */
195 const GLfloat *param[BRW_MAX_CURBE];
196 };
197
198 struct brw_sf_prog_data {
199 GLuint urb_read_length;
200 GLuint total_grf;
201
202 /* Each vertex may have upto 12 attributes, 4 components each,
203 * except WPOS which requires only 2. (11*4 + 2) == 44 ==> 11
204 * rows.
205 *
206 * Actually we use 4 for each, so call it 12 rows.
207 */
208 GLuint urb_entry_size;
209 };
210
211 struct brw_clip_prog_data {
212 GLuint curb_read_length; /* user planes? */
213 GLuint clip_mode;
214 GLuint urb_read_length;
215 GLuint total_grf;
216 };
217
218 struct brw_gs_prog_data {
219 GLuint urb_read_length;
220 GLuint total_grf;
221 };
222
223 struct brw_vs_prog_data {
224 GLuint curb_read_length;
225 GLuint urb_read_length;
226 GLuint total_grf;
227 GLuint outputs_written;
228
229 GLuint inputs_read;
230
231 /* Used for calculating urb partitions:
232 */
233 GLuint urb_entry_size;
234 };
235
236
237 /* Size == 0 if output either not written, or always [0,0,0,1]
238 */
239 struct brw_vs_ouput_sizes {
240 GLubyte output_size[VERT_RESULT_MAX];
241 };
242
243
244 #define BRW_MAX_TEX_UNIT 8
245 #define BRW_WM_MAX_SURF BRW_MAX_TEX_UNIT + MAX_DRAW_BUFFERS
246
247 enum brw_cache_id {
248 BRW_CC_VP,
249 BRW_CC_UNIT,
250 BRW_WM_PROG,
251 BRW_SAMPLER_DEFAULT_COLOR,
252 BRW_SAMPLER,
253 BRW_WM_UNIT,
254 BRW_SF_PROG,
255 BRW_SF_VP,
256 BRW_SF_UNIT,
257 BRW_VS_UNIT,
258 BRW_VS_PROG,
259 BRW_GS_UNIT,
260 BRW_GS_PROG,
261 BRW_CLIP_VP,
262 BRW_CLIP_UNIT,
263 BRW_CLIP_PROG,
264 BRW_SS_SURFACE,
265 BRW_SS_SURF_BIND,
266
267 BRW_MAX_CACHE
268 };
269
270 struct brw_cache_item {
271 /**
272 * Effectively part of the key, cache_id identifies what kind of state
273 * buffer is involved, and also which brw->state.dirty.cache flag should
274 * be set when this cache item is chosen.
275 */
276 enum brw_cache_id cache_id;
277 /** 32-bit hash of the key data */
278 GLuint hash;
279 GLuint key_size; /* for variable-sized keys */
280 const void *key;
281 dri_bo **reloc_bufs;
282 GLuint nr_reloc_bufs;
283
284 dri_bo *bo;
285 GLuint data_size;
286
287 struct brw_cache_item *next;
288 };
289
290
291
292 struct brw_cache {
293 struct brw_context *brw;
294
295 struct brw_cache_item **items;
296 GLuint size, n_items;
297
298 GLuint key_size[BRW_MAX_CACHE]; /* for fixed-size keys */
299 GLuint aux_size[BRW_MAX_CACHE];
300 char *name[BRW_MAX_CACHE];
301
302 /* Record of the last BOs chosen for each cache_id. Used to set
303 * brw->state.dirty.cache when a new cache item is chosen.
304 */
305 dri_bo *last_bo[BRW_MAX_CACHE];
306 };
307
308
309
310 struct brw_state_pointers {
311 struct gl_colorbuffer_attrib *Color;
312 struct gl_depthbuffer_attrib *Depth;
313 struct gl_fog_attrib *Fog;
314 struct gl_hint_attrib *Hint;
315 struct gl_light_attrib *Light;
316 struct gl_line_attrib *Line;
317 struct gl_point_attrib *Point;
318 struct gl_polygon_attrib *Polygon;
319 GLuint *PolygonStipple;
320 struct gl_scissor_attrib *Scissor;
321 struct gl_stencil_attrib *Stencil;
322 struct gl_texture_attrib *Texture;
323 struct gl_transform_attrib *Transform;
324 struct gl_viewport_attrib *Viewport;
325 struct gl_vertex_program_state *VertexProgram;
326 struct gl_fragment_program_state *FragmentProgram;
327 };
328
329 /* Considered adding a member to this struct to document which flags
330 * an update might raise so that ordering of the state atoms can be
331 * checked or derived at runtime. Dropped the idea in favor of having
332 * a debug mode where the state is monitored for flags which are
333 * raised that have already been tested against.
334 */
335 struct brw_tracked_state {
336 struct brw_state_flags dirty;
337 void (*prepare)( struct brw_context *brw );
338 void (*emit)( struct brw_context *brw );
339 };
340
341 /* Flags for brw->state.cache.
342 */
343 #define CACHE_NEW_CC_VP (1<<BRW_CC_VP)
344 #define CACHE_NEW_CC_UNIT (1<<BRW_CC_UNIT)
345 #define CACHE_NEW_WM_PROG (1<<BRW_WM_PROG)
346 #define CACHE_NEW_SAMPLER_DEFAULT_COLOR (1<<BRW_SAMPLER_DEFAULT_COLOR)
347 #define CACHE_NEW_SAMPLER (1<<BRW_SAMPLER)
348 #define CACHE_NEW_WM_UNIT (1<<BRW_WM_UNIT)
349 #define CACHE_NEW_SF_PROG (1<<BRW_SF_PROG)
350 #define CACHE_NEW_SF_VP (1<<BRW_SF_VP)
351 #define CACHE_NEW_SF_UNIT (1<<BRW_SF_UNIT)
352 #define CACHE_NEW_VS_UNIT (1<<BRW_VS_UNIT)
353 #define CACHE_NEW_VS_PROG (1<<BRW_VS_PROG)
354 #define CACHE_NEW_GS_UNIT (1<<BRW_GS_UNIT)
355 #define CACHE_NEW_GS_PROG (1<<BRW_GS_PROG)
356 #define CACHE_NEW_CLIP_VP (1<<BRW_CLIP_VP)
357 #define CACHE_NEW_CLIP_UNIT (1<<BRW_CLIP_UNIT)
358 #define CACHE_NEW_CLIP_PROG (1<<BRW_CLIP_PROG)
359 #define CACHE_NEW_SURFACE (1<<BRW_SS_SURFACE)
360 #define CACHE_NEW_SURF_BIND (1<<BRW_SS_SURF_BIND)
361
362 struct brw_cached_batch_item {
363 struct header *header;
364 GLuint sz;
365 struct brw_cached_batch_item *next;
366 };
367
368
369
370 /* Protect against a future where VERT_ATTRIB_MAX > 32. Wouldn't life
371 * be easier if C allowed arrays of packed elements?
372 */
373 #define ATTRIB_BIT_DWORDS ((VERT_ATTRIB_MAX+31)/32)
374
375 struct brw_vertex_element {
376 const struct gl_client_array *glarray;
377
378 /** Size of a complete element */
379 GLuint element_size;
380 /** Number of uploaded elements for this input. */
381 GLuint count;
382 /** Byte stride between elements in the uploaded array */
383 GLuint stride;
384 /** Offset of the first element within the buffer object */
385 unsigned int offset;
386 /** Buffer object containing the uploaded vertex data */
387 dri_bo *bo;
388 };
389
390
391
392 struct brw_vertex_info {
393 GLuint varying; /* varying:1[VERT_ATTRIB_MAX] */
394 GLuint sizes[ATTRIB_BIT_DWORDS * 2]; /* sizes:2[VERT_ATTRIB_MAX] */
395 };
396
397
398
399
400 /* Cache for TNL programs.
401 */
402 struct brw_tnl_cache_item {
403 GLuint hash;
404 void *key;
405 void *data;
406 struct brw_tnl_cache_item *next;
407 };
408
409 struct brw_tnl_cache {
410 struct brw_tnl_cache_item **items;
411 GLuint size, n_items;
412 };
413
414
415
416 struct brw_context
417 {
418 struct intel_context intel;
419 GLuint primitive;
420
421 GLboolean emit_state_always;
422 GLboolean wrap;
423 GLboolean tmp_fallback;
424 GLboolean no_batch_wrap;
425
426 struct {
427 struct brw_state_flags dirty;
428 struct brw_tracked_state **atoms;
429 GLuint nr_atoms;
430
431 GLuint nr_draw_regions;
432 struct intel_region *draw_regions[MAX_DRAW_BUFFERS];
433 struct intel_region *depth_region;
434 } state;
435
436 struct brw_state_pointers attribs;
437 struct brw_cache cache;
438 struct brw_cached_batch_item *cached_batch_items;
439
440 struct {
441 struct brw_vertex_element inputs[VERT_ATTRIB_MAX];
442
443 #define BRW_NR_UPLOAD_BUFS 17
444 #define BRW_UPLOAD_INIT_SIZE (128*1024)
445
446 struct {
447 dri_bo *bo;
448 GLuint offset;
449 } upload;
450
451 /* Summary of size and varying of active arrays, so we can check
452 * for changes to this state:
453 */
454 struct brw_vertex_info info;
455 unsigned int min_index, max_index;
456 } vb;
457
458 struct {
459 /**
460 * Index buffer for this draw_prims call.
461 *
462 * Updates are signaled by BRW_NEW_INDICES.
463 */
464 const struct _mesa_index_buffer *ib;
465
466 dri_bo *bo;
467 unsigned int offset;
468 } ib;
469
470 struct {
471 /* Will be allocated on demand if needed.
472 */
473 struct brw_state_pointers attribs;
474 struct gl_vertex_program *vp;
475 struct gl_fragment_program *fp, *fp_tex;
476
477 struct gl_buffer_object *vbo;
478
479 struct intel_region *saved_draw_region;
480 GLuint saved_nr_draw_regions;
481 struct intel_region *saved_depth_region;
482
483 GLuint restore_draw_buffers[MAX_DRAW_BUFFERS];
484 GLuint restore_num_draw_buffers;
485
486 struct gl_fragment_program *restore_fp;
487
488 GLboolean active;
489 } metaops;
490
491 /* Track fixed function t&l in a vertex program:
492 */
493 struct gl_vertex_program *tnl_program;
494 struct brw_tnl_cache tnl_program_cache;
495
496 /* Active vertex program:
497 */
498 const struct gl_vertex_program *vertex_program;
499 const struct gl_fragment_program *fragment_program;
500
501
502 /* For populating the gtt:
503 */
504 GLuint next_free_page;
505
506
507 /* BRW_NEW_URB_ALLOCATIONS:
508 */
509 struct {
510 GLuint vsize; /* vertex size plus header in urb registers */
511 GLuint csize; /* constant buffer size in urb registers */
512 GLuint sfsize; /* setup data size in urb registers */
513
514 GLboolean constrained;
515
516 GLuint nr_vs_entries;
517 GLuint nr_gs_entries;
518 GLuint nr_clip_entries;
519 GLuint nr_sf_entries;
520 GLuint nr_cs_entries;
521
522 /* GLuint vs_size; */
523 /* GLuint gs_size; */
524 /* GLuint clip_size; */
525 /* GLuint sf_size; */
526 /* GLuint cs_size; */
527
528 GLuint vs_start;
529 GLuint gs_start;
530 GLuint clip_start;
531 GLuint sf_start;
532 GLuint cs_start;
533 } urb;
534
535
536 /* BRW_NEW_CURBE_OFFSETS:
537 */
538 struct {
539 GLuint wm_start;
540 GLuint wm_size;
541 GLuint clip_start;
542 GLuint clip_size;
543 GLuint vs_start;
544 GLuint vs_size;
545 GLuint total_size;
546
547 /* Dynamic tracker which changes to reflect the state referenced
548 * by active fp and vp program parameters:
549 */
550 struct brw_tracked_state tracked_state;
551
552 dri_bo *curbe_bo;
553 /** Offset within curbe_bo of space for current curbe entry */
554 GLuint curbe_offset;
555 /** Offset within curbe_bo of space for next curbe entry */
556 GLuint curbe_next_offset;
557
558 GLfloat *last_buf;
559 GLuint last_bufsz;
560 } curbe;
561
562 struct {
563 struct brw_vs_prog_data *prog_data;
564
565 dri_bo *prog_bo;
566 dri_bo *state_bo;
567 } vs;
568
569 struct {
570 struct brw_gs_prog_data *prog_data;
571
572 GLboolean prog_active;
573 dri_bo *prog_bo;
574 dri_bo *state_bo;
575 } gs;
576
577 struct {
578 struct brw_clip_prog_data *prog_data;
579
580 dri_bo *prog_bo;
581 dri_bo *state_bo;
582 dri_bo *vp_bo;
583 } clip;
584
585
586 struct {
587 struct brw_sf_prog_data *prog_data;
588
589 dri_bo *prog_bo;
590 dri_bo *state_bo;
591 dri_bo *vp_bo;
592 } sf;
593
594 struct {
595 struct brw_wm_prog_data *prog_data;
596 struct brw_wm_compile *compile_data;
597
598 /* Input sizes, calculated from active vertex program:
599 */
600 GLuint input_size_masks[4];
601
602 /** Array of surface default colors (texture border color) */
603 dri_bo *sdc_bo[BRW_MAX_TEX_UNIT];
604
605 GLuint render_surf;
606 GLuint nr_surfaces;
607
608 GLuint max_threads;
609 dri_bo *scratch_buffer;
610
611 GLuint sampler_count;
612 dri_bo *sampler_bo;
613
614 /** Binding table of pointers to surf_bo entries */
615 dri_bo *bind_bo;
616 dri_bo *surf_bo[BRW_WM_MAX_SURF];
617
618 dri_bo *prog_bo;
619 dri_bo *state_bo;
620 } wm;
621
622
623 struct {
624 dri_bo *prog_bo;
625 dri_bo *state_bo;
626 dri_bo *vp_bo;
627 } cc;
628
629
630 /* Used to give every program string a unique id
631 */
632 GLuint program_id;
633 };
634
635
636 #define BRW_PACKCOLOR8888(r,g,b,a) ((r<<24) | (g<<16) | (b<<8) | a)
637
638
639
640 /*======================================================================
641 * brw_vtbl.c
642 */
643 void brwInitVtbl( struct brw_context *brw );
644 void brw_do_flush( struct brw_context *brw,
645 GLuint flags );
646
647 /*======================================================================
648 * brw_context.c
649 */
650 GLboolean brwCreateContext( const __GLcontextModes *mesaVis,
651 __DRIcontextPrivate *driContextPriv,
652 void *sharedContextPrivate);
653
654
655
656 /*======================================================================
657 * brw_state.c
658 */
659 void brw_validate_state( struct brw_context *brw );
660 void brw_init_state( struct brw_context *brw );
661 void brw_destroy_state( struct brw_context *brw );
662
663
664 /*======================================================================
665 * brw_state_dump.c
666 */
667 void brw_debug_batch(struct intel_context *intel);
668
669 /*======================================================================
670 * brw_tex.c
671 */
672 void brwUpdateTextureState( struct intel_context *intel );
673 void brw_FrameBufferTexInit( struct brw_context *brw,
674 struct intel_region *region );
675 void brw_FrameBufferTexDestroy( struct brw_context *brw );
676 void brw_validate_textures( struct brw_context *brw );
677
678 /*======================================================================
679 * brw_metaops.c
680 */
681
682 void brw_init_metaops( struct brw_context *brw );
683 void brw_destroy_metaops( struct brw_context *brw );
684
685
686 /*======================================================================
687 * brw_program.c
688 */
689 void brwInitFragProgFuncs( struct dd_function_table *functions );
690
691
692 /* brw_urb.c
693 */
694 void brw_upload_urb_fence(struct brw_context *brw);
695
696 void brw_upload_constant_buffer_state(struct brw_context *brw);
697
698
699 /*======================================================================
700 * Inline conversion functions. These are better-typed than the
701 * macros used previously:
702 */
703 static INLINE struct brw_context *
704 brw_context( GLcontext *ctx )
705 {
706 return (struct brw_context *)ctx;
707 }
708
709 #define DO_SETUP_BITS ((1<<(FRAG_ATTRIB_MAX)) - 1)
710
711 #endif
712