mirror of
https://git.rwth-aachen.de/acs/public/villas/node/
synced 2025-03-09 00:00:00 +01:00
added more documenation
git-svn-id: https://zerberus.eonerc.rwth-aachen.de:8443/svn/s2ss/trunk@53 8ec27952-4edc-4aab-86aa-e87bb2611832
This commit is contained in:
parent
9d4bd15002
commit
8842ffbd10
5 changed files with 93 additions and 56 deletions
8
Concept.md
Normal file
8
Concept.md
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
# Concept
|
||||
|
||||
|
||||
\diafile path_simple.dia
|
||||
|
||||
## Path
|
||||
|
||||
## Node
|
||||
6
Configuration.md
Normal file
6
Configuration.md
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
# Configuration
|
||||
|
||||
## Configuration file
|
||||
|
||||
\example loopback.conf
|
||||
\example server.conf
|
||||
3
Contributors.md
Normal file
3
Contributors.md
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
The following persons have been working on the s2ss:
|
||||
|
||||
- Steffen Vogel <StVogel@eonerc.rwth-aachen.de>
|
||||
56
Readme
56
Readme
|
|
@ -1,56 +0,0 @@
|
|||
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
|
||||
- CAP_IPC_LOC to lock pages for better realtime
|
||||
|
||||
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/)
|
||||
|
||||
76
Readme.md
Normal file
76
Readme.md
Normal file
|
|
@ -0,0 +1,76 @@
|
|||
# Readme \section Readme
|
||||
|
||||
This is the readme file for the S2SS server. Take a look at the `doc/html` directory for a full documentation.
|
||||
|
||||
## Contact
|
||||
|
||||
This project is developed at the [Institute for Automation of Complex Power Systems](www.acs.eonerc.rwth-aachen.de) (ACS) at the EON Energy Research Center (EONERC) at the [RWTH University](http://www.rwth-aachen.de) in Aachen.
|
||||
|
||||
- Steffen Vogel <StVogel@eonerc.rwth-aachen.de>
|
||||
- Marija Stevic <MStevic@eonerc.rwth-aachen.de>
|
||||
|
||||
## Compilation
|
||||
|
||||
Install libraries including developement headers for:
|
||||
|
||||
- libconfig
|
||||
- libnl-3
|
||||
- libnl-route-3
|
||||
|
||||
Start the compilation with:
|
||||
|
||||
$ make
|
||||
|
||||
Add `V=5` for a more verbose debugging output.
|
||||
|
||||
## Installation
|
||||
|
||||
Install the server by executing:
|
||||
|
||||
$ make install
|
||||
|
||||
Add `PREFIX=/usr/local/` to specify a non-standard installation destination.
|
||||
|
||||
The s2ss server needs several [capabilities(7)](http://man7.org/linux/man-pages/man7/capabilities.7.html) to run:
|
||||
|
||||
- `CAP_NET_ADMIN` to increase the socket priority
|
||||
- `CAP_NET_BIND_SERVICE` to listen to UDP ports below 1024
|
||||
- `CAP_SYS_NICE` to set the realtime priority and cpu affinity
|
||||
- `CAP_IPC_LOC` to lock pages for better realtime
|
||||
|
||||
## Configuration
|
||||
|
||||
See [configuration](Configuration.md) for more information.
|
||||
|
||||
## Usage
|
||||
|
||||
Usage: ./server CONFIG
|
||||
CONFIG is a required path to a configuration file
|
||||
|
||||
Simulator2Simulator Server 0.1-d7de19c (Jun 4 2014 02:50:13)
|
||||
Copyright 2014, Institute for Automation of Complex Power Systems, EONERC
|
||||
Steffen Vogel <stvogel@eonerc.rwth-aachen.de>
|
||||
|
||||
|
||||
### 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/)
|
||||
|
||||
Loading…
Add table
Reference in a new issue