model/plc-channel.h

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2012 University of British Columbia, Vancouver
 *
 * 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: Alexander Schloegl <alexander.schloegl@gmx.de>
 */

#ifndef PLC_CHANNEL_H_
#define PLC_CHANNEL_H_

#include <math.h>
#include <complex>
#include <vector>
#include <set>

#include <ns3/assert.h>
#include <ns3/object.h>
#include <ns3/type-id.h>

#include <ns3/system-thread.h>
#include <ns3/packet.h>
#include <ns3/channel.h>
#include <ns3/nstime.h>
#include <ns3/packet.h>
#include <ns3/spectrum-value.h>
#include <ns3/net-device.h>
#include <ns3/bridge-net-device.h>
#include <ns3/traced-value.h>
#include <ns3/trace-source-accessor.h>

#include "plc-interface.h"

namespace ns3 {

class PLC_Graph;
class PLC_Phy;
class PLC_TxInterface;
class PLC_RxInterface;;

class PLC_TrxMetaInfo : public Object
{
public:
        static TypeId GetTypeId (void);

        PLC_TrxMetaInfo (void);

        void SetUncodedPacket (Ptr<const Packet> p) { m_uncoded_packet = p; }
        Ptr<const Packet> GetUncodedPacket (void) const { return m_uncoded_packet; }
        void SetHeaderMcs (ModulationAndCodingType mcs) { m_header_mcs = mcs; }
        ModulationAndCodingType GetHeaderMcs (void) const { return m_header_mcs; }
        void SetPayloadMcs (ModulationAndCodingType mcs) { m_payload_mcs = mcs; }
        ModulationAndCodingType GetPayloadMcs (void) const { return m_payload_mcs; }
        void SetHeaderDuration (Time duration) { m_header_duration = duration; }
        Time GetHeaderDuration (void) const { return m_header_duration; }
        void SetPayloadDuration (Time duration) { m_payload_duration = duration; }
        Time GetPayloadDuration (void) const { return m_payload_duration; }

private:
        Ptr<const Packet> m_uncoded_packet;
        ModulationAndCodingType m_header_mcs;
        ModulationAndCodingType m_payload_mcs;
        Time m_header_duration;
        Time m_payload_duration;
};

class PLC_EdgeTransferUnit : public Object
{
        friend class PLC_Outlet;

public:
        static TypeId GetTypeId(void);

        PLC_EdgeTransferUnit(PLC_Edge *edge, PLC_Node *dst_node, Ptr<const SpectrumModel> sm, bool time_variant = false);

        ~PLC_EdgeTransferUnit(void) {}

        PLC_Edge *GetEdge(void) const { return m_edge; }

        PLC_Node *GetDstNode(void) const { return m_dst_node; }

        void SetEdgeTransferVector(Ptr<PLC_TransferBase> ctv);

        Ptr<PLC_TransferBase> GetEdgeTransferVector(void);

        PLC_TransferBase *GetEdgeTransferVectorPtr(void) { return PeekPointer(m_edge_transfer_vector); }

        bool IsUp2Date(void) const { return m_is_up_2_date; }

        void SetOutOfDate(void) { m_is_up_2_date = false; }

        bool IsTimeVariant(void);

        void Lock(void) const { m_edge_transfer_unit_mutex.Lock(); }
        void Unlock(void) const { m_edge_transfer_unit_mutex.Unlock(); }

private:
        void DoDispose(void);

        Ptr<const SpectrumModel>        m_spectrum_model;
        mutable PLC_Mutex                       m_edge_transfer_unit_mutex;
        PLC_Edge                                        *m_edge;         // non ns3::Ptr<>, because object system
        PLC_Node                                        *m_dst_node; // gets screwed up with parallel processing
        Ptr<PLC_TransferBase>           m_edge_transfer_vector; // Channel Transfer Function data for the m_edge heading to m_dst_node

        bool m_is_up_2_date;
};

class PLC_ChannelTransferImpl : public Object
{
        friend class PLC_TxInterface;

public:
        static TypeId GetTypeId(void);

        PLC_ChannelTransferImpl(PLC_TxInterface *txInterface, PLC_RxInterface *rxInterface, Ptr<const SpectrumModel> sm, bool create_backbone_path = true);
        ~PLC_ChannelTransferImpl() {}

        Ptr<PLC_Graph> GetGraph(void);

        bool IsTimeVariant(void);

        void SetTimeVariant(void);

        void UpdateImmediately(bool value) { m_update_immediately = value; }

        bool IsUp2Date(void) { return m_is_up_2_date; }

        Time GetDirectPathPropagationDelay(void);

        std::list<PLC_BackboneBranch *> GetBackbonePath(void);

        PLC_BackbonePath::iterator BackbonePathBegin(void);

        PLC_BackbonePath::iterator BackbonePathEnd(void);

        void CreateBackbonePath(void);

        void DiscoverBackboneBranches(void);

        void InitializeChannelTransferVector(bool set_time_variant = false);

        void CalculateChannelTransferVector(void);

        Ptr<PLC_TransferBase> GetChannelTransferVector(void);

        Ptr<SpectrumValue> GetAbsSqrCtf(unsigned int timeslot = 0);

        void GenerateAbsSqrCtf(void);

        Ptr<SpectrumValue> CalculateRxPowerSpectralDensity(Ptr<const SpectrumValue> txPsd, Timeslot timeslot = 0);

        void Lock(void) const { m_mutex.Lock(); }
        void Unlock(void) const { m_mutex.Unlock(); }

private:
        void DoDispose(void);

        void AddBackboneBranch(Ptr<PLC_Node> branch, Ptr<PLC_Node> node_before, Ptr<PLC_Node> node_next);
        Ptr<PLC_TransferBase> MultiplyChannelTransferVector(Ptr<PLC_TransferBase> result, PLC_TransferBase *ctv);
        void SetOutOfDate(void);
        void CalculateDirectPathPropagationDelay(void);

        Ptr<const SpectrumModel>                        m_spectrum_model;
        mutable PLC_Mutex                                       m_mutex;
        PLC_TxInterface                                         *m_txInterface;
        PLC_RxInterface                                         *m_rxInterface;
        PLC_BackbonePath                                        m_backbone_path;
        Ptr<PLC_TransferBase>                           m_channel_transfer_vector;
        std::vector<Ptr<SpectrumValue> >        m_abs_sqr_ctf;

        uint64_t m_impedance_hash_sum;

        Time m_delay;
        bool m_is_time_variant;
        bool m_ctv_is_up_2_date;
        bool m_is_up_2_date;

        bool m_update_immediately;
        bool m_update_scheduled;
        TracedCallback<Time, Ptr<PLC_TransferBase> > m_channelDataTracer;
};

class PLC_Channel : public Channel
{
        friend class PLC_Outlet;

public:
        static TypeId GetTypeId(void);

        PLC_Channel();

        PLC_Channel(Ptr<PLC_Graph> graph);
        ~PLC_Channel(void);

        void SetGraph(Ptr<PLC_Graph> graph);

        Ptr<PLC_Graph> GetGraph(void) { return this->m_graph; }

        uint32_t AddTxInterface(Ptr<PLC_TxInterface> txInterface);

        uint32_t GetNTxInterfaces(void) const;

        Ptr<PLC_TxInterface> GetTxInterface(uint32_t i) const;

        uint32_t AddRxInterface(Ptr<PLC_RxInterface> rxInterface);

        uint32_t GetNRxInterfaces(void) const;

        Ptr<PLC_RxInterface> GetRxInterface(uint32_t i) const;

        uint32_t AddDevice(Ptr<NetDevice>);

        uint32_t GetNDevices (void) const;

        Ptr<NetDevice> GetDevice (uint32_t i) const;

        void InitTransmissionChannels(void);

        void CalcTransmissionChannels(void);

        Ptr<PLC_TransferBase> GetChannelTransferData(uint32_t txId, uint32_t rxId);

        void TransmissionStart(Ptr<const Packet> p, uint32_t txId, Ptr<const SpectrumValue> txPsd, Time duration, Ptr<const PLC_TrxMetaInfo> metaInfo);

        bool TransmissionEnd(uint32_t txId, Time propagation_delay);

        void PropagationCompleteEvent(uint32_t txId);

        Timeslot GetCurrentTimeslot(void);

        Time GetRemainingSlotTime(Time t);

        void ProcessTimeslotTasks(Timeslot timeslot);

        void ScheduleNextTimeslotTasks(void);

        void UpdateReceivePSDs(Timeslot timeslot, bool channel_changed = false);

        void DeleteOutOfDatePSDs(Ptr<PLC_TxInterface> tx, Ptr<PLC_RxInterface> rx);

        void Lock(void) const { m_mutex.Lock(); }
        void Unlock(void) const { m_mutex.Unlock(); }

private:
        void DoStart(void);
        void DoDispose(void);

        void MakeRxPsdMapEntries(Timeslot cur_timeslot, Timeslot end_timeslot, PLC_RxPsdMap& rxPsdMap, PLC_ChannelTransferImpl *ch_impl, Ptr<const SpectrumValue> txPsd);

        mutable PLC_Mutex                                       m_mutex;
        mutable PLC_Mutex                                       m_schedule_mutex;
        Ptr<PLC_Graph>                                          m_graph;

        std::set<Ptr<PLC_Phy> >                         m_phys;
        std::vector<Ptr<PLC_TxInterface> >      m_txInterfaces;
        std::vector<Ptr<PLC_RxInterface> >      m_rxInterfaces;
        std::vector<Ptr<NetDevice> >            m_devices;

        std::set<uint32_t>                              m_transmitting;
        std::set<uint32_t>                              m_propagating;
        PLC_TransmissionDescriptorMap   m_transmission_descriptors;

        bool m_timeslot_tasks_scheduled;

        TracedCallback<Time, uint32_t, bool> m_occupancyLogger;
        TracedCallback<Time, std::set<uint32_t> > m_activeTxIfLogger;
};

}

#endif /* PLC_CHANNEL_H_ */