Perl 5 version 30.0 documentation
- stat EXPR
- stat DIRHANDLE
Returns a 13-element list giving the status info for a file, either the file opened via FILEHANDLE or DIRHANDLE, or named by EXPR. If EXPR is omitted, it stats $_ (not
_!). Returns the empty list if stat fails. Typically used as follows:
Not all fields are supported on all filesystem types. Here are the meanings of the fields:
- 0 dev device number of filesystem
- 1 ino inode number
- 2 mode file mode (type and permissions)
- 3 nlink number of (hard) links to the file
- 4 uid numeric user ID of file's owner
- 5 gid numeric group ID of file's owner
- 6 rdev the device identifier (special files only)
- 7 size total size of file, in bytes
- 8 atime last access time in seconds since the epoch
- 9 mtime last modify time in seconds since the epoch
- 10 ctime inode change time in seconds since the epoch (*)
- 11 blksize preferred I/O size in bytes for interacting with the
- file (may vary from file to file)
- 12 blocks actual number of system-specific blocks allocated
- on disk (often, but not always, 512 bytes each)
(The epoch was at 00:00 January 1, 1970 GMT.)
(*) Not all fields are supported on all filesystem types. Notably, the ctime field is non-portable. In particular, you cannot expect it to be a "creation time"; see Files and Filesystems in perlport for details.
(This works on machines only for which the device number is negative under NFS.)
On some platforms inode numbers are of a type larger than perl knows how to handle as integer numerical values. If necessary, an inode number will be returned as a decimal string in order to preserve the entire value. If used in a numeric context, this will be converted to a floating-point numerical value, with rounding, a fate that is best avoided. Therefore, you should prefer to compare inode numbers using
eqwill work fine on inode numbers that are represented numerically, as well as those represented as strings.
Because the mode contains both the file type and its permissions, you should mask off the file type portion and (s)printf using a
"%o"if you want to see the real permissions.
In scalar context, stat returns a boolean value indicating success or failure, and, if successful, sets the information associated with the special filehandle
The File::stat module provides a convenient, by-name access mechanism:
You can import symbolic mode constants (
S_IF*) and functions (
S_IS*) from the Fcntl module:
You could write the last two using the
-doperators. Commonly available
- # Permissions: read, write, execute, for user, group, others.
- S_IRWXU S_IRUSR S_IWUSR S_IXUSR
- S_IRWXG S_IRGRP S_IWGRP S_IXGRP
- S_IRWXO S_IROTH S_IWOTH S_IXOTH
- # Setuid/Setgid/Stickiness/SaveText.
- # Note that the exact meaning of these is system-dependent.
- S_ISUID S_ISGID S_ISVTX S_ISTXT
- # File types. Not all are necessarily available on
- # your system.
- S_IFREG S_IFDIR S_IFLNK S_IFBLK S_IFCHR
- S_IFIFO S_IFSOCK S_IFWHT S_ENFMT
- # The following are compatibility aliases for S_IRUSR,
- # S_IWUSR, and S_IXUSR.
- S_IREAD S_IWRITE S_IEXEC
- S_IMODE($mode) the part of $mode containing the permission
- bits and the setuid/setgid/sticky bits
- S_IFMT($mode) the part of $mode containing the file type
- which can be bit-anded with (for example)
- S_IFREG or with the following functions
- # The operators -f, -d, -l, -b, -c, -p, and -S.
- S_ISREG($mode) S_ISDIR($mode) S_ISLNK($mode)
- S_ISBLK($mode) S_ISCHR($mode) S_ISFIFO($mode) S_ISSOCK($mode)
- # No direct -X operator counterpart, but for the first one
- # the -g operator is often equivalent. The ENFMT stands for
- # record flocking enforcement, a platform-dependent feature.
- S_ISENFMT($mode) S_ISWHT($mode)
See your native chmod(2) and stat(2) documentation for more details about the
S_*constants. To get status info for a symbolic link instead of the target file behind the link, use the lstat function.
Portability issues: stat in perlport.