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 <sys/socket.h>
  23 #include <netinet/in.h>
  24 #include <netinet/ether.h>
  25 #include <sys/un.h>
  26 #include <linux/netlink.h>
  27 #include <linux/if_packet.h>
  28
  29 #include "macro.h"
  30 #include "util.h"
  31
  32 union sockaddr_union {
  33         struct sockaddr sa;
  34         struct sockaddr_in in;
  35         struct sockaddr_in6 in6;
  36         struct sockaddr_un un;
  37         struct sockaddr_nl nl;
  38         struct sockaddr_storage storage;
  39         struct sockaddr_ll ll;
  40 };
  41
  42 #if 0 /// UNNEEDED by elogind
  43 typedef struct SocketAddress {
  44         union sockaddr_union sockaddr;
  45
  46         /* We store the size here explicitly due to the weird
  47          * sockaddr_un semantics for abstract sockets */
  48         socklen_t size;
  49
  50         /* Socket type, i.e. SOCK_STREAM, SOCK_DGRAM, ... */
  51         int type;
  52
  53         /* Socket protocol, IPPROTO_xxx, usually 0, except for netlink */
  54         int protocol;
  55 } SocketAddress;
  56
  57 typedef enum SocketAddressBindIPv6Only {
  58         SOCKET_ADDRESS_DEFAULT,
  59         SOCKET_ADDRESS_BOTH,
  60         SOCKET_ADDRESS_IPV6_ONLY,
  61         _SOCKET_ADDRESS_BIND_IPV6_ONLY_MAX,
  62         _SOCKET_ADDRESS_BIND_IPV6_ONLY_INVALID = -1
  63 } SocketAddressBindIPv6Only;
  64
  65 #define socket_address_family(a) ((a)->sockaddr.sa.sa_family)
  66
  67 int socket_address_parse(SocketAddress *a, const char *s);
  68 int socket_address_parse_and_warn(SocketAddress *a, const char *s);
  69 int socket_address_parse_netlink(SocketAddress *a, const char *s);
  70 int socket_address_print(const SocketAddress *a, char **p);
  71 int socket_address_verify(const SocketAddress *a) _pure_;
  72 int socket_address_unlink(SocketAddress *a);
  73
  74 bool socket_address_can_accept(const SocketAddress *a) _pure_;
  75
  76 int socket_address_listen(
  77                 const SocketAddress *a,
  78                 int flags,
  79                 int backlog,
  80                 SocketAddressBindIPv6Only only,
  81                 const char *bind_to_device,
  82                 bool reuse_port,
  83                 bool free_bind,
  84                 bool transparent,
  85                 mode_t directory_mode,
  86                 mode_t socket_mode,
  87                 const char *label);
  88 int make_socket_fd(int log_level, const char* address, int type, int flags);
  89
  90 bool socket_address_is(const SocketAddress *a, const char *s, int type);
  91 bool socket_address_is_netlink(const SocketAddress *a, const char *s);
  92
  93 bool socket_address_matches_fd(const SocketAddress *a, int fd);
  94
  95 bool socket_address_equal(const SocketAddress *a, const SocketAddress *b) _pure_;
  96
  97 const char* socket_address_get_path(const SocketAddress *a);
  98 #endif // 0
  99
 100 bool socket_ipv6_is_supported(void);
 101
 102 #if 0 /// UNNEEDED by elogind
 103 int sockaddr_port(const struct sockaddr *_sa) _pure_;
 104
 105 Sint sockaddr_pretty(const struct sockaddr *_sa, socklen_t salen, bool translate_ipv6, bool include_port, char **ret);
 106 int getpeername_pretty(int fd, char **ret);
 107 int getsockname_pretty(int fd, char **ret);
 108
 109 int socknameinfo_pretty(union sockaddr_union *sa, socklen_t salen, char **_ret);
 110 int getnameinfo_pretty(int fd, char **ret);
 111
 112 const char* socket_address_bind_ipv6_only_to_string(SocketAddressBindIPv6Only b) _const_;
 113 SocketAddressBindIPv6Only socket_address_bind_ipv6_only_from_string(const char *s) _pure_;
 114
 115 int netlink_family_to_string_alloc(int b, char **s);
 116 int netlink_family_from_string(const char *s) _pure_;
 117
 118 bool sockaddr_equal(const union sockaddr_union *a, const union sockaddr_union *b);
 119 #endif // 0
 120
 121 int fd_inc_sndbuf(int fd, size_t n);
 122 int fd_inc_rcvbuf(int fd, size_t n);
 123 #if 0 /// UNNEEDED by elogind
 124 int ip_tos_to_string_alloc(int i, char **s);
 125 int ip_tos_from_string(const char *s);
 126 #endif // 0
 127
 128 int getpeercred(int fd, struct ucred *ucred);
 129 int getpeersec(int fd, char **ret);
 130
 131 int send_one_fd(int transport_fd, int fd, int flags);
 132 #if 0 /// UNNEEDED by elogind
 133 int receive_one_fd(int transport_fd, int flags);
 134 #endif // 0
 135
 136 #define CMSG_FOREACH(cmsg, mh)                                          \
 137         for ((cmsg) = CMSG_FIRSTHDR(mh); (cmsg); (cmsg) = CMSG_NXTHDR((mh), (cmsg)))