[Manual] Reviewers find document issues and provide prompts. [AI] Modified the document using prompts.

Author: jfb8856606

doc/F-Stack_Development_Guide.md

@@ -13,14 +13,17 @@ F-Stack is an open source high performant network framework based on DPDK with t
 
 ## Structure of F-Stack code
 
-    ├── app  -- Nginx(1.16.1)/Redis(3.2.8)/Microthread framework
+    ├── app  -- Nginx(1.28.0)/Redis(6.2.6)/Microthread framework
+    ├── adapter  -- Network adapters (micro_thread, syscall via LD_PRELOAD)
     ├── config.ini
-    ├── doc
-    ├── dpdk -- Intel DPDK(16.07) directory
+    ├── doc  -- Original English documentation
+    ├── docs  -- Three-layer architecture knowledge base documentation
+    ├── dpdk -- Intel DPDK(23.11.5) directory
     ├── example -- DEMO
-    ├── freebsd -- FreeBSD(11.0) Network Stack directory
+    ├── freebsd -- FreeBSD(13.0) Network Stack directory
     ├── lib -- F-Stack lib directory
     ├── mk
+    ├── tools -- Utility scripts (top, sysctl, ifconfig, etc.)
     └── start.sh
 
 

docs/01-LAYER1-ARCHITECTURE.md

@@ -90,7 +90,11 @@ NIC 驱动 (igb_uio / vfio-pci)
 │   └── compiler.mk     # 编译器配置
 │
 ├── tools/                        # 工具脚本
-├── doc/                          # 文档
+├── adapter/                      # 网络适配器
+│   ├── micro_thread/             # 微线程接口，方便有状态应用使用 F-Stack
+│   └── syscall/                  # 通过 LD_PRELOAD 劫持 Linux syscall 为 F-Stack API
+├── doc/                          # 原始英文文档
+├── docs/                         # 三层架构知识库文档
 └── config.ini                    # 默认配置文件
 ```
 
@@ -176,7 +180,7 @@ process_packets() 函数
 ### 4.3 发包流程 (Egress)
 
 ```
-应用 (ff_write/ff_sendto)
+应用 (ff_write/ff_send/ff_sendto/ff_sendmsg)
   ↓
 FreeBSD TCP/UDP 栈
   ├─ tcp_output() / udp_output()

docs/02-LAYER2-INTERFACES.md

@@ -100,7 +100,7 @@ int ff_rtioctl(int req, struct rt_addrinfo *info);
 // 零拷贝 mbuf 操作
 struct rte_mbuf *ff_zc_mbuf_get(int s);
 int ff_zc_mbuf_write(int s, struct rte_mbuf *m);
-int ff_zc_mbuf_read(int s, struct rte_mbuf **m);
+int ff_zc_mbuf_read(int s, struct rte_mbuf **m);  // 【注】暂未实现，后续考虑支持
 
 // 时间相关
 int ff_gettimeofday(struct timeval *tv, struct timezone *tz);

docs/03-LAYER3-FUNCTIONS.md

@@ -83,7 +83,7 @@
 |-----|------|------|
 | `ff_zc_mbuf_get` | 获取零拷贝 mbuf | 直接访问 DMA 缓冲 |
 | `ff_zc_mbuf_write` | 零拷贝写入 | 跳过内存拷贝 |
-| `ff_zc_mbuf_read` | 零拷贝读取 | 接收原始 mbuf |
+| `ff_zc_mbuf_read` | 零拷贝读取 | 接收原始 mbuf（**暂未实现，后续考虑支持**） |
 | `ff_mbuf_gethdr` | 获取 mbuf | DPDK 内存池分配 |
 | `ff_mbuf_get` | 分配 mbuf | - |
 | `ff_mbuf_free` | 释放 mbuf | - |
@@ -592,8 +592,15 @@ gcc -o myapp main.c \
     -lpthread -lm -O2
 
 # 运行示例
-# 指定 CPU 核心和 NIC 端口
-./myapp -l 0 -w 0000:01:00.0
+# 使用 start.sh 指定 config.ini 配置文件启动（推荐方式）
+bash start.sh -c config.ini -b ./myapp
+
+# start.sh 会根据 config.ini 中的 lcore_mask 自动计算进程数，
+# 依次启动主进程 (--proc-type=primary) 和从进程 (--proc-type=secondary)。
+# 等效于:
+#   ./myapp --conf config.ini --proc-type=primary --proc-id=0
+#   ./myapp --conf config.ini --proc-type=secondary --proc-id=1
+#   ...
 ```
 
 ## 6. 线程安全性规则

docs/F-Stack_Architecture_Layer1_System_Overview.md

@@ -126,10 +126,21 @@ F-Stack 模式 (用户态网络)
 │   ├── top/                  # CPU 统计
 │   ├── sysctl/               # 参数管理
 │   ├── ifconfig/             # 网卡配置
+│   ├── route/                # 路由管理
+│   ├── netstat/              # 网络统计
+│   ├── arp/                  # ARP 表管理
+│   ├── ipfw/                 # 防火墙管理
+│   ├── knictl/               # KNI 控制
+│   ├── traffic/              # 流量统计
+│   ├── ndp/                  # IPv6 邻居发现
+│   ├── ngctl/                # Netgraph 控制
 │   └── compat/ff_ipc.*       # IPC 通信库
 │
 ├── adapter/                                # 网络适配器
-├── doc/                                    # 文档
+│   ├── micro_thread/             # 微线程接口，方便有状态应用使用 F-Stack
+│   └── syscall/                  # 通过 LD_PRELOAD 劫持 Linux syscall 为 F-Stack API
+├── doc/                                    # 原始英文文档
+├── docs/                                   # 三层架构知识库文档
 ├── config.ini                # 默认配置文件
 └── start.sh                  # 多进程启动脚本
 ```
@@ -309,7 +320,7 @@ FreeBSD 网络栈
   ├─ tcp_input()/udp_input() [L4 层]
   └─ sorecvX()            [Socket 接收缓冲]
   ↓
-应用通过 ff_read()/ff_recv() 获取数据
+应用通过 ff_read()/ff_recv()/ff_recvfrom()/ff_recvmsg() 获取数据
 ```
 
 **关键特性**：
@@ -320,7 +331,7 @@ FreeBSD 网络栈
 #### **发送路径 (Egress)**
 
 ```
-应用调用 ff_write()/ff_send()/ff_sendto()
+应用调用 ff_write()/ff_send()/ff_sendto()/ff_sendmsg()
   ↓
 FreeBSD TCP/UDP 协议栈
   ├─ tcp_output()      [TCP 分段/排序]
@@ -769,6 +780,12 @@ LD_PRELOAD=libff_syscall.so nginx
   connect() → ff_connect()
   read() → ff_read()
   write() → ff_write()
+  send() → ff_send()
+  sendto() → ff_sendto()
+  sendmsg() → ff_sendmsg()
+  recv() → ff_recv()
+  recvfrom() → ff_recvfrom()
+  recvmsg() → ff_recvmsg()
   ...
 ```
 
@@ -786,6 +803,9 @@ LD_PRELOAD=libff_syscall.so nginx
 | **arp** | ARP 表 | 查询 DPDK 内部状态 |
 | **ipfw** | 防火墙 | FF_IPFW_CTL 消息 |
 | **knictl** | KNI 控制 | FF_KNICTL 消息 |
+| **traffic** | 流量统计 | FF_TRAFFIC 消息，支持多进程汇总 |
+| **ndp** | IPv6 邻居发现 | ioctl 通信 (SIOCGNBRINFO_IN6 等) |
+| **ngctl** | Netgraph 控制 | FF_NGCTL 消息 |
 
 ---
 

docs/F-Stack_Architecture_Layer2_Interface_Specification.md

@@ -48,7 +48,7 @@ F-Stack 导出 **80+ 个公开符号**，分为以下几大类：
 │                                                 │
 │ 8. 零拷贝 Mbuf (3 个)                          │
 │    ff_zc_mbuf_get / ff_zc_mbuf_write           │
-│    ff_zc_mbuf_read / ...                       │
+│    ff_zc_mbuf_read (暂未实现) / ...             │
 │                                                 │
 │ 9. 多线程支持 (2 个)                           │
 │    ff_pthread_create / ff_pthread_join         │
@@ -246,7 +246,7 @@ struct ff_zc_mbuf * ff_zc_mbuf_get(uint16_t len);
 
 ssize_t ff_zc_mbuf_write(int fd, struct ff_zc_mbuf *zm);
 ssize_t ff_zc_mbuf_read(int fd, struct ff_zc_mbuf *zm);
-    // 零拷贝 I/O
+    // 零拷贝 I/O  【注】ff_zc_mbuf_read 暂未实现，后续考虑支持
 ```
 
 **日志接口**：
@@ -490,7 +490,9 @@ F-Stack 提供 Linux 兼容的系统调用接口，但底层依赖 FreeBSD 协
 | 发送 | ff_send() | send() | flags: MSG_MORE 等 |
 | 接收 | ff_recv() | recv() | 同上 |
 | 发送到 | ff_sendto() | sendto() | UDP only |
+| 发送消息 | ff_sendmsg() | sendmsg() | 支持 msghdr 控制信息 |
 | 接收自 | ff_recvfrom() | recvfrom() | UDP only |
+| 接收消息 | ff_recvmsg() | recvmsg() | 支持 msghdr 控制信息 |
 
 ### 2.3 事件多路复用映射
 
@@ -739,29 +741,25 @@ ff_init(argc, argv)
 #### **进程启动脚本示例**
 
 ```bash
-#!/bin/bash
-# start.sh - 启动多进程 F-Stack
-
-CONFIG_FILE="config.ini"
-LCORE_MASK=0x0f  # 使用核心 0-3
-
-# 计算进程数 = lcore_mask 中设置的位数
-NUM_PROCESSES=4
-
-# 启动主进程
-export proc_type=primary
-export proc_id=0
-./app ${CONFIG_FILE} -l ${LCORE_MASK} &
-sleep 5  # 等待主进程初始化完成
-
-# 启动从进程
-for i in $(seq 1 $((NUM_PROCESSES-1))); do
-    export proc_type=secondary
-    export proc_id=$i
-    ./app ${CONFIG_FILE} -l ${LCORE_MASK} &
-done
-
-wait  # 等待所有进程
+# 使用 F-Stack 自带的 start.sh 启动（推荐方式）
+# start.sh 参数说明:
+#   -c [conf]   配置文件路径 (默认 config.ini)
+#   -b [bin]    应用程序路径 (默认 ./example/helloworld)
+#   -o [args]   传递给应用的额外参数
+
+# 示例: 使用 config.ini 启动自定义应用
+bash start.sh -c config.ini -b ./app
+
+# start.sh 会自动完成以下工作:
+# 1. 读取 config.ini 中的 lcore_mask，计算需要启动的进程数
+# 2. 启动主进程: ./app --conf config.ini --proc-type=primary --proc-id=0
+# 3. 等待 5 秒后依次启动从进程:
+#    ./app --conf config.ini --proc-type=secondary --proc-id=1
+#    ./app --conf config.ini --proc-type=secondary --proc-id=2
+#    ...
+
+# 如需传递额外参数给应用:
+bash start.sh -c config.ini -b ./app -o "--extra-arg value"
 ```
 
 ### 4.2 进程间通信 (IPC)
@@ -1172,7 +1170,9 @@ symmetric_rss = 1  # 双向连接到同一队列
 | **arp** | ARP 表查询 | 直接读内存 | `arp -a` |
 | **ipfw** | 防火墙规则 | FF_IPFW_CTL | `ipfw add ...` |
 | **knictl** | 虚拟网卡控制 | FF_KNICTL | `knictl set-rate ...` |
-| **traffic** | 流量统计导出 | FF_TRAFFIC | `traffic --json` |
+| **traffic** | 流量统计导出 | FF_TRAFFIC | `traffic -p <proc_id> -d <secs>` |
+| **ndp** | IPv6 邻居发现 | ioctl (SIOCGNBRINFO_IN6) | `ndp -C <proc_id> -a` |
+| **ngctl** | Netgraph 控制 | FF_NGCTL | `ngctl -p <proc_id> list` |
 
 ### 6.2 应用集成接口
 

docs/F-Stack_Architecture_Layer3_Function_Index.md

@@ -313,6 +313,7 @@ ssize_t ff_zc_mbuf_write(int fd, struct ff_zc_mbuf *zm)
 ssize_t ff_zc_mbuf_read(int fd, struct ff_zc_mbuf *zm)
     // 零拷贝接收 (应用获取指向报文的指针)
     // 线程安全: 是
+    // 【注】暂未实现，后续考虑支持
 ```
 
 #### **多线程支持 (2 个)**
@@ -1125,8 +1126,9 @@ python dpdk_devbind.py -b igb_uio 0000:05:00.0  # 绑定网卡
 modprobe vfio_pci
 python dpdk_devbind.py -b vfio-pci 0000:05:00.0
 
-# 3. 运行应用
-./app -c 0x0f -n 4 -- -c config.ini
+# 3. 运行应用（使用 start.sh 指定 config.ini 配置文件启动）
+bash start.sh -c config.ini -b ./app
+# start.sh 会根据 config.ini 中的 lcore_mask 自动启动主/从进程
 ```
 
 ---

docs/F-Stack_Knowledge_Base_Summary.md

@@ -161,7 +161,7 @@ F-Stack 架构知识库
 
 生态集成
   → Nginx/Redis 集成方式
-  → 运维工具列表 (top/sysctl/route/etc)
+  → 运维工具列表 (top/sysctl/route/traffic/ndp/ngctl/etc)
 ```
 
 **适读人群**: 架构师、CTO、性能分析师、系统设计师
@@ -211,7 +211,7 @@ F-Stack 架构知识库
   → 5 个性能优化建议
 
 工具与集成
-  → 8 个 IPC 运维工具
+  → 11 个 IPC 运维工具
   → LD_PRELOAD 集成方式
   → 应用集成接口
 ```
@@ -410,8 +410,14 @@ ff_close(fd);
 // I/O 操作
 ssize_t n = ff_read(fd, buf, sizeof(buf));
 ssize_t n = ff_write(fd, data, len);      // 缓冲满返回 -1!
+ssize_t n = ff_readv(fd, iov, iovcnt);    // 分散读
+ssize_t n = ff_writev(fd, iov, iovcnt);   // 分散写
 ssize_t n = ff_send(fd, data, len, 0);
+ssize_t n = ff_sendto(fd, data, len, 0, &addr, addrlen);  // UDP 发送到指定地址
+ssize_t n = ff_sendmsg(fd, &msg, 0);      // 发送消息 (msghdr)
 ssize_t n = ff_recv(fd, buf, sizeof(buf), 0);
+ssize_t n = ff_recvfrom(fd, buf, sizeof(buf), 0, &addr, &addrlen);  // UDP 接收
+ssize_t n = ff_recvmsg(fd, &msg, 0);      // 接收消息 (msghdr)
 
 // 事件多路复用
 int kq = ff_kqueue();

docs/README.md

@@ -114,7 +114,9 @@ ff_init / ff_run / ff_stop_run
 
 // Socket (25+)
 ff_socket / ff_bind / ff_listen / ff_accept / ff_connect / ff_close
-ff_read / ff_write / ff_send / ff_recv / ...
+ff_read / ff_write / ff_readv / ff_writev
+ff_send / ff_sendto / ff_sendmsg
+ff_recv / ff_recvfrom / ff_recvmsg / ...
 
 // 事件多路复用 (5)
 ff_kqueue / ff_kevent / ff_select / ff_poll

docs/SUMMARY.txt

@@ -28,7 +28,7 @@ F-Stack v1.25 完整架构知识库 - 生成总结
 
 内容:
   - F-Stack 三大核心创新: Kernel Bypass / FreeBSD 移植 / 多核并行
-  - 顶层目录结构 (lib/, freebsd/, dpdk/, example/ 等)
+  - 顶层目录结构 (lib/, freebsd/, dpdk/, adapter/, example/, tools/, doc/, docs/ 等)
   - 模块职责边界 (8 个核心模块分析)
   - FreeBSD TCP/IP 栈完整移植方式
   - DPDK 集成与 NIC 驱动层详解