src/shared/conf-parser.h

   1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
   2
   3 #pragma once
   4
   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
  11   under the terms of the GNU Lesser General Public License as published by
  12   the Free Software Foundation; either version 2.1 of the License, or
  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
  18   Lesser General Public License for more details.
  19
  20   You should have received a copy of the GNU Lesser General Public License
  21   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  22 ***/
  23
  24 #include <stdio.h>
  25 #include <stdbool.h>
  26
  27 #include "macro.h"
  28
  29 /* An abstract parser for simple, line based, shallow configuration
  30  * files consisting of variable assignments only. */
  31
  32 /* Prototype for a parser for a specific configuration setting */
  33 typedef int (*ConfigParserCallback)(const char *unit,
  34                                     const char *filename,
  35                                     unsigned line,
  36                                     const char *section,
  37                                     unsigned section_line,
  38                                     const char *lvalue,
  39                                     int ltype,
  40                                     const char *rvalue,
  41                                     void *data,
  42                                     void *userdata);
  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
  55  * be stored in a gperf perfect hashtable */
  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)(
  68                 const void *table,
  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 */
  78 int config_item_table_lookup(const void *table, const char *section, const char *lvalue, ConfigParserCallback *func, int *ltype, void **data, void *userdata);
  79
  80 /* gperf implementation of ConfigItemLookup, based on gperf
  81  * ConfigPerfItem tables */
  82 int config_item_perf_lookup(const void *table, const char *section, const char *lvalue, ConfigParserCallback *func, int *ltype, void **data, void *userdata);
  83
  84 int config_parse(const char *unit,
  85                  const char *filename,
  86                  FILE *f,
  87                  const char *sections,  /* nulstr */
  88                  ConfigItemLookup lookup,
  89                  const void *table,
  90                  bool relaxed,
  91                  bool allow_include,
  92                  bool warn,
  93                  void *userdata);
  94
  95 /* Generic parsers */
  96 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);
  97 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);
  98 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);
  99 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);
 100 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);
 101 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);
 102 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);
 103 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);
 104 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);
 105 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);
 106 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);
 107 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);
 108 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);
 109 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);
 110 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);
 111 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);
 112 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);
 113
 114 int log_syntax_internal(const char *unit, int level,
 115                         const char *file, unsigned line, const char *func,
 116                         const char *config_file, unsigned config_line,
 117                         int error, const char *format, ...) _printf_(9, 10);
 118
 119 #define log_syntax(unit, level, config_file, config_line, error, ...)   \
 120         log_syntax_internal(unit, level,                                \
 121                             __FILE__, __LINE__, __func__,               \
 122                             config_file, config_line,                   \
 123                             error, __VA_ARGS__)
 124
 125 #define log_invalid_utf8(unit, level, config_file, config_line, error, rvalue) { \
 126         _cleanup_free_ char *__p = utf8_escape_invalid(rvalue);                  \
 127         log_syntax(unit, level, config_file, config_line, error,                 \
 128                    "String is not UTF-8 clean, ignoring assignment: %s", __p);   \
 129         }
 130
 131 #define DEFINE_CONFIG_PARSE_ENUM(function,name,type,msg)                \
 132         int function(const char *unit,                                  \
 133                      const char *filename,                              \
 134                      unsigned line,                                     \
 135                      const char *section,                               \
 136                      unsigned section_line,                             \
 137                      const char *lvalue,                                \
 138                      int ltype,                                         \
 139                      const char *rvalue,                                \
 140                      void *data,                                        \
 141                      void *userdata) {                                  \
 142                                                                         \
 143                 type *i = data, x;                                      \
 144                                                                         \
 145                 assert(filename);                                       \
 146                 assert(lvalue);                                         \
 147                 assert(rvalue);                                         \
 148                 assert(data);                                           \
 149                                                                         \
 150                 if ((x = name##_from_string(rvalue)) < 0) {             \
 151                         log_syntax(unit, LOG_ERR, filename, line, -x,   \
 152                                    msg ", ignoring: %s", rvalue);       \
 153                         return 0;                                       \
 154                 }                                                       \
 155                                                                         \
 156                 *i = x;                                                 \
 157                 return 0;                                               \
 158         }
 159
 160 #define DEFINE_CONFIG_PARSE_ENUMV(function,name,type,invalid,msg)              \
 161         int function(const char *unit,                                         \
 162                      const char *filename,                                     \
 163                      unsigned line,                                            \
 164                      const char *section,                                      \
 165                      unsigned section_line,                                    \
 166                      const char *lvalue,                                       \
 167                      int ltype,                                                \
 168                      const char *rvalue,                                       \
 169                      void *data,                                               \
 170                      void *userdata) {                                         \
 171                                                                                \
 172                 type **enums = data, *xs, x, *ys;                              \
 173                 const char *word, *state;                                      \
 174                 size_t l, i = 0;                                               \
 175                                                                                \
 176                 assert(filename);                                              \
 177                 assert(lvalue);                                                \
 178                 assert(rvalue);                                                \
 179                 assert(data);                                                  \
 180                                                                                \
 181                 xs = new0(type, 1);                                            \
 182                 *xs = invalid;                                                 \
 183                                                                                \
 184                 FOREACH_WORD(word, l, rvalue, state) {                         \
 185                         _cleanup_free_ char *en = NULL;                        \
 186                                                                                \
 187                         en = strndup(word, l);                                 \
 188                         if (!en)                                               \
 189                                 return -ENOMEM;                                \
 190                                                                                \
 191                         if ((x = name##_from_string(en)) < 0) {                \
 192                                 log_syntax(unit, LOG_ERR, filename, line,      \
 193                                        -x, msg ", ignoring: %s", en);          \
 194                                 continue;                                      \
 195                         }                                                      \
 196                                                                                \
 197                         for (ys = xs; x != invalid && *ys != invalid; ys++) {  \
 198                                 if (*ys == x) {                                \
 199                                         log_syntax(unit, LOG_ERR, filename,    \
 200                                               line, -x,                        \
 201                                               "Duplicate entry, ignoring: %s", \
 202                                               en);                             \
 203                                         x = invalid;                           \
 204                                 }                                              \
 205                         }                                                      \
 206                                                                                \
 207                         if (x == invalid)                                      \
 208                                 continue;                                      \
 209                                                                                \
 210                         *(xs + i) = x;                                         \
 211                         xs = realloc(xs, (++i + 1) * sizeof(type));            \
 212                         if (!xs)                                               \
 213                                 return -ENOMEM;                                \
 214                         *(xs + i) = invalid;                                   \
 215                 }                                                              \
 216                                                                                \
 217                 free(*enums);                                                  \
 218                 *enums = xs;                                                   \
 219                 return 0;                                                      \
 220         }