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