Coverage Report

Created: 2026-10-31 06:35

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/bind9/lib/dns/zt.c
Line
Count
Source
1
/*
2
 * Copyright (C) Internet Systems Consortium, Inc. ("ISC")
3
 *
4
 * SPDX-License-Identifier: MPL-2.0
5
 *
6
 * This Source Code Form is subject to the terms of the Mozilla Public
7
 * License, v. 2.0. If a copy of the MPL was not distributed with this
8
 * file, you can obtain one at https://mozilla.org/MPL/2.0/.
9
 *
10
 * See the COPYRIGHT file distributed with this work for additional
11
 * information regarding copyright ownership.
12
 */
13
14
/*! \file */
15
16
#include <inttypes.h>
17
#include <stdbool.h>
18
19
#include <isc/atomic.h>
20
#include <isc/file.h>
21
#include <isc/log.h>
22
#include <isc/magic.h>
23
#include <isc/mem.h>
24
#include <isc/result.h>
25
#include <isc/string.h>
26
#include <isc/tid.h>
27
#include <isc/util.h>
28
29
#include <dns/name.h>
30
#include <dns/qp.h>
31
#include <dns/rdataclass.h>
32
#include <dns/view.h>
33
#include <dns/zone.h>
34
#include <dns/zoneproperties.h>
35
#include <dns/zt.h>
36
37
2
#define ZTMAGIC      ISC_MAGIC('Z', 'T', 'b', 'l')
38
#define VALID_ZT(zt) ISC_MAGIC_VALID(zt, ZTMAGIC)
39
40
struct dns_zt {
41
  unsigned int magic;
42
  isc_mem_t *mctx;
43
  dns_qpmulti_t *multi;
44
45
  atomic_bool flush;
46
  isc_refcount_t references;
47
  isc_refcount_t loads_pending;
48
};
49
50
struct zt_load_params {
51
  dns_zt_t *zt;
52
  dns_zt_callback_t *loaddone;
53
  void *loaddone_arg;
54
  bool newonly;
55
};
56
57
struct zt_freeze_params {
58
  dns_view_t *view;
59
  bool freeze;
60
};
61
62
static void
63
ztqpattach(void *uctx ISC_ATTR_UNUSED, void *pval,
64
2
     uint32_t ival ISC_ATTR_UNUSED) {
65
2
  dns_zone_t *zone = pval;
66
2
  dns_zone_ref(zone);
67
2
}
68
69
static void
70
ztqpdetach(void *uctx ISC_ATTR_UNUSED, void *pval,
71
0
     uint32_t ival ISC_ATTR_UNUSED) {
72
0
  dns_zone_t *zone = pval;
73
0
  dns_zone_detach(&zone);
74
0
}
75
76
static size_t
77
ztqpmakekey(dns_qpkey_t key, void *uctx ISC_ATTR_UNUSED, void *pval,
78
416
      uint32_t ival ISC_ATTR_UNUSED) {
79
416
  dns_zone_t *zone = pval;
80
416
  dns_name_t *name = dns_zone_getorigin(zone);
81
416
  return dns_qpkey_fromname(key, name, DNS_DBNAMESPACE_NORMAL);
82
416
}
83
84
static void
85
0
ztqptriename(void *uctx, char *buf, size_t size) {
86
0
  dns_view_t *view = uctx;
87
0
  snprintf(buf, size, "view %s zone table", view->name);
88
0
}
89
90
static dns_qpmethods_t ztqpmethods = {
91
  ztqpattach,
92
  ztqpdetach,
93
  ztqpmakekey,
94
  ztqptriename,
95
};
96
97
void
98
2
dns_zt_create(isc_mem_t *mctx, dns_view_t *view, dns_zt_t **ztp) {
99
2
  dns_qpmulti_t *multi = NULL;
100
2
  dns_zt_t *zt = NULL;
101
102
2
  REQUIRE(ztp != NULL && *ztp == NULL);
103
2
  REQUIRE(view != NULL);
104
105
2
  dns_qpmulti_create(mctx, &ztqpmethods, view, &multi);
106
107
2
  zt = isc_mem_get(mctx, sizeof(*zt));
108
2
  *zt = (dns_zt_t){
109
2
    .magic = ZTMAGIC,
110
2
    .multi = multi,
111
2
    .references = 1,
112
2
  };
113
114
2
  isc_mem_attach(mctx, &zt->mctx);
115
116
2
  *ztp = zt;
117
2
}
118
119
/*
120
 * XXXFANF it isn't clear whether this function will be useful. There
121
 * is only one zone table per view, so it is probably enough to let
122
 * the qp-trie auto-GC do its thing. However it might be problematic
123
 * if a very large zone is replaced, and its database memory is
124
 * retained for a long time.
125
 */
126
void
127
0
dns_zt_compact(dns_zt_t *zt) {
128
0
  dns_qp_t *qp = NULL;
129
130
0
  REQUIRE(VALID_ZT(zt));
131
132
0
  dns_qpmulti_write(zt->multi, &qp);
133
0
  dns_qp_compact(qp, DNS_QPGC_ALL);
134
0
  dns_qpmulti_commit(zt->multi, &qp);
135
0
}
136
137
isc_result_t
138
2
dns_zt_mount(dns_zt_t *zt, dns_zone_t *zone) {
139
2
  isc_result_t result;
140
2
  dns_qp_t *qp = NULL;
141
142
2
  REQUIRE(VALID_ZT(zt));
143
144
2
  dns_qpmulti_write(zt->multi, &qp);
145
2
  result = dns_qp_insert(qp, zone, 0);
146
2
  dns_qp_compact(qp, DNS_QPGC_MAYBE);
147
2
  dns_qpmulti_commit(zt->multi, &qp);
148
149
2
  return result;
150
2
}
151
152
isc_result_t
153
0
dns_zt_unmount(dns_zt_t *zt, dns_zone_t *zone) {
154
0
  isc_result_t result;
155
0
  dns_qp_t *qp = NULL;
156
157
0
  REQUIRE(VALID_ZT(zt));
158
159
0
  dns_qpmulti_write(zt->multi, &qp);
160
0
  result = dns_qp_deletename(qp, dns_zone_getorigin(zone),
161
0
           DNS_DBNAMESPACE_NORMAL, NULL, NULL);
162
0
  dns_qp_compact(qp, DNS_QPGC_MAYBE);
163
0
  dns_qpmulti_commit(zt->multi, &qp);
164
165
0
  return result;
166
0
}
167
168
isc_result_t
169
dns_zt_find(dns_zt_t *zt, const dns_name_t *name, dns_ztfind_t options,
170
414
      dns_zone_t **zonep) {
171
414
  isc_result_t result;
172
414
  dns_qpread_t qpr;
173
414
  void *pval = NULL;
174
414
  dns_ztfind_t exactmask = DNS_ZTFIND_NOEXACT | DNS_ZTFIND_EXACT;
175
414
  dns_ztfind_t exactopts = options & exactmask;
176
414
  dns_qpchain_t chain;
177
178
414
  REQUIRE(VALID_ZT(zt));
179
414
  REQUIRE(exactopts != exactmask);
180
181
414
  dns_qpmulti_query(zt->multi, &qpr);
182
183
414
  if (exactopts == DNS_ZTFIND_EXACT) {
184
0
    result = dns_qp_getname(&qpr, name, DNS_DBNAMESPACE_NORMAL,
185
0
          &pval, NULL);
186
414
  } else {
187
414
    result = dns_qp_lookup(&qpr, name, DNS_DBNAMESPACE_NORMAL, NULL,
188
414
               &chain, &pval, NULL);
189
414
    if (exactopts == DNS_ZTFIND_NOEXACT && result == ISC_R_SUCCESS)
190
0
    {
191
      /* get pval from the previous chain link */
192
0
      int len = dns_qpchain_length(&chain);
193
0
      if (len >= 2) {
194
0
        dns_qpchain_node(&chain, len - 2, &pval, NULL);
195
0
        result = DNS_R_PARTIALMATCH;
196
0
      } else {
197
0
        result = ISC_R_NOTFOUND;
198
0
      }
199
0
    }
200
414
  }
201
202
  /* Keep the zone protected through the checks and attachment. */
203
414
  if (result == ISC_R_SUCCESS || result == DNS_R_PARTIALMATCH) {
204
213
    dns_zone_t *zone = pval;
205
    /*
206
     * If DNS_ZTFIND_MIRROR is set and the zone which was
207
     * determined to be the deepest match for the supplied name is
208
     * a mirror zone which is expired or not yet loaded, treat it
209
     * as non-existent.  This will trigger a fallback to recursion
210
     * instead of returning a SERVFAIL.
211
     *
212
     * Note that currently only the deepest match in the zone table
213
     * is checked.  Consider a server configured with two mirror
214
     * zones: "bar" and its child, "foo.bar".  If zone data is
215
     * available for "bar" but not for "foo.bar", a query with
216
     * QNAME equal to or below "foo.bar" will cause ISC_R_NOTFOUND
217
     * to be returned, not DNS_R_PARTIALMATCH, despite zone data
218
     * being available for "bar".  This is considered to be an edge
219
     * case, handling which more appropriately is possible, but
220
     * arguably not worth the added complexity.
221
     */
222
213
    if ((options & DNS_ZTFIND_MIRROR) != 0 &&
223
213
        dns_zone_gettype(zone) == dns_zone_mirror &&
224
0
        !dns_zone_isloaded(zone))
225
0
    {
226
0
      result = ISC_R_NOTFOUND;
227
213
    } else {
228
213
      dns_zone_attach(zone, zonep);
229
213
    }
230
213
  }
231
414
  dns_qpread_destroy(zt->multi, &qpr);
232
233
414
  return result;
234
414
}
235
236
void
237
0
dns_zt_attach(dns_zt_t *zt, dns_zt_t **ztp) {
238
0
  REQUIRE(VALID_ZT(zt));
239
0
  REQUIRE(ztp != NULL && *ztp == NULL);
240
241
0
  isc_refcount_increment(&zt->references);
242
243
0
  *ztp = zt;
244
0
}
245
246
static isc_result_t
247
0
flush(dns_zone_t *zone, void *uap) {
248
0
  UNUSED(uap);
249
0
  return dns_zone_flush(zone);
250
0
}
251
252
static void
253
0
zt_destroy(dns_zt_t *zt) {
254
0
  isc_refcount_destroy(&zt->references);
255
0
  isc_refcount_destroy(&zt->loads_pending);
256
257
0
  if (atomic_load_acquire(&zt->flush)) {
258
0
    (void)dns_zt_apply(zt, false, NULL, flush, NULL);
259
0
  }
260
261
0
  dns_qpmulti_destroy(&zt->multi);
262
0
  zt->magic = 0;
263
0
  isc_mem_putanddetach(&zt->mctx, zt, sizeof(*zt));
264
0
}
265
266
void
267
0
dns_zt_detach(dns_zt_t **ztp) {
268
0
  dns_zt_t *zt;
269
270
0
  REQUIRE(ztp != NULL && VALID_ZT(*ztp));
271
272
0
  zt = *ztp;
273
0
  *ztp = NULL;
274
275
0
  if (isc_refcount_decrement(&zt->references) == 1) {
276
0
    zt_destroy(zt);
277
0
  }
278
0
}
279
280
void
281
0
dns_zt_flush(dns_zt_t *zt) {
282
0
  REQUIRE(VALID_ZT(zt));
283
0
  atomic_store_release(&zt->flush, true);
284
0
}
285
286
static void
287
0
loaded_all(struct zt_load_params *params) {
288
0
  if (params->loaddone != NULL) {
289
0
    params->loaddone(params->loaddone_arg);
290
0
  }
291
0
  isc_mem_put(params->zt->mctx, params, sizeof(*params));
292
0
}
293
294
/*
295
 * Decrement the loads_pending counter; when counter reaches
296
 * zero, call the loaddone callback that was initially set by
297
 * dns_zt_asyncload().
298
 */
299
static isc_result_t
300
0
loaded_one(void *uap) {
301
0
  struct zt_load_params *params = uap;
302
0
  dns_zt_t *zt = params->zt;
303
304
0
  REQUIRE(VALID_ZT(zt));
305
306
0
  if (isc_refcount_decrement(&zt->loads_pending) == 1) {
307
0
    loaded_all(params);
308
0
  }
309
310
0
  if (isc_refcount_decrement(&zt->references) == 1) {
311
0
    zt_destroy(zt);
312
0
  }
313
314
0
  return ISC_R_SUCCESS;
315
0
}
316
317
/*
318
 * Initiates asynchronous loading of zone 'zone'.  'callback' is a
319
 * pointer to a function which will be used to inform the caller when
320
 * the zone loading is complete.
321
 */
322
static isc_result_t
323
0
asyncload(dns_zone_t *zone, void *uap) {
324
0
  struct zt_load_params *params = uap;
325
0
  struct dns_zt *zt = params->zt;
326
0
  isc_result_t result;
327
328
0
  REQUIRE(VALID_ZT(zt));
329
0
  REQUIRE(zone != NULL);
330
331
0
  isc_refcount_increment(&zt->references);
332
0
  isc_refcount_increment(&zt->loads_pending);
333
334
0
  result = dns_zone_asyncload(zone, params->newonly, loaded_one, params);
335
0
  if (result != ISC_R_SUCCESS) {
336
    /*
337
     * Caller is holding a reference to zt->loads_pending
338
     * and zt->references so these can't decrement to zero.
339
     */
340
0
    isc_refcount_decrement1(&zt->references);
341
0
    isc_refcount_decrement1(&zt->loads_pending);
342
0
  }
343
0
  return ISC_R_SUCCESS;
344
0
}
345
346
isc_result_t
347
dns_zt_asyncload(dns_zt_t *zt, bool newonly, dns_zt_callback_t *loaddone,
348
0
     void *arg) {
349
0
  isc_result_t result;
350
0
  uint_fast32_t loads_pending;
351
0
  struct zt_load_params *params = NULL;
352
353
0
  REQUIRE(VALID_ZT(zt));
354
355
  /*
356
   * Obtain a reference to zt->loads_pending so that asyncload can
357
   * safely decrement both zt->references and zt->loads_pending
358
   * without going to zero.
359
   */
360
0
  loads_pending = isc_refcount_increment0(&zt->loads_pending);
361
0
  INSIST(loads_pending == 0);
362
363
0
  params = isc_mem_get(zt->mctx, sizeof(*params));
364
0
  *params = (struct zt_load_params){
365
0
    .zt = zt,
366
0
    .newonly = newonly,
367
0
    .loaddone = loaddone,
368
0
    .loaddone_arg = arg,
369
0
  };
370
371
0
  result = dns_zt_apply(zt, false, NULL, asyncload, params);
372
373
  /*
374
   * Have all the loads completed?
375
   */
376
0
  if (isc_refcount_decrement(&zt->loads_pending) == 1) {
377
0
    loaded_all(params);
378
0
  }
379
380
0
  return result;
381
0
}
382
383
static isc_result_t
384
0
freezezones(dns_zone_t *zone, void *uap) {
385
0
  struct zt_freeze_params *params = uap;
386
0
  bool frozen;
387
0
  isc_result_t result = ISC_R_SUCCESS;
388
0
  char classstr[DNS_RDATACLASS_FORMATSIZE];
389
0
  char zonename[DNS_NAME_FORMATSIZE];
390
0
  dns_zone_t *raw = NULL;
391
0
  dns_view_t *view;
392
0
  const char *vname;
393
0
  const char *sep;
394
0
  int level;
395
396
0
  dns_zone_getraw(zone, &raw);
397
0
  if (raw != NULL) {
398
0
    zone = raw;
399
0
  }
400
0
  if (params->view != dns_zone_getview(zone)) {
401
0
    if (raw != NULL) {
402
0
      dns_zone_detach(&raw);
403
0
    }
404
0
    return ISC_R_SUCCESS;
405
0
  }
406
0
  if (dns_zone_gettype(zone) != dns_zone_primary) {
407
0
    if (raw != NULL) {
408
0
      dns_zone_detach(&raw);
409
0
    }
410
0
    return ISC_R_SUCCESS;
411
0
  }
412
0
  if (!dns_zone_isdynamic(zone, true)) {
413
0
    if (raw != NULL) {
414
0
      dns_zone_detach(&raw);
415
0
    }
416
0
    return ISC_R_SUCCESS;
417
0
  }
418
419
0
  frozen = dns_zone_getupdatedisabled(zone);
420
0
  if (params->freeze) {
421
0
    if (frozen) {
422
0
      result = DNS_R_FROZEN;
423
0
    }
424
0
    if (result == ISC_R_SUCCESS) {
425
0
      result = dns_zone_flush(zone);
426
0
    }
427
0
    if (result == ISC_R_SUCCESS) {
428
0
      dns_zone_setupdatedisabled(zone, params->freeze);
429
0
    }
430
0
  } else {
431
0
    if (frozen) {
432
0
      result = dns_zone_loadandthaw(zone);
433
0
      if (result == DNS_R_CONTINUE ||
434
0
          result == ISC_R_LOADING || result == DNS_R_UPTODATE)
435
0
      {
436
0
        result = ISC_R_SUCCESS;
437
0
      }
438
0
    }
439
0
  }
440
0
  view = dns_zone_getview(zone);
441
0
  if (strcmp(view->name, "_bind") == 0 ||
442
0
      strcmp(view->name, "_default") == 0)
443
0
  {
444
0
    vname = "";
445
0
    sep = "";
446
0
  } else {
447
0
    vname = view->name;
448
0
    sep = " ";
449
0
  }
450
0
  dns_rdataclass_format(dns_zone_getclass(zone), classstr,
451
0
            sizeof(classstr));
452
0
  dns_name_format(dns_zone_getorigin(zone), zonename, sizeof(zonename));
453
0
  level = (result != ISC_R_SUCCESS) ? ISC_LOG_ERROR : ISC_LOG_DEBUG(1);
454
0
  isc_log_write(DNS_LOGCATEGORY_GENERAL, DNS_LOGMODULE_ZONE, level,
455
0
          "%s zone '%s/%s'%s%s: %s",
456
0
          params->freeze ? "freezing" : "thawing", zonename,
457
0
          classstr, sep, vname, isc_result_totext(result));
458
0
  if (raw != NULL) {
459
0
    dns_zone_detach(&raw);
460
0
  }
461
0
  return result;
462
0
}
463
464
isc_result_t
465
0
dns_zt_freezezones(dns_zt_t *zt, dns_view_t *view, bool freeze) {
466
0
  isc_result_t result, tresult;
467
0
  struct zt_freeze_params params = { view, freeze };
468
469
0
  REQUIRE(VALID_ZT(zt));
470
471
0
  result = dns_zt_apply(zt, false, &tresult, freezezones, &params);
472
0
  if (tresult == ISC_R_NOTFOUND) {
473
0
    tresult = ISC_R_SUCCESS;
474
0
  }
475
0
  return (result == ISC_R_SUCCESS) ? tresult : result;
476
0
}
477
478
typedef void
479
setview_cb(dns_zone_t *zone);
480
481
static isc_result_t
482
0
setview(dns_zone_t *zone, void *arg) {
483
0
  setview_cb *cb = arg;
484
0
  cb(zone);
485
0
  return ISC_R_SUCCESS;
486
0
}
487
488
void
489
0
dns_zt_setviewcommit(dns_zt_t *zt) {
490
0
  dns_zt_apply(zt, false, NULL, setview, dns_zone_setviewcommit);
491
0
}
492
493
void
494
0
dns_zt_setviewrevert(dns_zt_t *zt) {
495
0
  dns_zt_apply(zt, false, NULL, setview, dns_zone_setviewrevert);
496
0
}
497
498
isc_result_t
499
dns_zt_apply(dns_zt_t *zt, bool stop, isc_result_t *sub,
500
0
       isc_result_t (*action)(dns_zone_t *, void *), void *uap) {
501
0
  isc_result_t result = ISC_R_SUCCESS;
502
0
  isc_result_t tresult = ISC_R_SUCCESS;
503
0
  dns_qpiter_t qpi;
504
0
  dns_qpread_t qpr;
505
0
  void *zone = NULL;
506
507
0
  REQUIRE(VALID_ZT(zt));
508
0
  REQUIRE(action != NULL);
509
510
0
  dns_qpmulti_query(zt->multi, &qpr);
511
0
  dns_qpiter_init(&qpr, &qpi);
512
513
0
  while (dns_qpiter_next(&qpi, &zone, NULL) == ISC_R_SUCCESS) {
514
0
    result = action(zone, uap);
515
0
    if (tresult == ISC_R_SUCCESS) {
516
0
      tresult = result;
517
0
    }
518
0
    if (result != ISC_R_SUCCESS && stop) {
519
0
      break;
520
0
    }
521
0
  }
522
0
  dns_qpread_destroy(zt->multi, &qpr);
523
524
0
  SET_IF_NOT_NULL(sub, tresult);
525
526
0
  return result;
527
0
}