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(FILE *f, const char *line, bool enforce_newline) {
59 if (enforce_newline && !endswith(line, "\n"))
62 return fflush_and_check(f);
65 static int write_string_file_atomic(const char *fn, const char *line, bool enforce_newline) {
66 _cleanup_fclose_ FILE *f = NULL;
67 _cleanup_free_ char *p = NULL;
73 r = fopen_temporary(fn, &f, &p);
77 (void) fchmod_umask(fileno(f), 0644);
79 r = write_string_stream(f, line, enforce_newline);
81 if (rename(p, fn) < 0)
91 int write_string_file(const char *fn, const char *line, WriteStringFileFlags flags) {
92 _cleanup_fclose_ FILE *f = NULL;
98 if (flags & WRITE_STRING_FILE_ATOMIC) {
99 assert(flags & WRITE_STRING_FILE_CREATE);
101 r = write_string_file_atomic(fn, line, !(flags & WRITE_STRING_FILE_AVOID_NEWLINE));
108 if (flags & WRITE_STRING_FILE_CREATE) {
117 /* We manually build our own version of fopen(..., "we") that
118 * works without O_CREAT */
119 fd = open(fn, O_WRONLY|O_CLOEXEC|O_NOCTTY);
125 f = fdopen(fd, "we");
133 r = write_string_stream(f, line, !(flags & WRITE_STRING_FILE_AVOID_NEWLINE));
140 if (!(flags & WRITE_STRING_FILE_VERIFY_ON_FAILURE))
145 /* OK, the operation failed, but let's see if the right
146 * contents in place already. If so, eat up the error. */
148 q = verify_file(fn, line, !(flags & WRITE_STRING_FILE_AVOID_NEWLINE));
155 int read_one_line_file(const char *fn, char **line) {
156 _cleanup_fclose_ FILE *f = NULL;
157 char t[LINE_MAX], *c;
166 if (!fgets(t, sizeof(t), f)) {
169 return errno > 0 ? -errno : -EIO;
183 int verify_file(const char *fn, const char *blob, bool accept_extra_nl) {
184 _cleanup_fclose_ FILE *f = NULL;
185 _cleanup_free_ char *buf = NULL;
193 if (accept_extra_nl && endswith(blob, "\n"))
194 accept_extra_nl = false;
196 buf = malloc(l + accept_extra_nl + 1);
204 /* We try to read one byte more than we need, so that we know whether we hit eof */
206 k = fread(buf, 1, l + accept_extra_nl + 1, f);
208 return errno > 0 ? -errno : -EIO;
210 if (k != l && k != l + accept_extra_nl)
212 if (memcmp(buf, blob, l) != 0)
214 if (k > l && buf[l] != '\n')
220 int read_full_stream(FILE *f, char **contents, size_t *size) {
222 _cleanup_free_ char *buf = NULL;
228 if (fstat(fileno(f), &st) < 0)
233 if (S_ISREG(st.st_mode)) {
236 if (st.st_size > READ_FULL_BYTES_MAX)
239 /* Start with the right file size, but be prepared for
240 * files from /proc which generally report a file size
251 t = realloc(buf, n + 1);
256 k = fread(buf + l, 1, n - l, f);
266 /* We aren't expecting fread() to return a short read outside
267 * of (error && eof), assert buffer is full and enlarge buffer.
272 if (n >= READ_FULL_BYTES_MAX)
275 n = MIN(n * 2, READ_FULL_BYTES_MAX);
280 buf = NULL; /* do not free */
288 int read_full_file(const char *fn, char **contents, size_t *size) {
289 _cleanup_fclose_ FILE *f = NULL;
298 return read_full_stream(f, contents, size);
301 static int parse_env_file_internal(
305 int (*push) (const char *filename, unsigned line,
306 const char *key, char *value, void *userdata, int *n_pushed),
310 _cleanup_free_ char *contents = NULL, *key = NULL;
311 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;
312 char *p, *value = NULL;
323 SINGLE_QUOTE_VALUE_ESCAPE,
325 DOUBLE_QUOTE_VALUE_ESCAPE,
333 r = read_full_stream(f, &contents, NULL);
335 r = read_full_file(fname, &contents, NULL);
339 for (p = contents; *p; p++) {
345 if (strchr(COMMENTS, c))
347 else if (!strchr(WHITESPACE, c)) {
349 last_key_whitespace = (size_t) -1;
351 if (!GREEDY_REALLOC(key, key_alloc, n_key+2)) {
361 if (strchr(newline, c)) {
365 } else if (c == '=') {
367 last_value_whitespace = (size_t) -1;
369 if (!strchr(WHITESPACE, c))
370 last_key_whitespace = (size_t) -1;
371 else if (last_key_whitespace == (size_t) -1)
372 last_key_whitespace = n_key;
374 if (!GREEDY_REALLOC(key, key_alloc, n_key+2)) {
385 if (strchr(newline, c)) {
393 /* strip trailing whitespace from key */
394 if (last_key_whitespace != (size_t) -1)
395 key[last_key_whitespace] = 0;
397 r = push(fname, line, key, value, userdata, n_pushed);
403 value_alloc = n_value = 0;
405 } else if (c == '\'')
406 state = SINGLE_QUOTE_VALUE;
408 state = DOUBLE_QUOTE_VALUE;
410 state = VALUE_ESCAPE;
411 else if (!strchr(WHITESPACE, c)) {
414 if (!GREEDY_REALLOC(value, value_alloc, n_value+2)) {
419 value[n_value++] = c;
425 if (strchr(newline, c)) {
434 /* Chomp off trailing whitespace from value */
435 if (last_value_whitespace != (size_t) -1)
436 value[last_value_whitespace] = 0;
438 /* strip trailing whitespace from key */
439 if (last_key_whitespace != (size_t) -1)
440 key[last_key_whitespace] = 0;
442 r = push(fname, line, key, value, userdata, n_pushed);
448 value_alloc = n_value = 0;
450 } else if (c == '\\') {
451 state = VALUE_ESCAPE;
452 last_value_whitespace = (size_t) -1;
454 if (!strchr(WHITESPACE, c))
455 last_value_whitespace = (size_t) -1;
456 else if (last_value_whitespace == (size_t) -1)
457 last_value_whitespace = n_value;
459 if (!GREEDY_REALLOC(value, value_alloc, n_value+2)) {
464 value[n_value++] = c;
472 if (!strchr(newline, c)) {
473 /* Escaped newlines we eat up entirely */
474 if (!GREEDY_REALLOC(value, value_alloc, n_value+2)) {
479 value[n_value++] = c;
483 case SINGLE_QUOTE_VALUE:
487 state = SINGLE_QUOTE_VALUE_ESCAPE;
489 if (!GREEDY_REALLOC(value, value_alloc, n_value+2)) {
494 value[n_value++] = c;
499 case SINGLE_QUOTE_VALUE_ESCAPE:
500 state = SINGLE_QUOTE_VALUE;
502 if (!strchr(newline, c)) {
503 if (!GREEDY_REALLOC(value, value_alloc, n_value+2)) {
508 value[n_value++] = c;
512 case DOUBLE_QUOTE_VALUE:
516 state = DOUBLE_QUOTE_VALUE_ESCAPE;
518 if (!GREEDY_REALLOC(value, value_alloc, n_value+2)) {
523 value[n_value++] = c;
528 case DOUBLE_QUOTE_VALUE_ESCAPE:
529 state = DOUBLE_QUOTE_VALUE;
531 if (!strchr(newline, c)) {
532 if (!GREEDY_REALLOC(value, value_alloc, n_value+2)) {
537 value[n_value++] = c;
543 state = COMMENT_ESCAPE;
544 else if (strchr(newline, c)) {
561 SINGLE_QUOTE_VALUE_ESCAPE,
563 DOUBLE_QUOTE_VALUE_ESCAPE)) {
571 if (last_value_whitespace != (size_t) -1)
572 value[last_value_whitespace] = 0;
574 /* strip trailing whitespace from key */
575 if (last_key_whitespace != (size_t) -1)
576 key[last_key_whitespace] = 0;
578 r = push(fname, line, key, value, userdata, n_pushed);
590 static int check_utf8ness_and_warn(
591 const char *filename, unsigned line,
592 const char *key, char *value) {
594 if (!utf8_is_valid(key)) {
595 _cleanup_free_ char *p = NULL;
597 p = utf8_escape_invalid(key);
598 log_error("%s:%u: invalid UTF-8 in key '%s', ignoring.", strna(filename), line, p);
602 if (value && !utf8_is_valid(value)) {
603 _cleanup_free_ char *p = NULL;
605 p = utf8_escape_invalid(value);
606 log_error("%s:%u: invalid UTF-8 value for key %s: '%s', ignoring.", strna(filename), line, key, p);
613 static int parse_env_file_push(
614 const char *filename, unsigned line,
615 const char *key, char *value,
620 va_list aq, *ap = userdata;
623 r = check_utf8ness_and_warn(filename, line, key, value);
629 while ((k = va_arg(aq, const char *))) {
632 v = va_arg(aq, char **);
654 const char *newline, ...) {
662 va_start(ap, newline);
663 r = parse_env_file_internal(NULL, fname, newline, parse_env_file_push, &ap, &n_pushed);
666 return r < 0 ? r : n_pushed;
669 #if 0 /// UNNEEDED by elogind
670 static int load_env_file_push(
671 const char *filename, unsigned line,
672 const char *key, char *value,
675 char ***m = userdata;
679 r = check_utf8ness_and_warn(filename, line, key, value);
683 p = strjoin(key, "=", value);
687 r = strv_env_replace(m, p);
700 int load_env_file(FILE *f, const char *fname, const char *newline, char ***rl) {
707 r = parse_env_file_internal(f, fname, newline, load_env_file_push, &m, NULL);
717 static int load_env_file_push_pairs(
718 const char *filename, unsigned line,
719 const char *key, char *value,
722 char ***m = userdata;
725 r = check_utf8ness_and_warn(filename, line, key, value);
729 r = strv_extend(m, key);
734 r = strv_extend(m, "");
738 r = strv_push(m, value);
749 int load_env_file_pairs(FILE *f, const char *fname, const char *newline, char ***rl) {
756 r = parse_env_file_internal(f, fname, newline, load_env_file_push_pairs, &m, NULL);
766 static int merge_env_file_push(
767 const char *filename, unsigned line,
768 const char *key, char *value,
772 char ***env = userdata;
773 char *expanded_value;
778 log_error("%s:%u: invalid syntax (around \"%s\"), ignoring.", strna(filename), line, key);
782 if (!env_name_is_valid(key)) {
783 log_error("%s:%u: invalid variable name \"%s\", ignoring.", strna(filename), line, key);
788 expanded_value = replace_env(value, *env,
789 REPLACE_ENV_USE_ENVIRONMENT|REPLACE_ENV_ALLOW_BRACELESS);
793 free_and_replace(value, expanded_value);
795 return load_env_file_push(filename, line, key, value, env, n_pushed);
803 /* NOTE: this function supports braceful and braceless variable expansions,
804 * unlike other exported parsing functions.
807 return parse_env_file_internal(f, fname, NEWLINE, merge_env_file_push, env, NULL);
810 static void write_env_var(FILE *f, const char *v) {
822 fwrite(v, 1, p-v, f);
824 if (string_has_cc(p, NULL) || chars_intersect(p, WHITESPACE SHELL_NEED_QUOTES)) {
828 if (strchr(SHELL_NEED_ESCAPE, *p))
841 int write_env_file(const char *fname, char **l) {
842 _cleanup_fclose_ FILE *f = NULL;
843 _cleanup_free_ char *p = NULL;
849 r = fopen_temporary(fname, &f, &p);
853 fchmod_umask(fileno(f), 0644);
856 write_env_var(f, *i);
858 r = fflush_and_check(f);
860 if (rename(p, fname) >= 0)
870 int executable_is_script(const char *path, char **interpreter) {
872 _cleanup_free_ char *line = NULL;
878 r = read_one_line_file(path, &line);
882 if (!startswith(line, "#!"))
885 ans = strstrip(line + 2);
886 len = strcspn(ans, " \t");
891 ans = strndup(ans, len);
901 * Retrieve one field from a file like /proc/self/status. pattern
902 * should not include whitespace or the delimiter (':'). pattern matches only
903 * the beginning of a line. Whitespace before ':' is skipped. Whitespace and
904 * zeros after the ':' will be skipped. field must be freed afterwards.
905 * terminator specifies the terminating characters of the field value (not
906 * included in the value).
908 int get_proc_field(const char *filename, const char *pattern, const char *terminator, char **field) {
909 _cleanup_free_ char *status = NULL;
919 r = read_full_file(filename, &status, NULL);
929 t = strstr(t, pattern);
933 /* Check that pattern occurs in beginning of line. */
934 pattern_ok = (t == status || t[-1] == '\n');
936 t += strlen(pattern);
938 } while (!pattern_ok);
940 t += strspn(t, " \t");
949 t += strspn(t, " \t");
951 /* Also skip zeros, because when this is used for
952 * capabilities, we don't want the zeros. This way the
953 * same capability set always maps to the same string,
954 * irrespective of the total capability set size. For
955 * other numbers it shouldn't matter. */
957 /* Back off one char if there's nothing but whitespace
959 if (!*t || isspace(*t))
963 len = strcspn(t, terminator);
973 DIR *xopendirat(int fd, const char *name, int flags) {
977 assert(!(flags & O_CREAT));
979 nfd = openat(fd, name, O_RDONLY|O_NONBLOCK|O_DIRECTORY|O_CLOEXEC|flags, 0);
992 #if 0 /// UNNEEDED by elogind
993 static int search_and_fopen_internal(const char *path, const char *mode, const char *root, char **search, FILE **_f) {
1000 if (!path_strv_resolve_uniq(search, root))
1003 STRV_FOREACH(i, search) {
1004 _cleanup_free_ char *p = NULL;
1008 p = strjoin(root, *i, "/", path);
1010 p = strjoin(*i, "/", path);
1020 if (errno != ENOENT)
1027 int search_and_fopen(const char *path, const char *mode, const char *root, const char **search, FILE **_f) {
1028 _cleanup_strv_free_ char **copy = NULL;
1034 if (path_is_absolute(path)) {
1037 f = fopen(path, mode);
1046 copy = strv_copy((char**) search);
1050 return search_and_fopen_internal(path, mode, root, copy, _f);
1053 int search_and_fopen_nulstr(const char *path, const char *mode, const char *root, const char *search, FILE **_f) {
1054 _cleanup_strv_free_ char **s = NULL;
1056 if (path_is_absolute(path)) {
1059 f = fopen(path, mode);
1068 s = strv_split_nulstr(search);
1072 return search_and_fopen_internal(path, mode, root, s, _f);
1076 int fopen_temporary(const char *path, FILE **_f, char **_temp_path) {
1085 r = tempfn_xxxxxx(path, NULL, &t);
1089 fd = mkostemp_safe(t);
1095 f = fdopen(fd, "we");
1109 int fflush_and_check(FILE *f) {
1116 return errno > 0 ? -errno : -EIO;
1121 /* This is much like mkostemp() but is subject to umask(). */
1122 int mkostemp_safe(char *pattern) {
1123 _cleanup_umask_ mode_t u = 0;
1130 fd = mkostemp(pattern, O_CLOEXEC);
1137 int tempfn_xxxxxx(const char *p, const char *extra, char **ret) {
1149 * /foo/bar/.#<extra>waldoXXXXXX
1153 if (!filename_is_valid(fn))
1159 t = new(char, strlen(p) + 2 + strlen(extra) + 6 + 1);
1163 strcpy(stpcpy(stpcpy(stpcpy(mempcpy(t, p, fn - p), ".#"), extra), fn), "XXXXXX");
1165 *ret = path_kill_slashes(t);
1169 int tempfn_random(const char *p, const char *extra, char **ret) {
1183 * /foo/bar/.#<extra>waldobaa2a261115984a9
1187 if (!filename_is_valid(fn))
1193 t = new(char, strlen(p) + 2 + strlen(extra) + 16 + 1);
1197 x = stpcpy(stpcpy(stpcpy(mempcpy(t, p, fn - p), ".#"), extra), fn);
1200 for (i = 0; i < 16; i++) {
1201 *(x++) = hexchar(u & 0xF);
1207 *ret = path_kill_slashes(t);
1211 #if 0 /// UNNEEDED by elogind
1212 int tempfn_random_child(const char *p, const char *extra, char **ret) {
1223 * /foo/bar/waldo/.#<extra>3c2b6219aa75d7d0
1235 t = new(char, strlen(p) + 3 + strlen(extra) + 16 + 1);
1239 x = stpcpy(stpcpy(stpcpy(t, p), "/.#"), extra);
1242 for (i = 0; i < 16; i++) {
1243 *(x++) = hexchar(u & 0xF);
1249 *ret = path_kill_slashes(t);
1253 int write_timestamp_file_atomic(const char *fn, usec_t n) {
1254 char ln[DECIMAL_STR_MAX(n)+2];
1256 /* Creates a "timestamp" file, that contains nothing but a
1257 * usec_t timestamp, formatted in ASCII. */
1259 if (n <= 0 || n >= USEC_INFINITY)
1262 xsprintf(ln, USEC_FMT "\n", n);
1264 return write_string_file(fn, ln, WRITE_STRING_FILE_CREATE|WRITE_STRING_FILE_ATOMIC);
1267 int read_timestamp_file(const char *fn, usec_t *ret) {
1268 _cleanup_free_ char *ln = NULL;
1272 r = read_one_line_file(fn, &ln);
1276 r = safe_atou64(ln, &t);
1280 if (t <= 0 || t >= (uint64_t) USEC_INFINITY)
1287 int fputs_with_space(FILE *f, const char *s, const char *separator, bool *space) {
1292 /* Outputs the specified string with fputs(), but optionally prefixes it with a separator. The *space parameter
1293 * when specified shall initially point to a boolean variable initialized to false. It is set to true after the
1294 * first invocation. This call is supposed to be use in loops, where a separator shall be inserted between each
1295 * element, but not before the first one. */
1305 r = fputs(separator, f);
1316 int open_tmpfile_unlinkable(const char *directory, int flags) {
1321 r = tmp_dir(&directory);
1326 /* Returns an unlinked temporary file that cannot be linked into the file system anymore */
1328 /* Try O_TMPFILE first, if it is supported */
1329 fd = open(directory, flags|O_TMPFILE|O_EXCL, S_IRUSR|S_IWUSR);
1333 /* Fall back to unguessable name + unlinking */
1334 p = strjoina(directory, "/systemd-tmp-XXXXXX");
1336 fd = mkostemp_safe(p);
1345 int open_tmpfile_linkable(const char *target, int flags, char **ret_path) {
1346 _cleanup_free_ char *tmp = NULL;
1352 /* Don't allow O_EXCL, as that has a special meaning for O_TMPFILE */
1353 assert((flags & O_EXCL) == 0);
1355 /* Creates a temporary file, that shall be renamed to "target" later. If possible, this uses O_TMPFILE – in
1356 * which case "ret_path" will be returned as NULL. If not possible a the tempoary path name used is returned in
1357 * "ret_path". Use link_tmpfile() below to rename the result after writing the file in full. */
1360 _cleanup_free_ char *dn = NULL;
1362 dn = dirname_malloc(target);
1366 fd = open(dn, O_TMPFILE|flags, 0640);
1372 log_debug_errno(errno, "Failed to use O_TMPFILE on %s: %m", dn);
1375 r = tempfn_random(target, NULL, &tmp);
1379 fd = open(tmp, O_CREAT|O_EXCL|O_NOFOLLOW|O_NOCTTY|flags, 0640);
1389 int open_serialization_fd(const char *ident) {
1392 fd = memfd_create(ident, MFD_CLOEXEC);
1396 path = getpid() == 1 ? "/run/systemd" : "/tmp";
1397 fd = open_tmpfile_unlinkable(path, O_RDWR|O_CLOEXEC);
1401 log_debug("Serializing %s to %s.", ident, path);
1403 log_debug("Serializing %s to memfd.", ident);
1408 int link_tmpfile(int fd, const char *path, const char *target) {
1413 /* Moves a temporary file created with open_tmpfile() above into its final place. if "path" is NULL an fd
1414 * created with O_TMPFILE is assumed, and linkat() is used. Otherwise it is assumed O_TMPFILE is not supported
1415 * on the directory, and renameat2() is used instead.
1417 * Note that in both cases we will not replace existing files. This is because linkat() does not support this
1418 * operation currently (renameat2() does), and there is no nice way to emulate this. */
1421 if (rename_noreplace(AT_FDCWD, path, AT_FDCWD, target) < 0)
1424 char proc_fd_path[strlen("/proc/self/fd/") + DECIMAL_STR_MAX(fd) + 1];
1426 xsprintf(proc_fd_path, "/proc/self/fd/%i", fd);
1428 if (linkat(AT_FDCWD, proc_fd_path, AT_FDCWD, target, AT_SYMLINK_FOLLOW) < 0)
1436 int read_nul_string(FILE *f, char **ret) {
1437 _cleanup_free_ char *x = NULL;
1438 size_t allocated = 0, n = 0;
1443 /* Reads a NUL-terminated string from the specified file. */
1448 if (!GREEDY_REALLOC(x, allocated, n+2))
1452 if (c == 0) /* Terminate at NUL byte */
1457 break; /* Terminate at EOF */
1477 int mkdtemp_malloc(const char *template, char **ret) {
1483 p = strdup(template);