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/file.h>
188 #include <linux/fs.h>
189 #include <linux/sched/signal.h>
190 #include <linux/sync_file.h>
191 #include <linux/uaccess.h>
194 #include <drm/drm_drv.h>
195 #include <drm/drm_file.h>
196 #include <drm/drm_gem.h>
197 #include <drm/drm_print.h>
198 #include <drm/drm_syncobj.h>
199 #include <drm/drm_utils.h>
201 #include "drm_internal.h"
203 struct syncobj_wait_entry {
204 struct list_head node;
205 struct task_struct *task;
206 struct dma_fence *fence;
207 struct dma_fence_cb fence_cb;
211 static void syncobj_wait_syncobj_func(struct drm_syncobj *syncobj,
212 struct syncobj_wait_entry *wait);
215 * drm_syncobj_find - lookup and reference a sync object.
216 * @file_private: drm file private pointer
217 * @handle: sync object handle to lookup.
219 * Returns a reference to the syncobj pointed to by handle or NULL. The
220 * reference must be released by calling drm_syncobj_put().
222 struct drm_syncobj *drm_syncobj_find(struct drm_file *file_private,
225 struct drm_syncobj *syncobj;
227 spin_lock(&file_private->syncobj_table_lock);
229 /* Check if we currently have a reference on the object */
230 syncobj = idr_find(&file_private->syncobj_idr, handle);
232 drm_syncobj_get(syncobj);
234 spin_unlock(&file_private->syncobj_table_lock);
238 EXPORT_SYMBOL(drm_syncobj_find);
240 static void drm_syncobj_fence_add_wait(struct drm_syncobj *syncobj,
241 struct syncobj_wait_entry *wait)
243 struct dma_fence *fence;
248 spin_lock(&syncobj->lock);
249 /* We've already tried once to get a fence and failed. Now that we
250 * have the lock, try one more time just to be sure we don't add a
251 * callback when a fence has already been set.
253 fence = dma_fence_get(rcu_dereference_protected(syncobj->fence, 1));
254 if (!fence || dma_fence_chain_find_seqno(&fence, wait->point)) {
255 dma_fence_put(fence);
256 list_add_tail(&wait->node, &syncobj->cb_list);
258 wait->fence = dma_fence_get_stub();
262 spin_unlock(&syncobj->lock);
265 static void drm_syncobj_remove_wait(struct drm_syncobj *syncobj,
266 struct syncobj_wait_entry *wait)
268 if (!wait->node.next)
271 spin_lock(&syncobj->lock);
272 list_del_init(&wait->node);
273 spin_unlock(&syncobj->lock);
277 * drm_syncobj_add_point - add new timeline point to the syncobj
278 * @syncobj: sync object to add timeline point do
279 * @chain: chain node to use to add the point
280 * @fence: fence to encapsulate in the chain node
281 * @point: sequence number to use for the point
283 * Add the chain node as new timeline point to the syncobj.
285 void drm_syncobj_add_point(struct drm_syncobj *syncobj,
286 struct dma_fence_chain *chain,
287 struct dma_fence *fence,
290 struct syncobj_wait_entry *cur, *tmp;
291 struct dma_fence *prev;
293 dma_fence_get(fence);
295 spin_lock(&syncobj->lock);
297 prev = drm_syncobj_fence_get(syncobj);
298 /* You are adding an unorder point to timeline, which could cause payload returned from query_ioctl is 0! */
299 if (prev && prev->seqno >= point)
300 DRM_DEBUG("You are adding an unorder point to timeline!\n");
301 dma_fence_chain_init(chain, prev, fence, point);
302 rcu_assign_pointer(syncobj->fence, &chain->base);
304 list_for_each_entry_safe(cur, tmp, &syncobj->cb_list, node)
305 syncobj_wait_syncobj_func(syncobj, cur);
306 spin_unlock(&syncobj->lock);
308 /* Walk the chain once to trigger garbage collection */
309 dma_fence_chain_for_each(fence, prev);
312 EXPORT_SYMBOL(drm_syncobj_add_point);
315 * drm_syncobj_replace_fence - replace fence in a sync object.
316 * @syncobj: Sync object to replace fence in
317 * @fence: fence to install in sync file.
319 * This replaces the fence on a sync object.
321 void drm_syncobj_replace_fence(struct drm_syncobj *syncobj,
322 struct dma_fence *fence)
324 struct dma_fence *old_fence;
325 struct syncobj_wait_entry *cur, *tmp;
328 dma_fence_get(fence);
330 spin_lock(&syncobj->lock);
332 old_fence = rcu_dereference_protected(syncobj->fence,
333 lockdep_is_held(&syncobj->lock));
334 rcu_assign_pointer(syncobj->fence, fence);
336 if (fence != old_fence) {
337 list_for_each_entry_safe(cur, tmp, &syncobj->cb_list, node)
338 syncobj_wait_syncobj_func(syncobj, cur);
341 spin_unlock(&syncobj->lock);
343 dma_fence_put(old_fence);
345 EXPORT_SYMBOL(drm_syncobj_replace_fence);
348 * drm_syncobj_assign_null_handle - assign a stub fence to the sync object
349 * @syncobj: sync object to assign the fence on
351 * Assign a already signaled stub fence to the sync object.
353 static void drm_syncobj_assign_null_handle(struct drm_syncobj *syncobj)
355 struct dma_fence *fence = dma_fence_get_stub();
357 drm_syncobj_replace_fence(syncobj, fence);
358 dma_fence_put(fence);
361 /* 5s default for wait submission */
362 #define DRM_SYNCOBJ_WAIT_FOR_SUBMIT_TIMEOUT 5000000000ULL
364 * drm_syncobj_find_fence - lookup and reference the fence in a sync object
365 * @file_private: drm file private pointer
366 * @handle: sync object handle to lookup.
367 * @point: timeline point
368 * @flags: DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT or not
369 * @fence: out parameter for the fence
371 * This is just a convenience function that combines drm_syncobj_find() and
372 * drm_syncobj_fence_get().
374 * Returns 0 on success or a negative error value on failure. On success @fence
375 * contains a reference to the fence, which must be released by calling
378 int drm_syncobj_find_fence(struct drm_file *file_private,
379 u32 handle, u64 point, u64 flags,
380 struct dma_fence **fence)
382 struct drm_syncobj *syncobj = drm_syncobj_find(file_private, handle);
383 struct syncobj_wait_entry wait;
384 u64 timeout = nsecs_to_jiffies64(DRM_SYNCOBJ_WAIT_FOR_SUBMIT_TIMEOUT);
390 /* Waiting for userspace with locks help is illegal cause that can
391 * trivial deadlock with page faults for example. Make lockdep complain
394 if (flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT) {
396 lockdep_assert_none_held_once();
399 *fence = drm_syncobj_fence_get(syncobj);
402 ret = dma_fence_chain_find_seqno(fence, point);
404 /* If the requested seqno is already signaled
405 * drm_syncobj_find_fence may return a NULL
406 * fence. To make sure the recipient gets
407 * signalled, use a new fence instead.
410 *fence = dma_fence_get_stub();
414 dma_fence_put(*fence);
419 if (!(flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT))
422 memset(&wait, 0, sizeof(wait));
425 drm_syncobj_fence_add_wait(syncobj, &wait);
428 set_current_state(TASK_INTERRUPTIBLE);
438 if (signal_pending(current)) {
443 timeout = schedule_timeout(timeout);
446 __set_current_state(TASK_RUNNING);
450 drm_syncobj_remove_wait(syncobj, &wait);
453 drm_syncobj_put(syncobj);
457 EXPORT_SYMBOL(drm_syncobj_find_fence);
460 * drm_syncobj_free - free a sync object.
461 * @kref: kref to free.
463 * Only to be called from kref_put in drm_syncobj_put.
465 void drm_syncobj_free(struct kref *kref)
467 struct drm_syncobj *syncobj = container_of(kref,
470 drm_syncobj_replace_fence(syncobj, NULL);
473 EXPORT_SYMBOL(drm_syncobj_free);
476 * drm_syncobj_create - create a new syncobj
477 * @out_syncobj: returned syncobj
478 * @flags: DRM_SYNCOBJ_* flags
479 * @fence: if non-NULL, the syncobj will represent this fence
481 * This is the first function to create a sync object. After creating, drivers
482 * probably want to make it available to userspace, either through
483 * drm_syncobj_get_handle() or drm_syncobj_get_fd().
485 * Returns 0 on success or a negative error value on failure.
487 int drm_syncobj_create(struct drm_syncobj **out_syncobj, uint32_t flags,
488 struct dma_fence *fence)
490 struct drm_syncobj *syncobj;
492 syncobj = kzalloc(sizeof(struct drm_syncobj), GFP_KERNEL);
496 kref_init(&syncobj->refcount);
497 INIT_LIST_HEAD(&syncobj->cb_list);
498 spin_lock_init(&syncobj->lock);
500 if (flags & DRM_SYNCOBJ_CREATE_SIGNALED)
501 drm_syncobj_assign_null_handle(syncobj);
504 drm_syncobj_replace_fence(syncobj, fence);
506 *out_syncobj = syncobj;
509 EXPORT_SYMBOL(drm_syncobj_create);
512 * drm_syncobj_get_handle - get a handle from a syncobj
513 * @file_private: drm file private pointer
514 * @syncobj: Sync object to export
515 * @handle: out parameter with the new handle
517 * Exports a sync object created with drm_syncobj_create() as a handle on
518 * @file_private to userspace.
520 * Returns 0 on success or a negative error value on failure.
522 int drm_syncobj_get_handle(struct drm_file *file_private,
523 struct drm_syncobj *syncobj, u32 *handle)
527 /* take a reference to put in the idr */
528 drm_syncobj_get(syncobj);
530 idr_preload(GFP_KERNEL);
531 spin_lock(&file_private->syncobj_table_lock);
532 ret = idr_alloc(&file_private->syncobj_idr, syncobj, 1, 0, GFP_NOWAIT);
533 spin_unlock(&file_private->syncobj_table_lock);
538 drm_syncobj_put(syncobj);
545 EXPORT_SYMBOL(drm_syncobj_get_handle);
547 static int drm_syncobj_create_as_handle(struct drm_file *file_private,
548 u32 *handle, uint32_t flags)
551 struct drm_syncobj *syncobj;
553 ret = drm_syncobj_create(&syncobj, flags, NULL);
557 ret = drm_syncobj_get_handle(file_private, syncobj, handle);
558 drm_syncobj_put(syncobj);
562 static int drm_syncobj_destroy(struct drm_file *file_private,
565 struct drm_syncobj *syncobj;
567 spin_lock(&file_private->syncobj_table_lock);
568 syncobj = idr_remove(&file_private->syncobj_idr, handle);
569 spin_unlock(&file_private->syncobj_table_lock);
574 drm_syncobj_put(syncobj);
578 static int drm_syncobj_file_release(struct inode *inode, struct file *file)
580 struct drm_syncobj *syncobj = file->private_data;
582 drm_syncobj_put(syncobj);
586 static const struct file_operations drm_syncobj_file_fops = {
587 .release = drm_syncobj_file_release,
591 * drm_syncobj_get_fd - get a file descriptor from a syncobj
592 * @syncobj: Sync object to export
593 * @p_fd: out parameter with the new file descriptor
595 * Exports a sync object created with drm_syncobj_create() as a file descriptor.
597 * Returns 0 on success or a negative error value on failure.
599 int drm_syncobj_get_fd(struct drm_syncobj *syncobj, int *p_fd)
604 fd = get_unused_fd_flags(O_CLOEXEC);
608 file = anon_inode_getfile("syncobj_file",
609 &drm_syncobj_file_fops,
613 return PTR_ERR(file);
616 drm_syncobj_get(syncobj);
617 fd_install(fd, file);
622 EXPORT_SYMBOL(drm_syncobj_get_fd);
624 static int drm_syncobj_handle_to_fd(struct drm_file *file_private,
625 u32 handle, int *p_fd)
627 struct drm_syncobj *syncobj = drm_syncobj_find(file_private, handle);
633 ret = drm_syncobj_get_fd(syncobj, p_fd);
634 drm_syncobj_put(syncobj);
638 static int drm_syncobj_fd_to_handle(struct drm_file *file_private,
641 struct drm_syncobj *syncobj;
642 struct fd f = fdget(fd);
648 if (f.file->f_op != &drm_syncobj_file_fops) {
653 /* take a reference to put in the idr */
654 syncobj = f.file->private_data;
655 drm_syncobj_get(syncobj);
657 idr_preload(GFP_KERNEL);
658 spin_lock(&file_private->syncobj_table_lock);
659 ret = idr_alloc(&file_private->syncobj_idr, syncobj, 1, 0, GFP_NOWAIT);
660 spin_unlock(&file_private->syncobj_table_lock);
667 drm_syncobj_put(syncobj);
673 static int drm_syncobj_import_sync_file_fence(struct drm_file *file_private,
676 struct dma_fence *fence = sync_file_get_fence(fd);
677 struct drm_syncobj *syncobj;
682 syncobj = drm_syncobj_find(file_private, handle);
684 dma_fence_put(fence);
688 drm_syncobj_replace_fence(syncobj, fence);
689 dma_fence_put(fence);
690 drm_syncobj_put(syncobj);
694 static int drm_syncobj_export_sync_file(struct drm_file *file_private,
695 int handle, int *p_fd)
698 struct dma_fence *fence;
699 struct sync_file *sync_file;
700 int fd = get_unused_fd_flags(O_CLOEXEC);
705 ret = drm_syncobj_find_fence(file_private, handle, 0, 0, &fence);
709 sync_file = sync_file_create(fence);
711 dma_fence_put(fence);
718 fd_install(fd, sync_file->file);
727 * drm_syncobj_open - initalizes syncobj file-private structures at devnode open time
728 * @file_private: drm file-private structure to set up
730 * Called at device open time, sets up the structure for handling refcounting
734 drm_syncobj_open(struct drm_file *file_private)
736 idr_init_base(&file_private->syncobj_idr, 1);
737 spin_lock_init(&file_private->syncobj_table_lock);
741 drm_syncobj_release_handle(int id, void *ptr, void *data)
743 struct drm_syncobj *syncobj = ptr;
745 drm_syncobj_put(syncobj);
750 * drm_syncobj_release - release file-private sync object resources
751 * @file_private: drm file-private structure to clean up
753 * Called at close time when the filp is going away.
755 * Releases any remaining references on objects by this filp.
758 drm_syncobj_release(struct drm_file *file_private)
760 idr_for_each(&file_private->syncobj_idr,
761 &drm_syncobj_release_handle, file_private);
762 idr_destroy(&file_private->syncobj_idr);
766 drm_syncobj_create_ioctl(struct drm_device *dev, void *data,
767 struct drm_file *file_private)
769 struct drm_syncobj_create *args = data;
771 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
774 /* no valid flags yet */
775 if (args->flags & ~DRM_SYNCOBJ_CREATE_SIGNALED)
778 return drm_syncobj_create_as_handle(file_private,
779 &args->handle, args->flags);
783 drm_syncobj_destroy_ioctl(struct drm_device *dev, void *data,
784 struct drm_file *file_private)
786 struct drm_syncobj_destroy *args = data;
788 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
791 /* make sure padding is empty */
794 return drm_syncobj_destroy(file_private, args->handle);
798 drm_syncobj_handle_to_fd_ioctl(struct drm_device *dev, void *data,
799 struct drm_file *file_private)
801 struct drm_syncobj_handle *args = data;
803 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
809 if (args->flags != 0 &&
810 args->flags != DRM_SYNCOBJ_HANDLE_TO_FD_FLAGS_EXPORT_SYNC_FILE)
813 if (args->flags & DRM_SYNCOBJ_HANDLE_TO_FD_FLAGS_EXPORT_SYNC_FILE)
814 return drm_syncobj_export_sync_file(file_private, args->handle,
817 return drm_syncobj_handle_to_fd(file_private, args->handle,
822 drm_syncobj_fd_to_handle_ioctl(struct drm_device *dev, void *data,
823 struct drm_file *file_private)
825 struct drm_syncobj_handle *args = data;
827 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
833 if (args->flags != 0 &&
834 args->flags != DRM_SYNCOBJ_FD_TO_HANDLE_FLAGS_IMPORT_SYNC_FILE)
837 if (args->flags & DRM_SYNCOBJ_FD_TO_HANDLE_FLAGS_IMPORT_SYNC_FILE)
838 return drm_syncobj_import_sync_file_fence(file_private,
842 return drm_syncobj_fd_to_handle(file_private, args->fd,
846 static int drm_syncobj_transfer_to_timeline(struct drm_file *file_private,
847 struct drm_syncobj_transfer *args)
849 struct drm_syncobj *timeline_syncobj = NULL;
850 struct dma_fence *fence;
851 struct dma_fence_chain *chain;
854 timeline_syncobj = drm_syncobj_find(file_private, args->dst_handle);
855 if (!timeline_syncobj) {
858 ret = drm_syncobj_find_fence(file_private, args->src_handle,
859 args->src_point, args->flags,
863 chain = kzalloc(sizeof(struct dma_fence_chain), GFP_KERNEL);
868 drm_syncobj_add_point(timeline_syncobj, chain, fence, args->dst_point);
870 dma_fence_put(fence);
872 drm_syncobj_put(timeline_syncobj);
878 drm_syncobj_transfer_to_binary(struct drm_file *file_private,
879 struct drm_syncobj_transfer *args)
881 struct drm_syncobj *binary_syncobj = NULL;
882 struct dma_fence *fence;
885 binary_syncobj = drm_syncobj_find(file_private, args->dst_handle);
888 ret = drm_syncobj_find_fence(file_private, args->src_handle,
889 args->src_point, args->flags, &fence);
892 drm_syncobj_replace_fence(binary_syncobj, fence);
893 dma_fence_put(fence);
895 drm_syncobj_put(binary_syncobj);
900 drm_syncobj_transfer_ioctl(struct drm_device *dev, void *data,
901 struct drm_file *file_private)
903 struct drm_syncobj_transfer *args = data;
906 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ_TIMELINE))
913 ret = drm_syncobj_transfer_to_timeline(file_private, args);
915 ret = drm_syncobj_transfer_to_binary(file_private, args);
920 static void syncobj_wait_fence_func(struct dma_fence *fence,
921 struct dma_fence_cb *cb)
923 struct syncobj_wait_entry *wait =
924 container_of(cb, struct syncobj_wait_entry, fence_cb);
926 wake_up_process(wait->task);
929 static void syncobj_wait_syncobj_func(struct drm_syncobj *syncobj,
930 struct syncobj_wait_entry *wait)
932 struct dma_fence *fence;
934 /* This happens inside the syncobj lock */
935 fence = rcu_dereference_protected(syncobj->fence,
936 lockdep_is_held(&syncobj->lock));
937 dma_fence_get(fence);
938 if (!fence || dma_fence_chain_find_seqno(&fence, wait->point)) {
939 dma_fence_put(fence);
942 wait->fence = dma_fence_get_stub();
947 wake_up_process(wait->task);
948 list_del_init(&wait->node);
951 static signed long drm_syncobj_array_wait_timeout(struct drm_syncobj **syncobjs,
952 void __user *user_points,
958 struct syncobj_wait_entry *entries;
959 struct dma_fence *fence;
961 uint32_t signaled_count, i;
963 if (flags & (DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT |
964 DRM_SYNCOBJ_WAIT_FLAGS_WAIT_AVAILABLE))
965 lockdep_assert_none_held_once();
967 points = kmalloc_array(count, sizeof(*points), GFP_KERNEL);
972 memset(points, 0, count * sizeof(uint64_t));
974 } else if (copy_from_user(points, user_points,
975 sizeof(uint64_t) * count)) {
977 goto err_free_points;
980 entries = kcalloc(count, sizeof(*entries), GFP_KERNEL);
983 goto err_free_points;
985 /* Walk the list of sync objects and initialize entries. We do
986 * this up-front so that we can properly return -EINVAL if there is
987 * a syncobj with a missing fence and then never have the chance of
988 * returning -EINVAL again.
991 for (i = 0; i < count; ++i) {
992 struct dma_fence *fence;
994 entries[i].task = current;
995 entries[i].point = points[i];
996 fence = drm_syncobj_fence_get(syncobjs[i]);
997 if (!fence || dma_fence_chain_find_seqno(&fence, points[i])) {
998 dma_fence_put(fence);
999 if (flags & (DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT |
1000 DRM_SYNCOBJ_WAIT_FLAGS_WAIT_AVAILABLE)) {
1004 goto cleanup_entries;
1009 entries[i].fence = fence;
1011 entries[i].fence = dma_fence_get_stub();
1013 if ((flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_AVAILABLE) ||
1014 dma_fence_is_signaled(entries[i].fence)) {
1015 if (signaled_count == 0 && idx)
1021 if (signaled_count == count ||
1022 (signaled_count > 0 &&
1023 !(flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_ALL)))
1024 goto cleanup_entries;
1026 /* There's a very annoying laxness in the dma_fence API here, in
1027 * that backends are not required to automatically report when a
1028 * fence is signaled prior to fence->ops->enable_signaling() being
1029 * called. So here if we fail to match signaled_count, we need to
1030 * fallthough and try a 0 timeout wait!
1033 if (flags & (DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT |
1034 DRM_SYNCOBJ_WAIT_FLAGS_WAIT_AVAILABLE)) {
1035 for (i = 0; i < count; ++i)
1036 drm_syncobj_fence_add_wait(syncobjs[i], &entries[i]);
1040 set_current_state(TASK_INTERRUPTIBLE);
1043 for (i = 0; i < count; ++i) {
1044 fence = entries[i].fence;
1048 if ((flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_AVAILABLE) ||
1049 dma_fence_is_signaled(fence) ||
1050 (!entries[i].fence_cb.func &&
1051 dma_fence_add_callback(fence,
1052 &entries[i].fence_cb,
1053 syncobj_wait_fence_func))) {
1054 /* The fence has been signaled */
1055 if (flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_ALL) {
1065 if (signaled_count == count)
1073 if (signal_pending(current)) {
1074 timeout = -ERESTARTSYS;
1078 timeout = schedule_timeout(timeout);
1082 __set_current_state(TASK_RUNNING);
1085 for (i = 0; i < count; ++i) {
1086 drm_syncobj_remove_wait(syncobjs[i], &entries[i]);
1087 if (entries[i].fence_cb.func)
1088 dma_fence_remove_callback(entries[i].fence,
1089 &entries[i].fence_cb);
1090 dma_fence_put(entries[i].fence);
1101 * drm_timeout_abs_to_jiffies - calculate jiffies timeout from absolute value
1103 * @timeout_nsec: timeout nsec component in ns, 0 for poll
1105 * Calculate the timeout in jiffies from an absolute time in sec/nsec.
1107 signed long drm_timeout_abs_to_jiffies(int64_t timeout_nsec)
1109 ktime_t abs_timeout, now;
1110 u64 timeout_ns, timeout_jiffies64;
1112 /* make 0 timeout means poll - absolute 0 doesn't seem valid */
1113 if (timeout_nsec == 0)
1116 abs_timeout = ns_to_ktime(timeout_nsec);
1119 if (!ktime_after(abs_timeout, now))
1122 timeout_ns = ktime_to_ns(ktime_sub(abs_timeout, now));
1124 timeout_jiffies64 = nsecs_to_jiffies64(timeout_ns);
1125 /* clamp timeout to avoid infinite timeout */
1126 if (timeout_jiffies64 >= MAX_SCHEDULE_TIMEOUT - 1)
1127 return MAX_SCHEDULE_TIMEOUT - 1;
1129 return timeout_jiffies64 + 1;
1131 EXPORT_SYMBOL(drm_timeout_abs_to_jiffies);
1133 static int drm_syncobj_array_wait(struct drm_device *dev,
1134 struct drm_file *file_private,
1135 struct drm_syncobj_wait *wait,
1136 struct drm_syncobj_timeline_wait *timeline_wait,
1137 struct drm_syncobj **syncobjs, bool timeline)
1139 signed long timeout = 0;
1140 uint32_t first = ~0;
1143 timeout = drm_timeout_abs_to_jiffies(wait->timeout_nsec);
1144 timeout = drm_syncobj_array_wait_timeout(syncobjs,
1146 wait->count_handles,
1151 wait->first_signaled = first;
1153 timeout = drm_timeout_abs_to_jiffies(timeline_wait->timeout_nsec);
1154 timeout = drm_syncobj_array_wait_timeout(syncobjs,
1155 u64_to_user_ptr(timeline_wait->points),
1156 timeline_wait->count_handles,
1157 timeline_wait->flags,
1161 timeline_wait->first_signaled = first;
1166 static int drm_syncobj_array_find(struct drm_file *file_private,
1167 void __user *user_handles,
1168 uint32_t count_handles,
1169 struct drm_syncobj ***syncobjs_out)
1171 uint32_t i, *handles;
1172 struct drm_syncobj **syncobjs;
1175 handles = kmalloc_array(count_handles, sizeof(*handles), GFP_KERNEL);
1176 if (handles == NULL)
1179 if (copy_from_user(handles, user_handles,
1180 sizeof(uint32_t) * count_handles)) {
1182 goto err_free_handles;
1185 syncobjs = kmalloc_array(count_handles, sizeof(*syncobjs), GFP_KERNEL);
1186 if (syncobjs == NULL) {
1188 goto err_free_handles;
1191 for (i = 0; i < count_handles; i++) {
1192 syncobjs[i] = drm_syncobj_find(file_private, handles[i]);
1195 goto err_put_syncobjs;
1200 *syncobjs_out = syncobjs;
1205 drm_syncobj_put(syncobjs[i]);
1213 static void drm_syncobj_array_free(struct drm_syncobj **syncobjs,
1218 for (i = 0; i < count; i++)
1219 drm_syncobj_put(syncobjs[i]);
1224 drm_syncobj_wait_ioctl(struct drm_device *dev, void *data,
1225 struct drm_file *file_private)
1227 struct drm_syncobj_wait *args = data;
1228 struct drm_syncobj **syncobjs;
1231 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
1234 if (args->flags & ~(DRM_SYNCOBJ_WAIT_FLAGS_WAIT_ALL |
1235 DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT))
1238 if (args->count_handles == 0)
1241 ret = drm_syncobj_array_find(file_private,
1242 u64_to_user_ptr(args->handles),
1243 args->count_handles,
1248 ret = drm_syncobj_array_wait(dev, file_private,
1249 args, NULL, syncobjs, false);
1251 drm_syncobj_array_free(syncobjs, args->count_handles);
1257 drm_syncobj_timeline_wait_ioctl(struct drm_device *dev, void *data,
1258 struct drm_file *file_private)
1260 struct drm_syncobj_timeline_wait *args = data;
1261 struct drm_syncobj **syncobjs;
1264 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ_TIMELINE))
1267 if (args->flags & ~(DRM_SYNCOBJ_WAIT_FLAGS_WAIT_ALL |
1268 DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT |
1269 DRM_SYNCOBJ_WAIT_FLAGS_WAIT_AVAILABLE))
1272 if (args->count_handles == 0)
1275 ret = drm_syncobj_array_find(file_private,
1276 u64_to_user_ptr(args->handles),
1277 args->count_handles,
1282 ret = drm_syncobj_array_wait(dev, file_private,
1283 NULL, args, syncobjs, true);
1285 drm_syncobj_array_free(syncobjs, args->count_handles);
1292 drm_syncobj_reset_ioctl(struct drm_device *dev, void *data,
1293 struct drm_file *file_private)
1295 struct drm_syncobj_array *args = data;
1296 struct drm_syncobj **syncobjs;
1300 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
1306 if (args->count_handles == 0)
1309 ret = drm_syncobj_array_find(file_private,
1310 u64_to_user_ptr(args->handles),
1311 args->count_handles,
1316 for (i = 0; i < args->count_handles; i++)
1317 drm_syncobj_replace_fence(syncobjs[i], NULL);
1319 drm_syncobj_array_free(syncobjs, args->count_handles);
1325 drm_syncobj_signal_ioctl(struct drm_device *dev, void *data,
1326 struct drm_file *file_private)
1328 struct drm_syncobj_array *args = data;
1329 struct drm_syncobj **syncobjs;
1333 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
1339 if (args->count_handles == 0)
1342 ret = drm_syncobj_array_find(file_private,
1343 u64_to_user_ptr(args->handles),
1344 args->count_handles,
1349 for (i = 0; i < args->count_handles; i++)
1350 drm_syncobj_assign_null_handle(syncobjs[i]);
1352 drm_syncobj_array_free(syncobjs, args->count_handles);
1358 drm_syncobj_timeline_signal_ioctl(struct drm_device *dev, void *data,
1359 struct drm_file *file_private)
1361 struct drm_syncobj_timeline_array *args = data;
1362 struct drm_syncobj **syncobjs;
1363 struct dma_fence_chain **chains;
1368 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ_TIMELINE))
1371 if (args->flags != 0)
1374 if (args->count_handles == 0)
1377 ret = drm_syncobj_array_find(file_private,
1378 u64_to_user_ptr(args->handles),
1379 args->count_handles,
1384 points = kmalloc_array(args->count_handles, sizeof(*points),
1390 if (!u64_to_user_ptr(args->points)) {
1391 memset(points, 0, args->count_handles * sizeof(uint64_t));
1392 } else if (copy_from_user(points, u64_to_user_ptr(args->points),
1393 sizeof(uint64_t) * args->count_handles)) {
1398 chains = kmalloc_array(args->count_handles, sizeof(void *), GFP_KERNEL);
1403 for (i = 0; i < args->count_handles; i++) {
1404 chains[i] = kzalloc(sizeof(struct dma_fence_chain), GFP_KERNEL);
1406 for (j = 0; j < i; j++)
1413 for (i = 0; i < args->count_handles; i++) {
1414 struct dma_fence *fence = dma_fence_get_stub();
1416 drm_syncobj_add_point(syncobjs[i], chains[i],
1418 dma_fence_put(fence);
1425 drm_syncobj_array_free(syncobjs, args->count_handles);
1430 int drm_syncobj_query_ioctl(struct drm_device *dev, void *data,
1431 struct drm_file *file_private)
1433 struct drm_syncobj_timeline_array *args = data;
1434 struct drm_syncobj **syncobjs;
1435 uint64_t __user *points = u64_to_user_ptr(args->points);
1439 if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ_TIMELINE))
1442 if (args->flags & ~DRM_SYNCOBJ_QUERY_FLAGS_LAST_SUBMITTED)
1445 if (args->count_handles == 0)
1448 ret = drm_syncobj_array_find(file_private,
1449 u64_to_user_ptr(args->handles),
1450 args->count_handles,
1455 for (i = 0; i < args->count_handles; i++) {
1456 struct dma_fence_chain *chain;
1457 struct dma_fence *fence;
1460 fence = drm_syncobj_fence_get(syncobjs[i]);
1461 chain = to_dma_fence_chain(fence);
1463 struct dma_fence *iter, *last_signaled =
1464 dma_fence_get(fence);
1467 DRM_SYNCOBJ_QUERY_FLAGS_LAST_SUBMITTED) {
1468 point = fence->seqno;
1470 dma_fence_chain_for_each(iter, fence) {
1471 if (iter->context != fence->context) {
1472 dma_fence_put(iter);
1473 /* It is most likely that timeline has
1474 * unorder points. */
1477 dma_fence_put(last_signaled);
1478 last_signaled = dma_fence_get(iter);
1480 point = dma_fence_is_signaled(last_signaled) ?
1481 last_signaled->seqno :
1482 to_dma_fence_chain(last_signaled)->prev_seqno;
1484 dma_fence_put(last_signaled);
1488 dma_fence_put(fence);
1489 ret = copy_to_user(&points[i], &point, sizeof(uint64_t));
1490 ret = ret ? -EFAULT : 0;
1494 drm_syncobj_array_free(syncobjs, args->count_handles);