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.h,v 1.69.148.3 2011-06-08 23:02:43 each Exp $ */
20 #ifndef DNS_RDATASET_H
21 #define DNS_RDATASET_H 1
27 /*! \file dns/rdataset.h
29 * A DNS rdataset is a handle that can be associated with a collection of
30 * rdata all having a common owner name, class, and type.
32 * The dns_rdataset_t type is like a "virtual class". To actually use
33 * rdatasets, an implementation of the method suite (e.g. "slabbed rdata") is
36 * XXX <more> XXX
39 *\li Clients of this module must impose any required synchronization.
42 *\li No anticipated impact.
48 *\li No anticipated impact.
55 #include <isc/magic.h>
56 #include <isc/stdtime.h>
58 #include <dns/types.h>
63 dns_rdatasetadditional_fromauth,
64 dns_rdatasetadditional_fromcache,
65 dns_rdatasetadditional_fromglue
66 } dns_rdatasetadditional_t;
68 typedef struct dns_rdatasetmethods {
69 void (*disassociate)(dns_rdataset_t *rdataset);
70 isc_result_t (*first)(dns_rdataset_t *rdataset);
71 isc_result_t (*next)(dns_rdataset_t *rdataset);
72 void (*current)(dns_rdataset_t *rdataset,
74 void (*clone)(dns_rdataset_t *source,
75 dns_rdataset_t *target);
76 unsigned int (*count)(dns_rdataset_t *rdataset);
77 isc_result_t (*addnoqname)(dns_rdataset_t *rdataset,
79 isc_result_t (*getnoqname)(dns_rdataset_t *rdataset,
82 dns_rdataset_t *negsig);
83 isc_result_t (*addclosest)(dns_rdataset_t *rdataset,
85 isc_result_t (*getclosest)(dns_rdataset_t *rdataset,
88 dns_rdataset_t *negsig);
89 isc_result_t (*getadditional)(dns_rdataset_t *rdataset,
90 dns_rdatasetadditional_t type,
91 dns_rdatatype_t qtype,
95 dns_dbversion_t **versionp,
100 isc_result_t (*setadditional)(dns_rdataset_t *rdataset,
101 dns_rdatasetadditional_t type,
102 dns_rdatatype_t qtype,
103 dns_acache_t *acache,
106 dns_dbversion_t *version,
109 isc_result_t (*putadditional)(dns_acache_t *acache,
110 dns_rdataset_t *rdataset,
111 dns_rdatasetadditional_t type,
112 dns_rdatatype_t qtype);
113 void (*settrust)(dns_rdataset_t *rdataset,
115 void (*expire)(dns_rdataset_t *rdataset);
116 } dns_rdatasetmethods_t;
118 #define DNS_RDATASET_MAGIC ISC_MAGIC('D','N','S','R')
119 #define DNS_RDATASET_VALID(set) ISC_MAGIC_VALID(set, DNS_RDATASET_MAGIC)
122 * Direct use of this structure by clients is strongly discouraged, except
123 * for the 'link' field which may be used however the client wishes. The
124 * 'private', 'current', and 'index' fields MUST NOT be changed by clients.
125 * rdataset implementations may change any of the fields.
127 struct dns_rdataset {
128 unsigned int magic; /* XXX ? */
129 dns_rdatasetmethods_t * methods;
130 ISC_LINK(dns_rdataset_t) link;
132 * XXX do we need these, or should they be retrieved by methods?
133 * Leaning towards the latter, since they are not frequently required
134 * once you have the rdataset.
136 dns_rdataclass_t rdclass;
137 dns_rdatatype_t type;
140 dns_rdatatype_t covers;
144 unsigned int attributes;
146 * the counter provides the starting point in the "cyclic" order.
147 * The value ISC_UINT32_MAX has a special meaning of "picking up a
148 * random value." in order to take care of databases that do not
149 * increment the counter.
153 * This RRSIG RRset should be re-generated around this time.
154 * Only valid if DNS_RDATASETATTR_RESIGN is set in attributes.
156 isc_stdtime_t resign;
159 * These are for use by the rdataset implementation, and MUST NOT
160 * be changed by clients.
165 unsigned int privateuint4;
174 * \def DNS_RDATASETATTR_RENDERED
175 * Used by message.c to indicate that the rdataset was rendered.
177 * \def DNS_RDATASETATTR_TTLADJUSTED
178 * Used by message.c to indicate that the rdataset's rdata had differing
179 * TTL values, and the rdataset->ttl holds the smallest.
181 * \def DNS_RDATASETATTR_LOADORDER
182 * Output the RRset in load order.
185 #define DNS_RDATASETATTR_QUESTION 0x00000001
186 #define DNS_RDATASETATTR_RENDERED 0x00000002 /*%< Used by message.c */
187 #define DNS_RDATASETATTR_ANSWERED 0x00000004 /*%< Used by server. */
188 #define DNS_RDATASETATTR_CACHE 0x00000008 /*%< Used by resolver. */
189 #define DNS_RDATASETATTR_ANSWER 0x00000010 /*%< Used by resolver. */
190 #define DNS_RDATASETATTR_ANSWERSIG 0x00000020 /*%< Used by resolver. */
191 #define DNS_RDATASETATTR_EXTERNAL 0x00000040 /*%< Used by resolver. */
192 #define DNS_RDATASETATTR_NCACHE 0x00000080 /*%< Used by resolver. */
193 #define DNS_RDATASETATTR_CHAINING 0x00000100 /*%< Used by resolver. */
194 #define DNS_RDATASETATTR_TTLADJUSTED 0x00000200 /*%< Used by message.c */
195 #define DNS_RDATASETATTR_FIXEDORDER 0x00000400
196 #define DNS_RDATASETATTR_RANDOMIZE 0x00000800
197 #define DNS_RDATASETATTR_CHASE 0x00001000 /*%< Used by resolver. */
198 #define DNS_RDATASETATTR_NXDOMAIN 0x00002000
199 #define DNS_RDATASETATTR_NOQNAME 0x00004000
200 #define DNS_RDATASETATTR_CHECKNAMES 0x00008000 /*%< Used by resolver. */
201 #define DNS_RDATASETATTR_REQUIREDGLUE 0x00010000
202 #define DNS_RDATASETATTR_LOADORDER 0x00020000
203 #define DNS_RDATASETATTR_RESIGN 0x00040000
204 #define DNS_RDATASETATTR_CLOSEST 0x00080000
205 #define DNS_RDATASETATTR_OPTOUT 0x00100000 /*%< OPTOUT proof */
206 #define DNS_RDATASETATTR_NEGATIVE 0x00200000
210 * Omit DNSSEC records when rendering ncache records.
212 #define DNS_RDATASETTOWIRE_OMITDNSSEC 0x0001
215 dns_rdataset_init(dns_rdataset_t *rdataset);
217 * Make 'rdataset' a valid, disassociated rdataset.
220 *\li 'rdataset' is not NULL.
223 *\li 'rdataset' is a valid, disassociated rdataset.
227 dns_rdataset_invalidate(dns_rdataset_t *rdataset);
229 * Invalidate 'rdataset'.
232 *\li 'rdataset' is a valid, disassociated rdataset.
235 *\li If assertion checking is enabled, future attempts to use 'rdataset'
236 * without initializing it will cause an assertion failure.
240 dns_rdataset_disassociate(dns_rdataset_t *rdataset);
242 * Disassociate 'rdataset' from its rdata, allowing it to be reused.
245 *\li The client must ensure it has no references to rdata in the rdataset
246 * before disassociating.
249 *\li 'rdataset' is a valid, associated rdataset.
252 *\li 'rdataset' is a valid, disassociated rdataset.
256 dns_rdataset_isassociated(dns_rdataset_t *rdataset);
258 * Is 'rdataset' associated?
261 *\li 'rdataset' is a valid rdataset.
264 *\li #ISC_TRUE 'rdataset' is associated.
265 *\li #ISC_FALSE 'rdataset' is not associated.
269 dns_rdataset_makequestion(dns_rdataset_t *rdataset, dns_rdataclass_t rdclass,
270 dns_rdatatype_t type);
272 * Make 'rdataset' a valid, associated, question rdataset, with a
273 * question class of 'rdclass' and type 'type'.
276 *\li Question rdatasets have a class and type, but no rdata.
279 *\li 'rdataset' is a valid, disassociated rdataset.
282 *\li 'rdataset' is a valid, associated, question rdataset.
286 dns_rdataset_clone(dns_rdataset_t *source, dns_rdataset_t *target);
288 * Make 'target' refer to the same rdataset as 'source'.
291 *\li 'source' is a valid, associated rdataset.
293 *\li 'target' is a valid, dissociated rdataset.
296 *\li 'target' references the same rdataset as 'source'.
300 dns_rdataset_count(dns_rdataset_t *rdataset);
302 * Return the number of records in 'rdataset'.
305 *\li 'rdataset' is a valid, associated rdataset.
308 *\li The number of records in 'rdataset'.
312 dns_rdataset_first(dns_rdataset_t *rdataset);
314 * Move the rdata cursor to the first rdata in the rdataset (if any).
317 *\li 'rdataset' is a valid, associated rdataset.
321 *\li #ISC_R_NOMORE There are no rdata in the set.
325 dns_rdataset_next(dns_rdataset_t *rdataset);
327 * Move the rdata cursor to the next rdata in the rdataset (if any).
330 *\li 'rdataset' is a valid, associated rdataset.
334 *\li #ISC_R_NOMORE There are no more rdata in the set.
338 dns_rdataset_current(dns_rdataset_t *rdataset, dns_rdata_t *rdata);
340 * Make 'rdata' refer to the current rdata.
344 *\li The data returned in 'rdata' is valid for the life of the
345 * rdataset; in particular, subsequent changes in the cursor position
346 * do not invalidate 'rdata'.
349 *\li 'rdataset' is a valid, associated rdataset.
351 *\li The rdata cursor of 'rdataset' is at a valid location (i.e. the
352 * result of last call to a cursor movement command was ISC_R_SUCCESS).
355 *\li 'rdata' refers to the rdata at the rdata cursor location of
360 dns_rdataset_totext(dns_rdataset_t *rdataset,
361 dns_name_t *owner_name,
362 isc_boolean_t omit_final_dot,
363 isc_boolean_t question,
364 isc_buffer_t *target);
366 * Convert 'rdataset' to text format, storing the result in 'target'.
369 *\li The rdata cursor position will be changed.
371 *\li The 'question' flag should normally be #ISC_FALSE. If it is
372 * #ISC_TRUE, the TTL and rdata fields are not printed. This is
373 * for use when printing an rdata representing a question section.
375 *\li This interface is deprecated; use dns_master_rdatasettottext()
376 * and/or dns_master_questiontotext() instead.
379 *\li 'rdataset' is a valid rdataset.
381 *\li 'rdataset' is not empty.
385 dns_rdataset_towire(dns_rdataset_t *rdataset,
386 dns_name_t *owner_name,
387 dns_compress_t *cctx,
388 isc_buffer_t *target,
389 unsigned int options,
390 unsigned int *countp);
392 * Convert 'rdataset' to wire format, compressing names as specified
393 * in 'cctx', and storing the result in 'target'.
396 *\li The rdata cursor position will be changed.
398 *\li The number of RRs added to target will be added to *countp.
401 *\li 'rdataset' is a valid rdataset.
403 *\li 'rdataset' is not empty.
405 *\li 'countp' is a valid pointer.
408 *\li On a return of ISC_R_SUCCESS, 'target' contains a wire format
409 * for the data contained in 'rdataset'. Any error return leaves
410 * the buffer unchanged.
412 *\li *countp has been incremented by the number of RRs added to
416 *\li #ISC_R_SUCCESS - all ok
417 *\li #ISC_R_NOSPACE - 'target' doesn't have enough room
419 *\li Any error returned by dns_rdata_towire(), dns_rdataset_next(),
424 dns_rdataset_towiresorted(dns_rdataset_t *rdataset,
425 const dns_name_t *owner_name,
426 dns_compress_t *cctx,
427 isc_buffer_t *target,
428 dns_rdatasetorderfunc_t order,
429 const void *order_arg,
430 unsigned int options,
431 unsigned int *countp);
433 * Like dns_rdataset_towire(), but sorting the rdatasets according to
434 * the integer value returned by 'order' when called with the rdataset
435 * and 'order_arg' as arguments.
438 *\li All the requirements of dns_rdataset_towire(), and
439 * that order_arg is NULL if and only if order is NULL.
443 dns_rdataset_towirepartial(dns_rdataset_t *rdataset,
444 const dns_name_t *owner_name,
445 dns_compress_t *cctx,
446 isc_buffer_t *target,
447 dns_rdatasetorderfunc_t order,
448 const void *order_arg,
449 unsigned int options,
450 unsigned int *countp,
453 * Like dns_rdataset_towiresorted() except that a partial rdataset
457 *\li All the requirements of dns_rdataset_towiresorted().
458 * If 'state' is non NULL then the current position in the
459 * rdataset will be remembered if the rdataset in not
460 * completely written and should be passed on on subsequent
461 * calls (NOT CURRENTLY IMPLEMENTED).
464 *\li #ISC_R_SUCCESS if all of the records were written.
465 *\li #ISC_R_NOSPACE if unable to fit in all of the records. *countp
466 * will be updated to reflect the number of records
471 dns_rdataset_additionaldata(dns_rdataset_t *rdataset,
472 dns_additionaldatafunc_t add, void *arg);
474 * For each rdata in rdataset, call 'add' for each name and type in the
475 * rdata which is subject to additional section processing.
479 *\li 'rdataset' is a valid, non-question rdataset.
481 *\li 'add' is a valid dns_additionaldatafunc_t
485 *\li If successful, dns_rdata_additionaldata() will have been called for
486 * each rdata in 'rdataset'.
488 *\li If a call to dns_rdata_additionaldata() is not successful, the
489 * result returned will be the result of dns_rdataset_additionaldata().
495 *\li Any error that dns_rdata_additionaldata() can return.
499 dns_rdataset_getnoqname(dns_rdataset_t *rdataset, dns_name_t *name,
500 dns_rdataset_t *neg, dns_rdataset_t *negsig);
502 * Return the noqname proof for this record.
505 *\li 'rdataset' to be valid and #DNS_RDATASETATTR_NOQNAME to be set.
506 *\li 'name' to be valid.
507 *\li 'neg' and 'negsig' to be valid and not associated.
511 dns_rdataset_addnoqname(dns_rdataset_t *rdataset, dns_name_t *name);
513 * Associate a noqname proof with this record.
514 * Sets #DNS_RDATASETATTR_NOQNAME if successful.
515 * Adjusts the 'rdataset->ttl' to minimum of the 'rdataset->ttl' and
516 * the 'nsec'/'nsec3' and 'rrsig(nsec)'/'rrsig(nsec3)' ttl.
519 *\li 'rdataset' to be valid and #DNS_RDATASETATTR_NOQNAME to be set.
520 *\li 'name' to be valid and have NSEC or NSEC3 and associated RRSIG
525 dns_rdataset_getclosest(dns_rdataset_t *rdataset, dns_name_t *name,
526 dns_rdataset_t *nsec, dns_rdataset_t *nsecsig);
528 * Return the closest encloser for this record.
531 *\li 'rdataset' to be valid and #DNS_RDATASETATTR_CLOSEST to be set.
532 *\li 'name' to be valid.
533 *\li 'nsec' and 'nsecsig' to be valid and not associated.
537 dns_rdataset_addclosest(dns_rdataset_t *rdataset, dns_name_t *name);
539 * Associate a closest encloset proof with this record.
540 * Sets #DNS_RDATASETATTR_CLOSEST if successful.
541 * Adjusts the 'rdataset->ttl' to minimum of the 'rdataset->ttl' and
542 * the 'nsec' and 'rrsig(nsec)' ttl.
545 *\li 'rdataset' to be valid and #DNS_RDATASETATTR_CLOSEST to be set.
546 *\li 'name' to be valid and have NSEC3 and RRSIG(NSEC3) rdatasets.
550 dns_rdataset_getadditional(dns_rdataset_t *rdataset,
551 dns_rdatasetadditional_t type,
552 dns_rdatatype_t qtype,
553 dns_acache_t *acache,
556 dns_dbversion_t **versionp,
557 dns_dbnode_t **nodep,
562 * Get cached additional information from the DB node for a particular
563 * 'rdataset.' 'type' is one of dns_rdatasetadditional_fromauth,
564 * dns_rdatasetadditional_fromcache, and dns_rdatasetadditional_fromglue,
565 * which specifies the origin of the information. 'qtype' is intended to
566 * be used for specifying a particular rdata type in the cached information.
569 * \li 'rdataset' is a valid rdataset.
570 * \li 'acache' can be NULL, in which case this function will simply return
572 * \li For the other pointers, see dns_acache_getentry().
575 * \li See dns_acache_getentry().
579 * \li #ISC_R_FAILURE - additional information caching is not supported.
580 * \li #ISC_R_NOTFOUND - the corresponding DB node has not cached additional
581 * information for 'rdataset.'
582 * \li Any error that dns_acache_getentry() can return.
586 dns_rdataset_setadditional(dns_rdataset_t *rdataset,
587 dns_rdatasetadditional_t type,
588 dns_rdatatype_t qtype,
589 dns_acache_t *acache,
592 dns_dbversion_t *version,
596 * Set cached additional information to the DB node for a particular
597 * 'rdataset.' See dns_rdataset_getadditional for the semantics of 'type'
601 * \li 'rdataset' is a valid rdataset.
602 * \li 'acache' can be NULL, in which case this function will simply return
604 * \li For the other pointers, see dns_acache_setentry().
607 * \li See dns_acache_setentry().
611 * \li #ISC_R_FAILURE - additional information caching is not supported.
612 * \li #ISC_R_NOMEMORY
613 * \li Any error that dns_acache_setentry() can return.
617 dns_rdataset_putadditional(dns_acache_t *acache,
618 dns_rdataset_t *rdataset,
619 dns_rdatasetadditional_t type,
620 dns_rdatatype_t qtype);
622 * Discard cached additional information stored in the DB node for a particular
623 * 'rdataset.' See dns_rdataset_getadditional for the semantics of 'type'
627 * \li 'rdataset' is a valid rdataset.
628 * \li 'acache' can be NULL, in which case this function will simply return
632 * \li See dns_acache_cancelentry().
636 * \li #ISC_R_FAILURE - additional information caching is not supported.
637 * \li #ISC_R_NOTFOUND - the corresponding DB node has not cached additional
638 * information for 'rdataset.'
642 dns_rdataset_settrust(dns_rdataset_t *rdataset, dns_trust_t trust);
644 * Set the trust of the 'rdataset' to trust in any in the backing database.
645 * The local trust level of 'rdataset' is also set.
649 dns_rdataset_expire(dns_rdataset_t *rdataset);
651 * Mark the rdataset to be expired in the backing database.
655 dns_trust_totext(dns_trust_t trust);
657 * Display trust in textual form.
662 #endif /* DNS_RDATASET_H */