1450N/A/*
1450N/A * Copyright (c) 2006, 2012, Oracle and/or its affiliates. All rights reserved.
1450N/A */
1450N/A
1450N/A/*
1450N/A * Copyright (c) 2012 Intel Corporation. All rights reserved.
1450N/A */
1450N/A
1450N/A/**
1450N/A * \file drm_lock.c
1450N/A * IOCTLs for locking
1450N/A *
1450N/A * \author Rickard E. (Rik) Faith <faith@valinux.com>
1450N/A * \author Gareth Hughes <gareth@valinux.com>
1450N/A */
1450N/A
1450N/A/*
1450N/A * Created: Tue Feb 2 08:37:54 1999 by faith@valinux.com
1450N/A *
1450N/A * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
1450N/A * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
1450N/A * All Rights Reserved.
1450N/A *
1450N/A * Permission is hereby granted, free of charge, to any person obtaining a
1450N/A * copy of this software and associated documentation files (the "Software"),
1450N/A * to deal in the Software without restriction, including without limitation
1450N/A * the rights to use, copy, modify, merge, publish, distribute, sublicense,
1450N/A * and/or sell copies of the Software, and to permit persons to whom the
1450N/A * Software is furnished to do so, subject to the following conditions:
1450N/A *
1450N/A * The above copyright notice and this permission notice (including the next
1450N/A * paragraph) shall be included in all copies or substantial portions of the
1450N/A * Software.
1450N/A *
1450N/A * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
1450N/A * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
1450N/A * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
1450N/A * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
1450N/A * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
1450N/A * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
1450N/A * OTHER DEALINGS IN THE SOFTWARE.
1450N/A */
1450N/A
1450N/A#include "drmP.h"
1450N/A
1450N/A/**
1450N/A * Lock ioctl.
1450N/A *
1450N/A * \param inode device inode.
1450N/A * \param file_priv DRM file private.
1450N/A * \param cmd command.
1450N/A * \param arg user argument, pointing to a drm_lock structure.
1450N/A * \return zero on success or negative number on failure.
1450N/A *
1450N/A * Add the current task to the lock wait queue, and attempt to take to lock.
1450N/A */
1450N/A/* LINTED */
1450N/Aint drm_lock(DRM_IOCTL_ARGS)
1450N/A{
1450N/A struct drm_lock *lock = data;
1450N/A struct drm_master *master = file->master;
1450N/A int ret = 0;
1450N/A
1450N/A ++file->lock_count;
1450N/A
1450N/A if (lock->context == DRM_KERNEL_CONTEXT) {
1450N/A DRM_ERROR("Process %d using kernel context %d\n",
1450N/A DRM_CURRENTPID, lock->context);
1450N/A return -EINVAL;
1450N/A }
1450N/A
1450N/A if (master->lock.hw_lock == NULL)
1450N/A return -EINVAL;
1450N/A
1450N/A DRM_DEBUG("%d (pid %d) requests lock (0x%08x), flags = 0x%08x\n",
1450N/A lock->context, DRM_CURRENTPID,
1450N/A master->lock.hw_lock->lock, lock->flags);
1450N/A
1450N/A if (drm_core_check_feature(dev, DRIVER_DMA_QUEUE))
1450N/A if (lock->context < 0)
1450N/A return -EINVAL;
1450N/A
1450N/A mutex_enter(&master->lock.lock_mutex);
1450N/A master->lock.user_waiters++;
1450N/A for (;;) {
1450N/A if (drm_lock_take(&master->lock, lock->context)) {
1450N/A master->lock.file_priv = file;
1450N/A master->lock.lock_time = ddi_get_lbolt();
1450N/A atomic_inc(&dev->counts[_DRM_STAT_LOCKS]);
1450N/A break; /* Got lock */
1450N/A }
1450N/A
1450N/A ret = cv_wait_sig(&master->lock.lock_cv,
1450N/A &master->lock.lock_mutex);
1450N/A if (ret == 0) {
1450N/A ret = -EINTR;
1450N/A break;
1450N/A }
1450N/A }
1450N/A master->lock.user_waiters--;
1450N/A mutex_exit(&master->lock.lock_mutex);
1450N/A
1450N/A DRM_DEBUG("%d %s\n", lock->context,
1450N/A ret ? "interrupted" : "has lock");
1450N/A if (ret) return ret;
1450N/A
1450N/A if (dev->driver->dma_quiescent && (lock->flags & _DRM_LOCK_QUIESCENT))
1450N/A {
1450N/A if (dev->driver->dma_quiescent(dev)) {
1450N/A DRM_DEBUG("%d waiting for DMA quiescent\n",
1450N/A lock->context);
1450N/A return -EBUSY;
1450N/A }
1450N/A }
1450N/A
1450N/A return 0;
1450N/A}
1450N/A
1450N/A/**
1450N/A * Unlock ioctl.
1450N/A *
1450N/A * \param inode device inode.
1450N/A * \param file_priv DRM file private.
1450N/A * \param cmd command.
1450N/A * \param arg user argument, pointing to a drm_lock structure.
1450N/A * \return zero on success or negative number on failure.
1450N/A *
1450N/A * Transfer and free the lock.
1450N/A */
1450N/A/* LINTED */
1450N/Aint drm_unlock(DRM_IOCTL_ARGS)
1450N/A{
1450N/A struct drm_lock *lock = data;
1450N/A struct drm_master *master = file->master;
1450N/A
1450N/A if (lock->context == DRM_KERNEL_CONTEXT) {
1450N/A DRM_ERROR("Process %d using kernel context %d\n",
1450N/A DRM_CURRENTPID, lock->context);
1450N/A return -EINVAL;
1450N/A }
1450N/A
1450N/A atomic_inc(&dev->counts[_DRM_STAT_UNLOCKS]);
1450N/A
1450N/A /* kernel_context_switch isn't used by any of the x86 drm
1450N/A * modules but is required by the Sparc driver.
1450N/A */
1450N/A /* LINTED */
1450N/A if (drm_lock_free(&master->lock, lock->context)) {
1450N/A /* FIXME: Should really bail out here. */
1450N/A }
1450N/A
1450N/A return 0;
1450N/A}
1450N/A
1450N/A/**
1450N/A * Take the heavyweight lock.
1450N/A *
1450N/A * \param lock lock pointer.
1450N/A * \param context locking context.
1450N/A * \return one if the lock is held, or zero otherwise.
1450N/A *
1450N/A * Attempt to mark the lock as held by the given context, via the \p cmpxchg instruction.
1450N/A */
1450N/Aint drm_lock_take(struct drm_lock_data *lock_data,
1450N/A unsigned int context)
1450N/A{
1450N/A unsigned int old, new;
1450N/A volatile unsigned int *lock = &lock_data->hw_lock->lock;
1450N/A
1450N/A do {
1450N/A old = *lock;
1450N/A if (old & _DRM_LOCK_HELD)
1450N/A new = old | _DRM_LOCK_CONT;
1450N/A else {
1450N/A new = context | _DRM_LOCK_HELD |
1450N/A ((lock_data->user_waiters + lock_data->kernel_waiters > 1) ?
1450N/A _DRM_LOCK_CONT : 0);
1450N/A }
1450N/A } while (!atomic_cmpset_int(lock, old, new));
1450N/A
1450N/A if (_DRM_LOCKING_CONTEXT(old) == context) {
1450N/A if (old & _DRM_LOCK_HELD) {
1450N/A if (context != DRM_KERNEL_CONTEXT) {
1450N/A DRM_ERROR("%d holds heavyweight lock\n",
1450N/A context);
1450N/A }
1450N/A return 0;
1450N/A }
1450N/A }
1450N/A
1450N/A if ((_DRM_LOCKING_CONTEXT(new)) == context && (new & _DRM_LOCK_HELD)) {
1450N/A /* Have lock */
1450N/A return 1;
1450N/A }
1450N/A return 0;
1450N/A}
1450N/A
1450N/A/**
1450N/A * This takes a lock forcibly and hands it to context. Should ONLY be used
1450N/A * inside *_unlock to give lock to kernel before calling *_dma_schedule.
1450N/A *
1450N/A * \param dev DRM device.
1450N/A * \param lock lock pointer.
1450N/A * \param context locking context.
1450N/A * \return always one.
1450N/A *
1450N/A * Resets the lock file pointer.
1450N/A * Marks the lock as held by the given context, via the \p cmpxchg instruction.
1450N/A */
1450N/Astatic int drm_lock_transfer(struct drm_lock_data *lock_data,
1450N/A unsigned int context)
1450N/A{
1450N/A unsigned int old, new;
1450N/A volatile unsigned int *lock = &lock_data->hw_lock->lock;
1450N/A
1450N/A lock_data->file_priv = NULL;
1450N/A do {
1450N/A old = *lock;
1450N/A new = context | _DRM_LOCK_HELD;
1450N/A } while (!atomic_cmpset_int(lock, old, new));
1450N/A return 1;
1450N/A}
1450N/A
1450N/A/**
1450N/A * Free lock.
1450N/A *
1450N/A * \param dev DRM device.
1450N/A * \param lock lock.
1450N/A * \param context context.
1450N/A *
1450N/A * Resets the lock file pointer.
1450N/A * Marks the lock as not held, via the \p cmpxchg instruction. Wakes any task
1450N/A * waiting on the lock queue.
1450N/A */
1450N/Aint drm_lock_free(struct drm_lock_data *lock_data, unsigned int context)
1450N/A{
1450N/A unsigned int old, new;
1450N/A volatile unsigned int *lock = &lock_data->hw_lock->lock;
1450N/A
1450N/A mutex_enter(&lock_data->lock_mutex);
1450N/A if (lock_data->kernel_waiters != 0) {
1450N/A (void) drm_lock_transfer(lock_data, 0);
1450N/A lock_data->idle_has_lock = 1;
1450N/A mutex_exit(&lock_data->lock_mutex);
1450N/A return 1;
1450N/A }
1450N/A
1450N/A do {
1450N/A old = *lock;
1450N/A new = _DRM_LOCKING_CONTEXT(old);
1450N/A } while (!atomic_cmpset_int(lock, old, new));
1450N/A
1450N/A if (_DRM_LOCK_IS_HELD(old) && _DRM_LOCKING_CONTEXT(old) != context) {
1450N/A DRM_ERROR("%d freed heavyweight lock held by %d\n",
1450N/A context, _DRM_LOCKING_CONTEXT(old));
1450N/A mutex_exit(&lock_data->lock_mutex);
1450N/A return 1;
1450N/A }
1450N/A cv_broadcast(&lock_data->lock_cv);
1450N/A mutex_exit(&lock_data->lock_mutex);
1450N/A return 0;
1450N/A}
1450N/A
1450N/A/**
1450N/A * This function returns immediately and takes the hw lock
1450N/A * with the kernel context if it is free, otherwise it gets the highest priority when and if
1450N/A * it is eventually released.
1450N/A *
1450N/A * This guarantees that the kernel will _eventually_ have the lock _unless_ it is held
1450N/A * by a blocked process. (In the latter case an explicit wait for the hardware lock would cause
1450N/A * a deadlock, which is why the "idlelock" was invented).
1450N/A *
1450N/A * This should be sufficient to wait for GPU idle without
1450N/A * having to worry about starvation.
1450N/A */
1450N/A
1450N/Avoid drm_idlelock_take(struct drm_lock_data *lock_data)
1450N/A{
1450N/A int ret = 0;
1450N/A
1450N/A mutex_enter(&lock_data->lock_mutex);
1450N/A lock_data->kernel_waiters++;
1450N/A if (!lock_data->idle_has_lock) {
1450N/A
1450N/A ret = drm_lock_take(lock_data, DRM_KERNEL_CONTEXT);
1450N/A
1450N/A if (ret == 1)
1450N/A lock_data->idle_has_lock = 1;
1450N/A }
1450N/A mutex_exit(&(lock_data->lock_mutex));
1450N/A}
1450N/A
1450N/Avoid drm_idlelock_release(struct drm_lock_data *lock_data)
1450N/A{
1450N/A unsigned int old;
1450N/A volatile unsigned int *lock = &lock_data->hw_lock->lock;
1450N/A
1450N/A mutex_enter(&lock_data->lock_mutex);
1450N/A if (--lock_data->kernel_waiters == 0) {
1450N/A if (lock_data->idle_has_lock) {
1450N/A do {
1450N/A old = *lock;
1450N/A } while (!atomic_cmpset_int(lock, old, DRM_KERNEL_CONTEXT));
1450N/A cv_broadcast(&lock_data->lock_cv);
1450N/A lock_data->idle_has_lock = 0;
1450N/A }
1450N/A }
1450N/A mutex_exit(&lock_data->lock_mutex);
1450N/A}
1450N/A
1450N/A/* LINTED */
1450N/Aint drm_i_have_hw_lock(struct drm_device *dev, struct drm_file *file_priv)
1450N/A{
1450N/A struct drm_master *master = file_priv->master;
1450N/A return (file_priv->lock_count && master->lock.hw_lock &&
1450N/A _DRM_LOCK_IS_HELD(master->lock.hw_lock->lock) &&
1450N/A master->lock.file_priv == file_priv);
1450N/A}