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