1 /*-*- Mode: C; c-basic-offset: 8 -*-*/
4 This file is part of systemd.
6 Copyright 2010 Lennart Poettering
8 systemd is free software; you can redistribute it and/or modify it
9 under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 systemd is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with systemd; If not, see <http://www.gnu.org/licenses/>.
24 #include <sys/mount.h>
27 #include <sys/epoll.h>
29 #include <linux/auto_fs4.h>
30 #include <linux/auto_dev-ioctl.h>
33 #include "automount.h"
34 #include "load-fragment.h"
35 #include "load-dropin.h"
36 #include "unit-name.h"
37 #include "dbus-automount.h"
39 static const UnitActiveState state_translation_table[_AUTOMOUNT_STATE_MAX] = {
40 [AUTOMOUNT_DEAD] = UNIT_INACTIVE,
41 [AUTOMOUNT_WAITING] = UNIT_ACTIVE,
42 [AUTOMOUNT_RUNNING] = UNIT_ACTIVE,
43 [AUTOMOUNT_MAINTAINANCE] = UNIT_INACTIVE,
46 static int open_dev_autofs(Manager *m);
48 static void automount_init(Unit *u) {
49 Automount *a = AUTOMOUNT(u);
52 assert(u->meta.load_state == UNIT_STUB);
54 a->pipe_watch.fd = a->pipe_fd = -1;
55 a->pipe_watch.type = WATCH_INVALID;
58 static void repeat_unmout(const char *path) {
62 /* If there are multiple mounts on a mount point, this
65 if (umount2(path, MNT_DETACH) >= 0)
69 log_error("Failed to unmount: %m");
75 static void unmount_autofs(Automount *a) {
81 automount_send_ready(a, -EHOSTDOWN);
83 unit_unwatch_fd(UNIT(a), &a->pipe_watch);
84 close_nointr_nofail(a->pipe_fd);
87 /* If we reload/reexecute things we keep the mount point
90 (UNIT(a)->meta.manager->exit_code != MANAGER_RELOAD &&
91 UNIT(a)->meta.manager->exit_code != MANAGER_REEXECUTE))
92 repeat_unmout(a->where);
95 static void automount_done(Unit *u) {
96 Automount *a = AUTOMOUNT(u);
110 int automount_add_one_mount_link(Automount *a, Mount *m) {
116 if (a->meta.load_state != UNIT_LOADED ||
117 m->meta.load_state != UNIT_LOADED)
120 if (!path_startswith(a->where, m->where))
123 if (path_equal(a->where, m->where))
126 if ((r = unit_add_dependency(UNIT(m), UNIT_BEFORE, UNIT(a), true)) < 0)
129 if ((r = unit_add_dependency(UNIT(a), UNIT_REQUIRES, UNIT(m), true)) < 0)
135 static int automount_add_mount_links(Automount *a) {
141 LIST_FOREACH(units_per_type, other, a->meta.manager->units_per_type[UNIT_MOUNT])
142 if ((r = automount_add_one_mount_link(a, (Mount*) other)) < 0)
148 static int automount_verify(Automount *a) {
153 if (UNIT(a)->meta.load_state != UNIT_LOADED)
156 if (!(e = unit_name_from_path(a->where, ".automount")))
159 b = unit_has_name(UNIT(a), e);
163 log_error("%s's Where setting doesn't match unit name. Refusing.", UNIT(a)->meta.id);
170 static int automount_load(Unit *u) {
172 Automount *a = AUTOMOUNT(u);
175 assert(u->meta.load_state == UNIT_STUB);
177 /* Load a .automount file */
178 if ((r = unit_load_fragment_and_dropin_optional(u)) < 0)
181 if (u->meta.load_state == UNIT_LOADED) {
184 if (!(a->where = unit_name_to_path(u->meta.id)))
187 path_kill_slashes(a->where);
189 if ((r = automount_add_mount_links(a)) < 0)
192 if ((r = unit_load_related_unit(u, ".mount", (Unit**) &a->mount)) < 0)
195 if ((r = unit_add_dependency(u, UNIT_BEFORE, UNIT(a->mount), true)) < 0)
199 return automount_verify(a);
202 static void automount_set_state(Automount *a, AutomountState state) {
203 AutomountState old_state;
206 old_state = a->state;
209 if (state != AUTOMOUNT_WAITING &&
210 state != AUTOMOUNT_RUNNING)
213 if (state != old_state)
214 log_debug("%s changed %s -> %s",
216 automount_state_to_string(old_state),
217 automount_state_to_string(state));
219 unit_notify(UNIT(a), state_translation_table[old_state], state_translation_table[state]);
222 static int automount_coldplug(Unit *u) {
223 Automount *a = AUTOMOUNT(u);
227 assert(a->state == AUTOMOUNT_DEAD);
229 if (a->deserialized_state != a->state) {
231 if ((r = open_dev_autofs(u->meta.manager)) < 0)
234 if (a->deserialized_state == AUTOMOUNT_WAITING ||
235 a->deserialized_state == AUTOMOUNT_RUNNING) {
237 assert(a->pipe_fd >= 0);
239 if ((r = unit_watch_fd(UNIT(a), a->pipe_fd, EPOLLIN, &a->pipe_watch)) < 0)
243 automount_set_state(a, a->deserialized_state);
249 static void automount_dump(Unit *u, FILE *f, const char *prefix) {
250 Automount *a = AUTOMOUNT(u);
255 "%sAutomount State: %s\n"
257 prefix, automount_state_to_string(a->state),
261 static void automount_enter_dead(Automount *a, bool success) {
267 automount_set_state(a, a->failure ? AUTOMOUNT_MAINTAINANCE : AUTOMOUNT_DEAD);
270 static int open_dev_autofs(Manager *m) {
271 struct autofs_dev_ioctl param;
275 if (m->dev_autofs_fd >= 0)
276 return m->dev_autofs_fd;
278 if ((m->dev_autofs_fd = open("/dev/autofs", O_CLOEXEC|O_RDONLY)) < 0) {
280 if (errno == ENOENT || errno == ENODEV) {
281 log_error("Your kernel apparently lacks built-in autofs4 support. Please fix that. "
282 "We'll now try to work around this by calling 'modprobe autofs4'...");
283 system("/sbin/modprobe -q -- autofs4");
284 m->dev_autofs_fd = open("/dev/autofs", O_CLOEXEC|O_RDONLY);
287 if (m->dev_autofs_fd < 0) {
288 log_error("Failed to open /dev/autofs: %s", strerror(errno));
293 init_autofs_dev_ioctl(¶m);
294 if (ioctl(m->dev_autofs_fd, AUTOFS_DEV_IOCTL_VERSION, ¶m) < 0) {
295 close_nointr_nofail(m->dev_autofs_fd);
296 m->dev_autofs_fd = -1;
300 log_debug("Autofs kernel version %i.%i", param.ver_major, param.ver_minor);
302 return m->dev_autofs_fd;
305 static int open_ioctl_fd(int dev_autofs_fd, const char *where, dev_t devid) {
306 struct autofs_dev_ioctl *param;
310 assert(dev_autofs_fd >= 0);
313 l = sizeof(struct autofs_dev_ioctl) + strlen(where) + 1;
315 if (!(param = malloc(l)))
318 init_autofs_dev_ioctl(param);
321 param->openmount.devid = devid;
322 strcpy(param->path, where);
324 if (ioctl(dev_autofs_fd, AUTOFS_DEV_IOCTL_OPENMOUNT, param) < 0) {
329 if (param->ioctlfd < 0) {
334 fd_cloexec(param->ioctlfd, true);
342 static int autofs_protocol(int dev_autofs_fd, int ioctl_fd) {
343 uint32_t major, minor;
344 struct autofs_dev_ioctl param;
346 assert(dev_autofs_fd >= 0);
347 assert(ioctl_fd >= 0);
349 init_autofs_dev_ioctl(¶m);
350 param.ioctlfd = ioctl_fd;
352 if (ioctl(dev_autofs_fd, AUTOFS_DEV_IOCTL_PROTOVER, ¶m) < 0)
355 major = param.protover.version;
357 init_autofs_dev_ioctl(¶m);
358 param.ioctlfd = ioctl_fd;
360 if (ioctl(dev_autofs_fd, AUTOFS_DEV_IOCTL_PROTOSUBVER, ¶m) < 0)
363 minor = param.protosubver.sub_version;
365 log_debug("Autofs protocol version %i.%i", major, minor);
369 static int autofs_set_timeout(int dev_autofs_fd, int ioctl_fd, time_t sec) {
370 struct autofs_dev_ioctl param;
372 assert(dev_autofs_fd >= 0);
373 assert(ioctl_fd >= 0);
375 init_autofs_dev_ioctl(¶m);
376 param.ioctlfd = ioctl_fd;
377 param.timeout.timeout = sec;
379 if (ioctl(dev_autofs_fd, AUTOFS_DEV_IOCTL_TIMEOUT, ¶m) < 0)
385 static int autofs_send_ready(int dev_autofs_fd, int ioctl_fd, uint32_t token, int status) {
386 struct autofs_dev_ioctl param;
388 assert(dev_autofs_fd >= 0);
389 assert(ioctl_fd >= 0);
391 init_autofs_dev_ioctl(¶m);
392 param.ioctlfd = ioctl_fd;
395 param.fail.token = token;
396 param.fail.status = status;
398 param.ready.token = token;
400 if (ioctl(dev_autofs_fd, status ? AUTOFS_DEV_IOCTL_FAIL : AUTOFS_DEV_IOCTL_READY, ¶m) < 0)
406 int automount_send_ready(Automount *a, int status) {
413 if (set_isempty(a->tokens))
416 if ((ioctl_fd = open_ioctl_fd(UNIT(a)->meta.manager->dev_autofs_fd, a->where, a->dev_id)) < 0) {
422 log_debug("Sending failure: %s", strerror(-status));
424 log_debug("Sending success.");
426 /* Autofs thankfully does not hand out 0 as a token */
427 while ((token = PTR_TO_UINT(set_steal_first(a->tokens)))) {
430 /* Autofs fun fact II:
432 * if you pass a positive status code here, the kernel will
435 if ((k = autofs_send_ready(UNIT(a)->meta.manager->dev_autofs_fd,
446 close_nointr_nofail(ioctl_fd);
451 static void automount_enter_waiting(Automount *a) {
452 int p[2] = { -1, -1 };
453 char name[32], options[128];
454 bool mounted = false;
455 int r, ioctl_fd = -1, dev_autofs_fd;
459 assert(a->pipe_fd < 0);
463 set_clear(a->tokens);
465 if ((dev_autofs_fd = open_dev_autofs(UNIT(a)->meta.manager)) < 0) {
470 /* We knowingly ignore the results of this call */
471 mkdir_p(a->where, 0555);
473 if (pipe2(p, O_NONBLOCK|O_CLOEXEC) < 0) {
478 snprintf(options, sizeof(options), "fd=%i,pgrp=%u,minproto=5,maxproto=5,direct", p[1], (unsigned) getpgrp());
479 char_array_0(options);
481 snprintf(name, sizeof(name), "systemd-%u", (unsigned) getpid());
484 if (mount(name, a->where, "autofs", 0, options) < 0) {
491 close_nointr_nofail(p[1]);
494 if (stat(a->where, &st) < 0) {
499 if ((ioctl_fd = open_ioctl_fd(dev_autofs_fd, a->where, st.st_dev)) < 0) {
504 if ((r = autofs_protocol(dev_autofs_fd, ioctl_fd)) < 0)
507 if ((r = autofs_set_timeout(dev_autofs_fd, ioctl_fd, 300)) < 0)
512 * Unless we close the ioctl fd here, for some weird reason
513 * the direct mount will not receive events from the
516 close_nointr_nofail(ioctl_fd);
519 if ((r = unit_watch_fd(UNIT(a), p[0], EPOLLIN, &a->pipe_watch)) < 0)
523 a->dev_id = st.st_dev;
525 automount_set_state(a, AUTOMOUNT_WAITING);
530 assert_se(close_pipe(p) == 0);
533 close_nointr_nofail(ioctl_fd);
536 repeat_unmout(a->where);
538 log_error("Failed to initialize automounter: %s", strerror(-r));
539 automount_enter_dead(a, false);
542 static void automount_enter_runnning(Automount *a) {
549 /* Before we do anything, let's see if somebody is playing games with us? */
551 if (stat(a->where, &st) < 0) {
552 log_warning("%s failed stat automount point: %m", a->meta.id);
556 if (!S_ISDIR(st.st_mode) || st.st_dev != a->dev_id)
557 log_info("%s's automount point already active?", a->meta.id);
558 else if ((r = manager_add_job(UNIT(a)->meta.manager, JOB_START, UNIT(a->mount), JOB_REPLACE, true, NULL)) < 0) {
559 log_warning("%s failed to queue mount startup job: %s", a->meta.id, strerror(-r));
563 automount_set_state(a, AUTOMOUNT_RUNNING);
567 automount_enter_dead(a, false);
570 static int automount_start(Unit *u) {
571 Automount *a = AUTOMOUNT(u);
575 if (path_is_mount_point(a->where)) {
576 log_error("Path %s is already a mount point, refusing start for %s", a->where, u->meta.id);
580 assert(a->state == AUTOMOUNT_DEAD || a->state == AUTOMOUNT_MAINTAINANCE);
583 automount_enter_waiting(a);
587 static int automount_stop(Unit *u) {
588 Automount *a = AUTOMOUNT(u);
592 assert(a->state == AUTOMOUNT_WAITING || a->state == AUTOMOUNT_RUNNING);
594 automount_enter_dead(a, true);
598 static int automount_serialize(Unit *u, FILE *f, FDSet *fds) {
599 Automount *a = AUTOMOUNT(u);
607 unit_serialize_item(u, f, "state", automount_state_to_string(a->state));
608 unit_serialize_item(u, f, "failure", yes_no(a->failure));
609 unit_serialize_item_format(u, f, "dev-id", "%u", (unsigned) a->dev_id);
611 SET_FOREACH(p, a->tokens, i)
612 unit_serialize_item_format(u, f, "token", "%u", PTR_TO_UINT(p));
614 if (a->pipe_fd >= 0) {
617 if ((copy = fdset_put_dup(fds, a->pipe_fd)) < 0)
620 unit_serialize_item_format(u, f, "pipe-fd", "%i", copy);
626 static int automount_deserialize_item(Unit *u, const char *key, const char *value, FDSet *fds) {
627 Automount *a = AUTOMOUNT(u);
633 if (streq(key, "state")) {
634 AutomountState state;
636 if ((state = automount_state_from_string(value)) < 0)
637 log_debug("Failed to parse state value %s", value);
639 a->deserialized_state = state;
640 } else if (streq(key, "failure")) {
643 if ((b = parse_boolean(value)) < 0)
644 log_debug("Failed to parse failure value %s", value);
646 a->failure = b || a->failure;
647 } else if (streq(key, "dev-id")) {
650 if (safe_atou(value, &d) < 0)
651 log_debug("Failed to parse dev-id value %s", value);
653 a->dev_id = (unsigned) d;
654 } else if (streq(key, "token")) {
657 if (safe_atou(value, &token) < 0)
658 log_debug("Failed to parse token value %s", value);
661 if (!(a->tokens = set_new(trivial_hash_func, trivial_compare_func)))
664 if ((r = set_put(a->tokens, UINT_TO_PTR(token))) < 0)
667 } else if (streq(key, "pipe-fd")) {
670 if (safe_atoi(value, &fd) < 0 || fd < 0 || !fdset_contains(fds, fd))
671 log_debug("Failed to parse pipe-fd value %s", value);
674 close_nointr_nofail(a->pipe_fd);
676 a->pipe_fd = fdset_remove(fds, fd);
679 log_debug("Unknown serialization key '%s'", key);
684 static UnitActiveState automount_active_state(Unit *u) {
687 return state_translation_table[AUTOMOUNT(u)->state];
690 static const char *automount_sub_state_to_string(Unit *u) {
693 return automount_state_to_string(AUTOMOUNT(u)->state);
696 static bool automount_check_gc(Unit *u) {
697 Automount *a = AUTOMOUNT(u);
701 return UNIT_VTABLE(UNIT(a->mount))->check_gc(UNIT(a->mount));
704 static void automount_fd_event(Unit *u, int fd, uint32_t events, Watch *w) {
705 Automount *a = AUTOMOUNT(u);
706 union autofs_v5_packet_union packet;
711 assert(fd == a->pipe_fd);
713 if (events != EPOLLIN) {
714 log_error("Got invalid poll event on pipe.");
718 if ((l = loop_read(a->pipe_fd, &packet, sizeof(packet))) != sizeof(packet)) {
719 log_error("Invalid read from pipe: %s", l < 0 ? strerror(-l) : "short read");
723 switch (packet.hdr.type) {
725 case autofs_ptype_missing_direct:
726 log_debug("Got direct mount request for %s", packet.v5_packet.name);
729 if (!(a->tokens = set_new(trivial_hash_func, trivial_compare_func))) {
730 log_error("Failed to allocate token set.");
734 if ((r = set_put(a->tokens, UINT_TO_PTR(packet.v5_packet.wait_queue_token))) < 0) {
735 log_error("Failed to remember token: %s", strerror(-r));
739 automount_enter_runnning(a);
743 log_error("Received unknown automount request %i", packet.hdr.type);
750 automount_enter_dead(a, false);
753 static void automount_shutdown(Manager *m) {
756 if (m->dev_autofs_fd >= 0)
757 close_nointr_nofail(m->dev_autofs_fd);
760 static const char* const automount_state_table[_AUTOMOUNT_STATE_MAX] = {
761 [AUTOMOUNT_DEAD] = "dead",
762 [AUTOMOUNT_WAITING] = "waiting",
763 [AUTOMOUNT_RUNNING] = "running",
764 [AUTOMOUNT_MAINTAINANCE] = "maintainance"
767 DEFINE_STRING_TABLE_LOOKUP(automount_state, AutomountState);
769 const UnitVTable automount_vtable = {
770 .suffix = ".automount",
773 .no_instances = true,
775 .init = automount_init,
776 .load = automount_load,
777 .done = automount_done,
779 .coldplug = automount_coldplug,
781 .dump = automount_dump,
783 .start = automount_start,
784 .stop = automount_stop,
786 .serialize = automount_serialize,
787 .deserialize_item = automount_deserialize_item,
789 .active_state = automount_active_state,
790 .sub_state_to_string = automount_sub_state_to_string,
792 .check_gc = automount_check_gc,
794 .fd_event = automount_fd_event,
796 .bus_message_handler = bus_automount_message_handler,
798 .shutdown = automount_shutdown