src/basic/fileio.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #pragma once
   3
   4 /***
   5   Copyright 2010 Lennart Poettering
   6 ***/
   7
   8 #include <dirent.h>
   9 #include <stdbool.h>
  10 #include <stddef.h>
  11 #include <stdio.h>
  12 #include <sys/types.h>
  13
  14 #include "macro.h"
  15 #include "time-util.h"
  16
  17 typedef enum {
  18         WRITE_STRING_FILE_CREATE            = 1 << 0,
  19         WRITE_STRING_FILE_ATOMIC            = 1 << 1,
  20         WRITE_STRING_FILE_AVOID_NEWLINE     = 1 << 2,
  21         WRITE_STRING_FILE_VERIFY_ON_FAILURE = 1 << 3,
  22         WRITE_STRING_FILE_SYNC              = 1 << 4,
  23         WRITE_STRING_FILE_DISABLE_BUFFER    = 1 << 5,
  24
  25         /* And before you wonder, why write_string_file_atomic_label_ts() is a separate function instead of just one
  26            more flag here: it's about linking: we don't want to pull -lselinux into all users of write_string_file()
  27            and friends. */
  28
  29 } WriteStringFileFlags;
  30
  31 int write_string_stream_ts(FILE *f, const char *line, WriteStringFileFlags flags, struct timespec *ts);
  32 static inline int write_string_stream(FILE *f, const char *line, WriteStringFileFlags flags) {
  33         return write_string_stream_ts(f, line, flags, NULL);
  34 }
  35 int write_string_file_ts(const char *fn, const char *line, WriteStringFileFlags flags, struct timespec *ts);
  36 static inline int write_string_file(const char *fn, const char *line, WriteStringFileFlags flags) {
  37         return write_string_file_ts(fn, line, flags, NULL);
  38 }
  39
  40 int write_string_filef(const char *fn, WriteStringFileFlags flags, const char *format, ...) _printf_(3, 4);
  41
  42 int read_one_line_file(const char *fn, char **line);
  43 int read_full_file(const char *fn, char **contents, size_t *size);
  44 int read_full_stream(FILE *f, char **contents, size_t *size);
  45
  46 int verify_file(const char *fn, const char *blob, bool accept_extra_nl);
  47
  48 int parse_env_filev(FILE *f, const char *fname, const char *separator, va_list ap);
  49 int parse_env_file(FILE *f, const char *fname, const char *separator, ...) _sentinel_;
  50 int load_env_file(FILE *f, const char *fname, const char *separator, char ***l);
  51 int load_env_file_pairs(FILE *f, const char *fname, const char *separator, char ***l);
  52
  53 int merge_env_file(char ***env, FILE *f, const char *fname);
  54
  55 int write_env_file(const char *fname, char **l);
  56
  57 int executable_is_script(const char *path, char **interpreter);
  58
  59 int get_proc_field(const char *filename, const char *pattern, const char *terminator, char **field);
  60
  61 DIR *xopendirat(int dirfd, const char *name, int flags);
  62
  63 int search_and_fopen(const char *path, const char *mode, const char *root, const char **search, FILE **_f);
  64 int search_and_fopen_nulstr(const char *path, const char *mode, const char *root, const char *search, FILE **_f);
  65
  66 #define FOREACH_LINE(line, f, on_error)                         \
  67         for (;;)                                                \
  68                 if (!fgets(line, sizeof(line), f)) {            \
  69                         if (ferror(f)) {                        \
  70                                 on_error;                       \
  71                         }                                       \
  72                         break;                                  \
  73                 } else
  74
  75 int fflush_and_check(FILE *f);
  76 int fflush_sync_and_check(FILE *f);
  77
  78 int fopen_temporary(const char *path, FILE **_f, char **_temp_path);
  79 int mkostemp_safe(char *pattern);
  80
  81 int tempfn_xxxxxx(const char *p, const char *extra, char **ret);
  82 int tempfn_random(const char *p, const char *extra, char **ret);
  83 int tempfn_random_child(const char *p, const char *extra, char **ret);
  84
  85 int write_timestamp_file_atomic(const char *fn, usec_t n);
  86 int read_timestamp_file(const char *fn, usec_t *ret);
  87
  88 int fputs_with_space(FILE *f, const char *s, const char *separator, bool *space);
  89
  90 int open_tmpfile_unlinkable(const char *directory, int flags);
  91 int open_tmpfile_linkable(const char *target, int flags, char **ret_path);
  92 int open_serialization_fd(const char *ident);
  93
  94 int link_tmpfile(int fd, const char *path, const char *target);
  95
  96 int read_nul_string(FILE *f, char **ret);
  97
  98 int mkdtemp_malloc(const char *template, char **ret);
  99
 100 int read_line(FILE *f, size_t limit, char **ret);