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