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 blk_status_t 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 res = swap_type_of(swsusp_resume_device, swsusp_resume_block,
355 res = blkdev_get(hib_resume_bdev, FMODE_WRITE, NULL);
359 res = set_blocksize(hib_resume_bdev, PAGE_SIZE);
361 blkdev_put(hib_resume_bdev, FMODE_WRITE);
364 * Update the resume device to the one actually used,
365 * so the test_resume mode can use it in case it is
366 * invoked from hibernate() to test the snapshot.
368 swsusp_resume_device = hib_resume_bdev->bd_dev;
373 * write_page - Write one page to given swap location.
374 * @buf: Address we're writing.
375 * @offset: Offset of the swap page we're writing to.
376 * @hb: bio completion batch
379 static int write_page(void *buf, sector_t offset, struct hib_bio_batch *hb)
388 src = (void *)__get_free_page(GFP_NOIO | __GFP_NOWARN |
393 ret = hib_wait_io(hb); /* Free pages */
396 src = (void *)__get_free_page(GFP_NOIO |
403 hb = NULL; /* Go synchronous */
410 return hib_submit_io(REQ_OP_WRITE, REQ_SYNC, offset, src, hb);
413 static void release_swap_writer(struct swap_map_handle *handle)
416 free_page((unsigned long)handle->cur);
420 static int get_swap_writer(struct swap_map_handle *handle)
424 ret = swsusp_swap_check();
427 pr_err("Cannot find swap device, try swapon -a\n");
430 handle->cur = (struct swap_map_page *)get_zeroed_page(GFP_KERNEL);
435 handle->cur_swap = alloc_swapdev_block(root_swap);
436 if (!handle->cur_swap) {
441 handle->reqd_free_pages = reqd_free_pages();
442 handle->first_sector = handle->cur_swap;
445 release_swap_writer(handle);
447 swsusp_close(FMODE_WRITE);
451 static int swap_write_page(struct swap_map_handle *handle, void *buf,
452 struct hib_bio_batch *hb)
459 offset = alloc_swapdev_block(root_swap);
460 error = write_page(buf, offset, hb);
463 handle->cur->entries[handle->k++] = offset;
464 if (handle->k >= MAP_PAGE_ENTRIES) {
465 offset = alloc_swapdev_block(root_swap);
468 handle->cur->next_swap = offset;
469 error = write_page(handle->cur, handle->cur_swap, hb);
472 clear_page(handle->cur);
473 handle->cur_swap = offset;
476 if (hb && low_free_pages() <= handle->reqd_free_pages) {
477 error = hib_wait_io(hb);
481 * Recalculate the number of required free pages, to
482 * make sure we never take more than half.
484 handle->reqd_free_pages = reqd_free_pages();
491 static int flush_swap_writer(struct swap_map_handle *handle)
493 if (handle->cur && handle->cur_swap)
494 return write_page(handle->cur, handle->cur_swap, NULL);
499 static int swap_writer_finish(struct swap_map_handle *handle,
500 unsigned int flags, int error)
503 flush_swap_writer(handle);
505 error = mark_swapfiles(handle, flags);
510 free_all_swap_pages(root_swap);
511 release_swap_writer(handle);
512 swsusp_close(FMODE_WRITE);
517 /* We need to remember how much compressed data we need to read. */
518 #define LZO_HEADER sizeof(size_t)
520 /* Number of pages/bytes we'll compress at one time. */
521 #define LZO_UNC_PAGES 32
522 #define LZO_UNC_SIZE (LZO_UNC_PAGES * PAGE_SIZE)
524 /* Number of pages/bytes we need for compressed data (worst case). */
525 #define LZO_CMP_PAGES DIV_ROUND_UP(lzo1x_worst_compress(LZO_UNC_SIZE) + \
526 LZO_HEADER, PAGE_SIZE)
527 #define LZO_CMP_SIZE (LZO_CMP_PAGES * PAGE_SIZE)
529 /* Maximum number of threads for compression/decompression. */
530 #define LZO_THREADS 3
532 /* Minimum/maximum number of pages for read buffering. */
533 #define LZO_MIN_RD_PAGES 1024
534 #define LZO_MAX_RD_PAGES 8192
538 * save_image - save the suspend image data
541 static int save_image(struct swap_map_handle *handle,
542 struct snapshot_handle *snapshot,
543 unsigned int nr_to_write)
549 struct hib_bio_batch hb;
555 pr_info("Saving image data pages (%u pages)...\n",
557 m = nr_to_write / 10;
563 ret = snapshot_read_next(snapshot);
566 ret = swap_write_page(handle, data_of(*snapshot), &hb);
570 pr_info("Image saving progress: %3d%%\n",
574 err2 = hib_wait_io(&hb);
575 hib_finish_batch(&hb);
580 pr_info("Image saving done\n");
581 swsusp_show_speed(start, stop, nr_to_write, "Wrote");
586 * Structure used for CRC32.
589 struct task_struct *thr; /* thread */
590 atomic_t ready; /* ready to start flag */
591 atomic_t stop; /* ready to stop flag */
592 unsigned run_threads; /* nr current threads */
593 wait_queue_head_t go; /* start crc update */
594 wait_queue_head_t done; /* crc update done */
595 u32 *crc32; /* points to handle's crc32 */
596 size_t *unc_len[LZO_THREADS]; /* uncompressed lengths */
597 unsigned char *unc[LZO_THREADS]; /* uncompressed data */
601 * CRC32 update function that runs in its own thread.
603 static int crc32_threadfn(void *data)
605 struct crc_data *d = data;
609 wait_event(d->go, atomic_read(&d->ready) ||
610 kthread_should_stop());
611 if (kthread_should_stop()) {
613 atomic_set(&d->stop, 1);
617 atomic_set(&d->ready, 0);
619 for (i = 0; i < d->run_threads; i++)
620 *d->crc32 = crc32_le(*d->crc32,
621 d->unc[i], *d->unc_len[i]);
622 atomic_set(&d->stop, 1);
628 * Structure used for LZO data compression.
631 struct task_struct *thr; /* thread */
632 atomic_t ready; /* ready to start flag */
633 atomic_t stop; /* ready to stop flag */
634 int ret; /* return code */
635 wait_queue_head_t go; /* start compression */
636 wait_queue_head_t done; /* compression done */
637 size_t unc_len; /* uncompressed length */
638 size_t cmp_len; /* compressed length */
639 unsigned char unc[LZO_UNC_SIZE]; /* uncompressed buffer */
640 unsigned char cmp[LZO_CMP_SIZE]; /* compressed buffer */
641 unsigned char wrk[LZO1X_1_MEM_COMPRESS]; /* compression workspace */
645 * Compression function that runs in its own thread.
647 static int lzo_compress_threadfn(void *data)
649 struct cmp_data *d = data;
652 wait_event(d->go, atomic_read(&d->ready) ||
653 kthread_should_stop());
654 if (kthread_should_stop()) {
657 atomic_set(&d->stop, 1);
661 atomic_set(&d->ready, 0);
663 d->ret = lzo1x_1_compress(d->unc, d->unc_len,
664 d->cmp + LZO_HEADER, &d->cmp_len,
666 atomic_set(&d->stop, 1);
673 * save_image_lzo - Save the suspend image data compressed with LZO.
674 * @handle: Swap map handle to use for saving the image.
675 * @snapshot: Image to read data from.
676 * @nr_to_write: Number of pages to save.
678 static int save_image_lzo(struct swap_map_handle *handle,
679 struct snapshot_handle *snapshot,
680 unsigned int nr_to_write)
686 struct hib_bio_batch hb;
690 unsigned thr, run_threads, nr_threads;
691 unsigned char *page = NULL;
692 struct cmp_data *data = NULL;
693 struct crc_data *crc = NULL;
698 * We'll limit the number of threads for compression to limit memory
701 nr_threads = num_online_cpus() - 1;
702 nr_threads = clamp_val(nr_threads, 1, LZO_THREADS);
704 page = (void *)__get_free_page(GFP_NOIO | __GFP_HIGH);
706 pr_err("Failed to allocate LZO page\n");
711 data = vmalloc(array_size(nr_threads, sizeof(*data)));
713 pr_err("Failed to allocate LZO data\n");
717 for (thr = 0; thr < nr_threads; thr++)
718 memset(&data[thr], 0, offsetof(struct cmp_data, go));
720 crc = kmalloc(sizeof(*crc), GFP_KERNEL);
722 pr_err("Failed to allocate crc\n");
726 memset(crc, 0, offsetof(struct crc_data, go));
729 * Start the compression threads.
731 for (thr = 0; thr < nr_threads; thr++) {
732 init_waitqueue_head(&data[thr].go);
733 init_waitqueue_head(&data[thr].done);
735 data[thr].thr = kthread_run(lzo_compress_threadfn,
737 "image_compress/%u", thr);
738 if (IS_ERR(data[thr].thr)) {
739 data[thr].thr = NULL;
740 pr_err("Cannot start compression threads\n");
747 * Start the CRC32 thread.
749 init_waitqueue_head(&crc->go);
750 init_waitqueue_head(&crc->done);
753 crc->crc32 = &handle->crc32;
754 for (thr = 0; thr < nr_threads; thr++) {
755 crc->unc[thr] = data[thr].unc;
756 crc->unc_len[thr] = &data[thr].unc_len;
759 crc->thr = kthread_run(crc32_threadfn, crc, "image_crc32");
760 if (IS_ERR(crc->thr)) {
762 pr_err("Cannot start CRC32 thread\n");
768 * Adjust the number of required free pages after all allocations have
769 * been done. We don't want to run out of pages when writing.
771 handle->reqd_free_pages = reqd_free_pages();
773 pr_info("Using %u thread(s) for compression\n", nr_threads);
774 pr_info("Compressing and saving image data (%u pages)...\n",
776 m = nr_to_write / 10;
782 for (thr = 0; thr < nr_threads; thr++) {
783 for (off = 0; off < LZO_UNC_SIZE; off += PAGE_SIZE) {
784 ret = snapshot_read_next(snapshot);
791 memcpy(data[thr].unc + off,
792 data_of(*snapshot), PAGE_SIZE);
795 pr_info("Image saving progress: %3d%%\n",
802 data[thr].unc_len = off;
804 atomic_set(&data[thr].ready, 1);
805 wake_up(&data[thr].go);
811 crc->run_threads = thr;
812 atomic_set(&crc->ready, 1);
815 for (run_threads = thr, thr = 0; thr < run_threads; thr++) {
816 wait_event(data[thr].done,
817 atomic_read(&data[thr].stop));
818 atomic_set(&data[thr].stop, 0);
823 pr_err("LZO compression failed\n");
827 if (unlikely(!data[thr].cmp_len ||
829 lzo1x_worst_compress(data[thr].unc_len))) {
830 pr_err("Invalid LZO compressed length\n");
835 *(size_t *)data[thr].cmp = data[thr].cmp_len;
838 * Given we are writing one page at a time to disk, we
839 * copy that much from the buffer, although the last
840 * bit will likely be smaller than full page. This is
841 * OK - we saved the length of the compressed data, so
842 * any garbage at the end will be discarded when we
846 off < LZO_HEADER + data[thr].cmp_len;
848 memcpy(page, data[thr].cmp + off, PAGE_SIZE);
850 ret = swap_write_page(handle, page, &hb);
856 wait_event(crc->done, atomic_read(&crc->stop));
857 atomic_set(&crc->stop, 0);
861 err2 = hib_wait_io(&hb);
866 pr_info("Image saving done\n");
867 swsusp_show_speed(start, stop, nr_to_write, "Wrote");
869 hib_finish_batch(&hb);
872 kthread_stop(crc->thr);
876 for (thr = 0; thr < nr_threads; thr++)
878 kthread_stop(data[thr].thr);
881 if (page) free_page((unsigned long)page);
887 * enough_swap - Make sure we have enough swap to save the image.
889 * Returns TRUE or FALSE after checking the total amount of swap
890 * space avaiable from the resume partition.
893 static int enough_swap(unsigned int nr_pages)
895 unsigned int free_swap = count_swap_pages(root_swap, 1);
896 unsigned int required;
898 pr_debug("Free swap pages: %u\n", free_swap);
900 required = PAGES_FOR_IO + nr_pages;
901 return free_swap > required;
905 * swsusp_write - Write entire image and metadata.
906 * @flags: flags to pass to the "boot" kernel in the image header
908 * It is important _NOT_ to umount filesystems at this point. We want
909 * them synced (in case something goes wrong) but we DO not want to mark
910 * filesystem clean: it is not. (And it does not matter, if we resume
911 * correctly, we'll mark system clean, anyway.)
914 int swsusp_write(unsigned int flags)
916 struct swap_map_handle handle;
917 struct snapshot_handle snapshot;
918 struct swsusp_info *header;
922 pages = snapshot_get_image_size();
923 error = get_swap_writer(&handle);
925 pr_err("Cannot get swap writer\n");
928 if (flags & SF_NOCOMPRESS_MODE) {
929 if (!enough_swap(pages)) {
930 pr_err("Not enough free swap\n");
935 memset(&snapshot, 0, sizeof(struct snapshot_handle));
936 error = snapshot_read_next(&snapshot);
937 if (error < (int)PAGE_SIZE) {
943 header = (struct swsusp_info *)data_of(snapshot);
944 error = swap_write_page(&handle, header, NULL);
946 error = (flags & SF_NOCOMPRESS_MODE) ?
947 save_image(&handle, &snapshot, pages - 1) :
948 save_image_lzo(&handle, &snapshot, pages - 1);
951 error = swap_writer_finish(&handle, flags, error);
956 * The following functions allow us to read data using a swap map
957 * in a file-alike way
960 static void release_swap_reader(struct swap_map_handle *handle)
962 struct swap_map_page_list *tmp;
964 while (handle->maps) {
965 if (handle->maps->map)
966 free_page((unsigned long)handle->maps->map);
968 handle->maps = handle->maps->next;
974 static int get_swap_reader(struct swap_map_handle *handle,
975 unsigned int *flags_p)
978 struct swap_map_page_list *tmp, *last;
981 *flags_p = swsusp_header->flags;
983 if (!swsusp_header->image) /* how can this happen? */
987 last = handle->maps = NULL;
988 offset = swsusp_header->image;
990 tmp = kzalloc(sizeof(*handle->maps), GFP_KERNEL);
992 release_swap_reader(handle);
1001 tmp->map = (struct swap_map_page *)
1002 __get_free_page(GFP_NOIO | __GFP_HIGH);
1004 release_swap_reader(handle);
1008 error = hib_submit_io(REQ_OP_READ, 0, offset, tmp->map, NULL);
1010 release_swap_reader(handle);
1013 offset = tmp->map->next_swap;
1016 handle->cur = handle->maps->map;
1020 static int swap_read_page(struct swap_map_handle *handle, void *buf,
1021 struct hib_bio_batch *hb)
1025 struct swap_map_page_list *tmp;
1029 offset = handle->cur->entries[handle->k];
1032 error = hib_submit_io(REQ_OP_READ, 0, offset, buf, hb);
1035 if (++handle->k >= MAP_PAGE_ENTRIES) {
1037 free_page((unsigned long)handle->maps->map);
1039 handle->maps = handle->maps->next;
1042 release_swap_reader(handle);
1044 handle->cur = handle->maps->map;
1049 static int swap_reader_finish(struct swap_map_handle *handle)
1051 release_swap_reader(handle);
1057 * load_image - load the image using the swap map handle
1058 * @handle and the snapshot handle @snapshot
1059 * (assume there are @nr_pages pages to load)
1062 static int load_image(struct swap_map_handle *handle,
1063 struct snapshot_handle *snapshot,
1064 unsigned int nr_to_read)
1070 struct hib_bio_batch hb;
1074 hib_init_batch(&hb);
1076 clean_pages_on_read = true;
1077 pr_info("Loading image data pages (%u pages)...\n", nr_to_read);
1078 m = nr_to_read / 10;
1082 start = ktime_get();
1084 ret = snapshot_write_next(snapshot);
1087 ret = swap_read_page(handle, data_of(*snapshot), &hb);
1090 if (snapshot->sync_read)
1091 ret = hib_wait_io(&hb);
1094 if (!(nr_pages % m))
1095 pr_info("Image loading progress: %3d%%\n",
1099 err2 = hib_wait_io(&hb);
1100 hib_finish_batch(&hb);
1105 pr_info("Image loading done\n");
1106 snapshot_write_finalize(snapshot);
1107 if (!snapshot_image_loaded(snapshot))
1110 swsusp_show_speed(start, stop, nr_to_read, "Read");
1115 * Structure used for LZO data decompression.
1118 struct task_struct *thr; /* thread */
1119 atomic_t ready; /* ready to start flag */
1120 atomic_t stop; /* ready to stop flag */
1121 int ret; /* return code */
1122 wait_queue_head_t go; /* start decompression */
1123 wait_queue_head_t done; /* decompression done */
1124 size_t unc_len; /* uncompressed length */
1125 size_t cmp_len; /* compressed length */
1126 unsigned char unc[LZO_UNC_SIZE]; /* uncompressed buffer */
1127 unsigned char cmp[LZO_CMP_SIZE]; /* compressed buffer */
1131 * Deompression function that runs in its own thread.
1133 static int lzo_decompress_threadfn(void *data)
1135 struct dec_data *d = data;
1138 wait_event(d->go, atomic_read(&d->ready) ||
1139 kthread_should_stop());
1140 if (kthread_should_stop()) {
1143 atomic_set(&d->stop, 1);
1147 atomic_set(&d->ready, 0);
1149 d->unc_len = LZO_UNC_SIZE;
1150 d->ret = lzo1x_decompress_safe(d->cmp + LZO_HEADER, d->cmp_len,
1151 d->unc, &d->unc_len);
1152 if (clean_pages_on_decompress)
1153 flush_icache_range((unsigned long)d->unc,
1154 (unsigned long)d->unc + d->unc_len);
1156 atomic_set(&d->stop, 1);
1163 * load_image_lzo - Load compressed image data and decompress them with LZO.
1164 * @handle: Swap map handle to use for loading data.
1165 * @snapshot: Image to copy uncompressed data into.
1166 * @nr_to_read: Number of pages to load.
1168 static int load_image_lzo(struct swap_map_handle *handle,
1169 struct snapshot_handle *snapshot,
1170 unsigned int nr_to_read)
1175 struct hib_bio_batch hb;
1180 unsigned i, thr, run_threads, nr_threads;
1181 unsigned ring = 0, pg = 0, ring_size = 0,
1182 have = 0, want, need, asked = 0;
1183 unsigned long read_pages = 0;
1184 unsigned char **page = NULL;
1185 struct dec_data *data = NULL;
1186 struct crc_data *crc = NULL;
1188 hib_init_batch(&hb);
1191 * We'll limit the number of threads for decompression to limit memory
1194 nr_threads = num_online_cpus() - 1;
1195 nr_threads = clamp_val(nr_threads, 1, LZO_THREADS);
1197 page = vmalloc(array_size(LZO_MAX_RD_PAGES, sizeof(*page)));
1199 pr_err("Failed to allocate LZO page\n");
1204 data = vmalloc(array_size(nr_threads, sizeof(*data)));
1206 pr_err("Failed to allocate LZO data\n");
1210 for (thr = 0; thr < nr_threads; thr++)
1211 memset(&data[thr], 0, offsetof(struct dec_data, go));
1213 crc = kmalloc(sizeof(*crc), GFP_KERNEL);
1215 pr_err("Failed to allocate crc\n");
1219 memset(crc, 0, offsetof(struct crc_data, go));
1221 clean_pages_on_decompress = true;
1224 * Start the decompression threads.
1226 for (thr = 0; thr < nr_threads; thr++) {
1227 init_waitqueue_head(&data[thr].go);
1228 init_waitqueue_head(&data[thr].done);
1230 data[thr].thr = kthread_run(lzo_decompress_threadfn,
1232 "image_decompress/%u", thr);
1233 if (IS_ERR(data[thr].thr)) {
1234 data[thr].thr = NULL;
1235 pr_err("Cannot start decompression threads\n");
1242 * Start the CRC32 thread.
1244 init_waitqueue_head(&crc->go);
1245 init_waitqueue_head(&crc->done);
1248 crc->crc32 = &handle->crc32;
1249 for (thr = 0; thr < nr_threads; thr++) {
1250 crc->unc[thr] = data[thr].unc;
1251 crc->unc_len[thr] = &data[thr].unc_len;
1254 crc->thr = kthread_run(crc32_threadfn, crc, "image_crc32");
1255 if (IS_ERR(crc->thr)) {
1257 pr_err("Cannot start CRC32 thread\n");
1263 * Set the number of pages for read buffering.
1264 * This is complete guesswork, because we'll only know the real
1265 * picture once prepare_image() is called, which is much later on
1266 * during the image load phase. We'll assume the worst case and
1267 * say that none of the image pages are from high memory.
1269 if (low_free_pages() > snapshot_get_image_size())
1270 read_pages = (low_free_pages() - snapshot_get_image_size()) / 2;
1271 read_pages = clamp_val(read_pages, LZO_MIN_RD_PAGES, LZO_MAX_RD_PAGES);
1273 for (i = 0; i < read_pages; i++) {
1274 page[i] = (void *)__get_free_page(i < LZO_CMP_PAGES ?
1275 GFP_NOIO | __GFP_HIGH :
1276 GFP_NOIO | __GFP_NOWARN |
1280 if (i < LZO_CMP_PAGES) {
1282 pr_err("Failed to allocate LZO pages\n");
1290 want = ring_size = i;
1292 pr_info("Using %u thread(s) for decompression\n", nr_threads);
1293 pr_info("Loading and decompressing image data (%u pages)...\n",
1295 m = nr_to_read / 10;
1299 start = ktime_get();
1301 ret = snapshot_write_next(snapshot);
1306 for (i = 0; !eof && i < want; i++) {
1307 ret = swap_read_page(handle, page[ring], &hb);
1310 * On real read error, finish. On end of data,
1311 * set EOF flag and just exit the read loop.
1314 handle->cur->entries[handle->k]) {
1321 if (++ring >= ring_size)
1328 * We are out of data, wait for some more.
1334 ret = hib_wait_io(&hb);
1343 if (crc->run_threads) {
1344 wait_event(crc->done, atomic_read(&crc->stop));
1345 atomic_set(&crc->stop, 0);
1346 crc->run_threads = 0;
1349 for (thr = 0; have && thr < nr_threads; thr++) {
1350 data[thr].cmp_len = *(size_t *)page[pg];
1351 if (unlikely(!data[thr].cmp_len ||
1353 lzo1x_worst_compress(LZO_UNC_SIZE))) {
1354 pr_err("Invalid LZO compressed length\n");
1359 need = DIV_ROUND_UP(data[thr].cmp_len + LZO_HEADER,
1370 off < LZO_HEADER + data[thr].cmp_len;
1372 memcpy(data[thr].cmp + off,
1373 page[pg], PAGE_SIZE);
1376 if (++pg >= ring_size)
1380 atomic_set(&data[thr].ready, 1);
1381 wake_up(&data[thr].go);
1385 * Wait for more data while we are decompressing.
1387 if (have < LZO_CMP_PAGES && asked) {
1388 ret = hib_wait_io(&hb);
1397 for (run_threads = thr, thr = 0; thr < run_threads; thr++) {
1398 wait_event(data[thr].done,
1399 atomic_read(&data[thr].stop));
1400 atomic_set(&data[thr].stop, 0);
1402 ret = data[thr].ret;
1405 pr_err("LZO decompression failed\n");
1409 if (unlikely(!data[thr].unc_len ||
1410 data[thr].unc_len > LZO_UNC_SIZE ||
1411 data[thr].unc_len & (PAGE_SIZE - 1))) {
1412 pr_err("Invalid LZO uncompressed length\n");
1418 off < data[thr].unc_len; off += PAGE_SIZE) {
1419 memcpy(data_of(*snapshot),
1420 data[thr].unc + off, PAGE_SIZE);
1422 if (!(nr_pages % m))
1423 pr_info("Image loading progress: %3d%%\n",
1427 ret = snapshot_write_next(snapshot);
1429 crc->run_threads = thr + 1;
1430 atomic_set(&crc->ready, 1);
1437 crc->run_threads = thr;
1438 atomic_set(&crc->ready, 1);
1443 if (crc->run_threads) {
1444 wait_event(crc->done, atomic_read(&crc->stop));
1445 atomic_set(&crc->stop, 0);
1449 pr_info("Image loading done\n");
1450 snapshot_write_finalize(snapshot);
1451 if (!snapshot_image_loaded(snapshot))
1454 if (swsusp_header->flags & SF_CRC32_MODE) {
1455 if(handle->crc32 != swsusp_header->crc32) {
1456 pr_err("Invalid image CRC32!\n");
1462 swsusp_show_speed(start, stop, nr_to_read, "Read");
1464 hib_finish_batch(&hb);
1465 for (i = 0; i < ring_size; i++)
1466 free_page((unsigned long)page[i]);
1469 kthread_stop(crc->thr);
1473 for (thr = 0; thr < nr_threads; thr++)
1475 kthread_stop(data[thr].thr);
1484 * swsusp_read - read the hibernation image.
1485 * @flags_p: flags passed by the "frozen" kernel in the image header should
1486 * be written into this memory location
1489 int swsusp_read(unsigned int *flags_p)
1492 struct swap_map_handle handle;
1493 struct snapshot_handle snapshot;
1494 struct swsusp_info *header;
1496 memset(&snapshot, 0, sizeof(struct snapshot_handle));
1497 error = snapshot_write_next(&snapshot);
1498 if (error < (int)PAGE_SIZE)
1499 return error < 0 ? error : -EFAULT;
1500 header = (struct swsusp_info *)data_of(snapshot);
1501 error = get_swap_reader(&handle, flags_p);
1505 error = swap_read_page(&handle, header, NULL);
1507 error = (*flags_p & SF_NOCOMPRESS_MODE) ?
1508 load_image(&handle, &snapshot, header->pages - 1) :
1509 load_image_lzo(&handle, &snapshot, header->pages - 1);
1511 swap_reader_finish(&handle);
1514 pr_debug("Image successfully loaded\n");
1516 pr_debug("Error %d resuming\n", error);
1521 * swsusp_check - Check for swsusp signature in the resume device
1524 int swsusp_check(void)
1528 hib_resume_bdev = blkdev_get_by_dev(swsusp_resume_device,
1530 if (!IS_ERR(hib_resume_bdev)) {
1531 set_blocksize(hib_resume_bdev, PAGE_SIZE);
1532 clear_page(swsusp_header);
1533 error = hib_submit_io(REQ_OP_READ, 0,
1534 swsusp_resume_block,
1535 swsusp_header, NULL);
1539 if (!memcmp(HIBERNATE_SIG, swsusp_header->sig, 10)) {
1540 memcpy(swsusp_header->sig, swsusp_header->orig_sig, 10);
1541 /* Reset swap signature now */
1542 error = hib_submit_io(REQ_OP_WRITE, REQ_SYNC,
1543 swsusp_resume_block,
1544 swsusp_header, NULL);
1551 blkdev_put(hib_resume_bdev, FMODE_READ);
1553 pr_debug("Image signature found, resuming\n");
1555 error = PTR_ERR(hib_resume_bdev);
1559 pr_debug("Image not found (code %d)\n", error);
1565 * swsusp_close - close swap device.
1568 void swsusp_close(fmode_t mode)
1570 if (IS_ERR(hib_resume_bdev)) {
1571 pr_debug("Image device not initialised\n");
1575 blkdev_put(hib_resume_bdev, mode);
1579 * swsusp_unmark - Unmark swsusp signature in the resume device
1582 #ifdef CONFIG_SUSPEND
1583 int swsusp_unmark(void)
1587 hib_submit_io(REQ_OP_READ, 0, swsusp_resume_block,
1588 swsusp_header, NULL);
1589 if (!memcmp(HIBERNATE_SIG,swsusp_header->sig, 10)) {
1590 memcpy(swsusp_header->sig,swsusp_header->orig_sig, 10);
1591 error = hib_submit_io(REQ_OP_WRITE, REQ_SYNC,
1592 swsusp_resume_block,
1593 swsusp_header, NULL);
1595 pr_err("Cannot find swsusp signature!\n");
1600 * We just returned from suspend, we don't need the image any more.
1602 free_all_swap_pages(root_swap);
1608 static int __init swsusp_header_init(void)
1610 swsusp_header = (struct swsusp_header*) __get_free_page(GFP_KERNEL);
1612 panic("Could not allocate memory for swsusp_header\n");
1616 core_initcall(swsusp_header_init);