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/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 = rb_entry(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;
229 struct blk_plug plug;
232 static void hib_init_batch(struct hib_bio_batch *hb)
234 atomic_set(&hb->count, 0);
235 init_waitqueue_head(&hb->wait);
236 hb->error = BLK_STS_OK;
237 blk_start_plug(&hb->plug);
240 static void hib_finish_batch(struct hib_bio_batch *hb)
242 blk_finish_plug(&hb->plug);
245 static void hib_end_io(struct bio *bio)
247 struct hib_bio_batch *hb = bio->bi_private;
248 struct page *page = bio_first_page_all(bio);
250 if (bio->bi_status) {
251 pr_alert("Read-error on swap-device (%u:%u:%Lu)\n",
252 MAJOR(bio_dev(bio)), MINOR(bio_dev(bio)),
253 (unsigned long long)bio->bi_iter.bi_sector);
256 if (bio_data_dir(bio) == WRITE)
258 else if (clean_pages_on_read)
259 flush_icache_range((unsigned long)page_address(page),
260 (unsigned long)page_address(page) + PAGE_SIZE);
262 if (bio->bi_status && !hb->error)
263 hb->error = bio->bi_status;
264 if (atomic_dec_and_test(&hb->count))
270 static int hib_submit_io(int op, int op_flags, pgoff_t page_off, void *addr,
271 struct hib_bio_batch *hb)
273 struct page *page = virt_to_page(addr);
277 bio = bio_alloc(GFP_NOIO | __GFP_HIGH, 1);
278 bio->bi_iter.bi_sector = page_off * (PAGE_SIZE >> 9);
279 bio_set_dev(bio, hib_resume_bdev);
280 bio_set_op_attrs(bio, op, op_flags);
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);
316 static int mark_swapfiles(struct swap_map_handle *handle, unsigned int flags)
320 hib_submit_io(REQ_OP_READ, 0, swsusp_resume_block,
321 swsusp_header, NULL);
322 if (!memcmp("SWAP-SPACE",swsusp_header->sig, 10) ||
323 !memcmp("SWAPSPACE2",swsusp_header->sig, 10)) {
324 memcpy(swsusp_header->orig_sig,swsusp_header->sig, 10);
325 memcpy(swsusp_header->sig, HIBERNATE_SIG, 10);
326 swsusp_header->image = handle->first_sector;
327 swsusp_header->flags = flags;
328 if (flags & SF_CRC32_MODE)
329 swsusp_header->crc32 = handle->crc32;
330 error = hib_submit_io(REQ_OP_WRITE, REQ_SYNC,
331 swsusp_resume_block, swsusp_header, NULL);
333 pr_err("Swap header not found!\n");
340 * swsusp_swap_check - check if the resume device is a swap device
341 * and get its index (if so)
343 * This is called before saving image
345 static int swsusp_swap_check(void)
349 if (swsusp_resume_device)
350 res = swap_type_of(swsusp_resume_device, swsusp_resume_block);
352 res = find_first_swap(&swsusp_resume_device);
357 hib_resume_bdev = blkdev_get_by_dev(swsusp_resume_device, FMODE_WRITE,
359 if (IS_ERR(hib_resume_bdev))
360 return PTR_ERR(hib_resume_bdev);
362 res = set_blocksize(hib_resume_bdev, PAGE_SIZE);
364 blkdev_put(hib_resume_bdev, FMODE_WRITE);
370 * write_page - Write one page to given swap location.
371 * @buf: Address we're writing.
372 * @offset: Offset of the swap page we're writing to.
373 * @hb: bio completion batch
376 static int write_page(void *buf, sector_t offset, struct hib_bio_batch *hb)
385 src = (void *)__get_free_page(GFP_NOIO | __GFP_NOWARN |
390 ret = hib_wait_io(hb); /* Free pages */
393 src = (void *)__get_free_page(GFP_NOIO |
400 hb = NULL; /* Go synchronous */
407 return hib_submit_io(REQ_OP_WRITE, REQ_SYNC, offset, src, hb);
410 static void release_swap_writer(struct swap_map_handle *handle)
413 free_page((unsigned long)handle->cur);
417 static int get_swap_writer(struct swap_map_handle *handle)
421 ret = swsusp_swap_check();
424 pr_err("Cannot find swap device, try swapon -a\n");
427 handle->cur = (struct swap_map_page *)get_zeroed_page(GFP_KERNEL);
432 handle->cur_swap = alloc_swapdev_block(root_swap);
433 if (!handle->cur_swap) {
438 handle->reqd_free_pages = reqd_free_pages();
439 handle->first_sector = handle->cur_swap;
442 release_swap_writer(handle);
444 swsusp_close(FMODE_WRITE);
448 static int swap_write_page(struct swap_map_handle *handle, void *buf,
449 struct hib_bio_batch *hb)
456 offset = alloc_swapdev_block(root_swap);
457 error = write_page(buf, offset, hb);
460 handle->cur->entries[handle->k++] = offset;
461 if (handle->k >= MAP_PAGE_ENTRIES) {
462 offset = alloc_swapdev_block(root_swap);
465 handle->cur->next_swap = offset;
466 error = write_page(handle->cur, handle->cur_swap, hb);
469 clear_page(handle->cur);
470 handle->cur_swap = offset;
473 if (hb && low_free_pages() <= handle->reqd_free_pages) {
474 error = hib_wait_io(hb);
478 * Recalculate the number of required free pages, to
479 * make sure we never take more than half.
481 handle->reqd_free_pages = reqd_free_pages();
488 static int flush_swap_writer(struct swap_map_handle *handle)
490 if (handle->cur && handle->cur_swap)
491 return write_page(handle->cur, handle->cur_swap, NULL);
496 static int swap_writer_finish(struct swap_map_handle *handle,
497 unsigned int flags, int error)
501 error = mark_swapfiles(handle, flags);
503 flush_swap_writer(handle);
507 free_all_swap_pages(root_swap);
508 release_swap_writer(handle);
509 swsusp_close(FMODE_WRITE);
514 /* We need to remember how much compressed data we need to read. */
515 #define LZO_HEADER sizeof(size_t)
517 /* Number of pages/bytes we'll compress at one time. */
518 #define LZO_UNC_PAGES 32
519 #define LZO_UNC_SIZE (LZO_UNC_PAGES * PAGE_SIZE)
521 /* Number of pages/bytes we need for compressed data (worst case). */
522 #define LZO_CMP_PAGES DIV_ROUND_UP(lzo1x_worst_compress(LZO_UNC_SIZE) + \
523 LZO_HEADER, PAGE_SIZE)
524 #define LZO_CMP_SIZE (LZO_CMP_PAGES * PAGE_SIZE)
526 /* Maximum number of threads for compression/decompression. */
527 #define LZO_THREADS 3
529 /* Minimum/maximum number of pages for read buffering. */
530 #define LZO_MIN_RD_PAGES 1024
531 #define LZO_MAX_RD_PAGES 8192
535 * save_image - save the suspend image data
538 static int save_image(struct swap_map_handle *handle,
539 struct snapshot_handle *snapshot,
540 unsigned int nr_to_write)
546 struct hib_bio_batch hb;
552 pr_info("Saving image data pages (%u pages)...\n",
554 m = nr_to_write / 10;
560 ret = snapshot_read_next(snapshot);
563 ret = swap_write_page(handle, data_of(*snapshot), &hb);
567 pr_info("Image saving progress: %3d%%\n",
571 err2 = hib_wait_io(&hb);
572 hib_finish_batch(&hb);
577 pr_info("Image saving done\n");
578 swsusp_show_speed(start, stop, nr_to_write, "Wrote");
583 * Structure used for CRC32.
586 struct task_struct *thr; /* thread */
587 atomic_t ready; /* ready to start flag */
588 atomic_t stop; /* ready to stop flag */
589 unsigned run_threads; /* nr current threads */
590 wait_queue_head_t go; /* start crc update */
591 wait_queue_head_t done; /* crc update done */
592 u32 *crc32; /* points to handle's crc32 */
593 size_t *unc_len[LZO_THREADS]; /* uncompressed lengths */
594 unsigned char *unc[LZO_THREADS]; /* uncompressed data */
598 * CRC32 update function that runs in its own thread.
600 static int crc32_threadfn(void *data)
602 struct crc_data *d = data;
606 wait_event(d->go, atomic_read(&d->ready) ||
607 kthread_should_stop());
608 if (kthread_should_stop()) {
610 atomic_set(&d->stop, 1);
614 atomic_set(&d->ready, 0);
616 for (i = 0; i < d->run_threads; i++)
617 *d->crc32 = crc32_le(*d->crc32,
618 d->unc[i], *d->unc_len[i]);
619 atomic_set(&d->stop, 1);
625 * Structure used for LZO data compression.
628 struct task_struct *thr; /* thread */
629 atomic_t ready; /* ready to start flag */
630 atomic_t stop; /* ready to stop flag */
631 int ret; /* return code */
632 wait_queue_head_t go; /* start compression */
633 wait_queue_head_t done; /* compression done */
634 size_t unc_len; /* uncompressed length */
635 size_t cmp_len; /* compressed length */
636 unsigned char unc[LZO_UNC_SIZE]; /* uncompressed buffer */
637 unsigned char cmp[LZO_CMP_SIZE]; /* compressed buffer */
638 unsigned char wrk[LZO1X_1_MEM_COMPRESS]; /* compression workspace */
642 * Compression function that runs in its own thread.
644 static int lzo_compress_threadfn(void *data)
646 struct cmp_data *d = data;
649 wait_event(d->go, atomic_read(&d->ready) ||
650 kthread_should_stop());
651 if (kthread_should_stop()) {
654 atomic_set(&d->stop, 1);
658 atomic_set(&d->ready, 0);
660 d->ret = lzo1x_1_compress(d->unc, d->unc_len,
661 d->cmp + LZO_HEADER, &d->cmp_len,
663 atomic_set(&d->stop, 1);
670 * save_image_lzo - Save the suspend image data compressed with LZO.
671 * @handle: Swap map handle to use for saving the image.
672 * @snapshot: Image to read data from.
673 * @nr_to_write: Number of pages to save.
675 static int save_image_lzo(struct swap_map_handle *handle,
676 struct snapshot_handle *snapshot,
677 unsigned int nr_to_write)
683 struct hib_bio_batch hb;
687 unsigned thr, run_threads, nr_threads;
688 unsigned char *page = NULL;
689 struct cmp_data *data = NULL;
690 struct crc_data *crc = NULL;
695 * We'll limit the number of threads for compression to limit memory
698 nr_threads = num_online_cpus() - 1;
699 nr_threads = clamp_val(nr_threads, 1, LZO_THREADS);
701 page = (void *)__get_free_page(GFP_NOIO | __GFP_HIGH);
703 pr_err("Failed to allocate LZO page\n");
708 data = vzalloc(array_size(nr_threads, sizeof(*data)));
710 pr_err("Failed to allocate LZO data\n");
715 crc = kzalloc(sizeof(*crc), GFP_KERNEL);
717 pr_err("Failed to allocate crc\n");
723 * Start the compression threads.
725 for (thr = 0; thr < nr_threads; thr++) {
726 init_waitqueue_head(&data[thr].go);
727 init_waitqueue_head(&data[thr].done);
729 data[thr].thr = kthread_run(lzo_compress_threadfn,
731 "image_compress/%u", thr);
732 if (IS_ERR(data[thr].thr)) {
733 data[thr].thr = NULL;
734 pr_err("Cannot start compression threads\n");
741 * Start the CRC32 thread.
743 init_waitqueue_head(&crc->go);
744 init_waitqueue_head(&crc->done);
747 crc->crc32 = &handle->crc32;
748 for (thr = 0; thr < nr_threads; thr++) {
749 crc->unc[thr] = data[thr].unc;
750 crc->unc_len[thr] = &data[thr].unc_len;
753 crc->thr = kthread_run(crc32_threadfn, crc, "image_crc32");
754 if (IS_ERR(crc->thr)) {
756 pr_err("Cannot start CRC32 thread\n");
762 * Adjust the number of required free pages after all allocations have
763 * been done. We don't want to run out of pages when writing.
765 handle->reqd_free_pages = reqd_free_pages();
767 pr_info("Using %u thread(s) for compression\n", nr_threads);
768 pr_info("Compressing and saving image data (%u pages)...\n",
770 m = nr_to_write / 10;
776 for (thr = 0; thr < nr_threads; thr++) {
777 for (off = 0; off < LZO_UNC_SIZE; off += PAGE_SIZE) {
778 ret = snapshot_read_next(snapshot);
785 memcpy(data[thr].unc + off,
786 data_of(*snapshot), PAGE_SIZE);
789 pr_info("Image saving progress: %3d%%\n",
796 data[thr].unc_len = off;
798 atomic_set(&data[thr].ready, 1);
799 wake_up(&data[thr].go);
805 crc->run_threads = thr;
806 atomic_set(&crc->ready, 1);
809 for (run_threads = thr, thr = 0; thr < run_threads; thr++) {
810 wait_event(data[thr].done,
811 atomic_read(&data[thr].stop));
812 atomic_set(&data[thr].stop, 0);
817 pr_err("LZO compression failed\n");
821 if (unlikely(!data[thr].cmp_len ||
823 lzo1x_worst_compress(data[thr].unc_len))) {
824 pr_err("Invalid LZO compressed length\n");
829 *(size_t *)data[thr].cmp = data[thr].cmp_len;
832 * Given we are writing one page at a time to disk, we
833 * copy that much from the buffer, although the last
834 * bit will likely be smaller than full page. This is
835 * OK - we saved the length of the compressed data, so
836 * any garbage at the end will be discarded when we
840 off < LZO_HEADER + data[thr].cmp_len;
842 memcpy(page, data[thr].cmp + off, PAGE_SIZE);
844 ret = swap_write_page(handle, page, &hb);
850 wait_event(crc->done, atomic_read(&crc->stop));
851 atomic_set(&crc->stop, 0);
855 err2 = hib_wait_io(&hb);
860 pr_info("Image saving done\n");
861 swsusp_show_speed(start, stop, nr_to_write, "Wrote");
863 hib_finish_batch(&hb);
866 kthread_stop(crc->thr);
870 for (thr = 0; thr < nr_threads; thr++)
872 kthread_stop(data[thr].thr);
875 if (page) free_page((unsigned long)page);
881 * enough_swap - Make sure we have enough swap to save the image.
883 * Returns TRUE or FALSE after checking the total amount of swap
884 * space available from the resume partition.
887 static int enough_swap(unsigned int nr_pages)
889 unsigned int free_swap = count_swap_pages(root_swap, 1);
890 unsigned int required;
892 pr_debug("Free swap pages: %u\n", free_swap);
894 required = PAGES_FOR_IO + nr_pages;
895 return free_swap > required;
899 * swsusp_write - Write entire image and metadata.
900 * @flags: flags to pass to the "boot" kernel in the image header
902 * It is important _NOT_ to umount filesystems at this point. We want
903 * them synced (in case something goes wrong) but we DO not want to mark
904 * filesystem clean: it is not. (And it does not matter, if we resume
905 * correctly, we'll mark system clean, anyway.)
908 int swsusp_write(unsigned int flags)
910 struct swap_map_handle handle;
911 struct snapshot_handle snapshot;
912 struct swsusp_info *header;
916 pages = snapshot_get_image_size();
917 error = get_swap_writer(&handle);
919 pr_err("Cannot get swap writer\n");
922 if (flags & SF_NOCOMPRESS_MODE) {
923 if (!enough_swap(pages)) {
924 pr_err("Not enough free swap\n");
929 memset(&snapshot, 0, sizeof(struct snapshot_handle));
930 error = snapshot_read_next(&snapshot);
931 if (error < (int)PAGE_SIZE) {
937 header = (struct swsusp_info *)data_of(snapshot);
938 error = swap_write_page(&handle, header, NULL);
940 error = (flags & SF_NOCOMPRESS_MODE) ?
941 save_image(&handle, &snapshot, pages - 1) :
942 save_image_lzo(&handle, &snapshot, pages - 1);
945 error = swap_writer_finish(&handle, flags, error);
950 * The following functions allow us to read data using a swap map
951 * in a file-alike way
954 static void release_swap_reader(struct swap_map_handle *handle)
956 struct swap_map_page_list *tmp;
958 while (handle->maps) {
959 if (handle->maps->map)
960 free_page((unsigned long)handle->maps->map);
962 handle->maps = handle->maps->next;
968 static int get_swap_reader(struct swap_map_handle *handle,
969 unsigned int *flags_p)
972 struct swap_map_page_list *tmp, *last;
975 *flags_p = swsusp_header->flags;
977 if (!swsusp_header->image) /* how can this happen? */
981 last = handle->maps = NULL;
982 offset = swsusp_header->image;
984 tmp = kzalloc(sizeof(*handle->maps), GFP_KERNEL);
986 release_swap_reader(handle);
995 tmp->map = (struct swap_map_page *)
996 __get_free_page(GFP_NOIO | __GFP_HIGH);
998 release_swap_reader(handle);
1002 error = hib_submit_io(REQ_OP_READ, 0, offset, tmp->map, NULL);
1004 release_swap_reader(handle);
1007 offset = tmp->map->next_swap;
1010 handle->cur = handle->maps->map;
1014 static int swap_read_page(struct swap_map_handle *handle, void *buf,
1015 struct hib_bio_batch *hb)
1019 struct swap_map_page_list *tmp;
1023 offset = handle->cur->entries[handle->k];
1026 error = hib_submit_io(REQ_OP_READ, 0, offset, buf, hb);
1029 if (++handle->k >= MAP_PAGE_ENTRIES) {
1031 free_page((unsigned long)handle->maps->map);
1033 handle->maps = handle->maps->next;
1036 release_swap_reader(handle);
1038 handle->cur = handle->maps->map;
1043 static int swap_reader_finish(struct swap_map_handle *handle)
1045 release_swap_reader(handle);
1051 * load_image - load the image using the swap map handle
1052 * @handle and the snapshot handle @snapshot
1053 * (assume there are @nr_pages pages to load)
1056 static int load_image(struct swap_map_handle *handle,
1057 struct snapshot_handle *snapshot,
1058 unsigned int nr_to_read)
1064 struct hib_bio_batch hb;
1068 hib_init_batch(&hb);
1070 clean_pages_on_read = true;
1071 pr_info("Loading image data pages (%u pages)...\n", nr_to_read);
1072 m = nr_to_read / 10;
1076 start = ktime_get();
1078 ret = snapshot_write_next(snapshot);
1081 ret = swap_read_page(handle, data_of(*snapshot), &hb);
1084 if (snapshot->sync_read)
1085 ret = hib_wait_io(&hb);
1088 if (!(nr_pages % m))
1089 pr_info("Image loading progress: %3d%%\n",
1093 err2 = hib_wait_io(&hb);
1094 hib_finish_batch(&hb);
1099 pr_info("Image loading done\n");
1100 snapshot_write_finalize(snapshot);
1101 if (!snapshot_image_loaded(snapshot))
1104 swsusp_show_speed(start, stop, nr_to_read, "Read");
1109 * Structure used for LZO data decompression.
1112 struct task_struct *thr; /* thread */
1113 atomic_t ready; /* ready to start flag */
1114 atomic_t stop; /* ready to stop flag */
1115 int ret; /* return code */
1116 wait_queue_head_t go; /* start decompression */
1117 wait_queue_head_t done; /* decompression done */
1118 size_t unc_len; /* uncompressed length */
1119 size_t cmp_len; /* compressed length */
1120 unsigned char unc[LZO_UNC_SIZE]; /* uncompressed buffer */
1121 unsigned char cmp[LZO_CMP_SIZE]; /* compressed buffer */
1125 * Decompression function that runs in its own thread.
1127 static int lzo_decompress_threadfn(void *data)
1129 struct dec_data *d = data;
1132 wait_event(d->go, atomic_read(&d->ready) ||
1133 kthread_should_stop());
1134 if (kthread_should_stop()) {
1137 atomic_set(&d->stop, 1);
1141 atomic_set(&d->ready, 0);
1143 d->unc_len = LZO_UNC_SIZE;
1144 d->ret = lzo1x_decompress_safe(d->cmp + LZO_HEADER, d->cmp_len,
1145 d->unc, &d->unc_len);
1146 if (clean_pages_on_decompress)
1147 flush_icache_range((unsigned long)d->unc,
1148 (unsigned long)d->unc + d->unc_len);
1150 atomic_set(&d->stop, 1);
1157 * load_image_lzo - Load compressed image data and decompress them with LZO.
1158 * @handle: Swap map handle to use for loading data.
1159 * @snapshot: Image to copy uncompressed data into.
1160 * @nr_to_read: Number of pages to load.
1162 static int load_image_lzo(struct swap_map_handle *handle,
1163 struct snapshot_handle *snapshot,
1164 unsigned int nr_to_read)
1169 struct hib_bio_batch hb;
1174 unsigned i, thr, run_threads, nr_threads;
1175 unsigned ring = 0, pg = 0, ring_size = 0,
1176 have = 0, want, need, asked = 0;
1177 unsigned long read_pages = 0;
1178 unsigned char **page = NULL;
1179 struct dec_data *data = NULL;
1180 struct crc_data *crc = NULL;
1182 hib_init_batch(&hb);
1185 * We'll limit the number of threads for decompression to limit memory
1188 nr_threads = num_online_cpus() - 1;
1189 nr_threads = clamp_val(nr_threads, 1, LZO_THREADS);
1191 page = vmalloc(array_size(LZO_MAX_RD_PAGES, sizeof(*page)));
1193 pr_err("Failed to allocate LZO page\n");
1198 data = vzalloc(array_size(nr_threads, sizeof(*data)));
1200 pr_err("Failed to allocate LZO data\n");
1205 crc = kzalloc(sizeof(*crc), GFP_KERNEL);
1207 pr_err("Failed to allocate crc\n");
1212 clean_pages_on_decompress = true;
1215 * Start the decompression threads.
1217 for (thr = 0; thr < nr_threads; thr++) {
1218 init_waitqueue_head(&data[thr].go);
1219 init_waitqueue_head(&data[thr].done);
1221 data[thr].thr = kthread_run(lzo_decompress_threadfn,
1223 "image_decompress/%u", thr);
1224 if (IS_ERR(data[thr].thr)) {
1225 data[thr].thr = NULL;
1226 pr_err("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 pr_err("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_NOIO | __GFP_HIGH :
1267 GFP_NOIO | __GFP_NOWARN |
1271 if (i < LZO_CMP_PAGES) {
1273 pr_err("Failed to allocate LZO pages\n");
1281 want = ring_size = i;
1283 pr_info("Using %u thread(s) for decompression\n", nr_threads);
1284 pr_info("Loading and decompressing image data (%u pages)...\n",
1286 m = nr_to_read / 10;
1290 start = ktime_get();
1292 ret = snapshot_write_next(snapshot);
1297 for (i = 0; !eof && i < want; i++) {
1298 ret = swap_read_page(handle, page[ring], &hb);
1301 * On real read error, finish. On end of data,
1302 * set EOF flag and just exit the read loop.
1305 handle->cur->entries[handle->k]) {
1312 if (++ring >= ring_size)
1319 * We are out of data, wait for some more.
1325 ret = hib_wait_io(&hb);
1334 if (crc->run_threads) {
1335 wait_event(crc->done, atomic_read(&crc->stop));
1336 atomic_set(&crc->stop, 0);
1337 crc->run_threads = 0;
1340 for (thr = 0; have && thr < nr_threads; thr++) {
1341 data[thr].cmp_len = *(size_t *)page[pg];
1342 if (unlikely(!data[thr].cmp_len ||
1344 lzo1x_worst_compress(LZO_UNC_SIZE))) {
1345 pr_err("Invalid LZO compressed length\n");
1350 need = DIV_ROUND_UP(data[thr].cmp_len + LZO_HEADER,
1361 off < LZO_HEADER + data[thr].cmp_len;
1363 memcpy(data[thr].cmp + off,
1364 page[pg], PAGE_SIZE);
1367 if (++pg >= ring_size)
1371 atomic_set(&data[thr].ready, 1);
1372 wake_up(&data[thr].go);
1376 * Wait for more data while we are decompressing.
1378 if (have < LZO_CMP_PAGES && asked) {
1379 ret = hib_wait_io(&hb);
1388 for (run_threads = thr, thr = 0; thr < run_threads; thr++) {
1389 wait_event(data[thr].done,
1390 atomic_read(&data[thr].stop));
1391 atomic_set(&data[thr].stop, 0);
1393 ret = data[thr].ret;
1396 pr_err("LZO decompression failed\n");
1400 if (unlikely(!data[thr].unc_len ||
1401 data[thr].unc_len > LZO_UNC_SIZE ||
1402 data[thr].unc_len & (PAGE_SIZE - 1))) {
1403 pr_err("Invalid LZO uncompressed length\n");
1409 off < data[thr].unc_len; off += PAGE_SIZE) {
1410 memcpy(data_of(*snapshot),
1411 data[thr].unc + off, PAGE_SIZE);
1413 if (!(nr_pages % m))
1414 pr_info("Image loading progress: %3d%%\n",
1418 ret = snapshot_write_next(snapshot);
1420 crc->run_threads = thr + 1;
1421 atomic_set(&crc->ready, 1);
1428 crc->run_threads = thr;
1429 atomic_set(&crc->ready, 1);
1434 if (crc->run_threads) {
1435 wait_event(crc->done, atomic_read(&crc->stop));
1436 atomic_set(&crc->stop, 0);
1440 pr_info("Image loading done\n");
1441 snapshot_write_finalize(snapshot);
1442 if (!snapshot_image_loaded(snapshot))
1445 if (swsusp_header->flags & SF_CRC32_MODE) {
1446 if(handle->crc32 != swsusp_header->crc32) {
1447 pr_err("Invalid image CRC32!\n");
1453 swsusp_show_speed(start, stop, nr_to_read, "Read");
1455 hib_finish_batch(&hb);
1456 for (i = 0; i < ring_size; i++)
1457 free_page((unsigned long)page[i]);
1460 kthread_stop(crc->thr);
1464 for (thr = 0; thr < nr_threads; thr++)
1466 kthread_stop(data[thr].thr);
1475 * swsusp_read - read the hibernation image.
1476 * @flags_p: flags passed by the "frozen" kernel in the image header should
1477 * be written into this memory location
1480 int swsusp_read(unsigned int *flags_p)
1483 struct swap_map_handle handle;
1484 struct snapshot_handle snapshot;
1485 struct swsusp_info *header;
1487 memset(&snapshot, 0, sizeof(struct snapshot_handle));
1488 error = snapshot_write_next(&snapshot);
1489 if (error < (int)PAGE_SIZE)
1490 return error < 0 ? error : -EFAULT;
1491 header = (struct swsusp_info *)data_of(snapshot);
1492 error = get_swap_reader(&handle, flags_p);
1496 error = swap_read_page(&handle, header, NULL);
1498 error = (*flags_p & SF_NOCOMPRESS_MODE) ?
1499 load_image(&handle, &snapshot, header->pages - 1) :
1500 load_image_lzo(&handle, &snapshot, header->pages - 1);
1502 swap_reader_finish(&handle);
1505 pr_debug("Image successfully loaded\n");
1507 pr_debug("Error %d resuming\n", error);
1512 * swsusp_check - Check for swsusp signature in the resume device
1515 int swsusp_check(void)
1520 hib_resume_bdev = blkdev_get_by_dev(swsusp_resume_device,
1521 FMODE_READ | FMODE_EXCL, &holder);
1522 if (!IS_ERR(hib_resume_bdev)) {
1523 set_blocksize(hib_resume_bdev, PAGE_SIZE);
1524 clear_page(swsusp_header);
1525 error = hib_submit_io(REQ_OP_READ, 0,
1526 swsusp_resume_block,
1527 swsusp_header, NULL);
1531 if (!memcmp(HIBERNATE_SIG, swsusp_header->sig, 10)) {
1532 memcpy(swsusp_header->sig, swsusp_header->orig_sig, 10);
1533 /* Reset swap signature now */
1534 error = hib_submit_io(REQ_OP_WRITE, REQ_SYNC,
1535 swsusp_resume_block,
1536 swsusp_header, NULL);
1543 blkdev_put(hib_resume_bdev, FMODE_READ | FMODE_EXCL);
1545 pr_debug("Image signature found, resuming\n");
1547 error = PTR_ERR(hib_resume_bdev);
1551 pr_debug("Image not found (code %d)\n", error);
1557 * swsusp_close - close swap device.
1560 void swsusp_close(fmode_t mode)
1562 if (IS_ERR(hib_resume_bdev)) {
1563 pr_debug("Image device not initialised\n");
1567 blkdev_put(hib_resume_bdev, mode);
1571 * swsusp_unmark - Unmark swsusp signature in the resume device
1574 #ifdef CONFIG_SUSPEND
1575 int swsusp_unmark(void)
1579 hib_submit_io(REQ_OP_READ, 0, swsusp_resume_block,
1580 swsusp_header, NULL);
1581 if (!memcmp(HIBERNATE_SIG,swsusp_header->sig, 10)) {
1582 memcpy(swsusp_header->sig,swsusp_header->orig_sig, 10);
1583 error = hib_submit_io(REQ_OP_WRITE, REQ_SYNC,
1584 swsusp_resume_block,
1585 swsusp_header, NULL);
1587 pr_err("Cannot find swsusp signature!\n");
1592 * We just returned from suspend, we don't need the image any more.
1594 free_all_swap_pages(root_swap);
1600 static int __init swsusp_header_init(void)
1602 swsusp_header = (struct swsusp_header*) __get_free_page(GFP_KERNEL);
1604 panic("Could not allocate memory for swsusp_header\n");
1608 core_initcall(swsusp_header_init);