1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
13 #include <sys/xattr.h>
21 #include "alloc-util.h"
22 #include "btrfs-util.h"
23 #include "capability-util.h"
24 #include "chase-symlinks.h"
25 #include "chattr-util.h"
26 #include "conf-files.h"
29 #include "dirent-util.h"
30 #include "dissect-image.h"
35 #include "format-util.h"
37 #include "glob-util.h"
42 #include "main-func.h"
43 #include "missing_stat.h"
44 #include "missing_syscall.h"
45 #include "mkdir-label.h"
46 #include "mount-util.h"
47 #include "mountpoint-util.h"
48 #include "offline-passwd.h"
50 #include "parse-argument.h"
51 #include "parse-util.h"
52 #include "path-lookup.h"
53 #include "path-util.h"
54 #include "pretty-print.h"
55 #include "rlimit-util.h"
57 #include "selinux-util.h"
59 #include "sort-util.h"
60 #include "specifier.h"
61 #include "stat-util.h"
62 #include "stdio-util.h"
63 #include "string-table.h"
64 #include "string-util.h"
66 #include "terminal-util.h"
67 #include "umask-util.h"
68 #include "user-util.h"
70 /* This reads all files listed in /etc/tmpfiles.d/?*.conf and creates
71 * them in the file system. This is intended to be used to create
72 * properly owned directories beneath /tmp, /var/tmp, /run, which are
73 * volatile and hence need to be recreated on bootup. */
75 typedef enum OperationMask
{
76 OPERATION_CREATE
= 1 << 0,
77 OPERATION_REMOVE
= 1 << 1,
78 OPERATION_CLEAN
= 1 << 2,
81 typedef enum ItemType
{
82 /* These ones take file names */
84 TRUNCATE_FILE
= 'F', /* deprecated: use f+ */
85 CREATE_DIRECTORY
= 'd',
86 TRUNCATE_DIRECTORY
= 'D',
87 CREATE_SUBVOLUME
= 'v',
88 CREATE_SUBVOLUME_INHERIT_QUOTA
= 'q',
89 CREATE_SUBVOLUME_NEW_QUOTA
= 'Q',
92 CREATE_CHAR_DEVICE
= 'c',
93 CREATE_BLOCK_DEVICE
= 'b',
96 /* These ones take globs */
98 EMPTY_DIRECTORY
= 'e',
100 RECURSIVE_SET_XATTR
= 'T',
102 RECURSIVE_SET_ACL
= 'A',
104 RECURSIVE_SET_ATTRIBUTE
= 'H',
106 IGNORE_DIRECTORY_PATH
= 'X',
108 RECURSIVE_REMOVE_PATH
= 'R',
110 RECURSIVE_RELABEL_PATH
= 'Z',
111 ADJUST_MODE
= 'm', /* legacy, 'z' is identical to this */
115 AGE_BY_ATIME
= 1 << 0,
116 AGE_BY_BTIME
= 1 << 1,
117 AGE_BY_CTIME
= 1 << 2,
118 AGE_BY_MTIME
= 1 << 3,
120 /* All file timestamp types are checked by default. */
121 AGE_BY_DEFAULT_FILE
= AGE_BY_ATIME
| AGE_BY_BTIME
| AGE_BY_CTIME
| AGE_BY_MTIME
,
122 AGE_BY_DEFAULT_DIR
= AGE_BY_ATIME
| AGE_BY_BTIME
| AGE_BY_MTIME
125 typedef struct Item
{
139 AgeBy age_by_file
, age_by_dir
;
142 unsigned attribute_value
;
143 unsigned attribute_mask
;
150 bool attribute_set
:1;
152 bool keep_first_level
:1;
154 bool append_or_force
:1;
156 bool allow_failure
:1;
163 typedef struct ItemArray
{
167 struct ItemArray
*parent
;
171 typedef enum DirectoryType
{
179 static bool arg_cat_config
= false;
180 static bool arg_user
= false;
181 static OperationMask arg_operation
= 0;
182 static bool arg_boot
= false;
183 static PagerFlags arg_pager_flags
= 0;
185 static char **arg_include_prefixes
= NULL
;
186 static char **arg_exclude_prefixes
= NULL
;
187 static char *arg_root
= NULL
;
188 static char *arg_image
= NULL
;
189 static char *arg_replace
= NULL
;
191 #define MAX_DEPTH 256
193 static OrderedHashmap
*items
= NULL
, *globs
= NULL
;
194 static Set
*unix_sockets
= NULL
;
196 STATIC_DESTRUCTOR_REGISTER(items
, ordered_hashmap_freep
);
197 STATIC_DESTRUCTOR_REGISTER(globs
, ordered_hashmap_freep
);
198 STATIC_DESTRUCTOR_REGISTER(unix_sockets
, set_freep
);
199 STATIC_DESTRUCTOR_REGISTER(arg_include_prefixes
, freep
);
200 STATIC_DESTRUCTOR_REGISTER(arg_exclude_prefixes
, freep
);
201 STATIC_DESTRUCTOR_REGISTER(arg_root
, freep
);
202 STATIC_DESTRUCTOR_REGISTER(arg_image
, freep
);
204 static int specifier_machine_id_safe(char specifier
, const void *data
, const char *root
, const void *userdata
, char **ret
);
205 static int specifier_directory(char specifier
, const void *data
, const char *root
, const void *userdata
, char **ret
);
207 static const Specifier specifier_table
[] = {
208 { 'a', specifier_architecture
, NULL
},
209 { 'b', specifier_boot_id
, NULL
},
210 { 'B', specifier_os_build_id
, NULL
},
211 { 'H', specifier_host_name
, NULL
},
212 { 'l', specifier_short_host_name
, NULL
},
213 { 'm', specifier_machine_id_safe
, NULL
},
214 { 'o', specifier_os_id
, NULL
},
215 { 'v', specifier_kernel_release
, NULL
},
216 { 'w', specifier_os_version_id
, NULL
},
217 { 'W', specifier_os_variant_id
, NULL
},
219 { 'h', specifier_user_home
, NULL
},
221 { 'C', specifier_directory
, UINT_TO_PTR(DIRECTORY_CACHE
) },
222 { 'L', specifier_directory
, UINT_TO_PTR(DIRECTORY_LOGS
) },
223 { 'S', specifier_directory
, UINT_TO_PTR(DIRECTORY_STATE
) },
224 { 't', specifier_directory
, UINT_TO_PTR(DIRECTORY_RUNTIME
) },
226 COMMON_CREDS_SPECIFIERS
,
228 COMMON_TMP_SPECIFIERS
,
232 static int specifier_machine_id_safe(char specifier
, const void *data
, const char *root
, const void *userdata
, char **ret
) {
235 /* If /etc/machine_id is missing or empty (e.g. in a chroot environment) return a recognizable error
236 * so that the caller can skip the rule gracefully. */
238 r
= specifier_machine_id(specifier
, data
, root
, userdata
, ret
);
239 if (IN_SET(r
, -ENOENT
, -ENOMEDIUM
))
245 static int specifier_directory(char specifier
, const void *data
, const char *root
, const void *userdata
, char **ret
) {
251 static const struct table_entry paths_system
[] = {
252 [DIRECTORY_RUNTIME
] = { SD_PATH_SYSTEM_RUNTIME
},
253 [DIRECTORY_STATE
] = { SD_PATH_SYSTEM_STATE_PRIVATE
},
254 [DIRECTORY_CACHE
] = { SD_PATH_SYSTEM_STATE_CACHE
},
255 [DIRECTORY_LOGS
] = { SD_PATH_SYSTEM_STATE_LOGS
},
258 static const struct table_entry paths_user
[] = {
259 [DIRECTORY_RUNTIME
] = { SD_PATH_USER_RUNTIME
},
260 [DIRECTORY_STATE
] = { SD_PATH_USER_CONFIGURATION
},
261 [DIRECTORY_CACHE
] = { SD_PATH_USER_STATE_CACHE
},
262 [DIRECTORY_LOGS
] = { SD_PATH_USER_CONFIGURATION
, "log" },
265 const struct table_entry
*paths
;
266 _cleanup_free_
char *p
= NULL
;
270 assert_cc(ELEMENTSOF(paths_system
) == ELEMENTSOF(paths_user
));
271 paths
= arg_user
? paths_user
: paths_system
;
273 i
= PTR_TO_UINT(data
);
274 assert(i
< ELEMENTSOF(paths_system
));
276 r
= sd_path_lookup(paths
[i
].type
, paths
[i
].suffix
, &p
);
281 _cleanup_free_
char *j
= NULL
;
283 j
= path_join(arg_root
, p
);
294 static int log_unresolvable_specifier(const char *filename
, unsigned line
) {
295 static bool notified
= false;
297 /* In system mode, this is called when /etc is not fully initialized (e.g.
298 * in a chroot environment) where some specifiers are unresolvable. In user
299 * mode, this is called when some variables are not defined. These cases are
300 * not considered as an error so log at LOG_NOTICE only for the first time
301 * and then downgrade this to LOG_DEBUG for the rest. */
304 notified
? LOG_DEBUG
: LOG_NOTICE
,
306 "Failed to resolve specifier: %s, skipping",
307 arg_user
? "Required $XDG_... variable not defined" : "uninitialized /etc detected");
310 log_notice("All rules containing unresolvable specifiers will be skipped.");
316 static int user_config_paths(char*** ret
) {
317 _cleanup_strv_free_
char **config_dirs
= NULL
, **data_dirs
= NULL
;
318 _cleanup_free_
char *persistent_config
= NULL
, *runtime_config
= NULL
, *data_home
= NULL
;
319 _cleanup_strv_free_
char **res
= NULL
;
322 r
= xdg_user_dirs(&config_dirs
, &data_dirs
);
326 r
= xdg_user_config_dir(&persistent_config
, "/user-tmpfiles.d");
327 if (r
< 0 && r
!= -ENXIO
)
330 r
= xdg_user_runtime_dir(&runtime_config
, "/user-tmpfiles.d");
331 if (r
< 0 && r
!= -ENXIO
)
334 r
= xdg_user_data_dir(&data_home
, "/user-tmpfiles.d");
335 if (r
< 0 && r
!= -ENXIO
)
338 r
= strv_extend_strv_concat(&res
, config_dirs
, "/user-tmpfiles.d");
342 r
= strv_extend(&res
, persistent_config
);
346 r
= strv_extend(&res
, runtime_config
);
350 r
= strv_extend(&res
, data_home
);
354 r
= strv_extend_strv_concat(&res
, data_dirs
, "/user-tmpfiles.d");
358 r
= path_strv_make_absolute_cwd(res
);
362 *ret
= TAKE_PTR(res
);
366 static bool needs_glob(ItemType t
) {
370 IGNORE_DIRECTORY_PATH
,
372 RECURSIVE_REMOVE_PATH
,
376 RECURSIVE_RELABEL_PATH
,
382 RECURSIVE_SET_ATTRIBUTE
);
385 static bool takes_ownership(ItemType t
) {
393 CREATE_SUBVOLUME_INHERIT_QUOTA
,
394 CREATE_SUBVOLUME_NEW_QUOTA
,
402 IGNORE_DIRECTORY_PATH
,
404 RECURSIVE_REMOVE_PATH
);
407 static struct Item
* find_glob(OrderedHashmap
*h
, const char *match
) {
410 ORDERED_HASHMAP_FOREACH(j
, h
) {
413 for (n
= 0; n
< j
->n_items
; n
++) {
414 Item
*item
= j
->items
+ n
;
416 if (fnmatch(item
->path
, match
, FNM_PATHNAME
|FNM_PERIOD
) == 0)
424 static int load_unix_sockets(void) {
425 _cleanup_set_free_ Set
*sockets
= NULL
;
426 _cleanup_fclose_
FILE *f
= NULL
;
432 /* We maintain a cache of the sockets we found in /proc/net/unix to speed things up a little. */
434 f
= fopen("/proc/net/unix", "re");
436 return log_full_errno(errno
== ENOENT
? LOG_DEBUG
: LOG_WARNING
, errno
,
437 "Failed to open /proc/net/unix, ignoring: %m");
440 r
= read_line(f
, LONG_LINE_MAX
, NULL
);
442 return log_warning_errno(r
, "Failed to skip /proc/net/unix header line: %m");
444 return log_warning_errno(SYNTHETIC_ERRNO(EIO
), "Premature end of file reading /proc/net/unix.");
447 _cleanup_free_
char *line
= NULL
;
450 r
= read_line(f
, LONG_LINE_MAX
, &line
);
452 return log_warning_errno(r
, "Failed to read /proc/net/unix line, ignoring: %m");
453 if (r
== 0) /* EOF */
456 p
= strchr(line
, ':');
464 p
+= strspn(p
, WHITESPACE
);
465 p
+= strcspn(p
, WHITESPACE
); /* skip one more word */
466 p
+= strspn(p
, WHITESPACE
);
468 if (!path_is_absolute(p
))
471 r
= set_put_strdup_full(&sockets
, &path_hash_ops_free
, p
);
473 return log_warning_errno(r
, "Failed to add AF_UNIX socket to set, ignoring: %m");
476 unix_sockets
= TAKE_PTR(sockets
);
480 static bool unix_socket_alive(const char *fn
) {
483 if (load_unix_sockets() < 0)
484 return true; /* We don't know, so assume yes */
486 return set_contains(unix_sockets
, fn
);
489 static DIR* xopendirat_nomod(int dirfd
, const char *path
) {
492 dir
= xopendirat(dirfd
, path
, O_NOFOLLOW
|O_NOATIME
);
496 log_debug_errno(errno
, "Cannot open %sdirectory \"%s\": %m", dirfd
== AT_FDCWD
? "" : "sub", path
);
500 dir
= xopendirat(dirfd
, path
, O_NOFOLLOW
);
502 log_debug_errno(errno
, "Cannot open %sdirectory \"%s\": %m", dirfd
== AT_FDCWD
? "" : "sub", path
);
507 static DIR* opendir_nomod(const char *path
) {
508 return xopendirat_nomod(AT_FDCWD
, path
);
511 static inline nsec_t
load_statx_timestamp_nsec(const struct statx_timestamp
*ts
) {
515 return NSEC_INFINITY
;
517 if ((nsec_t
) ts
->tv_sec
>= (UINT64_MAX
- ts
->tv_nsec
) / NSEC_PER_SEC
)
518 return NSEC_INFINITY
;
520 return ts
->tv_sec
* NSEC_PER_SEC
+ ts
->tv_nsec
;
523 static bool needs_cleanup(
529 const char *sub_path
,
533 if (FLAGS_SET(age_by
, AGE_BY_MTIME
) && mtime
!= NSEC_INFINITY
&& mtime
>= cutoff
) {
534 /* Follows spelling in stat(1). */
535 log_debug("%s \"%s\": modify time %s is too new.",
536 is_dir
? "Directory" : "File",
538 FORMAT_TIMESTAMP_STYLE(mtime
/ NSEC_PER_USEC
, TIMESTAMP_US
));
543 if (FLAGS_SET(age_by
, AGE_BY_ATIME
) && atime
!= NSEC_INFINITY
&& atime
>= cutoff
) {
544 log_debug("%s \"%s\": access time %s is too new.",
545 is_dir
? "Directory" : "File",
547 FORMAT_TIMESTAMP_STYLE(atime
/ NSEC_PER_USEC
, TIMESTAMP_US
));
553 * Note: Unless explicitly specified by the user, "ctime" is ignored
554 * by default for directories, because we change it when deleting.
556 if (FLAGS_SET(age_by
, AGE_BY_CTIME
) && ctime
!= NSEC_INFINITY
&& ctime
>= cutoff
) {
557 log_debug("%s \"%s\": change time %s is too new.",
558 is_dir
? "Directory" : "File",
560 FORMAT_TIMESTAMP_STYLE(ctime
/ NSEC_PER_USEC
, TIMESTAMP_US
));
565 if (FLAGS_SET(age_by
, AGE_BY_BTIME
) && btime
!= NSEC_INFINITY
&& btime
>= cutoff
) {
566 log_debug("%s \"%s\": birth time %s is too new.",
567 is_dir
? "Directory" : "File",
569 FORMAT_TIMESTAMP_STYLE(btime
/ NSEC_PER_USEC
, TIMESTAMP_US
));
577 static int dir_cleanup(
581 nsec_t self_atime_nsec
,
582 nsec_t self_mtime_nsec
,
588 bool keep_this_level
,
592 bool deleted
= false;
595 FOREACH_DIRENT_ALL(de
, d
, break) {
596 _cleanup_free_
char *sub_path
= NULL
;
597 nsec_t atime_nsec
, mtime_nsec
, ctime_nsec
, btime_nsec
;
599 if (dot_or_dot_dot(de
->d_name
))
602 /* If statx() is supported, use it. It's preferable over fstatat() since it tells us
603 * explicitly where we are looking at a mount point, for free as side information. Determining
604 * the same information without statx() is hard, see the complexity of path_is_mount_point(),
605 * and also much slower as it requires a number of syscalls instead of just one. Hence, when
606 * we have modern statx() we use it instead of fstat() and do proper mount point checks,
607 * while on older kernels's well do traditional st_dev based detection of mount points.
609 * Using statx() for detecting mount points also has the benfit that we handle weird file
610 * systems such as overlayfs better where each file is originating from a different
613 STRUCT_STATX_DEFINE(sx
);
616 dirfd(d
), de
->d_name
,
617 AT_SYMLINK_NOFOLLOW
|AT_NO_AUTOMOUNT
,
618 STATX_TYPE
|STATX_MODE
|STATX_UID
|STATX_ATIME
|STATX_MTIME
|STATX_CTIME
|STATX_BTIME
,
623 /* FUSE, NFS mounts, SELinux might return EACCES */
624 r
= log_full_errno(errno
== EACCES
? LOG_DEBUG
: LOG_ERR
, errno
,
625 "statx(%s/%s) failed: %m", p
, de
->d_name
);
629 if (FLAGS_SET(sx
.stx_attributes_mask
, STATX_ATTR_MOUNT_ROOT
)) {
630 /* Yay, we have the mount point API, use it */
631 if (FLAGS_SET(sx
.stx_attributes
, STATX_ATTR_MOUNT_ROOT
)) {
632 log_debug("Ignoring \"%s/%s\": different mount points.", p
, de
->d_name
);
636 /* So we might have statx() but the STATX_ATTR_MOUNT_ROOT flag is not supported, fall
637 * back to traditional stx_dev checking. */
638 if (sx
.stx_dev_major
!= rootdev_major
||
639 sx
.stx_dev_minor
!= rootdev_minor
) {
640 log_debug("Ignoring \"%s/%s\": different filesystem.", p
, de
->d_name
);
644 /* Try to detect bind mounts of the same filesystem instance; they do not differ in device
645 * major/minors. This type of query is not supported on all kernels or filesystem types
647 if (S_ISDIR(sx
.stx_mode
)) {
650 q
= fd_is_mount_point(dirfd(d
), de
->d_name
, 0);
652 log_debug_errno(q
, "Failed to determine whether \"%s/%s\" is a mount point, ignoring: %m", p
, de
->d_name
);
654 log_debug("Ignoring \"%s/%s\": different mount of the same filesystem.", p
, de
->d_name
);
660 atime_nsec
= FLAGS_SET(sx
.stx_mask
, STATX_ATIME
) ? load_statx_timestamp_nsec(&sx
.stx_atime
) : 0;
661 mtime_nsec
= FLAGS_SET(sx
.stx_mask
, STATX_MTIME
) ? load_statx_timestamp_nsec(&sx
.stx_mtime
) : 0;
662 ctime_nsec
= FLAGS_SET(sx
.stx_mask
, STATX_CTIME
) ? load_statx_timestamp_nsec(&sx
.stx_ctime
) : 0;
663 btime_nsec
= FLAGS_SET(sx
.stx_mask
, STATX_BTIME
) ? load_statx_timestamp_nsec(&sx
.stx_btime
) : 0;
665 sub_path
= path_join(p
, de
->d_name
);
671 /* Is there an item configured for this path? */
672 if (ordered_hashmap_get(items
, sub_path
)) {
673 log_debug("Ignoring \"%s\": a separate entry exists.", sub_path
);
677 if (find_glob(globs
, sub_path
)) {
678 log_debug("Ignoring \"%s\": a separate glob exists.", sub_path
);
682 if (S_ISDIR(sx
.stx_mode
)) {
683 _cleanup_closedir_
DIR *sub_dir
= NULL
;
686 streq(de
->d_name
, "lost+found") &&
688 log_debug("Ignoring directory \"%s\".", sub_path
);
693 log_warning("Reached max depth on \"%s\".", sub_path
);
697 sub_dir
= xopendirat_nomod(dirfd(d
), de
->d_name
);
700 r
= log_warning_errno(errno
, "Opening directory \"%s\" failed, ignoring: %m", sub_path
);
705 if (flock(dirfd(sub_dir
), LOCK_EX
|LOCK_NB
) < 0) {
706 log_debug_errno(errno
, "Couldn't acquire shared BSD lock on directory \"%s\", skipping: %m", p
);
712 atime_nsec
, mtime_nsec
, cutoff_nsec
,
713 rootdev_major
, rootdev_minor
,
714 false, maxdepth
-1, false,
715 age_by_file
, age_by_dir
);
720 /* Note: if you are wondering why we don't support the sticky bit for excluding
721 * directories from cleaning like we do it for other file system objects: well, the
722 * sticky bit already has a meaning for directories, so we don't want to overload
725 if (keep_this_level
) {
726 log_debug("Keeping directory \"%s\".", sub_path
);
731 * Check the file timestamps of an entry against the
732 * given cutoff time; delete if it is older.
734 if (!needs_cleanup(atime_nsec
, btime_nsec
, ctime_nsec
, mtime_nsec
,
735 cutoff_nsec
, sub_path
, age_by_dir
, true))
738 log_debug("Removing directory \"%s\".", sub_path
);
739 if (unlinkat(dirfd(d
), de
->d_name
, AT_REMOVEDIR
) < 0)
740 if (!IN_SET(errno
, ENOENT
, ENOTEMPTY
))
741 r
= log_warning_errno(errno
, "Failed to remove directory \"%s\", ignoring: %m", sub_path
);
744 /* Skip files for which the sticky bit is set. These are semantics we define, and are
745 * unknown elsewhere. See XDG_RUNTIME_DIR specification for details. */
746 if (sx
.stx_mode
& S_ISVTX
) {
747 log_debug("Skipping \"%s\": sticky bit set.", sub_path
);
752 S_ISREG(sx
.stx_mode
) &&
754 STR_IN_SET(de
->d_name
,
758 log_debug("Skipping \"%s\".", sub_path
);
762 /* Ignore sockets that are listed in /proc/net/unix */
763 if (S_ISSOCK(sx
.stx_mode
) && unix_socket_alive(sub_path
)) {
764 log_debug("Skipping \"%s\": live socket.", sub_path
);
768 /* Ignore device nodes */
769 if (S_ISCHR(sx
.stx_mode
) || S_ISBLK(sx
.stx_mode
)) {
770 log_debug("Skipping \"%s\": a device.", sub_path
);
774 /* Keep files on this level around if this is requested */
775 if (keep_this_level
) {
776 log_debug("Keeping \"%s\".", sub_path
);
780 if (!needs_cleanup(atime_nsec
, btime_nsec
, ctime_nsec
, mtime_nsec
,
781 cutoff_nsec
, sub_path
, age_by_file
, false))
784 log_debug("Removing \"%s\".", sub_path
);
785 if (unlinkat(dirfd(d
), de
->d_name
, 0) < 0)
787 r
= log_warning_errno(errno
, "Failed to remove \"%s\", ignoring: %m", sub_path
);
795 struct timespec ts
[2];
797 log_debug("Restoring access and modification time on \"%s\": %s, %s",
799 FORMAT_TIMESTAMP_STYLE(self_atime_nsec
/ NSEC_PER_USEC
, TIMESTAMP_US
),
800 FORMAT_TIMESTAMP_STYLE(self_mtime_nsec
/ NSEC_PER_USEC
, TIMESTAMP_US
));
802 timespec_store_nsec(ts
+ 0, self_atime_nsec
);
803 timespec_store_nsec(ts
+ 1, self_mtime_nsec
);
805 /* Restore original directory timestamps */
806 if (futimens(dirfd(d
), ts
) < 0)
807 log_warning_errno(errno
, "Failed to revert timestamps of '%s', ignoring: %m", p
);
813 static bool dangerous_hardlinks(void) {
814 _cleanup_free_
char *value
= NULL
;
815 static int cached
= -1;
818 /* Check whether the fs.protected_hardlinks sysctl is on. If we can't determine it we assume its off, as that's
819 * what the upstream default is. */
824 r
= read_one_line_file("/proc/sys/fs/protected_hardlinks", &value
);
826 log_debug_errno(r
, "Failed to read fs.protected_hardlinks sysctl: %m");
830 r
= parse_boolean(value
);
832 log_debug_errno(r
, "Failed to parse fs.protected_hardlinks sysctl: %m");
840 static bool hardlink_vulnerable(const struct stat
*st
) {
843 return !S_ISDIR(st
->st_mode
) && st
->st_nlink
> 1 && dangerous_hardlinks();
846 static mode_t
process_mask_perms(mode_t mode
, mode_t current
) {
848 if ((current
& 0111) == 0)
850 if ((current
& 0222) == 0)
852 if ((current
& 0444) == 0)
854 if (!S_ISDIR(current
))
855 mode
&= ~07000; /* remove sticky/sgid/suid bit, unless directory */
860 static int fd_set_perms(Item
*i
, int fd
, const char *path
, const struct stat
*st
) {
870 if (!i
->mode_set
&& !i
->uid_set
&& !i
->gid_set
)
874 if (fstat(fd
, &stbuf
) < 0)
875 return log_error_errno(errno
, "fstat(%s) failed: %m", path
);
879 if (hardlink_vulnerable(st
))
880 return log_error_errno(SYNTHETIC_ERRNO(EPERM
),
881 "Refusing to set permissions on hardlinked file %s while the fs.protected_hardlinks sysctl is turned off.",
884 /* Do we need a chown()? */
886 (i
->uid_set
&& i
->uid
!= st
->st_uid
) ||
887 (i
->gid_set
&& i
->gid
!= st
->st_gid
);
889 /* Calculate the mode to apply */
890 new_mode
= i
->mode_set
? (i
->mask_perms
?
891 process_mask_perms(i
->mode
, st
->st_mode
) :
893 (st
->st_mode
& 07777);
895 if (i
->mode_set
&& do_chown
) {
896 /* Before we issue the chmod() let's reduce the access mode to the common bits of the old and
897 * the new mode. That way there's no time window where the file exists under the old owner
898 * with more than the old access modes — and not under the new owner with more than the new
899 * access modes either. */
901 if (S_ISLNK(st
->st_mode
))
902 log_debug("Skipping temporary mode fix for symlink %s.", path
);
904 mode_t m
= new_mode
& st
->st_mode
; /* Mask new mode by old mode */
906 if (((m
^ st
->st_mode
) & 07777) == 0)
907 log_debug("\"%s\" matches temporary mode %o already.", path
, m
);
909 log_debug("Temporarily changing \"%s\" to mode %o.", path
, m
);
910 r
= fchmod_opath(fd
, m
);
912 return log_error_errno(r
, "fchmod() of %s failed: %m", path
);
918 log_debug("Changing \"%s\" to owner "UID_FMT
":"GID_FMT
,
920 i
->uid_set
? i
->uid
: UID_INVALID
,
921 i
->gid_set
? i
->gid
: GID_INVALID
);
925 i
->uid_set
? i
->uid
: UID_INVALID
,
926 i
->gid_set
? i
->gid
: GID_INVALID
,
928 return log_error_errno(errno
, "fchownat() of %s failed: %m", path
);
931 /* Now, apply the final mode. We do this in two cases: when the user set a mode explicitly, or after a
932 * chown(), since chown()'s mangle the access mode in regards to sgid/suid in some conditions. */
933 if (i
->mode_set
|| do_chown
) {
934 if (S_ISLNK(st
->st_mode
))
935 log_debug("Skipping mode fix for symlink %s.", path
);
937 /* Check if the chmod() is unnecessary. Note that if we did a chown() before we always
938 * chmod() here again, since it might have mangled the bits. */
939 if (!do_chown
&& ((new_mode
^ st
->st_mode
) & 07777) == 0)
940 log_debug("\"%s\" matches mode %o already.", path
, new_mode
);
942 log_debug("Changing \"%s\" to mode %o.", path
, new_mode
);
943 r
= fchmod_opath(fd
, new_mode
);
945 return log_error_errno(r
, "fchmod() of %s failed: %m", path
);
951 return label_fix(path
, 0);
954 static int path_open_parent_safe(const char *path
) {
955 _cleanup_free_
char *dn
= NULL
;
958 if (path_equal(path
, "/") || !path_is_normalized(path
))
959 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
960 "Failed to open parent of '%s': invalid path.",
963 dn
= dirname_malloc(path
);
967 r
= chase_symlinks(dn
, arg_root
, CHASE_SAFE
|CHASE_WARN
, NULL
, &fd
);
968 if (r
< 0 && r
!= -ENOLINK
)
969 return log_error_errno(r
, "Failed to validate path %s: %m", path
);
971 return r
< 0 ? r
: fd
;
974 static int path_open_safe(const char *path
) {
977 /* path_open_safe() returns a file descriptor opened with O_PATH after
978 * verifying that the path doesn't contain unsafe transitions, except
979 * for its final component as the function does not follow symlink. */
983 if (!path_is_normalized(path
))
984 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
985 "Failed to open invalid path '%s'.",
988 r
= chase_symlinks(path
, arg_root
, CHASE_SAFE
|CHASE_WARN
|CHASE_NOFOLLOW
, NULL
, &fd
);
989 if (r
< 0 && r
!= -ENOLINK
)
990 return log_error_errno(r
, "Failed to validate path %s: %m", path
);
992 return r
< 0 ? r
: fd
;
995 static int path_set_perms(Item
*i
, const char *path
) {
996 _cleanup_close_
int fd
= -1;
1001 fd
= path_open_safe(path
);
1005 return fd_set_perms(i
, fd
, path
, NULL
);
1008 static int parse_xattrs_from_arg(Item
*i
) {
1013 assert(i
->argument
);
1018 _cleanup_free_
char *name
= NULL
, *value
= NULL
, *xattr
= NULL
;
1020 r
= extract_first_word(&p
, &xattr
, NULL
, EXTRACT_UNQUOTE
|EXTRACT_CUNESCAPE
);
1022 log_warning_errno(r
, "Failed to parse extended attribute '%s', ignoring: %m", p
);
1026 r
= split_pair(xattr
, "=", &name
, &value
);
1028 log_warning_errno(r
, "Failed to parse extended attribute, ignoring: %s", xattr
);
1032 if (isempty(name
) || isempty(value
)) {
1033 log_warning("Malformed extended attribute found, ignoring: %s", xattr
);
1037 if (strv_push_pair(&i
->xattrs
, name
, value
) < 0)
1040 name
= value
= NULL
;
1046 static int fd_set_xattrs(Item
*i
, int fd
, const char *path
, const struct stat
*st
) {
1047 char **name
, **value
;
1053 STRV_FOREACH_PAIR(name
, value
, i
->xattrs
) {
1054 log_debug("Setting extended attribute '%s=%s' on %s.", *name
, *value
, path
);
1055 if (setxattr(FORMAT_PROC_FD_PATH(fd
), *name
, *value
, strlen(*value
), 0) < 0)
1056 return log_error_errno(errno
, "Setting extended attribute %s=%s on %s failed: %m",
1057 *name
, *value
, path
);
1062 static int path_set_xattrs(Item
*i
, const char *path
) {
1063 _cleanup_close_
int fd
= -1;
1068 fd
= path_open_safe(path
);
1072 return fd_set_xattrs(i
, fd
, path
, NULL
);
1075 static int parse_acls_from_arg(Item
*item
) {
1081 /* If append_or_force (= modify) is set, we will not modify the acl
1082 * afterwards, so the mask can be added now if necessary. */
1084 r
= parse_acl(item
->argument
, &item
->acl_access
, &item
->acl_default
, !item
->append_or_force
);
1086 log_warning_errno(r
, "Failed to parse ACL \"%s\": %m. Ignoring", item
->argument
);
1088 log_warning("ACLs are not supported. Ignoring.");
1095 static int path_set_acl(const char *path
, const char *pretty
, acl_type_t type
, acl_t acl
, bool modify
) {
1096 _cleanup_(acl_free_charpp
) char *t
= NULL
;
1097 _cleanup_(acl_freep
) acl_t dup
= NULL
;
1100 /* Returns 0 for success, positive error if already warned,
1101 * negative error otherwise. */
1104 r
= acls_for_file(path
, type
, acl
, &dup
);
1108 r
= calc_acl_mask_if_needed(&dup
);
1116 /* the mask was already added earlier if needed */
1119 r
= add_base_acls_if_needed(&dup
, path
);
1123 t
= acl_to_any_text(dup
, NULL
, ',', TEXT_ABBREVIATE
);
1124 log_debug("Setting %s ACL %s on %s.",
1125 type
== ACL_TYPE_ACCESS
? "access" : "default",
1128 r
= acl_set_file(path
, type
, dup
);
1130 if (ERRNO_IS_NOT_SUPPORTED(errno
))
1131 /* No error if filesystem doesn't support ACLs. Return negative. */
1134 /* Return positive to indicate we already warned */
1135 return -log_error_errno(errno
,
1136 "Setting %s ACL \"%s\" on %s failed: %m",
1137 type
== ACL_TYPE_ACCESS
? "access" : "default",
1144 static int fd_set_acls(Item
*item
, int fd
, const char *path
, const struct stat
*st
) {
1154 if (fstat(fd
, &stbuf
) < 0)
1155 return log_error_errno(errno
, "fstat(%s) failed: %m", path
);
1159 if (hardlink_vulnerable(st
))
1160 return log_error_errno(SYNTHETIC_ERRNO(EPERM
),
1161 "Refusing to set ACLs on hardlinked file %s while the fs.protected_hardlinks sysctl is turned off.",
1164 if (S_ISLNK(st
->st_mode
)) {
1165 log_debug("Skipping ACL fix for symlink %s.", path
);
1169 if (item
->acl_access
)
1170 r
= path_set_acl(FORMAT_PROC_FD_PATH(fd
), path
, ACL_TYPE_ACCESS
, item
->acl_access
, item
->append_or_force
);
1172 /* set only default acls to folders */
1173 if (r
== 0 && item
->acl_default
&& S_ISDIR(st
->st_mode
))
1174 r
= path_set_acl(FORMAT_PROC_FD_PATH(fd
), path
, ACL_TYPE_DEFAULT
, item
->acl_default
, item
->append_or_force
);
1176 if (ERRNO_IS_NOT_SUPPORTED(r
)) {
1177 log_debug_errno(r
, "ACLs not supported by file system at %s", path
);
1182 return -r
; /* already warned */
1184 /* The above procfs paths don't work if /proc is not mounted. */
1185 if (r
== -ENOENT
&& proc_mounted() == 0)
1189 return log_error_errno(r
, "ACL operation on \"%s\" failed: %m", path
);
1194 static int path_set_acls(Item
*item
, const char *path
) {
1197 _cleanup_close_
int fd
= -1;
1202 fd
= path_open_safe(path
);
1206 r
= fd_set_acls(item
, fd
, path
, NULL
);
1211 static int parse_attribute_from_arg(Item
*item
) {
1213 static const struct {
1217 { 'A', FS_NOATIME_FL
}, /* do not update atime */
1218 { 'S', FS_SYNC_FL
}, /* Synchronous updates */
1219 { 'D', FS_DIRSYNC_FL
}, /* dirsync behaviour (directories only) */
1220 { 'a', FS_APPEND_FL
}, /* writes to file may only append */
1221 { 'c', FS_COMPR_FL
}, /* Compress file */
1222 { 'd', FS_NODUMP_FL
}, /* do not dump file */
1223 { 'e', FS_EXTENT_FL
}, /* Extents */
1224 { 'i', FS_IMMUTABLE_FL
}, /* Immutable file */
1225 { 'j', FS_JOURNAL_DATA_FL
}, /* Reserved for ext3 */
1226 { 's', FS_SECRM_FL
}, /* Secure deletion */
1227 { 'u', FS_UNRM_FL
}, /* Undelete */
1228 { 't', FS_NOTAIL_FL
}, /* file tail should not be merged */
1229 { 'T', FS_TOPDIR_FL
}, /* Top of directory hierarchies */
1230 { 'C', FS_NOCOW_FL
}, /* Do not cow file */
1231 { 'P', FS_PROJINHERIT_FL
}, /* Inherit the quota project ID */
1240 unsigned value
= 0, mask
= 0;
1250 } else if (*p
== '-') {
1253 } else if (*p
== '=') {
1259 if (isempty(p
) && mode
!= MODE_SET
)
1260 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
1261 "Setting file attribute on '%s' needs an attribute specification.",
1264 for (; p
&& *p
; p
++) {
1267 for (i
= 0; i
< ELEMENTSOF(attributes
); i
++)
1268 if (*p
== attributes
[i
].character
)
1271 if (i
>= ELEMENTSOF(attributes
))
1272 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
1273 "Unknown file attribute '%c' on '%s'.",
1276 v
= attributes
[i
].value
;
1278 SET_FLAG(value
, v
, IN_SET(mode
, MODE_ADD
, MODE_SET
));
1283 if (mode
== MODE_SET
)
1284 mask
|= CHATTR_ALL_FL
;
1288 item
->attribute_mask
= mask
;
1289 item
->attribute_value
= value
;
1290 item
->attribute_set
= true;
1295 static int fd_set_attribute(Item
*item
, int fd
, const char *path
, const struct stat
*st
) {
1296 _cleanup_close_
int procfs_fd
= -1;
1305 if (!item
->attribute_set
|| item
->attribute_mask
== 0)
1309 if (fstat(fd
, &stbuf
) < 0)
1310 return log_error_errno(errno
, "fstat(%s) failed: %m", path
);
1314 /* Issuing the file attribute ioctls on device nodes is not
1315 * safe, as that will be delivered to the drivers, not the
1316 * file system containing the device node. */
1317 if (!S_ISREG(st
->st_mode
) && !S_ISDIR(st
->st_mode
))
1318 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
1319 "Setting file flags is only supported on regular files and directories, cannot set on '%s'.",
1322 f
= item
->attribute_value
& item
->attribute_mask
;
1324 /* Mask away directory-specific flags */
1325 if (!S_ISDIR(st
->st_mode
))
1326 f
&= ~FS_DIRSYNC_FL
;
1328 procfs_fd
= fd_reopen(fd
, O_RDONLY
|O_CLOEXEC
|O_NOATIME
);
1330 return log_error_errno(procfs_fd
, "Failed to re-open '%s': %m", path
);
1332 unsigned previous
, current
;
1333 r
= chattr_full(NULL
, procfs_fd
, f
, item
->attribute_mask
, &previous
, ¤t
, CHATTR_FALLBACK_BITWISE
);
1335 log_warning("Cannot set file attributes for '%s', maybe due to incompatibility in specified attributes, "
1336 "previous=0x%08x, current=0x%08x, expected=0x%08x, ignoring.",
1337 path
, previous
, current
, (previous
& ~item
->attribute_mask
) | (f
& item
->attribute_mask
));
1339 log_full_errno(ERRNO_IS_NOT_SUPPORTED(r
) ? LOG_DEBUG
: LOG_WARNING
, r
,
1340 "Cannot set file attributes for '%s', value=0x%08x, mask=0x%08x, ignoring: %m",
1341 path
, item
->attribute_value
, item
->attribute_mask
);
1346 static int path_set_attribute(Item
*item
, const char *path
) {
1347 _cleanup_close_
int fd
= -1;
1349 if (!item
->attribute_set
|| item
->attribute_mask
== 0)
1352 fd
= path_open_safe(path
);
1356 return fd_set_attribute(item
, fd
, path
, NULL
);
1359 static int write_one_file(Item
*i
, const char *path
) {
1360 _cleanup_close_
int fd
= -1, dir_fd
= -1;
1366 assert(i
->argument
);
1367 assert(i
->type
== WRITE_FILE
);
1369 /* Validate the path and keep the fd on the directory for opening the
1370 * file so we're sure that it can't be changed behind our back. */
1371 dir_fd
= path_open_parent_safe(path
);
1375 bn
= basename(path
);
1377 /* Follows symlinks */
1378 fd
= openat(dir_fd
, bn
,
1379 O_NONBLOCK
|O_CLOEXEC
|O_WRONLY
|O_NOCTTY
|(i
->append_or_force
? O_APPEND
: 0),
1382 if (errno
== ENOENT
) {
1383 log_debug_errno(errno
, "Not writing missing file \"%s\": %m", path
);
1387 if (i
->allow_failure
)
1388 return log_debug_errno(errno
, "Failed to open file \"%s\", ignoring: %m", path
);
1390 return log_error_errno(errno
, "Failed to open file \"%s\": %m", path
);
1393 /* 'w' is allowed to write into any kind of files. */
1394 log_debug("Writing to \"%s\".", path
);
1396 r
= loop_write(fd
, i
->argument
, strlen(i
->argument
), false);
1398 return log_error_errno(r
, "Failed to write file \"%s\": %m", path
);
1400 return fd_set_perms(i
, fd
, path
, NULL
);
1403 static int create_file(Item
*i
, const char *path
) {
1404 _cleanup_close_
int fd
= -1, dir_fd
= -1;
1405 struct stat stbuf
, *st
= NULL
;
1411 assert(i
->type
== CREATE_FILE
);
1413 /* 'f' operates on regular files exclusively. */
1415 /* Validate the path and keep the fd on the directory for opening the
1416 * file so we're sure that it can't be changed behind our back. */
1417 dir_fd
= path_open_parent_safe(path
);
1421 bn
= basename(path
);
1423 RUN_WITH_UMASK(0000) {
1424 mac_selinux_create_file_prepare(path
, S_IFREG
);
1425 fd
= openat(dir_fd
, bn
, O_CREAT
|O_EXCL
|O_NOFOLLOW
|O_NONBLOCK
|O_CLOEXEC
|O_WRONLY
|O_NOCTTY
, i
->mode
);
1426 mac_selinux_create_file_clear();
1430 /* Even on a read-only filesystem, open(2) returns EEXIST if the
1431 * file already exists. It returns EROFS only if it needs to
1432 * create the file. */
1433 if (errno
!= EEXIST
)
1434 return log_error_errno(errno
, "Failed to create file %s: %m", path
);
1436 /* Re-open the file. At that point it must exist since open(2)
1437 * failed with EEXIST. We still need to check if the perms/mode
1438 * need to be changed. For read-only filesystems, we let
1439 * fd_set_perms() report the error if the perms need to be
1441 fd
= openat(dir_fd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
, i
->mode
);
1443 return log_error_errno(errno
, "Failed to re-open file %s: %m", path
);
1445 if (fstat(fd
, &stbuf
) < 0)
1446 return log_error_errno(errno
, "stat(%s) failed: %m", path
);
1448 if (!S_ISREG(stbuf
.st_mode
))
1449 return log_error_errno(SYNTHETIC_ERRNO(EEXIST
),
1450 "%s exists and is not a regular file.",
1456 log_debug("\"%s\" has been created.", path
);
1459 log_debug("Writing to \"%s\".", path
);
1461 r
= loop_write(fd
, i
->argument
, strlen(i
->argument
), false);
1463 return log_error_errno(r
, "Failed to write file \"%s\": %m", path
);
1467 return fd_set_perms(i
, fd
, path
, st
);
1470 static int truncate_file(Item
*i
, const char *path
) {
1471 _cleanup_close_
int fd
= -1, dir_fd
= -1;
1472 struct stat stbuf
, *st
= NULL
;
1479 assert(i
->type
== TRUNCATE_FILE
|| (i
->type
== CREATE_FILE
&& i
->append_or_force
));
1481 /* We want to operate on regular file exclusively especially since
1482 * O_TRUNC is unspecified if the file is neither a regular file nor a
1483 * fifo nor a terminal device. Therefore we first open the file and make
1484 * sure it's a regular one before truncating it. */
1486 /* Validate the path and keep the fd on the directory for opening the
1487 * file so we're sure that it can't be changed behind our back. */
1488 dir_fd
= path_open_parent_safe(path
);
1492 bn
= basename(path
);
1494 RUN_WITH_UMASK(0000) {
1495 mac_selinux_create_file_prepare(path
, S_IFREG
);
1496 fd
= openat(dir_fd
, bn
, O_CREAT
|O_NOFOLLOW
|O_NONBLOCK
|O_CLOEXEC
|O_WRONLY
|O_NOCTTY
, i
->mode
);
1497 mac_selinux_create_file_clear();
1502 return log_error_errno(errno
, "Failed to open/create file %s: %m", path
);
1504 /* On a read-only filesystem, we don't want to fail if the
1505 * target is already empty and the perms are set. So we still
1506 * proceed with the sanity checks and let the remaining
1507 * operations fail with EROFS if they try to modify the target
1510 fd
= openat(dir_fd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
, i
->mode
);
1512 if (errno
== ENOENT
)
1513 return log_error_errno(SYNTHETIC_ERRNO(EROFS
),
1514 "Cannot create file %s on a read-only file system.",
1517 return log_error_errno(errno
, "Failed to re-open file %s: %m", path
);
1523 if (fstat(fd
, &stbuf
) < 0)
1524 return log_error_errno(errno
, "stat(%s) failed: %m", path
);
1526 if (!S_ISREG(stbuf
.st_mode
))
1527 return log_error_errno(SYNTHETIC_ERRNO(EEXIST
),
1528 "%s exists and is not a regular file.",
1531 if (stbuf
.st_size
> 0) {
1532 if (ftruncate(fd
, 0) < 0) {
1533 r
= erofs
? -EROFS
: -errno
;
1534 return log_error_errno(r
, "Failed to truncate file %s: %m", path
);
1539 log_debug("\"%s\" has been created.", path
);
1542 log_debug("Writing to \"%s\".", path
);
1544 r
= loop_write(fd
, i
->argument
, strlen(i
->argument
), false);
1546 r
= erofs
? -EROFS
: r
;
1547 return log_error_errno(r
, "Failed to write file %s: %m", path
);
1551 return fd_set_perms(i
, fd
, path
, st
);
1554 static int copy_files(Item
*i
) {
1555 _cleanup_close_
int dfd
= -1, fd
= -1;
1559 log_debug("Copying tree \"%s\" to \"%s\".", i
->argument
, i
->path
);
1561 bn
= basename(i
->path
);
1563 /* Validate the path and use the returned directory fd for copying the
1564 * target so we're sure that the path can't be changed behind our
1566 dfd
= path_open_parent_safe(i
->path
);
1570 r
= copy_tree_at(AT_FDCWD
, i
->argument
,
1572 i
->uid_set
? i
->uid
: UID_INVALID
,
1573 i
->gid_set
? i
->gid
: GID_INVALID
,
1574 COPY_REFLINK
| COPY_MERGE_EMPTY
| COPY_MAC_CREATE
| COPY_HARDLINKS
);
1578 /* If the target already exists on read-only filesystems, trying
1579 * to create the target will not fail with EEXIST but with
1581 if (r
== -EROFS
&& faccessat(dfd
, bn
, F_OK
, AT_SYMLINK_NOFOLLOW
) == 0)
1585 return log_error_errno(r
, "Failed to copy files to %s: %m", i
->path
);
1587 if (stat(i
->argument
, &a
) < 0)
1588 return log_error_errno(errno
, "stat(%s) failed: %m", i
->argument
);
1590 if (fstatat(dfd
, bn
, &b
, AT_SYMLINK_NOFOLLOW
) < 0)
1591 return log_error_errno(errno
, "stat(%s) failed: %m", i
->path
);
1593 if ((a
.st_mode
^ b
.st_mode
) & S_IFMT
) {
1594 log_debug("Can't copy to %s, file exists already and is of different type", i
->path
);
1599 fd
= openat(dfd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
);
1601 return log_error_errno(errno
, "Failed to openat(%s): %m", i
->path
);
1603 return fd_set_perms(i
, fd
, i
->path
, NULL
);
1611 _CREATION_MODE_INVALID
= -EINVAL
,
1614 static const char *const creation_mode_verb_table
[_CREATION_MODE_MAX
] = {
1615 [CREATION_NORMAL
] = "Created",
1616 [CREATION_EXISTING
] = "Found existing",
1617 [CREATION_FORCE
] = "Created replacement",
1620 DEFINE_PRIVATE_STRING_TABLE_LOOKUP_TO_STRING(creation_mode_verb
, CreationMode
);
1622 static int create_directory_or_subvolume(const char *path
, mode_t mode
, bool subvol
, CreationMode
*creation
) {
1623 _cleanup_close_
int pfd
= -1;
1632 pfd
= path_open_parent_safe(path
);
1637 r
= getenv_bool("SYSTEMD_TMPFILES_FORCE_SUBVOL");
1639 if (r
!= -ENXIO
) /* env var is unset */
1640 log_warning_errno(r
, "Cannot parse value of $SYSTEMD_TMPFILES_FORCE_SUBVOL, ignoring.");
1641 r
= btrfs_is_subvol(empty_to_root(arg_root
)) > 0;
1644 /* Don't create a subvolume unless the root directory is
1645 * one, too. We do this under the assumption that if the
1646 * root directory is just a plain directory (i.e. very
1647 * light-weight), we shouldn't try to split it up into
1648 * subvolumes (i.e. more heavy-weight). Thus, chroot()
1649 * environments and suchlike will get a full brtfs
1650 * subvolume set up below their tree only if they
1651 * specifically set up a btrfs subvolume for the root
1656 RUN_WITH_UMASK((~mode
) & 0777)
1657 r
= btrfs_subvol_make_fd(pfd
, basename(path
));
1662 if (!subvol
|| r
== -ENOTTY
)
1663 RUN_WITH_UMASK(0000)
1664 r
= mkdirat_label(pfd
, basename(path
), mode
);
1669 if (!IN_SET(r
, -EEXIST
, -EROFS
))
1670 return log_error_errno(r
, "Failed to create directory or subvolume \"%s\": %m", path
);
1673 if (k
== -ENOENT
&& r
== -EROFS
)
1674 return log_error_errno(r
, "%s does not exist and cannot be created as the file system is read-only.", path
);
1676 return log_error_errno(k
, "Failed to check if %s exists: %m", path
);
1678 return log_warning_errno(SYNTHETIC_ERRNO(EEXIST
),
1679 "\"%s\" already exists and is not a directory.", path
);
1681 *creation
= CREATION_EXISTING
;
1683 *creation
= CREATION_NORMAL
;
1685 log_debug("%s directory \"%s\".", creation_mode_verb_to_string(*creation
), path
);
1687 r
= openat(pfd
, basename(path
), O_NOCTTY
|O_CLOEXEC
|O_DIRECTORY
);
1689 return log_error_errno(errno
, "Failed to open directory '%s': %m", basename(path
));
1694 static int create_directory(Item
*i
, const char *path
) {
1695 _cleanup_close_
int fd
= -1;
1698 assert(IN_SET(i
->type
, CREATE_DIRECTORY
, TRUNCATE_DIRECTORY
));
1700 fd
= create_directory_or_subvolume(path
, i
->mode
, false, NULL
);
1706 return fd_set_perms(i
, fd
, path
, NULL
);
1709 static int create_subvolume(Item
*i
, const char *path
) {
1710 _cleanup_close_
int fd
= -1;
1711 CreationMode creation
;
1715 assert(IN_SET(i
->type
, CREATE_SUBVOLUME
, CREATE_SUBVOLUME_NEW_QUOTA
, CREATE_SUBVOLUME_INHERIT_QUOTA
));
1717 fd
= create_directory_or_subvolume(path
, i
->mode
, true, &creation
);
1723 if (creation
== CREATION_NORMAL
&&
1724 IN_SET(i
->type
, CREATE_SUBVOLUME_NEW_QUOTA
, CREATE_SUBVOLUME_INHERIT_QUOTA
)) {
1725 r
= btrfs_subvol_auto_qgroup_fd(fd
, 0, i
->type
== CREATE_SUBVOLUME_NEW_QUOTA
);
1727 log_debug_errno(r
, "Couldn't adjust quota for subvolume \"%s\" (unsupported fs or dir not a subvolume): %m", i
->path
);
1728 else if (r
== -EROFS
)
1729 log_debug_errno(r
, "Couldn't adjust quota for subvolume \"%s\" (fs is read-only).", i
->path
);
1730 else if (r
== -ENOTCONN
)
1731 log_debug_errno(r
, "Couldn't adjust quota for subvolume \"%s\" (quota support is disabled).", i
->path
);
1733 q
= log_error_errno(r
, "Failed to adjust quota for subvolume \"%s\": %m", i
->path
);
1735 log_debug("Adjusted quota for subvolume \"%s\".", i
->path
);
1737 log_debug("Quota for subvolume \"%s\" already in place, no change made.", i
->path
);
1740 r
= fd_set_perms(i
, fd
, path
, NULL
);
1741 if (q
< 0) /* prefer the quota change error from above */
1747 static int empty_directory(Item
*i
, const char *path
) {
1751 assert(i
->type
== EMPTY_DIRECTORY
);
1753 r
= is_dir(path
, false);
1755 /* Option "e" operates only on existing objects. Do not
1756 * print errors about non-existent files or directories */
1757 log_debug("Skipping missing directory: %s", path
);
1761 return log_error_errno(r
, "is_dir() failed on path %s: %m", path
);
1763 log_warning("\"%s\" already exists and is not a directory.", path
);
1767 return path_set_perms(i
, path
);
1770 static int create_device(Item
*i
, mode_t file_type
) {
1771 _cleanup_close_
int dfd
= -1, fd
= -1;
1772 CreationMode creation
;
1777 assert(IN_SET(file_type
, S_IFBLK
, S_IFCHR
));
1779 bn
= basename(i
->path
);
1781 /* Validate the path and use the returned directory fd for copying the
1782 * target so we're sure that the path can't be changed behind our
1784 dfd
= path_open_parent_safe(i
->path
);
1788 RUN_WITH_UMASK(0000) {
1789 mac_selinux_create_file_prepare(i
->path
, file_type
);
1790 r
= mknodat(dfd
, bn
, i
->mode
| file_type
, i
->major_minor
);
1791 mac_selinux_create_file_clear();
1797 if (errno
== EPERM
) {
1798 log_debug("We lack permissions, possibly because of cgroup configuration; "
1799 "skipping creation of device node %s.", i
->path
);
1803 if (errno
!= EEXIST
)
1804 return log_error_errno(errno
, "Failed to create device node %s: %m", i
->path
);
1806 if (fstatat(dfd
, bn
, &st
, 0) < 0)
1807 return log_error_errno(errno
, "stat(%s) failed: %m", i
->path
);
1809 if ((st
.st_mode
& S_IFMT
) != file_type
) {
1811 if (i
->append_or_force
) {
1813 RUN_WITH_UMASK(0000) {
1814 mac_selinux_create_file_prepare(i
->path
, file_type
);
1815 /* FIXME: need to introduce mknodat_atomic() */
1816 r
= mknod_atomic(i
->path
, i
->mode
| file_type
, i
->major_minor
);
1817 mac_selinux_create_file_clear();
1821 return log_error_errno(r
, "Failed to create device node \"%s\": %m", i
->path
);
1822 creation
= CREATION_FORCE
;
1824 log_warning("\"%s\" already exists is not a device node.", i
->path
);
1828 creation
= CREATION_EXISTING
;
1830 creation
= CREATION_NORMAL
;
1832 log_debug("%s %s device node \"%s\" %u:%u.",
1833 creation_mode_verb_to_string(creation
),
1834 i
->type
== CREATE_BLOCK_DEVICE
? "block" : "char",
1835 i
->path
, major(i
->mode
), minor(i
->mode
));
1837 fd
= openat(dfd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
);
1839 return log_error_errno(errno
, "Failed to openat(%s): %m", i
->path
);
1841 return fd_set_perms(i
, fd
, i
->path
, NULL
);
1844 static int create_fifo(Item
*i
, const char *path
) {
1845 _cleanup_close_
int pfd
= -1, fd
= -1;
1846 CreationMode creation
;
1851 pfd
= path_open_parent_safe(path
);
1855 bn
= basename(path
);
1857 RUN_WITH_UMASK(0000) {
1858 mac_selinux_create_file_prepare(path
, S_IFIFO
);
1859 r
= mkfifoat(pfd
, bn
, i
->mode
);
1860 mac_selinux_create_file_clear();
1864 if (errno
!= EEXIST
)
1865 return log_error_errno(errno
, "Failed to create fifo %s: %m", path
);
1867 if (fstatat(pfd
, bn
, &st
, AT_SYMLINK_NOFOLLOW
) < 0)
1868 return log_error_errno(errno
, "stat(%s) failed: %m", path
);
1870 if (!S_ISFIFO(st
.st_mode
)) {
1872 if (i
->append_or_force
) {
1873 RUN_WITH_UMASK(0000) {
1874 mac_selinux_create_file_prepare(path
, S_IFIFO
);
1875 r
= mkfifoat_atomic(pfd
, bn
, i
->mode
);
1876 mac_selinux_create_file_clear();
1880 return log_error_errno(r
, "Failed to create fifo %s: %m", path
);
1881 creation
= CREATION_FORCE
;
1883 log_warning("\"%s\" already exists and is not a fifo.", path
);
1887 creation
= CREATION_EXISTING
;
1889 creation
= CREATION_NORMAL
;
1891 log_debug("%s fifo \"%s\".", creation_mode_verb_to_string(creation
), path
);
1893 fd
= openat(pfd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
);
1895 return log_error_errno(errno
, "Failed to openat(%s): %m", path
);
1897 return fd_set_perms(i
, fd
, i
->path
, NULL
);
1900 typedef int (*action_t
)(Item
*i
, const char *path
);
1901 typedef int (*fdaction_t
)(Item
*i
, int fd
, const char *path
, const struct stat
*st
);
1903 static int item_do(Item
*i
, int fd
, const char *path
, fdaction_t action
) {
1911 if (fstat(fd
, &st
) < 0) {
1912 r
= log_error_errno(errno
, "fstat() on file failed: %m");
1916 /* This returns the first error we run into, but nevertheless
1918 r
= action(i
, fd
, path
, &st
);
1920 if (S_ISDIR(st
.st_mode
)) {
1921 _cleanup_closedir_
DIR *d
= NULL
;
1923 /* The passed 'fd' was opened with O_PATH. We need to convert it into a 'regular' fd before
1924 * reading the directory content. */
1925 d
= opendir(FORMAT_PROC_FD_PATH(fd
));
1927 log_error_errno(errno
, "Failed to opendir() '%s': %m", FORMAT_PROC_FD_PATH(fd
));
1933 FOREACH_DIRENT_ALL(de
, d
, q
= -errno
; goto finish
) {
1936 if (dot_or_dot_dot(de
->d_name
))
1939 de_fd
= openat(fd
, de
->d_name
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
);
1941 q
= log_error_errno(errno
, "Failed to open() file '%s': %m", de
->d_name
);
1943 _cleanup_free_
char *de_path
= NULL
;
1945 de_path
= path_join(path
, de
->d_name
);
1949 /* Pass ownership of dirent fd over */
1950 q
= item_do(i
, de_fd
, de_path
, action
);
1953 if (q
< 0 && r
== 0)
1962 static int glob_item(Item
*i
, action_t action
) {
1963 _cleanup_globfree_ glob_t g
= {
1964 .gl_opendir
= (void *(*)(const char *)) opendir_nomod
,
1969 k
= safe_glob(i
->path
, GLOB_NOSORT
|GLOB_BRACE
, &g
);
1970 if (k
< 0 && k
!= -ENOENT
)
1971 return log_error_errno(k
, "glob(%s) failed: %m", i
->path
);
1973 STRV_FOREACH(fn
, g
.gl_pathv
) {
1975 if (k
< 0 && r
== 0)
1982 static int glob_item_recursively(Item
*i
, fdaction_t action
) {
1983 _cleanup_globfree_ glob_t g
= {
1984 .gl_opendir
= (void *(*)(const char *)) opendir_nomod
,
1989 k
= safe_glob(i
->path
, GLOB_NOSORT
|GLOB_BRACE
, &g
);
1990 if (k
< 0 && k
!= -ENOENT
)
1991 return log_error_errno(k
, "glob(%s) failed: %m", i
->path
);
1993 STRV_FOREACH(fn
, g
.gl_pathv
) {
1994 _cleanup_close_
int fd
= -1;
1996 /* Make sure we won't trigger/follow file object (such as
1997 * device nodes, automounts, ...) pointed out by 'fn' with
1998 * O_PATH. Note, when O_PATH is used, flags other than
1999 * O_CLOEXEC, O_DIRECTORY, and O_NOFOLLOW are ignored. */
2001 fd
= open(*fn
, O_CLOEXEC
|O_NOFOLLOW
|O_PATH
);
2003 log_error_errno(errno
, "Opening '%s' failed: %m", *fn
);
2009 k
= item_do(i
, fd
, *fn
, action
);
2010 if (k
< 0 && r
== 0)
2013 /* we passed fd ownership to the previous call */
2020 static int rm_if_wrong_type_safe(
2023 const struct stat
*parent_st
, /* Only used if follow_links below is true. */
2026 _cleanup_free_
char *parent_name
= NULL
;
2027 bool follow_links
= !FLAGS_SET(flags
, AT_SYMLINK_NOFOLLOW
);
2032 assert((mode
& ~S_IFMT
) == 0);
2033 assert(!follow_links
|| parent_st
);
2034 assert((flags
& ~AT_SYMLINK_NOFOLLOW
) == 0);
2036 if (!filename_is_valid(name
))
2037 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "\"%s\" is not a valid filename.", name
);
2039 r
= fstatat_harder(parent_fd
, name
, &st
, flags
, REMOVE_CHMOD
| REMOVE_CHMOD_RESTORE
);
2041 (void) fd_get_path(parent_fd
, &parent_name
);
2042 return log_full_errno(r
== -ENOENT
? LOG_DEBUG
: LOG_ERR
, r
,
2043 "Failed to stat \"%s\" at \"%s\": %m", name
, strna(parent_name
));
2046 /* Fail before removing anything if this is an unsafe transition. */
2047 if (follow_links
&& unsafe_transition(parent_st
, &st
)) {
2048 (void) fd_get_path(parent_fd
, &parent_name
);
2049 return log_error_errno(SYNTHETIC_ERRNO(ENOLINK
),
2050 "Unsafe transition from \"%s\" to \"%s\".", parent_name
, name
);
2053 if ((st
.st_mode
& S_IFMT
) == mode
)
2056 (void) fd_get_path(parent_fd
, &parent_name
);
2057 log_notice("Wrong file type 0x%x; rm -rf \"%s/%s\"", st
.st_mode
& S_IFMT
, strna(parent_name
), name
);
2059 /* If the target of the symlink was the wrong type, the link needs to be removed instead of the
2060 * target, so make sure it is identified as a link and not a directory. */
2062 r
= fstatat_harder(parent_fd
, name
, &st
, AT_SYMLINK_NOFOLLOW
, REMOVE_CHMOD
| REMOVE_CHMOD_RESTORE
);
2064 return log_error_errno(r
, "Failed to stat \"%s\" at \"%s\": %m", name
, strna(parent_name
));
2067 /* Do not remove mount points. */
2068 r
= fd_is_mount_point(parent_fd
, name
, follow_links
? AT_SYMLINK_FOLLOW
: 0);
2070 (void) log_warning_errno(r
, "Failed to check if \"%s/%s\" is a mount point: %m; Continuing",
2071 strna(parent_name
), name
);
2073 return log_error_errno(SYNTHETIC_ERRNO(EBUSY
),
2074 "Not removing \"%s/%s\" because it is a mount point.", strna(parent_name
), name
);
2076 if ((st
.st_mode
& S_IFMT
) == S_IFDIR
) {
2077 _cleanup_close_
int child_fd
= -1;
2079 child_fd
= openat(parent_fd
, name
, O_NOCTTY
| O_CLOEXEC
| O_DIRECTORY
);
2081 return log_error_errno(errno
, "Failed to open \"%s\" at \"%s\": %m", name
, strna(parent_name
));
2083 r
= rm_rf_children(TAKE_FD(child_fd
), REMOVE_ROOT
|REMOVE_SUBVOLUME
|REMOVE_PHYSICAL
, &st
);
2085 return log_error_errno(r
, "Failed to remove contents of \"%s\" at \"%s\": %m", name
, strna(parent_name
));
2087 r
= unlinkat_harder(parent_fd
, name
, AT_REMOVEDIR
, REMOVE_CHMOD
| REMOVE_CHMOD_RESTORE
);
2089 r
= unlinkat_harder(parent_fd
, name
, 0, REMOVE_CHMOD
| REMOVE_CHMOD_RESTORE
);
2091 return log_error_errno(r
, "Failed to remove \"%s\" at \"%s\": %m", name
, strna(parent_name
));
2093 /* This is covered by the log_notice "Wrong file type..." It is logged earlier because it gives
2094 * context to other error messages that might follow. */
2098 /* If child_mode is non-zero, rm_if_wrong_type_safe will be executed for the last path component. */
2099 static int mkdir_parents_rm_if_wrong_type(mode_t child_mode
, const char *path
) {
2100 _cleanup_close_
int parent_fd
= -1;
2101 struct stat parent_st
;
2106 assert((child_mode
& ~S_IFMT
) == 0);
2108 path_len
= strlen(path
);
2111 /* rm_if_wrong_type_safe already logs errors. */
2112 return child_mode
!= 0 ? rm_if_wrong_type_safe(child_mode
, AT_FDCWD
, NULL
, path
, AT_SYMLINK_NOFOLLOW
) : 0;
2114 if (child_mode
!= 0 && endswith(path
, "/"))
2115 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
2116 "Trailing path separators are only allowed if child_mode is not set; got \"%s\"", path
);
2118 /* Get the parent_fd and stat. */
2119 parent_fd
= openat(AT_FDCWD
, path_is_absolute(path
) ? "/" : ".", O_NOCTTY
| O_CLOEXEC
| O_DIRECTORY
);
2121 return log_error_errno(errno
, "Failed to open root: %m");
2123 if (fstat(parent_fd
, &parent_st
) < 0)
2124 return log_error_errno(errno
, "Failed to stat root: %m");
2126 /* Check every parent directory in the path, except the last component */
2127 for (const char *e
= path
;;) {
2128 _cleanup_close_
int next_fd
= -1;
2129 char t
[path_len
+ 1];
2132 /* Find the start of the next path component. */
2133 s
= e
+ strspn(e
, "/");
2134 /* Find the end of the next path component. */
2135 e
= s
+ strcspn(s
, "/");
2137 /* Copy the path component to t so it can be a null terminated string. */
2138 *((char*) mempcpy(t
, s
, e
- s
)) = 0;
2140 /* Is this the last component? If so, then check the type */
2142 return child_mode
!= 0 ? rm_if_wrong_type_safe(child_mode
, parent_fd
, &parent_st
, t
, AT_SYMLINK_NOFOLLOW
) : 0;
2144 r
= rm_if_wrong_type_safe(S_IFDIR
, parent_fd
, &parent_st
, t
, 0);
2145 /* Remove dangling symlinks. */
2147 r
= rm_if_wrong_type_safe(S_IFDIR
, parent_fd
, &parent_st
, t
, AT_SYMLINK_NOFOLLOW
);
2149 RUN_WITH_UMASK(0000)
2150 r
= mkdirat_label(parent_fd
, t
, 0755);
2152 _cleanup_free_
char *parent_name
= NULL
;
2154 (void) fd_get_path(parent_fd
, &parent_name
);
2155 return log_error_errno(r
, "Failed to mkdir \"%s\" at \"%s\": %m", t
, strnull(parent_name
));
2158 /* rm_if_wrong_type_safe already logs errors. */
2161 next_fd
= RET_NERRNO(openat(parent_fd
, t
, O_NOCTTY
| O_CLOEXEC
| O_DIRECTORY
));
2163 _cleanup_free_
char *parent_name
= NULL
;
2165 (void) fd_get_path(parent_fd
, &parent_name
);
2166 return log_error_errno(next_fd
, "Failed to open \"%s\" at \"%s\": %m", t
, strnull(parent_name
));
2168 r
= RET_NERRNO(fstat(next_fd
, &parent_st
));
2170 _cleanup_free_
char *parent_name
= NULL
;
2172 (void) fd_get_path(parent_fd
, &parent_name
);
2173 return log_error_errno(r
, "Failed to stat \"%s\" at \"%s\": %m", t
, strnull(parent_name
));
2176 CLOSE_AND_REPLACE(parent_fd
, next_fd
);
2180 static int mkdir_parents_item(Item
*i
, mode_t child_mode
) {
2182 if (i
->try_replace
) {
2183 r
= mkdir_parents_rm_if_wrong_type(child_mode
, i
->path
);
2184 if (r
< 0 && r
!= -ENOENT
)
2187 RUN_WITH_UMASK(0000)
2188 (void) mkdir_parents_label(i
->path
, 0755);
2193 static int create_item(Item
*i
) {
2194 CreationMode creation
;
2199 log_debug("Running create action for entry %c %s", (char) i
->type
, i
->path
);
2204 case IGNORE_DIRECTORY_PATH
:
2206 case RECURSIVE_REMOVE_PATH
:
2211 r
= mkdir_parents_item(i
, S_IFREG
);
2215 if ((i
->type
== CREATE_FILE
&& i
->append_or_force
) || i
->type
== TRUNCATE_FILE
)
2216 r
= truncate_file(i
, i
->path
);
2218 r
= create_file(i
, i
->path
);
2225 r
= mkdir_parents_item(i
, 0);
2235 r
= glob_item(i
, write_one_file
);
2241 case CREATE_DIRECTORY
:
2242 case TRUNCATE_DIRECTORY
:
2243 r
= mkdir_parents_item(i
, S_IFDIR
);
2247 r
= create_directory(i
, i
->path
);
2252 case CREATE_SUBVOLUME
:
2253 case CREATE_SUBVOLUME_INHERIT_QUOTA
:
2254 case CREATE_SUBVOLUME_NEW_QUOTA
:
2255 r
= mkdir_parents_item(i
, S_IFDIR
);
2259 r
= create_subvolume(i
, i
->path
);
2264 case EMPTY_DIRECTORY
:
2265 r
= glob_item(i
, empty_directory
);
2271 r
= mkdir_parents_item(i
, S_IFIFO
);
2275 r
= create_fifo(i
, i
->path
);
2280 case CREATE_SYMLINK
: {
2281 r
= mkdir_parents_item(i
, S_IFLNK
);
2285 mac_selinux_create_file_prepare(i
->path
, S_IFLNK
);
2286 r
= symlink(i
->argument
, i
->path
);
2287 mac_selinux_create_file_clear();
2290 _cleanup_free_
char *x
= NULL
;
2292 if (errno
!= EEXIST
)
2293 return log_error_errno(errno
, "symlink(%s, %s) failed: %m", i
->argument
, i
->path
);
2295 r
= readlink_malloc(i
->path
, &x
);
2296 if (r
< 0 || !streq(i
->argument
, x
)) {
2298 if (i
->append_or_force
) {
2299 mac_selinux_create_file_prepare(i
->path
, S_IFLNK
);
2300 r
= symlink_atomic(i
->argument
, i
->path
);
2301 mac_selinux_create_file_clear();
2303 if (IN_SET(r
, -EISDIR
, -EEXIST
, -ENOTEMPTY
)) {
2304 r
= rm_rf(i
->path
, REMOVE_ROOT
|REMOVE_PHYSICAL
);
2306 return log_error_errno(r
, "rm -fr %s failed: %m", i
->path
);
2308 mac_selinux_create_file_prepare(i
->path
, S_IFLNK
);
2309 r
= RET_NERRNO(symlink(i
->argument
, i
->path
));
2310 mac_selinux_create_file_clear();
2313 return log_error_errno(r
, "symlink(%s, %s) failed: %m", i
->argument
, i
->path
);
2315 creation
= CREATION_FORCE
;
2317 log_debug("\"%s\" is not a symlink or does not point to the correct path.", i
->path
);
2321 creation
= CREATION_EXISTING
;
2324 creation
= CREATION_NORMAL
;
2325 log_debug("%s symlink \"%s\".", creation_mode_verb_to_string(creation
), i
->path
);
2329 case CREATE_BLOCK_DEVICE
:
2330 case CREATE_CHAR_DEVICE
:
2331 if (have_effective_cap(CAP_MKNOD
) == 0) {
2332 /* In a container we lack CAP_MKNOD. We shouldn't attempt to create the device node in that
2333 * case to avoid noise, and we don't support virtualized devices in containers anyway. */
2335 log_debug("We lack CAP_MKNOD, skipping creation of device node %s.", i
->path
);
2339 r
= mkdir_parents_item(i
, i
->type
== CREATE_BLOCK_DEVICE
? S_IFBLK
: S_IFCHR
);
2343 r
= create_device(i
, i
->type
== CREATE_BLOCK_DEVICE
? S_IFBLK
: S_IFCHR
);
2351 r
= glob_item(i
, path_set_perms
);
2356 case RECURSIVE_RELABEL_PATH
:
2357 r
= glob_item_recursively(i
, fd_set_perms
);
2363 r
= glob_item(i
, path_set_xattrs
);
2368 case RECURSIVE_SET_XATTR
:
2369 r
= glob_item_recursively(i
, fd_set_xattrs
);
2375 r
= glob_item(i
, path_set_acls
);
2380 case RECURSIVE_SET_ACL
:
2381 r
= glob_item_recursively(i
, fd_set_acls
);
2387 r
= glob_item(i
, path_set_attribute
);
2392 case RECURSIVE_SET_ATTRIBUTE
:
2393 r
= glob_item_recursively(i
, fd_set_attribute
);
2402 static int remove_item_instance(Item
*i
, const char *instance
) {
2410 if (remove(instance
) < 0 && errno
!= ENOENT
)
2411 return log_error_errno(errno
, "rm(%s): %m", instance
);
2415 case RECURSIVE_REMOVE_PATH
:
2416 /* FIXME: we probably should use dir_cleanup() here instead of rm_rf() so that 'x' is honoured. */
2417 log_debug("rm -rf \"%s\"", instance
);
2418 r
= rm_rf(instance
, REMOVE_ROOT
|REMOVE_SUBVOLUME
|REMOVE_PHYSICAL
);
2419 if (r
< 0 && r
!= -ENOENT
)
2420 return log_error_errno(r
, "rm_rf(%s): %m", instance
);
2425 assert_not_reached();
2431 static int remove_item(Item
*i
) {
2436 log_debug("Running remove action for entry %c %s", (char) i
->type
, i
->path
);
2440 case TRUNCATE_DIRECTORY
:
2441 /* FIXME: we probably should use dir_cleanup() here instead of rm_rf() so that 'x' is honoured. */
2442 log_debug("rm -rf \"%s\"", i
->path
);
2443 r
= rm_rf(i
->path
, REMOVE_PHYSICAL
);
2444 if (r
< 0 && r
!= -ENOENT
)
2445 return log_error_errno(r
, "rm_rf(%s): %m", i
->path
);
2450 case RECURSIVE_REMOVE_PATH
:
2451 return glob_item(i
, remove_item_instance
);
2458 static char *age_by_to_string(AgeBy ab
, bool is_dir
) {
2459 static const char ab_map
[] = { 'a', 'b', 'c', 'm' };
2463 ret
= new(char, ELEMENTSOF(ab_map
) + 1);
2467 for (size_t i
= 0; i
< ELEMENTSOF(ab_map
); i
++)
2468 if (FLAGS_SET(ab
, 1U << i
))
2469 ret
[j
++] = is_dir
? ascii_toupper(ab_map
[i
]) : ab_map
[i
];
2475 static int clean_item_instance(Item
*i
, const char* instance
) {
2476 _cleanup_closedir_
DIR *d
= NULL
;
2477 STRUCT_STATX_DEFINE(sx
);
2486 n
= now(CLOCK_REALTIME
);
2490 cutoff
= n
- i
->age
;
2492 d
= opendir_nomod(instance
);
2494 if (IN_SET(errno
, ENOENT
, ENOTDIR
)) {
2495 log_debug_errno(errno
, "Directory \"%s\": %m", instance
);
2499 return log_error_errno(errno
, "Failed to open directory %s: %m", instance
);
2502 r
= statx_fallback(dirfd(d
), "", AT_EMPTY_PATH
, STATX_MODE
|STATX_INO
|STATX_ATIME
|STATX_MTIME
, &sx
);
2504 return log_error_errno(r
, "statx(%s) failed: %m", instance
);
2506 if (FLAGS_SET(sx
.stx_attributes_mask
, STATX_ATTR_MOUNT_ROOT
))
2507 mountpoint
= FLAGS_SET(sx
.stx_attributes
, STATX_ATTR_MOUNT_ROOT
);
2511 if (fstatat(dirfd(d
), "..", &ps
, AT_SYMLINK_NOFOLLOW
) != 0)
2512 return log_error_errno(errno
, "stat(%s/..) failed: %m", i
->path
);
2515 sx
.stx_dev_major
!= major(ps
.st_dev
) ||
2516 sx
.stx_dev_minor
!= minor(ps
.st_dev
) ||
2517 sx
.stx_ino
!= ps
.st_ino
;
2520 if (DEBUG_LOGGING
) {
2521 _cleanup_free_
char *ab_f
= NULL
, *ab_d
= NULL
;
2523 ab_f
= age_by_to_string(i
->age_by_file
, false);
2527 ab_d
= age_by_to_string(i
->age_by_dir
, true);
2531 log_debug("Cleanup threshold for %s \"%s\" is %s; age-by: %s%s",
2532 mountpoint
? "mount point" : "directory",
2534 FORMAT_TIMESTAMP_STYLE(cutoff
, TIMESTAMP_US
),
2538 return dir_cleanup(i
, instance
, d
,
2539 load_statx_timestamp_nsec(&sx
.stx_atime
),
2540 load_statx_timestamp_nsec(&sx
.stx_mtime
),
2541 cutoff
* NSEC_PER_USEC
,
2542 sx
.stx_dev_major
, sx
.stx_dev_minor
, mountpoint
,
2543 MAX_DEPTH
, i
->keep_first_level
,
2544 i
->age_by_file
, i
->age_by_dir
);
2547 static int clean_item(Item
*i
) {
2550 log_debug("Running clean action for entry %c %s", (char) i
->type
, i
->path
);
2553 case CREATE_DIRECTORY
:
2554 case CREATE_SUBVOLUME
:
2555 case CREATE_SUBVOLUME_INHERIT_QUOTA
:
2556 case CREATE_SUBVOLUME_NEW_QUOTA
:
2557 case TRUNCATE_DIRECTORY
:
2560 clean_item_instance(i
, i
->path
);
2562 case EMPTY_DIRECTORY
:
2563 case IGNORE_DIRECTORY_PATH
:
2564 return glob_item(i
, clean_item_instance
);
2570 static int process_item(Item
*i
, OperationMask operation
) {
2572 _cleanup_free_
char *_path
= NULL
;
2578 todo
= operation
& ~i
->done
;
2579 if (todo
== 0) /* Everything already done? */
2582 i
->done
|= operation
;
2585 if (string_is_glob(path
)) {
2586 /* We can't easily check whether a glob matches any autofs path, so let's do the check only
2587 * for the non-glob part. */
2589 r
= glob_non_glob_prefix(path
, &_path
);
2590 if (r
< 0 && r
!= -ENOENT
)
2591 return log_debug_errno(r
, "Failed to deglob path: %m");
2596 r
= chase_symlinks(path
, arg_root
, CHASE_NO_AUTOFS
|CHASE_NONEXISTENT
|CHASE_WARN
, NULL
, NULL
);
2597 if (r
== -EREMOTE
) {
2598 log_notice_errno(r
, "Skipping %s", i
->path
); /* We log the configured path, to not confuse the user. */
2602 log_debug_errno(r
, "Failed to determine whether '%s' is below autofs, ignoring: %m", i
->path
);
2604 r
= FLAGS_SET(operation
, OPERATION_CREATE
) ? create_item(i
) : 0;
2605 /* Failure can only be tolerated for create */
2606 if (i
->allow_failure
)
2609 q
= FLAGS_SET(operation
, OPERATION_REMOVE
) ? remove_item(i
) : 0;
2610 p
= FLAGS_SET(operation
, OPERATION_CLEAN
) ? clean_item(i
) : 0;
2617 static int process_item_array(ItemArray
*array
, OperationMask operation
) {
2623 /* Create any parent first. */
2624 if (FLAGS_SET(operation
, OPERATION_CREATE
) && array
->parent
)
2625 r
= process_item_array(array
->parent
, operation
& OPERATION_CREATE
);
2627 /* Clean up all children first */
2628 if ((operation
& (OPERATION_REMOVE
|OPERATION_CLEAN
)) && !set_isempty(array
->children
)) {
2631 SET_FOREACH(c
, array
->children
) {
2634 k
= process_item_array(c
, operation
& (OPERATION_REMOVE
|OPERATION_CLEAN
));
2635 if (k
< 0 && r
== 0)
2640 for (n
= 0; n
< array
->n_items
; n
++) {
2643 k
= process_item(array
->items
+ n
, operation
);
2644 if (k
< 0 && r
== 0)
2651 static void item_free_contents(Item
*i
) {
2655 strv_free(i
->xattrs
);
2658 acl_free(i
->acl_access
);
2659 acl_free(i
->acl_default
);
2663 static ItemArray
* item_array_free(ItemArray
*a
) {
2669 for (n
= 0; n
< a
->n_items
; n
++)
2670 item_free_contents(a
->items
+ n
);
2672 set_free(a
->children
);
2677 static int item_compare(const Item
*a
, const Item
*b
) {
2678 /* Make sure that the ownership taking item is put first, so
2679 * that we first create the node, and then can adjust it */
2681 if (takes_ownership(a
->type
) && !takes_ownership(b
->type
))
2683 if (!takes_ownership(a
->type
) && takes_ownership(b
->type
))
2686 return CMP(a
->type
, b
->type
);
2689 static bool item_compatible(Item
*a
, Item
*b
) {
2692 assert(streq(a
->path
, b
->path
));
2694 if (takes_ownership(a
->type
) && takes_ownership(b
->type
))
2695 /* check if the items are the same */
2696 return streq_ptr(a
->argument
, b
->argument
) &&
2698 a
->uid_set
== b
->uid_set
&&
2701 a
->gid_set
== b
->gid_set
&&
2704 a
->mode_set
== b
->mode_set
&&
2705 a
->mode
== b
->mode
&&
2707 a
->age_set
== b
->age_set
&&
2710 a
->age_by_file
== b
->age_by_file
&&
2711 a
->age_by_dir
== b
->age_by_dir
&&
2713 a
->mask_perms
== b
->mask_perms
&&
2715 a
->keep_first_level
== b
->keep_first_level
&&
2717 a
->major_minor
== b
->major_minor
;
2722 static bool should_include_path(const char *path
) {
2725 STRV_FOREACH(prefix
, arg_exclude_prefixes
)
2726 if (path_startswith(path
, *prefix
)) {
2727 log_debug("Entry \"%s\" matches exclude prefix \"%s\", skipping.",
2732 STRV_FOREACH(prefix
, arg_include_prefixes
)
2733 if (path_startswith(path
, *prefix
)) {
2734 log_debug("Entry \"%s\" matches include prefix \"%s\".", path
, *prefix
);
2738 /* no matches, so we should include this path only if we have no allow list at all */
2739 if (strv_isempty(arg_include_prefixes
))
2742 log_debug("Entry \"%s\" does not match any include prefix, skipping.", path
);
2746 static int specifier_expansion_from_arg(Item
*i
) {
2756 case CREATE_SYMLINK
:
2760 _cleanup_free_
char *unescaped
= NULL
, *resolved
= NULL
;
2763 l
= cunescape(i
->argument
, 0, &unescaped
);
2765 return log_error_errno(l
, "Failed to unescape parameter to write: %s", i
->argument
);
2767 r
= specifier_printf(unescaped
, PATH_MAX
-1, specifier_table
, arg_root
, NULL
, &resolved
);
2771 return free_and_replace(i
->argument
, resolved
);
2774 case RECURSIVE_SET_XATTR
: {
2776 STRV_FOREACH(xattr
, i
->xattrs
) {
2777 _cleanup_free_
char *resolved
= NULL
;
2779 r
= specifier_printf(*xattr
, SIZE_MAX
, specifier_table
, arg_root
, NULL
, &resolved
);
2783 free_and_replace(*xattr
, resolved
);
2792 static int patch_var_run(const char *fname
, unsigned line
, char **path
) {
2799 /* Optionally rewrites lines referencing /var/run/, to use /run/ instead. Why bother? tmpfiles merges lines in
2800 * some cases and detects conflicts in others. If files/directories are specified through two equivalent lines
2801 * this is problematic as neither case will be detected. Ideally we'd detect these cases by resolving symlinks
2802 * early, but that's precisely not what we can do here as this code very likely is running very early on, at a
2803 * time where the paths in question are not available yet, or even more importantly, our own tmpfiles rules
2804 * might create the paths that are intermediary to the listed paths. We can't really cover the generic case,
2805 * but the least we can do is cover the specific case of /var/run vs. /run, as /var/run is a legacy name for
2806 * /run only, and we explicitly document that and require that on systemd systems the former is a symlink to
2807 * the latter. Moreover files below this path are by far the primary usecase for tmpfiles.d/. */
2809 k
= path_startswith(*path
, "/var/run/");
2810 if (isempty(k
)) /* Don't complain about other paths than /var/run, and not about /var/run itself either. */
2813 n
= path_join("/run", k
);
2817 /* Also log about this briefly. We do so at LOG_NOTICE level, as we fixed up the situation automatically, hence
2818 * there's no immediate need for action by the user. However, in the interest of making things less confusing
2819 * to the user, let's still inform the user that these snippets should really be updated. */
2820 log_syntax(NULL
, LOG_NOTICE
, fname
, line
, 0,
2821 "Line references path below legacy directory /var/run/, updating %s → %s; please update the tmpfiles.d/ drop-in file accordingly.",
2824 free_and_replace(*path
, n
);
2829 static int find_uid(const char *user
, uid_t
*ret_uid
, Hashmap
**cache
) {
2835 /* First: parse as numeric UID string */
2836 r
= parse_uid(user
, ret_uid
);
2840 /* Second: pass to NSS if we are running "online" */
2842 return get_user_creds(&user
, ret_uid
, NULL
, NULL
, NULL
, 0);
2844 /* Third, synthesize "root" unconditionally */
2845 if (streq(user
, "root")) {
2850 /* Fourth: use fgetpwent() to read /etc/passwd directly, if we are "offline" */
2851 return name_to_uid_offline(arg_root
, user
, ret_uid
, cache
);
2854 static int find_gid(const char *group
, gid_t
*ret_gid
, Hashmap
**cache
) {
2860 /* First: parse as numeric GID string */
2861 r
= parse_gid(group
, ret_gid
);
2865 /* Second: pass to NSS if we are running "online" */
2867 return get_group_creds(&group
, ret_gid
, 0);
2869 /* Third, synthesize "root" unconditionally */
2870 if (streq(group
, "root")) {
2875 /* Fourth: use fgetgrent() to read /etc/group directly, if we are "offline" */
2876 return name_to_gid_offline(arg_root
, group
, ret_gid
, cache
);
2879 static int parse_age_by_from_arg(const char *age_by_str
, Item
*item
) {
2880 AgeBy ab_f
= 0, ab_d
= 0;
2882 static const struct {
2885 } age_by_types
[] = {
2886 { 'a', AGE_BY_ATIME
},
2887 { 'b', AGE_BY_BTIME
},
2888 { 'c', AGE_BY_CTIME
},
2889 { 'm', AGE_BY_MTIME
},
2895 if (isempty(age_by_str
))
2898 for (const char *s
= age_by_str
; *s
!= 0; s
++) {
2901 /* Ignore whitespace. */
2902 if (strchr(WHITESPACE
, *s
))
2905 for (i
= 0; i
< ELEMENTSOF(age_by_types
); i
++) {
2906 /* Check lower-case for files, upper-case for directories. */
2907 if (*s
== age_by_types
[i
].age_by_chr
) {
2908 ab_f
|= age_by_types
[i
].age_by_flag
;
2910 } else if (*s
== ascii_toupper(age_by_types
[i
].age_by_chr
)) {
2911 ab_d
|= age_by_types
[i
].age_by_flag
;
2916 /* Invalid character. */
2917 if (i
>= ELEMENTSOF(age_by_types
))
2922 if (ab_f
== 0 && ab_d
== 0)
2925 item
->age_by_file
= ab_f
> 0 ? ab_f
: AGE_BY_DEFAULT_FILE
;
2926 item
->age_by_dir
= ab_d
> 0 ? ab_d
: AGE_BY_DEFAULT_DIR
;
2931 static int parse_line(
2935 bool *invalid_config
,
2936 Hashmap
**uid_cache
,
2937 Hashmap
**gid_cache
) {
2939 _cleanup_free_
char *action
= NULL
, *mode
= NULL
, *user
= NULL
, *group
= NULL
, *age
= NULL
, *path
= NULL
;
2940 _cleanup_(item_free_contents
) Item i
= {
2941 /* The "age-by" argument considers all file timestamp types by default. */
2942 .age_by_file
= AGE_BY_DEFAULT_FILE
,
2943 .age_by_dir
= AGE_BY_DEFAULT_DIR
,
2945 ItemArray
*existing
;
2948 bool append_or_force
= false, boot
= false, allow_failure
= false, try_replace
= false;
2954 r
= extract_many_words(
2966 if (IN_SET(r
, -EINVAL
, -EBADSLT
))
2967 /* invalid quoting and such or an unknown specifier */
2968 *invalid_config
= true;
2969 return log_syntax(NULL
, LOG_ERR
, fname
, line
, r
, "Failed to parse line: %m");
2971 *invalid_config
= true;
2972 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
), "Syntax error.");
2975 if (!empty_or_dash(buffer
)) {
2976 i
.argument
= strdup(buffer
);
2981 if (isempty(action
)) {
2982 *invalid_config
= true;
2983 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
), "Command too short '%s'.", action
);
2986 for (pos
= 1; action
[pos
]; pos
++) {
2987 if (action
[pos
] == '!' && !boot
)
2989 else if (action
[pos
] == '+' && !append_or_force
)
2990 append_or_force
= true;
2991 else if (action
[pos
] == '-' && !allow_failure
)
2992 allow_failure
= true;
2993 else if (action
[pos
] == '=' && !try_replace
)
2996 *invalid_config
= true;
2997 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
), "Unknown modifiers in command '%s'", action
);
3001 if (boot
&& !arg_boot
) {
3002 log_syntax(NULL
, LOG_DEBUG
, fname
, line
, 0, "Ignoring entry %s \"%s\" because --boot is not specified.", action
, path
);
3007 i
.append_or_force
= append_or_force
;
3008 i
.allow_failure
= allow_failure
;
3009 i
.try_replace
= try_replace
;
3011 r
= specifier_printf(path
, PATH_MAX
-1, specifier_table
, arg_root
, NULL
, &i
.path
);
3013 return log_unresolvable_specifier(fname
, line
);
3015 if (IN_SET(r
, -EINVAL
, -EBADSLT
))
3016 *invalid_config
= true;
3017 return log_syntax(NULL
, LOG_ERR
, fname
, line
, r
, "Failed to replace specifiers in '%s': %m", path
);
3020 r
= patch_var_run(fname
, line
, &i
.path
);
3026 case CREATE_DIRECTORY
:
3027 case CREATE_SUBVOLUME
:
3028 case CREATE_SUBVOLUME_INHERIT_QUOTA
:
3029 case CREATE_SUBVOLUME_NEW_QUOTA
:
3030 case EMPTY_DIRECTORY
:
3031 case TRUNCATE_DIRECTORY
:
3034 case IGNORE_DIRECTORY_PATH
:
3036 case RECURSIVE_REMOVE_PATH
:
3039 case RECURSIVE_RELABEL_PATH
:
3041 log_syntax(NULL
, LOG_WARNING
, fname
, line
, 0, "%c lines don't take argument fields, ignoring.", i
.type
);
3049 case CREATE_SYMLINK
:
3051 i
.argument
= path_join("/usr/share/factory", i
.path
);
3059 *invalid_config
= true;
3060 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
), "Write file requires argument.");
3066 i
.argument
= path_join("/usr/share/factory", i
.path
);
3070 } else if (!path_is_absolute(i
.argument
)) {
3071 *invalid_config
= true;
3072 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
), "Source path '%s' is not absolute.", i
.argument
);
3076 if (!empty_or_root(arg_root
)) {
3079 p
= path_join(arg_root
, i
.argument
);
3082 free_and_replace(i
.argument
, p
);
3085 path_simplify(i
.argument
);
3088 case CREATE_CHAR_DEVICE
:
3089 case CREATE_BLOCK_DEVICE
:
3091 *invalid_config
= true;
3092 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
), "Device file requires argument.");
3095 r
= parse_dev(i
.argument
, &i
.major_minor
);
3097 *invalid_config
= true;
3098 return log_syntax(NULL
, LOG_ERR
, fname
, line
, r
, "Can't parse device file major/minor '%s'.", i
.argument
);
3104 case RECURSIVE_SET_XATTR
:
3106 *invalid_config
= true;
3107 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
),
3108 "Set extended attribute requires argument.");
3110 r
= parse_xattrs_from_arg(&i
);
3116 case RECURSIVE_SET_ACL
:
3118 *invalid_config
= true;
3119 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
),
3120 "Set ACLs requires argument.");
3122 r
= parse_acls_from_arg(&i
);
3128 case RECURSIVE_SET_ATTRIBUTE
:
3130 *invalid_config
= true;
3131 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
),
3132 "Set file attribute requires argument.");
3134 r
= parse_attribute_from_arg(&i
);
3135 if (IN_SET(r
, -EINVAL
, -EBADSLT
))
3136 *invalid_config
= true;
3142 *invalid_config
= true;
3143 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
),
3144 "Unknown command type '%c'.", (char) i
.type
);
3147 if (!path_is_absolute(i
.path
)) {
3148 *invalid_config
= true;
3149 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
),
3150 "Path '%s' not absolute.", i
.path
);
3153 path_simplify(i
.path
);
3155 if (!should_include_path(i
.path
))
3158 r
= specifier_expansion_from_arg(&i
);
3160 return log_unresolvable_specifier(fname
, line
);
3162 if (IN_SET(r
, -EINVAL
, -EBADSLT
))
3163 *invalid_config
= true;
3164 return log_syntax(NULL
, LOG_ERR
, fname
, line
, r
, "Failed to substitute specifiers in argument: %m");
3167 if (!empty_or_root(arg_root
)) {
3170 p
= path_join(arg_root
, i
.path
);
3173 free_and_replace(i
.path
, p
);
3176 if (!empty_or_dash(user
)) {
3177 r
= find_uid(user
, &i
.uid
, uid_cache
);
3179 *invalid_config
= true;
3180 return log_syntax(NULL
, LOG_ERR
, fname
, line
, r
, "Failed to resolve user '%s': %m", user
);
3186 if (!empty_or_dash(group
)) {
3187 r
= find_gid(group
, &i
.gid
, gid_cache
);
3189 *invalid_config
= true;
3190 return log_syntax(NULL
, LOG_ERR
, fname
, line
, r
, "Failed to resolve group '%s'.", group
);
3196 if (!empty_or_dash(mode
)) {
3197 const char *mm
= mode
;
3201 i
.mask_perms
= true;
3205 r
= parse_mode(mm
, &m
);
3207 *invalid_config
= true;
3208 return log_syntax(NULL
, LOG_ERR
, fname
, line
, r
, "Invalid mode '%s'.", mode
);
3214 i
.mode
= IN_SET(i
.type
, CREATE_DIRECTORY
, TRUNCATE_DIRECTORY
, CREATE_SUBVOLUME
, CREATE_SUBVOLUME_INHERIT_QUOTA
, CREATE_SUBVOLUME_NEW_QUOTA
) ? 0755 : 0644;
3216 if (!empty_or_dash(age
)) {
3217 const char *a
= age
;
3218 _cleanup_free_
char *seconds
= NULL
, *age_by
= NULL
;
3221 i
.keep_first_level
= true;
3225 /* Format: "age-by:age"; where age-by is "[abcmABCM]+". */
3226 r
= split_pair(a
, ":", &age_by
, &seconds
);
3229 if (r
< 0 && r
!= -EINVAL
)
3230 return log_error_errno(r
, "Failed to parse age-by for '%s': %m", age
);
3232 /* We found a ":", parse the "age-by" part. */
3233 r
= parse_age_by_from_arg(age_by
, &i
);
3237 *invalid_config
= true;
3238 return log_syntax(NULL
, LOG_ERR
, fname
, line
, r
, "Invalid age-by '%s'.", age_by
);
3241 /* For parsing the "age" part, after the ":". */
3245 r
= parse_sec(a
, &i
.age
);
3247 *invalid_config
= true;
3248 return log_syntax(NULL
, LOG_ERR
, fname
, line
, r
, "Invalid age '%s'.", a
);
3254 h
= needs_glob(i
.type
) ? globs
: items
;
3256 existing
= ordered_hashmap_get(h
, i
.path
);
3260 for (n
= 0; n
< existing
->n_items
; n
++) {
3261 if (!item_compatible(existing
->items
+ n
, &i
) && !i
.append_or_force
) {
3262 log_syntax(NULL
, LOG_NOTICE
, fname
, line
, 0, "Duplicate line for path \"%s\", ignoring.", i
.path
);
3267 existing
= new0(ItemArray
, 1);
3271 r
= ordered_hashmap_put(h
, i
.path
, existing
);
3278 if (!GREEDY_REALLOC(existing
->items
, existing
->n_items
+ 1))
3281 existing
->items
[existing
->n_items
++] = i
;
3282 i
= (struct Item
) {};
3284 /* Sort item array, to enforce stable ordering of application */
3285 typesafe_qsort(existing
->items
, existing
->n_items
, item_compare
);
3290 static int cat_config(char **config_dirs
, char **args
) {
3291 _cleanup_strv_free_
char **files
= NULL
;
3294 r
= conf_files_list_with_replacement(arg_root
, config_dirs
, arg_replace
, &files
, NULL
);
3298 return cat_files(NULL
, files
, 0);
3301 static int exclude_default_prefixes(void) {
3304 /* Provide an easy way to exclude virtual/memory file systems from what we do here. Useful in
3305 * combination with --root= where we probably don't want to apply stuff to these dirs as they are
3306 * likely over-mounted if the root directory is actually used, and it wouldbe less than ideal to have
3307 * all kinds of files created/adjusted underneath these mount points. */
3309 r
= strv_extend_strv(
3310 &arg_exclude_prefixes
,
3322 static int help(void) {
3323 _cleanup_free_
char *link
= NULL
;
3326 r
= terminal_urlify_man("systemd-tmpfiles", "8", &link
);
3330 printf("%s [OPTIONS...] [CONFIGURATION FILE...]\n"
3331 "\n%sCreates, deletes and cleans up volatile and temporary files and directories.%s\n\n"
3332 " -h --help Show this help\n"
3333 " --user Execute user configuration\n"
3334 " --version Show package version\n"
3335 " --cat-config Show configuration files\n"
3336 " --create Create marked files/directories\n"
3337 " --clean Clean up marked directories\n"
3338 " --remove Remove marked files/directories\n"
3339 " --boot Execute actions only safe at boot\n"
3340 " --prefix=PATH Only apply rules with the specified prefix\n"
3341 " --exclude-prefix=PATH Ignore rules with the specified prefix\n"
3342 " -E Ignore rules prefixed with /dev, /proc, /run, /sys\n"
3343 " --root=PATH Operate on an alternate filesystem root\n"
3344 " --image=PATH Operate on disk image as filesystem root\n"
3345 " --replace=PATH Treat arguments as replacement for PATH\n"
3346 " --no-pager Do not pipe output into a pager\n"
3347 "\nSee the %s for details.\n",
3348 program_invocation_short_name
,
3356 static int parse_argv(int argc
, char *argv
[]) {
3359 ARG_VERSION
= 0x100,
3374 static const struct option options
[] = {
3375 { "help", no_argument
, NULL
, 'h' },
3376 { "user", no_argument
, NULL
, ARG_USER
},
3377 { "version", no_argument
, NULL
, ARG_VERSION
},
3378 { "cat-config", no_argument
, NULL
, ARG_CAT_CONFIG
},
3379 { "create", no_argument
, NULL
, ARG_CREATE
},
3380 { "clean", no_argument
, NULL
, ARG_CLEAN
},
3381 { "remove", no_argument
, NULL
, ARG_REMOVE
},
3382 { "boot", no_argument
, NULL
, ARG_BOOT
},
3383 { "prefix", required_argument
, NULL
, ARG_PREFIX
},
3384 { "exclude-prefix", required_argument
, NULL
, ARG_EXCLUDE_PREFIX
},
3385 { "root", required_argument
, NULL
, ARG_ROOT
},
3386 { "image", required_argument
, NULL
, ARG_IMAGE
},
3387 { "replace", required_argument
, NULL
, ARG_REPLACE
},
3388 { "no-pager", no_argument
, NULL
, ARG_NO_PAGER
},
3397 while ((c
= getopt_long(argc
, argv
, "hE", options
, NULL
)) >= 0)
3407 case ARG_CAT_CONFIG
:
3408 arg_cat_config
= true;
3416 arg_operation
|= OPERATION_CREATE
;
3420 arg_operation
|= OPERATION_CLEAN
;
3424 arg_operation
|= OPERATION_REMOVE
;
3432 if (strv_push(&arg_include_prefixes
, optarg
) < 0)
3436 case ARG_EXCLUDE_PREFIX
:
3437 if (strv_push(&arg_exclude_prefixes
, optarg
) < 0)
3442 r
= parse_path_argument(optarg
, /* suppress_root= */ false, &arg_root
);
3449 return log_error_errno(SYNTHETIC_ERRNO(EOPNOTSUPP
),
3450 "This systemd-tmpfiles version is compiled without support for --image=.");
3452 r
= parse_path_argument(optarg
, /* suppress_root= */ false, &arg_image
);
3456 /* Imply -E here since it makes little sense to create files persistently in the /run mountpoint of a disk image */
3460 r
= exclude_default_prefixes();
3467 if (!path_is_absolute(optarg
) ||
3468 !endswith(optarg
, ".conf"))
3469 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
3470 "The argument to --replace= must an absolute path to a config file");
3472 arg_replace
= optarg
;
3476 arg_pager_flags
|= PAGER_DISABLE
;
3483 assert_not_reached();
3486 if (arg_operation
== 0 && !arg_cat_config
)
3487 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
3488 "You need to specify at least one of --clean, --create or --remove.");
3490 if (arg_replace
&& arg_cat_config
)
3491 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
3492 "Option --replace= is not supported with --cat-config");
3494 if (arg_replace
&& optind
>= argc
)
3495 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
3496 "When --replace= is given, some configuration items must be specified");
3498 if (arg_root
&& arg_user
)
3499 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
3500 "Combination of --user and --root= is not supported.");
3502 if (arg_image
&& arg_root
)
3503 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Please specify either --root= or --image=, the combination of both is not supported.");
3508 static int read_config_file(char **config_dirs
, const char *fn
, bool ignore_enoent
, bool *invalid_config
) {
3509 _cleanup_(hashmap_freep
) Hashmap
*uid_cache
= NULL
, *gid_cache
= NULL
;
3510 _cleanup_fclose_
FILE *_f
= NULL
;
3511 _cleanup_free_
char *pp
= NULL
;
3519 if (streq(fn
, "-")) {
3520 log_debug("Reading config from stdin…");
3524 r
= search_and_fopen(fn
, "re", arg_root
, (const char**) config_dirs
, &_f
, &pp
);
3526 if (ignore_enoent
&& r
== -ENOENT
) {
3527 log_debug_errno(r
, "Failed to open \"%s\", ignoring: %m", fn
);
3531 return log_error_errno(r
, "Failed to open '%s': %m", fn
);
3534 log_debug("Reading config file \"%s\"…", pp
);
3540 _cleanup_free_
char *line
= NULL
;
3541 bool invalid_line
= false;
3545 k
= read_line(f
, LONG_LINE_MAX
, &line
);
3547 return log_error_errno(k
, "Failed to read '%s': %m", fn
);
3554 if (IN_SET(*l
, 0, '#'))
3557 k
= parse_line(fn
, v
, l
, &invalid_line
, &uid_cache
, &gid_cache
);
3560 /* Allow reporting with a special code if the caller requested this */
3561 *invalid_config
= true;
3563 /* The first error becomes our return value */
3568 /* we have to determine age parameter for each entry of type X */
3569 ORDERED_HASHMAP_FOREACH(ia
, globs
)
3570 for (size_t ni
= 0; ni
< ia
->n_items
; ni
++) {
3572 Item
*i
= ia
->items
+ ni
, *candidate_item
= NULL
;
3574 if (i
->type
!= IGNORE_DIRECTORY_PATH
)
3577 ORDERED_HASHMAP_FOREACH(ja
, items
)
3578 for (size_t nj
= 0; nj
< ja
->n_items
; nj
++) {
3579 Item
*j
= ja
->items
+ nj
;
3581 if (!IN_SET(j
->type
, CREATE_DIRECTORY
,
3584 CREATE_SUBVOLUME_INHERIT_QUOTA
,
3585 CREATE_SUBVOLUME_NEW_QUOTA
))
3588 if (path_equal(j
->path
, i
->path
)) {
3594 ? (path_startswith(j
->path
, candidate_item
->path
) && fnmatch(i
->path
, j
->path
, FNM_PATHNAME
| FNM_PERIOD
) == 0)
3595 : path_startswith(i
->path
, j
->path
) != NULL
)
3599 if (candidate_item
&& candidate_item
->age_set
) {
3600 i
->age
= candidate_item
->age
;
3606 log_error_errno(errno
, "Failed to read from file %s: %m", fn
);
3614 static int parse_arguments(char **config_dirs
, char **args
, bool *invalid_config
) {
3618 STRV_FOREACH(arg
, args
) {
3619 r
= read_config_file(config_dirs
, *arg
, false, invalid_config
);
3627 static int read_config_files(char **config_dirs
, char **args
, bool *invalid_config
) {
3628 _cleanup_strv_free_
char **files
= NULL
;
3629 _cleanup_free_
char *p
= NULL
;
3633 r
= conf_files_list_with_replacement(arg_root
, config_dirs
, arg_replace
, &files
, &p
);
3637 STRV_FOREACH(f
, files
)
3638 if (p
&& path_equal(*f
, p
)) {
3639 log_debug("Parsing arguments at position \"%s\"…", *f
);
3641 r
= parse_arguments(config_dirs
, args
, invalid_config
);
3645 /* Just warn, ignore result otherwise.
3646 * read_config_file() has some debug output, so no need to print anything. */
3647 (void) read_config_file(config_dirs
, *f
, true, invalid_config
);
3652 static int link_parent(ItemArray
*a
) {
3659 /* Finds the closest "parent" item array for the specified item array. Then registers the specified item array
3660 * as child of it, and fills the parent in, linking them both ways. This allows us to later create parents
3661 * before their children, and clean up/remove children before their parents. */
3663 if (a
->n_items
<= 0)
3666 path
= a
->items
[0].path
;
3667 prefix
= newa(char, strlen(path
) + 1);
3668 PATH_FOREACH_PREFIX(prefix
, path
) {
3671 j
= ordered_hashmap_get(items
, prefix
);
3673 j
= ordered_hashmap_get(globs
, prefix
);
3675 r
= set_ensure_put(&j
->children
, NULL
, a
);
3687 DEFINE_PRIVATE_HASH_OPS_WITH_VALUE_DESTRUCTOR(item_array_hash_ops
, char, string_hash_func
, string_compare_func
,
3688 ItemArray
, item_array_free
);
3690 static int run(int argc
, char *argv
[]) {
3692 _cleanup_(loop_device_unrefp
) LoopDevice
*loop_device
= NULL
;
3693 _cleanup_(decrypted_image_unrefp
) DecryptedImage
*decrypted_image
= NULL
;
3694 _cleanup_(umount_and_rmdir_and_freep
) char *unlink_dir
= NULL
;
3696 _cleanup_strv_free_
char **config_dirs
= NULL
;
3697 bool invalid_config
= false;
3700 PHASE_REMOVE_AND_CLEAN
,
3706 r
= parse_argv(argc
, argv
);
3712 /* We require /proc/ for a lot of our operations, i.e. for adjusting access modes, for anything
3713 * SELinux related, for recursive operation, for xattr, acl and chattr handling, for btrfs stuff and
3714 * a lot more. It's probably the majority of invocations where /proc/ is required. Since people
3715 * apparently invoke it without anyway and are surprised about the failures, let's catch this early
3716 * and output a nice and friendly warning. */
3717 if (proc_mounted() == 0)
3718 return log_error_errno(SYNTHETIC_ERRNO(ENOSYS
),
3719 "/proc/ is not mounted, but required for successful operation of systemd-tmpfiles. "
3720 "Please mount /proc/. Alternatively, consider using the --root= or --image= switches.");
3722 /* Descending down file system trees might take a lot of fds */
3723 (void) rlimit_nofile_bump(HIGH_RLIMIT_NOFILE
);
3726 r
= user_config_paths(&config_dirs
);
3728 return log_error_errno(r
, "Failed to initialize configuration directory list: %m");
3730 config_dirs
= strv_split_nulstr(CONF_PATHS_NULSTR("tmpfiles.d"));
3735 if (DEBUG_LOGGING
) {
3736 _cleanup_free_
char *t
= NULL
;
3739 STRV_FOREACH(i
, config_dirs
) {
3740 _cleanup_free_
char *j
= NULL
;
3742 j
= path_join(arg_root
, *i
);
3746 if (!strextend(&t
, "\n\t", j
))
3750 log_debug("Looking for configuration files in (higher priority first):%s", t
);
3753 if (arg_cat_config
) {
3754 pager_open(arg_pager_flags
);
3756 return cat_config(config_dirs
, argv
+ optind
);
3761 r
= mac_selinux_init();
3769 r
= mount_image_privately_interactively(
3771 DISSECT_IMAGE_GENERIC_ROOT
|
3772 DISSECT_IMAGE_REQUIRE_ROOT
|
3773 DISSECT_IMAGE_VALIDATE_OS
|
3774 DISSECT_IMAGE_RELAX_VAR_CHECK
|
3775 DISSECT_IMAGE_FSCK
|
3776 DISSECT_IMAGE_GROWFS
,
3783 arg_root
= strdup(unlink_dir
);
3791 items
= ordered_hashmap_new(&item_array_hash_ops
);
3792 globs
= ordered_hashmap_new(&item_array_hash_ops
);
3793 if (!items
|| !globs
)
3796 /* If command line arguments are specified along with --replace, read all
3797 * configuration files and insert the positional arguments at the specified
3798 * place. Otherwise, if command line arguments are specified, execute just
3799 * them, and finally, without --replace= or any positional arguments, just
3800 * read configuration and execute it.
3802 if (arg_replace
|| optind
>= argc
)
3803 r
= read_config_files(config_dirs
, argv
+ optind
, &invalid_config
);
3805 r
= parse_arguments(config_dirs
, argv
+ optind
, &invalid_config
);
3809 /* Let's now link up all child/parent relationships */
3810 ORDERED_HASHMAP_FOREACH(a
, items
) {
3815 ORDERED_HASHMAP_FOREACH(a
, globs
) {
3821 /* If multiple operations are requested, let's first run the remove/clean operations, and only then the create
3822 * operations. i.e. that we first clean out the platform we then build on. */
3823 for (phase
= 0; phase
< _PHASE_MAX
; phase
++) {
3826 if (phase
== PHASE_REMOVE_AND_CLEAN
)
3827 op
= arg_operation
& (OPERATION_REMOVE
|OPERATION_CLEAN
);
3828 else if (phase
== PHASE_CREATE
)
3829 op
= arg_operation
& OPERATION_CREATE
;
3831 assert_not_reached();
3833 if (op
== 0) /* Nothing requested in this phase */
3836 /* The non-globbing ones usually create things, hence we apply them first */
3837 ORDERED_HASHMAP_FOREACH(a
, items
) {
3838 k
= process_item_array(a
, op
);
3839 if (k
< 0 && r
>= 0)
3843 /* The globbing ones usually alter things, hence we apply them second. */
3844 ORDERED_HASHMAP_FOREACH(a
, globs
) {
3845 k
= process_item_array(a
, op
);
3846 if (k
< 0 && r
>= 0)
3851 if (ERRNO_IS_RESOURCE(r
))
3856 return EX_CANTCREAT
;
3860 DEFINE_MAIN_FUNCTION_WITH_POSITIVE_FAILURE(run
);