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"
40 * When reading an {un,}compressed image, we may restore pages in place,
41 * in which case some architectures need these pages cleaning before they
42 * can be executed. We don't know which pages these may be, so clean the lot.
44 static bool clean_pages_on_read;
45 static bool clean_pages_on_decompress;
48 * The swap map is a data structure used for keeping track of each page
49 * written to a swap partition. It consists of many swap_map_page
50 * structures that contain each an array of MAP_PAGE_ENTRIES swap entries.
51 * These structures are stored on the swap and linked together with the
52 * help of the .next_swap member.
54 * The swap map is created during suspend. The swap map pages are
55 * allocated and populated one at a time, so we only need one memory
56 * page to set up the entire structure.
58 * During resume we pick up all swap_map_page structures into a list.
61 #define MAP_PAGE_ENTRIES (PAGE_SIZE / sizeof(sector_t) - 1)
64 * Number of free pages that are not high.
66 static inline unsigned long low_free_pages(void)
68 return nr_free_pages() - nr_free_highpages();
72 * Number of pages required to be kept free while writing the image. Always
73 * half of all available low pages before the writing starts.
75 static inline unsigned long reqd_free_pages(void)
77 return low_free_pages() / 2;
80 struct swap_map_page {
81 sector_t entries[MAP_PAGE_ENTRIES];
85 struct swap_map_page_list {
86 struct swap_map_page *map;
87 struct swap_map_page_list *next;
91 * The swap_map_handle structure is used for handling swap in
95 struct swap_map_handle {
96 struct swap_map_page *cur;
97 struct swap_map_page_list *maps;
99 sector_t first_sector;
101 unsigned long reqd_free_pages;
105 struct swsusp_header {
106 char reserved[PAGE_SIZE - 20 - sizeof(sector_t) - sizeof(int) -
110 unsigned int flags; /* Flags to pass to the "boot" kernel */
115 static struct swsusp_header *swsusp_header;
118 * The following functions are used for tracing the allocated
119 * swap pages, so that they can be freed in case of an error.
122 struct swsusp_extent {
128 static struct rb_root swsusp_extents = RB_ROOT;
130 static int swsusp_extents_insert(unsigned long swap_offset)
132 struct rb_node **new = &(swsusp_extents.rb_node);
133 struct rb_node *parent = NULL;
134 struct swsusp_extent *ext;
136 /* Figure out where to put the new node */
138 ext = rb_entry(*new, struct swsusp_extent, node);
140 if (swap_offset < ext->start) {
142 if (swap_offset == ext->start - 1) {
146 new = &((*new)->rb_left);
147 } else if (swap_offset > ext->end) {
149 if (swap_offset == ext->end + 1) {
153 new = &((*new)->rb_right);
155 /* It already is in the tree */
159 /* Add the new node and rebalance the tree. */
160 ext = kzalloc(sizeof(struct swsusp_extent), GFP_KERNEL);
164 ext->start = swap_offset;
165 ext->end = swap_offset;
166 rb_link_node(&ext->node, parent, new);
167 rb_insert_color(&ext->node, &swsusp_extents);
172 * alloc_swapdev_block - allocate a swap page and register that it has
173 * been allocated, so that it can be freed in case of an error.
176 sector_t alloc_swapdev_block(int swap)
178 unsigned long offset;
180 offset = swp_offset(get_swap_page_of_type(swap));
182 if (swsusp_extents_insert(offset))
183 swap_free(swp_entry(swap, offset));
185 return swapdev_block(swap, offset);
191 * free_all_swap_pages - free swap pages allocated for saving image data.
192 * It also frees the extents used to register which swap entries had been
196 void free_all_swap_pages(int swap)
198 struct rb_node *node;
200 while ((node = swsusp_extents.rb_node)) {
201 struct swsusp_extent *ext;
202 unsigned long offset;
204 ext = container_of(node, struct swsusp_extent, node);
205 rb_erase(node, &swsusp_extents);
206 for (offset = ext->start; offset <= ext->end; offset++)
207 swap_free(swp_entry(swap, offset));
213 int swsusp_swap_in_use(void)
215 return (swsusp_extents.rb_node != NULL);
222 static unsigned short root_swap = 0xffff;
223 static struct block_device *hib_resume_bdev;
225 struct hib_bio_batch {
227 wait_queue_head_t wait;
231 static void hib_init_batch(struct hib_bio_batch *hb)
233 atomic_set(&hb->count, 0);
234 init_waitqueue_head(&hb->wait);
238 static void hib_end_io(struct bio *bio)
240 struct hib_bio_batch *hb = bio->bi_private;
241 struct page *page = bio->bi_io_vec[0].bv_page;
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);
250 if (bio_data_dir(bio) == WRITE)
252 else if (clean_pages_on_read)
253 flush_icache_range((unsigned long)page_address(page),
254 (unsigned long)page_address(page) + PAGE_SIZE);
256 if (bio->bi_error && !hb->error)
257 hb->error = bio->bi_error;
258 if (atomic_dec_and_test(&hb->count))
264 static int hib_submit_io(int op, int op_flags, pgoff_t page_off, void *addr,
265 struct hib_bio_batch *hb)
267 struct page *page = virt_to_page(addr);
271 bio = bio_alloc(__GFP_RECLAIM | __GFP_HIGH, 1);
272 bio->bi_iter.bi_sector = page_off * (PAGE_SIZE >> 9);
273 bio->bi_bdev = hib_resume_bdev;
274 bio_set_op_attrs(bio, op, op_flags);
276 if (bio_add_page(bio, page, PAGE_SIZE, 0) < PAGE_SIZE) {
277 printk(KERN_ERR "PM: Adding page to bio failed at %llu\n",
278 (unsigned long long)bio->bi_iter.bi_sector);
284 bio->bi_end_io = hib_end_io;
285 bio->bi_private = hb;
286 atomic_inc(&hb->count);
289 error = submit_bio_wait(bio);
296 static int hib_wait_io(struct hib_bio_batch *hb)
298 wait_event(hb->wait, atomic_read(&hb->count) == 0);
306 static int mark_swapfiles(struct swap_map_handle *handle, unsigned int flags)
310 hib_submit_io(REQ_OP_READ, READ_SYNC, swsusp_resume_block,
311 swsusp_header, NULL);
312 if (!memcmp("SWAP-SPACE",swsusp_header->sig, 10) ||
313 !memcmp("SWAPSPACE2",swsusp_header->sig, 10)) {
314 memcpy(swsusp_header->orig_sig,swsusp_header->sig, 10);
315 memcpy(swsusp_header->sig, HIBERNATE_SIG, 10);
316 swsusp_header->image = handle->first_sector;
317 swsusp_header->flags = flags;
318 if (flags & SF_CRC32_MODE)
319 swsusp_header->crc32 = handle->crc32;
320 error = hib_submit_io(REQ_OP_WRITE, WRITE_SYNC,
321 swsusp_resume_block, swsusp_header, NULL);
323 printk(KERN_ERR "PM: Swap header not found!\n");
330 * swsusp_swap_check - check if the resume device is a swap device
331 * and get its index (if so)
333 * This is called before saving image
335 static int swsusp_swap_check(void)
339 res = swap_type_of(swsusp_resume_device, swsusp_resume_block,
345 res = blkdev_get(hib_resume_bdev, FMODE_WRITE, NULL);
349 res = set_blocksize(hib_resume_bdev, PAGE_SIZE);
351 blkdev_put(hib_resume_bdev, FMODE_WRITE);
357 * write_page - Write one page to given swap location.
358 * @buf: Address we're writing.
359 * @offset: Offset of the swap page we're writing to.
360 * @hb: bio completion batch
363 static int write_page(void *buf, sector_t offset, struct hib_bio_batch *hb)
372 src = (void *)__get_free_page(__GFP_RECLAIM | __GFP_NOWARN |
377 ret = hib_wait_io(hb); /* Free pages */
380 src = (void *)__get_free_page(__GFP_RECLAIM |
387 hb = NULL; /* Go synchronous */
394 return hib_submit_io(REQ_OP_WRITE, WRITE_SYNC, offset, src, hb);
397 static void release_swap_writer(struct swap_map_handle *handle)
400 free_page((unsigned long)handle->cur);
404 static int get_swap_writer(struct swap_map_handle *handle)
408 ret = swsusp_swap_check();
411 printk(KERN_ERR "PM: Cannot find swap device, try "
415 handle->cur = (struct swap_map_page *)get_zeroed_page(GFP_KERNEL);
420 handle->cur_swap = alloc_swapdev_block(root_swap);
421 if (!handle->cur_swap) {
426 handle->reqd_free_pages = reqd_free_pages();
427 handle->first_sector = handle->cur_swap;
430 release_swap_writer(handle);
432 swsusp_close(FMODE_WRITE);
436 static int swap_write_page(struct swap_map_handle *handle, void *buf,
437 struct hib_bio_batch *hb)
444 offset = alloc_swapdev_block(root_swap);
445 error = write_page(buf, offset, hb);
448 handle->cur->entries[handle->k++] = offset;
449 if (handle->k >= MAP_PAGE_ENTRIES) {
450 offset = alloc_swapdev_block(root_swap);
453 handle->cur->next_swap = offset;
454 error = write_page(handle->cur, handle->cur_swap, hb);
457 clear_page(handle->cur);
458 handle->cur_swap = offset;
461 if (hb && low_free_pages() <= handle->reqd_free_pages) {
462 error = hib_wait_io(hb);
466 * Recalculate the number of required free pages, to
467 * make sure we never take more than half.
469 handle->reqd_free_pages = reqd_free_pages();
476 static int flush_swap_writer(struct swap_map_handle *handle)
478 if (handle->cur && handle->cur_swap)
479 return write_page(handle->cur, handle->cur_swap, NULL);
484 static int swap_writer_finish(struct swap_map_handle *handle,
485 unsigned int flags, int error)
488 flush_swap_writer(handle);
489 printk(KERN_INFO "PM: S");
490 error = mark_swapfiles(handle, flags);
495 free_all_swap_pages(root_swap);
496 release_swap_writer(handle);
497 swsusp_close(FMODE_WRITE);
502 /* We need to remember how much compressed data we need to read. */
503 #define LZO_HEADER sizeof(size_t)
505 /* Number of pages/bytes we'll compress at one time. */
506 #define LZO_UNC_PAGES 32
507 #define LZO_UNC_SIZE (LZO_UNC_PAGES * PAGE_SIZE)
509 /* Number of pages/bytes we need for compressed data (worst case). */
510 #define LZO_CMP_PAGES DIV_ROUND_UP(lzo1x_worst_compress(LZO_UNC_SIZE) + \
511 LZO_HEADER, PAGE_SIZE)
512 #define LZO_CMP_SIZE (LZO_CMP_PAGES * PAGE_SIZE)
514 /* Maximum number of threads for compression/decompression. */
515 #define LZO_THREADS 3
517 /* Minimum/maximum number of pages for read buffering. */
518 #define LZO_MIN_RD_PAGES 1024
519 #define LZO_MAX_RD_PAGES 8192
523 * save_image - save the suspend image data
526 static int save_image(struct swap_map_handle *handle,
527 struct snapshot_handle *snapshot,
528 unsigned int nr_to_write)
534 struct hib_bio_batch hb;
540 printk(KERN_INFO "PM: Saving image data pages (%u pages)...\n",
542 m = nr_to_write / 10;
548 ret = snapshot_read_next(snapshot);
551 ret = swap_write_page(handle, data_of(*snapshot), &hb);
555 printk(KERN_INFO "PM: Image saving progress: %3d%%\n",
559 err2 = hib_wait_io(&hb);
564 printk(KERN_INFO "PM: Image saving done.\n");
565 swsusp_show_speed(start, stop, nr_to_write, "Wrote");
570 * Structure used for CRC32.
573 struct task_struct *thr; /* thread */
574 atomic_t ready; /* ready to start flag */
575 atomic_t stop; /* ready to stop flag */
576 unsigned run_threads; /* nr current threads */
577 wait_queue_head_t go; /* start crc update */
578 wait_queue_head_t done; /* crc update done */
579 u32 *crc32; /* points to handle's crc32 */
580 size_t *unc_len[LZO_THREADS]; /* uncompressed lengths */
581 unsigned char *unc[LZO_THREADS]; /* uncompressed data */
585 * CRC32 update function that runs in its own thread.
587 static int crc32_threadfn(void *data)
589 struct crc_data *d = data;
593 wait_event(d->go, atomic_read(&d->ready) ||
594 kthread_should_stop());
595 if (kthread_should_stop()) {
597 atomic_set(&d->stop, 1);
601 atomic_set(&d->ready, 0);
603 for (i = 0; i < d->run_threads; i++)
604 *d->crc32 = crc32_le(*d->crc32,
605 d->unc[i], *d->unc_len[i]);
606 atomic_set(&d->stop, 1);
612 * Structure used for LZO data compression.
615 struct task_struct *thr; /* thread */
616 atomic_t ready; /* ready to start flag */
617 atomic_t stop; /* ready to stop flag */
618 int ret; /* return code */
619 wait_queue_head_t go; /* start compression */
620 wait_queue_head_t done; /* compression done */
621 size_t unc_len; /* uncompressed length */
622 size_t cmp_len; /* compressed length */
623 unsigned char unc[LZO_UNC_SIZE]; /* uncompressed buffer */
624 unsigned char cmp[LZO_CMP_SIZE]; /* compressed buffer */
625 unsigned char wrk[LZO1X_1_MEM_COMPRESS]; /* compression workspace */
629 * Compression function that runs in its own thread.
631 static int lzo_compress_threadfn(void *data)
633 struct cmp_data *d = data;
636 wait_event(d->go, atomic_read(&d->ready) ||
637 kthread_should_stop());
638 if (kthread_should_stop()) {
641 atomic_set(&d->stop, 1);
645 atomic_set(&d->ready, 0);
647 d->ret = lzo1x_1_compress(d->unc, d->unc_len,
648 d->cmp + LZO_HEADER, &d->cmp_len,
650 atomic_set(&d->stop, 1);
657 * save_image_lzo - Save the suspend image data compressed with LZO.
658 * @handle: Swap map handle to use for saving the image.
659 * @snapshot: Image to read data from.
660 * @nr_to_write: Number of pages to save.
662 static int save_image_lzo(struct swap_map_handle *handle,
663 struct snapshot_handle *snapshot,
664 unsigned int nr_to_write)
670 struct hib_bio_batch hb;
674 unsigned thr, run_threads, nr_threads;
675 unsigned char *page = NULL;
676 struct cmp_data *data = NULL;
677 struct crc_data *crc = NULL;
682 * We'll limit the number of threads for compression to limit memory
685 nr_threads = num_online_cpus() - 1;
686 nr_threads = clamp_val(nr_threads, 1, LZO_THREADS);
688 page = (void *)__get_free_page(__GFP_RECLAIM | __GFP_HIGH);
690 printk(KERN_ERR "PM: Failed to allocate LZO page\n");
695 data = vmalloc(sizeof(*data) * nr_threads);
697 printk(KERN_ERR "PM: Failed to allocate LZO data\n");
701 for (thr = 0; thr < nr_threads; thr++)
702 memset(&data[thr], 0, offsetof(struct cmp_data, go));
704 crc = kmalloc(sizeof(*crc), GFP_KERNEL);
706 printk(KERN_ERR "PM: Failed to allocate crc\n");
710 memset(crc, 0, offsetof(struct crc_data, go));
713 * Start the compression threads.
715 for (thr = 0; thr < nr_threads; thr++) {
716 init_waitqueue_head(&data[thr].go);
717 init_waitqueue_head(&data[thr].done);
719 data[thr].thr = kthread_run(lzo_compress_threadfn,
721 "image_compress/%u", thr);
722 if (IS_ERR(data[thr].thr)) {
723 data[thr].thr = NULL;
725 "PM: Cannot start compression threads\n");
732 * Start the CRC32 thread.
734 init_waitqueue_head(&crc->go);
735 init_waitqueue_head(&crc->done);
738 crc->crc32 = &handle->crc32;
739 for (thr = 0; thr < nr_threads; thr++) {
740 crc->unc[thr] = data[thr].unc;
741 crc->unc_len[thr] = &data[thr].unc_len;
744 crc->thr = kthread_run(crc32_threadfn, crc, "image_crc32");
745 if (IS_ERR(crc->thr)) {
747 printk(KERN_ERR "PM: Cannot start CRC32 thread\n");
753 * Adjust the number of required free pages after all allocations have
754 * been done. We don't want to run out of pages when writing.
756 handle->reqd_free_pages = reqd_free_pages();
759 "PM: Using %u thread(s) for compression.\n"
760 "PM: Compressing and saving image data (%u pages)...\n",
761 nr_threads, nr_to_write);
762 m = nr_to_write / 10;
768 for (thr = 0; thr < nr_threads; thr++) {
769 for (off = 0; off < LZO_UNC_SIZE; off += PAGE_SIZE) {
770 ret = snapshot_read_next(snapshot);
777 memcpy(data[thr].unc + off,
778 data_of(*snapshot), PAGE_SIZE);
782 "PM: Image saving progress: "
790 data[thr].unc_len = off;
792 atomic_set(&data[thr].ready, 1);
793 wake_up(&data[thr].go);
799 crc->run_threads = thr;
800 atomic_set(&crc->ready, 1);
803 for (run_threads = thr, thr = 0; thr < run_threads; thr++) {
804 wait_event(data[thr].done,
805 atomic_read(&data[thr].stop));
806 atomic_set(&data[thr].stop, 0);
811 printk(KERN_ERR "PM: LZO compression failed\n");
815 if (unlikely(!data[thr].cmp_len ||
817 lzo1x_worst_compress(data[thr].unc_len))) {
819 "PM: Invalid LZO compressed length\n");
824 *(size_t *)data[thr].cmp = data[thr].cmp_len;
827 * Given we are writing one page at a time to disk, we
828 * copy that much from the buffer, although the last
829 * bit will likely be smaller than full page. This is
830 * OK - we saved the length of the compressed data, so
831 * any garbage at the end will be discarded when we
835 off < LZO_HEADER + data[thr].cmp_len;
837 memcpy(page, data[thr].cmp + off, PAGE_SIZE);
839 ret = swap_write_page(handle, page, &hb);
845 wait_event(crc->done, atomic_read(&crc->stop));
846 atomic_set(&crc->stop, 0);
850 err2 = hib_wait_io(&hb);
855 printk(KERN_INFO "PM: Image saving done.\n");
856 swsusp_show_speed(start, stop, nr_to_write, "Wrote");
860 kthread_stop(crc->thr);
864 for (thr = 0; thr < nr_threads; thr++)
866 kthread_stop(data[thr].thr);
869 if (page) free_page((unsigned long)page);
875 * enough_swap - Make sure we have enough swap to save the image.
877 * Returns TRUE or FALSE after checking the total amount of swap
878 * space avaiable from the resume partition.
881 static int enough_swap(unsigned int nr_pages, unsigned int flags)
883 unsigned int free_swap = count_swap_pages(root_swap, 1);
884 unsigned int required;
886 pr_debug("PM: Free swap pages: %u\n", free_swap);
888 required = PAGES_FOR_IO + nr_pages;
889 return free_swap > required;
893 * swsusp_write - Write entire image and metadata.
894 * @flags: flags to pass to the "boot" kernel in the image header
896 * It is important _NOT_ to umount filesystems at this point. We want
897 * them synced (in case something goes wrong) but we DO not want to mark
898 * filesystem clean: it is not. (And it does not matter, if we resume
899 * correctly, we'll mark system clean, anyway.)
902 int swsusp_write(unsigned int flags)
904 struct swap_map_handle handle;
905 struct snapshot_handle snapshot;
906 struct swsusp_info *header;
910 pages = snapshot_get_image_size();
911 error = get_swap_writer(&handle);
913 printk(KERN_ERR "PM: Cannot get swap writer\n");
916 if (flags & SF_NOCOMPRESS_MODE) {
917 if (!enough_swap(pages, flags)) {
918 printk(KERN_ERR "PM: Not enough free swap\n");
923 memset(&snapshot, 0, sizeof(struct snapshot_handle));
924 error = snapshot_read_next(&snapshot);
925 if (error < PAGE_SIZE) {
931 header = (struct swsusp_info *)data_of(snapshot);
932 error = swap_write_page(&handle, header, NULL);
934 error = (flags & SF_NOCOMPRESS_MODE) ?
935 save_image(&handle, &snapshot, pages - 1) :
936 save_image_lzo(&handle, &snapshot, pages - 1);
939 error = swap_writer_finish(&handle, flags, error);
944 * The following functions allow us to read data using a swap map
945 * in a file-alike way
948 static void release_swap_reader(struct swap_map_handle *handle)
950 struct swap_map_page_list *tmp;
952 while (handle->maps) {
953 if (handle->maps->map)
954 free_page((unsigned long)handle->maps->map);
956 handle->maps = handle->maps->next;
962 static int get_swap_reader(struct swap_map_handle *handle,
963 unsigned int *flags_p)
966 struct swap_map_page_list *tmp, *last;
969 *flags_p = swsusp_header->flags;
971 if (!swsusp_header->image) /* how can this happen? */
975 last = handle->maps = NULL;
976 offset = swsusp_header->image;
978 tmp = kmalloc(sizeof(*handle->maps), GFP_KERNEL);
980 release_swap_reader(handle);
983 memset(tmp, 0, sizeof(*tmp));
990 tmp->map = (struct swap_map_page *)
991 __get_free_page(__GFP_RECLAIM | __GFP_HIGH);
993 release_swap_reader(handle);
997 error = hib_submit_io(REQ_OP_READ, READ_SYNC, offset,
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(REQ_OP_READ, 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)
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 start = ktime_get();
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);
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;
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_RECLAIM | __GFP_HIGH :
1267 __GFP_RECLAIM | __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 start = ktime_get();
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);
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);
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(REQ_OP_READ, READ_SYNC,
1532 swsusp_resume_block,
1533 swsusp_header, NULL);
1537 if (!memcmp(HIBERNATE_SIG, swsusp_header->sig, 10)) {
1538 memcpy(swsusp_header->sig, swsusp_header->orig_sig, 10);
1539 /* Reset swap signature now */
1540 error = hib_submit_io(REQ_OP_WRITE, WRITE_SYNC,
1541 swsusp_resume_block,
1542 swsusp_header, NULL);
1549 blkdev_put(hib_resume_bdev, FMODE_READ);
1551 pr_debug("PM: Image signature found, resuming\n");
1553 error = PTR_ERR(hib_resume_bdev);
1557 pr_debug("PM: Image not found (code %d)\n", error);
1563 * swsusp_close - close swap device.
1566 void swsusp_close(fmode_t mode)
1568 if (IS_ERR(hib_resume_bdev)) {
1569 pr_debug("PM: Image device not initialised\n");
1573 blkdev_put(hib_resume_bdev, mode);
1577 * swsusp_unmark - Unmark swsusp signature in the resume device
1580 #ifdef CONFIG_SUSPEND
1581 int swsusp_unmark(void)
1585 hib_submit_io(REQ_OP_READ, READ_SYNC, swsusp_resume_block,
1586 swsusp_header, NULL);
1587 if (!memcmp(HIBERNATE_SIG,swsusp_header->sig, 10)) {
1588 memcpy(swsusp_header->sig,swsusp_header->orig_sig, 10);
1589 error = hib_submit_io(REQ_OP_WRITE, WRITE_SYNC,
1590 swsusp_resume_block,
1591 swsusp_header, NULL);
1593 printk(KERN_ERR "PM: Cannot find swsusp signature!\n");
1598 * We just returned from suspend, we don't need the image any more.
1600 free_all_swap_pages(root_swap);
1606 static int swsusp_header_init(void)
1608 swsusp_header = (struct swsusp_header*) __get_free_page(GFP_KERNEL);
1610 panic("Could not allocate memory for swsusp_header\n");
1614 core_initcall(swsusp_header_init);