gPTP: ClockServos, BMCA and HotStandby

.clang-format

@@ -1,21 +1,31 @@
-BasedOnStyle: None
+BasedOnStyle: InheritParentConfig
+
+SortIncludes: CaseSensitive
+IncludeBlocks: Regroup
+BreakBeforeBraces: Custom
+BraceWrapping:
+  AfterClass: true
+  AfterFunction: true
+  BeforeElse: true
+  AfterControlStatement: MultiLine
+TabWidth: 4
+IndentWidth: 4
+ColumnLimit: 120
 
-SortIncludes:    true
-IncludeBlocks:   Regroup
 
 IncludeIsMainRegex: '([-_](test|unittest))?$'
 IncludeIsMainSourceRegex: ''
 
 IncludeCategories:
-  - Regex:           '^<ext/.*\.h>'
-    Priority:        2
-    SortPriority:    0
-  - Regex:           '^<.*\.h>'
-    Priority:        1
-    SortPriority:    0
-  - Regex:           '^<.*'
-    Priority:        2
-    SortPriority:    0
-  - Regex:           '.*'
-    Priority:        3
-    SortPriority:    0
+  - Regex: '^<ext/.*\.h>'
+    Priority: 2
+    SortPriority: 0
+  - Regex: '^<.*\.h>'
+    Priority: 1
+    SortPriority: 0
+  - Regex: '^<.*'
+    Priority: 2
+    SortPriority: 0
+  - Regex: '.*'
+    Priority: 3
+    SortPriority: 0

.cproject

@@ -55,24 +55,24 @@
 							</tool>
 						</toolChain>
 					</folderInfo>
-					<folderInfo id="org.omnetpp.cdt.gnu.config.debug.229043752.190405672" name="/" resourcePath="src">
-						<toolChain id="org.omnetpp.cdt.gnu.toolchain.debug.1503084477" name="GCC for OMNeT++" superClass="org.omnetpp.cdt.gnu.toolchain.debug" unusedChildren="">
-							<tool id="cdt.managedbuild.tool.gnu.archiver.base.174182489" name="GCC Archiver" superClass="cdt.managedbuild.tool.gnu.archiver.base.1843986175"/>
-							<tool id="cdt.managedbuild.tool.gnu.cpp.compiler.base.1356567919" name="GCC C++ Compiler" superClass="cdt.managedbuild.tool.gnu.cpp.compiler.base.1544720771">
-								<inputType id="cdt.managedbuild.tool.gnu.cpp.compiler.input.1922783326" superClass="cdt.managedbuild.tool.gnu.cpp.compiler.input"/>
+					<folderInfo id="org.omnetpp.cdt.gnu.config.debug.229043752.1221505929" name="/" resourcePath="src">
+						<toolChain id="org.omnetpp.cdt.gnu.toolchain.debug.431488266" name="GCC for OMNeT++" superClass="org.omnetpp.cdt.gnu.toolchain.debug" unusedChildren="">
+							<tool id="cdt.managedbuild.tool.gnu.archiver.base.1905186376" name="GCC Archiver" superClass="cdt.managedbuild.tool.gnu.archiver.base.1843986175"/>
+							<tool id="cdt.managedbuild.tool.gnu.cpp.compiler.base.1642657122" name="GCC C++ Compiler" superClass="cdt.managedbuild.tool.gnu.cpp.compiler.base.1544720771">
+								<inputType id="cdt.managedbuild.tool.gnu.cpp.compiler.input.1244357031" superClass="cdt.managedbuild.tool.gnu.cpp.compiler.input"/>
 							</tool>
-							<tool id="cdt.managedbuild.tool.gnu.c.compiler.base.1512537327" name="GCC C Compiler" superClass="cdt.managedbuild.tool.gnu.c.compiler.base.892294620">
-								<inputType id="cdt.managedbuild.tool.gnu.c.compiler.input.1007328871" superClass="cdt.managedbuild.tool.gnu.c.compiler.input"/>
+							<tool id="cdt.managedbuild.tool.gnu.c.compiler.base.341513652" name="GCC C Compiler" superClass="cdt.managedbuild.tool.gnu.c.compiler.base.892294620">
+								<inputType id="cdt.managedbuild.tool.gnu.c.compiler.input.583104932" superClass="cdt.managedbuild.tool.gnu.c.compiler.input"/>
 							</tool>
-							<tool id="cdt.managedbuild.tool.gnu.c.linker.base.828983458" name="GCC C Linker" superClass="cdt.managedbuild.tool.gnu.c.linker.base.1169210834"/>
-							<tool id="cdt.managedbuild.tool.gnu.cpp.linker.base.468489866" name="GCC C++ Linker" superClass="cdt.managedbuild.tool.gnu.cpp.linker.base.1065738287"/>
-							<tool id="cdt.managedbuild.tool.gnu.assembler.base.877948907" name="GCC Assembler" superClass="cdt.managedbuild.tool.gnu.assembler.base.420284418">
-								<inputType id="cdt.managedbuild.tool.gnu.assembler.input.1558259164" superClass="cdt.managedbuild.tool.gnu.assembler.input"/>
+							<tool id="cdt.managedbuild.tool.gnu.c.linker.base.671556501" name="GCC C Linker" superClass="cdt.managedbuild.tool.gnu.c.linker.base.1169210834"/>
+							<tool id="cdt.managedbuild.tool.gnu.cpp.linker.base.310227149" name="GCC C++ Linker" superClass="cdt.managedbuild.tool.gnu.cpp.linker.base.1065738287"/>
+							<tool id="cdt.managedbuild.tool.gnu.assembler.base.882472359" name="GCC Assembler" superClass="cdt.managedbuild.tool.gnu.assembler.base.420284418">
+								<inputType id="cdt.managedbuild.tool.gnu.assembler.input.174444381" superClass="cdt.managedbuild.tool.gnu.assembler.input"/>
 							</tool>
 						</toolChain>
 					</folderInfo>
 					<sourceEntries>
-						<entry excluding="inet/visualizer/osg|inet/applications/voipstream|inet/transportlayer/tcp_nsc|inet/transportlayer/tcp_lwip|inet/emulation|inet/clock/oscillator|inet/clock/model|inet/clock/common|inet/clock/base|inet/linklayer/ext|inet/routing/extras|transport/tcp_nsc|transport/tcp_lwip" flags="VALUE_WORKSPACE_PATH|RESOLVED" kind="sourcePath" name="src"/>
+						<entry excluding="inet/visualizer/osg|inet/emulation" flags="VALUE_WORKSPACE_PATH|RESOLVED" kind="sourcePath" name="src"/>
 					</sourceEntries>
 				</configuration>
 			</storageModule>
@@ -128,24 +128,24 @@
 							</tool>
 						</toolChain>
 					</folderInfo>
-					<folderInfo id="org.omnetpp.cdt.gnu.config.release.1746235823.726435980" name="/" resourcePath="src">
-						<toolChain id="org.omnetpp.cdt.gnu.toolchain.release.1436426478" name="GCC for OMNeT++" superClass="org.omnetpp.cdt.gnu.toolchain.release" unusedChildren="">
-							<tool id="cdt.managedbuild.tool.gnu.archiver.base.2096808187" name="GCC Archiver" superClass="cdt.managedbuild.tool.gnu.archiver.base.1643927787"/>
-							<tool id="cdt.managedbuild.tool.gnu.cpp.compiler.base.1962906663" name="GCC C++ Compiler" superClass="cdt.managedbuild.tool.gnu.cpp.compiler.base.1039888888">
-								<inputType id="cdt.managedbuild.tool.gnu.cpp.compiler.input.999109181" superClass="cdt.managedbuild.tool.gnu.cpp.compiler.input"/>
+					<folderInfo id="org.omnetpp.cdt.gnu.config.release.1746235823.1025069471" name="/" resourcePath="src">
+						<toolChain id="org.omnetpp.cdt.gnu.toolchain.release.1869309723" name="GCC for OMNeT++" superClass="org.omnetpp.cdt.gnu.toolchain.release" unusedChildren="">
+							<tool id="cdt.managedbuild.tool.gnu.archiver.base.1037588028" name="GCC Archiver" superClass="cdt.managedbuild.tool.gnu.archiver.base.1643927787"/>
+							<tool id="cdt.managedbuild.tool.gnu.cpp.compiler.base.713957125" name="GCC C++ Compiler" superClass="cdt.managedbuild.tool.gnu.cpp.compiler.base.1039888888">
+								<inputType id="cdt.managedbuild.tool.gnu.cpp.compiler.input.354311558" superClass="cdt.managedbuild.tool.gnu.cpp.compiler.input"/>
 							</tool>
-							<tool id="cdt.managedbuild.tool.gnu.c.compiler.base.1379457008" name="GCC C Compiler" superClass="cdt.managedbuild.tool.gnu.c.compiler.base.419916163">
-								<inputType id="cdt.managedbuild.tool.gnu.c.compiler.input.745063749" superClass="cdt.managedbuild.tool.gnu.c.compiler.input"/>
+							<tool id="cdt.managedbuild.tool.gnu.c.compiler.base.2143832934" name="GCC C Compiler" superClass="cdt.managedbuild.tool.gnu.c.compiler.base.419916163">
+								<inputType id="cdt.managedbuild.tool.gnu.c.compiler.input.1746095656" superClass="cdt.managedbuild.tool.gnu.c.compiler.input"/>
 							</tool>
-							<tool id="cdt.managedbuild.tool.gnu.c.linker.base.1989126152" name="GCC C Linker" superClass="cdt.managedbuild.tool.gnu.c.linker.base.1190158571"/>
-							<tool id="cdt.managedbuild.tool.gnu.cpp.linker.base.1253563592" name="GCC C++ Linker" superClass="cdt.managedbuild.tool.gnu.cpp.linker.base.893445214"/>
-							<tool id="cdt.managedbuild.tool.gnu.assembler.base.485445059" name="GCC Assembler" superClass="cdt.managedbuild.tool.gnu.assembler.base.960891752">
-								<inputType id="cdt.managedbuild.tool.gnu.assembler.input.463994980" superClass="cdt.managedbuild.tool.gnu.assembler.input"/>
+							<tool id="cdt.managedbuild.tool.gnu.c.linker.base.20821548" name="GCC C Linker" superClass="cdt.managedbuild.tool.gnu.c.linker.base.1190158571"/>
+							<tool id="cdt.managedbuild.tool.gnu.cpp.linker.base.1142525406" name="GCC C++ Linker" superClass="cdt.managedbuild.tool.gnu.cpp.linker.base.893445214"/>
+							<tool id="cdt.managedbuild.tool.gnu.assembler.base.424443820" name="GCC Assembler" superClass="cdt.managedbuild.tool.gnu.assembler.base.960891752">
+								<inputType id="cdt.managedbuild.tool.gnu.assembler.input.438339827" superClass="cdt.managedbuild.tool.gnu.assembler.input"/>
 							</tool>
 						</toolChain>
 					</folderInfo>
 					<sourceEntries>
-						<entry excluding="inet/visualizer/osg|inet/applications/voipstream|inet/transportlayer/tcp_nsc|inet/transportlayer/tcp_lwip|inet/emulation|inet/clock/oscillator|inet/clock/model|inet/clock/common|inet/clock/base|inet/linklayer/ext|inet/routing/extras|transport/tcp_nsc|transport/tcp_lwip" flags="VALUE_WORKSPACE_PATH|RESOLVED" kind="sourcePath" name="src"/>
+						<entry excluding="inet/visualizer/osg|inet/emulation" flags="VALUE_WORKSPACE_PATH|RESOLVED" kind="sourcePath" name="src"/>
 					</sourceEntries>
 				</configuration>
 			</storageModule>

.gitignore

@@ -103,3 +103,4 @@ xxx
 /tmp/
 /.computed/
 *.DS_Store
+.idea/

.oppbuildspec

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
 <buildspec version="4.0">
-    <dir path="." type="custom"/>
     <dir makemake-options="--make-so --deep -o INET -O out -pINET --meta:export-include-path --meta:export-library --meta:use-exported-libs --meta:feature-cflags --meta:feature-ldflags" path="src" type="makemake"/>
+    <dir path="." type="custom"/>
 </buildspec>

.project

@@ -5,6 +5,11 @@
 	<projects>
 	</projects>
 	<buildSpec>
+		<buildCommand>
+			<name>org.python.pydev.PyDevBuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
 		<buildCommand>
 			<name>org.omnetpp.cdt.MakefileBuilder</name>
 			<arguments>
@@ -93,5 +98,6 @@
 		<nature>org.eclipse.cdt.core.ccnature</nature>
 		<nature>org.eclipse.cdt.managedbuilder.core.managedBuildNature</nature>
 		<nature>org.omnetpp.main.omnetppnature</nature>
+		<nature>org.python.pydev.pythonNature</nature>
 	</natures>
 </projectDescription>

doc/src/nedtags.xml

@@ -348,6 +348,18 @@
     <name>inet.linklayer.bmac.BMacInterface</name>
     <filename>inet.linklayer.bmac.BMacInterface.html</filename>
   </compound>
+  <compound kind="class">
+    <name>inet.showcases.tsn.timesynchronization.gptp_bmca.BmcaShowcaseDiamond</name>
+    <filename>inet.showcases.tsn.timesynchronization.gptp_bmca.BmcaShowcaseDiamond.html</filename>
+  </compound>
+  <compound kind="class">
+    <name>inet.showcases.tsn.timesynchronization.gptp_bmca.BmcaShowcaseDiamondAsymmetric</name>
+    <filename>inet.showcases.tsn.timesynchronization.gptp_bmca.BmcaShowcaseDiamondAsymmetric.html</filename>
+  </compound>
+  <compound kind="class">
+    <name>inet.showcases.tsn.timesynchronization.gptp_bmca.BmcaShowcaseSimple</name>
+    <filename>inet.showcases.tsn.timesynchronization.gptp_bmca.BmcaShowcaseSimple.html</filename>
+  </compound>
   <compound kind="class">
     <name>inet.mobility.single.BonnMotionMobility</name>
     <filename>inet.mobility.single.BonnMotionMobility.html</filename>
@@ -1868,6 +1880,10 @@
     <name>inet.linklayer.ieee8021as.GptpBridge</name>
     <filename>inet.linklayer.ieee8021as.GptpBridge.html</filename>
   </compound>
+  <compound kind="class">
+    <name>inet.linklayer.ieee8021as.GptpDomainClassifier</name>
+    <filename>inet.linklayer.ieee8021as.GptpDomainClassifier.html</filename>
+  </compound>
   <compound kind="class">
     <name>inet.linklayer.ieee8021as.GptpEndstation</name>
     <filename>inet.linklayer.ieee8021as.GptpEndstation.html</filename>
@@ -1956,6 +1972,10 @@
     <name>inet.tests.ethernet.HostsWithSwitch</name>
     <filename>inet.tests.ethernet.HostsWithSwitch.html</filename>
   </compound>
+  <compound kind="class">
+    <name>inet.linklayer.ieee8021as.HotStandby</name>
+    <filename>inet.linklayer.ieee8021as.HotStandby.html</filename>
+  </compound>
   <compound kind="class">
     <name>inet.examples.ethernet.lans.HubLAN</name>
     <filename>inet.examples.ethernet.lans.HubLAN.html</filename>
@@ -2932,6 +2952,10 @@
     <name>inet.queueing.server.InstantServer</name>
     <filename>inet.queueing.server.InstantServer.html</filename>
   </compound>
+  <compound kind="class">
+    <name>inet.clock.servo.InstantServoClock</name>
+    <filename>inet.clock.servo.InstantServoClock.html</filename>
+  </compound>
   <compound kind="class">
     <name>inet.showcases.visualizer.canvas.instrumentfigures.InstrumentShowcase</name>
     <filename>inet.showcases.visualizer.canvas.instrumentfigures.InstrumentShowcase.html</filename>
@@ -3508,6 +3532,10 @@
     <name>inet.showcases.measurement.jitter.JitterMeasurementShowcase</name>
     <filename>inet.showcases.measurement.jitter.JitterMeasurementShowcase.html</filename>
   </compound>
+  <compound kind="class">
+    <name>inet.showcases.tsn.timesynchronization.gptp.JumpingClockGptpShowcase</name>
+    <filename>inet.showcases.tsn.timesynchronization.gptp.JumpingClockGptpShowcase.html</filename>
+  </compound>
   <compound kind="class">
     <name>inet.examples.inet.kidsnw1.KIDSNw1</name>
     <filename>inet.examples.inet.kidsnw1.KIDSNw1.html</filename>
@@ -3948,6 +3976,10 @@
     <name>inet.examples.sctp.cmttest.multihomed</name>
     <filename>inet.examples.sctp.cmttest.multihomed.html</filename>
   </compound>
+  <compound kind="class">
+    <name>inet.showcases.tsn.timesynchronization.gptp.MultiHopGptpShowcase</name>
+    <filename>inet.showcases.tsn.timesynchronization.gptp.MultiHopGptpShowcase.html</filename>
+  </compound>
   <compound kind="class">
     <name>inet.protocolelement.measurement.MultiMeasurementLayer</name>
     <filename>inet.protocolelement.measurement.MultiMeasurementLayer.html</filename>
@@ -4980,6 +5012,10 @@
     <name>inet.applications.pingapp.PingApp</name>
     <filename>inet.applications.pingapp.PingApp.html</filename>
   </compound>
+  <compound kind="class">
+    <name>inet.clock.servo.PiServoClock</name>
+    <filename>inet.clock.servo.PiServoClock.html</filename>
+  </compound>
   <compound kind="class">
     <name>inet.showcases.wireless.power.PowerConsumptionShowcase</name>
     <filename>inet.showcases.wireless.power.PowerConsumptionShowcase.html</filename>
@@ -5717,8 +5753,8 @@
     <filename>inet.tutorials.queueing.ServerTutorialStep.html</filename>
   </compound>
   <compound kind="class">
-    <name>inet.clock.model.SettableClock</name>
-    <filename>inet.clock.model.SettableClock.html</filename>
+    <name>inet.clock.servo.ServoClockBase</name>
+    <filename>inet.clock.servo.ServoClockBase.html</filename>
   </compound>
   <compound kind="class">
     <name>inet.linklayer.shortcut.ShortcutInterface</name>
@@ -6509,12 +6545,12 @@
     <filename>inet.tests.ethernet.TwoHosts.html</filename>
   </compound>
   <compound kind="class">
-    <name>inet.showcases.tsn.timesynchronization.gptp.TwoMasterClocksRingGptpShowcase</name>
-    <filename>inet.showcases.tsn.timesynchronization.gptp.TwoMasterClocksRingGptpShowcase.html</filename>
+    <name>inet.showcases.tsn.timesynchronization.gptp_hotstandby.TwoMasterClocksRingGptpShowcase</name>
+    <filename>inet.showcases.tsn.timesynchronization.gptp_hotstandby.TwoMasterClocksRingGptpShowcase.html</filename>
   </compound>
   <compound kind="class">
-    <name>inet.showcases.tsn.timesynchronization.gptp.TwoMasterClocksTreeGptpShowcase</name>
-    <filename>inet.showcases.tsn.timesynchronization.gptp.TwoMasterClocksTreeGptpShowcase.html</filename>
+    <name>inet.showcases.tsn.timesynchronization.gptp_hotstandby.TwoMasterClocksTreeGptpShowcase</name>
+    <filename>inet.showcases.tsn.timesynchronization.gptp_hotstandby.TwoMasterClocksTreeGptpShowcase.html</filename>
   </compound>
   <compound kind="class">
     <name>inet.examples.ospfv2.areas.TwoNetsArea</name>

doc/src/users-guide/ch-clock.rst

@@ -54,12 +54,25 @@ return values. The interface contains functions such as :fun:`getClockTime()`,
 :fun:`cancelClockEvent()`.
 
 INET contains optional clock modules (not used by default) at the network node
-and the network interface levels. The following clock models are available:
+and the network interface levels. The following simple clock models are available:
 
 -  :ned:`IdealClock`: clock time is identical to the simulation time.
 -  :ned:`OscillatorBasedClock`: clock time is the number of oscillator ticks
    multiplied by the nominal tick length.
--  :ned:`SettableClock`: a clock that can be set to a different clock time.
+
+Above clock models are not adjustable during runtime.
+To this end, INET provides several clocks with an adjustable time and drift rate.
+These clocks are based on the :ned:`ServoClockBase` extending the :ned:`OscillatorBasedClock`:
+
+-  :ned:`InstantServoClock`: A simple clock servo module supports jumping its clock to another time and optionally
+   adjusting the drift rate. This allows for a simple synchronization with another clock.
+-  :ned:`PiServoClock`: A PI-based servo clock using proportional (kp) and integral (ki) gains
+   to in sync with another time source source while smoothly adjusting the drift rate.
+
+
+If multiple clocks are needed INET provides a :ned:`MultiClock`.
+This clock manages holds multiple subclocks with a programmatically switchable active clock.
+This is for example useful for multi-domain gPTP synchronization.
 
 Clock Time
 ----------
@@ -134,7 +147,7 @@ provides clocks and oscillators that implement the interface required by the
 oscillator states from the :ned:`ScenarioManager` XML script and also to mix
 these operations with many other supported operations.
 
-For example, the :ned:`SettableClock` model supports setting the clock time and
+For example, the :ned:`InstantServoClock` model supports setting the clock time and
 optionally resetting the oscillator at a specific moment of simulation time
 as follows: