dect
/
linux-2.6
Archived
13
0
Fork 0
Code Releases Activity

PM / Freezer / Docs: Update documentation about freezing of tasks 

The file Documentation/power/freezing-of-tasks.txt was still referencing
the TIF_FREEZE flag, that was removed by the commit
d88e4cb67197d007fb778d62fe17360e970d5bfa(freezer: remove now unused
TIF_FREEZE).

This patch removes all the references of TIF_FREEZE that were left
behind.

Signed-off-by: Marcos Paulo de Souza <marcos.souza.org@gmail.com>
Signed-off-by: Srivatsa S. Bhat <srivatsa.bhat@linux.vnet.ibm.com>
Signed-off-by: Rafael J. Wysocki <rjw@sisk.pl>
This commit is contained in:
Marcos Paulo de Souza 2012-04-29 22:29:30 +02:00 committed by Rafael J. Wysocki
parent f8262d4768
commit 26e0f90fde
1 changed files with 19 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
Documentation/power/freezing-of-tasks.txt
View File

@ -9,7 +9,7 @@ architectures).
II. How does it work? II. How does it work?
There are four per-task flags used for that, PF_NOFREEZE, PF_FROZEN, TIF_FREEZE There are three per-task flags used for that, PF_NOFREEZE, PF_FROZEN
and PF_FREEZER_SKIP (the last one is auxiliary). The tasks that have and PF_FREEZER_SKIP (the last one is auxiliary). The tasks that have
PF_NOFREEZE unset (all user space processes and some kernel threads) are PF_NOFREEZE unset (all user space processes and some kernel threads) are
regarded as 'freezable' and treated in a special way before the system enters a regarded as 'freezable' and treated in a special way before the system enters a
@ -17,30 +17,31 @@ suspend state as well as before a hibernation image is created (in what follows
we only consider hibernation, but the description also applies to suspend). we only consider hibernation, but the description also applies to suspend).
Namely, as the first step of the hibernation procedure the function Namely, as the first step of the hibernation procedure the function
freeze_processes() (defined in kernel/power/process.c) is called. It executes freeze_processes() (defined in kernel/power/process.c) is called. A system-wide
try_to_freeze_tasks() that sets TIF_FREEZE for all of the freezable tasks and variable system_freezing_cnt (as opposed to a per-task flag) is used to indicate
either wakes them up, if they are kernel threads, or sends fake signals to them, whether the system is to undergo a freezing operation. And freeze_processes()
if they are user space processes. A task that has TIF_FREEZE set, should react sets this variable. After this, it executes try_to_freeze_tasks() that sends a
to it by calling the function called __refrigerator() (defined in fake signal to all user space processes, and wakes up all the kernel threads.
kernel/freezer.c), which sets the task's PF_FROZEN flag, changes its state All freezable tasks must react to that by calling try_to_freeze(), which
to TASK_UNINTERRUPTIBLE and makes it loop until PF_FROZEN is cleared for it. results in a call to __refrigerator() (defined in kernel/freezer.c), which sets
Then, we say that the task is 'frozen' and therefore the set of functions the task's PF_FROZEN flag, changes its state to TASK_UNINTERRUPTIBLE and makes
handling this mechanism is referred to as 'the freezer' (these functions are it loop until PF_FROZEN is cleared for it. Then, we say that the task is
defined in kernel/power/process.c, kernel/freezer.c & include/linux/freezer.h). 'frozen' and therefore the set of functions handling this mechanism is referred
User space processes are generally frozen before kernel threads. to as 'the freezer' (these functions are defined in kernel/power/process.c,
kernel/freezer.c & include/linux/freezer.h). User space processes are generally
frozen before kernel threads.
__refrigerator() must not be called directly. Instead, use the __refrigerator() must not be called directly. Instead, use the
try_to_freeze() function (defined in include/linux/freezer.h), that checks try_to_freeze() function (defined in include/linux/freezer.h), that checks
the task's TIF_FREEZE flag and makes the task enter __refrigerator() if the if the task is to be frozen and makes the task enter __refrigerator().
flag is set.
For user space processes try_to_freeze() is called automatically from the For user space processes try_to_freeze() is called automatically from the
signal-handling code, but the freezable kernel threads need to call it signal-handling code, but the freezable kernel threads need to call it
explicitly in suitable places or use the wait_event_freezable() or explicitly in suitable places or use the wait_event_freezable() or
wait_event_freezable_timeout() macros (defined in include/linux/freezer.h) wait_event_freezable_timeout() macros (defined in include/linux/freezer.h)
that combine interruptible sleep with checking if TIF_FREEZE is set and calling that combine interruptible sleep with checking if the task is to be frozen and
try_to_freeze(). The main loop of a freezable kernel thread may look like the calling try_to_freeze(). The main loop of a freezable kernel thread may look
following one: like the following one:
set_freezable(); set_freezable();
do { do {
@ -53,7 +54,7 @@ following one:
(from drivers/usb/core/hub.c::hub_thread()). (from drivers/usb/core/hub.c::hub_thread()).
If a freezable kernel thread fails to call try_to_freeze() after the freezer has If a freezable kernel thread fails to call try_to_freeze() after the freezer has
set TIF_FREEZE for it, the freezing of tasks will fail and the entire initiated a freezing operation, the freezing of tasks will fail and the entire
hibernation operation will be cancelled. For this reason, freezable kernel hibernation operation will be cancelled. For this reason, freezable kernel
threads must call try_to_freeze() somewhere or use one of the threads must call try_to_freeze() somewhere or use one of the
wait_event_freezable() and wait_event_freezable_timeout() macros. wait_event_freezable() and wait_event_freezable_timeout() macros.