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;
62 a->meta.ignore_on_isolate = true;
65 static void repeat_unmout(const char *path) {
69 /* If there are multiple mounts on a mount point, this
72 if (umount2(path, MNT_DETACH) >= 0)
76 log_error("Failed to unmount: %m");
82 static void unmount_autofs(Automount *a) {
88 automount_send_ready(a, -EHOSTDOWN);
90 unit_unwatch_fd(UNIT(a), &a->pipe_watch);
91 close_nointr_nofail(a->pipe_fd);
94 /* If we reload/reexecute things we keep the mount point
97 (a->meta.manager->exit_code != MANAGER_RELOAD &&
98 a->meta.manager->exit_code != MANAGER_REEXECUTE))
99 repeat_unmout(a->where);
102 static void automount_done(Unit *u) {
103 Automount *a = AUTOMOUNT(u);
117 int automount_add_one_mount_link(Automount *a, Mount *m) {
123 if (a->meta.load_state != UNIT_LOADED ||
124 m->meta.load_state != UNIT_LOADED)
127 if (!path_startswith(a->where, m->where))
130 if (path_equal(a->where, m->where))
133 if ((r = unit_add_two_dependencies(UNIT(a), UNIT_AFTER, UNIT_REQUIRES, UNIT(m), true)) < 0)
139 static int automount_add_mount_links(Automount *a) {
145 LIST_FOREACH(units_by_type, other, a->meta.manager->units_by_type[UNIT_MOUNT])
146 if ((r = automount_add_one_mount_link(a, (Mount*) other)) < 0)
152 static int automount_add_default_dependencies(Automount *a) {
157 if (a->meta.manager->running_as == MANAGER_SYSTEM) {
159 if ((r = unit_add_dependency_by_name(UNIT(a), UNIT_BEFORE, SPECIAL_BASIC_TARGET, NULL, true)) < 0)
162 if ((r = unit_add_two_dependencies_by_name(UNIT(a), UNIT_BEFORE, UNIT_CONFLICTS, SPECIAL_UMOUNT_TARGET, NULL, true)) < 0)
169 static int automount_verify(Automount *a) {
174 if (a->meta.load_state != UNIT_LOADED)
177 if (path_equal(a->where, "/")) {
178 log_error("Cannot have an automount unit for the root directory. Refusing.");
182 if (!(e = unit_name_from_path(a->where, ".automount")))
185 b = unit_has_name(UNIT(a), e);
189 log_error("%s's Where setting doesn't match unit name. Refusing.", a->meta.id);
196 static int automount_load(Unit *u) {
198 Automount *a = AUTOMOUNT(u);
201 assert(u->meta.load_state == UNIT_STUB);
203 /* Load a .automount file */
204 if ((r = unit_load_fragment_and_dropin_optional(u)) < 0)
207 if (u->meta.load_state == UNIT_LOADED) {
210 if (!(a->where = unit_name_to_path(u->meta.id)))
213 path_kill_slashes(a->where);
215 if ((r = automount_add_mount_links(a)) < 0)
218 if ((r = unit_load_related_unit(u, ".mount", (Unit**) &a->mount)) < 0)
221 if ((r = unit_add_dependency(u, UNIT_BEFORE, UNIT(a->mount), true)) < 0)
224 if (a->meta.default_dependencies)
225 if ((r = automount_add_default_dependencies(a)) < 0)
229 return automount_verify(a);
232 static void automount_set_state(Automount *a, AutomountState state) {
233 AutomountState old_state;
236 old_state = a->state;
239 if (state != AUTOMOUNT_WAITING &&
240 state != AUTOMOUNT_RUNNING)
243 if (state != old_state)
244 log_debug("%s changed %s -> %s",
246 automount_state_to_string(old_state),
247 automount_state_to_string(state));
249 unit_notify(UNIT(a), state_translation_table[old_state], state_translation_table[state], true);
252 static int automount_coldplug(Unit *u) {
253 Automount *a = AUTOMOUNT(u);
257 assert(a->state == AUTOMOUNT_DEAD);
259 if (a->deserialized_state != a->state) {
261 if ((r = open_dev_autofs(u->meta.manager)) < 0)
264 if (a->deserialized_state == AUTOMOUNT_WAITING ||
265 a->deserialized_state == AUTOMOUNT_RUNNING) {
267 assert(a->pipe_fd >= 0);
269 if ((r = unit_watch_fd(UNIT(a), a->pipe_fd, EPOLLIN, &a->pipe_watch)) < 0)
273 automount_set_state(a, a->deserialized_state);
279 static void automount_dump(Unit *u, FILE *f, const char *prefix) {
280 Automount *a = AUTOMOUNT(u);
285 "%sAutomount State: %s\n"
287 "%sDirectoryMode: %04o\n",
288 prefix, automount_state_to_string(a->state),
290 prefix, a->directory_mode);
293 static void automount_enter_dead(Automount *a, bool success) {
299 automount_set_state(a, a->failure ? AUTOMOUNT_FAILED : AUTOMOUNT_DEAD);
302 static int open_dev_autofs(Manager *m) {
303 struct autofs_dev_ioctl param;
307 if (m->dev_autofs_fd >= 0)
308 return m->dev_autofs_fd;
310 label_fix("/dev/autofs", false);
312 if ((m->dev_autofs_fd = open("/dev/autofs", O_CLOEXEC|O_RDONLY)) < 0) {
313 log_error("Failed to open /dev/autofs: %s", strerror(errno));
317 init_autofs_dev_ioctl(¶m);
318 if (ioctl(m->dev_autofs_fd, AUTOFS_DEV_IOCTL_VERSION, ¶m) < 0) {
319 close_nointr_nofail(m->dev_autofs_fd);
320 m->dev_autofs_fd = -1;
324 log_debug("Autofs kernel version %i.%i", param.ver_major, param.ver_minor);
326 return m->dev_autofs_fd;
329 static int open_ioctl_fd(int dev_autofs_fd, const char *where, dev_t devid) {
330 struct autofs_dev_ioctl *param;
334 assert(dev_autofs_fd >= 0);
337 l = sizeof(struct autofs_dev_ioctl) + strlen(where) + 1;
339 if (!(param = malloc(l)))
342 init_autofs_dev_ioctl(param);
345 param->openmount.devid = devid;
346 strcpy(param->path, where);
348 if (ioctl(dev_autofs_fd, AUTOFS_DEV_IOCTL_OPENMOUNT, param) < 0) {
353 if (param->ioctlfd < 0) {
358 fd_cloexec(param->ioctlfd, true);
366 static int autofs_protocol(int dev_autofs_fd, int ioctl_fd) {
367 uint32_t major, minor;
368 struct autofs_dev_ioctl param;
370 assert(dev_autofs_fd >= 0);
371 assert(ioctl_fd >= 0);
373 init_autofs_dev_ioctl(¶m);
374 param.ioctlfd = ioctl_fd;
376 if (ioctl(dev_autofs_fd, AUTOFS_DEV_IOCTL_PROTOVER, ¶m) < 0)
379 major = param.protover.version;
381 init_autofs_dev_ioctl(¶m);
382 param.ioctlfd = ioctl_fd;
384 if (ioctl(dev_autofs_fd, AUTOFS_DEV_IOCTL_PROTOSUBVER, ¶m) < 0)
387 minor = param.protosubver.sub_version;
389 log_debug("Autofs protocol version %i.%i", major, minor);
393 static int autofs_set_timeout(int dev_autofs_fd, int ioctl_fd, time_t sec) {
394 struct autofs_dev_ioctl param;
396 assert(dev_autofs_fd >= 0);
397 assert(ioctl_fd >= 0);
399 init_autofs_dev_ioctl(¶m);
400 param.ioctlfd = ioctl_fd;
401 param.timeout.timeout = sec;
403 if (ioctl(dev_autofs_fd, AUTOFS_DEV_IOCTL_TIMEOUT, ¶m) < 0)
409 static int autofs_send_ready(int dev_autofs_fd, int ioctl_fd, uint32_t token, int status) {
410 struct autofs_dev_ioctl param;
412 assert(dev_autofs_fd >= 0);
413 assert(ioctl_fd >= 0);
415 init_autofs_dev_ioctl(¶m);
416 param.ioctlfd = ioctl_fd;
419 param.fail.token = token;
420 param.fail.status = status;
422 param.ready.token = token;
424 if (ioctl(dev_autofs_fd, status ? AUTOFS_DEV_IOCTL_FAIL : AUTOFS_DEV_IOCTL_READY, ¶m) < 0)
430 int automount_send_ready(Automount *a, int status) {
437 if (set_isempty(a->tokens))
440 if ((ioctl_fd = open_ioctl_fd(a->meta.manager->dev_autofs_fd, a->where, a->dev_id)) < 0) {
446 log_debug("Sending failure: %s", strerror(-status));
448 log_debug("Sending success.");
452 /* Autofs thankfully does not hand out 0 as a token */
453 while ((token = PTR_TO_UINT(set_steal_first(a->tokens)))) {
456 /* Autofs fun fact II:
458 * if you pass a positive status code here, the kernel will
461 if ((k = autofs_send_ready(a->meta.manager->dev_autofs_fd,
470 close_nointr_nofail(ioctl_fd);
475 static void automount_enter_waiting(Automount *a) {
476 int p[2] = { -1, -1 };
477 char name[32], options[128];
478 bool mounted = false;
479 int r, ioctl_fd = -1, dev_autofs_fd;
483 assert(a->pipe_fd < 0);
487 set_clear(a->tokens);
489 if ((dev_autofs_fd = open_dev_autofs(a->meta.manager)) < 0) {
494 /* We knowingly ignore the results of this call */
495 mkdir_p(a->where, 0555);
497 if (pipe2(p, O_NONBLOCK|O_CLOEXEC) < 0) {
502 snprintf(options, sizeof(options), "fd=%i,pgrp=%u,minproto=5,maxproto=5,direct", p[1], (unsigned) getpgrp());
503 char_array_0(options);
505 snprintf(name, sizeof(name), "systemd-%u", (unsigned) getpid());
508 if (mount(name, a->where, "autofs", 0, options) < 0) {
515 close_nointr_nofail(p[1]);
518 if (stat(a->where, &st) < 0) {
523 if ((ioctl_fd = open_ioctl_fd(dev_autofs_fd, a->where, st.st_dev)) < 0) {
528 if ((r = autofs_protocol(dev_autofs_fd, ioctl_fd)) < 0)
531 if ((r = autofs_set_timeout(dev_autofs_fd, ioctl_fd, 300)) < 0)
536 * Unless we close the ioctl fd here, for some weird reason
537 * the direct mount will not receive events from the
540 close_nointr_nofail(ioctl_fd);
543 if ((r = unit_watch_fd(UNIT(a), p[0], EPOLLIN, &a->pipe_watch)) < 0)
547 a->dev_id = st.st_dev;
549 automount_set_state(a, AUTOMOUNT_WAITING);
554 assert_se(close_pipe(p) == 0);
557 close_nointr_nofail(ioctl_fd);
560 repeat_unmout(a->where);
562 log_error("Failed to initialize automounter: %s", strerror(-r));
563 automount_enter_dead(a, false);
566 static void automount_enter_runnning(Automount *a) {
574 dbus_error_init(&error);
576 /* We don't take mount requests anymore if we are supposed to
577 * shut down anyway */
578 if (unit_pending_inactive(UNIT(a))) {
579 log_debug("Suppressing automount request on %s since unit stop is scheduled.", a->meta.id);
580 automount_send_ready(a, -EHOSTDOWN);
584 mkdir_p(a->where, a->directory_mode);
586 /* Before we do anything, let's see if somebody is playing games with us? */
587 if (lstat(a->where, &st) < 0) {
588 log_warning("%s failed to stat automount point: %m", a->meta.id);
592 if (!S_ISDIR(st.st_mode) || st.st_dev != a->dev_id)
593 log_info("%s's automount point already active?", a->meta.id);
594 else if ((r = manager_add_job(a->meta.manager, JOB_START, UNIT(a->mount), JOB_REPLACE, true, &error, NULL)) < 0) {
595 log_warning("%s failed to queue mount startup job: %s", a->meta.id, bus_error(&error, r));
599 automount_set_state(a, AUTOMOUNT_RUNNING);
603 automount_enter_dead(a, false);
604 dbus_error_free(&error);
607 static int automount_start(Unit *u) {
608 Automount *a = AUTOMOUNT(u);
612 assert(a->state == AUTOMOUNT_DEAD || a->state == AUTOMOUNT_FAILED);
614 if (path_is_mount_point(a->where)) {
615 log_error("Path %s is already a mount point, refusing start for %s", a->where, u->meta.id);
619 if (a->mount->meta.load_state != UNIT_LOADED)
623 automount_enter_waiting(a);
627 static int automount_stop(Unit *u) {
628 Automount *a = AUTOMOUNT(u);
632 assert(a->state == AUTOMOUNT_WAITING || a->state == AUTOMOUNT_RUNNING);
634 automount_enter_dead(a, true);
638 static int automount_serialize(Unit *u, FILE *f, FDSet *fds) {
639 Automount *a = AUTOMOUNT(u);
647 unit_serialize_item(u, f, "state", automount_state_to_string(a->state));
648 unit_serialize_item(u, f, "failure", yes_no(a->failure));
649 unit_serialize_item_format(u, f, "dev-id", "%u", (unsigned) a->dev_id);
651 SET_FOREACH(p, a->tokens, i)
652 unit_serialize_item_format(u, f, "token", "%u", PTR_TO_UINT(p));
654 if (a->pipe_fd >= 0) {
657 if ((copy = fdset_put_dup(fds, a->pipe_fd)) < 0)
660 unit_serialize_item_format(u, f, "pipe-fd", "%i", copy);
666 static int automount_deserialize_item(Unit *u, const char *key, const char *value, FDSet *fds) {
667 Automount *a = AUTOMOUNT(u);
673 if (streq(key, "state")) {
674 AutomountState state;
676 if ((state = automount_state_from_string(value)) < 0)
677 log_debug("Failed to parse state value %s", value);
679 a->deserialized_state = state;
680 } else if (streq(key, "failure")) {
683 if ((b = parse_boolean(value)) < 0)
684 log_debug("Failed to parse failure value %s", value);
686 a->failure = b || a->failure;
687 } else if (streq(key, "dev-id")) {
690 if (safe_atou(value, &d) < 0)
691 log_debug("Failed to parse dev-id value %s", value);
693 a->dev_id = (unsigned) d;
694 } else if (streq(key, "token")) {
697 if (safe_atou(value, &token) < 0)
698 log_debug("Failed to parse token value %s", value);
701 if (!(a->tokens = set_new(trivial_hash_func, trivial_compare_func)))
704 if ((r = set_put(a->tokens, UINT_TO_PTR(token))) < 0)
707 } else if (streq(key, "pipe-fd")) {
710 if (safe_atoi(value, &fd) < 0 || fd < 0 || !fdset_contains(fds, fd))
711 log_debug("Failed to parse pipe-fd value %s", value);
714 close_nointr_nofail(a->pipe_fd);
716 a->pipe_fd = fdset_remove(fds, fd);
719 log_debug("Unknown serialization key '%s'", key);
724 static UnitActiveState automount_active_state(Unit *u) {
727 return state_translation_table[AUTOMOUNT(u)->state];
730 static const char *automount_sub_state_to_string(Unit *u) {
733 return automount_state_to_string(AUTOMOUNT(u)->state);
736 static bool automount_check_gc(Unit *u) {
737 Automount *a = AUTOMOUNT(u);
744 return UNIT_VTABLE(UNIT(a->mount))->check_gc(UNIT(a->mount));
747 static void automount_fd_event(Unit *u, int fd, uint32_t events, Watch *w) {
748 Automount *a = AUTOMOUNT(u);
749 union autofs_v5_packet_union packet;
754 assert(fd == a->pipe_fd);
756 if (events != EPOLLIN) {
757 log_error("Got invalid poll event on pipe.");
761 if ((l = loop_read(a->pipe_fd, &packet, sizeof(packet), true)) != sizeof(packet)) {
762 log_error("Invalid read from pipe: %s", l < 0 ? strerror(-l) : "short read");
766 switch (packet.hdr.type) {
768 case autofs_ptype_missing_direct:
770 if (packet.v5_packet.pid > 0) {
773 get_process_name(packet.v5_packet.pid, &p);
774 log_debug("Got direct mount request for %s, triggered by %lu (%s)", packet.v5_packet.name, (unsigned long) packet.v5_packet.pid, strna(p));
778 log_debug("Got direct mount request for %s", packet.v5_packet.name);
781 if (!(a->tokens = set_new(trivial_hash_func, trivial_compare_func))) {
782 log_error("Failed to allocate token set.");
786 if ((r = set_put(a->tokens, UINT_TO_PTR(packet.v5_packet.wait_queue_token))) < 0) {
787 log_error("Failed to remember token: %s", strerror(-r));
791 automount_enter_runnning(a);
795 log_error("Received unknown automount request %i", packet.hdr.type);
802 automount_enter_dead(a, false);
805 static void automount_shutdown(Manager *m) {
808 if (m->dev_autofs_fd >= 0)
809 close_nointr_nofail(m->dev_autofs_fd);
812 static void automount_reset_failed(Unit *u) {
813 Automount *a = AUTOMOUNT(u);
817 if (a->state == AUTOMOUNT_FAILED)
818 automount_set_state(a, AUTOMOUNT_DEAD);
823 static const char* const automount_state_table[_AUTOMOUNT_STATE_MAX] = {
824 [AUTOMOUNT_DEAD] = "dead",
825 [AUTOMOUNT_WAITING] = "waiting",
826 [AUTOMOUNT_RUNNING] = "running",
827 [AUTOMOUNT_FAILED] = "failed"
830 DEFINE_STRING_TABLE_LOOKUP(automount_state, AutomountState);
832 const UnitVTable automount_vtable = {
833 .suffix = ".automount",
840 .no_instances = true,
842 .init = automount_init,
843 .load = automount_load,
844 .done = automount_done,
846 .coldplug = automount_coldplug,
848 .dump = automount_dump,
850 .start = automount_start,
851 .stop = automount_stop,
853 .serialize = automount_serialize,
854 .deserialize_item = automount_deserialize_item,
856 .active_state = automount_active_state,
857 .sub_state_to_string = automount_sub_state_to_string,
859 .check_gc = automount_check_gc,
861 .fd_event = automount_fd_event,
863 .reset_failed = automount_reset_failed,
865 .bus_interface = "org.freedesktop.systemd1.Automount",
866 .bus_message_handler = bus_automount_message_handler,
868 .shutdown = automount_shutdown