src/systemd/sd-netlink.h

   1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
   2 #ifndef foosdnetlinkhfoo
   3 #define foosdnetlinkhfoo
   4
   5 /***
   6   systemd is free software; you can redistribute it and/or modify it
   7   under the terms of the GNU Lesser General Public License as published by
   8   the Free Software Foundation; either version 2.1 of the License, or
   9   (at your option) any later version.
  10
  11   systemd is distributed in the hope that it will be useful, but
  12   WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  14   Lesser General Public License for more details.
  15
  16   You should have received a copy of the GNU Lesser General Public License
  17   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  18 ***/
  19
  20 #include <inttypes.h>
  21 #include <net/ethernet.h>
  22 #include <netinet/in.h>
  23 #include <linux/neighbour.h>
  24 #include <linux/rtnetlink.h>
  25
  26 #include "sd-event.h"
  27
  28 #include "_sd-common.h"
  29
  30 _SD_BEGIN_DECLARATIONS;
  31
  32 typedef struct sd_netlink sd_netlink;
  33 typedef struct sd_genl_socket sd_genl_socket;
  34 typedef struct sd_netlink_message sd_netlink_message;
  35 typedef struct sd_netlink_slot sd_netlink_slot;
  36
  37 typedef enum sd_gen_family {
  38         SD_GENL_ERROR,
  39         SD_GENL_DONE,
  40         SD_GENL_ID_CTRL,
  41         SD_GENL_WIREGUARD,
  42         SD_GENL_FOU,
  43         SD_GENL_L2TP,
  44         SD_GENL_MACSEC,
  45         SD_GENL_NL80211,
  46 } sd_genl_family;
  47
  48 /* callback */
  49
  50 typedef int (*sd_netlink_message_handler_t)(sd_netlink *nl, sd_netlink_message *m, void *userdata);
  51 typedef _sd_destroy_t sd_netlink_destroy_t;
  52
  53 /* bus */
  54 int sd_netlink_new_from_netlink(sd_netlink **nl, int fd);
  55 int sd_netlink_open(sd_netlink **nl);
  56 int sd_netlink_open_fd(sd_netlink **nl, int fd);
  57 int sd_netlink_inc_rcvbuf(sd_netlink *nl, const size_t size);
  58
  59 sd_netlink *sd_netlink_ref(sd_netlink *nl);
  60 sd_netlink *sd_netlink_unref(sd_netlink *nl);
  61
  62 int sd_netlink_send(sd_netlink *nl, sd_netlink_message *message, uint32_t *serial);
  63 int sd_netlink_sendv(sd_netlink *nl, sd_netlink_message **messages, size_t msgcnt, uint32_t **ret_serial);
  64 int sd_netlink_call_async(sd_netlink *nl, sd_netlink_slot **ret_slot, sd_netlink_message *message,
  65                           sd_netlink_message_handler_t callback, sd_netlink_destroy_t destoy_callback,
  66                           void *userdata, uint64_t usec, const char *description);
  67 int sd_netlink_call(sd_netlink *nl, sd_netlink_message *message, uint64_t timeout,
  68                     sd_netlink_message **reply);
  69 int sd_netlink_read(sd_netlink *nl, uint32_t serial, uint64_t timeout, sd_netlink_message **reply);
  70
  71 int sd_netlink_get_events(const sd_netlink *nl);
  72 int sd_netlink_get_timeout(const sd_netlink *nl, uint64_t *timeout);
  73 int sd_netlink_process(sd_netlink *nl, sd_netlink_message **ret);
  74 int sd_netlink_wait(sd_netlink *nl, uint64_t timeout);
  75
  76 int sd_netlink_add_match(sd_netlink *nl, sd_netlink_slot **ret_slot, uint16_t match,
  77                          sd_netlink_message_handler_t callback,
  78                          sd_netlink_destroy_t destroy_callback,
  79                          void *userdata, const char *description);
  80
  81 int sd_netlink_attach_event(sd_netlink *nl, sd_event *e, int64_t priority);
  82 int sd_netlink_detach_event(sd_netlink *nl);
  83
  84 int sd_netlink_message_append_string(sd_netlink_message *m, unsigned short type, const char *data);
  85 int sd_netlink_message_append_strv(sd_netlink_message *m, unsigned short type, char * const *data);
  86 int sd_netlink_message_append_flag(sd_netlink_message *m, unsigned short type);
  87 int sd_netlink_message_append_u8(sd_netlink_message *m, unsigned short type, uint8_t data);
  88 int sd_netlink_message_append_u16(sd_netlink_message *m, unsigned short type, uint16_t data);
  89 int sd_netlink_message_append_u32(sd_netlink_message *m, unsigned short type, uint32_t data);
  90 int sd_netlink_message_append_u64(sd_netlink_message *m, unsigned short type, uint64_t data);
  91 int sd_netlink_message_append_s8(sd_netlink_message *m, unsigned short type, int8_t data);
  92 int sd_netlink_message_append_s16(sd_netlink_message *m, unsigned short type, int16_t data);
  93 int sd_netlink_message_append_s32(sd_netlink_message *m, unsigned short type, int32_t data);
  94 int sd_netlink_message_append_s64(sd_netlink_message *m, unsigned short type, int64_t data);
  95 int sd_netlink_message_append_data(sd_netlink_message *m, unsigned short type, const void *data, size_t len);
  96 int sd_netlink_message_append_in_addr(sd_netlink_message *m, unsigned short type, const struct in_addr *data);
  97 int sd_netlink_message_append_in6_addr(sd_netlink_message *m, unsigned short type, const struct in6_addr *data);
  98 int sd_netlink_message_append_sockaddr_in(sd_netlink_message *m, unsigned short type, const struct sockaddr_in *data);
  99 int sd_netlink_message_append_sockaddr_in6(sd_netlink_message *m, unsigned short type, const struct sockaddr_in6 *data);
 100 int sd_netlink_message_append_ether_addr(sd_netlink_message *m, unsigned short type, const struct ether_addr *data);
 101 int sd_netlink_message_append_cache_info(sd_netlink_message *m, unsigned short type, const struct ifa_cacheinfo *info);
 102
 103 int sd_netlink_message_open_container(sd_netlink_message *m, unsigned short type);
 104 int sd_netlink_message_open_container_union(sd_netlink_message *m, unsigned short type, const char *key);
 105 int sd_netlink_message_close_container(sd_netlink_message *m);
 106
 107 int sd_netlink_message_read(sd_netlink_message *m, unsigned short type, size_t size, void *data);
 108 int sd_netlink_message_read_data(sd_netlink_message *m, unsigned short type, size_t *ret_size, void **ret_data);
 109 int sd_netlink_message_read_string_strdup(sd_netlink_message *m, unsigned short type, char **data);
 110 int sd_netlink_message_read_string(sd_netlink_message *m, unsigned short type, const char **data);
 111 int sd_netlink_message_read_strv(sd_netlink_message *m, unsigned short container_type, unsigned short type_id, char ***ret);
 112 int sd_netlink_message_read_u8(sd_netlink_message *m, unsigned short type, uint8_t *data);
 113 int sd_netlink_message_read_u16(sd_netlink_message *m, unsigned short type, uint16_t *data);
 114 int sd_netlink_message_read_u32(sd_netlink_message *m, unsigned short type, uint32_t *data);
 115 int sd_netlink_message_read_ether_addr(sd_netlink_message *m, unsigned short type, struct ether_addr *data);
 116 int sd_netlink_message_read_cache_info(sd_netlink_message *m, unsigned short type, struct ifa_cacheinfo *info);
 117 int sd_netlink_message_read_in_addr(sd_netlink_message *m, unsigned short type, struct in_addr *data);
 118 int sd_netlink_message_read_in6_addr(sd_netlink_message *m, unsigned short type, struct in6_addr *data);
 119 int sd_netlink_message_enter_container(sd_netlink_message *m, unsigned short type);
 120 int sd_netlink_message_enter_array(sd_netlink_message *m, unsigned short type);
 121 int sd_netlink_message_exit_container(sd_netlink_message *m);
 122
 123 int sd_netlink_message_open_array(sd_netlink_message *m, uint16_t type);
 124 int sd_netlink_message_cancel_array(sd_netlink_message *m);
 125
 126 int sd_netlink_message_rewind(sd_netlink_message *m, sd_netlink *genl);
 127
 128 sd_netlink_message *sd_netlink_message_next(sd_netlink_message *m);
 129
 130 sd_netlink_message *sd_netlink_message_ref(sd_netlink_message *m);
 131 sd_netlink_message *sd_netlink_message_unref(sd_netlink_message *m);
 132
 133 int sd_netlink_message_request_dump(sd_netlink_message *m, int dump);
 134 int sd_netlink_message_is_error(const sd_netlink_message *m);
 135 int sd_netlink_message_get_errno(const sd_netlink_message *m);
 136 int sd_netlink_message_get_type(const sd_netlink_message *m, uint16_t *type);
 137 int sd_netlink_message_set_flags(sd_netlink_message *m, uint16_t flags);
 138 int sd_netlink_message_is_broadcast(const sd_netlink_message *m);
 139
 140 /* rtnl */
 141
 142 int sd_rtnl_message_new_link(sd_netlink *nl, sd_netlink_message **ret, uint16_t msg_type, int index);
 143 int sd_rtnl_message_new_addr_update(sd_netlink *nl, sd_netlink_message **ret, int index, int family);
 144 int sd_rtnl_message_new_addr(sd_netlink *nl, sd_netlink_message **ret, uint16_t msg_type, int index, int family);
 145 int sd_rtnl_message_new_route(sd_netlink *nl, sd_netlink_message **ret, uint16_t nlmsg_type, int rtm_family, unsigned char rtm_protocol);
 146 int sd_rtnl_message_new_neigh(sd_netlink *nl, sd_netlink_message **ret, uint16_t msg_type, int index, int nda_family);
 147
 148 int sd_rtnl_message_get_family(const sd_netlink_message *m, int *family);
 149
 150 int sd_rtnl_message_addr_set_prefixlen(sd_netlink_message *m, unsigned char prefixlen);
 151 int sd_rtnl_message_addr_set_scope(sd_netlink_message *m, unsigned char scope);
 152 int sd_rtnl_message_addr_set_flags(sd_netlink_message *m, unsigned char flags);
 153 int sd_rtnl_message_addr_get_family(const sd_netlink_message *m, int *family);
 154 int sd_rtnl_message_addr_get_prefixlen(const sd_netlink_message *m, unsigned char *prefixlen);
 155 int sd_rtnl_message_addr_get_scope(const sd_netlink_message *m, unsigned char *scope);
 156 int sd_rtnl_message_addr_get_flags(const sd_netlink_message *m, unsigned char *flags);
 157 int sd_rtnl_message_addr_get_ifindex(const sd_netlink_message *m, int *ifindex);
 158
 159 int sd_rtnl_message_link_set_flags(sd_netlink_message *m, unsigned flags, unsigned change);
 160 int sd_rtnl_message_link_set_type(sd_netlink_message *m, unsigned type);
 161 int sd_rtnl_message_link_set_family(sd_netlink_message *m, unsigned family);
 162 int sd_rtnl_message_link_get_ifindex(const sd_netlink_message *m, int *ifindex);
 163 int sd_rtnl_message_link_get_flags(const sd_netlink_message *m, unsigned *flags);
 164 int sd_rtnl_message_link_get_type(const sd_netlink_message *m, unsigned short *type);
 165
 166 int sd_rtnl_message_route_set_dst_prefixlen(sd_netlink_message *m, unsigned char prefixlen);
 167 int sd_rtnl_message_route_set_src_prefixlen(sd_netlink_message *m, unsigned char prefixlen);
 168 int sd_rtnl_message_route_set_scope(sd_netlink_message *m, unsigned char scope);
 169 int sd_rtnl_message_route_set_flags(sd_netlink_message *m, unsigned flags);
 170 int sd_rtnl_message_route_set_table(sd_netlink_message *m, unsigned char table);
 171 int sd_rtnl_message_route_set_type(sd_netlink_message *m, unsigned char type);
 172 int sd_rtnl_message_route_get_flags(const sd_netlink_message *m, unsigned *flags);
 173 int sd_rtnl_message_route_get_family(const sd_netlink_message *m, int *family);
 174 int sd_rtnl_message_route_set_family(sd_netlink_message *m, int family);
 175 int sd_rtnl_message_route_get_protocol(const sd_netlink_message *m, unsigned char *protocol);
 176 int sd_rtnl_message_route_get_scope(const sd_netlink_message *m, unsigned char *scope);
 177 int sd_rtnl_message_route_get_tos(const sd_netlink_message *m, unsigned char *tos);
 178 int sd_rtnl_message_route_get_table(const sd_netlink_message *m, unsigned char *table);
 179 int sd_rtnl_message_route_get_dst_prefixlen(const sd_netlink_message *m, unsigned char *dst_len);
 180 int sd_rtnl_message_route_get_src_prefixlen(const sd_netlink_message *m, unsigned char *src_len);
 181 int sd_rtnl_message_route_get_type(const sd_netlink_message *m, unsigned char *type);
 182
 183 int sd_rtnl_message_new_nexthop(sd_netlink *rtnl, sd_netlink_message **ret, uint16_t nhmsg_type, int nh_family, unsigned char nh_protocol);
 184
 185 int sd_rtnl_message_nexthop_set_flags(sd_netlink_message *m, uint8_t flags);
 186 int sd_rtnl_message_nexthop_set_family(sd_netlink_message *m, uint8_t family);
 187 int sd_rtnl_message_nexthop_get_family(const sd_netlink_message *m, uint8_t *family);
 188
 189 int sd_rtnl_message_neigh_set_flags(sd_netlink_message *m, uint8_t flags);
 190 int sd_rtnl_message_neigh_set_state(sd_netlink_message *m, uint16_t state);
 191 int sd_rtnl_message_neigh_get_family(const sd_netlink_message *m, int *family);
 192 int sd_rtnl_message_neigh_get_ifindex(const sd_netlink_message *m, int *family);
 193 int sd_rtnl_message_neigh_get_state(const sd_netlink_message *m, uint16_t *state);
 194 int sd_rtnl_message_neigh_get_flags(const sd_netlink_message *m, uint8_t *flags);
 195
 196 int sd_rtnl_message_new_addrlabel(sd_netlink *rtnl, sd_netlink_message **ret, uint16_t nlmsg_type, int ifindex, int ifal_family);
 197 int sd_rtnl_message_addrlabel_set_prefixlen(sd_netlink_message *m, unsigned char prefixlen);
 198 int sd_rtnl_message_addrlabel_get_prefixlen(const sd_netlink_message *m, unsigned char *prefixlen);
 199
 200 int sd_rtnl_message_new_routing_policy_rule(sd_netlink *rtnl, sd_netlink_message **ret, uint16_t nlmsg_type, int ifal_family);
 201 int sd_rtnl_message_routing_policy_rule_set_tos(sd_netlink_message *m, uint8_t tos);
 202 int sd_rtnl_message_routing_policy_rule_get_tos(const sd_netlink_message *m, uint8_t *tos);
 203 int sd_rtnl_message_routing_policy_rule_set_table(sd_netlink_message *m, uint8_t table);
 204 int sd_rtnl_message_routing_policy_rule_get_table(const sd_netlink_message *m, uint8_t *table);
 205 int sd_rtnl_message_routing_policy_rule_set_fib_src_prefixlen(sd_netlink_message *m, uint8_t len);
 206 int sd_rtnl_message_routing_policy_rule_get_fib_src_prefixlen(const sd_netlink_message *m, uint8_t *len);
 207 int sd_rtnl_message_routing_policy_rule_set_fib_dst_prefixlen(sd_netlink_message *m, uint8_t len);
 208 int sd_rtnl_message_routing_policy_rule_get_fib_dst_prefixlen(const sd_netlink_message *m, uint8_t *len);
 209 int sd_rtnl_message_routing_policy_rule_set_fib_type(sd_netlink_message *m, uint8_t type);
 210 int sd_rtnl_message_routing_policy_rule_get_fib_type(const sd_netlink_message *m, uint8_t *type);
 211 int sd_rtnl_message_routing_policy_rule_set_flags(sd_netlink_message *m, uint32_t flags);
 212 int sd_rtnl_message_routing_policy_rule_get_flags(const sd_netlink_message *m, uint32_t *flags);
 213
 214 int sd_rtnl_message_new_qdisc(sd_netlink *rtnl, sd_netlink_message **ret, uint16_t nlmsg_type, int tcm_family, int tcm_ifindex);
 215 int sd_rtnl_message_set_qdisc_parent(sd_netlink_message *m, uint32_t parent);
 216 int sd_rtnl_message_set_qdisc_handle(sd_netlink_message *m, uint32_t handle);
 217
 218 int sd_rtnl_message_new_tclass(sd_netlink *rtnl, sd_netlink_message **ret, uint16_t nlmsg_type, int tcm_family, int tcm_ifindex);
 219 int sd_rtnl_message_set_tclass_parent(sd_netlink_message *m, uint32_t parent);
 220 int sd_rtnl_message_set_tclass_handle(sd_netlink_message *m, uint32_t handle);
 221
 222 int sd_rtnl_message_new_mdb(sd_netlink *rtnl, sd_netlink_message **ret, uint16_t nlmsg_type, int mdb_ifindex);
 223
 224 /* nfnl */
 225 int sd_nfnl_socket_open(sd_netlink **nl);
 226 int sd_nfnl_message_batch_begin(sd_netlink *nfnl, sd_netlink_message **ret);
 227 int sd_nfnl_message_batch_end(sd_netlink *nfnl, sd_netlink_message **ret);
 228 int sd_nfnl_nft_message_del_table(sd_netlink *nfnl, sd_netlink_message **ret,
 229                                   int family, const char *table);
 230 int sd_nfnl_nft_message_new_table(sd_netlink *nfnl, sd_netlink_message **ret,
 231                                   int family, const char *table, uint16_t nl_flags);
 232 int sd_nfnl_nft_message_new_basechain(sd_netlink *nfnl, sd_netlink_message **ret,
 233                                       int family, const char *table, const char *chain,
 234                                       const char *type, uint8_t hook, int prio);
 235 int sd_nfnl_nft_message_new_rule(sd_netlink *nfnl, sd_netlink_message **ret,
 236                                  int family, const char *table, const char *chain);
 237 int sd_nfnl_nft_message_new_set(sd_netlink *nfnl, sd_netlink_message **ret,
 238                                 int family, const char *table, const char *set_name,
 239                                 uint32_t setid, uint32_t klen);
 240 int sd_nfnl_nft_message_new_setelems_begin(sd_netlink *nfnl, sd_netlink_message **ret,
 241                                            int family, const char *table, const char *set_name);
 242 int sd_nfnl_nft_message_del_setelems_begin(sd_netlink *nfnl, sd_netlink_message **ret,
 243                                            int family, const char *table, const char *set_name);
 244 int sd_nfnl_nft_message_add_setelem(sd_netlink_message *m,
 245                                     uint32_t num,
 246                                     const void *key, uint32_t klen,
 247                                     const void *data, uint32_t dlen);
 248 int sd_nfnl_nft_message_add_setelem_end(sd_netlink_message *m);
 249
 250 /* genl */
 251 int sd_genl_socket_open(sd_netlink **nl);
 252 int sd_genl_message_new(sd_netlink *nl, sd_genl_family family, uint8_t cmd, sd_netlink_message **m);
 253 int sd_genl_message_get_family(const sd_netlink *nl, const sd_netlink_message *m, sd_genl_family *family);
 254
 255 /* slot */
 256 sd_netlink_slot *sd_netlink_slot_ref(sd_netlink_slot *nl);
 257 sd_netlink_slot *sd_netlink_slot_unref(sd_netlink_slot *nl);
 258
 259 sd_netlink *sd_netlink_slot_get_netlink(sd_netlink_slot *slot);
 260 void *sd_netlink_slot_get_userdata(sd_netlink_slot *slot);
 261 void *sd_netlink_slot_set_userdata(sd_netlink_slot *slot, void *userdata);
 262 int sd_netlink_slot_get_destroy_callback(const sd_netlink_slot *slot, sd_netlink_destroy_t *callback);
 263 int sd_netlink_slot_set_destroy_callback(sd_netlink_slot *slot, sd_netlink_destroy_t callback);
 264 int sd_netlink_slot_get_floating(const sd_netlink_slot *slot);
 265 int sd_netlink_slot_set_floating(sd_netlink_slot *slot, int b);
 266 int sd_netlink_slot_get_description(const sd_netlink_slot *slot, const char **description);
 267 int sd_netlink_slot_set_description(sd_netlink_slot *slot, const char *description);
 268
 269 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_netlink, sd_netlink_unref);
 270 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_netlink_message, sd_netlink_message_unref);
 271 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_netlink_slot, sd_netlink_slot_unref);
 272
 273 _SD_END_DECLARATIONS;
 274
 275 #endif