1 /*
2  * Copyright (c) 1989, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 4. Neither the name of the University nor the names of its contributors
14  *    may be used to endorse or promote products derived from this software
15  *    without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  *	@(#)fts.h	8.3 (Berkeley) 8/14/94
30  */
31 
32 #ifndef	_FTS_H
33 #define	_FTS_H 1
34 
35 #include <features.h>
36 #include <sys/types.h>
37 
38 /* The fts interface is incompatible with the LFS interface which
39    transparently uses the 64-bit file access functions.  */
40 #ifdef __USE_FILE_OFFSET64
41 # error "<fts.h> cannot be used with -D_FILE_OFFSET_BITS==64"
42 #endif
43 
44 
45 typedef struct {
46 	struct _ftsent *fts_cur;	/* current node */
47 	struct _ftsent *fts_child;	/* linked list of children */
48 	struct _ftsent **fts_array;	/* sort array */
49 	dev_t fts_dev;			/* starting device # */
50 	char *fts_path;			/* path for this descent */
51 	int fts_rfd;			/* fd for root */
52 	int fts_pathlen;		/* sizeof(path) */
53 	int fts_nitems;			/* elements in the sort array */
54 	int (*fts_compar) (const void *, const void *); /* compare fn */
55 
56 #define	FTS_COMFOLLOW	0x0001		/* follow command line symlinks */
57 #define	FTS_LOGICAL	0x0002		/* logical walk */
58 #define	FTS_NOCHDIR	0x0004		/* don't change directories */
59 #define	FTS_NOSTAT	0x0008		/* don't get stat info */
60 #define	FTS_PHYSICAL	0x0010		/* physical walk */
61 #define	FTS_SEEDOT	0x0020		/* return dot and dot-dot */
62 #define	FTS_XDEV	0x0040		/* don't cross devices */
63 #define FTS_WHITEOUT	0x0080		/* return whiteout information */
64 #define	FTS_OPTIONMASK	0x00ff		/* valid user option mask */
65 
66 #define	FTS_NAMEONLY	0x0100		/* (private) child names only */
67 #define	FTS_STOP	0x0200		/* (private) unrecoverable error */
68 	int fts_options;		/* fts_open options, global flags */
69 } FTS;
70 
71 typedef struct _ftsent {
72 	struct _ftsent *fts_cycle;	/* cycle node */
73 	struct _ftsent *fts_parent;	/* parent directory */
74 	struct _ftsent *fts_link;	/* next file in directory */
75 	long fts_number;	        /* local numeric value */
76 	void *fts_pointer;	        /* local address value */
77 	char *fts_accpath;		/* access path */
78 	char *fts_path;			/* root path */
79 	int fts_errno;			/* errno for this node */
80 	int fts_symfd;			/* fd for symlink */
81 	u_short fts_pathlen;		/* strlen(fts_path) */
82 	u_short fts_namelen;		/* strlen(fts_name) */
83 
84 	ino_t fts_ino;			/* inode */
85 	dev_t fts_dev;			/* device */
86 	nlink_t fts_nlink;		/* link count */
87 
88 #define	FTS_ROOTPARENTLEVEL	-1
89 #define	FTS_ROOTLEVEL		 0
90 	short fts_level;		/* depth (-1 to N) */
91 
92 #define	FTS_D		 1		/* preorder directory */
93 #define	FTS_DC		 2		/* directory that causes cycles */
94 #define	FTS_DEFAULT	 3		/* none of the above */
95 #define	FTS_DNR		 4		/* unreadable directory */
96 #define	FTS_DOT		 5		/* dot or dot-dot */
97 #define	FTS_DP		 6		/* postorder directory */
98 #define	FTS_ERR		 7		/* error; errno is set */
99 #define	FTS_F		 8		/* regular file */
100 #define	FTS_INIT	 9		/* initialized only */
101 #define	FTS_NS		10		/* stat(2) failed */
102 #define	FTS_NSOK	11		/* no stat(2) requested */
103 #define	FTS_SL		12		/* symbolic link */
104 #define	FTS_SLNONE	13		/* symbolic link without target */
105 #define FTS_W		14		/* whiteout object */
106 	u_short fts_info;		/* user flags for FTSENT structure */
107 
108 #define	FTS_DONTCHDIR	 0x01		/* don't chdir .. to the parent */
109 #define	FTS_SYMFOLLOW	 0x02		/* followed a symlink to get here */
110 	u_short fts_flags;		/* private flags for FTSENT structure */
111 
112 #define	FTS_AGAIN	 1		/* read node again */
113 #define	FTS_FOLLOW	 2		/* follow symbolic link */
114 #define	FTS_NOINSTR	 3		/* no instructions */
115 #define	FTS_SKIP	 4		/* discard node */
116 	u_short fts_instr;		/* fts_set() instructions */
117 
118 	struct stat *fts_statp;		/* stat(2) information */
119 	char fts_name[1];		/* file name */
120 } FTSENT;
121 
122 __BEGIN_DECLS
123 FTSENT	*fts_children (FTS *, int);
124 int	 fts_close (FTS *);
125 FTS	*fts_open (char * const *, int,
126 		   int (*)(const FTSENT **, const FTSENT **));
127 FTSENT	*fts_read (FTS *);
128 int	 fts_set (FTS *, FTSENT *, int) __THROW;
129 __END_DECLS
130 
131 #endif /* fts.h */
132