ns-3 RELEASE NOTES

This file contains ns-3 release notes (most recent releases first).  

All of the ns-3 documentation is accessible from the ns-3 website: 

http://www.nsnam.org including tutorials: http://www.nsnam.org/tutorials.html

Consult the file CHANGES.html for more detailed information about changed

API and behavior across ns-3 releases.

Release 3-dev

=============

Availability

------------

This release is not yet available.

Supported platforms

-------------------

This release has been tested on the following platforms:

New user-visible features

-------------------------

- (internet) Added TCP Vegas congestion control algorithm

- (internet) Added TCP Scalable congestion control algorithm

- (internet) Added TCP Veno congestion control algorithm

Bugs fixed

----------

- Bug 2057 - ARP and Ndisc caches should be updated by receiving valid L3 packets

- Bug 2346 - SixLowPan ConpressionThreshold can be violated.

- Bug 2329 - TCP Veno implementation

- Bug 2333 - TCP Scalable implementation

- Bug 2347 - LrWpan Ascii traces are hooked to the wrong traces.

- Bug 2353 - TCP Vegas implementation

Known issues

------------

In general, known issues are tracked on the project tracker available

at http://www.nsnam.org/bugzilla/

Release 3.25

============

Availability

------------

This release is available from:

https://www.nsnam.org/release/ns-allinone-3.25.tar.bz2

Supported platforms

-------------------

This release has been tested on the following platforms:

- Ubuntu 15.10 (64 bit) with g++-5.2.1

- Ubuntu 14.04 (64 bit) with g++-4.8.2

- Fedora Core 23 (64 bit) with g++-5.3.1

- Fedora Core 22 (32 bit) with g++-5.1.1

- Fedora Core 21 (64 bit) with g++-4.9.2

- Arch Linux (64 bit) with g++-5.3.0 and clang++-3.7.1

- CentOS/RHEL 6.7 (64-bit) with g++-4.4.7

- OS X El Capitan 10.11.4 with Xcode 7.3 and Apple LLVM version 7.3.0

- OS X El Capitan 10.11.3 with Xcode 7.2.1 and Apple LLVM version 7.0.2

- OS X Yosemite 10.10.5 with Xcode 7.2.1 and Apple LLVM version 7.0.2

- FreeBSD 10.2-RELEASE (64 bit) with clang-3.4.1

New user-visible features

-------------------------

- (internet) The native TCP implementation has been refactored, for the 

  following improvements:  

    1) congestion control has been aligned with the Linux architecture, 

       to facilitate easier coding of new congestion control algorithms

        or porting implementations from the Linux kernel, 

    2) Fast Retransmit and Fast Recovery algorithms, compliant to RFCs, are 

       shared by all TCP variants, unlike previous releases. 

    3) TCP Hybla and TCP HighSpeed variants have been added.

- (routing) The PrintRoutingTable* functions now print the following information

  each time they are called: 

    1) the node ID, 

    2) the global time, 

    3) the local time (allowing for future introduction of per-node clocks), 

    4) the routing protocol type

- (traffic control) A traffic control sublayer has been added with the aim of

  introducing an equivalent of the Linux Traffic +Control infrastructure into 

  ns-3. This layer sits in between the NetDevices (L2) and the network 

  protocol (e.g. IP). It is in charge of processing packets and performing 

  actions on them: scheduling, dropping, marking, policing, etc.  Initial

  support for flow control has been added to the PointToPointNetDevice;

  backward-compatible support for other device types is provided.

- (traffic control) A three band priority queue modelled after Linux

  pfifo_fast queueing discipline has been added.

- (traffic control) Adaptive RED extensions have been added to the RED model

- (wifi) A number of changes related to improving support for 802.11n/ac

  models have been introduced.

  1) Two rate controls compatible with High Throughput (HT) Wi-Fi modes

     (e.g. 802.11n/ac), Ideal and MinstrelHT, have been added  

  2) Support for multiple spatial streams (MIMO) using existing SISO

     error models

  3) The WiFi helper API for the WifiMac sublayer, and the configuration

     of HT modes and parameters, has been simplified

  4) Better support for backward compatibilty with legacy modes

- (wifi) 802.11g was made backward compatible with 802.11b networks

- (internet) L4 protocols (e.g., TCP, UDP, ICMP, etc.) can be demultiplexed 

  by IP according to the incoming interface. In other words, it is now 

  possible to use specialized L4 protocols according to the interface.

- (internet) Ipv6Address::IsAllHostsMulticast() is now deprecated. 

  FF02::3 is not in the official reserved IPv6 multicast address list.

- (internet) Ipv6Address::IsAll[Nodes,Routers]Multicast() now checks the 

  address scope beyond the simple link-local. Nodes are checked for 

  Interface-Local, Link-Local and Realm-Local, Routers for the above plus 

  Site-Local.

- (internet) Ipv6 routing protocols must now *not* forward packets to upper 

  layers unless for extremey specific cases. The Ipv6L3protocol handles 

  almost all the packets directed to the host.

- (internet) Ipv6 can now reject packets directed to an address not configured 

  on the interface they are received from (Strong End System Model, RFC 1222).

- (internet) UDP and Ipv6 RAW sockets can now join Ipv6 multicast groups.

  Incoming packets will be filtered according to if there's a socket listening 

  to that group. Source filtering is left to the application.

- (network) ns-3 is now capable of serializing cooked (SLL) headers. This is 

  used in DCE to allow the generation of pcap directly readable by wireshark.

- (internet) It is now possible to set custom values for RipNg Link Down 

  (standard is 16).

- (internet) permanent (static) NDISC entries can be created for IPv6

- (internet) IPv4 RIPv2 protocol model is now available.

Bugs fixed

----------

- Bug 1132 - useless for loops in block-ack-test-suite.cc

- Bug 1205 - EDCA is incorrectly modelled as DCF

- Bug 1571 - TCP zero-window and flow control window updates by the receiver

- Bug 1631 - Acoustic modem Energy consumption calc is wrong

- Bug 1761 - Rounding with olsr::EmfToSeconds

- Bug 1783 - BytesInFlight value fixed

- Bug 1954 - Serialized size of wifi-net-device differ for TX and RX trace

- Bug 1999 - PointToPointRemoteChannel invokes PointToPointChannel constructor

- Bug 2003 - Missing DSSS short PLCP preamble

- Bug 2041 - TCP RTO needs unit tests

- Bug 2068 - Timestamp option conforms to RFC 7323

- Bug 2102 - Make global routing robust to bridged links

- Bug 2116 - refactoring aggregation API

- Bug 2120 - 802.11g networks are not compatible with 802.11b clients

- Bug 2141 - TCP DataSent callback now correctly notifies sent data, without missing bytes in particular conditions

- Bug 2150 - The TCP sender keeps retransmitting and does not terminate the connection after some retries.

- Bug 2159 - TCP advertises wrong receive window

- Bug 2176 - Building IPv4 address from char* doesn't look reliable

- Bug 2183 - LiIonEnergySourceHelper is not in the energy wscript

- Bug 2184 - Integer overflow in Wi-Fi MacLow; remove dependency between tx and rx reference number field in MPDU status

- Bug 2185 - WiFi MacLow may respond to errored frames that it should ignore

- Bug 2193 - Simulation fails when transmitting very small MPDU subframes

- Bug 2195 - Udp[*]Client can't send packets to broadcast address

- Bug 2201 - Simulation fails when active probing is used in 802.11n/ac with channel bonding enabled

- Bug 2206 - Split internet-apps from applications

- Bug 2207 - Print node ID and time when printing routing tables

- Bug 2208 - Interface index based L4 protocols

- Bug 2210 - set Order field to 0 for HT/VHT 

- Bug 2211 - Ipv{4,6}EndPoint can cause memory corruption

- Bug 2213 - Inconsistencies may exist between the selected WifiMacHelper and the chosen 802.11 version

- Bug 2219 - SixLowPanNetDevice hangs trying to decode a IPv6 Fragment extension header

- Bug 2224 - scope of GetAmpduExist() in EdcaTxopN

- Bug 2233 - Implement RFC 1222 - Strong End System Model

- Bug 2234 - Ipv6L3Protocol should trash multicast packets not interesting for the node

- Bug 2238 - Ipv6 routing reorganization

- Bug 2242 - Mobility of both sender PHY and receiver PHY set to sender mobility in lr-wpan-phy-test.cc example.

- Bug 2243 - TCP Socket Fork() fails to copy some parameters, causing connections to close prematurely on retransmit

- Bug 2246 - Some DSR LogComponents and classes are not defined in a unique way.

- Bug 2247 - Disabled Fast retransmit after an RTO

- Bug 2249 - LTE perl speed tests possibly broken

- Bug 2252 - Nix needs StaticRouting to work

- Bug 2254 - Ipv[4,6]RawSocket can return the wrong number of bytes sent.

- Bug 2255 - Ipv6RawSocket does not call data sent callbacks.

- Bug 2257 - Ipv[4,6]InterfaceContainer::Add are not consistent

- Bug 2258 - TcpSocketBase updated options and RTT for out of range segments.

- Bug 2259 - GSL not successfully enabled for Wi-Fi DSSS error rate model

- Bug 2262 - Corrected initial slow start threshold value

- Bug 2266 - NixRouting info are not copied during a packet fragmentation.

- Bug 2267 - Wrong channel bandwidth value in pcap files

- Bug 2271 - Decision to enable RTS/CTS handshake for A-MPDUs should be based on the comparison between RtsCtsThreshold and the total A-MPDU size

- Bug 2272 - SixLowPan NetDevice can not send uncompressed packets larger than 802.15.4 MTU

- Bug 2273 - WeakEs model should be enforced in Static and Global routing

- Bug 2275 - AdhocWifiMac not compatible with 802.11n/ac

- Bug 2279 - Ipv[4,6]L3Protocol::GetInterfaceForDevice speedup.

- Bug 2283 - Add capability to use pcap trace files with nanosecond precision timestamps

- Bug 2286 - Support for SLL header (de)serialization.

- Bug 2287 - FlowMonitor is confused by IP over IP.

- Bug 2288 - Ipv4 broadcast and multicast packets are replicated on all the interfaces.

- Bug 2289 - RIP v2 implementation

- Bug 2290 - Cannot run click examples from test.py

- Bug 2292 - Uninitialized variables since commit 7c60a9f8f271

- Bug 2293 - Red Queue Estimator spins when trying to compute queue average size under long idle times.

- Bug 2297 - 802.11n/ac networks are not compatible with legacy clients

- Bug 2302 - Fixing RTT calculation inside TCP Socket

- Bug 2303 - WifiMacQueue::GetSize should cleanup queue beforehand

- Bug 2304 - DSCP Set/Get are using 8 bit values instead of 6

- Bug 2307 - m_receivedAtLeastOneMpdu is not always reset

- Bug 2311 - save Ht/Vht capabilities info on a per-station basis

- Bug 2313 - Assert failed when using aggregation and RTS/CTS

- Bug 2315 - Problem when BACK Request is part of an A-MPDU

- Bug 2316 - MacLow shall use a single TXVECTOR for all MPDUs belonging to a same A-MPDU

- Bug 2317 - Get the non-HT reference rate of a HT MCS

- Bug 2318 - MPDU Aggregation fails with TCP

- Bug 2319 - BlockAckTimeout value is too low for 802.11n operating at 2.4 GHz

- Bug 2320 - Add method to check whether a WifiTxVector contains a valid combination of WifiMode, number of spatial streams and channel width

- Bug 2321 - Wifi rate managers should not be triggered for each MPDU when A-MPDU is used

- Bug 2327 - CWmin value selection for 802.11g is not compliant with the standard rules

- Bug 2328 - changes to antenna configuration should update HT MCS set

- Bug 2331 - Wrong mobility model in vanet-routing-compare example

- Bug 2332 - Assert failed when using aggregation and two pairs of AP-STA

- Bug 2337 - WifiPhy uses channel width in Hz iso MHz

- Bug 2338 - WifiMode selected for control frames may sometimes be invalid

Known issues

------------

In general, known issues are tracked on the project tracker available

at http://www.nsnam.org/bugzilla/

Release 3.24.1

==============

Release 3.24.1 is a maintenance release that fixes three issues:

- support for Xcode 7 clang compiler version

- detection of Python bindings location

- compilation problem on 32-bit gcc-4.4 machine

The issues prevented selected systems from being able to successfully

build ns-3, and prevented the released version from being able to

detect the presence of pybindgen used for Python bindings.

Availability

------------

This release is available from:

https://www.nsnam.org/release/ns-allinone-3.24.1.tar.bz2

Supported platforms

-------------------

This release has been tested on the following platforms:

- Ubuntu 15.04 (64 bit) with g++-4.9.2

- Fedora Core 22 (32 bit) with g++-5.1.1

- Fedora Core 21 (64 bit) with g++-4.9.2

- Ubuntu 14.04 (64 bit) with g++-4.8.2

- Ubuntu 12.04.4 (64 bit) with g++-4.6.3

- CentOS/RHEL 6.7 (64-bit) with g++-4.4.7

- OS X Yosemite 10.10.5 with Xcode 7 and Apple LLVM version 7.0.0

- OS X Yosemite 10.10.5 with Xcode 6.4 and Apple LLVM version 6.1.0

- FreeBSD 10.2-RELEASE (64 bit) with clang-3.4.1

New user-visible features

-------------------------

Features are identical to release 3.24.

Bugs fixed

----------

- Bug 2181 - Xcode 7.0 compiler warnings trigger build failure

- Bug 2182 - pybindgen required version is now a string literal

- Bug 2184 - integer overflow in MacLow

Release 3.24

============

Availability

------------

This release is available from:

https://www.nsnam.org/release/ns-allinone-3.24.tar.bz2

Supported platforms

-------------------

This release has been tested on the following platforms:

- Ubuntu 15.04 (64 bit) with g++-4.9.2

- Fedora Core 22 (32 bit) with g++-5.1.1

- Fedora Core 21 (64 bit) with g++-4.9.2

- Ubuntu 14.04 (64 bit) with g++-4.8.2

- Ubuntu 12.04.4 (32/64 bit) with g++-4.6.3

- CentOS/RHEL 6.7 (64-bit) with g++-4.4.7

- OS X Yosemite 10.10.4 with Xcode 6.4 and Apple LLVM version 6.1.0

- FreeBSD 10.1-RELEASE (64 bit) with clang-3.4.1

New user-visible features

-------------------------

- (build system) Python 3 is now supported by waf and test runner programs

- (wifi) 802.11ac Very High Throughput (VHT) physical layer modes are now 

  supported.

- (internet) permanent (static) ARP entries can be created for IPv4

- (network) SimpleChannel allows per-NetDevice blacklists, in order to do hidden terminal testcases.

- (documentation) TracedCallback function signatures now documented in Doxygen

Bugs fixed

----------

- Bug 730 - Enabling fragmentation at run-time breaks simulation

- Bug 1249 - doxygen comments on device-level SetMobility ()

- Bug 1482 - mesh module was producing fatal error with ASCII and netanim traces

- Bug 1557 - errors in function OpenFlowSwitchNetDevice::BufferFromPacket()

- Bug 1681 - m_lastNavStart is assigned twice continuously

- Bug 1736 - default dot11EDCATableMSDULifetime

- Bug 1901 - mesh module producing malformed pcaps

- Bug 1929 - TcpL4Protocol::Send must indicate the source address to routing (if known)

- Bug 1982 - AODV and mesh modules use random variables before seeds can be set

- Bug 2058 - TCP window update can shrink left edge of window

- Bug 2063 - FdNetDevice::SendFrom assert does not account for headers correctly

- Bug 2082 - Empirical RV fails if value provided in CDF function is negative

- Bug 2093 - MultiModelSpectrumChannel::GetDevice only works for 0-th index

- Bug 2096 - Wrong pcap information when MPDU aggregation is used

- Bug 2104 - Sequence Number passed to QosUtilsMapSeqControlToUniqueInteger instead of Sequence Control

- Bug 2108 - Erroneous implementation in InterferenceHelper

- Bug 2119 - Fix memory leaks in FdNetDevice test due to non-executed events

- Bug 2124 - UdpSocketImpl::ShutdownRecv doesn't stop the Ipv[4,6]EndPointDemux

- Bug 2125 - subclasses must chain up to base class NotifyNewAggregate

- Bug 2126 - LrWpanNetDevice silently accepts no mobility on the node

- Bug 2127 - Scheduler benchmark utility works in first run only

- Bug 2130 - Allow SimpleChannel to simulate hidden terminals

- Bug 2132 - TcpL4Protocol sends a bad-formatted RST packet

- Bug 2135 - TCP doesn't honor the socket's output interface

- Bug 2136 - The usage of tid in wifi and wave module shall be "if (tid > 7)" rather than "if (tid >= 7)"

- Bug 2138 - SimpleNetDevice could send overlapped packets

- Bug 2143 - maybe-uninitialized warning

- Bug 2146 - bug in WAVE channel coordination

- Bug 2148 - Ipv6Interface::SetUp doesn't re-create the Link-Local addresses

- Bug 2153 - Incorrect power limits in wifi power control algorithms

- Bug 2154 - Incorrect power calculation in wifi power adaptation examples

- Bug 2156 - Duplicate packets when using two level aggregation

- Bug 2157 - OpenFlowSwitchNetDevice::BufferFromPacket setting eth_type incorrectly

- Bug 2158 - OpenflowSwitchNetDevice flooding bug

- Bug 2165 - server replies to SYN (with option TS) with a SYNACK (with option TS) also if the attribute Timestamp is false

- Bug 2166 - SteadyStateRandomWaypointMobilityModel directs the node to the ground

- Bug 2170 - AnimationInterface outputs improperly formed XML

- Bug 2171 - power-adaptation-distance.cc:202:22: error: call to 'pow' is ambiguous

- Bug 2173 - WifiInformationElement::DeserializeIfPresent attempts to read beyond the end of buffer

- Bug 2174 - m_rWnd not updated when segments without ACK are received

- Bug 2177 - Ipv6ExtensionFragmentHeader length is initialized to a wrong value.

Known issues

------------

In general, known issues are tracked on the project tracker available

at http://www.nsnam.org/bugzilla/

Release 3.23

============

Availability

------------

This release is available from:

http://www.nsnam.org/release/ns-allinone-3.23.tar.bz2

Supported platforms

-------------------

This release has been tested on the following platforms:

- Ubuntu 15.04 (64 bit) with g++-4.9.2

- Fedora Core 21 (64 bit) with g++-4.9.2

- Ubuntu 14.04 (64 bit) with g++-4.8.2

- Ubuntu 12.04.4 (32/64 bit) with g++-4.6.3

- CentOS/RHEL 6.6 (64-bit) with g++-4.4.7

- OS X Yosemite 10.10.3 with Xcode 6.3.1 and Apple LLVM version 6.1.0

- FreeBSD 10.1-RELEASE (64 bit) with clang-3.4.1

New user-visible features

-------------------------

- (network) CalculateTxTime has been declared obsolete.

  CalculateBytesTxTime and CalculateBitsTxTime are to be used instead.

  The return value is a Time, instead of a double.

- (mobility) Classes added for converting geographic to cartesian coordinates.

- (spectrum) TvSpectrumTransmitter models added to create television 

  transmitter(s) that transmit PSD spectrums customized by attributes such 

  as modulation type, power, antenna type, channel frequency, etc.

- (wifi) Several model improvements have been made.  Access points now 

  establish BSSBasicRateSet for control frame transmissions.  PLCP header 

  and payload reception have been decoupled for improved PHY modeling

  accuracy.  RTS/CTS with A-MPDU is now fully supported, and 802.11n

  stations now support two-level aggregation.

Bugs fixed

----------

- Bug 1757 - RLC AM not using NACK_SN

- Bug 1974 - CalculateTxTime should return a Time, not a double

- Bug 1982 - AODV and mesh use random variables before seed can be set

- Bug 2004 - Wrong timeout calculation for 802.11n in WifiMac

- Bug 2008 - (lr-wpan) Crash if ending rx while status change is in progress

- Bug 2025 - (lr-wpan) Changing the channel doesn't affect the Tx params

- Bug 2034 - (lr-wpan) CSMA-CA BackoffPeriod is too short 

- Bug 2054 - TCP window update can shrink the Left Edge of the window

- Bug 2066 - A-MPDU reception should check for successful preamble

- Bug 2067 - TCP performance when advertised window exceeds sender buffer size

- Bug 2070 - Wrong report of Packets and Bytes stored in CoDeL

- Bug 2073 - NDisc cache entries update timer might be stuck in a loop

- Bug 2075 - A-MPDU using RTS/CTS behaves wrongly when MaxSsrc is reached

- Bug 2076 - TCP MinRTO Attribute is not actually used

- Bug 2077 - Icmpv6L4Protocol::HandleDestinationUnreachable must check the packet size, not its serialized size

- Bug 2079 - mcs variable in ht-wifi-network example is confusing

- Bug 2082 - Empirical RV fails if the value provided in the CDF member function is negative

- Bug 2083 - BridgeNetDevice may send corrupted packets

- Bug 2087 - Waf fails to build ns-3 if the path contains accented characters

- Bug 2090 - (rip-ng) Routes may be added twice on interface activation

- Bug 2093 - MultiModelSpectrumChannel::GetDevice only works for 0-th index

- Bug 2095 - (wimax) Wrong values in default-traces.h for 16 QAM 3/4

- Bug 2097 - ACKs should be sent using legacy rates and preambles in 802.11n

- Bug 2103 - Ipv[4,6]RoutingHelper::PrintRoutingTableAll[At,Every] hangs if a node doesn't have IP

Known issues

------------

In general, known issues are tracked on the project tracker available

at http://www.nsnam.org/bugzilla/

Release 3.22

============

Availability

------------

This release is available from:

http://www.nsnam.org/release/ns-allinone-3.22.tar.bz2

Supported platforms

-------------------

This release has been tested on the following platforms:

- Fedora Core 21 (64 bit) with g++-4.9.2

- Ubuntu 14.10 (32 bit) with g++-4.9.1

- Ubuntu 14.04 (64 bit) with g++-4.8.2

- Ubuntu 12.04.4 (32/64 bit) with g++-4.6.3

- CentOS/RHEL 6.6 (64-bit) with g++-4.4.7

- OS X Yosemite 10.10 with Xcode 6.1.1 and clang-600.0.56

- FreeBSD 10.1-RELEASE (64 bit) with clang-3.4.1

New user-visible features

-------------------------

- (wifi) Support for MPDU aggregation has been added to the wifi model, 

  as well as a number of related example programs.

- (wifi) Added two combined power and rate control mechanisms to the

  wifi module.  The new mechanisms, PARF and APARF, are the first in the

  wifi module to jointly control transmission power and data rate.  Two use 

  case examples (PowerAdaptationDistance and PowerAdaptationInterference) 

  and a test case have also been added.

- (lte) In previous releases of the LTE module, the bearer release

  functionality was only partially supported. As an enhancement, a

  complete release bearer procedure is now implemented, which can be

  invoked by calling the new helper method

  LteHelper::DeActivateDedicatedEpsBearer(). The related output can be

  seen through the stats collected at different layers like PDCP, RLC,

  MAC, PHY. To support this implementation, an example and test suite is

  added within the LTE module examples and tests folder.  

- (wave) Additional support has been added for WiFi-based vehicular networks, 

  including the channel-access coordination features of IEEE 1609.4 and a 

  comprehensive VANET routing example that includes a Basic Safety 

  Message (BSM) packet generator application and associated statistics 

  counters.  Together, these allow users to evaluate the performance effects 

  in a VANET of varying transmission and channel properties (e.g., packet 

  rate, message size, transmit power, propagation loss model, impact of 

  routing protocol traffic, etc.).

- (internet) It is now possible to print the Neighbor Cache (ARP and NDISC) 

  by using the RoutingProtocolHelper

- (stats) A new TimeProbe class has been added to hook the data collection 

  framework to traced values emitting Time objects

- (documentation) the callback function signatures for all TraceSources

  is documented in Doxygen

- (utils) print-introspected-doxygen.cc has had several enhancements;

  use -h to read the usage message for details.

- (core) TracedValue and TracedCallback function signatures are now documented,

  which required changing the TypeId::AddTraceSource API.

Bugs fixed

----------

- Bug 1405 - RttEstimator improvements

- Bug 1551 - NS_LOG_COMPONENT_DEFINE inside or outside of ns3 namespace?

- Bug 1726 - WiFi Minstrel rate control algorithm doesn't save state

- Bug 1734 - TcpSocketBase produces spurious delayed ACKs

- Bug 1758 - Yans and Nist error rate models for 5/6 code rate 802.11n HT

- Bug 1770 - mesh test and example crash for 32-bit optimized builds

- Bug 1774 - compute signal power around channel, not across whole band, and fix LrWpanHelper to add a default PropagationDelayModel

- Bug 1791 - TCP Endpoint never deallocates when closing