blob: 2a37586a7ee8d4e7ca856723f27be808e6649005 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/**
Dave Airlieb5e89ed2005-09-25 14:28:13 +10002 * \file drm_auth.c
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 * IOCTLs for authentication
4 *
5 * \author Rickard E. (Rik) Faith <faith@valinux.com>
6 * \author Gareth Hughes <gareth@valinux.com>
7 */
8
9/*
10 * Created: Tue Feb 2 08:37:54 1999 by faith@valinux.com
11 *
12 * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
13 * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
14 * All Rights Reserved.
15 *
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:
22 *
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
25 * Software.
26 *
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.
34 */
35
36#include "drmP.h"
37
38/**
39 * Generate a hash key from a magic.
40 *
41 * \param magic magic.
42 * \return hash key.
43 *
44 * The key is the modulus of the hash table size, #DRM_HASH_SIZE, which must be
45 * a power of 2.
46 */
47static int drm_hash_magic(drm_magic_t magic)
48{
Dave Airlieb5e89ed2005-09-25 14:28:13 +100049 return magic & (DRM_HASH_SIZE - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -070050}
51
52/**
53 * Find the file with the given magic number.
54 *
55 * \param dev DRM device.
56 * \param magic magic number.
57 *
58 * Searches in drm_device::magiclist within all files with the same hash key
Dave Airlie30e2fb12006-02-02 19:37:46 +110059 * the one with matching magic number, while holding the drm_device::struct_mutex
Linus Torvalds1da177e2005-04-16 15:20:36 -070060 * lock.
61 */
Dave Airlieb5e89ed2005-09-25 14:28:13 +100062static drm_file_t *drm_find_file(drm_device_t * dev, drm_magic_t magic)
Linus Torvalds1da177e2005-04-16 15:20:36 -070063{
Dave Airlieb5e89ed2005-09-25 14:28:13 +100064 drm_file_t *retval = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -070065 drm_magic_entry_t *pt;
Dave Airlieb5e89ed2005-09-25 14:28:13 +100066 int hash = drm_hash_magic(magic);
Linus Torvalds1da177e2005-04-16 15:20:36 -070067
Dave Airlie30e2fb12006-02-02 19:37:46 +110068 mutex_lock(&dev->struct_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -070069 for (pt = dev->magiclist[hash].head; pt; pt = pt->next) {
70 if (pt->magic == magic) {
71 retval = pt->priv;
72 break;
73 }
74 }
Dave Airlie30e2fb12006-02-02 19:37:46 +110075 mutex_unlock(&dev->struct_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -070076 return retval;
77}
78
79/**
80 * Adds a magic number.
Dave Airlieb5e89ed2005-09-25 14:28:13 +100081 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070082 * \param dev DRM device.
83 * \param priv file private data.
84 * \param magic magic number.
85 *
86 * Creates a drm_magic_entry structure and appends to the linked list
87 * associated the magic number hash key in drm_device::magiclist, while holding
Dave Airlie30e2fb12006-02-02 19:37:46 +110088 * the drm_device::struct_mutex lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -070089 */
Dave Airlieb5e89ed2005-09-25 14:28:13 +100090static int drm_add_magic(drm_device_t * dev, drm_file_t * priv,
91 drm_magic_t magic)
Linus Torvalds1da177e2005-04-16 15:20:36 -070092{
Dave Airlieb5e89ed2005-09-25 14:28:13 +100093 int hash;
Linus Torvalds1da177e2005-04-16 15:20:36 -070094 drm_magic_entry_t *entry;
95
96 DRM_DEBUG("%d\n", magic);
97
Dave Airlieb5e89ed2005-09-25 14:28:13 +100098 hash = drm_hash_magic(magic);
99 entry = drm_alloc(sizeof(*entry), DRM_MEM_MAGIC);
100 if (!entry)
101 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102 memset(entry, 0, sizeof(*entry));
103 entry->magic = magic;
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000104 entry->priv = priv;
105 entry->next = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106
Dave Airlie30e2fb12006-02-02 19:37:46 +1100107 mutex_lock(&dev->struct_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108 if (dev->magiclist[hash].tail) {
109 dev->magiclist[hash].tail->next = entry;
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000110 dev->magiclist[hash].tail = entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111 } else {
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000112 dev->magiclist[hash].head = entry;
113 dev->magiclist[hash].tail = entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114 }
Dave Airlie30e2fb12006-02-02 19:37:46 +1100115 mutex_unlock(&dev->struct_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116
117 return 0;
118}
119
120/**
121 * Remove a magic number.
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000122 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123 * \param dev DRM device.
124 * \param magic magic number.
125 *
126 * Searches and unlinks the entry in drm_device::magiclist with the magic
Dave Airlie30e2fb12006-02-02 19:37:46 +1100127 * number hash key, while holding the drm_device::struct_mutex lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128 */
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000129static int drm_remove_magic(drm_device_t * dev, drm_magic_t magic)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130{
131 drm_magic_entry_t *prev = NULL;
132 drm_magic_entry_t *pt;
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000133 int hash;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134
135 DRM_DEBUG("%d\n", magic);
136 hash = drm_hash_magic(magic);
137
Dave Airlie30e2fb12006-02-02 19:37:46 +1100138 mutex_lock(&dev->struct_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139 for (pt = dev->magiclist[hash].head; pt; prev = pt, pt = pt->next) {
140 if (pt->magic == magic) {
141 if (dev->magiclist[hash].head == pt) {
142 dev->magiclist[hash].head = pt->next;
143 }
144 if (dev->magiclist[hash].tail == pt) {
145 dev->magiclist[hash].tail = prev;
146 }
147 if (prev) {
148 prev->next = pt->next;
149 }
Dave Airlie30e2fb12006-02-02 19:37:46 +1100150 mutex_unlock(&dev->struct_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151 return 0;
152 }
153 }
Dave Airlie30e2fb12006-02-02 19:37:46 +1100154 mutex_unlock(&dev->struct_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155
156 drm_free(pt, sizeof(*pt), DRM_MEM_MAGIC);
157
158 return -EINVAL;
159}
160
161/**
162 * Get a unique magic number (ioctl).
163 *
164 * \param inode device inode.
165 * \param filp file pointer.
166 * \param cmd command.
167 * \param arg pointer to a resulting drm_auth structure.
168 * \return zero on success, or a negative number on failure.
169 *
170 * If there is a magic number in drm_file::magic then use it, otherwise
171 * searches an unique non-zero magic number and add it associating it with \p
172 * filp.
173 */
174int drm_getmagic(struct inode *inode, struct file *filp,
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000175 unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176{
177 static drm_magic_t sequence = 0;
178 static DEFINE_SPINLOCK(lock);
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000179 drm_file_t *priv = filp->private_data;
180 drm_device_t *dev = priv->head->dev;
181 drm_auth_t auth;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000183 /* Find unique magic */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184 if (priv->magic) {
185 auth.magic = priv->magic;
186 } else {
187 do {
188 spin_lock(&lock);
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000189 if (!sequence)
190 ++sequence; /* reserve 0 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 auth.magic = sequence++;
192 spin_unlock(&lock);
193 } while (drm_find_file(dev, auth.magic));
194 priv->magic = auth.magic;
195 drm_add_magic(dev, priv, auth.magic);
196 }
197
198 DRM_DEBUG("%u\n", auth.magic);
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000199 if (copy_to_user((drm_auth_t __user *) arg, &auth, sizeof(auth)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200 return -EFAULT;
201 return 0;
202}
203
204/**
205 * Authenticate with a magic.
206 *
207 * \param inode device inode.
208 * \param filp file pointer.
209 * \param cmd command.
210 * \param arg pointer to a drm_auth structure.
211 * \return zero if authentication successed, or a negative number otherwise.
212 *
213 * Checks if \p filp is associated with the magic number passed in \arg.
214 */
215int drm_authmagic(struct inode *inode, struct file *filp,
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000216 unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217{
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000218 drm_file_t *priv = filp->private_data;
219 drm_device_t *dev = priv->head->dev;
220 drm_auth_t auth;
221 drm_file_t *file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000223 if (copy_from_user(&auth, (drm_auth_t __user *) arg, sizeof(auth)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224 return -EFAULT;
225 DRM_DEBUG("%u\n", auth.magic);
226 if ((file = drm_find_file(dev, auth.magic))) {
227 file->authenticated = 1;
228 drm_remove_magic(dev, auth.magic);
229 return 0;
230 }
231 return -EINVAL;
232}