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"
40 static const UnitActiveState state_translation_table
[_AUTOMOUNT_STATE_MAX
] = {
41 [AUTOMOUNT_DEAD
] = UNIT_INACTIVE
,
42 [AUTOMOUNT_WAITING
] = UNIT_ACTIVE
,
43 [AUTOMOUNT_RUNNING
] = UNIT_ACTIVE
,
44 [AUTOMOUNT_MAINTENANCE
] = UNIT_MAINTENANCE
47 static int open_dev_autofs(Manager
*m
);
49 static void automount_init(Unit
*u
) {
50 Automount
*a
= AUTOMOUNT(u
);
53 assert(u
->meta
.load_state
== UNIT_STUB
);
55 a
->pipe_watch
.fd
= a
->pipe_fd
= -1;
56 a
->pipe_watch
.type
= WATCH_INVALID
;
58 a
->directory_mode
= 0755;
61 static void repeat_unmout(const char *path
) {
65 /* If there are multiple mounts on a mount point, this
68 if (umount2(path
, MNT_DETACH
) >= 0)
72 log_error("Failed to unmount: %m");
78 static void unmount_autofs(Automount
*a
) {
84 automount_send_ready(a
, -EHOSTDOWN
);
86 unit_unwatch_fd(UNIT(a
), &a
->pipe_watch
);
87 close_nointr_nofail(a
->pipe_fd
);
90 /* If we reload/reexecute things we keep the mount point
93 (a
->meta
.manager
->exit_code
!= MANAGER_RELOAD
&&
94 a
->meta
.manager
->exit_code
!= MANAGER_REEXECUTE
))
95 repeat_unmout(a
->where
);
98 static void automount_done(Unit
*u
) {
99 Automount
*a
= AUTOMOUNT(u
);
113 int automount_add_one_mount_link(Automount
*a
, Mount
*m
) {
119 if (a
->meta
.load_state
!= UNIT_LOADED
||
120 m
->meta
.load_state
!= UNIT_LOADED
)
123 if (!path_startswith(a
->where
, m
->where
))
126 if (path_equal(a
->where
, m
->where
))
129 if ((r
= unit_add_two_dependencies(UNIT(a
), UNIT_AFTER
, 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 (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.", 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 "%sDirectoryMode: %04o\n",
258 prefix
, automount_state_to_string(a
->state
),
260 prefix
, a
->directory_mode
);
263 static void automount_enter_dead(Automount
*a
, bool success
) {
269 automount_set_state(a
, a
->failure
? AUTOMOUNT_MAINTENANCE
: AUTOMOUNT_DEAD
);
272 static int open_dev_autofs(Manager
*m
) {
273 struct autofs_dev_ioctl param
;
277 if (m
->dev_autofs_fd
>= 0)
278 return m
->dev_autofs_fd
;
280 if ((m
->dev_autofs_fd
= open("/dev/autofs", O_CLOEXEC
|O_RDONLY
)) < 0) {
281 log_error("Failed to open /dev/autofs: %s", strerror(errno
));
285 init_autofs_dev_ioctl(¶m
);
286 if (ioctl(m
->dev_autofs_fd
, AUTOFS_DEV_IOCTL_VERSION
, ¶m
) < 0) {
287 close_nointr_nofail(m
->dev_autofs_fd
);
288 m
->dev_autofs_fd
= -1;
292 log_debug("Autofs kernel version %i.%i", param
.ver_major
, param
.ver_minor
);
294 return m
->dev_autofs_fd
;
297 static int open_ioctl_fd(int dev_autofs_fd
, const char *where
, dev_t devid
) {
298 struct autofs_dev_ioctl
*param
;
302 assert(dev_autofs_fd
>= 0);
305 l
= sizeof(struct autofs_dev_ioctl
) + strlen(where
) + 1;
307 if (!(param
= malloc(l
)))
310 init_autofs_dev_ioctl(param
);
313 param
->openmount
.devid
= devid
;
314 strcpy(param
->path
, where
);
316 if (ioctl(dev_autofs_fd
, AUTOFS_DEV_IOCTL_OPENMOUNT
, param
) < 0) {
321 if (param
->ioctlfd
< 0) {
326 fd_cloexec(param
->ioctlfd
, true);
334 static int autofs_protocol(int dev_autofs_fd
, int ioctl_fd
) {
335 uint32_t major
, minor
;
336 struct autofs_dev_ioctl param
;
338 assert(dev_autofs_fd
>= 0);
339 assert(ioctl_fd
>= 0);
341 init_autofs_dev_ioctl(¶m
);
342 param
.ioctlfd
= ioctl_fd
;
344 if (ioctl(dev_autofs_fd
, AUTOFS_DEV_IOCTL_PROTOVER
, ¶m
) < 0)
347 major
= param
.protover
.version
;
349 init_autofs_dev_ioctl(¶m
);
350 param
.ioctlfd
= ioctl_fd
;
352 if (ioctl(dev_autofs_fd
, AUTOFS_DEV_IOCTL_PROTOSUBVER
, ¶m
) < 0)
355 minor
= param
.protosubver
.sub_version
;
357 log_debug("Autofs protocol version %i.%i", major
, minor
);
361 static int autofs_set_timeout(int dev_autofs_fd
, int ioctl_fd
, time_t sec
) {
362 struct autofs_dev_ioctl param
;
364 assert(dev_autofs_fd
>= 0);
365 assert(ioctl_fd
>= 0);
367 init_autofs_dev_ioctl(¶m
);
368 param
.ioctlfd
= ioctl_fd
;
369 param
.timeout
.timeout
= sec
;
371 if (ioctl(dev_autofs_fd
, AUTOFS_DEV_IOCTL_TIMEOUT
, ¶m
) < 0)
377 static int autofs_send_ready(int dev_autofs_fd
, int ioctl_fd
, uint32_t token
, int status
) {
378 struct autofs_dev_ioctl param
;
380 assert(dev_autofs_fd
>= 0);
381 assert(ioctl_fd
>= 0);
383 init_autofs_dev_ioctl(¶m
);
384 param
.ioctlfd
= ioctl_fd
;
387 param
.fail
.token
= token
;
388 param
.fail
.status
= status
;
390 param
.ready
.token
= token
;
392 if (ioctl(dev_autofs_fd
, status
? AUTOFS_DEV_IOCTL_FAIL
: AUTOFS_DEV_IOCTL_READY
, ¶m
) < 0)
398 int automount_send_ready(Automount
*a
, int status
) {
405 if (set_isempty(a
->tokens
))
408 if ((ioctl_fd
= open_ioctl_fd(a
->meta
.manager
->dev_autofs_fd
, a
->where
, a
->dev_id
)) < 0) {
414 log_debug("Sending failure: %s", strerror(-status
));
416 log_debug("Sending success.");
418 /* Autofs thankfully does not hand out 0 as a token */
419 while ((token
= PTR_TO_UINT(set_steal_first(a
->tokens
)))) {
422 /* Autofs fun fact II:
424 * if you pass a positive status code here, the kernel will
427 if ((k
= autofs_send_ready(a
->meta
.manager
->dev_autofs_fd
,
438 close_nointr_nofail(ioctl_fd
);
443 static void automount_enter_waiting(Automount
*a
) {
444 int p
[2] = { -1, -1 };
445 char name
[32], options
[128];
446 bool mounted
= false;
447 int r
, ioctl_fd
= -1, dev_autofs_fd
;
451 assert(a
->pipe_fd
< 0);
455 set_clear(a
->tokens
);
457 if ((dev_autofs_fd
= open_dev_autofs(a
->meta
.manager
)) < 0) {
462 /* We knowingly ignore the results of this call */
463 mkdir_p(a
->where
, 0555);
465 if (pipe2(p
, O_NONBLOCK
|O_CLOEXEC
) < 0) {
470 snprintf(options
, sizeof(options
), "fd=%i,pgrp=%u,minproto=5,maxproto=5,direct", p
[1], (unsigned) getpgrp());
471 char_array_0(options
);
473 snprintf(name
, sizeof(name
), "systemd-%u", (unsigned) getpid());
476 if (mount(name
, a
->where
, "autofs", 0, options
) < 0) {
483 close_nointr_nofail(p
[1]);
486 if (stat(a
->where
, &st
) < 0) {
491 if ((ioctl_fd
= open_ioctl_fd(dev_autofs_fd
, a
->where
, st
.st_dev
)) < 0) {
496 if ((r
= autofs_protocol(dev_autofs_fd
, ioctl_fd
)) < 0)
499 if ((r
= autofs_set_timeout(dev_autofs_fd
, ioctl_fd
, 300)) < 0)
504 * Unless we close the ioctl fd here, for some weird reason
505 * the direct mount will not receive events from the
508 close_nointr_nofail(ioctl_fd
);
511 if ((r
= unit_watch_fd(UNIT(a
), p
[0], EPOLLIN
, &a
->pipe_watch
)) < 0)
515 a
->dev_id
= st
.st_dev
;
517 automount_set_state(a
, AUTOMOUNT_WAITING
);
522 assert_se(close_pipe(p
) == 0);
525 close_nointr_nofail(ioctl_fd
);
528 repeat_unmout(a
->where
);
530 log_error("Failed to initialize automounter: %s", strerror(-r
));
531 automount_enter_dead(a
, false);
534 static void automount_enter_runnning(Automount
*a
) {
542 dbus_error_init(&error
);
544 mkdir_p(a
->where
, a
->directory_mode
);
546 /* Before we do anything, let's see if somebody is playing games with us? */
547 if (lstat(a
->where
, &st
) < 0) {
548 log_warning("%s failed stat automount point: %m", a
->meta
.id
);
552 if (!S_ISDIR(st
.st_mode
) || st
.st_dev
!= a
->dev_id
)
553 log_info("%s's automount point already active?", a
->meta
.id
);
554 else if ((r
= manager_add_job(a
->meta
.manager
, JOB_START
, UNIT(a
->mount
), JOB_REPLACE
, true, &error
, NULL
)) < 0) {
555 log_warning("%s failed to queue mount startup job: %s", a
->meta
.id
, bus_error(&error
, r
));
559 automount_set_state(a
, AUTOMOUNT_RUNNING
);
563 automount_enter_dead(a
, false);
564 dbus_error_free(&error
);
567 static int automount_start(Unit
*u
) {
568 Automount
*a
= AUTOMOUNT(u
);
572 assert(a
->state
== AUTOMOUNT_DEAD
|| a
->state
== AUTOMOUNT_MAINTENANCE
);
574 if (path_is_mount_point(a
->where
)) {
575 log_error("Path %s is already a mount point, refusing start for %s", a
->where
, u
->meta
.id
);
579 if (a
->mount
->meta
.load_state
!= UNIT_LOADED
)
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
), true)) != 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_MAINTENANCE
] = "maintenance"
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