drivers/gpu/drm/drm_modeset_lock.c

   1 /*
   2  * Copyright (C) 2014 Red Hat
   3  * Author: Rob Clark <robdclark@gmail.com>
   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/drm_atomic.h>
  25 #include <drm/drm_crtc.h>
  26 #include <drm/drm_device.h>
  27 #include <drm/drm_modeset_lock.h>
  28 #include <drm/drm_print.h>
  29
  30 /**
  31  * DOC: kms locking
  32  *
  33  * As KMS moves toward more fine grained locking, and atomic ioctl where
  34  * userspace can indirectly control locking order, it becomes necessary
  35  * to use &ww_mutex and acquire-contexts to avoid deadlocks.  But because
  36  * the locking is more distributed around the driver code, we want a bit
  37  * of extra utility/tracking out of our acquire-ctx.  This is provided
  38  * by &struct drm_modeset_lock and &struct drm_modeset_acquire_ctx.
  39  *
  40  * For basic principles of &ww_mutex, see: Documentation/locking/ww-mutex-design.rst
  41  *
  42  * The basic usage pattern is to::
  43  *
  44  *     drm_modeset_acquire_init(ctx, DRM_MODESET_ACQUIRE_INTERRUPTIBLE)
  45  *     retry:
  46  *     foreach (lock in random_ordered_set_of_locks) {
  47  *         ret = drm_modeset_lock(lock, ctx)
  48  *         if (ret == -EDEADLK) {
  49  *             ret = drm_modeset_backoff(ctx);
  50  *             if (!ret)
  51  *                 goto retry;
  52  *         }
  53  *         if (ret)
  54  *             goto out;
  55  *     }
  56  *     ... do stuff ...
  57  *     out:
  58  *     drm_modeset_drop_locks(ctx);
  59  *     drm_modeset_acquire_fini(ctx);
  60  *
  61  * For convenience this control flow is implemented in
  62  * DRM_MODESET_LOCK_ALL_BEGIN() and DRM_MODESET_LOCK_ALL_END() for the case
  63  * where all modeset locks need to be taken through drm_modeset_lock_all_ctx().
  64  *
  65  * If all that is needed is a single modeset lock, then the &struct
  66  * drm_modeset_acquire_ctx is not needed and the locking can be simplified
  67  * by passing a NULL instead of ctx in the drm_modeset_lock() call or
  68  * calling  drm_modeset_lock_single_interruptible(). To unlock afterwards
  69  * call drm_modeset_unlock().
  70  *
  71  * On top of these per-object locks using &ww_mutex there's also an overall
  72  * &drm_mode_config.mutex, for protecting everything else. Mostly this means
  73  * probe state of connectors, and preventing hotplug add/removal of connectors.
  74  *
  75  * Finally there's a bunch of dedicated locks to protect drm core internal
  76  * lists and lookup data structures.
  77  */
  78
  79 static DEFINE_WW_CLASS(crtc_ww_class);
  80
  81 #if IS_ENABLED(CONFIG_DRM_DEBUG_MODESET_LOCK)
  82 static noinline depot_stack_handle_t __drm_stack_depot_save(void)
  83 {
  84         unsigned long entries[8];
  85         unsigned int n;
  86
  87         n = stack_trace_save(entries, ARRAY_SIZE(entries), 1);
  88
  89         return stack_depot_save(entries, n, GFP_NOWAIT | __GFP_NOWARN);
  90 }
  91
  92 static void __drm_stack_depot_print(depot_stack_handle_t stack_depot)
  93 {
  94         struct drm_printer p = drm_debug_printer("drm_modeset_lock");
  95         unsigned long *entries;
  96         unsigned int nr_entries;
  97         char *buf;
  98
  99         buf = kmalloc(PAGE_SIZE, GFP_NOWAIT | __GFP_NOWARN);
 100         if (!buf)
 101                 return;
 102
 103         nr_entries = stack_depot_fetch(stack_depot, &entries);
 104         stack_trace_snprint(buf, PAGE_SIZE, entries, nr_entries, 2);
 105
 106         drm_printf(&p, "attempting to lock a contended lock without backoff:\n%s", buf);
 107
 108         kfree(buf);
 109 }
 110 #else /* CONFIG_DRM_DEBUG_MODESET_LOCK */
 111 static depot_stack_handle_t __drm_stack_depot_save(void)
 112 {
 113         return 0;
 114 }
 115 static void __drm_stack_depot_print(depot_stack_handle_t stack_depot)
 116 {
 117 }
 118 #endif /* CONFIG_DRM_DEBUG_MODESET_LOCK */
 119
 120 /**
 121  * drm_modeset_lock_all - take all modeset locks
 122  * @dev: DRM device
 123  *
 124  * This function takes all modeset locks, suitable where a more fine-grained
 125  * scheme isn't (yet) implemented. Locks must be dropped by calling the
 126  * drm_modeset_unlock_all() function.
 127  *
 128  * This function is deprecated. It allocates a lock acquisition context and
 129  * stores it in &drm_device.mode_config. This facilitate conversion of
 130  * existing code because it removes the need to manually deal with the
 131  * acquisition context, but it is also brittle because the context is global
 132  * and care must be taken not to nest calls. New code should use the
 133  * drm_modeset_lock_all_ctx() function and pass in the context explicitly.
 134  */
 135 void drm_modeset_lock_all(struct drm_device *dev)
 136 {
 137         struct drm_mode_config *config = &dev->mode_config;
 138         struct drm_modeset_acquire_ctx *ctx;
 139         int ret;
 140
 141         ctx = kzalloc(sizeof(*ctx), GFP_KERNEL | __GFP_NOFAIL);
 142         if (WARN_ON(!ctx))
 143                 return;
 144
 145         mutex_lock(&config->mutex);
 146
 147         drm_modeset_acquire_init(ctx, 0);
 148
 149 retry:
 150         ret = drm_modeset_lock_all_ctx(dev, ctx);
 151         if (ret < 0) {
 152                 if (ret == -EDEADLK) {
 153                         drm_modeset_backoff(ctx);
 154                         goto retry;
 155                 }
 156
 157                 drm_modeset_acquire_fini(ctx);
 158                 kfree(ctx);
 159                 return;
 160         }
 161         ww_acquire_done(&ctx->ww_ctx);
 162
 163         WARN_ON(config->acquire_ctx);
 164
 165         /*
 166          * We hold the locks now, so it is safe to stash the acquisition
 167          * context for drm_modeset_unlock_all().
 168          */
 169         config->acquire_ctx = ctx;
 170
 171         drm_warn_on_modeset_not_all_locked(dev);
 172 }
 173 EXPORT_SYMBOL(drm_modeset_lock_all);
 174
 175 /**
 176  * drm_modeset_unlock_all - drop all modeset locks
 177  * @dev: DRM device
 178  *
 179  * This function drops all modeset locks taken by a previous call to the
 180  * drm_modeset_lock_all() function.
 181  *
 182  * This function is deprecated. It uses the lock acquisition context stored
 183  * in &drm_device.mode_config. This facilitates conversion of existing
 184  * code because it removes the need to manually deal with the acquisition
 185  * context, but it is also brittle because the context is global and care must
 186  * be taken not to nest calls. New code should pass the acquisition context
 187  * directly to the drm_modeset_drop_locks() function.
 188  */
 189 void drm_modeset_unlock_all(struct drm_device *dev)
 190 {
 191         struct drm_mode_config *config = &dev->mode_config;
 192         struct drm_modeset_acquire_ctx *ctx = config->acquire_ctx;
 193
 194         if (WARN_ON(!ctx))
 195                 return;
 196
 197         config->acquire_ctx = NULL;
 198         drm_modeset_drop_locks(ctx);
 199         drm_modeset_acquire_fini(ctx);
 200
 201         kfree(ctx);
 202
 203         mutex_unlock(&dev->mode_config.mutex);
 204 }
 205 EXPORT_SYMBOL(drm_modeset_unlock_all);
 206
 207 /**
 208  * drm_warn_on_modeset_not_all_locked - check that all modeset locks are locked
 209  * @dev: device
 210  *
 211  * Useful as a debug assert.
 212  */
 213 void drm_warn_on_modeset_not_all_locked(struct drm_device *dev)
 214 {
 215         struct drm_crtc *crtc;
 216
 217         /* Locking is currently fubar in the panic handler. */
 218         if (oops_in_progress)
 219                 return;
 220
 221         drm_for_each_crtc(crtc, dev)
 222                 WARN_ON(!drm_modeset_is_locked(&crtc->mutex));
 223
 224         WARN_ON(!drm_modeset_is_locked(&dev->mode_config.connection_mutex));
 225         WARN_ON(!mutex_is_locked(&dev->mode_config.mutex));
 226 }
 227 EXPORT_SYMBOL(drm_warn_on_modeset_not_all_locked);
 228
 229 /**
 230  * drm_modeset_acquire_init - initialize acquire context
 231  * @ctx: the acquire context
 232  * @flags: 0 or %DRM_MODESET_ACQUIRE_INTERRUPTIBLE
 233  *
 234  * When passing %DRM_MODESET_ACQUIRE_INTERRUPTIBLE to @flags,
 235  * all calls to drm_modeset_lock() will perform an interruptible
 236  * wait.
 237  */
 238 void drm_modeset_acquire_init(struct drm_modeset_acquire_ctx *ctx,
 239                 uint32_t flags)
 240 {
 241         memset(ctx, 0, sizeof(*ctx));
 242         ww_acquire_init(&ctx->ww_ctx, &crtc_ww_class);
 243         INIT_LIST_HEAD(&ctx->locked);
 244
 245         if (flags & DRM_MODESET_ACQUIRE_INTERRUPTIBLE)
 246                 ctx->interruptible = true;
 247 }
 248 EXPORT_SYMBOL(drm_modeset_acquire_init);
 249
 250 /**
 251  * drm_modeset_acquire_fini - cleanup acquire context
 252  * @ctx: the acquire context
 253  */
 254 void drm_modeset_acquire_fini(struct drm_modeset_acquire_ctx *ctx)
 255 {
 256         ww_acquire_fini(&ctx->ww_ctx);
 257 }
 258 EXPORT_SYMBOL(drm_modeset_acquire_fini);
 259
 260 /**
 261  * drm_modeset_drop_locks - drop all locks
 262  * @ctx: the acquire context
 263  *
 264  * Drop all locks currently held against this acquire context.
 265  */
 266 void drm_modeset_drop_locks(struct drm_modeset_acquire_ctx *ctx)
 267 {
 268         if (WARN_ON(ctx->contended))
 269                 __drm_stack_depot_print(ctx->stack_depot);
 270
 271         while (!list_empty(&ctx->locked)) {
 272                 struct drm_modeset_lock *lock;
 273
 274                 lock = list_first_entry(&ctx->locked,
 275                                 struct drm_modeset_lock, head);
 276
 277                 drm_modeset_unlock(lock);
 278         }
 279 }
 280 EXPORT_SYMBOL(drm_modeset_drop_locks);
 281
 282 static inline int modeset_lock(struct drm_modeset_lock *lock,
 283                 struct drm_modeset_acquire_ctx *ctx,
 284                 bool interruptible, bool slow)
 285 {
 286         int ret;
 287
 288         if (WARN_ON(ctx->contended))
 289                 __drm_stack_depot_print(ctx->stack_depot);
 290
 291         if (ctx->trylock_only) {
 292                 lockdep_assert_held(&ctx->ww_ctx);
 293
 294                 if (!ww_mutex_trylock(&lock->mutex, NULL))
 295                         return -EBUSY;
 296                 else
 297                         return 0;
 298         } else if (interruptible && slow) {
 299                 ret = ww_mutex_lock_slow_interruptible(&lock->mutex, &ctx->ww_ctx);
 300         } else if (interruptible) {
 301                 ret = ww_mutex_lock_interruptible(&lock->mutex, &ctx->ww_ctx);
 302         } else if (slow) {
 303                 ww_mutex_lock_slow(&lock->mutex, &ctx->ww_ctx);
 304                 ret = 0;
 305         } else {
 306                 ret = ww_mutex_lock(&lock->mutex, &ctx->ww_ctx);
 307         }
 308         if (!ret) {
 309                 WARN_ON(!list_empty(&lock->head));
 310                 list_add(&lock->head, &ctx->locked);
 311         } else if (ret == -EALREADY) {
 312                 /* we already hold the lock.. this is fine.  For atomic
 313                  * we will need to be able to drm_modeset_lock() things
 314                  * without having to keep track of what is already locked
 315                  * or not.
 316                  */
 317                 ret = 0;
 318         } else if (ret == -EDEADLK) {
 319                 ctx->contended = lock;
 320                 ctx->stack_depot = __drm_stack_depot_save();
 321         }
 322
 323         return ret;
 324 }
 325
 326 /**
 327  * drm_modeset_backoff - deadlock avoidance backoff
 328  * @ctx: the acquire context
 329  *
 330  * If deadlock is detected (ie. drm_modeset_lock() returns -EDEADLK),
 331  * you must call this function to drop all currently held locks and
 332  * block until the contended lock becomes available.
 333  *
 334  * This function returns 0 on success, or -ERESTARTSYS if this context
 335  * is initialized with %DRM_MODESET_ACQUIRE_INTERRUPTIBLE and the
 336  * wait has been interrupted.
 337  */
 338 int drm_modeset_backoff(struct drm_modeset_acquire_ctx *ctx)
 339 {
 340         struct drm_modeset_lock *contended = ctx->contended;
 341
 342         ctx->contended = NULL;
 343         ctx->stack_depot = 0;
 344
 345         if (WARN_ON(!contended))
 346                 return 0;
 347
 348         drm_modeset_drop_locks(ctx);
 349
 350         return modeset_lock(contended, ctx, ctx->interruptible, true);
 351 }
 352 EXPORT_SYMBOL(drm_modeset_backoff);
 353
 354 /**
 355  * drm_modeset_lock_init - initialize lock
 356  * @lock: lock to init
 357  */
 358 void drm_modeset_lock_init(struct drm_modeset_lock *lock)
 359 {
 360         ww_mutex_init(&lock->mutex, &crtc_ww_class);
 361         INIT_LIST_HEAD(&lock->head);
 362 }
 363 EXPORT_SYMBOL(drm_modeset_lock_init);
 364
 365 /**
 366  * drm_modeset_lock - take modeset lock
 367  * @lock: lock to take
 368  * @ctx: acquire ctx
 369  *
 370  * If @ctx is not NULL, then its ww acquire context is used and the
 371  * lock will be tracked by the context and can be released by calling
 372  * drm_modeset_drop_locks().  If -EDEADLK is returned, this means a
 373  * deadlock scenario has been detected and it is an error to attempt
 374  * to take any more locks without first calling drm_modeset_backoff().
 375  *
 376  * If the @ctx is not NULL and initialized with
 377  * %DRM_MODESET_ACQUIRE_INTERRUPTIBLE, this function will fail with
 378  * -ERESTARTSYS when interrupted.
 379  *
 380  * If @ctx is NULL then the function call behaves like a normal,
 381  * uninterruptible non-nesting mutex_lock() call.
 382  */
 383 int drm_modeset_lock(struct drm_modeset_lock *lock,
 384                 struct drm_modeset_acquire_ctx *ctx)
 385 {
 386         if (ctx)
 387                 return modeset_lock(lock, ctx, ctx->interruptible, false);
 388
 389         ww_mutex_lock(&lock->mutex, NULL);
 390         return 0;
 391 }
 392 EXPORT_SYMBOL(drm_modeset_lock);
 393
 394 /**
 395  * drm_modeset_lock_single_interruptible - take a single modeset lock
 396  * @lock: lock to take
 397  *
 398  * This function behaves as drm_modeset_lock() with a NULL context,
 399  * but performs interruptible waits.
 400  *
 401  * This function returns 0 on success, or -ERESTARTSYS when interrupted.
 402  */
 403 int drm_modeset_lock_single_interruptible(struct drm_modeset_lock *lock)
 404 {
 405         return ww_mutex_lock_interruptible(&lock->mutex, NULL);
 406 }
 407 EXPORT_SYMBOL(drm_modeset_lock_single_interruptible);
 408
 409 /**
 410  * drm_modeset_unlock - drop modeset lock
 411  * @lock: lock to release
 412  */
 413 void drm_modeset_unlock(struct drm_modeset_lock *lock)
 414 {
 415         list_del_init(&lock->head);
 416         ww_mutex_unlock(&lock->mutex);
 417 }
 418 EXPORT_SYMBOL(drm_modeset_unlock);
 419
 420 /**
 421  * drm_modeset_lock_all_ctx - take all modeset locks
 422  * @dev: DRM device
 423  * @ctx: lock acquisition context
 424  *
 425  * This function takes all modeset locks, suitable where a more fine-grained
 426  * scheme isn't (yet) implemented.
 427  *
 428  * Unlike drm_modeset_lock_all(), it doesn't take the &drm_mode_config.mutex
 429  * since that lock isn't required for modeset state changes. Callers which
 430  * need to grab that lock too need to do so outside of the acquire context
 431  * @ctx.
 432  *
 433  * Locks acquired with this function should be released by calling the
 434  * drm_modeset_drop_locks() function on @ctx.
 435  *
 436  * See also: DRM_MODESET_LOCK_ALL_BEGIN() and DRM_MODESET_LOCK_ALL_END()
 437  *
 438  * Returns: 0 on success or a negative error-code on failure.
 439  */
 440 int drm_modeset_lock_all_ctx(struct drm_device *dev,
 441                              struct drm_modeset_acquire_ctx *ctx)
 442 {
 443         struct drm_private_obj *privobj;
 444         struct drm_crtc *crtc;
 445         struct drm_plane *plane;
 446         int ret;
 447
 448         ret = drm_modeset_lock(&dev->mode_config.connection_mutex, ctx);
 449         if (ret)
 450                 return ret;
 451
 452         drm_for_each_crtc(crtc, dev) {
 453                 ret = drm_modeset_lock(&crtc->mutex, ctx);
 454                 if (ret)
 455                         return ret;
 456         }
 457
 458         drm_for_each_plane(plane, dev) {
 459                 ret = drm_modeset_lock(&plane->mutex, ctx);
 460                 if (ret)
 461                         return ret;
 462         }
 463
 464         drm_for_each_privobj(privobj, dev) {
 465                 ret = drm_modeset_lock(&privobj->lock, ctx);
 466                 if (ret)
 467                         return ret;
 468         }
 469
 470         return 0;
 471 }
 472 EXPORT_SYMBOL(drm_modeset_lock_all_ctx);