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: db.h,v 1.89.128.5 2009/01/19 00:01:11 marka Exp $ */
29 * The DNS DB interface allows named rdatasets to be stored and retrieved.
31 * The dns_db_t type is like a "virtual class". To actually use
32 * DBs, an implementation of the class is required.
37 * \li The module ensures appropriate synchronization of data structures it
38 * creates and manipulates.
41 * \li No anticipated impact.
47 * \li No anticipated impact.
58 #include <isc/magic.h>
59 #include <isc/ondestroy.h>
60 #include <isc/stdtime.h>
63 #include <dns/types.h>
71 typedef struct dns_dbmethods {
72 void (*attach)(dns_db_t *source, dns_db_t **targetp);
73 void (*detach)(dns_db_t **dbp);
74 isc_result_t (*beginload)(dns_db_t *db, dns_addrdatasetfunc_t *addp,
75 dns_dbload_t **dbloadp);
76 isc_result_t (*endload)(dns_db_t *db, dns_dbload_t **dbloadp);
77 isc_result_t (*dump)(dns_db_t *db, dns_dbversion_t *version,
79 dns_masterformat_t masterformat);
80 void (*currentversion)(dns_db_t *db,
81 dns_dbversion_t **versionp);
82 isc_result_t (*newversion)(dns_db_t *db,
83 dns_dbversion_t **versionp);
84 void (*attachversion)(dns_db_t *db, dns_dbversion_t *source,
85 dns_dbversion_t **targetp);
86 void (*closeversion)(dns_db_t *db,
87 dns_dbversion_t **versionp,
88 isc_boolean_t commit);
89 isc_result_t (*findnode)(dns_db_t *db, dns_name_t *name,
91 dns_dbnode_t **nodep);
92 isc_result_t (*find)(dns_db_t *db, dns_name_t *name,
93 dns_dbversion_t *version,
94 dns_rdatatype_t type, unsigned int options,
96 dns_dbnode_t **nodep, dns_name_t *foundname,
97 dns_rdataset_t *rdataset,
98 dns_rdataset_t *sigrdataset);
99 isc_result_t (*findzonecut)(dns_db_t *db, dns_name_t *name,
100 unsigned int options, isc_stdtime_t now,
101 dns_dbnode_t **nodep,
102 dns_name_t *foundname,
103 dns_rdataset_t *rdataset,
104 dns_rdataset_t *sigrdataset);
105 void (*attachnode)(dns_db_t *db,
106 dns_dbnode_t *source,
107 dns_dbnode_t **targetp);
108 void (*detachnode)(dns_db_t *db,
109 dns_dbnode_t **targetp);
110 isc_result_t (*expirenode)(dns_db_t *db, dns_dbnode_t *node,
112 void (*printnode)(dns_db_t *db, dns_dbnode_t *node,
114 isc_result_t (*createiterator)(dns_db_t *db,
115 isc_boolean_t relative_names,
116 dns_dbiterator_t **iteratorp);
117 isc_result_t (*findrdataset)(dns_db_t *db, dns_dbnode_t *node,
118 dns_dbversion_t *version,
119 dns_rdatatype_t type,
120 dns_rdatatype_t covers,
122 dns_rdataset_t *rdataset,
123 dns_rdataset_t *sigrdataset);
124 isc_result_t (*allrdatasets)(dns_db_t *db, dns_dbnode_t *node,
125 dns_dbversion_t *version,
127 dns_rdatasetiter_t **iteratorp);
128 isc_result_t (*addrdataset)(dns_db_t *db, dns_dbnode_t *node,
129 dns_dbversion_t *version,
131 dns_rdataset_t *rdataset,
132 unsigned int options,
133 dns_rdataset_t *addedrdataset);
134 isc_result_t (*subtractrdataset)(dns_db_t *db, dns_dbnode_t *node,
135 dns_dbversion_t *version,
136 dns_rdataset_t *rdataset,
137 unsigned int options,
138 dns_rdataset_t *newrdataset);
139 isc_result_t (*deleterdataset)(dns_db_t *db, dns_dbnode_t *node,
140 dns_dbversion_t *version,
141 dns_rdatatype_t type,
142 dns_rdatatype_t covers);
143 isc_boolean_t (*issecure)(dns_db_t *db);
144 unsigned int (*nodecount)(dns_db_t *db);
145 isc_boolean_t (*ispersistent)(dns_db_t *db);
146 void (*overmem)(dns_db_t *db, isc_boolean_t overmem);
147 void (*settask)(dns_db_t *db, isc_task_t *);
148 isc_result_t (*getoriginnode)(dns_db_t *db, dns_dbnode_t **nodep);
149 void (*transfernode)(dns_db_t *db, dns_dbnode_t **sourcep,
150 dns_dbnode_t **targetp);
151 dns_stats_t *(*getrrsetstats)(dns_db_t *db);
155 (*dns_dbcreatefunc_t)(isc_mem_t *mctx, dns_name_t *name,
156 dns_dbtype_t type, dns_rdataclass_t rdclass,
157 unsigned int argc, char *argv[], void *driverarg,
160 #define DNS_DB_MAGIC ISC_MAGIC('D','N','S','D')
161 #define DNS_DB_VALID(db) ISC_MAGIC_VALID(db, DNS_DB_MAGIC)
164 * This structure is actually just the common prefix of a DNS db
165 * implementation's version of a dns_db_t.
167 * Direct use of this structure by clients is forbidden. DB implementations
168 * may change the structure. 'magic' must be DNS_DB_MAGIC for any of the
169 * dns_db_ routines to work. DB implementations must maintain all DB
174 unsigned int impmagic;
175 dns_dbmethods_t * methods;
176 isc_uint16_t attributes;
177 dns_rdataclass_t rdclass;
179 isc_ondestroy_t ondest;
183 #define DNS_DBATTR_CACHE 0x01
184 #define DNS_DBATTR_STUB 0x02
188 * Options that can be specified for dns_db_find().
190 #define DNS_DBFIND_GLUEOK 0x01
191 #define DNS_DBFIND_VALIDATEGLUE 0x02
192 #define DNS_DBFIND_NOWILD 0x04
193 #define DNS_DBFIND_PENDINGOK 0x08
194 #define DNS_DBFIND_NOEXACT 0x10
195 #define DNS_DBFIND_FORCENSEC 0x20
196 #define DNS_DBFIND_COVERINGNSEC 0x40
201 * Options that can be specified for dns_db_addrdataset().
203 #define DNS_DBADD_MERGE 0x01
204 #define DNS_DBADD_FORCE 0x02
205 #define DNS_DBADD_EXACT 0x04
206 #define DNS_DBADD_EXACTTTL 0x08
210 * Options that can be specified for dns_db_subtractrdataset().
212 #define DNS_DBSUB_EXACT 0x01
223 dns_db_create(isc_mem_t *mctx, const char *db_type, dns_name_t *origin,
224 dns_dbtype_t type, dns_rdataclass_t rdclass,
225 unsigned int argc, char *argv[], dns_db_t **dbp);
227 * Create a new database using implementation 'db_type'.
230 * \li All names in the database must be subdomains of 'origin' and in class
231 * 'rdclass'. The database makes its own copy of the origin, so the
232 * caller may do whatever they like with 'origin' and its storage once the
235 * \li DB implementation-specific parameters are passed using argc and argv.
239 * \li dbp != NULL and *dbp == NULL
241 * \li 'origin' is a valid absolute domain name.
243 * \li mctx is a valid memory context
247 * \li A copy of 'origin' has been made for the databases use, and the
248 * caller is free to do whatever they want with the name and storage
249 * associated with 'origin'.
254 * \li #ISC_R_NOMEMORY
255 * \li #ISC_R_NOTFOUND db_type not found
257 * \li Many other errors are possible, depending on what db_type was
262 dns_db_attach(dns_db_t *source, dns_db_t **targetp);
264 * Attach *targetp to source.
268 * \li 'source' is a valid database.
270 * \li 'targetp' points to a NULL dns_db_t *.
274 * \li *targetp is attached to source.
278 dns_db_detach(dns_db_t **dbp);
280 * Detach *dbp from its database.
284 * \li 'dbp' points to a valid database.
290 * \li If '*dbp' is the last reference to the database,
291 * all resources used by the database will be freed
295 dns_db_ondestroy(dns_db_t *db, isc_task_t *task, isc_event_t **eventp);
297 * Causes 'eventp' to be sent to be sent to 'task' when the database is
300 * Note; ownership of the eventp is taken from the caller (and *eventp is
301 * set to NULL). The sender field of the event is set to 'db' before it is
306 dns_db_iscache(dns_db_t *db);
308 * Does 'db' have cache semantics?
312 * \li 'db' is a valid database.
315 * \li #ISC_TRUE 'db' has cache semantics
316 * \li #ISC_FALSE otherwise
320 dns_db_iszone(dns_db_t *db);
322 * Does 'db' have zone semantics?
326 * \li 'db' is a valid database.
329 * \li #ISC_TRUE 'db' has zone semantics
330 * \li #ISC_FALSE otherwise
334 dns_db_isstub(dns_db_t *db);
336 * Does 'db' have stub semantics?
340 * \li 'db' is a valid database.
343 * \li #ISC_TRUE 'db' has zone semantics
344 * \li #ISC_FALSE otherwise
348 dns_db_issecure(dns_db_t *db);
354 * \li 'db' is a valid database with zone semantics.
357 * \li #ISC_TRUE 'db' is secure.
358 * \li #ISC_FALSE 'db' is not secure.
362 dns_db_origin(dns_db_t *db);
364 * The origin of the database.
366 * Note: caller must not try to change this name.
370 * \li 'db' is a valid database.
374 * \li The origin of the database.
378 dns_db_class(dns_db_t *db);
380 * The class of the database.
384 * \li 'db' is a valid database.
388 * \li The class of the database.
392 dns_db_beginload(dns_db_t *db, dns_addrdatasetfunc_t *addp,
393 dns_dbload_t **dbloadp);
395 * Begin loading 'db'.
399 * \li 'db' is a valid database.
401 * \li This is the first attempt to load 'db'.
403 * \li addp != NULL && *addp == NULL
405 * \li dbloadp != NULL && *dbloadp == NULL
409 * \li On success, *addp will be a valid dns_addrdatasetfunc_t suitable
410 * for loading 'db'. *dbloadp will be a valid DB load context which
411 * should be used as 'arg' when *addp is called.
416 * \li #ISC_R_NOMEMORY
418 * \li Other results are possible, depending upon the database
419 * implementation used, syntax errors in the master file, etc.
423 dns_db_endload(dns_db_t *db, dns_dbload_t **dbloadp);
425 * Finish loading 'db'.
429 * \li 'db' is a valid database that is being loaded.
431 * \li dbloadp != NULL and *dbloadp is a valid database load context.
435 * \li *dbloadp == NULL
440 * \li #ISC_R_NOMEMORY
442 * \li Other results are possible, depending upon the database
443 * implementation used, syntax errors in the master file, etc.
447 dns_db_load(dns_db_t *db, const char *filename);
450 dns_db_load2(dns_db_t *db, const char *filename, dns_masterformat_t format);
452 * Load master file 'filename' into 'db'.
455 * \li This routine is equivalent to calling
458 * dns_db_beginload();
459 * dns_master_loadfile();
465 * \li 'db' is a valid database.
467 * \li This is the first attempt to load 'db'.
472 * \li #ISC_R_NOMEMORY
474 * \li Other results are possible, depending upon the database
475 * implementation used, syntax errors in the master file, etc.
479 dns_db_dump(dns_db_t *db, dns_dbversion_t *version, const char *filename);
482 dns_db_dump2(dns_db_t *db, dns_dbversion_t *version, const char *filename,
483 dns_masterformat_t masterformat);
485 * Dump version 'version' of 'db' to master file 'filename'.
489 * \li 'db' is a valid database.
491 * \li 'version' is a valid version.
496 * \li #ISC_R_NOMEMORY
498 * \li Other results are possible, depending upon the database
499 * implementation used, OS file errors, etc.
507 dns_db_currentversion(dns_db_t *db, dns_dbversion_t **versionp);
509 * Open the current version for reading.
513 * \li 'db' is a valid database with zone semantics.
515 * \li versionp != NULL && *verisonp == NULL
519 * \li On success, '*versionp' is attached to the current version.
524 dns_db_newversion(dns_db_t *db, dns_dbversion_t **versionp);
526 * Open a new version for reading and writing.
530 * \li 'db' is a valid database with zone semantics.
532 * \li versionp != NULL && *verisonp == NULL
536 * \li On success, '*versionp' is attached to the current version.
541 * \li #ISC_R_NOMEMORY
543 * \li Other results are possible, depending upon the database
544 * implementation used.
548 dns_db_attachversion(dns_db_t *db, dns_dbversion_t *source,
549 dns_dbversion_t **targetp);
551 * Attach '*targetp' to 'source'.
555 * \li 'db' is a valid database with zone semantics.
557 * \li source is a valid open version
559 * \li targetp != NULL && *targetp == NULL
563 * \li '*targetp' is attached to source.
567 dns_db_closeversion(dns_db_t *db, dns_dbversion_t **versionp,
568 isc_boolean_t commit);
570 * Close version '*versionp'.
572 * Note: if '*versionp' is a read-write version and 'commit' is ISC_TRUE,
573 * then all changes made in the version will take effect, otherwise they
574 * will be rolled back. The value if 'commit' is ignored for read-only
579 * \li 'db' is a valid database with zone semantics.
581 * \li '*versionp' refers to a valid version.
583 * \li If committing a writable version, then there must be no other
584 * outstanding references to the version (e.g. an active rdataset
589 * \li *versionp == NULL
591 * \li If *versionp is a read-write version, and commit is ISC_TRUE, then
592 * the version will become the current version. If !commit, then all
593 * changes made in the version will be undone, and the version will
594 * not become the current version.
602 dns_db_findnode(dns_db_t *db, dns_name_t *name, isc_boolean_t create,
603 dns_dbnode_t **nodep);
605 * Find the node with name 'name'.
608 * \li If 'create' is ISC_TRUE and no node with name 'name' exists, then
609 * such a node will be created.
611 * \li This routine is for finding or creating a node with the specified
612 * name. There are no partial matches. It is not suitable for use
613 * in building responses to ordinary DNS queries; clients which wish
614 * to do that should use dns_db_find() instead.
618 * \li 'db' is a valid database.
620 * \li 'name' is a valid, non-empty, absolute name.
622 * \li nodep != NULL && *nodep == NULL
626 * \li On success, *nodep is attached to the node with name 'name'.
631 * \li #ISC_R_NOTFOUND If !create and name not found.
632 * \li #ISC_R_NOMEMORY Can only happen if create is ISC_TRUE.
634 * \li Other results are possible, depending upon the database
635 * implementation used.
639 dns_db_find(dns_db_t *db, dns_name_t *name, dns_dbversion_t *version,
640 dns_rdatatype_t type, unsigned int options, isc_stdtime_t now,
641 dns_dbnode_t **nodep, dns_name_t *foundname,
642 dns_rdataset_t *rdataset, dns_rdataset_t *sigrdataset);
644 * Find the best match for 'name' and 'type' in version 'version' of 'db'.
648 * \li If type == dns_rdataset_any, then rdataset will not be bound.
650 * \li If 'options' does not have #DNS_DBFIND_GLUEOK set, then no glue will
651 * be returned. For zone databases, glue is as defined in RFC2181.
652 * For cache databases, glue is any rdataset with a trust of
655 * \li If 'options' does not have #DNS_DBFIND_PENDINGOK set, then no
656 * pending data will be returned. This option is only meaningful for
659 * \li If the #DNS_DBFIND_NOWILD option is set, then wildcard matching will
660 * be disabled. This option is only meaningful for zone databases.
662 * \li If the #DNS_DBFIND_FORCENSEC option is set, the database is assumed to
663 * have NSEC records, and these will be returned when appropriate. This
664 * is only necessary when querying a database that was not secure
667 * \li If the DNS_DBFIND_COVERINGNSEC option is set, then look for a
668 * NSEC record that potentially covers 'name' if a answer cannot
669 * be found. Note the returned NSEC needs to be checked to ensure
670 * that it is correct. This only affects answers returned from the
673 * \li To respond to a query for SIG records, the caller should create a
674 * rdataset iterator and extract the signatures from each rdataset.
676 * \li Making queries of type ANY with #DNS_DBFIND_GLUEOK is not recommended,
677 * because the burden of determining whether a given rdataset is valid
678 * glue or not falls upon the caller.
680 * \li The 'now' field is ignored if 'db' is a zone database. If 'db' is a
681 * cache database, an rdataset will not be found unless it expires after
682 * 'now'. Any ANY query will not match unless at least one rdataset at
683 * the node expires after 'now'. If 'now' is zero, then the current time
688 * \li 'db' is a valid database.
690 * \li 'type' is not SIG, or a meta-RR type other than 'ANY' (e.g. 'OPT').
692 * \li 'nodep' is NULL, or nodep is a valid pointer and *nodep == NULL.
694 * \li 'foundname' is a valid name with a dedicated buffer.
696 * \li 'rdataset' is NULL, or is a valid unassociated rdataset.
699 * on a non-error completion:
701 * \li If nodep != NULL, then it is bound to the found node.
703 * \li If foundname != NULL, then it contains the full name of the
706 * \li If rdataset != NULL and type != dns_rdatatype_any, then
707 * rdataset is bound to the found rdataset.
709 * Non-error results are:
711 * \li #ISC_R_SUCCESS The desired node and type were
714 * \li #DNS_R_WILDCARD The desired node and type were
715 * found after performing
716 * wildcard matching. This is
717 * only returned if the
718 * #DNS_DBFIND_INDICATEWILD
719 * option is set; otherwise
720 * #ISC_R_SUCCESS is returned.
722 * \li #DNS_R_GLUE The desired node and type were
723 * found, but are glue. This
724 * result can only occur if
725 * the DNS_DBFIND_GLUEOK option
726 * is set. This result can only
727 * occur if 'db' is a zone
728 * database. If type ==
729 * dns_rdatatype_any, then the
730 * node returned may contain, or
731 * consist entirely of invalid
732 * glue (i.e. data occluded by a
733 * zone cut). The caller must
734 * take care not to return invalid
737 * \li #DNS_R_DELEGATION The data requested is beneath
738 * a zone cut. node, foundname,
739 * and rdataset reference the
740 * NS RRset of the zone cut.
741 * If 'db' is a cache database,
742 * then this is the deepest known
745 * \li #DNS_R_ZONECUT type == dns_rdatatype_any, and
746 * the desired node is a zonecut.
747 * The caller must take care not
748 * to return inappropriate glue
749 * to a client. This result can
750 * only occur if 'db' is a zone
751 * database and DNS_DBFIND_GLUEOK
754 * \li #DNS_R_DNAME The data requested is beneath
755 * a DNAME. node, foundname,
756 * and rdataset reference the
759 * \li #DNS_R_CNAME The rdataset requested was not
760 * found, but there is a CNAME
761 * at the desired name. node,
762 * foundname, and rdataset
763 * reference the CNAME RRset.
765 * \li #DNS_R_NXDOMAIN The desired name does not
768 * \li #DNS_R_NXRRSET The desired name exists, but
769 * the desired type does not.
771 * \li #ISC_R_NOTFOUND The desired name does not
772 * exist, and no delegation could
773 * be found. This result can only
774 * occur if 'db' is a cache
775 * database. The caller should
776 * use its nameserver(s) of last
777 * resort (e.g. root hints).
779 * \li #DNS_R_NCACHENXDOMAIN The desired name does not
780 * exist. 'node' is bound to the
781 * cache node with the desired
782 * name, and 'rdataset' contains
783 * the negative caching proof.
785 * \li #DNS_R_NCACHENXRRSET The desired type does not
786 * exist. 'node' is bound to the
787 * cache node with the desired
788 * name, and 'rdataset' contains
789 * the negative caching proof.
791 * \li #DNS_R_EMPTYNAME The name exists but there is
792 * no data at the name.
794 * \li #DNS_R_COVERINGNSEC The returned data is a NSEC
795 * that potentially covers 'name'.
799 * \li #ISC_R_NOMEMORY
801 * \li #DNS_R_BADDB Data that is required to be
802 * present in the DB, e.g. an NSEC
803 * record in a secure zone, is not
806 * \li Other results are possible, and should all be treated as
811 dns_db_findzonecut(dns_db_t *db, dns_name_t *name,
812 unsigned int options, isc_stdtime_t now,
813 dns_dbnode_t **nodep, dns_name_t *foundname,
814 dns_rdataset_t *rdataset, dns_rdataset_t *sigrdataset);
816 * Find the deepest known zonecut which encloses 'name' in 'db'.
820 * \li If the #DNS_DBFIND_NOEXACT option is set, then the zonecut returned
821 * (if any) will be the deepest known ancestor of 'name'.
823 * \li If 'now' is zero, then the current time will be used.
827 * \li 'db' is a valid database with cache semantics.
829 * \li 'nodep' is NULL, or nodep is a valid pointer and *nodep == NULL.
831 * \li 'foundname' is a valid name with a dedicated buffer.
833 * \li 'rdataset' is NULL, or is a valid unassociated rdataset.
835 * Ensures, on a non-error completion:
837 * \li If nodep != NULL, then it is bound to the found node.
839 * \li If foundname != NULL, then it contains the full name of the
842 * \li If rdataset != NULL and type != dns_rdatatype_any, then
843 * rdataset is bound to the found rdataset.
845 * Non-error results are:
849 * \li #ISC_R_NOTFOUND
851 * \li Other results are possible, and should all be treated as
856 dns_db_attachnode(dns_db_t *db, dns_dbnode_t *source, dns_dbnode_t **targetp);
858 * Attach *targetp to source.
862 * \li 'db' is a valid database.
864 * \li 'source' is a valid node.
866 * \li 'targetp' points to a NULL dns_dbnode_t *.
870 * \li *targetp is attached to source.
874 dns_db_detachnode(dns_db_t *db, dns_dbnode_t **nodep);
876 * Detach *nodep from its node.
880 * \li 'db' is a valid database.
882 * \li 'nodep' points to a valid node.
886 * \li *nodep is NULL.
890 dns_db_transfernode(dns_db_t *db, dns_dbnode_t **sourcep,
891 dns_dbnode_t **targetp);
893 * Transfer a node between pointer.
895 * This is equivalent to calling dns_db_attachnode() then dns_db_detachnode().
899 * \li 'db' is a valid database.
901 * \li '*sourcep' is a valid node.
903 * \li 'targetp' points to a NULL dns_dbnode_t *.
907 * \li '*sourcep' is NULL.
911 dns_db_expirenode(dns_db_t *db, dns_dbnode_t *node, isc_stdtime_t now);
913 * Mark as stale all records at 'node' which expire at or before 'now'.
915 * Note: if 'now' is zero, then the current time will be used.
919 * \li 'db' is a valid cache database.
921 * \li 'node' is a valid node.
925 dns_db_printnode(dns_db_t *db, dns_dbnode_t *node, FILE *out);
927 * Print a textual representation of the contents of the node to
930 * Note: this function is intended for debugging, not general use.
934 * \li 'db' is a valid database.
936 * \li 'node' is a valid node.
940 *** DB Iterator Creation
944 dns_db_createiterator(dns_db_t *db, isc_boolean_t relative_names,
945 dns_dbiterator_t **iteratorp);
947 * Create an iterator for version 'version' of 'db'.
951 * \li If 'relative_names' is ISC_TRUE, then node names returned by the
952 * iterator will be relative to the iterator's current origin. If
953 * #ISC_FALSE, then the node names will be absolute.
957 * \li 'db' is a valid database.
959 * \li iteratorp != NULL && *iteratorp == NULL
963 * \li On success, *iteratorp will be a valid database iterator.
968 * \li #ISC_R_NOMEMORY
976 * XXXRTH Should we check for glue and pending data in dns_db_findrdataset()?
980 dns_db_findrdataset(dns_db_t *db, dns_dbnode_t *node, dns_dbversion_t *version,
981 dns_rdatatype_t type, dns_rdatatype_t covers,
982 isc_stdtime_t now, dns_rdataset_t *rdataset,
983 dns_rdataset_t *sigrdataset);
985 * Search for an rdataset of type 'type' at 'node' that are in version
986 * 'version' of 'db'. If found, make 'rdataset' refer to it.
990 * \li If 'version' is NULL, then the current version will be used.
992 * \li Care must be used when using this routine to build a DNS response:
993 * 'node' should have been found with dns_db_find(), not
994 * dns_db_findnode(). No glue checking is done. No checking for
995 * pending data is done.
997 * \li The 'now' field is ignored if 'db' is a zone database. If 'db' is a
998 * cache database, an rdataset will not be found unless it expires after
999 * 'now'. If 'now' is zero, then the current time will be used.
1003 * \li 'db' is a valid database.
1005 * \li 'node' is a valid node.
1007 * \li 'rdataset' is a valid, disassociated rdataset.
1009 * \li 'sigrdataset' is a valid, disassociated rdataset, or it is NULL.
1011 * \li If 'covers' != 0, 'type' must be SIG.
1013 * \li 'type' is not a meta-RR type such as 'ANY' or 'OPT'.
1017 * \li On success, 'rdataset' is associated with the found rdataset.
1021 * \li #ISC_R_SUCCESS
1022 * \li #ISC_R_NOTFOUND
1024 * \li Other results are possible, depending upon the database
1025 * implementation used.
1029 dns_db_allrdatasets(dns_db_t *db, dns_dbnode_t *node, dns_dbversion_t *version,
1030 isc_stdtime_t now, dns_rdatasetiter_t **iteratorp);
1032 * Make '*iteratorp' an rdataset iterator for all rdatasets at 'node' in
1033 * version 'version' of 'db'.
1037 * \li If 'version' is NULL, then the current version will be used.
1039 * \li The 'now' field is ignored if 'db' is a zone database. If 'db' is a
1040 * cache database, an rdataset will not be found unless it expires after
1041 * 'now'. Any ANY query will not match unless at least one rdataset at
1042 * the node expires after 'now'. If 'now' is zero, then the current time
1047 * \li 'db' is a valid database.
1049 * \li 'node' is a valid node.
1051 * \li iteratorp != NULL && *iteratorp == NULL
1055 * \li On success, '*iteratorp' is a valid rdataset iterator.
1059 * \li #ISC_R_SUCCESS
1060 * \li #ISC_R_NOTFOUND
1062 * \li Other results are possible, depending upon the database
1063 * implementation used.
1067 dns_db_addrdataset(dns_db_t *db, dns_dbnode_t *node, dns_dbversion_t *version,
1068 isc_stdtime_t now, dns_rdataset_t *rdataset,
1069 unsigned int options, dns_rdataset_t *addedrdataset);
1071 * Add 'rdataset' to 'node' in version 'version' of 'db'.
1075 * \li If the database has zone semantics, the #DNS_DBADD_MERGE option is set,
1076 * and an rdataset of the same type as 'rdataset' already exists at
1077 * 'node' then the contents of 'rdataset' will be merged with the existing
1078 * rdataset. If the option is not set, then rdataset will replace any
1079 * existing rdataset of the same type. If not merging and the
1080 * #DNS_DBADD_FORCE option is set, then the data will update the database
1081 * without regard to trust levels. If not forcing the data, then the
1082 * rdataset will only be added if its trust level is >= the trust level of
1083 * any existing rdataset. Forcing is only meaningful for cache databases.
1084 * If #DNS_DBADD_EXACT is set then there must be no rdata in common between
1085 * the old and new rdata sets. If #DNS_DBADD_EXACTTTL is set then both
1086 * the old and new rdata sets must have the same ttl.
1088 * \li The 'now' field is ignored if 'db' is a zone database. If 'db' is
1089 * a cache database, then the added rdataset will expire no later than
1090 * now + rdataset->ttl.
1092 * \li If 'addedrdataset' is not NULL, then it will be attached to the
1093 * resulting new rdataset in the database, or to the existing data if
1094 * the existing data was better.
1098 * \li 'db' is a valid database.
1100 * \li 'node' is a valid node.
1102 * \li 'rdataset' is a valid, associated rdataset with the same class
1105 * \li 'addedrdataset' is NULL, or a valid, unassociated rdataset.
1107 * \li The database has zone semantics and 'version' is a valid
1108 * read-write version, or the database has cache semantics
1109 * and version is NULL.
1111 * \li If the database has cache semantics, the #DNS_DBADD_MERGE option must
1116 * \li #ISC_R_SUCCESS
1117 * \li #DNS_R_UNCHANGED The operation did not change anything.
1118 * \li #ISC_R_NOMEMORY
1119 * \li #DNS_R_NOTEXACT
1121 * \li Other results are possible, depending upon the database
1122 * implementation used.
1126 dns_db_subtractrdataset(dns_db_t *db, dns_dbnode_t *node,
1127 dns_dbversion_t *version, dns_rdataset_t *rdataset,
1128 unsigned int options, dns_rdataset_t *newrdataset);
1130 * Remove any rdata in 'rdataset' from 'node' in version 'version' of
1135 * \li If 'newrdataset' is not NULL, then it will be attached to the
1136 * resulting new rdataset in the database, unless the rdataset has
1137 * become nonexistent. If DNS_DBSUB_EXACT is set then all elements
1138 * of 'rdataset' must exist at 'node'.
1142 * \li 'db' is a valid database.
1144 * \li 'node' is a valid node.
1146 * \li 'rdataset' is a valid, associated rdataset with the same class
1149 * \li 'newrdataset' is NULL, or a valid, unassociated rdataset.
1151 * \li The database has zone semantics and 'version' is a valid
1152 * read-write version.
1156 * \li #ISC_R_SUCCESS
1157 * \li #DNS_R_UNCHANGED The operation did not change anything.
1158 * \li #DNS_R_NXRRSET All rdata of the same type as those
1159 * in 'rdataset' have been deleted.
1160 * \li #DNS_R_NOTEXACT Some part of 'rdataset' did not
1161 * exist and DNS_DBSUB_EXACT was set.
1163 * \li Other results are possible, depending upon the database
1164 * implementation used.
1168 dns_db_deleterdataset(dns_db_t *db, dns_dbnode_t *node,
1169 dns_dbversion_t *version, dns_rdatatype_t type,
1170 dns_rdatatype_t covers);
1172 * Make it so that no rdataset of type 'type' exists at 'node' in version
1173 * version 'version' of 'db'.
1177 * \li If 'type' is dns_rdatatype_any, then no rdatasets will exist in
1178 * 'version' (provided that the dns_db_deleterdataset() isn't followed
1179 * by one or more dns_db_addrdataset() calls).
1183 * \li 'db' is a valid database.
1185 * \li 'node' is a valid node.
1187 * \li The database has zone semantics and 'version' is a valid
1188 * read-write version, or the database has cache semantics
1189 * and version is NULL.
1191 * \li 'type' is not a meta-RR type, except for dns_rdatatype_any, which is
1194 * \li If 'covers' != 0, 'type' must be SIG.
1198 * \li #ISC_R_SUCCESS
1199 * \li #DNS_R_UNCHANGED No rdatasets of 'type' existed before
1200 * the operation was attempted.
1202 * \li Other results are possible, depending upon the database
1203 * implementation used.
1207 dns_db_getsoaserial(dns_db_t *db, dns_dbversion_t *ver, isc_uint32_t *serialp);
1209 * Get the current SOA serial number from a zone database.
1212 * \li 'db' is a valid database with zone semantics.
1213 * \li 'ver' is a valid version.
1217 dns_db_overmem(dns_db_t *db, isc_boolean_t overmem);
1219 * Enable / disable aggressive cache cleaning.
1223 dns_db_nodecount(dns_db_t *db);
1225 * Count the number of nodes in 'db'.
1229 * \li 'db' is a valid database.
1232 * \li The number of nodes in the database
1236 dns_db_settask(dns_db_t *db, isc_task_t *task);
1238 * If task is set then the final detach maybe performed asynchronously.
1241 * \li 'db' is a valid database.
1242 * \li 'task' to be valid or NULL.
1246 dns_db_ispersistent(dns_db_t *db);
1248 * Is 'db' persistent? A persistent database does not need to be loaded
1249 * from disk or written to disk.
1253 * \li 'db' is a valid database.
1256 * \li #ISC_TRUE 'db' is persistent.
1257 * \li #ISC_FALSE 'db' is not persistent.
1261 dns_db_register(const char *name, dns_dbcreatefunc_t create, void *driverarg,
1262 isc_mem_t *mctx, dns_dbimplementation_t **dbimp);
1265 * Register a new database implementation and add it to the list of
1266 * supported implementations.
1270 * \li 'name' is not NULL
1271 * \li 'order' is a valid function pointer
1272 * \li 'mctx' is a valid memory context
1273 * \li dbimp != NULL && *dbimp == NULL
1276 * \li #ISC_R_SUCCESS The registration succeeded
1277 * \li #ISC_R_NOMEMORY Out of memory
1278 * \li #ISC_R_EXISTS A database implementation with the same name exists
1282 * \li *dbimp points to an opaque structure which must be passed to
1283 * dns_db_unregister().
1287 dns_db_unregister(dns_dbimplementation_t **dbimp);
1289 * Remove a database implementation from the list of supported
1290 * implementations. No databases of this type can be active when this
1294 * \li dbimp != NULL && *dbimp == NULL
1298 * \li Any memory allocated in *dbimp will be freed.
1302 dns_db_getoriginnode(dns_db_t *db, dns_dbnode_t **nodep);
1304 * Get the origin DB node corresponding to the DB's zone. This function
1305 * should typically succeed unless the underlying DB implementation doesn't
1306 * support the feature.
1310 * \li 'db' is a valid zone database.
1311 * \li 'nodep' != NULL && '*nodep' == NULL
1314 * \li On success, '*nodep' will point to the DB node of the zone's origin.
1317 * \li #ISC_R_SUCCESS
1318 * \li #ISC_R_NOTFOUND - the DB implementation does not support this feature.
1322 dns_db_getrrsetstats(dns_db_t *db);
1324 * Get statistics information counting RRsets stored in the DB, when available.
1325 * The statistics may not be available depending on the DB implementation.
1329 * \li 'db' is a valid database (zone or cache).
1332 * \li when available, a pointer to a statistics object created by
1333 * dns_rdatasetstats_create(); otherwise NULL.
1338 #endif /* DNS_DB_H */