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
|
/* Copyright (C) 2022 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 "knot/conf/conf.h"
/*! Configuration schema additional flags for dynamic changes. */
#define CONF_IO_FACTIVE YP_FUSR1 /*!< Active confio transaction indicator. */
#define CONF_IO_FZONE YP_FUSR2 /*!< Zone section indicator. */
#define CONF_IO_FREF YP_FUSR3 /*!< Possibly referenced id from a zone. */
#define CONF_IO_FDIFF_ZONES YP_FUSR4 /*!< All zones config has changed. */
#define CONF_IO_FCHECK_ZONES YP_FUSR5 /*!< All zones config needs to check. */
#define CONF_IO_FRLD_SRV YP_FUSR6 /*!< Reload server. */
#define CONF_IO_FRLD_LOG YP_FUSR7 /*!< Reload logging. */
#define CONF_IO_FRLD_MOD YP_FUSR8 /*!< Reload global modules. */
#define CONF_IO_FRLD_ZONE YP_FUSR9 /*!< Reload a specific zone. */
#define CONF_IO_FRLD_ZONES YP_FUSR10 /*!< Reload all zones. */
#define CONF_IO_FRLD_ALL (CONF_IO_FRLD_SRV | CONF_IO_FRLD_LOG | \
CONF_IO_FRLD_MOD | CONF_IO_FRLD_ZONES)
/*! Zone configuration change type. */
typedef enum {
CONF_IO_TNONE = 0, /*!< Unspecified. */
CONF_IO_TSET = 1 << 0, /*!< Zone added. */
CONF_IO_TUNSET = 1 << 1, /*!< Zone removed. */
CONF_IO_TCHANGE = 1 << 2, /*!< Zone has changed configuration. */
CONF_IO_TRELOAD = 1 << 3, /*!< Zone must be reloaded. */
} conf_io_type_t;
/*! Configuration interface output. */
typedef struct conf_io conf_io_t;
struct conf_io {
/*! Section. */
const yp_item_t *key0;
/*! Section item. */
const yp_item_t *key1;
/*! Section identifier. */
const uint8_t *id;
/*! Section identifier length. */
size_t id_len;
/*! Consider item identifier as item data. */
bool id_as_data;
enum {
/*! Default item state. */
NONE,
/*! New item indicator. */
NEW,
/*! Old item indicator. */
OLD
} type;
struct {
/*! Section item data (NULL if not used). */
conf_val_t *val;
/*! Index of data value to format (counted from 1, 0 means all). */
size_t index;
/*! Binary data value (NULL if not used). */
const uint8_t *bin;
/*! Length of the binary data value. */
size_t bin_len;
} data;
struct {
/*! Edit operation return code. */
int code;
/*! Edit operation return error message. */
const char *str;
} error;
/*! Optional processing callback. */
int (*fcn)(conf_io_t *);
/*! Miscellaneous data useful for the callback. */
void *misc;
};
inline static conf_io_type_t conf_io_trie_val(trie_it_t *it)
{
return (conf_io_type_t)(uintptr_t)(*trie_it_val(it));
}
/*!
* Starts new writing transaction.
*
* \param[in] child Nested transaction indicator.
*
* \return Error code, KNOT_EOK if success.
*/
int conf_io_begin(
bool child
);
/*!
* Commits the current writing transaction.
*
* \note Remember to call conf_refresh to publish the changes into the common
* configuration.
*
* \param[in] child Nested transaction indicator.
*
* \return Error code, KNOT_EOK if success.
*/
int conf_io_commit(
bool child
);
/*!
* Aborts the current writing transaction.
*
* \param[in] child Nested transaction indicator.
*/
void conf_io_abort(
bool child
);
/*!
* Gets the configuration sections list or section items list.
*
* \param[in] key0 Section name (NULL to get section list).
* \param[in] key1 Item name (non-NULL to get value list).
* \param[in] id Section identifier name if needed for value list.
* \param[in] list_schema List schema items or option values.
* \param[in] get_current The current configuration or the active transaction switch.
* \param[out] io Operation output.
*
* \return Error code, KNOT_EOK if success.
*/
int conf_io_list(
const char *key0,
const char *key1,
const char *id,
bool list_schema,
bool get_current,
conf_io_t *io
);
/*!
* Gets the configuration difference between the current configuration and
* the active transaction.
*
* \param[in] key0 Section name (NULL to diff all sections).
* \param[in] key1 Item name (NULL to diff all section items).
* \param[in] id Section identifier name (NULL to consider all section identifiers).
* \param[out] io Operation output.
*
* \return Error code, KNOT_EOK if success.
*/
int conf_io_diff(
const char *key0,
const char *key1,
const char *id,
conf_io_t *io
);
/*!
* Gets the configuration item(s) value(s).
*
* \param[in] key0 Section name (NULL to get all sections).
* \param[in] key1 Item name (NULL to get all section items).
* \param[in] id Section identifier name (NULL to consider all section identifiers).
* \param[in] get_current The current configuration or the active transaction switch.
* \param[out] io Operation output.
*
* \return Error code, KNOT_EOK if success.
*/
int conf_io_get(
const char *key0,
const char *key1,
const char *id,
bool get_current,
conf_io_t *io
);
/*!
* Sets the configuration item(s) value.
*
* \param[in] key0 Section name.
* \param[in] key1 Item name (NULL to add identifier only).
* \param[in] id Section identifier name (NULL to consider all section identifiers).
* \param[in] data Item data to set/add.
*
* \return Error code, KNOT_EOK if success.
*/
int conf_io_set(
const char *key0,
const char *key1,
const char *id,
const char *data
);
/*!
* Unsets the configuration item(s) value(s).
*
* \param[in] key0 Section name (NULL to unset all sections).
* \param[in] key1 Item name (NULL to unset the whole section).
* \param[in] id Section identifier name (NULL to consider all section identifiers).
* \param[in] data Item data (NULL to unset all data).
*
* \return Error code, KNOT_EOK if success.
*/
int conf_io_unset(
const char *key0,
const char *key1,
const char *id,
const char *data
);
/*!
* Checks the configuration database semantics in the current writing transaction.
*
* \param[out] io Operation output.
*
* \return Error code, KNOT_EOK if success.
*/
int conf_io_check(
conf_io_t *io
);
|
