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