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                                     const char *lvalue,
  38                                     int ltype,
  39                                     const char *rvalue,
  40                                     void *data,
  41                                     void *userdata);
  42
  43 /* Wraps information for parsing a specific configuration variable, to
  44  * be stored in a simple array */
  45 typedef struct ConfigTableItem {
  46         const char *section;            /* Section */
  47         const char *lvalue;             /* Name of the variable */
  48         ConfigParserCallback parse;     /* Function that is called to parse the variable's value */
  49         int ltype;                      /* Distinguish different variables passed to the same callback */
  50         void *data;                     /* Where to store the variable's data */
  51 } ConfigTableItem;
  52
  53 /* Wraps information for parsing a specific configuration variable, to
  54  * ve srored in a gperf perfect hashtable */
  55 typedef struct ConfigPerfItem {
  56         const char *section_and_lvalue; /* Section + "." + name of the variable */
  57         ConfigParserCallback parse;     /* Function that is called to parse the variable's value */
  58         int ltype;                      /* Distinguish different variables passed to the same callback */
  59         size_t offset;                  /* Offset where to store data, from the beginning of userdata */
  60 } ConfigPerfItem;
  61
  62 /* Prototype for a low-level gperf lookup function */
  63 typedef const ConfigPerfItem* (*ConfigPerfItemLookup)(const char *section_and_lvalue, unsigned length);
  64
  65 /* Prototype for a generic high-level lookup function */
  66 typedef int (*ConfigItemLookup)(
  67                 void *table,
  68                 const char *section,
  69                 const char *lvalue,
  70                 ConfigParserCallback *func,
  71                 int *ltype,
  72                 void **data,
  73                 void *userdata);
  74
  75 /* Linear table search implementation of ConfigItemLookup, based on
  76  * ConfigTableItem arrays */
  77 int config_item_table_lookup(void *table, const char *section, const char *lvalue, ConfigParserCallback *func, int *ltype, void **data, void *userdata);
  78
  79 /* gperf implementation of ConfigItemLookup, based on gperf
  80  * ConfigPerfItem tables */
  81 int config_item_perf_lookup(void *table, const char *section, const char *lvalue, ConfigParserCallback *func, int *ltype, void **data, void *userdata);
  82
  83 int config_parse(const char *unit,
  84                  const char *filename,
  85                  FILE *f,
  86                  const char *sections,  /* nulstr */
  87                  ConfigItemLookup lookup,
  88                  void *table,
  89                  bool relaxed,
  90                  bool allow_include,
  91                  void *userdata);
  92
  93 /* Generic parsers */
  94 int config_parse_int(const char *unit, const char *filename, unsigned line, const char *section, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
  95 int config_parse_unsigned(const char *unit, const char *filename, unsigned line, const char *section, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
  96 int config_parse_long(const char *unit, const char *filename, unsigned line, const char *section, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
  97 int config_parse_uint64(const char *unit, const char *filename, unsigned line, const char *section, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
  98 int config_parse_double(const char *unit, const char *filename, unsigned line, const char *section, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
  99 int config_parse_bytes_size(const char *unit, const char *filename, unsigned line, const char *section, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
 100 int config_parse_bytes_off(const char *unit, const char *filename, unsigned line, const char *section, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
 101 int config_parse_bool(const char *unit, const char *filename, unsigned line, const char *section, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
 102 int config_parse_tristate(const char *unit, const char *filename, unsigned line, const char *section, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
 103 int config_parse_string(const char *unit, const char *filename, unsigned line, const char *section, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
 104 int config_parse_path(const char *unit, const char *filename, unsigned line, const char *section, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
 105 int config_parse_strv(const char *unit, const char *filename, unsigned line, const char *section, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
 106 int config_parse_path_strv(const char *unit, const char *filename, unsigned line, const char *section, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
 107 int config_parse_sec(const char *unit, const char *filename, unsigned line, const char *section, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
 108 int config_parse_nsec(const char *unit, const char *filename, unsigned line, const char *section, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
 109 int config_parse_mode(const char *unit, const char *filename, unsigned line, const char *section, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
 110 int config_parse_facility(const char *unit, const char *filename, unsigned line, const char *section, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
 111 int config_parse_level(const char *unit, const char *filename, unsigned line, const char *section, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
 112 int config_parse_set_status(const char *unit, const char *filename, unsigned line, const char *section, 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 DEFINE_CONFIG_PARSE_ENUM(function,name,type,msg)                \
 126         int function(const char *unit,                                  \
 127                      const char *filename,                              \
 128                      unsigned line,                                     \
 129                      const char *section,                               \
 130                      const char *lvalue,                                \
 131                      int ltype,                                         \
 132                      const char *rvalue,                                \
 133                      void *data,                                        \
 134                      void *userdata) {                                  \
 135                                                                         \
 136                 type *i = data, x;                                      \
 137                                                                         \
 138                 assert(filename);                                       \
 139                 assert(lvalue);                                         \
 140                 assert(rvalue);                                         \
 141                 assert(data);                                           \
 142                                                                         \
 143                 if ((x = name##_from_string(rvalue)) < 0) {             \
 144                         log_syntax(unit, LOG_ERR, filename, line, -x,   \
 145                                    msg ", ignoring: %s", rvalue);       \
 146                         return 0;                                       \
 147                 }                                                       \
 148                                                                         \
 149                 *i = x;                                                 \
 150                 return 0;                                               \
 151         }
 152
 153 #define DEFINE_CONFIG_PARSE_ENUMV(function,name,type,invalid,msg)              \
 154         int function(const char *unit,                                         \
 155                      const char *filename,                                     \
 156                      unsigned line,                                            \
 157                      const char *section,                                      \
 158                      const char *lvalue,                                       \
 159                      int ltype,                                                \
 160                      const char *rvalue,                                       \
 161                      void *data,                                               \
 162                      void *userdata) {                                         \
 163                                                                                \
 164                 type **enums = data, *xs, x, *ys;                              \
 165                 char *w, *state;                                               \
 166                 size_t l, i = 0;                                               \
 167                                                                                \
 168                 assert(filename);                                              \
 169                 assert(lvalue);                                                \
 170                 assert(rvalue);                                                \
 171                 assert(data);                                                  \
 172                                                                                \
 173                 xs = new0(type, 1);                                            \
 174                 *xs = invalid;                                                 \
 175                                                                                \
 176                 FOREACH_WORD(w, l, rvalue, state) {                            \
 177                         _cleanup_free_ char *en = NULL;                        \
 178                                                                                \
 179                         en = strndup(w, l);                                    \
 180                         if (!en)                                               \
 181                                 return -ENOMEM;                                \
 182                                                                                \
 183                         if ((x = name##_from_string(en)) < 0) {                \
 184                                 log_syntax(unit, LOG_ERR, filename, line,      \
 185                                        -x, msg ", ignoring: %s", en);          \
 186                                 continue;                                      \
 187                         }                                                      \
 188                                                                                \
 189                         for (ys = xs; x != invalid && *ys != invalid; ys++) {  \
 190                                 if (*ys == x) {                                \
 191                                         log_syntax(unit, LOG_ERR, filename,    \
 192                                               line, -x,                        \
 193                                               "Duplicate entry, ignoring: %s", \
 194                                               en);                             \
 195                                         x = invalid;                           \
 196                                 }                                              \
 197                         }                                                      \
 198                                                                                \
 199                         if (x == invalid)                                      \
 200                                 continue;                                      \
 201                                                                                \
 202                         *(xs + i) = x;                                         \
 203                         xs = realloc(xs, ++i + 1);                             \
 204                         if (!xs)                                               \
 205                                 return -ENOMEM;                                \
 206                         *(xs + i) = invalid;                                   \
 207                 }                                                              \
 208                                                                                \
 209                 free(*enums);                                                  \
 210                 *enums = xs;                                                   \
 211                 return 0;                                                      \
 212         }