Linux

CentOS 5.3

stat(2)


STAT

NOM

stat, fstat, lstat − Obtenir l’état d’un fichier (file status).

SYNOPSIS

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

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

DESCRIPTION

Ces fonctions renvoient des informations à propos d’un fichier. Aucune permission n’est nécessaire sur le fichier lui-même, mais — dans le cas de stat() et lstat() — la permission d’exécution (parcours) est nécessaire pour tous les répertoires de path qui mènent au fichier.

stat() récupère l’état du fichier pointé par file_name et remplit le tampon buf.

lstat() est identique à stat(), sauf que si path est un lien symbolique, il donne l’état du lien lui-même plutôt que celui du fichier visé.

fstat() est identique à stat(), sauf que le fichier ouvert est pointé par le descripteur filedes, obtenu avec open(2).

Les trois fonctions retournent une structure stat contenant les champs suivants :

struct stat {
    dev_t     st_dev;      /* ID du périphérique contenant le fichier */
    ino_t     st_ino;      /* Numéro i−noeud */
    mode_t    st_mode;     /* Protection */
    nlink_t   st_nlink;    /* Nb liens matériels */
    uid_t     st_uid;      /* UID propriétaire */
    gid_t     st_gid;      /* GID propriétaire */
    dev_t     st_rdev;     /* ID périphérique (si périphérique i−noeud */
    off_t     st_size;     /* Taille totale en octets */
    blksize_t st_blksize;  /* Taille de bloc pour E/S */
    blkcnt_t  st_blocks;   /* Nombre de blocs alloués */
    time_t    st_atime;    /* Heure dernier accès */
    time_t    st_mtime;    /* Heure dernière modification */
    time_t    st_ctime;    /* Heure dernier changement état */
};

Le champ st_dev décrit le périphérique sur laquel réside le fichier. le champ st_rdev décrit le périphérique que ce fichier (i−noeud) représente. Le champ st_size indique la taille du fichier (s’il s’agit d’un fichier régulier ou d’un lien symbolique) en octets. La taille d’un lien symbolique est la longueur de la chaîne représentant le chemin d’accès qu’il vise, sans l’octet nul final.

Le champ st_blocks donne indique le nombre de blocks alloués au fichier, en unité de 512 octets (cette valeur peut être plus petite que st_size/512 par exemple, si le fichier contient des trous). Le champ st_blksize indique la taille de bloc « préférée » pour les entrées-sorties du système de fichiers (l’écriture dans un fichier par petits morceaux peut induire de nombreuses étapes lecture-modification-écriture peu efficaces).

Les systèmes de fichiers de Linux n’implémentent pas tous les champs liés à la date. Certains systèmes de fichiers autorisent le montage de telle manière que les accès ne modifient pas le champ st_atime (voir l’option « noatime » de mount(8)).

Le champ st_atime est modifié par les accès au fichier, c’est-à -dire avec execve(2), mknod(2), pipe(2), utime(2) et read(2) (d’au moins un octet). D’autres routines, comme mmap(2), peuvent ou non mettre à jour ce champ st_atime.

Le champ st_mtime est modifié par des changements sur le fichier lui-même, c’est-à -dire mknod(2), truncate(2), utime(2) et write(2) (d’au moins un octet). D’autre part, le champ st_mtime d’un répertoire est modifié lors de la création ou la suppression de fichiers en son sein. Le champ st_mtime n’est pas mis à jour lors de modification de propriétaire, groupe, mode ou nombre de liens physiques.

Le champ st_ctime est modifié lors d’une écriture ou une modification de données concernant l’i−noeud (propriétaire, groupe, mode, etc.).

Les macros POSIX suivantes sont fournies pour vérifier le type de fichier en utilisant le champ stmode :

S_ISREG(m)

un fichier régulier ?

S_ISDIR(m)

un répertoire ?

S_ISCHR(m)

un péripherique en mode caractère ?

S_ISBLK(m)

un périphérique en mode bloc ?

S_ISFIFO(m)

une FIFO ?

S_ISLNK(m)

un lien symbolique ? (Pas dans POSIX.1-1996).

S_ISSOCK(m)

une socket ? (Pas dans POSIX.1-1996).

Les attributs suivants correspondent au champ st_mode :

Le bit set-group-ID (S_ISGID) a plusieurs utilisations particulières : pour un répertoire, il indique que la sémantique BSD doit être appliquée en son sein, c’est-à -dire que les fichiers qui y sont créés héritent leur GID du répertoire et non pas du GID effectif du processus créateur, et les sous-répertoires auront automatiquement le bit S_ISGID actif. Pour les fichiers qui n’ont pas d’autorisation d’exécution pour le groupe (S_IXGRP non actif), le bit set-group-ID indique qu’un verrouillage strict est en vigueur sur ce fichier.

Le bit « sticky » (S_ISVTX) sur un répertoire indique que les fichiers qui s’y trouvent ne peuvent être renommés ou effacés que par leur propriétaire, par le propriétaire du répertoire ou par un processus privilégié.

NOTES LINUX

Depuis le noyau 2.5.48, la structure stat supporte un résolution en nanoseconde pour les trois champs d’horodatage des fichiers. La glibc expose le composant nanoseconde de chaque champ en utilisant des noms soit de la forme st_atim.tv_nsec, si la macro de test de fonctionnalité _BSD_SOURCE ou _SVID_SOURCE est définie, soit de la forme st_atimensec, si aucune de ces macros n’est définie. Sur les systèmes de fichiers qui ne supportent pas les horodatages plus précis que la seconde, ces champs nanosecondes sont renvoyés avec la valeur 0.

Pour la plupart des fichiers du répertoire proc, stat() ne renvoie pas la taille du fichier dans le champ st_size ; à la place, le champ contient la valeur 0.

VALEUR RENVOYÃE

Ces fonctions retournent zéro si elles réussissent. En cas d’échec, −1 est renvoyé, et errno contient le code d’erreur.

ERREURS

EACCES

La permission de parcours est refusée pour un des répertoires contenu dans le chemin path. (Voir aussi path_resolution(2).)

EBADF

filedes est un mauvais descripteur.

EFAULT

Un pointeur se trouve en dehors de l’espace d’adressage.

ELOOP

Trop de liens symboliques rencontrés dans le chemin d’accès.

ENAMETOOLONG

Nom de fichier trop long.

ENOENT

Un composant de path n’existe pas, ou il s’agit d’une chaîne vide.

ENOMEM

Pas assez de mémoire pour le noyau.

ENOTDIR

Un composant du chemin d’accès n’est pas un répertoire.

CONFORMITÃ

Ces appels système sont conformes à SVr4, BSD 4.3, POSIX.1-2001.

L’utilisation des champs st_blocks et st_blksize risque d’être moins portable. Ils ont été introduits dans BSD. Leur interprétation change suivant les systèmes, voire sur un même système s’il y a des montages NFS.

POSIX ne décrit pas les bits S_IFMT, S_IFSOCK, S_IFLNK, S_IFREG, S_IFBLK, S_IFDIR, S_IFCHR, S_IFIFO, S_ISVTX, mais réclame d’utiliser les macros S_ISDIR(), etc. Les macros S_ISLNK et S_ISSOCK ne se trouvent pas dans POSIX.1-1996 mais sont présentes dans POSIX.1-2001. La première vient de SVID 4, la seconde de SUSv2.

Unix V7 (et les systèmes suivants) propose S_IREAD, S_IWRITE, S_IEXEC, là où POSIX préfère leurs synonymes S_IRUSR, S_IWUSR, S_IXUSR.

AUTRES SYSTÃMES

Voici quelques valeurs qui ont été (ou sont) utilisées sur d’autres systèmes

Une commande sticky est apparue dans la version 32V d’AT&T UNIX.

VOIR AUSSI

access(2), chmod(2), chown(2), fstatat(2), readlink(2), utime(2), capabilities(7)

TRADUCTION

Ce document est une traduction réalisée par Christophe Blaess <http://www.blaess.fr/christophe/> le 15 octobre 1996 et révisée le 14 août 2006.

L’équipe de traduction a fait le maximum pour réaliser une adaptation française de qualité. La version anglaise la plus à jour de ce document est toujours consultable via la commande : « LANG=C man 2 stat ». N’hésitez pas à signaler à l’auteur ou au traducteur, selon le cas, toute erreur dans cette page de manuel.


stat(2)