Blame shared/systemd/src/basic/socket-util.h

Packit Service b23acc
/* SPDX-License-Identifier: LGPL-2.1+ */
Packit Service b23acc
#pragma once
Packit Service b23acc
Packit Service b23acc
#include <inttypes.h>
Packit Service b23acc
#include <linux/netlink.h>
Packit Service b23acc
#include <linux/if_ether.h>
Packit Service b23acc
#include <linux/if_infiniband.h>
Packit Service b23acc
#include <linux/if_packet.h>
Packit Service b23acc
#include <netinet/in.h>
Packit Service b23acc
#include <stdbool.h>
Packit Service b23acc
#include <stddef.h>
Packit Service b23acc
#include <string.h>
Packit Service b23acc
#include <sys/socket.h>
Packit Service b23acc
#include <sys/types.h>
Packit Service b23acc
#include <sys/un.h>
Packit Service b23acc
Packit Service b23acc
#include "macro.h"
Packit Service b23acc
#include "missing_socket.h"
Packit Service b23acc
#include "sparse-endian.h"
Packit Service b23acc
Packit Service b23acc
union sockaddr_union {
Packit Service b23acc
        /* The minimal, abstract version */
Packit Service b23acc
        struct sockaddr sa;
Packit Service b23acc
Packit Service b23acc
        /* The libc provided version that allocates "enough room" for every protocol */
Packit Service b23acc
        struct sockaddr_storage storage;
Packit Service b23acc
Packit Service b23acc
        /* Protoctol-specific implementations */
Packit Service b23acc
        struct sockaddr_in in;
Packit Service b23acc
        struct sockaddr_in6 in6;
Packit Service b23acc
        struct sockaddr_un un;
Packit Service b23acc
        struct sockaddr_nl nl;
Packit Service b23acc
        struct sockaddr_ll ll;
Packit Service b23acc
#if 0 /* NM_IGNORED */
Packit Service b23acc
        struct sockaddr_vm vm;
Packit Service b23acc
#endif /* NM_IGNORED */
Packit Service b23acc
Packit Service b23acc
        /* Ensure there is enough space to store Infiniband addresses */
Packit Service b23acc
        uint8_t ll_buffer[offsetof(struct sockaddr_ll, sll_addr) + CONST_MAX(ETH_ALEN, INFINIBAND_ALEN)];
Packit Service b23acc
Packit Service b23acc
        /* Ensure there is enough space after the AF_UNIX sun_path for one more NUL byte, just to be sure that the path
Packit Service b23acc
         * component is always followed by at least one NUL byte. */
Packit Service b23acc
        uint8_t un_buffer[sizeof(struct sockaddr_un) + 1];
Packit Service b23acc
};
Packit Service b23acc
Packit Service b23acc
#define SUN_PATH_LEN (sizeof(((struct sockaddr_un){}).sun_path))
Packit Service b23acc
Packit Service b23acc
typedef struct SocketAddress {
Packit Service b23acc
        union sockaddr_union sockaddr;
Packit Service b23acc
Packit Service b23acc
        /* We store the size here explicitly due to the weird
Packit Service b23acc
         * sockaddr_un semantics for abstract sockets */
Packit Service b23acc
        socklen_t size;
Packit Service b23acc
Packit Service b23acc
        /* Socket type, i.e. SOCK_STREAM, SOCK_DGRAM, ... */
Packit Service b23acc
        int type;
Packit Service b23acc
Packit Service b23acc
        /* Socket protocol, IPPROTO_xxx, usually 0, except for netlink */
Packit Service b23acc
        int protocol;
Packit Service b23acc
} SocketAddress;
Packit Service b23acc
Packit Service b23acc
typedef enum SocketAddressBindIPv6Only {
Packit Service b23acc
        SOCKET_ADDRESS_DEFAULT,
Packit Service b23acc
        SOCKET_ADDRESS_BOTH,
Packit Service b23acc
        SOCKET_ADDRESS_IPV6_ONLY,
Packit Service b23acc
        _SOCKET_ADDRESS_BIND_IPV6_ONLY_MAX,
Packit Service b23acc
        _SOCKET_ADDRESS_BIND_IPV6_ONLY_INVALID = -1
Packit Service b23acc
} SocketAddressBindIPv6Only;
Packit Service b23acc
Packit Service b23acc
#define socket_address_family(a) ((a)->sockaddr.sa.sa_family)
Packit Service b23acc
Packit Service b23acc
const char* socket_address_type_to_string(int t) _const_;
Packit Service b23acc
int socket_address_type_from_string(const char *s) _pure_;
Packit Service b23acc
Packit Service b23acc
int sockaddr_un_unlink(const struct sockaddr_un *sa);
Packit Service b23acc
Packit Service b23acc
static inline int socket_address_unlink(const SocketAddress *a) {
Packit Service b23acc
        return socket_address_family(a) == AF_UNIX ? sockaddr_un_unlink(&a->sockaddr.un) : 0;
Packit Service b23acc
}
Packit Service b23acc
Packit Service b23acc
bool socket_address_can_accept(const SocketAddress *a) _pure_;
Packit Service b23acc
Packit Service b23acc
int socket_address_listen(
Packit Service b23acc
                const SocketAddress *a,
Packit Service b23acc
                int flags,
Packit Service b23acc
                int backlog,
Packit Service b23acc
                SocketAddressBindIPv6Only only,
Packit Service b23acc
                const char *bind_to_device,
Packit Service b23acc
                bool reuse_port,
Packit Service b23acc
                bool free_bind,
Packit Service b23acc
                bool transparent,
Packit Service b23acc
                mode_t directory_mode,
Packit Service b23acc
                mode_t socket_mode,
Packit Service b23acc
                const char *label);
Packit Service b23acc
Packit Service b23acc
int socket_address_verify(const SocketAddress *a, bool strict) _pure_;
Packit Service b23acc
int socket_address_print(const SocketAddress *a, char **p);
Packit Service b23acc
bool socket_address_matches_fd(const SocketAddress *a, int fd);
Packit Service b23acc
Packit Service b23acc
bool socket_address_equal(const SocketAddress *a, const SocketAddress *b) _pure_;
Packit Service b23acc
Packit Service b23acc
const char* socket_address_get_path(const SocketAddress *a);
Packit Service b23acc
Packit Service b23acc
bool socket_ipv6_is_supported(void);
Packit Service b23acc
Packit Service b23acc
int sockaddr_port(const struct sockaddr *_sa, unsigned *port);
Packit Service b23acc
Packit Service b23acc
int sockaddr_pretty(const struct sockaddr *_sa, socklen_t salen, bool translate_ipv6, bool include_port, char **ret);
Packit Service b23acc
int getpeername_pretty(int fd, bool include_port, char **ret);
Packit Service b23acc
int getsockname_pretty(int fd, char **ret);
Packit Service b23acc
Packit Service b23acc
int socknameinfo_pretty(union sockaddr_union *sa, socklen_t salen, char **_ret);
Packit Service b23acc
Packit Service b23acc
const char* socket_address_bind_ipv6_only_to_string(SocketAddressBindIPv6Only b) _const_;
Packit Service b23acc
SocketAddressBindIPv6Only socket_address_bind_ipv6_only_from_string(const char *s) _pure_;
Packit Service b23acc
SocketAddressBindIPv6Only socket_address_bind_ipv6_only_or_bool_from_string(const char *s);
Packit Service b23acc
Packit Service b23acc
int netlink_family_to_string_alloc(int b, char **s);
Packit Service b23acc
int netlink_family_from_string(const char *s) _pure_;
Packit Service b23acc
Packit Service b23acc
bool sockaddr_equal(const union sockaddr_union *a, const union sockaddr_union *b);
Packit Service b23acc
Packit Service b23acc
int fd_inc_sndbuf(int fd, size_t n);
Packit Service b23acc
int fd_inc_rcvbuf(int fd, size_t n);
Packit Service b23acc
Packit Service b23acc
int ip_tos_to_string_alloc(int i, char **s);
Packit Service b23acc
int ip_tos_from_string(const char *s);
Packit Service b23acc
Packit Service b23acc
bool ifname_valid_full(const char *p, bool alternative);
Packit Service b23acc
static inline bool ifname_valid(const char *p) {
Packit Service b23acc
        return ifname_valid_full(p, false);
Packit Service b23acc
}
Packit Service b23acc
bool address_label_valid(const char *p);
Packit Service b23acc
Packit Service b23acc
int getpeercred(int fd, struct ucred *ucred);
Packit Service b23acc
int getpeersec(int fd, char **ret);
Packit Service b23acc
int getpeergroups(int fd, gid_t **ret);
Packit Service b23acc
Packit Service b23acc
ssize_t send_one_fd_iov_sa(
Packit Service b23acc
                int transport_fd,
Packit Service b23acc
                int fd,
Packit Service b23acc
                struct iovec *iov, size_t iovlen,
Packit Service b23acc
                const struct sockaddr *sa, socklen_t len,
Packit Service b23acc
                int flags);
Packit Service b23acc
int send_one_fd_sa(int transport_fd,
Packit Service b23acc
                   int fd,
Packit Service b23acc
                   const struct sockaddr *sa, socklen_t len,
Packit Service b23acc
                   int flags);
Packit Service b23acc
#define send_one_fd_iov(transport_fd, fd, iov, iovlen, flags) send_one_fd_iov_sa(transport_fd, fd, iov, iovlen, NULL, 0, flags)
Packit Service b23acc
#define send_one_fd(transport_fd, fd, flags) send_one_fd_iov_sa(transport_fd, fd, NULL, 0, NULL, 0, flags)
Packit Service b23acc
ssize_t receive_one_fd_iov(int transport_fd, struct iovec *iov, size_t iovlen, int flags, int *ret_fd);
Packit Service b23acc
int receive_one_fd(int transport_fd, int flags);
Packit Service b23acc
Packit Service b23acc
ssize_t next_datagram_size_fd(int fd);
Packit Service b23acc
Packit Service b23acc
int flush_accept(int fd);
Packit Service b23acc
Packit Service b23acc
#define CMSG_FOREACH(cmsg, mh)                                          \
Packit Service b23acc
        for ((cmsg) = CMSG_FIRSTHDR(mh); (cmsg); (cmsg) = CMSG_NXTHDR((mh), (cmsg)))
Packit Service b23acc
Packit Service b23acc
struct cmsghdr* cmsg_find(struct msghdr *mh, int level, int type, socklen_t length);
Packit Service b23acc
Packit Service b23acc
/* Type-safe, dereferencing version of cmsg_find() */
Packit Service b23acc
#define CMSG_FIND_DATA(mh, level, type, ctype) \
Packit Service b23acc
        ({                                                            \
Packit Service b23acc
                struct cmsghdr *_found;                               \
Packit Service b23acc
                _found = cmsg_find(mh, level, type, CMSG_LEN(sizeof(ctype))); \
Packit Service b23acc
                (ctype*) (_found ? CMSG_DATA(_found) : NULL);         \
Packit Service b23acc
        })
Packit Service b23acc
Packit Service b23acc
/* Resolves to a type that can carry cmsghdr structures. Make sure things are properly aligned, i.e. the type
Packit Service b23acc
 * itself is placed properly in memory and the size is also aligned to what's appropriate for "cmsghdr"
Packit Service b23acc
 * structures. */
Packit Service b23acc
#define CMSG_BUFFER_TYPE(size)                                          \
Packit Service b23acc
        union {                                                         \
Packit Service b23acc
                struct cmsghdr cmsghdr;                                 \
Packit Service b23acc
                uint8_t buf[size];                                      \
Packit Service b23acc
                uint8_t align_check[(size) >= CMSG_SPACE(0) &&          \
Packit Service b23acc
                                    (size) == CMSG_ALIGN(size) ? 1 : -1]; \
Packit Service b23acc
        }
Packit Service b23acc
Packit Service b23acc
/*
Packit Service b23acc
 * Certain hardware address types (e.g Infiniband) do not fit into sll_addr
Packit Service b23acc
 * (8 bytes) and run over the structure. This macro returns the correct size that
Packit Service b23acc
 * must be passed to kernel.
Packit Service b23acc
 */
Packit Service b23acc
#define SOCKADDR_LL_LEN(sa)                                             \
Packit Service b23acc
        ({                                                              \
Packit Service b23acc
                const struct sockaddr_ll *_sa = &(sa);                  \
Packit Service b23acc
                size_t _mac_len = sizeof(_sa->sll_addr);                \
Packit Service b23acc
                assert(_sa->sll_family == AF_PACKET);                   \
Packit Service b23acc
                if (be16toh(_sa->sll_hatype) == ARPHRD_ETHER)           \
Packit Service b23acc
                        _mac_len = MAX(_mac_len, (size_t) ETH_ALEN);    \
Packit Service b23acc
                if (be16toh(_sa->sll_hatype) == ARPHRD_INFINIBAND)      \
Packit Service b23acc
                        _mac_len = MAX(_mac_len, (size_t) INFINIBAND_ALEN); \
Packit Service b23acc
                offsetof(struct sockaddr_ll, sll_addr) + _mac_len;      \
Packit Service b23acc
        })
Packit Service b23acc
Packit Service b23acc
/* Covers only file system and abstract AF_UNIX socket addresses, but not unnamed socket addresses. */
Packit Service b23acc
#define SOCKADDR_UN_LEN(sa)                                             \
Packit Service b23acc
        ({                                                              \
Packit Service b23acc
                const struct sockaddr_un *_sa = &(sa);                  \
Packit Service b23acc
                assert(_sa->sun_family == AF_UNIX);                     \
Packit Service b23acc
                offsetof(struct sockaddr_un, sun_path) +                \
Packit Service b23acc
                        (_sa->sun_path[0] == 0 ?                        \
Packit Service b23acc
                         1 + strnlen(_sa->sun_path+1, sizeof(_sa->sun_path)-1) : \
Packit Service b23acc
                         strnlen(_sa->sun_path, sizeof(_sa->sun_path))+1); \
Packit Service b23acc
        })
Packit Service b23acc
Packit Service b23acc
int socket_ioctl_fd(void);
Packit Service b23acc
Packit Service b23acc
int sockaddr_un_set_path(struct sockaddr_un *ret, const char *path);
Packit Service b23acc
Packit Service b23acc
static inline int setsockopt_int(int fd, int level, int optname, int value) {
Packit Service b23acc
        if (setsockopt(fd, level, optname, &value, sizeof(value)) < 0)
Packit Service b23acc
                return -errno;
Packit Service b23acc
Packit Service b23acc
        return 0;
Packit Service b23acc
}
Packit Service b23acc
Packit Service b23acc
int socket_bind_to_ifname(int fd, const char *ifname);
Packit Service b23acc
int socket_bind_to_ifindex(int fd, int ifindex);
Packit Service b23acc
Packit Service b23acc
ssize_t recvmsg_safe(int sockfd, struct msghdr *msg, int flags);
Packit Service b23acc
Packit Service b23acc
int socket_pass_pktinfo(int fd, bool b);