4 This file is part of systemd.
6 Copyright 2010 Lennart Poettering
8 systemd is free software; you can redistribute it and/or modify it
9 under the terms of the GNU Lesser General Public License as published by
10 the Free Software Foundation; either version 2.1 of the License, or
11 (at your option) any later version.
13 systemd is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 Lesser General Public License for more details.
18 You should have received a copy of the GNU Lesser General Public License
19 along with systemd; If not, see <http://www.gnu.org/licenses/>.
28 #include "alloc-util.h"
32 /* An abstract parser for simple, line based, shallow configuration
33 * files consisting of variable assignments only. */
35 /* Prototype for a parser for a specific configuration setting */
36 typedef int (*ConfigParserCallback)(const char *unit,
40 unsigned section_line,
47 /* Wraps information for parsing a specific configuration variable, to
48 * be stored in a simple array */
49 typedef struct ConfigTableItem {
50 const char *section; /* Section */
51 const char *lvalue; /* Name of the variable */
52 ConfigParserCallback parse; /* Function that is called to parse the variable's value */
53 int ltype; /* Distinguish different variables passed to the same callback */
54 void *data; /* Where to store the variable's data */
57 /* Wraps information for parsing a specific configuration variable, to
58 * be stored in a gperf perfect hashtable */
59 typedef struct ConfigPerfItem {
60 const char *section_and_lvalue; /* Section + "." + name of the variable */
61 ConfigParserCallback parse; /* Function that is called to parse the variable's value */
62 int ltype; /* Distinguish different variables passed to the same callback */
63 size_t offset; /* Offset where to store data, from the beginning of userdata */
66 /* Prototype for a low-level gperf lookup function */
67 typedef const ConfigPerfItem* (*ConfigPerfItemLookup)(const char *section_and_lvalue, unsigned length);
69 /* Prototype for a generic high-level lookup function */
70 typedef int (*ConfigItemLookup)(
74 ConfigParserCallback *func,
79 /* Linear table search implementation of ConfigItemLookup, based on
80 * ConfigTableItem arrays */
81 int config_item_table_lookup(const void *table, const char *section, const char *lvalue, ConfigParserCallback *func, int *ltype, void **data, void *userdata);
83 /* gperf implementation of ConfigItemLookup, based on gperf
84 * ConfigPerfItem tables */
85 int config_item_perf_lookup(const void *table, const char *section, const char *lvalue, ConfigParserCallback *func, int *ltype, void **data, void *userdata);
87 int config_parse(const char *unit,
90 const char *sections, /* nulstr */
91 ConfigItemLookup lookup,
98 int config_parse_many(const char *conf_file, /* possibly NULL */
99 const char *conf_file_dirs, /* nulstr */
100 const char *sections, /* nulstr */
101 ConfigItemLookup lookup,
106 /* Generic parsers */
107 int config_parse_int(const char *unit, const char *filename, unsigned line, const char *section, unsigned section_line, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
108 int config_parse_unsigned(const char *unit, const char *filename, unsigned line, const char *section, unsigned section_line, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
109 int config_parse_long(const char *unit, const char *filename, unsigned line, const char *section, unsigned section_line, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
110 int config_parse_uint32(const char *unit, const char *filename, unsigned line, const char *section, unsigned section_line, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
111 int config_parse_uint64(const char *unit, const char *filename, unsigned line, const char *section, unsigned section_line, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
112 int config_parse_double(const char *unit, const char *filename, unsigned line, const char *section, unsigned section_line, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
113 int config_parse_iec_size(const char *unit, const char *filename, unsigned line, const char *section, unsigned section_line, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
114 #if 0 /// UNNEEDED by elogind
115 int config_parse_si_size(const char *unit, const char *filename, unsigned line, const char *section, unsigned section_line, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
116 int config_parse_iec_uint64(const char *unit, const char *filename, unsigned line, const char *section, unsigned section_line, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
118 int config_parse_bool(const char *unit, const char *filename, unsigned line, const char *section, unsigned section_line, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
119 #if 0 /// UNNEEDED by elogind
120 int config_parse_tristate(const char *unit, const char *filename, unsigned line, const char *section, unsigned section_line, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
122 int config_parse_string(const char *unit, const char *filename, unsigned line, const char *section, unsigned section_line, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
123 int config_parse_path(const char *unit, const char *filename, unsigned line, const char *section, unsigned section_line, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
124 int config_parse_strv(const char *unit, const char *filename, unsigned line, const char *section, unsigned section_line, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
125 int config_parse_sec(const char *unit, const char *filename, unsigned line, const char *section, unsigned section_line, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
126 #if 0 /// UNNEEDED by elogind
127 int config_parse_nsec(const char *unit, const char *filename, unsigned line, const char *section, unsigned section_line, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
129 int config_parse_mode(const char *unit, const char *filename, unsigned line, const char *section, unsigned section_line, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
130 #if 0 /// UNNEEDED by elogind
131 int config_parse_log_facility(const char *unit, const char *filename, unsigned line, const char *section, unsigned section_line, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
133 int config_parse_log_level(const char *unit, const char *filename, unsigned line, const char *section, unsigned section_line, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
134 int config_parse_signal(const char *unit, const char *filename, unsigned line, const char *section, unsigned section_line, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
135 #if 0 /// UNNEEDED by elogind
136 int config_parse_personality(const char *unit, const char *filename, unsigned line, const char *section, unsigned section_line, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
139 #define DEFINE_CONFIG_PARSE_ENUM(function,name,type,msg) \
140 int function(const char *unit, \
141 const char *filename, \
143 const char *section, \
144 unsigned section_line, \
145 const char *lvalue, \
147 const char *rvalue, \
158 if ((x = name##_from_string(rvalue)) < 0) { \
159 log_syntax(unit, LOG_ERR, filename, line, -x, \
160 msg ", ignoring: %s", rvalue); \
168 #define DEFINE_CONFIG_PARSE_ENUMV(function,name,type,invalid,msg) \
169 int function(const char *unit, \
170 const char *filename, \
172 const char *section, \
173 unsigned section_line, \
174 const char *lvalue, \
176 const char *rvalue, \
180 type **enums = data, x, *ys; \
181 _cleanup_free_ type *xs = NULL; \
182 const char *word, *state; \
190 xs = new0(type, 1); \
196 FOREACH_WORD(word, l, rvalue, state) { \
197 _cleanup_free_ char *en = NULL; \
200 en = strndup(word, l); \
204 if ((x = name##_from_string(en)) < 0) { \
205 log_syntax(unit, LOG_ERR, filename, line, \
206 -x, msg ", ignoring: %s", en); \
210 for (ys = xs; x != invalid && *ys != invalid; ys++) { \
212 log_syntax(unit, LOG_ERR, filename, \
214 "Duplicate entry, ignoring: %s", \
224 new_xs = realloc(xs, (++i + 1) * sizeof(type)); \
230 *(xs + i) = invalid; \