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
sync_timeline_debug_add(struct sync_timeline * obj)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
sync_timeline_debug_remove(struct sync_timeline * obj)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
sync_file_debug_add(struct sync_file * sync_file)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
sync_file_debug_remove(struct sync_file * sync_file)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
sync_status_str(int status)63 static const char *sync_status_str(int status)
64 {
65 if (status < 0)
66 return "error";
67
68 if (status > 0)
69 return "signaled";
70
71 return "active";
72 }
73
sync_print_fence(struct seq_file * s,struct fence * fence,bool show)74 static void sync_print_fence(struct seq_file *s,
75 struct fence *fence, bool show)
76 {
77 struct sync_timeline *parent = fence_parent(fence);
78 int status;
79
80 status = fence_get_status_locked(fence);
81
82 seq_printf(s, " %s%sfence %s",
83 show ? parent->name : "",
84 show ? "_" : "",
85 sync_status_str(status));
86
87 if (status) {
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
sync_print_obj(struct seq_file * s,struct sync_timeline * obj)116 static void sync_print_obj(struct seq_file *s, struct sync_timeline *obj)
117 {
118 struct list_head *pos;
119
120 seq_printf(s, "%s: %d\n", obj->name, obj->value);
121
122 spin_lock_irq(&obj->lock);
123 list_for_each(pos, &obj->pt_list) {
124 struct sync_pt *pt = container_of(pos, struct sync_pt, link);
125 sync_print_fence(s, &pt->base, false);
126 }
127 spin_unlock_irq(&obj->lock);
128 }
129
sync_print_sync_file(struct seq_file * s,struct sync_file * sync_file)130 static void sync_print_sync_file(struct seq_file *s,
131 struct sync_file *sync_file)
132 {
133 int i;
134
135 seq_printf(s, "[%p] %s: %s\n", sync_file, sync_file->name,
136 sync_status_str(fence_get_status(sync_file->fence)));
137
138 if (fence_is_array(sync_file->fence)) {
139 struct fence_array *array = to_fence_array(sync_file->fence);
140
141 for (i = 0; i < array->num_fences; ++i)
142 sync_print_fence(s, array->fences[i], true);
143 } else {
144 sync_print_fence(s, sync_file->fence, true);
145 }
146 }
147
sync_debugfs_show(struct seq_file * s,void * unused)148 static int sync_debugfs_show(struct seq_file *s, void *unused)
149 {
150 struct list_head *pos;
151
152 seq_puts(s, "objs:\n--------------\n");
153
154 spin_lock_irq(&sync_timeline_list_lock);
155 list_for_each(pos, &sync_timeline_list_head) {
156 struct sync_timeline *obj =
157 container_of(pos, struct sync_timeline,
158 sync_timeline_list);
159
160 sync_print_obj(s, obj);
161 seq_puts(s, "\n");
162 }
163 spin_unlock_irq(&sync_timeline_list_lock);
164
165 seq_puts(s, "fences:\n--------------\n");
166
167 spin_lock_irq(&sync_file_list_lock);
168 list_for_each(pos, &sync_file_list_head) {
169 struct sync_file *sync_file =
170 container_of(pos, struct sync_file, sync_file_list);
171
172 sync_print_sync_file(s, sync_file);
173 seq_puts(s, "\n");
174 }
175 spin_unlock_irq(&sync_file_list_lock);
176 return 0;
177 }
178
sync_info_debugfs_open(struct inode * inode,struct file * file)179 static int sync_info_debugfs_open(struct inode *inode, struct file *file)
180 {
181 return single_open(file, sync_debugfs_show, inode->i_private);
182 }
183
184 static const struct file_operations sync_info_debugfs_fops = {
185 .open = sync_info_debugfs_open,
186 .read = seq_read,
187 .llseek = seq_lseek,
188 .release = single_release,
189 };
190
sync_debugfs_init(void)191 static __init int sync_debugfs_init(void)
192 {
193 dbgfs = debugfs_create_dir("sync", NULL);
194
195 /*
196 * The debugfs files won't ever get removed and thus, there is
197 * no need to protect it against removal races. The use of
198 * debugfs_create_file_unsafe() is actually safe here.
199 */
200 debugfs_create_file_unsafe("info", 0444, dbgfs, NULL,
201 &sync_info_debugfs_fops);
202 debugfs_create_file_unsafe("sw_sync", 0644, dbgfs, NULL,
203 &sw_sync_debugfs_fops);
204
205 return 0;
206 }
207 late_initcall(sync_debugfs_init);
208
209 #define DUMP_CHUNK 256
210 static char sync_dump_buf[64 * 1024];
sync_dump(void)211 void sync_dump(void)
212 {
213 struct seq_file s = {
214 .buf = sync_dump_buf,
215 .size = sizeof(sync_dump_buf) - 1,
216 };
217 int i;
218
219 sync_debugfs_show(&s, NULL);
220
221 for (i = 0; i < s.count; i += DUMP_CHUNK) {
222 if ((s.count - i) > DUMP_CHUNK) {
223 char c = s.buf[i + DUMP_CHUNK];
224
225 s.buf[i + DUMP_CHUNK] = 0;
226 pr_cont("%s", s.buf + i);
227 s.buf[i + DUMP_CHUNK] = c;
228 } else {
229 s.buf[s.count] = 0;
230 pr_cont("%s", s.buf + i);
231 }
232 }
233 }
234