2 * Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC")
3 * Copyright (C) 1999-2003 Internet Software Consortium.
5 * Permission to use, copy, modify, and 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.67.12.8 2004/05/14 05:06:41 marka Exp $ */
30 * The DNS DB interface allows named rdatasets to be stored and retrieved.
32 * The dns_db_t type is like a "virtual class". To actually use
33 * DBs, an implementation of the class is required.
38 * The module ensures appropriate synchronization of data structures it
39 * creates and manipulates.
42 * No anticipated impact.
48 * No anticipated impact.
59 #include <isc/magic.h>
60 #include <isc/ondestroy.h>
61 #include <isc/stdtime.h>
64 #include <dns/types.h>
72 typedef struct dns_dbmethods {
73 void (*attach)(dns_db_t *source, dns_db_t **targetp);
74 void (*detach)(dns_db_t **dbp);
75 isc_result_t (*beginload)(dns_db_t *db, dns_addrdatasetfunc_t *addp,
76 dns_dbload_t **dbloadp);
77 isc_result_t (*endload)(dns_db_t *db, dns_dbload_t **dbloadp);
78 isc_result_t (*dump)(dns_db_t *db, dns_dbversion_t *version,
79 const char *filename);
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 *);
151 (*dns_dbcreatefunc_t)(isc_mem_t *mctx, dns_name_t *name,
152 dns_dbtype_t type, dns_rdataclass_t rdclass,
153 unsigned int argc, char *argv[], void *driverarg,
156 #define DNS_DB_MAGIC ISC_MAGIC('D','N','S','D')
157 #define DNS_DB_VALID(db) ISC_MAGIC_VALID(db, DNS_DB_MAGIC)
160 * This structure is actually just the common prefix of a DNS db
161 * implementation's version of a dns_db_t.
163 * Direct use of this structure by clients is forbidden. DB implementations
164 * may change the structure. 'magic' must be DNS_DB_MAGIC for any of the
165 * dns_db_ routines to work. DB implementations must maintain all DB
170 unsigned int impmagic;
171 dns_dbmethods_t * methods;
172 isc_uint16_t attributes;
173 dns_rdataclass_t rdclass;
175 isc_ondestroy_t ondest;
179 #define DNS_DBATTR_CACHE 0x01
180 #define DNS_DBATTR_STUB 0x02
183 * Options that can be specified for dns_db_find().
185 #define DNS_DBFIND_GLUEOK 0x01
186 #define DNS_DBFIND_VALIDATEGLUE 0x02
187 #define DNS_DBFIND_NOWILD 0x04
188 #define DNS_DBFIND_PENDINGOK 0x08
189 #define DNS_DBFIND_NOEXACT 0x10
190 #define DNS_DBFIND_FORCENSEC 0x20
191 #define DNS_DBFIND_COVERINGNSEC 0x40
194 * Options that can be specified for dns_db_addrdataset().
196 #define DNS_DBADD_MERGE 0x01
197 #define DNS_DBADD_FORCE 0x02
198 #define DNS_DBADD_EXACT 0x04
199 #define DNS_DBADD_EXACTTTL 0x08
202 * Options that can be specified for dns_db_subtractrdataset().
204 #define DNS_DBSUB_EXACT 0x01
215 dns_db_create(isc_mem_t *mctx, const char *db_type, dns_name_t *origin,
216 dns_dbtype_t type, dns_rdataclass_t rdclass,
217 unsigned int argc, char *argv[], dns_db_t **dbp);
219 * Create a new database using implementation 'db_type'.
222 * All names in the database must be subdomains of 'origin' and in class
223 * 'rdclass'. The database makes its own copy of the origin, so the
224 * caller may do whatever they like with 'origin' and its storage once the
227 * DB implementation-specific parameters are passed using argc and argv.
231 * dbp != NULL and *dbp == NULL
233 * 'origin' is a valid absolute domain name.
235 * mctx is a valid memory context
239 * A copy of 'origin' has been made for the databases use, and the
240 * caller is free to do whatever they want with the name and storage
241 * associated with 'origin'.
247 * ISC_R_NOTFOUND db_type not found
249 * Many other errors are possible, depending on what db_type was
254 dns_db_attach(dns_db_t *source, dns_db_t **targetp);
256 * Attach *targetp to source.
260 * 'source' is a valid database.
262 * 'targetp' points to a NULL dns_db_t *.
266 * *targetp is attached to source.
270 dns_db_detach(dns_db_t **dbp);
272 * Detach *dbp from its database.
276 * 'dbp' points to a valid database.
282 * If '*dbp' is the last reference to the database,
284 * All resources used by the database will be freed
288 dns_db_ondestroy(dns_db_t *db, isc_task_t *task, isc_event_t **eventp);
290 * Causes 'eventp' to be sent to be sent to 'task' when the database is
293 * Note; ownership of the eventp is taken from the caller (and *eventp is
294 * set to NULL). The sender field of the event is set to 'db' before it is
299 dns_db_iscache(dns_db_t *db);
301 * Does 'db' have cache semantics?
305 * 'db' is a valid database.
308 * ISC_TRUE 'db' has cache semantics
309 * ISC_FALSE otherwise
313 dns_db_iszone(dns_db_t *db);
315 * Does 'db' have zone semantics?
319 * 'db' is a valid database.
322 * ISC_TRUE 'db' has zone semantics
323 * ISC_FALSE otherwise
327 dns_db_isstub(dns_db_t *db);
329 * Does 'db' have stub semantics?
333 * 'db' is a valid database.
336 * ISC_TRUE 'db' has zone semantics
337 * ISC_FALSE otherwise
341 dns_db_issecure(dns_db_t *db);
347 * 'db' is a valid database with zone semantics.
350 * ISC_TRUE 'db' is secure.
351 * ISC_FALSE 'db' is not secure.
355 dns_db_origin(dns_db_t *db);
357 * The origin of the database.
359 * Note: caller must not try to change this name.
363 * 'db' is a valid database.
367 * The origin of the database.
371 dns_db_class(dns_db_t *db);
373 * The class of the database.
377 * 'db' is a valid database.
381 * The class of the database.
385 dns_db_beginload(dns_db_t *db, dns_addrdatasetfunc_t *addp,
386 dns_dbload_t **dbloadp);
388 * Begin loading 'db'.
392 * 'db' is a valid database.
394 * This is the first attempt to load 'db'.
396 * addp != NULL && *addp == NULL
398 * dbloadp != NULL && *dbloadp == NULL
402 * On success, *addp will be a valid dns_addrdatasetfunc_t suitable
403 * for loading 'db'. *dbloadp will be a valid DB load context which
404 * should be used as 'arg' when *addp is called.
411 * Other results are possible, depending upon the database
412 * implementation used, syntax errors in the master file, etc.
416 dns_db_endload(dns_db_t *db, dns_dbload_t **dbloadp);
418 * Finish loading 'db'.
422 * 'db' is a valid database that is being loaded.
424 * dbloadp != NULL and *dbloadp is a valid database load context.
435 * Other results are possible, depending upon the database
436 * implementation used, syntax errors in the master file, etc.
440 dns_db_load(dns_db_t *db, const char *filename);
442 * Load master file 'filename' into 'db'.
445 * This routine is equivalent to calling
447 * dns_db_beginload();
448 * dns_master_loadfile();
453 * 'db' is a valid database.
455 * This is the first attempt to load 'db'.
462 * Other results are possible, depending upon the database
463 * implementation used, syntax errors in the master file, etc.
467 dns_db_dump(dns_db_t *db, dns_dbversion_t *version, const char *filename);
469 * Dump version 'version' of 'db' to master file 'filename'.
473 * 'db' is a valid database.
475 * 'version' is a valid version.
482 * Other results are possible, depending upon the database
483 * implementation used, OS file errors, etc.
491 dns_db_currentversion(dns_db_t *db, dns_dbversion_t **versionp);
493 * Open the current version for reading.
497 * 'db' is a valid database with zone semantics.
499 * versionp != NULL && *verisonp == NULL
503 * On success, '*versionp' is attached to the current version.
508 dns_db_newversion(dns_db_t *db, dns_dbversion_t **versionp);
510 * Open a new version for reading and writing.
514 * 'db' is a valid database with zone semantics.
516 * versionp != NULL && *verisonp == NULL
520 * On success, '*versionp' is attached to the current version.
527 * Other results are possible, depending upon the database
528 * implementation used.
532 dns_db_attachversion(dns_db_t *db, dns_dbversion_t *source,
533 dns_dbversion_t **targetp);
535 * Attach '*targetp' to 'source'.
539 * 'db' is a valid database with zone semantics.
541 * source is a valid open version
543 * targetp != NULL && *targetp == NULL
547 * '*targetp' is attached to source.
551 dns_db_closeversion(dns_db_t *db, dns_dbversion_t **versionp,
552 isc_boolean_t commit);
554 * Close version '*versionp'.
556 * Note: if '*versionp' is a read-write version and 'commit' is ISC_TRUE,
557 * then all changes made in the version will take effect, otherwise they
558 * will be rolled back. The value if 'commit' is ignored for read-only
563 * 'db' is a valid database with zone semantics.
565 * '*versionp' refers to a valid version.
567 * If committing a writable version, then there must be no other
568 * outstanding references to the version (e.g. an active rdataset
575 * If *versionp is a read-write version, and commit is ISC_TRUE, then
576 * the version will become the current version. If !commit, then all
577 * changes made in the version will be undone, and the version will
578 * not become the current version.
586 dns_db_findnode(dns_db_t *db, dns_name_t *name, isc_boolean_t create,
587 dns_dbnode_t **nodep);
589 * Find the node with name 'name'.
592 * If 'create' is ISC_TRUE and no node with name 'name' exists, then
593 * such a node will be created.
595 * This routine is for finding or creating a node with the specified
596 * name. There are no partial matches. It is not suitable for use
597 * in building responses to ordinary DNS queries; clients which wish
598 * to do that should use dns_db_find() instead.
602 * 'db' is a valid database.
604 * 'name' is a valid, non-empty, absolute name.
606 * nodep != NULL && *nodep == NULL
610 * On success, *nodep is attached to the node with name 'name'.
615 * ISC_R_NOTFOUND If !create and name not found.
616 * ISC_R_NOMEMORY Can only happen if create is ISC_TRUE.
618 * Other results are possible, depending upon the database
619 * implementation used.
623 dns_db_find(dns_db_t *db, dns_name_t *name, dns_dbversion_t *version,
624 dns_rdatatype_t type, unsigned int options, isc_stdtime_t now,
625 dns_dbnode_t **nodep, dns_name_t *foundname,
626 dns_rdataset_t *rdataset, dns_rdataset_t *sigrdataset);
628 * Find the best match for 'name' and 'type' in version 'version' of 'db'.
632 * If type == dns_rdataset_any, then rdataset will not be bound.
634 * If 'options' does not have DNS_DBFIND_GLUEOK set, then no glue will
635 * be returned. For zone databases, glue is as defined in RFC 2181.
636 * For cache databases, glue is any rdataset with a trust of
639 * If 'options' does not have DNS_DBFIND_PENDINGOK set, then no
640 * pending data will be returned. This option is only meaningful for
643 * If the DNS_DBFIND_NOWILD option is set, then wildcard matching will
644 * be disabled. This option is only meaningful for zone databases.
646 * If the DNS_DBFIND_FORCENSEC option is set, the database is assumed to
647 * have NSEC records, and these will be returned when appropriate. This
648 * is only necessary when querying a database that was not secure
651 * If the DNS_DBFIND_COVERINGNSEC option is set, then look for a
652 * NSEC record that potentially covers 'name' if a answer cannot
653 * be found. Note the returned NSEC needs to be checked to ensure
654 * that it is correct. This only affects answers returned from the
657 * To respond to a query for SIG records, the caller should create a
658 * rdataset iterator and extract the signatures from each rdataset.
660 * Making queries of type ANY with DNS_DBFIND_GLUEOK is not recommended,
661 * because the burden of determining whether a given rdataset is valid
662 * glue or not falls upon the caller.
664 * The 'now' field is ignored if 'db' is a zone database. If 'db' is a
665 * cache database, an rdataset will not be found unless it expires after
666 * 'now'. Any ANY query will not match unless at least one rdataset at
667 * the node expires after 'now'. If 'now' is zero, then the current time
672 * 'db' is a valid database.
674 * 'type' is not SIG, or a meta-RR type other than 'ANY' (e.g. 'OPT').
676 * 'nodep' is NULL, or nodep is a valid pointer and *nodep == NULL.
678 * 'foundname' is a valid name with a dedicated buffer.
680 * 'rdataset' is NULL, or is a valid unassociated rdataset.
683 * On a non-error completion:
685 * If nodep != NULL, then it is bound to the found node.
687 * If foundname != NULL, then it contains the full name of the
690 * If rdataset != NULL and type != dns_rdatatype_any, then
691 * rdataset is bound to the found rdataset.
695 * Non-error results are:
697 * ISC_R_SUCCESS The desired node and type were
700 * DNS_R_WILDCARD The desired node and type were
701 * found after performing
702 * wildcard matching. This is
703 * only returned if the
704 * DNS_DBFIND_INDICATEWILD
705 * option is set; otherwise
706 * ISC_R_SUCCESS is returned.
708 * DNS_R_GLUE The desired node and type were
709 * found, but are glue. This
710 * result can only occur if
711 * the DNS_DBFIND_GLUEOK option
712 * is set. This result can only
713 * occur if 'db' is a zone
714 * database. If type ==
715 * dns_rdatatype_any, then the
716 * node returned may contain, or
717 * consist entirely of invalid
718 * glue (i.e. data occluded by a
719 * zone cut). The caller must
720 * take care not to return invalid
723 * DNS_R_DELEGATION The data requested is beneath
724 * a zone cut. node, foundname,
725 * and rdataset reference the
726 * NS RRset of the zone cut.
727 * If 'db' is a cache database,
728 * then this is the deepest known
731 * DNS_R_ZONECUT type == dns_rdatatype_any, and
732 * the desired node is a zonecut.
733 * The caller must take care not
734 * to return inappropriate glue
735 * to a client. This result can
736 * only occur if 'db' is a zone
737 * database and DNS_DBFIND_GLUEOK
740 * DNS_R_DNAME The data requested is beneath
741 * a DNAME. node, foundname,
742 * and rdataset reference the
745 * DNS_R_CNAME The rdataset requested was not
746 * found, but there is a CNAME
747 * at the desired name. node,
748 * foundname, and rdataset
749 * reference the CNAME RRset.
751 * DNS_R_NXDOMAIN The desired name does not
754 * DNS_R_NXRRSET The desired name exists, but
755 * the desired type does not.
757 * ISC_R_NOTFOUND The desired name does not
758 * exist, and no delegation could
759 * be found. This result can only
760 * occur if 'db' is a cache
761 * database. The caller should
762 * use its nameserver(s) of last
763 * resort (e.g. root hints).
765 * DNS_R_NCACHENXDOMAIN The desired name does not
766 * exist. 'node' is bound to the
767 * cache node with the desired
768 * name, and 'rdataset' contains
769 * the negative caching proof.
771 * DNS_R_NCACHENXRRSET The desired type does not
772 * exist. 'node' is bound to the
773 * cache node with the desired
774 * name, and 'rdataset' contains
775 * the negative caching proof.
777 * DNS_R_EMPTYNAME The name exists but there is
778 * no data at the name.
780 * DNS_R_COVERINGNSEC The returned data is a NSEC
781 * that potentially covers 'name'.
787 * DNS_R_BADDB Data that is required to be
788 * present in the DB, e.g. an NSEC
789 * record in a secure zone, is not
792 * Other results are possible, and should all be treated as
797 dns_db_findzonecut(dns_db_t *db, dns_name_t *name,
798 unsigned int options, isc_stdtime_t now,
799 dns_dbnode_t **nodep, dns_name_t *foundname,
800 dns_rdataset_t *rdataset, dns_rdataset_t *sigrdataset);
802 * Find the deepest known zonecut which encloses 'name' in 'db'.
806 * If the DNS_DBFIND_NOEXACT option is set, then the zonecut returned
807 * (if any) will be the deepest known ancestor of 'name'.
809 * If 'now' is zero, then the current time will be used.
813 * 'db' is a valid database with cache semantics.
815 * 'nodep' is NULL, or nodep is a valid pointer and *nodep == NULL.
817 * 'foundname' is a valid name with a dedicated buffer.
819 * 'rdataset' is NULL, or is a valid unassociated rdataset.
822 * On a non-error completion:
824 * If nodep != NULL, then it is bound to the found node.
826 * If foundname != NULL, then it contains the full name of the
829 * If rdataset != NULL and type != dns_rdatatype_any, then
830 * rdataset is bound to the found rdataset.
834 * Non-error results are:
840 * Other results are possible, and should all be treated as
845 dns_db_attachnode(dns_db_t *db, dns_dbnode_t *source, dns_dbnode_t **targetp);
847 * Attach *targetp to source.
851 * 'db' is a valid database.
853 * 'source' is a valid node.
855 * 'targetp' points to a NULL dns_node_t *.
859 * *targetp is attached to source.
863 dns_db_detachnode(dns_db_t *db, dns_dbnode_t **nodep);
865 * Detach *nodep from its node.
869 * 'db' is a valid database.
871 * 'nodep' points to a valid node.
879 dns_db_expirenode(dns_db_t *db, dns_dbnode_t *node, isc_stdtime_t now);
881 * Mark as stale all records at 'node' which expire at or before 'now'.
883 * Note: if 'now' is zero, then the current time will be used.
887 * 'db' is a valid cache database.
889 * 'node' is a valid node.
893 dns_db_printnode(dns_db_t *db, dns_dbnode_t *node, FILE *out);
895 * Print a textual representation of the contents of the node to
898 * Note: this function is intended for debugging, not general use.
902 * 'db' is a valid database.
904 * 'node' is a valid node.
908 *** DB Iterator Creation
912 dns_db_createiterator(dns_db_t *db, isc_boolean_t relative_names,
913 dns_dbiterator_t **iteratorp);
915 * Create an iterator for version 'version' of 'db'.
919 * If 'relative_names' is ISC_TRUE, then node names returned by the
920 * iterator will be relative to the iterator's current origin. If
921 * ISC_FALSE, then the node names will be absolute.
925 * 'db' is a valid database.
927 * iteratorp != NULL && *iteratorp == NULL
931 * On success, *iteratorp will be a valid database iterator.
944 * XXXRTH Should we check for glue and pending data in dns_db_findrdataset()?
948 dns_db_findrdataset(dns_db_t *db, dns_dbnode_t *node, dns_dbversion_t *version,
949 dns_rdatatype_t type, dns_rdatatype_t covers,
950 isc_stdtime_t now, dns_rdataset_t *rdataset,
951 dns_rdataset_t *sigrdataset);
953 * Search for an rdataset of type 'type' at 'node' that are in version
954 * 'version' of 'db'. If found, make 'rdataset' refer to it.
958 * If 'version' is NULL, then the current version will be used.
960 * Care must be used when using this routine to build a DNS response:
961 * 'node' should have been found with dns_db_find(), not
962 * dns_db_findnode(). No glue checking is done. No checking for
963 * pending data is done.
965 * The 'now' field is ignored if 'db' is a zone database. If 'db' is a
966 * cache database, an rdataset will not be found unless it expires after
967 * 'now'. If 'now' is zero, then the current time will be used.
971 * 'db' is a valid database.
973 * 'node' is a valid node.
975 * 'rdataset' is a valid, disassociated rdataset.
977 * 'sigrdataset' is a valid, disassociated rdataset, or it is NULL.
979 * If 'covers' != 0, 'type' must be SIG.
981 * 'type' is not a meta-RR type such as 'ANY' or 'OPT'.
985 * On success, 'rdataset' is associated with the found rdataset.
992 * Other results are possible, depending upon the database
993 * implementation used.
997 dns_db_allrdatasets(dns_db_t *db, dns_dbnode_t *node, dns_dbversion_t *version,
998 isc_stdtime_t now, dns_rdatasetiter_t **iteratorp);
1000 * Make '*iteratorp' an rdataset iteratator for all rdatasets at 'node' in
1001 * version 'version' of 'db'.
1005 * If 'version' is NULL, then the current version will be used.
1007 * The 'now' field is ignored if 'db' is a zone database. If 'db' is a
1008 * cache database, an rdataset will not be found unless it expires after
1009 * 'now'. Any ANY query will not match unless at least one rdataset at
1010 * the node expires after 'now'. If 'now' is zero, then the current time
1015 * 'db' is a valid database.
1017 * 'node' is a valid node.
1019 * iteratorp != NULL && *iteratorp == NULL
1023 * On success, '*iteratorp' is a valid rdataset iterator.
1030 * Other results are possible, depending upon the database
1031 * implementation used.
1035 dns_db_addrdataset(dns_db_t *db, dns_dbnode_t *node, dns_dbversion_t *version,
1036 isc_stdtime_t now, dns_rdataset_t *rdataset,
1037 unsigned int options, dns_rdataset_t *addedrdataset);
1039 * Add 'rdataset' to 'node' in version 'version' of 'db'.
1043 * If the database has zone semantics, the DNS_DBADD_MERGE option is set,
1044 * and an rdataset of the same type as 'rdataset' already exists at
1045 * 'node' then the contents of 'rdataset' will be merged with the existing
1046 * rdataset. If the option is not set, then rdataset will replace any
1047 * existing rdataset of the same type. If not merging and the
1048 * DNS_DBADD_FORCE option is set, then the data will update the database
1049 * without regard to trust levels. If not forcing the data, then the
1050 * rdataset will only be added if its trust level is >= the trust level of
1051 * any existing rdataset. Forcing is only meaningful for cache databases.
1052 * If DNS_DBADD_EXACT is set then there must be no rdata in common between
1053 * the old and new rdata sets. If DNS_DBADD_EXACTTTL is set then both
1054 * the old and new rdata sets must have the same ttl.
1056 * The 'now' field is ignored if 'db' is a zone database. If 'db' is
1057 * a cache database, then the added rdataset will expire no later than
1058 * now + rdataset->ttl.
1060 * If 'addedrdataset' is not NULL, then it will be attached to the
1061 * resulting new rdataset in the database, or to the existing data if
1062 * the existing data was better.
1066 * 'db' is a valid database.
1068 * 'node' is a valid node.
1070 * 'rdataset' is a valid, associated rdataset with the same class
1073 * 'addedrdataset' is NULL, or a valid, unassociated rdataset.
1075 * The database has zone semantics and 'version' is a valid
1076 * read-write version, or the database has cache semantics
1077 * and version is NULL.
1079 * If the database has cache semantics, the DNS_DBADD_MERGE option must
1085 * DNS_R_UNCHANGED The operation did not change anything.
1089 * Other results are possible, depending upon the database
1090 * implementation used.
1094 dns_db_subtractrdataset(dns_db_t *db, dns_dbnode_t *node,
1095 dns_dbversion_t *version, dns_rdataset_t *rdataset,
1096 unsigned int options, dns_rdataset_t *newrdataset);
1098 * Remove any rdata in 'rdataset' from 'node' in version 'version' of
1103 * If 'newrdataset' is not NULL, then it will be attached to the
1104 * resulting new rdataset in the database, unless the rdataset has
1105 * become nonexistent. If DNS_DBSUB_EXACT is set then all elements
1106 * of 'rdataset' must exist at 'node'.
1110 * 'db' is a valid database.
1112 * 'node' is a valid node.
1114 * 'rdataset' is a valid, associated rdataset with the same class
1117 * 'newrdataset' is NULL, or a valid, unassociated rdataset.
1119 * The database has zone semantics and 'version' is a valid
1120 * read-write version.
1125 * DNS_R_UNCHANGED The operation did not change anything.
1126 * DNS_R_NXRRSET All rdata of the same type as those
1127 * in 'rdataset' have been deleted.
1128 * DNS_R_NOTEXACT Some part of 'rdataset' did not
1129 * exist and DNS_DBSUB_EXACT was set.
1131 * Other results are possible, depending upon the database
1132 * implementation used.
1136 dns_db_deleterdataset(dns_db_t *db, dns_dbnode_t *node,
1137 dns_dbversion_t *version, dns_rdatatype_t type,
1138 dns_rdatatype_t covers);
1140 * Make it so that no rdataset of type 'type' exists at 'node' in version
1141 * version 'version' of 'db'.
1145 * If 'type' is dns_rdatatype_any, then no rdatasets will exist in
1146 * 'version' (provided that the dns_db_deleterdataset() isn't followed
1147 * by one or more dns_db_addrdataset() calls).
1151 * 'db' is a valid database.
1153 * 'node' is a valid node.
1155 * The database has zone semantics and 'version' is a valid
1156 * read-write version, or the database has cache semantics
1157 * and version is NULL.
1159 * 'type' is not a meta-RR type, except for dns_rdatatype_any, which is
1162 * If 'covers' != 0, 'type' must be SIG.
1167 * DNS_R_UNCHANGED No rdatasets of 'type' existed before
1168 * the operation was attempted.
1170 * Other results are possible, depending upon the database
1171 * implementation used.
1175 dns_db_getsoaserial(dns_db_t *db, dns_dbversion_t *ver, isc_uint32_t *serialp);
1177 * Get the current SOA serial number from a zone database.
1180 * 'db' is a valid database with zone semantics.
1181 * 'ver' is a valid version.
1185 dns_db_overmem(dns_db_t *db, isc_boolean_t overmem);
1187 * Enable / disable agressive cache cleaning.
1191 dns_db_nodecount(dns_db_t *db);
1193 * Count the number of nodes in 'db'.
1197 * 'db' is a valid database.
1200 * The number of nodes in the database
1204 dns_db_settask(dns_db_t *db, isc_task_t *task);
1206 * If task is set then the final detach maybe performed asynchronously.
1209 * 'db' is a valid database.
1210 * 'task' to be valid or NULL.
1214 dns_db_ispersistent(dns_db_t *db);
1216 * Is 'db' persistent? A persistent database does not need to be loaded
1217 * from disk or written to disk.
1221 * 'db' is a valid database.
1224 * ISC_TRUE 'db' is persistent.
1225 * ISC_FALSE 'db' is not persistent.
1229 dns_db_register(const char *name, dns_dbcreatefunc_t create, void *driverarg,
1230 isc_mem_t *mctx, dns_dbimplementation_t **dbimp);
1233 * Register a new database implementation and add it to the list of
1234 * supported implementations.
1238 * 'name' is not NULL
1239 * 'order' is a valid function pointer
1240 * 'mctx' is a valid memory context
1241 * dbimp != NULL && *dbimp == NULL
1244 * ISC_R_SUCCESS The registration succeeded
1245 * ISC_R_NOMEMORY Out of memory
1246 * ISC_R_EXISTS A database implementation with the same name exists
1250 * *dbimp points to an opaque structure which must be passed to
1251 * dns_db_unregister().
1255 dns_db_unregister(dns_dbimplementation_t **dbimp);
1257 * Remove a database implementation from the the list of supported
1258 * implementations. No databases of this type can be active when this
1262 * dbimp != NULL && *dbimp == NULL
1266 * Any memory allocated in *dbimp will be freed.
1271 #endif /* DNS_DB_H */