usr/share/man/cat2/stat.0

STAT(2)                     BSD Programmer's Manual                    STAT(2)

N\bNA\bAM\bME\bE
     s\bst\bta\bat\bt, l\bls\bst\bta\bat\bt, f\bfs\bst\bta\bat\bt - get file status

S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
     #\b#i\bin\bnc\bcl\blu\bud\bde\be <\b<s\bsy\bys\bs/\b/t\bty\byp\bpe\bes\bs.\b.h\bh>\b>
     #\b#i\bin\bnc\bcl\blu\bud\bde\be <\b<s\bsy\bys\bs/\b/s\bst\bta\bat\bt.\b.h\bh>\b>

     _\bi_\bn_\bt
     s\bst\bta\bat\bt(_\bc_\bo_\bn_\bs_\bt _\bc_\bh_\ba_\br _\b*_\bp_\ba_\bt_\bh, _\bs_\bt_\br_\bu_\bc_\bt _\bs_\bt_\ba_\bt _\b*_\bb_\bu_\bf);

     _\bi_\bn_\bt
     l\bls\bst\bta\bat\bt(_\bc_\bo_\bn_\bs_\bt _\bc_\bh_\ba_\br _\b*_\bp_\ba_\bt_\bh, _\bs_\bt_\br_\bu_\bc_\bt _\bs_\bt_\ba_\bt _\b*_\bb_\bu_\bf);

     _\bi_\bn_\bt
     f\bfs\bst\bta\bat\bt(_\bi_\bn_\bt _\bf_\bd, _\bs_\bt_\br_\bu_\bc_\bt _\bs_\bt_\ba_\bt _\b*_\bb_\bu_\bf);

D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
     The s\bst\bta\bat\bt() function obtains information about the file pointed to by
     _\bp_\ba_\bt_\bh. Read, write or execute permission of the named file is not re-
     quired, but all directories listed in the path name leading to the file
     must be seachable.

     L\bLs\bst\bta\bat\bt() is like s\bst\bta\bat\bt() except in the case where the named file is a sym-
     bolic link, in which case l\bls\bst\bta\bat\bt() returns information about the link,
     while s\bst\bta\bat\bt() returns information about the file the link references.  Un-
     like other filesystem objects, symbolic links do not have an owner,
     group, access mode, times, etc.  Instead, these attributes are taken from
     the directory that contains the link.  The only attributes returned from
     an l\bls\bst\bta\bat\bt() that refer to the symbolic link itself are the file type
     (S_IFLNK), size, blocks, and link count (always 1).

     The f\bfs\bst\bta\bat\bt() obtains the same information about an open file known by the
     file descriptor _\bf_\bd, such as would be obtained by an open call.

     _\bB_\bu_\bf is a pointer to a s\bst\bta\bat\bt() structure as defined by <_\bs_\by_\bs_\b/_\bs_\bt_\ba_\bt_\b._\bh> (shown
     below) and into which information is placed concerning the file.

     struct stat {
         dev_t    st_dev;    /* device inode resides on */
         ino_t    st_ino;    /* inode's number */
         mode_t   st_mode;   /* inode protection mode */
         nlink_t  st_nlink;  /* number or hard links to the file */
         uid_t    st_uid;    /* user-id of owner */
         gid_t    st_gid;    /* group-id of owner */
         dev_t    st_rdev;   /* device type, for special file inode */
         off_t    st_size;   /* file size, in bytes */
         time_t   st_atime;  /* time of last access */
         long     st_spare1;
         time_t   st_mtime;  /* time of last data modification */
         long     st_spare2;
         time_t   st_ctime;  /* time of last file status change */
         long     st_spare3;
         long     st_blksize;/* optimal file sys I/O ops blocksize */
         long     st_blocks; /* blocks allocated for file */
         u_long   st_flags;  /* user defined flags for file */
         u_long   st_gen;    /* file generation number */
     };

     The time-related fields of _\bs_\bt_\br_\bu_\bc_\bt _\bs_\bt_\ba_\bt are as follows:

     st_atime   Time when file data last accessed.  Changed by the following


                system calls: mknod(2),  utimes(2),  and read(2).

     st_mtime   Time when file data last modified.  Changed by the following
                system calls: mknod(2),  utimes(2),  write(2).

     st_ctime   Time when file status was last changed (inode data modifica-
                tion).  Changed by the following system calls: chmod(2)
                chown(2),  link(2),  mknod(2),  rename(2),  unlink(2),
                utimes(2),  write(2).

     st_blocks  The actual number of blocks allocated for the file in 512-byte
                units.

     The status information word _\bs_\bt_\b__\bm_\bo_\bd_\be has bits:

     #define S_IFMT 0170000           /* type of file */
     #define        S_IFIFO  0010000  /* named pipe (fifo) */
     #define        S_IFCHR  0020000  /* character special */
     #define        S_IFDIR  0040000  /* directory */
     #define        S_IFBLK  0060000  /* block special */
     #define        S_IFREG  0100000  /* regular */
     #define        S_IFLNK  0120000  /* symbolic link */
     #define        S_IFSOCK 0140000  /* socket */
     #define S_ISUID 0004000  /* set user id on execution */
     #define S_ISGID 0002000  /* set group id on execution */
     #define S_ISVTX 0001000  /* save swapped text even after use */
     #define S_IRUSR 0000400  /* read permission, owner */
     #define S_IWUSR 0000200  /* write permission, owner */
     #define S_IXUSR 0000100  /* execute/search permission, owner */

     For a list of access modes, see <_\bs_\by_\bs_\b/_\bs_\bt_\ba_\bt_\b._\bh>, access(2) and chmod(2).

R\bRE\bET\bTU\bUR\bRN\bN V\bVA\bAL\bLU\bUE\bES\bS
     Upon successful completion a value of 0 is returned.  Otherwise, a value
     of -1 is returned and _\be_\br_\br_\bn_\bo is set to indicate the error.

E\bER\bRR\bRO\bOR\bRS\bS
     S\bSt\bta\bat\bt() and l\bls\bst\bta\bat\bt() will fail if:

     [ENOTDIR]       A component of the path prefix is not a directory.

     [EINVAL]        The pathname contains a character with the high-order bit
                     set.

     [ENAMETOOLONG]  A component of a pathname exceeded 255 characters, or an
                     entire path name exceeded 1023 characters.

     [ENOENT]        The named file does not exist.

     [EACCES]        Search permission is denied for a component of the path
                     prefix.

     [ELOOP]         Too many symbolic links were encountered in translating
                     the pathname.

     [EFAULT]        _\bB_\bu_\bf or _\bn_\ba_\bm_\be points to an invalid address.

     [EIO]           An I/O error occurred while reading from or writing to
                     the file system.

     F\bFs\bst\bta\bat\bt() will fail if:

     [EBADF]   _\bf_\bd is not a valid open file descriptor.


     [EFAULT]  _\bB_\bu_\bf points to an invalid address.

     [EIO]     An I/O error occurred while reading from or writing to the file
               system.

C\bCA\bAV\bVE\bEA\bAT\bT
     The fields in the stat structure currently marked _\bs_\bt_\b__\bs_\bp_\ba_\br_\be_\b1, _\bs_\bt_\b__\bs_\bp_\ba_\br_\be_\b2,
     and _\bs_\bt_\b__\bs_\bp_\ba_\br_\be_\b3 are present in preparation for inode time stamps expanding
     to 64 bits.  This, however, can break certain programs that depend on the
     time stamps being contiguous (in calls to utimes(2)).

S\bSE\bEE\bE A\bAL\bLS\bSO\bO
     chmod(2),  chown(2),  utimes(2) symlink(7)

B\bBU\bUG\bGS\bS
     Applying fstat to a socket (and thus to a pipe) returns a zero'd buffer,
     except for the blocksize field, and a unique device and inode number.

S\bST\bTA\bAN\bND\bDA\bAR\bRD\bDS\bS
     The s\bst\bta\bat\bt() and f\bfs\bst\bta\bat\bt() function calls are expected to conform to IEEE Std
     1003.1-1988 (``POSIX'').

H\bHI\bIS\bST\bTO\bOR\bRY\bY
     A l\bls\bst\bta\bat\bt function call appeared in 4.2BSD.

4th Berkeley Distribution        June 4, 1993                                3