src/network/netdev/netdev.h

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