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
|
/* Copyright (C) 2019 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/>.
*/
/*!
* \file
*
* \brief Zone database represents a list of managed zones.
*/
#pragma once
#include "knot/zone/zone.h"
#include "libknot/dname.h"
#include "contrib/qp-trie/trie.h"
struct knot_zonedb {
trie_t *trie;
knot_mm_t mm;
};
/*
* Mapping of iterators to internal data structure.
*/
typedef trie_it_t knot_zonedb_iter_t;
#define knot_zonedb_iter_begin(db) trie_it_begin((db)->trie)
#define knot_zonedb_iter_finished(it) trie_it_finished(it)
#define knot_zonedb_iter_next(it) trie_it_next(it)
#define knot_zonedb_iter_free(it) trie_it_free(it)
#define knot_zonedb_iter_val(it) *trie_it_val(it)
/*
* Simple foreach() access with callback and variable number of callback params.
*/
#define knot_zonedb_foreach(db, callback, ...) \
{ \
knot_zonedb_iter_t *it = knot_zonedb_iter_begin((db)); \
while(!knot_zonedb_iter_finished(it)) { \
callback((zone_t *)knot_zonedb_iter_val(it), ##__VA_ARGS__); \
knot_zonedb_iter_next(it); \
} \
knot_zonedb_iter_free(it); \
}
/*!
* \brief Allocates and initializes the zone database structure.
*
* \return Pointer to the created zone database structure or NULL if an error
* occurred.
*/
knot_zonedb_t *knot_zonedb_new(void);
/*!
* \brief Adds new zone to the database.
*
* \param db Zone database to store the zone.
* \param zone Parsed zone.
*
* \retval KNOT_EOK
* \retval KNOT_EZONEIN
*/
int knot_zonedb_insert(knot_zonedb_t *db, zone_t *zone);
/*!
* \brief Removes the given zone from the database if it exists.
*
* \param db Zone database to remove from.
* \param zone_name Name of the zone to be removed.
*
* \retval KNOT_EOK
* \retval KNOT_ENOZONE
*/
int knot_zonedb_del(knot_zonedb_t *db, const knot_dname_t *zone_name);
/*!
* \brief Finds zone exactly matching the given zone name.
*
* \param db Zone database to search in.
* \param zone_name Domain name representing the zone name.
*
* \return Zone with \a zone_name being the owner of the zone apex or NULL if
* not found.
*/
zone_t *knot_zonedb_find(knot_zonedb_t *db, const knot_dname_t *zone_name);
/*!
* \brief Finds zone the given domain name should belong to.
*
* \param db Zone database to search in.
* \param zone_name Domain name to find zone for.
*
* \retval Zone in which the domain name should be present or NULL if no such
* zone is found.
*/
zone_t *knot_zonedb_find_suffix(knot_zonedb_t *db, const knot_dname_t *zone_name);
size_t knot_zonedb_size(const knot_zonedb_t *db);
/*!
* \brief Destroys and deallocates the zone database structure (but not the
* zones within).
*
* \param db Zone database to be destroyed.
*/
void knot_zonedb_free(knot_zonedb_t **db);
/*!
* \brief Destroys and deallocates the whole zone database including the zones.
*
* \param db Zone database to be destroyed.
* \param abort_txn Indication that possible zone transactions are aborted.
*/
void knot_zonedb_deep_free(knot_zonedb_t **db, bool abort_txn);
|