usteer.h

   1 /*
   2  *   This program is free software; you can redistribute it and/or modify
   3  *   it under the terms of the GNU General Public License as published by
   4  *   the Free Software Foundation; either version 2 of the License.
   5  *
   6  *   This program is distributed in the hope that it will be useful,
   7  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
   8  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   9  *   GNU General Public License for more details.
  10  *
  11  *   You should have received a copy of the GNU General Public License
  12  *   along with this program; if not, write to the Free Software
  13  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
  14  *
  15  *   Copyright (C) 2020 embedd.ch
  16  *   Copyright (C) 2020 Felix Fietkau <nbd@nbd.name>
  17  *   Copyright (C) 2020 John Crispin <john@phrozen.org>
  18  */
  19
  20 #ifndef __APMGR_H
  21 #define __APMGR_H
  22
  23 #include <libubox/avl.h>
  24 #include <libubox/blobmsg.h>
  25 #include <libubox/uloop.h>
  26 #include <libubox/utils.h>
  27 #include <libubox/kvlist.h>
  28 #include <libubus.h>
  29 #include "utils.h"
  30 #include "timeout.h"
  31
  32 #define NO_SIGNAL 0xff
  33
  34 #define __STR(x)                #x
  35 #define _STR(x)                 __STR(x)
  36
  37 #define APMGR_V6_MCAST_GROUP    "ff02::4150"
  38
  39 #define APMGR_PORT              16720 /* AP */
  40 #define APMGR_PORT_STR          _STR(APMGR_PORT)
  41 #define APMGR_BUFLEN            (64 * 1024)
  42
  43 #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
  44
  45 enum usteer_event_type {
  46         EVENT_TYPE_PROBE,
  47         EVENT_TYPE_ASSOC,
  48         EVENT_TYPE_AUTH,
  49         __EVENT_TYPE_MAX,
  50 };
  51
  52 enum usteer_node_type {
  53         NODE_TYPE_LOCAL,
  54         NODE_TYPE_REMOTE,
  55 };
  56
  57 struct sta_info;
  58 struct usteer_local_node;
  59 struct usteer_remote_host;
  60
  61 struct usteer_node {
  62         struct avl_node avl;
  63         struct list_head sta_info;
  64
  65         enum usteer_node_type type;
  66
  67         struct blob_attr *rrm_nr;
  68         struct blob_attr *node_info;
  69         char ssid[33];
  70
  71         bool disabled;
  72         int freq;
  73         int noise;
  74         int n_assoc;
  75         int max_assoc;
  76         int load;
  77 };
  78
  79 struct usteer_scan_request {
  80         int n_freq;
  81         int *freq;
  82
  83         bool passive;
  84 };
  85
  86 struct usteer_scan_result {
  87         uint8_t bssid[6];
  88         char ssid[33];
  89
  90         int freq;
  91         int signal;
  92 };
  93
  94 struct usteer_survey_data {
  95         uint16_t freq;
  96         int8_t noise;
  97
  98         uint64_t time;
  99         uint64_t time_busy;
 100 };
 101
 102 struct usteer_freq_data {
 103         uint16_t freq;
 104
 105         uint8_t txpower;
 106         bool dfs;
 107 };
 108
 109 struct usteer_node_handler {
 110         struct list_head list;
 111
 112         void (*init_node)(struct usteer_node *);
 113         void (*free_node)(struct usteer_node *);
 114         void (*update_node)(struct usteer_node *);
 115         void (*update_sta)(struct usteer_node *, struct sta_info *);
 116         void (*get_survey)(struct usteer_node *, void *,
 117                            void (*cb)(void *priv, struct usteer_survey_data *d));
 118         void (*get_freqlist)(struct usteer_node *, void *,
 119                              void (*cb)(void *priv, struct usteer_freq_data *f));
 120         int (*scan)(struct usteer_node *, struct usteer_scan_request *,
 121                     void *, void (*cb)(void *priv, struct usteer_scan_result *r));
 122 };
 123
 124 struct usteer_config {
 125         bool syslog;
 126         uint32_t debug_level;
 127
 128         bool ipv6;
 129
 130         uint32_t sta_block_timeout;
 131         uint32_t local_sta_timeout;
 132         uint32_t local_sta_update;
 133
 134         uint32_t max_retry_band;
 135         uint32_t seen_policy_timeout;
 136
 137         bool assoc_steering;
 138
 139         uint32_t band_steering_threshold;
 140         uint32_t load_balancing_threshold;
 141
 142         uint32_t remote_update_interval;
 143         uint32_t remote_node_timeout;
 144
 145         int32_t min_snr;
 146         int32_t min_connect_snr;
 147         uint32_t signal_diff_threshold;
 148
 149         int32_t roam_scan_snr;
 150         uint32_t roam_scan_tries;
 151         uint32_t roam_scan_interval;
 152
 153         int32_t roam_trigger_snr;
 154         uint32_t roam_trigger_interval;
 155
 156         uint32_t roam_kick_delay;
 157
 158         uint32_t initial_connect_delay;
 159
 160         bool load_kick_enabled;
 161         uint32_t load_kick_threshold;
 162         uint32_t load_kick_delay;
 163         uint32_t load_kick_min_clients;
 164         uint32_t load_kick_reason_code;
 165
 166         const char *node_up_script;
 167         uint32_t event_log_mask;
 168
 169         struct blob_attr *ssid_list;
 170 };
 171
 172 struct sta_info_stats {
 173         uint32_t requests;
 174         uint32_t blocked_cur;
 175         uint32_t blocked_total;
 176         uint32_t blocked_last_time;
 177 };
 178
 179 enum roam_trigger_state {
 180         ROAM_TRIGGER_IDLE,
 181         ROAM_TRIGGER_SCAN,
 182         ROAM_TRIGGER_SCAN_DONE,
 183         ROAM_TRIGGER_WAIT_KICK,
 184         ROAM_TRIGGER_NOTIFY_KICK,
 185         ROAM_TRIGGER_KICK,
 186 };
 187
 188 struct sta_info {
 189         struct list_head list;
 190         struct list_head node_list;
 191
 192         struct usteer_node *node;
 193         struct sta *sta;
 194
 195         struct usteer_timeout timeout;
 196
 197         struct sta_info_stats stats[__EVENT_TYPE_MAX];
 198         uint64_t created;
 199         uint64_t seen;
 200         int signal;
 201
 202         enum roam_trigger_state roam_state;
 203         uint8_t roam_tries;
 204         uint64_t roam_event;
 205         uint64_t roam_kick;
 206         uint64_t roam_scan_done;
 207
 208         int kick_count;
 209
 210         uint8_t scan_band : 1;
 211         uint8_t connected : 2;
 212 };
 213
 214 struct sta {
 215         struct avl_node avl;
 216         struct list_head nodes;
 217
 218         uint8_t seen_2ghz : 1;
 219         uint8_t seen_5ghz : 1;
 220
 221         uint8_t addr[6];
 222 };
 223
 224 extern struct ubus_context *ubus_ctx;
 225 extern struct usteer_config config;
 226 extern struct list_head node_handlers;
 227 extern struct avl_tree stations;
 228 extern struct ubus_object usteer_obj;
 229 extern uint64_t current_time;
 230 extern const char * const event_types[__EVENT_TYPE_MAX];
 231 extern struct blob_attr *host_info_blob;
 232
 233 void usteer_update_time(void);
 234 void usteer_init_defaults(void);
 235 bool usteer_handle_sta_event(struct usteer_node *node, const uint8_t *addr,
 236                             enum usteer_event_type type, int freq, int signal);
 237
 238 void usteer_local_nodes_init(struct ubus_context *ctx);
 239 void usteer_local_node_kick(struct usteer_local_node *ln);
 240
 241 void usteer_ubus_init(struct ubus_context *ctx);
 242 void usteer_ubus_kick_client(struct sta_info *si);
 243 int usteer_ubus_trigger_client_scan(struct sta_info *si);
 244 int usteer_ubus_notify_client_disassoc(struct sta_info *si);
 245
 246 struct sta *usteer_sta_get(const uint8_t *addr, bool create);
 247 struct sta_info *usteer_sta_info_get(struct sta *sta, struct usteer_node *node, bool *create);
 248
 249 void usteer_sta_info_update_timeout(struct sta_info *si, int timeout);
 250 void usteer_sta_info_update(struct sta_info *si, int signal, bool avg);
 251
 252 static inline const char *usteer_node_name(struct usteer_node *node)
 253 {
 254         return node->avl.key;
 255 }
 256 void usteer_node_set_blob(struct blob_attr **dest, struct blob_attr *val);
 257
 258 bool usteer_check_request(struct sta_info *si, enum usteer_event_type type);
 259
 260 void config_set_interfaces(struct blob_attr *data);
 261 void config_get_interfaces(struct blob_buf *buf);
 262
 263 void config_set_node_up_script(struct blob_attr *data);
 264 void config_get_node_up_script(struct blob_buf *buf);
 265
 266 void config_set_ssid_list(struct blob_attr *data);
 267 void config_get_ssid_list(struct blob_buf *buf);
 268
 269 int usteer_interface_init(void);
 270 void usteer_interface_add(const char *name);
 271 void usteer_sta_node_cleanup(struct usteer_node *node);
 272 void usteer_send_sta_update(struct sta_info *si);
 273
 274 int usteer_lua_init(void);
 275 int usteer_lua_ubus_init(void);
 276 void usteer_run_hook(const char *name, const char *arg);
 277
 278 void usteer_dump_node(struct blob_buf *buf, struct usteer_node *node);
 279 void usteer_dump_host(struct blob_buf *buf, struct usteer_remote_host *host);
 280
 281 #endif