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 const struct ID3D10BlobVtbl *vtbl;
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 /* ID3D11ShaderReflection */
61 struct d3dcompiler_shader_reflection
63 const struct ID3D11ShaderReflectionVtbl *vtbl;
67 /* reflection handling */
68 HRESULT d3dcompiler_shader_reflection_init(struct d3dcompiler_shader_reflection *reflection, const void *data, SIZE_T data_size) DECLSPEC_HIDDEN;
70 /* Shader assembler definitions */
71 typedef enum _shader_type {
76 typedef enum BWRITER_COMPARISON_TYPE {
77 BWRITER_COMPARISON_NONE,
78 BWRITER_COMPARISON_GT,
79 BWRITER_COMPARISON_EQ,
80 BWRITER_COMPARISON_GE,
81 BWRITER_COMPARISON_LT,
82 BWRITER_COMPARISON_NE,
84 } BWRITER_COMPARISON_TYPE;
99 struct shader_reg *rel_reg;
111 BWRITER_COMPARISON_TYPE comptype;
113 struct shader_reg dst;
114 struct shader_reg *src;
115 unsigned int num_srcs; /* For freeing the rel_regs */
117 struct shader_reg predicate;
122 DWORD usage, usage_idx;
135 #define INSTRARRAY_INITIAL_SIZE 8
136 struct bwriter_shader {
139 /* Shader version selected */
142 /* Local constants. Every constant that is not defined below is loaded from
143 * the global constant set at shader runtime
145 struct constant **constF;
146 struct constant **constI;
147 struct constant **constB;
148 unsigned int num_cf, num_ci, num_cb;
150 /* Declared input and output varyings */
151 struct declaration *inputs, *outputs;
152 unsigned int num_inputs, num_outputs;
153 struct samplerdecl *samplers;
154 unsigned int num_samplers;
156 /* Are special pixel shader 3.0 registers declared? */
159 /* Array of shader instructions - The shader code itself */
160 struct instruction **instr;
161 unsigned int num_instrs, instr_alloc_size;
164 static inline LPVOID asm_alloc(SIZE_T size) {
165 return HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, size);
168 static inline LPVOID asm_realloc(LPVOID ptr, SIZE_T size) {
169 return HeapReAlloc(GetProcessHeap(), 0, ptr, size);
172 static inline BOOL asm_free(LPVOID ptr) {
173 return HeapFree(GetProcessHeap(), 0, ptr);
178 /* This structure is only used in asmshader.y, but since the .l file accesses the semantic types
179 * too it has to know it as well
184 DWORD additional_offset;
189 #define MAX_SRC_REGS 4
192 struct shader_reg reg[MAX_SRC_REGS];
196 struct asmparser_backend {
197 void (*constF)(struct asm_parser *This, DWORD reg, float x, float y, float z, float w);
198 void (*constI)(struct asm_parser *This, DWORD reg, INT x, INT y, INT z, INT w);
199 void (*constB)(struct asm_parser *This, DWORD reg, BOOL x);
201 void (*dstreg)(struct asm_parser *This, struct instruction *instr,
202 const struct shader_reg *dst);
203 void (*srcreg)(struct asm_parser *This, struct instruction *instr, int num,
204 const struct shader_reg *src);
206 void (*predicate)(struct asm_parser *This,
207 const struct shader_reg *predicate);
208 void (*coissue)(struct asm_parser *This);
210 void (*dcl_output)(struct asm_parser *This, DWORD usage, DWORD num,
211 const struct shader_reg *reg);
212 void (*dcl_input)(struct asm_parser *This, DWORD usage, DWORD num,
213 DWORD mod, const struct shader_reg *reg);
214 void (*dcl_sampler)(struct asm_parser *This, DWORD samptype, DWORD mod,
215 DWORD regnum, unsigned int line_no);
217 void (*end)(struct asm_parser *This);
219 void (*instr)(struct asm_parser *This, DWORD opcode, DWORD mod, DWORD shift,
220 BWRITER_COMPARISON_TYPE comp, const struct shader_reg *dst,
221 const struct src_regs *srcs, int expectednsrcs);
224 struct instruction *alloc_instr(unsigned int srcs) DECLSPEC_HIDDEN;
225 BOOL add_instruction(struct bwriter_shader *shader, struct instruction *instr) DECLSPEC_HIDDEN;
226 BOOL add_constF(struct bwriter_shader *shader, DWORD reg, float x, float y, float z, float w) DECLSPEC_HIDDEN;
227 BOOL add_constI(struct bwriter_shader *shader, DWORD reg, INT x, INT y, INT z, INT w) DECLSPEC_HIDDEN;
228 BOOL add_constB(struct bwriter_shader *shader, DWORD reg, BOOL x) DECLSPEC_HIDDEN;
229 BOOL record_declaration(struct bwriter_shader *shader, DWORD usage, DWORD usage_idx,
230 DWORD mod, BOOL output, DWORD regnum, DWORD writemask, BOOL builtin) DECLSPEC_HIDDEN;
231 BOOL record_sampler(struct bwriter_shader *shader, DWORD samptype, DWORD mod, DWORD regnum) DECLSPEC_HIDDEN;
233 #define MESSAGEBUFFER_INITIAL_SIZE 256
236 /* The function table of the parser implementation */
237 const struct asmparser_backend *funcs;
239 /* Private data follows */
240 struct bwriter_shader *shader;
241 unsigned int m3x3pad_count;
249 unsigned int messagesize;
250 unsigned int messagecapacity;
251 unsigned int line_no;
254 extern struct asm_parser asm_ctx DECLSPEC_HIDDEN;
256 void create_vs10_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
257 void create_vs11_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
258 void create_vs20_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
259 void create_vs2x_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
260 void create_vs30_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
261 void create_ps10_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
262 void create_ps11_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
263 void create_ps12_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
264 void create_ps13_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
265 void create_ps14_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
266 void create_ps20_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
267 void create_ps2x_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
268 void create_ps30_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
270 struct bwriter_shader *parse_asm_shader(char **messages) DECLSPEC_HIDDEN;
273 #define PRINTF_ATTR(fmt,args) __attribute__((format (printf,fmt,args)))
275 #define PRINTF_ATTR(fmt,args)
278 void asmparser_message(struct asm_parser *ctx, const char *fmt, ...) PRINTF_ATTR(2,3) DECLSPEC_HIDDEN;
279 void set_parse_status(struct asm_parser *ctx, enum parse_status status) DECLSPEC_HIDDEN;
281 /* A reasonable value as initial size */
282 #define BYTECODEBUFFER_INITIAL_SIZE 32
283 struct bytecode_buffer {
287 /* For tracking rare out of memory situations without passing
288 * return values around everywhere
293 struct bc_writer; /* Predeclaration for use in vtable parameters */
295 typedef void (*instr_writer)(struct bc_writer *This,
296 const struct instruction *instr,
297 struct bytecode_buffer *buffer);
299 struct bytecode_backend {
300 void (*header)(struct bc_writer *This, const struct bwriter_shader *shader,
301 struct bytecode_buffer *buffer);
302 void (*end)(struct bc_writer *This, const struct bwriter_shader *shader,
303 struct bytecode_buffer *buffer);
304 void (*srcreg)(struct bc_writer *This, const struct shader_reg *reg,
305 struct bytecode_buffer *buffer);
306 void (*dstreg)(struct bc_writer *This, const struct shader_reg *reg,
307 struct bytecode_buffer *buffer, DWORD shift, DWORD mod);
308 void (*opcode)(struct bc_writer *This, const struct instruction *instr,
309 DWORD token, struct bytecode_buffer *buffer);
311 const struct instr_handler_table {
317 /* Bytecode writing stuff */
319 const struct bytecode_backend *funcs;
321 /* Avoid result checking */
326 /* Vertex shader varying mapping */
335 /* Pixel shader specific members */
340 /* Debug utility routines */
341 const char *debug_print_srcmod(DWORD mod) DECLSPEC_HIDDEN;
342 const char *debug_print_dstmod(DWORD mod) DECLSPEC_HIDDEN;
343 const char *debug_print_shift(DWORD shift) DECLSPEC_HIDDEN;
344 const char *debug_print_dstreg(const struct shader_reg *reg) DECLSPEC_HIDDEN;
345 const char *debug_print_srcreg(const struct shader_reg *reg) DECLSPEC_HIDDEN;
346 const char *debug_print_comp(DWORD comp) DECLSPEC_HIDDEN;
347 const char *debug_print_opcode(DWORD opcode) DECLSPEC_HIDDEN;
349 /* Used to signal an incorrect swizzle/writemask */
350 #define SWIZZLE_ERR ~0U
353 Enumerations and defines used in the bytecode writer
354 intermediate representation
356 typedef enum _BWRITERSHADER_INSTRUCTION_OPCODE_TYPE {
412 BWRITERSIO_TEXREG2AR,
413 BWRITERSIO_TEXREG2GB,
414 BWRITERSIO_TEXM3x2PAD,
415 BWRITERSIO_TEXM3x2TEX,
416 BWRITERSIO_TEXM3x3PAD,
417 BWRITERSIO_TEXM3x3TEX,
418 BWRITERSIO_TEXM3x3SPEC,
419 BWRITERSIO_TEXM3x3VSPEC,
424 BWRITERSIO_TEXREG2RGB,
425 BWRITERSIO_TEXDP3TEX,
426 BWRITERSIO_TEXM3x2DEPTH,
445 } BWRITERSHADER_INSTRUCTION_OPCODE_TYPE;
447 typedef enum _BWRITERSHADER_PARAM_REGISTER_TYPE {
455 BWRITERSPR_TEXCRDOUT,
461 BWRITERSPR_CONSTBOOL,
466 } BWRITERSHADER_PARAM_REGISTER_TYPE;
468 typedef enum _BWRITERVS_RASTOUT_OFFSETS
472 BWRITERSRO_POINT_SIZE
473 } BWRITERVS_RASTOUT_OFFSETS;
475 #define BWRITERSP_WRITEMASK_0 0x1 /* .x r */
476 #define BWRITERSP_WRITEMASK_1 0x2 /* .y g */
477 #define BWRITERSP_WRITEMASK_2 0x4 /* .z b */
478 #define BWRITERSP_WRITEMASK_3 0x8 /* .w a */
479 #define BWRITERSP_WRITEMASK_ALL 0xf /* all */
481 typedef enum _BWRITERSHADER_PARAM_DSTMOD_TYPE {
482 BWRITERSPDM_NONE = 0,
483 BWRITERSPDM_SATURATE = 1,
484 BWRITERSPDM_PARTIALPRECISION = 2,
485 BWRITERSPDM_MSAMPCENTROID = 4,
486 } BWRITERSHADER_PARAM_DSTMOD_TYPE;
488 typedef enum _BWRITERSAMPLER_TEXTURE_TYPE {
489 BWRITERSTT_UNKNOWN = 0,
493 BWRITERSTT_VOLUME = 4,
494 } BWRITERSAMPLER_TEXTURE_TYPE;
496 #define BWRITERSI_TEXLD_PROJECT 1
497 #define BWRITERSI_TEXLD_BIAS 2
499 typedef enum _BWRITERSHADER_PARAM_SRCMOD_TYPE {
500 BWRITERSPSM_NONE = 0,
514 } BWRITERSHADER_PARAM_SRCMOD_TYPE;
516 #define BWRITER_SM1_VS 0xfffe
517 #define BWRITER_SM1_PS 0xffff
519 #define BWRITERPS_VERSION(major, minor) ((BWRITER_SM1_PS << 16) | ((major) << 8) | (minor))
520 #define BWRITERVS_VERSION(major, minor) ((BWRITER_SM1_VS << 16) | ((major) << 8) | (minor))
522 #define BWRITERVS_SWIZZLE_SHIFT 16
523 #define BWRITERVS_SWIZZLE_MASK (0xFF << BWRITERVS_SWIZZLE_SHIFT)
525 #define BWRITERVS_X_X (0 << BWRITERVS_SWIZZLE_SHIFT)
526 #define BWRITERVS_X_Y (1 << BWRITERVS_SWIZZLE_SHIFT)
527 #define BWRITERVS_X_Z (2 << BWRITERVS_SWIZZLE_SHIFT)
528 #define BWRITERVS_X_W (3 << BWRITERVS_SWIZZLE_SHIFT)
530 #define BWRITERVS_Y_X (0 << (BWRITERVS_SWIZZLE_SHIFT + 2))
531 #define BWRITERVS_Y_Y (1 << (BWRITERVS_SWIZZLE_SHIFT + 2))
532 #define BWRITERVS_Y_Z (2 << (BWRITERVS_SWIZZLE_SHIFT + 2))
533 #define BWRITERVS_Y_W (3 << (BWRITERVS_SWIZZLE_SHIFT + 2))
535 #define BWRITERVS_Z_X (0 << (BWRITERVS_SWIZZLE_SHIFT + 4))
536 #define BWRITERVS_Z_Y (1 << (BWRITERVS_SWIZZLE_SHIFT + 4))
537 #define BWRITERVS_Z_Z (2 << (BWRITERVS_SWIZZLE_SHIFT + 4))
538 #define BWRITERVS_Z_W (3 << (BWRITERVS_SWIZZLE_SHIFT + 4))
540 #define BWRITERVS_W_X (0 << (BWRITERVS_SWIZZLE_SHIFT + 6))
541 #define BWRITERVS_W_Y (1 << (BWRITERVS_SWIZZLE_SHIFT + 6))
542 #define BWRITERVS_W_Z (2 << (BWRITERVS_SWIZZLE_SHIFT + 6))
543 #define BWRITERVS_W_W (3 << (BWRITERVS_SWIZZLE_SHIFT + 6))
545 #define BWRITERVS_NOSWIZZLE (BWRITERVS_X_X | BWRITERVS_Y_Y | BWRITERVS_Z_Z | BWRITERVS_W_W)
547 #define BWRITERVS_SWIZZLE_X (BWRITERVS_X_X | BWRITERVS_Y_X | BWRITERVS_Z_X | BWRITERVS_W_X)
548 #define BWRITERVS_SWIZZLE_Y (BWRITERVS_X_Y | BWRITERVS_Y_Y | BWRITERVS_Z_Y | BWRITERVS_W_Y)
549 #define BWRITERVS_SWIZZLE_Z (BWRITERVS_X_Z | BWRITERVS_Y_Z | BWRITERVS_Z_Z | BWRITERVS_W_Z)
550 #define BWRITERVS_SWIZZLE_W (BWRITERVS_X_W | BWRITERVS_Y_W | BWRITERVS_Z_W | BWRITERVS_W_W)
552 typedef enum _BWRITERDECLUSAGE {
553 BWRITERDECLUSAGE_POSITION,
554 BWRITERDECLUSAGE_BLENDWEIGHT,
555 BWRITERDECLUSAGE_BLENDINDICES,
556 BWRITERDECLUSAGE_NORMAL,
557 BWRITERDECLUSAGE_PSIZE,
558 BWRITERDECLUSAGE_TEXCOORD,
559 BWRITERDECLUSAGE_TANGENT,
560 BWRITERDECLUSAGE_BINORMAL,
561 BWRITERDECLUSAGE_TESSFACTOR,
562 BWRITERDECLUSAGE_POSITIONT,
563 BWRITERDECLUSAGE_COLOR,
564 BWRITERDECLUSAGE_FOG,
565 BWRITERDECLUSAGE_DEPTH,
566 BWRITERDECLUSAGE_SAMPLE
569 /* ps 1.x texture registers mappings */
575 struct bwriter_shader *SlAssembleShader(const char *text, char **messages) DECLSPEC_HIDDEN;
576 DWORD SlWriteBytecode(const struct bwriter_shader *shader, int dxversion, DWORD **result) DECLSPEC_HIDDEN;
577 void SlDeleteShader(struct bwriter_shader *shader) DECLSPEC_HIDDEN;
579 #define MAKE_TAG(ch0, ch1, ch2, ch3) \
580 ((DWORD)(ch0) | ((DWORD)(ch1) << 8) | \
581 ((DWORD)(ch2) << 16) | ((DWORD)(ch3) << 24 ))
582 #define TAG_Aon9 MAKE_TAG('A', 'o', 'n', '9')
583 #define TAG_DXBC MAKE_TAG('D', 'X', 'B', 'C')
584 #define TAG_ISGN MAKE_TAG('I', 'S', 'G', 'N')
585 #define TAG_OSGN MAKE_TAG('O', 'S', 'G', 'N')
586 #define TAG_OSG5 MAKE_TAG('O', 'S', 'G', '5')
587 #define TAG_PCSG MAKE_TAG('P', 'C', 'S', 'G')
588 #define TAG_RDEF MAKE_TAG('R', 'D', 'E', 'F')
589 #define TAG_SDBG MAKE_TAG('S', 'D', 'B', 'G')
590 #define TAG_STAT MAKE_TAG('S', 'T', 'A', 'T')
591 #define TAG_XNAP MAKE_TAG('X', 'N', 'A', 'P')
592 #define TAG_XNAS MAKE_TAG('X', 'N', 'A', 'S')
605 struct dxbc_section *sections;
608 HRESULT dxbc_write_blob(struct dxbc *dxbc, ID3DBlob **blob) DECLSPEC_HIDDEN;
609 void dxbc_destroy(struct dxbc *dxbc) DECLSPEC_HIDDEN;
610 HRESULT dxbc_parse(const char *data, SIZE_T data_size, struct dxbc *dxbc) DECLSPEC_HIDDEN;
611 HRESULT dxbc_add_section(struct dxbc *dxbc, DWORD tag, const char *data, DWORD data_size) DECLSPEC_HIDDEN;
612 HRESULT dxbc_init(struct dxbc *dxbc, DWORD count) DECLSPEC_HIDDEN;
614 static inline void read_dword(const char **ptr, DWORD *d)
616 memcpy(d, *ptr, sizeof(*d));
620 static inline void write_dword(char **ptr, DWORD d)
622 memcpy(*ptr, &d, sizeof(d));
626 void skip_dword_unknown(const char **ptr, unsigned int count) DECLSPEC_HIDDEN;
627 void write_dword_unknown(char **ptr, DWORD d) DECLSPEC_HIDDEN;
629 #endif /* __WINE_D3DCOMPILER_PRIVATE_H */