A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
wifi-information-element.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2010 Dean Armstrong
3 *
4 * SPDX-License-Identifier: GPL-2.0-only
5 *
6 * Author: Dean Armstrong <deanarm@gmail.com>
7 */
8
9#ifndef WIFI_INFORMATION_ELEMENT_H
10#define WIFI_INFORMATION_ELEMENT_H
11
12#include "ns3/header.h"
13
14#include <optional>
15
16namespace ns3
17{
18
19/// Size in bytes of the Element ID Extension field (IEEE 802.11-2020 9.4.2.1 General)
20constexpr uint8_t WIFI_IE_ELEMENT_ID_EXT_SIZE = 1;
21
22/**
23 * This type is used to represent an Information Element ID. An
24 * enumeration would be tidier, but doesn't provide for the
25 * inheritance that is currently preferable to cleanly support
26 * pre-standard modules such as mesh. Maybe there is a nice way of
27 * doing this with a class.
28 *
29 * Until such time as a better way of implementing this is dreamt up
30 * and applied, developers will need to be careful to avoid
31 * duplication of IE IDs in the defines below (and in files which
32 * declare "subclasses" of WifiInformationElement). Sorry.
33 */
35
36/**
37 * Here we have definition of all Information Element IDs in IEEE
38 * 802.11-2007. See the comments for WifiInformationElementId - this could
39 * probably be done in a considerably tidier manner.
40 */
41#define IE_SSID ((WifiInformationElementId)0)
42#define IE_SUPPORTED_RATES ((WifiInformationElementId)1)
43#define IE_FH_PARAMETER_SET ((WifiInformationElementId)2)
44#define IE_DSSS_PARAMETER_SET ((WifiInformationElementId)3)
45#define IE_CF_PARAMETER_SET ((WifiInformationElementId)4)
46#define IE_TIM ((WifiInformationElementId)5)
47#define IE_IBSS_PARAMETER_SET ((WifiInformationElementId)6)
48#define IE_COUNTRY ((WifiInformationElementId)7)
49#define IE_HOPPING_PATTERN_PARAMETERS ((WifiInformationElementId)8)
50#define IE_HOPPING_PATTERN_TABLE ((WifiInformationElementId)9)
51#define IE_REQUEST ((WifiInformationElementId)10)
52#define IE_BSS_LOAD ((WifiInformationElementId)11)
53#define IE_EDCA_PARAMETER_SET ((WifiInformationElementId)12)
54#define IE_TSPEC ((WifiInformationElementId)13)
55#define IE_TCLAS ((WifiInformationElementId)14)
56#define IE_SCHEDULE ((WifiInformationElementId)15)
57#define IE_CHALLENGE_TEXT ((WifiInformationElementId)16)
58// 17 to 31 are reserved
59#define IE_POWER_CONSTRAINT ((WifiInformationElementId)32)
60#define IE_POWER_CAPABILITY ((WifiInformationElementId)33)
61#define IE_TPC_REQUEST ((WifiInformationElementId)34)
62#define IE_TPC_REPORT ((WifiInformationElementId)35)
63#define IE_SUPPORTED_CHANNELS ((WifiInformationElementId)36)
64#define IE_CHANNEL_SWITCH_ANNOUNCEMENT ((WifiInformationElementId)37)
65#define IE_MEASUREMENT_REQUEST ((WifiInformationElementId)38)
66#define IE_MEASUREMENT_REPORT ((WifiInformationElementId)39)
67#define IE_QUIET ((WifiInformationElementId)40)
68#define IE_IBSS_DFS ((WifiInformationElementId)41)
69#define IE_ERP_INFORMATION ((WifiInformationElementId)42)
70#define IE_TS_DELAY ((WifiInformationElementId)43)
71#define IE_TCLAS_PROCESSING ((WifiInformationElementId)44)
72#define IE_HT_CAPABILITIES ((WifiInformationElementId)45)
73#define IE_QOS_CAPABILITY ((WifiInformationElementId)46)
74// 47 is reserved
75#define IE_RSN ((WifiInformationElementId)48)
76// 49 is reserved
77#define IE_EXTENDED_SUPPORTED_RATES ((WifiInformationElementId)50)
78#define IE_AP_CHANNEL_REPORT ((WifiInformationElementId)51)
79#define IE_NEIGHBOR_REPORT ((WifiInformationElementId)52)
80#define IE_RCPI ((WifiInformationElementId)53)
81#define IE_MOBILITY_DOMAIN ((WifiInformationElementId)54)
82#define IE_FAST_BSS_TRANSITION ((WifiInformationElementId)55)
83#define IE_TIMEOUT_INTERVAL ((WifiInformationElementId)56)
84#define IE_RIC_DATA ((WifiInformationElementId)57)
85#define IE_DSE_REGISTERED_LOCATION ((WifiInformationElementId)58)
86#define IE_SUPPORTED_OPERATING_CLASSES ((WifiInformationElementId)59)
87#define IE_EXTENDED_CHANNEL_SWITCH_ANNOUNCEMENT ((WifiInformationElementId)60)
88#define IE_HT_OPERATION ((WifiInformationElementId)61)
89#define IE_SECONDARY_CHANNEL_OFFSET ((WifiInformationElementId)62)
90#define IE_BSS_AVERAGE_ACCESS_DELAY ((WifiInformationElementId)63)
91#define IE_ANTENNA ((WifiInformationElementId)64)
92#define IE_RSNI ((WifiInformationElementId)65)
93#define IE_MEASUREMENT_PILOT_TRANSMISSION ((WifiInformationElementId)66)
94#define IE_BSS_AVAILABLE_ADMISSION_CAPACITY ((WifiInformationElementId)67)
95#define IE_BSS_AC_ACCESS_DELAY ((WifiInformationElementId)68)
96#define IE_TIME_ADVERTISEMENT ((WifiInformationElementId)69)
97#define IE_RM_ENABLED_CAPACITIES ((WifiInformationElementId)70)
98#define IE_MULTIPLE_BSSID ((WifiInformationElementId)71)
99#define IE_20_40_BSS_COEXISTENCE ((WifiInformationElementId)72)
100#define IE_20_40_BSS_INTOLERANT_CHANNEL_REPORT ((WifiInformationElementId)73)
101#define IE_OVERLAPPING_BSS_SCAN_PARAMETERS ((WifiInformationElementId)74)
102#define IE_RIC_DESCRIPTOR ((WifiInformationElementId)75)
103#define IE_MANAGEMENT_MIC ((WifiInformationElementId)76)
104// 77 is reserved
105#define IE_EVENT_REQUEST ((WifiInformationElementId)78)
106#define IE_EVENT_REPORT ((WifiInformationElementId)79)
107#define IE_DIAGNOSTIC_REQUEST ((WifiInformationElementId)80)
108#define IE_DIAGNOSTIC_REPORT ((WifiInformationElementId)81)
109#define IE_LOCATION_PARAMETERS ((WifiInformationElementId)82)
110#define IE_NONTRANSMITTED_BSSID_CAPABILITY ((WifiInformationElementId)83)
111#define IE_SSID_LIST ((WifiInformationElementId)84)
112#define IE_MULTIPLE_BSSID_INDEX ((WifiInformationElementId)85)
113#define IE_FMS_DESCRIPTOR ((WifiInformationElementId)86)
114#define IE_FMS_REQUEST ((WifiInformationElementId)87)
115#define IE_FMS_RESPONSE ((WifiInformationElementId)88)
116#define IE_QOS_TRAFFIC_CAPABILITY ((WifiInformationElementId)89)
117#define IE_BSS_MAX_IDLE_PERIOD ((WifiInformationElementId)90)
118#define IE_TFS_REQUEST ((WifiInformationElementId)91)
119#define IE_TFS_RESPONSE ((WifiInformationElementId)92)
120#define IE_WNM_SLEEP_MODE ((WifiInformationElementId)93)
121#define IE_TIM_BROADCAST_REQUEST ((WifiInformationElementId)94)
122#define IE_TIM_BROADCAST_RESPONSE ((WifiInformationElementId)95)
123#define IE_COLLOCATED_INTERFERENCE_REPORT ((WifiInformationElementId)96)
124#define IE_CHANNEL_USAGE ((WifiInformationElementId)97)
125#define IE_TIME_ZONE ((WifiInformationElementId)98)
126#define IE_DMS_REQUEST ((WifiInformationElementId)99)
127#define IE_DMS_RESPONSE ((WifiInformationElementId)100)
128#define IE_LINK_IDENTIFIER ((WifiInformationElementId)101)
129#define IE_WAKEUP_SCHEDULE ((WifiInformationElementId)102)
130// 103 is reserved
131#define IE_CHANNEL_SWITCH_TIMING ((WifiInformationElementId)104)
132#define IE_PTI_CONTROL ((WifiInformationElementId)105)
133#define IE_TPU_BUFFER_STATUS ((WifiInformationElementId)106)
134#define IE_INTERWORKING ((WifiInformationElementId)107)
135#define IE_ADVERTISEMENT_PROTOCOL ((WifiInformationElementId)108)
136#define IE_EXPEDITED_BANDWIDTH_REQUEST ((WifiInformationElementId)109)
137#define IE_QOS_MAP_SET ((WifiInformationElementId)110)
138#define IE_ROAMING_CONSORTIUM ((WifiInformationElementId)111)
139#define IE_EMERGENCY_ALART_IDENTIFIER ((WifiInformationElementId)112)
140#define IE_MESH_CONFIGURATION ((WifiInformationElementId)113)
141#define IE_MESH_ID ((WifiInformationElementId)114)
142#define IE_MESH_LINK_METRIC_REPORT ((WifiInformationElementId)115)
143#define IE_CONGESTION_NOTIFICATION ((WifiInformationElementId)116)
144#define IE_MESH_PEERING_MANAGEMENT ((WifiInformationElementId)117)
145#define IE_MESH_CHANNEL_SWITCH_PARAMETERS ((WifiInformationElementId)118)
146#define IE_MESH_AWAKE_WINDOW ((WifiInformationElementId)119)
147#define IE_BEACON_TIMING ((WifiInformationElementId)120)
148#define IE_MCCAOP_SETUP_REQUEST ((WifiInformationElementId)121)
149#define IE_MCCAOP_SETUP_REPLY ((WifiInformationElementId)122)
150#define IE_MCCAOP_ADVERTISEMENT ((WifiInformationElementId)123)
151#define IE_MCCAOP_TEARDOWN ((WifiInformationElementId)124)
152#define IE_GANN ((WifiInformationElementId)125)
153#define IE_RANN ((WifiInformationElementId)126)
154// 67 to 126 are reserved
155#define IE_EXTENDED_CAPABILITIES ((WifiInformationElementId)127)
156// 128 to 129 are reserved
157#define IE_PREQ ((WifiInformationElementId)130)
158#define IE_PREP ((WifiInformationElementId)131)
159#define IE_PERR ((WifiInformationElementId)132)
160// 133 to 136 are reserved
161#define IE_PROXY_UPDATE ((WifiInformationElementId)137)
162#define IE_PROXY_UPDATE_CONFIRMATION ((WifiInformationElementId)138)
163#define IE_AUTHENTICATED_MESH_PEERING_EXCHANGE ((WifiInformationElementId)139)
164#define IE_MIC ((WifiInformationElementId)140)
165#define IE_DESTINATION_URI ((WifiInformationElementId)141)
166#define IE_UAPSD_COEXISTENCE ((WifiInformationElementId)142)
167#define IE_DMG_WAKEUP_SCHEDULE ((WifiInformationElementId)143)
168#define IE_EXTENDED_SCHEDULE ((WifiInformationElementId)144)
169#define IE_STA_AVAILABILITY ((WifiInformationElementId)145)
170#define IE_DMG_TSPEC ((WifiInformationElementId)146)
171#define IE_NEXT_DMG_ATI ((WifiInformationElementId)147)
172#define IE_DMG_CAPABILITIES ((WifiInformationElementId)148)
173// 149 to 150 are reserved
174#define IE_DMG_OPERATION ((WifiInformationElementId)151)
175#define IE_DMG_BSS_PARAMETER_CHANGE ((WifiInformationElementId)152)
176#define IE_DMG_BEAM_REFINEMENT ((WifiInformationElementId)153)
177#define IE_CHANNEL_MEASUREMENT_FEEDBACK ((WifiInformationElementId)154)
178// 155 to 156 are reserved
179#define IE_AWAKE_WINDOW ((WifiInformationElementId)157)
180#define IE_MULTI_BAND ((WifiInformationElementId)158)
181#define IE_ADDBA_EXTENSION ((WifiInformationElementId)159)
182#define IE_NEXT_PCP_LIST ((WifiInformationElementId)160)
183#define IE_PCP_HANDOVER ((WifiInformationElementId)161)
184#define IE_DMG_LINK_MARGIN ((WifiInformationElementId)162)
185#define IE_SWITCHING_STREAM ((WifiInformationElementId)163)
186#define IE_SESSION_TRANSITION ((WifiInformationElementId)164)
187#define IE_DYNAMIC_TONE_PAIRING_REPORT ((WifiInformationElementId)165)
188#define IE_CLUSTER_REPORT ((WifiInformationElementId)166)
189#define IE_RELAY_CAPABILITIES ((WifiInformationElementId)167)
190#define IE_RELAY_TRANSFER_PARAMETER_SET ((WifiInformationElementId)168)
191#define IE_BEAMLINK_MAINTENANCE ((WifiInformationElementId)169)
192// 170 to 171 are reserved
193#define IE_DMG_LINK_ADAPTATION_ACKNOWLEDGMENT ((WifiInformationElementId)172)
194// 173 is reserved
195#define IE_MCCAOP_ADVERTISEMENT_OVERVIEW ((WifiInformationElementId)174)
196#define IE_QUIET_PERIOD_REQUEST ((WifiInformationElementId)175)
197// 176 is reserved
198#define IE_QUIET_PERIOD_RESPONSE ((WifiInformationElementId)177)
199// 178 to 181 are reserved
200#define IE_ECPAC_POLICY ((WifiInformationElementId)182)
201// 183 to 190 are reserved
202#define IE_VHT_CAPABILITIES ((WifiInformationElementId)191)
203#define IE_VHT_OPERATION ((WifiInformationElementId)192)
204#define IE_EXTENDED_BSS_LOAD ((WifiInformationElementId)193)
205#define IE_WIDE_BANDWIDTH_CHANNEL_SWITCH ((WifiInformationElementId)194)
206#define IE_VHT_TRANSMIT_POWER_ENVELOPE ((WifiInformationElementId)195)
207#define IE_CHANNEL_SWITCH_WRAPPER ((WifiInformationElementId)196)
208#define IE_AID ((WifiInformationElementId)197)
209#define IE_QUIET_CHANNEL ((WifiInformationElementId)198)
210#define IE_OPERATING_MODE_NOTIFICATION ((WifiInformationElementId)199)
211#define IE_UPSIM ((WifiInformationElementId)200)
212#define IE_REDUCED_NEIGHBOR_REPORT ((WifiInformationElementId)201)
213// TODO Add 202 to 220. See Table 9-92 of 802.11-2020
214#define IE_VENDOR_SPECIFIC ((WifiInformationElementId)221)
215// TODO Add 222 to 241. See Table 9-92 of 802.11-2020
216#define IE_FRAGMENT ((WifiInformationElementId)242)
217// 243 to 254 are reserved
218#define IE_EXTENSION ((WifiInformationElementId)255)
219
220#define IE_EXT_HE_CAPABILITIES ((WifiInformationElementId)35)
221#define IE_EXT_HE_OPERATION ((WifiInformationElementId)36)
222#define IE_EXT_UORA_PARAMETER_SET ((WifiInformationElementId)37)
223#define IE_EXT_MU_EDCA_PARAMETER_SET ((WifiInformationElementId)38)
224
225#define IE_EXT_NON_INHERITANCE ((WifiInformationElementId)56)
226
227#define IE_EXT_HE_6GHZ_CAPABILITIES ((WifiInformationElementId)59)
228
229#define IE_EXT_EHT_OPERATION ((WifiInformationElementId)106)
230#define IE_EXT_MULTI_LINK_ELEMENT ((WifiInformationElementId)107)
231#define IE_EXT_EHT_CAPABILITIES ((WifiInformationElementId)108)
232#define IE_EXT_TID_TO_LINK_MAPPING_ELEMENT ((WifiInformationElementId)109)
233
234/**
235 * \brief Information element, as defined in 802.11-2007 standard
236 * \ingroup wifi
237 *
238 * The IEEE 802.11 standard includes the notion of Information
239 * Elements, which are encodings of management information to be
240 * communicated between STAs in the payload of various frames of type
241 * Management. Information Elements (IEs) have a common format, each
242 * starting with a single octet - the Element ID, which indicates the
243 * specific type of IE (a type to represent the options here is
244 * defined as WifiInformationElementId). The next octet is a length field and
245 * encodes the number of octets in the third and final field, which is
246 * the IE Information field.
247 *
248 * The class ns3::WifiInformationElement provides a base for classes
249 * which represent specific Information Elements. This class defines
250 * pure virtual methods for serialisation
251 * (ns3::WifiInformationElement::SerializeInformationField) and
252 * deserialisation
253 * (ns3::WifiInformationElement::DeserializeInformationField) of IEs, from
254 * or to data members or other objects that simulation objects use to
255 * maintain the relevant state.
256 *
257 * This class also provides an implementation of the equality
258 * operator, which operates by comparing the serialised versions of
259 * the two WifiInformationElement objects concerned.
260 *
261 * Elements are defined to have a common general format consisting of
262 * a 1 octet Element ID field, a 1 octet length field, and a
263 * variable-length element-specific information field. Each element is
264 * assigned a unique Element ID as defined in this standard. The
265 * Length field specifies the number of octets in the Information
266 * field.
267 *
268 * Fragmentation of an Information Element is handled transparently by the base
269 * class. Subclasses can simply serialize/deserialize their data into/from a
270 * single large buffer. It is the base class that takes care of splitting
271 * serialized data into multiple fragments (when serializing) or reconstructing
272 * data from multiple fragments when deserializing.
273 *
274 * This class is pure virtual and acts as base for classes which know
275 * how to serialize specific IEs.
276 */
277class WifiInformationElement : public SimpleRefCount<WifiInformationElement>
278{
279 public:
280 virtual ~WifiInformationElement();
281 /**
282 * Serialize entire IE including Element ID and length fields. Handle
283 * fragmentation of the IE if needed.
284 *
285 * \param i an iterator which points to where the IE should be written.
286 *
287 * \return an iterator
288 */
290 /**
291 * Deserialize entire IE (which may possibly be fragmented into multiple
292 * elements), which must be present. The iterator passed in must be pointing
293 * at the Element ID (i.e., the very first octet) of the correct type of
294 * information element, otherwise this method will generate a fatal error.
295 *
296 * \param i an iterator which points to where the IE should be read.
297 *
298 * \return an iterator
299 */
301 /**
302 * Deserialize entire IE (which may possibly be fragmented into multiple
303 * elements) if it is present. The iterator passed in
304 * must be pointing at the Element ID of an information element. If
305 * the Element ID is not the one that the given class is interested
306 * in then it will return the same iterator.
307 *
308 * \param i an iterator which points to where the IE should be read.
309 *
310 * \return an iterator
311 */
313 /**
314 * Get the size of the serialized IE including Element ID and
315 * length fields (for every element this IE is possibly fragmented into).
316 *
317 * \return the size of the serialized IE in bytes
318 */
319 uint16_t GetSerializedSize() const;
320
321 // Each subclass must implement these pure virtual functions:
322 /**
323 * Get the wifi information element ID
324 * \returns the wifi information element ID
325 */
327
328 /**
329 * Get the wifi information element ID extension
330 * \returns the wifi information element ID extension
331 */
333
334 // In addition, a subclass may optionally override the following...
335 /**
336 * Generate human-readable form of IE
337 *
338 * \param os output stream
339 */
340 virtual void Print(std::ostream& os) const;
341 /**
342 * Compare two IEs for equality by ID & Length, and then through
343 * memcmp of serialised version
344 *
345 * \param a another information element to compare with
346 *
347 * \return true if the two IEs are equal,
348 * false otherwise
349 */
350 virtual bool operator==(const WifiInformationElement& a) const;
351
352 private:
353 /**
354 * Serialize an IE that needs to be fragmented.
355 *
356 * \param i an iterator which points to where the IE should be written.
357 * \param size the size of the body of the IE
358 * \return an iterator pointing to past the IE that was serialized
359 */
361 /**
362 * Deserialize the Information field of an IE. Also handle the case in which
363 * the IE is fragmented.
364 *
365 * \param i an iterator which points to where the Information field should be read.
366 * \param length the expected number of bytes to read
367 * \return an iterator pointing to past the IE that was deserialized
368 */
370 /**
371 * Length of serialized information (i.e., the length of the body
372 * of the IE, not including the Element ID and length octets. This
373 * is the value that will appear in the second octet of the entire
374 * IE - the length field - if the IE is not fragmented)
375 *
376 * \return the length of serialized information
377 */
378 virtual uint16_t GetInformationFieldSize() const = 0;
379 /**
380 * Serialize information (i.e., the body of the IE, not including
381 * the Element ID and length octets)
382 *
383 * \param start an iterator which points to where the information should
384 * be written.
385 */
386 virtual void SerializeInformationField(Buffer::Iterator start) const = 0;
387 /**
388 * Deserialize information (i.e., the body of the IE, not including
389 * the Element ID and length octets)
390 *
391 * \param start an iterator which points to where the information should be written.
392 * \param length the expected number of bytes to read
393 *
394 * \return the number of bytes read
395 */
396 virtual uint16_t DeserializeInformationField(Buffer::Iterator start, uint16_t length) = 0;
397};
398
399/**
400 * \brief Stream insertion operator.
401 *
402 * \param os the output stream
403 * \param element the Information Element
404 * \returns a reference to the stream
405 */
406std::ostream& operator<<(std::ostream& os, const WifiInformationElement& element);
407
408} // namespace ns3
409
410#endif /* WIFI_INFORMATION_ELEMENT_H */
iterator in a Buffer instance
Definition buffer.h:89
A template-based reference counting class.
Information element, as defined in 802.11-2007 standard.
virtual WifiInformationElementId ElementId() const =0
Get the wifi information element ID.
uint16_t GetSerializedSize() const
Get the size of the serialized IE including Element ID and length fields (for every element this IE i...
Buffer::Iterator Deserialize(Buffer::Iterator i)
Deserialize entire IE (which may possibly be fragmented into multiple elements), which must be presen...
Buffer::Iterator Serialize(Buffer::Iterator i) const
Serialize entire IE including Element ID and length fields.
virtual uint16_t DeserializeInformationField(Buffer::Iterator start, uint16_t length)=0
Deserialize information (i.e., the body of the IE, not including the Element ID and length octets)
Buffer::Iterator DeserializeIfPresent(Buffer::Iterator i)
Deserialize entire IE (which may possibly be fragmented into multiple elements) if it is present.
Buffer::Iterator SerializeFragments(Buffer::Iterator i, uint16_t size) const
Serialize an IE that needs to be fragmented.
virtual void Print(std::ostream &os) const
Generate human-readable form of IE.
virtual void SerializeInformationField(Buffer::Iterator start) const =0
Serialize information (i.e., the body of the IE, not including the Element ID and length octets)
virtual uint16_t GetInformationFieldSize() const =0
Length of serialized information (i.e., the length of the body of the IE, not including the Element I...
virtual WifiInformationElementId ElementIdExt() const
Get the wifi information element ID extension.
Buffer::Iterator DoDeserialize(Buffer::Iterator i, uint16_t length)
Deserialize the Information field of an IE.
virtual bool operator==(const WifiInformationElement &a) const
Compare two IEs for equality by ID & Length, and then through memcmp of serialised version.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
std::ostream & operator<<(std::ostream &os, const Angles &a)
Definition angles.cc:148
constexpr uint8_t WIFI_IE_ELEMENT_ID_EXT_SIZE
Size in bytes of the Element ID Extension field (IEEE 802.11-2020 9.4.2.1 General)
uint8_t WifiInformationElementId
This type is used to represent an Information Element ID.