Documentation/driver-api/dma-buf.rst

   1 Buffer Sharing and Synchronization
   2 ==================================
   3
   4 The dma-buf subsystem provides the framework for sharing buffers for
   5 hardware (DMA) access across multiple device drivers and subsystems, and
   6 for synchronizing asynchronous hardware access.
   7
   8 This is used, for example, by drm "prime" multi-GPU support, but is of
   9 course not limited to GPU use cases.
  10
  11 The three main components of this are: (1) dma-buf, representing a
  12 sg_table and exposed to userspace as a file descriptor to allow passing
  13 between devices, (2) fence, which provides a mechanism to signal when
  14 one device has finished access, and (3) reservation, which manages the
  15 shared or exclusive fence(s) associated with the buffer.
  16
  17 Shared DMA Buffers
  18 ------------------
  19
  20 This document serves as a guide to device-driver writers on what is the dma-buf
  21 buffer sharing API, how to use it for exporting and using shared buffers.
  22
  23 Any device driver which wishes to be a part of DMA buffer sharing, can do so as
  24 either the 'exporter' of buffers, or the 'user' or 'importer' of buffers.
  25
  26 Say a driver A wants to use buffers created by driver B, then we call B as the
  27 exporter, and A as buffer-user/importer.
  28
  29 The exporter
  30
  31  - implements and manages operations in :c:type:`struct dma_buf_ops
  32    <dma_buf_ops>` for the buffer,
  33  - allows other users to share the buffer by using dma_buf sharing APIs,
  34  - manages the details of buffer allocation, wrapped in a :c:type:`struct
  35    dma_buf <dma_buf>`,
  36  - decides about the actual backing storage where this allocation happens,
  37  - and takes care of any migration of scatterlist - for all (shared) users of
  38    this buffer.
  39
  40 The buffer-user
  41
  42  - is one of (many) sharing users of the buffer.
  43  - doesn't need to worry about how the buffer is allocated, or where.
  44  - and needs a mechanism to get access to the scatterlist that makes up this
  45    buffer in memory, mapped into its own address space, so it can access the
  46    same area of memory. This interface is provided by :c:type:`struct
  47    dma_buf_attachment <dma_buf_attachment>`.
  48
  49 Any exporters or users of the dma-buf buffer sharing framework must have a
  50 'select DMA_SHARED_BUFFER' in their respective Kconfigs.
  51
  52 Userspace Interface Notes
  53 ~~~~~~~~~~~~~~~~~~~~~~~~~
  54
  55 Mostly a DMA buffer file descriptor is simply an opaque object for userspace,
  56 and hence the generic interface exposed is very minimal. There's a few things to
  57 consider though:
  58
  59 - Since kernel 3.12 the dma-buf FD supports the llseek system call, but only
  60   with offset=0 and whence=SEEK_END|SEEK_SET. SEEK_SET is supported to allow
  61   the usual size discover pattern size = SEEK_END(0); SEEK_SET(0). Every other
  62   llseek operation will report -EINVAL.
  63
  64   If llseek on dma-buf FDs isn't support the kernel will report -ESPIPE for all
  65   cases. Userspace can use this to detect support for discovering the dma-buf
  66   size using llseek.
  67
  68 - In order to avoid fd leaks on exec, the FD_CLOEXEC flag must be set
  69   on the file descriptor.  This is not just a resource leak, but a
  70   potential security hole.  It could give the newly exec'd application
  71   access to buffers, via the leaked fd, to which it should otherwise
  72   not be permitted access.
  73
  74   The problem with doing this via a separate fcntl() call, versus doing it
  75   atomically when the fd is created, is that this is inherently racy in a
  76   multi-threaded app[3].  The issue is made worse when it is library code
  77   opening/creating the file descriptor, as the application may not even be
  78   aware of the fd's.
  79
  80   To avoid this problem, userspace must have a way to request O_CLOEXEC
  81   flag be set when the dma-buf fd is created.  So any API provided by
  82   the exporting driver to create a dmabuf fd must provide a way to let
  83   userspace control setting of O_CLOEXEC flag passed in to dma_buf_fd().
  84
  85 - Memory mapping the contents of the DMA buffer is also supported. See the
  86   discussion below on `CPU Access to DMA Buffer Objects`_ for the full details.
  87
  88 - The DMA buffer FD is also pollable, see `Implicit Fence Poll Support`_ below for
  89   details.
  90
  91 Basic Operation and Device DMA Access
  92 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  93
  94 .. kernel-doc:: drivers/dma-buf/dma-buf.c
  95    :doc: dma buf device access
  96
  97 CPU Access to DMA Buffer Objects
  98 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  99
 100 .. kernel-doc:: drivers/dma-buf/dma-buf.c
 101    :doc: cpu access
 102
 103 Implicit Fence Poll Support
 104 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 105
 106 .. kernel-doc:: drivers/dma-buf/dma-buf.c
 107    :doc: implicit fence polling
 108
 109 Kernel Functions and Structures Reference
 110 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 111
 112 .. kernel-doc:: drivers/dma-buf/dma-buf.c
 113    :export:
 114
 115 .. kernel-doc:: include/linux/dma-buf.h
 116    :internal:
 117
 118 Buffer Mapping Helpers
 119 ~~~~~~~~~~~~~~~~~~~~~~
 120
 121 .. kernel-doc:: include/linux/dma-buf-map.h
 122    :doc: overview
 123
 124 .. kernel-doc:: include/linux/dma-buf-map.h
 125    :internal:
 126
 127 Reservation Objects
 128 -------------------
 129
 130 .. kernel-doc:: drivers/dma-buf/dma-resv.c
 131    :doc: Reservation Object Overview
 132
 133 .. kernel-doc:: drivers/dma-buf/dma-resv.c
 134    :export:
 135
 136 .. kernel-doc:: include/linux/dma-resv.h
 137    :internal:
 138
 139 DMA Fences
 140 ----------
 141
 142 .. kernel-doc:: drivers/dma-buf/dma-fence.c
 143    :doc: DMA fences overview
 144
 145 DMA Fence Cross-Driver Contract
 146 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 147
 148 .. kernel-doc:: drivers/dma-buf/dma-fence.c
 149    :doc: fence cross-driver contract
 150
 151 DMA Fence Signalling Annotations
 152 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 153
 154 .. kernel-doc:: drivers/dma-buf/dma-fence.c
 155    :doc: fence signalling annotation
 156
 157 DMA Fences Functions Reference
 158 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 159
 160 .. kernel-doc:: drivers/dma-buf/dma-fence.c
 161    :export:
 162
 163 .. kernel-doc:: include/linux/dma-fence.h
 164    :internal:
 165
 166 Seqno Hardware Fences
 167 ~~~~~~~~~~~~~~~~~~~~~
 168
 169 .. kernel-doc:: include/linux/seqno-fence.h
 170    :internal:
 171
 172 DMA Fence Array
 173 ~~~~~~~~~~~~~~~
 174
 175 .. kernel-doc:: drivers/dma-buf/dma-fence-array.c
 176    :export:
 177
 178 .. kernel-doc:: include/linux/dma-fence-array.h
 179    :internal:
 180
 181 DMA Fence Chain
 182 ~~~~~~~~~~~~~~~
 183
 184 .. kernel-doc:: drivers/dma-buf/dma-fence-chain.c
 185    :export:
 186
 187 .. kernel-doc:: include/linux/dma-fence-chain.h
 188    :internal:
 189
 190 DMA Fence uABI/Sync File
 191 ~~~~~~~~~~~~~~~~~~~~~~~~
 192
 193 .. kernel-doc:: drivers/dma-buf/sync_file.c
 194    :export:
 195
 196 .. kernel-doc:: include/linux/sync_file.h
 197    :internal:
 198
 199 Indefinite DMA Fences
 200 ~~~~~~~~~~~~~~~~~~~~~
 201
 202 At various times struct dma_fence with an indefinite time until dma_fence_wait()
 203 finishes have been proposed. Examples include:
 204
 205 * Future fences, used in HWC1 to signal when a buffer isn't used by the display
 206   any longer, and created with the screen update that makes the buffer visible.
 207   The time this fence completes is entirely under userspace's control.
 208
 209 * Proxy fences, proposed to handle &drm_syncobj for which the fence has not yet
 210   been set. Used to asynchronously delay command submission.
 211
 212 * Userspace fences or gpu futexes, fine-grained locking within a command buffer
 213   that userspace uses for synchronization across engines or with the CPU, which
 214   are then imported as a DMA fence for integration into existing winsys
 215   protocols.
 216
 217 * Long-running compute command buffers, while still using traditional end of
 218   batch DMA fences for memory management instead of context preemption DMA
 219   fences which get reattached when the compute job is rescheduled.
 220
 221 Common to all these schemes is that userspace controls the dependencies of these
 222 fences and controls when they fire. Mixing indefinite fences with normal
 223 in-kernel DMA fences does not work, even when a fallback timeout is included to
 224 protect against malicious userspace:
 225
 226 * Only the kernel knows about all DMA fence dependencies, userspace is not aware
 227   of dependencies injected due to memory management or scheduler decisions.
 228
 229 * Only userspace knows about all dependencies in indefinite fences and when
 230   exactly they will complete, the kernel has no visibility.
 231
 232 Furthermore the kernel has to be able to hold up userspace command submission
 233 for memory management needs, which means we must support indefinite fences being
 234 dependent upon DMA fences. If the kernel also support indefinite fences in the
 235 kernel like a DMA fence, like any of the above proposal would, there is the
 236 potential for deadlocks.
 237
 238 .. kernel-render:: DOT
 239    :alt: Indefinite Fencing Dependency Cycle
 240    :caption: Indefinite Fencing Dependency Cycle
 241
 242    digraph "Fencing Cycle" {
 243       node [shape=box bgcolor=grey style=filled]
 244       kernel [label="Kernel DMA Fences"]
 245       userspace [label="userspace controlled fences"]
 246       kernel -> userspace [label="memory management"]
 247       userspace -> kernel [label="Future fence, fence proxy, ..."]
 248
 249       { rank=same; kernel userspace }
 250    }
 251
 252 This means that the kernel might accidentally create deadlocks
 253 through memory management dependencies which userspace is unaware of, which
 254 randomly hangs workloads until the timeout kicks in. Workloads, which from
 255 userspace's perspective, do not contain a deadlock.  In such a mixed fencing
 256 architecture there is no single entity with knowledge of all dependencies.
 257 Thefore preventing such deadlocks from within the kernel is not possible.
 258
 259 The only solution to avoid dependencies loops is by not allowing indefinite
 260 fences in the kernel. This means:
 261
 262 * No future fences, proxy fences or userspace fences imported as DMA fences,
 263   with or without a timeout.
 264
 265 * No DMA fences that signal end of batchbuffer for command submission where
 266   userspace is allowed to use userspace fencing or long running compute
 267   workloads. This also means no implicit fencing for shared buffers in these
 268   cases.
 269
 270 Recoverable Hardware Page Faults Implications
 271 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 272
 273 Modern hardware supports recoverable page faults, which has a lot of
 274 implications for DMA fences.
 275
 276 First, a pending page fault obviously holds up the work that's running on the
 277 accelerator and a memory allocation is usually required to resolve the fault.
 278 But memory allocations are not allowed to gate completion of DMA fences, which
 279 means any workload using recoverable page faults cannot use DMA fences for
 280 synchronization. Synchronization fences controlled by userspace must be used
 281 instead.
 282
 283 On GPUs this poses a problem, because current desktop compositor protocols on
 284 Linux rely on DMA fences, which means without an entirely new userspace stack
 285 built on top of userspace fences, they cannot benefit from recoverable page
 286 faults. Specifically this means implicit synchronization will not be possible.
 287 The exception is when page faults are only used as migration hints and never to
 288 on-demand fill a memory request. For now this means recoverable page
 289 faults on GPUs are limited to pure compute workloads.
 290
 291 Furthermore GPUs usually have shared resources between the 3D rendering and
 292 compute side, like compute units or command submission engines. If both a 3D
 293 job with a DMA fence and a compute workload using recoverable page faults are
 294 pending they could deadlock:
 295
 296 - The 3D workload might need to wait for the compute job to finish and release
 297   hardware resources first.
 298
 299 - The compute workload might be stuck in a page fault, because the memory
 300   allocation is waiting for the DMA fence of the 3D workload to complete.
 301
 302 There are a few options to prevent this problem, one of which drivers need to
 303 ensure:
 304
 305 - Compute workloads can always be preempted, even when a page fault is pending
 306   and not yet repaired. Not all hardware supports this.
 307
 308 - DMA fence workloads and workloads which need page fault handling have
 309   independent hardware resources to guarantee forward progress. This could be
 310   achieved through e.g. through dedicated engines and minimal compute unit
 311   reservations for DMA fence workloads.
 312
 313 - The reservation approach could be further refined by only reserving the
 314   hardware resources for DMA fence workloads when they are in-flight. This must
 315   cover the time from when the DMA fence is visible to other threads up to
 316   moment when fence is completed through dma_fence_signal().
 317
 318 - As a last resort, if the hardware provides no useful reservation mechanics,
 319   all workloads must be flushed from the GPU when switching between jobs
 320   requiring DMA fences or jobs requiring page fault handling: This means all DMA
 321   fences must complete before a compute job with page fault handling can be
 322   inserted into the scheduler queue. And vice versa, before a DMA fence can be
 323   made visible anywhere in the system, all compute workloads must be preempted
 324   to guarantee all pending GPU page faults are flushed.
 325
 326 - Only a fairly theoretical option would be to untangle these dependencies when
 327   allocating memory to repair hardware page faults, either through separate
 328   memory blocks or runtime tracking of the full dependency graph of all DMA
 329   fences. This results very wide impact on the kernel, since resolving the page
 330   on the CPU side can itself involve a page fault. It is much more feasible and
 331   robust to limit the impact of handling hardware page faults to the specific
 332   driver.
 333
 334 Note that workloads that run on independent hardware like copy engines or other
 335 GPUs do not have any impact. This allows us to keep using DMA fences internally
 336 in the kernel even for resolving hardware page faults, e.g. by using copy
 337 engines to clear or copy memory needed to resolve the page fault.
 338
 339 In some ways this page fault problem is a special case of the `Infinite DMA
 340 Fences` discussions: Infinite fences from compute workloads are allowed to
 341 depend on DMA fences, but not the other way around. And not even the page fault
 342 problem is new, because some other CPU thread in userspace might
 343 hit a page fault which holds up a userspace fence - supporting page faults on
 344 GPUs doesn't anything fundamentally new.