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_IP6SEGMENTROUTING,
  57         DEV_ATTR_DROP_V4_UNICAST_IN_L2_MULTICAST,
  58         DEV_ATTR_DROP_V6_UNICAST_IN_L2_MULTICAST,
  59         DEV_ATTR_DROP_GRATUITOUS_ARP,
  60         DEV_ATTR_DROP_UNSOLICITED_NA,
  61         DEV_ATTR_ARP_ACCEPT,
  62         DEV_ATTR_AUTH,
  63         DEV_ATTR_AUTH_VLAN,
  64         DEV_ATTR_SPEED,
  65         DEV_ATTR_DUPLEX,
  66         DEV_ATTR_VLAN,
  67         DEV_ATTR_PAUSE,
  68         DEV_ATTR_ASYM_PAUSE,
  69         DEV_ATTR_RXPAUSE,
  70         DEV_ATTR_TXPAUSE,
  71         DEV_ATTR_AUTONEG,
  72         DEV_ATTR_GRO,
  73         __DEV_ATTR_MAX,
  74 };
  75
  76 enum dev_change_type {
  77         DEV_CONFIG_NO_CHANGE,
  78         DEV_CONFIG_APPLIED,
  79         DEV_CONFIG_RESTART,
  80         DEV_CONFIG_RECREATE,
  81 };
  82
  83 struct device_type {
  84         struct list_head list;
  85         const char *name;
  86
  87         bool bridge_capability;
  88         const char *name_prefix;
  89
  90         const struct uci_blob_param_list *config_params;
  91
  92         struct device *(*create)(const char *name, struct device_type *devtype,
  93                 struct blob_attr *attr);
  94         void (*config_init)(struct device *);
  95         enum dev_change_type (*reload)(struct device *, struct blob_attr *);
  96         void (*vlan_update)(struct device *);
  97         void (*dump_info)(struct device *, struct blob_buf *buf);
  98         void (*dump_stats)(struct device *, struct blob_buf *buf);
  99         int (*check_state)(struct device *);
 100         void (*stp_init)(struct device *);
 101         void (*free)(struct device *);
 102 };
 103
 104 enum {
 105         DEV_OPT_MTU                     = (1ULL << 0),
 106         DEV_OPT_MACADDR                 = (1ULL << 1),
 107         DEV_OPT_TXQUEUELEN              = (1ULL << 2),
 108         DEV_OPT_IPV6                    = (1ULL << 3),
 109         DEV_OPT_PROMISC                 = (1ULL << 4),
 110         DEV_OPT_RPFILTER                = (1ULL << 5),
 111         DEV_OPT_ACCEPTLOCAL             = (1ULL << 6),
 112         DEV_OPT_IGMPVERSION             = (1ULL << 7),
 113         DEV_OPT_MLDVERSION              = (1ULL << 8),
 114         DEV_OPT_NEIGHREACHABLETIME      = (1ULL << 9),
 115         DEV_OPT_DEFAULT_MACADDR         = (1ULL << 10),
 116         DEV_OPT_AUTH                    = (1ULL << 11),
 117         DEV_OPT_MTU6                    = (1ULL << 12),
 118         DEV_OPT_DADTRANSMITS            = (1ULL << 13),
 119         DEV_OPT_MULTICAST_TO_UNICAST    = (1ULL << 14),
 120         DEV_OPT_MULTICAST_ROUTER        = (1ULL << 15),
 121         DEV_OPT_MULTICAST               = (1ULL << 16),
 122         DEV_OPT_LEARNING                = (1ULL << 17),
 123         DEV_OPT_UNICAST_FLOOD           = (1ULL << 18),
 124         DEV_OPT_NEIGHGCSTALETIME        = (1ULL << 19),
 125         DEV_OPT_MULTICAST_FAST_LEAVE    = (1ULL << 20),
 126         DEV_OPT_SENDREDIRECTS           = (1ULL << 21),
 127         DEV_OPT_NEIGHLOCKTIME           = (1ULL << 22),
 128         DEV_OPT_ISOLATE                 = (1ULL << 23),
 129         DEV_OPT_IP6SEGMENTROUTING       = (1ULL << 24),
 130         DEV_OPT_DROP_V4_UNICAST_IN_L2_MULTICAST = (1ULL << 25),
 131         DEV_OPT_DROP_V6_UNICAST_IN_L2_MULTICAST = (1ULL << 26),
 132         DEV_OPT_DROP_GRATUITOUS_ARP     = (1ULL << 27),
 133         DEV_OPT_DROP_UNSOLICITED_NA     = (1ULL << 28),
 134         DEV_OPT_ARP_ACCEPT              = (1ULL << 29),
 135         DEV_OPT_SPEED                   = (1ULL << 30),
 136         DEV_OPT_DUPLEX                  = (1ULL << 31),
 137         DEV_OPT_PAUSE                   = (1ULL << 32),
 138         DEV_OPT_ASYM_PAUSE              = (1ULL << 33),
 139         DEV_OPT_RXPAUSE                 = (1ULL << 34),
 140         DEV_OPT_TXPAUSE                 = (1ULL << 35),
 141         DEV_OPT_AUTONEG                 = (1ULL << 36),
 142         DEV_OPT_GRO                     = (1ULL << 37),
 143 };
 144
 145 /* events broadcasted to all users of a device */
 146 enum device_event {
 147         DEV_EVENT_ADD,
 148         DEV_EVENT_REMOVE,
 149
 150         DEV_EVENT_UPDATE_IFNAME,
 151         DEV_EVENT_UPDATE_IFINDEX,
 152
 153         DEV_EVENT_SETUP,
 154         DEV_EVENT_TEARDOWN,
 155         DEV_EVENT_UP,
 156         DEV_EVENT_DOWN,
 157
 158         DEV_EVENT_AUTH_UP,
 159         DEV_EVENT_LINK_UP,
 160         DEV_EVENT_LINK_DOWN,
 161
 162         /* Topology changed (i.e. bridge member added) */
 163         DEV_EVENT_TOPO_CHANGE,
 164
 165         __DEV_EVENT_MAX
 166 };
 167
 168 /*
 169  * device dependency with callbacks
 170  */
 171 struct device_user {
 172         struct safe_list list;
 173
 174         bool claimed;
 175         bool hotplug;
 176         bool alias;
 177
 178         uint8_t ev_idx[__DEV_EVENT_MAX];
 179
 180         struct device *dev;
 181         void (*cb)(struct device_user *, enum device_event);
 182 };
 183
 184 struct device_settings {
 185         uint64_t flags;
 186         uint64_t valid_flags;
 187         unsigned int mtu;
 188         unsigned int mtu6;
 189         unsigned int txqueuelen;
 190         uint8_t macaddr[6];
 191         bool ipv6;
 192         bool promisc;
 193         unsigned int rpfilter;
 194         bool acceptlocal;
 195         unsigned int igmpversion;
 196         unsigned int mldversion;
 197         unsigned int neigh4reachabletime;
 198         unsigned int neigh6reachabletime;
 199         unsigned int neigh4gcstaletime;
 200         unsigned int neigh6gcstaletime;
 201         int neigh4locktime;
 202         unsigned int dadtransmits;
 203         bool multicast_to_unicast;
 204         unsigned int multicast_router;
 205         bool multicast_fast_leave;
 206         bool multicast;
 207         bool learning;
 208         bool unicast_flood;
 209         bool sendredirects;
 210         bool ip6segmentrouting;
 211         bool isolate;
 212         bool drop_v4_unicast_in_l2_multicast;
 213         bool drop_v6_unicast_in_l2_multicast;
 214         bool drop_gratuitous_arp;
 215         bool drop_unsolicited_na;
 216         bool arp_accept;
 217         bool auth;
 218         unsigned int speed;
 219         bool duplex;
 220         bool pause;
 221         bool asym_pause;
 222         bool rxpause;
 223         bool txpause;
 224         bool autoneg;
 225         bool gro;
 226 };
 227
 228 struct device_vlan_range {
 229         uint16_t start, end;
 230 };
 231
 232 /*
 233  * link layer device. typically represents a linux network device.
 234  * can be used to support VLANs as well
 235  */
 236 struct device {
 237         struct device_type *type;
 238
 239         struct avl_node avl;
 240         struct safe_list users;
 241         struct safe_list aliases;
 242
 243         struct vlist_tree vlans;
 244         struct kvlist vlan_aliases;
 245         struct blob_attr *config_auth_vlans;
 246         struct blob_attr *auth_vlans;
 247
 248         char ifname[IFNAMSIZ];
 249         int ifindex;
 250
 251         struct blob_attr *config;
 252         bool config_pending;
 253         bool sys_present;
 254         /* DEV_EVENT_ADD */
 255         bool present;
 256         /* DEV_EVENT_UP */
 257         int active;
 258         /* DEV_EVENT_LINK_UP */
 259         bool link_active;
 260         bool auth_status;
 261
 262         bool external;
 263         bool disabled;
 264         bool deferred;
 265         bool hidden;
 266
 267         bool current_config;
 268         bool iface_config;
 269         bool default_config;
 270         bool wireless;
 271         bool wireless_ap;
 272         bool wireless_proxyarp;
 273         bool wireless_isolate;
 274         bool bpdu_filter;
 275
 276         struct interface *config_iface;
 277         struct device_vlan_range *extra_vlan;
 278         int n_extra_vlan;
 279
 280         /* set interface up or down */
 281         device_state_cb set_state;
 282
 283         const struct device_hotplug_ops *hotplug_ops;
 284
 285         struct device_user parent;
 286
 287         struct device_settings orig_settings;
 288         struct device_settings settings;
 289 };
 290
 291 struct device_hotplug_ops {
 292         int (*prepare)(struct device *dev, struct device **bridge_dev);
 293         int (*add)(struct device *main, struct device *member, struct blob_attr *vlan);
 294         int (*del)(struct device *main, struct device *member, struct blob_attr *vlan);
 295 };
 296
 297 enum bridge_vlan_flags {
 298         BRVLAN_F_SELF =         (1 << 0),
 299         BRVLAN_F_PVID =         (1 << 1),
 300         BRVLAN_F_UNTAGGED =     (1 << 2),
 301 };
 302
 303 struct bridge_vlan_port {
 304         const char *ifname;
 305         uint16_t flags;
 306         int8_t check;
 307 };
 308
 309 struct bridge_vlan_hotplug_port {
 310         struct list_head list;
 311         struct bridge_vlan_port port;
 312 };
 313
 314 struct bridge_vlan {
 315         struct vlist_node node;
 316
 317         struct bridge_vlan_port *ports;
 318         int n_ports;
 319
 320         struct list_head hotplug_ports;
 321
 322         uint16_t vid;
 323         bool local;
 324         bool pending;
 325 };
 326
 327 extern const struct uci_blob_param_list device_attr_list;
 328 extern struct device_type simple_device_type;
 329 extern struct device_type tunnel_device_type;
 330
 331 void device_vlan_update(bool done);
 332 void device_stp_init(void);
 333
 334 int device_type_add(struct device_type *devtype);
 335 struct device_type *device_type_get(const char *tname);
 336 struct device *device_create(const char *name, struct device_type *type,
 337                              struct blob_attr *config);
 338 void device_merge_settings(struct device *dev, struct device_settings *n);
 339 void device_init_settings(struct device *dev, struct blob_attr **tb);
 340 void device_init_pending(void);
 341
 342 enum dev_change_type
 343 device_apply_config(struct device *dev, struct device_type *type,
 344                     struct blob_attr *config);
 345
 346 void device_reset_config(void);
 347 void device_reset_old(void);
 348
 349 int device_init_virtual(struct device *dev, struct device_type *type, const char *name);
 350 int device_init(struct device *dev, struct device_type *type, const char *ifname);
 351 void device_cleanup(struct device *dev);
 352 struct device *device_find(const char *name);
 353
 354 struct device *__device_get(const char *name, int create, bool check_vlan);
 355 static inline struct device *device_get(const char *name, int create)
 356 {
 357         return __device_get(name, create, true);
 358 }
 359
 360 void device_add_user(struct device_user *dep, struct device *dev);
 361 void device_remove_user(struct device_user *dep);
 362 void device_broadcast_event(struct device *dev, enum device_event ev);
 363
 364 void device_set_present(struct device *dev, bool state);
 365 void device_set_link(struct device *dev, bool state);
 366 void device_set_ifindex(struct device *dev, int ifindex);
 367 int device_set_ifname(struct device *dev, const char *name);
 368 void device_refresh_present(struct device *dev);
 369 int device_claim(struct device_user *dep);
 370 void device_release(struct device_user *dep);
 371 int device_check_state(struct device *dev);
 372 void device_dump_status(struct blob_buf *b, struct device *dev);
 373
 374 void device_free_unused(void);
 375
 376 struct device *get_vlan_device_chain(const char *ifname, int create);
 377 void alias_notify_device(const char *name, struct device *dev);
 378 struct device *device_alias_get(const char *name);
 379
 380 void device_set_auth_status(struct device *dev, bool value, struct blob_attr *vlans);
 381
 382 static inline void
 383 device_set_deferred(struct device *dev, bool value)
 384 {
 385         dev->deferred = value;
 386         device_refresh_present(dev);
 387 }
 388
 389 static inline void
 390 device_set_disabled(struct device *dev, bool value)
 391 {
 392         dev->disabled = value;
 393         device_refresh_present(dev);
 394 }
 395
 396 static inline bool
 397 device_link_active(struct device *dev)
 398 {
 399         if (dev->settings.auth && !dev->auth_status)
 400                 return false;
 401
 402         return dev->link_active;
 403 }
 404
 405 bool device_check_ip6segmentrouting(void);
 406 void device_hotplug_event(const char *name, bool add);
 407
 408 #endif