# CNOS

**Repository Path**: openOHO/cnos

## Basic Information

- **Project Name**: CNOS
- **Description**: 一个64位微内核操作系统，完全自研
- **Primary Language**: Unknown
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 1
- **Created**: 2026-04-12
- **Last Updated**: 2026-05-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# CNOS

CNOS（CN OS）是基于 **64 位微内核** 的实验性操作系统，通过 **GRUB2 + Multiboot2** 从 ISO 启动。默认提供 **帧缓冲图形桌面（LVGL）**、**串口日志** 与 **VGA 文本** 输出；文件系统侧接入 **e2fsprogs / libext2fs** 子集与自有 **VFS / CNAF**。

**仓库（Gitee）**：<https://gitee.com/openOHO/cnos>

克隆后请初始化子模块（含 **LVGL**）：

```bash
git clone https://gitee.com/openOHO/cnos.git
cd cnos
git submodule update --init --recursive
```

## 特性（概览）

- **引导**：Multiboot2 头位于 `.text` 最前；可选用 `gfxpayload=text` 保持 VGA 文本显存可见。
- **图形界面**：VBE 帧缓冲 + **LVGL** 桌面（任务栏、终端、设置、文件浏览器等）；**合成器（Compositor）** 负责 LFB 合成与窗口拖动纹理平移；可选 **V-Sync**（VGA 0x3DA）、三缓冲 partial 刷新。
- **统一抽象**：`kernel/ui/` 内 **时间轴**（`cnos_timeline`）、**逻辑坐标**（`cnos_coords`）、**合成器**（`cnos_compositor`）、**窗口管理约定**（`cnos_wm.h`）。
- **控制台**：`0xB8000` 文本缓冲 + COM1 镜像输出；Shell 经 PS/2 键盘（IRQ1）；PS/2 鼠标（IRQ12）供 GUI。
- **内存**：物理页管理（PMM）、页表（VMM）；渲染线程与主栈扩容以承载 LVGL。
- **文件系统**：VFS；`kernel/fs` 内含裁剪后的 **e2fsprogs** 源码树（仅部分文件编入内核，见 `kernel/fs/README`）；可选 **VirtIO 9p** 挂载宿主目录（QEMU `run.sh` 默认带 9p）。
<<<<<<< HEAD
=======
- **网络（实验）**：**VirtIO 网卡** + 极简 TCP/HTTP；QEMU **user** 网下 Shell 命令 `download` 可从自备 HTTP 服务拉取到 `/date/...`（见 `docs/net.md`）。
>>>>>>> c7d4346 (sdk)
- **应用包格式**：CNAF / CNAFL 规范与头校验（`kernel/fs/cnaf/`）。

## 依赖

| 工具 | 用途 |
|------|------|
| CMake ≥ 3.16 | 构建 |
| NASM | 内核汇编（`elf64`） |
| `x86_64-elf-gcc` + `x86_64-elf-ld` 等 | 裸机交叉编译（无 libc） |
| xorriso、`grub-mkrescue` | 生成 `cnos.iso`（可选；无则只生成 `kernel.elf`） |
| QEMU `qemu-system-x86_64` | 本地运行 ISO |

### 交叉工具链（多数 apt 源无预装包，需自行编译）

CNOS 需要 **目标三元组 `x86_64-elf`** 的裸机工具链（不是 `x86_64-linux-gnu`）。很多环境 **apt/dnf 里没有** 现成 `gcc-x86-64-elf`，需要 **从 GNU 源码编译 binutils + gcc**（或只用可信来源的预编译包）。

**与 CI 同源的一键脚本**（版本固定在脚本内：binutils / gcc 可从 GNU 镜像拉取）：

```bash
# 主机需已安装：gcc、g++、make、bison、flex、wget/curl、xz 等；脚本会在 gcc 源码树内运行 download_prerequisites 拉取 GMP/MPFR/MPC
sudo apt install build-essential bison flex texinfo curl xz-utils wget patch   # Debian/Ubuntu 示例

bash scripts/build-x86_64-elf-toolchain.sh "$HOME/opt/cross"
export PATH="$HOME/opt/cross/bin:$PATH"
```

若安装到仓库下的 `.cross`（与 GitHub Actions 默认一致）：

```bash
bash scripts/build-x86_64-elf-toolchain.sh "$(pwd)/.cross"
export PATH="$(pwd)/.cross/bin:$PATH"
```

更通用的手写步骤见 [OSDev Wiki: GCC Cross-Compiler](https://wiki.osdev.org/GCC_Cross-Compiler)。

CMake 通过 `PATH` 查找 `x86_64-elf-gcc`，也可用 `CNOS_X86_64_ELF_GCC` 指向编译器可执行文件（见 `cmake/x86_64-elf.cmake`）。

**不要**用 `x86_64-linux-gnu-gcc` 代替；若个别发行版 **恰好** 提供 `gcc-x86-64-elf` 包，也可直接 `apt install` 后使用，与脚本二选一即可。

## 构建

在仓库根目录执行（**先确保已 `git submodule update --init --recursive`**）：

```bash
cmake -B build -DCMAKE_TOOLCHAIN_FILE=cmake/x86_64-elf.cmake
cmake --build build
```

产物：

- `build/kernel.elf` — 内核 ELF  
- `build/cnos.iso` — 可启动镜像（需已安装 GRUB/xorriso）

若已配置过 `build/` 且未换工具链，可直接：

```bash
cmake -B build
cmake --build build
```

交叉编译器不在默认路径时：

```bash
export CNOS_X86_64_ELF_GCC=/path/to/x86_64-elf-gcc
cmake -B build -DCMAKE_TOOLCHAIN_FILE=cmake/x86_64-elf.cmake
cmake --build build
```

或使用 Makefile 封装：

```bash
make          # 首次自动带工具链文件配置
make clean    # 删除 build 目录
```

等价预设：`cmake --preset default`（见 `CMakePresets.json`）。

## 运行（QEMU）

```bash
./run.sh
```

<<<<<<< HEAD
`run.sh` 默认约 **256M** 内存、**串口 stdio**、可选 **VirtIO 9p** 共享当前目录为 `host`。等价手动示例：
=======
`run.sh` 默认约 **256M** 内存、**串口 stdio**、**VirtIO user 网**（`10.0.2.15` / 网关 `10.0.2.2`）、可选 **VirtIO 9p** 共享当前目录为 `host`。等价手动示例：
>>>>>>> c7d4346 (sdk)

```bash
qemu-system-x86_64 -cdrom build/cnos.iso -m 256M -serial stdio
```

串口与 VGA 会同时输出；若只看终端，使用 `-serial stdio` 即可。

## 目录速览

| 路径 | 说明 |
|------|------|
| `kernel/` | 内核源码（C / NASM） |
| `kernel/ui/` | LVGL 集成、GUI API、`cnos_*` 合成与时间轴 |
| `lv_conf.h` | LVGL 配置（内存、刷新周期等） |
| `third_party/lvgl/` | LVGL 子模块 |
| `kernel/fs/cnos/` | e2fsprogs 适配（`config.h`、`cnos_alloc` 等） |
| `kernel/fs/cnaf/` | CNAF/CNAFL 头解析 |
| `kernel/fs/lib/ext2fs/` 等 | e2fsprogs 库源码（按需加入 CMake） |
| `cmake/x86_64-elf.cmake` | 裸机工具链 |
| `iso/boot/grub/grub.cfg` | GRUB 菜单（`multiboot2` 加载内核） |
| `scripts/build-x86_64-elf-toolchain.sh` | 从源码构建 `x86_64-elf` 交叉链（与 Actions 一致） |
| `.github/workflows/` | CI 与 Release（推送 `v*` tag 发布 ISO） |
| `docs/gui_api.md` | GUI Core / APP API 说明 |
<<<<<<< HEAD
=======
| `docs/net.md` | VirtIO 网卡、`download` 命令与自备 HTTP 说明 |
>>>>>>> c7d4346 (sdk)

更细的 **kernel/fs** 说明见 `kernel/fs/README`。

## 自动化（GitHub Actions）

- **不依赖** apt 里的 `gcc-x86-64-elf`：在 Runner 上执行 `scripts/build-x86_64-elf-toolchain.sh`，从 **GNU 官方源码** 编译 **binutils + gcc**（`x86_64-elf`），安装到 `${GITHUB_WORKSPACE}/.cross`。  
- **`actions/cache`** 缓存 `.cross` 目录；**首次运行**耗时会较长（完整编译工具链），**缓存命中**后只编译内核/ISO。  
- **CI**：推送/PR 至 `main` 时生成 `kernel.elf`、`cnos.iso`，并上传 Artifact。  
- **Release**：推送 `v*` 标签时同样先确保工具链，再发布 `cnos-<tag>.iso` 与 `kernel-<tag>.elf`。

自建 Runner 时：保证已安装脚本所需 **宿主编译依赖**（`build-essential`、`bison`、`flex`、`texinfo`、`curl`、`xz-utils` 等），与 Ubuntu 工作流一致即可。

## 语言与界面

- 控制台与 Shell 消息为 **英文** 为主；文档与注释可为 **中文**。  
- **图形界面** 默认编入内核（LVGL 桌面）；配置见根目录 `lv_conf.h`。

## 许可

上游 **e2fsprogs**、**LVGL** 等文件遵循其原有 GPL/LGPL 等声明；仓库内 CNOS 新增文件以项目整体许可为准（若未单独声明，请与维护者确认）。

---

*后续更新：ext2 挂载深化、CNAF 加载器、用户态等。*