]>
git.ipfire.org Git - thirdparty/systemd.git/blob - src/basic/fs-util.c
1 /* SPDX-License-Identifier: LGPL-2.1+ */
3 This file is part of systemd.
5 Copyright 2010 Lennart Poettering
14 #include <linux/magic.h>
18 #include "alloc-util.h"
19 #include "dirent-util.h"
27 #include "parse-util.h"
28 #include "path-util.h"
29 #include "process-util.h"
30 #include "stat-util.h"
31 #include "stdio-util.h"
32 #include "string-util.h"
34 #include "time-util.h"
35 #include "user-util.h"
38 int unlink_noerrno ( const char * path
) {
49 int rmdir_parents ( const char * path
, const char * stop
) {
58 /* Skip trailing slashes */
59 while ( l
> 0 && path
[ l
- 1 ] == '/' )
65 /* Skip last component */
66 while ( l
> 0 && path
[ l
- 1 ] != '/' )
69 /* Skip trailing slashes */
70 while ( l
> 0 && path
[ l
- 1 ] == '/' )
80 if ( path_startswith ( stop
, t
)) {
96 int rename_noreplace ( int olddirfd
, const char * oldpath
, int newdirfd
, const char * newpath
) {
100 ret
= renameat2 ( olddirfd
, oldpath
, newdirfd
, newpath
, RENAME_NOREPLACE
);
104 /* renameat2() exists since Linux 3.15, btrfs added support for it later.
105 * If it is not implemented, fallback to another method. */
106 if (! IN_SET ( errno
, EINVAL
, ENOSYS
))
109 /* The link()/unlink() fallback does not work on directories. But
110 * renameat() without RENAME_NOREPLACE gives the same semantics on
111 * directories, except when newpath is an *empty* directory. This is
113 ret
= fstatat ( olddirfd
, oldpath
, & buf
, AT_SYMLINK_NOFOLLOW
);
114 if ( ret
>= 0 && S_ISDIR ( buf
. st_mode
)) {
115 ret
= renameat ( olddirfd
, oldpath
, newdirfd
, newpath
);
116 return ret
>= 0 ? 0 : - errno
;
119 /* If it is not a directory, use the link()/unlink() fallback. */
120 ret
= linkat ( olddirfd
, oldpath
, newdirfd
, newpath
, 0 );
124 ret
= unlinkat ( olddirfd
, oldpath
, 0 );
126 /* backup errno before the following unlinkat() alters it */
128 ( void ) unlinkat ( newdirfd
, newpath
, 0 );
136 int readlinkat_malloc ( int fd
, const char * p
, char ** ret
) {
151 n
= readlinkat ( fd
, p
, c
, l
- 1 );
158 if (( size_t ) n
< l
- 1 ) {
169 int readlink_malloc ( const char * p
, char ** ret
) {
170 return readlinkat_malloc ( AT_FDCWD
, p
, ret
);
173 int readlink_value ( const char * p
, char ** ret
) {
174 _cleanup_free_
char * link
= NULL
;
178 r
= readlink_malloc ( p
, & link
);
182 value
= basename ( link
);
186 value
= strdup ( value
);
195 int readlink_and_make_absolute ( const char * p
, char ** r
) {
196 _cleanup_free_
char * target
= NULL
;
203 j
= readlink_malloc ( p
, & target
);
207 k
= file_in_same_dir ( p
, target
);
215 int chmod_and_chown ( const char * path
, mode_t mode
, uid_t uid
, gid_t gid
) {
218 /* Under the assumption that we are running privileged we
219 * first change the access mode and only then hand out
220 * ownership to avoid a window where access is too open. */
222 if ( mode
!= MODE_INVALID
)
223 if ( chmod ( path
, mode
) < 0 )
226 if ( uid
!= UID_INVALID
|| gid
!= GID_INVALID
)
227 if ( chown ( path
, uid
, gid
) < 0 )
233 int fchmod_and_chown ( int fd
, mode_t mode
, uid_t uid
, gid_t gid
) {
234 /* Under the assumption that we are running privileged we
235 * first change the access mode and only then hand out
236 * ownership to avoid a window where access is too open. */
238 if ( mode
!= MODE_INVALID
)
239 if ( fchmod ( fd
, mode
) < 0 )
242 if ( uid
!= UID_INVALID
|| gid
!= GID_INVALID
)
243 if ( fchown ( fd
, uid
, gid
) < 0 )
249 int fchmod_umask ( int fd
, mode_t m
) {
254 r
= fchmod ( fd
, m
& (~ u
)) < 0 ? - errno
: 0 ;
260 int fchmod_opath ( int fd
, mode_t m
) {
261 char procfs_path
[ STRLEN ( "/proc/self/fd/" ) + DECIMAL_STR_MAX ( int )];
263 /* This function operates also on fd that might have been opened with
264 * O_PATH. Indeed fchmodat() doesn't have the AT_EMPTY_PATH flag like
265 * fchownat() does. */
267 xsprintf ( procfs_path
, "/proc/self/fd/%i" , fd
);
269 if ( chmod ( procfs_path
, m
) < 0 )
275 int fd_warn_permissions ( const char * path
, int fd
) {
278 if ( fstat ( fd
, & st
) < 0 )
281 if ( st
. st_mode
& 0111 )
282 log_warning ( "Configuration file %s is marked executable. Please remove executable permission bits. Proceeding anyway." , path
);
284 if ( st
. st_mode
& 0002 )
285 log_warning ( "Configuration file %s is marked world-writable. Please remove world writability permission bits. Proceeding anyway." , path
);
287 if ( getpid_cached () == 1 && ( st
. st_mode
& 0044 ) != 0044 )
288 log_warning ( "Configuration file %s is marked world-inaccessible. This has no effect as configuration data is accessible via APIs without restrictions. Proceeding anyway." , path
);
293 int touch_file ( const char * path
, bool parents
, usec_t stamp
, uid_t uid
, gid_t gid
, mode_t mode
) {
294 char fdpath
[ STRLEN ( "/proc/self/fd/" ) + DECIMAL_STR_MAX ( int )];
295 _cleanup_close_
int fd
= - 1 ;
300 /* Note that touch_file() does not follow symlinks: if invoked on an existing symlink, then it is the symlink
301 * itself which is updated, not its target
303 * Returns the first error we encounter, but tries to apply as much as possible. */
306 ( void ) mkdir_parents ( path
, 0755 );
308 /* Initially, we try to open the node with O_PATH, so that we get a reference to the node. This is useful in
309 * case the path refers to an existing device or socket node, as we can open it successfully in all cases, and
310 * won't trigger any driver magic or so. */
311 fd
= open ( path
, O_PATH
| O_CLOEXEC
| O_NOFOLLOW
);
316 /* if the node doesn't exist yet, we create it, but with O_EXCL, so that we only create a regular file
317 * here, and nothing else */
318 fd
= open ( path
, O_WRONLY
| O_CREAT
| O_EXCL
| O_CLOEXEC
, IN_SET ( mode
, 0 , MODE_INVALID
) ? 0644 : mode
);
323 /* Let's make a path from the fd, and operate on that. With this logic, we can adjust the access mode,
324 * ownership and time of the file node in all cases, even if the fd refers to an O_PATH object â which is
325 * something fchown(), fchmod(), futimensat() don't allow. */
326 xsprintf ( fdpath
, "/proc/self/fd/%i" , fd
);
328 if ( mode
!= MODE_INVALID
)
329 if ( chmod ( fdpath
, mode
) < 0 )
332 if ( uid_is_valid ( uid
) || gid_is_valid ( gid
))
333 if ( chown ( fdpath
, uid
, gid
) < 0 && ret
>= 0 )
336 if ( stamp
!= USEC_INFINITY
) {
337 struct timespec ts
[ 2 ];
339 timespec_store (& ts
[ 0 ], stamp
);
341 r
= utimensat ( AT_FDCWD
, fdpath
, ts
, 0 );
343 r
= utimensat ( AT_FDCWD
, fdpath
, NULL
, 0 );
344 if ( r
< 0 && ret
>= 0 )
350 int touch ( const char * path
) {
351 return touch_file ( path
, false , USEC_INFINITY
, UID_INVALID
, GID_INVALID
, MODE_INVALID
);
354 int symlink_idempotent ( const char * from
, const char * to
) {
360 if ( symlink ( from
, to
) < 0 ) {
361 _cleanup_free_
char * p
= NULL
;
366 r
= readlink_malloc ( to
, & p
);
367 if ( r
== - EINVAL
) /* Not a symlink? In that case return the original error we encountered: -EEXIST */
369 if ( r
< 0 ) /* Any other error? In that case propagate it as is */
372 if (! streq ( p
, from
)) /* Not the symlink we want it to be? In that case, propagate the original -EEXIST */
379 int symlink_atomic ( const char * from
, const char * to
) {
380 _cleanup_free_
char * t
= NULL
;
386 r
= tempfn_random ( to
, NULL
, & t
);
390 if ( symlink ( from
, t
) < 0 )
393 if ( rename ( t
, to
) < 0 ) {
401 int mknod_atomic ( const char * path
, mode_t mode
, dev_t dev
) {
402 _cleanup_free_
char * t
= NULL
;
407 r
= tempfn_random ( path
, NULL
, & t
);
411 if ( mknod ( t
, mode
, dev
) < 0 )
414 if ( rename ( t
, path
) < 0 ) {
422 int mkfifo_atomic ( const char * path
, mode_t mode
) {
423 _cleanup_free_
char * t
= NULL
;
428 r
= tempfn_random ( path
, NULL
, & t
);
432 if ( mkfifo ( t
, mode
) < 0 )
435 if ( rename ( t
, path
) < 0 ) {
443 int get_files_in_directory ( const char * path
, char *** list
) {
444 _cleanup_closedir_
DIR * d
= NULL
;
446 size_t bufsize
= 0 , n
= 0 ;
447 _cleanup_strv_free_
char ** l
= NULL
;
451 /* Returns all files in a directory in *list, and the number
452 * of files as return value. If list is NULL returns only the
459 FOREACH_DIRENT_ALL ( de
, d
, return - errno
) {
460 dirent_ensure_type ( d
, de
);
462 if (! dirent_is_file ( de
))
466 /* one extra slot is needed for the terminating NULL */
467 if (! GREEDY_REALLOC ( l
, bufsize
, n
+ 2 ))
470 l
[ n
] = strdup ( de
-> d_name
);
485 static int getenv_tmp_dir ( const char ** ret_path
) {
491 /* We use the same order of environment variables python uses in tempfile.gettempdir():
492 * https://docs.python.org/3/library/tempfile.html#tempfile.gettempdir */
493 FOREACH_STRING ( n
, "TMPDIR" , "TEMP" , "TMP" ) {
496 e
= secure_getenv ( n
);
499 if (! path_is_absolute ( e
)) {
503 if (! path_is_normalized ( e
)) {
520 /* Remember first error, to make this more debuggable */
532 static int tmp_dir_internal ( const char * def
, const char ** ret
) {
539 r
= getenv_tmp_dir (& e
);
545 k
= is_dir ( def
, true );
549 return r
< 0 ? r
: k
;
555 int var_tmp_dir ( const char ** ret
) {
557 /* Returns the location for "larger" temporary files, that is backed by physical storage if available, and thus
558 * even might survive a boot: /var/tmp. If $TMPDIR (or related environment variables) are set, its value is
559 * returned preferably however. Note that both this function and tmp_dir() below are affected by $TMPDIR,
560 * making it a variable that overrides all temporary file storage locations. */
562 return tmp_dir_internal ( "/var/tmp" , ret
);
565 int tmp_dir ( const char ** ret
) {
567 /* Similar to var_tmp_dir() above, but returns the location for "smaller" temporary files, which is usually
568 * backed by an in-memory file system: /tmp. */
570 return tmp_dir_internal ( "/tmp" , ret
);
573 int unlink_or_warn ( const char * filename
) {
574 if ( unlink ( filename
) < 0 && errno
!= ENOENT
)
575 /* If the file doesn't exist and the fs simply was read-only (in which
576 * case unlink() returns EROFS even if the file doesn't exist), don't
578 if ( errno
!= EROFS
|| access ( filename
, F_OK
) >= 0 )
579 return log_error_errno ( errno
, "Failed to remove \" %s \" : %m" , filename
);
584 int inotify_add_watch_fd ( int fd
, int what
, uint32_t mask
) {
585 char path
[ STRLEN ( "/proc/self/fd/" ) + DECIMAL_STR_MAX ( int ) + 1 ];
588 /* This is like inotify_add_watch(), except that the file to watch is not referenced by a path, but by an fd */
589 xsprintf ( path
, "/proc/self/fd/%i" , what
);
591 r
= inotify_add_watch ( fd
, path
, mask
);
598 static bool safe_transition ( const struct stat
* a
, const struct stat
* b
) {
599 /* Returns true if the transition from a to b is safe, i.e. that we never transition from unprivileged to
600 * privileged files or directories. Why bother? So that unprivileged code can't symlink to privileged files
601 * making us believe we read something safe even though it isn't safe in the specific context we open it in. */
603 if ( a
-> st_uid
== 0 ) /* Transitioning from privileged to unprivileged is always fine */
606 return a
-> st_uid
== b
-> st_uid
; /* Otherwise we need to stay within the same UID */
609 int chase_symlinks ( const char * path
, const char * original_root
, unsigned flags
, char ** ret
) {
610 _cleanup_free_
char * buffer
= NULL
, * done
= NULL
, * root
= NULL
;
611 _cleanup_close_
int fd
= - 1 ;
612 unsigned max_follow
= CHASE_SYMLINKS_MAX
; /* how many symlinks to follow before giving up and returning ELOOP */
613 struct stat previous_stat
;
620 /* Either the file may be missing, or we return an fd to the final object, but both make no sense */
621 if ( FLAGS_SET ( flags
, CHASE_NONEXISTENT
| CHASE_OPEN
))
624 if ( FLAGS_SET ( flags
, CHASE_STEP
| CHASE_OPEN
))
630 /* This is a lot like canonicalize_file_name(), but takes an additional "root" parameter, that allows following
631 * symlinks relative to a root directory, instead of the root of the host.
633 * Note that "root" primarily matters if we encounter an absolute symlink. It is also used when following
634 * relative symlinks to ensure they cannot be used to "escape" the root directory. The path parameter passed is
635 * assumed to be already prefixed by it, except if the CHASE_PREFIX_ROOT flag is set, in which case it is first
636 * prefixed accordingly.
638 * Algorithmically this operates on two path buffers: "done" are the components of the path we already
639 * processed and resolved symlinks, "." and ".." of. "todo" are the components of the path we still need to
640 * process. On each iteration, we move one component from "todo" to "done", processing it's special meaning
641 * each time. The "todo" path always starts with at least one slash, the "done" path always ends in no
642 * slash. We always keep an O_PATH fd to the component we are currently processing, thus keeping lookup races
645 * Suggested usage: whenever you want to canonicalize a path, use this function. Pass the absolute path you got
646 * as-is: fully qualified and relative to your host's root. Optionally, specify the root parameter to tell this
647 * function what to do when encountering a symlink with an absolute path as directory: prefix it by the
650 * There are three ways to invoke this function:
652 * 1. Without CHASE_STEP or CHASE_OPEN: in this case the path is resolved and the normalized path is returned
653 * in `ret`. The return value is < 0 on error. If CHASE_NONEXISTENT is also set 0 is returned if the file
654 * doesn't exist, > 0 otherwise. If CHASE_NONEXISTENT is not set >= 0 is returned if the destination was
655 * found, -ENOENT if it doesn't.
657 * 2. With CHASE_OPEN: in this case the destination is opened after chasing it as O_PATH and this file
658 * descriptor is returned as return value. This is useful to open files relative to some root
659 * directory. Note that the returned O_PATH file descriptors must be converted into a regular one (using
660 * fd_reopen() or such) before it can be used for reading/writing. CHASE_OPEN may not be combined with
663 * 3. With CHASE_STEP: in this case only a single step of the normalization is executed, i.e. only the first
664 * symlink or ".." component of the path is resolved, and the resulting path is returned. This is useful if
665 * a caller wants to trace the a path through the file system verbosely. Returns < 0 on error, > 0 if the
666 * path is fully normalized, and == 0 for each normalization step. This may be combined with
667 * CHASE_NONEXISTENT, in which case 1 is returned when a component is not found.
671 /* A root directory of "/" or "" is identical to none */
672 if ( empty_or_root ( original_root
))
673 original_root
= NULL
;
675 if (! original_root
&& ! ret
&& ( flags
& ( CHASE_NONEXISTENT
| CHASE_NO_AUTOFS
| CHASE_SAFE
| CHASE_OPEN
| CHASE_STEP
)) == CHASE_OPEN
) {
676 /* Shortcut the CHASE_OPEN case if the caller isn't interested in the actual path and has no root set
677 * and doesn't care about any of the other special features we provide either. */
678 r
= open ( path
, O_PATH
| O_CLOEXEC
);
686 r
= path_make_absolute_cwd ( original_root
, & root
);
690 if ( flags
& CHASE_PREFIX_ROOT
) {
692 /* We don't support relative paths in combination with a root directory */
693 if (! path_is_absolute ( path
))
696 path
= prefix_roota ( root
, path
);
700 r
= path_make_absolute_cwd ( path
, & buffer
);
704 fd
= open ( "/" , O_CLOEXEC
| O_NOFOLLOW
| O_PATH
);
708 if ( flags
& CHASE_SAFE
) {
709 if ( fstat ( fd
, & previous_stat
) < 0 )
715 _cleanup_free_
char * first
= NULL
;
716 _cleanup_close_
int child
= - 1 ;
720 /* Determine length of first component in the path */
721 n
= strspn ( todo
, "/" ); /* The slashes */
722 m
= n
+ strcspn ( todo
+ n
, "/" ); /* The entire length of the component */
724 /* Extract the first component. */
725 first
= strndup ( todo
, m
);
731 /* Empty? Then we reached the end. */
735 /* Just a single slash? Then we reached the end. */
736 if ( path_equal ( first
, "/" )) {
737 /* Preserve the trailing slash */
739 if ( flags
& CHASE_TRAIL_SLASH
)
740 if (! strextend (& done
, "/" , NULL
))
746 /* Just a dot? Then let's eat this up. */
747 if ( path_equal ( first
, "/." ))
750 /* Two dots? Then chop off the last bit of what we already found out. */
751 if ( path_equal ( first
, "/.." )) {
752 _cleanup_free_
char * parent
= NULL
;
753 _cleanup_close_
int fd_parent
= - 1 ;
755 /* If we already are at the top, then going up will not change anything. This is in-line with
756 * how the kernel handles this. */
757 if ( empty_or_root ( done
))
760 parent
= dirname_malloc ( done
);
764 /* Don't allow this to leave the root dir. */
766 path_startswith ( done
, root
) &&
767 ! path_startswith ( parent
, root
))
770 free_and_replace ( done
, parent
);
772 if ( flags
& CHASE_STEP
)
775 fd_parent
= openat ( fd
, ".." , O_CLOEXEC
| O_NOFOLLOW
| O_PATH
);
779 if ( flags
& CHASE_SAFE
) {
780 if ( fstat ( fd_parent
, & st
) < 0 )
783 if (! safe_transition (& previous_stat
, & st
))
790 fd
= TAKE_FD ( fd_parent
);
795 /* Otherwise let's see what this is. */
796 child
= openat ( fd
, first
+ n
, O_CLOEXEC
| O_NOFOLLOW
| O_PATH
);
799 if ( errno
== ENOENT
&&
800 ( flags
& CHASE_NONEXISTENT
) &&
801 ( isempty ( todo
) || path_is_normalized ( todo
))) {
803 /* If CHASE_NONEXISTENT is set, and the path does not exist, then that's OK, return
804 * what we got so far. But don't allow this if the remaining path contains "../ or "./"
805 * or something else weird. */
807 /* If done is "/", as first also contains slash at the head, then remove this redundant slash. */
808 if ( streq_ptr ( done
, "/" ))
811 if (! strextend (& done
, first
, todo
, NULL
))
821 if ( fstat ( child
, & st
) < 0 )
823 if (( flags
& CHASE_SAFE
) &&
824 ! safe_transition (& previous_stat
, & st
))
829 if (( flags
& CHASE_NO_AUTOFS
) &&
830 fd_is_fs_type ( child
, AUTOFS_SUPER_MAGIC
) > 0 )
833 if ( S_ISLNK ( st
. st_mode
)) {
836 _cleanup_free_
char * destination
= NULL
;
838 /* This is a symlink, in this case read the destination. But let's make sure we don't follow
839 * symlinks without bounds. */
840 if (-- max_follow
<= 0 )
843 r
= readlinkat_malloc ( fd
, first
+ n
, & destination
);
846 if ( isempty ( destination
))
849 if ( path_is_absolute ( destination
)) {
851 /* An absolute destination. Start the loop from the beginning, but use the root
852 * directory as base. */
855 fd
= open ( root
?: "/" , O_CLOEXEC
| O_NOFOLLOW
| O_PATH
);
859 if ( flags
& CHASE_SAFE
) {
860 if ( fstat ( fd
, & st
) < 0 )
863 if (! safe_transition (& previous_stat
, & st
))
871 /* Note that we do not revalidate the root, we take it as is. */
880 /* Prefix what's left to do with what we just read, and start the loop again, but
881 * remain in the current directory. */
882 joined
= strjoin ( destination
, todo
);
884 joined
= strjoin ( "/" , destination
, todo
);
889 todo
= buffer
= joined
;
891 if ( flags
& CHASE_STEP
)
897 /* If this is not a symlink, then let's just add the name we read to what we already verified. */
899 done
= TAKE_PTR ( first
);
901 /* If done is "/", as first also contains slash at the head, then remove this redundant slash. */
902 if ( streq ( done
, "/" ))
905 if (! strextend (& done
, first
, NULL
))
909 /* And iterate again, but go one directory further down. */
915 /* Special case, turn the empty string into "/", to indicate the root directory. */
922 * ret
= TAKE_PTR ( done
);
924 if ( flags
& CHASE_OPEN
) {
925 /* Return the O_PATH fd we currently are looking to the caller. It can translate it to a proper fd by
926 * opening /proc/self/fd/xyz. */
932 if ( flags
& CHASE_STEP
)
941 c
= strjoin ( strempty ( done
), todo
);
951 int chase_symlinks_and_open (
954 unsigned chase_flags
,
958 _cleanup_close_
int path_fd
= - 1 ;
959 _cleanup_free_
char * p
= NULL
;
962 if ( chase_flags
& CHASE_NONEXISTENT
)
965 if ( empty_or_root ( root
) && ! ret_path
&& ( chase_flags
& ( CHASE_NO_AUTOFS
| CHASE_SAFE
)) == 0 ) {
966 /* Shortcut this call if none of the special features of this call are requested */
967 r
= open ( path
, open_flags
);
974 path_fd
= chase_symlinks ( path
, root
, chase_flags
| CHASE_OPEN
, ret_path
? & p
: NULL
);
978 r
= fd_reopen ( path_fd
, open_flags
);
983 * ret_path
= TAKE_PTR ( p
);
988 int chase_symlinks_and_opendir (
991 unsigned chase_flags
,
995 char procfs_path
[ STRLEN ( "/proc/self/fd/" ) + DECIMAL_STR_MAX ( int )];
996 _cleanup_close_
int path_fd
= - 1 ;
997 _cleanup_free_
char * p
= NULL
;
1002 if ( chase_flags
& CHASE_NONEXISTENT
)
1005 if ( empty_or_root ( root
) && ! ret_path
&& ( chase_flags
& ( CHASE_NO_AUTOFS
| CHASE_SAFE
)) == 0 ) {
1006 /* Shortcut this call if none of the special features of this call are requested */
1015 path_fd
= chase_symlinks ( path
, root
, chase_flags
| CHASE_OPEN
, ret_path
? & p
: NULL
);
1019 xsprintf ( procfs_path
, "/proc/self/fd/%i" , path_fd
);
1020 d
= opendir ( procfs_path
);
1025 * ret_path
= TAKE_PTR ( p
);
1031 int chase_symlinks_and_stat (
1034 unsigned chase_flags
,
1036 struct stat
* ret_stat
) {
1038 _cleanup_close_
int path_fd
= - 1 ;
1039 _cleanup_free_
char * p
= NULL
;
1044 if ( chase_flags
& CHASE_NONEXISTENT
)
1047 if ( empty_or_root ( root
) && ! ret_path
&& ( chase_flags
& ( CHASE_NO_AUTOFS
| CHASE_SAFE
)) == 0 ) {
1048 /* Shortcut this call if none of the special features of this call are requested */
1049 if ( stat ( path
, ret_stat
) < 0 )
1055 path_fd
= chase_symlinks ( path
, root
, chase_flags
| CHASE_OPEN
, ret_path
? & p
: NULL
);
1059 if ( fstat ( path_fd
, ret_stat
) < 0 )
1063 * ret_path
= TAKE_PTR ( p
);
1065 if ( chase_flags
& CHASE_OPEN
)
1066 return TAKE_FD ( path_fd
);
1071 int access_fd ( int fd
, int mode
) {
1072 char p
[ STRLEN ( "/proc/self/fd/" ) + DECIMAL_STR_MAX ( fd
) + 1 ];
1075 /* Like access() but operates on an already open fd */
1077 xsprintf ( p
, "/proc/self/fd/%i" , fd
);
1078 r
= access ( p
, mode
);
1085 void unlink_tempfilep ( char (* p
)[]) {
1086 /* If the file is created with mkstemp(), it will (almost always)
1087 * change the suffix. Treat this as a sign that the file was
1088 * successfully created. We ignore both the rare case where the
1089 * original suffix is used and unlink failures. */
1090 if (! endswith (* p
, ".XXXXXX" ))
1091 ( void ) unlink_noerrno (* p
);
1094 int unlinkat_deallocate ( int fd
, const char * name
, int flags
) {
1095 _cleanup_close_
int truncate_fd
= - 1 ;
1099 /* Operates like unlinkat() but also deallocates the file contents if it is a regular file and there's no other
1100 * link to it. This is useful to ensure that other processes that might have the file open for reading won't be
1101 * able to keep the data pinned on disk forever. This call is particular useful whenever we execute clean-up
1102 * jobs ("vacuuming"), where we want to make sure the data is really gone and the disk space released and
1103 * returned to the free pool.
1105 * Deallocation is preferably done by FALLOC_FL_PUNCH_HOLE|FALLOC_FL_KEEP_SIZE (đ) if supported, which means
1106 * the file won't change size. That's a good thing since we shouldn't needlessly trigger SIGBUS in other
1107 * programs that have mmap()ed the file. (The assumption here is that changing file contents to all zeroes
1108 * underneath those programs is the better choice than simply triggering SIGBUS in them which truncation does.)
1109 * However if hole punching is not implemented in the kernel or file system we'll fall back to normal file
1110 * truncation (đĒ), as our goal of deallocating the data space trumps our goal of being nice to readers (đ).
1112 * Note that we attempt deallocation, but failure to succeed with that is not considered fatal, as long as the
1113 * primary job â to delete the file â is accomplished. */
1115 if (( flags
& AT_REMOVEDIR
) == 0 ) {
1116 truncate_fd
= openat ( fd
, name
, O_WRONLY
| O_CLOEXEC
| O_NOCTTY
| O_NOFOLLOW
| O_NONBLOCK
);
1117 if ( truncate_fd
< 0 ) {
1119 /* If this failed because the file doesn't exist propagate the error right-away. Also,
1120 * AT_REMOVEDIR wasn't set, and we tried to open the file for writing, which means EISDIR is
1121 * returned when this is a directory but we are not supposed to delete those, hence propagate
1122 * the error right-away too. */
1123 if ( IN_SET ( errno
, ENOENT
, EISDIR
))
1126 if ( errno
!= ELOOP
) /* don't complain if this is a symlink */
1127 log_debug_errno ( errno
, "Failed to open file '%s' for deallocation, ignoring: %m" , name
);
1131 if ( unlinkat ( fd
, name
, flags
) < 0 )
1134 if ( truncate_fd
< 0 ) /* Don't have a file handle, can't do more âšī¸ */
1137 if ( fstat ( truncate_fd
, & st
) < 0 ) {
1138 log_debug_errno ( errno
, "Failed to stat file '%s' for deallocation, ignoring." , name
);
1142 if (! S_ISREG ( st
. st_mode
) || st
. st_blocks
== 0 || st
. st_nlink
> 0 )
1145 /* If this is a regular file, it actually took up space on disk and there are no other links it's time to
1146 * punch-hole/truncate this to release the disk space. */
1148 bs
= MAX ( st
. st_blksize
, 512 );
1149 l
= DIV_ROUND_UP ( st
. st_size
, bs
) * bs
; /* Round up to next block size */
1151 if ( fallocate ( truncate_fd
, FALLOC_FL_PUNCH_HOLE
| FALLOC_FL_KEEP_SIZE
, 0 , l
) >= 0 )
1152 return 0 ; /* Successfully punched a hole! đ */
1154 /* Fall back to truncation */
1155 if ( ftruncate ( truncate_fd
, 0 ) < 0 ) {
1156 log_debug_errno ( errno
, "Failed to truncate file to 0, ignoring: %m" );
1163 int fsync_directory_of_file ( int fd
) {
1164 _cleanup_free_
char * path
= NULL
, * dn
= NULL
;
1165 _cleanup_close_
int dfd
= - 1 ;
1168 r
= fd_verify_regular ( fd
);
1172 r
= fd_get_path ( fd
, & path
);
1174 log_debug_errno ( r
, "Failed to query /proc/self/fd/%d%s: %m" ,
1176 r
== - EOPNOTSUPP
? ", ignoring" : "" );
1178 if ( r
== - EOPNOTSUPP
)
1179 /* If /proc is not available, we're most likely running in some
1180 * chroot environment, and syncing the directory is not very
1181 * important in that case. Let's just silently do nothing. */
1187 if (! path_is_absolute ( path
))
1190 dn
= dirname_malloc ( path
);
1194 dfd
= open ( dn
, O_RDONLY
| O_CLOEXEC
| O_DIRECTORY
);