xref: /netbsd-src/usr.sbin/screenblank/screenblank.c (revision b1c86f5f087524e68db12794ee9c3e3da1ab17a0)
1 /*	$NetBSD: screenblank.c,v 1.28 2008/07/21 13:36:59 lukem Exp $	*/
2 
3 /*-
4  * Copyright (c) 1996-2002 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Jason R. Thorpe.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 /*
33  * Screensaver daemon for the Sun 3 and SPARC, and platforms using WSCONS.
34  */
35 
36 #include <sys/cdefs.h>
37 #ifndef lint
38 __COPYRIGHT("@(#) Copyright (c) 1996-2002\
39  The NetBSD Foundation, Inc.  All rights reserved.");
40 __RCSID("$NetBSD: screenblank.c,v 1.28 2008/07/21 13:36:59 lukem Exp $");
41 #endif
42 
43 #include <sys/types.h>
44 #include <sys/time.h>
45 #include <sys/stat.h>
46 #include <sys/ioctl.h>
47 #include <sys/queue.h>
48 #include <ctype.h>
49 #include <err.h>
50 #include <errno.h>
51 #include <fcntl.h>
52 #include <limits.h>
53 #include <math.h>
54 #include <paths.h>
55 #include <stdlib.h>
56 #include <stdio.h>
57 #include <string.h>
58 #include <signal.h>
59 #include <syslog.h>
60 #include <unistd.h>
61 #include <util.h>
62 
63 #include <dev/wscons/wsconsio.h>
64 
65 #ifdef HAVE_FBIO
66 #include <dev/sun/fbio.h>
67 #endif
68 
69 #include "pathnames.h"
70 
71 u_long	setvideo = WSDISPLAYIO_SVIDEO;		/* "set video" ioctl */
72 int	videoon  = WSDISPLAYIO_VIDEO_ON;	/* value for "on" */
73 int	videooff = WSDISPLAYIO_VIDEO_OFF;	/* value for "off" */
74 
75 struct	dev_stat {
76 	LIST_ENTRY(dev_stat) ds_link;	/* linked list */
77 	const char *ds_path;		/* path to device */
78 	int	ds_isfb;		/* boolean; framebuffer? */
79 	time_t	ds_atime;		/* time device last accessed */
80 	time_t	ds_mtime;		/* time device last modified */
81 };
82 LIST_HEAD(ds_list, dev_stat) ds_list;
83 
84 int	main(int, char *[]);
85 static	void add_dev(const char *, int);
86 static	void change_state(int);
87 static	void cvt_arg(char *, struct timespec *);
88 static	void sighandler(int);
89 static	int is_graphics_fb(struct dev_stat *);
90 static	void usage(void);
91 
92 int
93 main(int argc, char *argv[])
94 {
95 	struct dev_stat *dsp;
96 	struct timespec timo_on, timo_off, *tvp, tv;
97 	struct sigaction sa;
98 	struct stat st;
99 	int ch, change, fflag = 0, kflag = 0, mflag = 0, state;
100 	int bflag = 0, uflag = 0;
101 	const char *kbd, *mouse, *display;
102 
103 	LIST_INIT(&ds_list);
104 
105 	/*
106 	 * Set the default timeouts: 10 minutes on, .25 seconds off.
107 	 */
108 	timo_on.tv_sec = 600;
109 	timo_on.tv_nsec = 0;
110 	timo_off.tv_sec = 0;
111 	timo_off.tv_nsec = 250000000;
112 
113 	while ((ch = getopt(argc, argv, "bd:e:f:i:kmu")) != -1) {
114 		switch (ch) {
115 		case 'b':
116 			bflag = 1;
117 			uflag = 0;
118 			break;
119 
120 		case 'd':
121 			cvt_arg(optarg, &timo_on);
122 			break;
123 
124 		case 'e':
125 			cvt_arg(optarg, &timo_off);
126 			break;
127 
128 		case 'f':
129 			fflag = 1;
130 			add_dev(optarg, 1);
131 			break;
132 
133 		case 'i':
134 			add_dev(optarg, 0);
135 			break;
136 
137 		case 'k':
138 			if (mflag || kflag)
139 				usage();
140 			kflag = 1;
141 			break;
142 
143 		case 'm':
144 			if (kflag || mflag)
145 				usage();
146 			mflag = 1;
147 			break;
148 
149 		case 'u':
150 			uflag = 1;
151 			bflag = 0;
152 			break;
153 
154 		default:
155 			usage();
156 		}
157 	}
158 	argc -= optind;
159 	if (argc)
160 		usage();
161 
162 	/*
163 	 * Default to WSCONS support.
164 	 */
165 	kbd = _PATH_WSKBD;
166 	mouse = _PATH_WSMOUSE;
167 	display = _PATH_WSDISPLAY;
168 
169 #ifdef HAVE_FBIO
170 	/*
171 	 * If a display device wasn't specified, check to see which we
172 	 * have.  If we can't open the WSCONS display, fall back to fbio.
173 	 */
174 	if (!fflag) {
175 		int fd;
176 
177 		if ((fd = open(display, O_RDONLY, 0666)) == -1)
178 			setvideo = FBIOSVIDEO;
179 		else
180 			(void) close(fd);
181 	}
182 
183 	/*
184 	 * Do this here so that -f ... args above can influence us.
185 	 */
186 	if (setvideo == FBIOSVIDEO) {
187 		videoon = FBVIDEO_ON;
188 		videooff = FBVIDEO_OFF;
189 		kbd = _PATH_KEYBOARD;
190 		mouse = _PATH_MOUSE;
191 		display = _PATH_FB;
192 	}
193 #endif
194 
195 	/*
196 	 * Add the default framebuffer device if necessary.
197 	 * We _always_ check the console device.
198 	 */
199 	add_dev(_PATH_CONSOLE, 0);
200 	if (!fflag)
201 		add_dev(display, 1);
202 
203 	/*
204 	 * If this is an one-off blank/unblank request, handle it now.
205 	 * We don't need to open keyboard/mouse device for that.
206 	 */
207 	if (bflag || uflag) {
208 		change_state(bflag ? videooff : videoon);
209 		exit(0);
210 	}
211 
212 
213 	/* Add the keyboard and mouse devices as necessary. */
214 	if (!kflag)
215 		add_dev(kbd, 0);
216 	if (!mflag)
217 		add_dev(mouse, 0);
218 
219 	/* Ensure that the framebuffer is on. */
220 	state = videoon;
221 	change_state(state);
222 	tvp = &timo_on;
223 
224 	/*
225 	 * Make sure the framebuffer gets turned back on when we're
226 	 * killed.
227 	 */
228 	sa.sa_handler = sighandler;
229 	sa.sa_flags = SA_NOCLDSTOP;
230 	if (sigemptyset(&sa.sa_mask))
231 		err(1, "sigemptyset");
232 	if (sigaction(SIGINT, &sa, NULL) || sigaction(SIGTERM, &sa, NULL) ||
233 	    sigaction(SIGHUP, &sa, NULL))
234 		err(1, "sigaction");
235 
236 	openlog("screenblank", LOG_PID, LOG_DAEMON);
237 	/* Detach. */
238 	if (daemon(0, 0))
239 		err(1, "daemon");
240 	pidfile(NULL);
241 
242 	/* Start the state machine. */
243 	for (;;) {
244 		change = 0;
245 		LIST_FOREACH(dsp, &ds_list, ds_link) {
246 			/* Don't check framebuffers in graphics mode. */
247 			if (is_graphics_fb(dsp))
248 				continue;
249 			if (stat(dsp->ds_path, &st) == -1) {
250 				syslog(LOG_CRIT,
251 				    "Can't stat `%s' (%m)", dsp->ds_path);
252 				exit(1);
253 			}
254 			if (st.st_atime > dsp->ds_atime) {
255 				change = 1;
256 				dsp->ds_atime = st.st_atime;
257 			}
258 			if (st.st_mtime > dsp->ds_mtime) {
259 				change = 1;
260 				dsp->ds_mtime = st.st_mtime;
261 			}
262 		}
263 
264 		if (state == videoon) {
265 			if (!change) {
266 				state = videooff;
267 				change_state(state);
268 				tvp = &timo_off;
269 			}
270 		} else {
271 			if (change) {
272 				state = videoon;
273 				change_state(state);
274 				tvp = &timo_on;
275 			}
276 		}
277 
278 		tv = *tvp;
279 		if (nanosleep(&tv, NULL) == -1)
280 			err(1, "nanosleep");
281 	}
282 	/* NOTREACHED */
283 }
284 
285 static void
286 add_dev(const char *path, int isfb)
287 {
288 	struct dev_stat *dsp;
289 	struct stat sb;
290 
291 	/* Make sure we can stat the device. */
292 	if (stat(path, &sb) == -1) {
293 		warn("Can't stat `%s'", path);
294 		return;
295 	}
296 
297 #ifdef HAVE_FBIO
298 	/*
299 	 * We default to WSCONS.  If this is a frame buffer
300 	 * device, check to see if it responds to the old
301 	 * Sun-style fbio ioctls.  If so, switch to fbio mode.
302 	 */
303 	if (isfb && setvideo != FBIOSVIDEO) {
304 		int onoff, fd;
305 
306 		if ((fd = open(path, O_RDWR, 0666)) == -1) {
307 			warn("Can't open `%s'", path);
308 			return;
309 		}
310 		if ((ioctl(fd, FBIOGVIDEO, &onoff)) == 0)
311 			setvideo = FBIOSVIDEO;
312 		(void)close(fd);
313 	}
314 #endif
315 
316 	/* Create the entry... */
317 	dsp = malloc(sizeof(struct dev_stat));
318 	if (dsp == NULL)
319 		err(1, "Can't allocate memory for `%s'", path);
320 	(void)memset(dsp, 0, sizeof(struct dev_stat));
321 	dsp->ds_path = path;
322 	dsp->ds_isfb = isfb;
323 
324 	/* ...and put it in the list. */
325 	LIST_INSERT_HEAD(&ds_list, dsp, ds_link);
326 }
327 
328 /* ARGSUSED */
329 static void
330 sighandler(int sig)
331 {
332 
333 	/* Kill the pid file and re-enable the framebuffer before exit. */
334 	change_state(videoon);
335 	exit(0);
336 }
337 
338 /*
339  * Return 1 if we are a framebuffer in graphics mode or a framebuffer
340  * where we cannot tell the mode. Return 0 if we are not a framebuffer
341  * device, or a wscons framebuffer in text mode.
342  */
343 static int
344 is_graphics_fb(struct dev_stat *dsp)
345 {
346 	int fd;
347 	int state;
348 
349 	if (dsp->ds_isfb == 0)
350 		return 0;
351 
352 	/* We can't tell if we are not a wscons device */
353 	if (setvideo != WSDISPLAYIO_SVIDEO)
354 		return 1;
355 
356 	if ((fd = open(dsp->ds_path, O_RDWR, 0)) == -1) {
357 		syslog(LOG_WARNING, "Cannot open `%s' (%m)", dsp->ds_path);
358 		return 1;
359 	}
360 
361 	if (ioctl(fd, WSDISPLAYIO_GMODE, &state) == -1) {
362 		syslog(LOG_WARNING, "Cannot get mode on `%s' (%m)",
363 		    dsp->ds_path);
364 		/* We can't tell, so we say we are mapped */
365 		state = WSDISPLAYIO_MODE_MAPPED;
366 	}
367 
368 	(void)close(fd);
369 
370 	return state != WSDISPLAYIO_MODE_EMUL;
371 }
372 
373 static void
374 change_state(int state)
375 {
376 	struct dev_stat *dsp;
377 	int fd;
378 	int fail = 1;
379 
380 	LIST_FOREACH(dsp, &ds_list, ds_link) {
381 		/* Don't change the state of non-framebuffers! */
382 		if (dsp->ds_isfb == 0)
383 			continue;
384 		if ((fd = open(dsp->ds_path, O_RDWR, 0)) == -1) {
385 			syslog(LOG_WARNING, "Can't open `%s' (%m)",
386 			    dsp->ds_path);
387 			continue;
388 		}
389 		if (ioctl(fd, setvideo, &state) == -1)
390 			syslog(LOG_WARNING, "Can't set video on `%s' (%m)",
391 			    dsp->ds_path);
392 		else
393 			fail = 0;
394 		(void)close(fd);
395 	}
396 	if (fail) {
397 		syslog(LOG_CRIT, "No frame buffer devices, exiting\n");
398 		exit(1);
399 	}
400 }
401 
402 static void
403 cvt_arg(char *arg, struct timespec *tvp)
404 {
405 	char *cp;
406 	int seconds, nanoseconds, factor;
407 	int period = 0;
408 	factor = 1000000000;
409 	nanoseconds = 0;
410 	seconds = 0;
411 
412 	for (cp = arg; *cp != '\0'; ++cp) {
413 		if (*cp == '.') {
414 			if (period)
415 				errx(1, "Invalid argument: %s", arg);
416 			period = 1;
417 			continue;
418 		}
419 
420 		if (!isdigit((unsigned char)*cp))
421 			errx(1, "Invalid argument: %s", arg);
422 
423 		if (period) {
424 			if (factor > 1) {
425 				nanoseconds = nanoseconds * 10 + (*cp - '0');
426 				factor /= 10;
427 			}
428 		} else
429 			seconds = (seconds * 10) + (*cp - '0');
430 	}
431 
432 	tvp->tv_sec = seconds;
433 	if (factor > 1)
434 		nanoseconds *= factor;
435 
436 	tvp->tv_nsec = nanoseconds;
437 }
438 
439 static void
440 usage(void)
441 {
442 
443 	(void)fprintf(stderr,
444 	    "usage: %s [-k | -m] [-d inactivity-timeout] [-e wakeup-delay]\n"
445 	    "\t\t[-f framebuffer] [-i input-device]\n"
446 	    "       %s {-b | -u}\n",
447 	    getprogname(),
448 	    getprogname());
449 	exit(1);
450 }
451