Sync File API Guide
本文档旨在为设备驱动程序编写者提供有关sync_file API的指南,以及驱动程序如何支持它。Sync file是需要在驱动程序之间或跨进程边界同步的fences(struct dma_fence)的载体。
sync_file API旨在用于在用户空间和内核空间之间发送和接收fence信息。它使用户空间能够进行显式的fencing,即生产者驱动程序(如GPU或V4L驱动程序)不是将fence附加到缓冲区,而是通过sync_file将与缓冲区相关的fence发送到用户空间。
然后,sync_file可以发送到消费者(例如DRM驱动程序),在fence信号之前,消费者不会对缓冲区进行任何操作,即发出fence的驱动程序不再使用/处理缓冲区,因此它表示缓冲区已准备好使用。对于循环的消费者->生产者部分也是如此。
Sync file允许用户空间了解驱动程序之间的缓冲区共享同步。
Sync file最初是在Android内核中添加的,但当前的Linux桌面系统也可以从中受益。
in-fences和out-fences
Sync file可以从用户空间发送到内核空间,也可以从内核空间发送到用户空间。当sync_file从驱动程序发送到用户空间时,其中包含的fences称为'out-fences'。它们与驱动程序正在处理或将要处理的缓冲区相关,因此驱动程序创建out-fence以通过dma_fence_signal()通知何时完成使用(或处理)该缓冲区。Out-fences是驱动程序创建的fences。
另一方面,如果驱动程序通过sync_file从用户空间接收fence(s),则称这些fence(s)为'in-fences'。接收in-fences意味着我们需要在使用与in-fences相关的任何缓冲区之前等待fence(s)发出信号。
创建Sync Files
当驱动程序需要向用户空间发送out-fence时,它创建一个sync_file。
接口:
struct sync_file *sync_file_create(struct dma_fence *fence);
调用者传递out-fence并获得sync_file。这只是第一步,接下来需要在sync_file->file上安装一个fd。因此,它获取一个fd:
fd = get_unused_fd_flags(O_CLOEXEC);
并将其安装在sync_file->file上:
fd_install(fd, sync_file->file);
现在可以将sync_file fd发送到用户空间。
如果创建过程失败,或者由于其他原因需要释放sync_file,则应使用fput(sync_file->file)。
从用户空间接收Sync Files
当用户空间需要向驱动程序发送in-fence时,它将Sync File的文件描述符传递给内核。然后内核可以从中检索fences。
接口:
struct dma_fence *sync_file_get_fence(int fd);
返回的引用由调用者拥有,并且必须在使用dma_fence_put()之后进行处理。如果出现错误,将返回NULL。
参考:
- include/linux/sync_file.h中的struct sync_file
- include/linux/sync_file.h中定义的所有上述接口