/usr/include/ns3.27/ns3/bs-uplink-scheduler-mbqos.h is in libns3-dev 3.27+dfsg-1.
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 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2009 INRIA/LRC - Computer Networks Laboratory
*
* 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
*
* Authors: Jahanzeb Farooq <jahanzeb.farooq@sophia.inria.fr>
* Flavio Kobuta <flaviokubota@gmail.com>
*
*/
#ifndef UPLINK_SCHEDULER_MBQOS_H
#define UPLINK_SCHEDULER_MBQOS_H
#include <stdint.h>
#include "ul-mac-messages.h"
#include "ns3/nstime.h"
#include "wimax-phy.h"
#include "ul-job.h"
#include "service-flow-record.h"
#include "ns3/object.h"
#include "bs-uplink-scheduler.h"
#include "service-flow.h"
namespace ns3 {
class BaseStationNetDevice;
class SSRecord;
class ServiceFlow;
class ServiceFlowRecord;
class UlJob;
/**
* \ingroup wimax
* \brief This class implements a Migration-based Quality of Service uplink scheduler(MBQoS).
*
* This uplink scheduler uses three queues, the low priority
* queue, the intermediate queue and the high priority queue.
* The scheduler serves the requests in strict priority order
* from the high priority queue to the low priority queue. The
* low priority queue stores the bandwidth requests of the BE
* service flow. The intermediate queue holds bandwidth requests
* sent by rtPS and by nrtPS connections. rtPS and nrtPS requests
* can migrate to the high priority queue to guarantee that
* their QoS requirements are met. Besides the requests migrated
* from the intermediate queue, the high priority queue stores
* periodic grants and unicast request opportunities that must be
* scheduled in the following frame. To guarantee the maximum delay
* requirement, the BS assigns a deadline to each rtPS bandwidth
* request in the intermediate queue. The minimum bandwidth
* requirement of both rtPS and nrtPS connections is guaranteed
* over a window of duration T .
* Implementation of uplink scheduler:
* Freitag, J.; da Fonseca, N.L.S., "Uplink Scheduling with Quality of Service in IEEE 802.16 Networks,"
* Global Telecommunications Conference, 2007. GLOBECOM '07. IEEE , vol., no., pp.2503-2508, 26-30 Nov. 2007
* URL: http://ieeexplore.ieee.org/stamp/stamp.jsp?arnumber=4411386&isnumber=4410910
*/
class UplinkSchedulerMBQoS : public UplinkScheduler
{
public:
UplinkSchedulerMBQoS ();
/**
* Constructor
*
* \param time the time
*/
UplinkSchedulerMBQoS (Time time);
~UplinkSchedulerMBQoS (void);
/**
* \brief Get the type ID.
* \return the object TypeId
*/
static TypeId GetTypeId (void);
/**
* Get uplink allocations
* \returns std::list<OfdmUlMapIe>
*/
std::list<OfdmUlMapIe> GetUplinkAllocations (void) const;
/**
* Determines if channel descriptors sent in the current frame are
* required to be updated
* \param updateDcd update DCD if true
* \param updateUcd update UCD if true
* \param sendDcd send DCD if true
* \param sendUcd send UCD if true
*/
void GetChannelDescriptorsToUpdate (bool &updateDcd, bool &updateUcd, bool &sendDcd, bool &sendUcd);
/**
* Calculate allocation start time
* \returns the allocation start time
*/
uint32_t CalculateAllocationStartTime (void);
/**
* Add uplink allocation
* \param ulMapIe the UL map IE
* \param allocationSize the allocation size
* \param symbolsToAllocation the symbols to allocation
* \param availableSymbols the available symbols
*/
void AddUplinkAllocation (OfdmUlMapIe &ulMapIe,
const uint32_t &allocationSize,
uint32_t &symbolsToAllocation,
uint32_t &availableSymbols);
/**
* Schedule function
*/
void Schedule (void);
/**
* Service unsolicited grants
* \param ssRecord the SS record
* \param schedulingType the scheduling type
* \param ulMapIe the UL map IE
* \param modulationType the modulation type
* \param symbolsToAllocation the symbols to allocation
* \param availableSymbols the available symbols
*/
void ServiceUnsolicitedGrants (const SSRecord *ssRecord,
enum ServiceFlow::SchedulingType schedulingType,
OfdmUlMapIe &ulMapIe,
const WimaxPhy::ModulationType modulationType,
uint32_t &symbolsToAllocation,
uint32_t &availableSymbols);
/**
* Service bandwidth requests
* \param ssRecord the SS record
* \param schedulingType the scheduling type
* \param ulMapIe the UL map IE
* \param modulationType the modulation type
* \param symbolsToAllocation the symbols to allocation
* \param availableSymbols the available symbols
*/
void ServiceBandwidthRequests (const SSRecord *ssRecord,
enum ServiceFlow::SchedulingType schedulingType,
OfdmUlMapIe &ulMapIe,
const WimaxPhy::ModulationType modulationType,
uint32_t &symbolsToAllocation,
uint32_t &availableSymbols);
/**
* Service bandwidth requests
* \param serviceFlow the service flow
* \param schedulingType the scheduling type
* \param ulMapIe the UL map IE
* \param modulationType the modulation type
* \param symbolsToAllocation the symbols to allocation
* \param availableSymbols the available symbols
* \returns true if successful
*/
bool ServiceBandwidthRequests (ServiceFlow *serviceFlow,
enum ServiceFlow::SchedulingType schedulingType,
OfdmUlMapIe &ulMapIe,
const WimaxPhy::ModulationType modulationType,
uint32_t &symbolsToAllocation,
uint32_t &availableSymbols);
/**
* Allocate initial ranging interval
* \param symbolsToAllocation the symbols to allocation
* \param availableSymbols the available symbols
*/
void AllocateInitialRangingInterval (uint32_t &symbolsToAllocation, uint32_t &availableSymbols);
/**
* Setup service flow
* \param ssRecord the SS record
* \param serviceFlow the service flow
*/
void SetupServiceFlow (SSRecord *ssRecord, ServiceFlow *serviceFlow);
/**
* \param availableSymbols available symbols in the uplink frame
* \brief Check deadline from jobs. Migrate requests if necessary.
*
* This method verifies for each rtPS request whether it should be
* migrated to the high priority queue or not. The conditions for
* migration are: request deadline expires in the frame following
* the next one, and the amount of bandwidth requested is less than
* or equal to the amount of available bytes in the next uplink frame.
*/
void CheckDeadline (uint32_t &availableSymbols);
/**
* \param availableSymbols available symbols in the uplink frame.
* \brief Check if Minimum bandwidth is guarantee. Migrate requests if necessary.
*
* This method first calculate a priority value for each request
* in the intermediate queue. Then, sorts the intermediate queue
* according to the priority values. Finally, while there is available
* bandwidth, the scheduler migrate the requests to the high priority queue.
*/
void CheckMinimumBandwidth (uint32_t &availableSymbols);
/**
* \brief Reset the current window.
* According to a configured time, reset the window.
*/
void UplinkSchedWindowTimer (void);
/**
* \param priority Priority of queue
* \param job job information
*
* \brief Enqueue a job in a priority queue.
*/
void EnqueueJob (UlJob::JobPriority priority, Ptr<UlJob> job);
/**
* \param priority Priority of queue
* \return Ptr<UlJob>
*
* \brief Dequeue a job from a priority queue.
*/
Ptr<UlJob> DequeueJob (UlJob::JobPriority priority);
void ProcessBandwidthRequest (const BandwidthRequestHeader &bwRequestHdr);
/**
* \param serviceFlow Service flow of connection
* \return Time
*
* \brief Calculates deadline of a request.
*/
Time DetermineDeadline (ServiceFlow *serviceFlow);
/**
* This method is called once to initialize window.
*/
void InitOnce (void);
/**
* \param jobs List of jobs
* \returns the symbols count
*
* Sum the amount of symbols of each job of a queue
*/
uint32_t CountSymbolsQueue (std::list<Ptr<UlJob> > jobs);
/**
* \param job job
* \returns the symbols count
*
* Count the amount of symbols of a job.
*/
uint32_t CountSymbolsJobs (Ptr<UlJob> job);
/**
* Set requested bandwidth
* \param sfr the service flow record
*/
void OnSetRequestedBandwidth (ServiceFlowRecord *sfr);
/**
* \param ssRecord Subscriber station record
* \param schedType Service flow type
* \param reqType Type of packet
* \return Ptr<UlJob>
*
* Create and fill information of a job.
*/
Ptr<UlJob>
CreateUlJob (SSRecord *ssRecord, enum ServiceFlow::SchedulingType schedType, ReqType reqType);
/**
* \param serviceFlow ServiceFlow
* \return Ptr<UlJob>
*
* Get pending size.
*/
uint32_t
GetPendingSize (ServiceFlow* serviceFlow);
/**
* Service bandwidth requests bytes.
* \param serviceFlow the service flow
* \param schedulingType the scheduling type
* \param ulMapIe the UL map IE
* \param modulationType the modulation type
* \param symbolsToAllocation the symbols to allocation
* \param availableSymbols the available symbols
* \param allocationSizeBytes the allocation size in bytes
* \returns true if successful
*/
bool
ServiceBandwidthRequestsBytes (ServiceFlow *serviceFlow,
enum ServiceFlow::SchedulingType schedulingType, OfdmUlMapIe &ulMapIe,
const WimaxPhy::ModulationType modulationType,
uint32_t &symbolsToAllocation, uint32_t &availableSymbols, uint32_t allocationSizeBytes);
private:
std::list<OfdmUlMapIe> m_uplinkAllocations; ///< uplink allocations
// queues for scheduler
std::list<Ptr<UlJob> > m_uplinkJobs_high; ///< uplink jobs high priority
std::list<Ptr<UlJob> > m_uplinkJobs_inter; ///< uplink jobs intermedite priority
std::list<Ptr<UlJob> > m_uplinkJobs_low; ///< uplink jobs low priority
// interval to reset window
Time m_windowInterval; ///< windows interval
};
} // namespace ns3
#endif /* UPLINK_SCHEDULER_MBQOS_H */
|