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
|
/* Copyright (C) 2020 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 "contrib/semaphore.h"
#include "knot/conf/conf.h"
#include "knot/conf/confio.h"
#include "knot/journal/journal_basic.h"
#include "knot/events/events.h"
#include "knot/updates/changesets.h"
#include "knot/zone/catalog.h"
#include "knot/zone/contents.h"
#include "knot/zone/timers.h"
#include "libknot/dname.h"
#include "libknot/packet/pkt.h"
struct zone_update;
struct zone_backup_ctx;
/*!
* \brief Zone flags.
*/
typedef enum {
ZONE_FORCE_AXFR = 1 << 0, /*!< Force AXFR as next transfer. */
ZONE_FORCE_RESIGN = 1 << 1, /*!< Force zone re-sign. */
ZONE_FORCE_FLUSH = 1 << 2, /*!< Force zone flush. */
ZONE_FORCE_KSK_ROLL = 1 << 3, /*!< Force KSK/CSK rollover. */
ZONE_FORCE_ZSK_ROLL = 1 << 4, /*!< Force ZSK rollover. */
ZONE_IS_CATALOG = 1 << 5, /*!< This is a catalog. */
ZONE_IS_CAT_MEMBER = 1 << 6, /*!< This zone exists according to a catalog. */
} zone_flag_t;
/*!
* \brief Structure for holding DNS zone.
*/
typedef struct zone
{
knot_dname_t *name;
zone_contents_t *contents;
zone_flag_t flags;
bool is_catalog_flag; //!< Lock-less indication of ZONE_IS_CATALOG flag.
/*! \brief Dynamic configuration zone change type. */
conf_io_type_t change_type;
/*! \brief Zonefile parameters. */
struct {
struct timespec mtime;
uint32_t serial;
bool exists;
bool resigned;
bool retransfer;
} zonefile;
/*! \brief Zone events. */
zone_timers_t timers; //!< Persistent zone timers.
zone_events_t events; //!< Zone events timers.
/*! \brief DDNS queue and lock. */
pthread_mutex_t ddns_lock;
size_t ddns_queue_size;
list_t ddns_queue;
/*! \brief Control update context. */
struct zone_update *control_update;
/*! \brief Ensue one COW tramsaction on zone's trees at a time. */
knot_sem_t cow_lock;
/*! \brief Ptr to journal DB (in struct server) */
knot_lmdb_db_t *journaldb;
/*! \brief Ptr to journal DB (in struct server) */
knot_lmdb_db_t *kaspdb;
/*! \brief Zone backup context (NULL unless backup pending). */
struct zone_backup_ctx *backup_ctx;
/*! \brief Ptr to catalog and ist changeset changes (in struct server) */
catalog_t *catalog;
catalog_update_t *catalog_upd;
/*! \brief Preferred master lock. Also used for flags access. */
pthread_mutex_t preferred_lock;
/*! \brief Preferred master for remote operation. */
struct sockaddr_storage *preferred_master;
/*! \brief Query modules. */
list_t query_modules;
struct query_plan *query_plan;
} zone_t;
/*!
* \brief Creates new zone with emtpy zone content.
*
* \param name Zone name.
*
* \return The initialized zone structure or NULL if an error occurred.
*/
zone_t* zone_new(const knot_dname_t *name);
/*!
* \brief Deallocates the zone structure.
*
* \note The function also deallocates all bound structures (contents, etc.).
*
* \param zone_ptr Zone to be freed.
*/
void zone_free(zone_t **zone_ptr);
/*!
* \brief Clear zone contents (->SERVFAIL), reset modules, plan LOAD.
*
* \param conf Current configuration.
* \param zone Zone to be re-set.
*/
void zone_reset(conf_t *conf, zone_t *zone);
/*!
* \brief Clears possible control update transaction.
*
* \param zone Zone to be cleared.
*/
void zone_control_clear(zone_t *zone);
inline static zone_journal_t zone_journal(zone_t *zone)
{
zone_journal_t j = { zone->journaldb, zone->name };
return j;
}
int zone_change_store(conf_t *conf, zone_t *zone, changeset_t *change, changeset_t *extra);
int zone_changes_clear(conf_t *conf, zone_t *zone);
int zone_in_journal_store(conf_t *conf, zone_t *zone, zone_contents_t *new_contents);
/*! \brief Synchronize zone file with journal. */
int zone_flush_journal(conf_t *conf, zone_t *zone, bool verbose);
bool zone_journal_has_zij(zone_t *zone);
/*!
* \brief Atomically switch the content of the zone.
*/
zone_contents_t *zone_switch_contents(zone_t *zone, zone_contents_t *new_contents);
/*! \brief Checks if the zone is slave. */
bool zone_is_slave(conf_t *conf, const zone_t *zone);
/*! \brief Sets the address as a preferred master address. */
void zone_set_preferred_master(zone_t *zone, const struct sockaddr_storage *addr);
/*! \brief Clears the current preferred master address. */
void zone_clear_preferred_master(zone_t *zone);
/*! \brief Sets a zone flag. */
void zone_set_flag(zone_t *zone, zone_flag_t flag);
/*! \brief Returns if a flag is set (and optionally clears it). */
zone_flag_t zone_get_flag(zone_t *zone, zone_flag_t flag, bool clear);
/*! \brief Get zone SOA RR. */
const knot_rdataset_t *zone_soa(const zone_t *zone);
/*! \brief Check if zone is expired according to timers. */
bool zone_expired(const zone_t *zone);
/*!
* \brief Set default timers for new zones or invalidate if not valid.
*/
void zone_timers_sanitize(conf_t *conf, zone_t *zone);
typedef int (*zone_master_cb)(conf_t *conf, zone_t *zone, const conf_remote_t *remote,
void *data);
/*!
* \brief Perform an action with a first working master server.
*
* The function iterates over available masters. For each master, the callback
* function is called. If the callback function succeeds (\ref KNOT_EOK is
* returned), the iteration is terminated.
*
* \return Error code from the last callback.
*/
int zone_master_try(conf_t *conf, zone_t *zone, zone_master_cb callback,
void *callback_data, const char *err_str);
/*! \brief Write zone contents to zonefile, but into different directory. */
int zone_dump_to_dir(conf_t *conf, zone_t *zone, const char *dir);
int zone_set_master_serial(zone_t *zone, uint32_t serial);
int zone_get_master_serial(zone_t *zone, uint32_t *serial);
int zone_set_lastsigned_serial(zone_t *zone, uint32_t serial);
int zone_get_lastsigned_serial(zone_t *zone, uint32_t *serial);
int slave_zone_serial(zone_t *zone, conf_t *conf, uint32_t *serial);
|
