include/dirent.h

   1 /*-
   2  * Copyright (c) 1989, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. All advertising materials mentioning features or use of this software
  14  *    must display the following acknowledgement:
  15  *      This product includes software developed by the University of
  16  *      California, Berkeley and its contributors.
  17  * 4. Neither the name of the University nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  *
  33  *      @(#)dirent.h    8.2 (Berkeley) 7/28/94
  34  * $FreeBSD: src/include/dirent.h,v 1.7 1999/12/29 05:01:20 peter Exp $
  35  */
  36
  37 #ifndef _DIRENT_H_
  38 #define _DIRENT_H_
  39
  40 /*
  41  * The kernel defines the format of directory entries returned by
  42  * the getdirentries(2) system call.
  43  */
  44 #include <sys/dirent.h>
  45
  46 #ifdef _POSIX_SOURCE
  47 typedef void *  DIR;
  48 #else
  49
  50 /* definitions for library routines operating on directories. */
  51 #define DIRBLKSIZ       1024
  52
  53 /* structure describing an open directory. */
  54 typedef struct _dirdesc {
  55         int     dd_fd;          /* file descriptor associated with directory */
  56         long    dd_loc;         /* offset in current buffer */
  57         long    dd_size;        /* amount of data returned by getdirentries */
  58         char    *dd_buf;        /* data buffer */
  59         int     dd_len;         /* size of data buffer */
  60         long    dd_lastseek;    /* last seek index */
  61         long    dd_rewind;      /* magic cookie for rewinding */
  62         int     dd_flags;       /* flags for readdir */
  63         void    *dd_lock;       /* hack to avoid include <pthread.h> */
  64         off_t   dd_seek;        /* new magic cookie returned by getdirentries */
  65 } DIR;
  66
  67 #define dirfd(dirp)     ((dirp)->dd_fd)
  68
  69 /* flags for opendir2 */
  70 #define DTF_HIDEW       0x0001  /* hide whiteout entries */
  71 #define DTF_NODUP       0x0002  /* don't return duplicate names */
  72 #define DTF_REWIND      0x0004  /* rewind after reading union stack */
  73 #define __DTF_READALL   0x0008  /* everything has been read */
  74 #define __DTF_SKIPME    0x0010  /* next entry to read not current entry */
  75
  76 #include <sys/_null.h>
  77
  78 #endif /* _POSIX_SOURCE */
  79
  80 #ifndef _KERNEL
  81
  82 #include <sys/cdefs.h>
  83
  84 __BEGIN_DECLS
  85 DIR *opendir (const char *);
  86 DIR *fdopendir (int);
  87 struct dirent *readdir (DIR *);
  88 void rewinddir (DIR *);
  89 int closedir (DIR *);
  90 #if __POSIX_VISIBLE >= 200809 || __XSI_VISIBLE >= 700 || !defined(_POSIX_SOURCE)
  91 int alphasort (const struct dirent **, const struct dirent **);
  92 int scandir(const char *, struct dirent ***, int (*)(const struct dirent *),
  93         int (*)(const struct dirent **, const struct dirent **));
  94 #endif
  95 #ifndef _POSIX_SOURCE
  96 DIR *__opendir2 (const char *, int);
  97 DIR *__fdopendir2 (int, int);
  98 long telldir(DIR *);
  99 struct dirent *_readdir_unlocked(DIR *, int);
 100 void seekdir(DIR *, long);
 101 void _reclaim_telldir(DIR *);
 102 void _seekdir (DIR *, long);
 103 int getdents (int, char *, int);
 104 int getdirentries (int, char *, int, long *);
 105 int readdir_r (DIR *, struct dirent *, struct dirent **);
 106 #endif /* not POSIX */
 107 __END_DECLS
 108
 109 #endif /* !_KERNEL */
 110
 111 #endif /* !_DIRENT_H_ */