1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
12 #include <sys/types.h>
15 #include "alloc-util.h"
20 #include "hexdecoct.h"
24 #include "nulstr-util.h"
25 #include "parse-util.h"
26 #include "path-util.h"
27 #include "socket-util.h"
28 #include "stdio-util.h"
29 #include "string-util.h"
30 #include "sync-util.h"
31 #include "tmpfile-util.h"
33 /* The maximum size of the file we'll read in one go in read_full_file() (64M). */
34 #define READ_FULL_BYTES_MAX (64U*1024U*1024U - 1U)
36 /* The maximum size of virtual files (i.e. procfs, sysfs, and other virtual "API" files) we'll read in one go
37 * in read_virtual_file(). Note that this limit is different (and much lower) than the READ_FULL_BYTES_MAX
38 * limit. This reflects the fact that we use different strategies for reading virtual and regular files:
39 * virtual files we generally have to read in a single read() syscall since the kernel doesn't support
40 * continuation read()s for them. Thankfully they are somewhat size constrained. Thus we can allocate the
41 * full potential buffer in advance. Regular files OTOH can be much larger, and there we grow the allocations
42 * exponentially in a loop. We use a size limit of 4M-2 because 4M-1 is the maximum buffer that /proc/sys/
43 * allows us to read() (larger reads will fail with ENOMEM), and we want to read one extra byte so that we
45 #define READ_VIRTUAL_BYTES_MAX (4U*1024U*1024U - 2U)
47 int fdopen_unlocked(int fd
, const char *options
, FILE **ret
) {
50 FILE *f
= fdopen(fd
, options
);
54 (void) __fsetlocking(f
, FSETLOCKING_BYCALLER
);
60 int take_fdopen_unlocked(int *fd
, const char *options
, FILE **ret
) {
65 r
= fdopen_unlocked(*fd
, options
, ret
);
74 FILE* take_fdopen(int *fd
, const char *options
) {
77 FILE *f
= fdopen(*fd
, options
);
86 DIR* take_fdopendir(int *dfd
) {
89 DIR *d
= fdopendir(*dfd
);
98 FILE* open_memstream_unlocked(char **ptr
, size_t *sizeloc
) {
99 FILE *f
= open_memstream(ptr
, sizeloc
);
103 (void) __fsetlocking(f
, FSETLOCKING_BYCALLER
);
108 FILE* fmemopen_unlocked(void *buf
, size_t size
, const char *mode
) {
109 FILE *f
= fmemopen(buf
, size
, mode
);
113 (void) __fsetlocking(f
, FSETLOCKING_BYCALLER
);
118 int write_string_stream_ts(
121 WriteStringFileFlags flags
,
122 const struct timespec
*ts
) {
134 /* If we shall set the timestamp we need the fd. But fmemopen() streams generally don't have
135 * an fd. Let's fail early in that case. */
141 if (flags
& WRITE_STRING_FILE_SUPPRESS_REDUNDANT_VIRTUAL
) {
142 _cleanup_free_
char *t
= NULL
;
144 /* If value to be written is same as that of the existing value, then suppress the write. */
152 /* Read an additional byte to detect cases where the prefix matches but the rest
153 * doesn't. Also, 0 returned by read_virtual_file_fd() means the read was truncated and
154 * it won't be equal to the new value. */
155 if (read_virtual_file_fd(fd
, strlen(line
)+1, &t
, NULL
) > 0 &&
156 streq_skip_trailing_chars(line
, t
, NEWLINE
)) {
157 log_debug("No change in value '%s', suppressing write", line
);
161 if (lseek(fd
, 0, SEEK_SET
) < 0)
165 needs_nl
= !(flags
& WRITE_STRING_FILE_AVOID_NEWLINE
) && !endswith(line
, "\n");
167 if (needs_nl
&& (flags
& WRITE_STRING_FILE_DISABLE_BUFFER
)) {
168 /* If STDIO buffering was disabled, then let's append the newline character to the string
169 * itself, so that the write goes out in one go, instead of two */
171 line
= strjoina(line
, "\n");
175 if (fputs(line
, f
) == EOF
)
179 if (fputc('\n', f
) == EOF
)
182 if (flags
& WRITE_STRING_FILE_SYNC
)
183 r
= fflush_sync_and_check(f
);
185 r
= fflush_and_check(f
);
190 const struct timespec twice
[2] = {*ts
, *ts
};
193 if (futimens(fd
, twice
) < 0)
200 static int write_string_file_atomic_at(
204 WriteStringFileFlags flags
,
205 const struct timespec
*ts
) {
207 _cleanup_fclose_
FILE *f
= NULL
;
208 _cleanup_free_
char *p
= NULL
;
214 /* Note that we'd really like to use O_TMPFILE here, but can't really, since we want replacement
215 * semantics here, and O_TMPFILE can't offer that. i.e. rename() replaces but linkat() doesn't. */
217 r
= fopen_temporary_at(dir_fd
, fn
, &f
, &p
);
221 r
= write_string_stream_ts(f
, line
, flags
, ts
);
225 r
= fchmod_umask(fileno(f
), FLAGS_SET(flags
, WRITE_STRING_FILE_MODE_0600
) ? 0600 : 0644);
229 if (renameat(dir_fd
, p
, dir_fd
, fn
) < 0) {
234 if (FLAGS_SET(flags
, WRITE_STRING_FILE_SYNC
)) {
235 /* Sync the rename, too */
236 r
= fsync_directory_of_file(fileno(f
));
244 (void) unlinkat(dir_fd
, p
, 0);
248 int write_string_file_ts_at(
252 WriteStringFileFlags flags
,
253 const struct timespec
*ts
) {
255 _cleanup_fclose_
FILE *f
= NULL
;
256 _cleanup_close_
int fd
= -EBADF
;
262 /* We don't know how to verify whether the file contents was already on-disk. */
263 assert(!((flags
& WRITE_STRING_FILE_VERIFY_ON_FAILURE
) && (flags
& WRITE_STRING_FILE_SYNC
)));
265 if (flags
& WRITE_STRING_FILE_MKDIR_0755
) {
266 r
= mkdirat_parents(dir_fd
, fn
, 0755);
271 if (flags
& WRITE_STRING_FILE_ATOMIC
) {
272 assert(flags
& WRITE_STRING_FILE_CREATE
);
274 r
= write_string_file_atomic_at(dir_fd
, fn
, line
, flags
, ts
);
282 /* We manually build our own version of fopen(..., "we") that works without O_CREAT and with O_NOFOLLOW if needed. */
283 fd
= openat(dir_fd
, fn
, O_CLOEXEC
|O_NOCTTY
|
284 (FLAGS_SET(flags
, WRITE_STRING_FILE_NOFOLLOW
) ? O_NOFOLLOW
: 0) |
285 (FLAGS_SET(flags
, WRITE_STRING_FILE_CREATE
) ? O_CREAT
: 0) |
286 (FLAGS_SET(flags
, WRITE_STRING_FILE_TRUNCATE
) ? O_TRUNC
: 0) |
287 (FLAGS_SET(flags
, WRITE_STRING_FILE_SUPPRESS_REDUNDANT_VIRTUAL
) ? O_RDWR
: O_WRONLY
),
288 (FLAGS_SET(flags
, WRITE_STRING_FILE_MODE_0600
) ? 0600 : 0666));
294 r
= take_fdopen_unlocked(&fd
, "w", &f
);
298 if (flags
& WRITE_STRING_FILE_DISABLE_BUFFER
)
299 setvbuf(f
, NULL
, _IONBF
, 0);
301 r
= write_string_stream_ts(f
, line
, flags
, ts
);
308 if (!(flags
& WRITE_STRING_FILE_VERIFY_ON_FAILURE
))
313 /* OK, the operation failed, but let's see if the right
314 * contents in place already. If so, eat up the error. */
316 q
= verify_file(fn
, line
, !(flags
& WRITE_STRING_FILE_AVOID_NEWLINE
) || (flags
& WRITE_STRING_FILE_VERIFY_IGNORE_NEWLINE
));
323 int write_string_filef(
325 WriteStringFileFlags flags
,
326 const char *format
, ...) {
328 _cleanup_free_
char *p
= NULL
;
332 va_start(ap
, format
);
333 r
= vasprintf(&p
, format
, ap
);
339 return write_string_file(fn
, p
, flags
);
342 int read_one_line_file_at(int dir_fd
, const char *filename
, char **ret
) {
343 _cleanup_fclose_
FILE *f
= NULL
;
346 assert(dir_fd
>= 0 || dir_fd
== AT_FDCWD
);
350 r
= fopen_unlocked_at(dir_fd
, filename
, "re", 0, &f
);
354 return read_line(f
, LONG_LINE_MAX
, ret
);
357 int verify_file_at(int dir_fd
, const char *fn
, const char *blob
, bool accept_extra_nl
) {
358 _cleanup_fclose_
FILE *f
= NULL
;
359 _cleanup_free_
char *buf
= NULL
;
368 if (accept_extra_nl
&& endswith(blob
, "\n"))
369 accept_extra_nl
= false;
371 buf
= malloc(l
+ accept_extra_nl
+ 1);
375 r
= fopen_unlocked_at(dir_fd
, fn
, "re", 0, &f
);
379 /* We try to read one byte more than we need, so that we know whether we hit eof */
381 k
= fread(buf
, 1, l
+ accept_extra_nl
+ 1, f
);
383 return errno_or_else(EIO
);
385 if (k
!= l
&& k
!= l
+ accept_extra_nl
)
387 if (memcmp(buf
, blob
, l
) != 0)
389 if (k
> l
&& buf
[l
] != '\n')
395 int read_virtual_file_fd(int fd
, size_t max_size
, char **ret_contents
, size_t *ret_size
) {
396 _cleanup_free_
char *buf
= NULL
;
399 bool truncated
= false;
401 /* Virtual filesystems such as sysfs or procfs use kernfs, and kernfs can work with two sorts of
402 * virtual files. One sort uses "seq_file", and the results of the first read are buffered for the
403 * second read. The other sort uses "raw" reads which always go direct to the device. In the latter
404 * case, the content of the virtual file must be retrieved with a single read otherwise a second read
405 * might get the new value instead of finding EOF immediately. That's the reason why the usage of
406 * fread(3) is prohibited in this case as it always performs a second call to read(2) looking for
407 * EOF. See issue #13585.
409 * max_size specifies a limit on the bytes read. If max_size is SIZE_MAX, the full file is read. If
410 * the full file is too large to read, an error is returned. For other values of max_size, *partial
411 * contents* may be returned. (Though the read is still done using one syscall.) Returns 0 on
412 * partial success, 1 if untruncated contents were read. */
415 assert(max_size
<= READ_VIRTUAL_BYTES_MAX
|| max_size
== SIZE_MAX
);
417 /* Limit the number of attempts to read the number of bytes returned by fstat(). */
423 if (fstat(fd
, &st
) < 0)
426 if (!S_ISREG(st
.st_mode
))
429 /* Be prepared for files from /proc which generally report a file size of 0. */
430 assert_cc(READ_VIRTUAL_BYTES_MAX
< SSIZE_MAX
);
431 if (st
.st_size
> 0 && n_retries
> 1) {
432 /* Let's use the file size if we have more than 1 attempt left. On the last attempt
433 * we'll ignore the file size */
435 if (st
.st_size
> SSIZE_MAX
) { /* Avoid overflow with 32-bit size_t and 64-bit off_t. */
437 if (max_size
== SIZE_MAX
)
442 size
= MIN((size_t) st
.st_size
, max_size
);
444 if (size
> READ_VIRTUAL_BYTES_MAX
)
449 } else if (n_retries
> 1) {
450 /* Files in /proc are generally smaller than the page size so let's start with
451 * a page size buffer from malloc and only use the max buffer on the final try. */
452 size
= MIN3(page_size() - 1, READ_VIRTUAL_BYTES_MAX
, max_size
);
455 size
= MIN(READ_VIRTUAL_BYTES_MAX
, max_size
);
459 buf
= malloc(size
+ 1);
463 /* Use a bigger allocation if we got it anyway, but not more than the limit. */
464 size
= MIN3(MALLOC_SIZEOF_SAFE(buf
) - 1, max_size
, READ_VIRTUAL_BYTES_MAX
);
469 /* Read one more byte so we can detect whether the content of the
470 * file has already changed or the guessed size for files from /proc
471 * wasn't large enough . */
472 k
= read(fd
, buf
, size
+ 1);
482 /* Consider a short read as EOF */
486 /* If a maximum size is specified and we already read more we know the file is larger, and
487 * can handle this as truncation case. Note that if the size of what we read equals the
488 * maximum size then this doesn't mean truncation, the file might or might not end on that
489 * byte. We need to rerun the loop in that case, with a larger buffer size, so that we read
490 * at least one more byte to be able to distinguish EOF from truncation. */
491 if (max_size
!= SIZE_MAX
&& n
> max_size
) {
492 n
= size
; /* Make sure we never use more than what we sized the buffer for (so that
493 * we have one free byte in it for the trailing NUL we add below). */
498 /* We have no further attempts left? Then the file is apparently larger than our limits. Give up. */
502 /* Hmm... either we read too few bytes from /proc or less likely the content of the file
503 * might have been changed (and is now bigger) while we were processing, let's try again
504 * either with the new file size. */
506 if (lseek(fd
, 0, SEEK_SET
) < 0)
514 /* Safety check: if the caller doesn't want to know the size of what we just read it will
515 * rely on the trailing NUL byte. But if there's an embedded NUL byte, then we should refuse
516 * operation as otherwise there'd be ambiguity about what we just read. */
517 if (!ret_size
&& memchr(buf
, 0, n
))
523 /* Return rest of the buffer to libc */
524 p
= realloc(buf
, n
+ 1);
531 *ret_contents
= TAKE_PTR(buf
);
540 int read_virtual_file_at(
542 const char *filename
,
547 _cleanup_close_
int fd
= -EBADF
;
549 assert(dir_fd
>= 0 || dir_fd
== AT_FDCWD
);
552 if (dir_fd
== AT_FDCWD
)
555 return read_virtual_file_fd(dir_fd
, max_size
, ret_contents
, ret_size
);
558 fd
= openat(dir_fd
, filename
, O_RDONLY
| O_NOCTTY
| O_CLOEXEC
);
562 return read_virtual_file_fd(fd
, max_size
, ret_contents
, ret_size
);
565 int read_full_stream_full(
567 const char *filename
,
570 ReadFullFileFlags flags
,
574 _cleanup_free_
char *buf
= NULL
;
575 size_t n
, n_next
= 0, l
;
579 assert(ret_contents
);
580 assert(!FLAGS_SET(flags
, READ_FULL_FILE_UNBASE64
| READ_FULL_FILE_UNHEX
));
581 assert(size
!= SIZE_MAX
|| !FLAGS_SET(flags
, READ_FULL_FILE_FAIL_WHEN_LARGER
));
583 if (offset
!= UINT64_MAX
&& offset
> LONG_MAX
) /* fseek() can only deal with "long" offsets */
587 if (fd
>= 0) { /* If the FILE* object is backed by an fd (as opposed to memory or such, see
588 * fmemopen()), let's optimize our buffering */
591 if (fstat(fd
, &st
) < 0)
594 if (S_ISREG(st
.st_mode
)) {
596 /* Try to start with the right file size if we shall read the file in full. Note
597 * that we increase the size to read here by one, so that the first read attempt
598 * already makes us notice the EOF. If the reported size of the file is zero, we
599 * avoid this logic however, since quite likely it might be a virtual file in procfs
600 * that all report a zero file size. */
602 if (st
.st_size
> 0 &&
603 (size
== SIZE_MAX
|| FLAGS_SET(flags
, READ_FULL_FILE_FAIL_WHEN_LARGER
))) {
606 LESS_BY((uint64_t) st
.st_size
, offset
== UINT64_MAX
? 0 : offset
);
608 if (rsize
< SIZE_MAX
) /* overflow check */
612 if (flags
& READ_FULL_FILE_WARN_WORLD_READABLE
)
613 (void) warn_file_is_world_accessible(filename
, &st
, NULL
, 0);
617 /* If we don't know how much to read, figure it out now. If we shall read a part of the file, then
618 * allocate the requested size. If we shall load the full file start with LINE_MAX. Note that if
619 * READ_FULL_FILE_FAIL_WHEN_LARGER we consider the specified size a safety limit, and thus also start
620 * with LINE_MAX, under assumption the file is most likely much shorter. */
622 n_next
= size
!= SIZE_MAX
&& !FLAGS_SET(flags
, READ_FULL_FILE_FAIL_WHEN_LARGER
) ? size
: LINE_MAX
;
624 /* Never read more than we need to determine that our own limit is hit */
625 if (n_next
> READ_FULL_BYTES_MAX
)
626 n_next
= READ_FULL_BYTES_MAX
+ 1;
628 if (offset
!= UINT64_MAX
&& fseek(f
, offset
, SEEK_SET
) < 0)
636 /* If we shall fail when reading overly large data, then read exactly one byte more than the
637 * specified size at max, since that'll tell us if there's anymore data beyond the limit*/
638 if (FLAGS_SET(flags
, READ_FULL_FILE_FAIL_WHEN_LARGER
) && n_next
> size
)
641 if (flags
& READ_FULL_FILE_SECURE
) {
642 t
= malloc(n_next
+ 1);
647 memcpy_safe(t
, buf
, n
);
648 explicit_bzero_safe(buf
, n
);
651 t
= realloc(buf
, n_next
+ 1);
657 /* Unless a size has been explicitly specified, try to read as much as fits into the memory
658 * we allocated (minus 1, to leave one byte for the safety NUL byte) */
659 n
= size
== SIZE_MAX
? MALLOC_SIZEOF_SAFE(buf
) - 1 : n_next
;
662 k
= fread(buf
+ l
, 1, n
- l
, f
);
668 r
= errno_or_else(EIO
);
674 if (size
!= SIZE_MAX
&& !FLAGS_SET(flags
, READ_FULL_FILE_FAIL_WHEN_LARGER
)) { /* If we got asked to read some specific size, we already sized the buffer right, hence leave */
679 assert(k
> 0); /* we can't have read zero bytes because that would have been EOF */
681 if (FLAGS_SET(flags
, READ_FULL_FILE_FAIL_WHEN_LARGER
) && l
> size
) {
686 if (n
>= READ_FULL_BYTES_MAX
) {
691 n_next
= MIN(n
* 2, READ_FULL_BYTES_MAX
);
694 if (flags
& (READ_FULL_FILE_UNBASE64
| READ_FULL_FILE_UNHEX
)) {
695 _cleanup_free_
void *decoded
= NULL
;
699 if (flags
& READ_FULL_FILE_UNBASE64
)
700 r
= unbase64mem_full(buf
, l
, flags
& READ_FULL_FILE_SECURE
, &decoded
, &decoded_size
);
702 r
= unhexmem_full(buf
, l
, flags
& READ_FULL_FILE_SECURE
, &decoded
, &decoded_size
);
706 if (flags
& READ_FULL_FILE_SECURE
)
707 explicit_bzero_safe(buf
, n
);
708 free_and_replace(buf
, decoded
);
709 n
= l
= decoded_size
;
713 /* Safety check: if the caller doesn't want to know the size of what we just read it will rely on the
714 * trailing NUL byte. But if there's an embedded NUL byte, then we should refuse operation as otherwise
715 * there'd be ambiguity about what we just read. */
717 if (memchr(buf
, 0, l
)) {
724 *ret_contents
= TAKE_PTR(buf
);
732 if (flags
& READ_FULL_FILE_SECURE
)
733 explicit_bzero_safe(buf
, n
);
738 int read_full_file_full(
740 const char *filename
,
743 ReadFullFileFlags flags
,
744 const char *bind_name
,
748 _cleanup_fclose_
FILE *f
= NULL
;
749 XfopenFlags xflags
= XFOPEN_UNLOCKED
;
753 assert(ret_contents
);
755 if (FLAGS_SET(flags
, READ_FULL_FILE_CONNECT_SOCKET
) && /* If this is enabled, let's try to connect to it */
756 offset
== UINT64_MAX
) /* Seeking is not supported on AF_UNIX sockets */
757 xflags
|= XFOPEN_SOCKET
;
759 r
= xfopenat_full(dir_fd
, filename
, "re", 0, xflags
, bind_name
, &f
);
763 return read_full_stream_full(f
, filename
, offset
, size
, flags
, ret_contents
, ret_size
);
766 int executable_is_script(const char *path
, char **interpreter
) {
767 _cleanup_free_
char *line
= NULL
;
774 r
= read_one_line_file(path
, &line
);
775 if (r
== -ENOBUFS
) /* First line overly long? if so, then it's not a script */
780 if (!startswith(line
, "#!"))
783 ans
= strstrip(line
+ 2);
784 len
= strcspn(ans
, " \t");
789 ans
= strndup(ans
, len
);
798 * Retrieve one field from a file like /proc/self/status. pattern
799 * should not include whitespace or the delimiter (':'). pattern matches only
800 * the beginning of a line. Whitespace before ':' is skipped. Whitespace and
801 * zeros after the ':' will be skipped. field must be freed afterwards.
802 * terminator specifies the terminating characters of the field value (not
803 * included in the value).
805 int get_proc_field(const char *filename
, const char *pattern
, const char *terminator
, char **field
) {
806 _cleanup_free_
char *status
= NULL
;
815 r
= read_full_virtual_file(filename
, &status
, NULL
);
825 t
= strstr(t
, pattern
);
829 /* Check that pattern occurs in beginning of line. */
830 pattern_ok
= (t
== status
|| t
[-1] == '\n');
832 t
+= strlen(pattern
);
834 } while (!pattern_ok
);
836 t
+= strspn(t
, " \t");
845 t
+= strspn(t
, " \t");
847 /* Also skip zeros, because when this is used for
848 * capabilities, we don't want the zeros. This way the
849 * same capability set always maps to the same string,
850 * irrespective of the total capability set size. For
851 * other numbers it shouldn't matter. */
853 /* Back off one char if there's nothing but whitespace
855 if (!*t
|| isspace(*t
))
859 f
= strdupcspn(t
, terminator
);
867 DIR *xopendirat(int fd
, const char *name
, int flags
) {
868 _cleanup_close_
int nfd
= -EBADF
;
870 assert(!(flags
& O_CREAT
));
872 if (fd
== AT_FDCWD
&& flags
== 0)
873 return opendir(name
);
875 nfd
= openat(fd
, name
, O_RDONLY
|O_NONBLOCK
|O_DIRECTORY
|O_CLOEXEC
|flags
, 0);
879 return take_fdopendir(&nfd
);
882 int fopen_mode_to_flags(const char *mode
) {
888 if ((p
= startswith(mode
, "r+")))
890 else if ((p
= startswith(mode
, "r")))
892 else if ((p
= startswith(mode
, "w+")))
893 flags
= O_RDWR
|O_CREAT
|O_TRUNC
;
894 else if ((p
= startswith(mode
, "w")))
895 flags
= O_WRONLY
|O_CREAT
|O_TRUNC
;
896 else if ((p
= startswith(mode
, "a+")))
897 flags
= O_RDWR
|O_CREAT
|O_APPEND
;
898 else if ((p
= startswith(mode
, "a")))
899 flags
= O_WRONLY
|O_CREAT
|O_APPEND
;
903 for (; *p
!= 0; p
++) {
916 /* ignore this here, fdopen() might care later though */
919 case 'c': /* not sure what to do about this one */
928 static int xfopenat_regular(int dir_fd
, const char *path
, const char *mode
, int open_flags
, FILE **ret
) {
931 /* A combination of fopen() with openat() */
933 assert(dir_fd
>= 0 || dir_fd
== AT_FDCWD
);
938 if (dir_fd
== AT_FDCWD
&& open_flags
== 0)
939 f
= fopen(path
, mode
);
941 _cleanup_close_
int fd
= -EBADF
;
944 mode_flags
= fopen_mode_to_flags(mode
);
948 fd
= openat(dir_fd
, path
, mode_flags
| open_flags
);
952 f
= take_fdopen(&fd
, mode
);
961 static int xfopenat_unix_socket(int dir_fd
, const char *path
, const char *bind_name
, FILE **ret
) {
962 _cleanup_close_
int sk
= -EBADF
;
966 assert(dir_fd
>= 0 || dir_fd
== AT_FDCWD
);
970 sk
= socket(AF_UNIX
, SOCK_STREAM
|SOCK_CLOEXEC
, 0);
975 /* If the caller specified a socket name to bind to, do so before connecting. This is
976 * useful to communicate some minor, short meta-information token from the client to
978 union sockaddr_union bsa
;
980 r
= sockaddr_un_set_path(&bsa
.un
, bind_name
);
984 if (bind(sk
, &bsa
.sa
, r
) < 0)
988 r
= connect_unix_path(sk
, dir_fd
, path
);
992 if (shutdown(sk
, SHUT_WR
) < 0)
995 f
= take_fdopen(&sk
, "r");
1009 const char *bind_name
,
1012 FILE *f
= NULL
; /* avoid false maybe-uninitialized warning */
1015 assert(dir_fd
>= 0 || dir_fd
== AT_FDCWD
);
1020 r
= xfopenat_regular(dir_fd
, path
, mode
, open_flags
, &f
);
1021 if (r
== -ENXIO
&& FLAGS_SET(flags
, XFOPEN_SOCKET
)) {
1022 /* ENXIO is what Linux returns if we open a node that is an AF_UNIX socket */
1023 r
= xfopenat_unix_socket(dir_fd
, path
, bind_name
, &f
);
1024 if (IN_SET(r
, -ENOTSOCK
, -EINVAL
))
1025 return -ENXIO
; /* propagate original error if this is not a socket after all */
1030 if (FLAGS_SET(flags
, XFOPEN_UNLOCKED
))
1031 (void) __fsetlocking(f
, FSETLOCKING_BYCALLER
);
1037 int fdopen_independent(int fd
, const char *mode
, FILE **ret
) {
1038 _cleanup_close_
int copy_fd
= -EBADF
;
1039 _cleanup_fclose_
FILE *f
= NULL
;
1046 /* A combination of fdopen() + fd_reopen(). i.e. reopens the inode the specified fd points to and
1047 * returns a FILE* for it */
1049 mode_flags
= fopen_mode_to_flags(mode
);
1053 copy_fd
= fd_reopen(fd
, mode_flags
);
1057 f
= take_fdopen(©_fd
, mode
);
1065 static int search_and_fopen_internal(
1077 if (!path_strv_resolve_uniq(search
, root
))
1080 STRV_FOREACH(i
, search
) {
1081 _cleanup_free_
char *p
= NULL
;
1084 p
= path_join(root
, *i
, path
);
1091 *ret_path
= path_simplify(TAKE_PTR(p
));
1097 if (errno
!= ENOENT
)
1104 int search_and_fopen(
1105 const char *filename
,
1108 const char **search
,
1112 _cleanup_strv_free_
char **copy
= NULL
;
1118 if (path_is_absolute(filename
)) {
1119 _cleanup_fclose_
FILE *f
= NULL
;
1121 f
= fopen(filename
, mode
);
1128 p
= strdup(filename
);
1132 *ret_path
= path_simplify(p
);
1139 copy
= strv_copy((char**) search
);
1143 return search_and_fopen_internal(filename
, mode
, root
, copy
, ret
, ret_path
);
1146 int search_and_fopen_nulstr(
1147 const char *filename
,
1154 _cleanup_strv_free_
char **s
= NULL
;
1156 if (path_is_absolute(filename
)) {
1157 _cleanup_fclose_
FILE *f
= NULL
;
1159 f
= fopen(filename
, mode
);
1166 p
= strdup(filename
);
1170 *ret_path
= path_simplify(p
);
1177 s
= strv_split_nulstr(search
);
1181 return search_and_fopen_internal(filename
, mode
, root
, s
, ret
, ret_path
);
1184 int fflush_and_check(FILE *f
) {
1191 return errno_or_else(EIO
);
1196 int fflush_sync_and_check(FILE *f
) {
1201 r
= fflush_and_check(f
);
1205 /* Not all file streams have an fd associated (think: fmemopen()), let's handle this gracefully and
1206 * assume that in that case we need no explicit syncing */
1218 int write_timestamp_file_atomic(const char *fn
, usec_t n
) {
1219 char ln
[DECIMAL_STR_MAX(n
)+2];
1221 /* Creates a "timestamp" file, that contains nothing but a
1222 * usec_t timestamp, formatted in ASCII. */
1224 if (!timestamp_is_set(n
))
1227 xsprintf(ln
, USEC_FMT
"\n", n
);
1229 return write_string_file(fn
, ln
, WRITE_STRING_FILE_CREATE
|WRITE_STRING_FILE_ATOMIC
);
1232 int read_timestamp_file(const char *fn
, usec_t
*ret
) {
1233 _cleanup_free_
char *ln
= NULL
;
1237 r
= read_one_line_file(fn
, &ln
);
1241 r
= safe_atou64(ln
, &t
);
1245 if (!timestamp_is_set(t
))
1252 int fputs_with_space(FILE *f
, const char *s
, const char *separator
, bool *space
) {
1257 /* Outputs the specified string with fputs(), but optionally prefixes it with a separator. The *space parameter
1258 * when specified shall initially point to a boolean variable initialized to false. It is set to true after the
1259 * first invocation. This call is supposed to be use in loops, where a separator shall be inserted between each
1260 * element, but not before the first one. */
1270 r
= fputs(separator
, f
);
1281 /* A bitmask of the EOL markers we know */
1282 typedef enum EndOfLineMarker
{
1284 EOL_ZERO
= 1 << 0, /* \0 (aka NUL) */
1285 EOL_TEN
= 1 << 1, /* \n (aka NL, aka LF) */
1286 EOL_THIRTEEN
= 1 << 2, /* \r (aka CR) */
1289 static EndOfLineMarker
categorize_eol(char c
, ReadLineFlags flags
) {
1291 if (!FLAGS_SET(flags
, READ_LINE_ONLY_NUL
)) {
1295 return EOL_THIRTEEN
;
1304 DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(FILE*, funlockfile
, NULL
);
1306 int read_line_full(FILE *f
, size_t limit
, ReadLineFlags flags
, char **ret
) {
1307 _cleanup_free_
char *buffer
= NULL
;
1308 size_t n
= 0, count
= 0;
1313 /* Something like a bounded version of getline().
1315 * Considers EOF, \n, \r and \0 end of line delimiters (or combinations of these), and does not include these
1316 * delimiters in the string returned. Specifically, recognizes the following combinations of markers as line
1329 * Returns the number of bytes read from the files (i.e. including delimiters — this hence usually differs from
1330 * the number of characters in the returned string). When EOF is hit, 0 is returned.
1332 * The input parameter limit is the maximum numbers of characters in the returned string, i.e. excluding
1333 * delimiters. If the limit is hit we fail and return -ENOBUFS.
1335 * If a line shall be skipped ret may be initialized as NULL. */
1338 if (!GREEDY_REALLOC(buffer
, 1))
1343 _unused_
_cleanup_(funlockfilep
) FILE *flocked
= f
;
1344 EndOfLineMarker previous_eol
= EOL_NONE
;
1348 EndOfLineMarker eol
;
1354 if (count
>= INT_MAX
) /* We couldn't return the counter anymore as "int", hence refuse this */
1357 r
= safe_fgetc(f
, &c
);
1360 if (r
== 0) /* EOF is definitely EOL */
1363 eol
= categorize_eol(c
, flags
);
1365 if (FLAGS_SET(previous_eol
, EOL_ZERO
) ||
1366 (eol
== EOL_NONE
&& previous_eol
!= EOL_NONE
) ||
1367 (eol
!= EOL_NONE
&& (previous_eol
& eol
) != 0)) {
1368 /* Previous char was a NUL? This is not an EOL, but the previous char was? This type of
1369 * EOL marker has been seen right before? In either of these three cases we are
1370 * done. But first, let's put this character back in the queue. (Note that we have to
1371 * cast this to (unsigned char) here as ungetc() expects a positive 'int', and if we
1372 * are on an architecture where 'char' equals 'signed char' we need to ensure we don't
1373 * pass a negative value here. That said, to complicate things further ungetc() is
1374 * actually happy with most negative characters and implicitly casts them back to
1375 * positive ones as needed, except for \xff (aka -1, aka EOF), which it refuses. What a
1377 assert_se(ungetc((unsigned char) c
, f
) != EOF
);
1383 if (eol
!= EOL_NONE
) {
1384 /* If we are on a tty, we can't shouldn't wait for more input, because that
1385 * generally means waiting for the user, interactively. In the case of a TTY
1386 * we expect only \n as the single EOL marker, so we are in the lucky
1387 * position that there is no need to wait. We check this condition last, to
1388 * avoid isatty() check if not necessary. */
1390 if ((flags
& (READ_LINE_IS_A_TTY
|READ_LINE_NOT_A_TTY
)) == 0) {
1394 if (fd
< 0) /* Maybe an fmemopen() stream? Handle this gracefully,
1395 * and don't call isatty() on an invalid fd */
1396 flags
|= READ_LINE_NOT_A_TTY
;
1398 flags
|= isatty(fd
) ? READ_LINE_IS_A_TTY
: READ_LINE_NOT_A_TTY
;
1400 if (FLAGS_SET(flags
, READ_LINE_IS_A_TTY
))
1404 if (eol
!= EOL_NONE
) {
1405 previous_eol
|= eol
;
1410 if (!GREEDY_REALLOC(buffer
, n
+ 2))
1423 *ret
= TAKE_PTR(buffer
);
1429 int safe_fgetc(FILE *f
, char *ret
) {
1434 /* A safer version of plain fgetc(): let's propagate the error that happened while reading as such, and
1435 * separate the EOF condition from the byte read, to avoid those confusion signed/unsigned issues fgetc()
1442 return errno_or_else(EIO
);
1456 int warn_file_is_world_accessible(const char *filename
, struct stat
*st
, const char *unit
, unsigned line
) {
1463 if (stat(filename
, &_st
) < 0)
1468 if ((st
->st_mode
& S_IRWXO
) == 0)
1472 log_syntax(unit
, LOG_WARNING
, filename
, line
, 0,
1473 "%s has %04o mode that is too permissive, please adjust the ownership and access mode.",
1474 filename
, st
->st_mode
& 07777);
1476 log_warning("%s has %04o mode that is too permissive, please adjust the ownership and access mode.",
1477 filename
, st
->st_mode
& 07777);