1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
4 This file is part of systemd.
6 Copyright 2010 Lennart Poettering, Kay Sievers
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/>.
37 #include <sys/types.h>
38 #include <sys/param.h>
48 /* This reads all files listed in /etc/tmpfiles.d/?*.conf and creates
49 * them in the file system. This is intended to be used to create
50 * properly owned directories beneath /tmp, /var/tmp, /var/run and
51 * /var/lock which are volatile and hence need to be recreated on
55 /* These ones take file names */
58 CREATE_DIRECTORY
= 'd',
59 TRUNCATE_DIRECTORY
= 'D',
61 /* These ones take globs */
64 RECURSIVE_REMOVE_PATH
= 'R'
82 static Hashmap
*items
= NULL
, *globs
= NULL
;
83 static Set
*unix_sockets
= NULL
;
85 static bool arg_create
= false;
86 static bool arg_clean
= false;
87 static bool arg_remove
= false;
89 static const char *arg_prefix
= NULL
;
93 static bool needs_glob(int t
) {
94 return t
== IGNORE_PATH
|| t
== REMOVE_PATH
|| t
== RECURSIVE_REMOVE_PATH
;
97 static struct Item
* find_glob(Hashmap
*h
, const char *match
) {
101 HASHMAP_FOREACH(j
, h
, i
)
102 if (fnmatch(j
->path
, match
, FNM_PATHNAME
|FNM_PERIOD
) == 0)
108 static void load_unix_sockets(void) {
115 /* We maintain a cache of the sockets we found in
116 * /proc/net/unix to speed things up a little. */
118 if (!(unix_sockets
= set_new(string_hash_func
, string_compare_func
)))
121 if (!(f
= fopen("/proc/net/unix", "re")))
124 if (!(fgets(line
, sizeof(line
), f
)))
131 if (!(fgets(line
, sizeof(line
), f
)))
136 if (strlen(line
) < 53)
140 p
+= strspn(p
, WHITESPACE
);
141 p
+= strcspn(p
, WHITESPACE
);
142 p
+= strspn(p
, WHITESPACE
);
147 if (!(s
= strdup(p
)))
150 path_kill_slashes(s
);
152 if ((k
= set_put(unix_sockets
, s
)) < 0) {
163 set_free_free(unix_sockets
);
170 static bool unix_socket_alive(const char *fn
) {
176 return !!set_get(unix_sockets
, (char*) fn
);
178 /* We don't know, so assume yes */
182 static int dir_cleanup(
185 const struct stat
*ds
,
192 struct timespec times
[2];
193 bool deleted
= false;
194 char *sub_path
= NULL
;
197 while ((dent
= readdir(d
))) {
201 if (streq(dent
->d_name
, ".") ||
202 streq(dent
->d_name
, ".."))
205 if (fstatat(dirfd(d
), dent
->d_name
, &s
, AT_SYMLINK_NOFOLLOW
) < 0) {
207 if (errno
!= ENOENT
) {
208 log_error("stat(%s/%s) failed: %m", p
, dent
->d_name
);
215 /* Stay on the same filesystem */
216 if (s
.st_dev
!= rootdev
)
219 /* Do not delete read-only files owned by root */
220 if (s
.st_uid
== 0 && !(s
.st_mode
& S_IWUSR
))
226 if (asprintf(&sub_path
, "%s/%s", p
, dent
->d_name
) < 0) {
227 log_error("Out of memory");
232 /* Is there an item configured for this path? */
233 if (hashmap_get(items
, sub_path
))
236 if (find_glob(globs
, sub_path
))
239 if (S_ISDIR(s
.st_mode
)) {
242 streq(dent
->d_name
, "lost+found") &&
247 log_warning("Reached max depth on %s.", sub_path
);
252 sub_dir
= xopendirat(dirfd(d
), dent
->d_name
, O_NOFOLLOW
);
253 if (sub_dir
== NULL
) {
254 if (errno
!= ENOENT
) {
255 log_error("opendir(%s/%s) failed: %m", p
, dent
->d_name
);
262 q
= dir_cleanup(sub_path
, sub_dir
, &s
, cutoff
, rootdev
, false, maxdepth
-1);
269 /* Ignore ctime, we change it when deleting */
270 age
= MAX(timespec_load(&s
.st_mtim
),
271 timespec_load(&s
.st_atim
));
275 log_debug("rmdir '%s'\n", sub_path
);
277 if (unlinkat(dirfd(d
), dent
->d_name
, AT_REMOVEDIR
) < 0) {
278 if (errno
!= ENOENT
&& errno
!= ENOTEMPTY
) {
279 log_error("rmdir(%s): %m", sub_path
);
285 /* Skip files for which the sticky bit is
286 * set. These are semantics we define, and are
287 * unknown elsewhere. See XDG_RUNTIME_DIR
288 * specification for details. */
289 if (s
.st_mode
& S_ISVTX
)
292 if (mountpoint
&& S_ISREG(s
.st_mode
)) {
293 if (streq(dent
->d_name
, ".journal") &&
297 if (streq(dent
->d_name
, "aquota.user") ||
298 streq(dent
->d_name
, "aquota.group"))
302 /* Ignore sockets that are listed in /proc/net/unix */
303 if (S_ISSOCK(s
.st_mode
) && unix_socket_alive(sub_path
))
306 /* Ignore device nodes */
307 if (S_ISCHR(s
.st_mode
) || S_ISBLK(s
.st_mode
))
310 age
= MAX3(timespec_load(&s
.st_mtim
),
311 timespec_load(&s
.st_atim
),
312 timespec_load(&s
.st_ctim
));
317 log_debug("unlink '%s'\n", sub_path
);
319 if (unlinkat(dirfd(d
), dent
->d_name
, 0) < 0) {
320 if (errno
!= ENOENT
) {
321 log_error("unlink(%s): %m", sub_path
);
332 /* Restore original directory timestamps */
333 times
[0] = ds
->st_atim
;
334 times
[1] = ds
->st_mtim
;
336 if (futimens(dirfd(d
), times
) < 0)
337 log_error("utimensat(%s): %m", p
);
345 static int clean_item(Item
*i
) {
354 if (i
->type
!= CREATE_DIRECTORY
&&
355 i
->type
!= TRUNCATE_DIRECTORY
&&
356 i
->type
!= IGNORE_PATH
)
359 if (!i
->age_set
|| i
->age
<= 0)
362 n
= now(CLOCK_REALTIME
);
368 d
= opendir(i
->path
);
373 log_error("Failed to open directory %s: %m", i
->path
);
377 if (fstat(dirfd(d
), &s
) < 0) {
378 log_error("stat(%s) failed: %m", i
->path
);
383 if (!S_ISDIR(s
.st_mode
)) {
384 log_error("%s is not a directory.", i
->path
);
389 if (fstatat(dirfd(d
), "..", &ps
, AT_SYMLINK_NOFOLLOW
) != 0) {
390 log_error("stat(%s/..) failed: %m", i
->path
);
395 mountpoint
= s
.st_dev
!= ps
.st_dev
||
396 (s
.st_dev
== ps
.st_dev
&& s
.st_ino
== ps
.st_ino
);
398 r
= dir_cleanup(i
->path
, d
, &s
, cutoff
, s
.st_dev
, mountpoint
, MAX_DEPTH
);
407 static int create_item(Item
*i
) {
418 case RECURSIVE_REMOVE_PATH
:
425 fd
= open(i
->path
, O_CREAT
|O_NDELAY
|O_CLOEXEC
|O_WRONLY
|O_NOCTTY
|O_NOFOLLOW
|
426 (i
->type
== TRUNCATE_FILE
? O_TRUNC
: 0), i
->mode
);
430 log_error("Failed to create file %s: %m", i
->path
);
435 if (fstat(fd
, &st
) < 0) {
436 log_error("stat(%s) failed: %m", i
->path
);
441 if (!S_ISREG(st
.st_mode
)) {
442 log_error("%s is not a file.", i
->path
);
448 if (fchmod(fd
, i
->mode
) < 0) {
449 log_error("chmod(%s) failed: %m", i
->path
);
454 if (i
->uid_set
|| i
->gid_set
)
456 i
->uid_set
? i
->uid
: (uid_t
) -1,
457 i
->gid_set
? i
->gid
: (gid_t
) -1) < 0) {
458 log_error("chown(%s) failed: %m", i
->path
);
465 case TRUNCATE_DIRECTORY
:
466 case CREATE_DIRECTORY
:
469 r
= mkdir(i
->path
, i
->mode
);
472 if (r
< 0 && errno
!= EEXIST
) {
473 log_error("Failed to create directory %s: %m", i
->path
);
478 if (stat(i
->path
, &st
) < 0) {
479 log_error("stat(%s) failed: %m", i
->path
);
484 if (!S_ISDIR(st
.st_mode
)) {
485 log_error("%s is not a directory.", i
->path
);
491 if (chmod(i
->path
, i
->mode
) < 0) {
492 log_error("chmod(%s) failed: %m", i
->path
);
497 if (i
->uid_set
|| i
->gid_set
)
499 i
->uid_set
? i
->uid
: (uid_t
) -1,
500 i
->gid_set
? i
->gid
: (gid_t
) -1) < 0) {
502 log_error("chown(%s) failed: %m", i
->path
);
510 if ((r
= label_fix(i
->path
, false)) < 0)
513 log_debug("%s created successfully.", i
->path
);
517 close_nointr_nofail(fd
);
522 static int remove_item(Item
*i
, const char *instance
) {
531 case CREATE_DIRECTORY
:
536 if (remove(instance
) < 0 && errno
!= ENOENT
) {
537 log_error("remove(%s): %m", instance
);
543 case TRUNCATE_DIRECTORY
:
544 case RECURSIVE_REMOVE_PATH
:
545 if ((r
= rm_rf(instance
, false, i
->type
== RECURSIVE_REMOVE_PATH
)) < 0 &&
547 log_error("rm_rf(%s): %s", instance
, strerror(-r
));
557 static int remove_item_glob(Item
*i
) {
564 case CREATE_DIRECTORY
:
569 case TRUNCATE_DIRECTORY
:
570 case RECURSIVE_REMOVE_PATH
: {
578 if ((k
= glob(i
->path
, GLOB_NOSORT
|GLOB_BRACE
, NULL
, &g
)) != 0) {
580 if (k
!= GLOB_NOMATCH
) {
584 log_error("glob(%s) failed: %m", i
->path
);
589 STRV_FOREACH(fn
, g
.gl_pathv
)
590 if ((k
= remove_item(i
, *fn
)) < 0)
601 static int process_item(Item
*i
) {
606 r
= arg_create
? create_item(i
) : 0;
607 q
= arg_remove
? remove_item_glob(i
) : 0;
608 p
= arg_clean
? clean_item(i
) : 0;
619 static void item_free(Item
*i
) {
626 static int parse_line(const char *fname
, unsigned line
, const char *buffer
) {
628 char *mode
= NULL
, *user
= NULL
, *group
= NULL
, *age
= NULL
;
635 if (!(i
= new0(Item
, 1))) {
636 log_error("Out of memory");
653 log_error("[%s:%u] Syntax error.", fname
, line
);
658 if (i
->type
!= CREATE_FILE
&&
659 i
->type
!= TRUNCATE_FILE
&&
660 i
->type
!= CREATE_DIRECTORY
&&
661 i
->type
!= TRUNCATE_DIRECTORY
&&
662 i
->type
!= IGNORE_PATH
&&
663 i
->type
!= REMOVE_PATH
&&
664 i
->type
!= RECURSIVE_REMOVE_PATH
) {
665 log_error("[%s:%u] Unknown file type '%c'.", fname
, line
, i
->type
);
670 if (!path_is_absolute(i
->path
)) {
671 log_error("[%s:%u] Path '%s' not absolute.", fname
, line
, i
->path
);
676 path_kill_slashes(i
->path
);
678 if (arg_prefix
&& !path_startswith(i
->path
, arg_prefix
)) {
683 if (user
&& !streq(user
, "-")) {
687 if (streq(user
, "root") || streq(user
, "0"))
689 else if (safe_atolu(user
, &lu
) >= 0)
691 else if ((p
= getpwnam(user
)))
694 log_error("[%s:%u] Unknown user '%s'.", fname
, line
, user
);
702 if (group
&& !streq(group
, "-")) {
706 if (streq(group
, "root") || streq(group
, "0"))
708 else if (safe_atolu(group
, &lu
) >= 0)
710 else if ((g
= getgrnam(group
)))
713 log_error("[%s:%u] Unknown group '%s'.", fname
, line
, group
);
721 if (mode
&& !streq(mode
, "-")) {
724 if (sscanf(mode
, "%o", &m
) != 1) {
725 log_error("[%s:%u] Invalid mode '%s'.", fname
, line
, mode
);
733 i
->mode
= i
->type
== CREATE_DIRECTORY
? 0755 : 0644;
735 if (age
&& !streq(age
, "-")) {
736 if (parse_usec(age
, &i
->age
) < 0) {
737 log_error("[%s:%u] Invalid age '%s'.", fname
, line
, age
);
745 if ((r
= hashmap_put(needs_glob(i
->type
) ? globs
: items
, i
->path
, i
)) < 0) {
747 log_warning("Two or more conflicting lines for %s configured, ignoring.", i
->path
);
752 log_error("Failed to insert item %s: %s", i
->path
, strerror(-r
));
771 static int scandir_filter(const struct dirent
*d
) {
774 if (ignore_file(d
->d_name
))
777 if (d
->d_type
!= DT_REG
&&
781 return endswith(d
->d_name
, ".conf");
784 static int help(void) {
786 printf("%s [OPTIONS...] [CONFIGURATION FILE...]\n\n"
787 "Creates, deletes and cleans up volatile and temporary files and directories.\n\n"
788 " -h --help Show this help\n"
789 " --create Create marked files/directories\n"
790 " --clean Clean up marked directories\n"
791 " --remove Remove marked files/directories\n"
792 " --prefix=PATH Only apply rules that apply to paths with the specified prefix\n",
793 program_invocation_short_name
);
798 static int parse_argv(int argc
, char *argv
[]) {
807 static const struct option options
[] = {
808 { "help", no_argument
, NULL
, 'h' },
809 { "create", no_argument
, NULL
, ARG_CREATE
},
810 { "clean", no_argument
, NULL
, ARG_CLEAN
},
811 { "remove", no_argument
, NULL
, ARG_REMOVE
},
812 { "prefix", required_argument
, NULL
, ARG_PREFIX
},
821 while ((c
= getopt_long(argc
, argv
, "h", options
, NULL
)) >= 0) {
849 log_error("Unknown option code %c", c
);
854 if (!arg_clean
&& !arg_create
&& !arg_remove
) {
855 log_error("You need to specify at least one of --clean, --create or --remove.");
862 static int read_config_file(const char *fn
, bool ignore_enoent
) {
869 if (!(f
= fopen(fn
, "re"))) {
871 if (ignore_enoent
&& errno
== ENOENT
)
874 log_error("Failed to open %s: %m", fn
);
879 char line
[LINE_MAX
], *l
;
882 if (!(fgets(line
, sizeof(line
), f
)))
888 if (*l
== '#' || *l
== 0)
891 if ((k
= parse_line(fn
, v
, l
)) < 0)
897 log_error("Failed to read from file %s: %m", fn
);
907 int main(int argc
, char *argv
[]) {
912 if ((r
= parse_argv(argc
, argv
)) <= 0)
913 return r
< 0 ? EXIT_FAILURE
: EXIT_SUCCESS
;
915 log_set_target(LOG_TARGET_AUTO
);
916 log_parse_environment();
921 items
= hashmap_new(string_hash_func
, string_compare_func
);
922 globs
= hashmap_new(string_hash_func
, string_compare_func
);
924 if (!items
|| !globs
) {
925 log_error("Out of memory");
935 for (j
= optind
; j
< argc
; j
++)
936 if (read_config_file(argv
[j
], false) < 0)
941 struct dirent
**de
= NULL
;
943 if ((n
= scandir("/etc/tmpfiles.d/", &de
, scandir_filter
, alphasort
)) < 0) {
945 if (errno
!= ENOENT
) {
946 log_error("Failed to enumerate /etc/tmpfiles.d/ files: %m");
953 for (j
= 0; j
< n
; j
++) {
957 k
= asprintf(&fn
, "/etc/tmpfiles.d/%s", de
[j
]->d_name
);
961 log_error("Failed to allocate file name.");
966 if (read_config_file(fn
, true) < 0)
975 HASHMAP_FOREACH(i
, globs
, iterator
)
976 if (process_item(i
) < 0)
979 HASHMAP_FOREACH(i
, items
, iterator
)
980 if (process_item(i
) < 0)
984 while ((i
= hashmap_steal_first(items
)))
987 while ((i
= hashmap_steal_first(globs
)))
993 set_free_free(unix_sockets
);