drivers/gpu/drm/drm_debugfs.c

   1 /*
   2  * Created: Sun Dec 21 13:08:50 2008 by bgamari@gmail.com
   3  *
   4  * Copyright 2008 Ben Gamari <bgamari@gmail.com>
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the "Software"),
   8  * to deal in the Software without restriction, including without limitation
   9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  10  * and/or sell copies of the Software, and to permit persons to whom the
  11  * Software is furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice (including the next
  14  * paragraph) shall be included in all copies or substantial portions of the
  15  * Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  20  * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  21  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  22  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  23  * OTHER DEALINGS IN THE SOFTWARE.
  24  */
  25
  26 #include <linux/debugfs.h>
  27 #include <linux/export.h>
  28 #include <linux/seq_file.h>
  29 #include <linux/slab.h>
  30 #include <linux/uaccess.h>
  31
  32 #include <drm/drm_atomic.h>
  33 #include <drm/drm_auth.h>
  34 #include <drm/drm_client.h>
  35 #include <drm/drm_debugfs.h>
  36 #include <drm/drm_device.h>
  37 #include <drm/drm_drv.h>
  38 #include <drm/drm_edid.h>
  39 #include <drm/drm_file.h>
  40 #include <drm/drm_gem.h>
  41
  42 #include "drm_crtc_internal.h"
  43 #include "drm_internal.h"
  44
  45 #if defined(CONFIG_DEBUG_FS)
  46
  47 /***************************************************
  48  * Initialization, etc.
  49  **************************************************/
  50
  51 static int drm_name_info(struct seq_file *m, void *data)
  52 {
  53         struct drm_info_node *node = (struct drm_info_node *) m->private;
  54         struct drm_minor *minor = node->minor;
  55         struct drm_device *dev = minor->dev;
  56         struct drm_master *master;
  57
  58         mutex_lock(&dev->master_mutex);
  59         master = dev->master;
  60         seq_printf(m, "%s", dev->driver->name);
  61         if (dev->dev)
  62                 seq_printf(m, " dev=%s", dev_name(dev->dev));
  63         if (master && master->unique)
  64                 seq_printf(m, " master=%s", master->unique);
  65         if (dev->unique)
  66                 seq_printf(m, " unique=%s", dev->unique);
  67         seq_printf(m, "\n");
  68         mutex_unlock(&dev->master_mutex);
  69
  70         return 0;
  71 }
  72
  73 static int drm_clients_info(struct seq_file *m, void *data)
  74 {
  75         struct drm_info_node *node = (struct drm_info_node *) m->private;
  76         struct drm_device *dev = node->minor->dev;
  77         struct drm_file *priv;
  78         kuid_t uid;
  79
  80         seq_printf(m,
  81                    "%20s %5s %3s master a %5s %10s\n",
  82                    "command",
  83                    "pid",
  84                    "dev",
  85                    "uid",
  86                    "magic");
  87
  88         /* dev->filelist is sorted youngest first, but we want to present
  89          * oldest first (i.e. kernel, servers, clients), so walk backwardss.
  90          */
  91         mutex_lock(&dev->filelist_mutex);
  92         list_for_each_entry_reverse(priv, &dev->filelist, lhead) {
  93                 struct task_struct *task;
  94
  95                 rcu_read_lock(); /* locks pid_task()->comm */
  96                 task = pid_task(priv->pid, PIDTYPE_PID);
  97                 uid = task ? __task_cred(task)->euid : GLOBAL_ROOT_UID;
  98                 seq_printf(m, "%20s %5d %3d   %c    %c %5d %10u\n",
  99                            task ? task->comm : "<unknown>",
 100                            pid_vnr(priv->pid),
 101                            priv->minor->index,
 102                            drm_is_current_master(priv) ? 'y' : 'n',
 103                            priv->authenticated ? 'y' : 'n',
 104                            from_kuid_munged(seq_user_ns(m), uid),
 105                            priv->magic);
 106                 rcu_read_unlock();
 107         }
 108         mutex_unlock(&dev->filelist_mutex);
 109         return 0;
 110 }
 111
 112 static int drm_gem_one_name_info(int id, void *ptr, void *data)
 113 {
 114         struct drm_gem_object *obj = ptr;
 115         struct seq_file *m = data;
 116
 117         seq_printf(m, "%6d %8zd %7d %8d\n",
 118                    obj->name, obj->size,
 119                    obj->handle_count,
 120                    kref_read(&obj->refcount));
 121         return 0;
 122 }
 123
 124 static int drm_gem_name_info(struct seq_file *m, void *data)
 125 {
 126         struct drm_info_node *node = (struct drm_info_node *) m->private;
 127         struct drm_device *dev = node->minor->dev;
 128
 129         seq_printf(m, "  name     size handles refcount\n");
 130
 131         mutex_lock(&dev->object_name_lock);
 132         idr_for_each(&dev->object_name_idr, drm_gem_one_name_info, m);
 133         mutex_unlock(&dev->object_name_lock);
 134
 135         return 0;
 136 }
 137
 138 static const struct drm_info_list drm_debugfs_list[] = {
 139         {"name", drm_name_info, 0},
 140         {"clients", drm_clients_info, 0},
 141         {"gem_names", drm_gem_name_info, DRIVER_GEM},
 142 };
 143 #define DRM_DEBUGFS_ENTRIES ARRAY_SIZE(drm_debugfs_list)
 144
 145
 146 static int drm_debugfs_open(struct inode *inode, struct file *file)
 147 {
 148         struct drm_info_node *node = inode->i_private;
 149
 150         return single_open(file, node->info_ent->show, node);
 151 }
 152
 153
 154 static const struct file_operations drm_debugfs_fops = {
 155         .owner = THIS_MODULE,
 156         .open = drm_debugfs_open,
 157         .read = seq_read,
 158         .llseek = seq_lseek,
 159         .release = single_release,
 160 };
 161
 162
 163 /**
 164  * drm_debugfs_create_files - Initialize a given set of debugfs files for DRM
 165  *                      minor
 166  * @files: The array of files to create
 167  * @count: The number of files given
 168  * @root: DRI debugfs dir entry.
 169  * @minor: device minor number
 170  *
 171  * Create a given set of debugfs files represented by an array of
 172  * &struct drm_info_list in the given root directory. These files will be removed
 173  * automatically on drm_debugfs_cleanup().
 174  */
 175 int drm_debugfs_create_files(const struct drm_info_list *files, int count,
 176                              struct dentry *root, struct drm_minor *minor)
 177 {
 178         struct drm_device *dev = minor->dev;
 179         struct drm_info_node *tmp;
 180         int i;
 181
 182         for (i = 0; i < count; i++) {
 183                 u32 features = files[i].driver_features;
 184
 185                 if (features && !drm_core_check_all_features(dev, features))
 186                         continue;
 187
 188                 tmp = kmalloc(sizeof(struct drm_info_node), GFP_KERNEL);
 189                 if (tmp == NULL)
 190                         continue;
 191
 192                 tmp->minor = minor;
 193                 tmp->dent = debugfs_create_file(files[i].name,
 194                                                 S_IFREG | S_IRUGO, root, tmp,
 195                                                 &drm_debugfs_fops);
 196                 tmp->info_ent = &files[i];
 197
 198                 mutex_lock(&minor->debugfs_lock);
 199                 list_add(&tmp->list, &minor->debugfs_list);
 200                 mutex_unlock(&minor->debugfs_lock);
 201         }
 202         return 0;
 203 }
 204 EXPORT_SYMBOL(drm_debugfs_create_files);
 205
 206 int drm_debugfs_init(struct drm_minor *minor, int minor_id,
 207                      struct dentry *root)
 208 {
 209         struct drm_device *dev = minor->dev;
 210         char name[64];
 211         int ret;
 212
 213         INIT_LIST_HEAD(&minor->debugfs_list);
 214         mutex_init(&minor->debugfs_lock);
 215         sprintf(name, "%d", minor_id);
 216         minor->debugfs_root = debugfs_create_dir(name, root);
 217
 218         ret = drm_debugfs_create_files(drm_debugfs_list, DRM_DEBUGFS_ENTRIES,
 219                                        minor->debugfs_root, minor);
 220         if (ret) {
 221                 debugfs_remove(minor->debugfs_root);
 222                 minor->debugfs_root = NULL;
 223                 DRM_ERROR("Failed to create core drm debugfs files\n");
 224                 return ret;
 225         }
 226
 227         if (drm_drv_uses_atomic_modeset(dev)) {
 228                 ret = drm_atomic_debugfs_init(minor);
 229                 if (ret) {
 230                         DRM_ERROR("Failed to create atomic debugfs files\n");
 231                         return ret;
 232                 }
 233         }
 234
 235         if (drm_core_check_feature(dev, DRIVER_MODESET)) {
 236                 ret = drm_framebuffer_debugfs_init(minor);
 237                 if (ret) {
 238                         DRM_ERROR("Failed to create framebuffer debugfs file\n");
 239                         return ret;
 240                 }
 241
 242                 ret = drm_client_debugfs_init(minor);
 243                 if (ret) {
 244                         DRM_ERROR("Failed to create client debugfs file\n");
 245                         return ret;
 246                 }
 247         }
 248
 249         if (dev->driver->debugfs_init) {
 250                 ret = dev->driver->debugfs_init(minor);
 251                 if (ret) {
 252                         DRM_ERROR("DRM: Driver failed to initialize "
 253                                   "/sys/kernel/debug/dri.\n");
 254                         return ret;
 255                 }
 256         }
 257         return 0;
 258 }
 259
 260
 261 int drm_debugfs_remove_files(const struct drm_info_list *files, int count,
 262                              struct drm_minor *minor)
 263 {
 264         struct list_head *pos, *q;
 265         struct drm_info_node *tmp;
 266         int i;
 267
 268         mutex_lock(&minor->debugfs_lock);
 269         for (i = 0; i < count; i++) {
 270                 list_for_each_safe(pos, q, &minor->debugfs_list) {
 271                         tmp = list_entry(pos, struct drm_info_node, list);
 272                         if (tmp->info_ent == &files[i]) {
 273                                 debugfs_remove(tmp->dent);
 274                                 list_del(pos);
 275                                 kfree(tmp);
 276                         }
 277                 }
 278         }
 279         mutex_unlock(&minor->debugfs_lock);
 280         return 0;
 281 }
 282 EXPORT_SYMBOL(drm_debugfs_remove_files);
 283
 284 static void drm_debugfs_remove_all_files(struct drm_minor *minor)
 285 {
 286         struct drm_info_node *node, *tmp;
 287
 288         mutex_lock(&minor->debugfs_lock);
 289         list_for_each_entry_safe(node, tmp, &minor->debugfs_list, list) {
 290                 debugfs_remove(node->dent);
 291                 list_del(&node->list);
 292                 kfree(node);
 293         }
 294         mutex_unlock(&minor->debugfs_lock);
 295 }
 296
 297 void drm_debugfs_cleanup(struct drm_minor *minor)
 298 {
 299         if (!minor->debugfs_root)
 300                 return;
 301
 302         drm_debugfs_remove_all_files(minor);
 303
 304         debugfs_remove_recursive(minor->debugfs_root);
 305         minor->debugfs_root = NULL;
 306 }
 307
 308 static int connector_show(struct seq_file *m, void *data)
 309 {
 310         struct drm_connector *connector = m->private;
 311
 312         seq_printf(m, "%s\n", drm_get_connector_force_name(connector->force));
 313
 314         return 0;
 315 }
 316
 317 static int connector_open(struct inode *inode, struct file *file)
 318 {
 319         struct drm_connector *dev = inode->i_private;
 320
 321         return single_open(file, connector_show, dev);
 322 }
 323
 324 static ssize_t connector_write(struct file *file, const char __user *ubuf,
 325                                size_t len, loff_t *offp)
 326 {
 327         struct seq_file *m = file->private_data;
 328         struct drm_connector *connector = m->private;
 329         char buf[12];
 330
 331         if (len > sizeof(buf) - 1)
 332                 return -EINVAL;
 333
 334         if (copy_from_user(buf, ubuf, len))
 335                 return -EFAULT;
 336
 337         buf[len] = '\0';
 338
 339         if (!strcmp(buf, "on"))
 340                 connector->force = DRM_FORCE_ON;
 341         else if (!strcmp(buf, "digital"))
 342                 connector->force = DRM_FORCE_ON_DIGITAL;
 343         else if (!strcmp(buf, "off"))
 344                 connector->force = DRM_FORCE_OFF;
 345         else if (!strcmp(buf, "unspecified"))
 346                 connector->force = DRM_FORCE_UNSPECIFIED;
 347         else
 348                 return -EINVAL;
 349
 350         return len;
 351 }
 352
 353 static int edid_show(struct seq_file *m, void *data)
 354 {
 355         struct drm_connector *connector = m->private;
 356         struct drm_property_blob *edid = connector->edid_blob_ptr;
 357
 358         if (connector->override_edid && edid)
 359                 seq_write(m, edid->data, edid->length);
 360
 361         return 0;
 362 }
 363
 364 static int edid_open(struct inode *inode, struct file *file)
 365 {
 366         struct drm_connector *dev = inode->i_private;
 367
 368         return single_open(file, edid_show, dev);
 369 }
 370
 371 static ssize_t edid_write(struct file *file, const char __user *ubuf,
 372                           size_t len, loff_t *offp)
 373 {
 374         struct seq_file *m = file->private_data;
 375         struct drm_connector *connector = m->private;
 376         char *buf;
 377         struct edid *edid;
 378         int ret;
 379
 380         buf = memdup_user(ubuf, len);
 381         if (IS_ERR(buf))
 382                 return PTR_ERR(buf);
 383
 384         edid = (struct edid *) buf;
 385
 386         if (len == 5 && !strncmp(buf, "reset", 5)) {
 387                 connector->override_edid = false;
 388                 ret = drm_connector_update_edid_property(connector, NULL);
 389         } else if (len < EDID_LENGTH ||
 390                    EDID_LENGTH * (1 + edid->extensions) > len)
 391                 ret = -EINVAL;
 392         else {
 393                 connector->override_edid = false;
 394                 ret = drm_connector_update_edid_property(connector, edid);
 395                 if (!ret)
 396                         connector->override_edid = true;
 397         }
 398
 399         kfree(buf);
 400
 401         return (ret) ? ret : len;
 402 }
 403
 404 static const struct file_operations drm_edid_fops = {
 405         .owner = THIS_MODULE,
 406         .open = edid_open,
 407         .read = seq_read,
 408         .llseek = seq_lseek,
 409         .release = single_release,
 410         .write = edid_write
 411 };
 412
 413
 414 static const struct file_operations drm_connector_fops = {
 415         .owner = THIS_MODULE,
 416         .open = connector_open,
 417         .read = seq_read,
 418         .llseek = seq_lseek,
 419         .release = single_release,
 420         .write = connector_write
 421 };
 422
 423 void drm_debugfs_connector_add(struct drm_connector *connector)
 424 {
 425         struct drm_minor *minor = connector->dev->primary;
 426         struct dentry *root;
 427
 428         if (!minor->debugfs_root)
 429                 return;
 430
 431         root = debugfs_create_dir(connector->name, minor->debugfs_root);
 432         connector->debugfs_entry = root;
 433
 434         /* force */
 435         debugfs_create_file("force", S_IRUGO | S_IWUSR, root, connector,
 436                             &drm_connector_fops);
 437
 438         /* edid */
 439         debugfs_create_file("edid_override", S_IRUGO | S_IWUSR, root, connector,
 440                             &drm_edid_fops);
 441 }
 442
 443 void drm_debugfs_connector_remove(struct drm_connector *connector)
 444 {
 445         if (!connector->debugfs_entry)
 446                 return;
 447
 448         debugfs_remove_recursive(connector->debugfs_entry);
 449
 450         connector->debugfs_entry = NULL;
 451 }
 452
 453 void drm_debugfs_crtc_add(struct drm_crtc *crtc)
 454 {
 455         struct drm_minor *minor = crtc->dev->primary;
 456         struct dentry *root;
 457         char *name;
 458
 459         name = kasprintf(GFP_KERNEL, "crtc-%d", crtc->index);
 460         if (!name)
 461                 return;
 462
 463         root = debugfs_create_dir(name, minor->debugfs_root);
 464         kfree(name);
 465
 466         crtc->debugfs_entry = root;
 467
 468         drm_debugfs_crtc_crc_add(crtc);
 469 }
 470
 471 void drm_debugfs_crtc_remove(struct drm_crtc *crtc)
 472 {
 473         debugfs_remove_recursive(crtc->debugfs_entry);
 474         crtc->debugfs_entry = NULL;
 475 }
 476
 477 #endif /* CONFIG_DEBUG_FS */