xtos_ bci_ snapshot_ consume
使用 SDK 保存的原 token 和 cursor,一次消费整个已获取快照;不释放映射。
本页目录
声明
#include <xtos/bci.h>
int xtos_bci_snapshot_consume(xtos_bci_session_t *session);参数
| 参数 | 类型 | 说明 |
|---|---|---|
| session | xtos_bci_session_t * | 非 NULL,调用方持有且负责生命周期;必须串行使用。 |
返回值
成功返回 0;失败 -1/errno;不会自动 release,失败不应当成成功消费。
错误
| errno | 条件 |
|---|---|
| EINVAL | session 为 NULL,或内核拒绝请求元数据。 |
| ENOENT | 没有本家族有效的已映射快照,或已成功 unmap。 |
| ESTALE | 快照已消费,或内核拒绝陈旧/replay token。 |
| EOVERFLOW | ring 读 cursor 已因覆盖移动;不消费替代数据。 |
| ENODEV/system errno | 断连或其他 ioctl 错误原样传播。 |
注意事项
- 同一会话的所有 API 必须由调用方串行化;SDK 无内部锁。调用可阻塞或分配,不能据此保证实时 deadline。
- 映射为只读、原生字节序、会话拥有的不可变副本;不是真正实时零复制 ring。不得修改、free、munmap 或通过借用 fd 自行发快照 ioctl。consume 不释放映射,release/destroy 后所有借用指针失效;保留数据需先复制。
- frame 家族发送 token、原 cursor、全部 frame_count 及 stream_generation;legacy 家族发送 token、原字节 cursor 和全部 payload_bytes。不能部分消费,也不能靠修改输出结构改变 SDK 保存的请求。
- 成功只推进相应 ring 的消费位置,不更新输出描述符或使指针失效;重复调用会再次发送请求并传播 ESTALE。
示例
#include <xtos/bci.h>
int consume_view(xtos_bci_session_t *s) {
return xtos_bci_snapshot_consume(s);
}源码
本文按 OpenXTOS v1.0.2(c24e923717670c4724cdaf24c7c105caee8dc2fb)的头文件和实现编写。