stat(2) obtiene el estado de un fichero

Other Alias

fstat, lstat

SINOPSIS

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

int stat(const char *file_name, struct stat *buf);
int fstat(int filedes, struct stat *buf);
int lstat(const char *file_name, struct stat *buf);

DESCRIPCIÓN

Estas funciones devuelven información del fichero especificado. No se necesitan derechos de acceso al fichero para conseguir la información pero sí se necesitan derechos de búsqueda para todos los directorios del camino al fichero.

stat examina el fichero al que apunta file_name y llena buf.

lstat es idéntico a stat, salvo en caso de que se trate de un enlace simbólico, en cuyo caso se examina el enlace mismo, no el fichero al que hace referencia.

fstat es idéntico a stat, pero sólo el fichero abierto apuntado por filedes (tal y como lo devuelve open(2)) es examinado en lugar de file_name.

Todos devuelven una estructura stat, que contien los siguientes campos:

struct stat {
    dev_t         st_dev;      /* dispositivo */
    ino_t         st_ino;      /* inodo */
    mode_t        st_mode;     /* protección */
    nlink_t       st_nlink;    /* número de enlaces físicos */
    uid_t         st_uid;      /* ID del usuario propietario */
    gid_t         st_gid;      /* ID del grupo propietario */
    dev_t         st_rdev;     /* tipo dispositivo (si es
                                  dispositivo inodo) */
    off_t         st_size;     /* tamaño total, en bytes */
    blksize_t     st_blksize;  /* tamaño de bloque para el
                                  sistema de ficheros de E/S */
    blkcnt_t      st_blocks;   /* número de bloques asignados */
    time_t        st_atime;    /* hora último acceso */
    time_t        st_mtime;    /* hora última modificación */
    time_t        st_ctime;    /* hora último cambio */
};

El valor st_size da el tamaño del fichero (si es un fichero regular o un enlace simbólico) en bytes. El tamaño de un enlace simbólico es la longitud del nombre de ruta que contiene, sin contar el caracter NUL final.

El valor st_blocks da el tamaño del fichero en bloques de 512 bytes. (Éste puede ser menor que st_size/512 p.e. cuando el fichero tenga huecos.) El valor st_blksize da el tamaño de bloque "preferido" para operaciones de E/S eficientes sobre el sistema de ficheros. (Escribir en un fichero en porciones más pequeñas puede producir una secuencia leer-modificar-reescribir ineficiente).

No todos los sistemas de ficheros en Linux implementan todos los campos de hora. Algunos tipos de sistemas de ficheros permiten el montaje de tal manera que los accesos al fichero no provocan una actualización del campo st_atime (Vea `noatime' en mount(8).)

El campo st_atime es modificado por accesos al fichero, p.e. por execve(2), mknod(2), pipe(2), utime(2) y read(2) (de más de cero bytes). Otras rutinas, como mmap(2), pueden o no actualizar st_atime.

El campo st_mtime es modificado por cambios en el fichero, p.e. por mknod(2), truncate(2), utime(2) y write(2) (de más de cero bytes). Además, el campo st_mtime de un directorio es modificado por la creación o borrado de ficheros en dicho directorio. El campo st_mtime no es modificado por cambios en el propietario, grupo, contador de enlaces duros, o modo.

El campo st_ctime es modificado por la escritura o por cambiar información del inodo (es decir, propietario, grupo, contador de enlaces, modo, etc.).

Se definen las siguientes macros POSIX para comprobar el tipo de fichero:

S_ISLNK(m)
es un enlace simbólico?
S_ISREG(m)
un fichero regular?
S_ISDIR(m)
un directorio?
S_ISCHR(m)
un dispositivo de caracteres?
S_ISBLK(m)
un dispositivo de bloques?
S_ISFIFO(m)
una tubería nombrada (fifo)?
S_ISLNK(m)
un enlace simbólico? (No presente en POSIX.1-1996.)
S_ISSOCK(m)
un conector (socket)? (No presente en POSIX.1-1996.)

Se definen las siguientes banderas para el campo st_mode:

S_IFMT0017000máscara de bits para los campos de bit del tipo
de fichero (no POSIX)
S_IFSOCK0140000conector (no POSIX)
S_IFLNK0120000enlace simbólico (no POSIX)
S_IFREG0100000fichero regular (no POSIX)
S_IFBLK0060000dispositivo de bloques (no POSIX)
S_IFDIR0040000directorio (no POSIX)
S_IFCHR0020000dispositivo de caracteres (no POSIX)
S_IFIFO0010000fifo o tubería nombrada (no POSIX)
S_ISUID0004000poner bit UID
S_ISGID0002000poner bit GID
S_ISVTX0001000sticky bit (no POSIX)
S_IRWXU00700usuario (propietario del fichero) tiene permisos
de lectura, escritura y ejecución
S_IRUSR00400usuario tiene premiso de lectura (igual que
S_IREAD, que no es POSIX)
S_IWUSR00200usuario tiene premiso de escritura (igual que
S_IWRITE, que no es POSIX)
S_IXUSR00100usuario tiene premiso de ejecución (igual que
S_IEXEC, que no es POSIX)
S_IRWXG00070grupo tiene permisos de lectura, escritura y
ejecución
S_IRGRP00040grupo tiene permiso de lectura
S_IWGRP00020grupo tiene permiso de escritura
S_IXGRP00010grupo tiene permiso de ejecución
S_IRWXO00007otros tienen permisos de lectura, escritura y
ejecución
S_IROTH00004otros tienen permiso de lectura
S_IWOTH00002otros tienen permiso de escritura
S_IXOTH00001otros tienen permiso de ejecución

El bit SETGID (S_ISGID) tiene varios usos especiales: para un directorio, indica que se va a usar la semántica BSD para el directorio: los ficheros creados allí heredarán su GID del directorio, no del GID efectivo del proceso que crea cada fichero, y los directorios creados allí también tendrán el bit S_ISGID activo. Para un fichero que no tiene el bit de ejecución del grupo (S_IXGRP) activo, indica bloqueo obligatorio de ficheros/registros.

El bit `sticky' (S_ISVTX) en un directorio significa que un fichero de ese directorio sólo puede ser renombrado o borrado por el propietario del fichero, por el propietario del directorio y por el superusuario.

VALOR DEVUELTO

Se devuelve cero si hubo éxito. Si hubo error, se devuelve -1, y errno es actualizado apropiadamente.

ERRORES

EBADF
filedes incorrecto.
ENOENT
No existe un componente del camino file_name o el camino es una cadena vacía.
ENOTDIR
Un componente del camino no es un directorio.
ELOOP
Se han encontrado demasiados enlaces simbólicos al recorrer el camino.
EFAULT
Dirección errónea.
EACCES
Permiso denegado.
ENOMEM
Fuera de memoria (es decir, memoria del núcleo).
ENAMETOOLONG
Nombre de fichero demasiado largo.

CONFORME A

Las llamadas stat y fstat conforman con SVr4, SVID, POSIX, X/OPEN y BSD 4.3. La llamada lstat conforma con 4.3BSD y SVr4. SVr4 documenta condiciones de error adicionales de fstat: EINTR, ENOLINK y EOVERFLOW. SVr4 documenta condiciones de error adicionales de stat y lstat: EACCES, EINTR, EMULTIHOP, ENOLINK y EOVERFLOW. El uso de los campos st_blocks y st_blksize puede ser poco portable. (Fueron introducidos en BSD. No están especificados por POSIX. La interpretación difiere entre sistemas y posiblemente en un mismo sistema cuando están involucrados montajes NFS).

POSIX no describe los bits S_IFMT, S_IFSOCK, S_IFLNK, S_IFREG, S_IFBLK, S_IFDIR, S_IFCHR, S_IFIFO y S_ISVTX, pero en su lugar demanda el uso de las macros S_ISDIR(), etc. Las macros S_ISLNK y S_ISSOCK no están en POSIX.1-1996, pero ambas formarán parte del próximo estándar POSIX; la primera es de SVID 4v2, la última de SUSv2.

Unix V7 (y sistemas posteriores) tenían S_IREAD, S_IWRITE, S_IEXEC, donde POSIX prescribe los sinónimos S_IRUSR, S_IWUSR, S_IXUSR.

OTROS SISTEMAS

Valores que han estado (o están) en uso en varios sistemas:

hexnombrelsoctaldescripción
f000S_IFMT170000Máscara para el tipo de fichero
0000000000SCO: nodo-i fuera de servicio

 
BSD: tipo desconocido

 
SVID-v2 y XPG2: tienen tanto 0 como

 
0100000 para ficheros ordinarios
1000S_IFIFOp|010000Fifo (tubería con nombre)
2000S_IFCHRc020000V7: fichero especial de caracteres
3000S_IFMPC030000V7: fichero especial de caracteres

 
multiplexados
4000S_IFDIRd/040000V7: directorio
5000S_IFNAM050000XENIX: fichero especial con nombre

 
con dos subtipos, distinguidos

 
por los valores st_rdev 1, 2:
0001S_INSEMs000001XENIX: subtipo semáforo de IFNAM
0002S_INSHDm000002XENIX: subtipo datos compartidos
de IFNAM
6000S_IFBLKb060000V7: fichero especial de bloques
7000S_IFMPB070000V7: fichero especial de bloques

 
multiplexados
8000S_IFREG-100000V7: fichero regular
9000S_IFCMP110000VxFS: fichero comprimido
9000S_IFNWKn110000HP-UX: fichero especial de red
a000S_IFLNKl@120000BSD: enlace simbólico
b000S_IFSHAD130000Solaris: nodo-i sombra para ACL

 
(no visto por el espacio de usuario)
c000S_IFSOCKs=140000BSD: conector (también "S_IFSOC" en VxFS)
d000S_IFDOORD>150000Solaris: puerta
e000S_IFWHTw%160000BSD: `whiteout'(no usado para nodos-i)
0200S_ISVTX001000V7: `sticky bit': salvar el código
intercambiado incluso después de usarse

 
SVID-v2: reservado
SunOS: En ficheros no directorios: no
colocar en cache este fichero

 
SVID-v4.2: En directorios: opción de
elminación restringida
0400S_ISGID002000V7: SETGID al ejecuctar
Para directorios: usar semántica BSD

 
para propagación del GID
0400S_ENFMT002000SysV: Aplicar el bloqueo del fichero

 
(compartido con S_ISGID)
0800S_ISUID004000V7: SETUID al ejecutar
0800S_CDF004000HP-UX: el directorio es un fichero

 
dependiente del contexto

Una orden `sticky' apareción en AT&T UNIX Version 32V.