drivers/char/drm/drm_context.c

   1 /**
   2  * \file drm_context.c
   3  * IOCTLs for generic contexts
   4  *
   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
  43 #include "drmP.h"
  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
  56  * in drm_device::ctx_idr, while holding the drm_device::struct_mutex
  57  * lock.
  58  */
  59 void drm_ctxbitmap_free(struct drm_device * dev, int ctx_handle)
  60 {
  61         mutex_lock(&dev->struct_mutex);
  62         idr_remove(&dev->ctx_idr, ctx_handle);
  63         mutex_unlock(&dev->struct_mutex);
  64 }
  65
  66 /**
  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  *
  72  * Allocate a new idr from drm_device::ctx_idr while holding the
  73  * drm_device::struct_mutex lock.
  74  */
  75 static int drm_ctxbitmap_next(struct drm_device * dev)
  76 {
  77         int new_id;
  78         int ret;
  79
  80 again:
  81         if (idr_pre_get(&dev->ctx_idr, GFP_KERNEL) == 0) {
  82                 DRM_ERROR("Out of memory expanding drawable idr\n");
  83                 return -ENOMEM;
  84         }
  85         mutex_lock(&dev->struct_mutex);
  86         ret = idr_get_new_above(&dev->ctx_idr, NULL,
  87                                 DRM_RESERVED_CONTEXTS, &new_id);
  88         if (ret == -EAGAIN) {
  89                 mutex_unlock(&dev->struct_mutex);
  90                 goto again;
  91         }
  92         mutex_unlock(&dev->struct_mutex);
  93         return new_id;
  94 }
  95
  96 /**
  97  * Context bitmap initialization.
  98  *
  99  * \param dev DRM device.
 100  *
 101  * Initialise the drm_device::ctx_idr
 102  */
 103 int drm_ctxbitmap_init(struct drm_device * dev)
 104 {
 105         idr_init(&dev->ctx_idr);
 106         return 0;
 107 }
 108
 109 /**
 110  * Context bitmap cleanup.
 111  *
 112  * \param dev DRM device.
 113  *
 114  * Free all idr members using drm_ctx_sarea_free helper function
 115  * while holding the drm_device::struct_mutex lock.
 116  */
 117 void drm_ctxbitmap_cleanup(struct drm_device * dev)
 118 {
 119         mutex_lock(&dev->struct_mutex);
 120         idr_remove_all(&dev->ctx_idr);
 121         mutex_unlock(&dev->struct_mutex);
 122 }
 123
 124 /*@}*/
 125
 126 /******************************************************************/
 127 /** \name Per Context SAREA Support */
 128 /*@{*/
 129
 130 /**
 131  * Get per-context SAREA.
 132  *
 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.
 138  *
 139  * Gets the map from drm_device::ctx_idr with the handle specified and
 140  * returns its handle.
 141  */
 142 int drm_getsareactx(struct inode *inode, struct drm_file *file_priv,
 143                     unsigned int cmd, unsigned long arg)
 144 {
 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;
 148         struct drm_map *map;
 149         struct drm_map_list *_entry;
 150
 151         if (copy_from_user(&request, argp, sizeof(request)))
 152                 return -EFAULT;
 153
 154         mutex_lock(&dev->struct_mutex);
 155
 156         map = idr_find(&dev->ctx_idr, request.ctx_id);
 157         if (!map) {
 158                 mutex_unlock(&dev->struct_mutex);
 159                 return -EINVAL;
 160         }
 161
 162         mutex_unlock(&dev->struct_mutex);
 163
 164         request.handle = NULL;
 165         list_for_each_entry(_entry, &dev->maplist, head) {
 166                 if (_entry->map == map) {
 167                         request.handle =
 168                             (void *)(unsigned long)_entry->user_token;
 169                         break;
 170                 }
 171         }
 172         if (request.handle == NULL)
 173                 return -EINVAL;
 174
 175         if (copy_to_user(argp, &request, sizeof(request)))
 176                 return -EFAULT;
 177         return 0;
 178 }
 179
 180 /**
 181  * Set per-context SAREA.
 182  *
 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.
 188  *
 189  * Searches the mapping specified in \p arg and update the entry in
 190  * drm_device::ctx_idr with it.
 191  */
 192 int drm_setsareactx(struct inode *inode, struct drm_file *file_priv,
 193                     unsigned int cmd, unsigned long arg)
 194 {
 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;
 199
 200         if (copy_from_user(&request,
 201                            (struct drm_ctx_priv_map __user *) arg,
 202                            sizeof(request)))
 203                 return -EFAULT;
 204
 205         mutex_lock(&dev->struct_mutex);
 206         list_for_each_entry(r_list, &dev->maplist, head) {
 207                 if (r_list->map
 208                     && r_list->user_token == (unsigned long)request.handle)
 209                         goto found;
 210         }
 211       bad:
 212         mutex_unlock(&dev->struct_mutex);
 213         return -EINVAL;
 214
 215       found:
 216         map = r_list->map;
 217         if (!map)
 218                 goto bad;
 219
 220         if (IS_ERR(idr_replace(&dev->ctx_idr, map, request.ctx_id)))
 221                 goto bad;
 222
 223         mutex_unlock(&dev->struct_mutex);
 224         return 0;
 225 }
 226
 227 /*@}*/
 228
 229 /******************************************************************/
 230 /** \name The actual DRM context handling routines */
 231 /*@{*/
 232
 233 /**
 234  * Switch context.
 235  *
 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.
 240  *
 241  * Attempt to set drm_device::context_flag.
 242  */
 243 static int drm_context_switch(struct drm_device * dev, int old, int new)
 244 {
 245         if (test_and_set_bit(0, &dev->context_flag)) {
 246                 DRM_ERROR("Reentering -- FIXME\n");
 247                 return -EBUSY;
 248         }
 249
 250         DRM_DEBUG("Context switch from %d to %d\n", old, new);
 251
 252         if (new == dev->last_context) {
 253                 clear_bit(0, &dev->context_flag);
 254                 return 0;
 255         }
 256
 257         return 0;
 258 }
 259
 260 /**
 261  * Complete context switch.
 262  *
 263  * \param dev DRM device.
 264  * \param new new context handle.
 265  * \return zero on success or a negative number on failure.
 266  *
 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.
 270  */
 271 static int drm_context_switch_complete(struct drm_device * dev, int new)
 272 {
 273         dev->last_context = new;        /* PRE/POST: This is the _only_ writer. */
 274         dev->last_switch = jiffies;
 275
 276         if (!_DRM_LOCK_IS_HELD(dev->lock.hw_lock->lock)) {
 277                 DRM_ERROR("Lock isn't held after context switch\n");
 278         }
 279
 280         /* If a context switch is ever initiated
 281            when the kernel holds the lock, release
 282            that lock here. */
 283         clear_bit(0, &dev->context_flag);
 284         wake_up(&dev->context_wait);
 285
 286         return 0;
 287 }
 288
 289 /**
 290  * Reserve contexts.
 291  *
 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.
 297  */
 298 int drm_resctx(struct inode *inode, struct drm_file *file_priv,
 299                unsigned int cmd, unsigned long arg)
 300 {
 301         struct drm_ctx_res res;
 302         struct drm_ctx_res __user *argp = (void __user *)arg;
 303         struct drm_ctx ctx;
 304         int i;
 305
 306         if (copy_from_user(&res, argp, sizeof(res)))
 307                 return -EFAULT;
 308
 309         if (res.count >= DRM_RESERVED_CONTEXTS) {
 310                 memset(&ctx, 0, sizeof(ctx));
 311                 for (i = 0; i < DRM_RESERVED_CONTEXTS; i++) {
 312                         ctx.handle = i;
 313                         if (copy_to_user(&res.contexts[i], &ctx, sizeof(ctx)))
 314                                 return -EFAULT;
 315                 }
 316         }
 317         res.count = DRM_RESERVED_CONTEXTS;
 318
 319         if (copy_to_user(argp, &res, sizeof(res)))
 320                 return -EFAULT;
 321         return 0;
 322 }
 323
 324 /**
 325  * Add context.
 326  *
 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.
 332  *
 333  * Get a new handle for the context and copy to userspace.
 334  */
 335 int drm_addctx(struct inode *inode, struct drm_file *file_priv,
 336                unsigned int cmd, unsigned long arg)
 337 {
 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;
 341         struct drm_ctx ctx;
 342
 343         if (copy_from_user(&ctx, argp, sizeof(ctx)))
 344                 return -EFAULT;
 345
 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);
 350         }
 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? */
 355                 return -ENOMEM;
 356         }
 357
 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");
 362                                 return -ENOMEM;
 363                         }
 364         }
 365
 366         ctx_entry = drm_alloc(sizeof(*ctx_entry), DRM_MEM_CTXLIST);
 367         if (!ctx_entry) {
 368                 DRM_DEBUG("out of memory\n");
 369                 return -ENOMEM;
 370         }
 371
 372         INIT_LIST_HEAD(&ctx_entry->head);
 373         ctx_entry->handle = ctx.handle;
 374         ctx_entry->tag = file_priv;
 375
 376         mutex_lock(&dev->ctxlist_mutex);
 377         list_add(&ctx_entry->head, &dev->ctxlist);
 378         ++dev->ctx_count;
 379         mutex_unlock(&dev->ctxlist_mutex);
 380
 381         if (copy_to_user(argp, &ctx, sizeof(ctx)))
 382                 return -EFAULT;
 383         return 0;
 384 }
 385
 386 int drm_modctx(struct inode *inode, struct drm_file *file_priv,
 387                unsigned int cmd, unsigned long arg)
 388 {
 389         /* This does nothing */
 390         return 0;
 391 }
 392
 393 /**
 394  * Get context.
 395  *
 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.
 401  */
 402 int drm_getctx(struct inode *inode, struct drm_file *file_priv,
 403                unsigned int cmd, unsigned long arg)
 404 {
 405         struct drm_ctx __user *argp = (void __user *)arg;
 406         struct drm_ctx ctx;
 407
 408         if (copy_from_user(&ctx, argp, sizeof(ctx)))
 409                 return -EFAULT;
 410
 411         /* This is 0, because we don't handle any context flags */
 412         ctx.flags = 0;
 413
 414         if (copy_to_user(argp, &ctx, sizeof(ctx)))
 415                 return -EFAULT;
 416         return 0;
 417 }
 418
 419 /**
 420  * Switch context.
 421  *
 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.
 427  *
 428  * Calls context_switch().
 429  */
 430 int drm_switchctx(struct inode *inode, struct drm_file *file_priv,
 431                   unsigned int cmd, unsigned long arg)
 432 {
 433         struct drm_device *dev = file_priv->head->dev;
 434         struct drm_ctx ctx;
 435
 436         if (copy_from_user(&ctx, (struct drm_ctx __user *) arg, sizeof(ctx)))
 437                 return -EFAULT;
 438
 439         DRM_DEBUG("%d\n", ctx.handle);
 440         return drm_context_switch(dev, dev->last_context, ctx.handle);
 441 }
 442
 443 /**
 444  * New context.
 445  *
 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.
 451  *
 452  * Calls context_switch_complete().
 453  */
 454 int drm_newctx(struct inode *inode, struct drm_file *file_priv,
 455                unsigned int cmd, unsigned long arg)
 456 {
 457         struct drm_device *dev = file_priv->head->dev;
 458         struct drm_ctx ctx;
 459
 460         if (copy_from_user(&ctx, (struct drm_ctx __user *) arg, sizeof(ctx)))
 461                 return -EFAULT;
 462
 463         DRM_DEBUG("%d\n", ctx.handle);
 464         drm_context_switch_complete(dev, ctx.handle);
 465
 466         return 0;
 467 }
 468
 469 /**
 470  * Remove context.
 471  *
 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.
 477  *
 478  * If not the special kernel context, calls ctxbitmap_free() to free the specified context.
 479  */
 480 int drm_rmctx(struct inode *inode, struct drm_file *file_priv,
 481               unsigned int cmd, unsigned long arg)
 482 {
 483         struct drm_device *dev = file_priv->head->dev;
 484         struct drm_ctx ctx;
 485
 486         if (copy_from_user(&ctx, (struct drm_ctx __user *) arg, sizeof(ctx)))
 487                 return -EFAULT;
 488
 489         DRM_DEBUG("%d\n", ctx.handle);
 490         if (ctx.handle == DRM_KERNEL_CONTEXT + 1) {
 491                 file_priv->remove_auth_on_close = 1;
 492         }
 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);
 497         }
 498
 499         mutex_lock(&dev->ctxlist_mutex);
 500         if (!list_empty(&dev->ctxlist)) {
 501                 struct drm_ctx_list *pos, *n;
 502
 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);
 507                                 --dev->ctx_count;
 508                         }
 509                 }
 510         }
 511         mutex_unlock(&dev->ctxlist_mutex);
 512
 513         return 0;
 514 }
 515
 516 /*@}*/