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