2 * Copyright (C) 2004-2007, 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.62.128.2 2009/01/19 23:47:03 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 *nsecsig);
83 isc_result_t (*getadditional)(dns_rdataset_t *rdataset,
84 dns_rdatasetadditional_t type,
85 dns_rdatatype_t qtype,
89 dns_dbversion_t **versionp,
94 isc_result_t (*setadditional)(dns_rdataset_t *rdataset,
95 dns_rdatasetadditional_t type,
96 dns_rdatatype_t qtype,
100 dns_dbversion_t *version,
103 isc_result_t (*putadditional)(dns_acache_t *acache,
104 dns_rdataset_t *rdataset,
105 dns_rdatasetadditional_t type,
106 dns_rdatatype_t qtype);
107 } dns_rdatasetmethods_t;
109 #define DNS_RDATASET_MAGIC ISC_MAGIC('D','N','S','R')
110 #define DNS_RDATASET_VALID(set) ISC_MAGIC_VALID(set, DNS_RDATASET_MAGIC)
113 * Direct use of this structure by clients is strongly discouraged, except
114 * for the 'link' field which may be used however the client wishes. The
115 * 'private', 'current', and 'index' fields MUST NOT be changed by clients.
116 * rdataset implementations may change any of the fields.
118 struct dns_rdataset {
119 unsigned int magic; /* XXX ? */
120 dns_rdatasetmethods_t * methods;
121 ISC_LINK(dns_rdataset_t) link;
123 * XXX do we need these, or should they be retrieved by methods?
124 * Leaning towards the latter, since they are not frequently required
125 * once you have the rdataset.
127 dns_rdataclass_t rdclass;
128 dns_rdatatype_t type;
131 dns_rdatatype_t covers;
135 unsigned int attributes;
137 * the counter provides the starting point in the "cyclic" order.
138 * The value ISC_UINT32_MAX has a special meaning of "picking up a
139 * random value." in order to take care of databases that do not
140 * increment the counter.
145 * These are for use by the rdataset implementation, and MUST NOT
146 * be changed by clients.
151 unsigned int privateuint4;
158 * \def DNS_RDATASETATTR_RENDERED
159 * Used by message.c to indicate that the rdataset was rendered.
161 * \def DNS_RDATASETATTR_TTLADJUSTED
162 * Used by message.c to indicate that the rdataset's rdata had differing
163 * TTL values, and the rdataset->ttl holds the smallest.
165 * \def DNS_RDATASETATTR_LOADORDER
166 * Output the RRset in load order.
169 #define DNS_RDATASETATTR_QUESTION 0x00000001
170 #define DNS_RDATASETATTR_RENDERED 0x00000002 /*%< Used by message.c */
171 #define DNS_RDATASETATTR_ANSWERED 0x00000004 /*%< Used by server. */
172 #define DNS_RDATASETATTR_CACHE 0x00000008 /*%< Used by resolver. */
173 #define DNS_RDATASETATTR_ANSWER 0x00000010 /*%< Used by resolver. */
174 #define DNS_RDATASETATTR_ANSWERSIG 0x00000020 /*%< Used by resolver. */
175 #define DNS_RDATASETATTR_EXTERNAL 0x00000040 /*%< Used by resolver. */
176 #define DNS_RDATASETATTR_NCACHE 0x00000080 /*%< Used by resolver. */
177 #define DNS_RDATASETATTR_CHAINING 0x00000100 /*%< Used by resolver. */
178 #define DNS_RDATASETATTR_TTLADJUSTED 0x00000200 /*%< Used by message.c */
179 #define DNS_RDATASETATTR_FIXEDORDER 0x00000400
180 #define DNS_RDATASETATTR_RANDOMIZE 0x00000800
181 #define DNS_RDATASETATTR_CHASE 0x00001000 /*%< Used by resolver. */
182 #define DNS_RDATASETATTR_NXDOMAIN 0x00002000
183 #define DNS_RDATASETATTR_NOQNAME 0x00004000
184 #define DNS_RDATASETATTR_CHECKNAMES 0x00008000 /*%< Used by resolver. */
185 #define DNS_RDATASETATTR_REQUIREDGLUE 0x00010000
186 #define DNS_RDATASETATTR_LOADORDER 0x00020000
190 * Omit DNSSEC records when rendering ncache records.
192 #define DNS_RDATASETTOWIRE_OMITDNSSEC 0x0001
195 dns_rdataset_init(dns_rdataset_t *rdataset);
197 * Make 'rdataset' a valid, disassociated rdataset.
200 *\li 'rdataset' is not NULL.
203 *\li 'rdataset' is a valid, disassociated rdataset.
207 dns_rdataset_invalidate(dns_rdataset_t *rdataset);
209 * Invalidate 'rdataset'.
212 *\li 'rdataset' is a valid, disassociated rdataset.
215 *\li If assertion checking is enabled, future attempts to use 'rdataset'
216 * without initializing it will cause an assertion failure.
220 dns_rdataset_disassociate(dns_rdataset_t *rdataset);
222 * Disassociate 'rdataset' from its rdata, allowing it to be reused.
225 *\li The client must ensure it has no references to rdata in the rdataset
226 * before disassociating.
229 *\li 'rdataset' is a valid, associated rdataset.
232 *\li 'rdataset' is a valid, disassociated rdataset.
236 dns_rdataset_isassociated(dns_rdataset_t *rdataset);
238 * Is 'rdataset' associated?
241 *\li 'rdataset' is a valid rdataset.
244 *\li #ISC_TRUE 'rdataset' is associated.
245 *\li #ISC_FALSE 'rdataset' is not associated.
249 dns_rdataset_makequestion(dns_rdataset_t *rdataset, dns_rdataclass_t rdclass,
250 dns_rdatatype_t type);
252 * Make 'rdataset' a valid, associated, question rdataset, with a
253 * question class of 'rdclass' and type 'type'.
256 *\li Question rdatasets have a class and type, but no rdata.
259 *\li 'rdataset' is a valid, disassociated rdataset.
262 *\li 'rdataset' is a valid, associated, question rdataset.
266 dns_rdataset_clone(dns_rdataset_t *source, dns_rdataset_t *target);
268 * Make 'target' refer to the same rdataset as 'source'.
271 *\li 'source' is a valid, associated rdataset.
273 *\li 'target' is a valid, dissociated rdataset.
276 *\li 'target' references the same rdataset as 'source'.
280 dns_rdataset_count(dns_rdataset_t *rdataset);
282 * Return the number of records in 'rdataset'.
285 *\li 'rdataset' is a valid, associated rdataset.
288 *\li The number of records in 'rdataset'.
292 dns_rdataset_first(dns_rdataset_t *rdataset);
294 * Move the rdata cursor to the first rdata in the rdataset (if any).
297 *\li 'rdataset' is a valid, associated rdataset.
301 *\li #ISC_R_NOMORE There are no rdata in the set.
305 dns_rdataset_next(dns_rdataset_t *rdataset);
307 * Move the rdata cursor to the next rdata in the rdataset (if any).
310 *\li 'rdataset' is a valid, associated rdataset.
314 *\li #ISC_R_NOMORE There are no more rdata in the set.
318 dns_rdataset_current(dns_rdataset_t *rdataset, dns_rdata_t *rdata);
320 * Make 'rdata' refer to the current rdata.
324 *\li The data returned in 'rdata' is valid for the life of the
325 * rdataset; in particular, subsequent changes in the cursor position
326 * do not invalidate 'rdata'.
329 *\li 'rdataset' is a valid, associated rdataset.
331 *\li The rdata cursor of 'rdataset' is at a valid location (i.e. the
332 * result of last call to a cursor movement command was ISC_R_SUCCESS).
335 *\li 'rdata' refers to the rdata at the rdata cursor location of
340 dns_rdataset_totext(dns_rdataset_t *rdataset,
341 dns_name_t *owner_name,
342 isc_boolean_t omit_final_dot,
343 isc_boolean_t question,
344 isc_buffer_t *target);
346 * Convert 'rdataset' to text format, storing the result in 'target'.
349 *\li The rdata cursor position will be changed.
351 *\li The 'question' flag should normally be #ISC_FALSE. If it is
352 * #ISC_TRUE, the TTL and rdata fields are not printed. This is
353 * for use when printing an rdata representing a question section.
355 *\li This interface is deprecated; use dns_master_rdatasettottext()
356 * and/or dns_master_questiontotext() instead.
359 *\li 'rdataset' is a valid rdataset.
361 *\li 'rdataset' is not empty.
365 dns_rdataset_towire(dns_rdataset_t *rdataset,
366 dns_name_t *owner_name,
367 dns_compress_t *cctx,
368 isc_buffer_t *target,
369 unsigned int options,
370 unsigned int *countp);
372 * Convert 'rdataset' to wire format, compressing names as specified
373 * in 'cctx', and storing the result in 'target'.
376 *\li The rdata cursor position will be changed.
378 *\li The number of RRs added to target will be added to *countp.
381 *\li 'rdataset' is a valid rdataset.
383 *\li 'rdataset' is not empty.
385 *\li 'countp' is a valid pointer.
388 *\li On a return of ISC_R_SUCCESS, 'target' contains a wire format
389 * for the data contained in 'rdataset'. Any error return leaves
390 * the buffer unchanged.
392 *\li *countp has been incremented by the number of RRs added to
396 *\li #ISC_R_SUCCESS - all ok
397 *\li #ISC_R_NOSPACE - 'target' doesn't have enough room
399 *\li Any error returned by dns_rdata_towire(), dns_rdataset_next(),
404 dns_rdataset_towiresorted(dns_rdataset_t *rdataset,
405 const dns_name_t *owner_name,
406 dns_compress_t *cctx,
407 isc_buffer_t *target,
408 dns_rdatasetorderfunc_t order,
409 const void *order_arg,
410 unsigned int options,
411 unsigned int *countp);
413 * Like dns_rdataset_towire(), but sorting the rdatasets according to
414 * the integer value returned by 'order' when called with the rdataset
415 * and 'order_arg' as arguments.
418 *\li All the requirements of dns_rdataset_towire(), and
419 * that order_arg is NULL if and only if order is NULL.
423 dns_rdataset_towirepartial(dns_rdataset_t *rdataset,
424 const dns_name_t *owner_name,
425 dns_compress_t *cctx,
426 isc_buffer_t *target,
427 dns_rdatasetorderfunc_t order,
428 const void *order_arg,
429 unsigned int options,
430 unsigned int *countp,
433 * Like dns_rdataset_towiresorted() except that a partial rdataset
437 *\li All the requirements of dns_rdataset_towiresorted().
438 * If 'state' is non NULL then the current position in the
439 * rdataset will be remembered if the rdataset in not
440 * completely written and should be passed on on subsequent
441 * calls (NOT CURRENTLY IMPLEMENTED).
444 *\li #ISC_R_SUCCESS if all of the records were written.
445 *\li #ISC_R_NOSPACE if unable to fit in all of the records. *countp
446 * will be updated to reflect the number of records
451 dns_rdataset_additionaldata(dns_rdataset_t *rdataset,
452 dns_additionaldatafunc_t add, void *arg);
454 * For each rdata in rdataset, call 'add' for each name and type in the
455 * rdata which is subject to additional section processing.
459 *\li 'rdataset' is a valid, non-question rdataset.
461 *\li 'add' is a valid dns_additionaldatafunc_t
465 *\li If successful, dns_rdata_additionaldata() will have been called for
466 * each rdata in 'rdataset'.
468 *\li If a call to dns_rdata_additionaldata() is not successful, the
469 * result returned will be the result of dns_rdataset_additionaldata().
475 *\li Any error that dns_rdata_additionaldata() can return.
479 dns_rdataset_getnoqname(dns_rdataset_t *rdataset, dns_name_t *name,
480 dns_rdataset_t *nsec, dns_rdataset_t *nsecsig);
482 * Return the noqname proof for this record.
485 *\li 'rdataset' to be valid and #DNS_RDATASETATTR_NOQNAME to be set.
486 *\li 'name' to be valid.
487 *\li 'nsec' and 'nsecsig' to be valid and not associated.
491 dns_rdataset_addnoqname(dns_rdataset_t *rdataset, dns_name_t *name);
493 * Associate a noqname proof with this record.
494 * Sets #DNS_RDATASETATTR_NOQNAME if successful.
495 * Adjusts the 'rdataset->ttl' to minimum of the 'rdataset->ttl' and
496 * the 'nsec' and 'rrsig(nsec)' ttl.
499 *\li 'rdataset' to be valid and #DNS_RDATASETATTR_NOQNAME to be set.
500 *\li 'name' to be valid and have NSEC and RRSIG(NSEC) rdatasets.
504 dns_rdataset_getadditional(dns_rdataset_t *rdataset,
505 dns_rdatasetadditional_t type,
506 dns_rdatatype_t qtype,
507 dns_acache_t *acache,
510 dns_dbversion_t **versionp,
511 dns_dbnode_t **nodep,
516 * Get cached additional information from the DB node for a particular
517 * 'rdataset.' 'type' is one of dns_rdatasetadditional_fromauth,
518 * dns_rdatasetadditional_fromcache, and dns_rdatasetadditional_fromglue,
519 * which specifies the origin of the information. 'qtype' is intended to
520 * be used for specifying a particular rdata type in the cached information.
523 * \li 'rdataset' is a valid rdataset.
524 * \li 'acache' can be NULL, in which case this function will simply return
526 * \li For the other pointers, see dns_acache_getentry().
529 * \li See dns_acache_getentry().
533 * \li #ISC_R_FAILURE - additional information caching is not supported.
534 * \li #ISC_R_NOTFOUND - the corresponding DB node has not cached additional
535 * information for 'rdataset.'
536 * \li Any error that dns_acache_getentry() can return.
540 dns_rdataset_setadditional(dns_rdataset_t *rdataset,
541 dns_rdatasetadditional_t type,
542 dns_rdatatype_t qtype,
543 dns_acache_t *acache,
546 dns_dbversion_t *version,
550 * Set cached additional information to the DB node for a particular
551 * 'rdataset.' See dns_rdataset_getadditional for the semantics of 'type'
555 * \li 'rdataset' is a valid rdataset.
556 * \li 'acache' can be NULL, in which case this function will simply return
558 * \li For the other pointers, see dns_acache_setentry().
561 * \li See dns_acache_setentry().
565 * \li #ISC_R_FAILURE - additional information caching is not supported.
566 * \li #ISC_R_NOMEMORY
567 * \li Any error that dns_acache_setentry() can return.
571 dns_rdataset_putadditional(dns_acache_t *acache,
572 dns_rdataset_t *rdataset,
573 dns_rdatasetadditional_t type,
574 dns_rdatatype_t qtype);
576 * Discard cached additional information stored in the DB node for a particular
577 * 'rdataset.' See dns_rdataset_getadditional for the semantics of 'type'
581 * \li 'rdataset' is a valid rdataset.
582 * \li 'acache' can be NULL, in which case this function will simply return
586 * \li See dns_acache_cancelentry().
590 * \li #ISC_R_FAILURE - additional information caching is not supported.
591 * \li #ISC_R_NOTFOUND - the corresponding DB node has not cached additional
592 * information for 'rdataset.'
597 #endif /* DNS_RDATASET_H */