1 /* SPDX-License-Identifier: LGPL-2.1+ */
3 This file is part of systemd.
5 Copyright 2010 Lennart Poettering
7 systemd is free software; you can redistribute it and/or modify it
8 under the terms of the GNU Lesser General Public License as published by
9 the Free Software Foundation; either version 2.1 of the License, or
10 (at your option) any later version.
12 systemd is distributed in the hope that it will be useful, but
13 WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 Lesser General Public License for more details.
17 You should have received a copy of the GNU Lesser General Public License
18 along with systemd; If not, see <http://www.gnu.org/licenses/>.
22 #include <sys/epoll.h>
23 #include <sys/inotify.h>
26 #include "bus-error.h"
28 #include "dbus-path.h"
31 #include "glob-util.h"
36 #include "stat-util.h"
37 #include "string-table.h"
38 #include "string-util.h"
39 #include "unit-name.h"
42 static const UnitActiveState state_translation_table
[_PATH_STATE_MAX
] = {
43 [PATH_DEAD
] = UNIT_INACTIVE
,
44 [PATH_WAITING
] = UNIT_ACTIVE
,
45 [PATH_RUNNING
] = UNIT_ACTIVE
,
46 [PATH_FAILED
] = UNIT_FAILED
49 static int path_dispatch_io(sd_event_source
*source
, int fd
, uint32_t revents
, void *userdata
);
51 int path_spec_watch(PathSpec
*s
, sd_event_io_handler_t handler
) {
53 static const int flags_table
[_PATH_TYPE_MAX
] = {
54 [PATH_EXISTS
] = IN_DELETE_SELF
|IN_MOVE_SELF
|IN_ATTRIB
,
55 [PATH_EXISTS_GLOB
] = IN_DELETE_SELF
|IN_MOVE_SELF
|IN_ATTRIB
,
56 [PATH_CHANGED
] = IN_DELETE_SELF
|IN_MOVE_SELF
|IN_ATTRIB
|IN_CLOSE_WRITE
|IN_CREATE
|IN_DELETE
|IN_MOVED_FROM
|IN_MOVED_TO
,
57 [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
,
58 [PATH_DIRECTORY_NOT_EMPTY
] = IN_DELETE_SELF
|IN_MOVE_SELF
|IN_ATTRIB
|IN_CREATE
|IN_MOVED_TO
62 char *slash
, *oldslash
= NULL
;
71 s
->inotify_fd
= inotify_init1(IN_NONBLOCK
|IN_CLOEXEC
);
72 if (s
->inotify_fd
< 0) {
77 r
= sd_event_add_io(s
->unit
->manager
->event
, &s
->event_source
, s
->inotify_fd
, EPOLLIN
, handler
, s
);
81 (void) sd_event_source_set_description(s
->event_source
, "path");
83 /* This assumes the path was passed through path_kill_slashes()! */
85 for (slash
= strchr(s
->path
, '/'); ; slash
= strchr(slash
+1, '/')) {
91 cut
= slash
+ (slash
== s
->path
);
95 flags
= IN_MOVE_SELF
| IN_DELETE_SELF
| IN_ATTRIB
| IN_CREATE
| IN_MOVED_TO
;
97 flags
= flags_table
[s
->type
];
99 r
= inotify_add_watch(s
->inotify_fd
, s
->path
, flags
);
101 if (IN_SET(errno
, EACCES
, ENOENT
)) {
107 r
= log_warning_errno(errno
, "Failed to add watch on %s: %s", s
->path
, errno
== ENOSPC
? "too many watches" : strerror(-r
));
114 /* Path exists, we don't need to watch parent too closely. */
116 char *cut2
= oldslash
+ (oldslash
== s
->path
);
120 (void) inotify_add_watch(s
->inotify_fd
, s
->path
, IN_MOVE_SELF
);
121 /* Error is ignored, the worst can happen is we get spurious events. */
133 /* whole path has been iterated over */
140 r
= log_error_errno(errno
, "Failed to add watch on any of the components of %s: %m", s
->path
);
141 /* either EACCESS or ENOENT */
148 path_spec_unwatch(s
);
152 void path_spec_unwatch(PathSpec
*s
) {
155 s
->event_source
= sd_event_source_unref(s
->event_source
);
156 s
->inotify_fd
= safe_close(s
->inotify_fd
);
159 int path_spec_fd_event(PathSpec
*s
, uint32_t revents
) {
160 union inotify_event_buffer buffer
;
161 struct inotify_event
*e
;
165 if (revents
!= EPOLLIN
) {
166 log_error("Got invalid poll event on inotify.");
170 l
= read(s
->inotify_fd
, &buffer
, sizeof(buffer
));
172 if (IN_SET(errno
, EAGAIN
, EINTR
))
175 return log_error_errno(errno
, "Failed to read inotify event: %m");
178 FOREACH_INOTIFY_EVENT(e
, buffer
, l
) {
179 if (IN_SET(s
->type
, PATH_CHANGED
, PATH_MODIFIED
) &&
180 s
->primary_wd
== e
->wd
)
187 static bool path_spec_check_good(PathSpec
*s
, bool initial
) {
193 good
= access(s
->path
, F_OK
) >= 0;
196 case PATH_EXISTS_GLOB
:
197 good
= glob_exists(s
->path
) > 0;
200 case PATH_DIRECTORY_NOT_EMPTY
: {
203 k
= dir_is_empty(s
->path
);
204 good
= !(k
== -ENOENT
|| k
> 0);
209 case PATH_MODIFIED
: {
212 b
= access(s
->path
, F_OK
) >= 0;
213 good
= !initial
&& b
!= s
->previous_exists
;
214 s
->previous_exists
= b
;
225 static void path_spec_mkdir(PathSpec
*s
, mode_t mode
) {
228 if (IN_SET(s
->type
, PATH_EXISTS
, PATH_EXISTS_GLOB
))
231 r
= mkdir_p_label(s
->path
, mode
);
233 log_warning_errno(r
, "mkdir(%s) failed: %m", s
->path
);
236 static void path_spec_dump(PathSpec
*s
, FILE *f
, const char *prefix
) {
240 path_type_to_string(s
->type
),
244 void path_spec_done(PathSpec
*s
) {
246 assert(s
->inotify_fd
== -1);
251 static void path_init(Unit
*u
) {
255 assert(u
->load_state
== UNIT_STUB
);
257 p
->directory_mode
= 0755;
260 void path_free_specs(Path
*p
) {
265 while ((s
= p
->specs
)) {
266 path_spec_unwatch(s
);
267 LIST_REMOVE(spec
, p
->specs
, s
);
273 static void path_done(Unit
*u
) {
281 static int path_add_mount_dependencies(Path
*p
) {
287 LIST_FOREACH(spec
, s
, p
->specs
) {
288 r
= unit_require_mounts_for(UNIT(p
), s
->path
, UNIT_DEPENDENCY_FILE
);
296 static int path_verify(Path
*p
) {
299 if (UNIT(p
)->load_state
!= UNIT_LOADED
)
303 log_unit_error(UNIT(p
), "Path unit lacks path setting. Refusing.");
310 static int path_add_default_dependencies(Path
*p
) {
315 if (!UNIT(p
)->default_dependencies
)
318 r
= unit_add_dependency_by_name(UNIT(p
), UNIT_BEFORE
, SPECIAL_PATHS_TARGET
, NULL
, true, UNIT_DEPENDENCY_DEFAULT
);
322 if (MANAGER_IS_SYSTEM(UNIT(p
)->manager
)) {
323 r
= unit_add_two_dependencies_by_name(UNIT(p
), UNIT_AFTER
, UNIT_REQUIRES
, SPECIAL_SYSINIT_TARGET
, NULL
, true, UNIT_DEPENDENCY_DEFAULT
);
328 return unit_add_two_dependencies_by_name(UNIT(p
), UNIT_BEFORE
, UNIT_CONFLICTS
, SPECIAL_SHUTDOWN_TARGET
, NULL
, true, UNIT_DEPENDENCY_DEFAULT
);
331 static int path_add_trigger_dependencies(Path
*p
) {
337 if (!hashmap_isempty(UNIT(p
)->dependencies
[UNIT_TRIGGERS
]))
340 r
= unit_load_related_unit(UNIT(p
), ".service", &x
);
344 return unit_add_two_dependencies(UNIT(p
), UNIT_BEFORE
, UNIT_TRIGGERS
, x
, true, UNIT_DEPENDENCY_IMPLICIT
);
347 static int path_load(Unit
*u
) {
352 assert(u
->load_state
== UNIT_STUB
);
354 r
= unit_load_fragment_and_dropin(u
);
358 if (u
->load_state
== UNIT_LOADED
) {
360 r
= path_add_trigger_dependencies(p
);
364 r
= path_add_mount_dependencies(p
);
368 r
= path_add_default_dependencies(p
);
373 return path_verify(p
);
376 static void path_dump(Unit
*u
, FILE *f
, const char *prefix
) {
384 trigger
= UNIT_TRIGGER(u
);
390 "%sMakeDirectory: %s\n"
391 "%sDirectoryMode: %04o\n",
392 prefix
, path_state_to_string(p
->state
),
393 prefix
, path_result_to_string(p
->result
),
394 prefix
, trigger
? trigger
->id
: "n/a",
395 prefix
, yes_no(p
->make_directory
),
396 prefix
, p
->directory_mode
);
398 LIST_FOREACH(spec
, s
, p
->specs
)
399 path_spec_dump(s
, f
, prefix
);
402 static void path_unwatch(Path
*p
) {
407 LIST_FOREACH(spec
, s
, p
->specs
)
408 path_spec_unwatch(s
);
411 static int path_watch(Path
*p
) {
417 LIST_FOREACH(spec
, s
, p
->specs
) {
418 r
= path_spec_watch(s
, path_dispatch_io
);
426 static void path_set_state(Path
*p
, PathState state
) {
430 old_state
= p
->state
;
433 if (state
!= PATH_WAITING
&&
434 (state
!= PATH_RUNNING
|| p
->inotify_triggered
))
437 if (state
!= old_state
)
438 log_unit_debug(UNIT(p
), "Changed %s -> %s", path_state_to_string(old_state
), path_state_to_string(state
));
440 unit_notify(UNIT(p
), state_translation_table
[old_state
], state_translation_table
[state
], true);
443 static void path_enter_waiting(Path
*p
, bool initial
, bool recheck
);
445 static int path_coldplug(Unit
*u
) {
449 assert(p
->state
== PATH_DEAD
);
451 if (p
->deserialized_state
!= p
->state
) {
453 if (IN_SET(p
->deserialized_state
, PATH_WAITING
, PATH_RUNNING
))
454 path_enter_waiting(p
, true, true);
456 path_set_state(p
, p
->deserialized_state
);
462 static void path_enter_dead(Path
*p
, PathResult f
) {
465 if (p
->result
== PATH_SUCCESS
)
468 if (p
->result
!= PATH_SUCCESS
)
469 log_unit_warning(UNIT(p
), "Failed with result '%s'.", path_result_to_string(p
->result
));
471 path_set_state(p
, p
->result
!= PATH_SUCCESS
? PATH_FAILED
: PATH_DEAD
);
474 static void path_enter_running(Path
*p
) {
475 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
481 /* Don't start job if we are supposed to go down */
482 if (unit_stop_pending(UNIT(p
)))
485 trigger
= UNIT_TRIGGER(UNIT(p
));
487 log_unit_error(UNIT(p
), "Unit to trigger vanished.");
488 path_enter_dead(p
, PATH_FAILURE_RESOURCES
);
492 r
= manager_add_job(UNIT(p
)->manager
, JOB_START
, trigger
, JOB_REPLACE
, &error
, NULL
);
496 p
->inotify_triggered
= false;
502 path_set_state(p
, PATH_RUNNING
);
506 log_unit_warning(UNIT(p
), "Failed to queue unit startup job: %s", bus_error_message(&error
, r
));
507 path_enter_dead(p
, PATH_FAILURE_RESOURCES
);
510 static bool path_check_good(Path
*p
, bool initial
) {
516 LIST_FOREACH(spec
, s
, p
->specs
) {
517 good
= path_spec_check_good(s
, initial
);
526 static void path_enter_waiting(Path
*p
, bool initial
, bool recheck
) {
530 if (path_check_good(p
, initial
)) {
531 log_unit_debug(UNIT(p
), "Got triggered.");
532 path_enter_running(p
);
540 /* Hmm, so now we have created inotify watches, but the file
541 * might have appeared/been removed by now, so we must
545 if (path_check_good(p
, false)) {
546 log_unit_debug(UNIT(p
), "Got triggered.");
547 path_enter_running(p
);
551 path_set_state(p
, PATH_WAITING
);
555 log_unit_warning_errno(UNIT(p
), r
, "Failed to enter waiting state: %m");
556 path_enter_dead(p
, PATH_FAILURE_RESOURCES
);
559 static void path_mkdir(Path
*p
) {
564 if (!p
->make_directory
)
567 LIST_FOREACH(spec
, s
, p
->specs
)
568 path_spec_mkdir(s
, p
->directory_mode
);
571 static int path_start(Unit
*u
) {
577 assert(IN_SET(p
->state
, PATH_DEAD
, PATH_FAILED
));
579 trigger
= UNIT_TRIGGER(u
);
580 if (!trigger
|| trigger
->load_state
!= UNIT_LOADED
) {
581 log_unit_error(u
, "Refusing to start, unit to trigger not loaded.");
585 r
= unit_start_limit_test(u
);
587 path_enter_dead(p
, PATH_FAILURE_START_LIMIT_HIT
);
591 r
= unit_acquire_invocation_id(u
);
597 p
->result
= PATH_SUCCESS
;
598 path_enter_waiting(p
, true, true);
603 static int path_stop(Unit
*u
) {
607 assert(IN_SET(p
->state
, PATH_WAITING
, PATH_RUNNING
));
609 path_enter_dead(p
, PATH_SUCCESS
);
613 static int path_serialize(Unit
*u
, FILE *f
, FDSet
*fds
) {
620 unit_serialize_item(u
, f
, "state", path_state_to_string(p
->state
));
621 unit_serialize_item(u
, f
, "result", path_result_to_string(p
->result
));
626 static int path_deserialize_item(Unit
*u
, const char *key
, const char *value
, FDSet
*fds
) {
634 if (streq(key
, "state")) {
637 state
= path_state_from_string(value
);
639 log_unit_debug(u
, "Failed to parse state value: %s", value
);
641 p
->deserialized_state
= state
;
643 } else if (streq(key
, "result")) {
646 f
= path_result_from_string(value
);
648 log_unit_debug(u
, "Failed to parse result value: %s", value
);
649 else if (f
!= PATH_SUCCESS
)
653 log_unit_debug(u
, "Unknown serialization key: %s", key
);
658 _pure_
static UnitActiveState
path_active_state(Unit
*u
) {
661 return state_translation_table
[PATH(u
)->state
];
664 _pure_
static const char *path_sub_state_to_string(Unit
*u
) {
667 return path_state_to_string(PATH(u
)->state
);
670 static int path_dispatch_io(sd_event_source
*source
, int fd
, uint32_t revents
, void *userdata
) {
671 PathSpec
*s
= userdata
;
681 if (!IN_SET(p
->state
, PATH_WAITING
, PATH_RUNNING
))
684 /* log_debug("inotify wakeup on %s.", u->id); */
686 LIST_FOREACH(spec
, s
, p
->specs
)
687 if (path_spec_owns_inotify_fd(s
, fd
))
691 log_error("Got event on unknown fd.");
695 changed
= path_spec_fd_event(s
, revents
);
699 /* If we are already running, then remember that one event was
700 * dispatched so that we restart the service only if something
701 * actually changed on disk */
702 p
->inotify_triggered
= true;
705 path_enter_running(p
);
707 path_enter_waiting(p
, false, true);
712 path_enter_dead(p
, PATH_FAILURE_RESOURCES
);
716 static void path_trigger_notify(Unit
*u
, Unit
*other
) {
722 /* Invoked whenever the unit we trigger changes state or gains
725 if (other
->load_state
!= UNIT_LOADED
)
728 if (p
->state
== PATH_RUNNING
&&
729 UNIT_IS_INACTIVE_OR_FAILED(unit_active_state(other
))) {
730 log_unit_debug(UNIT(p
), "Got notified about unit deactivation.");
732 /* Hmm, so inotify was triggered since the
733 * last activation, so I guess we need to
734 * recheck what is going on. */
735 path_enter_waiting(p
, false, p
->inotify_triggered
);
739 static void path_reset_failed(Unit
*u
) {
744 if (p
->state
== PATH_FAILED
)
745 path_set_state(p
, PATH_DEAD
);
747 p
->result
= PATH_SUCCESS
;
750 static const char* const path_type_table
[_PATH_TYPE_MAX
] = {
751 [PATH_EXISTS
] = "PathExists",
752 [PATH_EXISTS_GLOB
] = "PathExistsGlob",
753 [PATH_DIRECTORY_NOT_EMPTY
] = "DirectoryNotEmpty",
754 [PATH_CHANGED
] = "PathChanged",
755 [PATH_MODIFIED
] = "PathModified",
758 DEFINE_STRING_TABLE_LOOKUP(path_type
, PathType
);
760 static const char* const path_result_table
[_PATH_RESULT_MAX
] = {
761 [PATH_SUCCESS
] = "success",
762 [PATH_FAILURE_RESOURCES
] = "resources",
763 [PATH_FAILURE_START_LIMIT_HIT
] = "start-limit-hit",
766 DEFINE_STRING_TABLE_LOOKUP(path_result
, PathResult
);
768 const UnitVTable path_vtable
= {
769 .object_size
= sizeof(Path
),
780 .coldplug
= path_coldplug
,
787 .serialize
= path_serialize
,
788 .deserialize_item
= path_deserialize_item
,
790 .active_state
= path_active_state
,
791 .sub_state_to_string
= path_sub_state_to_string
,
793 .trigger_notify
= path_trigger_notify
,
795 .reset_failed
= path_reset_failed
,
797 .bus_vtable
= bus_path_vtable