Blame view
Documentation/sync_file.txt
3.08 KB
c16f291de sync_file.txt: st... |
1 2 3 |
=================== Sync File API Guide =================== |
c784c82a3 Documentation: ad... |
4 |
|
c16f291de sync_file.txt: st... |
5 |
:Author: Gustavo Padovan <gustavo at padovan dot org> |
c784c82a3 Documentation: ad... |
6 7 8 |
This document serves as a guide for device drivers writers on what the sync_file API is, and how drivers can support it. Sync file is the carrier of |
f54d18670 dma-buf: Rename s... |
9 |
the fences(struct dma_fence) that are needed to synchronize between drivers or |
fac8434da Documentation: Fi... |
10 |
across process boundaries. |
c784c82a3 Documentation: ad... |
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 |
The sync_file API is meant to be used to send and receive fence information to/from userspace. It enables userspace to do explicit fencing, where instead of attaching a fence to the buffer a producer driver (such as a GPU or V4L driver) sends the fence related to the buffer to userspace via a sync_file. The sync_file then can be sent to the consumer (DRM driver for example), that will not use the buffer for anything before the fence(s) signals, i.e., the driver that issued the fence is not using/processing the buffer anymore, so it signals that the buffer is ready to use. And vice-versa for the consumer -> producer part of the cycle. Sync files allows userspace awareness on buffer sharing synchronization between drivers. Sync file was originally added in the Android kernel but current Linux Desktop can benefit a lot from it. in-fences and out-fences ------------------------ Sync files can go either to or from userspace. When a sync_file is sent from the driver to userspace we call the fences it contains 'out-fences'. They are related to a buffer that the driver is processing or is going to process, so |
f54d18670 dma-buf: Rename s... |
35 36 37 |
the driver creates an out-fence to be able to notify, through dma_fence_signal(), when it has finished using (or processing) that buffer. Out-fences are fences that the driver creates. |
c784c82a3 Documentation: ad... |
38 39 |
On the other hand if the driver receives fence(s) through a sync_file from |
7bc41a655 Documentation: sy... |
40 |
userspace we call these fence(s) 'in-fences'. Receiving in-fences means that |
c784c82a3 Documentation: ad... |
41 42 43 44 45 46 47 |
we need to wait for the fence(s) to signal before using any buffer related to the in-fences. Creating Sync Files ------------------- When a driver needs to send an out-fence userspace it creates a sync_file. |
c16f291de sync_file.txt: st... |
48 |
Interface:: |
f54d18670 dma-buf: Rename s... |
49 |
struct sync_file *sync_file_create(struct dma_fence *fence); |
c784c82a3 Documentation: ad... |
50 51 52 |
The caller pass the out-fence and gets back the sync_file. That is just the first step, next it needs to install an fd on sync_file->file. So it gets an |
c16f291de sync_file.txt: st... |
53 |
fd:: |
c784c82a3 Documentation: ad... |
54 55 |
fd = get_unused_fd_flags(O_CLOEXEC); |
c16f291de sync_file.txt: st... |
56 |
and installs it on sync_file->file:: |
c784c82a3 Documentation: ad... |
57 58 59 60 61 62 63 |
fd_install(fd, sync_file->file); The sync_file fd now can be sent to userspace. If the creation process fail, or the sync_file needs to be released by any other reason fput(sync_file->file) should be used. |
395dec6f6 Documentation: ad... |
64 65 66 67 68 69 |
Receiving Sync Files from Userspace ----------------------------------- When userspace needs to send an in-fence to the driver it passes file descriptor of the Sync File to the kernel. The kernel can then retrieve the fences from it. |
c16f291de sync_file.txt: st... |
70 |
Interface:: |
f54d18670 dma-buf: Rename s... |
71 |
struct dma_fence *sync_file_get_fence(int fd); |
395dec6f6 Documentation: ad... |
72 73 74 |
The returned reference is owned by the caller and must be disposed of |
f54d18670 dma-buf: Rename s... |
75 |
afterwards using dma_fence_put(). In case of error, a NULL is returned instead. |
395dec6f6 Documentation: ad... |
76 |
|
c784c82a3 Documentation: ad... |
77 |
References: |
c16f291de sync_file.txt: st... |
78 79 80 |
1. struct sync_file in include/linux/sync_file.h 2. All interfaces mentioned above defined in include/linux/sync_file.h |