(split) LDP v3.30, v3.31 の定型的な変更内容を反映。

[linuxjm/LDP_man-pages.git] / release / man2 / sched_setaffinity.2

.\" man2/sched_setaffinity.2 - sched_setaffinity and sched_getaffinity man page
.\"
.\" Copyright (C) 2002 Robert Love
.\" and Copyright (C) 2006 Michael Kerrisk
.\"
.\" This is free documentation; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License as
.\" published by the Free Software Foundation; either version 2 of
.\" the License, or (at your option) any later version.
.\"
.\" The GNU General Public License's references to "object code"
.\" and "executables" are to be interpreted as the output of any
.\" document formatting or typesetting system, including
.\" intermediate and printed output.
.\"
.\" This manual is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public
.\" License along with this manual; if not, write to the Free
.\" Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111,
.\" USA.
.\"
.\" 2002-11-19 Robert Love <rml@tech9.net> - initial version
.\" 2004-04-20 mtk - fixed description of return value
.\" 2004-04-22 aeb - added glibc prototype history
.\" 2005-05-03 mtk - noted that sched_setaffinity may cause thread
.\"     migration and that CPU affinity is a per-thread attribute.
.\" 2006-02-03 mtk -- Major rewrite
.\" 2008-11-12, mtk, removed CPU_*() macro descriptions to a
.\" separate CPU_SET(3) page.
.\"
.\" Japanese Version Copyright (c) 2003, 2005 Yuichi SATO
.\"         all rights reserved.
.\" Translated 2003-01-23, Yuichi SATO <ysato444@yahoo.co.jp>
.\" Updated & Modified 2003-09-23, Yuichi SATO
.\" Updated & Modified 2005-01-03, Yuichi SATO
.\" Updated & Modified 2005-09-13, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
.\" Updated & Modified 2006-07-14, Akihiro MOTOKI, LDP v2.34
.\" Updated & Modified 2008-12-24, Akihiro MOTOKI, LDP v3.14
.\"
.\"WORD:        affinity                ¿ÆÏÂÅÙ
.\"WORD:        most significant bit    ºÇ¾å°Ì¥Ó¥Ã¥È
.\"WORD:        least significant bit   ºÇ²¼°Ì¥Ó¥Ã¥È
.\"WORD:        capability              ¸¢¸Â
.\"
.TH SCHED_SETAFFINITY 2 2010-11-06 "Linux" "Linux Programmer's Manual"
.SH ̾Á°
sched_setaffinity, sched_getaffinity \- \
¥×¥í¥»¥¹¤Î CPU affinity ¥Þ¥¹¥¯¤òÀßÄꡦ¼èÆÀ¤¹¤ë
.SH ½ñ¼°
.nf
.BR "#define _GNU_SOURCE" "             /* feature_test_macros(7) »²¾È */"
.B #include <sched.h>
.sp
.BI "int sched_setaffinity(pid_t " pid ", size_t " cpusetsize ,
.BI "                      cpu_set_t *" mask );
.sp
.BI "int sched_getaffinity(pid_t " pid ", size_t " cpusetsize ,
.BI "                      cpu_set_t *" mask );
.fi
.SH ÀâÌÀ
¥×¥í¥»¥¹¤Î CPU affinity (¿ÆÏÂÅÙ) ¥Þ¥¹¥¯¤Ï¡¢¤½¤Î¥×¥í¥»¥¹¤¬
¼Â¹Ô¤òµö²Ä¤µ¤ì¤Æ¤¤¤ë CPU ¤Î½¸¹ç¤ò·èÄꤹ¤ë¡£
¥Þ¥ë¥Á¥×¥í¥»¥Ã¥µ¡¦¥·¥¹¥Æ¥à¤Ç¤Ï¡¢CPU affinity ¥Þ¥¹¥¯¤òÀßÄꤹ¤ë¤³¤È¤Ç
À­Ç½¾å¤Î¥á¥ê¥Ã¥È¤òÆÀ¤é¤ì¤ë²ÄǽÀ­¤¬¤¢¤ë¡£
Î㤨¤Ð¡¢ÆÃÄê¤Î¥×¥í¥»¥¹¤ò°ì¤Ä¤Î CPU ¤Ë³ç¤êÉÕ¤±
(¤¹¤Ê¤ï¤Á¡¢¤½¤Î¥×¥í¥»¥¹¤Î affinity ¥Þ¥¹¥¯¤ò°ì¤Ä¤Î CPU ¤ËÀßÄꤷ)¡¢
¾¤ÎÁ´¤Æ¤Î¥×¥í¥»¥¹¤Î affinity ¥Þ¥¹¥¯¤«¤é¤½¤Î CPU ¤ò½ü³°¤¹¤ë¤³¤È¤Ç¡¢
³Î¼Â¤Ë¤½¤Î¥×¥í¥»¥¹¤Î¼Â¹Ô®ÅÙ¤òºÇÂç¤Ë¤¹¤ë¤³¤È¤¬¤Ç¤­¤ë¡£
¤Þ¤¿¡¢¤¢¤ë¥×¥í¥»¥¹¤Î¼Â¹Ô¤ò°ì¤Ä¤Î CPU ¤Ë¸ÂÄꤹ¤ë¤³¤È¤Ç¡¢
°ì¤Ä¤Î CPU ¤Ç¤Î¼Â¹Ô¤òÄä»ß¤·¤Æ¤«¤éÊ̤ΠCPU ¤Ç¼Â¹Ô¤òºÆ³«¤¹¤ë¤È¤­¤ËȯÀ¸¤¹¤ë
¥­¥ã¥Ã¥·¥å̵¸ú²½ (cache invalidation) ¤Ë¤è¤ëÀ­Ç½Ì̤ÎÎô²½¤òÈò¤±¤ë¤³¤È¤â¤Ç¤­¤ë¡£

CPU affinity ¥Þ¥¹¥¯¤Ï¡ÖCPU ¤Î½¸¹ç¡×¤òɽ¤¹
.I cpu_set_t
¹½Â¤ÂΤÇɽ¸½¤µ¤ì¡¢
.I cpu_set_t
¤Ø¤Î¥Ý¥¤¥ó¥¿
.I mask
¤Ç»ØÄꤵ¤ì¤ë¡£
CPU ½¸¹ç¤òÁàºî¤¹¤ë¤¿¤á¤Î¥Þ¥¯¥í·²¤Ë¤Ä¤¤¤Æ¤Ï
.BR CPU_SET (3)
¤Çµ­ºÜ¤µ¤ì¤Æ¤¤¤ë¡£

.BR sched_setaffinity ()
¤Ï¡¢¥×¥í¥»¥¹ID ¤¬
.I pid
¤Î¥×¥í¥»¥¹¤Î CPU affinity ¥Þ¥¹¥¯¤ò
.I mask
¤Ç»ØÄꤵ¤ì¤¿ÃͤËÀßÄꤹ¤ë¡£
.I pid
¤¬ 0 ¤Î¾ì¹ç¡¢¸Æ¤Ó½Ð¤·¸µ¥×¥í¥»¥¹¤¬»È¤ï¤ì¤ë¡£
.I cpusetsize
°ú¤­¿ô¤Ë¤Ï
.I mask
¤¬»Ø¤¹¥Ç¡¼¥¿¤ÎŤµ (¥Ð¥¤¥Èñ°Ì) ¤Ç¤¢¤ë¡£
Ä̾ï¤Ï¡¢¤³¤Î°ú¤­¿ô¤Ë¤Ï
.I "sizeof(cpu_set_t)"
¤ò»ØÄꤹ¤ì¤Ð¤è¤¤¡£

.I pid
¤Ç»ØÄꤵ¤ì¤¿¥×¥í¥»¥¹¤¬
.I mask
¤Ç»ØÄꤵ¤ì¤¿ CPU ¤Î¤¤¤º¤ì¤«¤Ç¸½ºß¼Â¹Ô¤µ¤ì¤Æ¤¤¤Ê¤¤¾ì¹ç¡¢
¤½¤Î¥×¥í¥»¥¹¤Ï
.I mask
¤Ç»ØÄꤵ¤ì¤¿ CPU ¤Î¤¤¤º¤ì¤«¤Ë°ÜÆ°¤µ¤ì¤ë¡£

.BR sched_getaffinity ()
¤Ï¡¢
¥×¥í¥»¥¹ID ¤¬
.I pid
¤Î¥×¥í¥»¥¹¤Î affinity ¥Þ¥¹¥¯¤ò
.I mask
¤¬»Ø¤¹
.I cpu_set_t
¹½Â¤ÂΤ˽ñ¤­¹þ¤à¡£
.I cpusetsize
°ú¤­¿ô¤Ë¤Ï
.I mask
¤Î (¥Ð¥¤¥Èñ°Ì¤Î) Â礭¤µ¤ò»ØÄꤹ¤ë¡£

´Ø¿ô
.BR sched_getaffinity ()
¤ÏŤµ
.I len
¤Î¥Ý¥¤¥ó¥¿
.I mask
¤Ë¥×¥í¥»¥¹
.I pid
¤Î affinity ¥Þ¥¹¥¯¤ò½ñ¤­¹þ¤à¡£
.I pid
¤¬ 0 ¤Î¾ì¹ç¡¢¸Æ¤Ó½Ð¤·¸µ¤Î¥×¥í¥»¥¹¤Î¥Þ¥¹¥¯¤¬ÊÖ¤µ¤ì¤ë¡£
.SH ÊÖ¤êÃÍ
À®¸ù¤·¤¿¾ì¹ç¡¢
.BR sched_setaffinity ()
¤È
.BR sched_getaffinity ()
¤Ï 0 ¤òÊÖ¤¹¡£
¥¨¥é¡¼¤Î¾ì¹ç¤Ï \-1 ¤òÊÖ¤·¡¢
.I errno
¤òŬÀÚ¤ËÀßÄꤹ¤ë¡£
.SH ¥¨¥é¡¼
.TP
.B EFAULT
»ØÄꤵ¤ì¤¿¥á¥â¥êÈÖÃϤ¬ÉÔÀµ¤Ç¤¢¤ë¡£
.TP
.B EINVAL
¥·¥¹¥Æ¥à¾å¤Ë¸½ºß¼ÂºÝ¤Ë¸ºß¤·¡¢¤«¤Ä
"cpuset" µ¡¹½¤¬²Ý¤¹À©¸Â¤Ë¤ª¤¤¤Æ¤½¤Î¥×¥í¥»¥¹¤ËÂФ·¤Æµö²Ä¤µ¤ì¤Æ¤¤¤ë
¥×¥í¥»¥Ã¥µ¤¬¡¢
affinity ¥Ó¥Ã¥È¥Þ¥¹¥¯
.I mask
¤Ë´Þ¤Þ¤ì¤Æ¤¤¤Ê¤¤¡£
"cpuset" µ¡¹½¤Ë¤Ä¤¤¤Æ¤Ï
.BR cpuset (7)
¤ò»²¾È¡£
.TP
.B EINVAL
.RB ( sched_getaffinity ()
¤È¡¢¥«¡¼¥Í¥ë 2.6.9 °ÊÁ°¤Î
.BR sched_setaffinity ())
.I cpusetsize
¤¬¥«¡¼¥Í¥ë¤Ç»È¤ï¤ì¤Æ¤¤¤ë affinity ¥Þ¥¹¥¯¤Î¥µ¥¤¥º¤è¤ê¾®¤µ¤¤¡£
.TP
.B EPERM
.RB ( sched_setaffinity ())
¸Æ¤Ó½Ð¤·¸µ¤Î¥×¥í¥»¥¹¤ËŬÀÚ¤ÊÆø¢¤¬¤Ê¤«¤Ã¤¿¡£
¸Æ¤Ó½Ð¤·¸µ¤Ï¡¢¼Â¸ú¥æ¡¼¥¶ ID ¤¬
.I pid
¤Ç¼±Ê̤µ¤ì¤ë¥×¥í¥»¥¹¤Î¼Â¥æ¡¼¥¶ ID ¤Þ¤¿¤Ï¼Â¸ú¥æ¡¼¥¶ ID ¤ÈƱ¤¸¤Ç¤¢¤ë¤«¡¢
.B CAP_SYS_NICE
¥±¡¼¥Ñ¥Ó¥ê¥Æ¥£ (capability) ¤ò»ý¤¿¤Ê¤±¤ì¤Ð¤Ê¤é¤Ê¤¤¡£
.TP
.B ESRCH
¥×¥í¥»¥¹ ID \fIpid\fP ¤Î¥×¥í¥»¥¹¤¬¸«¤Ä¤«¤é¤Ê¤«¤Ã¤¿¡£
.SH ¥Ð¡¼¥¸¥ç¥ó
CPU affinity ¥·¥¹¥Æ¥à¥³¡¼¥ë¤Ï Linux kernel 2.5.8 ¤ÇƳÆþ¤µ¤ì¤¿¡£
¤³¤ì¤é¤Î¥·¥¹¥Æ¥à¥³¡¼¥ë¤Î¥é¥Ã¥Ñ¡¼´Ø¿ô¤Ï glibc 2.3 ¤ÇƳÆþ¤µ¤ì¤¿¡£
ºÇ½é¤Ï¡¢glibc ¤Î¥¤¥ó¥¿¥Õ¥§¡¼¥¹¤Ë¤Ï
.I "unsigned int"
·¿¤Î
.I cpusetsize
°ú¤­¿ô¤¬Æþ¤Ã¤Æ¤¤¤¿¡£
glibc 2.3.3 ¤Ç¤Ï
.I cpusetsize
°ú¤­¿ô¤¬ºï½ü¤µ¤ì¤¿¤¬¡¢glibc 2.3.4 ¤Ç
.I size_t
·¿¤ÇÉü³è¤·¤¿¡£
.SH ½àµò
¤³¤ì¤é¤Î¥·¥¹¥Æ¥à¥³¡¼¥ë¤Ï Linux ¸ÇÍ­¤Ç¤¢¤ë¡£
.SH Ãí°Õ
.BR sched_setaffinity ()
¤ò¸Æ¤Ó½Ð¤·¤¿¸å¤Ï¡¢¥×¥í¥»¥¹¤¬¼ÂºÝ¤Ë¼Â¹Ô¤µ¤ì¤ë CPU ¤Î½¸¹ç¤Ï¡¢
.I mask
°ú¤­¿ô¤Ç»ØÄꤵ¤ì¤¿½¸¹ç¤È¡¢¥·¥¹¥Æ¥à¾å¤Ë¼ÂºÝ¤Ë¸ºß¤¹¤ë CPU ¤Î½¸¹ç¤Î
¶¦Ä̽¸¹ç (AND) ¤È¤Ê¤ë¡£
"cpuset" µ¡¹½¤¬»ÈÍѤµ¤ì¤Æ¤¤¤ë¾ì¹ç¤Ë¤Ï¡¢¥×¥í¥»¥¹¤¬Æ°ºî¤¹¤ë CPU ½¸¹ç
¤ËÂФ·¤Æ¥·¥¹¥Æ¥à¤Ï¤µ¤é¤ËÀ©¸Â¤ò²Ã¤¨¤ë¤«¤â¤·¤ì¤Ê¤¤
("cpuset" µ¡¹½¤Ë¤Ä¤¤¤Æ¤Ï
.BR cpuset (7)
¤ò»²¾È)¡£
¥×¥í¥»¥¹¤¬Æ°ºî¤¹¤ë¼ÂºÝ¤Î CPU ½¸¹ç¤ËÂФ¹¤ëÀ©¸Â¤Ï¥«¡¼¥Í¥ë¤Ë¤è¤ê
°ÅÌۤΤ¦¤Á¤ËŬÍѤµ¤ì¤ë¡£

.BR sched_setscheduler (2)
¤Ë¤Ï Linux ¤Ë¤ª¤±¤ë¥¹¥±¥¸¥å¡¼¥ê¥ó¥°µ¡¹½¤Ë¤Ä¤¤¤Æ¤ÎÀâÌÀ¤¬¤¢¤ë¡£
.PP
¼ÂºÝ¤Ë¤Ï affinity ¥Þ¥¹¥¯¤Ï¥¹¥ì¥Ã¥Éñ°Ì¤Î°À­¤Ç¡¢¥¹¥ì¥Ã¥É¥°¥ë¡¼¥×¤Î
³Æ¥¹¥ì¥Ã¥Éñ°Ì¤ËÆÈΩ¤·¤ÆÄ´À°¤¹¤ë¤³¤È¤¬¤Ç¤­¤ë¡£
.BR gettid (2)
¥³¡¼¥ë¤«¤é¤ÎÊÖ¤êÃͤò¤³¤Î¥³¡¼¥ë¤Î
.I pid
°ú¤­¿ô¤È¤·¤ÆÅϤ¹¤³¤È¤¬¤Ç¤­¤ë¡£
.I pid
¤Ë 0 ¤ò»ØÄꤹ¤ë¤È¸Æ¤Ó½Ð¤·¸µ¤Î¥¹¥ì¥Ã¥É¤Î°À­¤¬ÀßÄꤵ¤ì¡¢
.BR getpid (2)
¥³¡¼¥ë¤«¤é¤ÎÊÖ¤êÃͤò
.I pid
¤Ë»ØÄꤹ¤ë¤È¥¹¥ì¥Ã¥É¥°¥ë¡¼¥×¤Î¥á¥¤¥ó¥¹¥ì¥Ã¥É¤Î°À­¤¬ÀßÄꤵ¤ì¤ë
(POSIX ¥¹¥ì¥Ã¥É API ¤ò»ÈÍѤ·¤Æ¤¤¤ë¾ì¹ç¡¢
.BR sched_setaffinity ()
¤ÎÂå¤ï¤ê¤Ë
.BR pthread_setaffinity_np (3)
¤ò»ÈÍѤ¹¤ë¤³¤È)¡£

.BR fork (2)
·Ðͳ¤ÇÀ¸À®¤µ¤ì¤¿»Ò¥×¥í¥»¥¹¤Ï¿Æ¥×¥í¥»¥¹¤Î CPU affinity ¥Þ¥¹¥¯¤ò·Ñ¾µ¤¹¤ë¡£
affinity ¥Þ¥¹¥¯¤Ï
.BR execve (2)
¤ÎÁ°¸å¤ÇÊݸ¤µ¤ì¤ë¡£

¤³¤Î¥Þ¥Ë¥å¥¢¥ë¥Ú¡¼¥¸¤Ç¤Ï CPU affinity ¥³¡¼¥ë¤Î glibc ¥¤¥ó¥¿¥Õ¥§¡¼¥¹¤ò
ÀâÌÀ¤·¤Æ¤¤¤ë¡£¼ÂºÝ¤Î¥·¥¹¥Æ¥à¥³¡¼¥ë¡¦¥¤¥ó¥¿¥Õ¥§¡¼¥¹¤Ï¾¯¤·°ã¤Ã¤Æ¤ª¤ê¡¢
¼ÂºÝ¤Î¼ÂÁõ¤Ç¤Ï CPU ½¸¹ç¤Ï´Êñ¤Ê¥Ó¥Ã¥È¥Þ¥¹¥¯¤Ç¤¢¤ë¤È¤¤¤¦¼Â¾õ¤òÈ¿±Ç¤·¡¢
.I mask
¤Î·¿¤¬
.IR "unsigned long *"
¤È¤Ê¤Ã¤Æ¤¤¤ë¡£
À®¸ù»þ¤Ë¤Ï¡¢À¸¤Î
.BR sched_getaffinity ()
¥·¥¹¥Æ¥à¥³¡¼¥ë¼«¿È¤Ï
.I cpumask_t
¥Ç¡¼¥¿·¿¤Î (¥Ð¥¤¥Èñ°Ì¤Î) Â礭¤µ¤òÊÖ¤¹¡£
.I cpumask_t
¤Ï¥«¡¼¥Í¥ëÆâÉô¤Ç CPU ½¸¹ç¤Î¥Ó¥Ã¥È¥Þ¥¹¥¯¤òɽ¸½¤¹¤ë¤Î¤Ë
»È¤ï¤ì¤Æ¤¤¤ë¥Ç¡¼¥¿·¿¤Ç¤¢¤ë¡£
.SH ´ØÏ¢¹àÌÜ
.BR clone (2),
.BR getcpu (2),
.BR getpriority (2),
.BR gettid (2),
.BR nice (2),
.BR sched_get_priority_max (2),
.BR sched_get_priority_min (2),
.BR sched_getscheduler (2),
.BR sched_setscheduler (2),
.BR setpriority (2),
.BR CPU_SET (3),
.BR pthread_setaffinity_np (3),
.BR sched_getcpu (3),
.BR capabilities (7),
.BR cpuset (7)