xref: /freebsd/usr.bin/find/find.h (revision 2008043f386721d58158e37e0d7e50df8095942d)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1990, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * This code is derived from software contributed to Berkeley by
8  * Cimarron D. Taylor of the University of California, Berkeley.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. Neither the name of the University nor the names of its contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  *	@(#)find.h	8.1 (Berkeley) 6/6/93
35  */
36 
37 #include <regex.h>
38 #include <sys/mount.h>
39 #include <sys/stat.h>
40 
41 /*
42  * We need to build find during the bootstrap stage when building on a
43  * non-FreeBSD system. Linux does not have the st_flags and st_birthtime
44  * members in struct stat so we need to omit support for tests that depend
45  * on these members. This works fine since none of these flags are used
46  * during the build of world and kernel.
47  */
48 #ifdef UF_SETTABLE
49 #define HAVE_STRUCT_STAT_ST_FLAGS 1
50 #else
51 #define HAVE_STRUCT_STAT_ST_FLAGS 0
52 #endif
53 #if defined(st_birthtime) || defined(st_birthtimespec)
54 #define HAVE_STRUCT_STAT_ST_BIRTHTIME 1
55 #else
56 #define HAVE_STRUCT_STAT_ST_BIRTHTIME 0
57 #endif
58 #if defined(MFSNAMELEN) || defined(MFSTYPENAMELEN)
59 #define HAVE_STRUCT_STATFS_F_FSTYPENAME 1
60 #else
61 #define HAVE_STRUCT_STATFS_F_FSTYPENAME 0
62 #endif
63 
64 /* forward declarations */
65 struct _plandata;
66 struct _option;
67 
68 /* execute function */
69 typedef int exec_f(struct _plandata *, FTSENT *);
70 /* create function */
71 typedef	struct _plandata *creat_f(struct _option *, char ***);
72 
73 /* function modifiers */
74 #define	F_NEEDOK	0x00000001	/* -ok vs. -exec */
75 #define	F_EXECDIR	0x00000002	/* -execdir vs. -exec */
76 #define F_TIME_A	0x00000004	/* one of -atime, -anewer, -newera* */
77 #define F_TIME_C	0x00000008	/* one of -ctime, -cnewer, -newerc* */
78 #define	F_TIME2_A	0x00000010	/* one of -newer?a */
79 #define	F_TIME2_C	0x00000020	/* one of -newer?c */
80 #define	F_TIME2_T	0x00000040	/* one of -newer?t */
81 #define F_MAXDEPTH	F_TIME_A	/* maxdepth vs. mindepth */
82 #define F_DEPTH		F_TIME_A	/* -depth n vs. -d */
83 /* command line function modifiers */
84 #define	F_EQUAL		0x00000000	/* [acm]min [acm]time inum links size */
85 #define	F_LESSTHAN	0x00000100
86 #define	F_GREATER	0x00000200
87 #define F_ELG_MASK	0x00000300
88 #define	F_ATLEAST	0x00000400	/* flags perm */
89 #define F_ANY		0x00000800	/* perm */
90 #define	F_MTMASK	0x00003000
91 #define	F_MTFLAG	0x00000000	/* fstype */
92 #define	F_MTTYPE	0x00001000
93 #define	F_MTUNKNOWN	0x00002000
94 #define	F_IGNCASE	0x00010000	/* iname ipath iregex */
95 #define	F_EXACTTIME	F_IGNCASE	/* -[acm]time units syntax */
96 #define F_EXECPLUS	0x00020000	/* -exec ... {} + */
97 #if HAVE_STRUCT_STAT_ST_BIRTHTIME
98 #define	F_TIME_B	0x00040000	/* one of -Btime, -Bnewer, -newerB* */
99 #define	F_TIME2_B	0x00080000	/* one of -newer?B */
100 #endif
101 #define F_LINK		0x00100000	/* lname or ilname */
102 
103 /* node definition */
104 typedef struct _plandata {
105 	struct _plandata *next;		/* next node */
106 	exec_f	*execute;		/* node evaluation function */
107 	int flags;			/* private flags */
108 	union {
109 		gid_t _g_data;		/* gid */
110 		ino_t _i_data;		/* inode */
111 		mode_t _m_data;		/* mode mask */
112 		struct {
113 			u_long _f_flags;
114 			u_long _f_notflags;
115 		} fl;
116 		nlink_t _l_data;		/* link count */
117 		short _d_data;			/* level depth (-1 to N) */
118 		off_t _o_data;			/* file size */
119 		struct timespec _t_data;	/* time value */
120 		uid_t _u_data;			/* uid */
121 		short _mt_data;			/* mount flags */
122 		struct _plandata *_p_data[2];	/* PLAN trees */
123 		struct _ex {
124 			char **_e_argv;		/* argv array */
125 			char **_e_orig;		/* original strings */
126 			int *_e_len;		/* allocated length */
127 			int _e_pbnum;		/* base num. of args. used */
128 			int _e_ppos;		/* number of arguments used */
129 			int _e_pnummax;		/* max. number of arguments */
130 			int _e_psize;		/* number of bytes of args. */
131 			int _e_pbsize;		/* base num. of bytes of args */
132 			int _e_psizemax;	/* max num. of bytes of args */
133 			struct _plandata *_e_next;/* next F_EXECPLUS in tree */
134 		} ex;
135 		char *_a_data[2];		/* array of char pointers */
136 		char *_c_data;			/* char pointer */
137 		regex_t *_re_data;		/* regex */
138 	} p_un;
139 } PLAN;
140 #define	a_data	p_un._a_data
141 #define	c_data	p_un._c_data
142 #define	d_data	p_un._d_data
143 #define fl_flags	p_un.fl._f_flags
144 #define fl_notflags	p_un.fl._f_notflags
145 #define	g_data	p_un._g_data
146 #define	i_data	p_un._i_data
147 #define	l_data	p_un._l_data
148 #define	m_data	p_un._m_data
149 #define	mt_data	p_un._mt_data
150 #define	o_data	p_un._o_data
151 #define	p_data	p_un._p_data
152 #define	t_data	p_un._t_data
153 #define	u_data	p_un._u_data
154 #define	re_data	p_un._re_data
155 #define	e_argv	p_un.ex._e_argv
156 #define	e_orig	p_un.ex._e_orig
157 #define	e_len	p_un.ex._e_len
158 #define e_pbnum	p_un.ex._e_pbnum
159 #define e_ppos	p_un.ex._e_ppos
160 #define e_pnummax p_un.ex._e_pnummax
161 #define e_psize p_un.ex._e_psize
162 #define e_pbsize p_un.ex._e_pbsize
163 #define e_psizemax p_un.ex._e_psizemax
164 #define e_next p_un.ex._e_next
165 
166 typedef struct _option {
167 	const char *name;		/* option name */
168 	creat_f *create;		/* create function */
169 	exec_f *execute;		/* execute function */
170 	int flags;
171 } OPTION;
172 
173 #include "extern.h"
174