GSOC2023Projects - Revision history

Tommaso: /* ICMP socket and generate/handle ICMP messages (host/net unreachable) */

2023-04-04T14:32:07Z

ICMP socket and generate/handle ICMP messages (host/net unreachable)

← Older revision		Revision as of 14:32, 4 April 2023
Line 76:		Line 76:
	===== ICMP socket and generate/handle ICMP messages (host/net unreachable) =====		===== ICMP socket and generate/handle ICMP messages (host/net unreachable) =====

	Mentors: [mailto:tommaso.pecorella@unifi.it Tommaso Pecorella], [mailto: manoj24.rana@gmail.com Manoj K. Rana].		Mentors: [mailto:tommaso.pecorella@unifi.it Tommaso Pecorella], [mailto:manoj24.rana@gmail.com Manoj K. Rana].

	The current IP stack in ns-3 does not provide an ICMP socket, and in order to send or receive ICMP packets (either IPV4 or IPv6) it is necessary to use a "RAW" socket.		The current IP stack in ns-3 does not provide an ICMP socket, and in order to send or receive ICMP packets (either IPV4 or IPv6) it is necessary to use a "RAW" socket.

Tommaso: /* Dynamic device registration for NetAnim simulation animations */

2023-04-04T14:31:51Z

Dynamic device registration for NetAnim simulation animations

← Older revision		Revision as of 14:31, 4 April 2023
Line 104:		Line 104:
	===== Dynamic device registration for NetAnim simulation animations =====		===== Dynamic device registration for NetAnim simulation animations =====

	Mentors: [mailto:tommaso.pecorella@unifi.it Tommaso Pecorella], [mailto: manoj24.rana@gmail.com Manoj K. Rana].		Mentors: [mailto:tommaso.pecorella@unifi.it Tommaso Pecorella], [mailto:manoj24.rana@gmail.com Manoj K. Rana].

	NetAnim is a graphical interface based on QT able to visualise nodes movement and messages between nodes either while the simulation is running or when the simulation is ended. It is particularly useful to visualise network dynamics, and to demonstrate scenarios.		NetAnim is a graphical interface based on QT able to visualise nodes movement and messages between nodes either while the simulation is running or when the simulation is ended. It is particularly useful to visualise network dynamics, and to demonstrate scenarios.

Tommaso: /* Dynamic device registration for NetAnim simulation animations */

2023-04-04T14:31:26Z

Dynamic device registration for NetAnim simulation animations

← Older revision		Revision as of 14:31, 4 April 2023
Line 104:		Line 104:
	===== Dynamic device registration for NetAnim simulation animations =====		===== Dynamic device registration for NetAnim simulation animations =====

	Mentors: [mailto:tommaso.pecorella@unifi.it Tommaso Pecorella], [~~TBD~~].		Mentors: [mailto:tommaso.pecorella@unifi.it Tommaso Pecorella], [mailto: manoj24.rana@gmail.com Manoj K. Rana].

	NetAnim is a graphical interface based on QT able to visualise nodes movement and messages between nodes either while the simulation is running or when the simulation is ended. It is particularly useful to visualise network dynamics, and to demonstrate scenarios.		NetAnim is a graphical interface based on QT able to visualise nodes movement and messages between nodes either while the simulation is running or when the simulation is ended. It is particularly useful to visualise network dynamics, and to demonstrate scenarios.

Tommaso: /* ICMP socket and generate/handle ICMP messages (host/net unreachable) */

2023-04-04T14:31:10Z

ICMP socket and generate/handle ICMP messages (host/net unreachable)

← Older revision		Revision as of 14:31, 4 April 2023
Line 76:		Line 76:
	===== ICMP socket and generate/handle ICMP messages (host/net unreachable) =====		===== ICMP socket and generate/handle ICMP messages (host/net unreachable) =====

	Mentors: [mailto:tommaso.pecorella@unifi.it Tommaso Pecorella], [~~TBD~~].		Mentors: [mailto:tommaso.pecorella@unifi.it Tommaso Pecorella], [mailto: manoj24.rana@gmail.com Manoj K. Rana].

	The current IP stack in ns-3 does not provide an ICMP socket, and in order to send or receive ICMP packets (either IPV4 or IPv6) it is necessary to use a "RAW" socket.		The current IP stack in ns-3 does not provide an ICMP socket, and in order to send or receive ICMP packets (either IPV4 or IPv6) it is necessary to use a "RAW" socket.

Tomh at 18:30, 27 March 2023

2023-03-27T18:30:44Z

← Older revision		Revision as of 18:30, 27 March 2023
Line 100:		Line 100:

	Possible tasks to fulfill the patch requirement:		Possible tasks to fulfill the patch requirement:
	* [~~TBD~~]		* [[GSOC2023PatchRequirement]]

	===== Dynamic device registration for NetAnim simulation animations =====		===== Dynamic device registration for NetAnim simulation animations =====
Line 123:		Line 123:

	Possible tasks to fulfill the patch requirement:		Possible tasks to fulfill the patch requirement:
	* [~~TBD~~]		* [[GSOC2023PatchRequirement]]

	===== Linux-like Loss Detection Techniques for ns-3 TCP =====		===== Linux-like Loss Detection Techniques for ns-3 TCP =====
Line 135:		Line 135:
	* ''Interests:'' TCP packet loss detection techniques.		* ''Interests:'' TCP packet loss detection techniques.
	* ''Difficulty:'' Medium to Hard.		* ''Difficulty:'' Medium to Hard.
			* ''Patch requirement:'' [[GSOC2023PatchRequirement]]
	* ''Recommended Reading:''		* ''Recommended Reading:''
	** Forward Acknowledgement (FACK) [[https://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.41.2559&rep=rep1&type=pdf Paper]] [[https://gitlab.com/nsnam/ns-3-dev/-/merge_requests/34/commits Implementation]]		** Forward Acknowledgement (FACK) [[https://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.41.2559&rep=rep1&type=pdf Paper]] [[https://gitlab.com/nsnam/ns-3-dev/-/merge_requests/34/commits Implementation]]
Line 167:		Line 168:
	* ''Required Experience:'' Familiarity with TCP, and in particular with LEDBAT		* ''Required Experience:'' Familiarity with TCP, and in particular with LEDBAT
	* ''Difficulty:'' Medium		* ''Difficulty:'' Medium
			* ''Patch requirement:'' [[GSOC2023PatchRequirement]]
	* ''Recommended reading:''		* ''Recommended reading:''
	** [https://datatracker.ietf.org/doc/html/draft-irtf-iccrg-ledbat-plus-plus-01 LEDBAT++: Internet Draft]		** [https://datatracker.ietf.org/doc/html/draft-irtf-iccrg-ledbat-plus-plus-01 LEDBAT++: Internet Draft]
Line 182:		Line 184:
	* ''Interests:'' Wi-Fi simulations		* ''Interests:'' Wi-Fi simulations
	* ''Difficulty:'' Medium.		* ''Difficulty:'' Medium.
	* ''Patch requirement:'' See [https://gitlab.com/nsnam/ns-3-dev/-/issues/868 ns-3 issue 868] on supporting Buffer Occupancy metric in the wifi stack.		* ''Patch requirement:'' See [https://gitlab.com/nsnam/ns-3-dev/-/issues/868 ns-3 issue 868] on supporting Buffer Occupancy metric in the wifi stack. Or else work on the [[GSOC2023PatchRequirement]]
	* ''Background:''		* ''Background:''
	** IEEE P802.11 TGax defined [https://www.ieee802.org/11/Reports/tgax_update.htm simulation scenarios and methodology], which can be a target (such as the residential scenario 1).		** IEEE P802.11 TGax defined [https://www.ieee802.org/11/Reports/tgax_update.htm simulation scenarios and methodology], which can be a target (such as the residential scenario 1).
Line 225:		Line 227:
	* ''Interests:'' IPv6 routing		* ''Interests:'' IPv6 routing
	* ''Difficulty:'' Medium.		* ''Difficulty:'' Medium.
			* ''Patch requirement:'' [[GSOC2023PatchRequirement]]
	* ''Recommended reading:''		* ''Recommended reading:''
	** [https://www.nsnam.org/docs/models/html/ipv6.html IPv6 model in ns-3]		** [https://www.nsnam.org/docs/models/html/ipv6.html IPv6 model in ns-3]
Line 246:		Line 249:
	* ''Interests:'' Ad hoc routing		* ''Interests:'' Ad hoc routing
	* ''Difficulty:'' Medium.		* ''Difficulty:'' Medium.
			* ''Patch requirement:'' [[GSOC2023PatchRequirement]]
	* ''Recommended reading:''		* ''Recommended reading:''
	** [https://www.nsnam.org/docs/models/html/ipv6.html IPv6 model in ns-3]		** [https://www.nsnam.org/docs/models/html/ipv6.html IPv6 model in ns-3]
Line 266:		Line 270:
	* ''Interests:'' Active Queue Management, Packet scheduling and TCP.		* ''Interests:'' Active Queue Management, Packet scheduling and TCP.
	* ''Difficulty:'' Medium to Hard		* ''Difficulty:'' Medium to Hard
			* ''Patch requirement:'' [[GSOC2023PatchRequirement]]
	* ''Recommended reading:''		* ''Recommended reading:''
	** [https://arxiv.org/pdf/1804.07617.pdf Piece of CAKE: A Comprehensive Queue Management Solution for Home Gateways]		** [https://arxiv.org/pdf/1804.07617.pdf Piece of CAKE: A Comprehensive Queue Management Solution for Home Gateways]
Line 280:		Line 285:
	* ''Interests:'' Wi-Fi, adaptive algorithms.		* ''Interests:'' Wi-Fi, adaptive algorithms.
	* ''Difficulty:'' Medium		* ''Difficulty:'' Medium
			* ''Patch requirement:'' See [https://gitlab.com/nsnam/ns-3-dev/-/issues/868 ns-3 issue 868] on supporting Buffer Occupancy metric in the wifi stack. Or else work on the [[GSOC2023PatchRequirement]]
	* ''Recommended reading:''		* ''Recommended reading:''
	** [https://theses.hal.science/INSA-LYON-THESES/tel-03126953v1 Remy Grunblatt's thesis (especially chapter 5)]		** [https://theses.hal.science/INSA-LYON-THESES/tel-03126953v1 Remy Grunblatt's thesis (especially chapter 5)]
Line 300:		Line 306:
	* ''Interests:'' ML in wireless communication, IPC programming.		* ''Interests:'' ML in wireless communication, IPC programming.
	* ''Difficulty:'' Medium		* ''Difficulty:'' Medium
			* ''Patch requirement:'' [[GSOC2023PatchRequirement]]
	* ''Recommended reading:''		* ''Recommended reading:''
	** The ns3-ai model: [https://dl.acm.org/doi/10.1145/3389400.3389404 Paper], [https://github.com/hust-diangroup/ns3-ai Code]		** The ns3-ai model: [https://dl.acm.org/doi/10.1145/3389400.3389404 Paper], [https://github.com/hust-diangroup/ns3-ai Code]
Line 317:		Line 324:
	* ''Interests:'' New congestion control algorithms, IETF standards		* ''Interests:'' New congestion control algorithms, IETF standards
	* ''Difficulty:'' Medium		* ''Difficulty:'' Medium
			* ''Patch requirement:'' [[GSOC2023PatchRequirement]]
	* ''Recommended reading:'' [https://datatracker.ietf.org/doc/rfc9330/ RFC 9330], [https://arxiv.org/pdf/2209.01078.pdf paper on dual queue]		* ''Recommended reading:'' [https://datatracker.ietf.org/doc/rfc9330/ RFC 9330], [https://arxiv.org/pdf/2209.01078.pdf paper on dual queue]

Tomh: /* Patch requirement guidelines */

2023-03-27T18:20:36Z

Patch requirement guidelines

← Older revision		Revision as of 18:20, 27 March 2023
Line 56:		Line 56:
	=== Patch requirement guidelines ===		=== Patch requirement guidelines ===

	Each project idea has (or ~~will have)~~ a ~~list of proposed tasks~~ that a contributor must do to ~~ensure his/her~~ ability to carry out ~~the idea~~ successfully. Performing one task is necessary for a successful application, and performing more than one task is ''not'' necessary.		Each project idea has either a suggested task, or a link to a [[GSOC2023PatchRequirement \| generic task]], that a contributor must do to demonstrate some ability to carry out a GSoC project successfully. Performing one task is necessary for a successful application, and performing more than one task is ''not'' necessary.

	If a contributor wants to work on a proposed task he/she should immediately contact the mentor(s) to "claim" that task - in order to avoid (where needed) that multiple contributors are on the same task. A task might involve fixing a specific open issue, or adding some functionalities to the existing code.		Contributors that already contributed to the ns-3 codebase with non-trivial bug fixing or features additions might be exempted from performing a task. If you have doubts about if your contributions made you eligible for the task exemption contact the mentors.

	Contributors that ~~did~~ already ~~contribute~~ to the ns-3 codebase with non-trivial bug fixing or features additions might be exempted from performing a task. If you have doubts about if your contributions made you eligible for the task exemption contact the mentors.

	=== Mentors: how to participate ===		=== Mentors: how to participate ===

Tomh: /* 5G NR examples and tutorial */

2023-03-27T04:28:53Z

5G NR examples and tutorial

← Older revision		Revision as of 04:28, 27 March 2023
Line 202:		Line 202:
	For starters, I would suggest to add the CTTC LENA 5G nr module to ns-3, in the typical way (as a module in the contrib/ directory) , and build and run the examples. Documentation is available from here: https://5g-lena.cttc.es/. There is an overview tutorial video available here: https://acmse.net/2021/tutorials-offered/#tut-work03. That is the background information.		For starters, I would suggest to add the CTTC LENA 5G nr module to ns-3, in the typical way (as a module in the contrib/ directory) , and build and run the examples. Documentation is available from here: https://5g-lena.cttc.es/. There is an overview tutorial video available here: https://acmse.net/2021/tutorials-offered/#tut-work03. That is the background information.

	~~To avoid starting from scratch~~, ~~there is already an example in the codebase that we can improve-- see this paper:~~ https://~~arxiv~~.~~org~~/~~pdf~~/~~2205.03278.pdf. See the directory nr~~/~~examples/3gpp~~-~~outdoor~~-calibration. This is the example that we could improve with further tutorial material, some refactoring, and scripts to allow users to regenerate the plots in that paper (and to generate other plots). So, I would recommend anyone interested in this project to study this existing example and understand it as thoroughly as possible. A successful application will demonstrate that the example is well understood (perhaps with a description of what happens, step-by-step, to a user data packet that passes through that system), and suggests possible simplifications to the setup and configuration management of that example.		For more specific guidelines, please view [https://docs.google.com/document/d/1-xAt9c_XGcdOvDfcbr22aXM2mB-jK68zmtCIpqrDp_E/edit?usp=sharing this Google document].

	* ''Required Experience:'' C++ programming, understanding of 5G NR, LTE, and wireless networks		* ''Required Experience:'' C++ programming, understanding of 5G NR, LTE, and wireless networks
	* ''Interests:'' 5G NR simulations		* ''Interests:'' 5G NR simulations
	* ''Difficulty:'' Medium.		* ''Difficulty:'' Medium.
			* ''Patch requirement:'' See the [https://docs.google.com/document/d/1-xAt9c_XGcdOvDfcbr22aXM2mB-jK68zmtCIpqrDp_E/edit?usp=sharing Google document]

	==== Large projects (350 hours) ====		==== Large projects (350 hours) ====

Tomh: /* 5G NR examples and tutorial */

2023-03-24T16:55:30Z

5G NR examples and tutorial

← Older revision		Revision as of 16:55, 24 March 2023
Line 192:		Line 192:
	===== 5G NR examples and tutorial =====		===== 5G NR examples and tutorial =====

	~~Mentor~~: [mailto:tomh@tomh.org Tom Henderson]		Mentors: [mailto:tomh@tomh.org Tom Henderson], [mailto:bbojovic@cttc.es Biljana Bojovic], [mailto:kkoutlia@cttc.es Katerina Koutlia]

	'''Note:''' This could be proposed as either a medium- or large-sized project.		'''Note:''' This could be proposed as either a medium- or large-sized project.

Tomh: /* 5G NR examples and tutorial */

2023-03-19T18:54:00Z

5G NR examples and tutorial

← Older revision		Revision as of 18:54, 19 March 2023
Line 197:		Line 197:

	Readers will note the similarity of this project idea to the previous one. Likewise, the ns-3 5G NR model is one of the most highly used and advanced ns-3 model. Unlike Wi-Fi, this code exists as an add-on module to ns-3 at the current time (see [https://apps.nsnam.org/app/nr/ the app store page]). However, this model is very detailed and it is quite difficult for newcomers to understand and follow something as basic as the lifecycle of a packet through the system. This project would be to improve the usability and examples of the 5G NR module, and write corresponding tutorial documentation. New helpers and trace sources will likely be introduced, and new ways to visualize the 5G NR model operation (visualization of output data) are also of interest. The main output will be a 5G NR specific tutorial that carefully walks the reader through (new) well-designed example programs. Programs that could be used in academic courses could also be in scope. Providing programs to reproduce published performance results are another possibility. Fixing open issues along the way would also be a bonus.		Readers will note the similarity of this project idea to the previous one. Likewise, the ns-3 5G NR model is one of the most highly used and advanced ns-3 model. Unlike Wi-Fi, this code exists as an add-on module to ns-3 at the current time (see [https://apps.nsnam.org/app/nr/ the app store page]). However, this model is very detailed and it is quite difficult for newcomers to understand and follow something as basic as the lifecycle of a packet through the system. This project would be to improve the usability and examples of the 5G NR module, and write corresponding tutorial documentation. New helpers and trace sources will likely be introduced, and new ways to visualize the 5G NR model operation (visualization of output data) are also of interest. The main output will be a 5G NR specific tutorial that carefully walks the reader through (new) well-designed example programs. Programs that could be used in academic courses could also be in scope. Providing programs to reproduce published performance results are another possibility. Fixing open issues along the way would also be a bonus.

			I would like to focus on developing one well-worked example that can be used as an entry point to performing 5G NR simulations. This example should scale to very small and very large scenarios. Users should have a clear understanding of which features are implemented and which are lacking or heavily abstracted. Users should be able to trace the lifecycle of an arbitrary packet as it traverses the system, understanding what objects it passes through and where it spends its time queued in the stack. Users should be able to easily manage the configuration of the many parameters of the scenario. Plots of performance should be easily generated.

			For starters, I would suggest to add the CTTC LENA 5G nr module to ns-3, in the typical way (as a module in the contrib/ directory) , and build and run the examples. Documentation is available from here: https://5g-lena.cttc.es/. There is an overview tutorial video available here: https://acmse.net/2021/tutorials-offered/#tut-work03. That is the background information.

			To avoid starting from scratch, there is already an example in the codebase that we can improve-- see this paper: https://arxiv.org/pdf/2205.03278.pdf. See the directory nr/examples/3gpp-outdoor-calibration. This is the example that we could improve with further tutorial material, some refactoring, and scripts to allow users to regenerate the plots in that paper (and to generate other plots). So, I would recommend anyone interested in this project to study this existing example and understand it as thoroughly as possible. A successful application will demonstrate that the example is well understood (perhaps with a description of what happens, step-by-step, to a user data packet that passes through that system), and suggests possible simplifications to the setup and configuration management of that example.

	* ''Required Experience:'' C++ programming, understanding of 5G NR, LTE, and wireless networks		* ''Required Experience:'' C++ programming, understanding of 5G NR, LTE, and wireless networks

Tomh: /* Wi-Fi examples and tutorial */

2023-03-13T19:35:08Z

Wi-Fi examples and tutorial

← Older revision		Revision as of 19:35, 13 March 2023
Line 188:		Line 188:
	** IEEE P802.11 TGax defined [https://www.ieee802.org/11/Reports/tgax_update.htm simulation scenarios and methodology], which can be a target (such as the residential scenario 1).		** IEEE P802.11 TGax defined [https://www.ieee802.org/11/Reports/tgax_update.htm simulation scenarios and methodology], which can be a target (such as the residential scenario 1).
	** MATLAB has [https://www.mathworks.com/help/wlan/ug/802-11ax-multinode-system-level-simulation-of-residential-scenario-using-matlab.html TGax residential scenario support] which can be used as a guide.		** MATLAB has [https://www.mathworks.com/help/wlan/ug/802-11ax-multinode-system-level-simulation-of-residential-scenario-using-matlab.html TGax residential scenario support] which can be used as a guide.
	**		** check back later for more links

	===== 5G NR examples and tutorial =====		===== 5G NR examples and tutorial =====