Debian Codegraph @

src/basic/dirent-util.h

raw
1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
2 #pragma once
3
4 #include <dirent.h> /* IWYU pragma: export */
5
6 #include "basic-forward.h"
7 #include "path-util.h" /* IWYU pragma: keep */
8
9 bool dirent_is_file(const struct dirent *de) _pure_;
10 bool dirent_is_file_with_suffix(const struct dirent *de, const char *suffix) _pure_;
11 int dirent_ensure_type(int dir_fd, struct dirent *de);
12
13 struct dirent* readdir_ensure_type(DIR *d);
14 struct dirent* readdir_no_dot(DIR *dirp);
15
16 #define FOREACH_DIRENT_ALL(de, d, on_error) \
17 for (struct dirent *(de) = readdir_ensure_type(d);; (de) = readdir_ensure_type(d)) \
18 if (!de) { \
19 if (errno > 0) { \
20 on_error; \
21 } \
22 break; \
23 } else
24
25 #define FOREACH_DIRENT(de, d, on_error) \
26 FOREACH_DIRENT_ALL(de, d, on_error) \
27 if (hidden_or_backup_file((de)->d_name)) \
28 continue; \
29 else
30
31 /* Maximum space one dirent structure might require at most */
32 #define DIRENT_SIZE_MAX CONST_MAX(sizeof(struct dirent), offsetof(struct dirent, d_name) + NAME_MAX + 1)
33
34 /* Only if 64-bit off_t is enabled struct dirent + struct dirent64 are actually the same. We require this, and
35 * we want them to be interchangeable to make getdents64() work, hence verify that. */
36 assert_cc(_FILE_OFFSET_BITS == 64);
37 assert_cc(sizeof(struct dirent) == sizeof(struct dirent64));
38 assert_cc(offsetof(struct dirent, d_ino) == offsetof(struct dirent64, d_ino));
39 assert_cc(sizeof_field(struct dirent, d_ino) == sizeof_field(struct dirent64, d_ino));
40 assert_cc(offsetof(struct dirent, d_off) == offsetof(struct dirent64, d_off));
41 assert_cc(sizeof_field(struct dirent, d_off) == sizeof_field(struct dirent64, d_off));
42 assert_cc(offsetof(struct dirent, d_reclen) == offsetof(struct dirent64, d_reclen));
43 assert_cc(sizeof_field(struct dirent, d_reclen) == sizeof_field(struct dirent64, d_reclen));
44 assert_cc(offsetof(struct dirent, d_type) == offsetof(struct dirent64, d_type));
45 assert_cc(sizeof_field(struct dirent, d_type) == sizeof_field(struct dirent64, d_type));
46 assert_cc(offsetof(struct dirent, d_name) == offsetof(struct dirent64, d_name));
47 assert_cc(sizeof_field(struct dirent, d_name) == sizeof_field(struct dirent64, d_name));
48
49 #define FOREACH_DIRENT_IN_BUFFER(de, buf, sz) \
50 for (void *_end = (uint8_t*) ({ (de) = (buf); }) + (sz); \
51 (uint8_t*) (de) < (uint8_t*) _end; \
52 (de) = (struct dirent*) ((uint8_t*) (de) + (de)->d_reclen))
53
54 #define DEFINE_DIRENT_BUFFER(name, sz) \
55 union { \
56 struct dirent de; \
57 uint8_t data[(sz) * DIRENT_SIZE_MAX]; \
58 } name