xref: /openbsd-src/usr.sbin/ntpd/control.c (revision d1df930ffab53da22f3324c32bed7ac5709915e6)
1 /*	$OpenBSD: control.c,v 1.13 2018/08/04 11:07:14 mestre Exp $ */
2 
3 /*
4  * Copyright (c) 2003, 2004 Henning Brauer <henning@openbsd.org>
5  * Copyright (c) 2012 Mike Miller <mmiller@mgm51.com>
6  *
7  * Permission to use, copy, modify, and distribute this software for any
8  * purpose with or without fee is hereby granted, provided that the above
9  * copyright notice and this permission notice appear in all copies.
10  *
11  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18  */
19 
20 #include <sys/types.h>
21 #include <sys/stat.h>
22 #include <sys/socket.h>
23 #include <sys/un.h>
24 #include <errno.h>
25 #include <math.h>
26 #include <stdio.h>
27 #include <stdlib.h>
28 #include <string.h>
29 #include <unistd.h>
30 #include <fcntl.h>
31 #include <err.h>
32 
33 #include "ntpd.h"
34 
35 #define	CONTROL_BACKLOG	5
36 
37 #define square(x) ((x) * (x))
38 
39 int
40 control_init(char *path)
41 {
42 	struct sockaddr_un	 sa;
43 	int			 fd;
44 	mode_t			 old_umask;
45 
46 	if ((fd = socket(AF_UNIX, SOCK_STREAM | SOCK_CLOEXEC, 0)) == -1) {
47 		log_warn("control_init: socket");
48 		return (-1);
49 	}
50 
51 	memset(&sa, 0, sizeof(sa));
52 	sa.sun_family = AF_UNIX;
53 	if (strlcpy(sa.sun_path, path, sizeof(sa.sun_path)) >=
54 	    sizeof(sa.sun_path))
55 		errx(1, "ctl socket name too long");
56 
57 	if (unlink(path) == -1)
58 		if (errno != ENOENT) {
59 			log_warn("control_init: unlink %s", path);
60 			close(fd);
61 			return (-1);
62 		}
63 
64 	old_umask = umask(S_IXUSR|S_IXGRP|S_IWOTH|S_IROTH|S_IXOTH);
65 	if (bind(fd, (struct sockaddr *)&sa, sizeof(sa)) == -1) {
66 		log_warn("control_init: bind: %s", path);
67 		close(fd);
68 		umask(old_umask);
69 		return (-1);
70 	}
71 	umask(old_umask);
72 
73 	if (chmod(path, S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP) == -1) {
74 		log_warn("control_init: chmod");
75 		close(fd);
76 		(void)unlink(path);
77 		return (-1);
78 	}
79 
80 	session_socket_nonblockmode(fd);
81 
82 	return (fd);
83 }
84 
85 int
86 control_listen(int fd)
87 {
88 	if (fd != -1 && listen(fd, CONTROL_BACKLOG) == -1) {
89 		log_warn("control_listen: listen");
90 		return (-1);
91 	}
92 
93 	return (0);
94 }
95 
96 void
97 control_shutdown(int fd)
98 {
99 	close(fd);
100 }
101 
102 int
103 control_accept(int listenfd)
104 {
105 	int			 connfd;
106 	socklen_t		 len;
107 	struct sockaddr_un	 sa;
108 	struct ctl_conn		*ctl_conn;
109 
110 	len = sizeof(sa);
111 	if ((connfd = accept(listenfd,
112 	    (struct sockaddr *)&sa, &len)) == -1) {
113 		if (errno != EWOULDBLOCK && errno != EINTR)
114 			log_warn("control_accept: accept");
115 		return (0);
116 	}
117 
118 	session_socket_nonblockmode(connfd);
119 
120 	if ((ctl_conn = calloc(1, sizeof(struct ctl_conn))) == NULL) {
121 		log_warn("control_accept");
122 		close(connfd);
123 		return (0);
124 	}
125 
126 	imsg_init(&ctl_conn->ibuf, connfd);
127 
128 	TAILQ_INSERT_TAIL(&ctl_conns, ctl_conn, entry);
129 
130 	return (1);
131 }
132 
133 struct ctl_conn *
134 control_connbyfd(int fd)
135 {
136 	struct ctl_conn	*c;
137 
138 	TAILQ_FOREACH(c, &ctl_conns, entry) {
139 		if (c->ibuf.fd == fd)
140 			break;
141 	}
142 
143 	return (c);
144 }
145 
146 int
147 control_close(int fd)
148 {
149 	struct ctl_conn	*c;
150 
151 	if ((c = control_connbyfd(fd)) == NULL) {
152 		log_warn("control_close: fd %d: not found", fd);
153 		return (0);
154 	}
155 
156 	msgbuf_clear(&c->ibuf.w);
157 	TAILQ_REMOVE(&ctl_conns, c, entry);
158 
159 	close(c->ibuf.fd);
160 	free(c);
161 
162 	return (1);
163 }
164 
165 int
166 control_dispatch_msg(struct pollfd *pfd, u_int *ctl_cnt)
167 {
168 	struct imsg		 imsg;
169 	struct ctl_conn		*c;
170 	struct ntp_peer		*p;
171 	struct ntp_sensor	*s;
172 	struct ctl_show_status	 c_status;
173 	struct ctl_show_peer	 c_peer;
174 	struct ctl_show_sensor	 c_sensor;
175 	int			 cnt;
176 	ssize_t			 n;
177 
178 	if ((c = control_connbyfd(pfd->fd)) == NULL) {
179 		log_warn("control_dispatch_msg: fd %d: not found", pfd->fd);
180 		return (0);
181 	}
182 
183 	if (pfd->revents & POLLOUT)
184 		if (msgbuf_write(&c->ibuf.w) <= 0 && errno != EAGAIN) {
185 			*ctl_cnt -= control_close(pfd->fd);
186 			return (1);
187 		}
188 
189 	if (!(pfd->revents & POLLIN))
190 		return (0);
191 
192 	if (((n = imsg_read(&c->ibuf)) == -1 && errno != EAGAIN) || n == 0) {
193 		*ctl_cnt -= control_close(pfd->fd);
194 		return (1);
195 	}
196 
197 	for (;;) {
198 		if ((n = imsg_get(&c->ibuf, &imsg)) == -1) {
199 			*ctl_cnt -= control_close(pfd->fd);
200 			return (1);
201 		}
202 		if (n == 0)
203 			break;
204 
205 		switch (imsg.hdr.type) {
206 		case IMSG_CTL_SHOW_STATUS:
207 			build_show_status(&c_status);
208 			imsg_compose(&c->ibuf, IMSG_CTL_SHOW_STATUS, 0, 0, -1,
209 			    &c_status, sizeof (c_status));
210 			break;
211 		case IMSG_CTL_SHOW_PEERS:
212 			cnt = 0;
213 			TAILQ_FOREACH(p, &conf->ntp_peers, entry) {
214 				build_show_peer(&c_peer, p);
215 				imsg_compose(&c->ibuf, IMSG_CTL_SHOW_PEERS,
216 				    0, 0, -1, &c_peer, sizeof(c_peer));
217 				cnt++;
218 			}
219 			imsg_compose(&c->ibuf, IMSG_CTL_SHOW_PEERS_END,
220 			    0, 0, -1, &cnt, sizeof(cnt));
221 			break;
222 		case IMSG_CTL_SHOW_SENSORS:
223 			cnt = 0;
224 			TAILQ_FOREACH(s, &conf->ntp_sensors, entry) {
225 				build_show_sensor(&c_sensor, s);
226 				imsg_compose(&c->ibuf, IMSG_CTL_SHOW_SENSORS,
227 				    0, 0, -1, &c_sensor, sizeof(c_sensor));
228 			cnt++;
229 			}
230 			imsg_compose(&c->ibuf, IMSG_CTL_SHOW_SENSORS_END,
231 			    0, 0, -1, &cnt, sizeof(cnt));
232 			break;
233 		case IMSG_CTL_SHOW_ALL:
234 			build_show_status(&c_status);
235 			imsg_compose(&c->ibuf, IMSG_CTL_SHOW_STATUS, 0, 0, -1,
236 			    &c_status, sizeof (c_status));
237 
238 			cnt = 0;
239 			TAILQ_FOREACH(p, &conf->ntp_peers, entry) {
240 				build_show_peer(&c_peer, p);
241 				imsg_compose(&c->ibuf, IMSG_CTL_SHOW_PEERS,
242 				    0, 0, -1, &c_peer, sizeof(c_peer));
243 				cnt++;
244 			}
245 			imsg_compose(&c->ibuf, IMSG_CTL_SHOW_PEERS_END,
246 			    0, 0, -1, &cnt, sizeof(cnt));
247 
248 			cnt = 0;
249 			TAILQ_FOREACH(s, &conf->ntp_sensors, entry) {
250 				build_show_sensor(&c_sensor, s);
251 				imsg_compose(&c->ibuf, IMSG_CTL_SHOW_SENSORS,
252 				    0, 0, -1, &c_sensor, sizeof(c_sensor));
253 			cnt++;
254 			}
255 			imsg_compose(&c->ibuf, IMSG_CTL_SHOW_SENSORS_END,
256 			    0, 0, -1, &cnt, sizeof(cnt));
257 
258 			imsg_compose(&c->ibuf, IMSG_CTL_SHOW_ALL_END,
259 			    0, 0, -1, NULL, 0);
260 			break;
261 		default:
262 			break;
263 		}
264 		imsg_free(&imsg);
265 	}
266 	return (0);
267 }
268 
269 void
270 session_socket_nonblockmode(int fd)
271 {
272 	int	flags;
273 
274 	if ((flags = fcntl(fd, F_GETFL)) == -1)
275 		fatal("fcntl F_GETFL");
276 
277 	flags |= O_NONBLOCK;
278 
279 	if ((flags = fcntl(fd, F_SETFL, flags)) == -1)
280 		fatal("fcntl F_SETFL");
281 }
282 
283 void
284 build_show_status(struct ctl_show_status *cs)
285 {
286 	struct ntp_peer		*p;
287 	struct ntp_sensor	*s;
288 
289 	cs->peercnt = cs->valid_peers = 0;
290 	cs->sensorcnt = cs->valid_sensors = 0;
291 
292 	TAILQ_FOREACH(p, &conf->ntp_peers, entry) {
293 		cs->peercnt++;
294 		if (p->trustlevel >= TRUSTLEVEL_BADPEER)
295 			cs->valid_peers++;
296 	}
297 	TAILQ_FOREACH(s, &conf->ntp_sensors, entry) {
298 		cs->sensorcnt++;
299 		if (s->update.good)
300 			cs->valid_sensors++;
301 	}
302 
303 	cs->synced = conf->status.synced;
304 	cs->stratum = conf->status.stratum;
305 	cs->clock_offset = getoffset() * 1000.0;
306 	cs->constraint_median = conf->constraint_median;
307 	cs->constraint_last = conf->constraint_last;
308 	cs->constraint_errors = conf->constraint_errors;
309 }
310 
311 void
312 build_show_peer(struct ctl_show_peer *cp, struct ntp_peer *p)
313 {
314 	const char	*a = "not resolved";
315 	const char	*pool = "", *addr_head_name = "";
316 	u_int8_t	 shift, best, validdelaycnt, jittercnt;
317 	time_t		 now;
318 
319 	now = getmonotime();
320 
321 	if (p->addr)
322 		a = log_sockaddr((struct sockaddr *)&p->addr->ss);
323 	if (p->addr_head.pool)
324 		pool = "from pool ";
325 
326 	if (0 != strcmp(a, p->addr_head.name))
327 		addr_head_name = p->addr_head.name;
328 
329 	snprintf(cp->peer_desc, sizeof(cp->peer_desc),
330 	    "%s %s%s", a, pool, addr_head_name);
331 
332 	validdelaycnt = best = 0;
333 	cp->offset = cp->delay = 0.0;
334 	for (shift = 0; shift < OFFSET_ARRAY_SIZE; shift++) {
335 		if (p->reply[shift].delay > 0.0) {
336 			cp->offset += p->reply[shift].offset;
337 			cp->delay += p->reply[shift].delay;
338 
339 			if (p->reply[shift].delay < p->reply[best].delay)
340 				best = shift;
341 
342 			validdelaycnt++;
343 		}
344 	}
345 
346 	if (validdelaycnt > 1) {
347 		cp->offset /= validdelaycnt;
348 		cp->delay /= validdelaycnt;
349 	}
350 
351 	jittercnt = 0;
352 	cp->jitter = 0.0;
353 	for (shift = 0; shift < OFFSET_ARRAY_SIZE; shift++) {
354 		if (p->reply[shift].delay > 0.0 && shift != best) {
355 			cp->jitter += square(p->reply[shift].delay -
356 			    p->reply[best].delay);
357 			jittercnt++;
358 		}
359 	}
360 	if (jittercnt > 1)
361 		cp->jitter /= jittercnt;
362 	cp->jitter = sqrt(cp->jitter);
363 
364 	if (p->shift == 0)
365 		shift = OFFSET_ARRAY_SIZE - 1;
366 	else
367 		shift = p->shift - 1;
368 
369 	if (conf->status.synced == 1 &&
370 	    p->reply[shift].status.send_refid == conf->status.refid)
371 		cp->syncedto = 1;
372 	else
373 		cp->syncedto = 0;
374 
375 	/* milliseconds to reduce number of leading zeroes */
376 	cp->offset *= 1000.0;
377 	cp->delay *= 1000.0;
378 	cp->jitter *= 1000.0;
379 
380 	cp->weight = p->weight;
381 	cp->trustlevel = p->trustlevel;
382 	cp->stratum = p->reply[shift].status.stratum;
383 	cp->next = p->next - now < 0 ? 0 : p->next - now;
384 	cp->poll = p->poll;
385 }
386 
387 void
388 build_show_sensor(struct ctl_show_sensor *cs, struct ntp_sensor *s)
389 {
390 	time_t		 now;
391 	u_int8_t	 shift;
392 	u_int32_t	 refid;
393 
394 	now = getmonotime();
395 
396 	memcpy(&refid, SENSOR_DEFAULT_REFID, sizeof(refid));
397 	refid = refid == s->refid ? 0 : s->refid;
398 
399 	snprintf(cs->sensor_desc, sizeof(cs->sensor_desc),
400 	    "%s  %.4s", s->device, (char *)&refid);
401 
402 	if (s->shift == 0)
403 		shift = SENSOR_OFFSETS - 1;
404 	else
405 		shift = s->shift - 1;
406 
407 	if (conf->status.synced == 1 &&
408 	    s->offsets[shift].status.send_refid == conf->status.refid)
409 		cs->syncedto = 1;
410 	else
411 		cs->syncedto = 0;
412 
413 	cs->weight = s->weight;
414 	cs->good = s->update.good;
415 	cs->stratum = s->offsets[shift].status.stratum;
416 	cs->next = s->next - now < 0 ? 0 : s->next - now;
417 	cs->poll = SENSOR_QUERY_INTERVAL;
418 	cs->offset = s->offsets[shift].offset * 1000.0;
419 	cs->correction = (double)s->correction / 1000.0;
420 }
421