blob: ba23790450e9d4877ec8721ed5280140a18272ea [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/**
Linus Torvalds1da177e2005-04-16 15:20:36 -070039 * Find the file with the given magic number.
40 *
41 * \param dev DRM device.
42 * \param magic magic number.
43 *
44 * Searches in drm_device::magiclist within all files with the same hash key
Dave Airlie30e2fb12006-02-02 19:37:46 +110045 * the one with matching magic number, while holding the drm_device::struct_mutex
Linus Torvalds1da177e2005-04-16 15:20:36 -070046 * lock.
47 */
Dave Airlie7c1c2872008-11-28 14:22:24 +100048static struct drm_file *drm_find_file(struct drm_master *master, drm_magic_t magic)
Linus Torvalds1da177e2005-04-16 15:20:36 -070049{
Dave Airlie84b1fd12007-07-11 15:53:27 +100050 struct drm_file *retval = NULL;
Dave Airlie8fc2fdf2007-07-11 16:21:47 +100051 struct drm_magic_entry *pt;
Dave Airliee0be4282007-07-12 10:26:44 +100052 struct drm_hash_item *hash;
Dave Airlie7c1c2872008-11-28 14:22:24 +100053 struct drm_device *dev = master->minor->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -070054
Dave Airlie30e2fb12006-02-02 19:37:46 +110055 mutex_lock(&dev->struct_mutex);
Dave Airlie7c1c2872008-11-28 14:22:24 +100056 if (!drm_ht_find_item(&master->magiclist, (unsigned long)magic, &hash)) {
Dave Airlie8fc2fdf2007-07-11 16:21:47 +100057 pt = drm_hash_entry(hash, struct drm_magic_entry, hash_item);
Thomas Hellstrom8669cbc2006-08-07 22:22:10 +100058 retval = pt->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -070059 }
Dave Airlie30e2fb12006-02-02 19:37:46 +110060 mutex_unlock(&dev->struct_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -070061 return retval;
62}
63
64/**
65 * Adds a magic number.
Dave Airlieb5e89ed2005-09-25 14:28:13 +100066 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070067 * \param dev DRM device.
68 * \param priv file private data.
69 * \param magic magic number.
70 *
71 * Creates a drm_magic_entry structure and appends to the linked list
72 * associated the magic number hash key in drm_device::magiclist, while holding
Dave Airlie30e2fb12006-02-02 19:37:46 +110073 * the drm_device::struct_mutex lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -070074 */
Dave Airlie7c1c2872008-11-28 14:22:24 +100075static int drm_add_magic(struct drm_master *master, struct drm_file *priv,
Dave Airlieb5e89ed2005-09-25 14:28:13 +100076 drm_magic_t magic)
Linus Torvalds1da177e2005-04-16 15:20:36 -070077{
Dave Airlie8fc2fdf2007-07-11 16:21:47 +100078 struct drm_magic_entry *entry;
Dave Airlie7c1c2872008-11-28 14:22:24 +100079 struct drm_device *dev = master->minor->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -070080 DRM_DEBUG("%d\n", magic);
81
Julia Lawall6ebc22e2010-05-13 21:58:56 +020082 entry = kzalloc(sizeof(*entry), GFP_KERNEL);
Dave Airlieb5e89ed2005-09-25 14:28:13 +100083 if (!entry)
84 return -ENOMEM;
Dave Airlieb5e89ed2005-09-25 14:28:13 +100085 entry->priv = priv;
Thomas Hellstrom8669cbc2006-08-07 22:22:10 +100086 entry->hash_item.key = (unsigned long)magic;
Dave Airlie30e2fb12006-02-02 19:37:46 +110087 mutex_lock(&dev->struct_mutex);
Dave Airlie7c1c2872008-11-28 14:22:24 +100088 drm_ht_insert_item(&master->magiclist, &entry->hash_item);
89 list_add_tail(&entry->head, &master->magicfree);
Dave Airlie30e2fb12006-02-02 19:37:46 +110090 mutex_unlock(&dev->struct_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -070091
92 return 0;
93}
94
95/**
96 * Remove a magic number.
Dave Airlieb5e89ed2005-09-25 14:28:13 +100097 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070098 * \param dev DRM device.
99 * \param magic magic number.
100 *
101 * Searches and unlinks the entry in drm_device::magiclist with the magic
Dave Airlie30e2fb12006-02-02 19:37:46 +1100102 * number hash key, while holding the drm_device::struct_mutex lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103 */
Thomas Hellstrom598781d2012-01-24 18:54:21 +0100104int drm_remove_magic(struct drm_master *master, drm_magic_t magic)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105{
Dave Airlie8fc2fdf2007-07-11 16:21:47 +1000106 struct drm_magic_entry *pt;
Dave Airliee0be4282007-07-12 10:26:44 +1000107 struct drm_hash_item *hash;
Dave Airlie7c1c2872008-11-28 14:22:24 +1000108 struct drm_device *dev = master->minor->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109
110 DRM_DEBUG("%d\n", magic);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111
Dave Airlie30e2fb12006-02-02 19:37:46 +1100112 mutex_lock(&dev->struct_mutex);
Dave Airlie7c1c2872008-11-28 14:22:24 +1000113 if (drm_ht_find_item(&master->magiclist, (unsigned long)magic, &hash)) {
Thomas Hellstrom8669cbc2006-08-07 22:22:10 +1000114 mutex_unlock(&dev->struct_mutex);
115 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116 }
Dave Airlie8fc2fdf2007-07-11 16:21:47 +1000117 pt = drm_hash_entry(hash, struct drm_magic_entry, hash_item);
Dave Airlie7c1c2872008-11-28 14:22:24 +1000118 drm_ht_remove_item(&master->magiclist, hash);
Thomas Hellstrom8669cbc2006-08-07 22:22:10 +1000119 list_del(&pt->head);
Dave Airlie30e2fb12006-02-02 19:37:46 +1100120 mutex_unlock(&dev->struct_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121
Eric Anholt9a298b22009-03-24 12:23:04 -0700122 kfree(pt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123
Dave Airlie572225b2006-08-08 22:17:02 +1000124 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125}
126
127/**
128 * Get a unique magic number (ioctl).
129 *
130 * \param inode device inode.
Eric Anholt6c340ea2007-08-25 20:23:09 +1000131 * \param file_priv DRM file private.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132 * \param cmd command.
133 * \param arg pointer to a resulting drm_auth structure.
134 * \return zero on success, or a negative number on failure.
135 *
136 * If there is a magic number in drm_file::magic then use it, otherwise
137 * searches an unique non-zero magic number and add it associating it with \p
Eric Anholt6c340ea2007-08-25 20:23:09 +1000138 * file_priv.
Thomas Hellstrom598781d2012-01-24 18:54:21 +0100139 * This ioctl needs protection by the drm_global_mutex, which protects
140 * struct drm_file::magic and struct drm_magic_entry::priv.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141 */
Eric Anholtc153f452007-09-03 12:06:45 +1000142int drm_getmagic(struct drm_device *dev, void *data, struct drm_file *file_priv)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143{
144 static drm_magic_t sequence = 0;
145 static DEFINE_SPINLOCK(lock);
Eric Anholtc153f452007-09-03 12:06:45 +1000146 struct drm_auth *auth = data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000148 /* Find unique magic */
Eric Anholt6c340ea2007-08-25 20:23:09 +1000149 if (file_priv->magic) {
Eric Anholtc153f452007-09-03 12:06:45 +1000150 auth->magic = file_priv->magic;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151 } else {
152 do {
153 spin_lock(&lock);
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000154 if (!sequence)
155 ++sequence; /* reserve 0 */
Eric Anholtc153f452007-09-03 12:06:45 +1000156 auth->magic = sequence++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157 spin_unlock(&lock);
Dave Airlie7c1c2872008-11-28 14:22:24 +1000158 } while (drm_find_file(file_priv->master, auth->magic));
Eric Anholtc153f452007-09-03 12:06:45 +1000159 file_priv->magic = auth->magic;
Dave Airlie7c1c2872008-11-28 14:22:24 +1000160 drm_add_magic(file_priv->master, file_priv, auth->magic);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161 }
162
Eric Anholtc153f452007-09-03 12:06:45 +1000163 DRM_DEBUG("%u\n", auth->magic);
164
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165 return 0;
166}
167
168/**
169 * Authenticate with a magic.
170 *
171 * \param inode device inode.
Eric Anholt6c340ea2007-08-25 20:23:09 +1000172 * \param file_priv DRM file private.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173 * \param cmd command.
174 * \param arg pointer to a drm_auth structure.
175 * \return zero if authentication successed, or a negative number otherwise.
176 *
Eric Anholt6c340ea2007-08-25 20:23:09 +1000177 * Checks if \p file_priv is associated with the magic number passed in \arg.
Thomas Hellstrom598781d2012-01-24 18:54:21 +0100178 * This ioctl needs protection by the drm_global_mutex, which protects
179 * struct drm_file::magic and struct drm_magic_entry::priv.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180 */
Eric Anholtc153f452007-09-03 12:06:45 +1000181int drm_authmagic(struct drm_device *dev, void *data,
182 struct drm_file *file_priv)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183{
Eric Anholtc153f452007-09-03 12:06:45 +1000184 struct drm_auth *auth = data;
Dave Airlie84b1fd12007-07-11 15:53:27 +1000185 struct drm_file *file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186
Eric Anholtc153f452007-09-03 12:06:45 +1000187 DRM_DEBUG("%u\n", auth->magic);
Dave Airlie7c1c2872008-11-28 14:22:24 +1000188 if ((file = drm_find_file(file_priv->master, auth->magic))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189 file->authenticated = 1;
Dave Airlie7c1c2872008-11-28 14:22:24 +1000190 drm_remove_magic(file_priv->master, auth->magic);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 return 0;
192 }
193 return -EINVAL;
194}