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 /* Parse each config file in the specified directories. */
399 int config_parse_many(const char *conf_file,
400 const char *conf_file_dirs,
401 const char *sections,
402 ConfigItemLookup lookup,
406 _cleanup_strv_free_ char **files = NULL;
410 r = conf_files_list_nulstr(&files, ".conf", NULL, conf_file_dirs);
415 r = config_parse(NULL, conf_file, NULL, sections, lookup, table, relaxed, false, true, userdata);
420 STRV_FOREACH(fn, files) {
421 r = config_parse(NULL, *fn, NULL, sections, lookup, table, relaxed, false, true, userdata);
429 #define DEFINE_PARSER(type, vartype, conv_func) \
430 int config_parse_##type( \
432 const char *filename, \
434 const char *section, \
435 unsigned section_line, \
436 const char *lvalue, \
438 const char *rvalue, \
450 r = conv_func(rvalue, i); \
452 log_syntax(unit, LOG_ERR, filename, line, r, \
453 "Failed to parse %s value, ignoring: %s", \
458 struct __useless_struct_to_allow_trailing_semicolon__
460 DEFINE_PARSER(int, int, safe_atoi);
461 DEFINE_PARSER(long, long, safe_atoli);
462 DEFINE_PARSER(uint32, uint32_t, safe_atou32);
463 DEFINE_PARSER(uint64, uint64_t, safe_atou64);
464 DEFINE_PARSER(unsigned, unsigned, safe_atou);
465 DEFINE_PARSER(double, double, safe_atod);
466 #if 0 /// UNNEEDED by elogind
467 DEFINE_PARSER(nsec, nsec_t, parse_nsec);
469 DEFINE_PARSER(sec, usec_t, parse_sec);
470 DEFINE_PARSER(mode, mode_t, parse_mode);
472 int config_parse_iec_size(const char* unit,
473 const char *filename,
476 unsigned section_line,
492 r = parse_size(rvalue, 1024, &v);
493 if (r < 0 || (uint64_t) (size_t) v != v) {
494 log_syntax(unit, LOG_ERR, filename, line, r, "Failed to parse size value, ignoring: %s", rvalue);
502 #if 0 /// UNNEEDED by elogind
503 int config_parse_si_size(const char* unit,
504 const char *filename,
507 unsigned section_line,
523 r = parse_size(rvalue, 1000, &v);
524 if (r < 0 || (uint64_t) (size_t) v != v) {
525 log_syntax(unit, LOG_ERR, filename, line, r, "Failed to parse size value, ignoring: %s", rvalue);
533 int config_parse_iec_uint64(const char* unit,
534 const char *filename,
537 unsigned section_line,
544 uint64_t *bytes = data;
552 r = parse_size(rvalue, 1024, bytes);
554 log_syntax(unit, LOG_ERR, filename, line, r, "Failed to parse size value, ignoring: %s", rvalue);
560 int config_parse_bool(const char* unit,
561 const char *filename,
564 unsigned section_line,
579 k = parse_boolean(rvalue);
581 log_syntax(unit, LOG_ERR, filename, line, k, "Failed to parse boolean value, ignoring: %s", rvalue);
589 #if 0 /// UNNEEDED by elogind
590 int config_parse_tristate(
592 const char *filename,
595 unsigned section_line,
609 /* A tristate is pretty much a boolean, except that it can
610 * also take the special value -1, indicating "uninitialized",
611 * much like NULL is for a pointer type. */
613 k = parse_boolean(rvalue);
615 log_syntax(unit, LOG_ERR, filename, line, k, "Failed to parse boolean value, ignoring: %s", rvalue);
624 int config_parse_string(
626 const char *filename,
629 unsigned section_line,
643 if (!utf8_is_valid(rvalue)) {
644 log_syntax_invalid_utf8(unit, LOG_ERR, filename, line, rvalue);
662 int config_parse_path(
664 const char *filename,
667 unsigned section_line,
681 if (!utf8_is_valid(rvalue)) {
682 log_syntax_invalid_utf8(unit, LOG_ERR, filename, line, rvalue);
686 if (!path_is_absolute(rvalue)) {
687 log_syntax(unit, LOG_ERR, filename, line, 0, "Not an absolute path, ignoring: %s", rvalue);
695 path_kill_slashes(n);
703 int config_parse_strv(const char *unit,
704 const char *filename,
707 unsigned section_line,
722 if (isempty(rvalue)) {
725 /* Empty assignment resets the list. As a special rule
726 * we actually fill in a real empty array here rather
727 * than NULL, since some code wants to know if
728 * something was set at all... */
729 empty = new0(char*, 1);
742 r = extract_first_word(&rvalue, &word, WHITESPACE, EXTRACT_QUOTES|EXTRACT_RETAIN_ESCAPE);
748 log_syntax(unit, LOG_ERR, filename, line, r, "Invalid syntax, ignoring: %s", rvalue);
752 if (!utf8_is_valid(word)) {
753 log_syntax_invalid_utf8(unit, LOG_ERR, filename, line, rvalue);
757 r = strv_consume(sv, word);
765 #if 0 /// UNNEEDED by elogind
766 int config_parse_log_facility(
768 const char *filename,
771 unsigned section_line,
786 x = log_facility_unshifted_from_string(rvalue);
788 log_syntax(unit, LOG_ERR, filename, line, 0, "Failed to parse log facility, ignoring: %s", rvalue);
792 *o = (x << 3) | LOG_PRI(*o);
798 int config_parse_log_level(
800 const char *filename,
803 unsigned section_line,
818 x = log_level_from_string(rvalue);
820 log_syntax(unit, LOG_ERR, filename, line, 0, "Failed to parse log level, ignoring: %s", rvalue);
824 *o = (*o & LOG_FACMASK) | x;
828 int config_parse_signal(
830 const char *filename,
833 unsigned section_line,
847 r = signal_from_string_try_harder(rvalue);
849 log_syntax(unit, LOG_ERR, filename, line, 0, "Failed to parse signal name, ignoring: %s", rvalue);
857 #if 0 /// UNNEEDED by elogind
858 int config_parse_personality(
860 const char *filename,
863 unsigned section_line,
870 unsigned long *personality = data, p;
877 p = personality_from_string(rvalue);
878 if (p == PERSONALITY_INVALID) {
879 log_syntax(unit, LOG_ERR, filename, line, 0, "Failed to parse personality, ignoring: %s", rvalue);
887 int config_parse_ifname(
889 const char *filename,
892 unsigned section_line,
907 if (isempty(rvalue)) {
912 if (!ifname_valid(rvalue)) {
913 log_syntax(unit, LOG_ERR, filename, line, 0, "Interface name is not valid or too long, ignoring assignment: %s", rvalue);
917 r = free_and_strdup(s, rvalue);