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