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
|
/****************************************************************************
* bfs *
* Copyright (C) 2015-2020 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. *
****************************************************************************/
/**
* bfs execution context.
*/
#ifndef BFS_CTX_H
#define BFS_CTX_H
#include "bftw.h"
#include "trie.h"
#include <stdbool.h>
/**
* Various debugging flags.
*/
enum debug_flags {
/** Print cost estimates. */
DEBUG_COST = 1 << 0,
/** Print executed command details. */
DEBUG_EXEC = 1 << 1,
/** Print optimization details. */
DEBUG_OPT = 1 << 2,
/** Print rate information. */
DEBUG_RATES = 1 << 3,
/** Trace the filesystem traversal. */
DEBUG_SEARCH = 1 << 4,
/** Trace all stat() calls. */
DEBUG_STAT = 1 << 5,
/** Print the parse tree. */
DEBUG_TREE = 1 << 6,
/** All debug flags. */
DEBUG_ALL = (1 << 7) - 1,
};
/**
* Convert a debug flag to a string.
*/
const char *debug_flag_name(enum debug_flags flag);
/**
* The execution context for bfs.
*/
struct bfs_ctx {
/** The unparsed command line arguments. */
char **argv;
/** The root paths. */
const char **paths;
/** The main command line expression. */
struct expr *expr;
/** An expression for files to filter out. */
struct expr *exclude;
/** -mindepth option. */
int mindepth;
/** -maxdepth option. */
int maxdepth;
/** bftw() flags. */
enum bftw_flags flags;
/** bftw() search strategy. */
enum bftw_strategy strategy;
/** Optimization level (-O). */
int optlevel;
/** Debugging flags (-D). */
enum debug_flags debug;
/** Whether to ignore deletions that race with bfs (-ignore_readdir_race). */
bool ignore_races;
/** Whether to show a status bar (-status). */
bool status;
/** Whether to only return unique files (-unique). */
bool unique;
/** Whether to print warnings (-warn/-nowarn). */
bool warn;
/** Whether to only handle paths with xargs-safe characters (-X). */
bool xargs_safe;
/** Color data. */
struct colors *colors;
/** The error that occurred parsing the color table, if any. */
int colors_error;
/** Colored stdout. */
struct CFILE *cout;
/** Colored stderr. */
struct CFILE *cerr;
/** User table. */
struct bfs_users *users;
/** The error that occurred parsing the user table, if any. */
int users_error;
/** Group table. */
struct bfs_groups *groups;
/** The error that occurred parsing the group table, if any. */
int groups_error;
/** Table of mounted file systems. */
struct bfs_mtab *mtab;
/** The error that occurred parsing the mount table, if any. */
int mtab_error;
/** All the files owned by the context. */
struct trie files;
/** The number of files owned by the context. */
int nfiles;
};
/**
* @return
* A new bfs context, or NULL on failure.
*/
struct bfs_ctx *bfs_ctx_new(void);
/**
* Get the users table.
*
* @param ctx
* The bfs context.
* @return
* The cached users table, or NULL on failure.
*/
const struct bfs_users *bfs_ctx_users(const struct bfs_ctx *ctx);
/**
* Get the groups table.
*
* @param ctx
* The bfs context.
* @return
* The cached groups table, or NULL on failure.
*/
const struct bfs_groups *bfs_ctx_groups(const struct bfs_ctx *ctx);
/**
* Get the mount table.
*
* @param ctx
* The bfs context.
* @return
* The cached mount table, or NULL on failure.
*/
const struct bfs_mtab *bfs_ctx_mtab(const struct bfs_ctx *ctx);
/**
* Open a file for the bfs context.
*
* @param ctx
* The bfs context.
* @param use_color
* Whether to use colors if the file is a TTY.
* @return
* The opened file, or NULL on failure.
*/
struct CFILE *bfs_ctx_open(struct bfs_ctx *ctx, const char *path, bool use_color);
/**
* Dump the parsed command line.
*
* @param ctx
* The bfs context.
* @param flag
* The -D flag that triggered the dump.
*/
void bfs_ctx_dump(const struct bfs_ctx *ctx, enum debug_flags flag);
/**
* Free a bfs context.
*
* @param ctx
* The context to free.
* @return
* 0 on success, -1 if any errors occurred.
*/
int bfs_ctx_free(struct bfs_ctx *ctx);
#endif // BFS_CTX_H
|
