2 * Copyright (C) 2004, 2005, 2007-2009 Internet Systems Consortium, Inc. ("ISC")
3 * Copyright (C) 1999-2001, 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.c,v 1.83.128.4 2009/04/29 23:46:55 tbox Exp $ */
28 #include <isc/buffer.h>
31 #include <isc/rwlock.h>
32 #include <isc/string.h>
35 #include <dns/callbacks.h>
38 #include <dns/master.h>
39 #include <dns/rdata.h>
40 #include <dns/rdataset.h>
41 #include <dns/result.h>
47 struct dns_dbimplementation {
49 dns_dbcreatefunc_t create;
52 ISC_LINK(dns_dbimplementation_t) link;
56 *** Supported DB Implementations Registry
60 * Built in database implementations are registered here.
66 static ISC_LIST(dns_dbimplementation_t) implementations;
67 static isc_rwlock_t implock;
68 static isc_once_t once = ISC_ONCE_INIT;
70 static dns_dbimplementation_t rbtimp;
71 static dns_dbimplementation_t rbt64imp;
75 RUNTIME_CHECK(isc_rwlock_init(&implock, 0, 0) == ISC_R_SUCCESS);
78 rbtimp.create = dns_rbtdb_create;
80 rbtimp.driverarg = NULL;
81 ISC_LINK_INIT(&rbtimp, link);
83 rbt64imp.name = "rbt64";
84 rbt64imp.create = dns_rbtdb64_create;
86 rbt64imp.driverarg = NULL;
87 ISC_LINK_INIT(&rbt64imp, link);
89 ISC_LIST_INIT(implementations);
90 ISC_LIST_APPEND(implementations, &rbtimp, link);
91 ISC_LIST_APPEND(implementations, &rbt64imp, link);
94 static inline dns_dbimplementation_t *
95 impfind(const char *name) {
96 dns_dbimplementation_t *imp;
98 for (imp = ISC_LIST_HEAD(implementations);
100 imp = ISC_LIST_NEXT(imp, link))
101 if (strcasecmp(name, imp->name) == 0)
112 dns_db_create(isc_mem_t *mctx, const char *db_type, dns_name_t *origin,
113 dns_dbtype_t type, dns_rdataclass_t rdclass,
114 unsigned int argc, char *argv[], dns_db_t **dbp)
116 dns_dbimplementation_t *impinfo;
118 RUNTIME_CHECK(isc_once_do(&once, initialize) == ISC_R_SUCCESS);
121 * Create a new database using implementation 'db_type'.
124 REQUIRE(dbp != NULL && *dbp == NULL);
125 REQUIRE(dns_name_isabsolute(origin));
127 RWLOCK(&implock, isc_rwlocktype_read);
128 impinfo = impfind(db_type);
129 if (impinfo != NULL) {
131 result = ((impinfo->create)(mctx, origin, type,
133 impinfo->driverarg, dbp));
134 RWUNLOCK(&implock, isc_rwlocktype_read);
138 RWUNLOCK(&implock, isc_rwlocktype_read);
140 isc_log_write(dns_lctx, DNS_LOGCATEGORY_DATABASE,
141 DNS_LOGMODULE_DB, ISC_LOG_ERROR,
142 "unsupported database type '%s'", db_type);
144 return (ISC_R_NOTFOUND);
148 dns_db_attach(dns_db_t *source, dns_db_t **targetp) {
151 * Attach *targetp to source.
154 REQUIRE(DNS_DB_VALID(source));
155 REQUIRE(targetp != NULL && *targetp == NULL);
157 (source->methods->attach)(source, targetp);
159 ENSURE(*targetp == source);
163 dns_db_detach(dns_db_t **dbp) {
166 * Detach *dbp from its database.
169 REQUIRE(dbp != NULL);
170 REQUIRE(DNS_DB_VALID(*dbp));
172 ((*dbp)->methods->detach)(dbp);
174 ENSURE(*dbp == NULL);
178 dns_db_ondestroy(dns_db_t *db, isc_task_t *task, isc_event_t **eventp)
180 REQUIRE(DNS_DB_VALID(db));
182 return (isc_ondestroy_register(&db->ondest, task, eventp));
187 dns_db_iscache(dns_db_t *db) {
190 * Does 'db' have cache semantics?
193 REQUIRE(DNS_DB_VALID(db));
195 if ((db->attributes & DNS_DBATTR_CACHE) != 0)
202 dns_db_iszone(dns_db_t *db) {
205 * Does 'db' have zone semantics?
208 REQUIRE(DNS_DB_VALID(db));
210 if ((db->attributes & (DNS_DBATTR_CACHE|DNS_DBATTR_STUB)) == 0)
217 dns_db_isstub(dns_db_t *db) {
220 * Does 'db' have stub semantics?
223 REQUIRE(DNS_DB_VALID(db));
225 if ((db->attributes & DNS_DBATTR_STUB) != 0)
232 dns_db_issecure(dns_db_t *db) {
238 REQUIRE(DNS_DB_VALID(db));
239 REQUIRE((db->attributes & DNS_DBATTR_CACHE) == 0);
241 return ((db->methods->issecure)(db));
245 dns_db_ispersistent(dns_db_t *db) {
248 * Is 'db' persistent?
251 REQUIRE(DNS_DB_VALID(db));
253 return ((db->methods->ispersistent)(db));
257 dns_db_origin(dns_db_t *db) {
259 * The origin of the database.
262 REQUIRE(DNS_DB_VALID(db));
264 return (&db->origin);
268 dns_db_class(dns_db_t *db) {
270 * The class of the database.
273 REQUIRE(DNS_DB_VALID(db));
275 return (db->rdclass);
279 dns_db_beginload(dns_db_t *db, dns_addrdatasetfunc_t *addp,
280 dns_dbload_t **dbloadp) {
282 * Begin loading 'db'.
285 REQUIRE(DNS_DB_VALID(db));
286 REQUIRE(addp != NULL && *addp == NULL);
287 REQUIRE(dbloadp != NULL && *dbloadp == NULL);
289 return ((db->methods->beginload)(db, addp, dbloadp));
293 dns_db_endload(dns_db_t *db, dns_dbload_t **dbloadp) {
295 * Finish loading 'db'.
298 REQUIRE(DNS_DB_VALID(db));
299 REQUIRE(dbloadp != NULL && *dbloadp != NULL);
301 return ((db->methods->endload)(db, dbloadp));
305 dns_db_load(dns_db_t *db, const char *filename) {
306 return (dns_db_load2(db, filename, dns_masterformat_text));
310 dns_db_load2(dns_db_t *db, const char *filename, dns_masterformat_t format) {
311 isc_result_t result, eresult;
312 dns_rdatacallbacks_t callbacks;
313 unsigned int options = 0;
316 * Load master file 'filename' into 'db'.
319 REQUIRE(DNS_DB_VALID(db));
321 if ((db->attributes & DNS_DBATTR_CACHE) != 0)
322 options |= DNS_MASTER_AGETTL;
324 dns_rdatacallbacks_init(&callbacks);
326 result = dns_db_beginload(db, &callbacks.add, &callbacks.add_private);
327 if (result != ISC_R_SUCCESS)
329 result = dns_master_loadfile2(filename, &db->origin, &db->origin,
330 db->rdclass, options,
331 &callbacks, db->mctx, format);
332 eresult = dns_db_endload(db, &callbacks.add_private);
334 * We always call dns_db_endload(), but we only want to return its
335 * result if dns_master_loadfile() succeeded. If dns_master_loadfile()
336 * failed, we want to return the result code it gave us.
338 if (eresult != ISC_R_SUCCESS &&
339 (result == ISC_R_SUCCESS || result == DNS_R_SEENINCLUDE))
346 dns_db_dump(dns_db_t *db, dns_dbversion_t *version, const char *filename) {
347 return ((db->methods->dump)(db, version, filename,
348 dns_masterformat_text));
352 dns_db_dump2(dns_db_t *db, dns_dbversion_t *version, const char *filename,
353 dns_masterformat_t masterformat) {
355 * Dump 'db' into master file 'filename' in the 'masterformat' format.
356 * XXXJT: is it okay to modify the interface to the existing "dump"
360 REQUIRE(DNS_DB_VALID(db));
362 return ((db->methods->dump)(db, version, filename, masterformat));
370 dns_db_currentversion(dns_db_t *db, dns_dbversion_t **versionp) {
373 * Open the current version for reading.
376 REQUIRE(DNS_DB_VALID(db));
377 REQUIRE((db->attributes & DNS_DBATTR_CACHE) == 0);
378 REQUIRE(versionp != NULL && *versionp == NULL);
380 (db->methods->currentversion)(db, versionp);
384 dns_db_newversion(dns_db_t *db, dns_dbversion_t **versionp) {
387 * Open a new version for reading and writing.
390 REQUIRE(DNS_DB_VALID(db));
391 REQUIRE((db->attributes & DNS_DBATTR_CACHE) == 0);
392 REQUIRE(versionp != NULL && *versionp == NULL);
394 return ((db->methods->newversion)(db, versionp));
398 dns_db_attachversion(dns_db_t *db, dns_dbversion_t *source,
399 dns_dbversion_t **targetp)
402 * Attach '*targetp' to 'source'.
405 REQUIRE(DNS_DB_VALID(db));
406 REQUIRE((db->attributes & DNS_DBATTR_CACHE) == 0);
407 REQUIRE(source != NULL);
408 REQUIRE(targetp != NULL && *targetp == NULL);
410 (db->methods->attachversion)(db, source, targetp);
412 ENSURE(*targetp != NULL);
416 dns_db_closeversion(dns_db_t *db, dns_dbversion_t **versionp,
417 isc_boolean_t commit)
421 * Close version '*versionp'.
424 REQUIRE(DNS_DB_VALID(db));
425 REQUIRE((db->attributes & DNS_DBATTR_CACHE) == 0);
426 REQUIRE(versionp != NULL && *versionp != NULL);
428 (db->methods->closeversion)(db, versionp, commit);
430 ENSURE(*versionp == NULL);
438 dns_db_findnode(dns_db_t *db, dns_name_t *name,
439 isc_boolean_t create, dns_dbnode_t **nodep)
443 * Find the node with name 'name'.
446 REQUIRE(DNS_DB_VALID(db));
447 REQUIRE(nodep != NULL && *nodep == NULL);
449 return ((db->methods->findnode)(db, name, create, nodep));
453 dns_db_find(dns_db_t *db, dns_name_t *name, dns_dbversion_t *version,
454 dns_rdatatype_t type, unsigned int options, isc_stdtime_t now,
455 dns_dbnode_t **nodep, dns_name_t *foundname,
456 dns_rdataset_t *rdataset, dns_rdataset_t *sigrdataset)
460 * Find the best match for 'name' and 'type' in version 'version'
464 REQUIRE(DNS_DB_VALID(db));
465 REQUIRE(type != dns_rdatatype_rrsig);
466 REQUIRE(nodep == NULL || (nodep != NULL && *nodep == NULL));
467 REQUIRE(dns_name_hasbuffer(foundname));
468 REQUIRE(rdataset == NULL ||
469 (DNS_RDATASET_VALID(rdataset) &&
470 ! dns_rdataset_isassociated(rdataset)));
471 REQUIRE(sigrdataset == NULL ||
472 (DNS_RDATASET_VALID(sigrdataset) &&
473 ! dns_rdataset_isassociated(sigrdataset)));
475 return ((db->methods->find)(db, name, version, type, options, now,
476 nodep, foundname, rdataset, sigrdataset));
480 dns_db_findzonecut(dns_db_t *db, dns_name_t *name,
481 unsigned int options, isc_stdtime_t now,
482 dns_dbnode_t **nodep, dns_name_t *foundname,
483 dns_rdataset_t *rdataset, dns_rdataset_t *sigrdataset)
486 * Find the deepest known zonecut which encloses 'name' in 'db'.
489 REQUIRE(DNS_DB_VALID(db));
490 REQUIRE((db->attributes & DNS_DBATTR_CACHE) != 0);
491 REQUIRE(nodep == NULL || (nodep != NULL && *nodep == NULL));
492 REQUIRE(dns_name_hasbuffer(foundname));
493 REQUIRE(sigrdataset == NULL ||
494 (DNS_RDATASET_VALID(sigrdataset) &&
495 ! dns_rdataset_isassociated(sigrdataset)));
497 return ((db->methods->findzonecut)(db, name, options, now, nodep,
498 foundname, rdataset, sigrdataset));
502 dns_db_attachnode(dns_db_t *db, dns_dbnode_t *source, dns_dbnode_t **targetp) {
505 * Attach *targetp to source.
508 REQUIRE(DNS_DB_VALID(db));
509 REQUIRE(source != NULL);
510 REQUIRE(targetp != NULL && *targetp == NULL);
512 (db->methods->attachnode)(db, source, targetp);
516 dns_db_detachnode(dns_db_t *db, dns_dbnode_t **nodep) {
519 * Detach *nodep from its node.
522 REQUIRE(DNS_DB_VALID(db));
523 REQUIRE(nodep != NULL && *nodep != NULL);
525 (db->methods->detachnode)(db, nodep);
527 ENSURE(*nodep == NULL);
531 dns_db_transfernode(dns_db_t *db, dns_dbnode_t **sourcep,
532 dns_dbnode_t **targetp)
534 REQUIRE(DNS_DB_VALID(db));
535 REQUIRE(targetp != NULL && *targetp == NULL);
537 * This doesn't check the implementation magic. If we find that
538 * we need such checks in future then this will be done in the
541 REQUIRE(sourcep != NULL && *sourcep != NULL);
545 if (db->methods->transfernode == NULL) {
549 (db->methods->transfernode)(db, sourcep, targetp);
551 ENSURE(*sourcep == NULL);
555 dns_db_expirenode(dns_db_t *db, dns_dbnode_t *node, isc_stdtime_t now) {
558 * Mark as stale all records at 'node' which expire at or before 'now'.
561 REQUIRE(DNS_DB_VALID(db));
562 REQUIRE((db->attributes & DNS_DBATTR_CACHE) != 0);
563 REQUIRE(node != NULL);
565 return ((db->methods->expirenode)(db, node, now));
569 dns_db_printnode(dns_db_t *db, dns_dbnode_t *node, FILE *out) {
571 * Print a textual representation of the contents of the node to
575 REQUIRE(DNS_DB_VALID(db));
576 REQUIRE(node != NULL);
578 (db->methods->printnode)(db, node, out);
582 *** DB Iterator Creation
586 dns_db_createiterator(dns_db_t *db, isc_boolean_t relative_names,
587 dns_dbiterator_t **iteratorp)
590 * Create an iterator for version 'version' of 'db'.
593 REQUIRE(DNS_DB_VALID(db));
594 REQUIRE(iteratorp != NULL && *iteratorp == NULL);
596 return (db->methods->createiterator(db, relative_names, iteratorp));
604 dns_db_findrdataset(dns_db_t *db, dns_dbnode_t *node, dns_dbversion_t *version,
605 dns_rdatatype_t type, dns_rdatatype_t covers,
606 isc_stdtime_t now, dns_rdataset_t *rdataset,
607 dns_rdataset_t *sigrdataset)
610 * Search for an rdataset of type 'type' at 'node' that are in version
611 * 'version' of 'db'. If found, make 'rdataset' refer to it.
614 REQUIRE(DNS_DB_VALID(db));
615 REQUIRE(node != NULL);
616 REQUIRE(DNS_RDATASET_VALID(rdataset));
617 REQUIRE(! dns_rdataset_isassociated(rdataset));
618 REQUIRE(covers == 0 || type == dns_rdatatype_rrsig);
619 REQUIRE(type != dns_rdatatype_any);
620 REQUIRE(sigrdataset == NULL ||
621 (DNS_RDATASET_VALID(sigrdataset) &&
622 ! dns_rdataset_isassociated(sigrdataset)));
624 return ((db->methods->findrdataset)(db, node, version, type, covers,
625 now, rdataset, sigrdataset));
629 dns_db_allrdatasets(dns_db_t *db, dns_dbnode_t *node, dns_dbversion_t *version,
630 isc_stdtime_t now, dns_rdatasetiter_t **iteratorp)
633 * Make '*iteratorp' an rdataset iteratator for all rdatasets at
634 * 'node' in version 'version' of 'db'.
637 REQUIRE(DNS_DB_VALID(db));
638 REQUIRE(iteratorp != NULL && *iteratorp == NULL);
640 return ((db->methods->allrdatasets)(db, node, version, now,
645 dns_db_addrdataset(dns_db_t *db, dns_dbnode_t *node, dns_dbversion_t *version,
646 isc_stdtime_t now, dns_rdataset_t *rdataset,
647 unsigned int options, dns_rdataset_t *addedrdataset)
650 * Add 'rdataset' to 'node' in version 'version' of 'db'.
653 REQUIRE(DNS_DB_VALID(db));
654 REQUIRE(node != NULL);
655 REQUIRE(((db->attributes & DNS_DBATTR_CACHE) == 0 && version != NULL)||
656 ((db->attributes & DNS_DBATTR_CACHE) != 0 &&
657 version == NULL && (options & DNS_DBADD_MERGE) == 0));
658 REQUIRE((options & DNS_DBADD_EXACT) == 0 ||
659 (options & DNS_DBADD_MERGE) != 0);
660 REQUIRE(DNS_RDATASET_VALID(rdataset));
661 REQUIRE(dns_rdataset_isassociated(rdataset));
662 REQUIRE(rdataset->rdclass == db->rdclass);
663 REQUIRE(addedrdataset == NULL ||
664 (DNS_RDATASET_VALID(addedrdataset) &&
665 ! dns_rdataset_isassociated(addedrdataset)));
667 return ((db->methods->addrdataset)(db, node, version, now, rdataset,
668 options, addedrdataset));
672 dns_db_subtractrdataset(dns_db_t *db, dns_dbnode_t *node,
673 dns_dbversion_t *version, dns_rdataset_t *rdataset,
674 unsigned int options, dns_rdataset_t *newrdataset)
677 * Remove any rdata in 'rdataset' from 'node' in version 'version' of
681 REQUIRE(DNS_DB_VALID(db));
682 REQUIRE(node != NULL);
683 REQUIRE((db->attributes & DNS_DBATTR_CACHE) == 0 && version != NULL);
684 REQUIRE(DNS_RDATASET_VALID(rdataset));
685 REQUIRE(dns_rdataset_isassociated(rdataset));
686 REQUIRE(rdataset->rdclass == db->rdclass);
687 REQUIRE(newrdataset == NULL ||
688 (DNS_RDATASET_VALID(newrdataset) &&
689 ! dns_rdataset_isassociated(newrdataset)));
691 return ((db->methods->subtractrdataset)(db, node, version, rdataset,
692 options, newrdataset));
696 dns_db_deleterdataset(dns_db_t *db, dns_dbnode_t *node,
697 dns_dbversion_t *version, dns_rdatatype_t type,
698 dns_rdatatype_t covers)
701 * Make it so that no rdataset of type 'type' exists at 'node' in
702 * version version 'version' of 'db'.
705 REQUIRE(DNS_DB_VALID(db));
706 REQUIRE(node != NULL);
707 REQUIRE(((db->attributes & DNS_DBATTR_CACHE) == 0 && version != NULL)||
708 ((db->attributes & DNS_DBATTR_CACHE) != 0 && version == NULL));
710 return ((db->methods->deleterdataset)(db, node, version,
715 dns_db_overmem(dns_db_t *db, isc_boolean_t overmem) {
717 REQUIRE(DNS_DB_VALID(db));
719 (db->methods->overmem)(db, overmem);
723 dns_db_getsoaserial(dns_db_t *db, dns_dbversion_t *ver, isc_uint32_t *serialp)
726 dns_dbnode_t *node = NULL;
727 dns_rdataset_t rdataset;
728 dns_rdata_t rdata = DNS_RDATA_INIT;
731 REQUIRE(dns_db_iszone(db) || dns_db_isstub(db));
733 result = dns_db_findnode(db, dns_db_origin(db), ISC_FALSE, &node);
734 if (result != ISC_R_SUCCESS)
737 dns_rdataset_init(&rdataset);
738 result = dns_db_findrdataset(db, node, ver, dns_rdatatype_soa, 0,
739 (isc_stdtime_t)0, &rdataset, NULL);
740 if (result != ISC_R_SUCCESS)
743 result = dns_rdataset_first(&rdataset);
744 if (result != ISC_R_SUCCESS)
746 dns_rdataset_current(&rdataset, &rdata);
747 result = dns_rdataset_next(&rdataset);
748 INSIST(result == ISC_R_NOMORE);
750 INSIST(rdata.length > 20);
751 isc_buffer_init(&buffer, rdata.data, rdata.length);
752 isc_buffer_add(&buffer, rdata.length);
753 isc_buffer_forward(&buffer, rdata.length - 20);
754 *serialp = isc_buffer_getuint32(&buffer);
756 result = ISC_R_SUCCESS;
759 dns_rdataset_disassociate(&rdataset);
762 dns_db_detachnode(db, &node);
767 dns_db_nodecount(dns_db_t *db) {
768 REQUIRE(DNS_DB_VALID(db));
770 return ((db->methods->nodecount)(db));
774 dns_db_settask(dns_db_t *db, isc_task_t *task) {
775 REQUIRE(DNS_DB_VALID(db));
777 (db->methods->settask)(db, task);
781 dns_db_register(const char *name, dns_dbcreatefunc_t create, void *driverarg,
782 isc_mem_t *mctx, dns_dbimplementation_t **dbimp)
784 dns_dbimplementation_t *imp;
786 REQUIRE(name != NULL);
787 REQUIRE(dbimp != NULL && *dbimp == NULL);
789 RUNTIME_CHECK(isc_once_do(&once, initialize) == ISC_R_SUCCESS);
791 RWLOCK(&implock, isc_rwlocktype_write);
794 RWUNLOCK(&implock, isc_rwlocktype_write);
795 return (ISC_R_EXISTS);
798 imp = isc_mem_get(mctx, sizeof(dns_dbimplementation_t));
800 RWUNLOCK(&implock, isc_rwlocktype_write);
801 return (ISC_R_NOMEMORY);
804 imp->create = create;
806 imp->driverarg = driverarg;
807 isc_mem_attach(mctx, &imp->mctx);
808 ISC_LINK_INIT(imp, link);
809 ISC_LIST_APPEND(implementations, imp, link);
810 RWUNLOCK(&implock, isc_rwlocktype_write);
814 return (ISC_R_SUCCESS);
818 dns_db_unregister(dns_dbimplementation_t **dbimp) {
819 dns_dbimplementation_t *imp;
822 REQUIRE(dbimp != NULL && *dbimp != NULL);
824 RUNTIME_CHECK(isc_once_do(&once, initialize) == ISC_R_SUCCESS);
828 RWLOCK(&implock, isc_rwlocktype_write);
829 ISC_LIST_UNLINK(implementations, imp, link);
831 isc_mem_put(mctx, imp, sizeof(dns_dbimplementation_t));
832 isc_mem_detach(&mctx);
833 RWUNLOCK(&implock, isc_rwlocktype_write);
834 ENSURE(*dbimp == NULL);
838 dns_db_getrrsetstats(dns_db_t *db) {
839 REQUIRE(DNS_DB_VALID(db));
841 if (db->methods->getrrsetstats != NULL)
842 return ((db->methods->getrrsetstats)(db));
848 dns_db_getoriginnode(dns_db_t *db, dns_dbnode_t **nodep) {
849 REQUIRE(DNS_DB_VALID(db));
850 REQUIRE(dns_db_iszone(db) == ISC_TRUE);
851 REQUIRE(nodep != NULL && *nodep == NULL);
853 if (db->methods->getoriginnode != NULL)
854 return ((db->methods->getoriginnode)(db, nodep));
856 return (ISC_R_NOTFOUND);