DAWN/src/include/datastorage.h

#ifndef __DAWN_DATASTORAGE_H
#define __DAWN_DATASTORAGE_H

#include <pthread.h>
#include <stdint.h>
#include <time.h>
#include <limits.h>

#include "ieee80211_utils.h"
#include "mac_utils.h"
#include "utils.h"

/* Mac */

// ---------------- Defines -------------------

// ---------------- Global variables ----------------
extern struct mac_entry_s *mac_set;

struct mac_entry_s {
    struct mac_entry_s* next_mac;
    struct dawn_mac mac;
};

// ---------------- Functions ----------
void insert_macs_from_file();

struct mac_entry_s* insert_to_maclist(struct dawn_mac mac);

struct mac_entry_s* mac_find_entry(struct dawn_mac mac);

struct mac_entry_s* insert_to_mac_array(struct mac_entry_s* entry);

void mac_array_delete(struct mac_entry_s* entry);

int get_band(int freq);

// ---------------- Global variables ----------------
/*** Metrics and configuration data ***/

// TODO: Define a proper version string
#ifndef DAWN_CONFIG_VERSION
#define DAWN_CONFIG_VERSION "3"
#endif

// Band definitions
// Keep them sorted by frequency, in ascending order
enum dawn_bands {
    DAWN_BAND_80211G,
    DAWN_BAND_80211A,
    __DAWN_BAND_MAX
};

// config section name
extern const char *band_config_name[__DAWN_BAND_MAX];

// starting frequency
// TODO: make this configurable
extern const int max_band_freq[__DAWN_BAND_MAX];

// ---------------- Structs ----------------
struct probe_metric_s {
    // Global Configuration
    int min_probe_count;
    int bandwidth_threshold; // kick_clients()
    int use_station_count; // better_ap_available()
    int max_station_diff; // compare_station_count() <- better_ap_available()
    int eval_probe_req;
    int eval_auth_req;
    int eval_assoc_req;
    int deny_auth_reason;
    int deny_assoc_reason;
    int min_number_to_kick; // kick_clients()
    int chan_util_avg_period;
    int set_hostapd_nr;
    int disassoc_nr_length; // FIXME: Is there a standard for how many?  Use 6 as default to suit iOS.
    int kicking;
    int kicking_threshold;
    int duration;
    int rrm_mode_mask;
    int rrm_mode_order[__RRM_BEACON_RQST_MODE_MAX];

    // Per-band Configuration
    int initial_score[__DAWN_BAND_MAX]; // eval_probe_metric()()
    int ap_weight[__DAWN_BAND_MAX]; // TODO: Never evaluated?
    int ht_support[__DAWN_BAND_MAX]; // eval_probe_metric()()
    int vht_support[__DAWN_BAND_MAX]; // eval_probe_metric()()
    int no_ht_support[__DAWN_BAND_MAX]; // eval_probe_metric()()
    int no_vht_support[__DAWN_BAND_MAX]; // eval_probe_metric()()
    int rssi[__DAWN_BAND_MAX]; // eval_probe_metric()()
    int low_rssi[__DAWN_BAND_MAX]; // eval_probe_metric()()
    int chan_util[__DAWN_BAND_MAX]; // eval_probe_metric()()
    int max_chan_util[__DAWN_BAND_MAX]; // eval_probe_metric()()
    int rssi_val[__DAWN_BAND_MAX]; // eval_probe_metric()()
    int low_rssi_val[__DAWN_BAND_MAX]; // eval_probe_metric()()
    int chan_util_val[__DAWN_BAND_MAX]; // eval_probe_metric()()
    int max_chan_util_val[__DAWN_BAND_MAX]; // eval_probe_metric()()
    int rssi_weight[__DAWN_BAND_MAX]; // eval_probe_metric()()
    int rssi_center[__DAWN_BAND_MAX]; // eval_probe_metric()()
    struct mac_entry_s* neighbors[__DAWN_BAND_MAX]; // ap_get_nr()
};

struct time_config_s {
    time_t update_client; // Query locally connected clients
    time_t remove_client; // Delete aged client records
    time_t remove_probe; // Delete aged PROBE / BEACON records
    time_t remove_ap; // Delete aged AP records
    time_t update_hostapd; // Refresh wifi radio / SSID data from hostapd
    time_t update_tcp_con; // Refresh network connections
    time_t update_chan_util; // Refresh per radio / SSID channel util info
    time_t update_beacon_reports; // Request BEACON from capable clients
    time_t con_timeout; // Check for connection timeouts.
};

struct local_config_s {
    int loglevel; // Select the level of messgae in syslog
};

// FIXME: Are these with or without NUL terminator?  Adjust values, string allocation and strncpy() to agree.
#define MAX_IP_LENGTH 46
#define MAX_KEY_LENGTH 65

struct network_config_s {
    char broadcast_ip[MAX_IP_LENGTH + 1];
    int broadcast_port;
    char server_ip[MAX_IP_LENGTH + 1];
    char tcp_ip[MAX_IP_LENGTH + 1];
    int tcp_port;
    int network_option; // 0:Broadcast; 1:Multicast; 2:TCP+UMDNS; 3:TCP
    char shared_key[MAX_KEY_LENGTH + 1];
    char iv[MAX_KEY_LENGTH + 1];
    int use_symm_enc;
    int collision_domain;
    int bandwidth;
};

extern struct network_config_s network_config;
extern struct time_config_s timeout_config;
extern struct local_config_s local_config;
extern struct probe_metric_s dawn_metric;

/*** Core DAWN data structures for tracking network devices and status ***/

// TODO notes:
//    Never used? = No code reference
//    Never evaluated? = Set and passed in ubus, etc but never evaluated for outcomes

/* Probe, Auth, Assoc */

#define SSID_MAX_LEN 32

// ---------------- Structs ----------------
typedef struct probe_entry_s {
// List admin fields
    struct probe_entry_s* next_probe;
    struct probe_entry_s* next_probe_skip;
    time_t rssi_timestamp; // remove_old...entries
    time_t rcpi_timestamp; // remove_old...entries

// Connection accept / reject decision fields
    int counter; // FIXME: Never gets reset to zero.  Rely on deletion to create new for non-802.11k client?

// Client status reporting fields
    struct dawn_mac client_addr;
    struct dawn_mac bssid_addr;
    uint32_t signal; // eval_probe_metric()
    uint32_t freq; // eval_probe_metric()
    uint8_t ht_capabilities; // eval_probe_metric()
    uint8_t vht_capabilities; // eval_probe_metric()
    uint32_t rcpi;
    uint32_t rsni;

// FIXME: Historic fields - consider removing
    struct dawn_mac target_addr; // TODO: Never evaluated?
    uint8_t max_supp_datarate; // TODO: Never used?
    uint8_t min_supp_datarate; // TODO: Never used?
    int deny_counter; // TODO: Never used?
} probe_entry;

//struct probe_entry_s {
//    struct dawn_mac client_addr;
//    struct dawn_mac bssid_addr;
//    struct probe_entry_s* entry;
//};

typedef struct client_req_entry_s {
    // struct client_req_entry_s* next_deny;
    struct dawn_mac bssid_addr;
    struct dawn_mac client_addr;
    struct dawn_mac target_addr; // TODO: Never evaluated?
    uint32_t signal; // TODO: Never evaluated?
    uint32_t freq; // TODO: Never evaluated?
    time_t time; // Never used for removal?
    int counter;
} client_req_entry;

typedef struct hostapd_notify_entry_s {
    struct dawn_mac bssid_addr;
    struct dawn_mac client_addr;
} hostapd_notify_entry;

// ---------------- Defines ----------------
// FIXME: Is this enough of the NR to allow 802.11 operations to work?  Should we go for max possible length of 256 * 2 + 1
#define NEIGHBOR_REPORT_LEN 200
/* Neighbor report string elements
 * [Elemen ID|1][LENGTH|1][BSSID|6][BSSID INFORMATION|4][Operating Class|1][Channel Number|1][PHY Type|1][Operational Subelements]
 * first two bytes are not stored
 */
#define NR_BSSID         0
#define NR_BSSID_INFO   12
#define NR_OP_CLASS     20
#define NR_CHANNEL      22
#define NR_PHY          24

// ---------------- Global variables ----------------
struct probe_head_s {
    int node_count;
    int skip_count;
    int skip_ratio;

    struct probe_entry_s* first_probe;
    struct probe_entry_s* first_probe_skip;
};

extern struct probe_head_s probe_set;
extern pthread_mutex_t probe_array_mutex;

/* AP, Client */

#define SIGNATURE_LEN 1024
#define MAX_INTERFACE_NAME 64

// ---------------- Structs ----------------
typedef struct client_s {
    struct client_s* next_entry_bc;
    struct dawn_mac bssid_addr;
    struct dawn_mac client_addr;
    char signature[SIGNATURE_LEN]; // TODO: Never evaluated?
    uint8_t ht_supported; // TODO: Never evaluated?
    uint8_t vht_supported; // TODO: Never evaluated?
    uint32_t freq; // ap_get_nr()
    uint8_t auth; // TODO: Never evaluated?
    uint8_t assoc; // TODO: Never evaluated?
    uint8_t authorized; // TODO: Never evaluated?
    uint8_t preauth; // TODO: Never evaluated?
    uint8_t wds; // TODO: Never evaluated?
    uint8_t wmm;  // TODO: Never evaluated?
    uint8_t ht; // TODO: Never evaluated?
    uint8_t vht; // TODO: Never evaluated?
    uint8_t wps; // TODO: Never evaluated?
    uint8_t mfp; // TODO: Never evaluated?
    time_t time; // remove_old...entries
    uint32_t aid; // TODO: Never evaluated?
    uint32_t kick_count; // kick_clients()
    uint8_t rrm_enabled_capa; //the first byte is enough
} client;

// (1) Set in parse_to_clients()
// (2) Set by list insert operations
typedef struct ap_s {
    struct ap_s* next_ap; // (2)
    struct dawn_mac bssid_addr; // (1)
    uint32_t freq; // ap_get_nr() // (1)
    uint8_t ht_support; // eval_probe_metric() // (1)
    uint8_t vht_support; // eval_probe_metric() // (1)
    uint32_t channel_utilization; // eval_probe_metric() // (1)
    time_t time; // remove_old...entries // (2)
    uint32_t station_count; // compare_station_count() <- better_ap_available() // (1)
    uint8_t ssid[SSID_MAX_LEN + 1]; // compare_sid() < -better_ap_available() // (1)
    char neighbor_report[NEIGHBOR_REPORT_LEN + 1]; // (1)  // This is the self-NR of the AP
    uint32_t op_class; // ubus_send_beacon_report() // (1)
    uint32_t channel; // ubus_send_beacon_report() // (1)
    uint32_t ap_weight; // eval_probe_metric() // (1)
    char iface[MAX_INTERFACE_NAME]; // (1)
    char hostname[HOST_NAME_MAX]; // (1)
} ap;

// ---------------- Defines ----------------
#define TIME_THRESHOLD_AP 30

#define TIME_THRESHOLD_CLIENT 30
#define TIME_THRESHOLD_CLIENT_UPDATE 10
#define TIME_THRESHOLD_CLIENT_KICK 60

// ---------------- Global variables ----------------
extern struct ap_s* ap_set;
extern int ap_entry_last;
extern pthread_mutex_t ap_array_mutex;

extern struct client_s *client_set_bc;
extern pthread_mutex_t client_array_mutex;

// ---------------- Functions ----------------
probe_entry *insert_to_probe_array(probe_entry *entry, int inc_probe_count, int is_beacon, time_t expiry);

int probe_array_delete(struct dawn_mac client_addr, struct dawn_mac bssid_addr);

probe_entry* probe_array_find_first_entry(struct dawn_mac client_mac, struct dawn_mac bssid_mac, int do_bssid);

probe_entry *probe_array_get_entry(struct dawn_mac client_addr, struct dawn_mac bssid_addr);

void remove_old_probe_entries(time_t current_time, long long int threshold);

void print_probe_array();

void print_probe_entry(int level, probe_entry *entry);

int eval_probe_metric(struct probe_entry_s * probe_entry, ap *ap_entry);

void print_client_req_entry(int level, client_req_entry *entry);

// ---------------- Functions ----------------

probe_entry* probe_array_update_rssi(struct dawn_mac client_addr, ap* this_ap, uint32_t rssi, int send_network);

void remove_old_client_entries(time_t current_time, long long int threshold);

client* client_array_update_entry(client* entry, time_t expiry);

client *insert_client_to_array(client *entry, time_t expiry);

int kick_clients(struct dawn_mac bssid, uint32_t id);

void update_iw_info(struct dawn_mac bssid);

client** client_find_first_bc_entry(struct dawn_mac bssid_mac, struct dawn_mac client_mac, int do_client);

client *client_array_get_client(const struct dawn_mac client_addr);

client *client_array_delete_bc(struct dawn_mac bssid_mac, struct dawn_mac client_mac);

client *client_array_delete(client *entry, int unlink_only);

void print_client_array();

void print_client_entry(int level, client *entry);

ap *insert_to_ap_array(ap *entry, time_t expiry);

void remove_old_ap_entries(time_t current_time, long long int threshold);

void print_ap_array();

ap *ap_array_get_ap(struct dawn_mac bssid_mac);

int probe_array_set_all_probe_count(struct dawn_mac client_addr, uint32_t probe_count);

//int ap_get_collision_count(int col_domain);
void send_beacon_requests(ap* h, ap* a, int id);

/* Utils */
struct kicking_nr {
    ap *nr_ap;
    int score;
    struct kicking_nr *next;
};

// ---------------- Functions -------------------
int better_ap_available(ap *kicking_ap, probe_entry *own_probe, int own_score, struct kicking_nr** neighbor_report);

// All users of datastorage should call init_ / destroy_mutex at initialisation and termination respectively
int init_mutex();
void destroy_mutex();
#endif