]> git.ipfire.org Git - thirdparty/systemd.git/blob - src/automount.c
dbus: make errors reported via D-Bus more useful
[thirdparty/systemd.git] / src / automount.c
1 /*-*- Mode: C; c-basic-offset: 8 -*-*/
2
3 /***
4 This file is part of systemd.
5
6 Copyright 2010 Lennart Poettering
7
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.
12
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.
17
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/>.
20 ***/
21
22 #include <errno.h>
23 #include <limits.h>
24 #include <sys/mount.h>
25 #include <unistd.h>
26 #include <fcntl.h>
27 #include <sys/epoll.h>
28 #include <sys/stat.h>
29 #include <linux/auto_fs4.h>
30 #include <linux/auto_dev-ioctl.h>
31
32 #include "unit.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"
39
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
45 };
46
47 static int open_dev_autofs(Manager *m);
48
49 static void automount_init(Unit *u) {
50 Automount *a = AUTOMOUNT(u);
51
52 assert(u);
53 assert(u->meta.load_state == UNIT_STUB);
54
55 a->pipe_watch.fd = a->pipe_fd = -1;
56 a->pipe_watch.type = WATCH_INVALID;
57
58 a->directory_mode = 0755;
59 }
60
61 static void repeat_unmout(const char *path) {
62 assert(path);
63
64 for (;;) {
65 /* If there are multiple mounts on a mount point, this
66 * removes them all */
67
68 if (umount2(path, MNT_DETACH) >= 0)
69 continue;
70
71 if (errno != EINVAL)
72 log_error("Failed to unmount: %m");
73
74 break;
75 }
76 }
77
78 static void unmount_autofs(Automount *a) {
79 assert(a);
80
81 if (a->pipe_fd < 0)
82 return;
83
84 automount_send_ready(a, -EHOSTDOWN);
85
86 unit_unwatch_fd(UNIT(a), &a->pipe_watch);
87 close_nointr_nofail(a->pipe_fd);
88 a->pipe_fd = -1;
89
90 /* If we reload/reexecute things we keep the mount point
91 * around */
92 if (a->where &&
93 (a->meta.manager->exit_code != MANAGER_RELOAD &&
94 a->meta.manager->exit_code != MANAGER_REEXECUTE))
95 repeat_unmout(a->where);
96 }
97
98 static void automount_done(Unit *u) {
99 Automount *a = AUTOMOUNT(u);
100
101 assert(a);
102
103 unmount_autofs(a);
104 a->mount = NULL;
105
106 free(a->where);
107 a->where = NULL;
108
109 set_free(a->tokens);
110 a->tokens = NULL;
111 }
112
113 int automount_add_one_mount_link(Automount *a, Mount *m) {
114 int r;
115
116 assert(a);
117 assert(m);
118
119 if (a->meta.load_state != UNIT_LOADED ||
120 m->meta.load_state != UNIT_LOADED)
121 return 0;
122
123 if (!path_startswith(a->where, m->where))
124 return 0;
125
126 if (path_equal(a->where, m->where))
127 return 0;
128
129 if ((r = unit_add_two_dependencies(UNIT(a), UNIT_AFTER, UNIT_REQUIRES, UNIT(m), true)) < 0)
130 return r;
131
132 return 0;
133 }
134
135 static int automount_add_mount_links(Automount *a) {
136 Meta *other;
137 int r;
138
139 assert(a);
140
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)
143 return r;
144
145 return 0;
146 }
147
148 static int automount_verify(Automount *a) {
149 bool b;
150 char *e;
151 assert(a);
152
153 if (a->meta.load_state != UNIT_LOADED)
154 return 0;
155
156 if (!(e = unit_name_from_path(a->where, ".automount")))
157 return -ENOMEM;
158
159 b = unit_has_name(UNIT(a), e);
160 free(e);
161
162 if (!b) {
163 log_error("%s's Where setting doesn't match unit name. Refusing.", a->meta.id);
164 return -EINVAL;
165 }
166
167 return 0;
168 }
169
170 static int automount_load(Unit *u) {
171 int r;
172 Automount *a = AUTOMOUNT(u);
173
174 assert(u);
175 assert(u->meta.load_state == UNIT_STUB);
176
177 /* Load a .automount file */
178 if ((r = unit_load_fragment_and_dropin_optional(u)) < 0)
179 return r;
180
181 if (u->meta.load_state == UNIT_LOADED) {
182
183 if (!a->where)
184 if (!(a->where = unit_name_to_path(u->meta.id)))
185 return -ENOMEM;
186
187 path_kill_slashes(a->where);
188
189 if ((r = automount_add_mount_links(a)) < 0)
190 return r;
191
192 if ((r = unit_load_related_unit(u, ".mount", (Unit**) &a->mount)) < 0)
193 return r;
194
195 if ((r = unit_add_dependency(u, UNIT_BEFORE, UNIT(a->mount), true)) < 0)
196 return r;
197 }
198
199 return automount_verify(a);
200 }
201
202 static void automount_set_state(Automount *a, AutomountState state) {
203 AutomountState old_state;
204 assert(a);
205
206 old_state = a->state;
207 a->state = state;
208
209 if (state != AUTOMOUNT_WAITING &&
210 state != AUTOMOUNT_RUNNING)
211 unmount_autofs(a);
212
213 if (state != old_state)
214 log_debug("%s changed %s -> %s",
215 a->meta.id,
216 automount_state_to_string(old_state),
217 automount_state_to_string(state));
218
219 unit_notify(UNIT(a), state_translation_table[old_state], state_translation_table[state]);
220 }
221
222 static int automount_coldplug(Unit *u) {
223 Automount *a = AUTOMOUNT(u);
224 int r;
225
226 assert(a);
227 assert(a->state == AUTOMOUNT_DEAD);
228
229 if (a->deserialized_state != a->state) {
230
231 if ((r = open_dev_autofs(u->meta.manager)) < 0)
232 return r;
233
234 if (a->deserialized_state == AUTOMOUNT_WAITING ||
235 a->deserialized_state == AUTOMOUNT_RUNNING) {
236
237 assert(a->pipe_fd >= 0);
238
239 if ((r = unit_watch_fd(UNIT(a), a->pipe_fd, EPOLLIN, &a->pipe_watch)) < 0)
240 return r;
241 }
242
243 automount_set_state(a, a->deserialized_state);
244 }
245
246 return 0;
247 }
248
249 static void automount_dump(Unit *u, FILE *f, const char *prefix) {
250 Automount *a = AUTOMOUNT(u);
251
252 assert(a);
253
254 fprintf(f,
255 "%sAutomount State: %s\n"
256 "%sWhere: %s\n"
257 "%sDirectoryMode: %04o\n",
258 prefix, automount_state_to_string(a->state),
259 prefix, a->where,
260 prefix, a->directory_mode);
261 }
262
263 static void automount_enter_dead(Automount *a, bool success) {
264 assert(a);
265
266 if (!success)
267 a->failure = true;
268
269 automount_set_state(a, a->failure ? AUTOMOUNT_MAINTENANCE : AUTOMOUNT_DEAD);
270 }
271
272 static int open_dev_autofs(Manager *m) {
273 struct autofs_dev_ioctl param;
274
275 assert(m);
276
277 if (m->dev_autofs_fd >= 0)
278 return m->dev_autofs_fd;
279
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));
282 return -errno;
283 }
284
285 init_autofs_dev_ioctl(&param);
286 if (ioctl(m->dev_autofs_fd, AUTOFS_DEV_IOCTL_VERSION, &param) < 0) {
287 close_nointr_nofail(m->dev_autofs_fd);
288 m->dev_autofs_fd = -1;
289 return -errno;
290 }
291
292 log_debug("Autofs kernel version %i.%i", param.ver_major, param.ver_minor);
293
294 return m->dev_autofs_fd;
295 }
296
297 static int open_ioctl_fd(int dev_autofs_fd, const char *where, dev_t devid) {
298 struct autofs_dev_ioctl *param;
299 size_t l;
300 int r;
301
302 assert(dev_autofs_fd >= 0);
303 assert(where);
304
305 l = sizeof(struct autofs_dev_ioctl) + strlen(where) + 1;
306
307 if (!(param = malloc(l)))
308 return -ENOMEM;
309
310 init_autofs_dev_ioctl(param);
311 param->size = l;
312 param->ioctlfd = -1;
313 param->openmount.devid = devid;
314 strcpy(param->path, where);
315
316 if (ioctl(dev_autofs_fd, AUTOFS_DEV_IOCTL_OPENMOUNT, param) < 0) {
317 r = -errno;
318 goto finish;
319 }
320
321 if (param->ioctlfd < 0) {
322 r = -EIO;
323 goto finish;
324 }
325
326 fd_cloexec(param->ioctlfd, true);
327 r = param->ioctlfd;
328
329 finish:
330 free(param);
331 return r;
332 }
333
334 static int autofs_protocol(int dev_autofs_fd, int ioctl_fd) {
335 uint32_t major, minor;
336 struct autofs_dev_ioctl param;
337
338 assert(dev_autofs_fd >= 0);
339 assert(ioctl_fd >= 0);
340
341 init_autofs_dev_ioctl(&param);
342 param.ioctlfd = ioctl_fd;
343
344 if (ioctl(dev_autofs_fd, AUTOFS_DEV_IOCTL_PROTOVER, &param) < 0)
345 return -errno;
346
347 major = param.protover.version;
348
349 init_autofs_dev_ioctl(&param);
350 param.ioctlfd = ioctl_fd;
351
352 if (ioctl(dev_autofs_fd, AUTOFS_DEV_IOCTL_PROTOSUBVER, &param) < 0)
353 return -errno;
354
355 minor = param.protosubver.sub_version;
356
357 log_debug("Autofs protocol version %i.%i", major, minor);
358 return 0;
359 }
360
361 static int autofs_set_timeout(int dev_autofs_fd, int ioctl_fd, time_t sec) {
362 struct autofs_dev_ioctl param;
363
364 assert(dev_autofs_fd >= 0);
365 assert(ioctl_fd >= 0);
366
367 init_autofs_dev_ioctl(&param);
368 param.ioctlfd = ioctl_fd;
369 param.timeout.timeout = sec;
370
371 if (ioctl(dev_autofs_fd, AUTOFS_DEV_IOCTL_TIMEOUT, &param) < 0)
372 return -errno;
373
374 return 0;
375 }
376
377 static int autofs_send_ready(int dev_autofs_fd, int ioctl_fd, uint32_t token, int status) {
378 struct autofs_dev_ioctl param;
379
380 assert(dev_autofs_fd >= 0);
381 assert(ioctl_fd >= 0);
382
383 init_autofs_dev_ioctl(&param);
384 param.ioctlfd = ioctl_fd;
385
386 if (status) {
387 param.fail.token = token;
388 param.fail.status = status;
389 } else
390 param.ready.token = token;
391
392 if (ioctl(dev_autofs_fd, status ? AUTOFS_DEV_IOCTL_FAIL : AUTOFS_DEV_IOCTL_READY, &param) < 0)
393 return -errno;
394
395 return 0;
396 }
397
398 int automount_send_ready(Automount *a, int status) {
399 int ioctl_fd, r;
400 unsigned token;
401
402 assert(a);
403 assert(status <= 0);
404
405 if (set_isempty(a->tokens))
406 return 0;
407
408 if ((ioctl_fd = open_ioctl_fd(a->meta.manager->dev_autofs_fd, a->where, a->dev_id)) < 0) {
409 r = ioctl_fd;
410 goto fail;
411 }
412
413 if (status)
414 log_debug("Sending failure: %s", strerror(-status));
415 else
416 log_debug("Sending success.");
417
418 /* Autofs thankfully does not hand out 0 as a token */
419 while ((token = PTR_TO_UINT(set_steal_first(a->tokens)))) {
420 int k;
421
422 /* Autofs fun fact II:
423 *
424 * if you pass a positive status code here, the kernel will
425 * freeze! Yay! */
426
427 if ((k = autofs_send_ready(a->meta.manager->dev_autofs_fd,
428 ioctl_fd,
429 token,
430 status)) < 0)
431 r = k;
432 }
433
434 r = 0;
435
436 fail:
437 if (ioctl_fd >= 0)
438 close_nointr_nofail(ioctl_fd);
439
440 return r;
441 }
442
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;
448 struct stat st;
449
450 assert(a);
451 assert(a->pipe_fd < 0);
452 assert(a->where);
453
454 if (a->tokens)
455 set_clear(a->tokens);
456
457 if ((dev_autofs_fd = open_dev_autofs(a->meta.manager)) < 0) {
458 r = dev_autofs_fd;
459 goto fail;
460 }
461
462 /* We knowingly ignore the results of this call */
463 mkdir_p(a->where, 0555);
464
465 if (pipe2(p, O_NONBLOCK|O_CLOEXEC) < 0) {
466 r = -errno;
467 goto fail;
468 }
469
470 snprintf(options, sizeof(options), "fd=%i,pgrp=%u,minproto=5,maxproto=5,direct", p[1], (unsigned) getpgrp());
471 char_array_0(options);
472
473 snprintf(name, sizeof(name), "systemd-%u", (unsigned) getpid());
474 char_array_0(name);
475
476 if (mount(name, a->where, "autofs", 0, options) < 0) {
477 r = -errno;
478 goto fail;
479 }
480
481 mounted = true;
482
483 close_nointr_nofail(p[1]);
484 p[1] = -1;
485
486 if (stat(a->where, &st) < 0) {
487 r = -errno;
488 goto fail;
489 }
490
491 if ((ioctl_fd = open_ioctl_fd(dev_autofs_fd, a->where, st.st_dev)) < 0) {
492 r = ioctl_fd;
493 goto fail;
494 }
495
496 if ((r = autofs_protocol(dev_autofs_fd, ioctl_fd)) < 0)
497 goto fail;
498
499 if ((r = autofs_set_timeout(dev_autofs_fd, ioctl_fd, 300)) < 0)
500 goto fail;
501
502 /* Autofs fun fact:
503 *
504 * Unless we close the ioctl fd here, for some weird reason
505 * the direct mount will not receive events from the
506 * kernel. */
507
508 close_nointr_nofail(ioctl_fd);
509 ioctl_fd = -1;
510
511 if ((r = unit_watch_fd(UNIT(a), p[0], EPOLLIN, &a->pipe_watch)) < 0)
512 goto fail;
513
514 a->pipe_fd = p[0];
515 a->dev_id = st.st_dev;
516
517 automount_set_state(a, AUTOMOUNT_WAITING);
518
519 return;
520
521 fail:
522 assert_se(close_pipe(p) == 0);
523
524 if (ioctl_fd >= 0)
525 close_nointr_nofail(ioctl_fd);
526
527 if (mounted)
528 repeat_unmout(a->where);
529
530 log_error("Failed to initialize automounter: %s", strerror(-r));
531 automount_enter_dead(a, false);
532 }
533
534 static void automount_enter_runnning(Automount *a) {
535 int r;
536 struct stat st;
537 DBusError error;
538
539 assert(a);
540 assert(a->mount);
541
542 dbus_error_init(&error);
543
544 mkdir_p(a->where, a->directory_mode);
545
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);
549 goto fail;
550 }
551
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));
556 goto fail;
557 }
558
559 automount_set_state(a, AUTOMOUNT_RUNNING);
560 return;
561
562 fail:
563 automount_enter_dead(a, false);
564 dbus_error_free(&error);
565 }
566
567 static int automount_start(Unit *u) {
568 Automount *a = AUTOMOUNT(u);
569
570 assert(a);
571
572 assert(a->state == AUTOMOUNT_DEAD || a->state == AUTOMOUNT_MAINTENANCE);
573
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);
576 return -EEXIST;
577 }
578
579 if (a->mount->meta.load_state != UNIT_LOADED)
580 return -ENOENT;
581
582 a->failure = false;
583 automount_enter_waiting(a);
584 return 0;
585 }
586
587 static int automount_stop(Unit *u) {
588 Automount *a = AUTOMOUNT(u);
589
590 assert(a);
591
592 assert(a->state == AUTOMOUNT_WAITING || a->state == AUTOMOUNT_RUNNING);
593
594 automount_enter_dead(a, true);
595 return 0;
596 }
597
598 static int automount_serialize(Unit *u, FILE *f, FDSet *fds) {
599 Automount *a = AUTOMOUNT(u);
600 void *p;
601 Iterator i;
602
603 assert(a);
604 assert(f);
605 assert(fds);
606
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);
610
611 SET_FOREACH(p, a->tokens, i)
612 unit_serialize_item_format(u, f, "token", "%u", PTR_TO_UINT(p));
613
614 if (a->pipe_fd >= 0) {
615 int copy;
616
617 if ((copy = fdset_put_dup(fds, a->pipe_fd)) < 0)
618 return copy;
619
620 unit_serialize_item_format(u, f, "pipe-fd", "%i", copy);
621 }
622
623 return 0;
624 }
625
626 static int automount_deserialize_item(Unit *u, const char *key, const char *value, FDSet *fds) {
627 Automount *a = AUTOMOUNT(u);
628 int r;
629
630 assert(a);
631 assert(fds);
632
633 if (streq(key, "state")) {
634 AutomountState state;
635
636 if ((state = automount_state_from_string(value)) < 0)
637 log_debug("Failed to parse state value %s", value);
638 else
639 a->deserialized_state = state;
640 } else if (streq(key, "failure")) {
641 int b;
642
643 if ((b = parse_boolean(value)) < 0)
644 log_debug("Failed to parse failure value %s", value);
645 else
646 a->failure = b || a->failure;
647 } else if (streq(key, "dev-id")) {
648 unsigned d;
649
650 if (safe_atou(value, &d) < 0)
651 log_debug("Failed to parse dev-id value %s", value);
652 else
653 a->dev_id = (unsigned) d;
654 } else if (streq(key, "token")) {
655 unsigned token;
656
657 if (safe_atou(value, &token) < 0)
658 log_debug("Failed to parse token value %s", value);
659 else {
660 if (!a->tokens)
661 if (!(a->tokens = set_new(trivial_hash_func, trivial_compare_func)))
662 return -ENOMEM;
663
664 if ((r = set_put(a->tokens, UINT_TO_PTR(token))) < 0)
665 return r;
666 }
667 } else if (streq(key, "pipe-fd")) {
668 int fd;
669
670 if (safe_atoi(value, &fd) < 0 || fd < 0 || !fdset_contains(fds, fd))
671 log_debug("Failed to parse pipe-fd value %s", value);
672 else {
673 if (a->pipe_fd >= 0)
674 close_nointr_nofail(a->pipe_fd);
675
676 a->pipe_fd = fdset_remove(fds, fd);
677 }
678 } else
679 log_debug("Unknown serialization key '%s'", key);
680
681 return 0;
682 }
683
684 static UnitActiveState automount_active_state(Unit *u) {
685 assert(u);
686
687 return state_translation_table[AUTOMOUNT(u)->state];
688 }
689
690 static const char *automount_sub_state_to_string(Unit *u) {
691 assert(u);
692
693 return automount_state_to_string(AUTOMOUNT(u)->state);
694 }
695
696 static bool automount_check_gc(Unit *u) {
697 Automount *a = AUTOMOUNT(u);
698
699 assert(a);
700
701 return UNIT_VTABLE(UNIT(a->mount))->check_gc(UNIT(a->mount));
702 }
703
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;
707 ssize_t l;
708 int r;
709
710 assert(a);
711 assert(fd == a->pipe_fd);
712
713 if (events != EPOLLIN) {
714 log_error("Got invalid poll event on pipe.");
715 goto fail;
716 }
717
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");
720 goto fail;
721 }
722
723 switch (packet.hdr.type) {
724
725 case autofs_ptype_missing_direct:
726 log_debug("Got direct mount request for %s", packet.v5_packet.name);
727
728 if (!a->tokens)
729 if (!(a->tokens = set_new(trivial_hash_func, trivial_compare_func))) {
730 log_error("Failed to allocate token set.");
731 goto fail;
732 }
733
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));
736 goto fail;
737 }
738
739 automount_enter_runnning(a);
740 break;
741
742 default:
743 log_error("Received unknown automount request %i", packet.hdr.type);
744 break;
745 }
746
747 return;
748
749 fail:
750 automount_enter_dead(a, false);
751 }
752
753 static void automount_shutdown(Manager *m) {
754 assert(m);
755
756 if (m->dev_autofs_fd >= 0)
757 close_nointr_nofail(m->dev_autofs_fd);
758 }
759
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"
765 };
766
767 DEFINE_STRING_TABLE_LOOKUP(automount_state, AutomountState);
768
769 const UnitVTable automount_vtable = {
770 .suffix = ".automount",
771
772 .no_alias = true,
773 .no_instances = true,
774
775 .init = automount_init,
776 .load = automount_load,
777 .done = automount_done,
778
779 .coldplug = automount_coldplug,
780
781 .dump = automount_dump,
782
783 .start = automount_start,
784 .stop = automount_stop,
785
786 .serialize = automount_serialize,
787 .deserialize_item = automount_deserialize_item,
788
789 .active_state = automount_active_state,
790 .sub_state_to_string = automount_sub_state_to_string,
791
792 .check_gc = automount_check_gc,
793
794 .fd_event = automount_fd_event,
795
796 .bus_message_handler = bus_automount_message_handler,
797
798 .shutdown = automount_shutdown
799 };