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 available from: 

Supported platforms

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

New user-visible features

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

- Dual-stacked IPv6 sockets are implemented. An IPv6 socket can accept an IPv4 

  connection, returning the senders address as an IPv4-mapped address 

  (IPV6_V6ONLY socket option is not implemented).

- Ipv6RoutingHelper is now in-line with Ipv4RoutingHelper concerning the RT 

  print functions. Various minor changes made in Ipv6RoutingProtocol and derived 

  classes to make this possible.

- New "SendIcmpv6Redirect" attribute (and getter/setter functions) to 

  Ipv6L3Protocol. The behavior is similar to Linux's conf "send_redirects",

  i.e., enable/disable the ICMPv6 Redirect sending.

- An antenna module is now included, which includes different

  radiation pattern models. See the corresponding new section of the

  ns-3 models library documentation for details. 

Bugs fixed

----------

 - bug 1313 - Stddev (average.h) returning NaN

 - bug 1319 - Fix Ipv6RawSocketImpl Icmpv6 filter

 - bug 1318 - Asserts for IPv6 malformed packets

 - bug 1339 - test.py uses the old name for the test runner

 - bug 1357 - IPv6 fragmentation fails due to checks about malformed extensions

 - bug 1378 - UdpEchoClient::SetFill () does not set packet size correctly

 - bug 1351 and 1333 - TCP not able to take RTT samples on long delay network

 - bug 1362 - ICMPv6 does not forward ICMPs to upper layers (and minor fixes to ICMPv6)

 - bug 1392 - Modules built report does not clarify C++ or Python

 - bug 1395 - AODV DeferredRouteOutputTag missing constructor

Known issues

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

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

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

Release 3.13

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

Availability

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

This release is available from: 

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

Supported platforms

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

ns-3.13 has been tested on the following platforms.  Not all features are

available on all platforms; check the Installation page on the project wiki.

- Ubuntu 11.10 (32 bit) with g++-4.5.2

- Ubuntu 11.04 (32/64 bit) with g++-4.5.2 

- Ubuntu 10.04.3 LTS (64 bit) with g++-4.4.3, g++-3.4.6 

- OS X Lion with g++-4.2.1

- OS X Snow Leopard with g++-4.2.1 

- Fedora Core 16 (32/64 bit) with g++-4.6.2

  --  however, g++-3.4.6 fails on Fedora 16 i686 

- Fedora Core 14 (64 bit) with g++-4.5.1

- FreeBSD 9.0-RC1 (AMD64) with g++-4.2.1

New user-visible features

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

- IPv6 address generator with support for duplicate address detection

Bugs fixed

----------

 - bug 962 - list of paths to reach objects contains bogus entries

 - bug 1001 - Buffer::CopyData() doesn't return the number of bytes copied

 - bug 1010 - Uan model sleep patch

 - bug 1020 - Wrong usage of the originator sequence number in HWMP PREP

 - bug 1021 - Beacon collision avoidance in Mesh module works incorrectly

 - bug 1039 - Nagle's algorithm in TCP 

 - bug 1055 - Wrong UAN's Thorp absorption loss model formula

 - bug 1059 - Unable to load trace files created from SUMO and TraNS Lite

 - bug 1112 - Advance m_nextTxSequence upon retransmit after RTO 

 - bug 1137 - mpi module is hard-coded for openmpi

 - bug 1166 - IPV4 TCP failed to send a RST when connect arrives before listen

 - bug 1186 - Ipv4Header lacks DSCP and ECN

 - bug 1204 - Can't Parse Time +100000000.0ns

 - bug 1219 - Coding style of ns2-mobility-helper-test-suite.cc is fixed

 - bug 1257 - waf install __init__ Python files even with --disable-python

 - bug 1263 - waf configure fails on FreeBSD 9.0-BETA2 amd64

 - bug 1266 - gdb cannot be loaded

 - bug 1227 - Spurious RTO due to low min RTO

 - bug 1229 - Multiplication overflow in WaypointMobilityModel::EndMobility

 - bug 1242 - m_lastRtt in tcp-socket-base.cc not implemented

 - bug 1256 - TCP unnecessary snd.nxt advance

 - bug 1265 - Make ns-3 directory "movable"

 - bug 1269 - sqlite3 not found on FreeBSD

 - bug 1270 - "Checking boost includes" weirdness

 - bug 1278 - Ipv4ClickRouting::HandleScheduleFromClick bug

 - bug 1281 - Checksum not calculated when doing IP fragmentation

 - bug 1285 - IPv6 Localhost is marked as GLOBAL instead of HOST

 - bug 1290 - buffer-test.cc gets a valgrind error

 - bug 1295 - Missing const qualifiers in TopologyRead 

 - bug 1299 - EnableAsciiIpv4All tracing doesn't show transmitted/recvd packets

 - bug 1300 - HalfDuplexIdealPhy notify SpectrumInterference of AbortRx 

 - bug 1301 - Ns2MobilityHelper causes Node GetPosition() to return NaN

 - bug 1305 - do not list modules built upon exiting waf shell

 - bug 1312: TopologyRead Assert condition fix

 - IPv4 packets double fragmentation was broken 

 - Fix wifi-clear-channel-cmu.cc example

 - NetAnim: fix for bcast packet reuse

 - Missing PropagationLossModel.CalcRxPower in Python bindings

 - Corrected compilation behavior in Ubuntu 11.10 due to ldd behavior change

 - Added required PTHREAD dependency to RT library check.

Known issues

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

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

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

Release 3.12.1

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

Availability

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

This release is available from: 

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

Bugs fixed

----------

This release fixes PyViz visualizer's python bindings; otherwise, it

is the same as the ns-3.12 release.

Release 3.12

===========

Availability

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

This release is available from: 

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

Supported platforms

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

ns-3.12 has been tested on the following platforms.  Not all features are

available on all platforms; check the Installation page on the project wiki.

- Fedora Core 15 (32/64 bit) with g++-4.6.0 

- Ubuntu 11.04 (32/64 bit) with g++-4.5.2 

- OS X Lion with g++-4.2.1 

- Fedora Core 14 (64 bit) with g++-4.3.4, g++-4.5.3, g++-4.4.6 

- Fedora Core 12 (64 bit) with g++-4.4.4 

- OS X Snow Leopard with g++-4.2.1 

- Ubuntu 10.04.3 LTS (64 bit) with g++-4.4.3, g++-3.4.6 

New user-visible features

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

- SpectrumChannel models now support the usage of single-frequency

  propagation loss models based on the PropagationLossModel

  class. These model can be used in conjunction with

  the frequency-dependent propagation loss model based on the

  SpectrumPropagationLossModel class already supported by

  SpectrumChannel. 

- Extend the attribute system extend the attribute system to store map

  container objects in addition to vector containers.  The ObjectMap

  and related classes are patterned after ObjectVector.

- Support for IPv4 fragmentation has been added.

- Significant performance improvement for AODV in dense mobile scenarios

  due to a fixed bug in RERR processing.

- WiFi traces that were named promiscuous are now renamed monitor, and

  a separate flag for setting the interface to promiscuous mode has been

  introduced.  This disambiguates monitor mode from promiscuous mode.

- Monolithic Python bindings have been removed

Bugs fixed

----------

 - bug 845  - fix ConfigStore output for changing default values

 - bug 1010 - Uan model Sleep patch

 - bug 1033 - Mesh airtime-metric fixed

 - bug 1043 - lte-spectrum-value-helper.cc file swapped uplink/downlink freq.

 - bug 1050 - ISO C++ forbids variable length array; remove all instances

 - bug 1057 - LTE bearers differentiation issue

 - bug 1082 - Check that log component names are correct when taken from NS_LOG

 - bug 1100 - IPv6 fragmentation enhancements

 - bug 1102 - IPv4 header fragment offset field not set correctly

 - bug 1123 - class MinMaxAvgTotalCalculator does not implement all methods

 - bug 1134 - Fix LiIonEnergySource attribute spelling for InitialCellVoltage

 - bug 1139 - Broadcast packets issue in uan cw mac

 - bug 1141 - MeshWifiInterfaceMac adds supported modes to wrong remote station

 - bug 1163 - Ipv4EndPointDemux::AllocateEphemeralPort forget to increment port

 - bug 1164 - IPV4 TCP Bind already used port failed, but without setting errno

 - bug 1168 - BridgeNetDevice: default expiration time not realistic

 - bug 1174 - Ns-3 does not generate static libraries

 - bug 1175 - shared libraries are not versioned

 - bug 1193 - AODV Hello timers scheduling skewed when RREP, RREQ are processed

 - bug 1194 - AODV Incorrect RERR processing

 - bug 1201 - UDP sockets need to set connected state before notifying the ConnectionSucceeded callback

 - bug 1208 - Spectrum module example causing valgrind errors

 - bug 1209 - ns-3-click fails to build on Fedora 15 when tests are enabled

 - bug 1220 - FdReader always stops with NS_FATAL_ERROR

 - bug 1222 - Incomplete PointToPointNetDevice Python bindings

 - bug 1224 - ns-3-allinone fails to compile on OS X Lion

 - bug 1226 - Incomplete YansWifiChannel Python bindings

 - bug 1234 - GetAttributeChecker is not defined anymore but still used

 - bug 1239 - Add assertion that reference count never overflows

 - bug 1244 - Seg Faults in optimized builds due to missing Logging components

 - Fix ARP issue in nsclick-ip-router.click and static route in nsclick-routing-node2.click

Known issues

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

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

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

Release 3.11

===========

Availability

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

This release is available from: 

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

Supported platforms

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

ns-3.11 has been tested on the following platforms.  Not all features are

available on all platforms; check the Installation page on the project wiki.

- Linux x86_64 Ubuntu 11.04

  - g++-4.5.2

- Linux i686 Ubuntu 11.04

  - g++-4.5.2, g++-4.4.5

- Linux x86_64 Fedora Core 15

  - g++-4.6.0

- Linux x86_64 Fedora Core 14

  - g++-4.5.3, g++-4.4.6, g++-4.3.4

- Linux x86_64 Fedora Core 10

  - g++-3.4.6, 4.0.4, 4.1.2, 4.2.4, 4.3.2, 4.4.0

- OS X Snow Leopard

  - g++-4.2.1 

New user-visible features

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

  - The build system has been modularized, and the source code reorganized,

    to allow for modular libraries instead of a single monolithic ns-3

    library.   User programs now link a number of smaller, per-module

    libraries depending on the dependencies expressed to the build system.  

    Source code is now being maintained in individual modules with

    consistent directory structures.

  - Python bindings have also been modularized, and the bindings are now

    generated into a 'ns' namespace instead of 'ns3' for the old

    (monolithic) bindings.  By default the bindings are now modular, with

    a backward compatibility layer for older programs.  

  - By default, example and test programs are disabled from the build.

    Users can enable them via the use of a waf command at configure time,

    or automatically through the use of a new .ns3rc file.

  - int64x64_t is a new type which allows portable and easy to write arithmetic

    calculations that require a high degree of fractional precision.

  - An interface to the Click Modular Router and an Ipv4ClickRouting

    class has been added, to allow a node to use Click for external routing.

  - An interface to an OpenFlow software implementation distribution has

    been added to allow the simulation of OpenFlow switches in ns-3.

  - ns-3 coding style requirements have been applied to the entire coding

    base, resulting in a large number of whitespace changes.  The coding 

    style has been automatically enforced by running a style checking 

    program (utils/check-style.py) that uses the uncrustify (v. 0.58)

    program to apply changes. 

  - Some documentation reorganization to split documentation between

    the ns-3 manual (primarily focusing on the ns-3 core) and a new 

    "model library" document has been started.

Bugs fixed

----------

The following lists many of the bugs fixed or small feature additions

since ns-3.10, in many cases referencing the Bugzilla bug number.

   - bugfix: CsmaNetDevice ErrorModel not discarding packet

   - bugfix: do not call RouteOutput() twice 

   - Workaround gccxml bug scanning Seconds(0) as default value 

   - Copy a bug fix from ns3modulescan.py into ns3modulescan-modular.py 

   - Modular Python bindings work (many bug fixes, more modules tested) 

   - Modular bindings: bug fixes, more verbose scanning 

   - ./waf --apiscan: fix bug in detection of whether the per-module

   - Remove the 'Modules to build' debug print 

   - CsmaNetDevice ReceiveErrorModel was not dropping the packet

   - Several "set but not used" bugs for newer compilers quick-fixed

   - bug 445 - Is the class name Scalar in nstime.h appropriate?

   - bug 699 - TestCase::DoRun probably should not return a bool

   - bug 823 - Need finer-grained control over what goes into libns3

   - bug 957 - Issue with test.py

   - bug 1017 - node --> internet-stack --> node

   - bug 1018 - mobility --> helper --> mobility circular dependency

   - bug 1019 - common --> node --> common circular dependency

   - bug 1038 - Time::Get*Seconds () return signed integer while actually returning unsigned.

   - bug 1040 - Olsr and multiple interfaces

   - bug 1042 - AODV RERR implosion (missing RERR_RATELIMIT) 

   - bug 1044 - Seconds (1e-9) creates Time that is not IsPositive ()

   - bug 1047 - Multicast routes on nodes with >16 interfaces

   - bug 1048 - suggested MatrixPropagationLossModel::SetLoss() API change

   - bug 1049 - Issues with OLSR HNA messages sent by multiple gateways

   - bug 1052 - olsr::RoutingProtocol::LinkTupleUpdated incorrect detection of asymetric link with multiple interface nodes

   - bug 1054 - ipv6 InternetStackHelper EnablePcapIpv6All() broken

   - bug 1056 - CSMA: padding not handled correctly for LLC encapsulation

   - bug 1058 - InternetStackHelper pitfall: calling Install before adding routing protocols

   - bug 1060 - Setting NqStaWifiMac Active Probing true, crashes simulation

   - bug 1061 - Title level inconsistent in click.rst

   - bug 1062 - rescale-pdf not working

   - bug 1064 - Correct Friis propagation loss equation in spectrum module

   - bug 1066 - Set Radiotap modulation type flags correctly

   - bug 1069 - ApWifiMac unduly calls RegularWifiMac::Receive and crashes

   - bug 1070 - csma/ipv6 examples duplicate NS_LOG_COMPONENT_DEFINE

   - bug 1072 - crash upon call to Packet::AddAtEnd of fragmented packets 

   - bug 1075 - Python examples fail when static built is enabled

   - bug 1076 - Waf gives an error if you enable only a single module

   - bug 1078 - PacketTagList::Add performs NS_ASSERT counting one byte too few

   - bug 1079 - MPI code doesn't compile

   - bug 1081 - wutils.py refers to the old directory for visualizer module

   - bug 1083 - scratch doesn't work when only some modules are enabled

   - bug 1085 - Build failed: list index out of range

   - bug 1086 - sanity check for not calling Object::Dispose () twice

   - bug 1087 - Call MPI_Finalize to exit MPI environment

   - bug 1088 - Code in scratch directory assumes all modules are enabled

   - bug 1089 - lwip build issue

   - bug 1090 - WifiMacQueue is not accessible through the attribute path

   - bug 1092 - Problem building FreeBSD stack with g++ 4.5.2 (Ubuntu)

   - bug 1094 - Object::GetObject upon dlopen 

   - bug 1097 - AODV routing entry set to be VALID mistakenly.

   - bug 1098 - when to show users which modules are enabled?

   - bug 1101 - Sqlite stats disappeared from configuration file src/wscript

   - bug 1103 - Useless assignment in omnet-data-output.cc

   - bug 1105 - Move topology helpers into separate per-device modules

   - bug 1106 - Remove "CanvasLocation" dependencies in p2p helpers

   - bug 1108 - test.py -e option needs repair

   - bug 1110 - Sort alphabetically and display "Modules built" in columns

   - bug 1117 - bindings failures on selected platforms

   - bug 1122 - spectrum-value test should check tolerance on a per-value basis

   - bug 1125 - ./waf --enable-modules fails

   - bug 1131 - Bug in Ipv4L3Protocol::RemoveAddress()

   - bug 1133 - DSDV: Possible bug in settling time calc

   - bug 1142 - Wrong 802.11p Slot time

   - bug 1146 - help string for test.py with disabled tests

Known issues

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

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

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

Release 3.10

===========

Availability

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

This release is available from: 

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

Supported platforms

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

ns-3.10 has been tested on the following platforms.  Not all features are

available on all platforms; check the Installation page on the project wiki.

- Linux i686 Ubuntu 10.10

  - g++-4.4.5

- Linux x86_64 Ubuntu 8.04.4

  - g++-3.4.6, g++-4.2.4

- Linux x86_64 Fedora Core 12

  - g++-4.4.4

- Linux x86_64 Fedora Core 10

  - g++-3.4.6, 4.0.4, 4.1.2, 4.2.4, 4.3.4, 4.4.0

- OS X Snow Leopard

  - g++-4.2.1 

- OS X powerpc Leopard 

  - g++-4.0, g++-4.2

New user-visible features

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

   - NS-3 PyViz, a live simulation visualizer, has been added.  The 

     visualizer interacts with a running simulation, such that it uses no

     trace files. It can be most useful for debugging purposes, i.e. to

     figure out if mobility models are what you expect, where packets are

     being dropped, etc. There is also a builtin interactive python console

     that can be used to debug the state of the running objects. Although

     it is mostly written in Python, it works both with Python and pure C++

     simulations.

   - Wi-Fi MAC high classes have been reorganised in attempt to

     consolidate shared functionality into a single class. This new

     class is RegularWifiMac, and it derives from the abstract

     WifiMac, and is parent of AdhocWifiMac, StaWifiMac, ApWifiMac,

     and MeshWifiInterfaceMac. The QoS and non-QoS class variants are

     no longer, with a RegularWifiMac attribute "QosSupported"

     allowing selection between these two modes of

     operation.

   - Support for IEEE 802.11g (specifically, rates with Modulation

     Class ERP-OFDM) has been added to the wifi module. The new

     WifiModes have names of the form ErpOfdmRatexxMbps, where xx is

     the rate in Mbps (one of 6, 9, 12, 18, 24, 36, 48, 54), and a

     WifiPhyStandard enumeration WIFI_PHY_STANDARD_80211g has been

     added to allow configuration of a Wi-Fi STA supporting ERP-OFDM,

     HR/DSSS, and DSSS rates (which some call an "802.11b/g" station).

   - Two attributes were added to WaypointMobilityModel.  The first

     "LazyNotify" (default false), if enabled to true, will suppress

     course change notifications if there are no position updates.

     The second, "InitialPositionIsWaypoint" (default false), if enabled,

     will allow an initial call to SetPosition () (before any waypoints

     have been added) to be treated as the first waypoint.

   - Regression testing is now completely performed within test.py

     rather than a separate "./waf --regression" that consults

     reference traces in the ns-3.x-ref-traces directory.  In most

     cases, the example programs whose traces were included in 

     ns-3.x-ref-traces have a corresponding test called from the

     test.py program.  It is still possible to write trace-based

     regression tests but they are now called from the test.py

     program.

   - New BulkSendApplication sends data as fast as possible up to 

     MaxBytes or unlimited if MaxBytes is zero.  Think OnOff, but 

     without the "off" and without the variable data rate. This 

     application only works with SOCK_STREAM and SOCK_SEQPACKET 

     sockets, for example TCP sockets and not UDP sockets.

   - Extensions to the energy models:  1) a new Rakhmatov Vrudhula 

     non-linear battery model, 2) additional support for modeling 

     energy consumption in WiFi devices, 3) an example for how to add 

     energy models to a WiFi-based simulation (in examples/energy/ 

     directory).

   - New methods to print IPv4 routing tables to an output stream.

   - A replacement implementation for TCP for IPv4.  TcpSocketBase

     now replaces TcpSocketImpl.  There are subclasses defined for

     TCP Tahoe, Reno, NewReno, and the original RFC793 without

     congestion control.

   - Energy support for UAN module and Li-Ion energy model.

     Now each network node can have an associated energy source

     from which it consumes energy. The user can specify a custom

     energy model for the underwater transducer, with default values

     set for WHOI acoustic transducer. Li-Ion battery model added

     into energy models folder.

   - Destination-Sequenced Distance Vector (DSDV) routing protocol 

     is a proactive, table-driven routing protocol for MANETs 

     developed by Charles E. Perkins and Pravin Bhagwat in 1994. 

     This implementation is for IPv4 routing and was contributed 

     by ResilNets Research Group.

   - A novel model to simulate LTE networks has been added.  It focuses 

     mainly on modeling the E-UTRA part of the system, with a particular 

     attention on the aspects related to the channel, PHY and MAC layers. 

     The most important features available at this moment are (i) a basic 

     implementation of both the UE and the eNB devices, (ii) RRC and 

     entities for both the UE and the eNB, (iii) an Adaptive Modulation 

     and Coding (AMC) scheme for the downlink, (iv) the management of the 

     data radio bearers (with their QoS parameters), the MAC queues and 

     the RLC instances, (v) Channel Quality Indicator (CQI) management, 

     (vi) support for both uplink and downlik packet scheduling, 

     (vii) a PHY layer model with Resource Block level granularity, and 

     (viii) a channel model with the outdoor E-UTRAN propagation loss 

     model.

   - Project documentation has been converted from GNU Texinfo to Sphinx.