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
|
/*!
* \file zonedb.h
*
* \author Lubos Slovak <lubos.slovak@nic.cz>
*
* \brief Zone database structure and API for manipulating it.
*
* Zone database groups several zones and provides functions for finding
* suitable zone for a domain name, for searching in a particular zone, etc.
*
* \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_ZONEDB_H_
#define _KNOT_ZONEDB_H_
#include "common/general-tree.h"
#include "zone/zone.h"
#include "zone/node.h"
#include "dname.h"
/*!
* \brief Zone database structure. Contains all zones managed by the server.
*/
struct knot_zonedb {
general_tree_t *zone_tree; /*!< AVL tree of zones. */
size_t zone_count;
};
typedef struct knot_zonedb knot_zonedb_t;
/*----------------------------------------------------------------------------*/
/*!
* \brief Allocates and initializes the zone database structure.
*
* \return Pointer to the created zone database structure or NULL if an error
* occured.
*/
knot_zonedb_t *knot_zonedb_new();
/*!
* \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_add_zone(knot_zonedb_t *db, knot_zone_t *zone);
/*!
* \brief Removes the given zone from the database if it exists.
*
* \note Assumes that the zone was adjusted using knot_zone_adjust_dnames().
* If it was not, it may leak some memory due to checks used in
* knot_rdata_deep_free().
*
* \param db Zone database to remove from.
* \param zone_name Name of the zone to be removed.
* \param destroy_zone Set to <> 0 if you do want the function to destroy the
* zone after removing from zone database. Set to 0
* otherwise.
*
* \retval KNOT_EOK
* \retval KNOT_ENOZONE
*/
knot_zone_t * knot_zonedb_remove_zone(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.
*/
knot_zone_t *knot_zonedb_find_zone(const 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 dname Domain name to find zone for.
*
* \retval Zone in which the domain name should be present or NULL if no such
* zone is found.
*/
const knot_zone_t *knot_zonedb_find_zone_for_name(knot_zonedb_t *db,
const knot_dname_t *dname);
knot_zone_contents_t *knot_zonedb_expire_zone(knot_zonedb_t *db,
const knot_dname_t *zone_name);
size_t knot_zonedb_zone_count(const knot_zonedb_t *db);
const knot_zone_t **knot_zonedb_zones(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.
*
* \note Assumes that the zone was adjusted using knot_zone_adjust_dnames().
* If it was not, it may leak some memory due to checks used in
* knot_rdata_deep_free().
*
* \param db Zone database to be destroyed.
*/
void knot_zonedb_deep_free(knot_zonedb_t **db);
/*----------------------------------------------------------------------------*/
#endif /* _KNOT_ZONEDB_H_ */
/*! @} */
|
