Libiscsi 项目技术文档

1. 安装指南

1.1 安装依赖

在编译和安装 libiscsi 之前，确保系统上已经安装了以下依赖：

• libcunit1-dev（仅在需要编译测试套件时需要）

1.2 安装步骤

1. 进入项目根目录。
2. 运行以下命令进行安装：

   ./autogen.sh
   ./configure
   make
   sudo make install
   

1.3 构建 RPM 包

如果需要构建 RPM 包，可以运行以下脚本：

./packaging/RPM/makerpms.sh

2. 项目的使用说明

2.1 iSCSI URL 格式

libiscsi 使用特定的 URL 格式来指定 iSCSI 设备。格式如下：

iscsi://[<username>[%<password>]@]<host>[:<port>]/<target-iqn>/<lun>[?<argument>[&<argument>]*]

或

iser://[<username>[%<password>]@]<host>[:<port>]/<target-iqn>/<lun>[?<argument>[&<argument>]*]

2.2 CHAP 认证

CHAP 认证可以通过 URL 或环境变量进行设置。

2.2.1 通过 URL 设置

在 URL 中指定用户名和密码：

iscsi://ronnie%password@server/iqn.ronnie.test/1

2.2.2 通过环境变量设置

设置环境变量：

export LIBISCSI_CHAP_USERNAME=ronnie
export LIBISCSI_CHAP_PASSWORD=password

2.3 双向 CHAP 认证

双向 CHAP 认证可以通过 URL 参数或环境变量进行设置。

2.3.1 通过 URL 参数设置

在 URL 中指定目标用户名和密码：

iscsi://127.0.0.1/iqn.ronnie.test/1?target_user=target\&target_password=target

2.3.2 通过环境变量设置

设置环境变量：

export LIBISCSI_CHAP_TARGET_USERNAME=target
export LIBISCSI_CHAP_TARGET_PASSWORD=password

2.4 IPv6 支持

libiscsi 支持 IPv6，可以在 URL 中指定 IPv6 地址，格式如下：

iscsi://[fec0:2727::3]:3260/iqn.ronnie.test/1

2.5 Header Digest 和 Data Digest

libiscsi 支持 Header Digest 和 Data Digest。默认情况下，Header Digest 会提供 None 和 CRC32C，而 Data Digest 默认提供 None。可以通过调用 iscsi_set_header_digest() 和 iscsi_set_data_digest() 来强制设置特定的值。

3. 项目 API 使用文档

3.1 同步与异步 API

libiscsi 提供了同步和异步的 API。同步 API 适合简单的应用程序，而异步 API 则更适合需要高性能的应用程序。

3.2 示例代码

在 examples 目录中，提供了如何使用同步和异步 API 的示例代码。

3.3 测试工具

test-tool 目录中包含了一个 iSCSI 一致性测试套件。要编译测试套件，需要先安装 libcunit1-dev。

4. 项目安装方式

4.1 源码安装

通过源码安装 libiscsi 的步骤如下：

1. 下载源码包。
2. 解压源码包。
3. 进入项目根目录。
4. 运行以下命令进行安装：

   ./autogen.sh
   ./configure
   make
   sudo make install
   

4.2 构建 RPM 包

如果需要构建 RPM 包，可以运行以下脚本：

./packaging/RPM/makerpms.sh

通过以上步骤，您可以成功安装并使用 libiscsi 项目。