draft/man2/lookup_dcookie.2

   1 .\" Hey Emacs! This file is -*- nroff -*- source.
   2 .\"
   3 .\" Copyright (C) 2003 John Levon <levon@movementarian.org>
   4 .\"
   5 .\" Permission is granted to make and distribute verbatim copies of this
   6 .\" manual provided the copyright notice and this permission notice are
   7 .\" preserved on all copies.
   8 .\"
   9 .\" Permission is granted to copy and distribute modified versions of this
  10 .\" manual under the conditions for verbatim copying, provided that the
  11 .\" entire resulting derived work is distributed under the terms of a
  12 .\" permission notice identical to this one.
  13 .\"
  14 .\" Since the Linux kernel and libraries are constantly changing, this
  15 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  16 .\" responsibility for errors or omissions, or for damages resulting from
  17 .\" the use of the information contained herein.  The author(s) may not
  18 .\" have taken the same level of care in the production of this manual,
  19 .\" which is licensed free of charge, as they might when working
  20 .\" professionally.
  21 .\"
  22 .\" Formatted or processed versions of this manual, if unaccompanied by
  23 .\" the source, must acknowledge the copyright and authors of this work.
  24 .\"
  25 .\" Modified 2004-06-17 Michael Kerrisk <mtk.manpages@gmail.com>
  26 .\"
  27 .\" Japanese Version Copyright (c) 2003  Akihiro MOTOKI
  28 .\"         all rights reserved.
  29 .\" Translated 2003-06-04, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
  30 .\" Updated 2003-09-30, Akihiro MOTOKI
  31 .\" Updated 2005-02-10, Akihiro MOTOKI
  32 .\"
  33 .\"WORD:        opaque identifier       内部識別子
  34 .\"WORD:        Linux specific          Linux 独自
  35 .\"WORD:        capability              ケーパビリティ
  36 .\"
  37 .TH LOOKUP_DCOOKIE 2 2004-06-17 "Linux" "Linux Programmer's Manual"
  38 .\"O .SH NAME
  39 .SH 名前
  40 .\"O lookup_dcookie \- return a directory entry's path
  41 lookup_dcookie \- ディレクトリ・エントリのパス名を返す
  42 .\"O .SH SYNOPSIS
  43 .SH 書式
  44 .BI "int lookup_dcookie(u64 " cookie ", char *" buffer ", size_t " len );
  45 .\"O .SH DESCRIPTION
  46 .SH 説明
  47 .\"O Look up the full path of the directory entry specified by the value
  48 .\"O .IR cookie .
  49 .\"O The cookie is an opaque identifier uniquely identifying a particular
  50 .\"O directory entry.
  51 .\"O The buffer given is filled in with the full path of the directory entry.
  52 .I cookie
  53 値で指定されたディレクトリ・エントリのフルパス名を検索する。
  54 cookie は、個々のディレクトリ・エントリを区別する内部識別子 (opaque
  55 identifier) である。引き数で指定されたバッファに、ディレクトリ・エントリの
  56 フルパス名が格納される。
  57
  58 .\"O For
  59 .\"O .BR lookup_dcookie ()
  60 .\"O to return successfully,
  61 .\"O the kernel must still hold a cookie reference to the directory entry.
  62 .BR lookup_dcookie ()
  63 が正常に値を返すためには、カーネルがディレクトリ・エントリへの cookie 参照を
  64 保持していなければならない。
  65 .\"O .SH "RETURN VALUE"
  66 .SH 返り値
  67 .\"O On success,
  68 .\"O .BR lookup_dcookie ()
  69 .\"O returns the length of the path string copied into the buffer.
  70 .\"O On error, \-1 is returned, and
  71 .\"O .I errno
  72 .\"O is set appropriately.
  73 成功した場合、
  74 .BR lookup_dcookie ()
  75 はバッファにコピーしたパス文字列の長さを返す。
  76 エラーの場合は \-1 を返し、
  77 .I errno
  78 に適切な値を設定する。
  79 .\"O .SH ERRORS
  80 .SH エラー
  81 .TP
  82 .B EFAULT
  83 .\"O The buffer was not valid.
  84 バッファが有効でなかった。
  85 .TP
  86 .B EINVAL
  87 .\"O The kernel has no registered cookie/directory entry mappings at the
  88 .\"O time of lookup, or the cookie does not refer to a valid directory entry.
  89 検索が行われた時、cookie とディレクトリ・エントリのマッピングがカーネルに
  90 登録されていなかったか、または cookie が有効なディレクトリ・エントリを
  91 参照していない。
  92 .TP
  93 .B ENAMETOOLONG
  94 .\"O The name could not fit in the buffer.
  95 名前がバッファに入り切らなかった。
  96 .TP
  97 .B ENOMEM
  98 .\"O The kernel could not allocate memory for the temporary buffer holding
  99 .\"O the path.
 100 カーネルが、パス名を保持する一時バッファ用のメモリを割り当てることが
 101 できなかった。
 102 .TP
 103 .B EPERM
 104 .\"O The process does not have the capability
 105 .\"O .B CAP_SYS_ADMIN
 106 .\"O required to look up cookie values.
 107 プロセスが cookie 値を検索するのに必要なケーパビリティ
 108 .B CAP_SYS_ADMIN
 109 を持っていない。
 110 .TP
 111 .B ERANGE
 112 .\"O The buffer was not large enough to hold the path of the directory entry.
 113 バッファが、ディレクトリ・エントリのパス名を収容するのに
 114 十分な大きさではなかった。
 115 .\"O .SH VERSIONS
 116 .\"O Since Linux 2.5.43.
 117 .\"O The
 118 .\"O .B ENAMETOOLONG
 119 .\"O error return was added in 2.5.70.
 120 .SH バージョン
 121 Linux 2.5.43 以降で利用できる。
 122 エラー
 123 .B ENAMETOOLONG
 124 を返す仕様は 2.5.70 で追加された。
 125 .\"O .SH "CONFORMING TO"
 126 .SH 準拠
 127 .\"O .BR lookup_dcookie ()
 128 .\"O is Linux-specific.
 129 .BR lookup_dcookie ()
 130 は Linux 独自の関数である。
 131 .\"O .SH "NOTES"
 132 .SH 注意
 133 .\"O .BR lookup_dcookie ()
 134 .\"O is a special-purpose system call, currently used only by the oprofile profiler.
 135 .\"O It relies on a kernel driver to register cookies for directory entries.
 136 .BR lookup_dcookie ()
 137 は特殊な用途に使われるシステムコールで、現在のところ oprofile profiler で
 138 使われているだけである。
 139
 140 .\"O The path returned may be suffixed by the string " (deleted)" if the directory
 141 .\"O entry has been removed.
 142 指定されたディレクトリ・エントリが削除されていた場合、返されるパス名の最後に
 143 " (deleted)"
 144 という文字列が付加されることがある。