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