summaryrefslogtreecommitdiffstats
path: root/src/knot/journal/serialization.h
blob: 621dcdb5f01e4f143254c716f21b39c40086daed (plain)
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
/*  Copyright (C) 2022 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 <stdint.h>

#include "libknot/rrset.h"
#include "libknot/rrtype/soa.h"
#include "knot/updates/changesets.h"
#include "contrib/wire_ctx.h"

typedef struct zone_diff {
	zone_tree_t nodes;
	zone_tree_t nsec3s;
	zone_node_t *apex;
} zone_diff_t;

inline static void zone_diff_reverse(zone_diff_t *diff)
{
	diff->nodes.flags ^= ZONE_TREE_BINO_SECOND;
	diff->nsec3s.flags ^= ZONE_TREE_BINO_SECOND;
	diff->apex = binode_counterpart(diff->apex);
}

inline static void zone_diff_from_zone(zone_diff_t *diff, const zone_contents_t *z)
{
	diff->nodes = *z->nodes;
	if (z->nsec3_nodes != NULL) {
		diff->nsec3s = *z->nsec3_nodes;
	} else {
		memset(&diff->nsec3s, 0, sizeof(diff->nsec3s));
	}
	diff->apex = z->apex;
}

inline static uint32_t zone_diff_to(const zone_diff_t *diff)
{
	return knot_soa_serial(node_rdataset(diff->apex, KNOT_RRTYPE_SOA)->rdata);
}

inline static uint32_t zone_diff_from(const zone_diff_t *diff)
{
	return knot_soa_serial(node_rdataset(binode_counterpart(diff->apex), KNOT_RRTYPE_SOA)->rdata);
}

typedef struct serialize_ctx serialize_ctx_t;

/*!
 * \brief Init serialization context.
 *
 * \param ch  Changeset to be serialized.
 *
 * \return Context.
 */
serialize_ctx_t *serialize_init(const changeset_t *ch);

/*!
 * \brief Init serialization context.
 *
 * \param z   Zone to be serialized like zone-in-journal changeset.
 *
 * \return Context.
 */
serialize_ctx_t *serialize_zone_init(const zone_contents_t *z);

/*!
 * \brief Init serialization context.
 *
 * \param z   Zone with binodes being updated.
 *
 * \return Context.
 */
serialize_ctx_t *serialize_zone_diff_init(const zone_diff_t *z);

/*!
 * \brief Pre-check and space computation before serializing a chunk.
 *
 * \note This MUST be called before each serialize_chunk() !
 *
 * \param ctx           Serializing context.
 * \param thresh_size   Optimal size of next chunk.
 * \param max_size      Maximum size of next chunk.
 * \param realsize      Output: real exact size of next chunk.
 */
void serialize_prepare(serialize_ctx_t *ctx, size_t thresh_size,
                       size_t max_size, size_t *realsize);

/*!
 * \brief Perform one step of serializiation: fill one chunk.
 *
 * \param ctx        Serializing context.
 * \param chunk      Pointer on allocated memory to be serialized into.
 * \param chunk_size Its size. It MUST be the same as returned from serialize_prepare().
 */
void serialize_chunk(serialize_ctx_t *ctx, uint8_t *chunk, size_t chunk_size);

/*! \brief Tells if there remains something of the changeset
 *         to be serialized into next chunk(s) yet. */
bool serialize_unfinished(serialize_ctx_t *ctx);

/*!
 * \brief Free serialization context.
 *
 * \return KNOT_E* if there were errors during serialization.
 */
int serialize_deinit(serialize_ctx_t *ctx);

/*!
 * \brief Returns size of serialized changeset from zone diff.
 *
 * \warning Not accurate! This is an upper bound, suitable for policy enforcement etc.
 *
 * \param[in] diff    Zone diff structure to create changeset from.
 *
 * \return Size of the resulting changeset.
 */
size_t zone_diff_serialized_size(zone_diff_t diff);

/*!
 * \brief Returns size of changeset in serialized form.
 *
 * \param[in] ch  Changeset whose size we want to compute.
 *
 * \return Size of the changeset.
 */
size_t changeset_serialized_size(const changeset_t *ch);

/*!
 * \brief Simply serialize RRset w/o any chunking.
 *
 * \param wire
 * \param rrset
 *
 * \return KNOT_E*
 */
int serialize_rrset(wire_ctx_t *wire, const knot_rrset_t *rrset);

/*!
 * \brief Simply deserialize RRset w/o any chunking.
 *
 * \param wire
 * \param rrset
 *
 * \return KNOT_E*
 */
int deserialize_rrset(wire_ctx_t *wire, knot_rrset_t *rrset);

/*!
 * \brief Space needed to serialize RRset.
 *
 * \param rrset RRset.
 *
 * \return RRset binary size.
 */
size_t rrset_serialized_size(const knot_rrset_t *rrset);