Release 2.9 (NFD 22.02)

- Update the submodule of NFD to version 22.02

    Note

    In order to retrieve the marked versions of ndn-cxx and NFD, use
    --recursive option to the git clone command or run
    git submodule update --init after clone, pull, or merge.

- Update the submodule of ndn-cxx to version 0.8.0-18-g4999b2ed

- Base NS-3 was rebased to version 3.35

- The compilation now uses the C++17 standard.

- Update uses of QueueBase::MaxSize to DropTailQueue<Packet>::MaxSize

Release 2.8

- The submodules of NFD and ndn-cxx have been upgraded to version
  0.7.0.

    NOTE: In order to retrieve the marked versions of ndn-cxx and NFD,
    use `--recursive` option to the `git clone` command or run `git submodule
    update --init` after clone, pull, or merge.

- With the underlying NFD/ndn-cxx upgrade, ndnSIM now operates with
  NDN Packet format version 0.3.

- Base NS-3 was rebased to version 3.30.1

- Add Loop-Free In-port Dependent (LFID) route calculation that
  provides a set of loop-free paths (4985)

- Fix wrong behaviour of default Size in ConsumerWindow

- Remove legacy content store implementation. Use content store
  replacement/placement policies implemented using NFD routines.

Release 2.7

Overview
^^^^^^^^

- The submodules of NFD and ndn-cxx have been upgraded to version 0.6.5.

    In order to retrieve the marked versions of ndn-cxx and NFD, use
    --recursive option to the git clone command or run
    git submodule update --init after clone, pull, or merge.

- Base NS-3 was rebased to version 3.29
- Following changes in NFD and ndn-cxx codebases, the build requirements
  have been upgraded to gcc >= 5.3 or clang >= 3.6, boost >= 1.58,
  openssl >= 1.0.2. This effectively drops support for all versions of
  Ubuntu older than 16.04 that use distribution-provided compilers and
  packages.
- The compilation now uses the C++14 standard.

Improvements and bug fixes
^^^^^^^^^^^^^^^^^^^^^^^^^^

- Update face metric based on simulated p2p link delay (4733)
- Remove and replace the previously deprecated and removed in NS-3.29
  QueueBase::MaxPackets
- Update installation instructions

Deprecation
^^^^^^^^^^^

- ndnSIM 2.7 is the last release that supports the legacy content store
  implementation. The future versions will only include content store
  replacement/placement policies implemented using NFD routines. Please
  refer to the latest version of NFD Developer's Guide for more
  information.

Release 2.6

- The submodules of NFD and ndn-cxx have been upgraded to version 0.6.2
  (4514).

  NFD 0.6.2 release notes

  ndn-cxx 0.6.2 release notes

    Note

    In order to retrieve the marked versions of ndn-cxx and NFD, use
    --recursive option to the git clone command or run
    git submodule update --init after clone, pull, or merge.

- This will be the last release that supports "old" API for content
  store implementations. Going forward, only NFD-based implementations
  will be supported.

Improvements and bug fixes

- Add queue length congestion detection and signaling (Issue #4578)

- Implement BIC and CUBIC congestion control in ConsumerPcon (Issue #4672)

- Fix compilation failure on some systems with Python 3

- Fix outdated and remove deprecated APIs in the examples

- Updates of the ndnSIM documentation.

Release 2.5

- The submodules of NFD and ndn-cxx have been upgraded to version 0.6.1
  (Issue #4514).

    NOTE: In order to retrieve the marked versions of ndn-cxx and NFD,
          use --recursive option to the git clone command or run git
          submodule update --init after clone, pull, or merge.

Improvements and bug fixes

- Fix memory leak related to canceling events scheduled via ndn-cxx's
  Scheduler interface adapted for NS-3 (Issue #4509).

- Fix compilation failure with boost >= 1.66 (Issue #4471).

- Updates of the ndnSIM documentation.

Release 2.4

- The submodules of NFD and ndn-cxx have been upgraded to version
  0.6.0 (4306).

- Upgrade the base NS-3 version to ns-3.27-22-g90fb309d5 (Issue 4311).

    NOTE: In order to retrieve the marked versions of ndn-cxx and NFD,
          use --recursive option to the git clone command or run git
          submodule update --init after clone, pull, or merge.

    NOTE: To set the maximum size of the used queue when porting
          already implemented scenarios to ndnSIM 2.4, the
          QueueBase::MaxPackets attribute has to be set instead of
          DropTailQueue::MaxPackets.

    NOTE: ndnSIM 2.4 requires the following minimal compiler
          requirements:
            - g++-4.9 or later (Note: this is an upgraded requirement
              from ndnSIM 2.3)
            - Apple LLVM version 7.0.2 or later
            - clang-3.3 or later.

Improvements and bug fixes

- Internal refactoring of dummy keychain to work with security v2 of
  ndn-cxx (Issue 4306)

- Updates of the ndnSIM documentation and Technical Report (Issues
  4039, 4213)
  - Added page about community contributions to the simulator.
  - CS tracer documentation update.

Changes since release 2.2

Release date: December 12, 2016

Overview

- The submodules of NFD and ndn-cxx have been both upgraded to version
  0.5 (Issue 3875).

  Features of NFD:

    - Adaptive SRTT-based Forwarding strategy has been added.
    - Breaking change -- Configurable policy for admission of
      unsolicited data packets into the content store have
      been introduced.
    - Introduce mechanism to update properties (e.g.,
      flags, persistency) of an existing Face.
    - Breaking change -- ForwarderStatus dataset can now be requested
      only with /localhost/nfd/status/general interest.
    - Breaking change -- Strategy API update. FIB entry is no longer
      supplied to the Strategy::afterReceiveInterest method (i.e., FIB
      lookup is not performed by the forwarding pipelines). When
      necessary, a strategy can request FIB lookup
      using Strategy::lookupFib.
    - Refactor implementation of RIB Manager to make it uniform with
      other managers.

  Features of ndn-cxx:

    - New transformation API.
    - Introduce Name::deepCopy to allow memory optimizations when
      working with Name objects.
    - New ndn::security::CommandInterestValidator class.
    - New FaceUpdateCommand structure for NFD management protocols.
    - Breaking change - Expose ControlResponse as part
      of Controller::CommandFailCallback.
    - Breaking change - Change security constants to corresponding
      strongly typed enumerations.

    In order to retrieve the marked versions of ndn-cxx and NFD, use
    --recursive option to the git clone command or run
    git submodule update --init after clone, pull, or merge.

- Replace NetDeviceFaceLinkService with NetDeviceTransport to add full
  support of NDNLPv2 and, thus, network-layer NACK handling to
  ndnSIM (Issue 3871).

  ndnSIM now uses an implementation of nfd::face::Transport that enables
  the full support of NDNLPv2 and the handling of network-layer NACKs
  generated by NFD. NACKs can reach the ndnSIM applications.

  NACK handling by ndnSIM came at the cost of losing the NS3 related
  packet tags. The hopCount tag is now implemented as a tag of a packet
  directly at the NDNLPv2 layer.

New features

- Enable NACK tracing by the network layer tracers (Issue 3872).
- NetworkRegionTable helper was added to allow the configuration of the
  simulated nodes' NetworkRegionTable (Issue 3806).

Improvements and bug fixes

- Internal refactoring to use the ndnSIM-specific transport
  implementation (ndn::L3Protocol, ndn::StackHelper,
  ndn::LinkControlHelper, ndn::GlobalRoutingHelper,
  ndn::Consumer, ndn::Producer).
- Updates of the ndnSIM documentation (Issue 3876)
  - Added explanation about the support of NDNLPv2 and its implications.

Changes since release 2.1

Release date: November 11, 2016

OVERVIEW

- The submodules of NFD and ndn-cxx have been both upgraded to version
  0.4.1 (Issue 3560).

  Features of NFD:

  - Face system is refactored.
  - Data Retrieval using full names is fixed.
  - Allow setting CS capacity to 0.
  - LinkService provides an "adaptation" layer to translate
    between NDN packets and data blocks communicated
    through Transport.
  - Face provides combines Transport and LinkServices, providing
    high-level interface to work with Interest/Data/Nack packets
    inside NFD.
  - Networking NACK in pipelines and best-route strategy.
  - Refactored implementation of NFD management.
  - Interest forwarding processes Link included in
    interest packets.

  Features of ndn-cxx:

  - LocalControlHeader for special signaling between application
    and NFD has been replaced with NDNLPv2 signaling.
  - NDNLPv2 Network NACK support in Face abstraction.
  - New API in Face class to remove all pending Interests.

  In order to retrieve the marked versions of ndn-cxx and NFD, use
  --recursive option to the git clone command or run
  git submodule update --init after clone, pull, or merge.

- Replace NetDeviceFace with NetDeviceFaceLinkService and AppFace with
  AppFaceModel to match NFD's v0.4+ Face model (Issue 3560).

  ndnSIM (for now) intentionally uses LinkService instead of Transport
  for optimization purposes and in order to preserve ns3::Packet Tags.
  This may be fixed in the future when there is a different mechanism
  to propagate ns3 Tags.

  This version of dnSIM does not include support for NDNLPv2 and,
  thus, cannot yet be used to simulate network-level NACKs across the
  simulated nodes. This will be addressed in the next release
  of ndnSIM.

- ndnSIM no longer officially support Ubuntu Linux 12.04, as it now
  requires a more modern compiler version and dependent libraries.

NEW FEATURES

- The NetDevice address is now represented as a LocalUri instance for
  NetDevice-based Faces (Issue 2665).
- Enable configurability of NFD's managers (Issue 3328).

  The managers of NFD can be enabled/disabled as specified in a
  simulation scenario.

IMPROVEMENTS AND BUG FIXES

- Bugfix in RandomPolicy for the "old-style"
  ContentStore implementation.
- Updates of the ndnSIM 2 Technical Report

  Technical Report became up-to-date with the latest version of
  ndnSIM. Please see report's change-log for more
  detailed information.

- Updates of the ndnSIM documentation (Issue 3835)
  - Updated out-dated statements about NFD's CS
    implementation (Issue 3827).
  - Added explanation about the limited support of NDNLPv2 and
    its implications.
  - Fixed description of the ConsumerBatches application.
  - Added homebrew instructions for dependency installation on OS X.
  - Added specification of ndn::CsTracer output format.

Changes since release 2.0

Release date: September 4, 2015

Overview

- Integration with ndn-cxx and NFD codebases has been refactored to
  include ndn-cxx and NFD repositories as git submodules within ndnSIM
  repository (Issue 3138).

- The official home for ndnSIM codebase has been moved to GitHub
  named-data-ndnSIM organization (Issue 3123).

- Modified version of NS-3 was updated to (rebased on top of) version
  3.23-dev, with ndnSIM codebase adjusted to reflect API
  changes (Issue 3122)

- NFD and ndn-cxx has been upgraded to version 0.3.4 (Issue 3125)

New features

- ndnSIM-specific version of ndn::Face (Issue 2370)

  The updated version of ndn::Face specially designed to allow writing
  simulation applications in the same way as real applications. It is
  also possible to directly use codebase of the existing applications
  to drive simulations, provided that the codebase meets or can be
  adjusted to meet the requirements listed
  in guide-to-simulate-real-apps.

- Full support for NFD'S RIB manager (Issue 2370)

- Tutorial and example on how to speed up simulations with MPI module
  of NS-3.

- Two new helpers to simplify writing basic simulation scenarios:
  * ScenarioHelper leverages C++11 constructs to write scenarios
  * FactoryCallbackApp simplifies creation of basic apps without
    creating a separate class that is derived from ns3::Applications.

Improvements and bug fixes

- Updates of ndnSIM documentation
  * Updated the structure for the ndnSIM website index page
  * Updated installation instructions to reflect refactoring and
    relocation of ndnSIM codebase
  * API documentation (doxygen) improvements
  * Updated list of ndnSIM research papers

- The NDN stack can now be updated to handle any simulation topology
  changes after its initial installation on a node (Issue 2717)

- Application ID that appears in ndn::AppDelayTracer output is now ID
  of the application on the node, not ID of the application face that
  was used previously.

- FibHelper has been extended to support route removals (Issue 2358)

- ndnSIM codebase now partially covered with unit-tests (Issues 2369,
  3059, 2783)

- Bugfixes:
  * In ndn::GlobalRoutingHelper::CalculateAllPossibleRoutes that
    caused crash in some cases (Issue 2535)
  * In FailLink and Uplink methods of ndn::LinkControlHelper class
    that affected more links than requested (Issue 2783)
  * With hop count of data packets retrieved from the Contest Store
    of NFD (Issue 2764)
  * In ndn::Producer application that caused a wrong dummy signature
    to be added to the constructed data packets (Issue 2927)

Release 2.0

Overview

ndnSIM 2.0 is a new release of NS-3 based Named Data Networking (NDN)
simulator that went through extensive refactoring and rewriting. The key
new features of the new version:

-   ndnSIM no longer re-implements basic NDN primitives and directly
    uses implementation from ndn-cxx library (NDN C++ library with
    eXperimental eXtensions).

-   All NDN forwarding and management is implemented directly using
    source code of Named Data Networking Forwarding Daemon (NFD). The
    current code is based on a22a217
    commit of NFD repository.

Note RIB Manager is not yet available in ndnSIM.

-   Packet format changed to the NDN packet format.

-   Code style changes to conform to ndn-cxx Code Style and Coding
    Guidelines This change also includes renaming of the header and
    source files: *.h -> *.hpp, *.cc -> *.cpp

-   ndnSIM now uses C++11.

New Features

-   Integration with NFD codebase:
-   A realistic behavior is added to the simulations.
-   Forwarding plane extensions can be used in both ndnSIM simulations
    and real NFD deployment.
-   Per namespace forwarding strategies for different namespaces (one
    strategy per namespace).
-   New examples:
-   ndn-load-balancer
-   ndn-grid-multiple-strategies
-   ndn-different-strategy-per-prefix
-   Basic examples using python bindings: ndn-simple.py and ndn-grid.py
-   Use of the the full-featured NDN packet format.
-   Full-featured support for Interest selectors.
-   Full-featured crypto operations can be simulated (disabled by
    default).
-   FibHelper to manage FIB entries.
-   StrategyChoiceHelper to manage per-namespace forwarding strategy
    selection.

Changes

-   HopCount tracing now includes only one way network-level hop count
    (e.g., the number of physical links traversed by a packet).
    Previously, this tracing was round-trip and included applications
    hops.
-   Python bindings have changed and, due to limitations of pybindgen,
    currently cover a smaller subset of C++ code (Task #2341).
-   LinkControlHelper now uses ErrorRate to simulate link
    failure/recovery. Previously it was relying on Up/Down flag on NDN
    level.
-   The Face abstraction of NFD is now used.

Bug fixes

-   Fix processing files with customized LossRate or Queue model in
    AnnotatedTopologyReader Bug #2354.

Removals

-   PyNDN emulation
-   (temporarily) ApiFace. Will be replaced with emulation of ndn-cxx
    ndn::Face in future releases (Issue #2370).
-   (temporarily) UdpFace, TcpFace (Issue #2371).
-   Limits, LimitsWindow, LimitsRate.
-   PIT, FIB with "replacement" policies.
-   Old deprecated packet formats.