/* -*-  Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */

/*

 * Copyright (c) 2006, 2009 INRIA

 * Copyright (c) 2009 MIRKO BANCHI

 *

 * 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: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>

 * Author: Mirko Banchi <mk.banchi@gmail.com>

 */

#include "ns3/assert.h"

#include "ns3/log.h"

#include "ns3/simulator.h"

#include "ns3/string.h"

#include "ns3/pointer.h"

#include "qos-tag.h"

#include "qap-wifi-mac.h"

#include "dca-txop.h"

#include "edca-txop-n.h"

#include "wifi-phy.h"

#include "dcf-manager.h"

#include "mac-rx-middle.h"

#include "mac-tx-middle.h"

#include "mgt-headers.h"

#include "mac-low.h"

#include "amsdu-subframe-header.h"

#include "msdu-aggregator.h"

NS_LOG_COMPONENT_DEFINE ("QapWifiMac");

namespace ns3 {

NS_OBJECT_ENSURE_REGISTERED (QapWifiMac);

TypeId

QapWifiMac::GetTypeId (void)

{

  static TypeId tid = TypeId ("ns3::QapWifiMac")

    .SetParent<WifiMac> ()

    .AddConstructor<QapWifiMac> ()

    .AddAttribute ("BeaconInterval", "Delay between two beacons",

                   TimeValue (Seconds (0.1)),

                   MakeTimeAccessor (&QapWifiMac::GetBeaconInterval,

                                     &QapWifiMac::SetBeaconInterval),

                   MakeTimeChecker ())

    .AddAttribute ("BeaconGeneration", "Whether or not beacons are generated.",

                   BooleanValue (true),

                   MakeBooleanAccessor (&QapWifiMac::SetBeaconGeneration,

                                        &QapWifiMac::GetBeaconGeneration),

                   MakeBooleanChecker ())

    .AddAttribute ("VO_EdcaTxopN",

                   "Queue that manages packets belonging to AC_VO access class",

                   PointerValue (),

                   MakePointerAccessor(&QapWifiMac::GetVOQueue),

                   MakePointerChecker<EdcaTxopN> ())

    .AddAttribute ("VI_EdcaTxopN",

                   "Queue that manages packets belonging to AC_VI access class",

                   PointerValue (),

                   MakePointerAccessor(&QapWifiMac::GetVIQueue),

                   MakePointerChecker<EdcaTxopN> ())

    .AddAttribute ("BE_EdcaTxopN",

                   "Queue that manages packets belonging to AC_BE access class",

                   PointerValue (),

                   MakePointerAccessor(&QapWifiMac::GetBEQueue),

                   MakePointerChecker<EdcaTxopN> ())

    .AddAttribute ("BK_EdcaTxopN",

                   "Queue that manages packets belonging to AC_BK access class",

                   PointerValue (),

                   MakePointerAccessor(&QapWifiMac::GetBKQueue),

                   MakePointerChecker<EdcaTxopN> ())

    ;  

  return tid;

}

QapWifiMac::QapWifiMac ()

{

  NS_LOG_FUNCTION (this);

  m_rxMiddle = new MacRxMiddle ();

  m_rxMiddle->SetForwardCallback (MakeCallback (&QapWifiMac::Receive, this));

  m_txMiddle = new MacTxMiddle ();

  m_low = CreateObject<MacLow> ();

  m_low->SetRxCallback (MakeCallback (&MacRxMiddle::Receive, m_rxMiddle));

  m_dcfManager = new DcfManager ();

  m_dcfManager->SetupLowListener (m_low);

  m_beaconDca = CreateObject<DcaTxop> ();

  m_beaconDca->SetAifsn(1);

  m_beaconDca->SetMinCw(0);

  m_beaconDca->SetMaxCw(0);

  m_beaconDca->SetLow (m_low);

  m_beaconDca->SetManager (m_dcfManager);

  SetQueue (AC_VO);

  SetQueue (AC_VI);

  SetQueue (AC_BE);

  SetQueue (AC_BK);

  m_enableBeaconGeneration = false;

}

QapWifiMac::~QapWifiMac ()

{

  NS_LOG_FUNCTION (this);

}

void

QapWifiMac::DoDispose ()

{

  delete m_rxMiddle;

  delete m_txMiddle;

  delete m_dcfManager;

  m_low->Dispose ();

  m_rxMiddle = 0;

  m_txMiddle = 0;

  m_dcfManager = 0;

  m_low = 0;

  m_phy = 0;

  m_beaconDca = 0;

  m_enableBeaconGeneration = false;

  m_beaconEvent.Cancel ();

  m_stationManager = 0;

  for (Queues::iterator i = m_queues.begin (); i != m_queues.end (); ++i)

    {

      (*i).second = 0;

    }

  WifiMac::DoDispose ();

}

void

QapWifiMac::SetBeaconGeneration (bool enable)

{

  NS_LOG_FUNCTION (this << enable);

  if (!enable)

    {

      m_beaconEvent.Cancel ();

    }

  else if (enable && !m_enableBeaconGeneration)

    {

      m_beaconEvent = Simulator::ScheduleNow (&QapWifiMac::SendOneBeacon, this);

    }

  m_enableBeaconGeneration = enable;

}

bool

QapWifiMac::GetBeaconGeneration (void) const

{

  return m_enableBeaconGeneration;

}

Time

QapWifiMac::GetBeaconInterval (void) const

{

  return m_beaconInterval;

}

void 

QapWifiMac::SetSlot (Time slotTime)

{

  NS_LOG_FUNCTION (this << slotTime);

  m_dcfManager->SetSlot (slotTime);

  m_low->SetSlotTime (slotTime);

}

void 

QapWifiMac::SetSifs (Time sifs)

{

  NS_LOG_FUNCTION (this << sifs);

  m_dcfManager->SetSifs (sifs);

  m_low->SetSifs (sifs);

}

void 

QapWifiMac::SetEifsNoDifs (Time eifsNoDifs)

{

  NS_LOG_FUNCTION (this << eifsNoDifs);

  m_dcfManager->SetEifsNoDifs (eifsNoDifs);

}

void 

QapWifiMac::SetAckTimeout (Time ackTimeout)

{

  m_low->SetAckTimeout (ackTimeout);

}

void 

QapWifiMac::SetCtsTimeout (Time ctsTimeout)

{

  m_low->SetCtsTimeout (ctsTimeout);

}

void 

QapWifiMac::SetPifs (Time pifs)

{

  m_low->SetPifs (pifs);

}

Time 

QapWifiMac::GetSlot (void) const

{

  return m_low->GetSlotTime ();

}

Time 

QapWifiMac::GetSifs (void) const

{

  return m_low->GetSifs ();

}

Time 

QapWifiMac::GetEifsNoDifs (void) const

{

  return m_dcfManager->GetEifsNoDifs ();

}

Time 

QapWifiMac::GetAckTimeout (void) const

{

  return m_low->GetAckTimeout ();

}

Time 

QapWifiMac::GetCtsTimeout (void) const

{

  return m_low->GetCtsTimeout ();

}

Time 

QapWifiMac::GetPifs (void) const

{

  return m_low->GetPifs ();

}

void 

QapWifiMac::SetWifiPhy (Ptr<WifiPhy> phy)

{

  NS_LOG_FUNCTION (this << phy);

  m_phy = phy;

  m_dcfManager->SetupPhyListener (phy);

  m_low->SetPhy (phy);

}

void

QapWifiMac::SetWifiRemoteStationManager (Ptr<WifiRemoteStationManager> stationManager)

{

  NS_LOG_FUNCTION (this << stationManager);

  m_stationManager = stationManager;

  for (Queues::iterator i = m_queues.begin (); i != m_queues.end (); ++i)

    {

      (*i).second->SetWifiRemoteStationManager (stationManager);

    }

  m_beaconDca->SetWifiRemoteStationManager (stationManager);

  m_low->SetWifiRemoteStationManager (stationManager);

}

void 

QapWifiMac::SetForwardUpCallback (Callback<void, Ptr<Packet>, Mac48Address, Mac48Address> upCallback)

{

  NS_LOG_FUNCTION (this);

  m_forwardUp = upCallback;

}

void

QapWifiMac::SetLinkUpCallback (Callback<void> linkUp)

{

  NS_LOG_FUNCTION (this);

  if (!linkUp.IsNull ())

    {

      linkUp ();

    }

}

void 

QapWifiMac::SetLinkDownCallback (Callback<void> linkDown)

{

  NS_LOG_FUNCTION (this);

}

Mac48Address

QapWifiMac::GetAddress () const

{

  return m_low->GetAddress ();

}

Ssid 

QapWifiMac::GetSsid (void) const

{

  return m_ssid;

}

void

QapWifiMac::SetAddress (Mac48Address address)

{

  NS_LOG_FUNCTION (address);

  m_low->SetAddress (address);

  m_low->SetBssid (address);

}

void

QapWifiMac::SetSsid (Ssid ssid)

{

  NS_LOG_FUNCTION (this << ssid);

  m_ssid = ssid;

}

Mac48Address 

QapWifiMac::GetBssid (void) const

{

  return m_low->GetBssid ();

}

void

QapWifiMac::SetBeaconInterval (Time interval)

{

  NS_LOG_FUNCTION (this << interval);

  m_beaconInterval = interval;

}

void

QapWifiMac::StartBeaconing (void)

{

  NS_LOG_FUNCTION (this);

  SendOneBeacon ();

}

void

QapWifiMac::ForwardUp (Ptr<Packet> packet, Mac48Address from, Mac48Address to)

{

  NS_LOG_FUNCTION (this << packet << from);

  m_forwardUp (packet, from, to);

}

void

QapWifiMac::ForwardDown (Ptr<const Packet> packet, Mac48Address from, Mac48Address to)

{

  /* For now Qos AP sends only Qos frame. In the future it should be able to 

     send frames also to Non-Qos Stas.

   */

  NS_LOG_FUNCTION (this << packet << from << to);

  WifiMacHeader hdr;

  hdr.SetType (WIFI_MAC_QOSDATA);

  hdr.SetQosAckPolicy (WifiMacHeader::NORMAL_ACK);

  hdr.SetQosNoEosp ();

  hdr.SetQosNoAmsdu ();

  /* Transmission of multiple frames in the same 

     Txop is not supported for now */

  hdr.SetQosTxopLimit (0);

  hdr.SetAddr1 (to);

  hdr.SetAddr2 (GetAddress ());

  hdr.SetAddr3 (from);

  hdr.SetDsFrom ();

  hdr.SetDsNotTo ();

  uint8_t tid = QosUtilsGetTidForPacket (packet);

  if (tid < 8)

    {

      hdr.SetQosTid (tid);

      AccessClass ac = QosUtilsMapTidToAc (tid);

      m_queues[ac]->Queue (packet, hdr);

    }

  else

    {

      //packet is considerated belonging to BestEffort AC

      hdr.SetQosTid (0);

      m_queues[AC_BE]->Queue (packet, hdr);

    }

}

void

QapWifiMac::ForwardDown (Ptr<const Packet> packet, Mac48Address from, Mac48Address to,

                         const WifiMacHeader *oldHdr)

{

  /* For now Qos AP sends only Qos frame. In the future it should be able to 

     send frames also to Non-Qos Stas.

   */

  NS_LOG_FUNCTION (this << packet << from << to);

  NS_ASSERT (oldHdr->IsQosData ());

  WifiMacHeader hdr;

  hdr.SetType (WIFI_MAC_QOSDATA);

  hdr.SetQosAckPolicy (WifiMacHeader::NORMAL_ACK);

  hdr.SetQosNoEosp ();

  hdr.SetQosNoAmsdu ();

  /* Transmission of multiple frames in the same 

     Txop is not supported for now */

  hdr.SetQosTxopLimit (0);

  hdr.SetQosTid (oldHdr->GetQosTid ());

  hdr.SetAddr1 (to);

  hdr.SetAddr2 (GetAddress ());

  hdr.SetAddr3 (from);

  hdr.SetDsFrom ();

  hdr.SetDsNotTo ();

  AccessClass ac = QosUtilsMapTidToAc (oldHdr->GetQosTid ());

  m_queues[ac]->Queue (packet, hdr);

}

void

QapWifiMac::Enqueue (Ptr<const Packet> packet, Mac48Address to, Mac48Address from)

{

  NS_LOG_FUNCTION (this << packet << from << to);

  ForwardDown (packet, from, to);

}

void 

QapWifiMac::Enqueue (Ptr<const Packet> packet, Mac48Address to)

{

  NS_LOG_FUNCTION (this << packet << to);

  ForwardDown (packet, m_low->GetAddress (), to);

}

bool 

QapWifiMac::SupportsSendFrom (void) const

{

  return true;

}

SupportedRates

QapWifiMac::GetSupportedRates (void) const

{

  // send the set of supported rates and make sure that we indicate

  // the Basic Rate set in this set of supported rates.

  SupportedRates rates;

  for (uint32_t i = 0; i < m_phy->GetNModes (); i++)

    {

      WifiMode mode = m_phy->GetMode (i);

      rates.AddSupportedRate (mode.GetDataRate ());

    }

  // set the basic rates

  for (uint32_t j = 0; j < m_stationManager->GetNBasicModes (); j++)

    {

      WifiMode mode = m_stationManager->GetBasicMode (j);

      rates.SetBasicRate (mode.GetDataRate ());

    }

  return rates; 

}

void

QapWifiMac::SendProbeResp (Mac48Address to)

{

  NS_LOG_FUNCTION (this << to);

  WifiMacHeader hdr;

  hdr.SetProbeResp ();

  hdr.SetAddr1 (to);

  hdr.SetAddr2 (GetAddress ());

  hdr.SetAddr3 (GetAddress ());

  hdr.SetDsNotFrom ();

  hdr.SetDsNotTo ();

  Ptr<Packet> packet = Create<Packet> ();

  MgtProbeResponseHeader probe;

  probe.SetSsid (GetSsid ());

  probe.SetSupportedRates (GetSupportedRates ());

  probe.SetBeaconIntervalUs (m_beaconInterval.GetMicroSeconds ());

  packet->AddHeader (probe);

  /* Which is correct queue for management frames ? */

  m_queues[AC_VO]->Queue (packet, hdr);

}

void

QapWifiMac::SendAssocResp (Mac48Address to, bool success)

{

  NS_LOG_FUNCTION (this << to << success);

  WifiMacHeader hdr;

  hdr.SetAssocResp ();

  hdr.SetAddr1 (to);

  hdr.SetAddr2 (GetAddress ());

  hdr.SetAddr3 (GetAddress ());

  hdr.SetDsNotFrom ();

  hdr.SetDsNotTo ();

  Ptr<Packet> packet = Create<Packet> ();

  MgtAssocResponseHeader assoc;

  StatusCode code;

  if (success)

    {

      code.SetSuccess ();

    }

  else

    {

      code.SetFailure ();

    }

  assoc.SetSupportedRates (GetSupportedRates ());

  assoc.SetStatusCode (code);

  packet->AddHeader (assoc);