lib/libc/sys/shmctl.2

   1 .\"
   2 .\" Copyright (c) 1995 David Hovemeyer <daveho@infocom.com>
   3 .\"
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
  16 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
  19 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD: src/lib/libc/sys/shmctl.2,v 1.9.2.4 2001/12/14 18:34:01 ru Exp $
  27 .\"
  28 .Dd January 4, 2014
  29 .Dt SHMCTL 2
  30 .Os
  31 .Sh NAME
  32 .Nm shmctl
  33 .Nd shared memory control
  34 .Sh LIBRARY
  35 .Lb libc
  36 .Sh SYNOPSIS
  37 .In machine/param.h
  38 .In sys/types.h
  39 .In sys/ipc.h
  40 .In sys/shm.h
  41 .Ft int
  42 .Fn shmctl "int shmid" "int cmd" "struct shmid_ds *buf"
  43 .Sh DESCRIPTION
  44 Performs the action specified by
  45 .Fa cmd
  46 on the shared memory segment identified by
  47 .Fa shmid :
  48 .Bl -tag -width SHM_UNLOCKX
  49 .It Dv IPC_STAT
  50 Fetch the segment's
  51 .Fa "struct shmid_ds" ,
  52 storing it in the memory pointed to by
  53 .Fa buf .
  54 .\"
  55 .\" XXX need to make sure that this is correct for FreeBSD
  56 .\"
  57 .It Dv IPC_SET
  58 Changes the
  59 .Fa shm_perm.uid ,
  60 .Fa shm_perm.gid ,
  61 and
  62 .Fa shm_perm.mode
  63 members of the segment's
  64 .Fa "struct shmid_ds"
  65 to match those of the struct pointed to by
  66 .Fa buf .
  67 The calling process's effective uid must
  68 match either
  69 .Fa shm_perm.uid
  70 or
  71 .Fa shm_perm.cuid ,
  72 or it must have superuser privileges.
  73 .It Dv IPC_RMID
  74 Removes the segment from the system.
  75 The removal will not take
  76 effect until all processes having attached the segment have exited;
  77 however, once the
  78 .Dv IPC_RMID
  79 operation has taken place, no further
  80 processes will be allowed to attach the segment.
  81 For the operation
  82 to succeed, the calling process's effective uid must match
  83 .Fa shm_perm.uid
  84 or
  85 .Fa shm_perm.cuid ,
  86 or the process must have superuser privileges.
  87 .\" .It Dv SHM_LOCK
  88 .\" Locks the segment in memory.
  89 .\" The calling process must have superuser privileges.
  90 .\" Not implemented in FreeBSD.
  91 .\" .It Dv SHM_UNLOCK
  92 .\" Unlocks the segment from memory.
  93 .\" The calling process must have superuser privileges.
  94 .\" Not implemented in FreeBSD.
  95 .El
  96 .Pp
  97 The
  98 .Fa shmid_ds
  99 struct is defined as follows:
 100 .\"
 101 .\" I fiddled with the spaces a bit to make it fit well when viewed
 102 .\" with nroff, but otherwise it's straight from sys/shm.h
 103 .\"
 104 .Bd -literal
 105 typedef unsigned int shmatt_t;
 106
 107 struct shmid_ds {
 108     struct ipc_perm shm_perm;   /* operation permission structure */
 109     size_t          shm_segsz;  /* size of segment in bytes */
 110     pid_t           shm_lpid;   /* process ID of last shared memory op */
 111     pid_t           shm_cpid;   /* process ID of creator */
 112     shmatt_t        shm_nattch; /* number of current attaches */
 113     time_t          shm_atime;  /* time of last shmat() */
 114     time_t          shm_dtime;  /* time of last shmdt() */
 115     time_t          shm_ctime;  /* time of last change by shmctl() */
 116     void           *shm_internal; /* sysv stupidity */
 117 };
 118 .Ed
 119 .Sh RETURN VALUES
 120 .Rv -std shmctl
 121 .Sh ENVIRONMENT
 122 The XSI Interprocess Communication family of functions is also available
 123 as an implementation in userspace.
 124 To use it, the
 125 .Xr sysvipcd 8
 126 daemon has to be running.
 127 .Pp
 128 If the
 129 .Ev USR_SYSVIPC
 130 variable is set in a process' environment, the process and its children
 131 will use the userspace implementation.
 132 .Sh ERRORS
 133 .Fn Shmctl
 134 will fail if:
 135 .Bl -tag -width Er
 136 .It Bq Er EINVAL
 137 Invalid operation, or
 138 no shared memory segment was found corresponding to
 139 .Fa shmid .
 140 .\"
 141 .\" XXX I think the following is right: ipcperm() only returns EPERM
 142 .\"     when an attempt is made to modify (IPC_M) by a non-creator
 143 .\"     non-owner
 144 .It Bq Er EPERM
 145 The calling process's effective uid does not match the uid of
 146 the shared memory segment's owner or creator.
 147 .It Bq Er EACCES
 148 Permission denied due to mismatch between operation and mode of
 149 shared memory segment.
 150 .El
 151 .Sh "SEE ALSO"
 152 .Xr shmat 2 ,
 153 .Xr shmdt 2 ,
 154 .Xr shmget 2 ,
 155 .Xr ftok 3
 156 .Sh AUTHORS
 157 .An -nosplit
 158 The
 159 .Dx
 160 specific userspace implementation (see
 161 .Sx ENVIRONMENT )
 162 was written by
 163 .An Larisa Grigore .