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;
46 struct d3dcompiler_blob
48 ID3DBlob ID3DBlob_iface;
55 HRESULT d3dcompiler_blob_init(struct d3dcompiler_blob *blob, SIZE_T data_size) DECLSPEC_HIDDEN;
58 HRESULT d3dcompiler_get_blob_part(const void *data, SIZE_T data_size, D3D_BLOB_PART part, UINT flags, ID3DBlob **blob) DECLSPEC_HIDDEN;
59 HRESULT d3dcompiler_strip_shader(const void *data, SIZE_T data_size, UINT flags, ID3DBlob **blob) DECLSPEC_HIDDEN;
61 struct d3dcompiler_shader_signature
63 D3D11_SIGNATURE_PARAMETER_DESC *elements;
68 struct d3dcompiler_shader_reflection_type
70 ID3D11ShaderReflectionType ID3D11ShaderReflectionType_iface;
73 struct wine_rb_entry entry;
75 struct d3dcompiler_shader_reflection *reflection;
77 D3D11_SHADER_TYPE_DESC desc;
80 struct d3dcompiler_shader_reflection_variable
82 ID3D11ShaderReflectionVariable ID3D11ShaderReflectionVariable_iface;
84 struct d3dcompiler_shader_reflection_constant_buffer *constant_buffer;
85 struct d3dcompiler_shader_reflection_type *type;
94 struct d3dcompiler_shader_reflection_constant_buffer
96 ID3D11ShaderReflectionConstantBuffer ID3D11ShaderReflectionConstantBuffer_iface;
98 struct d3dcompiler_shader_reflection *reflection;
101 D3D_CBUFFER_TYPE type;
106 struct d3dcompiler_shader_reflection_variable *variables;
109 /* ID3D11ShaderReflection */
110 struct d3dcompiler_shader_reflection
112 ID3D11ShaderReflection ID3D11ShaderReflection_iface;
119 UINT bound_resource_count;
120 UINT constant_buffer_count;
122 UINT mov_instruction_count;
123 UINT conversion_instruction_count;
124 UINT instruction_count;
125 UINT emit_instruction_count;
126 D3D_PRIMITIVE_TOPOLOGY gs_output_topology;
127 UINT gs_max_output_vertex_count;
128 D3D_PRIMITIVE input_primitive;
129 UINT cut_instruction_count;
131 UINT static_flow_control_count;
132 UINT float_instruction_count;
133 UINT temp_register_count;
134 UINT int_instruction_count;
135 UINT uint_instruction_count;
136 UINT temp_array_count;
137 UINT array_instruction_count;
138 UINT texture_normal_instructions;
139 UINT texture_load_instructions;
140 UINT texture_comp_instructions;
141 UINT texture_bias_instructions;
142 UINT texture_gradient_instructions;
143 UINT dynamic_flow_control_count;
144 UINT c_control_points;
145 D3D_TESSELLATOR_OUTPUT_PRIMITIVE hs_output_primitive;
146 D3D_TESSELLATOR_PARTITIONING hs_prtitioning;
147 D3D_TESSELLATOR_DOMAIN tessellator_domain;
149 struct d3dcompiler_shader_signature *isgn;
150 struct d3dcompiler_shader_signature *osgn;
151 struct d3dcompiler_shader_signature *pcsg;
152 char *resource_string;
153 D3D11_SHADER_INPUT_BIND_DESC *bound_resources;
154 struct d3dcompiler_shader_reflection_constant_buffer *constant_buffers;
155 struct wine_rb_tree types;
158 /* reflection handling */
159 HRESULT d3dcompiler_shader_reflection_init(struct d3dcompiler_shader_reflection *reflection, const void *data, SIZE_T data_size) DECLSPEC_HIDDEN;
161 /* Shader assembler definitions */
162 typedef enum _shader_type {
167 typedef enum BWRITER_COMPARISON_TYPE {
168 BWRITER_COMPARISON_NONE,
169 BWRITER_COMPARISON_GT,
170 BWRITER_COMPARISON_EQ,
171 BWRITER_COMPARISON_GE,
172 BWRITER_COMPARISON_LT,
173 BWRITER_COMPARISON_NE,
174 BWRITER_COMPARISON_LE
175 } BWRITER_COMPARISON_TYPE;
190 struct shader_reg *rel_reg;
202 BWRITER_COMPARISON_TYPE comptype;
204 struct shader_reg dst;
205 struct shader_reg *src;
206 unsigned int num_srcs; /* For freeing the rel_regs */
208 struct shader_reg predicate;
213 DWORD usage, usage_idx;
226 #define INSTRARRAY_INITIAL_SIZE 8
227 struct bwriter_shader {
230 /* Shader version selected */
233 /* Local constants. Every constant that is not defined below is loaded from
234 * the global constant set at shader runtime
236 struct constant **constF;
237 struct constant **constI;
238 struct constant **constB;
239 unsigned int num_cf, num_ci, num_cb;
241 /* Declared input and output varyings */
242 struct declaration *inputs, *outputs;
243 unsigned int num_inputs, num_outputs;
244 struct samplerdecl *samplers;
245 unsigned int num_samplers;
247 /* Are special pixel shader 3.0 registers declared? */
250 /* Array of shader instructions - The shader code itself */
251 struct instruction **instr;
252 unsigned int num_instrs, instr_alloc_size;
255 static inline LPVOID asm_alloc(SIZE_T size) {
256 return HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, size);
259 static inline LPVOID asm_realloc(LPVOID ptr, SIZE_T size) {
260 return HeapReAlloc(GetProcessHeap(), 0, ptr, size);
263 static inline BOOL asm_free(LPVOID ptr) {
264 return HeapFree(GetProcessHeap(), 0, ptr);
269 /* This structure is only used in asmshader.y, but since the .l file accesses the semantic types
270 * too it has to know it as well
275 DWORD additional_offset;
280 #define MAX_SRC_REGS 4
283 struct shader_reg reg[MAX_SRC_REGS];
287 struct asmparser_backend {
288 void (*constF)(struct asm_parser *This, DWORD reg, float x, float y, float z, float w);
289 void (*constI)(struct asm_parser *This, DWORD reg, INT x, INT y, INT z, INT w);
290 void (*constB)(struct asm_parser *This, DWORD reg, BOOL x);
292 void (*dstreg)(struct asm_parser *This, struct instruction *instr,
293 const struct shader_reg *dst);
294 void (*srcreg)(struct asm_parser *This, struct instruction *instr, int num,
295 const struct shader_reg *src);
297 void (*predicate)(struct asm_parser *This,
298 const struct shader_reg *predicate);
299 void (*coissue)(struct asm_parser *This);
301 void (*dcl_output)(struct asm_parser *This, DWORD usage, DWORD num,
302 const struct shader_reg *reg);
303 void (*dcl_input)(struct asm_parser *This, DWORD usage, DWORD num,
304 DWORD mod, const struct shader_reg *reg);
305 void (*dcl_sampler)(struct asm_parser *This, DWORD samptype, DWORD mod,
306 DWORD regnum, unsigned int line_no);
308 void (*end)(struct asm_parser *This);
310 void (*instr)(struct asm_parser *This, DWORD opcode, DWORD mod, DWORD shift,
311 BWRITER_COMPARISON_TYPE comp, const struct shader_reg *dst,
312 const struct src_regs *srcs, int expectednsrcs);
315 struct instruction *alloc_instr(unsigned int srcs) DECLSPEC_HIDDEN;
316 BOOL add_instruction(struct bwriter_shader *shader, struct instruction *instr) DECLSPEC_HIDDEN;
317 BOOL add_constF(struct bwriter_shader *shader, DWORD reg, float x, float y, float z, float w) DECLSPEC_HIDDEN;
318 BOOL add_constI(struct bwriter_shader *shader, DWORD reg, INT x, INT y, INT z, INT w) DECLSPEC_HIDDEN;
319 BOOL add_constB(struct bwriter_shader *shader, DWORD reg, BOOL x) DECLSPEC_HIDDEN;
320 BOOL record_declaration(struct bwriter_shader *shader, DWORD usage, DWORD usage_idx,
321 DWORD mod, BOOL output, DWORD regnum, DWORD writemask, BOOL builtin) DECLSPEC_HIDDEN;
322 BOOL record_sampler(struct bwriter_shader *shader, DWORD samptype, DWORD mod, DWORD regnum) DECLSPEC_HIDDEN;
324 #define MESSAGEBUFFER_INITIAL_SIZE 256
327 /* The function table of the parser implementation */
328 const struct asmparser_backend *funcs;
330 /* Private data follows */
331 struct bwriter_shader *shader;
332 unsigned int m3x3pad_count;
340 unsigned int messagesize;
341 unsigned int messagecapacity;
342 unsigned int line_no;
345 extern struct asm_parser asm_ctx DECLSPEC_HIDDEN;
347 void create_vs10_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
348 void create_vs11_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
349 void create_vs20_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
350 void create_vs2x_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
351 void create_vs30_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
352 void create_ps10_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
353 void create_ps11_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
354 void create_ps12_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
355 void create_ps13_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
356 void create_ps14_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
357 void create_ps20_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
358 void create_ps2x_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
359 void create_ps30_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
361 struct bwriter_shader *parse_asm_shader(char **messages) DECLSPEC_HIDDEN;
364 #define PRINTF_ATTR(fmt,args) __attribute__((format (printf,fmt,args)))
366 #define PRINTF_ATTR(fmt,args)
369 void asmparser_message(struct asm_parser *ctx, const char *fmt, ...) PRINTF_ATTR(2,3) DECLSPEC_HIDDEN;
370 void set_parse_status(struct asm_parser *ctx, enum parse_status status) DECLSPEC_HIDDEN;
372 /* A reasonable value as initial size */
373 #define BYTECODEBUFFER_INITIAL_SIZE 32
374 struct bytecode_buffer {
378 /* For tracking rare out of memory situations without passing
379 * return values around everywhere
384 struct bc_writer; /* Predeclaration for use in vtable parameters */
386 typedef void (*instr_writer)(struct bc_writer *This,
387 const struct instruction *instr,
388 struct bytecode_buffer *buffer);
390 struct bytecode_backend {
391 void (*header)(struct bc_writer *This, const struct bwriter_shader *shader,
392 struct bytecode_buffer *buffer);
393 void (*end)(struct bc_writer *This, const struct bwriter_shader *shader,
394 struct bytecode_buffer *buffer);
395 void (*srcreg)(struct bc_writer *This, const struct shader_reg *reg,
396 struct bytecode_buffer *buffer);
397 void (*dstreg)(struct bc_writer *This, const struct shader_reg *reg,
398 struct bytecode_buffer *buffer, DWORD shift, DWORD mod);
399 void (*opcode)(struct bc_writer *This, const struct instruction *instr,
400 DWORD token, struct bytecode_buffer *buffer);
402 const struct instr_handler_table {
408 /* Bytecode writing stuff */
410 const struct bytecode_backend *funcs;
412 /* Avoid result checking */
417 /* Vertex shader varying mapping */
426 /* Pixel shader specific members */
431 /* Debug utility routines */
432 const char *debug_print_srcmod(DWORD mod) DECLSPEC_HIDDEN;
433 const char *debug_print_dstmod(DWORD mod) DECLSPEC_HIDDEN;
434 const char *debug_print_shift(DWORD shift) DECLSPEC_HIDDEN;
435 const char *debug_print_dstreg(const struct shader_reg *reg) DECLSPEC_HIDDEN;
436 const char *debug_print_srcreg(const struct shader_reg *reg) DECLSPEC_HIDDEN;
437 const char *debug_print_comp(DWORD comp) DECLSPEC_HIDDEN;
438 const char *debug_print_opcode(DWORD opcode) DECLSPEC_HIDDEN;
440 /* Used to signal an incorrect swizzle/writemask */
441 #define SWIZZLE_ERR ~0U
444 Enumerations and defines used in the bytecode writer
445 intermediate representation
447 typedef enum _BWRITERSHADER_INSTRUCTION_OPCODE_TYPE {
503 BWRITERSIO_TEXREG2AR,
504 BWRITERSIO_TEXREG2GB,
505 BWRITERSIO_TEXM3x2PAD,
506 BWRITERSIO_TEXM3x2TEX,
507 BWRITERSIO_TEXM3x3PAD,
508 BWRITERSIO_TEXM3x3TEX,
509 BWRITERSIO_TEXM3x3SPEC,
510 BWRITERSIO_TEXM3x3VSPEC,
515 BWRITERSIO_TEXREG2RGB,
516 BWRITERSIO_TEXDP3TEX,
517 BWRITERSIO_TEXM3x2DEPTH,
536 } BWRITERSHADER_INSTRUCTION_OPCODE_TYPE;
538 typedef enum _BWRITERSHADER_PARAM_REGISTER_TYPE {
546 BWRITERSPR_TEXCRDOUT,
552 BWRITERSPR_CONSTBOOL,
557 } BWRITERSHADER_PARAM_REGISTER_TYPE;
559 typedef enum _BWRITERVS_RASTOUT_OFFSETS
563 BWRITERSRO_POINT_SIZE
564 } BWRITERVS_RASTOUT_OFFSETS;
566 #define BWRITERSP_WRITEMASK_0 0x1 /* .x r */
567 #define BWRITERSP_WRITEMASK_1 0x2 /* .y g */
568 #define BWRITERSP_WRITEMASK_2 0x4 /* .z b */
569 #define BWRITERSP_WRITEMASK_3 0x8 /* .w a */
570 #define BWRITERSP_WRITEMASK_ALL 0xf /* all */
572 typedef enum _BWRITERSHADER_PARAM_DSTMOD_TYPE {
573 BWRITERSPDM_NONE = 0,
574 BWRITERSPDM_SATURATE = 1,
575 BWRITERSPDM_PARTIALPRECISION = 2,
576 BWRITERSPDM_MSAMPCENTROID = 4,
577 } BWRITERSHADER_PARAM_DSTMOD_TYPE;
579 typedef enum _BWRITERSAMPLER_TEXTURE_TYPE {
580 BWRITERSTT_UNKNOWN = 0,
584 BWRITERSTT_VOLUME = 4,
585 } BWRITERSAMPLER_TEXTURE_TYPE;
587 #define BWRITERSI_TEXLD_PROJECT 1
588 #define BWRITERSI_TEXLD_BIAS 2
590 typedef enum _BWRITERSHADER_PARAM_SRCMOD_TYPE {
591 BWRITERSPSM_NONE = 0,
605 } BWRITERSHADER_PARAM_SRCMOD_TYPE;
607 #define BWRITER_SM1_VS 0xfffe
608 #define BWRITER_SM1_PS 0xffff
610 #define BWRITERPS_VERSION(major, minor) ((BWRITER_SM1_PS << 16) | ((major) << 8) | (minor))
611 #define BWRITERVS_VERSION(major, minor) ((BWRITER_SM1_VS << 16) | ((major) << 8) | (minor))
613 #define BWRITERVS_SWIZZLE_SHIFT 16
614 #define BWRITERVS_SWIZZLE_MASK (0xFF << BWRITERVS_SWIZZLE_SHIFT)
616 #define BWRITERVS_X_X (0 << BWRITERVS_SWIZZLE_SHIFT)
617 #define BWRITERVS_X_Y (1 << BWRITERVS_SWIZZLE_SHIFT)
618 #define BWRITERVS_X_Z (2 << BWRITERVS_SWIZZLE_SHIFT)
619 #define BWRITERVS_X_W (3 << BWRITERVS_SWIZZLE_SHIFT)
621 #define BWRITERVS_Y_X (0 << (BWRITERVS_SWIZZLE_SHIFT + 2))
622 #define BWRITERVS_Y_Y (1 << (BWRITERVS_SWIZZLE_SHIFT + 2))
623 #define BWRITERVS_Y_Z (2 << (BWRITERVS_SWIZZLE_SHIFT + 2))
624 #define BWRITERVS_Y_W (3 << (BWRITERVS_SWIZZLE_SHIFT + 2))
626 #define BWRITERVS_Z_X (0 << (BWRITERVS_SWIZZLE_SHIFT + 4))
627 #define BWRITERVS_Z_Y (1 << (BWRITERVS_SWIZZLE_SHIFT + 4))
628 #define BWRITERVS_Z_Z (2 << (BWRITERVS_SWIZZLE_SHIFT + 4))
629 #define BWRITERVS_Z_W (3 << (BWRITERVS_SWIZZLE_SHIFT + 4))
631 #define BWRITERVS_W_X (0 << (BWRITERVS_SWIZZLE_SHIFT + 6))
632 #define BWRITERVS_W_Y (1 << (BWRITERVS_SWIZZLE_SHIFT + 6))
633 #define BWRITERVS_W_Z (2 << (BWRITERVS_SWIZZLE_SHIFT + 6))
634 #define BWRITERVS_W_W (3 << (BWRITERVS_SWIZZLE_SHIFT + 6))
636 #define BWRITERVS_NOSWIZZLE (BWRITERVS_X_X | BWRITERVS_Y_Y | BWRITERVS_Z_Z | BWRITERVS_W_W)
638 #define BWRITERVS_SWIZZLE_X (BWRITERVS_X_X | BWRITERVS_Y_X | BWRITERVS_Z_X | BWRITERVS_W_X)
639 #define BWRITERVS_SWIZZLE_Y (BWRITERVS_X_Y | BWRITERVS_Y_Y | BWRITERVS_Z_Y | BWRITERVS_W_Y)
640 #define BWRITERVS_SWIZZLE_Z (BWRITERVS_X_Z | BWRITERVS_Y_Z | BWRITERVS_Z_Z | BWRITERVS_W_Z)
641 #define BWRITERVS_SWIZZLE_W (BWRITERVS_X_W | BWRITERVS_Y_W | BWRITERVS_Z_W | BWRITERVS_W_W)
643 typedef enum _BWRITERDECLUSAGE {
644 BWRITERDECLUSAGE_POSITION,
645 BWRITERDECLUSAGE_BLENDWEIGHT,
646 BWRITERDECLUSAGE_BLENDINDICES,
647 BWRITERDECLUSAGE_NORMAL,
648 BWRITERDECLUSAGE_PSIZE,
649 BWRITERDECLUSAGE_TEXCOORD,
650 BWRITERDECLUSAGE_TANGENT,
651 BWRITERDECLUSAGE_BINORMAL,
652 BWRITERDECLUSAGE_TESSFACTOR,
653 BWRITERDECLUSAGE_POSITIONT,
654 BWRITERDECLUSAGE_COLOR,
655 BWRITERDECLUSAGE_FOG,
656 BWRITERDECLUSAGE_DEPTH,
657 BWRITERDECLUSAGE_SAMPLE
660 /* ps 1.x texture registers mappings */
666 struct bwriter_shader *SlAssembleShader(const char *text, char **messages) DECLSPEC_HIDDEN;
667 DWORD SlWriteBytecode(const struct bwriter_shader *shader, int dxversion, DWORD **result) DECLSPEC_HIDDEN;
668 void SlDeleteShader(struct bwriter_shader *shader) DECLSPEC_HIDDEN;
670 #define MAKE_TAG(ch0, ch1, ch2, ch3) \
671 ((DWORD)(ch0) | ((DWORD)(ch1) << 8) | \
672 ((DWORD)(ch2) << 16) | ((DWORD)(ch3) << 24 ))
673 #define TAG_Aon9 MAKE_TAG('A', 'o', 'n', '9')
674 #define TAG_DXBC MAKE_TAG('D', 'X', 'B', 'C')
675 #define TAG_ISGN MAKE_TAG('I', 'S', 'G', 'N')
676 #define TAG_OSGN MAKE_TAG('O', 'S', 'G', 'N')
677 #define TAG_OSG5 MAKE_TAG('O', 'S', 'G', '5')
678 #define TAG_PCSG MAKE_TAG('P', 'C', 'S', 'G')
679 #define TAG_RDEF MAKE_TAG('R', 'D', 'E', 'F')
680 #define TAG_SDBG MAKE_TAG('S', 'D', 'B', 'G')
681 #define TAG_SHDR MAKE_TAG('S', 'H', 'D', 'R')
682 #define TAG_SHEX MAKE_TAG('S', 'H', 'E', 'X')
683 #define TAG_STAT MAKE_TAG('S', 'T', 'A', 'T')
684 #define TAG_XNAP MAKE_TAG('X', 'N', 'A', 'P')
685 #define TAG_XNAS MAKE_TAG('X', 'N', 'A', 'S')
698 struct dxbc_section *sections;
701 HRESULT dxbc_write_blob(struct dxbc *dxbc, ID3DBlob **blob) DECLSPEC_HIDDEN;
702 void dxbc_destroy(struct dxbc *dxbc) DECLSPEC_HIDDEN;
703 HRESULT dxbc_parse(const char *data, SIZE_T data_size, struct dxbc *dxbc) DECLSPEC_HIDDEN;
704 HRESULT dxbc_add_section(struct dxbc *dxbc, DWORD tag, const char *data, DWORD data_size) DECLSPEC_HIDDEN;
705 HRESULT dxbc_init(struct dxbc *dxbc, DWORD count) DECLSPEC_HIDDEN;
707 static inline void read_dword(const char **ptr, DWORD *d)
709 memcpy(d, *ptr, sizeof(*d));
713 static inline void write_dword(char **ptr, DWORD d)
715 memcpy(*ptr, &d, sizeof(d));
719 void skip_dword_unknown(const char **ptr, unsigned int count) DECLSPEC_HIDDEN;
720 void write_dword_unknown(char **ptr, DWORD d) DECLSPEC_HIDDEN;
722 #endif /* __WINE_D3DCOMPILER_PRIVATE_H */