]>
Commit | Line | Data |
---|---|---|
fea681da MK |
1 | .\" Copyright (C) 2003 John Levon <levon@movementarian.org> |
2 | .\" | |
93015253 | 3 | .\" %%%LICENSE_START(VERBATIM) |
fea681da MK |
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. | |
c13182ef | 12 | .\" |
fea681da MK |
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. | |
c13182ef | 20 | .\" |
fea681da MK |
21 | .\" Formatted or processed versions of this manual, if unaccompanied by |
22 | .\" the source, must acknowledge the copyright and authors of this work. | |
4b72fb64 | 23 | .\" %%%LICENSE_END |
fea681da | 24 | .\" |
c11b1abf | 25 | .\" Modified 2004-06-17 Michael Kerrisk <mtk.manpages@gmail.com> |
fea681da | 26 | .\" |
4b8c67d9 | 27 | .TH LOOKUP_DCOOKIE 2 2017-09-15 "Linux" "Linux Programmer's Manual" |
fea681da MK |
28 | .SH NAME |
29 | lookup_dcookie \- return a directory entry's path | |
30 | .SH SYNOPSIS | |
b9f02710 | 31 | .BI "int lookup_dcookie(u64 " cookie ", char *" buffer ", size_t " len ); |
fea681da MK |
32 | .SH DESCRIPTION |
33 | Look up the full path of the directory entry specified by the value | |
ce28864c | 34 | .IR cookie . |
c13182ef MK |
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. | |
efeece04 | 38 | .PP |
fea681da | 39 | For |
e511ffb6 | 40 | .BR lookup_dcookie () |
c13182ef | 41 | to return successfully, |
fea681da | 42 | the kernel must still hold a cookie reference to the directory entry. |
47297adb | 43 | .SH RETURN VALUE |
fea681da | 44 | On success, |
e511ffb6 | 45 | .BR lookup_dcookie () |
fea681da MK |
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 | |
c13182ef | 67 | The process does not have the capability |
fea681da MK |
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. | |
a759cc87 MK |
73 | .SH VERSIONS |
74 | Available since Linux 2.5.43. | |
682edefb | 75 | The |
0daa9e92 | 76 | .B ENAMETOOLONG |
682edefb | 77 | error return was added in 2.5.70. |
47297adb | 78 | .SH CONFORMING TO |
a1d5f77c | 79 | .BR lookup_dcookie () |
8382f16d | 80 | is Linux-specific. |
47297adb | 81 | .SH NOTES |
a1d5f77c | 82 | .BR lookup_dcookie () |
9484e1a3 MK |
83 | is a special-purpose system call, currently used only by the |
84 | .BR oprofile (1) | |
85 | profiler. | |
a1d5f77c | 86 | It relies on a kernel driver to register cookies for directory entries. |
efeece04 | 87 | .PP |
a1d5f77c MK |
88 | The path returned may be suffixed by the string " (deleted)" if the directory |
89 | entry has been removed. | |
d133313f MK |
90 | .SH SEE ALSO |
91 | .BR oprofile (1) |