drivers/gpu/drm/drm_proc.c

   1 /**
   2  * \file drm_proc.c
   3  * /proc support for DRM
   4  *
   5  * \author Rickard E. (Rik) Faith <faith@valinux.com>
   6  * \author Gareth Hughes <gareth@valinux.com>
   7  *
   8  * \par Acknowledgements:
   9  *    Matthew J Sottek <matthew.j.sottek@intel.com> sent in a patch to fix
  10  *    the problem with the proc files not outputting all their information.
  11  */
  12
  13 /*
  14  * Created: Mon Jan 11 09:48:47 1999 by faith@valinux.com
  15  *
  16  * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
  17  * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
  18  * All Rights Reserved.
  19  *
  20  * Permission is hereby granted, free of charge, to any person obtaining a
  21  * copy of this software and associated documentation files (the "Software"),
  22  * to deal in the Software without restriction, including without limitation
  23  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  24  * and/or sell copies of the Software, and to permit persons to whom the
  25  * Software is furnished to do so, subject to the following conditions:
  26  *
  27  * The above copyright notice and this permission notice (including the next
  28  * paragraph) shall be included in all copies or substantial portions of the
  29  * Software.
  30  *
  31  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  32  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  33  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  34  * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  35  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  36  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  37  * OTHER DEALINGS IN THE SOFTWARE.
  38  */
  39
  40 #include <linux/seq_file.h>
  41 #include "drmP.h"
  42
  43
  44 /***************************************************
  45  * Initialization, etc.
  46  **************************************************/
  47
  48 /**
  49  * Proc file list.
  50  */
  51 static struct drm_info_list drm_proc_list[] = {
  52         {"name", drm_name_info, 0},
  53         {"vm", drm_vm_info, 0},
  54         {"clients", drm_clients_info, 0},
  55         {"queues", drm_queues_info, 0},
  56         {"bufs", drm_bufs_info, 0},
  57         {"gem_names", drm_gem_name_info, DRIVER_GEM},
  58         {"gem_objects", drm_gem_object_info, DRIVER_GEM},
  59 #if DRM_DEBUG_CODE
  60         {"vma", drm_vma_info, 0},
  61 #endif
  62 };
  63 #define DRM_PROC_ENTRIES ARRAY_SIZE(drm_proc_list)
  64
  65 static int drm_proc_open(struct inode *inode, struct file *file)
  66 {
  67         struct drm_info_node* node = PDE(inode)->data;
  68
  69         return single_open(file, node->info_ent->show, node);
  70 }
  71
  72 static const struct file_operations drm_proc_fops = {
  73         .owner = THIS_MODULE,
  74         .open = drm_proc_open,
  75         .read = seq_read,
  76         .llseek = seq_lseek,
  77         .release = single_release,
  78 };
  79
  80
  81 /**
  82  * Initialize a given set of proc files for a device
  83  *
  84  * \param files The array of files to create
  85  * \param count The number of files given
  86  * \param root DRI proc dir entry.
  87  * \param minor device minor number
  88  * \return Zero on success, non-zero on failure
  89  *
  90  * Create a given set of proc files represented by an array of
  91  * gdm_proc_lists in the given root directory.
  92  */
  93 int drm_proc_create_files(struct drm_info_list *files, int count,
  94                           struct proc_dir_entry *root, struct drm_minor *minor)
  95 {
  96         struct drm_device *dev = minor->dev;
  97         struct proc_dir_entry *ent;
  98         struct drm_info_node *tmp;
  99         char name[64];
 100         int i, ret;
 101
 102         for (i = 0; i < count; i++) {
 103                 u32 features = files[i].driver_features;
 104
 105                 if (features != 0 &&
 106                     (dev->driver->driver_features & features) != features)
 107                         continue;
 108
 109                 tmp = drm_alloc(sizeof(struct drm_info_node), _DRM_DRIVER);
 110                 ent = create_proc_entry(files[i].name, S_IFREG | S_IRUGO, root);
 111                 if (!ent) {
 112                         DRM_ERROR("Cannot create /proc/dri/%s/%s\n",
 113                                   name, files[i].name);
 114                         drm_free(tmp, sizeof(struct drm_info_node),
 115                                  _DRM_DRIVER);
 116                         ret = -1;
 117                         goto fail;
 118                 }
 119
 120                 ent->proc_fops = &drm_proc_fops;
 121                 ent->data = tmp;
 122                 tmp->minor = minor;
 123                 tmp->info_ent = &files[i];
 124                 list_add(&(tmp->list), &(minor->proc_nodes.list));
 125         }
 126         return 0;
 127
 128 fail:
 129         for (i = 0; i < count; i++)
 130                 remove_proc_entry(drm_proc_list[i].name, minor->proc_root);
 131         return ret;
 132 }
 133
 134 /**
 135  * Initialize the DRI proc filesystem for a device
 136  *
 137  * \param dev DRM device
 138  * \param minor device minor number
 139  * \param root DRI proc dir entry.
 140  * \param dev_root resulting DRI device proc dir entry.
 141  * \return root entry pointer on success, or NULL on failure.
 142  *
 143  * Create the DRI proc root entry "/proc/dri", the device proc root entry
 144  * "/proc/dri/%minor%/", and each entry in proc_list as
 145  * "/proc/dri/%minor%/%name%".
 146  */
 147 int drm_proc_init(struct drm_minor *minor, int minor_id,
 148                   struct proc_dir_entry *root)
 149 {
 150         struct drm_device *dev = minor->dev;
 151         char name[64];
 152         int ret;
 153
 154         INIT_LIST_HEAD(&minor->proc_nodes.list);
 155         sprintf(name, "%d", minor_id);
 156         minor->proc_root = proc_mkdir(name, root);
 157         if (!minor->proc_root) {
 158                 DRM_ERROR("Cannot create /proc/dri/%s\n", name);
 159                 return -1;
 160         }
 161
 162         ret = drm_proc_create_files(drm_proc_list, DRM_PROC_ENTRIES,
 163                                     minor->proc_root, minor);
 164         if (ret) {
 165                 remove_proc_entry(name, root);
 166                 minor->proc_root = NULL;
 167                 DRM_ERROR("Failed to create core drm proc files\n");
 168                 return ret;
 169         }
 170
 171         if (dev->driver->proc_init) {
 172                 ret = dev->driver->proc_init(minor);
 173                 if (ret) {
 174                         DRM_ERROR("DRM: Driver failed to initialize "
 175                                   "/proc/dri.\n");
 176                         return ret;
 177                 }
 178         }
 179         return 0;
 180 }
 181
 182 int drm_proc_remove_files(struct drm_info_list *files, int count,
 183                           struct drm_minor *minor)
 184 {
 185         struct list_head *pos, *q;
 186         struct drm_info_node *tmp;
 187         int i;
 188
 189         for (i = 0; i < count; i++) {
 190                 list_for_each_safe(pos, q, &minor->proc_nodes.list) {
 191                         tmp = list_entry(pos, struct drm_info_node, list);
 192                         if (tmp->info_ent == &files[i]) {
 193                                 remove_proc_entry(files[i].name,
 194                                                   minor->proc_root);
 195                                 list_del(pos);
 196                                 drm_free(tmp, sizeof(struct drm_info_node),
 197                                          _DRM_DRIVER);
 198                         }
 199                 }
 200         }
 201         return 0;
 202 }
 203
 204 /**
 205  * Cleanup the proc filesystem resources.
 206  *
 207  * \param minor device minor number.
 208  * \param root DRI proc dir entry.
 209  * \param dev_root DRI device proc dir entry.
 210  * \return always zero.
 211  *
 212  * Remove all proc entries created by proc_init().
 213  */
 214 int drm_proc_cleanup(struct drm_minor *minor, struct proc_dir_entry *root)
 215 {
 216         struct drm_device *dev = minor->dev;
 217         char name[64];
 218
 219         if (!root || !minor->proc_root)
 220                 return 0;
 221
 222         if (dev->driver->proc_cleanup)
 223                 dev->driver->proc_cleanup(minor);
 224
 225         drm_proc_remove_files(drm_proc_list, DRM_PROC_ENTRIES, minor);
 226
 227         sprintf(name, "%d", minor->index);
 228         remove_proc_entry(name, root);
 229
 230         return 0;
 231 }
 232