blob: 023ff2a31d899159e61ffb72e9e4eeea65d93b25 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * linux/kernel/power/swsusp.c
3 *
Pavel Machek96bc7ae2005-10-30 14:59:58 -08004 * This file provides code to write suspend image to swap and read it back.
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 *
6 * Copyright (C) 1998-2001 Gabor Kuti <seasons@fornax.hu>
Rafael J. Wysocki25761b62005-10-30 14:59:56 -08007 * Copyright (C) 1998,2001-2005 Pavel Machek <pavel@suse.cz>
Linus Torvalds1da177e2005-04-16 15:20:36 -07008 *
9 * This file is released under the GPLv2.
10 *
11 * I'd like to thank the following people for their work:
Pavel Machek2e4d5822005-06-25 14:55:12 -070012 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070013 * Pavel Machek <pavel@ucw.cz>:
14 * Modifications, defectiveness pointing, being with me at the very beginning,
15 * suspend to swap space, stop all tasks. Port to 2.4.18-ac and 2.5.17.
16 *
Pavel Machek2e4d5822005-06-25 14:55:12 -070017 * Steve Doddi <dirk@loth.demon.co.uk>:
Linus Torvalds1da177e2005-04-16 15:20:36 -070018 * Support the possibility of hardware state restoring.
19 *
20 * Raph <grey.havens@earthling.net>:
21 * Support for preserving states of network devices and virtual console
22 * (including X and svgatextmode)
23 *
24 * Kurt Garloff <garloff@suse.de>:
25 * Straightened the critical function in order to prevent compilers from
26 * playing tricks with local variables.
27 *
28 * Andreas Mohr <a.mohr@mailto.de>
29 *
30 * Alex Badea <vampire@go.ro>:
31 * Fixed runaway init
32 *
Rafael J. Wysocki7088a5c2006-01-06 00:13:05 -080033 * Rafael J. Wysocki <rjw@sisk.pl>
Rafael J. Wysocki61159a32006-03-23 03:00:00 -080034 * Reworked the freeing of memory and the handling of swap
Rafael J. Wysocki7088a5c2006-01-06 00:13:05 -080035 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070036 * More state savers are welcome. Especially for the scsi layer...
37 *
38 * For TODOs,FIXMEs also look in Documentation/power/swsusp.txt
39 */
40
Linus Torvalds1da177e2005-04-16 15:20:36 -070041#include <linux/mm.h>
42#include <linux/suspend.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070043#include <linux/spinlock.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070044#include <linux/kernel.h>
45#include <linux/major.h>
46#include <linux/swap.h>
47#include <linux/pm.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070048#include <linux/swapops.h>
49#include <linux/bootmem.h>
50#include <linux/syscalls.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070051#include <linux/highmem.h>
Rafael J. Wysocki0d3a9ab2006-12-06 20:34:32 -080052#include <linux/time.h>
Rafael J. Wysockid1d241c2007-05-06 14:50:47 -070053#include <linux/rbtree.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070054
55#include "power.h"
56
Rafael J. Wysockica0aec02006-01-06 00:15:56 -080057/*
Rafael J. Wysocki853609b2006-02-01 03:05:07 -080058 * Preferred image size in bytes (tunable via /sys/power/image_size).
Rafael J. Wysockica0aec02006-01-06 00:15:56 -080059 * When it is set to N, swsusp will do its best to ensure the image
Rafael J. Wysocki853609b2006-02-01 03:05:07 -080060 * size will not exceed N bytes, but if that is impossible, it will
Rafael J. Wysockica0aec02006-01-06 00:15:56 -080061 * try to create the smallest image possible.
62 */
Rafael J. Wysocki853609b2006-02-01 03:05:07 -080063unsigned long image_size = 500 * 1024 * 1024;
Rafael J. Wysockica0aec02006-01-06 00:15:56 -080064
Rafael J. Wysockif577eb32006-03-23 02:59:59 -080065int in_suspend __nosavedata = 0;
66
Rafael J. Wysockif577eb32006-03-23 02:59:59 -080067/**
68 * The following functions are used for tracing the allocated
69 * swap pages, so that they can be freed in case of an error.
Rafael J. Wysockif577eb32006-03-23 02:59:59 -080070 */
71
Rafael J. Wysockid1d241c2007-05-06 14:50:47 -070072struct swsusp_extent {
73 struct rb_node node;
74 unsigned long start;
75 unsigned long end;
76};
77
78static struct rb_root swsusp_extents = RB_ROOT;
79
80static int swsusp_extents_insert(unsigned long swap_offset)
Rafael J. Wysockif577eb32006-03-23 02:59:59 -080081{
Rafael J. Wysockid1d241c2007-05-06 14:50:47 -070082 struct rb_node **new = &(swsusp_extents.rb_node);
83 struct rb_node *parent = NULL;
84 struct swsusp_extent *ext;
Rafael J. Wysockif577eb32006-03-23 02:59:59 -080085
Rafael J. Wysockid1d241c2007-05-06 14:50:47 -070086 /* Figure out where to put the new node */
87 while (*new) {
88 ext = container_of(*new, struct swsusp_extent, node);
89 parent = *new;
90 if (swap_offset < ext->start) {
91 /* Try to merge */
92 if (swap_offset == ext->start - 1) {
93 ext->start--;
94 return 0;
95 }
96 new = &((*new)->rb_left);
97 } else if (swap_offset > ext->end) {
98 /* Try to merge */
99 if (swap_offset == ext->end + 1) {
100 ext->end++;
101 return 0;
102 }
103 new = &((*new)->rb_right);
104 } else {
105 /* It already is in the tree */
106 return -EINVAL;
Rafael J. Wysockif577eb32006-03-23 02:59:59 -0800107 }
108 }
Rafael J. Wysockid1d241c2007-05-06 14:50:47 -0700109 /* Add the new node and rebalance the tree. */
110 ext = kzalloc(sizeof(struct swsusp_extent), GFP_KERNEL);
111 if (!ext)
112 return -ENOMEM;
Rafael J. Wysockif577eb32006-03-23 02:59:59 -0800113
Rafael J. Wysockid1d241c2007-05-06 14:50:47 -0700114 ext->start = swap_offset;
115 ext->end = swap_offset;
116 rb_link_node(&ext->node, parent, new);
117 rb_insert_color(&ext->node, &swsusp_extents);
Rafael J. Wysockif577eb32006-03-23 02:59:59 -0800118 return 0;
119}
120
Rafael J. Wysockid1d241c2007-05-06 14:50:47 -0700121/**
122 * alloc_swapdev_block - allocate a swap page and register that it has
123 * been allocated, so that it can be freed in case of an error.
124 */
125
126sector_t alloc_swapdev_block(int swap)
Rafael J. Wysockif577eb32006-03-23 02:59:59 -0800127{
128 unsigned long offset;
129
130 offset = swp_offset(get_swap_page_of_type(swap));
131 if (offset) {
Rafael J. Wysockid1d241c2007-05-06 14:50:47 -0700132 if (swsusp_extents_insert(offset))
Rafael J. Wysockif577eb32006-03-23 02:59:59 -0800133 swap_free(swp_entry(swap, offset));
Rafael J. Wysocki3aef83e2006-12-06 20:34:10 -0800134 else
135 return swapdev_block(swap, offset);
Rafael J. Wysockif577eb32006-03-23 02:59:59 -0800136 }
Rafael J. Wysocki3aef83e2006-12-06 20:34:10 -0800137 return 0;
Rafael J. Wysockif577eb32006-03-23 02:59:59 -0800138}
139
Rafael J. Wysockid1d241c2007-05-06 14:50:47 -0700140/**
141 * free_all_swap_pages - free swap pages allocated for saving image data.
142 * It also frees the extents used to register which swap entres had been
143 * allocated.
144 */
Rafael J. Wysockif577eb32006-03-23 02:59:59 -0800145
Rafael J. Wysockid1d241c2007-05-06 14:50:47 -0700146void free_all_swap_pages(int swap)
147{
148 struct rb_node *node;
149
150 while ((node = swsusp_extents.rb_node)) {
151 struct swsusp_extent *ext;
152 unsigned long offset;
153
154 ext = container_of(node, struct swsusp_extent, node);
155 rb_erase(node, &swsusp_extents);
156 for (offset = ext->start; offset <= ext->end; offset++)
157 swap_free(swp_entry(swap, offset));
158
159 kfree(ext);
Rafael J. Wysockif577eb32006-03-23 02:59:59 -0800160 }
161}
162
Rafael J. Wysockid1d241c2007-05-06 14:50:47 -0700163int swsusp_swap_in_use(void)
164{
165 return (swsusp_extents.rb_node != NULL);
166}
167
Rafael J. Wysockif577eb32006-03-23 02:59:59 -0800168/**
Rafael J. Wysocki0d3a9ab2006-12-06 20:34:32 -0800169 * swsusp_show_speed - print the time elapsed between two events represented by
170 * @start and @stop
171 *
172 * @nr_pages - number of pages processed between @start and @stop
173 * @msg - introductory message to print
174 */
175
176void swsusp_show_speed(struct timeval *start, struct timeval *stop,
177 unsigned nr_pages, char *msg)
178{
179 s64 elapsed_centisecs64;
180 int centisecs;
181 int k;
182 int kps;
183
184 elapsed_centisecs64 = timeval_to_ns(stop) - timeval_to_ns(start);
185 do_div(elapsed_centisecs64, NSEC_PER_SEC / 100);
186 centisecs = elapsed_centisecs64;
187 if (centisecs == 0)
188 centisecs = 1; /* avoid div-by-zero */
189 k = nr_pages * (PAGE_SIZE / 1024);
190 kps = (k * 100) / centisecs;
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100191 printk(KERN_INFO "PM: %s %d kbytes in %d.%02d seconds (%d.%02d MB/s)\n",
192 msg, k,
Rafael J. Wysocki0d3a9ab2006-12-06 20:34:32 -0800193 centisecs / 100, centisecs % 100,
194 kps / 1000, (kps % 1000) / 10);
195}
196
197/**
Rafael J. Wysocki72a97e02006-01-06 00:13:46 -0800198 * swsusp_shrink_memory - Try to free as much memory as needed
199 *
200 * ... but do not OOM-kill anyone
201 *
202 * Notice: all userland should be stopped before it is called, or
203 * livelock is possible.
204 */
205
206#define SHRINK_BITE 10000
Rafael J. Wysockid6277db2006-06-23 02:03:18 -0700207static inline unsigned long __shrink_memory(long tmp)
208{
209 if (tmp > SHRINK_BITE)
210 tmp = SHRINK_BITE;
211 return shrink_all_memory(tmp);
212}
Rafael J. Wysocki72a97e02006-01-06 00:13:46 -0800213
214int swsusp_shrink_memory(void)
215{
Rafael J. Wysocki83573762006-12-06 20:34:18 -0800216 long tmp;
Rafael J. Wysocki72a97e02006-01-06 00:13:46 -0800217 struct zone *zone;
218 unsigned long pages = 0;
219 unsigned int i = 0;
220 char *p = "-\\|/";
Rafael J. Wysocki0d3a9ab2006-12-06 20:34:32 -0800221 struct timeval start, stop;
Rafael J. Wysocki72a97e02006-01-06 00:13:46 -0800222
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100223 printk(KERN_INFO "PM: Shrinking memory... ");
Rafael J. Wysocki0d3a9ab2006-12-06 20:34:32 -0800224 do_gettimeofday(&start);
Rafael J. Wysocki72a97e02006-01-06 00:13:46 -0800225 do {
Rafael J. Wysocki83573762006-12-06 20:34:18 -0800226 long size, highmem_size;
227
228 highmem_size = count_highmem_pages();
Rafael J. Wysocki56f99bc2007-05-06 14:50:52 -0700229 size = count_data_pages() + PAGES_FOR_IO + SPARE_PAGES;
Rafael J. Wysockib3a93a22006-01-06 00:15:22 -0800230 tmp = size;
Rafael J. Wysocki83573762006-12-06 20:34:18 -0800231 size += highmem_size;
Rafael J. Wysocki72a97e02006-01-06 00:13:46 -0800232 for_each_zone (zone)
Rafael J. Wysocki83573762006-12-06 20:34:18 -0800233 if (populated_zone(zone)) {
Rafael J. Wysockic75fd0e2007-04-04 19:08:21 -0700234 tmp += snapshot_additional_pages(zone);
Rafael J. Wysocki83573762006-12-06 20:34:18 -0800235 if (is_highmem(zone)) {
Christoph Lameterd23ad422007-02-10 01:43:02 -0800236 highmem_size -=
237 zone_page_state(zone, NR_FREE_PAGES);
Rafael J. Wysocki83573762006-12-06 20:34:18 -0800238 } else {
Christoph Lameterd23ad422007-02-10 01:43:02 -0800239 tmp -= zone_page_state(zone, NR_FREE_PAGES);
Rafael J. Wysocki83573762006-12-06 20:34:18 -0800240 tmp += zone->lowmem_reserve[ZONE_NORMAL];
Rafael J. Wysocki83573762006-12-06 20:34:18 -0800241 }
Rafael J. Wysockia938c352006-06-23 02:04:46 -0700242 }
Rafael J. Wysocki83573762006-12-06 20:34:18 -0800243
244 if (highmem_size < 0)
245 highmem_size = 0;
246
247 tmp += highmem_size;
Rafael J. Wysocki72a97e02006-01-06 00:13:46 -0800248 if (tmp > 0) {
Rafael J. Wysockid6277db2006-06-23 02:03:18 -0700249 tmp = __shrink_memory(tmp);
Rafael J. Wysocki72a97e02006-01-06 00:13:46 -0800250 if (!tmp)
251 return -ENOMEM;
252 pages += tmp;
Rafael J. Wysocki853609b2006-02-01 03:05:07 -0800253 } else if (size > image_size / PAGE_SIZE) {
Rafael J. Wysockid6277db2006-06-23 02:03:18 -0700254 tmp = __shrink_memory(size - (image_size / PAGE_SIZE));
Rafael J. Wysockib3a93a22006-01-06 00:15:22 -0800255 pages += tmp;
Rafael J. Wysocki72a97e02006-01-06 00:13:46 -0800256 }
Rafael J. Wysocki72a97e02006-01-06 00:13:46 -0800257 printk("\b%c", p[i++%4]);
258 } while (tmp > 0);
Rafael J. Wysocki0d3a9ab2006-12-06 20:34:32 -0800259 do_gettimeofday(&stop);
Rafael J. Wysocki72a97e02006-01-06 00:13:46 -0800260 printk("\bdone (%lu pages freed)\n", pages);
Rafael J. Wysocki0d3a9ab2006-12-06 20:34:32 -0800261 swsusp_show_speed(&start, &stop, pages, "Freed");
Rafael J. Wysocki72a97e02006-01-06 00:13:46 -0800262
263 return 0;
264}