Difference between revisions of "GSOC2024Projects"

Revision as of 19:27, 31 January 2024

This page contains 2024 Google Summer of Code project ideas for ns-3.

• GSoC Frequently Asked Questions
• ns-3's 2023 GSoC Contributor guide
• GSoC contributor/student guide (not ns-3 specific)
• 2023 GSoC Contributor application template
• ns-3's GSoC Mentor guide
• GSoC Mentor guide (not ns-3 specific)
• GSoC Contributor Selection Process
• Get in contact with the ns-3 team: ns-developers mailing list | chat https://ns-3.zulipchat.com/

About the ns-3 project

ns-3 is a discrete-event network simulator, with a particular emphasis on network research and education.

Users of ns-3 can construct simulations of computer networks using models of traffic generators, protocols such as TCP/IP, and devices and channels such as WiFi, and analyze or visualize the results. Simulation plays a vital role in the research and education process, because of the ability for simulations to obtain reproducible results (particularly for wireless protocol design), scale to large networks, and study systems that have not yet been implemented. A particular emphasis in ns-3 is the high degree of realism in the models (including frameworks for real application and kernel code) and integration of the tool with virtual machine environments and testbeds; we view that researchers need to move more effortlessly between simulation, testbeds, and live experiments, and ns-3 is designed to facilitate that.

ns-3 has participated in past GSoCs during 2008-10, 2012-15, and 2017-23. We seek contributors interested in the intersection of wireless and computer networking, performance analysis, and open source software.

Org admins

Google Summer of Code organizational admins for ns-3 are Tommaso Pecorella, Mohit P. Tahiliani, and Tom Henderson; contact them with any questions. They also hang out on Zulip.

Mentors

Mentors will be paired with contributors based on the projects that are selected. Mentors from companies are welcome, if the employer will permit the mentor sufficient time to perform the mentoring. Prospective mentors should notify Mohit P. Tahiliani or Tommaso Pecorella of interest. Mentors familiar with ns-3 development practices will be preferred, to improve the chances of code merge. We are going to be seeking two-person or multiple-person mentoring teams for projects, to help with the mentoring workload and bring more expertise.

The current list of prospective mentors can be found among the ideas listed below.

How to apply

For students or contributors interested in applying to ns-3 for GSoC, please go through the following list to get started:

• Read the official GSoC contributor guide.
• Read ns-3's GSoC contributor guide
• Look through our #Project Ideas below to see if you find a project that interests you.
• Review the tutorial and contributing guide thoroughly, if you have not already done so.
• Once it is posted, look through the GSoC application template to start preparing your proposal. We will wait to see whether we are actually part of GSoC before posting this.
• Next, proceed to get in touch with the developers on the mailing list or chat room and refine your proposal.
• In parallel, make sure you prepare a patch as per the patch requirement guidelines. Your application to ns-3 will not be considered if you do not fulfill this requirement.

Below is a list of #Project Ideas proposed by the ns-3 team for Google Summer of Code 2023. Please note that these ideas are not limited to GSoC; anyone is welcome to work on them. Please email the ns-developers list if you have a different idea that you'd like to work on, to see if a mentor may be interested. Applicants are encouraged to look over this list, pick one that especially interests them, think about it, and discuss potential approaches on the ns-developers list. Previous experience with the Google Summer of Code programs suggest that the more you discuss and refine your proposal on the mailing list beforehand, the stronger the proposal it will develop into, and the higher your chances of being accepted into the program.

Each project idea within a particular priority has been tagged with the following properties:

• Required Experience: Languages, concepts, or packages with which applicants must be familiar.
• Bonus Experience: Other experience or familiarity which would be greatly helpful to applicants for this project.
• Interests: Areas of particular relevance to this project, and an indicator of where successful contributors might apply their experiences coming out of this project.
• Difficulty: easy, medium or difficult
• Recommended reading: pointers to documentation, papers, specific bugs, etc.

Note that all of the projects require some experience and comfort with C++. Project ideas for which C++ is noted as a required experience will require more and deeper familiarity with the language. A similar notion applies to computer networking, BSD sockets, etc: Familiarity is strongly preferred, but is not required except where explicitly noted due to the topic being more advanced in that regard. A few projects are more Python-centric.

Patch requirement guidelines

Each project idea has either a suggested task, or a link to a 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.

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.

Mentors: how to participate

The ns-3 project is open to the proposal of new project ideas by developers interested in being a GSoC mentor. For mentors who're adding project ideas to the list below, please ensure that:

• The projects are sized such that there can be a code merge by the end of the coding period. The scope of the project should be such that it is very difficult to *not* have a code merge by the end of the summer.
• The proposed projects are not too open-ended. That is, if the deliverables or a clear path to the same are not well understood, it is better kept outside GSOC.
• There should be a clear merge path to one of the main project code repositories (ns-3-dev, ns-3-dce, bake) by the end of the summer, either because the patches directly apply to these repositories, or because they apply to an ns-3 module that is in the process of being merged with ns-3-dev.

Project Ideas

Note to contributors: These ideas are not listed in any priority order. If an idea doesn't have a mentor yet, it means that if you are interested, you should announce your interest and see if there is a mentor who might pick it up.

Medium sized projects (175 hours)

ICMP socket and generate/handle ICMP messages

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

Mentors: Tommaso Pecorella, 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. This approach works, but has a severe limitation: it does not work if the packet has been fragmented. Moreover, using a RAW socket is far more complex than a normal socket, as the receiver application must filter the incoming packets according to specific rules.

The goal of the idea is to create, test, and document an ICMP socket that works both for IPv4 and IPv6, mimicking the Linux sockets socket(AF_INET, SOCK_DGRAM, IPPROTO_ICMP) and socket(AF_INET6, SOCK_DGRAM, IPPROTO_ICMPV6). Note that the choice of SOCK_DGRAM or SOCK_RAW (i.e., with or without the IP header) is totally left to the proposal.

The most important point of the implementation should be code duplicate minimization, in order to have the minimize maintenance efforts.

Once the sockets are in place, beside the "normal" tests, it will be necessary to modify the code that is actually made obsolete by the new sockets, e.g.:

• IPv6 ICMP messages (RA, RS, NA, NS, etc.),
• IPv4 ICMP messages,
• ICMP Echo and ICMPv6 Echo messages.

and to handle properly ICMP error messages like Destination Unreachable in the Ping application.

• Required Experience: Fundamentals of IPv4 and IPv6 sockets, C++ programming.
• Interests: Sockets and API interface implementation.
• Difficulty: Medium.
• Recommended reading:
  • Linux socket
  • Raw Sockets and ICMP, Srinidhi Varadarajan
  • Issue #810

Possible tasks to fulfill the patch requirement:

• GSOC2023PatchRequirement