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
|
// Copyright © Tavian Barnes <tavianator@tavianator.com>
// SPDX-License-Identifier: 0BSD
/**
* bfs execution context.
*/
#ifndef BFS_CTX_H
#define BFS_CTX_H
#include "alloc.h"
#include "bftw.h"
#include "diag.h"
#include "expr.h"
#include "trie.h"
#include <stddef.h>
#include <sys/resource.h>
#include <sys/types.h>
#include <time.h>
struct CFILE;
/**
* The execution context for bfs.
*/
struct bfs_ctx {
/** The number of command line arguments. */
size_t argc;
/** The unparsed command line arguments. */
char **argv;
/** The root paths. */
const char **paths;
/** The number of root paths. */
size_t npaths;
/** The main command line expression. */
struct bfs_expr *expr;
/** An expression for files to filter out. */
struct bfs_expr *exclude;
/** bfs_expr arena. */
struct arena exprs;
/** -mindepth option. */
int mindepth;
/** -maxdepth option. */
int maxdepth;
/** bftw() flags. */
enum bftw_flags flags;
/** bftw() search strategy. */
enum bftw_strategy strategy;
/** Threads (-j). */
int threads;
/** 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 follow POSIXisms more closely ($POSIXLY_CORRECT). */
bool posixly_correct;
/** Whether to show a status bar (-status). */
bool status;
/** Whether to only return unique files (-unique). */
bool unique;
/** Whether to only handle paths with xargs-safe characters (-X). */
bool xargs_safe;
/** Whether bfs was run interactively. */
bool interactive;
/** Whether to print warnings (-warn/-nowarn). */
bool warn;
/** Whether to report errors (-noerror). */
bool ignore_errors;
/** Whether any dangerous actions (-delete/-exec) are present. */
bool dangerous;
/** 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 cache. */
struct bfs_users *users;
/** 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;
/** The current file creation mask. */
mode_t umask;
/** The initial RLIMIT_NOFILE limits. */
struct rlimit orig_nofile;
/** The current RLIMIT_NOFILE limits. */
struct rlimit cur_nofile;
/** Whether the fd limit should be raised. */
bool raise_nofile;
/** The current time. */
struct timespec now;
};
/**
* @return
* A new bfs context, or NULL on failure.
*/
struct bfs_ctx *bfs_ctx_new(void);
/**
* Get the mount table.
*
* @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);
/**
* Deduplicate an opened file.
*
* @ctx
* The bfs context.
* @cfile
* The opened file.
* @path
* The path to the opened file (or NULL for standard streams).
* @return
* If the same file was opened previously, that file is returned. If cfile is a new file,
* cfile itself is returned. If an error occurs, NULL is returned.
*/
struct CFILE *bfs_ctx_dedup(struct bfs_ctx *ctx, struct CFILE *cfile, const char *path);
/**
* Flush any caches for consistency with external processes.
*
* @ctx
* The bfs context.
*/
void bfs_ctx_flush(const struct bfs_ctx *ctx);
/**
* Dump the parsed command line.
*
* @ctx
* The bfs context.
* @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.
*
* @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
|
