src/network/netdev/netdev.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #pragma once
   3
   4 /***
   5   This file is part of systemd.
   6
   7   Copyright 2013 Tom Gundersen <teg@jklm.no>
   8 ***/
   9
  10 #include "sd-netlink.h"
  11
  12 #include "list.h"
  13 #include "time-util.h"
  14
  15 typedef struct netdev_join_callback netdev_join_callback;
  16 typedef struct Link Link;
  17
  18 struct netdev_join_callback {
  19         sd_netlink_message_handler_t callback;
  20         Link *link;
  21
  22         LIST_FIELDS(netdev_join_callback, callbacks);
  23 };
  24
  25 typedef enum NetDevKind {
  26         NETDEV_KIND_BRIDGE,
  27         NETDEV_KIND_BOND,
  28         NETDEV_KIND_VLAN,
  29         NETDEV_KIND_MACVLAN,
  30         NETDEV_KIND_MACVTAP,
  31         NETDEV_KIND_IPVLAN,
  32         NETDEV_KIND_VXLAN,
  33         NETDEV_KIND_IPIP,
  34         NETDEV_KIND_GRE,
  35         NETDEV_KIND_GRETAP,
  36         NETDEV_KIND_IP6GRE,
  37         NETDEV_KIND_IP6GRETAP,
  38         NETDEV_KIND_SIT,
  39         NETDEV_KIND_VETH,
  40         NETDEV_KIND_VTI,
  41         NETDEV_KIND_VTI6,
  42         NETDEV_KIND_IP6TNL,
  43         NETDEV_KIND_DUMMY,
  44         NETDEV_KIND_TUN,
  45         NETDEV_KIND_TAP,
  46         NETDEV_KIND_VRF,
  47         NETDEV_KIND_VCAN,
  48         NETDEV_KIND_GENEVE,
  49         NETDEV_KIND_VXCAN,
  50         NETDEV_KIND_WIREGUARD,
  51         NETDEV_KIND_NETDEVSIM,
  52         _NETDEV_KIND_MAX,
  53         _NETDEV_KIND_INVALID = -1
  54 } NetDevKind;
  55
  56 typedef enum NetDevState {
  57         NETDEV_STATE_LOADING,
  58         NETDEV_STATE_FAILED,
  59         NETDEV_STATE_CREATING,
  60         NETDEV_STATE_READY,
  61         NETDEV_STATE_LINGER,
  62         _NETDEV_STATE_MAX,
  63         _NETDEV_STATE_INVALID = -1,
  64 } NetDevState;
  65
  66 typedef enum NetDevCreateType {
  67         NETDEV_CREATE_INDEPENDENT,
  68         NETDEV_CREATE_MASTER,
  69         NETDEV_CREATE_STACKED,
  70         _NETDEV_CREATE_MAX,
  71         _NETDEV_CREATE_INVALID = -1,
  72 } NetDevCreateType;
  73
  74 typedef struct Manager Manager;
  75 typedef struct Condition Condition;
  76
  77 typedef struct NetDev {
  78         Manager *manager;
  79
  80         int n_ref;
  81
  82         char *filename;
  83
  84         Condition *match_host;
  85         Condition *match_virt;
  86         Condition *match_kernel_cmdline;
  87         Condition *match_kernel_version;
  88         Condition *match_arch;
  89
  90         NetDevState state;
  91         NetDevKind kind;
  92         char *description;
  93         char *ifname;
  94         struct ether_addr *mac;
  95         uint32_t mtu;
  96         int ifindex;
  97
  98         LIST_HEAD(netdev_join_callback, callbacks);
  99 } NetDev;
 100
 101 typedef struct NetDevVTable {
 102         /* How much memory does an object of this unit type need */
 103         size_t object_size;
 104
 105         /* Config file sections this netdev kind understands, separated
 106          * by NUL chars */
 107         const char *sections;
 108
 109         /* This should reset all type-specific variables. This should
 110          * not allocate memory, and is called with zero-initialized
 111          * data. It should hence only initialize variables that need
 112          * to be set != 0. */
 113         void (*init)(NetDev *n);
 114
 115         /* This should free all kind-specific variables. It should be
 116          * idempotent. */
 117         void (*done)(NetDev *n);
 118
 119         /* fill in message to create netdev */
 120         int (*fill_message_create)(NetDev *netdev, Link *link, sd_netlink_message *message);
 121
 122         /* specifies if netdev is independent, or a master device or a stacked device */
 123         NetDevCreateType create_type;
 124
 125         /* create netdev, if not done via rtnl */
 126         int (*create)(NetDev *netdev);
 127
 128         /* perform additional configuration after netdev has been createad */
 129         int (*post_create)(NetDev *netdev, Link *link, sd_netlink_message *message);
 130
 131         /* verify that compulsory configuration options were specified */
 132         int (*config_verify)(NetDev *netdev, const char *filename);
 133 } NetDevVTable;
 134
 135 extern const NetDevVTable * const netdev_vtable[_NETDEV_KIND_MAX];
 136
 137 #define NETDEV_VTABLE(n) ((n)->kind != _NETDEV_KIND_INVALID ? netdev_vtable[(n)->kind] : NULL)
 138
 139 /* For casting a netdev into the various netdev kinds */
 140 #define DEFINE_NETDEV_CAST(UPPERCASE, MixedCase)                            \
 141         static inline MixedCase* UPPERCASE(NetDev *n) {                     \
 142                 if (_unlikely_(!n ||                                        \
 143                                n->kind != NETDEV_KIND_##UPPERCASE) ||       \
 144                                n->state == _NETDEV_STATE_INVALID)           \
 145                         return NULL;                                        \
 146                                                                             \
 147                 return (MixedCase*) n;                                      \
 148         }
 149
 150 /* For casting the various netdev kinds into a netdev */
 151 #define NETDEV(n) (&(n)->meta)
 152
 153 int netdev_load(Manager *manager);
 154 void netdev_drop(NetDev *netdev);
 155
 156 NetDev *netdev_unref(NetDev *netdev);
 157 NetDev *netdev_ref(NetDev *netdev);
 158
 159 DEFINE_TRIVIAL_CLEANUP_FUNC(NetDev*, netdev_unref);
 160
 161 int netdev_get(Manager *manager, const char *name, NetDev **ret);
 162 int netdev_set_ifindex(NetDev *netdev, sd_netlink_message *newlink);
 163 int netdev_enslave(NetDev *netdev, Link *link, sd_netlink_message_handler_t callback);
 164 int netdev_get_mac(const char *ifname, struct ether_addr **ret);
 165 int netdev_join(NetDev *netdev, Link *link, sd_netlink_message_handler_t cb);
 166
 167 const char *netdev_kind_to_string(NetDevKind d) _const_;
 168 NetDevKind netdev_kind_from_string(const char *d) _pure_;
 169
 170 int config_parse_netdev_kind(const char *unit, const char *filename, unsigned line, const char *section, unsigned section_line, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
 171
 172 /* gperf */
 173 const struct ConfigPerfItem* network_netdev_gperf_lookup(const char *key, GPERF_LEN_TYPE length);
 174
 175 /* Macros which append INTERFACE= to the message */
 176
 177 #define log_netdev_full(netdev, level, error, ...)                      \
 178         ({                                                              \
 179                 const NetDev *_n = (netdev);                            \
 180                 _n ? log_object_internal(level, error, __FILE__, __LINE__, __func__, "INTERFACE=", _n->ifname, NULL, NULL, ##__VA_ARGS__) : \
 181                         log_internal(level, error, __FILE__, __LINE__, __func__, ##__VA_ARGS__); \
 182         })
 183
 184 #define log_netdev_debug(netdev, ...)       log_netdev_full(netdev, LOG_DEBUG, 0, ##__VA_ARGS__)
 185 #define log_netdev_info(netdev, ...)        log_netdev_full(netdev, LOG_INFO, 0, ##__VA_ARGS__)
 186 #define log_netdev_notice(netdev, ...)      log_netdev_full(netdev, LOG_NOTICE, 0, ##__VA_ARGS__)
 187 #define log_netdev_warning(netdev, ...)     log_netdev_full(netdev, LOG_WARNING, 0, ## __VA_ARGS__)
 188 #define log_netdev_error(netdev, ...)       log_netdev_full(netdev, LOG_ERR, 0, ##__VA_ARGS__)
 189
 190 #define log_netdev_debug_errno(netdev, error, ...)   log_netdev_full(netdev, LOG_DEBUG, error, ##__VA_ARGS__)
 191 #define log_netdev_info_errno(netdev, error, ...)    log_netdev_full(netdev, LOG_INFO, error, ##__VA_ARGS__)
 192 #define log_netdev_notice_errno(netdev, error, ...)  log_netdev_full(netdev, LOG_NOTICE, error, ##__VA_ARGS__)
 193 #define log_netdev_warning_errno(netdev, error, ...) log_netdev_full(netdev, LOG_WARNING, error, ##__VA_ARGS__)
 194 #define log_netdev_error_errno(netdev, error, ...)   log_netdev_full(netdev, LOG_ERR, error, ##__VA_ARGS__)
 195
 196 #define LOG_NETDEV_MESSAGE(netdev, fmt, ...) "MESSAGE=%s: " fmt, (netdev)->ifname, ##__VA_ARGS__
 197 #define LOG_NETDEV_INTERFACE(netdev) "INTERFACE=%s", (netdev)->ifname