src/network/netdev/netdev.h

   1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
   2 #pragma once
   3
   4 #include "sd-netlink.h"
   5
   6 #include "conf-parser.h"
   7 #include "list.h"
   8 #include "networkd-link.h"
   9 #include "time-util.h"
  10
  11 #define NETDEV_COMMON_SECTIONS "Match\0NetDev\0"
  12 /* This is the list of known sections. We need to ignore them in the initial parsing phase. */
  13 #define NETDEV_OTHER_SECTIONS                     \
  14         "-BareUDP\0"                              \
  15         "-Bond\0"                                 \
  16         "-Bridge\0"                               \
  17         "-FooOverUDP\0"                           \
  18         "-GENEVE\0"                               \
  19         "-IPVLAN\0"                               \
  20         "-IPVTAP\0"                               \
  21         "-L2TP\0"                                 \
  22         "-L2TPSession\0"                          \
  23         "-MACsec\0"                               \
  24         "-MACsecReceiveChannel\0"                 \
  25         "-MACsecTransmitAssociation\0"            \
  26         "-MACsecReceiveAssociation\0"             \
  27         "-MACVTAP\0"                              \
  28         "-MACVLAN\0"                              \
  29         "-Tunnel\0"                               \
  30         "-Tun\0"                                  \
  31         "-Tap\0"                                  \
  32         "-Peer\0"                                 \
  33         "-VLAN\0"                                 \
  34         "-VRF\0"                                  \
  35         "-VXCAN\0"                                \
  36         "-VXLAN\0"                                \
  37         "-WireGuard\0"                            \
  38         "-WireGuardPeer\0"                        \
  39         "-Xfrm\0"
  40
  41 typedef struct netdev_join_callback netdev_join_callback;
  42
  43 struct netdev_join_callback {
  44         link_netlink_message_handler_t callback;
  45         Link *link;
  46
  47         LIST_FIELDS(netdev_join_callback, callbacks);
  48 };
  49
  50 typedef enum NetDevKind {
  51         NETDEV_KIND_BRIDGE,
  52         NETDEV_KIND_BOND,
  53         NETDEV_KIND_VLAN,
  54         NETDEV_KIND_MACVLAN,
  55         NETDEV_KIND_MACVTAP,
  56         NETDEV_KIND_IPVLAN,
  57         NETDEV_KIND_IPVTAP,
  58         NETDEV_KIND_VXLAN,
  59         NETDEV_KIND_IPIP,
  60         NETDEV_KIND_GRE,
  61         NETDEV_KIND_GRETAP,
  62         NETDEV_KIND_IP6GRE,
  63         NETDEV_KIND_IP6GRETAP,
  64         NETDEV_KIND_SIT,
  65         NETDEV_KIND_VETH,
  66         NETDEV_KIND_VTI,
  67         NETDEV_KIND_VTI6,
  68         NETDEV_KIND_IP6TNL,
  69         NETDEV_KIND_DUMMY,
  70         NETDEV_KIND_TUN,
  71         NETDEV_KIND_TAP,
  72         NETDEV_KIND_VRF,
  73         NETDEV_KIND_VCAN,
  74         NETDEV_KIND_GENEVE,
  75         NETDEV_KIND_VXCAN,
  76         NETDEV_KIND_WIREGUARD,
  77         NETDEV_KIND_NETDEVSIM,
  78         NETDEV_KIND_FOU,
  79         NETDEV_KIND_ERSPAN,
  80         NETDEV_KIND_L2TP,
  81         NETDEV_KIND_MACSEC,
  82         NETDEV_KIND_NLMON,
  83         NETDEV_KIND_XFRM,
  84         NETDEV_KIND_IFB,
  85         NETDEV_KIND_BAREUDP,
  86         _NETDEV_KIND_MAX,
  87         _NETDEV_KIND_TUNNEL, /* Used by config_parse_stacked_netdev() */
  88         _NETDEV_KIND_INVALID = -1
  89 } NetDevKind;
  90
  91 typedef enum NetDevState {
  92         NETDEV_STATE_LOADING,
  93         NETDEV_STATE_FAILED,
  94         NETDEV_STATE_CREATING,
  95         NETDEV_STATE_READY,
  96         NETDEV_STATE_LINGER,
  97         _NETDEV_STATE_MAX,
  98         _NETDEV_STATE_INVALID = -1,
  99 } NetDevState;
 100
 101 typedef enum NetDevCreateType {
 102         NETDEV_CREATE_INDEPENDENT,
 103         NETDEV_CREATE_MASTER,
 104         NETDEV_CREATE_STACKED,
 105         NETDEV_CREATE_AFTER_CONFIGURED,
 106         _NETDEV_CREATE_MAX,
 107         _NETDEV_CREATE_INVALID = -1,
 108 } NetDevCreateType;
 109
 110 typedef struct Manager Manager;
 111 typedef struct Condition Condition;
 112
 113 typedef struct NetDev {
 114         Manager *manager;
 115
 116         unsigned n_ref;
 117
 118         char *filename;
 119
 120         LIST_HEAD(Condition, conditions);
 121
 122         NetDevState state;
 123         NetDevKind kind;
 124         char *description;
 125         char *ifname;
 126         struct ether_addr *mac;
 127         uint32_t mtu;
 128         int ifindex;
 129
 130         LIST_HEAD(netdev_join_callback, callbacks);
 131 } NetDev;
 132
 133 typedef struct NetDevVTable {
 134         /* How much memory does an object of this unit type need */
 135         size_t object_size;
 136
 137         /* Config file sections this netdev kind understands, separated
 138          * by NUL chars */
 139         const char *sections;
 140
 141         /* This should reset all type-specific variables. This should
 142          * not allocate memory, and is called with zero-initialized
 143          * data. It should hence only initialize variables that need
 144          * to be set != 0. */
 145         void (*init)(NetDev *n);
 146
 147         /* This should free all kind-specific variables. It should be
 148          * idempotent. */
 149         void (*done)(NetDev *n);
 150
 151         /* fill in message to create netdev */
 152         int (*fill_message_create)(NetDev *netdev, Link *link, sd_netlink_message *message);
 153
 154         /* specifies if netdev is independent, or a master device or a stacked device */
 155         NetDevCreateType create_type;
 156
 157         /* create netdev, if not done via rtnl */
 158         int (*create)(NetDev *netdev);
 159
 160         /* create netdev after link is fully configured */
 161         int (*create_after_configured)(NetDev *netdev, Link *link);
 162
 163         /* perform additional configuration after netdev has been createad */
 164         int (*post_create)(NetDev *netdev, Link *link, sd_netlink_message *message);
 165
 166         /* verify that compulsory configuration options were specified */
 167         int (*config_verify)(NetDev *netdev, const char *filename);
 168
 169         /* Generate MAC address or not When MACAddress= is not specified. */
 170         bool generate_mac;
 171 } NetDevVTable;
 172
 173 extern const NetDevVTable * const netdev_vtable[_NETDEV_KIND_MAX];
 174
 175 #define NETDEV_VTABLE(n) ((n)->kind != _NETDEV_KIND_INVALID ? netdev_vtable[(n)->kind] : NULL)
 176
 177 /* For casting a netdev into the various netdev kinds */
 178 #define DEFINE_NETDEV_CAST(UPPERCASE, MixedCase)                            \
 179         static inline MixedCase* UPPERCASE(NetDev *n) {                     \
 180                 if (_unlikely_(!n ||                                        \
 181                                n->kind != NETDEV_KIND_##UPPERCASE) ||       \
 182                                n->state == _NETDEV_STATE_INVALID)           \
 183                         return NULL;                                        \
 184                                                                             \
 185                 return (MixedCase*) n;                                      \
 186         }
 187
 188 /* For casting the various netdev kinds into a netdev */
 189 #define NETDEV(n) (&(n)->meta)
 190
 191 int netdev_load(Manager *manager, bool reload);
 192 int netdev_load_one(Manager *manager, const char *filename);
 193 void netdev_drop(NetDev *netdev);
 194
 195 NetDev *netdev_unref(NetDev *netdev);
 196 NetDev *netdev_ref(NetDev *netdev);
 197 DEFINE_TRIVIAL_DESTRUCTOR(netdev_destroy_callback, NetDev, netdev_unref);
 198 DEFINE_TRIVIAL_CLEANUP_FUNC(NetDev*, netdev_unref);
 199
 200 bool netdev_is_managed(NetDev *netdev);
 201 int netdev_get(Manager *manager, const char *name, NetDev **ret);
 202 int netdev_set_ifindex(NetDev *netdev, sd_netlink_message *newlink);
 203 int netdev_get_mac(const char *ifname, struct ether_addr **ret);
 204 int netdev_join(NetDev *netdev, Link *link, link_netlink_message_handler_t cb);
 205 int netdev_join_after_configured(NetDev *netdev, Link *link, link_netlink_message_handler_t callback);
 206
 207 const char *netdev_kind_to_string(NetDevKind d) _const_;
 208 NetDevKind netdev_kind_from_string(const char *d) _pure_;
 209
 210 static inline NetDevCreateType netdev_get_create_type(NetDev *netdev) {
 211         assert(netdev);
 212         assert(NETDEV_VTABLE(netdev));
 213
 214         return NETDEV_VTABLE(netdev)->create_type;
 215 }
 216
 217 CONFIG_PARSER_PROTOTYPE(config_parse_netdev_kind);
 218
 219 /* gperf */
 220 const struct ConfigPerfItem* network_netdev_gperf_lookup(const char *key, GPERF_LEN_TYPE length);
 221
 222 /* Macros which append INTERFACE= to the message */
 223
 224 #define log_netdev_full(netdev, level, error, ...)                      \
 225         ({                                                              \
 226                 const NetDev *_n = (netdev);                            \
 227                 _n ? log_object_internal(level, error, PROJECT_FILE, __LINE__, __func__, "INTERFACE=", _n->ifname, NULL, NULL, ##__VA_ARGS__) : \
 228                         log_internal(level, error, PROJECT_FILE, __LINE__, __func__, ##__VA_ARGS__); \
 229         })
 230
 231 #define log_netdev_debug(netdev, ...)       log_netdev_full(netdev, LOG_DEBUG, 0, ##__VA_ARGS__)
 232 #define log_netdev_info(netdev, ...)        log_netdev_full(netdev, LOG_INFO, 0, ##__VA_ARGS__)
 233 #define log_netdev_notice(netdev, ...)      log_netdev_full(netdev, LOG_NOTICE, 0, ##__VA_ARGS__)
 234 #define log_netdev_warning(netdev, ...)     log_netdev_full(netdev, LOG_WARNING, 0, ## __VA_ARGS__)
 235 #define log_netdev_error(netdev, ...)       log_netdev_full(netdev, LOG_ERR, 0, ##__VA_ARGS__)
 236
 237 #define log_netdev_debug_errno(netdev, error, ...)   log_netdev_full(netdev, LOG_DEBUG, error, ##__VA_ARGS__)
 238 #define log_netdev_info_errno(netdev, error, ...)    log_netdev_full(netdev, LOG_INFO, error, ##__VA_ARGS__)
 239 #define log_netdev_notice_errno(netdev, error, ...)  log_netdev_full(netdev, LOG_NOTICE, error, ##__VA_ARGS__)
 240 #define log_netdev_warning_errno(netdev, error, ...) log_netdev_full(netdev, LOG_WARNING, error, ##__VA_ARGS__)
 241 #define log_netdev_error_errno(netdev, error, ...)   log_netdev_full(netdev, LOG_ERR, error, ##__VA_ARGS__)
 242
 243 #define LOG_NETDEV_MESSAGE(netdev, fmt, ...) "MESSAGE=%s: " fmt, (netdev)->ifname, ##__VA_ARGS__
 244 #define LOG_NETDEV_INTERFACE(netdev) "INTERFACE=%s", (netdev)->ifname