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