2 * linux/kernel/power/swap.c
4 * This file provides functions for reading the suspend image from
5 * and writing it to a swap partition.
7 * Copyright (C) 1998,2001-2005 Pavel Machek <pavel@ucw.cz>
8 * Copyright (C) 2006 Rafael J. Wysocki <rjw@sisk.pl>
9 * Copyright (C) 2010-2012 Bojan Smojver <bojan@rexursive.com>
11 * This file is released under the GPLv2.
15 #include <linux/module.h>
16 #include <linux/file.h>
17 #include <linux/delay.h>
18 #include <linux/bitops.h>
19 #include <linux/genhd.h>
20 #include <linux/device.h>
21 #include <linux/bio.h>
22 #include <linux/blkdev.h>
23 #include <linux/swap.h>
24 #include <linux/swapops.h>
26 #include <linux/slab.h>
27 #include <linux/lzo.h>
28 #include <linux/vmalloc.h>
29 #include <linux/cpumask.h>
30 #include <linux/atomic.h>
31 #include <linux/kthread.h>
32 #include <linux/crc32.h>
33 #include <linux/ktime.h>
37 #define HIBERNATE_SIG "S1SUSPEND"
39 static int goldenimage;
41 * When reading an {un,}compressed image, we may restore pages in place,
42 * in which case some architectures need these pages cleaning before they
43 * can be executed. We don't know which pages these may be, so clean the lot.
45 static bool clean_pages_on_read;
46 static bool clean_pages_on_decompress;
49 * When reading an {un,}compressed image, we may restore pages in place,
50 * in which case some architectures need these pages cleaning before they
51 * can be executed. We don't know which pages these may be, so clean the lot.
53 static bool clean_pages_on_read;
54 static bool clean_pages_on_decompress;
57 * The swap map is a data structure used for keeping track of each page
58 * written to a swap partition. It consists of many swap_map_page
59 * structures that contain each an array of MAP_PAGE_ENTRIES swap entries.
60 * These structures are stored on the swap and linked together with the
61 * help of the .next_swap member.
63 * The swap map is created during suspend. The swap map pages are
64 * allocated and populated one at a time, so we only need one memory
65 * page to set up the entire structure.
67 * During resume we pick up all swap_map_page structures into a list.
70 #define MAP_PAGE_ENTRIES (PAGE_SIZE / sizeof(sector_t) - 1)
73 * Number of free pages that are not high.
75 static inline unsigned long low_free_pages(void)
77 return nr_free_pages() - nr_free_highpages();
81 * Number of pages required to be kept free while writing the image. Always
82 * half of all available low pages before the writing starts.
84 static inline unsigned long reqd_free_pages(void)
86 return low_free_pages() / 2;
89 struct swap_map_page {
90 sector_t entries[MAP_PAGE_ENTRIES];
94 struct swap_map_page_list {
95 struct swap_map_page *map;
96 struct swap_map_page_list *next;
100 * The swap_map_handle structure is used for handling swap in
104 struct swap_map_handle {
105 struct swap_map_page *cur;
106 struct swap_map_page_list *maps;
108 sector_t first_sector;
110 unsigned long reqd_free_pages;
114 struct swsusp_header {
115 char reserved[PAGE_SIZE - 20 - sizeof(sector_t) - sizeof(int) -
119 unsigned int flags; /* Flags to pass to the "boot" kernel */
124 static struct swsusp_header *swsusp_header;
127 * The following functions are used for tracing the allocated
128 * swap pages, so that they can be freed in case of an error.
131 struct swsusp_extent {
137 static struct rb_root swsusp_extents = RB_ROOT;
139 static int swsusp_extents_insert(unsigned long swap_offset)
141 struct rb_node **new = &(swsusp_extents.rb_node);
142 struct rb_node *parent = NULL;
143 struct swsusp_extent *ext;
145 /* Figure out where to put the new node */
147 ext = rb_entry(*new, struct swsusp_extent, node);
149 if (swap_offset < ext->start) {
151 if (swap_offset == ext->start - 1) {
155 new = &((*new)->rb_left);
156 } else if (swap_offset > ext->end) {
158 if (swap_offset == ext->end + 1) {
162 new = &((*new)->rb_right);
164 /* It already is in the tree */
168 /* Add the new node and rebalance the tree. */
169 ext = kzalloc(sizeof(struct swsusp_extent), GFP_KERNEL);
173 ext->start = swap_offset;
174 ext->end = swap_offset;
175 rb_link_node(&ext->node, parent, new);
176 rb_insert_color(&ext->node, &swsusp_extents);
181 * alloc_swapdev_block - allocate a swap page and register that it has
182 * been allocated, so that it can be freed in case of an error.
185 sector_t alloc_swapdev_block(int swap)
187 unsigned long offset;
189 offset = swp_offset(get_swap_page_of_type(swap));
191 if (swsusp_extents_insert(offset))
192 swap_free(swp_entry(swap, offset));
194 return swapdev_block(swap, offset);
200 * free_all_swap_pages - free swap pages allocated for saving image data.
201 * It also frees the extents used to register which swap entries had been
205 void free_all_swap_pages(int swap)
207 struct rb_node *node;
209 while ((node = swsusp_extents.rb_node)) {
210 struct swsusp_extent *ext;
211 unsigned long offset;
213 ext = container_of(node, struct swsusp_extent, node);
214 rb_erase(node, &swsusp_extents);
215 for (offset = ext->start; offset <= ext->end; offset++)
216 swap_free(swp_entry(swap, offset));
222 int swsusp_swap_in_use(void)
224 return (swsusp_extents.rb_node != NULL);
231 static unsigned short root_swap = 0xffff;
232 static struct block_device *hib_resume_bdev;
234 struct hib_bio_batch {
236 wait_queue_head_t wait;
240 static void hib_init_batch(struct hib_bio_batch *hb)
242 atomic_set(&hb->count, 0);
243 init_waitqueue_head(&hb->wait);
247 static void hib_end_io(struct bio *bio)
249 struct hib_bio_batch *hb = bio->bi_private;
250 struct page *page = bio->bi_io_vec[0].bv_page;
253 printk(KERN_ALERT "Read-error on swap-device (%u:%u:%Lu)\n",
254 imajor(bio->bi_bdev->bd_inode),
255 iminor(bio->bi_bdev->bd_inode),
256 (unsigned long long)bio->bi_iter.bi_sector);
259 if (bio_data_dir(bio) == WRITE)
261 else if (clean_pages_on_read)
262 flush_icache_range((unsigned long)page_address(page),
263 (unsigned long)page_address(page) + PAGE_SIZE);
265 if (bio->bi_error && !hb->error)
266 hb->error = bio->bi_error;
267 if (atomic_dec_and_test(&hb->count))
273 static int hib_submit_io(int rw, pgoff_t page_off, void *addr,
274 struct hib_bio_batch *hb)
276 struct page *page = virt_to_page(addr);
280 bio = bio_alloc(__GFP_RECLAIM | __GFP_HIGH, 1);
281 bio->bi_iter.bi_sector = page_off * (PAGE_SIZE >> 9);
282 bio->bi_bdev = hib_resume_bdev;
284 if (bio_add_page(bio, page, PAGE_SIZE, 0) < PAGE_SIZE) {
285 printk(KERN_ERR "PM: Adding page to bio failed at %llu\n",
286 (unsigned long long)bio->bi_iter.bi_sector);
292 bio->bi_end_io = hib_end_io;
293 bio->bi_private = hb;
294 atomic_inc(&hb->count);
297 error = submit_bio_wait(rw, bio);
304 static int hib_wait_io(struct hib_bio_batch *hb)
306 wait_event(hb->wait, atomic_read(&hb->count) == 0);
314 static int mark_swapfiles(struct swap_map_handle *handle, unsigned int flags)
318 hib_submit_io(READ_SYNC, swsusp_resume_block, swsusp_header, NULL);
319 if (!memcmp("SWAP-SPACE",swsusp_header->sig, 10) ||
320 !memcmp("SWAPSPACE2",swsusp_header->sig, 10)) {
321 memcpy(swsusp_header->orig_sig,swsusp_header->sig, 10);
322 memcpy(swsusp_header->sig, HIBERNATE_SIG, 10);
323 swsusp_header->image = handle->first_sector;
324 swsusp_header->flags = flags;
325 if (flags & SF_CRC32_MODE)
326 swsusp_header->crc32 = handle->crc32;
327 error = hib_submit_io(WRITE_SYNC, swsusp_resume_block,
328 swsusp_header, NULL);
330 printk(KERN_ERR "PM: Swap header not found!\n");
337 * swsusp_swap_check - check if the resume device is a swap device
338 * and get its index (if so)
340 * This is called before saving image
342 static int swsusp_swap_check(void)
346 res = swap_type_of(swsusp_resume_device, swsusp_resume_block,
352 res = blkdev_get(hib_resume_bdev, FMODE_WRITE, NULL);
356 res = set_blocksize(hib_resume_bdev, PAGE_SIZE);
358 blkdev_put(hib_resume_bdev, FMODE_WRITE);
364 * write_page - Write one page to given swap location.
365 * @buf: Address we're writing.
366 * @offset: Offset of the swap page we're writing to.
367 * @hb: bio completion batch
370 static int write_page(void *buf, sector_t offset, struct hib_bio_batch *hb)
379 src = (void *)__get_free_page(__GFP_RECLAIM | __GFP_NOWARN |
384 ret = hib_wait_io(hb); /* Free pages */
387 src = (void *)__get_free_page(__GFP_RECLAIM |
394 hb = NULL; /* Go synchronous */
401 return hib_submit_io(WRITE_SYNC, offset, src, hb);
404 static void release_swap_writer(struct swap_map_handle *handle)
407 free_page((unsigned long)handle->cur);
411 static int get_swap_writer(struct swap_map_handle *handle)
415 ret = swsusp_swap_check();
418 printk(KERN_ERR "PM: Cannot find swap device, try "
422 handle->cur = (struct swap_map_page *)get_zeroed_page(GFP_KERNEL);
427 handle->cur_swap = alloc_swapdev_block(root_swap);
428 if (!handle->cur_swap) {
433 handle->reqd_free_pages = reqd_free_pages();
434 handle->first_sector = handle->cur_swap;
437 release_swap_writer(handle);
439 swsusp_close(FMODE_WRITE);
443 static int swap_write_page(struct swap_map_handle *handle, void *buf,
444 struct hib_bio_batch *hb)
451 offset = alloc_swapdev_block(root_swap);
452 error = write_page(buf, offset, hb);
455 handle->cur->entries[handle->k++] = offset;
456 if (handle->k >= MAP_PAGE_ENTRIES) {
457 offset = alloc_swapdev_block(root_swap);
460 handle->cur->next_swap = offset;
461 error = write_page(handle->cur, handle->cur_swap, hb);
464 clear_page(handle->cur);
465 handle->cur_swap = offset;
468 if (hb && low_free_pages() <= handle->reqd_free_pages) {
469 error = hib_wait_io(hb);
473 * Recalculate the number of required free pages, to
474 * make sure we never take more than half.
476 handle->reqd_free_pages = reqd_free_pages();
483 static int flush_swap_writer(struct swap_map_handle *handle)
485 if (handle->cur && handle->cur_swap)
486 return write_page(handle->cur, handle->cur_swap, NULL);
491 static int swap_writer_finish(struct swap_map_handle *handle,
492 unsigned int flags, int error)
495 flush_swap_writer(handle);
496 printk(KERN_INFO "PM: S");
497 error = mark_swapfiles(handle, flags);
502 free_all_swap_pages(root_swap);
503 release_swap_writer(handle);
504 swsusp_close(FMODE_WRITE);
509 /* We need to remember how much compressed data we need to read. */
510 #define LZO_HEADER sizeof(size_t)
512 /* Number of pages/bytes we'll compress at one time. */
513 #define LZO_UNC_PAGES 32
514 #define LZO_UNC_SIZE (LZO_UNC_PAGES * PAGE_SIZE)
516 /* Number of pages/bytes we need for compressed data (worst case). */
517 #define LZO_CMP_PAGES DIV_ROUND_UP(lzo1x_worst_compress(LZO_UNC_SIZE) + \
518 LZO_HEADER, PAGE_SIZE)
519 #define LZO_CMP_SIZE (LZO_CMP_PAGES * PAGE_SIZE)
521 /* Maximum number of threads for compression/decompression. */
522 #define LZO_THREADS 3
524 /* Minimum/maximum number of pages for read buffering. */
525 #define LZO_MIN_RD_PAGES 1024
526 #define LZO_MAX_RD_PAGES 8192
530 * save_image - save the suspend image data
533 static int save_image(struct swap_map_handle *handle,
534 struct snapshot_handle *snapshot,
535 unsigned int nr_to_write)
541 struct hib_bio_batch hb;
547 printk(KERN_INFO "PM: Saving image data pages (%u pages)...\n",
549 m = nr_to_write / 10;
555 ret = snapshot_read_next(snapshot);
558 ret = swap_write_page(handle, data_of(*snapshot), &hb);
562 printk(KERN_INFO "PM: Image saving progress: %3d%%\n",
566 err2 = hib_wait_io(&hb);
571 printk(KERN_INFO "PM: Image saving done.\n");
572 swsusp_show_speed(start, stop, nr_to_write, "Wrote");
577 * Structure used for CRC32.
580 struct task_struct *thr; /* thread */
581 atomic_t ready; /* ready to start flag */
582 atomic_t stop; /* ready to stop flag */
583 unsigned run_threads; /* nr current threads */
584 wait_queue_head_t go; /* start crc update */
585 wait_queue_head_t done; /* crc update done */
586 u32 *crc32; /* points to handle's crc32 */
587 size_t *unc_len[LZO_THREADS]; /* uncompressed lengths */
588 unsigned char *unc[LZO_THREADS]; /* uncompressed data */
592 * CRC32 update function that runs in its own thread.
594 static int crc32_threadfn(void *data)
596 struct crc_data *d = data;
600 wait_event(d->go, atomic_read(&d->ready) ||
601 kthread_should_stop());
602 if (kthread_should_stop()) {
604 atomic_set(&d->stop, 1);
608 atomic_set(&d->ready, 0);
610 for (i = 0; i < d->run_threads; i++)
611 *d->crc32 = crc32_le(*d->crc32,
612 d->unc[i], *d->unc_len[i]);
613 atomic_set(&d->stop, 1);
619 * Structure used for LZO data compression.
622 struct task_struct *thr; /* thread */
623 atomic_t ready; /* ready to start flag */
624 atomic_t stop; /* ready to stop flag */
625 int ret; /* return code */
626 wait_queue_head_t go; /* start compression */
627 wait_queue_head_t done; /* compression done */
628 size_t unc_len; /* uncompressed length */
629 size_t cmp_len; /* compressed length */
630 unsigned char unc[LZO_UNC_SIZE]; /* uncompressed buffer */
631 unsigned char cmp[LZO_CMP_SIZE]; /* compressed buffer */
632 unsigned char wrk[LZO1X_1_MEM_COMPRESS]; /* compression workspace */
636 * Compression function that runs in its own thread.
638 static int lzo_compress_threadfn(void *data)
640 struct cmp_data *d = data;
643 wait_event(d->go, atomic_read(&d->ready) ||
644 kthread_should_stop());
645 if (kthread_should_stop()) {
648 atomic_set(&d->stop, 1);
652 atomic_set(&d->ready, 0);
654 d->ret = lzo1x_1_compress(d->unc, d->unc_len,
655 d->cmp + LZO_HEADER, &d->cmp_len,
657 atomic_set(&d->stop, 1);
664 * save_image_lzo - Save the suspend image data compressed with LZO.
665 * @handle: Swap map handle to use for saving the image.
666 * @snapshot: Image to read data from.
667 * @nr_to_write: Number of pages to save.
669 static int save_image_lzo(struct swap_map_handle *handle,
670 struct snapshot_handle *snapshot,
671 unsigned int nr_to_write)
677 struct hib_bio_batch hb;
681 unsigned thr, run_threads, nr_threads;
682 unsigned char *page = NULL;
683 struct cmp_data *data = NULL;
684 struct crc_data *crc = NULL;
689 * We'll limit the number of threads for compression to limit memory
692 nr_threads = num_online_cpus() - 1;
693 nr_threads = clamp_val(nr_threads, 1, LZO_THREADS);
695 page = (void *)__get_free_page(__GFP_RECLAIM | __GFP_HIGH);
697 printk(KERN_ERR "PM: Failed to allocate LZO page\n");
702 data = vmalloc(sizeof(*data) * nr_threads);
704 printk(KERN_ERR "PM: Failed to allocate LZO data\n");
708 for (thr = 0; thr < nr_threads; thr++)
709 memset(&data[thr], 0, offsetof(struct cmp_data, go));
711 crc = kmalloc(sizeof(*crc), GFP_KERNEL);
713 printk(KERN_ERR "PM: Failed to allocate crc\n");
717 memset(crc, 0, offsetof(struct crc_data, go));
720 * Start the compression threads.
722 for (thr = 0; thr < nr_threads; thr++) {
723 init_waitqueue_head(&data[thr].go);
724 init_waitqueue_head(&data[thr].done);
726 data[thr].thr = kthread_run(lzo_compress_threadfn,
728 "image_compress/%u", thr);
729 if (IS_ERR(data[thr].thr)) {
730 data[thr].thr = NULL;
732 "PM: Cannot start compression threads\n");
739 * Start the CRC32 thread.
741 init_waitqueue_head(&crc->go);
742 init_waitqueue_head(&crc->done);
745 crc->crc32 = &handle->crc32;
746 for (thr = 0; thr < nr_threads; thr++) {
747 crc->unc[thr] = data[thr].unc;
748 crc->unc_len[thr] = &data[thr].unc_len;
751 crc->thr = kthread_run(crc32_threadfn, crc, "image_crc32");
752 if (IS_ERR(crc->thr)) {
754 printk(KERN_ERR "PM: Cannot start CRC32 thread\n");
760 * Adjust the number of required free pages after all allocations have
761 * been done. We don't want to run out of pages when writing.
763 handle->reqd_free_pages = reqd_free_pages();
766 "PM: Using %u thread(s) for compression.\n"
767 "PM: Compressing and saving image data (%u pages)...\n",
768 nr_threads, nr_to_write);
769 m = nr_to_write / 10;
775 for (thr = 0; thr < nr_threads; thr++) {
776 for (off = 0; off < LZO_UNC_SIZE; off += PAGE_SIZE) {
777 ret = snapshot_read_next(snapshot);
784 memcpy(data[thr].unc + off,
785 data_of(*snapshot), PAGE_SIZE);
789 "PM: Image saving progress: "
797 data[thr].unc_len = off;
799 atomic_set(&data[thr].ready, 1);
800 wake_up(&data[thr].go);
806 crc->run_threads = thr;
807 atomic_set(&crc->ready, 1);
810 for (run_threads = thr, thr = 0; thr < run_threads; thr++) {
811 wait_event(data[thr].done,
812 atomic_read(&data[thr].stop));
813 atomic_set(&data[thr].stop, 0);
818 printk(KERN_ERR "PM: LZO compression failed\n");
822 if (unlikely(!data[thr].cmp_len ||
824 lzo1x_worst_compress(data[thr].unc_len))) {
826 "PM: Invalid LZO compressed length\n");
831 *(size_t *)data[thr].cmp = data[thr].cmp_len;
834 * Given we are writing one page at a time to disk, we
835 * copy that much from the buffer, although the last
836 * bit will likely be smaller than full page. This is
837 * OK - we saved the length of the compressed data, so
838 * any garbage at the end will be discarded when we
842 off < LZO_HEADER + data[thr].cmp_len;
844 memcpy(page, data[thr].cmp + off, PAGE_SIZE);
846 ret = swap_write_page(handle, page, &hb);
852 wait_event(crc->done, atomic_read(&crc->stop));
853 atomic_set(&crc->stop, 0);
857 err2 = hib_wait_io(&hb);
862 printk(KERN_INFO "PM: Image saving done.\n");
863 swsusp_show_speed(start, stop, nr_to_write, "Wrote");
867 kthread_stop(crc->thr);
871 for (thr = 0; thr < nr_threads; thr++)
873 kthread_stop(data[thr].thr);
876 if (page) free_page((unsigned long)page);
882 * enough_swap - Make sure we have enough swap to save the image.
884 * Returns TRUE or FALSE after checking the total amount of swap
885 * space avaiable from the resume partition.
888 static int enough_swap(unsigned int nr_pages, unsigned int flags)
890 unsigned int free_swap = count_swap_pages(root_swap, 1);
891 unsigned int required;
893 pr_debug("PM: Free swap pages: %u\n", free_swap);
895 required = PAGES_FOR_IO + nr_pages;
896 return free_swap > required;
900 * swsusp_write - Write entire image and metadata.
901 * @flags: flags to pass to the "boot" kernel in the image header
903 * It is important _NOT_ to umount filesystems at this point. We want
904 * them synced (in case something goes wrong) but we DO not want to mark
905 * filesystem clean: it is not. (And it does not matter, if we resume
906 * correctly, we'll mark system clean, anyway.)
909 int swsusp_write(unsigned int flags)
911 struct swap_map_handle handle;
912 struct snapshot_handle snapshot;
913 struct swsusp_info *header;
917 pages = snapshot_get_image_size();
918 error = get_swap_writer(&handle);
920 printk(KERN_ERR "PM: Cannot get swap writer\n");
923 if (flags & SF_NOCOMPRESS_MODE) {
924 if (!enough_swap(pages, flags)) {
925 printk(KERN_ERR "PM: Not enough free swap\n");
930 memset(&snapshot, 0, sizeof(struct snapshot_handle));
931 error = snapshot_read_next(&snapshot);
932 if (error < PAGE_SIZE) {
938 header = (struct swsusp_info *)data_of(snapshot);
939 error = swap_write_page(&handle, header, NULL);
941 error = (flags & SF_NOCOMPRESS_MODE) ?
942 save_image(&handle, &snapshot, pages - 1) :
943 save_image_lzo(&handle, &snapshot, pages - 1);
946 error = swap_writer_finish(&handle, flags, error);
951 * The following functions allow us to read data using a swap map
952 * in a file-alike way
955 static void release_swap_reader(struct swap_map_handle *handle)
957 struct swap_map_page_list *tmp;
959 while (handle->maps) {
960 if (handle->maps->map)
961 free_page((unsigned long)handle->maps->map);
963 handle->maps = handle->maps->next;
969 static int get_swap_reader(struct swap_map_handle *handle,
970 unsigned int *flags_p)
973 struct swap_map_page_list *tmp, *last;
976 *flags_p = swsusp_header->flags;
978 if (!swsusp_header->image) /* how can this happen? */
982 last = handle->maps = NULL;
983 offset = swsusp_header->image;
985 tmp = kmalloc(sizeof(*handle->maps), GFP_KERNEL);
987 release_swap_reader(handle);
990 memset(tmp, 0, sizeof(*tmp));
997 tmp->map = (struct swap_map_page *)
998 __get_free_page(__GFP_RECLAIM | __GFP_HIGH);
1000 release_swap_reader(handle);
1004 error = hib_submit_io(READ_SYNC, offset, tmp->map, NULL);
1006 release_swap_reader(handle);
1009 offset = tmp->map->next_swap;
1012 handle->cur = handle->maps->map;
1016 static int swap_read_page(struct swap_map_handle *handle, void *buf,
1017 struct hib_bio_batch *hb)
1021 struct swap_map_page_list *tmp;
1025 offset = handle->cur->entries[handle->k];
1028 error = hib_submit_io(READ_SYNC, offset, buf, hb);
1031 if (++handle->k >= MAP_PAGE_ENTRIES) {
1033 free_page((unsigned long)handle->maps->map);
1035 handle->maps = handle->maps->next;
1038 release_swap_reader(handle);
1040 handle->cur = handle->maps->map;
1045 static int swap_reader_finish(struct swap_map_handle *handle)
1047 release_swap_reader(handle);
1053 * load_image - load the image using the swap map handle
1054 * @handle and the snapshot handle @snapshot
1055 * (assume there are @nr_pages pages to load)
1058 static int load_image(struct swap_map_handle *handle,
1059 struct snapshot_handle *snapshot,
1060 unsigned int nr_to_read)
1066 struct hib_bio_batch hb;
1070 hib_init_batch(&hb);
1072 clean_pages_on_read = true;
1073 printk(KERN_INFO "PM: Loading image data pages (%u pages)...\n",
1075 m = nr_to_read / 10;
1079 start = ktime_get();
1081 ret = snapshot_write_next(snapshot);
1084 ret = swap_read_page(handle, data_of(*snapshot), &hb);
1087 if (snapshot->sync_read)
1088 ret = hib_wait_io(&hb);
1091 if (!(nr_pages % m))
1092 printk(KERN_INFO "PM: Image loading progress: %3d%%\n",
1096 err2 = hib_wait_io(&hb);
1101 printk(KERN_INFO "PM: Image loading done.\n");
1102 snapshot_write_finalize(snapshot);
1103 if (!snapshot_image_loaded(snapshot))
1106 swsusp_show_speed(start, stop, nr_to_read, "Read");
1111 * Structure used for LZO data decompression.
1114 struct task_struct *thr; /* thread */
1115 atomic_t ready; /* ready to start flag */
1116 atomic_t stop; /* ready to stop flag */
1117 int ret; /* return code */
1118 wait_queue_head_t go; /* start decompression */
1119 wait_queue_head_t done; /* decompression done */
1120 size_t unc_len; /* uncompressed length */
1121 size_t cmp_len; /* compressed length */
1122 unsigned char unc[LZO_UNC_SIZE]; /* uncompressed buffer */
1123 unsigned char cmp[LZO_CMP_SIZE]; /* compressed buffer */
1127 * Deompression function that runs in its own thread.
1129 static int lzo_decompress_threadfn(void *data)
1131 struct dec_data *d = data;
1134 wait_event(d->go, atomic_read(&d->ready) ||
1135 kthread_should_stop());
1136 if (kthread_should_stop()) {
1139 atomic_set(&d->stop, 1);
1143 atomic_set(&d->ready, 0);
1145 d->unc_len = LZO_UNC_SIZE;
1146 d->ret = lzo1x_decompress_safe(d->cmp + LZO_HEADER, d->cmp_len,
1147 d->unc, &d->unc_len);
1148 if (clean_pages_on_decompress)
1149 flush_icache_range((unsigned long)d->unc,
1150 (unsigned long)d->unc + d->unc_len);
1152 atomic_set(&d->stop, 1);
1159 * load_image_lzo - Load compressed image data and decompress them with LZO.
1160 * @handle: Swap map handle to use for loading data.
1161 * @snapshot: Image to copy uncompressed data into.
1162 * @nr_to_read: Number of pages to load.
1164 static int load_image_lzo(struct swap_map_handle *handle,
1165 struct snapshot_handle *snapshot,
1166 unsigned int nr_to_read)
1171 struct hib_bio_batch hb;
1176 unsigned i, thr, run_threads, nr_threads;
1177 unsigned ring = 0, pg = 0, ring_size = 0,
1178 have = 0, want, need, asked = 0;
1179 unsigned long read_pages = 0;
1180 unsigned char **page = NULL;
1181 struct dec_data *data = NULL;
1182 struct crc_data *crc = NULL;
1184 hib_init_batch(&hb);
1187 * We'll limit the number of threads for decompression to limit memory
1190 nr_threads = num_online_cpus() - 1;
1191 nr_threads = clamp_val(nr_threads, 1, LZO_THREADS);
1193 page = vmalloc(sizeof(*page) * LZO_MAX_RD_PAGES);
1195 printk(KERN_ERR "PM: Failed to allocate LZO page\n");
1200 data = vmalloc(sizeof(*data) * nr_threads);
1202 printk(KERN_ERR "PM: Failed to allocate LZO data\n");
1206 for (thr = 0; thr < nr_threads; thr++)
1207 memset(&data[thr], 0, offsetof(struct dec_data, go));
1209 crc = kmalloc(sizeof(*crc), GFP_KERNEL);
1211 printk(KERN_ERR "PM: Failed to allocate crc\n");
1215 memset(crc, 0, offsetof(struct crc_data, go));
1217 clean_pages_on_decompress = true;
1220 * Start the decompression threads.
1222 for (thr = 0; thr < nr_threads; thr++) {
1223 init_waitqueue_head(&data[thr].go);
1224 init_waitqueue_head(&data[thr].done);
1226 data[thr].thr = kthread_run(lzo_decompress_threadfn,
1228 "image_decompress/%u", thr);
1229 if (IS_ERR(data[thr].thr)) {
1230 data[thr].thr = NULL;
1232 "PM: Cannot start decompression threads\n");
1239 * Start the CRC32 thread.
1241 init_waitqueue_head(&crc->go);
1242 init_waitqueue_head(&crc->done);
1245 crc->crc32 = &handle->crc32;
1246 for (thr = 0; thr < nr_threads; thr++) {
1247 crc->unc[thr] = data[thr].unc;
1248 crc->unc_len[thr] = &data[thr].unc_len;
1251 crc->thr = kthread_run(crc32_threadfn, crc, "image_crc32");
1252 if (IS_ERR(crc->thr)) {
1254 printk(KERN_ERR "PM: Cannot start CRC32 thread\n");
1260 * Set the number of pages for read buffering.
1261 * This is complete guesswork, because we'll only know the real
1262 * picture once prepare_image() is called, which is much later on
1263 * during the image load phase. We'll assume the worst case and
1264 * say that none of the image pages are from high memory.
1266 if (low_free_pages() > snapshot_get_image_size())
1267 read_pages = (low_free_pages() - snapshot_get_image_size()) / 2;
1268 read_pages = clamp_val(read_pages, LZO_MIN_RD_PAGES, LZO_MAX_RD_PAGES);
1270 for (i = 0; i < read_pages; i++) {
1271 page[i] = (void *)__get_free_page(i < LZO_CMP_PAGES ?
1272 __GFP_RECLAIM | __GFP_HIGH :
1273 __GFP_RECLAIM | __GFP_NOWARN |
1277 if (i < LZO_CMP_PAGES) {
1280 "PM: Failed to allocate LZO pages\n");
1288 want = ring_size = i;
1291 "PM: Using %u thread(s) for decompression.\n"
1292 "PM: Loading and decompressing image data (%u pages)...\n",
1293 nr_threads, nr_to_read);
1294 m = nr_to_read / 10;
1298 start = ktime_get();
1300 ret = snapshot_write_next(snapshot);
1305 for (i = 0; !eof && i < want; i++) {
1306 ret = swap_read_page(handle, page[ring], &hb);
1309 * On real read error, finish. On end of data,
1310 * set EOF flag and just exit the read loop.
1313 handle->cur->entries[handle->k]) {
1320 if (++ring >= ring_size)
1327 * We are out of data, wait for some more.
1333 ret = hib_wait_io(&hb);
1342 if (crc->run_threads) {
1343 wait_event(crc->done, atomic_read(&crc->stop));
1344 atomic_set(&crc->stop, 0);
1345 crc->run_threads = 0;
1348 for (thr = 0; have && thr < nr_threads; thr++) {
1349 data[thr].cmp_len = *(size_t *)page[pg];
1350 if (unlikely(!data[thr].cmp_len ||
1352 lzo1x_worst_compress(LZO_UNC_SIZE))) {
1354 "PM: Invalid LZO compressed length\n");
1359 need = DIV_ROUND_UP(data[thr].cmp_len + LZO_HEADER,
1370 off < LZO_HEADER + data[thr].cmp_len;
1372 memcpy(data[thr].cmp + off,
1373 page[pg], PAGE_SIZE);
1376 if (++pg >= ring_size)
1380 atomic_set(&data[thr].ready, 1);
1381 wake_up(&data[thr].go);
1385 * Wait for more data while we are decompressing.
1387 if (have < LZO_CMP_PAGES && asked) {
1388 ret = hib_wait_io(&hb);
1397 for (run_threads = thr, thr = 0; thr < run_threads; thr++) {
1398 wait_event(data[thr].done,
1399 atomic_read(&data[thr].stop));
1400 atomic_set(&data[thr].stop, 0);
1402 ret = data[thr].ret;
1406 "PM: LZO decompression failed\n");
1410 if (unlikely(!data[thr].unc_len ||
1411 data[thr].unc_len > LZO_UNC_SIZE ||
1412 data[thr].unc_len & (PAGE_SIZE - 1))) {
1414 "PM: Invalid LZO uncompressed length\n");
1420 off < data[thr].unc_len; off += PAGE_SIZE) {
1421 memcpy(data_of(*snapshot),
1422 data[thr].unc + off, PAGE_SIZE);
1424 if (!(nr_pages % m))
1426 "PM: Image loading progress: "
1431 ret = snapshot_write_next(snapshot);
1433 crc->run_threads = thr + 1;
1434 atomic_set(&crc->ready, 1);
1441 crc->run_threads = thr;
1442 atomic_set(&crc->ready, 1);
1447 if (crc->run_threads) {
1448 wait_event(crc->done, atomic_read(&crc->stop));
1449 atomic_set(&crc->stop, 0);
1453 printk(KERN_INFO "PM: Image loading done.\n");
1454 snapshot_write_finalize(snapshot);
1455 if (!snapshot_image_loaded(snapshot))
1458 if (swsusp_header->flags & SF_CRC32_MODE) {
1459 if(handle->crc32 != swsusp_header->crc32) {
1461 "PM: Invalid image CRC32!\n");
1467 swsusp_show_speed(start, stop, nr_to_read, "Read");
1469 for (i = 0; i < ring_size; i++)
1470 free_page((unsigned long)page[i]);
1473 kthread_stop(crc->thr);
1477 for (thr = 0; thr < nr_threads; thr++)
1479 kthread_stop(data[thr].thr);
1488 * swsusp_read - read the hibernation image.
1489 * @flags_p: flags passed by the "frozen" kernel in the image header should
1490 * be written into this memory location
1493 int swsusp_read(unsigned int *flags_p)
1496 struct swap_map_handle handle;
1497 struct snapshot_handle snapshot;
1498 struct swsusp_info *header;
1500 memset(&snapshot, 0, sizeof(struct snapshot_handle));
1501 error = snapshot_write_next(&snapshot);
1502 if (error < PAGE_SIZE)
1503 return error < 0 ? error : -EFAULT;
1504 header = (struct swsusp_info *)data_of(snapshot);
1505 error = get_swap_reader(&handle, flags_p);
1509 error = swap_read_page(&handle, header, NULL);
1511 error = (*flags_p & SF_NOCOMPRESS_MODE) ?
1512 load_image(&handle, &snapshot, header->pages - 1) :
1513 load_image_lzo(&handle, &snapshot, header->pages - 1);
1515 swap_reader_finish(&handle);
1518 pr_debug("PM: Image successfully loaded\n");
1520 pr_debug("PM: Error %d resuming\n", error);
1525 * swsusp_check - Check for swsusp signature in the resume device
1528 int swsusp_check(void)
1532 hib_resume_bdev = blkdev_get_by_dev(swsusp_resume_device,
1534 if (!IS_ERR(hib_resume_bdev)) {
1535 set_blocksize(hib_resume_bdev, PAGE_SIZE);
1536 clear_page(swsusp_header);
1537 error = hib_submit_io(READ_SYNC, swsusp_resume_block,
1538 swsusp_header, NULL);
1542 if (!memcmp(HIBERNATE_SIG, swsusp_header->sig, 10)) {
1544 pr_debug("PM: corrupt hibernate image header\n");
1545 memcpy(swsusp_header->sig,
1546 swsusp_header->orig_sig, 10);
1548 pr_debug("PM: Header corruption avoided\n");
1550 /* Reset swap signature now */
1551 error = hib_submit_io(WRITE_SYNC, swsusp_resume_block,
1552 swsusp_header, NULL);
1559 blkdev_put(hib_resume_bdev, FMODE_READ);
1561 pr_debug("PM: Image signature found, resuming\n");
1563 error = PTR_ERR(hib_resume_bdev);
1567 pr_debug("PM: Image not found (code %d)\n", error);
1573 * swsusp_close - close swap device.
1576 void swsusp_close(fmode_t mode)
1578 if (IS_ERR(hib_resume_bdev)) {
1579 pr_debug("PM: Image device not initialised\n");
1583 blkdev_put(hib_resume_bdev, mode);
1587 * swsusp_unmark - Unmark swsusp signature in the resume device
1590 #ifdef CONFIG_SUSPEND
1591 int swsusp_unmark(void)
1595 hib_submit_io(READ_SYNC, swsusp_resume_block, swsusp_header, NULL);
1596 if (!memcmp(HIBERNATE_SIG,swsusp_header->sig, 10)) {
1597 memcpy(swsusp_header->sig,swsusp_header->orig_sig, 10);
1598 error = hib_submit_io(WRITE_SYNC, swsusp_resume_block,
1599 swsusp_header, NULL);
1601 printk(KERN_ERR "PM: Cannot find swsusp signature!\n");
1606 * We just returned from suspend, we don't need the image any more.
1608 free_all_swap_pages(root_swap);
1614 static int swsusp_header_init(void)
1616 swsusp_header = (struct swsusp_header*) __get_free_page(GFP_KERNEL);
1618 panic("Could not allocate memory for swsusp_header\n");
1622 core_initcall(swsusp_header_init);
1624 static int __init golden_image_setup(char *str)
1629 __setup("golden_image", golden_image_setup);