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
|
/*!
* \file changesets.h
*
* \author Lubos Slovak <lubos.slovak@nic.cz>, Jan Kadlec <jan.kadlec@nic.cz>
*
* \brief Structure for representing IXFR/DDNS changeset and its API.
*
* \addtogroup xfr
* @{
*/
/* Copyright (C) 2013 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 <http://www.gnu.org/licenses/>.
*/
#ifndef _KNOT_CHANGESETS_H_
#define _KNOT_CHANGESETS_H_
#include "libknot/rrset.h"
#include "libknot/zone/node.h"
#include "common/lists.h"
#include "common/mempattern.h"
/*----------------------------------------------------------------------------*/
/*! \brief Changeset flags, stored as first 4 bytes in serialized changeset. */
typedef enum {
KNOT_CHANGESET_TYPE_IXFR = 1 << 0,
KNOT_CHANGESET_TYPE_DDNS = 1 << 1,
KNOT_CHANGESET_TYPE_DNSSEC = 1 << 2
} knot_changeset_flag_t;
/*! \brief One changeset received from wire, with parsed RRs. */
typedef struct knot_changeset {
node_t n; /*!< List node. */
mm_ctx_t mem_ctx; /*!< Memory context */
knot_rrset_t *soa_from; /*!< Start SOA. */
list_t remove; /*!< List of RRs to remove. */
knot_rrset_t *soa_to; /*!< Destination SOA. */
list_t add; /*!< List of RRs to add. */
uint8_t *data; /*!< Serialized changeset. */
size_t size; /*!< Size of serialized changeset. */
uint32_t serial_from; /*!< SOA start serial. */
uint32_t serial_to; /*!< SOA destination serial. */
uint32_t flags; /*!< DDNS / IXFR flags. */
} knot_changeset_t;
/*----------------------------------------------------------------------------*/
/*! \brief Wrapper for BIRD lists. Storing: RRSet. */
typedef struct knot_rr_ln {
node_t n; /*!< List node. */
knot_rrset_t *rr; /*!< Actual usable data. */
} knot_rr_ln_t;
/*! \brief Partial changes done to zones - used for update/transfer rollback. */
typedef struct {
/*!
* Memory context. Ideally a pool allocator since there is a possibility
* of many changes in one transfer/update.
*/
mm_ctx_t mem_ctx;
/*!
* Deleted after successful update.
*/
list_t old_rrsets;
/*!
* Deleted after failed update.
*/
list_t new_rrsets;
} knot_changes_t;
/*----------------------------------------------------------------------------*/
/*!
* \brief Changeset structure (changes recieved by slave server between two
* serial numbers.
*/
typedef struct {
mm_ctx_t mmc_chs; /*!< Memory context for creating changesets */
mm_ctx_t mmc_rr; /*!< Memory context for creating RRs in changesets */
list_t sets; /*!< List of changesets. */
size_t count; /*!< Changeset count. */
knot_rrset_t *first_soa; /*!< First received SOA. */
uint32_t flags; /*!< DDNS / IXFR flags. */
knot_changes_t *changes; /*!< Partial changes. */
} knot_changesets_t;
/*----------------------------------------------------------------------------*/
typedef enum {
KNOT_CHANGESET_ADD,
KNOT_CHANGESET_REMOVE
} knot_changeset_part_t;
typedef enum {
KNOT_CHANGES_OLD,
KNOT_CHANGES_NEW,
} knot_changes_part_t;
/*----------------------------------------------------------------------------*/
/*!
* \brief Inits changesets structure. The structure has to be freed
* using 'knot_changesets_free()' function.
*
* \param changesets Double pointer to changesets structure.
* \param flags IXFR / DDNS flag.
*
* \retval KNOT_EOK on success.
* \retval Error code on failure.
*/
int knot_changesets_init(knot_changesets_t **changesets);
/*!
* \brief Creates changesets structure. The created structure has to be freed
* using 'knot_changesets_free()' function.
*
* \param flags IXFR / DDNS flag.
*
* \retval Created structure on success.
* \retval NULL on failure.
*/
knot_changesets_t *knot_changesets_create();
/*!
* \brief Creates new changeset structure and returns it to caller.
* The structure is also connected to a list of changesets.
*
* \param ch Changesets structure to create a new changeset in.
*
* \retval Created structure on success.
* \retval NULL on failure.
*/
knot_changeset_t *knot_changesets_create_changeset(knot_changesets_t *ch);
/*!
* \brief Gets last changesets from from structure's list.
*
* \param ch Changesets structure to get a last changeset from.
*
* \retval Last changeset on success.
* \retval NULL on failure.
*/
knot_changeset_t *knot_changesets_get_last(const knot_changesets_t *ch);
const knot_rrset_t *knot_changeset_last_rr(const knot_changeset_t *ch,
knot_changeset_part_t part);
void knot_changeset_remove_last_rr(knot_changeset_t *ch,
knot_changeset_part_t part);
/*!
* \brief Add RRSet to changeset. RRSet is either inserted to 'add' or to
* 'remove' list. Will *not* try to merge with previous RRSets.
*
* \param chgs Changeset to add RRSet into.
* \param rrset RRSet to be added.
* \param part Add to 'add' or 'remove'?
*
* \retval KNOT_EOK on success.
* \retval Error code on failure.
*/
int knot_changeset_add_rrset(knot_changeset_t *chgs,
knot_rrset_t *rrset, knot_changeset_part_t part);
/*!
* \brief Add RRSet to changeset. RRSet is either inserted to 'add' or to
* 'remove' list. *Will* try to merge with previous RRSets.
*
* \param chgs Changeset to add RRSet into.
* \param rrset RRSet to be added.
* \param part Add to 'add' or 'remove'?
*
* \retval KNOT_EOK on success.
* \retval Error code on failure.
*/
int knot_changeset_add_rr(knot_changeset_t *chgs,
knot_rrset_t *rrset, knot_changeset_part_t part);
/*!
* \brief Adds a source/destination SOA RRSet to changeset.
*
* \param changeset Changeset to store SOA to.
* \param soa SOA RRSet to be stored to changeset.
* \param part To which part we store SOA (from = REMOVE, add = TO)
*/
void knot_changeset_add_soa(knot_changeset_t *changeset, knot_rrset_t *soa,
knot_changeset_part_t part);
/*!
* \brief Checks whether changeset is empty.
*
* \param changeset Changeset to be checked.
*
* Changeset is considered empty if it has no RRs in REMOVE and ADD sections and
* final SOA (soa_to) is not set.
*
* \retval true if changeset is empty.
* \retval false if changeset is not empty.
*/
bool knot_changeset_is_empty(const knot_changeset_t *changeset);
/*!
* \brief Get number of changes (additions and removals) in the changeset.
*
* \param changeset Changeset to be checked.
*
* \return Number of changes in the changeset.
*/
size_t knot_changeset_size(const knot_changeset_t *changeset);
/*!
* \brief Apply given function to all RRSets in one part of the changeset.
*
* \param changeset Changeset to apply the function to.
* \param part Part of changeset to apply the function to.
* \param func Function to apply to RRSets in the changeset. It is required that
* the function returns KNOT_EOK on success.
* \param data Data to pass to the applied function.
*
* If the applied function fails, the application aborts and this function
* returns the return value of the applied function.
*
* \retval KNOT_EOK if OK
* \retval KNOT_EINVAL if \a changeset or \a func is NULL.
* \retval Other error code if the applied function failed.
*/
int knot_changeset_apply(knot_changeset_t *changeset,
knot_changeset_part_t part,
int (*func)(knot_rrset_t *, void *), void *data);
/*!
* \brief Frees the 'changesets' structure, including all its internal data.
*
* \param changesets Double pointer to changesets structure to be freed.
*/
void knot_changesets_free(knot_changesets_t **changesets);
/*!
* \brief Add RRSet to changes structure.
* RRSet is either inserted to 'old' or to 'new' list.
*
* \param chgs Change to add RRSet into.
* \param rrset RRSet to be added.
* \param part Add to 'old' or 'new'?
*
* \retval KNOT_EOK on success.
* \retval Error code on failure.
*/
int knot_changes_add_rrset(knot_changes_t *ch, knot_rrset_t *rrset,
knot_changes_part_t part);
/*!
* \brief Merges two changesets together, second changeset's lists are kept.
*
* \param ch1 Changeset to merge into
* \param ch2 Changeset to merge
*
* Beginning SOA is used from the first changeset, ending SOA from the second.
* Ending SOA from first changeset is deleted. SOAs in the second changeset are
* left untouched.
*
* \retval KNOT_EOK on success.
* \retval Error code on failure.
*/
int knot_changeset_merge(knot_changeset_t *ch1, knot_changeset_t *ch2);
/*!
* \param changes Double pointer of changes structure to be freed.
*/
void knot_changes_free(knot_changes_t **changes);
#endif /* _KNOT_CHANGESETS_H_ */
/*! @} */
|
