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