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 .\"*******************************************************************
  30 .\"
  31 .\" This file was generated with po4a. Translate the source file.
  32 .\"
  33 .\"*******************************************************************
  34 .TH SYSLOG 2 2012\-05\-05 Linux "Linux Programmer's Manual"
  35 .SH 名前
  36 syslog, klogctl \- カーネルのメッセージ・リング・バッファを読んだり消去したりする; console_loglevel の設定を行う
  37 .SH 書式
  38 .nf
  39 \fBint syslog(int \fP\fItype\fP\fB, char *\fP\fIbufp\fP\fB, int \fP\fIlen\fP\fB);\fP
  40 \fB/* glibc ではラッパー関数は提供されていない */\fP
  41 .sp
  42 /* glibc のインタフェース */
  43 .br
  44 \fB#include <sys/klog.h>\fP
  45 .sp
  46 \fBint klogctl(int \fP\fItype\fP\fB, char *\fP\fIbufp\fP\fB, int \fP\fIlen\fP\fB);\fP
  47 .fi
  48 .SH 説明
  49 (\fBsyslogd\fP(8) と話す) C ライブラリ関数の \fBsyslog\fP() が必要な場合は、
  50 \fBsyslog\fP(3) を見ること。この名前のシステム・コールはカーネルの
  51 \fIprintk\fP() バッファを制御するものであり、glibc ラッパー関数は
  52 \fBklogctl\fP() と呼ばれている。
  53
  54 \fItype\fP 引き数はこの関数の動作を決定する。以下を指定できる。
  55
  56 .nf
  57       0 \-\- ログを閉じる。現在の実装では何もしない (NOP) 。
  58       1 \-\- ログを開く。現在の実装では何もしない (NOP) 。
  59       2 \-\- ログから読み出す。
  60       3 \-\- リング・バッファに残っているメッセージをすべて読み出す。
  61       4 \-\- リング・バッファに残っているメッセージをすべて読み出し、消去する。
  62       5 \-\- リングバッファを消去する。
  63       6 \-\- コンソールへの printk を無効にする。
  64       7 \-\- コンソールへの printk を有効にする。
  65       8 \-\- コンソールに表示されるメッセージのレベルを設定する。
  66       9 \-\- ログバッファの未読の文字数を返す。
  67       10 \-\- ログバッファのサイズを返す。
  68 .fi
  69
  70 type 9 は Linux 2.4.10 で追加された。
  71 type 10 は Linux 2.6.6 で追加された。
  72
  73 バージョン 2.6.37 より前の Linux カーネルでは、
  74 コマンド種別 3 と 10 だけが非特権プロセスに対して許可されている。
  75 Linux 2.6.37 以降では、\fI/proc/sys/kernel/dmesg_restrict\fP が値 0 の場合に
  76 コマンド種別 3 と 10 だけが非特権プロセスに対して許可される。
  77 Linux 2.6.37 より前では、「特権を持つ (privileged)」とは呼び出し者が
  78 \fBCAP_SYS_ADMIN\fP ケーパビリティを持つことを意味する。
  79 Linux 2.6.37 以降では、「特権を持つ」とは呼び出し者が
  80 \fBCAP_SYS_ADMIN\fP ケーパビリティか
  81 (新しい) \fBCAP_SYSLOG\fP ケーパビリティのいずれかを持つことを意味する
  82 (この目的で \fBCAP_SYS_ADMIN\fP ケーパビリティを使うのは今は非推奨である)。
  83 .SS "カーネル・ログ・バッファ (kernel log buffer)"
  84 .\" Under "General setup" ==> "Kernel log buffer size"
  85 .\" For 2.6, precisely the option seems to have appeared in 2.5.55.
  86 カーネルは長さ \fBLOG_BUF_LEN\fP の巡回式のバッファを持っており、 それにはカーネル関数の \fBprintk\fP()
  87 の引き数として与えられた メッセージが (そのログレベルにかかわらず) 格納される。 初期のカーネルでは \fBLOG_BUF_LEN\fP の値は 4096
  88 であった。 カーネル 1.3.54 からは 8192、 カーネル 2.1.113 からは 16384 になり、 カーネル 2.4.23 以降および
  89 2.6 以降ではカーネルのコンパイル時に 値を設定できるようになっている。 最近のカーネルでは、コマンド 10 でバッファのサイズを問い合わせできる。
  90
  91 \fIsyslog(2,buf,len)\fP の呼び出しはカーネル・ログ・バッファが空でなくなるまで待って、 最大 \fIlen\fP バイトまで \fIbuf\fP
  92 へと読み出し、読み込んだ バイト数を返す。ログから読まれたバイトはログ・バッファから消える: 情報は一度しか読むことができない。
  93 これはユーザーのプログラムが \fI/proc/kmsg\fP を読んだ時にカーネルによって実行される関数でもある。
  94
  95 \fIsyslog(3,buf,len)\fP の呼び出しはログ・バッファの最後の \fIlen\fP バイトを
  96 (非破壊的に)読み出す、しかし、直近の「リング・バッファ消去」命令 (この命令はバッファを消去するわけではない)
  97 以降にバッファに書き込まれた情報しか読み出せない。 返り値は読み込んだバイト数である。
  98
  99 \fIsyslog(4,buf,len)\fP 呼び出しは「リング・バッファ消去」命令も実行する以外は 機能 3 と完全に同じである。
 100
 101 \fIsyslog(5,dummy,dummy)\fP 呼び出しは「リング・バッファ消去」命令のみを実行する (呼び出しの書式で、 \fIbuf\fP や
 102 \fIlen\fP が "dummy" と記載されている場合、その引き数の値が無視されることを表す)。
 103
 104 \fIsyslog(6,dummy,dummy)\fP 呼び出しはコンソールのログレベルを最小に設定し、 コンソールにメッセージが表示されないようにする。
 105
 106 \fIsyslog(7,dummy,dummy)\fP 呼び出しはコンソールのログレベルをデフォルトに設定し、 コンソールにメッセージが表示されるようにする。
 107
 108 \fIsyslog(8,dummy,level)\fP 呼び出しはコンソールのログレベルを \fIlevel\fP に設定する。 \fIlevel\fP は 1 以上 8
 109 以下の整数でなければならない。 詳細は \fBログレベル (loglevel)\fP の節を参照のこと。
 110
 111 \fIsyslog(9,dummy,dummy)\fP 呼び出しはカーネル・ログバッファにある現在読み出し可能なバイト数を返す。
 112
 113 \fIsyslog(10,dummy,dummy)\fP 呼び出しはカーネル・ログバッファの総量を返す。
 114 .SS "ログレベル (loglevel)"
 115 カーネル・ルーチンの \fBprintk\fP()  は、ログレベルが \fIconsole_loglevel\fP
 116 変数より小さいときにのみ、コンソールにメッセージを表示する。 \fIconsole_loglevel\fP は最初
 117 \fBDEFAULT_CONSOLE_LOGLEVEL\fP (7) に設定されるが、起動時にカーネルの コマンド・ライン・オプションに "debug"
 118 という単語が含まれている場合は 10 に設定され、カーネル・フォールトが発生した場合には 15 に設定される (但し、10 や 15
 119 という数字に意味はなく、8 と同等である)。 この変数は \fIsyslog(8,dummy,value)\fP.  呼び出しによって設定され、値の範囲は
 120 1\-8 である。 \fIsyslog(type,dummy,dummy)\fP 呼び出しで \fItype\fP が 6 もしくは 7 の場合、
 121 console_loglevel は 1 (カーネル・パニックのみ)、 7 (デバッグ・メッセージ以外の全て) にそれぞれ設定される。
 122
 123 メッセージの各行はそれぞれにログレベルを持つ。このログレベルは \fIDEFAULT_MESSAGE_LOGLEVEL \- 1\fP (6) であるが、
 124 <d> (\fId\fP は 1\-7 の範囲の数字) で始まる行の ログレベルは \fId\fP である。 ログレベルの慣習的な意味は
 125 \fI<linux/kernel.h>\fP に以下のように定義されている:
 126
 127 .nf
 128 #define KERN_EMERG    "<0>"  /* システムが使用不能         */
 129 #define KERN_ALERT    "<1>"  /* 直ちに対処が必要            */
 130 #define KERN_CRIT     "<2>"  /* 致命的な状態                  */
 131 #define KERN_ERR      "<3>"  /* エラー状態                     */
 132 #define KERN_WARNING  "<4>"  /* 警告状態                        */
 133 #define KERN_NOTICE   "<5>"  /* 通常状態だが大事な情報           */
 134 #define KERN_INFO     "<6>"  /* 通知                              */
 135 #define KERN_DEBUG    "<7>"  /* デバッグレベルの情報        */
 136 .fi
 137 .SH 返り値
 138 \fItype\fP が 2, 3, 4 の場合、成功すると \fBsyslog\fP()  は読み出したバイト数を返す。 \fItype\fP が 9 の場合、
 139 カーネル・ログバッファにある現在読み出し可能なバイト数を返す。 \fItype\fP が 10 の場合、 カーネル・ログバッファの総量を返す。 \fItype\fP
 140 がそれ以外の値の場合、成功すると 0 が返される。
 141
 142 エラーの場合は、\-1\ が返り、 \fIerrno\fP にエラーを示す値が設定される。
 143 .SH エラー
 144 .TP
 145 \fBEINVAL\fP
 146 不正な引き数 (具体的には、 \fItype\fP が正しくない、もしくは \fItype\fP が 2, 3, 4 の場合に \fIbuf\fP が NULL か
 147 \fIlen\fP が 0 未満である、もしくは \fItype\fP が 8 の場合に \fIlevel\fP が 1 以上 8 以下の範囲に入っていない)。
 148 .TP
 149 \fBENOSYS\fP
 150 カーネルの設定オプション \fBCONFIG_PRINTK\fP を無効にしてカーネルがコンパイルされているため、 \fBsyslog\fP()
 151 システムコールが利用できない。
 152 .TP
 153 \fBEPERM\fP
 154 十分な権限を持たないプロセス (正確にはケーパビリティ \fBCAP_SYS_ADMIN\fP も
 155 \fBCAP_SYSLOG\fP も持たないプロセス) が console_loglevel を変更しようとしたか、
 156 カーネル・メッセージ・リングを消去しようとした。
 157 .TP
 158 \fBERESTARTSYS\fP
 159 システム・コールがシグナルによって割り込まれ、何も読み出せなかった。 (トレース中にしか発生することはない)
 160 .SH 準拠
 161 このシステム・コールは Linux 特有であり、移植を意図したプログラムでは 使用してはいけない。
 162 .SH 注意
 163 .\" In libc4 and libc5 the number of this call was defined by
 164 .\" .BR SYS_klog .
 165 .\" In glibc 2.0 the syscall is baptized
 166 .\" .BR klogctl ().
 167 かなり初期の頃から、同じ名前を持つシステムコールとライブラリルーチンが
 168 全く異なる別物であるのは不幸なことだと指摘されてきた。
 169 .SH 関連項目
 170 \fBsyslog\fP(3), \fBcapabilities\fP(7)
 171 .SH この文書について
 172 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.41 の一部
 173 である。プロジェクトの説明とバグ報告に関する情報は
 174 http://www.kernel.org/doc/man\-pages/ に書かれている。