2 * Copyright (c) 2014 The FreeBSD Foundation
5 * This software was developed by Edward Tomasz Napierala under sponsorship
6 * from the FreeBSD Foundation.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD$");
34 #include <sys/types.h>
36 #include <sys/ioctl.h>
37 #include <sys/param.h>
38 #include <sys/linker.h>
39 #include <sys/mount.h>
40 #include <sys/socket.h>
43 #include <sys/utsname.h>
60 #include "autofs_ioctl.h"
64 #define AUTOMOUNTD_PIDFILE "/var/run/automountd.pid"
66 static int nchildren = 0;
68 static int request_id;
71 done(int request_error, bool wildcards)
73 struct autofs_daemon_done add;
76 memset(&add, 0, sizeof(add));
77 add.add_id = request_id;
78 add.add_wildcards = wildcards;
79 add.add_error = request_error;
81 log_debugx("completing request %d with error %d",
82 request_id, request_error);
84 error = ioctl(autofs_fd, AUTOFSDONE, &add);
86 log_warn("AUTOFSDONE");
90 * Remove "fstype=whatever" from optionsp and return the "whatever" part.
93 pick_option(const char *option, char **optionsp)
95 char *tofree, *pair, *newoptions;
101 newoptions = calloc(strlen(*optionsp) + 1, 1);
102 if (newoptions == NULL)
103 log_err(1, "calloc");
105 while ((pair = strsep(optionsp, ",")) != NULL) {
107 * XXX: strncasecmp(3) perhaps?
109 if (strncmp(pair, option, strlen(option)) == 0) {
110 picked = checked_strdup(pair + strlen(option));
113 strcat(newoptions, ",");
116 strcat(newoptions, pair);
121 *optionsp = newoptions;
127 create_subtree(const struct node *node, bool incomplete)
129 const struct node *child;
131 bool wildcard_found = false;
134 * Skip wildcard nodes.
136 if (strcmp(node->n_key, "*") == 0)
139 path = node_path(node);
140 log_debugx("creating subtree at %s", path);
141 create_directory(path);
144 TAILQ_FOREACH(child, &node->n_children, n_next) {
145 if (strcmp(child->n_key, "*") == 0) {
146 wildcard_found = true;
151 if (wildcard_found) {
152 log_debugx("node %s contains wildcard entry; "
153 "not creating its subdirectories due to -d flag",
162 TAILQ_FOREACH(child, &node->n_children, n_next)
163 create_subtree(child, incomplete);
174 handle_request(const struct autofs_daemon_request *adr, char *cmdline_options,
175 bool incomplete_hierarchy)
178 struct node *root, *parent, *node;
180 char *options, *fstype, *nobrowse, *retrycnt, *tmp;
184 log_debugx("got request %d: from %s, path %s, prefix \"%s\", "
185 "key \"%s\", options \"%s\"", adr->adr_id, adr->adr_from,
186 adr->adr_path, adr->adr_prefix, adr->adr_key, adr->adr_options);
189 * Try to notify the kernel about any problems.
191 request_id = adr->adr_id;
192 atexit(exit_callback);
194 if (strncmp(adr->adr_from, "map ", 4) != 0) {
195 log_errx(1, "invalid mountfrom \"%s\"; failing request",
199 map = adr->adr_from + 4; /* 4 for strlen("map "); */
200 root = node_new_root();
201 if (adr->adr_prefix[0] == '\0' || strcmp(adr->adr_prefix, "/") == 0) {
204 parent = node_new_map(root, checked_strdup(adr->adr_prefix),
205 NULL, checked_strdup(map),
206 checked_strdup("[kernel request]"), lineno);
210 * "Wildcards" here actually means "make autofs(4) request
211 * automountd(8) action if the node being looked up does not
212 * exist, even though the parent is marked as cached". This
213 * needs to be done for maps with wildcard entries, but also
214 * for special and executable maps.
216 parse_map(parent, map, adr->adr_key[0] != '\0' ? adr->adr_key : NULL,
219 wildcards = node_has_wildcards(parent);
221 log_debugx("map may contain wildcard entries");
223 log_debugx("map does not contain wildcard entries");
225 if (adr->adr_key[0] != '\0')
226 node_expand_wildcard(root, adr->adr_key);
228 node = node_find(root, adr->adr_path);
230 log_errx(1, "map %s does not contain key for \"%s\"; "
231 "failing mount", map, adr->adr_path);
234 options = node_options(node);
237 * Append options from auto_master.
239 options = concat(options, ',', adr->adr_options);
242 * Prepend options passed via automountd(8) command line.
244 options = concat(cmdline_options, ',', options);
246 if (node->n_location == NULL) {
247 log_debugx("found node defined at %s:%d; not a mountpoint",
248 node->n_config_file, node->n_config_line);
250 nobrowse = pick_option("nobrowse", &options);
251 if (nobrowse != NULL && adr->adr_key[0] == '\0') {
252 log_debugx("skipping map %s due to \"nobrowse\" "
253 "option; exiting", map);
257 * Exit without calling exit_callback().
263 * Not a mountpoint; create directories in the autofs mount
264 * and complete the request.
266 create_subtree(node, incomplete_hierarchy);
268 if (incomplete_hierarchy && adr->adr_key[0] != '\0') {
270 * We still need to create the single subdirectory
271 * user is trying to access.
273 tmp = concat(adr->adr_path, '/', adr->adr_key);
274 node = node_find(root, tmp);
276 create_subtree(node, false);
279 log_debugx("nothing to mount; exiting");
283 * Exit without calling exit_callback().
288 log_debugx("found node defined at %s:%d; it is a mountpoint",
289 node->n_config_file, node->n_config_line);
291 node_expand_ampersand(node,
292 adr->adr_key[0] != '\0' ? adr->adr_key : NULL);
293 error = node_expand_defined(node);
295 log_errx(1, "variable expansion failed for %s; "
296 "failing mount", adr->adr_path);
300 * Append "automounted".
302 options = concat(options, ',', "automounted");
305 * Remove "nobrowse", mount(8) doesn't understand it.
307 pick_option("nobrowse", &options);
312 fstype = pick_option("fstype=", &options);
313 if (fstype == NULL) {
314 log_debugx("fstype not specified in options; "
315 "defaulting to \"nfs\"");
316 fstype = checked_strdup("nfs");
319 if (strcmp(fstype, "nfs") == 0) {
321 * The mount_nfs(8) command defaults to retry undefinitely.
322 * We do not want that behaviour, because it leaves mount_nfs(8)
323 * instances and automountd(8) children hanging forever.
324 * Disable retries unless the option was passed explicitly.
326 retrycnt = pick_option("retrycnt=", &options);
327 if (retrycnt == NULL) {
328 log_debugx("retrycnt not specified in options; "
330 options = concat(options, ',', "retrycnt=1");
332 options = concat(options, ',',
333 concat("retrycnt", '=', retrycnt));
337 f = auto_popen("mount", "-t", fstype, "-o", options,
338 node->n_location, adr->adr_path, NULL);
340 error = auto_pclose(f);
342 log_errx(1, "mount failed");
344 log_debugx("mount done; exiting");
348 * Exit without calling exit_callback().
354 sigchld_handler(int dummy __unused)
358 * The only purpose of this handler is to make SIGCHLD
359 * interrupt the AUTOFSREQUEST ioctl(2), so we can call
360 * wait_for_children().
365 register_sigchld(void)
370 bzero(&sa, sizeof(sa));
371 sa.sa_handler = sigchld_handler;
372 sigfillset(&sa.sa_mask);
373 error = sigaction(SIGCHLD, &sa, NULL);
375 log_err(1, "sigaction");
381 wait_for_children(bool block)
389 * If "block" is true, wait for at least one process.
391 if (block && num == 0)
392 pid = wait4(-1, &status, 0, NULL);
394 pid = wait4(-1, &status, WNOHANG, NULL);
397 if (WIFSIGNALED(status)) {
398 log_warnx("child process %d terminated with signal %d",
399 pid, WTERMSIG(status));
400 } else if (WEXITSTATUS(status) != 0) {
401 log_debugx("child process %d terminated with exit status %d",
402 pid, WEXITSTATUS(status));
404 log_debugx("child process %d terminated gracefully", pid);
413 usage_automountd(void)
416 fprintf(stderr, "usage: automountd [-D name=value][-m maxproc]"
417 "[-o opts][-Tidv]\n");
422 main_automountd(int argc, char **argv)
426 const char *pidfile_path = AUTOMOUNTD_PIDFILE;
427 char *options = NULL;
428 struct autofs_daemon_request request;
429 int ch, debug = 0, error, maxproc = 30, retval, saved_errno;
430 bool dont_daemonize = false, incomplete_hierarchy = false;
434 while ((ch = getopt(argc, argv, "D:Tdim:o:v")) != -1) {
437 defined_parse_and_add(optarg);
441 * For compatibility with other implementations,
447 dont_daemonize = true;
451 incomplete_hierarchy = true;
454 maxproc = atoi(optarg);
457 options = concat(options, ',', optarg);
473 pidfh = pidfile_open(pidfile_path, 0600, &otherpid);
475 if (errno == EEXIST) {
476 log_errx(1, "daemon already running, pid: %jd.",
479 log_err(1, "cannot open or create pidfile \"%s\"",
483 autofs_fd = open(AUTOFS_PATH, O_RDWR | O_CLOEXEC);
484 if (autofs_fd < 0 && errno == ENOENT) {
486 retval = kldload("autofs");
488 autofs_fd = open(AUTOFS_PATH, O_RDWR | O_CLOEXEC);
493 log_err(1, "failed to open %s", AUTOFS_PATH);
495 if (dont_daemonize == false) {
496 if (daemon(0, 0) == -1) {
497 log_warn("cannot daemonize");
498 pidfile_remove(pidfh);
505 pidfile_write(pidfh);
510 log_debugx("waiting for request from the kernel");
512 memset(&request, 0, sizeof(request));
513 error = ioctl(autofs_fd, AUTOFSREQUEST, &request);
515 if (errno == EINTR) {
516 nchildren -= wait_for_children(false);
517 assert(nchildren >= 0);
521 log_err(1, "AUTOFSREQUEST");
524 if (dont_daemonize) {
525 log_debugx("not forking due to -d flag; "
526 "will exit after servicing a single request");
528 nchildren -= wait_for_children(false);
529 assert(nchildren >= 0);
531 while (maxproc > 0 && nchildren >= maxproc) {
532 log_debugx("maxproc limit of %d child processes hit; "
533 "waiting for child process to exit", maxproc);
534 nchildren -= wait_for_children(true);
535 assert(nchildren >= 0);
537 log_debugx("got request; forking child process #%d",
548 pidfile_close(pidfh);
549 handle_request(&request, options, incomplete_hierarchy);
552 pidfile_close(pidfh);