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 <https://www.gnu.org/licenses/>.
  18 ***/
  19
  20 #include <linux/rtnetlink.h> /* IWYU pragma: export */
  21
  22 #include "_sd-common.h"
  23
  24 _SD_BEGIN_DECLARATIONS;
  25
  26 struct ether_addr;
  27 struct in_addr;
  28 struct in6_addr;
  29 struct sockaddr_in;
  30 struct sockaddr_in6;
  31 struct sock_filter;
  32 struct ifa_cacheinfo;
  33
  34 typedef struct sd_event sd_event;
  35
  36 typedef struct sd_netlink sd_netlink;
  37 typedef struct sd_netlink_message sd_netlink_message;
  38 typedef struct sd_netlink_slot sd_netlink_slot;
  39
  40 /* callback */
  41 typedef int (*sd_netlink_message_handler_t)(sd_netlink *nl, sd_netlink_message *m, void *userdata);
  42 typedef _sd_destroy_t sd_netlink_destroy_t;
  43
  44 /* bus */
  45 int sd_netlink_open(sd_netlink **ret);
  46 int sd_netlink_open_fd(sd_netlink **ret, int fd);
  47 int sd_netlink_increase_rxbuf(sd_netlink *nl, const size_t size);
  48
  49 sd_netlink* sd_netlink_ref(sd_netlink *nl);
  50 sd_netlink* sd_netlink_unref(sd_netlink *nl);
  51
  52 int sd_netlink_send(sd_netlink *nl, sd_netlink_message *message, uint32_t *ret_serial);
  53 int sd_netlink_call_async(sd_netlink *nl, sd_netlink_slot **ret_slot, sd_netlink_message *message,
  54                           sd_netlink_message_handler_t callback, sd_netlink_destroy_t destroy_callback,
  55                           void *userdata, uint64_t usec, const char *description);
  56 int sd_netlink_call(sd_netlink *nl, sd_netlink_message *message, uint64_t timeout, sd_netlink_message **ret);
  57 int sd_netlink_read(sd_netlink *nl, uint32_t serial, uint64_t timeout, sd_netlink_message **ret);
  58
  59 int sd_netlink_get_events(sd_netlink *nl);
  60 int sd_netlink_get_timeout(sd_netlink *nl, uint64_t *ret);
  61 int sd_netlink_process(sd_netlink *nl, sd_netlink_message **ret);
  62 int sd_netlink_wait(sd_netlink *nl, uint64_t timeout);
  63
  64 int sd_netlink_add_match(sd_netlink *nl, sd_netlink_slot **ret_slot, uint16_t match,
  65                          sd_netlink_message_handler_t callback,
  66                          sd_netlink_destroy_t destroy_callback,
  67                          void *userdata, const char *description);
  68
  69 int sd_netlink_attach_event(sd_netlink *nl, sd_event *e, int64_t priority);
  70 int sd_netlink_detach_event(sd_netlink *nl);
  71 sd_event* sd_netlink_get_event(sd_netlink *nl);
  72 int sd_netlink_attach_filter(sd_netlink *nl, size_t len, const struct sock_filter *filter);
  73
  74 /* Message construction */
  75 int sd_netlink_message_append_string(sd_netlink_message *m, uint16_t attr_type, const char *data);
  76 int sd_netlink_message_append_strv(sd_netlink_message *m, uint16_t attr_type, const char* const *data);
  77 int sd_netlink_message_append_flag(sd_netlink_message *m, uint16_t attr_type);
  78 int sd_netlink_message_append_u8(sd_netlink_message *m, uint16_t attr_type, uint8_t data);
  79 int sd_netlink_message_append_u16(sd_netlink_message *m, uint16_t attr_type, uint16_t data);
  80 int sd_netlink_message_append_u32(sd_netlink_message *m, uint16_t attr_type, uint32_t data);
  81 int sd_netlink_message_append_u64(sd_netlink_message *m, uint16_t attr_type, uint64_t data);
  82 int sd_netlink_message_append_s8(sd_netlink_message *m, uint16_t attr_type, int8_t data);
  83 int sd_netlink_message_append_s16(sd_netlink_message *m, uint16_t attr_type, int16_t data);
  84 int sd_netlink_message_append_s32(sd_netlink_message *m, uint16_t attr_type, int32_t data);
  85 int sd_netlink_message_append_s64(sd_netlink_message *m, uint16_t attr_type, int64_t data);
  86 int sd_netlink_message_append_data(sd_netlink_message *m, uint16_t attr_type, const void *data, size_t len);
  87 int sd_netlink_message_append_container_data(
  88                 sd_netlink_message *m,
  89                 uint16_t container_type,
  90                 uint16_t attr_type,
  91                 const void *data,
  92                 size_t len);
  93 int sd_netlink_message_append_in_addr(sd_netlink_message *m, uint16_t attr_type, const struct in_addr *data);
  94 int sd_netlink_message_append_in6_addr(sd_netlink_message *m, uint16_t attr_type, const struct in6_addr *data);
  95 int sd_netlink_message_append_sockaddr_in(sd_netlink_message *m, uint16_t attr_type, const struct sockaddr_in *data);
  96 int sd_netlink_message_append_sockaddr_in6(sd_netlink_message *m, uint16_t attr_type, const struct sockaddr_in6 *data);
  97 int sd_netlink_message_append_ether_addr(sd_netlink_message *m, uint16_t attr_type, const struct ether_addr *data);
  98 int sd_netlink_message_append_cache_info(sd_netlink_message *m, uint16_t attr_type, const struct ifa_cacheinfo *info);
  99
 100 int sd_netlink_message_open_container(sd_netlink_message *m, uint16_t attr_type);
 101 int sd_netlink_message_open_container_union(sd_netlink_message *m, uint16_t attr_type, const char *key);
 102 int sd_netlink_message_close_container(sd_netlink_message *m);
 103
 104 int sd_netlink_message_open_array(sd_netlink_message *m, uint16_t type);
 105 int sd_netlink_message_cancel_array(sd_netlink_message *m);
 106
 107 /* Reading messages */
 108 int sd_netlink_message_read(sd_netlink_message *m, uint16_t attr_type, size_t size, void *ret);
 109 int sd_netlink_message_read_data(sd_netlink_message *m, uint16_t attr_type, size_t *ret_size, void **ret_data);
 110 int sd_netlink_message_read_string_strdup(sd_netlink_message *m, uint16_t attr_type, char **ret);
 111 int sd_netlink_message_read_string(sd_netlink_message *m, uint16_t attr_type, const char **ret);
 112 int sd_netlink_message_read_strv(sd_netlink_message *m, uint16_t container_type, uint16_t attr_type, char ***ret);
 113 int sd_netlink_message_read_u8(sd_netlink_message *m, uint16_t attr_type, uint8_t *ret);
 114 int sd_netlink_message_read_u16(sd_netlink_message *m, uint16_t attr_type, uint16_t *ret);
 115 int sd_netlink_message_read_u32(sd_netlink_message *m, uint16_t attr_type, uint32_t *ret);
 116 int sd_netlink_message_read_u64(sd_netlink_message *m, uint16_t attr_type, uint64_t *ret);
 117 int sd_netlink_message_read_ether_addr(sd_netlink_message *m, uint16_t attr_type, struct ether_addr *ret);
 118 int sd_netlink_message_read_cache_info(sd_netlink_message *m, uint16_t attr_type, struct ifa_cacheinfo *ret);
 119 int sd_netlink_message_read_in_addr(sd_netlink_message *m, uint16_t attr_type, struct in_addr *ret);
 120 int sd_netlink_message_read_in6_addr(sd_netlink_message *m, uint16_t attr_type, struct in6_addr *ret);
 121 int sd_netlink_message_has_flag(sd_netlink_message *m, uint16_t attr_type);
 122 int sd_netlink_message_enter_container(sd_netlink_message *m, uint16_t attr_type);
 123 int sd_netlink_message_enter_array(sd_netlink_message *m, uint16_t attr_type);
 124 int sd_netlink_message_exit_container(sd_netlink_message *m);
 125
 126 int sd_netlink_message_rewind(sd_netlink_message *m, sd_netlink *nl);
 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_set_request_dump(sd_netlink_message *m, int dump);
 134 int sd_netlink_message_is_error(sd_netlink_message *m);
 135 int sd_netlink_message_get_errno(sd_netlink_message *m);
 136 int sd_netlink_message_get_type(sd_netlink_message *m, uint16_t *ret);
 137 int sd_netlink_message_set_flags(sd_netlink_message *m, uint16_t flags);
 138 int sd_netlink_message_is_broadcast(sd_netlink_message *m);
 139 int sd_netlink_message_get_max_attribute(sd_netlink_message *m, uint16_t *ret);
 140
 141 /* rtnl */
 142 int sd_rtnl_message_get_family(sd_netlink_message *m, int *ret);
 143
 144 int sd_rtnl_message_new_addr(sd_netlink *nl, sd_netlink_message **ret, uint16_t msg_type, int ifindex, int family);
 145 int sd_rtnl_message_new_addr_update(sd_netlink *nl, sd_netlink_message **ret, int ifindex, int family);
 146 /* struct ifaddrmsg */
 147 int sd_rtnl_message_addr_get_ifindex(sd_netlink_message *m, int *ret); /* ifa_index */
 148 int sd_rtnl_message_addr_get_family(sd_netlink_message *m, int *ret); /* ifa_family */
 149 int sd_rtnl_message_addr_set_prefixlen(sd_netlink_message *m, uint8_t prefixlen); /* ifa_prefixlen */
 150 int sd_rtnl_message_addr_get_prefixlen(sd_netlink_message *m, uint8_t *ret);
 151 int sd_rtnl_message_addr_set_scope(sd_netlink_message *m, uint8_t scope); /* ifa_scope */
 152 int sd_rtnl_message_addr_get_scope(sd_netlink_message *m, uint8_t *ret);
 153
 154 int sd_rtnl_message_new_link(sd_netlink *nl, sd_netlink_message **ret, uint16_t msg_type, int ifindex);
 155 /* struct ifinfomsg */
 156 int sd_rtnl_message_link_get_ifindex(sd_netlink_message *m, int *ret); /* ifi_index */
 157 int sd_rtnl_message_link_set_family(sd_netlink_message *m, int family); /* ifi_family */
 158 int sd_rtnl_message_link_get_family(sd_netlink_message *m, int *ret);
 159 int sd_rtnl_message_link_set_type(sd_netlink_message *m, uint16_t type); /* ifi_type */
 160 int sd_rtnl_message_link_get_type(sd_netlink_message *m, uint16_t *ret);
 161 int sd_rtnl_message_link_set_flags(sd_netlink_message *m, uint32_t flags, uint32_t change); /* ifi_flags and ifi_change */
 162 int sd_rtnl_message_link_get_flags(sd_netlink_message *m, uint32_t *ret); /* ifi_flags */
 163
 164 int sd_rtnl_message_new_route(sd_netlink *nl, sd_netlink_message **ret, uint16_t nlmsg_type, int family, uint8_t protocol);
 165 /* struct rtmsg */
 166 int sd_rtnl_message_route_get_family(sd_netlink_message *m, int *ret); /* rtm_family */
 167 int sd_rtnl_message_route_set_dst_prefixlen(sd_netlink_message *m, uint8_t prefixlen); /* rtm_dst_len */
 168 int sd_rtnl_message_route_get_dst_prefixlen(sd_netlink_message *m, uint8_t *ret);
 169 int sd_rtnl_message_route_set_src_prefixlen(sd_netlink_message *m, uint8_t prefixlen); /* rtm_src_len */
 170 int sd_rtnl_message_route_get_src_prefixlen(sd_netlink_message *m, uint8_t *ret);
 171 int sd_rtnl_message_route_set_tos(sd_netlink_message *m, uint8_t tos); /* rtm_tos */
 172 int sd_rtnl_message_route_get_tos(sd_netlink_message *m, uint8_t *ret);
 173 int sd_rtnl_message_route_set_table(sd_netlink_message *m, uint8_t table); /* rtm_table */
 174 int sd_rtnl_message_route_get_table(sd_netlink_message *m, uint8_t *ret);
 175 int sd_rtnl_message_route_get_protocol(sd_netlink_message *m, uint8_t *ret); /* rtm_protocol */
 176 int sd_rtnl_message_route_set_scope(sd_netlink_message *m, uint8_t scope); /* rtm_scope */
 177 int sd_rtnl_message_route_get_scope(sd_netlink_message *m, uint8_t *ret);
 178 int sd_rtnl_message_route_set_type(sd_netlink_message *m, uint8_t type); /* rtm_type */
 179 int sd_rtnl_message_route_get_type(sd_netlink_message *m, uint8_t *ret);
 180 int sd_rtnl_message_route_set_flags(sd_netlink_message *m, uint32_t flags); /* rtm_flags */
 181 int sd_rtnl_message_route_get_flags(sd_netlink_message *m, uint32_t *ret);
 182
 183 int sd_rtnl_message_new_nexthop(sd_netlink *rtnl, sd_netlink_message **ret, uint16_t nlmsg_type, int family, uint8_t protocol);
 184 /* struct nhmsg */
 185 int sd_rtnl_message_nexthop_get_family(sd_netlink_message *m, int *ret); /* nh_family */
 186 int sd_rtnl_message_nexthop_set_flags(sd_netlink_message *m, uint32_t flags); /* nh_flags, RTNH_F flags */
 187 int sd_rtnl_message_nexthop_get_flags(sd_netlink_message *m, uint32_t *ret);
 188 int sd_rtnl_message_nexthop_get_protocol(sd_netlink_message *m, uint8_t *ret); /* nh_protocol */
 189
 190 int sd_rtnl_message_new_neigh(sd_netlink *nl, sd_netlink_message **ret, uint16_t nlmsg_type, int ifindex, int family);
 191 /* struct ndmsg */
 192 int sd_rtnl_message_neigh_get_ifindex(sd_netlink_message *m, int *ret); /* ndm_ifindex */
 193 int sd_rtnl_message_neigh_get_family(sd_netlink_message *m, int *ret); /* ndm_family */
 194 int sd_rtnl_message_neigh_set_state(sd_netlink_message *m, uint16_t state); /* ndm_state */
 195 int sd_rtnl_message_neigh_get_state(sd_netlink_message *m, uint16_t *ret);
 196 int sd_rtnl_message_neigh_set_flags(sd_netlink_message *m, uint8_t flags); /* ndm_flags */
 197 int sd_rtnl_message_neigh_get_flags(sd_netlink_message *m, uint8_t *ret);
 198
 199 int sd_rtnl_message_new_addrlabel(sd_netlink *rtnl, sd_netlink_message **ret, uint16_t nlmsg_type, int ifindex, int family);
 200 /* struct ifaddrlblmsg */
 201 int sd_rtnl_message_addrlabel_set_prefixlen(sd_netlink_message *m, uint8_t prefixlen); /* ifal_prefixlen */
 202 int sd_rtnl_message_addrlabel_get_prefixlen(sd_netlink_message *m, uint8_t *ret);
 203
 204 int sd_rtnl_message_new_routing_policy_rule(sd_netlink *rtnl, sd_netlink_message **ret, uint16_t nlmsg_type, int family);
 205 /* struct fib_rule_hdr */
 206 int sd_rtnl_message_routing_policy_rule_get_family(sd_netlink_message *m, int *ret); /* family */
 207 int sd_rtnl_message_routing_policy_rule_set_dst_prefixlen(sd_netlink_message *m, uint8_t prefixlen); /* dst_len */
 208 int sd_rtnl_message_routing_policy_rule_get_dst_prefixlen(sd_netlink_message *m, uint8_t *ret);
 209 int sd_rtnl_message_routing_policy_rule_set_src_prefixlen(sd_netlink_message *m, uint8_t prefixlen); /* src_len */
 210 int sd_rtnl_message_routing_policy_rule_get_src_prefixlen(sd_netlink_message *m, uint8_t *ret);
 211 int sd_rtnl_message_routing_policy_rule_set_tos(sd_netlink_message *m, uint8_t tos); /* tos */
 212 int sd_rtnl_message_routing_policy_rule_get_tos(sd_netlink_message *m, uint8_t *ret);
 213 int sd_rtnl_message_routing_policy_rule_set_table(sd_netlink_message *m, uint8_t table); /* table */
 214 int sd_rtnl_message_routing_policy_rule_get_table(sd_netlink_message *m, uint8_t *ret);
 215 int sd_rtnl_message_routing_policy_rule_set_action(sd_netlink_message *m, uint8_t action); /* action */
 216 int sd_rtnl_message_routing_policy_rule_get_action(sd_netlink_message *m, uint8_t *ret);
 217 int sd_rtnl_message_routing_policy_rule_set_flags(sd_netlink_message *m, uint32_t flags); /* flags */
 218 int sd_rtnl_message_routing_policy_rule_get_flags(sd_netlink_message *m, uint32_t *ret);
 219
 220 int sd_rtnl_message_new_traffic_control(sd_netlink *rtnl, sd_netlink_message **ret, uint16_t nlmsg_type,
 221                                         int ifindex, uint32_t handle, uint32_t parent);
 222 /* struct tcmsg */
 223 int sd_rtnl_message_traffic_control_get_ifindex(sd_netlink_message *m, int *ret); /* tcm_ifindex */
 224 int sd_rtnl_message_traffic_control_get_handle(sd_netlink_message *m, uint32_t *ret); /* tcm_handle */
 225 int sd_rtnl_message_traffic_control_get_parent(sd_netlink_message *m, uint32_t *ret); /* tcm_parent */
 226
 227 int sd_rtnl_message_new_mdb(sd_netlink *rtnl, sd_netlink_message **ret, uint16_t nlmsg_type, int ifindex);
 228
 229 int sd_rtnl_message_new_nsid(sd_netlink *rtnl, sd_netlink_message **ret, uint16_t nlmsg_type);
 230
 231 /* genl */
 232 int sd_genl_socket_open(sd_netlink **ret);
 233 int sd_genl_message_new(sd_netlink *genl, const char *family_name, uint8_t cmd, sd_netlink_message **ret);
 234 int sd_genl_message_get_family_name(sd_netlink *genl, sd_netlink_message *m, const char **ret);
 235 int sd_genl_message_get_command(sd_netlink *genl, sd_netlink_message *m, uint8_t *ret);
 236 int sd_genl_add_match(sd_netlink *nl, sd_netlink_slot **ret_slot, const char *family_name,
 237                       const char *multicast_group_name, uint8_t command,
 238                       sd_netlink_message_handler_t callback,
 239                       sd_netlink_destroy_t destroy_callback,
 240                       void *userdata, const char *description);
 241
 242 /* slot */
 243 sd_netlink_slot *sd_netlink_slot_ref(sd_netlink_slot *slot);
 244 sd_netlink_slot *sd_netlink_slot_unref(sd_netlink_slot *slot);
 245
 246 sd_netlink* sd_netlink_slot_get_netlink(sd_netlink_slot *slot);
 247 void* sd_netlink_slot_get_userdata(sd_netlink_slot *slot);
 248 void* sd_netlink_slot_set_userdata(sd_netlink_slot *slot, void *userdata);
 249 int sd_netlink_slot_get_destroy_callback(sd_netlink_slot *slot, sd_netlink_destroy_t *ret);
 250 int sd_netlink_slot_set_destroy_callback(sd_netlink_slot *slot, sd_netlink_destroy_t callback);
 251 int sd_netlink_slot_get_floating(sd_netlink_slot *slot);
 252 int sd_netlink_slot_set_floating(sd_netlink_slot *slot, int b);
 253 int sd_netlink_slot_get_description(sd_netlink_slot *slot, const char **ret);
 254 int sd_netlink_slot_set_description(sd_netlink_slot *slot, const char *description);
 255
 256 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_netlink, sd_netlink_unref);
 257 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_netlink_message, sd_netlink_message_unref);
 258 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_netlink_slot, sd_netlink_slot_unref);
 259
 260 _SD_END_DECLARATIONS;
 261
 262 #endif