interface.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_INTERFACE_H
  15 #define __NETIFD_INTERFACE_H
  16
  17 #include "device.h"
  18 #include "config.h"
  19
  20 struct interface;
  21 struct interface_proto_state;
  22
  23 enum interface_event {
  24         IFEV_DOWN,
  25         IFEV_UP,
  26         IFEV_UPDATE,
  27         IFEV_FREE,
  28         IFEV_RELOAD,
  29 };
  30
  31 enum interface_state {
  32         IFS_SETUP,
  33         IFS_UP,
  34         IFS_TEARDOWN,
  35         IFS_DOWN,
  36 };
  37
  38 enum interface_config_state {
  39         IFC_NORMAL,
  40         IFC_RELOAD,
  41         IFC_REMOVE
  42 };
  43
  44 struct interface_error {
  45         struct list_head list;
  46
  47         const char *subsystem;
  48         const char *code;
  49         const char *data[];
  50 };
  51
  52 struct interface_user {
  53         struct list_head list;
  54         struct interface *iface;
  55         void (*cb)(struct interface_user *dep, struct interface *iface, enum interface_event ev);
  56 };
  57
  58 struct interface_ip_settings {
  59         struct interface *iface;
  60         bool enabled;
  61         bool no_defaultroute;
  62         bool no_dns;
  63
  64         struct vlist_tree addr;
  65         struct vlist_tree route;
  66         struct vlist_tree prefix;
  67
  68         struct vlist_simple_tree dns_servers;
  69         struct vlist_simple_tree dns_search;
  70 };
  71
  72 struct interface_data {
  73         struct avl_node node;
  74         struct blob_attr data[];
  75 };
  76
  77 struct interface_assignment_class {
  78         struct list_head head;
  79         char name[];
  80 };
  81
  82 /*
  83  * interface configuration
  84  */
  85 struct interface {
  86         struct vlist_node node;
  87         struct list_head hotplug_list;
  88         enum interface_event hotplug_ev;
  89
  90         char name[IFNAMSIZ];
  91         const char *ifname;
  92
  93         bool available;
  94         bool autostart;
  95         bool config_autostart;
  96         bool device_config;
  97         bool dynamic;
  98
  99         time_t start_time;
 100         enum interface_state state;
 101         enum interface_config_state config_state;
 102
 103         struct list_head users;
 104
 105         const char *parent_ifname;
 106         struct interface_user parent_iface;
 107
 108         /* main interface that the interface is bound to */
 109         struct device_user main_dev;
 110
 111         /* interface that layer 3 communication will go through */
 112         struct device_user l3_dev;
 113
 114         struct blob_attr *config;
 115
 116         /* primary protocol state */
 117         const struct proto_handler *proto_handler;
 118         struct interface_proto_state *proto;
 119
 120         struct interface_ip_settings proto_ip;
 121         struct interface_ip_settings config_ip;
 122         struct vlist_tree host_routes;
 123
 124         int metric;
 125         unsigned int ip4table;
 126         unsigned int ip6table;
 127
 128         /* IPv6 assignment parameters */
 129         uint8_t assignment_length;
 130         int32_t assignment_hint;
 131         struct list_head assignment_classes;
 132
 133         /* errors/warnings while trying to bring up the interface */
 134         struct list_head errors;
 135
 136         /* extra data provided by protocol handlers or modules */
 137         struct avl_tree data;
 138
 139         struct uloop_timeout remove_timer;
 140         struct ubus_object ubus;
 141 };
 142
 143
 144 extern struct vlist_tree interfaces;
 145 extern const struct uci_blob_param_list interface_attr_list;
 146
 147 void interface_init(struct interface *iface, const char *name,
 148                     struct blob_attr *config, bool dynamic);
 149
 150 void interface_add(struct interface *iface, struct blob_attr *config);
 151 bool interface_add_alias(struct interface *iface, struct blob_attr *config);
 152
 153 void interface_set_proto_state(struct interface *iface, struct interface_proto_state *state);
 154
 155 void interface_set_available(struct interface *iface, bool new_state);
 156 int interface_set_up(struct interface *iface);
 157 int interface_set_down(struct interface *iface);
 158 void __interface_set_down(struct interface *iface, bool force);
 159
 160 void interface_set_main_dev(struct interface *iface, struct device *dev);
 161 void interface_set_l3_dev(struct interface *iface, struct device *dev);
 162
 163 void interface_add_user(struct interface_user *dep, struct interface *iface);
 164 void interface_remove_user(struct interface_user *dep);
 165
 166 int interface_add_link(struct interface *iface, struct device *dev);
 167 int interface_remove_link(struct interface *iface, struct device *dev);
 168
 169 void interface_add_error(struct interface *iface, const char *subsystem,
 170                          const char *code, const char **data, int n_data);
 171
 172 int interface_add_data(struct interface *iface, const struct blob_attr *data);
 173
 174 void interface_update_start(struct interface *iface);
 175 void interface_update_complete(struct interface *iface);
 176
 177 void interface_start_pending(void);
 178
 179 #endif