1 /* SPDX-License-Identifier: LGPL-2.1+ */
13 #include <sys/xattr.h>
21 #include "alloc-util.h"
22 #include "btrfs-util.h"
23 #include "capability-util.h"
24 #include "chattr-util.h"
25 #include "conf-files.h"
28 #include "dirent-util.h"
32 #include "format-util.h"
34 #include "glob-util.h"
39 #include "main-func.h"
41 #include "mountpoint-util.h"
43 #include "parse-util.h"
44 #include "path-lookup.h"
45 #include "path-util.h"
46 #include "pretty-print.h"
47 #include "rlimit-util.h"
49 #include "selinux-util.h"
51 #include "sort-util.h"
52 #include "specifier.h"
53 #include "stat-util.h"
54 #include "stdio-util.h"
55 #include "string-table.h"
56 #include "string-util.h"
58 #include "umask-util.h"
59 #include "user-util.h"
61 /* This reads all files listed in /etc/tmpfiles.d/?*.conf and creates
62 * them in the file system. This is intended to be used to create
63 * properly owned directories beneath /tmp, /var/tmp, /run, which are
64 * volatile and hence need to be recreated on bootup. */
66 typedef enum OperationMask
{
67 OPERATION_CREATE
= 1 << 0,
68 OPERATION_REMOVE
= 1 << 1,
69 OPERATION_CLEAN
= 1 << 2,
72 typedef enum ItemType
{
73 /* These ones take file names */
76 CREATE_DIRECTORY
= 'd',
77 TRUNCATE_DIRECTORY
= 'D',
78 CREATE_SUBVOLUME
= 'v',
79 CREATE_SUBVOLUME_INHERIT_QUOTA
= 'q',
80 CREATE_SUBVOLUME_NEW_QUOTA
= 'Q',
83 CREATE_CHAR_DEVICE
= 'c',
84 CREATE_BLOCK_DEVICE
= 'b',
87 /* These ones take globs */
89 EMPTY_DIRECTORY
= 'e',
91 RECURSIVE_SET_XATTR
= 'T',
93 RECURSIVE_SET_ACL
= 'A',
95 RECURSIVE_SET_ATTRIBUTE
= 'H',
97 IGNORE_DIRECTORY_PATH
= 'X',
99 RECURSIVE_REMOVE_PATH
= 'R',
101 RECURSIVE_RELABEL_PATH
= 'Z',
102 ADJUST_MODE
= 'm', /* legacy, 'z' is identical to this */
105 typedef struct Item
{
121 unsigned attribute_value
;
122 unsigned attribute_mask
;
129 bool attribute_set
:1;
131 bool keep_first_level
:1;
133 bool append_or_force
:1;
135 bool allow_failure
:1;
140 typedef struct ItemArray
{
145 struct ItemArray
*parent
;
149 typedef enum DirectoryType
{
157 static bool arg_cat_config
= false;
158 static bool arg_user
= false;
159 static OperationMask arg_operation
= 0;
160 static bool arg_boot
= false;
161 static PagerFlags arg_pager_flags
= 0;
163 static char **arg_include_prefixes
= NULL
;
164 static char **arg_exclude_prefixes
= NULL
;
165 static char *arg_root
= NULL
;
166 static char *arg_replace
= NULL
;
168 #define MAX_DEPTH 256
170 static OrderedHashmap
*items
= NULL
, *globs
= NULL
;
171 static Set
*unix_sockets
= NULL
;
173 STATIC_DESTRUCTOR_REGISTER(items
, ordered_hashmap_freep
);
174 STATIC_DESTRUCTOR_REGISTER(globs
, ordered_hashmap_freep
);
175 STATIC_DESTRUCTOR_REGISTER(unix_sockets
, set_free_freep
);
176 STATIC_DESTRUCTOR_REGISTER(arg_include_prefixes
, freep
);
177 STATIC_DESTRUCTOR_REGISTER(arg_exclude_prefixes
, freep
);
178 STATIC_DESTRUCTOR_REGISTER(arg_root
, freep
);
180 static int specifier_machine_id_safe(char specifier
, const void *data
, const void *userdata
, char **ret
);
181 static int specifier_directory(char specifier
, const void *data
, const void *userdata
, char **ret
);
183 static const Specifier specifier_table
[] = {
184 { 'm', specifier_machine_id_safe
, NULL
},
185 { 'b', specifier_boot_id
, NULL
},
186 { 'H', specifier_host_name
, NULL
},
187 { 'v', specifier_kernel_release
, NULL
},
189 { 'g', specifier_group_name
, NULL
},
190 { 'G', specifier_group_id
, NULL
},
191 { 'U', specifier_user_id
, NULL
},
192 { 'u', specifier_user_name
, NULL
},
193 { 'h', specifier_user_home
, NULL
},
195 { 't', specifier_directory
, UINT_TO_PTR(DIRECTORY_RUNTIME
) },
196 { 'S', specifier_directory
, UINT_TO_PTR(DIRECTORY_STATE
) },
197 { 'C', specifier_directory
, UINT_TO_PTR(DIRECTORY_CACHE
) },
198 { 'L', specifier_directory
, UINT_TO_PTR(DIRECTORY_LOGS
) },
199 { 'T', specifier_tmp_dir
, NULL
},
200 { 'V', specifier_var_tmp_dir
, NULL
},
204 static int specifier_machine_id_safe(char specifier
, const void *data
, const void *userdata
, char **ret
) {
207 /* If /etc/machine_id is missing or empty (e.g. in a chroot environment)
208 * return a recognizable error so that the caller can skip the rule
211 r
= specifier_machine_id(specifier
, data
, userdata
, ret
);
212 if (IN_SET(r
, -ENOENT
, -ENOMEDIUM
))
218 static int specifier_directory(char specifier
, const void *data
, const void *userdata
, char **ret
) {
224 static const struct table_entry paths_system
[] = {
225 [DIRECTORY_RUNTIME
] = { SD_PATH_SYSTEM_RUNTIME
},
226 [DIRECTORY_STATE
] = { SD_PATH_SYSTEM_STATE_PRIVATE
},
227 [DIRECTORY_CACHE
] = { SD_PATH_SYSTEM_STATE_CACHE
},
228 [DIRECTORY_LOGS
] = { SD_PATH_SYSTEM_STATE_LOGS
},
231 static const struct table_entry paths_user
[] = {
232 [DIRECTORY_RUNTIME
] = { SD_PATH_USER_RUNTIME
},
233 [DIRECTORY_STATE
] = { SD_PATH_USER_CONFIGURATION
},
234 [DIRECTORY_CACHE
] = { SD_PATH_USER_STATE_CACHE
},
235 [DIRECTORY_LOGS
] = { SD_PATH_USER_CONFIGURATION
, "log" },
239 const struct table_entry
*paths
;
241 assert_cc(ELEMENTSOF(paths_system
) == ELEMENTSOF(paths_user
));
242 paths
= arg_user
? paths_user
: paths_system
;
244 i
= PTR_TO_UINT(data
);
245 assert(i
< ELEMENTSOF(paths_system
));
247 return sd_path_home(paths
[i
].type
, paths
[i
].suffix
, ret
);
250 static int log_unresolvable_specifier(const char *filename
, unsigned line
) {
251 static bool notified
= false;
253 /* In system mode, this is called when /etc is not fully initialized (e.g.
254 * in a chroot environment) where some specifiers are unresolvable. In user
255 * mode, this is called when some variables are not defined. These cases are
256 * not considered as an error so log at LOG_NOTICE only for the first time
257 * and then downgrade this to LOG_DEBUG for the rest. */
259 log_full(notified
? LOG_DEBUG
: LOG_NOTICE
,
260 "[%s:%u] Failed to resolve specifier: %s, skipping",
262 arg_user
? "Required $XDG_... variable not defined" : "uninitialized /etc detected");
265 log_notice("All rules containing unresolvable specifiers will be skipped.");
271 static int user_config_paths(char*** ret
) {
272 _cleanup_strv_free_
char **config_dirs
= NULL
, **data_dirs
= NULL
;
273 _cleanup_free_
char *persistent_config
= NULL
, *runtime_config
= NULL
, *data_home
= NULL
;
274 _cleanup_strv_free_
char **res
= NULL
;
277 r
= xdg_user_dirs(&config_dirs
, &data_dirs
);
281 r
= xdg_user_config_dir(&persistent_config
, "/user-tmpfiles.d");
282 if (r
< 0 && r
!= -ENXIO
)
285 r
= xdg_user_runtime_dir(&runtime_config
, "/user-tmpfiles.d");
286 if (r
< 0 && r
!= -ENXIO
)
289 r
= xdg_user_data_dir(&data_home
, "/user-tmpfiles.d");
290 if (r
< 0 && r
!= -ENXIO
)
293 r
= strv_extend_strv_concat(&res
, config_dirs
, "/user-tmpfiles.d");
297 r
= strv_extend(&res
, persistent_config
);
301 r
= strv_extend(&res
, runtime_config
);
305 r
= strv_extend(&res
, data_home
);
309 r
= strv_extend_strv_concat(&res
, data_dirs
, "/user-tmpfiles.d");
313 r
= path_strv_make_absolute_cwd(res
);
317 *ret
= TAKE_PTR(res
);
321 static bool needs_glob(ItemType t
) {
325 IGNORE_DIRECTORY_PATH
,
327 RECURSIVE_REMOVE_PATH
,
331 RECURSIVE_RELABEL_PATH
,
337 RECURSIVE_SET_ATTRIBUTE
);
340 static bool takes_ownership(ItemType t
) {
348 CREATE_SUBVOLUME_INHERIT_QUOTA
,
349 CREATE_SUBVOLUME_NEW_QUOTA
,
357 IGNORE_DIRECTORY_PATH
,
359 RECURSIVE_REMOVE_PATH
);
362 static struct Item
* find_glob(OrderedHashmap
*h
, const char *match
) {
366 ORDERED_HASHMAP_FOREACH(j
, h
, i
) {
369 for (n
= 0; n
< j
->n_items
; n
++) {
370 Item
*item
= j
->items
+ n
;
372 if (fnmatch(item
->path
, match
, FNM_PATHNAME
|FNM_PERIOD
) == 0)
380 static int load_unix_sockets(void) {
381 _cleanup_set_free_free_ Set
*sockets
= NULL
;
382 _cleanup_fclose_
FILE *f
= NULL
;
388 /* We maintain a cache of the sockets we found in /proc/net/unix to speed things up a little. */
390 sockets
= set_new(&path_hash_ops
);
394 f
= fopen("/proc/net/unix", "re");
396 return log_full_errno(errno
== ENOENT
? LOG_DEBUG
: LOG_WARNING
, errno
,
397 "Failed to open /proc/net/unix, ignoring: %m");
400 r
= read_line(f
, LONG_LINE_MAX
, NULL
);
402 return log_warning_errno(r
, "Failed to skip /proc/net/unix header line: %m");
404 return log_warning_errno(SYNTHETIC_ERRNO(EIO
), "Premature end of file reading /proc/net/unix.");
407 _cleanup_free_
char *line
= NULL
, *s
= NULL
;
410 r
= read_line(f
, LONG_LINE_MAX
, &line
);
412 return log_warning_errno(r
, "Failed to read /proc/net/unix line, ignoring: %m");
413 if (r
== 0) /* EOF */
416 p
= strchr(line
, ':');
424 p
+= strspn(p
, WHITESPACE
);
425 p
+= strcspn(p
, WHITESPACE
); /* skip one more word */
426 p
+= strspn(p
, WHITESPACE
);
435 path_simplify(s
, false);
437 r
= set_consume(sockets
, s
);
441 return log_warning_errno(r
, "Failed to add AF_UNIX socket to set, ignoring: %m");
446 unix_sockets
= TAKE_PTR(sockets
);
450 static bool unix_socket_alive(const char *fn
) {
453 if (load_unix_sockets() < 0)
454 return true; /* We don't know, so assume yes */
456 return !!set_get(unix_sockets
, (char*) fn
);
459 static DIR* xopendirat_nomod(int dirfd
, const char *path
) {
462 dir
= xopendirat(dirfd
, path
, O_NOFOLLOW
|O_NOATIME
);
466 log_debug_errno(errno
, "Cannot open %sdirectory \"%s\": %m", dirfd
== AT_FDCWD
? "" : "sub", path
);
470 dir
= xopendirat(dirfd
, path
, O_NOFOLLOW
);
472 log_debug_errno(errno
, "Cannot open %sdirectory \"%s\": %m", dirfd
== AT_FDCWD
? "" : "sub", path
);
477 static DIR* opendir_nomod(const char *path
) {
478 return xopendirat_nomod(AT_FDCWD
, path
);
481 static int dir_cleanup(
485 const struct stat
*ds
,
490 bool keep_this_level
) {
493 bool deleted
= false;
496 FOREACH_DIRENT_ALL(dent
, d
, break) {
499 _cleanup_free_
char *sub_path
= NULL
;
501 if (dot_or_dot_dot(dent
->d_name
))
504 if (fstatat(dirfd(d
), dent
->d_name
, &s
, AT_SYMLINK_NOFOLLOW
) < 0) {
508 /* FUSE, NFS mounts, SELinux might return EACCES */
509 r
= log_full_errno(errno
== EACCES
? LOG_DEBUG
: LOG_ERR
, errno
,
510 "stat(%s/%s) failed: %m", p
, dent
->d_name
);
514 /* Stay on the same filesystem */
515 if (s
.st_dev
!= rootdev
) {
516 log_debug("Ignoring \"%s/%s\": different filesystem.", p
, dent
->d_name
);
520 /* Try to detect bind mounts of the same filesystem instance; they
521 * do not differ in device major/minors. This type of query is not
522 * supported on all kernels or filesystem types though. */
523 if (S_ISDIR(s
.st_mode
)) {
526 q
= fd_is_mount_point(dirfd(d
), dent
->d_name
, 0);
528 log_debug_errno(q
, "Failed to determine whether \"%s/%s\" is a mount point, ignoring: %m", p
, dent
->d_name
);
530 log_debug("Ignoring \"%s/%s\": different mount of the same filesystem.", p
, dent
->d_name
);
535 sub_path
= path_join(p
, dent
->d_name
);
541 /* Is there an item configured for this path? */
542 if (ordered_hashmap_get(items
, sub_path
)) {
543 log_debug("Ignoring \"%s\": a separate entry exists.", sub_path
);
547 if (find_glob(globs
, sub_path
)) {
548 log_debug("Ignoring \"%s\": a separate glob exists.", sub_path
);
552 if (S_ISDIR(s
.st_mode
)) {
553 _cleanup_closedir_
DIR *sub_dir
= NULL
;
556 streq(dent
->d_name
, "lost+found") &&
558 log_debug("Ignoring directory \"%s\".", sub_path
);
563 log_warning("Reached max depth on \"%s\".", sub_path
);
567 sub_dir
= xopendirat_nomod(dirfd(d
), dent
->d_name
);
570 r
= log_warning_errno(errno
, "Opening directory \"%s\" failed, ignoring: %m", sub_path
);
575 if (flock(dirfd(sub_dir
), LOCK_EX
|LOCK_NB
) < 0) {
576 log_debug_errno(errno
, "Couldn't acquire shared BSD lock on directory \"%s\", skipping: %m", p
);
580 q
= dir_cleanup(i
, sub_path
, sub_dir
, &s
, cutoff
, rootdev
, false, maxdepth
-1, false);
585 /* Note: if you are wondering why we don't support the sticky bit for excluding
586 * directories from cleaning like we do it for other file system objects: well, the
587 * sticky bit already has a meaning for directories, so we don't want to overload
590 if (keep_this_level
) {
591 log_debug("Keeping directory \"%s\".", sub_path
);
595 /* Ignore ctime, we change it when deleting */
596 age
= timespec_load(&s
.st_mtim
);
598 char a
[FORMAT_TIMESTAMP_MAX
];
599 /* Follows spelling in stat(1). */
600 log_debug("Directory \"%s\": modify time %s is too new.",
602 format_timestamp_us(a
, sizeof(a
), age
));
606 age
= timespec_load(&s
.st_atim
);
608 char a
[FORMAT_TIMESTAMP_MAX
];
609 log_debug("Directory \"%s\": access time %s is too new.",
611 format_timestamp_us(a
, sizeof(a
), age
));
615 log_debug("Removing directory \"%s\".", sub_path
);
616 if (unlinkat(dirfd(d
), dent
->d_name
, AT_REMOVEDIR
) < 0)
617 if (!IN_SET(errno
, ENOENT
, ENOTEMPTY
))
618 r
= log_warning_errno(errno
, "Failed to remove directory \"%s\", ignoring: %m", sub_path
);
621 /* Skip files for which the sticky bit is set. These are semantics we define, and are
622 * unknown elsewhere. See XDG_RUNTIME_DIR specification for details. */
623 if (s
.st_mode
& S_ISVTX
) {
624 log_debug("Skipping \"%s\": sticky bit set.", sub_path
);
629 S_ISREG(s
.st_mode
) &&
631 STR_IN_SET(dent
->d_name
,
635 log_debug("Skipping \"%s\".", sub_path
);
639 /* Ignore sockets that are listed in /proc/net/unix */
640 if (S_ISSOCK(s
.st_mode
) && unix_socket_alive(sub_path
)) {
641 log_debug("Skipping \"%s\": live socket.", sub_path
);
645 /* Ignore device nodes */
646 if (S_ISCHR(s
.st_mode
) || S_ISBLK(s
.st_mode
)) {
647 log_debug("Skipping \"%s\": a device.", sub_path
);
651 /* Keep files on this level around if this is requested */
652 if (keep_this_level
) {
653 log_debug("Keeping \"%s\".", sub_path
);
657 age
= timespec_load(&s
.st_mtim
);
659 char a
[FORMAT_TIMESTAMP_MAX
];
660 /* Follows spelling in stat(1). */
661 log_debug("File \"%s\": modify time %s is too new.",
663 format_timestamp_us(a
, sizeof(a
), age
));
667 age
= timespec_load(&s
.st_atim
);
669 char a
[FORMAT_TIMESTAMP_MAX
];
670 log_debug("File \"%s\": access time %s is too new.",
672 format_timestamp_us(a
, sizeof(a
), age
));
676 age
= timespec_load(&s
.st_ctim
);
678 char a
[FORMAT_TIMESTAMP_MAX
];
679 log_debug("File \"%s\": change time %s is too new.",
681 format_timestamp_us(a
, sizeof(a
), age
));
685 log_debug("Removing \"%s\".", sub_path
);
686 if (unlinkat(dirfd(d
), dent
->d_name
, 0) < 0)
688 r
= log_warning_errno(errno
, "Failed to remove \"%s\", ignoring: %m", sub_path
);
696 char a
[FORMAT_TIMESTAMP_MAX
], b
[FORMAT_TIMESTAMP_MAX
];
699 age1
= timespec_load(&ds
->st_atim
);
700 age2
= timespec_load(&ds
->st_mtim
);
702 log_debug("Restoring access and modification time on \"%s\": %s, %s",
704 format_timestamp_us(a
, sizeof(a
), age1
),
705 format_timestamp_us(b
, sizeof(b
), age2
));
707 /* Restore original directory timestamps */
708 if (futimens(dirfd(d
), (struct timespec
[]) {
711 log_warning_errno(errno
, "Failed to revert timestamps of '%s', ignoring: %m", p
);
717 static bool dangerous_hardlinks(void) {
718 _cleanup_free_
char *value
= NULL
;
719 static int cached
= -1;
722 /* Check whether the fs.protected_hardlinks sysctl is on. If we can't determine it we assume its off, as that's
723 * what the upstream default is. */
728 r
= read_one_line_file("/proc/sys/fs/protected_hardlinks", &value
);
730 log_debug_errno(r
, "Failed to read fs.protected_hardlinks sysctl: %m");
734 r
= parse_boolean(value
);
736 log_debug_errno(r
, "Failed to parse fs.protected_hardlinks sysctl: %m");
744 static bool hardlink_vulnerable(const struct stat
*st
) {
747 return !S_ISDIR(st
->st_mode
) && st
->st_nlink
> 1 && dangerous_hardlinks();
750 static mode_t
process_mask_perms(mode_t mode
, mode_t current
) {
752 if ((current
& 0111) == 0)
754 if ((current
& 0222) == 0)
756 if ((current
& 0444) == 0)
758 if (!S_ISDIR(current
))
759 mode
&= ~07000; /* remove sticky/sgid/suid bit, unless directory */
764 static int fd_set_perms(Item
*i
, int fd
, const char *path
, const struct stat
*st
) {
773 if (!i
->mode_set
&& !i
->uid_set
&& !i
->gid_set
)
777 if (fstat(fd
, &stbuf
) < 0)
778 return log_error_errno(errno
, "fstat(%s) failed: %m", path
);
782 if (hardlink_vulnerable(st
))
783 return log_error_errno(SYNTHETIC_ERRNO(EPERM
),
784 "Refusing to set permissions on hardlinked file %s while the fs.protected_hardlinks sysctl is turned off.",
787 /* Do we need a chown()? */
789 (i
->uid_set
&& i
->uid
!= st
->st_uid
) ||
790 (i
->gid_set
&& i
->gid
!= st
->st_gid
);
792 /* Calculate the mode to apply */
793 new_mode
= i
->mode_set
? (i
->mask_perms
?
794 process_mask_perms(i
->mode
, st
->st_mode
) :
796 (st
->st_mode
& 07777);
798 if (i
->mode_set
&& do_chown
) {
799 /* Before we issue the chmod() let's reduce the access mode to the common bits of the old and
800 * the new mode. That way there's no time window where the file exists under the old owner
801 * with more than the old access modes — and not under the new owner with more than the new
802 * access modes either. */
804 if (S_ISLNK(st
->st_mode
))
805 log_debug("Skipping temporary mode fix for symlink %s.", path
);
807 mode_t m
= new_mode
& st
->st_mode
; /* Mask new mode by old mode */
809 if (((m
^ st
->st_mode
) & 07777) == 0)
810 log_debug("\"%s\" matches temporary mode %o already.", path
, m
);
812 log_debug("Temporarily changing \"%s\" to mode %o.", path
, m
);
813 if (fchmod_opath(fd
, m
) < 0)
814 return log_error_errno(errno
, "fchmod() of %s failed: %m", path
);
820 log_debug("Changing \"%s\" to owner "UID_FMT
":"GID_FMT
,
822 i
->uid_set
? i
->uid
: UID_INVALID
,
823 i
->gid_set
? i
->gid
: GID_INVALID
);
827 i
->uid_set
? i
->uid
: UID_INVALID
,
828 i
->gid_set
? i
->gid
: GID_INVALID
,
830 return log_error_errno(errno
, "fchownat() of %s failed: %m", path
);
833 /* Now, apply the final mode. We do this in two cases: when the user set a mode explicitly, or after a
834 * chown(), since chown()'s mangle the access mode in regards to sgid/suid in some conditions. */
835 if (i
->mode_set
|| do_chown
) {
836 if (S_ISLNK(st
->st_mode
))
837 log_debug("Skipping mode fix for symlink %s.", path
);
839 /* Check if the chmod() is unnecessary. Note that if we did a chown() before we always
840 * chmod() here again, since it might have mangled the bits. */
841 if (!do_chown
&& ((new_mode
^ st
->st_mode
) & 07777) == 0)
842 log_debug("\"%s\" matches mode %o already.", path
, new_mode
);
844 log_debug("Changing \"%s\" to mode %o.", path
, new_mode
);
845 if (fchmod_opath(fd
, new_mode
) < 0)
846 return log_error_errno(errno
, "fchmod() of %s failed: %m", path
);
852 return label_fix(path
, 0);
855 static int path_open_parent_safe(const char *path
) {
856 _cleanup_free_
char *dn
= NULL
;
859 if (path_equal(path
, "/") || !path_is_normalized(path
))
860 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
861 "Failed to open parent of '%s': invalid path.",
864 dn
= dirname_malloc(path
);
868 r
= chase_symlinks(dn
, arg_root
, CHASE_SAFE
|CHASE_WARN
, NULL
, &fd
);
869 if (r
< 0 && r
!= -ENOLINK
)
870 return log_error_errno(r
, "Failed to validate path %s: %m", path
);
872 return r
< 0 ? r
: fd
;
875 static int path_open_safe(const char *path
) {
878 /* path_open_safe() returns a file descriptor opened with O_PATH after
879 * verifying that the path doesn't contain unsafe transitions, except
880 * for its final component as the function does not follow symlink. */
884 if (!path_is_normalized(path
))
885 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
886 "Failed to open invalid path '%s'.",
889 r
= chase_symlinks(path
, arg_root
, CHASE_SAFE
|CHASE_WARN
|CHASE_NOFOLLOW
, NULL
, &fd
);
890 if (r
< 0 && r
!= -ENOLINK
)
891 return log_error_errno(r
, "Failed to validate path %s: %m", path
);
893 return r
< 0 ? r
: fd
;
896 static int path_set_perms(Item
*i
, const char *path
) {
897 _cleanup_close_
int fd
= -1;
902 fd
= path_open_safe(path
);
906 return fd_set_perms(i
, fd
, path
, NULL
);
909 static int parse_xattrs_from_arg(Item
*i
) {
919 _cleanup_free_
char *name
= NULL
, *value
= NULL
, *xattr
= NULL
;
921 r
= extract_first_word(&p
, &xattr
, NULL
, EXTRACT_UNQUOTE
|EXTRACT_CUNESCAPE
);
923 log_warning_errno(r
, "Failed to parse extended attribute '%s', ignoring: %m", p
);
927 r
= split_pair(xattr
, "=", &name
, &value
);
929 log_warning_errno(r
, "Failed to parse extended attribute, ignoring: %s", xattr
);
933 if (isempty(name
) || isempty(value
)) {
934 log_warning("Malformed extended attribute found, ignoring: %s", xattr
);
938 if (strv_push_pair(&i
->xattrs
, name
, value
) < 0)
947 static int fd_set_xattrs(Item
*i
, int fd
, const char *path
, const struct stat
*st
) {
948 char procfs_path
[STRLEN("/proc/self/fd/") + DECIMAL_STR_MAX(int)];
949 char **name
, **value
;
955 xsprintf(procfs_path
, "/proc/self/fd/%i", fd
);
957 STRV_FOREACH_PAIR(name
, value
, i
->xattrs
) {
958 log_debug("Setting extended attribute '%s=%s' on %s.", *name
, *value
, path
);
959 if (setxattr(procfs_path
, *name
, *value
, strlen(*value
), 0) < 0)
960 return log_error_errno(errno
, "Setting extended attribute %s=%s on %s failed: %m",
961 *name
, *value
, path
);
966 static int path_set_xattrs(Item
*i
, const char *path
) {
967 _cleanup_close_
int fd
= -1;
972 fd
= path_open_safe(path
);
976 return fd_set_xattrs(i
, fd
, path
, NULL
);
979 static int parse_acls_from_arg(Item
*item
) {
985 /* If append_or_force (= modify) is set, we will not modify the acl
986 * afterwards, so the mask can be added now if necessary. */
988 r
= parse_acl(item
->argument
, &item
->acl_access
, &item
->acl_default
, !item
->append_or_force
);
990 log_warning_errno(r
, "Failed to parse ACL \"%s\": %m. Ignoring", item
->argument
);
992 log_warning_errno(SYNTHETIC_ERRNO(ENOSYS
), "ACLs are not supported. Ignoring");
999 static int path_set_acl(const char *path
, const char *pretty
, acl_type_t type
, acl_t acl
, bool modify
) {
1000 _cleanup_(acl_free_charpp
) char *t
= NULL
;
1001 _cleanup_(acl_freep
) acl_t dup
= NULL
;
1004 /* Returns 0 for success, positive error if already warned,
1005 * negative error otherwise. */
1008 r
= acls_for_file(path
, type
, acl
, &dup
);
1012 r
= calc_acl_mask_if_needed(&dup
);
1020 /* the mask was already added earlier if needed */
1023 r
= add_base_acls_if_needed(&dup
, path
);
1027 t
= acl_to_any_text(dup
, NULL
, ',', TEXT_ABBREVIATE
);
1028 log_debug("Setting %s ACL %s on %s.",
1029 type
== ACL_TYPE_ACCESS
? "access" : "default",
1032 r
= acl_set_file(path
, type
, dup
);
1034 /* Return positive to indicate we already warned */
1035 return -log_error_errno(errno
,
1036 "Setting %s ACL \"%s\" on %s failed: %m",
1037 type
== ACL_TYPE_ACCESS
? "access" : "default",
1044 static int fd_set_acls(Item
*item
, int fd
, const char *path
, const struct stat
*st
) {
1047 char procfs_path
[STRLEN("/proc/self/fd/") + DECIMAL_STR_MAX(int)];
1055 if (fstat(fd
, &stbuf
) < 0)
1056 return log_error_errno(errno
, "fstat(%s) failed: %m", path
);
1060 if (hardlink_vulnerable(st
))
1061 return log_error_errno(SYNTHETIC_ERRNO(EPERM
),
1062 "Refusing to set ACLs on hardlinked file %s while the fs.protected_hardlinks sysctl is turned off.",
1065 if (S_ISLNK(st
->st_mode
)) {
1066 log_debug("Skipping ACL fix for symlink %s.", path
);
1070 xsprintf(procfs_path
, "/proc/self/fd/%i", fd
);
1072 if (item
->acl_access
)
1073 r
= path_set_acl(procfs_path
, path
, ACL_TYPE_ACCESS
, item
->acl_access
, item
->append_or_force
);
1075 /* set only default acls to folders */
1076 if (r
== 0 && item
->acl_default
&& S_ISDIR(st
->st_mode
))
1077 r
= path_set_acl(procfs_path
, path
, ACL_TYPE_DEFAULT
, item
->acl_default
, item
->append_or_force
);
1080 return -r
; /* already warned */
1081 if (r
== -EOPNOTSUPP
) {
1082 log_debug_errno(r
, "ACLs not supported by file system at %s", path
);
1086 return log_error_errno(r
, "ACL operation on \"%s\" failed: %m", path
);
1091 static int path_set_acls(Item
*item
, const char *path
) {
1094 _cleanup_close_
int fd
= -1;
1099 fd
= path_open_safe(path
);
1103 r
= fd_set_acls(item
, fd
, path
, NULL
);
1108 static int parse_attribute_from_arg(Item
*item
) {
1110 static const struct {
1114 { 'A', FS_NOATIME_FL
}, /* do not update atime */
1115 { 'S', FS_SYNC_FL
}, /* Synchronous updates */
1116 { 'D', FS_DIRSYNC_FL
}, /* dirsync behaviour (directories only) */
1117 { 'a', FS_APPEND_FL
}, /* writes to file may only append */
1118 { 'c', FS_COMPR_FL
}, /* Compress file */
1119 { 'd', FS_NODUMP_FL
}, /* do not dump file */
1120 { 'e', FS_EXTENT_FL
}, /* Extents */
1121 { 'i', FS_IMMUTABLE_FL
}, /* Immutable file */
1122 { 'j', FS_JOURNAL_DATA_FL
}, /* Reserved for ext3 */
1123 { 's', FS_SECRM_FL
}, /* Secure deletion */
1124 { 'u', FS_UNRM_FL
}, /* Undelete */
1125 { 't', FS_NOTAIL_FL
}, /* file tail should not be merged */
1126 { 'T', FS_TOPDIR_FL
}, /* Top of directory hierarchies */
1127 { 'C', FS_NOCOW_FL
}, /* Do not cow file */
1128 { 'P', FS_PROJINHERIT_FL
}, /* Inherit the quota project ID */
1137 unsigned value
= 0, mask
= 0;
1147 } else if (*p
== '-') {
1150 } else if (*p
== '=') {
1156 if (isempty(p
) && mode
!= MODE_SET
)
1157 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
1158 "Setting file attribute on '%s' needs an attribute specification.",
1161 for (; p
&& *p
; p
++) {
1164 for (i
= 0; i
< ELEMENTSOF(attributes
); i
++)
1165 if (*p
== attributes
[i
].character
)
1168 if (i
>= ELEMENTSOF(attributes
))
1169 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
1170 "Unknown file attribute '%c' on '%s'.",
1173 v
= attributes
[i
].value
;
1175 SET_FLAG(value
, v
, IN_SET(mode
, MODE_ADD
, MODE_SET
));
1180 if (mode
== MODE_SET
)
1181 mask
|= CHATTR_ALL_FL
;
1185 item
->attribute_mask
= mask
;
1186 item
->attribute_value
= value
;
1187 item
->attribute_set
= true;
1192 static int fd_set_attribute(Item
*item
, int fd
, const char *path
, const struct stat
*st
) {
1193 _cleanup_close_
int procfs_fd
= -1;
1202 if (!item
->attribute_set
|| item
->attribute_mask
== 0)
1206 if (fstat(fd
, &stbuf
) < 0)
1207 return log_error_errno(errno
, "fstat(%s) failed: %m", path
);
1211 /* Issuing the file attribute ioctls on device nodes is not
1212 * safe, as that will be delivered to the drivers, not the
1213 * file system containing the device node. */
1214 if (!S_ISREG(st
->st_mode
) && !S_ISDIR(st
->st_mode
))
1215 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
1216 "Setting file flags is only supported on regular files and directories, cannot set on '%s'.",
1219 f
= item
->attribute_value
& item
->attribute_mask
;
1221 /* Mask away directory-specific flags */
1222 if (!S_ISDIR(st
->st_mode
))
1223 f
&= ~FS_DIRSYNC_FL
;
1225 procfs_fd
= fd_reopen(fd
, O_RDONLY
|O_CLOEXEC
|O_NOATIME
);
1227 return log_error_errno(procfs_fd
, "Failed to re-open '%s': %m", path
);
1229 r
= chattr_fd(procfs_fd
, f
, item
->attribute_mask
, NULL
);
1231 log_full_errno(IN_SET(r
, -ENOTTY
, -EOPNOTSUPP
) ? LOG_DEBUG
: LOG_WARNING
,
1233 "Cannot set file attribute for '%s', value=0x%08x, mask=0x%08x, ignoring: %m",
1234 path
, item
->attribute_value
, item
->attribute_mask
);
1239 static int path_set_attribute(Item
*item
, const char *path
) {
1240 _cleanup_close_
int fd
= -1;
1242 if (!item
->attribute_set
|| item
->attribute_mask
== 0)
1245 fd
= path_open_safe(path
);
1249 return fd_set_attribute(item
, fd
, path
, NULL
);
1252 static int write_one_file(Item
*i
, const char *path
) {
1253 _cleanup_close_
int fd
= -1, dir_fd
= -1;
1259 assert(i
->argument
);
1260 assert(i
->type
== WRITE_FILE
);
1262 /* Validate the path and keep the fd on the directory for opening the
1263 * file so we're sure that it can't be changed behind our back. */
1264 dir_fd
= path_open_parent_safe(path
);
1268 bn
= basename(path
);
1270 flags
= O_NONBLOCK
|O_CLOEXEC
|O_WRONLY
|O_NOCTTY
;
1272 /* Follows symlinks */
1273 fd
= openat(dir_fd
, bn
, i
->append_or_force
? flags
|O_APPEND
: flags
, i
->mode
);
1275 if (errno
== ENOENT
) {
1276 log_debug_errno(errno
, "Not writing missing file \"%s\": %m", path
);
1279 return log_error_errno(errno
, "Failed to open file \"%s\": %m", path
);
1282 /* 'w' is allowed to write into any kind of files. */
1283 log_debug("Writing to \"%s\".", path
);
1285 r
= loop_write(fd
, i
->argument
, strlen(i
->argument
), false);
1287 return log_error_errno(r
, "Failed to write file \"%s\": %m", path
);
1289 return fd_set_perms(i
, fd
, path
, NULL
);
1292 static int create_file(Item
*i
, const char *path
) {
1293 _cleanup_close_
int fd
= -1, dir_fd
= -1;
1294 struct stat stbuf
, *st
= NULL
;
1300 assert(i
->type
== CREATE_FILE
);
1302 /* 'f' operates on regular files exclusively. */
1304 /* Validate the path and keep the fd on the directory for opening the
1305 * file so we're sure that it can't be changed behind our back. */
1306 dir_fd
= path_open_parent_safe(path
);
1310 bn
= basename(path
);
1312 RUN_WITH_UMASK(0000) {
1313 mac_selinux_create_file_prepare(path
, S_IFREG
);
1314 fd
= openat(dir_fd
, bn
, O_CREAT
|O_EXCL
|O_NOFOLLOW
|O_NONBLOCK
|O_CLOEXEC
|O_WRONLY
|O_NOCTTY
, i
->mode
);
1315 mac_selinux_create_file_clear();
1319 /* Even on a read-only filesystem, open(2) returns EEXIST if the
1320 * file already exists. It returns EROFS only if it needs to
1321 * create the file. */
1322 if (errno
!= EEXIST
)
1323 return log_error_errno(errno
, "Failed to create file %s: %m", path
);
1325 /* Re-open the file. At that point it must exist since open(2)
1326 * failed with EEXIST. We still need to check if the perms/mode
1327 * need to be changed. For read-only filesystems, we let
1328 * fd_set_perms() report the error if the perms need to be
1330 fd
= openat(dir_fd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
, i
->mode
);
1332 return log_error_errno(errno
, "Failed to re-open file %s: %m", path
);
1334 if (fstat(fd
, &stbuf
) < 0)
1335 return log_error_errno(errno
, "stat(%s) failed: %m", path
);
1337 if (!S_ISREG(stbuf
.st_mode
)) {
1338 log_error("%s exists and is not a regular file.", path
);
1345 log_debug("\"%s\" has been created.", path
);
1348 log_debug("Writing to \"%s\".", path
);
1350 r
= loop_write(fd
, i
->argument
, strlen(i
->argument
), false);
1352 return log_error_errno(r
, "Failed to write file \"%s\": %m", path
);
1356 return fd_set_perms(i
, fd
, path
, st
);
1359 static int truncate_file(Item
*i
, const char *path
) {
1360 _cleanup_close_
int fd
= -1, dir_fd
= -1;
1361 struct stat stbuf
, *st
= NULL
;
1368 assert(i
->type
== TRUNCATE_FILE
);
1370 /* We want to operate on regular file exclusively especially since
1371 * O_TRUNC is unspecified if the file is neither a regular file nor a
1372 * fifo nor a terminal device. Therefore we first open the file and make
1373 * sure it's a regular one before truncating it. */
1375 /* Validate the path and keep the fd on the directory for opening the
1376 * file so we're sure that it can't be changed behind our back. */
1377 dir_fd
= path_open_parent_safe(path
);
1381 bn
= basename(path
);
1383 RUN_WITH_UMASK(0000) {
1384 mac_selinux_create_file_prepare(path
, S_IFREG
);
1385 fd
= openat(dir_fd
, bn
, O_CREAT
|O_NOFOLLOW
|O_NONBLOCK
|O_CLOEXEC
|O_WRONLY
|O_NOCTTY
, i
->mode
);
1386 mac_selinux_create_file_clear();
1391 return log_error_errno(errno
, "Failed to open/create file %s: %m", path
);
1393 /* On a read-only filesystem, we don't want to fail if the
1394 * target is already empty and the perms are set. So we still
1395 * proceed with the sanity checks and let the remaining
1396 * operations fail with EROFS if they try to modify the target
1399 fd
= openat(dir_fd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
, i
->mode
);
1401 if (errno
== ENOENT
) {
1402 log_error("Cannot create file %s on a read-only file system.", path
);
1406 return log_error_errno(errno
, "Failed to re-open file %s: %m", path
);
1412 if (fstat(fd
, &stbuf
) < 0)
1413 return log_error_errno(errno
, "stat(%s) failed: %m", path
);
1415 if (!S_ISREG(stbuf
.st_mode
)) {
1416 log_error("%s exists and is not a regular file.", path
);
1420 if (stbuf
.st_size
> 0) {
1421 if (ftruncate(fd
, 0) < 0) {
1422 r
= erofs
? -EROFS
: -errno
;
1423 return log_error_errno(r
, "Failed to truncate file %s: %m", path
);
1428 log_debug("\"%s\" has been created.", path
);
1431 log_debug("Writing to \"%s\".", path
);
1433 r
= loop_write(fd
, i
->argument
, strlen(i
->argument
), false);
1435 r
= erofs
? -EROFS
: r
;
1436 return log_error_errno(r
, "Failed to write file %s: %m", path
);
1440 return fd_set_perms(i
, fd
, path
, st
);
1443 static int copy_files(Item
*i
) {
1444 _cleanup_close_
int dfd
= -1, fd
= -1;
1448 log_debug("Copying tree \"%s\" to \"%s\".", i
->argument
, i
->path
);
1450 bn
= basename(i
->path
);
1452 /* Validate the path and use the returned directory fd for copying the
1453 * target so we're sure that the path can't be changed behind our
1455 dfd
= path_open_parent_safe(i
->path
);
1459 r
= copy_tree_at(AT_FDCWD
, i
->argument
,
1461 i
->uid_set
? i
->uid
: UID_INVALID
,
1462 i
->gid_set
? i
->gid
: GID_INVALID
,
1463 COPY_REFLINK
| COPY_MERGE_EMPTY
);
1467 /* If the target already exists on read-only filesystems, trying
1468 * to create the target will not fail with EEXIST but with
1470 if (r
== -EROFS
&& faccessat(dfd
, bn
, F_OK
, AT_SYMLINK_NOFOLLOW
) == 0)
1474 return log_error_errno(r
, "Failed to copy files to %s: %m", i
->path
);
1476 if (stat(i
->argument
, &a
) < 0)
1477 return log_error_errno(errno
, "stat(%s) failed: %m", i
->argument
);
1479 if (fstatat(dfd
, bn
, &b
, AT_SYMLINK_NOFOLLOW
) < 0)
1480 return log_error_errno(errno
, "stat(%s) failed: %m", i
->path
);
1482 if ((a
.st_mode
^ b
.st_mode
) & S_IFMT
) {
1483 log_debug("Can't copy to %s, file exists already and is of different type", i
->path
);
1488 fd
= openat(dfd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
);
1490 return log_error_errno(errno
, "Failed to openat(%s): %m", i
->path
);
1492 return fd_set_perms(i
, fd
, i
->path
, NULL
);
1500 _CREATION_MODE_INVALID
= -1
1503 static const char *const creation_mode_verb_table
[_CREATION_MODE_MAX
] = {
1504 [CREATION_NORMAL
] = "Created",
1505 [CREATION_EXISTING
] = "Found existing",
1506 [CREATION_FORCE
] = "Created replacement",
1509 DEFINE_PRIVATE_STRING_TABLE_LOOKUP_TO_STRING(creation_mode_verb
, CreationMode
);
1511 static int create_directory_or_subvolume(const char *path
, mode_t mode
, bool subvol
, CreationMode
*creation
) {
1512 _cleanup_close_
int pfd
= -1;
1521 pfd
= path_open_parent_safe(path
);
1526 if (btrfs_is_subvol(empty_to_root(arg_root
)) <= 0)
1528 /* Don't create a subvolume unless the root directory is
1529 * one, too. We do this under the assumption that if the
1530 * root directory is just a plain directory (i.e. very
1531 * light-weight), we shouldn't try to split it up into
1532 * subvolumes (i.e. more heavy-weight). Thus, chroot()
1533 * environments and suchlike will get a full brtfs
1534 * subvolume set up below their tree only if they
1535 * specifically set up a btrfs subvolume for the root
1540 RUN_WITH_UMASK((~mode
) & 0777)
1541 r
= btrfs_subvol_make_fd(pfd
, basename(path
));
1546 if (!subvol
|| r
== -ENOTTY
)
1547 RUN_WITH_UMASK(0000)
1548 r
= mkdirat_label(pfd
, basename(path
), mode
);
1553 if (!IN_SET(r
, -EEXIST
, -EROFS
))
1554 return log_error_errno(r
, "Failed to create directory or subvolume \"%s\": %m", path
);
1557 if (k
== -ENOENT
&& r
== -EROFS
)
1558 return log_error_errno(r
, "%s does not exist and cannot be created as the file system is read-only.", path
);
1560 return log_error_errno(k
, "Failed to check if %s exists: %m", path
);
1562 log_warning("\"%s\" already exists and is not a directory.", path
);
1566 *creation
= CREATION_EXISTING
;
1568 *creation
= CREATION_NORMAL
;
1570 log_debug("%s directory \"%s\".", creation_mode_verb_to_string(*creation
), path
);
1572 r
= openat(pfd
, basename(path
), O_NOCTTY
|O_CLOEXEC
|O_DIRECTORY
);
1574 return log_error_errno(errno
, "Failed to open directory '%s': %m", basename(path
));
1579 static int create_directory(Item
*i
, const char *path
) {
1580 _cleanup_close_
int fd
= -1;
1583 assert(IN_SET(i
->type
, CREATE_DIRECTORY
, TRUNCATE_DIRECTORY
));
1585 fd
= create_directory_or_subvolume(path
, i
->mode
, false, NULL
);
1591 return fd_set_perms(i
, fd
, path
, NULL
);
1594 static int create_subvolume(Item
*i
, const char *path
) {
1595 _cleanup_close_
int fd
= -1;
1596 CreationMode creation
;
1600 assert(IN_SET(i
->type
, CREATE_SUBVOLUME
, CREATE_SUBVOLUME_NEW_QUOTA
, CREATE_SUBVOLUME_INHERIT_QUOTA
));
1602 fd
= create_directory_or_subvolume(path
, i
->mode
, true, &creation
);
1608 if (creation
== CREATION_NORMAL
&&
1609 IN_SET(i
->type
, CREATE_SUBVOLUME_NEW_QUOTA
, CREATE_SUBVOLUME_INHERIT_QUOTA
)) {
1610 r
= btrfs_subvol_auto_qgroup_fd(fd
, 0, i
->type
== CREATE_SUBVOLUME_NEW_QUOTA
);
1612 log_debug_errno(r
, "Couldn't adjust quota for subvolume \"%s\" (unsupported fs or dir not a subvolume): %m", i
->path
);
1613 else if (r
== -EROFS
)
1614 log_debug_errno(r
, "Couldn't adjust quota for subvolume \"%s\" (fs is read-only).", i
->path
);
1615 else if (r
== -ENOPROTOOPT
)
1616 log_debug_errno(r
, "Couldn't adjust quota for subvolume \"%s\" (quota support is disabled).", i
->path
);
1618 q
= log_error_errno(r
, "Failed to adjust quota for subvolume \"%s\": %m", i
->path
);
1620 log_debug("Adjusted quota for subvolume \"%s\".", i
->path
);
1622 log_debug("Quota for subvolume \"%s\" already in place, no change made.", i
->path
);
1625 r
= fd_set_perms(i
, fd
, path
, NULL
);
1626 if (q
< 0) /* prefer the quota change error from above */
1632 static int empty_directory(Item
*i
, const char *path
) {
1636 assert(i
->type
== EMPTY_DIRECTORY
);
1638 r
= is_dir(path
, false);
1640 /* Option "e" operates only on existing objects. Do not
1641 * print errors about non-existent files or directories */
1642 log_debug("Skipping missing directory: %s", path
);
1646 return log_error_errno(r
, "is_dir() failed on path %s: %m", path
);
1648 return log_error_errno(SYNTHETIC_ERRNO(EEXIST
),
1649 "'%s' already exists and is not a directory.",
1652 return path_set_perms(i
, path
);
1655 static int create_device(Item
*i
, mode_t file_type
) {
1656 _cleanup_close_
int dfd
= -1, fd
= -1;
1657 CreationMode creation
;
1662 assert(IN_SET(file_type
, S_IFBLK
, S_IFCHR
));
1664 bn
= basename(i
->path
);
1666 /* Validate the path and use the returned directory fd for copying the
1667 * target so we're sure that the path can't be changed behind our
1669 dfd
= path_open_parent_safe(i
->path
);
1673 RUN_WITH_UMASK(0000) {
1674 mac_selinux_create_file_prepare(i
->path
, file_type
);
1675 r
= mknodat(dfd
, bn
, i
->mode
| file_type
, i
->major_minor
);
1676 mac_selinux_create_file_clear();
1682 if (errno
== EPERM
) {
1683 log_debug("We lack permissions, possibly because of cgroup configuration; "
1684 "skipping creation of device node %s.", i
->path
);
1688 if (errno
!= EEXIST
)
1689 return log_error_errno(errno
, "Failed to create device node %s: %m", i
->path
);
1691 if (fstatat(dfd
, bn
, &st
, 0) < 0)
1692 return log_error_errno(errno
, "stat(%s) failed: %m", i
->path
);
1694 if ((st
.st_mode
& S_IFMT
) != file_type
) {
1696 if (i
->append_or_force
) {
1698 RUN_WITH_UMASK(0000) {
1699 mac_selinux_create_file_prepare(i
->path
, file_type
);
1700 /* FIXME: need to introduce mknodat_atomic() */
1701 r
= mknod_atomic(i
->path
, i
->mode
| file_type
, i
->major_minor
);
1702 mac_selinux_create_file_clear();
1706 return log_error_errno(r
, "Failed to create device node \"%s\": %m", i
->path
);
1707 creation
= CREATION_FORCE
;
1709 log_debug("%s is not a device node.", i
->path
);
1713 creation
= CREATION_EXISTING
;
1715 creation
= CREATION_NORMAL
;
1717 log_debug("%s %s device node \"%s\" %u:%u.",
1718 creation_mode_verb_to_string(creation
),
1719 i
->type
== CREATE_BLOCK_DEVICE
? "block" : "char",
1720 i
->path
, major(i
->mode
), minor(i
->mode
));
1722 fd
= openat(dfd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
);
1724 return log_error_errno(errno
, "Failed to openat(%s): %m", i
->path
);
1726 return fd_set_perms(i
, fd
, i
->path
, NULL
);
1729 static int create_fifo(Item
*i
, const char *path
) {
1730 _cleanup_close_
int pfd
= -1, fd
= -1;
1731 CreationMode creation
;
1736 pfd
= path_open_parent_safe(path
);
1740 bn
= basename(path
);
1742 RUN_WITH_UMASK(0000) {
1743 mac_selinux_create_file_prepare(path
, S_IFIFO
);
1744 r
= mkfifoat(pfd
, bn
, i
->mode
);
1745 mac_selinux_create_file_clear();
1749 if (errno
!= EEXIST
)
1750 return log_error_errno(errno
, "Failed to create fifo %s: %m", path
);
1752 if (fstatat(pfd
, bn
, &st
, AT_SYMLINK_NOFOLLOW
) < 0)
1753 return log_error_errno(errno
, "stat(%s) failed: %m", path
);
1755 if (!S_ISFIFO(st
.st_mode
)) {
1757 if (i
->append_or_force
) {
1758 RUN_WITH_UMASK(0000) {
1759 mac_selinux_create_file_prepare(path
, S_IFIFO
);
1760 r
= mkfifoat_atomic(pfd
, bn
, i
->mode
);
1761 mac_selinux_create_file_clear();
1765 return log_error_errno(r
, "Failed to create fifo %s: %m", path
);
1766 creation
= CREATION_FORCE
;
1768 log_warning("\"%s\" already exists and is not a fifo.", path
);
1772 creation
= CREATION_EXISTING
;
1774 creation
= CREATION_NORMAL
;
1776 log_debug("%s fifo \"%s\".", creation_mode_verb_to_string(creation
), path
);
1778 fd
= openat(pfd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
);
1780 return log_error_errno(errno
, "Failed to openat(%s): %m", path
);
1782 return fd_set_perms(i
, fd
, i
->path
, NULL
);
1785 typedef int (*action_t
)(Item
*i
, const char *path
);
1786 typedef int (*fdaction_t
)(Item
*i
, int fd
, const char *path
, const struct stat
*st
);
1788 static int item_do(Item
*i
, int fd
, const char *path
, fdaction_t action
) {
1796 if (fstat(fd
, &st
) < 0) {
1797 r
= log_error_errno(errno
, "fstat() on file failed: %m");
1801 /* This returns the first error we run into, but nevertheless
1803 r
= action(i
, fd
, path
, &st
);
1805 if (S_ISDIR(st
.st_mode
)) {
1806 char procfs_path
[STRLEN("/proc/self/fd/") + DECIMAL_STR_MAX(int)];
1807 _cleanup_closedir_
DIR *d
= NULL
;
1810 /* The passed 'fd' was opened with O_PATH. We need to convert
1811 * it into a 'regular' fd before reading the directory content. */
1812 xsprintf(procfs_path
, "/proc/self/fd/%i", fd
);
1814 d
= opendir(procfs_path
);
1816 log_error_errno(errno
, "Failed to opendir() '%s': %m", procfs_path
);
1822 FOREACH_DIRENT_ALL(de
, d
, q
= -errno
; goto finish
) {
1825 if (dot_or_dot_dot(de
->d_name
))
1828 de_fd
= openat(fd
, de
->d_name
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
);
1830 q
= log_error_errno(errno
, "Failed to open() file '%s': %m", de
->d_name
);
1832 _cleanup_free_
char *de_path
= NULL
;
1834 de_path
= path_join(path
, de
->d_name
);
1838 /* Pass ownership of dirent fd over */
1839 q
= item_do(i
, de_fd
, de_path
, action
);
1842 if (q
< 0 && r
== 0)
1851 static int glob_item(Item
*i
, action_t action
) {
1852 _cleanup_globfree_ glob_t g
= {
1853 .gl_opendir
= (void *(*)(const char *)) opendir_nomod
,
1858 k
= safe_glob(i
->path
, GLOB_NOSORT
|GLOB_BRACE
, &g
);
1859 if (k
< 0 && k
!= -ENOENT
)
1860 return log_error_errno(k
, "glob(%s) failed: %m", i
->path
);
1862 STRV_FOREACH(fn
, g
.gl_pathv
) {
1864 if (k
< 0 && r
== 0)
1871 static int glob_item_recursively(Item
*i
, fdaction_t action
) {
1872 _cleanup_globfree_ glob_t g
= {
1873 .gl_opendir
= (void *(*)(const char *)) opendir_nomod
,
1878 k
= safe_glob(i
->path
, GLOB_NOSORT
|GLOB_BRACE
, &g
);
1879 if (k
< 0 && k
!= -ENOENT
)
1880 return log_error_errno(k
, "glob(%s) failed: %m", i
->path
);
1882 STRV_FOREACH(fn
, g
.gl_pathv
) {
1883 _cleanup_close_
int fd
= -1;
1885 /* Make sure we won't trigger/follow file object (such as
1886 * device nodes, automounts, ...) pointed out by 'fn' with
1887 * O_PATH. Note, when O_PATH is used, flags other than
1888 * O_CLOEXEC, O_DIRECTORY, and O_NOFOLLOW are ignored. */
1890 fd
= open(*fn
, O_CLOEXEC
|O_NOFOLLOW
|O_PATH
);
1892 log_error_errno(errno
, "Opening '%s' failed: %m", *fn
);
1898 k
= item_do(i
, fd
, *fn
, action
);
1899 if (k
< 0 && r
== 0)
1902 /* we passed fd ownership to the previous call */
1909 static int create_item(Item
*i
) {
1910 CreationMode creation
;
1915 log_debug("Running create action for entry %c %s", (char) i
->type
, i
->path
);
1920 case IGNORE_DIRECTORY_PATH
:
1922 case RECURSIVE_REMOVE_PATH
:
1926 RUN_WITH_UMASK(0000)
1927 (void) mkdir_parents_label(i
->path
, 0755);
1929 r
= create_file(i
, i
->path
);
1935 RUN_WITH_UMASK(0000)
1936 (void) mkdir_parents_label(i
->path
, 0755);
1938 r
= truncate_file(i
, i
->path
);
1944 RUN_WITH_UMASK(0000)
1945 (void) mkdir_parents_label(i
->path
, 0755);
1953 r
= glob_item(i
, write_one_file
);
1959 case CREATE_DIRECTORY
:
1960 case TRUNCATE_DIRECTORY
:
1961 RUN_WITH_UMASK(0000)
1962 (void) mkdir_parents_label(i
->path
, 0755);
1964 r
= create_directory(i
, i
->path
);
1969 case CREATE_SUBVOLUME
:
1970 case CREATE_SUBVOLUME_INHERIT_QUOTA
:
1971 case CREATE_SUBVOLUME_NEW_QUOTA
:
1972 RUN_WITH_UMASK(0000)
1973 (void) mkdir_parents_label(i
->path
, 0755);
1975 r
= create_subvolume(i
, i
->path
);
1980 case EMPTY_DIRECTORY
:
1981 r
= glob_item(i
, empty_directory
);
1987 RUN_WITH_UMASK(0000)
1988 (void) mkdir_parents_label(i
->path
, 0755);
1990 r
= create_fifo(i
, i
->path
);
1995 case CREATE_SYMLINK
: {
1996 RUN_WITH_UMASK(0000)
1997 (void) mkdir_parents_label(i
->path
, 0755);
1999 mac_selinux_create_file_prepare(i
->path
, S_IFLNK
);
2000 r
= symlink(i
->argument
, i
->path
);
2001 mac_selinux_create_file_clear();
2004 _cleanup_free_
char *x
= NULL
;
2006 if (errno
!= EEXIST
)
2007 return log_error_errno(errno
, "symlink(%s, %s) failed: %m", i
->argument
, i
->path
);
2009 r
= readlink_malloc(i
->path
, &x
);
2010 if (r
< 0 || !streq(i
->argument
, x
)) {
2012 if (i
->append_or_force
) {
2013 mac_selinux_create_file_prepare(i
->path
, S_IFLNK
);
2014 r
= symlink_atomic(i
->argument
, i
->path
);
2015 mac_selinux_create_file_clear();
2017 if (IN_SET(r
, -EISDIR
, -EEXIST
, -ENOTEMPTY
)) {
2018 r
= rm_rf(i
->path
, REMOVE_ROOT
|REMOVE_PHYSICAL
);
2020 return log_error_errno(r
, "rm -fr %s failed: %m", i
->path
);
2022 mac_selinux_create_file_prepare(i
->path
, S_IFLNK
);
2023 r
= symlink(i
->argument
, i
->path
) < 0 ? -errno
: 0;
2024 mac_selinux_create_file_clear();
2027 return log_error_errno(r
, "symlink(%s, %s) failed: %m", i
->argument
, i
->path
);
2029 creation
= CREATION_FORCE
;
2031 log_debug("\"%s\" is not a symlink or does not point to the correct path.", i
->path
);
2035 creation
= CREATION_EXISTING
;
2038 creation
= CREATION_NORMAL
;
2039 log_debug("%s symlink \"%s\".", creation_mode_verb_to_string(creation
), i
->path
);
2043 case CREATE_BLOCK_DEVICE
:
2044 case CREATE_CHAR_DEVICE
:
2045 if (have_effective_cap(CAP_MKNOD
) == 0) {
2046 /* In a container we lack CAP_MKNOD. We shouldn't attempt to create the device node in that
2047 * case to avoid noise, and we don't support virtualized devices in containers anyway. */
2049 log_debug("We lack CAP_MKNOD, skipping creation of device node %s.", i
->path
);
2053 RUN_WITH_UMASK(0000)
2054 (void) mkdir_parents_label(i
->path
, 0755);
2056 r
= create_device(i
, i
->type
== CREATE_BLOCK_DEVICE
? S_IFBLK
: S_IFCHR
);
2064 r
= glob_item(i
, path_set_perms
);
2069 case RECURSIVE_RELABEL_PATH
:
2070 r
= glob_item_recursively(i
, fd_set_perms
);
2076 r
= glob_item(i
, path_set_xattrs
);
2081 case RECURSIVE_SET_XATTR
:
2082 r
= glob_item_recursively(i
, fd_set_xattrs
);
2088 r
= glob_item(i
, path_set_acls
);
2093 case RECURSIVE_SET_ACL
:
2094 r
= glob_item_recursively(i
, fd_set_acls
);
2100 r
= glob_item(i
, path_set_attribute
);
2105 case RECURSIVE_SET_ATTRIBUTE
:
2106 r
= glob_item_recursively(i
, fd_set_attribute
);
2115 static int remove_item_instance(Item
*i
, const char *instance
) {
2123 if (remove(instance
) < 0 && errno
!= ENOENT
)
2124 return log_error_errno(errno
, "rm(%s): %m", instance
);
2128 case RECURSIVE_REMOVE_PATH
:
2129 /* FIXME: we probably should use dir_cleanup() here instead of rm_rf() so that 'x' is honoured. */
2130 log_debug("rm -rf \"%s\"", instance
);
2131 r
= rm_rf(instance
, REMOVE_ROOT
|REMOVE_SUBVOLUME
|REMOVE_PHYSICAL
);
2132 if (r
< 0 && r
!= -ENOENT
)
2133 return log_error_errno(r
, "rm_rf(%s): %m", instance
);
2138 assert_not_reached("wut?");
2144 static int remove_item(Item
*i
) {
2149 log_debug("Running remove action for entry %c %s", (char) i
->type
, i
->path
);
2153 case TRUNCATE_DIRECTORY
:
2154 /* FIXME: we probably should use dir_cleanup() here instead of rm_rf() so that 'x' is honoured. */
2155 log_debug("rm -rf \"%s\"", i
->path
);
2156 r
= rm_rf(i
->path
, REMOVE_PHYSICAL
);
2157 if (r
< 0 && r
!= -ENOENT
)
2158 return log_error_errno(r
, "rm_rf(%s): %m", i
->path
);
2163 case RECURSIVE_REMOVE_PATH
:
2164 return glob_item(i
, remove_item_instance
);
2171 static int clean_item_instance(Item
*i
, const char* instance
) {
2172 _cleanup_closedir_
DIR *d
= NULL
;
2176 char timestamp
[FORMAT_TIMESTAMP_MAX
];
2183 n
= now(CLOCK_REALTIME
);
2187 cutoff
= n
- i
->age
;
2189 d
= opendir_nomod(instance
);
2191 if (IN_SET(errno
, ENOENT
, ENOTDIR
)) {
2192 log_debug_errno(errno
, "Directory \"%s\": %m", instance
);
2196 return log_error_errno(errno
, "Failed to open directory %s: %m", instance
);
2199 if (fstat(dirfd(d
), &s
) < 0)
2200 return log_error_errno(errno
, "stat(%s) failed: %m", i
->path
);
2202 if (!S_ISDIR(s
.st_mode
))
2203 return log_error_errno(SYNTHETIC_ERRNO(ENOTDIR
),
2204 "%s is not a directory.", i
->path
);
2206 if (fstatat(dirfd(d
), "..", &ps
, AT_SYMLINK_NOFOLLOW
) != 0)
2207 return log_error_errno(errno
, "stat(%s/..) failed: %m", i
->path
);
2209 mountpoint
= s
.st_dev
!= ps
.st_dev
|| s
.st_ino
== ps
.st_ino
;
2211 log_debug("Cleanup threshold for %s \"%s\" is %s",
2212 mountpoint
? "mount point" : "directory",
2214 format_timestamp_us(timestamp
, sizeof(timestamp
), cutoff
));
2216 return dir_cleanup(i
, instance
, d
, &s
, cutoff
, s
.st_dev
, mountpoint
,
2217 MAX_DEPTH
, i
->keep_first_level
);
2220 static int clean_item(Item
*i
) {
2223 log_debug("Running clean action for entry %c %s", (char) i
->type
, i
->path
);
2226 case CREATE_DIRECTORY
:
2227 case CREATE_SUBVOLUME
:
2228 case CREATE_SUBVOLUME_INHERIT_QUOTA
:
2229 case CREATE_SUBVOLUME_NEW_QUOTA
:
2230 case TRUNCATE_DIRECTORY
:
2233 clean_item_instance(i
, i
->path
);
2235 case EMPTY_DIRECTORY
:
2236 case IGNORE_DIRECTORY_PATH
:
2237 return glob_item(i
, clean_item_instance
);
2243 static int process_item(Item
*i
, OperationMask operation
) {
2249 todo
= operation
& ~i
->done
;
2250 if (todo
== 0) /* Everything already done? */
2253 i
->done
|= operation
;
2255 r
= chase_symlinks(i
->path
, arg_root
, CHASE_NO_AUTOFS
|CHASE_WARN
, NULL
, NULL
);
2256 if (r
== -EREMOTE
) {
2257 log_notice_errno(r
, "Skipping %s", i
->path
);
2261 log_debug_errno(r
, "Failed to determine whether '%s' is below autofs, ignoring: %m", i
->path
);
2263 r
= FLAGS_SET(operation
, OPERATION_CREATE
) ? create_item(i
) : 0;
2264 /* Failure can only be tolerated for create */
2265 if (i
->allow_failure
)
2268 q
= FLAGS_SET(operation
, OPERATION_REMOVE
) ? remove_item(i
) : 0;
2269 p
= FLAGS_SET(operation
, OPERATION_CLEAN
) ? clean_item(i
) : 0;
2276 static int process_item_array(ItemArray
*array
, OperationMask operation
) {
2282 /* Create any parent first. */
2283 if (FLAGS_SET(operation
, OPERATION_CREATE
) && array
->parent
)
2284 r
= process_item_array(array
->parent
, operation
& OPERATION_CREATE
);
2286 /* Clean up all children first */
2287 if ((operation
& (OPERATION_REMOVE
|OPERATION_CLEAN
)) && !set_isempty(array
->children
)) {
2291 SET_FOREACH(c
, array
->children
, i
) {
2294 k
= process_item_array(c
, operation
& (OPERATION_REMOVE
|OPERATION_CLEAN
));
2295 if (k
< 0 && r
== 0)
2300 for (n
= 0; n
< array
->n_items
; n
++) {
2303 k
= process_item(array
->items
+ n
, operation
);
2304 if (k
< 0 && r
== 0)
2311 static void item_free_contents(Item
*i
) {
2315 strv_free(i
->xattrs
);
2318 acl_free(i
->acl_access
);
2319 acl_free(i
->acl_default
);
2323 static ItemArray
* item_array_free(ItemArray
*a
) {
2329 for (n
= 0; n
< a
->n_items
; n
++)
2330 item_free_contents(a
->items
+ n
);
2332 set_free(a
->children
);
2337 static int item_compare(const Item
*a
, const Item
*b
) {
2338 /* Make sure that the ownership taking item is put first, so
2339 * that we first create the node, and then can adjust it */
2341 if (takes_ownership(a
->type
) && !takes_ownership(b
->type
))
2343 if (!takes_ownership(a
->type
) && takes_ownership(b
->type
))
2346 return CMP(a
->type
, b
->type
);
2349 static bool item_compatible(Item
*a
, Item
*b
) {
2352 assert(streq(a
->path
, b
->path
));
2354 if (takes_ownership(a
->type
) && takes_ownership(b
->type
))
2355 /* check if the items are the same */
2356 return streq_ptr(a
->argument
, b
->argument
) &&
2358 a
->uid_set
== b
->uid_set
&&
2361 a
->gid_set
== b
->gid_set
&&
2364 a
->mode_set
== b
->mode_set
&&
2365 a
->mode
== b
->mode
&&
2367 a
->age_set
== b
->age_set
&&
2370 a
->mask_perms
== b
->mask_perms
&&
2372 a
->keep_first_level
== b
->keep_first_level
&&
2374 a
->major_minor
== b
->major_minor
;
2379 static bool should_include_path(const char *path
) {
2382 STRV_FOREACH(prefix
, arg_exclude_prefixes
)
2383 if (path_startswith(path
, *prefix
)) {
2384 log_debug("Entry \"%s\" matches exclude prefix \"%s\", skipping.",
2389 STRV_FOREACH(prefix
, arg_include_prefixes
)
2390 if (path_startswith(path
, *prefix
)) {
2391 log_debug("Entry \"%s\" matches include prefix \"%s\".", path
, *prefix
);
2395 /* no matches, so we should include this path only if we
2396 * have no whitelist at all */
2397 if (strv_isempty(arg_include_prefixes
))
2400 log_debug("Entry \"%s\" does not match any include prefix, skipping.", path
);
2404 static int specifier_expansion_from_arg(Item
*i
) {
2405 _cleanup_free_
char *unescaped
= NULL
, *resolved
= NULL
;
2416 case CREATE_SYMLINK
:
2420 r
= cunescape(i
->argument
, 0, &unescaped
);
2422 return log_error_errno(r
, "Failed to unescape parameter to write: %s", i
->argument
);
2424 r
= specifier_printf(unescaped
, specifier_table
, NULL
, &resolved
);
2428 free_and_replace(i
->argument
, resolved
);
2432 case RECURSIVE_SET_XATTR
:
2435 STRV_FOREACH (xattr
, i
->xattrs
) {
2436 r
= specifier_printf(*xattr
, specifier_table
, NULL
, &resolved
);
2440 free_and_replace(*xattr
, resolved
);
2450 static int patch_var_run(const char *fname
, unsigned line
, char **path
) {
2457 /* Optionally rewrites lines referencing /var/run/, to use /run/ instead. Why bother? tmpfiles merges lines in
2458 * some cases and detects conflicts in others. If files/directories are specified through two equivalent lines
2459 * this is problematic as neither case will be detected. Ideally we'd detect these cases by resolving symlinks
2460 * early, but that's precisely not what we can do here as this code very likely is running very early on, at a
2461 * time where the paths in question are not available yet, or even more importantly, our own tmpfiles rules
2462 * might create the paths that are intermediary to the listed paths. We can't really cover the generic case,
2463 * but the least we can do is cover the specific case of /var/run vs. /run, as /var/run is a legacy name for
2464 * /run only, and we explicitly document that and require that on systemd systems the former is a symlink to
2465 * the latter. Moreover files below this path are by far the primary usecase for tmpfiles.d/. */
2467 k
= path_startswith(*path
, "/var/run/");
2468 if (isempty(k
)) /* Don't complain about other paths than /var/run, and not about /var/run itself either. */
2471 n
= path_join("/run", k
);
2475 /* Also log about this briefly. We do so at LOG_NOTICE level, as we fixed up the situation automatically, hence
2476 * there's no immediate need for action by the user. However, in the interest of making things less confusing
2477 * to the user, let's still inform the user that these snippets should really be updated. */
2478 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
);
2480 free_and_replace(*path
, n
);
2485 static int parse_line(const char *fname
, unsigned line
, const char *buffer
, bool *invalid_config
) {
2487 _cleanup_free_
char *action
= NULL
, *mode
= NULL
, *user
= NULL
, *group
= NULL
, *age
= NULL
, *path
= NULL
;
2488 _cleanup_(item_free_contents
) Item i
= {};
2489 ItemArray
*existing
;
2492 bool append_or_force
= false, boot
= false, allow_failure
= false;
2498 r
= extract_many_words(
2510 if (IN_SET(r
, -EINVAL
, -EBADSLT
))
2511 /* invalid quoting and such or an unknown specifier */
2512 *invalid_config
= true;
2513 return log_error_errno(r
, "[%s:%u] Failed to parse line: %m", fname
, line
);
2515 *invalid_config
= true;
2516 log_error("[%s:%u] Syntax error.", fname
, line
);
2520 if (!empty_or_dash(buffer
)) {
2521 i
.argument
= strdup(buffer
);
2526 if (isempty(action
)) {
2527 *invalid_config
= true;
2528 log_error("[%s:%u] Command too short '%s'.", fname
, line
, action
);
2532 for (pos
= 1; action
[pos
]; pos
++) {
2533 if (action
[pos
] == '!' && !boot
)
2535 else if (action
[pos
] == '+' && !append_or_force
)
2536 append_or_force
= true;
2537 else if (action
[pos
] == '-' && !allow_failure
)
2538 allow_failure
= true;
2540 *invalid_config
= true;
2541 log_error("[%s:%u] Unknown modifiers in command '%s'",
2542 fname
, line
, action
);
2547 if (boot
&& !arg_boot
) {
2548 log_debug("Ignoring entry %s \"%s\" because --boot is not specified.",
2554 i
.append_or_force
= append_or_force
;
2555 i
.allow_failure
= allow_failure
;
2557 r
= specifier_printf(path
, specifier_table
, NULL
, &i
.path
);
2559 return log_unresolvable_specifier(fname
, line
);
2561 if (IN_SET(r
, -EINVAL
, -EBADSLT
))
2562 *invalid_config
= true;
2563 return log_error_errno(r
, "[%s:%u] Failed to replace specifiers: %s", fname
, line
, path
);
2566 r
= patch_var_run(fname
, line
, &i
.path
);
2572 case CREATE_DIRECTORY
:
2573 case CREATE_SUBVOLUME
:
2574 case CREATE_SUBVOLUME_INHERIT_QUOTA
:
2575 case CREATE_SUBVOLUME_NEW_QUOTA
:
2576 case EMPTY_DIRECTORY
:
2577 case TRUNCATE_DIRECTORY
:
2580 case IGNORE_DIRECTORY_PATH
:
2582 case RECURSIVE_REMOVE_PATH
:
2585 case RECURSIVE_RELABEL_PATH
:
2587 log_warning("[%s:%u] %c lines don't take argument fields, ignoring.", fname
, line
, i
.type
);
2595 case CREATE_SYMLINK
:
2597 i
.argument
= path_join("/usr/share/factory", i
.path
);
2605 *invalid_config
= true;
2606 log_error("[%s:%u] Write file requires argument.", fname
, line
);
2613 i
.argument
= path_join(arg_root
, "/usr/share/factory", i
.path
);
2617 } else if (!path_is_absolute(i
.argument
)) {
2618 *invalid_config
= true;
2619 log_error("[%s:%u] Source path is not absolute.", fname
, line
);
2622 } else if (arg_root
) {
2625 p
= path_join(arg_root
, i
.argument
);
2628 free_and_replace(i
.argument
, p
);
2631 path_simplify(i
.argument
, false);
2634 case CREATE_CHAR_DEVICE
:
2635 case CREATE_BLOCK_DEVICE
:
2637 *invalid_config
= true;
2638 log_error("[%s:%u] Device file requires argument.", fname
, line
);
2642 r
= parse_dev(i
.argument
, &i
.major_minor
);
2644 *invalid_config
= true;
2645 log_error_errno(r
, "[%s:%u] Can't parse device file major/minor '%s'.", fname
, line
, i
.argument
);
2652 case RECURSIVE_SET_XATTR
:
2654 *invalid_config
= true;
2655 log_error("[%s:%u] Set extended attribute requires argument.", fname
, line
);
2658 r
= parse_xattrs_from_arg(&i
);
2664 case RECURSIVE_SET_ACL
:
2666 *invalid_config
= true;
2667 log_error("[%s:%u] Set ACLs requires argument.", fname
, line
);
2670 r
= parse_acls_from_arg(&i
);
2676 case RECURSIVE_SET_ATTRIBUTE
:
2678 *invalid_config
= true;
2679 log_error("[%s:%u] Set file attribute requires argument.", fname
, line
);
2682 r
= parse_attribute_from_arg(&i
);
2683 if (IN_SET(r
, -EINVAL
, -EBADSLT
))
2684 *invalid_config
= true;
2690 log_error("[%s:%u] Unknown command type '%c'.", fname
, line
, (char) i
.type
);
2691 *invalid_config
= true;
2695 if (!path_is_absolute(i
.path
)) {
2696 log_error("[%s:%u] Path '%s' not absolute.", fname
, line
, i
.path
);
2697 *invalid_config
= true;
2701 path_simplify(i
.path
, false);
2703 if (!should_include_path(i
.path
))
2706 r
= specifier_expansion_from_arg(&i
);
2708 return log_unresolvable_specifier(fname
, line
);
2710 if (IN_SET(r
, -EINVAL
, -EBADSLT
))
2711 *invalid_config
= true;
2712 return log_error_errno(r
, "[%s:%u] Failed to substitute specifiers in argument: %m",
2719 p
= path_join(arg_root
, i
.path
);
2722 free_and_replace(i
.path
, p
);
2725 if (!empty_or_dash(user
)) {
2726 const char *u
= user
;
2728 r
= get_user_creds(&u
, &i
.uid
, NULL
, NULL
, NULL
, USER_CREDS_ALLOW_MISSING
);
2730 *invalid_config
= true;
2731 return log_error_errno(r
, "[%s:%u] Unknown user '%s'.", fname
, line
, user
);
2737 if (!empty_or_dash(group
)) {
2738 const char *g
= group
;
2740 r
= get_group_creds(&g
, &i
.gid
, USER_CREDS_ALLOW_MISSING
);
2742 *invalid_config
= true;
2743 log_error("[%s:%u] Unknown group '%s'.", fname
, line
, group
);
2750 if (!empty_or_dash(mode
)) {
2751 const char *mm
= mode
;
2755 i
.mask_perms
= true;
2759 if (parse_mode(mm
, &m
) < 0) {
2760 *invalid_config
= true;
2761 log_error("[%s:%u] Invalid mode '%s'.", fname
, line
, mode
);
2768 i
.mode
= IN_SET(i
.type
, CREATE_DIRECTORY
, TRUNCATE_DIRECTORY
, CREATE_SUBVOLUME
, CREATE_SUBVOLUME_INHERIT_QUOTA
, CREATE_SUBVOLUME_NEW_QUOTA
) ? 0755 : 0644;
2770 if (!empty_or_dash(age
)) {
2771 const char *a
= age
;
2774 i
.keep_first_level
= true;
2778 if (parse_sec(a
, &i
.age
) < 0) {
2779 *invalid_config
= true;
2780 log_error("[%s:%u] Invalid age '%s'.", fname
, line
, age
);
2787 h
= needs_glob(i
.type
) ? globs
: items
;
2789 existing
= ordered_hashmap_get(h
, i
.path
);
2793 for (n
= 0; n
< existing
->n_items
; n
++) {
2794 if (!item_compatible(existing
->items
+ n
, &i
) && !i
.append_or_force
) {
2795 log_notice("[%s:%u] Duplicate line for path \"%s\", ignoring.",
2796 fname
, line
, i
.path
);
2801 existing
= new0(ItemArray
, 1);
2805 r
= ordered_hashmap_put(h
, i
.path
, existing
);
2812 if (!GREEDY_REALLOC(existing
->items
, existing
->allocated
, existing
->n_items
+ 1))
2815 existing
->items
[existing
->n_items
++] = i
;
2816 i
= (struct Item
) {};
2818 /* Sort item array, to enforce stable ordering of application */
2819 typesafe_qsort(existing
->items
, existing
->n_items
, item_compare
);
2824 static int cat_config(char **config_dirs
, char **args
) {
2825 _cleanup_strv_free_
char **files
= NULL
;
2828 r
= conf_files_list_with_replacement(arg_root
, config_dirs
, arg_replace
, &files
, NULL
);
2832 return cat_files(NULL
, files
, 0);
2835 static int help(void) {
2836 _cleanup_free_
char *link
= NULL
;
2839 r
= terminal_urlify_man("systemd-tmpfiles", "8", &link
);
2843 printf("%s [OPTIONS...] [CONFIGURATION FILE...]\n\n"
2844 "Creates, deletes and cleans up volatile and temporary files and directories.\n\n"
2845 " -h --help Show this help\n"
2846 " --user Execute user configuration\n"
2847 " --version Show package version\n"
2848 " --cat-config Show configuration files\n"
2849 " --create Create marked files/directories\n"
2850 " --clean Clean up marked directories\n"
2851 " --remove Remove marked files/directories\n"
2852 " --boot Execute actions only safe at boot\n"
2853 " --prefix=PATH Only apply rules with the specified prefix\n"
2854 " --exclude-prefix=PATH Ignore rules with the specified prefix\n"
2855 " --root=PATH Operate on an alternate filesystem root\n"
2856 " --replace=PATH Treat arguments as replacement for PATH\n"
2857 " --no-pager Do not pipe output into a pager\n"
2858 "\nSee the %s for details.\n"
2859 , program_invocation_short_name
2866 static int parse_argv(int argc
, char *argv
[]) {
2869 ARG_VERSION
= 0x100,
2883 static const struct option options
[] = {
2884 { "help", no_argument
, NULL
, 'h' },
2885 { "user", no_argument
, NULL
, ARG_USER
},
2886 { "version", no_argument
, NULL
, ARG_VERSION
},
2887 { "cat-config", no_argument
, NULL
, ARG_CAT_CONFIG
},
2888 { "create", no_argument
, NULL
, ARG_CREATE
},
2889 { "clean", no_argument
, NULL
, ARG_CLEAN
},
2890 { "remove", no_argument
, NULL
, ARG_REMOVE
},
2891 { "boot", no_argument
, NULL
, ARG_BOOT
},
2892 { "prefix", required_argument
, NULL
, ARG_PREFIX
},
2893 { "exclude-prefix", required_argument
, NULL
, ARG_EXCLUDE_PREFIX
},
2894 { "root", required_argument
, NULL
, ARG_ROOT
},
2895 { "replace", required_argument
, NULL
, ARG_REPLACE
},
2896 { "no-pager", no_argument
, NULL
, ARG_NO_PAGER
},
2905 while ((c
= getopt_long(argc
, argv
, "h", options
, NULL
)) >= 0)
2915 case ARG_CAT_CONFIG
:
2916 arg_cat_config
= true;
2924 arg_operation
|= OPERATION_CREATE
;
2928 arg_operation
|= OPERATION_CLEAN
;
2932 arg_operation
|= OPERATION_REMOVE
;
2940 if (strv_push(&arg_include_prefixes
, optarg
) < 0)
2944 case ARG_EXCLUDE_PREFIX
:
2945 if (strv_push(&arg_exclude_prefixes
, optarg
) < 0)
2950 r
= parse_path_argument_and_warn(optarg
, true, &arg_root
);
2956 if (!path_is_absolute(optarg
) ||
2957 !endswith(optarg
, ".conf"))
2958 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
2959 "The argument to --replace= must an absolute path to a config file");
2961 arg_replace
= optarg
;
2965 arg_pager_flags
|= PAGER_DISABLE
;
2972 assert_not_reached("Unhandled option");
2975 if (arg_operation
== 0 && !arg_cat_config
)
2976 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
2977 "You need to specify at least one of --clean, --create or --remove.");
2979 if (arg_replace
&& arg_cat_config
)
2980 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
2981 "Option --replace= is not supported with --cat-config");
2983 if (arg_replace
&& optind
>= argc
)
2984 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
2985 "When --replace= is given, some configuration items must be specified");
2990 static int read_config_file(char **config_dirs
, const char *fn
, bool ignore_enoent
, bool *invalid_config
) {
2991 _cleanup_fclose_
FILE *_f
= NULL
;
3000 if (streq(fn
, "-")) {
3001 log_debug("Reading config from stdin…");
3005 r
= search_and_fopen(fn
, "re", arg_root
, (const char**) config_dirs
, &_f
);
3007 if (ignore_enoent
&& r
== -ENOENT
) {
3008 log_debug_errno(r
, "Failed to open \"%s\", ignoring: %m", fn
);
3012 return log_error_errno(r
, "Failed to open '%s': %m", fn
);
3014 log_debug("Reading config file \"%s\"…", fn
);
3019 _cleanup_free_
char *line
= NULL
;
3020 bool invalid_line
= false;
3024 k
= read_line(f
, LONG_LINE_MAX
, &line
);
3026 return log_error_errno(k
, "Failed to read '%s': %m", fn
);
3033 if (IN_SET(*l
, 0, '#'))
3036 k
= parse_line(fn
, v
, l
, &invalid_line
);
3039 /* Allow reporting with a special code if the caller requested this */
3040 *invalid_config
= true;
3042 /* The first error becomes our return value */
3047 /* we have to determine age parameter for each entry of type X */
3048 ORDERED_HASHMAP_FOREACH(i
, globs
, iterator
) {
3050 Item
*j
, *candidate_item
= NULL
;
3052 if (i
->type
!= IGNORE_DIRECTORY_PATH
)
3055 ORDERED_HASHMAP_FOREACH(j
, items
, iter
) {
3056 if (!IN_SET(j
->type
, CREATE_DIRECTORY
, TRUNCATE_DIRECTORY
, CREATE_SUBVOLUME
, CREATE_SUBVOLUME_INHERIT_QUOTA
, CREATE_SUBVOLUME_NEW_QUOTA
))
3059 if (path_equal(j
->path
, i
->path
)) {
3064 if ((!candidate_item
&& path_startswith(i
->path
, j
->path
)) ||
3065 (candidate_item
&& path_startswith(j
->path
, candidate_item
->path
) && (fnmatch(i
->path
, j
->path
, FNM_PATHNAME
| FNM_PERIOD
) == 0)))
3069 if (candidate_item
&& candidate_item
->age_set
) {
3070 i
->age
= candidate_item
->age
;
3076 log_error_errno(errno
, "Failed to read from file %s: %m", fn
);
3084 static int parse_arguments(char **config_dirs
, char **args
, bool *invalid_config
) {
3088 STRV_FOREACH(arg
, args
) {
3089 r
= read_config_file(config_dirs
, *arg
, false, invalid_config
);
3097 static int read_config_files(char **config_dirs
, char **args
, bool *invalid_config
) {
3098 _cleanup_strv_free_
char **files
= NULL
;
3099 _cleanup_free_
char *p
= NULL
;
3103 r
= conf_files_list_with_replacement(arg_root
, config_dirs
, arg_replace
, &files
, &p
);
3107 STRV_FOREACH(f
, files
)
3108 if (p
&& path_equal(*f
, p
)) {
3109 log_debug("Parsing arguments at position \"%s\"…", *f
);
3111 r
= parse_arguments(config_dirs
, args
, invalid_config
);
3115 /* Just warn, ignore result otherwise.
3116 * read_config_file() has some debug output, so no need to print anything. */
3117 (void) read_config_file(config_dirs
, *f
, true, invalid_config
);
3122 static int link_parent(ItemArray
*a
) {
3129 /* Finds the closest "parent" item array for the specified item array. Then registers the specified item array
3130 * as child of it, and fills the parent in, linking them both ways. This allows us to later create parents
3131 * before their children, and clean up/remove children before their parents. */
3133 if (a
->n_items
<= 0)
3136 path
= a
->items
[0].path
;
3137 prefix
= newa(char, strlen(path
) + 1);
3138 PATH_FOREACH_PREFIX(prefix
, path
) {
3141 j
= ordered_hashmap_get(items
, prefix
);
3143 j
= ordered_hashmap_get(globs
, prefix
);
3145 r
= set_ensure_allocated(&j
->children
, NULL
);
3149 r
= set_put(j
->children
, a
);
3161 DEFINE_PRIVATE_HASH_OPS_WITH_VALUE_DESTRUCTOR(item_array_hash_ops
, char, string_hash_func
, string_compare_func
,
3162 ItemArray
, item_array_free
);
3164 static int run(int argc
, char *argv
[]) {
3165 _cleanup_strv_free_
char **config_dirs
= NULL
;
3166 bool invalid_config
= false;
3170 PHASE_REMOVE_AND_CLEAN
,
3176 r
= parse_argv(argc
, argv
);
3180 log_setup_service();
3182 /* Descending down file system trees might take a lot of fds */
3183 (void) rlimit_nofile_bump(HIGH_RLIMIT_NOFILE
);
3186 r
= user_config_paths(&config_dirs
);
3188 return log_error_errno(r
, "Failed to initialize configuration directory list: %m");
3190 config_dirs
= strv_split_nulstr(CONF_PATHS_NULSTR("tmpfiles.d"));
3195 if (DEBUG_LOGGING
) {
3196 _cleanup_free_
char *t
= NULL
;
3198 t
= strv_join(config_dirs
, "\n\t");
3200 log_debug("Looking for configuration files in (higher priority first):\n\t%s", t
);
3203 if (arg_cat_config
) {
3204 (void) pager_open(arg_pager_flags
);
3206 return cat_config(config_dirs
, argv
+ optind
);
3213 items
= ordered_hashmap_new(&item_array_hash_ops
);
3214 globs
= ordered_hashmap_new(&item_array_hash_ops
);
3215 if (!items
|| !globs
)
3218 /* If command line arguments are specified along with --replace, read all
3219 * configuration files and insert the positional arguments at the specified
3220 * place. Otherwise, if command line arguments are specified, execute just
3221 * them, and finally, without --replace= or any positional arguments, just
3222 * read configuration and execute it.
3224 if (arg_replace
|| optind
>= argc
)
3225 r
= read_config_files(config_dirs
, argv
+ optind
, &invalid_config
);
3227 r
= parse_arguments(config_dirs
, argv
+ optind
, &invalid_config
);
3231 /* Let's now link up all child/parent relationships */
3232 ORDERED_HASHMAP_FOREACH(a
, items
, iterator
) {
3237 ORDERED_HASHMAP_FOREACH(a
, globs
, iterator
) {
3243 /* If multiple operations are requested, let's first run the remove/clean operations, and only then the create
3244 * operations. i.e. that we first clean out the platform we then build on. */
3245 for (phase
= 0; phase
< _PHASE_MAX
; phase
++) {
3248 if (phase
== PHASE_REMOVE_AND_CLEAN
)
3249 op
= arg_operation
& (OPERATION_REMOVE
|OPERATION_CLEAN
);
3250 else if (phase
== PHASE_CREATE
)
3251 op
= arg_operation
& OPERATION_CREATE
;
3253 assert_not_reached("unexpected phase");
3255 if (op
== 0) /* Nothing requested in this phase */
3258 /* The non-globbing ones usually create things, hence we apply them first */
3259 ORDERED_HASHMAP_FOREACH(a
, items
, iterator
) {
3260 k
= process_item_array(a
, op
);
3261 if (k
< 0 && r
>= 0)
3265 /* The globbing ones usually alter things, hence we apply them second. */
3266 ORDERED_HASHMAP_FOREACH(a
, globs
, iterator
) {
3267 k
= process_item_array(a
, op
);
3268 if (k
< 0 && r
>= 0)
3273 if (ERRNO_IS_RESOURCE(-r
))
3278 return EX_CANTCREAT
;
3282 DEFINE_MAIN_FUNCTION_WITH_POSITIVE_FAILURE(run
);