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/>.
26 #include <sys/types.h>
28 #include "alloc-util.h"
29 #include "conf-files.h"
30 #include "conf-parser.h"
31 #include "extract-word.h"
36 #include "parse-util.h"
37 #include "path-util.h"
38 #include "process-util.h"
39 #include "signal-util.h"
40 #include "string-util.h"
42 #include "syslog-util.h"
43 #include "time-util.h"
46 int config_item_table_lookup(
50 ConfigParserCallback *func,
55 const ConfigTableItem *t;
63 for (t = table; t->lvalue; t++) {
65 if (!streq(lvalue, t->lvalue))
68 if (!streq_ptr(section, t->section))
80 int config_item_perf_lookup(
84 ConfigParserCallback *func,
89 ConfigPerfItemLookup lookup = (ConfigPerfItemLookup) table;
90 const ConfigPerfItem *p;
99 p = lookup(lvalue, strlen(lvalue));
103 key = strjoin(section, ".", lvalue, NULL);
107 p = lookup(key, strlen(key));
116 *data = (uint8_t*) userdata + p->offset;
120 /* Run the user supplied parser for an assignment */
121 static int next_assignment(const char *unit,
122 const char *filename,
124 ConfigItemLookup lookup,
127 unsigned section_line,
133 ConfigParserCallback func = NULL;
144 r = lookup(table, section, lvalue, &func, <ype, &data, userdata);
150 return func(unit, filename, line, section, section_line,
151 lvalue, ltype, rvalue, data, userdata);
156 /* Warn about unknown non-extension fields. */
157 if (!relaxed && !startswith(lvalue, "X-"))
158 log_syntax(unit, LOG_WARNING, filename, line, 0, "Unknown lvalue '%s' in section '%s'", lvalue, section);
163 /* Parse a variable assignment line */
164 static int parse_line(const char* unit,
165 const char *filename,
167 const char *sections,
168 ConfigItemLookup lookup,
173 unsigned *section_line,
174 bool *section_ignored,
190 if (strchr(COMMENTS "\n", *l))
193 if (startswith(l, ".include ")) {
194 _cleanup_free_ char *fn = NULL;
196 /* .includes are a bad idea, we only support them here
197 * for historical reasons. They create cyclic include
198 * problems and make it difficult to detect
199 * configuration file changes with an easy
200 * stat(). Better approaches, such as .d/ drop-in
203 * Support for them should be eventually removed. */
205 if (!allow_include) {
206 log_syntax(unit, LOG_ERR, filename, line, 0, ".include not allowed here. Ignoring.");
210 fn = file_in_same_dir(filename, strstrip(l+9));
214 return config_parse(unit, fn, NULL, sections, lookup, table, relaxed, false, false, userdata);
225 log_syntax(unit, LOG_ERR, filename, line, 0, "Invalid section header '%s'", l);
229 n = strndup(l+1, k-2);
233 if (sections && !nulstr_contains(sections, n)) {
235 if (!relaxed && !startswith(n, "X-"))
236 log_syntax(unit, LOG_WARNING, filename, line, 0, "Unknown section '%s'. Ignoring.", n);
239 *section = mfree(*section);
241 *section_ignored = true;
245 *section_line = line;
246 *section_ignored = false;
252 if (sections && !*section) {
254 if (!relaxed && !*section_ignored)
255 log_syntax(unit, LOG_WARNING, filename, line, 0, "Assignment outside of section. Ignoring.");
262 log_syntax(unit, LOG_WARNING, filename, line, 0, "Missing '='.");
269 return next_assignment(unit,
282 /* Go through the file and parse each line */
283 int config_parse(const char *unit,
284 const char *filename,
286 const char *sections,
287 ConfigItemLookup lookup,
294 _cleanup_free_ char *section = NULL, *continuation = NULL;
295 _cleanup_fclose_ FILE *ours = NULL;
296 unsigned line = 0, section_line = 0;
297 bool section_ignored = false, allow_bom = true;
304 f = ours = fopen(filename, "re");
306 /* Only log on request, except for ENOENT,
307 * since we return 0 to the caller. */
308 if (warn || errno == ENOENT)
309 log_full(errno == ENOENT ? LOG_DEBUG : LOG_ERR,
310 "Failed to open configuration file '%s': %m", filename);
311 return errno == ENOENT ? 0 : -errno;
315 fd_warn_permissions(filename, fileno(f));
318 char buf[LINE_MAX], *l, *p, *c = NULL, *e;
319 bool escaped = false;
321 if (!fgets(buf, sizeof buf, f)) {
325 return log_error_errno(errno, "Failed to read configuration file '%s': %m", filename);
329 if (allow_bom && startswith(l, UTF8_BYTE_ORDER_MARK))
330 l += strlen(UTF8_BYTE_ORDER_MARK);
336 c = strappend(continuation, l);
343 continuation = mfree(continuation);
348 for (e = p; *e; e++) {
361 continuation = strdup(l);
389 log_warning_errno(r, "Failed to parse file '%s': %m",
398 static int config_parse_many_files(
399 const char *conf_file,
401 const char *sections,
402 ConfigItemLookup lookup,
411 r = config_parse(NULL, conf_file, NULL, sections, lookup, table, relaxed, false, true, userdata);
416 STRV_FOREACH(fn, files) {
417 r = config_parse(NULL, *fn, NULL, sections, lookup, table, relaxed, false, true, userdata);
425 /* Parse each config file in the directories specified as nulstr. */
426 int config_parse_many_nulstr(
427 const char *conf_file,
428 const char *conf_file_dirs,
429 const char *sections,
430 ConfigItemLookup lookup,
435 _cleanup_strv_free_ char **files = NULL;
438 r = conf_files_list_nulstr(&files, ".conf", NULL, conf_file_dirs);
442 return config_parse_many_files(conf_file, files,
443 sections, lookup, table, relaxed, userdata);
446 #if 0 /// UNNEEDED by elogind
447 /* Parse each config file in the directories specified as strv. */
448 int config_parse_many(
449 const char *conf_file,
450 const char* const* conf_file_dirs,
451 const char *dropin_dirname,
452 const char *sections,
453 ConfigItemLookup lookup,
458 _cleanup_strv_free_ char **dropin_dirs = NULL;
459 _cleanup_strv_free_ char **files = NULL;
463 suffix = strjoina("/", dropin_dirname);
464 r = strv_extend_strv_concat(&dropin_dirs, (char**) conf_file_dirs, suffix);
468 r = conf_files_list_strv(&files, ".conf", NULL, (const char* const*) dropin_dirs);
472 return config_parse_many_files(conf_file, files,
473 sections, lookup, table, relaxed, userdata);
477 #define DEFINE_PARSER(type, vartype, conv_func) \
478 int config_parse_##type( \
480 const char *filename, \
482 const char *section, \
483 unsigned section_line, \
484 const char *lvalue, \
486 const char *rvalue, \
498 r = conv_func(rvalue, i); \
500 log_syntax(unit, LOG_ERR, filename, line, r, \
501 "Failed to parse %s value, ignoring: %s", \
506 struct __useless_struct_to_allow_trailing_semicolon__
508 DEFINE_PARSER(int, int, safe_atoi);
509 DEFINE_PARSER(long, long, safe_atoli);
510 #if 0 /// UNNEEDED by elogind
511 DEFINE_PARSER(uint16, uint16_t, safe_atou16);
512 DEFINE_PARSER(uint32, uint32_t, safe_atou32);
514 DEFINE_PARSER(uint64, uint64_t, safe_atou64);
515 DEFINE_PARSER(unsigned, unsigned, safe_atou);
516 DEFINE_PARSER(double, double, safe_atod);
517 #if 0 /// UNNEEDED by elogind
518 DEFINE_PARSER(nsec, nsec_t, parse_nsec);
520 DEFINE_PARSER(sec, usec_t, parse_sec);
521 DEFINE_PARSER(mode, mode_t, parse_mode);
523 int config_parse_iec_size(const char* unit,
524 const char *filename,
527 unsigned section_line,
543 r = parse_size(rvalue, 1024, &v);
544 if (r < 0 || (uint64_t) (size_t) v != v) {
545 log_syntax(unit, LOG_ERR, filename, line, r, "Failed to parse size value, ignoring: %s", rvalue);
553 #if 0 /// UNNEEDED by elogind
554 int config_parse_si_size(const char* unit,
555 const char *filename,
558 unsigned section_line,
574 r = parse_size(rvalue, 1000, &v);
575 if (r < 0 || (uint64_t) (size_t) v != v) {
576 log_syntax(unit, LOG_ERR, filename, line, r, "Failed to parse size value, ignoring: %s", rvalue);
584 int config_parse_iec_uint64(const char* unit,
585 const char *filename,
588 unsigned section_line,
595 uint64_t *bytes = data;
603 r = parse_size(rvalue, 1024, bytes);
605 log_syntax(unit, LOG_ERR, filename, line, r, "Failed to parse size value, ignoring: %s", rvalue);
611 int config_parse_bool(const char* unit,
612 const char *filename,
615 unsigned section_line,
630 k = parse_boolean(rvalue);
632 log_syntax(unit, LOG_ERR, filename, line, k, "Failed to parse boolean value, ignoring: %s", rvalue);
640 #if 0 /// UNNEEDED by elogind
641 int config_parse_tristate(
643 const char *filename,
646 unsigned section_line,
660 /* A tristate is pretty much a boolean, except that it can
661 * also take the special value -1, indicating "uninitialized",
662 * much like NULL is for a pointer type. */
664 k = parse_boolean(rvalue);
666 log_syntax(unit, LOG_ERR, filename, line, k, "Failed to parse boolean value, ignoring: %s", rvalue);
675 int config_parse_string(
677 const char *filename,
680 unsigned section_line,
694 if (!utf8_is_valid(rvalue)) {
695 log_syntax_invalid_utf8(unit, LOG_ERR, filename, line, rvalue);
713 int config_parse_path(
715 const char *filename,
718 unsigned section_line,
732 if (!utf8_is_valid(rvalue)) {
733 log_syntax_invalid_utf8(unit, LOG_ERR, filename, line, rvalue);
737 if (!path_is_absolute(rvalue)) {
738 log_syntax(unit, LOG_ERR, filename, line, 0, "Not an absolute path, ignoring: %s", rvalue);
746 path_kill_slashes(n);
754 int config_parse_strv(const char *unit,
755 const char *filename,
758 unsigned section_line,
773 if (isempty(rvalue)) {
776 /* Empty assignment resets the list. As a special rule
777 * we actually fill in a real empty array here rather
778 * than NULL, since some code wants to know if
779 * something was set at all... */
780 empty = new0(char*, 1);
793 r = extract_first_word(&rvalue, &word, WHITESPACE, EXTRACT_QUOTES|EXTRACT_RETAIN_ESCAPE);
799 log_syntax(unit, LOG_ERR, filename, line, r, "Invalid syntax, ignoring: %s", rvalue);
803 if (!utf8_is_valid(word)) {
804 log_syntax_invalid_utf8(unit, LOG_ERR, filename, line, rvalue);
808 r = strv_consume(sv, word);
816 #if 0 /// UNNEEDED by elogind
817 int config_parse_log_facility(
819 const char *filename,
822 unsigned section_line,
837 x = log_facility_unshifted_from_string(rvalue);
839 log_syntax(unit, LOG_ERR, filename, line, 0, "Failed to parse log facility, ignoring: %s", rvalue);
843 *o = (x << 3) | LOG_PRI(*o);
849 int config_parse_log_level(
851 const char *filename,
854 unsigned section_line,
869 x = log_level_from_string(rvalue);
871 log_syntax(unit, LOG_ERR, filename, line, 0, "Failed to parse log level, ignoring: %s", rvalue);
875 *o = (*o & LOG_FACMASK) | x;
879 int config_parse_signal(
881 const char *filename,
884 unsigned section_line,
898 r = signal_from_string_try_harder(rvalue);
900 log_syntax(unit, LOG_ERR, filename, line, 0, "Failed to parse signal name, ignoring: %s", rvalue);
908 #if 0 /// UNNEEDED by elogind
909 int config_parse_personality(
911 const char *filename,
914 unsigned section_line,
921 unsigned long *personality = data, p;
928 p = personality_from_string(rvalue);
929 if (p == PERSONALITY_INVALID) {
930 log_syntax(unit, LOG_ERR, filename, line, 0, "Failed to parse personality, ignoring: %s", rvalue);
938 int config_parse_ifname(
940 const char *filename,
943 unsigned section_line,
958 if (isempty(rvalue)) {
963 if (!ifname_valid(rvalue)) {
964 log_syntax(unit, LOG_ERR, filename, line, 0, "Interface name is not valid or too long, ignoring assignment: %s", rvalue);
968 r = free_and_strdup(s, rvalue);