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