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 <libubox/kvlist.h>
  20 #include <netinet/in.h>
  21
  22 struct device;
  23 struct device_type;
  24 struct device_user;
  25 struct device_hotplug_ops;
  26 struct bridge_vlan;
  27 struct interface;
  28
  29 typedef int (*device_state_cb)(struct device *, bool up);
  30
  31 enum {
  32         DEV_ATTR_TYPE,
  33         DEV_ATTR_MTU,
  34         DEV_ATTR_MTU6,
  35         DEV_ATTR_MACADDR,
  36         DEV_ATTR_TXQUEUELEN,
  37         DEV_ATTR_ENABLED,
  38         DEV_ATTR_IPV6,
  39         DEV_ATTR_PROMISC,
  40         DEV_ATTR_RPFILTER,
  41         DEV_ATTR_ACCEPTLOCAL,
  42         DEV_ATTR_IGMPVERSION,
  43         DEV_ATTR_MLDVERSION,
  44         DEV_ATTR_NEIGHREACHABLETIME,
  45         DEV_ATTR_DADTRANSMITS,
  46         DEV_ATTR_MULTICAST_TO_UNICAST,
  47         DEV_ATTR_MULTICAST_ROUTER,
  48         DEV_ATTR_MULTICAST_FAST_LEAVE,
  49         DEV_ATTR_MULTICAST,
  50         DEV_ATTR_LEARNING,
  51         DEV_ATTR_UNICAST_FLOOD,
  52         DEV_ATTR_NEIGHGCSTALETIME,
  53         DEV_ATTR_SENDREDIRECTS,
  54         DEV_ATTR_NEIGHLOCKTIME,
  55         DEV_ATTR_ISOLATE,
  56         __DEV_ATTR_MAX,
  57 };
  58
  59 enum dev_change_type {
  60         DEV_CONFIG_NO_CHANGE,
  61         DEV_CONFIG_APPLIED,
  62         DEV_CONFIG_RESTART,
  63         DEV_CONFIG_RECREATE,
  64 };
  65
  66 struct device_type {
  67         struct list_head list;
  68         const char *name;
  69
  70         bool bridge_capability;
  71         const char *name_prefix;
  72
  73         const struct uci_blob_param_list *config_params;
  74
  75         struct device *(*create)(const char *name, struct device_type *devtype,
  76                 struct blob_attr *attr);
  77         void (*config_init)(struct device *);
  78         enum dev_change_type (*reload)(struct device *, struct blob_attr *);
  79         void (*dump_info)(struct device *, struct blob_buf *buf);
  80         void (*dump_stats)(struct device *, struct blob_buf *buf);
  81         int (*check_state)(struct device *);
  82         void (*free)(struct device *);
  83 };
  84
  85 enum {
  86         DEV_OPT_MTU                     = (1 << 0),
  87         DEV_OPT_MACADDR                 = (1 << 1),
  88         DEV_OPT_TXQUEUELEN              = (1 << 2),
  89         DEV_OPT_IPV6                    = (1 << 3),
  90         DEV_OPT_PROMISC                 = (1 << 4),
  91         DEV_OPT_RPFILTER                = (1 << 5),
  92         DEV_OPT_ACCEPTLOCAL             = (1 << 6),
  93         DEV_OPT_IGMPVERSION             = (1 << 7),
  94         DEV_OPT_MLDVERSION              = (1 << 8),
  95         DEV_OPT_NEIGHREACHABLETIME      = (1 << 9),
  96         DEV_OPT_DEFAULT_MACADDR         = (1 << 10),
  97         /* 1 bit hole */
  98         DEV_OPT_MTU6                    = (1 << 12),
  99         DEV_OPT_DADTRANSMITS            = (1 << 13),
 100         DEV_OPT_MULTICAST_TO_UNICAST    = (1 << 14),
 101         DEV_OPT_MULTICAST_ROUTER        = (1 << 15),
 102         DEV_OPT_MULTICAST               = (1 << 16),
 103         DEV_OPT_LEARNING                = (1 << 17),
 104         DEV_OPT_UNICAST_FLOOD           = (1 << 18),
 105         DEV_OPT_NEIGHGCSTALETIME        = (1 << 19),
 106         DEV_OPT_MULTICAST_FAST_LEAVE    = (1 << 20),
 107         DEV_OPT_SENDREDIRECTS           = (1 << 21),
 108         DEV_OPT_NEIGHLOCKTIME           = (1 << 22),
 109         DEV_OPT_ISOLATE                 = (1 << 23),
 110 };
 111
 112 /* events broadcasted to all users of a device */
 113 enum device_event {
 114         DEV_EVENT_ADD,
 115         DEV_EVENT_REMOVE,
 116
 117         DEV_EVENT_UPDATE_IFNAME,
 118         DEV_EVENT_UPDATE_IFINDEX,
 119
 120         DEV_EVENT_SETUP,
 121         DEV_EVENT_TEARDOWN,
 122         DEV_EVENT_UP,
 123         DEV_EVENT_DOWN,
 124
 125         DEV_EVENT_LINK_UP,
 126         DEV_EVENT_LINK_DOWN,
 127
 128         /* Topology changed (i.e. bridge member added) */
 129         DEV_EVENT_TOPO_CHANGE,
 130
 131         __DEV_EVENT_MAX
 132 };
 133
 134 /*
 135  * device dependency with callbacks
 136  */
 137 struct device_user {
 138         struct safe_list list;
 139
 140         bool claimed;
 141         bool hotplug;
 142         bool alias;
 143
 144         uint8_t ev_idx[__DEV_EVENT_MAX];
 145
 146         struct device *dev;
 147         void (*cb)(struct device_user *, enum device_event);
 148 };
 149
 150 struct device_settings {
 151         unsigned int flags;
 152         unsigned int valid_flags;
 153         unsigned int mtu;
 154         unsigned int mtu6;
 155         unsigned int txqueuelen;
 156         uint8_t macaddr[6];
 157         bool ipv6;
 158         bool promisc;
 159         unsigned int rpfilter;
 160         bool acceptlocal;
 161         unsigned int igmpversion;
 162         unsigned int mldversion;
 163         unsigned int neigh4reachabletime;
 164         unsigned int neigh6reachabletime;
 165         unsigned int neigh4gcstaletime;
 166         unsigned int neigh6gcstaletime;
 167         int neigh4locktime;
 168         unsigned int dadtransmits;
 169         bool multicast_to_unicast;
 170         unsigned int multicast_router;
 171         bool multicast_fast_leave;
 172         bool multicast;
 173         bool learning;
 174         bool unicast_flood;
 175         bool sendredirects;
 176         bool isolate;
 177 };
 178
 179 /*
 180  * link layer device. typically represents a linux network device.
 181  * can be used to support VLANs as well
 182  */
 183 struct device {
 184         struct device_type *type;
 185
 186         struct avl_node avl;
 187         struct safe_list users;
 188         struct safe_list aliases;
 189
 190         struct vlist_tree vlans;
 191         struct kvlist vlan_aliases;
 192
 193         char ifname[IFNAMSIZ + 1];
 194         int ifindex;
 195
 196         struct blob_attr *config;
 197         bool config_pending;
 198         bool sys_present;
 199         /* DEV_EVENT_ADD */
 200         bool present;
 201         /* DEV_EVENT_UP */
 202         int active;
 203         /* DEV_EVENT_LINK_UP */
 204         bool link_active;
 205
 206         bool external;
 207         bool disabled;
 208         bool deferred;
 209         bool hidden;
 210
 211         bool current_config;
 212         bool iface_config;
 213         bool default_config;
 214         bool wireless;
 215         bool wireless_ap;
 216         bool wireless_isolate;
 217
 218         struct interface *config_iface;
 219
 220         /* set interface up or down */
 221         device_state_cb set_state;
 222
 223         const struct device_hotplug_ops *hotplug_ops;
 224
 225         struct device_user parent;
 226
 227         struct device_settings orig_settings;
 228         struct device_settings settings;
 229 };
 230
 231 struct device_hotplug_ops {
 232         int (*prepare)(struct device *dev, struct device **bridge_dev);
 233         int (*add)(struct device *main, struct device *member, struct blob_attr *vlan);
 234         int (*del)(struct device *main, struct device *member);
 235 };
 236
 237 enum bridge_vlan_flags {
 238         BRVLAN_F_SELF =         (1 << 0),
 239         BRVLAN_F_PVID =         (1 << 1),
 240         BRVLAN_F_UNTAGGED =     (1 << 2),
 241 };
 242
 243 struct bridge_vlan_port {
 244         const char *ifname;
 245         uint16_t flags;
 246 };
 247
 248 struct bridge_vlan {
 249         struct vlist_node node;
 250
 251         struct bridge_vlan_port *ports;
 252         int n_ports;
 253
 254         struct list_head hotplug_ports;
 255
 256         uint16_t vid;
 257         bool local;
 258 };
 259
 260 extern const struct uci_blob_param_list device_attr_list;
 261 extern struct device_type simple_device_type;
 262 extern struct device_type tunnel_device_type;
 263
 264 void device_lock(void);
 265 void device_unlock(void);
 266
 267 void device_vlan_update(bool done);
 268
 269 int device_type_add(struct device_type *devtype);
 270 struct device_type *device_type_get(const char *tname);
 271 struct device *device_create(const char *name, struct device_type *type,
 272                              struct blob_attr *config);
 273 void device_merge_settings(struct device *dev, struct device_settings *n);
 274 void device_init_settings(struct device *dev, struct blob_attr **tb);
 275 void device_init_pending(void);
 276
 277 enum dev_change_type
 278 device_apply_config(struct device *dev, struct device_type *type,
 279                     struct blob_attr *config);
 280
 281 void device_reset_config(void);
 282 void device_reset_old(void);
 283
 284 int device_init_virtual(struct device *dev, struct device_type *type, const char *name);
 285 int device_init(struct device *dev, struct device_type *type, const char *ifname);
 286 void device_cleanup(struct device *dev);
 287 struct device *device_find(const char *name);
 288 struct device *device_get(const char *name, int create);
 289 void device_add_user(struct device_user *dep, struct device *dev);
 290 void device_remove_user(struct device_user *dep);
 291 void device_broadcast_event(struct device *dev, enum device_event ev);
 292
 293 void device_set_present(struct device *dev, bool state);
 294 void device_set_link(struct device *dev, bool state);
 295 void device_set_ifindex(struct device *dev, int ifindex);
 296 int device_set_ifname(struct device *dev, const char *name);
 297 void device_refresh_present(struct device *dev);
 298 int device_claim(struct device_user *dep);
 299 void device_release(struct device_user *dep);
 300 int device_check_state(struct device *dev);
 301 void device_dump_status(struct blob_buf *b, struct device *dev);
 302
 303 void device_free_unused(struct device *dev);
 304
 305 struct device *get_vlan_device_chain(const char *ifname, bool create);
 306 void alias_notify_device(const char *name, struct device *dev);
 307 struct device *device_alias_get(const char *name);
 308
 309 static inline void
 310 device_set_deferred(struct device *dev, bool value)
 311 {
 312         dev->deferred = value;
 313         device_refresh_present(dev);
 314 }
 315
 316 static inline void
 317 device_set_disabled(struct device *dev, bool value)
 318 {
 319         dev->disabled = value;
 320         device_refresh_present(dev);
 321 }
 322
 323 #endif