fstat(2)

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUES | ERRORS | USAGE | ATTRIBUTES | SUMMARY OF TRUSTED SOLARIS CHANGES | SEE ALSO | NOTES

NAME

stat, lstat, fstat- get file status

SYNOPSIS

#include <sys/types.h>
#include <sys/stat.h>

int stat(const char *path, struct stat *buf);
int lstat(const char *path, struct stat *buf);
int fstat(int fildes, struct stat *buf);

DESCRIPTION

The stat() function obtains information about the file pointed to by path. Read, write, or execute permission of the named file is not required, but all directories listed in the path name leading to the file must be searchable.

The lstat() function obtains file attributes similar to stat(), except when the named file is a symbolic link; in that case lstat() returns information about the link, while stat() returns information about the file the link references.

The fstat() function obtains information about an open file known by the file descriptor fildes, obtained from a successful open(2), creat(2), dup(2), fcntl(2), or pipe(2) function.

The buf argument is a pointer to a stat structure into which information is placed concerning the file. A stat structure includes the following members:

---

mode_t   st_mode;     /* File mode (see mknod(2)) */
ino_t    st_ino;      /* Inode number */
dev_t    st_dev;      /* ID of device containing */
                      /* a directory entry for this file */
dev_t    st_rdev;     /* ID of device */
                      /* This entry is defined only for */
                      /* char special or block special files */
nlink_t  st_nlink;    /* Number of links */
uid_t    st_uid;      /* User ID of the file's owner */
gid_t    st_gid;      /* Group ID of the file's group */
off_t    st_size;     /* File size in bytes */
time_t   st_atime;    /* Time of last access */
time_t   st_mtime;    /* Time of last data modification */
time_t   st_ctime;    /* Time of last file status change */
                      /* Times measured in seconds since */
                      /* 00:00:00 UTC, Jan. 1, 1970 */
long     st_blksize;  /* Preferred I/O block size */
blkcnt_t st_blocks;   /* Number of 512 byte blocks allocated*/ 

---

Descriptions of structure members are as follows:

st_mode

The mode of the file as described in mknod(2). In addition to the modes described in mknod(), the mode of a file may also be S_IFLNK if the file is a symbolic link. S_IFLNK may only be returned by lstat().

st_ino

This field uniquely identifies the file in a given file system. The pair st_ino and st_dev uniquely identifies regular files.

st_dev

This field uniquely identifies the file system that contains the file. Its value may be used as input to the ustat() function to determine more information about this file system. No other meaning is associated with this value.

st_rdev

This field should be used only by administrative commands. It is valid only for block special or character special files and only has meaning on the system where the file was configured.

st_nlink

This field should be used only by administrative commands.

st_uid

The user ID of the file's owner.

st_gid

The group ID of the file's group.

st_size

For regular files, this is the address of the end of the file. For block special or character special, this is not defined. See also pipe(2).

st_atime

Time when file data was last accessed. Changed by the following functions: creat(), mknod(), pipe(), utime(2), and read(2).

st_mtime

Time when data was last modified. Changed by the following functions: creat(), mknod(), pipe(), utime(), and write(2).

st_ctime

Time when file status was last changed. Changed by the following functions: chmod(), chown(), creat(), link(2), mknod(), pipe(), unlink(2), utime(), and write().

st_blksize

A hint as to the "best" unit size for I/O operations. This field is not defined for block special or character special files.

st_blocks

The total number of physical blocks of size 512 bytes actually allocated on disk. This field is not defined for block special or character special files.

stat(), lstat(), and fstat() require mandatory read access to the final component of path. If the file descriptor is open only for writing, fstat() requires mandatory read access to the object to which the descriptor refers. To override these restrictions, the calling process may assert the PRIV_FILE_MAC_READ privilege in its set of effective privileges.

If the calling process does not have mandatory read access, stat(), lstat(), and fstat() return fixed values for some elements of the stat structure.

RETURN VALUES

Upon successful completion, 0 is returned. Otherwise, -1 is returned and errno is set to indicate the error.

ERRORS

The stat(), fstat(), and lstat() functions will fail if:

EOVERFLOW

The file size in bytes or the number of blocks allocated to the file or the file serial number cannot be represented correctly in the structure pointed to by buf.

The stat() and lstat() functions will fail if:

EACCES

Search permission is denied for a component of the path prefix. To override this restriction, the calling process may assert one or both of these privileges: PRIV_FILE_DAC_SEARCH and PRIV_FILE_MAC_SEARCH.

EFAULT

The buf or path argument points to an illegal address.

EINTR

A signal was caught during the execution of the stat() or lstat() function.

ELOOP

Too many symbolic links were encountered in translating path.

ENAMETOOLONG

The length of the path argument exceeds PATH_MAX, or the length of a path component exceeds NAME_MAX while _POSIX_NO_TRUNC is in effect.

ENOENT

The named file does not exist or is the null pathname.

ENOLINK

The path argument points to a remote machine and the link to that machine is no longer active.

ENOTDIR

A component of the path prefix is not a directory.

EOVERFLOW

A component is too large to store in the structure pointed to by buf.

The fstat() function will fail if:

EBADF

The fildes argument is not a valid open file descriptor.

EFAULT

The buf argument points to an illegal address.

EINTR

A signal was caught during the execution of the fstat() function.

ENOLINK

The fildes argument points to a remote machine and the link to that machine is no longer active.

EOVERFLOW

A component is too large to store in the structure pointed to by buf.

USAGE

The stat(), fstat(), and lstat() functions have transitional interfaces for 64-bit file offsets. See lf64(5).

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE	ATTRIBUTE VALUE
MT-Level	stat() and fstat() are Async-Signal-Safe

SUMMARY OF TRUSTED SOLARIS CHANGES

stat(), lstat(), and fstat() require mandatory read access to the final component of path. If the file descriptor is open only for writing, fstat() requires mandatory read access to the object to which the descriptor refers. To override these restrictions, the calling process may assert the PRIV_FILE_MAC_READ privilege in its set of effective privileges.

To override access restrictions, the calling process of stat() or lstat() may also assert one or both of these privileges: PRIV_FILE_DAC_SEARCH and PRIV_FILE_MAC_SEARCH.

Certain uses of this interface may present a covert channel. If a covert channel is exploited, the execution of the process may be delayed. To bypass this delay, the process may assert the PRIV_PROC_NODELAY privilege.

SEE ALSO

Trusted Solaris 8 4/01 Reference Manual

chmod(2), chown(2), creat(2), fcntl(2), link(2), mknod(2), open(2), read(2), unlink(2), write(2)

SunOS 5.8 Reference Manual

dup(2), pipe(2), time(2), utime(2), fattach(3C), stat(3HEAD), attributes(5)

NOTES

If you use chmod(2) to change the file group owner permissions on a file with ACL entries, both the file group owner permissions and the ACL mask are changed to the new permissions. Be aware that the new ACL mask permissions may change the effective permissions for additional users and groups who have ACL entries on the file.

Trusted Solaris 8 4/01  Last Revised 20 Apr 2000

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUES | ERRORS | USAGE | ATTRIBUTES | SUMMARY OF TRUSTED SOLARIS CHANGES | SEE ALSO | NOTES