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