ShuriZma
/
BizHawk
mirror of https://github.com/TASEmulators/BizHawk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
BizHawk/waterbox/waterboxhost
History
nattthebear 3a18f6356d Rebuild all of waterbox as sysvabi, not msabi 
This helps linux at the expense of windows, except it seems like windows gets a nice little speed up as well
 		2020-07-03 18:21:48 -04:00
..
.vscode more krusty krab 2020-06-22 18:15:11 -04:00
src Rebuild all of waterbox as sysvabi, not msabi 2020-07-03 18:21:48 -04:00
.gitignore remove what should have been ignored 2020-06-20 13:49:58 -04:00
Cargo.lock More crusty progress 2020-06-28 10:21:36 -04:00
Cargo.toml Rewrite WaterboxHost in rust. (#2190) 2020-07-03 11:45:59 -04:00
README.md Rewrite WaterboxHost in rust. (#2190) 2020-07-03 11:45:59 -04:00
build-debug.bat Rewrite WaterboxHost in rust. (#2190) 2020-07-03 11:45:59 -04:00
build-debug.sh Rewrite WaterboxHost in rust. (#2190) 2020-07-03 11:45:59 -04:00
build-release.bat Rewrite WaterboxHost in rust. (#2190) 2020-07-03 11:45:59 -04:00
build-release.sh Rewrite WaterboxHost in rust. (#2190) 2020-07-03 11:45:59 -04:00

README.md

Waterboxhost

This is the native support code for Waterbox. It's intended to be consumed as a shared library from the host environment with a C api. For most work with Waterbox cores, you don't need to get into this at all.

API

The public api is mostly all in src/cinterface.rs and has basic documentation on it. Bare minimum sequence of calls to get going:

  1. (Optional) In a release environment, turn off certain checks to speed things up wbx_set_always_evict_blocks()
  2. Create an environment, and load the ELF into it wbx_create_host() wbx_activate_host()
  3. Connect exports from the guest executable to your host system wbx_get_proc_addr()
  4. Run the guest system's init, using function pointers it exposed through wbx_get_proc_addr()
  5. Get ready to take savestates wbx_seal()
  6. Run emulation, using frameadvance or other advance functions exposed by the guest through wbx_get_proc_addr()
  7. Save and load states as needed wbx_save_state() wbx_load_state()
  8. Tear down the environment when done with it. (One shot processes that are about to exit can skip this; the OS will clean everything up) wbx_deactivate_host() wbx_destroy_host()

If you're keeping around multiple hosts that may compete for the same address space, use wbx_activate_host and wbx_deactivate_host to switch between them. If you'd like to expose files to the virtual filesystem, see wbx_mount_file and wbx_unmount_file

Building

Standard rust build infrastructure is used and can be installed with rustup. At the moment, we're using the nightly-x86_64-pc-windows-gnu chain on Windows, and the nightly-x86_64-unknown-linux-gnu chain on linux. I don't know much about crosspiling, but presumably that will work. The linux chain works fine in WSL, anyway. When used in a Windows environment with the right default chain, build-release.bat will build waterboxhost.dll and copy it to the right place. When used in a Linux (or WSL) environment with the right default chain, build-release.sh will build libwaterboxhost.so and copy it to the right place.