FEX-Emu/FEX
1
0
Fork 0
mirror of https://github.com/FEX-Emu/FEX.git synced 2024-12-17 02:47:48 +00:00
Code Issues Actions 6 Packages Projects Releases Wiki Activity
A fast usermode x86 and x86-64 emulator for Arm64 Linux
2,510 Commits 4 Branches 47 Tags 44 MiB
C++ 59.3%
Assembly 30.7%
C 7.1%
Python 1.5%
CMake 1%
Other 0.3%
cf5bd202d4
Go to file
Stefanos Kornilios Mitsis Poiitidis cf5bd202d4 AOTIR: Update gen script to default to global fex installation
2021-05-03 06:15:25 +03:00
.github/workflows Enables ARMv8.4 CI runner 2021-04-27 23:16:39 -07:00
Data/AppConfig Implements support for installing global application profiles 2021-03-23 22:34:01 -07:00
docs Docs: Commit generated SourceOutline.md, update Readme.md 2021-03-30 12:21:18 +03:00
External Undo xbyak update 2021-05-03 05:48:00 +03:00
include Adds Config.h generated file 2021-03-23 19:12:18 -07:00
Scripts AOTIR: Update gen script to default to global fex installation 2021-05-03 06:15:25 +03:00
Source AOTGen: Cleanup unwind symbol logic, add to x86-32 binaries 2021-05-02 11:08:12 +03:00
ThunkLibs Docs: Add tags to the source code 2021-03-30 12:21:18 +03:00
unittests IR: Remove Entry from OP_HEADER, pass as parameter to CompileCode 2021-04-25 13:15:23 +03:00
.gitignore Add MemoryData to IR and ASM Tests 2020-08-21 01:29:37 +12:00
.gitmodules Switches FEX over to using jemalloc 2021-04-08 12:42:37 -07:00
CMakeLists.txt Removes xxhash version check 2021-04-30 01:35:03 -07:00
CMakeSettings.json EnvironmentLoader, clean merge 2020-04-24 19:25:57 -04:00
CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md 2020-12-25 01:57:09 -08:00
Dockerfile Update Dockerfile 2021-03-26 06:30:17 +01:00
LICENSE Initial Commit 2020-03-06 09:08:13 +02:00
Readme.md Docs: Commit generated SourceOutline.md, update Readme.md 2021-03-30 12:21:18 +03:00

Readme.md

FEX - Fast x86 emulation frontend

FEX allows you to run x86 and x86-64 binaries on an AArch64 host, similar to qemu-user and box86. It has native support for a rootfs overlay, so you don't need to chroot, as well as some thunklibs so it can forward things like GL to the host. FEX presents a Linux 5.0 interface to the guest, and supports both AArch64 and x86-64 as hosts. FEX is very much work in progress, so expect things to change.

Getting Started

FEX has been tested to build and run on ARMv8.0, ARMv8.1+, and x86-64(AVX or newer) hardware. ARMv7 and older x86 hardware will not work. Expected operating system usage is Linux. FEX has been tested with Ubuntu 20.04, 20.10, and 21.04. Also Arch Linux. On AArch64 hosts the user MUST have an x86-64 RootFS Creating a RootFS.

Navigating the Source

See the Source Outline for more information.

Dependencies

  • cmake (version 3.14 minimum)
  • ninja-build
  • clang (version 10 minimum for C++20)
  • libnuma-dev
  • libglfw3-dev (For GUI)
  • libsdl2-dev (For GUI)
  • libepoxy-dev (For GUI)
  • g++-x86-64-linux-gnu (For building thunks)
  • nasm (only if building tests)

Building FEX

After installing the dependencies you can now build FEX.

git clone https://github.com/FEX-Emu/FEX.git
cd FEX
git submodule update --init
mkdir Build
cd Build
CC=clang CXX=clang++ cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Release -DENABLE_LTO=True -DBUILD_TESTS=False -G Ninja ..
ninja

Installation

sudo ninja install

On AArch64 Hosts

You can install a binfmt_misc handler for both 32bit and 64bit x86 execution directly from the environment. If you already have box86's 32bit binfmt_misc handler installed then I don't recommend installing FEX's until it is useful. Make sure to have run install prior to this, otherwise binfmt_misc will install an old handler even if the executable has been updated.

sudo ninja binfmt_misc_32
sudo ninja binfmt_misc_64

More information

This wiki page can contain more information about setting up FEX on your device https://wiki.fex-emu.org/index.php/Development:Setting_up_FEX

RootFS generation

AArch64 hosts require a rootfs for running applications. Follow the guide on the wiki page for seeing how to set up the rootfs from scratch https://wiki.fex-emu.org/index.php/Development:Setting_up_RootFS

FEX diagram