(split) LDP_man-pages: update original to v3.35.

[linuxjm/LDP_man-pages.git] / draft / man2 / sigqueue.2

.\" Copyright (c) 2002 Michael Kerrisk <mtk.manpages@gmail.com>
.\"
.\" 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.
.\"
.\" added note on self-signaling, aeb, 2002-06-07
.\" added note on CAP_KILL, mtk, 2004-06-16
.\"
.\" Japanese Version Copyright (c) 2002, 2005 Yuichi SATO
.\"         all rights reserved.
.\" Translated 2002-08-06, Yuichi SATO <ysato@h4.dion.ne.jp>
.\" Updated & Modified 2005-01-08, Yuichi SATO <ysato444@yahoo.co.jp>
.\" Updated 2007-09-08, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>, LDP v2.64
.\"
.TH SIGQUEUE 2 2007-07-26 "Linux" "Linux Programmer's Manual"
.\"O .SH NAME
.SH ̾Á°
.\"O sigqueue, rt_sigqueueinfo \- queue a signal and data to a process
sigqueue, rt_sigqueueinfo \- ¥·¥°¥Ê¥ë¤È¥Ç¡¼¥¿¤ò¥×¥í¥»¥¹¤ËÁ÷¤ë
.\"O .SH SYNOPSIS
.SH ½ñ¼°
.B #include <signal.h>
.sp
.BI "int sigqueue(pid_t " pid ", int " sig ", const union sigval " value );
.sp
.in -4n
.\"O Feature Test Macro Requirements for glibc (see
.\"O .BR feature_test_macros (7)):
glibc ¸þ¤±¤Îµ¡Ç½¸¡ºº¥Þ¥¯¥í¤ÎÍ×·ï
.RB ( feature_test_macros (7)
»²¾È):
.in
.sp
.BR sigqueue ():
_POSIX_C_SOURCE\ >=\ 199309L
.\"O .SH DESCRIPTION
.SH ÀâÌÀ
.\"O .BR sigqueue ()
.\"O sends the signal specified in
.\"O .I sig
.\"O to the process whose PID is given in
.\"O .IR pid .
.BR sigqueue ()
¤Ï
.I sig
¤Ç»ØÄꤵ¤ì¤¿¥·¥°¥Ê¥ë¤ò¡¢PID ¤¬
.I pid
¤Ç¤¢¤ë¥×¥í¥»¥¹¤ËÁ÷¤ë¡£
.\"O The permissions required to send a signal are the same as for
.\"O .BR kill (2).
¥·¥°¥Ê¥ë¤òÁ÷¤ë¤Î¤ËɬÍפʸ¢¸Â¤Ï
.BR kill (2)
¤ÈƱ¤¸¤Ç¤¢¤ë¡£
.\"O As with
.\"O .BR kill (2),
.\"O the null signal (0) can be used to check if a process with a given
.\"O PID exists.
.BR kill (2)
¤ÈƱÍͤˡ¢¥Ì¥ë¡¦¥·¥°¥Ê¥ë (0) ¤ò»È¤Ã¤Æ
»ØÄꤷ¤¿ PID ¤Î¥×¥í¥»¥¹¤¬Â¸ºß¤¹¤ë¤«¤ò¥Á¥§¥Ã¥¯¤¹¤ë¤³¤È¤¬¤Ç¤­¤ë¡£
.PP
.\"O The
.\"O .I value
.\"O argument is used to specify an accompanying item of data (either an integer
.\"O or a pointer value) to be sent with the signal, and has the following type:
.I value
°ú¤­¿ô¤Ï¥·¥°¥Ê¥ë¤È°ì½ï¤ËÁ÷¤ë¥Ç¡¼¥¿¤ÎÉÕ°¥¢¥¤¥Æ¥à¤ò»ØÄꤹ¤ë¡£
.I value
¤Ï (À°¿ô¤Þ¤¿¤Ï¥Ý¥¤¥ó¥¿¤ÎÃͤǤ¢¤ê) °Ê²¼¤Î¤è¤¦¤Ê·¿¤Ç¤¢¤ë¡£
.sp
.in +4n
.nf
union sigval {
    int   sival_int;
    void *sival_ptr;
};
.fi
.in

.\"O If the receiving process has installed a handler for this signal using the
.\"O .B SA_SIGINFO
.\"O flag to
.\"O .BR sigaction (2),
.\"O then it can obtain this data via the
.\"O .I si_value
.\"O field of the
.\"O .I siginfo_t
.\"O structure passed as the second argument to the handler.
¼õ¼èÀè¤Î¥×¥í¥»¥¹¤Ë¡¢¤³¤Î¥·¥°¥Ê¥ë¤ËÂФ¹¤ë¥Ï¥ó¥É¥é¤ò
.RB ( sigaction (2)
¤Ë
.B SA_SIGINFO
¤ò»ØÄꤷ¤Æ) ¥¤¥ó¥¹¥È¡¼¥ë¤·¤Æ¤ª¤¯¤È¡¢
¤½¤Î¥Ï¥ó¥É¥é¤ÎÂè 2 °ú¤­¿ô¤ËÅϤµ¤ì¤ë
.I siginfo_t
¹½Â¤ÂΤÎ
.I si_value
¥Õ¥£¡¼¥ë¥É¤Ë¤è¤Ã¤Æ¡¢¤³¤Î¥Ç¡¼¥¿¤ò¼èÆÀ¤Ç¤­¤ë¡£
.\"O Furthermore, the
.\"O .I si_code
.\"O field of that structure will be set to
.\"O .BR SI_QUEUE .
¤µ¤é¤Ë¡¢¤³¤Î¹½Â¤ÂΤÎ
.I si_code
¥Õ¥£¡¼¥ë¥É¤Ï
.B SI_QUEUE
¤ËÀßÄꤵ¤ì¤ë¡£
.\"O .SH "RETURN VALUE"
.SH ÊÖ¤êÃÍ
.\"O On success,
.\"O .BR sigqueue ()
.\"O returns 0, indicating that the signal was successfully
.\"O queued to the receiving process.
À®¸ù¤·¤¿¾ì¹ç¡¢
.BR sigqueue ()
¤Ï 0 ¤òÊÖ¤¹¡£
¤³¤ì¤Ï¼õ¤±¼è¤ê¦¥×¥í¥»¥¹¤ÎÂÔ¤Á¹ÔÎó¤Ë
¥·¥°¥Ê¥ë¤¬Àµ¤·¤¯Æþ¤ì¤é¤ì¤¿¤³¤È¤ò¼¨¤¹¡£
.\"O Otherwise \-1 is returned and
.\"O .I errno
.\"O is set to indicate the error.
¼ºÇÔ¤·¤¿¾ì¹ç¤Ï \-1 ¤¬ÊÖ¤µ¤ì¡¢
.I errno
¤¬¥¨¥é¡¼¤òɽ¤¹ÃͤËÀßÄꤵ¤ì¤ë¡£
.\"O .SH ERRORS
.SH ¥¨¥é¡¼
.TP
.B EAGAIN
.\"O The limit of signals which may be queued has been reached.
ÂÔ¤Á¹ÔÎó¤ËÆþ¤ì¤é¤ì¤ë¥·¥°¥Ê¥ë¤ÎºÇÂç¿ô¤Ë㤷¤¿
.\"O (See
.\"O .BR signal (7)
.\"O for further information.)
(¤è¤ê¾Ü¤·¤¤¾ðÊó¤Ï
.BR signal (7)
¤ò»²¾È¤¹¤ë¤³¤È)¡£
.TP
.B EINVAL
.\"O .I sig
.\"O was invalid.
.I sig
¤¬ÉÔÀµ¤Ç¤¢¤ë¡£
.TP
.B EPERM
.\"O The process does not have permission to send the signal
.\"O to the receiving process.
¤³¤Î¥×¥í¥»¥¹¤Ë¤Ï¡¢¼õ¤±¼è¤ê¦¥×¥í¥»¥¹¤Ë¥·¥°¥Ê¥ë¤òÁ÷¤ë¸¢¸Â¤¬¤Ê¤¤¡£
.\"O For the required permissions, see
.\"O .BR kill (2).
ɬÍפʸ¢¸Â¤Ë¤Ä¤¤¤Æ¤Ï¡¢
.BR kill (2)
¤ò»²¾È¤¹¤ë¤³¤È¡£
.TP
.B ESRCH
.\"O No process has a PID matching
.\"O .IR pid .
.I pid
¤Ë¥Þ¥Ã¥Á¤¹¤ë PID ¤Î¥×¥í¥»¥¹¤¬¤Ê¤¤¡£
.\"O .SH VERSIONS
.SH ¥Ð¡¼¥¸¥ç¥ó
.\"O This system call first appeared in Linux 2.2.
¤³¤Î¥·¥¹¥Æ¥à¥³¡¼¥ë¤Ï Linux 2.2 ¤Ç½é¤á¤ÆÅо줷¤¿¡£
.\"O .SH "CONFORMING TO"
.SH ½àµò
POSIX.1-2001.
.\"O .SH NOTES
.SH Ãí°Õ
.\"O If this function results in the sending of a signal to the process
.\"O that invoked it, and that signal was not blocked by the calling thread,
.\"O and no other threads were willing to handle this signal (either by
.\"O having it unblocked, or by waiting for it using
.\"O .BR sigwait (3)),
.\"O then at least some signal must be delivered to this thread before this
.\"O function returns.
.\"Osato:
.\"Osato: ¤³¤Îʸ¾Ï¤ÏŤ¹¤®¤ë¤Î¤È it ¤¬Â¿¤¹¤®¤ë¤¿¤á¤ËÎɤ¯Ê¬¤«¤ê¤Þ¤»¤ó¡£
.\"Osato: that invoked it ( = this function)
.\"Osato: by having it ( = that signal) unblocked
.\"Osato: by waiting for it  ( = that signal) using sigwait(3)
.\"Osato: ¤È¤·¤ÆÌõ¤·¤Æ¤ß¤Þ¤·¤¿¡£
.\"Osato: ¾Ü¤·¤¤Êý¤«¤é¤Î¸æ»ØŦ¤ò¤ªÂÔ¤Á¤·¤Þ¤¹¡£
.\"Osato:
¤³¤Î´Ø¿ô¤ò¸Æ¤Ó½Ð¤·¤¿¥×¥í¥»¥¹¤Ë¤³¤Î´Ø¿ô¤¬¥·¥°¥Ê¥ë¤òÁ÷¤Ã¤¿¤È¤­¤Ë¡¢
¥·¥°¥Ê¥ë¤¬¸Æ¤Ó½Ð¤·Â¦¥¹¥ì¥Ã¥É¤Ë¥Ö¥í¥Ã¥¯¤µ¤ì¤º¡¢
¤«¤Ä (¥·¥°¥Ê¥ë¤¬¥Ö¥í¥Ã¥¯¤µ¤ì¤Ê¤«¤Ã¤¿¡¢¤Þ¤¿¤Ï
.BR sigwait (3)
¤ò»ÈÍѤ¹¤ë¤Î¤òÂԤäƤ¤¤ë¤³¤È¤Ë¤è¤ê)
¤³¤Î¥·¥°¥Ê¥ë¤ò°·¤¦¥¹¥ì¥Ã¥É¤¬²¿¤â¤Ê¤¤¾ì¹ç¤Ï¡¢
¤³¤Î´Ø¿ô¤¬¥ê¥¿¡¼¥ó¤¹¤ëÁ°¤Ë¡¢¾¯¤Ê¤¯¤È¤â
¤½¤Î¥¹¥ì¥Ã¥É¤ËÂФ·¤Æ¥·¥°¥Ê¥ë¤¬ÇÛÁ÷¤µ¤ì¤Æ¤¤¤Ê¤±¤ì¤Ð¤Ê¤é¤Ê¤¤¡£

.\"O On Linux, the underlying system call is actually named
.\"O .BR rt_sigqueueinfo (),
.\"O and differs in its third argument, which is the
.\"O .I siginfo_t
.\"O structure that will be supplied to the receiving process's
.\"O signal handler or returned by the receiving process's
.\"O .BR sigtimedwait (2)
.\"O call.
.\"O Inside the glibc
.\"O .BR sigqueue ()
.\"O wrapper, this argument,
.\"O .IR info ,
.\"O is initialized as follows:
Linux ¤Ç¤Ï¡¢¸Æ¤Ó½Ð¤µ¤ì¤ë¥·¥¹¥Æ¥à¥³¡¼¥ë¤Î̾Á°¤Ï¼ÂºÝ¤Ë¤Ï
.BR rt_sigqueueinfo ()
¤Ç¤¢¤ë¡£
.BR rt_sigqueueinfo ()
¤Ç¤Ï 3 ÈÖÌܤΰú¤­¿ô¤Ë°ã¤¤¤¬¤¢¤ê¡¢
.I siginfo_t
¹½Â¤ÂΤǤ¢¤ë¡£
.I siginfo_t
¹½Â¤ÂΤϡ¢¥·¥°¥Ê¥ë¤ò¼õ¿®¤¹¤ë¥×¥í¥»¥¹¤Î¥·¥°¥Ê¥ë¥Ï¥ó¥É¥é¤ËÅϤµ¤ì¤¿¤ê¡¢
¥·¥°¥Ê¥ë¼õ¿®¥×¥í¥»¥¹¤Î
.BR sigtimedwait (2)
¥·¥¹¥Æ¥à¥³¡¼¥ë¤«¤éÊÖ¤µ¤ì¤¿¤ê¤¹¤ë¡£
glibc ¤Î
.BR sigqueue ()
¥é¥Ã¥Ñ¡¼´Ø¿ôÆâÉô¤Ç¤Ï¡¢
¤³¤Î°ú¤­¿ô
.I info
¤Ï°Ê²¼¤Î¤è¤¦¤Ë½é´ü²½¤µ¤ì¤ë¡£
.in +4n
.nf

info.si_signo = sig;      /* argument supplied to sigqueue() */
info.si_code = SI_QUEUE;
info.si_pid = getpid();   /* Process ID of sender */
info.si_uid = getuid();   /* Real UID of sender */
info.si_value = val;      /* argument supplied to sigqueue() */
.fi
.in
.\"O .SH "SEE ALSO"
.SH ´ØÏ¢¹àÌÜ
.BR kill (2),
.BR sigaction (2),
.BR signal (2),
.BR sigwait (3),
.BR signal (7)