drivers/dma-buf/sync_debug.c

   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 "error";
  67
  68         if (status > 0)
  69                 return "signaled";
  70
  71         return "active";
  72 }
  73
  74 static void sync_print_fence(struct seq_file *s,
  75                              struct dma_fence *fence, bool show)
  76 {
  77         struct sync_timeline *parent = dma_fence_parent(fence);
  78         int status;
  79
  80         status = dma_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_putc(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         char buf[128];
 136         int i;
 137
 138         seq_printf(s, "[%p] %s: %s\n", sync_file,
 139                    sync_file_get_name(sync_file, buf, sizeof(buf)),
 140                    sync_status_str(dma_fence_get_status(sync_file->fence)));
 141
 142         if (dma_fence_is_array(sync_file->fence)) {
 143                 struct dma_fence_array *array = to_dma_fence_array(sync_file->fence);
 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         }
 150 }
 151
 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);
 166                 seq_putc(s, '\n');
 167         }
 168         spin_unlock_irqrestore(&sync_timeline_list_lock, flags);
 169
 170         seq_puts(s, "fences:\n--------------\n");
 171
 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);
 176
 177                 sync_print_sync_file(s, sync_file);
 178                 seq_putc(s, '\n');
 179         }
 180         spin_unlock_irqrestore(&sync_file_list_lock, flags);
 181         return 0;
 182 }
 183
 184 static int sync_info_debugfs_open(struct inode *inode, struct file *file)
 185 {
 186         return single_open(file, sync_debugfs_show, inode->i_private);
 187 }
 188
 189 static const struct file_operations sync_info_debugfs_fops = {
 190         .open           = sync_info_debugfs_open,
 191         .read           = seq_read,
 192         .llseek         = seq_lseek,
 193         .release        = single_release,
 194 };
 195
 196 static __init int sync_debugfs_init(void)
 197 {
 198         dbgfs = debugfs_create_dir("sync", NULL);
 199
 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);
 209
 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];
 229
 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 }