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

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

New user-visible features

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

- The LTE module now supports the transport of the S1-U, X2-U and X2-C

  interfaces over emulated links via the new helper class EmuEpcHelper.

- CommandLine can now provide a shorthand argument name for any

  Attribute.

- Implemented support for Frequency Reuse algorithms in LTE module, as the 

  outcome of GSoC 2014 project. 

  The project also includes several sub-features, such as:

   - implementation of Downlink Power Control

   - implementation of Uplink Power Control

   - new DL-CQI generation approach, which increases throughput if FR algorithms 

     are used

   - seven options of Frequency Reuse algorithms: LteFrNoOpAlgorithm, 

     LteFrHardAlgorithm, LteFrStrictAlgorithm, LteFrSoftAlgorithm, 

     LteFfrSoftAlgorithm, LteFfrEnhancedAlgorithm, LteFfrDistributedAlgorithm

   - updated RadioEnvironmentMapHelper. Now RadioEnvironmentMap can be generated 

     for Data or Control channel and for specified RbId, what is helpful when 

     using FR algorithms

- SimpleNetDevice and SimpleChannel are not so simple anymore. 

  SimpleNetDevice can be now a Broadcast or PointToPoint NetDevice, 

  it can have a limited bandwidth and it uses an output queue.

- SimpleNetDevice and SimpleChannel can be installed in a node through 

  an helper: SimpleNetDeviceHelper.

- Implemented new PacketSocketServer and PacketSocketClient applications.

  The primary use is in tests, to avoid the ones from the application module.

Bugs fixed

----------

- Bug 1762 - UE stuck in IDLE_CONNECTING because RRC CONN REQ is not transmitted

- Bug 1811 - basic traffic generator for network module 

- Bug 1831 - TcpSocket SlowStartThreshold is not a TraceSource

- Bug 1851 - WifiRadioEnergyModel energy consumption values are taken from a 802.15.4 chip

- Bug 1854 - std::out_of_range Problem

- Bug 1858 - wireless examples not correctly recording packet reception

- Bug 1860 - TCP needs the Window Scale option

- Bug 1893 - issue in DoSchedUlTriggerReq with harq

- Bug 1921 - Icmpv6L4Protocol::ForgeEchoRequest returns a malformed packet

- Bug 1930 - Use of invalid reference in OLSR RemoveLinkTuple

- Bug 1932 - NdiscCache entry is not failsafe on double neighbor probing.

- Bug 1937 - FlowMonitor fails to track multiplexed packets

- Bug 1942 - refactoring of lte-sinr-chunk-processor -> lte-chunk-processor

- Bug 1943 - Waveform generator signal duration calc error

- Bug 1951 - AODV does not update nexthop for 1-hop nodes

- Bug 1955 - The IPv4 identification field should be unique per (source, destination, protocol) tuple

- Bug 1960 - Wrong information on index range, about Node::GetDevice

- Bug 1961 - planetlab-tap-creator "variable set but not used"

- Bug 1963 - AODV can tag the same packet twice (and raise an assert)

- Bug 1967 - LL Multicast is not compressed in the right way in IPHC

Known issues

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

Release 3.20

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

Availability

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

This release is available from:

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

Supported platforms

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

- Fedora Core 20 (32/64 bit) with g++-4.8.2

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

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

- Ubuntu 10.04.4 LTS (64 bit) with g++-4.4.3

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

- OS X Mavericks 10.9 with Xcode 5.1.1 and clang-503.0.40

- FreeBSD 9.2-RELEASE (64 bit) with clang-3.3

New user-visible features

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

- A new LrWpan model, providing initial support for IEEE 802.15.4 networks

- A new IPv6 routing protocol has been added: RIPng. This protocol is

  an Interior Gateway Protocol and it is available in the Internet module.

- A new LTE MAC downlink scheduling algorithm named Channel and QoS Aware (CQA) 

  Scheduler is provided by the new ``ns3::CqaFfMacScheduler`` object.

- The Internet FlowMonitor can now track IPv6 packets.

- FlowMonitor no longer tracks multicast/broadcast packets, reflecting

  its original design.

- FlowMonitor "SerializeToXml" functions are now directly available 

  from the helper.

- The SixLowPan model can now use uncompressed IPv6 headers. An option to

  define the minimum compressed packet size has been added. 

- Simplify output of Times in a specific unit; see Time::As ()

- Ipv6Extension::m_dropTrace has been removed. Ipv6L3Protocol::m_dropTrace 

  is now fired when appropriate.

- IPv4 identification field value is now dependent on the protocol field.

- Fixes to support Python >= 3.3 in ns3 Python bindings

- Enable selection of high precision int64x64_t implementation

  at configure time, for debugging purposes.

Bugs fixed

----------

- Bug 1276 - optimize NistErrorRateModel

- Bug 1294 - New PeekU8 () and Read (Buffer::Iterator start, uint32_t size) methods in Buffer::Iterator

- Bug 1443 - MinDistance replaced by MinLoss in FriisPropagationLossModel, to

  better handle conditions outside of the assumed far field region.

- Bug 1653 - Extension of CommandLine interface: restored operator << (CommandLine)

- Bug 1717 - Detect unsettable attributes

- Bug 1730 - no model library documentation for spectrum module

- Bug 1739 - The endpoint is not deallocated for UDP sockets

- Bug 1786 - os << int64x64_t prints un-normalized fractional values

- Bug 1787 - Runtime error when using AnimationInterface::EnablePacketMetadata() to fetch metadata of CSMA packet

- Bug 1792 - Parameter logger constructor

- Bug 1808 - FlowMon relies on IPv4's Identification field to trace packets

- Bug 1817 - IPv4 Identification field should consider protocol as well.

- Bug 1818 - FlowMonitor needs IPv6 support

- Bug 1820 - models library doc: make should not rm -rf figures

- Bug 1821 - Setting an interface to Down state will cause various asserts in IPv6

- Bug 1829 - Multiple TCP socket entries

- Bug 1837 - AODV crashes when using multiple interfaces

- Bug 1838 - FlowMonitorHelper must not be copied.

- Bug 1841 - FlowMonitor fails to install if IPv4 is not installed in the node

- Bug 1842 - FlowMonitor SerializeToXml<Something> should be called by the helper

- Bug 1843 - IPv6 extensions dropped packets do not fire L3 drop trace

- Bug 1845 - FlowMonitor should discard any broadcast/multicast packet

- Bug 1846 - IPv6 should send Destination Unreachable if no route is available

- Bug 1850 - TCP NewReno loss behavior

- Bug 1852 - cairo-wideint-private.h error cannot find definitions for fixed-width integral types

- Bug 1853 - NS_LOG_FUNCTION broken on OSX 10.9

- Bug 1855 - SixLowPanNetDevice is not correctly indexed

- Bug 1857 - Detect location of installed boost libraries

- Bug 1862 - NS_LOG="Time=*|prefix_time" causes stack overflow

- Bug 1868 - Optimized builds are sensitive to -fstrict-overflow

- Bug 1870 - Remove unnecessary AsInt functions

- Bug 1872 - Inside RREQ processing, in case of IP duplication, packet dropped instead of being forwarded

- Bug 1873 - Energy source checked to be aggregated to the node

- Bug 1874 - Ipv4L3Protocol::ProcessFragment: addressCombination and idProto identifiers not properly computed

- Bug 1876 - enable OLSR HNA table access

- Bug 1877 - constructors missing for PropagationLossModels

- Bug 1882 - int64x64 tests trigger valgrind bug

- Bug 1883 - IPv6 don't consider the prefix and network when choosing output address

- Bug 1885 - WifiSpectrumValue5MhzFactory::CreateRfFilter does not align with the used 5Mhz SpectrumModel

- Bug 1887 - Point-to-point traces should contain PPP headers

- Bug 1888 - COST231 propagation loss model: corrections

- Bug 1889 - PointToPointNetDevice: In some cases MacTxDrop trace is not called

- Bug 1890 - UdpClientTrace: MPEG frame size is squeezed into (insufficient) 16 bit integer

- Bug 1891 - UdpSocketImpl::GetSockName doesn't return the IPv6 address

- Bug 1894 - CqaFfMacScheduler needs an update

- Bug 1895 - IP header Source Address changed while forwarding RREQ

- Bug 1900 - Avoid floating point differences across platforms in test outputs

- Bug 1903 - Namespace usage in olsr-state.cc/h

- Bug 1907 - Add IsSupportedMcs method in YansWifiPhy

- Bug 1912 - Avoid multiple Wifi MacTxMiddle instances

- Bug 1913 - Avoid crash in Wifi BlockAckManager::GetNextPacket()

- Bug 1915 - BRITE channel delay is rounded to an integer

- Bug 1916 - RandomWalk2dMobilityMode default "Bounds" attribute is not a rectangle

- Bug 1919 - Strip trailing semi-colons from mobility trace files

- Bug 1920 - Remove DSR attributes so file can be re-loaded by config-store

- Bug 1922 - WAVE GetSsid should not be fatal

- Bug 1923 - Setting Active Probing to false in Wifi Sta has no effect

- Bug 1924 - sensing radius and CCA

Known issues

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

- Bug 1770 - The mesh module will crash if used for g++ version >= 4.8.1

in optimized mode, on a 32-bit Linux machine.  Lowering the optimization

level to -O1 in this case can be used as a workaround.

Release 3.19

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

Availability

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

This release is available from:

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

Supported platforms

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

These platforms have been tested; others may work also:

- Fedora Core 20 (32 bit) with g++-4.8.2

- Fedora Core 19 (32/64 bit) with g++-4.8.1

- Ubuntu 13.10 (64 bit) with g++-4.8.1

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

- Ubuntu 10.04.4 LTS (64 bit) with g++-4.4.3

- OS X Mavericks 10.9 with Xcode 5.0.1 and clang-500.2.79

- OS X Mountain Lion 10.8.5 with Xcode 5 and g++-4.2.1

- FreeBSD 9.2-RELEASE (64 bit) with clang-3.3

New user-visible features

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

- Extension to UE measurements and improved handover algorithm models in LTE

  module, as the outcome of GSoC 2013 project. The project also includes several

  sub-features, such as:

   - implementation of System Information Block Type 1 (SIB1);

   - a new option for automatic UE attachment using Idle mode cell selection

     procedure;

   - improved configurability of UE measurements; and

   - two options of handover algorithms for enabling automatic handover trigger

     in LTE simulation: A2-A4-RSRQ and strongest cell (A3-RSRP).

- A new FixedRoomPositionAllocator has been added to the buildings

  module. It allows one to generate a random position uniformly

  distributed in the volume of a chosen room inside a chosen building.  

- A new attribute ns3::LteRlcAm::TxOpportunityForRetxAlwaysBigEnough

  allows to overcome the lack for re-segmentation in the RLC AM

  implementation by assuming that the size of a TxOpportunity is

  always big enough for the RLC AM PDU to be retransmitted.

- After some profiling, the code of LteMiErrorModel has been optimized

  for speed, resulting in a significantly lower execution time of the

  LTE model when used with the error model enabled.

- A new WiFi extension for vehicular simulation support is available in 

  the src/wave directory.  The current code represents an interim capability 

  to realize an IEEE 802.11p-compliant device, but without the WAVE 

  extensions (which are planned for a later patch).  The WaveNetDevice 

  modelled herein enforces that a WAVE-compliant physical layer (at 5.9 GHz)

  is selected, and does not require any association between devices (similar 

  to an adhoc WiFi MAC), but is otherwise similar (at this time) to a 

  WifiNetDevice.  WAVE capabililties of switching between control and 

  service channels, or using multiple radios, are not yet modelled.

- A new IPv6 over Low power Wireless Personal Area Networks (6LoWPAN) model

  is available.  Using ns-3's naming convention, the acronym is expanded

  to SixLowPanNetDevice.   The SixLowPanNetDevice is able to act as a 

  shim between IPv6 and a NetDevice, compressing IPv6 headers according 

  to RFCs 4944 and 6262.  The SixLowPanNetDevice is meant to be used over 

  IEEE 802.15.4 NetDevices, but it can be used on other NetDevices as 

  well (see the manual for full details).  This model precedes the

  general availability of an 802.15.4 model, so must be run in conjunction

  with a wired NetDevice model for now, or with experimental versions of

  802.15.4 models.

- It is now possible to use Ipv6PacketInfoTag from UDP applications in the

  same way as with Ipv4PacketInfoTag. See Doxygen for current limitations in

  using Ipv[4,6]PacketInfoTag to set IP properties.

- Ipv[4,6]Interfaces not respecting the minimum MTU requirements (68 octects

  for IPv4 and 1280 octects for IPv6) will be automatically set as Down.

- IPv6 addresses and routing tables are printed in a more conventional way,

  closely matching the Linux "route -A inet6" command.

- Additional time units (Year, Day, Hour, Minute) were added to the time

  value class that represents simulation time; the largest unit prior to 

  this addition was Second.

- A new parallel scheduling algorithm based on null messages, a common 

  parallel DES scheduling algorithm, has been added.  The null message 

  scheduler has better scaling properties when running on some scenarios

  with large numbers of nodes since it does not require a global 

  communication.

Bugs fixed

----------

- Bug 1496 - Option to print log level in NS_LOG messages, and documentation.

- Bug 1592 - Parsing bug in FlowMonitor example script

- Bug 1756 - RLC AM Mode State Variable Bug

- Bug 1763 - Message 3 should be sent using the UL GRANT in the RAR

- Bug 1778 - Implement TapBridge::IsLinkUp() function

- Bug 1777 - Implement the more direct way of "using" configuration of existing tap interface

- Bug 1776 - Improve CRC performance for CsmaNetDevice in emulation modes

- Bug 1788 - unused private field warning

- Bug 1789 - missing test condition for sigma in buildings-shadowing-test

- Bug 1796 - Ipv6PacketInfoTag is not filled by UdpSocketImpl::ForwardUp6

- Bug 1798 - Changing the rate of onOffApplication might stop transmission

- Bug 1802 - FlowMon header deserialization problem with IPv4 fragments

- Bug 1803 - Lookup /NodeList/4/DeviceList/0/LteEnbRrc/UeMap/0 got no matches

- Bug 1807 - Multiple bugs in Ipv4L3Protocol::LocalDeliver

- Bug 1810 - IP packets can be sent on NetDevices not respecting the minimum MTU requirements

- Bug 1814 - IPv6 Packet with length not multiple of 8 bytes are fragmented incorrectly.

- Bug 1815 - Python bindings compilation with clang compiler toolchain

- Bug 1816 - IPv4 fragmentation loses Packet tags

- Bug 1877 - constructor missing for <something>PropagationLossModels

Release 3.18.2

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

ns-allinone-3.18.2 was released to include a bake configuration file update

for Direct Code Execution.  The ns-3 code in this release was unchanged

from that of ns-3.18.1.

Release 3.18.1

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

This release is mainly to provide updated compiler support (clang/LLVM)

and fix the Python API scanning facility.  A few additional bug fixes

and new features are described below.

Availability

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

This release is available from:

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

Supported platforms

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

These platforms have been tested; others may work also:

- Fedora Core 19 (32/64 bit) with g++-4.8.1

- Ubuntu 13.10 (64 bit) with g++-4.8.1

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

- Ubuntu 10.04.4 LTS (64 bit) with g++-4.4.3

- OS X Mavericks 10.9 with Xcode 5.0.1 and clang-500.2.79

- OS X Mountain Lion 10.8.5 with Xcode 5 and g++-4.2.1

- FreeBSD 9.2-RELEASE (64 bit) with clang-3.3

New user-visible features

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

- It is now possible to randomize the time of the first beacon from an 

  access point.  Use an attribute "EnableBeaconJitter" to enable/disable 

  this feature.

- A new FixedRoomPositionAllocator helper class is available; it

  allows one to generate a random position uniformly distributed in the

  volume of a chosen room inside a chosen building.

- Logging wildcards:  allow "***" as synonym for "*=**" to turn on all logging.

- The log component list ("NS_LOG=print-list") is now printed alphabetically.

Bugs fixed

----------

- Bug 1779 - NS_UNUSED_GLOBAL not working in attribute test class declaration

- Bug 1766 - Fixes to wifi-hidden-terminal.cc example

- Bug 1722 - Avoid transmitting beacons concurrently

- Bug 1691 - RTS/CTS NAV reset prematurely

- Bug 1622 - Avoid waf hanging during apiscan

- Bug 1616 - WifiPhyStateHelper reports false CCA_BUSY times at State trace source

- Bug 1552 - Storing log name inside LogComponent class (NS_LOG) as std::string

- Bug 1011 - assert failed. file=../src/devices/wifi/dcf-manager.cc

- bug 945 - remove deprecated IEEE 802.11p code from wifi module

- Fix aliasing bug in optimized static builds

- Fix memory leak due to circular reference in MPI module

- Make wifi tests more robust to random variable perturbations

- Fix Time class doxygen

- Fix compilation with Clang 3.2 and newer versions, including Apple Xcode 5

- Miscellaneous NetAnim fixes

Release 3.18

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

Availability

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

This release is available from: 

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

Supported platforms

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

These platforms have been tested; others may work also:

- Fedora Core 18 (32/64 bit) with g++-4.7.2

- Fedora Core 17 (32/64 bit) with g++-4.7.0

- Ubuntu 13.04 (32/64 bit) with g++-4.7.3

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

- Ubuntu 10.04.4 LTS (64 bit) with g++-4.4.3

- OS X Mountain Lion 10.8.3 with g++-4.2.1

- FreeBSD 9.1-RELEASE (64 bit) with g++-4.2.1

New user-visible features

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

- Time attributes can now be bounded.  See attribute-test-suite.cc for an

  example.

- Data collection components have been added to the stats module.  These

  components can be used to generate time series data in files and plots.

- IPv6 address class 2001:db8::/32 is now dropped by routers (RFC 3849).

- New generic hash function interface.  Two hash functions are provided:

  murmur3 (default), and the venerable FNV1a.  See the Hash Functions

  section in the Manual.

- New Mac16Address has been added, Mac64Address is now in-line with 

  Mac48Address and all the three can be used in IPv6 autoconfigure. 

- Previously, the use of Building models was limited to the use of the

  companion BuildingsMobilityModel. Now, any MobilityModel can be

  used with Building models. 

- The latest LTE module code by the LENA project has been merged,

  including the following new features: 

   - PHY support for UE measurements (RSRP and RSRQ)

   - RRC support for UE measurements (configuration, execution, reporting)

   - Automatic Handover trigger based on RRC UE measurement reports

- IPv6 can now detect and use Path-MTU. See 

  examples/ipv6/fragmentation-ipv6-two-MTU.cc for an example.

- Radvd application have a new Helper. See the updated 

  examples/ipv6/radvd.cc for an example.

- 11n- It is now possible to create a high throughput (HT) node that used the new 11n data rates and preambles.

- It is now possible to request printing command line arguments to the

  desired output stream using PrintHelp or operator <<

Bugs fixed

----------

- Bug  760 - IP address removal can be painful

- Bug 1190 - Suppress hello if bcast was sent within the last hello interval

- Bug 1296 - Enhancement in Ipv[4,6]RoutingHelper

- Bug 1390 - ICMPv6 Redirect are handled correctly only for /64 networks

- Bug 1522 - Hidden node scenario leads to ARP failure

- Bug 1584 - Old Association Request Timeouts are not canceled

- Bug 1629 - Make AODV Default to Disable Hello

- Bug 1643 - NdiscCache creation and existence checks

- Bug 1646 - ICMPv6 Redirect are sent from global address instead of link-local

- Bug 1662 - m_type not set for Ipv6OptionRouterAlertHeader

- Bug 1678 - C++11 compliance problem with std::pair"

- Bug 1682 - ./waf crashes on FC10

- Bug 1683 - IPv6 autoconfigured don't use *infinite* lifetimes

- Bug 1669 - ns-3 should support binding two and three (possibly more) arguments

- Bug 1675 - Throughput computation error in Wireless examples

- Bug 1687 - wscript features report doesn't respect NOCOLOR

- Bug 1688 - Routers should advertise themselves from the link-local address

- Bug 1689 - IPv6 shouldn't add a default gateway without checking the Router lifetime

- Bug 1690 - missing header files from wifi wscript

- Bug 1697 - ICMPv6 Redirect trigger contains multiple bugs

- Bug 1698 - mobility.SetPositionAllocator misses prefix "ns3::"

- Bug 1700 - Ipv6RawSocket does not honor the bound address when sending packets

- Bug 1701 - Ipv6StaticRouting: the source address should match the destination scope

- Bug 1702 - Ipv6InterfaceContainer::SetRouter should not always add the router as the default router.

- Bug 1703 - Nodes don't react to a DAD

- Bug 1712 - The IP (v4 and v6) forwarding needs a test

- Bug 1718 - Ipv4StaticRouting log component is misspelled

- Bug 1720 - IPv6 Fragmentation cause crashes

- Bug 1721 - Path MTU isn't handled properly

- Bug 1723 - name clash in ipv4-header.h with <termios.h>

- Bug 1727 - Ping6 should use a proper source address

- Bug 1728 - Radvd application is missing an Helper

- Bug 1731 - lte-phy-error-model passes unexpectedly

- Bug 1738 - strict aliasing compiler bug

- Bug 1742 - IPv6 HbH and Dst Extension Header size is not correctly calculated

- Bug 1752 - RadvdInterface m_defaultLifeTime is set to milliseconds instead of seconds

- Bug 1753 - Halting Issue with DistributedSimulatorImpl

- Bug 1754 - Missing GIL lock in generated callback destructor

Known issues

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

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

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

Release 3.17

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

Availability

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

This release is available from: 

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

Supported platforms

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

These platforms have been tested; others may work also:

- Fedora Core 18 (32/64 bit) with g++-4.7.2

- Fedora Core 17 (32/64 bit) with g++-4.7.0

- Ubuntu 13.04 (32/64 bit) with g++-4.7.3

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

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

- Ubuntu 10.04.4 LTS (64 bit) with g++-4.4.3

- OS X Mountain Lion 10.8.3 with g++-4.2.1

- FreeBSD 9.1-RELEASE (64 bit) with g++-4.2.1

New user-visible features

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

- new TCP Westwood and Westwood+ models

- new FdNetDevice model and associated helpers.  The FdNetDevice is able

  to read and write from a file descriptor.  Various helpers are provided

  to associate this descriptor with underlying devices or sockets on the 

  host operating system, including a packet socket for emulation, and

  tap devices including a version specialized for use on PlanetLab.

- ns-3-click: it's now possible to (i) have Click pull random numbers from

  ns-3 and (ii) have ns-3 set "defines" in Click via the simulation file 

  (see src/click/examples/nsclick-defines.cc).

- Waf shipped with ns-3 has been upgraded to version 1.7.10 and custom

  pkg-config generator has been replaced by Waf's builtin tool.

- create-module.py script has been updated to work with waf 1.7 and support

  for creating modules with names containing dashes has been added.

- the M5 release of the LTE module by the LENA project has been

  merged; please see src/lte/RELEASE_NOTES for more detailed info