Skip to content

Commit 2563623

Browse files
committed
Add arch docs' review docs, and modify.
1 parent 9e7c12c commit 2563623

10 files changed

+1067
-7
lines changed

docs/01-LAYER1-ARCHITECTURE.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,9 @@ NIC 驱动 (igb_uio / vfio-pci)
4343
- **连接建立**: 100 万+ CPS (Connection Per Second)
4444
- **延迟**: 微秒级 (vs 毫秒级内核栈)
4545

46+
<!-- 注: 此补充基于 2/3 评审意见一致 (GPT-5.4 + Claude) -->
47+
> **注意**: 以上性能数据为参考值,实际结果取决于硬件配置 (CPU/网卡)、测试场景和报文大小等条件。
48+
4649
## 2. 目录结构与模块边界
4750

4851
### 2.1 核心目录布局
@@ -75,7 +78,7 @@ NIC 驱动 (igb_uio / vfio-pci)
7578
│ └── build/ # 编译产物
7679
7780
├── app/ # 应用集成
78-
│ ├── nginx-1.25.2/
81+
│ ├── nginx-1.28.0/
7982
│ └── redis-6.2.6/
8083
8184
├── example/ # 示例代码
@@ -330,4 +333,5 @@ F-Stack 的架构设计围绕三个核心支柱:
330333
2. **成熟协议栈**: 复用 FreeBSD 久经考验的实现
331334
3. **多核并行**: 充分利用现代多核 CPU 和 NIC 硬件能力
332335
333-
这使得 F-Stack 能够达到 500 万+ RPS、10 亿+ 并发连接的性能水平,是云计算核心网络设施的理想选择。
336+
<!-- 注: 此修改基于 2/3 评审意见一致 (GPT-5.4 + Claude),原文“10 亿+”为笔误,与全文其他位置“1000 万+”不一致 -->
337+
这使得 F-Stack 能够达到 500 万+ RPS、1000 万+ 并发连接的性能水平,是云计算核心网络设施的理想选择。

docs/02-LAYER2-INTERFACES.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,14 @@
66
77
## 1. F-Stack API 完整列表 (80+ 导出函数)
88

9+
<!-- 注: 此补充基于 2/3 评审意见一致 (GPT-5.4 + Claude) -->
10+
> **API 层次说明**: F-Stack 的接口体系分为三个层级:
11+
> 1. **`ff_api.h` 主接口** — 包含 ff_init/ff_run/ff_stop_run 等生命周期函数及所有 socket/kqueue/sysctl 等函数声明
12+
> 2. **`ff_epoll.h` 补充接口** — epoll 兼容层 (ff_epoll_create/ff_epoll_ctl/ff_epoll_wait),独立于 ff_api.h
13+
> 3. **`ff_api.symlist` 动态导出符号表** — 定义实际动态链接时导出的符号。**注意**: ff_init/ff_run/ff_stop_run 不在此列表中,仅通过静态链接 (libfstack.a) 可用
14+
>
15+
> 做动态链接或语言绑定 (FFI) 时,应以 `ff_api.symlist` 为准确定可用符号。
16+
917
### 1.1 核心生命周期函数
1018

1119
```c

docs/03-LAYER3-FUNCTIONS.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@
66
77
## 1. 导出函数完整索引 (80+ 函数)
88

9+
<!-- 注: 此补充基于 2/3 评审意见一致 (GPT-5.4 + Claude) -->
10+
> **符号导出层次**: 以下函数索引包含 `ff_api.h``ff_epoll.h` 中声明的全部接口。实际通过 `ff_api.symlist` 动态导出的符号是其子集。
11+
> - ff_init / ff_run / ff_stop_run 在 `ff_api.h` 中声明但**不在** `ff_api.symlist` 中,仅通过静态链接可用
12+
> - ff_epoll_* 系列函数声明在 `ff_epoll.h` 中,不在 `ff_api.h`
13+
914
### 1.1 生命周期管理函数
1015

1116
| 函数 | 签名 | 功能 | 线程安全 |

0 commit comments

Comments
 (0)