]> git.ipfire.org Git - thirdparty/systemd.git/blame - src/core/automount.c
core: set private section name for automount units
[thirdparty/systemd.git] / src / core / automount.c
CommitLineData
53e1b683 1/* SPDX-License-Identifier: LGPL-2.1+ */
a7334b09 2
5cb5a6ff 3#include <errno.h>
8d567588 4#include <fcntl.h>
07630cea
LP
5#include <limits.h>
6#include <linux/auto_dev-ioctl.h>
7#include <linux/auto_fs4.h>
8d567588 8#include <sys/epoll.h>
07630cea 9#include <sys/mount.h>
8d567588 10#include <sys/stat.h>
07630cea 11#include <unistd.h>
5cb5a6ff 12
b5efdb8a 13#include "alloc-util.h"
07630cea 14#include "async.h"
3ffd4af2 15#include "automount.h"
07630cea
LP
16#include "bus-error.h"
17#include "bus-util.h"
18#include "dbus-automount.h"
6fcbec6f 19#include "dbus-unit.h"
3ffd4af2 20#include "fd-util.h"
f97b34a6 21#include "format-util.h"
c004493c 22#include "io-util.h"
e51bc1a2 23#include "label.h"
49e942b2 24#include "mkdir.h"
4349cd7c 25#include "mount-util.h"
07630cea 26#include "mount.h"
049af8ad 27#include "mountpoint-util.h"
6bedfcbb 28#include "parse-util.h"
9eb977db 29#include "path-util.h"
0b452006 30#include "process-util.h"
d68c645b 31#include "serialize.h"
07630cea 32#include "special.h"
15a5e950 33#include "stdio-util.h"
8b43440b 34#include "string-table.h"
07630cea
LP
35#include "string-util.h"
36#include "unit-name.h"
37#include "unit.h"
5cb5a6ff 38
e537352b
LP
39static const UnitActiveState state_translation_table[_AUTOMOUNT_STATE_MAX] = {
40 [AUTOMOUNT_DEAD] = UNIT_INACTIVE,
41 [AUTOMOUNT_WAITING] = UNIT_ACTIVE,
42 [AUTOMOUNT_RUNNING] = UNIT_ACTIVE,
74ac3cbd 43 [AUTOMOUNT_FAILED] = UNIT_FAILED
e537352b 44};
5cb5a6ff 45
deb0a77c
MO
46struct expire_data {
47 int dev_autofs_fd;
48 int ioctl_fd;
49};
50
a1e92eee 51static void expire_data_free(struct expire_data *data) {
deb0a77c
MO
52 if (!data)
53 return;
54
55 safe_close(data->dev_autofs_fd);
56 safe_close(data->ioctl_fd);
57 free(data);
58}
59
60DEFINE_TRIVIAL_CLEANUP_FUNC(struct expire_data*, expire_data_free);
61
a16e1123 62static int open_dev_autofs(Manager *m);
718db961 63static int automount_dispatch_io(sd_event_source *s, int fd, uint32_t events, void *userdata);
dbb0578e
LP
64static int automount_start_expire(Automount *a);
65static void automount_stop_expire(Automount *a);
66static int automount_send_ready(Automount *a, Set *tokens, int status);
8d567588 67
e537352b
LP
68static void automount_init(Unit *u) {
69 Automount *a = AUTOMOUNT(u);
5cb5a6ff 70
8d567588 71 assert(u);
ac155bb8 72 assert(u->load_state == UNIT_STUB);
8d567588 73
718db961 74 a->pipe_fd = -1;
1cf18f27 75 a->directory_mode = 0755;
1124fe6f 76 UNIT(a)->ignore_on_isolate = true;
8d567588
LP
77}
78
8d567588 79static void unmount_autofs(Automount *a) {
3f2c0bec
LP
80 int r;
81
8d567588
LP
82 assert(a);
83
84 if (a->pipe_fd < 0)
85 return;
86
718db961 87 a->pipe_event_source = sd_event_source_unref(a->pipe_event_source);
03e334a1 88 a->pipe_fd = safe_close(a->pipe_fd);
8d567588 89
e350ca3f 90 /* If we reload/reexecute things we keep the mount point around */
af41e508 91 if (!IN_SET(UNIT(a)->manager->objective, MANAGER_RELOAD, MANAGER_REEXECUTE)) {
e350ca3f 92
87d41d62
MO
93 automount_send_ready(a, a->tokens, -EHOSTDOWN);
94 automount_send_ready(a, a->expire_tokens, -EHOSTDOWN);
95
e350ca3f
LP
96 if (a->where) {
97 r = repeat_unmount(a->where, MNT_DETACH);
98 if (r < 0)
99 log_error_errno(r, "Failed to unmount: %m");
100 }
3f2c0bec 101 }
8d567588
LP
102}
103
104static void automount_done(Unit *u) {
105 Automount *a = AUTOMOUNT(u);
106
107 assert(a);
108
109 unmount_autofs(a);
8d567588 110
a1e58e8e 111 a->where = mfree(a->where);
a16e1123 112
525d3cc7
LP
113 a->tokens = set_free(a->tokens);
114 a->expire_tokens = set_free(a->expire_tokens);
deb0a77c
MO
115
116 a->expire_event_source = sd_event_source_unref(a->expire_event_source);
8d567588
LP
117}
118
eef85c4a
LP
119static int automount_add_trigger_dependencies(Automount *a) {
120 Unit *x;
121 int r;
122
123 assert(a);
124
125 r = unit_load_related_unit(UNIT(a), ".mount", &x);
126 if (r < 0)
127 return r;
128
129 return unit_add_two_dependencies(UNIT(a), UNIT_BEFORE, UNIT_TRIGGERS, x, true, UNIT_DEPENDENCY_IMPLICIT);
130}
131
132static int automount_add_mount_dependencies(Automount *a) {
a57f7e2c 133 _cleanup_free_ char *parent = NULL;
6e2ef85b
LP
134
135 assert(a);
1b560190 136
5f311f8c
LP
137 parent = dirname_malloc(a->where);
138 if (!parent)
139 return -ENOMEM;
6e2ef85b 140
eef85c4a 141 return unit_require_mounts_for(UNIT(a), parent, UNIT_DEPENDENCY_IMPLICIT);
6e2ef85b
LP
142}
143
2edd4434
LP
144static int automount_add_default_dependencies(Automount *a) {
145 int r;
146
147 assert(a);
148
4c9ea260
LP
149 if (!UNIT(a)->default_dependencies)
150 return 0;
151
463d0d15 152 if (!MANAGER_IS_SYSTEM(UNIT(a)->manager))
6b1dc2bd 153 return 0;
2a77d31d 154
b3d7aef5
FB
155 r = unit_add_dependency_by_name(UNIT(a), UNIT_BEFORE, SPECIAL_LOCAL_FS_TARGET, true, UNIT_DEPENDENCY_DEFAULT);
156 if (r < 0)
157 return r;
158
9432f882
ZJS
159 r = unit_add_dependency_by_name(UNIT(a), UNIT_AFTER, SPECIAL_LOCAL_FS_PRE_TARGET, true, UNIT_DEPENDENCY_DEFAULT);
160 if (r < 0)
161 return r;
162
5a724170 163 r = unit_add_two_dependencies_by_name(UNIT(a), UNIT_BEFORE, UNIT_CONFLICTS, SPECIAL_UMOUNT_TARGET, true, UNIT_DEPENDENCY_DEFAULT);
6b1dc2bd
LP
164 if (r < 0)
165 return r;
2edd4434
LP
166
167 return 0;
168}
169
8d567588 170static int automount_verify(Automount *a) {
e1d75803 171 _cleanup_free_ char *e = NULL;
7410616c
LP
172 int r;
173
8d567588 174 assert(a);
75193d41 175 assert(UNIT(a)->load_state == UNIT_LOADED);
8d567588 176
41e45059 177 if (path_equal(a->where, "/")) {
f2341e0a 178 log_unit_error(UNIT(a), "Cannot have an automount unit for the root directory. Refusing.");
6f40aa45 179 return -ENOEXEC;
41e45059
LP
180 }
181
7410616c
LP
182 r = unit_name_from_path(a->where, ".automount", &e);
183 if (r < 0)
b8b846d7 184 return log_unit_error_errno(UNIT(a), r, "Failed to generate unit name from path: %m");
8d567588 185
7410616c 186 if (!unit_has_name(UNIT(a), e)) {
f2341e0a 187 log_unit_error(UNIT(a), "Where= setting doesn't match unit name. Refusing.");
6f40aa45 188 return -ENOEXEC;
8d567588
LP
189 }
190
191 return 0;
e537352b 192}
5cb5a6ff 193
e350ca3f
LP
194static int automount_set_where(Automount *a) {
195 int r;
196
197 assert(a);
198
199 if (a->where)
200 return 0;
201
202 r = unit_name_to_path(UNIT(a)->id, &a->where);
203 if (r < 0)
204 return r;
205
858d36c1 206 path_simplify(a->where, false);
e350ca3f
LP
207 return 1;
208}
209
75193d41
ZJS
210static int automount_add_extras(Automount *a) {
211 int r;
212
213 r = automount_set_where(a);
214 if (r < 0)
215 return r;
216
217 r = automount_add_trigger_dependencies(a);
218 if (r < 0)
219 return r;
220
221 r = automount_add_mount_dependencies(a);
222 if (r < 0)
223 return r;
224
225 return automount_add_default_dependencies(a);
226}
227
e537352b 228static int automount_load(Unit *u) {
e537352b 229 Automount *a = AUTOMOUNT(u);
3ecaa09b 230 int r;
23a177ef 231
e537352b 232 assert(u);
ac155bb8 233 assert(u->load_state == UNIT_STUB);
5cb5a6ff 234
e537352b 235 /* Load a .automount file */
c3620770 236 r = unit_load_fragment_and_dropin(u, true);
0b2665c3 237 if (r < 0)
e537352b 238 return r;
23a177ef 239
75193d41
ZJS
240 if (u->load_state != UNIT_LOADED)
241 return 0;
4e67ddd6 242
75193d41
ZJS
243 r = automount_add_extras(a);
244 if (r < 0)
245 return r;
23a177ef 246
8d567588 247 return automount_verify(a);
5cb5a6ff
LP
248}
249
8d567588
LP
250static void automount_set_state(Automount *a, AutomountState state) {
251 AutomountState old_state;
e537352b 252 assert(a);
034c6ed7 253
6fcbec6f
LP
254 if (a->state != state)
255 bus_unit_send_pending_change_signal(UNIT(a), false);
256
8d567588
LP
257 old_state = a->state;
258 a->state = state;
259
dbb0578e
LP
260 if (state != AUTOMOUNT_RUNNING)
261 automount_stop_expire(a);
262
ec2ce0c5 263 if (!IN_SET(state, AUTOMOUNT_WAITING, AUTOMOUNT_RUNNING))
8d567588
LP
264 unmount_autofs(a);
265
266 if (state != old_state)
f2341e0a 267 log_unit_debug(UNIT(a), "Changed %s -> %s", automount_state_to_string(old_state), automount_state_to_string(state));
8d567588 268
2ad2e41a 269 unit_notify(UNIT(a), state_translation_table[old_state], state_translation_table[state], 0);
034c6ed7
LP
270}
271
be847e82 272static int automount_coldplug(Unit *u) {
a16e1123
LP
273 Automount *a = AUTOMOUNT(u);
274 int r;
275
276 assert(a);
277 assert(a->state == AUTOMOUNT_DEAD);
278
e350ca3f
LP
279 if (a->deserialized_state == a->state)
280 return 0;
281
282 if (IN_SET(a->deserialized_state, AUTOMOUNT_WAITING, AUTOMOUNT_RUNNING)) {
283
284 r = automount_set_where(a);
285 if (r < 0)
286 return r;
a16e1123 287
0b2665c3
LP
288 r = open_dev_autofs(u->manager);
289 if (r < 0)
a16e1123
LP
290 return r;
291
e350ca3f
LP
292 assert(a->pipe_fd >= 0);
293
294 r = sd_event_add_io(u->manager->event, &a->pipe_event_source, a->pipe_fd, EPOLLIN, automount_dispatch_io, u);
295 if (r < 0)
296 return r;
a16e1123 297
e350ca3f
LP
298 (void) sd_event_source_set_description(a->pipe_event_source, "automount-io");
299 if (a->deserialized_state == AUTOMOUNT_RUNNING) {
300 r = automount_start_expire(a);
0b2665c3 301 if (r < 0)
e350ca3f 302 log_unit_warning_errno(UNIT(a), r, "Failed to start expiration timer, ignoring: %m");
a16e1123
LP
303 }
304
305 automount_set_state(a, a->deserialized_state);
306 }
307
308 return 0;
309}
310
87f0e418 311static void automount_dump(Unit *u, FILE *f, const char *prefix) {
deb0a77c 312 char time_string[FORMAT_TIMESPAN_MAX];
a16e1123 313 Automount *a = AUTOMOUNT(u);
5cb5a6ff 314
a16e1123 315 assert(a);
5cb5a6ff
LP
316
317 fprintf(f,
a16e1123 318 "%sAutomount State: %s\n"
81a5c6d0 319 "%sResult: %s\n"
1cf18f27 320 "%sWhere: %s\n"
deb0a77c
MO
321 "%sDirectoryMode: %04o\n"
322 "%sTimeoutIdleUSec: %s\n",
a16e1123 323 prefix, automount_state_to_string(a->state),
81a5c6d0 324 prefix, automount_result_to_string(a->result),
1cf18f27 325 prefix, a->where,
deb0a77c
MO
326 prefix, a->directory_mode,
327 prefix, format_timespan(time_string, FORMAT_TIMESPAN_MAX, a->timeout_idle_usec, USEC_PER_SEC));
5cb5a6ff
LP
328}
329
81a5c6d0 330static void automount_enter_dead(Automount *a, AutomountResult f) {
8d567588
LP
331 assert(a);
332
a0fef983 333 if (a->result == AUTOMOUNT_SUCCESS)
81a5c6d0 334 a->result = f;
8d567588 335
aac99f30 336 unit_log_result(UNIT(a), a->result == AUTOMOUNT_SUCCESS, automount_result_to_string(a->result));
81a5c6d0 337 automount_set_state(a, a->result != AUTOMOUNT_SUCCESS ? AUTOMOUNT_FAILED : AUTOMOUNT_DEAD);
8d567588
LP
338}
339
340static int open_dev_autofs(Manager *m) {
341 struct autofs_dev_ioctl param;
342
343 assert(m);
344
345 if (m->dev_autofs_fd >= 0)
346 return m->dev_autofs_fd;
347
08c84981 348 (void) label_fix("/dev/autofs", 0);
56cf987f 349
0b2665c3 350 m->dev_autofs_fd = open("/dev/autofs", O_CLOEXEC|O_RDONLY);
4a62c710
MS
351 if (m->dev_autofs_fd < 0)
352 return log_error_errno(errno, "Failed to open /dev/autofs: %m");
8d567588
LP
353
354 init_autofs_dev_ioctl(&param);
355 if (ioctl(m->dev_autofs_fd, AUTOFS_DEV_IOCTL_VERSION, &param) < 0) {
03e334a1 356 m->dev_autofs_fd = safe_close(m->dev_autofs_fd);
8d567588
LP
357 return -errno;
358 }
359
360 log_debug("Autofs kernel version %i.%i", param.ver_major, param.ver_minor);
361
362 return m->dev_autofs_fd;
363}
364
365static int open_ioctl_fd(int dev_autofs_fd, const char *where, dev_t devid) {
366 struct autofs_dev_ioctl *param;
367 size_t l;
8d567588
LP
368
369 assert(dev_autofs_fd >= 0);
370 assert(where);
371
372 l = sizeof(struct autofs_dev_ioctl) + strlen(where) + 1;
0b2665c3 373 param = alloca(l);
8d567588
LP
374
375 init_autofs_dev_ioctl(param);
376 param->size = l;
377 param->ioctlfd = -1;
378 param->openmount.devid = devid;
379 strcpy(param->path, where);
380
0b2665c3
LP
381 if (ioctl(dev_autofs_fd, AUTOFS_DEV_IOCTL_OPENMOUNT, param) < 0)
382 return -errno;
8d567588 383
0b2665c3
LP
384 if (param->ioctlfd < 0)
385 return -EIO;
8d567588 386
f34beace 387 (void) fd_cloexec(param->ioctlfd, true);
0b2665c3 388 return param->ioctlfd;
8d567588
LP
389}
390
391static int autofs_protocol(int dev_autofs_fd, int ioctl_fd) {
392 uint32_t major, minor;
393 struct autofs_dev_ioctl param;
394
395 assert(dev_autofs_fd >= 0);
396 assert(ioctl_fd >= 0);
397
398 init_autofs_dev_ioctl(&param);
399 param.ioctlfd = ioctl_fd;
400
401 if (ioctl(dev_autofs_fd, AUTOFS_DEV_IOCTL_PROTOVER, &param) < 0)
402 return -errno;
403
404 major = param.protover.version;
405
406 init_autofs_dev_ioctl(&param);
407 param.ioctlfd = ioctl_fd;
408
409 if (ioctl(dev_autofs_fd, AUTOFS_DEV_IOCTL_PROTOSUBVER, &param) < 0)
410 return -errno;
411
412 minor = param.protosubver.sub_version;
413
414 log_debug("Autofs protocol version %i.%i", major, minor);
415 return 0;
416}
417
deb0a77c 418static int autofs_set_timeout(int dev_autofs_fd, int ioctl_fd, usec_t usec) {
8d567588
LP
419 struct autofs_dev_ioctl param;
420
421 assert(dev_autofs_fd >= 0);
422 assert(ioctl_fd >= 0);
423
424 init_autofs_dev_ioctl(&param);
425 param.ioctlfd = ioctl_fd;
deb0a77c 426
2d79a0bb
N
427 if (usec == USEC_INFINITY)
428 param.timeout.timeout = 0;
429 else
430 /* Convert to seconds, rounding up. */
be6b0c21 431 param.timeout.timeout = DIV_ROUND_UP(usec, USEC_PER_SEC);
8d567588
LP
432
433 if (ioctl(dev_autofs_fd, AUTOFS_DEV_IOCTL_TIMEOUT, &param) < 0)
434 return -errno;
435
436 return 0;
437}
438
439static int autofs_send_ready(int dev_autofs_fd, int ioctl_fd, uint32_t token, int status) {
440 struct autofs_dev_ioctl param;
441
442 assert(dev_autofs_fd >= 0);
443 assert(ioctl_fd >= 0);
444
445 init_autofs_dev_ioctl(&param);
446 param.ioctlfd = ioctl_fd;
447
9703a8ad 448 if (status != 0) {
8d567588
LP
449 param.fail.token = token;
450 param.fail.status = status;
451 } else
452 param.ready.token = token;
453
454 if (ioctl(dev_autofs_fd, status ? AUTOFS_DEV_IOCTL_FAIL : AUTOFS_DEV_IOCTL_READY, &param) < 0)
455 return -errno;
456
457 return 0;
458}
459
deb0a77c 460static int automount_send_ready(Automount *a, Set *tokens, int status) {
03e334a1 461 _cleanup_close_ int ioctl_fd = -1;
8d567588 462 unsigned token;
03e334a1 463 int r;
8d567588
LP
464
465 assert(a);
466 assert(status <= 0);
467
deb0a77c 468 if (set_isempty(tokens))
8d567588
LP
469 return 0;
470
0b2665c3 471 ioctl_fd = open_ioctl_fd(UNIT(a)->manager->dev_autofs_fd, a->where, a->dev_id);
03e334a1
LP
472 if (ioctl_fd < 0)
473 return ioctl_fd;
8d567588 474
9703a8ad 475 if (status != 0)
f2341e0a 476 log_unit_debug_errno(UNIT(a), status, "Sending failure: %m");
8d567588 477 else
f2341e0a 478 log_unit_debug(UNIT(a), "Sending success.");
8d567588 479
e364ad06
LP
480 r = 0;
481
8d567588 482 /* Autofs thankfully does not hand out 0 as a token */
deb0a77c 483 while ((token = PTR_TO_UINT(set_steal_first(tokens)))) {
8d567588
LP
484 int k;
485
ca5b440a 486 /* Autofs fun fact:
8d567588 487 *
ca5b440a
N
488 * if you pass a positive status code here, kernels
489 * prior to 4.12 will freeze! Yay! */
8d567588 490
0b2665c3
LP
491 k = autofs_send_ready(UNIT(a)->manager->dev_autofs_fd,
492 ioctl_fd,
493 token,
494 status);
495 if (k < 0)
8d567588
LP
496 r = k;
497 }
498
8d567588
LP
499 return r;
500}
501
fae03ed3
LP
502static void automount_trigger_notify(Unit *u, Unit *other) {
503 Automount *a = AUTOMOUNT(u);
3dbadf9e
MO
504 int r;
505
deb0a77c 506 assert(a);
fae03ed3
LP
507 assert(other);
508
509 /* Filter out invocations with bogus state */
510 if (other->load_state != UNIT_LOADED || other->type != UNIT_MOUNT)
511 return;
512
513 /* Don't propagate state changes from the mount if we are already down */
514 if (!IN_SET(a->state, AUTOMOUNT_WAITING, AUTOMOUNT_RUNNING))
515 return;
deb0a77c 516
fae03ed3
LP
517 /* Propagate start limit hit state */
518 if (other->start_limit_hit) {
519 automount_enter_dead(a, AUTOMOUNT_FAILURE_MOUNT_START_LIMIT_HIT);
520 return;
521 }
9703a8ad 522
fae03ed3
LP
523 /* Don't propagate anything if there's still a job queued */
524 if (other->job)
525 return;
526
527 /* The mount is successfully established */
528 if (IN_SET(MOUNT(other)->state, MOUNT_MOUNTED, MOUNT_REMOUNTING)) {
529 (void) automount_send_ready(a, a->tokens, 0);
deb0a77c 530
3dbadf9e
MO
531 r = automount_start_expire(a);
532 if (r < 0)
533 log_unit_warning_errno(UNIT(a), r, "Failed to start expiration timer, ignoring: %m");
deb0a77c 534
fae03ed3 535 automount_set_state(a, AUTOMOUNT_RUNNING);
deb0a77c
MO
536 }
537
0a62f810
MO
538 if (IN_SET(MOUNT(other)->state,
539 MOUNT_MOUNTING, MOUNT_MOUNTING_DONE,
540 MOUNT_MOUNTED, MOUNT_REMOUNTING,
0a62f810
MO
541 MOUNT_REMOUNTING_SIGTERM, MOUNT_REMOUNTING_SIGKILL,
542 MOUNT_UNMOUNTING_SIGTERM, MOUNT_UNMOUNTING_SIGKILL,
543 MOUNT_FAILED)) {
544
545 (void) automount_send_ready(a, a->expire_tokens, -ENODEV);
546 }
547
548 if (MOUNT(other)->state == MOUNT_DEAD)
549 (void) automount_send_ready(a, a->expire_tokens, 0);
550
fae03ed3
LP
551 /* The mount is in some unhappy state now, let's unfreeze any waiting clients */
552 if (IN_SET(MOUNT(other)->state,
553 MOUNT_DEAD, MOUNT_UNMOUNTING,
fae03ed3
LP
554 MOUNT_REMOUNTING_SIGTERM, MOUNT_REMOUNTING_SIGKILL,
555 MOUNT_UNMOUNTING_SIGTERM, MOUNT_UNMOUNTING_SIGKILL,
556 MOUNT_FAILED)) {
deb0a77c 557
fae03ed3 558 (void) automount_send_ready(a, a->tokens, -ENODEV);
deb0a77c 559
fae03ed3
LP
560 automount_set_state(a, AUTOMOUNT_WAITING);
561 }
deb0a77c
MO
562}
563
8d567588 564static void automount_enter_waiting(Automount *a) {
03e334a1 565 _cleanup_close_ int ioctl_fd = -1;
8d567588 566 int p[2] = { -1, -1 };
fbd0b64f
LP
567 char name[STRLEN("systemd-") + DECIMAL_STR_MAX(pid_t) + 1];
568 char options[STRLEN("fd=,pgrp=,minproto=5,maxproto=5,direct")
5ffa8c81 569 + DECIMAL_STR_MAX(int) + DECIMAL_STR_MAX(gid_t) + 1];
8d567588 570 bool mounted = false;
03e334a1 571 int r, dev_autofs_fd;
8d567588
LP
572 struct stat st;
573
574 assert(a);
575 assert(a->pipe_fd < 0);
576 assert(a->where);
577
f2341e0a
LP
578 set_clear(a->tokens);
579
25cd4964 580 r = unit_fail_if_noncanonical(UNIT(a), a->where);
f2341e0a
LP
581 if (r < 0)
582 goto fail;
583
8084dcb9 584 (void) mkdir_p_label(a->where, a->directory_mode);
f2341e0a
LP
585
586 unit_warn_if_dir_nonempty(UNIT(a), a->where);
8d567588 587
0b2665c3
LP
588 dev_autofs_fd = open_dev_autofs(UNIT(a)->manager);
589 if (dev_autofs_fd < 0) {
8d567588
LP
590 r = dev_autofs_fd;
591 goto fail;
592 }
593
1cae151d 594 if (pipe2(p, O_CLOEXEC) < 0) {
8d567588
LP
595 r = -errno;
596 goto fail;
597 }
1cae151d
N
598 r = fd_nonblock(p[0], true);
599 if (r < 0)
600 goto fail;
8d567588 601
5ffa8c81 602 xsprintf(options, "fd=%i,pgrp="PID_FMT",minproto=5,maxproto=5,direct", p[1], getpgrp());
df0ff127 603 xsprintf(name, "systemd-"PID_FMT, getpid_cached());
8d567588
LP
604 if (mount(name, a->where, "autofs", 0, options) < 0) {
605 r = -errno;
606 goto fail;
607 }
608
609 mounted = true;
610
03e334a1 611 p[1] = safe_close(p[1]);
8d567588
LP
612
613 if (stat(a->where, &st) < 0) {
614 r = -errno;
615 goto fail;
616 }
617
0b2665c3
LP
618 ioctl_fd = open_ioctl_fd(dev_autofs_fd, a->where, st.st_dev);
619 if (ioctl_fd < 0) {
8d567588
LP
620 r = ioctl_fd;
621 goto fail;
622 }
623
0b2665c3
LP
624 r = autofs_protocol(dev_autofs_fd, ioctl_fd);
625 if (r < 0)
8d567588
LP
626 goto fail;
627
deb0a77c 628 r = autofs_set_timeout(dev_autofs_fd, ioctl_fd, a->timeout_idle_usec);
0b2665c3 629 if (r < 0)
8d567588
LP
630 goto fail;
631
151b9b96 632 r = sd_event_add_io(UNIT(a)->manager->event, &a->pipe_event_source, p[0], EPOLLIN, automount_dispatch_io, a);
0b2665c3 633 if (r < 0)
8d567588
LP
634 goto fail;
635
7dfbe2e3
TG
636 (void) sd_event_source_set_description(a->pipe_event_source, "automount-io");
637
8d567588
LP
638 a->pipe_fd = p[0];
639 a->dev_id = st.st_dev;
640
641 automount_set_state(a, AUTOMOUNT_WAITING);
642
643 return;
644
645fail:
3f2c0bec
LP
646 log_unit_error_errno(UNIT(a), r, "Failed to initialize automounter: %m");
647
3d94f76c 648 safe_close_pair(p);
8d567588 649
3f2c0bec
LP
650 if (mounted) {
651 r = repeat_unmount(a->where, MNT_DETACH);
652 if (r < 0)
653 log_error_errno(r, "Failed to unmount, ignoring: %m");
654 }
8d567588 655
81a5c6d0 656 automount_enter_dead(a, AUTOMOUNT_FAILURE_RESOURCES);
8d567588
LP
657}
658
deb0a77c
MO
659static void *expire_thread(void *p) {
660 struct autofs_dev_ioctl param;
661 _cleanup_(expire_data_freep) struct expire_data *data = (struct expire_data*)p;
662 int r;
663
664 assert(data->dev_autofs_fd >= 0);
665 assert(data->ioctl_fd >= 0);
666
667 init_autofs_dev_ioctl(&param);
668 param.ioctlfd = data->ioctl_fd;
669
670 do {
671 r = ioctl(data->dev_autofs_fd, AUTOFS_DEV_IOCTL_EXPIRE, &param);
672 } while (r >= 0);
673
674 if (errno != EAGAIN)
675 log_warning_errno(errno, "Failed to expire automount, ignoring: %m");
676
677 return NULL;
678}
679
deb0a77c
MO
680static int automount_dispatch_expire(sd_event_source *source, usec_t usec, void *userdata) {
681 Automount *a = AUTOMOUNT(userdata);
682 _cleanup_(expire_data_freep) struct expire_data *data = NULL;
683 int r;
684
685 assert(a);
686 assert(source == a->expire_event_source);
687
688 data = new0(struct expire_data, 1);
689 if (!data)
690 return log_oom();
691
692 data->ioctl_fd = -1;
693
694 data->dev_autofs_fd = fcntl(UNIT(a)->manager->dev_autofs_fd, F_DUPFD_CLOEXEC, 3);
695 if (data->dev_autofs_fd < 0)
f2341e0a 696 return log_unit_error_errno(UNIT(a), errno, "Failed to duplicate autofs fd: %m");
deb0a77c
MO
697
698 data->ioctl_fd = open_ioctl_fd(UNIT(a)->manager->dev_autofs_fd, a->where, a->dev_id);
699 if (data->ioctl_fd < 0)
f2341e0a 700 return log_unit_error_errno(UNIT(a), data->ioctl_fd, "Couldn't open autofs ioctl fd: %m");
deb0a77c
MO
701
702 r = asynchronous_job(expire_thread, data);
703 if (r < 0)
f2341e0a 704 return log_unit_error_errno(UNIT(a), r, "Failed to start expire job: %m");
deb0a77c
MO
705
706 data = NULL;
707
708 return automount_start_expire(a);
709}
710
711static int automount_start_expire(Automount *a) {
712 int r;
713 usec_t timeout;
714
715 assert(a);
716
93a3b53b
DM
717 if (a->timeout_idle_usec == 0)
718 return 0;
719
dbf5cc47 720 timeout = now(CLOCK_MONOTONIC) + MAX(a->timeout_idle_usec/3, USEC_PER_SEC);
deb0a77c
MO
721
722 if (a->expire_event_source) {
723 r = sd_event_source_set_time(a->expire_event_source, timeout);
724 if (r < 0)
725 return r;
726
727 return sd_event_source_set_enabled(a->expire_event_source, SD_EVENT_ONESHOT);
728 }
729
7dfbe2e3 730 r = sd_event_add_time(
deb0a77c
MO
731 UNIT(a)->manager->event,
732 &a->expire_event_source,
733 CLOCK_MONOTONIC, timeout, 0,
734 automount_dispatch_expire, a);
7dfbe2e3
TG
735 if (r < 0)
736 return r;
737
738 (void) sd_event_source_set_description(a->expire_event_source, "automount-expire");
739
740 return 0;
deb0a77c
MO
741}
742
dbb0578e
LP
743static void automount_stop_expire(Automount *a) {
744 assert(a);
745
746 if (!a->expire_event_source)
747 return;
748
749 (void) sd_event_source_set_enabled(a->expire_event_source, SD_EVENT_OFF);
750}
751
e7d54bf5 752static void automount_enter_running(Automount *a) {
4afd3348 753 _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
e7d54bf5 754 Unit *trigger;
3ecaa09b
LP
755 struct stat st;
756 int r;
8d567588
LP
757
758 assert(a);
8d567588 759
e350ca3f
LP
760 /* If the user masked our unit in the meantime, fail */
761 if (UNIT(a)->load_state != UNIT_LOADED) {
762 log_unit_error(UNIT(a), "Suppressing automount event since unit is no longer loaded.");
763 goto fail;
764 }
765
ba3e67a7
LP
766 /* We don't take mount requests anymore if we are supposed to
767 * shut down anyway */
31afa0a4 768 if (unit_stop_pending(UNIT(a))) {
f2341e0a 769 log_unit_debug(UNIT(a), "Suppressing automount request since unit stop is scheduled.");
deb0a77c
MO
770 automount_send_ready(a, a->tokens, -EHOSTDOWN);
771 automount_send_ready(a, a->expire_tokens, -EHOSTDOWN);
ba3e67a7
LP
772 return;
773 }
774
6e5dcce4 775 (void) mkdir_p_label(a->where, a->directory_mode);
8d567588 776
1cf18f27
LP
777 /* Before we do anything, let's see if somebody is playing games with us? */
778 if (lstat(a->where, &st) < 0) {
f2341e0a 779 log_unit_warning_errno(UNIT(a), errno, "Failed to stat automount point: %m");
8d567588
LP
780 goto fail;
781 }
782
e7d54bf5
AC
783 /* The mount unit may have been explicitly started before we got the
784 * autofs request. Ack it to unblock anything waiting on the mount point. */
785 if (!S_ISDIR(st.st_mode) || st.st_dev != a->dev_id) {
f2341e0a 786 log_unit_info(UNIT(a), "Automount point already active?");
e7d54bf5
AC
787 automount_send_ready(a, a->tokens, 0);
788 return;
789 }
e903182e 790
e7d54bf5
AC
791 trigger = UNIT_TRIGGER(UNIT(a));
792 if (!trigger) {
793 log_unit_error(UNIT(a), "Unit to trigger vanished.");
794 goto fail;
795 }
e903182e 796
50cbaba4 797 r = manager_add_job(UNIT(a)->manager, JOB_START, trigger, JOB_REPLACE, NULL, &error, NULL);
e7d54bf5
AC
798 if (r < 0) {
799 log_unit_warning(UNIT(a), "Failed to queue mount startup job: %s", bus_error_message(&error, r));
800 goto fail;
8d567588
LP
801 }
802
803 automount_set_state(a, AUTOMOUNT_RUNNING);
804 return;
805
806fail:
81a5c6d0 807 automount_enter_dead(a, AUTOMOUNT_FAILURE_RESOURCES);
8d567588
LP
808}
809
810static int automount_start(Unit *u) {
811 Automount *a = AUTOMOUNT(u);
07299350 812 int r;
8d567588
LP
813
814 assert(a);
3742095b 815 assert(IN_SET(a->state, AUTOMOUNT_DEAD, AUTOMOUNT_FAILED));
01f78473 816
e1873695 817 if (path_is_mount_point(a->where, NULL, 0) > 0) {
f2341e0a 818 log_unit_error(u, "Path %s is already a mount point, refusing start.", a->where);
8d567588
LP
819 return -EEXIST;
820 }
821
a4191c9f
LP
822 r = unit_test_trigger_loaded(u);
823 if (r < 0)
824 return r;
8d567588 825
97a3f4ee 826 r = unit_test_start_limit(u);
07299350
LP
827 if (r < 0) {
828 automount_enter_dead(a, AUTOMOUNT_FAILURE_START_LIMIT_HIT);
829 return r;
830 }
831
4b58153d
LP
832 r = unit_acquire_invocation_id(u);
833 if (r < 0)
834 return r;
835
81a5c6d0 836 a->result = AUTOMOUNT_SUCCESS;
8d567588 837 automount_enter_waiting(a);
82a2b6bb 838 return 1;
8d567588
LP
839}
840
841static int automount_stop(Unit *u) {
842 Automount *a = AUTOMOUNT(u);
843
844 assert(a);
3742095b 845 assert(IN_SET(a->state, AUTOMOUNT_WAITING, AUTOMOUNT_RUNNING));
8d567588 846
81a5c6d0 847 automount_enter_dead(a, AUTOMOUNT_SUCCESS);
82a2b6bb 848 return 1;
8d567588
LP
849}
850
a16e1123
LP
851static int automount_serialize(Unit *u, FILE *f, FDSet *fds) {
852 Automount *a = AUTOMOUNT(u);
a16e1123 853 Iterator i;
a34ceba6
LP
854 void *p;
855 int r;
a16e1123
LP
856
857 assert(a);
858 assert(f);
859 assert(fds);
860
d68c645b
LP
861 (void) serialize_item(f, "state", automount_state_to_string(a->state));
862 (void) serialize_item(f, "result", automount_result_to_string(a->result));
863 (void) serialize_item_format(f, "dev-id", "%lu", (unsigned long) a->dev_id);
a16e1123
LP
864
865 SET_FOREACH(p, a->tokens, i)
d68c645b 866 (void) serialize_item_format(f, "token", "%u", PTR_TO_UINT(p));
deb0a77c 867 SET_FOREACH(p, a->expire_tokens, i)
d68c645b 868 (void) serialize_item_format(f, "expire-token", "%u", PTR_TO_UINT(p));
a16e1123 869
d68c645b 870 r = serialize_fd(f, fds, "pipe-fd", a->pipe_fd);
a34ceba6
LP
871 if (r < 0)
872 return r;
a16e1123
LP
873
874 return 0;
875}
876
877static int automount_deserialize_item(Unit *u, const char *key, const char *value, FDSet *fds) {
878 Automount *a = AUTOMOUNT(u);
879 int r;
880
881 assert(a);
882 assert(fds);
883
884 if (streq(key, "state")) {
885 AutomountState state;
886
0b2665c3
LP
887 state = automount_state_from_string(value);
888 if (state < 0)
f2341e0a 889 log_unit_debug(u, "Failed to parse state value: %s", value);
a16e1123
LP
890 else
891 a->deserialized_state = state;
81a5c6d0
LP
892 } else if (streq(key, "result")) {
893 AutomountResult f;
894
895 f = automount_result_from_string(value);
896 if (f < 0)
f2341e0a 897 log_unit_debug(u, "Failed to parse result value: %s", value);
81a5c6d0
LP
898 else if (f != AUTOMOUNT_SUCCESS)
899 a->result = f;
a16e1123 900
a16e1123 901 } else if (streq(key, "dev-id")) {
a2a44444 902 unsigned long d;
a16e1123 903
a2a44444 904 if (safe_atolu(value, &d) < 0)
f2341e0a 905 log_unit_debug(u, "Failed to parse dev-id value: %s", value);
a16e1123 906 else
a2a44444
LP
907 a->dev_id = (dev_t) d;
908
a16e1123
LP
909 } else if (streq(key, "token")) {
910 unsigned token;
911
912 if (safe_atou(value, &token) < 0)
f2341e0a 913 log_unit_debug(u, "Failed to parse token value: %s", value);
a16e1123 914 else {
de7fef4b 915 r = set_ensure_put(&a->tokens, NULL, UINT_TO_PTR(token));
0b2665c3 916 if (r < 0)
f2341e0a 917 log_unit_error_errno(u, r, "Failed to add token to set: %m");
a16e1123 918 }
deb0a77c
MO
919 } else if (streq(key, "expire-token")) {
920 unsigned token;
921
922 if (safe_atou(value, &token) < 0)
f2341e0a 923 log_unit_debug(u, "Failed to parse token value: %s", value);
deb0a77c 924 else {
de7fef4b 925 r = set_ensure_put(&a->expire_tokens, NULL, UINT_TO_PTR(token));
deb0a77c 926 if (r < 0)
f2341e0a 927 log_unit_error_errno(u, r, "Failed to add expire token to set: %m");
deb0a77c 928 }
a16e1123
LP
929 } else if (streq(key, "pipe-fd")) {
930 int fd;
931
932 if (safe_atoi(value, &fd) < 0 || fd < 0 || !fdset_contains(fds, fd))
f2341e0a 933 log_unit_debug(u, "Failed to parse pipe-fd value: %s", value);
a16e1123 934 else {
03e334a1 935 safe_close(a->pipe_fd);
a16e1123
LP
936 a->pipe_fd = fdset_remove(fds, fd);
937 }
938 } else
f2341e0a 939 log_unit_debug(u, "Unknown serialization key: %s", key);
a16e1123
LP
940
941 return 0;
942}
943
87f0e418 944static UnitActiveState automount_active_state(Unit *u) {
a16e1123 945 assert(u);
87f0e418 946
e537352b 947 return state_translation_table[AUTOMOUNT(u)->state];
5cb5a6ff
LP
948}
949
10a94420
LP
950static const char *automount_sub_state_to_string(Unit *u) {
951 assert(u);
952
a16e1123 953 return automount_state_to_string(AUTOMOUNT(u)->state);
10a94420
LP
954}
955
f2f725e5
ZJS
956static bool automount_may_gc(Unit *u) {
957 Unit *t;
958
3ecaa09b 959 assert(u);
701cc384 960
f2f725e5
ZJS
961 t = UNIT_TRIGGER(u);
962 if (!t)
963 return true;
7573916f 964
f2f725e5 965 return UNIT_VTABLE(t)->may_gc(t);
701cc384
LP
966}
967
718db961 968static int automount_dispatch_io(sd_event_source *s, int fd, uint32_t events, void *userdata) {
4afd3348 969 _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
8d567588 970 union autofs_v5_packet_union packet;
718db961 971 Automount *a = AUTOMOUNT(userdata);
e903182e 972 Unit *trigger;
8d567588
LP
973 int r;
974
8d567588
LP
975 assert(a);
976 assert(fd == a->pipe_fd);
977
978 if (events != EPOLLIN) {
f2341e0a 979 log_unit_error(UNIT(a), "Got invalid poll event %"PRIu32" on pipe (fd=%d)", events, fd);
8d567588
LP
980 goto fail;
981 }
982
a6dcc7e5
ZJS
983 r = loop_read_exact(a->pipe_fd, &packet, sizeof(packet), true);
984 if (r < 0) {
f2341e0a 985 log_unit_error_errno(UNIT(a), r, "Invalid read from pipe: %m");
8d567588
LP
986 goto fail;
987 }
988
989 switch (packet.hdr.type) {
990
991 case autofs_ptype_missing_direct:
941a4041
LP
992
993 if (packet.v5_packet.pid > 0) {
e42e801b 994 _cleanup_free_ char *p = NULL;
941a4041 995
87d2c1ff 996 get_process_comm(packet.v5_packet.pid, &p);
f2341e0a 997 log_unit_info(UNIT(a), "Got automount request for %s, triggered by %"PRIu32" (%s)", a->where, packet.v5_packet.pid, strna(p));
941a4041 998 } else
f2341e0a 999 log_unit_debug(UNIT(a), "Got direct mount request on %s", a->where);
8d567588 1000
de7fef4b 1001 r = set_ensure_put(&a->tokens, NULL, UINT_TO_PTR(packet.v5_packet.wait_queue_token));
0b2665c3 1002 if (r < 0) {
f2341e0a 1003 log_unit_error_errno(UNIT(a), r, "Failed to remember token: %m");
8d567588
LP
1004 goto fail;
1005 }
1006
e7d54bf5 1007 automount_enter_running(a);
8d567588
LP
1008 break;
1009
deb0a77c 1010 case autofs_ptype_expire_direct:
f2341e0a 1011 log_unit_debug(UNIT(a), "Got direct umount request on %s", a->where);
deb0a77c 1012
dbb0578e 1013 automount_stop_expire(a);
deb0a77c 1014
de7fef4b 1015 r = set_ensure_put(&a->expire_tokens, NULL, UINT_TO_PTR(packet.v5_packet.wait_queue_token));
deb0a77c 1016 if (r < 0) {
f2341e0a 1017 log_unit_error_errno(UNIT(a), r, "Failed to remember token: %m");
deb0a77c
MO
1018 goto fail;
1019 }
5f8ae398 1020
e903182e
LP
1021 trigger = UNIT_TRIGGER(UNIT(a));
1022 if (!trigger) {
1023 log_unit_error(UNIT(a), "Unit to trigger vanished.");
1024 goto fail;
1025 }
1026
50cbaba4 1027 r = manager_add_job(UNIT(a)->manager, JOB_STOP, trigger, JOB_REPLACE, NULL, &error, NULL);
deb0a77c 1028 if (r < 0) {
f2341e0a 1029 log_unit_warning(UNIT(a), "Failed to queue umount startup job: %s", bus_error_message(&error, r));
deb0a77c
MO
1030 goto fail;
1031 }
1032 break;
1033
8d567588 1034 default:
f2341e0a 1035 log_unit_error(UNIT(a), "Received unknown automount request %i", packet.hdr.type);
8d567588
LP
1036 break;
1037 }
1038
718db961 1039 return 0;
8d567588
LP
1040
1041fail:
81a5c6d0 1042 automount_enter_dead(a, AUTOMOUNT_FAILURE_RESOURCES);
718db961 1043 return 0;
8d567588
LP
1044}
1045
1046static void automount_shutdown(Manager *m) {
1047 assert(m);
1048
03e334a1 1049 m->dev_autofs_fd = safe_close(m->dev_autofs_fd);
8d567588
LP
1050}
1051
74ac3cbd 1052static void automount_reset_failed(Unit *u) {
5632e374
LP
1053 Automount *a = AUTOMOUNT(u);
1054
1055 assert(a);
1056
74ac3cbd 1057 if (a->state == AUTOMOUNT_FAILED)
5632e374
LP
1058 automount_set_state(a, AUTOMOUNT_DEAD);
1059
81a5c6d0 1060 a->result = AUTOMOUNT_SUCCESS;
5632e374
LP
1061}
1062
1c2e9646 1063static bool automount_supported(void) {
0faacd47
LP
1064 static int supported = -1;
1065
0faacd47
LP
1066 if (supported < 0)
1067 supported = access("/dev/autofs", F_OK) >= 0;
1068
1069 return supported;
1070}
1071
81a5c6d0
LP
1072static const char* const automount_result_table[_AUTOMOUNT_RESULT_MAX] = {
1073 [AUTOMOUNT_SUCCESS] = "success",
07299350
LP
1074 [AUTOMOUNT_FAILURE_RESOURCES] = "resources",
1075 [AUTOMOUNT_FAILURE_START_LIMIT_HIT] = "start-limit-hit",
fae03ed3 1076 [AUTOMOUNT_FAILURE_MOUNT_START_LIMIT_HIT] = "mount-start-limit-hit",
81a5c6d0
LP
1077};
1078
1079DEFINE_STRING_TABLE_LOOKUP(automount_result, AutomountResult);
1080
87f0e418 1081const UnitVTable automount_vtable = {
7d17cfbc 1082 .object_size = sizeof(Automount),
718db961 1083
f975e971
LP
1084 .sections =
1085 "Unit\0"
1086 "Automount\0"
1087 "Install\0",
2fadbb45 1088 .private_section = "Automount",
5cb5a6ff 1089
c80a9a33
LP
1090 .can_transient = true,
1091 .can_fail = true,
1092 .can_trigger = true,
1093
034c6ed7 1094 .init = automount_init,
e537352b 1095 .load = automount_load,
034c6ed7 1096 .done = automount_done,
5cb5a6ff 1097
a16e1123
LP
1098 .coldplug = automount_coldplug,
1099
034c6ed7 1100 .dump = automount_dump,
5cb5a6ff 1101
8d567588
LP
1102 .start = automount_start,
1103 .stop = automount_stop,
1104
a16e1123
LP
1105 .serialize = automount_serialize,
1106 .deserialize_item = automount_deserialize_item,
1107
10a94420 1108 .active_state = automount_active_state,
8d567588
LP
1109 .sub_state_to_string = automount_sub_state_to_string,
1110
f2f725e5 1111 .may_gc = automount_may_gc,
701cc384 1112
fae03ed3
LP
1113 .trigger_notify = automount_trigger_notify,
1114
74ac3cbd 1115 .reset_failed = automount_reset_failed,
5632e374 1116
afb14803
MO
1117 .bus_set_property = bus_automount_set_property,
1118
c6918296 1119 .shutdown = automount_shutdown,
0faacd47 1120 .supported = automount_supported,
c6918296
MS
1121
1122 .status_message_formats = {
1123 .finished_start_job = {
1124 [JOB_DONE] = "Set up automount %s.",
1125 [JOB_FAILED] = "Failed to set up automount %s.",
c6918296
MS
1126 },
1127 .finished_stop_job = {
1128 [JOB_DONE] = "Unset automount %s.",
1129 [JOB_FAILED] = "Failed to unset automount %s.",
1130 },
1131 },
5cb5a6ff 1132};