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_verify(Automount
*a
) {
154 if (a
->meta
.load_state
!= UNIT_LOADED
)
157 if (path_equal(a
->where
, "/")) {
158 log_error("Cannot have an automount unit for the root directory. Refusing.");
162 if (!(e
= unit_name_from_path(a
->where
, ".automount")))
165 b
= unit_has_name(UNIT(a
), e
);
169 log_error("%s's Where setting doesn't match unit name. Refusing.", a
->meta
.id
);
176 static int automount_load(Unit
*u
) {
178 Automount
*a
= AUTOMOUNT(u
);
181 assert(u
->meta
.load_state
== UNIT_STUB
);
183 /* Load a .automount file */
184 if ((r
= unit_load_fragment_and_dropin_optional(u
)) < 0)
187 if (u
->meta
.load_state
== UNIT_LOADED
) {
190 if (!(a
->where
= unit_name_to_path(u
->meta
.id
)))
193 path_kill_slashes(a
->where
);
195 if ((r
= automount_add_mount_links(a
)) < 0)
198 if ((r
= unit_load_related_unit(u
, ".mount", (Unit
**) &a
->mount
)) < 0)
201 if ((r
= unit_add_dependency(u
, UNIT_BEFORE
, UNIT(a
->mount
), true)) < 0)
204 if (a
->meta
.default_dependencies
)
205 if ((r
= unit_add_two_dependencies_by_name(UNIT(a
), UNIT_BEFORE
, UNIT_CONFLICTS
, SPECIAL_UMOUNT_TARGET
, NULL
, true)) < 0)
209 return automount_verify(a
);
212 static void automount_set_state(Automount
*a
, AutomountState state
) {
213 AutomountState old_state
;
216 old_state
= a
->state
;
219 if (state
!= AUTOMOUNT_WAITING
&&
220 state
!= AUTOMOUNT_RUNNING
)
223 if (state
!= old_state
)
224 log_debug("%s changed %s -> %s",
226 automount_state_to_string(old_state
),
227 automount_state_to_string(state
));
229 unit_notify(UNIT(a
), state_translation_table
[old_state
], state_translation_table
[state
]);
232 static int automount_coldplug(Unit
*u
) {
233 Automount
*a
= AUTOMOUNT(u
);
237 assert(a
->state
== AUTOMOUNT_DEAD
);
239 if (a
->deserialized_state
!= a
->state
) {
241 if ((r
= open_dev_autofs(u
->meta
.manager
)) < 0)
244 if (a
->deserialized_state
== AUTOMOUNT_WAITING
||
245 a
->deserialized_state
== AUTOMOUNT_RUNNING
) {
247 assert(a
->pipe_fd
>= 0);
249 if ((r
= unit_watch_fd(UNIT(a
), a
->pipe_fd
, EPOLLIN
, &a
->pipe_watch
)) < 0)
253 automount_set_state(a
, a
->deserialized_state
);
259 static void automount_dump(Unit
*u
, FILE *f
, const char *prefix
) {
260 Automount
*a
= AUTOMOUNT(u
);
265 "%sAutomount State: %s\n"
267 "%sDirectoryMode: %04o\n",
268 prefix
, automount_state_to_string(a
->state
),
270 prefix
, a
->directory_mode
);
273 static void automount_enter_dead(Automount
*a
, bool success
) {
279 automount_set_state(a
, a
->failure
? AUTOMOUNT_MAINTENANCE
: AUTOMOUNT_DEAD
);
282 static int open_dev_autofs(Manager
*m
) {
283 struct autofs_dev_ioctl param
;
287 if (m
->dev_autofs_fd
>= 0)
288 return m
->dev_autofs_fd
;
290 if ((m
->dev_autofs_fd
= open("/dev/autofs", O_CLOEXEC
|O_RDONLY
)) < 0) {
291 log_error("Failed to open /dev/autofs: %s", strerror(errno
));
295 init_autofs_dev_ioctl(¶m
);
296 if (ioctl(m
->dev_autofs_fd
, AUTOFS_DEV_IOCTL_VERSION
, ¶m
) < 0) {
297 close_nointr_nofail(m
->dev_autofs_fd
);
298 m
->dev_autofs_fd
= -1;
302 log_debug("Autofs kernel version %i.%i", param
.ver_major
, param
.ver_minor
);
304 return m
->dev_autofs_fd
;
307 static int open_ioctl_fd(int dev_autofs_fd
, const char *where
, dev_t devid
) {
308 struct autofs_dev_ioctl
*param
;
312 assert(dev_autofs_fd
>= 0);
315 l
= sizeof(struct autofs_dev_ioctl
) + strlen(where
) + 1;
317 if (!(param
= malloc(l
)))
320 init_autofs_dev_ioctl(param
);
323 param
->openmount
.devid
= devid
;
324 strcpy(param
->path
, where
);
326 if (ioctl(dev_autofs_fd
, AUTOFS_DEV_IOCTL_OPENMOUNT
, param
) < 0) {
331 if (param
->ioctlfd
< 0) {
336 fd_cloexec(param
->ioctlfd
, true);
344 static int autofs_protocol(int dev_autofs_fd
, int ioctl_fd
) {
345 uint32_t major
, minor
;
346 struct autofs_dev_ioctl param
;
348 assert(dev_autofs_fd
>= 0);
349 assert(ioctl_fd
>= 0);
351 init_autofs_dev_ioctl(¶m
);
352 param
.ioctlfd
= ioctl_fd
;
354 if (ioctl(dev_autofs_fd
, AUTOFS_DEV_IOCTL_PROTOVER
, ¶m
) < 0)
357 major
= param
.protover
.version
;
359 init_autofs_dev_ioctl(¶m
);
360 param
.ioctlfd
= ioctl_fd
;
362 if (ioctl(dev_autofs_fd
, AUTOFS_DEV_IOCTL_PROTOSUBVER
, ¶m
) < 0)
365 minor
= param
.protosubver
.sub_version
;
367 log_debug("Autofs protocol version %i.%i", major
, minor
);
371 static int autofs_set_timeout(int dev_autofs_fd
, int ioctl_fd
, time_t sec
) {
372 struct autofs_dev_ioctl param
;
374 assert(dev_autofs_fd
>= 0);
375 assert(ioctl_fd
>= 0);
377 init_autofs_dev_ioctl(¶m
);
378 param
.ioctlfd
= ioctl_fd
;
379 param
.timeout
.timeout
= sec
;
381 if (ioctl(dev_autofs_fd
, AUTOFS_DEV_IOCTL_TIMEOUT
, ¶m
) < 0)
387 static int autofs_send_ready(int dev_autofs_fd
, int ioctl_fd
, uint32_t token
, int status
) {
388 struct autofs_dev_ioctl param
;
390 assert(dev_autofs_fd
>= 0);
391 assert(ioctl_fd
>= 0);
393 init_autofs_dev_ioctl(¶m
);
394 param
.ioctlfd
= ioctl_fd
;
397 param
.fail
.token
= token
;
398 param
.fail
.status
= status
;
400 param
.ready
.token
= token
;
402 if (ioctl(dev_autofs_fd
, status
? AUTOFS_DEV_IOCTL_FAIL
: AUTOFS_DEV_IOCTL_READY
, ¶m
) < 0)
408 int automount_send_ready(Automount
*a
, int status
) {
415 if (set_isempty(a
->tokens
))
418 if ((ioctl_fd
= open_ioctl_fd(a
->meta
.manager
->dev_autofs_fd
, a
->where
, a
->dev_id
)) < 0) {
424 log_debug("Sending failure: %s", strerror(-status
));
426 log_debug("Sending success.");
428 /* Autofs thankfully does not hand out 0 as a token */
429 while ((token
= PTR_TO_UINT(set_steal_first(a
->tokens
)))) {
432 /* Autofs fun fact II:
434 * if you pass a positive status code here, the kernel will
437 if ((k
= autofs_send_ready(a
->meta
.manager
->dev_autofs_fd
,
448 close_nointr_nofail(ioctl_fd
);
453 static void automount_enter_waiting(Automount
*a
) {
454 int p
[2] = { -1, -1 };
455 char name
[32], options
[128];
456 bool mounted
= false;
457 int r
, ioctl_fd
= -1, dev_autofs_fd
;
461 assert(a
->pipe_fd
< 0);
465 set_clear(a
->tokens
);
467 if ((dev_autofs_fd
= open_dev_autofs(a
->meta
.manager
)) < 0) {
472 /* We knowingly ignore the results of this call */
473 mkdir_p(a
->where
, 0555);
475 if (pipe2(p
, O_NONBLOCK
|O_CLOEXEC
) < 0) {
480 snprintf(options
, sizeof(options
), "fd=%i,pgrp=%u,minproto=5,maxproto=5,direct", p
[1], (unsigned) getpgrp());
481 char_array_0(options
);
483 snprintf(name
, sizeof(name
), "systemd-%u", (unsigned) getpid());
486 if (mount(name
, a
->where
, "autofs", 0, options
) < 0) {
493 close_nointr_nofail(p
[1]);
496 if (stat(a
->where
, &st
) < 0) {
501 if ((ioctl_fd
= open_ioctl_fd(dev_autofs_fd
, a
->where
, st
.st_dev
)) < 0) {
506 if ((r
= autofs_protocol(dev_autofs_fd
, ioctl_fd
)) < 0)
509 if ((r
= autofs_set_timeout(dev_autofs_fd
, ioctl_fd
, 300)) < 0)
514 * Unless we close the ioctl fd here, for some weird reason
515 * the direct mount will not receive events from the
518 close_nointr_nofail(ioctl_fd
);
521 if ((r
= unit_watch_fd(UNIT(a
), p
[0], EPOLLIN
, &a
->pipe_watch
)) < 0)
525 a
->dev_id
= st
.st_dev
;
527 automount_set_state(a
, AUTOMOUNT_WAITING
);
532 assert_se(close_pipe(p
) == 0);
535 close_nointr_nofail(ioctl_fd
);
538 repeat_unmout(a
->where
);
540 log_error("Failed to initialize automounter: %s", strerror(-r
));
541 automount_enter_dead(a
, false);
544 static void automount_enter_runnning(Automount
*a
) {
552 dbus_error_init(&error
);
554 mkdir_p(a
->where
, a
->directory_mode
);
556 /* Before we do anything, let's see if somebody is playing games with us? */
557 if (lstat(a
->where
, &st
) < 0) {
558 log_warning("%s failed stat automount point: %m", a
->meta
.id
);
562 if (!S_ISDIR(st
.st_mode
) || st
.st_dev
!= a
->dev_id
)
563 log_info("%s's automount point already active?", a
->meta
.id
);
564 else if ((r
= manager_add_job(a
->meta
.manager
, JOB_START
, UNIT(a
->mount
), JOB_REPLACE
, true, &error
, NULL
)) < 0) {
565 log_warning("%s failed to queue mount startup job: %s", a
->meta
.id
, bus_error(&error
, r
));
569 automount_set_state(a
, AUTOMOUNT_RUNNING
);
573 automount_enter_dead(a
, false);
574 dbus_error_free(&error
);
577 static int automount_start(Unit
*u
) {
578 Automount
*a
= AUTOMOUNT(u
);
582 assert(a
->state
== AUTOMOUNT_DEAD
|| a
->state
== AUTOMOUNT_MAINTENANCE
);
584 if (path_is_mount_point(a
->where
)) {
585 log_error("Path %s is already a mount point, refusing start for %s", a
->where
, u
->meta
.id
);
589 if (a
->mount
->meta
.load_state
!= UNIT_LOADED
)
593 automount_enter_waiting(a
);
597 static int automount_stop(Unit
*u
) {
598 Automount
*a
= AUTOMOUNT(u
);
602 assert(a
->state
== AUTOMOUNT_WAITING
|| a
->state
== AUTOMOUNT_RUNNING
);
604 automount_enter_dead(a
, true);
608 static int automount_serialize(Unit
*u
, FILE *f
, FDSet
*fds
) {
609 Automount
*a
= AUTOMOUNT(u
);
617 unit_serialize_item(u
, f
, "state", automount_state_to_string(a
->state
));
618 unit_serialize_item(u
, f
, "failure", yes_no(a
->failure
));
619 unit_serialize_item_format(u
, f
, "dev-id", "%u", (unsigned) a
->dev_id
);
621 SET_FOREACH(p
, a
->tokens
, i
)
622 unit_serialize_item_format(u
, f
, "token", "%u", PTR_TO_UINT(p
));
624 if (a
->pipe_fd
>= 0) {
627 if ((copy
= fdset_put_dup(fds
, a
->pipe_fd
)) < 0)
630 unit_serialize_item_format(u
, f
, "pipe-fd", "%i", copy
);
636 static int automount_deserialize_item(Unit
*u
, const char *key
, const char *value
, FDSet
*fds
) {
637 Automount
*a
= AUTOMOUNT(u
);
643 if (streq(key
, "state")) {
644 AutomountState state
;
646 if ((state
= automount_state_from_string(value
)) < 0)
647 log_debug("Failed to parse state value %s", value
);
649 a
->deserialized_state
= state
;
650 } else if (streq(key
, "failure")) {
653 if ((b
= parse_boolean(value
)) < 0)
654 log_debug("Failed to parse failure value %s", value
);
656 a
->failure
= b
|| a
->failure
;
657 } else if (streq(key
, "dev-id")) {
660 if (safe_atou(value
, &d
) < 0)
661 log_debug("Failed to parse dev-id value %s", value
);
663 a
->dev_id
= (unsigned) d
;
664 } else if (streq(key
, "token")) {
667 if (safe_atou(value
, &token
) < 0)
668 log_debug("Failed to parse token value %s", value
);
671 if (!(a
->tokens
= set_new(trivial_hash_func
, trivial_compare_func
)))
674 if ((r
= set_put(a
->tokens
, UINT_TO_PTR(token
))) < 0)
677 } else if (streq(key
, "pipe-fd")) {
680 if (safe_atoi(value
, &fd
) < 0 || fd
< 0 || !fdset_contains(fds
, fd
))
681 log_debug("Failed to parse pipe-fd value %s", value
);
684 close_nointr_nofail(a
->pipe_fd
);
686 a
->pipe_fd
= fdset_remove(fds
, fd
);
689 log_debug("Unknown serialization key '%s'", key
);
694 static UnitActiveState
automount_active_state(Unit
*u
) {
697 return state_translation_table
[AUTOMOUNT(u
)->state
];
700 static const char *automount_sub_state_to_string(Unit
*u
) {
703 return automount_state_to_string(AUTOMOUNT(u
)->state
);
706 static bool automount_check_gc(Unit
*u
) {
707 Automount
*a
= AUTOMOUNT(u
);
711 return UNIT_VTABLE(UNIT(a
->mount
))->check_gc(UNIT(a
->mount
));
714 static void automount_fd_event(Unit
*u
, int fd
, uint32_t events
, Watch
*w
) {
715 Automount
*a
= AUTOMOUNT(u
);
716 union autofs_v5_packet_union packet
;
721 assert(fd
== a
->pipe_fd
);
723 if (events
!= EPOLLIN
) {
724 log_error("Got invalid poll event on pipe.");
728 if ((l
= loop_read(a
->pipe_fd
, &packet
, sizeof(packet
), true)) != sizeof(packet
)) {
729 log_error("Invalid read from pipe: %s", l
< 0 ? strerror(-l
) : "short read");
733 switch (packet
.hdr
.type
) {
735 case autofs_ptype_missing_direct
:
736 log_debug("Got direct mount request for %s", packet
.v5_packet
.name
);
739 if (!(a
->tokens
= set_new(trivial_hash_func
, trivial_compare_func
))) {
740 log_error("Failed to allocate token set.");
744 if ((r
= set_put(a
->tokens
, UINT_TO_PTR(packet
.v5_packet
.wait_queue_token
))) < 0) {
745 log_error("Failed to remember token: %s", strerror(-r
));
749 automount_enter_runnning(a
);
753 log_error("Received unknown automount request %i", packet
.hdr
.type
);
760 automount_enter_dead(a
, false);
763 static void automount_shutdown(Manager
*m
) {
766 if (m
->dev_autofs_fd
>= 0)
767 close_nointr_nofail(m
->dev_autofs_fd
);
770 static const char* const automount_state_table
[_AUTOMOUNT_STATE_MAX
] = {
771 [AUTOMOUNT_DEAD
] = "dead",
772 [AUTOMOUNT_WAITING
] = "waiting",
773 [AUTOMOUNT_RUNNING
] = "running",
774 [AUTOMOUNT_MAINTENANCE
] = "maintenance"
777 DEFINE_STRING_TABLE_LOOKUP(automount_state
, AutomountState
);
779 const UnitVTable automount_vtable
= {
780 .suffix
= ".automount",
783 .no_instances
= true,
785 .init
= automount_init
,
786 .load
= automount_load
,
787 .done
= automount_done
,
789 .coldplug
= automount_coldplug
,
791 .dump
= automount_dump
,
793 .start
= automount_start
,
794 .stop
= automount_stop
,
796 .serialize
= automount_serialize
,
797 .deserialize_item
= automount_deserialize_item
,
799 .active_state
= automount_active_state
,
800 .sub_state_to_string
= automount_sub_state_to_string
,
802 .check_gc
= automount_check_gc
,
804 .fd_event
= automount_fd_event
,
806 .bus_message_handler
= bus_automount_message_handler
,
808 .shutdown
= automount_shutdown