Provided by: manpages-fr-dev_3.57d1p1-1_all bug

NOM

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

SYNOPSIS

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

       Remarque :  il  n'existe  pas  de  fonction  glibc autour de cet appel système ; consultez
       NOTES.

DESCRIPTION

       Ce n'est pas la fonction qui vous intéresse. 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 l'interface de l'appel système du noyau.

       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 0) */
                                   /* La longueur est en fait (d_reclen - 2 -
                                      offsetof(struct linux_dirent, d_name)) */
               /*
               char           pad;       // Octet nul de remplissage
               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 nul.

       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'une 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 rempli par des zéros dans  la  structure  linux_dirent.
       Ainsi,  sur  les  noyaux  antérieurs à 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.

VALEUR RENVOYÉE

       getdents renvoie le nombre d'octets lus s'il réussit (0 en fin de répertoire), ou -1  s'il
       échoue, 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  glibc  ne  fournit  pas  de fonction autour de cet appel système ; vous devez utiliser
       syscall(2) pour l'appeler.  Vous  devrez  définir  la  structure  linux_dirent  vous-même.
       Cependant, readdir(3) peut avantageusement être utilisé à la place.

       Cette fonction remplace readdir(2).

       L'appel  système getdents() original de Linux ne permettait pas de gérer les gros fichiers
       et les positions dans les gros fichiers. En conséquence, Linux 2.4 a ajouté  getdents64(),
       avec un type élargi pour les champs d_ino et d_off de la structure linux_dirent.

EXEMPLE

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

           $ ./a.out /testfs/
           --------------- nread=120 ---------------
           i-node#  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>     /* Définie les constantes DT_* */
       #include <fcntl.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 {
           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, nread;
           char buf[BUF_SIZE];
           struct linux_dirent *d;
           int bpos;
           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("i-node#  file type  d_reclen  d_off   d_name\n");
               for (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 %10lld  %s\n", d->d_reclen,
                           (long long) d->d_off, d->d_name);
                   bpos += d->d_reclen;
               }
           }

           exit(EXIT_SUCCESS);
       }

VOIR AUSSI

       readdir(2), readdir(3)

COLOPHON

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

TRADUCTION

       Depuis   2010,   cette   traduction   est   maintenue   à   l'aide   de    l'outil    po4a
       <http://po4a.alioth.debian.org/>  par l'équipe de traduction francophone au sein du projet
       perkamon <http://perkamon.alioth.debian.org/>.

       Christophe   Blaess   <http://www.blaess.fr/christophe/>   (1996-2003),    Alain    Portal
       <http://manpagesfr.free.fr/>  (2003-2006).  Julien  Cristau  et  l'équipe  francophone  de
       traduction de Debian (2006-2009).

       Veuillez     signaler     toute     erreur     de     traduction     en     écrivant     à
       <debian-l10n-french@lists.debian.org>   ou   par   un  rapport  de  bogue  sur  le  paquet
       manpages-fr.

       Vous pouvez toujours avoir accès à la version anglaise de  ce  document  en  utilisant  la
       commande « man -L C <section> <page_de_man> ».