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