Libsqlfs 技术文档

1. 安装指南

作为库安装

Libsqlfs 提供了一个基于 GNU autoconf/automake 的构建系统，用于构建应用程序库。要构建，请按照标准的 GNU 配置约定进行。通常，以下命令就足够了：

./configure --prefix=<安装目录>
make && make install

如果未指定 <安装目录>，则默认为 /usr/local。

您需要以 root 用户身份安装到系统目录，如 /usr/local。

除非通过配置选项指定，否则将构建静态库和共享库。

作为 FUSE 模块安装

如果您想将其构建为 FUSE 模块，您的系统需要安装 libfuse。这种方式测试较少。

运行脚本后，您将得到一个名为 fuse_sqlfs 的可执行文件。以 root 用户身份运行以下命令来启动 FUSE 会话：

fuse_sqlfs <挂载点>

然后您将看到 libsqlfs 文件空间被暴露，并且可以通过 <挂载点> 被普通应用程序访问。

示例：

fuse_sqlfs /mnt/sqlfs &
ls /mnt/sqlfs

SQLite 数据库的位置在 fuse_main.c 中硬编码。根据需要更改 sqlfs_init() 的参数。

打开的数据库文件在 fuse_sqlfs.c 中硬编码为 /tmp/fsdata。如果您想使用不同的数据库文件或提供加密文件的密钥，只需编辑 fuse_sqlfs.c 并重新构建。

有关 libsqlfs 的示例应用程序，请参阅 tests/ 目录中的测试程序。

2. 项目使用说明

Libsqlfs 库实现了在 SQLite 数据库之上的 POSIX 风格文件系统。它允许应用程序访问一个完整的读写文件系统，该文件系统包含在自己的文件层次结构和命名空间中。这对于需要结构化存储的应用程序非常有用，例如在文档中嵌入文档或管理配置数据或首选项。

Libsqlfs 可以作为共享库使用，也可以构建为 FUSE 模块，允许通过操作系统级别的文件系统接口访问 libsqlfs 数据库。

3. 项目 API 使用文档

Libsqlfs 最初是作为 FUSE 模块开发的，因此它实现了 FUSE 版本 2.5.3 定义的原始操作。Libsqlfs 会话由 sqlfs_t 类型的对象表示。所有 API 都需要一个有效的 sqlfs_t 显式引用。

以下是一些实现的文件系统原始操作：

• int sqlfs_proc_getattr(sqlfs_t *, const char *path, struct stat *stbuf);
• int sqlfs_proc_access(sqlfs_t *, const char *path, int mask);
• int sqlfs_proc_readlink(sqlfs_t *, const char *path, char *buf, size_t size);
• int sqlfs_proc_readdir(sqlfs_t *, const char *path, void *buf, fuse_fill_dir_t filler, off_t offset, struct fuse_file_info *fi);
• int sqlfs_proc_mknod(sqlfs_t *, const char *path, mode_t mode, dev_t rdev);
• int sqlfs_proc_mkdir(sqlfs_t *, const char *path, mode_t mode);
• int sqlfs_proc_unlink(sqlfs_t *, const char *path);
• int sqlfs_proc_rmdir(sqlfs_t *, const char *path);
• int sqlfs_proc_symlink(sqlfs_t *, const char *path, const char *to);
• int sqlfs_proc_rename(sqlfs_t *, const char *from, const char *to);
• int sqlfs_proc_link(sqlfs_t *, const char *from, const char *to);
• int sqlfs_proc_chmod(sqlfs_t *, const char *path, mode_t mode);
• int sqlfs_proc_chown(sqlfs_t *, const char *path, uid_t uid, gid_t gid);
• int sqlfs_proc_truncate(sqlfs_t *, const char *path, off_t size);
• int sqlfs_proc_utime(sqlfs_t *, const char *path, struct utimbuf *buf);
• int sqlfs_proc_open(sqlfs_t *, const char *path, struct fuse_file_info *fi);
• int sqlfs_proc_read(sqlfs_t *, const char *path, char *buf, size_t size, off_t offset, struct fuse_file_info *fi);
• int sqlfs_proc_write(sqlfs_t *, const char *path, const char *buf, size_t size, off_t offset, struct fuse_file_info *fi);
• int sqlfs_proc_statfs(sqlfs_t *, const char *path, struct statvfs *stbuf);
• int sqlfs_proc_release(sqlfs_t *, const char *path, struct fuse_file_info *fi);
• int sqlfs_proc_fsync(sqlfs_t *, const char *path, int isfdatasync, struct fuse_file_info *fi);

它们的语义与 FUSE 文档和相应的 Unix 文件系统调用定义的相同。

此外，其他 API 提供了环境设置、事务支持和便利函数：

• int sqlfs_init(const char *); 初始化 libsqlfs 库并设置默认数据库文件名。
• int sqlfs_destroy(); 在所有操作完成后，清理 sqlfs_init()。
• int sqlfs_open(const char *db, sqlfs_t **); 创建到 libsqlfs 数据库的新连接。
• int sqlfs_open_key(const char *db_file, const char *key, sqlfs_t **sqlfs); 创建到加密的 libsqlfs 数据库的新连接并使用提供的密码解锁。
• int sqlfs_close(sqlfs_t *); 关闭并释放 libsqlfs 连接。

4. 项目安装方式

请按照以下步骤进行安装：

1. 下载 Libsqlfs 源代码。
2. 解压源代码。
3. 进入源代码目录。
4. 执行 ./configure --prefix=<安装目录> 命令。
5. 执行 make 命令。
6. 执行 make install 命令。

确保您以 root 用户身份安装到系统目录。如果您想要构建为 FUSE 模块，请确保您的系统安装了 libfuse。