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 /* Shader assembler definitions */
61 typedef enum _shader_type {
66 typedef enum BWRITER_COMPARISON_TYPE {
67 BWRITER_COMPARISON_NONE,
68 BWRITER_COMPARISON_GT,
69 BWRITER_COMPARISON_EQ,
70 BWRITER_COMPARISON_GE,
71 BWRITER_COMPARISON_LT,
72 BWRITER_COMPARISON_NE,
74 } BWRITER_COMPARISON_TYPE;
89 struct shader_reg *rel_reg;
101 BWRITER_COMPARISON_TYPE comptype;
103 struct shader_reg dst;
104 struct shader_reg *src;
105 unsigned int num_srcs; /* For freeing the rel_regs */
107 struct shader_reg predicate;
112 DWORD usage, usage_idx;
125 #define INSTRARRAY_INITIAL_SIZE 8
126 struct bwriter_shader {
129 /* Shader version selected */
132 /* Local constants. Every constant that is not defined below is loaded from
133 * the global constant set at shader runtime
135 struct constant **constF;
136 struct constant **constI;
137 struct constant **constB;
138 unsigned int num_cf, num_ci, num_cb;
140 /* Declared input and output varyings */
141 struct declaration *inputs, *outputs;
142 unsigned int num_inputs, num_outputs;
143 struct samplerdecl *samplers;
144 unsigned int num_samplers;
146 /* Are special pixel shader 3.0 registers declared? */
149 /* Array of shader instructions - The shader code itself */
150 struct instruction **instr;
151 unsigned int num_instrs, instr_alloc_size;
154 static inline LPVOID asm_alloc(SIZE_T size) {
155 return HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, size);
158 static inline LPVOID asm_realloc(LPVOID ptr, SIZE_T size) {
159 return HeapReAlloc(GetProcessHeap(), 0, ptr, size);
162 static inline BOOL asm_free(LPVOID ptr) {
163 return HeapFree(GetProcessHeap(), 0, ptr);
168 /* This structure is only used in asmshader.y, but since the .l file accesses the semantic types
169 * too it has to know it as well
174 DWORD additional_offset;
179 #define MAX_SRC_REGS 4
182 struct shader_reg reg[MAX_SRC_REGS];
186 struct asmparser_backend {
187 void (*constF)(struct asm_parser *This, DWORD reg, float x, float y, float z, float w);
188 void (*constI)(struct asm_parser *This, DWORD reg, INT x, INT y, INT z, INT w);
189 void (*constB)(struct asm_parser *This, DWORD reg, BOOL x);
191 void (*dstreg)(struct asm_parser *This, struct instruction *instr,
192 const struct shader_reg *dst);
193 void (*srcreg)(struct asm_parser *This, struct instruction *instr, int num,
194 const struct shader_reg *src);
196 void (*predicate)(struct asm_parser *This,
197 const struct shader_reg *predicate);
198 void (*coissue)(struct asm_parser *This);
200 void (*dcl_output)(struct asm_parser *This, DWORD usage, DWORD num,
201 const struct shader_reg *reg);
202 void (*dcl_input)(struct asm_parser *This, DWORD usage, DWORD num,
203 DWORD mod, const struct shader_reg *reg);
204 void (*dcl_sampler)(struct asm_parser *This, DWORD samptype, DWORD mod,
205 DWORD regnum, unsigned int line_no);
207 void (*end)(struct asm_parser *This);
209 void (*instr)(struct asm_parser *This, DWORD opcode, DWORD mod, DWORD shift,
210 BWRITER_COMPARISON_TYPE comp, const struct shader_reg *dst,
211 const struct src_regs *srcs, int expectednsrcs);
214 struct instruction *alloc_instr(unsigned int srcs) DECLSPEC_HIDDEN;
215 BOOL add_instruction(struct bwriter_shader *shader, struct instruction *instr) DECLSPEC_HIDDEN;
216 BOOL add_constF(struct bwriter_shader *shader, DWORD reg, float x, float y, float z, float w) DECLSPEC_HIDDEN;
217 BOOL add_constI(struct bwriter_shader *shader, DWORD reg, INT x, INT y, INT z, INT w) DECLSPEC_HIDDEN;
218 BOOL add_constB(struct bwriter_shader *shader, DWORD reg, BOOL x) DECLSPEC_HIDDEN;
219 BOOL record_declaration(struct bwriter_shader *shader, DWORD usage, DWORD usage_idx,
220 DWORD mod, BOOL output, DWORD regnum, DWORD writemask, BOOL builtin) DECLSPEC_HIDDEN;
221 BOOL record_sampler(struct bwriter_shader *shader, DWORD samptype, DWORD mod, DWORD regnum) DECLSPEC_HIDDEN;
223 #define MESSAGEBUFFER_INITIAL_SIZE 256
226 /* The function table of the parser implementation */
227 const struct asmparser_backend *funcs;
229 /* Private data follows */
230 struct bwriter_shader *shader;
231 unsigned int m3x3pad_count;
239 unsigned int messagesize;
240 unsigned int messagecapacity;
241 unsigned int line_no;
244 extern struct asm_parser asm_ctx DECLSPEC_HIDDEN;
246 void create_vs10_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
247 void create_vs11_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
248 void create_vs20_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
249 void create_vs2x_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
250 void create_vs30_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
251 void create_ps10_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
252 void create_ps11_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
253 void create_ps12_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
254 void create_ps13_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
255 void create_ps14_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
256 void create_ps20_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
257 void create_ps2x_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
258 void create_ps30_parser(struct asm_parser *ret) DECLSPEC_HIDDEN;
260 struct bwriter_shader *parse_asm_shader(char **messages) DECLSPEC_HIDDEN;
263 #define PRINTF_ATTR(fmt,args) __attribute__((format (printf,fmt,args)))
265 #define PRINTF_ATTR(fmt,args)
268 void asmparser_message(struct asm_parser *ctx, const char *fmt, ...) PRINTF_ATTR(2,3) DECLSPEC_HIDDEN;
269 void set_parse_status(struct asm_parser *ctx, enum parse_status status) DECLSPEC_HIDDEN;
271 /* A reasonable value as initial size */
272 #define BYTECODEBUFFER_INITIAL_SIZE 32
273 struct bytecode_buffer {
277 /* For tracking rare out of memory situations without passing
278 * return values around everywhere
283 struct bc_writer; /* Predeclaration for use in vtable parameters */
285 typedef void (*instr_writer)(struct bc_writer *This,
286 const struct instruction *instr,
287 struct bytecode_buffer *buffer);
289 struct bytecode_backend {
290 void (*header)(struct bc_writer *This, const struct bwriter_shader *shader,
291 struct bytecode_buffer *buffer);
292 void (*end)(struct bc_writer *This, const struct bwriter_shader *shader,
293 struct bytecode_buffer *buffer);
294 void (*srcreg)(struct bc_writer *This, const struct shader_reg *reg,
295 struct bytecode_buffer *buffer);
296 void (*dstreg)(struct bc_writer *This, const struct shader_reg *reg,
297 struct bytecode_buffer *buffer, DWORD shift, DWORD mod);
298 void (*opcode)(struct bc_writer *This, const struct instruction *instr,
299 DWORD token, struct bytecode_buffer *buffer);
301 const struct instr_handler_table {
307 /* Bytecode writing stuff */
309 const struct bytecode_backend *funcs;
311 /* Avoid result checking */
316 /* Vertex shader varying mapping */
325 /* Pixel shader specific members */
330 /* Debug utility routines */
331 const char *debug_print_srcmod(DWORD mod) DECLSPEC_HIDDEN;
332 const char *debug_print_dstmod(DWORD mod) DECLSPEC_HIDDEN;
333 const char *debug_print_shift(DWORD shift) DECLSPEC_HIDDEN;
334 const char *debug_print_dstreg(const struct shader_reg *reg) DECLSPEC_HIDDEN;
335 const char *debug_print_srcreg(const struct shader_reg *reg) DECLSPEC_HIDDEN;
336 const char *debug_print_comp(DWORD comp) DECLSPEC_HIDDEN;
337 const char *debug_print_opcode(DWORD opcode) DECLSPEC_HIDDEN;
339 /* Used to signal an incorrect swizzle/writemask */
340 #define SWIZZLE_ERR ~0U
343 Enumerations and defines used in the bytecode writer
344 intermediate representation
346 typedef enum _BWRITERSHADER_INSTRUCTION_OPCODE_TYPE {
402 BWRITERSIO_TEXREG2AR,
403 BWRITERSIO_TEXREG2GB,
404 BWRITERSIO_TEXM3x2PAD,
405 BWRITERSIO_TEXM3x2TEX,
406 BWRITERSIO_TEXM3x3PAD,
407 BWRITERSIO_TEXM3x3TEX,
408 BWRITERSIO_TEXM3x3SPEC,
409 BWRITERSIO_TEXM3x3VSPEC,
414 BWRITERSIO_TEXREG2RGB,
415 BWRITERSIO_TEXDP3TEX,
416 BWRITERSIO_TEXM3x2DEPTH,
435 } BWRITERSHADER_INSTRUCTION_OPCODE_TYPE;
437 typedef enum _BWRITERSHADER_PARAM_REGISTER_TYPE {
445 BWRITERSPR_TEXCRDOUT,
451 BWRITERSPR_CONSTBOOL,
456 } BWRITERSHADER_PARAM_REGISTER_TYPE;
458 typedef enum _BWRITERVS_RASTOUT_OFFSETS
462 BWRITERSRO_POINT_SIZE
463 } BWRITERVS_RASTOUT_OFFSETS;
465 #define BWRITERSP_WRITEMASK_0 0x1 /* .x r */
466 #define BWRITERSP_WRITEMASK_1 0x2 /* .y g */
467 #define BWRITERSP_WRITEMASK_2 0x4 /* .z b */
468 #define BWRITERSP_WRITEMASK_3 0x8 /* .w a */
469 #define BWRITERSP_WRITEMASK_ALL 0xf /* all */
471 typedef enum _BWRITERSHADER_PARAM_DSTMOD_TYPE {
472 BWRITERSPDM_NONE = 0,
473 BWRITERSPDM_SATURATE = 1,
474 BWRITERSPDM_PARTIALPRECISION = 2,
475 BWRITERSPDM_MSAMPCENTROID = 4,
476 } BWRITERSHADER_PARAM_DSTMOD_TYPE;
478 typedef enum _BWRITERSAMPLER_TEXTURE_TYPE {
479 BWRITERSTT_UNKNOWN = 0,
483 BWRITERSTT_VOLUME = 4,
484 } BWRITERSAMPLER_TEXTURE_TYPE;
486 #define BWRITERSI_TEXLD_PROJECT 1
487 #define BWRITERSI_TEXLD_BIAS 2
489 typedef enum _BWRITERSHADER_PARAM_SRCMOD_TYPE {
490 BWRITERSPSM_NONE = 0,
504 } BWRITERSHADER_PARAM_SRCMOD_TYPE;
506 #define BWRITER_SM1_VS 0xfffe
507 #define BWRITER_SM1_PS 0xffff
509 #define BWRITERPS_VERSION(major, minor) ((BWRITER_SM1_PS << 16) | ((major) << 8) | (minor))
510 #define BWRITERVS_VERSION(major, minor) ((BWRITER_SM1_VS << 16) | ((major) << 8) | (minor))
512 #define BWRITERVS_SWIZZLE_SHIFT 16
513 #define BWRITERVS_SWIZZLE_MASK (0xFF << BWRITERVS_SWIZZLE_SHIFT)
515 #define BWRITERVS_X_X (0 << BWRITERVS_SWIZZLE_SHIFT)
516 #define BWRITERVS_X_Y (1 << BWRITERVS_SWIZZLE_SHIFT)
517 #define BWRITERVS_X_Z (2 << BWRITERVS_SWIZZLE_SHIFT)
518 #define BWRITERVS_X_W (3 << BWRITERVS_SWIZZLE_SHIFT)
520 #define BWRITERVS_Y_X (0 << (BWRITERVS_SWIZZLE_SHIFT + 2))
521 #define BWRITERVS_Y_Y (1 << (BWRITERVS_SWIZZLE_SHIFT + 2))
522 #define BWRITERVS_Y_Z (2 << (BWRITERVS_SWIZZLE_SHIFT + 2))
523 #define BWRITERVS_Y_W (3 << (BWRITERVS_SWIZZLE_SHIFT + 2))
525 #define BWRITERVS_Z_X (0 << (BWRITERVS_SWIZZLE_SHIFT + 4))
526 #define BWRITERVS_Z_Y (1 << (BWRITERVS_SWIZZLE_SHIFT + 4))
527 #define BWRITERVS_Z_Z (2 << (BWRITERVS_SWIZZLE_SHIFT + 4))
528 #define BWRITERVS_Z_W (3 << (BWRITERVS_SWIZZLE_SHIFT + 4))
530 #define BWRITERVS_W_X (0 << (BWRITERVS_SWIZZLE_SHIFT + 6))
531 #define BWRITERVS_W_Y (1 << (BWRITERVS_SWIZZLE_SHIFT + 6))
532 #define BWRITERVS_W_Z (2 << (BWRITERVS_SWIZZLE_SHIFT + 6))
533 #define BWRITERVS_W_W (3 << (BWRITERVS_SWIZZLE_SHIFT + 6))
535 #define BWRITERVS_NOSWIZZLE (BWRITERVS_X_X | BWRITERVS_Y_Y | BWRITERVS_Z_Z | BWRITERVS_W_W)
537 #define BWRITERVS_SWIZZLE_X (BWRITERVS_X_X | BWRITERVS_Y_X | BWRITERVS_Z_X | BWRITERVS_W_X)
538 #define BWRITERVS_SWIZZLE_Y (BWRITERVS_X_Y | BWRITERVS_Y_Y | BWRITERVS_Z_Y | BWRITERVS_W_Y)
539 #define BWRITERVS_SWIZZLE_Z (BWRITERVS_X_Z | BWRITERVS_Y_Z | BWRITERVS_Z_Z | BWRITERVS_W_Z)
540 #define BWRITERVS_SWIZZLE_W (BWRITERVS_X_W | BWRITERVS_Y_W | BWRITERVS_Z_W | BWRITERVS_W_W)
542 typedef enum _BWRITERDECLUSAGE {
543 BWRITERDECLUSAGE_POSITION,
544 BWRITERDECLUSAGE_BLENDWEIGHT,
545 BWRITERDECLUSAGE_BLENDINDICES,
546 BWRITERDECLUSAGE_NORMAL,
547 BWRITERDECLUSAGE_PSIZE,
548 BWRITERDECLUSAGE_TEXCOORD,
549 BWRITERDECLUSAGE_TANGENT,
550 BWRITERDECLUSAGE_BINORMAL,
551 BWRITERDECLUSAGE_TESSFACTOR,
552 BWRITERDECLUSAGE_POSITIONT,
553 BWRITERDECLUSAGE_COLOR,
554 BWRITERDECLUSAGE_FOG,
555 BWRITERDECLUSAGE_DEPTH,
556 BWRITERDECLUSAGE_SAMPLE
559 /* ps 1.x texture registers mappings */
565 struct bwriter_shader *SlAssembleShader(const char *text, char **messages) DECLSPEC_HIDDEN;
566 DWORD SlWriteBytecode(const struct bwriter_shader *shader, int dxversion, DWORD **result) DECLSPEC_HIDDEN;
567 void SlDeleteShader(struct bwriter_shader *shader) DECLSPEC_HIDDEN;
569 #define MAKE_TAG(ch0, ch1, ch2, ch3) \
570 ((DWORD)(ch0) | ((DWORD)(ch1) << 8) | \
571 ((DWORD)(ch2) << 16) | ((DWORD)(ch3) << 24 ))
572 #define TAG_Aon9 MAKE_TAG('A', 'o', 'n', '9')
573 #define TAG_DXBC MAKE_TAG('D', 'X', 'B', 'C')
574 #define TAG_ISGN MAKE_TAG('I', 'S', 'G', 'N')
575 #define TAG_OSGN MAKE_TAG('O', 'S', 'G', 'N')
576 #define TAG_PCSG MAKE_TAG('P', 'C', 'S', 'G')
577 #define TAG_RDEF MAKE_TAG('R', 'D', 'E', 'F')
578 #define TAG_SDBG MAKE_TAG('S', 'D', 'B', 'G')
579 #define TAG_STAT MAKE_TAG('S', 'T', 'A', 'T')
580 #define TAG_XNAP MAKE_TAG('X', 'N', 'A', 'P')
581 #define TAG_XNAS MAKE_TAG('X', 'N', 'A', 'S')
594 struct dxbc_section *sections;
597 HRESULT dxbc_write_blob(struct dxbc *dxbc, ID3DBlob **blob) DECLSPEC_HIDDEN;
598 void dxbc_destroy(struct dxbc *dxbc) DECLSPEC_HIDDEN;
599 HRESULT dxbc_parse(const char *data, SIZE_T data_size, struct dxbc *dxbc) DECLSPEC_HIDDEN;
600 HRESULT dxbc_add_section(struct dxbc *dxbc, DWORD tag, const char *data, DWORD data_size) DECLSPEC_HIDDEN;
601 HRESULT dxbc_init(struct dxbc *dxbc, DWORD count) DECLSPEC_HIDDEN;
603 static inline void read_dword(const char **ptr, DWORD *d)
605 memcpy(d, *ptr, sizeof(*d));
609 static inline void write_dword(char **ptr, DWORD d)
611 memcpy(*ptr, &d, sizeof(d));
615 void skip_dword_unknown(const char **ptr, unsigned int count) DECLSPEC_HIDDEN;
616 void write_dword_unknown(char **ptr, DWORD d) DECLSPEC_HIDDEN;
618 #endif /* __WINE_D3DCOMPILER_PRIVATE_H */