drm/i915: export error state ref handling
[deliverable/linux.git] / drivers / gpu / drm / drm_context.c
CommitLineData
1da177e4 1/**
b5e89ed5 2 * \file drm_context.c
1da177e4 3 * IOCTLs for generic contexts
b5e89ed5 4 *
1da177e4
LT
5 * \author Rickard E. (Rik) Faith <faith@valinux.com>
6 * \author Gareth Hughes <gareth@valinux.com>
7 */
8
9/*
10 * Created: Fri Nov 24 18:31:37 2000 by gareth@valinux.com
11 *
12 * Copyright 1999, 2000 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/*
37 * ChangeLog:
38 * 2001-11-16 Torsten Duwe <duwe@caldera.de>
39 * added context constructor/destructor hooks,
40 * needed by SiS driver's memory management.
41 */
42
760285e7 43#include <drm/drmP.h>
1da177e4
LT
44
45/******************************************************************/
46/** \name Context bitmap support */
47/*@{*/
48
49/**
50 * Free a handle from the context bitmap.
51 *
52 * \param dev DRM device.
53 * \param ctx_handle context handle.
54 *
55 * Clears the bit specified by \p ctx_handle in drm_device::ctx_bitmap and the entry
62968144 56 * in drm_device::ctx_idr, while holding the drm_device::struct_mutex
1da177e4
LT
57 * lock.
58 */
84b1fd10 59void drm_ctxbitmap_free(struct drm_device * dev, int ctx_handle)
1da177e4 60{
62968144
DA
61 mutex_lock(&dev->struct_mutex);
62 idr_remove(&dev->ctx_idr, ctx_handle);
63 mutex_unlock(&dev->struct_mutex);
1da177e4
LT
64}
65
b5e89ed5 66/**
1da177e4
LT
67 * Context bitmap allocation.
68 *
69 * \param dev DRM device.
70 * \return (non-negative) context handle on success or a negative number on failure.
71 *
62968144 72 * Allocate a new idr from drm_device::ctx_idr while holding the
30e2fb18 73 * drm_device::struct_mutex lock.
1da177e4 74 */
84b1fd10 75static int drm_ctxbitmap_next(struct drm_device * dev)
1da177e4 76{
62968144 77 int ret;
1da177e4 78
30e2fb18 79 mutex_lock(&dev->struct_mutex);
2e928815
TH
80 ret = idr_alloc(&dev->ctx_idr, NULL, DRM_RESERVED_CONTEXTS, 0,
81 GFP_KERNEL);
30e2fb18 82 mutex_unlock(&dev->struct_mutex);
2e928815 83 return ret;
1da177e4
LT
84}
85
86/**
87 * Context bitmap initialization.
88 *
89 * \param dev DRM device.
90 *
62968144 91 * Initialise the drm_device::ctx_idr
1da177e4 92 */
84b1fd10 93int drm_ctxbitmap_init(struct drm_device * dev)
1da177e4 94{
62968144 95 idr_init(&dev->ctx_idr);
1da177e4
LT
96 return 0;
97}
98
99/**
100 * Context bitmap cleanup.
101 *
102 * \param dev DRM device.
103 *
62968144
DA
104 * Free all idr members using drm_ctx_sarea_free helper function
105 * while holding the drm_device::struct_mutex lock.
1da177e4 106 */
84b1fd10 107void drm_ctxbitmap_cleanup(struct drm_device * dev)
1da177e4 108{
30e2fb18 109 mutex_lock(&dev->struct_mutex);
4d53233a 110 idr_destroy(&dev->ctx_idr);
30e2fb18 111 mutex_unlock(&dev->struct_mutex);
1da177e4
LT
112}
113
114/*@}*/
115
116/******************************************************************/
117/** \name Per Context SAREA Support */
118/*@{*/
119
120/**
121 * Get per-context SAREA.
b5e89ed5 122 *
1da177e4 123 * \param inode device inode.
6c340eac 124 * \param file_priv DRM file private.
1da177e4
LT
125 * \param cmd command.
126 * \param arg user argument pointing to a drm_ctx_priv_map structure.
127 * \return zero on success or a negative number on failure.
128 *
62968144 129 * Gets the map from drm_device::ctx_idr with the handle specified and
1da177e4
LT
130 * returns its handle.
131 */
c153f45f
EA
132int drm_getsareactx(struct drm_device *dev, void *data,
133 struct drm_file *file_priv)
1da177e4 134{
c153f45f 135 struct drm_ctx_priv_map *request = data;
f77d390c 136 struct drm_local_map *map;
55910517 137 struct drm_map_list *_entry;
1da177e4 138
30e2fb18 139 mutex_lock(&dev->struct_mutex);
62968144 140
c153f45f 141 map = idr_find(&dev->ctx_idr, request->ctx_id);
62968144 142 if (!map) {
30e2fb18 143 mutex_unlock(&dev->struct_mutex);
1da177e4
LT
144 return -EINVAL;
145 }
146
c153f45f 147 request->handle = NULL;
bd1b331f 148 list_for_each_entry(_entry, &dev->maplist, head) {
d1f2b55a 149 if (_entry->map == map) {
bc5f4523 150 request->handle =
b5e89ed5 151 (void *)(unsigned long)_entry->user_token;
d1f2b55a
DA
152 break;
153 }
154 }
09b4ea47
IH
155
156 mutex_unlock(&dev->struct_mutex);
157
c153f45f 158 if (request->handle == NULL)
d1f2b55a
DA
159 return -EINVAL;
160
1da177e4
LT
161 return 0;
162}
163
164/**
165 * Set per-context SAREA.
b5e89ed5 166 *
1da177e4 167 * \param inode device inode.
6c340eac 168 * \param file_priv DRM file private.
1da177e4
LT
169 * \param cmd command.
170 * \param arg user argument pointing to a drm_ctx_priv_map structure.
171 * \return zero on success or a negative number on failure.
172 *
173 * Searches the mapping specified in \p arg and update the entry in
62968144 174 * drm_device::ctx_idr with it.
1da177e4 175 */
c153f45f
EA
176int drm_setsareactx(struct drm_device *dev, void *data,
177 struct drm_file *file_priv)
1da177e4 178{
c153f45f 179 struct drm_ctx_priv_map *request = data;
f77d390c 180 struct drm_local_map *map = NULL;
55910517 181 struct drm_map_list *r_list = NULL;
1da177e4 182
30e2fb18 183 mutex_lock(&dev->struct_mutex);
bd1b331f 184 list_for_each_entry(r_list, &dev->maplist, head) {
9a186645 185 if (r_list->map
c153f45f 186 && r_list->user_token == (unsigned long) request->handle)
1da177e4
LT
187 goto found;
188 }
b5e89ed5 189 bad:
30e2fb18 190 mutex_unlock(&dev->struct_mutex);
1da177e4
LT
191 return -EINVAL;
192
b5e89ed5 193 found:
1da177e4 194 map = r_list->map;
b5e89ed5
DA
195 if (!map)
196 goto bad;
62968144 197
c153f45f 198 if (IS_ERR(idr_replace(&dev->ctx_idr, map, request->ctx_id)))
1da177e4 199 goto bad;
62968144 200
30e2fb18 201 mutex_unlock(&dev->struct_mutex);
c153f45f 202
1da177e4
LT
203 return 0;
204}
205
206/*@}*/
207
208/******************************************************************/
209/** \name The actual DRM context handling routines */
210/*@{*/
211
212/**
213 * Switch context.
214 *
215 * \param dev DRM device.
216 * \param old old context handle.
217 * \param new new context handle.
218 * \return zero on success or a negative number on failure.
219 *
220 * Attempt to set drm_device::context_flag.
221 */
84b1fd10 222static int drm_context_switch(struct drm_device * dev, int old, int new)
1da177e4 223{
b5e89ed5
DA
224 if (test_and_set_bit(0, &dev->context_flag)) {
225 DRM_ERROR("Reentering -- FIXME\n");
226 return -EBUSY;
227 }
1da177e4 228
b5e89ed5 229 DRM_DEBUG("Context switch from %d to %d\n", old, new);
1da177e4 230
b5e89ed5
DA
231 if (new == dev->last_context) {
232 clear_bit(0, &dev->context_flag);
233 return 0;
234 }
1da177e4 235
b5e89ed5 236 return 0;
1da177e4
LT
237}
238
239/**
240 * Complete context switch.
241 *
242 * \param dev DRM device.
243 * \param new new context handle.
244 * \return zero on success or a negative number on failure.
245 *
246 * Updates drm_device::last_context and drm_device::last_switch. Verifies the
247 * hardware lock is held, clears the drm_device::context_flag and wakes up
248 * drm_device::context_wait.
249 */
7c1c2871
DA
250static int drm_context_switch_complete(struct drm_device *dev,
251 struct drm_file *file_priv, int new)
1da177e4 252{
b5e89ed5
DA
253 dev->last_context = new; /* PRE/POST: This is the _only_ writer. */
254 dev->last_switch = jiffies;
1da177e4 255
7c1c2871 256 if (!_DRM_LOCK_IS_HELD(file_priv->master->lock.hw_lock->lock)) {
b5e89ed5
DA
257 DRM_ERROR("Lock isn't held after context switch\n");
258 }
1da177e4 259
b5e89ed5
DA
260 /* If a context switch is ever initiated
261 when the kernel holds the lock, release
262 that lock here. */
263 clear_bit(0, &dev->context_flag);
264 wake_up(&dev->context_wait);
1da177e4 265
b5e89ed5 266 return 0;
1da177e4
LT
267}
268
269/**
270 * Reserve contexts.
271 *
272 * \param inode device inode.
6c340eac 273 * \param file_priv DRM file private.
1da177e4
LT
274 * \param cmd command.
275 * \param arg user argument pointing to a drm_ctx_res structure.
276 * \return zero on success or a negative number on failure.
277 */
c153f45f
EA
278int drm_resctx(struct drm_device *dev, void *data,
279 struct drm_file *file_priv)
1da177e4 280{
c153f45f 281 struct drm_ctx_res *res = data;
c60ce623 282 struct drm_ctx ctx;
1da177e4
LT
283 int i;
284
c153f45f 285 if (res->count >= DRM_RESERVED_CONTEXTS) {
b5e89ed5
DA
286 memset(&ctx, 0, sizeof(ctx));
287 for (i = 0; i < DRM_RESERVED_CONTEXTS; i++) {
1da177e4 288 ctx.handle = i;
c153f45f 289 if (copy_to_user(&res->contexts[i], &ctx, sizeof(ctx)))
1da177e4
LT
290 return -EFAULT;
291 }
292 }
c153f45f 293 res->count = DRM_RESERVED_CONTEXTS;
1da177e4 294
1da177e4
LT
295 return 0;
296}
297
298/**
299 * Add context.
300 *
301 * \param inode device inode.
6c340eac 302 * \param file_priv DRM file private.
1da177e4
LT
303 * \param cmd command.
304 * \param arg user argument pointing to a drm_ctx structure.
305 * \return zero on success or a negative number on failure.
306 *
307 * Get a new handle for the context and copy to userspace.
308 */
c153f45f
EA
309int drm_addctx(struct drm_device *dev, void *data,
310 struct drm_file *file_priv)
1da177e4 311{
55910517 312 struct drm_ctx_list *ctx_entry;
c153f45f 313 struct drm_ctx *ctx = data;
1da177e4 314
c153f45f
EA
315 ctx->handle = drm_ctxbitmap_next(dev);
316 if (ctx->handle == DRM_KERNEL_CONTEXT) {
b5e89ed5 317 /* Skip kernel's context and get a new one. */
c153f45f 318 ctx->handle = drm_ctxbitmap_next(dev);
1da177e4 319 }
c153f45f
EA
320 DRM_DEBUG("%d\n", ctx->handle);
321 if (ctx->handle == -1) {
b5e89ed5
DA
322 DRM_DEBUG("Not enough free contexts.\n");
323 /* Should this return -EBUSY instead? */
1da177e4
LT
324 return -ENOMEM;
325 }
326
9a298b2a 327 ctx_entry = kmalloc(sizeof(*ctx_entry), GFP_KERNEL);
b5e89ed5 328 if (!ctx_entry) {
1da177e4
LT
329 DRM_DEBUG("out of memory\n");
330 return -ENOMEM;
331 }
332
b5e89ed5 333 INIT_LIST_HEAD(&ctx_entry->head);
c153f45f 334 ctx_entry->handle = ctx->handle;
6c340eac 335 ctx_entry->tag = file_priv;
1da177e4 336
30e2fb18 337 mutex_lock(&dev->ctxlist_mutex);
bd1b331f 338 list_add(&ctx_entry->head, &dev->ctxlist);
1da177e4 339 ++dev->ctx_count;
30e2fb18 340 mutex_unlock(&dev->ctxlist_mutex);
1da177e4 341
1da177e4
LT
342 return 0;
343}
344
c153f45f 345int drm_modctx(struct drm_device *dev, void *data, struct drm_file *file_priv)
1da177e4
LT
346{
347 /* This does nothing */
348 return 0;
349}
350
351/**
352 * Get context.
353 *
354 * \param inode device inode.
6c340eac 355 * \param file_priv DRM file private.
1da177e4
LT
356 * \param cmd command.
357 * \param arg user argument pointing to a drm_ctx structure.
358 * \return zero on success or a negative number on failure.
359 */
c153f45f 360int drm_getctx(struct drm_device *dev, void *data, struct drm_file *file_priv)
1da177e4 361{
c153f45f 362 struct drm_ctx *ctx = data;
1da177e4
LT
363
364 /* This is 0, because we don't handle any context flags */
c153f45f 365 ctx->flags = 0;
1da177e4 366
1da177e4
LT
367 return 0;
368}
369
370/**
371 * Switch context.
372 *
373 * \param inode device inode.
6c340eac 374 * \param file_priv DRM file private.
1da177e4
LT
375 * \param cmd command.
376 * \param arg user argument pointing to a drm_ctx structure.
377 * \return zero on success or a negative number on failure.
378 *
379 * Calls context_switch().
380 */
c153f45f
EA
381int drm_switchctx(struct drm_device *dev, void *data,
382 struct drm_file *file_priv)
1da177e4 383{
c153f45f 384 struct drm_ctx *ctx = data;
1da177e4 385
c153f45f
EA
386 DRM_DEBUG("%d\n", ctx->handle);
387 return drm_context_switch(dev, dev->last_context, ctx->handle);
1da177e4
LT
388}
389
390/**
391 * New context.
392 *
393 * \param inode device inode.
6c340eac 394 * \param file_priv DRM file private.
1da177e4
LT
395 * \param cmd command.
396 * \param arg user argument pointing to a drm_ctx structure.
397 * \return zero on success or a negative number on failure.
398 *
399 * Calls context_switch_complete().
400 */
c153f45f
EA
401int drm_newctx(struct drm_device *dev, void *data,
402 struct drm_file *file_priv)
1da177e4 403{
c153f45f 404 struct drm_ctx *ctx = data;
1da177e4 405
c153f45f 406 DRM_DEBUG("%d\n", ctx->handle);
7c1c2871 407 drm_context_switch_complete(dev, file_priv, ctx->handle);
1da177e4
LT
408
409 return 0;
410}
411
412/**
413 * Remove context.
414 *
415 * \param inode device inode.
6c340eac 416 * \param file_priv DRM file private.
1da177e4
LT
417 * \param cmd command.
418 * \param arg user argument pointing to a drm_ctx structure.
419 * \return zero on success or a negative number on failure.
420 *
421 * If not the special kernel context, calls ctxbitmap_free() to free the specified context.
422 */
c153f45f
EA
423int drm_rmctx(struct drm_device *dev, void *data,
424 struct drm_file *file_priv)
1da177e4 425{
c153f45f 426 struct drm_ctx *ctx = data;
1da177e4 427
c153f45f 428 DRM_DEBUG("%d\n", ctx->handle);
c153f45f 429 if (ctx->handle != DRM_KERNEL_CONTEXT) {
1da177e4 430 if (dev->driver->context_dtor)
c153f45f
EA
431 dev->driver->context_dtor(dev, ctx->handle);
432 drm_ctxbitmap_free(dev, ctx->handle);
1da177e4
LT
433 }
434
30e2fb18 435 mutex_lock(&dev->ctxlist_mutex);
bd1b331f 436 if (!list_empty(&dev->ctxlist)) {
55910517 437 struct drm_ctx_list *pos, *n;
1da177e4 438
bd1b331f 439 list_for_each_entry_safe(pos, n, &dev->ctxlist, head) {
c153f45f 440 if (pos->handle == ctx->handle) {
b5e89ed5 441 list_del(&pos->head);
9a298b2a 442 kfree(pos);
1da177e4
LT
443 --dev->ctx_count;
444 }
445 }
446 }
30e2fb18 447 mutex_unlock(&dev->ctxlist_mutex);
1da177e4
LT
448
449 return 0;
450}
451
452/*@}*/
This page took 0.675343 seconds and 5 git commands to generate.