This is an auto-generated repository from the whole source code, without reference solution source codes.
C++ Makefile
Switch branches/tags
Nothing to show
Clone or download
leeopop Generated from: b2e935c558a87173030417d0b73b0c1f3f24532d
1. Add unreliable data transfer to the Switch module
2. Fix solution
Latest commit 6fac040 May 5, 2017
Permalink
Failed to load latest commit information.
app
build
doxygen
include/E
lib
mk
solution
src
.gitignore
LICENSE
Makefile
README.md

README.md

KENSv3 (KAIST Educational Network System)

KENS series have been used for programming assignment in CS341: Introduction to Computer Network in KAIST. First version of KENS(v1) had been developed by Network Computing Lab(http://nclab.kaist.ac.kr/kens/), 2005. This version had been used until 2013.

KENSv2 is an improvement version from KENSv1, which contains basic unit test mechanism. Since KENSv2, we provided students an adversary solution which work along with students' solution. This solution was provided in binary form, and enabled incremental development of network functionalities. For example, we had to implement both connect and accept for basic execution. From KENSv2, the implementation could be modularized in system call level. This version was used in 2014 (https://an.kaist.ac.kr/courses/2014/cs341/) and the experience of using it has been published at SIGCSE 2015 (http://an.kaist.ac.kr/~sbmoon/paper/intl-conf/2015-sigcse-kensv2.pdf). The source code is managed by Advanced Networking Lab in KAIST.

KENSv1: https://github.com/ANLAB-KAIST/KENSv1

KENSv2: https://github.com/ANLAB-KAIST/KENSv2

From 2015, we are using KENSv3 which is developed from a clean state. However its philosophy has been adopted from KENSv2 and KENSv1. KENSv3 has more powerful features than KENSv2.

  • POSIX equivalent system call layer.
  • Equivalent simulation power against ns2.
  • Modular architecture for multiple protocol layers to work together.

What is KENSv3?

KENSv3 is an educational framework.

KENSv3 provides useful template for building prototypes of Ethernet/ARP/IP/TCP and many other network layers. Also, it contains automated grading system to verify the completeness of each implementation. There are solution binaries in KENSv3 which enables incremental building of network functions.

KENSv3 is a network simulator

Virtual network devices of KENSv3 simulates queuing effect of switched network. So it can be used for precise network simulations like ns2. All packets are recorded as pcap log files which can be analyzed by Wireshark or other analysis tools.

KENSv3 is a virtual execution environment

KENSv3 can execute actual network application source written in C. The system call requests from applications are linked with proper network layer.

How to run KENSv3?

Building KENSv3

  • Check that your compiler supports C++11 and GNU extension (At least 4.8.2 for gcc, LLVM 6.0 for MAC c++).
g++ -std=c++11
g++ -std=gnu++11
  • Check that gtest (Google Test) library is installed in your system.
#include <gtest/gtest.h>

We also need pthread library (or other implementation for C++11 Threading library).

g++ -std=gnu++11 -lgtest -lpthread

To build documentation, you need Doxygen.

  • Build
#cd KENSv3
make depend # dependency check
#header changes will trigger rebuilding of affected source

make all
make doxygen # for making documentation (need Doxygen)

Solution binary for your architecture is needed for building KENS. Currently, we support Cygwin 64bit, Linux 64bit, and Mac OS 64bit.

Running KENSv3

In build directory, testTCP binary will be created after building KENS.

./testTCP # run all tests
./testTCP --gtest_filter="TestEnv_Reliable.TestOpen" # run specific test

See Google Test documentation for further usage.

We provide commands for partial tests.

#cd KENSv3
make test_part1
make test_part2 #also checks test_part1
make test_part3 #also checks test_part2
make test_part4 #also checks test_part3

Running KENSv3 using solution binary bundle

Defining symbol RUN_SOLUTION will build testTCP in solution only mode. You have to clean and rebuild the whole project.

#cd KENSv3
export EXTRA_CXXFLAGS="-DRUN_SOLUTION"
make all

How to do KENSv3 project?

Template source

In TestTCP folder, there are one source file and one header file. You are allowed to modify TCPAssignment.cpp and TCPAssignment.hpp. Also, you can add member fields to "class TCPAssignment". Any source files in TestTCP folder are automatically included in the build path.

What you have to do?

  1. Handling system calls See the documentation for how to handle with blocking system calls.

  2. Context management You have to manage a global context (usually member variables of TCPAssignment). Also, you have to split incoming packets and system call requests. Use IP address and port number for classifying packets, and pid(process id) and fd(file descriptor number) for classifying application sockets. Until here is test_part1.

  3. Handshaking Implement 3-way handshaking for connect/accept and 4-way handshaking for close. Until here is test_part2.

  4. Flow control You may block read/write calls if you have no data from TCP window or you TCP window is full. Handle with read/write and generate/process proper TCP packets for data transmission. Until here is test_part3.

  5. Recovery You have to handle with losses, reorders, and packet corruption.

  6. Congestion control Implement AIMD congestion control mechanism for test_part4. You can observe convergence graph from pcap logs. If you did not implement congestion control algorithm, you may not pass test_part4. There would be retransmission storms and applications may not finish in time. Until here is test_part4.

How to contribute?

This is an automatically generated source repository from our internal repository. If you want to contribute to KENSv3 framework, please send us your patches, your Github ID, and your email address. These informations are used to add you to our contributor list. You can send it via Github issues or kens-dev@an.kaist.ac.kr.

Requests to students

KENSv3 is an open-source framework. However, it is also an educational framework. We couldn't get our position between them. We are asking your favor not to make a public fork, but a private clone for your project. Github provides free educational plan for students (https://education.github.com/). Please do not upload your solutions online, so that other students can do this project themselves later.

Requests to instructors

You may modify it freely to customize this project with your courses. Not only the source contribution, we also receive material contribution. If you have better presentation slides or other teaching material, you can contribute with them. Please let your students not to upload their solutions online.