diff options
| author | Yang Liu <liuyang22@iscas.ac.cn> | 2025-05-14 16:15:01 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-05-14 10:15:01 +0200 |
| commit | 3d0b4ac9e1a861afb2a5def13a10a74a5f2f1b24 (patch) | |
| tree | 1bd17ca487b634cf7fc510179007521f05145e2b /docs/USAGE.md | |
| parent | 4be5149b8d291268b32a7a8ad93651ecbcd12f1b (diff) | |
| download | box64-3d0b4ac9e1a861afb2a5def13a10a74a5f2f1b24.tar.gz box64-3d0b4ac9e1a861afb2a5def13a10a74a5f2f1b24.zip | |
[DOCS] Align usage.json and env.h (#2633)
* [DOCS] Align usage.json and env.h * Removed BOX64_FUTEX_WAITV * review * gen
Diffstat (limited to 'docs/USAGE.md')
| -rw-r--r-- | docs/USAGE.md | 28 |
1 files changed, 25 insertions, 3 deletions
diff --git a/docs/USAGE.md b/docs/USAGE.md index c81e9948..7240a773 100644 --- a/docs/USAGE.md +++ b/docs/USAGE.md @@ -171,6 +171,14 @@ Add --no-sandbox argument to the guest program. ## Compatibility +### BOX64_AVX + +Expose AVX extension to CPUID and cpuinfo file. Default value is 2 on Arm64 because it's fully implemented in DynaRec, 0 otherwise. + + * 0: Do not expose AVX capabilities. + * 1: Expose AVX, BMI1, F16C and VAES extensions to CPUID and cpuinfo file. + * 2: All in 1, plus AVX2, BMI2, FMA, ADX,VPCLMULQDQ and RDRAND extensions. + ### BOX64_BASH Path to the bash executable. @@ -462,9 +470,9 @@ Set the address where the program is loaded, only active for PIE guest programs. ### BOX64_LOG -Enable or disable Box64 logs. +Enable or disable Box64 logs, default value is 0 if stdout is not terminal, 1 otherwise. - * 0: Disable Box64 logs. [Default] + * 0: Disable Box64 logs. * 1: Enable minimal Box64 logs. * 2: Enable debug level Box64 logs. * 3: Enable verbose level Box64 logs. @@ -473,7 +481,7 @@ Enable or disable Box64 logs. Disable the Box64 banner. - * 0: Show the Box64 banner. [Default] + * 0: Show the Box64 banner. * 1: Do not show the Box64 banner. ### BOX64_NOSIGSEGV @@ -567,6 +575,13 @@ Only available on box64 build with trace. Adds trace of all instructions execute ## Performance +### BOX64_DYNAREC + +Enable/disable the Dynamic Recompiler (a.k.a DynaRec). This option defaults to 1 if it's enabled in the build options for a supported architecture. + + * 0: Disable DynaRec. + * 1: Enable DynaRec. + ### BOX64_DYNAREC_ALIGNED_ATOMICS Generate aligned atomics only (only available on Arm64 for now). @@ -684,6 +699,13 @@ Tweak the memory barriers to reduce the performance impact by strong memory emua * 1: Use weak barriers to have more performance boost. [Default] * 2: All in 1, plus disabled the last write barriers. +### BOX64_MMAP32 + +Force 32-bit compatible memory mappings on 64-bit programs that run 32-bit code (like Wine WOW64), can improve performance. + + * 0: Do not force 32-bit memory mappings. + * 1: Force 32-bit memory mappings. [Default] + ### BOX64_NODYNAREC Forbid dynablock creation in the address range specified, helpful for debugging behaviour difference between Dynarec and Interpreter. |