Skip to content

Latest commit

 

History

History
107 lines (71 loc) · 6.14 KB

README.md

File metadata and controls

107 lines (71 loc) · 6.14 KB
Raw

virt86

Windows Linux and macOS Downloads
AppVeyor build status Travis CI build status Bintray downloads

virt86 interfaces with the major x86 hardware-assisted virtualization engines Intel HAXM, Microsoft Windows Hypervisor Platform, KVM and Hypervisor.Framework1, exposing a simple and universal C++ API to consumers while abstracting away the specifics of each platform. It does not provide a hypervisor by itself; instead, it interacts with existing virtualization platforms.

See more details about supported platforms and features here.

1 Hypervisor.Framework support is being studied. See issue #1 and the hvf branch.

Downloads

You can find the latest release of virt86 here. Older releases are available in the Releases page. You can also find development builds in AppVeyor (Windows only) and Bintray (all platforms).

Building virt86

virt86 is built with CMake. The minimum required version is 3.12.0.

The project has been successfully compiled with the following toolchains:

  • Microsoft Visual C++ 19.16.27027.1 (Visual Studio 2017 v15.9.7) on Windows 10, 32- and 64-bit, using Windows 10 SDKs 10.0.17134.0 and 10.0.17763.0
  • GCC 7.3.0 on Ubuntu 18.04.0, 64-bit
  • GCC 8.2.0 on Ubuntu 18.04.0 (gcc-8 package), 64-bit
  • Apple LLVM 10.0.0 on macOS Mojave 10.14.3, 64-bit

Building on Windows with Visual Studio 2017

To make a Visual Studio 2017 project you'll need to specify the "Visual Studio 15 2017" CMake generator (-G command line parameter) and a target architecture (-A). Use either Win32 for a 32-bit build or x64 for a 64-bit build.

The following commands create and open a Visual Studio 2017 64-bit project:

git clone https://github.com/StrikerX3/virt86.git
cd virt86
md build && cd build
cmake -G "Visual Studio 15 2017" -A x64 ..
start virt86.sln

The project can be built directly from the command line with CMake, without opening Visual Studio:

cd virt86/build
cmake --build . --target ALL_BUILD --config Release -- /nologo /verbosity:minimal /maxcpucount

If your installation of Visual Studio 2017 provides a Windows 10 SDK older than 10.0.17134.0, Windows Hypervisor Platform will not be available and the virt86-whpx project will neither be included in the solution nor in the library. You'll still be able to use virt86 with HAXM.

To install the library, build the INSTALL project from the solution or specify the INSTALL target to the cmake --build command. The Debug configuration exports virt86-debug.lib and virt86.pdb. All Release configurations export virt86.lib. Note that, by default, CMake projects will install to C:\Program Files\ on Windows which needs administrative rights to write files to. To work around that, provide the CMAKE_INSTALL_PREFIX parameter to the cmake command line to point to a directory where you have write permissions: -DCMAKE_INSTALL_PREFIX=<path>. Alternatively, you can run Visual Studio with administrative privileges or cmake from an elevated command prompt.

Building on Linux with GCC 7+

Make sure you have at least GCC 7, make and CMake 3.12.0 installed on your system.

git clone https://github.com/StrikerX3/virt86.git
cd virt86
mkdir build; cd build
cmake ..
make

To install the library, run sudo make install from the build directory.

Building on macOS

Install brew if you haven't already. The default installation is sufficient. Xcode is not needed to compile the library -- virt86 can be compiled with the Xcode command line tools included with brew.

git clone https://github.com/StrikerX3/virt86.git
cd virt86
mkdir build; cd build
cmake ..
make

Using virt86

Linking with CMake

Once the library is installed on your system, you can link against it as follows:

find_package(virt86 CONFIG REQUIRED)
target_link_libraries(YourTarget PUBLIC virt86::virt86)

If you installed the library to a non-standard location by specifying CMAKE_INSTALL_PREFIX when installing virt86 (or if you downloaded and extracted the package to a different location), you'll have to specify the same path to your project's CMAKE_INSTALL_PREFIX.

Linking against a downloaded release

Extract the file to your preferred location for libraries. Add <virt86-path>/include to your project's includes and <virt86-path>/lib to your project's library directories. Link against virt86.lib on Windows or libvirt86.a on Linux and macOS. For debug libraries, use virt86-debug.lib or libvirt86-debug.a.

Using the library

#include "virt86/virt86.hpp" in your application. The header includes all platforms available on your system and defines a fixed-sized array of platform factories named virt86::PlatformFactories for convenience.

Read the wiki and check out the demo projects for more details on how to use virt86.

Support

If you find this useful and want to support the author, consider becoming a patron.