runtime/README.md

# Reborn Runtime
This is a simple program allowing ARM32 code to easily call "native" code.

By running an ARM32 program inside this runtime, it gains the ability to call `raw_trampoline()`. This function copies its arguments and passes them to the "host" code.

The runtime also automatically uses QEMU on non-ARM systems.

## Terminology
- "Guest" code is the main ARM32 program. It is running inside the runtime.
- "Host" code is the native code located in `libtrampoline.so`. It is running "alongside" the runtime.

## Example
There is a simple C example [here](./example).

## Syscall Vs. Pipe Trampolines
The runtime supports two methods of passing data between the guest and host.
- System Call
  - Data is passed through a custom system-call added to QEMU.
  - Only supported on x86_64.
- Pipes
  - Data is passed through standard UNIX pipes.
  - Can be forced using an environmental variable.

## Licensing
The runtime itself is licensed with [GPLv2](./LICENSE) to comply with [QEMU's license](https://wiki.qemu.org/License). However, the `raw_trampoline` function and associated headers are licensed with the [Unlicense](lib/LICENSE) as they do not directly link to the runtime.
Changes 2025-01-04 05:34:24 -05:00			`# Reborn Runtime`
			`This is a simple program allowing ARM32 code to easily call "native" code.`
Rebrand! Rebrand! 2024-06-08 05:28:22 -04:00
Update QEMU 2025-02-14 23:21:19 -05:00			By running an ARM32 program inside this runtime, it gains the ability to call `raw_trampoline()`. This function copies its arguments and passes them to the "host" code.
Rebrand! Rebrand! 2024-06-08 05:28:22 -04:00
CI Attempt 2025-02-15 00:03:19 -05:00			`The runtime also automatically uses QEMU on non-ARM systems.`
Rebrand! Rebrand! 2024-06-08 05:28:22 -04:00
Changes 2025-01-04 05:34:24 -05:00			`## Terminology`
Refactor 2025-02-14 23:10:29 -05:00			`- "Guest" code is the main ARM32 program. It is running inside the runtime.`
			- "Host" code is the native code located in `libtrampoline.so`. It is running "alongside" the runtime.
Rebrand! Rebrand! 2024-06-08 05:28:22 -04:00
Changes 2025-01-04 05:34:24 -05:00			`## Example`
Update QEMU 2025-02-14 23:21:19 -05:00			`There is a simple C example [here](./example).`
Rebrand! Rebrand! 2024-06-08 05:28:22 -04:00
Refactor 2025-02-14 23:10:29 -05:00			`## Syscall Vs. Pipe Trampolines`
Changes 2025-01-04 05:34:24 -05:00			`The runtime supports two methods of passing data between the guest and host.`
			`- System Call`
			`- Data is passed through a custom system-call added to QEMU.`
			`- Only supported on x86_64.`
			`- Pipes`
			`- Data is passed through standard UNIX pipes.`
			`- Can be forced using an environmental variable.`
Rebrand! Rebrand! 2024-06-08 05:28:22 -04:00
Changes 2025-01-04 05:34:24 -05:00			`## Licensing`
Link To QEMU's License 2025-01-04 05:51:37 -05:00			The runtime itself is licensed with [GPLv2](./LICENSE) to comply with [QEMU's license](https://wiki.qemu.org/License). However, the `raw_trampoline` function and associated headers are licensed with the [Unlicense](lib/LICENSE) as they do not directly link to the runtime.