xref: /freebsd/lib/libc/gen/gen-private.h (revision f39bffc62c1395bde25d152c7f68fdf7cbaab414)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
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  * $FreeBSD$
32  */
33 
34 #ifndef _GEN_PRIVATE_H_
35 #define	_GEN_PRIVATE_H_
36 
37 struct _telldir;		/* see telldir.h */
38 struct pthread_mutex;
39 
40 /*
41  * Structure describing an open directory.
42  *
43  * NOTE. Change structure layout with care, at least dd_fd field has to
44  * remain unchanged to guarantee backward compatibility.
45  */
46 struct _dirdesc {
47 	int	dd_fd;		/* file descriptor associated with directory */
48 	long	dd_loc;		/* offset in current buffer */
49 	long	dd_size;	/* amount of data returned by getdirentries */
50 	char	*dd_buf;	/* data buffer */
51 	int	dd_len;		/* size of data buffer */
52 	off_t	dd_seek;	/* magic cookie returned by getdirentries */
53 	int	dd_flags;	/* flags for readdir */
54 	struct pthread_mutex	*dd_lock;	/* lock */
55 	struct _telldir *dd_td;	/* telldir position recording */
56 	void	*dd_compat_de;	/* compat dirent */
57 };
58 
59 #define	_dirfd(dirp)	((dirp)->dd_fd)
60 
61 struct dirent;
62 int __readdir_r(DIR *dirp, struct dirent *entry, struct dirent **result);
63 
64 #endif /* !_GEN_PRIVATE_H_ */
65