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
|
/****************************************************************************
* bfs *
* Copyright (C) 2016-2018 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_UTIL_H
#define BFS_UTIL_H
#include <dirent.h>
#include <fcntl.h>
#include <fnmatch.h>
#include <regex.h>
#include <stdbool.h>
#include <sys/types.h>
#include <time.h>
// Some portability concerns
#ifdef __has_include
# define BFS_HAS_INCLUDE(header, fallback) __has_include(header)
#else
# define BFS_HAS_INCLUDE(header, fallback) fallback
#endif
#define BFS_HAS_MNTENT BFS_HAS_INCLUDE(<mntent.h>, __GLIBC__)
#define BFS_HAS_SYS_ACL BFS_HAS_INCLUDE(<sys/acl.h>, true)
#define BFS_HAS_SYS_CAPABILITY BFS_HAS_INCLUDE(<sys/capability.h>, __linux__)
#define BFS_HAS_SYS_MKDEV BFS_HAS_INCLUDE(<sys/mkdev.h>, false)
#define BFS_HAS_SYS_PARAM BFS_HAS_INCLUDE(<sys/param.h>, true)
#define BFS_HAS_SYS_SYSMACROS BFS_HAS_INCLUDE(<sys/sysmacros.h>, __GLIBC__)
#if BFS_HAS_SYS_CAPABILITY
# include <sys/capability.h>
# ifdef CAP_CHOWN
# define BFS_HAS_POSIX1E_CAPABILITIES true
# endif
#endif
#if !defined(FNM_CASEFOLD) && defined(FNM_IGNORECASE)
# define FNM_CASEFOLD FNM_IGNORECASE
#endif
#ifndef S_ISDOOR
# define S_ISDOOR(mode) false
#endif
#ifndef S_ISPORT
# define S_ISPORT(mode) false
#endif
#ifndef S_ISWHT
# define S_ISWHT(mode) false
#endif
#ifndef O_DIRECTORY
# define O_DIRECTORY 0
#endif
/**
* Adds compiler warnings for bad printf()-style function calls, if supported.
*/
#if __GNUC__
# define BFS_FORMATTER(fmt, args) __attribute__((format(printf, fmt, args)))
#else
# define BFS_FORMATTER(fmt, args)
#endif
/**
* readdir() wrapper that makes error handling cleaner.
*/
int xreaddir(DIR *dir, struct dirent **de);
/**
* readlinkat() wrapper that dynamically allocates the result.
*
* @param fd
* The base directory descriptor.
* @param path
* The path to the link, relative to fd.
* @param size
* An estimate for the size of the link name (pass 0 if unknown).
* @return The target of the link, allocated with malloc(), or NULL on failure.
*/
char *xreadlinkat(int fd, const char *path, size_t size);
/**
* Check if a file descriptor is open.
*/
bool isopen(int fd);
/**
* Open a file and redirect it to a particular descriptor.
*
* @param fd
* The file descriptor to redirect.
* @param path
* The path to open.
* @param flags
* The flags passed to open().
* @param mode
* The mode passed to open() (optional).
* @return fd on success, -1 on failure.
*/
int redirect(int fd, const char *path, int flags, ...);
/**
* Like dup(), but set the FD_CLOEXEC flag.
*
* @param fd
* The file descriptor to duplicate.
* @return A duplicated file descriptor, or -1 on failure.
*/
int dup_cloexec(int fd);
/**
* Like pipe(), but set the FD_CLOEXEC flag.
*
* @param pipefd
* The array to hold the two file descriptors.
* @return 0 on success, -1 on failure.
*/
int pipe_cloexec(int pipefd[2]);
/**
* Dynamically allocate a regex error message.
*
* @param err
* The error code to stringify.
* @param regex
* The (partially) compiled regex.
* @return A human-readable description of the error, allocated with malloc().
*/
char *xregerror(int err, const regex_t *regex);
/**
* localtime_r() wrapper that calls tzset() first.
*
* @param timep
* The time_t to convert.
* @param result
* Buffer to hold the result.
* @return 0 on success, -1 on failure.
*/
int xlocaltime(const time_t *timep, struct tm *result);
/**
* Format a mode like ls -l (e.g. -rw-r--r--).
*
* @param mode
* The mode to format.
* @param str
* The string to hold the formatted mode.
*/
void format_mode(mode_t mode, char str[11]);
/**
* basename() variant that doesn't modify the input.
*
* @param path
* The path in question.
* @return A pointer into path at the base name offset.
*/
const char *xbasename(const char *path);
/**
* Wrapper for faccessat() that handles some portability issues.
*/
int xfaccessat(int fd, const char *path, int amode);
/**
* Return whether an error code is due to a path not existing.
*/
bool is_nonexistence_error(int error);
/**
* Process a yes/no prompt.
*
* @return 1 for yes, 0 for no, and -1 for unknown.
*/
int ynprompt(void);
/**
* Portable version of makedev().
*/
dev_t bfs_makedev(int ma, int mi);
/**
* Portable version of major().
*/
int bfs_major(dev_t dev);
/**
* Portable version of minor().
*/
int bfs_minor(dev_t dev);
#endif // BFS_UTIL_H
|
