man2/lookup_dcookie.2

   1 .\" Copyright (C) 2003 John Levon <levon@movementarian.org>
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .\" Modified 2004-06-17 Michael Kerrisk <mtk.manpages@gmail.com>
  26 .\"
  27 .TH LOOKUP_DCOOKIE 2 2016-07-17 "Linux" "Linux Programmer's Manual"
  28 .SH NAME
  29 lookup_dcookie \- return a directory entry's path
  30 .SH SYNOPSIS
  31 .BI "int lookup_dcookie(u64 " cookie ", char *" buffer ", size_t " len );
  32 .SH DESCRIPTION
  33 Look up the full path of the directory entry specified by the value
  34 .IR cookie .
  35 The cookie is an opaque identifier uniquely identifying a particular
  36 directory entry.
  37 The buffer given is filled in with the full path of the directory entry.
  38
  39 For
  40 .BR lookup_dcookie ()
  41 to return successfully,
  42 the kernel must still hold a cookie reference to the directory entry.
  43 .SH RETURN VALUE
  44 On success,
  45 .BR lookup_dcookie ()
  46 returns the length of the path string copied into the buffer.
  47 On error, \-1 is returned, and
  48 .I errno
  49 is set appropriately.
  50 .SH ERRORS
  51 .TP
  52 .B EFAULT
  53 The buffer was not valid.
  54 .TP
  55 .B EINVAL
  56 The kernel has no registered cookie/directory entry mappings at the
  57 time of lookup, or the cookie does not refer to a valid directory entry.
  58 .TP
  59 .B ENAMETOOLONG
  60 The name could not fit in the buffer.
  61 .TP
  62 .B ENOMEM
  63 The kernel could not allocate memory for the temporary buffer holding
  64 the path.
  65 .TP
  66 .B EPERM
  67 The process does not have the capability
  68 .B CAP_SYS_ADMIN
  69 required to look up cookie values.
  70 .TP
  71 .B ERANGE
  72 The buffer was not large enough to hold the path of the directory entry.
  73 .SH VERSIONS
  74 Available since Linux 2.5.43.
  75 The
  76 .B ENAMETOOLONG
  77 error return was added in 2.5.70.
  78 .SH CONFORMING TO
  79 .BR lookup_dcookie ()
  80 is Linux-specific.
  81 .SH NOTES
  82 .BR lookup_dcookie ()
  83 is a special-purpose system call, currently used only by the
  84 .BR oprofile (1)
  85 profiler.
  86 It relies on a kernel driver to register cookies for directory entries.
  87
  88 The path returned may be suffixed by the string " (deleted)" if the directory
  89 entry has been removed.
  90 .SH SEE ALSO
  91 .BR oprofile (1)