582cc9c17960da259c6f0a2a837b3d65a9e2cfc4
[x262.git] / common / x86 / x86inc.asm
1 ;*****************************************************************************
2 ;* x86inc.asm: x264asm abstraction layer
3 ;*****************************************************************************
4 ;* Copyright (C) 2005-2012 x264 project
5 ;*
6 ;* Authors: Loren Merritt <lorenm@u.washington.edu>
7 ;*          Anton Mitrofanov <BugMaster@narod.ru>
8 ;*          Jason Garrett-Glaser <darkshikari@gmail.com>
9 ;*          Henrik Gramner <hengar-6@student.ltu.se>
10 ;*
11 ;* Permission to use, copy, modify, and/or distribute this software for any
12 ;* purpose with or without fee is hereby granted, provided that the above
13 ;* copyright notice and this permission notice appear in all copies.
14 ;*
15 ;* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
16 ;* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
17 ;* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
18 ;* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
19 ;* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
20 ;* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
21 ;* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
22 ;*****************************************************************************
23
24 ; This is a header file for the x264ASM assembly language, which uses
25 ; NASM/YASM syntax combined with a large number of macros to provide easy
26 ; abstraction between different calling conventions (x86_32, win64, linux64).
27 ; It also has various other useful features to simplify writing the kind of
28 ; DSP functions that are most often used in x264.
29
30 ; Unlike the rest of x264, this file is available under an ISC license, as it
31 ; has significant usefulness outside of x264 and we want it to be available
32 ; to the largest audience possible.  Of course, if you modify it for your own
33 ; purposes to add a new feature, we strongly encourage contributing a patch
34 ; as this feature might be useful for others as well.  Send patches or ideas
35 ; to x264-devel@videolan.org .
36
37 %define program_name x264
38
39 %define WIN64  0
40 %define UNIX64 0
41 %if ARCH_X86_64
42     %ifidn __OUTPUT_FORMAT__,win32
43         %define WIN64  1
44     %elifidn __OUTPUT_FORMAT__,win64
45         %define WIN64  1
46     %else
47         %define UNIX64 1
48     %endif
49 %endif
50
51 %ifdef PREFIX
52     %define mangle(x) _ %+ x
53 %else
54     %define mangle(x) x
55 %endif
56
57 ; Name of the .rodata section.
58 ; Kludge: Something on OS X fails to align .rodata even given an align attribute,
59 ; so use a different read-only section.
60 %macro SECTION_RODATA 0-1 16
61     %ifidn __OUTPUT_FORMAT__,macho64
62         SECTION .text align=%1
63     %elifidn __OUTPUT_FORMAT__,macho
64         SECTION .text align=%1
65         fakegot:
66     %elifidn __OUTPUT_FORMAT__,aout
67         section .text
68     %else
69         SECTION .rodata align=%1
70     %endif
71 %endmacro
72
73 ; aout does not support align=
74 %macro SECTION_TEXT 0-1 16
75     %ifidn __OUTPUT_FORMAT__,aout
76         SECTION .text
77     %else
78         SECTION .text align=%1
79     %endif
80 %endmacro
81
82 %if WIN64
83     %define PIC
84 %elif ARCH_X86_64 == 0
85 ; x86_32 doesn't require PIC.
86 ; Some distros prefer shared objects to be PIC, but nothing breaks if
87 ; the code contains a few textrels, so we'll skip that complexity.
88     %undef PIC
89 %endif
90 %ifdef PIC
91     default rel
92 %endif
93
94 ; Always use long nops (reduces 0x90 spam in disassembly on x86_32)
95 CPU amdnop
96
97 ; Macros to eliminate most code duplication between x86_32 and x86_64:
98 ; Currently this works only for leaf functions which load all their arguments
99 ; into registers at the start, and make no other use of the stack. Luckily that
100 ; covers most of x264's asm.
101
102 ; PROLOGUE:
103 ; %1 = number of arguments. loads them from stack if needed.
104 ; %2 = number of registers used. pushes callee-saved regs if needed.
105 ; %3 = number of xmm registers used. pushes callee-saved xmm regs if needed.
106 ; %4 = list of names to define to registers
107 ; PROLOGUE can also be invoked by adding the same options to cglobal
108
109 ; e.g.
110 ; cglobal foo, 2,3,0, dst, src, tmp
111 ; declares a function (foo), taking two args (dst and src) and one local variable (tmp)
112
113 ; TODO Some functions can use some args directly from the stack. If they're the
114 ; last args then you can just not declare them, but if they're in the middle
115 ; we need more flexible macro.
116
117 ; RET:
118 ; Pops anything that was pushed by PROLOGUE, and returns.
119
120 ; REP_RET:
121 ; Same, but if it doesn't pop anything it becomes a 2-byte ret, for athlons
122 ; which are slow when a normal ret follows a branch.
123
124 ; registers:
125 ; rN and rNq are the native-size register holding function argument N
126 ; rNd, rNw, rNb are dword, word, and byte size
127 ; rNh is the high 8 bits of the word size
128 ; rNm is the original location of arg N (a register or on the stack), dword
129 ; rNmp is native size
130
131 %macro DECLARE_REG 2-3
132     %define r%1q %2
133     %define r%1d %2d
134     %define r%1w %2w
135     %define r%1b %2b
136     %define r%1h %2h
137     %if %0 == 2
138         %define r%1m  %2d
139         %define r%1mp %2
140     %elif ARCH_X86_64 ; memory
141         %define r%1m [rsp + stack_offset + %3]
142         %define r%1mp qword r %+ %1m
143     %else
144         %define r%1m [esp + stack_offset + %3]
145         %define r%1mp dword r %+ %1m
146     %endif
147     %define r%1  %2
148 %endmacro
149
150 %macro DECLARE_REG_SIZE 3
151     %define r%1q r%1
152     %define e%1q r%1
153     %define r%1d e%1
154     %define e%1d e%1
155     %define r%1w %1
156     %define e%1w %1
157     %define r%1h %3
158     %define e%1h %3
159     %define r%1b %2
160     %define e%1b %2
161 %if ARCH_X86_64 == 0
162     %define r%1  e%1
163 %endif
164 %endmacro
165
166 DECLARE_REG_SIZE ax, al, ah
167 DECLARE_REG_SIZE bx, bl, bh
168 DECLARE_REG_SIZE cx, cl, ch
169 DECLARE_REG_SIZE dx, dl, dh
170 DECLARE_REG_SIZE si, sil, null
171 DECLARE_REG_SIZE di, dil, null
172 DECLARE_REG_SIZE bp, bpl, null
173
174 ; t# defines for when per-arch register allocation is more complex than just function arguments
175
176 %macro DECLARE_REG_TMP 1-*
177     %assign %%i 0
178     %rep %0
179         CAT_XDEFINE t, %%i, r%1
180         %assign %%i %%i+1
181         %rotate 1
182     %endrep
183 %endmacro
184
185 %macro DECLARE_REG_TMP_SIZE 0-*
186     %rep %0
187         %define t%1q t%1 %+ q
188         %define t%1d t%1 %+ d
189         %define t%1w t%1 %+ w
190         %define t%1h t%1 %+ h
191         %define t%1b t%1 %+ b
192         %rotate 1
193     %endrep
194 %endmacro
195
196 DECLARE_REG_TMP_SIZE 0,1,2,3,4,5,6,7,8,9,10,11,12,13,14
197
198 %if ARCH_X86_64
199     %define gprsize 8
200 %else
201     %define gprsize 4
202 %endif
203
204 %macro PUSH 1
205     push %1
206     %assign stack_offset stack_offset+gprsize
207 %endmacro
208
209 %macro POP 1
210     pop %1
211     %assign stack_offset stack_offset-gprsize
212 %endmacro
213
214 %macro PUSH_IF_USED 1-*
215     %rep %0
216         %if %1 < regs_used
217             PUSH r%1
218         %endif
219         %rotate 1
220     %endrep
221 %endmacro
222
223 %macro POP_IF_USED 1-*
224     %rep %0
225         %if %1 < regs_used
226             pop r%1
227         %endif
228         %rotate 1
229     %endrep
230 %endmacro
231
232 %macro LOAD_IF_USED 1-*
233     %rep %0
234         %if %1 < num_args
235             mov r%1, r %+ %1 %+ mp
236         %endif
237         %rotate 1
238     %endrep
239 %endmacro
240
241 %macro SUB 2
242     sub %1, %2
243     %ifidn %1, rsp
244         %assign stack_offset stack_offset+(%2)
245     %endif
246 %endmacro
247
248 %macro ADD 2
249     add %1, %2
250     %ifidn %1, rsp
251         %assign stack_offset stack_offset-(%2)
252     %endif
253 %endmacro
254
255 %macro movifnidn 2
256     %ifnidn %1, %2
257         mov %1, %2
258     %endif
259 %endmacro
260
261 %macro movsxdifnidn 2
262     %ifnidn %1, %2
263         movsxd %1, %2
264     %endif
265 %endmacro
266
267 %macro ASSERT 1
268     %if (%1) == 0
269         %error assert failed
270     %endif
271 %endmacro
272
273 %macro DEFINE_ARGS 0-*
274     %ifdef n_arg_names
275         %assign %%i 0
276         %rep n_arg_names
277             CAT_UNDEF arg_name %+ %%i, q
278             CAT_UNDEF arg_name %+ %%i, d
279             CAT_UNDEF arg_name %+ %%i, w
280             CAT_UNDEF arg_name %+ %%i, h
281             CAT_UNDEF arg_name %+ %%i, b
282             CAT_UNDEF arg_name %+ %%i, m
283             CAT_UNDEF arg_name, %%i
284             %assign %%i %%i+1
285         %endrep
286     %endif
287
288     %assign %%stack_offset stack_offset
289     %undef stack_offset ; so that the current value of stack_offset doesn't get baked in by xdefine
290     %assign %%i 0
291     %rep %0
292         %xdefine %1q r %+ %%i %+ q
293         %xdefine %1d r %+ %%i %+ d
294         %xdefine %1w r %+ %%i %+ w
295         %xdefine %1h r %+ %%i %+ h
296         %xdefine %1b r %+ %%i %+ b
297         %xdefine %1m r %+ %%i %+ m
298         CAT_XDEFINE arg_name, %%i, %1
299         %assign %%i %%i+1
300         %rotate 1
301     %endrep
302     %assign stack_offset %%stack_offset
303     %assign n_arg_names %0
304 %endmacro
305
306 %if WIN64 ; Windows x64 ;=================================================
307
308 DECLARE_REG 0,  rcx
309 DECLARE_REG 1,  rdx
310 DECLARE_REG 2,  R8
311 DECLARE_REG 3,  R9
312 DECLARE_REG 4,  R10, 40
313 DECLARE_REG 5,  R11, 48
314 DECLARE_REG 6,  rax, 56
315 DECLARE_REG 7,  rdi, 64
316 DECLARE_REG 8,  rsi, 72
317 DECLARE_REG 9,  rbx, 80
318 DECLARE_REG 10, rbp, 88
319 DECLARE_REG 11, R12, 96
320 DECLARE_REG 12, R13, 104
321 DECLARE_REG 13, R14, 112
322 DECLARE_REG 14, R15, 120
323
324 %macro PROLOGUE 2-4+ 0 ; #args, #regs, #xmm_regs, arg_names...
325     %assign num_args %1
326     %assign regs_used %2
327     ASSERT regs_used >= num_args
328     ASSERT regs_used <= 15
329     PUSH_IF_USED 7, 8, 9, 10, 11, 12, 13, 14
330     WIN64_SPILL_XMM %3
331     LOAD_IF_USED 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14
332     DEFINE_ARGS %4
333 %endmacro
334
335 %macro WIN64_SPILL_XMM 1
336     %assign xmm_regs_used %1
337     %if mmsize == 8
338         %assign xmm_regs_used 0
339     %endif
340     ASSERT xmm_regs_used <= 16
341     %if xmm_regs_used > 6
342         SUB rsp, (xmm_regs_used-6)*16+16
343         %assign %%i xmm_regs_used
344         %rep (xmm_regs_used-6)
345             %assign %%i %%i-1
346             movdqa [rsp + (%%i-6)*16+(~stack_offset&8)], xmm %+ %%i
347         %endrep
348     %endif
349 %endmacro
350
351 %macro WIN64_RESTORE_XMM_INTERNAL 1
352     %if xmm_regs_used > 6
353         %assign %%i xmm_regs_used
354         %rep (xmm_regs_used-6)
355             %assign %%i %%i-1
356             movdqa xmm %+ %%i, [%1 + (%%i-6)*16+(~stack_offset&8)]
357         %endrep
358         add %1, (xmm_regs_used-6)*16+16
359     %endif
360 %endmacro
361
362 %macro WIN64_RESTORE_XMM 1
363     WIN64_RESTORE_XMM_INTERNAL %1
364     %assign stack_offset stack_offset-(xmm_regs_used-6)*16+16
365     %assign xmm_regs_used 0
366 %endmacro
367
368 %define has_epilogue regs_used > 7 || xmm_regs_used > 6
369
370 %macro RET 0
371     WIN64_RESTORE_XMM_INTERNAL rsp
372     POP_IF_USED 14, 13, 12, 11, 10, 9, 8, 7
373     ret
374 %endmacro
375
376 %elif ARCH_X86_64 ; *nix x64 ;=============================================
377
378 DECLARE_REG 0,  rdi
379 DECLARE_REG 1,  rsi
380 DECLARE_REG 2,  rdx
381 DECLARE_REG 3,  rcx
382 DECLARE_REG 4,  R8
383 DECLARE_REG 5,  R9
384 DECLARE_REG 6,  rax, 8
385 DECLARE_REG 7,  R10, 16
386 DECLARE_REG 8,  R11, 24
387 DECLARE_REG 9,  rbx, 32
388 DECLARE_REG 10, rbp, 40
389 DECLARE_REG 11, R12, 48
390 DECLARE_REG 12, R13, 56
391 DECLARE_REG 13, R14, 64
392 DECLARE_REG 14, R15, 72
393
394 %macro PROLOGUE 2-4+ ; #args, #regs, #xmm_regs, arg_names...
395     %assign num_args %1
396     %assign regs_used %2
397     ASSERT regs_used >= num_args
398     ASSERT regs_used <= 15
399     PUSH_IF_USED 9, 10, 11, 12, 13, 14
400     LOAD_IF_USED 6, 7, 8, 9, 10, 11, 12, 13, 14
401     DEFINE_ARGS %4
402 %endmacro
403
404 %define has_epilogue regs_used > 9
405
406 %macro RET 0
407     POP_IF_USED 14, 13, 12, 11, 10, 9
408     ret
409 %endmacro
410
411 %else ; X86_32 ;==============================================================
412
413 DECLARE_REG 0, eax, 4
414 DECLARE_REG 1, ecx, 8
415 DECLARE_REG 2, edx, 12
416 DECLARE_REG 3, ebx, 16
417 DECLARE_REG 4, esi, 20
418 DECLARE_REG 5, edi, 24
419 DECLARE_REG 6, ebp, 28
420 %define rsp esp
421
422 %macro DECLARE_ARG 1-*
423     %rep %0
424         %define r%1m [esp + stack_offset + 4*%1 + 4]
425         %define r%1mp dword r%1m
426         %rotate 1
427     %endrep
428 %endmacro
429
430 DECLARE_ARG 7, 8, 9, 10, 11, 12, 13, 14
431
432 %macro PROLOGUE 2-4+ ; #args, #regs, #xmm_regs, arg_names...
433     %assign num_args %1
434     %assign regs_used %2
435     %if regs_used > 7
436         %assign regs_used 7
437     %endif
438     ASSERT regs_used >= num_args
439     PUSH_IF_USED 3, 4, 5, 6
440     LOAD_IF_USED 0, 1, 2, 3, 4, 5, 6
441     DEFINE_ARGS %4
442 %endmacro
443
444 %define has_epilogue regs_used > 3
445
446 %macro RET 0
447     POP_IF_USED 6, 5, 4, 3
448     ret
449 %endmacro
450
451 %endif ;======================================================================
452
453 %if WIN64 == 0
454 %macro WIN64_SPILL_XMM 1
455 %endmacro
456 %macro WIN64_RESTORE_XMM 1
457 %endmacro
458 %endif
459
460 %macro REP_RET 0
461     %if has_epilogue
462         RET
463     %else
464         rep ret
465     %endif
466 %endmacro
467
468 %macro TAIL_CALL 2 ; callee, is_nonadjacent
469     %if has_epilogue
470         call %1
471         RET
472     %elif %2
473         jmp %1
474     %endif
475 %endmacro
476
477 ;=============================================================================
478 ; arch-independent part
479 ;=============================================================================
480
481 %assign function_align 16
482
483 ; Begin a function.
484 ; Applies any symbol mangling needed for C linkage, and sets up a define such that
485 ; subsequent uses of the function name automatically refer to the mangled version.
486 ; Appends cpuflags to the function name if cpuflags has been specified.
487 %macro cglobal 1-2+ ; name, [PROLOGUE args]
488 %if %0 == 1
489     cglobal_internal %1 %+ SUFFIX
490 %else
491     cglobal_internal %1 %+ SUFFIX, %2
492 %endif
493 %endmacro
494 %macro cglobal_internal 1-2+
495     %ifndef cglobaled_%1
496         %xdefine %1 mangle(program_name %+ _ %+ %1)
497         %xdefine %1.skip_prologue %1 %+ .skip_prologue
498         CAT_XDEFINE cglobaled_, %1, 1
499     %endif
500     %xdefine current_function %1
501     %ifidn __OUTPUT_FORMAT__,elf
502         global %1:function hidden
503     %else
504         global %1
505     %endif
506     align function_align
507     %1:
508     RESET_MM_PERMUTATION ; not really needed, but makes disassembly somewhat nicer
509     %assign stack_offset 0
510     %if %0 > 1
511         PROLOGUE %2
512     %endif
513 %endmacro
514
515 %macro cextern 1
516     %xdefine %1 mangle(program_name %+ _ %+ %1)
517     CAT_XDEFINE cglobaled_, %1, 1
518     extern %1
519 %endmacro
520
521 ; like cextern, but without the prefix
522 %macro cextern_naked 1
523     %xdefine %1 mangle(%1)
524     CAT_XDEFINE cglobaled_, %1, 1
525     extern %1
526 %endmacro
527
528 %macro const 2+
529     %xdefine %1 mangle(program_name %+ _ %+ %1)
530     global %1
531     %1: %2
532 %endmacro
533
534 ; This is needed for ELF, otherwise the GNU linker assumes the stack is
535 ; executable by default.
536 %ifidn __OUTPUT_FORMAT__,elf
537 SECTION .note.GNU-stack noalloc noexec nowrite progbits
538 %endif
539
540 ; cpuflags
541
542 %assign cpuflags_mmx      (1<<0)
543 %assign cpuflags_mmx2     (1<<1) | cpuflags_mmx
544 %assign cpuflags_sse      (1<<2) | cpuflags_mmx2
545 %assign cpuflags_sse2     (1<<3) | cpuflags_sse
546 %assign cpuflags_sse2slow (1<<4) | cpuflags_sse2
547 %assign cpuflags_sse3     (1<<5) | cpuflags_sse2
548 %assign cpuflags_ssse3    (1<<6) | cpuflags_sse3
549 %assign cpuflags_sse4     (1<<7) | cpuflags_ssse3
550 %assign cpuflags_sse42    (1<<8) | cpuflags_sse4
551 %assign cpuflags_avx      (1<<9) | cpuflags_sse42
552 %assign cpuflags_xop      (1<<10)| cpuflags_avx
553 %assign cpuflags_fma4     (1<<11)| cpuflags_avx
554 %assign cpuflags_avx2     (1<<12)| cpuflags_avx
555 %assign cpuflags_fma3     (1<<13)| cpuflags_avx
556
557 %assign cpuflags_cache32  (1<<16)
558 %assign cpuflags_cache64  (1<<17)
559 %assign cpuflags_slowctz  (1<<18)
560 %assign cpuflags_lzcnt    (1<<19)
561 %assign cpuflags_misalign (1<<20)
562 %assign cpuflags_aligned  (1<<21) ; not a cpu feature, but a function variant
563 %assign cpuflags_bmi1     (1<<22)
564 %assign cpuflags_bmi2     (1<<23)|cpuflags_bmi1
565 %assign cpuflags_tbm      (1<<24)|cpuflags_bmi1
566
567 %define    cpuflag(x) ((cpuflags & (cpuflags_ %+ x)) == (cpuflags_ %+ x))
568 %define notcpuflag(x) ((cpuflags & (cpuflags_ %+ x)) != (cpuflags_ %+ x))
569
570 ; Takes up to 2 cpuflags from the above list.
571 ; All subsequent functions (up to the next INIT_CPUFLAGS) is built for the specified cpu.
572 ; You shouldn't need to invoke this macro directly, it's a subroutine for INIT_MMX &co.
573 %macro INIT_CPUFLAGS 0-2
574     %if %0 >= 1
575         %xdefine cpuname %1
576         %assign cpuflags cpuflags_%1
577         %if %0 >= 2
578             %xdefine cpuname %1_%2
579             %assign cpuflags cpuflags | cpuflags_%2
580         %endif
581         %xdefine SUFFIX _ %+ cpuname
582         %if cpuflag(avx)
583             %assign avx_enabled 1
584         %endif
585         %if cpuflag(aligned)
586             %define movu mova
587         %elifidn %1, sse3
588             %define movu lddqu
589         %endif
590     %else
591         %xdefine SUFFIX
592         %undef cpuname
593         %undef cpuflags
594     %endif
595 %endmacro
596
597 ; merge mmx and sse*
598
599 %macro CAT_XDEFINE 3
600     %xdefine %1%2 %3
601 %endmacro
602
603 %macro CAT_UNDEF 2
604     %undef %1%2
605 %endmacro
606
607 %macro INIT_MMX 0-1+
608     %assign avx_enabled 0
609     %define RESET_MM_PERMUTATION INIT_MMX %1
610     %define mmsize 8
611     %define num_mmregs 8
612     %define mova movq
613     %define movu movq
614     %define movh movd
615     %define movnta movntq
616     %assign %%i 0
617     %rep 8
618     CAT_XDEFINE m, %%i, mm %+ %%i
619     CAT_XDEFINE nmm, %%i, %%i
620     %assign %%i %%i+1
621     %endrep
622     %rep 8
623     CAT_UNDEF m, %%i
624     CAT_UNDEF nmm, %%i
625     %assign %%i %%i+1
626     %endrep
627     INIT_CPUFLAGS %1
628 %endmacro
629
630 %macro INIT_XMM 0-1+
631     %assign avx_enabled 0
632     %define RESET_MM_PERMUTATION INIT_XMM %1
633     %define mmsize 16
634     %define num_mmregs 8
635     %if ARCH_X86_64
636     %define num_mmregs 16
637     %endif
638     %define mova movdqa
639     %define movu movdqu
640     %define movh movq
641     %define movnta movntdq
642     %assign %%i 0
643     %rep num_mmregs
644     CAT_XDEFINE m, %%i, xmm %+ %%i
645     CAT_XDEFINE nxmm, %%i, %%i
646     %assign %%i %%i+1
647     %endrep
648     INIT_CPUFLAGS %1
649 %endmacro
650
651 %macro INIT_YMM 0-1+
652     %assign avx_enabled 1
653     %define RESET_MM_PERMUTATION INIT_YMM %1
654     %define mmsize 32
655     %define num_mmregs 8
656     %if ARCH_X86_64
657     %define num_mmregs 16
658     %endif
659     %define mova vmovaps
660     %define movu vmovups
661     %undef movh
662     %undef movnta
663     %assign %%i 0
664     %rep num_mmregs
665     CAT_XDEFINE m, %%i, ymm %+ %%i
666     CAT_XDEFINE nymm, %%i, %%i
667     %assign %%i %%i+1
668     %endrep
669     INIT_CPUFLAGS %1
670 %endmacro
671
672 INIT_XMM
673
674 ; I often want to use macros that permute their arguments. e.g. there's no
675 ; efficient way to implement butterfly or transpose or dct without swapping some
676 ; arguments.
677 ;
678 ; I would like to not have to manually keep track of the permutations:
679 ; If I insert a permutation in the middle of a function, it should automatically
680 ; change everything that follows. For more complex macros I may also have multiple
681 ; implementations, e.g. the SSE2 and SSSE3 versions may have different permutations.
682 ;
683 ; Hence these macros. Insert a PERMUTE or some SWAPs at the end of a macro that
684 ; permutes its arguments. It's equivalent to exchanging the contents of the
685 ; registers, except that this way you exchange the register names instead, so it
686 ; doesn't cost any cycles.
687
688 %macro PERMUTE 2-* ; takes a list of pairs to swap
689 %rep %0/2
690     %xdefine tmp%2 m%2
691     %xdefine ntmp%2 nm%2
692     %rotate 2
693 %endrep
694 %rep %0/2
695     %xdefine m%1 tmp%2
696     %xdefine nm%1 ntmp%2
697     %undef tmp%2
698     %undef ntmp%2
699     %rotate 2
700 %endrep
701 %endmacro
702
703 %macro SWAP 2-* ; swaps a single chain (sometimes more concise than pairs)
704 %rep %0-1
705 %ifdef m%1
706     %xdefine tmp m%1
707     %xdefine m%1 m%2
708     %xdefine m%2 tmp
709     CAT_XDEFINE n, m%1, %1
710     CAT_XDEFINE n, m%2, %2
711 %else
712     ; If we were called as "SWAP m0,m1" rather than "SWAP 0,1" infer the original numbers here.
713     ; Be careful using this mode in nested macros though, as in some cases there may be
714     ; other copies of m# that have already been dereferenced and don't get updated correctly.
715     %xdefine %%n1 n %+ %1
716     %xdefine %%n2 n %+ %2
717     %xdefine tmp m %+ %%n1
718     CAT_XDEFINE m, %%n1, m %+ %%n2
719     CAT_XDEFINE m, %%n2, tmp
720     CAT_XDEFINE n, m %+ %%n1, %%n1
721     CAT_XDEFINE n, m %+ %%n2, %%n2
722 %endif
723     %undef tmp
724     %rotate 1
725 %endrep
726 %endmacro
727
728 ; If SAVE_MM_PERMUTATION is placed at the end of a function, then any later
729 ; calls to that function will automatically load the permutation, so values can
730 ; be returned in mmregs.
731 %macro SAVE_MM_PERMUTATION 0-1
732     %if %0
733         %xdefine %%f %1_m
734     %else
735         %xdefine %%f current_function %+ _m
736     %endif
737     %assign %%i 0
738     %rep num_mmregs
739         CAT_XDEFINE %%f, %%i, m %+ %%i
740     %assign %%i %%i+1
741     %endrep
742 %endmacro
743
744 %macro LOAD_MM_PERMUTATION 1 ; name to load from
745     %ifdef %1_m0
746         %assign %%i 0
747         %rep num_mmregs
748             CAT_XDEFINE m, %%i, %1_m %+ %%i
749             CAT_XDEFINE n, m %+ %%i, %%i
750         %assign %%i %%i+1
751         %endrep
752     %endif
753 %endmacro
754
755 ; Append cpuflags to the callee's name iff the appended name is known and the plain name isn't
756 %macro call 1
757     call_internal %1, %1 %+ SUFFIX
758 %endmacro
759 %macro call_internal 2
760     %xdefine %%i %1
761     %ifndef cglobaled_%1
762         %ifdef cglobaled_%2
763             %xdefine %%i %2
764         %endif
765     %endif
766     call %%i
767     LOAD_MM_PERMUTATION %%i
768 %endmacro
769
770 ; Substitutions that reduce instruction size but are functionally equivalent
771 %macro add 2
772     %ifnum %2
773         %if %2==128
774             sub %1, -128
775         %else
776             add %1, %2
777         %endif
778     %else
779         add %1, %2
780     %endif
781 %endmacro
782
783 %macro sub 2
784     %ifnum %2
785         %if %2==128
786             add %1, -128
787         %else
788             sub %1, %2
789         %endif
790     %else
791         sub %1, %2
792     %endif
793 %endmacro
794
795 ;=============================================================================
796 ; AVX abstraction layer
797 ;=============================================================================
798
799 %assign i 0
800 %rep 16
801     %if i < 8
802         CAT_XDEFINE sizeofmm, i, 8
803     %endif
804     CAT_XDEFINE sizeofxmm, i, 16
805     CAT_XDEFINE sizeofymm, i, 32
806 %assign i i+1
807 %endrep
808 %undef i
809
810 %macro CHECK_AVX_INSTR_EMU 3-*
811     %xdefine %%opcode %1
812     %xdefine %%dst %2
813     %rep %0-2
814         %ifidn %%dst, %3
815             %error non-avx emulation of ``%%opcode'' is not supported
816         %endif
817         %rotate 1
818     %endrep
819 %endmacro
820
821 ;%1 == instruction
822 ;%2 == 1 if float, 0 if int
823 ;%3 == 1 if 4-operand (xmm, xmm, xmm, imm), 0 if 3-operand (xmm, xmm, xmm)
824 ;%4 == number of operands given
825 ;%5+: operands
826 %macro RUN_AVX_INSTR 6-7+
827     %ifid %6
828         %define %%sizeofreg sizeof%6
829     %elifid %5
830         %define %%sizeofreg sizeof%5
831     %else
832         %define %%sizeofreg mmsize
833     %endif
834     %if %%sizeofreg==32
835         %if %4>=3
836             v%1 %5, %6, %7
837         %else
838             v%1 %5, %6
839         %endif
840     %else
841         %if %%sizeofreg==8
842             %define %%regmov movq
843         %elif %2
844             %define %%regmov movaps
845         %else
846             %define %%regmov movdqa
847         %endif
848
849         %if %4>=3+%3
850             %ifnidn %5, %6
851                 %if avx_enabled && %%sizeofreg==16
852                     v%1 %5, %6, %7
853                 %else
854                     CHECK_AVX_INSTR_EMU {%1 %5, %6, %7}, %5, %7
855                     %%regmov %5, %6
856                     %1 %5, %7
857                 %endif
858             %else
859                 %1 %5, %7
860             %endif
861         %elif %4>=3
862             %1 %5, %6, %7
863         %else
864             %1 %5, %6
865         %endif
866     %endif
867 %endmacro
868
869 ; 3arg AVX ops with a memory arg can only have it in src2,
870 ; whereas SSE emulation of 3arg prefers to have it in src1 (i.e. the mov).
871 ; So, if the op is symmetric and the wrong one is memory, swap them.
872 %macro RUN_AVX_INSTR1 8
873     %assign %%swap 0
874     %if avx_enabled
875         %ifnid %6
876             %assign %%swap 1
877         %endif
878     %elifnidn %5, %6
879         %ifnid %7
880             %assign %%swap 1
881         %endif
882     %endif
883     %if %%swap && %3 == 0 && %8 == 1
884         RUN_AVX_INSTR %1, %2, %3, %4, %5, %7, %6
885     %else
886         RUN_AVX_INSTR %1, %2, %3, %4, %5, %6, %7
887     %endif
888 %endmacro
889
890 ;%1 == instruction
891 ;%2 == 1 if float, 0 if int
892 ;%3 == 1 if 4-operand (xmm, xmm, xmm, imm), 0 if 3-operand (xmm, xmm, xmm)
893 ;%4 == 1 if symmetric (i.e. doesn't matter which src arg is which), 0 if not
894 %macro AVX_INSTR 4
895     %macro %1 2-9 fnord, fnord, fnord, %1, %2, %3, %4
896         %ifidn %3, fnord
897             RUN_AVX_INSTR %6, %7, %8, 2, %1, %2
898         %elifidn %4, fnord
899             RUN_AVX_INSTR1 %6, %7, %8, 3, %1, %2, %3, %9
900         %elifidn %5, fnord
901             RUN_AVX_INSTR %6, %7, %8, 4, %1, %2, %3, %4
902         %else
903             RUN_AVX_INSTR %6, %7, %8, 5, %1, %2, %3, %4, %5
904         %endif
905     %endmacro
906 %endmacro
907
908 AVX_INSTR addpd, 1, 0, 1
909 AVX_INSTR addps, 1, 0, 1
910 AVX_INSTR addsd, 1, 0, 1
911 AVX_INSTR addss, 1, 0, 1
912 AVX_INSTR addsubpd, 1, 0, 0
913 AVX_INSTR addsubps, 1, 0, 0
914 AVX_INSTR andpd, 1, 0, 1
915 AVX_INSTR andps, 1, 0, 1
916 AVX_INSTR andnpd, 1, 0, 0
917 AVX_INSTR andnps, 1, 0, 0
918 AVX_INSTR blendpd, 1, 0, 0
919 AVX_INSTR blendps, 1, 0, 0
920 AVX_INSTR blendvpd, 1, 0, 0
921 AVX_INSTR blendvps, 1, 0, 0
922 AVX_INSTR cmppd, 1, 0, 0
923 AVX_INSTR cmpps, 1, 0, 0
924 AVX_INSTR cmpsd, 1, 0, 0
925 AVX_INSTR cmpss, 1, 0, 0
926 AVX_INSTR divpd, 1, 0, 0
927 AVX_INSTR divps, 1, 0, 0
928 AVX_INSTR divsd, 1, 0, 0
929 AVX_INSTR divss, 1, 0, 0
930 AVX_INSTR dppd, 1, 1, 0
931 AVX_INSTR dpps, 1, 1, 0
932 AVX_INSTR haddpd, 1, 0, 0
933 AVX_INSTR haddps, 1, 0, 0
934 AVX_INSTR hsubpd, 1, 0, 0
935 AVX_INSTR hsubps, 1, 0, 0
936 AVX_INSTR maxpd, 1, 0, 1
937 AVX_INSTR maxps, 1, 0, 1
938 AVX_INSTR maxsd, 1, 0, 1
939 AVX_INSTR maxss, 1, 0, 1
940 AVX_INSTR minpd, 1, 0, 1
941 AVX_INSTR minps, 1, 0, 1
942 AVX_INSTR minsd, 1, 0, 1
943 AVX_INSTR minss, 1, 0, 1
944 AVX_INSTR movsd, 1, 0, 0
945 AVX_INSTR movss, 1, 0, 0
946 AVX_INSTR mpsadbw, 0, 1, 0
947 AVX_INSTR mulpd, 1, 0, 1
948 AVX_INSTR mulps, 1, 0, 1
949 AVX_INSTR mulsd, 1, 0, 1
950 AVX_INSTR mulss, 1, 0, 1
951 AVX_INSTR orpd, 1, 0, 1
952 AVX_INSTR orps, 1, 0, 1
953 AVX_INSTR pabsb, 0, 0, 0
954 AVX_INSTR pabsw, 0, 0, 0
955 AVX_INSTR pabsd, 0, 0, 0
956 AVX_INSTR packsswb, 0, 0, 0
957 AVX_INSTR packssdw, 0, 0, 0
958 AVX_INSTR packuswb, 0, 0, 0
959 AVX_INSTR packusdw, 0, 0, 0
960 AVX_INSTR paddb, 0, 0, 1
961 AVX_INSTR paddw, 0, 0, 1
962 AVX_INSTR paddd, 0, 0, 1
963 AVX_INSTR paddq, 0, 0, 1
964 AVX_INSTR paddsb, 0, 0, 1
965 AVX_INSTR paddsw, 0, 0, 1
966 AVX_INSTR paddusb, 0, 0, 1
967 AVX_INSTR paddusw, 0, 0, 1
968 AVX_INSTR palignr, 0, 1, 0
969 AVX_INSTR pand, 0, 0, 1
970 AVX_INSTR pandn, 0, 0, 0
971 AVX_INSTR pavgb, 0, 0, 1
972 AVX_INSTR pavgw, 0, 0, 1
973 AVX_INSTR pblendvb, 0, 0, 0
974 AVX_INSTR pblendw, 0, 1, 0
975 AVX_INSTR pcmpestri, 0, 0, 0
976 AVX_INSTR pcmpestrm, 0, 0, 0
977 AVX_INSTR pcmpistri, 0, 0, 0
978 AVX_INSTR pcmpistrm, 0, 0, 0
979 AVX_INSTR pcmpeqb, 0, 0, 1
980 AVX_INSTR pcmpeqw, 0, 0, 1
981 AVX_INSTR pcmpeqd, 0, 0, 1
982 AVX_INSTR pcmpeqq, 0, 0, 1
983 AVX_INSTR pcmpgtb, 0, 0, 0
984 AVX_INSTR pcmpgtw, 0, 0, 0
985 AVX_INSTR pcmpgtd, 0, 0, 0
986 AVX_INSTR pcmpgtq, 0, 0, 0
987 AVX_INSTR phaddw, 0, 0, 0
988 AVX_INSTR phaddd, 0, 0, 0
989 AVX_INSTR phaddsw, 0, 0, 0
990 AVX_INSTR phsubw, 0, 0, 0
991 AVX_INSTR phsubd, 0, 0, 0
992 AVX_INSTR phsubsw, 0, 0, 0
993 AVX_INSTR pmaddwd, 0, 0, 1
994 AVX_INSTR pmaddubsw, 0, 0, 0
995 AVX_INSTR pmaxsb, 0, 0, 1
996 AVX_INSTR pmaxsw, 0, 0, 1
997 AVX_INSTR pmaxsd, 0, 0, 1
998 AVX_INSTR pmaxub, 0, 0, 1
999 AVX_INSTR pmaxuw, 0, 0, 1
1000 AVX_INSTR pmaxud, 0, 0, 1
1001 AVX_INSTR pminsb, 0, 0, 1
1002 AVX_INSTR pminsw, 0, 0, 1
1003 AVX_INSTR pminsd, 0, 0, 1
1004 AVX_INSTR pminub, 0, 0, 1
1005 AVX_INSTR pminuw, 0, 0, 1
1006 AVX_INSTR pminud, 0, 0, 1
1007 AVX_INSTR pmovmskb, 0, 0, 0
1008 AVX_INSTR pmulhuw, 0, 0, 1
1009 AVX_INSTR pmulhrsw, 0, 0, 1
1010 AVX_INSTR pmulhw, 0, 0, 1
1011 AVX_INSTR pmullw, 0, 0, 1
1012 AVX_INSTR pmulld, 0, 0, 1
1013 AVX_INSTR pmuludq, 0, 0, 1
1014 AVX_INSTR pmuldq, 0, 0, 1
1015 AVX_INSTR por, 0, 0, 1
1016 AVX_INSTR psadbw, 0, 0, 1
1017 AVX_INSTR pshufb, 0, 0, 0
1018 AVX_INSTR pshufd, 0, 1, 0
1019 AVX_INSTR pshufhw, 0, 1, 0
1020 AVX_INSTR pshuflw, 0, 1, 0
1021 AVX_INSTR psignb, 0, 0, 0
1022 AVX_INSTR psignw, 0, 0, 0
1023 AVX_INSTR psignd, 0, 0, 0
1024 AVX_INSTR psllw, 0, 0, 0
1025 AVX_INSTR pslld, 0, 0, 0
1026 AVX_INSTR psllq, 0, 0, 0
1027 AVX_INSTR pslldq, 0, 0, 0
1028 AVX_INSTR psraw, 0, 0, 0
1029 AVX_INSTR psrad, 0, 0, 0
1030 AVX_INSTR psrlw, 0, 0, 0
1031 AVX_INSTR psrld, 0, 0, 0
1032 AVX_INSTR psrlq, 0, 0, 0
1033 AVX_INSTR psrldq, 0, 0, 0
1034 AVX_INSTR psubb, 0, 0, 0
1035 AVX_INSTR psubw, 0, 0, 0
1036 AVX_INSTR psubd, 0, 0, 0
1037 AVX_INSTR psubq, 0, 0, 0
1038 AVX_INSTR psubsb, 0, 0, 0
1039 AVX_INSTR psubsw, 0, 0, 0
1040 AVX_INSTR psubusb, 0, 0, 0
1041 AVX_INSTR psubusw, 0, 0, 0
1042 AVX_INSTR ptest, 0, 0, 0
1043 AVX_INSTR punpckhbw, 0, 0, 0
1044 AVX_INSTR punpckhwd, 0, 0, 0
1045 AVX_INSTR punpckhdq, 0, 0, 0
1046 AVX_INSTR punpckhqdq, 0, 0, 0
1047 AVX_INSTR punpcklbw, 0, 0, 0
1048 AVX_INSTR punpcklwd, 0, 0, 0
1049 AVX_INSTR punpckldq, 0, 0, 0
1050 AVX_INSTR punpcklqdq, 0, 0, 0
1051 AVX_INSTR pxor, 0, 0, 1
1052 AVX_INSTR shufps, 1, 1, 0
1053 AVX_INSTR subpd, 1, 0, 0
1054 AVX_INSTR subps, 1, 0, 0
1055 AVX_INSTR subsd, 1, 0, 0
1056 AVX_INSTR subss, 1, 0, 0
1057 AVX_INSTR unpckhpd, 1, 0, 0
1058 AVX_INSTR unpckhps, 1, 0, 0
1059 AVX_INSTR unpcklpd, 1, 0, 0
1060 AVX_INSTR unpcklps, 1, 0, 0
1061 AVX_INSTR xorpd, 1, 0, 1
1062 AVX_INSTR xorps, 1, 0, 1
1063
1064 ; 3DNow instructions, for sharing code between AVX, SSE and 3DN
1065 AVX_INSTR pfadd, 1, 0, 1
1066 AVX_INSTR pfsub, 1, 0, 0
1067 AVX_INSTR pfmul, 1, 0, 1
1068
1069 ; base-4 constants for shuffles
1070 %assign i 0
1071 %rep 256
1072     %assign j ((i>>6)&3)*1000 + ((i>>4)&3)*100 + ((i>>2)&3)*10 + (i&3)
1073     %if j < 10
1074         CAT_XDEFINE q000, j, i
1075     %elif j < 100
1076         CAT_XDEFINE q00, j, i
1077     %elif j < 1000
1078         CAT_XDEFINE q0, j, i
1079     %else
1080         CAT_XDEFINE q, j, i
1081     %endif
1082 %assign i i+1
1083 %endrep
1084 %undef i
1085 %undef j
1086
1087 %macro FMA_INSTR 3
1088     %macro %1 4-7 %1, %2, %3
1089         %if cpuflag(xop)
1090             v%5 %1, %2, %3, %4
1091         %else
1092             %6 %1, %2, %3
1093             %7 %1, %4
1094         %endif
1095     %endmacro
1096 %endmacro
1097
1098 FMA_INSTR  pmacsdd,  pmulld, paddd
1099 FMA_INSTR  pmacsww,  pmullw, paddw
1100 FMA_INSTR pmadcswd, pmaddwd, paddd
1101
1102 ; tzcnt is equivalent to "rep bsf" and is backwards-compatible with bsf.
1103 ; This lets us use tzcnt without bumping the yasm version requirement yet.
1104 %define tzcnt rep bsf