2 * Copyright 2017 Red Hat
3 * Parts ported from amdgpu (fence wait code).
4 * Copyright 2016 Advanced Micro Devices, Inc.
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice (including the next
14 * paragraph) shall be included in all copies or substantial portions of the
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
22 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
32 * DRM synchronisation objects (syncobj, see struct &drm_syncobj) provide a
33 * container for a synchronization primitive which can be used by userspace
34 * to explicitly synchronize GPU commands, can be shared between userspace
35 * processes, and can be shared between different DRM drivers.
36 * Their primary use-case is to implement Vulkan fences and semaphores.
37 * The syncobj userspace API provides ioctls for several operations:
39 * - Creation and destruction of syncobjs
40 * - Import and export of syncobjs to/from a syncobj file descriptor
41 * - Import and export a syncobj's underlying fence to/from a sync file
42 * - Reset a syncobj (set its fence to NULL)
43 * - Signal a syncobj (set a trivially signaled fence)
44 * - Wait for a syncobj's fence to appear and be signaled
46 * The syncobj userspace API also provides operations to manipulate a syncobj
47 * in terms of a timeline of struct &dma_fence_chain rather than a single
48 * struct &dma_fence, through the following operations:
50 * - Signal a given point on the timeline
51 * - Wait for a given point to appear and/or be signaled
52 * - Import and export from/to a given point of a timeline
54 * At it's core, a syncobj is simply a wrapper around a pointer to a struct
55 * &dma_fence which may be NULL.
56 * When a syncobj is first created, its pointer is either NULL or a pointer
57 * to an already signaled fence depending on whether the
58 * &DRM_SYNCOBJ_CREATE_SIGNALED flag is passed to
59 * &DRM_IOCTL_SYNCOBJ_CREATE.
61 * If the syncobj is considered as a binary (its state is either signaled or
62 * unsignaled) primitive, when GPU work is enqueued in a DRM driver to signal
63 * the syncobj, the syncobj's fence is replaced with a fence which will be
64 * signaled by the completion of that work.
65 * If the syncobj is considered as a timeline primitive, when GPU work is
66 * enqueued in a DRM driver to signal the a given point of the syncobj, a new
67 * struct &dma_fence_chain pointing to the DRM driver's fence and also
68 * pointing to the previous fence that was in the syncobj. The new struct
69 * &dma_fence_chain fence replace the syncobj's fence and will be signaled by
70 * completion of the DRM driver's work and also any work associated with the
71 * fence previously in the syncobj.
73 * When GPU work which waits on a syncobj is enqueued in a DRM driver, at the
74 * time the work is enqueued, it waits on the syncobj's fence before
75 * submitting the work to hardware. That fence is either :
77 * - The syncobj's current fence if the syncobj is considered as a binary
79 * - The struct &dma_fence associated with a given point if the syncobj is
80 * considered as a timeline primitive.
82 * If the syncobj's fence is NULL or not present in the syncobj's timeline,
83 * the enqueue operation is expected to fail.
85 * With binary syncobj, all manipulation of the syncobjs's fence happens in
86 * terms of the current fence at the time the ioctl is called by userspace
87 * regardless of whether that operation is an immediate host-side operation
88 * (signal or reset) or or an operation which is enqueued in some driver
89 * queue. &DRM_IOCTL_SYNCOBJ_RESET and &DRM_IOCTL_SYNCOBJ_SIGNAL can be used
90 * to manipulate a syncobj from the host by resetting its pointer to NULL or
91 * setting its pointer to a fence which is already signaled.
93 * With a timeline syncobj, all manipulation of the synobj's fence happens in
94 * terms of a u64 value referring to point in the timeline. See
95 * dma_fence_chain_find_seqno() to see how a given point is found in the
98 * Note that applications should be careful to always use timeline set of
99 * ioctl() when dealing with syncobj considered as timeline. Using a binary
100 * set of ioctl() with a syncobj considered as timeline could result incorrect
101 * synchronization. The use of binary syncobj is supported through the
102 * timeline set of ioctl() by using a point value of 0, this will reproduce
103 * the behavior of the binary set of ioctl() (for example replace the
104 * syncobj's fence when signaling).
107 * Host-side wait on syncobjs
108 * --------------------------
110 * &DRM_IOCTL_SYNCOBJ_WAIT takes an array of syncobj handles and does a
111 * host-side wait on all of the syncobj fences simultaneously.
112 * If &DRM_SYNCOBJ_WAIT_FLAGS_WAIT_ALL is set, the wait ioctl will wait on
113 * all of the syncobj fences to be signaled before it returns.
114 * Otherwise, it returns once at least one syncobj fence has been signaled
115 * and the index of a signaled fence is written back to the client.
117 * Unlike the enqueued GPU work dependencies which fail if they see a NULL
118 * fence in a syncobj, if &DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT is set,
119 * the host-side wait will first wait for the syncobj to receive a non-NULL
120 * fence and then wait on that fence.
121 * If &DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT is not set and any one of the
122 * syncobjs in the array has a NULL fence, -EINVAL will be returned.
123 * Assuming the syncobj starts off with a NULL fence, this allows a client
124 * to do a host wait in one thread (or process) which waits on GPU work
125 * submitted in another thread (or process) without having to manually
126 * synchronize between the two.
127 * This requirement is inherited from the Vulkan fence API.
129 * Similarly, &DRM_IOCTL_SYNCOBJ_TIMELINE_WAIT takes an array of syncobj
130 * handles as well as an array of u64 points and does a host-side wait on all
131 * of syncobj fences at the given points simultaneously.
133 * &DRM_IOCTL_SYNCOBJ_TIMELINE_WAIT also adds the ability to wait for a given
134 * fence to materialize on the timeline without waiting for the fence to be
135 * signaled by using the &DRM_SYNCOBJ_WAIT_FLAGS_WAIT_AVAILABLE flag. This
136 * requirement is inherited from the wait-before-signal behavior required by
137 * the Vulkan timeline semaphore API.
140 * Import/export of syncobjs
141 * -------------------------
143 * &DRM_IOCTL_SYNCOBJ_FD_TO_HANDLE and &DRM_IOCTL_SYNCOBJ_HANDLE_TO_FD
144 * provide two mechanisms for import/export of syncobjs.
146 * The first lets the client import or export an entire syncobj to a file
148 * These fd's are opaque and have no other use case, except passing the
149 * syncobj between processes.
150 * All exported file descriptors and any syncobj handles created as a
151 * result of importing those file descriptors own a reference to the
152 * same underlying struct &drm_syncobj and the syncobj can be used
153 * persistently across all the processes with which it is shared.
154 * The syncobj is freed only once the last reference is dropped.
155 * Unlike dma-buf, importing a syncobj creates a new handle (with its own
156 * reference) for every import instead of de-duplicating.
157 * The primary use-case of this persistent import/export is for shared
158 * Vulkan fences and semaphores.
160 * The second import/export mechanism, which is indicated by
161 * &DRM_SYNCOBJ_FD_TO_HANDLE_FLAGS_IMPORT_SYNC_FILE or
162 * &DRM_SYNCOBJ_HANDLE_TO_FD_FLAGS_EXPORT_SYNC_FILE lets the client
163 * import/export the syncobj's current fence from/to a &sync_file.
164 * When a syncobj is exported to a sync file, that sync file wraps the
165 * sycnobj's fence at the time of export and any later signal or reset
166 * operations on the syncobj will not affect the exported sync file.
167 * When a sync file is imported into a syncobj, the syncobj's fence is set
168 * to the fence wrapped by that sync file.
169 * Because sync files are immutable, resetting or signaling the syncobj
170 * will not affect any sync files whose fences have been imported into the
174 * Import/export of timeline points in timeline syncobjs
175 * -----------------------------------------------------
177 * &DRM_IOCTL_SYNCOBJ_TRANSFER provides a mechanism to transfer a struct
178 * &dma_fence_chain of a syncobj at a given u64 point to another u64 point
179 * into another syncobj.
181 * Note that if you want to transfer a struct &dma_fence_chain from a given
182 * point on a timeline syncobj from/into a binary syncobj, you can use the
183 * point 0 to mean take/replace the fence in the syncobj.
186 #include <linux/anon_inodes.h>
187 #include <linux/dma-fence-unwrap.h>
188 #include <linux/file.h>
189 #include <linux/fs.h>
190 #include <linux/sched/signal.h>
191 #include <linux/sync_file.h>
192 #include <linux/uaccess.h>
195 #include <drm/drm_drv.h>
196 #include <drm/drm_file.h>
197 #include <drm/drm_gem.h>
198 #include <drm/drm_print.h>
199 #include <drm/drm_syncobj.h>
200 #include <drm/drm_utils.h>
202 #include "drm_internal.h"
204 struct syncobj_wait_entry {
205 struct list_head node;
206 struct task_struct *task;
207 struct dma_fence *fence;
208 struct dma_fence_cb fence_cb;
212 static void syncobj_wait_syncobj_func(struct drm_syncobj *syncobj,
213 struct syncobj_wait_entry *wait);
216 * drm_syncobj_find - lookup and reference a sync object.
217 * @file_private: drm file private pointer
218 * @handle: sync object handle to lookup.
220 * Returns a reference to the syncobj pointed to by handle or NULL. The
221 * reference must be released by calling drm_syncobj_put().
223 struct drm_syncobj *drm_syncobj_find(struct drm_file *file_private,
226 struct drm_syncobj *syncobj;
228 spin_lock(&file_private->syncobj_table_lock);
230 /* Check if we currently have a reference on the object */
231 syncobj = idr_find(&file_private->syncobj_idr, handle);
233 drm_syncobj_get(syncobj);
235 spin_unlock(&file_private->syncobj_table_lock);
239 EXPORT_SYMBOL(drm_syncobj_find);
241 static void drm_syncobj_fence_add_wait(struct drm_syncobj *syncobj,
242 struct syncobj_wait_entry *wait)
244 struct dma_fence *fence;
249 spin_lock(&syncobj->lock);
250 /* We've already tried once to get a fence and failed. Now that we
251 * have the lock, try one more time just to be sure we don't add a
252 * callback when a fence has already been set.
254 fence = dma_fence_get(rcu_dereference_protected(syncobj->fence, 1));
255 if (!fence || dma_fence_chain_find_seqno(&fence, wait->point)) {
256 dma_fence_put(fence);
257 list_add_tail(&wait->node, &syncobj->cb_list);
259 wait->fence = dma_fence_get_stub();
263 spin_unlock(&syncobj->lock);
266 static void drm_syncobj_remove_wait(struct drm_syncobj *syncobj,
267 struct syncobj_wait_entry *wait)
269 if (!wait->node.next)
272 spin_lock(&syncobj->lock);
273 list_del_init(&wait->node);
274 spin_unlock(&syncobj->lock);
278 * drm_syncobj_add_point - add new timeline point to the syncobj
279 * @syncobj: sync object to add timeline point do
280 * @chain: chain node to use to add the point
281 * @fence: fence to encapsulate in the chain node
282 * @point: sequence number to use for the point
284 * Add the chain node as new timeline point to the syncobj.
286 void drm_syncobj_add_point(struct drm_syncobj *syncobj,
287 struct dma_fence_chain *chain,
288 struct dma_fence *fence,
291 struct syncobj_wait_entry *cur, *tmp;
292 struct dma_fence *prev;
294 dma_fence_get(fence);
296 spin_lock(&syncobj->lock);
298 prev = drm_syncobj_fence_get(syncobj);
299 /* You are adding an unorder point to timeline, which could cause payload returned from query_ioctl is 0! */
300 if (prev && prev->seqno >= point)
301 DRM_DEBUG("You are adding an unorder point to timeline!\n");
302 dma_fence_chain_init(chain, prev, fence, point);
303 rcu_assign_pointer(syncobj->fence, &chain->base);
305 list_for_each_entry_safe(cur, tmp, &syncobj->cb_list, node)
306 syncobj_wait_syncobj_func(syncobj, cur);
307 spin_unlock(&syncobj->lock);
309 /* Walk the chain once to trigger garbage collection */
310 dma_fence_chain_for_each(fence, prev);
313 EXPORT_SYMBOL(drm_syncobj_add_point);
316 * drm_syncobj_replace_fence - replace fence in a sync object.
317 * @syncobj: Sync object to replace fence in
318 * @fence: fence to install in sync file.
320 * This replaces the fence on a sync object.
322 void drm_syncobj_replace_fence(struct drm_syncobj *syncobj,
323 struct dma_fence *fence)
325 struct dma_fence *old_fence;
326 struct syncobj_wait_entry *cur, *tmp;
329 dma_fence_get(fence);
331 spin_lock(&syncobj->lock);
333 old_fence = rcu_dereference_protected(syncobj->fence,
334 lockdep_is_held(&syncobj->lock));
335 rcu_assign_pointer(syncobj->fence, fence);
337 if (fence != old_fence) {
338 list_for_each_entry_safe(cur, tmp, &syncobj->cb_list, node)
339 syncobj_wait_syncobj_func(syncobj, cur);
342 spin_unlock(&syncobj->lock);
344 dma_fence_put(old_fence);
346 EXPORT_SYMBOL(drm_syncobj_replace_fence);
349 * drm_syncobj_assign_null_handle - assign a stub fence to the sync object
350 * @syncobj: sync object to assign the fence on
352 * Assign a already signaled stub fence to the sync object.
354 static int drm_syncobj_assign_null_handle(struct drm_syncobj *syncobj)
356 struct dma_fence *fence = dma_fence_allocate_private_stub(ktime_get());
361 drm_syncobj_replace_fence(syncobj, fence);
362 dma_fence_put(fence);
366 /* 5s default for wait submission */
367 #define DRM_SYNCOBJ_WAIT_FOR_SUBMIT_TIMEOUT 5000000000ULL
369 * drm_syncobj_find_fence - lookup and reference the fence in a sync object
370 * @file_private: drm file private pointer
371 * @handle: sync object handle to lookup.
372 * @point: timeline point
373 * @flags: DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT or not
374 * @fence: out parameter for the fence
376 * This is just a convenience function that combines drm_syncobj_find() and
377 * drm_syncobj_fence_get().
379 * Returns 0 on success or a negative error value on failure. On success @fence
380 * contains a reference to the fence, which must be released by calling
383 int drm_syncobj_find_fence(struct drm_file *file_private,
384 u32 handle, u64 point, u64 flags,
385 struct dma_fence **fence)
387 struct drm_syncobj *syncobj = drm_syncobj_find(file_private, handle);
388 struct syncobj_wait_entry wait;
389 u64 timeout = nsecs_to_jiffies64(DRM_SYNCOBJ_WAIT_FOR_SUBMIT_TIMEOUT);
395 /* Waiting for userspace with locks help is illegal cause that can
396 * trivial deadlock with page faults for example. Make lockdep complain
399 if (flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT) {
401 lockdep_assert_none_held_once();
404 *fence = drm_syncobj_fence_get(syncobj);
407 ret = dma_fence_chain_find_seqno(fence, point);
409 /* If the requested seqno is already signaled
410 * drm_syncobj_find_fence may return a NULL
411 * fence. To make sure the recipient gets
412 * signalled, use a new fence instead.
415 *fence = dma_fence_get_stub();
419 dma_fence_put(*fence);
424 if (!(flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT))
427 memset(&wait, 0, sizeof(wait));
430 drm_syncobj_fence_add_wait(syncobj, &wait);
433 set_current_state(TASK_INTERRUPTIBLE);
443 if (signal_pending(current)) {
448 timeout = schedule_timeout(timeout);
451 __set_current_state(TASK_RUNNING);
455 drm_syncobj_remove_wait(syncobj, &wait);
458 drm_syncobj_put(syncobj);
462 EXPORT_SYMBOL(drm_syncobj_find_fence);
465 * drm_syncobj_free - free a sync object.
466 * @kref: kref to free.
468 * Only to be called from kref_put in drm_syncobj_put.
470 void drm_syncobj_free(struct kref *kref)
472 struct drm_syncobj *syncobj = container_of(kref,
475 drm_syncobj_replace_fence(syncobj, NULL);
478 EXPORT_SYMBOL(drm_syncobj_free);
481 * drm_syncobj_create - create a new syncobj
482 * @out_syncobj: returned syncobj
483 * @flags: DRM_SYNCOBJ_* flags
484 * @fence: if non-NULL, the syncobj will represent this fence
486 * This is the first function to create a sync object. After creating, drivers
487 * probably want to make it available to userspace, either through
488 * drm_syncobj_get_handle() or drm_syncobj_get_fd().
490 * Returns 0 on success or a negative error value on failure.
492 int drm_syncobj_create(struct drm_syncobj **out_syncobj, uint32_t flags,
493 struct dma_fence *fence)
496 struct drm_syncobj *syncobj;
498 syncobj = kzalloc(sizeof(struct drm_syncobj), GFP_KERNEL);
502 kref_init(&syncobj->refcount);
503 INIT_LIST_HEAD(&syncobj->cb_list);
504 spin_lock_init(&syncobj->lock);
506 if (flags & DRM_SYNCOBJ_CREATE_SIGNALED) {
507 ret = drm_syncobj_assign_null_handle(syncobj);
509 drm_syncobj_put(syncobj);
515 drm_syncobj_replace_fence(syncobj, fence);
517 *out_syncobj = syncobj;
520 EXPORT_SYMBOL(drm_syncobj_create);
523 * drm_syncobj_get_handle - get a handle from a syncobj
524 * @file_private: drm file private pointer
525 * @syncobj: Sync object to export
526 * @handle: out parameter with the new handle
528 * Exports a sync object created with drm_syncobj_create() as a handle on
529 * @file_private to userspace.
531 * Returns 0 on success or a negative error value on failure.
533 int drm_syncobj_get_handle(struct drm_file *file_private,
534 struct drm_syncobj *syncobj, u32 *handle)
538 /* take a reference to put in the idr */
539 drm_syncobj_get(syncobj);
541 idr_preload(GFP_KERNEL);
542 spin_lock(&file_private->syncobj_table_lock);
543 ret = idr_alloc(&file_private->syncobj_idr, syncobj, 1, 0, GFP_NOWAIT);
544 spin_unlock(&file_private->syncobj_table_lock);
549 drm_syncobj_put(syncobj);
556 EXPORT_SYMBOL(drm_syncobj_get_handle);
558 static int drm_syncobj_create_as_handle(struct drm_file *file_private,
559 u32 *handle, uint32_t flags)
562 struct drm_syncobj *syncobj;
564 ret = drm_syncobj_create(&syncobj, flags, NULL);
568 ret = drm_syncobj_get_handle(file_private, syncobj, handle);
569 drm_syncobj_put(syncobj);
573 static int drm_syncobj_destroy(struct drm_file *file_private,
576 struct drm_syncobj *syncobj;
578 spin_lock(&file_private->syncobj_table_lock);
579 syncobj = idr_remove(&file_private->syncobj_idr, handle);
580 spin_unlock(&file_private->syncobj_table_lock);
585 drm_syncobj_put(syncobj);
589 static int drm_syncobj_file_release(struct inode *inode, struct file *file)
591 struct drm_syncobj *syncobj = file->private_data;
593 drm_syncobj_put(syncobj);
597 static const struct file_operations drm_syncobj_file_fops = {
598 .release = drm_syncobj_file_release,
602 * drm_syncobj_get_fd - get a file descriptor from a syncobj
603 * @syncobj: Sync object to export
604 * @p_fd: out parameter with the new file descriptor
606 * Exports a sync object created with drm_syncobj_create() as a file descriptor.
608 * Returns 0 on success or a negative error value on failure.
610 int drm_syncobj_get_fd(struct drm_syncobj *syncobj, int *p_fd)
615 fd = get_unused_fd_flags(O_CLOEXEC);
619 file = anon_inode_getfile("syncobj_file",
620 &drm_syncobj_file_fops,
624 return PTR_ERR(file);
627 drm_syncobj_get(syncobj);
628 fd_install(fd, file);
633 EXPORT_SYMBOL(drm_syncobj_get_fd);
635 static int drm_syncobj_handle_to_fd(struct drm_file *file_private,
636 u32 handle, int *p_fd)
638 struct drm_syncobj *syncobj = drm_syncobj_find(file_private, handle);
644 ret = drm_syncobj_get_fd(syncobj, p_fd);
645 drm_syncobj_put(syncobj);
649 static int drm_syncobj_fd_to_handle(struct drm_file *file_private,
652 struct drm_syncobj *syncobj;
653 struct fd f = fdget(fd);
659 if (f.file->f_op != &drm_syncobj_file_fops) {
664 /* take a reference to put in the idr */
665 syncobj = f.file->private_data;
666 drm_syncobj_get(syncobj);
668 idr_preload(GFP_KERNEL);
669 spin_lock(&file_private->syncobj_table_lock);
670 ret = idr_alloc(&file_private->syncobj_idr, syncobj, 1, 0, GFP_NOWAIT);
671 spin_unlock(&file_private->syncobj_table_lock);
678 drm_syncobj_put(syncobj);
684 static int drm_syncobj_import_sync_file_fence(struct drm_file *file_private,
687 struct dma_fence *fence = sync_file_get_fence(fd);
688 struct drm_syncobj *syncobj;
693 syncobj = drm_syncobj_find(file_private, handle);
695 dma_fence_put(fence);
699 drm_syncobj_replace_fence(syncobj, fence);
700 dma_fence_put(fence);
701 drm_syncobj_put(syncobj);
705 static int drm_syncobj_export_sync_file(struct drm_file *file_private,
706 int handle, int *p_fd)
709 struct dma_fence *fence;
710 struct sync_file *sync_file;
711 int fd = get_unused_fd_flags(O_CLOEXEC);
716 ret = drm_syncobj_find_fence(file_private, handle, 0, 0, &fence);
720 sync_file = sync_file_create(fence);
722 dma_fence_put(fence);
729 fd_install(fd, sync_file->file);
738 * drm_syncobj_open - initializes syncobj file-private structures at devnode open time
739 * @file_private: drm file-private structure to set up
741 * Called at device open time, sets up the structure for handling refcounting
745 drm_syncobj_open(struct drm_file *file_private)
747 idr_init_base(&file_private->syncobj_idr, 1);
748 spin_lock_init(&file_private->syncobj_table_lock);
752 drm_syncobj_release_handle(int id, void *ptr, void *data)
754 struct drm_syncobj *syncobj = ptr;
756 drm_syncobj_put(syncobj);
761 * drm_syncobj_release - release file-private sync object resources
762 * @file_private: drm file-private structure to clean up
764 * Called at close time when the filp is going away.
766 * Releases any remaining references on objects by this filp.
769 drm_syncobj_release(struct drm_file *file_private)
771 idr_for_each(&file_private->syncobj_idr,
772 &drm_syncobj_release_handle, file_private);
773 idr_destroy(&file_private->syncobj_idr);
777 drm_syncobj_create_ioctl(struct drm_device *dev, void *data,
778 struct drm_file *file_private)
780 struct drm_syncobj_create *args = data;
782 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
785 /* no valid flags yet */
786 if (args->flags & ~DRM_SYNCOBJ_CREATE_SIGNALED)
789 return drm_syncobj_create_as_handle(file_private,
790 &args->handle, args->flags);
794 drm_syncobj_destroy_ioctl(struct drm_device *dev, void *data,
795 struct drm_file *file_private)
797 struct drm_syncobj_destroy *args = data;
799 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
802 /* make sure padding is empty */
805 return drm_syncobj_destroy(file_private, args->handle);
809 drm_syncobj_handle_to_fd_ioctl(struct drm_device *dev, void *data,
810 struct drm_file *file_private)
812 struct drm_syncobj_handle *args = data;
814 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
820 if (args->flags != 0 &&
821 args->flags != DRM_SYNCOBJ_HANDLE_TO_FD_FLAGS_EXPORT_SYNC_FILE)
824 if (args->flags & DRM_SYNCOBJ_HANDLE_TO_FD_FLAGS_EXPORT_SYNC_FILE)
825 return drm_syncobj_export_sync_file(file_private, args->handle,
828 return drm_syncobj_handle_to_fd(file_private, args->handle,
833 drm_syncobj_fd_to_handle_ioctl(struct drm_device *dev, void *data,
834 struct drm_file *file_private)
836 struct drm_syncobj_handle *args = data;
838 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
844 if (args->flags != 0 &&
845 args->flags != DRM_SYNCOBJ_FD_TO_HANDLE_FLAGS_IMPORT_SYNC_FILE)
848 if (args->flags & DRM_SYNCOBJ_FD_TO_HANDLE_FLAGS_IMPORT_SYNC_FILE)
849 return drm_syncobj_import_sync_file_fence(file_private,
853 return drm_syncobj_fd_to_handle(file_private, args->fd,
857 static int drm_syncobj_transfer_to_timeline(struct drm_file *file_private,
858 struct drm_syncobj_transfer *args)
860 struct drm_syncobj *timeline_syncobj = NULL;
861 struct dma_fence *fence, *tmp;
862 struct dma_fence_chain *chain;
865 timeline_syncobj = drm_syncobj_find(file_private, args->dst_handle);
866 if (!timeline_syncobj) {
869 ret = drm_syncobj_find_fence(file_private, args->src_handle,
870 args->src_point, args->flags,
873 goto err_put_timeline;
875 fence = dma_fence_unwrap_merge(tmp);
879 goto err_put_timeline;
882 chain = dma_fence_chain_alloc();
888 drm_syncobj_add_point(timeline_syncobj, chain, fence, args->dst_point);
890 dma_fence_put(fence);
892 drm_syncobj_put(timeline_syncobj);
898 drm_syncobj_transfer_to_binary(struct drm_file *file_private,
899 struct drm_syncobj_transfer *args)
901 struct drm_syncobj *binary_syncobj = NULL;
902 struct dma_fence *fence;
905 binary_syncobj = drm_syncobj_find(file_private, args->dst_handle);
908 ret = drm_syncobj_find_fence(file_private, args->src_handle,
909 args->src_point, args->flags, &fence);
912 drm_syncobj_replace_fence(binary_syncobj, fence);
913 dma_fence_put(fence);
915 drm_syncobj_put(binary_syncobj);
920 drm_syncobj_transfer_ioctl(struct drm_device *dev, void *data,
921 struct drm_file *file_private)
923 struct drm_syncobj_transfer *args = data;
926 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ_TIMELINE))
933 ret = drm_syncobj_transfer_to_timeline(file_private, args);
935 ret = drm_syncobj_transfer_to_binary(file_private, args);
940 static void syncobj_wait_fence_func(struct dma_fence *fence,
941 struct dma_fence_cb *cb)
943 struct syncobj_wait_entry *wait =
944 container_of(cb, struct syncobj_wait_entry, fence_cb);
946 wake_up_process(wait->task);
949 static void syncobj_wait_syncobj_func(struct drm_syncobj *syncobj,
950 struct syncobj_wait_entry *wait)
952 struct dma_fence *fence;
954 /* This happens inside the syncobj lock */
955 fence = rcu_dereference_protected(syncobj->fence,
956 lockdep_is_held(&syncobj->lock));
957 dma_fence_get(fence);
958 if (!fence || dma_fence_chain_find_seqno(&fence, wait->point)) {
959 dma_fence_put(fence);
962 wait->fence = dma_fence_get_stub();
967 wake_up_process(wait->task);
968 list_del_init(&wait->node);
971 static signed long drm_syncobj_array_wait_timeout(struct drm_syncobj **syncobjs,
972 void __user *user_points,
978 struct syncobj_wait_entry *entries;
979 struct dma_fence *fence;
981 uint32_t signaled_count, i;
983 if (flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT)
984 lockdep_assert_none_held_once();
986 points = kmalloc_array(count, sizeof(*points), GFP_KERNEL);
991 memset(points, 0, count * sizeof(uint64_t));
993 } else if (copy_from_user(points, user_points,
994 sizeof(uint64_t) * count)) {
996 goto err_free_points;
999 entries = kcalloc(count, sizeof(*entries), GFP_KERNEL);
1002 goto err_free_points;
1004 /* Walk the list of sync objects and initialize entries. We do
1005 * this up-front so that we can properly return -EINVAL if there is
1006 * a syncobj with a missing fence and then never have the chance of
1007 * returning -EINVAL again.
1010 for (i = 0; i < count; ++i) {
1011 struct dma_fence *fence;
1013 entries[i].task = current;
1014 entries[i].point = points[i];
1015 fence = drm_syncobj_fence_get(syncobjs[i]);
1016 if (!fence || dma_fence_chain_find_seqno(&fence, points[i])) {
1017 dma_fence_put(fence);
1018 if (flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT) {
1022 goto cleanup_entries;
1027 entries[i].fence = fence;
1029 entries[i].fence = dma_fence_get_stub();
1031 if ((flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_AVAILABLE) ||
1032 dma_fence_is_signaled(entries[i].fence)) {
1033 if (signaled_count == 0 && idx)
1039 if (signaled_count == count ||
1040 (signaled_count > 0 &&
1041 !(flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_ALL)))
1042 goto cleanup_entries;
1044 /* There's a very annoying laxness in the dma_fence API here, in
1045 * that backends are not required to automatically report when a
1046 * fence is signaled prior to fence->ops->enable_signaling() being
1047 * called. So here if we fail to match signaled_count, we need to
1048 * fallthough and try a 0 timeout wait!
1051 if (flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT) {
1052 for (i = 0; i < count; ++i)
1053 drm_syncobj_fence_add_wait(syncobjs[i], &entries[i]);
1057 set_current_state(TASK_INTERRUPTIBLE);
1060 for (i = 0; i < count; ++i) {
1061 fence = entries[i].fence;
1065 if ((flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_AVAILABLE) ||
1066 dma_fence_is_signaled(fence) ||
1067 (!entries[i].fence_cb.func &&
1068 dma_fence_add_callback(fence,
1069 &entries[i].fence_cb,
1070 syncobj_wait_fence_func))) {
1071 /* The fence has been signaled */
1072 if (flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_ALL) {
1082 if (signaled_count == count)
1090 if (signal_pending(current)) {
1091 timeout = -ERESTARTSYS;
1095 timeout = schedule_timeout(timeout);
1099 __set_current_state(TASK_RUNNING);
1102 for (i = 0; i < count; ++i) {
1103 drm_syncobj_remove_wait(syncobjs[i], &entries[i]);
1104 if (entries[i].fence_cb.func)
1105 dma_fence_remove_callback(entries[i].fence,
1106 &entries[i].fence_cb);
1107 dma_fence_put(entries[i].fence);
1118 * drm_timeout_abs_to_jiffies - calculate jiffies timeout from absolute value
1120 * @timeout_nsec: timeout nsec component in ns, 0 for poll
1122 * Calculate the timeout in jiffies from an absolute time in sec/nsec.
1124 signed long drm_timeout_abs_to_jiffies(int64_t timeout_nsec)
1126 ktime_t abs_timeout, now;
1127 u64 timeout_ns, timeout_jiffies64;
1129 /* make 0 timeout means poll - absolute 0 doesn't seem valid */
1130 if (timeout_nsec == 0)
1133 abs_timeout = ns_to_ktime(timeout_nsec);
1136 if (!ktime_after(abs_timeout, now))
1139 timeout_ns = ktime_to_ns(ktime_sub(abs_timeout, now));
1141 timeout_jiffies64 = nsecs_to_jiffies64(timeout_ns);
1142 /* clamp timeout to avoid infinite timeout */
1143 if (timeout_jiffies64 >= MAX_SCHEDULE_TIMEOUT - 1)
1144 return MAX_SCHEDULE_TIMEOUT - 1;
1146 return timeout_jiffies64 + 1;
1148 EXPORT_SYMBOL(drm_timeout_abs_to_jiffies);
1150 static int drm_syncobj_array_wait(struct drm_device *dev,
1151 struct drm_file *file_private,
1152 struct drm_syncobj_wait *wait,
1153 struct drm_syncobj_timeline_wait *timeline_wait,
1154 struct drm_syncobj **syncobjs, bool timeline)
1156 signed long timeout = 0;
1157 uint32_t first = ~0;
1160 timeout = drm_timeout_abs_to_jiffies(wait->timeout_nsec);
1161 timeout = drm_syncobj_array_wait_timeout(syncobjs,
1163 wait->count_handles,
1168 wait->first_signaled = first;
1170 timeout = drm_timeout_abs_to_jiffies(timeline_wait->timeout_nsec);
1171 timeout = drm_syncobj_array_wait_timeout(syncobjs,
1172 u64_to_user_ptr(timeline_wait->points),
1173 timeline_wait->count_handles,
1174 timeline_wait->flags,
1178 timeline_wait->first_signaled = first;
1183 static int drm_syncobj_array_find(struct drm_file *file_private,
1184 void __user *user_handles,
1185 uint32_t count_handles,
1186 struct drm_syncobj ***syncobjs_out)
1188 uint32_t i, *handles;
1189 struct drm_syncobj **syncobjs;
1192 handles = kmalloc_array(count_handles, sizeof(*handles), GFP_KERNEL);
1193 if (handles == NULL)
1196 if (copy_from_user(handles, user_handles,
1197 sizeof(uint32_t) * count_handles)) {
1199 goto err_free_handles;
1202 syncobjs = kmalloc_array(count_handles, sizeof(*syncobjs), GFP_KERNEL);
1203 if (syncobjs == NULL) {
1205 goto err_free_handles;
1208 for (i = 0; i < count_handles; i++) {
1209 syncobjs[i] = drm_syncobj_find(file_private, handles[i]);
1212 goto err_put_syncobjs;
1217 *syncobjs_out = syncobjs;
1222 drm_syncobj_put(syncobjs[i]);
1230 static void drm_syncobj_array_free(struct drm_syncobj **syncobjs,
1235 for (i = 0; i < count; i++)
1236 drm_syncobj_put(syncobjs[i]);
1241 drm_syncobj_wait_ioctl(struct drm_device *dev, void *data,
1242 struct drm_file *file_private)
1244 struct drm_syncobj_wait *args = data;
1245 struct drm_syncobj **syncobjs;
1248 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
1251 if (args->flags & ~(DRM_SYNCOBJ_WAIT_FLAGS_WAIT_ALL |
1252 DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT))
1255 if (args->count_handles == 0)
1258 ret = drm_syncobj_array_find(file_private,
1259 u64_to_user_ptr(args->handles),
1260 args->count_handles,
1265 ret = drm_syncobj_array_wait(dev, file_private,
1266 args, NULL, syncobjs, false);
1268 drm_syncobj_array_free(syncobjs, args->count_handles);
1274 drm_syncobj_timeline_wait_ioctl(struct drm_device *dev, void *data,
1275 struct drm_file *file_private)
1277 struct drm_syncobj_timeline_wait *args = data;
1278 struct drm_syncobj **syncobjs;
1281 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ_TIMELINE))
1284 if (args->flags & ~(DRM_SYNCOBJ_WAIT_FLAGS_WAIT_ALL |
1285 DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT |
1286 DRM_SYNCOBJ_WAIT_FLAGS_WAIT_AVAILABLE))
1289 if (args->count_handles == 0)
1292 ret = drm_syncobj_array_find(file_private,
1293 u64_to_user_ptr(args->handles),
1294 args->count_handles,
1299 ret = drm_syncobj_array_wait(dev, file_private,
1300 NULL, args, syncobjs, true);
1302 drm_syncobj_array_free(syncobjs, args->count_handles);
1309 drm_syncobj_reset_ioctl(struct drm_device *dev, void *data,
1310 struct drm_file *file_private)
1312 struct drm_syncobj_array *args = data;
1313 struct drm_syncobj **syncobjs;
1317 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
1323 if (args->count_handles == 0)
1326 ret = drm_syncobj_array_find(file_private,
1327 u64_to_user_ptr(args->handles),
1328 args->count_handles,
1333 for (i = 0; i < args->count_handles; i++)
1334 drm_syncobj_replace_fence(syncobjs[i], NULL);
1336 drm_syncobj_array_free(syncobjs, args->count_handles);
1342 drm_syncobj_signal_ioctl(struct drm_device *dev, void *data,
1343 struct drm_file *file_private)
1345 struct drm_syncobj_array *args = data;
1346 struct drm_syncobj **syncobjs;
1350 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
1356 if (args->count_handles == 0)
1359 ret = drm_syncobj_array_find(file_private,
1360 u64_to_user_ptr(args->handles),
1361 args->count_handles,
1366 for (i = 0; i < args->count_handles; i++) {
1367 ret = drm_syncobj_assign_null_handle(syncobjs[i]);
1372 drm_syncobj_array_free(syncobjs, args->count_handles);
1378 drm_syncobj_timeline_signal_ioctl(struct drm_device *dev, void *data,
1379 struct drm_file *file_private)
1381 struct drm_syncobj_timeline_array *args = data;
1382 struct drm_syncobj **syncobjs;
1383 struct dma_fence_chain **chains;
1388 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ_TIMELINE))
1391 if (args->flags != 0)
1394 if (args->count_handles == 0)
1397 ret = drm_syncobj_array_find(file_private,
1398 u64_to_user_ptr(args->handles),
1399 args->count_handles,
1404 points = kmalloc_array(args->count_handles, sizeof(*points),
1410 if (!u64_to_user_ptr(args->points)) {
1411 memset(points, 0, args->count_handles * sizeof(uint64_t));
1412 } else if (copy_from_user(points, u64_to_user_ptr(args->points),
1413 sizeof(uint64_t) * args->count_handles)) {
1418 chains = kmalloc_array(args->count_handles, sizeof(void *), GFP_KERNEL);
1423 for (i = 0; i < args->count_handles; i++) {
1424 chains[i] = dma_fence_chain_alloc();
1426 for (j = 0; j < i; j++)
1427 dma_fence_chain_free(chains[j]);
1433 for (i = 0; i < args->count_handles; i++) {
1434 struct dma_fence *fence = dma_fence_get_stub();
1436 drm_syncobj_add_point(syncobjs[i], chains[i],
1438 dma_fence_put(fence);
1445 drm_syncobj_array_free(syncobjs, args->count_handles);
1450 int drm_syncobj_query_ioctl(struct drm_device *dev, void *data,
1451 struct drm_file *file_private)
1453 struct drm_syncobj_timeline_array *args = data;
1454 struct drm_syncobj **syncobjs;
1455 uint64_t __user *points = u64_to_user_ptr(args->points);
1459 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ_TIMELINE))
1462 if (args->flags & ~DRM_SYNCOBJ_QUERY_FLAGS_LAST_SUBMITTED)
1465 if (args->count_handles == 0)
1468 ret = drm_syncobj_array_find(file_private,
1469 u64_to_user_ptr(args->handles),
1470 args->count_handles,
1475 for (i = 0; i < args->count_handles; i++) {
1476 struct dma_fence_chain *chain;
1477 struct dma_fence *fence;
1480 fence = drm_syncobj_fence_get(syncobjs[i]);
1481 chain = to_dma_fence_chain(fence);
1483 struct dma_fence *iter, *last_signaled =
1484 dma_fence_get(fence);
1487 DRM_SYNCOBJ_QUERY_FLAGS_LAST_SUBMITTED) {
1488 point = fence->seqno;
1490 dma_fence_chain_for_each(iter, fence) {
1491 if (iter->context != fence->context) {
1492 dma_fence_put(iter);
1493 /* It is most likely that timeline has
1494 * unorder points. */
1497 dma_fence_put(last_signaled);
1498 last_signaled = dma_fence_get(iter);
1500 point = dma_fence_is_signaled(last_signaled) ?
1501 last_signaled->seqno :
1502 to_dma_fence_chain(last_signaled)->prev_seqno;
1504 dma_fence_put(last_signaled);
1508 dma_fence_put(fence);
1509 ret = copy_to_user(&points[i], &point, sizeof(uint64_t));
1510 ret = ret ? -EFAULT : 0;
1514 drm_syncobj_array_free(syncobjs, args->count_handles);