nepi/resources/ns3/classes/rraa_wifi_manager.py

   1 #
   2 #    NEPI, a framework to manage network experiments
   3 #    Copyright (C) 2014 INRIA
   4 #
   5 #    This program is free software: you can redistribute it and/or modify
   6 #    it under the terms of the GNU General Public License version 2 as
   7 #    published by the Free Software Foundation;
   8 #
   9 #    This program is distributed in the hope that it will be useful,
  10 #    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 #    GNU General Public License for more details.
  13 #
  14 #    You should have received a copy of the GNU General Public License
  15 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16 #
  17
  18 from nepi.execution.attribute import Attribute, Flags, Types
  19 from nepi.execution.trace import Trace, TraceAttr
  20 from nepi.execution.resource import ResourceManager, clsinit_copy, \
  21         ResourceState
  22 from nepi.resources.ns3.ns3wifiremotestationmanager import NS3BaseWifiRemoteStationManager
  23
  24 @clsinit_copy
  25 class NS3RraaWifiManager(NS3BaseWifiRemoteStationManager):
  26     _rtype = "ns3::RraaWifiManager"
  27
  28     @classmethod
  29     def _register_attributes(cls):
  30
  31         attr_basic = Attribute("Basic",
  32             "If true the RRAA-BASIC algorithm will be used, otherwise the RRAA wil be used",
  33             type = Types.Bool,
  34             default = "False",
  35             allowed = None,
  36             range = None,
  37             flags = Flags.Reserved | Flags.Construct)
  38
  39         cls._register_attribute(attr_basic)
  40
  41         attr_timeout = Attribute("Timeout",
  42             "Timeout for the RRAA BASIC loss estimaton block (s)",
  43             type = Types.String,
  44             default = "+50000000.0ns",
  45             allowed = None,
  46             range = None,
  47             flags = Flags.Reserved | Flags.Construct)
  48
  49         cls._register_attribute(attr_timeout)
  50
  51         attr_ewndfor54mbps = Attribute("ewndFor54mbps",
  52             "ewnd parameter for 54 Mbs data mode",
  53             type = Types.Integer,
  54             default = "40",
  55             allowed = None,
  56             range = None,
  57             flags = Flags.Reserved | Flags.Construct)
  58
  59         cls._register_attribute(attr_ewndfor54mbps)
  60
  61         attr_ewndfor48mbps = Attribute("ewndFor48mbps",
  62             "ewnd parameter for 48 Mbs data mode",
  63             type = Types.Integer,
  64             default = "40",
  65             allowed = None,
  66             range = None,
  67             flags = Flags.Reserved | Flags.Construct)
  68
  69         cls._register_attribute(attr_ewndfor48mbps)
  70
  71         attr_ewndfor36mbps = Attribute("ewndFor36mbps",
  72             "ewnd parameter for 36 Mbs data mode",
  73             type = Types.Integer,
  74             default = "40",
  75             allowed = None,
  76             range = None,
  77             flags = Flags.Reserved | Flags.Construct)
  78
  79         cls._register_attribute(attr_ewndfor36mbps)
  80
  81         attr_ewndfor24mbps = Attribute("ewndFor24mbps",
  82             "ewnd parameter for 24 Mbs data mode",
  83             type = Types.Integer,
  84             default = "40",
  85             allowed = None,
  86             range = None,
  87             flags = Flags.Reserved | Flags.Construct)
  88
  89         cls._register_attribute(attr_ewndfor24mbps)
  90
  91         attr_ewndfor18mbps = Attribute("ewndFor18mbps",
  92             "ewnd parameter for 18 Mbs data mode",
  93             type = Types.Integer,
  94             default = "20",
  95             allowed = None,
  96             range = None,
  97             flags = Flags.Reserved | Flags.Construct)
  98
  99         cls._register_attribute(attr_ewndfor18mbps)
 100
 101         attr_ewndfor12mbps = Attribute("ewndFor12mbps",
 102             "ewnd parameter for 12 Mbs data mode",
 103             type = Types.Integer,
 104             default = "20",
 105             allowed = None,
 106             range = None,
 107             flags = Flags.Reserved | Flags.Construct)
 108
 109         cls._register_attribute(attr_ewndfor12mbps)
 110
 111         attr_ewndfor9mbps = Attribute("ewndFor9mbps",
 112             "ewnd parameter for 9 Mbs data mode",
 113             type = Types.Integer,
 114             default = "10",
 115             allowed = None,
 116             range = None,
 117             flags = Flags.Reserved | Flags.Construct)
 118
 119         cls._register_attribute(attr_ewndfor9mbps)
 120
 121         attr_ewndfor6mbps = Attribute("ewndFor6mbps",
 122             "ewnd parameter for 6 Mbs data mode",
 123             type = Types.Integer,
 124             default = "6",
 125             allowed = None,
 126             range = None,
 127             flags = Flags.Reserved | Flags.Construct)
 128
 129         cls._register_attribute(attr_ewndfor6mbps)
 130
 131         attr_porifor48mbps = Attribute("poriFor48mbps",
 132             "Pori parameter for 48 Mbs data mode",
 133             type = Types.Double,
 134             default = "0.047",
 135             allowed = None,
 136             range = None,
 137             flags = Flags.Reserved | Flags.Construct)
 138
 139         cls._register_attribute(attr_porifor48mbps)
 140
 141         attr_porifor36mbps = Attribute("poriFor36mbps",
 142             "Pori parameter for 36 Mbs data mode",
 143             type = Types.Double,
 144             default = "0.115",
 145             allowed = None,
 146             range = None,
 147             flags = Flags.Reserved | Flags.Construct)
 148
 149         cls._register_attribute(attr_porifor36mbps)
 150
 151         attr_porifor24mbps = Attribute("poriFor24mbps",
 152             "Pori parameter for 24 Mbs data mode",
 153             type = Types.Double,
 154             default = "0.1681",
 155             allowed = None,
 156             range = None,
 157             flags = Flags.Reserved | Flags.Construct)
 158
 159         cls._register_attribute(attr_porifor24mbps)
 160
 161         attr_porifor18mbps = Attribute("poriFor18mbps",
 162             "Pori parameter for 18 Mbs data mode",
 163             type = Types.Double,
 164             default = "0.1325",
 165             allowed = None,
 166             range = None,
 167             flags = Flags.Reserved | Flags.Construct)
 168
 169         cls._register_attribute(attr_porifor18mbps)
 170
 171         attr_porifor12mbps = Attribute("poriFor12mbps",
 172             "Pori parameter for 12 Mbs data mode",
 173             type = Types.Double,
 174             default = "0.1861",
 175             allowed = None,
 176             range = None,
 177             flags = Flags.Reserved | Flags.Construct)
 178
 179         cls._register_attribute(attr_porifor12mbps)
 180
 181         attr_porifor9mbps = Attribute("poriFor9mbps",
 182             "Pori parameter for 9 Mbs data mode",
 183             type = Types.Double,
 184             default = "0.1434",
 185             allowed = None,
 186             range = None,
 187             flags = Flags.Reserved | Flags.Construct)
 188
 189         cls._register_attribute(attr_porifor9mbps)
 190
 191         attr_porifor6mbps = Attribute("poriFor6mbps",
 192             "Pori parameter for 6 Mbs data mode",
 193             type = Types.Double,
 194             default = "0.5",
 195             allowed = None,
 196             range = None,
 197             flags = Flags.Reserved | Flags.Construct)
 198
 199         cls._register_attribute(attr_porifor6mbps)
 200
 201         attr_pmtlfor54mbps = Attribute("pmtlFor54mbps",
 202             "Pmtl parameter for 54 Mbs data mode",
 203             type = Types.Double,
 204             default = "0.094",
 205             allowed = None,
 206             range = None,
 207             flags = Flags.Reserved | Flags.Construct)
 208
 209         cls._register_attribute(attr_pmtlfor54mbps)
 210
 211         attr_pmtlfor48mbps = Attribute("pmtlFor48mbps",
 212             "Pmtl parameter for 48 Mbs data mode",
 213             type = Types.Double,
 214             default = "0.23",
 215             allowed = None,
 216             range = None,
 217             flags = Flags.Reserved | Flags.Construct)
 218
 219         cls._register_attribute(attr_pmtlfor48mbps)
 220
 221         attr_pmtlfor36mbps = Attribute("pmtlFor36mbps",
 222             "Pmtl parameter for 36 Mbs data mode",
 223             type = Types.Double,
 224             default = "0.3363",
 225             allowed = None,
 226             range = None,
 227             flags = Flags.Reserved | Flags.Construct)
 228
 229         cls._register_attribute(attr_pmtlfor36mbps)
 230
 231         attr_pmtlfor24mbps = Attribute("pmtlFor24mbps",
 232             "Pmtl parameter for 24 Mbs data mode",
 233             type = Types.Double,
 234             default = "0.265",
 235             allowed = None,
 236             range = None,
 237             flags = Flags.Reserved | Flags.Construct)
 238
 239         cls._register_attribute(attr_pmtlfor24mbps)
 240
 241         attr_pmtlfor18mbps = Attribute("pmtlFor18mbps",
 242             "Pmtl parameter for 18 Mbs data mode",
 243             type = Types.Double,
 244             default = "0.3722",
 245             allowed = None,
 246             range = None,
 247             flags = Flags.Reserved | Flags.Construct)
 248
 249         cls._register_attribute(attr_pmtlfor18mbps)
 250
 251         attr_pmtlfor12mbps = Attribute("pmtlFor12mbps",
 252             "Pmtl parameter for 12 Mbs data mode",
 253             type = Types.Double,
 254             default = "0.2868",
 255             allowed = None,
 256             range = None,
 257             flags = Flags.Reserved | Flags.Construct)
 258
 259         cls._register_attribute(attr_pmtlfor12mbps)
 260
 261         attr_pmtlfor9mbps = Attribute("pmtlFor9mbps",
 262             "Pmtl parameter for 9 Mbs data mode",
 263             type = Types.Double,
 264             default = "0.3932",
 265             allowed = None,
 266             range = None,
 267             flags = Flags.Reserved | Flags.Construct)
 268
 269         cls._register_attribute(attr_pmtlfor9mbps)
 270
 271         attr_islowlatency = Attribute("IsLowLatency",
 272             "If true, we attempt to modelize a so-called low-latency device: a device where decisions about tx parameters can be made on a per-packet basis and feedback about the transmission of each packet is obtained before sending the next. Otherwise, we modelize a  high-latency device, that is a device where we cannot update our decision about tx parameters after every packet transmission.",
 273             type = Types.Bool,
 274             default = "True",
 275             allowed = None,
 276             range = None,
 277             flags = Flags.Reserved | Flags.Construct)
 278
 279         cls._register_attribute(attr_islowlatency)
 280
 281         attr_maxssrc = Attribute("MaxSsrc",
 282             "The maximum number of retransmission attempts for an RTS. This value will not have any effect on some rate control algorithms.",
 283             type = Types.Integer,
 284             default = "7",
 285             allowed = None,
 286             range = None,
 287             flags = Flags.Reserved | Flags.Construct)
 288
 289         cls._register_attribute(attr_maxssrc)
 290
 291         attr_maxslrc = Attribute("MaxSlrc",
 292             "The maximum number of retransmission attempts for a DATA packet. This value will not have any effect on some rate control algorithms.",
 293             type = Types.Integer,
 294             default = "7",
 295             allowed = None,
 296             range = None,
 297             flags = Flags.Reserved | Flags.Construct)
 298
 299         cls._register_attribute(attr_maxslrc)
 300
 301         attr_rtsctsthreshold = Attribute("RtsCtsThreshold",
 302             "If  the size of the data packet + LLC header + MAC header + FCS trailer is bigger than this value, we use an RTS/CTS handshake before sending the data, as per IEEE Std. 802.11-2012, Section 9.3.5. This value will not have any effect on some rate control algorithms.",
 303             type = Types.Integer,
 304             default = "2346",
 305             allowed = None,
 306             range = None,
 307             flags = Flags.Reserved | Flags.Construct)
 308
 309         cls._register_attribute(attr_rtsctsthreshold)
 310
 311         attr_fragmentationthreshold = Attribute("FragmentationThreshold",
 312             "If the size of the data packet + LLC header + MAC header + FCS trailer is biggerthan this value, we fragment it such that the size of the fragments are equal or smaller than this value, as per IEEE Std. 802.11-2012, Section 9.5. This value will not have any effect on some rate control algorithms.",
 313             type = Types.Integer,
 314             default = "2346",
 315             allowed = None,
 316             range = None,
 317             flags = Flags.Reserved | Flags.Construct)
 318
 319         cls._register_attribute(attr_fragmentationthreshold)
 320
 321         attr_nonunicastmode = Attribute("NonUnicastMode",
 322             "Wifi mode used for non-unicast transmissions.",
 323             type = Types.String,
 324             default = "Invalid-WifiMode",
 325             allowed = None,
 326             range = None,
 327             flags = Flags.Reserved | Flags.Construct)
 328
 329         cls._register_attribute(attr_nonunicastmode)
 330
 331         attr_defaulttxpowerlevel = Attribute("DefaultTxPowerLevel",
 332             "Default power level to be used for transmissions. This is the power level that is used by all those WifiManagers that do notimplement TX power control.",
 333             type = Types.Integer,
 334             default = "0",
 335             allowed = None,
 336             range = None,
 337             flags = Flags.Reserved | Flags.Construct)
 338
 339         cls._register_attribute(attr_defaulttxpowerlevel)
 340
 341
 342
 343     @classmethod
 344     def _register_traces(cls):
 345
 346         mactxrtsfailed = Trace("MacTxRtsFailed", "The transmission of a RTS by the MAC layer has failed")
 347
 348         cls._register_trace(mactxrtsfailed)
 349
 350         mactxdatafailed = Trace("MacTxDataFailed", "The transmission of a data packet by the MAC layer has failed")
 351
 352         cls._register_trace(mactxdatafailed)
 353
 354         mactxfinalrtsfailed = Trace("MacTxFinalRtsFailed", "The transmission of a RTS has exceeded the maximum number of attempts")
 355
 356         cls._register_trace(mactxfinalrtsfailed)
 357
 358         mactxfinaldatafailed = Trace("MacTxFinalDataFailed", "The transmission of a data packet has exceeded the maximum number of attempts")
 359
 360         cls._register_trace(mactxfinaldatafailed)
 361
 362
 363
 364     def __init__(self, ec, guid):
 365         super(NS3RraaWifiManager, self).__init__(ec, guid)
 366         self._home = "ns3-rraa-wifi-manager-%s" % self.guid