3 * IOCTLs for authentication
5 * \author Rickard E. (Rik) Faith <faith@valinux.com>
6 * \author Gareth Hughes <gareth@valinux.com>
10 * Created: Tue Feb 2 08:37:54 1999 by faith@valinux.com
12 * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
13 * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
14 * All Rights Reserved.
16 * Permission is hereby granted, free of charge, to any person obtaining a
17 * copy of this software and associated documentation files (the "Software"),
18 * to deal in the Software without restriction, including without limitation
19 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
20 * and/or sell copies of the Software, and to permit persons to whom the
21 * Software is furnished to do so, subject to the following conditions:
23 * The above copyright notice and this permission notice (including the next
24 * paragraph) shall be included in all copies or substantial portions of the
27 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
28 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
29 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
30 * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
31 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
32 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
33 * OTHER DEALINGS IN THE SOFTWARE.
37 #include "drm_internal.h"
40 * Find the file with the given magic number.
42 * \param dev DRM device.
43 * \param magic magic number.
45 * Searches in drm_device::magiclist within all files with the same hash key
46 * the one with matching magic number, while holding the drm_device::struct_mutex
49 static struct drm_file *drm_find_file(struct drm_device *dev, drm_magic_t magic)
51 struct drm_file *retval = NULL;
52 struct drm_magic_entry *pt;
53 struct drm_hash_item *hash;
55 mutex_lock(&dev->struct_mutex);
56 if (!drm_ht_find_item(&dev->magiclist, (unsigned long)magic, &hash)) {
57 pt = drm_hash_entry(hash, struct drm_magic_entry, hash_item);
60 mutex_unlock(&dev->struct_mutex);
65 * Inserts the given magic number into the hash table of used magic number
68 static int drm_add_magic(struct drm_device *dev, struct drm_file *priv,
71 struct drm_magic_entry *entry;
73 DRM_DEBUG("%d\n", magic);
75 entry = kzalloc(sizeof(*entry), GFP_KERNEL);
79 entry->hash_item.key = (unsigned long)magic;
80 mutex_lock(&dev->struct_mutex);
81 drm_ht_insert_item(&dev->magiclist, &entry->hash_item);
82 list_add_tail(&entry->head, &dev->magicfree);
83 mutex_unlock(&dev->struct_mutex);
89 * Removes the given magic number from the hash table of used magic number
92 int drm_remove_magic(struct drm_device *dev, drm_magic_t magic)
94 struct drm_magic_entry *pt;
95 struct drm_hash_item *hash;
97 DRM_DEBUG("%d\n", magic);
99 mutex_lock(&dev->struct_mutex);
100 if (drm_ht_find_item(&dev->magiclist, (unsigned long)magic, &hash)) {
101 mutex_unlock(&dev->struct_mutex);
104 pt = drm_hash_entry(hash, struct drm_magic_entry, hash_item);
105 drm_ht_remove_item(&dev->magiclist, hash);
107 mutex_unlock(&dev->struct_mutex);
115 * Get a unique magic number (ioctl).
117 * \param inode device inode.
118 * \param file_priv DRM file private.
119 * \param cmd command.
120 * \param arg pointer to a resulting drm_auth structure.
121 * \return zero on success, or a negative number on failure.
123 * If there is a magic number in drm_file::magic then use it, otherwise
124 * searches an unique non-zero magic number and add it associating it with \p
126 * This ioctl needs protection by the drm_global_mutex, which protects
127 * struct drm_file::magic and struct drm_magic_entry::priv.
129 int drm_getmagic(struct drm_device *dev, void *data, struct drm_file *file_priv)
131 static drm_magic_t sequence = 0;
132 static struct spinlock lock = SPINLOCK_INITIALIZER(&lock, "drm_gm");
133 struct drm_auth *auth = data;
135 /* Find unique magic */
136 if (file_priv->magic) {
137 auth->magic = file_priv->magic;
142 ++sequence; /* reserve 0 */
143 auth->magic = sequence++;
145 } while (drm_find_file(dev, auth->magic));
146 file_priv->magic = auth->magic;
147 drm_add_magic(dev, file_priv, auth->magic);
150 DRM_DEBUG("%u\n", auth->magic);
156 * Authenticate with a magic.
158 * \param inode device inode.
159 * \param file_priv DRM file private.
160 * \param cmd command.
161 * \param arg pointer to a drm_auth structure.
162 * \return zero if authentication successed, or a negative number otherwise.
164 * Checks if \p file_priv is associated with the magic number passed in \arg.
165 * This ioctl needs protection by the drm_global_mutex, which protects
166 * struct drm_file::magic and struct drm_magic_entry::priv.
168 int drm_authmagic(struct drm_device *dev, void *data,
169 struct drm_file *file_priv)
171 struct drm_auth *auth = data;
172 struct drm_file *file;
174 DRM_DEBUG("%u\n", auth->magic);
175 if ((file = drm_find_file(dev, auth->magic))) {
176 file->authenticated = 1;
177 drm_remove_magic(dev, auth->magic);