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"
32 #include "d3dcompiler.h"
35 * This doesn't belong here, but for some functions it is possible to return that value,
36 * see http://msdn.microsoft.com/en-us/library/bb205278%28v=VS.85%29.aspx
37 * The original definition is in D3DX10core.h.
39 #define D3DERR_INVALIDCALL 0x8876086c
41 /* TRACE helper functions */
42 const char *debug_d3dcompiler_d3d_blob_part(D3D_BLOB_PART part) DECLSPEC_HIDDEN;
45 struct d3dcompiler_blob
47 ID3DBlob ID3DBlob_iface;
54 HRESULT d3dcompiler_blob_init(struct d3dcompiler_blob *blob, SIZE_T data_size) DECLSPEC_HIDDEN;
57 HRESULT d3dcompiler_get_blob_part(const void *data, SIZE_T data_size, D3D_BLOB_PART part, UINT flags, ID3DBlob **blob) DECLSPEC_HIDDEN;
58 HRESULT d3dcompiler_strip_shader(const void *data, SIZE_T data_size, UINT flags, ID3DBlob **blob) DECLSPEC_HIDDEN;
60 struct d3dcompiler_shader_signature
62 D3D11_SIGNATURE_PARAMETER_DESC *elements;
67 /* ID3D11ShaderReflection */
68 struct d3dcompiler_shader_reflection
70 ID3D11ShaderReflection ID3D11ShaderReflection_iface;
76 UINT bound_resource_count;
77 UINT constant_buffer_count;
79 UINT mov_instruction_count;
80 UINT conversion_instruction_count;
81 UINT instruction_count;
82 UINT emit_instruction_count;
83 D3D_PRIMITIVE_TOPOLOGY gs_output_topology;
84 UINT gs_max_output_vertex_count;
85 D3D_PRIMITIVE input_primitive;
86 UINT cut_instruction_count;
88 UINT static_flow_control_count;
89 UINT float_instruction_count;
90 UINT temp_register_count;
91 UINT int_instruction_count;
92 UINT uint_instruction_count;
93 UINT temp_array_count;
94 UINT array_instruction_count;
95 UINT texture_normal_instructions;
96 UINT texture_load_instructions;
97 UINT texture_comp_instructions;
98 UINT texture_bias_instructions;
99 UINT texture_gradient_instructions;
100 UINT dynamic_flow_control_count;
101 UINT c_control_points;
102 D3D_TESSELLATOR_OUTPUT_PRIMITIVE hs_output_primitive;
103 D3D_TESSELLATOR_PARTITIONING hs_prtitioning;
104 D3D_TESSELLATOR_DOMAIN tessellator_domain;
106 struct d3dcompiler_shader_signature *isgn;
107 struct d3dcompiler_shader_signature *osgn;
108 struct d3dcompiler_shader_signature *pcsg;
111 /* reflection handling */
112 HRESULT d3dcompiler_shader_reflection_init(struct d3dcompiler_shader_reflection *reflection, const void *data, SIZE_T data_size) DECLSPEC_HIDDEN;
114 /* Shader assembler definitions */
115 typedef enum _shader_type {
120 typedef enum BWRITER_COMPARISON_TYPE {
121 BWRITER_COMPARISON_NONE,
122 BWRITER_COMPARISON_GT,
123 BWRITER_COMPARISON_EQ,
124 BWRITER_COMPARISON_GE,
125 BWRITER_COMPARISON_LT,
126 BWRITER_COMPARISON_NE,
127 BWRITER_COMPARISON_LE
128 } BWRITER_COMPARISON_TYPE;
143 struct shader_reg *rel_reg;
155 BWRITER_COMPARISON_TYPE comptype;
157 struct shader_reg dst;
158 struct shader_reg *src;
159 unsigned int num_srcs; /* For freeing the rel_regs */
161 struct shader_reg predicate;
166 DWORD usage, usage_idx;
179 #define INSTRARRAY_INITIAL_SIZE 8
180 struct bwriter_shader {
183 /* Shader version selected */
186 /* Local constants. Every constant that is not defined below is loaded from
187 * the global constant set at shader runtime
189 struct constant **constF;
190 struct constant **constI;
191 struct constant **constB;
192 unsigned int num_cf, num_ci, num_cb;
194 /* Declared input and output varyings */
195 struct declaration *inputs, *outputs;
196 unsigned int num_inputs, num_outputs;
197 struct samplerdecl *samplers;
198 unsigned int num_samplers;
200 /* Are special pixel shader 3.0 registers declared? */
203 /* Array of shader instructions - The shader code itself */
204 struct instruction **instr;
205 unsigned int num_instrs, instr_alloc_size;
208 static inline LPVOID asm_alloc(SIZE_T size) {
209 return HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, size);
212 static inline LPVOID asm_realloc(LPVOID ptr, SIZE_T size) {
213 return HeapReAlloc(GetProcessHeap(), 0, ptr, size);
216 static inline BOOL asm_free(LPVOID ptr) {
217 return HeapFree(GetProcessHeap(), 0, ptr);
222 /* This structure is only used in asmshader.y, but since the .l file accesses the semantic types
223 * too it has to know it as well
228 DWORD additional_offset;
233 #define MAX_SRC_REGS 4
236 struct shader_reg reg[MAX_SRC_REGS];
240 struct asmparser_backend {
241 void (*constF)(struct asm_parser *This, DWORD reg, float x, float y, float z, float w);
242 void (*constI)(struct asm_parser *This, DWORD reg, INT x, INT y, INT z, INT w);
243 void (*constB)(struct asm_parser *This, DWORD reg, BOOL x);
245 void (*dstreg)(struct asm_parser *This, struct instruction *instr,
246 const struct shader_reg *dst);
247 void (*srcreg)(struct asm_parser *This, struct instruction *instr, int num,
248 const struct shader_reg *src);
250 void (*predicate)(struct asm_parser *This,
251 const struct shader_reg *predicate);
252 void (*coissue)(struct asm_parser *This);
254 void (*dcl_output)(struct asm_parser *This, DWORD usage, DWORD num,
255 const struct shader_reg *reg);
256 void (*dcl_input)(struct asm_parser *This, DWORD usage, DWORD num,
257 DWORD mod, const struct shader_reg *reg);
258 void (*dcl_sampler)(struct asm_parser *This, DWORD samptype, DWORD mod,
259 DWORD regnum, unsigned int line_no);
261 void (*end)(struct asm_parser *This);
263 void (*instr)(struct asm_parser *This, DWORD opcode, DWORD mod, DWORD shift,
264 BWRITER_COMPARISON_TYPE comp, const struct shader_reg *dst,
265 const struct src_regs *srcs, int expectednsrcs);
268 struct instruction *alloc_instr(unsigned int srcs) DECLSPEC_HIDDEN;
269 BOOL add_instruction(struct bwriter_shader *shader, struct instruction *instr) DECLSPEC_HIDDEN;
270 BOOL add_constF(struct bwriter_shader *shader, DWORD reg, float x, float y, float z, float w) DECLSPEC_HIDDEN;
271 BOOL add_constI(struct bwriter_shader *shader, DWORD reg, INT x, INT y, INT z, INT w) DECLSPEC_HIDDEN;
272 BOOL add_constB(struct bwriter_shader *shader, DWORD reg, BOOL x) DECLSPEC_HIDDEN;
273 BOOL record_declaration(struct bwriter_shader *shader, DWORD usage, DWORD usage_idx,
274 DWORD mod, BOOL output, DWORD regnum, DWORD writemask, BOOL builtin) DECLSPEC_HIDDEN;
275 BOOL record_sampler(struct bwriter_shader *shader, DWORD samptype, DWORD mod, DWORD regnum) DECLSPEC_HIDDEN;
277 #define MESSAGEBUFFER_INITIAL_SIZE 256
280 /* The function table of the parser implementation */
281 const struct asmparser_backend *funcs;
283 /* Private data follows */
284 struct bwriter_shader *shader;
285 unsigned int m3x3pad_count;
293 unsigned int messagesize;
294 unsigned int messagecapacity;
295 unsigned int line_no;
298 extern struct asm_parser asm_ctx DECLSPEC_HIDDEN;
300 void create_vs10_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
301 void create_vs11_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
302 void create_vs20_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
303 void create_vs2x_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
304 void create_vs30_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
305 void create_ps10_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
306 void create_ps11_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
307 void create_ps12_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
308 void create_ps13_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
309 void create_ps14_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
310 void create_ps20_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
311 void create_ps2x_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
312 void create_ps30_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
314 struct bwriter_shader *parse_asm_shader(char **messages) DECLSPEC_HIDDEN;
317 #define PRINTF_ATTR(fmt,args) __attribute__((format (printf,fmt,args)))
319 #define PRINTF_ATTR(fmt,args)
322 void asmparser_message(struct asm_parser *ctx, const char *fmt, ...) PRINTF_ATTR(2,3) DECLSPEC_HIDDEN;
323 void set_parse_status(struct asm_parser *ctx, enum parse_status status) DECLSPEC_HIDDEN;
325 /* A reasonable value as initial size */
326 #define BYTECODEBUFFER_INITIAL_SIZE 32
327 struct bytecode_buffer {
331 /* For tracking rare out of memory situations without passing
332 * return values around everywhere
337 struct bc_writer; /* Predeclaration for use in vtable parameters */
339 typedef void (*instr_writer)(struct bc_writer *This,
340 const struct instruction *instr,
341 struct bytecode_buffer *buffer);
343 struct bytecode_backend {
344 void (*header)(struct bc_writer *This, const struct bwriter_shader *shader,
345 struct bytecode_buffer *buffer);
346 void (*end)(struct bc_writer *This, const struct bwriter_shader *shader,
347 struct bytecode_buffer *buffer);
348 void (*srcreg)(struct bc_writer *This, const struct shader_reg *reg,
349 struct bytecode_buffer *buffer);
350 void (*dstreg)(struct bc_writer *This, const struct shader_reg *reg,
351 struct bytecode_buffer *buffer, DWORD shift, DWORD mod);
352 void (*opcode)(struct bc_writer *This, const struct instruction *instr,
353 DWORD token, struct bytecode_buffer *buffer);
355 const struct instr_handler_table {
361 /* Bytecode writing stuff */
363 const struct bytecode_backend *funcs;
365 /* Avoid result checking */
370 /* Vertex shader varying mapping */
379 /* Pixel shader specific members */
384 /* Debug utility routines */
385 const char *debug_print_srcmod(DWORD mod) DECLSPEC_HIDDEN;
386 const char *debug_print_dstmod(DWORD mod) DECLSPEC_HIDDEN;
387 const char *debug_print_shift(DWORD shift) DECLSPEC_HIDDEN;
388 const char *debug_print_dstreg(const struct shader_reg *reg) DECLSPEC_HIDDEN;
389 const char *debug_print_srcreg(const struct shader_reg *reg) DECLSPEC_HIDDEN;
390 const char *debug_print_comp(DWORD comp) DECLSPEC_HIDDEN;
391 const char *debug_print_opcode(DWORD opcode) DECLSPEC_HIDDEN;
393 /* Used to signal an incorrect swizzle/writemask */
394 #define SWIZZLE_ERR ~0U
397 Enumerations and defines used in the bytecode writer
398 intermediate representation
400 typedef enum _BWRITERSHADER_INSTRUCTION_OPCODE_TYPE {
456 BWRITERSIO_TEXREG2AR,
457 BWRITERSIO_TEXREG2GB,
458 BWRITERSIO_TEXM3x2PAD,
459 BWRITERSIO_TEXM3x2TEX,
460 BWRITERSIO_TEXM3x3PAD,
461 BWRITERSIO_TEXM3x3TEX,
462 BWRITERSIO_TEXM3x3SPEC,
463 BWRITERSIO_TEXM3x3VSPEC,
468 BWRITERSIO_TEXREG2RGB,
469 BWRITERSIO_TEXDP3TEX,
470 BWRITERSIO_TEXM3x2DEPTH,
489 } BWRITERSHADER_INSTRUCTION_OPCODE_TYPE;
491 typedef enum _BWRITERSHADER_PARAM_REGISTER_TYPE {
499 BWRITERSPR_TEXCRDOUT,
505 BWRITERSPR_CONSTBOOL,
510 } BWRITERSHADER_PARAM_REGISTER_TYPE;
512 typedef enum _BWRITERVS_RASTOUT_OFFSETS
516 BWRITERSRO_POINT_SIZE
517 } BWRITERVS_RASTOUT_OFFSETS;
519 #define BWRITERSP_WRITEMASK_0 0x1 /* .x r */
520 #define BWRITERSP_WRITEMASK_1 0x2 /* .y g */
521 #define BWRITERSP_WRITEMASK_2 0x4 /* .z b */
522 #define BWRITERSP_WRITEMASK_3 0x8 /* .w a */
523 #define BWRITERSP_WRITEMASK_ALL 0xf /* all */
525 typedef enum _BWRITERSHADER_PARAM_DSTMOD_TYPE {
526 BWRITERSPDM_NONE = 0,
527 BWRITERSPDM_SATURATE = 1,
528 BWRITERSPDM_PARTIALPRECISION = 2,
529 BWRITERSPDM_MSAMPCENTROID = 4,
530 } BWRITERSHADER_PARAM_DSTMOD_TYPE;
532 typedef enum _BWRITERSAMPLER_TEXTURE_TYPE {
533 BWRITERSTT_UNKNOWN = 0,
537 BWRITERSTT_VOLUME = 4,
538 } BWRITERSAMPLER_TEXTURE_TYPE;
540 #define BWRITERSI_TEXLD_PROJECT 1
541 #define BWRITERSI_TEXLD_BIAS 2
543 typedef enum _BWRITERSHADER_PARAM_SRCMOD_TYPE {
544 BWRITERSPSM_NONE = 0,
558 } BWRITERSHADER_PARAM_SRCMOD_TYPE;
560 #define BWRITER_SM1_VS 0xfffe
561 #define BWRITER_SM1_PS 0xffff
563 #define BWRITERPS_VERSION(major, minor) ((BWRITER_SM1_PS << 16) | ((major) << 8) | (minor))
564 #define BWRITERVS_VERSION(major, minor) ((BWRITER_SM1_VS << 16) | ((major) << 8) | (minor))
566 #define BWRITERVS_SWIZZLE_SHIFT 16
567 #define BWRITERVS_SWIZZLE_MASK (0xFF << BWRITERVS_SWIZZLE_SHIFT)
569 #define BWRITERVS_X_X (0 << BWRITERVS_SWIZZLE_SHIFT)
570 #define BWRITERVS_X_Y (1 << BWRITERVS_SWIZZLE_SHIFT)
571 #define BWRITERVS_X_Z (2 << BWRITERVS_SWIZZLE_SHIFT)
572 #define BWRITERVS_X_W (3 << BWRITERVS_SWIZZLE_SHIFT)
574 #define BWRITERVS_Y_X (0 << (BWRITERVS_SWIZZLE_SHIFT + 2))
575 #define BWRITERVS_Y_Y (1 << (BWRITERVS_SWIZZLE_SHIFT + 2))
576 #define BWRITERVS_Y_Z (2 << (BWRITERVS_SWIZZLE_SHIFT + 2))
577 #define BWRITERVS_Y_W (3 << (BWRITERVS_SWIZZLE_SHIFT + 2))
579 #define BWRITERVS_Z_X (0 << (BWRITERVS_SWIZZLE_SHIFT + 4))
580 #define BWRITERVS_Z_Y (1 << (BWRITERVS_SWIZZLE_SHIFT + 4))
581 #define BWRITERVS_Z_Z (2 << (BWRITERVS_SWIZZLE_SHIFT + 4))
582 #define BWRITERVS_Z_W (3 << (BWRITERVS_SWIZZLE_SHIFT + 4))
584 #define BWRITERVS_W_X (0 << (BWRITERVS_SWIZZLE_SHIFT + 6))
585 #define BWRITERVS_W_Y (1 << (BWRITERVS_SWIZZLE_SHIFT + 6))
586 #define BWRITERVS_W_Z (2 << (BWRITERVS_SWIZZLE_SHIFT + 6))
587 #define BWRITERVS_W_W (3 << (BWRITERVS_SWIZZLE_SHIFT + 6))
589 #define BWRITERVS_NOSWIZZLE (BWRITERVS_X_X | BWRITERVS_Y_Y | BWRITERVS_Z_Z | BWRITERVS_W_W)
591 #define BWRITERVS_SWIZZLE_X (BWRITERVS_X_X | BWRITERVS_Y_X | BWRITERVS_Z_X | BWRITERVS_W_X)
592 #define BWRITERVS_SWIZZLE_Y (BWRITERVS_X_Y | BWRITERVS_Y_Y | BWRITERVS_Z_Y | BWRITERVS_W_Y)
593 #define BWRITERVS_SWIZZLE_Z (BWRITERVS_X_Z | BWRITERVS_Y_Z | BWRITERVS_Z_Z | BWRITERVS_W_Z)
594 #define BWRITERVS_SWIZZLE_W (BWRITERVS_X_W | BWRITERVS_Y_W | BWRITERVS_Z_W | BWRITERVS_W_W)
596 typedef enum _BWRITERDECLUSAGE {
597 BWRITERDECLUSAGE_POSITION,
598 BWRITERDECLUSAGE_BLENDWEIGHT,
599 BWRITERDECLUSAGE_BLENDINDICES,
600 BWRITERDECLUSAGE_NORMAL,
601 BWRITERDECLUSAGE_PSIZE,
602 BWRITERDECLUSAGE_TEXCOORD,
603 BWRITERDECLUSAGE_TANGENT,
604 BWRITERDECLUSAGE_BINORMAL,
605 BWRITERDECLUSAGE_TESSFACTOR,
606 BWRITERDECLUSAGE_POSITIONT,
607 BWRITERDECLUSAGE_COLOR,
608 BWRITERDECLUSAGE_FOG,
609 BWRITERDECLUSAGE_DEPTH,
610 BWRITERDECLUSAGE_SAMPLE
613 /* ps 1.x texture registers mappings */
619 struct bwriter_shader *SlAssembleShader(const char *text, char **messages) DECLSPEC_HIDDEN;
620 DWORD SlWriteBytecode(const struct bwriter_shader *shader, int dxversion, DWORD **result) DECLSPEC_HIDDEN;
621 void SlDeleteShader(struct bwriter_shader *shader) DECLSPEC_HIDDEN;
623 #define MAKE_TAG(ch0, ch1, ch2, ch3) \
624 ((DWORD)(ch0) | ((DWORD)(ch1) << 8) | \
625 ((DWORD)(ch2) << 16) | ((DWORD)(ch3) << 24 ))
626 #define TAG_Aon9 MAKE_TAG('A', 'o', 'n', '9')
627 #define TAG_DXBC MAKE_TAG('D', 'X', 'B', 'C')
628 #define TAG_ISGN MAKE_TAG('I', 'S', 'G', 'N')
629 #define TAG_OSGN MAKE_TAG('O', 'S', 'G', 'N')
630 #define TAG_OSG5 MAKE_TAG('O', 'S', 'G', '5')
631 #define TAG_PCSG MAKE_TAG('P', 'C', 'S', 'G')
632 #define TAG_RDEF MAKE_TAG('R', 'D', 'E', 'F')
633 #define TAG_SDBG MAKE_TAG('S', 'D', 'B', 'G')
634 #define TAG_SHDR MAKE_TAG('S', 'H', 'D', 'R')
635 #define TAG_SHEX MAKE_TAG('S', 'H', 'E', 'X')
636 #define TAG_STAT MAKE_TAG('S', 'T', 'A', 'T')
637 #define TAG_XNAP MAKE_TAG('X', 'N', 'A', 'P')
638 #define TAG_XNAS MAKE_TAG('X', 'N', 'A', 'S')
651 struct dxbc_section *sections;
654 HRESULT dxbc_write_blob(struct dxbc *dxbc, ID3DBlob **blob) DECLSPEC_HIDDEN;
655 void dxbc_destroy(struct dxbc *dxbc) DECLSPEC_HIDDEN;
656 HRESULT dxbc_parse(const char *data, SIZE_T data_size, struct dxbc *dxbc) DECLSPEC_HIDDEN;
657 HRESULT dxbc_add_section(struct dxbc *dxbc, DWORD tag, const char *data, DWORD data_size) DECLSPEC_HIDDEN;
658 HRESULT dxbc_init(struct dxbc *dxbc, DWORD count) DECLSPEC_HIDDEN;
660 static inline void read_dword(const char **ptr, DWORD *d)
662 memcpy(d, *ptr, sizeof(*d));
666 static inline void write_dword(char **ptr, DWORD d)
668 memcpy(*ptr, &d, sizeof(d));
672 void skip_dword_unknown(const char **ptr, unsigned int count) DECLSPEC_HIDDEN;
673 void write_dword_unknown(char **ptr, DWORD d) DECLSPEC_HIDDEN;
675 #endif /* __WINE_D3DCOMPILER_PRIVATE_H */