[thirdparty/systemd.git] / src / shared / conf-parser.h

/*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/

#pragma once

/***
  This file is part of systemd.

  Copyright 2010 Lennart Poettering

  systemd is free software; you can redistribute it and/or modify it
  under the terms of the GNU Lesser General Public License as published by
  the Free Software Foundation; either version 2.1 of the License, or
  (at your option) any later version.

  systemd is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public License
  along with systemd; If not, see <http://www.gnu.org/licenses/>.
***/

#include <stdio.h>
#include <stdbool.h>

#include "macro.h"

/* An abstract parser for simple, line based, shallow configuration
 * files consisting of variable assignments only. */

/* Prototype for a parser for a specific configuration setting */
typedef int (*ConfigParserCallback)(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);

/* Wraps information for parsing a specific configuration variable, to
 * be stored in a simple array */
typedef struct ConfigTableItem {
        const char *section;            /* Section */
        const char *lvalue;             /* Name of the variable */
        ConfigParserCallback parse;     /* Function that is called to parse the variable's value */
        int ltype;                      /* Distinguish different variables passed to the same callback */
        void *data;                     /* Where to store the variable's data */
} ConfigTableItem;

/* Wraps information for parsing a specific configuration variable, to
 * be stored in a gperf perfect hashtable */
typedef struct ConfigPerfItem {
        const char *section_and_lvalue; /* Section + "." + name of the variable */
        ConfigParserCallback parse;     /* Function that is called to parse the variable's value */
        int ltype;                      /* Distinguish different variables passed to the same callback */
        size_t offset;                  /* Offset where to store data, from the beginning of userdata */
} ConfigPerfItem;

/* Prototype for a low-level gperf lookup function */
typedef const ConfigPerfItem* (*ConfigPerfItemLookup)(const char *section_and_lvalue, unsigned length);

/* Prototype for a generic high-level lookup function */
typedef int (*ConfigItemLookup)(
                const void *table,
                const char *section,
                const char *lvalue,
                ConfigParserCallback *func,
                int *ltype,
                void **data,
                void *userdata);

/* Linear table search implementation of ConfigItemLookup, based on
 * ConfigTableItem arrays */
int config_item_table_lookup(const void *table, const char *section, const char *lvalue, ConfigParserCallback *func, int *ltype, void **data, void *userdata);

/* gperf implementation of ConfigItemLookup, based on gperf
 * ConfigPerfItem tables */
int config_item_perf_lookup(const void *table, const char *section, const char *lvalue, ConfigParserCallback *func, int *ltype, void **data, void *userdata);

int config_parse(const char *unit,
                 const char *filename,
                 FILE *f,
                 const char *sections,  /* nulstr */
                 ConfigItemLookup lookup,
                 const void *table,
                 bool relaxed,
                 bool allow_include,
                 bool warn,
                 void *userdata);

int config_parse_many(const char *conf_file,      /* possibly NULL */
                      const char *conf_file_dirs, /* nulstr */
                      const char *sections,       /* nulstr */
                      ConfigItemLookup lookup,
                      const void *table,
                      bool relaxed,
                      void *userdata);

/* Generic parsers */
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);
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);
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);
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);
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);
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);
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);
int config_parse_iec_off(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);
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);
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);
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);
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);
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);
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);
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);
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);
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);

#define log_invalid_utf8(unit, level, config_file, config_line, error, rvalue) \
        do {                                                            \
                _cleanup_free_ char *_p = utf8_escape_invalid(rvalue);  \
                log_syntax(unit, level, config_file, config_line, error, \
                           "String is not UTF-8 clean, ignoring assignment: %s", strna(_p)); \
        } while(false)

#define DEFINE_CONFIG_PARSE_ENUM(function,name,type,msg)                \
        int function(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) {                                  \
                                                                        \
                type *i = data, x;                                      \
                                                                        \
                assert(filename);                                       \
                assert(lvalue);                                         \
                assert(rvalue);                                         \
                assert(data);                                           \
                                                                        \
                if ((x = name##_from_string(rvalue)) < 0) {             \
                        log_syntax(unit, LOG_ERR, filename, line, -x,   \
                                   msg ", ignoring: %s", rvalue);       \
                        return 0;                                       \
                }                                                       \
                                                                        \
                *i = x;                                                 \
                return 0;                                               \
        }

#define DEFINE_CONFIG_PARSE_ENUMV(function,name,type,invalid,msg)              \
        int function(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) {                                         \
                                                                               \
                type **enums = data, x, *ys;                                   \
                _cleanup_free_ type *xs = NULL;                                \
                const char *word, *state;                                      \
                size_t l, i = 0;                                               \
                                                                               \
                assert(filename);                                              \
                assert(lvalue);                                                \
                assert(rvalue);                                                \
                assert(data);                                                  \
                                                                               \
                xs = new0(type, 1);                                            \
                if(!xs)                                                        \
                        return -ENOMEM;                                        \
                                                                               \
                *xs = invalid;                                                 \
                                                                               \
                FOREACH_WORD(word, l, rvalue, state) {                         \
                        _cleanup_free_ char *en = NULL;                        \
                        type *new_xs;                                          \
                                                                               \
                        en = strndup(word, l);                                 \
                        if (!en)                                               \
                                return -ENOMEM;                                \
                                                                               \
                        if ((x = name##_from_string(en)) < 0) {                \
                                log_syntax(unit, LOG_ERR, filename, line,      \
                                       -x, msg ", ignoring: %s", en);          \
                                continue;                                      \
                        }                                                      \
                                                                               \
                        for (ys = xs; x != invalid && *ys != invalid; ys++) {  \
                                if (*ys == x) {                                \
                                        log_syntax(unit, LOG_ERR, filename,    \
                                              line, -x,                        \
                                              "Duplicate entry, ignoring: %s", \
                                              en);                             \
                                        x = invalid;                           \
                                }                                              \
                        }                                                      \
                                                                               \
                        if (x == invalid)                                      \
                                continue;                                      \
                                                                               \
                        *(xs + i) = x;                                         \
                        new_xs = realloc(xs, (++i + 1) * sizeof(type));        \
                        if (new_xs)                                            \
                                xs = new_xs;                                   \
                        else                                                   \
                                return -ENOMEM;                                \
                                                                               \
                        *(xs + i) = invalid;                                   \
                }                                                              \
                                                                               \
                free(*enums);                                                  \
                *enums = xs;                                                   \
                xs = NULL;                                                     \
                                                                               \
                return 0;                                                      \
        }
Commit	Line	Data
03467c88	1	/-- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil --/
ed5bcfbe	2
c2f1db8f	3	#pragma once
ed5bcfbe	4
a7334b09 LP	5	/***
	6	This file is part of systemd.
	7
	8	Copyright 2010 Lennart Poettering
	9
	10	systemd is free software; you can redistribute it and/or modify it
5430f7f2 LP	11	under the terms of the GNU Lesser General Public License as published by
5430f7f2 LP	12	the Free Software Foundation; either version 2.1 of the License, or
a7334b09 LP	13	(at your option) any later version.
	14
	15	systemd is distributed in the hope that it will be useful, but
	16	WITHOUT ANY WARRANTY; without even the implied warranty of
	17	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5430f7f2	18	Lesser General Public License for more details.
a7334b09	19
5430f7f2	20	You should have received a copy of the GNU Lesser General Public License
a7334b09 LP	21	along with systemd; If not, see <http://www.gnu.org/licenses/>.
	22	***/
	23
ed5bcfbe	24	#include <stdio.h>
10e87ee7	25	#include <stdbool.h>
ed5bcfbe	26
e8e581bf ZJS	27	#include "macro.h"
e8e581bf ZJS	28
ed5bcfbe LP	29	/* An abstract parser for simple, line based, shallow configuration
	30	* files consisting of variable assignments only. */
	31
f975e971	32	/* Prototype for a parser for a specific configuration setting */
e8e581bf ZJS	33	typedef int (ConfigParserCallback)(const char unit,
	34	const char *filename,
	35	unsigned line,
	36	const char *section,
71a61510	37	unsigned section_line,
e8e581bf ZJS	38	const char *lvalue,
	39	int ltype,
	40	const char *rvalue,
	41	void *data,
	42	void *userdata);
f975e971 LP	43
	44	/* Wraps information for parsing a specific configuration variable, to
	45	* be stored in a simple array */
	46	typedef struct ConfigTableItem {
	47	const char section; / Section */
	48	const char lvalue; / Name of the variable */
	49	ConfigParserCallback parse; /* Function that is called to parse the variable's value */
	50	int ltype; /* Distinguish different variables passed to the same callback */
	51	void data; / Where to store the variable's data */
	52	} ConfigTableItem;
	53
	54	/* Wraps information for parsing a specific configuration variable, to
e5a7f173	55	* be stored in a gperf perfect hashtable */
f975e971 LP	56	typedef struct ConfigPerfItem {
	57	const char section_and_lvalue; / Section + "." + name of the variable */
	58	ConfigParserCallback parse; /* Function that is called to parse the variable's value */
	59	int ltype; /* Distinguish different variables passed to the same callback */
	60	size_t offset; /* Offset where to store data, from the beginning of userdata */
	61	} ConfigPerfItem;
	62
	63	/* Prototype for a low-level gperf lookup function */
	64	typedef const ConfigPerfItem* (ConfigPerfItemLookup)(const char section_and_lvalue, unsigned length);
	65
	66	/* Prototype for a generic high-level lookup function */
	67	typedef int (*ConfigItemLookup)(
e9f3d2d5	68	const void *table,
f975e971 LP	69	const char *section,
	70	const char *lvalue,
	71	ConfigParserCallback *func,
	72	int *ltype,
	73	void **data,
	74	void *userdata);
	75
	76	/* Linear table search implementation of ConfigItemLookup, based on
	77	* ConfigTableItem arrays */
e9f3d2d5	78	int config_item_table_lookup(const void table, const char section, const char lvalue, ConfigParserCallback func, int ltype, void data, void userdata);
f975e971 LP	79
	80	/* gperf implementation of ConfigItemLookup, based on gperf
	81	* ConfigPerfItem tables */
e9f3d2d5	82	int config_item_perf_lookup(const void table, const char section, const char lvalue, ConfigParserCallback func, int ltype, void data, void userdata);
f975e971	83
e8e581bf ZJS	84	int config_parse(const char *unit,
	85	const char *filename,
	86	FILE *f,
	87	const char sections, / nulstr */
	88	ConfigItemLookup lookup,
e9f3d2d5	89	const void *table,
e8e581bf	90	bool relaxed,
db5c0122	91	bool allow_include,
36f822c4	92	bool warn,
e8e581bf	93	void *userdata);
ed5bcfbe	94
e8461023 JT	95	int config_parse_many(const char conf_file, / possibly NULL */
	96	const char conf_file_dirs, / nulstr */
	97	const char sections, / nulstr */
	98	ConfigItemLookup lookup,
	99	const void *table,
	100	bool relaxed,
	101	void *userdata);
	102
ed5bcfbe	103	/* Generic parsers */
71a61510 TG	104	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);
	105	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);
	106	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);
	107	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);
	108	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);
5556b5fe LP	109	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);
	110	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);
	111	int config_parse_iec_off(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);
71a61510 TG	112	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);
	113	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);
	114	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);
	115	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);
71a61510 TG	116	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);
	117	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);
	118	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);
ca37242e LP	119	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);
ca37242e LP	120	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);
e8e581bf	121
978553ce LP	122	#define log_invalid_utf8(unit, level, config_file, config_line, error, rvalue) \
	123	do { \
	124	_cleanup_free_ char *_p = utf8_escape_invalid(rvalue); \
	125	log_syntax(unit, level, config_file, config_line, error, \
	126	"String is not UTF-8 clean, ignoring assignment: %s", strna(_p)); \
	127	} while(false)
b5d74213	128
487393e9	129	#define DEFINE_CONFIG_PARSE_ENUM(function,name,type,msg) \
e8e581bf ZJS	130	int function(const char *unit, \
	131	const char *filename, \
	132	unsigned line, \
	133	const char *section, \
71a61510	134	unsigned section_line, \
e8e581bf ZJS	135	const char *lvalue, \
	136	int ltype, \
	137	const char *rvalue, \
	138	void *data, \
	139	void *userdata) { \
487393e9 LP	140	\
	141	type *i = data, x; \
	142	\
	143	assert(filename); \
	144	assert(lvalue); \
	145	assert(rvalue); \
	146	assert(data); \
	147	\
	148	if ((x = name##_from_string(rvalue)) < 0) { \
e8e581bf ZJS	149	log_syntax(unit, LOG_ERR, filename, line, -x, \
e8e581bf ZJS	150	msg ", ignoring: %s", rvalue); \
c0b34696	151	return 0; \
487393e9 LP	152	} \
	153	\
	154	*i = x; \
487393e9 LP	155	return 0; \
487393e9 LP	156	}
916484f5 TG	157
	158	#define DEFINE_CONFIG_PARSE_ENUMV(function,name,type,invalid,msg) \
	159	int function(const char *unit, \
	160	const char *filename, \
	161	unsigned line, \
	162	const char *section, \
71a61510	163	unsigned section_line, \
916484f5 TG	164	const char *lvalue, \
	165	int ltype, \
	166	const char *rvalue, \
	167	void *data, \
	168	void *userdata) { \
	169	\
77c10205 TG	170	type *enums = data, x, ys; \
77c10205 TG	171	_cleanup_free_ type *xs = NULL; \
a2a5291b	172	const char word, state; \
916484f5 TG	173	size_t l, i = 0; \
	174	\
	175	assert(filename); \
	176	assert(lvalue); \
	177	assert(rvalue); \
	178	assert(data); \
	179	\
	180	xs = new0(type, 1); \
83e341a6 TG	181	if(!xs) \
	182	return -ENOMEM; \
	183	\
916484f5 TG	184	*xs = invalid; \
916484f5 TG	185	\
a2a5291b	186	FOREACH_WORD(word, l, rvalue, state) { \
916484f5	187	_cleanup_free_ char *en = NULL; \
77c10205	188	type *new_xs; \
916484f5	189	\
a2a5291b	190	en = strndup(word, l); \
916484f5 TG	191	if (!en) \
	192	return -ENOMEM; \
	193	\
	194	if ((x = name##_from_string(en)) < 0) { \
	195	log_syntax(unit, LOG_ERR, filename, line, \
	196	-x, msg ", ignoring: %s", en); \
	197	continue; \
	198	} \
	199	\
	200	for (ys = xs; x != invalid && *ys != invalid; ys++) { \
	201	if (*ys == x) { \
	202	log_syntax(unit, LOG_ERR, filename, \
	203	line, -x, \
	204	"Duplicate entry, ignoring: %s", \
	205	en); \
	206	x = invalid; \
	207	} \
	208	} \
	209	\
	210	if (x == invalid) \
	211	continue; \
	212	\
	213	*(xs + i) = x; \
77c10205 TG	214	new_xs = realloc(xs, (++i + 1) * sizeof(type)); \
	215	if (new_xs) \
	216	xs = new_xs; \
	217	else \
916484f5	218	return -ENOMEM; \
83e341a6	219	\
916484f5 TG	220	*(xs + i) = invalid; \
	221	} \
	222	\
	223	free(*enums); \
	224	*enums = xs; \
77c10205 TG	225	xs = NULL; \
77c10205 TG	226	\
916484f5 TG	227	return 0; \
916484f5 TG	228	}