Linux Audio

Check our new training course

Linux kernel drivers training

May 6-19, 2025
Register
Loading...
v6.13.7
   1/*
   2 * Copyright 2017 Red Hat
   3 * Parts ported from amdgpu (fence wait code).
   4 * Copyright 2016 Advanced Micro Devices, Inc.
   5 *
   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:
  12 *
  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
  15 * Software.
  16 *
  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
  23 * IN THE SOFTWARE.
  24 *
  25 * Authors:
  26 *
  27 */
  28
  29/**
  30 * DOC: Overview
  31 *
  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:
  38 *
  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
  45 *
  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:
  49 *
  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
  53 *
  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.
  60 *
  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.
  72 *
  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 :
  76 *
  77 *    - The syncobj's current fence if the syncobj is considered as a binary
  78 *      primitive.
  79 *    - The struct &dma_fence associated with a given point if the syncobj is
  80 *      considered as a timeline primitive.
  81 *
  82 * If the syncobj's fence is NULL or not present in the syncobj's timeline,
  83 * the enqueue operation is expected to fail.
  84 *
  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.
  92 *
  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
  96 * timeline.
  97 *
  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).
 105 *
 106 *
 107 * Host-side wait on syncobjs
 108 * --------------------------
 109 *
 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.
 116 *
 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.
 128 *
 129 * If &DRM_SYNCOBJ_WAIT_FLAGS_WAIT_DEADLINE is set, the ioctl will also set
 130 * a fence deadline hint on the backing fences before waiting, to provide the
 131 * fence signaler with an appropriate sense of urgency.  The deadline is
 132 * specified as an absolute &CLOCK_MONOTONIC value in units of ns.
 133 *
 134 * Similarly, &DRM_IOCTL_SYNCOBJ_TIMELINE_WAIT takes an array of syncobj
 135 * handles as well as an array of u64 points and does a host-side wait on all
 136 * of syncobj fences at the given points simultaneously.
 137 *
 138 * &DRM_IOCTL_SYNCOBJ_TIMELINE_WAIT also adds the ability to wait for a given
 139 * fence to materialize on the timeline without waiting for the fence to be
 140 * signaled by using the &DRM_SYNCOBJ_WAIT_FLAGS_WAIT_AVAILABLE flag. This
 141 * requirement is inherited from the wait-before-signal behavior required by
 142 * the Vulkan timeline semaphore API.
 143 *
 144 * Alternatively, &DRM_IOCTL_SYNCOBJ_EVENTFD can be used to wait without
 145 * blocking: an eventfd will be signaled when the syncobj is. This is useful to
 146 * integrate the wait in an event loop.
 147 *
 148 *
 149 * Import/export of syncobjs
 150 * -------------------------
 151 *
 152 * &DRM_IOCTL_SYNCOBJ_FD_TO_HANDLE and &DRM_IOCTL_SYNCOBJ_HANDLE_TO_FD
 153 * provide two mechanisms for import/export of syncobjs.
 154 *
 155 * The first lets the client import or export an entire syncobj to a file
 156 * descriptor.
 157 * These fd's are opaque and have no other use case, except passing the
 158 * syncobj between processes.
 159 * All exported file descriptors and any syncobj handles created as a
 160 * result of importing those file descriptors own a reference to the
 161 * same underlying struct &drm_syncobj and the syncobj can be used
 162 * persistently across all the processes with which it is shared.
 163 * The syncobj is freed only once the last reference is dropped.
 164 * Unlike dma-buf, importing a syncobj creates a new handle (with its own
 165 * reference) for every import instead of de-duplicating.
 166 * The primary use-case of this persistent import/export is for shared
 167 * Vulkan fences and semaphores.
 168 *
 169 * The second import/export mechanism, which is indicated by
 170 * &DRM_SYNCOBJ_FD_TO_HANDLE_FLAGS_IMPORT_SYNC_FILE or
 171 * &DRM_SYNCOBJ_HANDLE_TO_FD_FLAGS_EXPORT_SYNC_FILE lets the client
 172 * import/export the syncobj's current fence from/to a &sync_file.
 173 * When a syncobj is exported to a sync file, that sync file wraps the
 174 * sycnobj's fence at the time of export and any later signal or reset
 175 * operations on the syncobj will not affect the exported sync file.
 176 * When a sync file is imported into a syncobj, the syncobj's fence is set
 177 * to the fence wrapped by that sync file.
 178 * Because sync files are immutable, resetting or signaling the syncobj
 179 * will not affect any sync files whose fences have been imported into the
 180 * syncobj.
 181 *
 182 *
 183 * Import/export of timeline points in timeline syncobjs
 184 * -----------------------------------------------------
 185 *
 186 * &DRM_IOCTL_SYNCOBJ_TRANSFER provides a mechanism to transfer a struct
 187 * &dma_fence_chain of a syncobj at a given u64 point to another u64 point
 188 * into another syncobj.
 189 *
 190 * Note that if you want to transfer a struct &dma_fence_chain from a given
 191 * point on a timeline syncobj from/into a binary syncobj, you can use the
 192 * point 0 to mean take/replace the fence in the syncobj.
 193 */
 194
 195#include <linux/anon_inodes.h>
 196#include <linux/dma-fence-unwrap.h>
 197#include <linux/eventfd.h>
 198#include <linux/file.h>
 199#include <linux/fs.h>
 200#include <linux/sched/signal.h>
 201#include <linux/sync_file.h>
 202#include <linux/uaccess.h>
 203
 204#include <drm/drm.h>
 205#include <drm/drm_drv.h>
 206#include <drm/drm_file.h>
 207#include <drm/drm_gem.h>
 208#include <drm/drm_print.h>
 209#include <drm/drm_syncobj.h>
 210#include <drm/drm_utils.h>
 211
 212#include "drm_internal.h"
 213
 214struct syncobj_wait_entry {
 215	struct list_head node;
 216	struct task_struct *task;
 217	struct dma_fence *fence;
 218	struct dma_fence_cb fence_cb;
 219	u64    point;
 220};
 221
 222static void syncobj_wait_syncobj_func(struct drm_syncobj *syncobj,
 223				      struct syncobj_wait_entry *wait);
 224
 225struct syncobj_eventfd_entry {
 226	struct list_head node;
 227	struct dma_fence *fence;
 228	struct dma_fence_cb fence_cb;
 229	struct drm_syncobj *syncobj;
 230	struct eventfd_ctx *ev_fd_ctx;
 231	u64 point;
 232	u32 flags;
 233};
 234
 235static void
 236syncobj_eventfd_entry_func(struct drm_syncobj *syncobj,
 237			   struct syncobj_eventfd_entry *entry);
 238
 239/**
 240 * drm_syncobj_find - lookup and reference a sync object.
 241 * @file_private: drm file private pointer
 242 * @handle: sync object handle to lookup.
 243 *
 244 * Returns a reference to the syncobj pointed to by handle or NULL. The
 245 * reference must be released by calling drm_syncobj_put().
 246 */
 247struct drm_syncobj *drm_syncobj_find(struct drm_file *file_private,
 248				     u32 handle)
 249{
 250	struct drm_syncobj *syncobj;
 251
 252	spin_lock(&file_private->syncobj_table_lock);
 253
 254	/* Check if we currently have a reference on the object */
 255	syncobj = idr_find(&file_private->syncobj_idr, handle);
 256	if (syncobj)
 257		drm_syncobj_get(syncobj);
 258
 259	spin_unlock(&file_private->syncobj_table_lock);
 260
 261	return syncobj;
 262}
 263EXPORT_SYMBOL(drm_syncobj_find);
 264
 265static void drm_syncobj_fence_add_wait(struct drm_syncobj *syncobj,
 266				       struct syncobj_wait_entry *wait)
 267{
 268	struct dma_fence *fence;
 269
 270	if (wait->fence)
 271		return;
 272
 273	spin_lock(&syncobj->lock);
 274	/* We've already tried once to get a fence and failed.  Now that we
 275	 * have the lock, try one more time just to be sure we don't add a
 276	 * callback when a fence has already been set.
 277	 */
 278	fence = dma_fence_get(rcu_dereference_protected(syncobj->fence, 1));
 279	if (!fence || dma_fence_chain_find_seqno(&fence, wait->point)) {
 280		dma_fence_put(fence);
 281		list_add_tail(&wait->node, &syncobj->cb_list);
 282	} else if (!fence) {
 283		wait->fence = dma_fence_get_stub();
 284	} else {
 285		wait->fence = fence;
 286	}
 287	spin_unlock(&syncobj->lock);
 288}
 289
 290static void drm_syncobj_remove_wait(struct drm_syncobj *syncobj,
 291				    struct syncobj_wait_entry *wait)
 292{
 293	if (!wait->node.next)
 294		return;
 295
 296	spin_lock(&syncobj->lock);
 297	list_del_init(&wait->node);
 298	spin_unlock(&syncobj->lock);
 299}
 300
 301static void
 302syncobj_eventfd_entry_free(struct syncobj_eventfd_entry *entry)
 303{
 304	eventfd_ctx_put(entry->ev_fd_ctx);
 305	dma_fence_put(entry->fence);
 306	/* This happens either inside the syncobj lock, or after the node has
 307	 * already been removed from the list.
 308	 */
 309	list_del(&entry->node);
 310	kfree(entry);
 311}
 312
 313static void
 314drm_syncobj_add_eventfd(struct drm_syncobj *syncobj,
 315			struct syncobj_eventfd_entry *entry)
 316{
 317	spin_lock(&syncobj->lock);
 318	list_add_tail(&entry->node, &syncobj->ev_fd_list);
 319	syncobj_eventfd_entry_func(syncobj, entry);
 320	spin_unlock(&syncobj->lock);
 321}
 322
 323/**
 324 * drm_syncobj_add_point - add new timeline point to the syncobj
 325 * @syncobj: sync object to add timeline point do
 326 * @chain: chain node to use to add the point
 327 * @fence: fence to encapsulate in the chain node
 328 * @point: sequence number to use for the point
 329 *
 330 * Add the chain node as new timeline point to the syncobj.
 331 */
 332void drm_syncobj_add_point(struct drm_syncobj *syncobj,
 333			   struct dma_fence_chain *chain,
 334			   struct dma_fence *fence,
 335			   uint64_t point)
 336{
 337	struct syncobj_wait_entry *wait_cur, *wait_tmp;
 338	struct syncobj_eventfd_entry *ev_fd_cur, *ev_fd_tmp;
 339	struct dma_fence *prev;
 340
 341	dma_fence_get(fence);
 342
 343	spin_lock(&syncobj->lock);
 344
 345	prev = drm_syncobj_fence_get(syncobj);
 346	/* You are adding an unorder point to timeline, which could cause payload returned from query_ioctl is 0! */
 347	if (prev && prev->seqno >= point)
 348		DRM_DEBUG("You are adding an unorder point to timeline!\n");
 349	dma_fence_chain_init(chain, prev, fence, point);
 350	rcu_assign_pointer(syncobj->fence, &chain->base);
 351
 352	list_for_each_entry_safe(wait_cur, wait_tmp, &syncobj->cb_list, node)
 353		syncobj_wait_syncobj_func(syncobj, wait_cur);
 354	list_for_each_entry_safe(ev_fd_cur, ev_fd_tmp, &syncobj->ev_fd_list, node)
 355		syncobj_eventfd_entry_func(syncobj, ev_fd_cur);
 356	spin_unlock(&syncobj->lock);
 357
 358	/* Walk the chain once to trigger garbage collection */
 359	dma_fence_chain_for_each(fence, prev);
 360	dma_fence_put(prev);
 361}
 362EXPORT_SYMBOL(drm_syncobj_add_point);
 363
 364/**
 365 * drm_syncobj_replace_fence - replace fence in a sync object.
 366 * @syncobj: Sync object to replace fence in
 367 * @fence: fence to install in sync file.
 368 *
 369 * This replaces the fence on a sync object.
 370 */
 371void drm_syncobj_replace_fence(struct drm_syncobj *syncobj,
 372			       struct dma_fence *fence)
 373{
 374	struct dma_fence *old_fence;
 375	struct syncobj_wait_entry *wait_cur, *wait_tmp;
 376	struct syncobj_eventfd_entry *ev_fd_cur, *ev_fd_tmp;
 377
 378	if (fence)
 379		dma_fence_get(fence);
 380
 381	spin_lock(&syncobj->lock);
 382
 383	old_fence = rcu_dereference_protected(syncobj->fence,
 384					      lockdep_is_held(&syncobj->lock));
 385	rcu_assign_pointer(syncobj->fence, fence);
 386
 387	if (fence != old_fence) {
 388		list_for_each_entry_safe(wait_cur, wait_tmp, &syncobj->cb_list, node)
 389			syncobj_wait_syncobj_func(syncobj, wait_cur);
 390		list_for_each_entry_safe(ev_fd_cur, ev_fd_tmp, &syncobj->ev_fd_list, node)
 391			syncobj_eventfd_entry_func(syncobj, ev_fd_cur);
 392	}
 393
 394	spin_unlock(&syncobj->lock);
 395
 396	dma_fence_put(old_fence);
 397}
 398EXPORT_SYMBOL(drm_syncobj_replace_fence);
 399
 400/**
 401 * drm_syncobj_assign_null_handle - assign a stub fence to the sync object
 402 * @syncobj: sync object to assign the fence on
 403 *
 404 * Assign a already signaled stub fence to the sync object.
 405 */
 406static int drm_syncobj_assign_null_handle(struct drm_syncobj *syncobj)
 407{
 408	struct dma_fence *fence = dma_fence_allocate_private_stub(ktime_get());
 409
 410	if (!fence)
 411		return -ENOMEM;
 412
 413	drm_syncobj_replace_fence(syncobj, fence);
 414	dma_fence_put(fence);
 415	return 0;
 416}
 417
 418/* 5s default for wait submission */
 419#define DRM_SYNCOBJ_WAIT_FOR_SUBMIT_TIMEOUT 5000000000ULL
 420/**
 421 * drm_syncobj_find_fence - lookup and reference the fence in a sync object
 422 * @file_private: drm file private pointer
 423 * @handle: sync object handle to lookup.
 424 * @point: timeline point
 425 * @flags: DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT or not
 426 * @fence: out parameter for the fence
 427 *
 428 * This is just a convenience function that combines drm_syncobj_find() and
 429 * drm_syncobj_fence_get().
 430 *
 431 * Returns 0 on success or a negative error value on failure. On success @fence
 432 * contains a reference to the fence, which must be released by calling
 433 * dma_fence_put().
 434 */
 435int drm_syncobj_find_fence(struct drm_file *file_private,
 436			   u32 handle, u64 point, u64 flags,
 437			   struct dma_fence **fence)
 438{
 439	struct drm_syncobj *syncobj = drm_syncobj_find(file_private, handle);
 440	struct syncobj_wait_entry wait;
 441	u64 timeout = nsecs_to_jiffies64(DRM_SYNCOBJ_WAIT_FOR_SUBMIT_TIMEOUT);
 442	int ret;
 443
 444	if (flags & ~DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT)
 445		return -EINVAL;
 446
 447	if (!syncobj)
 448		return -ENOENT;
 449
 450	/* Waiting for userspace with locks help is illegal cause that can
 451	 * trivial deadlock with page faults for example. Make lockdep complain
 452	 * about it early on.
 453	 */
 454	if (flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT) {
 455		might_sleep();
 456		lockdep_assert_none_held_once();
 457	}
 458
 459	*fence = drm_syncobj_fence_get(syncobj);
 460
 461	if (*fence) {
 462		ret = dma_fence_chain_find_seqno(fence, point);
 463		if (!ret) {
 464			/* If the requested seqno is already signaled
 465			 * drm_syncobj_find_fence may return a NULL
 466			 * fence. To make sure the recipient gets
 467			 * signalled, use a new fence instead.
 468			 */
 469			if (!*fence)
 470				*fence = dma_fence_get_stub();
 471
 472			goto out;
 473		}
 474		dma_fence_put(*fence);
 475	} else {
 476		ret = -EINVAL;
 477	}
 478
 479	if (!(flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT))
 480		goto out;
 481
 482	memset(&wait, 0, sizeof(wait));
 483	wait.task = current;
 484	wait.point = point;
 485	drm_syncobj_fence_add_wait(syncobj, &wait);
 486
 487	do {
 488		set_current_state(TASK_INTERRUPTIBLE);
 489		if (wait.fence) {
 490			ret = 0;
 491			break;
 492		}
 493                if (timeout == 0) {
 494                        ret = -ETIME;
 495                        break;
 496                }
 497
 498		if (signal_pending(current)) {
 499			ret = -ERESTARTSYS;
 500			break;
 501		}
 502
 503                timeout = schedule_timeout(timeout);
 504	} while (1);
 505
 506	__set_current_state(TASK_RUNNING);
 507	*fence = wait.fence;
 508
 509	if (wait.node.next)
 510		drm_syncobj_remove_wait(syncobj, &wait);
 511
 512out:
 513	drm_syncobj_put(syncobj);
 514
 515	return ret;
 516}
 517EXPORT_SYMBOL(drm_syncobj_find_fence);
 518
 519/**
 520 * drm_syncobj_free - free a sync object.
 521 * @kref: kref to free.
 522 *
 523 * Only to be called from kref_put in drm_syncobj_put.
 524 */
 525void drm_syncobj_free(struct kref *kref)
 526{
 527	struct drm_syncobj *syncobj = container_of(kref,
 528						   struct drm_syncobj,
 529						   refcount);
 530	struct syncobj_eventfd_entry *ev_fd_cur, *ev_fd_tmp;
 531
 532	drm_syncobj_replace_fence(syncobj, NULL);
 533
 534	list_for_each_entry_safe(ev_fd_cur, ev_fd_tmp, &syncobj->ev_fd_list, node)
 535		syncobj_eventfd_entry_free(ev_fd_cur);
 536
 537	kfree(syncobj);
 538}
 539EXPORT_SYMBOL(drm_syncobj_free);
 540
 541/**
 542 * drm_syncobj_create - create a new syncobj
 543 * @out_syncobj: returned syncobj
 544 * @flags: DRM_SYNCOBJ_* flags
 545 * @fence: if non-NULL, the syncobj will represent this fence
 546 *
 547 * This is the first function to create a sync object. After creating, drivers
 548 * probably want to make it available to userspace, either through
 549 * drm_syncobj_get_handle() or drm_syncobj_get_fd().
 550 *
 551 * Returns 0 on success or a negative error value on failure.
 552 */
 553int drm_syncobj_create(struct drm_syncobj **out_syncobj, uint32_t flags,
 554		       struct dma_fence *fence)
 555{
 556	int ret;
 557	struct drm_syncobj *syncobj;
 558
 559	syncobj = kzalloc(sizeof(struct drm_syncobj), GFP_KERNEL);
 560	if (!syncobj)
 561		return -ENOMEM;
 562
 563	kref_init(&syncobj->refcount);
 564	INIT_LIST_HEAD(&syncobj->cb_list);
 565	INIT_LIST_HEAD(&syncobj->ev_fd_list);
 566	spin_lock_init(&syncobj->lock);
 567
 568	if (flags & DRM_SYNCOBJ_CREATE_SIGNALED) {
 569		ret = drm_syncobj_assign_null_handle(syncobj);
 570		if (ret < 0) {
 571			drm_syncobj_put(syncobj);
 572			return ret;
 573		}
 574	}
 575
 576	if (fence)
 577		drm_syncobj_replace_fence(syncobj, fence);
 578
 579	*out_syncobj = syncobj;
 580	return 0;
 581}
 582EXPORT_SYMBOL(drm_syncobj_create);
 583
 584/**
 585 * drm_syncobj_get_handle - get a handle from a syncobj
 586 * @file_private: drm file private pointer
 587 * @syncobj: Sync object to export
 588 * @handle: out parameter with the new handle
 589 *
 590 * Exports a sync object created with drm_syncobj_create() as a handle on
 591 * @file_private to userspace.
 592 *
 593 * Returns 0 on success or a negative error value on failure.
 594 */
 595int drm_syncobj_get_handle(struct drm_file *file_private,
 596			   struct drm_syncobj *syncobj, u32 *handle)
 597{
 598	int ret;
 599
 600	/* take a reference to put in the idr */
 601	drm_syncobj_get(syncobj);
 602
 603	idr_preload(GFP_KERNEL);
 604	spin_lock(&file_private->syncobj_table_lock);
 605	ret = idr_alloc(&file_private->syncobj_idr, syncobj, 1, 0, GFP_NOWAIT);
 606	spin_unlock(&file_private->syncobj_table_lock);
 607
 608	idr_preload_end();
 609
 610	if (ret < 0) {
 611		drm_syncobj_put(syncobj);
 612		return ret;
 613	}
 614
 615	*handle = ret;
 616	return 0;
 617}
 618EXPORT_SYMBOL(drm_syncobj_get_handle);
 619
 620static int drm_syncobj_create_as_handle(struct drm_file *file_private,
 621					u32 *handle, uint32_t flags)
 622{
 623	int ret;
 624	struct drm_syncobj *syncobj;
 625
 626	ret = drm_syncobj_create(&syncobj, flags, NULL);
 627	if (ret)
 628		return ret;
 629
 630	ret = drm_syncobj_get_handle(file_private, syncobj, handle);
 631	drm_syncobj_put(syncobj);
 632	return ret;
 633}
 634
 635static int drm_syncobj_destroy(struct drm_file *file_private,
 636			       u32 handle)
 637{
 638	struct drm_syncobj *syncobj;
 639
 640	spin_lock(&file_private->syncobj_table_lock);
 641	syncobj = idr_remove(&file_private->syncobj_idr, handle);
 642	spin_unlock(&file_private->syncobj_table_lock);
 643
 644	if (!syncobj)
 645		return -EINVAL;
 646
 647	drm_syncobj_put(syncobj);
 648	return 0;
 649}
 650
 651static int drm_syncobj_file_release(struct inode *inode, struct file *file)
 652{
 653	struct drm_syncobj *syncobj = file->private_data;
 654
 655	drm_syncobj_put(syncobj);
 656	return 0;
 657}
 658
 659static const struct file_operations drm_syncobj_file_fops = {
 660	.release = drm_syncobj_file_release,
 661};
 662
 663/**
 664 * drm_syncobj_get_fd - get a file descriptor from a syncobj
 665 * @syncobj: Sync object to export
 666 * @p_fd: out parameter with the new file descriptor
 667 *
 668 * Exports a sync object created with drm_syncobj_create() as a file descriptor.
 669 *
 670 * Returns 0 on success or a negative error value on failure.
 671 */
 672int drm_syncobj_get_fd(struct drm_syncobj *syncobj, int *p_fd)
 673{
 674	struct file *file;
 675	int fd;
 676
 677	fd = get_unused_fd_flags(O_CLOEXEC);
 678	if (fd < 0)
 679		return fd;
 680
 681	file = anon_inode_getfile("syncobj_file",
 682				  &drm_syncobj_file_fops,
 683				  syncobj, 0);
 684	if (IS_ERR(file)) {
 685		put_unused_fd(fd);
 686		return PTR_ERR(file);
 687	}
 688
 689	drm_syncobj_get(syncobj);
 690	fd_install(fd, file);
 691
 692	*p_fd = fd;
 693	return 0;
 694}
 695EXPORT_SYMBOL(drm_syncobj_get_fd);
 696
 697static int drm_syncobj_handle_to_fd(struct drm_file *file_private,
 698				    u32 handle, int *p_fd)
 699{
 700	struct drm_syncobj *syncobj = drm_syncobj_find(file_private, handle);
 701	int ret;
 702
 703	if (!syncobj)
 704		return -EINVAL;
 705
 706	ret = drm_syncobj_get_fd(syncobj, p_fd);
 707	drm_syncobj_put(syncobj);
 708	return ret;
 709}
 710
 711static int drm_syncobj_fd_to_handle(struct drm_file *file_private,
 712				    int fd, u32 *handle)
 713{
 714	struct drm_syncobj *syncobj;
 715	CLASS(fd, f)(fd);
 716	int ret;
 717
 718	if (fd_empty(f))
 719		return -EINVAL;
 720
 721	if (fd_file(f)->f_op != &drm_syncobj_file_fops)
 
 722		return -EINVAL;
 
 723
 724	/* take a reference to put in the idr */
 725	syncobj = fd_file(f)->private_data;
 726	drm_syncobj_get(syncobj);
 727
 728	idr_preload(GFP_KERNEL);
 729	spin_lock(&file_private->syncobj_table_lock);
 730	ret = idr_alloc(&file_private->syncobj_idr, syncobj, 1, 0, GFP_NOWAIT);
 731	spin_unlock(&file_private->syncobj_table_lock);
 732	idr_preload_end();
 733
 734	if (ret > 0) {
 735		*handle = ret;
 736		ret = 0;
 737	} else
 738		drm_syncobj_put(syncobj);
 739
 
 740	return ret;
 741}
 742
 743static int drm_syncobj_import_sync_file_fence(struct drm_file *file_private,
 744					      int fd, int handle)
 745{
 746	struct dma_fence *fence = sync_file_get_fence(fd);
 747	struct drm_syncobj *syncobj;
 748
 749	if (!fence)
 750		return -EINVAL;
 751
 752	syncobj = drm_syncobj_find(file_private, handle);
 753	if (!syncobj) {
 754		dma_fence_put(fence);
 755		return -ENOENT;
 756	}
 757
 758	drm_syncobj_replace_fence(syncobj, fence);
 759	dma_fence_put(fence);
 760	drm_syncobj_put(syncobj);
 761	return 0;
 762}
 763
 764static int drm_syncobj_export_sync_file(struct drm_file *file_private,
 765					int handle, int *p_fd)
 766{
 767	int ret;
 768	struct dma_fence *fence;
 769	struct sync_file *sync_file;
 770	int fd = get_unused_fd_flags(O_CLOEXEC);
 771
 772	if (fd < 0)
 773		return fd;
 774
 775	ret = drm_syncobj_find_fence(file_private, handle, 0, 0, &fence);
 776	if (ret)
 777		goto err_put_fd;
 778
 779	sync_file = sync_file_create(fence);
 780
 781	dma_fence_put(fence);
 782
 783	if (!sync_file) {
 784		ret = -EINVAL;
 785		goto err_put_fd;
 786	}
 787
 788	fd_install(fd, sync_file->file);
 789
 790	*p_fd = fd;
 791	return 0;
 792err_put_fd:
 793	put_unused_fd(fd);
 794	return ret;
 795}
 796/**
 797 * drm_syncobj_open - initializes syncobj file-private structures at devnode open time
 798 * @file_private: drm file-private structure to set up
 799 *
 800 * Called at device open time, sets up the structure for handling refcounting
 801 * of sync objects.
 802 */
 803void
 804drm_syncobj_open(struct drm_file *file_private)
 805{
 806	idr_init_base(&file_private->syncobj_idr, 1);
 807	spin_lock_init(&file_private->syncobj_table_lock);
 808}
 809
 810static int
 811drm_syncobj_release_handle(int id, void *ptr, void *data)
 812{
 813	struct drm_syncobj *syncobj = ptr;
 814
 815	drm_syncobj_put(syncobj);
 816	return 0;
 817}
 818
 819/**
 820 * drm_syncobj_release - release file-private sync object resources
 821 * @file_private: drm file-private structure to clean up
 822 *
 823 * Called at close time when the filp is going away.
 824 *
 825 * Releases any remaining references on objects by this filp.
 826 */
 827void
 828drm_syncobj_release(struct drm_file *file_private)
 829{
 830	idr_for_each(&file_private->syncobj_idr,
 831		     &drm_syncobj_release_handle, file_private);
 832	idr_destroy(&file_private->syncobj_idr);
 833}
 834
 835int
 836drm_syncobj_create_ioctl(struct drm_device *dev, void *data,
 837			 struct drm_file *file_private)
 838{
 839	struct drm_syncobj_create *args = data;
 840
 841	if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
 842		return -EOPNOTSUPP;
 843
 844	/* no valid flags yet */
 845	if (args->flags & ~DRM_SYNCOBJ_CREATE_SIGNALED)
 846		return -EINVAL;
 847
 848	return drm_syncobj_create_as_handle(file_private,
 849					    &args->handle, args->flags);
 850}
 851
 852int
 853drm_syncobj_destroy_ioctl(struct drm_device *dev, void *data,
 854			  struct drm_file *file_private)
 855{
 856	struct drm_syncobj_destroy *args = data;
 857
 858	if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
 859		return -EOPNOTSUPP;
 860
 861	/* make sure padding is empty */
 862	if (args->pad)
 863		return -EINVAL;
 864	return drm_syncobj_destroy(file_private, args->handle);
 865}
 866
 867int
 868drm_syncobj_handle_to_fd_ioctl(struct drm_device *dev, void *data,
 869				   struct drm_file *file_private)
 870{
 871	struct drm_syncobj_handle *args = data;
 872
 873	if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
 874		return -EOPNOTSUPP;
 875
 876	if (args->pad)
 877		return -EINVAL;
 878
 879	if (args->flags != 0 &&
 880	    args->flags != DRM_SYNCOBJ_HANDLE_TO_FD_FLAGS_EXPORT_SYNC_FILE)
 881		return -EINVAL;
 882
 883	if (args->flags & DRM_SYNCOBJ_HANDLE_TO_FD_FLAGS_EXPORT_SYNC_FILE)
 884		return drm_syncobj_export_sync_file(file_private, args->handle,
 885						    &args->fd);
 886
 887	return drm_syncobj_handle_to_fd(file_private, args->handle,
 888					&args->fd);
 889}
 890
 891int
 892drm_syncobj_fd_to_handle_ioctl(struct drm_device *dev, void *data,
 893				   struct drm_file *file_private)
 894{
 895	struct drm_syncobj_handle *args = data;
 896
 897	if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
 898		return -EOPNOTSUPP;
 899
 900	if (args->pad)
 901		return -EINVAL;
 902
 903	if (args->flags != 0 &&
 904	    args->flags != DRM_SYNCOBJ_FD_TO_HANDLE_FLAGS_IMPORT_SYNC_FILE)
 905		return -EINVAL;
 906
 907	if (args->flags & DRM_SYNCOBJ_FD_TO_HANDLE_FLAGS_IMPORT_SYNC_FILE)
 908		return drm_syncobj_import_sync_file_fence(file_private,
 909							  args->fd,
 910							  args->handle);
 911
 912	return drm_syncobj_fd_to_handle(file_private, args->fd,
 913					&args->handle);
 914}
 915
 916static int drm_syncobj_transfer_to_timeline(struct drm_file *file_private,
 917					    struct drm_syncobj_transfer *args)
 918{
 919	struct drm_syncobj *timeline_syncobj = NULL;
 920	struct dma_fence *fence, *tmp;
 921	struct dma_fence_chain *chain;
 922	int ret;
 923
 924	timeline_syncobj = drm_syncobj_find(file_private, args->dst_handle);
 925	if (!timeline_syncobj) {
 926		return -ENOENT;
 927	}
 928	ret = drm_syncobj_find_fence(file_private, args->src_handle,
 929				     args->src_point, args->flags,
 930				     &tmp);
 931	if (ret)
 932		goto err_put_timeline;
 933
 934	fence = dma_fence_unwrap_merge(tmp);
 935	dma_fence_put(tmp);
 936	if (!fence) {
 937		ret = -ENOMEM;
 938		goto err_put_timeline;
 939	}
 940
 941	chain = dma_fence_chain_alloc();
 942	if (!chain) {
 943		ret = -ENOMEM;
 944		goto err_free_fence;
 945	}
 946
 947	drm_syncobj_add_point(timeline_syncobj, chain, fence, args->dst_point);
 948err_free_fence:
 949	dma_fence_put(fence);
 950err_put_timeline:
 951	drm_syncobj_put(timeline_syncobj);
 952
 953	return ret;
 954}
 955
 956static int
 957drm_syncobj_transfer_to_binary(struct drm_file *file_private,
 958			       struct drm_syncobj_transfer *args)
 959{
 960	struct drm_syncobj *binary_syncobj = NULL;
 961	struct dma_fence *fence;
 962	int ret;
 963
 964	binary_syncobj = drm_syncobj_find(file_private, args->dst_handle);
 965	if (!binary_syncobj)
 966		return -ENOENT;
 967	ret = drm_syncobj_find_fence(file_private, args->src_handle,
 968				     args->src_point, args->flags, &fence);
 969	if (ret)
 970		goto err;
 971	drm_syncobj_replace_fence(binary_syncobj, fence);
 972	dma_fence_put(fence);
 973err:
 974	drm_syncobj_put(binary_syncobj);
 975
 976	return ret;
 977}
 978int
 979drm_syncobj_transfer_ioctl(struct drm_device *dev, void *data,
 980			   struct drm_file *file_private)
 981{
 982	struct drm_syncobj_transfer *args = data;
 983	int ret;
 984
 985	if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ_TIMELINE))
 986		return -EOPNOTSUPP;
 987
 988	if (args->pad)
 989		return -EINVAL;
 990
 991	if (args->dst_point)
 992		ret = drm_syncobj_transfer_to_timeline(file_private, args);
 993	else
 994		ret = drm_syncobj_transfer_to_binary(file_private, args);
 995
 996	return ret;
 997}
 998
 999static void syncobj_wait_fence_func(struct dma_fence *fence,
1000				    struct dma_fence_cb *cb)
1001{
1002	struct syncobj_wait_entry *wait =
1003		container_of(cb, struct syncobj_wait_entry, fence_cb);
1004
1005	wake_up_process(wait->task);
1006}
1007
1008static void syncobj_wait_syncobj_func(struct drm_syncobj *syncobj,
1009				      struct syncobj_wait_entry *wait)
1010{
1011	struct dma_fence *fence;
1012
1013	/* This happens inside the syncobj lock */
1014	fence = rcu_dereference_protected(syncobj->fence,
1015					  lockdep_is_held(&syncobj->lock));
1016	dma_fence_get(fence);
1017	if (!fence || dma_fence_chain_find_seqno(&fence, wait->point)) {
1018		dma_fence_put(fence);
1019		return;
1020	} else if (!fence) {
1021		wait->fence = dma_fence_get_stub();
1022	} else {
1023		wait->fence = fence;
1024	}
1025
1026	wake_up_process(wait->task);
1027	list_del_init(&wait->node);
1028}
1029
1030static signed long drm_syncobj_array_wait_timeout(struct drm_syncobj **syncobjs,
1031						  void __user *user_points,
1032						  uint32_t count,
1033						  uint32_t flags,
1034						  signed long timeout,
1035						  uint32_t *idx,
1036						  ktime_t *deadline)
1037{
1038	struct syncobj_wait_entry *entries;
1039	struct dma_fence *fence;
1040	uint64_t *points;
1041	uint32_t signaled_count, i;
1042
1043	if (flags & (DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT |
1044		     DRM_SYNCOBJ_WAIT_FLAGS_WAIT_AVAILABLE)) {
1045		might_sleep();
1046		lockdep_assert_none_held_once();
1047	}
1048
1049	points = kmalloc_array(count, sizeof(*points), GFP_KERNEL);
1050	if (points == NULL)
1051		return -ENOMEM;
1052
1053	if (!user_points) {
1054		memset(points, 0, count * sizeof(uint64_t));
1055
1056	} else if (copy_from_user(points, user_points,
1057				  sizeof(uint64_t) * count)) {
1058		timeout = -EFAULT;
1059		goto err_free_points;
1060	}
1061
1062	entries = kcalloc(count, sizeof(*entries), GFP_KERNEL);
1063	if (!entries) {
1064		timeout = -ENOMEM;
1065		goto err_free_points;
1066	}
1067	/* Walk the list of sync objects and initialize entries.  We do
1068	 * this up-front so that we can properly return -EINVAL if there is
1069	 * a syncobj with a missing fence and then never have the chance of
1070	 * returning -EINVAL again.
1071	 */
1072	signaled_count = 0;
1073	for (i = 0; i < count; ++i) {
1074		struct dma_fence *fence;
1075
1076		entries[i].task = current;
1077		entries[i].point = points[i];
1078		fence = drm_syncobj_fence_get(syncobjs[i]);
1079		if (!fence || dma_fence_chain_find_seqno(&fence, points[i])) {
1080			dma_fence_put(fence);
1081			if (flags & (DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT |
1082				     DRM_SYNCOBJ_WAIT_FLAGS_WAIT_AVAILABLE)) {
1083				continue;
1084			} else {
1085				timeout = -EINVAL;
1086				goto cleanup_entries;
1087			}
1088		}
1089
1090		if (fence)
1091			entries[i].fence = fence;
1092		else
1093			entries[i].fence = dma_fence_get_stub();
1094
1095		if ((flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_AVAILABLE) ||
1096		    dma_fence_is_signaled(entries[i].fence)) {
1097			if (signaled_count == 0 && idx)
1098				*idx = i;
1099			signaled_count++;
1100		}
1101	}
1102
1103	if (signaled_count == count ||
1104	    (signaled_count > 0 &&
1105	     !(flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_ALL)))
1106		goto cleanup_entries;
1107
1108	/* There's a very annoying laxness in the dma_fence API here, in
1109	 * that backends are not required to automatically report when a
1110	 * fence is signaled prior to fence->ops->enable_signaling() being
1111	 * called.  So here if we fail to match signaled_count, we need to
1112	 * fallthough and try a 0 timeout wait!
1113	 */
1114
1115	if (flags & (DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT |
1116		     DRM_SYNCOBJ_WAIT_FLAGS_WAIT_AVAILABLE)) {
1117		for (i = 0; i < count; ++i)
1118			drm_syncobj_fence_add_wait(syncobjs[i], &entries[i]);
1119	}
1120
1121	if (deadline) {
1122		for (i = 0; i < count; ++i) {
1123			fence = entries[i].fence;
1124			if (!fence)
1125				continue;
1126			dma_fence_set_deadline(fence, *deadline);
1127		}
1128	}
1129
1130	do {
1131		set_current_state(TASK_INTERRUPTIBLE);
1132
1133		signaled_count = 0;
1134		for (i = 0; i < count; ++i) {
1135			fence = entries[i].fence;
1136			if (!fence)
1137				continue;
1138
1139			if ((flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_AVAILABLE) ||
1140			    dma_fence_is_signaled(fence) ||
1141			    (!entries[i].fence_cb.func &&
1142			     dma_fence_add_callback(fence,
1143						    &entries[i].fence_cb,
1144						    syncobj_wait_fence_func))) {
1145				/* The fence has been signaled */
1146				if (flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_ALL) {
1147					signaled_count++;
1148				} else {
1149					if (idx)
1150						*idx = i;
1151					goto done_waiting;
1152				}
1153			}
1154		}
1155
1156		if (signaled_count == count)
1157			goto done_waiting;
1158
1159		if (timeout == 0) {
1160			timeout = -ETIME;
1161			goto done_waiting;
1162		}
1163
1164		if (signal_pending(current)) {
1165			timeout = -ERESTARTSYS;
1166			goto done_waiting;
1167		}
1168
1169		timeout = schedule_timeout(timeout);
1170	} while (1);
1171
1172done_waiting:
1173	__set_current_state(TASK_RUNNING);
1174
1175cleanup_entries:
1176	for (i = 0; i < count; ++i) {
1177		drm_syncobj_remove_wait(syncobjs[i], &entries[i]);
1178		if (entries[i].fence_cb.func)
1179			dma_fence_remove_callback(entries[i].fence,
1180						  &entries[i].fence_cb);
1181		dma_fence_put(entries[i].fence);
1182	}
1183	kfree(entries);
1184
1185err_free_points:
1186	kfree(points);
1187
1188	return timeout;
1189}
1190
1191/**
1192 * drm_timeout_abs_to_jiffies - calculate jiffies timeout from absolute value
1193 *
1194 * @timeout_nsec: timeout nsec component in ns, 0 for poll
1195 *
1196 * Calculate the timeout in jiffies from an absolute time in sec/nsec.
1197 */
1198signed long drm_timeout_abs_to_jiffies(int64_t timeout_nsec)
1199{
1200	ktime_t abs_timeout, now;
1201	u64 timeout_ns, timeout_jiffies64;
1202
1203	/* make 0 timeout means poll - absolute 0 doesn't seem valid */
1204	if (timeout_nsec == 0)
1205		return 0;
1206
1207	abs_timeout = ns_to_ktime(timeout_nsec);
1208	now = ktime_get();
1209
1210	if (!ktime_after(abs_timeout, now))
1211		return 0;
1212
1213	timeout_ns = ktime_to_ns(ktime_sub(abs_timeout, now));
1214
1215	timeout_jiffies64 = nsecs_to_jiffies64(timeout_ns);
1216	/*  clamp timeout to avoid infinite timeout */
1217	if (timeout_jiffies64 >= MAX_SCHEDULE_TIMEOUT - 1)
1218		return MAX_SCHEDULE_TIMEOUT - 1;
1219
1220	return timeout_jiffies64 + 1;
1221}
1222EXPORT_SYMBOL(drm_timeout_abs_to_jiffies);
1223
1224static int drm_syncobj_array_wait(struct drm_device *dev,
1225				  struct drm_file *file_private,
1226				  struct drm_syncobj_wait *wait,
1227				  struct drm_syncobj_timeline_wait *timeline_wait,
1228				  struct drm_syncobj **syncobjs, bool timeline,
1229				  ktime_t *deadline)
1230{
1231	signed long timeout = 0;
1232	uint32_t first = ~0;
1233
1234	if (!timeline) {
1235		timeout = drm_timeout_abs_to_jiffies(wait->timeout_nsec);
1236		timeout = drm_syncobj_array_wait_timeout(syncobjs,
1237							 NULL,
1238							 wait->count_handles,
1239							 wait->flags,
1240							 timeout, &first,
1241							 deadline);
1242		if (timeout < 0)
1243			return timeout;
1244		wait->first_signaled = first;
1245	} else {
1246		timeout = drm_timeout_abs_to_jiffies(timeline_wait->timeout_nsec);
1247		timeout = drm_syncobj_array_wait_timeout(syncobjs,
1248							 u64_to_user_ptr(timeline_wait->points),
1249							 timeline_wait->count_handles,
1250							 timeline_wait->flags,
1251							 timeout, &first,
1252							 deadline);
1253		if (timeout < 0)
1254			return timeout;
1255		timeline_wait->first_signaled = first;
1256	}
1257	return 0;
1258}
1259
1260static int drm_syncobj_array_find(struct drm_file *file_private,
1261				  void __user *user_handles,
1262				  uint32_t count_handles,
1263				  struct drm_syncobj ***syncobjs_out)
1264{
1265	uint32_t i, *handles;
1266	struct drm_syncobj **syncobjs;
1267	int ret;
1268
1269	handles = kmalloc_array(count_handles, sizeof(*handles), GFP_KERNEL);
1270	if (handles == NULL)
1271		return -ENOMEM;
1272
1273	if (copy_from_user(handles, user_handles,
1274			   sizeof(uint32_t) * count_handles)) {
1275		ret = -EFAULT;
1276		goto err_free_handles;
1277	}
1278
1279	syncobjs = kmalloc_array(count_handles, sizeof(*syncobjs), GFP_KERNEL);
1280	if (syncobjs == NULL) {
1281		ret = -ENOMEM;
1282		goto err_free_handles;
1283	}
1284
1285	for (i = 0; i < count_handles; i++) {
1286		syncobjs[i] = drm_syncobj_find(file_private, handles[i]);
1287		if (!syncobjs[i]) {
1288			ret = -ENOENT;
1289			goto err_put_syncobjs;
1290		}
1291	}
1292
1293	kfree(handles);
1294	*syncobjs_out = syncobjs;
1295	return 0;
1296
1297err_put_syncobjs:
1298	while (i-- > 0)
1299		drm_syncobj_put(syncobjs[i]);
1300	kfree(syncobjs);
1301err_free_handles:
1302	kfree(handles);
1303
1304	return ret;
1305}
1306
1307static void drm_syncobj_array_free(struct drm_syncobj **syncobjs,
1308				   uint32_t count)
1309{
1310	uint32_t i;
1311
1312	for (i = 0; i < count; i++)
1313		drm_syncobj_put(syncobjs[i]);
1314	kfree(syncobjs);
1315}
1316
1317int
1318drm_syncobj_wait_ioctl(struct drm_device *dev, void *data,
1319		       struct drm_file *file_private)
1320{
1321	struct drm_syncobj_wait *args = data;
1322	struct drm_syncobj **syncobjs;
1323	unsigned int possible_flags;
1324	ktime_t t, *tp = NULL;
1325	int ret = 0;
1326
1327	if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
1328		return -EOPNOTSUPP;
1329
1330	possible_flags = DRM_SYNCOBJ_WAIT_FLAGS_WAIT_ALL |
1331			 DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT |
1332			 DRM_SYNCOBJ_WAIT_FLAGS_WAIT_DEADLINE;
1333
1334	if (args->flags & ~possible_flags)
1335		return -EINVAL;
1336
1337	if (args->count_handles == 0)
1338		return 0;
1339
1340	ret = drm_syncobj_array_find(file_private,
1341				     u64_to_user_ptr(args->handles),
1342				     args->count_handles,
1343				     &syncobjs);
1344	if (ret < 0)
1345		return ret;
1346
1347	if (args->flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_DEADLINE) {
1348		t = ns_to_ktime(args->deadline_nsec);
1349		tp = &t;
1350	}
1351
1352	ret = drm_syncobj_array_wait(dev, file_private,
1353				     args, NULL, syncobjs, false, tp);
1354
1355	drm_syncobj_array_free(syncobjs, args->count_handles);
1356
1357	return ret;
1358}
1359
1360int
1361drm_syncobj_timeline_wait_ioctl(struct drm_device *dev, void *data,
1362				struct drm_file *file_private)
1363{
1364	struct drm_syncobj_timeline_wait *args = data;
1365	struct drm_syncobj **syncobjs;
1366	unsigned int possible_flags;
1367	ktime_t t, *tp = NULL;
1368	int ret = 0;
1369
1370	if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ_TIMELINE))
1371		return -EOPNOTSUPP;
1372
1373	possible_flags = DRM_SYNCOBJ_WAIT_FLAGS_WAIT_ALL |
1374			 DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT |
1375			 DRM_SYNCOBJ_WAIT_FLAGS_WAIT_AVAILABLE |
1376			 DRM_SYNCOBJ_WAIT_FLAGS_WAIT_DEADLINE;
1377
1378	if (args->flags & ~possible_flags)
1379		return -EINVAL;
1380
1381	if (args->count_handles == 0)
1382		return 0;
1383
1384	ret = drm_syncobj_array_find(file_private,
1385				     u64_to_user_ptr(args->handles),
1386				     args->count_handles,
1387				     &syncobjs);
1388	if (ret < 0)
1389		return ret;
1390
1391	if (args->flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_DEADLINE) {
1392		t = ns_to_ktime(args->deadline_nsec);
1393		tp = &t;
1394	}
1395
1396	ret = drm_syncobj_array_wait(dev, file_private,
1397				     NULL, args, syncobjs, true, tp);
1398
1399	drm_syncobj_array_free(syncobjs, args->count_handles);
1400
1401	return ret;
1402}
1403
1404static void syncobj_eventfd_entry_fence_func(struct dma_fence *fence,
1405					     struct dma_fence_cb *cb)
1406{
1407	struct syncobj_eventfd_entry *entry =
1408		container_of(cb, struct syncobj_eventfd_entry, fence_cb);
1409
1410	eventfd_signal(entry->ev_fd_ctx);
1411	syncobj_eventfd_entry_free(entry);
1412}
1413
1414static void
1415syncobj_eventfd_entry_func(struct drm_syncobj *syncobj,
1416			   struct syncobj_eventfd_entry *entry)
1417{
1418	int ret;
1419	struct dma_fence *fence;
1420
1421	/* This happens inside the syncobj lock */
1422	fence = dma_fence_get(rcu_dereference_protected(syncobj->fence, 1));
1423	if (!fence)
1424		return;
1425
1426	ret = dma_fence_chain_find_seqno(&fence, entry->point);
1427	if (ret != 0) {
1428		/* The given seqno has not been submitted yet. */
1429		dma_fence_put(fence);
1430		return;
1431	} else if (!fence) {
1432		/* If dma_fence_chain_find_seqno returns 0 but sets the fence
1433		 * to NULL, it implies that the given seqno is signaled and a
1434		 * later seqno has already been submitted. Assign a stub fence
1435		 * so that the eventfd still gets signaled below.
1436		 */
1437		fence = dma_fence_get_stub();
1438	}
1439
1440	list_del_init(&entry->node);
1441	entry->fence = fence;
1442
1443	if (entry->flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_AVAILABLE) {
1444		eventfd_signal(entry->ev_fd_ctx);
1445		syncobj_eventfd_entry_free(entry);
1446	} else {
1447		ret = dma_fence_add_callback(fence, &entry->fence_cb,
1448					     syncobj_eventfd_entry_fence_func);
1449		if (ret == -ENOENT) {
1450			eventfd_signal(entry->ev_fd_ctx);
1451			syncobj_eventfd_entry_free(entry);
1452		}
1453	}
1454}
1455
1456int
1457drm_syncobj_eventfd_ioctl(struct drm_device *dev, void *data,
1458			  struct drm_file *file_private)
1459{
1460	struct drm_syncobj_eventfd *args = data;
1461	struct drm_syncobj *syncobj;
1462	struct eventfd_ctx *ev_fd_ctx;
1463	struct syncobj_eventfd_entry *entry;
1464	int ret;
1465
1466	if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ_TIMELINE))
1467		return -EOPNOTSUPP;
1468
1469	if (args->flags & ~DRM_SYNCOBJ_WAIT_FLAGS_WAIT_AVAILABLE)
1470		return -EINVAL;
1471
1472	if (args->pad)
1473		return -EINVAL;
1474
1475	syncobj = drm_syncobj_find(file_private, args->handle);
1476	if (!syncobj)
1477		return -ENOENT;
1478
1479	ev_fd_ctx = eventfd_ctx_fdget(args->fd);
1480	if (IS_ERR(ev_fd_ctx)) {
1481		ret = PTR_ERR(ev_fd_ctx);
1482		goto err_fdget;
1483	}
1484
1485	entry = kzalloc(sizeof(*entry), GFP_KERNEL);
1486	if (!entry) {
1487		ret = -ENOMEM;
1488		goto err_kzalloc;
1489	}
1490	entry->syncobj = syncobj;
1491	entry->ev_fd_ctx = ev_fd_ctx;
1492	entry->point = args->point;
1493	entry->flags = args->flags;
1494
1495	drm_syncobj_add_eventfd(syncobj, entry);
1496	drm_syncobj_put(syncobj);
1497
1498	return 0;
1499
1500err_kzalloc:
1501	eventfd_ctx_put(ev_fd_ctx);
1502err_fdget:
1503	drm_syncobj_put(syncobj);
1504	return ret;
1505}
1506
1507int
1508drm_syncobj_reset_ioctl(struct drm_device *dev, void *data,
1509			struct drm_file *file_private)
1510{
1511	struct drm_syncobj_array *args = data;
1512	struct drm_syncobj **syncobjs;
1513	uint32_t i;
1514	int ret;
1515
1516	if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
1517		return -EOPNOTSUPP;
1518
1519	if (args->pad != 0)
1520		return -EINVAL;
1521
1522	if (args->count_handles == 0)
1523		return -EINVAL;
1524
1525	ret = drm_syncobj_array_find(file_private,
1526				     u64_to_user_ptr(args->handles),
1527				     args->count_handles,
1528				     &syncobjs);
1529	if (ret < 0)
1530		return ret;
1531
1532	for (i = 0; i < args->count_handles; i++)
1533		drm_syncobj_replace_fence(syncobjs[i], NULL);
1534
1535	drm_syncobj_array_free(syncobjs, args->count_handles);
1536
1537	return 0;
1538}
1539
1540int
1541drm_syncobj_signal_ioctl(struct drm_device *dev, void *data,
1542			 struct drm_file *file_private)
1543{
1544	struct drm_syncobj_array *args = data;
1545	struct drm_syncobj **syncobjs;
1546	uint32_t i;
1547	int ret;
1548
1549	if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
1550		return -EOPNOTSUPP;
1551
1552	if (args->pad != 0)
1553		return -EINVAL;
1554
1555	if (args->count_handles == 0)
1556		return -EINVAL;
1557
1558	ret = drm_syncobj_array_find(file_private,
1559				     u64_to_user_ptr(args->handles),
1560				     args->count_handles,
1561				     &syncobjs);
1562	if (ret < 0)
1563		return ret;
1564
1565	for (i = 0; i < args->count_handles; i++) {
1566		ret = drm_syncobj_assign_null_handle(syncobjs[i]);
1567		if (ret < 0)
1568			break;
1569	}
1570
1571	drm_syncobj_array_free(syncobjs, args->count_handles);
1572
1573	return ret;
1574}
1575
1576int
1577drm_syncobj_timeline_signal_ioctl(struct drm_device *dev, void *data,
1578				  struct drm_file *file_private)
1579{
1580	struct drm_syncobj_timeline_array *args = data;
1581	struct drm_syncobj **syncobjs;
1582	struct dma_fence_chain **chains;
1583	uint64_t *points;
1584	uint32_t i, j;
1585	int ret;
1586
1587	if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ_TIMELINE))
1588		return -EOPNOTSUPP;
1589
1590	if (args->flags != 0)
1591		return -EINVAL;
1592
1593	if (args->count_handles == 0)
1594		return -EINVAL;
1595
1596	ret = drm_syncobj_array_find(file_private,
1597				     u64_to_user_ptr(args->handles),
1598				     args->count_handles,
1599				     &syncobjs);
1600	if (ret < 0)
1601		return ret;
1602
1603	points = kmalloc_array(args->count_handles, sizeof(*points),
1604			       GFP_KERNEL);
1605	if (!points) {
1606		ret = -ENOMEM;
1607		goto out;
1608	}
1609	if (!u64_to_user_ptr(args->points)) {
1610		memset(points, 0, args->count_handles * sizeof(uint64_t));
1611	} else if (copy_from_user(points, u64_to_user_ptr(args->points),
1612				  sizeof(uint64_t) * args->count_handles)) {
1613		ret = -EFAULT;
1614		goto err_points;
1615	}
1616
1617	chains = kmalloc_array(args->count_handles, sizeof(void *), GFP_KERNEL);
1618	if (!chains) {
1619		ret = -ENOMEM;
1620		goto err_points;
1621	}
1622	for (i = 0; i < args->count_handles; i++) {
1623		chains[i] = dma_fence_chain_alloc();
1624		if (!chains[i]) {
1625			for (j = 0; j < i; j++)
1626				dma_fence_chain_free(chains[j]);
1627			ret = -ENOMEM;
1628			goto err_chains;
1629		}
1630	}
1631
1632	for (i = 0; i < args->count_handles; i++) {
1633		struct dma_fence *fence = dma_fence_get_stub();
1634
1635		drm_syncobj_add_point(syncobjs[i], chains[i],
1636				      fence, points[i]);
1637		dma_fence_put(fence);
1638	}
1639err_chains:
1640	kfree(chains);
1641err_points:
1642	kfree(points);
1643out:
1644	drm_syncobj_array_free(syncobjs, args->count_handles);
1645
1646	return ret;
1647}
1648
1649int drm_syncobj_query_ioctl(struct drm_device *dev, void *data,
1650			    struct drm_file *file_private)
1651{
1652	struct drm_syncobj_timeline_array *args = data;
1653	struct drm_syncobj **syncobjs;
1654	uint64_t __user *points = u64_to_user_ptr(args->points);
1655	uint32_t i;
1656	int ret;
1657
1658	if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ_TIMELINE))
1659		return -EOPNOTSUPP;
1660
1661	if (args->flags & ~DRM_SYNCOBJ_QUERY_FLAGS_LAST_SUBMITTED)
1662		return -EINVAL;
1663
1664	if (args->count_handles == 0)
1665		return -EINVAL;
1666
1667	ret = drm_syncobj_array_find(file_private,
1668				     u64_to_user_ptr(args->handles),
1669				     args->count_handles,
1670				     &syncobjs);
1671	if (ret < 0)
1672		return ret;
1673
1674	for (i = 0; i < args->count_handles; i++) {
1675		struct dma_fence_chain *chain;
1676		struct dma_fence *fence;
1677		uint64_t point;
1678
1679		fence = drm_syncobj_fence_get(syncobjs[i]);
1680		chain = to_dma_fence_chain(fence);
1681		if (chain) {
1682			struct dma_fence *iter, *last_signaled =
1683				dma_fence_get(fence);
1684
1685			if (args->flags &
1686			    DRM_SYNCOBJ_QUERY_FLAGS_LAST_SUBMITTED) {
1687				point = fence->seqno;
1688			} else {
1689				dma_fence_chain_for_each(iter, fence) {
1690					if (iter->context != fence->context) {
1691						dma_fence_put(iter);
1692						/* It is most likely that timeline has
1693						* unorder points. */
1694						break;
1695					}
1696					dma_fence_put(last_signaled);
1697					last_signaled = dma_fence_get(iter);
1698				}
1699				point = dma_fence_is_signaled(last_signaled) ?
1700					last_signaled->seqno :
1701					to_dma_fence_chain(last_signaled)->prev_seqno;
1702			}
1703			dma_fence_put(last_signaled);
1704		} else {
1705			point = 0;
1706		}
1707		dma_fence_put(fence);
1708		ret = copy_to_user(&points[i], &point, sizeof(uint64_t));
1709		ret = ret ? -EFAULT : 0;
1710		if (ret)
1711			break;
1712	}
1713	drm_syncobj_array_free(syncobjs, args->count_handles);
1714
1715	return ret;
1716}
v5.14.15
   1/*
   2 * Copyright 2017 Red Hat
   3 * Parts ported from amdgpu (fence wait code).
   4 * Copyright 2016 Advanced Micro Devices, Inc.
   5 *
   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:
  12 *
  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
  15 * Software.
  16 *
  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
  23 * IN THE SOFTWARE.
  24 *
  25 * Authors:
  26 *
  27 */
  28
  29/**
  30 * DOC: Overview
  31 *
  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:
  38 *
  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
  45 *
  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:
  49 *
  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
  53 *
  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.
  60 *
  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.
  72 *
  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 :
  76 *
  77 *    - The syncobj's current fence if the syncobj is considered as a binary
  78 *      primitive.
  79 *    - The struct &dma_fence associated with a given point if the syncobj is
  80 *      considered as a timeline primitive.
  81 *
  82 * If the syncobj's fence is NULL or not present in the syncobj's timeline,
  83 * the enqueue operation is expected to fail.
  84 *
  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.
  92 *
  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
  96 * timeline.
  97 *
  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).
 105 *
 106 *
 107 * Host-side wait on syncobjs
 108 * --------------------------
 109 *
 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.
 116 *
 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.
 128 *
 
 
 
 
 
 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.
 132 *
 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.
 138 *
 
 
 
 
 139 *
 140 * Import/export of syncobjs
 141 * -------------------------
 142 *
 143 * &DRM_IOCTL_SYNCOBJ_FD_TO_HANDLE and &DRM_IOCTL_SYNCOBJ_HANDLE_TO_FD
 144 * provide two mechanisms for import/export of syncobjs.
 145 *
 146 * The first lets the client import or export an entire syncobj to a file
 147 * descriptor.
 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.
 159 *
 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
 171 * syncobj.
 172 *
 173 *
 174 * Import/export of timeline points in timeline syncobjs
 175 * -----------------------------------------------------
 176 *
 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.
 180 *
 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.
 184 */
 185
 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>
 192
 193#include <drm/drm.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>
 200
 201#include "drm_internal.h"
 202
 203struct 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;
 208	u64    point;
 209};
 210
 211static void syncobj_wait_syncobj_func(struct drm_syncobj *syncobj,
 212				      struct syncobj_wait_entry *wait);
 213
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 214/**
 215 * drm_syncobj_find - lookup and reference a sync object.
 216 * @file_private: drm file private pointer
 217 * @handle: sync object handle to lookup.
 218 *
 219 * Returns a reference to the syncobj pointed to by handle or NULL. The
 220 * reference must be released by calling drm_syncobj_put().
 221 */
 222struct drm_syncobj *drm_syncobj_find(struct drm_file *file_private,
 223				     u32 handle)
 224{
 225	struct drm_syncobj *syncobj;
 226
 227	spin_lock(&file_private->syncobj_table_lock);
 228
 229	/* Check if we currently have a reference on the object */
 230	syncobj = idr_find(&file_private->syncobj_idr, handle);
 231	if (syncobj)
 232		drm_syncobj_get(syncobj);
 233
 234	spin_unlock(&file_private->syncobj_table_lock);
 235
 236	return syncobj;
 237}
 238EXPORT_SYMBOL(drm_syncobj_find);
 239
 240static void drm_syncobj_fence_add_wait(struct drm_syncobj *syncobj,
 241				       struct syncobj_wait_entry *wait)
 242{
 243	struct dma_fence *fence;
 244
 245	if (wait->fence)
 246		return;
 247
 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.
 252	 */
 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);
 257	} else if (!fence) {
 258		wait->fence = dma_fence_get_stub();
 259	} else {
 260		wait->fence = fence;
 261	}
 262	spin_unlock(&syncobj->lock);
 263}
 264
 265static void drm_syncobj_remove_wait(struct drm_syncobj *syncobj,
 266				    struct syncobj_wait_entry *wait)
 267{
 268	if (!wait->node.next)
 269		return;
 270
 271	spin_lock(&syncobj->lock);
 272	list_del_init(&wait->node);
 273	spin_unlock(&syncobj->lock);
 274}
 275
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 276/**
 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
 282 *
 283 * Add the chain node as new timeline point to the syncobj.
 284 */
 285void drm_syncobj_add_point(struct drm_syncobj *syncobj,
 286			   struct dma_fence_chain *chain,
 287			   struct dma_fence *fence,
 288			   uint64_t point)
 289{
 290	struct syncobj_wait_entry *cur, *tmp;
 
 291	struct dma_fence *prev;
 292
 293	dma_fence_get(fence);
 294
 295	spin_lock(&syncobj->lock);
 296
 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);
 303
 304	list_for_each_entry_safe(cur, tmp, &syncobj->cb_list, node)
 305		syncobj_wait_syncobj_func(syncobj, cur);
 
 
 306	spin_unlock(&syncobj->lock);
 307
 308	/* Walk the chain once to trigger garbage collection */
 309	dma_fence_chain_for_each(fence, prev);
 310	dma_fence_put(prev);
 311}
 312EXPORT_SYMBOL(drm_syncobj_add_point);
 313
 314/**
 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.
 318 *
 319 * This replaces the fence on a sync object.
 320 */
 321void drm_syncobj_replace_fence(struct drm_syncobj *syncobj,
 322			       struct dma_fence *fence)
 323{
 324	struct dma_fence *old_fence;
 325	struct syncobj_wait_entry *cur, *tmp;
 
 326
 327	if (fence)
 328		dma_fence_get(fence);
 329
 330	spin_lock(&syncobj->lock);
 331
 332	old_fence = rcu_dereference_protected(syncobj->fence,
 333					      lockdep_is_held(&syncobj->lock));
 334	rcu_assign_pointer(syncobj->fence, fence);
 335
 336	if (fence != old_fence) {
 337		list_for_each_entry_safe(cur, tmp, &syncobj->cb_list, node)
 338			syncobj_wait_syncobj_func(syncobj, cur);
 
 
 339	}
 340
 341	spin_unlock(&syncobj->lock);
 342
 343	dma_fence_put(old_fence);
 344}
 345EXPORT_SYMBOL(drm_syncobj_replace_fence);
 346
 347/**
 348 * drm_syncobj_assign_null_handle - assign a stub fence to the sync object
 349 * @syncobj: sync object to assign the fence on
 350 *
 351 * Assign a already signaled stub fence to the sync object.
 352 */
 353static int drm_syncobj_assign_null_handle(struct drm_syncobj *syncobj)
 354{
 355	struct dma_fence *fence = dma_fence_allocate_private_stub();
 356
 357	if (IS_ERR(fence))
 358		return PTR_ERR(fence);
 359
 360	drm_syncobj_replace_fence(syncobj, fence);
 361	dma_fence_put(fence);
 362	return 0;
 363}
 364
 365/* 5s default for wait submission */
 366#define DRM_SYNCOBJ_WAIT_FOR_SUBMIT_TIMEOUT 5000000000ULL
 367/**
 368 * drm_syncobj_find_fence - lookup and reference the fence in a sync object
 369 * @file_private: drm file private pointer
 370 * @handle: sync object handle to lookup.
 371 * @point: timeline point
 372 * @flags: DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT or not
 373 * @fence: out parameter for the fence
 374 *
 375 * This is just a convenience function that combines drm_syncobj_find() and
 376 * drm_syncobj_fence_get().
 377 *
 378 * Returns 0 on success or a negative error value on failure. On success @fence
 379 * contains a reference to the fence, which must be released by calling
 380 * dma_fence_put().
 381 */
 382int drm_syncobj_find_fence(struct drm_file *file_private,
 383			   u32 handle, u64 point, u64 flags,
 384			   struct dma_fence **fence)
 385{
 386	struct drm_syncobj *syncobj = drm_syncobj_find(file_private, handle);
 387	struct syncobj_wait_entry wait;
 388	u64 timeout = nsecs_to_jiffies64(DRM_SYNCOBJ_WAIT_FOR_SUBMIT_TIMEOUT);
 389	int ret;
 390
 
 
 
 391	if (!syncobj)
 392		return -ENOENT;
 393
 394	/* Waiting for userspace with locks help is illegal cause that can
 395	 * trivial deadlock with page faults for example. Make lockdep complain
 396	 * about it early on.
 397	 */
 398	if (flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT) {
 399		might_sleep();
 400		lockdep_assert_none_held_once();
 401	}
 402
 403	*fence = drm_syncobj_fence_get(syncobj);
 404
 405	if (*fence) {
 406		ret = dma_fence_chain_find_seqno(fence, point);
 407		if (!ret)
 
 
 
 
 
 
 
 
 408			goto out;
 
 409		dma_fence_put(*fence);
 410	} else {
 411		ret = -EINVAL;
 412	}
 413
 414	if (!(flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT))
 415		goto out;
 416
 417	memset(&wait, 0, sizeof(wait));
 418	wait.task = current;
 419	wait.point = point;
 420	drm_syncobj_fence_add_wait(syncobj, &wait);
 421
 422	do {
 423		set_current_state(TASK_INTERRUPTIBLE);
 424		if (wait.fence) {
 425			ret = 0;
 426			break;
 427		}
 428                if (timeout == 0) {
 429                        ret = -ETIME;
 430                        break;
 431                }
 432
 433		if (signal_pending(current)) {
 434			ret = -ERESTARTSYS;
 435			break;
 436		}
 437
 438                timeout = schedule_timeout(timeout);
 439	} while (1);
 440
 441	__set_current_state(TASK_RUNNING);
 442	*fence = wait.fence;
 443
 444	if (wait.node.next)
 445		drm_syncobj_remove_wait(syncobj, &wait);
 446
 447out:
 448	drm_syncobj_put(syncobj);
 449
 450	return ret;
 451}
 452EXPORT_SYMBOL(drm_syncobj_find_fence);
 453
 454/**
 455 * drm_syncobj_free - free a sync object.
 456 * @kref: kref to free.
 457 *
 458 * Only to be called from kref_put in drm_syncobj_put.
 459 */
 460void drm_syncobj_free(struct kref *kref)
 461{
 462	struct drm_syncobj *syncobj = container_of(kref,
 463						   struct drm_syncobj,
 464						   refcount);
 
 
 465	drm_syncobj_replace_fence(syncobj, NULL);
 
 
 
 
 466	kfree(syncobj);
 467}
 468EXPORT_SYMBOL(drm_syncobj_free);
 469
 470/**
 471 * drm_syncobj_create - create a new syncobj
 472 * @out_syncobj: returned syncobj
 473 * @flags: DRM_SYNCOBJ_* flags
 474 * @fence: if non-NULL, the syncobj will represent this fence
 475 *
 476 * This is the first function to create a sync object. After creating, drivers
 477 * probably want to make it available to userspace, either through
 478 * drm_syncobj_get_handle() or drm_syncobj_get_fd().
 479 *
 480 * Returns 0 on success or a negative error value on failure.
 481 */
 482int drm_syncobj_create(struct drm_syncobj **out_syncobj, uint32_t flags,
 483		       struct dma_fence *fence)
 484{
 485	int ret;
 486	struct drm_syncobj *syncobj;
 487
 488	syncobj = kzalloc(sizeof(struct drm_syncobj), GFP_KERNEL);
 489	if (!syncobj)
 490		return -ENOMEM;
 491
 492	kref_init(&syncobj->refcount);
 493	INIT_LIST_HEAD(&syncobj->cb_list);
 
 494	spin_lock_init(&syncobj->lock);
 495
 496	if (flags & DRM_SYNCOBJ_CREATE_SIGNALED) {
 497		ret = drm_syncobj_assign_null_handle(syncobj);
 498		if (ret < 0) {
 499			drm_syncobj_put(syncobj);
 500			return ret;
 501		}
 502	}
 503
 504	if (fence)
 505		drm_syncobj_replace_fence(syncobj, fence);
 506
 507	*out_syncobj = syncobj;
 508	return 0;
 509}
 510EXPORT_SYMBOL(drm_syncobj_create);
 511
 512/**
 513 * drm_syncobj_get_handle - get a handle from a syncobj
 514 * @file_private: drm file private pointer
 515 * @syncobj: Sync object to export
 516 * @handle: out parameter with the new handle
 517 *
 518 * Exports a sync object created with drm_syncobj_create() as a handle on
 519 * @file_private to userspace.
 520 *
 521 * Returns 0 on success or a negative error value on failure.
 522 */
 523int drm_syncobj_get_handle(struct drm_file *file_private,
 524			   struct drm_syncobj *syncobj, u32 *handle)
 525{
 526	int ret;
 527
 528	/* take a reference to put in the idr */
 529	drm_syncobj_get(syncobj);
 530
 531	idr_preload(GFP_KERNEL);
 532	spin_lock(&file_private->syncobj_table_lock);
 533	ret = idr_alloc(&file_private->syncobj_idr, syncobj, 1, 0, GFP_NOWAIT);
 534	spin_unlock(&file_private->syncobj_table_lock);
 535
 536	idr_preload_end();
 537
 538	if (ret < 0) {
 539		drm_syncobj_put(syncobj);
 540		return ret;
 541	}
 542
 543	*handle = ret;
 544	return 0;
 545}
 546EXPORT_SYMBOL(drm_syncobj_get_handle);
 547
 548static int drm_syncobj_create_as_handle(struct drm_file *file_private,
 549					u32 *handle, uint32_t flags)
 550{
 551	int ret;
 552	struct drm_syncobj *syncobj;
 553
 554	ret = drm_syncobj_create(&syncobj, flags, NULL);
 555	if (ret)
 556		return ret;
 557
 558	ret = drm_syncobj_get_handle(file_private, syncobj, handle);
 559	drm_syncobj_put(syncobj);
 560	return ret;
 561}
 562
 563static int drm_syncobj_destroy(struct drm_file *file_private,
 564			       u32 handle)
 565{
 566	struct drm_syncobj *syncobj;
 567
 568	spin_lock(&file_private->syncobj_table_lock);
 569	syncobj = idr_remove(&file_private->syncobj_idr, handle);
 570	spin_unlock(&file_private->syncobj_table_lock);
 571
 572	if (!syncobj)
 573		return -EINVAL;
 574
 575	drm_syncobj_put(syncobj);
 576	return 0;
 577}
 578
 579static int drm_syncobj_file_release(struct inode *inode, struct file *file)
 580{
 581	struct drm_syncobj *syncobj = file->private_data;
 582
 583	drm_syncobj_put(syncobj);
 584	return 0;
 585}
 586
 587static const struct file_operations drm_syncobj_file_fops = {
 588	.release = drm_syncobj_file_release,
 589};
 590
 591/**
 592 * drm_syncobj_get_fd - get a file descriptor from a syncobj
 593 * @syncobj: Sync object to export
 594 * @p_fd: out parameter with the new file descriptor
 595 *
 596 * Exports a sync object created with drm_syncobj_create() as a file descriptor.
 597 *
 598 * Returns 0 on success or a negative error value on failure.
 599 */
 600int drm_syncobj_get_fd(struct drm_syncobj *syncobj, int *p_fd)
 601{
 602	struct file *file;
 603	int fd;
 604
 605	fd = get_unused_fd_flags(O_CLOEXEC);
 606	if (fd < 0)
 607		return fd;
 608
 609	file = anon_inode_getfile("syncobj_file",
 610				  &drm_syncobj_file_fops,
 611				  syncobj, 0);
 612	if (IS_ERR(file)) {
 613		put_unused_fd(fd);
 614		return PTR_ERR(file);
 615	}
 616
 617	drm_syncobj_get(syncobj);
 618	fd_install(fd, file);
 619
 620	*p_fd = fd;
 621	return 0;
 622}
 623EXPORT_SYMBOL(drm_syncobj_get_fd);
 624
 625static int drm_syncobj_handle_to_fd(struct drm_file *file_private,
 626				    u32 handle, int *p_fd)
 627{
 628	struct drm_syncobj *syncobj = drm_syncobj_find(file_private, handle);
 629	int ret;
 630
 631	if (!syncobj)
 632		return -EINVAL;
 633
 634	ret = drm_syncobj_get_fd(syncobj, p_fd);
 635	drm_syncobj_put(syncobj);
 636	return ret;
 637}
 638
 639static int drm_syncobj_fd_to_handle(struct drm_file *file_private,
 640				    int fd, u32 *handle)
 641{
 642	struct drm_syncobj *syncobj;
 643	struct fd f = fdget(fd);
 644	int ret;
 645
 646	if (!f.file)
 647		return -EINVAL;
 648
 649	if (f.file->f_op != &drm_syncobj_file_fops) {
 650		fdput(f);
 651		return -EINVAL;
 652	}
 653
 654	/* take a reference to put in the idr */
 655	syncobj = f.file->private_data;
 656	drm_syncobj_get(syncobj);
 657
 658	idr_preload(GFP_KERNEL);
 659	spin_lock(&file_private->syncobj_table_lock);
 660	ret = idr_alloc(&file_private->syncobj_idr, syncobj, 1, 0, GFP_NOWAIT);
 661	spin_unlock(&file_private->syncobj_table_lock);
 662	idr_preload_end();
 663
 664	if (ret > 0) {
 665		*handle = ret;
 666		ret = 0;
 667	} else
 668		drm_syncobj_put(syncobj);
 669
 670	fdput(f);
 671	return ret;
 672}
 673
 674static int drm_syncobj_import_sync_file_fence(struct drm_file *file_private,
 675					      int fd, int handle)
 676{
 677	struct dma_fence *fence = sync_file_get_fence(fd);
 678	struct drm_syncobj *syncobj;
 679
 680	if (!fence)
 681		return -EINVAL;
 682
 683	syncobj = drm_syncobj_find(file_private, handle);
 684	if (!syncobj) {
 685		dma_fence_put(fence);
 686		return -ENOENT;
 687	}
 688
 689	drm_syncobj_replace_fence(syncobj, fence);
 690	dma_fence_put(fence);
 691	drm_syncobj_put(syncobj);
 692	return 0;
 693}
 694
 695static int drm_syncobj_export_sync_file(struct drm_file *file_private,
 696					int handle, int *p_fd)
 697{
 698	int ret;
 699	struct dma_fence *fence;
 700	struct sync_file *sync_file;
 701	int fd = get_unused_fd_flags(O_CLOEXEC);
 702
 703	if (fd < 0)
 704		return fd;
 705
 706	ret = drm_syncobj_find_fence(file_private, handle, 0, 0, &fence);
 707	if (ret)
 708		goto err_put_fd;
 709
 710	sync_file = sync_file_create(fence);
 711
 712	dma_fence_put(fence);
 713
 714	if (!sync_file) {
 715		ret = -EINVAL;
 716		goto err_put_fd;
 717	}
 718
 719	fd_install(fd, sync_file->file);
 720
 721	*p_fd = fd;
 722	return 0;
 723err_put_fd:
 724	put_unused_fd(fd);
 725	return ret;
 726}
 727/**
 728 * drm_syncobj_open - initalizes syncobj file-private structures at devnode open time
 729 * @file_private: drm file-private structure to set up
 730 *
 731 * Called at device open time, sets up the structure for handling refcounting
 732 * of sync objects.
 733 */
 734void
 735drm_syncobj_open(struct drm_file *file_private)
 736{
 737	idr_init_base(&file_private->syncobj_idr, 1);
 738	spin_lock_init(&file_private->syncobj_table_lock);
 739}
 740
 741static int
 742drm_syncobj_release_handle(int id, void *ptr, void *data)
 743{
 744	struct drm_syncobj *syncobj = ptr;
 745
 746	drm_syncobj_put(syncobj);
 747	return 0;
 748}
 749
 750/**
 751 * drm_syncobj_release - release file-private sync object resources
 752 * @file_private: drm file-private structure to clean up
 753 *
 754 * Called at close time when the filp is going away.
 755 *
 756 * Releases any remaining references on objects by this filp.
 757 */
 758void
 759drm_syncobj_release(struct drm_file *file_private)
 760{
 761	idr_for_each(&file_private->syncobj_idr,
 762		     &drm_syncobj_release_handle, file_private);
 763	idr_destroy(&file_private->syncobj_idr);
 764}
 765
 766int
 767drm_syncobj_create_ioctl(struct drm_device *dev, void *data,
 768			 struct drm_file *file_private)
 769{
 770	struct drm_syncobj_create *args = data;
 771
 772	if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
 773		return -EOPNOTSUPP;
 774
 775	/* no valid flags yet */
 776	if (args->flags & ~DRM_SYNCOBJ_CREATE_SIGNALED)
 777		return -EINVAL;
 778
 779	return drm_syncobj_create_as_handle(file_private,
 780					    &args->handle, args->flags);
 781}
 782
 783int
 784drm_syncobj_destroy_ioctl(struct drm_device *dev, void *data,
 785			  struct drm_file *file_private)
 786{
 787	struct drm_syncobj_destroy *args = data;
 788
 789	if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
 790		return -EOPNOTSUPP;
 791
 792	/* make sure padding is empty */
 793	if (args->pad)
 794		return -EINVAL;
 795	return drm_syncobj_destroy(file_private, args->handle);
 796}
 797
 798int
 799drm_syncobj_handle_to_fd_ioctl(struct drm_device *dev, void *data,
 800				   struct drm_file *file_private)
 801{
 802	struct drm_syncobj_handle *args = data;
 803
 804	if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
 805		return -EOPNOTSUPP;
 806
 807	if (args->pad)
 808		return -EINVAL;
 809
 810	if (args->flags != 0 &&
 811	    args->flags != DRM_SYNCOBJ_HANDLE_TO_FD_FLAGS_EXPORT_SYNC_FILE)
 812		return -EINVAL;
 813
 814	if (args->flags & DRM_SYNCOBJ_HANDLE_TO_FD_FLAGS_EXPORT_SYNC_FILE)
 815		return drm_syncobj_export_sync_file(file_private, args->handle,
 816						    &args->fd);
 817
 818	return drm_syncobj_handle_to_fd(file_private, args->handle,
 819					&args->fd);
 820}
 821
 822int
 823drm_syncobj_fd_to_handle_ioctl(struct drm_device *dev, void *data,
 824				   struct drm_file *file_private)
 825{
 826	struct drm_syncobj_handle *args = data;
 827
 828	if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
 829		return -EOPNOTSUPP;
 830
 831	if (args->pad)
 832		return -EINVAL;
 833
 834	if (args->flags != 0 &&
 835	    args->flags != DRM_SYNCOBJ_FD_TO_HANDLE_FLAGS_IMPORT_SYNC_FILE)
 836		return -EINVAL;
 837
 838	if (args->flags & DRM_SYNCOBJ_FD_TO_HANDLE_FLAGS_IMPORT_SYNC_FILE)
 839		return drm_syncobj_import_sync_file_fence(file_private,
 840							  args->fd,
 841							  args->handle);
 842
 843	return drm_syncobj_fd_to_handle(file_private, args->fd,
 844					&args->handle);
 845}
 846
 847static int drm_syncobj_transfer_to_timeline(struct drm_file *file_private,
 848					    struct drm_syncobj_transfer *args)
 849{
 850	struct drm_syncobj *timeline_syncobj = NULL;
 851	struct dma_fence *fence;
 852	struct dma_fence_chain *chain;
 853	int ret;
 854
 855	timeline_syncobj = drm_syncobj_find(file_private, args->dst_handle);
 856	if (!timeline_syncobj) {
 857		return -ENOENT;
 858	}
 859	ret = drm_syncobj_find_fence(file_private, args->src_handle,
 860				     args->src_point, args->flags,
 861				     &fence);
 862	if (ret)
 863		goto err;
 864	chain = kzalloc(sizeof(struct dma_fence_chain), GFP_KERNEL);
 
 
 
 
 
 
 
 
 865	if (!chain) {
 866		ret = -ENOMEM;
 867		goto err1;
 868	}
 
 869	drm_syncobj_add_point(timeline_syncobj, chain, fence, args->dst_point);
 870err1:
 871	dma_fence_put(fence);
 872err:
 873	drm_syncobj_put(timeline_syncobj);
 874
 875	return ret;
 876}
 877
 878static int
 879drm_syncobj_transfer_to_binary(struct drm_file *file_private,
 880			       struct drm_syncobj_transfer *args)
 881{
 882	struct drm_syncobj *binary_syncobj = NULL;
 883	struct dma_fence *fence;
 884	int ret;
 885
 886	binary_syncobj = drm_syncobj_find(file_private, args->dst_handle);
 887	if (!binary_syncobj)
 888		return -ENOENT;
 889	ret = drm_syncobj_find_fence(file_private, args->src_handle,
 890				     args->src_point, args->flags, &fence);
 891	if (ret)
 892		goto err;
 893	drm_syncobj_replace_fence(binary_syncobj, fence);
 894	dma_fence_put(fence);
 895err:
 896	drm_syncobj_put(binary_syncobj);
 897
 898	return ret;
 899}
 900int
 901drm_syncobj_transfer_ioctl(struct drm_device *dev, void *data,
 902			   struct drm_file *file_private)
 903{
 904	struct drm_syncobj_transfer *args = data;
 905	int ret;
 906
 907	if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ_TIMELINE))
 908		return -EOPNOTSUPP;
 909
 910	if (args->pad)
 911		return -EINVAL;
 912
 913	if (args->dst_point)
 914		ret = drm_syncobj_transfer_to_timeline(file_private, args);
 915	else
 916		ret = drm_syncobj_transfer_to_binary(file_private, args);
 917
 918	return ret;
 919}
 920
 921static void syncobj_wait_fence_func(struct dma_fence *fence,
 922				    struct dma_fence_cb *cb)
 923{
 924	struct syncobj_wait_entry *wait =
 925		container_of(cb, struct syncobj_wait_entry, fence_cb);
 926
 927	wake_up_process(wait->task);
 928}
 929
 930static void syncobj_wait_syncobj_func(struct drm_syncobj *syncobj,
 931				      struct syncobj_wait_entry *wait)
 932{
 933	struct dma_fence *fence;
 934
 935	/* This happens inside the syncobj lock */
 936	fence = rcu_dereference_protected(syncobj->fence,
 937					  lockdep_is_held(&syncobj->lock));
 938	dma_fence_get(fence);
 939	if (!fence || dma_fence_chain_find_seqno(&fence, wait->point)) {
 940		dma_fence_put(fence);
 941		return;
 942	} else if (!fence) {
 943		wait->fence = dma_fence_get_stub();
 944	} else {
 945		wait->fence = fence;
 946	}
 947
 948	wake_up_process(wait->task);
 949	list_del_init(&wait->node);
 950}
 951
 952static signed long drm_syncobj_array_wait_timeout(struct drm_syncobj **syncobjs,
 953						  void __user *user_points,
 954						  uint32_t count,
 955						  uint32_t flags,
 956						  signed long timeout,
 957						  uint32_t *idx)
 
 958{
 959	struct syncobj_wait_entry *entries;
 960	struct dma_fence *fence;
 961	uint64_t *points;
 962	uint32_t signaled_count, i;
 963
 964	if (flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT)
 
 
 965		lockdep_assert_none_held_once();
 
 966
 967	points = kmalloc_array(count, sizeof(*points), GFP_KERNEL);
 968	if (points == NULL)
 969		return -ENOMEM;
 970
 971	if (!user_points) {
 972		memset(points, 0, count * sizeof(uint64_t));
 973
 974	} else if (copy_from_user(points, user_points,
 975				  sizeof(uint64_t) * count)) {
 976		timeout = -EFAULT;
 977		goto err_free_points;
 978	}
 979
 980	entries = kcalloc(count, sizeof(*entries), GFP_KERNEL);
 981	if (!entries) {
 982		timeout = -ENOMEM;
 983		goto err_free_points;
 984	}
 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.
 989	 */
 990	signaled_count = 0;
 991	for (i = 0; i < count; ++i) {
 992		struct dma_fence *fence;
 993
 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				continue;
1001			} else {
1002				timeout = -EINVAL;
1003				goto cleanup_entries;
1004			}
1005		}
1006
1007		if (fence)
1008			entries[i].fence = fence;
1009		else
1010			entries[i].fence = dma_fence_get_stub();
1011
1012		if ((flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_AVAILABLE) ||
1013		    dma_fence_is_signaled(entries[i].fence)) {
1014			if (signaled_count == 0 && idx)
1015				*idx = i;
1016			signaled_count++;
1017		}
1018	}
1019
1020	if (signaled_count == count ||
1021	    (signaled_count > 0 &&
1022	     !(flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_ALL)))
1023		goto cleanup_entries;
1024
1025	/* There's a very annoying laxness in the dma_fence API here, in
1026	 * that backends are not required to automatically report when a
1027	 * fence is signaled prior to fence->ops->enable_signaling() being
1028	 * called.  So here if we fail to match signaled_count, we need to
1029	 * fallthough and try a 0 timeout wait!
1030	 */
1031
1032	if (flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT) {
 
1033		for (i = 0; i < count; ++i)
1034			drm_syncobj_fence_add_wait(syncobjs[i], &entries[i]);
1035	}
1036
 
 
 
 
 
 
 
 
 
1037	do {
1038		set_current_state(TASK_INTERRUPTIBLE);
1039
1040		signaled_count = 0;
1041		for (i = 0; i < count; ++i) {
1042			fence = entries[i].fence;
1043			if (!fence)
1044				continue;
1045
1046			if ((flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_AVAILABLE) ||
1047			    dma_fence_is_signaled(fence) ||
1048			    (!entries[i].fence_cb.func &&
1049			     dma_fence_add_callback(fence,
1050						    &entries[i].fence_cb,
1051						    syncobj_wait_fence_func))) {
1052				/* The fence has been signaled */
1053				if (flags & DRM_SYNCOBJ_WAIT_FLAGS_WAIT_ALL) {
1054					signaled_count++;
1055				} else {
1056					if (idx)
1057						*idx = i;
1058					goto done_waiting;
1059				}
1060			}
1061		}
1062
1063		if (signaled_count == count)
1064			goto done_waiting;
1065
1066		if (timeout == 0) {
1067			timeout = -ETIME;
1068			goto done_waiting;
1069		}
1070
1071		if (signal_pending(current)) {
1072			timeout = -ERESTARTSYS;
1073			goto done_waiting;
1074		}
1075
1076		timeout = schedule_timeout(timeout);
1077	} while (1);
1078
1079done_waiting:
1080	__set_current_state(TASK_RUNNING);
1081
1082cleanup_entries:
1083	for (i = 0; i < count; ++i) {
1084		drm_syncobj_remove_wait(syncobjs[i], &entries[i]);
1085		if (entries[i].fence_cb.func)
1086			dma_fence_remove_callback(entries[i].fence,
1087						  &entries[i].fence_cb);
1088		dma_fence_put(entries[i].fence);
1089	}
1090	kfree(entries);
1091
1092err_free_points:
1093	kfree(points);
1094
1095	return timeout;
1096}
1097
1098/**
1099 * drm_timeout_abs_to_jiffies - calculate jiffies timeout from absolute value
1100 *
1101 * @timeout_nsec: timeout nsec component in ns, 0 for poll
1102 *
1103 * Calculate the timeout in jiffies from an absolute time in sec/nsec.
1104 */
1105signed long drm_timeout_abs_to_jiffies(int64_t timeout_nsec)
1106{
1107	ktime_t abs_timeout, now;
1108	u64 timeout_ns, timeout_jiffies64;
1109
1110	/* make 0 timeout means poll - absolute 0 doesn't seem valid */
1111	if (timeout_nsec == 0)
1112		return 0;
1113
1114	abs_timeout = ns_to_ktime(timeout_nsec);
1115	now = ktime_get();
1116
1117	if (!ktime_after(abs_timeout, now))
1118		return 0;
1119
1120	timeout_ns = ktime_to_ns(ktime_sub(abs_timeout, now));
1121
1122	timeout_jiffies64 = nsecs_to_jiffies64(timeout_ns);
1123	/*  clamp timeout to avoid infinite timeout */
1124	if (timeout_jiffies64 >= MAX_SCHEDULE_TIMEOUT - 1)
1125		return MAX_SCHEDULE_TIMEOUT - 1;
1126
1127	return timeout_jiffies64 + 1;
1128}
1129EXPORT_SYMBOL(drm_timeout_abs_to_jiffies);
1130
1131static int drm_syncobj_array_wait(struct drm_device *dev,
1132				  struct drm_file *file_private,
1133				  struct drm_syncobj_wait *wait,
1134				  struct drm_syncobj_timeline_wait *timeline_wait,
1135				  struct drm_syncobj **syncobjs, bool timeline)
 
1136{
1137	signed long timeout = 0;
1138	uint32_t first = ~0;
1139
1140	if (!timeline) {
1141		timeout = drm_timeout_abs_to_jiffies(wait->timeout_nsec);
1142		timeout = drm_syncobj_array_wait_timeout(syncobjs,
1143							 NULL,
1144							 wait->count_handles,
1145							 wait->flags,
1146							 timeout, &first);
 
1147		if (timeout < 0)
1148			return timeout;
1149		wait->first_signaled = first;
1150	} else {
1151		timeout = drm_timeout_abs_to_jiffies(timeline_wait->timeout_nsec);
1152		timeout = drm_syncobj_array_wait_timeout(syncobjs,
1153							 u64_to_user_ptr(timeline_wait->points),
1154							 timeline_wait->count_handles,
1155							 timeline_wait->flags,
1156							 timeout, &first);
 
1157		if (timeout < 0)
1158			return timeout;
1159		timeline_wait->first_signaled = first;
1160	}
1161	return 0;
1162}
1163
1164static int drm_syncobj_array_find(struct drm_file *file_private,
1165				  void __user *user_handles,
1166				  uint32_t count_handles,
1167				  struct drm_syncobj ***syncobjs_out)
1168{
1169	uint32_t i, *handles;
1170	struct drm_syncobj **syncobjs;
1171	int ret;
1172
1173	handles = kmalloc_array(count_handles, sizeof(*handles), GFP_KERNEL);
1174	if (handles == NULL)
1175		return -ENOMEM;
1176
1177	if (copy_from_user(handles, user_handles,
1178			   sizeof(uint32_t) * count_handles)) {
1179		ret = -EFAULT;
1180		goto err_free_handles;
1181	}
1182
1183	syncobjs = kmalloc_array(count_handles, sizeof(*syncobjs), GFP_KERNEL);
1184	if (syncobjs == NULL) {
1185		ret = -ENOMEM;
1186		goto err_free_handles;
1187	}
1188
1189	for (i = 0; i < count_handles; i++) {
1190		syncobjs[i] = drm_syncobj_find(file_private, handles[i]);
1191		if (!syncobjs[i]) {
1192			ret = -ENOENT;
1193			goto err_put_syncobjs;
1194		}
1195	}
1196
1197	kfree(handles);
1198	*syncobjs_out = syncobjs;
1199	return 0;
1200
1201err_put_syncobjs:
1202	while (i-- > 0)
1203		drm_syncobj_put(syncobjs[i]);
1204	kfree(syncobjs);
1205err_free_handles:
1206	kfree(handles);
1207
1208	return ret;
1209}
1210
1211static void drm_syncobj_array_free(struct drm_syncobj **syncobjs,
1212				   uint32_t count)
1213{
1214	uint32_t i;
1215
1216	for (i = 0; i < count; i++)
1217		drm_syncobj_put(syncobjs[i]);
1218	kfree(syncobjs);
1219}
1220
1221int
1222drm_syncobj_wait_ioctl(struct drm_device *dev, void *data,
1223		       struct drm_file *file_private)
1224{
1225	struct drm_syncobj_wait *args = data;
1226	struct drm_syncobj **syncobjs;
 
 
1227	int ret = 0;
1228
1229	if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
1230		return -EOPNOTSUPP;
1231
1232	if (args->flags & ~(DRM_SYNCOBJ_WAIT_FLAGS_WAIT_ALL |
1233			    DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT))
 
 
 
1234		return -EINVAL;
1235
1236	if (args->count_handles == 0)
1237		return -EINVAL;
1238
1239	ret = drm_syncobj_array_find(file_private,
1240				     u64_to_user_ptr(args->handles),
1241				     args->count_handles,
1242				     &syncobjs);
1243	if (ret < 0)
1244		return ret;
1245
 
 
 
 
 
1246	ret = drm_syncobj_array_wait(dev, file_private,
1247				     args, NULL, syncobjs, false);
1248
1249	drm_syncobj_array_free(syncobjs, args->count_handles);
1250
1251	return ret;
1252}
1253
1254int
1255drm_syncobj_timeline_wait_ioctl(struct drm_device *dev, void *data,
1256				struct drm_file *file_private)
1257{
1258	struct drm_syncobj_timeline_wait *args = data;
1259	struct drm_syncobj **syncobjs;
 
 
1260	int ret = 0;
1261
1262	if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ_TIMELINE))
1263		return -EOPNOTSUPP;
1264
1265	if (args->flags & ~(DRM_SYNCOBJ_WAIT_FLAGS_WAIT_ALL |
1266			    DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT |
1267			    DRM_SYNCOBJ_WAIT_FLAGS_WAIT_AVAILABLE))
 
 
 
1268		return -EINVAL;
1269
1270	if (args->count_handles == 0)
1271		return -EINVAL;
1272
1273	ret = drm_syncobj_array_find(file_private,
1274				     u64_to_user_ptr(args->handles),
1275				     args->count_handles,
1276				     &syncobjs);
1277	if (ret < 0)
1278		return ret;
1279
 
 
 
 
 
1280	ret = drm_syncobj_array_wait(dev, file_private,
1281				     NULL, args, syncobjs, true);
1282
1283	drm_syncobj_array_free(syncobjs, args->count_handles);
1284
1285	return ret;
1286}
1287
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1288
1289int
1290drm_syncobj_reset_ioctl(struct drm_device *dev, void *data,
1291			struct drm_file *file_private)
1292{
1293	struct drm_syncobj_array *args = data;
1294	struct drm_syncobj **syncobjs;
1295	uint32_t i;
1296	int ret;
1297
1298	if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
1299		return -EOPNOTSUPP;
1300
1301	if (args->pad != 0)
1302		return -EINVAL;
1303
1304	if (args->count_handles == 0)
1305		return -EINVAL;
1306
1307	ret = drm_syncobj_array_find(file_private,
1308				     u64_to_user_ptr(args->handles),
1309				     args->count_handles,
1310				     &syncobjs);
1311	if (ret < 0)
1312		return ret;
1313
1314	for (i = 0; i < args->count_handles; i++)
1315		drm_syncobj_replace_fence(syncobjs[i], NULL);
1316
1317	drm_syncobj_array_free(syncobjs, args->count_handles);
1318
1319	return 0;
1320}
1321
1322int
1323drm_syncobj_signal_ioctl(struct drm_device *dev, void *data,
1324			 struct drm_file *file_private)
1325{
1326	struct drm_syncobj_array *args = data;
1327	struct drm_syncobj **syncobjs;
1328	uint32_t i;
1329	int ret;
1330
1331	if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ))
1332		return -EOPNOTSUPP;
1333
1334	if (args->pad != 0)
1335		return -EINVAL;
1336
1337	if (args->count_handles == 0)
1338		return -EINVAL;
1339
1340	ret = drm_syncobj_array_find(file_private,
1341				     u64_to_user_ptr(args->handles),
1342				     args->count_handles,
1343				     &syncobjs);
1344	if (ret < 0)
1345		return ret;
1346
1347	for (i = 0; i < args->count_handles; i++) {
1348		ret = drm_syncobj_assign_null_handle(syncobjs[i]);
1349		if (ret < 0)
1350			break;
1351	}
1352
1353	drm_syncobj_array_free(syncobjs, args->count_handles);
1354
1355	return ret;
1356}
1357
1358int
1359drm_syncobj_timeline_signal_ioctl(struct drm_device *dev, void *data,
1360				  struct drm_file *file_private)
1361{
1362	struct drm_syncobj_timeline_array *args = data;
1363	struct drm_syncobj **syncobjs;
1364	struct dma_fence_chain **chains;
1365	uint64_t *points;
1366	uint32_t i, j;
1367	int ret;
1368
1369	if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ_TIMELINE))
1370		return -EOPNOTSUPP;
1371
1372	if (args->flags != 0)
1373		return -EINVAL;
1374
1375	if (args->count_handles == 0)
1376		return -EINVAL;
1377
1378	ret = drm_syncobj_array_find(file_private,
1379				     u64_to_user_ptr(args->handles),
1380				     args->count_handles,
1381				     &syncobjs);
1382	if (ret < 0)
1383		return ret;
1384
1385	points = kmalloc_array(args->count_handles, sizeof(*points),
1386			       GFP_KERNEL);
1387	if (!points) {
1388		ret = -ENOMEM;
1389		goto out;
1390	}
1391	if (!u64_to_user_ptr(args->points)) {
1392		memset(points, 0, args->count_handles * sizeof(uint64_t));
1393	} else if (copy_from_user(points, u64_to_user_ptr(args->points),
1394				  sizeof(uint64_t) * args->count_handles)) {
1395		ret = -EFAULT;
1396		goto err_points;
1397	}
1398
1399	chains = kmalloc_array(args->count_handles, sizeof(void *), GFP_KERNEL);
1400	if (!chains) {
1401		ret = -ENOMEM;
1402		goto err_points;
1403	}
1404	for (i = 0; i < args->count_handles; i++) {
1405		chains[i] = kzalloc(sizeof(struct dma_fence_chain), GFP_KERNEL);
1406		if (!chains[i]) {
1407			for (j = 0; j < i; j++)
1408				kfree(chains[j]);
1409			ret = -ENOMEM;
1410			goto err_chains;
1411		}
1412	}
1413
1414	for (i = 0; i < args->count_handles; i++) {
1415		struct dma_fence *fence = dma_fence_get_stub();
1416
1417		drm_syncobj_add_point(syncobjs[i], chains[i],
1418				      fence, points[i]);
1419		dma_fence_put(fence);
1420	}
1421err_chains:
1422	kfree(chains);
1423err_points:
1424	kfree(points);
1425out:
1426	drm_syncobj_array_free(syncobjs, args->count_handles);
1427
1428	return ret;
1429}
1430
1431int drm_syncobj_query_ioctl(struct drm_device *dev, void *data,
1432			    struct drm_file *file_private)
1433{
1434	struct drm_syncobj_timeline_array *args = data;
1435	struct drm_syncobj **syncobjs;
1436	uint64_t __user *points = u64_to_user_ptr(args->points);
1437	uint32_t i;
1438	int ret;
1439
1440	if (!drm_core_check_feature(dev, DRIVER_SYNCOBJ_TIMELINE))
1441		return -EOPNOTSUPP;
1442
1443	if (args->flags & ~DRM_SYNCOBJ_QUERY_FLAGS_LAST_SUBMITTED)
1444		return -EINVAL;
1445
1446	if (args->count_handles == 0)
1447		return -EINVAL;
1448
1449	ret = drm_syncobj_array_find(file_private,
1450				     u64_to_user_ptr(args->handles),
1451				     args->count_handles,
1452				     &syncobjs);
1453	if (ret < 0)
1454		return ret;
1455
1456	for (i = 0; i < args->count_handles; i++) {
1457		struct dma_fence_chain *chain;
1458		struct dma_fence *fence;
1459		uint64_t point;
1460
1461		fence = drm_syncobj_fence_get(syncobjs[i]);
1462		chain = to_dma_fence_chain(fence);
1463		if (chain) {
1464			struct dma_fence *iter, *last_signaled =
1465				dma_fence_get(fence);
1466
1467			if (args->flags &
1468			    DRM_SYNCOBJ_QUERY_FLAGS_LAST_SUBMITTED) {
1469				point = fence->seqno;
1470			} else {
1471				dma_fence_chain_for_each(iter, fence) {
1472					if (iter->context != fence->context) {
1473						dma_fence_put(iter);
1474						/* It is most likely that timeline has
1475						* unorder points. */
1476						break;
1477					}
1478					dma_fence_put(last_signaled);
1479					last_signaled = dma_fence_get(iter);
1480				}
1481				point = dma_fence_is_signaled(last_signaled) ?
1482					last_signaled->seqno :
1483					to_dma_fence_chain(last_signaled)->prev_seqno;
1484			}
1485			dma_fence_put(last_signaled);
1486		} else {
1487			point = 0;
1488		}
1489		dma_fence_put(fence);
1490		ret = copy_to_user(&points[i], &point, sizeof(uint64_t));
1491		ret = ret ? -EFAULT : 0;
1492		if (ret)
1493			break;
1494	}
1495	drm_syncobj_array_free(syncobjs, args->count_handles);
1496
1497	return ret;
1498}