xref: /illumos-gate/usr/src/head/fts.h (revision 93b8872871607b3d21317283c1230b2a4a00920b)
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  * 3. 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 
30 #ifndef	_FTS_H
31 #define	_FTS_H
32 
33 #ifdef	__cplusplus
34 extern "C" {
35 #endif
36 
37 typedef struct {
38 	struct _ftsent *fts_cur;	/* current node */
39 	struct _ftsent *fts_child;	/* linked list of children */
40 	struct _ftsent **fts_array;	/* sort array */
41 	dev_t fts_dev;			/* starting device # */
42 	char *fts_path;			/* path for this descent */
43 	int fts_rfd;			/* fd for root */
44 	size_t fts_pathlen;		/* sizeof(path) */
45 	int fts_nitems;			/* elements in the sort array */
46 	int (*fts_compar)();		/* compare function */
47 
48 #define	FTS_COMFOLLOW	0x0001		/* follow command line symlinks */
49 #define	FTS_LOGICAL	0x0002		/* logical walk */
50 #define	FTS_NOCHDIR	0x0004		/* don't change directories */
51 #define	FTS_NOSTAT	0x0008		/* don't get stat info */
52 #define	FTS_PHYSICAL	0x0010		/* physical walk */
53 #define	FTS_SEEDOT	0x0020		/* return dot and dot-dot */
54 #define	FTS_XDEV	0x0040		/* don't cross devices */
55 #define	FTS_OPTIONMASK	0x00ff		/* valid user option mask */
56 
57 #define	FTS_NAMEONLY	0x1000		/* (private) child names only */
58 #define	FTS_STOP	0x2000		/* (private) unrecoverable error */
59 	int fts_options;		/* fts_open options, global flags */
60 } FTS;
61 
62 typedef struct _ftsent {
63 	struct _ftsent *fts_cycle;	/* cycle node */
64 	struct _ftsent *fts_parent;	/* parent directory */
65 	struct _ftsent *fts_link;	/* next file in directory */
66 	long fts_number;		/* local numeric value */
67 	void *fts_pointer;		/* local address value */
68 	char *fts_accpath;		/* access path */
69 	char *fts_path;			/* root path */
70 	int fts_errno;			/* errno for this node */
71 	int fts_symfd;			/* fd for symlink */
72 	size_t fts_pathlen;		/* strlen(fts_path) */
73 	size_t fts_namelen;		/* strlen(fts_name) */
74 
75 	ino_t fts_ino;			/* inode */
76 	dev_t fts_dev;			/* device */
77 	nlink_t fts_nlink;		/* link count */
78 
79 #define	FTS_ROOTPARENTLEVEL	-1
80 #define	FTS_ROOTLEVEL		 0
81 #define	FTS_MAXLEVEL		 0x7fffffff
82 	int fts_level;		/* depth (-1 to N) */
83 
84 #define	FTS_D		 1		/* preorder directory */
85 #define	FTS_DC		 2		/* directory that causes cycles */
86 #define	FTS_DEFAULT	 3		/* none of the above */
87 #define	FTS_DNR		 4		/* unreadable directory */
88 #define	FTS_DOT		 5		/* dot or dot-dot */
89 #define	FTS_DP		 6		/* postorder directory */
90 #define	FTS_ERR		 7		/* error; errno is set */
91 #define	FTS_F		 8		/* regular file */
92 #define	FTS_INIT	 9		/* initialized only */
93 #define	FTS_NS		10		/* stat(2) failed */
94 #define	FTS_NSOK	11		/* no stat(2) requested */
95 #define	FTS_SL		12		/* symbolic link */
96 #define	FTS_SLNONE	13		/* symbolic link without target */
97 	unsigned short fts_info;	/* user flags for FTSENT structure */
98 
99 #define	FTS_DONTCHDIR	 0x01		/* don't chdir .. to the parent */
100 #define	FTS_SYMFOLLOW	 0x02		/* followed a symlink to get here */
101 	unsigned short fts_flags;	/* private flags for FTSENT structure */
102 
103 #define	FTS_AGAIN	 1		/* read node again */
104 #define	FTS_FOLLOW	 2		/* follow symbolic link */
105 #define	FTS_NOINSTR	 3		/* no instructions */
106 #define	FTS_SKIP	 4		/* discard node */
107 	unsigned short fts_instr;	/* fts_set() instructions */
108 
109 	unsigned short fts_spare;	/* unused */
110 
111 	struct stat *fts_statp;		/* stat(2) information */
112 	char fts_name[1];		/* file name */
113 } FTSENT;
114 
115 #if !defined(_LP64) && _FILE_OFFSET_BITS == 64
116 #ifdef __PRAGMA_REDEFINE_EXTNAME
117 #pragma	redefine_extname	fts_children	fts_children64
118 #pragma	redefine_extname	fts_close	fts_close64
119 #pragma	redefine_extname	fts_open	fts_open64
120 #pragma	redefine_extname	fts_read	fts_read64
121 #pragma	redefine_extname	fts_set		fts_set64
122 #else
123 #define	fts_children	fts_children64
124 #define	fts_close	fts_close64
125 #define	fts_open	fts_open64
126 #define	fts_read	fts_read64
127 #define	fts_set		fts_set64
128 #endif /* __PRAGMA_REDEFINE_EXTNAME */
129 #endif /* !_LP64 && _FILE_OFFSET_BITS == 64 */
130 
131 FTSENT	*fts_children(FTS *, int);
132 int	 fts_close(FTS *);
133 FTS	*fts_open(char * const *, int,
134 	    int (*)(const FTSENT **, const FTSENT **));
135 FTSENT	*fts_read(FTS *);
136 int	 fts_set(FTS *, FTSENT *, int);
137 
138 #ifdef	__cplusplus
139 }
140 #endif
141 
142 #endif /* !_FTS_H */
143