.\" Copyright (c) 1993 Luigi P. Bai (lpb@softint.com) July 28, 1993
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one
.\" 
.\" Since the Linux kernel and libraries are constantly changing, this
.\" manual page may be incorrect or out-of-date.  The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein.  The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\" 
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\"
.\" Modified Wed Jul 28 10:57:35 1993, Rik Faith (faith@cs.unc.edu)
.\" Modified Sun Nov 28 16:43:30 1993, Rik Faith (faith@cs.unc.edu)
.\"          with material from Giorgio Ciucci (giorgio@crcc.it)
.\" Portions Copyright 1993 Giorgio Ciucci (giorgio@crcc.it)
.\"
.\" Traduction 16/10/1996 par Christophe Blaess (ccb@club-internet.fr)
.\" Mise a Jour 15/04/97
.\" Mise a Jour 10/10/99
.TH SHMGET 2 "10 Octobre 1999" Linux "Manuel du programmeur Linux"
.SH NOM
shmget \- Allouer un segment de mmoire partage.
.SH SYNOPSIS
.ad l
.B #include <sys/ipc.h>
.sp
.B #include <sys/shm.h>
.sp
.BI "int shmget(key_t " cl ", int " size ", int " shmflg );
.ad b
.SH DESCRIPTION
.B shmget()
renvoie l'identificateur du segment de mmoire partage
associ  la valeur de l'argument
.IR cl .
Un nouveau segment mmoire, de taille 
.I size
arrondie au multiple suprieur de
.BR PAGE_SIZE ,
est cr si
.I cl
a la valeur
.B IPC_PRIVATE
ou si aucun segment de mmoire partage n'est associ 
.IR cl ,
et
.B IPC_CREAT
est prsent dans
.I shmflg.
.PP
.I shmflg
est compos de :
.TP 12
.B IPC_CREAT
pour crer un nouveau segment. Sinon
.B shmget()
recherchera le segment associ  \fIcl\fP, vrifiera que
l'appelant a la permission de recevoir l'identifiant \fIshmid\fP 
associ au segment, et contrlera que le segment n'est pas
dtruit.
.TP
.B IPC_EXCL
est utilis avec \fBIPC_CREAT\fP pour garantir l'chec si
le segment existe dj.
.TP
.B mode d'accs (les 9 bits de poids faibles)
indiquant les permissions pour le propritaire, le groupe et
les autres.
Actuellement la permission d'excution n'est pas utilise 
par le systme.
.PP
Si un nouveau segment est cr, les permissions d'accs de
.I shmflg
sont copies dans le membre
.I shm_perm
de la structure
.I shmid_ds
dcrivant le segment. Cette structure est dfinie ainsi :
.PP
.in +0.5i
.nf
struct shmid_ds {
  struct          ipc_perm shm_perm; /* Permissions d'accs       */
  int             shm_segsz;         /* Taille segment en octets  */
  time_t          shm_atime;         /* Heure dernier attachement */
  time_t          shm_dtime;         /* Heure dernier dtachement */
  time_t          shm_ctime;         /* Heure dernier changement  */
  unsigned short  shm_cpid;          /* PID du crateur           */
  unsigned short  shm_lpid;          /* PID du dernier oprateur  */
  short           shm_nattch;        /* Nombre d'attachements     */
  /* ------------- Les champs suivants sont prives -------------- */
  unsigned short  shm_npages;        /* Taille segment en pages   */
  unsigned long   *shm_pages;        /* Taille d'une page (?)     */
  struct shm_desc *attaches;         /* Descript. attachements    */
};
.fi
.in -0.5i
.PP
.in +0.5i
.nf
struct ipc_perm
{
  key_t  key;
  ushort uid;   /* UID et GID effectifs du propritaire    */
  ushort gid;
  ushort cuid;  /* UID et GID effectif du crateur         */
  ushort cgid;
  ushort mode;  /* Mode d'accs sur 9 bits de poids faible */
  ushort seq;   /* Numro de squence                      */
};
.fi
.PP
De plus, durant la cration, le systme initialise la structure
.B shmid_ds
associe au segment comme suit :
.IP
.B shm_perm.cuid
et
.B shm_perm.uid
contiennent l'UID effectif de l'appelant.
.IP
.B shm_perm.cgid
et 
.B shm_perm.gid
contiennent le GID effectif de l'appelant.
.IP
Les 9 bits de poids faibles de
.B shm_perm.mode
contiennent les 9 bits de poids faibles de
.IR shmflg .
.IP
.B shm_segsz
prend la valeur
.IR size.
.IP
.BR shm_lpid ,
.BR shm_nattch ,
.B shm_atime
et
.B shm_dtime
sont mis  
.BR 0.
.IP
.B shm_ctime
contient l'heure actuelle
.PP
.PP
.SH "AUTRES APPELS SYSTMES"
.TP
.B fork()
Aprs un
.B fork()
le fils hrite des segments de mmoire partage.
.TP
.B exec()
Aprs un
.B exec()
tous les segments de mmoire partage sont dtachs (pas dtruits).
.TP
.B exit()
Lors d'un
.B exit()
tous les segments de mmoire partage sont dtachs (pas dtruits).
.PP
.SH "VALEUR RENVOYE"
Un identificateur de segment 
.IR shmid 
valide est renvoy en cas de russite, sinon \-1 est renvoy et
.I errno
contient le code d'erreur.
.SH ERREURS
.TP 12
.B EINVAL
\fBSHMMIN\fP > \fIsize\fP ou
\fIsize\fP > \fBSHMMAX\fP, ou \fIsize\fP plus grand que la taille du segment.
.TP
.B EEXIST
On a indiqu
.B IPC_CREAT | IPC_EXCL
et le segment existe dj.
.TP
.B EIDRM
Le segment est dtruit.
.TP
.B ENOSPC
Tous les ID de mmoire partage sont utiliss, ou l'allocation
d'un segment partag de taille
.I size
dpasserait les limites de mmoire partage du systme.
.TP
.B ENOENT
Aucun segment n'est associ  \fIcl\fP, et 
.B IPC_CREAT
n'etait pas indiqu.
.TP
.B EACCES
L'appelant n'a pas les autorisations d'accs au segment.
.TP
.B ENOMEM
Pas assez de mmoire.
.SH NOTES
.B IPC_PRIVATE
n'est pas une option mais une valeur de type
.BR key_t .
Si cette valeur spciale est utilise comme
.IR cl ,
l'appel systme ignore tout sauf les 9 bits de poids faibles
de
.I shmflg
et tente de crer un nouveau segment.
.PP
Les limites suivantes influent sur l'appel systme
.BR shmget " :"
.TP 11
.B SHMALL
Nombre maximal de pages de mmoire partage sur le systme.
.TP
.B SHMMAX
Taille maximale d'un segment partag (actuellement 4 Mo).
.TP
.B SHMMIN
Taille minimale d'un segment partag.
(actuellement 1 octet, bien que
.B PAGE_SIZE
soit la valeur effectivement utilise).
.TP
.B SHMMNI
Nombre maximal de segments de mmoire partage sur le systme 
(actuellement 4096).
.PP
Il n'y a pas de limite pour le nombre de segments partags par
processus (sauf SHMMNI).
.SH CONFORMIT
SVr4, SVID. SVr4 mentionne une condition d'erreur supplmentaire EEXIST. Ni
SVr4, ni SVID ne mentionnent l'erreur EIDRM.
.SH BUGS
Indiquer  la fois
.B IPC_CREAT
et
.B IPC_EXCL
dans
.I shmflg
garantit seulement la cration d'un nouveau segment, et non pas
l'exclusivite d'accs  ce segment.
.SH "VOIR AUSSI"
.BR ftok (3),
.BR ipc (5),
.BR shmctl (2),
.BR shmat (2),
.BR shmdt (2).

.SH TRADUCTION
Christophe Blaess, 1997.