st/glsl_to_tgsi: make use of driver_cache_blob with the disk cache
[mesa.git] / src / mesa / state_tracker / st_program.h
1 /**************************************************************************
2 *
3 * Copyright 2003 VMware, Inc.
4 * All Rights Reserved.
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * 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, sub license, 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 portions
16 * of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
21 * IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS BE LIABLE FOR
22 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
23 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
24 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
25 *
26 **************************************************************************/
27
28 /*
29 * Authors:
30 * Keith Whitwell <keithw@vmware.com>
31 */
32
33
34 #ifndef ST_PROGRAM_H
35 #define ST_PROGRAM_H
36
37 #include "main/mtypes.h"
38 #include "main/atifragshader.h"
39 #include "program/program.h"
40 #include "pipe/p_state.h"
41 #include "tgsi/tgsi_from_mesa.h"
42 #include "st_context.h"
43 #include "st_texture.h"
44 #include "st_glsl_to_tgsi.h"
45
46 #ifdef __cplusplus
47 extern "C" {
48 #endif
49
50 #define ST_DOUBLE_ATTRIB_PLACEHOLDER 0xff
51
52 struct st_external_sampler_key
53 {
54 GLuint lower_nv12; /**< bitmask of 2 plane YUV samplers */
55 GLuint lower_iyuv; /**< bitmask of 3 plane YUV samplers */
56 };
57
58 static inline struct st_external_sampler_key
59 st_get_external_sampler_key(struct st_context *st, struct gl_program *prog)
60 {
61 unsigned mask = prog->ExternalSamplersUsed;
62 struct st_external_sampler_key key;
63
64 memset(&key, 0, sizeof(key));
65
66 while (unlikely(mask)) {
67 unsigned unit = u_bit_scan(&mask);
68 struct st_texture_object *stObj =
69 st_get_texture_object(st->ctx, prog, unit);
70
71 switch (st_get_view_format(stObj)) {
72 case PIPE_FORMAT_NV12:
73 key.lower_nv12 |= (1 << unit);
74 break;
75 case PIPE_FORMAT_IYUV:
76 key.lower_iyuv |= (1 << unit);
77 break;
78 default:
79 break;
80 }
81 }
82
83 return key;
84 }
85
86 /** Fragment program variant key */
87 struct st_fp_variant_key
88 {
89 struct st_context *st; /**< variants are per-context */
90
91 /** for glBitmap */
92 GLuint bitmap:1; /**< glBitmap variant? */
93
94 /** for glDrawPixels */
95 GLuint drawpixels:1; /**< glDrawPixels variant */
96 GLuint scaleAndBias:1; /**< glDrawPixels w/ scale and/or bias? */
97 GLuint pixelMaps:1; /**< glDrawPixels w/ pixel lookup map? */
98
99 /** for ARB_color_buffer_float */
100 GLuint clamp_color:1;
101
102 /** for ARB_sample_shading */
103 GLuint persample_shading:1;
104
105 /** needed for ATI_fragment_shader */
106 GLuint fog:2;
107
108 /** needed for ATI_fragment_shader */
109 char texture_targets[MAX_NUM_FRAGMENT_REGISTERS_ATI];
110
111 struct st_external_sampler_key external;
112 };
113
114
115 /**
116 * Variant of a fragment program.
117 */
118 struct st_fp_variant
119 {
120 /** Parameters which generated this version of fragment program */
121 struct st_fp_variant_key key;
122
123 /** Driver's compiled shader */
124 void *driver_shader;
125
126 /** For glBitmap variants */
127 uint bitmap_sampler;
128
129 /** For glDrawPixels variants */
130 unsigned drawpix_sampler;
131 unsigned pixelmap_sampler;
132
133 /** next in linked list */
134 struct st_fp_variant *next;
135 };
136
137
138 /**
139 * Derived from Mesa gl_program:
140 */
141 struct st_fragment_program
142 {
143 struct gl_program Base;
144 struct pipe_shader_state tgsi;
145 struct glsl_to_tgsi_visitor* glsl_to_tgsi;
146 struct ati_fragment_shader *ati_fs;
147 uint64_t affected_states; /**< ST_NEW_* flags to mark dirty when binding */
148
149 /* used when bypassing glsl_to_tgsi: */
150 struct gl_shader_program *shader_program;
151
152 struct st_fp_variant *variants;
153 };
154
155
156
157 /** Vertex program variant key */
158 struct st_vp_variant_key
159 {
160 struct st_context *st; /**< variants are per-context */
161 boolean passthrough_edgeflags;
162
163 /** for ARB_color_buffer_float */
164 boolean clamp_color;
165 };
166
167
168 /**
169 * This represents a vertex program, especially translated to match
170 * the inputs of a particular fragment shader.
171 */
172 struct st_vp_variant
173 {
174 /* Parameters which generated this translated version of a vertex
175 * shader:
176 */
177 struct st_vp_variant_key key;
178
179 /**
180 * TGSI tokens (to later generate a 'draw' module shader for
181 * selection/feedback/rasterpos)
182 */
183 struct pipe_shader_state tgsi;
184
185 /** Driver's compiled shader */
186 void *driver_shader;
187
188 /** For using our private draw module (glRasterPos) */
189 struct draw_vertex_shader *draw_shader;
190
191 /** Next in linked list */
192 struct st_vp_variant *next;
193
194 /** similar to that in st_vertex_program, but with edgeflags info too */
195 GLuint num_inputs;
196 };
197
198
199 /**
200 * Derived from Mesa gl_program:
201 */
202 struct st_vertex_program
203 {
204 struct gl_program Base; /**< The Mesa vertex program */
205 struct pipe_shader_state tgsi;
206 struct glsl_to_tgsi_visitor* glsl_to_tgsi;
207 uint64_t affected_states; /**< ST_NEW_* flags to mark dirty when binding */
208
209 /* used when bypassing glsl_to_tgsi: */
210 struct gl_shader_program *shader_program;
211
212 /** maps a TGSI input index back to a Mesa VERT_ATTRIB_x */
213 ubyte index_to_input[PIPE_MAX_ATTRIBS];
214 ubyte num_inputs;
215
216 /** Maps VARYING_SLOT_x to slot */
217 ubyte result_to_output[VARYING_SLOT_MAX];
218
219 /** List of translated variants of this vertex program.
220 */
221 struct st_vp_variant *variants;
222
223 /** SHA1 hash of linked tgsi shader program, used for on-disk cache */
224 unsigned char sha1[20];
225 };
226
227
228
229 /** Key shared by all shaders except VP, FP */
230 struct st_basic_variant_key
231 {
232 struct st_context *st; /**< variants are per-context */
233 };
234
235
236 /**
237 * Geometry program variant.
238 */
239 struct st_basic_variant
240 {
241 /* Parameters which generated this variant. */
242 struct st_basic_variant_key key;
243
244 void *driver_shader;
245
246 struct st_basic_variant *next;
247 };
248
249
250 /**
251 * Derived from Mesa gl_program:
252 */
253 struct st_common_program
254 {
255 struct gl_program Base;
256 struct pipe_shader_state tgsi;
257 struct glsl_to_tgsi_visitor* glsl_to_tgsi;
258 uint64_t affected_states; /**< ST_NEW_* flags to mark dirty when binding */
259
260 /* used when bypassing glsl_to_tgsi: */
261 struct gl_shader_program *shader_program;
262
263 struct st_basic_variant *variants;
264
265 /** SHA1 hash of linked tgsi shader program, used for on-disk cache */
266 unsigned char sha1[20];
267 };
268
269
270 /**
271 * Derived from Mesa gl_program:
272 */
273 struct st_compute_program
274 {
275 struct gl_program Base; /**< The Mesa compute program */
276 struct pipe_compute_state tgsi;
277 struct glsl_to_tgsi_visitor* glsl_to_tgsi;
278 uint64_t affected_states; /**< ST_NEW_* flags to mark dirty when binding */
279
280 /* used when bypassing glsl_to_tgsi: */
281 struct gl_shader_program *shader_program;
282
283 struct st_basic_variant *variants;
284
285 /** SHA1 hash of linked tgsi shader program, used for on-disk cache */
286 unsigned char sha1[20];
287 };
288
289
290 static inline struct st_fragment_program *
291 st_fragment_program( struct gl_program *fp )
292 {
293 return (struct st_fragment_program *)fp;
294 }
295
296
297 static inline struct st_vertex_program *
298 st_vertex_program( struct gl_program *vp )
299 {
300 return (struct st_vertex_program *)vp;
301 }
302
303 static inline struct st_common_program *
304 st_common_program( struct gl_program *gp )
305 {
306 return (struct st_common_program *)gp;
307 }
308
309 static inline struct st_compute_program *
310 st_compute_program( struct gl_program *cp )
311 {
312 return (struct st_compute_program *)cp;
313 }
314
315 static inline void
316 st_reference_vertprog(struct st_context *st,
317 struct st_vertex_program **ptr,
318 struct st_vertex_program *prog)
319 {
320 _mesa_reference_program(st->ctx,
321 (struct gl_program **) ptr,
322 (struct gl_program *) prog);
323 }
324
325 static inline void
326 st_reference_fragprog(struct st_context *st,
327 struct st_fragment_program **ptr,
328 struct st_fragment_program *prog)
329 {
330 _mesa_reference_program(st->ctx,
331 (struct gl_program **) ptr,
332 (struct gl_program *) prog);
333 }
334
335 static inline void
336 st_reference_prog(struct st_context *st,
337 struct st_common_program **ptr,
338 struct st_common_program *prog)
339 {
340 _mesa_reference_program(st->ctx,
341 (struct gl_program **) ptr,
342 (struct gl_program *) prog);
343 }
344
345 static inline void
346 st_reference_compprog(struct st_context *st,
347 struct st_compute_program **ptr,
348 struct st_compute_program *prog)
349 {
350 _mesa_reference_program(st->ctx,
351 (struct gl_program **) ptr,
352 (struct gl_program *) prog);
353 }
354
355 /**
356 * This defines mapping from Mesa VARYING_SLOTs to TGSI GENERIC slots.
357 */
358 static inline unsigned
359 st_get_generic_varying_index(struct st_context *st, GLuint attr)
360 {
361 return tgsi_get_generic_gl_varying_index((gl_varying_slot)attr,
362 st->needs_texcoord_semantic);
363 }
364
365 extern void
366 st_set_prog_affected_state_flags(struct gl_program *prog);
367
368 extern struct st_vp_variant *
369 st_get_vp_variant(struct st_context *st,
370 struct st_vertex_program *stvp,
371 const struct st_vp_variant_key *key);
372
373
374 extern struct st_fp_variant *
375 st_get_fp_variant(struct st_context *st,
376 struct st_fragment_program *stfp,
377 const struct st_fp_variant_key *key);
378
379 extern struct st_basic_variant *
380 st_get_cp_variant(struct st_context *st,
381 struct pipe_compute_state *tgsi,
382 struct st_basic_variant **variants);
383
384 extern struct st_basic_variant *
385 st_get_basic_variant(struct st_context *st,
386 unsigned pipe_shader,
387 struct st_common_program *p);
388
389 extern void
390 st_release_vp_variants( struct st_context *st,
391 struct st_vertex_program *stvp );
392
393 extern void
394 st_release_fp_variants( struct st_context *st,
395 struct st_fragment_program *stfp );
396
397 extern void
398 st_release_cp_variants(struct st_context *st,
399 struct st_compute_program *stcp);
400
401 extern void
402 st_release_basic_variants(struct st_context *st, GLenum target,
403 struct st_basic_variant **variants,
404 struct pipe_shader_state *tgsi);
405
406 extern void
407 st_destroy_program_variants(struct st_context *st);
408
409 extern bool
410 st_translate_vertex_program(struct st_context *st,
411 struct st_vertex_program *stvp);
412
413 extern bool
414 st_translate_fragment_program(struct st_context *st,
415 struct st_fragment_program *stfp);
416
417 extern bool
418 st_translate_geometry_program(struct st_context *st,
419 struct st_common_program *stgp);
420
421 extern bool
422 st_translate_tessctrl_program(struct st_context *st,
423 struct st_common_program *sttcp);
424
425 extern bool
426 st_translate_tesseval_program(struct st_context *st,
427 struct st_common_program *sttep);
428
429 extern bool
430 st_translate_compute_program(struct st_context *st,
431 struct st_compute_program *stcp);
432
433 extern void
434 st_print_current_vertex_program(void);
435
436 extern void
437 st_precompile_shader_variant(struct st_context *st,
438 struct gl_program *prog);
439
440 #ifdef __cplusplus
441 }
442 #endif
443
444 #endif