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"
37 #include "hexdecoct.h"
41 #include "parse-util.h"
42 #include "path-util.h"
43 #include "random-util.h"
44 #include "stdio-util.h"
45 #include "string-util.h"
47 //#include "time-util.h"
48 #include "umask-util.h"
51 #define READ_FULL_BYTES_MAX (4U*1024U*1024U)
53 int write_string_stream_ts(FILE *f, const char *line, bool enforce_newline, struct timespec *ts) {
59 if (enforce_newline && !endswith(line, "\n"))
63 struct timespec twice[2] = {*ts, *ts};
65 if (futimens(fileno(f), twice) < 0)
69 return fflush_and_check(f);
72 static int write_string_file_atomic(const char *fn, const char *line, bool enforce_newline) {
73 _cleanup_fclose_ FILE *f = NULL;
74 _cleanup_free_ char *p = NULL;
80 r = fopen_temporary(fn, &f, &p);
84 (void) fchmod_umask(fileno(f), 0644);
86 r = write_string_stream(f, line, enforce_newline);
88 if (rename(p, fn) < 0)
98 int write_string_file_ts(const char *fn, const char *line, WriteStringFileFlags flags, struct timespec *ts) {
99 _cleanup_fclose_ FILE *f = NULL;
105 if (flags & WRITE_STRING_FILE_ATOMIC) {
106 assert(flags & WRITE_STRING_FILE_CREATE);
108 r = write_string_file_atomic(fn, line, !(flags & WRITE_STRING_FILE_AVOID_NEWLINE));
116 if (flags & WRITE_STRING_FILE_CREATE) {
125 /* We manually build our own version of fopen(..., "we") that
126 * works without O_CREAT */
127 fd = open(fn, O_WRONLY|O_CLOEXEC|O_NOCTTY);
133 f = fdopen(fd, "we");
141 r = write_string_stream_ts(f, line, !(flags & WRITE_STRING_FILE_AVOID_NEWLINE), ts);
148 if (!(flags & WRITE_STRING_FILE_VERIFY_ON_FAILURE))
153 /* OK, the operation failed, but let's see if the right
154 * contents in place already. If so, eat up the error. */
156 q = verify_file(fn, line, !(flags & WRITE_STRING_FILE_AVOID_NEWLINE));
163 int read_one_line_file(const char *fn, char **line) {
164 _cleanup_fclose_ FILE *f = NULL;
165 char t[LINE_MAX], *c;
174 if (!fgets(t, sizeof(t), f)) {
177 return errno > 0 ? -errno : -EIO;
191 int verify_file(const char *fn, const char *blob, bool accept_extra_nl) {
192 _cleanup_fclose_ FILE *f = NULL;
193 _cleanup_free_ char *buf = NULL;
201 if (accept_extra_nl && endswith(blob, "\n"))
202 accept_extra_nl = false;
204 buf = malloc(l + accept_extra_nl + 1);
212 /* We try to read one byte more than we need, so that we know whether we hit eof */
214 k = fread(buf, 1, l + accept_extra_nl + 1, f);
216 return errno > 0 ? -errno : -EIO;
218 if (k != l && k != l + accept_extra_nl)
220 if (memcmp(buf, blob, l) != 0)
222 if (k > l && buf[l] != '\n')
228 int read_full_stream(FILE *f, char **contents, size_t *size) {
230 _cleanup_free_ char *buf = NULL;
236 if (fstat(fileno(f), &st) < 0)
241 if (S_ISREG(st.st_mode)) {
244 if (st.st_size > READ_FULL_BYTES_MAX)
247 /* Start with the right file size, but be prepared for
248 * files from /proc which generally report a file size
259 t = realloc(buf, n + 1);
264 k = fread(buf + l, 1, n - l, f);
274 /* We aren't expecting fread() to return a short read outside
275 * of (error && eof), assert buffer is full and enlarge buffer.
280 if (n >= READ_FULL_BYTES_MAX)
283 n = MIN(n * 2, READ_FULL_BYTES_MAX);
288 buf = NULL; /* do not free */
296 int read_full_file(const char *fn, char **contents, size_t *size) {
297 _cleanup_fclose_ FILE *f = NULL;
306 return read_full_stream(f, contents, size);
309 static int parse_env_file_internal(
313 int (*push) (const char *filename, unsigned line,
314 const char *key, char *value, void *userdata, int *n_pushed),
318 _cleanup_free_ char *contents = NULL, *key = NULL;
319 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;
320 char *p, *value = NULL;
331 SINGLE_QUOTE_VALUE_ESCAPE,
333 DOUBLE_QUOTE_VALUE_ESCAPE,
341 r = read_full_stream(f, &contents, NULL);
343 r = read_full_file(fname, &contents, NULL);
347 for (p = contents; *p; p++) {
353 if (strchr(COMMENTS, c))
355 else if (!strchr(WHITESPACE, c)) {
357 last_key_whitespace = (size_t) -1;
359 if (!GREEDY_REALLOC(key, key_alloc, n_key+2)) {
369 if (strchr(newline, c)) {
373 } else if (c == '=') {
375 last_value_whitespace = (size_t) -1;
377 if (!strchr(WHITESPACE, c))
378 last_key_whitespace = (size_t) -1;
379 else if (last_key_whitespace == (size_t) -1)
380 last_key_whitespace = n_key;
382 if (!GREEDY_REALLOC(key, key_alloc, n_key+2)) {
393 if (strchr(newline, c)) {
401 /* strip trailing whitespace from key */
402 if (last_key_whitespace != (size_t) -1)
403 key[last_key_whitespace] = 0;
405 r = push(fname, line, key, value, userdata, n_pushed);
411 value_alloc = n_value = 0;
413 } else if (c == '\'')
414 state = SINGLE_QUOTE_VALUE;
416 state = DOUBLE_QUOTE_VALUE;
418 state = VALUE_ESCAPE;
419 else if (!strchr(WHITESPACE, c)) {
422 if (!GREEDY_REALLOC(value, value_alloc, n_value+2)) {
427 value[n_value++] = c;
433 if (strchr(newline, c)) {
442 /* Chomp off trailing whitespace from value */
443 if (last_value_whitespace != (size_t) -1)
444 value[last_value_whitespace] = 0;
446 /* strip trailing whitespace from key */
447 if (last_key_whitespace != (size_t) -1)
448 key[last_key_whitespace] = 0;
450 r = push(fname, line, key, value, userdata, n_pushed);
456 value_alloc = n_value = 0;
458 } else if (c == '\\') {
459 state = VALUE_ESCAPE;
460 last_value_whitespace = (size_t) -1;
462 if (!strchr(WHITESPACE, c))
463 last_value_whitespace = (size_t) -1;
464 else if (last_value_whitespace == (size_t) -1)
465 last_value_whitespace = n_value;
467 if (!GREEDY_REALLOC(value, value_alloc, n_value+2)) {
472 value[n_value++] = c;
480 if (!strchr(newline, c)) {
481 /* Escaped newlines we eat up entirely */
482 if (!GREEDY_REALLOC(value, value_alloc, n_value+2)) {
487 value[n_value++] = c;
491 case SINGLE_QUOTE_VALUE:
495 state = SINGLE_QUOTE_VALUE_ESCAPE;
497 if (!GREEDY_REALLOC(value, value_alloc, n_value+2)) {
502 value[n_value++] = c;
507 case SINGLE_QUOTE_VALUE_ESCAPE:
508 state = SINGLE_QUOTE_VALUE;
510 if (!strchr(newline, c)) {
511 if (!GREEDY_REALLOC(value, value_alloc, n_value+2)) {
516 value[n_value++] = c;
520 case DOUBLE_QUOTE_VALUE:
524 state = DOUBLE_QUOTE_VALUE_ESCAPE;
526 if (!GREEDY_REALLOC(value, value_alloc, n_value+2)) {
531 value[n_value++] = c;
536 case DOUBLE_QUOTE_VALUE_ESCAPE:
537 state = DOUBLE_QUOTE_VALUE;
539 if (!strchr(newline, c)) {
540 if (!GREEDY_REALLOC(value, value_alloc, n_value+2)) {
545 value[n_value++] = c;
551 state = COMMENT_ESCAPE;
552 else if (strchr(newline, c)) {
569 SINGLE_QUOTE_VALUE_ESCAPE,
571 DOUBLE_QUOTE_VALUE_ESCAPE)) {
579 if (last_value_whitespace != (size_t) -1)
580 value[last_value_whitespace] = 0;
582 /* strip trailing whitespace from key */
583 if (last_key_whitespace != (size_t) -1)
584 key[last_key_whitespace] = 0;
586 r = push(fname, line, key, value, userdata, n_pushed);
598 static int check_utf8ness_and_warn(
599 const char *filename, unsigned line,
600 const char *key, char *value) {
602 if (!utf8_is_valid(key)) {
603 _cleanup_free_ char *p = NULL;
605 p = utf8_escape_invalid(key);
606 log_error("%s:%u: invalid UTF-8 in key '%s', ignoring.", strna(filename), line, p);
610 if (value && !utf8_is_valid(value)) {
611 _cleanup_free_ char *p = NULL;
613 p = utf8_escape_invalid(value);
614 log_error("%s:%u: invalid UTF-8 value for key %s: '%s', ignoring.", strna(filename), line, key, p);
621 static int parse_env_file_push(
622 const char *filename, unsigned line,
623 const char *key, char *value,
628 va_list aq, *ap = userdata;
631 r = check_utf8ness_and_warn(filename, line, key, value);
637 while ((k = va_arg(aq, const char *))) {
640 v = va_arg(aq, char **);
662 const char *newline, ...) {
670 va_start(ap, newline);
671 r = parse_env_file_internal(NULL, fname, newline, parse_env_file_push, &ap, &n_pushed);
674 return r < 0 ? r : n_pushed;
677 #if 0 /// UNNEEDED by elogind
678 static int load_env_file_push(
679 const char *filename, unsigned line,
680 const char *key, char *value,
683 char ***m = userdata;
687 r = check_utf8ness_and_warn(filename, line, key, value);
691 p = strjoin(key, "=", value);
695 r = strv_env_replace(m, p);
708 int load_env_file(FILE *f, const char *fname, const char *newline, char ***rl) {
715 r = parse_env_file_internal(f, fname, newline, load_env_file_push, &m, NULL);
726 static int load_env_file_push_pairs(
727 const char *filename, unsigned line,
728 const char *key, char *value,
731 char ***m = userdata;
734 r = check_utf8ness_and_warn(filename, line, key, value);
738 r = strv_extend(m, key);
743 r = strv_extend(m, "");
747 r = strv_push(m, value);
758 int load_env_file_pairs(FILE *f, const char *fname, const char *newline, char ***rl) {
765 r = parse_env_file_internal(f, fname, newline, load_env_file_push_pairs, &m, NULL);
774 #if 0 /// UNNEEDED by elogind
776 static int merge_env_file_push(
777 const char *filename, unsigned line,
778 const char *key, char *value,
782 char ***env = userdata;
783 char *expanded_value;
788 log_error("%s:%u: invalid syntax (around \"%s\"), ignoring.", strna(filename), line, key);
792 if (!env_name_is_valid(key)) {
793 log_error("%s:%u: invalid variable name \"%s\", ignoring.", strna(filename), line, key);
798 expanded_value = replace_env(value, *env,
799 REPLACE_ENV_USE_ENVIRONMENT|
800 REPLACE_ENV_ALLOW_BRACELESS|
801 REPLACE_ENV_ALLOW_EXTENDED);
805 free_and_replace(value, expanded_value);
807 return load_env_file_push(filename, line, key, value, env, n_pushed);
815 /* NOTE: this function supports braceful and braceless variable expansions,
816 * plus "extended" substitutions, unlike other exported parsing functions.
819 return parse_env_file_internal(f, fname, NEWLINE, merge_env_file_push, env, NULL);
822 static void write_env_var(FILE *f, const char *v) {
834 fwrite(v, 1, p-v, f);
836 if (string_has_cc(p, NULL) || chars_intersect(p, WHITESPACE SHELL_NEED_QUOTES)) {
840 if (strchr(SHELL_NEED_ESCAPE, *p))
853 int write_env_file(const char *fname, char **l) {
854 _cleanup_fclose_ FILE *f = NULL;
855 _cleanup_free_ char *p = NULL;
861 r = fopen_temporary(fname, &f, &p);
865 fchmod_umask(fileno(f), 0644);
868 write_env_var(f, *i);
870 r = fflush_and_check(f);
872 if (rename(p, fname) >= 0)
882 int executable_is_script(const char *path, char **interpreter) {
884 _cleanup_free_ char *line = NULL;
890 r = read_one_line_file(path, &line);
894 if (!startswith(line, "#!"))
897 ans = strstrip(line + 2);
898 len = strcspn(ans, " \t");
903 ans = strndup(ans, len);
913 * Retrieve one field from a file like /proc/self/status. pattern
914 * should not include whitespace or the delimiter (':'). pattern matches only
915 * the beginning of a line. Whitespace before ':' is skipped. Whitespace and
916 * zeros after the ':' will be skipped. field must be freed afterwards.
917 * terminator specifies the terminating characters of the field value (not
918 * included in the value).
920 int get_proc_field(const char *filename, const char *pattern, const char *terminator, char **field) {
921 _cleanup_free_ char *status = NULL;
931 r = read_full_file(filename, &status, NULL);
941 t = strstr(t, pattern);
945 /* Check that pattern occurs in beginning of line. */
946 pattern_ok = (t == status || t[-1] == '\n');
948 t += strlen(pattern);
950 } while (!pattern_ok);
952 t += strspn(t, " \t");
961 t += strspn(t, " \t");
963 /* Also skip zeros, because when this is used for
964 * capabilities, we don't want the zeros. This way the
965 * same capability set always maps to the same string,
966 * irrespective of the total capability set size. For
967 * other numbers it shouldn't matter. */
969 /* Back off one char if there's nothing but whitespace
971 if (!*t || isspace(*t))
975 len = strcspn(t, terminator);
985 DIR *xopendirat(int fd, const char *name, int flags) {
989 assert(!(flags & O_CREAT));
991 nfd = openat(fd, name, O_RDONLY|O_NONBLOCK|O_DIRECTORY|O_CLOEXEC|flags, 0);
1004 #if 0 /// UNNEEDED by elogind
1005 static int search_and_fopen_internal(const char *path, const char *mode, const char *root, char **search, FILE **_f) {
1012 if (!path_strv_resolve_uniq(search, root))
1015 STRV_FOREACH(i, search) {
1016 _cleanup_free_ char *p = NULL;
1020 p = strjoin(root, *i, "/", path);
1022 p = strjoin(*i, "/", path);
1032 if (errno != ENOENT)
1039 int search_and_fopen(const char *path, const char *mode, const char *root, const char **search, FILE **_f) {
1040 _cleanup_strv_free_ char **copy = NULL;
1046 if (path_is_absolute(path)) {
1049 f = fopen(path, mode);
1058 copy = strv_copy((char**) search);
1062 return search_and_fopen_internal(path, mode, root, copy, _f);
1065 int search_and_fopen_nulstr(const char *path, const char *mode, const char *root, const char *search, FILE **_f) {
1066 _cleanup_strv_free_ char **s = NULL;
1068 if (path_is_absolute(path)) {
1071 f = fopen(path, mode);
1080 s = strv_split_nulstr(search);
1084 return search_and_fopen_internal(path, mode, root, s, _f);
1088 int fopen_temporary(const char *path, FILE **_f, char **_temp_path) {
1097 r = tempfn_xxxxxx(path, NULL, &t);
1101 fd = mkostemp_safe(t);
1107 f = fdopen(fd, "we");
1121 int fflush_and_check(FILE *f) {
1128 return errno > 0 ? -errno : -EIO;
1133 /* This is much like mkostemp() but is subject to umask(). */
1134 int mkostemp_safe(char *pattern) {
1135 _cleanup_umask_ mode_t u = 0;
1142 fd = mkostemp(pattern, O_CLOEXEC);
1149 int tempfn_xxxxxx(const char *p, const char *extra, char **ret) {
1161 * /foo/bar/.#<extra>waldoXXXXXX
1165 if (!filename_is_valid(fn))
1171 t = new(char, strlen(p) + 2 + strlen(extra) + 6 + 1);
1175 strcpy(stpcpy(stpcpy(stpcpy(mempcpy(t, p, fn - p), ".#"), extra), fn), "XXXXXX");
1177 *ret = path_kill_slashes(t);
1181 int tempfn_random(const char *p, const char *extra, char **ret) {
1195 * /foo/bar/.#<extra>waldobaa2a261115984a9
1199 if (!filename_is_valid(fn))
1205 t = new(char, strlen(p) + 2 + strlen(extra) + 16 + 1);
1209 x = stpcpy(stpcpy(stpcpy(mempcpy(t, p, fn - p), ".#"), extra), fn);
1212 for (i = 0; i < 16; i++) {
1213 *(x++) = hexchar(u & 0xF);
1219 *ret = path_kill_slashes(t);
1223 #if 0 /// UNNEEDED by elogind
1224 int tempfn_random_child(const char *p, const char *extra, char **ret) {
1235 * /foo/bar/waldo/.#<extra>3c2b6219aa75d7d0
1247 t = new(char, strlen(p) + 3 + strlen(extra) + 16 + 1);
1251 x = stpcpy(stpcpy(stpcpy(t, p), "/.#"), extra);
1254 for (i = 0; i < 16; i++) {
1255 *(x++) = hexchar(u & 0xF);
1261 *ret = path_kill_slashes(t);
1265 int write_timestamp_file_atomic(const char *fn, usec_t n) {
1266 char ln[DECIMAL_STR_MAX(n)+2];
1268 /* Creates a "timestamp" file, that contains nothing but a
1269 * usec_t timestamp, formatted in ASCII. */
1271 if (n <= 0 || n >= USEC_INFINITY)
1274 xsprintf(ln, USEC_FMT "\n", n);
1276 return write_string_file(fn, ln, WRITE_STRING_FILE_CREATE|WRITE_STRING_FILE_ATOMIC);
1279 int read_timestamp_file(const char *fn, usec_t *ret) {
1280 _cleanup_free_ char *ln = NULL;
1284 r = read_one_line_file(fn, &ln);
1288 r = safe_atou64(ln, &t);
1292 if (t <= 0 || t >= (uint64_t) USEC_INFINITY)
1299 int fputs_with_space(FILE *f, const char *s, const char *separator, bool *space) {
1304 /* Outputs the specified string with fputs(), but optionally prefixes it with a separator. The *space parameter
1305 * when specified shall initially point to a boolean variable initialized to false. It is set to true after the
1306 * first invocation. This call is supposed to be use in loops, where a separator shall be inserted between each
1307 * element, but not before the first one. */
1317 r = fputs(separator, f);
1329 int open_tmpfile_unlinkable(const char *directory, int flags) {
1334 r = tmp_dir(&directory);
1339 /* Returns an unlinked temporary file that cannot be linked into the file system anymore */
1341 /* Try O_TMPFILE first, if it is supported */
1342 fd = open(directory, flags|O_TMPFILE|O_EXCL, S_IRUSR|S_IWUSR);
1346 /* Fall back to unguessable name + unlinking */
1347 p = strjoina(directory, "/systemd-tmp-XXXXXX");
1349 fd = mkostemp_safe(p);
1358 #if 0 /// UNNEEDED by elogind
1359 int open_tmpfile_linkable(const char *target, int flags, char **ret_path) {
1360 _cleanup_free_ char *tmp = NULL;
1366 /* Don't allow O_EXCL, as that has a special meaning for O_TMPFILE */
1367 assert((flags & O_EXCL) == 0);
1369 /* Creates a temporary file, that shall be renamed to "target" later. If possible, this uses O_TMPFILE – in
1370 * which case "ret_path" will be returned as NULL. If not possible a the tempoary path name used is returned in
1371 * "ret_path". Use link_tmpfile() below to rename the result after writing the file in full. */
1374 _cleanup_free_ char *dn = NULL;
1376 dn = dirname_malloc(target);
1380 fd = open(dn, O_TMPFILE|flags, 0640);
1386 log_debug_errno(errno, "Failed to use O_TMPFILE on %s: %m", dn);
1389 r = tempfn_random(target, NULL, &tmp);
1393 fd = open(tmp, O_CREAT|O_EXCL|O_NOFOLLOW|O_NOCTTY|flags, 0640);
1404 int open_serialization_fd(const char *ident) {
1407 fd = memfd_create(ident, MFD_CLOEXEC);
1411 path = getpid() == 1 ? "/run/systemd" : "/tmp";
1412 fd = open_tmpfile_unlinkable(path, O_RDWR|O_CLOEXEC);
1416 log_debug("Serializing %s to %s.", ident, path);
1418 log_debug("Serializing %s to memfd.", ident);
1423 #if 0 /// UNNEEDED by elogind
1424 int link_tmpfile(int fd, const char *path, const char *target) {
1429 /* Moves a temporary file created with open_tmpfile() above into its final place. if "path" is NULL an fd
1430 * created with O_TMPFILE is assumed, and linkat() is used. Otherwise it is assumed O_TMPFILE is not supported
1431 * on the directory, and renameat2() is used instead.
1433 * Note that in both cases we will not replace existing files. This is because linkat() does not support this
1434 * operation currently (renameat2() does), and there is no nice way to emulate this. */
1437 if (rename_noreplace(AT_FDCWD, path, AT_FDCWD, target) < 0)
1440 char proc_fd_path[strlen("/proc/self/fd/") + DECIMAL_STR_MAX(fd) + 1];
1442 xsprintf(proc_fd_path, "/proc/self/fd/%i", fd);
1444 if (linkat(AT_FDCWD, proc_fd_path, AT_FDCWD, target, AT_SYMLINK_FOLLOW) < 0)
1451 int read_nul_string(FILE *f, char **ret) {
1452 _cleanup_free_ char *x = NULL;
1453 size_t allocated = 0, n = 0;
1458 /* Reads a NUL-terminated string from the specified file. */
1463 if (!GREEDY_REALLOC(x, allocated, n+2))
1467 if (c == 0) /* Terminate at NUL byte */
1472 break; /* Terminate at EOF */
1492 int mkdtemp_malloc(const char *template, char **ret) {
1498 p = strdup(template);