/usr/include/ns3.17/ns3/bs-uplink-scheduler-rtps.h is in libns3-dev 3.17+dfsg-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2007,2008 INRIA
*
* 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: Giuseppe Piro <g.piro@poliba.it>
*/
#ifndef UPLINK_SCHEDULER_RTPS_H
#define UPLINK_SCHEDULER_RTPS_H
#include <stdint.h>
#include "ul-mac-messages.h"
#include "ns3/nstime.h"
#include "wimax-phy.h"
#include "bs-uplink-scheduler.h"
namespace ns3 {
class BaseStationNetDevice;
class SSRecord;
class ServiceFlow;
/**
* \ingroup wimax
* \brief This class implements a simple uplink scheduler for rtPS flows.
*
* The UL-rtPS-Scheduler work in this way:
* At the beginning of the UL sub-frame some symbols are allocated
* to the rangingInterval Messages, DSA Messages, UGS grants and
* UGS/rtPS/nrtPS/BE poll.
* Then, the remaining available symbols are allocated to the all
* rtPS flows according to their requestedBandwidth.
* The bandwidth saturation control has been implemented to
* redistribute the resource if the sum of requestedBandwidth exceed
* the available bandwidth.
* At the end, if there are some free symbols, their are allocated to
* nrtPS and BE Connections.
*/
class UplinkSchedulerRtps : public UplinkScheduler
{
public:
UplinkSchedulerRtps ();
UplinkSchedulerRtps (Ptr<BaseStationNetDevice> bs);
~UplinkSchedulerRtps (void);
static TypeId GetTypeId (void);
std::list<OfdmUlMapIe> GetUplinkAllocations (void) const;
/**
* Determines if channel descriptors sent in the current frame are
* required to be updated
*/
void GetChannelDescriptorsToUpdate (bool&, bool&, bool&, bool&);
uint32_t CalculateAllocationStartTime (void);
void AddUplinkAllocation (OfdmUlMapIe &ulMapIe,
const uint32_t &allocationSize,
uint32_t &symbolsToAllocation,
uint32_t &availableSymbols);
/**
* \brief Schedule function.
*/
void Schedule (void);
void ServiceUnsolicitedGrants (const SSRecord *ssRecord,
enum ServiceFlow::SchedulingType schedulingType,
OfdmUlMapIe &ulMapIe,
const WimaxPhy::ModulationType modulationType,
uint32_t &symbolsToAllocation,
uint32_t &availableSymbols);
void ServiceBandwidthRequests (const SSRecord *ssRecord,
enum ServiceFlow::SchedulingType schedulingType,
OfdmUlMapIe &ulMapIe,
const WimaxPhy::ModulationType modulationType,
uint32_t &symbolsToAllocation,
uint32_t &availableSymbols);
bool ServiceBandwidthRequests (ServiceFlow *serviceFlow,
enum ServiceFlow::SchedulingType schedulingType,
OfdmUlMapIe &ulMapIe,
const WimaxPhy::ModulationType modulationType,
uint32_t &symbolsToAllocation,
uint32_t &availableSymbols);
/**
* \brief Uplink Scheduler for rtPS connections.
*
* \param symbolsToAllocation symbols to allocation for UpLink Subframe
* \param availableSymbols available symbols for rtPS flows
*
* This method represent the UL Scheduler for rtPS connections.
* The scheduler is designed to serve all rtPS connections that
* have at least one packet to transmit, every UL Subframe.
* The methos selects all rtPS connection that have al least one
* packet to transmit. To each rtPS connections are allocated,
* at the beginning, the bandwidth to transmit a quota of data equal
* to (RequestedBandwidth - GrantedBandwidth).
* If the sum of all pre-allocated bandwidth exceed the available
* symbols for rtPS connections, the Channel Saturation Control function
* is called to redistribute the available bandwidth.
*/
void ULSchedulerRTPSConnection (uint32_t &symbolsToAllocation, uint32_t &availableSymbols);
void AllocateInitialRangingInterval (uint32_t &symbolsToAllocation, uint32_t &availableSymbols);
void SetupServiceFlow (SSRecord *ssRecord, ServiceFlow *serviceFlow);
void ProcessBandwidthRequest (const BandwidthRequestHeader &bwRequestHdr);
void InitOnce (void);
void OnSetRequestedBandwidth (ServiceFlowRecord *sfr);
private:
std::list<OfdmUlMapIe> m_uplinkAllocations;
};
} // namespace ns3
#endif /* UPLINK_SCHEDULER_RTPS_H */
|