Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rcore-os/rcore-user
User programs for rCore OS
https://github.com/rcore-os/rcore-user
Last synced: 2 months ago
JSON representation
User programs for rCore OS
- Host: GitHub
- URL: https://github.com/rcore-os/rcore-user
- Owner: rcore-os
- Created: 2019-01-04T10:42:53.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-06-07T02:54:12.000Z (over 2 years ago)
- Last Synced: 2024-11-09T15:42:40.349Z (2 months ago)
- Language: C
- Size: 4.4 MB
- Stars: 18
- Watchers: 7
- Forks: 20
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# rCore-user
[](https://travis-ci.org/rcore-os/rcore-user)
* [rCore-user](#rcore-user)
* [Build](#build)
* [Support matrix](#support-matrix)
* [How to run real world programs](#how-to-run-real-world-programs)
* [How to use Redis](#how-to-use-redis)
* [How to use nginx](#how-to-use-nginx)
* [How to use gcc](#how-to-use-gcc)
User programs for [rCore OS](https://github.com/rcore-os/rCore).
Now it has 6 parts:
* `ucore`: C-lang, from the original [ucore_os_lab](https://github.com/chyyuu/ucore_os_plus)
* `biscuit`: C/C++, from [Biscuit](https://github.com/mit-pdos/biscuit), based on a `musl` instead of original `litc`.
* `rust`: Simple no_std Rust programs.
* `app`: C-lang, custom test programs based on `musl`.
* `nginx`, `redis`, `busybox`, `alpine`, `gcc`: Real world applications.
* `vmm`: Simple VMM (Virtual Machine Monitor) runs on top of [RVM](https://github.com/rcore-os/RVM), can run the unmodified [ucore_os_lab](https://github.com/chyyuu/os_kernel_lab/tree/master) as a guest OS.
## Build
Install prebuilt musl toolchain from [musl.cc](https://musl.cc).
See Travis script 'install' section for details.
Then, build userspace programs for rCore:
```bash
$ make {ucore,biscuit,rust,nginx,redis,all} ARCH={x86_64,aarch64,riscv32,riscv64,mipsel}
$ make alpine ARCH={x86_64,aarch64} # if you want to use alpine rootfs
$ make test ARCH={x86_64} # test alpine real apps, e.g. python, gcc, rust, go, lua, etc.(need rootfs with these real apps)
$ make sfsimg ARCH={x86_64,aarch64,riscv32,riscv64,mipsel}
```
A rootfs is created at `build/$(arch)` and converted to `qcow2`.
## Support matrix
| | x86_64 | aarch64 | riscv32 | riscv64 | mipsel |
| ------------------ | ------ | ------- | ------- | ------- | ------ |
| ucore | ✅ | ✅ | ✅ | ✅ | ❗ |
| rust | ✅ | ✅ | ✅ | ✅ | ✅ |
| biscuit | ✅ | ✅ | ✅ | ✅ | ✅ |
| app | ✅ | ✅ | ✅ | ✅ | ✅ |
| nginx (linux only) | ✅ | ✅ | ❗ | ✅ | ❗ |
| redis (linux only) | ✅ | ✅ | ✅ | ✅ | ✅ |
| busybox | ✅ | ✅ | ✅ | ✅ | ✅ |
| alpine rootfs | ✅ | ✅ | ❌ | ❌ | ❌ |
| iperf3 | ✅ | ❌ | ❌ | ❌ | ❌ |
| test | ✅ | ❌ | ❌ | ❌ | ❌ |
| vmm (linux only) | ✅ | ❌ | ❌ | ❌ | ❌ |
Note: ❗ means workarounds are used so that they may not work properly. ❌ means failure in compiling or not existed on such platform.
## How to run real world programs
### How to use Redis
If redis is dynamically linked to musl (default if you use commands above), you might need to copy `ld-musl-$(arch).so.1` to rootfs `/lib` by yourself .Alpine rootfs includes one as well.
After building redis, you should be able to run redis-server in rCore. Then, start `redis-server` in rCore:
```bash
/> redis-server redis.conf
```
Then you should be able to connect to it using `redis-cli` over the network:
```bash
$ redis-cli -h 10.0.0.2 get abc
(nil)
$ redis-cli -h 10.0.0.2 set abc def
OK
$ redis-cli -h 10.0.0.2 get abc
"def"
```
Note: `redis-cli` in rCore is not working at the time.
### How to use nginx
Nginx is statically linked to musl instead, so there is no need to copy its dynamic loader. A nginx.conf is provided in this repo and automatically copied to its destination. So, just start `nginx` directly:
```bash
/> nginx
```
Then you should be able to visit it via network:
```bash
$ curl http://10.0.0.2/
Index of /
Index of /
../
bin/ 01-Jan-1970 00:00 -
biscuit/ 01-Jan-1970 00:00 -
dev/ 01-Jan-1970 00:00 -
etc/ 01-Jan-1970 00:00 -
home/ 01-Jan-1970 00:00 -
lib/ 01-Jan-1970 00:00 -
media/ 01-Jan-1970 00:00 -
mnt/ 01-Jan-1970 00:00 -
opt/ 01-Jan-1970 00:00 -
proc/ 01-Jan-1970 00:00 -
root/ 01-Jan-1970 00:00 -
run/ 01-Jan-1970 00:00 -
rust/ 01-Jan-1970 00:00 -
sbin/ 01-Jan-1970 00:00 -
srv/ 01-Jan-1970 00:00 -
sys/ 01-Jan-1970 00:00 -
tmp/ 01-Jan-1970 00:00 -
usr/ 01-Jan-1970 00:00 -
var/ 01-Jan-1970 00:00 -
busybox 01-Jan-1970 00:00 1141024
nginx 01-Jan-1970 00:00 741288
nginx-remote 01-Jan-1970 00:00 762440
nginx.conf 01-Jan-1970 00:00 99
redis-cli 01-Jan-1970 00:00 221256
redis-server 01-Jan-1970 00:00 1120888
redis.conf 01-Jan-1970 00:00 18
```
It is generated by `autoindex`.
Note: `nginx` might lead to an unresolved file system bug, so you might need to re-create sfs img after killing it.
Note: if you want to run nginx in rCore with qemu, you have to set `net = on` when make run. After that, configure the ip of new device tap0.
```` bash
# Commands on linux
make run net=on ARCH={riscv32,riscv64,x86_64,aarch64,mipsel}
# in qemu
./nginx
# then in a new cmd, "ip link show" will present a new device tap0
sudo ifconfig tap0 10.0.0.1
ping 10.0.0.1 # success
curl 10.0.0.2 # rCore root directory structure is returned
````
### How to use gcc
First, download prebuilt musl toolchain from [musl.cc](https://musl.cc), for example `x86_64-linux-musl-cross.tgz`. Untar it into `build/x86_64` directory. You are expected have a `build/x86_64/x86_64-linux-musl` directory now.
To build a simple C program, `printf.c` for example:
```bash
$ x86_64-linux-musl-cross/bin/x86_64-linux-musl-gcc printf.c -c -o printf.o
$ x86_64-linux-musl-cross/bin/x86_64-linux-musl-ld -dynamic-linker /lib/ld-musl-x86_64.so.1 x86_64-linux-musl-cross/x86_64-linux-musl/lib/crt1.o x86_64-linux-musl-cross/x86_64-linux-musl/lib/crtn.o x86_64-linux-musl-cross/lib/gcc/x86_64-linux-musl/8.3.0/crtbeginS.o x86_64-linux-musl-cross/lib/gcc/x86_64-linux-musl/8.3.0/crtendS.o printf.o -o printf -lc -static
```
You can now run the produced program:
```bash
$ printf
Built within rCore
```
Note: the long linker args can be replaced by invoking gcc instead later when we fix the problem. If you encountered `rcore-fs-fuse` panicking, consider upgrading it to latest version.
### How to test real alpine apps
#### simple test for alpine minifs with little apps
```bash
1. make alpine ARCH=x86_64
2. make test ARCH=x86_64
3. make sfsimg ARCH=x86_64
4. cd $(RCORE_ROOT)/kernel; make run ARCH=x86_64 mode=release
```
#### test gcc/go/python2/python3/ruby/lua/java/rust
```bash
1. download x86_64.qcow2.realapps.xz from cloud tsinghua
2. xz -d x86_64.qcow2.realapps.xz; mv x86_64.qcow2.realapps x86_64.qcow2
3. mv x86_64.qcow2 $(RCORE_ROOT)/user/build
4. cd $(RCORE_ROOT)/kernel; make run ARCH=x86_64 mode=release
```
### How to run uCore in rCore
Clone this repo recursively with [rcore-vmm](https://github.com/rcore-os/rcore-vmm) and [ucore_os_lab](https://github.com/chyyuu/os_kernel_lab/tree/master):
```bash
$ git clone https://github.com/rcore-os/rcore-user.git --recursive
```
Build with `EN_VMM=y`:
```bash
$ make sfsimg ARCH=x86_64 EN_VMM=y
```
Build and run [rCore](https://github.com/rcore-os/rCore) with `HYPERVISOR=on`:
```bash
$ cd $(RCORE_ROOT)/kernel
$ make run mode=release ARCH=x86_64 HYPERVISOR=on
```
Run the `vmm` app in rCore shell:
```
Hello world! from CPU 0!
/ # cd vmm
/vmm # ./vmm
rvm fd = 3
vmid = 1
UCORE_BIOS_ENTRY = 0x9000
[INFO] success to map ucore.img to ide base:disk = 0:0
[INFO] success to add empty disk 134217728 bytes, base:disk = 0:1
[INFO] success to map sfs.img to ide base:disk = 1:0
vcpu_id = 1
(THU.CST) os is loading ...
```
Now uCore is booting and your can get uCore's shell soon.