Loading...
1#include <linux/suspend.h>
2#include <linux/suspend_ioctls.h>
3#include <linux/utsname.h>
4#include <linux/freezer.h>
5
6struct swsusp_info {
7 struct new_utsname uts;
8 u32 version_code;
9 unsigned long num_physpages;
10 int cpus;
11 unsigned long image_pages;
12 unsigned long pages;
13 unsigned long size;
14} __attribute__((aligned(PAGE_SIZE)));
15
16#ifdef CONFIG_HIBERNATION
17/* kernel/power/snapshot.c */
18extern void __init hibernate_reserved_size_init(void);
19extern void __init hibernate_image_size_init(void);
20
21#ifdef CONFIG_ARCH_HIBERNATION_HEADER
22/* Maximum size of architecture specific data in a hibernation header */
23#define MAX_ARCH_HEADER_SIZE (sizeof(struct new_utsname) + 4)
24
25extern int arch_hibernation_header_save(void *addr, unsigned int max_size);
26extern int arch_hibernation_header_restore(void *addr);
27
28static inline int init_header_complete(struct swsusp_info *info)
29{
30 return arch_hibernation_header_save(info, MAX_ARCH_HEADER_SIZE);
31}
32
33static inline char *check_image_kernel(struct swsusp_info *info)
34{
35 return arch_hibernation_header_restore(info) ?
36 "architecture specific data" : NULL;
37}
38#endif /* CONFIG_ARCH_HIBERNATION_HEADER */
39
40/*
41 * Keep some memory free so that I/O operations can succeed without paging
42 * [Might this be more than 4 MB?]
43 */
44#define PAGES_FOR_IO ((4096 * 1024) >> PAGE_SHIFT)
45
46/*
47 * Keep 1 MB of memory free so that device drivers can allocate some pages in
48 * their .suspend() routines without breaking the suspend to disk.
49 */
50#define SPARE_PAGES ((1024 * 1024) >> PAGE_SHIFT)
51
52/* kernel/power/hibernate.c */
53extern int hibernation_snapshot(int platform_mode);
54extern int hibernation_restore(int platform_mode);
55extern int hibernation_platform_enter(void);
56
57#else /* !CONFIG_HIBERNATION */
58
59static inline void hibernate_reserved_size_init(void) {}
60static inline void hibernate_image_size_init(void) {}
61#endif /* !CONFIG_HIBERNATION */
62
63extern int pfn_is_nosave(unsigned long);
64
65#define power_attr(_name) \
66static struct kobj_attribute _name##_attr = { \
67 .attr = { \
68 .name = __stringify(_name), \
69 .mode = 0644, \
70 }, \
71 .show = _name##_show, \
72 .store = _name##_store, \
73}
74
75/* Preferred image size in bytes (default 500 MB) */
76extern unsigned long image_size;
77/* Size of memory reserved for drivers (default SPARE_PAGES x PAGE_SIZE) */
78extern unsigned long reserved_size;
79extern int in_suspend;
80extern dev_t swsusp_resume_device;
81extern sector_t swsusp_resume_block;
82
83extern asmlinkage int swsusp_arch_suspend(void);
84extern asmlinkage int swsusp_arch_resume(void);
85
86extern int create_basic_memory_bitmaps(void);
87extern void free_basic_memory_bitmaps(void);
88extern int hibernate_preallocate_memory(void);
89
90/**
91 * Auxiliary structure used for reading the snapshot image data and
92 * metadata from and writing them to the list of page backup entries
93 * (PBEs) which is the main data structure of swsusp.
94 *
95 * Using struct snapshot_handle we can transfer the image, including its
96 * metadata, as a continuous sequence of bytes with the help of
97 * snapshot_read_next() and snapshot_write_next().
98 *
99 * The code that writes the image to a storage or transfers it to
100 * the user land is required to use snapshot_read_next() for this
101 * purpose and it should not make any assumptions regarding the internal
102 * structure of the image. Similarly, the code that reads the image from
103 * a storage or transfers it from the user land is required to use
104 * snapshot_write_next().
105 *
106 * This may allow us to change the internal structure of the image
107 * in the future with considerably less effort.
108 */
109
110struct snapshot_handle {
111 unsigned int cur; /* number of the block of PAGE_SIZE bytes the
112 * next operation will refer to (ie. current)
113 */
114 void *buffer; /* address of the block to read from
115 * or write to
116 */
117 int sync_read; /* Set to one to notify the caller of
118 * snapshot_write_next() that it may
119 * need to call wait_on_bio_chain()
120 */
121};
122
123/* This macro returns the address from/to which the caller of
124 * snapshot_read_next()/snapshot_write_next() is allowed to
125 * read/write data after the function returns
126 */
127#define data_of(handle) ((handle).buffer)
128
129extern unsigned int snapshot_additional_pages(struct zone *zone);
130extern unsigned long snapshot_get_image_size(void);
131extern int snapshot_read_next(struct snapshot_handle *handle);
132extern int snapshot_write_next(struct snapshot_handle *handle);
133extern void snapshot_write_finalize(struct snapshot_handle *handle);
134extern int snapshot_image_loaded(struct snapshot_handle *handle);
135
136/* If unset, the snapshot device cannot be open. */
137extern atomic_t snapshot_device_available;
138
139extern sector_t alloc_swapdev_block(int swap);
140extern void free_all_swap_pages(int swap);
141extern int swsusp_swap_in_use(void);
142
143/*
144 * Flags that can be passed from the hibernatig hernel to the "boot" kernel in
145 * the image header.
146 */
147#define SF_PLATFORM_MODE 1
148#define SF_NOCOMPRESS_MODE 2
149
150/* kernel/power/hibernate.c */
151extern int swsusp_check(void);
152extern void swsusp_free(void);
153extern int swsusp_read(unsigned int *flags_p);
154extern int swsusp_write(unsigned int flags);
155extern void swsusp_close(fmode_t);
156
157/* kernel/power/block_io.c */
158extern struct block_device *hib_resume_bdev;
159
160extern int hib_bio_read_page(pgoff_t page_off, void *addr,
161 struct bio **bio_chain);
162extern int hib_bio_write_page(pgoff_t page_off, void *addr,
163 struct bio **bio_chain);
164extern int hib_wait_on_bio_chain(struct bio **bio_chain);
165
166struct timeval;
167/* kernel/power/swsusp.c */
168extern void swsusp_show_speed(struct timeval *, struct timeval *,
169 unsigned int, char *);
170
171#ifdef CONFIG_SUSPEND
172/* kernel/power/suspend.c */
173extern const char *const pm_states[];
174
175extern bool valid_state(suspend_state_t state);
176extern int suspend_devices_and_enter(suspend_state_t state);
177extern int enter_state(suspend_state_t state);
178#else /* !CONFIG_SUSPEND */
179static inline int suspend_devices_and_enter(suspend_state_t state)
180{
181 return -ENOSYS;
182}
183static inline int enter_state(suspend_state_t state) { return -ENOSYS; }
184static inline bool valid_state(suspend_state_t state) { return false; }
185#endif /* !CONFIG_SUSPEND */
186
187#ifdef CONFIG_PM_TEST_SUSPEND
188/* kernel/power/suspend_test.c */
189extern void suspend_test_start(void);
190extern void suspend_test_finish(const char *label);
191#else /* !CONFIG_PM_TEST_SUSPEND */
192static inline void suspend_test_start(void) {}
193static inline void suspend_test_finish(const char *label) {}
194#endif /* !CONFIG_PM_TEST_SUSPEND */
195
196#ifdef CONFIG_PM_SLEEP
197/* kernel/power/main.c */
198extern int pm_notifier_call_chain(unsigned long val);
199#endif
200
201#ifdef CONFIG_HIGHMEM
202int restore_highmem(void);
203#else
204static inline unsigned int count_highmem_pages(void) { return 0; }
205static inline int restore_highmem(void) { return 0; }
206#endif
207
208/*
209 * Suspend test levels
210 */
211enum {
212 /* keep first */
213 TEST_NONE,
214 TEST_CORE,
215 TEST_CPUS,
216 TEST_PLATFORM,
217 TEST_DEVICES,
218 TEST_FREEZER,
219 /* keep last */
220 __TEST_AFTER_LAST
221};
222
223#define TEST_FIRST TEST_NONE
224#define TEST_MAX (__TEST_AFTER_LAST - 1)
225
226extern int pm_test_level;
227
228#ifdef CONFIG_SUSPEND_FREEZER
229static inline int suspend_freeze_processes(void)
230{
231 return freeze_processes();
232}
233
234static inline void suspend_thaw_processes(void)
235{
236 thaw_processes();
237}
238#else
239static inline int suspend_freeze_processes(void)
240{
241 return 0;
242}
243
244static inline void suspend_thaw_processes(void)
245{
246}
247#endif
1/* SPDX-License-Identifier: GPL-2.0 */
2#include <linux/suspend.h>
3#include <linux/suspend_ioctls.h>
4#include <linux/utsname.h>
5#include <linux/freezer.h>
6#include <linux/compiler.h>
7
8struct swsusp_info {
9 struct new_utsname uts;
10 u32 version_code;
11 unsigned long num_physpages;
12 int cpus;
13 unsigned long image_pages;
14 unsigned long pages;
15 unsigned long size;
16} __aligned(PAGE_SIZE);
17
18#ifdef CONFIG_HIBERNATION
19/* kernel/power/snapshot.c */
20extern void __init hibernate_reserved_size_init(void);
21extern void __init hibernate_image_size_init(void);
22
23#ifdef CONFIG_ARCH_HIBERNATION_HEADER
24/* Maximum size of architecture specific data in a hibernation header */
25#define MAX_ARCH_HEADER_SIZE (sizeof(struct new_utsname) + 4)
26
27extern int arch_hibernation_header_save(void *addr, unsigned int max_size);
28extern int arch_hibernation_header_restore(void *addr);
29
30static inline int init_header_complete(struct swsusp_info *info)
31{
32 return arch_hibernation_header_save(info, MAX_ARCH_HEADER_SIZE);
33}
34
35static inline const char *check_image_kernel(struct swsusp_info *info)
36{
37 return arch_hibernation_header_restore(info) ?
38 "architecture specific data" : NULL;
39}
40#endif /* CONFIG_ARCH_HIBERNATION_HEADER */
41
42extern int hibernate_resume_nonboot_cpu_disable(void);
43
44/*
45 * Keep some memory free so that I/O operations can succeed without paging
46 * [Might this be more than 4 MB?]
47 */
48#define PAGES_FOR_IO ((4096 * 1024) >> PAGE_SHIFT)
49
50/*
51 * Keep 1 MB of memory free so that device drivers can allocate some pages in
52 * their .suspend() routines without breaking the suspend to disk.
53 */
54#define SPARE_PAGES ((1024 * 1024) >> PAGE_SHIFT)
55
56asmlinkage int swsusp_save(void);
57
58/* kernel/power/hibernate.c */
59extern bool freezer_test_done;
60
61extern int hibernation_snapshot(int platform_mode);
62extern int hibernation_restore(int platform_mode);
63extern int hibernation_platform_enter(void);
64
65#ifdef CONFIG_STRICT_KERNEL_RWX
66/* kernel/power/snapshot.c */
67extern void enable_restore_image_protection(void);
68#else
69static inline void enable_restore_image_protection(void) {}
70#endif /* CONFIG_STRICT_KERNEL_RWX */
71
72#else /* !CONFIG_HIBERNATION */
73
74static inline void hibernate_reserved_size_init(void) {}
75static inline void hibernate_image_size_init(void) {}
76#endif /* !CONFIG_HIBERNATION */
77
78#define power_attr(_name) \
79static struct kobj_attribute _name##_attr = { \
80 .attr = { \
81 .name = __stringify(_name), \
82 .mode = 0644, \
83 }, \
84 .show = _name##_show, \
85 .store = _name##_store, \
86}
87
88#define power_attr_ro(_name) \
89static struct kobj_attribute _name##_attr = { \
90 .attr = { \
91 .name = __stringify(_name), \
92 .mode = S_IRUGO, \
93 }, \
94 .show = _name##_show, \
95}
96
97/* Preferred image size in bytes (default 500 MB) */
98extern unsigned long image_size;
99/* Size of memory reserved for drivers (default SPARE_PAGES x PAGE_SIZE) */
100extern unsigned long reserved_size;
101extern int in_suspend;
102extern dev_t swsusp_resume_device;
103extern sector_t swsusp_resume_block;
104
105extern int create_basic_memory_bitmaps(void);
106extern void free_basic_memory_bitmaps(void);
107extern int hibernate_preallocate_memory(void);
108
109extern void clear_or_poison_free_pages(void);
110
111/**
112 * Auxiliary structure used for reading the snapshot image data and
113 * metadata from and writing them to the list of page backup entries
114 * (PBEs) which is the main data structure of swsusp.
115 *
116 * Using struct snapshot_handle we can transfer the image, including its
117 * metadata, as a continuous sequence of bytes with the help of
118 * snapshot_read_next() and snapshot_write_next().
119 *
120 * The code that writes the image to a storage or transfers it to
121 * the user land is required to use snapshot_read_next() for this
122 * purpose and it should not make any assumptions regarding the internal
123 * structure of the image. Similarly, the code that reads the image from
124 * a storage or transfers it from the user land is required to use
125 * snapshot_write_next().
126 *
127 * This may allow us to change the internal structure of the image
128 * in the future with considerably less effort.
129 */
130
131struct snapshot_handle {
132 unsigned int cur; /* number of the block of PAGE_SIZE bytes the
133 * next operation will refer to (ie. current)
134 */
135 void *buffer; /* address of the block to read from
136 * or write to
137 */
138 int sync_read; /* Set to one to notify the caller of
139 * snapshot_write_next() that it may
140 * need to call wait_on_bio_chain()
141 */
142};
143
144/* This macro returns the address from/to which the caller of
145 * snapshot_read_next()/snapshot_write_next() is allowed to
146 * read/write data after the function returns
147 */
148#define data_of(handle) ((handle).buffer)
149
150extern unsigned int snapshot_additional_pages(struct zone *zone);
151extern unsigned long snapshot_get_image_size(void);
152extern int snapshot_read_next(struct snapshot_handle *handle);
153extern int snapshot_write_next(struct snapshot_handle *handle);
154extern void snapshot_write_finalize(struct snapshot_handle *handle);
155extern int snapshot_image_loaded(struct snapshot_handle *handle);
156
157extern bool hibernate_acquire(void);
158extern void hibernate_release(void);
159
160extern sector_t alloc_swapdev_block(int swap);
161extern void free_all_swap_pages(int swap);
162extern int swsusp_swap_in_use(void);
163
164/*
165 * Flags that can be passed from the hibernatig hernel to the "boot" kernel in
166 * the image header.
167 */
168#define SF_PLATFORM_MODE 1
169#define SF_NOCOMPRESS_MODE 2
170#define SF_CRC32_MODE 4
171
172/* kernel/power/hibernate.c */
173extern int swsusp_check(void);
174extern void swsusp_free(void);
175extern int swsusp_read(unsigned int *flags_p);
176extern int swsusp_write(unsigned int flags);
177extern void swsusp_close(fmode_t);
178#ifdef CONFIG_SUSPEND
179extern int swsusp_unmark(void);
180#endif
181
182struct __kernel_old_timeval;
183/* kernel/power/swsusp.c */
184extern void swsusp_show_speed(ktime_t, ktime_t, unsigned int, char *);
185
186#ifdef CONFIG_SUSPEND
187/* kernel/power/suspend.c */
188extern const char * const pm_labels[];
189extern const char *pm_states[];
190extern const char *mem_sleep_states[];
191
192extern int suspend_devices_and_enter(suspend_state_t state);
193#else /* !CONFIG_SUSPEND */
194#define mem_sleep_current PM_SUSPEND_ON
195
196static inline int suspend_devices_and_enter(suspend_state_t state)
197{
198 return -ENOSYS;
199}
200#endif /* !CONFIG_SUSPEND */
201
202#ifdef CONFIG_PM_TEST_SUSPEND
203/* kernel/power/suspend_test.c */
204extern void suspend_test_start(void);
205extern void suspend_test_finish(const char *label);
206#else /* !CONFIG_PM_TEST_SUSPEND */
207static inline void suspend_test_start(void) {}
208static inline void suspend_test_finish(const char *label) {}
209#endif /* !CONFIG_PM_TEST_SUSPEND */
210
211#ifdef CONFIG_PM_SLEEP
212/* kernel/power/main.c */
213extern int pm_notifier_call_chain_robust(unsigned long val_up, unsigned long val_down);
214extern int pm_notifier_call_chain(unsigned long val);
215#endif
216
217#ifdef CONFIG_HIGHMEM
218int restore_highmem(void);
219#else
220static inline unsigned int count_highmem_pages(void) { return 0; }
221static inline int restore_highmem(void) { return 0; }
222#endif
223
224/*
225 * Suspend test levels
226 */
227enum {
228 /* keep first */
229 TEST_NONE,
230 TEST_CORE,
231 TEST_CPUS,
232 TEST_PLATFORM,
233 TEST_DEVICES,
234 TEST_FREEZER,
235 /* keep last */
236 __TEST_AFTER_LAST
237};
238
239#define TEST_FIRST TEST_NONE
240#define TEST_MAX (__TEST_AFTER_LAST - 1)
241
242#ifdef CONFIG_PM_SLEEP_DEBUG
243extern int pm_test_level;
244#else
245#define pm_test_level (TEST_NONE)
246#endif
247
248#ifdef CONFIG_SUSPEND_FREEZER
249static inline int suspend_freeze_processes(void)
250{
251 int error;
252
253 error = freeze_processes();
254 /*
255 * freeze_processes() automatically thaws every task if freezing
256 * fails. So we need not do anything extra upon error.
257 */
258 if (error)
259 return error;
260
261 error = freeze_kernel_threads();
262 /*
263 * freeze_kernel_threads() thaws only kernel threads upon freezing
264 * failure. So we have to thaw the userspace tasks ourselves.
265 */
266 if (error)
267 thaw_processes();
268
269 return error;
270}
271
272static inline void suspend_thaw_processes(void)
273{
274 thaw_processes();
275}
276#else
277static inline int suspend_freeze_processes(void)
278{
279 return 0;
280}
281
282static inline void suspend_thaw_processes(void)
283{
284}
285#endif
286
287#ifdef CONFIG_PM_AUTOSLEEP
288
289/* kernel/power/autosleep.c */
290extern int pm_autosleep_init(void);
291extern int pm_autosleep_lock(void);
292extern void pm_autosleep_unlock(void);
293extern suspend_state_t pm_autosleep_state(void);
294extern int pm_autosleep_set_state(suspend_state_t state);
295
296#else /* !CONFIG_PM_AUTOSLEEP */
297
298static inline int pm_autosleep_init(void) { return 0; }
299static inline int pm_autosleep_lock(void) { return 0; }
300static inline void pm_autosleep_unlock(void) {}
301static inline suspend_state_t pm_autosleep_state(void) { return PM_SUSPEND_ON; }
302
303#endif /* !CONFIG_PM_AUTOSLEEP */
304
305#ifdef CONFIG_PM_WAKELOCKS
306
307/* kernel/power/wakelock.c */
308extern ssize_t pm_show_wakelocks(char *buf, bool show_active);
309extern int pm_wake_lock(const char *buf);
310extern int pm_wake_unlock(const char *buf);
311
312#endif /* !CONFIG_PM_WAKELOCKS */