src/shared/conf-parser.h

   1 #pragma once
   2
   3 /***
   4   This file is part of systemd.
   5
   6   Copyright 2010 Lennart Poettering
   7
   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.
  12
  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.
  17
  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/>.
  20 ***/
  21
  22 #include <errno.h>
  23 #include <stdbool.h>
  24 #include <stddef.h>
  25 #include <stdio.h>
  26 #include <syslog.h>
  27
  28 #include "alloc-util.h"
  29 #include "log.h"
  30 #include "macro.h"
  31
  32 /* An abstract parser for simple, line based, shallow configuration
  33  * files consisting of variable assignments only. */
  34
  35 /* Prototype for a parser for a specific configuration setting */
  36 typedef int (*ConfigParserCallback)(const char *unit,
  37                                     const char *filename,
  38                                     unsigned line,
  39                                     const char *section,
  40                                     unsigned section_line,
  41                                     const char *lvalue,
  42                                     int ltype,
  43                                     const char *rvalue,
  44                                     void *data,
  45                                     void *userdata);
  46
  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 */
  55 } ConfigTableItem;
  56
  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 */
  64 } ConfigPerfItem;
  65
  66 /* Prototype for a low-level gperf lookup function */
  67 typedef const ConfigPerfItem* (*ConfigPerfItemLookup)(const char *section_and_lvalue, unsigned length);
  68
  69 /* Prototype for a generic high-level lookup function */
  70 typedef int (*ConfigItemLookup)(
  71                 const void *table,
  72                 const char *section,
  73                 const char *lvalue,
  74                 ConfigParserCallback *func,
  75                 int *ltype,
  76                 void **data,
  77                 void *userdata);
  78
  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);
  82
  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);
  86
  87 int config_parse(const char *unit,
  88                  const char *filename,
  89                  FILE *f,
  90                  const char *sections,  /* nulstr */
  91                  ConfigItemLookup lookup,
  92                  const void *table,
  93                  bool relaxed,
  94                  bool allow_include,
  95                  bool warn,
  96                  void *userdata);
  97
  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,
 102                       const void *table,
 103                       bool relaxed,
 104                       void *userdata);
 105
 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);
 117 #endif // 0
 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);
 121 #endif // 0
 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);
 128 #endif // 0
 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);
 132 #endif // 0
 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);
 137 int config_parse_ifname(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);
 138 #endif // 0
 139
 140 #define DEFINE_CONFIG_PARSE_ENUM(function,name,type,msg)                \
 141         int function(const char *unit,                                  \
 142                      const char *filename,                              \
 143                      unsigned line,                                     \
 144                      const char *section,                               \
 145                      unsigned section_line,                             \
 146                      const char *lvalue,                                \
 147                      int ltype,                                         \
 148                      const char *rvalue,                                \
 149                      void *data,                                        \
 150                      void *userdata) {                                  \
 151                                                                         \
 152                 type *i = data, x;                                      \
 153                                                                         \
 154                 assert(filename);                                       \
 155                 assert(lvalue);                                         \
 156                 assert(rvalue);                                         \
 157                 assert(data);                                           \
 158                                                                         \
 159                 if ((x = name##_from_string(rvalue)) < 0) {             \
 160                         log_syntax(unit, LOG_ERR, filename, line, -x,   \
 161                                    msg ", ignoring: %s", rvalue);       \
 162                         return 0;                                       \
 163                 }                                                       \
 164                                                                         \
 165                 *i = x;                                                 \
 166                 return 0;                                               \
 167         }
 168
 169 #define DEFINE_CONFIG_PARSE_ENUMV(function,name,type,invalid,msg)              \
 170         int function(const char *unit,                                         \
 171                      const char *filename,                                     \
 172                      unsigned line,                                            \
 173                      const char *section,                                      \
 174                      unsigned section_line,                                    \
 175                      const char *lvalue,                                       \
 176                      int ltype,                                                \
 177                      const char *rvalue,                                       \
 178                      void *data,                                               \
 179                      void *userdata) {                                         \
 180                                                                                \
 181                 type **enums = data, x, *ys;                                   \
 182                 _cleanup_free_ type *xs = NULL;                                \
 183                 const char *word, *state;                                      \
 184                 size_t l, i = 0;                                               \
 185                                                                                \
 186                 assert(filename);                                              \
 187                 assert(lvalue);                                                \
 188                 assert(rvalue);                                                \
 189                 assert(data);                                                  \
 190                                                                                \
 191                 xs = new0(type, 1);                                            \
 192                 if (!xs)                                                       \
 193                         return -ENOMEM;                                        \
 194                                                                                \
 195                 *xs = invalid;                                                 \
 196                                                                                \
 197                 FOREACH_WORD(word, l, rvalue, state) {                         \
 198                         _cleanup_free_ char *en = NULL;                        \
 199                         type *new_xs;                                          \
 200                                                                                \
 201                         en = strndup(word, l);                                 \
 202                         if (!en)                                               \
 203                                 return -ENOMEM;                                \
 204                                                                                \
 205                         if ((x = name##_from_string(en)) < 0) {                \
 206                                 log_syntax(unit, LOG_ERR, filename, line,      \
 207                                        -x, msg ", ignoring: %s", en);          \
 208                                 continue;                                      \
 209                         }                                                      \
 210                                                                                \
 211                         for (ys = xs; x != invalid && *ys != invalid; ys++) {  \
 212                                 if (*ys == x) {                                \
 213                                         log_syntax(unit, LOG_ERR, filename,    \
 214                                               line, -x,                        \
 215                                               "Duplicate entry, ignoring: %s", \
 216                                               en);                             \
 217                                         x = invalid;                           \
 218                                 }                                              \
 219                         }                                                      \
 220                                                                                \
 221                         if (x == invalid)                                      \
 222                                 continue;                                      \
 223                                                                                \
 224                         *(xs + i) = x;                                         \
 225                         new_xs = realloc(xs, (++i + 1) * sizeof(type));        \
 226                         if (new_xs)                                            \
 227                                 xs = new_xs;                                   \
 228                         else                                                   \
 229                                 return -ENOMEM;                                \
 230                                                                                \
 231                         *(xs + i) = invalid;                                   \
 232                 }                                                              \
 233                                                                                \
 234                 free(*enums);                                                  \
 235                 *enums = xs;                                                   \
 236                 xs = NULL;                                                     \
 237                                                                                \
 238                 return 0;                                                      \
 239         }