2 * Copyright 2008 Stefan Dösinger
3 * Copyright 2009 Matteo Bruni
4 * Copyright 2010 Rico Schüller
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
21 #ifndef __WINE_D3DCOMPILER_PRIVATE_H
22 #define __WINE_D3DCOMPILER_PRIVATE_H
24 #include "wine/debug.h"
25 #include "wine/list.h"
26 #include "wine/rbtree.h"
33 #include "d3dcompiler.h"
36 * This doesn't belong here, but for some functions it is possible to return that value,
37 * see http://msdn.microsoft.com/en-us/library/bb205278%28v=VS.85%29.aspx
38 * The original definition is in D3DX10core.h.
40 #define D3DERR_INVALIDCALL 0x8876086c
42 /* TRACE helper functions */
43 const char *debug_d3dcompiler_d3d_blob_part(D3D_BLOB_PART part
) DECLSPEC_HIDDEN
;
44 const char *debug_d3dcompiler_shader_variable_class(D3D_SHADER_VARIABLE_CLASS c
) DECLSPEC_HIDDEN
;
45 const char *debug_d3dcompiler_shader_variable_type(D3D_SHADER_VARIABLE_TYPE t
) DECLSPEC_HIDDEN
;
53 typedef enum BWRITER_COMPARISON_TYPE
{
54 BWRITER_COMPARISON_NONE
,
55 BWRITER_COMPARISON_GT
,
56 BWRITER_COMPARISON_EQ
,
57 BWRITER_COMPARISON_GE
,
58 BWRITER_COMPARISON_LT
,
59 BWRITER_COMPARISON_NE
,
61 } BWRITER_COMPARISON_TYPE
;
76 struct shader_reg
*rel_reg
;
88 BWRITER_COMPARISON_TYPE comptype
;
90 struct shader_reg dst
;
91 struct shader_reg
*src
;
92 unsigned int num_srcs
; /* For freeing the rel_regs */
94 struct shader_reg predicate
;
99 DWORD usage
, usage_idx
;
112 #define INSTRARRAY_INITIAL_SIZE 8
113 struct bwriter_shader
{
114 enum shader_type type
;
116 /* Shader version selected */
119 /* Local constants. Every constant that is not defined below is loaded from
120 * the global constant set at shader runtime
122 struct constant
**constF
;
123 struct constant
**constI
;
124 struct constant
**constB
;
125 unsigned int num_cf
, num_ci
, num_cb
;
127 /* Declared input and output varyings */
128 struct declaration
*inputs
, *outputs
;
129 unsigned int num_inputs
, num_outputs
;
130 struct samplerdecl
*samplers
;
131 unsigned int num_samplers
;
133 /* Are special pixel shader 3.0 registers declared? */
136 /* Array of shader instructions - The shader code itself */
137 struct instruction
**instr
;
138 unsigned int num_instrs
, instr_alloc_size
;
141 static inline LPVOID
asm_alloc(SIZE_T size
) {
142 return HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY
, size
);
145 static inline LPVOID
asm_realloc(LPVOID ptr
, SIZE_T size
) {
146 return HeapReAlloc(GetProcessHeap(), 0, ptr
, size
);
149 static inline BOOL
asm_free(LPVOID ptr
) {
150 return HeapFree(GetProcessHeap(), 0, ptr
);
155 /* This structure is only used in asmshader.y, but since the .l file accesses the semantic types
156 * too it has to know it as well
161 DWORD additional_offset
;
166 #define MAX_SRC_REGS 4
169 struct shader_reg reg
[MAX_SRC_REGS
];
173 struct asmparser_backend
{
174 void (*constF
)(struct asm_parser
*This
, DWORD reg
, float x
, float y
, float z
, float w
);
175 void (*constI
)(struct asm_parser
*This
, DWORD reg
, INT x
, INT y
, INT z
, INT w
);
176 void (*constB
)(struct asm_parser
*This
, DWORD reg
, BOOL x
);
178 void (*dstreg
)(struct asm_parser
*This
, struct instruction
*instr
,
179 const struct shader_reg
*dst
);
180 void (*srcreg
)(struct asm_parser
*This
, struct instruction
*instr
, int num
,
181 const struct shader_reg
*src
);
183 void (*predicate
)(struct asm_parser
*This
,
184 const struct shader_reg
*predicate
);
185 void (*coissue
)(struct asm_parser
*This
);
187 void (*dcl_output
)(struct asm_parser
*This
, DWORD usage
, DWORD num
,
188 const struct shader_reg
*reg
);
189 void (*dcl_input
)(struct asm_parser
*This
, DWORD usage
, DWORD num
,
190 DWORD mod
, const struct shader_reg
*reg
);
191 void (*dcl_sampler
)(struct asm_parser
*This
, DWORD samptype
, DWORD mod
,
192 DWORD regnum
, unsigned int line_no
);
194 void (*end
)(struct asm_parser
*This
);
196 void (*instr
)(struct asm_parser
*This
, DWORD opcode
, DWORD mod
, DWORD shift
,
197 BWRITER_COMPARISON_TYPE comp
, const struct shader_reg
*dst
,
198 const struct src_regs
*srcs
, int expectednsrcs
);
201 struct instruction
*alloc_instr(unsigned int srcs
) DECLSPEC_HIDDEN
;
202 BOOL
add_instruction(struct bwriter_shader
*shader
, struct instruction
*instr
) DECLSPEC_HIDDEN
;
203 BOOL
add_constF(struct bwriter_shader
*shader
, DWORD reg
, float x
, float y
, float z
, float w
) DECLSPEC_HIDDEN
;
204 BOOL
add_constI(struct bwriter_shader
*shader
, DWORD reg
, INT x
, INT y
, INT z
, INT w
) DECLSPEC_HIDDEN
;
205 BOOL
add_constB(struct bwriter_shader
*shader
, DWORD reg
, BOOL x
) DECLSPEC_HIDDEN
;
206 BOOL
record_declaration(struct bwriter_shader
*shader
, DWORD usage
, DWORD usage_idx
,
207 DWORD mod
, BOOL output
, DWORD regnum
, DWORD writemask
, BOOL builtin
) DECLSPEC_HIDDEN
;
208 BOOL
record_sampler(struct bwriter_shader
*shader
, DWORD samptype
, DWORD mod
, DWORD regnum
) DECLSPEC_HIDDEN
;
210 #define MESSAGEBUFFER_INITIAL_SIZE 256
219 struct compilation_messages
223 unsigned int capacity
;
228 /* The function table of the parser implementation */
229 const struct asmparser_backend
*funcs
;
231 /* Private data follows */
232 struct bwriter_shader
*shader
;
233 unsigned int m3x3pad_count
;
235 enum parse_status status
;
236 struct compilation_messages messages
;
237 unsigned int line_no
;
240 extern struct asm_parser asm_ctx DECLSPEC_HIDDEN
;
242 void create_vs10_parser(struct asm_parser
*ret
) DECLSPEC_HIDDEN
;
243 void create_vs11_parser(struct asm_parser
*ret
) DECLSPEC_HIDDEN
;
244 void create_vs20_parser(struct asm_parser
*ret
) DECLSPEC_HIDDEN
;
245 void create_vs2x_parser(struct asm_parser
*ret
) DECLSPEC_HIDDEN
;
246 void create_vs30_parser(struct asm_parser
*ret
) DECLSPEC_HIDDEN
;
247 void create_ps10_parser(struct asm_parser
*ret
) DECLSPEC_HIDDEN
;
248 void create_ps11_parser(struct asm_parser
*ret
) DECLSPEC_HIDDEN
;
249 void create_ps12_parser(struct asm_parser
*ret
) DECLSPEC_HIDDEN
;
250 void create_ps13_parser(struct asm_parser
*ret
) DECLSPEC_HIDDEN
;
251 void create_ps14_parser(struct asm_parser
*ret
) DECLSPEC_HIDDEN
;
252 void create_ps20_parser(struct asm_parser
*ret
) DECLSPEC_HIDDEN
;
253 void create_ps2x_parser(struct asm_parser
*ret
) DECLSPEC_HIDDEN
;
254 void create_ps30_parser(struct asm_parser
*ret
) DECLSPEC_HIDDEN
;
256 struct bwriter_shader
*parse_asm_shader(char **messages
) DECLSPEC_HIDDEN
;
259 #define PRINTF_ATTR(fmt,args) __attribute__((format (printf,fmt,args)))
261 #define PRINTF_ATTR(fmt,args)
264 void compilation_message(struct compilation_messages
*msg
, const char *fmt
, va_list args
) DECLSPEC_HIDDEN
;
265 void asmparser_message(struct asm_parser
*ctx
, const char *fmt
, ...) PRINTF_ATTR(2,3) DECLSPEC_HIDDEN
;
266 static inline void set_parse_status(enum parse_status
*current
, enum parse_status update
)
268 if (update
== PARSE_ERR
)
269 *current
= PARSE_ERR
;
270 else if (update
== PARSE_WARN
&& *current
== PARSE_SUCCESS
)
271 *current
= PARSE_WARN
;
274 /* A reasonable value as initial size */
275 #define BYTECODEBUFFER_INITIAL_SIZE 32
276 struct bytecode_buffer
{
280 /* For tracking rare out of memory situations without passing
281 * return values around everywhere
286 struct bc_writer
; /* Predeclaration for use in vtable parameters */
288 typedef void (*instr_writer
)(struct bc_writer
*This
,
289 const struct instruction
*instr
,
290 struct bytecode_buffer
*buffer
);
292 struct bytecode_backend
{
293 void (*header
)(struct bc_writer
*This
, const struct bwriter_shader
*shader
,
294 struct bytecode_buffer
*buffer
);
295 void (*end
)(struct bc_writer
*This
, const struct bwriter_shader
*shader
,
296 struct bytecode_buffer
*buffer
);
297 void (*srcreg
)(struct bc_writer
*This
, const struct shader_reg
*reg
,
298 struct bytecode_buffer
*buffer
);
299 void (*dstreg
)(struct bc_writer
*This
, const struct shader_reg
*reg
,
300 struct bytecode_buffer
*buffer
, DWORD shift
, DWORD mod
);
301 void (*opcode
)(struct bc_writer
*This
, const struct instruction
*instr
,
302 DWORD token
, struct bytecode_buffer
*buffer
);
304 const struct instr_handler_table
{
310 /* Bytecode writing stuff */
312 const struct bytecode_backend
*funcs
;
314 /* Avoid result checking */
319 /* Vertex shader varying mapping */
328 /* Pixel shader specific members */
333 /* Debug utility routines */
334 const char *debug_print_srcmod(DWORD mod
) DECLSPEC_HIDDEN
;
335 const char *debug_print_dstmod(DWORD mod
) DECLSPEC_HIDDEN
;
336 const char *debug_print_shift(DWORD shift
) DECLSPEC_HIDDEN
;
337 const char *debug_print_dstreg(const struct shader_reg
*reg
) DECLSPEC_HIDDEN
;
338 const char *debug_print_srcreg(const struct shader_reg
*reg
) DECLSPEC_HIDDEN
;
339 const char *debug_print_comp(DWORD comp
) DECLSPEC_HIDDEN
;
340 const char *debug_print_opcode(DWORD opcode
) DECLSPEC_HIDDEN
;
342 /* Used to signal an incorrect swizzle/writemask */
343 #define SWIZZLE_ERR ~0U
346 Enumerations and defines used in the bytecode writer
347 intermediate representation
349 typedef enum _BWRITERSHADER_INSTRUCTION_OPCODE_TYPE
{
405 BWRITERSIO_TEXREG2AR
,
406 BWRITERSIO_TEXREG2GB
,
407 BWRITERSIO_TEXM3x2PAD
,
408 BWRITERSIO_TEXM3x2TEX
,
409 BWRITERSIO_TEXM3x3PAD
,
410 BWRITERSIO_TEXM3x3TEX
,
411 BWRITERSIO_TEXM3x3SPEC
,
412 BWRITERSIO_TEXM3x3VSPEC
,
417 BWRITERSIO_TEXREG2RGB
,
418 BWRITERSIO_TEXDP3TEX
,
419 BWRITERSIO_TEXM3x2DEPTH
,
438 } BWRITERSHADER_INSTRUCTION_OPCODE_TYPE
;
440 typedef enum _BWRITERSHADER_PARAM_REGISTER_TYPE
{
448 BWRITERSPR_TEXCRDOUT
,
454 BWRITERSPR_CONSTBOOL
,
459 } BWRITERSHADER_PARAM_REGISTER_TYPE
;
461 typedef enum _BWRITERVS_RASTOUT_OFFSETS
465 BWRITERSRO_POINT_SIZE
466 } BWRITERVS_RASTOUT_OFFSETS
;
468 #define BWRITERSP_WRITEMASK_0 0x1 /* .x r */
469 #define BWRITERSP_WRITEMASK_1 0x2 /* .y g */
470 #define BWRITERSP_WRITEMASK_2 0x4 /* .z b */
471 #define BWRITERSP_WRITEMASK_3 0x8 /* .w a */
472 #define BWRITERSP_WRITEMASK_ALL 0xf /* all */
474 typedef enum _BWRITERSHADER_PARAM_DSTMOD_TYPE
{
475 BWRITERSPDM_NONE
= 0,
476 BWRITERSPDM_SATURATE
= 1,
477 BWRITERSPDM_PARTIALPRECISION
= 2,
478 BWRITERSPDM_MSAMPCENTROID
= 4,
479 } BWRITERSHADER_PARAM_DSTMOD_TYPE
;
481 typedef enum _BWRITERSAMPLER_TEXTURE_TYPE
{
482 BWRITERSTT_UNKNOWN
= 0,
486 BWRITERSTT_VOLUME
= 4,
487 } BWRITERSAMPLER_TEXTURE_TYPE
;
489 #define BWRITERSI_TEXLD_PROJECT 1
490 #define BWRITERSI_TEXLD_BIAS 2
492 typedef enum _BWRITERSHADER_PARAM_SRCMOD_TYPE
{
493 BWRITERSPSM_NONE
= 0,
507 } BWRITERSHADER_PARAM_SRCMOD_TYPE
;
509 #define BWRITER_SM1_VS 0xfffe
510 #define BWRITER_SM1_PS 0xffff
512 #define BWRITERPS_VERSION(major, minor) ((BWRITER_SM1_PS << 16) | ((major) << 8) | (minor))
513 #define BWRITERVS_VERSION(major, minor) ((BWRITER_SM1_VS << 16) | ((major) << 8) | (minor))
515 #define BWRITERVS_SWIZZLE_SHIFT 16
516 #define BWRITERVS_SWIZZLE_MASK (0xFF << BWRITERVS_SWIZZLE_SHIFT)
518 #define BWRITERVS_X_X (0 << BWRITERVS_SWIZZLE_SHIFT)
519 #define BWRITERVS_X_Y (1 << BWRITERVS_SWIZZLE_SHIFT)
520 #define BWRITERVS_X_Z (2 << BWRITERVS_SWIZZLE_SHIFT)
521 #define BWRITERVS_X_W (3 << BWRITERVS_SWIZZLE_SHIFT)
523 #define BWRITERVS_Y_X (0 << (BWRITERVS_SWIZZLE_SHIFT + 2))
524 #define BWRITERVS_Y_Y (1 << (BWRITERVS_SWIZZLE_SHIFT + 2))
525 #define BWRITERVS_Y_Z (2 << (BWRITERVS_SWIZZLE_SHIFT + 2))
526 #define BWRITERVS_Y_W (3 << (BWRITERVS_SWIZZLE_SHIFT + 2))
528 #define BWRITERVS_Z_X (0 << (BWRITERVS_SWIZZLE_SHIFT + 4))
529 #define BWRITERVS_Z_Y (1 << (BWRITERVS_SWIZZLE_SHIFT + 4))
530 #define BWRITERVS_Z_Z (2 << (BWRITERVS_SWIZZLE_SHIFT + 4))
531 #define BWRITERVS_Z_W (3 << (BWRITERVS_SWIZZLE_SHIFT + 4))
533 #define BWRITERVS_W_X (0 << (BWRITERVS_SWIZZLE_SHIFT + 6))
534 #define BWRITERVS_W_Y (1 << (BWRITERVS_SWIZZLE_SHIFT + 6))
535 #define BWRITERVS_W_Z (2 << (BWRITERVS_SWIZZLE_SHIFT + 6))
536 #define BWRITERVS_W_W (3 << (BWRITERVS_SWIZZLE_SHIFT + 6))
538 #define BWRITERVS_NOSWIZZLE (BWRITERVS_X_X | BWRITERVS_Y_Y | BWRITERVS_Z_Z | BWRITERVS_W_W)
540 #define BWRITERVS_SWIZZLE_X (BWRITERVS_X_X | BWRITERVS_Y_X | BWRITERVS_Z_X | BWRITERVS_W_X)
541 #define BWRITERVS_SWIZZLE_Y (BWRITERVS_X_Y | BWRITERVS_Y_Y | BWRITERVS_Z_Y | BWRITERVS_W_Y)
542 #define BWRITERVS_SWIZZLE_Z (BWRITERVS_X_Z | BWRITERVS_Y_Z | BWRITERVS_Z_Z | BWRITERVS_W_Z)
543 #define BWRITERVS_SWIZZLE_W (BWRITERVS_X_W | BWRITERVS_Y_W | BWRITERVS_Z_W | BWRITERVS_W_W)
545 typedef enum _BWRITERDECLUSAGE
{
546 BWRITERDECLUSAGE_POSITION
,
547 BWRITERDECLUSAGE_BLENDWEIGHT
,
548 BWRITERDECLUSAGE_BLENDINDICES
,
549 BWRITERDECLUSAGE_NORMAL
,
550 BWRITERDECLUSAGE_PSIZE
,
551 BWRITERDECLUSAGE_TEXCOORD
,
552 BWRITERDECLUSAGE_TANGENT
,
553 BWRITERDECLUSAGE_BINORMAL
,
554 BWRITERDECLUSAGE_TESSFACTOR
,
555 BWRITERDECLUSAGE_POSITIONT
,
556 BWRITERDECLUSAGE_COLOR
,
557 BWRITERDECLUSAGE_FOG
,
558 BWRITERDECLUSAGE_DEPTH
,
559 BWRITERDECLUSAGE_SAMPLE
562 /* ps 1.x texture registers mappings */
568 struct bwriter_shader
*SlAssembleShader(const char *text
, char **messages
) DECLSPEC_HIDDEN
;
569 DWORD
SlWriteBytecode(const struct bwriter_shader
*shader
, int dxversion
, DWORD
**result
) DECLSPEC_HIDDEN
;
570 void SlDeleteShader(struct bwriter_shader
*shader
) DECLSPEC_HIDDEN
;
572 #define MAKE_TAG(ch0, ch1, ch2, ch3) \
573 ((DWORD)(ch0) | ((DWORD)(ch1) << 8) | \
574 ((DWORD)(ch2) << 16) | ((DWORD)(ch3) << 24 ))
575 #define TAG_Aon9 MAKE_TAG('A', 'o', 'n', '9')
576 #define TAG_DXBC MAKE_TAG('D', 'X', 'B', 'C')
577 #define TAG_ISGN MAKE_TAG('I', 'S', 'G', 'N')
578 #define TAG_OSGN MAKE_TAG('O', 'S', 'G', 'N')
579 #define TAG_OSG5 MAKE_TAG('O', 'S', 'G', '5')
580 #define TAG_PCSG MAKE_TAG('P', 'C', 'S', 'G')
581 #define TAG_RDEF MAKE_TAG('R', 'D', 'E', 'F')
582 #define TAG_SDBG MAKE_TAG('S', 'D', 'B', 'G')
583 #define TAG_SHDR MAKE_TAG('S', 'H', 'D', 'R')
584 #define TAG_SHEX MAKE_TAG('S', 'H', 'E', 'X')
585 #define TAG_STAT MAKE_TAG('S', 'T', 'A', 'T')
586 #define TAG_XNAP MAKE_TAG('X', 'N', 'A', 'P')
587 #define TAG_XNAS MAKE_TAG('X', 'N', 'A', 'S')
600 struct dxbc_section
*sections
;
603 HRESULT
dxbc_write_blob(struct dxbc
*dxbc
, ID3DBlob
**blob
) DECLSPEC_HIDDEN
;
604 void dxbc_destroy(struct dxbc
*dxbc
) DECLSPEC_HIDDEN
;
605 HRESULT
dxbc_parse(const char *data
, SIZE_T data_size
, struct dxbc
*dxbc
) DECLSPEC_HIDDEN
;
606 HRESULT
dxbc_add_section(struct dxbc
*dxbc
, DWORD tag
, const char *data
, DWORD data_size
) DECLSPEC_HIDDEN
;
607 HRESULT
dxbc_init(struct dxbc
*dxbc
, DWORD count
) DECLSPEC_HIDDEN
;
609 static inline void read_dword(const char **ptr
, DWORD
*d
)
611 memcpy(d
, *ptr
, sizeof(*d
));
615 static inline void write_dword(char **ptr
, DWORD d
)
617 memcpy(*ptr
, &d
, sizeof(d
));
621 void skip_dword_unknown(const char **ptr
, unsigned int count
) DECLSPEC_HIDDEN
;
623 #endif /* __WINE_D3DCOMPILER_PRIVATE_H */