src/libsystemd/sd-netlink/netlink-util.h

   1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
   2 #pragma once
   3
   4 #include <linux/rtnetlink.h>
   5
   6 #include "forward.h"
   7 #include "in-addr-util.h"
   8
   9 #define RTA_FLAGS(rta) ((rta)->rta_type & ~NLA_TYPE_MASK)
  10 #define RTA_TYPE(rta)  ((rta)->rta_type & NLA_TYPE_MASK)
  11
  12 /* See struct rtvia in rtnetlink.h */
  13 typedef struct RouteVia {
  14         uint16_t family;
  15         union in_addr_union address;
  16 } _packed_ RouteVia;
  17
  18 int rtnl_get_link_info_full(
  19                 sd_netlink **rtnl,
  20                 int ifindex,
  21                 char **ret_name,
  22                 char ***ret_altnames,
  23                 unsigned short *ret_iftype,
  24                 unsigned *ret_flags,
  25                 char **ret_kind,
  26                 struct hw_addr_data *ret_hw_addr,
  27                 struct hw_addr_data *ret_permanent_hw_addr);
  28
  29 static inline int rtnl_get_ifname_full(sd_netlink **rtnl, int ifindex, char **ret_name, char ***ret_altnames) {
  30         return rtnl_get_link_info_full(
  31                         rtnl,
  32                         ifindex,
  33                         ret_name,
  34                         ret_altnames,
  35                         /* ret_iftype = */ NULL,
  36                         /* ret_flags = */ NULL,
  37                         /* ret_kind = */ NULL,
  38                         /* ret_hw_addr = */ NULL,
  39                         /* ret_permanent_hw_addr = */ NULL);
  40 }
  41 static inline int rtnl_get_ifname(sd_netlink **rtnl, int ifindex, char **ret) {
  42         return rtnl_get_ifname_full(rtnl, ifindex, ret, NULL);
  43 }
  44 static inline int rtnl_get_link_alternative_names(sd_netlink **rtnl, int ifindex, char ***ret) {
  45         return rtnl_get_ifname_full(rtnl, ifindex, NULL, ret);
  46 }
  47 static inline int rtnl_get_link_info(
  48                 sd_netlink **rtnl,
  49                 int ifindex,
  50                 unsigned short *ret_iftype,
  51                 unsigned *ret_flags,
  52                 char **ret_kind,
  53                 struct hw_addr_data *ret_hw_addr,
  54                 struct hw_addr_data *ret_permanent_hw_addr) {
  55
  56         return rtnl_get_link_info_full(
  57                         rtnl,
  58                         ifindex,
  59                         /* ret_name = */ NULL,
  60                         /* ret_altnames = */ NULL,
  61                         ret_iftype,
  62                         ret_flags,
  63                         ret_kind,
  64                         ret_hw_addr,
  65                         ret_permanent_hw_addr);
  66 }
  67 static inline int rtnl_get_link_hw_addr(sd_netlink **rtnl, int ifindex, struct hw_addr_data *ret) {
  68         return rtnl_get_link_info(
  69                         rtnl,
  70                         ifindex,
  71                         /* ret_iftype = */ NULL,
  72                         /* ret_flags = */ NULL,
  73                         /* ret_kind = */ NULL,
  74                         ret,
  75                         /* ret_permanent_hw_addr = */ NULL);
  76 }
  77
  78 typedef enum ResolveInterfaceNameFlag {
  79         RESOLVE_IFNAME_MAIN        = 1 << 0, /* resolve main interface name */
  80         RESOLVE_IFNAME_ALTERNATIVE = 1 << 1, /* resolve alternative name */
  81         RESOLVE_IFNAME_NUMERIC     = 1 << 2, /* resolve decimal formatted ifindex */
  82         _RESOLVE_IFNAME_ALL        = RESOLVE_IFNAME_MAIN | RESOLVE_IFNAME_ALTERNATIVE | RESOLVE_IFNAME_NUMERIC,
  83 } ResolveInterfaceNameFlag;
  84
  85 int rtnl_resolve_ifname_full(
  86                   sd_netlink **rtnl,
  87                   ResolveInterfaceNameFlag flags,
  88                   const char *name,
  89                   char **ret_name,
  90                   char ***ret_altnames);
  91 static inline int rtnl_resolve_link_alternative_name(sd_netlink **rtnl, const char *name, char **ret) {
  92         return rtnl_resolve_ifname_full(rtnl, RESOLVE_IFNAME_ALTERNATIVE, name, ret, NULL);
  93 }
  94 static inline int rtnl_resolve_ifname(sd_netlink **rtnl, const char *name) {
  95         return rtnl_resolve_ifname_full(rtnl, RESOLVE_IFNAME_MAIN | RESOLVE_IFNAME_ALTERNATIVE, name, NULL, NULL);
  96 }
  97 static inline int rtnl_resolve_interface(sd_netlink **rtnl, const char *name) {
  98         return rtnl_resolve_ifname_full(rtnl, _RESOLVE_IFNAME_ALL, name, NULL, NULL);
  99 }
 100 int rtnl_resolve_interface_or_warn(sd_netlink **rtnl, const char *name);
 101
 102 int rtnl_set_link_alternative_names(sd_netlink **rtnl, int ifindex, char* const *alternative_names);
 103 int rtnl_set_link_alternative_names_by_ifname(sd_netlink **rtnl, const char *ifname, char* const *alternative_names);
 104 int rtnl_delete_link_alternative_names(sd_netlink **rtnl, int ifindex, char* const *alternative_names);
 105 int rtnl_rename_link(sd_netlink **rtnl, const char *orig_name, const char *new_name);
 106 int rtnl_set_link_name(sd_netlink **rtnl, int ifindex, const char *name, char* const* alternative_names);
 107 static inline int rtnl_append_link_alternative_names(sd_netlink **rtnl, int ifindex, char* const *alternative_names) {
 108         return rtnl_set_link_name(rtnl, ifindex, NULL, alternative_names);
 109 }
 110
 111 int rtnl_set_link_properties(
 112                 sd_netlink **rtnl,
 113                 int ifindex,
 114                 const char *alias,
 115                 const struct hw_addr_data *hw_addr,
 116                 uint32_t txqueues,
 117                 uint32_t rxqueues,
 118                 uint32_t txqueuelen,
 119                 uint32_t mtu,
 120                 uint32_t gso_max_size,
 121                 size_t gso_max_segments);
 122
 123 int rtnl_log_parse_error(int r);
 124 int rtnl_log_create_error(int r);
 125
 126 #define netlink_call_async(nl, ret_slot, message, callback, destroy_callback, userdata) \
 127         ({                                                              \
 128                 int (*_callback_)(sd_netlink *, sd_netlink_message *, typeof(userdata)) = callback; \
 129                 void (*_destroy_)(typeof(userdata)) = destroy_callback; \
 130                 sd_netlink_call_async(nl, ret_slot, message,            \
 131                                       (sd_netlink_message_handler_t) _callback_, \
 132                                       (sd_netlink_destroy_t) _destroy_, \
 133                                       userdata, 0, __func__);           \
 134         })
 135
 136 #define netlink_add_match(nl, ret_slot, match, callback, destroy_callback, userdata, description) \
 137         ({                                                              \
 138                 int (*_callback_)(sd_netlink *, sd_netlink_message *, typeof(userdata)) = callback; \
 139                 void (*_destroy_)(typeof(userdata)) = destroy_callback; \
 140                 sd_netlink_add_match(nl, ret_slot, match,               \
 141                                      (sd_netlink_message_handler_t) _callback_, \
 142                                      (sd_netlink_destroy_t) _destroy_,  \
 143                                      userdata, description);            \
 144         })
 145
 146 #define genl_add_match(nl, ret_slot, family, group, cmd, callback, destroy_callback, userdata, description) \
 147         ({                                                              \
 148                 int (*_callback_)(sd_netlink *, sd_netlink_message *, typeof(userdata)) = callback; \
 149                 void (*_destroy_)(typeof(userdata)) = destroy_callback; \
 150                 sd_genl_add_match(nl, ret_slot, family, group, cmd,     \
 151                                   (sd_netlink_message_handler_t) _callback_, \
 152                                   (sd_netlink_destroy_t) _destroy_,     \
 153                                   userdata, description);               \
 154         })
 155
 156 int netlink_message_append_hw_addr(sd_netlink_message *m, unsigned short type, const struct hw_addr_data *data);
 157 int netlink_message_append_in_addr_union(sd_netlink_message *m, unsigned short type, int family, const union in_addr_union *data);
 158 int netlink_message_append_sockaddr_union(sd_netlink_message *m, unsigned short type, const union sockaddr_union *data);
 159
 160 int netlink_message_read_hw_addr(sd_netlink_message *m, unsigned short type, struct hw_addr_data *data);
 161 int netlink_message_read_in_addr_union(sd_netlink_message *m, unsigned short type, int family, union in_addr_union *data);
 162
 163 void rtattr_append_attribute_internal(struct rtattr *rta, unsigned short type, const void *data, size_t data_length);
 164 int rtattr_append_attribute(struct rtattr **rta, unsigned short type, const void *data, size_t data_length);
 165
 166 void netlink_seal_message(sd_netlink *nl, sd_netlink_message *m);
 167
 168 size_t netlink_get_reply_callback_count(sd_netlink *nl);
 169
 170 /* TODO: to be exported later */
 171 int sd_netlink_sendv(sd_netlink *nl, sd_netlink_message **messages, size_t msgcnt, uint32_t **ret_serial);