chiark / gitweb /
core: rework how we flush incoming traffic when a socket unit goes down
[elogind.git] / src / basic / fd-util.h
1 #pragma once
2
3 /***
4   This file is part of systemd.
5
6   Copyright 2010 Lennart Poettering
7
8   systemd is free software; you can redistribute it and/or modify it
9   under the terms of the GNU Lesser General Public License as published by
10   the Free Software Foundation; either version 2.1 of the License, or
11   (at your option) any later version.
12
13   systemd is distributed in the hope that it will be useful, but
14   WITHOUT ANY WARRANTY; without even the implied warranty of
15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16   Lesser General Public License for more details.
17
18   You should have received a copy of the GNU Lesser General Public License
19   along with systemd; If not, see <http://www.gnu.org/licenses/>.
20 ***/
21
22 #include <dirent.h>
23 #include <stdbool.h>
24 #include <stdio.h>
25 #include <sys/socket.h>
26
27 #include "macro.h"
28
29 /* Make sure we can distinguish fd 0 and NULL */
30 #define FD_TO_PTR(fd) INT_TO_PTR((fd)+1)
31 #define PTR_TO_FD(p) (PTR_TO_INT(p)-1)
32
33 int close_nointr(int fd);
34 int safe_close(int fd);
35 void safe_close_pair(int p[]);
36
37 void close_many(const int fds[], unsigned n_fd);
38
39 int fclose_nointr(FILE *f);
40 FILE* safe_fclose(FILE *f);
41 #if 0 /// UNNEEDED by elogind
42 DIR* safe_closedir(DIR *f);
43 #endif // 0
44
45 static inline void closep(int *fd) {
46         safe_close(*fd);
47 }
48
49 static inline void close_pairp(int (*p)[2]) {
50         safe_close_pair(*p);
51 }
52
53 static inline void fclosep(FILE **f) {
54         safe_fclose(*f);
55 }
56
57 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, pclose);
58 DEFINE_TRIVIAL_CLEANUP_FUNC(DIR*, closedir);
59
60 #define _cleanup_close_ _cleanup_(closep)
61 #define _cleanup_fclose_ _cleanup_(fclosep)
62 #define _cleanup_pclose_ _cleanup_(pclosep)
63 #define _cleanup_closedir_ _cleanup_(closedirp)
64 #define _cleanup_close_pair_ _cleanup_(close_pairp)
65
66 int fd_nonblock(int fd, bool nonblock);
67 int fd_cloexec(int fd, bool cloexec);
68
69 int close_all_fds(const int except[], unsigned n_except);
70
71 #if 0 /// UNNEEDED by elogind
72 int same_fd(int a, int b);
73
74 void cmsg_close_all(struct msghdr *mh);
75
76 bool fdname_is_valid(const char *s);
77 #endif // 0
78
79 /* Hint: ENETUNREACH happens if we try to connect to "non-existing" special IP addresses, such as ::5 */
80 #define ERRNO_IS_DISCONNECT(r) \
81         IN_SET(r, ENOTCONN, ECONNRESET, ECONNREFUSED, ECONNABORTED, EPIPE, ENETUNREACH)