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