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