1 // SPDX-License-Identifier: GPL-2.0-only
3 * linux/kernel/power/swap.c
5 * This file provides functions for reading the suspend image from
6 * and writing it to a swap partition.
8 * Copyright (C) 1998,2001-2005 Pavel Machek <pavel@ucw.cz>
9 * Copyright (C) 2006 Rafael J. Wysocki <rjw@sisk.pl>
10 * Copyright (C) 2010-2012 Bojan Smojver <bojan@rexursive.com>
13 #define pr_fmt(fmt) "PM: " fmt
15 #include <linux/module.h>
16 #include <linux/file.h>
17 #include <linux/delay.h>
18 #include <linux/bitops.h>
19 #include <linux/device.h>
20 #include <linux/bio.h>
21 #include <linux/blkdev.h>
22 #include <linux/swap.h>
23 #include <linux/swapops.h>
25 #include <linux/slab.h>
26 #include <linux/lzo.h>
27 #include <linux/vmalloc.h>
28 #include <linux/cpumask.h>
29 #include <linux/atomic.h>
30 #include <linux/kthread.h>
31 #include <linux/crc32.h>
32 #include <linux/ktime.h>
36 #define HIBERNATE_SIG "S1SUSPEND"
38 u32 swsusp_hardware_signature;
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 * The swap map is a data structure used for keeping track of each page
50 * written to a swap partition. It consists of many swap_map_page
51 * structures that contain each an array of MAP_PAGE_ENTRIES swap entries.
52 * These structures are stored on the swap and linked together with the
53 * help of the .next_swap member.
55 * The swap map is created during suspend. The swap map pages are
56 * allocated and populated one at a time, so we only need one memory
57 * page to set up the entire structure.
59 * During resume we pick up all swap_map_page structures into a list.
62 #define MAP_PAGE_ENTRIES (PAGE_SIZE / sizeof(sector_t) - 1)
65 * Number of free pages that are not high.
67 static inline unsigned long low_free_pages(void)
69 return nr_free_pages() - nr_free_highpages();
73 * Number of pages required to be kept free while writing the image. Always
74 * half of all available low pages before the writing starts.
76 static inline unsigned long reqd_free_pages(void)
78 return low_free_pages() / 2;
81 struct swap_map_page {
82 sector_t entries[MAP_PAGE_ENTRIES];
86 struct swap_map_page_list {
87 struct swap_map_page *map;
88 struct swap_map_page_list *next;
92 * The swap_map_handle structure is used for handling swap in
96 struct swap_map_handle {
97 struct swap_map_page *cur;
98 struct swap_map_page_list *maps;
100 sector_t first_sector;
102 unsigned long reqd_free_pages;
106 struct swsusp_header {
107 char reserved[PAGE_SIZE - 20 - sizeof(sector_t) - sizeof(int) -
108 sizeof(u32) - sizeof(u32)];
112 unsigned int flags; /* Flags to pass to the "boot" kernel */
117 static struct swsusp_header *swsusp_header;
120 * The following functions are used for tracing the allocated
121 * swap pages, so that they can be freed in case of an error.
124 struct swsusp_extent {
130 static struct rb_root swsusp_extents = RB_ROOT;
132 static int swsusp_extents_insert(unsigned long swap_offset)
134 struct rb_node **new = &(swsusp_extents.rb_node);
135 struct rb_node *parent = NULL;
136 struct swsusp_extent *ext;
138 /* Figure out where to put the new node */
140 ext = rb_entry(*new, struct swsusp_extent, node);
142 if (swap_offset < ext->start) {
144 if (swap_offset == ext->start - 1) {
148 new = &((*new)->rb_left);
149 } else if (swap_offset > ext->end) {
151 if (swap_offset == ext->end + 1) {
155 new = &((*new)->rb_right);
157 /* It already is in the tree */
161 /* Add the new node and rebalance the tree. */
162 ext = kzalloc(sizeof(struct swsusp_extent), GFP_KERNEL);
166 ext->start = swap_offset;
167 ext->end = swap_offset;
168 rb_link_node(&ext->node, parent, new);
169 rb_insert_color(&ext->node, &swsusp_extents);
174 * alloc_swapdev_block - allocate a swap page and register that it has
175 * been allocated, so that it can be freed in case of an error.
178 sector_t alloc_swapdev_block(int swap)
180 unsigned long offset;
182 offset = swp_offset(get_swap_page_of_type(swap));
184 if (swsusp_extents_insert(offset))
185 swap_free(swp_entry(swap, offset));
187 return swapdev_block(swap, offset);
193 * free_all_swap_pages - free swap pages allocated for saving image data.
194 * It also frees the extents used to register which swap entries had been
198 void free_all_swap_pages(int swap)
200 struct rb_node *node;
202 while ((node = swsusp_extents.rb_node)) {
203 struct swsusp_extent *ext;
204 unsigned long offset;
206 ext = rb_entry(node, struct swsusp_extent, node);
207 rb_erase(node, &swsusp_extents);
208 for (offset = ext->start; offset <= ext->end; offset++)
209 swap_free(swp_entry(swap, offset));
215 int swsusp_swap_in_use(void)
217 return (swsusp_extents.rb_node != NULL);
224 static unsigned short root_swap = 0xffff;
225 static struct block_device *hib_resume_bdev;
227 struct hib_bio_batch {
229 wait_queue_head_t wait;
231 struct blk_plug plug;
234 static void hib_init_batch(struct hib_bio_batch *hb)
236 atomic_set(&hb->count, 0);
237 init_waitqueue_head(&hb->wait);
238 hb->error = BLK_STS_OK;
239 blk_start_plug(&hb->plug);
242 static void hib_finish_batch(struct hib_bio_batch *hb)
244 blk_finish_plug(&hb->plug);
247 static void hib_end_io(struct bio *bio)
249 struct hib_bio_batch *hb = bio->bi_private;
250 struct page *page = bio_first_page_all(bio);
252 if (bio->bi_status) {
253 pr_alert("Read-error on swap-device (%u:%u:%Lu)\n",
254 MAJOR(bio_dev(bio)), MINOR(bio_dev(bio)),
255 (unsigned long long)bio->bi_iter.bi_sector);
258 if (bio_data_dir(bio) == WRITE)
260 else if (clean_pages_on_read)
261 flush_icache_range((unsigned long)page_address(page),
262 (unsigned long)page_address(page) + PAGE_SIZE);
264 if (bio->bi_status && !hb->error)
265 hb->error = bio->bi_status;
266 if (atomic_dec_and_test(&hb->count))
272 static int hib_submit_io(blk_opf_t opf, pgoff_t page_off, void *addr,
273 struct hib_bio_batch *hb)
275 struct page *page = virt_to_page(addr);
279 bio = bio_alloc(hib_resume_bdev, 1, opf, GFP_NOIO | __GFP_HIGH);
280 bio->bi_iter.bi_sector = page_off * (PAGE_SIZE >> 9);
282 if (bio_add_page(bio, page, PAGE_SIZE, 0) < PAGE_SIZE) {
283 pr_err("Adding page to bio failed at %llu\n",
284 (unsigned long long)bio->bi_iter.bi_sector);
290 bio->bi_end_io = hib_end_io;
291 bio->bi_private = hb;
292 atomic_inc(&hb->count);
295 error = submit_bio_wait(bio);
302 static int hib_wait_io(struct hib_bio_batch *hb)
305 * We are relying on the behavior of blk_plug that a thread with
306 * a plug will flush the plug list before sleeping.
308 wait_event(hb->wait, atomic_read(&hb->count) == 0);
309 return blk_status_to_errno(hb->error);
315 static int mark_swapfiles(struct swap_map_handle *handle, unsigned int flags)
319 hib_submit_io(REQ_OP_READ, swsusp_resume_block, swsusp_header, NULL);
320 if (!memcmp("SWAP-SPACE",swsusp_header->sig, 10) ||
321 !memcmp("SWAPSPACE2",swsusp_header->sig, 10)) {
322 memcpy(swsusp_header->orig_sig,swsusp_header->sig, 10);
323 memcpy(swsusp_header->sig, HIBERNATE_SIG, 10);
324 swsusp_header->image = handle->first_sector;
325 if (swsusp_hardware_signature) {
326 swsusp_header->hw_sig = swsusp_hardware_signature;
329 swsusp_header->flags = flags;
330 if (flags & SF_CRC32_MODE)
331 swsusp_header->crc32 = handle->crc32;
332 error = hib_submit_io(REQ_OP_WRITE | REQ_SYNC,
333 swsusp_resume_block, swsusp_header, NULL);
335 pr_err("Swap header not found!\n");
342 * swsusp_swap_check - check if the resume device is a swap device
343 * and get its index (if so)
345 * This is called before saving image
347 static int swsusp_swap_check(void)
351 if (swsusp_resume_device)
352 res = swap_type_of(swsusp_resume_device, swsusp_resume_block);
354 res = find_first_swap(&swsusp_resume_device);
359 hib_resume_bdev = blkdev_get_by_dev(swsusp_resume_device, FMODE_WRITE,
361 if (IS_ERR(hib_resume_bdev))
362 return PTR_ERR(hib_resume_bdev);
364 res = set_blocksize(hib_resume_bdev, PAGE_SIZE);
366 blkdev_put(hib_resume_bdev, FMODE_WRITE);
372 * write_page - Write one page to given swap location.
373 * @buf: Address we're writing.
374 * @offset: Offset of the swap page we're writing to.
375 * @hb: bio completion batch
378 static int write_page(void *buf, sector_t offset, struct hib_bio_batch *hb)
387 src = (void *)__get_free_page(GFP_NOIO | __GFP_NOWARN |
392 ret = hib_wait_io(hb); /* Free pages */
395 src = (void *)__get_free_page(GFP_NOIO |
402 hb = NULL; /* Go synchronous */
409 return hib_submit_io(REQ_OP_WRITE | REQ_SYNC, offset, src, hb);
412 static void release_swap_writer(struct swap_map_handle *handle)
415 free_page((unsigned long)handle->cur);
419 static int get_swap_writer(struct swap_map_handle *handle)
423 ret = swsusp_swap_check();
426 pr_err("Cannot find swap device, try swapon -a\n");
429 handle->cur = (struct swap_map_page *)get_zeroed_page(GFP_KERNEL);
434 handle->cur_swap = alloc_swapdev_block(root_swap);
435 if (!handle->cur_swap) {
440 handle->reqd_free_pages = reqd_free_pages();
441 handle->first_sector = handle->cur_swap;
444 release_swap_writer(handle);
446 swsusp_close(FMODE_WRITE);
450 static int swap_write_page(struct swap_map_handle *handle, void *buf,
451 struct hib_bio_batch *hb)
458 offset = alloc_swapdev_block(root_swap);
459 error = write_page(buf, offset, hb);
462 handle->cur->entries[handle->k++] = offset;
463 if (handle->k >= MAP_PAGE_ENTRIES) {
464 offset = alloc_swapdev_block(root_swap);
467 handle->cur->next_swap = offset;
468 error = write_page(handle->cur, handle->cur_swap, hb);
471 clear_page(handle->cur);
472 handle->cur_swap = offset;
475 if (hb && low_free_pages() <= handle->reqd_free_pages) {
476 error = hib_wait_io(hb);
480 * Recalculate the number of required free pages, to
481 * make sure we never take more than half.
483 handle->reqd_free_pages = reqd_free_pages();
490 static int flush_swap_writer(struct swap_map_handle *handle)
492 if (handle->cur && handle->cur_swap)
493 return write_page(handle->cur, handle->cur_swap, NULL);
498 static int swap_writer_finish(struct swap_map_handle *handle,
499 unsigned int flags, int error)
503 error = mark_swapfiles(handle, flags);
505 flush_swap_writer(handle);
509 free_all_swap_pages(root_swap);
510 release_swap_writer(handle);
511 swsusp_close(FMODE_WRITE);
516 /* We need to remember how much compressed data we need to read. */
517 #define LZO_HEADER sizeof(size_t)
519 /* Number of pages/bytes we'll compress at one time. */
520 #define LZO_UNC_PAGES 32
521 #define LZO_UNC_SIZE (LZO_UNC_PAGES * PAGE_SIZE)
523 /* Number of pages/bytes we need for compressed data (worst case). */
524 #define LZO_CMP_PAGES DIV_ROUND_UP(lzo1x_worst_compress(LZO_UNC_SIZE) + \
525 LZO_HEADER, PAGE_SIZE)
526 #define LZO_CMP_SIZE (LZO_CMP_PAGES * PAGE_SIZE)
528 /* Maximum number of threads for compression/decompression. */
529 #define LZO_THREADS 3
531 /* Minimum/maximum number of pages for read buffering. */
532 #define LZO_MIN_RD_PAGES 1024
533 #define LZO_MAX_RD_PAGES 8192
537 * save_image - save the suspend image data
540 static int save_image(struct swap_map_handle *handle,
541 struct snapshot_handle *snapshot,
542 unsigned int nr_to_write)
548 struct hib_bio_batch hb;
554 pr_info("Saving image data pages (%u pages)...\n",
556 m = nr_to_write / 10;
562 ret = snapshot_read_next(snapshot);
565 ret = swap_write_page(handle, data_of(*snapshot), &hb);
569 pr_info("Image saving progress: %3d%%\n",
573 err2 = hib_wait_io(&hb);
574 hib_finish_batch(&hb);
579 pr_info("Image saving done\n");
580 swsusp_show_speed(start, stop, nr_to_write, "Wrote");
585 * Structure used for CRC32.
588 struct task_struct *thr; /* thread */
589 atomic_t ready; /* ready to start flag */
590 atomic_t stop; /* ready to stop flag */
591 unsigned run_threads; /* nr current threads */
592 wait_queue_head_t go; /* start crc update */
593 wait_queue_head_t done; /* crc update done */
594 u32 *crc32; /* points to handle's crc32 */
595 size_t *unc_len[LZO_THREADS]; /* uncompressed lengths */
596 unsigned char *unc[LZO_THREADS]; /* uncompressed data */
600 * CRC32 update function that runs in its own thread.
602 static int crc32_threadfn(void *data)
604 struct crc_data *d = data;
608 wait_event(d->go, atomic_read(&d->ready) ||
609 kthread_should_stop());
610 if (kthread_should_stop()) {
612 atomic_set(&d->stop, 1);
616 atomic_set(&d->ready, 0);
618 for (i = 0; i < d->run_threads; i++)
619 *d->crc32 = crc32_le(*d->crc32,
620 d->unc[i], *d->unc_len[i]);
621 atomic_set(&d->stop, 1);
627 * Structure used for LZO data compression.
630 struct task_struct *thr; /* thread */
631 atomic_t ready; /* ready to start flag */
632 atomic_t stop; /* ready to stop flag */
633 int ret; /* return code */
634 wait_queue_head_t go; /* start compression */
635 wait_queue_head_t done; /* compression done */
636 size_t unc_len; /* uncompressed length */
637 size_t cmp_len; /* compressed length */
638 unsigned char unc[LZO_UNC_SIZE]; /* uncompressed buffer */
639 unsigned char cmp[LZO_CMP_SIZE]; /* compressed buffer */
640 unsigned char wrk[LZO1X_1_MEM_COMPRESS]; /* compression workspace */
644 * Compression function that runs in its own thread.
646 static int lzo_compress_threadfn(void *data)
648 struct cmp_data *d = data;
651 wait_event(d->go, atomic_read(&d->ready) ||
652 kthread_should_stop());
653 if (kthread_should_stop()) {
656 atomic_set(&d->stop, 1);
660 atomic_set(&d->ready, 0);
662 d->ret = lzo1x_1_compress(d->unc, d->unc_len,
663 d->cmp + LZO_HEADER, &d->cmp_len,
665 atomic_set(&d->stop, 1);
672 * save_image_lzo - Save the suspend image data compressed with LZO.
673 * @handle: Swap map handle to use for saving the image.
674 * @snapshot: Image to read data from.
675 * @nr_to_write: Number of pages to save.
677 static int save_image_lzo(struct swap_map_handle *handle,
678 struct snapshot_handle *snapshot,
679 unsigned int nr_to_write)
685 struct hib_bio_batch hb;
689 unsigned thr, run_threads, nr_threads;
690 unsigned char *page = NULL;
691 struct cmp_data *data = NULL;
692 struct crc_data *crc = NULL;
697 * We'll limit the number of threads for compression to limit memory
700 nr_threads = num_online_cpus() - 1;
701 nr_threads = clamp_val(nr_threads, 1, LZO_THREADS);
703 page = (void *)__get_free_page(GFP_NOIO | __GFP_HIGH);
705 pr_err("Failed to allocate LZO page\n");
710 data = vzalloc(array_size(nr_threads, sizeof(*data)));
712 pr_err("Failed to allocate LZO data\n");
717 crc = kzalloc(sizeof(*crc), GFP_KERNEL);
719 pr_err("Failed to allocate crc\n");
725 * Start the compression threads.
727 for (thr = 0; thr < nr_threads; thr++) {
728 init_waitqueue_head(&data[thr].go);
729 init_waitqueue_head(&data[thr].done);
731 data[thr].thr = kthread_run(lzo_compress_threadfn,
733 "image_compress/%u", thr);
734 if (IS_ERR(data[thr].thr)) {
735 data[thr].thr = NULL;
736 pr_err("Cannot start compression threads\n");
743 * Start the CRC32 thread.
745 init_waitqueue_head(&crc->go);
746 init_waitqueue_head(&crc->done);
749 crc->crc32 = &handle->crc32;
750 for (thr = 0; thr < nr_threads; thr++) {
751 crc->unc[thr] = data[thr].unc;
752 crc->unc_len[thr] = &data[thr].unc_len;
755 crc->thr = kthread_run(crc32_threadfn, crc, "image_crc32");
756 if (IS_ERR(crc->thr)) {
758 pr_err("Cannot start CRC32 thread\n");
764 * Adjust the number of required free pages after all allocations have
765 * been done. We don't want to run out of pages when writing.
767 handle->reqd_free_pages = reqd_free_pages();
769 pr_info("Using %u thread(s) for compression\n", nr_threads);
770 pr_info("Compressing and saving image data (%u pages)...\n",
772 m = nr_to_write / 10;
778 for (thr = 0; thr < nr_threads; thr++) {
779 for (off = 0; off < LZO_UNC_SIZE; off += PAGE_SIZE) {
780 ret = snapshot_read_next(snapshot);
787 memcpy(data[thr].unc + off,
788 data_of(*snapshot), PAGE_SIZE);
791 pr_info("Image saving progress: %3d%%\n",
798 data[thr].unc_len = off;
800 atomic_set(&data[thr].ready, 1);
801 wake_up(&data[thr].go);
807 crc->run_threads = thr;
808 atomic_set(&crc->ready, 1);
811 for (run_threads = thr, thr = 0; thr < run_threads; thr++) {
812 wait_event(data[thr].done,
813 atomic_read(&data[thr].stop));
814 atomic_set(&data[thr].stop, 0);
819 pr_err("LZO compression failed\n");
823 if (unlikely(!data[thr].cmp_len ||
825 lzo1x_worst_compress(data[thr].unc_len))) {
826 pr_err("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 pr_info("Image saving done\n");
863 swsusp_show_speed(start, stop, nr_to_write, "Wrote");
865 hib_finish_batch(&hb);
868 kthread_stop(crc->thr);
872 for (thr = 0; thr < nr_threads; thr++)
874 kthread_stop(data[thr].thr);
877 if (page) free_page((unsigned long)page);
883 * enough_swap - Make sure we have enough swap to save the image.
885 * Returns TRUE or FALSE after checking the total amount of swap
886 * space available from the resume partition.
889 static int enough_swap(unsigned int nr_pages)
891 unsigned int free_swap = count_swap_pages(root_swap, 1);
892 unsigned int required;
894 pr_debug("Free swap pages: %u\n", free_swap);
896 required = PAGES_FOR_IO + nr_pages;
897 return free_swap > required;
901 * swsusp_write - Write entire image and metadata.
902 * @flags: flags to pass to the "boot" kernel in the image header
904 * It is important _NOT_ to umount filesystems at this point. We want
905 * them synced (in case something goes wrong) but we DO not want to mark
906 * filesystem clean: it is not. (And it does not matter, if we resume
907 * correctly, we'll mark system clean, anyway.)
910 int swsusp_write(unsigned int flags)
912 struct swap_map_handle handle;
913 struct snapshot_handle snapshot;
914 struct swsusp_info *header;
918 pages = snapshot_get_image_size();
919 error = get_swap_writer(&handle);
921 pr_err("Cannot get swap writer\n");
924 if (flags & SF_NOCOMPRESS_MODE) {
925 if (!enough_swap(pages)) {
926 pr_err("Not enough free swap\n");
931 memset(&snapshot, 0, sizeof(struct snapshot_handle));
932 error = snapshot_read_next(&snapshot);
933 if (error < (int)PAGE_SIZE) {
939 header = (struct swsusp_info *)data_of(snapshot);
940 error = swap_write_page(&handle, header, NULL);
942 error = (flags & SF_NOCOMPRESS_MODE) ?
943 save_image(&handle, &snapshot, pages - 1) :
944 save_image_lzo(&handle, &snapshot, pages - 1);
947 error = swap_writer_finish(&handle, flags, error);
952 * The following functions allow us to read data using a swap map
953 * in a file-alike way
956 static void release_swap_reader(struct swap_map_handle *handle)
958 struct swap_map_page_list *tmp;
960 while (handle->maps) {
961 if (handle->maps->map)
962 free_page((unsigned long)handle->maps->map);
964 handle->maps = handle->maps->next;
970 static int get_swap_reader(struct swap_map_handle *handle,
971 unsigned int *flags_p)
974 struct swap_map_page_list *tmp, *last;
977 *flags_p = swsusp_header->flags;
979 if (!swsusp_header->image) /* how can this happen? */
983 last = handle->maps = NULL;
984 offset = swsusp_header->image;
986 tmp = kzalloc(sizeof(*handle->maps), GFP_KERNEL);
988 release_swap_reader(handle);
997 tmp->map = (struct swap_map_page *)
998 __get_free_page(GFP_NOIO | __GFP_HIGH);
1000 release_swap_reader(handle);
1004 error = hib_submit_io(REQ_OP_READ, 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(REQ_OP_READ, 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 pr_info("Loading image data pages (%u pages)...\n", nr_to_read);
1074 m = nr_to_read / 10;
1078 start = ktime_get();
1080 ret = snapshot_write_next(snapshot);
1083 ret = swap_read_page(handle, data_of(*snapshot), &hb);
1086 if (snapshot->sync_read)
1087 ret = hib_wait_io(&hb);
1090 if (!(nr_pages % m))
1091 pr_info("Image loading progress: %3d%%\n",
1095 err2 = hib_wait_io(&hb);
1096 hib_finish_batch(&hb);
1101 pr_info("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 * Decompression 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(array_size(LZO_MAX_RD_PAGES, sizeof(*page)));
1195 pr_err("Failed to allocate LZO page\n");
1200 data = vzalloc(array_size(nr_threads, sizeof(*data)));
1202 pr_err("Failed to allocate LZO data\n");
1207 crc = kzalloc(sizeof(*crc), GFP_KERNEL);
1209 pr_err("Failed to allocate crc\n");
1214 clean_pages_on_decompress = true;
1217 * Start the decompression threads.
1219 for (thr = 0; thr < nr_threads; thr++) {
1220 init_waitqueue_head(&data[thr].go);
1221 init_waitqueue_head(&data[thr].done);
1223 data[thr].thr = kthread_run(lzo_decompress_threadfn,
1225 "image_decompress/%u", thr);
1226 if (IS_ERR(data[thr].thr)) {
1227 data[thr].thr = NULL;
1228 pr_err("Cannot start decompression threads\n");
1235 * Start the CRC32 thread.
1237 init_waitqueue_head(&crc->go);
1238 init_waitqueue_head(&crc->done);
1241 crc->crc32 = &handle->crc32;
1242 for (thr = 0; thr < nr_threads; thr++) {
1243 crc->unc[thr] = data[thr].unc;
1244 crc->unc_len[thr] = &data[thr].unc_len;
1247 crc->thr = kthread_run(crc32_threadfn, crc, "image_crc32");
1248 if (IS_ERR(crc->thr)) {
1250 pr_err("Cannot start CRC32 thread\n");
1256 * Set the number of pages for read buffering.
1257 * This is complete guesswork, because we'll only know the real
1258 * picture once prepare_image() is called, which is much later on
1259 * during the image load phase. We'll assume the worst case and
1260 * say that none of the image pages are from high memory.
1262 if (low_free_pages() > snapshot_get_image_size())
1263 read_pages = (low_free_pages() - snapshot_get_image_size()) / 2;
1264 read_pages = clamp_val(read_pages, LZO_MIN_RD_PAGES, LZO_MAX_RD_PAGES);
1266 for (i = 0; i < read_pages; i++) {
1267 page[i] = (void *)__get_free_page(i < LZO_CMP_PAGES ?
1268 GFP_NOIO | __GFP_HIGH :
1269 GFP_NOIO | __GFP_NOWARN |
1273 if (i < LZO_CMP_PAGES) {
1275 pr_err("Failed to allocate LZO pages\n");
1283 want = ring_size = i;
1285 pr_info("Using %u thread(s) for decompression\n", nr_threads);
1286 pr_info("Loading and decompressing image data (%u pages)...\n",
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))) {
1347 pr_err("Invalid LZO compressed length\n");
1352 need = DIV_ROUND_UP(data[thr].cmp_len + LZO_HEADER,
1363 off < LZO_HEADER + data[thr].cmp_len;
1365 memcpy(data[thr].cmp + off,
1366 page[pg], PAGE_SIZE);
1369 if (++pg >= ring_size)
1373 atomic_set(&data[thr].ready, 1);
1374 wake_up(&data[thr].go);
1378 * Wait for more data while we are decompressing.
1380 if (have < LZO_CMP_PAGES && asked) {
1381 ret = hib_wait_io(&hb);
1390 for (run_threads = thr, thr = 0; thr < run_threads; thr++) {
1391 wait_event(data[thr].done,
1392 atomic_read(&data[thr].stop));
1393 atomic_set(&data[thr].stop, 0);
1395 ret = data[thr].ret;
1398 pr_err("LZO decompression failed\n");
1402 if (unlikely(!data[thr].unc_len ||
1403 data[thr].unc_len > LZO_UNC_SIZE ||
1404 data[thr].unc_len & (PAGE_SIZE - 1))) {
1405 pr_err("Invalid LZO uncompressed length\n");
1411 off < data[thr].unc_len; off += PAGE_SIZE) {
1412 memcpy(data_of(*snapshot),
1413 data[thr].unc + off, PAGE_SIZE);
1415 if (!(nr_pages % m))
1416 pr_info("Image loading progress: %3d%%\n",
1420 ret = snapshot_write_next(snapshot);
1422 crc->run_threads = thr + 1;
1423 atomic_set(&crc->ready, 1);
1430 crc->run_threads = thr;
1431 atomic_set(&crc->ready, 1);
1436 if (crc->run_threads) {
1437 wait_event(crc->done, atomic_read(&crc->stop));
1438 atomic_set(&crc->stop, 0);
1442 pr_info("Image loading done\n");
1443 snapshot_write_finalize(snapshot);
1444 if (!snapshot_image_loaded(snapshot))
1447 if (swsusp_header->flags & SF_CRC32_MODE) {
1448 if(handle->crc32 != swsusp_header->crc32) {
1449 pr_err("Invalid image CRC32!\n");
1455 swsusp_show_speed(start, stop, nr_to_read, "Read");
1457 hib_finish_batch(&hb);
1458 for (i = 0; i < ring_size; i++)
1459 free_page((unsigned long)page[i]);
1462 kthread_stop(crc->thr);
1466 for (thr = 0; thr < nr_threads; thr++)
1468 kthread_stop(data[thr].thr);
1477 * swsusp_read - read the hibernation image.
1478 * @flags_p: flags passed by the "frozen" kernel in the image header should
1479 * be written into this memory location
1482 int swsusp_read(unsigned int *flags_p)
1485 struct swap_map_handle handle;
1486 struct snapshot_handle snapshot;
1487 struct swsusp_info *header;
1489 memset(&snapshot, 0, sizeof(struct snapshot_handle));
1490 error = snapshot_write_next(&snapshot);
1491 if (error < (int)PAGE_SIZE)
1492 return error < 0 ? error : -EFAULT;
1493 header = (struct swsusp_info *)data_of(snapshot);
1494 error = get_swap_reader(&handle, flags_p);
1498 error = swap_read_page(&handle, header, NULL);
1500 error = (*flags_p & SF_NOCOMPRESS_MODE) ?
1501 load_image(&handle, &snapshot, header->pages - 1) :
1502 load_image_lzo(&handle, &snapshot, header->pages - 1);
1504 swap_reader_finish(&handle);
1507 pr_debug("Image successfully loaded\n");
1509 pr_debug("Error %d resuming\n", error);
1514 * swsusp_check - Check for swsusp signature in the resume device
1517 int swsusp_check(void)
1522 hib_resume_bdev = blkdev_get_by_dev(swsusp_resume_device,
1523 FMODE_READ | FMODE_EXCL, &holder);
1524 if (!IS_ERR(hib_resume_bdev)) {
1525 set_blocksize(hib_resume_bdev, PAGE_SIZE);
1526 clear_page(swsusp_header);
1527 error = hib_submit_io(REQ_OP_READ, swsusp_resume_block,
1528 swsusp_header, NULL);
1532 if (!memcmp(HIBERNATE_SIG, swsusp_header->sig, 10)) {
1533 memcpy(swsusp_header->sig, swsusp_header->orig_sig, 10);
1534 /* Reset swap signature now */
1535 error = hib_submit_io(REQ_OP_WRITE | REQ_SYNC,
1536 swsusp_resume_block,
1537 swsusp_header, NULL);
1541 if (!error && swsusp_header->flags & SF_HW_SIG &&
1542 swsusp_header->hw_sig != swsusp_hardware_signature) {
1543 pr_info("Suspend image hardware signature mismatch (%08x now %08x); aborting resume.\n",
1544 swsusp_header->hw_sig, swsusp_hardware_signature);
1550 blkdev_put(hib_resume_bdev, FMODE_READ | FMODE_EXCL);
1552 pr_debug("Image signature found, resuming\n");
1554 error = PTR_ERR(hib_resume_bdev);
1558 pr_debug("Image not found (code %d)\n", error);
1564 * swsusp_close - close swap device.
1567 void swsusp_close(fmode_t mode)
1569 if (IS_ERR(hib_resume_bdev)) {
1570 pr_debug("Image device not initialised\n");
1574 blkdev_put(hib_resume_bdev, mode);
1578 * swsusp_unmark - Unmark swsusp signature in the resume device
1581 #ifdef CONFIG_SUSPEND
1582 int swsusp_unmark(void)
1586 hib_submit_io(REQ_OP_READ, swsusp_resume_block,
1587 swsusp_header, NULL);
1588 if (!memcmp(HIBERNATE_SIG,swsusp_header->sig, 10)) {
1589 memcpy(swsusp_header->sig,swsusp_header->orig_sig, 10);
1590 error = hib_submit_io(REQ_OP_WRITE | REQ_SYNC,
1591 swsusp_resume_block,
1592 swsusp_header, NULL);
1594 pr_err("Cannot find swsusp signature!\n");
1599 * We just returned from suspend, we don't need the image any more.
1601 free_all_swap_pages(root_swap);
1607 static int __init swsusp_header_init(void)
1609 swsusp_header = (struct swsusp_header*) __get_free_page(GFP_KERNEL);
1611 panic("Could not allocate memory for swsusp_header\n");
1615 core_initcall(swsusp_header_init);