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 "socket-util.h"
41 #include "string-util.h"
43 #include "syslog-util.h"
44 #include "time-util.h"
47 int config_item_table_lookup(
51 ConfigParserCallback
*func
,
56 const ConfigTableItem
*t
;
64 for (t
= table
; t
->lvalue
; t
++) {
66 if (!streq(lvalue
, t
->lvalue
))
69 if (!streq_ptr(section
, t
->section
))
81 int config_item_perf_lookup(
85 ConfigParserCallback
*func
,
90 ConfigPerfItemLookup lookup
= (ConfigPerfItemLookup
) table
;
91 const ConfigPerfItem
*p
;
100 p
= lookup(lvalue
, strlen(lvalue
));
104 key
= strjoin(section
, ".", lvalue
, NULL
);
108 p
= lookup(key
, strlen(key
));
117 *data
= (uint8_t*) userdata
+ p
->offset
;
121 /* Run the user supplied parser for an assignment */
122 static int next_assignment(const char *unit
,
123 const char *filename
,
125 ConfigItemLookup lookup
,
128 unsigned section_line
,
134 ConfigParserCallback func
= NULL
;
145 r
= lookup(table
, section
, lvalue
, &func
, <ype
, &data
, userdata
);
151 return func(unit
, filename
, line
, section
, section_line
,
152 lvalue
, ltype
, rvalue
, data
, userdata
);
157 /* Warn about unknown non-extension fields. */
158 if (!relaxed
&& !startswith(lvalue
, "X-"))
159 log_syntax(unit
, LOG_WARNING
, filename
, line
, 0, "Unknown lvalue '%s' in section '%s'", lvalue
, section
);
164 /* Parse a variable assignment line */
165 static int parse_line(const char* unit
,
166 const char *filename
,
168 const char *sections
,
169 ConfigItemLookup lookup
,
174 unsigned *section_line
,
175 bool *section_ignored
,
191 if (strchr(COMMENTS
"\n", *l
))
194 if (startswith(l
, ".include ")) {
195 _cleanup_free_
char *fn
= NULL
;
197 /* .includes are a bad idea, we only support them here
198 * for historical reasons. They create cyclic include
199 * problems and make it difficult to detect
200 * configuration file changes with an easy
201 * stat(). Better approaches, such as .d/ drop-in
204 * Support for them should be eventually removed. */
206 if (!allow_include
) {
207 log_syntax(unit
, LOG_ERR
, filename
, line
, 0, ".include not allowed here. Ignoring.");
211 fn
= file_in_same_dir(filename
, strstrip(l
+9));
215 return config_parse(unit
, fn
, NULL
, sections
, lookup
, table
, relaxed
, false, false, userdata
);
226 log_syntax(unit
, LOG_ERR
, filename
, line
, 0, "Invalid section header '%s'", l
);
230 n
= strndup(l
+1, k
-2);
234 if (sections
&& !nulstr_contains(sections
, n
)) {
236 if (!relaxed
&& !startswith(n
, "X-"))
237 log_syntax(unit
, LOG_WARNING
, filename
, line
, 0, "Unknown section '%s'. Ignoring.", n
);
240 *section
= mfree(*section
);
242 *section_ignored
= true;
246 *section_line
= line
;
247 *section_ignored
= false;
253 if (sections
&& !*section
) {
255 if (!relaxed
&& !*section_ignored
)
256 log_syntax(unit
, LOG_WARNING
, filename
, line
, 0, "Assignment outside of section. Ignoring.");
263 log_syntax(unit
, LOG_WARNING
, filename
, line
, 0, "Missing '='.");
270 return next_assignment(unit
,
283 /* Go through the file and parse each line */
284 int config_parse(const char *unit
,
285 const char *filename
,
287 const char *sections
,
288 ConfigItemLookup lookup
,
295 _cleanup_free_
char *section
= NULL
, *continuation
= NULL
;
296 _cleanup_fclose_
FILE *ours
= NULL
;
297 unsigned line
= 0, section_line
= 0;
298 bool section_ignored
= false, allow_bom
= true;
305 f
= ours
= fopen(filename
, "re");
307 /* Only log on request, except for ENOENT,
308 * since we return 0 to the caller. */
309 if (warn
|| errno
== ENOENT
)
310 log_full(errno
== ENOENT
? LOG_DEBUG
: LOG_ERR
,
311 "Failed to open configuration file '%s': %m", filename
);
312 return errno
== ENOENT
? 0 : -errno
;
316 fd_warn_permissions(filename
, fileno(f
));
319 char buf
[LINE_MAX
], *l
, *p
, *c
= NULL
, *e
;
320 bool escaped
= false;
322 if (!fgets(buf
, sizeof buf
, f
)) {
326 return log_error_errno(errno
, "Failed to read configuration file '%s': %m", filename
);
330 if (allow_bom
&& startswith(l
, UTF8_BYTE_ORDER_MARK
))
331 l
+= strlen(UTF8_BYTE_ORDER_MARK
);
337 c
= strappend(continuation
, l
);
344 continuation
= mfree(continuation
);
349 for (e
= p
; *e
; e
++) {
362 continuation
= strdup(l
);
390 log_warning_errno(r
, "Failed to parse file '%s': %m",
399 /* Parse each config file in the specified directories. */
400 int config_parse_many_nulstr(
401 const char *conf_file
,
402 const char *conf_file_dirs
,
403 const char *sections
,
404 ConfigItemLookup lookup
,
409 _cleanup_strv_free_
char **files
= NULL
;
413 r
= conf_files_list_nulstr(&files
, ".conf", NULL
, conf_file_dirs
);
418 r
= config_parse(NULL
, conf_file
, NULL
, sections
, lookup
, table
, relaxed
, false, true, userdata
);
423 STRV_FOREACH(fn
, files
) {
424 r
= config_parse(NULL
, *fn
, NULL
, sections
, lookup
, table
, relaxed
, false, true, userdata
);
432 #define DEFINE_PARSER(type, vartype, conv_func) \
433 int config_parse_##type( \
435 const char *filename, \
437 const char *section, \
438 unsigned section_line, \
439 const char *lvalue, \
441 const char *rvalue, \
453 r = conv_func(rvalue, i); \
455 log_syntax(unit, LOG_ERR, filename, line, r, \
456 "Failed to parse %s value, ignoring: %s", \
461 struct __useless_struct_to_allow_trailing_semicolon__
463 DEFINE_PARSER(int, int, safe_atoi
);
464 DEFINE_PARSER(long, long, safe_atoli
);
465 DEFINE_PARSER(uint16
, uint16_t, safe_atou16
);
466 DEFINE_PARSER(uint32
, uint32_t, safe_atou32
);
467 DEFINE_PARSER(uint64
, uint64_t, safe_atou64
);
468 DEFINE_PARSER(unsigned, unsigned, safe_atou
);
469 DEFINE_PARSER(double, double, safe_atod
);
470 DEFINE_PARSER(nsec
, nsec_t
, parse_nsec
);
471 DEFINE_PARSER(sec
, usec_t
, parse_sec
);
472 DEFINE_PARSER(mode
, mode_t
, parse_mode
);
474 int config_parse_iec_size(const char* unit
,
475 const char *filename
,
478 unsigned section_line
,
494 r
= parse_size(rvalue
, 1024, &v
);
495 if (r
< 0 || (uint64_t) (size_t) v
!= v
) {
496 log_syntax(unit
, LOG_ERR
, filename
, line
, r
, "Failed to parse size value, ignoring: %s", rvalue
);
504 int config_parse_si_size(const char* unit
,
505 const char *filename
,
508 unsigned section_line
,
524 r
= parse_size(rvalue
, 1000, &v
);
525 if (r
< 0 || (uint64_t) (size_t) v
!= v
) {
526 log_syntax(unit
, LOG_ERR
, filename
, line
, r
, "Failed to parse size value, ignoring: %s", rvalue
);
534 int config_parse_iec_uint64(const char* unit
,
535 const char *filename
,
538 unsigned section_line
,
545 uint64_t *bytes
= data
;
553 r
= parse_size(rvalue
, 1024, bytes
);
555 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 int config_parse_tristate(
591 const char *filename
,
594 unsigned section_line
,
608 /* A tristate is pretty much a boolean, except that it can
609 * also take the special value -1, indicating "uninitialized",
610 * much like NULL is for a pointer type. */
612 k
= parse_boolean(rvalue
);
614 log_syntax(unit
, LOG_ERR
, filename
, line
, k
, "Failed to parse boolean value, ignoring: %s", rvalue
);
622 int config_parse_string(
624 const char *filename
,
627 unsigned section_line
,
641 if (!utf8_is_valid(rvalue
)) {
642 log_syntax_invalid_utf8(unit
, LOG_ERR
, filename
, line
, rvalue
);
660 int config_parse_path(
662 const char *filename
,
665 unsigned section_line
,
679 if (!utf8_is_valid(rvalue
)) {
680 log_syntax_invalid_utf8(unit
, LOG_ERR
, filename
, line
, rvalue
);
684 if (!path_is_absolute(rvalue
)) {
685 log_syntax(unit
, LOG_ERR
, filename
, line
, 0, "Not an absolute path, ignoring: %s", rvalue
);
693 path_kill_slashes(n
);
701 int config_parse_strv(const char *unit
,
702 const char *filename
,
705 unsigned section_line
,
720 if (isempty(rvalue
)) {
723 /* Empty assignment resets the list. As a special rule
724 * we actually fill in a real empty array here rather
725 * than NULL, since some code wants to know if
726 * something was set at all... */
727 empty
= new0(char*, 1);
740 r
= extract_first_word(&rvalue
, &word
, WHITESPACE
, EXTRACT_QUOTES
|EXTRACT_RETAIN_ESCAPE
);
746 log_syntax(unit
, LOG_ERR
, filename
, line
, r
, "Invalid syntax, ignoring: %s", rvalue
);
750 if (!utf8_is_valid(word
)) {
751 log_syntax_invalid_utf8(unit
, LOG_ERR
, filename
, line
, rvalue
);
755 r
= strv_consume(sv
, word
);
763 int config_parse_log_facility(
765 const char *filename
,
768 unsigned section_line
,
783 x
= log_facility_unshifted_from_string(rvalue
);
785 log_syntax(unit
, LOG_ERR
, filename
, line
, 0, "Failed to parse log facility, ignoring: %s", rvalue
);
789 *o
= (x
<< 3) | LOG_PRI(*o
);
794 int config_parse_log_level(
796 const char *filename
,
799 unsigned section_line
,
814 x
= log_level_from_string(rvalue
);
816 log_syntax(unit
, LOG_ERR
, filename
, line
, 0, "Failed to parse log level, ignoring: %s", rvalue
);
820 *o
= (*o
& LOG_FACMASK
) | x
;
824 int config_parse_signal(
826 const char *filename
,
829 unsigned section_line
,
843 r
= signal_from_string_try_harder(rvalue
);
845 log_syntax(unit
, LOG_ERR
, filename
, line
, 0, "Failed to parse signal name, ignoring: %s", rvalue
);
853 int config_parse_personality(
855 const char *filename
,
858 unsigned section_line
,
865 unsigned long *personality
= data
, p
;
872 p
= personality_from_string(rvalue
);
873 if (p
== PERSONALITY_INVALID
) {
874 log_syntax(unit
, LOG_ERR
, filename
, line
, 0, "Failed to parse personality, ignoring: %s", rvalue
);
882 int config_parse_ifname(
884 const char *filename
,
887 unsigned section_line
,
902 if (isempty(rvalue
)) {
907 if (!ifname_valid(rvalue
)) {
908 log_syntax(unit
, LOG_ERR
, filename
, line
, 0, "Interface name is not valid or too long, ignoring assignment: %s", rvalue
);
912 r
= free_and_strdup(s
, rvalue
);