[mirror_ubuntu-artful-kernel.git] / drivers / dma-buf / sync_debug.c

/*
 * Sync File validation framework and debug information
 *
 * 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 "sync_debug.h"

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 "error";

	if (status > 0)
		return "signaled";

	return "active";
}

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

	status = dma_fence_get_status_locked(fence);

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

	if (test_bit(DMA_FENCE_FLAG_TIMESTAMP_BIT, &fence->flags)) {
		struct timespec64 ts64 =
			ktime_to_timespec64(fence->timestamp);

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

	if (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);

			fence->ops->timeline_value_str(fence, value,
						       sizeof(value));

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

	seq_putc(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: %d\n", obj->name, obj->value);

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

static void sync_print_sync_file(struct seq_file *s,
				  struct sync_file *sync_file)
{
	char buf[128];
	int i;

	seq_printf(s, "[%p] %s: %s\n", sync_file,
		   sync_file_get_name(sync_file, buf, sizeof(buf)),
		   sync_status_str(dma_fence_get_status(sync_file->fence)));

	if (dma_fence_is_array(sync_file->fence)) {
		struct dma_fence_array *array = to_dma_fence_array(sync_file->fence);

		for (i = 0; i < array->num_fences; ++i)
			sync_print_fence(s, array->fences[i], true);
	} else {
		sync_print_fence(s, sync_file->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_putc(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_putc(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,
};

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

	/*
	 * The debugfs files won't ever get removed and thus, there is
	 * no need to protect it against removal races. The use of
	 * debugfs_create_file_unsafe() is actually safe here.
	 */
	debugfs_create_file_unsafe("info", 0444, dbgfs, NULL,
				   &sync_info_debugfs_fops);
	debugfs_create_file_unsafe("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);
		}
	}
}
Commit	Line	Data
0f0d8406	1	/*
e912c881	2	* Sync File validation framework and debug information
0f0d8406 ML	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>
1fe82e2e	18	#include "sync_debug.h"
0f0d8406	19
8a004484 GP	20	static struct dentry *dbgfs;
8a004484 GP	21
0f0d8406 ML	22	static LIST_HEAD(sync_timeline_list_head);
0f0d8406 ML	23	static DEFINE_SPINLOCK(sync_timeline_list_lock);
d7fdb0ae GP	24	static LIST_HEAD(sync_file_list_head);
d7fdb0ae GP	25	static DEFINE_SPINLOCK(sync_file_list_lock);
0f0d8406 ML	26
	27	void sync_timeline_debug_add(struct sync_timeline *obj)
	28	{
	29	unsigned long flags;
	30
	31	spin_lock_irqsave(&sync_timeline_list_lock, flags);
	32	list_add_tail(&obj->sync_timeline_list, &sync_timeline_list_head);
	33	spin_unlock_irqrestore(&sync_timeline_list_lock, flags);
	34	}
	35
	36	void sync_timeline_debug_remove(struct sync_timeline *obj)
	37	{
	38	unsigned long flags;
	39
	40	spin_lock_irqsave(&sync_timeline_list_lock, flags);
	41	list_del(&obj->sync_timeline_list);
	42	spin_unlock_irqrestore(&sync_timeline_list_lock, flags);
	43	}
	44
d7fdb0ae	45	void sync_file_debug_add(struct sync_file *sync_file)
0f0d8406 ML	46	{
	47	unsigned long flags;
	48
d7fdb0ae GP	49	spin_lock_irqsave(&sync_file_list_lock, flags);
	50	list_add_tail(&sync_file->sync_file_list, &sync_file_list_head);
	51	spin_unlock_irqrestore(&sync_file_list_lock, flags);
0f0d8406 ML	52	}
0f0d8406 ML	53
d7fdb0ae	54	void sync_file_debug_remove(struct sync_file *sync_file)
0f0d8406 ML	55	{
	56	unsigned long flags;
	57
d7fdb0ae GP	58	spin_lock_irqsave(&sync_file_list_lock, flags);
	59	list_del(&sync_file->sync_file_list);
	60	spin_unlock_irqrestore(&sync_file_list_lock, flags);
0f0d8406 ML	61	}
	62
	63	static const char *sync_status_str(int status)
	64	{
d6c99f4b CW	65	if (status < 0)
d6c99f4b CW	66	return "error";
95451355 PST	67
95451355 PST	68	if (status > 0)
d6c99f4b	69	return "signaled";
95451355	70
d6c99f4b	71	return "active";
0f0d8406 ML	72	}
0f0d8406 ML	73
f54d1867 CW	74	static void sync_print_fence(struct seq_file *s,
f54d1867 CW	75	struct dma_fence *fence, bool show)
0f0d8406	76	{
f54d1867	77	struct sync_timeline *parent = dma_fence_parent(fence);
d6c99f4b	78	int status;
0f0d8406	79
d6c99f4b	80	status = dma_fence_get_status_locked(fence);
0f0d8406	81
b55b54b5 GP	82	seq_printf(s, " %s%sfence %s",
	83	show ? parent->name : "",
	84	show ? "_" : "",
0f0d8406 ML	85	sync_status_str(status));
0f0d8406 ML	86
76250f2b	87	if (test_bit(DMA_FENCE_FLAG_TIMESTAMP_BIT, &fence->flags)) {
0541cdf5	88	struct timespec64 ts64 =
b55b54b5	89	ktime_to_timespec64(fence->timestamp);
95451355	90
353fdf17	91	seq_printf(s, "@%lld.%09ld", (s64)ts64.tv_sec, ts64.tv_nsec);
0f0d8406 ML	92	}
0f0d8406 ML	93
724812d6	94	if (fence->ops->timeline_value_str &&
b55b54b5	95	fence->ops->fence_value_str) {
0f0d8406	96	char value[64];
73465f1c	97	bool success;
95451355	98
b55b54b5	99	fence->ops->fence_value_str(fence, value, sizeof(value));
73465f1c ML	100	success = strlen(value);
73465f1c ML	101
724812d6	102	if (success) {
73465f1c ML	103	seq_printf(s, ": %s", value);
73465f1c ML	104
b55b54b5 GP	105	fence->ops->timeline_value_str(fence, value,
b55b54b5 GP	106	sizeof(value));
73465f1c ML	107
	108	if (strlen(value))
	109	seq_printf(s, " / %s", value);
0f0d8406 ML	110	}
	111	}
	112
47a369de	113	seq_putc(s, '\n');
0f0d8406 ML	114	}
	115
	116	static void sync_print_obj(struct seq_file s, struct sync_timeline obj)
	117	{
	118	struct list_head *pos;
	119	unsigned long flags;
	120
b9bc2b7b	121	seq_printf(s, "%s: %d\n", obj->name, obj->value);
0f0d8406 ML	122
	123	spin_lock_irqsave(&obj->child_list_lock, flags);
	124	list_for_each(pos, &obj->child_list_head) {
0431b906 GP	125	struct sync_pt *pt =
	126	container_of(pos, struct sync_pt, child_list);
	127	sync_print_fence(s, &pt->base, false);
0f0d8406 ML	128	}
	129	spin_unlock_irqrestore(&obj->child_list_lock, flags);
	130	}
	131
d7fdb0ae GP	132	static void sync_print_sync_file(struct seq_file *s,
d7fdb0ae GP	133	struct sync_file *sync_file)
b55b54b5	134	{
71ebc9a3	135	char buf[128];
0f0d8406 ML	136	int i;
0f0d8406 ML	137
71ebc9a3 CW	138	seq_printf(s, "[%p] %s: %s\n", sync_file,
71ebc9a3 CW	139	sync_file_get_name(sync_file, buf, sizeof(buf)),
d6c99f4b	140	sync_status_str(dma_fence_get_status(sync_file->fence)));
0f0d8406	141
f54d1867 CW	142	if (dma_fence_is_array(sync_file->fence)) {
f54d1867 CW	143	struct dma_fence_array *array = to_dma_fence_array(sync_file->fence);
a02b9dc9 GP	144
	145	for (i = 0; i < array->num_fences; ++i)
	146	sync_print_fence(s, array->fences[i], true);
	147	} else {
	148	sync_print_fence(s, sync_file->fence, true);
	149	}
b55b54b5 GP	150	}
b55b54b5 GP	151
0f0d8406 ML	152	static int sync_debugfs_show(struct seq_file s, void unused)
	153	{
	154	unsigned long flags;
	155	struct list_head *pos;
	156
	157	seq_puts(s, "objs:\n--------------\n");
	158
	159	spin_lock_irqsave(&sync_timeline_list_lock, flags);
	160	list_for_each(pos, &sync_timeline_list_head) {
	161	struct sync_timeline *obj =
	162	container_of(pos, struct sync_timeline,
	163	sync_timeline_list);
	164
	165	sync_print_obj(s, obj);
47a369de	166	seq_putc(s, '\n');
0f0d8406 ML	167	}
	168	spin_unlock_irqrestore(&sync_timeline_list_lock, flags);
	169
	170	seq_puts(s, "fences:\n--------------\n");
	171
d7fdb0ae GP	172	spin_lock_irqsave(&sync_file_list_lock, flags);
	173	list_for_each(pos, &sync_file_list_head) {
	174	struct sync_file *sync_file =
	175	container_of(pos, struct sync_file, sync_file_list);
0f0d8406	176
d7fdb0ae	177	sync_print_sync_file(s, sync_file);
47a369de	178	seq_putc(s, '\n');
0f0d8406	179	}
d7fdb0ae	180	spin_unlock_irqrestore(&sync_file_list_lock, flags);
0f0d8406 ML	181	return 0;
	182	}
	183
8a004484	184	static int sync_info_debugfs_open(struct inode inode, struct file file)
0f0d8406 ML	185	{
	186	return single_open(file, sync_debugfs_show, inode->i_private);
	187	}
	188
8a004484 GP	189	static const struct file_operations sync_info_debugfs_fops = {
8a004484 GP	190	.open = sync_info_debugfs_open,
0f0d8406 ML	191	.read = seq_read,
	192	.llseek = seq_lseek,
	193	.release = single_release,
	194	};
	195
	196	static __init int sync_debugfs_init(void)
	197	{
8a004484 GP	198	dbgfs = debugfs_create_dir("sync", NULL);
8a004484 GP	199
0fd9da9a NS	200	/*
	201	* The debugfs files won't ever get removed and thus, there is
	202	* no need to protect it against removal races. The use of
	203	* debugfs_create_file_unsafe() is actually safe here.
	204	*/
	205	debugfs_create_file_unsafe("info", 0444, dbgfs, NULL,
	206	&sync_info_debugfs_fops);
	207	debugfs_create_file_unsafe("sw_sync", 0644, dbgfs, NULL,
	208	&sw_sync_debugfs_fops);
8a004484	209
0f0d8406 ML	210	return 0;
	211	}
	212	late_initcall(sync_debugfs_init);
	213
	214	#define DUMP_CHUNK 256
	215	static char sync_dump_buf[64 * 1024];
	216	void sync_dump(void)
	217	{
	218	struct seq_file s = {
	219	.buf = sync_dump_buf,
	220	.size = sizeof(sync_dump_buf) - 1,
	221	};
	222	int i;
	223
	224	sync_debugfs_show(&s, NULL);
	225
	226	for (i = 0; i < s.count; i += DUMP_CHUNK) {
	227	if ((s.count - i) > DUMP_CHUNK) {
	228	char c = s.buf[i + DUMP_CHUNK];
95451355	229
0f0d8406 ML	230	s.buf[i + DUMP_CHUNK] = 0;
	231	pr_cont("%s", s.buf + i);
	232	s.buf[i + DUMP_CHUNK] = c;
	233	} else {
	234	s.buf[s.count] = 0;
	235	pr_cont("%s", s.buf + i);
	236	}
	237	}
	238	}