ProtocolStack

This repository is for learning network programming in Go and mainly aims to implement TCP/IP stack.

Overview

Supported Protocols

• Ethernet
• ARP
  • Request
  • Reply
• IP
  • v4
  • v6
• ICMP
  • Echo Request
  • Echo Reply
• TCP
  • Receiving data less than MTU
  • Receiving data which exceeds MTU
  • Sending data
  • Flow Control
  • Retransmission
• UDP

Requirements

• OS: Linux
• Go: 1.14.x or higher

Directory Structure

ProtocolStack/
├── .github
│ └── workflows .. Configurations for GitHub Actions
├── src
│ ├── binary ..... provides utilities for binary operation
│ ├── cli ........ cli command difinitions
│ ├── error ...... error definitions
│ ├── log ........ provides utilities for logging
│ ├── monitor .... provides monitoring features to watch services
│ ├── mw ......... provides a layer to connect network layer with ethernet layer
│ ├── net ........ protocol implementations
│ │ ├── arp .... arp
│ │ ├── eth .... ethernet protocol
│ │ ├── icmp ... icmp
│ │ ├── ip ..... ip
│ │ └── tcp .... tcp
│ ├── repo ....... provides repositories of various entities
│ ├── syscall .... provides system call wrappers
│ ├── test ....... test cases
│ ├── time ....... provides utilities for time operation
│ └── worker ..... provides various types used by worker
└── vagrant
└── provisioners provides provisioning scripts

Instructions

ProtocolStack needs a TAP device for its capability. For the reason, this project uses a virtual machine (Linux) to run the application.

1. Preparing for using the virtual machine

Software required is as follows:

• Mutagen
• Vagrant
• VirtualBox

Note: Mutagen synchronizes files between local system and virtual machine.

2. Controlling the virtual machine

vm.sh controls the virtual machine. The available commands are as follows:

• start
• stop
• restart

You can perform the commands below:

> ./vm.sh start # Start the VM and create a Mutagen session.> ./vm.sh stop # Stop the VM and terminate the Mutagen session.> ./vm.sh restart # Restart the VM and recreate the Mutagen session.

Note: Remote debugging with GoLand

• See the instruction for more detail.
• Related information:
  • What Are Run Targets & How To Run Code Anywhere
  • How to use Docker to compile and run Go code from GoLand
  • Compile and run Go code using WSL 2 and GoLand

3. Compile

It is able to compile the application with make:

> make compile

4. Running application

Start as echo server

./bin/pstack server

Start as client

Send ICMP request:

./bin/pstack ping -c 192.0.2.1

Note: make supports the commands below:

• build build project
• clean clean up caches
• compile resolve dependencies, and build the program
• fmt run formatter
• gen generate source code
• lint run linters (golangci-lint)
• resolve resolve dependencies
• test run all tests

Examples

• ICMP Echo Reply
• ICMP Echo Request
• 3-Way Handshake

References

• Articles
  • Demystifying memory management in modern programming languages
• Blogs
  • golangspec
  • Vincent Blanchon
• Books
  • Hands-On High Performance with Go
  • Mastering Go - Second Edition
  • Multiplayer Game Programming: Architecting Networked Games
  • TCP/IP Illustrated
• Docs
  • Codecov
    • About the Codecov yaml
    • Codecov Delta
  • Docker
    • Compose file
    • Dockerfile
    • Overview of Docker Compose
  • fedora
    • DNF, the next-generation replacement for YUM
    • Understanding and administering systemd
  • GitHub Actions
    • Reference
  • Mutagen
    • File synchronization
  • Slack
    • Builder
      • Block Kit
      • Message
    • Reference guides for app features
  • UI
    • Error Message Guidelines
    • Messages: UI Text Guidelines
  • Vagrant
    • Vagrantfile
• Go
  • Articles
    • A Closer Look at Golang From an Architect’s Perspective
    • Go at Google: Language Design in the Service of Software Engineering
    • Go talks
    • Golang tips: why pointers to slices are useful and how ignoring them can lead to tricky bugs
  • Docs
    • Command compile
    • Command vet
    • Compiler And Runtime Optimizations
    • Data Race Detector
    • Effective Go
    • Frequently Asked Questions (FAQ)
      • Should I define methods on values or pointers?
        • Value vs Pointer Receivers
    • Getting Started with Code Coverage for Golang
    • Go by Example
    • Package testing
    • The Go Memory Model
    • The Go Programming Language Specification
  • Packages
    • github.com/google/go-cmp/cmp
• Makefile
  • A Good Makefile for Go
  • GNU Make Manual
• Papers
  • Fifty Shades of Congestion Control: A Performance and Interactions Evaluation
  • Implementation of Transmission Control Protocol in Linux
• RFC
  • 791: Internet Protocol
  • 793: Transmission Control Protocol
  • 1071: Computing the Internet Checksum
  • 5952: 5. Text Representation of Special Addresses
• Open Source Software
  • pandax381 / microps
  • torvalds / linux
    • net / ethernet
    • net / ipv4
• Wikipedia
  • Computer Network
    • 0.0.0.0
    • Address Resolution Protocol
    • Data link layer
    • Ethernet frame
    • Internet Protocol
    • Network Layer
    • TUN/TAP
    • TCP congestion control
    • Transmission Control Protocol
    • User Datagram Protocol
  • Memory
    • Memory barrier
    • Memory management
    • Memory model (programming)
    • Memory safety
    • Region-based memory management
  • Others
    • Architectural pattern
    • Communicating sequential processes
    • Continuation
    • Cooperative multitasking
    • Critical section
    • Ellipsis (computer programming)
    • Fair-share scheduling
    • Fork-join model
    • Generic programming
    • Monitor (synchronization)
    • Pipeline stall
    • Preemption (computing)
    • Process substitution
    • Reflective programming
    • Software design pattern
    • Task (computing)
    • Template metaprogramming
    • Thread pool
    • Threading models
    • Work stealing

Notes

• Computer Network
  • Pseudo-Headers: A Source of Controversy
• GO
  • Asynchronous Preemption
    • Go: Goroutine and Preemption
    • Goroutine preemptive scheduling with new features of go 1.14
  • Context
    • Go: Context and Cancellation by Propagation
• Programming
  • History of programming languages
• Question and answer site
  • C++ : how to close a tcp socket (server) when receiving SIGKILL
  • How to clear values of a instance of a type struct dynamically
  • Understanding INADDR_ANY for socket programming
  • What is the difference between AF_INET and PF_INET in socket programming?

Memos

• Use the context types properly acording to the rubric.
  • context.Background()
  • context.TODO()
• Definition of errno in Go
  • go/src/syscall/zerrors_linux_amd64.go