1 /*****************************************************************************
3 * Monitoring check_ntp plugin
6 * Copyright (c) 2006 Sean Finney <seanius@seanius.net>
7 * Copyright (c) 2006-2008 Monitoring Plugins Development Team
11 * This file contains the check_ntp plugin
13 * This plugin to check ntp servers independant of any commandline
14 * programs or external libraries.
17 * This program is free software: you can redistribute it and/or modify
18 * it under the terms of the GNU General Public License as published by
19 * the Free Software Foundation, either version 3 of the License, or
20 * (at your option) any later version.
22 * This program is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU General Public License for more details.
27 * You should have received a copy of the GNU General Public License
28 * along with this program. If not, see <http://www.gnu.org/licenses/>.
31 *****************************************************************************/
33 const char *progname
= "check_ntp";
34 const char *copyright
= "2006-2008";
35 const char *email
= "devel@monitoring-plugins.org";
41 static char *server_address
=NULL
;
43 static short do_offset
=0;
44 static char *owarn
="60";
45 static char *ocrit
="120";
46 static short do_jitter
=0;
47 static char *jwarn
="5000";
48 static char *jcrit
="10000";
50 int process_arguments (int, char **);
51 thresholds
*offset_thresholds
= NULL
;
52 thresholds
*jitter_thresholds
= NULL
;
53 void print_help (void);
54 void print_usage (void);
56 /* number of times to perform each request to get a good average. */
61 /* max size of control message data */
62 #define MAX_CM_SIZE 468
64 /* this structure holds everything in an ntp request/response as per rfc1305 */
66 uint8_t flags
; /* byte with leapindicator,vers,mode. see macros */
67 uint8_t stratum
; /* clock stratum */
68 int8_t poll
; /* polling interval */
69 int8_t precision
; /* precision of the local clock */
70 int32_t rtdelay
; /* total rt delay, as a fixed point num. see macros */
71 uint32_t rtdisp
; /* like above, but for max err to primary src */
72 uint32_t refid
; /* ref clock identifier */
73 uint64_t refts
; /* reference timestamp. local time local clock */
74 uint64_t origts
; /* time at which request departed client */
75 uint64_t rxts
; /* time at which request arrived at server */
76 uint64_t txts
; /* time at which request departed server */
79 /* this structure holds data about results from querying offset from a peer */
81 time_t waiting
; /* ts set when we started waiting for a response */
82 int num_responses
; /* number of successfully recieved responses */
83 uint8_t stratum
; /* copied verbatim from the ntp_message */
84 double rtdelay
; /* converted from the ntp_message */
85 double rtdisp
; /* converted from the ntp_message */
86 double offset
[AVG_NUM
]; /* offsets from each response */
87 uint8_t flags
; /* byte with leapindicator,vers,mode. see macros */
90 /* this structure holds everything in an ntp control message as per rfc1305 */
92 uint8_t flags
; /* byte with leapindicator,vers,mode. see macros */
93 uint8_t op
; /* R,E,M bits and Opcode */
94 uint16_t seq
; /* Packet sequence */
95 uint16_t status
; /* Clock status */
96 uint16_t assoc
; /* Association */
97 uint16_t offset
; /* Similar to TCP sequence # */
98 uint16_t count
; /* # bytes of data */
99 char data
[MAX_CM_SIZE
]; /* ASCII data of the request */
100 /* NB: not necessarily NULL terminated! */
101 } ntp_control_message
;
103 /* this is an association/status-word pair found in control packet reponses */
107 } ntp_assoc_status_pair
;
109 /* bits 1,2 are the leap indicator */
111 #define LI(x) ((x&LI_MASK)>>6)
112 #define LI_SET(x,y) do{ x |= ((y<<6)&LI_MASK); }while(0)
113 /* and these are the values of the leap indicator */
114 #define LI_NOWARNING 0x00
115 #define LI_EXTRASEC 0x01
116 #define LI_MISSINGSEC 0x02
117 #define LI_ALARM 0x03
118 /* bits 3,4,5 are the ntp version */
120 #define VN(x) ((x&VN_MASK)>>3)
121 #define VN_SET(x,y) do{ x |= ((y<<3)&VN_MASK); }while(0)
122 #define VN_RESERVED 0x02
123 /* bits 6,7,8 are the ntp mode */
124 #define MODE_MASK 0x07
125 #define MODE(x) (x&MODE_MASK)
126 #define MODE_SET(x,y) do{ x |= (y&MODE_MASK); }while(0)
127 /* here are some values */
128 #define MODE_CLIENT 0x03
129 #define MODE_CONTROLMSG 0x06
130 /* In control message, bits 8-10 are R,E,M bits */
131 #define REM_MASK 0xe0
132 #define REM_RESP 0x80
133 #define REM_ERROR 0x40
134 #define REM_MORE 0x20
135 /* In control message, bits 11 - 15 are opcode */
137 #define OP_SET(x,y) do{ x |= (y&OP_MASK); }while(0)
138 #define OP_READSTAT 0x01
139 #define OP_READVAR 0x02
140 /* In peer status bytes, bits 6,7,8 determine clock selection status */
141 #define PEER_SEL(x) ((ntohs(x)>>8)&0x07)
142 #define PEER_INCLUDED 0x04
143 #define PEER_SYNCSOURCE 0x06
146 ** a note about the 32-bit "fixed point" numbers:
148 they are divided into halves, each being a 16-bit int in network byte order:
149 - the first 16 bits are an int on the left side of a decimal point.
150 - the second 16 bits represent a fraction n/(2^16)
151 likewise for the 64-bit "fixed point" numbers with everything doubled :)
154 /* macros to access the left/right 16 bits of a 32-bit ntp "fixed point"
155 number. note that these can be used as lvalues too */
156 #define L16(x) (((uint16_t*)&x)[0])
157 #define R16(x) (((uint16_t*)&x)[1])
158 /* macros to access the left/right 32 bits of a 64-bit ntp "fixed point"
159 number. these too can be used as lvalues */
160 #define L32(x) (((uint32_t*)&x)[0])
161 #define R32(x) (((uint32_t*)&x)[1])
163 /* ntp wants seconds since 1/1/00, epoch is 1/1/70. this is the difference */
164 #define EPOCHDIFF 0x83aa7e80UL
166 /* extract a 32-bit ntp fixed point number into a double */
167 #define NTP32asDOUBLE(x) (ntohs(L16(x)) + (double)ntohs(R16(x))/65536.0)
169 /* likewise for a 64-bit ntp fp number */
170 #define NTP64asDOUBLE(n) (double)(((uint64_t)n)?\
171 (ntohl(L32(n))-EPOCHDIFF) + \
172 (.00000001*(0.5+(double)(ntohl(R32(n))/42.94967296))):\
175 /* convert a struct timeval to a double */
176 #define TVasDOUBLE(x) (double)(x.tv_sec+(0.000001*x.tv_usec))
178 /* convert an ntp 64-bit fp number to a struct timeval */
179 #define NTP64toTV(n,t) \
180 do{ if(!n) t.tv_sec = t.tv_usec = 0; \
182 t.tv_sec=ntohl(L32(n))-EPOCHDIFF; \
183 t.tv_usec=(int)(0.5+(double)(ntohl(R32(n))/4294.967296)); \
187 /* convert a struct timeval to an ntp 64-bit fp number */
188 #define TVtoNTP64(t,n) \
189 do{ if(!t.tv_usec && !t.tv_sec) n=0x0UL; \
191 L32(n)=htonl(t.tv_sec + EPOCHDIFF); \
192 R32(n)=htonl((uint64_t)((4294.967296*t.tv_usec)+.5)); \
196 /* NTP control message header is 12 bytes, plus any data in the data
197 * field, plus null padding to the nearest 32-bit boundary per rfc.
199 #define SIZEOF_NTPCM(m) (12+ntohs(m.count)+((ntohs(m.count)%4)?4-(ntohs(m.count)%4):0))
201 /* finally, a little helper or two for debugging: */
202 #define DBG(x) do{if(verbose>1){ x; }}while(0);
203 #define PRINTSOCKADDR(x) \
205 printf("%u.%u.%u.%u", (x>>24)&0xff, (x>>16)&0xff, (x>>8)&0xff, x&0xff);\
208 /* calculate the offset of the local clock */
209 static inline double calc_offset(const ntp_message
*m
, const struct timeval
*t
){
210 double client_tx
, peer_rx
, peer_tx
, client_rx
;
211 client_tx
= NTP64asDOUBLE(m
->origts
);
212 peer_rx
= NTP64asDOUBLE(m
->rxts
);
213 peer_tx
= NTP64asDOUBLE(m
->txts
);
214 client_rx
=TVasDOUBLE((*t
));
215 return (.5*((peer_tx
-client_rx
)+(peer_rx
-client_tx
)));
218 /* print out a ntp packet in human readable/debuggable format */
219 void print_ntp_message(const ntp_message
*p
){
220 struct timeval ref
, orig
, rx
, tx
;
222 NTP64toTV(p
->refts
,ref
);
223 NTP64toTV(p
->origts
,orig
);
224 NTP64toTV(p
->rxts
,rx
);
225 NTP64toTV(p
->txts
,tx
);
227 printf("packet contents:\n");
228 printf("\tflags: 0x%.2x\n", p
->flags
);
229 printf("\t li=%d (0x%.2x)\n", LI(p
->flags
), p
->flags
&LI_MASK
);
230 printf("\t vn=%d (0x%.2x)\n", VN(p
->flags
), p
->flags
&VN_MASK
);
231 printf("\t mode=%d (0x%.2x)\n", MODE(p
->flags
), p
->flags
&MODE_MASK
);
232 printf("\tstratum = %d\n", p
->stratum
);
233 printf("\tpoll = %g\n", pow(2, p
->poll
));
234 printf("\tprecision = %g\n", pow(2, p
->precision
));
235 printf("\trtdelay = %-.16g\n", NTP32asDOUBLE(p
->rtdelay
));
236 printf("\trtdisp = %-.16g\n", NTP32asDOUBLE(p
->rtdisp
));
237 printf("\trefid = %x\n", p
->refid
);
238 printf("\trefts = %-.16g\n", NTP64asDOUBLE(p
->refts
));
239 printf("\torigts = %-.16g\n", NTP64asDOUBLE(p
->origts
));
240 printf("\trxts = %-.16g\n", NTP64asDOUBLE(p
->rxts
));
241 printf("\ttxts = %-.16g\n", NTP64asDOUBLE(p
->txts
));
244 void print_ntp_control_message(const ntp_control_message
*p
){
246 const ntp_assoc_status_pair
*peer
=NULL
;
248 printf("control packet contents:\n");
249 printf("\tflags: 0x%.2x , 0x%.2x\n", p
->flags
, p
->op
);
250 printf("\t li=%d (0x%.2x)\n", LI(p
->flags
), p
->flags
&LI_MASK
);
251 printf("\t vn=%d (0x%.2x)\n", VN(p
->flags
), p
->flags
&VN_MASK
);
252 printf("\t mode=%d (0x%.2x)\n", MODE(p
->flags
), p
->flags
&MODE_MASK
);
253 printf("\t response=%d (0x%.2x)\n", (p
->op
&REM_RESP
)>0, p
->op
&REM_RESP
);
254 printf("\t more=%d (0x%.2x)\n", (p
->op
&REM_MORE
)>0, p
->op
&REM_MORE
);
255 printf("\t error=%d (0x%.2x)\n", (p
->op
&REM_ERROR
)>0, p
->op
&REM_ERROR
);
256 printf("\t op=%d (0x%.2x)\n", p
->op
&OP_MASK
, p
->op
&OP_MASK
);
257 printf("\tsequence: %d (0x%.2x)\n", ntohs(p
->seq
), ntohs(p
->seq
));
258 printf("\tstatus: %d (0x%.2x)\n", ntohs(p
->status
), ntohs(p
->status
));
259 printf("\tassoc: %d (0x%.2x)\n", ntohs(p
->assoc
), ntohs(p
->assoc
));
260 printf("\toffset: %d (0x%.2x)\n", ntohs(p
->offset
), ntohs(p
->offset
));
261 printf("\tcount: %d (0x%.2x)\n", ntohs(p
->count
), ntohs(p
->count
));
262 numpeers
=ntohs(p
->count
)/(sizeof(ntp_assoc_status_pair
));
263 if(p
->op
&REM_RESP
&& p
->op
&OP_READSTAT
){
264 peer
=(ntp_assoc_status_pair
*)p
->data
;
265 for(i
=0;i
<numpeers
;i
++){
266 printf("\tpeer id %.2x status %.2x",
267 ntohs(peer
[i
].assoc
), ntohs(peer
[i
].status
));
268 if (PEER_SEL(peer
[i
].status
) >= PEER_INCLUDED
){
269 if(PEER_SEL(peer
[i
].status
) >= PEER_SYNCSOURCE
){
270 printf(" <-- current sync source");
272 printf(" <-- current sync candidate");
280 void setup_request(ntp_message
*p
){
283 memset(p
, 0, sizeof(ntp_message
));
284 LI_SET(p
->flags
, LI_ALARM
);
286 MODE_SET(p
->flags
, MODE_CLIENT
);
288 p
->precision
=(int8_t)0xfa;
289 L16(p
->rtdelay
)=htons(1);
290 L16(p
->rtdisp
)=htons(1);
292 gettimeofday(&t
, NULL
);
293 TVtoNTP64(t
,p
->txts
);
296 /* select the "best" server from a list of servers, and return its index.
297 * this is done by filtering servers based on stratum, dispersion, and
298 * finally round-trip delay. */
299 int best_offset_server(const ntp_server_results
*slist
, int nservers
){
300 int cserver
=0, best_server
=-1;
302 /* for each server */
303 for(cserver
=0; cserver
<nservers
; cserver
++){
304 /* We don't want any servers that fails these tests */
305 /* Sort out servers that didn't respond or responede with a 0 stratum;
306 * stratum 0 is for reference clocks so no NTP server should ever report
308 if ( slist
[cserver
].stratum
== 0){
309 if (verbose
) printf("discarding peer %d: stratum=%d\n", cserver
, slist
[cserver
].stratum
);
312 /* Sort out servers with error flags */
313 if ( LI(slist
[cserver
].flags
) == LI_ALARM
){
314 if (verbose
) printf("discarding peer %d: flags=%d\n", cserver
, LI(slist
[cserver
].flags
));
318 /* If we don't have a server yet, use the first one */
319 if (best_server
== -1) {
320 best_server
= cserver
;
321 DBG(printf("using peer %d as our first candidate\n", best_server
));
325 /* compare the server to the best one we've seen so far */
326 /* does it have an equal or better stratum? */
327 DBG(printf("comparing peer %d with peer %d\n", cserver
, best_server
));
328 if(slist
[cserver
].stratum
<= slist
[best_server
].stratum
){
329 DBG(printf("stratum for peer %d <= peer %d\n", cserver
, best_server
));
330 /* does it have an equal or better dispersion? */
331 if(slist
[cserver
].rtdisp
<= slist
[best_server
].rtdisp
){
332 DBG(printf("dispersion for peer %d <= peer %d\n", cserver
, best_server
));
333 /* does it have a better rtdelay? */
334 if(slist
[cserver
].rtdelay
< slist
[best_server
].rtdelay
){
335 DBG(printf("rtdelay for peer %d < peer %d\n", cserver
, best_server
));
336 best_server
= cserver
;
337 DBG(printf("peer %d is now our best candidate\n", best_server
));
343 if(best_server
>= 0) {
344 DBG(printf("best server selected: peer %d\n", best_server
));
347 DBG(printf("no peers meeting synchronization criteria :(\n"));
352 /* do everything we need to get the total average offset
353 * - we use a certain amount of parallelization with poll() to ensure
354 * we don't waste time sitting around waiting for single packets.
355 * - we also "manually" handle resolving host names and connecting, because
356 * we have to do it in a way that our lazy macros don't handle currently :( */
357 double offset_request(const char *host
, int *status
){
358 int i
=0, ga_result
=0, num_hosts
=0, *socklist
=NULL
, respnum
=0;
359 int servers_completed
=0, one_read
=0, servers_readable
=0, best_index
=-1;
360 time_t now_time
=0, start_ts
=0;
361 ntp_message
*req
=NULL
;
362 double avg_offset
=0.;
363 struct timeval recv_time
;
364 struct addrinfo
*ai
=NULL
, *ai_tmp
=NULL
, hints
;
365 struct pollfd
*ufds
=NULL
;
366 ntp_server_results
*servers
=NULL
;
368 /* setup hints to only return results from getaddrinfo that we'd like */
369 memset(&hints
, 0, sizeof(struct addrinfo
));
370 hints
.ai_family
= address_family
;
371 hints
.ai_protocol
= IPPROTO_UDP
;
372 hints
.ai_socktype
= SOCK_DGRAM
;
374 /* fill in ai with the list of hosts resolved by the host name */
375 ga_result
= getaddrinfo(host
, "123", &hints
, &ai
);
377 die(STATE_UNKNOWN
, "error getting address for %s: %s\n",
378 host
, gai_strerror(ga_result
));
381 /* count the number of returned hosts, and allocate stuff accordingly */
382 for(ai_tmp
=ai
; ai_tmp
!=NULL
; ai_tmp
=ai_tmp
->ai_next
){ num_hosts
++; }
383 req
=(ntp_message
*)malloc(sizeof(ntp_message
)*num_hosts
);
384 if(req
==NULL
) die(STATE_UNKNOWN
, "can not allocate ntp message array");
385 socklist
=(int*)malloc(sizeof(int)*num_hosts
);
386 if(socklist
==NULL
) die(STATE_UNKNOWN
, "can not allocate socket array");
387 ufds
=(struct pollfd
*)malloc(sizeof(struct pollfd
)*num_hosts
);
388 if(ufds
==NULL
) die(STATE_UNKNOWN
, "can not allocate socket array");
389 servers
=(ntp_server_results
*)malloc(sizeof(ntp_server_results
)*num_hosts
);
390 if(servers
==NULL
) die(STATE_UNKNOWN
, "can not allocate server array");
391 memset(servers
, 0, sizeof(ntp_server_results
)*num_hosts
);
392 DBG(printf("Found %d peers to check\n", num_hosts
));
394 /* setup each socket for writing, and the corresponding struct pollfd */
397 socklist
[i
]=socket(ai_tmp
->ai_family
, SOCK_DGRAM
, IPPROTO_UDP
);
398 if(socklist
[i
] == -1) {
400 die(STATE_UNKNOWN
, "can not create new socket");
402 if(connect(socklist
[i
], ai_tmp
->ai_addr
, ai_tmp
->ai_addrlen
)){
403 /* don't die here, because it is enough if there is one server
404 answering in time. This also would break for dual ipv4/6 stacked
405 ntp servers when the client only supports on of them.
407 DBG(printf("can't create socket connection on peer %i: %s\n", i
, strerror(errno
)));
409 ufds
[i
].fd
=socklist
[i
];
410 ufds
[i
].events
=POLLIN
;
413 ai_tmp
= ai_tmp
->ai_next
;
416 /* now do AVG_NUM checks to each host. we stop before timeout/2 seconds
417 * have passed in order to ensure post-processing and jitter time. */
418 now_time
=start_ts
=time(NULL
);
419 while(servers_completed
<num_hosts
&& now_time
-start_ts
<= socket_timeout
/2){
420 /* loop through each server and find each one which hasn't
421 * been touched in the past second or so and is still lacking
422 * some responses. for each of these servers, send a new request,
423 * and update the "waiting" timestamp with the current time. */
426 for(i
=0; i
<num_hosts
; i
++){
427 if(servers
[i
].waiting
<now_time
&& servers
[i
].num_responses
<AVG_NUM
){
428 if(verbose
&& servers
[i
].waiting
!= 0) printf("re-");
429 if(verbose
) printf("sending request to peer %d\n", i
);
430 setup_request(&req
[i
]);
431 write(socklist
[i
], &req
[i
], sizeof(ntp_message
));
432 servers
[i
].waiting
=now_time
;
437 /* quickly poll for any sockets with pending data */
438 servers_readable
=poll(ufds
, num_hosts
, 100);
439 if(servers_readable
==-1){
440 perror("polling ntp sockets");
441 die(STATE_UNKNOWN
, "communication errors");
444 /* read from any sockets with pending data */
445 for(i
=0; servers_readable
&& i
<num_hosts
; i
++){
446 if(ufds
[i
].revents
&POLLIN
&& servers
[i
].num_responses
< AVG_NUM
){
448 printf("response from peer %d: ", i
);
451 read(ufds
[i
].fd
, &req
[i
], sizeof(ntp_message
));
452 gettimeofday(&recv_time
, NULL
);
453 DBG(print_ntp_message(&req
[i
]));
454 respnum
=servers
[i
].num_responses
++;
455 servers
[i
].offset
[respnum
]=calc_offset(&req
[i
], &recv_time
);
457 printf("offset %.10g\n", servers
[i
].offset
[respnum
]);
459 servers
[i
].stratum
=req
[i
].stratum
;
460 servers
[i
].rtdisp
=NTP32asDOUBLE(req
[i
].rtdisp
);
461 servers
[i
].rtdelay
=NTP32asDOUBLE(req
[i
].rtdelay
);
462 servers
[i
].waiting
=0;
463 servers
[i
].flags
=req
[i
].flags
;
466 if(servers
[i
].num_responses
==AVG_NUM
) servers_completed
++;
469 /* lather, rinse, repeat. */
473 die(STATE_CRITICAL
, "NTP CRITICAL: No response from NTP server\n");
476 /* now, pick the best server from the list */
477 best_index
=best_offset_server(servers
, num_hosts
);
479 *status
=STATE_UNKNOWN
;
481 /* finally, calculate the average offset */
482 for(i
=0; i
<servers
[best_index
].num_responses
;i
++){
483 avg_offset
+=servers
[best_index
].offset
[i
];
485 avg_offset
/=servers
[best_index
].num_responses
;
489 /* FIXME: Not closing the socket to avoid re-use of the local port
490 * which can cause old NTP packets to be read instead of NTP control
491 * packets in jitter_request(). THERE MUST BE ANOTHER WAY...
492 * for(j=0; j<num_hosts; j++){ close(socklist[j]); } */
499 if(verbose
) printf("overall average offset: %.10g\n", avg_offset
);
504 setup_control_request(ntp_control_message
*p
, uint8_t opcode
, uint16_t seq
){
505 memset(p
, 0, sizeof(ntp_control_message
));
506 LI_SET(p
->flags
, LI_NOWARNING
);
507 VN_SET(p
->flags
, VN_RESERVED
);
508 MODE_SET(p
->flags
, MODE_CONTROLMSG
);
509 OP_SET(p
->op
, opcode
);
511 /* Remaining fields are zero for requests */
514 /* XXX handle responses with the error bit set */
515 double jitter_request(int *status
){
516 int conn
=-1, i
, npeers
=0, num_candidates
=0, syncsource_found
=0;
517 int run
=0, min_peer_sel
=PEER_INCLUDED
, num_selected
=0, num_valid
=0;
518 int peers_size
=0, peer_offset
=0;
519 ntp_assoc_status_pair
*peers
=NULL
;
520 ntp_control_message req
;
521 const char *getvar
= "jitter";
522 double rval
= 0.0, jitter
= -1.0;
523 char *startofvalue
=NULL
, *nptr
=NULL
;
526 /* Long-winded explanation:
527 * Getting the jitter requires a number of steps:
528 * 1) Send a READSTAT request.
529 * 2) Interpret the READSTAT reply
530 * a) The data section contains a list of peer identifiers (16 bits)
531 * and associated status words (16 bits)
532 * b) We want the value of 0x06 in the SEL (peer selection) value,
533 * which means "current synchronizatin source". If that's missing,
534 * we take anything better than 0x04 (see the rfc for details) but
535 * set a minimum of warning.
536 * 3) Send a READVAR request for information on each peer identified
537 * in 2b greater than the minimum selection value.
538 * 4) Extract the jitter value from the data[] (it's ASCII)
540 my_udp_connect(server_address
, 123, &conn
);
542 /* keep sending requests until the server stops setting the
543 * REM_MORE bit, though usually this is only 1 packet. */
545 setup_control_request(&req
, OP_READSTAT
, 1);
546 DBG(printf("sending READSTAT request"));
547 write(conn
, &req
, SIZEOF_NTPCM(req
));
548 DBG(print_ntp_control_message(&req
));
549 /* Attempt to read the largest size packet possible */
550 req
.count
=htons(MAX_CM_SIZE
);
551 DBG(printf("receiving READSTAT response"))
552 read(conn
, &req
, SIZEOF_NTPCM(req
));
553 DBG(print_ntp_control_message(&req
));
554 /* Each peer identifier is 4 bytes in the data section, which
555 * we represent as a ntp_assoc_status_pair datatype.
557 peers_size
+=ntohs(req
.count
);
558 if((tmp
=realloc(peers
, peers_size
)) == NULL
)
559 free(peers
), die(STATE_UNKNOWN
, "can not (re)allocate 'peers' buffer\n");
561 memcpy((void*)((ptrdiff_t)peers
+peer_offset
), (void*)req
.data
, ntohs(req
.count
));
562 npeers
=peers_size
/sizeof(ntp_assoc_status_pair
);
563 peer_offset
+=ntohs(req
.count
);
564 } while(req
.op
&REM_MORE
);
566 /* first, let's find out if we have a sync source, or if there are
567 * at least some candidates. in the case of the latter we'll issue
568 * a warning but go ahead with the check on them. */
569 for (i
= 0; i
< npeers
; i
++){
570 if (PEER_SEL(peers
[i
].status
) >= PEER_INCLUDED
){
572 if(PEER_SEL(peers
[i
].status
) >= PEER_SYNCSOURCE
){
574 min_peer_sel
=PEER_SYNCSOURCE
;
578 if(verbose
) printf("%d candiate peers available\n", num_candidates
);
579 if(verbose
&& syncsource_found
) printf("synchronization source found\n");
580 if(! syncsource_found
){
581 *status
= STATE_UNKNOWN
;
582 if(verbose
) printf("warning: no synchronization source found\n");
586 for (run
=0; run
<AVG_NUM
; run
++){
587 if(verbose
) printf("jitter run %d of %d\n", run
+1, AVG_NUM
);
588 for (i
= 0; i
< npeers
; i
++){
589 /* Only query this server if it is the current sync source */
590 if (PEER_SEL(peers
[i
].status
) >= min_peer_sel
){
591 char jitter_data
[MAX_CM_SIZE
+1];
592 size_t jitter_data_count
;
595 setup_control_request(&req
, OP_READVAR
, 2);
596 req
.assoc
= peers
[i
].assoc
;
597 /* By spec, putting the variable name "jitter" in the request
598 * should cause the server to provide _only_ the jitter value.
599 * thus reducing net traffic, guaranteeing us only a single
600 * datagram in reply, and making intepretation much simpler
602 /* Older servers doesn't know what jitter is, so if we get an
603 * error on the first pass we redo it with "dispersion" */
604 strncpy(req
.data
, getvar
, MAX_CM_SIZE
-1);
605 req
.count
= htons(strlen(getvar
));
606 DBG(printf("sending READVAR request...\n"));
607 write(conn
, &req
, SIZEOF_NTPCM(req
));
608 DBG(print_ntp_control_message(&req
));
610 req
.count
= htons(MAX_CM_SIZE
);
611 DBG(printf("receiving READVAR response...\n"));
612 read(conn
, &req
, SIZEOF_NTPCM(req
));
613 DBG(print_ntp_control_message(&req
));
615 if(req
.op
&REM_ERROR
&& strstr(getvar
, "jitter")) {
616 if(verbose
) printf("The 'jitter' command failed (old ntp server?)\nRestarting with 'dispersion'...\n");
617 getvar
= "dispersion";
623 /* get to the float value */
625 printf("parsing jitter from peer %.2x: ", ntohs(peers
[i
].assoc
));
627 if((jitter_data_count
= ntohs(req
.count
)) >= sizeof(jitter_data
)){
629 _("jitter response too large (%lu bytes)\n"),
630 (unsigned long)jitter_data_count
);
632 memcpy(jitter_data
, req
.data
, jitter_data_count
);
633 jitter_data
[jitter_data_count
] = '\0';
634 startofvalue
= strchr(jitter_data
, '=');
635 if(startofvalue
!= NULL
) {
637 jitter
= strtod(startofvalue
, &nptr
);
639 if(startofvalue
== NULL
|| startofvalue
==nptr
){
640 printf("warning: unable to read server jitter response.\n");
641 *status
= STATE_UNKNOWN
;
643 if(verbose
) printf("%g\n", jitter
);
650 printf("jitter parsed from %d/%d peers\n", num_valid
, num_selected
);
654 rval
= num_valid
? rval
/ num_valid
: -1.0;
657 if(peers
!=NULL
) free(peers
);
658 /* If we return -1.0, it means no synchronization source was found */
662 int process_arguments(int argc
, char **argv
){
665 static struct option longopts
[] = {
666 {"version", no_argument
, 0, 'V'},
667 {"help", no_argument
, 0, 'h'},
668 {"verbose", no_argument
, 0, 'v'},
669 {"use-ipv4", no_argument
, 0, '4'},
670 {"use-ipv6", no_argument
, 0, '6'},
671 {"warning", required_argument
, 0, 'w'},
672 {"critical", required_argument
, 0, 'c'},
673 {"jwarn", required_argument
, 0, 'j'},
674 {"jcrit", required_argument
, 0, 'k'},
675 {"timeout", required_argument
, 0, 't'},
676 {"hostname", required_argument
, 0, 'H'},
685 c
= getopt_long (argc
, argv
, "Vhv46w:c:j:k:t:H:", longopts
, &option
);
686 if (c
== -1 || c
== EOF
|| c
== 1)
695 print_revision(progname
, NP_VERSION
);
718 if(is_host(optarg
) == FALSE
)
719 usage2(_("Invalid hostname/address"), optarg
);
720 server_address
= strdup(optarg
);
723 socket_timeout
=atoi(optarg
);
726 address_family
= AF_INET
;
730 address_family
= AF_INET6
;
732 usage4 (_("IPv6 support not available"));
736 /* print short usage statement if args not parsable */
742 if(server_address
== NULL
){
743 usage4(_("Hostname was not supplied"));
749 char *perfd_offset (double offset
)
751 return fperfdata ("offset", offset
, "s",
752 TRUE
, offset_thresholds
->warning
->end
,
753 TRUE
, offset_thresholds
->critical
->end
,
757 char *perfd_jitter (double jitter
)
759 return fperfdata ("jitter", jitter
, "s",
760 do_jitter
, jitter_thresholds
->warning
->end
,
761 do_jitter
, jitter_thresholds
->critical
->end
,
765 int main(int argc
, char *argv
[]){
766 int result
, offset_result
, jitter_result
;
767 double offset
=0, jitter
=0;
768 char *result_line
, *perfdata_line
;
770 setlocale (LC_ALL
, "");
771 bindtextdomain (PACKAGE
, LOCALEDIR
);
772 textdomain (PACKAGE
);
774 result
= offset_result
= jitter_result
= STATE_OK
;
776 /* Parse extra opts if any */
777 argv
=np_extra_opts (&argc
, argv
, progname
);
779 if (process_arguments (argc
, argv
) == ERROR
)
780 usage4 (_("Could not parse arguments"));
782 set_thresholds(&offset_thresholds
, owarn
, ocrit
);
783 set_thresholds(&jitter_thresholds
, jwarn
, jcrit
);
785 /* initialize alarm signal handling */
786 signal (SIGALRM
, socket_timeout_alarm_handler
);
788 /* set socket timeout */
789 alarm (socket_timeout
);
791 offset
= offset_request(server_address
, &offset_result
);
792 /* check_ntp used to always return CRITICAL if offset_result == STATE_UNKNOWN.
793 * Now we'll only do that is the offset thresholds were set */
794 if (do_offset
&& offset_result
== STATE_UNKNOWN
) {
795 result
= STATE_CRITICAL
;
797 result
= get_status(fabs(offset
), offset_thresholds
);
800 /* If not told to check the jitter, we don't even send packets.
801 * jitter is checked using NTP control packets, which not all
802 * servers recognize. Trying to check the jitter on OpenNTPD
803 * (for example) will result in an error
806 jitter
=jitter_request(&jitter_result
);
807 result
= max_state_alt(result
, get_status(jitter
, jitter_thresholds
));
808 /* -1 indicates that we couldn't calculate the jitter
809 * Only overrides STATE_OK from the offset */
810 if(jitter
== -1.0 && result
== STATE_OK
)
811 result
= STATE_UNKNOWN
;
813 result
= max_state_alt(result
, jitter_result
);
816 case STATE_CRITICAL
:
817 xasprintf(&result_line
, _("NTP CRITICAL:"));
820 xasprintf(&result_line
, _("NTP WARNING:"));
823 xasprintf(&result_line
, _("NTP OK:"));
826 xasprintf(&result_line
, _("NTP UNKNOWN:"));
829 if(offset_result
== STATE_UNKNOWN
){
830 xasprintf(&result_line
, "%s %s", result_line
, _("Offset unknown"));
831 xasprintf(&perfdata_line
, "");
833 xasprintf(&result_line
, "%s %s %.10g secs", result_line
, _("Offset"), offset
);
834 xasprintf(&perfdata_line
, "%s", perfd_offset(offset
));
837 xasprintf(&result_line
, "%s, jitter=%f", result_line
, jitter
);
838 xasprintf(&perfdata_line
, "%s %s", perfdata_line
, perfd_jitter(jitter
));
840 printf("%s|%s\n", result_line
, perfdata_line
);
842 if(server_address
!=NULL
) free(server_address
);
848 void print_help(void){
849 print_revision(progname
, NP_VERSION
);
851 printf ("Copyright (c) 2006 Sean Finney\n");
852 printf (COPYRIGHT
, copyright
, email
);
854 printf ("%s\n", _("This plugin checks the selected ntp server"));
859 printf (UT_HELP_VRSN
);
860 printf (UT_EXTRA_OPTS
);
861 printf (UT_HOST_PORT
, 'p', "123");
863 printf (" %s\n", "-w, --warning=THRESHOLD");
864 printf (" %s\n", _("Offset to result in warning status (seconds)"));
865 printf (" %s\n", "-c, --critical=THRESHOLD");
866 printf (" %s\n", _("Offset to result in critical status (seconds)"));
867 printf (" %s\n", "-j, --jwarn=THRESHOLD");
868 printf (" %s\n", _("Warning threshold for jitter"));
869 printf (" %s\n", "-k, --jcrit=THRESHOLD");
870 printf (" %s\n", _("Critical threshold for jitter"));
871 printf (UT_CONN_TIMEOUT
, DEFAULT_SOCKET_TIMEOUT
);
875 printf("%s\n", _("Notes:"));
876 printf(UT_THRESHOLDS_NOTES
);
879 printf("%s\n", _("Examples:"));
880 printf(" %s\n", _("Normal offset check:"));
881 printf(" %s\n", ("./check_ntp -H ntpserv -w 0.5 -c 1"));
883 printf(" %s\n", _("Check jitter too, avoiding critical notifications if jitter isn't available"));
884 printf(" %s\n", _("(See Notes above for more details on thresholds formats):"));
885 printf(" %s\n", ("./check_ntp -H ntpserv -w 0.5 -c 1 -j -1:100 -k -1:200"));
889 printf ("%s\n", _("WARNING: check_ntp is deprecated. Please use check_ntp_peer or"));
890 printf ("%s\n\n", _("check_ntp_time instead."));
896 printf ("%s\n", _("WARNING: check_ntp is deprecated. Please use check_ntp_peer or"));
897 printf ("%s\n\n", _("check_ntp_time instead."));
898 printf ("%s\n", _("Usage:"));
899 printf(" %s -H <host> [-w <warn>] [-c <crit>] [-j <warn>] [-k <crit>] [-4|-6] [-v verbose]\n", progname
);