[apple/libc.git] / gen / FreeBSD / telldir.h

/*
 * Copyright (c) 1983, 1993
 *	The Regents of the University of California.  All rights reserved.
 *
 * Copyright (c) 2000
 * 	Daniel Eischen.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * $FreeBSD: src/lib/libc/gen/telldir.h,v 1.3 2008/05/05 14:05:23 kib Exp $
 */

#ifndef _TELLDIR_H_
#define	_TELLDIR_H_

#include <sys/queue.h>
#include <stdbool.h>

/*
 * One of these structures is malloced to describe the current directory
 * position each time telldir is called. It records the current magic
 * cookie returned by getdirentries and the offset within the buffer
 * associated with that return value.
 */
struct ddloc {
	LIST_ENTRY(ddloc) loc_lqe; /* entry in list */
	long	loc_index;	/* key associated with structure */
#if __DARWIN_64_BIT_INO_T
	__darwin_off_t	loc_seek;	/* returned by lseek */
#else /* !__DARWIN_64_BIT_INO_T */
	long	loc_seek;	/* magic cookie returned by getdirentries */
#endif /* __DARWIN_64_BIT_INO_T */
	long	loc_loc;	/* offset of entry in buffer */
};

/*
 * One of these structures is malloced for each DIR to record telldir
 * positions.
 */
struct _telldir {
	LIST_HEAD(, ddloc) td_locq; /* list of locations */
	long	td_loccnt;	/* index of entry for sequential readdir's */
#if __DARWIN_64_BIT_INO_T
	__darwin_off_t seekoff;	/* 64-bit seek offset */
#endif /* __DARWIN_64_BIT_INO_T */
};

#if __DARWIN_64_BIT_INO_T
size_t		__getdirentries64(int fd, void *buf, size_t bufsize, __darwin_off_t *basep);
#endif /* __DARWIN_64_BIT_INO_T */
__attribute__ ((visibility ("hidden")))
bool           _filldir(DIR *, bool) __DARWIN_INODE64(_filldir);
struct dirent	*_readdir_unlocked(DIR *, int) __DARWIN_INODE64(_readdir_unlocked);
void 		_reclaim_telldir(DIR *);
void 		_seekdir(DIR *, long) __DARWIN_ALIAS_I(_seekdir);
__attribute__ ((visibility ("hidden")))
void        _fixtelldir(DIR *dirp, long oldseek, long oldloc) __DARWIN_INODE64(_fixtelldir);
long		telldir(DIR *) __DARWIN_ALIAS_I(telldir);

#endif
Commit	Line	Data
9385eb3d A	1	/*
9385eb3d A	2	* Copyright (c) 1983, 1993
e9ce8d39 A	3	* The Regents of the University of California. All rights reserved.
e9ce8d39 A	4	*
9385eb3d A	5	* Copyright (c) 2000
9385eb3d A	6	* Daniel Eischen. All rights reserved.
e9ce8d39 A	7	*
	8	* Redistribution and use in source and binary forms, with or without
	9	* modification, are permitted provided that the following conditions
	10	* are met:
	11	* 1. Redistributions of source code must retain the above copyright
	12	* notice, this list of conditions and the following disclaimer.
	13	* 2. Redistributions in binary form must reproduce the above copyright
	14	* notice, this list of conditions and the following disclaimer in the
	15	* documentation and/or other materials provided with the distribution.
9385eb3d	16	* 3. Neither the name of the University nor the names of its contributors
e9ce8d39 A	17	* may be used to endorse or promote products derived from this software
	18	* without specific prior written permission.
	19	*
	20	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	21	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	22	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	23	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	24	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	25	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	26	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	27	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	28	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	29	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	30	* SUCH DAMAGE.
5b2abdfb	31	*
1f2f436a	32	* $FreeBSD: src/lib/libc/gen/telldir.h,v 1.3 2008/05/05 14:05:23 kib Exp $
e9ce8d39 A	33	*/
e9ce8d39 A	34
9385eb3d A	35	#ifndef _TELLDIR_H_
	36	#define _TELLDIR_H_
	37
	38	#include <sys/queue.h>
b061a43b	39	#include <stdbool.h>
9385eb3d	40
e9ce8d39	41	/*
9385eb3d A	42	* One of these structures is malloced to describe the current directory
	43	* position each time telldir is called. It records the current magic
	44	* cookie returned by getdirentries and the offset within the buffer
	45	* associated with that return value.
e9ce8d39	46	*/
9385eb3d A	47	struct ddloc {
	48	LIST_ENTRY(ddloc) loc_lqe; /* entry in list */
	49	long loc_index; /* key associated with structure */
ad3c9f2a A	50	#if __DARWIN_64_BIT_INO_T
	51	__darwin_off_t loc_seek; /* returned by lseek */
	52	#else /* !__DARWIN_64_BIT_INO_T */
9385eb3d	53	long loc_seek; /* magic cookie returned by getdirentries */
ad3c9f2a	54	#endif /* __DARWIN_64_BIT_INO_T */
9385eb3d	55	long loc_loc; /* offset of entry in buffer */
e9ce8d39	56	};
9385eb3d A	57
	58	/*
	59	* One of these structures is malloced for each DIR to record telldir
	60	* positions.
	61	*/
	62	struct _telldir {
	63	LIST_HEAD(, ddloc) td_locq; /* list of locations */
	64	long td_loccnt; /* index of entry for sequential readdir's */
ad3c9f2a A	65	#if __DARWIN_64_BIT_INO_T
	66	__darwin_off_t seekoff; /* 64-bit seek offset */
	67	#endif /* __DARWIN_64_BIT_INO_T */
e9ce8d39 A	68	};
e9ce8d39 A	69
ad3c9f2a A	70	#if __DARWIN_64_BIT_INO_T
	71	size_t __getdirentries64(int fd, void buf, size_t bufsize, __darwin_off_t basep);
	72	#endif /* __DARWIN_64_BIT_INO_T */
b061a43b A	73	__attribute__ ((visibility ("hidden")))
b061a43b A	74	bool _filldir(DIR *, bool) __DARWIN_INODE64(_filldir);
ad3c9f2a	75	struct dirent _readdir_unlocked(DIR , int) __DARWIN_INODE64(_readdir_unlocked);
9385eb3d	76	void _reclaim_telldir(DIR *);
ad3c9f2a	77	void _seekdir(DIR *, long) __DARWIN_ALIAS_I(_seekdir);
b061a43b A	78	__attribute__ ((visibility ("hidden")))
b061a43b A	79	void _fixtelldir(DIR *dirp, long oldseek, long oldloc) __DARWIN_INODE64(_fixtelldir);
ad3c9f2a	80	long telldir(DIR *) __DARWIN_ALIAS_I(telldir);
9385eb3d	81
e9ce8d39	82	#endif