xref: /dragonfly/usr.sbin/autofs/autounmountd.c (revision a1626531)
1 /*-
2  * Copyright (c) 2016 The DragonFly Project
3  * Copyright (c) 2014 The FreeBSD Foundation
4  * All rights reserved.
5  *
6  * This software was developed by Edward Tomasz Napierala under sponsorship
7  * from the FreeBSD Foundation.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  *
30  */
31 
32 #include <sys/types.h>
33 #include <sys/mount.h>
34 #include <sys/event.h>
35 #include <sys/time.h>
36 #include <assert.h>
37 #include <errno.h>
38 #include <stdio.h>
39 #include <stdlib.h>
40 #include <string.h>
41 #include <unistd.h>
42 #include <libutil.h>
43 
44 #include "common.h"
45 
46 #define AUTOUNMOUNTD_PIDFILE	"/var/run/autounmountd.pid"
47 
48 struct automounted_fs {
49 	TAILQ_ENTRY(automounted_fs)	af_next;
50 	time_t				af_mount_time;
51 	bool				af_mark;
52 	fsid_t				af_fsid;
53 	char				af_mountpoint[MNAMELEN];
54 };
55 
56 static TAILQ_HEAD(, automounted_fs)	automounted;
57 
58 static struct automounted_fs *
59 automounted_find(fsid_t fsid)
60 {
61 	struct automounted_fs *af;
62 
63 	TAILQ_FOREACH(af, &automounted, af_next) {
64 		if (fsidcmp(&af->af_fsid, &fsid) == 0)
65 			return (af);
66 	}
67 
68 	return (NULL);
69 }
70 
71 static struct automounted_fs *
72 automounted_add(fsid_t fsid, const char *mountpoint)
73 {
74 	struct automounted_fs *af;
75 
76 	af = calloc(1, sizeof(*af));
77 	if (af == NULL)
78 		log_err(1, "calloc");
79 	af->af_mount_time = time(NULL);
80 	af->af_fsid = fsid;
81 	strlcpy(af->af_mountpoint, mountpoint, sizeof(af->af_mountpoint));
82 
83 	TAILQ_INSERT_TAIL(&automounted, af, af_next);
84 
85 	return (af);
86 }
87 
88 static void
89 automounted_remove(struct automounted_fs *af)
90 {
91 
92 	TAILQ_REMOVE(&automounted, af, af_next);
93 	free(af);
94 }
95 
96 static void
97 refresh_automounted(void)
98 {
99 	struct automounted_fs *af, *tmpaf;
100 	struct statfs *mntbuf;
101 	int i, nitems;
102 
103 	nitems = getmntinfo(&mntbuf, MNT_WAIT);
104 	if (nitems <= 0)
105 		log_err(1, "getmntinfo");
106 
107 	log_debugx("refreshing list of automounted filesystems");
108 
109 	TAILQ_FOREACH(af, &automounted, af_next)
110 		af->af_mark = false;
111 
112 	for (i = 0; i < nitems; i++) {
113 		if (strcmp(mntbuf[i].f_fstypename, "autofs") == 0) {
114 			log_debugx("skipping %s, filesystem type is autofs",
115 			    mntbuf[i].f_mntonname);
116 			continue;
117 		}
118 
119 		if ((mntbuf[i].f_flags & MNT_AUTOMOUNTED) == 0) {
120 			log_debugx("skipping %s, not automounted",
121 			    mntbuf[i].f_mntonname);
122 			continue;
123 		}
124 
125 		af = automounted_find(mntbuf[i].f_fsid);
126 		if (af == NULL) {
127 			log_debugx("new automounted filesystem found on %s "
128 			    "(FSID:%d:%d)", mntbuf[i].f_mntonname,
129 			    mntbuf[i].f_fsid.val[0], mntbuf[i].f_fsid.val[1]);
130 			af = automounted_add(mntbuf[i].f_fsid,
131 			    mntbuf[i].f_mntonname);
132 		} else {
133 			log_debugx("already known automounted filesystem "
134 			    "found on %s (FSID:%d:%d)", mntbuf[i].f_mntonname,
135 			    mntbuf[i].f_fsid.val[0], mntbuf[i].f_fsid.val[1]);
136 		}
137 		af->af_mark = true;
138 	}
139 
140 	TAILQ_FOREACH_SAFE(af, &automounted, af_next, tmpaf) {
141 		if (af->af_mark)
142 			continue;
143 		log_debugx("lost filesystem mounted on %s (FSID:%d:%d)",
144 		    af->af_mountpoint, af->af_fsid.val[0], af->af_fsid.val[1]);
145 		automounted_remove(af);
146 	}
147 }
148 
149 static int
150 do_unmount(const fsid_t fsid __unused, const char *mountpoint)
151 {
152 	struct stat sb;
153 	int error, isbusy = 0;
154 
155 	error = unmount(mountpoint, 0);
156 	if (error != 0) {
157 		if (errno == EBUSY) {
158 			isbusy = 1;
159 			log_debugx("cannot unmount %s: %s",
160 			    mountpoint, strerror(errno));
161 		} else {
162 			log_warn("cannot unmount %s", mountpoint);
163 		}
164 	}
165 
166 	/*
167 	 * XXX: Workaround for DragonFly kernel bug.
168 	 * https://bugs.dragonflybsd.org/issues/2908
169 	 */
170 	if (isbusy) {
171 		log_debugx("workaround DragonFly kernel bug via stat(2)");
172 		if (stat(mountpoint, &sb))
173 			log_warn("cannot stat %s", mountpoint);
174 	}
175 
176 	return (error);
177 }
178 
179 static time_t
180 expire_automounted(time_t expiration_time)
181 {
182 	struct automounted_fs *af, *tmpaf;
183 	time_t now;
184 	time_t mounted_for, mounted_max = -1;
185 	int error;
186 
187 	now = time(NULL);
188 
189 	log_debugx("expiring automounted filesystems");
190 
191 	TAILQ_FOREACH_SAFE(af, &automounted, af_next, tmpaf) {
192 		mounted_for = difftime(now, af->af_mount_time);
193 
194 		if (mounted_for < expiration_time) {
195 			log_debugx("skipping %s (FSID:%d:%d), mounted "
196 			    "for %jd seconds", af->af_mountpoint,
197 			    af->af_fsid.val[0], af->af_fsid.val[1],
198 			    (intmax_t)mounted_for);
199 
200 			if (mounted_for > mounted_max)
201 				mounted_max = mounted_for;
202 
203 			continue;
204 		}
205 
206 		log_debugx("filesystem mounted on %s (FSID:%d:%d), "
207 		    "was mounted for %jd seconds; unmounting",
208 		    af->af_mountpoint, af->af_fsid.val[0], af->af_fsid.val[1],
209 		    (intmax_t)mounted_for);
210 		error = do_unmount(af->af_fsid, af->af_mountpoint);
211 		if (error != 0) {
212 			if (mounted_for > mounted_max)
213 				mounted_max = mounted_for;
214 		}
215 	}
216 
217 	return (mounted_max);
218 }
219 
220 static void
221 usage_autounmountd(void)
222 {
223 
224 	fprintf(stderr, "usage: autounmountd [-r time][-t time][-dv]\n");
225 	exit(1);
226 }
227 
228 static void
229 do_wait(int kq, time_t sleep_time)
230 {
231 	struct timespec timeout;
232 	struct kevent unused;
233 	int nevents;
234 
235 	if (sleep_time != -1) {
236 		assert(sleep_time > 0);
237 		timeout.tv_sec = sleep_time;
238 		timeout.tv_nsec = 0;
239 
240 		log_debugx("waiting for filesystem event for %jd seconds",
241 		    (intmax_t)sleep_time);
242 		nevents = kevent(kq, NULL, 0, &unused, 1, &timeout);
243 	} else {
244 		log_debugx("waiting for filesystem event");
245 		nevents = kevent(kq, NULL, 0, &unused, 1, NULL);
246 	}
247 	if (nevents < 0) {
248 		if (errno == EINTR)
249 			return;
250 		log_err(1, "kevent");
251 	}
252 
253 	if (nevents == 0) {
254 		log_debugx("timeout reached");
255 		assert(sleep_time > 0);
256 	} else {
257 		log_debugx("got filesystem event");
258 	}
259 }
260 
261 void
262 main_autounmountd(int argc, char **argv)
263 {
264 	struct kevent event;
265 	struct pidfh *pidfh;
266 	pid_t otherpid;
267 	const char *pidfile_path = AUTOUNMOUNTD_PIDFILE;
268 	int ch, debug = 0, error, kq;
269 	time_t expiration_time = 600, retry_time = 600, mounted_max, sleep_time;
270 	bool dont_daemonize = false;
271 
272 	while ((ch = getopt(argc, argv, "dr:t:v")) != -1) {
273 		switch (ch) {
274 		case 'd':
275 			dont_daemonize = true;
276 			debug++;
277 			break;
278 		case 'r':
279 			retry_time = atoi(optarg);
280 			break;
281 		case 't':
282 			expiration_time = atoi(optarg);
283 			break;
284 		case 'v':
285 			debug++;
286 			break;
287 		case '?':
288 		default:
289 			usage_autounmountd();
290 		}
291 	}
292 	argc -= optind;
293 	if (argc != 0)
294 		usage_autounmountd();
295 
296 	if (retry_time <= 0)
297 		log_errx(1, "retry time must be greater than zero");
298 	if (expiration_time <= 0)
299 		log_errx(1, "expiration time must be greater than zero");
300 
301 	log_init(debug);
302 
303 	pidfh = pidfile_open(pidfile_path, 0600, &otherpid);
304 	if (pidfh == NULL) {
305 		if (errno == EEXIST) {
306 			log_errx(1, "daemon already running, pid: %jd.",
307 			    (intmax_t)otherpid);
308 		}
309 		log_err(1, "cannot open or create pidfile \"%s\"",
310 		    pidfile_path);
311 	}
312 
313 	if (dont_daemonize == false) {
314 		if (daemon(0, 0) == -1) {
315 			log_warn("cannot daemonize");
316 			pidfile_remove(pidfh);
317 			exit(1);
318 		}
319 	}
320 
321 	pidfile_write(pidfh);
322 
323 	TAILQ_INIT(&automounted);
324 
325 	kq = kqueue();
326 	if (kq < 0)
327 		log_err(1, "kqueue");
328 
329 	EV_SET(&event, 0, EVFILT_FS, EV_ADD | EV_CLEAR, 0, 0, NULL);
330 	error = kevent(kq, &event, 1, NULL, 0, NULL);
331 	if (error < 0)
332 		log_err(1, "kevent");
333 
334 	for (;;) {
335 		refresh_automounted();
336 		mounted_max = expire_automounted(expiration_time);
337 		if (mounted_max == -1) {
338 			sleep_time = mounted_max;
339 			log_debugx("no filesystems to expire");
340 		} else if (mounted_max < expiration_time) {
341 			sleep_time = difftime(expiration_time, mounted_max);
342 			log_debugx("some filesystems expire in %jd seconds",
343 			    (intmax_t)sleep_time);
344 		} else {
345 			sleep_time = retry_time;
346 			log_debugx("some expired filesystems remain mounted, "
347 			    "will retry in %jd seconds", (intmax_t)sleep_time);
348 		}
349 
350 		do_wait(kq, sleep_time);
351 	}
352 }
353