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