2 * Copyright 2008 Stefan Dösinger
3 * Copyright 2009 Matteo Bruni
4 * Copyright 2010 Rico Schüller
5 * Copyright 2012 Matteo Bruni for CodeWeavers
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
22 #ifndef __WINE_D3DCOMPILER_PRIVATE_H
23 #define __WINE_D3DCOMPILER_PRIVATE_H
25 #include "wine/debug.h"
26 #include "wine/list.h"
27 #include "wine/rbtree.h"
34 #include "d3dcompiler.h"
37 * This doesn't belong here, but for some functions it is possible to return that value,
38 * see http://msdn.microsoft.com/en-us/library/bb205278%28v=VS.85%29.aspx
39 * The original definition is in D3DX10core.h.
41 #define D3DERR_INVALIDCALL 0x8876086c
43 /* TRACE helper functions */
44 const char *debug_d3dcompiler_d3d_blob_part(D3D_BLOB_PART part) DECLSPEC_HIDDEN;
45 const char *debug_d3dcompiler_shader_variable_class(D3D_SHADER_VARIABLE_CLASS c) DECLSPEC_HIDDEN;
46 const char *debug_d3dcompiler_shader_variable_type(D3D_SHADER_VARIABLE_TYPE t) DECLSPEC_HIDDEN;
54 typedef enum BWRITER_COMPARISON_TYPE {
55 BWRITER_COMPARISON_NONE,
56 BWRITER_COMPARISON_GT,
57 BWRITER_COMPARISON_EQ,
58 BWRITER_COMPARISON_GE,
59 BWRITER_COMPARISON_LT,
60 BWRITER_COMPARISON_NE,
62 } BWRITER_COMPARISON_TYPE;
77 struct shader_reg *rel_reg;
89 BWRITER_COMPARISON_TYPE comptype;
91 struct shader_reg dst;
92 struct shader_reg *src;
93 unsigned int num_srcs; /* For freeing the rel_regs */
95 struct shader_reg predicate;
100 DWORD usage, usage_idx;
113 #define INSTRARRAY_INITIAL_SIZE 8
114 struct bwriter_shader {
115 enum shader_type type;
117 /* Shader version selected */
120 /* Local constants. Every constant that is not defined below is loaded from
121 * the global constant set at shader runtime
123 struct constant **constF;
124 struct constant **constI;
125 struct constant **constB;
126 unsigned int num_cf, num_ci, num_cb;
128 /* Declared input and output varyings */
129 struct declaration *inputs, *outputs;
130 unsigned int num_inputs, num_outputs;
131 struct samplerdecl *samplers;
132 unsigned int num_samplers;
134 /* Are special pixel shader 3.0 registers declared? */
137 /* Array of shader instructions - The shader code itself */
138 struct instruction **instr;
139 unsigned int num_instrs, instr_alloc_size;
142 static inline void *d3dcompiler_alloc(SIZE_T size)
144 return HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, size);
147 static inline void *d3dcompiler_realloc(void *ptr, SIZE_T size)
149 return HeapReAlloc(GetProcessHeap(), 0, ptr, size);
152 static inline BOOL d3dcompiler_free(void *ptr)
154 return HeapFree(GetProcessHeap(), 0, ptr);
157 static inline char *d3dcompiler_strdup(const char *string)
165 len = strlen(string);
166 copy = d3dcompiler_alloc(len + 1);
168 memcpy(copy, string, len + 1);
174 /* This structure is only used in asmshader.y, but since the .l file accesses the semantic types
175 * too it has to know it as well
180 DWORD additional_offset;
185 #define MAX_SRC_REGS 4
188 struct shader_reg reg[MAX_SRC_REGS];
192 struct asmparser_backend {
193 void (*constF)(struct asm_parser *This, DWORD reg, float x, float y, float z, float w);
194 void (*constI)(struct asm_parser *This, DWORD reg, INT x, INT y, INT z, INT w);
195 void (*constB)(struct asm_parser *This, DWORD reg, BOOL x);
197 void (*dstreg)(struct asm_parser *This, struct instruction *instr,
198 const struct shader_reg *dst);
199 void (*srcreg)(struct asm_parser *This, struct instruction *instr, int num,
200 const struct shader_reg *src);
202 void (*predicate)(struct asm_parser *This,
203 const struct shader_reg *predicate);
204 void (*coissue)(struct asm_parser *This);
206 void (*dcl_output)(struct asm_parser *This, DWORD usage, DWORD num,
207 const struct shader_reg *reg);
208 void (*dcl_input)(struct asm_parser *This, DWORD usage, DWORD num,
209 DWORD mod, const struct shader_reg *reg);
210 void (*dcl_sampler)(struct asm_parser *This, DWORD samptype, DWORD mod,
211 DWORD regnum, unsigned int line_no);
213 void (*end)(struct asm_parser *This);
215 void (*instr)(struct asm_parser *This, DWORD opcode, DWORD mod, DWORD shift,
216 BWRITER_COMPARISON_TYPE comp, const struct shader_reg *dst,
217 const struct src_regs *srcs, int expectednsrcs);
220 struct instruction *alloc_instr(unsigned int srcs) DECLSPEC_HIDDEN;
221 BOOL add_instruction(struct bwriter_shader *shader, struct instruction *instr) DECLSPEC_HIDDEN;
222 BOOL add_constF(struct bwriter_shader *shader, DWORD reg, float x, float y, float z, float w) DECLSPEC_HIDDEN;
223 BOOL add_constI(struct bwriter_shader *shader, DWORD reg, INT x, INT y, INT z, INT w) DECLSPEC_HIDDEN;
224 BOOL add_constB(struct bwriter_shader *shader, DWORD reg, BOOL x) DECLSPEC_HIDDEN;
225 BOOL record_declaration(struct bwriter_shader *shader, DWORD usage, DWORD usage_idx,
226 DWORD mod, BOOL output, DWORD regnum, DWORD writemask, BOOL builtin) DECLSPEC_HIDDEN;
227 BOOL record_sampler(struct bwriter_shader *shader, DWORD samptype, DWORD mod, DWORD regnum) DECLSPEC_HIDDEN;
229 #define MESSAGEBUFFER_INITIAL_SIZE 256
238 struct compilation_messages
242 unsigned int capacity;
247 /* The function table of the parser implementation */
248 const struct asmparser_backend *funcs;
250 /* Private data follows */
251 struct bwriter_shader *shader;
252 unsigned int m3x3pad_count;
254 enum parse_status status;
255 struct compilation_messages messages;
256 unsigned int line_no;
259 extern struct asm_parser asm_ctx DECLSPEC_HIDDEN;
261 void create_vs10_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
262 void create_vs11_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
263 void create_vs20_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
264 void create_vs2x_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
265 void create_vs30_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
266 void create_ps10_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
267 void create_ps11_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
268 void create_ps12_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
269 void create_ps13_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
270 void create_ps14_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
271 void create_ps20_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
272 void create_ps2x_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
273 void create_ps30_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
275 struct bwriter_shader *parse_asm_shader(char **messages) DECLSPEC_HIDDEN;
278 #define PRINTF_ATTR(fmt,args) __attribute__((format (printf,fmt,args)))
280 #define PRINTF_ATTR(fmt,args)
283 void compilation_message(struct compilation_messages *msg, const char *fmt, va_list args) DECLSPEC_HIDDEN;
284 void asmparser_message(struct asm_parser *ctx, const char *fmt, ...) PRINTF_ATTR(2,3) DECLSPEC_HIDDEN;
285 static inline void set_parse_status(enum parse_status *current, enum parse_status update)
287 if (update == PARSE_ERR)
288 *current = PARSE_ERR;
289 else if (update == PARSE_WARN && *current == PARSE_SUCCESS)
290 *current = PARSE_WARN;
293 /* A reasonable value as initial size */
294 #define BYTECODEBUFFER_INITIAL_SIZE 32
295 struct bytecode_buffer {
299 /* For tracking rare out of memory situations without passing
300 * return values around everywhere
305 struct bc_writer; /* Predeclaration for use in vtable parameters */
307 typedef void (*instr_writer)(struct bc_writer *This,
308 const struct instruction *instr,
309 struct bytecode_buffer *buffer);
311 struct bytecode_backend {
312 void (*header)(struct bc_writer *This, const struct bwriter_shader *shader,
313 struct bytecode_buffer *buffer);
314 void (*end)(struct bc_writer *This, const struct bwriter_shader *shader,
315 struct bytecode_buffer *buffer);
316 void (*srcreg)(struct bc_writer *This, const struct shader_reg *reg,
317 struct bytecode_buffer *buffer);
318 void (*dstreg)(struct bc_writer *This, const struct shader_reg *reg,
319 struct bytecode_buffer *buffer, DWORD shift, DWORD mod);
320 void (*opcode)(struct bc_writer *This, const struct instruction *instr,
321 DWORD token, struct bytecode_buffer *buffer);
323 const struct instr_handler_table {
329 /* Bytecode writing stuff */
331 const struct bytecode_backend *funcs;
333 /* Avoid result checking */
338 /* Vertex shader varying mapping */
347 /* Pixel shader specific members */
352 /* Debug utility routines */
353 const char *debug_print_srcmod(DWORD mod) DECLSPEC_HIDDEN;
354 const char *debug_print_dstmod(DWORD mod) DECLSPEC_HIDDEN;
355 const char *debug_print_shift(DWORD shift) DECLSPEC_HIDDEN;
356 const char *debug_print_dstreg(const struct shader_reg *reg) DECLSPEC_HIDDEN;
357 const char *debug_print_srcreg(const struct shader_reg *reg) DECLSPEC_HIDDEN;
358 const char *debug_print_comp(DWORD comp) DECLSPEC_HIDDEN;
359 const char *debug_print_opcode(DWORD opcode) DECLSPEC_HIDDEN;
361 /* Used to signal an incorrect swizzle/writemask */
362 #define SWIZZLE_ERR ~0U
365 Enumerations and defines used in the bytecode writer
366 intermediate representation
368 typedef enum _BWRITERSHADER_INSTRUCTION_OPCODE_TYPE {
424 BWRITERSIO_TEXREG2AR,
425 BWRITERSIO_TEXREG2GB,
426 BWRITERSIO_TEXM3x2PAD,
427 BWRITERSIO_TEXM3x2TEX,
428 BWRITERSIO_TEXM3x3PAD,
429 BWRITERSIO_TEXM3x3TEX,
430 BWRITERSIO_TEXM3x3SPEC,
431 BWRITERSIO_TEXM3x3VSPEC,
436 BWRITERSIO_TEXREG2RGB,
437 BWRITERSIO_TEXDP3TEX,
438 BWRITERSIO_TEXM3x2DEPTH,
457 } BWRITERSHADER_INSTRUCTION_OPCODE_TYPE;
459 typedef enum _BWRITERSHADER_PARAM_REGISTER_TYPE {
467 BWRITERSPR_TEXCRDOUT,
473 BWRITERSPR_CONSTBOOL,
478 } BWRITERSHADER_PARAM_REGISTER_TYPE;
480 typedef enum _BWRITERVS_RASTOUT_OFFSETS
484 BWRITERSRO_POINT_SIZE
485 } BWRITERVS_RASTOUT_OFFSETS;
487 #define BWRITERSP_WRITEMASK_0 0x1 /* .x r */
488 #define BWRITERSP_WRITEMASK_1 0x2 /* .y g */
489 #define BWRITERSP_WRITEMASK_2 0x4 /* .z b */
490 #define BWRITERSP_WRITEMASK_3 0x8 /* .w a */
491 #define BWRITERSP_WRITEMASK_ALL 0xf /* all */
493 typedef enum _BWRITERSHADER_PARAM_DSTMOD_TYPE {
494 BWRITERSPDM_NONE = 0,
495 BWRITERSPDM_SATURATE = 1,
496 BWRITERSPDM_PARTIALPRECISION = 2,
497 BWRITERSPDM_MSAMPCENTROID = 4,
498 } BWRITERSHADER_PARAM_DSTMOD_TYPE;
500 typedef enum _BWRITERSAMPLER_TEXTURE_TYPE {
501 BWRITERSTT_UNKNOWN = 0,
505 BWRITERSTT_VOLUME = 4,
506 } BWRITERSAMPLER_TEXTURE_TYPE;
508 #define BWRITERSI_TEXLD_PROJECT 1
509 #define BWRITERSI_TEXLD_BIAS 2
511 typedef enum _BWRITERSHADER_PARAM_SRCMOD_TYPE {
512 BWRITERSPSM_NONE = 0,
526 } BWRITERSHADER_PARAM_SRCMOD_TYPE;
528 #define BWRITER_SM1_VS 0xfffe
529 #define BWRITER_SM1_PS 0xffff
531 #define BWRITERPS_VERSION(major, minor) ((BWRITER_SM1_PS << 16) | ((major) << 8) | (minor))
532 #define BWRITERVS_VERSION(major, minor) ((BWRITER_SM1_VS << 16) | ((major) << 8) | (minor))
534 #define BWRITERVS_SWIZZLE_SHIFT 16
535 #define BWRITERVS_SWIZZLE_MASK (0xFF << BWRITERVS_SWIZZLE_SHIFT)
537 #define BWRITERVS_X_X (0 << BWRITERVS_SWIZZLE_SHIFT)
538 #define BWRITERVS_X_Y (1 << BWRITERVS_SWIZZLE_SHIFT)
539 #define BWRITERVS_X_Z (2 << BWRITERVS_SWIZZLE_SHIFT)
540 #define BWRITERVS_X_W (3 << BWRITERVS_SWIZZLE_SHIFT)
542 #define BWRITERVS_Y_X (0 << (BWRITERVS_SWIZZLE_SHIFT + 2))
543 #define BWRITERVS_Y_Y (1 << (BWRITERVS_SWIZZLE_SHIFT + 2))
544 #define BWRITERVS_Y_Z (2 << (BWRITERVS_SWIZZLE_SHIFT + 2))
545 #define BWRITERVS_Y_W (3 << (BWRITERVS_SWIZZLE_SHIFT + 2))
547 #define BWRITERVS_Z_X (0 << (BWRITERVS_SWIZZLE_SHIFT + 4))
548 #define BWRITERVS_Z_Y (1 << (BWRITERVS_SWIZZLE_SHIFT + 4))
549 #define BWRITERVS_Z_Z (2 << (BWRITERVS_SWIZZLE_SHIFT + 4))
550 #define BWRITERVS_Z_W (3 << (BWRITERVS_SWIZZLE_SHIFT + 4))
552 #define BWRITERVS_W_X (0 << (BWRITERVS_SWIZZLE_SHIFT + 6))
553 #define BWRITERVS_W_Y (1 << (BWRITERVS_SWIZZLE_SHIFT + 6))
554 #define BWRITERVS_W_Z (2 << (BWRITERVS_SWIZZLE_SHIFT + 6))
555 #define BWRITERVS_W_W (3 << (BWRITERVS_SWIZZLE_SHIFT + 6))
557 #define BWRITERVS_NOSWIZZLE (BWRITERVS_X_X | BWRITERVS_Y_Y | BWRITERVS_Z_Z | BWRITERVS_W_W)
559 #define BWRITERVS_SWIZZLE_X (BWRITERVS_X_X | BWRITERVS_Y_X | BWRITERVS_Z_X | BWRITERVS_W_X)
560 #define BWRITERVS_SWIZZLE_Y (BWRITERVS_X_Y | BWRITERVS_Y_Y | BWRITERVS_Z_Y | BWRITERVS_W_Y)
561 #define BWRITERVS_SWIZZLE_Z (BWRITERVS_X_Z | BWRITERVS_Y_Z | BWRITERVS_Z_Z | BWRITERVS_W_Z)
562 #define BWRITERVS_SWIZZLE_W (BWRITERVS_X_W | BWRITERVS_Y_W | BWRITERVS_Z_W | BWRITERVS_W_W)
564 typedef enum _BWRITERDECLUSAGE {
565 BWRITERDECLUSAGE_POSITION,
566 BWRITERDECLUSAGE_BLENDWEIGHT,
567 BWRITERDECLUSAGE_BLENDINDICES,
568 BWRITERDECLUSAGE_NORMAL,
569 BWRITERDECLUSAGE_PSIZE,
570 BWRITERDECLUSAGE_TEXCOORD,
571 BWRITERDECLUSAGE_TANGENT,
572 BWRITERDECLUSAGE_BINORMAL,
573 BWRITERDECLUSAGE_TESSFACTOR,
574 BWRITERDECLUSAGE_POSITIONT,
575 BWRITERDECLUSAGE_COLOR,
576 BWRITERDECLUSAGE_FOG,
577 BWRITERDECLUSAGE_DEPTH,
578 BWRITERDECLUSAGE_SAMPLE
581 /* ps 1.x texture registers mappings */
587 struct bwriter_shader *SlAssembleShader(const char *text, char **messages) DECLSPEC_HIDDEN;
588 HRESULT SlWriteBytecode(const struct bwriter_shader *shader, int dxversion, DWORD **result, DWORD *size) DECLSPEC_HIDDEN;
589 void SlDeleteShader(struct bwriter_shader *shader) DECLSPEC_HIDDEN;
591 enum hlsl_matrix_majority
597 struct hlsl_parse_ctx
600 unsigned int line_no;
601 enum parse_status status;
602 struct compilation_messages messages;
604 struct hlsl_scope *cur_scope;
605 struct hlsl_scope *globals;
609 struct list functions;
611 enum hlsl_matrix_majority matrix_majority;
614 extern struct hlsl_parse_ctx hlsl_ctx DECLSPEC_HIDDEN;
616 void hlsl_message(const char *fmt, ...) PRINTF_ATTR(1,2) DECLSPEC_HIDDEN;
617 struct bwriter_shader *parse_hlsl_shader(const char *text, enum shader_type type, DWORD version,
618 const char *entrypoint, char **messages) DECLSPEC_HIDDEN;
620 #define MAKE_TAG(ch0, ch1, ch2, ch3) \
621 ((DWORD)(ch0) | ((DWORD)(ch1) << 8) | \
622 ((DWORD)(ch2) << 16) | ((DWORD)(ch3) << 24 ))
623 #define TAG_Aon9 MAKE_TAG('A', 'o', 'n', '9')
624 #define TAG_DXBC MAKE_TAG('D', 'X', 'B', 'C')
625 #define TAG_ISGN MAKE_TAG('I', 'S', 'G', 'N')
626 #define TAG_OSGN MAKE_TAG('O', 'S', 'G', 'N')
627 #define TAG_OSG5 MAKE_TAG('O', 'S', 'G', '5')
628 #define TAG_PCSG MAKE_TAG('P', 'C', 'S', 'G')
629 #define TAG_RDEF MAKE_TAG('R', 'D', 'E', 'F')
630 #define TAG_SDBG MAKE_TAG('S', 'D', 'B', 'G')
631 #define TAG_SHDR MAKE_TAG('S', 'H', 'D', 'R')
632 #define TAG_SHEX MAKE_TAG('S', 'H', 'E', 'X')
633 #define TAG_STAT MAKE_TAG('S', 'T', 'A', 'T')
634 #define TAG_XNAP MAKE_TAG('X', 'N', 'A', 'P')
635 #define TAG_XNAS MAKE_TAG('X', 'N', 'A', 'S')
648 struct dxbc_section *sections;
651 HRESULT dxbc_write_blob(struct dxbc *dxbc, ID3DBlob **blob) DECLSPEC_HIDDEN;
652 void dxbc_destroy(struct dxbc *dxbc) DECLSPEC_HIDDEN;
653 HRESULT dxbc_parse(const char *data, SIZE_T data_size, struct dxbc *dxbc) DECLSPEC_HIDDEN;
654 HRESULT dxbc_add_section(struct dxbc *dxbc, DWORD tag, const char *data, DWORD data_size) DECLSPEC_HIDDEN;
655 HRESULT dxbc_init(struct dxbc *dxbc, DWORD count) DECLSPEC_HIDDEN;
657 static inline void read_dword(const char **ptr, DWORD *d)
659 memcpy(d, *ptr, sizeof(*d));
663 static inline void write_dword(char **ptr, DWORD d)
665 memcpy(*ptr, &d, sizeof(d));
669 void skip_dword_unknown(const char **ptr, unsigned int count) DECLSPEC_HIDDEN;
671 #endif /* __WINE_D3DCOMPILER_PRIVATE_H */