xref: /linux/drivers/dma-buf/sync_debug.c (revision 59024954a1e7e26b62680e1f2b5725249a6c09f7)
1 /*
2  * Sync File validation framework and debug information
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 "sync_debug.h"
19 
20 static struct dentry *dbgfs;
21 
22 static LIST_HEAD(sync_timeline_list_head);
23 static DEFINE_SPINLOCK(sync_timeline_list_lock);
24 static LIST_HEAD(sync_file_list_head);
25 static DEFINE_SPINLOCK(sync_file_list_lock);
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 
45 void sync_file_debug_add(struct sync_file *sync_file)
46 {
47 	unsigned long flags;
48 
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);
52 }
53 
54 void sync_file_debug_remove(struct sync_file *sync_file)
55 {
56 	unsigned long flags;
57 
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);
61 }
62 
63 static const char *sync_status_str(int status)
64 {
65 	if (status == 0)
66 		return "signaled";
67 
68 	if (status > 0)
69 		return "active";
70 
71 	return "error";
72 }
73 
74 static void sync_print_fence(struct seq_file *s, struct fence *fence, bool show)
75 {
76 	int status = 1;
77 	struct sync_timeline *parent = fence_parent(fence);
78 
79 	if (fence_is_signaled_locked(fence))
80 		status = fence->status;
81 
82 	seq_printf(s, "  %s%sfence %s",
83 		   show ? parent->name : "",
84 		   show ? "_" : "",
85 		   sync_status_str(status));
86 
87 	if (status <= 0) {
88 		struct timespec64 ts64 =
89 			ktime_to_timespec64(fence->timestamp);
90 
91 		seq_printf(s, "@%lld.%09ld", (s64)ts64.tv_sec, ts64.tv_nsec);
92 	}
93 
94 	if (fence->ops->timeline_value_str &&
95 		fence->ops->fence_value_str) {
96 		char value[64];
97 		bool success;
98 
99 		fence->ops->fence_value_str(fence, value, sizeof(value));
100 		success = strlen(value);
101 
102 		if (success) {
103 			seq_printf(s, ": %s", value);
104 
105 			fence->ops->timeline_value_str(fence, value,
106 						       sizeof(value));
107 
108 			if (strlen(value))
109 				seq_printf(s, " / %s", value);
110 		}
111 	}
112 
113 	seq_puts(s, "\n");
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 
121 	seq_printf(s, "%s: %d\n", obj->name, obj->value);
122 
123 	spin_lock_irqsave(&obj->child_list_lock, flags);
124 	list_for_each(pos, &obj->child_list_head) {
125 		struct sync_pt *pt =
126 			container_of(pos, struct sync_pt, child_list);
127 		sync_print_fence(s, &pt->base, false);
128 	}
129 	spin_unlock_irqrestore(&obj->child_list_lock, flags);
130 }
131 
132 static void sync_print_sync_file(struct seq_file *s,
133 				  struct sync_file *sync_file)
134 {
135 	int i;
136 
137 	seq_printf(s, "[%p] %s: %s\n", sync_file, sync_file->name,
138 		   sync_status_str(atomic_read(&sync_file->status)));
139 
140 	for (i = 0; i < sync_file->num_fences; ++i)
141 		sync_print_fence(s, sync_file->cbs[i].fence, true);
142 }
143 
144 static int sync_debugfs_show(struct seq_file *s, void *unused)
145 {
146 	unsigned long flags;
147 	struct list_head *pos;
148 
149 	seq_puts(s, "objs:\n--------------\n");
150 
151 	spin_lock_irqsave(&sync_timeline_list_lock, flags);
152 	list_for_each(pos, &sync_timeline_list_head) {
153 		struct sync_timeline *obj =
154 			container_of(pos, struct sync_timeline,
155 				     sync_timeline_list);
156 
157 		sync_print_obj(s, obj);
158 		seq_puts(s, "\n");
159 	}
160 	spin_unlock_irqrestore(&sync_timeline_list_lock, flags);
161 
162 	seq_puts(s, "fences:\n--------------\n");
163 
164 	spin_lock_irqsave(&sync_file_list_lock, flags);
165 	list_for_each(pos, &sync_file_list_head) {
166 		struct sync_file *sync_file =
167 			container_of(pos, struct sync_file, sync_file_list);
168 
169 		sync_print_sync_file(s, sync_file);
170 		seq_puts(s, "\n");
171 	}
172 	spin_unlock_irqrestore(&sync_file_list_lock, flags);
173 	return 0;
174 }
175 
176 static int sync_info_debugfs_open(struct inode *inode, struct file *file)
177 {
178 	return single_open(file, sync_debugfs_show, inode->i_private);
179 }
180 
181 static const struct file_operations sync_info_debugfs_fops = {
182 	.open           = sync_info_debugfs_open,
183 	.read           = seq_read,
184 	.llseek         = seq_lseek,
185 	.release        = single_release,
186 };
187 
188 static __init int sync_debugfs_init(void)
189 {
190 	dbgfs = debugfs_create_dir("sync", NULL);
191 
192 	/*
193 	 * The debugfs files won't ever get removed and thus, there is
194 	 * no need to protect it against removal races. The use of
195 	 * debugfs_create_file_unsafe() is actually safe here.
196 	 */
197 	debugfs_create_file_unsafe("info", 0444, dbgfs, NULL,
198 				   &sync_info_debugfs_fops);
199 	debugfs_create_file_unsafe("sw_sync", 0644, dbgfs, NULL,
200 				   &sw_sync_debugfs_fops);
201 
202 	return 0;
203 }
204 late_initcall(sync_debugfs_init);
205 
206 #define DUMP_CHUNK 256
207 static char sync_dump_buf[64 * 1024];
208 void sync_dump(void)
209 {
210 	struct seq_file s = {
211 		.buf = sync_dump_buf,
212 		.size = sizeof(sync_dump_buf) - 1,
213 	};
214 	int i;
215 
216 	sync_debugfs_show(&s, NULL);
217 
218 	for (i = 0; i < s.count; i += DUMP_CHUNK) {
219 		if ((s.count - i) > DUMP_CHUNK) {
220 			char c = s.buf[i + DUMP_CHUNK];
221 
222 			s.buf[i + DUMP_CHUNK] = 0;
223 			pr_cont("%s", s.buf + i);
224 			s.buf[i + DUMP_CHUNK] = c;
225 		} else {
226 			s.buf[s.count] = 0;
227 			pr_cont("%s", s.buf + i);
228 		}
229 	}
230 }
231