F5/unison
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

lr-wpan: Pending transaction list and association support params.

Browse Source
This commit is contained in:
Alberto Gallegos Ramonet
2022-07-19 13:11:35 +09:00
committed by Tommaso Pecorella
parent 4b79811c8a
commit b0d85940bf
5 changed files with 637 additions and 114 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGES.md
View File

@@ -31,6 +31,7 @@ Changes from ns-3.36 to ns-3.37
* Adds support for **LrWpanMac** energy detection (ED) scan.
* IPv6 Router Solicitations (RS) are now retransmitted up to 4 times, following RFC 5779.
* Adds support for **LrWpanMac** active and passive scan.
* Add supporting association structures: parameters, callbacks and the pending transaction list to **LrWpanMac**.
### Changes to build system

16
src/lr-wpan/doc/lr-wpan.rst
View File

@@ -142,21 +142,13 @@ The implemented ns-3 MAC supports scanning. Typically, a scanning request is pre
by an association request but these can be used independently.
IEEE 802.15.4 supports 4 types of scanning:
* Energy Detection (ED) Scan: In an energy scan, a device or a coordinator scan a set number of channels
looking for traces of energy. The maximum energy registered during a given amount of time is stored.
Energy scan is typically used to measure the quality of a channel at any given time. For this reason,
coordinators often use this scan before initiating a PAN on a channel.
* *Energy Detection (ED) Scan:* In an energy scan, a device or a coordinator scan a set number of channels looking for traces of energy. The maximum energy registered during a given amount of time is stored. Energy scan is typically used to measure the quality of a channel at any given time. For this reason, coordinators often use this scan before initiating a PAN on a channel.
* Active Scan: A device sends beacon requests on a set number of channels looking for a PAN coordinator.
The receiving coordinator must be configured on non-beacon mode. Coordinators on beacon-mode ignore these requests.
The coordinators who accept the request, respond with a beacon. After an active scan take place, during the association process
devices extract the information in the PAN descriptors from the collected beacons and
based on this information (e.g. channel, LQI level), choose a coordinator to associate with.
* *Active Scan:* A device sends beacon requests on a set number of channels looking for a PAN coordinator. The receiving coordinator must be configured on non-beacon mode. Coordinators on beacon-mode ignore these requests. The coordinators who accept the request, respond with a beacon. After an active scan take place, during the association process devices extract the information in the PAN descriptors from the collected beacons and based on this information (e.g. channel, LQI level), choose a coordinator to associate with.
* Passive Scan: In a passive scan, no beacon requests are sent. Devices scan a set number of channels looking for beacons currently being transmitted (coordinators in beacon-mode).
Like in the active scan, the information from beacons is stored in PAN descriptors and used by the device to choose a coordinator to associate with.
* *Passive Scan:* In a passive scan, no beacon requests are sent. Devices scan a set number of channels looking for beacons currently being transmitted (coordinators in beacon-mode). Like in the active scan, the information from beacons is stored in PAN descriptors and used by the device to choose a coordinator to associate with.
* Orphan Scan: <Not supported by ns-3>
* *Orphan Scan:* <Not supported by ns-3>
In active and passive scans, the link quality indicator (LQI) is the main parameter used to
determine the optimal coordinator. LQI values range from 0 to 255. Where 255 is the highest quality

235
src/lr-wpan/model/lr-wpan-mac.cc
View File

@@ -36,6 +36,8 @@
#include <ns3/random-variable-stream.h>
#include <ns3/double.h>
#undef NS_LOG_APPEND_CONTEXT
#define NS_LOG_APPEND_CONTEXT \
std::clog << "[address " << m_shortAddress << "] ";
@@ -43,16 +45,8 @@
namespace ns3 {
NS_LOG_COMPONENT_DEFINE ("LrWpanMac");
NS_OBJECT_ENSURE_REGISTERED (LrWpanMac);
//IEEE 802.15.4-2011 Table 51
const uint32_t LrWpanMac::aMinMPDUOverhead = 9;
const uint32_t LrWpanMac::aBaseSlotDuration = 60;
const uint32_t LrWpanMac::aNumSuperframeSlots = 16;
const uint32_t LrWpanMac::aBaseSuperframeDuration = aBaseSlotDuration * aNumSuperframeSlots;
const uint32_t LrWpanMac::aMaxLostBeacons = 4;
const uint32_t LrWpanMac::aMaxSIFSFrameSize = 18;
TypeId
LrWpanMac::GetTypeId (void)
@@ -162,6 +156,8 @@ LrWpanMac::LrWpanMac ()
m_macRxOnWhenIdle = true;
m_macPanId = 0xffff;
m_macCoordShortAddress = Mac16Address ("ff:ff");
m_macCoordExtendedAddress = Mac64Address ("ff:ff:ff:ff:ff:ff:ff:ed");
m_deviceCapability = DeviceType::FFD;
m_associationStatus = ASSOCIATED;
m_selfExt = Mac64Address::Allocate ();
@@ -177,7 +173,7 @@ LrWpanMac::LrWpanMac ()
m_macBeaconOrder = 15;
m_macSuperframeOrder = 15;
m_macTransactionPersistanceTime = 500; //0x01F5
m_macTransactionPersistenceTime = 500; //0x01F5
m_macAutoRequest = true;
m_incomingBeaconOrder = 15;
@@ -458,31 +454,11 @@ LrWpanMac::McpsDataRequest (McpsDataRequestParams params, Ptr<Packet> p)
}
else
{
IndTxQueueElement *indTxQElement = new IndTxQueueElement;
uint64_t unitPeriodSymbols;
Time expireTime;
if (m_macBeaconOrder == 15)
{
unitPeriodSymbols = aBaseSuperframeDuration;
}
else
{
unitPeriodSymbols = ((uint64_t) 1 << m_macBeaconOrder) * aBaseSuperframeDuration;
}
//TODO: check possible incorrect expire time here.
expireTime = Simulator::Now () + m_macTransactionPersistanceTime
* MicroSeconds (unitPeriodSymbols * 1000 * 1000 / m_phy->GetDataOrSymbolRate (false));
indTxQElement->expireTime = expireTime;
indTxQElement->txQMsduHandle = params.m_msduHandle;
indTxQElement->txQPkt = p;
m_indTxQueue.push_back (indTxQElement);
std::cout << "Indirect Transmission Pushed | Elements in the queue: " << m_indTxQueue.size ()
<< " " << "Element to expire in: " << expireTime.GetSeconds () << "secs\n";
NS_LOG_ERROR (this << " Indirect transmissions not currently supported");
// Note: The current Pending transaction list should work for indirect transmissions.
// However, this is not tested yet. For now, we block the use of indirect transmissions.
// TODO: Save packet in the Pending Transaction list.
// EnqueueInd (p);
}
}
else
@@ -1228,6 +1204,18 @@ LrWpanMac::SetMcpsDataIndicationCallback (McpsDataIndicationCallback c)
m_mcpsDataIndicationCallback = c;
}
void
LrWpanMac::SetMlmeAssociateIndicationCallback (MlmeAssociateIndicationCallback c)
{
m_mlmeAssociateIndicationCallback = c;
}
void
LrWpanMac::SetMlmeCommStatusIndicationCallback (MlmeCommStatusIndicationCallback c)
{
m_mlmeCommStatusIndicationCallback = c;
}
void
LrWpanMac::SetMcpsDataConfirmCallback (McpsDataConfirmCallback c)
{
@@ -1246,6 +1234,12 @@ LrWpanMac::SetMlmeScanConfirmCallback (MlmeScanConfirmCallback c)
m_mlmeScanConfirmCallback = c;
}
void
LrWpanMac::SetMlmeAssociateConfirmCallback (MlmeAssociateConfirmCallback c)
{
m_mlmeAssociateConfirmCallback = c;
}
void
LrWpanMac::SetMlmeBeaconNotifyIndicationCallback (MlmeBeaconNotifyIndicationCallback c)
{
@@ -1865,6 +1859,179 @@ LrWpanMac::PrepareRetransmission (void)
}
}
void
LrWpanMac::EnqueueInd (Ptr<Packet> p)
{
std::unique_ptr <IndTxQueueElement> indTxQElement = std::make_unique <IndTxQueueElement>();
LrWpanMacHeader peekedMacHdr;
p->PeekHeader (peekedMacHdr);
PurgeInd ();
NS_ASSERT (peekedMacHdr.GetDstAddrMode () == SHORT_ADDR || peekedMacHdr.GetDstAddrMode () == EXT_ADDR);
if (peekedMacHdr.GetDstAddrMode () == SHORT_ADDR)
{
indTxQElement->dstShortAddress = peekedMacHdr.GetShortDstAddr ();
}
else
{
indTxQElement->dstExtAddress = peekedMacHdr.GetExtDstAddr ();
}
indTxQElement->seqNum = peekedMacHdr.GetSeqNum ();
// See IEEE 802.15.4-2006, Table 86
uint32_t unit = 0; // The persistence time in symbols
if (m_macBeaconOrder == 15)
{
//Non-beacon enabled mode
unit = aBaseSuperframeDuration * m_macTransactionPersistenceTime;
}
else
{
//Beacon-enabled mode
unit = ((static_cast<uint32_t> (1) << m_macBeaconOrder) * aBaseSuperframeDuration) * m_macTransactionPersistenceTime;
}
double symbolRate = m_phy->GetDataOrSymbolRate (false);
Time expireTime = Seconds (unit / symbolRate);
expireTime += Simulator::Now ();
indTxQElement->expireTime = expireTime;
indTxQElement->txQPkt = p;
m_indTxQueue.push_back (std::move(indTxQElement));
}
bool
LrWpanMac::DequeueInd (Mac64Address dst, IndTxQueueElement * entry)
{
PurgeInd ();
for (uint32_t i = 0; i < m_indTxQueue.size (); i++)
{
if (m_indTxQueue[i]->dstExtAddress == dst)
{
*entry = *m_indTxQueue[i];
return true;
}
}
return false;
}
void
LrWpanMac::PurgeInd ()
{
for (uint32_t i = 0; i < m_indTxQueue.size (); )
{
if (Simulator::Now () > m_indTxQueue[i]->expireTime)
{
// Transaction expired, remove and send proper confirmation/indication to a higher layer
LrWpanMacHeader peekedMacHdr;
m_indTxQueue[i]->txQPkt->Copy ()->PeekHeader (peekedMacHdr);
if (peekedMacHdr.IsCommand ())
{
// IEEE 802.15.4-2006 (Section 7.1.3.3.3)
if (!m_mlmeCommStatusIndicationCallback.IsNull ())
{
MlmeCommStatusIndicationParams commStatusParams;
commStatusParams.m_panId = m_macPanId;
commStatusParams.m_srcAddrMode = LrWpanMacHeader::EXTADDR;
commStatusParams.m_srcExtAddr = peekedMacHdr.GetExtSrcAddr ();
commStatusParams.m_dstAddrMode = LrWpanMacHeader::EXTADDR;
commStatusParams.m_dstExtAddr = peekedMacHdr.GetExtDstAddr ();
commStatusParams.m_status = LrWpanMlmeCommStatus::MLMECOMMSTATUS_TRANSACTION_EXPIRED;
m_mlmeCommStatusIndicationCallback (commStatusParams);
}
}
else if (peekedMacHdr.IsData())
{
// IEEE 802.15.4-2006 (Section 7.1.1.1.3)
if (! m_mcpsDataConfirmCallback.IsNull ())
{
McpsDataConfirmParams confParams;
confParams.m_status = IEEE_802_15_4_TRANSACTION_EXPIRED;
m_mcpsDataConfirmCallback (confParams);
}
}
m_macTxDropTrace (m_indTxQueue[i]->txQPkt);
m_indTxQueue.erase (m_indTxQueue.begin () + i);
}
else
{
i++;
}
}
}
void
LrWpanMac::PrintPendTxQ (std::ostream &os) const
{
LrWpanMacHeader peekedMacHdr;
os << "Pending Transaction List ["
<< GetShortAddress ()
<< " | " << GetExtendedAddress () << "] | CurrentTime: "
<< Simulator::Now ().As (Time::S) << "\n"
<< " Destination | Sequence Number | Frame type | Expire time\n";
for (uint32_t i = 0; i < m_indTxQueue.size (); i++)
{
m_indTxQueue[i]->txQPkt->PeekHeader (peekedMacHdr);
os << m_indTxQueue[i]->dstExtAddress << " " << static_cast <uint32_t> (m_indTxQueue[i]->seqNum) << " ";
if (peekedMacHdr.IsCommand ())
{
os << "Cmd Frame ";
}
else if (peekedMacHdr.IsData ())
{
os << "Data Frame ";
}
else
{
os << "Unk Frame ";
}
os << m_indTxQueue[i]->expireTime.As (Time::S) << "\n";
}
}
void
LrWpanMac::RemovePendTxQElement (Ptr<Packet> p)
{
LrWpanMacHeader peekedMacHdr;
p->PeekHeader (peekedMacHdr);
for (auto it = m_indTxQueue.begin (); it != m_indTxQueue.end (); it++)
{
if (peekedMacHdr.GetDstAddrMode () == EXT_ADDR)
{
if (((*it)->dstExtAddress == peekedMacHdr.GetExtDstAddr ())
&& ((*it)->seqNum == peekedMacHdr.GetSeqNum ()))
{
m_macPendTxDequeueTrace (p);
m_indTxQueue.erase (it);
break;
}
}
else if (peekedMacHdr.GetDstAddrMode () == SHORT_ADDR)
{
if (((*it)->dstShortAddress == peekedMacHdr.GetShortDstAddr ())
&& ((*it)->seqNum == peekedMacHdr.GetSeqNum ()))
{
m_macPendTxDequeueTrace (p);
m_indTxQueue.erase (it);
break;
}
}
}
p = 0;
}
void
LrWpanMac::PdDataConfirm (LrWpanPhyEnumeration status)
{

497
src/lr-wpan/model/lr-wpan-mac.h
View File

File diff suppressed because it is too large Load Diff

2
src/lr-wpan/model/lr-wpan-phy.h
View File

@@ -456,7 +456,7 @@ public:
/**
* implement PLME SetAttribute confirm SAP
* bit rate is in kbit/s. Symbol rate is in ksymbol/s.
* bit rate is in bit/s. Symbol rate is in symbol/s.
* @param isData is true for data rate or false for symbol rate
* @return the rate value of this PHY
*/