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
|
/*!
* \file zone.h
*
* \author Lubos Slovak <lubos.slovak@nic.cz>
*
* \brief Zone structure and API for manipulating it.
*
* \addtogroup libknot
* @{
*/
/* Copyright (C) 2011 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_ZONE_H_
#define _KNOT_ZONE_H_
#include <time.h>
#include "libknot/zone/node.h"
#include "libknot/dname.h"
#include "libknot/dnssec/nsec3.h"
#include "common/ref.h"
#include "libknot/zone/zone-tree.h"
#include "libknot/zone/zone-contents.h"
/*----------------------------------------------------------------------------*/
/*!
* \brief Return values for search functions.
*
* Used in knot_zone_find_dname() and knot_zone_find_dname_hash().
*/
enum knot_zone_retvals {
KNOT_ZONE_NAME_FOUND = 1,
KNOT_ZONE_NAME_NOT_FOUND = 0
};
typedef enum knot_zone_retvals knot_zone_retvals_t;
/*!
* \brief Zone flags.
*/
typedef enum knot_zone_flag_t {
KNOT_ZONE_SLAVE = 0 << 0, /*! Slave zone */
KNOT_ZONE_MASTER = 1 << 0, /*! Master zone. */
KNOT_ZONE_DISCARDED = 1 << 1, /*! Zone waiting to be discarded. */
KNOT_ZONE_UPDATED = 1 << 2, /*! Zone is updated in this cycle. */
KNOT_ZONE_OBSOLETE = 1 << 3 /*! Zone is obsolete (forces retransfer). */
} knot_zone_flag_t;
/*----------------------------------------------------------------------------*/
/*!
* \brief Structure for holding DNS zone.
*
* \warning Make sure not to insert the same nodes using both the normal and
* NSEC3 functions. Although this will be successfull, it will produce
* double-free errors when destroying the zone.
*/
struct knot_zone {
ref_t ref; /*!< Reference counting. */
knot_dname_t *name;
knot_zone_contents_t *contents;
time_t version;
unsigned flags;
void *data; /*!< Pointer to generic zone-related data. */
int (*dtor)(struct knot_zone *); /*!< Data destructor. */
};
typedef struct knot_zone knot_zone_t;
/*----------------------------------------------------------------------------*/
/*!
* \brief Creates new empty DNS zone.
*
* \note Zone will be created without contents.
*
* \param name Zone owner.
*
* \return The initialized zone structure or NULL if an error occured.
*/
knot_zone_t *knot_zone_new_empty(knot_dname_t *name);
/*!
* \brief Creates new DNS zone.
*
* \param apex Node representing the zone apex.
*
* \return The initialized zone structure or NULL if an error occured.
*/
knot_zone_t *knot_zone_new(knot_node_t *apex);
knot_zone_contents_t *knot_zone_get_contents(
const knot_zone_t *zone);
const knot_zone_contents_t *knot_zone_contents(
const knot_zone_t *zone);
time_t knot_zone_version(const knot_zone_t *zone);
void knot_zone_set_version(knot_zone_t *zone, time_t version);
short knot_zone_is_master(const knot_zone_t *zone);
void knot_zone_set_master(knot_zone_t *zone, short master);
const void *knot_zone_data(const knot_zone_t *zone);
void knot_zone_set_data(knot_zone_t *zone, void *data);
const knot_dname_t *knot_zone_name(const knot_zone_t *zone);
knot_zone_contents_t *knot_zone_switch_contents(knot_zone_t *zone,
knot_zone_contents_t *new_contents);
/*!
* \brief Correctly deallocates the zone structure, without deleting its nodes.
*
* Also sets the given pointer to NULL.
*
* \param zone Zone to be freed.
*/
void knot_zone_free(knot_zone_t **zone);
/*!
* \brief Correctly deallocates the zone structure and all nodes within.
*
* Also sets the given pointer to NULL.
*
* \param zone Zone to be freed.
*/
void knot_zone_deep_free(knot_zone_t **zone);
/*!
* \brief Set destructor and initialize reference counter to 1.
*
* \param zone Related zone.
* \param dtor Destructor.
*/
void knot_zone_set_dtor(knot_zone_t *zone, int (*dtor)(struct knot_zone *));
/*!
* \brief Increment reference counter for dname.
*
* \param zone Referenced zone.
*/
static inline void knot_zone_retain(knot_zone_t *zone) {
if (zone != NULL) {
ref_retain(&zone->ref);
}
}
/*!
* \brief Decrement reference counter for dname.
*
* \param zone Referenced zone.
*/
static inline void knot_zone_release(knot_zone_t *zone) {
if (zone != NULL) {
ref_release(&zone->ref);
}
}
/*!
* \brief Return zone flags.
*
* \param zone Zone.
*/
static inline unsigned knot_zone_flags(knot_zone_t *zone) {
if (zone) {
return zone->flags;
} else {
return 0;
}
}
/*!
* \brief Set zone flag.
*
* \param zone Zone.
* \param flag Respected flag.
* \param on 1 to set, 0 to unset flag.
*/
void knot_zone_set_flag(knot_zone_t *zone, knot_zone_flag_t flag, unsigned on);
#endif
/*! @} */
|
