2 * Copyright (C) 2004-2011 Internet Systems Consortium, Inc. ("ISC")
3 * Copyright (C) 1999-2003 Internet Software Consortium.
5 * Permission to use, copy, modify, and/or distribute this software for any
6 * purpose with or without fee is hereby granted, provided that the above
7 * copyright notice and this permission notice appear in all copies.
9 * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
10 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
11 * AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
12 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
13 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
14 * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
15 * PERFORMANCE OF THIS SOFTWARE.
18 /* $Id: rdataset.c,v 1.86.148.4 2011-06-08 23:02:42 each Exp $ */
26 #include <isc/buffer.h>
28 #include <isc/random.h>
32 #include <dns/ncache.h>
33 #include <dns/rdata.h>
34 #include <dns/rdataset.h>
35 #include <dns/compress.h>
37 static const char *trustnames[] = {
47 "local" /* aka ultimate */
51 dns_trust_totext(dns_trust_t trust) {
52 if (trust >= sizeof(trustnames)/sizeof(*trustnames))
54 return (trustnames[trust]);
58 dns_rdataset_init(dns_rdataset_t *rdataset) {
61 * Make 'rdataset' a valid, disassociated rdataset.
64 REQUIRE(rdataset != NULL);
66 rdataset->magic = DNS_RDATASET_MAGIC;
67 rdataset->methods = NULL;
68 ISC_LINK_INIT(rdataset, link);
69 rdataset->rdclass = 0;
74 rdataset->attributes = 0;
75 rdataset->count = ISC_UINT32_MAX;
76 rdataset->private1 = NULL;
77 rdataset->private2 = NULL;
78 rdataset->private3 = NULL;
79 rdataset->privateuint4 = 0;
80 rdataset->private5 = NULL;
81 rdataset->private6 = NULL;
86 dns_rdataset_invalidate(dns_rdataset_t *rdataset) {
89 * Invalidate 'rdataset'.
92 REQUIRE(DNS_RDATASET_VALID(rdataset));
93 REQUIRE(rdataset->methods == NULL);
96 ISC_LINK_INIT(rdataset, link);
97 rdataset->rdclass = 0;
101 rdataset->covers = 0;
102 rdataset->attributes = 0;
103 rdataset->count = ISC_UINT32_MAX;
104 rdataset->private1 = NULL;
105 rdataset->private2 = NULL;
106 rdataset->private3 = NULL;
107 rdataset->privateuint4 = 0;
108 rdataset->private5 = NULL;
112 dns_rdataset_disassociate(dns_rdataset_t *rdataset) {
115 * Disassociate 'rdataset' from its rdata, allowing it to be reused.
118 REQUIRE(DNS_RDATASET_VALID(rdataset));
119 REQUIRE(rdataset->methods != NULL);
121 (rdataset->methods->disassociate)(rdataset);
122 rdataset->methods = NULL;
123 ISC_LINK_INIT(rdataset, link);
124 rdataset->rdclass = 0;
128 rdataset->covers = 0;
129 rdataset->attributes = 0;
130 rdataset->count = ISC_UINT32_MAX;
131 rdataset->private1 = NULL;
132 rdataset->private2 = NULL;
133 rdataset->private3 = NULL;
134 rdataset->privateuint4 = 0;
135 rdataset->private5 = NULL;
136 rdataset->private6 = NULL;
140 dns_rdataset_isassociated(dns_rdataset_t *rdataset) {
142 * Is 'rdataset' associated?
145 REQUIRE(DNS_RDATASET_VALID(rdataset));
147 if (rdataset->methods != NULL)
154 question_disassociate(dns_rdataset_t *rdataset) {
159 question_cursor(dns_rdataset_t *rdataset) {
162 return (ISC_R_NOMORE);
166 question_current(dns_rdataset_t *rdataset, dns_rdata_t *rdata) {
168 * This routine should never be called.
177 question_clone(dns_rdataset_t *source, dns_rdataset_t *target) {
182 question_count(dns_rdataset_t *rdataset) {
184 * This routine should never be called.
192 static dns_rdatasetmethods_t question_methods = {
193 question_disassociate,
211 dns_rdataset_makequestion(dns_rdataset_t *rdataset, dns_rdataclass_t rdclass,
212 dns_rdatatype_t type)
216 * Make 'rdataset' a valid, associated, question rdataset, with a
217 * question class of 'rdclass' and type 'type'.
220 REQUIRE(DNS_RDATASET_VALID(rdataset));
221 REQUIRE(rdataset->methods == NULL);
223 rdataset->methods = &question_methods;
224 rdataset->rdclass = rdclass;
225 rdataset->type = type;
226 rdataset->attributes |= DNS_RDATASETATTR_QUESTION;
230 dns_rdataset_count(dns_rdataset_t *rdataset) {
233 * Return the number of records in 'rdataset'.
236 REQUIRE(DNS_RDATASET_VALID(rdataset));
237 REQUIRE(rdataset->methods != NULL);
239 return ((rdataset->methods->count)(rdataset));
243 dns_rdataset_clone(dns_rdataset_t *source, dns_rdataset_t *target) {
246 * Make 'target' refer to the same rdataset as 'source'.
249 REQUIRE(DNS_RDATASET_VALID(source));
250 REQUIRE(source->methods != NULL);
251 REQUIRE(DNS_RDATASET_VALID(target));
252 REQUIRE(target->methods == NULL);
254 (source->methods->clone)(source, target);
258 dns_rdataset_first(dns_rdataset_t *rdataset) {
261 * Move the rdata cursor to the first rdata in the rdataset (if any).
264 REQUIRE(DNS_RDATASET_VALID(rdataset));
265 REQUIRE(rdataset->methods != NULL);
267 return ((rdataset->methods->first)(rdataset));
271 dns_rdataset_next(dns_rdataset_t *rdataset) {
274 * Move the rdata cursor to the next rdata in the rdataset (if any).
277 REQUIRE(DNS_RDATASET_VALID(rdataset));
278 REQUIRE(rdataset->methods != NULL);
280 return ((rdataset->methods->next)(rdataset));
284 dns_rdataset_current(dns_rdataset_t *rdataset, dns_rdata_t *rdata) {
287 * Make 'rdata' refer to the current rdata.
290 REQUIRE(DNS_RDATASET_VALID(rdataset));
291 REQUIRE(rdataset->methods != NULL);
293 (rdataset->methods->current)(rdataset, rdata);
296 #define MAX_SHUFFLE 32
297 #define WANT_FIXED(r) (((r)->attributes & DNS_RDATASETATTR_FIXEDORDER) != 0)
298 #define WANT_RANDOM(r) (((r)->attributes & DNS_RDATASETATTR_RANDOMIZE) != 0)
306 towire_compare(const void *av, const void *bv) {
307 const struct towire_sort *a = (const struct towire_sort *) av;
308 const struct towire_sort *b = (const struct towire_sort *) bv;
309 return (a->key - b->key);
313 towiresorted(dns_rdataset_t *rdataset, const dns_name_t *owner_name,
314 dns_compress_t *cctx, isc_buffer_t *target,
315 dns_rdatasetorderfunc_t order, const void *order_arg,
316 isc_boolean_t partial, unsigned int options,
317 unsigned int *countp, void **state)
319 dns_rdata_t rdata = DNS_RDATA_INIT;
322 unsigned int i, count = 0, added, choice;
323 isc_buffer_t savedbuffer, rdlen, rrbuffer;
324 unsigned int headlen;
325 isc_boolean_t question = ISC_FALSE;
326 isc_boolean_t shuffle = ISC_FALSE;
327 dns_rdata_t *shuffled = NULL, shuffled_fixed[MAX_SHUFFLE];
328 struct towire_sort *sorted = NULL, sorted_fixed[MAX_SHUFFLE];
333 * Convert 'rdataset' to wire format, compressing names as specified
334 * in cctx, and storing the result in 'target'.
337 REQUIRE(DNS_RDATASET_VALID(rdataset));
338 REQUIRE(countp != NULL);
339 REQUIRE((order == NULL) == (order_arg == NULL));
340 REQUIRE(cctx != NULL && cctx->mctx != NULL);
342 if ((rdataset->attributes & DNS_RDATASETATTR_QUESTION) != 0) {
345 result = dns_rdataset_first(rdataset);
346 INSIST(result == ISC_R_NOMORE);
347 } else if ((rdataset->attributes & DNS_RDATASETATTR_NEGATIVE) != 0) {
349 * This is a negative caching rdataset.
351 unsigned int ncache_opts = 0;
352 if ((options & DNS_RDATASETTOWIRE_OMITDNSSEC) != 0)
353 ncache_opts |= DNS_NCACHETOWIRE_OMITDNSSEC;
354 return (dns_ncache_towire(rdataset, cctx, target, ncache_opts,
357 count = (rdataset->methods->count)(rdataset);
358 result = dns_rdataset_first(rdataset);
359 if (result == ISC_R_NOMORE)
360 return (ISC_R_SUCCESS);
361 if (result != ISC_R_SUCCESS)
366 * Do we want to shuffle this answer?
368 if (!question && count > 1 &&
369 (!WANT_FIXED(rdataset) || order != NULL) &&
370 rdataset->type != dns_rdatatype_rrsig)
373 if (shuffle && count > MAX_SHUFFLE) {
374 shuffled = isc_mem_get(cctx->mctx, count * sizeof(*shuffled));
375 sorted = isc_mem_get(cctx->mctx, count * sizeof(*sorted));
376 if (shuffled == NULL || sorted == NULL)
379 shuffled = shuffled_fixed;
380 sorted = sorted_fixed;
385 * First we get handles to all of the rdata.
390 dns_rdata_init(&shuffled[i]);
391 dns_rdataset_current(rdataset, &shuffled[i]);
393 result = dns_rdataset_next(rdataset);
394 } while (result == ISC_R_SUCCESS);
395 if (result != ISC_R_NOMORE)
402 if (WANT_FIXED(rdataset)) {
406 INSIST(order != NULL);
407 for (i = 0; i < count; i++) {
408 sorted[i].key = (*order)(&shuffled[i],
410 sorted[i].rdata = &shuffled[i];
412 } else if (WANT_RANDOM(rdataset)) {
416 for (i = 0; i < count; i++) {
420 isc_random_get(&val);
421 choice = i + (val % (count - i));
423 shuffled[i] = shuffled[choice];
424 shuffled[choice] = rdata;
426 sorted[i].key = (*order)(&shuffled[i],
429 sorted[i].key = 0; /* Unused */
430 sorted[i].rdata = &shuffled[i];
439 val = rdataset->count;
440 if (val == ISC_UINT32_MAX)
441 isc_random_get(&val);
443 for (i = 0; i < count; i++) {
445 sorted[j].key = (*order)(&shuffled[i],
448 sorted[j].key = 0; /* Unused */
449 sorted[j].rdata = &shuffled[i];
452 j = 0; /* Wrap around. */
460 qsort(sorted, count, sizeof(sorted[0]),
464 savedbuffer = *target;
470 * Copy out the name, type, class, ttl.
474 dns_compress_setmethods(cctx, DNS_COMPRESS_GLOBAL14);
475 result = dns_name_towire(owner_name, cctx, target);
476 if (result != ISC_R_SUCCESS)
478 headlen = sizeof(dns_rdataclass_t) + sizeof(dns_rdatatype_t);
480 headlen += sizeof(dns_ttl_t)
481 + 2; /* XXX 2 for rdata len */
482 isc_buffer_availableregion(target, &r);
483 if (r.length < headlen) {
484 result = ISC_R_NOSPACE;
487 isc_buffer_putuint16(target, rdataset->type);
488 isc_buffer_putuint16(target, rdataset->rdclass);
490 isc_buffer_putuint32(target, rdataset->ttl);
493 * Save space for rdlen.
496 isc_buffer_add(target, 2);
502 rdata = *(sorted[i].rdata);
504 dns_rdata_reset(&rdata);
505 dns_rdataset_current(rdataset, &rdata);
507 result = dns_rdata_towire(&rdata, cctx, target);
508 if (result != ISC_R_SUCCESS)
510 INSIST((target->used >= rdlen.used + 2) &&
511 (target->used - rdlen.used - 2 < 65536));
512 isc_buffer_putuint16(&rdlen,
513 (isc_uint16_t)(target->used -
521 result = ISC_R_NOMORE;
523 result = ISC_R_SUCCESS;
525 result = dns_rdataset_next(rdataset);
527 } while (result == ISC_R_SUCCESS);
529 if (result != ISC_R_NOMORE)
534 result = ISC_R_SUCCESS;
538 if (partial && result == ISC_R_NOSPACE) {
539 INSIST(rrbuffer.used < 65536);
540 dns_compress_rollback(cctx, (isc_uint16_t)rrbuffer.used);
545 INSIST(savedbuffer.used < 65536);
546 dns_compress_rollback(cctx, (isc_uint16_t)savedbuffer.used);
548 *target = savedbuffer;
551 if (sorted != NULL && sorted != sorted_fixed)
552 isc_mem_put(cctx->mctx, sorted, count * sizeof(*sorted));
553 if (shuffled != NULL && shuffled != shuffled_fixed)
554 isc_mem_put(cctx->mctx, shuffled, count * sizeof(*shuffled));
559 dns_rdataset_towiresorted(dns_rdataset_t *rdataset,
560 const dns_name_t *owner_name,
561 dns_compress_t *cctx,
562 isc_buffer_t *target,
563 dns_rdatasetorderfunc_t order,
564 const void *order_arg,
565 unsigned int options,
566 unsigned int *countp)
568 return (towiresorted(rdataset, owner_name, cctx, target,
569 order, order_arg, ISC_FALSE, options,
574 dns_rdataset_towirepartial(dns_rdataset_t *rdataset,
575 const dns_name_t *owner_name,
576 dns_compress_t *cctx,
577 isc_buffer_t *target,
578 dns_rdatasetorderfunc_t order,
579 const void *order_arg,
580 unsigned int options,
581 unsigned int *countp,
584 REQUIRE(state == NULL); /* XXX remove when implemented */
585 return (towiresorted(rdataset, owner_name, cctx, target,
586 order, order_arg, ISC_TRUE, options,
591 dns_rdataset_towire(dns_rdataset_t *rdataset,
592 dns_name_t *owner_name,
593 dns_compress_t *cctx,
594 isc_buffer_t *target,
595 unsigned int options,
596 unsigned int *countp)
598 return (towiresorted(rdataset, owner_name, cctx, target,
599 NULL, NULL, ISC_FALSE, options, countp, NULL));
603 dns_rdataset_additionaldata(dns_rdataset_t *rdataset,
604 dns_additionaldatafunc_t add, void *arg)
606 dns_rdata_t rdata = DNS_RDATA_INIT;
610 * For each rdata in rdataset, call 'add' for each name and type in the
611 * rdata which is subject to additional section processing.
614 REQUIRE(DNS_RDATASET_VALID(rdataset));
615 REQUIRE((rdataset->attributes & DNS_RDATASETATTR_QUESTION) == 0);
617 result = dns_rdataset_first(rdataset);
618 if (result != ISC_R_SUCCESS)
622 dns_rdataset_current(rdataset, &rdata);
623 result = dns_rdata_additionaldata(&rdata, add, arg);
624 if (result == ISC_R_SUCCESS)
625 result = dns_rdataset_next(rdataset);
626 dns_rdata_reset(&rdata);
627 } while (result == ISC_R_SUCCESS);
629 if (result != ISC_R_NOMORE)
632 return (ISC_R_SUCCESS);
636 dns_rdataset_addnoqname(dns_rdataset_t *rdataset, dns_name_t *name) {
638 REQUIRE(DNS_RDATASET_VALID(rdataset));
639 REQUIRE(rdataset->methods != NULL);
640 if (rdataset->methods->addnoqname == NULL)
641 return (ISC_R_NOTIMPLEMENTED);
642 return((rdataset->methods->addnoqname)(rdataset, name));
646 dns_rdataset_getnoqname(dns_rdataset_t *rdataset, dns_name_t *name,
647 dns_rdataset_t *neg, dns_rdataset_t *negsig)
649 REQUIRE(DNS_RDATASET_VALID(rdataset));
650 REQUIRE(rdataset->methods != NULL);
652 if (rdataset->methods->getnoqname == NULL)
653 return (ISC_R_NOTIMPLEMENTED);
654 return((rdataset->methods->getnoqname)(rdataset, name, neg, negsig));
658 dns_rdataset_addclosest(dns_rdataset_t *rdataset, dns_name_t *name) {
660 REQUIRE(DNS_RDATASET_VALID(rdataset));
661 REQUIRE(rdataset->methods != NULL);
662 if (rdataset->methods->addclosest == NULL)
663 return (ISC_R_NOTIMPLEMENTED);
664 return((rdataset->methods->addclosest)(rdataset, name));
668 dns_rdataset_getclosest(dns_rdataset_t *rdataset, dns_name_t *name,
669 dns_rdataset_t *neg, dns_rdataset_t *negsig)
671 REQUIRE(DNS_RDATASET_VALID(rdataset));
672 REQUIRE(rdataset->methods != NULL);
674 if (rdataset->methods->getclosest == NULL)
675 return (ISC_R_NOTIMPLEMENTED);
676 return((rdataset->methods->getclosest)(rdataset, name, neg, negsig));
680 * Additional cache stuff
683 dns_rdataset_getadditional(dns_rdataset_t *rdataset,
684 dns_rdatasetadditional_t type,
685 dns_rdatatype_t qtype,
686 dns_acache_t *acache,
689 dns_dbversion_t **versionp,
690 dns_dbnode_t **nodep,
695 REQUIRE(DNS_RDATASET_VALID(rdataset));
696 REQUIRE(rdataset->methods != NULL);
697 REQUIRE(zonep == NULL || *zonep == NULL);
698 REQUIRE(dbp != NULL && *dbp == NULL);
699 REQUIRE(versionp != NULL && *versionp == NULL);
700 REQUIRE(nodep != NULL && *nodep == NULL);
701 REQUIRE(fname != NULL);
702 REQUIRE(msg != NULL);
704 if (acache != NULL && rdataset->methods->getadditional != NULL) {
705 return ((rdataset->methods->getadditional)(rdataset, type,
712 return (ISC_R_FAILURE);
716 dns_rdataset_setadditional(dns_rdataset_t *rdataset,
717 dns_rdatasetadditional_t type,
718 dns_rdatatype_t qtype,
719 dns_acache_t *acache,
722 dns_dbversion_t *version,
726 REQUIRE(DNS_RDATASET_VALID(rdataset));
727 REQUIRE(rdataset->methods != NULL);
729 if (acache != NULL && rdataset->methods->setadditional != NULL) {
730 return ((rdataset->methods->setadditional)(rdataset, type,
736 return (ISC_R_FAILURE);
740 dns_rdataset_putadditional(dns_acache_t *acache,
741 dns_rdataset_t *rdataset,
742 dns_rdatasetadditional_t type,
743 dns_rdatatype_t qtype)
745 REQUIRE(DNS_RDATASET_VALID(rdataset));
746 REQUIRE(rdataset->methods != NULL);
748 if (acache != NULL && rdataset->methods->putadditional != NULL) {
749 return ((rdataset->methods->putadditional)(acache, rdataset,
753 return (ISC_R_FAILURE);
757 dns_rdataset_settrust(dns_rdataset_t *rdataset, dns_trust_t trust) {
758 REQUIRE(DNS_RDATASET_VALID(rdataset));
759 REQUIRE(rdataset->methods != NULL);
761 if (rdataset->methods->settrust != NULL)
762 (rdataset->methods->settrust)(rdataset, trust);
764 rdataset->trust = trust;
768 dns_rdataset_expire(dns_rdataset_t *rdataset) {
769 REQUIRE(DNS_RDATASET_VALID(rdataset));
770 REQUIRE(rdataset->methods != NULL);
772 if (rdataset->methods->expire != NULL)
773 (rdataset->methods->expire)(rdataset);