1 .\" Copyright (c) 1980, 1991, 1993, 1994
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
12 .\" 3. Neither the name of the University nor the names of its contributors
13 .\" may be used to endorse or promote products derived from this software
14 .\" without specific prior written permission.
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" @(#)stat.2 8.4 (Berkeley) 5/1/95
29 .\" $FreeBSD: src/lib/libc/sys/stat.2,v 1.16.2.7 2001/12/14 18:34:01 ru Exp $
30 .\" $DragonFly: src/lib/libc/sys/stat.2,v 1.6 2008/09/28 16:33:35 swildner Exp $
47 .Fn stat "const char *path" "struct stat *sb"
49 .Fn lstat "const char *path" "struct stat *sb"
51 .Fn fstat "int fd" "struct stat *sb"
53 .Fn fstatat "int fd" "const char *path" "struct stat *buf" "int flag"
57 system call obtains information about the file pointed to by
59 Read, write or execute
60 permission of the named file is not required, but all directories
61 listed in the path name leading to the file must be searchable.
66 except in the case where the named file is a symbolic link,
69 returns information about the link,
72 returns information about the file the link references.
76 system call obtains the same information about an open file
77 known by the file descriptor
82 system call is equivalent to
86 except in the case where the
88 specifies a relative path.
89 In this case the status is retrieved from a file relative to
90 the directory associated with the file descriptor
92 instead of the current working directory.
96 are constructed by a bitwise-inclusive OR of flags from the following list,
99 .Bl -tag -width indent
100 .It Dv AT_SYMLINK_NOFOLLOW
103 names a symbolic link, the status of the symbolic link is returned.
108 is passed the special value
112 parameter, the current working directory is used and the behavior is
113 identical to a call to
117 respectively, depending on whether or not the
118 .Dv AT_SYMLINK_NOFOLLOW
124 argument is a pointer to a
130 and into which information is placed concerning the file.
133 dev_t st_dev; /* inode's device */
134 ino_t st_ino; /* inode's number */
135 mode_t st_mode; /* inode protection mode */
136 nlink_t st_nlink; /* number of hard links */
137 uid_t st_uid; /* user ID of the file's owner */
138 gid_t st_gid; /* group ID of the file's group */
139 dev_t st_rdev; /* device type */
140 #ifndef _POSIX_SOURCE
141 struct timespec st_atimespec; /* time of last access */
142 struct timespec st_mtimespec; /* time of last data modification */
143 struct timespec st_ctimespec; /* time of last file status change */
145 time_t st_atime; /* time of last access */
146 long st_atimensec; /* nsec of last access */
147 time_t st_mtime; /* time of last data modification */
148 long st_mtimensec; /* nsec of last data modification */
149 time_t st_ctime; /* time of last file status change */
150 long st_ctimensec; /* nsec of last file status change */
152 off_t st_size; /* file size, in bytes */
153 int64_t st_blocks; /* blocks allocated for file */
154 u_int32_t st_blksize; /* optimal blocksize for I/O */
155 u_int32_t st_flags; /* user defined flags for file */
156 u_int32_t st_gen; /* file generation number */
160 The time-related fields of
163 .Bl -tag -width ".Fa st_mtime"
165 Time when file data last accessed.
175 Time when file data last modified.
183 Time when file status was last changed (inode data modification).
199 is not defined, the time-related fields are defined as:
201 #ifndef _POSIX_SOURCE
202 #define st_atime st_atimespec.tv_sec
203 #define st_mtime st_mtimespec.tv_sec
204 #define st_ctime st_ctimespec.tv_sec
208 The size-related fields of the
211 .Bl -tag -width ".Fa st_blksize"
213 The optimal I/O block size for the file.
215 The actual number of blocks allocated for the file in 512-byte units.
216 As short symbolic links are stored in the inode, this number may
220 The status information word
222 has the following bits:
224 #define S_IFMT 0170000 /* type of file */
225 #define S_IFIFO 0010000 /* named pipe (fifo) */
226 #define S_IFCHR 0020000 /* character special */
227 #define S_IFDIR 0040000 /* directory */
228 #define S_IFBLK 0060000 /* block special */
229 #define S_IFREG 0100000 /* regular */
230 #define S_IFLNK 0120000 /* symbolic link */
231 #define S_IFSOCK 0140000 /* socket */
232 #define S_IFWHT 0160000 /* whiteout */
233 #define S_ISUID 0004000 /* set user id on execution */
234 #define S_ISGID 0002000 /* set group id on execution */
235 #define S_ISVTX 0001000 /* save swapped text even after use */
236 #define S_IRUSR 0000400 /* read permission, owner */
237 #define S_IWUSR 0000200 /* write permission, owner */
238 #define S_IXUSR 0000100 /* execute/search permission, owner */
241 For a list of access modes, see
249 Previous versions of the system used different types for the
266 Search permission is denied for a component of the path prefix.
268 An I/O error occurred while reading from or writing to the file system.
270 Too many symbolic links were encountered in translating the pathname.
271 .It Bq Er ENAMETOOLONG
272 A component of a pathname exceeded 255 characters,
273 or an entire path name exceeded 1023 characters.
275 The named file does not exist.
277 A component of the path prefix is not a directory.
282 points to an invalid address.
290 is not a valid open file descriptor.
293 points to an invalid address.
295 An I/O error occurred while reading from or writing to the file system.
310 system calls are expected to conform to
317 system call appeared in
321 system call appeared in
325 system call appeared in
330 to a socket (and thus to a pipe)
331 returns a zeroed buffer,
332 except for the blocksize field,
333 and a unique device and inode number.