1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
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 Lesser General Public License as published by
10 the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
18 You should have received a copy of the GNU Lesser General Public License
19 along with systemd; If not, see <http://www.gnu.org/licenses/>.
23 #include <sys/epoll.h>
24 #include <sys/inotify.h>
27 #include "bus-error.h"
29 #include "dbus-path.h"
35 #include "string-util.h"
36 #include "unit-name.h"
39 static const UnitActiveState state_translation_table
[_PATH_STATE_MAX
] = {
40 [PATH_DEAD
] = UNIT_INACTIVE
,
41 [PATH_WAITING
] = UNIT_ACTIVE
,
42 [PATH_RUNNING
] = UNIT_ACTIVE
,
43 [PATH_FAILED
] = UNIT_FAILED
46 static int path_dispatch_io(sd_event_source
*source
, int fd
, uint32_t revents
, void *userdata
);
48 int path_spec_watch(PathSpec
*s
, sd_event_io_handler_t handler
) {
50 static const int flags_table
[_PATH_TYPE_MAX
] = {
51 [PATH_EXISTS
] = IN_DELETE_SELF
|IN_MOVE_SELF
|IN_ATTRIB
,
52 [PATH_EXISTS_GLOB
] = IN_DELETE_SELF
|IN_MOVE_SELF
|IN_ATTRIB
,
53 [PATH_CHANGED
] = IN_DELETE_SELF
|IN_MOVE_SELF
|IN_ATTRIB
|IN_CLOSE_WRITE
|IN_CREATE
|IN_DELETE
|IN_MOVED_FROM
|IN_MOVED_TO
,
54 [PATH_MODIFIED
] = IN_DELETE_SELF
|IN_MOVE_SELF
|IN_ATTRIB
|IN_CLOSE_WRITE
|IN_CREATE
|IN_DELETE
|IN_MOVED_FROM
|IN_MOVED_TO
|IN_MODIFY
,
55 [PATH_DIRECTORY_NOT_EMPTY
] = IN_DELETE_SELF
|IN_MOVE_SELF
|IN_ATTRIB
|IN_CREATE
|IN_MOVED_TO
59 char *slash
, *oldslash
= NULL
;
68 s
->inotify_fd
= inotify_init1(IN_NONBLOCK
|IN_CLOEXEC
);
69 if (s
->inotify_fd
< 0) {
74 r
= sd_event_add_io(s
->unit
->manager
->event
, &s
->event_source
, s
->inotify_fd
, EPOLLIN
, handler
, s
);
78 (void) sd_event_source_set_description(s
->event_source
, "path");
80 /* This assumes the path was passed through path_kill_slashes()! */
82 for (slash
= strchr(s
->path
, '/'); ; slash
= strchr(slash
+1, '/')) {
88 cut
= slash
+ (slash
== s
->path
);
92 flags
= IN_MOVE_SELF
| IN_DELETE_SELF
| IN_ATTRIB
| IN_CREATE
| IN_MOVED_TO
;
94 flags
= flags_table
[s
->type
];
96 r
= inotify_add_watch(s
->inotify_fd
, s
->path
, flags
);
98 if (errno
== EACCES
|| errno
== ENOENT
) {
104 r
= log_warning_errno(errno
, "Failed to add watch on %s: %s", s
->path
, errno
== ENOSPC
? "too many watches" : strerror(-r
));
111 /* Path exists, we don't need to watch parent
114 char *cut2
= oldslash
+ (oldslash
== s
->path
);
118 inotify_add_watch(s
->inotify_fd
, s
->path
, IN_MOVE_SELF
);
119 /* Error is ignored, the worst can happen is
120 we get spurious events. */
132 /* whole path has been iterated over */
139 r
= log_error_errno(errno
, "Failed to add watch on any of the components of %s: %m", s
->path
);
140 /* either EACCESS or ENOENT */
147 path_spec_unwatch(s
);
151 void path_spec_unwatch(PathSpec
*s
) {
154 s
->event_source
= sd_event_source_unref(s
->event_source
);
155 s
->inotify_fd
= safe_close(s
->inotify_fd
);
158 int path_spec_fd_event(PathSpec
*s
, uint32_t revents
) {
159 union inotify_event_buffer buffer
;
160 struct inotify_event
*e
;
164 if (revents
!= EPOLLIN
) {
165 log_error("Got invalid poll event on inotify.");
169 l
= read(s
->inotify_fd
, &buffer
, sizeof(buffer
));
171 if (errno
== EAGAIN
|| errno
== EINTR
)
174 return log_error_errno(errno
, "Failed to read inotify event: %m");
177 FOREACH_INOTIFY_EVENT(e
, buffer
, l
) {
178 if ((s
->type
== PATH_CHANGED
|| s
->type
== PATH_MODIFIED
) &&
179 s
->primary_wd
== e
->wd
)
186 static bool path_spec_check_good(PathSpec
*s
, bool initial
) {
192 good
= access(s
->path
, F_OK
) >= 0;
195 case PATH_EXISTS_GLOB
:
196 good
= glob_exists(s
->path
) > 0;
199 case PATH_DIRECTORY_NOT_EMPTY
: {
202 k
= dir_is_empty(s
->path
);
203 good
= !(k
== -ENOENT
|| k
> 0);
208 case PATH_MODIFIED
: {
211 b
= access(s
->path
, F_OK
) >= 0;
212 good
= !initial
&& b
!= s
->previous_exists
;
213 s
->previous_exists
= b
;
224 static void path_spec_mkdir(PathSpec
*s
, mode_t mode
) {
227 if (s
->type
== PATH_EXISTS
|| s
->type
== PATH_EXISTS_GLOB
)
230 r
= mkdir_p_label(s
->path
, mode
);
232 log_warning_errno(r
, "mkdir(%s) failed: %m", s
->path
);
235 static void path_spec_dump(PathSpec
*s
, FILE *f
, const char *prefix
) {
239 path_type_to_string(s
->type
),
243 void path_spec_done(PathSpec
*s
) {
245 assert(s
->inotify_fd
== -1);
250 static void path_init(Unit
*u
) {
254 assert(u
->load_state
== UNIT_STUB
);
256 p
->directory_mode
= 0755;
259 void path_free_specs(Path
*p
) {
264 while ((s
= p
->specs
)) {
265 path_spec_unwatch(s
);
266 LIST_REMOVE(spec
, p
->specs
, s
);
272 static void path_done(Unit
*u
) {
280 static int path_add_mount_links(Path
*p
) {
286 LIST_FOREACH(spec
, s
, p
->specs
) {
287 r
= unit_require_mounts_for(UNIT(p
), s
->path
);
295 static int path_verify(Path
*p
) {
298 if (UNIT(p
)->load_state
!= UNIT_LOADED
)
302 log_unit_error(UNIT(p
), "Path unit lacks path setting. Refusing.");
309 static int path_add_default_dependencies(Path
*p
) {
314 r
= unit_add_dependency_by_name(UNIT(p
), UNIT_BEFORE
,
315 SPECIAL_PATHS_TARGET
, NULL
, true);
319 if (UNIT(p
)->manager
->running_as
== MANAGER_SYSTEM
) {
320 r
= unit_add_two_dependencies_by_name(UNIT(p
), UNIT_AFTER
, UNIT_REQUIRES
,
321 SPECIAL_SYSINIT_TARGET
, NULL
, true);
326 return unit_add_two_dependencies_by_name(UNIT(p
), UNIT_BEFORE
, UNIT_CONFLICTS
,
327 SPECIAL_SHUTDOWN_TARGET
, NULL
, true);
330 static int path_load(Unit
*u
) {
335 assert(u
->load_state
== UNIT_STUB
);
337 r
= unit_load_fragment_and_dropin(u
);
341 if (u
->load_state
== UNIT_LOADED
) {
343 if (set_isempty(u
->dependencies
[UNIT_TRIGGERS
])) {
346 r
= unit_load_related_unit(u
, ".service", &x
);
350 r
= unit_add_two_dependencies(u
, UNIT_BEFORE
, UNIT_TRIGGERS
, x
, true);
355 r
= path_add_mount_links(p
);
359 if (UNIT(p
)->default_dependencies
) {
360 r
= path_add_default_dependencies(p
);
366 return path_verify(p
);
369 static void path_dump(Unit
*u
, FILE *f
, const char *prefix
) {
377 trigger
= UNIT_TRIGGER(u
);
383 "%sMakeDirectory: %s\n"
384 "%sDirectoryMode: %04o\n",
385 prefix
, path_state_to_string(p
->state
),
386 prefix
, path_result_to_string(p
->result
),
387 prefix
, trigger
? trigger
->id
: "n/a",
388 prefix
, yes_no(p
->make_directory
),
389 prefix
, p
->directory_mode
);
391 LIST_FOREACH(spec
, s
, p
->specs
)
392 path_spec_dump(s
, f
, prefix
);
395 static void path_unwatch(Path
*p
) {
400 LIST_FOREACH(spec
, s
, p
->specs
)
401 path_spec_unwatch(s
);
404 static int path_watch(Path
*p
) {
410 LIST_FOREACH(spec
, s
, p
->specs
) {
411 r
= path_spec_watch(s
, path_dispatch_io
);
419 static void path_set_state(Path
*p
, PathState state
) {
423 old_state
= p
->state
;
426 if (state
!= PATH_WAITING
&&
427 (state
!= PATH_RUNNING
|| p
->inotify_triggered
))
430 if (state
!= old_state
)
431 log_unit_debug(UNIT(p
), "Changed %s -> %s", path_state_to_string(old_state
), path_state_to_string(state
));
433 unit_notify(UNIT(p
), state_translation_table
[old_state
], state_translation_table
[state
], true);
436 static void path_enter_waiting(Path
*p
, bool initial
, bool recheck
);
438 static int path_coldplug(Unit
*u
) {
442 assert(p
->state
== PATH_DEAD
);
444 if (p
->deserialized_state
!= p
->state
) {
446 if (p
->deserialized_state
== PATH_WAITING
||
447 p
->deserialized_state
== PATH_RUNNING
)
448 path_enter_waiting(p
, true, true);
450 path_set_state(p
, p
->deserialized_state
);
456 static void path_enter_dead(Path
*p
, PathResult f
) {
459 if (f
!= PATH_SUCCESS
)
462 path_set_state(p
, p
->result
!= PATH_SUCCESS
? PATH_FAILED
: PATH_DEAD
);
465 static void path_enter_running(Path
*p
) {
466 _cleanup_bus_error_free_ sd_bus_error error
= SD_BUS_ERROR_NULL
;
471 /* Don't start job if we are supposed to go down */
472 if (unit_stop_pending(UNIT(p
)))
475 r
= manager_add_job(UNIT(p
)->manager
, JOB_START
, UNIT_TRIGGER(UNIT(p
)),
476 JOB_REPLACE
, true, &error
, NULL
);
480 p
->inotify_triggered
= false;
486 path_set_state(p
, PATH_RUNNING
);
490 log_unit_warning(UNIT(p
), "Failed to queue unit startup job: %s", bus_error_message(&error
, r
));
491 path_enter_dead(p
, PATH_FAILURE_RESOURCES
);
494 static bool path_check_good(Path
*p
, bool initial
) {
500 LIST_FOREACH(spec
, s
, p
->specs
) {
501 good
= path_spec_check_good(s
, initial
);
510 static void path_enter_waiting(Path
*p
, bool initial
, bool recheck
) {
514 if (path_check_good(p
, initial
)) {
515 log_unit_debug(UNIT(p
), "Got triggered.");
516 path_enter_running(p
);
524 /* Hmm, so now we have created inotify watches, but the file
525 * might have appeared/been removed by now, so we must
529 if (path_check_good(p
, false)) {
530 log_unit_debug(UNIT(p
), "Got triggered.");
531 path_enter_running(p
);
535 path_set_state(p
, PATH_WAITING
);
539 log_unit_warning_errno(UNIT(p
), r
, "Failed to enter waiting state: %m");
540 path_enter_dead(p
, PATH_FAILURE_RESOURCES
);
543 static void path_mkdir(Path
*p
) {
548 if (!p
->make_directory
)
551 LIST_FOREACH(spec
, s
, p
->specs
)
552 path_spec_mkdir(s
, p
->directory_mode
);
555 static int path_start(Unit
*u
) {
559 assert(p
->state
== PATH_DEAD
|| p
->state
== PATH_FAILED
);
561 if (UNIT_TRIGGER(u
)->load_state
!= UNIT_LOADED
)
566 p
->result
= PATH_SUCCESS
;
567 path_enter_waiting(p
, true, true);
572 static int path_stop(Unit
*u
) {
576 assert(p
->state
== PATH_WAITING
|| p
->state
== PATH_RUNNING
);
578 path_enter_dead(p
, PATH_SUCCESS
);
582 static int path_serialize(Unit
*u
, FILE *f
, FDSet
*fds
) {
589 unit_serialize_item(u
, f
, "state", path_state_to_string(p
->state
));
590 unit_serialize_item(u
, f
, "result", path_result_to_string(p
->result
));
595 static int path_deserialize_item(Unit
*u
, const char *key
, const char *value
, FDSet
*fds
) {
603 if (streq(key
, "state")) {
606 state
= path_state_from_string(value
);
608 log_unit_debug(u
, "Failed to parse state value: %s", value
);
610 p
->deserialized_state
= state
;
612 } else if (streq(key
, "result")) {
615 f
= path_result_from_string(value
);
617 log_unit_debug(u
, "Failed to parse result value: %s", value
);
618 else if (f
!= PATH_SUCCESS
)
622 log_unit_debug(u
, "Unknown serialization key: %s", key
);
627 _pure_
static UnitActiveState
path_active_state(Unit
*u
) {
630 return state_translation_table
[PATH(u
)->state
];
633 _pure_
static const char *path_sub_state_to_string(Unit
*u
) {
636 return path_state_to_string(PATH(u
)->state
);
639 static int path_dispatch_io(sd_event_source
*source
, int fd
, uint32_t revents
, void *userdata
) {
640 PathSpec
*s
= userdata
;
650 if (p
->state
!= PATH_WAITING
&&
651 p
->state
!= PATH_RUNNING
)
654 /* log_debug("inotify wakeup on %s.", u->id); */
656 LIST_FOREACH(spec
, s
, p
->specs
)
657 if (path_spec_owns_inotify_fd(s
, fd
))
661 log_error("Got event on unknown fd.");
665 changed
= path_spec_fd_event(s
, revents
);
669 /* If we are already running, then remember that one event was
670 * dispatched so that we restart the service only if something
671 * actually changed on disk */
672 p
->inotify_triggered
= true;
675 path_enter_running(p
);
677 path_enter_waiting(p
, false, true);
682 path_enter_dead(p
, PATH_FAILURE_RESOURCES
);
686 static void path_trigger_notify(Unit
*u
, Unit
*other
) {
692 /* Invoked whenever the unit we trigger changes state or gains
695 if (other
->load_state
!= UNIT_LOADED
)
698 if (p
->state
== PATH_RUNNING
&&
699 UNIT_IS_INACTIVE_OR_FAILED(unit_active_state(other
))) {
700 log_unit_debug(UNIT(p
), "Got notified about unit deactivation.");
702 /* Hmm, so inotify was triggered since the
703 * last activation, so I guess we need to
704 * recheck what is going on. */
705 path_enter_waiting(p
, false, p
->inotify_triggered
);
709 static void path_reset_failed(Unit
*u
) {
714 if (p
->state
== PATH_FAILED
)
715 path_set_state(p
, PATH_DEAD
);
717 p
->result
= PATH_SUCCESS
;
720 static const char* const path_type_table
[_PATH_TYPE_MAX
] = {
721 [PATH_EXISTS
] = "PathExists",
722 [PATH_EXISTS_GLOB
] = "PathExistsGlob",
723 [PATH_DIRECTORY_NOT_EMPTY
] = "DirectoryNotEmpty",
724 [PATH_CHANGED
] = "PathChanged",
725 [PATH_MODIFIED
] = "PathModified",
728 DEFINE_STRING_TABLE_LOOKUP(path_type
, PathType
);
730 static const char* const path_result_table
[_PATH_RESULT_MAX
] = {
731 [PATH_SUCCESS
] = "success",
732 [PATH_FAILURE_RESOURCES
] = "resources",
735 DEFINE_STRING_TABLE_LOOKUP(path_result
, PathResult
);
737 const UnitVTable path_vtable
= {
738 .object_size
= sizeof(Path
),
749 .coldplug
= path_coldplug
,
756 .serialize
= path_serialize
,
757 .deserialize_item
= path_deserialize_item
,
759 .active_state
= path_active_state
,
760 .sub_state_to_string
= path_sub_state_to_string
,
762 .trigger_notify
= path_trigger_notify
,
764 .reset_failed
= path_reset_failed
,
766 .bus_vtable
= bus_path_vtable