rtmutex: Document rt_mutex_adjust_prio_chain()

Parameters and usage of rt_mutex_adjust_prio_chain() are already
documented in Documentation/rt-mutex-design.txt. However, since this
function is called from several paths with different semantics (related
to the arguments), it is handy to have a quick reference directly in
the code.

Signed-off-by: Juri Lelli <juri.lelli@gmail.com>
Cc: Clark Williams <williams@redhat.com>
Cc: Steven Rostedt <rostedt@goodmis.org>
Signed-off-by: Peter Zijlstra <a.p.zijlstra@chello.nl>
Link: http://lkml.kernel.org/r/1368608650-7935-1-git-send-email-juri.lelli@gmail.com
Signed-off-by: Ingo Molnar <mingo@kernel.org>
This commit is contained in:
Juri Lelli 2013-05-15 11:04:10 +02:00 коммит произвёл Ingo Molnar
Родитель 4eedb77a9c
Коммит 0c1061733a
1 изменённых файлов: 13 добавлений и 0 удалений

Просмотреть файл

@ -145,6 +145,19 @@ int max_lock_depth = 1024;
/* /*
* Adjust the priority chain. Also used for deadlock detection. * Adjust the priority chain. Also used for deadlock detection.
* Decreases task's usage by one - may thus free the task. * Decreases task's usage by one - may thus free the task.
*
* @task: the task owning the mutex (owner) for which a chain walk is probably
* needed
* @deadlock_detect: do we have to carry out deadlock detection?
* @orig_lock: the mutex (can be NULL if we are walking the chain to recheck
* things for a task that has just got its priority adjusted, and
* is waiting on a mutex)
* @orig_waiter: rt_mutex_waiter struct for the task that has just donated
* its priority to the mutex owner (can be NULL in the case
* depicted above or if the top waiter is gone away and we are
* actually deboosting the owner)
* @top_task: the current top waiter
*
* Returns 0 or -EDEADLK. * Returns 0 or -EDEADLK.
*/ */
static int rt_mutex_adjust_prio_chain(struct task_struct *task, static int rt_mutex_adjust_prio_chain(struct task_struct *task,