35 #include <ns3/double.h>
38 #include <ns3/pointer.h>
39 #include <ns3/simulator.h>
40 #include <ns3/uinteger.h>
44 NS_LOG_COMPONENT_DEFINE(
"SatGeoFeederPhy");
49 NS_OBJECT_ENSURE_REGISTERED(SatGeoFeederPhy);
55 TypeId(
"ns3::SatGeoFeederPhy")
57 .AddConstructor<SatGeoFeederPhy>()
58 .AddAttribute(
"PhyRx",
59 "The PhyRx layer attached to this phy.",
62 MakePointerChecker<SatPhyRx>())
63 .AddAttribute(
"PhyTx",
64 "The PhyTx layer attached to this phy.",
67 MakePointerChecker<SatPhyTx>())
68 .AddAttribute(
"RxTemperatureDbk",
69 "RX noise temperature in Geo Feeder in dBK.",
73 MakeDoubleChecker<double>())
76 "Maximum RX gain in dB",
79 MakeDoubleChecker<double_t>())
82 "Maximum TX gain in dB",
85 MakeDoubleChecker<double_t>())
86 .AddAttribute(
"TxMaxPowerDbw",
87 "Maximum TX power in dB",
90 MakeDoubleChecker<double>())
93 "TX Output loss in dB",
96 MakeDoubleChecker<double>())
99 "TX Pointing loss in dB",
102 MakeDoubleChecker<double>())
103 .AddAttribute(
"TxOboLossDb",
107 MakeDoubleChecker<double>())
110 "TX Antenna loss in dB",
113 MakeDoubleChecker<double>())
116 "RX Antenna loss in dB",
119 MakeDoubleChecker<double>())
120 .AddAttribute(
"DefaultFadingValue",
121 "Default value for fading",
124 MakeDoubleChecker<double_t>())
125 .AddAttribute(
"ExtNoisePowerDensityDbwhz",
126 "Other system interference, C over I in dB.",
129 MakeDoubleChecker<double>())
130 .AddAttribute(
"ImIfCOverIDb",
131 "Adjacent channel interference, C over I in dB.",
134 MakeDoubleChecker<double>())
135 .AddAttribute(
"FixedAmplificationGainDb",
136 "Fixed amplification gain used in RTN link at the satellite.",
139 MakeDoubleChecker<double>())
140 .AddAttribute(
"QueueSize",
141 "Maximum size of FIFO m_queue in bytes.",
142 UintegerValue(100000),
144 MakeUintegerChecker<uint32_t>())
145 .AddTraceSource(
"QueueSizeBytes",
146 "Send number of bytes in FIFO return feeder queue",
148 "ns3::SatStatsRtnFeederQueueHelper::QueueSizeCallback")
149 .AddTraceSource(
"QueueSizePackets",
150 "Send number of packets in FIFO return feeder queue",
152 "ns3::SatStatsRtnFeederQueueHelper::QueueSizeCallback");
159 NS_LOG_FUNCTION(
this);
165 : m_extNoisePowerDensityDbwHz(-207.0),
166 m_imInterferenceCOverIDb(27.0),
167 m_imInterferenceCOverI(
SatUtils::DbToLinear(m_imInterferenceCOverIDb)),
168 m_fixedAmplificationGainDb(82.0),
170 m_queueSizePackets(0)
172 NS_LOG_FUNCTION(
this);
173 NS_FATAL_ERROR(
"SatGeoFeederPhy default constructor is not allowed to use");
177 Ptr<SatLinkResults> linkResults,
178 SatPhyRxCarrierConf::RxCarrierCreateParams_s parameters,
179 Ptr<SatSuperframeConf> superFrameConf,
184 NS_LOG_FUNCTION(
this);
194 m_queue = std::queue<std::tuple<Ptr<SatSignalParameters>, uint32_t, uint32_t>>();
206 ObjectBase::ConstructSelf(AttributeConstructionList());
215 parameters.m_aciIfWrtNoiseFactor = 0.0;
224 parameters.m_linkRegenerationMode = forwardLinkRegenerationMode;
227 Ptr<SatPhyRxCarrierConf> carrierConf = CreateObject<SatPhyRxCarrierConf>(parameters);
231 carrierConf->SetLinkResults(linkResults);
234 carrierConf->SetAdditionalInterferenceCb(
242 NS_LOG_FUNCTION(
this);
248 NS_LOG_FUNCTION(
this);
255 NS_LOG_FUNCTION(
this);
256 Object::DoInitialize();
262 NS_LOG_FUNCTION(
this << txParams);
263 NS_LOG_INFO(
this <<
" sending a packet with carrierId: " << txParams->m_carrierId
264 <<
" duration: " << txParams->m_duration);
287 txParams->m_txPower_W =
302 uint32_t nbBytes = 0;
303 for (Ptr<Packet> pkt : txParams->m_packetsInBurst)
305 nbBytes += pkt->GetSize();
307 uint32_t nbPackets = txParams->m_packetsInBurst.size();
311 m_queue.push(std::make_tuple(txParams, nbBytes, nbPackets));
328 NS_LOG_INFO(
"Packet dropped because REGENERATION_PHY queue is full");
353 NS_FATAL_ERROR(
"Trying to deque an empty queue");
356 std::tuple<Ptr<SatSignalParameters>, uint32_t, uint32_t> element =
m_queue.front();
359 Ptr<SatSignalParameters> txParams = std::get<0>(element);
394 NS_LOG_FUNCTION(
this);
398 SatSignalParameters::PacketsInBurst_t::iterator it1;
399 for (it1 = packets.begin(); it1 != packets.end(); ++it1)
404 if ((*it1)->PeekPacketTag(addressE2ETag))
406 NS_LOG_DEBUG(
this <<
" contains a SatMac tag");
413 if ((*it1)->RemovePacketTag(linkTimeTag))
415 NS_LOG_DEBUG(
this <<
" contains a SatPhyLinkTimeTag tag");
434 NS_LOG_FUNCTION(
this << rxParams);
451 NS_LOG_INFO(
this <<
" dropped " << rxParams->m_packetsInBurst.size()
452 <<
" packets because of PHY error.");
464 SatSignalParameters::PacketsInBurst_t::iterator it;
465 for (it = rxParams->m_packetsInBurst.begin(); it != rxParams->m_packetsInBurst.end();
469 (*it)->RemovePacketTag(satUplinkInfoTag);
470 satUplinkInfoTag.
SetSatId(rxParams->m_satId);
471 satUplinkInfoTag.
SetBeamId(rxParams->m_beamId);
472 (*it)->AddPacketTag(satUplinkInfoTag);
475 RxTraces(rxParams->m_packetsInBurst);
482 NS_FATAL_ERROR(
"Unknown regeneration mode");
492 NS_LOG_FUNCTION(
this);
512 SatSignalParameters::PacketsInBurst_t::iterator it1;
513 for (it1 = packets.begin(); it1 != packets.end(); ++it1)
516 ByteTagIterator it2 = (*it1)->GetByteTagIterator();
518 while (it2.HasNext())
520 ByteTagIterator::Item item = it2.Next();
525 item.GetTag(addrTag);
530 return Mac48Address();
This class implements a tag that carries the satellite MAC of GW and UT.
Mac48Address GetE2EDestAddress(void) const
Get E2E destination MAC address.
This class implements a tag that carries the MAC address of the sender of the packet.
static TypeId GetTypeId()
Inherited from ObjectBase base class.
Address GetSourceAddress() const
Get the source address.
SatLinkDir_t
Link direction used for packet tracing.
SatPacketEvent_t
Packet event used for packet tracing.
@ PACKET_TYPE_DEDICATED_ACCESS
RegenerationMode_t
The regeneration mode used in satellites.
virtual ~SatGeoFeederPhy()
Destructor for SatGeoFeederPhy.
uint32_t m_queueSizeMax
Maximum size of FIFO m_queue in bytes.
virtual double GetAdditionalInterference()
Get additional interference, used to compute final SINR at RX.
static TypeId GetTypeId(void)
inherited from Object
double m_imInterferenceCOverI
Intermodulation interference in linear.
virtual void DoDispose(void)
Dispose of this class instance.
virtual void SendPduWithParams(Ptr< SatSignalParameters > rxParams)
Send Pdu to the PHY tx module (for GEO satellite switch packet forwarding)
virtual void RxTraces(SatPhy::PacketContainer_t packets)
Invoke the Rx trace source for each received packet.
uint32_t m_queueSizeBytes
Size of FIFO queue in bytes.
SatEnums::RegenerationMode_t m_returnLinkRegenerationMode
Regeneration mode on return link.
SatGeoFeederPhy(void)
Default constructor.
std::queue< std::tuple< Ptr< SatSignalParameters >, uint32_t, uint32_t > > m_queue
Simple FIFO queue to avoid collisions on TX in case of REGENERATION_PHY.
virtual void Receive(Ptr< SatSignalParameters > rxParams, bool phyError)
Receives packets from lower layer.
double m_fixedAmplificationGainDb
Fixed amplification gain used in RTN link at the satellite.
virtual SatEnums::SatLinkDir_t GetSatLinkRxDir()
Get the link RX direction.
SatEnums::RegenerationMode_t m_forwardLinkRegenerationMode
Regeneration mode on forward link.
void SendFromQueue()
Send a packet from the queue.
bool m_isSending
Indicates if a packet is already being sent.
virtual SatEnums::SatLinkDir_t GetSatLinkTxDir()
Get the link TX direction.
Address GetE2ESourceAddress(SatPhy::PacketContainer_t packets)
Get source address of packets.
virtual void DoInitialize(void)
Initialization of SatPhy.
TypeId GetInstanceTypeId(void) const
double m_imInterferenceCOverIDb
Configured Intermodulation interference in dB.
uint32_t m_queueSizePackets
Size of FIFO queue in packets.
void EndTx()
Notify a packet has finished being sent.
TracedCallback< uint32_t, const Address & > m_queueSizePacketsTrace
Traced callback to monitor RTN feeder queue size in packets.
double m_extNoisePowerDensityDbwHz
Configured external noise power.
TracedCallback< uint32_t, const Address & > m_queueSizeBytesTrace
Traced callback to monitor RTN feeder queue size in bytes.
The SatPhy models the basic physical layer of the satellite system.
void SetTxPointingLossDb(double lossDb)
Set the pointing loss of the transmitter in dB.
TracedCallback< Time, SatEnums::SatPacketEvent_t, SatEnums::SatNodeType_t, uint32_t, Mac48Address, SatEnums::SatLogLevel_t, SatEnums::SatLinkDir_t, std::string > m_packetTrace
Trace callback used for packet tracing:
void SetTimeTag(SatPhy::PacketContainer_t packets)
Set SatPhyTimeTag of packets.
void SetRxAntennaGainDb(double gainDb)
Set the maximum antenna gain of the receiver in dB.
void ConfigureRxCarriers(Ptr< SatPhyRxCarrierConf > carrierConf, Ptr< SatSuperframeConf > superFrameConf)
Configure Rx carriers.
virtual Ptr< SatPhyTx > GetPhyTx() const
Get the SatPhyTx pointer.
void SetTxOboLossDb(double lossDb)
Set the OBO loss of the transmitter in dB.
TracedCallback< const Time &, const Address & > m_rxLinkDelayTrace
Traced callback for all received packets, including link delay information and the address of the sen...
void SetDefaultFading(double fading)
Set the default fading of the PHY.
double GetTxOutputLossDb() const
Get the output loss of the transmitter in dB.
double GetTxAntennaGainDb() const
Get the maximum antenna gain of the transmitter in dB.
virtual Ptr< SatPhyRx > GetPhyRx() const
Get the SatPhyRx pointer.
void SetTxOutputLossDb(double lossDb)
Set the output loss of the transmitter in dB.
double GetTxPointingLossDb() const
Get the pointing loss of the transmitter in dB.
Ptr< SatNodeInfo > m_nodeInfo
Node info containing node related information, such as node type, node id and MAC address (of the Sat...
double GetDefaultFading() const
Get the default fading of the PHY.
double GetTxMaxPowerDbw() const
Get the maximum transmit power of the transmitter in dB.
double GetTxOboLossDb() const
Get the OBO loss of the transmitter in dB.
void SetTxMaxPowerDbw(double powerDb)
Set the maximum transmit power of the transmitter in dB.
TracedCallback< Ptr< const Packet >, const Address & > m_rxTrace
Traced callback for all received packets, including the address of the senders.
double GetRxAntennaGainDb() const
Get the maximum antenna gain of the receiver in dB.
double m_eirpWoGainW
Calculated EIRP without gain in W.
virtual void SetPhyTx(Ptr< SatPhyTx > phyTx)
Set the SatPhyTx module.
void SetRxAntennaLossDb(double lossDb)
Set the antenna loss of the receiver in dB.
void SetRxNoiseTemperatureDbk(double temperatureDbk)
Set the noise temperature of the receiver in dbK.
double GetRxNoiseTemperatureDbk() const
Get the noise temperature of the receiver in dbK.
double GetRxAntennaLossDb() const
Get the antenna loss of the receiver in dB.
Ptr< SatPhyTx > m_phyTx
Pointer to internal SatPhyTx instance.
void ModcodTrace(Ptr< SatSignalParameters > rxParams)
Invoke the RxLinkModcod trace source for each received packet.
void SetTxAntennaGainDb(double gainDb)
Set the maximum antenna gain of the transmitter in dB.
bool m_isStatisticsTagsEnabled
EnableStatisticsTags attribute.
Time m_lastLinkDelay
Last delay measurement for link.
SatSignalParameters::PacketsInBurst_t PacketContainer_t
Define PacketContainer in SatPhy.
void SetTxAntennaLossDb(double lossDb)
Set the antenna loss of the transmitter in dB.
virtual void SetPhyRx(Ptr< SatPhyRx > phyRx)
Set the SatPhyRx module.
SatPhy::ReceiveCallback m_rxCallback
The upper layer package receive callback.
TracedCallback< const Time &, const Address & > m_rxLinkJitterTrace
Traced callback for all received packets, including link jitter information and the address of the se...
double GetTxAntennaLossDb() const
Get the antenna loss of the transmitter in dB.
Time tag used to identify the time when packet is enqueued at PHY on current link level.
Time GetSenderLinkTimestamp(void) const
Get sender time stamp of this tag.
Tag to store uplink phy info that need to be forwarded to the downlink.
void SetBeamId(uint32_t beamId)
Set the UT beam ID.
void SetSatId(uint32_t satId)
Set the UT sat ID.
SatUtils class is for general conversions used in satellite module.
static T DbToLinear(T db)
Converts decibels to linear.
static T LinearToDb(T linear)
Converts linear to decibels.
static std::string GetPacketInfo(const Ptr< const Packet > p)
Get packet information in std::string for printing purposes.
SatArqSequenceNumber is handling the sequence numbers for the ARQ process.
Creation parameters for base PHY object.