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 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.
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.
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/>.
22 #include <sys/inotify.h>
23 #include <sys/epoll.h>
24 #include <sys/ioctl.h>
29 #include "unit-name.h"
31 #include "dbus-path.h"
33 #include "bus-errors.h"
35 static const UnitActiveState state_translation_table
[_PATH_STATE_MAX
] = {
36 [PATH_DEAD
] = UNIT_INACTIVE
,
37 [PATH_WAITING
] = UNIT_ACTIVE
,
38 [PATH_RUNNING
] = UNIT_ACTIVE
,
39 [PATH_FAILED
] = UNIT_FAILED
42 static void path_init(Unit
*u
) {
46 assert(u
->meta
.load_state
== UNIT_STUB
);
48 p
->directory_mode
= 0755;
51 static void path_unwatch_one(Path
*p
, PathSpec
*s
) {
53 if (s
->inotify_fd
< 0)
56 unit_unwatch_fd(UNIT(p
), &s
->watch
);
58 close_nointr_nofail(s
->inotify_fd
);
62 static void path_done(Unit
*u
) {
68 while ((s
= p
->specs
)) {
69 path_unwatch_one(p
, s
);
70 LIST_REMOVE(PathSpec
, spec
, p
->specs
, s
);
76 int path_add_one_mount_link(Path
*p
, Mount
*m
) {
83 if (p
->meta
.load_state
!= UNIT_LOADED
||
84 m
->meta
.load_state
!= UNIT_LOADED
)
87 LIST_FOREACH(spec
, s
, p
->specs
) {
89 if (!path_startswith(s
->path
, m
->where
))
92 if ((r
= unit_add_two_dependencies(UNIT(p
), UNIT_AFTER
, UNIT_REQUIRES
, UNIT(m
), true)) < 0)
99 static int path_add_mount_links(Path
*p
) {
105 LIST_FOREACH(units_by_type
, other
, p
->meta
.manager
->units_by_type
[UNIT_MOUNT
])
106 if ((r
= path_add_one_mount_link(p
, (Mount
*) other
)) < 0)
112 static int path_verify(Path
*p
) {
115 if (p
->meta
.load_state
!= UNIT_LOADED
)
119 log_error("%s lacks path setting. Refusing.", p
->meta
.id
);
126 static int path_add_default_dependencies(Path
*p
) {
131 if (p
->meta
.manager
->running_as
== MANAGER_SYSTEM
) {
132 if ((r
= unit_add_dependency_by_name(UNIT(p
), UNIT_BEFORE
, SPECIAL_BASIC_TARGET
, NULL
, true)) < 0)
135 if ((r
= unit_add_two_dependencies_by_name(UNIT(p
), UNIT_AFTER
, UNIT_REQUIRES
, SPECIAL_SYSINIT_TARGET
, NULL
, true)) < 0)
139 return unit_add_two_dependencies_by_name(UNIT(p
), UNIT_BEFORE
, UNIT_CONFLICTS
, SPECIAL_SHUTDOWN_TARGET
, NULL
, true);
142 static int path_load(Unit
*u
) {
147 assert(u
->meta
.load_state
== UNIT_STUB
);
149 if ((r
= unit_load_fragment_and_dropin(u
)) < 0)
152 if (u
->meta
.load_state
== UNIT_LOADED
) {
155 if ((r
= unit_load_related_unit(u
, ".service", &p
->unit
)))
158 if ((r
= unit_add_dependency(u
, UNIT_BEFORE
, p
->unit
, true)) < 0)
161 if ((r
= path_add_mount_links(p
)) < 0)
164 if (p
->meta
.default_dependencies
)
165 if ((r
= path_add_default_dependencies(p
)) < 0)
169 return path_verify(p
);
172 static void path_dump(Unit
*u
, FILE *f
, const char *prefix
) {
182 "%sMakeDirectory: %s\n"
183 "%sDirectoryMode: %04o\n",
184 prefix
, path_state_to_string(p
->state
),
185 prefix
, p
->unit
->meta
.id
,
186 prefix
, yes_no(p
->make_directory
),
187 prefix
, p
->directory_mode
);
189 LIST_FOREACH(spec
, s
, p
->specs
)
193 path_type_to_string(s
->type
),
197 static int path_watch_one(Path
*p
, PathSpec
*s
) {
198 static const int flags_table
[_PATH_TYPE_MAX
] = {
199 [PATH_EXISTS
] = IN_DELETE_SELF
|IN_MOVE_SELF
|IN_ATTRIB
,
200 [PATH_EXISTS_GLOB
] = IN_DELETE_SELF
|IN_MOVE_SELF
|IN_ATTRIB
,
201 [PATH_CHANGED
] = IN_DELETE_SELF
|IN_MOVE_SELF
|IN_ATTRIB
|IN_CLOSE_WRITE
|IN_CREATE
|IN_DELETE
|IN_MOVED_FROM
|IN_MOVED_TO
,
202 [PATH_DIRECTORY_NOT_EMPTY
] = IN_DELETE_SELF
|IN_MOVE_SELF
|IN_ATTRIB
|IN_CREATE
|IN_MOVED_TO
212 path_unwatch_one(p
, s
);
214 if (!(k
= strdup(s
->path
)))
217 if ((s
->inotify_fd
= inotify_init1(IN_NONBLOCK
|IN_CLOEXEC
)) < 0) {
222 if (unit_watch_fd(UNIT(p
), s
->inotify_fd
, EPOLLIN
, &s
->watch
) < 0) {
227 if ((s
->primary_wd
= inotify_add_watch(s
->inotify_fd
, k
, flags_table
[s
->type
])) >= 0)
233 /* This assumes the path was passed through path_kill_slashes()! */
234 if (!(slash
= strrchr(k
, '/')))
237 /* Trim the path at the last slash. Keep the slash if it's the root dir. */
238 slash
[slash
== k
] = 0;
240 flags
= IN_MOVE_SELF
;
242 flags
|= IN_DELETE_SELF
| IN_ATTRIB
| IN_CREATE
| IN_MOVED_TO
;
244 if (inotify_add_watch(s
->inotify_fd
, k
, flags
) >= 0)
246 } while (slash
!= k
);
253 path_unwatch_one(p
, s
);
257 static void path_unwatch(Path
*p
) {
262 LIST_FOREACH(spec
, s
, p
->specs
)
263 path_unwatch_one(p
, s
);
266 static int path_watch(Path
*p
) {
272 LIST_FOREACH(spec
, s
, p
->specs
)
273 if ((r
= path_watch_one(p
, s
)) < 0)
279 static void path_set_state(Path
*p
, PathState state
) {
283 old_state
= p
->state
;
286 if (state
!= PATH_WAITING
&&
287 (state
!= PATH_RUNNING
|| p
->inotify_triggered
))
290 if (state
!= old_state
)
291 log_debug("%s changed %s -> %s",
293 path_state_to_string(old_state
),
294 path_state_to_string(state
));
296 unit_notify(UNIT(p
), state_translation_table
[old_state
], state_translation_table
[state
], true);
299 static void path_enter_waiting(Path
*p
, bool initial
, bool recheck
);
301 static int path_coldplug(Unit
*u
) {
305 assert(p
->state
== PATH_DEAD
);
307 if (p
->deserialized_state
!= p
->state
) {
309 if (p
->deserialized_state
== PATH_WAITING
||
310 p
->deserialized_state
== PATH_RUNNING
)
311 path_enter_waiting(p
, true, true);
313 path_set_state(p
, p
->deserialized_state
);
319 static void path_enter_dead(Path
*p
, bool success
) {
325 path_set_state(p
, p
->failure
? PATH_FAILED
: PATH_DEAD
);
328 static void path_enter_running(Path
*p
) {
333 dbus_error_init(&error
);
335 /* Don't start job if we are supposed to go down */
336 if (p
->meta
.job
&& p
->meta
.job
->type
== JOB_STOP
)
339 if ((r
= manager_add_job(p
->meta
.manager
, JOB_START
, p
->unit
, JOB_REPLACE
, true, &error
, NULL
)) < 0)
342 p
->inotify_triggered
= false;
344 if ((r
= path_watch(p
)) < 0)
347 path_set_state(p
, PATH_RUNNING
);
351 log_warning("%s failed to queue unit startup job: %s", p
->meta
.id
, bus_error(&error
, r
));
352 path_enter_dead(p
, false);
354 dbus_error_free(&error
);
357 static bool path_check_good(Path
*p
, bool initial
) {
363 LIST_FOREACH(spec
, s
, p
->specs
) {
368 good
= access(s
->path
, F_OK
) >= 0;
371 case PATH_EXISTS_GLOB
:
372 good
= glob_exists(s
->path
) > 0;
375 case PATH_DIRECTORY_NOT_EMPTY
: {
378 k
= dir_is_empty(s
->path
);
379 good
= !(k
== -ENOENT
|| k
> 0);
386 b
= access(s
->path
, F_OK
) >= 0;
387 good
= !initial
&& b
!= s
->previous_exists
;
388 s
->previous_exists
= b
;
403 static void path_enter_waiting(Path
*p
, bool initial
, bool recheck
) {
407 if (path_check_good(p
, initial
)) {
408 log_debug("%s got triggered.", p
->meta
.id
);
409 path_enter_running(p
);
413 if ((r
= path_watch(p
)) < 0)
416 /* Hmm, so now we have created inotify watches, but the file
417 * might have appeared/been removed by now, so we must
421 if (path_check_good(p
, false)) {
422 log_debug("%s got triggered.", p
->meta
.id
);
423 path_enter_running(p
);
427 path_set_state(p
, PATH_WAITING
);
431 log_warning("%s failed to enter waiting state: %s", p
->meta
.id
, strerror(-r
));
432 path_enter_dead(p
, false);
435 static void path_mkdir(Path
*p
) {
440 if (!p
->make_directory
)
443 LIST_FOREACH(spec
, s
, p
->specs
) {
446 if (s
->type
== PATH_EXISTS
|| s
->type
== PATH_EXISTS_GLOB
)
449 if ((r
= mkdir_p(s
->path
, p
->directory_mode
)) < 0)
450 log_warning("mkdir(%s) failed: %s", s
->path
, strerror(-r
));
454 static int path_start(Unit
*u
) {
458 assert(p
->state
== PATH_DEAD
|| p
->state
== PATH_FAILED
);
460 if (p
->unit
->meta
.load_state
!= UNIT_LOADED
)
466 path_enter_waiting(p
, true, true);
471 static int path_stop(Unit
*u
) {
475 assert(p
->state
== PATH_WAITING
|| p
->state
== PATH_RUNNING
);
477 path_enter_dead(p
, true);
481 static int path_serialize(Unit
*u
, FILE *f
, FDSet
*fds
) {
488 unit_serialize_item(u
, f
, "state", path_state_to_string(p
->state
));
493 static int path_deserialize_item(Unit
*u
, const char *key
, const char *value
, FDSet
*fds
) {
501 if (streq(key
, "state")) {
504 if ((state
= path_state_from_string(value
)) < 0)
505 log_debug("Failed to parse state value %s", value
);
507 p
->deserialized_state
= state
;
509 log_debug("Unknown serialization key '%s'", key
);
514 static UnitActiveState
path_active_state(Unit
*u
) {
517 return state_translation_table
[PATH(u
)->state
];
520 static const char *path_sub_state_to_string(Unit
*u
) {
523 return path_state_to_string(PATH(u
)->state
);
526 static void path_fd_event(Unit
*u
, int fd
, uint32_t events
, Watch
*w
) {
531 struct inotify_event
*e
;
538 if (p
->state
!= PATH_WAITING
&&
539 p
->state
!= PATH_RUNNING
)
542 /* log_debug("inotify wakeup on %s.", u->meta.id); */
544 if (events
!= EPOLLIN
) {
545 log_error("Got Invalid poll event on inotify.");
549 LIST_FOREACH(spec
, s
, p
->specs
)
550 if (s
->inotify_fd
== fd
)
554 log_error("Got event on unknown fd.");
558 if (ioctl(fd
, FIONREAD
, &l
) < 0) {
559 log_error("FIONREAD failed: %s", strerror(errno
));
565 if (!(buf
= malloc(l
))) {
566 log_error("Failed to allocate buffer: %s", strerror(-ENOMEM
));
570 if ((k
= read(fd
, buf
, l
)) < 0) {
571 log_error("Failed to read inotify event: %s", strerror(-errno
));
575 /* If we are already running, then remember that one event was
576 * dispatched so that we restart the service only if something
577 * actually changed on disk */
578 p
->inotify_triggered
= true;
580 e
= (struct inotify_event
*) buf
;
586 if (s
->type
== PATH_CHANGED
&& s
->primary_wd
== e
->wd
)
589 step
= sizeof(struct inotify_event
) + e
->len
;
590 assert(step
<= (size_t) k
);
592 e
= (struct inotify_event
*) ((uint8_t*) e
+ step
);
597 path_enter_running(p
);
599 path_enter_waiting(p
, false, true);
607 path_enter_dead(p
, false);
610 void path_unit_notify(Unit
*u
, UnitActiveState new_state
) {
615 if (u
->meta
.type
== UNIT_PATH
)
618 SET_FOREACH(n
, u
->meta
.names
, i
) {
623 if (!(k
= unit_name_change_suffix(n
, ".path"))) {
628 t
= manager_get_unit(u
->meta
.manager
, k
);
634 if (t
->meta
.load_state
!= UNIT_LOADED
)
642 if (p
->state
== PATH_RUNNING
&& new_state
== UNIT_INACTIVE
) {
643 log_debug("%s got notified about unit deactivation.", p
->meta
.id
);
645 /* Hmm, so inotify was triggered since the
646 * last activation, so I guess we need to
647 * recheck what is going on. */
648 path_enter_waiting(p
, false, p
->inotify_triggered
);
655 log_error("Failed find path unit: %s", strerror(-r
));
658 static void path_reset_failed(Unit
*u
) {
663 if (p
->state
== PATH_FAILED
)
664 path_set_state(p
, PATH_DEAD
);
669 static const char* const path_state_table
[_PATH_STATE_MAX
] = {
670 [PATH_DEAD
] = "dead",
671 [PATH_WAITING
] = "waiting",
672 [PATH_RUNNING
] = "running",
673 [PATH_FAILED
] = "failed"
676 DEFINE_STRING_TABLE_LOOKUP(path_state
, PathState
);
678 static const char* const path_type_table
[_PATH_TYPE_MAX
] = {
679 [PATH_EXISTS
] = "PathExists",
680 [PATH_EXISTS_GLOB
] = "PathExistsGlob",
681 [PATH_CHANGED
] = "PathChanged",
682 [PATH_DIRECTORY_NOT_EMPTY
] = "DirectoryNotEmpty"
685 DEFINE_STRING_TABLE_LOOKUP(path_type
, PathType
);
687 const UnitVTable path_vtable
= {
698 .coldplug
= path_coldplug
,
705 .serialize
= path_serialize
,
706 .deserialize_item
= path_deserialize_item
,
708 .active_state
= path_active_state
,
709 .sub_state_to_string
= path_sub_state_to_string
,
711 .fd_event
= path_fd_event
,
713 .reset_failed
= path_reset_failed
,
715 .bus_interface
= "org.freedesktop.systemd1.Path",
716 .bus_message_handler
= bus_path_message_handler