1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
13 #include <sys/xattr.h>
21 #include "alloc-util.h"
22 #include "btrfs-util.h"
24 #include "capability-util.h"
26 #include "chattr-util.h"
27 #include "conf-files.h"
28 #include "constants.h"
30 #include "creds-util.h"
31 #include "devnum-util.h"
32 #include "dirent-util.h"
33 #include "dissect-image.h"
35 #include "errno-util.h"
39 #include "format-util.h"
41 #include "glob-util.h"
42 #include "hexdecoct.h"
44 #include "label-util.h"
47 #include "main-func.h"
48 #include "missing_syscall.h"
49 #include "mkdir-label.h"
50 #include "mount-util.h"
51 #include "mountpoint-util.h"
52 #include "nulstr-util.h"
53 #include "offline-passwd.h"
55 #include "parse-argument.h"
56 #include "parse-util.h"
57 #include "path-lookup.h"
58 #include "path-util.h"
59 #include "pretty-print.h"
60 #include "rlimit-util.h"
62 #include "selinux-util.h"
64 #include "sort-util.h"
65 #include "specifier.h"
66 #include "stat-util.h"
67 #include "stdio-util.h"
68 #include "string-table.h"
69 #include "string-util.h"
71 #include "terminal-util.h"
72 #include "umask-util.h"
73 #include "user-util.h"
76 /* This reads all files listed in /etc/tmpfiles.d/?*.conf and creates
77 * them in the file system. This is intended to be used to create
78 * properly owned directories beneath /tmp, /var/tmp, /run, which are
79 * volatile and hence need to be recreated on bootup. */
81 typedef enum OperationMask
{
82 OPERATION_CREATE
= 1 << 0,
83 OPERATION_REMOVE
= 1 << 1,
84 OPERATION_CLEAN
= 1 << 2,
85 OPERATION_PURGE
= 1 << 3,
88 typedef enum ItemType
{
89 /* These ones take file names */
91 TRUNCATE_FILE
= 'F', /* deprecated: use f+ */
92 CREATE_DIRECTORY
= 'd',
93 TRUNCATE_DIRECTORY
= 'D',
94 CREATE_SUBVOLUME
= 'v',
95 CREATE_SUBVOLUME_INHERIT_QUOTA
= 'q',
96 CREATE_SUBVOLUME_NEW_QUOTA
= 'Q',
99 CREATE_CHAR_DEVICE
= 'c',
100 CREATE_BLOCK_DEVICE
= 'b',
103 /* These ones take globs */
105 EMPTY_DIRECTORY
= 'e',
107 RECURSIVE_SET_XATTR
= 'T',
109 RECURSIVE_SET_ACL
= 'A',
111 RECURSIVE_SET_ATTRIBUTE
= 'H',
113 IGNORE_DIRECTORY_PATH
= 'X',
115 RECURSIVE_REMOVE_PATH
= 'R',
117 RECURSIVE_RELABEL_PATH
= 'Z',
118 ADJUST_MODE
= 'm', /* legacy, 'z' is identical to this */
122 AGE_BY_ATIME
= 1 << 0,
123 AGE_BY_BTIME
= 1 << 1,
124 AGE_BY_CTIME
= 1 << 2,
125 AGE_BY_MTIME
= 1 << 3,
127 /* All file timestamp types are checked by default. */
128 AGE_BY_DEFAULT_FILE
= AGE_BY_ATIME
| AGE_BY_BTIME
| AGE_BY_CTIME
| AGE_BY_MTIME
,
129 AGE_BY_DEFAULT_DIR
= AGE_BY_ATIME
| AGE_BY_BTIME
| AGE_BY_MTIME
,
132 typedef struct Item
{
137 void *binary_argument
; /* set if binary data, in which case it takes precedence over 'argument' */
138 size_t binary_argument_size
;
142 acl_t acl_access_exec
;
149 AgeBy age_by_file
, age_by_dir
;
152 unsigned attribute_value
;
153 unsigned attribute_mask
;
158 bool uid_only_create
:1;
159 bool gid_only_create
:1;
160 bool mode_only_create
:1;
163 bool attribute_set
:1;
165 bool keep_first_level
:1;
167 bool append_or_force
:1;
169 bool allow_failure
:1;
176 typedef struct ItemArray
{
180 struct ItemArray
*parent
;
184 typedef enum DirectoryType
{
197 _CREATION_MODE_INVALID
= -EINVAL
,
200 static CatFlags arg_cat_flags
= CAT_CONFIG_OFF
;
201 static RuntimeScope arg_runtime_scope
= RUNTIME_SCOPE_SYSTEM
;
202 static OperationMask arg_operation
= 0;
203 static bool arg_boot
= false;
204 static bool arg_graceful
= false;
205 static PagerFlags arg_pager_flags
= 0;
207 static char **arg_include_prefixes
= NULL
;
208 static char **arg_exclude_prefixes
= NULL
;
209 static char *arg_root
= NULL
;
210 static char *arg_image
= NULL
;
211 static char *arg_replace
= NULL
;
212 static ImagePolicy
*arg_image_policy
= NULL
;
214 #define MAX_DEPTH 256
216 typedef struct Context
{
217 OrderedHashmap
*items
, *globs
;
221 STATIC_DESTRUCTOR_REGISTER(arg_include_prefixes
, strv_freep
);
222 STATIC_DESTRUCTOR_REGISTER(arg_exclude_prefixes
, strv_freep
);
223 STATIC_DESTRUCTOR_REGISTER(arg_root
, freep
);
224 STATIC_DESTRUCTOR_REGISTER(arg_image
, freep
);
225 STATIC_DESTRUCTOR_REGISTER(arg_image_policy
, image_policy_freep
);
227 static const char *const creation_mode_verb_table
[_CREATION_MODE_MAX
] = {
228 [CREATION_NORMAL
] = "Created",
229 [CREATION_EXISTING
] = "Found existing",
230 [CREATION_FORCE
] = "Created replacement",
233 DEFINE_PRIVATE_STRING_TABLE_LOOKUP_TO_STRING(creation_mode_verb
, CreationMode
);
235 static void context_done(Context
*c
) {
238 ordered_hashmap_free(c
->items
);
239 ordered_hashmap_free(c
->globs
);
241 set_free(c
->unix_sockets
);
244 /* Different kinds of errors that mean that information is not available in the environment. */
245 static bool ERRNO_IS_NOINFO(int r
) {
246 return IN_SET(abs(r
),
247 EUNATCH
, /* os-release or machine-id missing */
248 ENOMEDIUM
, /* machine-id or another file empty */
249 ENOPKG
, /* machine-id is uninitialized */
250 ENXIO
); /* env var is unset */
253 static int specifier_directory(char specifier
, const void *data
, const char *root
, const void *userdata
, char **ret
) {
259 static const struct table_entry paths_system
[] = {
260 [DIRECTORY_RUNTIME
] = { SD_PATH_SYSTEM_RUNTIME
},
261 [DIRECTORY_STATE
] = { SD_PATH_SYSTEM_STATE_PRIVATE
},
262 [DIRECTORY_CACHE
] = { SD_PATH_SYSTEM_STATE_CACHE
},
263 [DIRECTORY_LOGS
] = { SD_PATH_SYSTEM_STATE_LOGS
},
266 static const struct table_entry paths_user
[] = {
267 [DIRECTORY_RUNTIME
] = { SD_PATH_USER_RUNTIME
},
268 [DIRECTORY_STATE
] = { SD_PATH_USER_STATE_PRIVATE
},
269 [DIRECTORY_CACHE
] = { SD_PATH_USER_STATE_CACHE
},
270 [DIRECTORY_LOGS
] = { SD_PATH_USER_STATE_PRIVATE
, "log" },
273 const struct table_entry
*paths
;
274 _cleanup_free_
char *p
= NULL
;
278 assert_cc(ELEMENTSOF(paths_system
) == ELEMENTSOF(paths_user
));
279 paths
= arg_runtime_scope
== RUNTIME_SCOPE_USER
? paths_user
: paths_system
;
281 i
= PTR_TO_UINT(data
);
282 assert(i
< ELEMENTSOF(paths_system
));
284 r
= sd_path_lookup(paths
[i
].type
, paths
[i
].suffix
, &p
);
289 _cleanup_free_
char *j
= NULL
;
291 j
= path_join(arg_root
, p
);
302 static int log_unresolvable_specifier(const char *filename
, unsigned line
) {
303 static bool notified
= false;
305 /* In system mode, this is called when /etc is not fully initialized and some specifiers are
306 * unresolvable. In user mode, this is called when some variables are not defined. These cases are
307 * not considered a fatal error, so log at LOG_NOTICE only for the first time and then downgrade this
308 * to LOG_DEBUG for the rest.
310 * If we're running in a chroot (--root was used or sd_booted() reports that systemd is not running),
311 * always use LOG_DEBUG. We may be called to initialize a chroot before booting and there is no
312 * expectation that machine-id and other files will be populated.
315 int log_level
= notified
|| arg_root
|| running_in_chroot() > 0 ?
316 LOG_DEBUG
: LOG_NOTICE
;
321 "Failed to resolve specifier: %s, skipping.",
322 arg_runtime_scope
== RUNTIME_SCOPE_USER
? "Required $XDG_... variable not defined" : "uninitialized /etc/ detected");
326 "All rules containing unresolvable specifiers will be skipped.");
332 static int user_config_paths(char*** ret
) {
333 _cleanup_strv_free_
char **config_dirs
= NULL
, **data_dirs
= NULL
;
334 _cleanup_free_
char *persistent_config
= NULL
, *runtime_config
= NULL
, *data_home
= NULL
;
335 _cleanup_strv_free_
char **res
= NULL
;
338 r
= xdg_user_dirs(&config_dirs
, &data_dirs
);
342 r
= xdg_user_config_dir(&persistent_config
, "/user-tmpfiles.d");
343 if (r
< 0 && !ERRNO_IS_NOINFO(r
))
346 r
= xdg_user_runtime_dir(&runtime_config
, "/user-tmpfiles.d");
347 if (r
< 0 && !ERRNO_IS_NOINFO(r
))
350 r
= xdg_user_data_dir(&data_home
, "/user-tmpfiles.d");
351 if (r
< 0 && !ERRNO_IS_NOINFO(r
))
354 r
= strv_extend_strv_concat(&res
, config_dirs
, "/user-tmpfiles.d");
358 r
= strv_extend_many(
366 r
= strv_extend_strv_concat(&res
, data_dirs
, "/user-tmpfiles.d");
370 r
= path_strv_make_absolute_cwd(res
);
374 *ret
= TAKE_PTR(res
);
378 static bool needs_purge(ItemType t
) {
386 CREATE_SUBVOLUME_INHERIT_QUOTA
,
387 CREATE_SUBVOLUME_NEW_QUOTA
,
396 static bool needs_glob(ItemType t
) {
405 RECURSIVE_SET_ATTRIBUTE
,
407 IGNORE_DIRECTORY_PATH
,
409 RECURSIVE_REMOVE_PATH
,
411 RECURSIVE_RELABEL_PATH
,
415 static bool takes_ownership(ItemType t
) {
422 CREATE_SUBVOLUME_INHERIT_QUOTA
,
423 CREATE_SUBVOLUME_NEW_QUOTA
,
432 IGNORE_DIRECTORY_PATH
,
434 RECURSIVE_REMOVE_PATH
);
437 static struct Item
* find_glob(OrderedHashmap
*h
, const char *match
) {
440 ORDERED_HASHMAP_FOREACH(j
, h
) {
443 for (n
= 0; n
< j
->n_items
; n
++) {
444 Item
*item
= j
->items
+ n
;
446 if (fnmatch(item
->path
, match
, FNM_PATHNAME
|FNM_PERIOD
) == 0)
454 static int load_unix_sockets(Context
*c
) {
455 _cleanup_set_free_ Set
*sockets
= NULL
;
456 _cleanup_fclose_
FILE *f
= NULL
;
462 /* We maintain a cache of the sockets we found in /proc/net/unix to speed things up a little. */
464 f
= fopen("/proc/net/unix", "re");
466 return log_full_errno(errno
== ENOENT
? LOG_DEBUG
: LOG_WARNING
, errno
,
467 "Failed to open /proc/net/unix, ignoring: %m");
470 r
= read_line(f
, LONG_LINE_MAX
, NULL
);
472 return log_warning_errno(r
, "Failed to skip /proc/net/unix header line: %m");
474 return log_warning_errno(SYNTHETIC_ERRNO(EIO
), "Premature end of file reading /proc/net/unix.");
477 _cleanup_free_
char *line
= NULL
;
480 r
= read_line(f
, LONG_LINE_MAX
, &line
);
482 return log_warning_errno(r
, "Failed to read /proc/net/unix line, ignoring: %m");
483 if (r
== 0) /* EOF */
486 p
= strchr(line
, ':');
494 p
+= strspn(p
, WHITESPACE
);
495 p
+= strcspn(p
, WHITESPACE
); /* skip one more word */
496 p
+= strspn(p
, WHITESPACE
);
498 if (!path_is_absolute(p
))
501 r
= set_put_strdup_full(&sockets
, &path_hash_ops_free
, p
);
503 return log_warning_errno(r
, "Failed to add AF_UNIX socket to set, ignoring: %m");
506 c
->unix_sockets
= TAKE_PTR(sockets
);
510 static bool unix_socket_alive(Context
*c
, const char *fn
) {
514 if (load_unix_sockets(c
) < 0)
515 return true; /* We don't know, so assume yes */
517 return set_contains(c
->unix_sockets
, fn
);
520 /* Accessors for the argument in binary format */
521 static const void* item_binary_argument(const Item
*i
) {
523 return i
->binary_argument
?: i
->argument
;
526 static size_t item_binary_argument_size(const Item
*i
) {
528 return i
->binary_argument
? i
->binary_argument_size
: strlen_ptr(i
->argument
);
531 static DIR* xopendirat_nomod(int dirfd
, const char *path
) {
534 dir
= xopendirat(dirfd
, path
, O_NOFOLLOW
|O_NOATIME
);
538 if (!IN_SET(errno
, ENOENT
, ELOOP
))
539 log_debug_errno(errno
, "Cannot open %sdirectory \"%s\": %m", dirfd
== AT_FDCWD
? "" : "sub", path
);
544 dir
= xopendirat(dirfd
, path
, O_NOFOLLOW
);
546 log_debug_errno(errno
, "Cannot open %sdirectory \"%s\": %m", dirfd
== AT_FDCWD
? "" : "sub", path
);
551 static DIR* opendir_nomod(const char *path
) {
552 return xopendirat_nomod(AT_FDCWD
, path
);
555 static bool needs_cleanup(
561 const char *sub_path
,
565 if (FLAGS_SET(age_by
, AGE_BY_MTIME
) && mtime
!= NSEC_INFINITY
&& mtime
>= cutoff
) {
566 /* Follows spelling in stat(1). */
567 log_debug("%s \"%s\": modify time %s is too new.",
568 is_dir
? "Directory" : "File",
570 FORMAT_TIMESTAMP_STYLE(mtime
/ NSEC_PER_USEC
, TIMESTAMP_US
));
575 if (FLAGS_SET(age_by
, AGE_BY_ATIME
) && atime
!= NSEC_INFINITY
&& atime
>= cutoff
) {
576 log_debug("%s \"%s\": access time %s is too new.",
577 is_dir
? "Directory" : "File",
579 FORMAT_TIMESTAMP_STYLE(atime
/ NSEC_PER_USEC
, TIMESTAMP_US
));
585 * Note: Unless explicitly specified by the user, "ctime" is ignored
586 * by default for directories, because we change it when deleting.
588 if (FLAGS_SET(age_by
, AGE_BY_CTIME
) && ctime
!= NSEC_INFINITY
&& ctime
>= cutoff
) {
589 log_debug("%s \"%s\": change time %s is too new.",
590 is_dir
? "Directory" : "File",
592 FORMAT_TIMESTAMP_STYLE(ctime
/ NSEC_PER_USEC
, TIMESTAMP_US
));
597 if (FLAGS_SET(age_by
, AGE_BY_BTIME
) && btime
!= NSEC_INFINITY
&& btime
>= cutoff
) {
598 log_debug("%s \"%s\": birth time %s is too new.",
599 is_dir
? "Directory" : "File",
601 FORMAT_TIMESTAMP_STYLE(btime
/ NSEC_PER_USEC
, TIMESTAMP_US
));
609 static int dir_cleanup(
614 nsec_t self_atime_nsec
,
615 nsec_t self_mtime_nsec
,
621 bool keep_this_level
,
625 bool deleted
= false;
632 FOREACH_DIRENT_ALL(de
, d
, break) {
633 _cleanup_free_
char *sub_path
= NULL
;
634 nsec_t atime_nsec
, mtime_nsec
, ctime_nsec
, btime_nsec
;
636 if (dot_or_dot_dot(de
->d_name
))
639 /* If statx() is supported, use it. It's preferable over fstatat() since it tells us
640 * explicitly where we are looking at a mount point, for free as side information. Determining
641 * the same information without statx() is hard, see the complexity of path_is_mount_point(),
642 * and also much slower as it requires a number of syscalls instead of just one. Hence, when
643 * we have modern statx() we use it instead of fstat() and do proper mount point checks,
644 * while on older kernels's well do traditional st_dev based detection of mount points.
646 * Using statx() for detecting mount points also has the benefit that we handle weird file
647 * systems such as overlayfs better where each file is originating from a different
650 STRUCT_STATX_DEFINE(sx
);
653 dirfd(d
), de
->d_name
,
654 AT_SYMLINK_NOFOLLOW
|AT_NO_AUTOMOUNT
,
655 STATX_TYPE
|STATX_MODE
|STATX_UID
|STATX_ATIME
|STATX_MTIME
|STATX_CTIME
|STATX_BTIME
,
660 /* FUSE, NFS mounts, SELinux might return EACCES */
661 r
= log_full_errno(r
== -EACCES
? LOG_DEBUG
: LOG_ERR
, r
,
662 "statx(%s/%s) failed: %m", p
, de
->d_name
);
666 if (FLAGS_SET(sx
.stx_attributes_mask
, STATX_ATTR_MOUNT_ROOT
)) {
667 /* Yay, we have the mount point API, use it */
668 if (FLAGS_SET(sx
.stx_attributes
, STATX_ATTR_MOUNT_ROOT
)) {
669 log_debug("Ignoring \"%s/%s\": different mount points.", p
, de
->d_name
);
673 /* So we might have statx() but the STATX_ATTR_MOUNT_ROOT flag is not supported, fall
674 * back to traditional stx_dev checking. */
675 if (sx
.stx_dev_major
!= rootdev_major
||
676 sx
.stx_dev_minor
!= rootdev_minor
) {
677 log_debug("Ignoring \"%s/%s\": different filesystem.", p
, de
->d_name
);
681 /* Try to detect bind mounts of the same filesystem instance; they do not differ in device
682 * major/minors. This type of query is not supported on all kernels or filesystem types
684 if (S_ISDIR(sx
.stx_mode
)) {
687 q
= fd_is_mount_point(dirfd(d
), de
->d_name
, 0);
689 log_debug_errno(q
, "Failed to determine whether \"%s/%s\" is a mount point, ignoring: %m", p
, de
->d_name
);
691 log_debug("Ignoring \"%s/%s\": different mount of the same filesystem.", p
, de
->d_name
);
697 atime_nsec
= FLAGS_SET(sx
.stx_mask
, STATX_ATIME
) ? statx_timestamp_load_nsec(&sx
.stx_atime
) : 0;
698 mtime_nsec
= FLAGS_SET(sx
.stx_mask
, STATX_MTIME
) ? statx_timestamp_load_nsec(&sx
.stx_mtime
) : 0;
699 ctime_nsec
= FLAGS_SET(sx
.stx_mask
, STATX_CTIME
) ? statx_timestamp_load_nsec(&sx
.stx_ctime
) : 0;
700 btime_nsec
= FLAGS_SET(sx
.stx_mask
, STATX_BTIME
) ? statx_timestamp_load_nsec(&sx
.stx_btime
) : 0;
702 sub_path
= path_join(p
, de
->d_name
);
708 /* Is there an item configured for this path? */
709 if (ordered_hashmap_get(c
->items
, sub_path
)) {
710 log_debug("Ignoring \"%s\": a separate entry exists.", sub_path
);
714 if (find_glob(c
->globs
, sub_path
)) {
715 log_debug("Ignoring \"%s\": a separate glob exists.", sub_path
);
719 if (S_ISDIR(sx
.stx_mode
)) {
720 _cleanup_closedir_
DIR *sub_dir
= NULL
;
723 streq(de
->d_name
, "lost+found") &&
725 log_debug("Ignoring directory \"%s\".", sub_path
);
730 log_warning("Reached max depth on \"%s\".", sub_path
);
734 sub_dir
= xopendirat_nomod(dirfd(d
), de
->d_name
);
737 r
= log_warning_errno(errno
, "Opening directory \"%s\" failed, ignoring: %m", sub_path
);
742 if (flock(dirfd(sub_dir
), LOCK_EX
|LOCK_NB
) < 0) {
743 log_debug_errno(errno
, "Couldn't acquire shared BSD lock on directory \"%s\", skipping: %m", sub_path
);
747 q
= dir_cleanup(c
, i
,
749 atime_nsec
, mtime_nsec
, cutoff_nsec
,
750 rootdev_major
, rootdev_minor
,
751 false, maxdepth
-1, false,
752 age_by_file
, age_by_dir
);
757 /* Note: if you are wondering why we don't support the sticky bit for excluding
758 * directories from cleaning like we do it for other file system objects: well, the
759 * sticky bit already has a meaning for directories, so we don't want to overload
762 if (keep_this_level
) {
763 log_debug("Keeping directory \"%s\".", sub_path
);
768 * Check the file timestamps of an entry against the
769 * given cutoff time; delete if it is older.
771 if (!needs_cleanup(atime_nsec
, btime_nsec
, ctime_nsec
, mtime_nsec
,
772 cutoff_nsec
, sub_path
, age_by_dir
, true))
775 log_debug("Removing directory \"%s\".", sub_path
);
776 if (unlinkat(dirfd(d
), de
->d_name
, AT_REMOVEDIR
) < 0)
777 if (!IN_SET(errno
, ENOENT
, ENOTEMPTY
))
778 r
= log_warning_errno(errno
, "Failed to remove directory \"%s\", ignoring: %m", sub_path
);
781 _cleanup_close_
int fd
= -EBADF
;
783 /* Skip files for which the sticky bit is set. These are semantics we define, and are
784 * unknown elsewhere. See XDG_RUNTIME_DIR specification for details. */
785 if (sx
.stx_mode
& S_ISVTX
) {
786 log_debug("Skipping \"%s\": sticky bit set.", sub_path
);
791 S_ISREG(sx
.stx_mode
) &&
793 STR_IN_SET(de
->d_name
,
797 log_debug("Skipping \"%s\".", sub_path
);
801 /* Ignore sockets that are listed in /proc/net/unix */
802 if (S_ISSOCK(sx
.stx_mode
) && unix_socket_alive(c
, sub_path
)) {
803 log_debug("Skipping \"%s\": live socket.", sub_path
);
807 /* Ignore device nodes */
808 if (S_ISCHR(sx
.stx_mode
) || S_ISBLK(sx
.stx_mode
)) {
809 log_debug("Skipping \"%s\": a device.", sub_path
);
813 /* Keep files on this level around if this is requested */
814 if (keep_this_level
) {
815 log_debug("Keeping \"%s\".", sub_path
);
819 if (!needs_cleanup(atime_nsec
, btime_nsec
, ctime_nsec
, mtime_nsec
,
820 cutoff_nsec
, sub_path
, age_by_file
, false))
823 fd
= xopenat(dirfd(d
),
825 O_RDONLY
|O_CLOEXEC
|O_NOFOLLOW
|O_NOATIME
|O_NONBLOCK
,
826 /* xopen_flags = */ 0,
828 if (fd
< 0 && !IN_SET(fd
, -ENOENT
, -ELOOP
))
829 log_warning_errno(fd
, "Opening file \"%s\" failed, ignoring: %m", sub_path
);
830 if (fd
>= 0 && flock(fd
, LOCK_EX
|LOCK_NB
) < 0 && errno
== EAGAIN
) {
831 log_debug_errno(errno
, "Couldn't acquire shared BSD lock on file \"%s\", skipping: %m", sub_path
);
835 log_debug("Removing \"%s\".", sub_path
);
836 if (unlinkat(dirfd(d
), de
->d_name
, 0) < 0)
838 r
= log_warning_errno(errno
, "Failed to remove \"%s\", ignoring: %m", sub_path
);
846 struct timespec ts
[2];
848 log_debug("Restoring access and modification time on \"%s\": %s, %s",
850 FORMAT_TIMESTAMP_STYLE(self_atime_nsec
/ NSEC_PER_USEC
, TIMESTAMP_US
),
851 FORMAT_TIMESTAMP_STYLE(self_mtime_nsec
/ NSEC_PER_USEC
, TIMESTAMP_US
));
853 timespec_store_nsec(ts
+ 0, self_atime_nsec
);
854 timespec_store_nsec(ts
+ 1, self_mtime_nsec
);
856 /* Restore original directory timestamps */
857 if (futimens(dirfd(d
), ts
) < 0)
858 log_warning_errno(errno
, "Failed to revert timestamps of '%s', ignoring: %m", p
);
864 static bool dangerous_hardlinks(void) {
865 _cleanup_free_
char *value
= NULL
;
866 static int cached
= -1;
869 /* Check whether the fs.protected_hardlinks sysctl is on. If we can't determine it we assume its off, as that's
870 * what the upstream default is. */
875 r
= read_one_line_file("/proc/sys/fs/protected_hardlinks", &value
);
877 log_debug_errno(r
, "Failed to read fs.protected_hardlinks sysctl: %m");
881 r
= parse_boolean(value
);
883 log_debug_errno(r
, "Failed to parse fs.protected_hardlinks sysctl: %m");
891 static bool hardlink_vulnerable(const struct stat
*st
) {
894 return !S_ISDIR(st
->st_mode
) && st
->st_nlink
> 1 && dangerous_hardlinks();
897 static mode_t
process_mask_perms(mode_t mode
, mode_t current
) {
899 if ((current
& 0111) == 0)
901 if ((current
& 0222) == 0)
903 if ((current
& 0444) == 0)
905 if (!S_ISDIR(current
))
906 mode
&= ~07000; /* remove sticky/sgid/suid bit, unless directory */
911 static int fd_set_perms(
916 const struct stat
*st
,
917 CreationMode creation
) {
919 bool do_chown
, do_chmod
;
931 if (!i
->mode_set
&& !i
->uid_set
&& !i
->gid_set
)
935 if (fstat(fd
, &stbuf
) < 0)
936 return log_error_errno(errno
, "fstat(%s) failed: %m", path
);
940 if (hardlink_vulnerable(st
))
941 return log_error_errno(SYNTHETIC_ERRNO(EPERM
),
942 "Refusing to set permissions on hardlinked file %s while the fs.protected_hardlinks sysctl is turned off.",
944 new_uid
= i
->uid_set
&& (creation
!= CREATION_EXISTING
|| !i
->uid_only_create
) ? i
->uid
: st
->st_uid
;
945 new_gid
= i
->gid_set
&& (creation
!= CREATION_EXISTING
|| !i
->gid_only_create
) ? i
->gid
: st
->st_gid
;
947 /* Do we need a chown()? */
948 do_chown
= (new_uid
!= st
->st_uid
) || (new_gid
!= st
->st_gid
);
950 /* Calculate the mode to apply */
951 new_mode
= i
->mode_set
&& (creation
!= CREATION_EXISTING
|| !i
->mode_only_create
) ?
952 (i
->mask_perms
? process_mask_perms(i
->mode
, st
->st_mode
) : i
->mode
) :
953 (st
->st_mode
& 07777);
955 do_chmod
= ((new_mode
^ st
->st_mode
) & 07777) != 0;
957 if (do_chmod
&& do_chown
) {
958 /* Before we issue the chmod() let's reduce the access mode to the common bits of the old and
959 * the new mode. That way there's no time window where the file exists under the old owner
960 * with more than the old access modes — and not under the new owner with more than the new
961 * access modes either. */
963 if (S_ISLNK(st
->st_mode
))
964 log_debug("Skipping temporary mode fix for symlink %s.", path
);
966 mode_t m
= new_mode
& st
->st_mode
; /* Mask new mode by old mode */
968 if (((m
^ st
->st_mode
) & 07777) == 0)
969 log_debug("\"%s\" matches temporary mode %o already.", path
, m
);
971 log_debug("Temporarily changing \"%s\" to mode %o.", path
, m
);
972 r
= fchmod_opath(fd
, m
);
974 return log_error_errno(r
, "fchmod() of %s failed: %m", path
);
980 log_debug("Changing \"%s\" to owner "UID_FMT
":"GID_FMT
, path
, new_uid
, new_gid
);
983 new_uid
!= st
->st_uid
? new_uid
: UID_INVALID
,
984 new_gid
!= st
->st_gid
? new_gid
: GID_INVALID
,
986 return log_error_errno(errno
, "fchownat() of %s failed: %m", path
);
989 /* Now, apply the final mode. We do this in two cases: when the user set a mode explicitly, or after a
990 * chown(), since chown()'s mangle the access mode in regards to sgid/suid in some conditions. */
991 if (do_chmod
|| do_chown
) {
992 if (S_ISLNK(st
->st_mode
))
993 log_debug("Skipping mode fix for symlink %s.", path
);
995 log_debug("Changing \"%s\" to mode %o.", path
, new_mode
);
996 r
= fchmod_opath(fd
, new_mode
);
998 return log_error_errno(r
, "fchmod() of %s failed: %m", path
);
1003 return label_fix_full(fd
, /* inode_path= */ NULL
, /* label_path= */ path
, 0);
1006 static int path_open_parent_safe(const char *path
, bool allow_failure
) {
1007 _cleanup_free_
char *dn
= NULL
;
1010 if (!path_is_normalized(path
))
1011 return log_full_errno(allow_failure
? LOG_INFO
: LOG_ERR
,
1012 SYNTHETIC_ERRNO(EINVAL
),
1013 "Failed to open parent of '%s': path not normalized%s.",
1015 allow_failure
? ", ignoring" : "");
1017 r
= path_extract_directory(path
, &dn
);
1019 return log_full_errno(allow_failure
? LOG_INFO
: LOG_ERR
,
1021 "Unable to determine parent directory of '%s'%s: %m",
1023 allow_failure
? ", ignoring" : "");
1025 r
= chase(dn
, arg_root
, allow_failure
? CHASE_SAFE
: CHASE_SAFE
|CHASE_WARN
, NULL
, &fd
);
1026 if (r
== -ENOLINK
) /* Unsafe symlink: already covered by CHASE_WARN */
1029 return log_full_errno(allow_failure
? LOG_INFO
: LOG_ERR
,
1031 "Failed to open path '%s'%s: %m",
1033 allow_failure
? ", ignoring" : "");
1038 static int path_open_safe(const char *path
) {
1041 /* path_open_safe() returns a file descriptor opened with O_PATH after
1042 * verifying that the path doesn't contain unsafe transitions, except
1043 * for its final component as the function does not follow symlink. */
1047 if (!path_is_normalized(path
))
1048 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Failed to open invalid path '%s'.", path
);
1050 r
= chase(path
, arg_root
, CHASE_SAFE
|CHASE_WARN
|CHASE_NOFOLLOW
, NULL
, &fd
);
1052 return r
; /* Unsafe symlink: already covered by CHASE_WARN */
1054 return log_error_errno(r
, "Failed to open path %s: %m", path
);
1059 static int path_set_perms(
1063 CreationMode creation
) {
1065 _cleanup_close_
int fd
= -EBADF
;
1071 fd
= path_open_safe(path
);
1075 return fd_set_perms(c
, i
, fd
, path
, /* st= */ NULL
, creation
);
1078 static int parse_xattrs_from_arg(Item
*i
) {
1084 assert_se(p
= i
->argument
);
1086 _cleanup_free_
char *name
= NULL
, *value
= NULL
, *xattr
= NULL
;
1088 r
= extract_first_word(&p
, &xattr
, NULL
, EXTRACT_UNQUOTE
|EXTRACT_CUNESCAPE
);
1090 log_warning_errno(r
, "Failed to parse extended attribute '%s', ignoring: %m", p
);
1094 r
= split_pair(xattr
, "=", &name
, &value
);
1096 log_warning_errno(r
, "Failed to parse extended attribute, ignoring: %s", xattr
);
1100 if (isempty(name
) || isempty(value
)) {
1101 log_warning("Malformed extended attribute found, ignoring: %s", xattr
);
1105 if (strv_push_pair(&i
->xattrs
, name
, value
) < 0)
1108 name
= value
= NULL
;
1114 static int fd_set_xattrs(
1119 const struct stat
*st
,
1120 CreationMode creation
) {
1127 STRV_FOREACH_PAIR(name
, value
, i
->xattrs
) {
1128 log_debug("Setting extended attribute '%s=%s' on %s.", *name
, *value
, path
);
1129 if (setxattr(FORMAT_PROC_FD_PATH(fd
), *name
, *value
, strlen(*value
), 0) < 0)
1130 return log_error_errno(errno
, "Setting extended attribute %s=%s on %s failed: %m",
1131 *name
, *value
, path
);
1136 static int path_set_xattrs(
1140 CreationMode creation
) {
1142 _cleanup_close_
int fd
= -EBADF
;
1148 fd
= path_open_safe(path
);
1152 return fd_set_xattrs(c
, i
, fd
, path
, /* st = */ NULL
, creation
);
1155 static int parse_acls_from_arg(Item
*item
) {
1161 /* If append_or_force (= modify) is set, we will not modify the acl
1162 * afterwards, so the mask can be added now if necessary. */
1164 r
= parse_acl(item
->argument
, &item
->acl_access
, &item
->acl_access_exec
,
1165 &item
->acl_default
, !item
->append_or_force
);
1167 log_full_errno(arg_graceful
&& IN_SET(r
, -EINVAL
, -ENOENT
, -ESRCH
) ? LOG_DEBUG
: LOG_WARNING
,
1168 r
, "Failed to parse ACL \"%s\", ignoring: %m", item
->argument
);
1170 log_warning("ACLs are not supported, ignoring.");
1177 static int parse_acl_cond_exec(
1179 acl_t access
, /* could be empty (NULL) */
1181 const struct stat
*st
,
1185 _cleanup_(acl_freep
) acl_t parsed
= NULL
;
1187 acl_permset_t permset
;
1195 parsed
= access
? acl_dup(access
) : acl_init(0);
1199 /* Since we substitute 'X' with 'x' in parse_acl(), we just need to copy the entries over
1200 * for directories */
1201 if (S_ISDIR(st
->st_mode
)) {
1202 for (r
= acl_get_entry(cond_exec
, ACL_FIRST_ENTRY
, &entry
);
1204 r
= acl_get_entry(cond_exec
, ACL_NEXT_ENTRY
, &entry
)) {
1206 acl_entry_t parsed_entry
;
1208 if (acl_create_entry(&parsed
, &parsed_entry
) < 0)
1211 if (acl_copy_entry(parsed_entry
, entry
) < 0)
1220 has_exec
= st
->st_mode
& S_IXUSR
;
1222 if (!has_exec
&& append
) {
1223 _cleanup_(acl_freep
) acl_t old
= NULL
;
1225 old
= acl_get_file(path
, ACL_TYPE_ACCESS
);
1229 for (r
= acl_get_entry(old
, ACL_FIRST_ENTRY
, &entry
);
1231 r
= acl_get_entry(old
, ACL_NEXT_ENTRY
, &entry
)) {
1233 if (acl_get_permset(entry
, &permset
) < 0)
1236 r
= acl_get_perm(permset
, ACL_EXECUTE
);
1248 /* Check if we're about to set the execute bit in acl_access */
1249 if (!has_exec
&& access
) {
1250 for (r
= acl_get_entry(access
, ACL_FIRST_ENTRY
, &entry
);
1252 r
= acl_get_entry(access
, ACL_NEXT_ENTRY
, &entry
)) {
1254 if (acl_get_permset(entry
, &permset
) < 0)
1257 r
= acl_get_perm(permset
, ACL_EXECUTE
);
1269 for (r
= acl_get_entry(cond_exec
, ACL_FIRST_ENTRY
, &entry
);
1271 r
= acl_get_entry(cond_exec
, ACL_NEXT_ENTRY
, &entry
)) {
1273 acl_entry_t parsed_entry
;
1275 if (acl_create_entry(&parsed
, &parsed_entry
) < 0)
1278 if (acl_copy_entry(parsed_entry
, entry
) < 0)
1282 if (acl_get_permset(parsed_entry
, &permset
) < 0)
1285 if (acl_delete_perm(permset
, ACL_EXECUTE
) < 0)
1293 if (!append
) { /* want_mask = true */
1294 r
= calc_acl_mask_if_needed(&parsed
);
1299 *ret
= TAKE_PTR(parsed
);
1304 static int path_set_acl(
1312 _cleanup_(acl_free_charpp
) char *t
= NULL
;
1313 _cleanup_(acl_freep
) acl_t dup
= NULL
;
1318 /* Returns 0 for success, positive error if already warned, negative error otherwise. */
1321 r
= acls_for_file(path
, type
, acl
, &dup
);
1325 r
= calc_acl_mask_if_needed(&dup
);
1333 /* the mask was already added earlier if needed */
1336 r
= add_base_acls_if_needed(&dup
, path
);
1340 t
= acl_to_any_text(dup
, NULL
, ',', TEXT_ABBREVIATE
);
1341 log_debug("Setting %s ACL %s on %s.",
1342 type
== ACL_TYPE_ACCESS
? "access" : "default",
1345 r
= acl_set_file(path
, type
, dup
);
1347 if (ERRNO_IS_NOT_SUPPORTED(errno
))
1348 /* No error if filesystem doesn't support ACLs. Return negative. */
1351 /* Return positive to indicate we already warned */
1352 return -log_error_errno(errno
,
1353 "Setting %s ACL \"%s\" on %s failed: %m",
1354 type
== ACL_TYPE_ACCESS
? "access" : "default",
1361 static int fd_set_acls(
1366 const struct stat
*st
,
1367 CreationMode creation
) {
1371 _cleanup_(acl_freep
) acl_t access_with_exec_parsed
= NULL
;
1380 if (fstat(fd
, &stbuf
) < 0)
1381 return log_error_errno(errno
, "fstat(%s) failed: %m", path
);
1385 if (hardlink_vulnerable(st
))
1386 return log_error_errno(SYNTHETIC_ERRNO(EPERM
),
1387 "Refusing to set ACLs on hardlinked file %s while the fs.protected_hardlinks sysctl is turned off.",
1390 if (S_ISLNK(st
->st_mode
)) {
1391 log_debug("Skipping ACL fix for symlink %s.", path
);
1395 if (item
->acl_access_exec
) {
1396 r
= parse_acl_cond_exec(FORMAT_PROC_FD_PATH(fd
),
1398 item
->acl_access_exec
,
1400 item
->append_or_force
,
1401 &access_with_exec_parsed
);
1403 return log_error_errno(r
, "Failed to parse conditionalized execute bit for \"%s\": %m", path
);
1405 r
= path_set_acl(c
, FORMAT_PROC_FD_PATH(fd
), path
, ACL_TYPE_ACCESS
, access_with_exec_parsed
, item
->append_or_force
);
1406 } else if (item
->acl_access
)
1407 r
= path_set_acl(c
, FORMAT_PROC_FD_PATH(fd
), path
, ACL_TYPE_ACCESS
, item
->acl_access
, item
->append_or_force
);
1409 /* set only default acls to folders */
1410 if (r
== 0 && item
->acl_default
&& S_ISDIR(st
->st_mode
))
1411 r
= path_set_acl(c
, FORMAT_PROC_FD_PATH(fd
), path
, ACL_TYPE_DEFAULT
, item
->acl_default
, item
->append_or_force
);
1413 if (ERRNO_IS_NOT_SUPPORTED(r
)) {
1414 log_debug_errno(r
, "ACLs not supported by file system at %s", path
);
1419 return -r
; /* already warned in path_set_acl */
1421 /* The above procfs paths don't work if /proc is not mounted. */
1422 if (r
== -ENOENT
&& proc_mounted() == 0)
1426 return log_error_errno(r
, "ACL operation on \"%s\" failed: %m", path
);
1431 static int path_set_acls(
1435 CreationMode creation
) {
1439 _cleanup_close_
int fd
= -EBADF
;
1445 fd
= path_open_safe(path
);
1449 r
= fd_set_acls(c
, item
, fd
, path
, /* st= */ NULL
, creation
);
1454 static int parse_attribute_from_arg(Item
*item
) {
1456 static const struct {
1460 { 'A', FS_NOATIME_FL
}, /* do not update atime */
1461 { 'S', FS_SYNC_FL
}, /* Synchronous updates */
1462 { 'D', FS_DIRSYNC_FL
}, /* dirsync behaviour (directories only) */
1463 { 'a', FS_APPEND_FL
}, /* writes to file may only append */
1464 { 'c', FS_COMPR_FL
}, /* Compress file */
1465 { 'd', FS_NODUMP_FL
}, /* do not dump file */
1466 { 'e', FS_EXTENT_FL
}, /* Extents */
1467 { 'i', FS_IMMUTABLE_FL
}, /* Immutable file */
1468 { 'j', FS_JOURNAL_DATA_FL
}, /* Reserved for ext3 */
1469 { 's', FS_SECRM_FL
}, /* Secure deletion */
1470 { 'u', FS_UNRM_FL
}, /* Undelete */
1471 { 't', FS_NOTAIL_FL
}, /* file tail should not be merged */
1472 { 'T', FS_TOPDIR_FL
}, /* Top of directory hierarchies */
1473 { 'C', FS_NOCOW_FL
}, /* Do not cow file */
1474 { 'P', FS_PROJINHERIT_FL
}, /* Inherit the quota project ID */
1483 unsigned value
= 0, mask
= 0;
1493 } else if (*p
== '-') {
1496 } else if (*p
== '=') {
1502 if (isempty(p
) && mode
!= MODE_SET
)
1503 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
1504 "Setting file attribute on '%s' needs an attribute specification.",
1507 for (; p
&& *p
; p
++) {
1510 for (i
= 0; i
< ELEMENTSOF(attributes
); i
++)
1511 if (*p
== attributes
[i
].character
)
1514 if (i
>= ELEMENTSOF(attributes
))
1515 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
1516 "Unknown file attribute '%c' on '%s'.",
1519 v
= attributes
[i
].value
;
1521 SET_FLAG(value
, v
, IN_SET(mode
, MODE_ADD
, MODE_SET
));
1526 if (mode
== MODE_SET
)
1527 mask
|= CHATTR_ALL_FL
;
1531 item
->attribute_mask
= mask
;
1532 item
->attribute_value
= value
;
1533 item
->attribute_set
= true;
1538 static int fd_set_attribute(
1543 const struct stat
*st
,
1544 CreationMode creation
) {
1546 _cleanup_close_
int procfs_fd
= -EBADF
;
1556 if (!item
->attribute_set
|| item
->attribute_mask
== 0)
1560 if (fstat(fd
, &stbuf
) < 0)
1561 return log_error_errno(errno
, "fstat(%s) failed: %m", path
);
1565 /* Issuing the file attribute ioctls on device nodes is not safe, as that will be delivered to the
1566 * drivers, not the file system containing the device node. */
1567 if (!S_ISREG(st
->st_mode
) && !S_ISDIR(st
->st_mode
))
1568 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
1569 "Setting file flags is only supported on regular files and directories, cannot set on '%s'.",
1572 f
= item
->attribute_value
& item
->attribute_mask
;
1574 /* Mask away directory-specific flags */
1575 if (!S_ISDIR(st
->st_mode
))
1576 f
&= ~FS_DIRSYNC_FL
;
1578 procfs_fd
= fd_reopen(fd
, O_RDONLY
|O_CLOEXEC
|O_NOATIME
);
1580 return log_error_errno(procfs_fd
, "Failed to re-open '%s': %m", path
);
1582 unsigned previous
, current
;
1583 r
= chattr_full(procfs_fd
, NULL
, f
, item
->attribute_mask
, &previous
, ¤t
, CHATTR_FALLBACK_BITWISE
);
1585 log_warning("Cannot set file attributes for '%s', maybe due to incompatibility in specified attributes, "
1586 "previous=0x%08x, current=0x%08x, expected=0x%08x, ignoring.",
1587 path
, previous
, current
, (previous
& ~item
->attribute_mask
) | (f
& item
->attribute_mask
));
1589 log_full_errno(ERRNO_IS_NOT_SUPPORTED(r
) ? LOG_DEBUG
: LOG_WARNING
, r
,
1590 "Cannot set file attributes for '%s', value=0x%08x, mask=0x%08x, ignoring: %m",
1591 path
, item
->attribute_value
, item
->attribute_mask
);
1596 static int path_set_attribute(
1600 CreationMode creation
) {
1602 _cleanup_close_
int fd
= -EBADF
;
1607 if (!item
->attribute_set
|| item
->attribute_mask
== 0)
1610 fd
= path_open_safe(path
);
1614 return fd_set_attribute(c
, item
, fd
, path
, /* st= */ NULL
, creation
);
1617 static int write_argument_data(Item
*i
, int fd
, const char *path
) {
1624 if (item_binary_argument_size(i
) == 0)
1627 assert(item_binary_argument(i
));
1629 log_debug("Writing to \"%s\".", path
);
1631 r
= loop_write(fd
, item_binary_argument(i
), item_binary_argument_size(i
));
1633 return log_error_errno(r
, "Failed to write file \"%s\": %m", path
);
1638 static int write_one_file(Context
*c
, Item
*i
, const char *path
, CreationMode creation
) {
1639 _cleanup_close_
int fd
= -EBADF
, dir_fd
= -EBADF
;
1640 _cleanup_free_
char *bn
= NULL
;
1646 assert(i
->type
== WRITE_FILE
);
1648 r
= path_extract_filename(path
, &bn
);
1650 return log_error_errno(r
, "Failed to extract filename from path '%s': %m", path
);
1651 if (r
== O_DIRECTORY
)
1652 return log_error_errno(SYNTHETIC_ERRNO(EISDIR
), "Cannot open path '%s' for writing, is a directory.", path
);
1654 /* Validate the path and keep the fd on the directory for opening the file so we're sure that it
1655 * can't be changed behind our back. */
1656 dir_fd
= path_open_parent_safe(path
, i
->allow_failure
);
1660 /* Follows symlinks */
1661 fd
= openat(dir_fd
, bn
,
1662 O_NONBLOCK
|O_CLOEXEC
|O_WRONLY
|O_NOCTTY
|(i
->append_or_force
? O_APPEND
: 0),
1665 if (errno
== ENOENT
) {
1666 log_debug_errno(errno
, "Not writing missing file \"%s\": %m", path
);
1670 if (i
->allow_failure
)
1671 return log_debug_errno(errno
, "Failed to open file \"%s\", ignoring: %m", path
);
1673 return log_error_errno(errno
, "Failed to open file \"%s\": %m", path
);
1676 /* 'w' is allowed to write into any kind of files. */
1678 r
= write_argument_data(i
, fd
, path
);
1682 return fd_set_perms(c
, i
, fd
, path
, NULL
, creation
);
1685 static int create_file(
1690 _cleanup_close_
int fd
= -EBADF
, dir_fd
= -EBADF
;
1691 _cleanup_free_
char *bn
= NULL
;
1692 struct stat stbuf
, *st
= NULL
;
1693 CreationMode creation
;
1699 assert(i
->type
== CREATE_FILE
);
1701 /* 'f' operates on regular files exclusively. */
1703 r
= path_extract_filename(path
, &bn
);
1705 return log_error_errno(r
, "Failed to extract filename from path '%s': %m", path
);
1706 if (r
== O_DIRECTORY
)
1707 return log_error_errno(SYNTHETIC_ERRNO(EISDIR
), "Cannot open path '%s' for writing, is a directory.", path
);
1709 /* Validate the path and keep the fd on the directory for opening the file so we're sure that it
1710 * can't be changed behind our back. */
1711 dir_fd
= path_open_parent_safe(path
, i
->allow_failure
);
1716 mac_selinux_create_file_prepare(path
, S_IFREG
);
1717 fd
= RET_NERRNO(openat(dir_fd
, bn
, O_CREAT
|O_EXCL
|O_NOFOLLOW
|O_NONBLOCK
|O_CLOEXEC
|O_WRONLY
|O_NOCTTY
, i
->mode
));
1718 mac_selinux_create_file_clear();
1722 /* Even on a read-only filesystem, open(2) returns EEXIST if the file already exists. It
1723 * returns EROFS only if it needs to create the file. */
1725 return log_error_errno(fd
, "Failed to create file %s: %m", path
);
1727 /* Re-open the file. At that point it must exist since open(2) failed with EEXIST. We still
1728 * need to check if the perms/mode need to be changed. For read-only filesystems, we let
1729 * fd_set_perms() report the error if the perms need to be modified. */
1730 fd
= openat(dir_fd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
, i
->mode
);
1732 return log_error_errno(errno
, "Failed to re-open file %s: %m", path
);
1734 if (fstat(fd
, &stbuf
) < 0)
1735 return log_error_errno(errno
, "stat(%s) failed: %m", path
);
1737 if (!S_ISREG(stbuf
.st_mode
))
1738 return log_error_errno(SYNTHETIC_ERRNO(EEXIST
),
1739 "%s exists and is not a regular file.",
1743 creation
= CREATION_EXISTING
;
1745 r
= write_argument_data(i
, fd
, path
);
1749 creation
= CREATION_NORMAL
;
1752 return fd_set_perms(c
, i
, fd
, path
, st
, creation
);
1755 static int truncate_file(
1760 _cleanup_close_
int fd
= -EBADF
, dir_fd
= -EBADF
;
1761 _cleanup_free_
char *bn
= NULL
;
1762 struct stat stbuf
, *st
= NULL
;
1763 CreationMode creation
;
1770 assert(i
->type
== TRUNCATE_FILE
|| (i
->type
== CREATE_FILE
&& i
->append_or_force
));
1772 /* We want to operate on regular file exclusively especially since O_TRUNC is unspecified if the file
1773 * is neither a regular file nor a fifo nor a terminal device. Therefore we first open the file and
1774 * make sure it's a regular one before truncating it. */
1776 r
= path_extract_filename(path
, &bn
);
1778 return log_error_errno(r
, "Failed to extract filename from path '%s': %m", path
);
1779 if (r
== O_DIRECTORY
)
1780 return log_error_errno(SYNTHETIC_ERRNO(EISDIR
), "Cannot open path '%s' for truncation, is a directory.", path
);
1782 /* Validate the path and keep the fd on the directory for opening the file so we're sure that it
1783 * can't be changed behind our back. */
1784 dir_fd
= path_open_parent_safe(path
, i
->allow_failure
);
1788 creation
= CREATION_EXISTING
;
1789 fd
= RET_NERRNO(openat(dir_fd
, bn
, O_NOFOLLOW
|O_NONBLOCK
|O_CLOEXEC
|O_WRONLY
|O_NOCTTY
, i
->mode
));
1790 if (fd
== -ENOENT
) {
1791 creation
= CREATION_NORMAL
; /* Didn't work without O_CREATE, try again with */
1794 mac_selinux_create_file_prepare(path
, S_IFREG
);
1795 fd
= RET_NERRNO(openat(dir_fd
, bn
, O_CREAT
|O_NOFOLLOW
|O_NONBLOCK
|O_CLOEXEC
|O_WRONLY
|O_NOCTTY
, i
->mode
));
1796 mac_selinux_create_file_clear();
1802 return log_error_errno(fd
, "Failed to open/create file %s: %m", path
);
1804 /* On a read-only filesystem, we don't want to fail if the target is already empty and the
1805 * perms are set. So we still proceed with the sanity checks and let the remaining operations
1806 * fail with EROFS if they try to modify the target file. */
1808 fd
= openat(dir_fd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
, i
->mode
);
1810 if (errno
== ENOENT
)
1811 return log_error_errno(SYNTHETIC_ERRNO(EROFS
),
1812 "Cannot create file %s on a read-only file system.",
1815 return log_error_errno(errno
, "Failed to re-open file %s: %m", path
);
1819 creation
= CREATION_EXISTING
;
1822 if (fstat(fd
, &stbuf
) < 0)
1823 return log_error_errno(errno
, "stat(%s) failed: %m", path
);
1825 if (!S_ISREG(stbuf
.st_mode
))
1826 return log_error_errno(SYNTHETIC_ERRNO(EEXIST
),
1827 "%s exists and is not a regular file.",
1830 if (stbuf
.st_size
> 0) {
1831 if (ftruncate(fd
, 0) < 0) {
1832 r
= erofs
? -EROFS
: -errno
;
1833 return log_error_errno(r
, "Failed to truncate file %s: %m", path
);
1838 log_debug("\"%s\" has been created.", path
);
1840 if (item_binary_argument(i
)) {
1841 r
= write_argument_data(i
, fd
, path
);
1846 return fd_set_perms(c
, i
, fd
, path
, st
, creation
);
1849 static int copy_files(Context
*c
, Item
*i
) {
1850 _cleanup_close_
int dfd
= -EBADF
, fd
= -EBADF
;
1851 _cleanup_free_
char *bn
= NULL
;
1855 log_debug("Copying tree \"%s\" to \"%s\".", i
->argument
, i
->path
);
1857 r
= path_extract_filename(i
->path
, &bn
);
1859 return log_error_errno(r
, "Failed to extract filename from path '%s': %m", i
->path
);
1861 /* Validate the path and use the returned directory fd for copying the target so we're sure that the
1862 * path can't be changed behind our back. */
1863 dfd
= path_open_parent_safe(i
->path
, i
->allow_failure
);
1867 r
= copy_tree_at(AT_FDCWD
, i
->argument
,
1869 i
->uid_set
? i
->uid
: UID_INVALID
,
1870 i
->gid_set
? i
->gid
: GID_INVALID
,
1871 COPY_REFLINK
| ((i
->append_or_force
) ? COPY_MERGE
: COPY_MERGE_EMPTY
) | COPY_MAC_CREATE
| COPY_HARDLINKS
,
1874 fd
= openat(dfd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
);
1876 if (r
< 0) /* Look at original error first */
1877 return log_error_errno(r
, "Failed to copy files to %s: %m", i
->path
);
1879 return log_error_errno(errno
, "Failed to openat(%s): %m", i
->path
);
1882 if (fstat(fd
, &st
) < 0)
1883 return log_error_errno(errno
, "Failed to fstat(%s): %m", i
->path
);
1885 if (stat(i
->argument
, &a
) < 0)
1886 return log_error_errno(errno
, "Failed to stat(%s): %m", i
->argument
);
1888 if (((st
.st_mode
^ a
.st_mode
) & S_IFMT
) != 0) {
1889 log_debug("Can't copy to %s, file exists already and is of different type", i
->path
);
1893 return fd_set_perms(c
, i
, fd
, i
->path
, &st
, _CREATION_MODE_INVALID
);
1896 static int create_directory_or_subvolume(
1901 struct stat
*ret_st
,
1902 CreationMode
*ret_creation
) {
1904 _cleanup_free_
char *bn
= NULL
;
1905 _cleanup_close_
int pfd
= -EBADF
;
1906 CreationMode creation
;
1912 r
= path_extract_filename(path
, &bn
);
1914 return log_error_errno(r
, "Failed to extract filename from path '%s': %m", path
);
1916 pfd
= path_open_parent_safe(path
, allow_failure
);
1921 r
= getenv_bool("SYSTEMD_TMPFILES_FORCE_SUBVOL");
1923 if (r
!= -ENXIO
) /* env var is unset */
1924 log_warning_errno(r
, "Cannot parse value of $SYSTEMD_TMPFILES_FORCE_SUBVOL, ignoring.");
1925 r
= btrfs_is_subvol(empty_to_root(arg_root
)) > 0;
1928 /* Don't create a subvolume unless the root directory is one, too. We do this under
1929 * the assumption that if the root directory is just a plain directory (i.e. very
1930 * light-weight), we shouldn't try to split it up into subvolumes (i.e. more
1931 * heavy-weight). Thus, chroot() environments and suchlike will get a full brtfs
1932 * subvolume set up below their tree only if they specifically set up a btrfs
1933 * subvolume for the root dir too. */
1937 WITH_UMASK((~mode
) & 0777)
1938 r
= btrfs_subvol_make(pfd
, bn
);
1943 if (!subvol
|| ERRNO_IS_NEG_NOT_SUPPORTED(r
))
1945 r
= mkdirat_label(pfd
, bn
, mode
);
1947 creation
= r
>= 0 ? CREATION_NORMAL
: CREATION_EXISTING
;
1949 fd
= openat(pfd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_DIRECTORY
|O_PATH
);
1951 /* We couldn't open it because it is not actually a directory? */
1952 if (errno
== ENOTDIR
)
1953 return log_error_errno(SYNTHETIC_ERRNO(EEXIST
), "\"%s\" already exists and is not a directory.", path
);
1955 /* Then look at the original error */
1957 return log_full_errno(allow_failure
? LOG_INFO
: LOG_ERR
,
1959 "Failed to create directory or subvolume \"%s\"%s: %m",
1961 allow_failure
? ", ignoring" : "");
1963 return log_error_errno(errno
, "Failed to open directory/subvolume we just created '%s': %m", path
);
1966 if (fstat(fd
, &st
) < 0)
1967 return log_error_errno(errno
, "Failed to fstat(%s): %m", path
);
1969 assert(S_ISDIR(st
.st_mode
)); /* we used O_DIRECTORY above */
1971 log_debug("%s directory \"%s\".", creation_mode_verb_to_string(creation
), path
);
1976 *ret_creation
= creation
;
1981 static int create_directory(
1986 _cleanup_close_
int fd
= -EBADF
;
1987 CreationMode creation
;
1992 assert(IN_SET(i
->type
, CREATE_DIRECTORY
, TRUNCATE_DIRECTORY
));
1994 fd
= create_directory_or_subvolume(path
, i
->mode
, /* subvol= */ false, i
->allow_failure
, &st
, &creation
);
2000 return fd_set_perms(c
, i
, fd
, path
, &st
, creation
);
2003 static int create_subvolume(
2008 _cleanup_close_
int fd
= -EBADF
;
2009 CreationMode creation
;
2015 assert(IN_SET(i
->type
, CREATE_SUBVOLUME
, CREATE_SUBVOLUME_NEW_QUOTA
, CREATE_SUBVOLUME_INHERIT_QUOTA
));
2017 fd
= create_directory_or_subvolume(path
, i
->mode
, /* subvol = */ true, i
->allow_failure
, &st
, &creation
);
2023 if (creation
== CREATION_NORMAL
&&
2024 IN_SET(i
->type
, CREATE_SUBVOLUME_NEW_QUOTA
, CREATE_SUBVOLUME_INHERIT_QUOTA
)) {
2025 r
= btrfs_subvol_auto_qgroup_fd(fd
, 0, i
->type
== CREATE_SUBVOLUME_NEW_QUOTA
);
2027 log_debug_errno(r
, "Couldn't adjust quota for subvolume \"%s\" (unsupported fs or dir not a subvolume): %m", i
->path
);
2028 else if (r
== -EROFS
)
2029 log_debug_errno(r
, "Couldn't adjust quota for subvolume \"%s\" (fs is read-only).", i
->path
);
2030 else if (r
== -ENOTCONN
)
2031 log_debug_errno(r
, "Couldn't adjust quota for subvolume \"%s\" (quota support is disabled).", i
->path
);
2033 q
= log_error_errno(r
, "Failed to adjust quota for subvolume \"%s\": %m", i
->path
);
2035 log_debug("Adjusted quota for subvolume \"%s\".", i
->path
);
2037 log_debug("Quota for subvolume \"%s\" already in place, no change made.", i
->path
);
2040 r
= fd_set_perms(c
, i
, fd
, path
, &st
, creation
);
2041 if (q
< 0) /* prefer the quota change error from above */
2047 static int empty_directory(
2051 CreationMode creation
) {
2053 _cleanup_close_
int fd
= -EBADF
;
2059 assert(i
->type
== EMPTY_DIRECTORY
);
2061 r
= chase(path
, arg_root
, CHASE_SAFE
|CHASE_WARN
, NULL
, &fd
);
2062 if (r
== -ENOLINK
) /* Unsafe symlink: already covered by CHASE_WARN */
2065 /* Option "e" operates only on existing objects. Do not print errors about non-existent files
2067 log_debug_errno(r
, "Skipping missing directory: %s", path
);
2071 return log_error_errno(r
, "Failed to open directory '%s': %m", path
);
2073 if (fstat(fd
, &st
) < 0)
2074 return log_error_errno(errno
, "Failed to fstat(%s): %m", path
);
2075 if (!S_ISDIR(st
.st_mode
)) {
2076 log_warning("'%s' already exists and is not a directory.", path
);
2080 return fd_set_perms(c
, i
, fd
, path
, &st
, creation
);
2083 static int create_device(
2088 _cleanup_close_
int dfd
= -EBADF
, fd
= -EBADF
;
2089 _cleanup_free_
char *bn
= NULL
;
2090 CreationMode creation
;
2096 assert(IN_SET(i
->type
, CREATE_BLOCK_DEVICE
, CREATE_CHAR_DEVICE
));
2097 assert(IN_SET(file_type
, S_IFBLK
, S_IFCHR
));
2099 r
= path_extract_filename(i
->path
, &bn
);
2101 return log_error_errno(r
, "Failed to extract filename from path '%s': %m", i
->path
);
2102 if (r
== O_DIRECTORY
)
2103 return log_error_errno(SYNTHETIC_ERRNO(EISDIR
), "Cannot open path '%s' for creating device node, is a directory.", i
->path
);
2105 /* Validate the path and use the returned directory fd for copying the target so we're sure that the
2106 * path can't be changed behind our back. */
2107 dfd
= path_open_parent_safe(i
->path
, i
->allow_failure
);
2112 mac_selinux_create_file_prepare(i
->path
, file_type
);
2113 r
= RET_NERRNO(mknodat(dfd
, bn
, i
->mode
| file_type
, i
->major_minor
));
2114 mac_selinux_create_file_clear();
2116 creation
= r
>= 0 ? CREATION_NORMAL
: CREATION_EXISTING
;
2118 /* Try to open the inode via O_PATH, regardless if we could create it or not. Maybe everything is in
2119 * order anyway and we hence can ignore the error to create the device node */
2120 fd
= openat(dfd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
);
2122 /* OK, so opening the inode failed, let's look at the original error then. */
2125 if (ERRNO_IS_PRIVILEGE(r
))
2126 goto handle_privilege
;
2128 return log_error_errno(r
, "Failed to create device node '%s': %m", i
->path
);
2131 return log_error_errno(errno
, "Failed to open device node '%s' we just created: %m", i
->path
);
2134 if (fstat(fd
, &st
) < 0)
2135 return log_error_errno(errno
, "Failed to fstat(%s): %m", i
->path
);
2137 if (((st
.st_mode
^ file_type
) & S_IFMT
) != 0) {
2139 if (i
->append_or_force
) {
2140 fd
= safe_close(fd
);
2143 mac_selinux_create_file_prepare(i
->path
, file_type
);
2144 r
= mknodat_atomic(dfd
, bn
, i
->mode
| file_type
, i
->major_minor
);
2145 mac_selinux_create_file_clear();
2147 if (ERRNO_IS_PRIVILEGE(r
))
2148 goto handle_privilege
;
2149 if (IN_SET(r
, -EISDIR
, -EEXIST
, -ENOTEMPTY
)) {
2150 r
= rm_rf_child(dfd
, bn
, REMOVE_PHYSICAL
);
2152 return log_error_errno(r
, "rm -rf %s failed: %m", i
->path
);
2154 mac_selinux_create_file_prepare(i
->path
, file_type
);
2155 r
= RET_NERRNO(mknodat(dfd
, bn
, i
->mode
| file_type
, i
->major_minor
));
2156 mac_selinux_create_file_clear();
2159 return log_error_errno(r
, "Failed to create device node '%s': %m", i
->path
);
2161 fd
= openat(dfd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
);
2163 return log_error_errno(errno
, "Failed to open device node we just created '%s': %m", i
->path
);
2165 /* Validate type before change ownership below */
2166 if (fstat(fd
, &st
) < 0)
2167 return log_error_errno(errno
, "Failed to fstat(%s): %m", i
->path
);
2169 if (((st
.st_mode
^ file_type
) & S_IFMT
) != 0)
2170 return log_error_errno(SYNTHETIC_ERRNO(EBADF
), "Device node we just created is not a device node, refusing.");
2172 creation
= CREATION_FORCE
;
2174 log_warning("\"%s\" already exists and is not a device node.", i
->path
);
2179 log_debug("%s %s device node \"%s\" %u:%u.",
2180 creation_mode_verb_to_string(creation
),
2181 i
->type
== CREATE_BLOCK_DEVICE
? "block" : "char",
2182 i
->path
, major(i
->mode
), minor(i
->mode
));
2184 return fd_set_perms(c
, i
, fd
, i
->path
, &st
, creation
);
2188 "We lack permissions, possibly because of cgroup configuration; "
2189 "skipping creation of device node '%s'.", i
->path
);
2193 static int create_fifo(Context
*c
, Item
*i
) {
2194 _cleanup_close_
int pfd
= -EBADF
, fd
= -EBADF
;
2195 _cleanup_free_
char *bn
= NULL
;
2196 CreationMode creation
;
2202 assert(i
->type
== CREATE_FIFO
);
2204 r
= path_extract_filename(i
->path
, &bn
);
2206 return log_error_errno(r
, "Failed to extract filename from path '%s': %m", i
->path
);
2207 if (r
== O_DIRECTORY
)
2208 return log_error_errno(SYNTHETIC_ERRNO(EISDIR
), "Cannot open path '%s' for creating FIFO, is a directory.", i
->path
);
2210 pfd
= path_open_parent_safe(i
->path
, i
->allow_failure
);
2215 mac_selinux_create_file_prepare(i
->path
, S_IFIFO
);
2216 r
= RET_NERRNO(mkfifoat(pfd
, bn
, i
->mode
));
2217 mac_selinux_create_file_clear();
2220 creation
= r
>= 0 ? CREATION_NORMAL
: CREATION_EXISTING
;
2222 /* Open the inode via O_PATH, regardless if we managed to create it or not. Maybe it is already the FIFO we want */
2223 fd
= openat(pfd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
);
2226 return log_error_errno(r
, "Failed to create FIFO %s: %m", i
->path
); /* original error! */
2228 return log_error_errno(errno
, "Failed to open FIFO we just created %s: %m", i
->path
);
2231 if (fstat(fd
, &st
) < 0)
2232 return log_error_errno(errno
, "Failed to fstat(%s): %m", i
->path
);
2234 if (!S_ISFIFO(st
.st_mode
)) {
2236 if (i
->append_or_force
) {
2237 fd
= safe_close(fd
);
2240 mac_selinux_create_file_prepare(i
->path
, S_IFIFO
);
2241 r
= mkfifoat_atomic(pfd
, bn
, i
->mode
);
2242 mac_selinux_create_file_clear();
2244 if (IN_SET(r
, -EISDIR
, -EEXIST
, -ENOTEMPTY
)) {
2245 r
= rm_rf_child(pfd
, bn
, REMOVE_PHYSICAL
);
2247 return log_error_errno(r
, "rm -rf %s failed: %m", i
->path
);
2249 mac_selinux_create_file_prepare(i
->path
, S_IFIFO
);
2250 r
= RET_NERRNO(mkfifoat(pfd
, bn
, i
->mode
));
2251 mac_selinux_create_file_clear();
2254 return log_error_errno(r
, "Failed to create FIFO %s: %m", i
->path
);
2256 fd
= openat(pfd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
);
2258 return log_error_errno(errno
, "Failed to open FIFO we just created '%s': %m", i
->path
);
2260 /* Validate type before change ownership below */
2261 if (fstat(fd
, &st
) < 0)
2262 return log_error_errno(errno
, "Failed to fstat(%s): %m", i
->path
);
2264 if (!S_ISFIFO(st
.st_mode
))
2265 return log_error_errno(SYNTHETIC_ERRNO(EBADF
), "FIFO inode we just created is not a FIFO, refusing.");
2267 creation
= CREATION_FORCE
;
2269 log_warning("\"%s\" already exists and is not a FIFO.", i
->path
);
2274 log_debug("%s fifo \"%s\".", creation_mode_verb_to_string(creation
), i
->path
);
2276 return fd_set_perms(c
, i
, fd
, i
->path
, &st
, creation
);
2279 static int create_symlink(Context
*c
, Item
*i
) {
2280 _cleanup_close_
int pfd
= -EBADF
, fd
= -EBADF
;
2281 _cleanup_free_
char *bn
= NULL
;
2282 CreationMode creation
;
2290 r
= path_extract_filename(i
->path
, &bn
);
2292 return log_error_errno(r
, "Failed to extract filename from path '%s': %m", i
->path
);
2293 if (r
== O_DIRECTORY
)
2294 return log_error_errno(SYNTHETIC_ERRNO(EISDIR
), "Cannot open path '%s' for creating FIFO, is a directory.", i
->path
);
2296 pfd
= path_open_parent_safe(i
->path
, i
->allow_failure
);
2300 mac_selinux_create_file_prepare(i
->path
, S_IFLNK
);
2301 r
= RET_NERRNO(symlinkat(i
->argument
, pfd
, bn
));
2302 mac_selinux_create_file_clear();
2304 creation
= r
>= 0 ? CREATION_NORMAL
: CREATION_EXISTING
;
2306 fd
= openat(pfd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
);
2309 return log_error_errno(r
, "Failed to create symlink '%s': %m", i
->path
); /* original error! */
2311 return log_error_errno(errno
, "Failed to open symlink we just created '%s': %m", i
->path
);
2314 if (fstat(fd
, &st
) < 0)
2315 return log_error_errno(errno
, "Failed to fstat(%s): %m", i
->path
);
2317 if (S_ISLNK(st
.st_mode
)) {
2318 _cleanup_free_
char *x
= NULL
;
2320 r
= readlinkat_malloc(fd
, "", &x
);
2322 return log_error_errno(r
, "readlinkat(%s) failed: %m", i
->path
);
2324 good
= streq(x
, i
->argument
);
2329 if (!i
->append_or_force
) {
2330 log_debug("\"%s\" is not a symlink or does not point to the correct path.", i
->path
);
2334 fd
= safe_close(fd
);
2336 mac_selinux_create_file_prepare(i
->path
, S_IFLNK
);
2337 r
= symlinkat_atomic_full(i
->argument
, pfd
, bn
, /* make_relative= */ false);
2338 mac_selinux_create_file_clear();
2339 if (IN_SET(r
, -EISDIR
, -EEXIST
, -ENOTEMPTY
)) {
2340 r
= rm_rf_child(pfd
, bn
, REMOVE_PHYSICAL
);
2342 return log_error_errno(r
, "rm -rf %s failed: %m", i
->path
);
2344 mac_selinux_create_file_prepare(i
->path
, S_IFLNK
);
2345 r
= RET_NERRNO(symlinkat(i
->argument
, pfd
, i
->path
));
2346 mac_selinux_create_file_clear();
2349 return log_error_errno(r
, "symlink(%s, %s) failed: %m", i
->argument
, i
->path
);
2351 fd
= openat(pfd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
);
2353 return log_error_errno(errno
, "Failed to open symlink we just created '%s': %m", i
->path
);
2355 /* Validate type before change ownership below */
2356 if (fstat(fd
, &st
) < 0)
2357 return log_error_errno(errno
, "Failed to fstat(%s): %m", i
->path
);
2359 if (!S_ISLNK(st
.st_mode
))
2360 return log_error_errno(SYNTHETIC_ERRNO(EBADF
), "Symlink we just created is not a symlink, refusing.");
2362 creation
= CREATION_FORCE
;
2365 log_debug("%s symlink \"%s\".", creation_mode_verb_to_string(creation
), i
->path
);
2366 return fd_set_perms(c
, i
, fd
, i
->path
, &st
, creation
);
2369 typedef int (*action_t
)(Context
*c
, Item
*i
, const char *path
, CreationMode creation
);
2370 typedef int (*fdaction_t
)(Context
*c
, Item
*i
, int fd
, const char *path
, const struct stat
*st
, CreationMode creation
);
2377 CreationMode creation
,
2378 fdaction_t action
) {
2388 if (fstat(fd
, &st
) < 0) {
2389 r
= log_error_errno(errno
, "fstat() on file failed: %m");
2393 /* This returns the first error we run into, but nevertheless tries to go on */
2394 r
= action(c
, i
, fd
, path
, &st
, creation
);
2396 if (S_ISDIR(st
.st_mode
)) {
2397 _cleanup_closedir_
DIR *d
= NULL
;
2399 /* The passed 'fd' was opened with O_PATH. We need to convert it into a 'regular' fd before
2400 * reading the directory content. */
2401 d
= opendir(FORMAT_PROC_FD_PATH(fd
));
2403 log_error_errno(errno
, "Failed to opendir() '%s': %m", FORMAT_PROC_FD_PATH(fd
));
2409 FOREACH_DIRENT_ALL(de
, d
, q
= -errno
; goto finish
) {
2412 if (dot_or_dot_dot(de
->d_name
))
2415 de_fd
= openat(fd
, de
->d_name
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
);
2417 q
= log_error_errno(errno
, "Failed to open() file '%s': %m", de
->d_name
);
2419 _cleanup_free_
char *de_path
= NULL
;
2421 de_path
= path_join(path
, de
->d_name
);
2425 /* Pass ownership of dirent fd over */
2426 q
= item_do(c
, i
, de_fd
, de_path
, CREATION_EXISTING
, action
);
2429 if (q
< 0 && r
== 0)
2438 static int glob_item(Context
*c
, Item
*i
, action_t action
) {
2439 _cleanup_globfree_ glob_t g
= {
2440 .gl_opendir
= (void *(*)(const char *)) opendir_nomod
,
2447 k
= safe_glob(i
->path
, GLOB_NOSORT
|GLOB_BRACE
, &g
);
2448 if (k
< 0 && k
!= -ENOENT
)
2449 return log_error_errno(k
, "glob(%s) failed: %m", i
->path
);
2451 STRV_FOREACH(fn
, g
.gl_pathv
) {
2452 /* We pass CREATION_EXISTING here, since if we are globbing for it, it always has to exist */
2453 k
= action(c
, i
, *fn
, CREATION_EXISTING
);
2454 if (k
< 0 && r
== 0)
2461 static int glob_item_recursively(
2464 fdaction_t action
) {
2466 _cleanup_globfree_ glob_t g
= {
2467 .gl_opendir
= (void *(*)(const char *)) opendir_nomod
,
2471 k
= safe_glob(i
->path
, GLOB_NOSORT
|GLOB_BRACE
, &g
);
2472 if (k
< 0 && k
!= -ENOENT
)
2473 return log_error_errno(k
, "glob(%s) failed: %m", i
->path
);
2475 STRV_FOREACH(fn
, g
.gl_pathv
) {
2476 _cleanup_close_
int fd
= -EBADF
;
2478 /* Make sure we won't trigger/follow file object (such as
2479 * device nodes, automounts, ...) pointed out by 'fn' with
2480 * O_PATH. Note, when O_PATH is used, flags other than
2481 * O_CLOEXEC, O_DIRECTORY, and O_NOFOLLOW are ignored. */
2483 fd
= open(*fn
, O_CLOEXEC
|O_NOFOLLOW
|O_PATH
);
2485 log_error_errno(errno
, "Opening '%s' failed: %m", *fn
);
2491 k
= item_do(c
, i
, fd
, *fn
, CREATION_EXISTING
, action
);
2492 if (k
< 0 && r
== 0)
2495 /* we passed fd ownership to the previous call */
2502 static int rm_if_wrong_type_safe(
2505 const struct stat
*parent_st
, /* Only used if follow_links below is true. */
2508 _cleanup_free_
char *parent_name
= NULL
;
2509 bool follow_links
= !FLAGS_SET(flags
, AT_SYMLINK_NOFOLLOW
);
2514 assert((mode
& ~S_IFMT
) == 0);
2515 assert(!follow_links
|| parent_st
);
2516 assert((flags
& ~AT_SYMLINK_NOFOLLOW
) == 0);
2518 if (!filename_is_valid(name
))
2519 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "\"%s\" is not a valid filename.", name
);
2521 r
= fstatat_harder(parent_fd
, name
, &st
, flags
, REMOVE_CHMOD
| REMOVE_CHMOD_RESTORE
);
2523 (void) fd_get_path(parent_fd
, &parent_name
);
2524 return log_full_errno(r
== -ENOENT
? LOG_DEBUG
: LOG_ERR
, r
,
2525 "Failed to stat \"%s\" at \"%s\": %m", name
, strna(parent_name
));
2528 /* Fail before removing anything if this is an unsafe transition. */
2529 if (follow_links
&& unsafe_transition(parent_st
, &st
)) {
2530 (void) fd_get_path(parent_fd
, &parent_name
);
2531 return log_error_errno(SYNTHETIC_ERRNO(ENOLINK
),
2532 "Unsafe transition from \"%s\" to \"%s\".", parent_name
, name
);
2535 if ((st
.st_mode
& S_IFMT
) == mode
)
2538 (void) fd_get_path(parent_fd
, &parent_name
);
2539 log_notice("Wrong file type 0o%o; rm -rf \"%s/%s\"", st
.st_mode
& S_IFMT
, strna(parent_name
), name
);
2541 /* If the target of the symlink was the wrong type, the link needs to be removed instead of the
2542 * target, so make sure it is identified as a link and not a directory. */
2544 r
= fstatat_harder(parent_fd
, name
, &st
, AT_SYMLINK_NOFOLLOW
, REMOVE_CHMOD
| REMOVE_CHMOD_RESTORE
);
2546 return log_error_errno(r
, "Failed to stat \"%s\" at \"%s\": %m", name
, strna(parent_name
));
2549 /* Do not remove mount points. */
2550 r
= fd_is_mount_point(parent_fd
, name
, follow_links
? AT_SYMLINK_FOLLOW
: 0);
2552 (void) log_warning_errno(r
, "Failed to check if \"%s/%s\" is a mount point: %m; Continuing",
2553 strna(parent_name
), name
);
2555 return log_error_errno(SYNTHETIC_ERRNO(EBUSY
),
2556 "Not removing \"%s/%s\" because it is a mount point.", strna(parent_name
), name
);
2558 if ((st
.st_mode
& S_IFMT
) == S_IFDIR
) {
2559 _cleanup_close_
int child_fd
= -EBADF
;
2561 child_fd
= openat(parent_fd
, name
, O_NOCTTY
| O_CLOEXEC
| O_DIRECTORY
);
2563 return log_error_errno(errno
, "Failed to open \"%s\" at \"%s\": %m", name
, strna(parent_name
));
2565 r
= rm_rf_children(TAKE_FD(child_fd
), REMOVE_ROOT
|REMOVE_SUBVOLUME
|REMOVE_PHYSICAL
, &st
);
2567 return log_error_errno(r
, "Failed to remove contents of \"%s\" at \"%s\": %m", name
, strna(parent_name
));
2569 r
= unlinkat_harder(parent_fd
, name
, AT_REMOVEDIR
, REMOVE_CHMOD
| REMOVE_CHMOD_RESTORE
);
2571 r
= unlinkat_harder(parent_fd
, name
, 0, REMOVE_CHMOD
| REMOVE_CHMOD_RESTORE
);
2573 return log_error_errno(r
, "Failed to remove \"%s\" at \"%s\": %m", name
, strna(parent_name
));
2575 /* This is covered by the log_notice "Wrong file type..." It is logged earlier because it gives
2576 * context to other error messages that might follow. */
2580 /* If child_mode is non-zero, rm_if_wrong_type_safe will be executed for the last path component. */
2581 static int mkdir_parents_rm_if_wrong_type(mode_t child_mode
, const char *path
) {
2582 _cleanup_close_
int parent_fd
= -EBADF
;
2583 struct stat parent_st
;
2588 assert((child_mode
& ~S_IFMT
) == 0);
2590 path_len
= strlen(path
);
2593 /* rm_if_wrong_type_safe already logs errors. */
2594 return child_mode
!= 0 ? rm_if_wrong_type_safe(child_mode
, AT_FDCWD
, NULL
, path
, AT_SYMLINK_NOFOLLOW
) : 0;
2596 if (child_mode
!= 0 && endswith(path
, "/"))
2597 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
2598 "Trailing path separators are only allowed if child_mode is not set; got \"%s\"", path
);
2600 /* Get the parent_fd and stat. */
2601 parent_fd
= openat(AT_FDCWD
, path_is_absolute(path
) ? "/" : ".", O_NOCTTY
| O_CLOEXEC
| O_DIRECTORY
);
2603 return log_error_errno(errno
, "Failed to open root: %m");
2605 if (fstat(parent_fd
, &parent_st
) < 0)
2606 return log_error_errno(errno
, "Failed to stat root: %m");
2608 /* Check every parent directory in the path, except the last component */
2609 for (const char *e
= path
;;) {
2610 _cleanup_close_
int next_fd
= -EBADF
;
2611 char t
[path_len
+ 1];
2614 /* Find the start of the next path component. */
2615 s
= e
+ strspn(e
, "/");
2616 /* Find the end of the next path component. */
2617 e
= s
+ strcspn(s
, "/");
2619 /* Copy the path component to t so it can be a null terminated string. */
2620 *((char*) mempcpy(t
, s
, e
- s
)) = 0;
2622 /* Is this the last component? If so, then check the type */
2624 return child_mode
!= 0 ? rm_if_wrong_type_safe(child_mode
, parent_fd
, &parent_st
, t
, AT_SYMLINK_NOFOLLOW
) : 0;
2626 r
= rm_if_wrong_type_safe(S_IFDIR
, parent_fd
, &parent_st
, t
, 0);
2627 /* Remove dangling symlinks. */
2629 r
= rm_if_wrong_type_safe(S_IFDIR
, parent_fd
, &parent_st
, t
, AT_SYMLINK_NOFOLLOW
);
2632 r
= mkdirat_label(parent_fd
, t
, 0755);
2634 _cleanup_free_
char *parent_name
= NULL
;
2636 (void) fd_get_path(parent_fd
, &parent_name
);
2637 return log_error_errno(r
, "Failed to mkdir \"%s\" at \"%s\": %m", t
, strnull(parent_name
));
2640 /* rm_if_wrong_type_safe already logs errors. */
2643 next_fd
= RET_NERRNO(openat(parent_fd
, t
, O_NOCTTY
| O_CLOEXEC
| O_DIRECTORY
));
2645 _cleanup_free_
char *parent_name
= NULL
;
2647 (void) fd_get_path(parent_fd
, &parent_name
);
2648 return log_error_errno(next_fd
, "Failed to open \"%s\" at \"%s\": %m", t
, strnull(parent_name
));
2650 r
= RET_NERRNO(fstat(next_fd
, &parent_st
));
2652 _cleanup_free_
char *parent_name
= NULL
;
2654 (void) fd_get_path(parent_fd
, &parent_name
);
2655 return log_error_errno(r
, "Failed to stat \"%s\" at \"%s\": %m", t
, strnull(parent_name
));
2658 close_and_replace(parent_fd
, next_fd
);
2662 static int mkdir_parents_item(Item
*i
, mode_t child_mode
) {
2664 if (i
->try_replace
) {
2665 r
= mkdir_parents_rm_if_wrong_type(child_mode
, i
->path
);
2666 if (r
< 0 && r
!= -ENOENT
)
2670 (void) mkdir_parents_label(i
->path
, 0755);
2675 static int create_item(Context
*c
, Item
*i
) {
2681 log_debug("Running create action for entry %c %s", (char) i
->type
, i
->path
);
2686 case IGNORE_DIRECTORY_PATH
:
2688 case RECURSIVE_REMOVE_PATH
:
2693 r
= mkdir_parents_item(i
, S_IFREG
);
2697 if ((i
->type
== CREATE_FILE
&& i
->append_or_force
) || i
->type
== TRUNCATE_FILE
)
2698 r
= truncate_file(c
, i
, i
->path
);
2700 r
= create_file(c
, i
, i
->path
);
2706 r
= mkdir_parents_item(i
, 0);
2710 r
= copy_files(c
, i
);
2716 r
= glob_item(c
, i
, write_one_file
);
2722 case CREATE_DIRECTORY
:
2723 case TRUNCATE_DIRECTORY
:
2724 r
= mkdir_parents_item(i
, S_IFDIR
);
2728 r
= create_directory(c
, i
, i
->path
);
2733 case CREATE_SUBVOLUME
:
2734 case CREATE_SUBVOLUME_INHERIT_QUOTA
:
2735 case CREATE_SUBVOLUME_NEW_QUOTA
:
2736 r
= mkdir_parents_item(i
, S_IFDIR
);
2740 r
= create_subvolume(c
, i
, i
->path
);
2745 case EMPTY_DIRECTORY
:
2746 r
= glob_item(c
, i
, empty_directory
);
2752 r
= mkdir_parents_item(i
, S_IFIFO
);
2756 r
= create_fifo(c
, i
);
2761 case CREATE_SYMLINK
:
2762 r
= mkdir_parents_item(i
, S_IFLNK
);
2766 r
= create_symlink(c
, i
);
2772 case CREATE_BLOCK_DEVICE
:
2773 case CREATE_CHAR_DEVICE
:
2774 if (have_effective_cap(CAP_MKNOD
) <= 0) {
2775 /* In a container we lack CAP_MKNOD. We shouldn't attempt to create the device node in that
2776 * case to avoid noise, and we don't support virtualized devices in containers anyway. */
2778 log_debug("We lack CAP_MKNOD, skipping creation of device node %s.", i
->path
);
2782 r
= mkdir_parents_item(i
, i
->type
== CREATE_BLOCK_DEVICE
? S_IFBLK
: S_IFCHR
);
2786 r
= create_device(c
, i
, i
->type
== CREATE_BLOCK_DEVICE
? S_IFBLK
: S_IFCHR
);
2794 r
= glob_item(c
, i
, path_set_perms
);
2799 case RECURSIVE_RELABEL_PATH
:
2800 r
= glob_item_recursively(c
, i
, fd_set_perms
);
2806 r
= glob_item(c
, i
, path_set_xattrs
);
2811 case RECURSIVE_SET_XATTR
:
2812 r
= glob_item_recursively(c
, i
, fd_set_xattrs
);
2818 r
= glob_item(c
, i
, path_set_acls
);
2823 case RECURSIVE_SET_ACL
:
2824 r
= glob_item_recursively(c
, i
, fd_set_acls
);
2830 r
= glob_item(c
, i
, path_set_attribute
);
2835 case RECURSIVE_SET_ATTRIBUTE
:
2836 r
= glob_item_recursively(c
, i
, fd_set_attribute
);
2845 static int purge_item_instance(Context
*c
, Item
*i
, const char *instance
, CreationMode creation
) {
2848 /* FIXME: we probably should use dir_cleanup() here instead of rm_rf() so that 'x' is honoured. */
2849 log_debug("rm -rf \"%s\"", instance
);
2850 r
= rm_rf(instance
, REMOVE_ROOT
|REMOVE_SUBVOLUME
|REMOVE_PHYSICAL
);
2851 if (r
< 0 && r
!= -ENOENT
)
2852 return log_error_errno(r
, "rm_rf(%s): %m", instance
);
2857 static int purge_item(Context
*c
, Item
*i
) {
2861 if (!needs_purge(i
->type
))
2864 log_debug("Running purge owned action for entry %c %s", (char) i
->type
, i
->path
);
2866 if (needs_glob(i
->type
))
2867 return glob_item(c
, i
, purge_item_instance
);
2869 return purge_item_instance(c
, i
, i
->path
, CREATION_EXISTING
);
2872 static int remove_item_instance(
2875 const char *instance
,
2876 CreationMode creation
) {
2886 if (remove(instance
) < 0 && errno
!= ENOENT
)
2887 return log_error_errno(errno
, "rm(%s): %m", instance
);
2891 case RECURSIVE_REMOVE_PATH
:
2892 /* FIXME: we probably should use dir_cleanup() here instead of rm_rf() so that 'x' is honoured. */
2893 log_debug("rm -rf \"%s\"", instance
);
2894 r
= rm_rf(instance
, REMOVE_ROOT
|REMOVE_SUBVOLUME
|REMOVE_PHYSICAL
);
2895 if (r
< 0 && r
!= -ENOENT
)
2896 return log_error_errno(r
, "rm_rf(%s): %m", instance
);
2901 assert_not_reached();
2907 static int remove_item(Context
*c
, Item
*i
) {
2913 log_debug("Running remove action for entry %c %s", (char) i
->type
, i
->path
);
2917 case TRUNCATE_DIRECTORY
:
2918 /* FIXME: we probably should use dir_cleanup() here instead of rm_rf() so that 'x' is honoured. */
2919 log_debug("rm -rf \"%s\"", i
->path
);
2920 r
= rm_rf(i
->path
, REMOVE_PHYSICAL
);
2921 if (r
< 0 && r
!= -ENOENT
)
2922 return log_error_errno(r
, "rm_rf(%s): %m", i
->path
);
2927 case RECURSIVE_REMOVE_PATH
:
2928 return glob_item(c
, i
, remove_item_instance
);
2935 static char *age_by_to_string(AgeBy ab
, bool is_dir
) {
2936 static const char ab_map
[] = { 'a', 'b', 'c', 'm' };
2940 ret
= new(char, ELEMENTSOF(ab_map
) + 1);
2944 for (size_t i
= 0; i
< ELEMENTSOF(ab_map
); i
++)
2945 if (FLAGS_SET(ab
, 1U << i
))
2946 ret
[j
++] = is_dir
? ascii_toupper(ab_map
[i
]) : ab_map
[i
];
2952 static int clean_item_instance(
2955 const char* instance
,
2956 CreationMode creation
) {
2958 _cleanup_closedir_
DIR *d
= NULL
;
2959 STRUCT_STATX_DEFINE(sx
);
2968 n
= now(CLOCK_REALTIME
);
2972 cutoff
= n
- i
->age
;
2974 d
= opendir_nomod(instance
);
2976 if (IN_SET(errno
, ENOENT
, ENOTDIR
)) {
2977 log_debug_errno(errno
, "Directory \"%s\": %m", instance
);
2981 return log_error_errno(errno
, "Failed to open directory %s: %m", instance
);
2984 r
= statx_fallback(dirfd(d
), "", AT_EMPTY_PATH
, STATX_MODE
|STATX_INO
|STATX_ATIME
|STATX_MTIME
, &sx
);
2986 return log_error_errno(r
, "statx(%s) failed: %m", instance
);
2988 if (FLAGS_SET(sx
.stx_attributes_mask
, STATX_ATTR_MOUNT_ROOT
))
2989 mountpoint
= FLAGS_SET(sx
.stx_attributes
, STATX_ATTR_MOUNT_ROOT
);
2993 if (fstatat(dirfd(d
), "..", &ps
, AT_SYMLINK_NOFOLLOW
) != 0)
2994 return log_error_errno(errno
, "stat(%s/..) failed: %m", i
->path
);
2997 sx
.stx_dev_major
!= major(ps
.st_dev
) ||
2998 sx
.stx_dev_minor
!= minor(ps
.st_dev
) ||
2999 sx
.stx_ino
!= ps
.st_ino
;
3002 if (DEBUG_LOGGING
) {
3003 _cleanup_free_
char *ab_f
= NULL
, *ab_d
= NULL
;
3005 ab_f
= age_by_to_string(i
->age_by_file
, false);
3009 ab_d
= age_by_to_string(i
->age_by_dir
, true);
3013 log_debug("Cleanup threshold for %s \"%s\" is %s; age-by: %s%s",
3014 mountpoint
? "mount point" : "directory",
3016 FORMAT_TIMESTAMP_STYLE(cutoff
, TIMESTAMP_US
),
3020 return dir_cleanup(c
, i
, instance
, d
,
3021 statx_timestamp_load_nsec(&sx
.stx_atime
),
3022 statx_timestamp_load_nsec(&sx
.stx_mtime
),
3023 cutoff
* NSEC_PER_USEC
,
3024 sx
.stx_dev_major
, sx
.stx_dev_minor
, mountpoint
,
3025 MAX_DEPTH
, i
->keep_first_level
,
3026 i
->age_by_file
, i
->age_by_dir
);
3029 static int clean_item(Context
*c
, Item
*i
) {
3033 log_debug("Running clean action for entry %c %s", (char) i
->type
, i
->path
);
3037 case CREATE_DIRECTORY
:
3038 case TRUNCATE_DIRECTORY
:
3039 case CREATE_SUBVOLUME
:
3040 case CREATE_SUBVOLUME_INHERIT_QUOTA
:
3041 case CREATE_SUBVOLUME_NEW_QUOTA
:
3043 clean_item_instance(c
, i
, i
->path
, CREATION_EXISTING
);
3046 case EMPTY_DIRECTORY
:
3048 case IGNORE_DIRECTORY_PATH
:
3049 return glob_item(c
, i
, clean_item_instance
);
3056 static int process_item(
3059 OperationMask operation
) {
3062 _cleanup_free_
char *_path
= NULL
;
3069 todo
= operation
& ~i
->done
;
3070 if (todo
== 0) /* Everything already done? */
3073 i
->done
|= operation
;
3076 if (string_is_glob(path
)) {
3077 /* We can't easily check whether a glob matches any autofs path, so let's do the check only
3078 * for the non-glob part. */
3080 r
= glob_non_glob_prefix(path
, &_path
);
3081 if (r
< 0 && r
!= -ENOENT
)
3082 return log_debug_errno(r
, "Failed to deglob path: %m");
3087 r
= chase(path
, arg_root
, CHASE_NO_AUTOFS
|CHASE_NONEXISTENT
|CHASE_WARN
, NULL
, NULL
);
3088 if (r
== -EREMOTE
) {
3089 log_notice_errno(r
, "Skipping %s", i
->path
); /* We log the configured path, to not confuse the user. */
3093 log_debug_errno(r
, "Failed to determine whether '%s' is below autofs, ignoring: %m", i
->path
);
3095 r
= FLAGS_SET(operation
, OPERATION_CREATE
) ? create_item(c
, i
) : 0;
3096 /* Failure can only be tolerated for create */
3097 if (i
->allow_failure
)
3100 RET_GATHER(r
, FLAGS_SET(operation
, OPERATION_REMOVE
) ? remove_item(c
, i
) : 0);
3101 RET_GATHER(r
, FLAGS_SET(operation
, OPERATION_CLEAN
) ? clean_item(c
, i
) : 0);
3102 RET_GATHER(r
, FLAGS_SET(operation
, OPERATION_PURGE
) ? purge_item(c
, i
) : 0);
3107 static int process_item_array(
3110 OperationMask operation
) {
3118 /* Create any parent first. */
3119 if (FLAGS_SET(operation
, OPERATION_CREATE
) && array
->parent
)
3120 r
= process_item_array(c
, array
->parent
, operation
& OPERATION_CREATE
);
3122 /* Clean up all children first */
3123 if ((operation
& (OPERATION_REMOVE
|OPERATION_CLEAN
|OPERATION_PURGE
)) && !set_isempty(array
->children
)) {
3126 SET_FOREACH(cc
, array
->children
) {
3129 k
= process_item_array(c
, cc
, operation
& (OPERATION_REMOVE
|OPERATION_CLEAN
|OPERATION_PURGE
));
3130 if (k
< 0 && r
== 0)
3135 for (n
= 0; n
< array
->n_items
; n
++) {
3138 k
= process_item(c
, array
->items
+ n
, operation
);
3139 if (k
< 0 && r
== 0)
3146 static void item_free_contents(Item
*i
) {
3150 free(i
->binary_argument
);
3151 strv_free(i
->xattrs
);
3155 acl_free(i
->acl_access
);
3157 if (i
->acl_access_exec
)
3158 acl_free(i
->acl_access_exec
);
3161 acl_free(i
->acl_default
);
3165 static ItemArray
* item_array_free(ItemArray
*a
) {
3171 for (n
= 0; n
< a
->n_items
; n
++)
3172 item_free_contents(a
->items
+ n
);
3174 set_free(a
->children
);
3179 static int item_compare(const Item
*a
, const Item
*b
) {
3180 /* Make sure that the ownership taking item is put first, so
3181 * that we first create the node, and then can adjust it */
3183 if (takes_ownership(a
->type
) && !takes_ownership(b
->type
))
3185 if (!takes_ownership(a
->type
) && takes_ownership(b
->type
))
3188 return CMP(a
->type
, b
->type
);
3191 static bool item_compatible(const Item
*a
, const Item
*b
) {
3194 assert(streq(a
->path
, b
->path
));
3196 if (takes_ownership(a
->type
) && takes_ownership(b
->type
))
3197 /* check if the items are the same */
3198 return memcmp_nn(item_binary_argument(a
), item_binary_argument_size(a
),
3199 item_binary_argument(b
), item_binary_argument_size(b
)) == 0 &&
3201 a
->uid_set
== b
->uid_set
&&
3203 a
->uid_only_create
== b
->uid_only_create
&&
3205 a
->gid_set
== b
->gid_set
&&
3207 a
->gid_only_create
== b
->gid_only_create
&&
3209 a
->mode_set
== b
->mode_set
&&
3210 a
->mode
== b
->mode
&&
3211 a
->mode_only_create
== b
->mode_only_create
&&
3213 a
->age_set
== b
->age_set
&&
3216 a
->age_by_file
== b
->age_by_file
&&
3217 a
->age_by_dir
== b
->age_by_dir
&&
3219 a
->mask_perms
== b
->mask_perms
&&
3221 a
->keep_first_level
== b
->keep_first_level
&&
3223 a
->major_minor
== b
->major_minor
;
3228 static bool should_include_path(const char *path
) {
3229 STRV_FOREACH(prefix
, arg_exclude_prefixes
)
3230 if (path_startswith(path
, *prefix
)) {
3231 log_debug("Entry \"%s\" matches exclude prefix \"%s\", skipping.",
3236 STRV_FOREACH(prefix
, arg_include_prefixes
)
3237 if (path_startswith(path
, *prefix
)) {
3238 log_debug("Entry \"%s\" matches include prefix \"%s\".", path
, *prefix
);
3242 /* no matches, so we should include this path only if we have no allow list at all */
3243 if (strv_isempty(arg_include_prefixes
))
3246 log_debug("Entry \"%s\" does not match any include prefix, skipping.", path
);
3250 static int specifier_expansion_from_arg(const Specifier
*specifier_table
, Item
*i
) {
3260 case CREATE_SYMLINK
:
3264 _cleanup_free_
char *unescaped
= NULL
, *resolved
= NULL
;
3267 l
= cunescape(i
->argument
, 0, &unescaped
);
3269 return log_error_errno(l
, "Failed to unescape parameter to write: %s", i
->argument
);
3271 r
= specifier_printf(unescaped
, PATH_MAX
-1, specifier_table
, arg_root
, NULL
, &resolved
);
3275 return free_and_replace(i
->argument
, resolved
);
3278 case RECURSIVE_SET_XATTR
:
3279 STRV_FOREACH(xattr
, i
->xattrs
) {
3280 _cleanup_free_
char *resolved
= NULL
;
3282 r
= specifier_printf(*xattr
, SIZE_MAX
, specifier_table
, arg_root
, NULL
, &resolved
);
3286 free_and_replace(*xattr
, resolved
);
3295 static int patch_var_run(const char *fname
, unsigned line
, char **path
) {
3302 /* Optionally rewrites lines referencing /var/run/, to use /run/ instead. Why bother? tmpfiles merges lines in
3303 * some cases and detects conflicts in others. If files/directories are specified through two equivalent lines
3304 * this is problematic as neither case will be detected. Ideally we'd detect these cases by resolving symlinks
3305 * early, but that's precisely not what we can do here as this code very likely is running very early on, at a
3306 * time where the paths in question are not available yet, or even more importantly, our own tmpfiles rules
3307 * might create the paths that are intermediary to the listed paths. We can't really cover the generic case,
3308 * but the least we can do is cover the specific case of /var/run vs. /run, as /var/run is a legacy name for
3309 * /run only, and we explicitly document that and require that on systemd systems the former is a symlink to
3310 * the latter. Moreover files below this path are by far the primary use case for tmpfiles.d/. */
3312 k
= path_startswith(*path
, "/var/run/");
3313 if (isempty(k
)) /* Don't complain about other paths than /var/run, and not about /var/run itself either. */
3316 n
= path_join("/run", k
);
3320 /* Also log about this briefly. We do so at LOG_NOTICE level, as we fixed up the situation automatically, hence
3321 * there's no immediate need for action by the user. However, in the interest of making things less confusing
3322 * to the user, let's still inform the user that these snippets should really be updated. */
3323 log_syntax(NULL
, LOG_NOTICE
, fname
, line
, 0,
3324 "Line references path below legacy directory /var/run/, updating %s → %s; please update the tmpfiles.d/ drop-in file accordingly.",
3327 free_and_replace(*path
, n
);
3332 static int find_uid(const char *user
, uid_t
*ret_uid
, Hashmap
**cache
) {
3338 /* First: parse as numeric UID string */
3339 r
= parse_uid(user
, ret_uid
);
3343 /* Second: pass to NSS if we are running "online" */
3345 return get_user_creds(&user
, ret_uid
, NULL
, NULL
, NULL
, 0);
3347 /* Third, synthesize "root" unconditionally */
3348 if (streq(user
, "root")) {
3353 /* Fourth: use fgetpwent() to read /etc/passwd directly, if we are "offline" */
3354 return name_to_uid_offline(arg_root
, user
, ret_uid
, cache
);
3357 static int find_gid(const char *group
, gid_t
*ret_gid
, Hashmap
**cache
) {
3363 /* First: parse as numeric GID string */
3364 r
= parse_gid(group
, ret_gid
);
3368 /* Second: pass to NSS if we are running "online" */
3370 return get_group_creds(&group
, ret_gid
, 0);
3372 /* Third, synthesize "root" unconditionally */
3373 if (streq(group
, "root")) {
3378 /* Fourth: use fgetgrent() to read /etc/group directly, if we are "offline" */
3379 return name_to_gid_offline(arg_root
, group
, ret_gid
, cache
);
3382 static int parse_age_by_from_arg(const char *age_by_str
, Item
*item
) {
3383 AgeBy ab_f
= 0, ab_d
= 0;
3385 static const struct {
3388 } age_by_types
[] = {
3389 { 'a', AGE_BY_ATIME
},
3390 { 'b', AGE_BY_BTIME
},
3391 { 'c', AGE_BY_CTIME
},
3392 { 'm', AGE_BY_MTIME
},
3398 if (isempty(age_by_str
))
3401 for (const char *s
= age_by_str
; *s
!= 0; s
++) {
3404 /* Ignore whitespace. */
3405 if (strchr(WHITESPACE
, *s
))
3408 for (i
= 0; i
< ELEMENTSOF(age_by_types
); i
++) {
3409 /* Check lower-case for files, upper-case for directories. */
3410 if (*s
== age_by_types
[i
].age_by_chr
) {
3411 ab_f
|= age_by_types
[i
].age_by_flag
;
3413 } else if (*s
== ascii_toupper(age_by_types
[i
].age_by_chr
)) {
3414 ab_d
|= age_by_types
[i
].age_by_flag
;
3419 /* Invalid character. */
3420 if (i
>= ELEMENTSOF(age_by_types
))
3425 if (ab_f
== 0 && ab_d
== 0)
3428 item
->age_by_file
= ab_f
> 0 ? ab_f
: AGE_BY_DEFAULT_FILE
;
3429 item
->age_by_dir
= ab_d
> 0 ? ab_d
: AGE_BY_DEFAULT_DIR
;
3434 static bool is_duplicated_item(ItemArray
*existing
, const Item
*i
) {
3439 for (size_t n
= 0; n
< existing
->n_items
; n
++) {
3440 const Item
*e
= existing
->items
+ n
;
3442 if (item_compatible(e
, i
))
3445 /* Only multiple 'w+' lines for the same path are allowed. */
3446 if (e
->type
!= WRITE_FILE
|| !e
->append_or_force
||
3447 i
->type
!= WRITE_FILE
|| !i
->append_or_force
)
3454 static int parse_line(
3459 bool *invalid_config
,
3460 Hashmap
**uid_cache
,
3461 Hashmap
**gid_cache
) {
3463 _cleanup_free_
char *action
= NULL
, *mode
= NULL
, *user
= NULL
, *group
= NULL
, *age
= NULL
, *path
= NULL
;
3464 _cleanup_(item_free_contents
) Item i
= {
3465 /* The "age-by" argument considers all file timestamp types by default. */
3466 .age_by_file
= AGE_BY_DEFAULT_FILE
,
3467 .age_by_dir
= AGE_BY_DEFAULT_DIR
,
3469 ItemArray
*existing
;
3472 bool append_or_force
= false, boot
= false, allow_failure
= false, try_replace
= false,
3473 unbase64
= false, from_cred
= false, missing_user_or_group
= false;
3480 const Specifier specifier_table
[] = {
3481 { 'a', specifier_architecture
, NULL
},
3482 { 'b', specifier_boot_id
, NULL
},
3483 { 'B', specifier_os_build_id
, NULL
},
3484 { 'H', specifier_hostname
, NULL
},
3485 { 'l', specifier_short_hostname
, NULL
},
3486 { 'm', specifier_machine_id
, NULL
},
3487 { 'o', specifier_os_id
, NULL
},
3488 { 'v', specifier_kernel_release
, NULL
},
3489 { 'w', specifier_os_version_id
, NULL
},
3490 { 'W', specifier_os_variant_id
, NULL
},
3492 { 'h', specifier_user_home
, NULL
},
3494 { 'C', specifier_directory
, UINT_TO_PTR(DIRECTORY_CACHE
) },
3495 { 'L', specifier_directory
, UINT_TO_PTR(DIRECTORY_LOGS
) },
3496 { 'S', specifier_directory
, UINT_TO_PTR(DIRECTORY_STATE
) },
3497 { 't', specifier_directory
, UINT_TO_PTR(DIRECTORY_RUNTIME
) },
3499 COMMON_CREDS_SPECIFIERS(arg_runtime_scope
),
3500 COMMON_TMP_SPECIFIERS
,
3504 r
= extract_many_words(
3507 EXTRACT_UNQUOTE
| EXTRACT_CUNESCAPE
,
3516 if (IN_SET(r
, -EINVAL
, -EBADSLT
))
3517 /* invalid quoting and such or an unknown specifier */
3518 *invalid_config
= true;
3519 return log_syntax(NULL
, LOG_ERR
, fname
, line
, r
, "Failed to parse line: %m");
3521 *invalid_config
= true;
3522 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
), "Syntax error.");
3525 if (!empty_or_dash(buffer
)) {
3526 i
.argument
= strdup(buffer
);
3531 if (isempty(action
)) {
3532 *invalid_config
= true;
3533 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
), "Command too short '%s'.", action
);
3536 for (pos
= 1; action
[pos
]; pos
++) {
3537 if (action
[pos
] == '!' && !boot
)
3539 else if (action
[pos
] == '+' && !append_or_force
)
3540 append_or_force
= true;
3541 else if (action
[pos
] == '-' && !allow_failure
)
3542 allow_failure
= true;
3543 else if (action
[pos
] == '=' && !try_replace
)
3545 else if (action
[pos
] == '~' && !unbase64
)
3547 else if (action
[pos
] == '^' && !from_cred
)
3550 *invalid_config
= true;
3551 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
), "Unknown modifiers in command '%s'", action
);
3555 if (boot
&& !arg_boot
) {
3556 log_syntax(NULL
, LOG_DEBUG
, fname
, line
, 0, "Ignoring entry %s \"%s\" because --boot is not specified.", action
, path
);
3561 i
.append_or_force
= append_or_force
;
3562 i
.allow_failure
= allow_failure
;
3563 i
.try_replace
= try_replace
;
3565 r
= specifier_printf(path
, PATH_MAX
-1, specifier_table
, arg_root
, NULL
, &i
.path
);
3566 if (ERRNO_IS_NOINFO(r
))
3567 return log_unresolvable_specifier(fname
, line
);
3569 if (IN_SET(r
, -EINVAL
, -EBADSLT
))
3570 *invalid_config
= true;
3571 return log_syntax(NULL
, LOG_ERR
, fname
, line
, r
, "Failed to replace specifiers in '%s': %m", path
);
3574 r
= patch_var_run(fname
, line
, &i
.path
);
3578 if (!path_is_absolute(i
.path
)) {
3579 *invalid_config
= true;
3580 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
),
3581 "Path '%s' not absolute.", i
.path
);
3584 path_simplify(i
.path
);
3588 case CREATE_DIRECTORY
:
3589 case CREATE_SUBVOLUME
:
3590 case CREATE_SUBVOLUME_INHERIT_QUOTA
:
3591 case CREATE_SUBVOLUME_NEW_QUOTA
:
3592 case EMPTY_DIRECTORY
:
3593 case TRUNCATE_DIRECTORY
:
3596 case IGNORE_DIRECTORY_PATH
:
3598 case RECURSIVE_REMOVE_PATH
:
3601 case RECURSIVE_RELABEL_PATH
:
3608 "%c lines don't take argument fields, ignoring.",
3617 case CREATE_SYMLINK
:
3619 *invalid_config
= true;
3620 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
), "base64 decoding not supported for symlink targets.");
3626 *invalid_config
= true;
3627 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
), "Write file requires argument.");
3633 *invalid_config
= true;
3634 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
), "base64 decoding not supported for copy sources.");
3638 case CREATE_CHAR_DEVICE
:
3639 case CREATE_BLOCK_DEVICE
:
3641 *invalid_config
= true;
3642 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
), "base64 decoding not supported for device node creation.");
3646 *invalid_config
= true;
3647 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
), "Device file requires argument.");
3650 r
= parse_devnum(i
.argument
, &i
.major_minor
);
3652 *invalid_config
= true;
3653 return log_syntax(NULL
, LOG_ERR
, fname
, line
, r
, "Can't parse device file major/minor '%s'.", i
.argument
);
3659 case RECURSIVE_SET_XATTR
:
3661 *invalid_config
= true;
3662 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
), "base64 decoding not supported for extended attributes.");
3665 *invalid_config
= true;
3666 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
),
3667 "Set extended attribute requires argument.");
3669 r
= parse_xattrs_from_arg(&i
);
3675 case RECURSIVE_SET_ACL
:
3677 *invalid_config
= true;
3678 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
), "base64 decoding not supported for ACLs.");
3681 *invalid_config
= true;
3682 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
),
3683 "Set ACLs requires argument.");
3685 r
= parse_acls_from_arg(&i
);
3691 case RECURSIVE_SET_ATTRIBUTE
:
3693 *invalid_config
= true;
3694 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
), "base64 decoding not supported for file attributes.");
3697 *invalid_config
= true;
3698 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
),
3699 "Set file attribute requires argument.");
3701 r
= parse_attribute_from_arg(&i
);
3702 if (IN_SET(r
, -EINVAL
, -EBADSLT
))
3703 *invalid_config
= true;
3709 *invalid_config
= true;
3710 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
),
3711 "Unknown command type '%c'.", (char) i
.type
);
3714 if (!should_include_path(i
.path
))
3718 /* Do specifier expansion except if base64 mode is enabled */
3719 r
= specifier_expansion_from_arg(specifier_table
, &i
);
3720 if (ERRNO_IS_NOINFO(r
))
3721 return log_unresolvable_specifier(fname
, line
);
3723 if (IN_SET(r
, -EINVAL
, -EBADSLT
))
3724 *invalid_config
= true;
3725 return log_syntax(NULL
, LOG_ERR
, fname
, line
, r
, "Failed to substitute specifiers in argument: %m");
3730 case CREATE_SYMLINK
:
3732 i
.argument
= path_join("/usr/share/factory", i
.path
);
3740 i
.argument
= path_join("/usr/share/factory", i
.path
);
3743 } else if (!path_is_absolute(i
.argument
)) {
3744 *invalid_config
= true;
3745 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
), "Source path '%s' is not absolute.", i
.argument
);
3749 if (!empty_or_root(arg_root
)) {
3752 p
= path_join(arg_root
, i
.argument
);
3755 free_and_replace(i
.argument
, p
);
3758 path_simplify(i
.argument
);
3760 if (laccess(i
.argument
, F_OK
) == -ENOENT
) {
3761 /* Silently skip over lines where the source file is missing. */
3762 log_syntax(NULL
, LOG_DEBUG
, fname
, line
, 0, "Copy source path '%s' does not exist, skipping line.", i
.argument
);
3774 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EINVAL
), "Reading from credential requested, but no credential name specified.");
3775 if (!credential_name_valid(i
.argument
))
3776 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EINVAL
), "Credential name not valid: %s", i
.argument
);
3778 r
= read_credential(i
.argument
, &i
.binary_argument
, &i
.binary_argument_size
);
3779 if (IN_SET(r
, -ENXIO
, -ENOENT
)) {
3780 /* Silently skip over lines that have no credentials passed */
3781 log_syntax(NULL
, LOG_DEBUG
, fname
, line
, 0,
3782 "Credential '%s' not specified, skipping line.", i
.argument
);
3786 return log_error_errno(r
, "Failed to read credential '%s': %m", i
.argument
);
3789 /* If base64 decoding is requested, do so now */
3790 if (unbase64
&& item_binary_argument(&i
)) {
3791 _cleanup_free_
void *data
= NULL
;
3792 size_t data_size
= 0;
3794 r
= unbase64mem_full(item_binary_argument(&i
), item_binary_argument_size(&i
), /* secure = */ false,
3797 return log_syntax(NULL
, LOG_ERR
, fname
, line
, r
, "Failed to base64 decode specified argument '%s': %m", i
.argument
);
3799 free_and_replace(i
.binary_argument
, data
);
3800 i
.binary_argument_size
= data_size
;
3803 if (!empty_or_root(arg_root
)) {
3806 p
= path_join(arg_root
, i
.path
);
3809 free_and_replace(i
.path
, p
);
3812 if (!empty_or_dash(user
)) {
3815 u
= startswith(user
, ":");
3817 i
.uid_only_create
= true;
3821 r
= find_uid(u
, &i
.uid
, uid_cache
);
3822 if (r
== -ESRCH
&& arg_graceful
) {
3823 log_syntax(NULL
, LOG_DEBUG
, fname
, line
, r
,
3824 "%s: user '%s' not found, not adjusting ownership.", i
.path
, u
);
3825 missing_user_or_group
= true;
3827 *invalid_config
= true;
3828 return log_syntax(NULL
, LOG_ERR
, fname
, line
, r
, "Failed to resolve user '%s': %m", u
);
3833 if (!empty_or_dash(group
)) {
3836 g
= startswith(group
, ":");
3838 i
.gid_only_create
= true;
3842 r
= find_gid(g
, &i
.gid
, gid_cache
);
3843 if (r
== -ESRCH
&& arg_graceful
) {
3844 log_syntax(NULL
, LOG_DEBUG
, fname
, line
, r
,
3845 "%s: group '%s' not found, not adjusting ownership.", i
.path
, g
);
3846 missing_user_or_group
= true;
3848 *invalid_config
= true;
3849 return log_syntax(NULL
, LOG_ERR
, fname
, line
, r
, "Failed to resolve group '%s': %m", g
);
3854 if (!empty_or_dash(mode
)) {
3858 for (mm
= mode
;; mm
++) {
3860 i
.mask_perms
= true;
3861 else if (*mm
== ':')
3862 i
.mode_only_create
= true;
3867 r
= parse_mode(mm
, &m
);
3869 *invalid_config
= true;
3870 return log_syntax(NULL
, LOG_ERR
, fname
, line
, r
, "Invalid mode '%s'.", mode
);
3876 i
.mode
= IN_SET(i
.type
,
3880 CREATE_SUBVOLUME_INHERIT_QUOTA
,
3881 CREATE_SUBVOLUME_NEW_QUOTA
) ? 0755 : 0644;
3883 if (missing_user_or_group
&& (i
.mode
& ~0777) != 0) {
3884 /* Refuse any special bits for nodes where we couldn't resolve the ownership properly. */
3885 mode_t adjusted
= i
.mode
& 0777;
3886 log_syntax(NULL
, LOG_INFO
, fname
, line
, 0,
3887 "Changing mode 0%o to 0%o because of changed ownership.", i
.mode
, adjusted
);
3891 if (!empty_or_dash(age
)) {
3892 const char *a
= age
;
3893 _cleanup_free_
char *seconds
= NULL
, *age_by
= NULL
;
3896 i
.keep_first_level
= true;
3900 /* Format: "age-by:age"; where age-by is "[abcmABCM]+". */
3901 r
= split_pair(a
, ":", &age_by
, &seconds
);
3904 if (r
< 0 && r
!= -EINVAL
)
3905 return log_error_errno(r
, "Failed to parse age-by for '%s': %m", age
);
3907 /* We found a ":", parse the "age-by" part. */
3908 r
= parse_age_by_from_arg(age_by
, &i
);
3912 *invalid_config
= true;
3913 return log_syntax(NULL
, LOG_ERR
, fname
, line
, r
, "Invalid age-by '%s'.", age_by
);
3916 /* For parsing the "age" part, after the ":". */
3920 r
= parse_sec(a
, &i
.age
);
3922 *invalid_config
= true;
3923 return log_syntax(NULL
, LOG_ERR
, fname
, line
, r
, "Invalid age '%s'.", a
);
3929 h
= needs_glob(i
.type
) ? c
->globs
: c
->items
;
3931 existing
= ordered_hashmap_get(h
, i
.path
);
3933 if (is_duplicated_item(existing
, &i
)) {
3934 log_syntax(NULL
, LOG_NOTICE
, fname
, line
, 0,
3935 "Duplicate line for path \"%s\", ignoring.", i
.path
);
3939 existing
= new0(ItemArray
, 1);
3943 r
= ordered_hashmap_put(h
, i
.path
, existing
);
3950 if (!GREEDY_REALLOC(existing
->items
, existing
->n_items
+ 1))
3953 existing
->items
[existing
->n_items
++] = TAKE_STRUCT(i
);
3955 /* Sort item array, to enforce stable ordering of application */
3956 typesafe_qsort(existing
->items
, existing
->n_items
, item_compare
);
3961 static int cat_config(char **config_dirs
, char **args
) {
3962 _cleanup_strv_free_
char **files
= NULL
;
3965 r
= conf_files_list_with_replacement(arg_root
, config_dirs
, arg_replace
, &files
, NULL
);
3969 pager_open(arg_pager_flags
);
3971 return cat_files(NULL
, files
, arg_cat_flags
);
3974 static int exclude_default_prefixes(void) {
3977 /* Provide an easy way to exclude virtual/memory file systems from what we do here. Useful in
3978 * combination with --root= where we probably don't want to apply stuff to these dirs as they are
3979 * likely over-mounted if the root directory is actually used, and it wouldbe less than ideal to have
3980 * all kinds of files created/adjusted underneath these mount points. */
3982 r
= strv_extend_many(
3983 &arg_exclude_prefixes
,
3991 strv_uniq(arg_exclude_prefixes
);
3995 static int help(void) {
3996 _cleanup_free_
char *link
= NULL
;
3999 r
= terminal_urlify_man("systemd-tmpfiles", "8", &link
);
4003 printf("%s [OPTIONS...] [CONFIGURATION FILE...]\n"
4004 "\n%sCreates, deletes and cleans up volatile and temporary files and directories.%s\n\n"
4005 " -h --help Show this help\n"
4006 " --user Execute user configuration\n"
4007 " --version Show package version\n"
4008 " --cat-config Show configuration files\n"
4009 " --tldr Show non-comment parts of configuration\n"
4010 " --create Create marked files/directories\n"
4011 " --clean Clean up marked directories\n"
4012 " --remove Remove marked files/directories\n"
4013 " --boot Execute actions only safe at boot\n"
4014 " --graceful Quietly ignore unknown users or groups\n"
4015 " --purge Delete all files owned by the configuration files\n"
4016 " --prefix=PATH Only apply rules with the specified prefix\n"
4017 " --exclude-prefix=PATH Ignore rules with the specified prefix\n"
4018 " -E Ignore rules prefixed with /dev, /proc, /run, /sys\n"
4019 " --root=PATH Operate on an alternate filesystem root\n"
4020 " --image=PATH Operate on disk image as filesystem root\n"
4021 " --image-policy=POLICY Specify disk image dissection policy\n"
4022 " --replace=PATH Treat arguments as replacement for PATH\n"
4023 " --no-pager Do not pipe output into a pager\n"
4024 "\nSee the %s for details.\n",
4025 program_invocation_short_name
,
4033 static int parse_argv(int argc
, char *argv
[]) {
4036 ARG_VERSION
= 0x100,
4055 static const struct option options
[] = {
4056 { "help", no_argument
, NULL
, 'h' },
4057 { "user", no_argument
, NULL
, ARG_USER
},
4058 { "version", no_argument
, NULL
, ARG_VERSION
},
4059 { "cat-config", no_argument
, NULL
, ARG_CAT_CONFIG
},
4060 { "tldr", no_argument
, NULL
, ARG_TLDR
},
4061 { "create", no_argument
, NULL
, ARG_CREATE
},
4062 { "clean", no_argument
, NULL
, ARG_CLEAN
},
4063 { "remove", no_argument
, NULL
, ARG_REMOVE
},
4064 { "purge", no_argument
, NULL
, ARG_PURGE
},
4065 { "boot", no_argument
, NULL
, ARG_BOOT
},
4066 { "graceful", no_argument
, NULL
, ARG_GRACEFUL
},
4067 { "prefix", required_argument
, NULL
, ARG_PREFIX
},
4068 { "exclude-prefix", required_argument
, NULL
, ARG_EXCLUDE_PREFIX
},
4069 { "root", required_argument
, NULL
, ARG_ROOT
},
4070 { "image", required_argument
, NULL
, ARG_IMAGE
},
4071 { "image-policy", required_argument
, NULL
, ARG_IMAGE_POLICY
},
4072 { "replace", required_argument
, NULL
, ARG_REPLACE
},
4073 { "no-pager", no_argument
, NULL
, ARG_NO_PAGER
},
4082 while ((c
= getopt_long(argc
, argv
, "hE", options
, NULL
)) >= 0)
4092 case ARG_CAT_CONFIG
:
4093 arg_cat_flags
= CAT_CONFIG_ON
;
4097 arg_cat_flags
= CAT_TLDR
;
4101 arg_runtime_scope
= RUNTIME_SCOPE_USER
;
4105 arg_operation
|= OPERATION_CREATE
;
4109 arg_operation
|= OPERATION_CLEAN
;
4113 arg_operation
|= OPERATION_REMOVE
;
4121 arg_operation
|= OPERATION_PURGE
;
4125 arg_graceful
= true;
4129 if (strv_extend(&arg_include_prefixes
, optarg
) < 0)
4133 case ARG_EXCLUDE_PREFIX
:
4134 if (strv_extend(&arg_exclude_prefixes
, optarg
) < 0)
4139 r
= parse_path_argument(optarg
, /* suppress_root= */ false, &arg_root
);
4146 return log_error_errno(SYNTHETIC_ERRNO(EOPNOTSUPP
),
4147 "This systemd-tmpfiles version is compiled without support for --image=.");
4149 r
= parse_path_argument(optarg
, /* suppress_root= */ false, &arg_image
);
4153 /* Imply -E here since it makes little sense to create files persistently in the /run mountpoint of a disk image */
4157 r
= exclude_default_prefixes();
4163 case ARG_IMAGE_POLICY
:
4164 r
= parse_image_policy_argument(optarg
, &arg_image_policy
);
4170 if (!path_is_absolute(optarg
) ||
4171 !endswith(optarg
, ".conf"))
4172 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
4173 "The argument to --replace= must an absolute path to a config file");
4175 arg_replace
= optarg
;
4179 arg_pager_flags
|= PAGER_DISABLE
;
4186 assert_not_reached();
4189 if (arg_operation
== 0 && arg_cat_flags
== CAT_CONFIG_OFF
)
4190 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
4191 "You need to specify at least one of --clean, --create, --remove, or --purge.");
4193 if (arg_replace
&& arg_cat_flags
!= CAT_CONFIG_OFF
)
4194 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
4195 "Option --replace= is not supported with --cat-config/--tldr.");
4197 if (arg_replace
&& optind
>= argc
)
4198 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
4199 "When --replace= is given, some configuration items must be specified.");
4201 if (arg_root
&& arg_runtime_scope
== RUNTIME_SCOPE_USER
)
4202 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
4203 "Combination of --user and --root= is not supported.");
4205 if (arg_image
&& arg_root
)
4206 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Please specify either --root= or --image=, the combination of both is not supported.");
4211 static int read_config_file(
4216 bool *invalid_config
) {
4218 _cleanup_hashmap_free_ Hashmap
*uid_cache
= NULL
, *gid_cache
= NULL
;
4219 _cleanup_fclose_
FILE *_f
= NULL
;
4220 _cleanup_free_
char *pp
= NULL
;
4229 if (streq(fn
, "-")) {
4230 log_debug("Reading config from stdin%s", special_glyph(SPECIAL_GLYPH_ELLIPSIS
));
4234 r
= search_and_fopen(fn
, "re", arg_root
, (const char**) config_dirs
, &_f
, &pp
);
4236 if (ignore_enoent
&& r
== -ENOENT
) {
4237 log_debug_errno(r
, "Failed to open \"%s\", ignoring: %m", fn
);
4241 return log_error_errno(r
, "Failed to open '%s': %m", fn
);
4244 log_debug("Reading config file \"%s\"%s", pp
, special_glyph(SPECIAL_GLYPH_ELLIPSIS
));
4250 _cleanup_free_
char *line
= NULL
;
4251 bool invalid_line
= false;
4254 k
= read_stripped_line(f
, LONG_LINE_MAX
, &line
);
4256 return log_error_errno(k
, "Failed to read '%s': %m", fn
);
4262 if (IN_SET(line
[0], 0, '#'))
4265 k
= parse_line(c
, fn
, v
, line
, &invalid_line
, &uid_cache
, &gid_cache
);
4268 /* Allow reporting with a special code if the caller requested this */
4269 *invalid_config
= true;
4271 /* The first error becomes our return value */
4276 /* we have to determine age parameter for each entry of type X */
4277 ORDERED_HASHMAP_FOREACH(ia
, c
->globs
)
4278 for (size_t ni
= 0; ni
< ia
->n_items
; ni
++) {
4280 Item
*i
= ia
->items
+ ni
, *candidate_item
= NULL
;
4282 if (i
->type
!= IGNORE_DIRECTORY_PATH
)
4285 ORDERED_HASHMAP_FOREACH(ja
, c
->items
)
4286 for (size_t nj
= 0; nj
< ja
->n_items
; nj
++) {
4287 Item
*j
= ja
->items
+ nj
;
4289 if (!IN_SET(j
->type
, CREATE_DIRECTORY
,
4292 CREATE_SUBVOLUME_INHERIT_QUOTA
,
4293 CREATE_SUBVOLUME_NEW_QUOTA
))
4296 if (path_equal(j
->path
, i
->path
)) {
4302 ? (path_startswith(j
->path
, candidate_item
->path
) && fnmatch(i
->path
, j
->path
, FNM_PATHNAME
| FNM_PERIOD
) == 0)
4303 : path_startswith(i
->path
, j
->path
) != NULL
)
4307 if (candidate_item
&& candidate_item
->age_set
) {
4308 i
->age
= candidate_item
->age
;
4314 log_error_errno(errno
, "Failed to read from file %s: %m", fn
);
4322 static int parse_arguments(
4326 bool *invalid_config
) {
4331 STRV_FOREACH(arg
, args
) {
4332 r
= read_config_file(c
, config_dirs
, *arg
, false, invalid_config
);
4340 static int read_config_files(
4344 bool *invalid_config
) {
4346 _cleanup_strv_free_
char **files
= NULL
;
4347 _cleanup_free_
char *p
= NULL
;
4352 r
= conf_files_list_with_replacement(arg_root
, config_dirs
, arg_replace
, &files
, &p
);
4356 STRV_FOREACH(f
, files
)
4357 if (p
&& path_equal(*f
, p
)) {
4358 log_debug("Parsing arguments at position \"%s\"%s", *f
, special_glyph(SPECIAL_GLYPH_ELLIPSIS
));
4360 r
= parse_arguments(c
, config_dirs
, args
, invalid_config
);
4364 /* Just warn, ignore result otherwise.
4365 * read_config_file() has some debug output, so no need to print anything. */
4366 (void) read_config_file(c
, config_dirs
, *f
, true, invalid_config
);
4371 static int read_credential_lines(Context
*c
, bool *invalid_config
) {
4373 _cleanup_free_
char *j
= NULL
;
4379 r
= get_credentials_dir(&d
);
4383 return log_error_errno(r
, "Failed to get credentials directory: %m");
4385 j
= path_join(d
, "tmpfiles.extra");
4389 (void) read_config_file(c
, /* config_dirs= */ NULL
, j
, /* ignore_enoent= */ true, invalid_config
);
4393 static int link_parent(Context
*c
, ItemArray
*a
) {
4401 /* Finds the closest "parent" item array for the specified item array. Then registers the specified item array
4402 * as child of it, and fills the parent in, linking them both ways. This allows us to later create parents
4403 * before their children, and clean up/remove children before their parents. */
4405 if (a
->n_items
<= 0)
4408 path
= a
->items
[0].path
;
4409 prefix
= newa(char, strlen(path
) + 1);
4410 PATH_FOREACH_PREFIX(prefix
, path
) {
4413 j
= ordered_hashmap_get(c
->items
, prefix
);
4415 j
= ordered_hashmap_get(c
->globs
, prefix
);
4417 r
= set_ensure_put(&j
->children
, NULL
, a
);
4429 DEFINE_PRIVATE_HASH_OPS_WITH_VALUE_DESTRUCTOR(item_array_hash_ops
, char, string_hash_func
, string_compare_func
,
4430 ItemArray
, item_array_free
);
4432 static int run(int argc
, char *argv
[]) {
4434 _cleanup_(loop_device_unrefp
) LoopDevice
*loop_device
= NULL
;
4435 _cleanup_(umount_and_freep
) char *mounted_dir
= NULL
;
4437 _cleanup_strv_free_
char **config_dirs
= NULL
;
4438 _cleanup_(context_done
) Context c
= {};
4439 bool invalid_config
= false;
4443 PHASE_REMOVE_AND_CLEAN
,
4449 r
= parse_argv(argc
, argv
);
4455 /* We require /proc/ for a lot of our operations, i.e. for adjusting access modes, for anything
4456 * SELinux related, for recursive operation, for xattr, acl and chattr handling, for btrfs stuff and
4457 * a lot more. It's probably the majority of invocations where /proc/ is required. Since people
4458 * apparently invoke it without anyway and are surprised about the failures, let's catch this early
4459 * and output a nice and friendly warning. */
4460 if (proc_mounted() == 0)
4461 return log_error_errno(SYNTHETIC_ERRNO(ENOSYS
),
4462 "/proc/ is not mounted, but required for successful operation of systemd-tmpfiles. "
4463 "Please mount /proc/. Alternatively, consider using the --root= or --image= switches.");
4465 /* Descending down file system trees might take a lot of fds */
4466 (void) rlimit_nofile_bump(HIGH_RLIMIT_NOFILE
);
4468 switch (arg_runtime_scope
) {
4470 case RUNTIME_SCOPE_USER
:
4471 r
= user_config_paths(&config_dirs
);
4473 return log_error_errno(r
, "Failed to initialize configuration directory list: %m");
4476 case RUNTIME_SCOPE_SYSTEM
:
4477 config_dirs
= strv_split_nulstr(CONF_PATHS_NULSTR("tmpfiles.d"));
4483 assert_not_reached();
4486 if (DEBUG_LOGGING
) {
4487 _cleanup_free_
char *t
= NULL
;
4489 STRV_FOREACH(i
, config_dirs
) {
4490 _cleanup_free_
char *j
= NULL
;
4492 j
= path_join(arg_root
, *i
);
4496 if (!strextend(&t
, "\n\t", j
))
4500 log_debug("Looking for configuration files in (higher priority first):%s", t
);
4503 if (arg_cat_flags
!= CAT_CONFIG_OFF
)
4504 return cat_config(config_dirs
, argv
+ optind
);
4516 r
= mount_image_privately_interactively(
4519 DISSECT_IMAGE_GENERIC_ROOT
|
4520 DISSECT_IMAGE_REQUIRE_ROOT
|
4521 DISSECT_IMAGE_VALIDATE_OS
|
4522 DISSECT_IMAGE_RELAX_VAR_CHECK
|
4523 DISSECT_IMAGE_FSCK
|
4524 DISSECT_IMAGE_GROWFS
,
4526 /* ret_dir_fd= */ NULL
,
4531 arg_root
= strdup(mounted_dir
);
4539 c
.items
= ordered_hashmap_new(&item_array_hash_ops
);
4540 c
.globs
= ordered_hashmap_new(&item_array_hash_ops
);
4541 if (!c
.items
|| !c
.globs
)
4544 /* If command line arguments are specified along with --replace, read all
4545 * configuration files and insert the positional arguments at the specified
4546 * place. Otherwise, if command line arguments are specified, execute just
4547 * them, and finally, without --replace= or any positional arguments, just
4548 * read configuration and execute it.
4550 if (arg_replace
|| optind
>= argc
)
4551 r
= read_config_files(&c
, config_dirs
, argv
+ optind
, &invalid_config
);
4553 r
= parse_arguments(&c
, config_dirs
, argv
+ optind
, &invalid_config
);
4557 r
= read_credential_lines(&c
, &invalid_config
);
4561 /* Let's now link up all child/parent relationships */
4562 ORDERED_HASHMAP_FOREACH(a
, c
.items
) {
4563 r
= link_parent(&c
, a
);
4567 ORDERED_HASHMAP_FOREACH(a
, c
.globs
) {
4568 r
= link_parent(&c
, a
);
4573 /* If multiple operations are requested, let's first run the remove/clean operations, and only then the create
4574 * operations. i.e. that we first clean out the platform we then build on. */
4575 for (phase
= 0; phase
< _PHASE_MAX
; phase
++) {
4578 if (phase
== PHASE_PURGE
)
4579 op
= arg_operation
& OPERATION_PURGE
;
4580 else if (phase
== PHASE_REMOVE_AND_CLEAN
)
4581 op
= arg_operation
& (OPERATION_REMOVE
|OPERATION_CLEAN
);
4582 else if (phase
== PHASE_CREATE
)
4583 op
= arg_operation
& OPERATION_CREATE
;
4585 assert_not_reached();
4587 if (op
== 0) /* Nothing requested in this phase */
4590 /* The non-globbing ones usually create things, hence we apply them first */
4591 ORDERED_HASHMAP_FOREACH(a
, c
.items
) {
4592 k
= process_item_array(&c
, a
, op
);
4593 if (k
< 0 && r
>= 0)
4597 /* The globbing ones usually alter things, hence we apply them second. */
4598 ORDERED_HASHMAP_FOREACH(a
, c
.globs
) {
4599 k
= process_item_array(&c
, a
, op
);
4600 if (k
< 0 && r
>= 0)
4605 if (ERRNO_IS_RESOURCE(r
))
4610 return EX_CANTCREAT
;
4614 DEFINE_MAIN_FUNCTION_WITH_POSITIVE_FAILURE(run
);