[deliverable/linux.git] / drivers / staging / android / sync_debug.c

/*
 * drivers/base/sync.c
 *
 * Copyright (C) 2012 Google, Inc.
 *
 * This software is licensed under the terms of the GNU General Public
 * License version 2, as published by the Free Software Foundation, and
 * may be copied, distributed, and modified under those terms.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 */

#include <linux/debugfs.h>
#include <linux/export.h>
#include <linux/file.h>
#include <linux/fs.h>
#include <linux/kernel.h>
#include <linux/poll.h>
#include <linux/sched.h>
#include <linux/seq_file.h>
#include <linux/slab.h>
#include <linux/uaccess.h>
#include <linux/anon_inodes.h>
#include <linux/time64.h>
#include <linux/sync_file.h>
#include "sw_sync.h"

#ifdef CONFIG_DEBUG_FS

static struct dentry *dbgfs;

static LIST_HEAD(sync_timeline_list_head);
static DEFINE_SPINLOCK(sync_timeline_list_lock);
static LIST_HEAD(sync_file_list_head);
static DEFINE_SPINLOCK(sync_file_list_lock);

void sync_timeline_debug_add(struct sync_timeline *obj)
{
	unsigned long flags;

	spin_lock_irqsave(&sync_timeline_list_lock, flags);
	list_add_tail(&obj->sync_timeline_list, &sync_timeline_list_head);
	spin_unlock_irqrestore(&sync_timeline_list_lock, flags);
}

void sync_timeline_debug_remove(struct sync_timeline *obj)
{
	unsigned long flags;

	spin_lock_irqsave(&sync_timeline_list_lock, flags);
	list_del(&obj->sync_timeline_list);
	spin_unlock_irqrestore(&sync_timeline_list_lock, flags);
}

void sync_file_debug_add(struct sync_file *sync_file)
{
	unsigned long flags;

	spin_lock_irqsave(&sync_file_list_lock, flags);
	list_add_tail(&sync_file->sync_file_list, &sync_file_list_head);
	spin_unlock_irqrestore(&sync_file_list_lock, flags);
}

void sync_file_debug_remove(struct sync_file *sync_file)
{
	unsigned long flags;

	spin_lock_irqsave(&sync_file_list_lock, flags);
	list_del(&sync_file->sync_file_list);
	spin_unlock_irqrestore(&sync_file_list_lock, flags);
}

static const char *sync_status_str(int status)
{
	if (status == 0)
		return "signaled";

	if (status > 0)
		return "active";

	return "error";
}

static void sync_print_fence(struct seq_file *s, struct fence *fence, bool show)
{
	int status = 1;
	struct sync_timeline *parent = fence_parent(fence);

	if (fence_is_signaled_locked(fence))
		status = fence->status;

	seq_printf(s, "  %s%sfence %s",
		   show ? parent->name : "",
		   show ? "_" : "",
		   sync_status_str(status));

	if (status <= 0) {
		struct timespec64 ts64 =
			ktime_to_timespec64(fence->timestamp);

		seq_printf(s, "@%lld.%09ld", (s64)ts64.tv_sec, ts64.tv_nsec);
	}

	if ((!fence || fence->ops->timeline_value_str) &&
		fence->ops->fence_value_str) {
		char value[64];
		bool success;

		fence->ops->fence_value_str(fence, value, sizeof(value));
		success = strlen(value);

		if (success)
			seq_printf(s, ": %s", value);

		if (success && fence) {
			fence->ops->timeline_value_str(fence, value,
						       sizeof(value));

			if (strlen(value))
				seq_printf(s, " / %s", value);
		}
	}

	seq_puts(s, "\n");
}

static void sync_print_obj(struct seq_file *s, struct sync_timeline *obj)
{
	struct list_head *pos;
	unsigned long flags;

	seq_printf(s, "%s %s", obj->name, obj->ops->driver_name);

	if (obj->ops->timeline_value_str) {
		char value[64];

		obj->ops->timeline_value_str(obj, value, sizeof(value));
		seq_printf(s, ": %s", value);
	}

	seq_puts(s, "\n");

	spin_lock_irqsave(&obj->child_list_lock, flags);
	list_for_each(pos, &obj->child_list_head) {
		struct fence *fence =
			container_of(pos, struct fence, child_list);
		sync_print_fence(s, fence, false);
	}
	spin_unlock_irqrestore(&obj->child_list_lock, flags);
}

static void sync_print_sync_file(struct seq_file *s,
				  struct sync_file *sync_file)
{
	int i;

	seq_printf(s, "[%p] %s: %s\n", sync_file, sync_file->name,
		   sync_status_str(atomic_read(&sync_file->status)));

	for (i = 0; i < sync_file->num_fences; ++i)
		sync_print_fence(s, sync_file->cbs[i].fence, true);
}

static int sync_debugfs_show(struct seq_file *s, void *unused)
{
	unsigned long flags;
	struct list_head *pos;

	seq_puts(s, "objs:\n--------------\n");

	spin_lock_irqsave(&sync_timeline_list_lock, flags);
	list_for_each(pos, &sync_timeline_list_head) {
		struct sync_timeline *obj =
			container_of(pos, struct sync_timeline,
				     sync_timeline_list);

		sync_print_obj(s, obj);
		seq_puts(s, "\n");
	}
	spin_unlock_irqrestore(&sync_timeline_list_lock, flags);

	seq_puts(s, "fences:\n--------------\n");

	spin_lock_irqsave(&sync_file_list_lock, flags);
	list_for_each(pos, &sync_file_list_head) {
		struct sync_file *sync_file =
			container_of(pos, struct sync_file, sync_file_list);

		sync_print_sync_file(s, sync_file);
		seq_puts(s, "\n");
	}
	spin_unlock_irqrestore(&sync_file_list_lock, flags);
	return 0;
}

static int sync_info_debugfs_open(struct inode *inode, struct file *file)
{
	return single_open(file, sync_debugfs_show, inode->i_private);
}

static const struct file_operations sync_info_debugfs_fops = {
	.open           = sync_info_debugfs_open,
	.read           = seq_read,
	.llseek         = seq_lseek,
	.release        = single_release,
};

/*
 * *WARNING*
 *
 * improper use of this can result in deadlocking kernel drivers from userspace.
 */

/* opening sw_sync create a new sync obj */
static int sw_sync_debugfs_open(struct inode *inode, struct file *file)
{
	struct sw_sync_timeline *obj;
	char task_comm[TASK_COMM_LEN];

	get_task_comm(task_comm, current);

	obj = sw_sync_timeline_create(task_comm);
	if (!obj)
		return -ENOMEM;

	file->private_data = obj;

	return 0;
}

static int sw_sync_debugfs_release(struct inode *inode, struct file *file)
{
	struct sw_sync_timeline *obj = file->private_data;

	sync_timeline_destroy(&obj->obj);
	return 0;
}

static long sw_sync_ioctl_create_fence(struct sw_sync_timeline *obj,
				       unsigned long arg)
{
	int fd = get_unused_fd_flags(O_CLOEXEC);
	int err;
	struct fence *fence;
	struct sync_file *sync_file;
	struct sw_sync_create_fence_data data;

	if (fd < 0)
		return fd;

	if (copy_from_user(&data, (void __user *)arg, sizeof(data))) {
		err = -EFAULT;
		goto err;
	}

	fence = sw_sync_pt_create(obj, data.value);
	if (!fence) {
		err = -ENOMEM;
		goto err;
	}

	sync_file = sync_file_create(fence);
	if (!sync_file) {
		fence_put(fence);
		err = -ENOMEM;
		goto err;
	}

	data.fence = fd;
	if (copy_to_user((void __user *)arg, &data, sizeof(data))) {
		fput(sync_file->file);
		err = -EFAULT;
		goto err;
	}

	fd_install(fd, sync_file->file);

	return 0;

err:
	put_unused_fd(fd);
	return err;
}

static long sw_sync_ioctl_inc(struct sw_sync_timeline *obj, unsigned long arg)
{
	u32 value;

	if (copy_from_user(&value, (void __user *)arg, sizeof(value)))
		return -EFAULT;

	sw_sync_timeline_inc(obj, value);

	return 0;
}

static long sw_sync_ioctl(struct file *file, unsigned int cmd,
			  unsigned long arg)
{
	struct sw_sync_timeline *obj = file->private_data;

	switch (cmd) {
	case SW_SYNC_IOC_CREATE_FENCE:
		return sw_sync_ioctl_create_fence(obj, arg);

	case SW_SYNC_IOC_INC:
		return sw_sync_ioctl_inc(obj, arg);

	default:
		return -ENOTTY;
	}
}

static const struct file_operations sw_sync_debugfs_fops = {
	.open           = sw_sync_debugfs_open,
	.release        = sw_sync_debugfs_release,
	.unlocked_ioctl = sw_sync_ioctl,
	.compat_ioctl = sw_sync_ioctl,
};

static __init int sync_debugfs_init(void)
{
	dbgfs = debugfs_create_dir("sync", NULL);

	debugfs_create_file("info", 0444, dbgfs, NULL, &sync_info_debugfs_fops);
	debugfs_create_file("sw_sync", 0644, dbgfs, NULL,
			    &sw_sync_debugfs_fops);

	return 0;
}
late_initcall(sync_debugfs_init);

#define DUMP_CHUNK 256
static char sync_dump_buf[64 * 1024];
void sync_dump(void)
{
	struct seq_file s = {
		.buf = sync_dump_buf,
		.size = sizeof(sync_dump_buf) - 1,
	};
	int i;

	sync_debugfs_show(&s, NULL);

	for (i = 0; i < s.count; i += DUMP_CHUNK) {
		if ((s.count - i) > DUMP_CHUNK) {
			char c = s.buf[i + DUMP_CHUNK];

			s.buf[i + DUMP_CHUNK] = 0;
			pr_cont("%s", s.buf + i);
			s.buf[i + DUMP_CHUNK] = c;
		} else {
			s.buf[s.count] = 0;
			pr_cont("%s", s.buf + i);
		}
	}
}

#endif
Commit	Line	Data
0f0d8406 ML	1	/*
	2	* drivers/base/sync.c
	3	*
	4	* Copyright (C) 2012 Google, Inc.
	5	*
	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.
	9	*
	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.
	14	*
	15	*/
	16
	17	#include <linux/debugfs.h>
	18	#include <linux/export.h>
	19	#include <linux/file.h>
	20	#include <linux/fs.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>
353fdf17	28	#include <linux/time64.h>
460bfc41	29	#include <linux/sync_file.h>
a44eb74c	30	#include "sw_sync.h"
0f0d8406 ML	31
	32	#ifdef CONFIG_DEBUG_FS
	33
8a004484 GP	34	static struct dentry *dbgfs;
8a004484 GP	35
0f0d8406 ML	36	static LIST_HEAD(sync_timeline_list_head);
0f0d8406 ML	37	static DEFINE_SPINLOCK(sync_timeline_list_lock);
d7fdb0ae GP	38	static LIST_HEAD(sync_file_list_head);
d7fdb0ae GP	39	static DEFINE_SPINLOCK(sync_file_list_lock);
0f0d8406 ML	40
	41	void sync_timeline_debug_add(struct sync_timeline *obj)
	42	{
	43	unsigned long flags;
	44
	45	spin_lock_irqsave(&sync_timeline_list_lock, flags);
	46	list_add_tail(&obj->sync_timeline_list, &sync_timeline_list_head);
	47	spin_unlock_irqrestore(&sync_timeline_list_lock, flags);
	48	}
	49
	50	void sync_timeline_debug_remove(struct sync_timeline *obj)
	51	{
	52	unsigned long flags;
	53
	54	spin_lock_irqsave(&sync_timeline_list_lock, flags);
	55	list_del(&obj->sync_timeline_list);
	56	spin_unlock_irqrestore(&sync_timeline_list_lock, flags);
	57	}
	58
d7fdb0ae	59	void sync_file_debug_add(struct sync_file *sync_file)
0f0d8406 ML	60	{
	61	unsigned long flags;
	62
d7fdb0ae GP	63	spin_lock_irqsave(&sync_file_list_lock, flags);
	64	list_add_tail(&sync_file->sync_file_list, &sync_file_list_head);
	65	spin_unlock_irqrestore(&sync_file_list_lock, flags);
0f0d8406 ML	66	}
0f0d8406 ML	67
d7fdb0ae	68	void sync_file_debug_remove(struct sync_file *sync_file)
0f0d8406 ML	69	{
	70	unsigned long flags;
	71
d7fdb0ae GP	72	spin_lock_irqsave(&sync_file_list_lock, flags);
	73	list_del(&sync_file->sync_file_list);
	74	spin_unlock_irqrestore(&sync_file_list_lock, flags);
0f0d8406 ML	75	}
	76
	77	static const char *sync_status_str(int status)
	78	{
	79	if (status == 0)
	80	return "signaled";
95451355 PST	81
95451355 PST	82	if (status > 0)
0f0d8406	83	return "active";
95451355 PST	84
95451355 PST	85	return "error";
0f0d8406 ML	86	}
0f0d8406 ML	87
b55b54b5	88	static void sync_print_fence(struct seq_file s, struct fence fence, bool show)
0f0d8406 ML	89	{
0f0d8406 ML	90	int status = 1;
b55b54b5	91	struct sync_timeline *parent = fence_parent(fence);
0f0d8406	92
b55b54b5 GP	93	if (fence_is_signaled_locked(fence))
b55b54b5 GP	94	status = fence->status;
0f0d8406	95
b55b54b5 GP	96	seq_printf(s, " %s%sfence %s",
	97	show ? parent->name : "",
	98	show ? "_" : "",
0f0d8406 ML	99	sync_status_str(status));
	100
	101	if (status <= 0) {
0541cdf5	102	struct timespec64 ts64 =
b55b54b5	103	ktime_to_timespec64(fence->timestamp);
95451355	104
353fdf17	105	seq_printf(s, "@%lld.%09ld", (s64)ts64.tv_sec, ts64.tv_nsec);
0f0d8406 ML	106	}
0f0d8406 ML	107
b55b54b5 GP	108	if ((!fence \|\| fence->ops->timeline_value_str) &&
b55b54b5 GP	109	fence->ops->fence_value_str) {
0f0d8406	110	char value[64];
73465f1c	111	bool success;
95451355	112
b55b54b5	113	fence->ops->fence_value_str(fence, value, sizeof(value));
73465f1c ML	114	success = strlen(value);
	115
	116	if (success)
	117	seq_printf(s, ": %s", value);
	118
	119	if (success && fence) {
b55b54b5 GP	120	fence->ops->timeline_value_str(fence, value,
b55b54b5 GP	121	sizeof(value));
73465f1c ML	122
	123	if (strlen(value))
	124	seq_printf(s, " / %s", value);
0f0d8406 ML	125	}
	126	}
	127
	128	seq_puts(s, "\n");
	129	}
	130
	131	static void sync_print_obj(struct seq_file s, struct sync_timeline obj)
	132	{
	133	struct list_head *pos;
	134	unsigned long flags;
	135
	136	seq_printf(s, "%s %s", obj->name, obj->ops->driver_name);
	137
	138	if (obj->ops->timeline_value_str) {
	139	char value[64];
95451355	140
0f0d8406 ML	141	obj->ops->timeline_value_str(obj, value, sizeof(value));
	142	seq_printf(s, ": %s", value);
	143	}
	144
	145	seq_puts(s, "\n");
	146
	147	spin_lock_irqsave(&obj->child_list_lock, flags);
	148	list_for_each(pos, &obj->child_list_head) {
b55b54b5 GP	149	struct fence *fence =
	150	container_of(pos, struct fence, child_list);
	151	sync_print_fence(s, fence, false);
0f0d8406 ML	152	}
	153	spin_unlock_irqrestore(&obj->child_list_lock, flags);
	154	}
	155
d7fdb0ae GP	156	static void sync_print_sync_file(struct seq_file *s,
d7fdb0ae GP	157	struct sync_file *sync_file)
b55b54b5	158	{
0f0d8406 ML	159	int i;
0f0d8406 ML	160
d7fdb0ae GP	161	seq_printf(s, "[%p] %s: %s\n", sync_file, sync_file->name,
d7fdb0ae GP	162	sync_status_str(atomic_read(&sync_file->status)));
0f0d8406	163
d7fdb0ae	164	for (i = 0; i < sync_file->num_fences; ++i)
b55b54b5 GP	165	sync_print_fence(s, sync_file->cbs[i].fence, true);
	166	}
	167
0f0d8406 ML	168	static int sync_debugfs_show(struct seq_file s, void unused)
	169	{
	170	unsigned long flags;
	171	struct list_head *pos;
	172
	173	seq_puts(s, "objs:\n--------------\n");
	174
	175	spin_lock_irqsave(&sync_timeline_list_lock, flags);
	176	list_for_each(pos, &sync_timeline_list_head) {
	177	struct sync_timeline *obj =
	178	container_of(pos, struct sync_timeline,
	179	sync_timeline_list);
	180
	181	sync_print_obj(s, obj);
	182	seq_puts(s, "\n");
	183	}
	184	spin_unlock_irqrestore(&sync_timeline_list_lock, flags);
	185
	186	seq_puts(s, "fences:\n--------------\n");
	187
d7fdb0ae GP	188	spin_lock_irqsave(&sync_file_list_lock, flags);
	189	list_for_each(pos, &sync_file_list_head) {
	190	struct sync_file *sync_file =
	191	container_of(pos, struct sync_file, sync_file_list);
0f0d8406	192
d7fdb0ae	193	sync_print_sync_file(s, sync_file);
0f0d8406 ML	194	seq_puts(s, "\n");
0f0d8406 ML	195	}
d7fdb0ae	196	spin_unlock_irqrestore(&sync_file_list_lock, flags);
0f0d8406 ML	197	return 0;
	198	}
	199
8a004484	200	static int sync_info_debugfs_open(struct inode inode, struct file file)
0f0d8406 ML	201	{
	202	return single_open(file, sync_debugfs_show, inode->i_private);
	203	}
	204
8a004484 GP	205	static const struct file_operations sync_info_debugfs_fops = {
8a004484 GP	206	.open = sync_info_debugfs_open,
0f0d8406 ML	207	.read = seq_read,
	208	.llseek = seq_lseek,
	209	.release = single_release,
	210	};
	211
a44eb74c GP	212	/*
	213	* WARNING
	214	*
	215	* improper use of this can result in deadlocking kernel drivers from userspace.
	216	*/
	217
	218	/* opening sw_sync create a new sync obj */
	219	static int sw_sync_debugfs_open(struct inode inode, struct file file)
	220	{
	221	struct sw_sync_timeline *obj;
	222	char task_comm[TASK_COMM_LEN];
	223
	224	get_task_comm(task_comm, current);
	225
	226	obj = sw_sync_timeline_create(task_comm);
	227	if (!obj)
	228	return -ENOMEM;
	229
	230	file->private_data = obj;
	231
	232	return 0;
	233	}
	234
	235	static int sw_sync_debugfs_release(struct inode inode, struct file file)
	236	{
	237	struct sw_sync_timeline *obj = file->private_data;
	238
	239	sync_timeline_destroy(&obj->obj);
	240	return 0;
	241	}
	242
	243	static long sw_sync_ioctl_create_fence(struct sw_sync_timeline *obj,
	244	unsigned long arg)
	245	{
	246	int fd = get_unused_fd_flags(O_CLOEXEC);
	247	int err;
b55b54b5	248	struct fence *fence;
d7fdb0ae	249	struct sync_file *sync_file;
a44eb74c GP	250	struct sw_sync_create_fence_data data;
	251
	252	if (fd < 0)
	253	return fd;
	254
	255	if (copy_from_user(&data, (void __user *)arg, sizeof(data))) {
	256	err = -EFAULT;
	257	goto err;
	258	}
	259
b55b54b5 GP	260	fence = sw_sync_pt_create(obj, data.value);
b55b54b5 GP	261	if (!fence) {
a44eb74c GP	262	err = -ENOMEM;
	263	goto err;
	264	}
	265
d7c3110c	266	sync_file = sync_file_create(fence);
d7fdb0ae	267	if (!sync_file) {
b55b54b5	268	fence_put(fence);
a44eb74c GP	269	err = -ENOMEM;
	270	goto err;
	271	}
	272
	273	data.fence = fd;
	274	if (copy_to_user((void __user *)arg, &data, sizeof(data))) {
2a7c1db5	275	fput(sync_file->file);
a44eb74c GP	276	err = -EFAULT;
	277	goto err;
	278	}
	279
2a7c1db5	280	fd_install(fd, sync_file->file);
a44eb74c GP	281
	282	return 0;
	283
	284	err:
	285	put_unused_fd(fd);
	286	return err;
	287	}
	288
	289	static long sw_sync_ioctl_inc(struct sw_sync_timeline *obj, unsigned long arg)
	290	{
	291	u32 value;
	292
	293	if (copy_from_user(&value, (void __user *)arg, sizeof(value)))
	294	return -EFAULT;
	295
	296	sw_sync_timeline_inc(obj, value);
	297
	298	return 0;
	299	}
	300
	301	static long sw_sync_ioctl(struct file *file, unsigned int cmd,
	302	unsigned long arg)
	303	{
	304	struct sw_sync_timeline *obj = file->private_data;
	305
	306	switch (cmd) {
	307	case SW_SYNC_IOC_CREATE_FENCE:
	308	return sw_sync_ioctl_create_fence(obj, arg);
	309
	310	case SW_SYNC_IOC_INC:
	311	return sw_sync_ioctl_inc(obj, arg);
	312
	313	default:
	314	return -ENOTTY;
	315	}
	316	}
	317
	318	static const struct file_operations sw_sync_debugfs_fops = {
	319	.open = sw_sync_debugfs_open,
	320	.release = sw_sync_debugfs_release,
	321	.unlocked_ioctl = sw_sync_ioctl,
	322	.compat_ioctl = sw_sync_ioctl,
	323	};
	324
0f0d8406 ML	325	static __init int sync_debugfs_init(void)
0f0d8406 ML	326	{
8a004484 GP	327	dbgfs = debugfs_create_dir("sync", NULL);
	328
	329	debugfs_create_file("info", 0444, dbgfs, NULL, &sync_info_debugfs_fops);
a44eb74c GP	330	debugfs_create_file("sw_sync", 0644, dbgfs, NULL,
a44eb74c GP	331	&sw_sync_debugfs_fops);
8a004484	332
0f0d8406 ML	333	return 0;
	334	}
	335	late_initcall(sync_debugfs_init);
	336
	337	#define DUMP_CHUNK 256
	338	static char sync_dump_buf[64 * 1024];
	339	void sync_dump(void)
	340	{
	341	struct seq_file s = {
	342	.buf = sync_dump_buf,
	343	.size = sizeof(sync_dump_buf) - 1,
	344	};
	345	int i;
	346
	347	sync_debugfs_show(&s, NULL);
	348
	349	for (i = 0; i < s.count; i += DUMP_CHUNK) {
	350	if ((s.count - i) > DUMP_CHUNK) {
	351	char c = s.buf[i + DUMP_CHUNK];
95451355	352
0f0d8406 ML	353	s.buf[i + DUMP_CHUNK] = 0;
	354	pr_cont("%s", s.buf + i);
	355	s.buf[i + DUMP_CHUNK] = c;
	356	} else {
	357	s.buf[s.count] = 0;
	358	pr_cont("%s", s.buf + i);
	359	}
	360	}
	361	}
	362
	363	#endif