include/linux/freezer.h

   1 /* Freezer declarations */
   2
   3 #ifndef FREEZER_H_INCLUDED
   4 #define FREEZER_H_INCLUDED
   5
   6 #include <linux/sched.h>
   7 #include <linux/wait.h>
   8 #include <linux/atomic.h>
   9
  10 #ifdef CONFIG_FREEZER
  11 extern atomic_t system_freezing_cnt;    /* nr of freezing conds in effect */
  12 extern bool pm_freezing;                /* PM freezing in effect */
  13 extern bool pm_nosig_freezing;          /* PM nosig freezing in effect */
  14
  15 /*
  16  * Check if a process has been frozen
  17  */
  18 static inline bool frozen(struct task_struct *p)
  19 {
  20         return p->flags & PF_FROZEN;
  21 }
  22
  23 extern bool freezing_slow_path(struct task_struct *p);
  24
  25 /*
  26  * Check if there is a request to freeze a process
  27  */
  28 static inline bool freezing(struct task_struct *p)
  29 {
  30         if (likely(!atomic_read(&system_freezing_cnt)))
  31                 return false;
  32         return freezing_slow_path(p);
  33 }
  34
  35 /* Takes and releases task alloc lock using task_lock() */
  36 extern void __thaw_task(struct task_struct *t);
  37
  38 extern bool __refrigerator(bool check_kthr_stop);
  39 extern int freeze_processes(void);
  40 extern int freeze_kernel_threads(void);
  41 extern void thaw_processes(void);
  42
  43 static inline bool try_to_freeze(void)
  44 {
  45         might_sleep();
  46         if (likely(!freezing(current)))
  47                 return false;
  48         return __refrigerator(false);
  49 }
  50
  51 extern bool freeze_task(struct task_struct *p, bool sig_only);
  52 extern bool __set_freezable(bool with_signal);
  53
  54 #ifdef CONFIG_CGROUP_FREEZER
  55 extern bool cgroup_freezing(struct task_struct *task);
  56 #else /* !CONFIG_CGROUP_FREEZER */
  57 static inline bool cgroup_freezing(struct task_struct *task)
  58 {
  59         return false;
  60 }
  61 #endif /* !CONFIG_CGROUP_FREEZER */
  62
  63 /*
  64  * The PF_FREEZER_SKIP flag should be set by a vfork parent right before it
  65  * calls wait_for_completion(&vfork) and reset right after it returns from this
  66  * function.  Next, the parent should call try_to_freeze() to freeze itself
  67  * appropriately in case the child has exited before the freezing of tasks is
  68  * complete.  However, we don't want kernel threads to be frozen in unexpected
  69  * places, so we allow them to block freeze_processes() instead or to set
  70  * PF_NOFREEZE if needed and PF_FREEZER_SKIP is only set for userland vfork
  71  * parents.  Fortunately, in the ____call_usermodehelper() case the parent won't
  72  * really block freeze_processes(), since ____call_usermodehelper() (the child)
  73  * does a little before exec/exit and it can't be frozen before waking up the
  74  * parent.
  75  */
  76
  77 /*
  78  * If the current task is a user space one, tell the freezer not to count it as
  79  * freezable.
  80  */
  81 static inline void freezer_do_not_count(void)
  82 {
  83         if (current->mm)
  84                 current->flags |= PF_FREEZER_SKIP;
  85 }
  86
  87 /*
  88  * If the current task is a user space one, tell the freezer to count it as
  89  * freezable again and try to freeze it.
  90  */
  91 static inline void freezer_count(void)
  92 {
  93         if (current->mm) {
  94                 current->flags &= ~PF_FREEZER_SKIP;
  95                 try_to_freeze();
  96         }
  97 }
  98
  99 /*
 100  * Check if the task should be counted as freezable by the freezer
 101  */
 102 static inline int freezer_should_skip(struct task_struct *p)
 103 {
 104         return !!(p->flags & PF_FREEZER_SKIP);
 105 }
 106
 107 /*
 108  * Tell the freezer that the current task should be frozen by it
 109  */
 110 static inline bool set_freezable(void)
 111 {
 112         return __set_freezable(false);
 113 }
 114
 115 /*
 116  * Tell the freezer that the current task should be frozen by it and that it
 117  * should send a fake signal to the task to freeze it.
 118  */
 119 static inline bool set_freezable_with_signal(void)
 120 {
 121         return __set_freezable(true);
 122 }
 123
 124 /*
 125  * Freezer-friendly wrappers around wait_event_interruptible(),
 126  * wait_event_killable() and wait_event_interruptible_timeout(), originally
 127  * defined in <linux/wait.h>
 128  */
 129
 130 #define wait_event_freezekillable(wq, condition)                        \
 131 ({                                                                      \
 132         int __retval;                                                   \
 133         freezer_do_not_count();                                         \
 134         __retval = wait_event_killable(wq, (condition));                \
 135         freezer_count();                                                \
 136         __retval;                                                       \
 137 })
 138
 139 #define wait_event_freezable(wq, condition)                             \
 140 ({                                                                      \
 141         int __retval;                                                   \
 142         do {                                                            \
 143                 __retval = wait_event_interruptible(wq,                 \
 144                                 (condition) || freezing(current));      \
 145                 if (__retval && !freezing(current))                     \
 146                         break;                                          \
 147                 else if (!(condition))                                  \
 148                         __retval = -ERESTARTSYS;                        \
 149         } while (try_to_freeze());                                      \
 150         __retval;                                                       \
 151 })
 152
 153
 154 #define wait_event_freezable_timeout(wq, condition, timeout)            \
 155 ({                                                                      \
 156         long __retval = timeout;                                        \
 157         do {                                                            \
 158                 __retval = wait_event_interruptible_timeout(wq,         \
 159                                 (condition) || freezing(current),       \
 160                                 __retval);                              \
 161         } while (try_to_freeze());                                      \
 162         __retval;                                                       \
 163 })
 164 #else /* !CONFIG_FREEZER */
 165 static inline bool frozen(struct task_struct *p) { return false; }
 166 static inline bool freezing(struct task_struct *p) { return false; }
 167
 168 static inline bool __refrigerator(bool check_kthr_stop) { return false; }
 169 static inline int freeze_processes(void) { return -ENOSYS; }
 170 static inline int freeze_kernel_threads(void) { return -ENOSYS; }
 171 static inline void thaw_processes(void) {}
 172
 173 static inline bool try_to_freeze(void) { return false; }
 174
 175 static inline void freezer_do_not_count(void) {}
 176 static inline void freezer_count(void) {}
 177 static inline int freezer_should_skip(struct task_struct *p) { return 0; }
 178 static inline void set_freezable(void) {}
 179 static inline void set_freezable_with_signal(void) {}
 180
 181 #define wait_event_freezable(wq, condition)                             \
 182                 wait_event_interruptible(wq, condition)
 183
 184 #define wait_event_freezable_timeout(wq, condition, timeout)            \
 185                 wait_event_interruptible_timeout(wq, condition, timeout)
 186
 187 #define wait_event_freezekillable(wq, condition)                \
 188                 wait_event_killable(wq, condition)
 189
 190 #endif /* !CONFIG_FREEZER */
 191
 192 #endif  /* FREEZER_H_INCLUDED */