1 /* SPDX-License-Identifier: LGPL-2.1+ */
16 #include <sys/xattr.h>
24 #include "alloc-util.h"
25 #include "btrfs-util.h"
26 #include "capability-util.h"
27 #include "chattr-util.h"
28 #include "conf-files.h"
31 #include "dirent-util.h"
35 #include "format-util.h"
37 #include "glob-util.h"
42 #include "main-func.h"
44 #include "mountpoint-util.h"
46 #include "parse-util.h"
47 #include "path-lookup.h"
48 #include "path-util.h"
49 #include "pretty-print.h"
50 #include "rlimit-util.h"
52 #include "selinux-util.h"
54 #include "sort-util.h"
55 #include "specifier.h"
56 #include "stat-util.h"
57 #include "stdio-util.h"
58 #include "string-table.h"
59 #include "string-util.h"
61 #include "umask-util.h"
62 #include "user-util.h"
64 /* This reads all files listed in /etc/tmpfiles.d/?*.conf and creates
65 * them in the file system. This is intended to be used to create
66 * properly owned directories beneath /tmp, /var/tmp, /run, which are
67 * volatile and hence need to be recreated on bootup. */
69 typedef enum OperationMask
{
70 OPERATION_CREATE
= 1 << 0,
71 OPERATION_REMOVE
= 1 << 1,
72 OPERATION_CLEAN
= 1 << 2,
75 typedef enum ItemType
{
76 /* These ones take file names */
79 CREATE_DIRECTORY
= 'd',
80 TRUNCATE_DIRECTORY
= 'D',
81 CREATE_SUBVOLUME
= 'v',
82 CREATE_SUBVOLUME_INHERIT_QUOTA
= 'q',
83 CREATE_SUBVOLUME_NEW_QUOTA
= 'Q',
86 CREATE_CHAR_DEVICE
= 'c',
87 CREATE_BLOCK_DEVICE
= 'b',
90 /* These ones take globs */
92 EMPTY_DIRECTORY
= 'e',
94 RECURSIVE_SET_XATTR
= 'T',
96 RECURSIVE_SET_ACL
= 'A',
98 RECURSIVE_SET_ATTRIBUTE
= 'H',
100 IGNORE_DIRECTORY_PATH
= 'X',
102 RECURSIVE_REMOVE_PATH
= 'R',
104 RECURSIVE_RELABEL_PATH
= 'Z',
105 ADJUST_MODE
= 'm', /* legacy, 'z' is identical to this */
108 typedef struct Item
{
124 unsigned attribute_value
;
125 unsigned attribute_mask
;
132 bool attribute_set
:1;
134 bool keep_first_level
:1;
136 bool append_or_force
:1;
138 bool allow_failure
:1;
143 typedef struct ItemArray
{
148 struct ItemArray
*parent
;
152 typedef enum DirectoryType
{
160 static bool arg_cat_config
= false;
161 static bool arg_user
= false;
162 static OperationMask arg_operation
= 0;
163 static bool arg_boot
= false;
164 static PagerFlags arg_pager_flags
= 0;
166 static char **arg_include_prefixes
= NULL
;
167 static char **arg_exclude_prefixes
= NULL
;
168 static char *arg_root
= NULL
;
169 static char *arg_replace
= NULL
;
171 #define MAX_DEPTH 256
173 static OrderedHashmap
*items
= NULL
, *globs
= NULL
;
174 static Set
*unix_sockets
= NULL
;
176 STATIC_DESTRUCTOR_REGISTER(items
, ordered_hashmap_freep
);
177 STATIC_DESTRUCTOR_REGISTER(globs
, ordered_hashmap_freep
);
178 STATIC_DESTRUCTOR_REGISTER(unix_sockets
, set_free_freep
);
179 STATIC_DESTRUCTOR_REGISTER(arg_include_prefixes
, freep
);
180 STATIC_DESTRUCTOR_REGISTER(arg_exclude_prefixes
, freep
);
181 STATIC_DESTRUCTOR_REGISTER(arg_root
, freep
);
183 static int specifier_machine_id_safe(char specifier
, const void *data
, const void *userdata
, char **ret
);
184 static int specifier_directory(char specifier
, const void *data
, const void *userdata
, char **ret
);
186 static const Specifier specifier_table
[] = {
187 { 'm', specifier_machine_id_safe
, NULL
},
188 { 'b', specifier_boot_id
, NULL
},
189 { 'H', specifier_host_name
, NULL
},
190 { 'v', specifier_kernel_release
, NULL
},
192 { 'g', specifier_group_name
, NULL
},
193 { 'G', specifier_group_id
, NULL
},
194 { 'U', specifier_user_id
, NULL
},
195 { 'u', specifier_user_name
, NULL
},
196 { 'h', specifier_user_home
, NULL
},
198 { 't', specifier_directory
, UINT_TO_PTR(DIRECTORY_RUNTIME
) },
199 { 'S', specifier_directory
, UINT_TO_PTR(DIRECTORY_STATE
) },
200 { 'C', specifier_directory
, UINT_TO_PTR(DIRECTORY_CACHE
) },
201 { 'L', specifier_directory
, UINT_TO_PTR(DIRECTORY_LOGS
) },
202 { 'T', specifier_tmp_dir
, NULL
},
203 { 'V', specifier_var_tmp_dir
, NULL
},
207 static int specifier_machine_id_safe(char specifier
, const void *data
, const void *userdata
, char **ret
) {
210 /* If /etc/machine_id is missing or empty (e.g. in a chroot environment)
211 * return a recognizable error so that the caller can skip the rule
214 r
= specifier_machine_id(specifier
, data
, userdata
, ret
);
215 if (IN_SET(r
, -ENOENT
, -ENOMEDIUM
))
221 static int specifier_directory(char specifier
, const void *data
, const void *userdata
, char **ret
) {
227 static const struct table_entry paths_system
[] = {
228 [DIRECTORY_RUNTIME
] = { SD_PATH_SYSTEM_RUNTIME
},
229 [DIRECTORY_STATE
] = { SD_PATH_SYSTEM_STATE_PRIVATE
},
230 [DIRECTORY_CACHE
] = { SD_PATH_SYSTEM_STATE_CACHE
},
231 [DIRECTORY_LOGS
] = { SD_PATH_SYSTEM_STATE_LOGS
},
234 static const struct table_entry paths_user
[] = {
235 [DIRECTORY_RUNTIME
] = { SD_PATH_USER_RUNTIME
},
236 [DIRECTORY_STATE
] = { SD_PATH_USER_CONFIGURATION
},
237 [DIRECTORY_CACHE
] = { SD_PATH_USER_STATE_CACHE
},
238 [DIRECTORY_LOGS
] = { SD_PATH_USER_CONFIGURATION
, "log" },
242 const struct table_entry
*paths
;
244 assert_cc(ELEMENTSOF(paths_system
) == ELEMENTSOF(paths_user
));
245 paths
= arg_user
? paths_user
: paths_system
;
247 i
= PTR_TO_UINT(data
);
248 assert(i
< ELEMENTSOF(paths_system
));
250 return sd_path_home(paths
[i
].type
, paths
[i
].suffix
, ret
);
253 static int log_unresolvable_specifier(const char *filename
, unsigned line
) {
254 static bool notified
= false;
256 /* In system mode, this is called when /etc is not fully initialized (e.g.
257 * in a chroot environment) where some specifiers are unresolvable. In user
258 * mode, this is called when some variables are not defined. These cases are
259 * not considered as an error so log at LOG_NOTICE only for the first time
260 * and then downgrade this to LOG_DEBUG for the rest. */
262 log_full(notified
? LOG_DEBUG
: LOG_NOTICE
,
263 "[%s:%u] Failed to resolve specifier: %s, skipping",
265 arg_user
? "Required $XDG_... variable not defined" : "uninitialized /etc detected");
268 log_notice("All rules containing unresolvable specifiers will be skipped.");
274 static int user_config_paths(char*** ret
) {
275 _cleanup_strv_free_
char **config_dirs
= NULL
, **data_dirs
= NULL
;
276 _cleanup_free_
char *persistent_config
= NULL
, *runtime_config
= NULL
, *data_home
= NULL
;
277 _cleanup_strv_free_
char **res
= NULL
;
280 r
= xdg_user_dirs(&config_dirs
, &data_dirs
);
284 r
= xdg_user_config_dir(&persistent_config
, "/user-tmpfiles.d");
285 if (r
< 0 && r
!= -ENXIO
)
288 r
= xdg_user_runtime_dir(&runtime_config
, "/user-tmpfiles.d");
289 if (r
< 0 && r
!= -ENXIO
)
292 r
= xdg_user_data_dir(&data_home
, "/user-tmpfiles.d");
293 if (r
< 0 && r
!= -ENXIO
)
296 r
= strv_extend_strv_concat(&res
, config_dirs
, "/user-tmpfiles.d");
300 r
= strv_extend(&res
, persistent_config
);
304 r
= strv_extend(&res
, runtime_config
);
308 r
= strv_extend(&res
, data_home
);
312 r
= strv_extend_strv_concat(&res
, data_dirs
, "/user-tmpfiles.d");
316 r
= path_strv_make_absolute_cwd(res
);
320 *ret
= TAKE_PTR(res
);
324 static bool needs_glob(ItemType t
) {
328 IGNORE_DIRECTORY_PATH
,
330 RECURSIVE_REMOVE_PATH
,
334 RECURSIVE_RELABEL_PATH
,
340 RECURSIVE_SET_ATTRIBUTE
);
343 static bool takes_ownership(ItemType t
) {
351 CREATE_SUBVOLUME_INHERIT_QUOTA
,
352 CREATE_SUBVOLUME_NEW_QUOTA
,
360 IGNORE_DIRECTORY_PATH
,
362 RECURSIVE_REMOVE_PATH
);
365 static struct Item
* find_glob(OrderedHashmap
*h
, const char *match
) {
369 ORDERED_HASHMAP_FOREACH(j
, h
, i
) {
372 for (n
= 0; n
< j
->n_items
; n
++) {
373 Item
*item
= j
->items
+ n
;
375 if (fnmatch(item
->path
, match
, FNM_PATHNAME
|FNM_PERIOD
) == 0)
383 static int load_unix_sockets(void) {
384 _cleanup_set_free_free_ Set
*sockets
= NULL
;
385 _cleanup_fclose_
FILE *f
= NULL
;
391 /* We maintain a cache of the sockets we found in /proc/net/unix to speed things up a little. */
393 sockets
= set_new(&path_hash_ops
);
397 f
= fopen("/proc/net/unix", "re");
399 return log_full_errno(errno
== ENOENT
? LOG_DEBUG
: LOG_WARNING
, errno
,
400 "Failed to open /proc/net/unix, ignoring: %m");
403 r
= read_line(f
, LONG_LINE_MAX
, NULL
);
405 return log_warning_errno(r
, "Failed to skip /proc/net/unix header line: %m");
407 return log_warning_errno(SYNTHETIC_ERRNO(EIO
), "Premature end of file reading /proc/net/unix.");
410 _cleanup_free_
char *line
= NULL
, *s
= NULL
;
413 r
= read_line(f
, LONG_LINE_MAX
, &line
);
415 return log_warning_errno(r
, "Failed to read /proc/net/unix line, ignoring: %m");
416 if (r
== 0) /* EOF */
419 p
= strchr(line
, ':');
427 p
+= strspn(p
, WHITESPACE
);
428 p
+= strcspn(p
, WHITESPACE
); /* skip one more word */
429 p
+= strspn(p
, WHITESPACE
);
438 path_simplify(s
, false);
440 r
= set_consume(sockets
, s
);
444 return log_warning_errno(r
, "Failed to add AF_UNIX socket to set, ignoring: %m");
449 unix_sockets
= TAKE_PTR(sockets
);
453 static bool unix_socket_alive(const char *fn
) {
456 if (load_unix_sockets() < 0)
457 return true; /* We don't know, so assume yes */
459 return !!set_get(unix_sockets
, (char*) fn
);
462 static DIR* xopendirat_nomod(int dirfd
, const char *path
) {
465 dir
= xopendirat(dirfd
, path
, O_NOFOLLOW
|O_NOATIME
);
469 log_debug_errno(errno
, "Cannot open %sdirectory \"%s\": %m", dirfd
== AT_FDCWD
? "" : "sub", path
);
473 dir
= xopendirat(dirfd
, path
, O_NOFOLLOW
);
475 log_debug_errno(errno
, "Cannot open %sdirectory \"%s\": %m", dirfd
== AT_FDCWD
? "" : "sub", path
);
480 static DIR* opendir_nomod(const char *path
) {
481 return xopendirat_nomod(AT_FDCWD
, path
);
484 static int dir_cleanup(
488 const struct stat
*ds
,
493 bool keep_this_level
) {
496 bool deleted
= false;
499 FOREACH_DIRENT_ALL(dent
, d
, break) {
502 _cleanup_free_
char *sub_path
= NULL
;
504 if (dot_or_dot_dot(dent
->d_name
))
507 if (fstatat(dirfd(d
), dent
->d_name
, &s
, AT_SYMLINK_NOFOLLOW
) < 0) {
511 /* FUSE, NFS mounts, SELinux might return EACCES */
512 r
= log_full_errno(errno
== EACCES
? LOG_DEBUG
: LOG_ERR
, errno
,
513 "stat(%s/%s) failed: %m", p
, dent
->d_name
);
517 /* Stay on the same filesystem */
518 if (s
.st_dev
!= rootdev
) {
519 log_debug("Ignoring \"%s/%s\": different filesystem.", p
, dent
->d_name
);
523 /* Try to detect bind mounts of the same filesystem instance; they
524 * do not differ in device major/minors. This type of query is not
525 * supported on all kernels or filesystem types though. */
526 if (S_ISDIR(s
.st_mode
)) {
529 q
= fd_is_mount_point(dirfd(d
), dent
->d_name
, 0);
531 log_debug_errno(q
, "Failed to determine whether \"%s/%s\" is a mount point, ignoring: %m", p
, dent
->d_name
);
533 log_debug("Ignoring \"%s/%s\": different mount of the same filesystem.", p
, dent
->d_name
);
538 sub_path
= path_join(p
, dent
->d_name
);
544 /* Is there an item configured for this path? */
545 if (ordered_hashmap_get(items
, sub_path
)) {
546 log_debug("Ignoring \"%s\": a separate entry exists.", sub_path
);
550 if (find_glob(globs
, sub_path
)) {
551 log_debug("Ignoring \"%s\": a separate glob exists.", sub_path
);
555 if (S_ISDIR(s
.st_mode
)) {
556 _cleanup_closedir_
DIR *sub_dir
= NULL
;
559 streq(dent
->d_name
, "lost+found") &&
561 log_debug("Ignoring directory \"%s\".", sub_path
);
566 log_warning("Reached max depth on \"%s\".", sub_path
);
570 sub_dir
= xopendirat_nomod(dirfd(d
), dent
->d_name
);
573 r
= log_warning_errno(errno
, "Opening directory \"%s\" failed, ignoring: %m", sub_path
);
578 if (flock(dirfd(sub_dir
), LOCK_EX
|LOCK_NB
) < 0) {
579 log_debug_errno(errno
, "Couldn't acquire shared BSD lock on directory \"%s\", skipping: %m", p
);
583 q
= dir_cleanup(i
, sub_path
, sub_dir
, &s
, cutoff
, rootdev
, false, maxdepth
-1, false);
588 /* Note: if you are wondering why we don't support the sticky bit for excluding
589 * directories from cleaning like we do it for other file system objects: well, the
590 * sticky bit already has a meaning for directories, so we don't want to overload
593 if (keep_this_level
) {
594 log_debug("Keeping directory \"%s\".", sub_path
);
598 /* Ignore ctime, we change it when deleting */
599 age
= timespec_load(&s
.st_mtim
);
601 char a
[FORMAT_TIMESTAMP_MAX
];
602 /* Follows spelling in stat(1). */
603 log_debug("Directory \"%s\": modify time %s is too new.",
605 format_timestamp_us(a
, sizeof(a
), age
));
609 age
= timespec_load(&s
.st_atim
);
611 char a
[FORMAT_TIMESTAMP_MAX
];
612 log_debug("Directory \"%s\": access time %s is too new.",
614 format_timestamp_us(a
, sizeof(a
), age
));
618 log_debug("Removing directory \"%s\".", sub_path
);
619 if (unlinkat(dirfd(d
), dent
->d_name
, AT_REMOVEDIR
) < 0)
620 if (!IN_SET(errno
, ENOENT
, ENOTEMPTY
))
621 r
= log_warning_errno(errno
, "Failed to remove directory \"%s\", ignoring: %m", sub_path
);
624 /* Skip files for which the sticky bit is set. These are semantics we define, and are
625 * unknown elsewhere. See XDG_RUNTIME_DIR specification for details. */
626 if (s
.st_mode
& S_ISVTX
) {
627 log_debug("Skipping \"%s\": sticky bit set.", sub_path
);
632 S_ISREG(s
.st_mode
) &&
634 STR_IN_SET(dent
->d_name
,
638 log_debug("Skipping \"%s\".", sub_path
);
642 /* Ignore sockets that are listed in /proc/net/unix */
643 if (S_ISSOCK(s
.st_mode
) && unix_socket_alive(sub_path
)) {
644 log_debug("Skipping \"%s\": live socket.", sub_path
);
648 /* Ignore device nodes */
649 if (S_ISCHR(s
.st_mode
) || S_ISBLK(s
.st_mode
)) {
650 log_debug("Skipping \"%s\": a device.", sub_path
);
654 /* Keep files on this level around if this is requested */
655 if (keep_this_level
) {
656 log_debug("Keeping \"%s\".", sub_path
);
660 age
= timespec_load(&s
.st_mtim
);
662 char a
[FORMAT_TIMESTAMP_MAX
];
663 /* Follows spelling in stat(1). */
664 log_debug("File \"%s\": modify time %s is too new.",
666 format_timestamp_us(a
, sizeof(a
), age
));
670 age
= timespec_load(&s
.st_atim
);
672 char a
[FORMAT_TIMESTAMP_MAX
];
673 log_debug("File \"%s\": access time %s is too new.",
675 format_timestamp_us(a
, sizeof(a
), age
));
679 age
= timespec_load(&s
.st_ctim
);
681 char a
[FORMAT_TIMESTAMP_MAX
];
682 log_debug("File \"%s\": change time %s is too new.",
684 format_timestamp_us(a
, sizeof(a
), age
));
688 log_debug("Removing \"%s\".", sub_path
);
689 if (unlinkat(dirfd(d
), dent
->d_name
, 0) < 0)
691 r
= log_warning_errno(errno
, "Failed to remove \"%s\", ignoring: %m", sub_path
);
699 char a
[FORMAT_TIMESTAMP_MAX
], b
[FORMAT_TIMESTAMP_MAX
];
702 age1
= timespec_load(&ds
->st_atim
);
703 age2
= timespec_load(&ds
->st_mtim
);
705 log_debug("Restoring access and modification time on \"%s\": %s, %s",
707 format_timestamp_us(a
, sizeof(a
), age1
),
708 format_timestamp_us(b
, sizeof(b
), age2
));
710 /* Restore original directory timestamps */
711 if (futimens(dirfd(d
), (struct timespec
[]) {
714 log_warning_errno(errno
, "Failed to revert timestamps of '%s', ignoring: %m", p
);
720 static bool dangerous_hardlinks(void) {
721 _cleanup_free_
char *value
= NULL
;
722 static int cached
= -1;
725 /* Check whether the fs.protected_hardlinks sysctl is on. If we can't determine it we assume its off, as that's
726 * what the upstream default is. */
731 r
= read_one_line_file("/proc/sys/fs/protected_hardlinks", &value
);
733 log_debug_errno(r
, "Failed to read fs.protected_hardlinks sysctl: %m");
737 r
= parse_boolean(value
);
739 log_debug_errno(r
, "Failed to parse fs.protected_hardlinks sysctl: %m");
747 static bool hardlink_vulnerable(const struct stat
*st
) {
750 return !S_ISDIR(st
->st_mode
) && st
->st_nlink
> 1 && dangerous_hardlinks();
753 static mode_t
process_mask_perms(mode_t mode
, mode_t current
) {
755 if ((current
& 0111) == 0)
757 if ((current
& 0222) == 0)
759 if ((current
& 0444) == 0)
761 if (!S_ISDIR(current
))
762 mode
&= ~07000; /* remove sticky/sgid/suid bit, unless directory */
767 static int fd_set_perms(Item
*i
, int fd
, const char *path
, const struct stat
*st
) {
776 if (!i
->mode_set
&& !i
->uid_set
&& !i
->gid_set
)
780 if (fstat(fd
, &stbuf
) < 0)
781 return log_error_errno(errno
, "fstat(%s) failed: %m", path
);
785 if (hardlink_vulnerable(st
))
786 return log_error_errno(SYNTHETIC_ERRNO(EPERM
),
787 "Refusing to set permissions on hardlinked file %s while the fs.protected_hardlinks sysctl is turned off.",
790 /* Do we need a chown()? */
792 (i
->uid_set
&& i
->uid
!= st
->st_uid
) ||
793 (i
->gid_set
&& i
->gid
!= st
->st_gid
);
795 /* Calculate the mode to apply */
796 new_mode
= i
->mode_set
? (i
->mask_perms
?
797 process_mask_perms(i
->mode
, st
->st_mode
) :
799 (st
->st_mode
& 07777);
801 if (i
->mode_set
&& do_chown
) {
802 /* Before we issue the chmod() let's reduce the access mode to the common bits of the old and
803 * the new mode. That way there's no time window where the file exists under the old owner
804 * with more than the old access modes — and not under the new owner with more than the new
805 * access modes either. */
807 if (S_ISLNK(st
->st_mode
))
808 log_debug("Skipping temporary mode fix for symlink %s.", path
);
810 mode_t m
= new_mode
& st
->st_mode
; /* Mask new mode by old mode */
812 if (((m
^ st
->st_mode
) & 07777) == 0)
813 log_debug("\"%s\" matches temporary mode %o already.", path
, m
);
815 log_debug("Temporarily changing \"%s\" to mode %o.", path
, m
);
816 if (fchmod_opath(fd
, m
) < 0)
817 return log_error_errno(errno
, "fchmod() of %s failed: %m", path
);
823 log_debug("Changing \"%s\" to owner "UID_FMT
":"GID_FMT
,
825 i
->uid_set
? i
->uid
: UID_INVALID
,
826 i
->gid_set
? i
->gid
: GID_INVALID
);
830 i
->uid_set
? i
->uid
: UID_INVALID
,
831 i
->gid_set
? i
->gid
: GID_INVALID
,
833 return log_error_errno(errno
, "fchownat() of %s failed: %m", path
);
836 /* Now, apply the final mode. We do this in two cases: when the user set a mode explicitly, or after a
837 * chown(), since chown()'s mangle the access mode in regards to sgid/suid in some conditions. */
838 if (i
->mode_set
|| do_chown
) {
839 if (S_ISLNK(st
->st_mode
))
840 log_debug("Skipping mode fix for symlink %s.", path
);
842 /* Check if the chmod() is unnecessary. Note that if we did a chown() before we always
843 * chmod() here again, since it might have mangled the bits. */
844 if (!do_chown
&& ((new_mode
^ st
->st_mode
) & 07777) == 0)
845 log_debug("\"%s\" matches mode %o already.", path
, new_mode
);
847 log_debug("Changing \"%s\" to mode %o.", path
, new_mode
);
848 if (fchmod_opath(fd
, new_mode
) < 0)
849 return log_error_errno(errno
, "fchmod() of %s failed: %m", path
);
855 return label_fix(path
, 0);
858 static int path_open_parent_safe(const char *path
) {
859 _cleanup_free_
char *dn
= NULL
;
862 if (path_equal(path
, "/") || !path_is_normalized(path
))
863 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
864 "Failed to open parent of '%s': invalid path.",
867 dn
= dirname_malloc(path
);
871 r
= chase_symlinks(dn
, arg_root
, CHASE_SAFE
|CHASE_WARN
, NULL
, &fd
);
872 if (r
< 0 && r
!= -ENOLINK
)
873 return log_error_errno(r
, "Failed to validate path %s: %m", path
);
875 return r
< 0 ? r
: fd
;
878 static int path_open_safe(const char *path
) {
881 /* path_open_safe() returns a file descriptor opened with O_PATH after
882 * verifying that the path doesn't contain unsafe transitions, except
883 * for its final component as the function does not follow symlink. */
887 if (!path_is_normalized(path
))
888 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
889 "Failed to open invalid path '%s'.",
892 r
= chase_symlinks(path
, arg_root
, CHASE_SAFE
|CHASE_WARN
|CHASE_NOFOLLOW
, NULL
, &fd
);
893 if (r
< 0 && r
!= -ENOLINK
)
894 return log_error_errno(r
, "Failed to validate path %s: %m", path
);
896 return r
< 0 ? r
: fd
;
899 static int path_set_perms(Item
*i
, const char *path
) {
900 _cleanup_close_
int fd
= -1;
905 fd
= path_open_safe(path
);
909 return fd_set_perms(i
, fd
, path
, NULL
);
912 static int parse_xattrs_from_arg(Item
*i
) {
922 _cleanup_free_
char *name
= NULL
, *value
= NULL
, *xattr
= NULL
;
924 r
= extract_first_word(&p
, &xattr
, NULL
, EXTRACT_UNQUOTE
|EXTRACT_CUNESCAPE
);
926 log_warning_errno(r
, "Failed to parse extended attribute '%s', ignoring: %m", p
);
930 r
= split_pair(xattr
, "=", &name
, &value
);
932 log_warning_errno(r
, "Failed to parse extended attribute, ignoring: %s", xattr
);
936 if (isempty(name
) || isempty(value
)) {
937 log_warning("Malformed extended attribute found, ignoring: %s", xattr
);
941 if (strv_push_pair(&i
->xattrs
, name
, value
) < 0)
950 static int fd_set_xattrs(Item
*i
, int fd
, const char *path
, const struct stat
*st
) {
951 char procfs_path
[STRLEN("/proc/self/fd/") + DECIMAL_STR_MAX(int)];
952 char **name
, **value
;
958 xsprintf(procfs_path
, "/proc/self/fd/%i", fd
);
960 STRV_FOREACH_PAIR(name
, value
, i
->xattrs
) {
961 log_debug("Setting extended attribute '%s=%s' on %s.", *name
, *value
, path
);
962 if (setxattr(procfs_path
, *name
, *value
, strlen(*value
), 0) < 0)
963 return log_error_errno(errno
, "Setting extended attribute %s=%s on %s failed: %m",
964 *name
, *value
, path
);
969 static int path_set_xattrs(Item
*i
, const char *path
) {
970 _cleanup_close_
int fd
= -1;
975 fd
= path_open_safe(path
);
979 return fd_set_xattrs(i
, fd
, path
, NULL
);
982 static int parse_acls_from_arg(Item
*item
) {
988 /* If append_or_force (= modify) is set, we will not modify the acl
989 * afterwards, so the mask can be added now if necessary. */
991 r
= parse_acl(item
->argument
, &item
->acl_access
, &item
->acl_default
, !item
->append_or_force
);
993 log_warning_errno(r
, "Failed to parse ACL \"%s\": %m. Ignoring", item
->argument
);
995 log_warning_errno(SYNTHETIC_ERRNO(ENOSYS
), "ACLs are not supported. Ignoring");
1002 static int path_set_acl(const char *path
, const char *pretty
, acl_type_t type
, acl_t acl
, bool modify
) {
1003 _cleanup_(acl_free_charpp
) char *t
= NULL
;
1004 _cleanup_(acl_freep
) acl_t dup
= NULL
;
1007 /* Returns 0 for success, positive error if already warned,
1008 * negative error otherwise. */
1011 r
= acls_for_file(path
, type
, acl
, &dup
);
1015 r
= calc_acl_mask_if_needed(&dup
);
1023 /* the mask was already added earlier if needed */
1026 r
= add_base_acls_if_needed(&dup
, path
);
1030 t
= acl_to_any_text(dup
, NULL
, ',', TEXT_ABBREVIATE
);
1031 log_debug("Setting %s ACL %s on %s.",
1032 type
== ACL_TYPE_ACCESS
? "access" : "default",
1035 r
= acl_set_file(path
, type
, dup
);
1037 /* Return positive to indicate we already warned */
1038 return -log_error_errno(errno
,
1039 "Setting %s ACL \"%s\" on %s failed: %m",
1040 type
== ACL_TYPE_ACCESS
? "access" : "default",
1047 static int fd_set_acls(Item
*item
, int fd
, const char *path
, const struct stat
*st
) {
1050 char procfs_path
[STRLEN("/proc/self/fd/") + DECIMAL_STR_MAX(int)];
1058 if (fstat(fd
, &stbuf
) < 0)
1059 return log_error_errno(errno
, "fstat(%s) failed: %m", path
);
1063 if (hardlink_vulnerable(st
))
1064 return log_error_errno(SYNTHETIC_ERRNO(EPERM
),
1065 "Refusing to set ACLs on hardlinked file %s while the fs.protected_hardlinks sysctl is turned off.",
1068 if (S_ISLNK(st
->st_mode
)) {
1069 log_debug("Skipping ACL fix for symlink %s.", path
);
1073 xsprintf(procfs_path
, "/proc/self/fd/%i", fd
);
1075 if (item
->acl_access
)
1076 r
= path_set_acl(procfs_path
, path
, ACL_TYPE_ACCESS
, item
->acl_access
, item
->append_or_force
);
1078 /* set only default acls to folders */
1079 if (r
== 0 && item
->acl_default
&& S_ISDIR(st
->st_mode
))
1080 r
= path_set_acl(procfs_path
, path
, ACL_TYPE_DEFAULT
, item
->acl_default
, item
->append_or_force
);
1083 return -r
; /* already warned */
1084 if (r
== -EOPNOTSUPP
) {
1085 log_debug_errno(r
, "ACLs not supported by file system at %s", path
);
1089 return log_error_errno(r
, "ACL operation on \"%s\" failed: %m", path
);
1094 static int path_set_acls(Item
*item
, const char *path
) {
1097 _cleanup_close_
int fd
= -1;
1102 fd
= path_open_safe(path
);
1106 r
= fd_set_acls(item
, fd
, path
, NULL
);
1111 static int parse_attribute_from_arg(Item
*item
) {
1113 static const struct {
1117 { 'A', FS_NOATIME_FL
}, /* do not update atime */
1118 { 'S', FS_SYNC_FL
}, /* Synchronous updates */
1119 { 'D', FS_DIRSYNC_FL
}, /* dirsync behaviour (directories only) */
1120 { 'a', FS_APPEND_FL
}, /* writes to file may only append */
1121 { 'c', FS_COMPR_FL
}, /* Compress file */
1122 { 'd', FS_NODUMP_FL
}, /* do not dump file */
1123 { 'e', FS_EXTENT_FL
}, /* Extents */
1124 { 'i', FS_IMMUTABLE_FL
}, /* Immutable file */
1125 { 'j', FS_JOURNAL_DATA_FL
}, /* Reserved for ext3 */
1126 { 's', FS_SECRM_FL
}, /* Secure deletion */
1127 { 'u', FS_UNRM_FL
}, /* Undelete */
1128 { 't', FS_NOTAIL_FL
}, /* file tail should not be merged */
1129 { 'T', FS_TOPDIR_FL
}, /* Top of directory hierarchies */
1130 { 'C', FS_NOCOW_FL
}, /* Do not cow file */
1131 { 'P', FS_PROJINHERIT_FL
}, /* Inherit the quota project ID */
1140 unsigned value
= 0, mask
= 0;
1150 } else if (*p
== '-') {
1153 } else if (*p
== '=') {
1159 if (isempty(p
) && mode
!= MODE_SET
)
1160 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
1161 "Setting file attribute on '%s' needs an attribute specification.",
1164 for (; p
&& *p
; p
++) {
1167 for (i
= 0; i
< ELEMENTSOF(attributes
); i
++)
1168 if (*p
== attributes
[i
].character
)
1171 if (i
>= ELEMENTSOF(attributes
))
1172 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
1173 "Unknown file attribute '%c' on '%s'.",
1176 v
= attributes
[i
].value
;
1178 SET_FLAG(value
, v
, IN_SET(mode
, MODE_ADD
, MODE_SET
));
1183 if (mode
== MODE_SET
)
1184 mask
|= CHATTR_ALL_FL
;
1188 item
->attribute_mask
= mask
;
1189 item
->attribute_value
= value
;
1190 item
->attribute_set
= true;
1195 static int fd_set_attribute(Item
*item
, int fd
, const char *path
, const struct stat
*st
) {
1196 _cleanup_close_
int procfs_fd
= -1;
1205 if (!item
->attribute_set
|| item
->attribute_mask
== 0)
1209 if (fstat(fd
, &stbuf
) < 0)
1210 return log_error_errno(errno
, "fstat(%s) failed: %m", path
);
1214 /* Issuing the file attribute ioctls on device nodes is not
1215 * safe, as that will be delivered to the drivers, not the
1216 * file system containing the device node. */
1217 if (!S_ISREG(st
->st_mode
) && !S_ISDIR(st
->st_mode
))
1218 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
1219 "Setting file flags is only supported on regular files and directories, cannot set on '%s'.",
1222 f
= item
->attribute_value
& item
->attribute_mask
;
1224 /* Mask away directory-specific flags */
1225 if (!S_ISDIR(st
->st_mode
))
1226 f
&= ~FS_DIRSYNC_FL
;
1228 procfs_fd
= fd_reopen(fd
, O_RDONLY
|O_CLOEXEC
|O_NOATIME
);
1230 return log_error_errno(procfs_fd
, "Failed to re-open '%s': %m", path
);
1232 r
= chattr_fd(procfs_fd
, f
, item
->attribute_mask
, NULL
);
1234 log_full_errno(IN_SET(r
, -ENOTTY
, -EOPNOTSUPP
) ? LOG_DEBUG
: LOG_WARNING
,
1236 "Cannot set file attribute for '%s', value=0x%08x, mask=0x%08x, ignoring: %m",
1237 path
, item
->attribute_value
, item
->attribute_mask
);
1242 static int path_set_attribute(Item
*item
, const char *path
) {
1243 _cleanup_close_
int fd
= -1;
1245 if (!item
->attribute_set
|| item
->attribute_mask
== 0)
1248 fd
= path_open_safe(path
);
1252 return fd_set_attribute(item
, fd
, path
, NULL
);
1255 static int write_one_file(Item
*i
, const char *path
) {
1256 _cleanup_close_
int fd
= -1, dir_fd
= -1;
1262 assert(i
->argument
);
1263 assert(i
->type
== WRITE_FILE
);
1265 /* Validate the path and keep the fd on the directory for opening the
1266 * file so we're sure that it can't be changed behind our back. */
1267 dir_fd
= path_open_parent_safe(path
);
1271 bn
= basename(path
);
1273 flags
= O_NONBLOCK
|O_CLOEXEC
|O_WRONLY
|O_NOCTTY
;
1275 /* Follows symlinks */
1276 fd
= openat(dir_fd
, bn
, i
->append_or_force
? flags
|O_APPEND
: flags
, i
->mode
);
1278 if (errno
== ENOENT
) {
1279 log_debug_errno(errno
, "Not writing missing file \"%s\": %m", path
);
1282 return log_error_errno(errno
, "Failed to open file \"%s\": %m", path
);
1285 /* 'w' is allowed to write into any kind of files. */
1286 log_debug("Writing to \"%s\".", path
);
1288 r
= loop_write(fd
, i
->argument
, strlen(i
->argument
), false);
1290 return log_error_errno(r
, "Failed to write file \"%s\": %m", path
);
1292 return fd_set_perms(i
, fd
, path
, NULL
);
1295 static int create_file(Item
*i
, const char *path
) {
1296 _cleanup_close_
int fd
= -1, dir_fd
= -1;
1297 struct stat stbuf
, *st
= NULL
;
1303 assert(i
->type
== CREATE_FILE
);
1305 /* 'f' operates on regular files exclusively. */
1307 /* Validate the path and keep the fd on the directory for opening the
1308 * file so we're sure that it can't be changed behind our back. */
1309 dir_fd
= path_open_parent_safe(path
);
1313 bn
= basename(path
);
1315 RUN_WITH_UMASK(0000) {
1316 mac_selinux_create_file_prepare(path
, S_IFREG
);
1317 fd
= openat(dir_fd
, bn
, O_CREAT
|O_EXCL
|O_NOFOLLOW
|O_NONBLOCK
|O_CLOEXEC
|O_WRONLY
|O_NOCTTY
, i
->mode
);
1318 mac_selinux_create_file_clear();
1322 /* Even on a read-only filesystem, open(2) returns EEXIST if the
1323 * file already exists. It returns EROFS only if it needs to
1324 * create the file. */
1325 if (errno
!= EEXIST
)
1326 return log_error_errno(errno
, "Failed to create file %s: %m", path
);
1328 /* Re-open the file. At that point it must exist since open(2)
1329 * failed with EEXIST. We still need to check if the perms/mode
1330 * need to be changed. For read-only filesystems, we let
1331 * fd_set_perms() report the error if the perms need to be
1333 fd
= openat(dir_fd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
, i
->mode
);
1335 return log_error_errno(errno
, "Failed to re-open file %s: %m", path
);
1337 if (fstat(fd
, &stbuf
) < 0)
1338 return log_error_errno(errno
, "stat(%s) failed: %m", path
);
1340 if (!S_ISREG(stbuf
.st_mode
)) {
1341 log_error("%s exists and is not a regular file.", path
);
1348 log_debug("\"%s\" has been created.", path
);
1351 log_debug("Writing to \"%s\".", path
);
1353 r
= loop_write(fd
, i
->argument
, strlen(i
->argument
), false);
1355 return log_error_errno(r
, "Failed to write file \"%s\": %m", path
);
1359 return fd_set_perms(i
, fd
, path
, st
);
1362 static int truncate_file(Item
*i
, const char *path
) {
1363 _cleanup_close_
int fd
= -1, dir_fd
= -1;
1364 struct stat stbuf
, *st
= NULL
;
1371 assert(i
->type
== TRUNCATE_FILE
);
1373 /* We want to operate on regular file exclusively especially since
1374 * O_TRUNC is unspecified if the file is neither a regular file nor a
1375 * fifo nor a terminal device. Therefore we first open the file and make
1376 * sure it's a regular one before truncating it. */
1378 /* Validate the path and keep the fd on the directory for opening the
1379 * file so we're sure that it can't be changed behind our back. */
1380 dir_fd
= path_open_parent_safe(path
);
1384 bn
= basename(path
);
1386 RUN_WITH_UMASK(0000) {
1387 mac_selinux_create_file_prepare(path
, S_IFREG
);
1388 fd
= openat(dir_fd
, bn
, O_CREAT
|O_NOFOLLOW
|O_NONBLOCK
|O_CLOEXEC
|O_WRONLY
|O_NOCTTY
, i
->mode
);
1389 mac_selinux_create_file_clear();
1394 return log_error_errno(errno
, "Failed to open/create file %s: %m", path
);
1396 /* On a read-only filesystem, we don't want to fail if the
1397 * target is already empty and the perms are set. So we still
1398 * proceed with the sanity checks and let the remaining
1399 * operations fail with EROFS if they try to modify the target
1402 fd
= openat(dir_fd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
, i
->mode
);
1404 if (errno
== ENOENT
) {
1405 log_error("Cannot create file %s on a read-only file system.", path
);
1409 return log_error_errno(errno
, "Failed to re-open file %s: %m", path
);
1415 if (fstat(fd
, &stbuf
) < 0)
1416 return log_error_errno(errno
, "stat(%s) failed: %m", path
);
1418 if (!S_ISREG(stbuf
.st_mode
)) {
1419 log_error("%s exists and is not a regular file.", path
);
1423 if (stbuf
.st_size
> 0) {
1424 if (ftruncate(fd
, 0) < 0) {
1425 r
= erofs
? -EROFS
: -errno
;
1426 return log_error_errno(r
, "Failed to truncate file %s: %m", path
);
1431 log_debug("\"%s\" has been created.", path
);
1434 log_debug("Writing to \"%s\".", path
);
1436 r
= loop_write(fd
, i
->argument
, strlen(i
->argument
), false);
1438 r
= erofs
? -EROFS
: r
;
1439 return log_error_errno(r
, "Failed to write file %s: %m", path
);
1443 return fd_set_perms(i
, fd
, path
, st
);
1446 static int copy_files(Item
*i
) {
1447 _cleanup_close_
int dfd
= -1, fd
= -1;
1451 log_debug("Copying tree \"%s\" to \"%s\".", i
->argument
, i
->path
);
1453 bn
= basename(i
->path
);
1455 /* Validate the path and use the returned directory fd for copying the
1456 * target so we're sure that the path can't be changed behind our
1458 dfd
= path_open_parent_safe(i
->path
);
1462 r
= copy_tree_at(AT_FDCWD
, i
->argument
,
1464 i
->uid_set
? i
->uid
: UID_INVALID
,
1465 i
->gid_set
? i
->gid
: GID_INVALID
,
1466 COPY_REFLINK
| COPY_MERGE_EMPTY
);
1470 /* If the target already exists on read-only filesystems, trying
1471 * to create the target will not fail with EEXIST but with
1473 if (r
== -EROFS
&& faccessat(dfd
, bn
, F_OK
, AT_SYMLINK_NOFOLLOW
) == 0)
1477 return log_error_errno(r
, "Failed to copy files to %s: %m", i
->path
);
1479 if (stat(i
->argument
, &a
) < 0)
1480 return log_error_errno(errno
, "stat(%s) failed: %m", i
->argument
);
1482 if (fstatat(dfd
, bn
, &b
, AT_SYMLINK_NOFOLLOW
) < 0)
1483 return log_error_errno(errno
, "stat(%s) failed: %m", i
->path
);
1485 if ((a
.st_mode
^ b
.st_mode
) & S_IFMT
) {
1486 log_debug("Can't copy to %s, file exists already and is of different type", i
->path
);
1491 fd
= openat(dfd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
);
1493 return log_error_errno(errno
, "Failed to openat(%s): %m", i
->path
);
1495 return fd_set_perms(i
, fd
, i
->path
, NULL
);
1503 _CREATION_MODE_INVALID
= -1
1506 static const char *const creation_mode_verb_table
[_CREATION_MODE_MAX
] = {
1507 [CREATION_NORMAL
] = "Created",
1508 [CREATION_EXISTING
] = "Found existing",
1509 [CREATION_FORCE
] = "Created replacement",
1512 DEFINE_PRIVATE_STRING_TABLE_LOOKUP_TO_STRING(creation_mode_verb
, CreationMode
);
1514 static int create_directory_or_subvolume(const char *path
, mode_t mode
, bool subvol
, CreationMode
*creation
) {
1515 _cleanup_close_
int pfd
= -1;
1524 pfd
= path_open_parent_safe(path
);
1529 if (btrfs_is_subvol(empty_to_root(arg_root
)) <= 0)
1531 /* Don't create a subvolume unless the root directory is
1532 * one, too. We do this under the assumption that if the
1533 * root directory is just a plain directory (i.e. very
1534 * light-weight), we shouldn't try to split it up into
1535 * subvolumes (i.e. more heavy-weight). Thus, chroot()
1536 * environments and suchlike will get a full brtfs
1537 * subvolume set up below their tree only if they
1538 * specifically set up a btrfs subvolume for the root
1543 RUN_WITH_UMASK((~mode
) & 0777)
1544 r
= btrfs_subvol_make_fd(pfd
, basename(path
));
1549 if (!subvol
|| r
== -ENOTTY
)
1550 RUN_WITH_UMASK(0000)
1551 r
= mkdirat_label(pfd
, basename(path
), mode
);
1556 if (!IN_SET(r
, -EEXIST
, -EROFS
))
1557 return log_error_errno(r
, "Failed to create directory or subvolume \"%s\": %m", path
);
1560 if (k
== -ENOENT
&& r
== -EROFS
)
1561 return log_error_errno(r
, "%s does not exist and cannot be created as the file system is read-only.", path
);
1563 return log_error_errno(k
, "Failed to check if %s exists: %m", path
);
1565 log_warning("\"%s\" already exists and is not a directory.", path
);
1569 *creation
= CREATION_EXISTING
;
1571 *creation
= CREATION_NORMAL
;
1573 log_debug("%s directory \"%s\".", creation_mode_verb_to_string(*creation
), path
);
1575 r
= openat(pfd
, basename(path
), O_NOCTTY
|O_CLOEXEC
|O_DIRECTORY
);
1577 return log_error_errno(errno
, "Failed to open directory '%s': %m", basename(path
));
1582 static int create_directory(Item
*i
, const char *path
) {
1583 _cleanup_close_
int fd
= -1;
1586 assert(IN_SET(i
->type
, CREATE_DIRECTORY
, TRUNCATE_DIRECTORY
));
1588 fd
= create_directory_or_subvolume(path
, i
->mode
, false, NULL
);
1594 return fd_set_perms(i
, fd
, path
, NULL
);
1597 static int create_subvolume(Item
*i
, const char *path
) {
1598 _cleanup_close_
int fd
= -1;
1599 CreationMode creation
;
1603 assert(IN_SET(i
->type
, CREATE_SUBVOLUME
, CREATE_SUBVOLUME_NEW_QUOTA
, CREATE_SUBVOLUME_INHERIT_QUOTA
));
1605 fd
= create_directory_or_subvolume(path
, i
->mode
, true, &creation
);
1611 if (creation
== CREATION_NORMAL
&&
1612 IN_SET(i
->type
, CREATE_SUBVOLUME_NEW_QUOTA
, CREATE_SUBVOLUME_INHERIT_QUOTA
)) {
1613 r
= btrfs_subvol_auto_qgroup_fd(fd
, 0, i
->type
== CREATE_SUBVOLUME_NEW_QUOTA
);
1615 log_debug_errno(r
, "Couldn't adjust quota for subvolume \"%s\" (unsupported fs or dir not a subvolume): %m", i
->path
);
1616 else if (r
== -EROFS
)
1617 log_debug_errno(r
, "Couldn't adjust quota for subvolume \"%s\" (fs is read-only).", i
->path
);
1618 else if (r
== -ENOPROTOOPT
)
1619 log_debug_errno(r
, "Couldn't adjust quota for subvolume \"%s\" (quota support is disabled).", i
->path
);
1621 q
= log_error_errno(r
, "Failed to adjust quota for subvolume \"%s\": %m", i
->path
);
1623 log_debug("Adjusted quota for subvolume \"%s\".", i
->path
);
1625 log_debug("Quota for subvolume \"%s\" already in place, no change made.", i
->path
);
1628 r
= fd_set_perms(i
, fd
, path
, NULL
);
1629 if (q
< 0) /* prefer the quota change error from above */
1635 static int empty_directory(Item
*i
, const char *path
) {
1639 assert(i
->type
== EMPTY_DIRECTORY
);
1641 r
= is_dir(path
, false);
1643 /* Option "e" operates only on existing objects. Do not
1644 * print errors about non-existent files or directories */
1645 log_debug("Skipping missing directory: %s", path
);
1649 return log_error_errno(r
, "is_dir() failed on path %s: %m", path
);
1651 return log_error_errno(SYNTHETIC_ERRNO(EEXIST
),
1652 "'%s' already exists and is not a directory.",
1655 return path_set_perms(i
, path
);
1658 static int create_device(Item
*i
, mode_t file_type
) {
1659 _cleanup_close_
int dfd
= -1, fd
= -1;
1660 CreationMode creation
;
1665 assert(IN_SET(file_type
, S_IFBLK
, S_IFCHR
));
1667 bn
= basename(i
->path
);
1669 /* Validate the path and use the returned directory fd for copying the
1670 * target so we're sure that the path can't be changed behind our
1672 dfd
= path_open_parent_safe(i
->path
);
1676 RUN_WITH_UMASK(0000) {
1677 mac_selinux_create_file_prepare(i
->path
, file_type
);
1678 r
= mknodat(dfd
, bn
, i
->mode
| file_type
, i
->major_minor
);
1679 mac_selinux_create_file_clear();
1685 if (errno
== EPERM
) {
1686 log_debug("We lack permissions, possibly because of cgroup configuration; "
1687 "skipping creation of device node %s.", i
->path
);
1691 if (errno
!= EEXIST
)
1692 return log_error_errno(errno
, "Failed to create device node %s: %m", i
->path
);
1694 if (fstatat(dfd
, bn
, &st
, 0) < 0)
1695 return log_error_errno(errno
, "stat(%s) failed: %m", i
->path
);
1697 if ((st
.st_mode
& S_IFMT
) != file_type
) {
1699 if (i
->append_or_force
) {
1701 RUN_WITH_UMASK(0000) {
1702 mac_selinux_create_file_prepare(i
->path
, file_type
);
1703 /* FIXME: need to introduce mknodat_atomic() */
1704 r
= mknod_atomic(i
->path
, i
->mode
| file_type
, i
->major_minor
);
1705 mac_selinux_create_file_clear();
1709 return log_error_errno(r
, "Failed to create device node \"%s\": %m", i
->path
);
1710 creation
= CREATION_FORCE
;
1712 log_debug("%s is not a device node.", i
->path
);
1716 creation
= CREATION_EXISTING
;
1718 creation
= CREATION_NORMAL
;
1720 log_debug("%s %s device node \"%s\" %u:%u.",
1721 creation_mode_verb_to_string(creation
),
1722 i
->type
== CREATE_BLOCK_DEVICE
? "block" : "char",
1723 i
->path
, major(i
->mode
), minor(i
->mode
));
1725 fd
= openat(dfd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
);
1727 return log_error_errno(errno
, "Failed to openat(%s): %m", i
->path
);
1729 return fd_set_perms(i
, fd
, i
->path
, NULL
);
1732 static int create_fifo(Item
*i
, const char *path
) {
1733 _cleanup_close_
int pfd
= -1, fd
= -1;
1734 CreationMode creation
;
1739 pfd
= path_open_parent_safe(path
);
1743 bn
= basename(path
);
1745 RUN_WITH_UMASK(0000) {
1746 mac_selinux_create_file_prepare(path
, S_IFIFO
);
1747 r
= mkfifoat(pfd
, bn
, i
->mode
);
1748 mac_selinux_create_file_clear();
1752 if (errno
!= EEXIST
)
1753 return log_error_errno(errno
, "Failed to create fifo %s: %m", path
);
1755 if (fstatat(pfd
, bn
, &st
, AT_SYMLINK_NOFOLLOW
) < 0)
1756 return log_error_errno(errno
, "stat(%s) failed: %m", path
);
1758 if (!S_ISFIFO(st
.st_mode
)) {
1760 if (i
->append_or_force
) {
1761 RUN_WITH_UMASK(0000) {
1762 mac_selinux_create_file_prepare(path
, S_IFIFO
);
1763 r
= mkfifoat_atomic(pfd
, bn
, i
->mode
);
1764 mac_selinux_create_file_clear();
1768 return log_error_errno(r
, "Failed to create fifo %s: %m", path
);
1769 creation
= CREATION_FORCE
;
1771 log_warning("\"%s\" already exists and is not a fifo.", path
);
1775 creation
= CREATION_EXISTING
;
1777 creation
= CREATION_NORMAL
;
1779 log_debug("%s fifo \"%s\".", creation_mode_verb_to_string(creation
), path
);
1781 fd
= openat(pfd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
);
1783 return log_error_errno(errno
, "Failed to openat(%s): %m", path
);
1785 return fd_set_perms(i
, fd
, i
->path
, NULL
);
1788 typedef int (*action_t
)(Item
*i
, const char *path
);
1789 typedef int (*fdaction_t
)(Item
*i
, int fd
, const char *path
, const struct stat
*st
);
1791 static int item_do(Item
*i
, int fd
, const char *path
, fdaction_t action
) {
1799 if (fstat(fd
, &st
) < 0) {
1800 r
= log_error_errno(errno
, "fstat() on file failed: %m");
1804 /* This returns the first error we run into, but nevertheless
1806 r
= action(i
, fd
, path
, &st
);
1808 if (S_ISDIR(st
.st_mode
)) {
1809 char procfs_path
[STRLEN("/proc/self/fd/") + DECIMAL_STR_MAX(int)];
1810 _cleanup_closedir_
DIR *d
= NULL
;
1813 /* The passed 'fd' was opened with O_PATH. We need to convert
1814 * it into a 'regular' fd before reading the directory content. */
1815 xsprintf(procfs_path
, "/proc/self/fd/%i", fd
);
1817 d
= opendir(procfs_path
);
1819 log_error_errno(errno
, "Failed to opendir() '%s': %m", procfs_path
);
1825 FOREACH_DIRENT_ALL(de
, d
, q
= -errno
; goto finish
) {
1828 if (dot_or_dot_dot(de
->d_name
))
1831 de_fd
= openat(fd
, de
->d_name
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
);
1833 q
= log_error_errno(errno
, "Failed to open() file '%s': %m", de
->d_name
);
1835 _cleanup_free_
char *de_path
= NULL
;
1837 de_path
= path_join(path
, de
->d_name
);
1841 /* Pass ownership of dirent fd over */
1842 q
= item_do(i
, de_fd
, de_path
, action
);
1845 if (q
< 0 && r
== 0)
1854 static int glob_item(Item
*i
, action_t action
) {
1855 _cleanup_globfree_ glob_t g
= {
1856 .gl_opendir
= (void *(*)(const char *)) opendir_nomod
,
1861 k
= safe_glob(i
->path
, GLOB_NOSORT
|GLOB_BRACE
, &g
);
1862 if (k
< 0 && k
!= -ENOENT
)
1863 return log_error_errno(k
, "glob(%s) failed: %m", i
->path
);
1865 STRV_FOREACH(fn
, g
.gl_pathv
) {
1867 if (k
< 0 && r
== 0)
1874 static int glob_item_recursively(Item
*i
, fdaction_t action
) {
1875 _cleanup_globfree_ glob_t g
= {
1876 .gl_opendir
= (void *(*)(const char *)) opendir_nomod
,
1881 k
= safe_glob(i
->path
, GLOB_NOSORT
|GLOB_BRACE
, &g
);
1882 if (k
< 0 && k
!= -ENOENT
)
1883 return log_error_errno(k
, "glob(%s) failed: %m", i
->path
);
1885 STRV_FOREACH(fn
, g
.gl_pathv
) {
1886 _cleanup_close_
int fd
= -1;
1888 /* Make sure we won't trigger/follow file object (such as
1889 * device nodes, automounts, ...) pointed out by 'fn' with
1890 * O_PATH. Note, when O_PATH is used, flags other than
1891 * O_CLOEXEC, O_DIRECTORY, and O_NOFOLLOW are ignored. */
1893 fd
= open(*fn
, O_CLOEXEC
|O_NOFOLLOW
|O_PATH
);
1895 log_error_errno(errno
, "Opening '%s' failed: %m", *fn
);
1901 k
= item_do(i
, fd
, *fn
, action
);
1902 if (k
< 0 && r
== 0)
1905 /* we passed fd ownership to the previous call */
1912 static int create_item(Item
*i
) {
1913 CreationMode creation
;
1918 log_debug("Running create action for entry %c %s", (char) i
->type
, i
->path
);
1923 case IGNORE_DIRECTORY_PATH
:
1925 case RECURSIVE_REMOVE_PATH
:
1929 RUN_WITH_UMASK(0000)
1930 (void) mkdir_parents_label(i
->path
, 0755);
1932 r
= create_file(i
, i
->path
);
1938 RUN_WITH_UMASK(0000)
1939 (void) mkdir_parents_label(i
->path
, 0755);
1941 r
= truncate_file(i
, i
->path
);
1947 RUN_WITH_UMASK(0000)
1948 (void) mkdir_parents_label(i
->path
, 0755);
1956 r
= glob_item(i
, write_one_file
);
1962 case CREATE_DIRECTORY
:
1963 case TRUNCATE_DIRECTORY
:
1964 RUN_WITH_UMASK(0000)
1965 (void) mkdir_parents_label(i
->path
, 0755);
1967 r
= create_directory(i
, i
->path
);
1972 case CREATE_SUBVOLUME
:
1973 case CREATE_SUBVOLUME_INHERIT_QUOTA
:
1974 case CREATE_SUBVOLUME_NEW_QUOTA
:
1975 RUN_WITH_UMASK(0000)
1976 (void) mkdir_parents_label(i
->path
, 0755);
1978 r
= create_subvolume(i
, i
->path
);
1983 case EMPTY_DIRECTORY
:
1984 r
= glob_item(i
, empty_directory
);
1990 RUN_WITH_UMASK(0000)
1991 (void) mkdir_parents_label(i
->path
, 0755);
1993 r
= create_fifo(i
, i
->path
);
1998 case CREATE_SYMLINK
: {
1999 RUN_WITH_UMASK(0000)
2000 (void) mkdir_parents_label(i
->path
, 0755);
2002 mac_selinux_create_file_prepare(i
->path
, S_IFLNK
);
2003 r
= symlink(i
->argument
, i
->path
);
2004 mac_selinux_create_file_clear();
2007 _cleanup_free_
char *x
= NULL
;
2009 if (errno
!= EEXIST
)
2010 return log_error_errno(errno
, "symlink(%s, %s) failed: %m", i
->argument
, i
->path
);
2012 r
= readlink_malloc(i
->path
, &x
);
2013 if (r
< 0 || !streq(i
->argument
, x
)) {
2015 if (i
->append_or_force
) {
2016 mac_selinux_create_file_prepare(i
->path
, S_IFLNK
);
2017 r
= symlink_atomic(i
->argument
, i
->path
);
2018 mac_selinux_create_file_clear();
2020 if (IN_SET(r
, -EISDIR
, -EEXIST
, -ENOTEMPTY
)) {
2021 r
= rm_rf(i
->path
, REMOVE_ROOT
|REMOVE_PHYSICAL
);
2023 return log_error_errno(r
, "rm -fr %s failed: %m", i
->path
);
2025 mac_selinux_create_file_prepare(i
->path
, S_IFLNK
);
2026 r
= symlink(i
->argument
, i
->path
) < 0 ? -errno
: 0;
2027 mac_selinux_create_file_clear();
2030 return log_error_errno(r
, "symlink(%s, %s) failed: %m", i
->argument
, i
->path
);
2032 creation
= CREATION_FORCE
;
2034 log_debug("\"%s\" is not a symlink or does not point to the correct path.", i
->path
);
2038 creation
= CREATION_EXISTING
;
2041 creation
= CREATION_NORMAL
;
2042 log_debug("%s symlink \"%s\".", creation_mode_verb_to_string(creation
), i
->path
);
2046 case CREATE_BLOCK_DEVICE
:
2047 case CREATE_CHAR_DEVICE
:
2048 if (have_effective_cap(CAP_MKNOD
) == 0) {
2049 /* In a container we lack CAP_MKNOD. We shouldn't attempt to create the device node in that
2050 * case to avoid noise, and we don't support virtualized devices in containers anyway. */
2052 log_debug("We lack CAP_MKNOD, skipping creation of device node %s.", i
->path
);
2056 RUN_WITH_UMASK(0000)
2057 (void) mkdir_parents_label(i
->path
, 0755);
2059 r
= create_device(i
, i
->type
== CREATE_BLOCK_DEVICE
? S_IFBLK
: S_IFCHR
);
2067 r
= glob_item(i
, path_set_perms
);
2072 case RECURSIVE_RELABEL_PATH
:
2073 r
= glob_item_recursively(i
, fd_set_perms
);
2079 r
= glob_item(i
, path_set_xattrs
);
2084 case RECURSIVE_SET_XATTR
:
2085 r
= glob_item_recursively(i
, fd_set_xattrs
);
2091 r
= glob_item(i
, path_set_acls
);
2096 case RECURSIVE_SET_ACL
:
2097 r
= glob_item_recursively(i
, fd_set_acls
);
2103 r
= glob_item(i
, path_set_attribute
);
2108 case RECURSIVE_SET_ATTRIBUTE
:
2109 r
= glob_item_recursively(i
, fd_set_attribute
);
2118 static int remove_item_instance(Item
*i
, const char *instance
) {
2126 if (remove(instance
) < 0 && errno
!= ENOENT
)
2127 return log_error_errno(errno
, "rm(%s): %m", instance
);
2131 case RECURSIVE_REMOVE_PATH
:
2132 /* FIXME: we probably should use dir_cleanup() here instead of rm_rf() so that 'x' is honoured. */
2133 log_debug("rm -rf \"%s\"", instance
);
2134 r
= rm_rf(instance
, REMOVE_ROOT
|REMOVE_SUBVOLUME
|REMOVE_PHYSICAL
);
2135 if (r
< 0 && r
!= -ENOENT
)
2136 return log_error_errno(r
, "rm_rf(%s): %m", instance
);
2141 assert_not_reached("wut?");
2147 static int remove_item(Item
*i
) {
2152 log_debug("Running remove action for entry %c %s", (char) i
->type
, i
->path
);
2156 case TRUNCATE_DIRECTORY
:
2157 /* FIXME: we probably should use dir_cleanup() here instead of rm_rf() so that 'x' is honoured. */
2158 log_debug("rm -rf \"%s\"", i
->path
);
2159 r
= rm_rf(i
->path
, REMOVE_PHYSICAL
);
2160 if (r
< 0 && r
!= -ENOENT
)
2161 return log_error_errno(r
, "rm_rf(%s): %m", i
->path
);
2166 case RECURSIVE_REMOVE_PATH
:
2167 return glob_item(i
, remove_item_instance
);
2174 static int clean_item_instance(Item
*i
, const char* instance
) {
2175 _cleanup_closedir_
DIR *d
= NULL
;
2179 char timestamp
[FORMAT_TIMESTAMP_MAX
];
2186 n
= now(CLOCK_REALTIME
);
2190 cutoff
= n
- i
->age
;
2192 d
= opendir_nomod(instance
);
2194 if (IN_SET(errno
, ENOENT
, ENOTDIR
)) {
2195 log_debug_errno(errno
, "Directory \"%s\": %m", instance
);
2199 return log_error_errno(errno
, "Failed to open directory %s: %m", instance
);
2202 if (fstat(dirfd(d
), &s
) < 0)
2203 return log_error_errno(errno
, "stat(%s) failed: %m", i
->path
);
2205 if (!S_ISDIR(s
.st_mode
))
2206 return log_error_errno(SYNTHETIC_ERRNO(ENOTDIR
),
2207 "%s is not a directory.", i
->path
);
2209 if (fstatat(dirfd(d
), "..", &ps
, AT_SYMLINK_NOFOLLOW
) != 0)
2210 return log_error_errno(errno
, "stat(%s/..) failed: %m", i
->path
);
2212 mountpoint
= s
.st_dev
!= ps
.st_dev
|| s
.st_ino
== ps
.st_ino
;
2214 log_debug("Cleanup threshold for %s \"%s\" is %s",
2215 mountpoint
? "mount point" : "directory",
2217 format_timestamp_us(timestamp
, sizeof(timestamp
), cutoff
));
2219 return dir_cleanup(i
, instance
, d
, &s
, cutoff
, s
.st_dev
, mountpoint
,
2220 MAX_DEPTH
, i
->keep_first_level
);
2223 static int clean_item(Item
*i
) {
2226 log_debug("Running clean action for entry %c %s", (char) i
->type
, i
->path
);
2229 case CREATE_DIRECTORY
:
2230 case CREATE_SUBVOLUME
:
2231 case CREATE_SUBVOLUME_INHERIT_QUOTA
:
2232 case CREATE_SUBVOLUME_NEW_QUOTA
:
2233 case TRUNCATE_DIRECTORY
:
2236 clean_item_instance(i
, i
->path
);
2238 case EMPTY_DIRECTORY
:
2239 case IGNORE_DIRECTORY_PATH
:
2240 return glob_item(i
, clean_item_instance
);
2246 static int process_item(Item
*i
, OperationMask operation
) {
2252 todo
= operation
& ~i
->done
;
2253 if (todo
== 0) /* Everything already done? */
2256 i
->done
|= operation
;
2258 r
= chase_symlinks(i
->path
, arg_root
, CHASE_NO_AUTOFS
|CHASE_WARN
, NULL
, NULL
);
2259 if (r
== -EREMOTE
) {
2260 log_notice_errno(r
, "Skipping %s", i
->path
);
2264 log_debug_errno(r
, "Failed to determine whether '%s' is below autofs, ignoring: %m", i
->path
);
2266 r
= FLAGS_SET(operation
, OPERATION_CREATE
) ? create_item(i
) : 0;
2267 /* Failure can only be tolerated for create */
2268 if (i
->allow_failure
)
2271 q
= FLAGS_SET(operation
, OPERATION_REMOVE
) ? remove_item(i
) : 0;
2272 p
= FLAGS_SET(operation
, OPERATION_CLEAN
) ? clean_item(i
) : 0;
2279 static int process_item_array(ItemArray
*array
, OperationMask operation
) {
2285 /* Create any parent first. */
2286 if (FLAGS_SET(operation
, OPERATION_CREATE
) && array
->parent
)
2287 r
= process_item_array(array
->parent
, operation
& OPERATION_CREATE
);
2289 /* Clean up all children first */
2290 if ((operation
& (OPERATION_REMOVE
|OPERATION_CLEAN
)) && !set_isempty(array
->children
)) {
2294 SET_FOREACH(c
, array
->children
, i
) {
2297 k
= process_item_array(c
, operation
& (OPERATION_REMOVE
|OPERATION_CLEAN
));
2298 if (k
< 0 && r
== 0)
2303 for (n
= 0; n
< array
->n_items
; n
++) {
2306 k
= process_item(array
->items
+ n
, operation
);
2307 if (k
< 0 && r
== 0)
2314 static void item_free_contents(Item
*i
) {
2318 strv_free(i
->xattrs
);
2321 acl_free(i
->acl_access
);
2322 acl_free(i
->acl_default
);
2326 static ItemArray
* item_array_free(ItemArray
*a
) {
2332 for (n
= 0; n
< a
->n_items
; n
++)
2333 item_free_contents(a
->items
+ n
);
2335 set_free(a
->children
);
2340 static int item_compare(const Item
*a
, const Item
*b
) {
2341 /* Make sure that the ownership taking item is put first, so
2342 * that we first create the node, and then can adjust it */
2344 if (takes_ownership(a
->type
) && !takes_ownership(b
->type
))
2346 if (!takes_ownership(a
->type
) && takes_ownership(b
->type
))
2349 return CMP(a
->type
, b
->type
);
2352 static bool item_compatible(Item
*a
, Item
*b
) {
2355 assert(streq(a
->path
, b
->path
));
2357 if (takes_ownership(a
->type
) && takes_ownership(b
->type
))
2358 /* check if the items are the same */
2359 return streq_ptr(a
->argument
, b
->argument
) &&
2361 a
->uid_set
== b
->uid_set
&&
2364 a
->gid_set
== b
->gid_set
&&
2367 a
->mode_set
== b
->mode_set
&&
2368 a
->mode
== b
->mode
&&
2370 a
->age_set
== b
->age_set
&&
2373 a
->mask_perms
== b
->mask_perms
&&
2375 a
->keep_first_level
== b
->keep_first_level
&&
2377 a
->major_minor
== b
->major_minor
;
2382 static bool should_include_path(const char *path
) {
2385 STRV_FOREACH(prefix
, arg_exclude_prefixes
)
2386 if (path_startswith(path
, *prefix
)) {
2387 log_debug("Entry \"%s\" matches exclude prefix \"%s\", skipping.",
2392 STRV_FOREACH(prefix
, arg_include_prefixes
)
2393 if (path_startswith(path
, *prefix
)) {
2394 log_debug("Entry \"%s\" matches include prefix \"%s\".", path
, *prefix
);
2398 /* no matches, so we should include this path only if we
2399 * have no whitelist at all */
2400 if (strv_isempty(arg_include_prefixes
))
2403 log_debug("Entry \"%s\" does not match any include prefix, skipping.", path
);
2407 static int specifier_expansion_from_arg(Item
*i
) {
2408 _cleanup_free_
char *unescaped
= NULL
, *resolved
= NULL
;
2419 case CREATE_SYMLINK
:
2423 r
= cunescape(i
->argument
, 0, &unescaped
);
2425 return log_error_errno(r
, "Failed to unescape parameter to write: %s", i
->argument
);
2427 r
= specifier_printf(unescaped
, specifier_table
, NULL
, &resolved
);
2431 free_and_replace(i
->argument
, resolved
);
2435 case RECURSIVE_SET_XATTR
:
2438 STRV_FOREACH (xattr
, i
->xattrs
) {
2439 r
= specifier_printf(*xattr
, specifier_table
, NULL
, &resolved
);
2443 free_and_replace(*xattr
, resolved
);
2453 static int patch_var_run(const char *fname
, unsigned line
, char **path
) {
2460 /* Optionally rewrites lines referencing /var/run/, to use /run/ instead. Why bother? tmpfiles merges lines in
2461 * some cases and detects conflicts in others. If files/directories are specified through two equivalent lines
2462 * this is problematic as neither case will be detected. Ideally we'd detect these cases by resolving symlinks
2463 * early, but that's precisely not what we can do here as this code very likely is running very early on, at a
2464 * time where the paths in question are not available yet, or even more importantly, our own tmpfiles rules
2465 * might create the paths that are intermediary to the listed paths. We can't really cover the generic case,
2466 * but the least we can do is cover the specific case of /var/run vs. /run, as /var/run is a legacy name for
2467 * /run only, and we explicitly document that and require that on systemd systems the former is a symlink to
2468 * the latter. Moreover files below this path are by far the primary usecase for tmpfiles.d/. */
2470 k
= path_startswith(*path
, "/var/run/");
2471 if (isempty(k
)) /* Don't complain about other paths than /var/run, and not about /var/run itself either. */
2474 n
= path_join("/run", k
);
2478 /* Also log about this briefly. We do so at LOG_NOTICE level, as we fixed up the situation automatically, hence
2479 * there's no immediate need for action by the user. However, in the interest of making things less confusing
2480 * to the user, let's still inform the user that these snippets should really be updated. */
2481 log_syntax(NULL
, LOG_NOTICE
, fname
, line
, 0, "Line references path below legacy directory /var/run/, updating %s → %s; please update the tmpfiles.d/ drop-in file accordingly.", *path
, n
);
2483 free_and_replace(*path
, n
);
2488 static int parse_line(const char *fname
, unsigned line
, const char *buffer
, bool *invalid_config
) {
2490 _cleanup_free_
char *action
= NULL
, *mode
= NULL
, *user
= NULL
, *group
= NULL
, *age
= NULL
, *path
= NULL
;
2491 _cleanup_(item_free_contents
) Item i
= {};
2492 ItemArray
*existing
;
2495 bool append_or_force
= false, boot
= false, allow_failure
= false;
2501 r
= extract_many_words(
2513 if (IN_SET(r
, -EINVAL
, -EBADSLT
))
2514 /* invalid quoting and such or an unknown specifier */
2515 *invalid_config
= true;
2516 return log_error_errno(r
, "[%s:%u] Failed to parse line: %m", fname
, line
);
2518 *invalid_config
= true;
2519 log_error("[%s:%u] Syntax error.", fname
, line
);
2523 if (!empty_or_dash(buffer
)) {
2524 i
.argument
= strdup(buffer
);
2529 if (isempty(action
)) {
2530 *invalid_config
= true;
2531 log_error("[%s:%u] Command too short '%s'.", fname
, line
, action
);
2535 for (pos
= 1; action
[pos
]; pos
++) {
2536 if (action
[pos
] == '!' && !boot
)
2538 else if (action
[pos
] == '+' && !append_or_force
)
2539 append_or_force
= true;
2540 else if (action
[pos
] == '-' && !allow_failure
)
2541 allow_failure
= true;
2543 *invalid_config
= true;
2544 log_error("[%s:%u] Unknown modifiers in command '%s'",
2545 fname
, line
, action
);
2550 if (boot
&& !arg_boot
) {
2551 log_debug("Ignoring entry %s \"%s\" because --boot is not specified.",
2557 i
.append_or_force
= append_or_force
;
2558 i
.allow_failure
= allow_failure
;
2560 r
= specifier_printf(path
, specifier_table
, NULL
, &i
.path
);
2562 return log_unresolvable_specifier(fname
, line
);
2564 if (IN_SET(r
, -EINVAL
, -EBADSLT
))
2565 *invalid_config
= true;
2566 return log_error_errno(r
, "[%s:%u] Failed to replace specifiers: %s", fname
, line
, path
);
2569 r
= patch_var_run(fname
, line
, &i
.path
);
2575 case CREATE_DIRECTORY
:
2576 case CREATE_SUBVOLUME
:
2577 case CREATE_SUBVOLUME_INHERIT_QUOTA
:
2578 case CREATE_SUBVOLUME_NEW_QUOTA
:
2579 case EMPTY_DIRECTORY
:
2580 case TRUNCATE_DIRECTORY
:
2583 case IGNORE_DIRECTORY_PATH
:
2585 case RECURSIVE_REMOVE_PATH
:
2588 case RECURSIVE_RELABEL_PATH
:
2590 log_warning("[%s:%u] %c lines don't take argument fields, ignoring.", fname
, line
, i
.type
);
2598 case CREATE_SYMLINK
:
2600 i
.argument
= path_join("/usr/share/factory", i
.path
);
2608 *invalid_config
= true;
2609 log_error("[%s:%u] Write file requires argument.", fname
, line
);
2616 i
.argument
= path_join(arg_root
, "/usr/share/factory", i
.path
);
2620 } else if (!path_is_absolute(i
.argument
)) {
2621 *invalid_config
= true;
2622 log_error("[%s:%u] Source path is not absolute.", fname
, line
);
2625 } else if (arg_root
) {
2628 p
= path_join(arg_root
, i
.argument
);
2631 free_and_replace(i
.argument
, p
);
2634 path_simplify(i
.argument
, false);
2637 case CREATE_CHAR_DEVICE
:
2638 case CREATE_BLOCK_DEVICE
:
2640 *invalid_config
= true;
2641 log_error("[%s:%u] Device file requires argument.", fname
, line
);
2645 r
= parse_dev(i
.argument
, &i
.major_minor
);
2647 *invalid_config
= true;
2648 log_error_errno(r
, "[%s:%u] Can't parse device file major/minor '%s'.", fname
, line
, i
.argument
);
2655 case RECURSIVE_SET_XATTR
:
2657 *invalid_config
= true;
2658 log_error("[%s:%u] Set extended attribute requires argument.", fname
, line
);
2661 r
= parse_xattrs_from_arg(&i
);
2667 case RECURSIVE_SET_ACL
:
2669 *invalid_config
= true;
2670 log_error("[%s:%u] Set ACLs requires argument.", fname
, line
);
2673 r
= parse_acls_from_arg(&i
);
2679 case RECURSIVE_SET_ATTRIBUTE
:
2681 *invalid_config
= true;
2682 log_error("[%s:%u] Set file attribute requires argument.", fname
, line
);
2685 r
= parse_attribute_from_arg(&i
);
2686 if (IN_SET(r
, -EINVAL
, -EBADSLT
))
2687 *invalid_config
= true;
2693 log_error("[%s:%u] Unknown command type '%c'.", fname
, line
, (char) i
.type
);
2694 *invalid_config
= true;
2698 if (!path_is_absolute(i
.path
)) {
2699 log_error("[%s:%u] Path '%s' not absolute.", fname
, line
, i
.path
);
2700 *invalid_config
= true;
2704 path_simplify(i
.path
, false);
2706 if (!should_include_path(i
.path
))
2709 r
= specifier_expansion_from_arg(&i
);
2711 return log_unresolvable_specifier(fname
, line
);
2713 if (IN_SET(r
, -EINVAL
, -EBADSLT
))
2714 *invalid_config
= true;
2715 return log_error_errno(r
, "[%s:%u] Failed to substitute specifiers in argument: %m",
2722 p
= path_join(arg_root
, i
.path
);
2725 free_and_replace(i
.path
, p
);
2728 if (!empty_or_dash(user
)) {
2729 const char *u
= user
;
2731 r
= get_user_creds(&u
, &i
.uid
, NULL
, NULL
, NULL
, USER_CREDS_ALLOW_MISSING
);
2733 *invalid_config
= true;
2734 return log_error_errno(r
, "[%s:%u] Unknown user '%s'.", fname
, line
, user
);
2740 if (!empty_or_dash(group
)) {
2741 const char *g
= group
;
2743 r
= get_group_creds(&g
, &i
.gid
, USER_CREDS_ALLOW_MISSING
);
2745 *invalid_config
= true;
2746 log_error("[%s:%u] Unknown group '%s'.", fname
, line
, group
);
2753 if (!empty_or_dash(mode
)) {
2754 const char *mm
= mode
;
2758 i
.mask_perms
= true;
2762 if (parse_mode(mm
, &m
) < 0) {
2763 *invalid_config
= true;
2764 log_error("[%s:%u] Invalid mode '%s'.", fname
, line
, mode
);
2771 i
.mode
= IN_SET(i
.type
, CREATE_DIRECTORY
, TRUNCATE_DIRECTORY
, CREATE_SUBVOLUME
, CREATE_SUBVOLUME_INHERIT_QUOTA
, CREATE_SUBVOLUME_NEW_QUOTA
) ? 0755 : 0644;
2773 if (!empty_or_dash(age
)) {
2774 const char *a
= age
;
2777 i
.keep_first_level
= true;
2781 if (parse_sec(a
, &i
.age
) < 0) {
2782 *invalid_config
= true;
2783 log_error("[%s:%u] Invalid age '%s'.", fname
, line
, age
);
2790 h
= needs_glob(i
.type
) ? globs
: items
;
2792 existing
= ordered_hashmap_get(h
, i
.path
);
2796 for (n
= 0; n
< existing
->n_items
; n
++) {
2797 if (!item_compatible(existing
->items
+ n
, &i
) && !i
.append_or_force
) {
2798 log_notice("[%s:%u] Duplicate line for path \"%s\", ignoring.",
2799 fname
, line
, i
.path
);
2804 existing
= new0(ItemArray
, 1);
2808 r
= ordered_hashmap_put(h
, i
.path
, existing
);
2815 if (!GREEDY_REALLOC(existing
->items
, existing
->allocated
, existing
->n_items
+ 1))
2818 existing
->items
[existing
->n_items
++] = i
;
2819 i
= (struct Item
) {};
2821 /* Sort item array, to enforce stable ordering of application */
2822 typesafe_qsort(existing
->items
, existing
->n_items
, item_compare
);
2827 static int cat_config(char **config_dirs
, char **args
) {
2828 _cleanup_strv_free_
char **files
= NULL
;
2831 r
= conf_files_list_with_replacement(arg_root
, config_dirs
, arg_replace
, &files
, NULL
);
2835 return cat_files(NULL
, files
, 0);
2838 static int help(void) {
2839 _cleanup_free_
char *link
= NULL
;
2842 r
= terminal_urlify_man("systemd-tmpfiles", "8", &link
);
2846 printf("%s [OPTIONS...] [CONFIGURATION FILE...]\n\n"
2847 "Creates, deletes and cleans up volatile and temporary files and directories.\n\n"
2848 " -h --help Show this help\n"
2849 " --user Execute user configuration\n"
2850 " --version Show package version\n"
2851 " --cat-config Show configuration files\n"
2852 " --create Create marked files/directories\n"
2853 " --clean Clean up marked directories\n"
2854 " --remove Remove marked files/directories\n"
2855 " --boot Execute actions only safe at boot\n"
2856 " --prefix=PATH Only apply rules with the specified prefix\n"
2857 " --exclude-prefix=PATH Ignore rules with the specified prefix\n"
2858 " --root=PATH Operate on an alternate filesystem root\n"
2859 " --replace=PATH Treat arguments as replacement for PATH\n"
2860 " --no-pager Do not pipe output into a pager\n"
2861 "\nSee the %s for details.\n"
2862 , program_invocation_short_name
2869 static int parse_argv(int argc
, char *argv
[]) {
2872 ARG_VERSION
= 0x100,
2886 static const struct option options
[] = {
2887 { "help", no_argument
, NULL
, 'h' },
2888 { "user", no_argument
, NULL
, ARG_USER
},
2889 { "version", no_argument
, NULL
, ARG_VERSION
},
2890 { "cat-config", no_argument
, NULL
, ARG_CAT_CONFIG
},
2891 { "create", no_argument
, NULL
, ARG_CREATE
},
2892 { "clean", no_argument
, NULL
, ARG_CLEAN
},
2893 { "remove", no_argument
, NULL
, ARG_REMOVE
},
2894 { "boot", no_argument
, NULL
, ARG_BOOT
},
2895 { "prefix", required_argument
, NULL
, ARG_PREFIX
},
2896 { "exclude-prefix", required_argument
, NULL
, ARG_EXCLUDE_PREFIX
},
2897 { "root", required_argument
, NULL
, ARG_ROOT
},
2898 { "replace", required_argument
, NULL
, ARG_REPLACE
},
2899 { "no-pager", no_argument
, NULL
, ARG_NO_PAGER
},
2908 while ((c
= getopt_long(argc
, argv
, "h", options
, NULL
)) >= 0)
2918 case ARG_CAT_CONFIG
:
2919 arg_cat_config
= true;
2927 arg_operation
|= OPERATION_CREATE
;
2931 arg_operation
|= OPERATION_CLEAN
;
2935 arg_operation
|= OPERATION_REMOVE
;
2943 if (strv_push(&arg_include_prefixes
, optarg
) < 0)
2947 case ARG_EXCLUDE_PREFIX
:
2948 if (strv_push(&arg_exclude_prefixes
, optarg
) < 0)
2953 r
= parse_path_argument_and_warn(optarg
, true, &arg_root
);
2959 if (!path_is_absolute(optarg
) ||
2960 !endswith(optarg
, ".conf"))
2961 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
2962 "The argument to --replace= must an absolute path to a config file");
2964 arg_replace
= optarg
;
2968 arg_pager_flags
|= PAGER_DISABLE
;
2975 assert_not_reached("Unhandled option");
2978 if (arg_operation
== 0 && !arg_cat_config
)
2979 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
2980 "You need to specify at least one of --clean, --create or --remove.");
2982 if (arg_replace
&& arg_cat_config
)
2983 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
2984 "Option --replace= is not supported with --cat-config");
2986 if (arg_replace
&& optind
>= argc
)
2987 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
2988 "When --replace= is given, some configuration items must be specified");
2993 static int read_config_file(char **config_dirs
, const char *fn
, bool ignore_enoent
, bool *invalid_config
) {
2994 _cleanup_fclose_
FILE *_f
= NULL
;
3003 if (streq(fn
, "-")) {
3004 log_debug("Reading config from stdin…");
3008 r
= search_and_fopen(fn
, "re", arg_root
, (const char**) config_dirs
, &_f
);
3010 if (ignore_enoent
&& r
== -ENOENT
) {
3011 log_debug_errno(r
, "Failed to open \"%s\", ignoring: %m", fn
);
3015 return log_error_errno(r
, "Failed to open '%s': %m", fn
);
3017 log_debug("Reading config file \"%s\"…", fn
);
3022 _cleanup_free_
char *line
= NULL
;
3023 bool invalid_line
= false;
3027 k
= read_line(f
, LONG_LINE_MAX
, &line
);
3029 return log_error_errno(k
, "Failed to read '%s': %m", fn
);
3036 if (IN_SET(*l
, 0, '#'))
3039 k
= parse_line(fn
, v
, l
, &invalid_line
);
3042 /* Allow reporting with a special code if the caller requested this */
3043 *invalid_config
= true;
3045 /* The first error becomes our return value */
3050 /* we have to determine age parameter for each entry of type X */
3051 ORDERED_HASHMAP_FOREACH(i
, globs
, iterator
) {
3053 Item
*j
, *candidate_item
= NULL
;
3055 if (i
->type
!= IGNORE_DIRECTORY_PATH
)
3058 ORDERED_HASHMAP_FOREACH(j
, items
, iter
) {
3059 if (!IN_SET(j
->type
, CREATE_DIRECTORY
, TRUNCATE_DIRECTORY
, CREATE_SUBVOLUME
, CREATE_SUBVOLUME_INHERIT_QUOTA
, CREATE_SUBVOLUME_NEW_QUOTA
))
3062 if (path_equal(j
->path
, i
->path
)) {
3067 if ((!candidate_item
&& path_startswith(i
->path
, j
->path
)) ||
3068 (candidate_item
&& path_startswith(j
->path
, candidate_item
->path
) && (fnmatch(i
->path
, j
->path
, FNM_PATHNAME
| FNM_PERIOD
) == 0)))
3072 if (candidate_item
&& candidate_item
->age_set
) {
3073 i
->age
= candidate_item
->age
;
3079 log_error_errno(errno
, "Failed to read from file %s: %m", fn
);
3087 static int parse_arguments(char **config_dirs
, char **args
, bool *invalid_config
) {
3091 STRV_FOREACH(arg
, args
) {
3092 r
= read_config_file(config_dirs
, *arg
, false, invalid_config
);
3100 static int read_config_files(char **config_dirs
, char **args
, bool *invalid_config
) {
3101 _cleanup_strv_free_
char **files
= NULL
;
3102 _cleanup_free_
char *p
= NULL
;
3106 r
= conf_files_list_with_replacement(arg_root
, config_dirs
, arg_replace
, &files
, &p
);
3110 STRV_FOREACH(f
, files
)
3111 if (p
&& path_equal(*f
, p
)) {
3112 log_debug("Parsing arguments at position \"%s\"…", *f
);
3114 r
= parse_arguments(config_dirs
, args
, invalid_config
);
3118 /* Just warn, ignore result otherwise.
3119 * read_config_file() has some debug output, so no need to print anything. */
3120 (void) read_config_file(config_dirs
, *f
, true, invalid_config
);
3125 static int link_parent(ItemArray
*a
) {
3132 /* Finds the closest "parent" item array for the specified item array. Then registers the specified item array
3133 * as child of it, and fills the parent in, linking them both ways. This allows us to later create parents
3134 * before their children, and clean up/remove children before their parents. */
3136 if (a
->n_items
<= 0)
3139 path
= a
->items
[0].path
;
3140 prefix
= newa(char, strlen(path
) + 1);
3141 PATH_FOREACH_PREFIX(prefix
, path
) {
3144 j
= ordered_hashmap_get(items
, prefix
);
3146 j
= ordered_hashmap_get(globs
, prefix
);
3148 r
= set_ensure_allocated(&j
->children
, NULL
);
3152 r
= set_put(j
->children
, a
);
3164 DEFINE_PRIVATE_HASH_OPS_WITH_VALUE_DESTRUCTOR(item_array_hash_ops
, char, string_hash_func
, string_compare_func
,
3165 ItemArray
, item_array_free
);
3167 static int run(int argc
, char *argv
[]) {
3168 _cleanup_strv_free_
char **config_dirs
= NULL
;
3169 bool invalid_config
= false;
3173 PHASE_REMOVE_AND_CLEAN
,
3179 r
= parse_argv(argc
, argv
);
3183 log_setup_service();
3185 /* Descending down file system trees might take a lot of fds */
3186 (void) rlimit_nofile_bump(HIGH_RLIMIT_NOFILE
);
3189 r
= user_config_paths(&config_dirs
);
3191 return log_error_errno(r
, "Failed to initialize configuration directory list: %m");
3193 config_dirs
= strv_split_nulstr(CONF_PATHS_NULSTR("tmpfiles.d"));
3198 if (DEBUG_LOGGING
) {
3199 _cleanup_free_
char *t
= NULL
;
3201 t
= strv_join(config_dirs
, "\n\t");
3203 log_debug("Looking for configuration files in (higher priority first):\n\t%s", t
);
3206 if (arg_cat_config
) {
3207 (void) pager_open(arg_pager_flags
);
3209 return cat_config(config_dirs
, argv
+ optind
);
3216 items
= ordered_hashmap_new(&item_array_hash_ops
);
3217 globs
= ordered_hashmap_new(&item_array_hash_ops
);
3218 if (!items
|| !globs
)
3221 /* If command line arguments are specified along with --replace, read all
3222 * configuration files and insert the positional arguments at the specified
3223 * place. Otherwise, if command line arguments are specified, execute just
3224 * them, and finally, without --replace= or any positional arguments, just
3225 * read configuration and execute it.
3227 if (arg_replace
|| optind
>= argc
)
3228 r
= read_config_files(config_dirs
, argv
+ optind
, &invalid_config
);
3230 r
= parse_arguments(config_dirs
, argv
+ optind
, &invalid_config
);
3234 /* Let's now link up all child/parent relationships */
3235 ORDERED_HASHMAP_FOREACH(a
, items
, iterator
) {
3240 ORDERED_HASHMAP_FOREACH(a
, globs
, iterator
) {
3246 /* If multiple operations are requested, let's first run the remove/clean operations, and only then the create
3247 * operations. i.e. that we first clean out the platform we then build on. */
3248 for (phase
= 0; phase
< _PHASE_MAX
; phase
++) {
3251 if (phase
== PHASE_REMOVE_AND_CLEAN
)
3252 op
= arg_operation
& (OPERATION_REMOVE
|OPERATION_CLEAN
);
3253 else if (phase
== PHASE_CREATE
)
3254 op
= arg_operation
& OPERATION_CREATE
;
3256 assert_not_reached("unexpected phase");
3258 if (op
== 0) /* Nothing requested in this phase */
3261 /* The non-globbing ones usually create things, hence we apply them first */
3262 ORDERED_HASHMAP_FOREACH(a
, items
, iterator
) {
3263 k
= process_item_array(a
, op
);
3264 if (k
< 0 && r
>= 0)
3268 /* The globbing ones usually alter things, hence we apply them second. */
3269 ORDERED_HASHMAP_FOREACH(a
, globs
, iterator
) {
3270 k
= process_item_array(a
, op
);
3271 if (k
< 0 && r
>= 0)
3276 if (ERRNO_IS_RESOURCE(-r
))
3281 return EX_CANTCREAT
;
3285 DEFINE_MAIN_FUNCTION_WITH_POSITIVE_FAILURE(run
);