11#include "ns3/address-utils.h"
12#include "ns3/mgt-headers.h"
73 start.WriteHtolsbU16(val);
81 start.WriteHtolsbU16(val);
90 uint8_t length = i.
ReadU8();
94 if ((presence & 0x0001) != 0)
99 if ((presence & 0x0002) != 0)
104 if ((presence & 0x0004) != 0)
113 if ((presence & 0x0008) != 0)
125 if ((presence & 0x0010) != 0)
138 "Common Info Length (" << +length
140 "from actual number of bytes read ("
155 for (uint8_t i = 1; i <= 4; i++)
157 if (1 << (i + 4) == delayUs)
188 for (uint8_t i = 1; i <= 5; i++)
190 if (1 << (i + 3) == delayUs)
215 NS_ABORT_MSG_IF(delayUs % 32 != 0,
"Delay must be a multiple of 32 microseconds");
235 NS_ABORT_MSG_IF(threshold < -72 || threshold > -62,
"Threshold may range from -72 to -62 dBm");
236 uint8_t value = 72 + threshold;
255 NS_ASSERT_MSG(nTxops < 16,
"Value " << +nTxops <<
"cannot be encoded in 4 bits");
272std::optional<uint8_t>
288 : m_containingFrame(frame),
289 m_commonInfo(
std::in_place_type<
std::monostate>)
349 std::get<BASIC_VARIANT>(
m_commonInfo).m_mldMacAddress = address;
355 return std::get<BASIC_VARIANT>(
m_commonInfo).m_mldMacAddress;
361 std::get<BASIC_VARIANT>(
m_commonInfo).m_linkIdInfo = (linkIdInfo & 0x0f);
367 return std::get<BASIC_VARIANT>(
m_commonInfo).m_linkIdInfo.has_value();
373 return std::get<BASIC_VARIANT>(
m_commonInfo).m_linkIdInfo.value();
379 std::get<BASIC_VARIANT>(
m_commonInfo).m_bssParamsChangeCount = count;
385 return std::get<BASIC_VARIANT>(
m_commonInfo).m_bssParamsChangeCount.has_value();
391 return std::get<BASIC_VARIANT>(
m_commonInfo).m_bssParamsChangeCount.value();
397 auto& emlCapabilities = std::get<BASIC_VARIANT>(
m_commonInfo).m_emlCapabilities;
398 if (!emlCapabilities.has_value())
408 auto& emlCapabilities = std::get<BASIC_VARIANT>(
m_commonInfo).m_emlCapabilities;
409 if (!emlCapabilities.has_value())
419 auto& emlCapabilities = std::get<BASIC_VARIANT>(
m_commonInfo).m_emlCapabilities;
420 if (!emlCapabilities.has_value())
430 auto& emlCapabilities = std::get<BASIC_VARIANT>(
m_commonInfo).m_emlCapabilities;
431 if (!emlCapabilities.has_value())
439 emlCapabilities->transitionTimeout = 0;
444 for (i = 1; i <= 10; i++)
446 if (1 << (i + 6) == timeoutUs)
448 emlCapabilities->transitionTimeout = i;
459 return std::get<BASIC_VARIANT>(
m_commonInfo).m_emlCapabilities.has_value();
465 return std::get<BASIC_VARIANT>(
m_commonInfo).m_emlCapabilities->emlsrSupport;
471 auto& emlCapabilities = std::get<BASIC_VARIANT>(
m_commonInfo).m_emlCapabilities;
479 auto& emlCapabilities = std::get<BASIC_VARIANT>(
m_commonInfo).m_emlCapabilities;
487 auto& emlCapabilities = std::get<BASIC_VARIANT>(
m_commonInfo).m_emlCapabilities;
489 if (emlCapabilities->transitionTimeout == 0)
493 return MicroSeconds(1 << (6 + emlCapabilities->transitionTimeout));
497 : m_variant(variant),
504 : m_variant(perStaProfile.m_variant),
505 m_staControl(perStaProfile.m_staControl),
506 m_staMacAddress(perStaProfile.m_staMacAddress)
509 auto staProfileCopy = [&](
auto&& frame) {
510 using Ptr = std::decay_t<
decltype(frame)>;
511 if constexpr (std::is_same_v<Ptr, std::monostate>)
517 using T = std::decay_t<
decltype(*frame.get())>;
528 if (&perStaProfile ==
this)
538 auto staProfileCopy = [&](
auto&& frame) {
539 using Ptr = std::decay_t<
decltype(frame)>;
540 if constexpr (std::is_same_v<Ptr, std::monostate>)
546 using T = std::decay_t<
decltype(*frame.get())>;
547 m_staProfile = std::make_unique<T>(*frame.get());
558 m_staControl &= 0xfff0;
559 m_staControl |= (linkId & 0x0f);
565 return static_cast<uint8_t
>(m_staControl & 0x000f);
571 m_staControl |= 0x0010;
577 return (m_staControl & 0x0010) != 0;
584 m_staMacAddress = address;
585 m_staControl |= 0x0020;
591 return (m_staControl & 0x0020) != 0;
598 return m_staMacAddress;
603 const std::variant<MgtAssocRequestHeader, MgtReassocRequestHeader>& assoc)
607 m_staProfile = std::make_unique<std::decay_t<
decltype(frame)>>(frame);
614 std::variant<MgtAssocRequestHeader, MgtReassocRequestHeader>&& assoc)
618 using T = std::decay_t<
decltype(frame)>;
619 m_staProfile = std::make_unique<T>(std::forward<T>(frame));
627 return std::holds_alternative<std::unique_ptr<MgtAssocRequestHeader>>(m_staProfile);
633 return std::holds_alternative<std::unique_ptr<MgtReassocRequestHeader>>(m_staProfile);
639 if (HasAssocRequest())
641 return *std::get<std::unique_ptr<MgtAssocRequestHeader>>(m_staProfile);
644 return *std::get<std::unique_ptr<MgtReassocRequestHeader>>(m_staProfile);
650 m_staProfile = std::make_unique<MgtAssocResponseHeader>(assoc);
656 m_staProfile = std::make_unique<MgtAssocResponseHeader>(std::move(assoc));
662 return std::holds_alternative<std::unique_ptr<MgtAssocResponseHeader>>(m_staProfile);
669 return *std::get<std::unique_ptr<MgtAssocResponseHeader>>(m_staProfile);
677 if (HasStaMacAddress())
696 ret += GetStaInfoLength();
698 auto staProfileSize = [&](
auto&& frame) {
699 using T = std::decay_t<
decltype(frame)>;
700 if constexpr (std::is_same_v<T, std::monostate>)
703 "Missing management frame for Per-STA Profile subelement");
708 using U = std::decay_t<
decltype(*frame)>;
711 "Containing frame type and frame type in Per-STA Profile do not match");
712 const auto& containing = std::get<std::reference_wrapper<const U>>(
m_containingFrame);
713 return frame->GetSerializedSizeInPerStaProfile(containing);
716 ret += std::visit(staProfileSize, m_staProfile);
724 start.WriteHtolsbU16(m_staControl);
725 start.WriteU8(GetStaInfoLength());
727 if (HasStaMacAddress())
729 WriteTo(start, m_staMacAddress);
732 auto staProfileSerialize = [&](
auto&& frame) {
733 using T = std::decay_t<
decltype(frame)>;
734 if constexpr (std::is_same_v<T, std::monostate>)
737 "Missing management frame for Per-STA Profile subelement");
742 using U = std::decay_t<
decltype(*frame)>;
745 "Containing frame type and frame type in Per-STA Profile do not match");
746 const auto& containing = std::get<std::reference_wrapper<const U>>(
m_containingFrame);
747 frame->SerializeInPerStaProfile(start, containing);
750 std::visit(staProfileSerialize, m_staProfile);
762 if (HasStaMacAddress())
771 "Bytes read (" << count <<
") exceed expected number (" << length <<
")");
778 auto staProfileDeserialize = [&](
auto&& frame) {
779 using T = std::decay_t<
decltype(frame)>;
780 if constexpr (!std::is_same_v<T, std::monostate>)
782 using U = std::decay_t<
decltype(frame.get())>;
784 count += assoc.DeserializeFromPerStaProfile(i, length - count, frame.get());
785 m_staProfile = std::make_unique<U>(std::move(assoc));
826 [](
auto&& arg) -> uint8_t {
827 using T = std::decay_t<
decltype(arg)>;
828 if constexpr (std::is_same_v<T, std::monostate>)
835 return arg.GetSize();
843 ret += subelement.GetSerializedSize();
854 [
this, &start](
auto&& arg) {
855 using T = std::decay_t<
decltype(arg)>;
856 if constexpr (std::is_same_v<T, std::monostate>)
863 static_cast<uint8_t
>(
GetVariant()) + (arg.GetPresenceBitmap() << 4);
864 start.WriteHtolsbU16(mlControl);
865 arg.Serialize(start);
872 start = subelement.Serialize(start);
886 uint16_t presence = mlControl >> 4;
888 uint8_t nBytes = std::visit(
889 [&i, &presence](
auto&& arg) -> uint8_t {
890 using T = std::decay_t<
decltype(arg)>;
891 if constexpr (std::is_same_v<T, std::monostate>)
898 return arg.Deserialize(i, presence);
905 while (count < length)
913 i = perStaProfile.Deserialize(i);
iterator in a Buffer instance
uint32_t GetDistanceFrom(const Iterator &o) const
void Next()
go forward by one byte
Per-STA Profile Subelement of Multi-Link element.
PerStaProfileSubelement(Variant variant)
Constructor.
Variant m_variant
Multi-Link element variant.
MgtAssocResponseHeader & GetAssocResponse() const
Get the (Re)Association Response frame body included in the STA Profile field of this Per-STA Profile...
AssocReqRefVariant GetAssocRequest() const
Get the (Re)Association Request frame body included in the STA Profile field of this Per-STA Profile ...
bool HasReassocRequest() const
Return true if a Reassociation Request frame body is included in the STA Profile field of this Per-ST...
Mac48Address GetStaMacAddress() const
Get the STA MAC Address subfield in the STA Info field, if present.
bool HasStaMacAddress() const
Return true if the STA MAC Address subfield in the STA Info field is present.
void SetAssocResponse(const MgtAssocResponseHeader &assoc)
Include the given (Re)Association Response frame body in the STA Profile field of this Per-STA Profil...
PerStaProfileSubelement & operator=(const PerStaProfileSubelement &perStaProfile)
Copy assignment operator performing a deep copy of the object.
uint16_t DeserializeInformationField(Buffer::Iterator start, uint16_t length) override
Deserialize information (i.e., the body of the IE, not including the Element ID and length octets)
uint8_t GetStaInfoLength() const
Get the size in bytes of the serialized STA Info Length subfield of the STA Info field.
WifiInformationElementId ElementId() const override
Get the wifi information element ID.
void SerializeInformationField(Buffer::Iterator start) const override
Serialize information (i.e., the body of the IE, not including the Element ID and length octets)
void SetStaMacAddress(Mac48Address address)
Set the STA MAC Address subfield in the STA Info field.
Mac48Address m_staMacAddress
STA MAC address.
void SetCompleteProfile()
Set the Complete Profile flag in the STA Control field.
void SetAssocRequest(const std::variant< MgtAssocRequestHeader, MgtReassocRequestHeader > &assoc)
Include the given (Re)Association Request frame body in the STA Profile field of this Per-STA Profile...
std::variant< std::monostate, std::unique_ptr< MgtAssocRequestHeader >, std::unique_ptr< MgtReassocRequestHeader >, std::unique_ptr< MgtAssocResponseHeader > > m_staProfile
STA Profile field, containing the frame body of a frame of the same type as the frame containing the ...
uint16_t GetInformationFieldSize() const override
Length of serialized information (i.e., the length of the body of the IE, not including the Element I...
bool IsCompleteProfileSet() const
void SetLinkId(uint8_t linkId)
Set the Link ID subfield in the STA Control field.
bool HasAssocRequest() const
Return true if an Association Request frame body is included in the STA Profile field of this Per-STA...
uint16_t m_staControl
STA Control field.
uint8_t GetLinkId() const
Get the Link ID subfield in the STA Control field.
bool HasAssocResponse() const
Return true if a (Re)Association Response frame body is included in the STA Profile field of this Per...
ContainingFrame m_containingFrame
reference to the mgt frame containing this MLE
uint16_t DeserializeInformationField(Buffer::Iterator start, uint16_t length) override
Deserialize information (i.e., the body of the IE, not including the Element ID and length octets)
uint16_t GetInformationFieldSize() const override
Length of serialized information (i.e., the length of the body of the IE, not including the Element I...
bool HasBssParamsChangeCount() const
Return true if the BSS Parameters Change Count subfield in the Common Info field is present and false...
void AddPerStaProfileSubelement()
Add a Per-STA Profile Subelement in the Link Info field.
void SetEmlsrSupported(bool supported)
Set the EMLSR Support subfield of the EML Capabilities subfield in the Common Info field to 1 if EMLS...
Time GetTransitionTimeout() const
Get the Transition Timeout subfield of the EML Capabilities subfield in the Common Info field.
void SetBssParamsChangeCount(uint8_t count)
Set the BSS Parameters Change Count subfield in the Common Info field.
uint8_t GetBssParamsChangeCount() const
Return the BSS Parameters Change Count subfield in the Common Info field.
void SerializeInformationField(Buffer::Iterator start) const override
Serialize information (i.e., the body of the IE, not including the Element ID and length octets)
void SetLinkIdInfo(uint8_t linkIdInfo)
Set the Link ID Info subfield in the Common Info field.
void SetVariant(Variant variant)
Set the variant of this Multi-Link Element.
Time GetEmlsrTransitionDelay() const
Get the EMLSR Transition Delay subfield of the EML Capabilities subfield in the Common Info field.
std::vector< PerStaProfileSubelement > m_perStaProfileSubelements
Per-STA Profile Subelements.
CommonInfoBasicMle & GetCommonInfoBasic()
std::variant< std::monostate, std::reference_wrapper< const MgtAssocRequestHeader >, std::reference_wrapper< const MgtReassocRequestHeader >, std::reference_wrapper< const MgtAssocResponseHeader > > ContainingFrame
Typedef for structure holding a reference to the containing frame.
void SetEmlsrTransitionDelay(Time delay)
Set the EMLSR Transition Delay subfield of the EML Capabilities subfield in the Common Info field.
PerStaProfileSubelement & GetPerStaProfile(std::size_t i)
Get a reference to the i-th Per-STA Profile Subelement in the Link Info field.
Variant GetVariant() const
Get the Multi-Link element variant.
Time GetEmlsrPaddingDelay() const
Get the EMLSR Padding Delay subfield of the EML Capabilities subfield in the Common Info field.
void SetEmlsrPaddingDelay(Time delay)
Set the EMLSR Padding Delay subfield of the EML Capabilities subfield in the Common Info field.
CommonInfo m_commonInfo
Common Info field.
bool HasLinkIdInfo() const
Return true if the Link ID Info subfield in the Common Info field is present and false otherwise.
Mac48Address GetMldMacAddress() const
Return the MLD MAC Address subfield in the Common Info field.
bool HasEmlCapabilities() const
Return true if the EML Capabilities subfield in the Common Info field is present and false otherwise.
bool IsEmlsrSupported() const
Return true if the EMLSR Support subfield of the EML Capabilities subfield in the Common Info field i...
void SetMldMacAddress(Mac48Address address)
Set the MLD MAC Address subfield in the Common Info field.
MultiLinkElement(ContainingFrame frame={})
Construct a Multi-Link Element with no variant set.
WifiInformationElementId ElementIdExt() const override
Get the wifi information element ID extension.
WifiInformationElementId ElementId() const override
Get the wifi information element ID.
void SetTransitionTimeout(Time timeout)
Set the Transition Timeout subfield of the EML Capabilities subfield in the Common Info field.
std::size_t GetNPerStaProfileSubelements() const
Return the number of Per-STA Profile Subelement in the Link Info field.
uint8_t GetLinkIdInfo() const
Return the Link ID Info subfield in the Common Info field.
Smart pointer class similar to boost::intrusive_ptr.
Simulation virtual time values and global simulation resolution.
TimeWithUnit As(const Unit unit=Time::AUTO) const
Attach a unit to a Time, to facilitate output in a specific unit.
int64_t GetMicroSeconds() const
Get an approximation of the time stored in this instance in the indicated unit.
#define NS_ASSERT(condition)
At runtime, in debugging builds, if this condition is not true, the program prints the source file,...
#define NS_ASSERT_MSG(condition, message)
At runtime, in debugging builds, if this condition is not true, the program prints the message to out...
#define NS_ABORT_MSG(msg)
Unconditional abnormal program termination with a message.
#define NS_ABORT_UNLESS(cond)
Abnormal program termination if a condition is false.
#define NS_ABORT_MSG_IF(cond, msg)
Abnormal program termination if a condition is true, with a message.
#define NS_ABORT_IF(cond)
Abnormal program termination if a condition is true.
Time MicroSeconds(uint64_t value)
Construct a Time in the indicated unit.
Variant
Multi-Link element variants.
SubElementId
SubElement IDs.
@ PER_STA_PROFILE_SUBELEMENT_ID
Every class exported by the ns3 library is enclosed in the ns3 namespace.
void WriteTo(Buffer::Iterator &i, Ipv4Address ad)
Write an Ipv4Address to a Buffer.
std::variant< std::reference_wrapper< MgtAssocRequestHeader >, std::reference_wrapper< MgtReassocRequestHeader > > AssocReqRefVariant
variant holding a reference to a (Re)Association Request
uint8_t WifiInformationElementId
This type is used to represent an Information Element ID.
void ReadFrom(Buffer::Iterator &i, Ipv4Address &ad)
Read an Ipv4Address from a Buffer.
EML Capabilities subfield.
uint8_t emlsrSupport
EMLSR Support.
uint8_t emlsrPaddingDelay
EMLSR Padding Delay.
uint8_t emlsrTransitionDelay
EMLSR Transition Delay.
Medium Synchronization Delay Information subfield.
uint8_t mediumSyncOfdmEdThreshold
Medium Synchronization OFDM ED Threshold.
uint8_t mediumSyncDuration
Medium Synchronization Duration.
uint8_t mediumSyncMaxNTxops
Medium Synchronization MAximum Number of TXOPs.
MLD Capabilities subfield.
Common Info field of the Basic Multi-Link element.
uint16_t GetPresenceBitmap() const
Get the Presence Bitmap subfield of the Common Info field.
uint8_t GetSize() const
Get the size of the serialized Common Info field.
static uint8_t EncodeEmlsrTransitionDelay(Time delay)
static Time DecodeEmlsrTransitionDelay(uint8_t value)
std::optional< EmlCapabilities > m_emlCapabilities
EML Capabilities.
uint8_t Deserialize(Buffer::Iterator start, uint16_t presence)
Deserialize the Common Info field.
std::optional< uint8_t > GetMediumSyncMaxNTxops() const
Get the maximum number of TXOPs a non-AP STA is allowed to attempt to initiate while the MediumSyncDe...
int8_t GetMediumSyncOfdmEdThreshold() const
Get the Medium Synchronization OFDM ED Threshold in dBm.
std::optional< MldCapabilities > m_mldCapabilities
MLD Capabilities.
void SetMediumSyncOfdmEdThreshold(int8_t threshold)
Set the Medium Synchronization OFDM ED Threshold subfield of the Medium Synchronization Delay Informa...
static Time DecodeEmlsrPaddingDelay(uint8_t value)
void Serialize(Buffer::Iterator &start) const
Serialize the Common Info field.
std::optional< MediumSyncDelayInfo > m_mediumSyncDelayInfo
Medium Synchronization Delay Information.
void SetMediumSyncDelayTimer(Time delay)
Set the Medium Synchronization Duration subfield of the Medium Synchronization Delay Information in t...
Time GetMediumSyncDelayTimer() const
Get the Medium Synchronization Duration subfield of the Medium Synchronization Delay Information in t...
Mac48Address m_mldMacAddress
Subfields.
std::optional< uint8_t > m_bssParamsChangeCount
BSS Parameters Change Count.
void SetMediumSyncMaxNTxops(uint8_t nTxops)
Set the Medium Synchronization Maximum Number of TXOPs subfield of the Medium Synchronization Delay I...
std::optional< uint8_t > m_linkIdInfo
Link ID Info.
static uint8_t EncodeEmlsrPaddingDelay(Time delay)