usr/src/man/man3c/mlockall.3c

   1 '\" te
   2 .\" Copyright 1989 AT&T.  Copyright (c) 2004, Sun Microsystems, Inc.  All Rights Reserved.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH MLOCKALL 3C "Mar 22, 2004"
   7 .SH NAME
   8 mlockall, munlockall \- lock or unlock address space
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/mman.h>
  13
  14 \fBint\fR \fBmlockall\fR(\fBint\fR \fIflags\fR);
  15 .fi
  16
  17 .LP
  18 .nf
  19 \fBint\fR \fBmunlockall\fR(\fBvoid\fR);
  20 .fi
  21
  22 .SH DESCRIPTION
  23 .sp
  24 .LP
  25 The \fBmlockall()\fR function locks in memory all pages mapped by an address
  26 space.
  27 .sp
  28 .LP
  29 The value of \fIflags\fR determines whether the pages to be locked are those
  30 currently mapped by the address space, those that will be mapped in the future,
  31 or both:
  32 .sp
  33 .in +2
  34 .nf
  35        \fBMCL_CURRENT\fR  Lock current mappings
  36        \fBMCL_FUTURE\fR   Lock future mappings
  37 .fi
  38 .in -2
  39
  40 .sp
  41 .LP
  42 If \fBMCL_FUTURE\fR is specified for \fBmlockall()\fR, mappings are locked as
  43 they are added to the address space (or replace existing mappings), provided
  44 sufficient memory is available. Locking in this manner is not persistent across
  45 the \fBexec\fR family of functions (see \fBexec\fR(2)).
  46 .sp
  47 .LP
  48 Mappings locked using \fBmlockall()\fR with any option may be explicitly
  49 unlocked with a \fBmunlock()\fR call (see \fBmlock\fR(3C)).
  50 .sp
  51 .LP
  52 The  \fBmunlockall()\fR function removes address space locks and locks on
  53 mappings in the address space.
  54 .sp
  55 .LP
  56 All conditions and constraints on the use of locked memory that apply to
  57 \fBmlock\fR(3C) also apply to \fBmlockall()\fR.
  58 .sp
  59 .LP
  60 Locks established with \fBmlockall()\fR are not inherited by a child process
  61 after a  \fBfork\fR(2) call, and are not nested.
  62 .SH RETURN VALUES
  63 .sp
  64 .LP
  65 Upon successful completion, the  \fBmlockall()\fR and  \fBmunlockall()\fR
  66 functions return \fB0\fR.  Otherwise, they return  \fB\(mi1\fR and set
  67 \fBerrno\fR to indicate the error.
  68 .SH ERRORS
  69 .sp
  70 .LP
  71 The \fBmlockall()\fR and \fBmunlockall()\fR functions will fail if:
  72 .sp
  73 .ne 2
  74 .na
  75 \fB\fBEAGAIN\fR\fR
  76 .ad
  77 .RS 10n
  78 Some or all of the memory in the address space could not be locked due to
  79 sufficient resources. This error condition applies to \fBmlockall()\fR only.
  80 .RE
  81
  82 .sp
  83 .ne 2
  84 .na
  85 \fB\fBEINVAL\fR\fR
  86 .ad
  87 .RS 10n
  88 The \fIflags\fR argument contains values other than \fBMCL_CURRENT\fR and
  89 \fBMCL_FUTURE\fR.
  90 .RE
  91
  92 .sp
  93 .ne 2
  94 .na
  95 \fB\fBEPERM\fR\fR
  96 .ad
  97 .RS 10n
  98 The {\fBPRIV_PROC_LOCK_MEMORY\fR} privilege is not asserted in the effective
  99 set of the calling process.
 100 .RE
 101
 102 .SH ATTRIBUTES
 103 .sp
 104 .LP
 105 See \fBattributes\fR(5) for descriptions of the following attributes:
 106 .sp
 107
 108 .sp
 109 .TS
 110 box;
 111 c | c
 112 l | l .
 113 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 114 _
 115 Interface Stability     Standard
 116 _
 117 MT-Level        MT-Safe
 118 .TE
 119
 120 .SH SEE ALSO
 121 .sp
 122 .LP
 123 \fBexec\fR(2), \fBfork\fR(2), \fBmemcntl\fR(2), \fBmmap\fR(2), \fBplock\fR(3C),
 124 \fBmlock\fR(3C), \fBsysconf\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)