f3 项目技术文档

1. 安装指南

1.1 下载与编译

首先，从GitHub下载f3的稳定版本源码包：

$ unzip f3-8.0.zip

1.2 在Linux或FreeBSD上编译

进入解压后的目录，执行以下命令进行编译：

$ make

如果需要安装f3write和f3read，可以运行：

$ make install

1.3 在Windows/Cygwin上编译

在Windows上使用Cygwin编译时，需要安装以下依赖包：

• gcc-core
• make
• libargp-devel

然后设置编译选项并进行编译：

$ export LDFLAGS="$LDFLAGS -Wl,--stack,4000000 -largp"
$ make

安装命令：

$ make install

1.4 在Apple Mac上编译

在Mac上可以使用HomeBrew或MacPorts进行安装：

使用HomeBrew

$ brew install f3

使用MacPorts

$ port install f3

如果需要手动编译，首先安装Apple命令行工具：

$ xcode-select --install

然后安装HomeBrew或MacPorts，并安装argp-standalone库：

$ brew install argp-standalone

最后，进行编译：

$ make

1.5 使用Docker安装

可以使用Docker快速启动f3工具。首先拉取预构建的Docker镜像：

$ docker run -it --rm --device /dev/sdX peron/f3 f3probe --destructive --time-ops /dev/sdX

如果需要自定义构建Docker镜像，可以执行以下命令：

$ make docker

或

$ docker build -t f3:latest .

然后运行f3命令：

$ docker run -it --rm --device /dev/sdX f3:latest f3probe --destructive --time-ops /dev/sdX

2. 项目的使用说明

2.1 测试性能

使用f3write和f3read测试闪存卡的性能：

$ ./f3write /media/michel/5EBD-5C80/
$ ./f3read /media/michel/5EBD-5C80/

请将路径替换为实际的挂载路径。

2.2 快速容量测试

使用f3probe进行快速容量测试：

$ ./f3probe --destructive --time-ops /dev/sdX

注意：此操作会破坏磁盘上的所有数据。

2.3 修正容量

使用f3fix修正闪存卡的实际容量：

$ ./f3fix --last-sec=16477878 /dev/sdX

3. 项目API使用文档

3.1 f3write

f3write用于将伪随机数据写入闪存卡，测试其写入性能。

$ f3write /path/to/mount/point

3.2 f3read

f3read用于读取并验证闪存卡中的数据，确保其与写入的数据一致。

$ f3read /path/to/mount/point

3.3 f3probe

f3probe用于快速测试闪存卡的容量，适用于大容量磁盘。

$ f3probe --destructive --time-ops /dev/sdX

3.4 f3fix

f3fix用于修正闪存卡的实际容量，创建一个与实际大小匹配的分区。

$ f3fix --last-sec=16477878 /dev/sdX

4. 项目安装方式

4.1 源码编译安装

通过源码编译安装f3工具：

$ make
$ make install

4.2 使用包管理器安装

在Mac上可以使用HomeBrew或MacPorts安装：

$ brew install f3

或

$ port install f3

4.3 使用Docker安装

通过Docker快速启动f3工具：

$ docker run -it --rm --device /dev/sdX peron/f3 f3probe --destructive --time-ops /dev/sdX