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