release/man2/getpriority.2

   1 .\" Copyright (c) 1980, 1991 The Regents of the University of California.
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)getpriority.2       6.9 (Berkeley) 3/10/91
  33 .\"
  34 .\" Modified 1993-07-24 by Rik Faith <faith@cs.unc.edu>
  35 .\" Modified 1996-07-01 by Andries Brouwer <aeb@cwi.nl>
  36 .\" Modified 1996-11-06 by Eric S. Raymond <esr@thyrsus.com>
  37 .\" Modified 2001-10-21 by Michael Kerrisk <mtk.manpages@gmail.com>
  38 .\"    Corrected statement under EPERM to clarify privileges required
  39 .\" Modified 2002-06-21 by Michael Kerrisk <mtk.manpages@gmail.com>
  40 .\"    Clarified meaning of 0 value for 'who' argument
  41 .\" Modified 2004-05-27 by Michael Kerrisk <mtk.manpages@gmail.com>
  42 .\"
  43 .\" FIXME Oct 2008: Denys Vlasenko is working on a PRIO_THREAD feature that
  44 .\" is likely to get included in mainline; this will need to be documented.
  45 .\"
  46 .\"*******************************************************************
  47 .\"
  48 .\" This file was generated with po4a. Translate the source file.
  49 .\"
  50 .\"*******************************************************************
  51 .TH GETPRIORITY 2 2008\-05\-29 Linux "Linux Programmer's Manual"
  52 .SH 名前
  53 getpriority, setpriority \- プログラムのスケジューリングの優先度を取得/設定する
  54 .SH 書式
  55 \fB#include <sys/time.h>\fP
  56 .br
  57 \fB#include <sys/resource.h>\fP
  58 .sp
  59 \fBint getpriority(int \fP\fIwhich\fP\fB, int \fP\fIwho\fP\fB);\fP
  60 .br
  61 \fBint setpriority(int \fP\fIwhich\fP\fB, int \fP\fIwho\fP\fB, int \fP\fIprio\fP\fB);\fP
  62 .SH 説明
  63 システムコール \fBgetpriority\fP()  や \fBsetpriority\fP()  は、 \fIwhich\fP と \fIwho\fP
  64 で指定されたプロセス、プロセスグループ、ユーザーの スケジューリング優先度 (scheduling priority) の 取得や設定をそれぞれ行う。
  65
  66 \fIwhich\fP の値は \fBPRIO_PROCESS\fP, \fBPRIO_PGRP\fP, \fBPRIO_USER\fP, のどれか一つで、 \fIwho\fP は
  67 \fIwhich\fP に応じて解釈される (\fBPRIO_PROCESS\fP だとプロセス識別子、 \fBPRIO_PGRP\fP だとプロセスグループ識別子、
  68 \fBPRIO_USER\fP だと UID (ユーザID) と解釈される)。 \fIwho\fP がゼロならば、(それぞれ)呼び出したプロセス、
  69 呼び出したプロセスのプロセスグループ、 呼び出したプロセスの実UID を意味する。 \fIprio\fP は \-20 から 19 の範囲の値で
  70 (但し以下の注意の項を参照のこと)、 デフォルトの優先度は 0 である; 小さな数字ほど、有利なスケジューリングとなる。
  71
  72 \fBgetpriority\fP()  コールは指定したプロセスの中の最も高い優先度 (数値的には最小の値) を返す。 \fBsetpriority\fP()
  73 コールは指定したプロセス全ての優先度を指定した値に設定する。 優先度を今より小さい値に設定できるのはスーパーユーザーだけである。
  74 .SH 返り値
  75 \fBgetpriority\fP()  は成功した場合にも \-1 の値を返す可能性があるので、 呼び出しの前に外部変数の \fIerrno\fP
  76 をクリアし、呼び出しの後に返り値の \-1 が正当な値か エラーかを判別する必要がある。 \fBsetpriority\fP()  コールはエラーがなければ 0
  77 を返し、エラーがあれば \-1 を返す。
  78 .SH エラー
  79 .TP
  80 \fBEINVAL\fP
  81 \fIwhich\fP が \fBPRIO_PROCESS\fP, \fBPRIO_PGRP\fP, \fBPRIO_USER\fP のいずれでもない。
  82 .TP
  83 \fBESRCH\fP
  84 \fIwhich\fP と \fIwho\fP で指定されたプロセスが存在しない。
  85 .PP
  86 上記のものに加えて \fBsetpriority\fP()  では以下のエラーがある:
  87 .TP
  88 \fBEACCES\fP
  89 呼び出し元がプロセスの優先度を下げようとしたが、必要な特権を 持っていなかった (Linux の場合、 \fBCAP_SYS_NICE\fP
  90 ケーパビリティがなかった)。 Linux 2.6.12 以降では、呼び出し元が、あるプロセスの優先度を、 変更対象のプロセスのリソース
  91 \fBRLIMIT_NICE\fP のソフトリミットの範囲外に設定しようとした場合にのみ、 このエラーが発生する。詳細は \fBgetrlimit\fP(2)
  92 を参照。
  93 .TP
  94 \fBEPERM\fP
  95 プロセスは見つかったが、そのプロセスの実効 (effective) UID が 呼び出し元の実効UID にも実 (real) UID にも一致せず、
  96 呼び出し元が特権も持っていなかった (Linux の場合、 \fBCAP_SYS_NICE\fP ケーパビリティがなかった)。 以下の「注意」も参照のこと。
  97 .SH 準拠
  98 SVr4, 4.4BSD (これらの関数は 4.2BSD で最初に登場した), POSIX.1\-2001.
  99 .SH 注意
 100 \fBfork\fP(2)  で作成された子プロセスは、 親プロセスの nice 値を継承する。 \fBexecve\fP(2)  の前後で nice
 101 値は保存される。
 102
 103 相対的な nice 値の違いがプロセス間のスケジューリングにどの程度影響を与えるか は、UNIX システム間で異なり、Linux
 104 ではカーネルバージョンにより異なる。 Linux は、カーネル 2.6.23 以降で、nice 値の相対的な違いが、非常に強い影響を
 105 与えるアルゴリズムを採用した。このアルゴリズムでは、 他に優先度の高いものがシステムに存在する時には、 非常に低い nice 値 (+19)
 106 ではプロセスに本当にほとんど CPU が割り当てられない。 また、高い nice 値 (\-20) では CPU を必要とするアプリケーション (例えば
 107 オーディオアプリケーション) に CPU のほとんどが割り当てられる。
 108
 109 \fBEPERM\fP が発生する条件の詳細はシステムに依存する。 上記の説明は POSIX.1\-2001 のものであり、全ての System V
 110 風システムは これに従っているようである。 2.6.12 より前の Linux カーネルでは、呼び出し元の実 UID または 実効 UID がプロセス
 111 \fIwho\fP の (実効 UID でなく)  実 UID に一致する必要がある。 Linux 2.6.12 以降では、呼び出し元の実行 UID
 112 がプロセス \fIwho\fP の実 UID か実効 UID のいずれかと一致する必要がある。 全ての BSD 風システム (SunOS 4.1.3,
 113 Ultrix 4.2, 4.3BSD, FreeBSD 4.3, OpenBSD\-2.5等) は、 Linux 2.6.12 以降と同じ動作をする。
 114 .LP
 115 実際の優先度の値の範囲はカーネルのバージョンによって異なる。 1.3.36 より前の Linux では、優先度の範囲は負の無限大 〜 15 である。
 116 1.3.43 以降の Linux では、優先度の範囲は \-20 〜 19 である。 カーネル内部では、nice 値は実際には 40 〜 1
 117 の範囲を使って 表現されており (負の値はエラーコードとなるため)、こちらの値が システムコール \fBsetpriority\fP()  と
 118 \fBgetpriority\fP()  で使用されている。 glibc のこれらのシステムコールのラッパー関数において、nice 値の ユーザ領域
 119 (user\-land) とカーネル表現の間の変換が行われる。 変換式は以下の通り: \fIunice\ =\ 20\ \-\ knice\fP
 120 .LP
 121 いくつかのシステムでは、nice 値の範囲は \20 〜 20 である。
 122 .LP
 123 現在では \fI<sys/time.h>\fP をインクルードする必要はないが、インクルードすれば移植性を高めることができる (実際には
 124 \fI<sys/resource.h>\fP で \fIrusage\fP 構造体が定義されているが、そのフィールドで使用されている
 125 \fIstruct timeval\fP 型は \fI<sys/time.h>\fP で定義されている)。
 126 .SH 関連項目
 127 \fBnice\fP(1), \fBrenice\fP(1), \fBfork\fP(2), \fBcapabilities\fP(7)
 128 .sp
 129 (Linux 2.6.23 以降の) カーネルのソースツリー内の
 130 \fIDocumentation/scheduler/sched\-nice\-design.txt\fP