lib/libc/sys/swapon.2

   1 .\" Copyright (c) 1980, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)swapon.2    8.1 (Berkeley) 6/4/93
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd December 8, 2021
  32 .Dt SWAPON 2
  33 .Os
  34 .Sh NAME
  35 .Nm swapon , swapoff
  36 .Nd control devices for interleaved paging/swapping
  37 .Sh LIBRARY
  38 .Lb libc
  39 .Sh SYNOPSIS
  40 .It vm/vm_param.h
  41 .It vm/swap_pager.h
  42 .In unistd.h
  43 .Ft int
  44 .Fn swapon "const char *special"
  45 .Ft int
  46 .Fn swapoff "const char *special" "u_int flags"
  47 .Sh DESCRIPTION
  48 The
  49 .Fn swapon
  50 system call
  51 makes the block device
  52 .Fa special
  53 available to the system for
  54 allocation for paging and swapping.
  55 The names of potentially
  56 available devices are known to the system and defined at system
  57 configuration time.
  58 The size of the swap area on
  59 .Fa special
  60 is calculated at the time the device is first made available
  61 for swapping.
  62 .Pp
  63 The
  64 .Fn swapoff
  65 system call disables paging and swapping on the given device.
  66 All associated swap metadata are deallocated, and the device
  67 is made available for other purposes.
  68 .Pp
  69 The
  70 .Fa special
  71 argument points to the name of the device or file used for swapping.
  72 .The
  73 .Va flags
  74 argument takes the following flags:
  75 .Bl -tag -width SWAPOFF_FORCE
  76 .It Dv SWAPOFF_FORCE
  77 Overrides a very conservative check that prevents swapoff
  78 if the total amount of free memory and remaining swap
  79 devices space might be unsufficient for the system to continue
  80 operating.
  81 .El
  82 .Sh RETURN VALUES
  83 If an error has occurred, a value of -1 is returned and
  84 .Va errno
  85 is set to indicate the error.
  86 .Sh ERRORS
  87 Both
  88 .Fn swapon
  89 and
  90 .Fn swapoff
  91 can fail if:
  92 .Bl -tag -width Er
  93 .It Bq Er ENOTDIR
  94 A component of the path prefix is not a directory.
  95 .It Bq Er ENAMETOOLONG
  96 A component of a pathname exceeded 255 characters,
  97 or an entire path name exceeded 1023 characters.
  98 .It Bq Er ENOENT
  99 The named device does not exist.
 100 .It Bq Er EACCES
 101 Search permission is denied for a component of the path prefix.
 102 .It Bq Er ELOOP
 103 Too many symbolic links were encountered in translating the pathname.
 104 .It Bq Er EPERM
 105 The caller is not the super-user.
 106 .It Bq Er EFAULT
 107 The
 108 .Fa special
 109 argument
 110 points outside the process's allocated address space.
 111 .El
 112 .Pp
 113 Additionally,
 114 .Fn swapon
 115 can fail for the following reasons:
 116 .Bl -tag -width Er
 117 .It Bq Er ENOTBLK
 118 The
 119 .Fa special
 120 argument
 121 is not a block device.
 122 .It Bq Er EBUSY
 123 The device specified by
 124 .Fa special
 125 has already
 126 been made available for swapping
 127 .It Bq Er ENXIO
 128 The major device number of
 129 .Fa special
 130 is out of range (this indicates no device driver exists
 131 for the associated hardware).
 132 .It Bq Er EIO
 133 An I/O error occurred while opening the swap device.
 134 .It Bq Er EINTEGRITY
 135 Corrupted data was detected while reading from the file system to open the
 136 swap device.
 137 .El
 138 .Pp
 139 Lastly,
 140 .Fn swapoff
 141 can fail if:
 142 .Bl -tag -width Er
 143 .It Bq Er EINVAL
 144 The system is not currently swapping to
 145 .Fa special .
 146 .It Bq Er ENOMEM
 147 Not enough virtual memory is available to safely disable
 148 paging and swapping to the given device.
 149 .El
 150 .Sh SEE ALSO
 151 .Xr config 8 ,
 152 .Xr swapon 8 ,
 153 .Xr sysctl 8
 154 .Sh HISTORY
 155 The
 156 .Fn swapon
 157 system call appeared in
 158 .Bx 4.0 .
 159 The
 160 .Fn swapoff
 161 system call appeared in
 162 .Fx 5.0 .