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