poll tests: Avoid test failure on BSD and Solaris systems.
[gnulib.git] / doc / posix-functions / stat.texi
blob1d1f9276446f727a7d0a0fbab7adaeaa40ca5730
1 @node stat
2 @section @code{stat}
3 @findex stat
5 POSIX specification:@* @url{https://pubs.opengroup.org/onlinepubs/9699919799/functions/stat.html}
7 Gnulib module: stat
9 Portability problems fixed by Gnulib:
10 @itemize
11 @item
12 On platforms where @code{off_t} is a 32-bit type, @code{stat} may not correctly
13 report the size of files or block devices larger than 2 GB.
14 (Cf. @code{AC_SYS_LARGEFILE}.)
15 @item
16 On Linux/x86 and Linux/x86_64, applications compiled in 32-bit mode cannot
17 access files that happen to have a 64-bit inode number.  This can occur with
18 file systems such as XFS (typically on large disks) and NFS.
19 (Cf. @code{AC_SYS_LARGEFILE}.)
20 @item
21 The @code{st_atime}, @code{st_ctime}, @code{st_mtime} fields are affected by
22 the current time zone and by the DST flag of the current time zone on some
23 platforms:
24 mingw, MSVC 14 (when the environment variable @code{TZ} is set).
25 @item
26 On MSVC 14, this function fails with error @code{ENOENT}
27 on files such as @samp{C:\pagefile.sys} and
28 on directories such as @samp{C:\System Volume Information}.
29 @item
30 On some platforms, @code{stat("link-to-file/",buf)} succeeds instead
31 of failing with @code{ENOTDIR}.
32 Mac OS X 10.13, FreeBSD 7.2, AIX 7.1, Solaris 9, mingw64.
33 @item
34 On some platforms, @code{stat(".",buf)} and @code{stat("./",buf)} give
35 different results:
36 mingw, MSVC 14.
37 @item
38 On Solaris 11.4, when this function yields a timestamp with a
39 nonpositive @code{tv_sec} value, @code{tv_nsec} might be in the range
40 @minus{}1000000000..@minus{}1, representing a negative nanoseconds
41 offset from @code{tv_sec}.
42 @end itemize
44 Portability problems not fixed by Gnulib:
45 @itemize
46 @item
47 @xref{sys/stat.h}, for general portability problems with @code{struct stat}.
48 @item
49 Cygwin's @code{stat} function sometimes sets @code{errno} to @code{EACCES} when
50 @code{ENOENT} would be more appropriate.
51 @item
52 Because of the definition of @code{struct stat}, it is not possible to
53 portably replace @code{stat} via an object-like macro.  Therefore,
54 expressions such as @code{(islnk ? lstat : stat) (name, buf)} are not
55 portable, and should instead be written @code{islnk ? lstat (name,
56 buf) : stat (name, buf)}.
57 @end itemize