A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
interference-helper.cc
Go to the documentation of this file.
1/*
2 * Copyright (c) 2005,2006 INRIA
3 *
4 * SPDX-License-Identifier: GPL-2.0-only
5 *
6 * Authors: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
7 * Sébastien Deronne <sebastien.deronne@gmail.com>
8 */
9
10#include "interference-helper.h"
11
12#include "error-rate-model.h"
13#include "phy-entity.h"
15#include "wifi-phy.h"
16#include "wifi-psdu.h"
17#include "wifi-utils.h"
18
19#include "ns3/he-ppdu.h"
20#include "ns3/log.h"
21#include "ns3/packet.h"
22#include "ns3/simulator.h"
23
24#include <algorithm>
25#include <numeric>
26
27namespace ns3
28{
29
30NS_LOG_COMPONENT_DEFINE("InterferenceHelper");
31
33
34/****************************************************************
35 * PHY event class
36 ****************************************************************/
37
39 : m_ppdu(ppdu),
41 m_endTime(m_startTime + duration),
42 m_rxPowerW(std::move(rxPower))
43{
44}
45
48{
49 return m_ppdu;
50}
51
52Time
54{
55 return m_startTime;
56}
57
58Time
60{
61 return m_endTime;
62}
63
64Time
66{
67 return m_endTime - m_startTime;
68}
69
72{
73 NS_ASSERT(!m_rxPowerW.empty());
74 // The total RX power corresponds to the maximum over all the bands
75 auto it =
76 std::max_element(m_rxPowerW.cbegin(),
77 m_rxPowerW.cend(),
78 [](const auto& p1, const auto& p2) { return p1.second < p2.second; });
79 return it->second;
80}
81
84{
85 const auto it = m_rxPowerW.find(band);
86 NS_ASSERT(it != m_rxPowerW.cend());
87 return it->second;
88}
89
92{
93 return m_rxPowerW;
94}
95
96void
98{
99 NS_ASSERT(rxPower.size() == m_rxPowerW.size());
100 // Update power band per band
101 for (auto& currentRxPowerW : m_rxPowerW)
102 {
103 auto band = currentRxPowerW.first;
104 auto it = rxPower.find(band);
105 if (it != rxPower.end())
106 {
107 currentRxPowerW.second += it->second;
108 }
109 }
110}
111
112void
114{
115 m_ppdu = ppdu;
116}
117
118std::ostream&
119operator<<(std::ostream& os, const Event& event)
120{
121 os << "start=" << event.GetStartTime() << ", end=" << event.GetEndTime()
122 << ", power=" << event.GetRxPower() << "W"
123 << ", PPDU=" << event.GetPpdu();
124 return os;
125}
126
127/****************************************************************
128 * Class which records SNIR change events for a
129 * short period of time.
130 ****************************************************************/
131
133 : m_power(power),
134 m_event(event)
135{
136}
137
138Watt_u
143
144void
149
155
156/****************************************************************
157 * The actual InterferenceHelper
158 ****************************************************************/
159
166
171
172TypeId
174{
175 static TypeId tid = TypeId("ns3::InterferenceHelper")
177 .SetGroupName("Wifi")
178 .AddConstructor<InterferenceHelper>();
179 return tid;
180}
181
182void
184{
185 NS_LOG_FUNCTION(this);
186 for (auto it : m_niChanges)
187 {
188 it.second.clear();
189 }
190 m_niChanges.clear();
191 m_firstPowers.clear();
192 m_errorRateModel = nullptr;
193}
194
197 Time duration,
199 const FrequencyRange& freqRange,
200 bool isStartHePortionRxing)
201{
202 Ptr<Event> event = Create<Event>(ppdu, duration, std::move(rxPowerW));
203 AppendEvent(event, freqRange, isStartHePortionRxing);
204 return event;
205}
206
207void
210 const FrequencyRange& freqRange)
211{
212 // Parameters other than duration and rxPowerW are unused for this type
213 // of signal, so we provide dummy versions
214 WifiMacHeader hdr;
216 hdr.SetQosTid(0);
218 WifiTxVector(),
220 Add(fakePpdu, duration, rxPowerW, freqRange);
221}
222
223bool
225{
226 return !m_niChanges.empty();
227}
228
229bool
231{
232 return m_niChanges.contains(band);
233}
234
235void
237{
238 NS_LOG_FUNCTION(this << band);
239 NS_ASSERT(!m_niChanges.contains(band));
240 NS_ASSERT(!m_firstPowers.contains(band));
241 NiChanges niChanges;
242 auto result = m_niChanges.insert({band, niChanges});
243 NS_ASSERT(result.second);
244 // Always have a zero power noise event in the list
245 AddNiChangeEvent(Time(0), NiChange(Watt_u{0}, nullptr), result.first);
246 m_firstPowers.insert({band, Watt_u{0}});
247}
248
249void
251{
252 NS_LOG_FUNCTION(this << band);
253 NS_ASSERT(m_firstPowers.count(band) != 0);
254 m_firstPowers.erase(band);
255 auto it = m_niChanges.find(band);
256 NS_ASSERT(it != std::end(m_niChanges));
257 it->second.clear();
258 m_niChanges.erase(it);
259}
260
261void
262InterferenceHelper::UpdateBands(const std::vector<WifiSpectrumBandInfo>& bands,
263 const FrequencyRange& freqRange)
264{
265 NS_LOG_FUNCTION(this << freqRange);
266 std::vector<WifiSpectrumBandInfo> bandsToRemove{};
267 for (auto it = m_niChanges.begin(); it != m_niChanges.end(); ++it)
269 if (!IsBandInFrequencyRange(it->first, freqRange))
270 {
271 continue;
272 }
273 const auto frequencies = it->first.frequencies;
274 const auto found =
275 std::find_if(bands.cbegin(), bands.cend(), [frequencies](const auto& item) {
276 return frequencies == item.frequencies;
277 }) != std::end(bands);
278 if (!found)
279 {
280 // band does not belong to the new bands, erase it
281 bandsToRemove.emplace_back(it->first);
282 }
283 }
284 for (const auto& band : bandsToRemove)
285 {
286 RemoveBand(band);
287 }
288 for (const auto& band : bands)
289 {
290 if (!HasBand(band))
291 {
292 // this is a new band, add it
293 AddBand(band);
294 }
295 }
296}
297
298void
300{
301 m_noiseFigure = value;
302}
303
304void
309
315
316void
321
324{
325 NS_LOG_FUNCTION(this << energy << band);
326 Time now = Simulator::Now();
327 auto niIt = m_niChanges.find(band);
328 NS_ABORT_IF(niIt == m_niChanges.end());
329 auto i = GetPreviousPosition(now, niIt);
330 Time end = i->first;
331 for (; i != niIt->second.end(); ++i)
332 {
333 const auto noiseInterference = i->second.GetPower();
334 end = i->first;
335 if (noiseInterference < energy)
336 {
337 break;
338 }
339 }
340 return end > now ? end - now : Time{0};
341}
342
343void
345 const FrequencyRange& freqRange,
346 bool isStartHePortionRxing)
347{
348 NS_LOG_FUNCTION(this << event << freqRange << isStartHePortionRxing);
349 for (const auto& [band, power] : event->GetRxPowerPerBand())
350 {
351 auto niIt = m_niChanges.find(band);
352 NS_ABORT_IF(niIt == m_niChanges.end());
353 Watt_u previousPowerStart{0.0};
354 Watt_u previousPowerEnd{0.0};
355 auto previousPowerPosition = GetPreviousPosition(event->GetStartTime(), niIt);
356 previousPowerStart = previousPowerPosition->second.GetPower();
357 previousPowerEnd = GetPreviousPosition(event->GetEndTime(), niIt)->second.GetPower();
358 if (const auto rxing = (m_rxing.contains(freqRange) && m_rxing.at(freqRange)); !rxing)
359 {
360 m_firstPowers.find(band)->second = previousPowerStart;
361 // Always leave the first zero power noise event in the list
362 niIt->second.erase(++(niIt->second.begin()), ++previousPowerPosition);
363 }
364 else if (isStartHePortionRxing)
365 {
366 // When the first HE portion is received, we need to set m_firstPowerPerBand
367 // so that it takes into account interferences that arrived between the start of the
368 // HE TB PPDU transmission and the start of HE TB payload.
369 m_firstPowers.find(band)->second = previousPowerStart;
370 }
371 auto first =
372 AddNiChangeEvent(event->GetStartTime(), NiChange(previousPowerStart, event), niIt);
373 auto last = AddNiChangeEvent(event->GetEndTime(), NiChange(previousPowerEnd, event), niIt);
374 for (auto i = first; i != last; ++i)
375 {
376 i->second.AddPower(power);
377 }
378 }
379}
380
381void
383{
384 NS_LOG_FUNCTION(this << event);
385 // This is called for UL MU events, in order to scale power as long as UL MU PPDUs arrive
386 for (const auto& [band, power] : rxPower)
387 {
388 auto niIt = m_niChanges.find(band);
389 NS_ABORT_IF(niIt == m_niChanges.end());
390 auto first = GetPreviousPosition(event->GetStartTime(), niIt);
391 auto last = GetPreviousPosition(event->GetEndTime(), niIt);
392 for (auto i = first; i != last; ++i)
393 {
394 i->second.AddPower(power);
395 }
396 }
397 event->UpdateRxPowerW(rxPower);
398}
399
400double
402 Watt_u noiseInterference,
403 MHz_u channelWidth,
404 uint8_t nss) const
405{
406 NS_LOG_FUNCTION(this << signal << noiseInterference << channelWidth << +nss);
407 // thermal noise at 290K in J/s = W
408 static const double BOLTZMANN = 1.3803e-23;
409 // Nt is the power of thermal noise in W
410 const auto Nt = BOLTZMANN * 290 * MHzToHz(channelWidth);
411 // receiver noise Floor which accounts for thermal noise and non-idealities of the receiver
412 Watt_u noiseFloor{m_noiseFigure * Nt};
413 Watt_u noise = noiseFloor + noiseInterference;
414 auto snr = signal / noise; // linear scale
415 NS_LOG_DEBUG("bandwidth=" << channelWidth << "MHz, signal=" << signal << "W, noise="
416 << noiseFloor << "W, interference=" << noiseInterference
417 << "W, snr=" << RatioToDb(snr) << "dB");
418 if (m_errorRateModel->IsAwgn())
419 {
420 double gain = 1;
421 if (m_numRxAntennas > nss)
422 {
423 gain = static_cast<double>(m_numRxAntennas) /
424 nss; // compute gain offered by diversity for AWGN
425 }
426 NS_LOG_DEBUG("SNR improvement thanks to diversity: " << 10 * std::log10(gain) << "dB");
427 snr *= gain;
428 }
429 return snr;
430}
431
432Watt_u
434 NiChangesPerBand& nis,
435 const WifiSpectrumBandInfo& band) const
436{
437 NS_LOG_FUNCTION(this << band);
438 auto firstPower_it = m_firstPowers.find(band);
439 NS_ABORT_IF(firstPower_it == m_firstPowers.end());
440 auto noiseInterference = firstPower_it->second;
441 auto niIt = m_niChanges.find(band);
442 NS_ABORT_IF(niIt == m_niChanges.end());
443 const auto now = Simulator::Now();
444 auto it = niIt->second.find(event->GetStartTime());
445 const auto muMimoPower = (event->GetPpdu()->GetType() == WIFI_PPDU_TYPE_UL_MU)
446 ? CalculateMuMimoPowerW(event, band)
447 : Watt_u{0.0};
448 for (; it != niIt->second.end() && it->first < now; ++it)
449 {
450 if (IsSameMuMimoTransmission(event, it->second.GetEvent()) &&
451 (event != it->second.GetEvent()))
452 {
453 // Do not calculate noiseInterferenceW if events belong to the same MU-MIMO transmission
454 // unless this is the same event
455 continue;
456 }
457 noiseInterference = it->second.GetPower() - event->GetRxPower(band) - muMimoPower;
458 if (std::abs(noiseInterference) < std::numeric_limits<double>::epsilon())
459 {
460 // fix some possible rounding issues with double values
461 noiseInterference = Watt_u{0.0};
462 }
463 }
464 it = niIt->second.find(event->GetStartTime());
465 NS_ABORT_IF(it == niIt->second.end());
466 for (; it != niIt->second.end() && it->second.GetEvent() != event; ++it)
467 {
468 ;
469 }
470 auto& ni = nis[band];
471 ni.emplace(event->GetStartTime(), NiChange(Watt_u{0}, event));
472 while (++it != niIt->second.end() && it->second.GetEvent() != event)
473 {
474 ni.insert(*it);
475 }
476 ni.emplace(event->GetEndTime(), NiChange(Watt_u{0}, event));
477 NS_ASSERT_MSG(noiseInterference >= Watt_u{0.0},
478 "CalculateNoiseInterferenceW returns negative value " << noiseInterference);
479 return noiseInterference;
480}
481
482Watt_u
484 const WifiSpectrumBandInfo& band) const
485{
486 auto niIt = m_niChanges.find(band);
487 NS_ASSERT(niIt != m_niChanges.end());
488 auto it = niIt->second.begin();
489 ++it;
490 Watt_u muMimoPower{0.0};
491 for (; it != niIt->second.end() && it->first < Simulator::Now(); ++it)
492 {
493 if (IsSameMuMimoTransmission(event, it->second.GetEvent()))
494 {
495 auto hePpdu = DynamicCast<HePpdu>(it->second.GetEvent()->GetPpdu()->Copy());
496 NS_ASSERT(hePpdu);
497 HePpdu::TxPsdFlag psdFlag = hePpdu->GetTxPsdFlag();
498 if (psdFlag == HePpdu::PSD_HE_PORTION)
499 {
500 const auto staId =
501 event->GetPpdu()->GetTxVector().GetHeMuUserInfoMap().cbegin()->first;
502 const auto otherStaId = it->second.GetEvent()
503 ->GetPpdu()
504 ->GetTxVector()
505 .GetHeMuUserInfoMap()
506 .cbegin()
507 ->first;
508 if (staId == otherStaId)
509 {
510 break;
511 }
512 muMimoPower += it->second.GetEvent()->GetRxPower(band);
513 }
514 }
515 }
516 return muMimoPower;
517}
518
519double
521 Time duration,
522 WifiMode mode,
523 const WifiTxVector& txVector,
524 WifiPpduField field) const
525{
526 if (duration.IsZero())
527 {
528 return 1.0;
529 }
530 const auto rate = mode.GetDataRate(txVector.GetChannelWidth());
531 auto nbits = static_cast<uint64_t>(rate * duration.GetSeconds());
532 const auto csr =
533 m_errorRateModel->GetChunkSuccessRate(mode, txVector, snir, nbits, m_numRxAntennas, field);
534 return csr;
535}
536
537double
539 Time duration,
540 const WifiTxVector& txVector,
541 uint16_t staId) const
542{
543 if (duration.IsZero())
544 {
545 return 1.0;
546 }
547 const auto mode = txVector.GetMode(staId);
548 const auto rate = mode.GetDataRate(txVector, staId);
549 auto nbits = static_cast<uint64_t>(rate * duration.GetSeconds());
550 nbits /= txVector.GetNss(staId); // divide effective number of bits by NSS to achieve same chunk
551 // error rate as SISO for AWGN
552 double csr = m_errorRateModel->GetChunkSuccessRate(mode,
553 txVector,
554 snir,
555 nbits,
558 staId);
559 return csr;
560}
561
562double
564 MHz_u channelWidth,
565 NiChangesPerBand* nis,
566 const WifiSpectrumBandInfo& band,
567 uint16_t staId,
568 std::pair<Time, Time> window) const
569{
570 NS_LOG_FUNCTION(this << channelWidth << band << staId << window.first << window.second);
571 double psr = 1.0; /* Packet Success Rate */
572 const auto& niIt = nis->find(band)->second;
573 auto j = niIt.cbegin();
574 auto previous = j->first;
575 Watt_u muMimoPower{0.0};
576 const auto payloadMode = event->GetPpdu()->GetTxVector().GetMode(staId);
577 auto phyPayloadStart = j->first;
578 if (event->GetPpdu()->GetType() != WIFI_PPDU_TYPE_UL_MU &&
579 event->GetPpdu()->GetType() !=
580 WIFI_PPDU_TYPE_DL_MU) // j->first corresponds to the start of the MU payload
581 {
582 phyPayloadStart = j->first + WifiPhy::CalculatePhyPreambleAndHeaderDuration(
583 event->GetPpdu()->GetTxVector());
584 }
585 else
586 {
587 muMimoPower = CalculateMuMimoPowerW(event, band);
588 }
589 const auto windowStart = phyPayloadStart + window.first;
590 const auto windowEnd = phyPayloadStart + window.second;
591 NS_ABORT_IF(!m_firstPowers.contains(band));
592 auto noiseInterference = m_firstPowers.at(band);
593 auto power = event->GetRxPower(band);
594 while (++j != niIt.cend())
595 {
596 Time current = j->first;
597 NS_LOG_DEBUG("previous= " << previous << ", current=" << current);
598 NS_ASSERT(current >= previous);
599 const auto snr = CalculateSnr(power,
600 noiseInterference,
601 channelWidth,
602 event->GetPpdu()->GetTxVector().GetNss(staId));
603 // Case 1: Both previous and current point to the windowed payload
604 if (previous >= windowStart)
605 {
607 Min(windowEnd, current) - previous,
608 event->GetPpdu()->GetTxVector(),
609 staId);
610 NS_LOG_DEBUG("Both previous and current point to the windowed payload: mode="
611 << payloadMode << ", psr=" << psr);
612 }
613 // Case 2: previous is before windowed payload and current is in the windowed payload
614 else if (current >= windowStart)
615 {
617 Min(windowEnd, current) - windowStart,
618 event->GetPpdu()->GetTxVector(),
619 staId);
621 "previous is before windowed payload and current is in the windowed payload: mode="
622 << payloadMode << ", psr=" << psr);
623 }
624 noiseInterference = j->second.GetPower() - power;
625 if (IsSameMuMimoTransmission(event, j->second.GetEvent()))
626 {
627 muMimoPower += j->second.GetEvent()->GetRxPower(band);
628 NS_LOG_DEBUG("PPDU belongs to same MU-MIMO transmission: muMimoPowerW=" << muMimoPower);
629 }
630 noiseInterference -= muMimoPower;
631 previous = j->first;
632 if (previous > windowEnd)
633 {
634 NS_LOG_DEBUG("Stop: new previous=" << previous
635 << " after time window end=" << windowEnd);
636 break;
637 }
638 }
639 const auto per = 1.0 - psr;
640 return per;
641}
642
643double
645 NiChangesPerBand* nis,
646 MHz_u channelWidth,
647 const WifiSpectrumBandInfo& band,
648 PhyHeaderSections phyHeaderSections) const
649{
650 NS_LOG_FUNCTION(this << band);
651 double psr = 1.0; /* Packet Success Rate */
652 auto niIt = nis->find(band)->second;
653 auto j = niIt.begin();
654
655 NS_ASSERT(!phyHeaderSections.empty());
656 Time stopLastSection;
657 for (const auto& section : phyHeaderSections)
658 {
659 stopLastSection = Max(stopLastSection, section.second.first.second);
660 }
661
662 auto previous = j->first;
663 NS_ABORT_IF(!m_firstPowers.contains(band));
664 auto noiseInterference = m_firstPowers.at(band);
665 const auto power = event->GetRxPower(band);
666 while (++j != niIt.end())
667 {
668 auto current = j->first;
669 NS_LOG_DEBUG("previous= " << previous << ", current=" << current);
670 NS_ASSERT(current >= previous);
671 const auto snr = CalculateSnr(power, noiseInterference, channelWidth, 1);
672 for (const auto& section : phyHeaderSections)
673 {
674 const auto start = section.second.first.first;
675 const auto stop = section.second.first.second;
676
677 if (previous <= stop || current >= start)
678 {
679 const auto duration = Min(stop, current) - Max(start, previous);
680 if (duration.IsStrictlyPositive())
681 {
682 psr *= CalculateChunkSuccessRate(snr,
683 duration,
684 section.second.second,
685 event->GetPpdu()->GetTxVector(),
686 section.first);
687 NS_LOG_DEBUG("Current NI change in "
688 << section.first << " [" << start << ", " << stop << "] for "
689 << duration.As(Time::NS) << ": mode=" << section.second.second
690 << ", psr=" << psr);
691 }
692 }
693 }
694 noiseInterference = j->second.GetPower() - power;
695 previous = j->first;
696 if (previous > stopLastSection)
697 {
698 NS_LOG_DEBUG("Stop: new previous=" << previous << " after stop of last section="
699 << stopLastSection);
700 break;
701 }
702 }
703 return psr;
704}
705
706double
708 NiChangesPerBand* nis,
709 MHz_u channelWidth,
710 const WifiSpectrumBandInfo& band,
711 WifiPpduField header) const
712{
713 NS_LOG_FUNCTION(this << band << header);
714 auto niIt = nis->find(band)->second;
715 auto phyEntity =
716 WifiPhy::GetStaticPhyEntity(event->GetPpdu()->GetTxVector().GetModulationClass());
717
718 PhyHeaderSections sections;
719 for (const auto& section :
720 phyEntity->GetPhyHeaderSections(event->GetPpdu()->GetTxVector(), niIt.begin()->first))
721 {
722 if (section.first == header)
723 {
724 sections[header] = section.second;
725 }
726 }
727
728 double psr = 1.0;
729 if (!sections.empty())
730 {
731 psr = CalculatePhyHeaderSectionPsr(event, nis, channelWidth, band, sections);
732 }
733 return 1 - psr;
734}
735
736SnrPer
738 MHz_u channelWidth,
739 const WifiSpectrumBandInfo& band,
740 uint16_t staId,
741 std::pair<Time, Time> relativeMpduStartStop) const
742{
743 NS_LOG_FUNCTION(this << channelWidth << band << staId << relativeMpduStartStop.first
744 << relativeMpduStartStop.second);
746 const auto noiseInterference = CalculateNoiseInterferenceW(event, ni, band);
747 const auto snr = CalculateSnr(event->GetRxPower(band),
748 noiseInterference,
749 channelWidth,
750 event->GetPpdu()->GetTxVector().GetNss(staId));
751
752 /* calculate the SNIR at the start of the MPDU (located through windowing) and accumulate
753 * all SNIR changes in the SNIR vector.
754 */
755 const auto per =
756 CalculatePayloadPer(event, channelWidth, &ni, band, staId, relativeMpduStartStop);
757
758 return SnrPer(snr, per);
759}
760
761double
763 MHz_u channelWidth,
764 uint8_t nss,
765 const WifiSpectrumBandInfo& band) const
766{
768 const auto noiseInterference = CalculateNoiseInterferenceW(event, ni, band);
769 return CalculateSnr(event->GetRxPower(band), noiseInterference, channelWidth, nss);
770}
771
772SnrPer
774 MHz_u channelWidth,
775 const WifiSpectrumBandInfo& band,
776 WifiPpduField header) const
777{
778 NS_LOG_FUNCTION(this << band << header);
780 const auto noiseInterference = CalculateNoiseInterferenceW(event, ni, band);
781 const auto snr = CalculateSnr(event->GetRxPower(band), noiseInterference, channelWidth, 1);
782
783 /* calculate the SNIR at the start of the PHY header and accumulate
784 * all SNIR changes in the SNIR vector.
785 */
786 const auto per = CalculatePhyHeaderPer(event, &ni, channelWidth, band, header);
787
788 return SnrPer(snr, per);
789}
790
791InterferenceHelper::NiChanges::iterator
792InterferenceHelper::GetNextPosition(Time moment, NiChangesPerBand::iterator niIt) const
793{
794 return niIt->second.upper_bound(moment);
795}
796
797InterferenceHelper::NiChanges::iterator
798InterferenceHelper::GetPreviousPosition(Time moment, NiChangesPerBand::iterator niIt) const
799{
800 // This is safe since there is always an NiChange at time 0, before moment.
801 return std::prev(GetNextPosition(moment, niIt));
802}
803
804InterferenceHelper::NiChanges::iterator
805InterferenceHelper::AddNiChangeEvent(Time moment, NiChange change, NiChangesPerBand::iterator niIt)
806{
807 return niIt->second.insert(GetNextPosition(moment, niIt), {moment, change});
808}
809
810void
812{
813 NS_LOG_FUNCTION(this << freqRange);
814 m_rxing[freqRange] = true;
815}
816
817void
819{
820 NS_LOG_FUNCTION(this << endTime << freqRange);
821 m_rxing.at(freqRange) = false;
822 // Update m_firstPowers for frame capture
823 for (auto niIt = m_niChanges.begin(); niIt != m_niChanges.end(); ++niIt)
824 {
825 if (!IsBandInFrequencyRange(niIt->first, freqRange))
826 {
827 continue;
828 }
829 NS_ASSERT(niIt->second.size() > 1);
830 auto it = std::prev(GetPreviousPosition(endTime, niIt));
831 m_firstPowers.find(niIt->first)->second = it->second.GetPower();
832 }
833}
834
835bool
837 const FrequencyRange& freqRange) const
838{
839 return std::all_of(band.frequencies.cbegin(),
840 band.frequencies.cend(),
841 [&freqRange](const auto& freqs) {
842 return ((freqs.second > MHzToHz(freqRange.minFrequency)) &&
843 (freqs.first < MHzToHz(freqRange.maxFrequency)));
844 });
845}
846
847bool
849 Ptr<const Event> otherEvent) const
850{
851 if ((currentEvent->GetPpdu()->GetType() == WIFI_PPDU_TYPE_UL_MU) &&
852 (otherEvent->GetPpdu()->GetType() == WIFI_PPDU_TYPE_UL_MU) &&
853 (currentEvent->GetPpdu()->GetUid() == otherEvent->GetPpdu()->GetUid()))
854 {
855 const auto currentTxVector = currentEvent->GetPpdu()->GetTxVector();
856 const auto otherTxVector = otherEvent->GetPpdu()->GetTxVector();
857 NS_ASSERT(currentTxVector.GetHeMuUserInfoMap().size() == 1);
858 NS_ASSERT(otherTxVector.GetHeMuUserInfoMap().size() == 1);
859 const auto currentUserInfo = currentTxVector.GetHeMuUserInfoMap().cbegin();
860 const auto otherUserInfo = otherTxVector.GetHeMuUserInfoMap().cbegin();
861 return (currentUserInfo->second.ru == otherUserInfo->second.ru);
862 }
863 return false;
864}
865
866} // namespace ns3
#define Max(a, b)
#define Min(a, b)
handles interference calculations
Time m_endTime
end time
Watt_u GetRxPower() const
Return the total received power.
Time m_startTime
start time
Event(Ptr< const WifiPpdu > ppdu, Time duration, RxPowerWattPerChannelBand &&rxPower)
Create an Event with the given parameters.
Ptr< const WifiPpdu > GetPpdu() const
Return the PPDU.
Ptr< const WifiPpdu > m_ppdu
PPDU.
void UpdateRxPowerW(const RxPowerWattPerChannelBand &rxPower)
Update the received power (W) for all bands, i.e.
Time GetEndTime() const
Return the end time of the signal.
Time GetDuration() const
Return the duration of the signal.
const RxPowerWattPerChannelBand & GetRxPowerPerBand() const
Return the received power (W) for all bands.
RxPowerWattPerChannelBand m_rxPowerW
received power in watts per band
Time GetStartTime() const
Return the start time of the signal.
void UpdatePpdu(Ptr< const WifiPpdu > ppdu)
Update the PPDU that initially generated the event.
TxPsdFlag
The transmit power spectral density flag, namely used to correctly build PSDs for pre-HE and HE porti...
Definition he-ppdu.h:104
@ PSD_HE_PORTION
HE portion of an HE PPDU.
Definition he-ppdu.h:106
Noise and Interference (thus Ni) event.
void AddPower(Watt_u power)
Add a given amount of power.
NiChange(Watt_u power, Ptr< Event > event)
Create a NiChange at the given time and the amount of NI change.
Watt_u GetPower() const
Return the power.
Ptr< Event > GetEvent() const
Return the event causes the corresponding NI change.
handles interference calculations
double CalculatePhyHeaderPer(Ptr< const Event > event, NiChangesPerBand *nis, MHz_u channelWidth, const WifiSpectrumBandInfo &band, WifiPpduField header) const
Calculate the error rate of the PHY header.
void SetNoiseFigure(double value)
Set the noise figure.
Ptr< Event > Add(Ptr< const WifiPpdu > ppdu, Time duration, RxPowerWattPerChannelBand &rxPower, const FrequencyRange &freqRange, bool isStartHePortionRxing=false)
Add the PPDU-related signal to interference helper.
double m_noiseFigure
noise figure (linear)
std::map< FrequencyRange, bool > m_rxing
flag whether it is in receiving state for a given FrequencyRange
Ptr< ErrorRateModel > GetErrorRateModel() const
Return the error rate model.
NiChanges::iterator AddNiChangeEvent(Time moment, NiChange change, NiChangesPerBand::iterator niIt)
Add NiChange to the list at the appropriate position and return the iterator of the new event.
std::map< WifiSpectrumBandInfo, NiChanges > NiChangesPerBand
Map of NiChanges per band.
void NotifyRxStart(const FrequencyRange &freqRange)
Notify that RX has started.
NiChanges::iterator GetNextPosition(Time moment, NiChangesPerBand::iterator niIt) const
Returns an iterator to the first NiChange that is later than moment.
uint8_t m_numRxAntennas
the number of RX antennas in the corresponding receiver
bool IsBandInFrequencyRange(const WifiSpectrumBandInfo &band, const FrequencyRange &freqRange) const
Check whether a given band belongs to a given frequency range.
void DoDispose() override
Destructor implementation.
std::multimap< Time, NiChange > NiChanges
typedef for a multimap of NiChange
Time GetEnergyDuration(Watt_u energy, const WifiSpectrumBandInfo &band)
NiChangesPerBand m_niChanges
NI Changes for each band.
void UpdateBands(const std::vector< WifiSpectrumBandInfo > &bands, const FrequencyRange &freqRange)
Update the frequency bands that belongs to a given frequency range when the spectrum model is changed...
void SetErrorRateModel(const Ptr< ErrorRateModel > rate)
Set the error rate model for this interference helper.
bool HasBands() const
Check whether bands are already tracked by this interference helper.
void AddForeignSignal(Time duration, RxPowerWattPerChannelBand &rxPower, const FrequencyRange &freqRange)
Add a non-Wifi signal to interference helper.
double CalculatePayloadChunkSuccessRate(double snir, Time duration, const WifiTxVector &txVector, uint16_t staId=SU_STA_ID) const
Calculate the success rate of the payload chunk given the SINR, duration, and TXVECTOR.
Ptr< ErrorRateModel > m_errorRateModel
error rate model
SnrPer CalculatePhyHeaderSnrPer(Ptr< Event > event, MHz_u channelWidth, const WifiSpectrumBandInfo &band, WifiPpduField header) const
Calculate the SNIR at the start of the PHY header and accumulate all SNIR changes in the SNIR vector.
FirstPowerPerBand m_firstPowers
first power of each band
bool IsSameMuMimoTransmission(Ptr< const Event > currentEvent, Ptr< const Event > otherEvent) const
Return whether another event is a MU-MIMO event that belongs to the same transmission and to the same...
double CalculateChunkSuccessRate(double snir, Time duration, WifiMode mode, const WifiTxVector &txVector, WifiPpduField field) const
Calculate the success rate of the chunk given the SINR, duration, and TXVECTOR.
bool HasBand(const WifiSpectrumBandInfo &band) const
Check whether a given band is tracked by this interference helper.
void AddBand(const WifiSpectrumBandInfo &band)
Add a frequency band.
Watt_u CalculateMuMimoPowerW(Ptr< const Event > event, const WifiSpectrumBandInfo &band) const
Calculate power of all other events preceding a given event that belong to the same MU-MIMO transmiss...
void AppendEvent(Ptr< Event > event, const FrequencyRange &freqRange, bool isStartHePortionRxing)
Append the given Event.
static TypeId GetTypeId()
Get the type ID.
void UpdateEvent(Ptr< Event > event, const RxPowerWattPerChannelBand &rxPower)
Update event to scale its received power (W) per band.
void RemoveBand(const WifiSpectrumBandInfo &band)
Remove a frequency band.
void NotifyRxEnd(Time endTime, const FrequencyRange &freqRange)
Notify that RX has ended.
Watt_u CalculateNoiseInterferenceW(Ptr< Event > event, NiChangesPerBand &nis, const WifiSpectrumBandInfo &band) const
Calculate noise and interference power.
void SetNumberOfReceiveAntennas(uint8_t rx)
Set the number of RX antennas in the receiver corresponding to this interference helper.
SnrPer CalculatePayloadSnrPer(Ptr< Event > event, MHz_u channelWidth, const WifiSpectrumBandInfo &band, uint16_t staId, std::pair< Time, Time > relativeMpduStartStop) const
Calculate the SNIR at the start of the payload and accumulate all SNIR changes in the SNIR vector for...
NiChanges::iterator GetPreviousPosition(Time moment, NiChangesPerBand::iterator niIt) const
Returns an iterator to the last NiChange that is before than moment.
double CalculateSnr(Ptr< Event > event, MHz_u channelWidth, uint8_t nss, const WifiSpectrumBandInfo &band) const
Calculate the SNIR for the event (starting from now until the event end).
double CalculatePayloadPer(Ptr< const Event > event, MHz_u channelWidth, NiChangesPerBand *nis, const WifiSpectrumBandInfo &band, uint16_t staId, std::pair< Time, Time > window) const
Calculate the error rate of the given PHY payload only in the provided time window (thus enabling per...
double CalculatePhyHeaderSectionPsr(Ptr< const Event > event, NiChangesPerBand *nis, MHz_u channelWidth, const WifiSpectrumBandInfo &band, PhyHeaderSections phyHeaderSections) const
Calculate the success rate of the PHY header sections for the provided event.
A base class which provides memory management and object aggregation.
Definition object.h:78
Smart pointer class similar to boost::intrusive_ptr.
Definition ptr.h:67
Control the scheduling of simulation events.
Definition simulator.h:57
static Time Now()
Return the current simulation virtual time.
Definition simulator.cc:197
Simulation virtual time values and global simulation resolution.
Definition nstime.h:96
double GetSeconds() const
Get an approximation of the time stored in this instance in the indicated unit.
Definition nstime.h:394
@ NS
nanosecond
Definition nstime.h:110
bool IsZero() const
Exactly equivalent to t == 0.
Definition nstime.h:306
a unique identifier for an interface.
Definition type-id.h:49
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition type-id.cc:1001
Implements the IEEE 802.11 MAC header.
virtual void SetType(WifiMacType type, bool resetToDsFromDs=true)
Set Type/Subtype values with the correct values depending on the given type.
void SetQosTid(uint8_t tid)
Set the TID for the QoS header.
represent a single transmission mode
Definition wifi-mode.h:38
uint64_t GetDataRate(MHz_u channelWidth, Time guardInterval, uint8_t nss) const
Definition wifi-mode.cc:110
static const std::shared_ptr< const PhyEntity > GetStaticPhyEntity(WifiModulationClass modulation)
Get the implemented PHY entity corresponding to the modulation class.
Definition wifi-phy.cc:760
static Time CalculatePhyPreambleAndHeaderDuration(const WifiTxVector &txVector)
Definition wifi-phy.cc:1561
Class that keeps track of all information about the current PHY operating channel.
This class mimics the TXVECTOR which is to be passed to the PHY in order to define the parameters whi...
WifiMode GetMode(uint16_t staId=SU_STA_ID) const
If this TX vector is associated with an SU PPDU, return the selected payload transmission mode.
uint8_t GetNss(uint16_t staId=SU_STA_ID) const
If this TX vector is associated with an SU PPDU, return the number of spatial streams.
MHz_u GetChannelWidth() const
#define NS_ASSERT(condition)
At runtime, in debugging builds, if this condition is not true, the program prints the source file,...
Definition assert.h:55
#define NS_ASSERT_MSG(condition, message)
At runtime, in debugging builds, if this condition is not true, the program prints the message to out...
Definition assert.h:75
#define NS_ABORT_IF(cond)
Abnormal program termination if a condition is true.
Definition abort.h:65
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition log.h:191
#define NS_LOG_DEBUG(msg)
Use NS_LOG to output a message of level LOG_DEBUG.
Definition log.h:257
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by ",...
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition object-base.h:35
Ptr< T > Create(Ts &&... args)
Create class instances by constructors with varying numbers of arguments and return them by Ptr.
Definition ptr.h:439
Time Now()
create an ns3::Time instance which contains the current simulation time.
Definition simulator.cc:294
WifiPpduField
The type of PPDU field (grouped for convenience)
@ WIFI_PPDU_TYPE_DL_MU
@ WIFI_PPDU_TYPE_UL_MU
@ WIFI_PPDU_FIELD_DATA
data field
Definition first.py:1
Every class exported by the ns3 library is enclosed in the ns3 namespace.
std::map< WifiSpectrumBandInfo, Watt_u > RxPowerWattPerChannelBand
A map of the received power for each band.
dB_u RatioToDb(double ratio)
Convert from ratio to dB.
Definition wifi-utils.cc:45
std::ostream & operator<<(std::ostream &os, const Angles &a)
Definition angles.cc:148
std::map< WifiPpduField, PhyHeaderChunkInfo > PhyHeaderSections
A map of PhyHeaderChunkInfo elements per PPDU field.
double MHz_u
MHz weak type.
Definition wifi-units.h:31
Ptr< T1 > DynamicCast(const Ptr< T2 > &p)
Cast a Ptr.
Definition ptr.h:585
@ WIFI_MAC_QOSDATA
Hz_u MHzToHz(MHz_u val)
Convert from MHz to Hz.
Definition wifi-utils.h:120
double Watt_u
Watt weak type.
Definition wifi-units.h:25
STL namespace.
Declaration of:
Struct defining a frequency range between minFrequency and maxFrequency.
A struct for both SNR and PER.
WifiSpectrumBandInfo structure containing info about a spectrum band.
std::vector< WifiSpectrumBandFrequencies > frequencies
the start and stop frequencies for each segment of the band