1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
|
/* Copyright (C) 2021 CZ.NIC, z.s.p.o. <knot-dns@labs.nic.cz>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
#pragma once
#include "libknot/libknot.h"
#include "libknot/yparser/ypschema.h"
#include "contrib/qp-trie/trie.h"
#include "contrib/ucw/lists.h"
#include "contrib/dynarray.h"
#include "knot/include/module.h"
/*! Default template identifier. */
#define CONF_DEFAULT_ID ((uint8_t *)"\x08""default\0")
/*! Default configuration file. */
#define CONF_DEFAULT_FILE (CONFIG_DIR "/knot.conf")
/*! Default configuration database. */
#define CONF_DEFAULT_DBDIR (STORAGE_DIR "/confdb")
/*! Maximum depth of nested transactions. */
#define CONF_MAX_TXN_DEPTH 5
/*! Maximum number of concurrent DB readers. */
#define CONF_MAX_DB_READERS 630
/*! Configuration specific logging. */
#define CONF_LOG(severity, msg, ...) do { \
log_fmt(severity, LOG_SOURCE_SERVER, "config, " msg, ##__VA_ARGS__); \
} while (0)
#define CONF_LOG_ZONE(severity, zone, msg, ...) do { \
log_fmt_zone(severity, LOG_SOURCE_ZONE, zone, NULL, "config, " msg, ##__VA_ARGS__); \
} while (0)
/*! Configuration getter output. */
typedef struct {
/*! Item description. */
const yp_item_t *item;
/*! Whole data (can be array). */
const uint8_t *blob;
/*! Whole data length. */
size_t blob_len;
// Public items.
/*! Current single data. */
const uint8_t *data;
/*! Current single data length. */
size_t len;
/*! Value getter return code. */
int code;
} conf_val_t;
/*! Query module context. */
typedef struct {
/*! Module interface. */
const knotd_mod_api_t *api;
/*! Shared library dlopen handler. */
void *lib_handle;
/*! Indication of a temporary module created during confio check. */
bool temporary;
} module_t;
dynarray_declare(mod, module_t *, DYNARRAY_VISIBILITY_PUBLIC, 16)
dynarray_declare(old_schema, yp_item_t *, DYNARRAY_VISIBILITY_PUBLIC, 16)
struct knot_catalog;
/*! Configuration context. */
typedef struct {
/*! Cloned configuration indicator. */
bool is_clone;
/*! Currently used namedb api. */
const struct knot_db_api *api;
/*! Configuration schema. */
yp_item_t *schema;
/*! Configuration database. */
knot_db_t *db;
/*! Read-only transaction for config access. */
knot_db_txn_t read_txn;
struct {
/*! The current writing transaction. */
knot_db_txn_t *txn;
/*! Stack of nested writing transactions. */
knot_db_txn_t txn_stack[CONF_MAX_TXN_DEPTH];
/*! Master transaction flags. */
yp_flag_t flags;
/*! Changed zones. */
trie_t *zones;
} io;
/*! Current config file (for reload if started with config file). */
char *filename;
/*! Prearranged hostname string (for automatic NSID or CH ident value). */
char *hostname;
/*! Cached critical confdb items. */
struct {
uint16_t srv_udp_max_payload_ipv4;
uint16_t srv_udp_max_payload_ipv6;
int srv_tcp_idle_timeout;
int srv_tcp_io_timeout;
int srv_tcp_remote_io_timeout;
bool srv_tcp_reuseport;
bool srv_socket_affinity;
size_t srv_udp_threads;
size_t srv_tcp_threads;
size_t srv_xdp_threads;
size_t srv_bg_threads;
size_t srv_tcp_max_clients;
int ctl_timeout;
conf_val_t srv_nsid;
bool srv_ecs;
bool srv_ans_rotate;
} cache;
/*! List of dynamically loaded modules. */
mod_dynarray_t modules;
/*! List of old schemas (lazy freed). */
old_schema_dynarray_t old_schemas;
/*! List of active query modules. */
list_t *query_modules;
/*! Default query modules plan. */
struct query_plan *query_plan;
/*! Zone catalog database. */
struct catalog *catalog;
} conf_t;
/*!
* Configuration access flags.
*/
typedef enum {
CONF_FNONE = 0, /*!< Empty flag. */
CONF_FREADONLY = 1 << 0, /*!< Read only access. */
CONF_FNOCHECK = 1 << 1, /*!< Disabled confdb check. */
CONF_FNOHOSTNAME = 1 << 2, /*!< Don't set the hostname. */
CONF_FREQMODULES = 1 << 3, /*!< Load module schemas (must succeed). */
CONF_FOPTMODULES = 1 << 4, /*!< Load module schemas (may fail). */
} conf_flag_t;
/*!
* Configuration update flags.
*/
typedef enum {
CONF_UPD_FNONE = 0, /*!< Empty flag. */
CONF_UPD_FNOFREE = 1 << 0, /*!< Disable auto-free of previous config. */
CONF_UPD_FMODULES = 1 << 1, /*!< Reuse previous global modules. */
CONF_UPD_FCONFIO = 1 << 2, /*!< Reuse previous confio reload context. */
} conf_update_flag_t;
/*!
* Returns the active configuration.
*/
conf_t* conf(void);
/*!
* Refreshes common read-only transaction.
*
* \param[in] conf Configuration.
*
* \return Error code, KNOT_EOK if success.
*/
int conf_refresh_txn(
conf_t *conf
);
/*!
* Refreshes cached hostname.
*
* \param[in] conf Configuration.
*/
void conf_refresh_hostname(
conf_t *conf
);
/*!
* Creates new or opens old configuration database.
*
* \param[out] conf Configuration.
* \param[in] schema Configuration schema.
* \param[in] db_dir Database path or NULL.
* \param[in] max_conf_size Maximum configuration DB size in bytes (LMDB mapsize).
* \param[in] flags Access flags.
*
* \return Error code, KNOT_EOK if success.
*/
int conf_new(
conf_t **conf,
const yp_item_t *schema,
const char *db_dir,
size_t max_conf_size,
conf_flag_t flags
);
/*!
* Creates a partial copy of the active configuration.
*
* Shared objects: api, mm, db, filename.
*
* \param[out] conf Configuration.
*
* \return Error code, KNOT_EOK if success.
*/
int conf_clone(
conf_t **conf
);
/*!
* Replaces the active configuration with the specified one.
*
* \param[in] conf New configuration.
* \param[in] flags Update flags.
*
* \return Previous config if CONF_UPD_FNOFREE, else NULL.
*/
conf_t *conf_update(
conf_t *conf,
conf_update_flag_t flags
);
/*!
* Removes the specified configuration.
*
* \param[in] conf Configuration.
*/
void conf_free(
conf_t *conf
);
/*!
* Parses textual configuration from the string or from the file.
*
* This function is not for direct using, just for includes processing!
*
* \param[in] conf Configuration.
* \param[in] txn Transaction.
* \param[in] input Configuration string or filename.
* \param[in] is_file Specifies if the input is string or input filename.
*
* \return Error code, KNOT_EOK if success.
*/
int conf_parse(
conf_t *conf,
knot_db_txn_t *txn,
const char *input,
bool is_file
);
/*!
* Imports textual configuration.
*
* \param[in] conf Configuration.
* \param[in] input Configuration string or input filename.
* \param[in] is_file Specifies if the input is string or filename.
* \param[in] reinit_cache Indication if cache reinitialization needed.
*
* \return Error code, KNOT_EOK if success.
*/
int conf_import(
conf_t *conf,
const char *input,
bool is_file,
bool reinit_cache
);
/*!
* Exports configuration to textual file.
*
* \param[in] conf Configuration.
* \param[in] file_name Output filename (stdout is used if NULL).
* \param[in] style Formatting style.
*
* \return Error code, KNOT_EOK if success.
*/
int conf_export(
conf_t *conf,
const char *file_name,
yp_style_t style
);
|
