Provided by: manpages-fr-dev_4.13-4_all bug

NOM

       getdents, getdents64 - Obtenir les points d'entrée d'un répertoire

SYNOPSIS

       long getdents(unsigned int fd, struct linux_dirent *dirp,
                    unsigned int count);

       #define _GNU_SOURCE        /* See feature_test_macros(7) */
       #include <dirent.h>

       ssize_t getdents64(int fd, void *dirp, size_t count);

       Note : il n'existe pas d'enveloppe glibc pour getdents() ; voir les NOTES.

DESCRIPTION

       Ce  ne  sont pas des interfaces qui vous intéressent. Veuillez regarder readdir(3) pour l'interface de la
       fonction de même nom de la bibliothèque C conforme à la spécification POSIX.  Cette  page  documente  les
       interfaces de l'appel système du noyau.

   getdents()
       L'appel  système  getdents()  lit plusieurs structures linux_dirent depuis le répertoire référencé par le
       descripteur de fichier ouvert fd et les place dans la zone de mémoire  pointée  par  dirp.  Le  paramètre
       count spécifie la taille de cette zone mémoire.

       La structure linux_dirent est déclarée comme ceci :

           struct linux_dirent {
               unsigned long  d_ino;     /* Numéro d'inœud */
               unsigned long  d_off;     /* Distance au prochain linux_dirent */
               unsigned short d_reclen;  /* Longueur de ce linux_dirent */
               char           d_name[];  /* Nom de fichier (fini par NULL) */
                                 /* La longueur est en fait (d_reclen - 2 -
                                    offsetof(struct linux_dirent, d_name)) */
               /*
               char           pad;       // Octet de remplissage avec des zéros
               char           d_type;    // Type de fichier (seulement depuis
                                         // Linux 2.6.4) ; sa position est
                                         // (d_reclen - 1)
               */

       d_ino  est  un  numéro  d'inœud.  d_off  est  la  distance entre le début du répertoire et le début de la
       prochaine structure linux_dirent. d_reclen est la taille complète de linux_dirent. d_name est le  nom  de
       fichier terminé par un caractère NULL.

       d_type  est un octet placé à la fin de la structure qui indique le type du fichier. Il contient l'une des
       valeurs suivantes (définies dans <dirent.h>) :

       DT_BLK      Il s'agit d'un périphérique bloc.

       DT_CHR      Il s'agit d'un périphérique caractère.

       DT_DIR      Il s'agit d'un répertoire

       DT_FIFO     Il s'agit d'un tube nommé (FIFO).

       DT_LNK      Il s'agit d'un lien symbolique.

       DT_REG      Il s'agit d'un fichier ordinaire.

       DT_SOCK     Il s'agit d'un socket de domaine UNIX.

       DT_UNKNOWN  Le type du fichier est inconnu.

       Le champ d_type est implémenté depuis Linux 2.6.4. Il occupe un espace qui était auparavant un  octet  de
       remplissage  composé de zéros dans la structure linux_dirent. Ainsi, sur les noyaux antérieurs ou égaux à
       2.6.3, les accès à ce champ fournissent toujours la valeur 0 (DT_UNKNOWN).

       Actuellement, seuls certains systèmes de fichiers (parmi lesquels Btrfs, ext2,  ext3  et  ext4)  prennent
       complètement  en  charge  le renvoi du type de fichier dans d_type. Toutes les applications doivent gérer
       correctement une valeur de retour valant DT_UNKNOWN.

   getdents64()
       L'appel système getdents() original de Linux ne permettait pas de gérer les gros systèmes de fichiers  et
       les  positions  dans  les  gros fichiers. En conséquence, Linux 2.4 a ajouté getdents64(), avec des types
       plus larges pour les champs d_ino et d_off. De plus, getdents64() gère un champ explicite d_type.

       L'appel système getdents64() est comme getdents(), sauf que son deuxième paramètre est un  pointeur  vers
       un tampon contenant des structures de type suivant :

           struct dirent {
               ino_t          d_ino;       /* numéro d'inœud 64 bits */
               off_t          d_off;       /* distance 64 bits vers
                                              la prochaine structure */
               unsigned short d_reclen;    /* longueur de ce dirent */
               unsigned char  d_type;      /* type du fichier */
               char           d_name[];    /* nom du fichier (terminé par NULL) */
           };

VALEUR RENVOYÉE

       En cas de réussite, le nombre d'octets est renvoyé. En fin de répertoire, 0 est renvoyé. En cas d’erreur,
       -1 est renvoyé, auquel cas errno contient le code d'erreur.

ERREURS

       EBADF  fd n'est pas un descripteur de fichier valable.

       EFAULT L'argument pointe en dehors de l'espace d'adressage du processus appelant.

       EINVAL Le tampon de résultat est trop petit.

       ENOENT Répertoire inexistant.

       ENOTDIR
              Le descripteur de fichier ne pointe pas sur un répertoire.

CONFORMITÉ

       SVr4.

NOTES

       La prise en charge par la bibliothèque de getdents64() a été ajoutée dans la glibc 2.30 ; il n'existe pas
       d'enveloppe  glibc pour getdents(). L'appel à getdents() (ou getdents64() sur des versions antérieures de
       la glibc) oblige à utiliser  syscall(2).  Dans  ce  cas,  vous  devrez  définir  vous-même  la  structure
       linux_dirent ou linux_dirent64.

       Vous voudrez probablement utiliser readdir(3) à la place de ces appels système.

       Ces appels remplacent readdir(2).

EXEMPLES

       Le  programme ci-dessous démontre l'utilisation de getdents(). La sortie suivante montre un exemple de ce
       que donne le programme sur un répertoire ext2 :

           $ ./a.out /testfs/
           --------------- nread=120 ---------------
           inode#    file type  d_reclen  d_off   d_name
                  2  directory    16         12  .
                  2  directory    16         24  ..
                 11  directory    24         44  lost+found
                 12  regular      16         56  a
             228929  directory    16         68  sub
              16353  directory    16         80  sub2
             130817  directory    16       4096  sub3

   Source du programme

       #define _GNU_SOURCE
       #include <dirent.h>     /* Defines DT_* constants */
       #include <fcntl.h>
       #include <stdint.h>
       #include <stdio.h>
       #include <unistd.h>
       #include <stdlib.h>
       #include <sys/stat.h>
       #include <sys/syscall.h>

       #define handle_error(msg) \
               do { perror(msg); exit(EXIT_FAILURE); } while (0)

       struct linux_dirent {
           unsigned long  d_ino;
           off_t          d_off;
           unsigned short d_reclen;
           char           d_name[];
       };

       #define BUF_SIZE 1024

       int
       main(int argc, char *argv[])
       {
           int fd;
           long nread;
           char buf[BUF_SIZE];
           struct linux_dirent *d;
           char d_type;

           fd = open(argc > 1 ? argv[1] : ".", O_RDONLY | O_DIRECTORY);
           if (fd == -1)
               handle_error("open");

           for (;;) {
               nread = syscall(SYS_getdents, fd, buf, BUF_SIZE);
               if (nread == -1)
                   handle_error("getdents");

               if (nread == 0)
                   break;

               printf("--------------- nread=%d ---------------\n", nread);
               printf("inode#    file type  d_reclen  d_off   d_name\n");
               for (long bpos = 0; bpos < nread;) {
                   d = (struct linux_dirent *) (buf + bpos);
                   printf("%8ld  ", d->d_ino);
                   d_type = *(buf + bpos + d->d_reclen - 1);
                   printf("%-10s ", (d_type == DT_REG) ? "regular" :
                                    (d_type == DT_DIR) ? "directory" :
                                    (d_type == DT_FIFO) ? "FIFO" :
                                    (d_type == DT_SOCK) ? "socket" :
                                    (d_type == DT_LNK) ? "symlink" :
                                    (d_type == DT_BLK) ? "block dev" :
                                    (d_type == DT_CHR) ? "char dev" : "???");
                   printf("%4d %10jd  %s\n", d->d_reclen,
                           (intmax_t) d->d_off, d->d_name);
                   bpos += d->d_reclen;
               }
           }

           exit(EXIT_SUCCESS);
       }

VOIR AUSSI

       readdir(2), readdir(3), inode(7)

COLOPHON

       Cette page fait partie de la publication 5.10 du projet man-pages Linux. Une description du projet et des
       instructions  pour  signaler  des  anomalies et la dernière version de cette page peuvent être trouvées à
       l'adresse https://www.kernel.org/doc/man-pages/.

TRADUCTION

       La  traduction  française   de   cette   page   de   manuel   a   été   créée   par   Christophe   Blaess
       <https://www.blaess.fr/christophe/>,   Stéphan   Rafin   <stephan.rafin@laposte.net>,   Thierry   Vignaud
       <tvignaud@mandriva.com>, François Micaux, Alain Portal  <aportal@univ-montp2.fr>,  Jean-Philippe  Guérard
       <fevrier@tigreraye.org>,   Jean-Luc   Coulon   (f5ibh)   <jean-luc.coulon@wanadoo.fr>,   Julien   Cristau
       <jcristau@debian.org>,     Thomas     Huriaux      <thomas.huriaux@gmail.com>,      Nicolas      François
       <nicolas.francois@centraliens.net>,     Florentin     Duneau    <fduneau@gmail.com>,    Simon    Paillard
       <simon.paillard@resel.enst-bretagne.fr>,    Denis    Barbier    <barbier@debian.org>,    David     Prévot
       <david@tilapin.org> et Jean-Philippe MENGUAL <jpmengual@debian.org>

       Cette  traduction  est  une  documentation libre ; veuillez vous reporter à la GNU General Public License
       version 3  ⟨https://www.gnu.org/licenses/gpl-3.0.html⟩  concernant  les  conditions  de   copie   et   de
       distribution. Il n'y a aucune RESPONSABILITÉ LÉGALE.

       Si  vous  découvrez  un  bogue  dans la traduction de cette page de manuel, veuillez envoyer un message à
       debian-l10n-french@lists.debian.org ⟨⟩.