Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | #include <linux/suspend.h> |
2 | #include <linux/utsname.h> | |
3 | ||
1da177e4 LT |
4 | struct swsusp_info { |
5 | struct new_utsname uts; | |
6 | u32 version_code; | |
7 | unsigned long num_physpages; | |
8 | int cpus; | |
9 | unsigned long image_pages; | |
7088a5c0 | 10 | unsigned long pages; |
6e1819d6 | 11 | unsigned long size; |
1da177e4 LT |
12 | } __attribute__((aligned(PAGE_SIZE))); |
13 | ||
14 | ||
15 | ||
16 | #ifdef CONFIG_SOFTWARE_SUSPEND | |
17 | extern int pm_suspend_disk(void); | |
18 | ||
19 | #else | |
20 | static inline int pm_suspend_disk(void) | |
21 | { | |
22 | return -EPERM; | |
23 | } | |
24 | #endif | |
25 | extern struct semaphore pm_sem; | |
26 | #define power_attr(_name) \ | |
27 | static struct subsys_attribute _name##_attr = { \ | |
28 | .attr = { \ | |
29 | .name = __stringify(_name), \ | |
30 | .mode = 0644, \ | |
31 | }, \ | |
32 | .show = _name##_show, \ | |
33 | .store = _name##_store, \ | |
34 | } | |
35 | ||
36 | extern struct subsystem power_subsys; | |
37 | ||
25761b6e RW |
38 | /* References to section boundaries */ |
39 | extern const void __nosave_begin, __nosave_end; | |
40 | ||
853609b6 RW |
41 | /* Preferred image size in bytes (default 500 MB) */ |
42 | extern unsigned long image_size; | |
f577eb30 | 43 | extern int in_suspend; |
61159a31 | 44 | extern dev_t swsusp_resume_device; |
9a154d9d | 45 | extern sector_t swsusp_resume_block; |
f577eb30 | 46 | |
25761b6e RW |
47 | extern asmlinkage int swsusp_arch_suspend(void); |
48 | extern asmlinkage int swsusp_arch_resume(void); | |
49 | ||
72a97e08 | 50 | extern unsigned int count_data_pages(void); |
f577eb30 | 51 | |
fb13a28b RW |
52 | /** |
53 | * Auxiliary structure used for reading the snapshot image data and | |
54 | * metadata from and writing them to the list of page backup entries | |
55 | * (PBEs) which is the main data structure of swsusp. | |
56 | * | |
57 | * Using struct snapshot_handle we can transfer the image, including its | |
58 | * metadata, as a continuous sequence of bytes with the help of | |
59 | * snapshot_read_next() and snapshot_write_next(). | |
60 | * | |
61 | * The code that writes the image to a storage or transfers it to | |
62 | * the user land is required to use snapshot_read_next() for this | |
63 | * purpose and it should not make any assumptions regarding the internal | |
64 | * structure of the image. Similarly, the code that reads the image from | |
65 | * a storage or transfers it from the user land is required to use | |
66 | * snapshot_write_next(). | |
67 | * | |
68 | * This may allow us to change the internal structure of the image | |
69 | * in the future with considerably less effort. | |
70 | */ | |
71 | ||
f577eb30 | 72 | struct snapshot_handle { |
fb13a28b RW |
73 | loff_t offset; /* number of the last byte ready for reading |
74 | * or writing in the sequence | |
75 | */ | |
76 | unsigned int cur; /* number of the block of PAGE_SIZE bytes the | |
77 | * next operation will refer to (ie. current) | |
78 | */ | |
79 | unsigned int cur_offset; /* offset with respect to the current | |
80 | * block (for the next operation) | |
81 | */ | |
82 | unsigned int prev; /* number of the block of PAGE_SIZE bytes that | |
83 | * was the current one previously | |
84 | */ | |
fb13a28b RW |
85 | void *buffer; /* address of the block to read from |
86 | * or write to | |
87 | */ | |
88 | unsigned int buf_offset; /* location to read from or write to, | |
89 | * given as a displacement from 'buffer' | |
90 | */ | |
91 | int sync_read; /* Set to one to notify the caller of | |
92 | * snapshot_write_next() that it may | |
93 | * need to call wait_on_bio_chain() | |
94 | */ | |
f577eb30 RW |
95 | }; |
96 | ||
fb13a28b RW |
97 | /* This macro returns the address from/to which the caller of |
98 | * snapshot_read_next()/snapshot_write_next() is allowed to | |
99 | * read/write data after the function returns | |
100 | */ | |
f577eb30 RW |
101 | #define data_of(handle) ((handle).buffer + (handle).buf_offset) |
102 | ||
b788db79 | 103 | extern unsigned int snapshot_additional_pages(struct zone *zone); |
f577eb30 RW |
104 | extern int snapshot_read_next(struct snapshot_handle *handle, size_t count); |
105 | extern int snapshot_write_next(struct snapshot_handle *handle, size_t count); | |
b788db79 | 106 | extern int snapshot_image_loaded(struct snapshot_handle *handle); |
940864dd | 107 | extern void snapshot_free_unused_memory(struct snapshot_handle *handle); |
61159a31 | 108 | |
37b2ba12 RW |
109 | /* |
110 | * This structure is used to pass the values needed for the identification | |
111 | * of the resume swap area from a user space to the kernel via the | |
112 | * SNAPSHOT_SET_SWAP_AREA ioctl | |
113 | */ | |
114 | struct resume_swap_area { | |
115 | loff_t offset; | |
116 | u_int32_t dev; | |
117 | } __attribute__((packed)); | |
118 | ||
6e1819d6 RW |
119 | #define SNAPSHOT_IOC_MAGIC '3' |
120 | #define SNAPSHOT_FREEZE _IO(SNAPSHOT_IOC_MAGIC, 1) | |
121 | #define SNAPSHOT_UNFREEZE _IO(SNAPSHOT_IOC_MAGIC, 2) | |
122 | #define SNAPSHOT_ATOMIC_SNAPSHOT _IOW(SNAPSHOT_IOC_MAGIC, 3, void *) | |
123 | #define SNAPSHOT_ATOMIC_RESTORE _IO(SNAPSHOT_IOC_MAGIC, 4) | |
124 | #define SNAPSHOT_FREE _IO(SNAPSHOT_IOC_MAGIC, 5) | |
125 | #define SNAPSHOT_SET_IMAGE_SIZE _IOW(SNAPSHOT_IOC_MAGIC, 6, unsigned long) | |
126 | #define SNAPSHOT_AVAIL_SWAP _IOR(SNAPSHOT_IOC_MAGIC, 7, void *) | |
127 | #define SNAPSHOT_GET_SWAP_PAGE _IOR(SNAPSHOT_IOC_MAGIC, 8, void *) | |
128 | #define SNAPSHOT_FREE_SWAP_PAGES _IO(SNAPSHOT_IOC_MAGIC, 9) | |
129 | #define SNAPSHOT_SET_SWAP_FILE _IOW(SNAPSHOT_IOC_MAGIC, 10, unsigned int) | |
9b238205 | 130 | #define SNAPSHOT_S2RAM _IO(SNAPSHOT_IOC_MAGIC, 11) |
3592695c | 131 | #define SNAPSHOT_PMOPS _IOW(SNAPSHOT_IOC_MAGIC, 12, unsigned int) |
37b2ba12 RW |
132 | #define SNAPSHOT_SET_SWAP_AREA _IOW(SNAPSHOT_IOC_MAGIC, 13, \ |
133 | struct resume_swap_area) | |
134 | #define SNAPSHOT_IOC_MAXNR 13 | |
3592695c SS |
135 | |
136 | #define PMOPS_PREPARE 1 | |
137 | #define PMOPS_ENTER 2 | |
138 | #define PMOPS_FINISH 3 | |
6e1819d6 | 139 | |
61159a31 RW |
140 | /** |
141 | * The bitmap is used for tracing allocated swap pages | |
142 | * | |
143 | * The entire bitmap consists of a number of bitmap_page | |
144 | * structures linked with the help of the .next member. | |
145 | * Thus each page can be allocated individually, so we only | |
146 | * need to make 0-order memory allocations to create | |
147 | * the bitmap. | |
148 | */ | |
149 | ||
150 | #define BITMAP_PAGE_SIZE (PAGE_SIZE - sizeof(void *)) | |
151 | #define BITMAP_PAGE_CHUNKS (BITMAP_PAGE_SIZE / sizeof(long)) | |
152 | #define BITS_PER_CHUNK (sizeof(long) * 8) | |
153 | #define BITMAP_PAGE_BITS (BITMAP_PAGE_CHUNKS * BITS_PER_CHUNK) | |
154 | ||
155 | struct bitmap_page { | |
156 | unsigned long chunks[BITMAP_PAGE_CHUNKS]; | |
157 | struct bitmap_page *next; | |
158 | }; | |
159 | ||
160 | extern void free_bitmap(struct bitmap_page *bitmap); | |
161 | extern struct bitmap_page *alloc_bitmap(unsigned int nr_bits); | |
3aef83e0 | 162 | extern sector_t alloc_swapdev_block(int swap, struct bitmap_page *bitmap); |
61159a31 RW |
163 | extern void free_all_swap_pages(int swap, struct bitmap_page *bitmap); |
164 | ||
74c7e2ef | 165 | extern int swsusp_check(void); |
61159a31 | 166 | extern int swsusp_shrink_memory(void); |
74c7e2ef | 167 | extern void swsusp_free(void); |
61159a31 RW |
168 | extern int swsusp_suspend(void); |
169 | extern int swsusp_resume(void); | |
74c7e2ef RD |
170 | extern int swsusp_read(void); |
171 | extern int swsusp_write(void); | |
172 | extern void swsusp_close(void); | |
9b238205 | 173 | extern int suspend_enter(suspend_state_t state); |