Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/daniel-ac-martin/sel4-minimal-asm
A minimal example of running assembly code on the seL4 micro-kernel.
https://github.com/daniel-ac-martin/sel4-minimal-asm
Last synced: about 8 hours ago
JSON representation
A minimal example of running assembly code on the seL4 micro-kernel.
- Host: GitHub
- URL: https://github.com/daniel-ac-martin/sel4-minimal-asm
- Owner: daniel-ac-martin
- Created: 2023-07-17T21:53:20.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-07-17T22:00:02.000Z (over 1 year ago)
- Last Synced: 2023-07-17T23:21:01.329Z (over 1 year ago)
- Language: Assembly
- Size: 5.86 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Minimal seL4 example in assembly
================================
This repo demonstrates a minimal build of the [seL4 micro-kernel] along
with a very simple ('hello world') roottask, implemented in
[NASM]-flavoured (x86-64) assembly.
Rather than using seL4's wider build-system, this simply performs a
['stand-alone' build of the kernel].
The roottask (initrd) is _very_ simple and just uses seL4's debug
system call to write 'Hello, World!' to the serial console.
Motivation
----------
The standard build system for seL4 assumes that one wants to build in C,
and this isn't necessarily the case. My hope is that this repo will
provide a simple example that demonstrates what needs to be provided to
seL4 in the form of a roottask, so that other programming languages can
be made to produce something compatible. I think this might also be
helpful because seL4 doesn't seem to document its ABI, but rather only
it's API in the form of libsel4. (Apologies if I am mistaken, and I have
somehow missed the place where this is documented.)
The standard build system also feels a bit invasive to me. It seems
wrong that I should have my build system dictated to me by the kernel.
I'm also not familiar with CMake, and so the system feels a bit too
'magical' to me. That all said, I can see the convenience that it can
bring, and perhaps I will change my view on this over time.
Pre-requisites
--------------
In order to build and run this software, you will need:
- [Git] (to pull down the only dependency, [seL4], this is in place of
the [Repo] tool)
- [Make] (for the overarching build system)
- [CMake] (to build the kernel, [seL4])
- [Ninja] (to build the kernel, [seL4])
- [gcc] and [others]? (to build the kernel, [seL4])
- [Python]3 and some packages (to build the kernel):
- [setuptools]: `pip3 install --user setuptools`
- [sel4-deps]: `pip3 install --user sel4-deps`
- [NASM] (to build the roottask / root-server / initrd)
- [GNU Binutils] (ld and objcopy; to build both, the kernel and
roottask)
- [QEMU] (to run / simulate in a virtual machine)
Usage
-----
First clone this repo:
```shell
git clone https://github.com/daniel-ac-martin/seL4-minimal-asm.git
```
Then pull down the dependencies:
```shell
cd seL4-minimal-asm
git submodule init
git submodule update
```
To build everything:
```shell
make
```
To build just the kernel:
```shell
make kernel
```
To build just the roottask:
```shell
make initrd
```
To run:
```shell
make run
```
To delete built files:
```shell
make clean
```
Miscellaneous notes
-------------------
- This has been tested on a GNU/Linux system (Fedora 38)
- This is not currently using the [MCS kernel] (edit [`seL4/x86_64-pc99.cmake`](seL4/x86_64-pc99.cmake) to start work on this)
- To understand the initial environment of the roottask, it's probably best to consult the C runtime: https://github.com/seL4/sel4runtime
- The system calls on x86-64 can be found here: https://github.com/seL4/seL4/blob/master/libsel4/sel4_arch_include/x86_64/sel4/sel4_arch/syscalls.h
- Thoughts / comments / ideas are welcome in the [issues]
[seL4 micro-kernel]: https://sel4.systems/
[NASM]: https://www.nasm.us/
['stand-alone' build of the kernel]: https://docs.sel4.systems/projects/buildsystem/standalone.html
[Git]: https://git-scm.com/
[seL4]: https://sel4.systems/
[Repo]: https://source.android.com/docs/setup/download#repo
[Make]: https://www.gnu.org/software/make/
[CMake]: https://cmake.org/
[Ninja]: https://ninja-build.org/
[gcc]: https://gcc.gnu.org/
[others]: https://docs.sel4.systems/projects/buildsystem/host-dependencies.html#base-build-dependencies
[Python]: https://www.python.org/
[setuptools]: https://pypi.org/project/setuptools/
[sel4-deps]: https://pypi.org/project/sel4-deps/
[GNU Binutils]: https://www.gnu.org/software/binutils/
[QEMU]: https://www.qemu.org/
[MCS kernel]: https://docs.sel4.systems/Tutorials/mcs.html
[issues]: https://github.com/daniel-ac-martin/seL4-minimal-asm/issues