Manpage of SWAPON
SWAPONSection: Linux Programmer's Manual (2)
NAMEswapon, swapoff - start/stop swapping to file/device
DESCRIPTIONswapon() sets the swap area to the file or block device specified by path. swapoff() stops swapping to the file or block device specified by path.
SWAP_FLAG_PREFERflag is specified in the
swapflagsargument, the new swap area will have a higher priority than default.
The priority is encoded within
(prio << SWAP_FLAG_PRIO_SHIFT) & SWAP_FLAG_PRIO_MASK
If the SWAP_FLAG_DISCARDflag is specified in the swapon() swapflagsargument, freed swap pages will be discarded before they are reused, if the swap device supports the discard or trim operation. (This may improve performance on some Solid State Devices, but often it does not.) See also NOTES.
PriorityEach swap area has a priority, either high or low. The default priority is low. Within the low-priority areas, newer areas are even lower priority than older areas.
All priorities set with swapflagsare high-priority, higher than default. They may have any nonnegative value chosen by the caller. Higher numbers mean higher priority.
Swap pages are allocated from areas in priority order, highest priority first. For areas with different priorities, a higher-priority area is exhausted before using a lower-priority area. If two or more areas have the same priority, and it is the highest priority available, pages are allocated on a round-robin basis between them.
RETURN VALUEOn success, zero is returned. On error, -1 is returned, and errnois set appropriately.
- (for swapon()) The specified pathis already being used as a swap area.
- The file pathexists, but refers neither to a regular file nor to a block device;
- (swapon()) The indicated path does not contain a valid swap signature or resides on an in-memory filesystem such as tmpfs.
- EINVAL (since Linux 3.4)
- (swapon()) An invalid flag value was specified in flags.
- (swapoff()) pathis not currently a swap area.
- The system-wide limit on the total number of open files has been reached.
- The file pathdoes not exist.
- The system has insufficient memory to start swapping.
- The caller does not have the CAP_SYS_ADMINcapability. Alternatively, the maximum number of swap files are already in use; see NOTES below.
CONFORMING TOThese functions are Linux-specific and should not be used in programs intended to be portable. The second swapflagsargument was introduced in Linux 1.3.2.
NOTESThe partition or path must be prepared with mkswap(8).
There is an upper limit on the number of swap files that may be used, defined by the kernel constant MAX_SWAPFILES. Before kernel 2.4.10, MAX_SWAPFILEShas the value 8; since kernel 2.4.10, it has the value 32. Since kernel 2.6.18, the limit is decreased by 2 (thus: 30) if the kernel is built with the CONFIG_MIGRATIONoption (which reserves two swap table entries for the page migration features of mbind(2) and migrate_pages(2)). Since kernel 2.6.32, the limit is further decreased by 1 if the kernel is built with the CONFIG_MEMORY_FAILUREoption.
Discard of swap pages was introduced in kernel 2.6.29, then made conditional on the SWAP_FLAG_DISCARDflag in kernel 2.6.36, which still discards the entire swap area when swapon() is called, even if that flag bit is not set.
SEE ALSOmkswap(8), swapoff(8), swapon(8)
This document was created by man2html, using the manual pages.
Time: 22:27:43 GMT, June 20, 2016