1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
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"
38 #include "bus-errors.h"
42 static const UnitActiveState state_translation_table[_AUTOMOUNT_STATE_MAX] = {
43 [AUTOMOUNT_DEAD] = UNIT_INACTIVE,
44 [AUTOMOUNT_WAITING] = UNIT_ACTIVE,
45 [AUTOMOUNT_RUNNING] = UNIT_ACTIVE,
46 [AUTOMOUNT_FAILED] = UNIT_FAILED
49 static int open_dev_autofs(Manager *m);
51 static void automount_init(Unit *u) {
52 Automount *a = AUTOMOUNT(u);
55 assert(u->meta.load_state == UNIT_STUB);
57 a->pipe_watch.fd = a->pipe_fd = -1;
58 a->pipe_watch.type = WATCH_INVALID;
60 a->directory_mode = 0755;
63 static void repeat_unmout(const char *path) {
67 /* If there are multiple mounts on a mount point, this
70 if (umount2(path, MNT_DETACH) >= 0)
74 log_error("Failed to unmount: %m");
80 static void unmount_autofs(Automount *a) {
86 automount_send_ready(a, -EHOSTDOWN);
88 unit_unwatch_fd(UNIT(a), &a->pipe_watch);
89 close_nointr_nofail(a->pipe_fd);
92 /* If we reload/reexecute things we keep the mount point
95 (a->meta.manager->exit_code != MANAGER_RELOAD &&
96 a->meta.manager->exit_code != MANAGER_REEXECUTE))
97 repeat_unmout(a->where);
100 static void automount_done(Unit *u) {
101 Automount *a = AUTOMOUNT(u);
115 int automount_add_one_mount_link(Automount *a, Mount *m) {
121 if (a->meta.load_state != UNIT_LOADED ||
122 m->meta.load_state != UNIT_LOADED)
125 if (!path_startswith(a->where, m->where))
128 if (path_equal(a->where, m->where))
131 if ((r = unit_add_two_dependencies(UNIT(a), UNIT_AFTER, UNIT_REQUIRES, UNIT(m), true)) < 0)
137 static int automount_add_mount_links(Automount *a) {
143 LIST_FOREACH(units_per_type, other, a->meta.manager->units_per_type[UNIT_MOUNT])
144 if ((r = automount_add_one_mount_link(a, (Mount*) other)) < 0)
150 static int automount_add_default_dependencies(Automount *a) {
155 if (a->meta.manager->running_as == MANAGER_SYSTEM) {
157 if ((r = unit_add_dependency_by_name(UNIT(a), UNIT_BEFORE, SPECIAL_BASIC_TARGET, NULL, true)) < 0)
160 if ((r = unit_add_two_dependencies_by_name(UNIT(a), UNIT_BEFORE, UNIT_CONFLICTS, SPECIAL_UMOUNT_TARGET, NULL, true)) < 0)
167 static int automount_verify(Automount *a) {
172 if (a->meta.load_state != UNIT_LOADED)
175 if (path_equal(a->where, "/")) {
176 log_error("Cannot have an automount unit for the root directory. Refusing.");
180 if (!(e = unit_name_from_path(a->where, ".automount")))
183 b = unit_has_name(UNIT(a), e);
187 log_error("%s's Where setting doesn't match unit name. Refusing.", a->meta.id);
194 static int automount_load(Unit *u) {
196 Automount *a = AUTOMOUNT(u);
199 assert(u->meta.load_state == UNIT_STUB);
201 /* Load a .automount file */
202 if ((r = unit_load_fragment_and_dropin_optional(u)) < 0)
205 if (u->meta.load_state == UNIT_LOADED) {
208 if (!(a->where = unit_name_to_path(u->meta.id)))
211 path_kill_slashes(a->where);
213 if ((r = automount_add_mount_links(a)) < 0)
216 if ((r = unit_load_related_unit(u, ".mount", (Unit**) &a->mount)) < 0)
219 if ((r = unit_add_dependency(u, UNIT_BEFORE, UNIT(a->mount), true)) < 0)
222 if (a->meta.default_dependencies)
223 if ((r = automount_add_default_dependencies(a)) < 0)
227 return automount_verify(a);
230 static void automount_set_state(Automount *a, AutomountState state) {
231 AutomountState old_state;
234 old_state = a->state;
237 if (state != AUTOMOUNT_WAITING &&
238 state != AUTOMOUNT_RUNNING)
241 if (state != old_state)
242 log_debug("%s changed %s -> %s",
244 automount_state_to_string(old_state),
245 automount_state_to_string(state));
247 unit_notify(UNIT(a), state_translation_table[old_state], state_translation_table[state], true);
250 static int automount_coldplug(Unit *u) {
251 Automount *a = AUTOMOUNT(u);
255 assert(a->state == AUTOMOUNT_DEAD);
257 if (a->deserialized_state != a->state) {
259 if ((r = open_dev_autofs(u->meta.manager)) < 0)
262 if (a->deserialized_state == AUTOMOUNT_WAITING ||
263 a->deserialized_state == AUTOMOUNT_RUNNING) {
265 assert(a->pipe_fd >= 0);
267 if ((r = unit_watch_fd(UNIT(a), a->pipe_fd, EPOLLIN, &a->pipe_watch)) < 0)
271 automount_set_state(a, a->deserialized_state);
277 static void automount_dump(Unit *u, FILE *f, const char *prefix) {
278 Automount *a = AUTOMOUNT(u);
283 "%sAutomount State: %s\n"
285 "%sDirectoryMode: %04o\n",
286 prefix, automount_state_to_string(a->state),
288 prefix, a->directory_mode);
291 static void automount_enter_dead(Automount *a, bool success) {
297 automount_set_state(a, a->failure ? AUTOMOUNT_FAILED : AUTOMOUNT_DEAD);
300 static int open_dev_autofs(Manager *m) {
301 struct autofs_dev_ioctl param;
305 if (m->dev_autofs_fd >= 0)
306 return m->dev_autofs_fd;
308 label_fix("/dev/autofs");
310 if ((m->dev_autofs_fd = open("/dev/autofs", O_CLOEXEC|O_RDONLY)) < 0) {
311 log_error("Failed to open /dev/autofs: %s", strerror(errno));
315 init_autofs_dev_ioctl(¶m);
316 if (ioctl(m->dev_autofs_fd, AUTOFS_DEV_IOCTL_VERSION, ¶m) < 0) {
317 close_nointr_nofail(m->dev_autofs_fd);
318 m->dev_autofs_fd = -1;
322 log_debug("Autofs kernel version %i.%i", param.ver_major, param.ver_minor);
324 return m->dev_autofs_fd;
327 static int open_ioctl_fd(int dev_autofs_fd, const char *where, dev_t devid) {
328 struct autofs_dev_ioctl *param;
332 assert(dev_autofs_fd >= 0);
335 l = sizeof(struct autofs_dev_ioctl) + strlen(where) + 1;
337 if (!(param = malloc(l)))
340 init_autofs_dev_ioctl(param);
343 param->openmount.devid = devid;
344 strcpy(param->path, where);
346 if (ioctl(dev_autofs_fd, AUTOFS_DEV_IOCTL_OPENMOUNT, param) < 0) {
351 if (param->ioctlfd < 0) {
356 fd_cloexec(param->ioctlfd, true);
364 static int autofs_protocol(int dev_autofs_fd, int ioctl_fd) {
365 uint32_t major, minor;
366 struct autofs_dev_ioctl param;
368 assert(dev_autofs_fd >= 0);
369 assert(ioctl_fd >= 0);
371 init_autofs_dev_ioctl(¶m);
372 param.ioctlfd = ioctl_fd;
374 if (ioctl(dev_autofs_fd, AUTOFS_DEV_IOCTL_PROTOVER, ¶m) < 0)
377 major = param.protover.version;
379 init_autofs_dev_ioctl(¶m);
380 param.ioctlfd = ioctl_fd;
382 if (ioctl(dev_autofs_fd, AUTOFS_DEV_IOCTL_PROTOSUBVER, ¶m) < 0)
385 minor = param.protosubver.sub_version;
387 log_debug("Autofs protocol version %i.%i", major, minor);
391 static int autofs_set_timeout(int dev_autofs_fd, int ioctl_fd, time_t sec) {
392 struct autofs_dev_ioctl param;
394 assert(dev_autofs_fd >= 0);
395 assert(ioctl_fd >= 0);
397 init_autofs_dev_ioctl(¶m);
398 param.ioctlfd = ioctl_fd;
399 param.timeout.timeout = sec;
401 if (ioctl(dev_autofs_fd, AUTOFS_DEV_IOCTL_TIMEOUT, ¶m) < 0)
407 static int autofs_send_ready(int dev_autofs_fd, int ioctl_fd, uint32_t token, int status) {
408 struct autofs_dev_ioctl param;
410 assert(dev_autofs_fd >= 0);
411 assert(ioctl_fd >= 0);
413 init_autofs_dev_ioctl(¶m);
414 param.ioctlfd = ioctl_fd;
417 param.fail.token = token;
418 param.fail.status = status;
420 param.ready.token = token;
422 if (ioctl(dev_autofs_fd, status ? AUTOFS_DEV_IOCTL_FAIL : AUTOFS_DEV_IOCTL_READY, ¶m) < 0)
428 int automount_send_ready(Automount *a, int status) {
435 if (set_isempty(a->tokens))
438 if ((ioctl_fd = open_ioctl_fd(a->meta.manager->dev_autofs_fd, a->where, a->dev_id)) < 0) {
444 log_debug("Sending failure: %s", strerror(-status));
446 log_debug("Sending success.");
450 /* Autofs thankfully does not hand out 0 as a token */
451 while ((token = PTR_TO_UINT(set_steal_first(a->tokens)))) {
454 /* Autofs fun fact II:
456 * if you pass a positive status code here, the kernel will
459 if ((k = autofs_send_ready(a->meta.manager->dev_autofs_fd,
468 close_nointr_nofail(ioctl_fd);
473 static void automount_enter_waiting(Automount *a) {
474 int p[2] = { -1, -1 };
475 char name[32], options[128];
476 bool mounted = false;
477 int r, ioctl_fd = -1, dev_autofs_fd;
481 assert(a->pipe_fd < 0);
485 set_clear(a->tokens);
487 if ((dev_autofs_fd = open_dev_autofs(a->meta.manager)) < 0) {
492 /* We knowingly ignore the results of this call */
493 mkdir_p(a->where, 0555);
495 if (pipe2(p, O_NONBLOCK|O_CLOEXEC) < 0) {
500 snprintf(options, sizeof(options), "fd=%i,pgrp=%u,minproto=5,maxproto=5,direct", p[1], (unsigned) getpgrp());
501 char_array_0(options);
503 snprintf(name, sizeof(name), "systemd-%u", (unsigned) getpid());
506 if (mount(name, a->where, "autofs", 0, options) < 0) {
513 close_nointr_nofail(p[1]);
516 if (stat(a->where, &st) < 0) {
521 if ((ioctl_fd = open_ioctl_fd(dev_autofs_fd, a->where, st.st_dev)) < 0) {
526 if ((r = autofs_protocol(dev_autofs_fd, ioctl_fd)) < 0)
529 if ((r = autofs_set_timeout(dev_autofs_fd, ioctl_fd, 300)) < 0)
534 * Unless we close the ioctl fd here, for some weird reason
535 * the direct mount will not receive events from the
538 close_nointr_nofail(ioctl_fd);
541 if ((r = unit_watch_fd(UNIT(a), p[0], EPOLLIN, &a->pipe_watch)) < 0)
545 a->dev_id = st.st_dev;
547 automount_set_state(a, AUTOMOUNT_WAITING);
552 assert_se(close_pipe(p) == 0);
555 close_nointr_nofail(ioctl_fd);
558 repeat_unmout(a->where);
560 log_error("Failed to initialize automounter: %s", strerror(-r));
561 automount_enter_dead(a, false);
564 static void automount_enter_runnning(Automount *a) {
572 dbus_error_init(&error);
574 /* We don't take mount requests anymore if we are supposed to
575 * shut down anyway */
576 if (a->meta.job && a->meta.job->type == JOB_STOP) {
577 automount_send_ready(a, -EHOSTDOWN);
581 mkdir_p(a->where, a->directory_mode);
583 /* Before we do anything, let's see if somebody is playing games with us? */
584 if (lstat(a->where, &st) < 0) {
585 log_warning("%s failed stat automount point: %m", a->meta.id);
589 if (!S_ISDIR(st.st_mode) || st.st_dev != a->dev_id)
590 log_info("%s's automount point already active?", a->meta.id);
591 else if ((r = manager_add_job(a->meta.manager, JOB_START, UNIT(a->mount), JOB_REPLACE, true, &error, NULL)) < 0) {
592 log_warning("%s failed to queue mount startup job: %s", a->meta.id, bus_error(&error, r));
596 automount_set_state(a, AUTOMOUNT_RUNNING);
600 automount_enter_dead(a, false);
601 dbus_error_free(&error);
604 static int automount_start(Unit *u) {
605 Automount *a = AUTOMOUNT(u);
609 assert(a->state == AUTOMOUNT_DEAD || a->state == AUTOMOUNT_FAILED);
611 if (path_is_mount_point(a->where)) {
612 log_error("Path %s is already a mount point, refusing start for %s", a->where, u->meta.id);
616 if (a->mount->meta.load_state != UNIT_LOADED)
620 automount_enter_waiting(a);
624 static int automount_stop(Unit *u) {
625 Automount *a = AUTOMOUNT(u);
629 assert(a->state == AUTOMOUNT_WAITING || a->state == AUTOMOUNT_RUNNING);
631 automount_enter_dead(a, true);
635 static int automount_serialize(Unit *u, FILE *f, FDSet *fds) {
636 Automount *a = AUTOMOUNT(u);
644 unit_serialize_item(u, f, "state", automount_state_to_string(a->state));
645 unit_serialize_item(u, f, "failure", yes_no(a->failure));
646 unit_serialize_item_format(u, f, "dev-id", "%u", (unsigned) a->dev_id);
648 SET_FOREACH(p, a->tokens, i)
649 unit_serialize_item_format(u, f, "token", "%u", PTR_TO_UINT(p));
651 if (a->pipe_fd >= 0) {
654 if ((copy = fdset_put_dup(fds, a->pipe_fd)) < 0)
657 unit_serialize_item_format(u, f, "pipe-fd", "%i", copy);
663 static int automount_deserialize_item(Unit *u, const char *key, const char *value, FDSet *fds) {
664 Automount *a = AUTOMOUNT(u);
670 if (streq(key, "state")) {
671 AutomountState state;
673 if ((state = automount_state_from_string(value)) < 0)
674 log_debug("Failed to parse state value %s", value);
676 a->deserialized_state = state;
677 } else if (streq(key, "failure")) {
680 if ((b = parse_boolean(value)) < 0)
681 log_debug("Failed to parse failure value %s", value);
683 a->failure = b || a->failure;
684 } else if (streq(key, "dev-id")) {
687 if (safe_atou(value, &d) < 0)
688 log_debug("Failed to parse dev-id value %s", value);
690 a->dev_id = (unsigned) d;
691 } else if (streq(key, "token")) {
694 if (safe_atou(value, &token) < 0)
695 log_debug("Failed to parse token value %s", value);
698 if (!(a->tokens = set_new(trivial_hash_func, trivial_compare_func)))
701 if ((r = set_put(a->tokens, UINT_TO_PTR(token))) < 0)
704 } else if (streq(key, "pipe-fd")) {
707 if (safe_atoi(value, &fd) < 0 || fd < 0 || !fdset_contains(fds, fd))
708 log_debug("Failed to parse pipe-fd value %s", value);
711 close_nointr_nofail(a->pipe_fd);
713 a->pipe_fd = fdset_remove(fds, fd);
716 log_debug("Unknown serialization key '%s'", key);
721 static UnitActiveState automount_active_state(Unit *u) {
724 return state_translation_table[AUTOMOUNT(u)->state];
727 static const char *automount_sub_state_to_string(Unit *u) {
730 return automount_state_to_string(AUTOMOUNT(u)->state);
733 static bool automount_check_gc(Unit *u) {
734 Automount *a = AUTOMOUNT(u);
741 return UNIT_VTABLE(UNIT(a->mount))->check_gc(UNIT(a->mount));
744 static void automount_fd_event(Unit *u, int fd, uint32_t events, Watch *w) {
745 Automount *a = AUTOMOUNT(u);
746 union autofs_v5_packet_union packet;
751 assert(fd == a->pipe_fd);
753 if (events != EPOLLIN) {
754 log_error("Got invalid poll event on pipe.");
758 if ((l = loop_read(a->pipe_fd, &packet, sizeof(packet), true)) != sizeof(packet)) {
759 log_error("Invalid read from pipe: %s", l < 0 ? strerror(-l) : "short read");
763 switch (packet.hdr.type) {
765 case autofs_ptype_missing_direct:
767 if (packet.v5_packet.pid > 0) {
770 get_process_name(packet.v5_packet.pid, &p);
771 log_debug("Got direct mount request for %s, triggered by %lu (%s)", packet.v5_packet.name, (unsigned long) packet.v5_packet.pid, strna(p));
775 log_debug("Got direct mount request for %s", packet.v5_packet.name);
778 if (!(a->tokens = set_new(trivial_hash_func, trivial_compare_func))) {
779 log_error("Failed to allocate token set.");
783 if ((r = set_put(a->tokens, UINT_TO_PTR(packet.v5_packet.wait_queue_token))) < 0) {
784 log_error("Failed to remember token: %s", strerror(-r));
788 automount_enter_runnning(a);
792 log_error("Received unknown automount request %i", packet.hdr.type);
799 automount_enter_dead(a, false);
802 static void automount_shutdown(Manager *m) {
805 if (m->dev_autofs_fd >= 0)
806 close_nointr_nofail(m->dev_autofs_fd);
809 static void automount_reset_failed(Unit *u) {
810 Automount *a = AUTOMOUNT(u);
814 if (a->state == AUTOMOUNT_FAILED)
815 automount_set_state(a, AUTOMOUNT_DEAD);
820 static const char* const automount_state_table[_AUTOMOUNT_STATE_MAX] = {
821 [AUTOMOUNT_DEAD] = "dead",
822 [AUTOMOUNT_WAITING] = "waiting",
823 [AUTOMOUNT_RUNNING] = "running",
824 [AUTOMOUNT_FAILED] = "failed"
827 DEFINE_STRING_TABLE_LOOKUP(automount_state, AutomountState);
829 const UnitVTable automount_vtable = {
830 .suffix = ".automount",
833 .no_instances = true,
835 .init = automount_init,
836 .load = automount_load,
837 .done = automount_done,
839 .coldplug = automount_coldplug,
841 .dump = automount_dump,
843 .start = automount_start,
844 .stop = automount_stop,
846 .serialize = automount_serialize,
847 .deserialize_item = automount_deserialize_item,
849 .active_state = automount_active_state,
850 .sub_state_to_string = automount_sub_state_to_string,
852 .check_gc = automount_check_gc,
854 .fd_event = automount_fd_event,
856 .reset_failed = automount_reset_failed,
858 .bus_interface = "org.freedesktop.systemd1.Automount",
859 .bus_message_handler = bus_automount_message_handler,
861 .shutdown = automount_shutdown