Difference between revisions of "Windows Port of ns-3 using Visual Studio"

From Nsnam
Jump to: navigation, search
(Software download)
(update old windows page)
 
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:
A project to extend NS3 functionality on Windows operating-systems
+
'''Note:  This page is dated and kept only for historical reference; it has been replaced by [[Ns-3_on_Visual_Studio_2012 | ns-3 on Visual Studio 2012]].'''
  
Please take one minute to fill our poll (2 questions) on ns-3 on Windows usage
+
A project to extend NS3 functionality on Windows operating-systems (Specifically Visual Studio integration)
[https://spreadsheets.google.com/viewform?formkey=dGJtZ3lQNHdHbXEydVBCMVByYmZPb1E6MQ poll]
+
 
+
'''Note:''' Currently the development support for this project is limited; there hasn't been any commitment from the ns-3 project as a whole to maintain this version of ns-3.  So expect bugs and delayed response to queries.
+
Please use this [http://groups.google.com/group/ns3-on-windows google-group] for queries and feedback.
+
  
 
= Project Goals =
 
= Project Goals =
Line 15: Line 11:
 
= Development Plan =
 
= Development Plan =
 
# Feasibility study and pilot implementation
 
# Feasibility study and pilot implementation
# After the final commit from the [http://www.nsnam.org/wiki/index.php/App_Store_Technical_Requirements NS3 Modularization project] finalize folder structure and module list
+
# After the final commit from the [[App Store Technical Requirements|ns-3 modularization project]] finalize folder structure and module list
 
# Review and commit changes for Windows onto ns-3.11
 
# Review and commit changes for Windows onto ns-3.11
 
# Review copyrights,coding-style and documentation
 
# Review copyrights,coding-style and documentation
Line 22: Line 18:
 
= Current status =
 
= Current status =
 
# The feasibility study was done .An unstable implementation built on ns-3.10 is available at [[#Software download]] (OBSOLETE)
 
# The feasibility study was done .An unstable implementation built on ns-3.10 is available at [[#Software download]] (OBSOLETE)
# After the [http://www.nsnam.org/wiki/index.php/App_Store_Technical_Requirements NS3 Modularization projecta new unstable version is available, built on the ns-3-dev lineup
+
# After the ns-3 modularization project a new unstable version is available, built on the ns-3-dev lineup
  
 
= Software download =
 
= Software download =
* Version (ns-3-Win2.0) Alpha version built on ns-3-dev(dated 05/23/2011)
+
* Version (ns-3-Win2.0) built on ns-3-dev(dated 05/23/2011)
Download via []
+
Download via mercurial: "hg clone http://code.nsnam.org/jabraham3/ns-3-win"
  
 
Changelog & Caveats:
 
Changelog & Caveats:
 +
 +
# The ~30 modules of ns-3 can be built independently as projects within the master solution, saving time
 +
# Instead of building all the examples within the solution, I have provided a facility to run only one example at a time.This is due to the fact that I wanted to reduce the changes required and considering the fact any user deals with 1 or 2 examples at most at any given time. (A Visual Studio solution provides only executable at any point)
 +
# The project files will need to be downloaded via "mercurial"
 +
# Optional features such as click,mpi,openflow can be built, however I have made these project files dormant. It is left to the end-user to enable them and point to the required include libraries to run its examples. I might provide instructions later on how to handle the optional features as time permits
 +
# Any windows-based solution is always going to be a subset of the main ns-3 project and will have a reduced feature-set.
 +
# This version is built on ns-3-dev rather than ns-3.10.
 +
# The GUI MFC code is removed, as I prefer to maintain it separately.
 +
 
The following are some of the missing features  
 
The following are some of the missing features  
 
(some are excluded currently due to lack of time in porting them,some because they depend on third-party s/w  
 
(some are excluded currently due to lack of time in porting them,some because they depend on third-party s/w  
 
and some can never be supported for windows)
 
and some can never be supported for windows)
  
1. waf,Python-binding,Visualizer (portable). Visual studio solution does not require waf at this point.
+
# waf,Python-binding,Visualizer (portable). Note:Visual studio solution does not require waf at this point.
2. watchdog.cc,wall-clock-synchronizer.cc,unix-system-wall-clock-ms.cc,unix-system-thread.cc,unix-system-condition.cc,unix-fd-reader.cc
+
# watchdog.cc,wall-clock-synchronizer.cc,unix-system-wall-clock-ms.cc,unix-system-thread.cc,unix-system-condition.cc,unix-fd-reader.cc,int64x64-cairo.cc,int64x64-128.cc (can be sort of ported)
int64x64-cairo.cc,int64x64-128.cc (can be sort of ported)
+
# config-store (portable)
3. config-store (portable)
+
# All NSC code (non-portable)
4. All NSC code (non-portable)
+
# SQL dependent code (portable)
5. SQL dependent code (portable)
+
# rocketfuel-topology-reader.cc (portable)
6. rocketfuel-topology-reader.cc (portable)
+
# Real-time simulator (????)
7. Real-time simulator (????)
+
# lte-multiple-flows.cc (portable)
8. lte-multiple-flows.cc (portable)
+
# main-test-sync.cc (portable)
9. main-test-sync.cc (portable)
+
# nms-p2p-* files (portable)
10. nms-p2p-* files (portable)
+
  
  
Line 105: Line 109:
  
 
= Installation & Usage =
 
= Installation & Usage =
Follow instructions at [[Installation & Usage]]
+
Follow instructions at [[Windows Port of ns-3 using Visual Studio Installation and Usage]]

Latest revision as of 14:08, 28 July 2015

Note: This page is dated and kept only for historical reference; it has been replaced by ns-3 on Visual Studio 2012.

A project to extend NS3 functionality on Windows operating-systems (Specifically Visual Studio integration)

Project Goals

  1. To reduce or eliminate the need for CygWin to run NS3 on Windows operating-systems
  2. To expose native Windows API to NS3 developers
  3. To integrate NS3 into IDE's such as Visual Studio 2010
  4. To integrate NS3 into IDE's such as Visual Studio 2008 (Stretch Goal)

Development Plan

  1. Feasibility study and pilot implementation
  2. After the final commit from the ns-3 modularization project finalize folder structure and module list
  3. Review and commit changes for Windows onto ns-3.11
  4. Review copyrights,coding-style and documentation
  5. Build automated build framework

Current status

  1. The feasibility study was done .An unstable implementation built on ns-3.10 is available at #Software download (OBSOLETE)
  2. After the ns-3 modularization project a new unstable version is available, built on the ns-3-dev lineup

Software download

  • Version (ns-3-Win2.0) built on ns-3-dev(dated 05/23/2011)

Download via mercurial: "hg clone http://code.nsnam.org/jabraham3/ns-3-win"

Changelog & Caveats:

  1. The ~30 modules of ns-3 can be built independently as projects within the master solution, saving time
  2. Instead of building all the examples within the solution, I have provided a facility to run only one example at a time.This is due to the fact that I wanted to reduce the changes required and considering the fact any user deals with 1 or 2 examples at most at any given time. (A Visual Studio solution provides only executable at any point)
  3. The project files will need to be downloaded via "mercurial"
  4. Optional features such as click,mpi,openflow can be built, however I have made these project files dormant. It is left to the end-user to enable them and point to the required include libraries to run its examples. I might provide instructions later on how to handle the optional features as time permits
  5. Any windows-based solution is always going to be a subset of the main ns-3 project and will have a reduced feature-set.
  6. This version is built on ns-3-dev rather than ns-3.10.
  7. The GUI MFC code is removed, as I prefer to maintain it separately.

The following are some of the missing features (some are excluded currently due to lack of time in porting them,some because they depend on third-party s/w and some can never be supported for windows)

  1. waf,Python-binding,Visualizer (portable). Note:Visual studio solution does not require waf at this point.
  2. watchdog.cc,wall-clock-synchronizer.cc,unix-system-wall-clock-ms.cc,unix-system-thread.cc,unix-system-condition.cc,unix-fd-reader.cc,int64x64-cairo.cc,int64x64-128.cc (can be sort of ported)
  3. config-store (portable)
  4. All NSC code (non-portable)
  5. SQL dependent code (portable)
  6. rocketfuel-topology-reader.cc (portable)
  7. Real-time simulator (????)
  8. lte-multiple-flows.cc (portable)
  9. main-test-sync.cc (portable)
  10. nms-p2p-* files (portable)


  • Version (ns-3.10-Win-1.3) Alpha version built on ns-3-dev(dated 02/07/2011)

Download from here

Changelog & Caveats:

  1. This version caters to "Distributed simulation/MPI".
  2. A separate Visual Studio 2010 Solution file "ns-3-dev-MPI.sln" is provided in addition to the default "ns-3-dev.sln",
  3. "ns-3-dev-MPI.sln" is required to build "ns-dev" static libraries with MPI/Distributed simulation related code available.
  4. The MPI-related examples have an associated Makefile, to help build them.
  5. Distributed simulation is run with the aid of "Open MPI". As Open MPI's "mpirun" utility requires a console application, distributed-simulation needs to be a console app (i.e Windows GUI components won't be available).
  6. nms* examples are not included as they use "variable-length arrays" with are C99 features not supported on Visual C++.These examples might be made available in a future version.

Please visit the #Installation & Usage page for more details


  • Version (ns-3.10-Win-1.2) Alpha version built on ns-3-dev(dated 02/07/2011)

Download from here

Download NetAnim for Windows from here

Changelog & Caveats:

  1. Examples under Animation are enabled
  2. A Windows port of NetAnim
  3. Possible memory-leak if "Stop" button is pressed before Simulation ends (Need a way to gracefully shutdown simulator in future versions).


  • Version (ns-3.10-Win-1.1) Pilot/Limited feature/Alpha version built on ns-3-dev(dated 02/07/2011)

Download from here

Changelog & Caveats:

  1. More examples have been enabled,including wireless and wimax.However, the following examples are still excluded:
    • examples/matrix-topology
    • examples/mpi
    • examples/realtime
    • examples/tap
    • examples/topology-read
    • examples/emulation
  2. Missing code from Core simulator:
    • tools
    • test
    • mpi
    • cairo high-precision
    • any animation related code
    • tap-bridge
    • emulation
    • NSC
    • realtime
    • utils
    • python bindings
    • unix* and wall-clock-synchronization
    • matrix topology reader
    • buffer-test.cc
  3. This version contains a port of gsl_erfc from GSL 1.14, as Visual Studio does not provide erfc in the standard math libraries. The erfc(x) port has been tested for x ranging from 0 to 3.5
  4. Most of the contrib code is now included, except for code such as xml-config,config-store,sqlite*,gtk dependent code etc.
  5. High-precision cairo is not yet ported.
  6. OLSR model and helper are included, but olsr\test and olsr\examples are excluded as high-precision cairo is still not ported.
  7. This version fixes a major buffer-security bug in the first version (this is not related to the ns3 code).
  8. There should be zero linker errors & zero linker warnings in this version.

Installation & Usage

Follow instructions at Windows Port of ns-3 using Visual Studio Installation and Usage