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