drivers/gpu/drm/drm_modeset_lock.c

   1 /*
   2  * Copyright (C) 2014 Red Hat
   3  * Author: Rob Clark <[email protected]>
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a
   6  * copy of this software and associated documentation files (the "Software"),
   7  * to deal in the Software without restriction, including without limitation
   8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   9  * and/or sell copies of the Software, and to permit persons to whom the
  10  * Software is furnished to do so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included in
  13  * all copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  18  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
  19  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  20  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  21  * OTHER DEALINGS IN THE SOFTWARE.
  22  */
  23
  24 #include <drm/drmP.h>
  25 #include <drm/drm_crtc.h>
  26 #include <drm/drm_modeset_lock.h>
  27
  28 /**
  29  * DOC: kms locking
  30  *
  31  * As KMS moves toward more fine grained locking, and atomic ioctl where
  32  * userspace can indirectly control locking order, it becomes necessary
  33  * to use &ww_mutex and acquire-contexts to avoid deadlocks.  But because
  34  * the locking is more distributed around the driver code, we want a bit
  35  * of extra utility/tracking out of our acquire-ctx.  This is provided
  36  * by &struct drm_modeset_lock and &struct drm_modeset_acquire_ctx.
  37  *
  38  * For basic principles of &ww_mutex, see: Documentation/locking/ww-mutex-design.txt
  39  *
  40  * The basic usage pattern is to::
  41  *
  42  *     drm_modeset_acquire_init(&ctx)
  43  *     retry:
  44  *     foreach (lock in random_ordered_set_of_locks) {
  45  *         ret = drm_modeset_lock(lock, &ctx)
  46  *         if (ret == -EDEADLK) {
  47  *             drm_modeset_backoff(&ctx);
  48  *             goto retry;
  49  *         }
  50  *     }
  51  *     ... do stuff ...
  52  *     drm_modeset_drop_locks(&ctx);
  53  *     drm_modeset_acquire_fini(&ctx);
  54  *
  55  * If all that is needed is a single modeset lock, then the &struct
  56  * drm_modeset_acquire_ctx is not needed and the locking can be simplified
  57  * by passing a NULL instead of ctx in the drm_modeset_lock()
  58  * call and, when done, by calling drm_modeset_unlock().
  59  *
  60  * On top of these per-object locks using &ww_mutex there's also an overall
  61  * &drm_mode_config.mutex, for protecting everything else. Mostly this means
  62  * probe state of connectors, and preventing hotplug add/removal of connectors.
  63  *
  64  * Finally there's a bunch of dedicated locks to protect drm core internal
  65  * lists and lookup data structures.
  66  */
  67
  68 static DEFINE_WW_CLASS(crtc_ww_class);
  69
  70 /**
  71  * drm_modeset_lock_all - take all modeset locks
  72  * @dev: DRM device
  73  *
  74  * This function takes all modeset locks, suitable where a more fine-grained
  75  * scheme isn't (yet) implemented. Locks must be dropped by calling the
  76  * drm_modeset_unlock_all() function.
  77  *
  78  * This function is deprecated. It allocates a lock acquisition context and
  79  * stores it in &drm_device.mode_config. This facilitate conversion of
  80  * existing code because it removes the need to manually deal with the
  81  * acquisition context, but it is also brittle because the context is global
  82  * and care must be taken not to nest calls. New code should use the
  83  * drm_modeset_lock_all_ctx() function and pass in the context explicitly.
  84  */
  85 void drm_modeset_lock_all(struct drm_device *dev)
  86 {
  87         struct drm_mode_config *config = &dev->mode_config;
  88         struct drm_modeset_acquire_ctx *ctx;
  89         int ret;
  90
  91         ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
  92         if (WARN_ON(!ctx))
  93                 return;
  94
  95         mutex_lock(&config->mutex);
  96
  97         drm_modeset_acquire_init(ctx, 0);
  98
  99 retry:
 100         ret = drm_modeset_lock_all_ctx(dev, ctx);
 101         if (ret < 0) {
 102                 if (ret == -EDEADLK) {
 103                         drm_modeset_backoff(ctx);
 104                         goto retry;
 105                 }
 106
 107                 drm_modeset_acquire_fini(ctx);
 108                 kfree(ctx);
 109                 return;
 110         }
 111
 112         WARN_ON(config->acquire_ctx);
 113
 114         /*
 115          * We hold the locks now, so it is safe to stash the acquisition
 116          * context for drm_modeset_unlock_all().
 117          */
 118         config->acquire_ctx = ctx;
 119
 120         drm_warn_on_modeset_not_all_locked(dev);
 121 }
 122 EXPORT_SYMBOL(drm_modeset_lock_all);
 123
 124 /**
 125  * drm_modeset_unlock_all - drop all modeset locks
 126  * @dev: DRM device
 127  *
 128  * This function drops all modeset locks taken by a previous call to the
 129  * drm_modeset_lock_all() function.
 130  *
 131  * This function is deprecated. It uses the lock acquisition context stored
 132  * in &drm_device.mode_config. This facilitates conversion of existing
 133  * code because it removes the need to manually deal with the acquisition
 134  * context, but it is also brittle because the context is global and care must
 135  * be taken not to nest calls. New code should pass the acquisition context
 136  * directly to the drm_modeset_drop_locks() function.
 137  */
 138 void drm_modeset_unlock_all(struct drm_device *dev)
 139 {
 140         struct drm_mode_config *config = &dev->mode_config;
 141         struct drm_modeset_acquire_ctx *ctx = config->acquire_ctx;
 142
 143         if (WARN_ON(!ctx))
 144                 return;
 145
 146         config->acquire_ctx = NULL;
 147         drm_modeset_drop_locks(ctx);
 148         drm_modeset_acquire_fini(ctx);
 149
 150         kfree(ctx);
 151
 152         mutex_unlock(&dev->mode_config.mutex);
 153 }
 154 EXPORT_SYMBOL(drm_modeset_unlock_all);
 155
 156 /**
 157  * drm_warn_on_modeset_not_all_locked - check that all modeset locks are locked
 158  * @dev: device
 159  *
 160  * Useful as a debug assert.
 161  */
 162 void drm_warn_on_modeset_not_all_locked(struct drm_device *dev)
 163 {
 164         struct drm_crtc *crtc;
 165
 166         /* Locking is currently fubar in the panic handler. */
 167         if (oops_in_progress)
 168                 return;
 169
 170         drm_for_each_crtc(crtc, dev)
 171                 WARN_ON(!drm_modeset_is_locked(&crtc->mutex));
 172
 173         WARN_ON(!drm_modeset_is_locked(&dev->mode_config.connection_mutex));
 174         WARN_ON(!mutex_is_locked(&dev->mode_config.mutex));
 175 }
 176 EXPORT_SYMBOL(drm_warn_on_modeset_not_all_locked);
 177
 178 /**
 179  * drm_modeset_acquire_init - initialize acquire context
 180  * @ctx: the acquire context
 181  * @flags: for future
 182  */
 183 void drm_modeset_acquire_init(struct drm_modeset_acquire_ctx *ctx,
 184                 uint32_t flags)
 185 {
 186         memset(ctx, 0, sizeof(*ctx));
 187         ww_acquire_init(&ctx->ww_ctx, &crtc_ww_class);
 188         INIT_LIST_HEAD(&ctx->locked);
 189 }
 190 EXPORT_SYMBOL(drm_modeset_acquire_init);
 191
 192 /**
 193  * drm_modeset_acquire_fini - cleanup acquire context
 194  * @ctx: the acquire context
 195  */
 196 void drm_modeset_acquire_fini(struct drm_modeset_acquire_ctx *ctx)
 197 {
 198         ww_acquire_fini(&ctx->ww_ctx);
 199 }
 200 EXPORT_SYMBOL(drm_modeset_acquire_fini);
 201
 202 /**
 203  * drm_modeset_drop_locks - drop all locks
 204  * @ctx: the acquire context
 205  *
 206  * Drop all locks currently held against this acquire context.
 207  */
 208 void drm_modeset_drop_locks(struct drm_modeset_acquire_ctx *ctx)
 209 {
 210         WARN_ON(ctx->contended);
 211         while (!list_empty(&ctx->locked)) {
 212                 struct drm_modeset_lock *lock;
 213
 214                 lock = list_first_entry(&ctx->locked,
 215                                 struct drm_modeset_lock, head);
 216
 217                 drm_modeset_unlock(lock);
 218         }
 219 }
 220 EXPORT_SYMBOL(drm_modeset_drop_locks);
 221
 222 static inline int modeset_lock(struct drm_modeset_lock *lock,
 223                 struct drm_modeset_acquire_ctx *ctx,
 224                 bool interruptible, bool slow)
 225 {
 226         int ret;
 227
 228         WARN_ON(ctx->contended);
 229
 230         if (ctx->trylock_only) {
 231                 lockdep_assert_held(&ctx->ww_ctx);
 232
 233                 if (!ww_mutex_trylock(&lock->mutex))
 234                         return -EBUSY;
 235                 else
 236                         return 0;
 237         } else if (interruptible && slow) {
 238                 ret = ww_mutex_lock_slow_interruptible(&lock->mutex, &ctx->ww_ctx);
 239         } else if (interruptible) {
 240                 ret = ww_mutex_lock_interruptible(&lock->mutex, &ctx->ww_ctx);
 241         } else if (slow) {
 242                 ww_mutex_lock_slow(&lock->mutex, &ctx->ww_ctx);
 243                 ret = 0;
 244         } else {
 245                 ret = ww_mutex_lock(&lock->mutex, &ctx->ww_ctx);
 246         }
 247         if (!ret) {
 248                 WARN_ON(!list_empty(&lock->head));
 249                 list_add(&lock->head, &ctx->locked);
 250         } else if (ret == -EALREADY) {
 251                 /* we already hold the lock.. this is fine.  For atomic
 252                  * we will need to be able to drm_modeset_lock() things
 253                  * without having to keep track of what is already locked
 254                  * or not.
 255                  */
 256                 ret = 0;
 257         } else if (ret == -EDEADLK) {
 258                 ctx->contended = lock;
 259         }
 260
 261         return ret;
 262 }
 263
 264 static int modeset_backoff(struct drm_modeset_acquire_ctx *ctx,
 265                 bool interruptible)
 266 {
 267         struct drm_modeset_lock *contended = ctx->contended;
 268
 269         ctx->contended = NULL;
 270
 271         if (WARN_ON(!contended))
 272                 return 0;
 273
 274         drm_modeset_drop_locks(ctx);
 275
 276         return modeset_lock(contended, ctx, interruptible, true);
 277 }
 278
 279 /**
 280  * drm_modeset_backoff - deadlock avoidance backoff
 281  * @ctx: the acquire context
 282  *
 283  * If deadlock is detected (ie. drm_modeset_lock() returns -EDEADLK),
 284  * you must call this function to drop all currently held locks and
 285  * block until the contended lock becomes available.
 286  */
 287 void drm_modeset_backoff(struct drm_modeset_acquire_ctx *ctx)
 288 {
 289         modeset_backoff(ctx, false);
 290 }
 291 EXPORT_SYMBOL(drm_modeset_backoff);
 292
 293 /**
 294  * drm_modeset_backoff_interruptible - deadlock avoidance backoff
 295  * @ctx: the acquire context
 296  *
 297  * Interruptible version of drm_modeset_backoff()
 298  */
 299 int drm_modeset_backoff_interruptible(struct drm_modeset_acquire_ctx *ctx)
 300 {
 301         return modeset_backoff(ctx, true);
 302 }
 303 EXPORT_SYMBOL(drm_modeset_backoff_interruptible);
 304
 305 /**
 306  * drm_modeset_lock_init - initialize lock
 307  * @lock: lock to init
 308  */
 309 void drm_modeset_lock_init(struct drm_modeset_lock *lock)
 310 {
 311         ww_mutex_init(&lock->mutex, &crtc_ww_class);
 312         INIT_LIST_HEAD(&lock->head);
 313 }
 314 EXPORT_SYMBOL(drm_modeset_lock_init);
 315
 316 /**
 317  * drm_modeset_lock - take modeset lock
 318  * @lock: lock to take
 319  * @ctx: acquire ctx
 320  *
 321  * If @ctx is not NULL, then its ww acquire context is used and the
 322  * lock will be tracked by the context and can be released by calling
 323  * drm_modeset_drop_locks().  If -EDEADLK is returned, this means a
 324  * deadlock scenario has been detected and it is an error to attempt
 325  * to take any more locks without first calling drm_modeset_backoff().
 326  *
 327  * If @ctx is NULL then the function call behaves like a normal,
 328  * non-nesting mutex_lock() call.
 329  */
 330 int drm_modeset_lock(struct drm_modeset_lock *lock,
 331                 struct drm_modeset_acquire_ctx *ctx)
 332 {
 333         if (ctx)
 334                 return modeset_lock(lock, ctx, false, false);
 335
 336         ww_mutex_lock(&lock->mutex, NULL);
 337         return 0;
 338 }
 339 EXPORT_SYMBOL(drm_modeset_lock);
 340
 341 /**
 342  * drm_modeset_lock_interruptible - take modeset lock
 343  * @lock: lock to take
 344  * @ctx: acquire ctx
 345  *
 346  * Interruptible version of drm_modeset_lock()
 347  */
 348 int drm_modeset_lock_interruptible(struct drm_modeset_lock *lock,
 349                 struct drm_modeset_acquire_ctx *ctx)
 350 {
 351         if (ctx)
 352                 return modeset_lock(lock, ctx, true, false);
 353
 354         return ww_mutex_lock_interruptible(&lock->mutex, NULL);
 355 }
 356 EXPORT_SYMBOL(drm_modeset_lock_interruptible);
 357
 358 /**
 359  * drm_modeset_unlock - drop modeset lock
 360  * @lock: lock to release
 361  */
 362 void drm_modeset_unlock(struct drm_modeset_lock *lock)
 363 {
 364         list_del_init(&lock->head);
 365         ww_mutex_unlock(&lock->mutex);
 366 }
 367 EXPORT_SYMBOL(drm_modeset_unlock);
 368
 369 /**
 370  * drm_modeset_lock_all_ctx - take all modeset locks
 371  * @dev: DRM device
 372  * @ctx: lock acquisition context
 373  *
 374  * This function takes all modeset locks, suitable where a more fine-grained
 375  * scheme isn't (yet) implemented.
 376  *
 377  * Unlike drm_modeset_lock_all(), it doesn't take the &drm_mode_config.mutex
 378  * since that lock isn't required for modeset state changes. Callers which
 379  * need to grab that lock too need to do so outside of the acquire context
 380  * @ctx.
 381  *
 382  * Locks acquired with this function should be released by calling the
 383  * drm_modeset_drop_locks() function on @ctx.
 384  *
 385  * Returns: 0 on success or a negative error-code on failure.
 386  */
 387 int drm_modeset_lock_all_ctx(struct drm_device *dev,
 388                              struct drm_modeset_acquire_ctx *ctx)
 389 {
 390         struct drm_crtc *crtc;
 391         struct drm_plane *plane;
 392         int ret;
 393
 394         ret = drm_modeset_lock(&dev->mode_config.connection_mutex, ctx);
 395         if (ret)
 396                 return ret;
 397
 398         drm_for_each_crtc(crtc, dev) {
 399                 ret = drm_modeset_lock(&crtc->mutex, ctx);
 400                 if (ret)
 401                         return ret;
 402         }
 403
 404         drm_for_each_plane(plane, dev) {
 405                 ret = drm_modeset_lock(&plane->mutex, ctx);
 406                 if (ret)
 407                         return ret;
 408         }
 409
 410         return 0;
 411 }
 412 EXPORT_SYMBOL(drm_modeset_lock_all_ctx);