LCOV - code coverage report
Current view: top level - basic - socket-util.h (source / functions) Hit Total Coverage
Test: systemd_full.info Lines: 4 6 66.7 %
Date: 2019-08-23 13:36:53 Functions: 1 2 50.0 %
Legend: Lines: hit not hit | Branches: + taken - not taken # not executed Branches: 2 4 50.0 %

           Branch data     Line data    Source code
       1                 :            : /* SPDX-License-Identifier: LGPL-2.1+ */
       2                 :            : #pragma once
       3                 :            : 
       4                 :            : #include <inttypes.h>
       5                 :            : #include <linux/netlink.h>
       6                 :            : #include <linux/if_ether.h>
       7                 :            : #include <linux/if_infiniband.h>
       8                 :            : #include <linux/if_packet.h>
       9                 :            : #include <netinet/in.h>
      10                 :            : #include <stdbool.h>
      11                 :            : #include <stddef.h>
      12                 :            : #include <string.h>
      13                 :            : #include <sys/socket.h>
      14                 :            : #include <sys/types.h>
      15                 :            : #include <sys/un.h>
      16                 :            : 
      17                 :            : #include "macro.h"
      18                 :            : #include "missing_socket.h"
      19                 :            : #include "sparse-endian.h"
      20                 :            : 
      21                 :            : union sockaddr_union {
      22                 :            :         /* The minimal, abstract version */
      23                 :            :         struct sockaddr sa;
      24                 :            : 
      25                 :            :         /* The libc provided version that allocates "enough room" for every protocol */
      26                 :            :         struct sockaddr_storage storage;
      27                 :            : 
      28                 :            :         /* Protoctol-specific implementations */
      29                 :            :         struct sockaddr_in in;
      30                 :            :         struct sockaddr_in6 in6;
      31                 :            :         struct sockaddr_un un;
      32                 :            :         struct sockaddr_nl nl;
      33                 :            :         struct sockaddr_ll ll;
      34                 :            :         struct sockaddr_vm vm;
      35                 :            : 
      36                 :            :         /* Ensure there is enough space to store Infiniband addresses */
      37                 :            :         uint8_t ll_buffer[offsetof(struct sockaddr_ll, sll_addr) + CONST_MAX(ETH_ALEN, INFINIBAND_ALEN)];
      38                 :            : 
      39                 :            :         /* Ensure there is enough space after the AF_UNIX sun_path for one more NUL byte, just to be sure that the path
      40                 :            :          * component is always followed by at least one NUL byte. */
      41                 :            :         uint8_t un_buffer[sizeof(struct sockaddr_un) + 1];
      42                 :            : };
      43                 :            : 
      44                 :            : typedef struct SocketAddress {
      45                 :            :         union sockaddr_union sockaddr;
      46                 :            : 
      47                 :            :         /* We store the size here explicitly due to the weird
      48                 :            :          * sockaddr_un semantics for abstract sockets */
      49                 :            :         socklen_t size;
      50                 :            : 
      51                 :            :         /* Socket type, i.e. SOCK_STREAM, SOCK_DGRAM, ... */
      52                 :            :         int type;
      53                 :            : 
      54                 :            :         /* Socket protocol, IPPROTO_xxx, usually 0, except for netlink */
      55                 :            :         int protocol;
      56                 :            : } SocketAddress;
      57                 :            : 
      58                 :            : typedef enum SocketAddressBindIPv6Only {
      59                 :            :         SOCKET_ADDRESS_DEFAULT,
      60                 :            :         SOCKET_ADDRESS_BOTH,
      61                 :            :         SOCKET_ADDRESS_IPV6_ONLY,
      62                 :            :         _SOCKET_ADDRESS_BIND_IPV6_ONLY_MAX,
      63                 :            :         _SOCKET_ADDRESS_BIND_IPV6_ONLY_INVALID = -1
      64                 :            : } SocketAddressBindIPv6Only;
      65                 :            : 
      66                 :            : #define socket_address_family(a) ((a)->sockaddr.sa.sa_family)
      67                 :            : 
      68                 :            : const char* socket_address_type_to_string(int t) _const_;
      69                 :            : int socket_address_type_from_string(const char *s) _pure_;
      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, bool strict) _pure_;
      76                 :            : 
      77                 :            : int sockaddr_un_unlink(const struct sockaddr_un *sa);
      78                 :            : 
      79                 :          0 : static inline int socket_address_unlink(const SocketAddress *a) {
      80         [ #  # ]:          0 :         return socket_address_family(a) == AF_UNIX ? sockaddr_un_unlink(&a->sockaddr.un) : 0;
      81                 :            : }
      82                 :            : 
      83                 :            : bool socket_address_can_accept(const SocketAddress *a) _pure_;
      84                 :            : 
      85                 :            : int socket_address_listen(
      86                 :            :                 const SocketAddress *a,
      87                 :            :                 int flags,
      88                 :            :                 int backlog,
      89                 :            :                 SocketAddressBindIPv6Only only,
      90                 :            :                 const char *bind_to_device,
      91                 :            :                 bool reuse_port,
      92                 :            :                 bool free_bind,
      93                 :            :                 bool transparent,
      94                 :            :                 mode_t directory_mode,
      95                 :            :                 mode_t socket_mode,
      96                 :            :                 const char *label);
      97                 :            : int make_socket_fd(int log_level, const char* address, int type, int flags);
      98                 :            : 
      99                 :            : bool socket_address_is(const SocketAddress *a, const char *s, int type);
     100                 :            : bool socket_address_is_netlink(const SocketAddress *a, const char *s);
     101                 :            : 
     102                 :            : bool socket_address_matches_fd(const SocketAddress *a, int fd);
     103                 :            : 
     104                 :            : bool socket_address_equal(const SocketAddress *a, const SocketAddress *b) _pure_;
     105                 :            : 
     106                 :            : const char* socket_address_get_path(const SocketAddress *a);
     107                 :            : 
     108                 :            : bool socket_ipv6_is_supported(void);
     109                 :            : 
     110                 :            : int sockaddr_port(const struct sockaddr *_sa, unsigned *port);
     111                 :            : 
     112                 :            : int sockaddr_pretty(const struct sockaddr *_sa, socklen_t salen, bool translate_ipv6, bool include_port, char **ret);
     113                 :            : int getpeername_pretty(int fd, bool include_port, char **ret);
     114                 :            : int getsockname_pretty(int fd, char **ret);
     115                 :            : 
     116                 :            : int socknameinfo_pretty(union sockaddr_union *sa, socklen_t salen, char **_ret);
     117                 :            : 
     118                 :            : const char* socket_address_bind_ipv6_only_to_string(SocketAddressBindIPv6Only b) _const_;
     119                 :            : SocketAddressBindIPv6Only socket_address_bind_ipv6_only_from_string(const char *s) _pure_;
     120                 :            : SocketAddressBindIPv6Only socket_address_bind_ipv6_only_or_bool_from_string(const char *s);
     121                 :            : 
     122                 :            : int netlink_family_to_string_alloc(int b, char **s);
     123                 :            : int netlink_family_from_string(const char *s) _pure_;
     124                 :            : 
     125                 :            : bool sockaddr_equal(const union sockaddr_union *a, const union sockaddr_union *b);
     126                 :            : 
     127                 :            : int fd_inc_sndbuf(int fd, size_t n);
     128                 :            : int fd_inc_rcvbuf(int fd, size_t n);
     129                 :            : 
     130                 :            : int ip_tos_to_string_alloc(int i, char **s);
     131                 :            : int ip_tos_from_string(const char *s);
     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                 :            : int getpeergroups(int fd, gid_t **ret);
     139                 :            : 
     140                 :            : ssize_t send_one_fd_iov_sa(
     141                 :            :                 int transport_fd,
     142                 :            :                 int fd,
     143                 :            :                 struct iovec *iov, size_t iovlen,
     144                 :            :                 const struct sockaddr *sa, socklen_t len,
     145                 :            :                 int flags);
     146                 :            : int send_one_fd_sa(int transport_fd,
     147                 :            :                    int fd,
     148                 :            :                    const struct sockaddr *sa, socklen_t len,
     149                 :            :                    int flags);
     150                 :            : #define send_one_fd_iov(transport_fd, fd, iov, iovlen, flags) send_one_fd_iov_sa(transport_fd, fd, iov, iovlen, NULL, 0, flags)
     151                 :            : #define send_one_fd(transport_fd, fd, flags) send_one_fd_iov_sa(transport_fd, fd, NULL, 0, NULL, 0, flags)
     152                 :            : ssize_t receive_one_fd_iov(int transport_fd, struct iovec *iov, size_t iovlen, int flags, int *ret_fd);
     153                 :            : int receive_one_fd(int transport_fd, int flags);
     154                 :            : 
     155                 :            : ssize_t next_datagram_size_fd(int fd);
     156                 :            : 
     157                 :            : int flush_accept(int fd);
     158                 :            : 
     159                 :            : #define CMSG_FOREACH(cmsg, mh)                                          \
     160                 :            :         for ((cmsg) = CMSG_FIRSTHDR(mh); (cmsg); (cmsg) = CMSG_NXTHDR((mh), (cmsg)))
     161                 :            : 
     162                 :            : struct cmsghdr* cmsg_find(struct msghdr *mh, int level, int type, socklen_t length);
     163                 :            : 
     164                 :            : /*
     165                 :            :  * Certain hardware address types (e.g Infiniband) do not fit into sll_addr
     166                 :            :  * (8 bytes) and run over the structure. This macro returns the correct size that
     167                 :            :  * must be passed to kernel.
     168                 :            :  */
     169                 :            : #define SOCKADDR_LL_LEN(sa)                                             \
     170                 :            :         ({                                                              \
     171                 :            :                 const struct sockaddr_ll *_sa = &(sa);                  \
     172                 :            :                 size_t _mac_len = sizeof(_sa->sll_addr);                \
     173                 :            :                 assert(_sa->sll_family == AF_PACKET);                   \
     174                 :            :                 if (be16toh(_sa->sll_hatype) == ARPHRD_ETHER)           \
     175                 :            :                         _mac_len = MAX(_mac_len, (size_t) ETH_ALEN);    \
     176                 :            :                 if (be16toh(_sa->sll_hatype) == ARPHRD_INFINIBAND)      \
     177                 :            :                         _mac_len = MAX(_mac_len, (size_t) INFINIBAND_ALEN); \
     178                 :            :                 offsetof(struct sockaddr_ll, sll_addr) + _mac_len;      \
     179                 :            :         })
     180                 :            : 
     181                 :            : /* Covers only file system and abstract AF_UNIX socket addresses, but not unnamed socket addresses. */
     182                 :            : #define SOCKADDR_UN_LEN(sa)                                             \
     183                 :            :         ({                                                              \
     184                 :            :                 const struct sockaddr_un *_sa = &(sa);                  \
     185                 :            :                 assert(_sa->sun_family == AF_UNIX);                     \
     186                 :            :                 offsetof(struct sockaddr_un, sun_path) +                \
     187                 :            :                         (_sa->sun_path[0] == 0 ?                        \
     188                 :            :                          1 + strnlen(_sa->sun_path+1, sizeof(_sa->sun_path)-1) : \
     189                 :            :                          strnlen(_sa->sun_path, sizeof(_sa->sun_path))+1); \
     190                 :            :         })
     191                 :            : 
     192                 :            : int socket_ioctl_fd(void);
     193                 :            : 
     194                 :            : int sockaddr_un_set_path(struct sockaddr_un *ret, const char *path);
     195                 :            : 
     196                 :       1344 : static inline int setsockopt_int(int fd, int level, int optname, int value) {
     197         [ +  + ]:       1344 :         if (setsockopt(fd, level, optname, &value, sizeof(value)) < 0)
     198                 :         44 :                 return -errno;
     199                 :            : 
     200                 :       1300 :         return 0;
     201                 :            : }
     202                 :            : 
     203                 :            : int socket_bind_to_ifname(int fd, const char *ifname);
     204                 :            : int socket_bind_to_ifindex(int fd, int ifindex);

Generated by: LCOV version 1.14