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