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. All advertising materials mentioning features or use of this software
13 .\" must display the following acknowledgement:
14 .\" This product includes software developed by the University of
15 .\" California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\" may be used to endorse or promote products derived from this software
18 .\" without specific prior written permission.
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .\" @(#)stat.2 8.4 (Berkeley) 5/1/95
33 .\" $FreeBSD: src/lib/libc/sys/stat.2,v 1.16.2.7 2001/12/14 18:34:01 ru Exp $
34 .\" $DragonFly: src/lib/libc/sys/stat.2,v 1.6 2008/09/28 16:33:35 swildner Exp $
51 .Fn stat "const char *path" "struct stat *sb"
53 .Fn lstat "const char *path" "struct stat *sb"
55 .Fn fstat "int fd" "struct stat *sb"
57 .Fn fstatat "int fd" "const char *path" "struct stat *buf" "int flag"
61 system call obtains information about the file pointed to by
63 Read, write or execute
64 permission of the named file is not required, but all directories
65 listed in the path name leading to the file must be searchable.
70 except in the case where the named file is a symbolic link,
73 returns information about the link,
76 returns information about the file the link references.
80 system call obtains the same information about an open file
81 known by the file descriptor
86 system call is equivalent to
90 except in the case where the
92 specifies a relative path.
93 In this case the status is retrieved from a file relative to
94 the directory associated with the file descriptor
96 instead of the current working directory.
100 are constructed by a bitwise-inclusive OR of flags from the following list,
103 .Bl -tag -width indent
104 .It Dv AT_SYMLINK_NOFOLLOW
107 names a symbolic link, the status of the symbolic link is returned.
112 is passed the special value
116 parameter, the current working directory is used and the behavior is
117 identical to a call to
121 respectively, depending on whether or not the
122 .Dv AT_SYMLINK_NOFOLLOW
128 argument is a pointer to a
134 and into which information is placed concerning the file.
137 dev_t st_dev; /* inode's device */
138 ino_t st_ino; /* inode's number */
139 mode_t st_mode; /* inode protection mode */
140 nlink_t st_nlink; /* number of hard links */
141 uid_t st_uid; /* user ID of the file's owner */
142 gid_t st_gid; /* group ID of the file's group */
143 dev_t st_rdev; /* device type */
144 #ifndef _POSIX_SOURCE
145 struct timespec st_atimespec; /* time of last access */
146 struct timespec st_mtimespec; /* time of last data modification */
147 struct timespec st_ctimespec; /* time of last file status change */
149 time_t st_atime; /* time of last access */
150 long st_atimensec; /* nsec of last access */
151 time_t st_mtime; /* time of last data modification */
152 long st_mtimensec; /* nsec of last data modification */
153 time_t st_ctime; /* time of last file status change */
154 long st_ctimensec; /* nsec of last file status change */
156 off_t st_size; /* file size, in bytes */
157 int64_t st_blocks; /* blocks allocated for file */
158 u_int32_t st_blksize; /* optimal blocksize for I/O */
159 u_int32_t st_flags; /* user defined flags for file */
160 u_int32_t st_gen; /* file generation number */
164 The time-related fields of
167 .Bl -tag -width ".Fa st_mtime"
169 Time when file data last accessed.
179 Time when file data last modified.
187 Time when file status was last changed (inode data modification).
203 is not defined, the time-related fields are defined as:
205 #ifndef _POSIX_SOURCE
206 #define st_atime st_atimespec.tv_sec
207 #define st_mtime st_mtimespec.tv_sec
208 #define st_ctime st_ctimespec.tv_sec
212 The size-related fields of the
215 .Bl -tag -width ".Fa st_blksize"
217 The optimal I/O block size for the file.
219 The actual number of blocks allocated for the file in 512-byte units.
220 As short symbolic links are stored in the inode, this number may
224 The status information word
226 has the following bits:
228 #define S_IFMT 0170000 /* type of file */
229 #define S_IFIFO 0010000 /* named pipe (fifo) */
230 #define S_IFCHR 0020000 /* character special */
231 #define S_IFDIR 0040000 /* directory */
232 #define S_IFBLK 0060000 /* block special */
233 #define S_IFREG 0100000 /* regular */
234 #define S_IFLNK 0120000 /* symbolic link */
235 #define S_IFSOCK 0140000 /* socket */
236 #define S_IFWHT 0160000 /* whiteout */
237 #define S_ISUID 0004000 /* set user id on execution */
238 #define S_ISGID 0002000 /* set group id on execution */
239 #define S_ISVTX 0001000 /* save swapped text even after use */
240 #define S_IRUSR 0000400 /* read permission, owner */
241 #define S_IWUSR 0000200 /* write permission, owner */
242 #define S_IXUSR 0000100 /* execute/search permission, owner */
245 For a list of access modes, see
253 Previous versions of the system used different types for the
270 Search permission is denied for a component of the path prefix.
272 An I/O error occurred while reading from or writing to the file system.
274 Too many symbolic links were encountered in translating the pathname.
275 .It Bq Er ENAMETOOLONG
276 A component of a pathname exceeded 255 characters,
277 or an entire path name exceeded 1023 characters.
279 The named file does not exist.
281 A component of the path prefix is not a directory.
286 points to an invalid address.
294 is not a valid open file descriptor.
297 points to an invalid address.
299 An I/O error occurred while reading from or writing to the file system.
314 system calls are expected to conform to
321 system call appeared in
325 system call appeared in
329 system call appeared in
334 to a socket (and thus to a pipe)
335 returns a zeroed buffer,
336 except for the blocksize field,
337 and a unique device and inode number.