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 // UNNEEDED 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);
 112 // UNNEEDED 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);
 113 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);
 114 // UNNEEDED 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);
 115 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);
 116 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);
 117 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);
 118 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);
 119 // UNNEEDED 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);
 120 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);
 121 // UNNEEDED 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);
 122 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);
 123 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);
 124 // UNNEEDED 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);
 125
 126 #define DEFINE_CONFIG_PARSE_ENUM(function,name,type,msg)                \
 127         int function(const char *unit,                                  \
 128                      const char *filename,                              \
 129                      unsigned line,                                     \
 130                      const char *section,                               \
 131                      unsigned section_line,                             \
 132                      const char *lvalue,                                \
 133                      int ltype,                                         \
 134                      const char *rvalue,                                \
 135                      void *data,                                        \
 136                      void *userdata) {                                  \
 137                                                                         \
 138                 type *i = data, x;                                      \
 139                                                                         \
 140                 assert(filename);                                       \
 141                 assert(lvalue);                                         \
 142                 assert(rvalue);                                         \
 143                 assert(data);                                           \
 144                                                                         \
 145                 if ((x = name##_from_string(rvalue)) < 0) {             \
 146                         log_syntax(unit, LOG_ERR, filename, line, -x,   \
 147                                    msg ", ignoring: %s", rvalue);       \
 148                         return 0;                                       \
 149                 }                                                       \
 150                                                                         \
 151                 *i = x;                                                 \
 152                 return 0;                                               \
 153         }
 154
 155 #define DEFINE_CONFIG_PARSE_ENUMV(function,name,type,invalid,msg)              \
 156         int function(const char *unit,                                         \
 157                      const char *filename,                                     \
 158                      unsigned line,                                            \
 159                      const char *section,                                      \
 160                      unsigned section_line,                                    \
 161                      const char *lvalue,                                       \
 162                      int ltype,                                                \
 163                      const char *rvalue,                                       \
 164                      void *data,                                               \
 165                      void *userdata) {                                         \
 166                                                                                \
 167                 type **enums = data, x, *ys;                                   \
 168                 _cleanup_free_ type *xs = NULL;                                \
 169                 const char *word, *state;                                      \
 170                 size_t l, i = 0;                                               \
 171                                                                                \
 172                 assert(filename);                                              \
 173                 assert(lvalue);                                                \
 174                 assert(rvalue);                                                \
 175                 assert(data);                                                  \
 176                                                                                \
 177                 xs = new0(type, 1);                                            \
 178                 if(!xs)                                                        \
 179                         return -ENOMEM;                                        \
 180                                                                                \
 181                 *xs = invalid;                                                 \
 182                                                                                \
 183                 FOREACH_WORD(word, l, rvalue, state) {                         \
 184                         _cleanup_free_ char *en = NULL;                        \
 185                         type *new_xs;                                          \
 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                         new_xs = realloc(xs, (++i + 1) * sizeof(type));        \
 212                         if (new_xs)                                            \
 213                                 xs = new_xs;                                   \
 214                         else                                                   \
 215                                 return -ENOMEM;                                \
 216                                                                                \
 217                         *(xs + i) = invalid;                                   \
 218                 }                                                              \
 219                                                                                \
 220                 free(*enums);                                                  \
 221                 *enums = xs;                                                   \
 222                 xs = NULL;                                                     \
 223                                                                                \
 224                 return 0;                                                      \
 225         }