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