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>
36 #define HIBERNATE_SIG "S1SUSPEND"
39 * When reading an {un,}compressed image, we may restore pages in place,
40 * in which case some architectures need these pages cleaning before they
41 * can be executed. We don't know which pages these may be, so clean the lot.
43 static bool clean_pages_on_read;
44 static bool clean_pages_on_decompress;
47 * The swap map is a data structure used for keeping track of each page
48 * written to a swap partition. It consists of many swap_map_page
49 * structures that contain each an array of MAP_PAGE_ENTRIES swap entries.
50 * These structures are stored on the swap and linked together with the
51 * help of the .next_swap member.
53 * The swap map is created during suspend. The swap map pages are
54 * allocated and populated one at a time, so we only need one memory
55 * page to set up the entire structure.
57 * During resume we pick up all swap_map_page structures into a list.
60 #define MAP_PAGE_ENTRIES (PAGE_SIZE / sizeof(sector_t) - 1)
63 * Number of free pages that are not high.
65 static inline unsigned long low_free_pages(void)
67 return nr_free_pages() - nr_free_highpages();
71 * Number of pages required to be kept free while writing the image. Always
72 * half of all available low pages before the writing starts.
74 static inline unsigned long reqd_free_pages(void)
76 return low_free_pages() / 2;
79 struct swap_map_page {
80 sector_t entries[MAP_PAGE_ENTRIES];
84 struct swap_map_page_list {
85 struct swap_map_page *map;
86 struct swap_map_page_list *next;
90 * The swap_map_handle structure is used for handling swap in
94 struct swap_map_handle {
95 struct swap_map_page *cur;
96 struct swap_map_page_list *maps;
98 sector_t first_sector;
100 unsigned long reqd_free_pages;
104 struct swsusp_header {
105 char reserved[PAGE_SIZE - 20 - sizeof(sector_t) - sizeof(int) -
109 unsigned int flags; /* Flags to pass to the "boot" kernel */
114 static struct swsusp_header *swsusp_header;
117 * The following functions are used for tracing the allocated
118 * swap pages, so that they can be freed in case of an error.
121 struct swsusp_extent {
127 static struct rb_root swsusp_extents = RB_ROOT;
129 static int swsusp_extents_insert(unsigned long swap_offset)
131 struct rb_node **new = &(swsusp_extents.rb_node);
132 struct rb_node *parent = NULL;
133 struct swsusp_extent *ext;
135 /* Figure out where to put the new node */
137 ext = rb_entry(*new, struct swsusp_extent, node);
139 if (swap_offset < ext->start) {
141 if (swap_offset == ext->start - 1) {
145 new = &((*new)->rb_left);
146 } else if (swap_offset > ext->end) {
148 if (swap_offset == ext->end + 1) {
152 new = &((*new)->rb_right);
154 /* It already is in the tree */
158 /* Add the new node and rebalance the tree. */
159 ext = kzalloc(sizeof(struct swsusp_extent), GFP_KERNEL);
163 ext->start = swap_offset;
164 ext->end = swap_offset;
165 rb_link_node(&ext->node, parent, new);
166 rb_insert_color(&ext->node, &swsusp_extents);
171 * alloc_swapdev_block - allocate a swap page and register that it has
172 * been allocated, so that it can be freed in case of an error.
175 sector_t alloc_swapdev_block(int swap)
177 unsigned long offset;
179 offset = swp_offset(get_swap_page_of_type(swap));
181 if (swsusp_extents_insert(offset))
182 swap_free(swp_entry(swap, offset));
184 return swapdev_block(swap, offset);
190 * free_all_swap_pages - free swap pages allocated for saving image data.
191 * It also frees the extents used to register which swap entries had been
195 void free_all_swap_pages(int swap)
197 struct rb_node *node;
199 while ((node = swsusp_extents.rb_node)) {
200 struct swsusp_extent *ext;
201 unsigned long offset;
203 ext = container_of(node, struct swsusp_extent, node);
204 rb_erase(node, &swsusp_extents);
205 for (offset = ext->start; offset <= ext->end; offset++)
206 swap_free(swp_entry(swap, offset));
212 int swsusp_swap_in_use(void)
214 return (swsusp_extents.rb_node != NULL);
221 static unsigned short root_swap = 0xffff;
222 static struct block_device *hib_resume_bdev;
224 struct hib_bio_batch {
226 wait_queue_head_t wait;
230 static void hib_init_batch(struct hib_bio_batch *hb)
232 atomic_set(&hb->count, 0);
233 init_waitqueue_head(&hb->wait);
237 static void hib_end_io(struct bio *bio, int error)
239 struct hib_bio_batch *hb = bio->bi_private;
240 const int uptodate = test_bit(BIO_UPTODATE, &bio->bi_flags);
241 struct page *page = bio->bi_io_vec[0].bv_page;
243 if (!uptodate || error) {
244 printk(KERN_ALERT "Read-error on swap-device (%u:%u:%Lu)\n",
245 imajor(bio->bi_bdev->bd_inode),
246 iminor(bio->bi_bdev->bd_inode),
247 (unsigned long long)bio->bi_iter.bi_sector);
253 if (bio_data_dir(bio) == WRITE)
255 else if (clean_pages_on_read)
256 flush_icache_range((unsigned long)page_address(page),
257 (unsigned long)page_address(page) + PAGE_SIZE);
259 if (error && !hb->error)
261 if (atomic_dec_and_test(&hb->count))
267 static int hib_submit_io(int rw, pgoff_t page_off, void *addr,
268 struct hib_bio_batch *hb)
270 struct page *page = virt_to_page(addr);
274 bio = bio_alloc(__GFP_WAIT | __GFP_HIGH, 1);
275 bio->bi_iter.bi_sector = page_off * (PAGE_SIZE >> 9);
276 bio->bi_bdev = hib_resume_bdev;
278 if (bio_add_page(bio, page, PAGE_SIZE, 0) < PAGE_SIZE) {
279 printk(KERN_ERR "PM: Adding page to bio failed at %llu\n",
280 (unsigned long long)bio->bi_iter.bi_sector);
286 bio->bi_end_io = hib_end_io;
287 bio->bi_private = hb;
288 atomic_inc(&hb->count);
291 error = submit_bio_wait(rw, bio);
298 static int hib_wait_io(struct hib_bio_batch *hb)
300 wait_event(hb->wait, atomic_read(&hb->count) == 0);
308 static int mark_swapfiles(struct swap_map_handle *handle, unsigned int flags)
312 hib_submit_io(READ_SYNC, swsusp_resume_block, swsusp_header, NULL);
313 if (!memcmp("SWAP-SPACE",swsusp_header->sig, 10) ||
314 !memcmp("SWAPSPACE2",swsusp_header->sig, 10)) {
315 memcpy(swsusp_header->orig_sig,swsusp_header->sig, 10);
316 memcpy(swsusp_header->sig, HIBERNATE_SIG, 10);
317 swsusp_header->image = handle->first_sector;
318 swsusp_header->flags = flags;
319 if (flags & SF_CRC32_MODE)
320 swsusp_header->crc32 = handle->crc32;
321 error = hib_submit_io(WRITE_SYNC, swsusp_resume_block,
322 swsusp_header, NULL);
324 printk(KERN_ERR "PM: Swap header not found!\n");
331 * swsusp_swap_check - check if the resume device is a swap device
332 * and get its index (if so)
334 * This is called before saving image
336 static int swsusp_swap_check(void)
340 res = swap_type_of(swsusp_resume_device, swsusp_resume_block,
346 res = blkdev_get(hib_resume_bdev, FMODE_WRITE, NULL);
350 res = set_blocksize(hib_resume_bdev, PAGE_SIZE);
352 blkdev_put(hib_resume_bdev, FMODE_WRITE);
358 * write_page - Write one page to given swap location.
359 * @buf: Address we're writing.
360 * @offset: Offset of the swap page we're writing to.
361 * @hb: bio completion batch
364 static int write_page(void *buf, sector_t offset, struct hib_bio_batch *hb)
373 src = (void *)__get_free_page(__GFP_WAIT | __GFP_NOWARN |
378 ret = hib_wait_io(hb); /* Free pages */
381 src = (void *)__get_free_page(__GFP_WAIT |
388 hb = NULL; /* Go synchronous */
395 return hib_submit_io(WRITE_SYNC, offset, src, hb);
398 static void release_swap_writer(struct swap_map_handle *handle)
401 free_page((unsigned long)handle->cur);
405 static int get_swap_writer(struct swap_map_handle *handle)
409 ret = swsusp_swap_check();
412 printk(KERN_ERR "PM: Cannot find swap device, try "
416 handle->cur = (struct swap_map_page *)get_zeroed_page(GFP_KERNEL);
421 handle->cur_swap = alloc_swapdev_block(root_swap);
422 if (!handle->cur_swap) {
427 handle->reqd_free_pages = reqd_free_pages();
428 handle->first_sector = handle->cur_swap;
431 release_swap_writer(handle);
433 swsusp_close(FMODE_WRITE);
437 static int swap_write_page(struct swap_map_handle *handle, void *buf,
438 struct hib_bio_batch *hb)
445 offset = alloc_swapdev_block(root_swap);
446 error = write_page(buf, offset, hb);
449 handle->cur->entries[handle->k++] = offset;
450 if (handle->k >= MAP_PAGE_ENTRIES) {
451 offset = alloc_swapdev_block(root_swap);
454 handle->cur->next_swap = offset;
455 error = write_page(handle->cur, handle->cur_swap, hb);
458 clear_page(handle->cur);
459 handle->cur_swap = offset;
462 if (hb && low_free_pages() <= handle->reqd_free_pages) {
463 error = hib_wait_io(hb);
467 * Recalculate the number of required free pages, to
468 * make sure we never take more than half.
470 handle->reqd_free_pages = reqd_free_pages();
477 static int flush_swap_writer(struct swap_map_handle *handle)
479 if (handle->cur && handle->cur_swap)
480 return write_page(handle->cur, handle->cur_swap, NULL);
485 static int swap_writer_finish(struct swap_map_handle *handle,
486 unsigned int flags, int error)
489 flush_swap_writer(handle);
490 printk(KERN_INFO "PM: S");
491 error = mark_swapfiles(handle, flags);
496 free_all_swap_pages(root_swap);
497 release_swap_writer(handle);
498 swsusp_close(FMODE_WRITE);
503 /* We need to remember how much compressed data we need to read. */
504 #define LZO_HEADER sizeof(size_t)
506 /* Number of pages/bytes we'll compress at one time. */
507 #define LZO_UNC_PAGES 32
508 #define LZO_UNC_SIZE (LZO_UNC_PAGES * PAGE_SIZE)
510 /* Number of pages/bytes we need for compressed data (worst case). */
511 #define LZO_CMP_PAGES DIV_ROUND_UP(lzo1x_worst_compress(LZO_UNC_SIZE) + \
512 LZO_HEADER, PAGE_SIZE)
513 #define LZO_CMP_SIZE (LZO_CMP_PAGES * PAGE_SIZE)
515 /* Maximum number of threads for compression/decompression. */
516 #define LZO_THREADS 3
518 /* Minimum/maximum number of pages for read buffering. */
519 #define LZO_MIN_RD_PAGES 1024
520 #define LZO_MAX_RD_PAGES 8192
524 * save_image - save the suspend image data
527 static int save_image(struct swap_map_handle *handle,
528 struct snapshot_handle *snapshot,
529 unsigned int nr_to_write)
535 struct hib_bio_batch hb;
536 struct timeval start;
541 printk(KERN_INFO "PM: Saving image data pages (%u pages)...\n",
543 m = nr_to_write / 10;
547 do_gettimeofday(&start);
549 ret = snapshot_read_next(snapshot);
552 ret = swap_write_page(handle, data_of(*snapshot), &hb);
556 printk(KERN_INFO "PM: Image saving progress: %3d%%\n",
560 err2 = hib_wait_io(&hb);
561 do_gettimeofday(&stop);
565 printk(KERN_INFO "PM: Image saving done.\n");
566 swsusp_show_speed(&start, &stop, nr_to_write, "Wrote");
571 * Structure used for CRC32.
574 struct task_struct *thr; /* thread */
575 atomic_t ready; /* ready to start flag */
576 atomic_t stop; /* ready to stop flag */
577 unsigned run_threads; /* nr current threads */
578 wait_queue_head_t go; /* start crc update */
579 wait_queue_head_t done; /* crc update done */
580 u32 *crc32; /* points to handle's crc32 */
581 size_t *unc_len[LZO_THREADS]; /* uncompressed lengths */
582 unsigned char *unc[LZO_THREADS]; /* uncompressed data */
586 * CRC32 update function that runs in its own thread.
588 static int crc32_threadfn(void *data)
590 struct crc_data *d = data;
594 wait_event(d->go, atomic_read(&d->ready) ||
595 kthread_should_stop());
596 if (kthread_should_stop()) {
598 atomic_set(&d->stop, 1);
602 atomic_set(&d->ready, 0);
604 for (i = 0; i < d->run_threads; i++)
605 *d->crc32 = crc32_le(*d->crc32,
606 d->unc[i], *d->unc_len[i]);
607 atomic_set(&d->stop, 1);
613 * Structure used for LZO data compression.
616 struct task_struct *thr; /* thread */
617 atomic_t ready; /* ready to start flag */
618 atomic_t stop; /* ready to stop flag */
619 int ret; /* return code */
620 wait_queue_head_t go; /* start compression */
621 wait_queue_head_t done; /* compression done */
622 size_t unc_len; /* uncompressed length */
623 size_t cmp_len; /* compressed length */
624 unsigned char unc[LZO_UNC_SIZE]; /* uncompressed buffer */
625 unsigned char cmp[LZO_CMP_SIZE]; /* compressed buffer */
626 unsigned char wrk[LZO1X_1_MEM_COMPRESS]; /* compression workspace */
630 * Compression function that runs in its own thread.
632 static int lzo_compress_threadfn(void *data)
634 struct cmp_data *d = data;
637 wait_event(d->go, atomic_read(&d->ready) ||
638 kthread_should_stop());
639 if (kthread_should_stop()) {
642 atomic_set(&d->stop, 1);
646 atomic_set(&d->ready, 0);
648 d->ret = lzo1x_1_compress(d->unc, d->unc_len,
649 d->cmp + LZO_HEADER, &d->cmp_len,
651 atomic_set(&d->stop, 1);
658 * save_image_lzo - Save the suspend image data compressed with LZO.
659 * @handle: Swap map handle to use for saving the image.
660 * @snapshot: Image to read data from.
661 * @nr_to_write: Number of pages to save.
663 static int save_image_lzo(struct swap_map_handle *handle,
664 struct snapshot_handle *snapshot,
665 unsigned int nr_to_write)
671 struct hib_bio_batch hb;
672 struct timeval start;
675 unsigned thr, run_threads, nr_threads;
676 unsigned char *page = NULL;
677 struct cmp_data *data = NULL;
678 struct crc_data *crc = NULL;
683 * We'll limit the number of threads for compression to limit memory
686 nr_threads = num_online_cpus() - 1;
687 nr_threads = clamp_val(nr_threads, 1, LZO_THREADS);
689 page = (void *)__get_free_page(__GFP_WAIT | __GFP_HIGH);
691 printk(KERN_ERR "PM: Failed to allocate LZO page\n");
696 data = vmalloc(sizeof(*data) * nr_threads);
698 printk(KERN_ERR "PM: Failed to allocate LZO data\n");
702 for (thr = 0; thr < nr_threads; thr++)
703 memset(&data[thr], 0, offsetof(struct cmp_data, go));
705 crc = kmalloc(sizeof(*crc), GFP_KERNEL);
707 printk(KERN_ERR "PM: Failed to allocate crc\n");
711 memset(crc, 0, offsetof(struct crc_data, go));
714 * Start the compression threads.
716 for (thr = 0; thr < nr_threads; thr++) {
717 init_waitqueue_head(&data[thr].go);
718 init_waitqueue_head(&data[thr].done);
720 data[thr].thr = kthread_run(lzo_compress_threadfn,
722 "image_compress/%u", thr);
723 if (IS_ERR(data[thr].thr)) {
724 data[thr].thr = NULL;
726 "PM: Cannot start compression threads\n");
733 * Start the CRC32 thread.
735 init_waitqueue_head(&crc->go);
736 init_waitqueue_head(&crc->done);
739 crc->crc32 = &handle->crc32;
740 for (thr = 0; thr < nr_threads; thr++) {
741 crc->unc[thr] = data[thr].unc;
742 crc->unc_len[thr] = &data[thr].unc_len;
745 crc->thr = kthread_run(crc32_threadfn, crc, "image_crc32");
746 if (IS_ERR(crc->thr)) {
748 printk(KERN_ERR "PM: Cannot start CRC32 thread\n");
754 * Adjust the number of required free pages after all allocations have
755 * been done. We don't want to run out of pages when writing.
757 handle->reqd_free_pages = reqd_free_pages();
760 "PM: Using %u thread(s) for compression.\n"
761 "PM: Compressing and saving image data (%u pages)...\n",
762 nr_threads, nr_to_write);
763 m = nr_to_write / 10;
767 do_gettimeofday(&start);
769 for (thr = 0; thr < nr_threads; thr++) {
770 for (off = 0; off < LZO_UNC_SIZE; off += PAGE_SIZE) {
771 ret = snapshot_read_next(snapshot);
778 memcpy(data[thr].unc + off,
779 data_of(*snapshot), PAGE_SIZE);
783 "PM: Image saving progress: "
791 data[thr].unc_len = off;
793 atomic_set(&data[thr].ready, 1);
794 wake_up(&data[thr].go);
800 crc->run_threads = thr;
801 atomic_set(&crc->ready, 1);
804 for (run_threads = thr, thr = 0; thr < run_threads; thr++) {
805 wait_event(data[thr].done,
806 atomic_read(&data[thr].stop));
807 atomic_set(&data[thr].stop, 0);
812 printk(KERN_ERR "PM: LZO compression failed\n");
816 if (unlikely(!data[thr].cmp_len ||
818 lzo1x_worst_compress(data[thr].unc_len))) {
820 "PM: Invalid LZO compressed length\n");
825 *(size_t *)data[thr].cmp = data[thr].cmp_len;
828 * Given we are writing one page at a time to disk, we
829 * copy that much from the buffer, although the last
830 * bit will likely be smaller than full page. This is
831 * OK - we saved the length of the compressed data, so
832 * any garbage at the end will be discarded when we
836 off < LZO_HEADER + data[thr].cmp_len;
838 memcpy(page, data[thr].cmp + off, PAGE_SIZE);
840 ret = swap_write_page(handle, page, &hb);
846 wait_event(crc->done, atomic_read(&crc->stop));
847 atomic_set(&crc->stop, 0);
851 err2 = hib_wait_io(&hb);
852 do_gettimeofday(&stop);
856 printk(KERN_INFO "PM: Image saving done.\n");
857 swsusp_show_speed(&start, &stop, nr_to_write, "Wrote");
861 kthread_stop(crc->thr);
865 for (thr = 0; thr < nr_threads; thr++)
867 kthread_stop(data[thr].thr);
870 if (page) free_page((unsigned long)page);
876 * enough_swap - Make sure we have enough swap to save the image.
878 * Returns TRUE or FALSE after checking the total amount of swap
879 * space avaiable from the resume partition.
882 static int enough_swap(unsigned int nr_pages, unsigned int flags)
884 unsigned int free_swap = count_swap_pages(root_swap, 1);
885 unsigned int required;
887 pr_debug("PM: Free swap pages: %u\n", free_swap);
889 required = PAGES_FOR_IO + nr_pages;
890 return free_swap > required;
894 * swsusp_write - Write entire image and metadata.
895 * @flags: flags to pass to the "boot" kernel in the image header
897 * It is important _NOT_ to umount filesystems at this point. We want
898 * them synced (in case something goes wrong) but we DO not want to mark
899 * filesystem clean: it is not. (And it does not matter, if we resume
900 * correctly, we'll mark system clean, anyway.)
903 int swsusp_write(unsigned int flags)
905 struct swap_map_handle handle;
906 struct snapshot_handle snapshot;
907 struct swsusp_info *header;
911 pages = snapshot_get_image_size();
912 error = get_swap_writer(&handle);
914 printk(KERN_ERR "PM: Cannot get swap writer\n");
917 if (flags & SF_NOCOMPRESS_MODE) {
918 if (!enough_swap(pages, flags)) {
919 printk(KERN_ERR "PM: Not enough free swap\n");
924 memset(&snapshot, 0, sizeof(struct snapshot_handle));
925 error = snapshot_read_next(&snapshot);
926 if (error < PAGE_SIZE) {
932 header = (struct swsusp_info *)data_of(snapshot);
933 error = swap_write_page(&handle, header, NULL);
935 error = (flags & SF_NOCOMPRESS_MODE) ?
936 save_image(&handle, &snapshot, pages - 1) :
937 save_image_lzo(&handle, &snapshot, pages - 1);
940 error = swap_writer_finish(&handle, flags, error);
945 * The following functions allow us to read data using a swap map
946 * in a file-alike way
949 static void release_swap_reader(struct swap_map_handle *handle)
951 struct swap_map_page_list *tmp;
953 while (handle->maps) {
954 if (handle->maps->map)
955 free_page((unsigned long)handle->maps->map);
957 handle->maps = handle->maps->next;
963 static int get_swap_reader(struct swap_map_handle *handle,
964 unsigned int *flags_p)
967 struct swap_map_page_list *tmp, *last;
970 *flags_p = swsusp_header->flags;
972 if (!swsusp_header->image) /* how can this happen? */
976 last = handle->maps = NULL;
977 offset = swsusp_header->image;
979 tmp = kmalloc(sizeof(*handle->maps), GFP_KERNEL);
981 release_swap_reader(handle);
984 memset(tmp, 0, sizeof(*tmp));
991 tmp->map = (struct swap_map_page *)
992 __get_free_page(__GFP_WAIT | __GFP_HIGH);
994 release_swap_reader(handle);
998 error = hib_submit_io(READ_SYNC, offset, tmp->map, NULL);
1000 release_swap_reader(handle);
1003 offset = tmp->map->next_swap;
1006 handle->cur = handle->maps->map;
1010 static int swap_read_page(struct swap_map_handle *handle, void *buf,
1011 struct hib_bio_batch *hb)
1015 struct swap_map_page_list *tmp;
1019 offset = handle->cur->entries[handle->k];
1022 error = hib_submit_io(READ_SYNC, offset, buf, hb);
1025 if (++handle->k >= MAP_PAGE_ENTRIES) {
1027 free_page((unsigned long)handle->maps->map);
1029 handle->maps = handle->maps->next;
1032 release_swap_reader(handle);
1034 handle->cur = handle->maps->map;
1039 static int swap_reader_finish(struct swap_map_handle *handle)
1041 release_swap_reader(handle);
1047 * load_image - load the image using the swap map handle
1048 * @handle and the snapshot handle @snapshot
1049 * (assume there are @nr_pages pages to load)
1052 static int load_image(struct swap_map_handle *handle,
1053 struct snapshot_handle *snapshot,
1054 unsigned int nr_to_read)
1058 struct timeval start;
1059 struct timeval stop;
1060 struct hib_bio_batch hb;
1064 hib_init_batch(&hb);
1066 clean_pages_on_read = true;
1067 printk(KERN_INFO "PM: Loading image data pages (%u pages)...\n",
1069 m = nr_to_read / 10;
1073 do_gettimeofday(&start);
1075 ret = snapshot_write_next(snapshot);
1078 ret = swap_read_page(handle, data_of(*snapshot), &hb);
1081 if (snapshot->sync_read)
1082 ret = hib_wait_io(&hb);
1085 if (!(nr_pages % m))
1086 printk(KERN_INFO "PM: Image loading progress: %3d%%\n",
1090 err2 = hib_wait_io(&hb);
1091 do_gettimeofday(&stop);
1095 printk(KERN_INFO "PM: Image loading done.\n");
1096 snapshot_write_finalize(snapshot);
1097 if (!snapshot_image_loaded(snapshot))
1100 swsusp_show_speed(&start, &stop, nr_to_read, "Read");
1105 * Structure used for LZO data decompression.
1108 struct task_struct *thr; /* thread */
1109 atomic_t ready; /* ready to start flag */
1110 atomic_t stop; /* ready to stop flag */
1111 int ret; /* return code */
1112 wait_queue_head_t go; /* start decompression */
1113 wait_queue_head_t done; /* decompression done */
1114 size_t unc_len; /* uncompressed length */
1115 size_t cmp_len; /* compressed length */
1116 unsigned char unc[LZO_UNC_SIZE]; /* uncompressed buffer */
1117 unsigned char cmp[LZO_CMP_SIZE]; /* compressed buffer */
1121 * Deompression function that runs in its own thread.
1123 static int lzo_decompress_threadfn(void *data)
1125 struct dec_data *d = data;
1128 wait_event(d->go, atomic_read(&d->ready) ||
1129 kthread_should_stop());
1130 if (kthread_should_stop()) {
1133 atomic_set(&d->stop, 1);
1137 atomic_set(&d->ready, 0);
1139 d->unc_len = LZO_UNC_SIZE;
1140 d->ret = lzo1x_decompress_safe(d->cmp + LZO_HEADER, d->cmp_len,
1141 d->unc, &d->unc_len);
1142 if (clean_pages_on_decompress)
1143 flush_icache_range((unsigned long)d->unc,
1144 (unsigned long)d->unc + d->unc_len);
1146 atomic_set(&d->stop, 1);
1153 * load_image_lzo - Load compressed image data and decompress them with LZO.
1154 * @handle: Swap map handle to use for loading data.
1155 * @snapshot: Image to copy uncompressed data into.
1156 * @nr_to_read: Number of pages to load.
1158 static int load_image_lzo(struct swap_map_handle *handle,
1159 struct snapshot_handle *snapshot,
1160 unsigned int nr_to_read)
1165 struct hib_bio_batch hb;
1166 struct timeval start;
1167 struct timeval stop;
1170 unsigned i, thr, run_threads, nr_threads;
1171 unsigned ring = 0, pg = 0, ring_size = 0,
1172 have = 0, want, need, asked = 0;
1173 unsigned long read_pages = 0;
1174 unsigned char **page = NULL;
1175 struct dec_data *data = NULL;
1176 struct crc_data *crc = NULL;
1178 hib_init_batch(&hb);
1181 * We'll limit the number of threads for decompression to limit memory
1184 nr_threads = num_online_cpus() - 1;
1185 nr_threads = clamp_val(nr_threads, 1, LZO_THREADS);
1187 page = vmalloc(sizeof(*page) * LZO_MAX_RD_PAGES);
1189 printk(KERN_ERR "PM: Failed to allocate LZO page\n");
1194 data = vmalloc(sizeof(*data) * nr_threads);
1196 printk(KERN_ERR "PM: Failed to allocate LZO data\n");
1200 for (thr = 0; thr < nr_threads; thr++)
1201 memset(&data[thr], 0, offsetof(struct dec_data, go));
1203 crc = kmalloc(sizeof(*crc), GFP_KERNEL);
1205 printk(KERN_ERR "PM: Failed to allocate crc\n");
1209 memset(crc, 0, offsetof(struct crc_data, go));
1211 clean_pages_on_decompress = true;
1214 * Start the decompression threads.
1216 for (thr = 0; thr < nr_threads; thr++) {
1217 init_waitqueue_head(&data[thr].go);
1218 init_waitqueue_head(&data[thr].done);
1220 data[thr].thr = kthread_run(lzo_decompress_threadfn,
1222 "image_decompress/%u", thr);
1223 if (IS_ERR(data[thr].thr)) {
1224 data[thr].thr = NULL;
1226 "PM: Cannot start decompression threads\n");
1233 * Start the CRC32 thread.
1235 init_waitqueue_head(&crc->go);
1236 init_waitqueue_head(&crc->done);
1239 crc->crc32 = &handle->crc32;
1240 for (thr = 0; thr < nr_threads; thr++) {
1241 crc->unc[thr] = data[thr].unc;
1242 crc->unc_len[thr] = &data[thr].unc_len;
1245 crc->thr = kthread_run(crc32_threadfn, crc, "image_crc32");
1246 if (IS_ERR(crc->thr)) {
1248 printk(KERN_ERR "PM: Cannot start CRC32 thread\n");
1254 * Set the number of pages for read buffering.
1255 * This is complete guesswork, because we'll only know the real
1256 * picture once prepare_image() is called, which is much later on
1257 * during the image load phase. We'll assume the worst case and
1258 * say that none of the image pages are from high memory.
1260 if (low_free_pages() > snapshot_get_image_size())
1261 read_pages = (low_free_pages() - snapshot_get_image_size()) / 2;
1262 read_pages = clamp_val(read_pages, LZO_MIN_RD_PAGES, LZO_MAX_RD_PAGES);
1264 for (i = 0; i < read_pages; i++) {
1265 page[i] = (void *)__get_free_page(i < LZO_CMP_PAGES ?
1266 __GFP_WAIT | __GFP_HIGH :
1267 __GFP_WAIT | __GFP_NOWARN |
1271 if (i < LZO_CMP_PAGES) {
1274 "PM: Failed to allocate LZO pages\n");
1282 want = ring_size = i;
1285 "PM: Using %u thread(s) for decompression.\n"
1286 "PM: Loading and decompressing image data (%u pages)...\n",
1287 nr_threads, nr_to_read);
1288 m = nr_to_read / 10;
1292 do_gettimeofday(&start);
1294 ret = snapshot_write_next(snapshot);
1299 for (i = 0; !eof && i < want; i++) {
1300 ret = swap_read_page(handle, page[ring], &hb);
1303 * On real read error, finish. On end of data,
1304 * set EOF flag and just exit the read loop.
1307 handle->cur->entries[handle->k]) {
1314 if (++ring >= ring_size)
1321 * We are out of data, wait for some more.
1327 ret = hib_wait_io(&hb);
1336 if (crc->run_threads) {
1337 wait_event(crc->done, atomic_read(&crc->stop));
1338 atomic_set(&crc->stop, 0);
1339 crc->run_threads = 0;
1342 for (thr = 0; have && thr < nr_threads; thr++) {
1343 data[thr].cmp_len = *(size_t *)page[pg];
1344 if (unlikely(!data[thr].cmp_len ||
1346 lzo1x_worst_compress(LZO_UNC_SIZE))) {
1348 "PM: Invalid LZO compressed length\n");
1353 need = DIV_ROUND_UP(data[thr].cmp_len + LZO_HEADER,
1364 off < LZO_HEADER + data[thr].cmp_len;
1366 memcpy(data[thr].cmp + off,
1367 page[pg], PAGE_SIZE);
1370 if (++pg >= ring_size)
1374 atomic_set(&data[thr].ready, 1);
1375 wake_up(&data[thr].go);
1379 * Wait for more data while we are decompressing.
1381 if (have < LZO_CMP_PAGES && asked) {
1382 ret = hib_wait_io(&hb);
1391 for (run_threads = thr, thr = 0; thr < run_threads; thr++) {
1392 wait_event(data[thr].done,
1393 atomic_read(&data[thr].stop));
1394 atomic_set(&data[thr].stop, 0);
1396 ret = data[thr].ret;
1400 "PM: LZO decompression failed\n");
1404 if (unlikely(!data[thr].unc_len ||
1405 data[thr].unc_len > LZO_UNC_SIZE ||
1406 data[thr].unc_len & (PAGE_SIZE - 1))) {
1408 "PM: Invalid LZO uncompressed length\n");
1414 off < data[thr].unc_len; off += PAGE_SIZE) {
1415 memcpy(data_of(*snapshot),
1416 data[thr].unc + off, PAGE_SIZE);
1418 if (!(nr_pages % m))
1420 "PM: Image loading progress: "
1425 ret = snapshot_write_next(snapshot);
1427 crc->run_threads = thr + 1;
1428 atomic_set(&crc->ready, 1);
1435 crc->run_threads = thr;
1436 atomic_set(&crc->ready, 1);
1441 if (crc->run_threads) {
1442 wait_event(crc->done, atomic_read(&crc->stop));
1443 atomic_set(&crc->stop, 0);
1445 do_gettimeofday(&stop);
1447 printk(KERN_INFO "PM: Image loading done.\n");
1448 snapshot_write_finalize(snapshot);
1449 if (!snapshot_image_loaded(snapshot))
1452 if (swsusp_header->flags & SF_CRC32_MODE) {
1453 if(handle->crc32 != swsusp_header->crc32) {
1455 "PM: Invalid image CRC32!\n");
1461 swsusp_show_speed(&start, &stop, nr_to_read, "Read");
1463 for (i = 0; i < ring_size; i++)
1464 free_page((unsigned long)page[i]);
1467 kthread_stop(crc->thr);
1471 for (thr = 0; thr < nr_threads; thr++)
1473 kthread_stop(data[thr].thr);
1476 if (page) vfree(page);
1482 * swsusp_read - read the hibernation image.
1483 * @flags_p: flags passed by the "frozen" kernel in the image header should
1484 * be written into this memory location
1487 int swsusp_read(unsigned int *flags_p)
1490 struct swap_map_handle handle;
1491 struct snapshot_handle snapshot;
1492 struct swsusp_info *header;
1494 memset(&snapshot, 0, sizeof(struct snapshot_handle));
1495 error = snapshot_write_next(&snapshot);
1496 if (error < PAGE_SIZE)
1497 return error < 0 ? error : -EFAULT;
1498 header = (struct swsusp_info *)data_of(snapshot);
1499 error = get_swap_reader(&handle, flags_p);
1503 error = swap_read_page(&handle, header, NULL);
1505 error = (*flags_p & SF_NOCOMPRESS_MODE) ?
1506 load_image(&handle, &snapshot, header->pages - 1) :
1507 load_image_lzo(&handle, &snapshot, header->pages - 1);
1509 swap_reader_finish(&handle);
1512 pr_debug("PM: Image successfully loaded\n");
1514 pr_debug("PM: Error %d resuming\n", error);
1519 * swsusp_check - Check for swsusp signature in the resume device
1522 int swsusp_check(void)
1526 hib_resume_bdev = blkdev_get_by_dev(swsusp_resume_device,
1528 if (!IS_ERR(hib_resume_bdev)) {
1529 set_blocksize(hib_resume_bdev, PAGE_SIZE);
1530 clear_page(swsusp_header);
1531 error = hib_submit_io(READ_SYNC, swsusp_resume_block,
1532 swsusp_header, NULL);
1536 if (!memcmp(HIBERNATE_SIG, swsusp_header->sig, 10)) {
1537 memcpy(swsusp_header->sig, swsusp_header->orig_sig, 10);
1538 /* Reset swap signature now */
1539 error = hib_submit_io(WRITE_SYNC, swsusp_resume_block,
1540 swsusp_header, NULL);
1547 blkdev_put(hib_resume_bdev, FMODE_READ);
1549 pr_debug("PM: Image signature found, resuming\n");
1551 error = PTR_ERR(hib_resume_bdev);
1555 pr_debug("PM: Image not found (code %d)\n", error);
1561 * swsusp_close - close swap device.
1564 void swsusp_close(fmode_t mode)
1566 if (IS_ERR(hib_resume_bdev)) {
1567 pr_debug("PM: Image device not initialised\n");
1571 blkdev_put(hib_resume_bdev, mode);
1575 * swsusp_unmark - Unmark swsusp signature in the resume device
1578 #ifdef CONFIG_SUSPEND
1579 int swsusp_unmark(void)
1583 hib_submit_io(READ_SYNC, swsusp_resume_block, swsusp_header, NULL);
1584 if (!memcmp(HIBERNATE_SIG,swsusp_header->sig, 10)) {
1585 memcpy(swsusp_header->sig,swsusp_header->orig_sig, 10);
1586 error = hib_submit_io(WRITE_SYNC, swsusp_resume_block,
1587 swsusp_header, NULL);
1589 printk(KERN_ERR "PM: Cannot find swsusp signature!\n");
1594 * We just returned from suspend, we don't need the image any more.
1596 free_all_swap_pages(root_swap);
1602 static int swsusp_header_init(void)
1604 swsusp_header = (struct swsusp_header*) __get_free_page(GFP_KERNEL);
1606 panic("Could not allocate memory for swsusp_header\n");
1610 core_initcall(swsusp_header_init);