phy-entity.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2020 Orange Labs
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Authors: Rediet <getachew.redieteab@orange.com>
 *          Sébastien Deronne <sebastien.deronne@gmail.com> (for logic ported from wifi-phy and spectrum-wifi-phy)
 *          Mathieu Lacage <mathieu.lacage@sophia.inria.fr> (for logic ported from wifi-phy)
 */

#ifndef PHY_ENTITY_H
#define PHY_ENTITY_H

#include "wifi-mpdu-type.h"
#include "wifi-tx-vector.h"
#include "wifi-phy-band.h"
#include "wifi-ppdu.h"
#include "wifi-mpdu-type.h"
#include "wifi-ppdu.h"
#include "ns3/event-id.h"
#include "ns3/simple-ref-count.h"
#include "ns3/nstime.h"
#include "ns3/wifi-spectrum-value-helper.h"
#include <list>
#include <map>
#include <tuple>

namespace ns3 {

struct SignalNoiseDbm
{
  double signal; 
  double noise;  
};

struct MpduInfo
{
  MpduType type;          
  uint32_t mpduRefNumber; 
};

struct RxSignalInfo
{
  double snr;  
  double rssi; 
};

typedef std::map <WifiSpectrumBand, double> RxPowerWattPerChannelBand;

class WifiPsdu;
class WifiPhy;
class InterferenceHelper;
class Event;
class WifiPhyStateHelper;
class WifiPsdu;
class WifiPpdu;

class PhyEntity : public SimpleRefCount<PhyEntity>
{
public:

  enum PhyRxFailureAction
  {
    DROP = 0, 
    ABORT,    
    IGNORE    
  };

  struct PhyFieldRxStatus
  {
    /* *NS_CHECK_STYLE_OFF* */
    bool isSuccess {true}; 
    WifiPhyRxfailureReason reason {UNKNOWN}; 
    PhyRxFailureAction actionIfFailure {DROP}; 

    PhyFieldRxStatus (bool s) : isSuccess (s) {};
    PhyFieldRxStatus (bool s, WifiPhyRxfailureReason r, PhyRxFailureAction a) : isSuccess (s), reason (r), actionIfFailure (a) {};
    /* *NS_CHECK_STYLE_ON* */
  };

  struct SnrPer
  {
    double snr {0.0}; 
    double per {1.0}; 

    SnrPer () {};
    SnrPer (double s, double p) : snr (s), per (p) {};
  };

  virtual ~PhyEntity ();

  void SetOwner (Ptr<WifiPhy> wifiPhy);

  virtual bool IsModeSupported (WifiMode mode) const;
  virtual uint8_t GetNumModes (void) const;

  virtual WifiMode GetMcs (uint8_t index) const;
  virtual bool IsMcsSupported (uint8_t index) const;
  virtual bool HandlesMcsModes (void) const;

  virtual WifiMode GetSigMode (WifiPpduField field, const WifiTxVector& txVector) const;

  std::list<WifiMode>::const_iterator begin (void) const;
  std::list<WifiMode>::const_iterator end (void) const;

  WifiPpduField GetNextField (WifiPpduField currentField, WifiPreamble preamble) const;

  virtual Time GetDuration (WifiPpduField field, const WifiTxVector& txVector) const;
  Time CalculatePhyPreambleAndHeaderDuration (const WifiTxVector& txVector) const;

  virtual Time GetPayloadDuration (uint32_t size, const WifiTxVector& txVector, WifiPhyBand band, MpduType mpdutype,
                                   bool incFlag, uint32_t &totalAmpduSize, double &totalAmpduNumSymbols,
                                   uint16_t staId) const = 0;

  virtual WifiConstPsduMap GetWifiConstPsduMap (Ptr<const WifiPsdu> psdu, const WifiTxVector& txVector) const;

  virtual uint32_t GetMaxPsduSize (void) const = 0;

  typedef std::pair<std::pair<Time /* start */, Time /* stop */>, WifiMode> PhyHeaderChunkInfo;
  typedef std::map<WifiPpduField, PhyHeaderChunkInfo> PhyHeaderSections;
  PhyHeaderSections GetPhyHeaderSections (const WifiTxVector& txVector, Time ppduStart) const;

  virtual Ptr<WifiPpdu> BuildPpdu (const WifiConstPsduMap & psdus, const WifiTxVector& txVector, Time ppduDuration);

  Time GetDurationUpToField (WifiPpduField field, const WifiTxVector& txVector) const;
  Time GetRemainingDurationAfterField (Ptr<const WifiPpdu> ppdu, WifiPpduField field) const;

  virtual Ptr<const WifiPsdu> GetAddressedPsduInPpdu (Ptr<const WifiPpdu> ppdu) const;

  virtual void StartReceivePreamble (Ptr<WifiPpdu> ppdu, RxPowerWattPerChannelBand rxPowersW,
                                     Time rxDuration);
  void StartReceiveField (WifiPpduField field, Ptr<Event> event);
  void EndReceiveField (WifiPpduField field, Ptr<Event> event);

  void EndReceivePayload (Ptr<Event> event);

  void ResetReceive (Ptr<Event> event);

  virtual void CancelAllEvents (void);
  bool NoEndPreambleDetectionEvents (void) const;
  void CancelRunningEndPreambleDetectionEvents (bool clear = false);

  virtual uint16_t GetStaId (const Ptr<const WifiPpdu> ppdu) const;

  virtual uint16_t GetMeasurementChannelWidth (const Ptr<const WifiPpdu> ppdu) const;

  virtual uint16_t GetRxChannelWidth (const WifiTxVector& txVector) const;

  virtual void StartTx (Ptr<WifiPpdu> ppdu);

  void Transmit (Time txDuration, Ptr<WifiPpdu> ppdu, std::string type);

  virtual Time CalculateTxDuration (WifiConstPsduMap psduMap, const WifiTxVector& txVector, WifiPhyBand band) const;

protected:
  typedef std::map<WifiPreamble, std::vector<WifiPpduField> > PpduFormats;

  typedef std::pair<WifiCodeRate, uint16_t> CodeRateConstellationSizePair;

  typedef std::map<std::string, CodeRateConstellationSizePair> ModulationLookupTable;

  virtual const PpduFormats & GetPpduFormats (void) const = 0;

  virtual bool DoStartReceiveField (WifiPpduField field, Ptr<Event> event);
  virtual PhyFieldRxStatus DoEndReceiveField (WifiPpduField field, Ptr<Event> event);

  virtual Ptr<Event> DoGetEvent (Ptr<const WifiPpdu> ppdu, RxPowerWattPerChannelBand rxPowersW);
  virtual PhyFieldRxStatus DoEndReceivePreamble (Ptr<Event> event);
  void StartPreambleDetectionPeriod (Ptr<Event> event);
  void EndPreambleDetectionPeriod (Ptr<Event> event);

  void StartReceivePayload (Ptr<Event> event);

  virtual void DoStartReceivePayload (Ptr<Event> event);

  virtual void DoResetReceive (Ptr<Event> event);

  virtual void DoAbortCurrentReception (WifiPhyRxfailureReason reason);

  virtual bool IsConfigSupported (Ptr<const WifiPpdu> ppdu) const;

  void DropPreambleEvent (Ptr<const WifiPpdu> ppdu, WifiPhyRxfailureReason reason, Time endRx, uint16_t measurementChannelWidth);

  void ErasePreambleEvent (Ptr<const WifiPpdu> ppdu, Time rxDuration);

  std::pair<bool, SignalNoiseDbm> GetReceptionStatus (Ptr<const WifiPsdu> psdu,
                                                      Ptr<Event> event, uint16_t staId,
                                                      Time relativeMpduStart,
                                                      Time mpduDuration);
  void EndOfMpdu (Ptr<Event> event, Ptr<const WifiPsdu> psdu, size_t mpduIndex, Time relativeStart, Time mpduDuration);

  void ScheduleEndOfMpdus (Ptr<Event> event);

  virtual void DoEndReceivePayload (Ptr<const WifiPpdu> ppdu);

  virtual std::pair<uint16_t, WifiSpectrumBand> GetChannelWidthAndBand (const WifiTxVector& txVector, uint16_t staId) const;

  void AbortCurrentReception (WifiPhyRxfailureReason reason);

  double GetRandomValue (void) const;
  SnrPer GetPhyHeaderSnrPer (WifiPpduField field, Ptr<Event> event) const;
  double GetRxPowerWForPpdu (Ptr<Event> event) const;
  Ptr<const Event> GetCurrentEvent (void) const;
  const std::map <std::pair<uint64_t, WifiPreamble>, Ptr<Event> > & GetCurrentPreambleEvents (void) const;
  void AddPreambleEvent (Ptr<Event> event);

  Ptr<Event> CreateInterferenceEvent (Ptr<const WifiPpdu> ppdu, const WifiTxVector& txVector, Time duration, RxPowerWattPerChannelBand rxPower, bool isStartOfdmaRxing = false);
  void UpdateInterferenceEvent (Ptr<Event> event, RxPowerWattPerChannelBand rxPower);
  void NotifyInterferenceRxEndAndClear (bool reset);

  virtual uint64_t ObtainNextUid (const WifiTxVector& txVector);

  virtual Ptr<SpectrumValue> GetTxPowerSpectralDensity (double txPowerW, Ptr<const WifiPpdu> ppdu) const = 0;

  uint16_t GetCenterFrequencyForChannelWidth (const WifiTxVector& txVector) const;

  uint16_t GetGuardBandwidth (uint16_t currentChannelWidth) const;
  std::tuple<double, double, double> GetTxMaskRejectionParams (void) const;

  Ptr<WifiPhy> m_wifiPhy;          
  Ptr<WifiPhyStateHelper> m_state; 

  std::list<WifiMode> m_modeList;  

  std::vector <EventId> m_endPreambleDetectionEvents; 
  std::vector <EventId> m_endOfMpduEvents; 

  std::vector <EventId> m_endRxPayloadEvents; 

  typedef std::pair <uint64_t /* UID */, uint16_t /* STA-ID */> UidStaIdPair;

  std::map<UidStaIdPair, std::vector<bool> > m_statusPerMpduMap; 
  std::map<UidStaIdPair, SignalNoiseDbm> m_signalNoiseMap; 

  static uint64_t m_globalPpduUid; 
}; //class PhyEntity

std::ostream& operator<< (std::ostream& os, const PhyEntity::PhyRxFailureAction &action);
std::ostream& operator<< (std::ostream& os, const PhyEntity::PhyFieldRxStatus &status);

} //namespace ns3

#endif /* PHY_ENTITY_H */