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