MCIT Online 553 Project 1 Documentation Link State and Distance Vector RoutingC/C++

Java Python MCIT Online 553 Project 1 Documentation

Link State and Distance Vector Routing

MCIT Online 553 Staff - v3

May 6, 2024

Directions

You must work in groups of 4 for this project.  Please regularly check Ed Discussion through out this course for project specification clarifications. You are required to version control your code, but please only use the GitHub repository created for you by the 553 staff. Do not work in public GitHub reposito- ries! Please avoid publishing this project at any time, even post-submission, to observe course integrity policies.  If you are caught using code from other groups or any sources from public code reposito- ries, your entire group will receive ZERO for this assignment, and will be sent to the Office of Student Conduct where there will be additional sanctions imposed by the university.

Overview

In this assignment, you will implement two routing protocols:  link state and distance vector routing. Your ns-3 implementation should be able to read network topology files and calculate routing table based on the LS and the DV algorithms.  There will be commands to bring up/down a node or a link, your code should handle the update and reflect on the output in a timely manner.  We also provide an auto-grader and test files to validate your implementation.

We will be using the ns-3 discrete network simulator to teach core principles of network routing protocol design and implementation.   Your assignment is to extend ns-3 to support efficient routing using link-state and distance-vector protocols.

An important goal of this project is to provide you the opportunity to read and understand a sizable piece of software and extend it applying best practices of version control. Hence, we have deliberately not included all the details about the ns-3 code,particularly on specific APIs.

Please be aware that no amount of documentation can replace actual reading and running of the code itself.  So rather than spend hours digesting this document without looking at the code, make sure you treat this document as a reference guide while you run the simulator and step through the control flow of various interacting software modules. To get into the habit of working as a team, we encourage you to spend a day or two to get your entire group together to try to understand the code as a team, and help each other out.

1    Getting Started

The TAs developed a version of ns-3.33 release for this assignment.  Instead of downloading from the ns3 website, please clone the repo we set up for you. We normally post a tar file in Canvas with starter code from previous semester for students that want a head stard, however please make sure you clone the repo provided to you before starting to code as some updates in starter code may have been made.

1.1    VM and ns-3 Download

We provide a Docker environment for the class, files are in this repo. DockerEnv Github Repo

•  Create home folder for the project in your host OS (this will be our home directory) and clone the docker repo here.

$ mkdir my_project1_repo && cd my_project1_repo

$ git clone https://github.com/CIS-553-Online/DockerEnv.git

•  Move files to home directory, build and run docker image.

$ mv DockerEnv/Dockerfile  . && mv DockerEnv/docker-compose.yml  . $ docker-compose build cis553

$ docker-compose run --rm cis553

You should be inside your docker image now. The directory from which you run the image in your host OS becomes the home directory inside the docker container. If for any reason you need superuser priviledges inside docker container, password is:

mcit

1.2    Git Repositories

We will be setting up a git repo for you in the CIS 553 Github account. Do not set up your own git repo outside of our assigned repositories. We will post a Google form for you to enter your group information necessarily for creating your repositories.

2    Code Structure and Compilation

For the purpose of this project, we have isolated all the code that you need to make/learn within the contrib/upenn-cis553 folder. All the other files for the purpose of testing are stored under scratch/re- sults, scratch/scenarios and scratch/topologies folder.

One of the important things to learn from this project is learning how to read and understand APIs within the code, before filling in the actual implementation. We will not provide details of APIs here. Understanding these APIs is part of your project. To help you understand each function, we have added

some comments (function headers).

2.1    Files to modify

•  ls-routing-protocol<