1/*	$NetBSD: dirent.h,v 1.37.2.1 2022/12/28 18:00:15 martin Exp $	*/
  2
  3/*-
  4 * Copyright (c) 1989, 1993
  5 *	The Regents of the University of California.  All rights reserved.
  6 *
  7 * Redistribution and use in source and binary forms, with or without
  8 * modification, are permitted provided that the following conditions
  9 * are met:
 10 * 1. Redistributions of source code must retain the above copyright
 11 *    notice, this list of conditions and the following disclaimer.
 12 * 2. Redistributions in binary form must reproduce the above copyright
 13 *    notice, this list of conditions and the following disclaimer in the
 14 *    documentation and/or other materials provided with the distribution.
 15 * 3. Neither the name of the University nor the names of its contributors
 16 *    may be used to endorse or promote products derived from this software
 17 *    without specific prior written permission.
 18 *
 19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 22 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 29 * SUCH DAMAGE.
 30 *
 31 *	@(#)dirent.h	8.2 (Berkeley) 7/28/94
 32 */
 33
 34#ifndef _DIRENT_H_
 35#define _DIRENT_H_
 36
 37#include <sys/featuretest.h>
 38#include <sys/types.h>
 39
 40/*
 41 * The kernel defines the format of directory entries returned by 
 42 * the getdents(2) system call.
 43 */
 44#include <sys/dirent.h>
 45
 46#if defined(_XOPEN_SOURCE) || defined(_NETBSD_SOURCE)
 47#define	d_ino		d_fileno	/* backward compatibility */
 48#endif
 49
 50typedef struct _dirdesc DIR;
 51
 52#if defined(_NETBSD_SOURCE)
 53
 54/* definitions for library routines operating on directories. */
 55#define	DIRBLKSIZ	1024
 56
 57/* structure describing an open directory. */
 58struct _dirdesc {
 59	/*
 60	 * dd_fd should be kept intact to preserve ABI compat.  see dirfd().
 61	 */
 62	int	dd_fd;		/* file descriptor associated with directory */
 63	/*
 64	 * the rest is hidden from user.
 65	 */
 66	long	dd_loc;		/* offset in current buffer */
 67	long	dd_size;	/* amount of data returned by getdents */
 68	char	*dd_buf;	/* data buffer */
 69	int	dd_len;		/* size of data buffer */
 70	off_t	dd_seek;	/* magic cookie returned by getdents */
 71	void	*dd_internal;	/* state for seekdir/telldir */
 72	int	dd_flags;	/* flags for readdir */
 73	void	*dd_lock;	/* lock for concurrent access */
 74};
 75
 76#define	dirfd(dirp)	((dirp)->dd_fd)
 77
 78/* flags for __opendir2() */
 79#define DTF_HIDEW	0x0001	/* hide whiteout entries */
 80#define DTF_NODUP	0x0002	/* don't return duplicate names */
 81#define DTF_REWIND	0x0004	/* rewind after reading union stack */
 82#define __DTF_READALL	0x0008	/* everything has been read */
 83#define __DTF_RETRY_ON_BADCOOKIE 0x0001	/* retry on EINVAL
 84					(only valid with __DTF_READALL) */
 85
 86#include <sys/null.h>
 87
 88#endif
 89
 90#ifndef _KERNEL
 91
 92#include <sys/cdefs.h>
 93
 94__BEGIN_DECLS
 95int closedir(DIR *);
 96void rewinddir(DIR *);
 97#ifndef __LIBC12_SOURCE__
 98DIR *opendir(const char *) __RENAME(__opendir30);
 99struct dirent *readdir(DIR *) __RENAME(__readdir30);
100int readdir_r(DIR * __restrict, struct dirent * __restrict,
101    struct dirent ** __restrict) __RENAME(__readdir_r30);
102#endif
103#if defined(_XOPEN_SOURCE) || defined(_NETBSD_SOURCE)
104void seekdir(DIR *, long);
105long telldir(DIR *);
106#endif /* defined(_NETBSD_SOURCE) || defined(_XOPEN_SOURCE) */
107#if (_POSIX_C_SOURCE - 0) >= 200809L || (_XOPEN_SOURCE - 0) >= 700 || \
108    defined(_NETBSD_SOURCE)
109#ifndef __LIBC12_SOURCE__
110DIR *fdopendir(int);
111int scandir(const char *, struct dirent ***,
112    int (*)(const struct dirent *), int (*)(const struct dirent **,
113    const struct dirent **))
114    __RENAME(__scandir30);
115int alphasort(const struct dirent **, const struct dirent **)
116    __RENAME(__alphasort30);
117#endif
118#endif
119#if defined(_NETBSD_SOURCE)
120#ifndef __LIBC12_SOURCE__
121DIR *__opendir2(const char *, int) __RENAME(__opendir230);
122int getdents(int, char *, size_t) __RENAME(__getdents30);
123#endif
124#endif /* defined(_NETBSD_SOURCE) */
125__END_DECLS
126
127#endif /* !_KERNEL */
128
129#endif /* !_DIRENT_H_ */