# StarryOS-LoongArch

**Repository Path**: rust-osdev/StarryOS-LoongArch

## Basic Information

- **Project Name**: StarryOS-LoongArch
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-10-21
- **Last Updated**: 2024-10-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# StarryOS

## 简介

这里是StarryOS，一个基于ArceOS实现的宏内核。

> Starry意指布满星星的，寓意本OS的开发学习借鉴了许多前辈的思路，并将其汇总归一为这个内核。

在线文档详见：[Starry (azure-stars.github.io)](https://azure-stars.github.io/Starry/)

此分支是LoongArch64的移植版本，旨在LoongArch平台可以运行StarryOS。

## Usage

```shell
# 构建镜像
./build_img.sh sdcard
# 运行内核
make run

# 使用 ramdisk 加载测例并且运行内核，可以显著提高文件 IO 速度
make FEATURES=img run

```

## 项目结构

### 整体结构图

![image-20230603005345201](https://raw.githubusercontent.com/Azure-stars/Figure-Bed/main/image-20230603005345201.png)



### 模块依赖图

```mermaid
graph TD;
axsync-->axdisplay
axdriver-->axdisplay

axhal-->axdriver
axalloc-->axdriver
axconfig-->axdriver

axdriver-->axfs
axsync-->axfs
axtask-.dev.->axfs

axconfig-->axhal
axalloc-->axhal
axlog-->axhal

axhal-->axnet
axsync-->axnet
axtask-->axnet
axdriver-->axnet

axalloc-->axruntime
axconfig-->axruntime
axdriver-->axruntime
axhal-->axruntime
axlog-->axruntime
axnet-->axruntime
axdisplay-->axruntime
axtask-->axruntime
axprocess-->axruntime
axtask-->axsync
axtask-->axprocess
axfs-->axprocess
axhal-->axprocess

axalloc-->axtask
axhal-->axtask
axconfig-->axtask
axlog-->axtask

axfs-->axmem
axalloc-->axmem
axhal-->axmem
axmem-->axprocess
```

* crates：与OS设计无关的公共组件
* modules：与OS设计更加耦合的组件
* doc：每周汇报文档，当前位于doc分支上
* apps：unikernel架构下的用户程序，继承原有ArceOS
* scripts：makefile脚本，继承原有ArceOS
* ulib：用户库，继承原有ArceOS



## 测例切换和执行

执行如下指令可以生成sdcard文件镜像

```shell
$ ./build_img.sh sdcard
```

如果想要切换到其他测例，如切换到gcc，请在保证testcases/gcc文件夹下对应文件夹内容满足需求之后，执行如下指令

```shell
$ ./build_img.sh gcc
```

当使用 gcc 测例时，由于 gcc 测例内容过大，不直接拷贝到 ramdisk 上，因此不能启动 `FEATURES=img`。

通过修改指令可以切换生成的文件镜像中包含的测例。相应测例存放在`testcases/`文件夹下，如执行`./build_img.sh libc-static`可以生成libc静态测例。



## 文档

内核文档存放在`doc/Starry决赛设计文档.pdf`。

另外，可以通过静态部署网页[Starry (azure-stars.github.io)](https://azure-stars.github.io/Starry/)查看更好排版的文档。