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.h,v 1.65.50.2 2009/01/18 23:47:41 tbox 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 } dns_rdatasetmethods_t;
115 #define DNS_RDATASET_MAGIC ISC_MAGIC('D','N','S','R')
116 #define DNS_RDATASET_VALID(set) ISC_MAGIC_VALID(set, DNS_RDATASET_MAGIC)
119 * Direct use of this structure by clients is strongly discouraged, except
120 * for the 'link' field which may be used however the client wishes. The
121 * 'private', 'current', and 'index' fields MUST NOT be changed by clients.
122 * rdataset implementations may change any of the fields.
124 struct dns_rdataset {
125 unsigned int magic; /* XXX ? */
126 dns_rdatasetmethods_t * methods;
127 ISC_LINK(dns_rdataset_t) link;
129 * XXX do we need these, or should they be retrieved by methods?
130 * Leaning towards the latter, since they are not frequently required
131 * once you have the rdataset.
133 dns_rdataclass_t rdclass;
134 dns_rdatatype_t type;
137 dns_rdatatype_t covers;
141 unsigned int attributes;
143 * the counter provides the starting point in the "cyclic" order.
144 * The value ISC_UINT32_MAX has a special meaning of "picking up a
145 * random value." in order to take care of databases that do not
146 * increment the counter.
150 * This RRSIG RRset should be re-generated around this time.
151 * Only valid if DNS_RDATASETATTR_RESIGN is set in attributes.
153 isc_stdtime_t resign;
156 * These are for use by the rdataset implementation, and MUST NOT
157 * be changed by clients.
162 unsigned int privateuint4;
171 * \def DNS_RDATASETATTR_RENDERED
172 * Used by message.c to indicate that the rdataset was rendered.
174 * \def DNS_RDATASETATTR_TTLADJUSTED
175 * Used by message.c to indicate that the rdataset's rdata had differing
176 * TTL values, and the rdataset->ttl holds the smallest.
178 * \def DNS_RDATASETATTR_LOADORDER
179 * Output the RRset in load order.
182 #define DNS_RDATASETATTR_QUESTION 0x00000001
183 #define DNS_RDATASETATTR_RENDERED 0x00000002 /*%< Used by message.c */
184 #define DNS_RDATASETATTR_ANSWERED 0x00000004 /*%< Used by server. */
185 #define DNS_RDATASETATTR_CACHE 0x00000008 /*%< Used by resolver. */
186 #define DNS_RDATASETATTR_ANSWER 0x00000010 /*%< Used by resolver. */
187 #define DNS_RDATASETATTR_ANSWERSIG 0x00000020 /*%< Used by resolver. */
188 #define DNS_RDATASETATTR_EXTERNAL 0x00000040 /*%< Used by resolver. */
189 #define DNS_RDATASETATTR_NCACHE 0x00000080 /*%< Used by resolver. */
190 #define DNS_RDATASETATTR_CHAINING 0x00000100 /*%< Used by resolver. */
191 #define DNS_RDATASETATTR_TTLADJUSTED 0x00000200 /*%< Used by message.c */
192 #define DNS_RDATASETATTR_FIXEDORDER 0x00000400
193 #define DNS_RDATASETATTR_RANDOMIZE 0x00000800
194 #define DNS_RDATASETATTR_CHASE 0x00001000 /*%< Used by resolver. */
195 #define DNS_RDATASETATTR_NXDOMAIN 0x00002000
196 #define DNS_RDATASETATTR_NOQNAME 0x00004000
197 #define DNS_RDATASETATTR_CHECKNAMES 0x00008000 /*%< Used by resolver. */
198 #define DNS_RDATASETATTR_REQUIREDGLUE 0x00010000
199 #define DNS_RDATASETATTR_LOADORDER 0x00020000
200 #define DNS_RDATASETATTR_RESIGN 0x00040000
201 #define DNS_RDATASETATTR_CLOSEST 0x00080000
202 #define DNS_RDATASETATTR_OPTOUT 0x00100000 /*%< OPTOUT proof */
206 * Omit DNSSEC records when rendering ncache records.
208 #define DNS_RDATASETTOWIRE_OMITDNSSEC 0x0001
211 dns_rdataset_init(dns_rdataset_t *rdataset);
213 * Make 'rdataset' a valid, disassociated rdataset.
216 *\li 'rdataset' is not NULL.
219 *\li 'rdataset' is a valid, disassociated rdataset.
223 dns_rdataset_invalidate(dns_rdataset_t *rdataset);
225 * Invalidate 'rdataset'.
228 *\li 'rdataset' is a valid, disassociated rdataset.
231 *\li If assertion checking is enabled, future attempts to use 'rdataset'
232 * without initializing it will cause an assertion failure.
236 dns_rdataset_disassociate(dns_rdataset_t *rdataset);
238 * Disassociate 'rdataset' from its rdata, allowing it to be reused.
241 *\li The client must ensure it has no references to rdata in the rdataset
242 * before disassociating.
245 *\li 'rdataset' is a valid, associated rdataset.
248 *\li 'rdataset' is a valid, disassociated rdataset.
252 dns_rdataset_isassociated(dns_rdataset_t *rdataset);
254 * Is 'rdataset' associated?
257 *\li 'rdataset' is a valid rdataset.
260 *\li #ISC_TRUE 'rdataset' is associated.
261 *\li #ISC_FALSE 'rdataset' is not associated.
265 dns_rdataset_makequestion(dns_rdataset_t *rdataset, dns_rdataclass_t rdclass,
266 dns_rdatatype_t type);
268 * Make 'rdataset' a valid, associated, question rdataset, with a
269 * question class of 'rdclass' and type 'type'.
272 *\li Question rdatasets have a class and type, but no rdata.
275 *\li 'rdataset' is a valid, disassociated rdataset.
278 *\li 'rdataset' is a valid, associated, question rdataset.
282 dns_rdataset_clone(dns_rdataset_t *source, dns_rdataset_t *target);
284 * Make 'target' refer to the same rdataset as 'source'.
287 *\li 'source' is a valid, associated rdataset.
289 *\li 'target' is a valid, dissociated rdataset.
292 *\li 'target' references the same rdataset as 'source'.
296 dns_rdataset_count(dns_rdataset_t *rdataset);
298 * Return the number of records in 'rdataset'.
301 *\li 'rdataset' is a valid, associated rdataset.
304 *\li The number of records in 'rdataset'.
308 dns_rdataset_first(dns_rdataset_t *rdataset);
310 * Move the rdata cursor to the first rdata in the rdataset (if any).
313 *\li 'rdataset' is a valid, associated rdataset.
317 *\li #ISC_R_NOMORE There are no rdata in the set.
321 dns_rdataset_next(dns_rdataset_t *rdataset);
323 * Move the rdata cursor to the next rdata in the rdataset (if any).
326 *\li 'rdataset' is a valid, associated rdataset.
330 *\li #ISC_R_NOMORE There are no more rdata in the set.
334 dns_rdataset_current(dns_rdataset_t *rdataset, dns_rdata_t *rdata);
336 * Make 'rdata' refer to the current rdata.
340 *\li The data returned in 'rdata' is valid for the life of the
341 * rdataset; in particular, subsequent changes in the cursor position
342 * do not invalidate 'rdata'.
345 *\li 'rdataset' is a valid, associated rdataset.
347 *\li The rdata cursor of 'rdataset' is at a valid location (i.e. the
348 * result of last call to a cursor movement command was ISC_R_SUCCESS).
351 *\li 'rdata' refers to the rdata at the rdata cursor location of
356 dns_rdataset_totext(dns_rdataset_t *rdataset,
357 dns_name_t *owner_name,
358 isc_boolean_t omit_final_dot,
359 isc_boolean_t question,
360 isc_buffer_t *target);
362 * Convert 'rdataset' to text format, storing the result in 'target'.
365 *\li The rdata cursor position will be changed.
367 *\li The 'question' flag should normally be #ISC_FALSE. If it is
368 * #ISC_TRUE, the TTL and rdata fields are not printed. This is
369 * for use when printing an rdata representing a question section.
371 *\li This interface is deprecated; use dns_master_rdatasettottext()
372 * and/or dns_master_questiontotext() instead.
375 *\li 'rdataset' is a valid rdataset.
377 *\li 'rdataset' is not empty.
381 dns_rdataset_towire(dns_rdataset_t *rdataset,
382 dns_name_t *owner_name,
383 dns_compress_t *cctx,
384 isc_buffer_t *target,
385 unsigned int options,
386 unsigned int *countp);
388 * Convert 'rdataset' to wire format, compressing names as specified
389 * in 'cctx', and storing the result in 'target'.
392 *\li The rdata cursor position will be changed.
394 *\li The number of RRs added to target will be added to *countp.
397 *\li 'rdataset' is a valid rdataset.
399 *\li 'rdataset' is not empty.
401 *\li 'countp' is a valid pointer.
404 *\li On a return of ISC_R_SUCCESS, 'target' contains a wire format
405 * for the data contained in 'rdataset'. Any error return leaves
406 * the buffer unchanged.
408 *\li *countp has been incremented by the number of RRs added to
412 *\li #ISC_R_SUCCESS - all ok
413 *\li #ISC_R_NOSPACE - 'target' doesn't have enough room
415 *\li Any error returned by dns_rdata_towire(), dns_rdataset_next(),
420 dns_rdataset_towiresorted(dns_rdataset_t *rdataset,
421 const dns_name_t *owner_name,
422 dns_compress_t *cctx,
423 isc_buffer_t *target,
424 dns_rdatasetorderfunc_t order,
425 const void *order_arg,
426 unsigned int options,
427 unsigned int *countp);
429 * Like dns_rdataset_towire(), but sorting the rdatasets according to
430 * the integer value returned by 'order' when called with the rdataset
431 * and 'order_arg' as arguments.
434 *\li All the requirements of dns_rdataset_towire(), and
435 * that order_arg is NULL if and only if order is NULL.
439 dns_rdataset_towirepartial(dns_rdataset_t *rdataset,
440 const dns_name_t *owner_name,
441 dns_compress_t *cctx,
442 isc_buffer_t *target,
443 dns_rdatasetorderfunc_t order,
444 const void *order_arg,
445 unsigned int options,
446 unsigned int *countp,
449 * Like dns_rdataset_towiresorted() except that a partial rdataset
453 *\li All the requirements of dns_rdataset_towiresorted().
454 * If 'state' is non NULL then the current position in the
455 * rdataset will be remembered if the rdataset in not
456 * completely written and should be passed on on subsequent
457 * calls (NOT CURRENTLY IMPLEMENTED).
460 *\li #ISC_R_SUCCESS if all of the records were written.
461 *\li #ISC_R_NOSPACE if unable to fit in all of the records. *countp
462 * will be updated to reflect the number of records
467 dns_rdataset_additionaldata(dns_rdataset_t *rdataset,
468 dns_additionaldatafunc_t add, void *arg);
470 * For each rdata in rdataset, call 'add' for each name and type in the
471 * rdata which is subject to additional section processing.
475 *\li 'rdataset' is a valid, non-question rdataset.
477 *\li 'add' is a valid dns_additionaldatafunc_t
481 *\li If successful, dns_rdata_additionaldata() will have been called for
482 * each rdata in 'rdataset'.
484 *\li If a call to dns_rdata_additionaldata() is not successful, the
485 * result returned will be the result of dns_rdataset_additionaldata().
491 *\li Any error that dns_rdata_additionaldata() can return.
495 dns_rdataset_getnoqname(dns_rdataset_t *rdataset, dns_name_t *name,
496 dns_rdataset_t *neg, dns_rdataset_t *negsig);
498 * Return the noqname proof for this record.
501 *\li 'rdataset' to be valid and #DNS_RDATASETATTR_NOQNAME to be set.
502 *\li 'name' to be valid.
503 *\li 'neg' and 'negsig' to be valid and not associated.
507 dns_rdataset_addnoqname(dns_rdataset_t *rdataset, dns_name_t *name);
509 * Associate a noqname proof with this record.
510 * Sets #DNS_RDATASETATTR_NOQNAME if successful.
511 * Adjusts the 'rdataset->ttl' to minimum of the 'rdataset->ttl' and
512 * the 'nsec'/'nsec3' and 'rrsig(nsec)'/'rrsig(nsec3)' ttl.
515 *\li 'rdataset' to be valid and #DNS_RDATASETATTR_NOQNAME to be set.
516 *\li 'name' to be valid and have NSEC or NSEC3 and associated RRSIG
521 dns_rdataset_getclosest(dns_rdataset_t *rdataset, dns_name_t *name,
522 dns_rdataset_t *nsec, dns_rdataset_t *nsecsig);
524 * Return the closest encloser for this record.
527 *\li 'rdataset' to be valid and #DNS_RDATASETATTR_CLOSEST to be set.
528 *\li 'name' to be valid.
529 *\li 'nsec' and 'nsecsig' to be valid and not associated.
533 dns_rdataset_addclosest(dns_rdataset_t *rdataset, dns_name_t *name);
535 * Associate a closest encloset proof with this record.
536 * Sets #DNS_RDATASETATTR_CLOSEST if successful.
537 * Adjusts the 'rdataset->ttl' to minimum of the 'rdataset->ttl' and
538 * the 'nsec' and 'rrsig(nsec)' ttl.
541 *\li 'rdataset' to be valid and #DNS_RDATASETATTR_CLOSEST to be set.
542 *\li 'name' to be valid and have NSEC3 and RRSIG(NSEC3) rdatasets.
546 dns_rdataset_getadditional(dns_rdataset_t *rdataset,
547 dns_rdatasetadditional_t type,
548 dns_rdatatype_t qtype,
549 dns_acache_t *acache,
552 dns_dbversion_t **versionp,
553 dns_dbnode_t **nodep,
558 * Get cached additional information from the DB node for a particular
559 * 'rdataset.' 'type' is one of dns_rdatasetadditional_fromauth,
560 * dns_rdatasetadditional_fromcache, and dns_rdatasetadditional_fromglue,
561 * which specifies the origin of the information. 'qtype' is intended to
562 * be used for specifying a particular rdata type in the cached information.
565 * \li 'rdataset' is a valid rdataset.
566 * \li 'acache' can be NULL, in which case this function will simply return
568 * \li For the other pointers, see dns_acache_getentry().
571 * \li See dns_acache_getentry().
575 * \li #ISC_R_FAILURE - additional information caching is not supported.
576 * \li #ISC_R_NOTFOUND - the corresponding DB node has not cached additional
577 * information for 'rdataset.'
578 * \li Any error that dns_acache_getentry() can return.
582 dns_rdataset_setadditional(dns_rdataset_t *rdataset,
583 dns_rdatasetadditional_t type,
584 dns_rdatatype_t qtype,
585 dns_acache_t *acache,
588 dns_dbversion_t *version,
592 * Set cached additional information to the DB node for a particular
593 * 'rdataset.' See dns_rdataset_getadditional for the semantics of 'type'
597 * \li 'rdataset' is a valid rdataset.
598 * \li 'acache' can be NULL, in which case this function will simply return
600 * \li For the other pointers, see dns_acache_setentry().
603 * \li See dns_acache_setentry().
607 * \li #ISC_R_FAILURE - additional information caching is not supported.
608 * \li #ISC_R_NOMEMORY
609 * \li Any error that dns_acache_setentry() can return.
613 dns_rdataset_putadditional(dns_acache_t *acache,
614 dns_rdataset_t *rdataset,
615 dns_rdatasetadditional_t type,
616 dns_rdatatype_t qtype);
618 * Discard cached additional information stored in the DB node for a particular
619 * 'rdataset.' See dns_rdataset_getadditional for the semantics of 'type'
623 * \li 'rdataset' is a valid rdataset.
624 * \li 'acache' can be NULL, in which case this function will simply return
628 * \li See dns_acache_cancelentry().
632 * \li #ISC_R_FAILURE - additional information caching is not supported.
633 * \li #ISC_R_NOTFOUND - the corresponding DB node has not cached additional
634 * information for 'rdataset.'
639 #endif /* DNS_RDATASET_H */