1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
|
/* $OpenBSD: ieee80211_mira.h,v 1.8 2020/03/03 21:09:35 tb Exp $ */
/*
* Copyright (c) 2016 Stefan Sperling <stsp@openbsd.org>
* Copyright (c) 2016 Theo Buehler <tb@openbsd.org>
*
* Permission to use, copy, modify, and distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
#ifndef _NET80211_IEEE80211_MIRA_H_
#define _NET80211_IEEE80211_MIRA_H_
/*
* MiRA - "MIMO Rate Adaptation in 802.11n Wireless Networks"
* Ioannis Pefkianakis, Yun Hu, Starsky H.Y. Wong, Hao Yang, Songwu Lu
* http://metro.cs.ucla.edu/papers/Pefkianakis.MOBICOM10.pdf
* https://doi.org/10.1145/1859995.1860025
*/
/*
* Goodput statistics struct. Measures the effective data rate of an MCS
* index and contains data related to time-based probing to a new rate.
* All uint64_t numbers in this struct use fixed-point arithmetic.
*/
struct ieee80211_mira_goodput_stats {
uint64_t measured; /* Most recently measured goodput. */
uint64_t average; /* Average measured goodput. */
uint64_t average_agg; /* Average number of subframes per frame. */
uint64_t stddeviation; /* Goodput standard deviation. */
/* These fields are used while calculating probe intervals: */
uint64_t loss; /* This rate's loss percentage SFER. */
uint32_t nprobes; /* Number of probe attempts. */
uint32_t nprobe_bytes; /* Number of bytes sent while probing. */
int probe_interval; /* Probe interval for this rate. */
int probe_timeout_triggered; /* It is time to probe this rate. */
};
/*
* Rate control state.
*/
struct ieee80211_mira_node {
/*
* Fields set by drivers before calling ieee80211_mira_choose().
*/
uint32_t frames; /* Increment per (sub-)frame transmitted. */
uint32_t retries; /* Increment per Tx retry (MiRA "nbad") */
uint32_t txfail; /* Increment per Tx failure (MiRA "retries") */
uint32_t ampdu_size; /* Length of last (aggregated) frame sent. */
uint32_t agglen; /* Number of subframes in last frame (1-64). */
/*
* Private fields for use by the rate control algorithm.
*/
/* Bitmaps MCS 0-31. */
uint32_t valid_rates;
uint32_t candidate_rates;
uint32_t probed_rates;
/* Timeouts which trigger time-driven probing. */
struct timeout probe_to[2];
#define IEEE80211_MIRA_PROBE_TO_INVALID -1
#define IEEE80211_MIRA_PROBE_TO_UP 0
#define IEEE80211_MIRA_PROBE_TO_DOWN 1
int probe_timer_expired[2];
/* Probing state. */
int probing;
#define IEEE80211_MIRA_NOT_PROBING 0x0
#define IEEE80211_MIRA_PROBING_DOWN 0x1
#define IEEE80211_MIRA_PROBING_UP 0x2
#define IEEE80211_MIRA_PROBING_INTER 0x4 /* combined with UP or DOWN */
/* The current best MCS found by probing. */
int best_mcs;
/* Goodput statistics for each MCS. */
struct ieee80211_mira_goodput_stats g[IEEE80211_HT_RATESET_NUM_MCS];
/* Interference observation window (see MiRA paper section 5.2). */
int ifwnd;
uint32_t ifwnd_frames;
uint32_t ifwnd_retries;
uint32_t ifwnd_txfail;
/* Current RTS threshold for this node. */
int rts_threshold;
};
/* Initialize rate control state. */
void ieee80211_mira_node_init(struct ieee80211_mira_node *);
/* Called by drivers from the Tx completion interrupt handler. */
void ieee80211_mira_choose(struct ieee80211_mira_node *,
struct ieee80211com *, struct ieee80211_node *);
/* Cancel timeouts scheduled by ieee80211_mira_choose(). */
void ieee80211_mira_cancel_timeouts(struct ieee80211_mira_node *);
/* Returns RTS threshold to be used for a frame about to be transmitted. */
int ieee80211_mira_get_rts_threshold(struct ieee80211_mira_node *,
struct ieee80211com *, struct ieee80211_node *, size_t);
/* Indicate whether Tx rates are currently being probed. */
int ieee80211_mira_is_probing(struct ieee80211_mira_node *);
/* Return the best MCS determined by the most recent probe. */
int ieee80211_mira_get_best_mcs(struct ieee80211_mira_node *);
#endif /* _NET80211_IEEE80211_MIRA_H_ */
|