2 This file is part of systemd.
4 Copyright 2010 Lennart Poettering
6 systemd is free software; you can redistribute it and/or modify it
7 under the terms of the GNU Lesser General Public License as published by
8 the Free Software Foundation; either version 2.1 of the License, or
9 (at your option) any later version.
11 systemd is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 Lesser General Public License for more details.
16 You should have received a copy of the GNU Lesser General Public License
17 along with systemd; If not, see <http://www.gnu.org/licenses/>.
28 #include <sys/types.h>
31 #include "alloc-util.h"
38 #include "hexdecoct.h"
42 #include "parse-util.h"
43 #include "path-util.h"
44 #include "process-util.h"
45 #include "random-util.h"
46 #include "stdio-util.h"
47 #include "string-util.h"
49 //#include "time-util.h"
50 #include "umask-util.h"
53 #define READ_FULL_BYTES_MAX (4U*1024U*1024U)
55 int write_string_stream_ts(FILE *f, const char *line, bool enforce_newline, struct timespec *ts) {
61 if (enforce_newline && !endswith(line, "\n"))
65 struct timespec twice[2] = {*ts, *ts};
67 if (futimens(fileno(f), twice) < 0)
71 return fflush_and_check(f);
74 static int write_string_file_atomic(const char *fn, const char *line, bool enforce_newline, bool do_fsync) {
75 _cleanup_fclose_ FILE *f = NULL;
76 _cleanup_free_ char *p = NULL;
82 r = fopen_temporary(fn, &f, &p);
86 (void) fchmod_umask(fileno(f), 0644);
88 r = write_string_stream(f, line, enforce_newline);
89 if (r >= 0 && do_fsync)
90 r = fflush_sync_and_check(f);
93 if (rename(p, fn) < 0)
103 int write_string_file_ts(const char *fn, const char *line, WriteStringFileFlags flags, struct timespec *ts) {
104 _cleanup_fclose_ FILE *f = NULL;
110 /* We don't know how to verify whether the file contents was already on-disk. */
111 assert(!((flags & WRITE_STRING_FILE_VERIFY_ON_FAILURE) && (flags & WRITE_STRING_FILE_SYNC)));
113 if (flags & WRITE_STRING_FILE_ATOMIC) {
114 assert(flags & WRITE_STRING_FILE_CREATE);
116 r = write_string_file_atomic(fn, line, !(flags & WRITE_STRING_FILE_AVOID_NEWLINE),
117 flags & WRITE_STRING_FILE_SYNC);
125 if (flags & WRITE_STRING_FILE_CREATE) {
134 /* We manually build our own version of fopen(..., "we") that
135 * works without O_CREAT */
136 fd = open(fn, O_WRONLY|O_CLOEXEC|O_NOCTTY);
142 f = fdopen(fd, "we");
150 r = write_string_stream_ts(f, line, !(flags & WRITE_STRING_FILE_AVOID_NEWLINE), ts);
154 if (flags & WRITE_STRING_FILE_SYNC) {
155 r = fflush_sync_and_check(f);
163 if (!(flags & WRITE_STRING_FILE_VERIFY_ON_FAILURE))
168 /* OK, the operation failed, but let's see if the right
169 * contents in place already. If so, eat up the error. */
171 q = verify_file(fn, line, !(flags & WRITE_STRING_FILE_AVOID_NEWLINE));
178 int read_one_line_file(const char *fn, char **line) {
179 _cleanup_fclose_ FILE *f = NULL;
180 char t[LINE_MAX], *c;
189 if (!fgets(t, sizeof(t), f)) {
192 return errno > 0 ? -errno : -EIO;
206 int verify_file(const char *fn, const char *blob, bool accept_extra_nl) {
207 _cleanup_fclose_ FILE *f = NULL;
208 _cleanup_free_ char *buf = NULL;
216 if (accept_extra_nl && endswith(blob, "\n"))
217 accept_extra_nl = false;
219 buf = malloc(l + accept_extra_nl + 1);
227 /* We try to read one byte more than we need, so that we know whether we hit eof */
229 k = fread(buf, 1, l + accept_extra_nl + 1, f);
231 return errno > 0 ? -errno : -EIO;
233 if (k != l && k != l + accept_extra_nl)
235 if (memcmp(buf, blob, l) != 0)
237 if (k > l && buf[l] != '\n')
243 int read_full_stream(FILE *f, char **contents, size_t *size) {
245 _cleanup_free_ char *buf = NULL;
251 if (fstat(fileno(f), &st) < 0)
256 if (S_ISREG(st.st_mode)) {
259 if (st.st_size > READ_FULL_BYTES_MAX)
262 /* Start with the right file size, but be prepared for
263 * files from /proc which generally report a file size
274 t = realloc(buf, n + 1);
279 k = fread(buf + l, 1, n - l, f);
289 /* We aren't expecting fread() to return a short read outside
290 * of (error && eof), assert buffer is full and enlarge buffer.
295 if (n >= READ_FULL_BYTES_MAX)
298 n = MIN(n * 2, READ_FULL_BYTES_MAX);
303 buf = NULL; /* do not free */
311 int read_full_file(const char *fn, char **contents, size_t *size) {
312 _cleanup_fclose_ FILE *f = NULL;
321 return read_full_stream(f, contents, size);
324 static int parse_env_file_internal(
328 int (*push) (const char *filename, unsigned line,
329 const char *key, char *value, void *userdata, int *n_pushed),
333 _cleanup_free_ char *contents = NULL, *key = NULL;
334 size_t key_alloc = 0, n_key = 0, value_alloc = 0, n_value = 0, last_value_whitespace = (size_t) -1, last_key_whitespace = (size_t) -1;
335 char *p, *value = NULL;
346 SINGLE_QUOTE_VALUE_ESCAPE,
348 DOUBLE_QUOTE_VALUE_ESCAPE,
356 r = read_full_stream(f, &contents, NULL);
358 r = read_full_file(fname, &contents, NULL);
362 for (p = contents; *p; p++) {
368 if (strchr(COMMENTS, c))
370 else if (!strchr(WHITESPACE, c)) {
372 last_key_whitespace = (size_t) -1;
374 if (!GREEDY_REALLOC(key, key_alloc, n_key+2)) {
384 if (strchr(newline, c)) {
388 } else if (c == '=') {
390 last_value_whitespace = (size_t) -1;
392 if (!strchr(WHITESPACE, c))
393 last_key_whitespace = (size_t) -1;
394 else if (last_key_whitespace == (size_t) -1)
395 last_key_whitespace = n_key;
397 if (!GREEDY_REALLOC(key, key_alloc, n_key+2)) {
408 if (strchr(newline, c)) {
416 /* strip trailing whitespace from key */
417 if (last_key_whitespace != (size_t) -1)
418 key[last_key_whitespace] = 0;
420 r = push(fname, line, key, value, userdata, n_pushed);
426 value_alloc = n_value = 0;
428 } else if (c == '\'')
429 state = SINGLE_QUOTE_VALUE;
431 state = DOUBLE_QUOTE_VALUE;
433 state = VALUE_ESCAPE;
434 else if (!strchr(WHITESPACE, c)) {
437 if (!GREEDY_REALLOC(value, value_alloc, n_value+2)) {
442 value[n_value++] = c;
448 if (strchr(newline, c)) {
457 /* Chomp off trailing whitespace from value */
458 if (last_value_whitespace != (size_t) -1)
459 value[last_value_whitespace] = 0;
461 /* strip trailing whitespace from key */
462 if (last_key_whitespace != (size_t) -1)
463 key[last_key_whitespace] = 0;
465 r = push(fname, line, key, value, userdata, n_pushed);
471 value_alloc = n_value = 0;
473 } else if (c == '\\') {
474 state = VALUE_ESCAPE;
475 last_value_whitespace = (size_t) -1;
477 if (!strchr(WHITESPACE, c))
478 last_value_whitespace = (size_t) -1;
479 else if (last_value_whitespace == (size_t) -1)
480 last_value_whitespace = n_value;
482 if (!GREEDY_REALLOC(value, value_alloc, n_value+2)) {
487 value[n_value++] = c;
495 if (!strchr(newline, c)) {
496 /* Escaped newlines we eat up entirely */
497 if (!GREEDY_REALLOC(value, value_alloc, n_value+2)) {
502 value[n_value++] = c;
506 case SINGLE_QUOTE_VALUE:
510 state = SINGLE_QUOTE_VALUE_ESCAPE;
512 if (!GREEDY_REALLOC(value, value_alloc, n_value+2)) {
517 value[n_value++] = c;
522 case SINGLE_QUOTE_VALUE_ESCAPE:
523 state = SINGLE_QUOTE_VALUE;
525 if (!strchr(newline, c)) {
526 if (!GREEDY_REALLOC(value, value_alloc, n_value+2)) {
531 value[n_value++] = c;
535 case DOUBLE_QUOTE_VALUE:
539 state = DOUBLE_QUOTE_VALUE_ESCAPE;
541 if (!GREEDY_REALLOC(value, value_alloc, n_value+2)) {
546 value[n_value++] = c;
551 case DOUBLE_QUOTE_VALUE_ESCAPE:
552 state = DOUBLE_QUOTE_VALUE;
554 if (!strchr(newline, c)) {
555 if (!GREEDY_REALLOC(value, value_alloc, n_value+2)) {
560 value[n_value++] = c;
566 state = COMMENT_ESCAPE;
567 else if (strchr(newline, c)) {
584 SINGLE_QUOTE_VALUE_ESCAPE,
586 DOUBLE_QUOTE_VALUE_ESCAPE)) {
594 if (last_value_whitespace != (size_t) -1)
595 value[last_value_whitespace] = 0;
597 /* strip trailing whitespace from key */
598 if (last_key_whitespace != (size_t) -1)
599 key[last_key_whitespace] = 0;
601 r = push(fname, line, key, value, userdata, n_pushed);
613 static int check_utf8ness_and_warn(
614 const char *filename, unsigned line,
615 const char *key, char *value) {
617 if (!utf8_is_valid(key)) {
618 _cleanup_free_ char *p = NULL;
620 p = utf8_escape_invalid(key);
621 log_error("%s:%u: invalid UTF-8 in key '%s', ignoring.", strna(filename), line, p);
625 if (value && !utf8_is_valid(value)) {
626 _cleanup_free_ char *p = NULL;
628 p = utf8_escape_invalid(value);
629 log_error("%s:%u: invalid UTF-8 value for key %s: '%s', ignoring.", strna(filename), line, key, p);
636 static int parse_env_file_push(
637 const char *filename, unsigned line,
638 const char *key, char *value,
643 va_list aq, *ap = userdata;
646 r = check_utf8ness_and_warn(filename, line, key, value);
652 while ((k = va_arg(aq, const char *))) {
655 v = va_arg(aq, char **);
677 const char *newline, ...) {
685 va_start(ap, newline);
686 r = parse_env_file_internal(NULL, fname, newline, parse_env_file_push, &ap, &n_pushed);
689 return r < 0 ? r : n_pushed;
692 #if 0 /// UNNEEDED by elogind
693 static int load_env_file_push(
694 const char *filename, unsigned line,
695 const char *key, char *value,
698 char ***m = userdata;
702 r = check_utf8ness_and_warn(filename, line, key, value);
706 p = strjoin(key, "=", value);
710 r = strv_env_replace(m, p);
723 int load_env_file(FILE *f, const char *fname, const char *newline, char ***rl) {
730 r = parse_env_file_internal(f, fname, newline, load_env_file_push, &m, NULL);
741 static int load_env_file_push_pairs(
742 const char *filename, unsigned line,
743 const char *key, char *value,
746 char ***m = userdata;
749 r = check_utf8ness_and_warn(filename, line, key, value);
753 r = strv_extend(m, key);
758 r = strv_extend(m, "");
762 r = strv_push(m, value);
773 int load_env_file_pairs(FILE *f, const char *fname, const char *newline, char ***rl) {
780 r = parse_env_file_internal(f, fname, newline, load_env_file_push_pairs, &m, NULL);
789 #if 0 /// UNNEEDED by elogind
791 static int merge_env_file_push(
792 const char *filename, unsigned line,
793 const char *key, char *value,
797 char ***env = userdata;
798 char *expanded_value;
803 log_error("%s:%u: invalid syntax (around \"%s\"), ignoring.", strna(filename), line, key);
807 if (!env_name_is_valid(key)) {
808 log_error("%s:%u: invalid variable name \"%s\", ignoring.", strna(filename), line, key);
813 expanded_value = replace_env(value, *env,
814 REPLACE_ENV_USE_ENVIRONMENT|
815 REPLACE_ENV_ALLOW_BRACELESS|
816 REPLACE_ENV_ALLOW_EXTENDED);
820 free_and_replace(value, expanded_value);
822 return load_env_file_push(filename, line, key, value, env, n_pushed);
830 /* NOTE: this function supports braceful and braceless variable expansions,
831 * plus "extended" substitutions, unlike other exported parsing functions.
834 return parse_env_file_internal(f, fname, NEWLINE, merge_env_file_push, env, NULL);
837 static void write_env_var(FILE *f, const char *v) {
843 fputs_unlocked(v, f);
844 fputc_unlocked('\n', f);
849 fwrite_unlocked(v, 1, p-v, f);
851 if (string_has_cc(p, NULL) || chars_intersect(p, WHITESPACE SHELL_NEED_QUOTES)) {
852 fputc_unlocked('\"', f);
855 if (strchr(SHELL_NEED_ESCAPE, *p))
856 fputc_unlocked('\\', f);
858 fputc_unlocked(*p, f);
861 fputc_unlocked('\"', f);
863 fputs_unlocked(p, f);
865 fputc_unlocked('\n', f);
868 int write_env_file(const char *fname, char **l) {
869 _cleanup_fclose_ FILE *f = NULL;
870 _cleanup_free_ char *p = NULL;
876 r = fopen_temporary(fname, &f, &p);
880 fchmod_umask(fileno(f), 0644);
883 write_env_var(f, *i);
885 r = fflush_and_check(f);
887 if (rename(p, fname) >= 0)
897 int executable_is_script(const char *path, char **interpreter) {
899 _cleanup_free_ char *line = NULL;
905 r = read_one_line_file(path, &line);
909 if (!startswith(line, "#!"))
912 ans = strstrip(line + 2);
913 len = strcspn(ans, " \t");
918 ans = strndup(ans, len);
928 * Retrieve one field from a file like /proc/self/status. pattern
929 * should not include whitespace or the delimiter (':'). pattern matches only
930 * the beginning of a line. Whitespace before ':' is skipped. Whitespace and
931 * zeros after the ':' will be skipped. field must be freed afterwards.
932 * terminator specifies the terminating characters of the field value (not
933 * included in the value).
935 int get_proc_field(const char *filename, const char *pattern, const char *terminator, char **field) {
936 _cleanup_free_ char *status = NULL;
946 r = read_full_file(filename, &status, NULL);
956 t = strstr(t, pattern);
960 /* Check that pattern occurs in beginning of line. */
961 pattern_ok = (t == status || t[-1] == '\n');
963 t += strlen(pattern);
965 } while (!pattern_ok);
967 t += strspn(t, " \t");
976 t += strspn(t, " \t");
978 /* Also skip zeros, because when this is used for
979 * capabilities, we don't want the zeros. This way the
980 * same capability set always maps to the same string,
981 * irrespective of the total capability set size. For
982 * other numbers it shouldn't matter. */
984 /* Back off one char if there's nothing but whitespace
986 if (!*t || isspace(*t))
990 len = strcspn(t, terminator);
1000 DIR *xopendirat(int fd, const char *name, int flags) {
1004 assert(!(flags & O_CREAT));
1006 nfd = openat(fd, name, O_RDONLY|O_NONBLOCK|O_DIRECTORY|O_CLOEXEC|flags, 0);
1019 #if 0 /// UNNEEDED by elogind
1020 static int search_and_fopen_internal(const char *path, const char *mode, const char *root, char **search, FILE **_f) {
1027 if (!path_strv_resolve_uniq(search, root))
1030 STRV_FOREACH(i, search) {
1031 _cleanup_free_ char *p = NULL;
1035 p = strjoin(root, *i, "/", path);
1037 p = strjoin(*i, "/", path);
1047 if (errno != ENOENT)
1054 int search_and_fopen(const char *path, const char *mode, const char *root, const char **search, FILE **_f) {
1055 _cleanup_strv_free_ char **copy = NULL;
1061 if (path_is_absolute(path)) {
1064 f = fopen(path, mode);
1073 copy = strv_copy((char**) search);
1077 return search_and_fopen_internal(path, mode, root, copy, _f);
1080 int search_and_fopen_nulstr(const char *path, const char *mode, const char *root, const char *search, FILE **_f) {
1081 _cleanup_strv_free_ char **s = NULL;
1083 if (path_is_absolute(path)) {
1086 f = fopen(path, mode);
1095 s = strv_split_nulstr(search);
1099 return search_and_fopen_internal(path, mode, root, s, _f);
1103 int fopen_temporary(const char *path, FILE **_f, char **_temp_path) {
1112 r = tempfn_xxxxxx(path, NULL, &t);
1116 fd = mkostemp_safe(t);
1122 f = fdopen(fd, "we");
1136 int fflush_and_check(FILE *f) {
1143 return errno > 0 ? -errno : -EIO;
1148 int fflush_sync_and_check(FILE *f) {
1153 r = fflush_and_check(f);
1157 if (fsync(fileno(f)) < 0)
1163 /* This is much like mkostemp() but is subject to umask(). */
1164 int mkostemp_safe(char *pattern) {
1165 _cleanup_umask_ mode_t u = 0;
1172 fd = mkostemp(pattern, O_CLOEXEC);
1179 int tempfn_xxxxxx(const char *p, const char *extra, char **ret) {
1191 * /foo/bar/.#<extra>waldoXXXXXX
1195 if (!filename_is_valid(fn))
1201 t = new(char, strlen(p) + 2 + strlen(extra) + 6 + 1);
1205 strcpy(stpcpy(stpcpy(stpcpy(mempcpy(t, p, fn - p), ".#"), extra), fn), "XXXXXX");
1207 *ret = path_kill_slashes(t);
1211 int tempfn_random(const char *p, const char *extra, char **ret) {
1225 * /foo/bar/.#<extra>waldobaa2a261115984a9
1229 if (!filename_is_valid(fn))
1235 t = new(char, strlen(p) + 2 + strlen(extra) + 16 + 1);
1239 x = stpcpy(stpcpy(stpcpy(mempcpy(t, p, fn - p), ".#"), extra), fn);
1242 for (i = 0; i < 16; i++) {
1243 *(x++) = hexchar(u & 0xF);
1249 *ret = path_kill_slashes(t);
1253 #if 0 /// UNNEEDED by elogind
1254 int tempfn_random_child(const char *p, const char *extra, char **ret) {
1265 * /foo/bar/waldo/.#<extra>3c2b6219aa75d7d0
1277 t = new(char, strlen(p) + 3 + strlen(extra) + 16 + 1);
1281 x = stpcpy(stpcpy(stpcpy(t, p), "/.#"), extra);
1284 for (i = 0; i < 16; i++) {
1285 *(x++) = hexchar(u & 0xF);
1291 *ret = path_kill_slashes(t);
1295 int write_timestamp_file_atomic(const char *fn, usec_t n) {
1296 char ln[DECIMAL_STR_MAX(n)+2];
1298 /* Creates a "timestamp" file, that contains nothing but a
1299 * usec_t timestamp, formatted in ASCII. */
1301 if (n <= 0 || n >= USEC_INFINITY)
1304 xsprintf(ln, USEC_FMT "\n", n);
1306 return write_string_file(fn, ln, WRITE_STRING_FILE_CREATE|WRITE_STRING_FILE_ATOMIC);
1309 int read_timestamp_file(const char *fn, usec_t *ret) {
1310 _cleanup_free_ char *ln = NULL;
1314 r = read_one_line_file(fn, &ln);
1318 r = safe_atou64(ln, &t);
1322 if (t <= 0 || t >= (uint64_t) USEC_INFINITY)
1329 int fputs_with_space(FILE *f, const char *s, const char *separator, bool *space) {
1334 /* Outputs the specified string with fputs(), but optionally prefixes it with a separator. The *space parameter
1335 * when specified shall initially point to a boolean variable initialized to false. It is set to true after the
1336 * first invocation. This call is supposed to be use in loops, where a separator shall be inserted between each
1337 * element, but not before the first one. */
1347 r = fputs(separator, f);
1359 int open_tmpfile_unlinkable(const char *directory, int flags) {
1364 r = tmp_dir(&directory);
1369 /* Returns an unlinked temporary file that cannot be linked into the file system anymore */
1371 /* Try O_TMPFILE first, if it is supported */
1372 fd = open(directory, flags|O_TMPFILE|O_EXCL, S_IRUSR|S_IWUSR);
1376 /* Fall back to unguessable name + unlinking */
1377 p = strjoina(directory, "/systemd-tmp-XXXXXX");
1379 fd = mkostemp_safe(p);
1388 #if 0 /// UNNEEDED by elogind
1389 int open_tmpfile_linkable(const char *target, int flags, char **ret_path) {
1390 _cleanup_free_ char *tmp = NULL;
1396 /* Don't allow O_EXCL, as that has a special meaning for O_TMPFILE */
1397 assert((flags & O_EXCL) == 0);
1399 /* Creates a temporary file, that shall be renamed to "target" later. If possible, this uses O_TMPFILE – in
1400 * which case "ret_path" will be returned as NULL. If not possible a the tempoary path name used is returned in
1401 * "ret_path". Use link_tmpfile() below to rename the result after writing the file in full. */
1404 _cleanup_free_ char *dn = NULL;
1406 dn = dirname_malloc(target);
1410 fd = open(dn, O_TMPFILE|flags, 0640);
1416 log_debug_errno(errno, "Failed to use O_TMPFILE on %s: %m", dn);
1419 r = tempfn_random(target, NULL, &tmp);
1423 fd = open(tmp, O_CREAT|O_EXCL|O_NOFOLLOW|O_NOCTTY|flags, 0640);
1434 int open_serialization_fd(const char *ident) {
1437 fd = memfd_create(ident, MFD_CLOEXEC);
1441 path = getpid_cached() == 1 ? "/run/systemd" : "/tmp";
1442 fd = open_tmpfile_unlinkable(path, O_RDWR|O_CLOEXEC);
1446 log_debug("Serializing %s to %s.", ident, path);
1448 log_debug("Serializing %s to memfd.", ident);
1453 #if 0 /// UNNEEDED by elogind
1454 int link_tmpfile(int fd, const char *path, const char *target) {
1459 /* Moves a temporary file created with open_tmpfile() above into its final place. if "path" is NULL an fd
1460 * created with O_TMPFILE is assumed, and linkat() is used. Otherwise it is assumed O_TMPFILE is not supported
1461 * on the directory, and renameat2() is used instead.
1463 * Note that in both cases we will not replace existing files. This is because linkat() does not support this
1464 * operation currently (renameat2() does), and there is no nice way to emulate this. */
1467 if (rename_noreplace(AT_FDCWD, path, AT_FDCWD, target) < 0)
1470 char proc_fd_path[strlen("/proc/self/fd/") + DECIMAL_STR_MAX(fd) + 1];
1472 xsprintf(proc_fd_path, "/proc/self/fd/%i", fd);
1474 if (linkat(AT_FDCWD, proc_fd_path, AT_FDCWD, target, AT_SYMLINK_FOLLOW) < 0)
1481 int read_nul_string(FILE *f, char **ret) {
1482 _cleanup_free_ char *x = NULL;
1483 size_t allocated = 0, n = 0;
1488 /* Reads a NUL-terminated string from the specified file. */
1493 if (!GREEDY_REALLOC(x, allocated, n+2))
1497 if (c == 0) /* Terminate at NUL byte */
1502 break; /* Terminate at EOF */
1522 int mkdtemp_malloc(const char *template, char **ret) {
1528 p = strdup(template);