Coverage Report

Created: 2025-07-11 06:14

/src/hostap/wpa_supplicant/bss.h
Line
Count
Source (jump to first uncovered line)
1
/*
2
 * BSS table
3
 * Copyright (c) 2009-2019, Jouni Malinen <j@w1.fi>
4
 *
5
 * This software may be distributed under the terms of the BSD license.
6
 * See README for more details.
7
 */
8
9
#ifndef BSS_H
10
#define BSS_H
11
12
struct wpa_scan_res;
13
14
#define WPA_BSS_QUAL_INVALID    BIT(0)
15
#define WPA_BSS_NOISE_INVALID   BIT(1)
16
#define WPA_BSS_LEVEL_INVALID   BIT(2)
17
#define WPA_BSS_LEVEL_DBM   BIT(3)
18
#define WPA_BSS_AUTHENTICATED   BIT(4)
19
0
#define WPA_BSS_ASSOCIATED    BIT(5)
20
0
#define WPA_BSS_ANQP_FETCH_TRIED  BIT(6)
21
#define WPA_BSS_OWE_TRANSITION    BIT(7)
22
23
0
#define WPA_BSS_FREQ_CHANGED_FLAG BIT(0)
24
0
#define WPA_BSS_SIGNAL_CHANGED_FLAG BIT(1)
25
0
#define WPA_BSS_PRIVACY_CHANGED_FLAG  BIT(2)
26
0
#define WPA_BSS_MODE_CHANGED_FLAG BIT(3)
27
0
#define WPA_BSS_WPAIE_CHANGED_FLAG  BIT(4)
28
0
#define WPA_BSS_RSNIE_CHANGED_FLAG  BIT(5)
29
0
#define WPA_BSS_WPS_CHANGED_FLAG  BIT(6)
30
0
#define WPA_BSS_RATES_CHANGED_FLAG  BIT(7)
31
0
#define WPA_BSS_IES_CHANGED_FLAG  BIT(8)
32
33
struct wpa_bss_anqp_elem {
34
  struct dl_list list;
35
  u16 infoid;
36
  bool protected_response; /* received in a protected GAS response */
37
  struct wpabuf *payload;
38
};
39
40
/**
41
 * struct wpa_bss_anqp - ANQP data for a BSS entry (struct wpa_bss)
42
 */
43
struct wpa_bss_anqp {
44
  /** Number of BSS entries referring to this ANQP data instance */
45
  unsigned int users;
46
#ifdef CONFIG_INTERWORKING
47
  struct wpabuf *capability_list;
48
  struct wpabuf *venue_name;
49
  struct wpabuf *network_auth_type;
50
  struct wpabuf *roaming_consortium;
51
  struct wpabuf *ip_addr_type_availability;
52
  struct wpabuf *nai_realm;
53
  struct wpabuf *anqp_3gpp;
54
  struct wpabuf *domain_name;
55
  struct wpabuf *fils_realm_info;
56
  struct dl_list anqp_elems; /* list of struct wpa_bss_anqp_elem */
57
#endif /* CONFIG_INTERWORKING */
58
#ifdef CONFIG_HS20
59
  struct wpabuf *hs20_capability_list;
60
  struct wpabuf *hs20_operator_friendly_name;
61
  struct wpabuf *hs20_wan_metrics;
62
  struct wpabuf *hs20_connection_capability;
63
  struct wpabuf *hs20_operating_class;
64
#endif /* CONFIG_HS20 */
65
};
66
67
/**
68
 * struct wpa_bss - BSS table
69
 *
70
 * This structure is used to store information about neighboring BSSes in
71
 * generic format. It is mainly updated based on scan results from the driver.
72
 */
73
struct wpa_bss {
74
  /** List entry for struct wpa_supplicant::bss */
75
  struct dl_list list;
76
  /** List entry for struct wpa_supplicant::bss_id */
77
  struct dl_list list_id;
78
  /** Unique identifier for this BSS entry */
79
  unsigned int id;
80
  /** Number of counts without seeing this BSS */
81
  unsigned int scan_miss_count;
82
  /** Index of the last scan update */
83
  unsigned int last_update_idx;
84
  /** Information flags about the BSS/IBSS (WPA_BSS_*) */
85
  unsigned int flags;
86
  /** BSSID */
87
  u8 bssid[ETH_ALEN];
88
  /** HESSID */
89
  u8 hessid[ETH_ALEN];
90
  /** SSID */
91
  u8 ssid[SSID_MAX_LEN];
92
  /** Length of SSID */
93
  size_t ssid_len;
94
  /** Frequency of the channel in MHz (e.g., 2412 = channel 1) */
95
  int freq;
96
  /** The max channel width supported by both the AP and the STA */
97
  enum chan_width max_cw;
98
  /** Beacon interval in TUs (host byte order) */
99
  u16 beacon_int;
100
  /** Capability information field in host byte order */
101
  u16 caps;
102
  /** Signal quality */
103
  int qual;
104
  /** Noise level */
105
  int noise;
106
  /** Signal level */
107
  int level;
108
  /** Timestamp of last Beacon/Probe Response frame */
109
  u64 tsf;
110
  /** Whether the Beacon frame data is known to be newer */
111
  bool beacon_newer;
112
  /** Time of the last update (i.e., Beacon or Probe Response RX) */
113
  struct os_reltime last_update;
114
  /** Estimated throughput in kbps */
115
  unsigned int est_throughput;
116
  /** Signal-to-noise ratio in dB */
117
  int snr;
118
  /** ANQP data */
119
  struct wpa_bss_anqp *anqp;
120
  /** Length of the following IE field in octets (from Probe Response) */
121
  size_t ie_len;
122
  /** Length of the following Beacon IE field in octets */
123
  size_t beacon_ie_len;
124
  /** MLD address of the AP */
125
  u8 mld_addr[ETH_ALEN];
126
  /** Link ID of this affiliated AP of the AP MLD */
127
  u8 mld_link_id;
128
129
  /** An array of MLD links */
130
  u16 valid_links;
131
  struct mld_link {
132
    u8 bssid[ETH_ALEN];
133
    int freq;
134
135
    /* Whether the link is valid but currently disabled */
136
    bool disabled;
137
  } mld_links[MAX_NUM_MLD_LINKS];
138
139
  /* followed by ie_len octets of IEs */
140
  /* followed by beacon_ie_len octets of IEs */
141
  u8 ies[];
142
};
143
144
static inline const u8 * wpa_bss_ie_ptr(const struct wpa_bss *bss)
145
2.37k
{
146
2.37k
  return bss->ies;
147
2.37k
}
bss.c:wpa_bss_ie_ptr
Line
Count
Source
145
2.37k
{
146
2.37k
  return bss->ies;
147
2.37k
}
Unexecuted instantiation: events.c:wpa_bss_ie_ptr
Unexecuted instantiation: hs20_supplicant.c:wpa_bss_ie_ptr
Unexecuted instantiation: interworking.c:wpa_bss_ie_ptr
Unexecuted instantiation: notify.c:wpa_bss_ie_ptr
Unexecuted instantiation: op_classes.c:wpa_bss_ie_ptr
Unexecuted instantiation: robust_av.c:wpa_bss_ie_ptr
Unexecuted instantiation: rrm.c:wpa_bss_ie_ptr
Unexecuted instantiation: scan.c:wpa_bss_ie_ptr
Unexecuted instantiation: wmm_ac.c:wpa_bss_ie_ptr
Unexecuted instantiation: wnm_sta.c:wpa_bss_ie_ptr
Unexecuted instantiation: wpa_supplicant.c:wpa_bss_ie_ptr
Unexecuted instantiation: wpas_glue.c:wpa_bss_ie_ptr
Unexecuted instantiation: wnm.c:wpa_bss_ie_ptr
148
149
void notify_bss_changes(struct wpa_supplicant *wpa_s, u32 changes,
150
      const struct wpa_bss *bss);
151
void wpa_bss_update_start(struct wpa_supplicant *wpa_s);
152
void wpa_bss_update_scan_res(struct wpa_supplicant *wpa_s,
153
           struct wpa_scan_res *res,
154
           struct os_reltime *fetch_time);
155
void wpa_bss_remove(struct wpa_supplicant *wpa_s, struct wpa_bss *bss,
156
        const char *reason);
157
void wpa_bss_update_end(struct wpa_supplicant *wpa_s, struct scan_info *info,
158
      int new_scan);
159
int wpa_bss_init(struct wpa_supplicant *wpa_s);
160
void wpa_bss_deinit(struct wpa_supplicant *wpa_s);
161
void wpa_bss_flush(struct wpa_supplicant *wpa_s);
162
void wpa_bss_flush_by_age(struct wpa_supplicant *wpa_s, int age);
163
struct wpa_bss * wpa_bss_get(struct wpa_supplicant *wpa_s, const u8 *bssid,
164
           const u8 *ssid, size_t ssid_len);
165
struct wpa_bss * wpa_bss_get_connection(struct wpa_supplicant *wpa_s,
166
          const u8 *bssid,
167
          const u8 *ssid, size_t ssid_len);
168
struct wpa_bss * wpa_bss_get_bssid(struct wpa_supplicant *wpa_s,
169
           const u8 *bssid);
170
struct wpa_bss * wpa_bss_get_bssid_latest(struct wpa_supplicant *wpa_s,
171
            const u8 *bssid);
172
struct wpa_bss * wpa_bss_get_p2p_dev_addr(struct wpa_supplicant *wpa_s,
173
            const u8 *dev_addr);
174
struct wpa_bss * wpa_bss_get_id(struct wpa_supplicant *wpa_s, unsigned int id);
175
struct wpa_bss * wpa_bss_get_id_range(struct wpa_supplicant *wpa_s,
176
              unsigned int idf, unsigned int idl);
177
const u8 * wpa_bss_get_ie(const struct wpa_bss *bss, u8 ie);
178
const u8 * wpa_bss_get_ie_beacon(const struct wpa_bss *bss, u8 ie);
179
const u8 * wpa_bss_get_ie_ext(const struct wpa_bss *bss, u8 ext);
180
const u8 * wpa_bss_get_vendor_ie(const struct wpa_bss *bss, u32 vendor_type);
181
const u8 * wpa_bss_get_vendor_ie_beacon(const struct wpa_bss *bss,
182
          u32 vendor_type);
183
struct wpabuf * wpa_bss_get_vendor_ie_multi(const struct wpa_bss *bss,
184
              u32 vendor_type);
185
struct wpabuf * wpa_bss_get_vendor_ie_multi_beacon(const struct wpa_bss *bss,
186
               u32 vendor_type);
187
int wpa_bss_get_max_rate(const struct wpa_bss *bss);
188
int wpa_bss_get_bit_rates(const struct wpa_bss *bss, u8 **rates);
189
struct wpa_bss_anqp * wpa_bss_anqp_alloc(void);
190
int wpa_bss_anqp_unshare_alloc(struct wpa_bss *bss);
191
const u8 * wpa_bss_get_fils_cache_id(const struct wpa_bss *bss);
192
int wpa_bss_ext_capab(const struct wpa_bss *bss, unsigned int capab);
193
194
static inline int bss_is_dmg(const struct wpa_bss *bss)
195
0
{
196
0
  return bss->freq > 45000;
197
0
}
Unexecuted instantiation: bss.c:bss_is_dmg
Unexecuted instantiation: events.c:bss_is_dmg
Unexecuted instantiation: hs20_supplicant.c:bss_is_dmg
Unexecuted instantiation: interworking.c:bss_is_dmg
Unexecuted instantiation: notify.c:bss_is_dmg
Unexecuted instantiation: op_classes.c:bss_is_dmg
Unexecuted instantiation: robust_av.c:bss_is_dmg
Unexecuted instantiation: rrm.c:bss_is_dmg
Unexecuted instantiation: scan.c:bss_is_dmg
Unexecuted instantiation: wmm_ac.c:bss_is_dmg
Unexecuted instantiation: wnm_sta.c:bss_is_dmg
Unexecuted instantiation: wpa_supplicant.c:bss_is_dmg
Unexecuted instantiation: wpas_glue.c:bss_is_dmg
Unexecuted instantiation: wnm.c:bss_is_dmg
198
199
/**
200
 * Test whether a BSS is a PBSS.
201
 * This checks whether a BSS is a DMG-band PBSS. PBSS is used for P2P DMG
202
 * network.
203
 */
204
static inline int bss_is_pbss(struct wpa_bss *bss)
205
0
{
206
0
  return bss_is_dmg(bss) &&
207
0
    (bss->caps & IEEE80211_CAP_DMG_MASK) == IEEE80211_CAP_DMG_PBSS;
208
0
}
Unexecuted instantiation: bss.c:bss_is_pbss
Unexecuted instantiation: events.c:bss_is_pbss
Unexecuted instantiation: hs20_supplicant.c:bss_is_pbss
Unexecuted instantiation: interworking.c:bss_is_pbss
Unexecuted instantiation: notify.c:bss_is_pbss
Unexecuted instantiation: op_classes.c:bss_is_pbss
Unexecuted instantiation: robust_av.c:bss_is_pbss
Unexecuted instantiation: rrm.c:bss_is_pbss
Unexecuted instantiation: scan.c:bss_is_pbss
Unexecuted instantiation: wmm_ac.c:bss_is_pbss
Unexecuted instantiation: wnm_sta.c:bss_is_pbss
Unexecuted instantiation: wpa_supplicant.c:bss_is_pbss
Unexecuted instantiation: wpas_glue.c:bss_is_pbss
Unexecuted instantiation: wnm.c:bss_is_pbss
209
210
static inline void wpa_bss_update_level(struct wpa_bss *bss, int new_level)
211
0
{
212
0
  if (bss != NULL && new_level > -WPA_INVALID_NOISE && new_level < 0)
213
0
    bss->level = new_level;
214
0
}
Unexecuted instantiation: bss.c:wpa_bss_update_level
Unexecuted instantiation: events.c:wpa_bss_update_level
Unexecuted instantiation: hs20_supplicant.c:wpa_bss_update_level
Unexecuted instantiation: interworking.c:wpa_bss_update_level
Unexecuted instantiation: notify.c:wpa_bss_update_level
Unexecuted instantiation: op_classes.c:wpa_bss_update_level
Unexecuted instantiation: robust_av.c:wpa_bss_update_level
Unexecuted instantiation: rrm.c:wpa_bss_update_level
Unexecuted instantiation: scan.c:wpa_bss_update_level
Unexecuted instantiation: wmm_ac.c:wpa_bss_update_level
Unexecuted instantiation: wnm_sta.c:wpa_bss_update_level
Unexecuted instantiation: wpa_supplicant.c:wpa_bss_update_level
Unexecuted instantiation: wpas_glue.c:wpa_bss_update_level
Unexecuted instantiation: wnm.c:wpa_bss_update_level
215
216
void calculate_update_time(const struct os_reltime *fetch_time,
217
         unsigned int age_ms,
218
         struct os_reltime *update_time);
219
220
int wpa_bss_parse_basic_ml_element(struct wpa_supplicant *wpa_s,
221
           struct wpa_bss *bss,
222
           u8 *ap_mld_addr,
223
           u16 *missing_links,
224
           struct wpa_ssid *ssid,
225
           u8 *ap_mld_id);
226
u16 wpa_bss_parse_reconf_ml_element(struct wpa_supplicant *wpa_s,
227
            struct wpa_bss *bss);
228
229
const u8 * wpa_bss_get_rsne(struct wpa_supplicant *wpa_s,
230
          const struct wpa_bss *bss, struct wpa_ssid *ssid,
231
          bool mlo);
232
const u8 * wpa_bss_get_rsnxe(struct wpa_supplicant *wpa_s,
233
           const struct wpa_bss *bss, struct wpa_ssid *ssid,
234
           bool mlo);
235
236
#endif /* BSS_H */