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 "missing.h"
  34 #include "util.h"
  35
  36 union sockaddr_union {
  37         struct sockaddr sa;
  38         struct sockaddr_in in;
  39         struct sockaddr_in6 in6;
  40         struct sockaddr_un un;
  41         struct sockaddr_nl nl;
  42         struct sockaddr_storage storage;
  43         struct sockaddr_ll ll;
  44         struct sockaddr_vm vm;
  45 };
  46
  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
 103 bool socket_ipv6_is_supported(void);
 104
 105 int sockaddr_port(const struct sockaddr *_sa, unsigned *port);
 106
 107 int sockaddr_pretty(const struct sockaddr *_sa, socklen_t salen, bool translate_ipv6, bool include_port, char **ret);
 108 int getpeername_pretty(int fd, bool include_port, char **ret);
 109 int getsockname_pretty(int fd, char **ret);
 110
 111 int socknameinfo_pretty(union sockaddr_union *sa, socklen_t salen, char **_ret);
 112 int getnameinfo_pretty(int fd, char **ret);
 113
 114 const char* socket_address_bind_ipv6_only_to_string(SocketAddressBindIPv6Only b) _const_;
 115 SocketAddressBindIPv6Only socket_address_bind_ipv6_only_from_string(const char *s) _pure_;
 116
 117 int netlink_family_to_string_alloc(int b, char **s);
 118 int netlink_family_from_string(const char *s) _pure_;
 119
 120 bool sockaddr_equal(const union sockaddr_union *a, const union sockaddr_union *b);
 121
 122 int fd_inc_sndbuf(int fd, size_t n);
 123 int fd_inc_rcvbuf(int fd, size_t n);
 124
 125 int ip_tos_to_string_alloc(int i, char **s);
 126 int ip_tos_from_string(const char *s);
 127
 128 bool ifname_valid(const char *p);
 129 bool address_label_valid(const char *p);
 130
 131 int getpeercred(int fd, struct ucred *ucred);
 132 int getpeersec(int fd, char **ret);
 133
 134 int send_one_fd_sa(int transport_fd,
 135                    int fd,
 136                    const struct sockaddr *sa, socklen_t len,
 137                    int flags);
 138 #define send_one_fd(transport_fd, fd, flags) send_one_fd_sa(transport_fd, fd, NULL, 0, flags)
 139 int receive_one_fd(int transport_fd, int flags);
 140
 141 ssize_t next_datagram_size_fd(int fd);
 142
 143 int flush_accept(int fd);
 144
 145 #define CMSG_FOREACH(cmsg, mh)                                          \
 146         for ((cmsg) = CMSG_FIRSTHDR(mh); (cmsg); (cmsg) = CMSG_NXTHDR((mh), (cmsg)))
 147
 148 struct cmsghdr* cmsg_find(struct msghdr *mh, int level, int type, socklen_t length);
 149
 150 /* Covers only file system and abstract AF_UNIX socket addresses, but not unnamed socket addresses. */
 151 #define SOCKADDR_UN_LEN(sa)                                             \
 152         ({                                                              \
 153                 const struct sockaddr_un *_sa = &(sa);                  \
 154                 assert(_sa->sun_family == AF_UNIX);                     \
 155                 offsetof(struct sockaddr_un, sun_path) +                \
 156                         (_sa->sun_path[0] == 0 ?                        \
 157                          1 + strnlen(_sa->sun_path+1, sizeof(_sa->sun_path)-1) : \
 158                          strnlen(_sa->sun_path, sizeof(_sa->sun_path))); \
 159         })
 160
 161 int socket_ioctl_fd(void);