Minstrel_he.h

/************************************************************************************
* Copyright (C) 2023                                                               *
* TETCOS, Bangalore. India                                                         *
*                                                                                  *
* The code Minstrel Rate Control algorithm is provided per GNU GPLv2 licensing     *
*                                                                                  *
* Author: HESUOFDM@IITM                                                            *
*                                                                                  *
* ---------------------------------------------------------------------------------*/
//#include "Minstrel.h"
//#include "IEEE802_11_HTPhy.h"
#include "IEEE802_11_Phy.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
static struct stru_802_11_Phy_Parameters_HE
{
    int nIndex;
    int MCS;
    double dRxSensitivity;
    PHY_MODULATION nModulation;
    double dCodingRate;
    int nNBPSC;
    int nNSD;
    int NSP;
    int nNCBPS;
    int nNDBPS;
    int NES;
    double dGI;
    double dDataRate;
} b; //HESUOFDM@IITM
 
struct stru_HE_McsGroup{
    UINT streams;       //number of spatial streams
    UINT sgi;           //short guard Interval
    UINT chWidth;       //bandwidth
    bool isHe;
    bool isSupported;
 
    double* rate;           //rates supported by this group
    double* trTime;         //transmission time for the rates
}HE_McsGroup;  //HESUOFDM@IITM
 
typedef struct stru_HeRateInfo{
    /**
   * Perfect transmission time calculation, or frame calculation.
   * Given a bit rate and a packet length n bytes.
   */
  double perfectTrTime;
  double rate;
 
  BOOL supported;               //!< If the rate is supported.
 
  UINT retryCount;          //!< Retry limit.
  UINT adjustedRetryCount;  //!< Adjust the retry limit for this rate.
  double prob;                  //!< Current probability within last time interval. (# frame success )/(# total frames)
 
  BOOL retryUpdated;            //!< If number of retries was updated already.
 
  /**
   * Exponential weighted moving average of probability.
   * EWMA calculation:
   * ewma_prob =[prob *(100 - ewma_level) + (ewma_prob_old * ewma_level)]/100
   */
  double ewmaProb;
  double throughput;            //!< Throughput of this rate (in pkts per second).
  double ewmsdProb;             //!< Exponential weighted moving standard deviation of probability.
 
  UINT numSampleSkipped;    //number of skipped stats updates
  UINT currNumAttempt;      //attempts made so far
  UINT currNumSuccess;      //success pkts so far
  UINT prevNumAttempt;      //transmission made with previous rate
  UINT prevNumSuccess;      //successful transmission made with previous rate
  UINT64 totalNumAttempt;       //total number of attempts made
  UINT64 totalNumSuccess;       //total number of success pkts
 
  
}HeRateInfo,*Ptr_HeRateInfo;
 
typedef struct stru_HE_GroupInfo{
    UINT col;               //sample table row
    UINT row;               //sample table col
    BOOL supported;         //if the group is supported
    UINT streams;           //number of special streams
    UINT sgi;               //short guard interval
    UINT chWidth;           //bandwidth
 
    UINT maxTpRate;         //index of rate with max throughput in this group
    UINT maxTpRate2;        //index of rate with 2nd max throughput in this group
    UINT maxProbRate;       //index of rate with max transmission probability in this group
 
    Ptr_HeRateInfo rateTable;   //Info of rates supported by this group
}HE_GroupInfo,*Ptr_HE_GroupInfo; //HESUOFDM-4 needs a change of name
 
typedef struct stru_HePerRemoteStation{
    NETSIM_ID remoteStationId;
    NETSIM_ID stationId;
    NETSIM_ID stationInterface;
    //variables for HT-info
    UINT sampleGroup;            //!< The group that the sample rate belongs to.
    UINT sampleWait;          //!< How many transmission attempts to wait until a new sample.
    UINT sampleTries;            //!< Number of sample tries after waiting sampleWait.
    UINT sampleCount;            //!< Max number of samples per update interval.
    UINT sampleSlow;          //!< Number of times a slow rate was sampled.
 
    double avgAmpduLen;          //!< Average number of MPDUs in an A-MPDU.
    double ampduLen;            //!< Number of MPDUs tried since last update
    UINT ampduPacketCount;      //!< Number of A-MPDUs transmitted since last update
    Ptr_HE_GroupInfo groupTable;  //!< Table of groups with stats.
    UINT nGroup;                //Number of groups in the station
    UINT nGroupRate;            //number of rates supported
    BOOL isHe;                  //If this station is VHT(802.11ac)
 
    //General variables
    BOOL isInitialized;             //Check if station is Initialized
    BOOL isSampling;                //Check if we are sampling
    double nextStatsUpdate;         //Scheduled time for next
    UINT trRate;                    //Index of the transmission rate
    UINT sampleRate;                //Index of the sample rate
    UINT maxTpRate;                 //Index of the max rate
    UINT maxTpRate2;                //Index of the 2nd best throughput
    UINT maxProbRate;               //Index of the max probability rate
    UINT longRetry;                                 
    UINT shortRetry;
    UINT totalRetry;                //total number of retries
    UINT** sampleTable;             //sample table for the station
 
    UINT64 totalPacketCount;        //total packet count of the station
    UINT64 samplePacketCount;       //sample packet count of the station
    PIEEE802_11_PHY_VAR phy;        //NetSim implementation requirement
}MinstrelHePerRemoteStation,*Ptr_MinstrelHePerRemoteStation;
 
 
typedef struct stru_MinstrelHeWifiStation{
    NETSIM_ID devId;
    NETSIM_ID interfaceId;
    Ptr_MinstrelHePerRemoteStation *minstrelHeInfo;
}MinstrelHeWifiStation,*Ptr_MinstrelHeWifiStation;
 
double he_updateStatsTime;                  //Time Interval for updating Minstrel Table
double he_lookAroundRate;               //% of pkts to send with other rates. ~10
double he_ewmaWeight;                   //weight to be given to new value (0,100) ~25%
UINT he_sampleCol;                      //number of columns in Sample Table
 
 
void He_InitMinstrel(NETSIM_ID nDevId,NETSIM_ID nifid);
static void He_CheckInit(Ptr_MinstrelHePerRemoteStation station,NETSIM_ID devid,NETSIM_ID ifid);
static void He_InitSampleTable(Ptr_MinstrelHePerRemoteStation station);
static void He_InitGroupTable(Ptr_MinstrelHePerRemoteStation station);
static void He_UpdatePacketCounter(Ptr_MinstrelHePerRemoteStation station,UINT success,UINT failed);
static void He_UpdateRetry(Ptr_MinstrelHePerRemoteStation station);
static void He_UpdateStats(Ptr_MinstrelHePerRemoteStation station);
static void He_UpdateRate(Ptr_MinstrelHePerRemoteStation station);
static UINT He_FindRate(Ptr_MinstrelHePerRemoteStation station);
static void He_SetStationThRate(Ptr_MinstrelHePerRemoteStation station);
static void He_SetStationProbRate(Ptr_MinstrelHePerRemoteStation station);
static UINT He_GetNextSample(Ptr_MinstrelHePerRemoteStation station);
static void He_SetNextSample(Ptr_MinstrelHePerRemoteStation station);
static double He_CalculateEwmsd(double oldEwmsd, double currentProb, double ewmaProb, double ewmaWeight);
static double He_CalculateThroughput(Ptr_MinstrelHePerRemoteStation station,UINT grpId, UINT rateId);
static void He_CalculateRetransmits(Ptr_MinstrelHePerRemoteStation station,UINT index);
static UINT He_CountRetries(Ptr_MinstrelHePerRemoteStation station);
static UINT He_GetLowestIndex(Ptr_MinstrelHePerRemoteStation station);
static UINT He_GetHighestIndex(Ptr_MinstrelHePerRemoteStation station);
 
 
#ifdef __cplusplus
}
#endif