实验小项目招新：支持多种架构的 hal 层 crate

[yfblock]

1. 目前支持 x86_64, aarch64, loongarch64, riscv64，
2. 尝试发布到 crates.io，补全文档，提供一个比较好的引导方式和 demo.
3. 移植到 visionfive2.
4. 支持 multicore, 内核中断.
5. 支持 virtio-drivers for loongarch64 (TODO list....)
6. 考虑HAL支持 用户态libOS模式（可参考zCore的libOS设计）
7. 2024.04.27: xsp plan -- https://github.com/rcore-os/rCore-Tutorial-v3 support polyhal
8. 2024.06.02: xsp plan -- https://github.com/rcore-os/rCore-Tutorial-in-single-workspace support polyhal
9. 2024.xxx.xx: xsp plan -- https://github.com/rcore-os/rCore-Tutorial-in-single-workspace support polyhal & SMP
10. 2024.xxx.xx: xsp plan -- finish master thesis rcore-tutorial key techs: component-based, SMP support , polyhal support

[yfblock]

hal 层 repo: https://github.com/Byte-OS/arch

目前的 hal 层支持 byte-os 和 rcore-tutorial.

ByteOS

下面介绍怎么运行

环境准备

git clone https://github.com/Byte-OS/ByteOS.git
cd ByteOS
git reset 655eef3e38b5a85baaab4b2ba33832fbb299f19a --hard
git clone https://github.com/Byte-OS/arch.git
git reset cabff90bc4aecb7c8d3decb408c64e898112f6fe --hard

运行在一个特定的平台

run on riscv64

make ARCH=riscv64 LOG=error run

如果想要运行在别的平台上，那么将 ARCH 改为其他值。

rCore-tutorial-v3 ch7

环境准备

git clone https://github.com/yfblock/rcore-tutorial-v3-with-hal-component.git
git reset fe2c146dedeadcc5fa9db8402128e066e45ca5a9 --hard
git clone https://github.com/Byte-OS/arch.git
git reset cabff90bc4aecb7c8d3decb408c64e898112f6fe --hard

运行在一个特定平台上

make ARCH=riscv64 run

目前 tutorial 中存在一些 log, 并不影响运行。turorial 中可以使用测试程序 usertests 。

欢迎各位体验并提供反馈

[chyyuu]

关于用户态LibOS的HAL层设计步骤：

1. 把用户态libOS模式的zCore跑起来
2. 写出用户态libOS模式的设计实现的分析文档
3. 重构rCore Tutorial v3，让这个kernel支持用户态libOS模式
4. （Option）分析改进ArceOS的HAL，支持用户态libOS模式
5. （Option）分析改进 hal 层 repo: https://github.com/Byte-OS/arch，支持用户态libOS模式

[Huzhiwen1208]

总文档一览（更新中）：zCore探究

1. 用户态libOS模式的zCore运行，参考如下文档中的运行Libos形态的zCore章节：zCore探究
2. 用户态libOS模式的设计实现的分析文档：参考zCore LibOS模式的设计分析
3. 重构rCore Tutorial v3，使其支持用户态LibOS模式，实现参考：rCore-Tutorial-v3的LibOS设计（启动版），实验指导参考：rCore-Tutorial-v3的LibOS实验指导（启动版）

[Huzhiwen1208]

Test work for rcore with libos:

meta: repo: https://github.com/Huzhiwen1208/rcore-with-libos

if you want to use ci locally, you could:

wget https://raw.githubusercontent.com/nektos/act/master/install.sh
sh install.sh
sudo ./bin/act

Test failed list:

chapter	reason	fixed?

Passed ci list

We use output retrieval to assert the success or failure of task step, which works well with adapting to loongarch64.

1. ch1-ci: https://github.com/Huzhiwen1208/rcore-with-libos/actions/runs/9364968544
2. ch2-ci:
3. ch3-ci:
4. ch4-ci:
5. ch5-ci:
6. ch6-ci:
7. ch7-ci:
8. ch8-ci:

[yfblock]

1. 完善 polyhal Unit Test
   1.1 CI(Github Actions), (Build Environment, Test)
   1.2 fix bugs

2. 建立环境
   2.1 collect modules info from org. (use a static list to store external repos)

3. 完善 polyhal 集成Test
   3.1 ByteOS
   3.2 Starry

[xushanpu123]

目前我们已经初步完成了基于polyhal支持rcore_tutorial的ch1到ch9，项目仓库链接为：https://github.com/xushanpu123/rCore-Tutorial-v3
其中每个branch x都有名为methods_for_chx_on_polyhal.md的文档来介绍具体的工作过程，其中，ch4、ch5、ch8、ch9还只完成了对riscv64架构的支持，其它的chapter则支持了riscv64、x86_64、aarch64、loongarch64 4种架构的支持。
具体来说，polyhal可以代替任何与架构相关的底层操作，比如对中断的处理，任务的切换，页表的设计、操作系统的初始化工作等，为os开发提供了极大的便利性，但是在应用到rcore tutorial时会出现一些特殊的问题，比较突出的一个问题就是在ch1-ch3 rcore tutorial本身还没有启用地址映射机制的时候，polyhal已经自动开启了页表，因此产生了一系列的用户地址访问权限的问题，另外，高半核的设计造成了rcore tutorial中几乎所有的硬编码虚拟地址都需要进行|VIRT_ADDR_START后才能正常使用。对于x86_64的支持还产生过一些与动态链接相关的问题，这些在文档中都有相关记录。
欢迎大家review我们的工作并提出宝贵意见。

[Huzhiwen1208]

Test work for rcore with polyhal:

meta: repo: https://github.com/sysones/rcore-tutorial-v3-with-hal-component

if you want to use ci locally, you could:

wget https://raw.githubusercontent.com/nektos/act/master/install.sh
sh install.sh
sudo ./bin/act

Test failed list:

chapter	reason	fixed?
ch3	x86_64 don't support context switch without page table	yes, impl ctx switch in polyhal
ch4	x86_64 don't support .align 3 in os/build.rs	yes, fixed it with .align 2
ch5	heap allocate error in aarch64	yes, expand the kernel heap mem
ch5	x86_64 don't support .align 3 in os/build.rs	yes, fixed it with .p2align 3
ch5	x86_64 page fault: user restore failed	yes, add .ALIGN 4K to linker.ld
ch6	usertests failed in stackoverflow	yes, segmentation fault code from -2 to -11
ch8	riscv64 usertests error code not matched	yes
ch8	x86_64, aarch64 usertests-thread problem	yes, fixed by yublock, fixed jeffy in x86, enable irq in aarch64

Passed ci list

We use output retrieval to assert the success or failure of task step, which works well with adapting to loongarch64.

1. ch1-ci: https://github.com/sysones/rcore-tutorial-v3-with-hal-component/actions/runs/9280968054
2. ch2-ci: https://github.com/sysones/rcore-tutorial-v3-with-hal-component/actions/runs/9279984831
3. ch3-ci: https://github.com/sysones/rcore-tutorial-v3-with-hal-component/actions/runs/9279960286
4. ch4-ci: https://github.com/sysones/rcore-tutorial-v3-with-hal-component/actions/runs/9282992438
5. ch5-ci: https://github.com/sysones/rcore-tutorial-v3-with-hal-component/actions/runs/9348030190
6. ch6-ci: https://github.com/sysones/rcore-tutorial-v3-with-hal-component/actions/runs/9281987810
7. ch7-ci: https://github.com/sysones/rcore-tutorial-v3-with-hal-component/actions/runs/9211885006
8. ch8-ci: https://github.com/sysones/rcore-tutorial-v3-with-hal-component/actions/runs/9347070776

[yfblock]

riscv64 usertests error code not matched

Suggestions:

1. replace .align 3 with .p2allign 3
2. Check if the linker-x86_64.ld file and .plt sections of ch5 is aligned with 4k?

[xushanpu123]

目前已经完全实现四种架构以及可以通过的CI的章节为ch1、ch2、ch3、ch4、ch6、ch7，ch5在x86_64下有个别测例没有通过，而ch8的x86_64和aarch64下与时钟中断有关的测例（比如addr）无法通过，经过调试发现x86_64架构下polyhal无法在用户态下发出或相应时钟中断，aarch64架构下polyhal并没有打开时钟中断。ch9完整支持了riscv架构，其它架构还差中断控制器没有支持。

[xushanpu123]

基于polyhal，已经完成了除ch9 loongarch64架构下的其它所有章节和架构的支持，仓库链接为:https://github.com/xushanpu123/rCore-Tutorial-v3

[xushanpu123]

基于polyhal实现了rCore-Tutorial-in-single-workspace的ch1的riscv架构支持