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 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
 103 /* Generic parsers */
 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_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);
 108 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);
 109 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);
 110 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);
 111 #if 0 /// UNNEEDED by elogind
 112 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);
 113 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);
 114 #endif // 0
 115 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);
 116 #if 0 /// UNNEEDED by elogind
 117 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);
 118 #endif // 0
 119 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);
 120 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);
 121 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);
 122 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);
 123 #if 0 /// UNNEEDED by elogind
 124 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);
 125 #endif // 0
 126 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);
 127 #if 0 /// UNNEEDED by elogind
 128 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);
 129 #endif // 0
 130 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);
 131 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);
 132 #if 0 /// UNNEEDED by elogind
 133 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);
 134 #endif // 0
 135
 136 #define DEFINE_CONFIG_PARSE_ENUM(function,name,type,msg)                \
 137         int function(const char *unit,                                  \
 138                      const char *filename,                              \
 139                      unsigned line,                                     \
 140                      const char *section,                               \
 141                      unsigned section_line,                             \
 142                      const char *lvalue,                                \
 143                      int ltype,                                         \
 144                      const char *rvalue,                                \
 145                      void *data,                                        \
 146                      void *userdata) {                                  \
 147                                                                         \
 148                 type *i = data, x;                                      \
 149                                                                         \
 150                 assert(filename);                                       \
 151                 assert(lvalue);                                         \
 152                 assert(rvalue);                                         \
 153                 assert(data);                                           \
 154                                                                         \
 155                 if ((x = name##_from_string(rvalue)) < 0) {             \
 156                         log_syntax(unit, LOG_ERR, filename, line, -x,   \
 157                                    msg ", ignoring: %s", rvalue);       \
 158                         return 0;                                       \
 159                 }                                                       \
 160                                                                         \
 161                 *i = x;                                                 \
 162                 return 0;                                               \
 163         }
 164
 165 #define DEFINE_CONFIG_PARSE_ENUMV(function,name,type,invalid,msg)              \
 166         int function(const char *unit,                                         \
 167                      const char *filename,                                     \
 168                      unsigned line,                                            \
 169                      const char *section,                                      \
 170                      unsigned section_line,                                    \
 171                      const char *lvalue,                                       \
 172                      int ltype,                                                \
 173                      const char *rvalue,                                       \
 174                      void *data,                                               \
 175                      void *userdata) {                                         \
 176                                                                                \
 177                 type **enums = data, x, *ys;                                   \
 178                 _cleanup_free_ type *xs = NULL;                                \
 179                 const char *word, *state;                                      \
 180                 size_t l, i = 0;                                               \
 181                                                                                \
 182                 assert(filename);                                              \
 183                 assert(lvalue);                                                \
 184                 assert(rvalue);                                                \
 185                 assert(data);                                                  \
 186                                                                                \
 187                 xs = new0(type, 1);                                            \
 188                 if(!xs)                                                        \
 189                         return -ENOMEM;                                        \
 190                                                                                \
 191                 *xs = invalid;                                                 \
 192                                                                                \
 193                 FOREACH_WORD(word, l, rvalue, state) {                         \
 194                         _cleanup_free_ char *en = NULL;                        \
 195                         type *new_xs;                                          \
 196                                                                                \
 197                         en = strndup(word, l);                                 \
 198                         if (!en)                                               \
 199                                 return -ENOMEM;                                \
 200                                                                                \
 201                         if ((x = name##_from_string(en)) < 0) {                \
 202                                 log_syntax(unit, LOG_ERR, filename, line,      \
 203                                        -x, msg ", ignoring: %s", en);          \
 204                                 continue;                                      \
 205                         }                                                      \
 206                                                                                \
 207                         for (ys = xs; x != invalid && *ys != invalid; ys++) {  \
 208                                 if (*ys == x) {                                \
 209                                         log_syntax(unit, LOG_ERR, filename,    \
 210                                               line, -x,                        \
 211                                               "Duplicate entry, ignoring: %s", \
 212                                               en);                             \
 213                                         x = invalid;                           \
 214                                 }                                              \
 215                         }                                                      \
 216                                                                                \
 217                         if (x == invalid)                                      \
 218                                 continue;                                      \
 219                                                                                \
 220                         *(xs + i) = x;                                         \
 221                         new_xs = realloc(xs, (++i + 1) * sizeof(type));        \
 222                         if (new_xs)                                            \
 223                                 xs = new_xs;                                   \
 224                         else                                                   \
 225                                 return -ENOMEM;                                \
 226                                                                                \
 227                         *(xs + i) = invalid;                                   \
 228                 }                                                              \
 229                                                                                \
 230                 free(*enums);                                                  \
 231                 *enums = xs;                                                   \
 232                 xs = NULL;                                                     \
 233                                                                                \
 234                 return 0;                                                      \
 235         }