src/network/networkd-netdev.h

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