4 * Copyright (C) 2012 Google, Inc.
6 * This software is licensed under the terms of the GNU General Public
7 * License version 2, as published by the Free Software Foundation, and
8 * may be copied, distributed, and modified under those terms.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
17 #include <linux/debugfs.h>
18 #include <linux/export.h>
19 #include <linux/file.h>
21 #include <linux/kernel.h>
22 #include <linux/poll.h>
23 #include <linux/sched.h>
24 #include <linux/seq_file.h>
25 #include <linux/slab.h>
26 #include <linux/uaccess.h>
27 #include <linux/anon_inodes.h>
31 #define CREATE_TRACE_POINTS
32 #include "trace/sync.h"
34 static const struct fence_ops android_fence_ops;
35 static const struct file_operations sync_fence_fops;
37 struct sync_timeline *sync_timeline_create(const struct sync_timeline_ops *ops,
38 int size, const char *name)
40 struct sync_timeline *obj;
42 if (size < sizeof(struct sync_timeline))
45 obj = kzalloc(size, GFP_KERNEL);
49 kref_init(&obj->kref);
51 obj->context = fence_context_alloc(1);
52 strlcpy(obj->name, name, sizeof(obj->name));
54 INIT_LIST_HEAD(&obj->child_list_head);
55 INIT_LIST_HEAD(&obj->active_list_head);
56 spin_lock_init(&obj->child_list_lock);
58 sync_timeline_debug_add(obj);
62 EXPORT_SYMBOL(sync_timeline_create);
64 static void sync_timeline_free(struct kref *kref)
66 struct sync_timeline *obj =
67 container_of(kref, struct sync_timeline, kref);
69 sync_timeline_debug_remove(obj);
71 if (obj->ops->release_obj)
72 obj->ops->release_obj(obj);
77 static void sync_timeline_get(struct sync_timeline *obj)
82 static void sync_timeline_put(struct sync_timeline *obj)
84 kref_put(&obj->kref, sync_timeline_free);
87 void sync_timeline_destroy(struct sync_timeline *obj)
89 obj->destroyed = true;
91 * Ensure timeline is marked as destroyed before
92 * changing timeline's fences status.
97 * signal any children that their parent is going away.
99 sync_timeline_signal(obj);
100 sync_timeline_put(obj);
102 EXPORT_SYMBOL(sync_timeline_destroy);
104 void sync_timeline_signal(struct sync_timeline *obj)
107 LIST_HEAD(signaled_pts);
108 struct sync_pt *pt, *next;
110 trace_sync_timeline(obj);
112 spin_lock_irqsave(&obj->child_list_lock, flags);
114 list_for_each_entry_safe(pt, next, &obj->active_list_head,
116 if (fence_is_signaled_locked(&pt->base))
117 list_del(&pt->active_list);
120 spin_unlock_irqrestore(&obj->child_list_lock, flags);
122 EXPORT_SYMBOL(sync_timeline_signal);
124 struct sync_pt *sync_pt_create(struct sync_timeline *obj, int size)
129 if (size < sizeof(struct sync_pt))
132 pt = kzalloc(size, GFP_KERNEL);
136 spin_lock_irqsave(&obj->child_list_lock, flags);
137 sync_timeline_get(obj);
138 fence_init(&pt->base, &android_fence_ops, &obj->child_list_lock,
139 obj->context, ++obj->value);
140 list_add_tail(&pt->child_list, &obj->child_list_head);
141 INIT_LIST_HEAD(&pt->active_list);
142 spin_unlock_irqrestore(&obj->child_list_lock, flags);
145 EXPORT_SYMBOL(sync_pt_create);
147 void sync_pt_free(struct sync_pt *pt)
149 fence_put(&pt->base);
151 EXPORT_SYMBOL(sync_pt_free);
153 static struct sync_fence *sync_fence_alloc(int size, const char *name)
155 struct sync_fence *fence;
157 fence = kzalloc(size, GFP_KERNEL);
161 fence->file = anon_inode_getfile("sync_fence", &sync_fence_fops,
163 if (IS_ERR(fence->file))
166 kref_init(&fence->kref);
167 strlcpy(fence->name, name, sizeof(fence->name));
169 init_waitqueue_head(&fence->wq);
178 static void fence_check_cb_func(struct fence *f, struct fence_cb *cb)
180 struct sync_fence_cb *check;
181 struct sync_fence *fence;
183 check = container_of(cb, struct sync_fence_cb, cb);
184 fence = check->fence;
186 if (atomic_dec_and_test(&fence->status))
187 wake_up_all(&fence->wq);
190 /* TODO: implement a create which takes more that one sync_pt */
191 struct sync_fence *sync_fence_create(const char *name, struct sync_pt *pt)
193 struct sync_fence *fence;
195 fence = sync_fence_alloc(offsetof(struct sync_fence, cbs[1]), name);
199 fence->num_fences = 1;
200 atomic_set(&fence->status, 1);
202 fence_get(&pt->base);
203 fence->cbs[0].sync_pt = &pt->base;
204 fence->cbs[0].fence = fence;
205 if (fence_add_callback(&pt->base, &fence->cbs[0].cb,
206 fence_check_cb_func))
207 atomic_dec(&fence->status);
209 sync_fence_debug_add(fence);
213 EXPORT_SYMBOL(sync_fence_create);
215 struct sync_fence *sync_fence_fdget(int fd)
217 struct file *file = fget(fd);
222 if (file->f_op != &sync_fence_fops)
225 return file->private_data;
231 EXPORT_SYMBOL(sync_fence_fdget);
233 void sync_fence_put(struct sync_fence *fence)
237 EXPORT_SYMBOL(sync_fence_put);
239 void sync_fence_install(struct sync_fence *fence, int fd)
241 fd_install(fd, fence->file);
243 EXPORT_SYMBOL(sync_fence_install);
245 static void sync_fence_add_pt(struct sync_fence *fence,
246 int *i, struct fence *pt)
248 fence->cbs[*i].sync_pt = pt;
249 fence->cbs[*i].fence = fence;
251 if (!fence_add_callback(pt, &fence->cbs[*i].cb, fence_check_cb_func)) {
257 struct sync_fence *sync_fence_merge(const char *name,
258 struct sync_fence *a, struct sync_fence *b)
260 int num_fences = a->num_fences + b->num_fences;
261 struct sync_fence *fence;
263 unsigned long size = offsetof(struct sync_fence, cbs[num_fences]);
265 fence = sync_fence_alloc(size, name);
269 atomic_set(&fence->status, num_fences);
272 * Assume sync_fence a and b are both ordered and have no
273 * duplicates with the same context.
275 * If a sync_fence can only be created with sync_fence_merge
276 * and sync_fence_create, this is a reasonable assumption.
278 for (i = i_a = i_b = 0; i_a < a->num_fences && i_b < b->num_fences; ) {
279 struct fence *pt_a = a->cbs[i_a].sync_pt;
280 struct fence *pt_b = b->cbs[i_b].sync_pt;
282 if (pt_a->context < pt_b->context) {
283 sync_fence_add_pt(fence, &i, pt_a);
286 } else if (pt_a->context > pt_b->context) {
287 sync_fence_add_pt(fence, &i, pt_b);
291 if (pt_a->seqno - pt_b->seqno <= INT_MAX)
292 sync_fence_add_pt(fence, &i, pt_a);
294 sync_fence_add_pt(fence, &i, pt_b);
301 for (; i_a < a->num_fences; i_a++)
302 sync_fence_add_pt(fence, &i, a->cbs[i_a].sync_pt);
304 for (; i_b < b->num_fences; i_b++)
305 sync_fence_add_pt(fence, &i, b->cbs[i_b].sync_pt);
308 atomic_sub(num_fences - i, &fence->status);
309 fence->num_fences = i;
311 sync_fence_debug_add(fence);
314 EXPORT_SYMBOL(sync_fence_merge);
316 int sync_fence_wake_up_wq(wait_queue_t *curr, unsigned mode,
317 int wake_flags, void *key)
319 struct sync_fence_waiter *wait;
321 wait = container_of(curr, struct sync_fence_waiter, work);
322 list_del_init(&wait->work.task_list);
324 wait->callback(wait->work.private, wait);
328 int sync_fence_wait_async(struct sync_fence *fence,
329 struct sync_fence_waiter *waiter)
331 int err = atomic_read(&fence->status);
340 init_waitqueue_func_entry(&waiter->work, sync_fence_wake_up_wq);
341 waiter->work.private = fence;
343 spin_lock_irqsave(&fence->wq.lock, flags);
344 err = atomic_read(&fence->status);
346 __add_wait_queue_tail(&fence->wq, &waiter->work);
347 spin_unlock_irqrestore(&fence->wq.lock, flags);
354 EXPORT_SYMBOL(sync_fence_wait_async);
356 int sync_fence_cancel_async(struct sync_fence *fence,
357 struct sync_fence_waiter *waiter)
362 spin_lock_irqsave(&fence->wq.lock, flags);
363 if (!list_empty(&waiter->work.task_list))
364 list_del_init(&waiter->work.task_list);
367 spin_unlock_irqrestore(&fence->wq.lock, flags);
370 EXPORT_SYMBOL(sync_fence_cancel_async);
372 int sync_fence_wait(struct sync_fence *fence, long timeout)
378 timeout = MAX_SCHEDULE_TIMEOUT;
380 timeout = msecs_to_jiffies(timeout);
382 trace_sync_wait(fence, 1);
383 for (i = 0; i < fence->num_fences; ++i)
384 trace_sync_pt(fence->cbs[i].sync_pt);
385 ret = wait_event_interruptible_timeout(fence->wq,
386 atomic_read(&fence->status) <= 0,
388 trace_sync_wait(fence, 0);
394 pr_info("fence timeout on [%p] after %dms\n", fence,
395 jiffies_to_msecs(timeout));
401 ret = atomic_read(&fence->status);
403 pr_info("fence error %ld on [%p]\n", ret, fence);
408 EXPORT_SYMBOL(sync_fence_wait);
410 static const char *android_fence_get_driver_name(struct fence *fence)
412 struct sync_pt *pt = container_of(fence, struct sync_pt, base);
413 struct sync_timeline *parent = sync_pt_parent(pt);
415 return parent->ops->driver_name;
418 static const char *android_fence_get_timeline_name(struct fence *fence)
420 struct sync_pt *pt = container_of(fence, struct sync_pt, base);
421 struct sync_timeline *parent = sync_pt_parent(pt);
426 static void android_fence_release(struct fence *fence)
428 struct sync_pt *pt = container_of(fence, struct sync_pt, base);
429 struct sync_timeline *parent = sync_pt_parent(pt);
432 spin_lock_irqsave(fence->lock, flags);
433 list_del(&pt->child_list);
434 if (WARN_ON_ONCE(!list_empty(&pt->active_list)))
435 list_del(&pt->active_list);
436 spin_unlock_irqrestore(fence->lock, flags);
438 if (parent->ops->free_pt)
439 parent->ops->free_pt(pt);
441 sync_timeline_put(parent);
442 fence_free(&pt->base);
445 static bool android_fence_signaled(struct fence *fence)
447 struct sync_pt *pt = container_of(fence, struct sync_pt, base);
448 struct sync_timeline *parent = sync_pt_parent(pt);
451 ret = parent->ops->has_signaled(pt);
457 static bool android_fence_enable_signaling(struct fence *fence)
459 struct sync_pt *pt = container_of(fence, struct sync_pt, base);
460 struct sync_timeline *parent = sync_pt_parent(pt);
462 if (android_fence_signaled(fence))
465 list_add_tail(&pt->active_list, &parent->active_list_head);
469 static int android_fence_fill_driver_data(struct fence *fence,
470 void *data, int size)
472 struct sync_pt *pt = container_of(fence, struct sync_pt, base);
473 struct sync_timeline *parent = sync_pt_parent(pt);
475 if (!parent->ops->fill_driver_data)
477 return parent->ops->fill_driver_data(pt, data, size);
480 static void android_fence_value_str(struct fence *fence,
483 struct sync_pt *pt = container_of(fence, struct sync_pt, base);
484 struct sync_timeline *parent = sync_pt_parent(pt);
486 if (!parent->ops->pt_value_str) {
491 parent->ops->pt_value_str(pt, str, size);
494 static void android_fence_timeline_value_str(struct fence *fence,
497 struct sync_pt *pt = container_of(fence, struct sync_pt, base);
498 struct sync_timeline *parent = sync_pt_parent(pt);
500 if (!parent->ops->timeline_value_str) {
505 parent->ops->timeline_value_str(parent, str, size);
508 static const struct fence_ops android_fence_ops = {
509 .get_driver_name = android_fence_get_driver_name,
510 .get_timeline_name = android_fence_get_timeline_name,
511 .enable_signaling = android_fence_enable_signaling,
512 .signaled = android_fence_signaled,
513 .wait = fence_default_wait,
514 .release = android_fence_release,
515 .fill_driver_data = android_fence_fill_driver_data,
516 .fence_value_str = android_fence_value_str,
517 .timeline_value_str = android_fence_timeline_value_str,
520 static void sync_fence_free(struct kref *kref)
522 struct sync_fence *fence = container_of(kref, struct sync_fence, kref);
523 int i, status = atomic_read(&fence->status);
525 for (i = 0; i < fence->num_fences; ++i) {
527 fence_remove_callback(fence->cbs[i].sync_pt,
529 fence_put(fence->cbs[i].sync_pt);
535 static int sync_fence_release(struct inode *inode, struct file *file)
537 struct sync_fence *fence = file->private_data;
539 sync_fence_debug_remove(fence);
541 kref_put(&fence->kref, sync_fence_free);
545 static unsigned int sync_fence_poll(struct file *file, poll_table *wait)
547 struct sync_fence *fence = file->private_data;
550 poll_wait(file, &fence->wq, wait);
552 status = atomic_read(&fence->status);
561 static long sync_fence_ioctl_wait(struct sync_fence *fence, unsigned long arg)
565 if (copy_from_user(&value, (void __user *)arg, sizeof(value)))
568 return sync_fence_wait(fence, value);
571 static long sync_fence_ioctl_merge(struct sync_fence *fence, unsigned long arg)
573 int fd = get_unused_fd_flags(O_CLOEXEC);
575 struct sync_fence *fence2, *fence3;
576 struct sync_merge_data data;
581 if (copy_from_user(&data, (void __user *)arg, sizeof(data))) {
586 fence2 = sync_fence_fdget(data.fd2);
587 if (fence2 == NULL) {
592 data.name[sizeof(data.name) - 1] = '\0';
593 fence3 = sync_fence_merge(data.name, fence, fence2);
594 if (fence3 == NULL) {
600 if (copy_to_user((void __user *)arg, &data, sizeof(data))) {
605 sync_fence_install(fence3, fd);
606 sync_fence_put(fence2);
610 sync_fence_put(fence3);
613 sync_fence_put(fence2);
620 static int sync_fill_pt_info(struct fence *fence, void *data, int size)
622 struct sync_pt_info *info = data;
625 if (size < sizeof(struct sync_pt_info))
628 info->len = sizeof(struct sync_pt_info);
630 if (fence->ops->fill_driver_data) {
631 ret = fence->ops->fill_driver_data(fence, info->driver_data,
632 size - sizeof(*info));
639 strlcpy(info->obj_name, fence->ops->get_timeline_name(fence),
640 sizeof(info->obj_name));
641 strlcpy(info->driver_name, fence->ops->get_driver_name(fence),
642 sizeof(info->driver_name));
643 if (fence_is_signaled(fence))
644 info->status = fence->status >= 0 ? 1 : fence->status;
647 info->timestamp_ns = ktime_to_ns(fence->timestamp);
652 static long sync_fence_ioctl_fence_info(struct sync_fence *fence,
655 struct sync_fence_info_data *data;
660 if (copy_from_user(&size, (void __user *)arg, sizeof(size)))
663 if (size < sizeof(struct sync_fence_info_data))
669 data = kzalloc(size, GFP_KERNEL);
673 strlcpy(data->name, fence->name, sizeof(data->name));
674 data->status = atomic_read(&fence->status);
675 if (data->status >= 0)
676 data->status = !data->status;
678 len = sizeof(struct sync_fence_info_data);
680 for (i = 0; i < fence->num_fences; ++i) {
681 struct fence *pt = fence->cbs[i].sync_pt;
683 ret = sync_fill_pt_info(pt, (u8 *)data + len, size - len);
693 if (copy_to_user((void __user *)arg, data, len))
704 static long sync_fence_ioctl(struct file *file, unsigned int cmd,
707 struct sync_fence *fence = file->private_data;
710 return sync_fence_ioctl_wait(fence, arg);
713 return sync_fence_ioctl_merge(fence, arg);
715 case SYNC_IOC_FENCE_INFO:
716 return sync_fence_ioctl_fence_info(fence, arg);
723 static const struct file_operations sync_fence_fops = {
724 .release = sync_fence_release,
725 .poll = sync_fence_poll,
726 .unlocked_ioctl = sync_fence_ioctl,
727 .compat_ioctl = sync_fence_ioctl,