2 * Copyright (C) 2004-2009 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.82.50.2 2009/01/18 23:47:40 tbox 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>
38 dns_rdataset_init(dns_rdataset_t *rdataset) {
41 * Make 'rdataset' a valid, disassociated rdataset.
44 REQUIRE(rdataset != NULL);
46 rdataset->magic = DNS_RDATASET_MAGIC;
47 rdataset->methods = NULL;
48 ISC_LINK_INIT(rdataset, link);
49 rdataset->rdclass = 0;
54 rdataset->attributes = 0;
55 rdataset->count = ISC_UINT32_MAX;
56 rdataset->private1 = NULL;
57 rdataset->private2 = NULL;
58 rdataset->private3 = NULL;
59 rdataset->privateuint4 = 0;
60 rdataset->private5 = NULL;
61 rdataset->private6 = NULL;
66 dns_rdataset_invalidate(dns_rdataset_t *rdataset) {
69 * Invalidate 'rdataset'.
72 REQUIRE(DNS_RDATASET_VALID(rdataset));
73 REQUIRE(rdataset->methods == NULL);
76 ISC_LINK_INIT(rdataset, link);
77 rdataset->rdclass = 0;
82 rdataset->attributes = 0;
83 rdataset->count = ISC_UINT32_MAX;
84 rdataset->private1 = NULL;
85 rdataset->private2 = NULL;
86 rdataset->private3 = NULL;
87 rdataset->privateuint4 = 0;
88 rdataset->private5 = NULL;
92 dns_rdataset_disassociate(dns_rdataset_t *rdataset) {
95 * Disassociate 'rdataset' from its rdata, allowing it to be reused.
98 REQUIRE(DNS_RDATASET_VALID(rdataset));
99 REQUIRE(rdataset->methods != NULL);
101 (rdataset->methods->disassociate)(rdataset);
102 rdataset->methods = NULL;
103 ISC_LINK_INIT(rdataset, link);
104 rdataset->rdclass = 0;
108 rdataset->covers = 0;
109 rdataset->attributes = 0;
110 rdataset->count = ISC_UINT32_MAX;
111 rdataset->private1 = NULL;
112 rdataset->private2 = NULL;
113 rdataset->private3 = NULL;
114 rdataset->privateuint4 = 0;
115 rdataset->private5 = NULL;
116 rdataset->private6 = NULL;
120 dns_rdataset_isassociated(dns_rdataset_t *rdataset) {
122 * Is 'rdataset' associated?
125 REQUIRE(DNS_RDATASET_VALID(rdataset));
127 if (rdataset->methods != NULL)
134 question_disassociate(dns_rdataset_t *rdataset) {
139 question_cursor(dns_rdataset_t *rdataset) {
142 return (ISC_R_NOMORE);
146 question_current(dns_rdataset_t *rdataset, dns_rdata_t *rdata) {
148 * This routine should never be called.
157 question_clone(dns_rdataset_t *source, dns_rdataset_t *target) {
162 question_count(dns_rdataset_t *rdataset) {
164 * This routine should never be called.
172 static dns_rdatasetmethods_t question_methods = {
173 question_disassociate,
189 dns_rdataset_makequestion(dns_rdataset_t *rdataset, dns_rdataclass_t rdclass,
190 dns_rdatatype_t type)
194 * Make 'rdataset' a valid, associated, question rdataset, with a
195 * question class of 'rdclass' and type 'type'.
198 REQUIRE(DNS_RDATASET_VALID(rdataset));
199 REQUIRE(rdataset->methods == NULL);
201 rdataset->methods = &question_methods;
202 rdataset->rdclass = rdclass;
203 rdataset->type = type;
204 rdataset->attributes |= DNS_RDATASETATTR_QUESTION;
208 dns_rdataset_count(dns_rdataset_t *rdataset) {
211 * Return the number of records in 'rdataset'.
214 REQUIRE(DNS_RDATASET_VALID(rdataset));
215 REQUIRE(rdataset->methods != NULL);
217 return ((rdataset->methods->count)(rdataset));
221 dns_rdataset_clone(dns_rdataset_t *source, dns_rdataset_t *target) {
224 * Make 'target' refer to the same rdataset as 'source'.
227 REQUIRE(DNS_RDATASET_VALID(source));
228 REQUIRE(source->methods != NULL);
229 REQUIRE(DNS_RDATASET_VALID(target));
230 REQUIRE(target->methods == NULL);
232 (source->methods->clone)(source, target);
236 dns_rdataset_first(dns_rdataset_t *rdataset) {
239 * Move the rdata cursor to the first rdata in the rdataset (if any).
242 REQUIRE(DNS_RDATASET_VALID(rdataset));
243 REQUIRE(rdataset->methods != NULL);
245 return ((rdataset->methods->first)(rdataset));
249 dns_rdataset_next(dns_rdataset_t *rdataset) {
252 * Move the rdata cursor to the next rdata in the rdataset (if any).
255 REQUIRE(DNS_RDATASET_VALID(rdataset));
256 REQUIRE(rdataset->methods != NULL);
258 return ((rdataset->methods->next)(rdataset));
262 dns_rdataset_current(dns_rdataset_t *rdataset, dns_rdata_t *rdata) {
265 * Make 'rdata' refer to the current rdata.
268 REQUIRE(DNS_RDATASET_VALID(rdataset));
269 REQUIRE(rdataset->methods != NULL);
271 (rdataset->methods->current)(rdataset, rdata);
274 #define MAX_SHUFFLE 32
275 #define WANT_FIXED(r) (((r)->attributes & DNS_RDATASETATTR_FIXEDORDER) != 0)
276 #define WANT_RANDOM(r) (((r)->attributes & DNS_RDATASETATTR_RANDOMIZE) != 0)
284 towire_compare(const void *av, const void *bv) {
285 const struct towire_sort *a = (const struct towire_sort *) av;
286 const struct towire_sort *b = (const struct towire_sort *) bv;
287 return (a->key - b->key);
291 towiresorted(dns_rdataset_t *rdataset, const dns_name_t *owner_name,
292 dns_compress_t *cctx, isc_buffer_t *target,
293 dns_rdatasetorderfunc_t order, const void *order_arg,
294 isc_boolean_t partial, unsigned int options,
295 unsigned int *countp, void **state)
297 dns_rdata_t rdata = DNS_RDATA_INIT;
300 unsigned int i, count, added, choice;
301 isc_buffer_t savedbuffer, rdlen, rrbuffer;
302 unsigned int headlen;
303 isc_boolean_t question = ISC_FALSE;
304 isc_boolean_t shuffle = ISC_FALSE;
305 dns_rdata_t *shuffled = NULL, shuffled_fixed[MAX_SHUFFLE];
306 struct towire_sort *sorted = NULL, sorted_fixed[MAX_SHUFFLE];
311 * Convert 'rdataset' to wire format, compressing names as specified
312 * in cctx, and storing the result in 'target'.
315 REQUIRE(DNS_RDATASET_VALID(rdataset));
316 REQUIRE(countp != NULL);
317 REQUIRE((order == NULL) == (order_arg == NULL));
318 REQUIRE(cctx != NULL && cctx->mctx != NULL);
321 if ((rdataset->attributes & DNS_RDATASETATTR_QUESTION) != 0) {
324 result = dns_rdataset_first(rdataset);
325 INSIST(result == ISC_R_NOMORE);
326 } else if (rdataset->type == 0) {
328 * This is a negative caching rdataset.
330 unsigned int ncache_opts = 0;
331 if ((options & DNS_RDATASETTOWIRE_OMITDNSSEC) != 0)
332 ncache_opts |= DNS_NCACHETOWIRE_OMITDNSSEC;
333 return (dns_ncache_towire(rdataset, cctx, target, ncache_opts,
336 count = (rdataset->methods->count)(rdataset);
337 result = dns_rdataset_first(rdataset);
338 if (result == ISC_R_NOMORE)
339 return (ISC_R_SUCCESS);
340 if (result != ISC_R_SUCCESS)
345 * Do we want to shuffle this answer?
347 if (!question && count > 1 &&
348 (!WANT_FIXED(rdataset) || order != NULL) &&
349 rdataset->type != dns_rdatatype_rrsig)
352 if (shuffle && count > MAX_SHUFFLE) {
353 shuffled = isc_mem_get(cctx->mctx, count * sizeof(*shuffled));
354 sorted = isc_mem_get(cctx->mctx, count * sizeof(*sorted));
355 if (shuffled == NULL || sorted == NULL)
358 shuffled = shuffled_fixed;
359 sorted = sorted_fixed;
364 * First we get handles to all of the rdata.
369 dns_rdata_init(&shuffled[i]);
370 dns_rdataset_current(rdataset, &shuffled[i]);
372 result = dns_rdataset_next(rdataset);
373 } while (result == ISC_R_SUCCESS);
374 if (result != ISC_R_NOMORE)
381 if (WANT_FIXED(rdataset)) {
385 INSIST(order != NULL);
386 for (i = 0; i < count; i++) {
387 sorted[i].key = (*order)(&shuffled[i],
389 sorted[i].rdata = &shuffled[i];
391 } else if (WANT_RANDOM(rdataset)) {
395 for (i = 0; i < count; i++) {
399 isc_random_get(&val);
400 choice = i + (val % (count - i));
402 shuffled[i] = shuffled[choice];
403 shuffled[choice] = rdata;
405 sorted[i].key = (*order)(&shuffled[i],
408 sorted[i].key = 0; /* Unused */
409 sorted[i].rdata = &shuffled[i];
418 val = rdataset->count;
419 if (val == ISC_UINT32_MAX)
420 isc_random_get(&val);
422 for (i = 0; i < count; i++) {
424 sorted[j].key = (*order)(&shuffled[i],
427 sorted[j].key = 0; /* Unused */
428 sorted[j].rdata = &shuffled[i];
431 j = 0; /* Wrap around. */
439 qsort(sorted, count, sizeof(sorted[0]),
443 savedbuffer = *target;
449 * Copy out the name, type, class, ttl.
453 dns_compress_setmethods(cctx, DNS_COMPRESS_GLOBAL14);
454 result = dns_name_towire(owner_name, cctx, target);
455 if (result != ISC_R_SUCCESS)
457 headlen = sizeof(dns_rdataclass_t) + sizeof(dns_rdatatype_t);
459 headlen += sizeof(dns_ttl_t)
460 + 2; /* XXX 2 for rdata len */
461 isc_buffer_availableregion(target, &r);
462 if (r.length < headlen) {
463 result = ISC_R_NOSPACE;
466 isc_buffer_putuint16(target, rdataset->type);
467 isc_buffer_putuint16(target, rdataset->rdclass);
469 isc_buffer_putuint32(target, rdataset->ttl);
472 * Save space for rdlen.
475 isc_buffer_add(target, 2);
481 rdata = *(sorted[i].rdata);
483 dns_rdata_reset(&rdata);
484 dns_rdataset_current(rdataset, &rdata);
486 result = dns_rdata_towire(&rdata, cctx, target);
487 if (result != ISC_R_SUCCESS)
489 INSIST((target->used >= rdlen.used + 2) &&
490 (target->used - rdlen.used - 2 < 65536));
491 isc_buffer_putuint16(&rdlen,
492 (isc_uint16_t)(target->used -
500 result = ISC_R_NOMORE;
502 result = ISC_R_SUCCESS;
504 result = dns_rdataset_next(rdataset);
506 } while (result == ISC_R_SUCCESS);
508 if (result != ISC_R_NOMORE)
513 result = ISC_R_SUCCESS;
517 if (partial && result == ISC_R_NOSPACE) {
518 INSIST(rrbuffer.used < 65536);
519 dns_compress_rollback(cctx, (isc_uint16_t)rrbuffer.used);
524 INSIST(savedbuffer.used < 65536);
525 dns_compress_rollback(cctx, (isc_uint16_t)savedbuffer.used);
527 *target = savedbuffer;
530 if (sorted != NULL && sorted != sorted_fixed)
531 isc_mem_put(cctx->mctx, sorted, count * sizeof(*sorted));
532 if (shuffled != NULL && shuffled != shuffled_fixed)
533 isc_mem_put(cctx->mctx, shuffled, count * sizeof(*shuffled));
538 dns_rdataset_towiresorted(dns_rdataset_t *rdataset,
539 const dns_name_t *owner_name,
540 dns_compress_t *cctx,
541 isc_buffer_t *target,
542 dns_rdatasetorderfunc_t order,
543 const void *order_arg,
544 unsigned int options,
545 unsigned int *countp)
547 return (towiresorted(rdataset, owner_name, cctx, target,
548 order, order_arg, ISC_FALSE, options,
553 dns_rdataset_towirepartial(dns_rdataset_t *rdataset,
554 const dns_name_t *owner_name,
555 dns_compress_t *cctx,
556 isc_buffer_t *target,
557 dns_rdatasetorderfunc_t order,
558 const void *order_arg,
559 unsigned int options,
560 unsigned int *countp,
563 REQUIRE(state == NULL); /* XXX remove when implemented */
564 return (towiresorted(rdataset, owner_name, cctx, target,
565 order, order_arg, ISC_TRUE, options,
570 dns_rdataset_towire(dns_rdataset_t *rdataset,
571 dns_name_t *owner_name,
572 dns_compress_t *cctx,
573 isc_buffer_t *target,
574 unsigned int options,
575 unsigned int *countp)
577 return (towiresorted(rdataset, owner_name, cctx, target,
578 NULL, NULL, ISC_FALSE, options, countp, NULL));
582 dns_rdataset_additionaldata(dns_rdataset_t *rdataset,
583 dns_additionaldatafunc_t add, void *arg)
585 dns_rdata_t rdata = DNS_RDATA_INIT;
589 * For each rdata in rdataset, call 'add' for each name and type in the
590 * rdata which is subject to additional section processing.
593 REQUIRE(DNS_RDATASET_VALID(rdataset));
594 REQUIRE((rdataset->attributes & DNS_RDATASETATTR_QUESTION) == 0);
596 result = dns_rdataset_first(rdataset);
597 if (result != ISC_R_SUCCESS)
601 dns_rdataset_current(rdataset, &rdata);
602 result = dns_rdata_additionaldata(&rdata, add, arg);
603 if (result == ISC_R_SUCCESS)
604 result = dns_rdataset_next(rdataset);
605 dns_rdata_reset(&rdata);
606 } while (result == ISC_R_SUCCESS);
608 if (result != ISC_R_NOMORE)
611 return (ISC_R_SUCCESS);
615 dns_rdataset_addnoqname(dns_rdataset_t *rdataset, dns_name_t *name) {
617 REQUIRE(DNS_RDATASET_VALID(rdataset));
618 REQUIRE(rdataset->methods != NULL);
619 if (rdataset->methods->addnoqname == NULL)
620 return (ISC_R_NOTIMPLEMENTED);
621 return((rdataset->methods->addnoqname)(rdataset, name));
625 dns_rdataset_getnoqname(dns_rdataset_t *rdataset, dns_name_t *name,
626 dns_rdataset_t *neg, dns_rdataset_t *negsig)
628 REQUIRE(DNS_RDATASET_VALID(rdataset));
629 REQUIRE(rdataset->methods != NULL);
631 if (rdataset->methods->getnoqname == NULL)
632 return (ISC_R_NOTIMPLEMENTED);
633 return((rdataset->methods->getnoqname)(rdataset, name, neg, negsig));
637 dns_rdataset_addclosest(dns_rdataset_t *rdataset, dns_name_t *name) {
639 REQUIRE(DNS_RDATASET_VALID(rdataset));
640 REQUIRE(rdataset->methods != NULL);
641 if (rdataset->methods->addclosest == NULL)
642 return (ISC_R_NOTIMPLEMENTED);
643 return((rdataset->methods->addclosest)(rdataset, name));
647 dns_rdataset_getclosest(dns_rdataset_t *rdataset, dns_name_t *name,
648 dns_rdataset_t *neg, dns_rdataset_t *negsig)
650 REQUIRE(DNS_RDATASET_VALID(rdataset));
651 REQUIRE(rdataset->methods != NULL);
653 if (rdataset->methods->getclosest == NULL)
654 return (ISC_R_NOTIMPLEMENTED);
655 return((rdataset->methods->getclosest)(rdataset, name, neg, negsig));
659 * Additional cache stuff
662 dns_rdataset_getadditional(dns_rdataset_t *rdataset,
663 dns_rdatasetadditional_t type,
664 dns_rdatatype_t qtype,
665 dns_acache_t *acache,
668 dns_dbversion_t **versionp,
669 dns_dbnode_t **nodep,
674 REQUIRE(DNS_RDATASET_VALID(rdataset));
675 REQUIRE(rdataset->methods != NULL);
676 REQUIRE(zonep == NULL || *zonep == NULL);
677 REQUIRE(dbp != NULL && *dbp == NULL);
678 REQUIRE(versionp != NULL && *versionp == NULL);
679 REQUIRE(nodep != NULL && *nodep == NULL);
680 REQUIRE(fname != NULL);
681 REQUIRE(msg != NULL);
683 if (acache != NULL && rdataset->methods->getadditional != NULL) {
684 return ((rdataset->methods->getadditional)(rdataset, type,
691 return (ISC_R_FAILURE);
695 dns_rdataset_setadditional(dns_rdataset_t *rdataset,
696 dns_rdatasetadditional_t type,
697 dns_rdatatype_t qtype,
698 dns_acache_t *acache,
701 dns_dbversion_t *version,
705 REQUIRE(DNS_RDATASET_VALID(rdataset));
706 REQUIRE(rdataset->methods != NULL);
708 if (acache != NULL && rdataset->methods->setadditional != NULL) {
709 return ((rdataset->methods->setadditional)(rdataset, type,
715 return (ISC_R_FAILURE);
719 dns_rdataset_putadditional(dns_acache_t *acache,
720 dns_rdataset_t *rdataset,
721 dns_rdatasetadditional_t type,
722 dns_rdatatype_t qtype)
724 REQUIRE(DNS_RDATASET_VALID(rdataset));
725 REQUIRE(rdataset->methods != NULL);
727 if (acache != NULL && rdataset->methods->putadditional != NULL) {
728 return ((rdataset->methods->putadditional)(acache, rdataset,
732 return (ISC_R_FAILURE);