drivers/gpu/drm/msm/msm_rd.c

   1 /*
   2  * Copyright (C) 2013 Red Hat
   3  * Author: Rob Clark <robdclark@gmail.com>
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 as published by
   7  * the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  12  * more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along with
  15  * this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 /* For debugging crashes, userspace can:
  19  *
  20  *   tail -f /sys/kernel/debug/dri/<minor>/rd > logfile.rd
  21  *
  22  * To log the cmdstream in a format that is understood by freedreno/cffdump
  23  * utility.  By comparing the last successfully completed fence #, to the
  24  * cmdstream for the next fence, you can narrow down which process and submit
  25  * caused the gpu crash/lockup.
  26  *
  27  * This bypasses drm_debugfs_create_files() mainly because we need to use
  28  * our own fops for a bit more control.  In particular, we don't want to
  29  * do anything if userspace doesn't have the debugfs file open.
  30  *
  31  * The module-param "rd_full", which defaults to false, enables snapshotting
  32  * all (non-written) buffers in the submit, rather than just cmdstream bo's.
  33  * This is useful to capture the contents of (for example) vbo's or textures,
  34  * or shader programs (if not emitted inline in cmdstream).
  35  */
  36
  37 #ifdef CONFIG_DEBUG_FS
  38
  39 #include <linux/kfifo.h>
  40 #include <linux/debugfs.h>
  41 #include <linux/circ_buf.h>
  42 #include <linux/wait.h>
  43
  44 #include "msm_drv.h"
  45 #include "msm_gpu.h"
  46 #include "msm_gem.h"
  47
  48 static bool rd_full = false;
  49 MODULE_PARM_DESC(rd_full, "If true, $debugfs/.../rd will snapshot all buffer contents");
  50 module_param_named(rd_full, rd_full, bool, 0600);
  51
  52 enum rd_sect_type {
  53         RD_NONE,
  54         RD_TEST,       /* ascii text */
  55         RD_CMD,        /* ascii text */
  56         RD_GPUADDR,    /* u32 gpuaddr, u32 size */
  57         RD_CONTEXT,    /* raw dump */
  58         RD_CMDSTREAM,  /* raw dump */
  59         RD_CMDSTREAM_ADDR, /* gpu addr of cmdstream */
  60         RD_PARAM,      /* u32 param_type, u32 param_val, u32 bitlen */
  61         RD_FLUSH,      /* empty, clear previous params */
  62         RD_PROGRAM,    /* shader program, raw dump */
  63         RD_VERT_SHADER,
  64         RD_FRAG_SHADER,
  65         RD_BUFFER_CONTENTS,
  66         RD_GPU_ID,
  67 };
  68
  69 #define BUF_SZ 512  /* should be power of 2 */
  70
  71 /* space used: */
  72 #define circ_count(circ) \
  73         (CIRC_CNT((circ)->head, (circ)->tail, BUF_SZ))
  74 #define circ_count_to_end(circ) \
  75         (CIRC_CNT_TO_END((circ)->head, (circ)->tail, BUF_SZ))
  76 /* space available: */
  77 #define circ_space(circ) \
  78         (CIRC_SPACE((circ)->head, (circ)->tail, BUF_SZ))
  79 #define circ_space_to_end(circ) \
  80         (CIRC_SPACE_TO_END((circ)->head, (circ)->tail, BUF_SZ))
  81
  82 struct msm_rd_state {
  83         struct drm_device *dev;
  84
  85         bool open;
  86
  87         struct dentry *ent;
  88         struct drm_info_node *node;
  89
  90         /* current submit to read out: */
  91         struct msm_gem_submit *submit;
  92
  93         /* fifo access is synchronized on the producer side by
  94          * struct_mutex held by submit code (otherwise we could
  95          * end up w/ cmds logged in different order than they
  96          * were executed).  And read_lock synchronizes the reads
  97          */
  98         struct mutex read_lock;
  99
 100         wait_queue_head_t fifo_event;
 101         struct circ_buf fifo;
 102
 103         char buf[BUF_SZ];
 104 };
 105
 106 static void rd_write(struct msm_rd_state *rd, const void *buf, int sz)
 107 {
 108         struct circ_buf *fifo = &rd->fifo;
 109         const char *ptr = buf;
 110
 111         while (sz > 0) {
 112                 char *fptr = &fifo->buf[fifo->head];
 113                 int n;
 114
 115                 wait_event(rd->fifo_event, circ_space(&rd->fifo) > 0 || !rd->open);
 116                 if (!rd->open)
 117                         return;
 118
 119                 n = min(sz, circ_space_to_end(&rd->fifo));
 120                 memcpy(fptr, ptr, n);
 121
 122                 fifo->head = (fifo->head + n) & (BUF_SZ - 1);
 123                 sz  -= n;
 124                 ptr += n;
 125
 126                 wake_up_all(&rd->fifo_event);
 127         }
 128 }
 129
 130 static void rd_write_section(struct msm_rd_state *rd,
 131                 enum rd_sect_type type, const void *buf, int sz)
 132 {
 133         rd_write(rd, &type, 4);
 134         rd_write(rd, &sz, 4);
 135         rd_write(rd, buf, sz);
 136 }
 137
 138 static ssize_t rd_read(struct file *file, char __user *buf,
 139                 size_t sz, loff_t *ppos)
 140 {
 141         struct msm_rd_state *rd = file->private_data;
 142         struct circ_buf *fifo = &rd->fifo;
 143         const char *fptr = &fifo->buf[fifo->tail];
 144         int n = 0, ret = 0;
 145
 146         mutex_lock(&rd->read_lock);
 147
 148         ret = wait_event_interruptible(rd->fifo_event,
 149                         circ_count(&rd->fifo) > 0);
 150         if (ret)
 151                 goto out;
 152
 153         n = min_t(int, sz, circ_count_to_end(&rd->fifo));
 154         if (copy_to_user(buf, fptr, n)) {
 155                 ret = -EFAULT;
 156                 goto out;
 157         }
 158
 159         fifo->tail = (fifo->tail + n) & (BUF_SZ - 1);
 160         *ppos += n;
 161
 162         wake_up_all(&rd->fifo_event);
 163
 164 out:
 165         mutex_unlock(&rd->read_lock);
 166         if (ret)
 167                 return ret;
 168         return n;
 169 }
 170
 171 static int rd_open(struct inode *inode, struct file *file)
 172 {
 173         struct msm_rd_state *rd = inode->i_private;
 174         struct drm_device *dev = rd->dev;
 175         struct msm_drm_private *priv = dev->dev_private;
 176         struct msm_gpu *gpu = priv->gpu;
 177         uint64_t val;
 178         uint32_t gpu_id;
 179         int ret = 0;
 180
 181         mutex_lock(&dev->struct_mutex);
 182
 183         if (rd->open || !gpu) {
 184                 ret = -EBUSY;
 185                 goto out;
 186         }
 187
 188         file->private_data = rd;
 189         rd->open = true;
 190
 191         /* Reset fifo to clear any previously unread data: */
 192         rd->fifo.head = rd->fifo.tail = 0;
 193
 194         /* the parsing tools need to know gpu-id to know which
 195          * register database to load.
 196          */
 197         gpu->funcs->get_param(gpu, MSM_PARAM_GPU_ID, &val);
 198         gpu_id = val;
 199
 200         rd_write_section(rd, RD_GPU_ID, &gpu_id, sizeof(gpu_id));
 201
 202 out:
 203         mutex_unlock(&dev->struct_mutex);
 204         return ret;
 205 }
 206
 207 static int rd_release(struct inode *inode, struct file *file)
 208 {
 209         struct msm_rd_state *rd = inode->i_private;
 210
 211         rd->open = false;
 212         wake_up_all(&rd->fifo_event);
 213
 214         return 0;
 215 }
 216
 217
 218 static const struct file_operations rd_debugfs_fops = {
 219         .owner = THIS_MODULE,
 220         .open = rd_open,
 221         .read = rd_read,
 222         .llseek = no_llseek,
 223         .release = rd_release,
 224 };
 225
 226 int msm_rd_debugfs_init(struct drm_minor *minor)
 227 {
 228         struct msm_drm_private *priv = minor->dev->dev_private;
 229         struct msm_rd_state *rd;
 230
 231         /* only create on first minor: */
 232         if (priv->rd)
 233                 return 0;
 234
 235         rd = kzalloc(sizeof(*rd), GFP_KERNEL);
 236         if (!rd)
 237                 return -ENOMEM;
 238
 239         rd->dev = minor->dev;
 240         rd->fifo.buf = rd->buf;
 241
 242         mutex_init(&rd->read_lock);
 243         priv->rd = rd;
 244
 245         init_waitqueue_head(&rd->fifo_event);
 246
 247         rd->node = kzalloc(sizeof(*rd->node), GFP_KERNEL);
 248         if (!rd->node)
 249                 goto fail;
 250
 251         rd->ent = debugfs_create_file("rd", S_IFREG | S_IRUGO,
 252                         minor->debugfs_root, rd, &rd_debugfs_fops);
 253         if (!rd->ent) {
 254                 DRM_ERROR("Cannot create /sys/kernel/debug/dri/%pd/rd\n",
 255                                 minor->debugfs_root);
 256                 goto fail;
 257         }
 258
 259         rd->node->minor = minor;
 260         rd->node->dent  = rd->ent;
 261         rd->node->info_ent = NULL;
 262
 263         mutex_lock(&minor->debugfs_lock);
 264         list_add(&rd->node->list, &minor->debugfs_list);
 265         mutex_unlock(&minor->debugfs_lock);
 266
 267         return 0;
 268
 269 fail:
 270         msm_rd_debugfs_cleanup(minor);
 271         return -1;
 272 }
 273
 274 void msm_rd_debugfs_cleanup(struct drm_minor *minor)
 275 {
 276         struct msm_drm_private *priv = minor->dev->dev_private;
 277         struct msm_rd_state *rd = priv->rd;
 278
 279         if (!rd)
 280                 return;
 281
 282         priv->rd = NULL;
 283
 284         debugfs_remove(rd->ent);
 285
 286         if (rd->node) {
 287                 mutex_lock(&minor->debugfs_lock);
 288                 list_del(&rd->node->list);
 289                 mutex_unlock(&minor->debugfs_lock);
 290                 kfree(rd->node);
 291         }
 292
 293         mutex_destroy(&rd->read_lock);
 294
 295         kfree(rd);
 296 }
 297
 298 static void snapshot_buf(struct msm_rd_state *rd,
 299                 struct msm_gem_submit *submit, int idx,
 300                 uint32_t iova, uint32_t size)
 301 {
 302         struct msm_gem_object *obj = submit->bos[idx].obj;
 303         const char *buf;
 304
 305         buf = msm_gem_get_vaddr_locked(&obj->base);
 306         if (IS_ERR(buf))
 307                 return;
 308
 309         if (iova) {
 310                 buf += iova - submit->bos[idx].iova;
 311         } else {
 312                 iova = submit->bos[idx].iova;
 313                 size = obj->base.size;
 314         }
 315
 316         rd_write_section(rd, RD_GPUADDR,
 317                         (uint32_t[2]){ iova, size }, 8);
 318         rd_write_section(rd, RD_BUFFER_CONTENTS, buf, size);
 319
 320         msm_gem_put_vaddr_locked(&obj->base);
 321 }
 322
 323 /* called under struct_mutex */
 324 void msm_rd_dump_submit(struct msm_gem_submit *submit)
 325 {
 326         struct drm_device *dev = submit->dev;
 327         struct msm_drm_private *priv = dev->dev_private;
 328         struct msm_rd_state *rd = priv->rd;
 329         char msg[128];
 330         int i, n;
 331
 332         if (!rd->open)
 333                 return;
 334
 335         /* writing into fifo is serialized by caller, and
 336          * rd->read_lock is used to serialize the reads
 337          */
 338         WARN_ON(!mutex_is_locked(&dev->struct_mutex));
 339
 340         n = snprintf(msg, sizeof(msg), "%.*s/%d: fence=%u",
 341                         TASK_COMM_LEN, current->comm, task_pid_nr(current),
 342                         submit->fence->seqno);
 343
 344         rd_write_section(rd, RD_CMD, msg, ALIGN(n, 4));
 345
 346         if (rd_full) {
 347                 for (i = 0; i < submit->nr_bos; i++) {
 348                         /* buffers that are written to probably don't start out
 349                          * with anything interesting:
 350                          */
 351                         if (submit->bos[i].flags & MSM_SUBMIT_BO_WRITE)
 352                                 continue;
 353
 354                         snapshot_buf(rd, submit, i, 0, 0);
 355                 }
 356         }
 357
 358         for (i = 0; i < submit->nr_cmds; i++) {
 359                 uint32_t iova = submit->cmd[i].iova;
 360                 uint32_t szd  = submit->cmd[i].size; /* in dwords */
 361
 362                 /* snapshot cmdstream bo's (if we haven't already): */
 363                 if (!rd_full) {
 364                         snapshot_buf(rd, submit, submit->cmd[i].idx,
 365                                         submit->cmd[i].iova, szd * 4);
 366                 }
 367
 368                 switch (submit->cmd[i].type) {
 369                 case MSM_SUBMIT_CMD_IB_TARGET_BUF:
 370                         /* ignore IB-targets, we've logged the buffer, the
 371                          * parser tool will follow the IB based on the logged
 372                          * buffer/gpuaddr, so nothing more to do.
 373                          */
 374                         break;
 375                 case MSM_SUBMIT_CMD_CTX_RESTORE_BUF:
 376                 case MSM_SUBMIT_CMD_BUF:
 377                         rd_write_section(rd, RD_CMDSTREAM_ADDR,
 378                                         (uint32_t[2]){ iova, szd }, 8);
 379                         break;
 380                 }
 381         }
 382 }
 383 #endif