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"
38 #include "bus-errors.h"
41 static const UnitActiveState state_translation_table[_AUTOMOUNT_STATE_MAX] = {
42 [AUTOMOUNT_DEAD] = UNIT_INACTIVE,
43 [AUTOMOUNT_WAITING] = UNIT_ACTIVE,
44 [AUTOMOUNT_RUNNING] = UNIT_ACTIVE,
45 [AUTOMOUNT_MAINTENANCE] = UNIT_MAINTENANCE
48 static int open_dev_autofs(Manager *m);
50 static void automount_init(Unit *u) {
51 Automount *a = AUTOMOUNT(u);
54 assert(u->meta.load_state == UNIT_STUB);
56 a->pipe_watch.fd = a->pipe_fd = -1;
57 a->pipe_watch.type = WATCH_INVALID;
59 a->directory_mode = 0755;
62 static void repeat_unmout(const char *path) {
66 /* If there are multiple mounts on a mount point, this
69 if (umount2(path, MNT_DETACH) >= 0)
73 log_error("Failed to unmount: %m");
79 static void unmount_autofs(Automount *a) {
85 automount_send_ready(a, -EHOSTDOWN);
87 unit_unwatch_fd(UNIT(a), &a->pipe_watch);
88 close_nointr_nofail(a->pipe_fd);
91 /* If we reload/reexecute things we keep the mount point
94 (a->meta.manager->exit_code != MANAGER_RELOAD &&
95 a->meta.manager->exit_code != MANAGER_REEXECUTE))
96 repeat_unmout(a->where);
99 static void automount_done(Unit *u) {
100 Automount *a = AUTOMOUNT(u);
114 int automount_add_one_mount_link(Automount *a, Mount *m) {
120 if (a->meta.load_state != UNIT_LOADED ||
121 m->meta.load_state != UNIT_LOADED)
124 if (!path_startswith(a->where, m->where))
127 if (path_equal(a->where, m->where))
130 if ((r = unit_add_two_dependencies(UNIT(a), UNIT_AFTER, UNIT_REQUIRES, UNIT(m), true)) < 0)
136 static int automount_add_mount_links(Automount *a) {
142 LIST_FOREACH(units_per_type, other, a->meta.manager->units_per_type[UNIT_MOUNT])
143 if ((r = automount_add_one_mount_link(a, (Mount*) other)) < 0)
149 static int automount_add_default_dependencies(Automount *a) {
154 if (a->meta.manager->running_as == MANAGER_SYSTEM) {
156 if ((r = unit_add_dependency_by_name(UNIT(a), UNIT_AFTER, SPECIAL_SYSINIT_TARGET, NULL, true)) < 0)
159 if ((r = unit_add_two_dependencies_by_name(UNIT(a), UNIT_BEFORE, UNIT_CONFLICTS, SPECIAL_UMOUNT_TARGET, NULL, true)) < 0)
166 static int automount_verify(Automount *a) {
171 if (a->meta.load_state != UNIT_LOADED)
174 if (path_equal(a->where, "/")) {
175 log_error("Cannot have an automount unit for the root directory. Refusing.");
179 if (!(e = unit_name_from_path(a->where, ".automount")))
182 b = unit_has_name(UNIT(a), e);
186 log_error("%s's Where setting doesn't match unit name. Refusing.", a->meta.id);
193 static int automount_load(Unit *u) {
195 Automount *a = AUTOMOUNT(u);
198 assert(u->meta.load_state == UNIT_STUB);
200 /* Load a .automount file */
201 if ((r = unit_load_fragment_and_dropin_optional(u)) < 0)
204 if (u->meta.load_state == UNIT_LOADED) {
207 if (!(a->where = unit_name_to_path(u->meta.id)))
210 path_kill_slashes(a->where);
212 if ((r = automount_add_mount_links(a)) < 0)
215 if ((r = unit_load_related_unit(u, ".mount", (Unit**) &a->mount)) < 0)
218 if ((r = unit_add_dependency(u, UNIT_BEFORE, UNIT(a->mount), true)) < 0)
221 if (a->meta.default_dependencies)
222 if ((r = automount_add_default_dependencies(a)) < 0)
226 return automount_verify(a);
229 static void automount_set_state(Automount *a, AutomountState state) {
230 AutomountState old_state;
233 old_state = a->state;
236 if (state != AUTOMOUNT_WAITING &&
237 state != AUTOMOUNT_RUNNING)
240 if (state != old_state)
241 log_debug("%s changed %s -> %s",
243 automount_state_to_string(old_state),
244 automount_state_to_string(state));
246 unit_notify(UNIT(a), state_translation_table[old_state], state_translation_table[state]);
249 static int automount_coldplug(Unit *u) {
250 Automount *a = AUTOMOUNT(u);
254 assert(a->state == AUTOMOUNT_DEAD);
256 if (a->deserialized_state != a->state) {
258 if ((r = open_dev_autofs(u->meta.manager)) < 0)
261 if (a->deserialized_state == AUTOMOUNT_WAITING ||
262 a->deserialized_state == AUTOMOUNT_RUNNING) {
264 assert(a->pipe_fd >= 0);
266 if ((r = unit_watch_fd(UNIT(a), a->pipe_fd, EPOLLIN, &a->pipe_watch)) < 0)
270 automount_set_state(a, a->deserialized_state);
276 static void automount_dump(Unit *u, FILE *f, const char *prefix) {
277 Automount *a = AUTOMOUNT(u);
282 "%sAutomount State: %s\n"
284 "%sDirectoryMode: %04o\n",
285 prefix, automount_state_to_string(a->state),
287 prefix, a->directory_mode);
290 static void automount_enter_dead(Automount *a, bool success) {
296 automount_set_state(a, a->failure ? AUTOMOUNT_MAINTENANCE : AUTOMOUNT_DEAD);
299 static int open_dev_autofs(Manager *m) {
300 struct autofs_dev_ioctl param;
304 if (m->dev_autofs_fd >= 0)
305 return m->dev_autofs_fd;
307 if ((m->dev_autofs_fd = open("/dev/autofs", O_CLOEXEC|O_RDONLY)) < 0) {
308 log_error("Failed to open /dev/autofs: %s", strerror(errno));
312 init_autofs_dev_ioctl(¶m);
313 if (ioctl(m->dev_autofs_fd, AUTOFS_DEV_IOCTL_VERSION, ¶m) < 0) {
314 close_nointr_nofail(m->dev_autofs_fd);
315 m->dev_autofs_fd = -1;
319 log_debug("Autofs kernel version %i.%i", param.ver_major, param.ver_minor);
321 return m->dev_autofs_fd;
324 static int open_ioctl_fd(int dev_autofs_fd, const char *where, dev_t devid) {
325 struct autofs_dev_ioctl *param;
329 assert(dev_autofs_fd >= 0);
332 l = sizeof(struct autofs_dev_ioctl) + strlen(where) + 1;
334 if (!(param = malloc(l)))
337 init_autofs_dev_ioctl(param);
340 param->openmount.devid = devid;
341 strcpy(param->path, where);
343 if (ioctl(dev_autofs_fd, AUTOFS_DEV_IOCTL_OPENMOUNT, param) < 0) {
348 if (param->ioctlfd < 0) {
353 fd_cloexec(param->ioctlfd, true);
361 static int autofs_protocol(int dev_autofs_fd, int ioctl_fd) {
362 uint32_t major, minor;
363 struct autofs_dev_ioctl param;
365 assert(dev_autofs_fd >= 0);
366 assert(ioctl_fd >= 0);
368 init_autofs_dev_ioctl(¶m);
369 param.ioctlfd = ioctl_fd;
371 if (ioctl(dev_autofs_fd, AUTOFS_DEV_IOCTL_PROTOVER, ¶m) < 0)
374 major = param.protover.version;
376 init_autofs_dev_ioctl(¶m);
377 param.ioctlfd = ioctl_fd;
379 if (ioctl(dev_autofs_fd, AUTOFS_DEV_IOCTL_PROTOSUBVER, ¶m) < 0)
382 minor = param.protosubver.sub_version;
384 log_debug("Autofs protocol version %i.%i", major, minor);
388 static int autofs_set_timeout(int dev_autofs_fd, int ioctl_fd, time_t sec) {
389 struct autofs_dev_ioctl param;
391 assert(dev_autofs_fd >= 0);
392 assert(ioctl_fd >= 0);
394 init_autofs_dev_ioctl(¶m);
395 param.ioctlfd = ioctl_fd;
396 param.timeout.timeout = sec;
398 if (ioctl(dev_autofs_fd, AUTOFS_DEV_IOCTL_TIMEOUT, ¶m) < 0)
404 static int autofs_send_ready(int dev_autofs_fd, int ioctl_fd, uint32_t token, int status) {
405 struct autofs_dev_ioctl param;
407 assert(dev_autofs_fd >= 0);
408 assert(ioctl_fd >= 0);
410 init_autofs_dev_ioctl(¶m);
411 param.ioctlfd = ioctl_fd;
414 param.fail.token = token;
415 param.fail.status = status;
417 param.ready.token = token;
419 if (ioctl(dev_autofs_fd, status ? AUTOFS_DEV_IOCTL_FAIL : AUTOFS_DEV_IOCTL_READY, ¶m) < 0)
425 int automount_send_ready(Automount *a, int status) {
432 if (set_isempty(a->tokens))
435 if ((ioctl_fd = open_ioctl_fd(a->meta.manager->dev_autofs_fd, a->where, a->dev_id)) < 0) {
441 log_debug("Sending failure: %s", strerror(-status));
443 log_debug("Sending success.");
445 /* Autofs thankfully does not hand out 0 as a token */
446 while ((token = PTR_TO_UINT(set_steal_first(a->tokens)))) {
449 /* Autofs fun fact II:
451 * if you pass a positive status code here, the kernel will
454 if ((k = autofs_send_ready(a->meta.manager->dev_autofs_fd,
465 close_nointr_nofail(ioctl_fd);
470 static void automount_enter_waiting(Automount *a) {
471 int p[2] = { -1, -1 };
472 char name[32], options[128];
473 bool mounted = false;
474 int r, ioctl_fd = -1, dev_autofs_fd;
478 assert(a->pipe_fd < 0);
482 set_clear(a->tokens);
484 if ((dev_autofs_fd = open_dev_autofs(a->meta.manager)) < 0) {
489 /* We knowingly ignore the results of this call */
490 mkdir_p(a->where, 0555);
492 if (pipe2(p, O_NONBLOCK|O_CLOEXEC) < 0) {
497 snprintf(options, sizeof(options), "fd=%i,pgrp=%u,minproto=5,maxproto=5,direct", p[1], (unsigned) getpgrp());
498 char_array_0(options);
500 snprintf(name, sizeof(name), "systemd-%u", (unsigned) getpid());
503 if (mount(name, a->where, "autofs", 0, options) < 0) {
510 close_nointr_nofail(p[1]);
513 if (stat(a->where, &st) < 0) {
518 if ((ioctl_fd = open_ioctl_fd(dev_autofs_fd, a->where, st.st_dev)) < 0) {
523 if ((r = autofs_protocol(dev_autofs_fd, ioctl_fd)) < 0)
526 if ((r = autofs_set_timeout(dev_autofs_fd, ioctl_fd, 300)) < 0)
531 * Unless we close the ioctl fd here, for some weird reason
532 * the direct mount will not receive events from the
535 close_nointr_nofail(ioctl_fd);
538 if ((r = unit_watch_fd(UNIT(a), p[0], EPOLLIN, &a->pipe_watch)) < 0)
542 a->dev_id = st.st_dev;
544 automount_set_state(a, AUTOMOUNT_WAITING);
549 assert_se(close_pipe(p) == 0);
552 close_nointr_nofail(ioctl_fd);
555 repeat_unmout(a->where);
557 log_error("Failed to initialize automounter: %s", strerror(-r));
558 automount_enter_dead(a, false);
561 static void automount_enter_runnning(Automount *a) {
569 dbus_error_init(&error);
571 /* We don't take mount requests anymore if we are supposed to
572 * shut down anyway */
573 if (a->meta.job && a->meta.job->type == JOB_STOP) {
574 automount_send_ready(a, -EHOSTDOWN);
578 mkdir_p(a->where, a->directory_mode);
580 /* Before we do anything, let's see if somebody is playing games with us? */
581 if (lstat(a->where, &st) < 0) {
582 log_warning("%s failed stat automount point: %m", a->meta.id);
586 if (!S_ISDIR(st.st_mode) || st.st_dev != a->dev_id)
587 log_info("%s's automount point already active?", a->meta.id);
588 else if ((r = manager_add_job(a->meta.manager, JOB_START, UNIT(a->mount), JOB_REPLACE, true, &error, NULL)) < 0) {
589 log_warning("%s failed to queue mount startup job: %s", a->meta.id, bus_error(&error, r));
593 automount_set_state(a, AUTOMOUNT_RUNNING);
597 automount_enter_dead(a, false);
598 dbus_error_free(&error);
601 static int automount_start(Unit *u) {
602 Automount *a = AUTOMOUNT(u);
606 assert(a->state == AUTOMOUNT_DEAD || a->state == AUTOMOUNT_MAINTENANCE);
608 if (path_is_mount_point(a->where)) {
609 log_error("Path %s is already a mount point, refusing start for %s", a->where, u->meta.id);
613 if (a->mount->meta.load_state != UNIT_LOADED)
617 automount_enter_waiting(a);
621 static int automount_stop(Unit *u) {
622 Automount *a = AUTOMOUNT(u);
626 assert(a->state == AUTOMOUNT_WAITING || a->state == AUTOMOUNT_RUNNING);
628 automount_enter_dead(a, true);
632 static int automount_serialize(Unit *u, FILE *f, FDSet *fds) {
633 Automount *a = AUTOMOUNT(u);
641 unit_serialize_item(u, f, "state", automount_state_to_string(a->state));
642 unit_serialize_item(u, f, "failure", yes_no(a->failure));
643 unit_serialize_item_format(u, f, "dev-id", "%u", (unsigned) a->dev_id);
645 SET_FOREACH(p, a->tokens, i)
646 unit_serialize_item_format(u, f, "token", "%u", PTR_TO_UINT(p));
648 if (a->pipe_fd >= 0) {
651 if ((copy = fdset_put_dup(fds, a->pipe_fd)) < 0)
654 unit_serialize_item_format(u, f, "pipe-fd", "%i", copy);
660 static int automount_deserialize_item(Unit *u, const char *key, const char *value, FDSet *fds) {
661 Automount *a = AUTOMOUNT(u);
667 if (streq(key, "state")) {
668 AutomountState state;
670 if ((state = automount_state_from_string(value)) < 0)
671 log_debug("Failed to parse state value %s", value);
673 a->deserialized_state = state;
674 } else if (streq(key, "failure")) {
677 if ((b = parse_boolean(value)) < 0)
678 log_debug("Failed to parse failure value %s", value);
680 a->failure = b || a->failure;
681 } else if (streq(key, "dev-id")) {
684 if (safe_atou(value, &d) < 0)
685 log_debug("Failed to parse dev-id value %s", value);
687 a->dev_id = (unsigned) d;
688 } else if (streq(key, "token")) {
691 if (safe_atou(value, &token) < 0)
692 log_debug("Failed to parse token value %s", value);
695 if (!(a->tokens = set_new(trivial_hash_func, trivial_compare_func)))
698 if ((r = set_put(a->tokens, UINT_TO_PTR(token))) < 0)
701 } else if (streq(key, "pipe-fd")) {
704 if (safe_atoi(value, &fd) < 0 || fd < 0 || !fdset_contains(fds, fd))
705 log_debug("Failed to parse pipe-fd value %s", value);
708 close_nointr_nofail(a->pipe_fd);
710 a->pipe_fd = fdset_remove(fds, fd);
713 log_debug("Unknown serialization key '%s'", key);
718 static UnitActiveState automount_active_state(Unit *u) {
721 return state_translation_table[AUTOMOUNT(u)->state];
724 static const char *automount_sub_state_to_string(Unit *u) {
727 return automount_state_to_string(AUTOMOUNT(u)->state);
730 static bool automount_check_gc(Unit *u) {
731 Automount *a = AUTOMOUNT(u);
735 return UNIT_VTABLE(UNIT(a->mount))->check_gc(UNIT(a->mount));
738 static void automount_fd_event(Unit *u, int fd, uint32_t events, Watch *w) {
739 Automount *a = AUTOMOUNT(u);
740 union autofs_v5_packet_union packet;
745 assert(fd == a->pipe_fd);
747 if (events != EPOLLIN) {
748 log_error("Got invalid poll event on pipe.");
752 if ((l = loop_read(a->pipe_fd, &packet, sizeof(packet), true)) != sizeof(packet)) {
753 log_error("Invalid read from pipe: %s", l < 0 ? strerror(-l) : "short read");
757 switch (packet.hdr.type) {
759 case autofs_ptype_missing_direct:
760 log_debug("Got direct mount request for %s", packet.v5_packet.name);
763 if (!(a->tokens = set_new(trivial_hash_func, trivial_compare_func))) {
764 log_error("Failed to allocate token set.");
768 if ((r = set_put(a->tokens, UINT_TO_PTR(packet.v5_packet.wait_queue_token))) < 0) {
769 log_error("Failed to remember token: %s", strerror(-r));
773 automount_enter_runnning(a);
777 log_error("Received unknown automount request %i", packet.hdr.type);
784 automount_enter_dead(a, false);
787 static void automount_shutdown(Manager *m) {
790 if (m->dev_autofs_fd >= 0)
791 close_nointr_nofail(m->dev_autofs_fd);
794 static const char* const automount_state_table[_AUTOMOUNT_STATE_MAX] = {
795 [AUTOMOUNT_DEAD] = "dead",
796 [AUTOMOUNT_WAITING] = "waiting",
797 [AUTOMOUNT_RUNNING] = "running",
798 [AUTOMOUNT_MAINTENANCE] = "maintenance"
801 DEFINE_STRING_TABLE_LOOKUP(automount_state, AutomountState);
803 const UnitVTable automount_vtable = {
804 .suffix = ".automount",
807 .no_instances = true,
809 .init = automount_init,
810 .load = automount_load,
811 .done = automount_done,
813 .coldplug = automount_coldplug,
815 .dump = automount_dump,
817 .start = automount_start,
818 .stop = automount_stop,
820 .serialize = automount_serialize,
821 .deserialize_item = automount_deserialize_item,
823 .active_state = automount_active_state,
824 .sub_state_to_string = automount_sub_state_to_string,
826 .check_gc = automount_check_gc,
828 .fd_event = automount_fd_event,
830 .bus_message_handler = bus_automount_message_handler,
832 .shutdown = automount_shutdown