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

===========

Availability

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

This release is available from: 

http://www.nsnam.org/releases/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/releases/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. 

Bugs fixed

----------

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

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

   - bug 824 - TCP should implement FastRecovery by default

   - bug 852 - Add support for 802.11g devices

   - bug 892 - WaypointMobilityModel incompatible with MobilityHelper::Install

   - bug 893 - Lazy CourseChange notification for WaypointMobilityModel

   - bug 903 - TapBridge does not shut down properly

   - bug 953 - WiMAX channel scanning overflow

   - bug 967 - Need to decouple Ipv4L4Protocols from Ipv4L3Protocol

   - bug 978 - Consolidate Wi-Fi MAC high functionality

   - bug 979 - Multi-octet fields in Wi-Fi headers have wrong endianness

   - bug 981 - use a cache to keep track of received MPDUs under block ack

   - bug 983 - handle correctly ADDBA response action frames in QadhocWifiMac

   - bug 984 - EmuNetDevice should use DIX encapsulation by default

   - bug 985 - WiMAX Invalid management message type on wimax-simple

   - bug 988 - MacRxMiddle::SequenceControlSmaller method

   - bug 990 - Error with an NS_ASSERT at uan-phy-gen.cc

   - bug 991 - InterferenceHelper assertion failure

   - bug 992 - Unusual (possibly incorrect assertion) in Packet::Deserialize

   - bug 993 - MinstrelWifiManager::UpdateStats useless if clause

   - bug 994 - PointToPointGridHelper useless if clauses

   - bug 995 - Useless (possibly incorrect) comparison of unsigned int

   - bug 1004 - module header not rebuilt

   - bug 1005 - GetSocket() methods for OnOffApplication and PacketSink

   - bug 1009 - decouple m_finSequence (TcpSocketImpl) from tx sequence numbers

   - bug 1012 - UAN Throp propagation model bug

   - bug 1015 - GetChannelFrequencyMhz() does not match with standard

   - bug 1022 - inappropriate ASSERT in tcp-socket-impl.cc

   - bug 1025 - wimax-ipv4 script exists with signal SIGSEGV when nbSS>20

   - bug 1027 - RocketfuelTopologyReader is not working at all

   - bug 1029 - v4Ping application endian issues

   - bug 1030 - routing/aodv example fixed

   - bug 1031 - Wifi hidden terminal example does not work

   - bug 1032 - Unable to specify multiple Compiler/Linker flags

Known issues

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

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

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

Windows XP 32 bit Cygwin 1.7.7 does not seem to work because of a

problem (reported elsewhere) in linking large libraries.

Release 3.9

===========

Availability

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

This release is immediately available from:

http://www.nsnam.org/releases/ns-allinone-3.9.tar.bz2

Supported platforms

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

ns-3.9 has been tested on the following platforms:

- Ubuntu 10.04 LTS 32/64-bit gcc-4.4.3

- Fedora Core 12 64-bit gcc-4.4.3

- Ubuntu 9.10 32-bit gcc-4.4.1

- Ubuntu 8.04 LTS 64-bit gcc-4.2.4

- Fedora Core 5 32-bit gcc-4.1.1

- Mac OS X Leopard powerpc gcc-4.0.1

- Windows Cygwin 1.7.5

Not all ns-3 options are available on all platforms; consult the

wiki for more information:

http://www.nsnam.org/wiki/index.php/Installation

New user-visible features

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

   - A reorganisation of the construction of Wi-Fi transmit rates has

     been undertaken with the aim of simplifying the task of

     supporting further IEEE 802.11 PHYs. This work has been completed

     under the auspices of Bug 871. A consequence of this work is that

     WifiModes have a new (hopefully future-proof) naming, and

     simulations which specify rates by name will need updating. The

     list of new rate names is given in the error message produced

     when an attempt is made to use any invalid rate name (including

     those that were previously valid).

   - A new OFDM error rate model for WiFi (NistErrorRateModel); this model

     has been validated in clear-channel testbed tests.  For 802.11b, it

     uses the same underlying model as the YansErrorRateModel, but it differs

     from YansErrorRateModel for OFDM modes (802.11a/g).  The default

     YansWifiPhyHelper has been changed to use this model.

   - A new NS-2 mobility trace reader supports BonnMotion, SUMO, TraNS, 

     etc. traces.

   - An energy model for nodes and devices, including an energy source

     model and device energy models allowing energy-aware devices

     to notify the energy source about energy consumption.  

   - Rocketfuel topology dataset support for existing topology reader

     Rocketfuel project: 

     http://www.cs.washington.edu/research/networking/rocketfuel/

   - Underwater Acoustic Network (UAN) model, split in to three parts, the 

     channel, PHY, and MAC models to enable researchers to model a variety 

     of underwater network scenarios.

   - the Spectrum framework, which provides support for spectrum-aware

     Channel and PHY layer modeling. It features a set of classes that

     allows the mathematical representation of frequency dependent

     phenomena. Some example channel, propagation and device

     implementations that make use of this framework are also

     included.  

Bugs fixed

----------

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

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

   - IPv4 global routing code; stub networks were assumed to be /24

     and added as /24 networks even if the mask is actually different

   - OLSR was generating messages on non-OLSR interfaces

   - ICMPv4 objects not properly registered; affected serialization code

   - bug 231 - SocketAddressTag needs to be removed from a packet before 

               forwarding the packet to the user

   - bug 385 - Add a generic "sequence number" class

   - bug 473 - [PATCH] Alternative ns-2 trace reader

   - bug 665 - Need Tutorial Sectino on Config Path and Tracing Use

   - bug 671 - add packet-info-tag.cc for IP_PKTINFO/IPV6_PKTINFO

   - bug 702 - Global routing doesn't respond to interface events

   - bug 799 - Interference helper is too slow

   - bug 800 - Erroneous packet sender while using aloha or cw mac in uan module

   - bug 802 - Minstrel algorithm causes segmentation fault

   - bug 826 - Using uint64_t instead of Time in DcfManager

   - bug 828 - PacketSocket::Close does not unregister protocol handler

   - bug 842 - ns-3-dev crashes using block acks

   - bug 843 - Most wifi examples change BeaconInterval to unrealistic values

   - bug 844 - YansWifiPhy::GetPowerDbm off-by-one problem when calculating Tx 

               power

   - bug 846 - packet.cc triggers deprecated warning

   - bug 853 - Rates for Wi-Fi control responses are incorrectly selected

   - bug 854 - Support DROP_QUEUE reason-code in Ipv4FlowProbe

   - bug 858 - support MSG_PEEK in IPv4/IPv6 raw socket

   - bug 861 - Forwarding drops (due to no route found) were not being logged 

               in IPv4 or IPv6 ascii traces

   - bug 869 - suggested test framework enhancements

   - bug 871 - naming for WifiPhyStandard

   - bug 873 - Queue occupancy counter not decremented in WifiMacQueue::Remove()

   - bug 874 - wrong modulation type is selected in the forwardBurst method

   - bug 875 - "frame includes FCS" flag should be set in Radiotap frame header

   - bug 879 - source address selection for AODV using DeferredRouteRequest

   - bug 881 - Reorganise to allow wider use of WifiInformationElement

   - bug 890 - several rate adaptation algorithms not tested by test.py

   - bug 900:  RawTextConfigLoad::Default does not load configurations

   - bug 901 - Optimize Mac48Address < != and ==

   - bug 902 - TCP: handle out-of-order packets during connection shutdown

   - bug 905 - WimaxNetDevice loses packet uid, tags, and memory optimization

   - bug 906 - NSC TCP socket fork did not copy txbuffersize over

   - bug 908 - test.py should exit if waf dies

   - bug 910 - Change Wi-Fi "AccessClass" to something closer to the standard

   - bug 911 - IPv4/v6 multicast forwarding not going to all output interfaces

   - bug 913 - Queue Enqueue/Drop trace sources behavior unintuitive

   - bug 916 - EnableAsciiAll ("prefix") does not work for YansWifiPhyHelper

   - bug 918 - samples/main-packet-header.cc is broken

   - bug 919 - minstrel does not pass valgrind tests

   - bug 921 - Inconsistent declaration of class/struct Object in object.h

   - bug 922 - Inconsistent declaration of class/struct in 

               wifi-remote-station-manager.h

   - bug 923 - Inconsistent declaration of class/struct in mac-low.h

   - bug 924 - Inconsistent declaration of class/struct in <xxx>-wifi-managers 

   - bug 925 - Various IPv6 cc files trigger deprecated warning

   - bug 926 - olsr handling of multicast packets 

   - bug 927 - SimpleOfdmWimaxChannel RxPower computation

   - bug 930 - examples/topology-read/topology-example-sim.cc uses variable 

               length array

   - bug 931 - Abnormal exit reports SIGSEGV on failure

   - bug 932 - Support IP_HDRINCL option for Ipv4RawSocket

   - bug 933 - Flushing ostream and files on abnormal program exit 

               (ASSERT, ABORT and FATAL_ERROR)

   - bug 936 - Waf build error for python bindings on "AccessClass"

   - bug 937 - bugs in ns-3 wimax

   - bug 939 - EmuNetDevice uses too much memory when reading packet bursts

   - bug 940 - AODV fails to set up a correct path

   - bug 941 - Wifi Dcf attributes not reachable through configuration namespace

   - bug 943 - Add a SO_BROADCAST socket option

   - bug 944 - change default ErrorRateModel from YansErrorRateModel to 

               NistErrorRateModel

   - bug 946 - Rocketfuel topology dataset support for topology reader

   - bug 949 - Node::NonPromiscReceiveFromDevice reports a meaningless 

               destination address to user callbacks 

   - bug 950 - PointToPointNetDevice says promisc support is not implemented 

               but it is

   - bug 955 - Install NSC for NS3 in a Itanium Architecture (ia64) with Linux 2.6.16.6

   - bug 956 - Bindings failure in core (traced-value) with older gcc

   - bug 958 - WiFi uses wrong default values for MTU, FragmentationThreshold 

               and RtsCtsThreshold

   - bug 959 - Simulation never finishes when using RealtimeSimulatorImpl

   - bug 960 - V4Ping does not generate checksum