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