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 enum usteer_sta_connection_state {
  58         STA_NOT_CONNECTED = 0,
  59         STA_CONNECTED = 1,
  60         STA_DISCONNECTED = 2,
  61 };
  62
  63 enum usteer_beacon_measurement_mode {
  64         BEACON_MEASUREMENT_PASSIVE = 0,
  65         BEACON_MEASUREMENT_ACTIVE = 1,
  66         BEACON_MEASUREMENT_TABLE = 2,
  67 };
  68
  69 struct sta_info;
  70 struct usteer_local_node;
  71 struct usteer_remote_host;
  72
  73 struct usteer_node {
  74         struct avl_node avl;
  75         struct list_head sta_info;
  76
  77         enum usteer_node_type type;
  78
  79         struct blob_attr *rrm_nr;
  80         struct blob_attr *node_info;
  81         char ssid[33];
  82         uint8_t bssid[6];
  83
  84         bool disabled;
  85         int freq;
  86         int noise;
  87         int n_assoc;
  88         int max_assoc;
  89         int load;
  90 };
  91
  92 struct usteer_scan_request {
  93         int n_freq;
  94         int *freq;
  95
  96         bool passive;
  97 };
  98
  99 struct usteer_scan_result {
 100         uint8_t bssid[6];
 101         char ssid[33];
 102
 103         int freq;
 104         int signal;
 105 };
 106
 107 struct usteer_survey_data {
 108         uint16_t freq;
 109         int8_t noise;
 110
 111         uint64_t time;
 112         uint64_t time_busy;
 113 };
 114
 115 struct usteer_freq_data {
 116         uint16_t freq;
 117
 118         uint8_t txpower;
 119         bool dfs;
 120 };
 121
 122 struct usteer_node_handler {
 123         struct list_head list;
 124
 125         void (*init_node)(struct usteer_node *);
 126         void (*free_node)(struct usteer_node *);
 127         void (*update_node)(struct usteer_node *);
 128         void (*update_sta)(struct usteer_node *, struct sta_info *);
 129         void (*get_survey)(struct usteer_node *, void *,
 130                            void (*cb)(void *priv, struct usteer_survey_data *d));
 131         void (*get_freqlist)(struct usteer_node *, void *,
 132                              void (*cb)(void *priv, struct usteer_freq_data *f));
 133         int (*scan)(struct usteer_node *, struct usteer_scan_request *,
 134                     void *, void (*cb)(void *priv, struct usteer_scan_result *r));
 135 };
 136
 137 struct usteer_config {
 138         bool syslog;
 139         uint32_t debug_level;
 140
 141         bool ipv6;
 142
 143         uint32_t sta_block_timeout;
 144         uint32_t local_sta_timeout;
 145         uint32_t local_sta_update;
 146
 147         uint32_t max_retry_band;
 148         uint32_t seen_policy_timeout;
 149
 150         bool assoc_steering;
 151
 152         uint32_t band_steering_threshold;
 153         uint32_t load_balancing_threshold;
 154
 155         uint32_t remote_update_interval;
 156         uint32_t remote_node_timeout;
 157
 158         int32_t min_snr;
 159         int32_t min_connect_snr;
 160         uint32_t signal_diff_threshold;
 161
 162         int32_t roam_scan_snr;
 163         uint32_t roam_scan_tries;
 164         uint32_t roam_scan_interval;
 165
 166         int32_t roam_trigger_snr;
 167         uint32_t roam_trigger_interval;
 168
 169         uint32_t roam_kick_delay;
 170
 171         uint32_t initial_connect_delay;
 172
 173         bool load_kick_enabled;
 174         uint32_t load_kick_threshold;
 175         uint32_t load_kick_delay;
 176         uint32_t load_kick_min_clients;
 177         uint32_t load_kick_reason_code;
 178
 179         const char *node_up_script;
 180         uint32_t event_log_mask;
 181
 182         struct blob_attr *ssid_list;
 183 };
 184
 185 struct sta_info_stats {
 186         uint32_t requests;
 187         uint32_t blocked_cur;
 188         uint32_t blocked_total;
 189         uint32_t blocked_last_time;
 190 };
 191
 192 enum roam_trigger_state {
 193         ROAM_TRIGGER_IDLE,
 194         ROAM_TRIGGER_SCAN,
 195         ROAM_TRIGGER_SCAN_DONE,
 196         ROAM_TRIGGER_WAIT_KICK,
 197         ROAM_TRIGGER_NOTIFY_KICK,
 198         ROAM_TRIGGER_KICK,
 199 };
 200
 201 struct sta_info {
 202         struct list_head list;
 203         struct list_head node_list;
 204
 205         struct usteer_node *node;
 206         struct sta *sta;
 207
 208         struct usteer_timeout timeout;
 209
 210         struct sta_info_stats stats[__EVENT_TYPE_MAX];
 211         uint64_t created;
 212         uint64_t seen;
 213         int signal;
 214
 215         enum roam_trigger_state roam_state;
 216         uint8_t roam_tries;
 217         uint64_t roam_event;
 218         uint64_t roam_kick;
 219         uint64_t roam_scan_done;
 220
 221         int kick_count;
 222
 223         uint8_t scan_band : 1;
 224         uint8_t connected : 2;
 225 };
 226
 227 struct sta {
 228         struct avl_node avl;
 229         struct list_head nodes;
 230
 231         uint8_t seen_2ghz : 1;
 232         uint8_t seen_5ghz : 1;
 233
 234         uint8_t addr[6];
 235 };
 236
 237 extern struct ubus_context *ubus_ctx;
 238 extern struct usteer_config config;
 239 extern struct list_head node_handlers;
 240 extern struct avl_tree stations;
 241 extern struct ubus_object usteer_obj;
 242 extern uint64_t current_time;
 243 extern const char * const event_types[__EVENT_TYPE_MAX];
 244 extern struct blob_attr *host_info_blob;
 245
 246 void usteer_update_time(void);
 247 void usteer_init_defaults(void);
 248 bool usteer_handle_sta_event(struct usteer_node *node, const uint8_t *addr,
 249                             enum usteer_event_type type, int freq, int signal);
 250
 251 void usteer_local_nodes_init(struct ubus_context *ctx);
 252 void usteer_local_node_kick(struct usteer_local_node *ln);
 253
 254 void usteer_ubus_init(struct ubus_context *ctx);
 255 void usteer_ubus_kick_client(struct sta_info *si);
 256 int usteer_ubus_trigger_client_scan(struct sta_info *si);
 257 int usteer_ubus_notify_client_disassoc(struct sta_info *si);
 258
 259 struct sta *usteer_sta_get(const uint8_t *addr, bool create);
 260 struct sta_info *usteer_sta_info_get(struct sta *sta, struct usteer_node *node, bool *create);
 261
 262 void usteer_sta_info_update_timeout(struct sta_info *si, int timeout);
 263 void usteer_sta_info_update(struct sta_info *si, int signal, bool avg);
 264
 265 static inline const char *usteer_node_name(struct usteer_node *node)
 266 {
 267         return node->avl.key;
 268 }
 269 void usteer_node_set_blob(struct blob_attr **dest, struct blob_attr *val);
 270
 271 bool usteer_check_request(struct sta_info *si, enum usteer_event_type type);
 272
 273 void config_set_interfaces(struct blob_attr *data);
 274 void config_get_interfaces(struct blob_buf *buf);
 275
 276 void config_set_node_up_script(struct blob_attr *data);
 277 void config_get_node_up_script(struct blob_buf *buf);
 278
 279 void config_set_ssid_list(struct blob_attr *data);
 280 void config_get_ssid_list(struct blob_buf *buf);
 281
 282 int usteer_interface_init(void);
 283 void usteer_interface_add(const char *name);
 284 void usteer_sta_node_cleanup(struct usteer_node *node);
 285 void usteer_send_sta_update(struct sta_info *si);
 286
 287 int usteer_lua_init(void);
 288 int usteer_lua_ubus_init(void);
 289 void usteer_run_hook(const char *name, const char *arg);
 290
 291 void usteer_dump_node(struct blob_buf *buf, struct usteer_node *node);
 292 void usteer_dump_host(struct blob_buf *buf, struct usteer_remote_host *host);
 293
 294 #endif