3 * IOCTLs for generic contexts
5 * \author Rickard E. (Rik) Faith <faith@valinux.com>
6 * \author Gareth Hughes <gareth@valinux.com>
10 * Created: Fri Nov 24 18:31:37 2000 by gareth@valinux.com
12 * Copyright 1999, 2000 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.
38 * 2001-11-16 Torsten Duwe <duwe@caldera.de>
39 * added context constructor/destructor hooks,
40 * needed by SiS driver's memory management.
45 /******************************************************************/
46 /** \name Context bitmap support */
50 * Free a handle from the context bitmap.
52 * \param dev DRM device.
53 * \param ctx_handle context handle.
55 * Clears the bit specified by \p ctx_handle in drm_device::ctx_bitmap and the entry
56 * in drm_device::context_sareas, while holding the drm_device::struct_mutex
59 void drm_ctxbitmap_free(drm_device_t * dev, int ctx_handle)
66 if (ctx_handle < DRM_MAX_CTXBITMAP) {
67 mutex_lock(&dev->struct_mutex);
68 clear_bit(ctx_handle, dev->ctx_bitmap);
69 dev->context_sareas[ctx_handle] = NULL;
70 mutex_unlock(&dev->struct_mutex);
74 DRM_ERROR("Attempt to free invalid context handle: %d\n", ctx_handle);
79 * Context bitmap allocation.
81 * \param dev DRM device.
82 * \return (non-negative) context handle on success or a negative number on failure.
84 * Find the first zero bit in drm_device::ctx_bitmap and (re)allocates
85 * drm_device::context_sareas to accommodate the new entry while holding the
86 * drm_device::struct_mutex lock.
88 static int drm_ctxbitmap_next(drm_device_t * dev)
95 mutex_lock(&dev->struct_mutex);
96 bit = find_first_zero_bit(dev->ctx_bitmap, DRM_MAX_CTXBITMAP);
97 if (bit < DRM_MAX_CTXBITMAP) {
98 set_bit(bit, dev->ctx_bitmap);
99 DRM_DEBUG("drm_ctxbitmap_next bit : %d\n", bit);
100 if ((bit + 1) > dev->max_context) {
101 dev->max_context = (bit + 1);
102 if (dev->context_sareas) {
103 drm_map_t **ctx_sareas;
105 ctx_sareas = drm_realloc(dev->context_sareas,
115 clear_bit(bit, dev->ctx_bitmap);
116 mutex_unlock(&dev->struct_mutex);
119 dev->context_sareas = ctx_sareas;
120 dev->context_sareas[bit] = NULL;
122 /* max_context == 1 at this point */
123 dev->context_sareas =
124 drm_alloc(dev->max_context *
125 sizeof(*dev->context_sareas),
127 if (!dev->context_sareas) {
128 clear_bit(bit, dev->ctx_bitmap);
129 mutex_unlock(&dev->struct_mutex);
132 dev->context_sareas[bit] = NULL;
135 mutex_unlock(&dev->struct_mutex);
138 mutex_unlock(&dev->struct_mutex);
143 * Context bitmap initialization.
145 * \param dev DRM device.
147 * Allocates and initialize drm_device::ctx_bitmap and drm_device::context_sareas, while holding
148 * the drm_device::struct_mutex lock.
150 int drm_ctxbitmap_init(drm_device_t * dev)
155 mutex_lock(&dev->struct_mutex);
156 dev->ctx_bitmap = (unsigned long *)drm_alloc(PAGE_SIZE,
158 if (dev->ctx_bitmap == NULL) {
159 mutex_unlock(&dev->struct_mutex);
162 memset((void *)dev->ctx_bitmap, 0, PAGE_SIZE);
163 dev->context_sareas = NULL;
164 dev->max_context = -1;
165 mutex_unlock(&dev->struct_mutex);
167 for (i = 0; i < DRM_RESERVED_CONTEXTS; i++) {
168 temp = drm_ctxbitmap_next(dev);
169 DRM_DEBUG("drm_ctxbitmap_init : %d\n", temp);
176 * Context bitmap cleanup.
178 * \param dev DRM device.
180 * Frees drm_device::ctx_bitmap and drm_device::context_sareas, while holding
181 * the drm_device::struct_mutex lock.
183 void drm_ctxbitmap_cleanup(drm_device_t * dev)
185 mutex_lock(&dev->struct_mutex);
186 if (dev->context_sareas)
187 drm_free(dev->context_sareas,
188 sizeof(*dev->context_sareas) *
189 dev->max_context, DRM_MEM_MAPS);
190 drm_free((void *)dev->ctx_bitmap, PAGE_SIZE, DRM_MEM_CTXBITMAP);
191 mutex_unlock(&dev->struct_mutex);
196 /******************************************************************/
197 /** \name Per Context SAREA Support */
201 * Get per-context SAREA.
203 * \param inode device inode.
204 * \param filp file pointer.
205 * \param cmd command.
206 * \param arg user argument pointing to a drm_ctx_priv_map structure.
207 * \return zero on success or a negative number on failure.
209 * Gets the map from drm_device::context_sareas with the handle specified and
210 * returns its handle.
212 int drm_getsareactx(struct inode *inode, struct file *filp,
213 unsigned int cmd, unsigned long arg)
215 drm_file_t *priv = filp->private_data;
216 drm_device_t *dev = priv->head->dev;
217 drm_ctx_priv_map_t __user *argp = (void __user *)arg;
218 drm_ctx_priv_map_t request;
220 drm_map_list_t *_entry;
222 if (copy_from_user(&request, argp, sizeof(request)))
225 mutex_lock(&dev->struct_mutex);
226 if (dev->max_context < 0
227 || request.ctx_id >= (unsigned)dev->max_context) {
228 mutex_unlock(&dev->struct_mutex);
232 map = dev->context_sareas[request.ctx_id];
233 mutex_unlock(&dev->struct_mutex);
235 request.handle = NULL;
236 list_for_each_entry(_entry, &dev->maplist, head) {
237 if (_entry->map == map) {
239 (void *)(unsigned long)_entry->user_token;
243 if (request.handle == NULL)
246 if (copy_to_user(argp, &request, sizeof(request)))
252 * Set per-context SAREA.
254 * \param inode device inode.
255 * \param filp file pointer.
256 * \param cmd command.
257 * \param arg user argument pointing to a drm_ctx_priv_map structure.
258 * \return zero on success or a negative number on failure.
260 * Searches the mapping specified in \p arg and update the entry in
261 * drm_device::context_sareas with it.
263 int drm_setsareactx(struct inode *inode, struct file *filp,
264 unsigned int cmd, unsigned long arg)
266 drm_file_t *priv = filp->private_data;
267 drm_device_t *dev = priv->head->dev;
268 drm_ctx_priv_map_t request;
269 drm_map_t *map = NULL;
270 drm_map_list_t *r_list = NULL;
272 if (copy_from_user(&request,
273 (drm_ctx_priv_map_t __user *) arg, sizeof(request)))
276 mutex_lock(&dev->struct_mutex);
277 list_for_each_entry(r_list, &dev->maplist, head) {
279 && r_list->user_token == (unsigned long) request.handle)
283 mutex_unlock(&dev->struct_mutex);
290 if (dev->max_context < 0)
292 if (request.ctx_id >= (unsigned)dev->max_context)
294 dev->context_sareas[request.ctx_id] = map;
295 mutex_unlock(&dev->struct_mutex);
301 /******************************************************************/
302 /** \name The actual DRM context handling routines */
308 * \param dev DRM device.
309 * \param old old context handle.
310 * \param new new context handle.
311 * \return zero on success or a negative number on failure.
313 * Attempt to set drm_device::context_flag.
315 static int drm_context_switch(drm_device_t * dev, int old, int new)
317 if (test_and_set_bit(0, &dev->context_flag)) {
318 DRM_ERROR("Reentering -- FIXME\n");
322 DRM_DEBUG("Context switch from %d to %d\n", old, new);
324 if (new == dev->last_context) {
325 clear_bit(0, &dev->context_flag);
333 * Complete context switch.
335 * \param dev DRM device.
336 * \param new new context handle.
337 * \return zero on success or a negative number on failure.
339 * Updates drm_device::last_context and drm_device::last_switch. Verifies the
340 * hardware lock is held, clears the drm_device::context_flag and wakes up
341 * drm_device::context_wait.
343 static int drm_context_switch_complete(drm_device_t * dev, int new)
345 dev->last_context = new; /* PRE/POST: This is the _only_ writer. */
346 dev->last_switch = jiffies;
348 if (!_DRM_LOCK_IS_HELD(dev->lock.hw_lock->lock)) {
349 DRM_ERROR("Lock isn't held after context switch\n");
352 /* If a context switch is ever initiated
353 when the kernel holds the lock, release
355 clear_bit(0, &dev->context_flag);
356 wake_up(&dev->context_wait);
364 * \param inode device inode.
365 * \param filp file pointer.
366 * \param cmd command.
367 * \param arg user argument pointing to a drm_ctx_res structure.
368 * \return zero on success or a negative number on failure.
370 int drm_resctx(struct inode *inode, struct file *filp,
371 unsigned int cmd, unsigned long arg)
374 drm_ctx_t __user *argp = (void __user *)arg;
378 if (copy_from_user(&res, argp, sizeof(res)))
381 if (res.count >= DRM_RESERVED_CONTEXTS) {
382 memset(&ctx, 0, sizeof(ctx));
383 for (i = 0; i < DRM_RESERVED_CONTEXTS; i++) {
385 if (copy_to_user(&res.contexts[i], &ctx, sizeof(ctx)))
389 res.count = DRM_RESERVED_CONTEXTS;
391 if (copy_to_user(argp, &res, sizeof(res)))
399 * \param inode device inode.
400 * \param filp file pointer.
401 * \param cmd command.
402 * \param arg user argument pointing to a drm_ctx structure.
403 * \return zero on success or a negative number on failure.
405 * Get a new handle for the context and copy to userspace.
407 int drm_addctx(struct inode *inode, struct file *filp,
408 unsigned int cmd, unsigned long arg)
410 drm_file_t *priv = filp->private_data;
411 drm_device_t *dev = priv->head->dev;
412 drm_ctx_list_t *ctx_entry;
413 drm_ctx_t __user *argp = (void __user *)arg;
416 if (copy_from_user(&ctx, argp, sizeof(ctx)))
419 ctx.handle = drm_ctxbitmap_next(dev);
420 if (ctx.handle == DRM_KERNEL_CONTEXT) {
421 /* Skip kernel's context and get a new one. */
422 ctx.handle = drm_ctxbitmap_next(dev);
424 DRM_DEBUG("%d\n", ctx.handle);
425 if (ctx.handle == -1) {
426 DRM_DEBUG("Not enough free contexts.\n");
427 /* Should this return -EBUSY instead? */
431 if (ctx.handle != DRM_KERNEL_CONTEXT) {
432 if (dev->driver->context_ctor)
433 if (!dev->driver->context_ctor(dev, ctx.handle)) {
434 DRM_DEBUG("Running out of ctxs or memory.\n");
439 ctx_entry = drm_alloc(sizeof(*ctx_entry), DRM_MEM_CTXLIST);
441 DRM_DEBUG("out of memory\n");
445 INIT_LIST_HEAD(&ctx_entry->head);
446 ctx_entry->handle = ctx.handle;
447 ctx_entry->tag = priv;
449 mutex_lock(&dev->ctxlist_mutex);
450 list_add(&ctx_entry->head, &dev->ctxlist);
452 mutex_unlock(&dev->ctxlist_mutex);
454 if (copy_to_user(argp, &ctx, sizeof(ctx)))
459 int drm_modctx(struct inode *inode, struct file *filp,
460 unsigned int cmd, unsigned long arg)
462 /* This does nothing */
469 * \param inode device inode.
470 * \param filp file pointer.
471 * \param cmd command.
472 * \param arg user argument pointing to a drm_ctx structure.
473 * \return zero on success or a negative number on failure.
475 int drm_getctx(struct inode *inode, struct file *filp,
476 unsigned int cmd, unsigned long arg)
478 drm_ctx_t __user *argp = (void __user *)arg;
481 if (copy_from_user(&ctx, argp, sizeof(ctx)))
484 /* This is 0, because we don't handle any context flags */
487 if (copy_to_user(argp, &ctx, sizeof(ctx)))
495 * \param inode device inode.
496 * \param filp file pointer.
497 * \param cmd command.
498 * \param arg user argument pointing to a drm_ctx structure.
499 * \return zero on success or a negative number on failure.
501 * Calls context_switch().
503 int drm_switchctx(struct inode *inode, struct file *filp,
504 unsigned int cmd, unsigned long arg)
506 drm_file_t *priv = filp->private_data;
507 drm_device_t *dev = priv->head->dev;
510 if (copy_from_user(&ctx, (drm_ctx_t __user *) arg, sizeof(ctx)))
513 DRM_DEBUG("%d\n", ctx.handle);
514 return drm_context_switch(dev, dev->last_context, ctx.handle);
520 * \param inode device inode.
521 * \param filp file pointer.
522 * \param cmd command.
523 * \param arg user argument pointing to a drm_ctx structure.
524 * \return zero on success or a negative number on failure.
526 * Calls context_switch_complete().
528 int drm_newctx(struct inode *inode, struct file *filp,
529 unsigned int cmd, unsigned long arg)
531 drm_file_t *priv = filp->private_data;
532 drm_device_t *dev = priv->head->dev;
535 if (copy_from_user(&ctx, (drm_ctx_t __user *) arg, sizeof(ctx)))
538 DRM_DEBUG("%d\n", ctx.handle);
539 drm_context_switch_complete(dev, ctx.handle);
547 * \param inode device inode.
548 * \param filp file pointer.
549 * \param cmd command.
550 * \param arg user argument pointing to a drm_ctx structure.
551 * \return zero on success or a negative number on failure.
553 * If not the special kernel context, calls ctxbitmap_free() to free the specified context.
555 int drm_rmctx(struct inode *inode, struct file *filp,
556 unsigned int cmd, unsigned long arg)
558 drm_file_t *priv = filp->private_data;
559 drm_device_t *dev = priv->head->dev;
562 if (copy_from_user(&ctx, (drm_ctx_t __user *) arg, sizeof(ctx)))
565 DRM_DEBUG("%d\n", ctx.handle);
566 if (ctx.handle == DRM_KERNEL_CONTEXT + 1) {
567 priv->remove_auth_on_close = 1;
569 if (ctx.handle != DRM_KERNEL_CONTEXT) {
570 if (dev->driver->context_dtor)
571 dev->driver->context_dtor(dev, ctx.handle);
572 drm_ctxbitmap_free(dev, ctx.handle);
575 mutex_lock(&dev->ctxlist_mutex);
576 if (!list_empty(&dev->ctxlist)) {
577 drm_ctx_list_t *pos, *n;
579 list_for_each_entry_safe(pos, n, &dev->ctxlist, head) {
580 if (pos->handle == ctx.handle) {
581 list_del(&pos->head);
582 drm_free(pos, sizeof(*pos), DRM_MEM_CTXLIST);
587 mutex_unlock(&dev->ctxlist_mutex);