summaryrefslogtreecommitdiff
path: root/lib/fts_.h
blob: 496211f6ee5117025b7e5df284706e26031bf639 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
/*
 * 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.
 * 4. Neither the name of the University nor the names of its contributors
 *    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.
 *
 *	@(#)fts.h	8.3 (Berkeley) 8/14/94
 */

#ifndef	_FTS_H
# define _FTS_H 1

# ifdef _LIBC
#  include <features.h>
# else
#  undef __THROW
#  define __THROW
#  undef __BEGIN_DECLS
#  define __BEGIN_DECLS
#  undef __END_DECLS
#  define __END_DECLS
# endif

# include <sys/types.h>
# include "hash.h"
# include "cycle-check.h"

typedef struct {
	struct _ftsent *fts_cur;	/* current node */
	struct _ftsent *fts_child;	/* linked list of children */
	struct _ftsent **fts_array;	/* sort array */
	dev_t fts_dev;			/* starting device # */
	char *fts_path;			/* path for this descent */
	int fts_rfd;			/* fd for root */
	size_t fts_pathlen;		/* sizeof(path) */
	int fts_nitems;			/* elements in the sort array */
	int (*fts_compar) (const void *, const void *); /* compare fn */

# define FTS_COMFOLLOW	0x0001		/* follow command line symlinks */
# define FTS_LOGICAL	0x0002		/* logical walk */
# define FTS_NOCHDIR	0x0004		/* don't change directories */
# define FTS_NOSTAT	0x0008		/* don't get stat info */
# define FTS_PHYSICAL	0x0010		/* physical walk */
# define FTS_SEEDOT	0x0020		/* return dot and dot-dot */
# define FTS_XDEV	0x0040		/* don't cross devices */
# define FTS_WHITEOUT	0x0080		/* return whiteout information */

  /* There are two ways to detect cycles.
     The lazy way, with which one may process a directory that is a
     part of the cycle several times before detecting the cycle.
     The `tight' way, whereby fts uses more memory (proportional
     to number of `active' directories, aka distance from root
     of current tree to current directory -- see active_dir_ht)
     to detect any cycle right away.  For example, du must use
     this option to avoid counting disk space in a cycle multiple
     times, but chown -R need not.
     The default is to use the constant-memory lazy way. */
# define FTS_TIGHT_CYCLE_CHECK	0x0100

# define FTS_OPTIONMASK	0x01ff		/* valid user option mask */

# define FTS_NAMEONLY	0x1000		/* (private) child names only */
# define FTS_STOP	0x2000		/* (private) unrecoverable error */
	int fts_options;		/* fts_open options, global flags */

	/* This data structure records the directories between a starting
	   point and the current directory.  I.e., a directory is recorded
	   here IFF we have visited it once, but we have not yet completed
	   processing of all its entries.  Every time we visit a new directory,
	   we add that directory to this set.  When we finish with a directory
	   (usually by visiting it a second time), we remove it from this
	   set.  Each entry in this data structure is a device/inode pair.
	   This data structure is used to detect directory cycles efficiently
	   and promptly even when the depth of a hierarchy is in the tens
	   of thousands.  Lazy checking, as done by GNU rm via cycle-check.c,
	   wouldn't be appropriate for du.  */
	Hash_table *active_dir_ht;
	struct cycle_check_state *cycle_state;
} FTS;

typedef struct _ftsent {
	struct _ftsent *fts_cycle;	/* cycle node */
	struct _ftsent *fts_parent;	/* parent directory */
	struct _ftsent *fts_link;	/* next file in directory */
	long fts_number;	        /* local numeric value */
	void *fts_pointer;	        /* local address value */
	char *fts_accpath;		/* access path */
	char *fts_path;			/* root path */
	int fts_errno;			/* errno for this node */
	int fts_symfd;			/* fd for symlink */
	size_t fts_pathlen;		/* strlen(fts_path) */

	ino_t fts_ino;			/* inode */
	dev_t fts_dev;			/* device */
	nlink_t fts_nlink;		/* link count */

# define FTS_ROOTPARENTLEVEL	-1
# define FTS_ROOTLEVEL		 0
	int fts_level;			/* depth (-1 to N) */

	u_short fts_namelen;		/* strlen(fts_name) */

# define FTS_D		 1		/* preorder directory */
# define FTS_DC		 2		/* directory that causes cycles */
# define FTS_DEFAULT	 3		/* none of the above */
# define FTS_DNR	 4		/* unreadable directory */
# define FTS_DOT	 5		/* dot or dot-dot */
# define FTS_DP		 6		/* postorder directory */
# define FTS_ERR	 7		/* error; errno is set */
# define FTS_F		 8		/* regular file */
# define FTS_INIT	 9		/* initialized only */
# define FTS_NS		10		/* stat(2) failed */
# define FTS_NSOK	11		/* no stat(2) requested */
# define FTS_SL		12		/* symbolic link */
# define FTS_SLNONE	13		/* symbolic link without target */
# define FTS_W		14		/* whiteout object */
	u_short fts_info;		/* user flags for FTSENT structure */

# define FTS_DONTCHDIR	 0x01		/* don't chdir .. to the parent */
# define FTS_SYMFOLLOW	 0x02		/* followed a symlink to get here */
	u_short fts_flags;		/* private flags for FTSENT structure */

# define FTS_AGAIN	 1		/* read node again */
# define FTS_FOLLOW	 2		/* follow symbolic link */
# define FTS_NOINSTR	 3		/* no instructions */
# define FTS_SKIP	 4		/* discard node */
	u_short fts_instr;		/* fts_set() instructions */

	struct stat *fts_statp;		/* stat(2) information */
	char fts_name[1];		/* file name */
} FTSENT;

__BEGIN_DECLS
FTSENT	*fts_children (FTS *, int) __THROW;
int	 fts_close (FTS *) __THROW;
FTS	*fts_open (char * const *, int,
		   int (*)(const FTSENT **, const FTSENT **)) __THROW;
FTSENT	*fts_read (FTS *) __THROW;
int	 fts_set (FTS *, FTSENT *, int) __THROW;
__END_DECLS

#endif /* fts.h */