1 /* SPDX-License-Identifier: LGPL-2.1+ */
17 #include <sys/xattr.h>
25 #include "alloc-util.h"
26 #include "btrfs-util.h"
27 #include "capability-util.h"
28 #include "chattr-util.h"
29 #include "conf-files.h"
32 #include "dirent-util.h"
36 #include "format-util.h"
38 #include "glob-util.h"
43 #include "main-func.h"
45 #include "mountpoint-util.h"
47 #include "parse-util.h"
48 #include "path-lookup.h"
49 #include "path-util.h"
50 #include "pretty-print.h"
51 #include "rlimit-util.h"
53 #include "selinux-util.h"
55 #include "sort-util.h"
56 #include "specifier.h"
57 #include "stat-util.h"
58 #include "stdio-util.h"
59 #include "string-table.h"
60 #include "string-util.h"
62 #include "umask-util.h"
63 #include "user-util.h"
65 /* This reads all files listed in /etc/tmpfiles.d/?*.conf and creates
66 * them in the file system. This is intended to be used to create
67 * properly owned directories beneath /tmp, /var/tmp, /run, which are
68 * volatile and hence need to be recreated on bootup. */
70 typedef enum OperationMask
{
71 OPERATION_CREATE
= 1 << 0,
72 OPERATION_REMOVE
= 1 << 1,
73 OPERATION_CLEAN
= 1 << 2,
76 typedef enum ItemType
{
77 /* These ones take file names */
80 CREATE_DIRECTORY
= 'd',
81 TRUNCATE_DIRECTORY
= 'D',
82 CREATE_SUBVOLUME
= 'v',
83 CREATE_SUBVOLUME_INHERIT_QUOTA
= 'q',
84 CREATE_SUBVOLUME_NEW_QUOTA
= 'Q',
87 CREATE_CHAR_DEVICE
= 'c',
88 CREATE_BLOCK_DEVICE
= 'b',
91 /* These ones take globs */
93 EMPTY_DIRECTORY
= 'e',
95 RECURSIVE_SET_XATTR
= 'T',
97 RECURSIVE_SET_ACL
= 'A',
99 RECURSIVE_SET_ATTRIBUTE
= 'H',
101 IGNORE_DIRECTORY_PATH
= 'X',
103 RECURSIVE_REMOVE_PATH
= 'R',
105 RECURSIVE_RELABEL_PATH
= 'Z',
106 ADJUST_MODE
= 'm', /* legacy, 'z' is identical to this */
109 typedef struct Item
{
125 unsigned attribute_value
;
126 unsigned attribute_mask
;
133 bool attribute_set
:1;
135 bool keep_first_level
:1;
137 bool append_or_force
:1;
139 bool allow_failure
:1;
144 typedef struct ItemArray
{
149 struct ItemArray
*parent
;
153 typedef enum DirectoryType
{
161 static bool arg_cat_config
= false;
162 static bool arg_user
= false;
163 static OperationMask arg_operation
= 0;
164 static bool arg_boot
= false;
165 static PagerFlags arg_pager_flags
= 0;
167 static char **arg_include_prefixes
= NULL
;
168 static char **arg_exclude_prefixes
= NULL
;
169 static char *arg_root
= NULL
;
170 static char *arg_replace
= NULL
;
172 #define MAX_DEPTH 256
174 static OrderedHashmap
*items
= NULL
, *globs
= NULL
;
175 static Set
*unix_sockets
= NULL
;
177 STATIC_DESTRUCTOR_REGISTER(items
, ordered_hashmap_freep
);
178 STATIC_DESTRUCTOR_REGISTER(globs
, ordered_hashmap_freep
);
179 STATIC_DESTRUCTOR_REGISTER(unix_sockets
, set_free_freep
);
180 STATIC_DESTRUCTOR_REGISTER(arg_include_prefixes
, freep
);
181 STATIC_DESTRUCTOR_REGISTER(arg_exclude_prefixes
, freep
);
182 STATIC_DESTRUCTOR_REGISTER(arg_root
, freep
);
184 static int specifier_machine_id_safe(char specifier
, const void *data
, const void *userdata
, char **ret
);
185 static int specifier_directory(char specifier
, const void *data
, const void *userdata
, char **ret
);
187 static const Specifier specifier_table
[] = {
188 { 'm', specifier_machine_id_safe
, NULL
},
189 { 'b', specifier_boot_id
, NULL
},
190 { 'H', specifier_host_name
, NULL
},
191 { 'v', specifier_kernel_release
, NULL
},
193 { 'g', specifier_group_name
, NULL
},
194 { 'G', specifier_group_id
, NULL
},
195 { 'U', specifier_user_id
, NULL
},
196 { 'u', specifier_user_name
, NULL
},
197 { 'h', specifier_user_home
, NULL
},
199 { 't', specifier_directory
, UINT_TO_PTR(DIRECTORY_RUNTIME
) },
200 { 'S', specifier_directory
, UINT_TO_PTR(DIRECTORY_STATE
) },
201 { 'C', specifier_directory
, UINT_TO_PTR(DIRECTORY_CACHE
) },
202 { 'L', specifier_directory
, UINT_TO_PTR(DIRECTORY_LOGS
) },
203 { 'T', specifier_tmp_dir
, NULL
},
204 { 'V', specifier_var_tmp_dir
, NULL
},
208 static int specifier_machine_id_safe(char specifier
, const void *data
, const void *userdata
, char **ret
) {
211 /* If /etc/machine_id is missing or empty (e.g. in a chroot environment)
212 * return a recognizable error so that the caller can skip the rule
215 r
= specifier_machine_id(specifier
, data
, userdata
, ret
);
216 if (IN_SET(r
, -ENOENT
, -ENOMEDIUM
))
222 static int specifier_directory(char specifier
, const void *data
, const void *userdata
, char **ret
) {
228 static const struct table_entry paths_system
[] = {
229 [DIRECTORY_RUNTIME
] = { SD_PATH_SYSTEM_RUNTIME
},
230 [DIRECTORY_STATE
] = { SD_PATH_SYSTEM_STATE_PRIVATE
},
231 [DIRECTORY_CACHE
] = { SD_PATH_SYSTEM_STATE_CACHE
},
232 [DIRECTORY_LOGS
] = { SD_PATH_SYSTEM_STATE_LOGS
},
235 static const struct table_entry paths_user
[] = {
236 [DIRECTORY_RUNTIME
] = { SD_PATH_USER_RUNTIME
},
237 [DIRECTORY_STATE
] = { SD_PATH_USER_CONFIGURATION
},
238 [DIRECTORY_CACHE
] = { SD_PATH_USER_STATE_CACHE
},
239 [DIRECTORY_LOGS
] = { SD_PATH_USER_CONFIGURATION
, "log" },
243 const struct table_entry
*paths
;
245 assert_cc(ELEMENTSOF(paths_system
) == ELEMENTSOF(paths_user
));
246 paths
= arg_user
? paths_user
: paths_system
;
248 i
= PTR_TO_UINT(data
);
249 assert(i
< ELEMENTSOF(paths_system
));
251 return sd_path_home(paths
[i
].type
, paths
[i
].suffix
, ret
);
254 static int log_unresolvable_specifier(const char *filename
, unsigned line
) {
255 static bool notified
= false;
257 /* In system mode, this is called when /etc is not fully initialized (e.g.
258 * in a chroot environment) where some specifiers are unresolvable. In user
259 * mode, this is called when some variables are not defined. These cases are
260 * not considered as an error so log at LOG_NOTICE only for the first time
261 * and then downgrade this to LOG_DEBUG for the rest. */
263 log_full(notified
? LOG_DEBUG
: LOG_NOTICE
,
264 "[%s:%u] Failed to resolve specifier: %s, skipping",
266 arg_user
? "Required $XDG_... variable not defined" : "uninitialized /etc detected");
269 log_notice("All rules containing unresolvable specifiers will be skipped.");
275 static int user_config_paths(char*** ret
) {
276 _cleanup_strv_free_
char **config_dirs
= NULL
, **data_dirs
= NULL
;
277 _cleanup_free_
char *persistent_config
= NULL
, *runtime_config
= NULL
, *data_home
= NULL
;
278 _cleanup_strv_free_
char **res
= NULL
;
281 r
= xdg_user_dirs(&config_dirs
, &data_dirs
);
285 r
= xdg_user_config_dir(&persistent_config
, "/user-tmpfiles.d");
286 if (r
< 0 && r
!= -ENXIO
)
289 r
= xdg_user_runtime_dir(&runtime_config
, "/user-tmpfiles.d");
290 if (r
< 0 && r
!= -ENXIO
)
293 r
= xdg_user_data_dir(&data_home
, "/user-tmpfiles.d");
294 if (r
< 0 && r
!= -ENXIO
)
297 r
= strv_extend_strv_concat(&res
, config_dirs
, "/user-tmpfiles.d");
301 r
= strv_extend(&res
, persistent_config
);
305 r
= strv_extend(&res
, runtime_config
);
309 r
= strv_extend(&res
, data_home
);
313 r
= strv_extend_strv_concat(&res
, data_dirs
, "/user-tmpfiles.d");
317 r
= path_strv_make_absolute_cwd(res
);
321 *ret
= TAKE_PTR(res
);
325 static bool needs_glob(ItemType t
) {
329 IGNORE_DIRECTORY_PATH
,
331 RECURSIVE_REMOVE_PATH
,
335 RECURSIVE_RELABEL_PATH
,
341 RECURSIVE_SET_ATTRIBUTE
);
344 static bool takes_ownership(ItemType t
) {
352 CREATE_SUBVOLUME_INHERIT_QUOTA
,
353 CREATE_SUBVOLUME_NEW_QUOTA
,
361 IGNORE_DIRECTORY_PATH
,
363 RECURSIVE_REMOVE_PATH
);
366 static struct Item
* find_glob(OrderedHashmap
*h
, const char *match
) {
370 ORDERED_HASHMAP_FOREACH(j
, h
, i
) {
373 for (n
= 0; n
< j
->n_items
; n
++) {
374 Item
*item
= j
->items
+ n
;
376 if (fnmatch(item
->path
, match
, FNM_PATHNAME
|FNM_PERIOD
) == 0)
384 static int load_unix_sockets(void) {
385 _cleanup_set_free_free_ Set
*sockets
= NULL
;
386 _cleanup_fclose_
FILE *f
= NULL
;
392 /* We maintain a cache of the sockets we found in /proc/net/unix to speed things up a little. */
394 sockets
= set_new(&path_hash_ops
);
398 f
= fopen("/proc/net/unix", "re");
400 return log_full_errno(errno
== ENOENT
? LOG_DEBUG
: LOG_WARNING
, errno
,
401 "Failed to open /proc/net/unix, ignoring: %m");
404 r
= read_line(f
, LONG_LINE_MAX
, NULL
);
406 return log_warning_errno(r
, "Failed to skip /proc/net/unix header line: %m");
408 return log_warning_errno(SYNTHETIC_ERRNO(EIO
), "Premature end of file reading /proc/net/unix.");
411 _cleanup_free_
char *line
= NULL
, *s
= NULL
;
414 r
= read_line(f
, LONG_LINE_MAX
, &line
);
416 return log_warning_errno(r
, "Failed to read /proc/net/unix line, ignoring: %m");
417 if (r
== 0) /* EOF */
420 p
= strchr(line
, ':');
428 p
+= strspn(p
, WHITESPACE
);
429 p
+= strcspn(p
, WHITESPACE
); /* skip one more word */
430 p
+= strspn(p
, WHITESPACE
);
439 path_simplify(s
, false);
441 r
= set_consume(sockets
, s
);
445 return log_warning_errno(r
, "Failed to add AF_UNIX socket to set, ignoring: %m");
450 unix_sockets
= TAKE_PTR(sockets
);
454 static bool unix_socket_alive(const char *fn
) {
457 if (load_unix_sockets() < 0)
458 return true; /* We don't know, so assume yes */
460 return !!set_get(unix_sockets
, (char*) fn
);
463 static DIR* xopendirat_nomod(int dirfd
, const char *path
) {
466 dir
= xopendirat(dirfd
, path
, O_NOFOLLOW
|O_NOATIME
);
470 log_debug_errno(errno
, "Cannot open %sdirectory \"%s\": %m", dirfd
== AT_FDCWD
? "" : "sub", path
);
474 dir
= xopendirat(dirfd
, path
, O_NOFOLLOW
);
476 log_debug_errno(errno
, "Cannot open %sdirectory \"%s\": %m", dirfd
== AT_FDCWD
? "" : "sub", path
);
481 static DIR* opendir_nomod(const char *path
) {
482 return xopendirat_nomod(AT_FDCWD
, path
);
485 static int dir_cleanup(
489 const struct stat
*ds
,
494 bool keep_this_level
) {
497 bool deleted
= false;
500 FOREACH_DIRENT_ALL(dent
, d
, break) {
503 _cleanup_free_
char *sub_path
= NULL
;
505 if (dot_or_dot_dot(dent
->d_name
))
508 if (fstatat(dirfd(d
), dent
->d_name
, &s
, AT_SYMLINK_NOFOLLOW
) < 0) {
512 /* FUSE, NFS mounts, SELinux might return EACCES */
513 r
= log_full_errno(errno
== EACCES
? LOG_DEBUG
: LOG_ERR
, errno
,
514 "stat(%s/%s) failed: %m", p
, dent
->d_name
);
518 /* Stay on the same filesystem */
519 if (s
.st_dev
!= rootdev
) {
520 log_debug("Ignoring \"%s/%s\": different filesystem.", p
, dent
->d_name
);
524 /* Try to detect bind mounts of the same filesystem instance; they
525 * do not differ in device major/minors. This type of query is not
526 * supported on all kernels or filesystem types though. */
527 if (S_ISDIR(s
.st_mode
)) {
530 q
= fd_is_mount_point(dirfd(d
), dent
->d_name
, 0);
532 log_debug_errno(q
, "Failed to determine whether \"%s/%s\" is a mount point, ignoring: %m", p
, dent
->d_name
);
534 log_debug("Ignoring \"%s/%s\": different mount of the same filesystem.", p
, dent
->d_name
);
539 sub_path
= path_join(p
, dent
->d_name
);
545 /* Is there an item configured for this path? */
546 if (ordered_hashmap_get(items
, sub_path
)) {
547 log_debug("Ignoring \"%s\": a separate entry exists.", sub_path
);
551 if (find_glob(globs
, sub_path
)) {
552 log_debug("Ignoring \"%s\": a separate glob exists.", sub_path
);
556 if (S_ISDIR(s
.st_mode
)) {
557 _cleanup_closedir_
DIR *sub_dir
= NULL
;
560 streq(dent
->d_name
, "lost+found") &&
562 log_debug("Ignoring directory \"%s\".", sub_path
);
567 log_warning("Reached max depth on \"%s\".", sub_path
);
571 sub_dir
= xopendirat_nomod(dirfd(d
), dent
->d_name
);
574 r
= log_warning_errno(errno
, "Opening directory \"%s\" failed, ignoring: %m", sub_path
);
579 if (flock(dirfd(sub_dir
), LOCK_EX
|LOCK_NB
) < 0) {
580 log_debug_errno(errno
, "Couldn't acquire shared BSD lock on directory \"%s\", skipping: %m", p
);
584 q
= dir_cleanup(i
, sub_path
, sub_dir
, &s
, cutoff
, rootdev
, false, maxdepth
-1, false);
589 /* Note: if you are wondering why we don't support the sticky bit for excluding
590 * directories from cleaning like we do it for other file system objects: well, the
591 * sticky bit already has a meaning for directories, so we don't want to overload
594 if (keep_this_level
) {
595 log_debug("Keeping directory \"%s\".", sub_path
);
599 /* Ignore ctime, we change it when deleting */
600 age
= timespec_load(&s
.st_mtim
);
602 char a
[FORMAT_TIMESTAMP_MAX
];
603 /* Follows spelling in stat(1). */
604 log_debug("Directory \"%s\": modify time %s is too new.",
606 format_timestamp_us(a
, sizeof(a
), age
));
610 age
= timespec_load(&s
.st_atim
);
612 char a
[FORMAT_TIMESTAMP_MAX
];
613 log_debug("Directory \"%s\": access time %s is too new.",
615 format_timestamp_us(a
, sizeof(a
), age
));
619 log_debug("Removing directory \"%s\".", sub_path
);
620 if (unlinkat(dirfd(d
), dent
->d_name
, AT_REMOVEDIR
) < 0)
621 if (!IN_SET(errno
, ENOENT
, ENOTEMPTY
))
622 r
= log_warning_errno(errno
, "Failed to remove directory \"%s\", ignoring: %m", sub_path
);
625 /* Skip files for which the sticky bit is set. These are semantics we define, and are
626 * unknown elsewhere. See XDG_RUNTIME_DIR specification for details. */
627 if (s
.st_mode
& S_ISVTX
) {
628 log_debug("Skipping \"%s\": sticky bit set.", sub_path
);
633 S_ISREG(s
.st_mode
) &&
635 STR_IN_SET(dent
->d_name
,
639 log_debug("Skipping \"%s\".", sub_path
);
643 /* Ignore sockets that are listed in /proc/net/unix */
644 if (S_ISSOCK(s
.st_mode
) && unix_socket_alive(sub_path
)) {
645 log_debug("Skipping \"%s\": live socket.", sub_path
);
649 /* Ignore device nodes */
650 if (S_ISCHR(s
.st_mode
) || S_ISBLK(s
.st_mode
)) {
651 log_debug("Skipping \"%s\": a device.", sub_path
);
655 /* Keep files on this level around if this is requested */
656 if (keep_this_level
) {
657 log_debug("Keeping \"%s\".", sub_path
);
661 age
= timespec_load(&s
.st_mtim
);
663 char a
[FORMAT_TIMESTAMP_MAX
];
664 /* Follows spelling in stat(1). */
665 log_debug("File \"%s\": modify time %s is too new.",
667 format_timestamp_us(a
, sizeof(a
), age
));
671 age
= timespec_load(&s
.st_atim
);
673 char a
[FORMAT_TIMESTAMP_MAX
];
674 log_debug("File \"%s\": access time %s is too new.",
676 format_timestamp_us(a
, sizeof(a
), age
));
680 age
= timespec_load(&s
.st_ctim
);
682 char a
[FORMAT_TIMESTAMP_MAX
];
683 log_debug("File \"%s\": change time %s is too new.",
685 format_timestamp_us(a
, sizeof(a
), age
));
689 log_debug("Removing \"%s\".", sub_path
);
690 if (unlinkat(dirfd(d
), dent
->d_name
, 0) < 0)
692 r
= log_warning_errno(errno
, "Failed to remove \"%s\", ignoring: %m", sub_path
);
700 char a
[FORMAT_TIMESTAMP_MAX
], b
[FORMAT_TIMESTAMP_MAX
];
703 age1
= timespec_load(&ds
->st_atim
);
704 age2
= timespec_load(&ds
->st_mtim
);
706 log_debug("Restoring access and modification time on \"%s\": %s, %s",
708 format_timestamp_us(a
, sizeof(a
), age1
),
709 format_timestamp_us(b
, sizeof(b
), age2
));
711 /* Restore original directory timestamps */
712 if (futimens(dirfd(d
), (struct timespec
[]) {
715 log_warning_errno(errno
, "Failed to revert timestamps of '%s', ignoring: %m", p
);
721 static bool dangerous_hardlinks(void) {
722 _cleanup_free_
char *value
= NULL
;
723 static int cached
= -1;
726 /* Check whether the fs.protected_hardlinks sysctl is on. If we can't determine it we assume its off, as that's
727 * what the upstream default is. */
732 r
= read_one_line_file("/proc/sys/fs/protected_hardlinks", &value
);
734 log_debug_errno(r
, "Failed to read fs.protected_hardlinks sysctl: %m");
738 r
= parse_boolean(value
);
740 log_debug_errno(r
, "Failed to parse fs.protected_hardlinks sysctl: %m");
748 static bool hardlink_vulnerable(const struct stat
*st
) {
751 return !S_ISDIR(st
->st_mode
) && st
->st_nlink
> 1 && dangerous_hardlinks();
754 static mode_t
process_mask_perms(mode_t mode
, mode_t current
) {
756 if ((current
& 0111) == 0)
758 if ((current
& 0222) == 0)
760 if ((current
& 0444) == 0)
762 if (!S_ISDIR(current
))
763 mode
&= ~07000; /* remove sticky/sgid/suid bit, unless directory */
768 static int fd_set_perms(Item
*i
, int fd
, const char *path
, const struct stat
*st
) {
777 if (!i
->mode_set
&& !i
->uid_set
&& !i
->gid_set
)
781 if (fstat(fd
, &stbuf
) < 0)
782 return log_error_errno(errno
, "fstat(%s) failed: %m", path
);
786 if (hardlink_vulnerable(st
))
787 return log_error_errno(SYNTHETIC_ERRNO(EPERM
),
788 "Refusing to set permissions on hardlinked file %s while the fs.protected_hardlinks sysctl is turned off.",
791 /* Do we need a chown()? */
793 (i
->uid_set
&& i
->uid
!= st
->st_uid
) ||
794 (i
->gid_set
&& i
->gid
!= st
->st_gid
);
796 /* Calculate the mode to apply */
797 new_mode
= i
->mode_set
? (i
->mask_perms
?
798 process_mask_perms(i
->mode
, st
->st_mode
) :
800 (st
->st_mode
& 07777);
802 if (i
->mode_set
&& do_chown
) {
803 /* Before we issue the chmod() let's reduce the access mode to the common bits of the old and
804 * the new mode. That way there's no time window where the file exists under the old owner
805 * with more than the old access modes — and not under the new owner with more than the new
806 * access modes either. */
808 if (S_ISLNK(st
->st_mode
))
809 log_debug("Skipping temporary mode fix for symlink %s.", path
);
811 mode_t m
= new_mode
& st
->st_mode
; /* Mask new mode by old mode */
813 if (((m
^ st
->st_mode
) & 07777) == 0)
814 log_debug("\"%s\" matches temporary mode %o already.", path
, m
);
816 log_debug("Temporarily changing \"%s\" to mode %o.", path
, m
);
817 if (fchmod_opath(fd
, m
) < 0)
818 return log_error_errno(errno
, "fchmod() of %s failed: %m", path
);
824 log_debug("Changing \"%s\" to owner "UID_FMT
":"GID_FMT
,
826 i
->uid_set
? i
->uid
: UID_INVALID
,
827 i
->gid_set
? i
->gid
: GID_INVALID
);
831 i
->uid_set
? i
->uid
: UID_INVALID
,
832 i
->gid_set
? i
->gid
: GID_INVALID
,
834 return log_error_errno(errno
, "fchownat() of %s failed: %m", path
);
837 /* Now, apply the final mode. We do this in two cases: when the user set a mode explicitly, or after a
838 * chown(), since chown()'s mangle the access mode in regards to sgid/suid in some conditions. */
839 if (i
->mode_set
|| do_chown
) {
840 if (S_ISLNK(st
->st_mode
))
841 log_debug("Skipping mode fix for symlink %s.", path
);
843 /* Check if the chmod() is unnecessary. Note that if we did a chown() before we always
844 * chmod() here again, since it might have mangled the bits. */
845 if (!do_chown
&& ((new_mode
^ st
->st_mode
) & 07777) == 0)
846 log_debug("\"%s\" matches mode %o already.", path
, new_mode
);
848 log_debug("Changing \"%s\" to mode %o.", path
, new_mode
);
849 if (fchmod_opath(fd
, new_mode
) < 0)
850 return log_error_errno(errno
, "fchmod() of %s failed: %m", path
);
856 return label_fix(path
, 0);
859 static int path_open_parent_safe(const char *path
) {
860 _cleanup_free_
char *dn
= NULL
;
863 if (path_equal(path
, "/") || !path_is_normalized(path
))
864 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
865 "Failed to open parent of '%s': invalid path.",
868 dn
= dirname_malloc(path
);
872 r
= chase_symlinks(dn
, arg_root
, CHASE_SAFE
|CHASE_WARN
, NULL
, &fd
);
873 if (r
< 0 && r
!= -ENOLINK
)
874 return log_error_errno(r
, "Failed to validate path %s: %m", path
);
876 return r
< 0 ? r
: fd
;
879 static int path_open_safe(const char *path
) {
882 /* path_open_safe() returns a file descriptor opened with O_PATH after
883 * verifying that the path doesn't contain unsafe transitions, except
884 * for its final component as the function does not follow symlink. */
888 if (!path_is_normalized(path
))
889 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
890 "Failed to open invalid path '%s'.",
893 r
= chase_symlinks(path
, arg_root
, CHASE_SAFE
|CHASE_WARN
|CHASE_NOFOLLOW
, NULL
, &fd
);
894 if (r
< 0 && r
!= -ENOLINK
)
895 return log_error_errno(r
, "Failed to validate path %s: %m", path
);
897 return r
< 0 ? r
: fd
;
900 static int path_set_perms(Item
*i
, const char *path
) {
901 _cleanup_close_
int fd
= -1;
906 fd
= path_open_safe(path
);
910 return fd_set_perms(i
, fd
, path
, NULL
);
913 static int parse_xattrs_from_arg(Item
*i
) {
923 _cleanup_free_
char *name
= NULL
, *value
= NULL
, *xattr
= NULL
;
925 r
= extract_first_word(&p
, &xattr
, NULL
, EXTRACT_UNQUOTE
|EXTRACT_CUNESCAPE
);
927 log_warning_errno(r
, "Failed to parse extended attribute '%s', ignoring: %m", p
);
931 r
= split_pair(xattr
, "=", &name
, &value
);
933 log_warning_errno(r
, "Failed to parse extended attribute, ignoring: %s", xattr
);
937 if (isempty(name
) || isempty(value
)) {
938 log_warning("Malformed extended attribute found, ignoring: %s", xattr
);
942 if (strv_push_pair(&i
->xattrs
, name
, value
) < 0)
951 static int fd_set_xattrs(Item
*i
, int fd
, const char *path
, const struct stat
*st
) {
952 char procfs_path
[STRLEN("/proc/self/fd/") + DECIMAL_STR_MAX(int)];
953 char **name
, **value
;
959 xsprintf(procfs_path
, "/proc/self/fd/%i", fd
);
961 STRV_FOREACH_PAIR(name
, value
, i
->xattrs
) {
962 log_debug("Setting extended attribute '%s=%s' on %s.", *name
, *value
, path
);
963 if (setxattr(procfs_path
, *name
, *value
, strlen(*value
), 0) < 0)
964 return log_error_errno(errno
, "Setting extended attribute %s=%s on %s failed: %m",
965 *name
, *value
, path
);
970 static int path_set_xattrs(Item
*i
, const char *path
) {
971 _cleanup_close_
int fd
= -1;
976 fd
= path_open_safe(path
);
980 return fd_set_xattrs(i
, fd
, path
, NULL
);
983 static int parse_acls_from_arg(Item
*item
) {
989 /* If append_or_force (= modify) is set, we will not modify the acl
990 * afterwards, so the mask can be added now if necessary. */
992 r
= parse_acl(item
->argument
, &item
->acl_access
, &item
->acl_default
, !item
->append_or_force
);
994 log_warning_errno(r
, "Failed to parse ACL \"%s\": %m. Ignoring", item
->argument
);
996 log_warning_errno(SYNTHETIC_ERRNO(ENOSYS
), "ACLs are not supported. Ignoring");
1003 static int path_set_acl(const char *path
, const char *pretty
, acl_type_t type
, acl_t acl
, bool modify
) {
1004 _cleanup_(acl_free_charpp
) char *t
= NULL
;
1005 _cleanup_(acl_freep
) acl_t dup
= NULL
;
1008 /* Returns 0 for success, positive error if already warned,
1009 * negative error otherwise. */
1012 r
= acls_for_file(path
, type
, acl
, &dup
);
1016 r
= calc_acl_mask_if_needed(&dup
);
1024 /* the mask was already added earlier if needed */
1027 r
= add_base_acls_if_needed(&dup
, path
);
1031 t
= acl_to_any_text(dup
, NULL
, ',', TEXT_ABBREVIATE
);
1032 log_debug("Setting %s ACL %s on %s.",
1033 type
== ACL_TYPE_ACCESS
? "access" : "default",
1036 r
= acl_set_file(path
, type
, dup
);
1038 /* Return positive to indicate we already warned */
1039 return -log_error_errno(errno
,
1040 "Setting %s ACL \"%s\" on %s failed: %m",
1041 type
== ACL_TYPE_ACCESS
? "access" : "default",
1048 static int fd_set_acls(Item
*item
, int fd
, const char *path
, const struct stat
*st
) {
1051 char procfs_path
[STRLEN("/proc/self/fd/") + DECIMAL_STR_MAX(int)];
1059 if (fstat(fd
, &stbuf
) < 0)
1060 return log_error_errno(errno
, "fstat(%s) failed: %m", path
);
1064 if (hardlink_vulnerable(st
))
1065 return log_error_errno(SYNTHETIC_ERRNO(EPERM
),
1066 "Refusing to set ACLs on hardlinked file %s while the fs.protected_hardlinks sysctl is turned off.",
1069 if (S_ISLNK(st
->st_mode
)) {
1070 log_debug("Skipping ACL fix for symlink %s.", path
);
1074 xsprintf(procfs_path
, "/proc/self/fd/%i", fd
);
1076 if (item
->acl_access
)
1077 r
= path_set_acl(procfs_path
, path
, ACL_TYPE_ACCESS
, item
->acl_access
, item
->append_or_force
);
1079 /* set only default acls to folders */
1080 if (r
== 0 && item
->acl_default
&& S_ISDIR(st
->st_mode
))
1081 r
= path_set_acl(procfs_path
, path
, ACL_TYPE_DEFAULT
, item
->acl_default
, item
->append_or_force
);
1084 return -r
; /* already warned */
1085 if (r
== -EOPNOTSUPP
) {
1086 log_debug_errno(r
, "ACLs not supported by file system at %s", path
);
1090 return log_error_errno(r
, "ACL operation on \"%s\" failed: %m", path
);
1095 static int path_set_acls(Item
*item
, const char *path
) {
1098 _cleanup_close_
int fd
= -1;
1103 fd
= path_open_safe(path
);
1107 r
= fd_set_acls(item
, fd
, path
, NULL
);
1112 static int parse_attribute_from_arg(Item
*item
) {
1114 static const struct {
1118 { 'A', FS_NOATIME_FL
}, /* do not update atime */
1119 { 'S', FS_SYNC_FL
}, /* Synchronous updates */
1120 { 'D', FS_DIRSYNC_FL
}, /* dirsync behaviour (directories only) */
1121 { 'a', FS_APPEND_FL
}, /* writes to file may only append */
1122 { 'c', FS_COMPR_FL
}, /* Compress file */
1123 { 'd', FS_NODUMP_FL
}, /* do not dump file */
1124 { 'e', FS_EXTENT_FL
}, /* Extents */
1125 { 'i', FS_IMMUTABLE_FL
}, /* Immutable file */
1126 { 'j', FS_JOURNAL_DATA_FL
}, /* Reserved for ext3 */
1127 { 's', FS_SECRM_FL
}, /* Secure deletion */
1128 { 'u', FS_UNRM_FL
}, /* Undelete */
1129 { 't', FS_NOTAIL_FL
}, /* file tail should not be merged */
1130 { 'T', FS_TOPDIR_FL
}, /* Top of directory hierarchies */
1131 { 'C', FS_NOCOW_FL
}, /* Do not cow file */
1132 { 'P', FS_PROJINHERIT_FL
}, /* Inherit the quota project ID */
1141 unsigned value
= 0, mask
= 0;
1151 } else if (*p
== '-') {
1154 } else if (*p
== '=') {
1160 if (isempty(p
) && mode
!= MODE_SET
)
1161 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
1162 "Setting file attribute on '%s' needs an attribute specification.",
1165 for (; p
&& *p
; p
++) {
1168 for (i
= 0; i
< ELEMENTSOF(attributes
); i
++)
1169 if (*p
== attributes
[i
].character
)
1172 if (i
>= ELEMENTSOF(attributes
))
1173 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
1174 "Unknown file attribute '%c' on '%s'.",
1177 v
= attributes
[i
].value
;
1179 SET_FLAG(value
, v
, IN_SET(mode
, MODE_ADD
, MODE_SET
));
1184 if (mode
== MODE_SET
)
1185 mask
|= CHATTR_ALL_FL
;
1189 item
->attribute_mask
= mask
;
1190 item
->attribute_value
= value
;
1191 item
->attribute_set
= true;
1196 static int fd_set_attribute(Item
*item
, int fd
, const char *path
, const struct stat
*st
) {
1197 _cleanup_close_
int procfs_fd
= -1;
1206 if (!item
->attribute_set
|| item
->attribute_mask
== 0)
1210 if (fstat(fd
, &stbuf
) < 0)
1211 return log_error_errno(errno
, "fstat(%s) failed: %m", path
);
1215 /* Issuing the file attribute ioctls on device nodes is not
1216 * safe, as that will be delivered to the drivers, not the
1217 * file system containing the device node. */
1218 if (!S_ISREG(st
->st_mode
) && !S_ISDIR(st
->st_mode
))
1219 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
1220 "Setting file flags is only supported on regular files and directories, cannot set on '%s'.",
1223 f
= item
->attribute_value
& item
->attribute_mask
;
1225 /* Mask away directory-specific flags */
1226 if (!S_ISDIR(st
->st_mode
))
1227 f
&= ~FS_DIRSYNC_FL
;
1229 procfs_fd
= fd_reopen(fd
, O_RDONLY
|O_CLOEXEC
|O_NOATIME
);
1231 return log_error_errno(procfs_fd
, "Failed to re-open '%s': %m", path
);
1233 r
= chattr_fd(procfs_fd
, f
, item
->attribute_mask
, NULL
);
1235 log_full_errno(IN_SET(r
, -ENOTTY
, -EOPNOTSUPP
) ? LOG_DEBUG
: LOG_WARNING
,
1237 "Cannot set file attribute for '%s', value=0x%08x, mask=0x%08x, ignoring: %m",
1238 path
, item
->attribute_value
, item
->attribute_mask
);
1243 static int path_set_attribute(Item
*item
, const char *path
) {
1244 _cleanup_close_
int fd
= -1;
1246 if (!item
->attribute_set
|| item
->attribute_mask
== 0)
1249 fd
= path_open_safe(path
);
1253 return fd_set_attribute(item
, fd
, path
, NULL
);
1256 static int write_one_file(Item
*i
, const char *path
) {
1257 _cleanup_close_
int fd
= -1, dir_fd
= -1;
1263 assert(i
->argument
);
1264 assert(i
->type
== WRITE_FILE
);
1266 /* Validate the path and keep the fd on the directory for opening the
1267 * file so we're sure that it can't be changed behind our back. */
1268 dir_fd
= path_open_parent_safe(path
);
1272 bn
= basename(path
);
1274 flags
= O_NONBLOCK
|O_CLOEXEC
|O_WRONLY
|O_NOCTTY
;
1276 /* Follows symlinks */
1277 fd
= openat(dir_fd
, bn
, i
->append_or_force
? flags
|O_APPEND
: flags
, i
->mode
);
1279 if (errno
== ENOENT
) {
1280 log_debug_errno(errno
, "Not writing missing file \"%s\": %m", path
);
1283 return log_error_errno(errno
, "Failed to open file \"%s\": %m", path
);
1286 /* 'w' is allowed to write into any kind of files. */
1287 log_debug("Writing to \"%s\".", path
);
1289 r
= loop_write(fd
, i
->argument
, strlen(i
->argument
), false);
1291 return log_error_errno(r
, "Failed to write file \"%s\": %m", path
);
1293 return fd_set_perms(i
, fd
, path
, NULL
);
1296 static int create_file(Item
*i
, const char *path
) {
1297 _cleanup_close_
int fd
= -1, dir_fd
= -1;
1298 struct stat stbuf
, *st
= NULL
;
1304 assert(i
->type
== CREATE_FILE
);
1306 /* 'f' operates on regular files exclusively. */
1308 /* Validate the path and keep the fd on the directory for opening the
1309 * file so we're sure that it can't be changed behind our back. */
1310 dir_fd
= path_open_parent_safe(path
);
1314 bn
= basename(path
);
1316 RUN_WITH_UMASK(0000) {
1317 mac_selinux_create_file_prepare(path
, S_IFREG
);
1318 fd
= openat(dir_fd
, bn
, O_CREAT
|O_EXCL
|O_NOFOLLOW
|O_NONBLOCK
|O_CLOEXEC
|O_WRONLY
|O_NOCTTY
, i
->mode
);
1319 mac_selinux_create_file_clear();
1323 /* Even on a read-only filesystem, open(2) returns EEXIST if the
1324 * file already exists. It returns EROFS only if it needs to
1325 * create the file. */
1326 if (errno
!= EEXIST
)
1327 return log_error_errno(errno
, "Failed to create file %s: %m", path
);
1329 /* Re-open the file. At that point it must exist since open(2)
1330 * failed with EEXIST. We still need to check if the perms/mode
1331 * need to be changed. For read-only filesystems, we let
1332 * fd_set_perms() report the error if the perms need to be
1334 fd
= openat(dir_fd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
, i
->mode
);
1336 return log_error_errno(errno
, "Failed to re-open file %s: %m", path
);
1338 if (fstat(fd
, &stbuf
) < 0)
1339 return log_error_errno(errno
, "stat(%s) failed: %m", path
);
1341 if (!S_ISREG(stbuf
.st_mode
)) {
1342 log_error("%s exists and is not a regular file.", path
);
1349 log_debug("\"%s\" has been created.", path
);
1352 log_debug("Writing to \"%s\".", path
);
1354 r
= loop_write(fd
, i
->argument
, strlen(i
->argument
), false);
1356 return log_error_errno(r
, "Failed to write file \"%s\": %m", path
);
1360 return fd_set_perms(i
, fd
, path
, st
);
1363 static int truncate_file(Item
*i
, const char *path
) {
1364 _cleanup_close_
int fd
= -1, dir_fd
= -1;
1365 struct stat stbuf
, *st
= NULL
;
1372 assert(i
->type
== TRUNCATE_FILE
);
1374 /* We want to operate on regular file exclusively especially since
1375 * O_TRUNC is unspecified if the file is neither a regular file nor a
1376 * fifo nor a terminal device. Therefore we first open the file and make
1377 * sure it's a regular one before truncating it. */
1379 /* Validate the path and keep the fd on the directory for opening the
1380 * file so we're sure that it can't be changed behind our back. */
1381 dir_fd
= path_open_parent_safe(path
);
1385 bn
= basename(path
);
1387 RUN_WITH_UMASK(0000) {
1388 mac_selinux_create_file_prepare(path
, S_IFREG
);
1389 fd
= openat(dir_fd
, bn
, O_CREAT
|O_NOFOLLOW
|O_NONBLOCK
|O_CLOEXEC
|O_WRONLY
|O_NOCTTY
, i
->mode
);
1390 mac_selinux_create_file_clear();
1395 return log_error_errno(errno
, "Failed to open/create file %s: %m", path
);
1397 /* On a read-only filesystem, we don't want to fail if the
1398 * target is already empty and the perms are set. So we still
1399 * proceed with the sanity checks and let the remaining
1400 * operations fail with EROFS if they try to modify the target
1403 fd
= openat(dir_fd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
, i
->mode
);
1405 if (errno
== ENOENT
) {
1406 log_error("Cannot create file %s on a read-only file system.", path
);
1410 return log_error_errno(errno
, "Failed to re-open file %s: %m", path
);
1416 if (fstat(fd
, &stbuf
) < 0)
1417 return log_error_errno(errno
, "stat(%s) failed: %m", path
);
1419 if (!S_ISREG(stbuf
.st_mode
)) {
1420 log_error("%s exists and is not a regular file.", path
);
1424 if (stbuf
.st_size
> 0) {
1425 if (ftruncate(fd
, 0) < 0) {
1426 r
= erofs
? -EROFS
: -errno
;
1427 return log_error_errno(r
, "Failed to truncate file %s: %m", path
);
1432 log_debug("\"%s\" has been created.", path
);
1435 log_debug("Writing to \"%s\".", path
);
1437 r
= loop_write(fd
, i
->argument
, strlen(i
->argument
), false);
1439 r
= erofs
? -EROFS
: r
;
1440 return log_error_errno(r
, "Failed to write file %s: %m", path
);
1444 return fd_set_perms(i
, fd
, path
, st
);
1447 static int copy_files(Item
*i
) {
1448 _cleanup_close_
int dfd
= -1, fd
= -1;
1452 log_debug("Copying tree \"%s\" to \"%s\".", i
->argument
, i
->path
);
1454 bn
= basename(i
->path
);
1456 /* Validate the path and use the returned directory fd for copying the
1457 * target so we're sure that the path can't be changed behind our
1459 dfd
= path_open_parent_safe(i
->path
);
1463 r
= copy_tree_at(AT_FDCWD
, i
->argument
,
1465 i
->uid_set
? i
->uid
: UID_INVALID
,
1466 i
->gid_set
? i
->gid
: GID_INVALID
,
1467 COPY_REFLINK
| COPY_MERGE_EMPTY
);
1471 /* If the target already exists on read-only filesystems, trying
1472 * to create the target will not fail with EEXIST but with
1474 if (r
== -EROFS
&& faccessat(dfd
, bn
, F_OK
, AT_SYMLINK_NOFOLLOW
) == 0)
1478 return log_error_errno(r
, "Failed to copy files to %s: %m", i
->path
);
1480 if (stat(i
->argument
, &a
) < 0)
1481 return log_error_errno(errno
, "stat(%s) failed: %m", i
->argument
);
1483 if (fstatat(dfd
, bn
, &b
, AT_SYMLINK_NOFOLLOW
) < 0)
1484 return log_error_errno(errno
, "stat(%s) failed: %m", i
->path
);
1486 if ((a
.st_mode
^ b
.st_mode
) & S_IFMT
) {
1487 log_debug("Can't copy to %s, file exists already and is of different type", i
->path
);
1492 fd
= openat(dfd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
);
1494 return log_error_errno(errno
, "Failed to openat(%s): %m", i
->path
);
1496 return fd_set_perms(i
, fd
, i
->path
, NULL
);
1504 _CREATION_MODE_INVALID
= -1
1507 static const char *const creation_mode_verb_table
[_CREATION_MODE_MAX
] = {
1508 [CREATION_NORMAL
] = "Created",
1509 [CREATION_EXISTING
] = "Found existing",
1510 [CREATION_FORCE
] = "Created replacement",
1513 DEFINE_PRIVATE_STRING_TABLE_LOOKUP_TO_STRING(creation_mode_verb
, CreationMode
);
1515 static int create_directory_or_subvolume(const char *path
, mode_t mode
, bool subvol
, CreationMode
*creation
) {
1516 _cleanup_close_
int pfd
= -1;
1525 pfd
= path_open_parent_safe(path
);
1530 if (btrfs_is_subvol(empty_to_root(arg_root
)) <= 0)
1532 /* Don't create a subvolume unless the root directory is
1533 * one, too. We do this under the assumption that if the
1534 * root directory is just a plain directory (i.e. very
1535 * light-weight), we shouldn't try to split it up into
1536 * subvolumes (i.e. more heavy-weight). Thus, chroot()
1537 * environments and suchlike will get a full brtfs
1538 * subvolume set up below their tree only if they
1539 * specifically set up a btrfs subvolume for the root
1544 RUN_WITH_UMASK((~mode
) & 0777)
1545 r
= btrfs_subvol_make_fd(pfd
, basename(path
));
1550 if (!subvol
|| r
== -ENOTTY
)
1551 RUN_WITH_UMASK(0000)
1552 r
= mkdirat_label(pfd
, basename(path
), mode
);
1557 if (!IN_SET(r
, -EEXIST
, -EROFS
))
1558 return log_error_errno(r
, "Failed to create directory or subvolume \"%s\": %m", path
);
1561 if (k
== -ENOENT
&& r
== -EROFS
)
1562 return log_error_errno(r
, "%s does not exist and cannot be created as the file system is read-only.", path
);
1564 return log_error_errno(k
, "Failed to check if %s exists: %m", path
);
1566 log_warning("\"%s\" already exists and is not a directory.", path
);
1570 *creation
= CREATION_EXISTING
;
1572 *creation
= CREATION_NORMAL
;
1574 log_debug("%s directory \"%s\".", creation_mode_verb_to_string(*creation
), path
);
1576 r
= openat(pfd
, basename(path
), O_NOCTTY
|O_CLOEXEC
|O_DIRECTORY
);
1578 return log_error_errno(errno
, "Failed to open directory '%s': %m", basename(path
));
1583 static int create_directory(Item
*i
, const char *path
) {
1584 _cleanup_close_
int fd
= -1;
1587 assert(IN_SET(i
->type
, CREATE_DIRECTORY
, TRUNCATE_DIRECTORY
));
1589 fd
= create_directory_or_subvolume(path
, i
->mode
, false, NULL
);
1595 return fd_set_perms(i
, fd
, path
, NULL
);
1598 static int create_subvolume(Item
*i
, const char *path
) {
1599 _cleanup_close_
int fd
= -1;
1600 CreationMode creation
;
1604 assert(IN_SET(i
->type
, CREATE_SUBVOLUME
, CREATE_SUBVOLUME_NEW_QUOTA
, CREATE_SUBVOLUME_INHERIT_QUOTA
));
1606 fd
= create_directory_or_subvolume(path
, i
->mode
, true, &creation
);
1612 if (creation
== CREATION_NORMAL
&&
1613 IN_SET(i
->type
, CREATE_SUBVOLUME_NEW_QUOTA
, CREATE_SUBVOLUME_INHERIT_QUOTA
)) {
1614 r
= btrfs_subvol_auto_qgroup_fd(fd
, 0, i
->type
== CREATE_SUBVOLUME_NEW_QUOTA
);
1616 log_debug_errno(r
, "Couldn't adjust quota for subvolume \"%s\" (unsupported fs or dir not a subvolume): %m", i
->path
);
1617 else if (r
== -EROFS
)
1618 log_debug_errno(r
, "Couldn't adjust quota for subvolume \"%s\" (fs is read-only).", i
->path
);
1619 else if (r
== -ENOPROTOOPT
)
1620 log_debug_errno(r
, "Couldn't adjust quota for subvolume \"%s\" (quota support is disabled).", i
->path
);
1622 q
= log_error_errno(r
, "Failed to adjust quota for subvolume \"%s\": %m", i
->path
);
1624 log_debug("Adjusted quota for subvolume \"%s\".", i
->path
);
1626 log_debug("Quota for subvolume \"%s\" already in place, no change made.", i
->path
);
1629 r
= fd_set_perms(i
, fd
, path
, NULL
);
1630 if (q
< 0) /* prefer the quota change error from above */
1636 static int empty_directory(Item
*i
, const char *path
) {
1640 assert(i
->type
== EMPTY_DIRECTORY
);
1642 r
= is_dir(path
, false);
1644 /* Option "e" operates only on existing objects. Do not
1645 * print errors about non-existent files or directories */
1646 log_debug("Skipping missing directory: %s", path
);
1650 return log_error_errno(r
, "is_dir() failed on path %s: %m", path
);
1652 return log_error_errno(SYNTHETIC_ERRNO(EEXIST
),
1653 "'%s' already exists and is not a directory.",
1656 return path_set_perms(i
, path
);
1659 static int create_device(Item
*i
, mode_t file_type
) {
1660 _cleanup_close_
int dfd
= -1, fd
= -1;
1661 CreationMode creation
;
1666 assert(IN_SET(file_type
, S_IFBLK
, S_IFCHR
));
1668 bn
= basename(i
->path
);
1670 /* Validate the path and use the returned directory fd for copying the
1671 * target so we're sure that the path can't be changed behind our
1673 dfd
= path_open_parent_safe(i
->path
);
1677 RUN_WITH_UMASK(0000) {
1678 mac_selinux_create_file_prepare(i
->path
, file_type
);
1679 r
= mknodat(dfd
, bn
, i
->mode
| file_type
, i
->major_minor
);
1680 mac_selinux_create_file_clear();
1686 if (errno
== EPERM
) {
1687 log_debug("We lack permissions, possibly because of cgroup configuration; "
1688 "skipping creation of device node %s.", i
->path
);
1692 if (errno
!= EEXIST
)
1693 return log_error_errno(errno
, "Failed to create device node %s: %m", i
->path
);
1695 if (fstatat(dfd
, bn
, &st
, 0) < 0)
1696 return log_error_errno(errno
, "stat(%s) failed: %m", i
->path
);
1698 if ((st
.st_mode
& S_IFMT
) != file_type
) {
1700 if (i
->append_or_force
) {
1702 RUN_WITH_UMASK(0000) {
1703 mac_selinux_create_file_prepare(i
->path
, file_type
);
1704 /* FIXME: need to introduce mknodat_atomic() */
1705 r
= mknod_atomic(i
->path
, i
->mode
| file_type
, i
->major_minor
);
1706 mac_selinux_create_file_clear();
1710 return log_error_errno(r
, "Failed to create device node \"%s\": %m", i
->path
);
1711 creation
= CREATION_FORCE
;
1713 log_debug("%s is not a device node.", i
->path
);
1717 creation
= CREATION_EXISTING
;
1719 creation
= CREATION_NORMAL
;
1721 log_debug("%s %s device node \"%s\" %u:%u.",
1722 creation_mode_verb_to_string(creation
),
1723 i
->type
== CREATE_BLOCK_DEVICE
? "block" : "char",
1724 i
->path
, major(i
->mode
), minor(i
->mode
));
1726 fd
= openat(dfd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
);
1728 return log_error_errno(errno
, "Failed to openat(%s): %m", i
->path
);
1730 return fd_set_perms(i
, fd
, i
->path
, NULL
);
1733 static int create_fifo(Item
*i
, const char *path
) {
1734 _cleanup_close_
int pfd
= -1, fd
= -1;
1735 CreationMode creation
;
1740 pfd
= path_open_parent_safe(path
);
1744 bn
= basename(path
);
1746 RUN_WITH_UMASK(0000) {
1747 mac_selinux_create_file_prepare(path
, S_IFIFO
);
1748 r
= mkfifoat(pfd
, bn
, i
->mode
);
1749 mac_selinux_create_file_clear();
1753 if (errno
!= EEXIST
)
1754 return log_error_errno(errno
, "Failed to create fifo %s: %m", path
);
1756 if (fstatat(pfd
, bn
, &st
, AT_SYMLINK_NOFOLLOW
) < 0)
1757 return log_error_errno(errno
, "stat(%s) failed: %m", path
);
1759 if (!S_ISFIFO(st
.st_mode
)) {
1761 if (i
->append_or_force
) {
1762 RUN_WITH_UMASK(0000) {
1763 mac_selinux_create_file_prepare(path
, S_IFIFO
);
1764 r
= mkfifoat_atomic(pfd
, bn
, i
->mode
);
1765 mac_selinux_create_file_clear();
1769 return log_error_errno(r
, "Failed to create fifo %s: %m", path
);
1770 creation
= CREATION_FORCE
;
1772 log_warning("\"%s\" already exists and is not a fifo.", path
);
1776 creation
= CREATION_EXISTING
;
1778 creation
= CREATION_NORMAL
;
1780 log_debug("%s fifo \"%s\".", creation_mode_verb_to_string(creation
), path
);
1782 fd
= openat(pfd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
);
1784 return log_error_errno(errno
, "Failed to openat(%s): %m", path
);
1786 return fd_set_perms(i
, fd
, i
->path
, NULL
);
1789 typedef int (*action_t
)(Item
*i
, const char *path
);
1790 typedef int (*fdaction_t
)(Item
*i
, int fd
, const char *path
, const struct stat
*st
);
1792 static int item_do(Item
*i
, int fd
, const char *path
, fdaction_t action
) {
1800 if (fstat(fd
, &st
) < 0) {
1801 r
= log_error_errno(errno
, "fstat() on file failed: %m");
1805 /* This returns the first error we run into, but nevertheless
1807 r
= action(i
, fd
, path
, &st
);
1809 if (S_ISDIR(st
.st_mode
)) {
1810 char procfs_path
[STRLEN("/proc/self/fd/") + DECIMAL_STR_MAX(int)];
1811 _cleanup_closedir_
DIR *d
= NULL
;
1814 /* The passed 'fd' was opened with O_PATH. We need to convert
1815 * it into a 'regular' fd before reading the directory content. */
1816 xsprintf(procfs_path
, "/proc/self/fd/%i", fd
);
1818 d
= opendir(procfs_path
);
1820 log_error_errno(errno
, "Failed to opendir() '%s': %m", procfs_path
);
1826 FOREACH_DIRENT_ALL(de
, d
, q
= -errno
; goto finish
) {
1829 if (dot_or_dot_dot(de
->d_name
))
1832 de_fd
= openat(fd
, de
->d_name
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
);
1834 q
= log_error_errno(errno
, "Failed to open() file '%s': %m", de
->d_name
);
1836 _cleanup_free_
char *de_path
= NULL
;
1838 de_path
= path_join(path
, de
->d_name
);
1842 /* Pass ownership of dirent fd over */
1843 q
= item_do(i
, de_fd
, de_path
, action
);
1846 if (q
< 0 && r
== 0)
1855 static int glob_item(Item
*i
, action_t action
) {
1856 _cleanup_globfree_ glob_t g
= {
1857 .gl_opendir
= (void *(*)(const char *)) opendir_nomod
,
1862 k
= safe_glob(i
->path
, GLOB_NOSORT
|GLOB_BRACE
, &g
);
1863 if (k
< 0 && k
!= -ENOENT
)
1864 return log_error_errno(k
, "glob(%s) failed: %m", i
->path
);
1866 STRV_FOREACH(fn
, g
.gl_pathv
) {
1868 if (k
< 0 && r
== 0)
1875 static int glob_item_recursively(Item
*i
, fdaction_t action
) {
1876 _cleanup_globfree_ glob_t g
= {
1877 .gl_opendir
= (void *(*)(const char *)) opendir_nomod
,
1882 k
= safe_glob(i
->path
, GLOB_NOSORT
|GLOB_BRACE
, &g
);
1883 if (k
< 0 && k
!= -ENOENT
)
1884 return log_error_errno(k
, "glob(%s) failed: %m", i
->path
);
1886 STRV_FOREACH(fn
, g
.gl_pathv
) {
1887 _cleanup_close_
int fd
= -1;
1889 /* Make sure we won't trigger/follow file object (such as
1890 * device nodes, automounts, ...) pointed out by 'fn' with
1891 * O_PATH. Note, when O_PATH is used, flags other than
1892 * O_CLOEXEC, O_DIRECTORY, and O_NOFOLLOW are ignored. */
1894 fd
= open(*fn
, O_CLOEXEC
|O_NOFOLLOW
|O_PATH
);
1896 log_error_errno(errno
, "Opening '%s' failed: %m", *fn
);
1902 k
= item_do(i
, fd
, *fn
, action
);
1903 if (k
< 0 && r
== 0)
1906 /* we passed fd ownership to the previous call */
1913 static int create_item(Item
*i
) {
1914 CreationMode creation
;
1919 log_debug("Running create action for entry %c %s", (char) i
->type
, i
->path
);
1924 case IGNORE_DIRECTORY_PATH
:
1926 case RECURSIVE_REMOVE_PATH
:
1930 RUN_WITH_UMASK(0000)
1931 (void) mkdir_parents_label(i
->path
, 0755);
1933 r
= create_file(i
, i
->path
);
1939 RUN_WITH_UMASK(0000)
1940 (void) mkdir_parents_label(i
->path
, 0755);
1942 r
= truncate_file(i
, i
->path
);
1948 RUN_WITH_UMASK(0000)
1949 (void) mkdir_parents_label(i
->path
, 0755);
1957 r
= glob_item(i
, write_one_file
);
1963 case CREATE_DIRECTORY
:
1964 case TRUNCATE_DIRECTORY
:
1965 RUN_WITH_UMASK(0000)
1966 (void) mkdir_parents_label(i
->path
, 0755);
1968 r
= create_directory(i
, i
->path
);
1973 case CREATE_SUBVOLUME
:
1974 case CREATE_SUBVOLUME_INHERIT_QUOTA
:
1975 case CREATE_SUBVOLUME_NEW_QUOTA
:
1976 RUN_WITH_UMASK(0000)
1977 (void) mkdir_parents_label(i
->path
, 0755);
1979 r
= create_subvolume(i
, i
->path
);
1984 case EMPTY_DIRECTORY
:
1985 r
= glob_item(i
, empty_directory
);
1991 RUN_WITH_UMASK(0000)
1992 (void) mkdir_parents_label(i
->path
, 0755);
1994 r
= create_fifo(i
, i
->path
);
1999 case CREATE_SYMLINK
: {
2000 RUN_WITH_UMASK(0000)
2001 (void) mkdir_parents_label(i
->path
, 0755);
2003 mac_selinux_create_file_prepare(i
->path
, S_IFLNK
);
2004 r
= symlink(i
->argument
, i
->path
);
2005 mac_selinux_create_file_clear();
2008 _cleanup_free_
char *x
= NULL
;
2010 if (errno
!= EEXIST
)
2011 return log_error_errno(errno
, "symlink(%s, %s) failed: %m", i
->argument
, i
->path
);
2013 r
= readlink_malloc(i
->path
, &x
);
2014 if (r
< 0 || !streq(i
->argument
, x
)) {
2016 if (i
->append_or_force
) {
2017 mac_selinux_create_file_prepare(i
->path
, S_IFLNK
);
2018 r
= symlink_atomic(i
->argument
, i
->path
);
2019 mac_selinux_create_file_clear();
2021 if (IN_SET(r
, -EISDIR
, -EEXIST
, -ENOTEMPTY
)) {
2022 r
= rm_rf(i
->path
, REMOVE_ROOT
|REMOVE_PHYSICAL
);
2024 return log_error_errno(r
, "rm -fr %s failed: %m", i
->path
);
2026 mac_selinux_create_file_prepare(i
->path
, S_IFLNK
);
2027 r
= symlink(i
->argument
, i
->path
) < 0 ? -errno
: 0;
2028 mac_selinux_create_file_clear();
2031 return log_error_errno(r
, "symlink(%s, %s) failed: %m", i
->argument
, i
->path
);
2033 creation
= CREATION_FORCE
;
2035 log_debug("\"%s\" is not a symlink or does not point to the correct path.", i
->path
);
2039 creation
= CREATION_EXISTING
;
2042 creation
= CREATION_NORMAL
;
2043 log_debug("%s symlink \"%s\".", creation_mode_verb_to_string(creation
), i
->path
);
2047 case CREATE_BLOCK_DEVICE
:
2048 case CREATE_CHAR_DEVICE
:
2049 if (have_effective_cap(CAP_MKNOD
) == 0) {
2050 /* In a container we lack CAP_MKNOD. We shouldn't attempt to create the device node in that
2051 * case to avoid noise, and we don't support virtualized devices in containers anyway. */
2053 log_debug("We lack CAP_MKNOD, skipping creation of device node %s.", i
->path
);
2057 RUN_WITH_UMASK(0000)
2058 (void) mkdir_parents_label(i
->path
, 0755);
2060 r
= create_device(i
, i
->type
== CREATE_BLOCK_DEVICE
? S_IFBLK
: S_IFCHR
);
2068 r
= glob_item(i
, path_set_perms
);
2073 case RECURSIVE_RELABEL_PATH
:
2074 r
= glob_item_recursively(i
, fd_set_perms
);
2080 r
= glob_item(i
, path_set_xattrs
);
2085 case RECURSIVE_SET_XATTR
:
2086 r
= glob_item_recursively(i
, fd_set_xattrs
);
2092 r
= glob_item(i
, path_set_acls
);
2097 case RECURSIVE_SET_ACL
:
2098 r
= glob_item_recursively(i
, fd_set_acls
);
2104 r
= glob_item(i
, path_set_attribute
);
2109 case RECURSIVE_SET_ATTRIBUTE
:
2110 r
= glob_item_recursively(i
, fd_set_attribute
);
2119 static int remove_item_instance(Item
*i
, const char *instance
) {
2127 if (remove(instance
) < 0 && errno
!= ENOENT
)
2128 return log_error_errno(errno
, "rm(%s): %m", instance
);
2132 case RECURSIVE_REMOVE_PATH
:
2133 /* FIXME: we probably should use dir_cleanup() here instead of rm_rf() so that 'x' is honoured. */
2134 log_debug("rm -rf \"%s\"", instance
);
2135 r
= rm_rf(instance
, REMOVE_ROOT
|REMOVE_SUBVOLUME
|REMOVE_PHYSICAL
);
2136 if (r
< 0 && r
!= -ENOENT
)
2137 return log_error_errno(r
, "rm_rf(%s): %m", instance
);
2142 assert_not_reached("wut?");
2148 static int remove_item(Item
*i
) {
2153 log_debug("Running remove action for entry %c %s", (char) i
->type
, i
->path
);
2157 case TRUNCATE_DIRECTORY
:
2158 /* FIXME: we probably should use dir_cleanup() here instead of rm_rf() so that 'x' is honoured. */
2159 log_debug("rm -rf \"%s\"", i
->path
);
2160 r
= rm_rf(i
->path
, REMOVE_PHYSICAL
);
2161 if (r
< 0 && r
!= -ENOENT
)
2162 return log_error_errno(r
, "rm_rf(%s): %m", i
->path
);
2167 case RECURSIVE_REMOVE_PATH
:
2168 return glob_item(i
, remove_item_instance
);
2175 static int clean_item_instance(Item
*i
, const char* instance
) {
2176 _cleanup_closedir_
DIR *d
= NULL
;
2180 char timestamp
[FORMAT_TIMESTAMP_MAX
];
2187 n
= now(CLOCK_REALTIME
);
2191 cutoff
= n
- i
->age
;
2193 d
= opendir_nomod(instance
);
2195 if (IN_SET(errno
, ENOENT
, ENOTDIR
)) {
2196 log_debug_errno(errno
, "Directory \"%s\": %m", instance
);
2200 return log_error_errno(errno
, "Failed to open directory %s: %m", instance
);
2203 if (fstat(dirfd(d
), &s
) < 0)
2204 return log_error_errno(errno
, "stat(%s) failed: %m", i
->path
);
2206 if (!S_ISDIR(s
.st_mode
))
2207 return log_error_errno(SYNTHETIC_ERRNO(ENOTDIR
),
2208 "%s is not a directory.", i
->path
);
2210 if (fstatat(dirfd(d
), "..", &ps
, AT_SYMLINK_NOFOLLOW
) != 0)
2211 return log_error_errno(errno
, "stat(%s/..) failed: %m", i
->path
);
2213 mountpoint
= s
.st_dev
!= ps
.st_dev
|| s
.st_ino
== ps
.st_ino
;
2215 log_debug("Cleanup threshold for %s \"%s\" is %s",
2216 mountpoint
? "mount point" : "directory",
2218 format_timestamp_us(timestamp
, sizeof(timestamp
), cutoff
));
2220 return dir_cleanup(i
, instance
, d
, &s
, cutoff
, s
.st_dev
, mountpoint
,
2221 MAX_DEPTH
, i
->keep_first_level
);
2224 static int clean_item(Item
*i
) {
2227 log_debug("Running clean action for entry %c %s", (char) i
->type
, i
->path
);
2230 case CREATE_DIRECTORY
:
2231 case CREATE_SUBVOLUME
:
2232 case CREATE_SUBVOLUME_INHERIT_QUOTA
:
2233 case CREATE_SUBVOLUME_NEW_QUOTA
:
2234 case TRUNCATE_DIRECTORY
:
2237 clean_item_instance(i
, i
->path
);
2239 case EMPTY_DIRECTORY
:
2240 case IGNORE_DIRECTORY_PATH
:
2241 return glob_item(i
, clean_item_instance
);
2247 static int process_item(Item
*i
, OperationMask operation
) {
2253 todo
= operation
& ~i
->done
;
2254 if (todo
== 0) /* Everything already done? */
2257 i
->done
|= operation
;
2259 r
= chase_symlinks(i
->path
, arg_root
, CHASE_NO_AUTOFS
|CHASE_WARN
, NULL
, NULL
);
2260 if (r
== -EREMOTE
) {
2261 log_notice_errno(r
, "Skipping %s", i
->path
);
2265 log_debug_errno(r
, "Failed to determine whether '%s' is below autofs, ignoring: %m", i
->path
);
2267 r
= FLAGS_SET(operation
, OPERATION_CREATE
) ? create_item(i
) : 0;
2268 /* Failure can only be tolerated for create */
2269 if (i
->allow_failure
)
2272 q
= FLAGS_SET(operation
, OPERATION_REMOVE
) ? remove_item(i
) : 0;
2273 p
= FLAGS_SET(operation
, OPERATION_CLEAN
) ? clean_item(i
) : 0;
2280 static int process_item_array(ItemArray
*array
, OperationMask operation
) {
2286 /* Create any parent first. */
2287 if (FLAGS_SET(operation
, OPERATION_CREATE
) && array
->parent
)
2288 r
= process_item_array(array
->parent
, operation
& OPERATION_CREATE
);
2290 /* Clean up all children first */
2291 if ((operation
& (OPERATION_REMOVE
|OPERATION_CLEAN
)) && !set_isempty(array
->children
)) {
2295 SET_FOREACH(c
, array
->children
, i
) {
2298 k
= process_item_array(c
, operation
& (OPERATION_REMOVE
|OPERATION_CLEAN
));
2299 if (k
< 0 && r
== 0)
2304 for (n
= 0; n
< array
->n_items
; n
++) {
2307 k
= process_item(array
->items
+ n
, operation
);
2308 if (k
< 0 && r
== 0)
2315 static void item_free_contents(Item
*i
) {
2319 strv_free(i
->xattrs
);
2322 acl_free(i
->acl_access
);
2323 acl_free(i
->acl_default
);
2327 static ItemArray
* item_array_free(ItemArray
*a
) {
2333 for (n
= 0; n
< a
->n_items
; n
++)
2334 item_free_contents(a
->items
+ n
);
2336 set_free(a
->children
);
2341 static int item_compare(const Item
*a
, const Item
*b
) {
2342 /* Make sure that the ownership taking item is put first, so
2343 * that we first create the node, and then can adjust it */
2345 if (takes_ownership(a
->type
) && !takes_ownership(b
->type
))
2347 if (!takes_ownership(a
->type
) && takes_ownership(b
->type
))
2350 return CMP(a
->type
, b
->type
);
2353 static bool item_compatible(Item
*a
, Item
*b
) {
2356 assert(streq(a
->path
, b
->path
));
2358 if (takes_ownership(a
->type
) && takes_ownership(b
->type
))
2359 /* check if the items are the same */
2360 return streq_ptr(a
->argument
, b
->argument
) &&
2362 a
->uid_set
== b
->uid_set
&&
2365 a
->gid_set
== b
->gid_set
&&
2368 a
->mode_set
== b
->mode_set
&&
2369 a
->mode
== b
->mode
&&
2371 a
->age_set
== b
->age_set
&&
2374 a
->mask_perms
== b
->mask_perms
&&
2376 a
->keep_first_level
== b
->keep_first_level
&&
2378 a
->major_minor
== b
->major_minor
;
2383 static bool should_include_path(const char *path
) {
2386 STRV_FOREACH(prefix
, arg_exclude_prefixes
)
2387 if (path_startswith(path
, *prefix
)) {
2388 log_debug("Entry \"%s\" matches exclude prefix \"%s\", skipping.",
2393 STRV_FOREACH(prefix
, arg_include_prefixes
)
2394 if (path_startswith(path
, *prefix
)) {
2395 log_debug("Entry \"%s\" matches include prefix \"%s\".", path
, *prefix
);
2399 /* no matches, so we should include this path only if we
2400 * have no whitelist at all */
2401 if (strv_isempty(arg_include_prefixes
))
2404 log_debug("Entry \"%s\" does not match any include prefix, skipping.", path
);
2408 static int specifier_expansion_from_arg(Item
*i
) {
2409 _cleanup_free_
char *unescaped
= NULL
, *resolved
= NULL
;
2420 case CREATE_SYMLINK
:
2424 r
= cunescape(i
->argument
, 0, &unescaped
);
2426 return log_error_errno(r
, "Failed to unescape parameter to write: %s", i
->argument
);
2428 r
= specifier_printf(unescaped
, specifier_table
, NULL
, &resolved
);
2432 free_and_replace(i
->argument
, resolved
);
2436 case RECURSIVE_SET_XATTR
:
2439 STRV_FOREACH (xattr
, i
->xattrs
) {
2440 r
= specifier_printf(*xattr
, specifier_table
, NULL
, &resolved
);
2444 free_and_replace(*xattr
, resolved
);
2454 static int patch_var_run(const char *fname
, unsigned line
, char **path
) {
2461 /* Optionally rewrites lines referencing /var/run/, to use /run/ instead. Why bother? tmpfiles merges lines in
2462 * some cases and detects conflicts in others. If files/directories are specified through two equivalent lines
2463 * this is problematic as neither case will be detected. Ideally we'd detect these cases by resolving symlinks
2464 * early, but that's precisely not what we can do here as this code very likely is running very early on, at a
2465 * time where the paths in question are not available yet, or even more importantly, our own tmpfiles rules
2466 * might create the paths that are intermediary to the listed paths. We can't really cover the generic case,
2467 * but the least we can do is cover the specific case of /var/run vs. /run, as /var/run is a legacy name for
2468 * /run only, and we explicitly document that and require that on systemd systems the former is a symlink to
2469 * the latter. Moreover files below this path are by far the primary usecase for tmpfiles.d/. */
2471 k
= path_startswith(*path
, "/var/run/");
2472 if (isempty(k
)) /* Don't complain about other paths than /var/run, and not about /var/run itself either. */
2475 n
= path_join("/run", k
);
2479 /* Also log about this briefly. We do so at LOG_NOTICE level, as we fixed up the situation automatically, hence
2480 * there's no immediate need for action by the user. However, in the interest of making things less confusing
2481 * to the user, let's still inform the user that these snippets should really be updated. */
2482 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
);
2484 free_and_replace(*path
, n
);
2489 static int parse_line(const char *fname
, unsigned line
, const char *buffer
, bool *invalid_config
) {
2491 _cleanup_free_
char *action
= NULL
, *mode
= NULL
, *user
= NULL
, *group
= NULL
, *age
= NULL
, *path
= NULL
;
2492 _cleanup_(item_free_contents
) Item i
= {};
2493 ItemArray
*existing
;
2496 bool append_or_force
= false, boot
= false, allow_failure
= false;
2502 r
= extract_many_words(
2514 if (IN_SET(r
, -EINVAL
, -EBADSLT
))
2515 /* invalid quoting and such or an unknown specifier */
2516 *invalid_config
= true;
2517 return log_error_errno(r
, "[%s:%u] Failed to parse line: %m", fname
, line
);
2519 *invalid_config
= true;
2520 log_error("[%s:%u] Syntax error.", fname
, line
);
2524 if (!empty_or_dash(buffer
)) {
2525 i
.argument
= strdup(buffer
);
2530 if (isempty(action
)) {
2531 *invalid_config
= true;
2532 log_error("[%s:%u] Command too short '%s'.", fname
, line
, action
);
2536 for (pos
= 1; action
[pos
]; pos
++) {
2537 if (action
[pos
] == '!' && !boot
)
2539 else if (action
[pos
] == '+' && !append_or_force
)
2540 append_or_force
= true;
2541 else if (action
[pos
] == '-' && !allow_failure
)
2542 allow_failure
= true;
2544 *invalid_config
= true;
2545 log_error("[%s:%u] Unknown modifiers in command '%s'",
2546 fname
, line
, action
);
2551 if (boot
&& !arg_boot
) {
2552 log_debug("Ignoring entry %s \"%s\" because --boot is not specified.",
2558 i
.append_or_force
= append_or_force
;
2559 i
.allow_failure
= allow_failure
;
2561 r
= specifier_printf(path
, specifier_table
, NULL
, &i
.path
);
2563 return log_unresolvable_specifier(fname
, line
);
2565 if (IN_SET(r
, -EINVAL
, -EBADSLT
))
2566 *invalid_config
= true;
2567 return log_error_errno(r
, "[%s:%u] Failed to replace specifiers: %s", fname
, line
, path
);
2570 r
= patch_var_run(fname
, line
, &i
.path
);
2576 case CREATE_DIRECTORY
:
2577 case CREATE_SUBVOLUME
:
2578 case CREATE_SUBVOLUME_INHERIT_QUOTA
:
2579 case CREATE_SUBVOLUME_NEW_QUOTA
:
2580 case EMPTY_DIRECTORY
:
2581 case TRUNCATE_DIRECTORY
:
2584 case IGNORE_DIRECTORY_PATH
:
2586 case RECURSIVE_REMOVE_PATH
:
2589 case RECURSIVE_RELABEL_PATH
:
2591 log_warning("[%s:%u] %c lines don't take argument fields, ignoring.", fname
, line
, i
.type
);
2599 case CREATE_SYMLINK
:
2601 i
.argument
= path_join("/usr/share/factory", i
.path
);
2609 *invalid_config
= true;
2610 log_error("[%s:%u] Write file requires argument.", fname
, line
);
2617 i
.argument
= path_join(arg_root
, "/usr/share/factory", i
.path
);
2621 } else if (!path_is_absolute(i
.argument
)) {
2622 *invalid_config
= true;
2623 log_error("[%s:%u] Source path is not absolute.", fname
, line
);
2626 } else if (arg_root
) {
2629 p
= path_join(arg_root
, i
.argument
);
2632 free_and_replace(i
.argument
, p
);
2635 path_simplify(i
.argument
, false);
2638 case CREATE_CHAR_DEVICE
:
2639 case CREATE_BLOCK_DEVICE
:
2641 *invalid_config
= true;
2642 log_error("[%s:%u] Device file requires argument.", fname
, line
);
2646 r
= parse_dev(i
.argument
, &i
.major_minor
);
2648 *invalid_config
= true;
2649 log_error_errno(r
, "[%s:%u] Can't parse device file major/minor '%s'.", fname
, line
, i
.argument
);
2656 case RECURSIVE_SET_XATTR
:
2658 *invalid_config
= true;
2659 log_error("[%s:%u] Set extended attribute requires argument.", fname
, line
);
2662 r
= parse_xattrs_from_arg(&i
);
2668 case RECURSIVE_SET_ACL
:
2670 *invalid_config
= true;
2671 log_error("[%s:%u] Set ACLs requires argument.", fname
, line
);
2674 r
= parse_acls_from_arg(&i
);
2680 case RECURSIVE_SET_ATTRIBUTE
:
2682 *invalid_config
= true;
2683 log_error("[%s:%u] Set file attribute requires argument.", fname
, line
);
2686 r
= parse_attribute_from_arg(&i
);
2687 if (IN_SET(r
, -EINVAL
, -EBADSLT
))
2688 *invalid_config
= true;
2694 log_error("[%s:%u] Unknown command type '%c'.", fname
, line
, (char) i
.type
);
2695 *invalid_config
= true;
2699 if (!path_is_absolute(i
.path
)) {
2700 log_error("[%s:%u] Path '%s' not absolute.", fname
, line
, i
.path
);
2701 *invalid_config
= true;
2705 path_simplify(i
.path
, false);
2707 if (!should_include_path(i
.path
))
2710 r
= specifier_expansion_from_arg(&i
);
2712 return log_unresolvable_specifier(fname
, line
);
2714 if (IN_SET(r
, -EINVAL
, -EBADSLT
))
2715 *invalid_config
= true;
2716 return log_error_errno(r
, "[%s:%u] Failed to substitute specifiers in argument: %m",
2723 p
= path_join(arg_root
, i
.path
);
2726 free_and_replace(i
.path
, p
);
2729 if (!empty_or_dash(user
)) {
2730 const char *u
= user
;
2732 r
= get_user_creds(&u
, &i
.uid
, NULL
, NULL
, NULL
, USER_CREDS_ALLOW_MISSING
);
2734 *invalid_config
= true;
2735 return log_error_errno(r
, "[%s:%u] Unknown user '%s'.", fname
, line
, user
);
2741 if (!empty_or_dash(group
)) {
2742 const char *g
= group
;
2744 r
= get_group_creds(&g
, &i
.gid
, USER_CREDS_ALLOW_MISSING
);
2746 *invalid_config
= true;
2747 log_error("[%s:%u] Unknown group '%s'.", fname
, line
, group
);
2754 if (!empty_or_dash(mode
)) {
2755 const char *mm
= mode
;
2759 i
.mask_perms
= true;
2763 if (parse_mode(mm
, &m
) < 0) {
2764 *invalid_config
= true;
2765 log_error("[%s:%u] Invalid mode '%s'.", fname
, line
, mode
);
2772 i
.mode
= IN_SET(i
.type
, CREATE_DIRECTORY
, TRUNCATE_DIRECTORY
, CREATE_SUBVOLUME
, CREATE_SUBVOLUME_INHERIT_QUOTA
, CREATE_SUBVOLUME_NEW_QUOTA
) ? 0755 : 0644;
2774 if (!empty_or_dash(age
)) {
2775 const char *a
= age
;
2778 i
.keep_first_level
= true;
2782 if (parse_sec(a
, &i
.age
) < 0) {
2783 *invalid_config
= true;
2784 log_error("[%s:%u] Invalid age '%s'.", fname
, line
, age
);
2791 h
= needs_glob(i
.type
) ? globs
: items
;
2793 existing
= ordered_hashmap_get(h
, i
.path
);
2797 for (n
= 0; n
< existing
->n_items
; n
++) {
2798 if (!item_compatible(existing
->items
+ n
, &i
) && !i
.append_or_force
) {
2799 log_notice("[%s:%u] Duplicate line for path \"%s\", ignoring.",
2800 fname
, line
, i
.path
);
2805 existing
= new0(ItemArray
, 1);
2809 r
= ordered_hashmap_put(h
, i
.path
, existing
);
2816 if (!GREEDY_REALLOC(existing
->items
, existing
->allocated
, existing
->n_items
+ 1))
2819 existing
->items
[existing
->n_items
++] = i
;
2820 i
= (struct Item
) {};
2822 /* Sort item array, to enforce stable ordering of application */
2823 typesafe_qsort(existing
->items
, existing
->n_items
, item_compare
);
2828 static int cat_config(char **config_dirs
, char **args
) {
2829 _cleanup_strv_free_
char **files
= NULL
;
2832 r
= conf_files_list_with_replacement(arg_root
, config_dirs
, arg_replace
, &files
, NULL
);
2836 return cat_files(NULL
, files
, 0);
2839 static int help(void) {
2840 _cleanup_free_
char *link
= NULL
;
2843 r
= terminal_urlify_man("systemd-tmpfiles", "8", &link
);
2847 printf("%s [OPTIONS...] [CONFIGURATION FILE...]\n\n"
2848 "Creates, deletes and cleans up volatile and temporary files and directories.\n\n"
2849 " -h --help Show this help\n"
2850 " --user Execute user configuration\n"
2851 " --version Show package version\n"
2852 " --cat-config Show configuration files\n"
2853 " --create Create marked files/directories\n"
2854 " --clean Clean up marked directories\n"
2855 " --remove Remove marked files/directories\n"
2856 " --boot Execute actions only safe at boot\n"
2857 " --prefix=PATH Only apply rules with the specified prefix\n"
2858 " --exclude-prefix=PATH Ignore rules with the specified prefix\n"
2859 " --root=PATH Operate on an alternate filesystem root\n"
2860 " --replace=PATH Treat arguments as replacement for PATH\n"
2861 " --no-pager Do not pipe output into a pager\n"
2862 "\nSee the %s for details.\n"
2863 , program_invocation_short_name
2870 static int parse_argv(int argc
, char *argv
[]) {
2873 ARG_VERSION
= 0x100,
2887 static const struct option options
[] = {
2888 { "help", no_argument
, NULL
, 'h' },
2889 { "user", no_argument
, NULL
, ARG_USER
},
2890 { "version", no_argument
, NULL
, ARG_VERSION
},
2891 { "cat-config", no_argument
, NULL
, ARG_CAT_CONFIG
},
2892 { "create", no_argument
, NULL
, ARG_CREATE
},
2893 { "clean", no_argument
, NULL
, ARG_CLEAN
},
2894 { "remove", no_argument
, NULL
, ARG_REMOVE
},
2895 { "boot", no_argument
, NULL
, ARG_BOOT
},
2896 { "prefix", required_argument
, NULL
, ARG_PREFIX
},
2897 { "exclude-prefix", required_argument
, NULL
, ARG_EXCLUDE_PREFIX
},
2898 { "root", required_argument
, NULL
, ARG_ROOT
},
2899 { "replace", required_argument
, NULL
, ARG_REPLACE
},
2900 { "no-pager", no_argument
, NULL
, ARG_NO_PAGER
},
2909 while ((c
= getopt_long(argc
, argv
, "h", options
, NULL
)) >= 0)
2919 case ARG_CAT_CONFIG
:
2920 arg_cat_config
= true;
2928 arg_operation
|= OPERATION_CREATE
;
2932 arg_operation
|= OPERATION_CLEAN
;
2936 arg_operation
|= OPERATION_REMOVE
;
2944 if (strv_push(&arg_include_prefixes
, optarg
) < 0)
2948 case ARG_EXCLUDE_PREFIX
:
2949 if (strv_push(&arg_exclude_prefixes
, optarg
) < 0)
2954 r
= parse_path_argument_and_warn(optarg
, true, &arg_root
);
2960 if (!path_is_absolute(optarg
) ||
2961 !endswith(optarg
, ".conf"))
2962 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
2963 "The argument to --replace= must an absolute path to a config file");
2965 arg_replace
= optarg
;
2969 arg_pager_flags
|= PAGER_DISABLE
;
2976 assert_not_reached("Unhandled option");
2979 if (arg_operation
== 0 && !arg_cat_config
)
2980 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
2981 "You need to specify at least one of --clean, --create or --remove.");
2983 if (arg_replace
&& arg_cat_config
)
2984 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
2985 "Option --replace= is not supported with --cat-config");
2987 if (arg_replace
&& optind
>= argc
)
2988 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
2989 "When --replace= is given, some configuration items must be specified");
2994 static int read_config_file(char **config_dirs
, const char *fn
, bool ignore_enoent
, bool *invalid_config
) {
2995 _cleanup_fclose_
FILE *_f
= NULL
;
3004 if (streq(fn
, "-")) {
3005 log_debug("Reading config from stdin…");
3009 r
= search_and_fopen(fn
, "re", arg_root
, (const char**) config_dirs
, &_f
);
3011 if (ignore_enoent
&& r
== -ENOENT
) {
3012 log_debug_errno(r
, "Failed to open \"%s\", ignoring: %m", fn
);
3016 return log_error_errno(r
, "Failed to open '%s': %m", fn
);
3018 log_debug("Reading config file \"%s\"…", fn
);
3023 _cleanup_free_
char *line
= NULL
;
3024 bool invalid_line
= false;
3028 k
= read_line(f
, LONG_LINE_MAX
, &line
);
3030 return log_error_errno(k
, "Failed to read '%s': %m", fn
);
3037 if (IN_SET(*l
, 0, '#'))
3040 k
= parse_line(fn
, v
, l
, &invalid_line
);
3043 /* Allow reporting with a special code if the caller requested this */
3044 *invalid_config
= true;
3046 /* The first error becomes our return value */
3051 /* we have to determine age parameter for each entry of type X */
3052 ORDERED_HASHMAP_FOREACH(i
, globs
, iterator
) {
3054 Item
*j
, *candidate_item
= NULL
;
3056 if (i
->type
!= IGNORE_DIRECTORY_PATH
)
3059 ORDERED_HASHMAP_FOREACH(j
, items
, iter
) {
3060 if (!IN_SET(j
->type
, CREATE_DIRECTORY
, TRUNCATE_DIRECTORY
, CREATE_SUBVOLUME
, CREATE_SUBVOLUME_INHERIT_QUOTA
, CREATE_SUBVOLUME_NEW_QUOTA
))
3063 if (path_equal(j
->path
, i
->path
)) {
3068 if ((!candidate_item
&& path_startswith(i
->path
, j
->path
)) ||
3069 (candidate_item
&& path_startswith(j
->path
, candidate_item
->path
) && (fnmatch(i
->path
, j
->path
, FNM_PATHNAME
| FNM_PERIOD
) == 0)))
3073 if (candidate_item
&& candidate_item
->age_set
) {
3074 i
->age
= candidate_item
->age
;
3080 log_error_errno(errno
, "Failed to read from file %s: %m", fn
);
3088 static int parse_arguments(char **config_dirs
, char **args
, bool *invalid_config
) {
3092 STRV_FOREACH(arg
, args
) {
3093 r
= read_config_file(config_dirs
, *arg
, false, invalid_config
);
3101 static int read_config_files(char **config_dirs
, char **args
, bool *invalid_config
) {
3102 _cleanup_strv_free_
char **files
= NULL
;
3103 _cleanup_free_
char *p
= NULL
;
3107 r
= conf_files_list_with_replacement(arg_root
, config_dirs
, arg_replace
, &files
, &p
);
3111 STRV_FOREACH(f
, files
)
3112 if (p
&& path_equal(*f
, p
)) {
3113 log_debug("Parsing arguments at position \"%s\"…", *f
);
3115 r
= parse_arguments(config_dirs
, args
, invalid_config
);
3119 /* Just warn, ignore result otherwise.
3120 * read_config_file() has some debug output, so no need to print anything. */
3121 (void) read_config_file(config_dirs
, *f
, true, invalid_config
);
3126 static int link_parent(ItemArray
*a
) {
3133 /* Finds the closest "parent" item array for the specified item array. Then registers the specified item array
3134 * as child of it, and fills the parent in, linking them both ways. This allows us to later create parents
3135 * before their children, and clean up/remove children before their parents. */
3137 if (a
->n_items
<= 0)
3140 path
= a
->items
[0].path
;
3141 prefix
= newa(char, strlen(path
) + 1);
3142 PATH_FOREACH_PREFIX(prefix
, path
) {
3145 j
= ordered_hashmap_get(items
, prefix
);
3147 j
= ordered_hashmap_get(globs
, prefix
);
3149 r
= set_ensure_allocated(&j
->children
, NULL
);
3153 r
= set_put(j
->children
, a
);
3165 DEFINE_PRIVATE_HASH_OPS_WITH_VALUE_DESTRUCTOR(item_array_hash_ops
, char, string_hash_func
, string_compare_func
,
3166 ItemArray
, item_array_free
);
3168 static int run(int argc
, char *argv
[]) {
3169 _cleanup_strv_free_
char **config_dirs
= NULL
;
3170 bool invalid_config
= false;
3174 PHASE_REMOVE_AND_CLEAN
,
3180 r
= parse_argv(argc
, argv
);
3184 log_setup_service();
3186 /* Descending down file system trees might take a lot of fds */
3187 (void) rlimit_nofile_bump(HIGH_RLIMIT_NOFILE
);
3190 r
= user_config_paths(&config_dirs
);
3192 return log_error_errno(r
, "Failed to initialize configuration directory list: %m");
3194 config_dirs
= strv_split_nulstr(CONF_PATHS_NULSTR("tmpfiles.d"));
3199 if (DEBUG_LOGGING
) {
3200 _cleanup_free_
char *t
= NULL
;
3202 t
= strv_join(config_dirs
, "\n\t");
3204 log_debug("Looking for configuration files in (higher priority first):\n\t%s", t
);
3207 if (arg_cat_config
) {
3208 (void) pager_open(arg_pager_flags
);
3210 return cat_config(config_dirs
, argv
+ optind
);
3217 items
= ordered_hashmap_new(&item_array_hash_ops
);
3218 globs
= ordered_hashmap_new(&item_array_hash_ops
);
3219 if (!items
|| !globs
)
3222 /* If command line arguments are specified along with --replace, read all
3223 * configuration files and insert the positional arguments at the specified
3224 * place. Otherwise, if command line arguments are specified, execute just
3225 * them, and finally, without --replace= or any positional arguments, just
3226 * read configuration and execute it.
3228 if (arg_replace
|| optind
>= argc
)
3229 r
= read_config_files(config_dirs
, argv
+ optind
, &invalid_config
);
3231 r
= parse_arguments(config_dirs
, argv
+ optind
, &invalid_config
);
3235 /* Let's now link up all child/parent relationships */
3236 ORDERED_HASHMAP_FOREACH(a
, items
, iterator
) {
3241 ORDERED_HASHMAP_FOREACH(a
, globs
, iterator
) {
3247 /* If multiple operations are requested, let's first run the remove/clean operations, and only then the create
3248 * operations. i.e. that we first clean out the platform we then build on. */
3249 for (phase
= 0; phase
< _PHASE_MAX
; phase
++) {
3252 if (phase
== PHASE_REMOVE_AND_CLEAN
)
3253 op
= arg_operation
& (OPERATION_REMOVE
|OPERATION_CLEAN
);
3254 else if (phase
== PHASE_CREATE
)
3255 op
= arg_operation
& OPERATION_CREATE
;
3257 assert_not_reached("unexpected phase");
3259 if (op
== 0) /* Nothing requested in this phase */
3262 /* The non-globbing ones usually create things, hence we apply them first */
3263 ORDERED_HASHMAP_FOREACH(a
, items
, iterator
) {
3264 k
= process_item_array(a
, op
);
3265 if (k
< 0 && r
>= 0)
3269 /* The globbing ones usually alter things, hence we apply them second. */
3270 ORDERED_HASHMAP_FOREACH(a
, globs
, iterator
) {
3271 k
= process_item_array(a
, op
);
3272 if (k
< 0 && r
>= 0)
3277 if (ERRNO_IS_RESOURCE(-r
))
3282 return EX_CANTCREAT
;
3286 DEFINE_MAIN_FUNCTION_WITH_POSITIVE_FAILURE(run
);