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