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.93.50.3 2009/01/18 23:25:17 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, unsigned int options,
115 dns_dbiterator_t **iteratorp);
116 isc_result_t (*findrdataset)(dns_db_t *db, dns_dbnode_t *node,
117 dns_dbversion_t *version,
118 dns_rdatatype_t type,
119 dns_rdatatype_t covers,
121 dns_rdataset_t *rdataset,
122 dns_rdataset_t *sigrdataset);
123 isc_result_t (*allrdatasets)(dns_db_t *db, dns_dbnode_t *node,
124 dns_dbversion_t *version,
126 dns_rdatasetiter_t **iteratorp);
127 isc_result_t (*addrdataset)(dns_db_t *db, dns_dbnode_t *node,
128 dns_dbversion_t *version,
130 dns_rdataset_t *rdataset,
131 unsigned int options,
132 dns_rdataset_t *addedrdataset);
133 isc_result_t (*subtractrdataset)(dns_db_t *db, dns_dbnode_t *node,
134 dns_dbversion_t *version,
135 dns_rdataset_t *rdataset,
136 unsigned int options,
137 dns_rdataset_t *newrdataset);
138 isc_result_t (*deleterdataset)(dns_db_t *db, dns_dbnode_t *node,
139 dns_dbversion_t *version,
140 dns_rdatatype_t type,
141 dns_rdatatype_t covers);
142 isc_boolean_t (*issecure)(dns_db_t *db);
143 unsigned int (*nodecount)(dns_db_t *db);
144 isc_boolean_t (*ispersistent)(dns_db_t *db);
145 void (*overmem)(dns_db_t *db, isc_boolean_t overmem);
146 void (*settask)(dns_db_t *db, isc_task_t *);
147 isc_result_t (*getoriginnode)(dns_db_t *db, dns_dbnode_t **nodep);
148 void (*transfernode)(dns_db_t *db, dns_dbnode_t **sourcep,
149 dns_dbnode_t **targetp);
150 isc_result_t (*getnsec3parameters)(dns_db_t *db,
151 dns_dbversion_t *version,
154 isc_uint16_t *iterations,
157 isc_result_t (*findnsec3node)(dns_db_t *db, dns_name_t *name,
158 isc_boolean_t create,
159 dns_dbnode_t **nodep);
160 isc_result_t (*setsigningtime)(dns_db_t *db,
161 dns_rdataset_t *rdataset,
162 isc_stdtime_t resign);
163 isc_result_t (*getsigningtime)(dns_db_t *db,
164 dns_rdataset_t *rdataset,
166 void (*resigned)(dns_db_t *db, dns_rdataset_t *rdataset,
167 dns_dbversion_t *version);
168 isc_boolean_t (*isdnssec)(dns_db_t *db);
169 dns_stats_t *(*getrrsetstats)(dns_db_t *db);
173 (*dns_dbcreatefunc_t)(isc_mem_t *mctx, dns_name_t *name,
174 dns_dbtype_t type, dns_rdataclass_t rdclass,
175 unsigned int argc, char *argv[], void *driverarg,
178 #define DNS_DB_MAGIC ISC_MAGIC('D','N','S','D')
179 #define DNS_DB_VALID(db) ISC_MAGIC_VALID(db, DNS_DB_MAGIC)
182 * This structure is actually just the common prefix of a DNS db
183 * implementation's version of a dns_db_t.
185 * Direct use of this structure by clients is forbidden. DB implementations
186 * may change the structure. 'magic' must be DNS_DB_MAGIC for any of the
187 * dns_db_ routines to work. DB implementations must maintain all DB
192 unsigned int impmagic;
193 dns_dbmethods_t * methods;
194 isc_uint16_t attributes;
195 dns_rdataclass_t rdclass;
197 isc_ondestroy_t ondest;
201 #define DNS_DBATTR_CACHE 0x01
202 #define DNS_DBATTR_STUB 0x02
206 * Options that can be specified for dns_db_find().
208 #define DNS_DBFIND_GLUEOK 0x01
209 #define DNS_DBFIND_VALIDATEGLUE 0x02
210 #define DNS_DBFIND_NOWILD 0x04
211 #define DNS_DBFIND_PENDINGOK 0x08
212 #define DNS_DBFIND_NOEXACT 0x10
213 #define DNS_DBFIND_FORCENSEC 0x20
214 #define DNS_DBFIND_COVERINGNSEC 0x40
215 #define DNS_DBFIND_FORCENSEC3 0x80
220 * Options that can be specified for dns_db_addrdataset().
222 #define DNS_DBADD_MERGE 0x01
223 #define DNS_DBADD_FORCE 0x02
224 #define DNS_DBADD_EXACT 0x04
225 #define DNS_DBADD_EXACTTTL 0x08
229 * Options that can be specified for dns_db_subtractrdataset().
231 #define DNS_DBSUB_EXACT 0x01
237 #define DNS_DB_RELATIVENAMES 0x1
238 #define DNS_DB_NSEC3ONLY 0x2
239 #define DNS_DB_NONSEC3 0x4
251 dns_db_create(isc_mem_t *mctx, const char *db_type, dns_name_t *origin,
252 dns_dbtype_t type, dns_rdataclass_t rdclass,
253 unsigned int argc, char *argv[], dns_db_t **dbp);
255 * Create a new database using implementation 'db_type'.
258 * \li All names in the database must be subdomains of 'origin' and in class
259 * 'rdclass'. The database makes its own copy of the origin, so the
260 * caller may do whatever they like with 'origin' and its storage once the
263 * \li DB implementation-specific parameters are passed using argc and argv.
267 * \li dbp != NULL and *dbp == NULL
269 * \li 'origin' is a valid absolute domain name.
271 * \li mctx is a valid memory context
275 * \li A copy of 'origin' has been made for the databases use, and the
276 * caller is free to do whatever they want with the name and storage
277 * associated with 'origin'.
282 * \li #ISC_R_NOMEMORY
283 * \li #ISC_R_NOTFOUND db_type not found
285 * \li Many other errors are possible, depending on what db_type was
290 dns_db_attach(dns_db_t *source, dns_db_t **targetp);
292 * Attach *targetp to source.
296 * \li 'source' is a valid database.
298 * \li 'targetp' points to a NULL dns_db_t *.
302 * \li *targetp is attached to source.
306 dns_db_detach(dns_db_t **dbp);
308 * Detach *dbp from its database.
312 * \li 'dbp' points to a valid database.
318 * \li If '*dbp' is the last reference to the database,
319 * all resources used by the database will be freed
323 dns_db_ondestroy(dns_db_t *db, isc_task_t *task, isc_event_t **eventp);
325 * Causes 'eventp' to be sent to be sent to 'task' when the database is
328 * Note; ownership of the eventp is taken from the caller (and *eventp is
329 * set to NULL). The sender field of the event is set to 'db' before it is
334 dns_db_iscache(dns_db_t *db);
336 * Does 'db' have cache semantics?
340 * \li 'db' is a valid database.
343 * \li #ISC_TRUE 'db' has cache semantics
344 * \li #ISC_FALSE otherwise
348 dns_db_iszone(dns_db_t *db);
350 * Does 'db' have zone semantics?
354 * \li 'db' is a valid database.
357 * \li #ISC_TRUE 'db' has zone semantics
358 * \li #ISC_FALSE otherwise
362 dns_db_isstub(dns_db_t *db);
364 * Does 'db' have stub semantics?
368 * \li 'db' is a valid database.
371 * \li #ISC_TRUE 'db' has zone semantics
372 * \li #ISC_FALSE otherwise
376 dns_db_issecure(dns_db_t *db);
382 * \li 'db' is a valid database with zone semantics.
385 * \li #ISC_TRUE 'db' is secure.
386 * \li #ISC_FALSE 'db' is not secure.
390 dns_db_isdnssec(dns_db_t *db);
392 * Is 'db' secure or partially secure?
396 * \li 'db' is a valid database with zone semantics.
399 * \li #ISC_TRUE 'db' is secure or is partially.
400 * \li #ISC_FALSE 'db' is not secure.
404 dns_db_origin(dns_db_t *db);
406 * The origin of the database.
408 * Note: caller must not try to change this name.
412 * \li 'db' is a valid database.
416 * \li The origin of the database.
420 dns_db_class(dns_db_t *db);
422 * The class of the database.
426 * \li 'db' is a valid database.
430 * \li The class of the database.
434 dns_db_beginload(dns_db_t *db, dns_addrdatasetfunc_t *addp,
435 dns_dbload_t **dbloadp);
437 * Begin loading 'db'.
441 * \li 'db' is a valid database.
443 * \li This is the first attempt to load 'db'.
445 * \li addp != NULL && *addp == NULL
447 * \li dbloadp != NULL && *dbloadp == NULL
451 * \li On success, *addp will be a valid dns_addrdatasetfunc_t suitable
452 * for loading 'db'. *dbloadp will be a valid DB load context which
453 * should be used as 'arg' when *addp is called.
458 * \li #ISC_R_NOMEMORY
460 * \li Other results are possible, depending upon the database
461 * implementation used, syntax errors in the master file, etc.
465 dns_db_endload(dns_db_t *db, dns_dbload_t **dbloadp);
467 * Finish loading 'db'.
471 * \li 'db' is a valid database that is being loaded.
473 * \li dbloadp != NULL and *dbloadp is a valid database load context.
477 * \li *dbloadp == NULL
482 * \li #ISC_R_NOMEMORY
484 * \li Other results are possible, depending upon the database
485 * implementation used, syntax errors in the master file, etc.
489 dns_db_load(dns_db_t *db, const char *filename);
492 dns_db_load2(dns_db_t *db, const char *filename, dns_masterformat_t format);
494 * Load master file 'filename' into 'db'.
497 * \li This routine is equivalent to calling
500 * dns_db_beginload();
501 * dns_master_loadfile();
507 * \li 'db' is a valid database.
509 * \li This is the first attempt to load 'db'.
514 * \li #ISC_R_NOMEMORY
516 * \li Other results are possible, depending upon the database
517 * implementation used, syntax errors in the master file, etc.
521 dns_db_dump(dns_db_t *db, dns_dbversion_t *version, const char *filename);
524 dns_db_dump2(dns_db_t *db, dns_dbversion_t *version, const char *filename,
525 dns_masterformat_t masterformat);
527 * Dump version 'version' of 'db' to master file 'filename'.
531 * \li 'db' is a valid database.
533 * \li 'version' is a valid version.
538 * \li #ISC_R_NOMEMORY
540 * \li Other results are possible, depending upon the database
541 * implementation used, OS file errors, etc.
549 dns_db_currentversion(dns_db_t *db, dns_dbversion_t **versionp);
551 * Open the current version for reading.
555 * \li 'db' is a valid database with zone semantics.
557 * \li versionp != NULL && *verisonp == NULL
561 * \li On success, '*versionp' is attached to the current version.
566 dns_db_newversion(dns_db_t *db, dns_dbversion_t **versionp);
568 * Open a new version for reading and writing.
572 * \li 'db' is a valid database with zone semantics.
574 * \li versionp != NULL && *verisonp == NULL
578 * \li On success, '*versionp' is attached to the current version.
583 * \li #ISC_R_NOMEMORY
585 * \li Other results are possible, depending upon the database
586 * implementation used.
590 dns_db_attachversion(dns_db_t *db, dns_dbversion_t *source,
591 dns_dbversion_t **targetp);
593 * Attach '*targetp' to 'source'.
597 * \li 'db' is a valid database with zone semantics.
599 * \li source is a valid open version
601 * \li targetp != NULL && *targetp == NULL
605 * \li '*targetp' is attached to source.
609 dns_db_closeversion(dns_db_t *db, dns_dbversion_t **versionp,
610 isc_boolean_t commit);
612 * Close version '*versionp'.
614 * Note: if '*versionp' is a read-write version and 'commit' is ISC_TRUE,
615 * then all changes made in the version will take effect, otherwise they
616 * will be rolled back. The value if 'commit' is ignored for read-only
621 * \li 'db' is a valid database with zone semantics.
623 * \li '*versionp' refers to a valid version.
625 * \li If committing a writable version, then there must be no other
626 * outstanding references to the version (e.g. an active rdataset
631 * \li *versionp == NULL
633 * \li If *versionp is a read-write version, and commit is ISC_TRUE, then
634 * the version will become the current version. If !commit, then all
635 * changes made in the version will be undone, and the version will
636 * not become the current version.
644 dns_db_findnode(dns_db_t *db, dns_name_t *name, isc_boolean_t create,
645 dns_dbnode_t **nodep);
647 * Find the node with name 'name'.
650 * \li If 'create' is ISC_TRUE and no node with name 'name' exists, then
651 * such a node will be created.
653 * \li This routine is for finding or creating a node with the specified
654 * name. There are no partial matches. It is not suitable for use
655 * in building responses to ordinary DNS queries; clients which wish
656 * to do that should use dns_db_find() instead.
660 * \li 'db' is a valid database.
662 * \li 'name' is a valid, non-empty, absolute name.
664 * \li nodep != NULL && *nodep == NULL
668 * \li On success, *nodep is attached to the node with name 'name'.
673 * \li #ISC_R_NOTFOUND If !create and name not found.
674 * \li #ISC_R_NOMEMORY Can only happen if create is ISC_TRUE.
676 * \li Other results are possible, depending upon the database
677 * implementation used.
681 dns_db_find(dns_db_t *db, dns_name_t *name, dns_dbversion_t *version,
682 dns_rdatatype_t type, unsigned int options, isc_stdtime_t now,
683 dns_dbnode_t **nodep, dns_name_t *foundname,
684 dns_rdataset_t *rdataset, dns_rdataset_t *sigrdataset);
686 * Find the best match for 'name' and 'type' in version 'version' of 'db'.
690 * \li If type == dns_rdataset_any, then rdataset will not be bound.
692 * \li If 'options' does not have #DNS_DBFIND_GLUEOK set, then no glue will
693 * be returned. For zone databases, glue is as defined in RFC2181.
694 * For cache databases, glue is any rdataset with a trust of
697 * \li If 'options' does not have #DNS_DBFIND_PENDINGOK set, then no
698 * pending data will be returned. This option is only meaningful for
701 * \li If the #DNS_DBFIND_NOWILD option is set, then wildcard matching will
702 * be disabled. This option is only meaningful for zone databases.
704 * \li If the #DNS_DBFIND_FORCENSEC option is set, the database is assumed to
705 * have NSEC records, and these will be returned when appropriate. This
706 * is only necessary when querying a database that was not secure
709 * \li If the DNS_DBFIND_COVERINGNSEC option is set, then look for a
710 * NSEC record that potentially covers 'name' if a answer cannot
711 * be found. Note the returned NSEC needs to be checked to ensure
712 * that it is correct. This only affects answers returned from the
715 * \li To respond to a query for SIG records, the caller should create a
716 * rdataset iterator and extract the signatures from each rdataset.
718 * \li Making queries of type ANY with #DNS_DBFIND_GLUEOK is not recommended,
719 * because the burden of determining whether a given rdataset is valid
720 * glue or not falls upon the caller.
722 * \li The 'now' field is ignored if 'db' is a zone database. If 'db' is a
723 * cache database, an rdataset will not be found unless it expires after
724 * 'now'. Any ANY query will not match unless at least one rdataset at
725 * the node expires after 'now'. If 'now' is zero, then the current time
730 * \li 'db' is a valid database.
732 * \li 'type' is not SIG, or a meta-RR type other than 'ANY' (e.g. 'OPT').
734 * \li 'nodep' is NULL, or nodep is a valid pointer and *nodep == NULL.
736 * \li 'foundname' is a valid name with a dedicated buffer.
738 * \li 'rdataset' is NULL, or is a valid unassociated rdataset.
741 * on a non-error completion:
743 * \li If nodep != NULL, then it is bound to the found node.
745 * \li If foundname != NULL, then it contains the full name of the
748 * \li If rdataset != NULL and type != dns_rdatatype_any, then
749 * rdataset is bound to the found rdataset.
751 * Non-error results are:
753 * \li #ISC_R_SUCCESS The desired node and type were
756 * \li #DNS_R_WILDCARD The desired node and type were
757 * found after performing
758 * wildcard matching. This is
759 * only returned if the
760 * #DNS_DBFIND_INDICATEWILD
761 * option is set; otherwise
762 * #ISC_R_SUCCESS is returned.
764 * \li #DNS_R_GLUE The desired node and type were
765 * found, but are glue. This
766 * result can only occur if
767 * the DNS_DBFIND_GLUEOK option
768 * is set. This result can only
769 * occur if 'db' is a zone
770 * database. If type ==
771 * dns_rdatatype_any, then the
772 * node returned may contain, or
773 * consist entirely of invalid
774 * glue (i.e. data occluded by a
775 * zone cut). The caller must
776 * take care not to return invalid
779 * \li #DNS_R_DELEGATION The data requested is beneath
780 * a zone cut. node, foundname,
781 * and rdataset reference the
782 * NS RRset of the zone cut.
783 * If 'db' is a cache database,
784 * then this is the deepest known
787 * \li #DNS_R_ZONECUT type == dns_rdatatype_any, and
788 * the desired node is a zonecut.
789 * The caller must take care not
790 * to return inappropriate glue
791 * to a client. This result can
792 * only occur if 'db' is a zone
793 * database and DNS_DBFIND_GLUEOK
796 * \li #DNS_R_DNAME The data requested is beneath
797 * a DNAME. node, foundname,
798 * and rdataset reference the
801 * \li #DNS_R_CNAME The rdataset requested was not
802 * found, but there is a CNAME
803 * at the desired name. node,
804 * foundname, and rdataset
805 * reference the CNAME RRset.
807 * \li #DNS_R_NXDOMAIN The desired name does not
810 * \li #DNS_R_NXRRSET The desired name exists, but
811 * the desired type does not.
813 * \li #ISC_R_NOTFOUND The desired name does not
814 * exist, and no delegation could
815 * be found. This result can only
816 * occur if 'db' is a cache
817 * database. The caller should
818 * use its nameserver(s) of last
819 * resort (e.g. root hints).
821 * \li #DNS_R_NCACHENXDOMAIN The desired name does not
822 * exist. 'node' is bound to the
823 * cache node with the desired
824 * name, and 'rdataset' contains
825 * the negative caching proof.
827 * \li #DNS_R_NCACHENXRRSET The desired type does not
828 * exist. 'node' is bound to the
829 * cache node with the desired
830 * name, and 'rdataset' contains
831 * the negative caching proof.
833 * \li #DNS_R_EMPTYNAME The name exists but there is
834 * no data at the name.
836 * \li #DNS_R_COVERINGNSEC The returned data is a NSEC
837 * that potentially covers 'name'.
841 * \li #ISC_R_NOMEMORY
843 * \li #DNS_R_BADDB Data that is required to be
844 * present in the DB, e.g. an NSEC
845 * record in a secure zone, is not
848 * \li Other results are possible, and should all be treated as
853 dns_db_findzonecut(dns_db_t *db, dns_name_t *name,
854 unsigned int options, isc_stdtime_t now,
855 dns_dbnode_t **nodep, dns_name_t *foundname,
856 dns_rdataset_t *rdataset, dns_rdataset_t *sigrdataset);
858 * Find the deepest known zonecut which encloses 'name' in 'db'.
862 * \li If the #DNS_DBFIND_NOEXACT option is set, then the zonecut returned
863 * (if any) will be the deepest known ancestor of 'name'.
865 * \li If 'now' is zero, then the current time will be used.
869 * \li 'db' is a valid database with cache semantics.
871 * \li 'nodep' is NULL, or nodep is a valid pointer and *nodep == NULL.
873 * \li 'foundname' is a valid name with a dedicated buffer.
875 * \li 'rdataset' is NULL, or is a valid unassociated rdataset.
877 * Ensures, on a non-error completion:
879 * \li If nodep != NULL, then it is bound to the found node.
881 * \li If foundname != NULL, then it contains the full name of the
884 * \li If rdataset != NULL and type != dns_rdatatype_any, then
885 * rdataset is bound to the found rdataset.
887 * Non-error results are:
891 * \li #ISC_R_NOTFOUND
893 * \li Other results are possible, and should all be treated as
898 dns_db_attachnode(dns_db_t *db, dns_dbnode_t *source, dns_dbnode_t **targetp);
900 * Attach *targetp to source.
904 * \li 'db' is a valid database.
906 * \li 'source' is a valid node.
908 * \li 'targetp' points to a NULL dns_dbnode_t *.
912 * \li *targetp is attached to source.
916 dns_db_detachnode(dns_db_t *db, dns_dbnode_t **nodep);
918 * Detach *nodep from its node.
922 * \li 'db' is a valid database.
924 * \li 'nodep' points to a valid node.
928 * \li *nodep is NULL.
932 dns_db_transfernode(dns_db_t *db, dns_dbnode_t **sourcep,
933 dns_dbnode_t **targetp);
935 * Transfer a node between pointer.
937 * This is equivalent to calling dns_db_attachnode() then dns_db_detachnode().
941 * \li 'db' is a valid database.
943 * \li '*sourcep' is a valid node.
945 * \li 'targetp' points to a NULL dns_dbnode_t *.
949 * \li '*sourcep' is NULL.
953 dns_db_expirenode(dns_db_t *db, dns_dbnode_t *node, isc_stdtime_t now);
955 * Mark as stale all records at 'node' which expire at or before 'now'.
957 * Note: if 'now' is zero, then the current time will be used.
961 * \li 'db' is a valid cache database.
963 * \li 'node' is a valid node.
967 dns_db_printnode(dns_db_t *db, dns_dbnode_t *node, FILE *out);
969 * Print a textual representation of the contents of the node to
972 * Note: this function is intended for debugging, not general use.
976 * \li 'db' is a valid database.
978 * \li 'node' is a valid node.
982 *** DB Iterator Creation
986 dns_db_createiterator(dns_db_t *db, unsigned int options,
987 dns_dbiterator_t **iteratorp);
989 * Create an iterator for version 'version' of 'db'.
993 * \li One or more of the following options can be set.
994 * #DNS_DB_RELATIVENAMES
1000 * \li 'db' is a valid database.
1002 * \li iteratorp != NULL && *iteratorp == NULL
1006 * \li On success, *iteratorp will be a valid database iterator.
1010 * \li #ISC_R_SUCCESS
1011 * \li #ISC_R_NOMEMORY
1015 *** Rdataset Methods
1019 * XXXRTH Should we check for glue and pending data in dns_db_findrdataset()?
1023 dns_db_findrdataset(dns_db_t *db, dns_dbnode_t *node, dns_dbversion_t *version,
1024 dns_rdatatype_t type, dns_rdatatype_t covers,
1025 isc_stdtime_t now, dns_rdataset_t *rdataset,
1026 dns_rdataset_t *sigrdataset);
1028 * Search for an rdataset of type 'type' at 'node' that are in version
1029 * 'version' of 'db'. If found, make 'rdataset' refer to it.
1033 * \li If 'version' is NULL, then the current version will be used.
1035 * \li Care must be used when using this routine to build a DNS response:
1036 * 'node' should have been found with dns_db_find(), not
1037 * dns_db_findnode(). No glue checking is done. No checking for
1038 * pending data is done.
1040 * \li The 'now' field is ignored if 'db' is a zone database. If 'db' is a
1041 * cache database, an rdataset will not be found unless it expires after
1042 * 'now'. If 'now' is zero, then the current time will be used.
1046 * \li 'db' is a valid database.
1048 * \li 'node' is a valid node.
1050 * \li 'rdataset' is a valid, disassociated rdataset.
1052 * \li 'sigrdataset' is a valid, disassociated rdataset, or it is NULL.
1054 * \li If 'covers' != 0, 'type' must be SIG.
1056 * \li 'type' is not a meta-RR type such as 'ANY' or 'OPT'.
1060 * \li On success, 'rdataset' is associated with the found rdataset.
1064 * \li #ISC_R_SUCCESS
1065 * \li #ISC_R_NOTFOUND
1067 * \li Other results are possible, depending upon the database
1068 * implementation used.
1072 dns_db_allrdatasets(dns_db_t *db, dns_dbnode_t *node, dns_dbversion_t *version,
1073 isc_stdtime_t now, dns_rdatasetiter_t **iteratorp);
1075 * Make '*iteratorp' an rdataset iterator for all rdatasets at 'node' in
1076 * version 'version' of 'db'.
1080 * \li If 'version' is NULL, then the current version will be used.
1082 * \li The 'now' field is ignored if 'db' is a zone database. If 'db' is a
1083 * cache database, an rdataset will not be found unless it expires after
1084 * 'now'. Any ANY query will not match unless at least one rdataset at
1085 * the node expires after 'now'. If 'now' is zero, then the current time
1090 * \li 'db' is a valid database.
1092 * \li 'node' is a valid node.
1094 * \li iteratorp != NULL && *iteratorp == NULL
1098 * \li On success, '*iteratorp' is a valid rdataset iterator.
1102 * \li #ISC_R_SUCCESS
1103 * \li #ISC_R_NOTFOUND
1105 * \li Other results are possible, depending upon the database
1106 * implementation used.
1110 dns_db_addrdataset(dns_db_t *db, dns_dbnode_t *node, dns_dbversion_t *version,
1111 isc_stdtime_t now, dns_rdataset_t *rdataset,
1112 unsigned int options, dns_rdataset_t *addedrdataset);
1114 * Add 'rdataset' to 'node' in version 'version' of 'db'.
1118 * \li If the database has zone semantics, the #DNS_DBADD_MERGE option is set,
1119 * and an rdataset of the same type as 'rdataset' already exists at
1120 * 'node' then the contents of 'rdataset' will be merged with the existing
1121 * rdataset. If the option is not set, then rdataset will replace any
1122 * existing rdataset of the same type. If not merging and the
1123 * #DNS_DBADD_FORCE option is set, then the data will update the database
1124 * without regard to trust levels. If not forcing the data, then the
1125 * rdataset will only be added if its trust level is >= the trust level of
1126 * any existing rdataset. Forcing is only meaningful for cache databases.
1127 * If #DNS_DBADD_EXACT is set then there must be no rdata in common between
1128 * the old and new rdata sets. If #DNS_DBADD_EXACTTTL is set then both
1129 * the old and new rdata sets must have the same ttl.
1131 * \li The 'now' field is ignored if 'db' is a zone database. If 'db' is
1132 * a cache database, then the added rdataset will expire no later than
1133 * now + rdataset->ttl.
1135 * \li If 'addedrdataset' is not NULL, then it will be attached to the
1136 * resulting new rdataset in the database, or to the existing data if
1137 * the existing data was better.
1141 * \li 'db' is a valid database.
1143 * \li 'node' is a valid node.
1145 * \li 'rdataset' is a valid, associated rdataset with the same class
1148 * \li 'addedrdataset' is NULL, or a valid, unassociated rdataset.
1150 * \li The database has zone semantics and 'version' is a valid
1151 * read-write version, or the database has cache semantics
1152 * and version is NULL.
1154 * \li If the database has cache semantics, the #DNS_DBADD_MERGE option must
1159 * \li #ISC_R_SUCCESS
1160 * \li #DNS_R_UNCHANGED The operation did not change anything.
1161 * \li #ISC_R_NOMEMORY
1162 * \li #DNS_R_NOTEXACT
1164 * \li Other results are possible, depending upon the database
1165 * implementation used.
1169 dns_db_subtractrdataset(dns_db_t *db, dns_dbnode_t *node,
1170 dns_dbversion_t *version, dns_rdataset_t *rdataset,
1171 unsigned int options, dns_rdataset_t *newrdataset);
1173 * Remove any rdata in 'rdataset' from 'node' in version 'version' of
1178 * \li If 'newrdataset' is not NULL, then it will be attached to the
1179 * resulting new rdataset in the database, unless the rdataset has
1180 * become nonexistent. If DNS_DBSUB_EXACT is set then all elements
1181 * of 'rdataset' must exist at 'node'.
1185 * \li 'db' is a valid database.
1187 * \li 'node' is a valid node.
1189 * \li 'rdataset' is a valid, associated rdataset with the same class
1192 * \li 'newrdataset' is NULL, or a valid, unassociated rdataset.
1194 * \li The database has zone semantics and 'version' is a valid
1195 * read-write version.
1199 * \li #ISC_R_SUCCESS
1200 * \li #DNS_R_UNCHANGED The operation did not change anything.
1201 * \li #DNS_R_NXRRSET All rdata of the same type as those
1202 * in 'rdataset' have been deleted.
1203 * \li #DNS_R_NOTEXACT Some part of 'rdataset' did not
1204 * exist and DNS_DBSUB_EXACT was set.
1206 * \li Other results are possible, depending upon the database
1207 * implementation used.
1211 dns_db_deleterdataset(dns_db_t *db, dns_dbnode_t *node,
1212 dns_dbversion_t *version, dns_rdatatype_t type,
1213 dns_rdatatype_t covers);
1215 * Make it so that no rdataset of type 'type' exists at 'node' in version
1216 * version 'version' of 'db'.
1220 * \li If 'type' is dns_rdatatype_any, then no rdatasets will exist in
1221 * 'version' (provided that the dns_db_deleterdataset() isn't followed
1222 * by one or more dns_db_addrdataset() calls).
1226 * \li 'db' is a valid database.
1228 * \li 'node' is a valid node.
1230 * \li The database has zone semantics and 'version' is a valid
1231 * read-write version, or the database has cache semantics
1232 * and version is NULL.
1234 * \li 'type' is not a meta-RR type, except for dns_rdatatype_any, which is
1237 * \li If 'covers' != 0, 'type' must be SIG.
1241 * \li #ISC_R_SUCCESS
1242 * \li #DNS_R_UNCHANGED No rdatasets of 'type' existed before
1243 * the operation was attempted.
1245 * \li Other results are possible, depending upon the database
1246 * implementation used.
1250 dns_db_getsoaserial(dns_db_t *db, dns_dbversion_t *ver, isc_uint32_t *serialp);
1252 * Get the current SOA serial number from a zone database.
1255 * \li 'db' is a valid database with zone semantics.
1256 * \li 'ver' is a valid version.
1260 dns_db_overmem(dns_db_t *db, isc_boolean_t overmem);
1262 * Enable / disable aggressive cache cleaning.
1266 dns_db_nodecount(dns_db_t *db);
1268 * Count the number of nodes in 'db'.
1272 * \li 'db' is a valid database.
1275 * \li The number of nodes in the database
1279 dns_db_settask(dns_db_t *db, isc_task_t *task);
1281 * If task is set then the final detach maybe performed asynchronously.
1284 * \li 'db' is a valid database.
1285 * \li 'task' to be valid or NULL.
1289 dns_db_ispersistent(dns_db_t *db);
1291 * Is 'db' persistent? A persistent database does not need to be loaded
1292 * from disk or written to disk.
1296 * \li 'db' is a valid database.
1299 * \li #ISC_TRUE 'db' is persistent.
1300 * \li #ISC_FALSE 'db' is not persistent.
1304 dns_db_register(const char *name, dns_dbcreatefunc_t create, void *driverarg,
1305 isc_mem_t *mctx, dns_dbimplementation_t **dbimp);
1308 * Register a new database implementation and add it to the list of
1309 * supported implementations.
1313 * \li 'name' is not NULL
1314 * \li 'order' is a valid function pointer
1315 * \li 'mctx' is a valid memory context
1316 * \li dbimp != NULL && *dbimp == NULL
1319 * \li #ISC_R_SUCCESS The registration succeeded
1320 * \li #ISC_R_NOMEMORY Out of memory
1321 * \li #ISC_R_EXISTS A database implementation with the same name exists
1325 * \li *dbimp points to an opaque structure which must be passed to
1326 * dns_db_unregister().
1330 dns_db_unregister(dns_dbimplementation_t **dbimp);
1332 * Remove a database implementation from the list of supported
1333 * implementations. No databases of this type can be active when this
1337 * \li dbimp != NULL && *dbimp == NULL
1341 * \li Any memory allocated in *dbimp will be freed.
1345 dns_db_getoriginnode(dns_db_t *db, dns_dbnode_t **nodep);
1347 * Get the origin DB node corresponding to the DB's zone. This function
1348 * should typically succeed unless the underlying DB implementation doesn't
1349 * support the feature.
1353 * \li 'db' is a valid zone database.
1354 * \li 'nodep' != NULL && '*nodep' == NULL
1357 * \li On success, '*nodep' will point to the DB node of the zone's origin.
1360 * \li #ISC_R_SUCCESS
1361 * \li #ISC_R_NOTFOUND - the DB implementation does not support this feature.
1365 dns_db_getnsec3parameters(dns_db_t *db, dns_dbversion_t *version,
1366 dns_hash_t *hash, isc_uint8_t *flags,
1367 isc_uint16_t *interations,
1368 unsigned char *salt, size_t *salt_length);
1370 * Get the NSEC3 parameters that are associated with this zone.
1373 * \li 'db' is a valid zone database.
1376 * \li #ISC_R_SUCCESS
1377 * \li #ISC_R_NOTFOUND - the DB implementation does not support this feature
1378 * or this zone does not have NSEC3 records.
1382 dns_db_findnsec3node(dns_db_t *db, dns_name_t *name,
1383 isc_boolean_t create, dns_dbnode_t **nodep);
1385 * Find the NSEC3 node with name 'name'.
1388 * \li If 'create' is ISC_TRUE and no node with name 'name' exists, then
1389 * such a node will be created.
1393 * \li 'db' is a valid database.
1395 * \li 'name' is a valid, non-empty, absolute name.
1397 * \li nodep != NULL && *nodep == NULL
1401 * \li On success, *nodep is attached to the node with name 'name'.
1405 * \li #ISC_R_SUCCESS
1406 * \li #ISC_R_NOTFOUND If !create and name not found.
1407 * \li #ISC_R_NOMEMORY Can only happen if create is ISC_TRUE.
1409 * \li Other results are possible, depending upon the database
1410 * implementation used.
1414 dns_db_setsigningtime(dns_db_t *db, dns_rdataset_t *rdataset,
1415 isc_stdtime_t resign);
1417 * Sets the re-signing time associated with 'rdataset' to 'resign'.
1420 * \li 'db' is a valid zone database.
1421 * \li 'rdataset' to be associated with 'db'.
1424 * \li #ISC_R_SUCCESS
1425 * \li #ISC_R_NOMEMORY
1426 * \li #ISC_R_NOTIMPLEMENTED - Not supported by this DB implementation.
1430 dns_db_getsigningtime(dns_db_t *db, dns_rdataset_t *rdataset, dns_name_t *name);
1432 * Return the rdataset with the earliest signing time in the zone.
1433 * Note: the rdataset is version agnostic.
1436 * \li 'db' is a valid zone database.
1437 * \li 'rdataset' to be initialized but not associated.
1438 * \li 'name' to be NULL or have a buffer associated with it.
1441 * \li #ISC_R_SUCCESS
1442 * \li #ISC_R_NOTFOUND - No dataset exists.
1446 dns_db_resigned(dns_db_t *db, dns_rdataset_t *rdataset,
1447 dns_dbversion_t *version);
1449 * Mark 'rdataset' as not being available to be returned by
1450 * dns_db_getsigningtime(). If the changes associated with 'version'
1451 * are committed this will be permanent. If the version is not committed
1452 * this change will be rolled back when the version is closed.
1455 * \li 'db' is a valid zone database.
1456 * \li 'rdataset' to be associated with 'db'.
1457 * \li 'version' to be open for writing.
1461 dns_db_getrrsetstats(dns_db_t *db);
1463 * Get statistics information counting RRsets stored in the DB, when available.
1464 * The statistics may not be available depending on the DB implementation.
1468 * \li 'db' is a valid database (zone or cache).
1471 * \li when available, a pointer to a statistics object created by
1472 * dns_rdatasetstats_create(); otherwise NULL.
1477 #endif /* DNS_DB_H */