xref: /freebsd/contrib/ntp/html/ntpdsim_new.html (revision aa0a1e58)
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
3<html>
4
5	<head>
6		<meta http-equiv="content-type" content="text/html;charset=iso-8859-1">
7		<meta name="generator" content="HTML Tidy, see www.w3.org">
8		<title>ntpdsim - Network Time Protocol (NTP) simulator</title>
9		<link href="scripts/style.css" type="text/css" rel="stylesheet">
10	</head>
11
12	<body>
13		<h3><tt>ntpdsim</tt> - Network Time Protocol (NTP) simulator</h3>
14		<img src="pic/alice47.gif" alt="gif" align="left"><a href="http://www.eecis.udel.edu/%7emills/pictures.html">from <i>Alice's Adventures in Wonderland</i>, Lewis Carroll</a>
15		<p>The mushroom knows all the command line options.</p>
16		<p>Last update: <csobj format="ShortTime" h="25" locale="00000409" region="0" t="DateTime" w="61">21:32</csobj> UTC <csobj format="LongDate" h="25" locale="00000409" region="0" t="DateTime" w="223">Friday, June 16, 2006</csobj></p>
17		<br clear="left">
18		<h4>Related Links</h4>
19		<script type="text/javascript" language="javascript" src="scripts/links7.txt"></script>
20		<h4>Table of Contents</h4>
21		<ul>
22			<li><a href="#description">Description</a><br>
23			<li><a href="#configuration">Configuration</a>
24			<li><a href="#sample">Sample Configuration File</a>
25		</ul>
26		<h4 id="description">Description</h4>
27		<p>The ntpdsim program is used to simulate and study the behavior of an NTP daemon that derives its time from a number of different simulated time sources (servers). Each simulated server can be configured to have a different time offset, frequency offset, propagation delay, processing delay, network jitter and oscillator wander.</p>
28		<p>The ntpdsim program runs all the same selection, mitigation, and discipline algorithms as the actual ntpd daemon at the client. (It actually uses the same code). However, the input/output routines and servers are simulated. That is, instead of sending the client messages over the network to the actual servers, the client messages are intercepted by the ntpdsim program, which then generates the replies to those messages. The reply messages are carefully "inserted" into the input queue of the client at the right time according to the specified server properties (like propagation delay).</p>
29		<p>Each simulated server runs according to a specified script that describes the server properties at a particular time. Each script consists of a series of consecutive acts. Each act runs for a particular duration and specifies the frequency offset, propagation delay, processing delay, network jitter and oscillator wander of the server for that duration. Once the duration of an act expires, the simulated server reconfigures itself according to the properties specified in the next act.</p>
30		<h4 id="configuration">Configuration</h4>
31		<p>The ntpdsim program is configured by providing a configuration file at startup. The crux of the simulator configuration is specified using a <tt>simulate</tt> command, the syntax of which is given below. Note that all time quantities are in seconds and all frequency quantities are in parts per million (PPM):</p>
32		<p>&lt;<i>simulate_command</i>&gt; ::= <tt>simulate</tt> { &lt;<i>init_statement_list</i>&gt; &lt;<i>server_list</i>&gt; }<br>
33		&lt;<i>init_statement_list</i>&gt; ::= &lt;init_statement_list&gt; &lt;init_statement&gt; | &lt;init_statement&gt;<br>
34		&lt;<i>init_statement</i>&gt; ::= <tt>beep_delay</tt> = &lt;number&gt; | <tt>simulation_duration</tt> = &lt;number&gt;<br>
35		&lt;<i>server_list</i>&gt; ::= &lt;<i>server_list</i>&gt; &lt;server&gt; | &lt;server&gt;<br>
36		&lt;<i>server_list</i>&gt; ::= <tt>server</tt> = &lt;address&gt; { <tt>server_offset</tt> = &lt;number&gt; &lt;act_list&gt; }<br>
37		&lt;<i>act_list</i>&gt; ::= &lt;<i>act_list</i>&gt; &lt;<i>act</i>&gt; | &lt;<i>act</i>&gt;<br>
38		&lt;<i>act</i>&gt; ::= <tt>duration</tt> = &lt;number&gt; { &lt;<i>act_stmt_list</i>&gt; }<br>
39		&lt;<i>act_stmt_list</i>&gt; ::= &lt;<i>act_stmt_list</i>&gt; &lt;<i>act_stmt</i>&gt; | &lt;<i>act_stmt</i>&gt;<br>
40		&lt;<i>act_stmt</i>&gt; ::= <tt>freq_offset</tt> = &lt;number&gt; | <tt>wander</tt> = &lt;number&gt; | <tt>jitter</tt> = &lt;number&gt; | <tt>prop_delay</tt> = &lt;number&gt; | <tt>proc_delay</tt> = &lt;number&gt;</p>
41		<p>In addition to the simulate command, other standard NTP configuration commands can be specified. These commands have the same meaning as in the ntpd configuration. Note that newlines are <b>not</b> significant within the simulate command even though they are used to mark the end of a normal NTP configuration command.</p>
42		<h4 id="sample">Sample Configuration File</h4>
43		<p>A sample ntpdsim configuration file is given below. It specifies two simulated servers, each of which has two acts.</p>
44	<pre>
45    # Client configuration
46    disable kernel
47    server pogo
48    driftfile ./ntp.drift
49    statsdir ./ntpstats/
50    filegen loopstats type day enable
51    filegen peerstats type day enable
52
53    # Simulation configuration
54    simulate {
55        simulation_duration = 86400
56        beep_delay = 3600
57
58        # Server 1
59	server = louie.udel.edu {
60	    server_offset = 0
61            duration = 50000 {
62		freq_offset = 400
63		wander = 1.0
64		jitter = 0.001
65		prop_delay = 0.001
66		proc_delay = 0.001
67	    }
68            duration = 6400 {
69		freq_offset = 200
70		wander = 1.0
71		jitter = 0.001
72		prop_delay = 0.001
73		proc_delay = 0.001
74	    }
75	}
76
77        # Server 2
78	server = baldwin.udel.edu {
79	    server_offset = 0.02
80	    duration = 10000 {
81		freq_offset = 400
82		wander = 1.0
83		jitter = 0.001
84		prop_delay = 0.5
85		proc_delay = 0.001
86	    }
87	    duration = 60000 {
88		freq_offset = 200
89		wander = 1.0
90		jitter = 0.05
91		prop_delay = 0.005
92		proc_delay = 0.001
93	    }
94	}
95    }
96  </pre>
97		<hr>
98		<address><a href="mailto:skamboj@udel.edu">Sachin Kamboj</a></address>
99		<script type="text/javascript" language="javascript" src="scripts/footer.txt"></script>
100	</body>
101
102</html>
103