readlink

Section: System Calls (2)
Updated: 2026-02-08
Index JM Home Page roff page
 

名前

readlink, readlinkat - シンボリックリンクの値を読む  

ライブラリ

標準 C ライブラリ (libc,~-lc)  

書式

#include <unistd.h>

ssize_t readlink(size_t bufsiz;
                 const char *restrict path,
                 char buf[restrict bufsiz], size_t bufsiz);

#include <fcntl.h>           /* AT_* 定数の定義 */
#include <unistd.h>

ssize_t readlinkat(size_t bufsiz;
                 int dirfd, const char *restrict path,
                 char buf[restrict bufsiz], size_t bufsiz);

glibc 向けの機能検査マクロの要件 (feature_test_macros(7) 参照):

readlink():


    _XOPEN_SOURCE >= 500 || _POSIX_C_SOURCE >= 200112L
        || /* glibc <= 2.19: */ _BSD_SOURCE

readlinkat():

    Since glibc 2.10:
        _POSIX_C_SOURCE >= 200809L
    Before glibc 2.10:
        _ATFILE_SOURCE
 

説明

readlink() places the contents of the symbolic link path in the buffer buf, which has size bufsiz. readlink() does not append a terminating null byte to buf. It will (silently) truncate the contents (to a length of bufsiz characters), in case the buffer is too small to hold all of the contents.  

readlinkat()

readlinkat() システムコールは readlink() と全く同様に動作するが、以下で説明する点が異なる。

If path is relative, then it is interpreted relative to the directory referred to by the file descriptor dirfd (rather than relative to the current working directory of the calling process, as is done by readlink() for a relative pathname).

If path is relative and dirfd is the special value AT_FDCWD, then path is interpreted relative to the current working directory of the calling process (like readlink()).

If path is absolute, then dirfd is ignored.

Since Linux 2.6.39, path can be an empty string, in which case the call operates on the symbolic link referred to by dirfd (which should have been obtained using open(2) with the O_PATH and O_NOFOLLOW flags).

readlinkat() の必要性についての説明については openat(2) を参照。  

返り値

On success, these calls return the number of bytes placed in buf. (If the returned value equals bufsiz, then truncation may have occurred.) On error, -1 is returned and errno is set to indicate the error.  

エラー

EACCES
パスのディレクトリ部分に検索許可が与えられていない (path_resolution(7) も参照すること)。
EBADF
(readlinkat()) path is relative but dirfd is neither AT_FDCWD nor a valid file descriptor.
EFAULT
buf がプロセスに割り当てられたアドレス空間の外を指している。
EINVAL
bufsiz が正でない。
EINVAL
The named file (i.e., the final filename component of path) is not a symbolic link.
EIO
ファイルシステムの読み込み中に I/O エラーが起こった。
ELOOP
パス名にシンボリックリンクが多すぎる。
ENAMETOOLONG
パス名かパス名の一部分が長過ぎる。
ENOENT
その名前のファイルが存在しない。
ENOMEM
十分なカーネルメモリーがない。
ENOTDIR
パスのディレクトリ部分がディレクトリでない。
ENOTDIR
(readlinkat()) path is relative and dirfd is a file descriptor referring to a file other than a directory.
 

標準規格

POSIX.1-2024.  

歴史

readlink()
4.4BSD (4.2BSD で初めて登場した), POSIX.1-2001, POSIX.1-2008.
readlinkat()
POSIX.1-2008. Linux 2.6.16, glibc 2.4.

Up to and including glibc 2.4, the return type of readlink() was declared as int. Nowadays, the return type is declared as ssize_t, as (newly) required in POSIX.1-2001.  

glibc

On older kernels where readlinkat() is unavailable, the glibc wrapper function falls back to the use of readlink(). When path is relative, glibc constructs a pathname based on the symbolic link in /proc/self/fd that corresponds to the dirfd argument.  

注意

静的な大きさのバッファーを使うと、 シンボリックリンクの内容を格納するのに十分な領域がない場合がある。 バッファーに必要なサイズは、 そのシンボリックリンクに対して lstat(2) の呼び出しで返される stat.st_size の値から取得できる。 ただし、 readlink() や readlinkat() が書き込んだバイト数をチェックして、 シンボリックリンクのサイズが二つの呼び出しの間で増えていないことを確認すべきである。 readlink() や readlinkat() 用のバッファーを動的に割り当てる方法でも、 バッファーサイズとして PATH_MAX を使用する場合に共通する移植性の問題を解決することができる。 なぜなら、POSIX では、 システムがそのような上限値を定義していない場合には、 PATH_MAX が定義されることが保証されていないからである。  

例

The following program allocates the buffer needed by readlink() dynamically from the information provided by lstat(2), falling back to a buffer of size PATH_MAX in cases where lstat(2) reports a size of zero.

#include <limits.h>
#include <stdio.h>
#include <stdlib.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <unistd.h>

int
main(int argc, char *argv[])
{
    char         *buf;
    ssize_t      nbytes, bufsiz;
    struct stat  sb;

    if (argc != 2) {
        fprintf(stderr, "Usage: %s <path>\n", argv[0]);
        exit(EXIT_FAILURE);
    }

    if (lstat(argv[1], &sb) == -1) {
        perror("lstat");
        exit(EXIT_FAILURE);
    }

    /* Add one to the link size, so that we can determine whether
       the buffer returned by readlink() was truncated.  */

    bufsiz = sb.st_size + 1;

    /* Some magic symlinks under (for example) /proc and /sys
       report 'st_size' as zero.  In that case, take PATH_MAX as
       a "good enough" estimate.  */

    if (sb.st_size == 0)
        bufsiz = PATH_MAX;

    buf = malloc(bufsiz);
    if (buf == NULL) {
        perror("malloc");
        exit(EXIT_FAILURE);
    }

    nbytes = readlink(argv[1], buf, bufsiz);
    if (nbytes == -1) {
        perror("readlink");
        exit(EXIT_FAILURE);
    }

    /* Print only 'nbytes' of 'buf', as it doesn't contain a terminating
       null byte ('\0').  */
    printf("'%s' points to '%.*s'\n", argv[1], (int) nbytes, buf);

    /* If the return value was equal to the buffer size, then
       the link target was larger than expected (perhaps because the
       target was changed between the call to lstat() and the call to
       readlink()).  Warn the user that the returned target may have
       been truncated.  */

    if (nbytes == bufsiz)
        printf("(Returned buffer may have been truncated)\n");

    free(buf);
    exit(EXIT_SUCCESS);
}
 

関連項目

readlink(1), lstat(2), stat(2), symlink(2), realpath(3), path_resolution(7), symlink(7)


 

Index

名前
ライブラリ
書式
説明
readlinkat()
返り値
エラー
標準規格
歴史
glibc
注意
例
関連項目

This document was created by man2html, using the manual pages.