x86inc: import patches from libav
[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, mp
284             CAT_UNDEF arg_name, %%i
285             %assign %%i %%i+1
286         %endrep
287     %endif
288
289     %xdefine %%stack_offset stack_offset
290     %undef stack_offset ; so that the current value of stack_offset doesn't get baked in by xdefine
291     %assign %%i 0
292     %rep %0
293         %xdefine %1q r %+ %%i %+ q
294         %xdefine %1d r %+ %%i %+ d
295         %xdefine %1w r %+ %%i %+ w
296         %xdefine %1h r %+ %%i %+ h
297         %xdefine %1b r %+ %%i %+ b
298         %xdefine %1m r %+ %%i %+ m
299         %xdefine %1mp r %+ %%i %+ mp
300         CAT_XDEFINE arg_name, %%i, %1
301         %assign %%i %%i+1
302         %rotate 1
303     %endrep
304     %xdefine stack_offset %%stack_offset
305     %assign n_arg_names %0
306 %endmacro
307
308 %if WIN64 ; Windows x64 ;=================================================
309
310 DECLARE_REG 0,  rcx
311 DECLARE_REG 1,  rdx
312 DECLARE_REG 2,  R8
313 DECLARE_REG 3,  R9
314 DECLARE_REG 4,  R10, 40
315 DECLARE_REG 5,  R11, 48
316 DECLARE_REG 6,  rax, 56
317 DECLARE_REG 7,  rdi, 64
318 DECLARE_REG 8,  rsi, 72
319 DECLARE_REG 9,  rbx, 80
320 DECLARE_REG 10, rbp, 88
321 DECLARE_REG 11, R12, 96
322 DECLARE_REG 12, R13, 104
323 DECLARE_REG 13, R14, 112
324 DECLARE_REG 14, R15, 120
325
326 %macro PROLOGUE 2-4+ 0 ; #args, #regs, #xmm_regs, arg_names...
327     %assign num_args %1
328     %assign regs_used %2
329     ASSERT regs_used >= num_args
330     ASSERT regs_used <= 15
331     PUSH_IF_USED 7, 8, 9, 10, 11, 12, 13, 14
332     %if mmsize == 8
333         %assign xmm_regs_used 0
334     %else
335         WIN64_SPILL_XMM %3
336     %endif
337     LOAD_IF_USED 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14
338     DEFINE_ARGS %4
339 %endmacro
340
341 %macro WIN64_SPILL_XMM 1
342     %assign xmm_regs_used %1
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 %define has_epilogue regs_used > 7 || xmm_regs_used > 6
372
373 %macro RET 0
374     WIN64_RESTORE_XMM_INTERNAL rsp
375     POP_IF_USED 14, 13, 12, 11, 10, 9, 8, 7
376     ret
377 %endmacro
378
379 %elif ARCH_X86_64 ; *nix x64 ;=============================================
380
381 DECLARE_REG 0,  rdi
382 DECLARE_REG 1,  rsi
383 DECLARE_REG 2,  rdx
384 DECLARE_REG 3,  rcx
385 DECLARE_REG 4,  R8
386 DECLARE_REG 5,  R9
387 DECLARE_REG 6,  rax, 8
388 DECLARE_REG 7,  R10, 16
389 DECLARE_REG 8,  R11, 24
390 DECLARE_REG 9,  rbx, 32
391 DECLARE_REG 10, rbp, 40
392 DECLARE_REG 11, R12, 48
393 DECLARE_REG 12, R13, 56
394 DECLARE_REG 13, R14, 64
395 DECLARE_REG 14, R15, 72
396
397 %macro PROLOGUE 2-4+ ; #args, #regs, #xmm_regs, arg_names...
398     %assign num_args %1
399     %assign regs_used %2
400     ASSERT regs_used >= num_args
401     ASSERT regs_used <= 15
402     PUSH_IF_USED 9, 10, 11, 12, 13, 14
403     LOAD_IF_USED 6, 7, 8, 9, 10, 11, 12, 13, 14
404     DEFINE_ARGS %4
405 %endmacro
406
407 %define has_epilogue regs_used > 9
408
409 %macro RET 0
410     POP_IF_USED 14, 13, 12, 11, 10, 9
411     ret
412 %endmacro
413
414 %else ; X86_32 ;==============================================================
415
416 DECLARE_REG 0, eax, 4
417 DECLARE_REG 1, ecx, 8
418 DECLARE_REG 2, edx, 12
419 DECLARE_REG 3, ebx, 16
420 DECLARE_REG 4, esi, 20
421 DECLARE_REG 5, edi, 24
422 DECLARE_REG 6, ebp, 28
423 %define rsp esp
424
425 %macro DECLARE_ARG 1-*
426     %rep %0
427         %define r%1m [esp + stack_offset + 4*%1 + 4]
428         %define r%1mp dword r%1m
429         %rotate 1
430     %endrep
431 %endmacro
432
433 DECLARE_ARG 7, 8, 9, 10, 11, 12, 13, 14
434
435 %macro PROLOGUE 2-4+ ; #args, #regs, #xmm_regs, arg_names...
436     %assign num_args %1
437     %assign regs_used %2
438     %if regs_used > 7
439         %assign regs_used 7
440     %endif
441     ASSERT regs_used >= num_args
442     PUSH_IF_USED 3, 4, 5, 6
443     LOAD_IF_USED 0, 1, 2, 3, 4, 5, 6
444     DEFINE_ARGS %4
445 %endmacro
446
447 %define has_epilogue regs_used > 3
448
449 %macro RET 0
450     POP_IF_USED 6, 5, 4, 3
451     ret
452 %endmacro
453
454 %endif ;======================================================================
455
456 %if WIN64 == 0
457 %macro WIN64_SPILL_XMM 1
458 %endmacro
459 %macro WIN64_RESTORE_XMM 1
460 %endmacro
461 %endif
462
463 %macro REP_RET 0
464     %if has_epilogue
465         RET
466     %else
467         rep ret
468     %endif
469 %endmacro
470
471 %macro TAIL_CALL 2 ; callee, is_nonadjacent
472     %if has_epilogue
473         call %1
474         RET
475     %elif %2
476         jmp %1
477     %endif
478 %endmacro
479
480 ;=============================================================================
481 ; arch-independent part
482 ;=============================================================================
483
484 %assign function_align 16
485
486 ; Begin a function.
487 ; Applies any symbol mangling needed for C linkage, and sets up a define such that
488 ; subsequent uses of the function name automatically refer to the mangled version.
489 ; Appends cpuflags to the function name if cpuflags has been specified.
490 %macro cglobal 1-2+ ; name, [PROLOGUE args]
491 %if %0 == 1
492     cglobal_internal %1 %+ SUFFIX
493 %else
494     cglobal_internal %1 %+ SUFFIX, %2
495 %endif
496 %endmacro
497 %macro cglobal_internal 1-2+
498     %ifndef cglobaled_%1
499         %xdefine %1 mangle(program_name %+ _ %+ %1)
500         %xdefine %1.skip_prologue %1 %+ .skip_prologue
501         CAT_XDEFINE cglobaled_, %1, 1
502     %endif
503     %xdefine current_function %1
504     %ifidn __OUTPUT_FORMAT__,elf
505         global %1:function hidden
506     %else
507         global %1
508     %endif
509     align function_align
510     %1:
511     RESET_MM_PERMUTATION ; not really needed, but makes disassembly somewhat nicer
512     %assign stack_offset 0
513     %if %0 > 1
514         PROLOGUE %2
515     %endif
516 %endmacro
517
518 %macro cextern 1
519     %xdefine %1 mangle(program_name %+ _ %+ %1)
520     CAT_XDEFINE cglobaled_, %1, 1
521     extern %1
522 %endmacro
523
524 ; like cextern, but without the prefix
525 %macro cextern_naked 1
526     %xdefine %1 mangle(%1)
527     CAT_XDEFINE cglobaled_, %1, 1
528     extern %1
529 %endmacro
530
531 %macro const 2+
532     %xdefine %1 mangle(program_name %+ _ %+ %1)
533     global %1
534     %1: %2
535 %endmacro
536
537 ; This is needed for ELF, otherwise the GNU linker assumes the stack is
538 ; executable by default.
539 %ifidn __OUTPUT_FORMAT__,elf
540 SECTION .note.GNU-stack noalloc noexec nowrite progbits
541 %endif
542
543 ; cpuflags
544
545 %assign cpuflags_mmx      (1<<0)
546 %assign cpuflags_mmx2     (1<<1) | cpuflags_mmx
547 %assign cpuflags_3dnow    (1<<2) | cpuflags_mmx
548 %assign cpuflags_3dnow2   (1<<3) | cpuflags_3dnow
549 %assign cpuflags_sse      (1<<4) | cpuflags_mmx2
550 %assign cpuflags_sse2     (1<<5) | cpuflags_sse
551 %assign cpuflags_sse2slow (1<<6) | cpuflags_sse2
552 %assign cpuflags_sse3     (1<<7) | cpuflags_sse2
553 %assign cpuflags_ssse3    (1<<8) | cpuflags_sse3
554 %assign cpuflags_sse4     (1<<9) | cpuflags_ssse3
555 %assign cpuflags_sse42    (1<<10)| cpuflags_sse4
556 %assign cpuflags_avx      (1<<11)| cpuflags_sse42
557 %assign cpuflags_xop      (1<<12)| cpuflags_avx
558 %assign cpuflags_fma4     (1<<13)| cpuflags_avx
559 %assign cpuflags_avx2     (1<<14)| cpuflags_avx
560 %assign cpuflags_fma3     (1<<15)| cpuflags_avx
561
562 %assign cpuflags_cache32  (1<<16)
563 %assign cpuflags_cache64  (1<<17)
564 %assign cpuflags_slowctz  (1<<18)
565 %assign cpuflags_lzcnt    (1<<19)
566 %assign cpuflags_misalign (1<<20)
567 %assign cpuflags_aligned  (1<<21) ; not a cpu feature, but a function variant
568 %assign cpuflags_atom     (1<<22)
569 %assign cpuflags_bmi1     (1<<23)
570 %assign cpuflags_bmi2     (1<<24)|cpuflags_bmi1
571 %assign cpuflags_tbm      (1<<25)|cpuflags_bmi1
572
573 %define    cpuflag(x) ((cpuflags & (cpuflags_ %+ x)) == (cpuflags_ %+ x))
574 %define notcpuflag(x) ((cpuflags & (cpuflags_ %+ x)) != (cpuflags_ %+ x))
575
576 ; Takes up to 2 cpuflags from the above list.
577 ; All subsequent functions (up to the next INIT_CPUFLAGS) is built for the specified cpu.
578 ; You shouldn't need to invoke this macro directly, it's a subroutine for INIT_MMX &co.
579 %macro INIT_CPUFLAGS 0-2
580     %if %0 >= 1
581         %xdefine cpuname %1
582         %assign cpuflags cpuflags_%1
583         %if %0 >= 2
584             %xdefine cpuname %1_%2
585             %assign cpuflags cpuflags | cpuflags_%2
586         %endif
587         %xdefine SUFFIX _ %+ cpuname
588         %if cpuflag(avx)
589             %assign avx_enabled 1
590         %endif
591         %if mmsize == 16 && notcpuflag(sse2)
592             %define mova movaps
593             %define movu movups
594             %define movnta movntps
595         %endif
596         %if cpuflag(aligned)
597             %define movu mova
598         %elifidn %1, sse3
599             %define movu lddqu
600         %endif
601     %else
602         %xdefine SUFFIX
603         %undef cpuname
604         %undef cpuflags
605     %endif
606 %endmacro
607
608 ; merge mmx and sse*
609
610 %macro CAT_XDEFINE 3
611     %xdefine %1%2 %3
612 %endmacro
613
614 %macro CAT_UNDEF 2
615     %undef %1%2
616 %endmacro
617
618 %macro INIT_MMX 0-1+
619     %assign avx_enabled 0
620     %define RESET_MM_PERMUTATION INIT_MMX %1
621     %define mmsize 8
622     %define num_mmregs 8
623     %define mova movq
624     %define movu movq
625     %define movh movd
626     %define movnta movntq
627     %assign %%i 0
628     %rep 8
629     CAT_XDEFINE m, %%i, mm %+ %%i
630     CAT_XDEFINE nmm, %%i, %%i
631     %assign %%i %%i+1
632     %endrep
633     %rep 8
634     CAT_UNDEF m, %%i
635     CAT_UNDEF nmm, %%i
636     %assign %%i %%i+1
637     %endrep
638     INIT_CPUFLAGS %1
639 %endmacro
640
641 %macro INIT_XMM 0-1+
642     %assign avx_enabled 0
643     %define RESET_MM_PERMUTATION INIT_XMM %1
644     %define mmsize 16
645     %define num_mmregs 8
646     %if ARCH_X86_64
647     %define num_mmregs 16
648     %endif
649     %define mova movdqa
650     %define movu movdqu
651     %define movh movq
652     %define movnta movntdq
653     %assign %%i 0
654     %rep num_mmregs
655     CAT_XDEFINE m, %%i, xmm %+ %%i
656     CAT_XDEFINE nxmm, %%i, %%i
657     %assign %%i %%i+1
658     %endrep
659     INIT_CPUFLAGS %1
660 %endmacro
661
662 %macro INIT_YMM 0-1+
663     %assign avx_enabled 1
664     %define RESET_MM_PERMUTATION INIT_YMM %1
665     %define mmsize 32
666     %define num_mmregs 8
667     %if ARCH_X86_64
668     %define num_mmregs 16
669     %endif
670     %define mova vmovaps
671     %define movu vmovups
672     %undef movh
673     %define movnta vmovntps
674     %assign %%i 0
675     %rep num_mmregs
676     CAT_XDEFINE m, %%i, ymm %+ %%i
677     CAT_XDEFINE nymm, %%i, %%i
678     %assign %%i %%i+1
679     %endrep
680     INIT_CPUFLAGS %1
681 %endmacro
682
683 INIT_XMM
684
685 ; I often want to use macros that permute their arguments. e.g. there's no
686 ; efficient way to implement butterfly or transpose or dct without swapping some
687 ; arguments.
688 ;
689 ; I would like to not have to manually keep track of the permutations:
690 ; If I insert a permutation in the middle of a function, it should automatically
691 ; change everything that follows. For more complex macros I may also have multiple
692 ; implementations, e.g. the SSE2 and SSSE3 versions may have different permutations.
693 ;
694 ; Hence these macros. Insert a PERMUTE or some SWAPs at the end of a macro that
695 ; permutes its arguments. It's equivalent to exchanging the contents of the
696 ; registers, except that this way you exchange the register names instead, so it
697 ; doesn't cost any cycles.
698
699 %macro PERMUTE 2-* ; takes a list of pairs to swap
700 %rep %0/2
701     %xdefine tmp%2 m%2
702     %xdefine ntmp%2 nm%2
703     %rotate 2
704 %endrep
705 %rep %0/2
706     %xdefine m%1 tmp%2
707     %xdefine nm%1 ntmp%2
708     %undef tmp%2
709     %undef ntmp%2
710     %rotate 2
711 %endrep
712 %endmacro
713
714 %macro SWAP 2-* ; swaps a single chain (sometimes more concise than pairs)
715 %rep %0-1
716 %ifdef m%1
717     %xdefine tmp m%1
718     %xdefine m%1 m%2
719     %xdefine m%2 tmp
720     CAT_XDEFINE n, m%1, %1
721     CAT_XDEFINE n, m%2, %2
722 %else
723     ; If we were called as "SWAP m0,m1" rather than "SWAP 0,1" infer the original numbers here.
724     ; Be careful using this mode in nested macros though, as in some cases there may be
725     ; other copies of m# that have already been dereferenced and don't get updated correctly.
726     %xdefine %%n1 n %+ %1
727     %xdefine %%n2 n %+ %2
728     %xdefine tmp m %+ %%n1
729     CAT_XDEFINE m, %%n1, m %+ %%n2
730     CAT_XDEFINE m, %%n2, tmp
731     CAT_XDEFINE n, m %+ %%n1, %%n1
732     CAT_XDEFINE n, m %+ %%n2, %%n2
733 %endif
734     %undef tmp
735     %rotate 1
736 %endrep
737 %endmacro
738
739 ; If SAVE_MM_PERMUTATION is placed at the end of a function, then any later
740 ; calls to that function will automatically load the permutation, so values can
741 ; be returned in mmregs.
742 %macro SAVE_MM_PERMUTATION 0-1
743     %if %0
744         %xdefine %%f %1_m
745     %else
746         %xdefine %%f current_function %+ _m
747     %endif
748     %assign %%i 0
749     %rep num_mmregs
750         CAT_XDEFINE %%f, %%i, m %+ %%i
751     %assign %%i %%i+1
752     %endrep
753 %endmacro
754
755 %macro LOAD_MM_PERMUTATION 1 ; name to load from
756     %ifdef %1_m0
757         %assign %%i 0
758         %rep num_mmregs
759             CAT_XDEFINE m, %%i, %1_m %+ %%i
760             CAT_XDEFINE n, m %+ %%i, %%i
761         %assign %%i %%i+1
762         %endrep
763     %endif
764 %endmacro
765
766 ; Append cpuflags to the callee's name iff the appended name is known and the plain name isn't
767 %macro call 1
768     call_internal %1, %1 %+ SUFFIX
769 %endmacro
770 %macro call_internal 2
771     %xdefine %%i %1
772     %ifndef cglobaled_%1
773         %ifdef cglobaled_%2
774             %xdefine %%i %2
775         %endif
776     %endif
777     call %%i
778     LOAD_MM_PERMUTATION %%i
779 %endmacro
780
781 ; Substitutions that reduce instruction size but are functionally equivalent
782 %macro add 2
783     %ifnum %2
784         %if %2==128
785             sub %1, -128
786         %else
787             add %1, %2
788         %endif
789     %else
790         add %1, %2
791     %endif
792 %endmacro
793
794 %macro sub 2
795     %ifnum %2
796         %if %2==128
797             add %1, -128
798         %else
799             sub %1, %2
800         %endif
801     %else
802         sub %1, %2
803     %endif
804 %endmacro
805
806 ;=============================================================================
807 ; AVX abstraction layer
808 ;=============================================================================
809
810 %assign i 0
811 %rep 16
812     %if i < 8
813         CAT_XDEFINE sizeofmm, i, 8
814     %endif
815     CAT_XDEFINE sizeofxmm, i, 16
816     CAT_XDEFINE sizeofymm, i, 32
817 %assign i i+1
818 %endrep
819 %undef i
820
821 %macro CHECK_AVX_INSTR_EMU 3-*
822     %xdefine %%opcode %1
823     %xdefine %%dst %2
824     %rep %0-2
825         %ifidn %%dst, %3
826             %error non-avx emulation of ``%%opcode'' is not supported
827         %endif
828         %rotate 1
829     %endrep
830 %endmacro
831
832 ;%1 == instruction
833 ;%2 == 1 if float, 0 if int
834 ;%3 == 1 if 4-operand (xmm, xmm, xmm, imm), 0 if 2- or 3-operand (xmm, xmm, xmm)
835 ;%4 == number of operands given
836 ;%5+: operands
837 %macro RUN_AVX_INSTR 6-7+
838     %ifid %6
839         %define %%sizeofreg sizeof%6
840     %elifid %5
841         %define %%sizeofreg sizeof%5
842     %else
843         %define %%sizeofreg mmsize
844     %endif
845     %if %%sizeofreg==32
846         %if %4>=3
847             v%1 %5, %6, %7
848         %else
849             v%1 %5, %6
850         %endif
851     %else
852         %if %%sizeofreg==8
853             %define %%regmov movq
854         %elif %2
855             %define %%regmov movaps
856         %else
857             %define %%regmov movdqa
858         %endif
859
860         %if %4>=3+%3
861             %ifnidn %5, %6
862                 %if avx_enabled && %%sizeofreg==16
863                     v%1 %5, %6, %7
864                 %else
865                     CHECK_AVX_INSTR_EMU {%1 %5, %6, %7}, %5, %7
866                     %%regmov %5, %6
867                     %1 %5, %7
868                 %endif
869             %else
870                 %1 %5, %7
871             %endif
872         %elif %4>=3
873             %1 %5, %6, %7
874         %else
875             %1 %5, %6
876         %endif
877     %endif
878 %endmacro
879
880 ; 3arg AVX ops with a memory arg can only have it in src2,
881 ; whereas SSE emulation of 3arg prefers to have it in src1 (i.e. the mov).
882 ; So, if the op is symmetric and the wrong one is memory, swap them.
883 %macro RUN_AVX_INSTR1 8
884     %assign %%swap 0
885     %if avx_enabled
886         %ifnid %6
887             %assign %%swap 1
888         %endif
889     %elifnidn %5, %6
890         %ifnid %7
891             %assign %%swap 1
892         %endif
893     %endif
894     %if %%swap && %3 == 0 && %8 == 1
895         RUN_AVX_INSTR %1, %2, %3, %4, %5, %7, %6
896     %else
897         RUN_AVX_INSTR %1, %2, %3, %4, %5, %6, %7
898     %endif
899 %endmacro
900
901 ;%1 == instruction
902 ;%2 == 1 if float, 0 if int
903 ;%3 == 1 if 4-operand (xmm, xmm, xmm, imm), 0 if 2- or 3-operand (xmm, xmm, xmm)
904 ;%4 == 1 if symmetric (i.e. doesn't matter which src arg is which), 0 if not
905 %macro AVX_INSTR 4
906     %macro %1 2-9 fnord, fnord, fnord, %1, %2, %3, %4
907         %ifidn %3, fnord
908             RUN_AVX_INSTR %6, %7, %8, 2, %1, %2
909         %elifidn %4, fnord
910             RUN_AVX_INSTR1 %6, %7, %8, 3, %1, %2, %3, %9
911         %elifidn %5, fnord
912             RUN_AVX_INSTR %6, %7, %8, 4, %1, %2, %3, %4
913         %else
914             RUN_AVX_INSTR %6, %7, %8, 5, %1, %2, %3, %4, %5
915         %endif
916     %endmacro
917 %endmacro
918
919 AVX_INSTR addpd, 1, 0, 1
920 AVX_INSTR addps, 1, 0, 1
921 AVX_INSTR addsd, 1, 0, 1
922 AVX_INSTR addss, 1, 0, 1
923 AVX_INSTR addsubpd, 1, 0, 0
924 AVX_INSTR addsubps, 1, 0, 0
925 AVX_INSTR andpd, 1, 0, 1
926 AVX_INSTR andps, 1, 0, 1
927 AVX_INSTR andnpd, 1, 0, 0
928 AVX_INSTR andnps, 1, 0, 0
929 AVX_INSTR blendpd, 1, 0, 0
930 AVX_INSTR blendps, 1, 0, 0
931 AVX_INSTR blendvpd, 1, 0, 0
932 AVX_INSTR blendvps, 1, 0, 0
933 AVX_INSTR cmppd, 1, 0, 0
934 AVX_INSTR cmpps, 1, 0, 0
935 AVX_INSTR cmpsd, 1, 0, 0
936 AVX_INSTR cmpss, 1, 0, 0
937 AVX_INSTR cvtdq2ps, 1, 0, 0
938 AVX_INSTR cvtps2dq, 1, 0, 0
939 AVX_INSTR divpd, 1, 0, 0
940 AVX_INSTR divps, 1, 0, 0
941 AVX_INSTR divsd, 1, 0, 0
942 AVX_INSTR divss, 1, 0, 0
943 AVX_INSTR dppd, 1, 1, 0
944 AVX_INSTR dpps, 1, 1, 0
945 AVX_INSTR haddpd, 1, 0, 0
946 AVX_INSTR haddps, 1, 0, 0
947 AVX_INSTR hsubpd, 1, 0, 0
948 AVX_INSTR hsubps, 1, 0, 0
949 AVX_INSTR maxpd, 1, 0, 1
950 AVX_INSTR maxps, 1, 0, 1
951 AVX_INSTR maxsd, 1, 0, 1
952 AVX_INSTR maxss, 1, 0, 1
953 AVX_INSTR minpd, 1, 0, 1
954 AVX_INSTR minps, 1, 0, 1
955 AVX_INSTR minsd, 1, 0, 1
956 AVX_INSTR minss, 1, 0, 1
957 AVX_INSTR movhlps, 1, 0, 0
958 AVX_INSTR movlhps, 1, 0, 0
959 AVX_INSTR movsd, 1, 0, 0
960 AVX_INSTR movss, 1, 0, 0
961 AVX_INSTR mpsadbw, 0, 1, 0
962 AVX_INSTR mulpd, 1, 0, 1
963 AVX_INSTR mulps, 1, 0, 1
964 AVX_INSTR mulsd, 1, 0, 1
965 AVX_INSTR mulss, 1, 0, 1
966 AVX_INSTR orpd, 1, 0, 1
967 AVX_INSTR orps, 1, 0, 1
968 AVX_INSTR pabsb, 0, 0, 0
969 AVX_INSTR pabsw, 0, 0, 0
970 AVX_INSTR pabsd, 0, 0, 0
971 AVX_INSTR packsswb, 0, 0, 0
972 AVX_INSTR packssdw, 0, 0, 0
973 AVX_INSTR packuswb, 0, 0, 0
974 AVX_INSTR packusdw, 0, 0, 0
975 AVX_INSTR paddb, 0, 0, 1
976 AVX_INSTR paddw, 0, 0, 1
977 AVX_INSTR paddd, 0, 0, 1
978 AVX_INSTR paddq, 0, 0, 1
979 AVX_INSTR paddsb, 0, 0, 1
980 AVX_INSTR paddsw, 0, 0, 1
981 AVX_INSTR paddusb, 0, 0, 1
982 AVX_INSTR paddusw, 0, 0, 1
983 AVX_INSTR palignr, 0, 1, 0
984 AVX_INSTR pand, 0, 0, 1
985 AVX_INSTR pandn, 0, 0, 0
986 AVX_INSTR pavgb, 0, 0, 1
987 AVX_INSTR pavgw, 0, 0, 1
988 AVX_INSTR pblendvb, 0, 0, 0
989 AVX_INSTR pblendw, 0, 1, 0
990 AVX_INSTR pcmpestri, 0, 0, 0
991 AVX_INSTR pcmpestrm, 0, 0, 0
992 AVX_INSTR pcmpistri, 0, 0, 0
993 AVX_INSTR pcmpistrm, 0, 0, 0
994 AVX_INSTR pcmpeqb, 0, 0, 1
995 AVX_INSTR pcmpeqw, 0, 0, 1
996 AVX_INSTR pcmpeqd, 0, 0, 1
997 AVX_INSTR pcmpeqq, 0, 0, 1
998 AVX_INSTR pcmpgtb, 0, 0, 0
999 AVX_INSTR pcmpgtw, 0, 0, 0
1000 AVX_INSTR pcmpgtd, 0, 0, 0
1001 AVX_INSTR pcmpgtq, 0, 0, 0
1002 AVX_INSTR phaddw, 0, 0, 0
1003 AVX_INSTR phaddd, 0, 0, 0
1004 AVX_INSTR phaddsw, 0, 0, 0
1005 AVX_INSTR phsubw, 0, 0, 0
1006 AVX_INSTR phsubd, 0, 0, 0
1007 AVX_INSTR phsubsw, 0, 0, 0
1008 AVX_INSTR pmaddwd, 0, 0, 1
1009 AVX_INSTR pmaddubsw, 0, 0, 0
1010 AVX_INSTR pmaxsb, 0, 0, 1
1011 AVX_INSTR pmaxsw, 0, 0, 1
1012 AVX_INSTR pmaxsd, 0, 0, 1
1013 AVX_INSTR pmaxub, 0, 0, 1
1014 AVX_INSTR pmaxuw, 0, 0, 1
1015 AVX_INSTR pmaxud, 0, 0, 1
1016 AVX_INSTR pminsb, 0, 0, 1
1017 AVX_INSTR pminsw, 0, 0, 1
1018 AVX_INSTR pminsd, 0, 0, 1
1019 AVX_INSTR pminub, 0, 0, 1
1020 AVX_INSTR pminuw, 0, 0, 1
1021 AVX_INSTR pminud, 0, 0, 1
1022 AVX_INSTR pmovmskb, 0, 0, 0
1023 AVX_INSTR pmulhuw, 0, 0, 1
1024 AVX_INSTR pmulhrsw, 0, 0, 1
1025 AVX_INSTR pmulhw, 0, 0, 1
1026 AVX_INSTR pmullw, 0, 0, 1
1027 AVX_INSTR pmulld, 0, 0, 1
1028 AVX_INSTR pmuludq, 0, 0, 1
1029 AVX_INSTR pmuldq, 0, 0, 1
1030 AVX_INSTR por, 0, 0, 1
1031 AVX_INSTR psadbw, 0, 0, 1
1032 AVX_INSTR pshufb, 0, 0, 0
1033 AVX_INSTR pshufd, 0, 1, 0
1034 AVX_INSTR pshufhw, 0, 1, 0
1035 AVX_INSTR pshuflw, 0, 1, 0
1036 AVX_INSTR psignb, 0, 0, 0
1037 AVX_INSTR psignw, 0, 0, 0
1038 AVX_INSTR psignd, 0, 0, 0
1039 AVX_INSTR psllw, 0, 0, 0
1040 AVX_INSTR pslld, 0, 0, 0
1041 AVX_INSTR psllq, 0, 0, 0
1042 AVX_INSTR pslldq, 0, 0, 0
1043 AVX_INSTR psraw, 0, 0, 0
1044 AVX_INSTR psrad, 0, 0, 0
1045 AVX_INSTR psrlw, 0, 0, 0
1046 AVX_INSTR psrld, 0, 0, 0
1047 AVX_INSTR psrlq, 0, 0, 0
1048 AVX_INSTR psrldq, 0, 0, 0
1049 AVX_INSTR psubb, 0, 0, 0
1050 AVX_INSTR psubw, 0, 0, 0
1051 AVX_INSTR psubd, 0, 0, 0
1052 AVX_INSTR psubq, 0, 0, 0
1053 AVX_INSTR psubsb, 0, 0, 0
1054 AVX_INSTR psubsw, 0, 0, 0
1055 AVX_INSTR psubusb, 0, 0, 0
1056 AVX_INSTR psubusw, 0, 0, 0
1057 AVX_INSTR ptest, 0, 0, 0
1058 AVX_INSTR punpckhbw, 0, 0, 0
1059 AVX_INSTR punpckhwd, 0, 0, 0
1060 AVX_INSTR punpckhdq, 0, 0, 0
1061 AVX_INSTR punpckhqdq, 0, 0, 0
1062 AVX_INSTR punpcklbw, 0, 0, 0
1063 AVX_INSTR punpcklwd, 0, 0, 0
1064 AVX_INSTR punpckldq, 0, 0, 0
1065 AVX_INSTR punpcklqdq, 0, 0, 0
1066 AVX_INSTR pxor, 0, 0, 1
1067 AVX_INSTR shufps, 1, 1, 0
1068 AVX_INSTR subpd, 1, 0, 0
1069 AVX_INSTR subps, 1, 0, 0
1070 AVX_INSTR subsd, 1, 0, 0
1071 AVX_INSTR subss, 1, 0, 0
1072 AVX_INSTR unpckhpd, 1, 0, 0
1073 AVX_INSTR unpckhps, 1, 0, 0
1074 AVX_INSTR unpcklpd, 1, 0, 0
1075 AVX_INSTR unpcklps, 1, 0, 0
1076 AVX_INSTR xorpd, 1, 0, 1
1077 AVX_INSTR xorps, 1, 0, 1
1078
1079 ; 3DNow instructions, for sharing code between AVX, SSE and 3DN
1080 AVX_INSTR pfadd, 1, 0, 1
1081 AVX_INSTR pfsub, 1, 0, 0
1082 AVX_INSTR pfmul, 1, 0, 1
1083
1084 ; base-4 constants for shuffles
1085 %assign i 0
1086 %rep 256
1087     %assign j ((i>>6)&3)*1000 + ((i>>4)&3)*100 + ((i>>2)&3)*10 + (i&3)
1088     %if j < 10
1089         CAT_XDEFINE q000, j, i
1090     %elif j < 100
1091         CAT_XDEFINE q00, j, i
1092     %elif j < 1000
1093         CAT_XDEFINE q0, j, i
1094     %else
1095         CAT_XDEFINE q, j, i
1096     %endif
1097 %assign i i+1
1098 %endrep
1099 %undef i
1100 %undef j
1101
1102 %macro FMA_INSTR 3
1103     %macro %1 4-7 %1, %2, %3
1104         %if cpuflag(xop)
1105             v%5 %1, %2, %3, %4
1106         %else
1107             %6 %1, %2, %3
1108             %7 %1, %4
1109         %endif
1110     %endmacro
1111 %endmacro
1112
1113 FMA_INSTR  pmacsdd,  pmulld, paddd
1114 FMA_INSTR  pmacsww,  pmullw, paddw
1115 FMA_INSTR pmadcswd, pmaddwd, paddd
1116
1117 ; tzcnt is equivalent to "rep bsf" and is backwards-compatible with bsf.
1118 ; This lets us use tzcnt without bumping the yasm version requirement yet.
1119 %define tzcnt rep bsf