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(
  88                 const char *unit,
  89                 const char *filename,
  90                 FILE *f,
  91                 const char *sections,  /* nulstr */
  92                 ConfigItemLookup lookup,
  93                 const void *table,
  94                 bool relaxed,
  95                 bool allow_include,
  96                 bool warn,
  97                 void *userdata);
  98
  99 int config_parse_many_nulstr(
 100                 const char *conf_file,      /* possibly NULL */
 101                 const char *conf_file_dirs, /* nulstr */
 102                 const char *sections,       /* nulstr */
 103                 ConfigItemLookup lookup,
 104                 const void *table,
 105                 bool relaxed,
 106                 void *userdata);
 107
 108 int config_parse_many(
 109                 const char *conf_file,      /* possibly NULL */
 110                 const char* const* conf_file_dirs,
 111                 const char *dropin_dirname,
 112                 const char *sections,       /* nulstr */
 113                 ConfigItemLookup lookup,
 114                 const void *table,
 115                 bool relaxed,
 116                 void *userdata);
 117
 118 /* Generic parsers */
 119 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);
 120 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);
 121 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);
 122 int config_parse_uint16(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_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);
 124 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);
 125 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);
 126 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);
 127 #if 0 /// UNNEEDED by elogind
 128 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);
 129 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);
 130 #endif // 0
 131 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);
 132 #if 0 /// UNNEEDED by elogind
 133 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);
 134 #endif // 0
 135 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);
 136 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);
 137 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);
 138 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);
 139 #if 0 /// UNNEEDED by elogind
 140 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);
 141 #endif // 0
 142 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);
 143 #if 0 /// UNNEEDED by elogind
 144 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);
 145 #endif // 0
 146 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);
 147 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);
 148 #if 0 /// UNNEEDED by elogind
 149 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);
 150 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);
 151 #endif // 0
 152
 153 #define DEFINE_CONFIG_PARSE_ENUM(function,name,type,msg)                \
 154         int function(const char *unit,                                  \
 155                      const char *filename,                              \
 156                      unsigned line,                                     \
 157                      const char *section,                               \
 158                      unsigned section_line,                             \
 159                      const char *lvalue,                                \
 160                      int ltype,                                         \
 161                      const char *rvalue,                                \
 162                      void *data,                                        \
 163                      void *userdata) {                                  \
 164                                                                         \
 165                 type *i = data, x;                                      \
 166                                                                         \
 167                 assert(filename);                                       \
 168                 assert(lvalue);                                         \
 169                 assert(rvalue);                                         \
 170                 assert(data);                                           \
 171                                                                         \
 172                 if ((x = name##_from_string(rvalue)) < 0) {             \
 173                         log_syntax(unit, LOG_ERR, filename, line, -x,   \
 174                                    msg ", ignoring: %s", rvalue);       \
 175                         return 0;                                       \
 176                 }                                                       \
 177                                                                         \
 178                 *i = x;                                                 \
 179                 return 0;                                               \
 180         }
 181
 182 #define DEFINE_CONFIG_PARSE_ENUMV(function,name,type,invalid,msg)              \
 183         int function(const char *unit,                                         \
 184                      const char *filename,                                     \
 185                      unsigned line,                                            \
 186                      const char *section,                                      \
 187                      unsigned section_line,                                    \
 188                      const char *lvalue,                                       \
 189                      int ltype,                                                \
 190                      const char *rvalue,                                       \
 191                      void *data,                                               \
 192                      void *userdata) {                                         \
 193                                                                                \
 194                 type **enums = data, x, *ys;                                   \
 195                 _cleanup_free_ type *xs = NULL;                                \
 196                 const char *word, *state;                                      \
 197                 size_t l, i = 0;                                               \
 198                                                                                \
 199                 assert(filename);                                              \
 200                 assert(lvalue);                                                \
 201                 assert(rvalue);                                                \
 202                 assert(data);                                                  \
 203                                                                                \
 204                 xs = new0(type, 1);                                            \
 205                 if (!xs)                                                       \
 206                         return -ENOMEM;                                        \
 207                                                                                \
 208                 *xs = invalid;                                                 \
 209                                                                                \
 210                 FOREACH_WORD(word, l, rvalue, state) {                         \
 211                         _cleanup_free_ char *en = NULL;                        \
 212                         type *new_xs;                                          \
 213                                                                                \
 214                         en = strndup(word, l);                                 \
 215                         if (!en)                                               \
 216                                 return -ENOMEM;                                \
 217                                                                                \
 218                         if ((x = name##_from_string(en)) < 0) {                \
 219                                 log_syntax(unit, LOG_ERR, filename, line,      \
 220                                        -x, msg ", ignoring: %s", en);          \
 221                                 continue;                                      \
 222                         }                                                      \
 223                                                                                \
 224                         for (ys = xs; x != invalid && *ys != invalid; ys++) {  \
 225                                 if (*ys == x) {                                \
 226                                         log_syntax(unit, LOG_ERR, filename,    \
 227                                               line, -x,                        \
 228                                               "Duplicate entry, ignoring: %s", \
 229                                               en);                             \
 230                                         x = invalid;                           \
 231                                 }                                              \
 232                         }                                                      \
 233                                                                                \
 234                         if (x == invalid)                                      \
 235                                 continue;                                      \
 236                                                                                \
 237                         *(xs + i) = x;                                         \
 238                         new_xs = realloc(xs, (++i + 1) * sizeof(type));        \
 239                         if (new_xs)                                            \
 240                                 xs = new_xs;                                   \
 241                         else                                                   \
 242                                 return -ENOMEM;                                \
 243                                                                                \
 244                         *(xs + i) = invalid;                                   \
 245                 }                                                              \
 246                                                                                \
 247                 free(*enums);                                                  \
 248                 *enums = xs;                                                   \
 249                 xs = NULL;                                                     \
 250                                                                                \
 251                 return 0;                                                      \
 252         }