]>
Commit | Line | Data |
---|---|---|
db9ecf05 | 1 | /* SPDX-License-Identifier: LGPL-2.1-or-later */ |
3ffd4af2 LP |
2 | #pragma once |
3 | ||
3ffd4af2 | 4 | #include <dirent.h> |
e212f422 | 5 | #include <fcntl.h> |
3ffd4af2 | 6 | #include <stdbool.h> |
71d35b6b | 7 | #include <stdio.h> |
3ffd4af2 LP |
8 | #include <sys/socket.h> |
9 | ||
10 | #include "macro.h" | |
6e1e4b59 | 11 | #include "stdio-util.h" |
3ffd4af2 | 12 | |
ae3f4bae YW |
13 | /* maximum length of fdname */ |
14 | #define FDNAME_MAX 255 | |
15 | ||
23e096cc LP |
16 | /* Make sure we can distinguish fd 0 and NULL */ |
17 | #define FD_TO_PTR(fd) INT_TO_PTR((fd)+1) | |
18 | #define PTR_TO_FD(p) (PTR_TO_INT(p)-1) | |
71136404 LP |
19 | |
20 | /* Useful helpers for initializing pipe(), socketpair() or stdio fd arrays */ | |
21 | #define EBADF_PAIR { -EBADF, -EBADF } | |
22 | #define EBADF_TRIPLET { -EBADF, -EBADF, -EBADF } | |
23e096cc | 23 | |
3ffd4af2 LP |
24 | int close_nointr(int fd); |
25 | int safe_close(int fd); | |
3042bbeb | 26 | void safe_close_pair(int p[static 2]); |
3ffd4af2 | 27 | |
e7685a77 | 28 | static inline int safe_close_above_stdio(int fd) { |
5bb1d7fb YW |
29 | if (fd < 3) /* Don't close stdin/stdout/stderr, but still invalidate the fd by returning -EBADF. */ |
30 | return -EBADF; | |
e7685a77 LP |
31 | |
32 | return safe_close(fd); | |
33 | } | |
34 | ||
da6053d0 | 35 | void close_many(const int fds[], size_t n_fd); |
d3eb74f8 | 36 | void close_many_unset(int fds[], size_t n_fd); |
3b444970 | 37 | void close_many_and_free(int *fds, size_t n_fds); |
3ffd4af2 LP |
38 | |
39 | int fclose_nointr(FILE *f); | |
40 | FILE* safe_fclose(FILE *f); | |
41 | DIR* safe_closedir(DIR *f); | |
42 | ||
43 | static inline void closep(int *fd) { | |
44 | safe_close(*fd); | |
45 | } | |
46 | ||
47 | static inline void close_pairp(int (*p)[2]) { | |
48 | safe_close_pair(*p); | |
49 | } | |
50 | ||
51 | static inline void fclosep(FILE **f) { | |
52 | safe_fclose(*f); | |
53 | } | |
54 | ||
fd421c4a ZJS |
55 | DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(FILE*, pclose, NULL); |
56 | DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(DIR*, closedir, NULL); | |
3ffd4af2 LP |
57 | |
58 | #define _cleanup_close_ _cleanup_(closep) | |
59 | #define _cleanup_fclose_ _cleanup_(fclosep) | |
60 | #define _cleanup_pclose_ _cleanup_(pclosep) | |
61 | #define _cleanup_closedir_ _cleanup_(closedirp) | |
62 | #define _cleanup_close_pair_ _cleanup_(close_pairp) | |
63 | ||
64 | int fd_nonblock(int fd, bool nonblock); | |
65 | int fd_cloexec(int fd, bool cloexec); | |
ed18c22c | 66 | int fd_cloexec_many(const int fds[], size_t n_fds, bool cloexec); |
3ffd4af2 | 67 | |
73fc0cbc LP |
68 | int get_max_fd(void); |
69 | ||
c85cb3bc | 70 | int close_all_fds(const int except[], size_t n_except); |
11966552 | 71 | int close_all_fds_without_malloc(const int except[], size_t n_except); |
3ffd4af2 LP |
72 | |
73 | int same_fd(int a, int b); | |
74 | ||
75 | void cmsg_close_all(struct msghdr *mh); | |
4fee3975 LP |
76 | |
77 | bool fdname_is_valid(const char *s); | |
a1a3f73a | 78 | |
4aeb20f5 LP |
79 | int fd_get_path(int fd, char **ret); |
80 | ||
046a82c1 LP |
81 | int move_fd(int from, int to, int cloexec); |
82 | ||
7fe2903c | 83 | int fd_move_above_stdio(int fd); |
aa11e28b LP |
84 | |
85 | int rearrange_stdio(int original_input_fd, int original_output_fd, int original_error_fd); | |
8bb2db73 LP |
86 | |
87 | static inline int make_null_stdio(void) { | |
5bb1d7fb | 88 | return rearrange_stdio(-EBADF, -EBADF, -EBADF); |
8bb2db73 | 89 | } |
c10d6bdb | 90 | |
40c5cc2b DS |
91 | /* Like TAKE_PTR() but for file descriptors, resetting them to -EBADF */ |
92 | #define TAKE_FD(fd) TAKE_GENERIC(fd, int, -EBADF) | |
f2324783 | 93 | |
0706c012 | 94 | /* Like free_and_replace(), but for file descriptors */ |
ee3455cf | 95 | #define close_and_replace(a, b) \ |
0706c012 ZJS |
96 | ({ \ |
97 | int *_fdp_ = &(a); \ | |
98 | safe_close(*_fdp_); \ | |
99 | *_fdp_ = TAKE_FD(b); \ | |
100 | 0; \ | |
101 | }) | |
102 | ||
f2324783 | 103 | int fd_reopen(int fd, int flags); |
5f5865f0 | 104 | int fd_reopen_condition(int fd, int flags, int mask, int *ret_new_fd); |
ea61e2e9 | 105 | int fd_is_opath(int fd); |
9264cc39 | 106 | int read_nr_open(void); |
7e93a658 | 107 | int fd_get_diskseq(int fd, uint64_t *ret); |
6e1e4b59 | 108 | |
8a65b0b2 | 109 | int path_is_root_at(int dir_fd, const char *path); |
83c57d8c YW |
110 | static inline int path_is_root(const char *path) { |
111 | return path_is_root_at(AT_FDCWD, path); | |
112 | } | |
8a65b0b2 DDM |
113 | static inline int dir_fd_is_root(int dir_fd) { |
114 | return path_is_root_at(dir_fd, NULL); | |
115 | } | |
e212f422 | 116 | static inline int dir_fd_is_root_or_cwd(int dir_fd) { |
8a65b0b2 | 117 | return dir_fd == AT_FDCWD ? true : path_is_root_at(dir_fd, NULL); |
e212f422 | 118 | } |
af423b4b | 119 | |
7b9da386 | 120 | /* The maximum length a buffer for a /proc/self/fd/<fd> path needs */ |
6e1e4b59 | 121 | #define PROC_FD_PATH_MAX \ |
7b9da386 | 122 | (STRLEN("/proc/self/fd/") + DECIMAL_STR_MAX(int)) |
6e1e4b59 LP |
123 | |
124 | static inline char *format_proc_fd_path(char buf[static PROC_FD_PATH_MAX], int fd) { | |
125 | assert(buf); | |
126 | assert(fd >= 0); | |
7b9da386 | 127 | assert_se(snprintf_ok(buf, PROC_FD_PATH_MAX, "/proc/self/fd/%i", fd)); |
6e1e4b59 LP |
128 | return buf; |
129 | } | |
130 | ||
131 | #define FORMAT_PROC_FD_PATH(fd) \ | |
132 | format_proc_fd_path((char[PROC_FD_PATH_MAX]) {}, (fd)) | |
b2b84f4b LP |
133 | |
134 | const char *accmode_to_string(int flags); | |
6f81bcef LP |
135 | |
136 | /* Like ASSERT_PTR, but for fds */ | |
137 | #define ASSERT_FD(fd) \ | |
138 | ({ \ | |
139 | int _fd_ = (fd); \ | |
140 | assert(_fd_ >= 0); \ | |
141 | _fd_; \ | |
142 | }) |