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::ctx_idr, while holding the drm_device::struct_mutex
59 void drm_ctxbitmap_free(struct drm_device * dev, int ctx_handle)
61 mutex_lock(&dev->struct_mutex);
62 idr_remove(&dev->ctx_idr, ctx_handle);
63 mutex_unlock(&dev->struct_mutex);
67 * Context bitmap allocation.
69 * \param dev DRM device.
70 * \return (non-negative) context handle on success or a negative number on failure.
72 * Allocate a new idr from drm_device::ctx_idr while holding the
73 * drm_device::struct_mutex lock.
75 static int drm_ctxbitmap_next(struct drm_device * dev)
81 if (idr_pre_get(&dev->ctx_idr, GFP_KERNEL) == 0) {
82 DRM_ERROR("Out of memory expanding drawable idr\n");
85 mutex_lock(&dev->struct_mutex);
86 ret = idr_get_new_above(&dev->ctx_idr, NULL,
87 DRM_RESERVED_CONTEXTS, &new_id);
89 mutex_unlock(&dev->struct_mutex);
92 mutex_unlock(&dev->struct_mutex);
97 * Context bitmap initialization.
99 * \param dev DRM device.
101 * Initialise the drm_device::ctx_idr
103 int drm_ctxbitmap_init(struct drm_device * dev)
105 idr_init(&dev->ctx_idr);
110 * Context bitmap cleanup.
112 * \param dev DRM device.
114 * Free all idr members using drm_ctx_sarea_free helper function
115 * while holding the drm_device::struct_mutex lock.
117 void drm_ctxbitmap_cleanup(struct drm_device * dev)
119 mutex_lock(&dev->struct_mutex);
120 idr_remove_all(&dev->ctx_idr);
121 mutex_unlock(&dev->struct_mutex);
126 /******************************************************************/
127 /** \name Per Context SAREA Support */
131 * Get per-context SAREA.
133 * \param inode device inode.
134 * \param file_priv DRM file private.
135 * \param cmd command.
136 * \param arg user argument pointing to a drm_ctx_priv_map structure.
137 * \return zero on success or a negative number on failure.
139 * Gets the map from drm_device::ctx_idr with the handle specified and
140 * returns its handle.
142 int drm_getsareactx(struct inode *inode, struct drm_file *file_priv,
143 unsigned int cmd, unsigned long arg)
145 struct drm_device *dev = file_priv->head->dev;
146 struct drm_ctx_priv_map __user *argp = (void __user *)arg;
147 struct drm_ctx_priv_map request;
149 struct drm_map_list *_entry;
151 if (copy_from_user(&request, argp, sizeof(request)))
154 mutex_lock(&dev->struct_mutex);
156 map = idr_find(&dev->ctx_idr, request.ctx_id);
158 mutex_unlock(&dev->struct_mutex);
162 mutex_unlock(&dev->struct_mutex);
164 request.handle = NULL;
165 list_for_each_entry(_entry, &dev->maplist, head) {
166 if (_entry->map == map) {
168 (void *)(unsigned long)_entry->user_token;
172 if (request.handle == NULL)
175 if (copy_to_user(argp, &request, sizeof(request)))
181 * Set per-context SAREA.
183 * \param inode device inode.
184 * \param file_priv DRM file private.
185 * \param cmd command.
186 * \param arg user argument pointing to a drm_ctx_priv_map structure.
187 * \return zero on success or a negative number on failure.
189 * Searches the mapping specified in \p arg and update the entry in
190 * drm_device::ctx_idr with it.
192 int drm_setsareactx(struct inode *inode, struct drm_file *file_priv,
193 unsigned int cmd, unsigned long arg)
195 struct drm_device *dev = file_priv->head->dev;
196 struct drm_ctx_priv_map request;
197 struct drm_map *map = NULL;
198 struct drm_map_list *r_list = NULL;
200 if (copy_from_user(&request,
201 (struct drm_ctx_priv_map __user *) arg,
205 mutex_lock(&dev->struct_mutex);
206 list_for_each_entry(r_list, &dev->maplist, head) {
208 && r_list->user_token == (unsigned long)request.handle)
212 mutex_unlock(&dev->struct_mutex);
220 if (IS_ERR(idr_replace(&dev->ctx_idr, map, request.ctx_id)))
223 mutex_unlock(&dev->struct_mutex);
229 /******************************************************************/
230 /** \name The actual DRM context handling routines */
236 * \param dev DRM device.
237 * \param old old context handle.
238 * \param new new context handle.
239 * \return zero on success or a negative number on failure.
241 * Attempt to set drm_device::context_flag.
243 static int drm_context_switch(struct drm_device * dev, int old, int new)
245 if (test_and_set_bit(0, &dev->context_flag)) {
246 DRM_ERROR("Reentering -- FIXME\n");
250 DRM_DEBUG("Context switch from %d to %d\n", old, new);
252 if (new == dev->last_context) {
253 clear_bit(0, &dev->context_flag);
261 * Complete context switch.
263 * \param dev DRM device.
264 * \param new new context handle.
265 * \return zero on success or a negative number on failure.
267 * Updates drm_device::last_context and drm_device::last_switch. Verifies the
268 * hardware lock is held, clears the drm_device::context_flag and wakes up
269 * drm_device::context_wait.
271 static int drm_context_switch_complete(struct drm_device * dev, int new)
273 dev->last_context = new; /* PRE/POST: This is the _only_ writer. */
274 dev->last_switch = jiffies;
276 if (!_DRM_LOCK_IS_HELD(dev->lock.hw_lock->lock)) {
277 DRM_ERROR("Lock isn't held after context switch\n");
280 /* If a context switch is ever initiated
281 when the kernel holds the lock, release
283 clear_bit(0, &dev->context_flag);
284 wake_up(&dev->context_wait);
292 * \param inode device inode.
293 * \param file_priv DRM file private.
294 * \param cmd command.
295 * \param arg user argument pointing to a drm_ctx_res structure.
296 * \return zero on success or a negative number on failure.
298 int drm_resctx(struct inode *inode, struct drm_file *file_priv,
299 unsigned int cmd, unsigned long arg)
301 struct drm_ctx_res res;
302 struct drm_ctx_res __user *argp = (void __user *)arg;
306 if (copy_from_user(&res, argp, sizeof(res)))
309 if (res.count >= DRM_RESERVED_CONTEXTS) {
310 memset(&ctx, 0, sizeof(ctx));
311 for (i = 0; i < DRM_RESERVED_CONTEXTS; i++) {
313 if (copy_to_user(&res.contexts[i], &ctx, sizeof(ctx)))
317 res.count = DRM_RESERVED_CONTEXTS;
319 if (copy_to_user(argp, &res, sizeof(res)))
327 * \param inode device inode.
328 * \param file_priv DRM file private.
329 * \param cmd command.
330 * \param arg user argument pointing to a drm_ctx structure.
331 * \return zero on success or a negative number on failure.
333 * Get a new handle for the context and copy to userspace.
335 int drm_addctx(struct inode *inode, struct drm_file *file_priv,
336 unsigned int cmd, unsigned long arg)
338 struct drm_device *dev = file_priv->head->dev;
339 struct drm_ctx_list *ctx_entry;
340 struct drm_ctx __user *argp = (void __user *)arg;
343 if (copy_from_user(&ctx, argp, sizeof(ctx)))
346 ctx.handle = drm_ctxbitmap_next(dev);
347 if (ctx.handle == DRM_KERNEL_CONTEXT) {
348 /* Skip kernel's context and get a new one. */
349 ctx.handle = drm_ctxbitmap_next(dev);
351 DRM_DEBUG("%d\n", ctx.handle);
352 if (ctx.handle == -1) {
353 DRM_DEBUG("Not enough free contexts.\n");
354 /* Should this return -EBUSY instead? */
358 if (ctx.handle != DRM_KERNEL_CONTEXT) {
359 if (dev->driver->context_ctor)
360 if (!dev->driver->context_ctor(dev, ctx.handle)) {
361 DRM_DEBUG("Running out of ctxs or memory.\n");
366 ctx_entry = drm_alloc(sizeof(*ctx_entry), DRM_MEM_CTXLIST);
368 DRM_DEBUG("out of memory\n");
372 INIT_LIST_HEAD(&ctx_entry->head);
373 ctx_entry->handle = ctx.handle;
374 ctx_entry->tag = file_priv;
376 mutex_lock(&dev->ctxlist_mutex);
377 list_add(&ctx_entry->head, &dev->ctxlist);
379 mutex_unlock(&dev->ctxlist_mutex);
381 if (copy_to_user(argp, &ctx, sizeof(ctx)))
386 int drm_modctx(struct inode *inode, struct drm_file *file_priv,
387 unsigned int cmd, unsigned long arg)
389 /* This does nothing */
396 * \param inode device inode.
397 * \param file_priv DRM file private.
398 * \param cmd command.
399 * \param arg user argument pointing to a drm_ctx structure.
400 * \return zero on success or a negative number on failure.
402 int drm_getctx(struct inode *inode, struct drm_file *file_priv,
403 unsigned int cmd, unsigned long arg)
405 struct drm_ctx __user *argp = (void __user *)arg;
408 if (copy_from_user(&ctx, argp, sizeof(ctx)))
411 /* This is 0, because we don't handle any context flags */
414 if (copy_to_user(argp, &ctx, sizeof(ctx)))
422 * \param inode device inode.
423 * \param file_priv DRM file private.
424 * \param cmd command.
425 * \param arg user argument pointing to a drm_ctx structure.
426 * \return zero on success or a negative number on failure.
428 * Calls context_switch().
430 int drm_switchctx(struct inode *inode, struct drm_file *file_priv,
431 unsigned int cmd, unsigned long arg)
433 struct drm_device *dev = file_priv->head->dev;
436 if (copy_from_user(&ctx, (struct drm_ctx __user *) arg, sizeof(ctx)))
439 DRM_DEBUG("%d\n", ctx.handle);
440 return drm_context_switch(dev, dev->last_context, ctx.handle);
446 * \param inode device inode.
447 * \param file_priv DRM file private.
448 * \param cmd command.
449 * \param arg user argument pointing to a drm_ctx structure.
450 * \return zero on success or a negative number on failure.
452 * Calls context_switch_complete().
454 int drm_newctx(struct inode *inode, struct drm_file *file_priv,
455 unsigned int cmd, unsigned long arg)
457 struct drm_device *dev = file_priv->head->dev;
460 if (copy_from_user(&ctx, (struct drm_ctx __user *) arg, sizeof(ctx)))
463 DRM_DEBUG("%d\n", ctx.handle);
464 drm_context_switch_complete(dev, ctx.handle);
472 * \param inode device inode.
473 * \param file_priv DRM file private.
474 * \param cmd command.
475 * \param arg user argument pointing to a drm_ctx structure.
476 * \return zero on success or a negative number on failure.
478 * If not the special kernel context, calls ctxbitmap_free() to free the specified context.
480 int drm_rmctx(struct inode *inode, struct drm_file *file_priv,
481 unsigned int cmd, unsigned long arg)
483 struct drm_device *dev = file_priv->head->dev;
486 if (copy_from_user(&ctx, (struct drm_ctx __user *) arg, sizeof(ctx)))
489 DRM_DEBUG("%d\n", ctx.handle);
490 if (ctx.handle == DRM_KERNEL_CONTEXT + 1) {
491 file_priv->remove_auth_on_close = 1;
493 if (ctx.handle != DRM_KERNEL_CONTEXT) {
494 if (dev->driver->context_dtor)
495 dev->driver->context_dtor(dev, ctx.handle);
496 drm_ctxbitmap_free(dev, ctx.handle);
499 mutex_lock(&dev->ctxlist_mutex);
500 if (!list_empty(&dev->ctxlist)) {
501 struct drm_ctx_list *pos, *n;
503 list_for_each_entry_safe(pos, n, &dev->ctxlist, head) {
504 if (pos->handle == ctx.handle) {
505 list_del(&pos->head);
506 drm_free(pos, sizeof(*pos), DRM_MEM_CTXLIST);
511 mutex_unlock(&dev->ctxlist_mutex);