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