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

/*

 * Copyright (c) 2014 Piotr Gawlowicz

 *

 * 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: Piotr Gawlowicz <gawlowicz.p@gmail.com>

 *

 */

#include "lte-ffr-soft-algorithm.h"

#include <ns3/log.h>

#include "ns3/boolean.h"

NS_OBJECT_ENSURE_REGISTERED (LteFfrSoftAlgorithm);

static const struct FfrSoftDownlinkDefaultConfiguration

{

  uint8_t cellId;

  uint8_t dlBandwidth;

  uint8_t dlCommonSubBandwidth;

  uint8_t dlEgdeSubBandOffset;

  uint8_t dlEdgeSubBandwidth;

} g_ffrSoftDownlinkDefaultConfiguration[] = {

  { 1, 15, 2, 0, 4},

  { 2, 15, 2, 4, 4},

  { 3, 15, 2, 8, 4},

  { 1, 25, 6, 0, 6},

  { 2, 25, 6, 6, 6},

  { 3, 25, 6, 12, 6},

  { 1, 50, 21, 0, 9},

  { 2, 50, 21, 9, 9},

  { 3, 50, 21, 18, 11},

  { 1, 75, 36, 0, 12},

  { 2, 75, 36, 12, 12},

  { 3, 75, 36, 24, 15},

  { 1, 100, 28, 0, 24},

  { 2, 100, 28, 24, 24},

  { 3, 100, 28, 48, 24}

};

static const struct FfrSoftUplinkDefaultConfiguration

{

  uint8_t cellId;

  uint8_t ulBandwidth;

  uint8_t ulCommonSubBandwidth;

  uint8_t ulEgdeSubBandOffset;

  uint8_t ulEdgeSubBandwidth;

} g_ffrSoftUplinkDefaultConfiguration[] = {

  { 1, 15, 3, 0, 4},

  { 2, 15, 3, 4, 4},

  { 3, 15, 3, 8, 4},

  { 1, 25, 6, 0, 6},

  { 2, 25, 6, 6, 6},

  { 3, 25, 6, 12, 6},

  { 1, 50, 21, 0, 9},

  { 2, 50, 21, 9, 9},

  { 3, 50, 21, 18, 11},

  { 1, 75, 36, 0, 12},

  { 2, 75, 36, 12, 12},

  { 3, 75, 36, 24, 15},

  { 1, 100, 28, 0, 24},

  { 2, 100, 28, 24, 24},

  { 3, 100, 28, 48, 24}

};

const uint16_t NUM_DOWNLINK_CONFS (sizeof (g_ffrSoftDownlinkDefaultConfiguration) / sizeof (FfrSoftDownlinkDefaultConfiguration));

const uint16_t NUM_UPLINK_CONFS (sizeof (g_ffrSoftUplinkDefaultConfiguration) / sizeof (FfrSoftUplinkDefaultConfiguration));

LteFfrSoftAlgorithm::LteFfrSoftAlgorithm ()

  : m_ffrSapUser (0),

    m_ffrRrcSapUser (0),

    m_dlEgdeSubBandOffset (0),

    m_dlEdgeSubBandwidth (0),

    m_ulEgdeSubBandOffset (0),

    m_ulEdgeSubBandwidth (0),

    m_measId (0)

{

  NS_LOG_FUNCTION (this);

  m_ffrSapProvider = new MemberLteFfrSapProvider<LteFfrSoftAlgorithm> (this);

  m_ffrRrcSapProvider = new MemberLteFfrRrcSapProvider<LteFfrSoftAlgorithm> (this);

}

LteFfrSoftAlgorithm::~LteFfrSoftAlgorithm ()

{

  NS_LOG_FUNCTION (this);

}

void

LteFfrSoftAlgorithm::DoDispose ()

{

  NS_LOG_FUNCTION (this);

  delete m_ffrSapProvider;

  delete m_ffrRrcSapProvider;

}

TypeId

LteFfrSoftAlgorithm::GetTypeId ()

{

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

    .SetParent<LteFfrAlgorithm> ()

    .AddConstructor<LteFfrSoftAlgorithm> ()

    .AddAttribute ("UlCommonSubBandwidth",

                   "Uplink Medium (Common) SubBandwidth Configuration in number of Resource Block Groups",

                   UintegerValue (6),

                   MakeUintegerAccessor (&LteFfrSoftAlgorithm::m_ulCommonSubBandwidth),

                   MakeUintegerChecker<uint8_t> ())

    .AddAttribute ("UlEdgeSubBandOffset",

                   "Uplink Edge SubBand Offset in number of Resource Block Groups",

                   UintegerValue (0),

                   MakeUintegerAccessor (&LteFfrSoftAlgorithm::m_ulEgdeSubBandOffset),

                   MakeUintegerChecker<uint8_t> ())

    .AddAttribute ("UlEdgeSubBandwidth",

                   "Uplink Edge SubBandwidth Configuration in number of Resource Block Groups",

                   UintegerValue (6),

                   MakeUintegerAccessor (&LteFfrSoftAlgorithm::m_ulEdgeSubBandwidth),

                   MakeUintegerChecker<uint8_t> ())

    .AddAttribute ("DlCommonSubBandwidth",

                   "Downlink Medium (Common) SubBandwidth Configuration in number of Resource Block Groups",

                   UintegerValue (6),

                   MakeUintegerAccessor (&LteFfrSoftAlgorithm::m_dlCommonSubBandwidth),

                   MakeUintegerChecker<uint8_t> ())

    .AddAttribute ("DlEdgeSubBandOffset",

                   "Downlink Edge SubBand Offset in number of Resource Block Groups",

                   UintegerValue (0),

                   MakeUintegerAccessor (&LteFfrSoftAlgorithm::m_dlEgdeSubBandOffset),

                   MakeUintegerChecker<uint8_t> ())

    .AddAttribute ("DlEdgeSubBandwidth",

                   "Downlink Edge SubBandwidth Configuration in number of Resource Block Groups",

                   UintegerValue (0),

                   MakeUintegerAccessor (&LteFfrSoftAlgorithm::m_dlEdgeSubBandwidth),

                   MakeUintegerChecker<uint8_t> ())

    .AddAttribute ("CenterRsrqThreshold",

                   "If the RSRQ of is worse than this threshold, UE should be served in Medium sub-band",

                   UintegerValue (30),

                   MakeUintegerAccessor (&LteFfrSoftAlgorithm::m_centerSubBandThreshold),

                   MakeUintegerChecker<uint8_t> ())

    .AddAttribute ("EdgeRsrqThreshold",

                   "If the RSRQ of is worse than this threshold, UE should be served in Edge sub-band",

                   UintegerValue (20),

                   MakeUintegerAccessor (&LteFfrSoftAlgorithm::m_egdeSubBandThreshold),

                   MakeUintegerChecker<uint8_t> ())

    .AddAttribute ("CenterAreaPowerOffset",

                   "PdschConfigDedicated::Pa value for Center Sub-band, default value dB0",

                   UintegerValue (5),

                   MakeUintegerAccessor (&LteFfrSoftAlgorithm::m_centerAreaPowerOffset),

                   MakeUintegerChecker<uint8_t> ())

    .AddAttribute ("MediumAreaPowerOffset",

                   "PdschConfigDedicated::Pa value for Medium Sub-band, default value dB0",

                   UintegerValue (5),

                   MakeUintegerAccessor (&LteFfrSoftAlgorithm::m_mediumAreaPowerOffset),

                   MakeUintegerChecker<uint8_t> ())

    .AddAttribute ("EdgeAreaPowerOffset",

                   "PdschConfigDedicated::Pa value for Edge Sub-band, default value dB0",

                   UintegerValue (5),

                   MakeUintegerAccessor (&LteFfrSoftAlgorithm::m_edgeAreaPowerOffset),

                   MakeUintegerChecker<uint8_t> ())

    .AddAttribute ("CenterAreaTpc",

                   "TPC value which will be set in DL-DCI for UEs in center area"

                   "Absolute mode is used, default value 1 is mapped to -1 according to"

                   "TS36.213 Table 5.1.1.1-2",

                   UintegerValue (1),

                   MakeUintegerAccessor (&LteFfrSoftAlgorithm::m_centerAreaTpc),

                   MakeUintegerChecker<uint8_t> ())

    .AddAttribute ("MediumAreaTpc",

                   "TPC value which will be set in DL-DCI for UEs in medium area"

                   "Absolute mode is used, default value 1 is mapped to -1 according to"

                   "TS36.213 Table 5.1.1.1-2",

                   UintegerValue (1),

                   MakeUintegerAccessor (&LteFfrSoftAlgorithm::m_mediumAreaTpc),

                   MakeUintegerChecker<uint8_t> ())

    .AddAttribute ("EdgeAreaTpc",

                   "TPC value which will be set in DL-DCI for UEs in edge area"

                   "Absolute mode is used, default value 1 is mapped to -1 according to"

                   "TS36.213 Table 5.1.1.1-2",

                   UintegerValue (1),

                   MakeUintegerAccessor (&LteFfrSoftAlgorithm::m_edgeAreaTpc),

                   MakeUintegerChecker<uint8_t> ())

  ;

  return tid;

}

void

LteFfrSoftAlgorithm::SetLteFfrSapUser (LteFfrSapUser* s)

{

  NS_LOG_FUNCTION (this << s);

  m_ffrSapUser = s;

}

LteFfrSapProvider*

LteFfrSoftAlgorithm::GetLteFfrSapProvider ()

{

  NS_LOG_FUNCTION (this);

  return m_ffrSapProvider;

}

void

LteFfrSoftAlgorithm::SetLteFfrRrcSapUser (LteFfrRrcSapUser* s)

{

  NS_LOG_FUNCTION (this << s);

  m_ffrRrcSapUser = s;

}

LteFfrRrcSapProvider*

LteFfrSoftAlgorithm::GetLteFfrRrcSapProvider ()

{

  NS_LOG_FUNCTION (this);

  return m_ffrRrcSapProvider;

}

void

LteFfrSoftAlgorithm::DoInitialize ()

{

  NS_LOG_FUNCTION (this);

  LteFfrAlgorithm::DoInitialize ();

  NS_ASSERT_MSG (m_dlBandwidth > 14,"DlBandwidth must be at least 15 to use FFR algorithms");

  NS_ASSERT_MSG (m_ulBandwidth > 14,"UlBandwidth must be at least 15 to use FFR algorithms");

  if (m_frCellTypeId != 0)

    {

      SetDownlinkConfiguration (m_frCellTypeId, m_dlBandwidth);

      SetUplinkConfiguration (m_frCellTypeId, m_ulBandwidth);

    }

  NS_LOG_LOGIC (this << " requesting Event A1 measurements"

                     << " (threshold = 0" << ")");

  LteRrcSap::ReportConfigEutra reportConfig;

  reportConfig.eventId = LteRrcSap::ReportConfigEutra::EVENT_A1;

  reportConfig.threshold1.choice = LteRrcSap::ThresholdEutra::THRESHOLD_RSRQ;

  reportConfig.threshold1.range = 0;

  reportConfig.triggerQuantity = LteRrcSap::ReportConfigEutra::RSRQ;

  reportConfig.reportInterval = LteRrcSap::ReportConfigEutra::MS120;

  m_measId = m_ffrRrcSapUser->AddUeMeasReportConfigForFfr (reportConfig);

}

void

LteFfrSoftAlgorithm::Reconfigure ()

{

  NS_LOG_FUNCTION (this);

  if (m_frCellTypeId != 0)

    {

      SetDownlinkConfiguration (m_frCellTypeId, m_dlBandwidth);

      SetUplinkConfiguration (m_frCellTypeId, m_ulBandwidth);

    }

  InitializeDownlinkRbgMaps ();

  InitializeUplinkRbgMaps ();

  m_needReconfiguration = false;

}

void

LteFfrSoftAlgorithm::SetDownlinkConfiguration (uint16_t cellId, uint8_t bandwidth)

{

  NS_LOG_FUNCTION (this);

  for (uint16_t i = 0; i < NUM_DOWNLINK_CONFS; ++i)

    {

      if ((g_ffrSoftDownlinkDefaultConfiguration[i].cellId == cellId)

          && g_ffrSoftDownlinkDefaultConfiguration[i].dlBandwidth == m_dlBandwidth)

        {

          m_dlCommonSubBandwidth = g_ffrSoftDownlinkDefaultConfiguration[i].dlCommonSubBandwidth;

          m_dlEgdeSubBandOffset = g_ffrSoftDownlinkDefaultConfiguration[i].dlEgdeSubBandOffset;

          m_dlEdgeSubBandwidth = g_ffrSoftDownlinkDefaultConfiguration[i].dlEdgeSubBandwidth;

        }

    }

}

void

LteFfrSoftAlgorithm::SetUplinkConfiguration (uint16_t cellId, uint8_t bandwidth)

{

  NS_LOG_FUNCTION (this);

  for (uint16_t i = 0; i < NUM_UPLINK_CONFS; ++i)

    {

      if ((g_ffrSoftUplinkDefaultConfiguration[i].cellId == cellId)

          && g_ffrSoftUplinkDefaultConfiguration[i].ulBandwidth == m_ulBandwidth)

        {

          m_ulCommonSubBandwidth = g_ffrSoftUplinkDefaultConfiguration[i].ulCommonSubBandwidth;

          m_ulEgdeSubBandOffset = g_ffrSoftUplinkDefaultConfiguration[i].ulEgdeSubBandOffset;

          m_ulEdgeSubBandwidth = g_ffrSoftUplinkDefaultConfiguration[i].ulEdgeSubBandwidth;

        }

    }

}

void

LteFfrSoftAlgorithm::InitializeDownlinkRbgMaps ()

{

  m_dlRbgMap.clear ();

  m_dlCenterRbgMap.clear ();

  m_dlMediumRbgMap.clear ();

  m_dlEdgeRbgMap.clear ();

  int rbgSize = GetRbgSize (m_dlBandwidth);

  m_dlRbgMap.resize (m_dlBandwidth / rbgSize, false);

  m_dlCenterRbgMap.resize (m_dlBandwidth / rbgSize, true);

  m_dlMediumRbgMap.resize (m_dlBandwidth / rbgSize, false);

  m_dlEdgeRbgMap.resize (m_dlBandwidth / rbgSize, false);

  NS_ASSERT_MSG (m_dlCommonSubBandwidth <= m_dlBandwidth,"DlCommonSubBandwidth higher than DlBandwidth");

  NS_ASSERT_MSG (m_dlCommonSubBandwidth + m_dlEgdeSubBandOffset <= m_dlBandwidth,

                 "DlCommonSubBandwidth + DlEgdeSubBandOffset higher than DlBandwidth");

  NS_ASSERT_MSG (m_dlEgdeSubBandOffset <= m_dlBandwidth,"DlEgdeSubBandOffset higher than DlBandwidth");

  NS_ASSERT_MSG (m_dlEdgeSubBandwidth <= m_dlBandwidth,"DlEdgeSubBandwidth higher than DlBandwidth");

  NS_ASSERT_MSG ((m_dlCommonSubBandwidth + m_dlEgdeSubBandOffset + m_dlEdgeSubBandwidth) <= m_dlBandwidth,

                 "(DlCommonSubBandwidth + DlEgdeSubBandOffset+DlEdgeSubBandwidth) higher than DlBandwidth");

  for (uint8_t i = 0;

       i < m_dlCommonSubBandwidth / rbgSize; i++)

    {

      m_dlMediumRbgMap[i] = true;

      m_dlCenterRbgMap[i] = false;

    }

  for (uint8_t i = (m_dlCommonSubBandwidth + m_dlEgdeSubBandOffset) / rbgSize;

       i < (m_dlCommonSubBandwidth + m_dlEgdeSubBandOffset + m_dlEdgeSubBandwidth) / rbgSize; i++)

    {

      m_dlEdgeRbgMap[i] = true;

      m_dlCenterRbgMap[i] = false;

    }

}

void

LteFfrSoftAlgorithm::InitializeUplinkRbgMaps ()

{

  m_ulRbgMap.clear ();

  m_ulCenterRbgMap.clear ();

  m_ulMediumRbgMap.clear ();

  m_ulEdgeRbgMap.clear ();

  m_ulRbgMap.resize (m_ulBandwidth, false);

  m_ulCenterRbgMap.resize (m_ulBandwidth, true);

  m_ulMediumRbgMap.resize (m_ulBandwidth, false);

  m_ulEdgeRbgMap.resize (m_ulBandwidth, false);

  NS_ASSERT_MSG (m_ulCommonSubBandwidth <= m_ulBandwidth,"UlCommonSubBandwidth higher than UlBandwidth");

  NS_ASSERT_MSG (m_ulCommonSubBandwidth + m_ulEgdeSubBandOffset <= m_ulBandwidth,

                 "UlCommonSubBandwidth + UlEgdeSubBandOffset higher than UlBandwidth");

  NS_ASSERT_MSG (m_ulEgdeSubBandOffset <= m_ulBandwidth,"UlEgdeSubBandOffset higher than UlBandwidth");

  NS_ASSERT_MSG (m_ulEdgeSubBandwidth <= m_ulBandwidth,"UlEdgeSubBandwidth higher than UlBandwidth");

  NS_ASSERT_MSG ((m_ulCommonSubBandwidth + m_ulEgdeSubBandOffset + m_ulEdgeSubBandwidth) <= m_ulBandwidth,

                 "(UlCommonSubBandwidth + UlEgdeSubBandOffset+UlEdgeSubBandwidth) higher than UlBandwidth");

  for (uint8_t i = 0;

       i < m_ulCommonSubBandwidth; i++)

    {

      m_ulMediumRbgMap[i] = true;

      m_ulCenterRbgMap[i] = false;

    }

  for (uint8_t i = (m_ulCommonSubBandwidth + m_ulEgdeSubBandOffset);

       i < (m_ulCommonSubBandwidth + m_ulEgdeSubBandOffset + m_ulEdgeSubBandwidth); i++)

    {

      m_ulEdgeRbgMap[i] = true;

      m_ulCenterRbgMap[i] = false;

    }

}

std::vector <bool>

LteFfrSoftAlgorithm::DoGetAvailableDlRbg ()

{

  NS_LOG_FUNCTION (this);

  if (m_needReconfiguration)

    {

      Reconfigure ();

    }

  if (m_dlRbgMap.empty ())

    {

      InitializeDownlinkRbgMaps ();

    }

  return m_dlRbgMap;

}

bool

LteFfrSoftAlgorithm::DoIsDlRbgAvailableForUe (int rbgId, uint16_t rnti)

{

  NS_LOG_FUNCTION (this);

  bool isCenterRbg = m_dlCenterRbgMap[rbgId];

  bool isMediumRbg = m_dlMediumRbgMap[rbgId];

  bool isEdgeRbg   = m_dlEdgeRbgMap[rbgId];

  std::map< uint16_t, uint8_t >::iterator it = m_ues.find (rnti);

  if (it == m_ues.end ())

    {

      m_ues.insert (std::pair< uint16_t, uint8_t > (rnti, AreaUnset));

    }

  it = m_ues.find (rnti);

  //if UE area is unknown, serve UE in medium (common) RBGs

  if (it->second == AreaUnset)

    {

      return isMediumRbg;

    }

  bool isCenterUe = false;

  bool isMediumUe = false;

  bool isEdgeUe   = false;

  if (it->second == CenterArea )

    {

      isCenterUe = true;

    }

  else if (it->second == MediumArea)

    {

      isMediumUe = true;

    }

  else if (it->second == EdgeArea)

    {

      isEdgeUe = true;

    }

  return (isCenterRbg && isCenterUe) || (isMediumRbg && isMediumUe) || (isEdgeRbg && isEdgeUe);

}

std::vector <bool>

LteFfrSoftAlgorithm::DoGetAvailableUlRbg ()

{

  NS_LOG_FUNCTION (this);

  if (m_ulRbgMap.empty ())

    {

      InitializeUplinkRbgMaps ();

    }

  return m_ulRbgMap;

}

bool

LteFfrSoftAlgorithm::DoIsUlRbgAvailableForUe (int rbgId, uint16_t rnti)

{

  NS_LOG_FUNCTION (this);

  if (!m_enabledInUplink)

    {

      return true;

    }

  bool isCenterRbg = m_ulCenterRbgMap[rbgId];

  bool isMediumRbg = m_ulMediumRbgMap[rbgId];

  bool isEdgeRbg   = m_ulEdgeRbgMap[rbgId];

  std::map< uint16_t, uint8_t >::iterator it = m_ues.find (rnti);

  if (it == m_ues.end ())

    {

      m_ues.insert (std::pair< uint16_t, uint8_t > (rnti, AreaUnset));

    }

  it = m_ues.find (rnti);

  //if UE area is unknown, serve UE in medium (common) RBGs

  if (it->second == AreaUnset)

    {

      return isMediumRbg;

    }

  bool isCenterUe = false;

  bool isMediumUe = false;

  bool isEdgeUe   = false;

  if (it->second == CenterArea )

    {

      isCenterUe = true;

    }

  else if (it->second == MediumArea)

    {

      isMediumUe = true;

    }

  else if (it->second == EdgeArea)

    {

      isEdgeUe = true;

    }

  return (isCenterRbg && isCenterUe) || (isMediumRbg && isMediumUe) || (isEdgeRbg && isEdgeUe);

}

void

LteFfrSoftAlgorithm::DoReportDlCqiInfo (const struct FfMacSchedSapProvider::SchedDlCqiInfoReqParameters& params)

{

  NS_LOG_FUNCTION (this);

  NS_LOG_WARN ("Method should not be called, because it is empty");

}

void

LteFfrSoftAlgorithm::DoReportUlCqiInfo (const struct FfMacSchedSapProvider::SchedUlCqiInfoReqParameters& params)

{

  NS_LOG_FUNCTION (this);

  NS_LOG_WARN ("Method should not be called, because it is empty");

}

void

LteFfrSoftAlgorithm::DoReportUlCqiInfo (std::map <uint16_t, std::vector <double> > ulCqiMap)

{

  NS_LOG_FUNCTION (this);

  NS_LOG_WARN ("Method should not be called, because it is empty");

}

uint8_t

LteFfrSoftAlgorithm::DoGetTpc (uint16_t rnti)

{

  NS_LOG_FUNCTION (this);