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_MAX,
  46 };
  47
  48 enum dev_change_type {
  49         DEV_CONFIG_NO_CHANGE,
  50         DEV_CONFIG_APPLIED,
  51         DEV_CONFIG_RESTART,
  52         DEV_CONFIG_RECREATE,
  53 };
  54
  55 struct device_type {
  56         struct list_head list;
  57         const char *name;
  58
  59         bool keep_link_status;
  60
  61         const struct uci_blob_param_list *config_params;
  62
  63         struct device *(*create)(const char *name, struct blob_attr *attr);
  64         void (*config_init)(struct device *);
  65         enum dev_change_type (*reload)(struct device *, struct blob_attr *);
  66         void (*dump_info)(struct device *, struct blob_buf *buf);
  67         void (*dump_stats)(struct device *, struct blob_buf *buf);
  68         int (*check_state)(struct device *);
  69         void (*free)(struct device *);
  70 };
  71
  72 enum {
  73         DEV_OPT_MTU                     = (1 << 0),
  74         DEV_OPT_MACADDR                 = (1 << 1),
  75         DEV_OPT_TXQUEUELEN              = (1 << 2),
  76         DEV_OPT_IPV6                    = (1 << 3),
  77         DEV_OPT_PROMISC                 = (1 << 4),
  78         DEV_OPT_RPFILTER                = (1 << 5),
  79         DEV_OPT_ACCEPTLOCAL             = (1 << 6),
  80         DEV_OPT_IGMPVERSION             = (1 << 7),
  81         DEV_OPT_MLDVERSION              = (1 << 8),
  82         DEV_OPT_NEIGHREACHABLETIME      = (1 << 9),
  83         DEV_OPT_RPS                     = (1 << 10),
  84         DEV_OPT_XPS                     = (1 << 11),
  85         DEV_OPT_MTU6                    = (1 << 12),
  86         DEV_OPT_DADTRANSMITS            = (1 << 13),
  87 };
  88
  89 /* events broadcasted to all users of a device */
  90 enum device_event {
  91         DEV_EVENT_ADD,
  92         DEV_EVENT_REMOVE,
  93
  94         DEV_EVENT_UPDATE_IFNAME,
  95         DEV_EVENT_UPDATE_IFINDEX,
  96
  97         DEV_EVENT_SETUP,
  98         DEV_EVENT_TEARDOWN,
  99         DEV_EVENT_UP,
 100         DEV_EVENT_DOWN,
 101
 102         DEV_EVENT_LINK_UP,
 103         DEV_EVENT_LINK_DOWN,
 104
 105         /* Topology changed (i.e. bridge member added) */
 106         DEV_EVENT_TOPO_CHANGE,
 107
 108         __DEV_EVENT_MAX
 109 };
 110
 111 /*
 112  * device dependency with callbacks
 113  */
 114 struct device_user {
 115         struct safe_list list;
 116
 117         bool claimed;
 118         bool hotplug;
 119         bool alias;
 120
 121         uint8_t ev_idx[__DEV_EVENT_MAX];
 122
 123         struct device *dev;
 124         void (*cb)(struct device_user *, enum device_event);
 125 };
 126
 127 struct device_settings {
 128         unsigned int flags;
 129         unsigned int mtu;
 130         unsigned int mtu6;
 131         unsigned int txqueuelen;
 132         uint8_t macaddr[6];
 133         bool ipv6;
 134         bool promisc;
 135         unsigned int rpfilter;
 136         bool acceptlocal;
 137         unsigned int igmpversion;
 138         unsigned int mldversion;
 139         unsigned int neigh4reachabletime;
 140         unsigned int neigh6reachabletime;
 141         bool rps;
 142         bool xps;
 143         unsigned int dadtransmits;
 144 };
 145
 146 /*
 147  * link layer device. typically represents a linux network device.
 148  * can be used to support VLANs as well
 149  */
 150 struct device {
 151         const struct device_type *type;
 152
 153         struct avl_node avl;
 154         struct safe_list users;
 155         struct safe_list aliases;
 156
 157         char ifname[IFNAMSIZ + 1];
 158         int ifindex;
 159
 160         struct blob_attr *config;
 161         bool config_pending;
 162         bool sys_present;
 163         /* DEV_EVENT_ADD */
 164         bool present;
 165         /* DEV_EVENT_UP */
 166         int active;
 167         /* DEV_EVENT_LINK_UP */
 168         bool link_active;
 169
 170         bool external;
 171         bool disabled;
 172         bool deferred;
 173         bool hidden;
 174
 175         bool current_config;
 176         bool iface_config;
 177         bool default_config;
 178         bool wireless;
 179         bool wireless_isolate;
 180
 181         struct interface *config_iface;
 182
 183         /* set interface up or down */
 184         device_state_cb set_state;
 185
 186         const struct device_hotplug_ops *hotplug_ops;
 187
 188         struct device_user parent;
 189
 190         struct device_settings orig_settings;
 191         struct device_settings settings;
 192 };
 193
 194 struct device_hotplug_ops {
 195         int (*prepare)(struct device *dev);
 196         int (*add)(struct device *main, struct device *member);
 197         int (*del)(struct device *main, struct device *member);
 198 };
 199
 200 extern const struct uci_blob_param_list device_attr_list;
 201 extern const struct device_type simple_device_type;
 202 extern const struct device_type bridge_device_type;
 203 extern const struct device_type tunnel_device_type;
 204 extern const struct device_type macvlan_device_type;
 205 extern const struct device_type vlandev_device_type;
 206
 207 void device_lock(void);
 208 void device_unlock(void);
 209
 210 struct device *device_create(const char *name, const struct device_type *type,
 211                              struct blob_attr *config);
 212 void device_init_settings(struct device *dev, struct blob_attr **tb);
 213 void device_init_pending(void);
 214
 215 enum dev_change_type
 216 device_apply_config(struct device *dev, const struct device_type *type,
 217                     struct blob_attr *config);
 218
 219 void device_reset_config(void);
 220 void device_reset_old(void);
 221 void device_set_default_ps(bool state);
 222
 223 void device_init_virtual(struct device *dev, const struct device_type *type, const char *name);
 224 int device_init(struct device *iface, const struct device_type *type, const char *ifname);
 225 void device_cleanup(struct device *iface);
 226 struct device *device_get(const char *name, int create);
 227 void device_add_user(struct device_user *dep, struct device *iface);
 228 void device_remove_user(struct device_user *dep);
 229 void device_broadcast_event(struct device *dev, enum device_event ev);
 230
 231 void device_set_present(struct device *dev, bool state);
 232 void device_set_link(struct device *dev, bool state);
 233 void device_set_ifindex(struct device *dev, int ifindex);
 234 void device_refresh_present(struct device *dev);
 235 int device_claim(struct device_user *dep);
 236 void device_release(struct device_user *dep);
 237 int device_check_state(struct device *dev);
 238 void device_dump_status(struct blob_buf *b, struct device *dev);
 239
 240 void device_free(struct device *dev);
 241 void device_free_unused(struct device *dev);
 242
 243 struct device *get_vlan_device_chain(const char *ifname, bool create);
 244 void alias_notify_device(const char *name, struct device *dev);
 245 struct device *device_alias_get(const char *name);
 246
 247 static inline void
 248 device_set_deferred(struct device *dev, bool value)
 249 {
 250         dev->deferred = value;
 251         device_refresh_present(dev);
 252 }
 253
 254 static inline void
 255 device_set_disabled(struct device *dev, bool value)
 256 {
 257         dev->disabled = value;
 258         device_refresh_present(dev);
 259 }
 260
 261 #endif