summaryrefslogtreecommitdiff
path: root/kernel/power/tuxonice.h
blob: 10b65633f39e8dbcbb880f6ba876ed897457956c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
/*
 * kernel/power/tuxonice.h
 *
 * Copyright (C) 2004-2015 Nigel Cunningham (nigel at nigelcunningham com au)
 *
 * This file is released under the GPLv2.
 *
 * It contains declarations used throughout swsusp.
 *
 */

#ifndef KERNEL_POWER_TOI_H
#define KERNEL_POWER_TOI_H

#include <linux/delay.h>
#include <linux/bootmem.h>
#include <linux/suspend.h>
#include <linux/fs.h>
#include <asm/setup.h>
#include "tuxonice_pageflags.h"
#include "power.h"

#define TOI_CORE_VERSION "3.3"
#define        TOI_HEADER_VERSION 3
#define MY_BOOT_KERNEL_DATA_VERSION 4

struct toi_boot_kernel_data {
        int version;
        int size;
        unsigned long toi_action;
        unsigned long toi_debug_state;
        u32 toi_default_console_level;
        int toi_io_time[2][2];
        char toi_nosave_commandline[COMMAND_LINE_SIZE];
        unsigned long pages_used[33];
        unsigned long incremental_bytes_in;
        unsigned long incremental_bytes_out;
        unsigned long compress_bytes_in;
        unsigned long compress_bytes_out;
        unsigned long pruned_pages;
};

extern struct toi_boot_kernel_data toi_bkd;

/* Location of book kernel data struct in kernel being resumed */
extern unsigned long boot_kernel_data_buffer;

/*                 == Action states ==                 */

enum {
        TOI_REBOOT,
        TOI_PAUSE,
        TOI_LOGALL,
        TOI_CAN_CANCEL,
        TOI_KEEP_IMAGE,
        TOI_FREEZER_TEST,
        TOI_SINGLESTEP,
        TOI_PAUSE_NEAR_PAGESET_END,
        TOI_TEST_FILTER_SPEED,
        TOI_TEST_BIO,
        TOI_NO_PAGESET2,
        TOI_IGNORE_ROOTFS,
        TOI_REPLACE_SWSUSP,
        TOI_PAGESET2_FULL,
        TOI_ABORT_ON_RESAVE_NEEDED,
        TOI_NO_MULTITHREADED_IO,
        TOI_NO_DIRECT_LOAD, /* Obsolete */
        TOI_LATE_CPU_HOTPLUG, /* Obsolete */
        TOI_GET_MAX_MEM_ALLOCD,
        TOI_NO_FLUSHER_THREAD,
        TOI_NO_PS2_IF_UNNEEDED,
        TOI_POST_RESUME_BREAKPOINT,
        TOI_NO_READAHEAD,
        TOI_TRACE_DEBUG_ON,
        TOI_INCREMENTAL_IMAGE,
};

extern unsigned long toi_bootflags_mask;

#define clear_action_state(bit) (test_and_clear_bit(bit, &toi_bkd.toi_action))

/*                 == Result states ==                 */

enum {
        TOI_ABORTED,
        TOI_ABORT_REQUESTED,
        TOI_NOSTORAGE_AVAILABLE,
        TOI_INSUFFICIENT_STORAGE,
        TOI_FREEZING_FAILED,
        TOI_KEPT_IMAGE,
        TOI_WOULD_EAT_MEMORY,
        TOI_UNABLE_TO_FREE_ENOUGH_MEMORY,
        TOI_PM_SEM,
        TOI_DEVICE_REFUSED,
        TOI_SYSDEV_REFUSED,
        TOI_EXTRA_PAGES_ALLOW_TOO_SMALL,
        TOI_UNABLE_TO_PREPARE_IMAGE,
        TOI_FAILED_MODULE_INIT,
        TOI_FAILED_MODULE_CLEANUP,
        TOI_FAILED_IO,
        TOI_OUT_OF_MEMORY,
        TOI_IMAGE_ERROR,
        TOI_PLATFORM_PREP_FAILED,
        TOI_CPU_HOTPLUG_FAILED,
        TOI_ARCH_PREPARE_FAILED, /* Removed Linux-3.0 */
        TOI_RESAVE_NEEDED,
        TOI_CANT_SUSPEND,
        TOI_NOTIFIERS_PREPARE_FAILED,
        TOI_PRE_SNAPSHOT_FAILED,
        TOI_PRE_RESTORE_FAILED,
        TOI_USERMODE_HELPERS_ERR,
        TOI_CANT_USE_ALT_RESUME,
        TOI_HEADER_TOO_BIG,
        TOI_WAKEUP_EVENT,
        TOI_SYSCORE_REFUSED,
        TOI_DPM_PREPARE_FAILED,
        TOI_DPM_SUSPEND_FAILED,
        TOI_NUM_RESULT_STATES        /* Used in printing debug info only */
};

extern unsigned long toi_result;

#define set_result_state(bit) (test_and_set_bit(bit, &toi_result))
#define set_abort_result(bit) (test_and_set_bit(TOI_ABORTED, &toi_result), \
                                test_and_set_bit(bit, &toi_result))
#define clear_result_state(bit) (test_and_clear_bit(bit, &toi_result))
#define test_result_state(bit) (test_bit(bit, &toi_result))

/*         == Debug sections and levels ==         */

/* debugging levels. */
enum {
        TOI_STATUS = 0,
        TOI_ERROR = 2,
        TOI_LOW,
        TOI_MEDIUM,
        TOI_HIGH,
        TOI_VERBOSE,
};

enum {
        TOI_ANY_SECTION,
        TOI_EAT_MEMORY,
        TOI_IO,
        TOI_HEADER,
        TOI_WRITER,
        TOI_MEMORY,
        TOI_PAGEDIR,
        TOI_COMPRESS,
        TOI_BIO,
};

#define set_debug_state(bit) (test_and_set_bit(bit, &toi_bkd.toi_debug_state))
#define clear_debug_state(bit) \
        (test_and_clear_bit(bit, &toi_bkd.toi_debug_state))
#define test_debug_state(bit) (test_bit(bit, &toi_bkd.toi_debug_state))

/*                == Steps in hibernating ==        */

enum {
        STEP_HIBERNATE_PREPARE_IMAGE,
        STEP_HIBERNATE_SAVE_IMAGE,
        STEP_HIBERNATE_POWERDOWN,
        STEP_RESUME_CAN_RESUME,
        STEP_RESUME_LOAD_PS1,
        STEP_RESUME_DO_RESTORE,
        STEP_RESUME_READ_PS2,
        STEP_RESUME_GO,
        STEP_RESUME_ALT_IMAGE,
        STEP_CLEANUP,
        STEP_QUIET_CLEANUP
};

/*                == TuxOnIce states ==
        (see also include/linux/suspend.h)        */

#define get_toi_state()  (toi_state)
#define restore_toi_state(saved_state) \
        do { toi_state = saved_state; } while (0)

/*                == Module support ==                */

struct toi_core_fns {
        int (*post_context_save)(void);
        unsigned long (*get_nonconflicting_page)(void);
        int (*try_hibernate)(void);
        void (*try_resume)(void);
};

extern struct toi_core_fns *toi_core_fns;

/*                == All else ==                        */
#define KB(x) ((x) << (PAGE_SHIFT - 10))
#define MB(x) ((x) >> (20 - PAGE_SHIFT))

extern int toi_start_anything(int toi_or_resume);
extern void toi_finish_anything(int toi_or_resume);

extern int save_image_part1(void);
extern int toi_atomic_restore(void);

extern int toi_try_hibernate(void);
extern void toi_try_resume(void);

extern int __toi_post_context_save(void);

extern unsigned int nr_hibernates;
extern char alt_resume_param[256];

extern void copyback_post(void);
extern int toi_hibernate(void);
extern unsigned long extra_pd1_pages_used;

#define SECTOR_SIZE 512

extern void toi_early_boot_message(int can_erase_image, int default_answer,
        char *warning_reason, ...);

extern int do_check_can_resume(void);
extern int do_toi_step(int step);
extern int toi_launch_userspace_program(char *command, int channel_no,
                int wait, int debug);

extern char tuxonice_signature[9];

extern int toi_start_other_threads(void);
extern void toi_stop_other_threads(void);

extern int toi_trace_index;
#define TOI_TRACE_DEBUG(PFN, DESC, ...) \
    do { \
        if (test_action_state(TOI_TRACE_DEBUG_ON)) { \
            printk("*TOI* %ld %02d" DESC "\n", PFN, toi_trace_index, ##__VA_ARGS__); \
        } \
    } while(0)

#ifdef CONFIG_TOI_KEEP_IMAGE
#define toi_keeping_image (test_action_state(TOI_KEEP_IMAGE) || test_action_state(TOI_INCREMENTAL_IMAGE))
#else
#define toi_keeping_image (0)
#endif

#ifdef CONFIG_TOI_INCREMENTAL
extern void toi_reset_dirtiness_one(unsigned long pfn, int verbose);
extern int toi_reset_dirtiness(int verbose);
extern void toi_cbw_write(void);
extern void toi_cbw_restore(void);
extern int toi_allocate_cbw_data(void);
extern void toi_free_cbw_data(void);
extern int toi_cbw_init(void);
extern void toi_mark_tasks_cbw(void);
#else
static inline int toi_reset_dirtiness(int verbose) { return 0; }
#define toi_cbw_write() do { } while(0)
#define toi_cbw_restore() do { } while(0)
#define toi_allocate_cbw_data() do { } while(0)
#define toi_free_cbw_data() do { } while(0)
static inline int toi_cbw_init(void) { return 0; }
#endif
#endif