commit	f5ccbb532aba547359d2c237c8a69c184b1b4a12	[log] [tgz]
author	MITSUNARI Shigeo <herumi@nifty.com>	Fri Jun 06 11:57:23 2025 +0900
committer	MITSUNARI Shigeo <herumi@nifty.com>	Fri Jun 06 11:57:23 2025 +0900
tree	037d716855120d61944ffa8f7de688909c585ca4
parent	beb5955113f9973d4bebb2c543387c91afba9bcc [diff]

tree: 037d716855120d61944ffa8f7de688909c585ca4

readme.md

Xbyak 7.25

A JIT assembler for x86/x64 architectures supporting advanced instruction sets up to AVX10.2

Abstract

Xbyak is a C++ header-only library that enables dynamic assembly of x86/x64 instructions using mnemonics.

The pronunciation of Xbyak is /kʌɪbjæk/ (kai-byak).

The name is derived from the Japanese word 開闢 (kaibyaku), which means “the beginning of the world” or “creation”.

Note: Use and_(), or_(), ... instead of and(), or(). If you want to use them, then specify -fno-operator-names option to gcc/clang.

Support AVX10.2
Support xresldtrk/xsusldtrk
Support RAO-INT for APX
Support AVX10 detection, AESKLE, WIDE_KL, KEYLOCKER, KEYLOCKER_WIDE
Support APX except for a few instructions
Add amx_fp16/avx_vnni_int8/avx_ne_convert/avx-ifma
Add movdiri, movdir64b, clwb, cldemote
WAITPKG instructions (tpause, umonitor, umwait) are supported.
MmapAllocator supports memfd with user-defined strings. see sample/memfd.cpp
Strictly check address offset disp32 in a signed 32-bit integer. e.g., ptr[(void*)0xffffffff] causes an error.
- Define XBYAK_OLD_DISP_CHECK if you need an old check, but the option will be remoevd.
Add jmp(mem, T_FAR), call(mem, T_FAR) retf() for far absolute indirect jump.
VNNI instructions such as vpdpbusd supports vex encoding.
(Break backward compatibility) push(byte, imm) (resp. push(word, imm)) forces to cast imm to 8(resp. 16) bit.
(Windows) #include <winsock2.h> has been removed from xbyak.h, so add it explicitly if you need it.
Support exception-less mode see. Exception-less mode
XBYAK_USE_MMAP_ALLOCATOR will be defined on Linux/macOS unless XBYAK_DONT_USE_MMAP_ALLOCATOR is defined.

Almost C++03 or later compilers for x86/x64 such as Visual Studio, g++, clang++, Intel C++ compiler and g++ on mingw/cygwin.