multi-user-scheduler.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2020 Universita' degli Studi di Napoli Federico II
 *
 * 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
 *
 * Author: Stefano Avallone <stavallo@unina.it>
 */

#ifndef MULTI_USER_SCHEDULER_H
#define MULTI_USER_SCHEDULER_H

#include "ns3/object.h"
#include "he-ru.h"
#include "ns3/ctrl-headers.h"
#include "ns3/ap-wifi-mac.h"
#include "ns3/wifi-mac-queue.h"
#include "ns3/wifi-tx-parameters.h"
#include "ns3/wifi-remote-station-manager.h"
#include <unordered_map>

namespace ns3 {

class HeFrameExchangeManager;

typedef std::unordered_map <uint16_t /* staId */, Ptr<WifiPsdu> /* PSDU */> WifiPsduMap;

class MultiUserScheduler : public Object
{
public:
  static TypeId GetTypeId (void);
  MultiUserScheduler ();
  virtual ~MultiUserScheduler ();

  enum TxFormat
  {
    NO_TX = 0,
    SU_TX,
    DL_MU_TX,
    UL_MU_TX
  };

  struct DlMuInfo
  {
    WifiPsduMap psduMap;            
    WifiTxParameters txParams;      
  };

  struct UlMuInfo
  {
    Ptr<WifiMacQueueItem> trigger;  
    Time tbPpduDuration;            
    WifiTxParameters txParams;      
  };

  TxFormat NotifyAccessGranted (Ptr<QosTxop> edca, Time availableTime, bool initialFrame);

  DlMuInfo& GetDlMuInfo (void);

  UlMuInfo& GetUlMuInfo (void);

protected:
  Ptr<WifiRemoteStationManager> GetWifiRemoteStationManager (void) const;

  TxFormat GetLastTxFormat (void) const;

  void DoDispose (void) override;
  void NotifyNewAggregate (void) override;
  void DoInitialize (void) override;

  Ptr<ApWifiMac> m_apMac;                
  Ptr<HeFrameExchangeManager> m_heFem;   
  Ptr<QosTxop> m_edca;                   
  Time m_availableTime;                  
  bool m_initialFrame;                   
  uint32_t m_sizeOf8QosNull;             

private:
  void SetWifiMac (Ptr<ApWifiMac> mac);

  virtual TxFormat SelectTxFormat (void) = 0;

  virtual DlMuInfo ComputeDlMuInfo (void) = 0;

  virtual UlMuInfo ComputeUlMuInfo (void) = 0;

  TxFormat m_lastTxFormat {NO_TX};       
  DlMuInfo m_dlInfo;                     
  UlMuInfo m_ulInfo;                     
};

} //namespace ns3

#endif /* MULTI_USER_SCHEDULER_H */