S2SS Documentation
================================================================================

Contacts:
	Steffen Vogel <StVogel@eonerc.rwth-aachen.de>
	Marija Stevic <MStevic@eonerc.rwth-aachen.de>

 0. Compilation
 -------------------------------------------------------------------------------

	Install libraries including developement headers for:

	  - libconfig
	  - libnl-3
	  - libnl-route-3

	$ make

 1. Installation
--------------------------------------------------------------------------------


 2. Configuration
--------------------------------------------------------------------------------

	The s2ss server needs several capabilities(7) to run:

	  - CAP_NET_ADMIN to increase the socket priority
	  - CAP_SYS_NICE to set the realtime priority and cpu affinity

 3. Examples
--------------------------------------------------------------------------------

	1. Send/Receive of random data:

	   $ ./random 1 4 100 | ./send 4 192.168.1.12:10200

	2. Ping/Pong Latency

	   $ ./test latency 192.168.1.12:10200
	

 A Operating System and Kernel
--------------------------------------------------------------------------------

	Kernel command line: isolcpus=[cpu_number]

	Map NIC IRQs	=> ???
	Map Tasks	=> taskset or sched_cpuaffinity
	Nice Task	=> Realtime Priority

	Linux RT-preemp: https://rt.wiki.kernel.org/index.php/Main_Page
		precompiled kernels: http://ccrma.stanford.edu/planetccrma/software/
			for Fedora 20 (https://fedoraproject.org/)