Forked from gtgnan/wifiTwt; for more information read the original README below.
We enhance their implementation for specific use cases.
Main script: scratch/videoTest.cc.
A small, warm-up packet is sent at 3s into the simulation, to establish ARP negotiation. The video traffic starts at ~10s, so we consider the first 10s of the simulation as a warm-up period.
Example runs: run_poisson.sh, run_weibull.sh.
Additions:
- application that can generate traffic in packet batches following a Weibull distribution, at exponential inter-arrival times:
src/applications/model/weibull-exp-application.cc - application that can generate traffic in individual packet arrivals following a Poisson process:
src/applications/model/poisson-application.cc - UDP support
- downlink traffic support
- queue state trackers
- more parameter customization; refer to the
videoTest.ccCommandLine parser
- About This Repo
- Video and VoIP Traffic Models
- Simulation results with TWT
- Overview
- Building ns-3
- Testing ns-3
- Running ns-3
- ns-3 Documentation
- Working with the Development Version of ns-3
- Contributing to ns-3
- Reporting Issues
- ns-3 App Store
NOTE: This README is meant for a custom implementation of ns-3 by Shyam K Venkateswaran (shyam1@gatech.edu, vshyamkrishnan@gmail.com) from the GNAN research lab at Georgia Tech.
NOTE: Much more substantial information about ns-3 can be found at https://www.nsnam.org
This repository is an implementation of the Target Wake Time (TWT) feature from IEEE 802.11ax with the ns-3 wifi module. The repository also contains implementations of video streaming and VoIP traffic generators. Currently, TWT features are being ported from an earlier implementation that was done in an older ns-3 release.
Following TWT features are implemented in this repository:
- Individual implicit unannounced non Trigger based TWT agreements for nodes with a single link
- Support for multiple TWT flows per node pair
- PHY state maintenance with active TWT agreements (SLEEP states properly maintained)
Following features are yet to be ported from the previous implementation:
- TWT management frame exchanges
- Beacon reception at stations with active TWT agreements
- Trigger based TWT agreements
- Multi User scheduler for TWT stations
- Station initiated TWT agreements
Following TWT features are yet to be implemented:
- TWT teardown mechanism
- Explicit TWT agreements
- Broadcast TWT agreements
- Announced TWT agreements
- Support for Multi link devices
To simulate real-world application traffic, we introduce a Voice over Internet Protocol (VoIP) traffic model and a video streaming traffic model chosen from the evaluation methodology proposed by the 802.11 task group. The applications are named voip-application and video-application respectively. Helper functions to instantiate the traffic-generating applications and to configure relevant parameters are provided. We also provide example simulation scripts (voip-example.cc and video-example.cc) to demonstrate both the traffic generators. Appropriate traffic parameters can be configured in both examples.
This repository contains the simulation scripts, shell scripts to run the simulations with different configurations, the raw results, and the scripts to plot the results. In all simulations, the first 10 seconds are used for setup and will not be considered for metrics. The details for different scenarios are described below.
- This simulation script can be found in scratch/wns3DutyCycle.cc
- The shell script to run the simulation with different configurations for 100 trials per configuration can be found in wns3DutyCycleScript.sh
- The raw results for the simulation can be found in logs/wns3DutyCycleResults.log
- The Jupyter notebook to process the raw results and generate plots can be found in logs/wns3DutyCyclePlotting.ipynb
This simulation scenario consists of a single STA in a WiFi 6 BSS. The STA offers uplink video traffic at configured video quality. Using implicit individual non Trigger Based TWT, the duty cycle of the STA is varied.
- This simulation script can be found in scratch/wns3VaryLoad.cc
- The shell script to run the simulation with different configurations for 100 trials per configuration can be found in wns3VaryLoadScript.sh
- The raw results for the simulation can be found in logs/wns3VaryLoadResults.log
- The Jupyter notebook to process the raw results and generate plots can be found in logs/wns3VaryLoadPlotting.ipynb
This simulation scenario consists of a configurable number of STAs in a WiFi 6 BSS. The number of STAs is varied from 4 to 32 in steps of 4. The STAs offers uplink video traffic at configured video quality. Four scenarios are evaluated: Continuously Active Mode (CAM) and three different dedicated TWT schedules
ns-3 is a free open source project aiming to build a discrete-event network simulator targeted for simulation research and education. This is a collaborative project; we hope that the missing pieces of the models we have not yet implemented will be contributed by the community in an open collaboration process. If you would like to contribute to ns-3, please check the Contributing to ns-3 section below.
This README excerpts some details from a more extensive tutorial that is maintained at: https://www.nsnam.org/documentation/latest/
The code for the framework and the default models provided by ns-3 is built as a set of libraries. User simulations are expected to be written as simple programs that make use of these ns-3 libraries.
To build the set of default libraries and the example
programs included in this package, you need to use the
ns3 tool. This tool provides a Waf-like API to the
underlying CMake build manager.
Detailed information on how to use ns3 is included in the
quick start guide.
Before building ns-3, you must configure it. This step allows the configuration of the build options, such as whether to enable the examples, tests and more.
To configure ns-3 with examples and tests enabled, run the following command on the ns-3 main directory:
./ns3 configure --enable-examples --enable-testsThen, build ns-3 by running the following command:
./ns3 buildBy default, the build artifacts will be stored in the build/ directory.
The current codebase is expected to build and run on the set of platforms listed in the release notes file.
Other platforms may or may not work: we welcome patches to improve the portability of the code to these other platforms.
ns-3 contains test suites to validate the models and detect regressions. To run the test suite, run the following command on the ns-3 main directory:
./test.pyMore information about ns-3 tests is available in the test framework section of the manual.
On recent Linux systems, once you have built ns-3 (with examples enabled), it should be easy to run the sample programs with the following command, such as:
./ns3 run simple-global-routingThat program should generate a simple-global-routing.tr text
trace file and a set of simple-global-routing-xx-xx.pcap binary
PCAP trace files, which can be read by tcpdump -n -tt -r filename.pcap.
The program source can be found in the examples/routing directory.
If you do not plan to modify ns-3 upstream modules, you can get a pre-built version of the ns-3 python bindings.
pip install --user ns3If you do not have pip, check their documents
on how to install it.
After installing the ns3 package, you can then create your simulation python script.
Below is a trivial demo script to get you started.
from ns import ns
ns.LogComponentEnable("Simulator", ns.LOG_LEVEL_ALL)
ns.Simulator.Stop(ns.Seconds(10))
ns.Simulator.Run()
ns.Simulator.Destroy()The simulation will take a while to start, while the bindings are loaded. The script above will print the logging messages for the called commands.
Use help(ns) to check the prototypes for all functions defined in the
ns3 namespace. To get more useful results, query specific classes of
interest and their functions e.g., help(ns.Simulator).
Smart pointers Ptr<> can be differentiated from objects by checking if
__deref__ is listed in dir(variable). To dereference the pointer,
use variable.__deref__().
Most ns-3 simulations are written in C++ and the documentation is
oriented towards C++ users. The ns-3 tutorial programs (first.cc,
second.cc, etc.) have Python equivalents, if you are looking for
some initial guidance on how to use the Python API. The Python
API may not be as full-featured as the C++ API, and an API guide
for what C++ APIs are supported or not from Python do not currently exist.
The project is looking for additional Python maintainers to improve
the support for future Python users.
Once you have verified that your build of ns-3 works by running
the simple-global-routing example as outlined in the running ns-3
section, it is quite likely that you will want to get started on reading
some ns-3 documentation.
All of that documentation should always be available from the ns-3 website: https://www.nsnam.org/documentation/.
This documentation includes:
- a tutorial
- a reference manual
- models in the ns-3 model library
- a wiki for user-contributed tips: https://www.nsnam.org/wiki/
- API documentation generated using doxygen: this is a reference manual, most likely not very well suited as introductory text: https://www.nsnam.org/doxygen/index.html
If you want to download and use the development version of ns-3, you
need to use the tool git. A quick and dirty cheat sheet is included
in the manual, but reading through the Git
tutorials found in the Internet is usually a good idea if you are not
familiar with it.
If you have successfully installed Git, you can get a copy of the development version with the following command:
git clone https://gitlab.com/nsnam/ns-3-dev.gitHowever, we recommend to follow the GitLab guidelines for starters, that includes creating a GitLab account, forking the ns-3-dev project under the new account's name, and then cloning the forked repository. You can find more information in the manual.
The process of contributing to the ns-3 project varies with the people involved, the amount of time they can invest and the type of model they want to work on, but the current process that the project tries to follow is described in the contributing code website and in the CONTRIBUTING.md file.
If you would like to report an issue, you can open a new issue in the GitLab issue tracker. Before creating a new issue, please check if the problem that you are facing was already reported and contribute to the discussion, if necessary.
The official ns-3 App Store is a centralized directory listing third-party modules for ns-3 available on the Internet.
More information on how to submit an ns-3 module to the ns-3 App Store is available in the ns-3 App Store documentation.