device.h

   1 /*
   2  * netifd - network interface daemon
   3  * Copyright (C) 2012 Felix Fietkau <nbd@openwrt.org>
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License version 2
   7  * as published by the Free Software Foundation
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  */
  14 #ifndef __NETIFD_DEVICE_H
  15 #define __NETIFD_DEVICE_H
  16
  17 #include <libubox/avl.h>
  18 #include <libubox/safe_list.h>
  19 #include <netinet/in.h>
  20
  21 struct device;
  22 struct device_user;
  23 struct device_hotplug_ops;
  24 struct interface;
  25
  26 typedef int (*device_state_cb)(struct device *, bool up);
  27
  28 enum {
  29         DEV_ATTR_TYPE,
  30         DEV_ATTR_MTU,
  31         DEV_ATTR_MTU6,
  32         DEV_ATTR_MACADDR,
  33         DEV_ATTR_TXQUEUELEN,
  34         DEV_ATTR_ENABLED,
  35         DEV_ATTR_IPV6,
  36         DEV_ATTR_PROMISC,
  37         DEV_ATTR_RPFILTER,
  38         DEV_ATTR_ACCEPTLOCAL,
  39         DEV_ATTR_IGMPVERSION,
  40         DEV_ATTR_MLDVERSION,
  41         DEV_ATTR_NEIGHREACHABLETIME,
  42         DEV_ATTR_RPS,
  43         DEV_ATTR_XPS,
  44         DEV_ATTR_DADTRANSMITS,
  45         DEV_ATTR_MULTICAST_TO_UNICAST,
  46         DEV_ATTR_MULTICAST_ROUTER,
  47         DEV_ATTR_MULTICAST,
  48         DEV_ATTR_LEARNING,
  49         DEV_ATTR_UNICAST_FLOOD,
  50         __DEV_ATTR_MAX,
  51 };
  52
  53 enum dev_change_type {
  54         DEV_CONFIG_NO_CHANGE,
  55         DEV_CONFIG_APPLIED,
  56         DEV_CONFIG_RESTART,
  57         DEV_CONFIG_RECREATE,
  58 };
  59
  60 struct device_type {
  61         struct list_head list;
  62         const char *name;
  63
  64         const struct uci_blob_param_list *config_params;
  65
  66         struct device *(*create)(const char *name, struct blob_attr *attr);
  67         void (*config_init)(struct device *);
  68         enum dev_change_type (*reload)(struct device *, struct blob_attr *);
  69         void (*dump_info)(struct device *, struct blob_buf *buf);
  70         void (*dump_stats)(struct device *, struct blob_buf *buf);
  71         int (*check_state)(struct device *);
  72         void (*free)(struct device *);
  73 };
  74
  75 enum {
  76         DEV_OPT_MTU                     = (1 << 0),
  77         DEV_OPT_MACADDR                 = (1 << 1),
  78         DEV_OPT_TXQUEUELEN              = (1 << 2),
  79         DEV_OPT_IPV6                    = (1 << 3),
  80         DEV_OPT_PROMISC                 = (1 << 4),
  81         DEV_OPT_RPFILTER                = (1 << 5),
  82         DEV_OPT_ACCEPTLOCAL             = (1 << 6),
  83         DEV_OPT_IGMPVERSION             = (1 << 7),
  84         DEV_OPT_MLDVERSION              = (1 << 8),
  85         DEV_OPT_NEIGHREACHABLETIME      = (1 << 9),
  86         DEV_OPT_RPS                     = (1 << 10),
  87         DEV_OPT_XPS                     = (1 << 11),
  88         DEV_OPT_MTU6                    = (1 << 12),
  89         DEV_OPT_DADTRANSMITS            = (1 << 13),
  90         DEV_OPT_MULTICAST_TO_UNICAST    = (1 << 14),
  91         DEV_OPT_MULTICAST_ROUTER        = (1 << 15),
  92         DEV_OPT_MULTICAST               = (1 << 16),
  93         DEV_OPT_LEARNING                = (1 << 17),
  94         DEV_OPT_UNICAST_FLOOD           = (1 << 18),
  95 };
  96
  97 /* events broadcasted to all users of a device */
  98 enum device_event {
  99         DEV_EVENT_ADD,
 100         DEV_EVENT_REMOVE,
 101
 102         DEV_EVENT_UPDATE_IFNAME,
 103         DEV_EVENT_UPDATE_IFINDEX,
 104
 105         DEV_EVENT_SETUP,
 106         DEV_EVENT_TEARDOWN,
 107         DEV_EVENT_UP,
 108         DEV_EVENT_DOWN,
 109
 110         DEV_EVENT_LINK_UP,
 111         DEV_EVENT_LINK_DOWN,
 112
 113         /* Topology changed (i.e. bridge member added) */
 114         DEV_EVENT_TOPO_CHANGE,
 115
 116         __DEV_EVENT_MAX
 117 };
 118
 119 /*
 120  * device dependency with callbacks
 121  */
 122 struct device_user {
 123         struct safe_list list;
 124
 125         bool claimed;
 126         bool hotplug;
 127         bool alias;
 128
 129         uint8_t ev_idx[__DEV_EVENT_MAX];
 130
 131         struct device *dev;
 132         void (*cb)(struct device_user *, enum device_event);
 133 };
 134
 135 struct device_settings {
 136         unsigned int flags;
 137         unsigned int valid_flags;
 138         unsigned int mtu;
 139         unsigned int mtu6;
 140         unsigned int txqueuelen;
 141         uint8_t macaddr[6];
 142         bool ipv6;
 143         bool promisc;
 144         unsigned int rpfilter;
 145         bool acceptlocal;
 146         unsigned int igmpversion;
 147         unsigned int mldversion;
 148         unsigned int neigh4reachabletime;
 149         unsigned int neigh6reachabletime;
 150         bool rps;
 151         bool xps;
 152         unsigned int dadtransmits;
 153         bool multicast_to_unicast;
 154         unsigned int multicast_router;
 155         bool multicast;
 156         bool learning;
 157         bool unicast_flood;
 158 };
 159
 160 /*
 161  * link layer device. typically represents a linux network device.
 162  * can be used to support VLANs as well
 163  */
 164 struct device {
 165         const struct device_type *type;
 166
 167         struct avl_node avl;
 168         struct safe_list users;
 169         struct safe_list aliases;
 170
 171         char ifname[IFNAMSIZ + 1];
 172         int ifindex;
 173
 174         struct blob_attr *config;
 175         bool config_pending;
 176         bool sys_present;
 177         /* DEV_EVENT_ADD */
 178         bool present;
 179         /* DEV_EVENT_UP */
 180         int active;
 181         /* DEV_EVENT_LINK_UP */
 182         bool link_active;
 183
 184         bool external;
 185         bool disabled;
 186         bool deferred;
 187         bool hidden;
 188
 189         bool current_config;
 190         bool iface_config;
 191         bool default_config;
 192         bool wireless;
 193         bool wireless_ap;
 194         bool wireless_isolate;
 195
 196         struct interface *config_iface;
 197
 198         /* set interface up or down */
 199         device_state_cb set_state;
 200
 201         const struct device_hotplug_ops *hotplug_ops;
 202
 203         struct device_user parent;
 204
 205         struct device_settings orig_settings;
 206         struct device_settings settings;
 207 };
 208
 209 struct device_hotplug_ops {
 210         int (*prepare)(struct device *dev);
 211         int (*add)(struct device *main, struct device *member);
 212         int (*del)(struct device *main, struct device *member);
 213 };
 214
 215 extern const struct uci_blob_param_list device_attr_list;
 216 extern const struct device_type simple_device_type;
 217 extern const struct device_type bridge_device_type;
 218 extern const struct device_type tunnel_device_type;
 219 extern const struct device_type macvlan_device_type;
 220 extern const struct device_type vlandev_device_type;
 221
 222 void device_lock(void);
 223 void device_unlock(void);
 224
 225 struct device *device_create(const char *name, const struct device_type *type,
 226                              struct blob_attr *config);
 227 void device_init_settings(struct device *dev, struct blob_attr **tb);
 228 void device_init_pending(void);
 229
 230 enum dev_change_type
 231 device_apply_config(struct device *dev, const struct device_type *type,
 232                     struct blob_attr *config);
 233
 234 void device_reset_config(void);
 235 void device_reset_old(void);
 236 void device_set_default_ps(bool state);
 237
 238 void device_init_virtual(struct device *dev, const struct device_type *type, const char *name);
 239 int device_init(struct device *iface, const struct device_type *type, const char *ifname);
 240 void device_cleanup(struct device *iface);
 241 struct device *device_get(const char *name, int create);
 242 void device_add_user(struct device_user *dep, struct device *iface);
 243 void device_remove_user(struct device_user *dep);
 244 void device_broadcast_event(struct device *dev, enum device_event ev);
 245
 246 void device_set_present(struct device *dev, bool state);
 247 void device_set_link(struct device *dev, bool state);
 248 void device_set_ifindex(struct device *dev, int ifindex);
 249 void device_refresh_present(struct device *dev);
 250 int device_claim(struct device_user *dep);
 251 void device_release(struct device_user *dep);
 252 int device_check_state(struct device *dev);
 253 void device_dump_status(struct blob_buf *b, struct device *dev);
 254
 255 void device_free(struct device *dev);
 256 void device_free_unused(struct device *dev);
 257
 258 struct device *get_vlan_device_chain(const char *ifname, bool create);
 259 void alias_notify_device(const char *name, struct device *dev);
 260 struct device *device_alias_get(const char *name);
 261
 262 static inline void
 263 device_set_deferred(struct device *dev, bool value)
 264 {
 265         dev->deferred = value;
 266         device_refresh_present(dev);
 267 }
 268
 269 static inline void
 270 device_set_disabled(struct device *dev, bool value)
 271 {
 272         dev->disabled = value;
 273         device_refresh_present(dev);
 274 }
 275
 276 #endif