release/man2/syslog.2

   1 .\" Copyright (C) 1995 Andries Brouwer (aeb@cwi.nl)
   2 .\"
   3 .\" Permission is granted to make and distribute verbatim copies of this
   4 .\" manual provided the copyright notice and this permission notice are
   5 .\" preserved on all copies.
   6 .\"
   7 .\" Permission is granted to copy and distribute modified versions of this
   8 .\" manual under the conditions for verbatim copying, provided that the
   9 .\" entire resulting derived work is distributed under the terms of a
  10 .\" permission notice identical to this one.
  11 .\"
  12 .\" Since the Linux kernel and libraries are constantly changing, this
  13 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  14 .\" responsibility for errors or omissions, or for damages resulting from
  15 .\" the use of the information contained herein.  The author(s) may not
  16 .\" have taken the same level of care in the production of this manual,
  17 .\" which is licensed free of charge, as they might when working
  18 .\" professionally.
  19 .\"
  20 .\" Formatted or processed versions of this manual, if unaccompanied by
  21 .\" the source, must acknowledge the copyright and authors of this work.
  22 .\"
  23 .\" Written 11 June 1995 by Andries Brouwer <aeb@cwi.nl>
  24 .\" 2008-02-15, Jeremy Kerr <jk@ozlabs.org>
  25 .\"     Add info on command type 10; add details on types 6, 7, 8, & 9.
  26 .\" 2008-02-15, Michael Kerrisk <mtk.manpages@gmail.com>
  27 .\"     Update LOG_BUF_LEN details; update RETURN VALUE section.
  28 .\"
  29 .\" Japanese Version Copyright (c) 1997 HANATAKA Shinya
  30 .\"         all rights reserved.
  31 .\" Translated Mon Dec 16 11:16:34 JST 2001
  32 .\"         by HANATAKA Shinya <hanataka@abyss.rim.or.jp>
  33 .\" Updated Thu Mar 6 2003 by Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
  34 .\" Updated 2005-09-06, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
  35 .\" Updated 2008-04-04, Akihiro MOTOKI, LDP v2.79
  36 .\" Updated 2008-07-31, Akihiro MOTOKI, LDP v3.05
  37 .\"
  38 .\"WORD:        kernel                  カーネル
  39 .\"WORD:        message ring buffer     メッセージ・リング・バッファ
  40 .\"WORD:        library                 ライブラリ
  41 .\"WORD:        kernel log buffer       カーネル・ログ・バッファ
  42 .\"WORD:        console                 コンソール
  43 .\"WORD:        kernel panic            カーネル・パニック
  44 .\"WORD:        loglevel                ログレベル
  45 .\"WORD:        debug message           デバッグ・メッセージ
  46 .\"
  47 .TH SYSLOG 2  2008-06-20 "Linux" "Linux Programmer's Manual"
  48 .SH 名前
  49 syslog, klogctl \- カーネルのメッセージ・リング・バッファを読んだり消去したりする;
  50 console_loglevel の設定を行う
  51 .SH 書式
  52 .nf
  53 .BI "int syslog(int " type ", char *" bufp ", int " len );
  54 .B  "                /* glibc ではラッパー関数は提供されていない */"
  55 .sp
  56 /* glibc のインタフェース */
  57 .br
  58 .B "#include <sys/klog.h>"
  59 .sp
  60 .BI "int klogctl(int " type ", char *" bufp ", int " len );
  61 .fi
  62 .SH 説明
  63 .RB ( syslogd (8)
  64 と話す) C ライブラリ関数の
  65 .BR syslog ()
  66 が必要な場合は、
  67 .BR syslog (3)
  68 を見ること。
  69 この名前のシステム・コールはカーネルの
  70 .IR printk ()
  71 バッファを制御するものであり、glibc では
  72 .BR klogctl ()
  73 と呼ばれている。
  74
  75 \fItype\fP 引き数はこの関数の動作を決定する。
  76
  77 .I kernel/printk.c
  78 からの引用 :
  79 .nf
  80 /*
  81  * Commands to sys_syslog:
  82  *
  83  *      0 \-\- ログを閉じる。現在の実装では何もしない (NOP) 。
  84  *      1 \-\- ログを開く。現在の実装では何もしない (NOP) 。
  85  *      2 \-\- ログから読み出す。
  86  *      3 \-\- リング・バッファに残っているメッセージをすべて読み出す。
  87  *      4 \-\- リング・バッファに残っているメッセージをすべて読み出し、消去する。
  88  *      5 \-\- リングバッファを消去する。
  89  *      6 \-\- コンソールへの printk を無効にする。
  90  *      7 \-\- コンソールへの printk を有効にする。
  91  *      8 \-\- コンソールに表示されるメッセージのレベルを設定する。
  92  *      9 \-\- ログバッファの未読の文字数を返す。
  93  *      10 \-\- ログバッファのサイズを返す。
  94  */
  95 .fi
  96
  97 非特権プロセスにはコマンド 3 と 10 のみが許可されている
  98 (コマンド 9 は Linux 2.4.10 で、コマンド 10 は Linux 2.6.6 で追加された)。
  99 .SS カーネル・ログ・バッファ (kernel log buffer)
 100 カーネルは長さ
 101 .B LOG_BUF_LEN
 102 の巡回式のバッファを持っており、
 103 それにはカーネル関数の
 104 .BR printk ()
 105 の引き数として与えられた
 106 メッセージが (そのログレベルにかかわらず) 格納される。
 107 初期のカーネルでは
 108 .B LOG_BUF_LEN
 109 の値は 4096 であった。
 110 カーネル 1.3.54 からは 8192、
 111 カーネル 2.1.113 からは 16384 になり、
 112 カーネル 2.4.23 以降および 2.6 以降ではカーネルのコンパイル時に
 113 値を設定できるようになっている。
 114 .\" Under "General setup" ==> "Kernel log buffer size"
 115 .\" For 2.6, precisely the option seems to have appeared in 2.5.55.
 116 最近のカーネルでは、コマンド 10 でバッファのサイズを問い合わせできる。
 117
 118 .I "syslog(2,buf,len)"
 119 の呼び出しはカーネル・ログ・バッファが空でなくなるまで待って、
 120 最大 \fIlen\fP バイトまで \fIbuf\fP へと読み出し、読み込んだ
 121 バイト数を返す。ログから読まれたバイトはログ・バッファから消える:
 122 情報は一度しか読むことができない。
 123 これはユーザーのプログラムが
 124 .I /proc/kmsg
 125 を読んだ時にカーネルによって実行される関数でもある。
 126
 127 .I syslog(3,buf,len)
 128 の呼び出しはログ・バッファの最後の \fIlen\fP バイトを
 129 (非破壊的に)読み出す、しかし、直近の「リング・バッファ消去」命令
 130 (この命令はバッファを消去するわけではない)
 131 以降にバッファに書き込まれた情報しか読み出せない。
 132 返り値は読み込んだバイト数である。
 133
 134 .I syslog(4,buf,len)
 135 呼び出しは「リング・バッファ消去」命令も実行する以外は
 136 機能 3 と完全に同じである。
 137
 138 .I syslog(5,dummy,dummy)
 139 呼び出しは「リング・バッファ消去」命令のみを実行する
 140 (呼び出しの書式で、
 141 .I buf
 142 や
 143 .I len
 144 が "dummy" と記載されている場合、その引き数の値が無視されることを表す)。
 145
 146 .I syslog(6,dummy,dummy)
 147 呼び出しはコンソールのログレベルを最小に設定し、
 148 コンソールにメッセージが表示されないようにする。
 149
 150 .I syslog(7,dummy,dummy)
 151 呼び出しはコンソールのログレベルをデフォルトに設定し、
 152 コンソールにメッセージが表示されるようにする。
 153
 154 .I syslog(8,dummy,level)
 155 呼び出しはコンソールのログレベルを
 156 .I level
 157 に設定する。
 158 .I level
 159 は 1 以上 8 以下の整数でなければならない。
 160 詳細は
 161 .B ログレベル (loglevel)
 162 の節を参照のこと。
 163
 164 .I syslog(9,dummy,dummy)
 165 呼び出しはカーネル・ログバッファにある現在読み出し可能なバイト数を返す。
 166
 167 .I syslog(10,dummy,dummy)
 168 呼び出しはカーネル・ログバッファの総量を返す。
 169 .SS ログレベル (loglevel)
 170 カーネル・ルーチンの
 171 .BR printk ()
 172 は、ログレベルが
 173 .I console_loglevel
 174 変数より小さいときにのみ、コンソールにメッセージを表示する。
 175 .I console_loglevel
 176 は最初
 177 .B DEFAULT_CONSOLE_LOGLEVEL
 178 (7) に設定されるが、起動時にカーネルの
 179 コマンド・ライン・オプションに "debug" という単語が含まれている場合は
 180 10 に設定され、カーネル・フォールトが発生した場合には 15 に設定される
 181 (但し、10 や 15 という数字に意味はなく、8 と同等である)。
 182 この変数は
 183 .IR syslog(8,dummy,value) .
 184 呼び出しによって設定され、値の範囲は 1-8 である。
 185 .I syslog(type,dummy,dummy)
 186 呼び出しで \fItype\fP が 6 もしくは 7 の場合、
 187 console_loglevel は 1 (カーネル・パニックのみ)、
 188 7 (デバッグ・メッセージ以外の全て) にそれぞれ設定される。
 189
 190 メッセージの各行はそれぞれにログレベルを持つ。このログレベルは
 191 .I "DEFAULT_MESSAGE_LOGLEVEL \- 1"
 192 (6) であるが、 <d> (\fId\fP は 1-7 の範囲の数字) で始まる行の
 193 ログレベルは \fId\fP である。
 194 ログレベルの慣習的な意味は
 195 .I <linux/kernel.h>
 196 に以下のように定義されている:
 197
 198 .nf
 199 #define KERN_EMERG    "<0>"  /* システムが使用不能         */
 200 #define KERN_ALERT    "<1>"  /* 直ちに対処が必要            */
 201 #define KERN_CRIT     "<2>"  /* 致命的な状態                  */
 202 #define KERN_ERR      "<3>"  /* エラー状態                     */
 203 #define KERN_WARNING  "<4>"  /* 警告状態                        */
 204 #define KERN_NOTICE   "<5>"  /* 通常状態だが大事な情報           */
 205 #define KERN_INFO     "<6>"  /* 通知                              */
 206 #define KERN_DEBUG    "<7>"  /* デバッグレベルの情報        */
 207 .fi
 208 .SH 返り値
 209 \fItype\fP が 2, 3, 4 の場合、成功すると
 210 .BR syslog ()
 211 は読み出したバイト数を返す。
 212 \fItype\fP が 9 の場合、
 213 カーネル・ログバッファにある現在読み出し可能なバイト数を返す。
 214 \fItype\fP が 10 の場合、
 215 カーネル・ログバッファの総量を返す。
 216 \fItype\fP がそれ以外の値の場合、成功すると 0 が返される。
 217
 218 エラーの場合は、\-1\ が返り、
 219 \fIerrno\fP にエラーを示す値が設定される。
 220 .SH エラー
 221 .TP
 222 .B EINVAL
 223 不正な引き数
 224 (具体的には、
 225 .I type
 226 が正しくない、もしくは
 227 .I type
 228 が 2, 3, 4 の場合に
 229 .I buf
 230 が NULL か
 231 .I len
 232 が 0 未満である、もしくは
 233 .I type
 234 が 8 の場合に
 235 .I level
 236 が 1 以上 8 以下の範囲に入っていない)。
 237 .TP
 238 .B ENOSYS
 239 カーネルの設定オプション
 240 .BR CONFIG_PRINTK
 241 を無効にしてカーネルがコンパイルされているため、
 242 .BR syslog ()
 243 システムコールが利用できない。
 244 .TP
 245 .B EPERM
 246 十分な権限を持たないプロセス (正確には
 247 .B CAP_SYS_ADMIN
 248 ケーパビリティを持たないプロセス) が console_loglevelを変更しようとしたか、
 249 カーネル・メッセージ・リングを消去しようとした。
 250 .TP
 251 .B ERESTARTSYS
 252 システム・コールがシグナルによって割り込まれ、何も読み出せなかった。
 253 (トレース中にしか発生することはない)
 254 .SH 準拠
 255 このシステム・コールは Linux 特有であり、移植を意図したプログラムでは
 256 使用してはいけない。
 257 .SH 注意
 258 かなり初期の頃から、同じ名前を持つシステム・コールと
 259 ライブラリ・ルーチンが全く異なる代物であるのは不幸なことだと
 260 気付かれていた。
 261 libc4 と libc5 ではこのコールの番号は
 262 .B SYS_klog
 263 と定義されていた。
 264 glibc2.0 でこのシステムコールは
 265 .BR klogctl ()
 266 という名前に改められた。
 267 .SH 関連項目
 268 .BR syslog (3)