.\" Copyright 1993 Giorgio Ciucci (giorgio@crcc.it)
.\"
.\" 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 Sun Nov 28 17:06:19 1993, Rik Faith (faith@cs.unc.edu)
.\"          with material from Luigi P. Bai (lpb@softint.com)
.\" Portions Copyright 1993 Luigi P. Bai
.\"
.\" Traduction 16/10/1996 par Christophe Blaess (ccb@club-internet.fr)
.\" Mise a Jour 15/04/97
.\" Mise a Jour 20/01/2002 - LDP-man-pages-1.47
.\" Mise a Jour 18/07/2003 - LDP-man-pages-1.56
.TH SHMOP 2 "18 juillet 2003" LDP "Manuel du programmeur Linux"
.SH NOM
shmop, shmat, shmdt \- Oprations sur la mmoire partage.
.SH SYNOPSIS
.nf
.B #include <sys/types.h>
.B #include <sys/shm.h>
.fi
.sp
.BI "void *shmat ( int " shmid ,
.BI "const void * " shmaddr ,
.BI "int " shmflg );
.sp
.BI "int shmdt (const void * " shmaddr );
.SH DESCRIPTION
La fonction
.B shmat
attache le segment de mmoire partage identifi par
.B shmid
au segment de donnes du processus appelant.
L'adresse d'attachement est indique par
.I shmaddr
avec les critres suivants\ :
.IP
Si
.I shmaddr
vaut
.BR NULL ,
le systme essaye de trouver une adresse libre pour attacher
le segment.
.IP
Si
.I shmaddr
n'est pas
.B NULL
et si
.B SHM_RND
est indiqu dans
.IR shmflg ,
l'attachement a lieu  l'adresse 
.I shmaddr
arrondie au multiple infrieur de
.BR SHMLBA .
Sinon
.I shmaddr
doit tre aligne sur une frontire de page, o l'attachement a lieu.
.PP
Si
.B SHM_RDONLY
est indiqu dans
.IR shmflg ,
le segment est attach en lecture seulement, et le processus doit disposer
de la permission de lecture dessus. Sinon le segment est attach en lecture
et criture et le processus doit disposer des deux permissions d'accs.
Il n'y a pas de notion d'criture seule pour les
segments de mmoire partage.
.PP
L'option (spcifique  Linux)
.B SHM_REMAP
peut tre ajoute dans
.I shmflg
pour indiquer que la projection du segment doit remplacer une projection
prcdente dans l'intervalle commenant en
.I shmaddr
et s'tendant sur la taille du segment.
(Normalement une erreur
.B EINVAL
se produirait si une projection existait dj dans l'intervalle indiqu).
Dans ce cas,
.I shmaddr
ne doit pas tre
.BR NULL .
.PP
La valeur
.B brk
du processus appelant n'est pas altre par l'attachement. Le segment est
automatiquement dtach quand le processus se termine. Le mme segment peut tre
attach  la fois en lecture seule et en lecture/criture. Il peut galement
tre attach en plusieurs endroits de l'espace d'adressage du processus.
.PP
Si 
.B shmat
russit, les membres de la structure
.B shmid_ds
associe au segment de mmoire partage sont mis  jour ainsi :
.IP
.B shm_atime
correspond  l'heure actuelle.
.IP
.B shm_lpid
contient le PID de l'appelant.
.IP
.B shm_nattch
est incrment de 1
.PP
Notez que l'attachement russit mme si le segment de mmoire est
marqu pour destruction.
.PP
La fonction
.B shmdt
dtache le segment de mmoire partage situe  l'adresse indique par
.IR shmaddr .
Le segment doit tre effectivement attach, et l'adresse
.I shmaddr
doit tre celle renvoye prcdement par
.BR shmat.
.PP
Quand
.B shmdt
russit, les membres de la structure
.B shmid_ds
associe au segment de mmoire partage sont mis  jour ainsi :
.IP
.B shm_dtime
correspond  l'heure actuelle.
.IP
.B shm_lpid
contient le PID de l'appelant.
.IP
.B shm_nattch
est dcrment de 1. S'il devient nul, et si le
segment est marqu pour destruction, il est
effectivement dtruit.
.PP
La rgion occupe de l'espace d'adressage du processus est
libre.
.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"
Les deux fonctions renvoient
.B \-1
si elles chouent, auquel cas
.B errno
contient le code d'erreur.
Sinon
.B shmat
renvoie l'adresse d'attachement du segment de mmoire partage, et
.B shmdt
renvoie
.BR 0 .
.SH ERREURS
.BR shmat " :"
.TP
.B EACCES
L'appelant n'a pas les permissions d'accs ncessaires pour l'attachement.
.TP
.B EINVAL
.I shmid
est invalide,
.I shmaddr
est mal aligne,
ou
.B SH_REMAP
a t rclam et
.I shmaddr
est
.BR NULL .
.TP
.B ENOMEM
Pas assez de mmoire pour le systme.
.PP
.BR shmdt " :"
.TP
.BR EINVAL .
Pas de segment attach  l'adresse
.IR shmaddr.
.SH NOTES
Utiliser
.B shmat
avec 
.I shmaddr
ggale 
.B NULL
est la manire conseille, portable, d'attecher un segment de mmoire partag.
Soyez conscients que le segment attach de cette manire peut l'tre 
des adresses diffrentes dans les diffrents processus.
Ainsi, tout pointeur contenu dans la mmoire partag doit tre relatif
(typiquement par rapport au dbut du segment) et pas
absolu.
.LP
Les paramtres systme suivant influent sur
.BR  shmat " :"
.TP 
.B SHMLBA
Multiple pour l'adresse de dbut de segment.
Doit tre align sur une frontire de page.
Pour l'implmentation actuelle,
.B SHMBLA
 la mme valeur que
.BR PAGE_SIZE .
.PP
L'implmentation n'a pas de limite intrinsque pour le nombre maximal de
segment de mmoire partage par processus.
.RB ( SHMSEG ).
.SH CONFORMIT
SVr4, SVID. SVr4 mentionne une condition d'erreur supplmentaire EMFILE.
Dans SVID-v4 le type de l'argument \fIshmaddr\fP a t modifi de
.B "char *"
en
.BR "const void *" ,
et le type de retour de \fIshmat\fP() de
.B "char *"
en
.BR "void *" .
(Les bibliothques Linux libc4 et libc5 avaient le prototype
.B "char *" ,
la GlibC 2 celui
.BR "void *" ).
.SH "VOIR AUSSI"
.BR brk (2),
.BR ipc (5),
.BR mmap (2),
.BR shmctl (2),
.BR shmget (2).
.SH TRADUCTION
Christophe Blaess, 1996-2003.