1 /*- 2 * SPDX-License-Identifier: BSD-3-Clause 3 * 4 * Copyright (c) 1983, 1993 5 * The Regents of the University of California. All rights reserved. 6 * 7 * Copyright (c) 2000 8 * Daniel Eischen. All rights reserved. 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 3. Neither the name of the University nor the names of its contributors 19 * may be used to endorse or promote products derived from this software 20 * without specific prior written permission. 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32 * SUCH DAMAGE. 33 * 34 * $FreeBSD$ 35 */ 36 37 #ifndef _TELLDIR_H_ 38 #define _TELLDIR_H_ 39 40 #include <sys/queue.h> 41 #include <stdbool.h> 42 43 /* 44 * telldir will malloc one of these to describe the current directory position, 45 * if it can't fit that information into the packed structure below. It 46 * records the current magic cookie returned by getdirentries and the offset 47 * within the buffer associated with that return value. 48 */ 49 struct ddloc_mem { 50 LIST_ENTRY(ddloc_mem) loc_lqe; /* entry in list */ 51 long loc_index; /* key associated with structure */ 52 off_t loc_seek; /* magic cookie returned by getdirentries */ 53 long loc_loc; /* offset of entry in buffer */ 54 }; 55 56 #ifdef __LP64__ 57 #define DD_LOC_BITS 31 58 #define DD_SEEK_BITS 32 59 #define DD_INDEX_BITS 63 60 #else 61 #define DD_LOC_BITS 12 62 #define DD_SEEK_BITS 19 63 #define DD_INDEX_BITS 31 64 #endif 65 66 /* 67 * This is the real type returned by telldir. telldir will prefer to return 68 * the packed type, if possible, or the malloced type otherwise. For msdosfs, 69 * UFS, and NFS, directory positions usually fit within the packed type. For 70 * ZFS and tmpfs, they usually fit within the packed type on 64-bit 71 * architectures. 72 */ 73 union ddloc_packed { 74 long l; /* Opaque type returned by telldir(3) */ 75 struct { 76 /* Identifies union type. Must be 0. */ 77 unsigned long is_packed:1; 78 /* Index into directory's linked list of ddloc_mem */ 79 unsigned long index:DD_INDEX_BITS; 80 } __packed i; 81 struct { 82 /* Identifies union type. Must be 1. */ 83 unsigned long is_packed:1; 84 /* offset of entry in buffer*/ 85 unsigned long loc:DD_LOC_BITS; 86 /* magic cookie returned by getdirentries */ 87 unsigned long seek:DD_SEEK_BITS; 88 } __packed s; 89 }; 90 91 _Static_assert(sizeof(long) == sizeof(union ddloc_packed), 92 "packed telldir size mismatch!"); 93 94 /* 95 * One of these structures is malloced for each DIR to record telldir 96 * positions. 97 */ 98 struct _telldir { 99 LIST_HEAD(, ddloc_mem) td_locq; /* list of locations */ 100 long td_loccnt; /* index of entry for sequential readdir's */ 101 }; 102 103 bool _filldir(DIR *, bool); 104 struct dirent *_readdir_unlocked(DIR *, int); 105 void _reclaim_telldir(DIR *); 106 void _seekdir(DIR *, long); 107 void _fixtelldir(DIR *dirp, long oldseek, long oldloc); 108 109 #define RDU_SKIP 0x0001 110 #define RDU_SHORT 0x0002 111 112 #endif 113