d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
e2ed7941e0
freebsd-dev/include/dirent.h

144 lines
4.1 KiB
C
Raw Normal View History

BSD 4.4 Lite Include Sources
1994-05-24 09:57:34 +00:00
/*-
include: further adoption of SPDX licensing ID tags. Mainly focus on files that use BSD 3-Clause license. The Software Package Data Exchange (SPDX) group provides a specification to make it easier for automated tools to detect and summarize well known opensource licenses. We are gradually adopting the specification, noting that the tags are considered only advisory and do not, in any way, superceed or replace the license texts. Special thanks to Wind River for providing access to "The Duke of Highlander" tool: an older (2014) run over FreeBSD tree was useful as a starting point.
2017-11-20 19:45:28 +00:00
* SPDX-License-Identifier: BSD-3-Clause
*
BSD 4.4 Lite Include Sources
1994-05-24 09:57:34 +00:00
* Copyright (c) 1989, 1993
* The Regents of the University of California. 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.
Remove the Berkeley clause 3's. Add a few $FreeBSD$
2010-02-16 19:39:50 +00:00
* 3. Neither the name of the University nor the names of its contributors
BSD 4.4 Lite Include Sources
1994-05-24 09:57:34 +00:00
* 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.
*
Merge Lite2 changes onto mainline: - declare opendir2(), which is used to control how readdir() handles whiteouts etc.
1997-03-11 11:15:46 +00:00
* @(#)dirent.h 8.2 (Berkeley) 7/28/94
add pthread_cancel, obtained from OpenBSD. eischen (Daniel Eischen) added wrappers to protect against cancled threads orphaning internal resources. the cancelability code is still a bit fuzzy but works for test programs of my own, OpenBSD's and some examples from ORA's books. add readdir_r to both libc and libc_r add some 'const' attributes to function parameters Reviewed by: eischen, jasone
1999-11-28 05:38:13 +00:00
* $FreeBSD$
BSD 4.4 Lite Include Sources
1994-05-24 09:57:34 +00:00
*/
#ifndef _DIRENT_H_
#define _DIRENT_H_
/*
Remove trailing whitespace.
1995-05-30 05:05:38 +00:00
* The kernel defines the format of directory entries returned by
BSD 4.4 Lite Include Sources
1994-05-24 09:57:34 +00:00
* the getdirentries(2) system call.
*/
Fix namespace issues by using the relatively new visibility primitives.
2002-09-10 18:12:16 +00:00
#include <sys/cdefs.h>
Add missing declaration of ino_t. POSIX requires that <dirent.h> provides ino_t in the XSI case. In our case, this wasn't being exposed, as d_ino is a macro that expands to d_fileno that is an uint32_t, not an ino_t.
2016-05-30 07:50:57 +00:00
#include <sys/_types.h>
BSD 4.4 Lite Include Sources
1994-05-24 09:57:34 +00:00
#include <sys/dirent.h>
Commit the 64-bit inode project. Extend the ino_t, dev_t, nlink_t types to 64-bit ints. Modify struct dirent layout to add d_off, increase the size of d_fileno to 64-bits, increase the size of d_namlen to 16-bits, and change the required alignment. Increase struct statfs f_mntfromname[] and f_mntonname[] array length MNAMELEN to 1024. ABI breakage is mitigated by providing compatibility using versioned symbols, ingenious use of the existing padding in structures, and by employing other tricks. Unfortunately, not everything can be fixed, especially outside the base system. For instance, third-party APIs which pass struct stat around are broken in backward and forward incompatible ways. Kinfo sysctl MIBs ABI is changed in backward-compatible way, but there is no general mechanism to handle other sysctl MIBS which return structures where the layout has changed. It was considered that the breakage is either in the management interfaces, where we usually allow ABI slip, or is not important. Struct xvnode changed layout, no compat shims are provided. For struct xtty, dev_t tty device member was reduced to uint32_t. It was decided that keeping ABI compat in this case is more useful than reporting 64-bit dev_t, for the sake of pstat. Update note: strictly follow the instructions in UPDATING. Build and install the new kernel with COMPAT_FREEBSD11 option enabled, then reboot, and only then install new world. Credits: The 64-bit inode project, also known as ino64, started life many years ago as a project by Gleb Kurtsou (gleb). Kirk McKusick (mckusick) then picked up and updated the patch, and acted as a flag-waver. Feedback, suggestions, and discussions were carried by Ed Maste (emaste), John Baldwin (jhb), Jilles Tjoelker (jilles), and Rick Macklem (rmacklem). Kris Moore (kris) performed an initial ports investigation followed by an exp-run by Antoine Brodin (antoine). Essential and all-embracing testing was done by Peter Holm (pho). The heavy lifting of coordinating all these efforts and bringing the project to completion were done by Konstantin Belousov (kib). Sponsored by: The FreeBSD Foundation (emaste, kib) Differential revision: https://reviews.freebsd.org/D10439
2017-05-23 09:29:05 +00:00
#if __BSD_VISIBLE
#ifndef _SIZE_T_DECLARED
typedef __size_t size_t;
#define _SIZE_T_DECLARED
#endif
#ifndef _SSIZE_T_DECLARED
typedef __ssize_t ssize_t;
#define _SSIZE_T_DECLARED
#endif
#ifndef _OFF_T_DECLARED
typedef __off_t off_t;
#define _OFF_T_DECLARED
#endif
#endif /* __BSD_VISIBLE */
include: Remove checks for __BSD_VISIBLE where redundant with __XSI_VISIBLE or __POSIX_VISIBLE. Whenever <sys/cdefs.h> sets __BSD_VISIBLE to non-zero, it also sets __POSIX_VISIBLE and __XSI_VISIBLE to the newest version supported. No functional change is intended.
2014-05-11 13:48:21 +00:00
#if __XSI_VISIBLE
Add missing declaration of ino_t. POSIX requires that <dirent.h> provides ino_t in the XSI case. In our case, this wasn't being exposed, as d_ino is a macro that expands to d_fileno that is an uint32_t, not an ino_t.
2016-05-30 07:50:57 +00:00
#ifndef _INO_T_DECLARED
typedef __ino_t ino_t;
#define _INO_T_DECLARED
#endif
Fix namespace issues by using the relatively new visibility primitives.
2002-09-10 18:12:16 +00:00
/*
* XXX this is probably illegal in the __XSI_VISIBLE case, but brings us closer
* to the specification.
*/
#define d_ino d_fileno /* backward and XSI compatibility */
Add missing declaration of ino_t. POSIX requires that <dirent.h> provides ino_t in the XSI case. In our case, this wasn't being exposed, as d_ino is a macro that expands to d_fileno that is an uint32_t, not an ino_t.
2016-05-30 07:50:57 +00:00
#endif /* __XSI_VISIBLE */
BSD 4.4 Lite Include Sources
1994-05-24 09:57:34 +00:00
Fix namespace issues by using the relatively new visibility primitives.
2002-09-10 18:12:16 +00:00
#if __BSD_VISIBLE
BSD 4.4 Lite Include Sources
1994-05-24 09:57:34 +00:00
Change the definition of NULL on ia64 (for LP64 compilations) from an int constant to a long constant. This change improves consistency in the following two ways: 1. The first 8 arguments are always passed in registers on ia64, which by virtue of the generated code implicitly widens ints to longs and allows the use of an 32-bit integral type for 64-bit arguments. Subsequent arguments are passed onto the memory stack, which does not exhibit the same behaviour and consequently do not allow this. In practice this means that variadic functions taking pointers and given NULL (without cast) work as long as the NULL is passed in one of the first 8 arguments. A SIGSEGV is more likely the result if such would be done for stack-based arguments. This is due to the fact that the upper 4 bytes remain undefined. 2. All 64-bit platforms that FreeBSD supports, with the obvious exception of ia64, allow 32-bit integral types (specifically NULL) when 64-bit pointers are expected in variadic functions by way of how the compiler generates code. As such, code that works correctly (whether rightfully so or not) on any platform other than ia64, may fail on ia64. To more easily allow tweaking of the definition of NULL, this commit removes the 12 definitions in the various headers and puts it in a new header that can be included whenever NULL is to be made visible. This commit fixes GNOME, emacs, xemacs and a whole bunch of ports that I don't particularly care about at this time...
2003-12-07 21:10:06 +00:00
#include <sys/_null.h>
BSD 4.4 Lite Include Sources
1994-05-24 09:57:34 +00:00
/* definitions for library routines operating on directories. */
#define DIRBLKSIZ 1024
Hide DIR definition by making it an opaque struct typedef. Introduce dirfd() libc exported symbol replacing macro with same name, preserve _dirfd() macro for internal use. Replace dirp->dd_fd with dirfd() call. Avoid using dirfd as variable name to prevent shadowing global symbol. Sponsored by: Google Summer Of Code 2011
2012-05-19 12:44:27 +00:00
struct _dirdesc;
typedef struct _dirdesc DIR;
BSD 4.4 Lite Include Sources
1994-05-24 09:57:34 +00:00
Merge Lite2 changes onto mainline: - declare opendir2(), which is used to control how readdir() handles whiteouts etc.
1997-03-11 11:15:46 +00:00
/* flags for opendir2 */
#define DTF_HIDEW 0x0001 /* hide whiteout entries */
#define DTF_NODUP 0x0002 /* don't return duplicate names */
#define DTF_REWIND 0x0004 /* rewind after reading union stack */
#define __DTF_READALL 0x0008 /* everything has been read */
Fix some edge cases with rewinddir(): - In the unionfs case, opendir() and fdopendir() read the directory's full contents and cache it. This cache is not refreshed when rewinddir() is called, so rewinddir() will not notice updates to a directory. Fix this by splitting the code to fetch a directory's contents out of __opendir_common() into a new _filldir() function and call this from rewinddir() when operating on a unionfs directory. - If rewinddir() is called on a directory opened with fdopendir() before any directory entries are fetched, rewinddir() will not adjust the seek location of the backing file descriptor. If the file descriptor passed to fdopendir() had a non-zero offset, the rewinddir() will not rewind to the beginning. Fix this by always seeking back to 0 in rewinddir(). This means the dd_rewind hack can also be removed. While here, add missing locking to rewinddir(). CR: https://phabric.freebsd.org/D312 Reviewed by: jilles MFC after: 1 week
2014-07-11 16:16:26 +00:00
#define __DTF_SKIPREAD 0x0010 /* assume internal buffer is populated */
Merge Lite2 changes onto mainline: - declare opendir2(), which is used to control how readdir() handles whiteouts etc.
1997-03-11 11:15:46 +00:00
Fix namespace issues by using the relatively new visibility primitives.
2002-09-10 18:12:16 +00:00
#else /* !__BSD_VISIBLE */
BSD 4.4 Lite Include Sources
1994-05-24 09:57:34 +00:00
Fix namespace issues by using the relatively new visibility primitives.
2002-09-10 18:12:16 +00:00
typedef void * DIR;
BSD 4.4 Lite Include Sources
1994-05-24 09:57:34 +00:00
Fix namespace issues by using the relatively new visibility primitives.
2002-09-10 18:12:16 +00:00
#endif /* __BSD_VISIBLE */
#ifndef _KERNEL
BSD 4.4 Lite Include Sources
1994-05-24 09:57:34 +00:00
__BEGIN_DECLS
Move scandir(3) and alphasort(3) into XSI namespace. Noted and reviewed by: bde MFC after: 2 weeks
2010-01-05 20:17:13 +00:00
#if __POSIX_VISIBLE >= 200809 || __XSI_VISIBLE >= 700
int alphasort(const struct dirent **, const struct dirent **);
Hide DIR definition by making it an opaque struct typedef. Introduce dirfd() libc exported symbol replacing macro with same name, preserve _dirfd() macro for internal use. Replace dirp->dd_fd with dirfd() call. Avoid using dirfd as variable name to prevent shadowing global symbol. Sponsored by: Google Summer Of Code 2011
2012-05-19 12:44:27 +00:00
int dirfd(DIR *);
Move scandir(3) and alphasort(3) into XSI namespace. Noted and reviewed by: bde MFC after: 2 weeks
2010-01-05 20:17:13 +00:00
#endif
Fix namespace issues by using the relatively new visibility primitives.
2002-09-10 18:12:16 +00:00
#if __BSD_VISIBLE
DIR *__opendir2(const char *, int);
Implement fdclosedir(3) function, which is equivalent to the closedir(3) function, but returns directory file descriptor instead of closing it. Submitted by: Mariusz Zaborski <oshogbo@FreeBSD.org> Sponsored by: Google Summer of Code 2013
2013-08-18 20:11:34 +00:00
int fdclosedir(DIR *);
Commit the 64-bit inode project. Extend the ino_t, dev_t, nlink_t types to 64-bit ints. Modify struct dirent layout to add d_off, increase the size of d_fileno to 64-bits, increase the size of d_namlen to 16-bits, and change the required alignment. Increase struct statfs f_mntfromname[] and f_mntonname[] array length MNAMELEN to 1024. ABI breakage is mitigated by providing compatibility using versioned symbols, ingenious use of the existing padding in structures, and by employing other tricks. Unfortunately, not everything can be fixed, especially outside the base system. For instance, third-party APIs which pass struct stat around are broken in backward and forward incompatible ways. Kinfo sysctl MIBs ABI is changed in backward-compatible way, but there is no general mechanism to handle other sysctl MIBS which return structures where the layout has changed. It was considered that the breakage is either in the management interfaces, where we usually allow ABI slip, or is not important. Struct xvnode changed layout, no compat shims are provided. For struct xtty, dev_t tty device member was reduced to uint32_t. It was decided that keeping ABI compat in this case is more useful than reporting 64-bit dev_t, for the sake of pstat. Update note: strictly follow the instructions in UPDATING. Build and install the new kernel with COMPAT_FREEBSD11 option enabled, then reboot, and only then install new world. Credits: The 64-bit inode project, also known as ino64, started life many years ago as a project by Gleb Kurtsou (gleb). Kirk McKusick (mckusick) then picked up and updated the patch, and acted as a flag-waver. Feedback, suggestions, and discussions were carried by Ed Maste (emaste), John Baldwin (jhb), Jilles Tjoelker (jilles), and Rick Macklem (rmacklem). Kris Moore (kris) performed an initial ports investigation followed by an exp-run by Antoine Brodin (antoine). Essential and all-embracing testing was done by Peter Holm (pho). The heavy lifting of coordinating all these efforts and bringing the project to completion were done by Konstantin Belousov (kib). Sponsored by: The FreeBSD Foundation (emaste, kib) Differential revision: https://reviews.freebsd.org/D10439
2017-05-23 09:29:05 +00:00
ssize_t getdents(int, char *, size_t);
ssize_t getdirentries(int, char *, size_t, off_t *);
Fix namespace issues by using the relatively new visibility primitives.
2002-09-10 18:12:16 +00:00
#endif
style(9): line up function names.
2002-09-09 03:52:43 +00:00
DIR *opendir(const char *);
Implement fdopendir(3) by splitting __opendir2() into two parts, the upper part deals with the usual __opendir2() calls, and the rest part with an interface translator to expose fdopendir(3) functionality. Manual page was obtained from kib@'s work for *at(2) system calls.
2008-04-16 18:59:36 +00:00
DIR *fdopendir(int);
style(9): line up function names.
2002-09-09 03:52:43 +00:00
struct dirent *
readdir(DIR *);
Fix namespace issues by using the relatively new visibility primitives.
2002-09-10 18:12:16 +00:00
#if __POSIX_VISIBLE >= 199506 || __XSI_VISIBLE >= 500
int readdir_r(DIR *, struct dirent *, struct dirent **);
#endif
style(9): line up function names.
2002-09-09 03:52:43 +00:00
void rewinddir(DIR *);
Move scandir(3) and alphasort(3) into XSI namespace. Noted and reviewed by: bde MFC after: 2 weeks
2010-01-05 20:17:13 +00:00
#if __POSIX_VISIBLE >= 200809 || __XSI_VISIBLE >= 700
style(9): line up function names.
2002-09-09 03:52:43 +00:00
int scandir(const char *, struct dirent ***,
Modernize scandir(3) and alphasort(3) interfaces according to the IEEE Std 1003.1-2008. Both Linux and Solaris conforms to the new definitions, so we better follow too (older glibc used old BSDish alphasort prototype and corresponding type of the comparision function for scandir). While there, change the definitions of the functions to ANSI C and fix several style issues nearby. Remove requirement for "sys/types.h" include for functions from manpage. POSIX also requires that alphasort(3) sorts as if strcoll(3) was used, but leave the strcmp(3) call in the function for now. Adapt in-tree callers of scandir(3) to new declaration. The fact that select_sections() from catman(1) could modify supplied struct dirent is a bug. PR: standards/142255 MFC after: 2 weeks
2010-01-04 15:40:17 +00:00
int (*)(const struct dirent *), int (*)(const struct dirent **,
const struct dirent **));
Add support for some block functions that come from OS X. These are intended to build with any C compiler. Reviewed by: pfg MFC after: 3 weeks
2014-04-02 16:07:48 +00:00
#ifdef __BLOCKS__
int scandir_b(const char *, struct dirent ***,
int (^)(const struct dirent *),
int (^)(const struct dirent **, const struct dirent **));
#endif
Fix namespace issues by using the relatively new visibility primitives.
2002-09-10 18:12:16 +00:00
#endif
#if __XSI_VISIBLE
void seekdir(DIR *, long);
long telldir(DIR *);
#endif
int closedir(DIR *);
BSD 4.4 Lite Include Sources
1994-05-24 09:57:34 +00:00
__END_DECLS
Change #ifdef KERNEL to #ifdef _KERNEL in the public headers. "KERNEL" is an application space macro and the applications are supposed to be free to use it as they please (but cannot). This is consistant with the other BSD's who made this change quite some time ago. More commits to come.
1999-12-29 05:07:58 +00:00
#endif /* !_KERNEL */
BSD 4.4 Lite Include Sources
1994-05-24 09:57:34 +00:00
#endif /* !_DIRENT_H_ */
Reference in New Issue Copy Permalink