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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
|
/****************************************************************************
* bfs *
* Copyright (C) 2015-2017 Tavian Barnes <tavianator@tavianator.com> *
* *
* Permission to use, copy, modify, and/or distribute this software for any *
* purpose with or without fee is hereby granted. *
* *
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES *
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF *
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR *
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES *
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN *
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF *
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. *
****************************************************************************/
#ifndef BFS_H
#define BFS_H
#include "color.h"
#include "exec.h"
#include "printf.h"
#include "mtab.h"
#include <regex.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdio.h>
#include <sys/types.h>
#include <time.h>
#ifndef BFS_VERSION
# define BFS_VERSION "1.1"
#endif
#ifndef BFS_HOMEPAGE
# define BFS_HOMEPAGE "https://github.com/tavianator/bfs"
#endif
/**
* A command line expression.
*/
struct expr;
/**
* Ephemeral state for evaluating an expression.
*/
struct eval_state;
/**
* Expression evaluation function.
*
* @param expr
* The current expression.
* @param state
* The current evaluation state.
* @return
* The result of the test.
*/
typedef bool eval_fn(const struct expr *expr, struct eval_state *state);
/**
* Various debugging flags.
*/
enum debug_flags {
/** Print executed command details. */
DEBUG_EXEC = 1 << 0,
/** Print optimization details. */
DEBUG_OPT = 1 << 1,
/** Print rate information. */
DEBUG_RATES = 1 << 2,
/** Trace all stat() calls. */
DEBUG_STAT = 1 << 3,
/** Print the parse tree. */
DEBUG_TREE = 1 << 4,
};
/**
* A root path to explore.
*/
struct root {
/** The root path itself. */
const char *path;
/** The next path in the list. */
struct root *next;
};
/**
* The parsed command line.
*/
struct cmdline {
/** The unparsed command line arguments. */
char **argv;
/** The list of root paths. */
struct root *roots;
/** Color data. */
struct colors *colors;
/** Colored stdout. */
CFILE *cout;
/** Colored stderr. */
CFILE *cerr;
/** Table of mounted file systems. */
struct bfs_mtab *mtab;
/** -mindepth option. */
int mindepth;
/** -maxdepth option. */
int maxdepth;
/** bftw() flags. */
enum bftw_flags flags;
/** Optimization level. */
int optlevel;
/** Debugging flags. */
enum debug_flags debug;
/** Whether to only handle paths with xargs-safe characters. */
bool xargs_safe;
/** Whether to ignore deletions that race with bfs. */
bool ignore_races;
/** The command line expression. */
struct expr *expr;
/** The number of open files used by the expression tree. */
int nopen_files;
};
/**
* Possible types of numeric comparison.
*/
enum cmp_flag {
/** Exactly n. */
CMP_EXACT,
/** Less than n. */
CMP_LESS,
/** Greater than n. */
CMP_GREATER,
};
/**
* Possible types of mode comparison.
*/
enum mode_cmp {
/** Mode is an exact match (MODE). */
MODE_EXACT,
/** Mode has all these bits (-MODE). */
MODE_ALL,
/** Mode has any of these bits (/MODE). */
MODE_ANY,
};
/**
* Available struct stat time fields.
*/
enum time_field {
/** Access time. */
ATIME,
/** Status change time. */
CTIME,
/** Modification time. */
MTIME,
};
/**
* Possible time units.
*/
enum time_unit {
/** Minutes. */
MINUTES,
/** Days. */
DAYS,
};
/**
* Possible file size units.
*/
enum size_unit {
/** 512-byte blocks. */
SIZE_BLOCKS,
/** Single bytes. */
SIZE_BYTES,
/** Two-byte words. */
SIZE_WORDS,
/** Kibibytes. */
SIZE_KB,
/** Mebibytes. */
SIZE_MB,
/** Gibibytes. */
SIZE_GB,
/** Tebibytes. */
SIZE_TB,
/** Pebibytes. */
SIZE_PB,
};
struct expr {
/** The function that evaluates this expression. */
eval_fn *eval;
/** The left hand side of the expression. */
struct expr *lhs;
/** The right hand side of the expression. */
struct expr *rhs;
/** Whether this expression has no side effects. */
bool pure;
/** Whether this expression always evaluates to true. */
bool always_true;
/** Whether this expression always evaluates to false. */
bool always_false;
/** Number of times this predicate was executed. */
size_t evaluations;
/** Number of times this predicate succeeded. */
size_t successes;
/** Total time spent running this predicate. */
struct timespec elapsed;
/** The number of command line arguments for this expression. */
size_t argc;
/** The command line arguments comprising this expression. */
char **argv;
/** The optional comparison flag. */
enum cmp_flag cmp_flag;
/** The mode comparison flag. */
enum mode_cmp mode_cmp;
/** Mode to use for files. */
mode_t file_mode;
/** Mode to use for directories (different due to X). */
mode_t dir_mode;
/** The optional reference time. */
struct timespec reftime;
/** The optional time field. */
enum time_field time_field;
/** The optional time unit. */
enum time_unit time_unit;
/** The optional size unit. */
enum size_unit size_unit;
/** Optional device number for a target file. */
dev_t dev;
/** Optional inode number for a target file. */
ino_t ino;
/** File to output to. */
CFILE *cfile;
/** Optional compiled regex. */
regex_t *regex;
/** Optional exec command. */
struct bfs_exec *execbuf;
/** Optional printf command. */
struct bfs_printf *printf;
/** Optional integer data for this expression. */
long long idata;
/** Optional string data for this expression. */
const char *sdata;
};
/**
* @return Whether expr is known to always quit.
*/
bool expr_never_returns(const struct expr *expr);
/**
* Parse the command line.
*/
struct cmdline *parse_cmdline(int argc, char *argv[]);
/**
* Dump the parsed command line.
*/
void dump_cmdline(const struct cmdline *cmdline, bool verbose);
/**
* Evaluate the command line.
*/
int eval_cmdline(const struct cmdline *cmdline);
/**
* Free the parsed command line.
*/
void free_cmdline(struct cmdline *cmdline);
// Predicate evaluation functions
bool eval_true(const struct expr *expr, struct eval_state *state);
bool eval_false(const struct expr *expr, struct eval_state *state);
bool eval_access(const struct expr *expr, struct eval_state *state);
bool eval_perm(const struct expr *expr, struct eval_state *state);
bool eval_acmtime(const struct expr *expr, struct eval_state *state);
bool eval_acnewer(const struct expr *expr, struct eval_state *state);
bool eval_used(const struct expr *expr, struct eval_state *state);
bool eval_gid(const struct expr *expr, struct eval_state *state);
bool eval_uid(const struct expr *expr, struct eval_state *state);
bool eval_nogroup(const struct expr *expr, struct eval_state *state);
bool eval_nouser(const struct expr *expr, struct eval_state *state);
bool eval_depth(const struct expr *expr, struct eval_state *state);
bool eval_empty(const struct expr *expr, struct eval_state *state);
bool eval_fstype(const struct expr *expr, struct eval_state *state);
bool eval_hidden(const struct expr *expr, struct eval_state *state);
bool eval_inum(const struct expr *expr, struct eval_state *state);
bool eval_links(const struct expr *expr, struct eval_state *state);
bool eval_samefile(const struct expr *expr, struct eval_state *state);
bool eval_size(const struct expr *expr, struct eval_state *state);
bool eval_sparse(const struct expr *expr, struct eval_state *state);
bool eval_type(const struct expr *expr, struct eval_state *state);
bool eval_xtype(const struct expr *expr, struct eval_state *state);
bool eval_lname(const struct expr *expr, struct eval_state *state);
bool eval_name(const struct expr *expr, struct eval_state *state);
bool eval_path(const struct expr *expr, struct eval_state *state);
bool eval_regex(const struct expr *expr, struct eval_state *state);
bool eval_delete(const struct expr *expr, struct eval_state *state);
bool eval_exec(const struct expr *expr, struct eval_state *state);
bool eval_exit(const struct expr *expr, struct eval_state *state);
bool eval_nohidden(const struct expr *expr, struct eval_state *state);
bool eval_fls(const struct expr *expr, struct eval_state *state);
bool eval_fprint(const struct expr *expr, struct eval_state *state);
bool eval_fprint0(const struct expr *expr, struct eval_state *state);
bool eval_fprintf(const struct expr *expr, struct eval_state *state);
bool eval_fprintx(const struct expr *expr, struct eval_state *state);
bool eval_prune(const struct expr *expr, struct eval_state *state);
bool eval_quit(
|