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