bandwidthmanager.h

Go to the documentation of this file.

// ##########################################################################
// ####                                                                  ####
// ####                   Master Thesis Implementation                   ####
// ####  Management of Layered Variable Bitrate Multimedia Streams over  ####
// ####                 DiffServ with A Priori Knowledge                 ####
// ####                                                                  ####
// #### ================================================================ ####
// ####                                                                  ####
// ####                                                                  ####
// #### Bandwidth Manager                                                ####
// ####                                                                  ####
// ####           Copyright (C) 1999-2012 by Thomas Dreibholz            ####
// ####                                                                  ####
// #### Contact:                                                         ####
// ####    EMail: dreibh@iem.uni-due.de                                  ####
// ####    WWW:   https://www.nntb.no/~dreibh/rtpaudio                ####
// ####                                                                  ####
// #### ---------------------------------------------------------------- ####
// ####                                                                  ####
// #### This program is free software: you can redistribute it and/or    ####
// #### modify it under the terms of the GNU General Public License as   ####
// #### published by the Free Software Foundation, either version 3 of   ####
// #### the License, or (at your option) any later version.              ####
// ####                                                                  ####
// #### 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, see                    ####
// #### <http://www.gnu.org/licenses/>.                                  ####
// ####                                                                  ####
// ##########################################################################
// $Id: bandwidthmanager.h 1307 2011-12-22 07:36:29Z dreibh $


#ifndef BANDWIDTHMANAGER_H
#define BANDWIDTHMANAGER_H


#include "tdsystem.h"
#include "qosmanagerinterface.h"
#include "abstractqosdescription.h"
#include "timedthread.h"
#include "servicelevelagreement.h"
#include "streamdescription.h"
#include "sessiondescription.h"
#include "roundtriptimepinger.h"
#include "rtcppacket.h"


#include <map>
#include <algorithm>


struct ResourceUtilizationSimplePoint
{
   // ====== Stream and point identification ================================
   StreamDescription* Stream;

   cardinal Point;

   double StreamPriorityFactor;


   // ====== Point data =====================================================
   card64 Bandwidth;

   double BandwidthCost;

   double Utilization;

   double SortingValue;
};

std::ostream& operator<<(std::ostream& os, const ResourceUtilizationSimplePoint& srup);



struct ResourceUtilizationMultiPoint
{
   // ====== Comparision operators ==========================================
   inline int operator<(const ResourceUtilizationMultiPoint& srup) const;

   inline int operator>(const ResourceUtilizationMultiPoint& srup) const;


   // ====== Session identification =========================================
   SessionDescription* Session;

   double SessionPriorityFactor;


   // ====== Streams and points identification ==============================
   static const cardinal MaxStreamsPerSession = 128;

   cardinal Streams;

   StreamDescription* Stream[MaxStreamsPerSession];

   cardinal Point[MaxStreamsPerSession];


   // ====== Point data =====================================================
   card64 Bandwidth;

   double BandwidthCost;

   double Utilization;

   double SortingValue;


   // ====== Miscellaneous ==================================================
   bool AlreadyAllocated;
};


std::ostream& operator<<(std::ostream& os, const ResourceUtilizationMultiPoint& srup);



class BandwidthManager : virtual public QoSManagerInterface,
                         public TimedThread
{
   // ====== Constructor/Destructor =========================================
   public:
   BandwidthManager(ServiceLevelAgreement* sla,
                    RoundTripTimePinger*   rttp);

   ~BandwidthManager();


   // ====== Stream management ==============================================
   void addStream(ManagedStreamInterface* stream,
                  const cardinal          sessionID = 0,
                  const char*             name      = NULL);

   void removeStream(ManagedStreamInterface* stream);

   void updateStream(ManagedStreamInterface* stream);

   inline void forceCompleteRemapping();

   // ====== Events =========================================================
   void intervalChangeEvent(ManagedStreamInterface* stream,
                            const bool              isNew,
                            const card64            when,
                            const bool              newRUList);

   void reportEvent(ManagedStreamInterface*         stream,
                    const RTCPReceptionReportBlock* report,
                    const cardinal                  layer);

   void bufferFlushEvent(ManagedStreamInterface* stream,
                         const cardinal          layer);

   void timerEvent();


   // ====== Settings =======================================================
   void setLogStream(std::ostream* logStream);

   inline void getPartialRemapping(bool&   enabled,
                                   double& reservedPortion,
                                   double& utilizationTolerance,
                                   double& maxRemappingInterval) const;


   inline void setPartialRemapping(const bool   enabled,
                                   const double reservedPortion,
                                   const double utilizationTolerance,
                                   const double maxRemappingInterval);

   inline void getFairness(double& fairnessSession,
                           double& fairnessStream) const;

   inline void setFairness(const double fairnessSession,
                           const double fairnessStream);

   inline void getQoSOptimizationParameters(
                  cardinal& maxRUPoints,
                  double&   utilizationThreshold,
                  card64&   bandwidthThreshold,
                  double&   systemDelayTolerance,
                  bool&     unlayeredAllocation) const;

   inline void setQoSOptimizationParameters(
                  const cardinal maxRUPoints,
                  const double   utilizationThreshold,
                  const card64   bandwidthThreshold,
                  const double   systemDelayTolerance,
                  const bool     unlayeredAllocation);


   // ====== Bandwidth variables ============================================
   card64 TotalAvailableBandwidth;
   card64 ClassAvailableBandwidthArray[TrafficClassValues::MaxValues];
   card64 TotalBandwidth;
   card64 ClassBandwidthArray[TrafficClassValues::MaxValues];
   int64  SLAUpdateRecommendation[TrafficClassValues::MaxValues];


   // ====== Information about remappings ===================================
   card64   StreamIDGenerator;
   card64   LastCompleteRemapping;
   card64   LastCompleteRemappingDuration;
   cardinal CompleteRemappings;
   cardinal PartialRemappings;
   cardinal TotalBufferFlushes;


   // ====== Simulator variables ============================================
   static card64 SimulatorTime;


   // ====== Stream and session management ==================================
   std::multimap<ManagedStreamInterface*,StreamDescription*> StreamSet;
   std::multimap<cardinal,SessionDescription*>               SessionSet;
   ServiceLevelAgreement*                                    SLA;
   cardinal                                                  Streams;
   cardinal                                                  Sessions;


   // ====== Constants ======================================================
   cardinal MaxRUPoints;
   double   UtilizationThreshold;
   card64   BandwidthThreshold;
   double   SystemDelayTolerance;
   double   FairnessSession;
   double   FairnessStream;
   double   AlphaLossRate;
   double   AlphaJitter;
   double   PartialRemappingPortion;
   double   PartialRemappingUtilizationTolerance;
   card64   MaxRemappingInterval;
   bool     EnablePartialRemappings;
   bool     UnlayeredAllocation;


   // ====== Private data ===================================================
   private:
   cardinal calculateSessionMultiPoints(
               SessionDescription*       session,
               const cardinal            offset,
               const cardinal            lastPoint,
               ResourceUtilizationMultiPoint* rumpList);
   void getRoundTripTimes(StreamDescription* sd);

   inline double getPriorityFactor(const int8 streamPriority) const;
   inline double getResourcePart(const ResourceUtilizationSimplePoint& rup) const;
   inline double getResourcePart(const ResourceUtilizationMultiPoint& rump) const;
   inline double getStreamSortingValue(const ResourceUtilizationSimplePoint& rup) const;
   inline double getSessionSortingValue(const ResourceUtilizationMultiPoint& rump) const;

   static inline void smoothedUpdate(double& value, const double measured, const double alpha);

   public:
   void updateReservation(StreamDescription* streamDescription);
   private:

   bool tryAllocation(
           ResourceUtilizationMultiPoint& rump,
           const card64                   bandwidthLimit = (card64)-1);

   void doAllocationTrials(
           ResourceUtilizationMultiPoint* rumpList,
           const cardinal                 points,
           const card64                   bandwidthLimit = (card64)-1);

   bool doPartialRemapping(StreamDescription* streamDescription);
   void doCompleteRemapping();


   RoundTripTimePinger* RTTP;
   std::ostream*        Log;
   card64               LogStartupTimeStamp;
   bool                 Changed;
};


#include "bandwidthmanager.icc"


#endif