swsusp-and-swap-files.rst 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. ===============================================
  2. Using swap files with software suspend (swsusp)
  3. ===============================================
  4. (C) 2006 Rafael J. Wysocki <rjw@sisk.pl>
  5. The Linux kernel handles swap files almost in the same way as it handles swap
  6. partitions and there are only two differences between these two types of swap
  7. areas:
  8. (1) swap files need not be contiguous,
  9. (2) the header of a swap file is not in the first block of the partition that
  10. holds it. From the swsusp's point of view (1) is not a problem, because it is
  11. already taken care of by the swap-handling code, but (2) has to be taken into
  12. consideration.
  13. In principle the location of a swap file's header may be determined with the
  14. help of appropriate filesystem driver. Unfortunately, however, it requires the
  15. filesystem holding the swap file to be mounted, and if this filesystem is
  16. journaled, it cannot be mounted during resume from disk. For this reason to
  17. identify a swap file swsusp uses the name of the partition that holds the file
  18. and the offset from the beginning of the partition at which the swap file's
  19. header is located. For convenience, this offset is expressed in <PAGE_SIZE>
  20. units.
  21. In order to use a swap file with swsusp, you need to:
  22. 1) Create the swap file and make it active, eg.::
  23. # dd if=/dev/zero of=<swap_file_path> bs=1024 count=<swap_file_size_in_k>
  24. # mkswap <swap_file_path>
  25. # swapon <swap_file_path>
  26. 2) Use an application that will bmap the swap file with the help of the
  27. FIBMAP ioctl and determine the location of the file's swap header, as the
  28. offset, in <PAGE_SIZE> units, from the beginning of the partition which
  29. holds the swap file.
  30. 3) Add the following parameters to the kernel command line::
  31. resume=<swap_file_partition> resume_offset=<swap_file_offset>
  32. where <swap_file_partition> is the partition on which the swap file is located
  33. and <swap_file_offset> is the offset of the swap header determined by the
  34. application in 2) (of course, this step may be carried out automatically
  35. by the same application that determines the swap file's header offset using the
  36. FIBMAP ioctl)
  37. OR
  38. Use a userland suspend application that will set the partition and offset
  39. with the help of the SNAPSHOT_SET_SWAP_AREA ioctl described in
  40. Documentation/power/userland-swsusp.rst (this is the only method to suspend
  41. to a swap file allowing the resume to be initiated from an initrd or initramfs
  42. image).
  43. Now, swsusp will use the swap file in the same way in which it would use a swap
  44. partition. In particular, the swap file has to be active (ie. be present in
  45. /proc/swaps) so that it can be used for suspending.
  46. Note that if the swap file used for suspending is deleted and recreated,
  47. the location of its header need not be the same as before. Thus every time
  48. this happens the value of the "resume_offset=" kernel command line parameter
  49. has to be updated.