fts-compat.h revision 251071
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 *	@(#)fts.h	8.3 (Berkeley) 8/14/94
30 * $FreeBSD: head/lib/libc/gen/fts-compat.h 251071 2013-05-28 21:05:06Z emaste $
31 */
32
33#ifndef	_FTS_H_
34#define	_FTS_H_
35
36typedef struct {
37	struct _ftsent *fts_cur;	/* current node */
38	struct _ftsent *fts_child;	/* linked list of children */
39	struct _ftsent **fts_array;	/* sort array */
40	dev_t fts_dev;			/* starting device # */
41	char *fts_path;			/* path for this descent */
42	int fts_rfd;			/* fd for root */
43	int fts_pathlen;		/* sizeof(path) */
44	int fts_nitems;			/* elements in the sort array */
45	int (*fts_compar)		/* compare function */
46	    (const struct _ftsent * const *, const struct _ftsent * const *);
47
48#define	FTS_COMFOLLOW	0x001		/* follow command line symlinks */
49#define	FTS_LOGICAL	0x002		/* logical walk */
50#define	FTS_NOCHDIR	0x004		/* don't change directories */
51#define	FTS_NOSTAT	0x008		/* don't get stat info */
52#define	FTS_PHYSICAL	0x010		/* physical walk */
53#define	FTS_SEEDOT	0x020		/* return dot and dot-dot */
54#define	FTS_XDEV	0x040		/* don't cross devices */
55#define	FTS_WHITEOUT	0x080		/* return whiteout information */
56#define	FTS_OPTIONMASK	0x0ff		/* valid user option mask */
57
58#define	FTS_NAMEONLY	0x100		/* (private) child names only */
59#define	FTS_STOP	0x200		/* (private) unrecoverable error */
60	int fts_options;		/* fts_open options, global flags */
61	void *fts_clientptr;		/* thunk for sort function */
62} FTS;
63
64typedef struct _ftsent {
65	struct _ftsent *fts_cycle;	/* cycle node */
66	struct _ftsent *fts_parent;	/* parent directory */
67	struct _ftsent *fts_link;	/* next file in directory */
68	union {
69		struct {
70			long __fts_number;	/* local numeric value */
71			void *__fts_pointer;	/* local address value */
72		} __struct_ftsent;
73		int64_t __fts_bignum;
74	} __union_ftsent;
75#define	fts_number	__union_ftsent.__struct_ftsent.__fts_number
76#define	fts_pointer	__union_ftsent.__struct_ftsent.__fts_pointer
77#define	fts_bignum	__union_ftsent.__fts_bignum
78	char *fts_accpath;		/* access path */
79	char *fts_path;			/* root path */
80	int fts_errno;			/* errno for this node */
81	int fts_symfd;			/* fd for symlink */
82	u_short fts_pathlen;		/* strlen(fts_path) */
83	u_short fts_namelen;		/* strlen(fts_name) */
84
85	ino_t fts_ino;			/* inode */
86	dev_t fts_dev;			/* device */
87	nlink_t fts_nlink;		/* link count */
88
89#define	FTS_ROOTPARENTLEVEL	-1
90#define	FTS_ROOTLEVEL		 0
91	short fts_level;		/* depth (-1 to N) */
92
93#define	FTS_D		 1		/* preorder directory */
94#define	FTS_DC		 2		/* directory that causes cycles */
95#define	FTS_DEFAULT	 3		/* none of the above */
96#define	FTS_DNR		 4		/* unreadable directory */
97#define	FTS_DOT		 5		/* dot or dot-dot */
98#define	FTS_DP		 6		/* postorder directory */
99#define	FTS_ERR		 7		/* error; errno is set */
100#define	FTS_F		 8		/* regular file */
101#define	FTS_INIT	 9		/* initialized only */
102#define	FTS_NS		10		/* stat(2) failed */
103#define	FTS_NSOK	11		/* no stat(2) requested */
104#define	FTS_SL		12		/* symbolic link */
105#define	FTS_SLNONE	13		/* symbolic link without target */
106#define	FTS_W		14		/* whiteout object */
107	u_short fts_info;		/* user flags for FTSENT structure */
108
109#define	FTS_DONTCHDIR	 0x01		/* don't chdir .. to the parent */
110#define	FTS_SYMFOLLOW	 0x02		/* followed a symlink to get here */
111#define	FTS_ISW		 0x04		/* this is a whiteout object */
112	u_short fts_flags;		/* private flags for FTSENT structure */
113
114#define	FTS_AGAIN	 1		/* read node again */
115#define	FTS_FOLLOW	 2		/* follow symbolic link */
116#define	FTS_NOINSTR	 3		/* no instructions */
117#define	FTS_SKIP	 4		/* discard node */
118	u_short fts_instr;		/* fts_set() instructions */
119
120	struct stat *fts_statp;		/* stat(2) information */
121	char *fts_name;			/* file name */
122	FTS *fts_fts;			/* back pointer to main FTS */
123} FTSENT;
124
125#define	 fts_get_clientptr(fts)	((fts)->fts_clientptr)
126#define	 fts_get_stream(ftsent)	((ftsent)->fts_fts)
127
128#endif /* !_FTS_H_ */
129