1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3 * 4 * Copyright (c) 2014 The FreeBSD Foundation 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/cdefs.h> 33 __FBSDID("$FreeBSD$"); 34 35 #include <sys/types.h> 36 #include <sys/event.h> 37 #include <sys/mount.h> 38 #include <sys/time.h> 39 #include <assert.h> 40 #include <errno.h> 41 #include <libutil.h> 42 #include <stdbool.h> 43 #include <stdint.h> 44 #include <stdio.h> 45 #include <stdlib.h> 46 #include <string.h> 47 #include <unistd.h> 48 49 #include "common.h" 50 51 #define AUTOUNMOUNTD_PIDFILE "/var/run/autounmountd.pid" 52 53 struct automounted_fs { 54 TAILQ_ENTRY(automounted_fs) af_next; 55 time_t af_mount_time; 56 bool af_mark; 57 fsid_t af_fsid; 58 char af_mountpoint[MNAMELEN]; 59 }; 60 61 static TAILQ_HEAD(, automounted_fs) automounted; 62 63 static struct automounted_fs * 64 automounted_find(fsid_t fsid) 65 { 66 struct automounted_fs *af; 67 68 TAILQ_FOREACH(af, &automounted, af_next) { 69 if (fsidcmp(&af->af_fsid, &fsid) == 0) 70 return (af); 71 } 72 73 return (NULL); 74 } 75 76 static struct automounted_fs * 77 automounted_add(fsid_t fsid, const char *mountpoint) 78 { 79 struct automounted_fs *af; 80 81 af = calloc(1, sizeof(*af)); 82 if (af == NULL) 83 log_err(1, "calloc"); 84 af->af_mount_time = time(NULL); 85 af->af_fsid = fsid; 86 strlcpy(af->af_mountpoint, mountpoint, sizeof(af->af_mountpoint)); 87 88 TAILQ_INSERT_TAIL(&automounted, af, af_next); 89 90 return (af); 91 } 92 93 static void 94 automounted_remove(struct automounted_fs *af) 95 { 96 97 TAILQ_REMOVE(&automounted, af, af_next); 98 free(af); 99 } 100 101 static void 102 refresh_automounted(void) 103 { 104 struct automounted_fs *af, *tmpaf; 105 struct statfs *mntbuf; 106 int i, nitems; 107 108 nitems = getmntinfo(&mntbuf, MNT_WAIT); 109 if (nitems <= 0) 110 log_err(1, "getmntinfo"); 111 112 log_debugx("refreshing list of automounted filesystems"); 113 114 TAILQ_FOREACH(af, &automounted, af_next) 115 af->af_mark = false; 116 117 for (i = 0; i < nitems; i++) { 118 if (strcmp(mntbuf[i].f_fstypename, "autofs") == 0) { 119 log_debugx("skipping %s, filesystem type is autofs", 120 mntbuf[i].f_mntonname); 121 continue; 122 } 123 124 if ((mntbuf[i].f_flags & MNT_AUTOMOUNTED) == 0) { 125 log_debugx("skipping %s, not automounted", 126 mntbuf[i].f_mntonname); 127 continue; 128 } 129 130 af = automounted_find(mntbuf[i].f_fsid); 131 if (af == NULL) { 132 log_debugx("new automounted filesystem found on %s " 133 "(FSID:%d:%d)", mntbuf[i].f_mntonname, 134 mntbuf[i].f_fsid.val[0], mntbuf[i].f_fsid.val[1]); 135 af = automounted_add(mntbuf[i].f_fsid, 136 mntbuf[i].f_mntonname); 137 } else { 138 log_debugx("already known automounted filesystem " 139 "found on %s (FSID:%d:%d)", mntbuf[i].f_mntonname, 140 mntbuf[i].f_fsid.val[0], mntbuf[i].f_fsid.val[1]); 141 } 142 af->af_mark = true; 143 } 144 145 TAILQ_FOREACH_SAFE(af, &automounted, af_next, tmpaf) { 146 if (af->af_mark) 147 continue; 148 log_debugx("lost filesystem mounted on %s (FSID:%d:%d)", 149 af->af_mountpoint, af->af_fsid.val[0], af->af_fsid.val[1]); 150 automounted_remove(af); 151 } 152 } 153 154 static int 155 unmount_by_fsid(const fsid_t fsid, const char *mountpoint) 156 { 157 char *fsid_str; 158 int error, ret; 159 160 ret = asprintf(&fsid_str, "FSID:%d:%d", fsid.val[0], fsid.val[1]); 161 if (ret < 0) 162 log_err(1, "asprintf"); 163 164 error = unmount(fsid_str, MNT_NONBUSY | MNT_BYFSID); 165 if (error != 0) { 166 if (errno == EBUSY) { 167 log_debugx("cannot unmount %s (%s): %s", 168 mountpoint, fsid_str, strerror(errno)); 169 } else { 170 log_warn("cannot unmount %s (%s)", 171 mountpoint, fsid_str); 172 } 173 } 174 175 free(fsid_str); 176 177 return (error); 178 } 179 180 static time_t 181 expire_automounted(time_t expiration_time) 182 { 183 struct automounted_fs *af, *tmpaf; 184 time_t now; 185 time_t mounted_for, mounted_max = -1; 186 int error; 187 188 now = time(NULL); 189 190 log_debugx("expiring automounted filesystems"); 191 192 TAILQ_FOREACH_SAFE(af, &automounted, af_next, tmpaf) { 193 mounted_for = difftime(now, af->af_mount_time); 194 195 if (mounted_for < expiration_time) { 196 log_debugx("skipping %s (FSID:%d:%d), mounted " 197 "for %jd seconds", af->af_mountpoint, 198 af->af_fsid.val[0], af->af_fsid.val[1], 199 (intmax_t)mounted_for); 200 201 if (mounted_for > mounted_max) 202 mounted_max = mounted_for; 203 204 continue; 205 } 206 207 log_debugx("filesystem mounted on %s (FSID:%d:%d), " 208 "was mounted for %ld seconds; unmounting", 209 af->af_mountpoint, af->af_fsid.val[0], af->af_fsid.val[1], 210 (long)mounted_for); 211 error = unmount_by_fsid(af->af_fsid, af->af_mountpoint); 212 if (error != 0) { 213 if (mounted_for > mounted_max) 214 mounted_max = mounted_for; 215 } 216 } 217 218 return (mounted_max); 219 } 220 221 static void 222 usage_autounmountd(void) 223 { 224 225 fprintf(stderr, "usage: autounmountd [-r time][-t time][-dv]\n"); 226 exit(1); 227 } 228 229 static void 230 do_wait(int kq, time_t sleep_time) 231 { 232 struct timespec timeout; 233 struct kevent unused; 234 int nevents; 235 236 if (sleep_time != -1) { 237 assert(sleep_time > 0); 238 timeout.tv_sec = sleep_time; 239 timeout.tv_nsec = 0; 240 241 log_debugx("waiting for filesystem event for %ld seconds", 242 (long)sleep_time); 243 nevents = kevent(kq, NULL, 0, &unused, 1, &timeout); 244 } else { 245 log_debugx("waiting for filesystem event"); 246 nevents = kevent(kq, NULL, 0, &unused, 1, NULL); 247 } 248 if (nevents < 0) { 249 if (errno == EINTR) 250 return; 251 log_err(1, "kevent"); 252 } 253 254 if (nevents == 0) { 255 log_debugx("timeout reached"); 256 assert(sleep_time > 0); 257 } else { 258 log_debugx("got filesystem event"); 259 } 260 } 261 262 int 263 main_autounmountd(int argc, char **argv) 264 { 265 struct kevent event; 266 struct pidfh *pidfh; 267 pid_t otherpid; 268 const char *pidfile_path = AUTOUNMOUNTD_PIDFILE; 269 int ch, debug = 0, error, kq; 270 time_t expiration_time = 600, retry_time = 600, mounted_max, sleep_time; 271 bool dont_daemonize = false; 272 273 while ((ch = getopt(argc, argv, "dr:t:v")) != -1) { 274 switch (ch) { 275 case 'd': 276 dont_daemonize = true; 277 debug++; 278 break; 279 case 'r': 280 retry_time = atoi(optarg); 281 break; 282 case 't': 283 expiration_time = atoi(optarg); 284 break; 285 case 'v': 286 debug++; 287 break; 288 case '?': 289 default: 290 usage_autounmountd(); 291 } 292 } 293 argc -= optind; 294 if (argc != 0) 295 usage_autounmountd(); 296 297 if (retry_time <= 0) 298 log_errx(1, "retry time must be greater than zero"); 299 if (expiration_time <= 0) 300 log_errx(1, "expiration time must be greater than zero"); 301 302 log_init(debug); 303 304 pidfh = pidfile_open(pidfile_path, 0600, &otherpid); 305 if (pidfh == NULL) { 306 if (errno == EEXIST) { 307 log_errx(1, "daemon already running, pid: %jd.", 308 (intmax_t)otherpid); 309 } 310 log_err(1, "cannot open or create pidfile \"%s\"", 311 pidfile_path); 312 } 313 314 if (dont_daemonize == false) { 315 if (daemon(0, 0) == -1) { 316 log_warn("cannot daemonize"); 317 pidfile_remove(pidfh); 318 exit(1); 319 } 320 } 321 322 pidfile_write(pidfh); 323 324 TAILQ_INIT(&automounted); 325 326 kq = kqueue(); 327 if (kq < 0) 328 log_err(1, "kqueue"); 329 330 EV_SET(&event, 0, EVFILT_FS, EV_ADD | EV_CLEAR, 0, 0, NULL); 331 error = kevent(kq, &event, 1, NULL, 0, NULL); 332 if (error < 0) 333 log_err(1, "kevent"); 334 335 for (;;) { 336 refresh_automounted(); 337 mounted_max = expire_automounted(expiration_time); 338 if (mounted_max == -1) { 339 sleep_time = mounted_max; 340 log_debugx("no filesystems to expire"); 341 } else if (mounted_max < expiration_time) { 342 sleep_time = difftime(expiration_time, mounted_max); 343 log_debugx("some filesystems expire in %ld seconds", 344 (long)sleep_time); 345 } else { 346 sleep_time = retry_time; 347 log_debugx("some expired filesystems remain mounted, " 348 "will retry in %ld seconds", (long)sleep_time); 349 } 350 351 do_wait(kq, sleep_time); 352 } 353 354 return (0); 355 } 356