man2/readlink.2

   1 .\" Copyright (c) 1983, 1991 The Regents of the University of California.
   2 .\" And Copyright (C) 2011 Guillem Jover <guillem@hadrons.org>
   3 .\" And Copyright (C) 2006, 2014 Michael Kerrisk
   4 .\" All rights reserved.
   5 .\"
   6 .\" %%%LICENSE_START(BSD_4_CLAUSE_UCB)
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\" 3. All advertising materials mentioning features or use of this software
  16 .\"    must display the following acknowledgement:
  17 .\"     This product includes software developed by the University of
  18 .\"     California, Berkeley and its contributors.
  19 .\" 4. Neither the name of the University nor the names of its contributors
  20 .\"    may be used to endorse or promote products derived from this software
  21 .\"    without specific prior written permission.
  22 .\"
  23 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33 .\" SUCH DAMAGE.
  34 .\" %%%LICENSE_END
  35 .\"
  36 .\"     @(#)readlink.2  6.8 (Berkeley) 3/10/91
  37 .\"
  38 .\" Modified Sat Jul 24 00:10:21 1993 by Rik Faith (faith@cs.unc.edu)
  39 .\" Modified Tue Jul  9 23:55:17 1996 by aeb
  40 .\" Modified Fri Jan 24 00:26:00 1997 by aeb
  41 .\" 2011-09-20, Guillem Jover <guillem@hadrons.org>:
  42 .\"     Added text on dynamically allocating buffer + example program
  43 .\"
  44 .TH READLINK 2 2021-03-22 "Linux" "Linux Programmer's Manual"
  45 .SH NAME
  46 readlink, readlinkat \- read value of a symbolic link
  47 .SH SYNOPSIS
  48 .nf
  49 .B #include <unistd.h>
  50 .PP
  51 .BI "ssize_t readlink(const char *restrict " pathname ", char *restrict " buf ,
  52 .BI "                 size_t " bufsiz );
  53 .PP
  54 .BR "#include <fcntl.h>            " "/* Definition of " AT_* " constants */"
  55 .B #include <unistd.h>
  56 .PP
  57 .BI "ssize_t readlinkat(int " dirfd ", const char *restrict " pathname ,
  58 .BI "                 char *restrict " buf ", size_t " bufsiz );
  59 .PP
  60 .fi
  61 .RS -4
  62 Feature Test Macro Requirements for glibc (see
  63 .BR feature_test_macros (7)):
  64 .RE
  65 .PP
  66 .BR readlink ():
  67 .nf
  68     _XOPEN_SOURCE >= 500 || _POSIX_C_SOURCE >= 200112L
  69 .\"    || _XOPEN_SOURCE && _XOPEN_SOURCE_EXTENDED
  70         || /* Glibc <= 2.19: */ _BSD_SOURCE
  71 .fi
  72 .PP
  73 .BR readlinkat ():
  74 .nf
  75     Since glibc 2.10:
  76         _POSIX_C_SOURCE >= 200809L
  77     Before glibc 2.10:
  78         _ATFILE_SOURCE
  79 .fi
  80 .SH DESCRIPTION
  81 .BR readlink ()
  82 places the contents of the symbolic link
  83 .I pathname
  84 in the buffer
  85 .IR buf ,
  86 which has size
  87 .IR bufsiz .
  88 .BR readlink ()
  89 does not append a terminating null byte to
  90 .IR buf .
  91 It will (silently) truncate the contents (to a length of
  92 .I bufsiz
  93 characters), in case the buffer is too small to hold all of the contents.
  94 .SS readlinkat()
  95 The
  96 .BR readlinkat ()
  97 system call operates in exactly the same way as
  98 .BR readlink (),
  99 except for the differences described here.
 100 .PP
 101 If the pathname given in
 102 .I pathname
 103 is relative, then it is interpreted relative to the directory
 104 referred to by the file descriptor
 105 .I dirfd
 106 (rather than relative to the current working directory of
 107 the calling process, as is done by
 108 .BR readlink ()
 109 for a relative pathname).
 110 .PP
 111 If
 112 .I pathname
 113 is relative and
 114 .I dirfd
 115 is the special value
 116 .BR AT_FDCWD ,
 117 then
 118 .I pathname
 119 is interpreted relative to the current working
 120 directory of the calling process (like
 121 .BR readlink ()).
 122 .PP
 123 If
 124 .I pathname
 125 is absolute, then
 126 .I dirfd
 127 is ignored.
 128 .PP
 129 Since Linux 2.6.39,
 130 .\" commit 65cfc6722361570bfe255698d9cd4dccaf47570d
 131 .I pathname
 132 can be an empty string,
 133 in which case the call operates on the symbolic link referred to by
 134 .IR dirfd
 135 (which should have been obtained using
 136 .BR open (2)
 137 with the
 138 .B O_PATH
 139 and
 140 .B O_NOFOLLOW
 141 flags).
 142 .PP
 143 See
 144 .BR openat (2)
 145 for an explanation of the need for
 146 .BR readlinkat ().
 147 .SH RETURN VALUE
 148 On success, these calls return the number of bytes placed in
 149 .IR buf .
 150 (If the returned value equals
 151 .IR bufsiz ,
 152 then truncation may have occurred.)
 153 On error, \-1 is returned and
 154 .I errno
 155 is set to indicate the error.
 156 .SH ERRORS
 157 .TP
 158 .B EACCES
 159 Search permission is denied for a component of the path prefix.
 160 (See also
 161 .BR path_resolution (7).)
 162 .TP
 163 .B EFAULT
 164 .I buf
 165 extends outside the process's allocated address space.
 166 .TP
 167 .B EINVAL
 168 .I bufsiz
 169 is not positive.
 170 .\" At the glibc level, bufsiz is unsigned, so this error can only occur
 171 .\" if bufsiz==0.  However, the in the kernel syscall, bufsiz is signed,
 172 .\" and this error can also occur if bufsiz < 0.
 173 .\" See: http://thread.gmane.org/gmane.linux.man/380
 174 .\" Subject: [patch 0/3] [RFC] kernel/glibc mismatch of "readlink" syscall?
 175 .TP
 176 .B EINVAL
 177 The named file (i.e., the final filename component of
 178 .IR pathname )
 179 is not a symbolic link.
 180 .TP
 181 .B EIO
 182 An I/O error occurred while reading from the filesystem.
 183 .TP
 184 .B ELOOP
 185 Too many symbolic links were encountered in translating the pathname.
 186 .TP
 187 .B ENAMETOOLONG
 188 A pathname, or a component of a pathname, was too long.
 189 .TP
 190 .B ENOENT
 191 The named file does not exist.
 192 .TP
 193 .B ENOMEM
 194 Insufficient kernel memory was available.
 195 .TP
 196 .B ENOTDIR
 197 A component of the path prefix is not a directory.
 198 .PP
 199 The following additional errors can occur for
 200 .BR readlinkat ():
 201 .TP
 202 .B EBADF
 203 .I dirfd
 204 is not a valid file descriptor.
 205 .TP
 206 .B ENOTDIR
 207 .I pathname
 208 is relative and
 209 .I dirfd
 210 is a file descriptor referring to a file other than a directory.
 211 .SH VERSIONS
 212 .BR readlinkat ()
 213 was added to Linux in kernel 2.6.16;
 214 library support was added to glibc in version 2.4.
 215 .SH CONFORMING TO
 216 .BR readlink ():
 217 4.4BSD
 218 .RB ( readlink ()
 219 first appeared in 4.2BSD),
 220 POSIX.1-2001, POSIX.1-2008.
 221 .PP
 222 .BR readlinkat ():
 223 POSIX.1-2008.
 224 .SH NOTES
 225 In versions of glibc up to and including glibc 2.4, the return type of
 226 .BR readlink ()
 227 was declared as
 228 .IR int .
 229 Nowadays, the return type is declared as
 230 .IR ssize_t ,
 231 as (newly) required in POSIX.1-2001.
 232 .PP
 233 Using a statically sized buffer might not provide enough room for the
 234 symbolic link contents.
 235 The required size for the buffer can be obtained from the
 236 .I stat.st_size
 237 value returned by a call to
 238 .BR lstat (2)
 239 on the link.
 240 However, the number of bytes written by
 241 .BR readlink ()
 242 and
 243 .BR readlinkat ()
 244 should be checked to make sure that the size of the
 245 symbolic link did not increase between the calls.
 246 Dynamically allocating the buffer for
 247 .BR readlink ()
 248 and
 249 .BR readlinkat ()
 250 also addresses a common portability problem when using
 251 .B PATH_MAX
 252 for the buffer size,
 253 as this constant is not guaranteed to be defined per POSIX
 254 if the system does not have such limit.
 255 .SS Glibc notes
 256 On older kernels where
 257 .BR readlinkat ()
 258 is unavailable, the glibc wrapper function falls back to the use of
 259 .BR readlink ().
 260 When
 261 .I pathname
 262 is a relative pathname,
 263 glibc constructs a pathname based on the symbolic link in
 264 .IR /proc/self/fd
 265 that corresponds to the
 266 .IR dirfd
 267 argument.
 268 .SH EXAMPLES
 269 The following program allocates the buffer needed by
 270 .BR readlink ()
 271 dynamically from the information provided by
 272 .BR lstat (2),
 273 falling back to a buffer of size
 274 .BR PATH_MAX
 275 in cases where
 276 .BR lstat (2)
 277 reports a size of zero.
 278 .PP
 279 .EX
 280 #include <sys/types.h>
 281 #include <sys/stat.h>
 282 #include <limits.h>
 283 #include <stdio.h>
 284 #include <stdlib.h>
 285 #include <unistd.h>
 286
 287 int
 288 main(int argc, char *argv[])
 289 {
 290     struct stat sb;
 291     char *buf;
 292     ssize_t nbytes, bufsiz;
 293
 294     if (argc != 2) {
 295         fprintf(stderr, "Usage: %s <pathname>\en", argv[0]);
 296         exit(EXIT_FAILURE);
 297     }
 298
 299     if (lstat(argv[1], &sb) == \-1) {
 300         perror("lstat");
 301         exit(EXIT_FAILURE);
 302     }
 303
 304     /* Add one to the link size, so that we can determine whether
 305        the buffer returned by readlink() was truncated. */
 306
 307     bufsiz = sb.st_size + 1;
 308
 309     /* Some magic symlinks under (for example) /proc and /sys
 310        report \(aqst_size\(aq as zero. In that case, take PATH_MAX as
 311        a "good enough" estimate. */
 312
 313     if (sb.st_size == 0)
 314         bufsiz = PATH_MAX;
 315
 316     buf = malloc(bufsiz);
 317     if (buf == NULL) {
 318         perror("malloc");
 319         exit(EXIT_FAILURE);
 320     }
 321
 322     nbytes = readlink(argv[1], buf, bufsiz);
 323     if (nbytes == \-1) {
 324         perror("readlink");
 325         exit(EXIT_FAILURE);
 326     }
 327
 328     /* Print only \(aqnbytes\(aq of \(aqbuf\(aq, as it doesn't contain a terminating
 329        null byte (\(aq\e0\(aq). */
 330     printf("\(aq%s\(aq points to \(aq%.*s\(aq\en", argv[1], (int) nbytes, buf);
 331
 332     /* If the return value was equal to the buffer size, then the
 333        the link target was larger than expected (perhaps because the
 334        target was changed between the call to lstat() and the call to
 335        readlink()). Warn the user that the returned target may have
 336        been truncated. */
 337
 338     if (nbytes == bufsiz)
 339         printf("(Returned buffer may have been truncated)\en");
 340
 341     free(buf);
 342     exit(EXIT_SUCCESS);
 343 }
 344 .EE
 345 .SH SEE ALSO
 346 .BR readlink (1),
 347 .BR lstat (2),
 348 .BR stat (2),
 349 .BR symlink (2),
 350 .BR realpath (3),
 351 .BR path_resolution (7),
 352 .BR symlink (7)