Initial revision.

Makefile.vc

@@ -0,0 +1,22 @@
+all: checkmakefiles
+	cd src && $(MAKE) -f Makefile.vc
+
+clean: checkmakefiles
+	cd src && $(MAKE) -f Makefile.vc clean
+
+cleanall: checkmakefiles
+	cd src && $(MAKE) -f Makefile.vc MODE=release clean
+	cd src && $(MAKE) -f Makefile.vc MODE=debug clean
+
+makefiles:
+	cd src && call opp_nmakemake -f --deep
+
+checkmakefiles:
+	@if not exist src\Makefile.vc ( \
+	echo. && \
+	echo ============================================================================ && \
+	echo src/Makefile.vc does not exist. Please use the following command to generate it: && \
+	echo nmake -f Makefile.vc makefiles && \
+	echo ============================================================================ && \
+	echo. && \
+	exit 1 )

Readme.md

@@ -0,0 +1,211 @@
+
+LibPTP: A Library for PTP Simulation
+==============================================================
+
+Project description
+-------------------------------
+
+LibPTP is an implementation of the Precision Time Protocol (PTP) as it is specified in IEEE 1588-2008 in the simulation framework [OMNeT++][1].
+LibPTP uses models of standare network components from the [INET][2] library, and extends them with PTP functionality.
+
+This library is one of the outcomes of my master thesis, _Simulation of Time-synchronized Networks using IEEE 1588-2008_, published at the University of Technology in 2016.
+
+The current version of this library can be found on the [author's Github site][3].
+
+Feature list of LibPTP:
+
+* Models for Ordinary, Boundary and Transparent Clocks
+* Support for both End-to-End (E2E) as wells as Peer-to-Peer (P2P) delay measurement
+* Debugging and tracing support
+* Suport for PTP/Ethernet as specified in Annex F of IEEE 1588-2008
+* A model for a PI clock servo, and support for implementing custom clock servos
+* Support for different kinds of filters
+* __Realistic clock noise__ can optionally be provided by using [LibPLN][4], a library for efficient powerlaw noise generation.
+
+[1]: https://omnetpp.org/
+[2]: https://inet.omnetpp.org/
+[3]: https://github.com/w-wallner/libPTP
+[4]: https://github.com/w-wallner/libPLN
+
+Project overview
+-------------------------------
+
+The goal of LibPTP is it to provide an easy to use simulation tool for PTP networks.
+OMNeT++ was chosen as the development environment because it provides a powerful tool with support for all stages of simulation development, from inital model design to carrying out sophisticated parameter studies.
+
+For an example for what is possible with LibPTP see the following image, which shows a parameter study for the sync interval:
+
+<img src="doc/img/SyncInterval_Mean.png" width="500" />
+
+The images shows the mean offset value a PTP slave node that is directly connected to its master, depending on the configured sync interval.
+The same simulation was carried out with two different oscillators, and LibPTP allows to study the behavior of each of them.
+
+Another advantage of LibPTP are its sophisticated debugging and tracing capabilities.
+For example it is easy to trace all state decisions of a PTP node, as shown in the following image:
+
+<img src="doc/img/BC8_Port2_StateDecisions.png" width="600" />
+
+Additionally, it would be possible to log every single step during the Best Master Clock Algorithm (BMCA) or the dataset comparison algorithm.
+
+Example PTP Simulations
+-------------------------------
+
+The LibPTP repository contains only the actual simulation model for PTP nodes.
+It does not contain any simulatons networks.
+Example simulations can be found in the [PTP Simulations][10] repository.
+
+[10]: https://github.com/w-wallner/PTP_Simulations
+
+Node Symbols
+-------------------------------
+
+OMNeT++ provides a powerful Graphical User Interface (GUI).
+To make full use of it, LibPTP uses custom icons for all PTP related models.
+
+__PTP Nodes:__
+
+The example components that come with LibPTP use an icon scheme to visualize there attributes:
+
+The node icons have a symbol in each corner:
+* __Upper left:__ Node type
+    * N = End node (Ordinary Clock)
+    * B = Boundary Clock
+    * T = Transparent Clock
+
+* __Upper right:__ Delay mechanism
+    * P = Peer-to-Peer (P2P)
+    * E = End-to-End (E2E)
+
+* __Lower left:__ Timestamping capability
+    * 1 = 1-step clock (on-the-fly timestamps)
+    * 2 = 2-step clock
+
+* __Lower right:__ Clock attributes for Best Master Clock Algorithm (BMCA)
+    * Golden star: Excellent clock attributes, such a node will prefer its ports to be passive rather than slave
+    * Silver star: Average clock attributes, such a clock will loose in the BMCA against a clock with golden star
+    * Brozne star: Bad clock attributes, such a clock will loose in the BMCA against a clock with silver star
+    * No icon: Slave only
+
+The image in the center shows a boundary clock, with P2P delay mechanism, which is 1-step capable and has average clock attributes.
+
+<img src="doc/img/NodeSymbols.png" width="500" />
+
+__Example network:__
+
+The folloing images shows an example network to visualize the example icons used by LibPTP:
+
+<img src="doc/img/NodeSymbols_ExampleNetwork.png" width="500" />
+
+All nodes in the PTP network use the P2P delay mechanism (blue P).
+The left-most node is a 1-step capable (1) ordinary clock (E) with excellent clock attributes (golden star).
+It is connected to a 1-step capble boundary clock (B) with average clock attributes (silver star).
+The boundary clock is connected to two daisy chains to the right.
+The upper chain consist of two slave only (no icon) transparent clocks (T), where the second one is only 2-step capable (2), followed by an ordinary clock with bad clock attributes.
+The lower chain consists of a transparent, a boundary and an ordinary clock.
+
+As only one clock has a golden star, we can safely assume that it will win the BMCA and become the grand master of the PTP network.
+
+__PTP Messages:__
+
+As with the PTP nodes, LibPTP also provides custom icons for PTP messages:
+
+<img src="doc/img/MessageSymbols.png" width="500" />
+
+_Remark:_ While icons for Management and Signaling messages are provided, these two message types are currently not implemented.
+
+
+Project structure
+-------------------------------
+
+The _src_ directory contains most of the project relevant contents.
+It structured as follwos: Most of the individual parts of a PTP system are loosely grouped into the folders _Hardware_, _Firmware_ and _Sotware_.
+These individual parts are then plugged to together to form network components, which are placed in the _Components_ directory.
+The _Utils_ folder contains generic utilities.
+
+The other directories are the following:
+
+* `doc:` Documentation for the project, mainly doxygen generated files.
+* `Docs:` Various documents, mainly related to measuremnt results.
+* `images:` The image files for the OMNeT++ models.
+* `Tools:` This the place for generic tools like shell scripts.
+
+Documentation format
+-------------------------------
+
+The documentation files in this repository are written in [Markdown][20] (line ending *.md).
+They can be either read in a text editor, are converted to HTML using the markdown utility.
+
+[20]: https://daringfireball.net/projects/markdown/
+
+Usage
+-------------------------------
+
+__Documentation:__
+
+* Doxygen files can be found in the _doc_ directory
+* The _Docs_ contains various files with additional information (e.g. how to use LibPTP together with LibPLN)
+* Both LibPLN and LibPTP have been developed as part of my master thesis:
+
+_Wolfgang Wallner_, __Simulation of Time-synchronized Networks using IEEE 1588-2008__, 2016, Vienna University of Technology
+
+This document contains an in-depth description on the various design decitions of both libraries, and would be the definitive source of information.
+As of April 2016, it is __not yet published__.
+Expected publication date: __May or June 2016__
+
+__Supported platforms:__
+
+LibPTP has been tested on Linux and Windows.
+Non-Portable libraries have been avoided, thus it is likely that it will work (maybe with small adjustments) also on other platforms.
+
+__Requirements:__
+
+* The [Boost C++ library][30], in a version before 5.x, preferrably 4.6
+* The [OMNeT++ simulation framework][31], in a version before 3.x, preferrably 2.6
+* The [INET library][32]
+* The [OMNeT_Utils project][33]
+* (optionally) The [LibPLN library][34], for realistic clock noise
+
+[30]: http://www.boost.org/
+[31]: https://omnetpp.org/omnetpp/category/30-omnet-releases
+[32]: https://inet.omnetpp.org/Download.html
+[33]: https://github.com/w-wallner/OMNeT_Utils
+[34]: https://github.com/w-wallner/libPLN
+
+__Getting started:__
+
+* Install OMNeT++ 4.6 and INET 2.6
+* Get the _OMNeT Utils_ repository, and add it in your OMNeT++ workspace
+* Get _LibPTP_, and add it in your OMNeT++ workspace
+* Create a new OMNeT++ project, and add LibPTP as project reference
+    * You can now use PTP nodes in your network simulation
+    * For an example on how to create PTP simulation networks, have a look at the examples in the _PTP Simulations_ repository
+* (Optional) Install LibPLN, and provide information about its installation in the provided _makefrag_ file
+    * This enables you to simulate network nodes with realistic clock noise, and thus make PTP simulations more plausible
+
+Credits
+-------------------------------
+
+The implementation of LibPTP would not have been possible without the availability of the following components:
+
+* The [Buttonized icon theme][40]
+* The [OMNeT++ simulation framework][41]
+* The [INET library][42], which provides a large set of models for standard network components
+* The [Boost C++ library][43]
+
+[40]: http://kde-look.org/content/show.php/?content=161553
+[41]: https://omnetpp.org/
+[42]: https://inet.omnetpp.org/
+[43]: http://www.boost.org/
+
+License
+-------------------------------
+
+Most parts of this project are licensed under the _GPLv3 license_. See the _COPYING_ file for details.
+
+As stated, the icons use by LibPTP are based on the _Buttonized_ icon theme, which is licensed unter the _GPLv2 license_.
+The images of LibPTP keep this license, and are thus also licensed unter the _GPLv2 license_. See the _images/LICENSE.txt_ file for details.
+
+Contact
+-------------------------------
+
+Wolfgang Wallner (wolfgang-wallner [AT] gmx.at)

Tools/Bash_Scripts/CleanUpSources.sh

@@ -0,0 +1,62 @@
+#!/bin/bash
+# Simple script to clean up source code (line endings, trailing spaces, ...)
+
+# ==========================================================================
+# Variable initialization
+# ==========================================================================
+declare -a SRC_PATHS=("src" "simulations")
+#declare -a SRC_PATHS=(".")
+declare -a FILE_EXTENSIONS=("*.c" "*.cc" "*.cpp" "*.h" ".hpp" "*.msg" "*.ned" "*.ini")
+
+#declare -a SRC_PATHS=("../../src/Components/BasicBlocks")
+#declare -a FILE_EXTENSIONS=("*.ned")
+
+# ==========================================================================
+# Functions
+# ==========================================================================
+
+# --------------------------------------------------------------------------
+# Clean source directory
+# --------------------------------------------------------------------------
+
+function CleanSourceDir
+{
+    Path=$1
+    Ext=$2
+
+    echo "Searching for ${Ext} in ${Path}"
+    echo ""
+
+    echo "  Converting DOS encoding to UNIX encoding"
+    find ${Path} -name ${Ext} ! -type d -exec bash -c 'dos2unix -q "$0"' {} \;
+
+    echo "  Replacing tabs with 4 spaces"
+    find ${Path} -name ${Ext} ! -type d -exec bash -c 'expand -t 4 "$0" > /tmp/e && mv /tmp/e "$0"' {} \;
+
+    echo "  Removing trailing spaces"
+    SED_CMD='sed '\''s/[[:space:]]*$//'\'' $0 > /tmp/e && mv /tmp/e $0'
+
+    find ${Path} -name ${Ext} ! -type d -exec bash -c "${SED_CMD}" {} \;
+}
+
+# --------------------------------------------------------------------------
+# main
+# --------------------------------------------------------------------------
+for SrcPath in "${SRC_PATHS[@]}"
+do
+    for FileExt in "${FILE_EXTENSIONS[@]}"
+    do
+
+        if [ "$#" -ne 1 ]; then
+            echo "Illegal number of parameters. Root directory required."
+            exit
+        fi
+
+        ROOT_PATH="$1"
+
+        echo "Root: " ${ROOT_PATH}
+
+        CleanSourceDir "${ROOT_PATH}/${SrcPath}" ${FileExt}
+
+    done
+done