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_type;
  23 struct device_user;
  24 struct device_hotplug_ops;
  25 struct interface;
  26
  27 typedef int (*device_state_cb)(struct device *, bool up);
  28
  29 enum {
  30         DEV_ATTR_TYPE,
  31         DEV_ATTR_MTU,
  32         DEV_ATTR_MTU6,
  33         DEV_ATTR_MACADDR,
  34         DEV_ATTR_TXQUEUELEN,
  35         DEV_ATTR_ENABLED,
  36         DEV_ATTR_IPV6,
  37         DEV_ATTR_PROMISC,
  38         DEV_ATTR_RPFILTER,
  39         DEV_ATTR_ACCEPTLOCAL,
  40         DEV_ATTR_IGMPVERSION,
  41         DEV_ATTR_MLDVERSION,
  42         DEV_ATTR_NEIGHREACHABLETIME,
  43         DEV_ATTR_DADTRANSMITS,
  44         DEV_ATTR_MULTICAST_TO_UNICAST,
  45         DEV_ATTR_MULTICAST_ROUTER,
  46         DEV_ATTR_MULTICAST_FAST_LEAVE,
  47         DEV_ATTR_MULTICAST,
  48         DEV_ATTR_LEARNING,
  49         DEV_ATTR_UNICAST_FLOOD,
  50         DEV_ATTR_NEIGHGCSTALETIME,
  51         DEV_ATTR_SENDREDIRECTS,
  52         DEV_ATTR_NEIGHLOCKTIME,
  53         DEV_ATTR_ISOLATE,
  54         __DEV_ATTR_MAX,
  55 };
  56
  57 enum dev_change_type {
  58         DEV_CONFIG_NO_CHANGE,
  59         DEV_CONFIG_APPLIED,
  60         DEV_CONFIG_RESTART,
  61         DEV_CONFIG_RECREATE,
  62 };
  63
  64 struct device_type {
  65         struct list_head list;
  66         const char *name;
  67
  68         bool bridge_capability;
  69         const char *name_prefix;
  70
  71         const struct uci_blob_param_list *config_params;
  72
  73         struct device *(*create)(const char *name, struct device_type *devtype,
  74                 struct blob_attr *attr);
  75         void (*config_init)(struct device *);
  76         enum dev_change_type (*reload)(struct device *, struct blob_attr *);
  77         void (*dump_info)(struct device *, struct blob_buf *buf);
  78         void (*dump_stats)(struct device *, struct blob_buf *buf);
  79         int (*check_state)(struct device *);
  80         void (*free)(struct device *);
  81 };
  82
  83 enum {
  84         DEV_OPT_MTU                     = (1 << 0),
  85         DEV_OPT_MACADDR                 = (1 << 1),
  86         DEV_OPT_TXQUEUELEN              = (1 << 2),
  87         DEV_OPT_IPV6                    = (1 << 3),
  88         DEV_OPT_PROMISC                 = (1 << 4),
  89         DEV_OPT_RPFILTER                = (1 << 5),
  90         DEV_OPT_ACCEPTLOCAL             = (1 << 6),
  91         DEV_OPT_IGMPVERSION             = (1 << 7),
  92         DEV_OPT_MLDVERSION              = (1 << 8),
  93         DEV_OPT_NEIGHREACHABLETIME      = (1 << 9),
  94         /* 2 bit hole */
  95         DEV_OPT_MTU6                    = (1 << 12),
  96         DEV_OPT_DADTRANSMITS            = (1 << 13),
  97         DEV_OPT_MULTICAST_TO_UNICAST    = (1 << 14),
  98         DEV_OPT_MULTICAST_ROUTER        = (1 << 15),
  99         DEV_OPT_MULTICAST               = (1 << 16),
 100         DEV_OPT_LEARNING                = (1 << 17),
 101         DEV_OPT_UNICAST_FLOOD           = (1 << 18),
 102         DEV_OPT_NEIGHGCSTALETIME        = (1 << 19),
 103         DEV_OPT_MULTICAST_FAST_LEAVE    = (1 << 20),
 104         DEV_OPT_SENDREDIRECTS           = (1 << 21),
 105         DEV_OPT_NEIGHLOCKTIME           = (1 << 22),
 106         DEV_OPT_ISOLATE                 = (1 << 23),
 107 };
 108
 109 /* events broadcasted to all users of a device */
 110 enum device_event {
 111         DEV_EVENT_ADD,
 112         DEV_EVENT_REMOVE,
 113
 114         DEV_EVENT_UPDATE_IFNAME,
 115         DEV_EVENT_UPDATE_IFINDEX,
 116
 117         DEV_EVENT_SETUP,
 118         DEV_EVENT_TEARDOWN,
 119         DEV_EVENT_UP,
 120         DEV_EVENT_DOWN,
 121
 122         DEV_EVENT_LINK_UP,
 123         DEV_EVENT_LINK_DOWN,
 124
 125         /* Topology changed (i.e. bridge member added) */
 126         DEV_EVENT_TOPO_CHANGE,
 127
 128         __DEV_EVENT_MAX
 129 };
 130
 131 /*
 132  * device dependency with callbacks
 133  */
 134 struct device_user {
 135         struct safe_list list;
 136
 137         bool claimed;
 138         bool hotplug;
 139         bool alias;
 140
 141         uint8_t ev_idx[__DEV_EVENT_MAX];
 142
 143         struct device *dev;
 144         void (*cb)(struct device_user *, enum device_event);
 145 };
 146
 147 struct device_settings {
 148         unsigned int flags;
 149         unsigned int valid_flags;
 150         unsigned int mtu;
 151         unsigned int mtu6;
 152         unsigned int txqueuelen;
 153         uint8_t macaddr[6];
 154         bool ipv6;
 155         bool promisc;
 156         unsigned int rpfilter;
 157         bool acceptlocal;
 158         unsigned int igmpversion;
 159         unsigned int mldversion;
 160         unsigned int neigh4reachabletime;
 161         unsigned int neigh6reachabletime;
 162         unsigned int neigh4gcstaletime;
 163         unsigned int neigh6gcstaletime;
 164         int neigh4locktime;
 165         unsigned int dadtransmits;
 166         bool multicast_to_unicast;
 167         unsigned int multicast_router;
 168         bool multicast_fast_leave;
 169         bool multicast;
 170         bool learning;
 171         bool unicast_flood;
 172         bool sendredirects;
 173         bool isolate;
 174 };
 175
 176 /*
 177  * link layer device. typically represents a linux network device.
 178  * can be used to support VLANs as well
 179  */
 180 struct device {
 181         struct device_type *type;
 182
 183         struct avl_node avl;
 184         struct safe_list users;
 185         struct safe_list aliases;
 186
 187         char ifname[IFNAMSIZ + 1];
 188         int ifindex;
 189
 190         struct blob_attr *config;
 191         bool config_pending;
 192         bool sys_present;
 193         /* DEV_EVENT_ADD */
 194         bool present;
 195         /* DEV_EVENT_UP */
 196         int active;
 197         /* DEV_EVENT_LINK_UP */
 198         bool link_active;
 199
 200         bool external;
 201         bool disabled;
 202         bool deferred;
 203         bool hidden;
 204
 205         bool current_config;
 206         bool iface_config;
 207         bool default_config;
 208         bool wireless;
 209         bool wireless_ap;
 210         bool wireless_isolate;
 211
 212         struct interface *config_iface;
 213
 214         /* set interface up or down */
 215         device_state_cb set_state;
 216
 217         const struct device_hotplug_ops *hotplug_ops;
 218
 219         struct device_user parent;
 220
 221         struct device_settings orig_settings;
 222         struct device_settings settings;
 223 };
 224
 225 struct device_hotplug_ops {
 226         int (*prepare)(struct device *dev);
 227         int (*add)(struct device *main, struct device *member);
 228         int (*del)(struct device *main, struct device *member);
 229 };
 230
 231 extern const struct uci_blob_param_list device_attr_list;
 232 extern struct device_type simple_device_type;
 233 extern struct device_type tunnel_device_type;
 234
 235 void device_lock(void);
 236 void device_unlock(void);
 237
 238 int device_type_add(struct device_type *devtype);
 239 struct device_type *device_type_get(const char *tname);
 240 struct device *device_create(const char *name, struct device_type *type,
 241                              struct blob_attr *config);
 242 void device_merge_settings(struct device *dev, struct device_settings *n);
 243 void device_init_settings(struct device *dev, struct blob_attr **tb);
 244 void device_init_pending(void);
 245
 246 enum dev_change_type
 247 device_apply_config(struct device *dev, struct device_type *type,
 248                     struct blob_attr *config);
 249
 250 void device_reset_config(void);
 251 void device_reset_old(void);
 252
 253 void device_init_virtual(struct device *dev, struct device_type *type, const char *name);
 254 int device_init(struct device *dev, struct device_type *type, const char *ifname);
 255 void device_cleanup(struct device *dev);
 256 struct device *device_find(const char *name);
 257 struct device *device_get(const char *name, int create);
 258 void device_add_user(struct device_user *dep, struct device *dev);
 259 void device_remove_user(struct device_user *dep);
 260 void device_broadcast_event(struct device *dev, enum device_event ev);
 261
 262 void device_set_present(struct device *dev, bool state);
 263 void device_set_link(struct device *dev, bool state);
 264 void device_set_ifindex(struct device *dev, int ifindex);
 265 int device_set_ifname(struct device *dev, const char *name);
 266 void device_refresh_present(struct device *dev);
 267 int device_claim(struct device_user *dep);
 268 void device_release(struct device_user *dep);
 269 int device_check_state(struct device *dev);
 270 void device_dump_status(struct blob_buf *b, struct device *dev);
 271
 272 void device_free(struct device *dev);
 273 void device_free_unused(struct device *dev);
 274
 275 struct device *get_vlan_device_chain(const char *ifname, bool create);
 276 void alias_notify_device(const char *name, struct device *dev);
 277 struct device *device_alias_get(const char *name);
 278
 279 static inline void
 280 device_set_deferred(struct device *dev, bool value)
 281 {
 282         dev->deferred = value;
 283         device_refresh_present(dev);
 284 }
 285
 286 static inline void
 287 device_set_disabled(struct device *dev, bool value)
 288 {
 289         dev->disabled = value;
 290         device_refresh_present(dev);
 291 }
 292
 293 #endif