Pileus Git - ~andy/linux/blob - drivers/gpu/drm/drm_lock.c

   1 /**
   2  * \file drm_lock.c
   3  * IOCTLs for locking
   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 static int drm_notifier(void *priv);
  39
  40 /**
  41  * Lock ioctl.
  42  *
  43  * \param inode device inode.
  44  * \param file_priv DRM file private.
  45  * \param cmd command.
  46  * \param arg user argument, pointing to a drm_lock structure.
  47  * \return zero on success or negative number on failure.
  48  *
  49  * Add the current task to the lock wait queue, and attempt to take to lock.
  50  */
  51 int drm_lock(struct drm_device *dev, void *data, struct drm_file *file_priv)
  52 {
  53         DECLARE_WAITQUEUE(entry, current);
  54         struct drm_lock *lock = data;
  55         struct drm_master *master = file_priv->master;
  56         int ret = 0;
  57
  58         ++file_priv->lock_count;
  59
  60         if (lock->context == DRM_KERNEL_CONTEXT) {
  61                 DRM_ERROR("Process %d using kernel context %d\n",
  62                           task_pid_nr(current), lock->context);
  63                 return -EINVAL;
  64         }
  65
  66         DRM_DEBUG("%d (pid %d) requests lock (0x%08x), flags = 0x%08x\n",
  67                   lock->context, task_pid_nr(current),
  68                   master->lock.hw_lock->lock, lock->flags);
  69
  70         if (drm_core_check_feature(dev, DRIVER_DMA_QUEUE))
  71                 if (lock->context < 0)
  72                         return -EINVAL;
  73
  74         add_wait_queue(&master->lock.lock_queue, &entry);
  75         spin_lock_bh(&master->lock.spinlock);
  76         master->lock.user_waiters++;
  77         spin_unlock_bh(&master->lock.spinlock);
  78
  79         for (;;) {
  80                 __set_current_state(TASK_INTERRUPTIBLE);
  81                 if (!master->lock.hw_lock) {
  82                         /* Device has been unregistered */
  83                         send_sig(SIGTERM, current, 0);
  84                         ret = -EINTR;
  85                         break;
  86                 }
  87                 if (drm_lock_take(&master->lock, lock->context)) {
  88                         master->lock.file_priv = file_priv;
  89                         master->lock.lock_time = jiffies;
  90                         atomic_inc(&dev->counts[_DRM_STAT_LOCKS]);
  91                         break;  /* Got lock */
  92                 }
  93
  94                 /* Contention */
  95                 mutex_unlock(&drm_global_mutex);
  96                 schedule();
  97                 mutex_lock(&drm_global_mutex);
  98                 if (signal_pending(current)) {
  99                         ret = -EINTR;
 100                         break;
 101                 }
 102         }
 103         spin_lock_bh(&master->lock.spinlock);
 104         master->lock.user_waiters--;
 105         spin_unlock_bh(&master->lock.spinlock);
 106         __set_current_state(TASK_RUNNING);
 107         remove_wait_queue(&master->lock.lock_queue, &entry);
 108
 109         DRM_DEBUG("%d %s\n", lock->context,
 110                   ret ? "interrupted" : "has lock");
 111         if (ret) return ret;
 112
 113         /* don't set the block all signals on the master process for now
 114          * really probably not the correct answer but lets us debug xkb
 115          * xserver for now */
 116         if (!file_priv->is_master) {
 117                 sigemptyset(&dev->sigmask);
 118                 sigaddset(&dev->sigmask, SIGSTOP);
 119                 sigaddset(&dev->sigmask, SIGTSTP);
 120                 sigaddset(&dev->sigmask, SIGTTIN);
 121                 sigaddset(&dev->sigmask, SIGTTOU);
 122                 dev->sigdata.context = lock->context;
 123                 dev->sigdata.lock = master->lock.hw_lock;
 124                 block_all_signals(drm_notifier, &dev->sigdata, &dev->sigmask);
 125         }
 126
 127         if (dev->driver->dma_quiescent && (lock->flags & _DRM_LOCK_QUIESCENT))
 128         {
 129                 if (dev->driver->dma_quiescent(dev)) {
 130                         DRM_DEBUG("%d waiting for DMA quiescent\n",
 131                                   lock->context);
 132                         return -EBUSY;
 133                 }
 134         }
 135
 136         return 0;
 137 }
 138
 139 /**
 140  * Unlock ioctl.
 141  *
 142  * \param inode device inode.
 143  * \param file_priv DRM file private.
 144  * \param cmd command.
 145  * \param arg user argument, pointing to a drm_lock structure.
 146  * \return zero on success or negative number on failure.
 147  *
 148  * Transfer and free the lock.
 149  */
 150 int drm_unlock(struct drm_device *dev, void *data, struct drm_file *file_priv)
 151 {
 152         struct drm_lock *lock = data;
 153
 154         if (lock->context == DRM_KERNEL_CONTEXT) {
 155                 DRM_ERROR("Process %d using kernel context %d\n",
 156                           task_pid_nr(current), lock->context);
 157                 return -EINVAL;
 158         }
 159
 160         atomic_inc(&dev->counts[_DRM_STAT_UNLOCKS]);
 161
 162         unblock_all_signals();
 163         return 0;
 164 }
 165
 166 /**
 167  * Take the heavyweight lock.
 168  *
 169  * \param lock lock pointer.
 170  * \param context locking context.
 171  * \return one if the lock is held, or zero otherwise.
 172  *
 173  * Attempt to mark the lock as held by the given context, via the \p cmpxchg instruction.
 174  */
 175 int drm_lock_take(struct drm_lock_data *lock_data,
 176                   unsigned int context)
 177 {
 178         unsigned int old, new, prev;
 179         volatile unsigned int *lock = &lock_data->hw_lock->lock;
 180
 181         spin_lock_bh(&lock_data->spinlock);
 182         do {
 183                 old = *lock;
 184                 if (old & _DRM_LOCK_HELD)
 185                         new = old | _DRM_LOCK_CONT;
 186                 else {
 187                         new = context | _DRM_LOCK_HELD |
 188                                 ((lock_data->user_waiters + lock_data->kernel_waiters > 1) ?
 189                                  _DRM_LOCK_CONT : 0);
 190                 }
 191                 prev = cmpxchg(lock, old, new);
 192         } while (prev != old);
 193         spin_unlock_bh(&lock_data->spinlock);
 194
 195         if (_DRM_LOCKING_CONTEXT(old) == context) {
 196                 if (old & _DRM_LOCK_HELD) {
 197                         if (context != DRM_KERNEL_CONTEXT) {
 198                                 DRM_ERROR("%d holds heavyweight lock\n",
 199                                           context);
 200                         }
 201                         return 0;
 202                 }
 203         }
 204
 205         if ((_DRM_LOCKING_CONTEXT(new)) == context && (new & _DRM_LOCK_HELD)) {
 206                 /* Have lock */
 207                 return 1;
 208         }
 209         return 0;
 210 }
 211 EXPORT_SYMBOL(drm_lock_take);
 212
 213 /**
 214  * This takes a lock forcibly and hands it to context.  Should ONLY be used
 215  * inside *_unlock to give lock to kernel before calling *_dma_schedule.
 216  *
 217  * \param dev DRM device.
 218  * \param lock lock pointer.
 219  * \param context locking context.
 220  * \return always one.
 221  *
 222  * Resets the lock file pointer.
 223  * Marks the lock as held by the given context, via the \p cmpxchg instruction.
 224  */
 225 static int drm_lock_transfer(struct drm_lock_data *lock_data,
 226                              unsigned int context)
 227 {
 228         unsigned int old, new, prev;
 229         volatile unsigned int *lock = &lock_data->hw_lock->lock;
 230
 231         lock_data->file_priv = NULL;
 232         do {
 233                 old = *lock;
 234                 new = context | _DRM_LOCK_HELD;
 235                 prev = cmpxchg(lock, old, new);
 236         } while (prev != old);
 237         return 1;
 238 }
 239
 240 /**
 241  * Free lock.
 242  *
 243  * \param dev DRM device.
 244  * \param lock lock.
 245  * \param context context.
 246  *
 247  * Resets the lock file pointer.
 248  * Marks the lock as not held, via the \p cmpxchg instruction. Wakes any task
 249  * waiting on the lock queue.
 250  */
 251 int drm_lock_free(struct drm_lock_data *lock_data, unsigned int context)
 252 {
 253         unsigned int old, new, prev;
 254         volatile unsigned int *lock = &lock_data->hw_lock->lock;
 255
 256         spin_lock_bh(&lock_data->spinlock);
 257         if (lock_data->kernel_waiters != 0) {
 258                 drm_lock_transfer(lock_data, 0);
 259                 lock_data->idle_has_lock = 1;
 260                 spin_unlock_bh(&lock_data->spinlock);
 261                 return 1;
 262         }
 263         spin_unlock_bh(&lock_data->spinlock);
 264
 265         do {
 266                 old = *lock;
 267                 new = _DRM_LOCKING_CONTEXT(old);
 268                 prev = cmpxchg(lock, old, new);
 269         } while (prev != old);
 270
 271         if (_DRM_LOCK_IS_HELD(old) && _DRM_LOCKING_CONTEXT(old) != context) {
 272                 DRM_ERROR("%d freed heavyweight lock held by %d\n",
 273                           context, _DRM_LOCKING_CONTEXT(old));
 274                 return 1;
 275         }
 276         wake_up_interruptible(&lock_data->lock_queue);
 277         return 0;
 278 }
 279 EXPORT_SYMBOL(drm_lock_free);
 280
 281 /**
 282  * If we get here, it means that the process has called DRM_IOCTL_LOCK
 283  * without calling DRM_IOCTL_UNLOCK.
 284  *
 285  * If the lock is not held, then let the signal proceed as usual.  If the lock
 286  * is held, then set the contended flag and keep the signal blocked.
 287  *
 288  * \param priv pointer to a drm_sigdata structure.
 289  * \return one if the signal should be delivered normally, or zero if the
 290  * signal should be blocked.
 291  */
 292 static int drm_notifier(void *priv)
 293 {
 294         struct drm_sigdata *s = (struct drm_sigdata *) priv;
 295         unsigned int old, new, prev;
 296
 297         /* Allow signal delivery if lock isn't held */
 298         if (!s->lock || !_DRM_LOCK_IS_HELD(s->lock->lock)
 299             || _DRM_LOCKING_CONTEXT(s->lock->lock) != s->context)
 300                 return 1;
 301
 302         /* Otherwise, set flag to force call to
 303            drmUnlock */
 304         do {
 305                 old = s->lock->lock;
 306                 new = old | _DRM_LOCK_CONT;
 307                 prev = cmpxchg(&s->lock->lock, old, new);
 308         } while (prev != old);
 309         return 0;
 310 }
 311
 312 /**
 313  * This function returns immediately and takes the hw lock
 314  * with the kernel context if it is free, otherwise it gets the highest priority when and if
 315  * it is eventually released.
 316  *
 317  * This guarantees that the kernel will _eventually_ have the lock _unless_ it is held
 318  * by a blocked process. (In the latter case an explicit wait for the hardware lock would cause
 319  * a deadlock, which is why the "idlelock" was invented).
 320  *
 321  * This should be sufficient to wait for GPU idle without
 322  * having to worry about starvation.
 323  */
 324
 325 void drm_idlelock_take(struct drm_lock_data *lock_data)
 326 {
 327         int ret = 0;
 328
 329         spin_lock_bh(&lock_data->spinlock);
 330         lock_data->kernel_waiters++;
 331         if (!lock_data->idle_has_lock) {
 332
 333                 spin_unlock_bh(&lock_data->spinlock);
 334                 ret = drm_lock_take(lock_data, DRM_KERNEL_CONTEXT);
 335                 spin_lock_bh(&lock_data->spinlock);
 336
 337                 if (ret == 1)
 338                         lock_data->idle_has_lock = 1;
 339         }
 340         spin_unlock_bh(&lock_data->spinlock);
 341 }
 342 EXPORT_SYMBOL(drm_idlelock_take);
 343
 344 void drm_idlelock_release(struct drm_lock_data *lock_data)
 345 {
 346         unsigned int old, prev;
 347         volatile unsigned int *lock = &lock_data->hw_lock->lock;
 348
 349         spin_lock_bh(&lock_data->spinlock);
 350         if (--lock_data->kernel_waiters == 0) {
 351                 if (lock_data->idle_has_lock) {
 352                         do {
 353                                 old = *lock;
 354                                 prev = cmpxchg(lock, old, DRM_KERNEL_CONTEXT);
 355                         } while (prev != old);
 356                         wake_up_interruptible(&lock_data->lock_queue);
 357                         lock_data->idle_has_lock = 0;
 358                 }
 359         }
 360         spin_unlock_bh(&lock_data->spinlock);
 361 }
 362 EXPORT_SYMBOL(drm_idlelock_release);
 363
 364
 365 int drm_i_have_hw_lock(struct drm_device *dev, struct drm_file *file_priv)
 366 {
 367         struct drm_master *master = file_priv->master;
 368         return (file_priv->lock_count && master->lock.hw_lock &&
 369                 _DRM_LOCK_IS_HELD(master->lock.hw_lock->lock) &&
 370                 master->lock.file_priv == file_priv);
 371 }
 372
 373 EXPORT_SYMBOL(drm_i_have_hw_lock);