usr/src/man/man2/shmctl.2

   1 '\" te
   2 .\" Copyright (c) 2007, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" Copyright 1989 AT&T
   4 .\" 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.
   5 .\" 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.
   6 .\" 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]
   7 .TH SHMCTL 2 "Apr 10, 2007"
   8 .SH NAME
   9 shmctl \- shared memory control operations
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/types.h>
  14 #include <sys/ipc.h>
  15 #include <sys/shm.h>
  16
  17 \fBint\fR \fBshmctl\fR(\fBint\fR \fIshmid\fR, \fBint\fR \fIcmd\fR, \fBstruct shmid_ds *\fR\fIbuf\fR);
  18 .fi
  19
  20 .SH DESCRIPTION
  21 .sp
  22 .LP
  23 The \fBshmctl()\fR function provides a variety of shared memory control
  24 operations as specified by \fIcmd\fR. The permission required for a shared
  25 memory control operation is given as {\fItoken\fR}, where \fItoken\fR is the
  26 type of permission needed. The types of permission are interpreted as follows:
  27 .sp
  28 .in +2
  29 .nf
  30 00400    READ by user
  31 00200    WRITE by user
  32 00040    READ by group
  33 00020    WRITE by group
  34 00004    READ by others
  35 00002    WRITE by others
  36 .fi
  37 .in -2
  38
  39 .sp
  40 .LP
  41 See the \fIShared Memory Operation Permissions\fR section of \fBIntro\fR(2) for
  42 more information.
  43 .sp
  44 .LP
  45 The following operations require the specified tokens:
  46 .sp
  47 .ne 2
  48 .na
  49 \fB\fBIPC_STAT\fR\fR
  50 .ad
  51 .RS 14n
  52 Place the current value of each member of the data structure associated with
  53 \fIshmid\fR into the structure pointed to by \fIbuf\fR. The contents of this
  54 structure are defined in \fBIntro\fR(2). {\fBREAD\fR}
  55 .RE
  56
  57 .sp
  58 .ne 2
  59 .na
  60 \fB\fBIPC_SET\fR\fR
  61 .ad
  62 .RS 14n
  63 Set the value of the following members of the data structure associated with
  64 \fIshmid\fR to the corresponding value found in the structure pointed to by
  65 \fIbuf\fR:
  66 .sp
  67 .in +2
  68 .nf
  69 shm_perm.uid
  70 shm_perm.gid
  71 shm_perm.mode   /* access permission bits only */
  72 .fi
  73 .in -2
  74
  75 This command can be executed only by a process that has appropriate privileges
  76 or an effective user \fBID\fR equal to the value of \fBshm_perm.cuid\fR or
  77 \fBshm_perm.uid\fR in the data structure associated with \fIshmid\fR.
  78 .RE
  79
  80 .sp
  81 .ne 2
  82 .na
  83 \fB\fBIPC_RMID\fR\fR
  84 .ad
  85 .RS 14n
  86 Remove the shared memory identifier specified by \fIshmid\fR from the system.
  87 The segment referenced by the identifier will be destroyed when all processes
  88 with the segment attached have either detached the segment or exited. If the
  89 segment is not attached to any process when \fBIPC_RMID\fR is invoked, it will
  90 be destroyed immediately. This command can be executed only by a process that
  91 has appropriate privileges or an effective user ID equal to the value of
  92 \fBshm_perm.cuid\fR or \fBshm_perm.uid\fR in the data structure associated with
  93 \fIshmid\fR.
  94 .RE
  95
  96 .sp
  97 .ne 2
  98 .na
  99 \fB\fBSHM_LOCK\fR\fR
 100 .ad
 101 .RS 14n
 102 Lock the shared memory segment specified by \fIshmid\fR in memory. This command
 103 can be executed only by a process that has appropriate privileges.
 104 .RE
 105
 106 .sp
 107 .ne 2
 108 .na
 109 \fB\fBSHM_UNLOCK\fR\fR
 110 .ad
 111 .RS 14n
 112 Unlock the shared memory segment specified by \fIshmid\fR. This command can be
 113 executed only by a process that has appropriate privileges.
 114 .RE
 115
 116 .sp
 117 .LP
 118 A shared memory segment must be explicitly removed using \fBIPC_RMID\fR before
 119 the system can deallocate it and the resources it uses.
 120 .SH RETURN VALUES
 121 .sp
 122 .LP
 123 Upon successful completion, \fB0\fR is returned. Otherwise, \fB\(mi1\fR is
 124 returned and \fBerrno\fR is set to indicate the error.
 125 .SH ERRORS
 126 .sp
 127 .LP
 128 The \fBshmctl()\fR function will fail if:
 129 .sp
 130 .ne 2
 131 .na
 132 \fB\fBEACCES\fR\fR
 133 .ad
 134 .RS 13n
 135 The \fIcmd\fR argument is equal to \fBIPC_STAT\fR and \fB{READ}\fR operation
 136 permission is denied to the calling process.
 137 .RE
 138
 139 .sp
 140 .ne 2
 141 .na
 142 \fB\fBEFAULT\fR\fR
 143 .ad
 144 .RS 13n
 145 The \fIbuf\fR argument points to an illegal address.
 146 .RE
 147
 148 .sp
 149 .ne 2
 150 .na
 151 \fB\fBEINVAL\fR\fR
 152 .ad
 153 .RS 13n
 154 The \fIshmid\fR argument is not a valid shared memory identifier; or the
 155 \fIcmd\fR argument is not a valid command or is \fBIPC_SET\fR and
 156 \fBshm_perm.uid\fR or \fBshm_perm.gid\fR is not valid.
 157 .RE
 158
 159 .sp
 160 .ne 2
 161 .na
 162 \fB\fBENOMEM\fR\fR
 163 .ad
 164 .RS 13n
 165 The \fIcmd\fR argument is equal to \fBSHM_LOCK\fR and there is not enough
 166 memory, or the operation would exceed a limit or resource control on locked
 167 memory.
 168 .RE
 169
 170 .sp
 171 .ne 2
 172 .na
 173 \fB\fBEOVERFLOW\fR\fR
 174 .ad
 175 .RS 13n
 176 The \fIcmd\fR argument is \fBIPC_STAT\fR and \fIuid\fR or \fIgid\fR is too
 177 large to be stored in the structure pointed to by \fIbuf\fR.
 178 .RE
 179
 180 .sp
 181 .ne 2
 182 .na
 183 \fB\fBEPERM\fR\fR
 184 .ad
 185 .RS 13n
 186 The \fIcmd\fR argument is equal to \fBIPC_RMID\fR or \fBIPC_SET\fR, the
 187 effective user ID of the calling process is not equal to the value of
 188 \fBshm_perm.cuid\fR or \fBshm_perm.uid\fR in the data structure associated with
 189 \fIshmid\fR, and {\fBPRIV_IPC_OWNER\fR} is not asserted in the effective set of
 190 the calling process.
 191 .sp
 192 The \fIcmd\fR argument is equal to \fBSHM_LOCK\fR or \fBSHM_UNLOCK\fR and
 193 {\fBPRIV_PROC_LOCK_MEMORY\fR} is not asserted in the effective set of the
 194 calling process.
 195 .RE
 196
 197 .SH ATTRIBUTES
 198 .sp
 199 .LP
 200 See \fBattributes\fR(5) for descriptions of the following attributes:
 201 .sp
 202
 203 .sp
 204 .TS
 205 box;
 206 c | c
 207 l | l .
 208 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 209 _
 210 Interface Stability     Standard
 211 .TE
 212
 213 .SH SEE ALSO
 214 .sp
 215 .LP
 216 \fBipcs\fR(1), \fBIntro\fR(2), \fBshmget\fR(2), \fBshmop\fR(2),
 217 \fBattributes\fR(5), \fBprivileges\fR(5), \fBstandards\fR(5)