RFC-0156：流附加模式

RFC-0156：数据流附加模式
状态	已接受
区域	内核
说明	为视频流添加了附加模式。
问题	88678
Gerrit 更改	664693
作者	cdrllrd@google.com
审核人	jamesr@google.com abarth@google.com rashaeqbal@google.com csuter@google.com
提交日期（年-月-日）	2022-04-06
审核日期（年-月-日）	2022-04-20

摘要

此 RFC 建议修改流 API，具体做法是向流添加附加模式，并从 zx_stream_writev 中移除附加选项。

设计初衷

流附加选项 ZX_STREAM_APPEND 目前仅在 C++ VFS 中用于为 memfs 实现 fuchsia.io/File.Write。所有 memfs 流都位于 FIDL 连接的服务器端，在该位置可以知道连接的附加模式。访问附加模式以选择性地将 ZX_STREAM_APPEND 传递给每个 zx_stream_writev 调用适用于此特定情况。

通过为用户空间分页器实现回写，可以将流发送到 FIDL 连接的客户端，从而显著提高 IO 性能。使用当前的流 API 将流移至客户端需要 fdio 跟踪连接的附加模式。

设计

概览

此设计的目的是避免在 fdio 中跟踪附加模式，并使流 API 更符合 POSIX 标准。

流 API 与在 POSIX 中读取、写入和查找文件非常相似，只是附加操作的处理方式不同。在 POSIX 中，可以通过向 open 传递 O_APPEND 来以附加模式打开文件。所有以附加模式对文件进行的 POSIX write 调用都与使用 ZX_STREAM_APPEND 选项的 zx_stream_writev 类似。

向流添加追加模式将避免 fdio 存储追加模式，并更符合 POSIX。添加此功能后，不再需要为 zx_stream_writev 提供 ZX_STREAM_APPEND 选项。

API 更改

此 RFC 包含 3 项 API 变更：

1. 将添加一个名为 ZX_STREAM_MODE_APPEND 的新 zx_stream_create 选项。使用 ZX_STREAM_MODE_APPEND 创建的数据流将处于附加模式。所有以附加模式对流进行的 zx_stream_writev 调用都将表现得好像 ZX_STREAM_APPEND 已传递给 zx_stream_writev 调用一样。

2. 系统将添加一个名为 ZX_PROP_STREAM_MODE_APPEND 的新属性。此属性对于 fdio 使用 F_SETFL 和 O_APPEND 实现 fcntl 是必需的。

   • ZX_PROP_STREAM_MODE_APPEND 的值类型将为 uint8_t。
   • 使用 ZX_PROP_STREAM_MODE_APPEND 和 0 的值调用 zx_object_set_property 会使流退出附加模式。
   • 使用 ZX_PROP_STREAM_MODE_APPEND 和 0 以外的任何值调用 zx_object_set_property 会将流置于附加模式。
   • 对于使用 ZX_PROP_STREAM_MODE_APPEND 的 zx_object_get_property 调用，如果流处于附加模式，则该属性的值为 1；如果流未处于附加模式，则该属性的值为 0。

3. zx_stream_writev 的 ZX_STREAM_APPEND 选项将被移除。

实现

此 RFC 将通过 3 项 Gerrit 更改来实现：

1. 将 ZX_STREAM_MODE_APPEND 和 ZX_PROP_STREAM_MODE_APPEND 添加到流 API。

2. 将 C++ VFS 从 ZX_STREAM_APPEND 迁移到 ZX_STREAM_MODE_APPEND 和 ZX_PROP_STREAM_MODE_APPEND

3. 从流 API 中移除了 ZX_STREAM_APPEND 选项。

性能

此提案应该不会对效果产生任何影响。

工效学设计

在流中存储附加模式可使流 API 与开发者已经熟悉的 fuchsia.io/Directory.Open 和 open 保持一致。

安全注意事项

无。

隐私注意事项

无。

测试

将编写核心测试来运行新 API，包括使用多个线程的测试。

memfs 使用的现有 fs_test 套件已包含追加相关测试，这些测试应能捕获迁移期间的任何潜在回归。

文档

Zircon 流文档将随 API 的更改而更新。

缺点、替代方案和未知因素

替代方案：在 fdio 中存储附加模式

将连接的附加模式直接存储在 fdio 中，并按原样使用流 API。

最好将附加模式存储在流中，因为这与 POSIX 中附加的工作方式相符。

替代方案：将 ZX_STREAM_APPEND 保留为 zx_stream_writev

支持流的文件系统通常会通过在内部将请求调度到流来实现 fuchsia.io/File.Read、Write 和 Seek。每个连接都已跟踪其附加模式，以便响应 GetFlags 请求，从而方便地将 ZX_STREAM_APPEND 与 zx_stream_writev 搭配使用。

移除 ZX_STREAM_APPEND 会强制文件系统保持连接的附加模式和流的附加模式同步，这并不难。 与保留 ZX_STREAM_APPEND 相比，减少 API Surface 区域并匹配 POSIX 是首选方案。

在先技术和参考资料

具有 ZX_STREAM_MODE_APPEND 的 zx_stream_create 类似于 POSIX 中具有 O_APPEND 的 open。

zx_object_set_property（含 ZX_PROP_STREAM_MODE_APPEND）类似于 fcntl（含 F_SETFL 和 O_APPEND，来自 POSIX）。