lib/libc/sys/mlock.2

   1 .\" Copyright (c) 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 .\"     @(#)mlock.2     8.2 (Berkeley) 12/11/93
  29 .\"
  30 .Dd May 13, 2019
  31 .Dt MLOCK 2
  32 .Os
  33 .Sh NAME
  34 .Nm mlock ,
  35 .Nm munlock
  36 .Nd lock (unlock) physical pages in memory
  37 .Sh LIBRARY
  38 .Lb libc
  39 .Sh SYNOPSIS
  40 .In sys/mman.h
  41 .Ft int
  42 .Fn mlock "const void *addr" "size_t len"
  43 .Ft int
  44 .Fn munlock "const void *addr" "size_t len"
  45 .Sh DESCRIPTION
  46 The
  47 .Fn mlock
  48 system call
  49 locks into memory the physical pages associated with the virtual address
  50 range starting at
  51 .Fa addr
  52 for
  53 .Fa len
  54 bytes.
  55 The
  56 .Fn munlock
  57 system call unlocks pages previously locked by one or more
  58 .Fn mlock
  59 calls.
  60 For both, the
  61 .Fa addr
  62 argument should be aligned to a multiple of the page size.
  63 If the
  64 .Fa len
  65 argument is not a multiple of the page size, it will be rounded up
  66 to be so.
  67 The entire range must be allocated.
  68 .Pp
  69 After an
  70 .Fn mlock
  71 system call, the indicated pages will cause neither a non-resident page
  72 nor address-translation fault until they are unlocked.
  73 They may still cause protection-violation faults or TLB-miss faults on
  74 architectures with software-managed TLBs.
  75 The physical pages remain in memory until all locked mappings for the pages
  76 are removed.
  77 Multiple processes may have the same physical pages locked via their own
  78 virtual address mappings.
  79 A single process may likewise have pages multiply-locked via different virtual
  80 mappings of the same physical pages.
  81 Unlocking is performed explicitly by
  82 .Fn munlock
  83 or implicitly by a call to
  84 .Fn munmap
  85 which deallocates the unmapped address range.
  86 Locked mappings are not inherited by the child process after a
  87 .Xr fork 2 .
  88 .Pp
  89 Since physical memory is a potentially scarce resource, processes are
  90 limited in how much they can lock down.
  91 The amount of memory that a single process can
  92 .Fn mlock
  93 is limited by both the per-process
  94 .Dv RLIMIT_MEMLOCK
  95 resource limit and the
  96 system-wide
  97 .Dq wired pages
  98 limit
  99 .Va vm.max_user_wired .
 100 .Va vm.max_user_wired
 101 applies to the system as a whole, so the amount available to a single
 102 process at any given time is the difference between
 103 .Va vm.max_user_wired
 104 and
 105 .Va vm.stats.vm.v_user_wire_count .
 106 .Pp
 107 If
 108 .Va security.bsd.unprivileged_mlock
 109 is set to 0 these calls are only available to the super-user.
 110 .Sh RETURN VALUES
 111 .Rv -std
 112 .Pp
 113 If the call succeeds, all pages in the range become locked (unlocked);
 114 otherwise the locked status of all pages in the range remains unchanged.
 115 .Sh ERRORS
 116 The
 117 .Fn mlock
 118 system call
 119 will fail if:
 120 .Bl -tag -width Er
 121 .It Bq Er EPERM
 122 .Va security.bsd.unprivileged_mlock
 123 is set to 0 and the caller is not the super-user.
 124 .It Bq Er EINVAL
 125 The address range given wraps around zero.
 126 .It Bq Er ENOMEM
 127 Some portion of the indicated address range is not allocated.
 128 There was an error faulting/mapping a page.
 129 Locking the indicated range would exceed the per-process or system-wide limits
 130 for locked memory.
 131 .El
 132 The
 133 .Fn munlock
 134 system call
 135 will fail if:
 136 .Bl -tag -width Er
 137 .It Bq Er EPERM
 138 .Va security.bsd.unprivileged_mlock
 139 is set to 0 and the caller is not the super-user.
 140 .It Bq Er EINVAL
 141 The address range given wraps around zero.
 142 .It Bq Er ENOMEM
 143 Some or all of the address range specified by the addr and len
 144 arguments does not correspond to valid mapped pages in the address space
 145 of the process.
 146 .It Bq Er ENOMEM
 147 Locking the pages mapped by the specified range would exceed a limit on
 148 the amount of memory that the process may lock.
 149 .El
 150 .Sh "SEE ALSO"
 151 .Xr fork 2 ,
 152 .Xr mincore 2 ,
 153 .Xr minherit 2 ,
 154 .Xr mlockall 2 ,
 155 .Xr mmap 2 ,
 156 .Xr munlockall 2 ,
 157 .Xr munmap 2 ,
 158 .Xr setrlimit 2 ,
 159 .Xr getpagesize 3
 160 .Sh HISTORY
 161 The
 162 .Fn mlock
 163 and
 164 .Fn munlock
 165 system calls first appeared in
 166 .Bx 4.4 .
 167 .Sh BUGS
 168 Allocating too much wired memory can lead to a memory-allocation deadlock
 169 which requires a reboot to recover from.
 170 .Pp
 171 The per-process and system-wide resource limits of locked memory apply
 172 to the amount of virtual memory locked, not the amount of locked physical
 173 pages.
 174 Hence two distinct locked mappings of the same physical page counts as
 175 2 pages aginst the system limit, and also against the per-process limit
 176 if both mappings belong to the same physical map.
 177 .Pp
 178 The per-process resource limit is not currently supported.