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 ¤È¤¤¤¦Ê¸»úÎó¤¬ÉÕ²Ã¤µ¤ì¤ë¤³¤È¤¬¤¢¤ë¡£