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

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

Bugs fixed

----------

 - bug 1485 - Setting global properties in config file (raw text) does

              not have any effect

Known issues

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

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

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

Release 3.15

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

Availability

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

This release is not yet available.

Supported platforms

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

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

- Fedora Core 15 (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.7.4 with g++-4.2.1

- OS X Snow Leopard 10.6.8 with g++-4.2.1 

- FreeBSD 8.2 (32 bit) with g++-4.2.1

- Cygwin 1.7.9-1 with g++-4.5.3

New user-visible features

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

- A new random variable base class called 'RandomVariableStream', has been

  introduced.  This base class derives from ns3::Object, unlike the current 

  'RandomVariable' class which is a special type of object in the ns-3 

  system to date.  By making this class derive from ns3::Object, it can be 

  handled with the Ptr class, can carry attributes, and can have its parameters

  and initial state saved in the config-store subsystem.  A new attribute

  called "Stream" has been introduced for this class, to allow users to

  better control the assignment of underlying pseudo-random sequences to

  the RandomVariableStream objects (bug 101).

Bugs fixed

----------

 - bug 101 - random variable initialization

 - bug 1256 - Unnecessary SND.NXT advance, missing ACK for Out of Order segments

 - bug 1308 - Nix-vector; do not process packets to self

 - bug 1386 - assert if PositionAllocator not provided to 

              RandomWaypointMobilityModel

 - bug 1399 - TCP not backing off retransmissions properly

 - bug 1441 - IPv4 header length handling

 - bug 1464 - ConfigStore Save + Load => Could not set default value 

                  for ns3::UdpSocketImpl::IcmpCallback

 - bug 1470 - define default parameter for constructor in .h file

 - bug 1473 - GetQueue/SetQueue missing from Csma python bindings

 - bug 1475 - "test.py --list" should sort the output

 - bug 1476 - TestCase::GetName () should not be private

 - bug 1477 - Click doesn't work with raw sockets

 - bug 1481 - Openflow example doesn't run

 - bug 1486 - Segfaults in nix-vector-routing with bridges

 - bug 1489 - Jakes Log component is missing

 - fixed bug with multiple LCs in UL BSR

 - fixed bug with lena-dual-stripe crashes with --homeUesHomeEnbRatio=2

Known issues

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

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

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

Release 3.14.1

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

Availability

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

This release is available from:

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

Bugs fixed

----------

This hotfix release contains a fix for the PyViz visualizer and makes it

easier to add PyViz support to examples; otherwise it is the same as the

ns-3.14 release.

Release 3.14

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

Availability

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

This release is available from: 

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

Supported platforms

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

ns-3.14 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 17 (32/64 bit) with g++-4.7.0

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

- Fedora Core 15 (64 bit) with g++-4.6.3

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

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

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

- OS X Lion 10.7.4 with g++-4.2.1

- OS X Snow Leopard 10.6.8 with g++-4.2.1 

- FreeBSD 8.2 (32 bit) with g++-4.2.1

- Cygwin 1.7.9-1 with g++-4.5.3

New user-visible features

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

- Transport protocol implementations (TCP, UDP) have been refactored to

  support also IPv6 connections. Dual-stacked IPv6 sockets are implemented. 

  An IPv6 socket can accept an IPv4 connection, returning the sender's 

  address as an IPv4-mapped address (IPV6_V6ONLY socket option is not 

  implemented).

- The LTE code from the LENA project has been merged, bringing in a

  significant redesign of the LTE module as well as many new features.

- 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.

- A new buildings module is introduced which allows to model the

  presence of buildings in a wireless network topology.  

- New propagation models (OkumuraHata, ITU-R P.1411, ITU-R P.1238)

  have been added

- The Dynamic Source Routing (DSR) MANET routing protocol for IPv4 was added.

- A Random Early Detection (RED) queue model has been added.

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

  print functions. Various minor changes were 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.

- Longer and more descriptive names are used for error units in RateErrorModel

  class and queue mode in Queue class. Attributes in those classes are also

  changed for consistency. See API documentation for details.

- The netanim animator is now bundled with the release.

Bugs fixed

----------

 - bug 603 - Simulator::Next is useless

 - bug 631 - RealtimeSimulatorImpl does not handle Ctrl-C with python bindings

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

 - bug 1000 - Make RealtimeSimulatorImpl last until stop

 - bug 1053 - Need better error diagnostics in ns2-mobility-trace example

 - bug 1109 - Point out the effects of ArpCache::PendingQueueSize

 - bug 1179 - Add LTE trace hooks for supporting visualizer

 - bug 1180 - LTE: Add TX/RX trace support

 - bug 1273 - Better error message on missing Python development files

 - bug 1282 - Sleep state and CCA

 - bug 1283 - PacketSocket::SendTo should return number of bytes 

 - bug 1302 - Flow monitor bug

 - bug 1304 - Tag information changed after transmission

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

 - bug 1318 - Asserts for IPv6 malformed packets

 - bug 1319 - Fix Ipv6RawSocketImpl Icmpv6 filter

 - bug 1325 - Python examples get valgrind errors when build subdirectories 

              are specified in waf

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

 - bug 1348 - python bindings: deprecated conversion from string constant 

              to ‘char*’

 - bug 1349 - TypeId.LookupAttributeByName Python bindings missing

 - bug 1350 - Simulator.ScheduleWithContext Python binding missing

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

 - bug 1352 - Fixed MapAttributes, previously was mapped to a vector in 

              ObjectPtrContainer and (and key information was dropped). 

              Now the container is a map.

 - bug 1354 - Building scratch subdir programs is broken

 - bug 1355 - Visualizer dependencies not detected at buildtime

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

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

              fixes to ICMPv6)

 - bug 1376 - wrong wind variable's name

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

 - bug 1379 - lte-multiple-flows example crashes

 - bug 1380 - lte-phy-uplink example crashes

 - bug 1391 - .ns3rc does not allow comments as expected

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

 - bug 1393 - IPv6 Routing Helper RT Print functions

 - bug 1395 - AODV DeferredRouteOutputTag missing constructor

 - bug 1396 - ARP with hardware addresses longer than 6 bytes

 - bug 1399 - TCP not backing off retransmissions properly

 - bug 1404 - Bound user input in tutorial third.cc program

 - bug 1406 - waf exits with maximum recursion depth exceeded 

 - bug 1415 - examples-to-run.py doesn't work with command line arguments

 - bug 1420 - no python bindings for csma-layout

 - bug 1441 - IPv4 header length handling

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