chiark / gitweb /
Prep v233: Unmask now needed functions in src/basic
[elogind.git] / src / basic / socket-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 <netinet/ether.h>
23 #include <netinet/in.h>
24 #include <stdbool.h>
25 #include <stddef.h>
26 #include <sys/socket.h>
27 #include <sys/types.h>
28 #include <sys/un.h>
29 #include <linux/netlink.h>
30 #include <linux/if_packet.h>
31
32 #include "macro.h"
33 #include "util.h"
34
35 union sockaddr_union {
36         struct sockaddr sa;
37         struct sockaddr_in in;
38         struct sockaddr_in6 in6;
39         struct sockaddr_un un;
40         struct sockaddr_nl nl;
41         struct sockaddr_storage storage;
42         struct sockaddr_ll ll;
43         struct sockaddr_vm vm;
44 };
45
46 #if 0 /// UNNEEDED by elogind
47 typedef struct SocketAddress {
48         union sockaddr_union sockaddr;
49
50         /* We store the size here explicitly due to the weird
51          * sockaddr_un semantics for abstract sockets */
52         socklen_t size;
53
54         /* Socket type, i.e. SOCK_STREAM, SOCK_DGRAM, ... */
55         int type;
56
57         /* Socket protocol, IPPROTO_xxx, usually 0, except for netlink */
58         int protocol;
59 } SocketAddress;
60
61 typedef enum SocketAddressBindIPv6Only {
62         SOCKET_ADDRESS_DEFAULT,
63         SOCKET_ADDRESS_BOTH,
64         SOCKET_ADDRESS_IPV6_ONLY,
65         _SOCKET_ADDRESS_BIND_IPV6_ONLY_MAX,
66         _SOCKET_ADDRESS_BIND_IPV6_ONLY_INVALID = -1
67 } SocketAddressBindIPv6Only;
68
69 #define socket_address_family(a) ((a)->sockaddr.sa.sa_family)
70
71 int socket_address_parse(SocketAddress *a, const char *s);
72 int socket_address_parse_and_warn(SocketAddress *a, const char *s);
73 int socket_address_parse_netlink(SocketAddress *a, const char *s);
74 int socket_address_print(const SocketAddress *a, char **p);
75 int socket_address_verify(const SocketAddress *a) _pure_;
76 int socket_address_unlink(SocketAddress *a);
77
78 bool socket_address_can_accept(const SocketAddress *a) _pure_;
79
80 int socket_address_listen(
81                 const SocketAddress *a,
82                 int flags,
83                 int backlog,
84                 SocketAddressBindIPv6Only only,
85                 const char *bind_to_device,
86                 bool reuse_port,
87                 bool free_bind,
88                 bool transparent,
89                 mode_t directory_mode,
90                 mode_t socket_mode,
91                 const char *label);
92 int make_socket_fd(int log_level, const char* address, int type, int flags);
93
94 bool socket_address_is(const SocketAddress *a, const char *s, int type);
95 bool socket_address_is_netlink(const SocketAddress *a, const char *s);
96
97 bool socket_address_matches_fd(const SocketAddress *a, int fd);
98
99 bool socket_address_equal(const SocketAddress *a, const SocketAddress *b) _pure_;
100
101 const char* socket_address_get_path(const SocketAddress *a);
102 #endif // 0
103
104 bool socket_ipv6_is_supported(void);
105
106 #if 0 /// UNNEEDED by elogind
107 int sockaddr_port(const struct sockaddr *_sa, unsigned *port);
108
109 int sockaddr_pretty(const struct sockaddr *_sa, socklen_t salen, bool translate_ipv6, bool include_port, char **ret);
110 int getpeername_pretty(int fd, bool include_port, char **ret);
111 int getsockname_pretty(int fd, char **ret);
112
113 int socknameinfo_pretty(union sockaddr_union *sa, socklen_t salen, char **_ret);
114 int getnameinfo_pretty(int fd, char **ret);
115
116 const char* socket_address_bind_ipv6_only_to_string(SocketAddressBindIPv6Only b) _const_;
117 SocketAddressBindIPv6Only socket_address_bind_ipv6_only_from_string(const char *s) _pure_;
118
119 int netlink_family_to_string_alloc(int b, char **s);
120 int netlink_family_from_string(const char *s) _pure_;
121
122 bool sockaddr_equal(const union sockaddr_union *a, const union sockaddr_union *b);
123 #endif // 0
124
125 int fd_inc_sndbuf(int fd, size_t n);
126 int fd_inc_rcvbuf(int fd, size_t n);
127 #if 0 /// UNNEEDED by elogind
128
129 int ip_tos_to_string_alloc(int i, char **s);
130 int ip_tos_from_string(const char *s);
131 #endif // 0
132
133 bool ifname_valid(const char *p);
134 bool address_label_valid(const char *p);
135
136 int getpeercred(int fd, struct ucred *ucred);
137 int getpeersec(int fd, char **ret);
138
139 int send_one_fd_sa(int transport_fd,
140                    int fd,
141                    const struct sockaddr *sa, socklen_t len,
142                    int flags);
143 #define send_one_fd(transport_fd, fd, flags) send_one_fd_sa(transport_fd, fd, NULL, 0, flags)
144 #if 0 /// UNNEEDED by elogind
145 int receive_one_fd(int transport_fd, int flags);
146
147 ssize_t next_datagram_size_fd(int fd);
148
149 int flush_accept(int fd);
150 #endif // 0
151
152 #define CMSG_FOREACH(cmsg, mh)                                          \
153         for ((cmsg) = CMSG_FIRSTHDR(mh); (cmsg); (cmsg) = CMSG_NXTHDR((mh), (cmsg)))
154
155 struct cmsghdr* cmsg_find(struct msghdr *mh, int level, int type, socklen_t length);
156
157 /* Covers only file system and abstract AF_UNIX socket addresses, but not unnamed socket addresses. */
158 #define SOCKADDR_UN_LEN(sa)                                             \
159         ({                                                              \
160                 const struct sockaddr_un *_sa = &(sa);                  \
161                 assert(_sa->sun_family == AF_UNIX);                     \
162                 offsetof(struct sockaddr_un, sun_path) +                \
163                         (_sa->sun_path[0] == 0 ?                        \
164                          1 + strnlen(_sa->sun_path+1, sizeof(_sa->sun_path)-1) : \
165                          strnlen(_sa->sun_path, sizeof(_sa->sun_path))); \
166         })
167
168 #if 0 /// UNNEEDED by elogind
169 int socket_ioctl_fd(void);
170 #endif // 0