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"
32 #include "glob-util.h"
37 #include "stat-util.h"
38 #include "string-table.h"
39 #include "string-util.h"
40 #include "unit-name.h"
43 static const UnitActiveState state_translation_table
[_PATH_STATE_MAX
] = {
44 [PATH_DEAD
] = UNIT_INACTIVE
,
45 [PATH_WAITING
] = UNIT_ACTIVE
,
46 [PATH_RUNNING
] = UNIT_ACTIVE
,
47 [PATH_FAILED
] = UNIT_FAILED
50 static int path_dispatch_io(sd_event_source
*source
, int fd
, uint32_t revents
, void *userdata
);
52 int path_spec_watch(PathSpec
*s
, sd_event_io_handler_t handler
) {
54 static const int flags_table
[_PATH_TYPE_MAX
] = {
55 [PATH_EXISTS
] = IN_DELETE_SELF
|IN_MOVE_SELF
|IN_ATTRIB
,
56 [PATH_EXISTS_GLOB
] = IN_DELETE_SELF
|IN_MOVE_SELF
|IN_ATTRIB
,
57 [PATH_CHANGED
] = IN_DELETE_SELF
|IN_MOVE_SELF
|IN_ATTRIB
|IN_CLOSE_WRITE
|IN_CREATE
|IN_DELETE
|IN_MOVED_FROM
|IN_MOVED_TO
,
58 [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
,
59 [PATH_DIRECTORY_NOT_EMPTY
] = IN_DELETE_SELF
|IN_MOVE_SELF
|IN_ATTRIB
|IN_CREATE
|IN_MOVED_TO
63 char *slash
, *oldslash
= NULL
;
72 s
->inotify_fd
= inotify_init1(IN_NONBLOCK
|IN_CLOEXEC
);
73 if (s
->inotify_fd
< 0) {
78 r
= sd_event_add_io(s
->unit
->manager
->event
, &s
->event_source
, s
->inotify_fd
, EPOLLIN
, handler
, s
);
82 (void) sd_event_source_set_description(s
->event_source
, "path");
84 /* This assumes the path was passed through path_kill_slashes()! */
86 for (slash
= strchr(s
->path
, '/'); ; slash
= strchr(slash
+1, '/')) {
92 cut
= slash
+ (slash
== s
->path
);
96 flags
= IN_MOVE_SELF
| IN_DELETE_SELF
| IN_ATTRIB
| IN_CREATE
| IN_MOVED_TO
;
98 flags
= flags_table
[s
->type
];
100 r
= inotify_add_watch(s
->inotify_fd
, s
->path
, flags
);
102 if (errno
== EACCES
|| errno
== ENOENT
) {
108 r
= log_warning_errno(errno
, "Failed to add watch on %s: %s", s
->path
, errno
== ENOSPC
? "too many watches" : strerror(-r
));
115 /* Path exists, we don't need to watch parent
118 char *cut2
= oldslash
+ (oldslash
== s
->path
);
122 inotify_add_watch(s
->inotify_fd
, s
->path
, IN_MOVE_SELF
);
123 /* Error is ignored, the worst can happen is
124 we get spurious events. */
136 /* whole path has been iterated over */
143 r
= log_error_errno(errno
, "Failed to add watch on any of the components of %s: %m", s
->path
);
144 /* either EACCESS or ENOENT */
151 path_spec_unwatch(s
);
155 void path_spec_unwatch(PathSpec
*s
) {
158 s
->event_source
= sd_event_source_unref(s
->event_source
);
159 s
->inotify_fd
= safe_close(s
->inotify_fd
);
162 int path_spec_fd_event(PathSpec
*s
, uint32_t revents
) {
163 union inotify_event_buffer buffer
;
164 struct inotify_event
*e
;
168 if (revents
!= EPOLLIN
) {
169 log_error("Got invalid poll event on inotify.");
173 l
= read(s
->inotify_fd
, &buffer
, sizeof(buffer
));
175 if (errno
== EAGAIN
|| errno
== EINTR
)
178 return log_error_errno(errno
, "Failed to read inotify event: %m");
181 FOREACH_INOTIFY_EVENT(e
, buffer
, l
) {
182 if ((s
->type
== PATH_CHANGED
|| s
->type
== PATH_MODIFIED
) &&
183 s
->primary_wd
== e
->wd
)
190 static bool path_spec_check_good(PathSpec
*s
, bool initial
) {
196 good
= access(s
->path
, F_OK
) >= 0;
199 case PATH_EXISTS_GLOB
:
200 good
= glob_exists(s
->path
) > 0;
203 case PATH_DIRECTORY_NOT_EMPTY
: {
206 k
= dir_is_empty(s
->path
);
207 good
= !(k
== -ENOENT
|| k
> 0);
212 case PATH_MODIFIED
: {
215 b
= access(s
->path
, F_OK
) >= 0;
216 good
= !initial
&& b
!= s
->previous_exists
;
217 s
->previous_exists
= b
;
228 static void path_spec_mkdir(PathSpec
*s
, mode_t mode
) {
231 if (s
->type
== PATH_EXISTS
|| s
->type
== PATH_EXISTS_GLOB
)
234 r
= mkdir_p_label(s
->path
, mode
);
236 log_warning_errno(r
, "mkdir(%s) failed: %m", s
->path
);
239 static void path_spec_dump(PathSpec
*s
, FILE *f
, const char *prefix
) {
243 path_type_to_string(s
->type
),
247 void path_spec_done(PathSpec
*s
) {
249 assert(s
->inotify_fd
== -1);
254 static void path_init(Unit
*u
) {
258 assert(u
->load_state
== UNIT_STUB
);
260 p
->directory_mode
= 0755;
263 void path_free_specs(Path
*p
) {
268 while ((s
= p
->specs
)) {
269 path_spec_unwatch(s
);
270 LIST_REMOVE(spec
, p
->specs
, s
);
276 static void path_done(Unit
*u
) {
284 static int path_add_mount_links(Path
*p
) {
290 LIST_FOREACH(spec
, s
, p
->specs
) {
291 r
= unit_require_mounts_for(UNIT(p
), s
->path
);
299 static int path_verify(Path
*p
) {
302 if (UNIT(p
)->load_state
!= UNIT_LOADED
)
306 log_unit_error(UNIT(p
), "Path unit lacks path setting. Refusing.");
313 static int path_add_default_dependencies(Path
*p
) {
318 r
= unit_add_dependency_by_name(UNIT(p
), UNIT_BEFORE
,
319 SPECIAL_PATHS_TARGET
, NULL
, true);
323 if (UNIT(p
)->manager
->running_as
== MANAGER_SYSTEM
) {
324 r
= unit_add_two_dependencies_by_name(UNIT(p
), UNIT_AFTER
, UNIT_REQUIRES
,
325 SPECIAL_SYSINIT_TARGET
, NULL
, true);
330 return unit_add_two_dependencies_by_name(UNIT(p
), UNIT_BEFORE
, UNIT_CONFLICTS
,
331 SPECIAL_SHUTDOWN_TARGET
, NULL
, true);
334 static int path_load(Unit
*u
) {
339 assert(u
->load_state
== UNIT_STUB
);
341 r
= unit_load_fragment_and_dropin(u
);
345 if (u
->load_state
== UNIT_LOADED
) {
347 if (set_isempty(u
->dependencies
[UNIT_TRIGGERS
])) {
350 r
= unit_load_related_unit(u
, ".service", &x
);
354 r
= unit_add_two_dependencies(u
, UNIT_BEFORE
, UNIT_TRIGGERS
, x
, true);
359 r
= path_add_mount_links(p
);
363 if (UNIT(p
)->default_dependencies
) {
364 r
= path_add_default_dependencies(p
);
370 return path_verify(p
);
373 static void path_dump(Unit
*u
, FILE *f
, const char *prefix
) {
381 trigger
= UNIT_TRIGGER(u
);
387 "%sMakeDirectory: %s\n"
388 "%sDirectoryMode: %04o\n",
389 prefix
, path_state_to_string(p
->state
),
390 prefix
, path_result_to_string(p
->result
),
391 prefix
, trigger
? trigger
->id
: "n/a",
392 prefix
, yes_no(p
->make_directory
),
393 prefix
, p
->directory_mode
);
395 LIST_FOREACH(spec
, s
, p
->specs
)
396 path_spec_dump(s
, f
, prefix
);
399 static void path_unwatch(Path
*p
) {
404 LIST_FOREACH(spec
, s
, p
->specs
)
405 path_spec_unwatch(s
);
408 static int path_watch(Path
*p
) {
414 LIST_FOREACH(spec
, s
, p
->specs
) {
415 r
= path_spec_watch(s
, path_dispatch_io
);
423 static void path_set_state(Path
*p
, PathState state
) {
427 old_state
= p
->state
;
430 if (state
!= PATH_WAITING
&&
431 (state
!= PATH_RUNNING
|| p
->inotify_triggered
))
434 if (state
!= old_state
)
435 log_unit_debug(UNIT(p
), "Changed %s -> %s", path_state_to_string(old_state
), path_state_to_string(state
));
437 unit_notify(UNIT(p
), state_translation_table
[old_state
], state_translation_table
[state
], true);
440 static void path_enter_waiting(Path
*p
, bool initial
, bool recheck
);
442 static int path_coldplug(Unit
*u
) {
446 assert(p
->state
== PATH_DEAD
);
448 if (p
->deserialized_state
!= p
->state
) {
450 if (p
->deserialized_state
== PATH_WAITING
||
451 p
->deserialized_state
== PATH_RUNNING
)
452 path_enter_waiting(p
, true, true);
454 path_set_state(p
, p
->deserialized_state
);
460 static void path_enter_dead(Path
*p
, PathResult f
) {
463 if (f
!= PATH_SUCCESS
)
466 path_set_state(p
, p
->result
!= PATH_SUCCESS
? PATH_FAILED
: PATH_DEAD
);
469 static void path_enter_running(Path
*p
) {
470 _cleanup_bus_error_free_ sd_bus_error error
= SD_BUS_ERROR_NULL
;
475 /* Don't start job if we are supposed to go down */
476 if (unit_stop_pending(UNIT(p
)))
479 r
= manager_add_job(UNIT(p
)->manager
, JOB_START
, UNIT_TRIGGER(UNIT(p
)),
480 JOB_REPLACE
, true, &error
, NULL
);
484 p
->inotify_triggered
= false;
490 path_set_state(p
, PATH_RUNNING
);
494 log_unit_warning(UNIT(p
), "Failed to queue unit startup job: %s", bus_error_message(&error
, r
));
495 path_enter_dead(p
, PATH_FAILURE_RESOURCES
);
498 static bool path_check_good(Path
*p
, bool initial
) {
504 LIST_FOREACH(spec
, s
, p
->specs
) {
505 good
= path_spec_check_good(s
, initial
);
514 static void path_enter_waiting(Path
*p
, bool initial
, bool recheck
) {
518 if (path_check_good(p
, initial
)) {
519 log_unit_debug(UNIT(p
), "Got triggered.");
520 path_enter_running(p
);
528 /* Hmm, so now we have created inotify watches, but the file
529 * might have appeared/been removed by now, so we must
533 if (path_check_good(p
, false)) {
534 log_unit_debug(UNIT(p
), "Got triggered.");
535 path_enter_running(p
);
539 path_set_state(p
, PATH_WAITING
);
543 log_unit_warning_errno(UNIT(p
), r
, "Failed to enter waiting state: %m");
544 path_enter_dead(p
, PATH_FAILURE_RESOURCES
);
547 static void path_mkdir(Path
*p
) {
552 if (!p
->make_directory
)
555 LIST_FOREACH(spec
, s
, p
->specs
)
556 path_spec_mkdir(s
, p
->directory_mode
);
559 static int path_start(Unit
*u
) {
563 assert(p
->state
== PATH_DEAD
|| p
->state
== PATH_FAILED
);
565 if (UNIT_TRIGGER(u
)->load_state
!= UNIT_LOADED
)
570 p
->result
= PATH_SUCCESS
;
571 path_enter_waiting(p
, true, true);
576 static int path_stop(Unit
*u
) {
580 assert(p
->state
== PATH_WAITING
|| p
->state
== PATH_RUNNING
);
582 path_enter_dead(p
, PATH_SUCCESS
);
586 static int path_serialize(Unit
*u
, FILE *f
, FDSet
*fds
) {
593 unit_serialize_item(u
, f
, "state", path_state_to_string(p
->state
));
594 unit_serialize_item(u
, f
, "result", path_result_to_string(p
->result
));
599 static int path_deserialize_item(Unit
*u
, const char *key
, const char *value
, FDSet
*fds
) {
607 if (streq(key
, "state")) {
610 state
= path_state_from_string(value
);
612 log_unit_debug(u
, "Failed to parse state value: %s", value
);
614 p
->deserialized_state
= state
;
616 } else if (streq(key
, "result")) {
619 f
= path_result_from_string(value
);
621 log_unit_debug(u
, "Failed to parse result value: %s", value
);
622 else if (f
!= PATH_SUCCESS
)
626 log_unit_debug(u
, "Unknown serialization key: %s", key
);
631 _pure_
static UnitActiveState
path_active_state(Unit
*u
) {
634 return state_translation_table
[PATH(u
)->state
];
637 _pure_
static const char *path_sub_state_to_string(Unit
*u
) {
640 return path_state_to_string(PATH(u
)->state
);
643 static int path_dispatch_io(sd_event_source
*source
, int fd
, uint32_t revents
, void *userdata
) {
644 PathSpec
*s
= userdata
;
654 if (p
->state
!= PATH_WAITING
&&
655 p
->state
!= PATH_RUNNING
)
658 /* log_debug("inotify wakeup on %s.", u->id); */
660 LIST_FOREACH(spec
, s
, p
->specs
)
661 if (path_spec_owns_inotify_fd(s
, fd
))
665 log_error("Got event on unknown fd.");
669 changed
= path_spec_fd_event(s
, revents
);
673 /* If we are already running, then remember that one event was
674 * dispatched so that we restart the service only if something
675 * actually changed on disk */
676 p
->inotify_triggered
= true;
679 path_enter_running(p
);
681 path_enter_waiting(p
, false, true);
686 path_enter_dead(p
, PATH_FAILURE_RESOURCES
);
690 static void path_trigger_notify(Unit
*u
, Unit
*other
) {
696 /* Invoked whenever the unit we trigger changes state or gains
699 if (other
->load_state
!= UNIT_LOADED
)
702 if (p
->state
== PATH_RUNNING
&&
703 UNIT_IS_INACTIVE_OR_FAILED(unit_active_state(other
))) {
704 log_unit_debug(UNIT(p
), "Got notified about unit deactivation.");
706 /* Hmm, so inotify was triggered since the
707 * last activation, so I guess we need to
708 * recheck what is going on. */
709 path_enter_waiting(p
, false, p
->inotify_triggered
);
713 static void path_reset_failed(Unit
*u
) {
718 if (p
->state
== PATH_FAILED
)
719 path_set_state(p
, PATH_DEAD
);
721 p
->result
= PATH_SUCCESS
;
724 static const char* const path_type_table
[_PATH_TYPE_MAX
] = {
725 [PATH_EXISTS
] = "PathExists",
726 [PATH_EXISTS_GLOB
] = "PathExistsGlob",
727 [PATH_DIRECTORY_NOT_EMPTY
] = "DirectoryNotEmpty",
728 [PATH_CHANGED
] = "PathChanged",
729 [PATH_MODIFIED
] = "PathModified",
732 DEFINE_STRING_TABLE_LOOKUP(path_type
, PathType
);
734 static const char* const path_result_table
[_PATH_RESULT_MAX
] = {
735 [PATH_SUCCESS
] = "success",
736 [PATH_FAILURE_RESOURCES
] = "resources",
739 DEFINE_STRING_TABLE_LOOKUP(path_result
, PathResult
);
741 const UnitVTable path_vtable
= {
742 .object_size
= sizeof(Path
),
753 .coldplug
= path_coldplug
,
760 .serialize
= path_serialize
,
761 .deserialize_item
= path_deserialize_item
,
763 .active_state
= path_active_state
,
764 .sub_state_to_string
= path_sub_state_to_string
,
766 .trigger_notify
= path_trigger_notify
,
768 .reset_failed
= path_reset_failed
,
770 .bus_vtable
= bus_path_vtable