x86inc: Remove argument from WIN64_RESTORE_XMM
[ffmpeg.git] / libavutil / x86 / x86inc.asm
1 ;*****************************************************************************
2 ;* x86inc.asm: x264asm abstraction layer
3 ;*****************************************************************************
4 ;* Copyright (C) 2005-2017 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 <henrik@gramner.com>
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 private_prefix
38     %define private_prefix x264
39 %endif
40
41 %ifndef public_prefix
42     %define public_prefix private_prefix
43 %endif
44
45 %if HAVE_ALIGNED_STACK
46     %define STACK_ALIGNMENT 16
47 %endif
48 %ifndef STACK_ALIGNMENT
49     %if ARCH_X86_64
50         %define STACK_ALIGNMENT 16
51     %else
52         %define STACK_ALIGNMENT 4
53     %endif
54 %endif
55
56 %define WIN64  0
57 %define UNIX64 0
58 %if ARCH_X86_64
59     %ifidn __OUTPUT_FORMAT__,win32
60         %define WIN64  1
61     %elifidn __OUTPUT_FORMAT__,win64
62         %define WIN64  1
63     %elifidn __OUTPUT_FORMAT__,x64
64         %define WIN64  1
65     %else
66         %define UNIX64 1
67     %endif
68 %endif
69
70 %define FORMAT_ELF 0
71 %ifidn __OUTPUT_FORMAT__,elf
72     %define FORMAT_ELF 1
73 %elifidn __OUTPUT_FORMAT__,elf32
74     %define FORMAT_ELF 1
75 %elifidn __OUTPUT_FORMAT__,elf64
76     %define FORMAT_ELF 1
77 %endif
78
79 %ifdef PREFIX
80     %define mangle(x) _ %+ x
81 %else
82     %define mangle(x) x
83 %endif
84
85 ; aout does not support align=
86 ; NOTE: This section is out of sync with x264, in order to
87 ; keep supporting OS/2.
88 %macro SECTION_RODATA 0-1 16
89     %ifidn __OUTPUT_FORMAT__,aout
90         section .text
91     %else
92         SECTION .rodata align=%1
93     %endif
94 %endmacro
95
96 %if WIN64
97     %define PIC
98 %elif ARCH_X86_64 == 0
99 ; x86_32 doesn't require PIC.
100 ; Some distros prefer shared objects to be PIC, but nothing breaks if
101 ; the code contains a few textrels, so we'll skip that complexity.
102     %undef PIC
103 %endif
104 %ifdef PIC
105     default rel
106 %endif
107
108 %macro CPUNOP 1
109     %if HAVE_CPUNOP
110         CPU %1
111     %endif
112 %endmacro
113
114 ; Macros to eliminate most code duplication between x86_32 and x86_64:
115 ; Currently this works only for leaf functions which load all their arguments
116 ; into registers at the start, and make no other use of the stack. Luckily that
117 ; covers most of x264's asm.
118
119 ; PROLOGUE:
120 ; %1 = number of arguments. loads them from stack if needed.
121 ; %2 = number of registers used. pushes callee-saved regs if needed.
122 ; %3 = number of xmm registers used. pushes callee-saved xmm regs if needed.
123 ; %4 = (optional) stack size to be allocated. The stack will be aligned before
124 ;      allocating the specified stack size. If the required stack alignment is
125 ;      larger than the known stack alignment the stack will be manually aligned
126 ;      and an extra register will be allocated to hold the original stack
127 ;      pointer (to not invalidate r0m etc.). To prevent the use of an extra
128 ;      register as stack pointer, request a negative stack size.
129 ; %4+/%5+ = list of names to define to registers
130 ; PROLOGUE can also be invoked by adding the same options to cglobal
131
132 ; e.g.
133 ; cglobal foo, 2,3,7,0x40, dst, src, tmp
134 ; declares a function (foo) that automatically loads two arguments (dst and
135 ; src) into registers, uses one additional register (tmp) plus 7 vector
136 ; registers (m0-m6) and allocates 0x40 bytes of stack space.
137
138 ; TODO Some functions can use some args directly from the stack. If they're the
139 ; last args then you can just not declare them, but if they're in the middle
140 ; we need more flexible macro.
141
142 ; RET:
143 ; Pops anything that was pushed by PROLOGUE, and returns.
144
145 ; REP_RET:
146 ; Use this instead of RET if it's a branch target.
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 ; rNh is the high 8 bits of the word size
152 ; rNm is the original location of arg N (a register or on the stack), dword
153 ; rNmp is native size
154
155 %macro DECLARE_REG 2-3
156     %define r%1q %2
157     %define r%1d %2d
158     %define r%1w %2w
159     %define r%1b %2b
160     %define r%1h %2h
161     %define %2q %2
162     %if %0 == 2
163         %define r%1m  %2d
164         %define r%1mp %2
165     %elif ARCH_X86_64 ; memory
166         %define r%1m [rstk + stack_offset + %3]
167         %define r%1mp qword r %+ %1 %+ m
168     %else
169         %define r%1m [rstk + stack_offset + %3]
170         %define r%1mp dword r %+ %1 %+ m
171     %endif
172     %define r%1  %2
173 %endmacro
174
175 %macro DECLARE_REG_SIZE 3
176     %define r%1q r%1
177     %define e%1q r%1
178     %define r%1d e%1
179     %define e%1d e%1
180     %define r%1w %1
181     %define e%1w %1
182     %define r%1h %3
183     %define e%1h %3
184     %define r%1b %2
185     %define e%1b %2
186     %if ARCH_X86_64 == 0
187         %define r%1 e%1
188     %endif
189 %endmacro
190
191 DECLARE_REG_SIZE ax, al, ah
192 DECLARE_REG_SIZE bx, bl, bh
193 DECLARE_REG_SIZE cx, cl, ch
194 DECLARE_REG_SIZE dx, dl, dh
195 DECLARE_REG_SIZE si, sil, null
196 DECLARE_REG_SIZE di, dil, null
197 DECLARE_REG_SIZE bp, bpl, null
198
199 ; t# defines for when per-arch register allocation is more complex than just function arguments
200
201 %macro DECLARE_REG_TMP 1-*
202     %assign %%i 0
203     %rep %0
204         CAT_XDEFINE t, %%i, r%1
205         %assign %%i %%i+1
206         %rotate 1
207     %endrep
208 %endmacro
209
210 %macro DECLARE_REG_TMP_SIZE 0-*
211     %rep %0
212         %define t%1q t%1 %+ q
213         %define t%1d t%1 %+ d
214         %define t%1w t%1 %+ w
215         %define t%1h t%1 %+ h
216         %define t%1b t%1 %+ b
217         %rotate 1
218     %endrep
219 %endmacro
220
221 DECLARE_REG_TMP_SIZE 0,1,2,3,4,5,6,7,8,9,10,11,12,13,14
222
223 %if ARCH_X86_64
224     %define gprsize 8
225 %else
226     %define gprsize 4
227 %endif
228
229 %macro PUSH 1
230     push %1
231     %ifidn rstk, rsp
232         %assign stack_offset stack_offset+gprsize
233     %endif
234 %endmacro
235
236 %macro POP 1
237     pop %1
238     %ifidn rstk, rsp
239         %assign stack_offset stack_offset-gprsize
240     %endif
241 %endmacro
242
243 %macro PUSH_IF_USED 1-*
244     %rep %0
245         %if %1 < regs_used
246             PUSH r%1
247         %endif
248         %rotate 1
249     %endrep
250 %endmacro
251
252 %macro POP_IF_USED 1-*
253     %rep %0
254         %if %1 < regs_used
255             pop r%1
256         %endif
257         %rotate 1
258     %endrep
259 %endmacro
260
261 %macro LOAD_IF_USED 1-*
262     %rep %0
263         %if %1 < num_args
264             mov r%1, r %+ %1 %+ mp
265         %endif
266         %rotate 1
267     %endrep
268 %endmacro
269
270 %macro SUB 2
271     sub %1, %2
272     %ifidn %1, rstk
273         %assign stack_offset stack_offset+(%2)
274     %endif
275 %endmacro
276
277 %macro ADD 2
278     add %1, %2
279     %ifidn %1, rstk
280         %assign stack_offset stack_offset-(%2)
281     %endif
282 %endmacro
283
284 %macro movifnidn 2
285     %ifnidn %1, %2
286         mov %1, %2
287     %endif
288 %endmacro
289
290 %macro movsxdifnidn 2
291     %ifnidn %1, %2
292         movsxd %1, %2
293     %endif
294 %endmacro
295
296 %macro ASSERT 1
297     %if (%1) == 0
298         %error assertion ``%1'' failed
299     %endif
300 %endmacro
301
302 %macro DEFINE_ARGS 0-*
303     %ifdef n_arg_names
304         %assign %%i 0
305         %rep n_arg_names
306             CAT_UNDEF arg_name %+ %%i, q
307             CAT_UNDEF arg_name %+ %%i, d
308             CAT_UNDEF arg_name %+ %%i, w
309             CAT_UNDEF arg_name %+ %%i, h
310             CAT_UNDEF arg_name %+ %%i, b
311             CAT_UNDEF arg_name %+ %%i, m
312             CAT_UNDEF arg_name %+ %%i, mp
313             CAT_UNDEF arg_name, %%i
314             %assign %%i %%i+1
315         %endrep
316     %endif
317
318     %xdefine %%stack_offset stack_offset
319     %undef stack_offset ; so that the current value of stack_offset doesn't get baked in by xdefine
320     %assign %%i 0
321     %rep %0
322         %xdefine %1q r %+ %%i %+ q
323         %xdefine %1d r %+ %%i %+ d
324         %xdefine %1w r %+ %%i %+ w
325         %xdefine %1h r %+ %%i %+ h
326         %xdefine %1b r %+ %%i %+ b
327         %xdefine %1m r %+ %%i %+ m
328         %xdefine %1mp r %+ %%i %+ mp
329         CAT_XDEFINE arg_name, %%i, %1
330         %assign %%i %%i+1
331         %rotate 1
332     %endrep
333     %xdefine stack_offset %%stack_offset
334     %assign n_arg_names %0
335 %endmacro
336
337 %define required_stack_alignment ((mmsize + 15) & ~15)
338
339 %macro ALLOC_STACK 1-2 0 ; stack_size, n_xmm_regs (for win64 only)
340     %ifnum %1
341         %if %1 != 0
342             %assign %%pad 0
343             %assign stack_size %1
344             %if stack_size < 0
345                 %assign stack_size -stack_size
346             %endif
347             %if WIN64
348                 %assign %%pad %%pad + 32 ; shadow space
349                 %if mmsize != 8
350                     %assign xmm_regs_used %2
351                     %if xmm_regs_used > 8
352                         %assign %%pad %%pad + (xmm_regs_used-8)*16 ; callee-saved xmm registers
353                     %endif
354                 %endif
355             %endif
356             %if required_stack_alignment <= STACK_ALIGNMENT
357                 ; maintain the current stack alignment
358                 %assign stack_size_padded stack_size + %%pad + ((-%%pad-stack_offset-gprsize) & (STACK_ALIGNMENT-1))
359                 SUB rsp, stack_size_padded
360             %else
361                 %assign %%reg_num (regs_used - 1)
362                 %xdefine rstk r %+ %%reg_num
363                 ; align stack, and save original stack location directly above
364                 ; it, i.e. in [rsp+stack_size_padded], so we can restore the
365                 ; stack in a single instruction (i.e. mov rsp, rstk or mov
366                 ; rsp, [rsp+stack_size_padded])
367                 %if %1 < 0 ; need to store rsp on stack
368                     %xdefine rstkm [rsp + stack_size + %%pad]
369                     %assign %%pad %%pad + gprsize
370                 %else ; can keep rsp in rstk during whole function
371                     %xdefine rstkm rstk
372                 %endif
373                 %assign stack_size_padded stack_size + ((%%pad + required_stack_alignment-1) & ~(required_stack_alignment-1))
374                 mov rstk, rsp
375                 and rsp, ~(required_stack_alignment-1)
376                 sub rsp, stack_size_padded
377                 movifnidn rstkm, rstk
378             %endif
379             WIN64_PUSH_XMM
380         %endif
381     %endif
382 %endmacro
383
384 %macro SETUP_STACK_POINTER 1
385     %ifnum %1
386         %if %1 != 0 && required_stack_alignment > STACK_ALIGNMENT
387             %if %1 > 0
388                 ; Reserve an additional register for storing the original stack pointer, but avoid using
389                 ; eax/rax for this purpose since it can potentially get overwritten as a return value.
390                 %assign regs_used (regs_used + 1)
391                 %if ARCH_X86_64 && regs_used == 7
392                     %assign regs_used 8
393                 %elif ARCH_X86_64 == 0 && regs_used == 1
394                     %assign regs_used 2
395                 %endif
396             %endif
397             %if ARCH_X86_64 && regs_used < 5 + UNIX64 * 3
398                 ; Ensure that we don't clobber any registers containing arguments. For UNIX64 we also preserve r6 (rax)
399                 ; since it's used as a hidden argument in vararg functions to specify the number of vector registers used.
400                 %assign regs_used 5 + UNIX64 * 3
401             %endif
402         %endif
403     %endif
404 %endmacro
405
406 %macro DEFINE_ARGS_INTERNAL 3+
407     %ifnum %2
408         DEFINE_ARGS %3
409     %elif %1 == 4
410         DEFINE_ARGS %2
411     %elif %1 > 4
412         DEFINE_ARGS %2, %3
413     %endif
414 %endmacro
415
416 %if WIN64 ; Windows x64 ;=================================================
417
418 DECLARE_REG 0,  rcx
419 DECLARE_REG 1,  rdx
420 DECLARE_REG 2,  R8
421 DECLARE_REG 3,  R9
422 DECLARE_REG 4,  R10, 40
423 DECLARE_REG 5,  R11, 48
424 DECLARE_REG 6,  rax, 56
425 DECLARE_REG 7,  rdi, 64
426 DECLARE_REG 8,  rsi, 72
427 DECLARE_REG 9,  rbx, 80
428 DECLARE_REG 10, rbp, 88
429 DECLARE_REG 11, R14, 96
430 DECLARE_REG 12, R15, 104
431 DECLARE_REG 13, R12, 112
432 DECLARE_REG 14, R13, 120
433
434 %macro PROLOGUE 2-5+ 0 ; #args, #regs, #xmm_regs, [stack_size,] arg_names...
435     %assign num_args %1
436     %assign regs_used %2
437     ASSERT regs_used >= num_args
438     SETUP_STACK_POINTER %4
439     ASSERT regs_used <= 15
440     PUSH_IF_USED 7, 8, 9, 10, 11, 12, 13, 14
441     ALLOC_STACK %4, %3
442     %if mmsize != 8 && stack_size == 0
443         WIN64_SPILL_XMM %3
444     %endif
445     LOAD_IF_USED 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14
446     DEFINE_ARGS_INTERNAL %0, %4, %5
447 %endmacro
448
449 %macro WIN64_PUSH_XMM 0
450     ; Use the shadow space to store XMM6 and XMM7, the rest needs stack space allocated.
451     %if xmm_regs_used > 6
452         movaps [rstk + stack_offset +  8], xmm6
453     %endif
454     %if xmm_regs_used > 7
455         movaps [rstk + stack_offset + 24], xmm7
456     %endif
457     %if xmm_regs_used > 8
458         %assign %%i 8
459         %rep xmm_regs_used-8
460             movaps [rsp + (%%i-8)*16 + stack_size + 32], xmm %+ %%i
461             %assign %%i %%i+1
462         %endrep
463     %endif
464 %endmacro
465
466 %macro WIN64_SPILL_XMM 1
467     %assign xmm_regs_used %1
468     ASSERT xmm_regs_used <= 16
469     %if xmm_regs_used > 8
470         ; Allocate stack space for callee-saved xmm registers plus shadow space and align the stack.
471         %assign %%pad (xmm_regs_used-8)*16 + 32
472         %assign stack_size_padded %%pad + ((-%%pad-stack_offset-gprsize) & (STACK_ALIGNMENT-1))
473         SUB rsp, stack_size_padded
474     %endif
475     WIN64_PUSH_XMM
476 %endmacro
477
478 %macro WIN64_RESTORE_XMM_INTERNAL 0
479     %assign %%pad_size 0
480     %if xmm_regs_used > 8
481         %assign %%i xmm_regs_used
482         %rep xmm_regs_used-8
483             %assign %%i %%i-1
484             movaps xmm %+ %%i, [rsp + (%%i-8)*16 + stack_size + 32]
485         %endrep
486     %endif
487     %if stack_size_padded > 0
488         %if stack_size > 0 && required_stack_alignment > STACK_ALIGNMENT
489             mov rsp, rstkm
490         %else
491             add rsp, stack_size_padded
492             %assign %%pad_size stack_size_padded
493         %endif
494     %endif
495     %if xmm_regs_used > 7
496         movaps xmm7, [rsp + stack_offset - %%pad_size + 24]
497     %endif
498     %if xmm_regs_used > 6
499         movaps xmm6, [rsp + stack_offset - %%pad_size +  8]
500     %endif
501 %endmacro
502
503 %macro WIN64_RESTORE_XMM 0
504     WIN64_RESTORE_XMM_INTERNAL
505     %assign stack_offset (stack_offset-stack_size_padded)
506     %assign stack_size_padded 0
507     %assign xmm_regs_used 0
508 %endmacro
509
510 %define has_epilogue regs_used > 7 || xmm_regs_used > 6 || mmsize == 32 || stack_size > 0
511
512 %macro RET 0
513     WIN64_RESTORE_XMM_INTERNAL
514     POP_IF_USED 14, 13, 12, 11, 10, 9, 8, 7
515     %if mmsize == 32
516         vzeroupper
517     %endif
518     AUTO_REP_RET
519 %endmacro
520
521 %elif ARCH_X86_64 ; *nix x64 ;=============================================
522
523 DECLARE_REG 0,  rdi
524 DECLARE_REG 1,  rsi
525 DECLARE_REG 2,  rdx
526 DECLARE_REG 3,  rcx
527 DECLARE_REG 4,  R8
528 DECLARE_REG 5,  R9
529 DECLARE_REG 6,  rax, 8
530 DECLARE_REG 7,  R10, 16
531 DECLARE_REG 8,  R11, 24
532 DECLARE_REG 9,  rbx, 32
533 DECLARE_REG 10, rbp, 40
534 DECLARE_REG 11, R14, 48
535 DECLARE_REG 12, R15, 56
536 DECLARE_REG 13, R12, 64
537 DECLARE_REG 14, R13, 72
538
539 %macro PROLOGUE 2-5+ ; #args, #regs, #xmm_regs, [stack_size,] arg_names...
540     %assign num_args %1
541     %assign regs_used %2
542     ASSERT regs_used >= num_args
543     SETUP_STACK_POINTER %4
544     ASSERT regs_used <= 15
545     PUSH_IF_USED 9, 10, 11, 12, 13, 14
546     ALLOC_STACK %4
547     LOAD_IF_USED 6, 7, 8, 9, 10, 11, 12, 13, 14
548     DEFINE_ARGS_INTERNAL %0, %4, %5
549 %endmacro
550
551 %define has_epilogue regs_used > 9 || mmsize == 32 || stack_size > 0
552
553 %macro RET 0
554     %if stack_size_padded > 0
555         %if required_stack_alignment > STACK_ALIGNMENT
556             mov rsp, rstkm
557         %else
558             add rsp, stack_size_padded
559         %endif
560     %endif
561     POP_IF_USED 14, 13, 12, 11, 10, 9
562     %if mmsize == 32
563         vzeroupper
564     %endif
565     AUTO_REP_RET
566 %endmacro
567
568 %else ; X86_32 ;==============================================================
569
570 DECLARE_REG 0, eax, 4
571 DECLARE_REG 1, ecx, 8
572 DECLARE_REG 2, edx, 12
573 DECLARE_REG 3, ebx, 16
574 DECLARE_REG 4, esi, 20
575 DECLARE_REG 5, edi, 24
576 DECLARE_REG 6, ebp, 28
577 %define rsp esp
578
579 %macro DECLARE_ARG 1-*
580     %rep %0
581         %define r%1m [rstk + stack_offset + 4*%1 + 4]
582         %define r%1mp dword r%1m
583         %rotate 1
584     %endrep
585 %endmacro
586
587 DECLARE_ARG 7, 8, 9, 10, 11, 12, 13, 14
588
589 %macro PROLOGUE 2-5+ ; #args, #regs, #xmm_regs, [stack_size,] arg_names...
590     %assign num_args %1
591     %assign regs_used %2
592     ASSERT regs_used >= num_args
593     %if num_args > 7
594         %assign num_args 7
595     %endif
596     %if regs_used > 7
597         %assign regs_used 7
598     %endif
599     SETUP_STACK_POINTER %4
600     ASSERT regs_used <= 7
601     PUSH_IF_USED 3, 4, 5, 6
602     ALLOC_STACK %4
603     LOAD_IF_USED 0, 1, 2, 3, 4, 5, 6
604     DEFINE_ARGS_INTERNAL %0, %4, %5
605 %endmacro
606
607 %define has_epilogue regs_used > 3 || mmsize == 32 || stack_size > 0
608
609 %macro RET 0
610     %if stack_size_padded > 0
611         %if required_stack_alignment > STACK_ALIGNMENT
612             mov rsp, rstkm
613         %else
614             add rsp, stack_size_padded
615         %endif
616     %endif
617     POP_IF_USED 6, 5, 4, 3
618     %if mmsize == 32
619         vzeroupper
620     %endif
621     AUTO_REP_RET
622 %endmacro
623
624 %endif ;======================================================================
625
626 %if WIN64 == 0
627     %macro WIN64_SPILL_XMM 1
628     %endmacro
629     %macro WIN64_RESTORE_XMM 0
630     %endmacro
631     %macro WIN64_PUSH_XMM 0
632     %endmacro
633 %endif
634
635 ; On AMD cpus <=K10, an ordinary ret is slow if it immediately follows either
636 ; a branch or a branch target. So switch to a 2-byte form of ret in that case.
637 ; We can automatically detect "follows a branch", but not a branch target.
638 ; (SSSE3 is a sufficient condition to know that your cpu doesn't have this problem.)
639 %macro REP_RET 0
640     %if has_epilogue || cpuflag(ssse3)
641         RET
642     %else
643         rep ret
644     %endif
645     annotate_function_size
646 %endmacro
647
648 %define last_branch_adr $$
649 %macro AUTO_REP_RET 0
650     %if notcpuflag(ssse3)
651         times ((last_branch_adr-$)>>31)+1 rep ; times 1 iff $ == last_branch_adr.
652     %endif
653     ret
654     annotate_function_size
655 %endmacro
656
657 %macro BRANCH_INSTR 0-*
658     %rep %0
659         %macro %1 1-2 %1
660             %2 %1
661             %if notcpuflag(ssse3)
662                 %%branch_instr equ $
663                 %xdefine last_branch_adr %%branch_instr
664             %endif
665         %endmacro
666         %rotate 1
667     %endrep
668 %endmacro
669
670 BRANCH_INSTR jz, je, jnz, jne, jl, jle, jnl, jnle, jg, jge, jng, jnge, ja, jae, jna, jnae, jb, jbe, jnb, jnbe, jc, jnc, js, jns, jo, jno, jp, jnp
671
672 %macro TAIL_CALL 2 ; callee, is_nonadjacent
673     %if has_epilogue
674         call %1
675         RET
676     %elif %2
677         jmp %1
678     %endif
679     annotate_function_size
680 %endmacro
681
682 ;=============================================================================
683 ; arch-independent part
684 ;=============================================================================
685
686 %assign function_align 16
687
688 ; Begin a function.
689 ; Applies any symbol mangling needed for C linkage, and sets up a define such that
690 ; subsequent uses of the function name automatically refer to the mangled version.
691 ; Appends cpuflags to the function name if cpuflags has been specified.
692 ; The "" empty default parameter is a workaround for nasm, which fails if SUFFIX
693 ; is empty and we call cglobal_internal with just %1 %+ SUFFIX (without %2).
694 %macro cglobal 1-2+ "" ; name, [PROLOGUE args]
695     cglobal_internal 1, %1 %+ SUFFIX, %2
696 %endmacro
697 %macro cvisible 1-2+ "" ; name, [PROLOGUE args]
698     cglobal_internal 0, %1 %+ SUFFIX, %2
699 %endmacro
700 %macro cglobal_internal 2-3+
701     annotate_function_size
702     %if %1
703         %xdefine %%FUNCTION_PREFIX private_prefix
704         %xdefine %%VISIBILITY hidden
705     %else
706         %xdefine %%FUNCTION_PREFIX public_prefix
707         %xdefine %%VISIBILITY
708     %endif
709     %ifndef cglobaled_%2
710         %xdefine %2 mangle(%%FUNCTION_PREFIX %+ _ %+ %2)
711         %xdefine %2.skip_prologue %2 %+ .skip_prologue
712         CAT_XDEFINE cglobaled_, %2, 1
713     %endif
714     %xdefine current_function %2
715     %xdefine current_function_section __SECT__
716     %if FORMAT_ELF
717         global %2:function %%VISIBILITY
718     %else
719         global %2
720     %endif
721     align function_align
722     %2:
723     RESET_MM_PERMUTATION        ; needed for x86-64, also makes disassembly somewhat nicer
724     %xdefine rstk rsp           ; copy of the original stack pointer, used when greater alignment than the known stack alignment is required
725     %assign stack_offset 0      ; stack pointer offset relative to the return address
726     %assign stack_size 0        ; amount of stack space that can be freely used inside a function
727     %assign stack_size_padded 0 ; total amount of allocated stack space, including space for callee-saved xmm registers on WIN64 and alignment padding
728     %assign xmm_regs_used 0     ; number of XMM registers requested, used for dealing with callee-saved registers on WIN64
729     %ifnidn %3, ""
730         PROLOGUE %3
731     %endif
732 %endmacro
733
734 %macro cextern 1
735     %xdefine %1 mangle(private_prefix %+ _ %+ %1)
736     CAT_XDEFINE cglobaled_, %1, 1
737     extern %1
738 %endmacro
739
740 ; like cextern, but without the prefix
741 %macro cextern_naked 1
742     %ifdef PREFIX
743         %xdefine %1 mangle(%1)
744     %endif
745     CAT_XDEFINE cglobaled_, %1, 1
746     extern %1
747 %endmacro
748
749 %macro const 1-2+
750     %xdefine %1 mangle(private_prefix %+ _ %+ %1)
751     %if FORMAT_ELF
752         global %1:data hidden
753     %else
754         global %1
755     %endif
756     %1: %2
757 %endmacro
758
759 ; This is needed for ELF, otherwise the GNU linker assumes the stack is executable by default.
760 %if FORMAT_ELF
761     [SECTION .note.GNU-stack noalloc noexec nowrite progbits]
762 %endif
763
764 ; Tell debuggers how large the function was.
765 ; This may be invoked multiple times per function; we rely on later instances overriding earlier ones.
766 ; This is invoked by RET and similar macros, and also cglobal does it for the previous function,
767 ; but if the last function in a source file doesn't use any of the standard macros for its epilogue,
768 ; then its size might be unspecified.
769 %macro annotate_function_size 0
770     %ifdef __YASM_VER__
771         %ifdef current_function
772             %if FORMAT_ELF
773                 current_function_section
774                 %%ecf equ $
775                 size current_function %%ecf - current_function
776                 __SECT__
777             %endif
778         %endif
779     %endif
780 %endmacro
781
782 ; cpuflags
783
784 %assign cpuflags_mmx      (1<<0)
785 %assign cpuflags_mmx2     (1<<1) | cpuflags_mmx
786 %assign cpuflags_3dnow    (1<<2) | cpuflags_mmx
787 %assign cpuflags_3dnowext (1<<3) | cpuflags_3dnow
788 %assign cpuflags_sse      (1<<4) | cpuflags_mmx2
789 %assign cpuflags_sse2     (1<<5) | cpuflags_sse
790 %assign cpuflags_sse2slow (1<<6) | cpuflags_sse2
791 %assign cpuflags_sse3     (1<<7) | cpuflags_sse2
792 %assign cpuflags_ssse3    (1<<8) | cpuflags_sse3
793 %assign cpuflags_sse4     (1<<9) | cpuflags_ssse3
794 %assign cpuflags_sse42    (1<<10)| cpuflags_sse4
795 %assign cpuflags_avx      (1<<11)| cpuflags_sse42
796 %assign cpuflags_xop      (1<<12)| cpuflags_avx
797 %assign cpuflags_fma4     (1<<13)| cpuflags_avx
798 %assign cpuflags_fma3     (1<<14)| cpuflags_avx
799 %assign cpuflags_avx2     (1<<15)| cpuflags_fma3
800
801 %assign cpuflags_cache32  (1<<16)
802 %assign cpuflags_cache64  (1<<17)
803 %assign cpuflags_slowctz  (1<<18)
804 %assign cpuflags_lzcnt    (1<<19)
805 %assign cpuflags_aligned  (1<<20) ; not a cpu feature, but a function variant
806 %assign cpuflags_atom     (1<<21)
807 %assign cpuflags_bmi1     (1<<22)|cpuflags_lzcnt
808 %assign cpuflags_bmi2     (1<<23)|cpuflags_bmi1
809 %assign cpuflags_aesni    (1<<24)|cpuflags_sse42
810
811 ; Returns a boolean value expressing whether or not the specified cpuflag is enabled.
812 %define    cpuflag(x) (((((cpuflags & (cpuflags_ %+ x)) ^ (cpuflags_ %+ x)) - 1) >> 31) & 1)
813 %define notcpuflag(x) (cpuflag(x) ^ 1)
814
815 ; Takes an arbitrary number of cpuflags from the above list.
816 ; All subsequent functions (up to the next INIT_CPUFLAGS) is built for the specified cpu.
817 ; You shouldn't need to invoke this macro directly, it's a subroutine for INIT_MMX &co.
818 %macro INIT_CPUFLAGS 0-*
819     %xdefine SUFFIX
820     %undef cpuname
821     %assign cpuflags 0
822
823     %if %0 >= 1
824         %rep %0
825             %ifdef cpuname
826                 %xdefine cpuname cpuname %+ _%1
827             %else
828                 %xdefine cpuname %1
829             %endif
830             %assign cpuflags cpuflags | cpuflags_%1
831             %rotate 1
832         %endrep
833         %xdefine SUFFIX _ %+ cpuname
834
835         %if cpuflag(avx)
836             %assign avx_enabled 1
837         %endif
838         %if (mmsize == 16 && notcpuflag(sse2)) || (mmsize == 32 && notcpuflag(avx2))
839             %define mova movaps
840             %define movu movups
841             %define movnta movntps
842         %endif
843         %if cpuflag(aligned)
844             %define movu mova
845         %elif cpuflag(sse3) && notcpuflag(ssse3)
846             %define movu lddqu
847         %endif
848     %endif
849
850     %if ARCH_X86_64 || cpuflag(sse2)
851         CPUNOP amdnop
852     %else
853         CPUNOP basicnop
854     %endif
855 %endmacro
856
857 ; Merge mmx and sse*
858 ; m# is a simd register of the currently selected size
859 ; xm# is the corresponding xmm register if mmsize >= 16, otherwise the same as m#
860 ; ym# is the corresponding ymm register if mmsize >= 32, otherwise the same as m#
861 ; (All 3 remain in sync through SWAP.)
862
863 %macro CAT_XDEFINE 3
864     %xdefine %1%2 %3
865 %endmacro
866
867 %macro CAT_UNDEF 2
868     %undef %1%2
869 %endmacro
870
871 %macro INIT_MMX 0-1+
872     %assign avx_enabled 0
873     %define RESET_MM_PERMUTATION INIT_MMX %1
874     %define mmsize 8
875     %define num_mmregs 8
876     %define mova movq
877     %define movu movq
878     %define movh movd
879     %define movnta movntq
880     %assign %%i 0
881     %rep 8
882         CAT_XDEFINE m, %%i, mm %+ %%i
883         CAT_XDEFINE nnmm, %%i, %%i
884         %assign %%i %%i+1
885     %endrep
886     %rep 8
887         CAT_UNDEF m, %%i
888         CAT_UNDEF nnmm, %%i
889         %assign %%i %%i+1
890     %endrep
891     INIT_CPUFLAGS %1
892 %endmacro
893
894 %macro INIT_XMM 0-1+
895     %assign avx_enabled 0
896     %define RESET_MM_PERMUTATION INIT_XMM %1
897     %define mmsize 16
898     %define num_mmregs 8
899     %if ARCH_X86_64
900         %define num_mmregs 16
901     %endif
902     %define mova movdqa
903     %define movu movdqu
904     %define movh movq
905     %define movnta movntdq
906     %assign %%i 0
907     %rep num_mmregs
908         CAT_XDEFINE m, %%i, xmm %+ %%i
909         CAT_XDEFINE nnxmm, %%i, %%i
910         %assign %%i %%i+1
911     %endrep
912     INIT_CPUFLAGS %1
913 %endmacro
914
915 %macro INIT_YMM 0-1+
916     %assign avx_enabled 1
917     %define RESET_MM_PERMUTATION INIT_YMM %1
918     %define mmsize 32
919     %define num_mmregs 8
920     %if ARCH_X86_64
921         %define num_mmregs 16
922     %endif
923     %define mova movdqa
924     %define movu movdqu
925     %undef movh
926     %define movnta movntdq
927     %assign %%i 0
928     %rep num_mmregs
929         CAT_XDEFINE m, %%i, ymm %+ %%i
930         CAT_XDEFINE nnymm, %%i, %%i
931         %assign %%i %%i+1
932     %endrep
933     INIT_CPUFLAGS %1
934 %endmacro
935
936 INIT_XMM
937
938 %macro DECLARE_MMCAST 1
939     %define  mmmm%1   mm%1
940     %define  mmxmm%1  mm%1
941     %define  mmymm%1  mm%1
942     %define xmmmm%1   mm%1
943     %define xmmxmm%1 xmm%1
944     %define xmmymm%1 xmm%1
945     %define ymmmm%1   mm%1
946     %define ymmxmm%1 xmm%1
947     %define ymmymm%1 ymm%1
948     %define xm%1 xmm %+ m%1
949     %define ym%1 ymm %+ m%1
950 %endmacro
951
952 %assign i 0
953 %rep 16
954     DECLARE_MMCAST i
955     %assign i i+1
956 %endrep
957
958 ; I often want to use macros that permute their arguments. e.g. there's no
959 ; efficient way to implement butterfly or transpose or dct without swapping some
960 ; arguments.
961 ;
962 ; I would like to not have to manually keep track of the permutations:
963 ; If I insert a permutation in the middle of a function, it should automatically
964 ; change everything that follows. For more complex macros I may also have multiple
965 ; implementations, e.g. the SSE2 and SSSE3 versions may have different permutations.
966 ;
967 ; Hence these macros. Insert a PERMUTE or some SWAPs at the end of a macro that
968 ; permutes its arguments. It's equivalent to exchanging the contents of the
969 ; registers, except that this way you exchange the register names instead, so it
970 ; doesn't cost any cycles.
971
972 %macro PERMUTE 2-* ; takes a list of pairs to swap
973     %rep %0/2
974         %xdefine %%tmp%2 m%2
975         %rotate 2
976     %endrep
977     %rep %0/2
978         %xdefine m%1 %%tmp%2
979         CAT_XDEFINE nn, m%1, %1
980         %rotate 2
981     %endrep
982 %endmacro
983
984 %macro SWAP 2+ ; swaps a single chain (sometimes more concise than pairs)
985     %ifnum %1 ; SWAP 0, 1, ...
986         SWAP_INTERNAL_NUM %1, %2
987     %else ; SWAP m0, m1, ...
988         SWAP_INTERNAL_NAME %1, %2
989     %endif
990 %endmacro
991
992 %macro SWAP_INTERNAL_NUM 2-*
993     %rep %0-1
994         %xdefine %%tmp m%1
995         %xdefine m%1 m%2
996         %xdefine m%2 %%tmp
997         CAT_XDEFINE nn, m%1, %1
998         CAT_XDEFINE nn, m%2, %2
999         %rotate 1
1000     %endrep
1001 %endmacro
1002
1003 %macro SWAP_INTERNAL_NAME 2-*
1004     %xdefine %%args nn %+ %1
1005     %rep %0-1
1006         %xdefine %%args %%args, nn %+ %2
1007         %rotate 1
1008     %endrep
1009     SWAP_INTERNAL_NUM %%args
1010 %endmacro
1011
1012 ; If SAVE_MM_PERMUTATION is placed at the end of a function, then any later
1013 ; calls to that function will automatically load the permutation, so values can
1014 ; be returned in mmregs.
1015 %macro SAVE_MM_PERMUTATION 0-1
1016     %if %0
1017         %xdefine %%f %1_m
1018     %else
1019         %xdefine %%f current_function %+ _m
1020     %endif
1021     %assign %%i 0
1022     %rep num_mmregs
1023         CAT_XDEFINE %%f, %%i, m %+ %%i
1024         %assign %%i %%i+1
1025     %endrep
1026 %endmacro
1027
1028 %macro LOAD_MM_PERMUTATION 1 ; name to load from
1029     %ifdef %1_m0
1030         %assign %%i 0
1031         %rep num_mmregs
1032             CAT_XDEFINE m, %%i, %1_m %+ %%i
1033             CAT_XDEFINE nn, m %+ %%i, %%i
1034             %assign %%i %%i+1
1035         %endrep
1036     %endif
1037 %endmacro
1038
1039 ; Append cpuflags to the callee's name iff the appended name is known and the plain name isn't
1040 %macro call 1
1041     %ifid %1
1042         call_internal %1 %+ SUFFIX, %1
1043     %else
1044         call %1
1045     %endif
1046 %endmacro
1047 %macro call_internal 2
1048     %xdefine %%i %2
1049     %ifndef cglobaled_%2
1050         %ifdef cglobaled_%1
1051             %xdefine %%i %1
1052         %endif
1053     %endif
1054     call %%i
1055     LOAD_MM_PERMUTATION %%i
1056 %endmacro
1057
1058 ; Substitutions that reduce instruction size but are functionally equivalent
1059 %macro add 2
1060     %ifnum %2
1061         %if %2==128
1062             sub %1, -128
1063         %else
1064             add %1, %2
1065         %endif
1066     %else
1067         add %1, %2
1068     %endif
1069 %endmacro
1070
1071 %macro sub 2
1072     %ifnum %2
1073         %if %2==128
1074             add %1, -128
1075         %else
1076             sub %1, %2
1077         %endif
1078     %else
1079         sub %1, %2
1080     %endif
1081 %endmacro
1082
1083 ;=============================================================================
1084 ; AVX abstraction layer
1085 ;=============================================================================
1086
1087 %assign i 0
1088 %rep 16
1089     %if i < 8
1090         CAT_XDEFINE sizeofmm, i, 8
1091     %endif
1092     CAT_XDEFINE sizeofxmm, i, 16
1093     CAT_XDEFINE sizeofymm, i, 32
1094     %assign i i+1
1095 %endrep
1096 %undef i
1097
1098 %macro CHECK_AVX_INSTR_EMU 3-*
1099     %xdefine %%opcode %1
1100     %xdefine %%dst %2
1101     %rep %0-2
1102         %ifidn %%dst, %3
1103             %error non-avx emulation of ``%%opcode'' is not supported
1104         %endif
1105         %rotate 1
1106     %endrep
1107 %endmacro
1108
1109 ;%1 == instruction
1110 ;%2 == minimal instruction set
1111 ;%3 == 1 if float, 0 if int
1112 ;%4 == 1 if 4-operand emulation, 0 if 3-operand emulation, 255 otherwise (no emulation)
1113 ;%5 == 1 if commutative (i.e. doesn't matter which src arg is which), 0 if not
1114 ;%6+: operands
1115 %macro RUN_AVX_INSTR 6-9+
1116     %ifnum sizeof%7
1117         %assign __sizeofreg sizeof%7
1118     %elifnum sizeof%6
1119         %assign __sizeofreg sizeof%6
1120     %else
1121         %assign __sizeofreg mmsize
1122     %endif
1123     %assign __emulate_avx 0
1124     %if avx_enabled && __sizeofreg >= 16
1125         %xdefine __instr v%1
1126     %else
1127         %xdefine __instr %1
1128         %if %0 >= 8+%4
1129             %assign __emulate_avx 1
1130         %endif
1131     %endif
1132     %ifnidn %2, fnord
1133         %ifdef cpuname
1134             %if notcpuflag(%2)
1135                 %error use of ``%1'' %2 instruction in cpuname function: current_function
1136             %elif cpuflags_%2 < cpuflags_sse && notcpuflag(sse2) && __sizeofreg > 8
1137                 %error use of ``%1'' sse2 instruction in cpuname function: current_function
1138             %endif
1139         %endif
1140     %endif
1141
1142     %if __emulate_avx
1143         %xdefine __src1 %7
1144         %xdefine __src2 %8
1145         %if %5 && %4 == 0
1146             %ifnidn %6, %7
1147                 %ifidn %6, %8
1148                     %xdefine __src1 %8
1149                     %xdefine __src2 %7
1150                 %elifnnum sizeof%8
1151                     ; 3-operand AVX instructions with a memory arg can only have it in src2,
1152                     ; whereas SSE emulation prefers to have it in src1 (i.e. the mov).
1153                     ; So, if the instruction is commutative with a memory arg, swap them.
1154                     %xdefine __src1 %8
1155                     %xdefine __src2 %7
1156                 %endif
1157             %endif
1158         %endif
1159         %ifnidn %6, __src1
1160             %if %0 >= 9
1161                 CHECK_AVX_INSTR_EMU {%1 %6, %7, %8, %9}, %6, __src2, %9
1162             %else
1163                 CHECK_AVX_INSTR_EMU {%1 %6, %7, %8}, %6, __src2
1164             %endif
1165             %if __sizeofreg == 8
1166                 MOVQ %6, __src1
1167             %elif %3
1168                 MOVAPS %6, __src1
1169             %else
1170                 MOVDQA %6, __src1
1171             %endif
1172         %endif
1173         %if %0 >= 9
1174             %1 %6, __src2, %9
1175         %else
1176             %1 %6, __src2
1177         %endif
1178     %elif %0 >= 9
1179         __instr %6, %7, %8, %9
1180     %elif %0 == 8
1181         __instr %6, %7, %8
1182     %elif %0 == 7
1183         __instr %6, %7
1184     %else
1185         __instr %6
1186     %endif
1187 %endmacro
1188
1189 ;%1 == instruction
1190 ;%2 == minimal instruction set
1191 ;%3 == 1 if float, 0 if int
1192 ;%4 == 1 if 4-operand emulation, 0 if 3-operand emulation, 255 otherwise (no emulation)
1193 ;%5 == 1 if commutative (i.e. doesn't matter which src arg is which), 0 if not
1194 %macro AVX_INSTR 1-5 fnord, 0, 255, 0
1195     %macro %1 1-10 fnord, fnord, fnord, fnord, %1, %2, %3, %4, %5
1196         %ifidn %2, fnord
1197             RUN_AVX_INSTR %6, %7, %8, %9, %10, %1
1198         %elifidn %3, fnord
1199             RUN_AVX_INSTR %6, %7, %8, %9, %10, %1, %2
1200         %elifidn %4, fnord
1201             RUN_AVX_INSTR %6, %7, %8, %9, %10, %1, %2, %3
1202         %elifidn %5, fnord
1203             RUN_AVX_INSTR %6, %7, %8, %9, %10, %1, %2, %3, %4
1204         %else
1205             RUN_AVX_INSTR %6, %7, %8, %9, %10, %1, %2, %3, %4, %5
1206         %endif
1207     %endmacro
1208 %endmacro
1209
1210 ; Instructions with both VEX and non-VEX encodings
1211 ; Non-destructive instructions are written without parameters
1212 AVX_INSTR addpd, sse2, 1, 0, 1
1213 AVX_INSTR addps, sse, 1, 0, 1
1214 AVX_INSTR addsd, sse2, 1, 0, 0
1215 AVX_INSTR addss, sse, 1, 0, 0
1216 AVX_INSTR addsubpd, sse3, 1, 0, 0
1217 AVX_INSTR addsubps, sse3, 1, 0, 0
1218 AVX_INSTR aesdec, aesni, 0, 0, 0
1219 AVX_INSTR aesdeclast, aesni, 0, 0, 0
1220 AVX_INSTR aesenc, aesni, 0, 0, 0
1221 AVX_INSTR aesenclast, aesni, 0, 0, 0
1222 AVX_INSTR aesimc, aesni
1223 AVX_INSTR aeskeygenassist, aesni
1224 AVX_INSTR andnpd, sse2, 1, 0, 0
1225 AVX_INSTR andnps, sse, 1, 0, 0
1226 AVX_INSTR andpd, sse2, 1, 0, 1
1227 AVX_INSTR andps, sse, 1, 0, 1
1228 AVX_INSTR blendpd, sse4, 1, 1, 0
1229 AVX_INSTR blendps, sse4, 1, 1, 0
1230 AVX_INSTR blendvpd, sse4 ; can't be emulated
1231 AVX_INSTR blendvps, sse4 ; can't be emulated
1232 AVX_INSTR cmppd, sse2, 1, 1, 0
1233 AVX_INSTR cmpps, sse, 1, 1, 0
1234 AVX_INSTR cmpsd, sse2, 1, 1, 0
1235 AVX_INSTR cmpss, sse, 1, 1, 0
1236 AVX_INSTR comisd, sse2
1237 AVX_INSTR comiss, sse
1238 AVX_INSTR cvtdq2pd, sse2
1239 AVX_INSTR cvtdq2ps, sse2
1240 AVX_INSTR cvtpd2dq, sse2
1241 AVX_INSTR cvtpd2ps, sse2
1242 AVX_INSTR cvtps2dq, sse2
1243 AVX_INSTR cvtps2pd, sse2
1244 AVX_INSTR cvtsd2si, sse2
1245 AVX_INSTR cvtsd2ss, sse2, 1, 0, 0
1246 AVX_INSTR cvtsi2sd, sse2, 1, 0, 0
1247 AVX_INSTR cvtsi2ss, sse, 1, 0, 0
1248 AVX_INSTR cvtss2sd, sse2, 1, 0, 0
1249 AVX_INSTR cvtss2si, sse
1250 AVX_INSTR cvttpd2dq, sse2
1251 AVX_INSTR cvttps2dq, sse2
1252 AVX_INSTR cvttsd2si, sse2
1253 AVX_INSTR cvttss2si, sse
1254 AVX_INSTR divpd, sse2, 1, 0, 0
1255 AVX_INSTR divps, sse, 1, 0, 0
1256 AVX_INSTR divsd, sse2, 1, 0, 0
1257 AVX_INSTR divss, sse, 1, 0, 0
1258 AVX_INSTR dppd, sse4, 1, 1, 0
1259 AVX_INSTR dpps, sse4, 1, 1, 0
1260 AVX_INSTR extractps, sse4
1261 AVX_INSTR haddpd, sse3, 1, 0, 0
1262 AVX_INSTR haddps, sse3, 1, 0, 0
1263 AVX_INSTR hsubpd, sse3, 1, 0, 0
1264 AVX_INSTR hsubps, sse3, 1, 0, 0
1265 AVX_INSTR insertps, sse4, 1, 1, 0
1266 AVX_INSTR lddqu, sse3
1267 AVX_INSTR ldmxcsr, sse
1268 AVX_INSTR maskmovdqu, sse2
1269 AVX_INSTR maxpd, sse2, 1, 0, 1
1270 AVX_INSTR maxps, sse, 1, 0, 1
1271 AVX_INSTR maxsd, sse2, 1, 0, 0
1272 AVX_INSTR maxss, sse, 1, 0, 0
1273 AVX_INSTR minpd, sse2, 1, 0, 1
1274 AVX_INSTR minps, sse, 1, 0, 1
1275 AVX_INSTR minsd, sse2, 1, 0, 0
1276 AVX_INSTR minss, sse, 1, 0, 0
1277 AVX_INSTR movapd, sse2
1278 AVX_INSTR movaps, sse
1279 AVX_INSTR movd, mmx
1280 AVX_INSTR movddup, sse3
1281 AVX_INSTR movdqa, sse2
1282 AVX_INSTR movdqu, sse2
1283 AVX_INSTR movhlps, sse, 1, 0, 0
1284 AVX_INSTR movhpd, sse2, 1, 0, 0
1285 AVX_INSTR movhps, sse, 1, 0, 0
1286 AVX_INSTR movlhps, sse, 1, 0, 0
1287 AVX_INSTR movlpd, sse2, 1, 0, 0
1288 AVX_INSTR movlps, sse, 1, 0, 0
1289 AVX_INSTR movmskpd, sse2
1290 AVX_INSTR movmskps, sse
1291 AVX_INSTR movntdq, sse2
1292 AVX_INSTR movntdqa, sse4
1293 AVX_INSTR movntpd, sse2
1294 AVX_INSTR movntps, sse
1295 AVX_INSTR movq, mmx
1296 AVX_INSTR movsd, sse2, 1, 0, 0
1297 AVX_INSTR movshdup, sse3
1298 AVX_INSTR movsldup, sse3
1299 AVX_INSTR movss, sse, 1, 0, 0
1300 AVX_INSTR movupd, sse2
1301 AVX_INSTR movups, sse
1302 AVX_INSTR mpsadbw, sse4, 0, 1, 0
1303 AVX_INSTR mulpd, sse2, 1, 0, 1
1304 AVX_INSTR mulps, sse, 1, 0, 1
1305 AVX_INSTR mulsd, sse2, 1, 0, 0
1306 AVX_INSTR mulss, sse, 1, 0, 0
1307 AVX_INSTR orpd, sse2, 1, 0, 1
1308 AVX_INSTR orps, sse, 1, 0, 1
1309 AVX_INSTR pabsb, ssse3
1310 AVX_INSTR pabsd, ssse3
1311 AVX_INSTR pabsw, ssse3
1312 AVX_INSTR packsswb, mmx, 0, 0, 0
1313 AVX_INSTR packssdw, mmx, 0, 0, 0
1314 AVX_INSTR packuswb, mmx, 0, 0, 0
1315 AVX_INSTR packusdw, sse4, 0, 0, 0
1316 AVX_INSTR paddb, mmx, 0, 0, 1
1317 AVX_INSTR paddw, mmx, 0, 0, 1
1318 AVX_INSTR paddd, mmx, 0, 0, 1
1319 AVX_INSTR paddq, sse2, 0, 0, 1
1320 AVX_INSTR paddsb, mmx, 0, 0, 1
1321 AVX_INSTR paddsw, mmx, 0, 0, 1
1322 AVX_INSTR paddusb, mmx, 0, 0, 1
1323 AVX_INSTR paddusw, mmx, 0, 0, 1
1324 AVX_INSTR palignr, ssse3, 0, 1, 0
1325 AVX_INSTR pand, mmx, 0, 0, 1
1326 AVX_INSTR pandn, mmx, 0, 0, 0
1327 AVX_INSTR pavgb, mmx2, 0, 0, 1
1328 AVX_INSTR pavgw, mmx2, 0, 0, 1
1329 AVX_INSTR pblendvb, sse4 ; can't be emulated
1330 AVX_INSTR pblendw, sse4, 0, 1, 0
1331 AVX_INSTR pclmulqdq, fnord, 0, 1, 0
1332 AVX_INSTR pclmulhqhqdq, fnord, 0, 0, 0
1333 AVX_INSTR pclmulhqlqdq, fnord, 0, 0, 0
1334 AVX_INSTR pclmullqhqdq, fnord, 0, 0, 0
1335 AVX_INSTR pclmullqlqdq, fnord, 0, 0, 0
1336 AVX_INSTR pcmpestri, sse42
1337 AVX_INSTR pcmpestrm, sse42
1338 AVX_INSTR pcmpistri, sse42
1339 AVX_INSTR pcmpistrm, sse42
1340 AVX_INSTR pcmpeqb, mmx, 0, 0, 1
1341 AVX_INSTR pcmpeqw, mmx, 0, 0, 1
1342 AVX_INSTR pcmpeqd, mmx, 0, 0, 1
1343 AVX_INSTR pcmpeqq, sse4, 0, 0, 1
1344 AVX_INSTR pcmpgtb, mmx, 0, 0, 0
1345 AVX_INSTR pcmpgtw, mmx, 0, 0, 0
1346 AVX_INSTR pcmpgtd, mmx, 0, 0, 0
1347 AVX_INSTR pcmpgtq, sse42, 0, 0, 0
1348 AVX_INSTR pextrb, sse4
1349 AVX_INSTR pextrd, sse4
1350 AVX_INSTR pextrq, sse4
1351 AVX_INSTR pextrw, mmx2
1352 AVX_INSTR phaddw, ssse3, 0, 0, 0
1353 AVX_INSTR phaddd, ssse3, 0, 0, 0
1354 AVX_INSTR phaddsw, ssse3, 0, 0, 0
1355 AVX_INSTR phminposuw, sse4
1356 AVX_INSTR phsubw, ssse3, 0, 0, 0
1357 AVX_INSTR phsubd, ssse3, 0, 0, 0
1358 AVX_INSTR phsubsw, ssse3, 0, 0, 0
1359 AVX_INSTR pinsrb, sse4, 0, 1, 0
1360 AVX_INSTR pinsrd, sse4, 0, 1, 0
1361 AVX_INSTR pinsrq, sse4, 0, 1, 0
1362 AVX_INSTR pinsrw, mmx2, 0, 1, 0
1363 AVX_INSTR pmaddwd, mmx, 0, 0, 1
1364 AVX_INSTR pmaddubsw, ssse3, 0, 0, 0
1365 AVX_INSTR pmaxsb, sse4, 0, 0, 1
1366 AVX_INSTR pmaxsw, mmx2, 0, 0, 1
1367 AVX_INSTR pmaxsd, sse4, 0, 0, 1
1368 AVX_INSTR pmaxub, mmx2, 0, 0, 1
1369 AVX_INSTR pmaxuw, sse4, 0, 0, 1
1370 AVX_INSTR pmaxud, sse4, 0, 0, 1
1371 AVX_INSTR pminsb, sse4, 0, 0, 1
1372 AVX_INSTR pminsw, mmx2, 0, 0, 1
1373 AVX_INSTR pminsd, sse4, 0, 0, 1
1374 AVX_INSTR pminub, mmx2, 0, 0, 1
1375 AVX_INSTR pminuw, sse4, 0, 0, 1
1376 AVX_INSTR pminud, sse4, 0, 0, 1
1377 AVX_INSTR pmovmskb, mmx2
1378 AVX_INSTR pmovsxbw, sse4
1379 AVX_INSTR pmovsxbd, sse4
1380 AVX_INSTR pmovsxbq, sse4
1381 AVX_INSTR pmovsxwd, sse4
1382 AVX_INSTR pmovsxwq, sse4
1383 AVX_INSTR pmovsxdq, sse4
1384 AVX_INSTR pmovzxbw, sse4
1385 AVX_INSTR pmovzxbd, sse4
1386 AVX_INSTR pmovzxbq, sse4
1387 AVX_INSTR pmovzxwd, sse4
1388 AVX_INSTR pmovzxwq, sse4
1389 AVX_INSTR pmovzxdq, sse4
1390 AVX_INSTR pmuldq, sse4, 0, 0, 1
1391 AVX_INSTR pmulhrsw, ssse3, 0, 0, 1
1392 AVX_INSTR pmulhuw, mmx2, 0, 0, 1
1393 AVX_INSTR pmulhw, mmx, 0, 0, 1
1394 AVX_INSTR pmullw, mmx, 0, 0, 1
1395 AVX_INSTR pmulld, sse4, 0, 0, 1
1396 AVX_INSTR pmuludq, sse2, 0, 0, 1
1397 AVX_INSTR por, mmx, 0, 0, 1
1398 AVX_INSTR psadbw, mmx2, 0, 0, 1
1399 AVX_INSTR pshufb, ssse3, 0, 0, 0
1400 AVX_INSTR pshufd, sse2
1401 AVX_INSTR pshufhw, sse2
1402 AVX_INSTR pshuflw, sse2
1403 AVX_INSTR psignb, ssse3, 0, 0, 0
1404 AVX_INSTR psignw, ssse3, 0, 0, 0
1405 AVX_INSTR psignd, ssse3, 0, 0, 0
1406 AVX_INSTR psllw, mmx, 0, 0, 0
1407 AVX_INSTR pslld, mmx, 0, 0, 0
1408 AVX_INSTR psllq, mmx, 0, 0, 0
1409 AVX_INSTR pslldq, sse2, 0, 0, 0
1410 AVX_INSTR psraw, mmx, 0, 0, 0
1411 AVX_INSTR psrad, mmx, 0, 0, 0
1412 AVX_INSTR psrlw, mmx, 0, 0, 0
1413 AVX_INSTR psrld, mmx, 0, 0, 0
1414 AVX_INSTR psrlq, mmx, 0, 0, 0
1415 AVX_INSTR psrldq, sse2, 0, 0, 0
1416 AVX_INSTR psubb, mmx, 0, 0, 0
1417 AVX_INSTR psubw, mmx, 0, 0, 0
1418 AVX_INSTR psubd, mmx, 0, 0, 0
1419 AVX_INSTR psubq, sse2, 0, 0, 0
1420 AVX_INSTR psubsb, mmx, 0, 0, 0
1421 AVX_INSTR psubsw, mmx, 0, 0, 0
1422 AVX_INSTR psubusb, mmx, 0, 0, 0
1423 AVX_INSTR psubusw, mmx, 0, 0, 0
1424 AVX_INSTR ptest, sse4
1425 AVX_INSTR punpckhbw, mmx, 0, 0, 0
1426 AVX_INSTR punpckhwd, mmx, 0, 0, 0
1427 AVX_INSTR punpckhdq, mmx, 0, 0, 0
1428 AVX_INSTR punpckhqdq, sse2, 0, 0, 0
1429 AVX_INSTR punpcklbw, mmx, 0, 0, 0
1430 AVX_INSTR punpcklwd, mmx, 0, 0, 0
1431 AVX_INSTR punpckldq, mmx, 0, 0, 0
1432 AVX_INSTR punpcklqdq, sse2, 0, 0, 0
1433 AVX_INSTR pxor, mmx, 0, 0, 1
1434 AVX_INSTR rcpps, sse
1435 AVX_INSTR rcpss, sse, 1, 0, 0
1436 AVX_INSTR roundpd, sse4
1437 AVX_INSTR roundps, sse4
1438 AVX_INSTR roundsd, sse4, 1, 1, 0
1439 AVX_INSTR roundss, sse4, 1, 1, 0
1440 AVX_INSTR rsqrtps, sse
1441 AVX_INSTR rsqrtss, sse, 1, 0, 0
1442 AVX_INSTR shufpd, sse2, 1, 1, 0
1443 AVX_INSTR shufps, sse, 1, 1, 0
1444 AVX_INSTR sqrtpd, sse2
1445 AVX_INSTR sqrtps, sse
1446 AVX_INSTR sqrtsd, sse2, 1, 0, 0
1447 AVX_INSTR sqrtss, sse, 1, 0, 0
1448 AVX_INSTR stmxcsr, sse
1449 AVX_INSTR subpd, sse2, 1, 0, 0
1450 AVX_INSTR subps, sse, 1, 0, 0
1451 AVX_INSTR subsd, sse2, 1, 0, 0
1452 AVX_INSTR subss, sse, 1, 0, 0
1453 AVX_INSTR ucomisd, sse2
1454 AVX_INSTR ucomiss, sse
1455 AVX_INSTR unpckhpd, sse2, 1, 0, 0
1456 AVX_INSTR unpckhps, sse, 1, 0, 0
1457 AVX_INSTR unpcklpd, sse2, 1, 0, 0
1458 AVX_INSTR unpcklps, sse, 1, 0, 0
1459 AVX_INSTR xorpd, sse2, 1, 0, 1
1460 AVX_INSTR xorps, sse, 1, 0, 1
1461
1462 ; 3DNow instructions, for sharing code between AVX, SSE and 3DN
1463 AVX_INSTR pfadd, 3dnow, 1, 0, 1
1464 AVX_INSTR pfsub, 3dnow, 1, 0, 0
1465 AVX_INSTR pfmul, 3dnow, 1, 0, 1
1466
1467 ; base-4 constants for shuffles
1468 %assign i 0
1469 %rep 256
1470     %assign j ((i>>6)&3)*1000 + ((i>>4)&3)*100 + ((i>>2)&3)*10 + (i&3)
1471     %if j < 10
1472         CAT_XDEFINE q000, j, i
1473     %elif j < 100
1474         CAT_XDEFINE q00, j, i
1475     %elif j < 1000
1476         CAT_XDEFINE q0, j, i
1477     %else
1478         CAT_XDEFINE q, j, i
1479     %endif
1480     %assign i i+1
1481 %endrep
1482 %undef i
1483 %undef j
1484
1485 %macro FMA_INSTR 3
1486     %macro %1 4-7 %1, %2, %3
1487         %if cpuflag(xop)
1488             v%5 %1, %2, %3, %4
1489         %elifnidn %1, %4
1490             %6 %1, %2, %3
1491             %7 %1, %4
1492         %else
1493             %error non-xop emulation of ``%5 %1, %2, %3, %4'' is not supported
1494         %endif
1495     %endmacro
1496 %endmacro
1497
1498 FMA_INSTR  pmacsww,  pmullw, paddw
1499 FMA_INSTR  pmacsdd,  pmulld, paddd ; sse4 emulation
1500 FMA_INSTR pmacsdql,  pmuldq, paddq ; sse4 emulation
1501 FMA_INSTR pmadcswd, pmaddwd, paddd
1502
1503 ; tzcnt is equivalent to "rep bsf" and is backwards-compatible with bsf.
1504 ; This lets us use tzcnt without bumping the yasm version requirement yet.
1505 %define tzcnt rep bsf
1506
1507 ; Macros for consolidating FMA3 and FMA4 using 4-operand (dst, src1, src2, src3) syntax.
1508 ; FMA3 is only possible if dst is the same as one of the src registers.
1509 ; Either src2 or src3 can be a memory operand.
1510 %macro FMA4_INSTR 2-*
1511     %push fma4_instr
1512     %xdefine %$prefix %1
1513     %rep %0 - 1
1514         %macro %$prefix%2 4-6 %$prefix, %2
1515             %if notcpuflag(fma3) && notcpuflag(fma4)
1516                 %error use of ``%5%6'' fma instruction in cpuname function: current_function
1517             %elif cpuflag(fma4)
1518                 v%5%6 %1, %2, %3, %4
1519             %elifidn %1, %2
1520                 ; If %3 or %4 is a memory operand it needs to be encoded as the last operand.
1521                 %ifnum sizeof%3
1522                     v%{5}213%6 %2, %3, %4
1523                 %else
1524                     v%{5}132%6 %2, %4, %3
1525                 %endif
1526             %elifidn %1, %3
1527                 v%{5}213%6 %3, %2, %4
1528             %elifidn %1, %4
1529                 v%{5}231%6 %4, %2, %3
1530             %else
1531                 %error fma3 emulation of ``%5%6 %1, %2, %3, %4'' is not supported
1532             %endif
1533         %endmacro
1534         %rotate 1
1535     %endrep
1536     %pop
1537 %endmacro
1538
1539 FMA4_INSTR fmadd,    pd, ps, sd, ss
1540 FMA4_INSTR fmaddsub, pd, ps
1541 FMA4_INSTR fmsub,    pd, ps, sd, ss
1542 FMA4_INSTR fmsubadd, pd, ps
1543 FMA4_INSTR fnmadd,   pd, ps, sd, ss
1544 FMA4_INSTR fnmsub,   pd, ps, sd, ss
1545
1546 ; workaround: vpbroadcastq is broken in x86_32 due to a yasm bug (fixed in 1.3.0)
1547 %ifdef __YASM_VER__
1548     %if __YASM_VERSION_ID__ < 0x01030000 && ARCH_X86_64 == 0
1549         %macro vpbroadcastq 2
1550             %if sizeof%1 == 16
1551                 movddup %1, %2
1552             %else
1553                 vbroadcastsd %1, %2
1554             %endif
1555         %endmacro
1556     %endif
1557 %endif