nepi/resources/ns3/classes/cara_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 NS3CaraWifiManager(NS3BaseWifiRemoteStationManager):
  26     _rtype = "ns3::CaraWifiManager"
  27
  28     @classmethod
  29     def _register_attributes(cls):
  30
  31         attr_probethreshold = Attribute("ProbeThreshold",
  32             "The number of consecutive transmissions failure to activate the RTS probe.",
  33             type = Types.Integer,
  34             default = "1",
  35             allowed = None,
  36             range = None,
  37             flags = Flags.Reserved | Flags.Construct)
  38
  39         cls._register_attribute(attr_probethreshold)
  40
  41         attr_failurethreshold = Attribute("FailureThreshold",
  42             "The number of consecutive transmissions failure to decrease the rate.",
  43             type = Types.Integer,
  44             default = "2",
  45             allowed = None,
  46             range = None,
  47             flags = Flags.Reserved | Flags.Construct)
  48
  49         cls._register_attribute(attr_failurethreshold)
  50
  51         attr_successthreshold = Attribute("SuccessThreshold",
  52             "The minimum number of sucessfull transmissions to try a new rate.",
  53             type = Types.Integer,
  54             default = "10",
  55             allowed = None,
  56             range = None,
  57             flags = Flags.Reserved | Flags.Construct)
  58
  59         cls._register_attribute(attr_successthreshold)
  60
  61         attr_timeout = Attribute("Timeout",
  62             "The \'timer\' in the CARA algorithm",
  63             type = Types.Integer,
  64             default = "15",
  65             allowed = None,
  66             range = None,
  67             flags = Flags.Reserved | Flags.Construct)
  68
  69         cls._register_attribute(attr_timeout)
  70
  71         attr_islowlatency = Attribute("IsLowLatency",
  72             "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.",
  73             type = Types.Bool,
  74             default = "True",
  75             allowed = None,
  76             range = None,
  77             flags = Flags.Reserved | Flags.Construct)
  78
  79         cls._register_attribute(attr_islowlatency)
  80
  81         attr_maxssrc = Attribute("MaxSsrc",
  82             "The maximum number of retransmission attempts for an RTS. This value will not have any effect on some rate control algorithms.",
  83             type = Types.Integer,
  84             default = "7",
  85             allowed = None,
  86             range = None,
  87             flags = Flags.Reserved | Flags.Construct)
  88
  89         cls._register_attribute(attr_maxssrc)
  90
  91         attr_maxslrc = Attribute("MaxSlrc",
  92             "The maximum number of retransmission attempts for a DATA packet. This value will not have any effect on some rate control algorithms.",
  93             type = Types.Integer,
  94             default = "7",
  95             allowed = None,
  96             range = None,
  97             flags = Flags.Reserved | Flags.Construct)
  98
  99         cls._register_attribute(attr_maxslrc)
 100
 101         attr_rtsctsthreshold = Attribute("RtsCtsThreshold",
 102             "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.",
 103             type = Types.Integer,
 104             default = "2346",
 105             allowed = None,
 106             range = None,
 107             flags = Flags.Reserved | Flags.Construct)
 108
 109         cls._register_attribute(attr_rtsctsthreshold)
 110
 111         attr_fragmentationthreshold = Attribute("FragmentationThreshold",
 112             "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.",
 113             type = Types.Integer,
 114             default = "2346",
 115             allowed = None,
 116             range = None,
 117             flags = Flags.Reserved | Flags.Construct)
 118
 119         cls._register_attribute(attr_fragmentationthreshold)
 120
 121         attr_nonunicastmode = Attribute("NonUnicastMode",
 122             "Wifi mode used for non-unicast transmissions.",
 123             type = Types.String,
 124             default = "Invalid-WifiMode",
 125             allowed = None,
 126             range = None,
 127             flags = Flags.Reserved | Flags.Construct)
 128
 129         cls._register_attribute(attr_nonunicastmode)
 130
 131         attr_defaulttxpowerlevel = Attribute("DefaultTxPowerLevel",
 132             "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.",
 133             type = Types.Integer,
 134             default = "0",
 135             allowed = None,
 136             range = None,
 137             flags = Flags.Reserved | Flags.Construct)
 138
 139         cls._register_attribute(attr_defaulttxpowerlevel)
 140
 141
 142
 143     @classmethod
 144     def _register_traces(cls):
 145
 146         mactxrtsfailed = Trace("MacTxRtsFailed", "The transmission of a RTS by the MAC layer has failed")
 147
 148         cls._register_trace(mactxrtsfailed)
 149
 150         mactxdatafailed = Trace("MacTxDataFailed", "The transmission of a data packet by the MAC layer has failed")
 151
 152         cls._register_trace(mactxdatafailed)
 153
 154         mactxfinalrtsfailed = Trace("MacTxFinalRtsFailed", "The transmission of a RTS has exceeded the maximum number of attempts")
 155
 156         cls._register_trace(mactxfinalrtsfailed)
 157
 158         mactxfinaldatafailed = Trace("MacTxFinalDataFailed", "The transmission of a data packet has exceeded the maximum number of attempts")
 159
 160         cls._register_trace(mactxfinaldatafailed)
 161
 162
 163
 164     def __init__(self, ec, guid):
 165         super(NS3CaraWifiManager, self).__init__(ec, guid)
 166         self._home = "ns3-cara-wifi-manager-%s" % self.guid