rplan.c 7.97 KB
Newer Older
1
/*  Copyright (C) 2014-2017 CZ.NIC, z.s.p.o. <knot-dns@labs.nic.cz>
Marek Vavruša's avatar
Marek Vavruša committed
2 3 4 5 6 7 8 9 10 11 12 13

    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
14
    along with this program.  If not, see <https://www.gnu.org/licenses/>.
Marek Vavruša's avatar
Marek Vavruša committed
15 16
 */

17
#include <libknot/descriptor.h>
18
#include <libknot/errcode.h>
19 20

#include "lib/rplan.h"
21
#include "lib/resolve.h"
22
#include "lib/cache/api.h"
23
#include "lib/defines.h"
24
#include "lib/layer.h"
25

26
#define VERBOSE_MSG(qry, ...) QRVERBOSE(qry, "plan",  __VA_ARGS__)
27

28 29 30 31 32 33 34 35 36 37 38 39 40 41
inline static unsigned char chars_or(const unsigned char a, const unsigned char b)
{
	return a | b;
}

/** Bits set to 1 in variable b will be set to zero in variable a. */
inline static unsigned char chars_mask(const unsigned char a, const unsigned char b)
{
	return a & ~b;
}

/** Apply mod(a, b) to every byte a, b from fl1, fl2 and return result in fl1. */
inline static void kr_qflags_mod(struct kr_qflags *fl1, struct kr_qflags fl2,
			unsigned char mod(const unsigned char a, const unsigned char b))
42 43 44 45
{
	if (!fl1) abort();
	union {
		struct kr_qflags flags;
46 47
		/* C99 section 6.5.3.4: sizeof(char) == 1 */
		unsigned char chars[sizeof(struct kr_qflags)];
48 49 50 51
	} tmp1, tmp2;
	/* The compiler should be able to optimize all this into simple ORs. */
	tmp1.flags = *fl1;
	tmp2.flags = fl2;
52 53
	for (size_t i = 0; i < sizeof(struct kr_qflags); ++i) {
		tmp1.chars[i] = mod(tmp1.chars[i], tmp2.chars[i]);
54 55 56
	}
	*fl1 = tmp1.flags;
}
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76

/**
 * Set bits from variable fl2 in variable fl1.
 * Bits which are not set in fl2 are not modified in fl1.
 *
 * @param[in,out] fl1
 * @param[in] fl2
 */
void kr_qflags_set(struct kr_qflags *fl1, struct kr_qflags fl2)
{
	kr_qflags_mod(fl1, fl2, chars_or);
}

/**
 * Clear bits from variable fl2 in variable fl1.
 * Bits which are not set in fl2 are not modified in fl1.
 *
 * @param[in,out] fl1
 * @param[in] fl2
 */
77 78
void kr_qflags_clear(struct kr_qflags *fl1, struct kr_qflags fl2)
{
79
	kr_qflags_mod(fl1, fl2, chars_mask);
80
}
81

82
static struct kr_query *query_create(knot_mm_t *pool, const knot_dname_t *name, uint32_t uid)
83 84 85 86 87 88 89
{
	struct kr_query *qry = mm_alloc(pool, sizeof(struct kr_query));
	if (qry == NULL) {
		return NULL;
	}

	memset(qry, 0, sizeof(struct kr_query));
90 91 92 93 94 95
	if (name != NULL) {
		qry->sname = knot_dname_copy(name, pool);
		if (qry->sname == NULL) {
			mm_free(pool, qry);
			return NULL;
		}
96 97
	}

98
	knot_dname_to_lower(qry->sname);
99
	qry->uid = uid;
100 101 102
	return qry;
}

103
static void query_free(knot_mm_t *pool, struct kr_query *qry)
104
{
105
	kr_zonecut_deinit(&qry->zone_cut);
106 107 108 109
	mm_free(pool, qry->sname);
	mm_free(pool, qry);
}

110
int kr_rplan_init(struct kr_rplan *rplan, struct kr_request *request, knot_mm_t *pool)
111
{
112 113 114 115
	if (rplan == NULL) {
		return KNOT_EINVAL;
	}

116 117
	memset(rplan, 0, sizeof(struct kr_rplan));

118
	rplan->pool = pool;
119
	rplan->request = request;
120 121
	array_init(rplan->pending);
	array_init(rplan->resolved);
122
	rplan->next_uid = 0;
123
	return KNOT_EOK;
124 125
}

126
void kr_rplan_deinit(struct kr_rplan *rplan)
127
{
128 129 130 131
	if (rplan == NULL) {
		return;
	}

132 133
	for (size_t i = 0; i < rplan->pending.len; ++i) {
		query_free(rplan->pool, rplan->pending.at[i]);
134
	}
135 136
	for (size_t i = 0; i < rplan->resolved.len; ++i) {
		query_free(rplan->pool, rplan->resolved.at[i]);
137
	}
138 139
	array_clear_mm(rplan->pending, mm_free, rplan->pool);
	array_clear_mm(rplan->resolved, mm_free, rplan->pool);
140 141 142 143
}

bool kr_rplan_empty(struct kr_rplan *rplan)
{
144 145 146 147
	if (rplan == NULL) {
		return true;
	}

148
	return rplan->pending.len == 0;
149 150
}

151 152 153
static struct kr_query *kr_rplan_push_query(struct kr_rplan *rplan,
                                            struct kr_query *parent,
                                            const knot_dname_t *name)
154
{
155
	if (rplan == NULL) {
156 157
		return NULL;
	}
158

159 160 161 162 163 164
	/* Make sure there's enough space */
	int ret = array_reserve_mm(rplan->pending, rplan->pending.len + 1, kr_memreserve, rplan->pool);
	if (ret != 0) {
		return NULL;
	}

165
	struct kr_query *qry = query_create(rplan->pool, name, rplan->next_uid);
166 167 168
	if (qry == NULL) {
		return NULL;
	}
169
	rplan->next_uid += 1;
170
	/* Class and type must be set outside this function. */
171
	qry->flags = rplan->request->options;
172
	qry->parent = parent;
173
	qry->request = rplan->request;
174
	qry->ns.ctx = rplan->request->ctx;
175
	qry->ns.addr[0].ip.sa_family = AF_UNSPEC;
176
	gettimeofday(&qry->timestamp, NULL);
Vitezslav Kriz's avatar
Vitezslav Kriz committed
177 178
	qry->timestamp_mono = kr_now();
	qry->creation_time_mono = parent ? parent->creation_time_mono : qry->timestamp_mono;
179
	kr_zonecut_init(&qry->zone_cut, (const uint8_t *)"", rplan->pool);
180
	qry->reorder = qry->flags.REORDER_RR ? kr_rand_bytes(sizeof(qry->reorder)) : 0;
181 182

	/* When forwarding, keep the nameserver addresses. */
183
	if (parent && parent->flags.FORWARD && qry->flags.FORWARD) {
184 185
		ret = kr_nsrep_copy_set(&qry->ns, &parent->ns);
		if (ret) {
186
			query_free(rplan->pool, qry);
187 188 189 190
			return NULL;
		}
	}

191
	array_push(rplan->pending, qry);
192

193 194 195 196 197 198 199 200 201 202 203 204 205 206
	return qry;
}

struct kr_query *kr_rplan_push_empty(struct kr_rplan *rplan, struct kr_query *parent)
{
	if (rplan == NULL) {
		return NULL;
	}

	struct kr_query *qry = kr_rplan_push_query(rplan, parent, NULL);
	if (qry == NULL) {
		return NULL;
	}

207
	WITH_VERBOSE(qry) {
Vladimír Čunát's avatar
Vladimír Čunát committed
208
	VERBOSE_MSG(qry, "plan '%s' type '%s'  uid [%05u.%02u]\n", "", "",
209
		    qry->request ? qry->request->uid : 0, qry->uid);
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228
	}
	return qry;
}

struct kr_query *kr_rplan_push(struct kr_rplan *rplan, struct kr_query *parent,
                               const knot_dname_t *name, uint16_t cls, uint16_t type)
{
	if (rplan == NULL || name == NULL) {
		return NULL;
	}

	struct kr_query *qry = kr_rplan_push_query(rplan, parent, name);
	if (qry == NULL) {
		return NULL;
	}

	qry->sclass = cls;
	qry->stype = type;

229
	WITH_VERBOSE(qry) {
230 231
	KR_DNAME_GET_STR(name_str, name);
	KR_RRTYPE_GET_STR(type_str, type);
Vladimír Čunát's avatar
Vladimír Čunát committed
232
	VERBOSE_MSG(parent, "plan '%s' type '%s' uid [%05u.%02u]\n",
233 234
		    name_str, type_str,
		    qry->request ? qry->request->uid : 0, qry->uid);
235
	}
236 237 238 239 240
	return qry;
}

int kr_rplan_pop(struct kr_rplan *rplan, struct kr_query *qry)
{
241 242 243 244
	if (rplan == NULL || qry == NULL) {
		return KNOT_EINVAL;
	}

245 246 247 248 249 250 251
	/* Make sure there's enough space */
	int ret = array_reserve_mm(rplan->resolved, rplan->resolved.len + 1, kr_memreserve, rplan->pool);
	if (ret != 0) {
		return ret;
	}

	/* Find the query, it will likely be on top */
252 253
	for (size_t i = rplan->pending.len; i > 0; i--) {
		if (rplan->pending.at[i - 1] == qry) {
254 255 256 257 258 259
			/* Delete i-1 element by *sliding* the rest,
			 * contrary to array_del() */
			for (size_t j = i; j < rplan->pending.len; ++j)
				rplan->pending.at[j - 1] = rplan->pending.at[j];
			array_pop(rplan->pending);

260 261 262 263
			array_push(rplan->resolved, qry);
			break;
		}
	}
264
	return KNOT_EOK;
265 266
}

267 268
bool kr_rplan_satisfies(struct kr_query *closure, const knot_dname_t *name, uint16_t cls, uint16_t type)
{
269
	while (name && closure) {
270 271
		if (closure->sclass == cls && closure->stype == type
		    && knot_dname_is_equal(closure->sname, name)) {
272 273 274 275 276 277
			return true;
		}
		closure = closure->parent;
	}
	return false;
}
278 279 280

struct kr_query *kr_rplan_resolved(struct kr_rplan *rplan)
{
281
	if (rplan->resolved.len == 0) {
282 283
		return NULL;
	}
284
	return array_tail(rplan->resolved);
285 286
}

287 288 289 290 291 292 293 294 295
struct kr_query *kr_rplan_last(struct kr_rplan *rplan)
{
	if (!kr_rplan_empty(rplan)) {
		return array_tail(rplan->pending);
	}

	return kr_rplan_resolved(rplan);
}

Grigorii Demidov's avatar
Grigorii Demidov committed
296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311
struct kr_query *kr_rplan_find_resolved(struct kr_rplan *rplan, struct kr_query *parent,
                               const knot_dname_t *name, uint16_t cls, uint16_t type)
{
	struct kr_query *ret = NULL;
	for (int i = 0; i < rplan->resolved.len; ++i) {
		struct kr_query *q = rplan->resolved.at[i];
		if (q->stype == type && q->sclass == cls &&
		    (parent == NULL || q->parent == parent) &&
		    knot_dname_is_equal(q->sname, name)) {
			ret = q;
			break;
		}
	}
	return ret;
}

312
#undef VERBOSE_MSG