lib/dns/db.c

	db.c revision 364a82f7c25b62967678027043425201a5e5171a
/*
 * Copyright (C) 1999, 2000  Internet Software Consortium.
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM DISCLAIMS
 * ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL INTERNET SOFTWARE
 * CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
 * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
 * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
 * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
 * SOFTWARE.
 */

/***
 *** Imports
 ***/

#include <config.h>

#include <stddef.h>
#include <string.h>

#include <isc/assertions.h>
#include <isc/ondestroy.h>
#include <isc/util.h>

#include <dns/db.h>
#include <dns/master.h>
#include <dns/rdataset.h>

/***
 *** Private Types
 ***/

typedef struct {
    char *          name;
    isc_result_t        (*create)(isc_mem_t *mctx, dns_name_t *name,
                      isc_boolean_t cache,
                      dns_rdataclass_t rdclass,
                      unsigned int argc, char *argv[],
                      dns_db_t **dbp);
} impinfo_t;

/***
 *** Supported DB Implementations Registry
 ***/

/*
 * Supported database implementations must be registered here.
 *
 * It might be nice to generate this automatically some day.
 */

#include "rbtdb.h"
#include "rbtdb64.h"

impinfo_t implementations[] = {
    { "rbt", dns_rbtdb_create },
    { "rbt64", dns_rbtdb64_create },
    { NULL, NULL }
};

/***
 *** Basic DB Methods
 ***/

isc_result_t
dns_db_create(isc_mem_t *mctx, char *db_type, dns_name_t *origin,
          isc_boolean_t cache, dns_rdataclass_t rdclass,
          unsigned int argc, char *argv[], dns_db_t **dbp)
{
    impinfo_t *impinfo;

    /*
     * Create a new database using implementation 'db_type'.
     */

    REQUIRE(dbp != NULL && *dbp == NULL);
    REQUIRE(dns_name_isabsolute(origin));

    for (impinfo = implementations; impinfo->name != NULL; impinfo++)
        if (strcasecmp(db_type, impinfo->name) == 0)
            return ((impinfo->create)(mctx, origin, cache, rdclass,
                          argc, argv, dbp));

    return (ISC_R_NOTFOUND);
}

void
dns_db_attach(dns_db_t *source, dns_db_t **targetp) {

    /*
     * Attach *targetp to source.
     */

    REQUIRE(DNS_DB_VALID(source));
    REQUIRE(targetp != NULL);

    (source->methods->attach)(source, targetp);

    ENSURE(*targetp == source);
}

void
dns_db_detach(dns_db_t **dbp) {

    /*
     * Detach *dbp from its database.
     */

    REQUIRE(dbp != NULL);
    REQUIRE(DNS_DB_VALID(*dbp));

    ((*dbp)->methods->detach)(dbp);

    ENSURE(*dbp == NULL);
}

isc_result_t
dns_db_ondestroy(dns_db_t *db, isc_task_t *task, isc_event_t **eventp)
{
    REQUIRE(DNS_DB_VALID(db));

    return (isc_ondestroy_register(&db->ondest, task, eventp));
}


isc_boolean_t
dns_db_iscache(dns_db_t *db) {

    /*
     * Does 'db' have cache semantics?
     */

    REQUIRE(DNS_DB_VALID(db));

    if ((db->attributes & DNS_DBATTR_CACHE) != 0)
        return (ISC_TRUE);

    return (ISC_FALSE);
}

isc_boolean_t
dns_db_iszone(dns_db_t *db) {

    /*
     * Does 'db' have zone semantics?
     */

    REQUIRE(DNS_DB_VALID(db));

    if ((db->attributes & DNS_DBATTR_CACHE) == 0)
        return (ISC_TRUE);

    return (ISC_FALSE);
}

isc_boolean_t
dns_db_issecure(dns_db_t *db) {

    /*
     * Is 'db' secure?
     */

    REQUIRE(DNS_DB_VALID(db));
    REQUIRE((db->attributes & DNS_DBATTR_CACHE) == 0);

    return ((db->methods->issecure)(db));
}

dns_name_t *
dns_db_origin(dns_db_t *db) {
    /*
     * The origin of the database.
     */

    REQUIRE(DNS_DB_VALID(db));

    return (&db->origin);
}

dns_rdataclass_t
dns_db_class(dns_db_t *db) {
    /*
     * The class of the database.
     */

    REQUIRE(DNS_DB_VALID(db));

    return (db->rdclass);
}

isc_result_t
dns_db_beginload(dns_db_t *db, dns_addrdatasetfunc_t *addp,
         dns_dbload_t **dbloadp) {
    /*
     * Begin loading 'db'.
     */

    REQUIRE(DNS_DB_VALID(db));
    REQUIRE(addp != NULL && *addp == NULL);
    REQUIRE(dbloadp != NULL && *dbloadp == NULL);

    return ((db->methods->beginload)(db, addp, dbloadp));
}

isc_result_t
dns_db_endload(dns_db_t *db, dns_dbload_t **dbloadp) {
    /*
     * Finish loading 'db'.
     */

    REQUIRE(DNS_DB_VALID(db));
    REQUIRE(dbloadp != NULL && *dbloadp != NULL);

    return ((db->methods->endload)(db, dbloadp));
}

isc_result_t
dns_db_load(dns_db_t *db, const char *filename) {
    isc_result_t result, eresult;
    int soacount, nscount;
    dns_rdatacallbacks_t callbacks;
    isc_boolean_t age_ttl = ISC_FALSE;

    /*
     * Load master file 'filename' into 'db'.
     */

    REQUIRE(DNS_DB_VALID(db));

    if ((db->attributes & DNS_DBATTR_CACHE) != 0)
        age_ttl = ISC_TRUE;

    dns_rdatacallbacks_init(&callbacks);

    result = dns_db_beginload(db, &callbacks.add, &callbacks.add_private);
    if (result != ISC_R_SUCCESS)
        return (result);
    result = dns_master_loadfile(filename, &db->origin, &db->origin,
                     db->rdclass, age_ttl, &soacount, &nscount,
                     &callbacks, db->mctx);
    eresult = dns_db_endload(db, &callbacks.add_private);
    /*
     * We always call dns_db_endload(), but we only want to return its
     * result if dns_master_loadfile() succeeded.  If dns_master_loadfile()
     * failed, we want to return the result code it gave us.
     */
    if (result == ISC_R_SUCCESS)
        result = eresult;

    return (result);
}

isc_result_t
dns_db_dump(dns_db_t *db, dns_dbversion_t *version, const char *filename) {
    /*
     * Dump 'db' into master file 'filename'.
     */

    REQUIRE(DNS_DB_VALID(db));

    return ((db->methods->dump)(db, version, filename));
}

/***
 *** Version Methods
 ***/

void
dns_db_currentversion(dns_db_t *db, dns_dbversion_t **versionp) {

    /*
     * Open the current version for reading.
     */

    REQUIRE(DNS_DB_VALID(db));
    REQUIRE((db->attributes & DNS_DBATTR_CACHE) == 0);
    REQUIRE(versionp != NULL && *versionp == NULL);

    (db->methods->currentversion)(db, versionp);
}

isc_result_t
dns_db_newversion(dns_db_t *db, dns_dbversion_t **versionp) {

    /*
     * Open a new version for reading and writing.
     */

    REQUIRE(DNS_DB_VALID(db));
    REQUIRE((db->attributes & DNS_DBATTR_CACHE) == 0);
    REQUIRE(versionp != NULL && *versionp == NULL);

    return ((db->methods->newversion)(db, versionp));
}

void
dns_db_attachversion(dns_db_t *db, dns_dbversion_t *source,
             dns_dbversion_t **targetp)
{
    /*
     * Attach '*targetp' to 'source'.
     */

    REQUIRE(DNS_DB_VALID(db));
    REQUIRE((db->attributes & DNS_DBATTR_CACHE) == 0);
    REQUIRE(source != NULL);
    REQUIRE(targetp != NULL && *targetp != NULL);

    (db->methods->attachversion)(db, source, targetp);

    ENSURE(*targetp != NULL);
}

void
dns_db_closeversion(dns_db_t *db, dns_dbversion_t **versionp,
            isc_boolean_t commit)
{

    /*
     * Close version '*versionp'.
     */

    REQUIRE(DNS_DB_VALID(db));
    REQUIRE((db->attributes & DNS_DBATTR_CACHE) == 0);
    REQUIRE(versionp != NULL && *versionp != NULL);

    (db->methods->closeversion)(db, versionp, commit);

    ENSURE(*versionp == NULL);
}

/***
 *** Node Methods
 ***/

isc_result_t
dns_db_findnode(dns_db_t *db, dns_name_t *name,
        isc_boolean_t create, dns_dbnode_t **nodep)
{

    /*
     * Find the node with name 'name'.
     */

    REQUIRE(DNS_DB_VALID(db));
    REQUIRE(dns_name_issubdomain(name, &db->origin));
    REQUIRE(nodep != NULL && *nodep == NULL);

    return ((db->methods->findnode)(db, name, create, nodep));
}

isc_result_t
dns_db_find(dns_db_t *db, dns_name_t *name, dns_dbversion_t *version,
        dns_rdatatype_t type, unsigned int options, isc_stdtime_t now,
        dns_dbnode_t **nodep, dns_name_t *foundname,
        dns_rdataset_t *rdataset, dns_rdataset_t *sigrdataset)
{

    /*
     * Find the best match for 'name' and 'type' in version 'version'
     * of 'db'.
     */

    REQUIRE(DNS_DB_VALID(db));
    REQUIRE(type != dns_rdatatype_sig);
    REQUIRE(nodep == NULL || (nodep != NULL && *nodep == NULL));
    REQUIRE(dns_name_hasbuffer(foundname));
    REQUIRE(rdataset == NULL ||
        (DNS_RDATASET_VALID(rdataset) && rdataset->methods == NULL));
    REQUIRE(sigrdataset == NULL ||
        (DNS_RDATASET_VALID(sigrdataset) &&
         sigrdataset->methods == NULL));

    return ((db->methods->find)(db, name, version, type, options, now,
                    nodep, foundname, rdataset, sigrdataset));
}

isc_result_t
dns_db_findzonecut(dns_db_t *db, dns_name_t *name,
           unsigned int options, isc_stdtime_t now,
           dns_dbnode_t **nodep, dns_name_t *foundname,
           dns_rdataset_t *rdataset, dns_rdataset_t *sigrdataset)
{
    /*
     * Find the deepest known zonecut which encloses 'name' in 'db'.
     */

    REQUIRE(DNS_DB_VALID(db));
    REQUIRE((db->attributes & DNS_DBATTR_CACHE) != 0);
    REQUIRE(nodep == NULL || (nodep != NULL && *nodep == NULL));
    REQUIRE(dns_name_hasbuffer(foundname));
    REQUIRE(sigrdataset == NULL ||
        (DNS_RDATASET_VALID(sigrdataset) &&
         sigrdataset->methods == NULL));

    return ((db->methods->findzonecut)(db, name, options, now, nodep,
                       foundname, rdataset, sigrdataset));
}

void
dns_db_attachnode(dns_db_t *db, dns_dbnode_t *source, dns_dbnode_t **targetp) {

    /*
     * Attach *targetp to source.
     */

    REQUIRE(DNS_DB_VALID(db));
    REQUIRE(source != NULL);
    REQUIRE(targetp != NULL && *targetp == NULL);

    (db->methods->attachnode)(db, source, targetp);
}

void
dns_db_detachnode(dns_db_t *db, dns_dbnode_t **nodep) {

    /*
     * Detach *nodep from its node.
     */

    REQUIRE(DNS_DB_VALID(db));
    REQUIRE(nodep != NULL && *nodep != NULL);

    (db->methods->detachnode)(db, nodep);

    ENSURE(*nodep == NULL);
}

isc_result_t
dns_db_expirenode(dns_db_t *db, dns_dbnode_t *node, isc_stdtime_t now) {

    /*
     * Mark as stale all records at 'node' which expire at or before 'now'.
     */

    REQUIRE(DNS_DB_VALID(db));
    REQUIRE((db->attributes & DNS_DBATTR_CACHE) != 0);
    REQUIRE(node != NULL);

    return ((db->methods->expirenode)(db, node, now));
}

void
dns_db_printnode(dns_db_t *db, dns_dbnode_t *node, FILE *out) {
    /*
     * Print a textual representation of the contents of the node to
     * 'out'.
     */

    REQUIRE(DNS_DB_VALID(db));
    REQUIRE(node != NULL);

    (db->methods->printnode)(db, node, out);
}

/***
 *** DB Iterator Creation
 ***/

isc_result_t
dns_db_createiterator(dns_db_t *db, isc_boolean_t relative_names,
              dns_dbiterator_t **iteratorp)
{
    /*
     * Create an iterator for version 'version' of 'db'.
     */

    REQUIRE(DNS_DB_VALID(db));
    REQUIRE(iteratorp != NULL && *iteratorp == NULL);

    return (db->methods->createiterator(db, relative_names, iteratorp));
}

/***
 *** Rdataset Methods
 ***/

isc_result_t
dns_db_findrdataset(dns_db_t *db, dns_dbnode_t *node, dns_dbversion_t *version,
            dns_rdatatype_t type, dns_rdatatype_t covers,
            isc_stdtime_t now, dns_rdataset_t *rdataset,
            dns_rdataset_t *sigrdataset)
{
    /*
     * Search for an rdataset of type 'type' at 'node' that are in version
     * 'version' of 'db'.  If found, make 'rdataset' refer to it.
     */

    REQUIRE(DNS_DB_VALID(db));
    REQUIRE(node != NULL);
    REQUIRE(DNS_RDATASET_VALID(rdataset));
    REQUIRE(rdataset->methods == NULL);
    REQUIRE(covers == 0 || type == dns_rdatatype_sig);
    REQUIRE(type != dns_rdatatype_any);
    REQUIRE(sigrdataset == NULL ||
        (DNS_RDATASET_VALID(sigrdataset) &&
         sigrdataset->methods == NULL));

    return ((db->methods->findrdataset)(db, node, version, type, covers,
                        now, rdataset, sigrdataset));
}

isc_result_t
dns_db_allrdatasets(dns_db_t *db, dns_dbnode_t *node, dns_dbversion_t *version,
            isc_stdtime_t now, dns_rdatasetiter_t **iteratorp)
{
    /*
     * Make '*iteratorp' an rdataset iteratator for all rdatasets at
     * 'node' in version 'version' of 'db'.
     */

    REQUIRE(DNS_DB_VALID(db));
    REQUIRE(iteratorp != NULL && *iteratorp == NULL);

    return ((db->methods->allrdatasets)(db, node, version, now,
                        iteratorp));
}

isc_result_t
dns_db_addrdataset(dns_db_t *db, dns_dbnode_t *node, dns_dbversion_t *version,
           isc_stdtime_t now, dns_rdataset_t *rdataset,
           unsigned int options, dns_rdataset_t *addedrdataset)
{
    /*
     * Add 'rdataset' to 'node' in version 'version' of 'db'.
     */

    REQUIRE(DNS_DB_VALID(db));
    REQUIRE(node != NULL);
    REQUIRE(((db->attributes & DNS_DBATTR_CACHE) == 0 && version != NULL)||
        ((db->attributes & DNS_DBATTR_CACHE) != 0 &&
         version == NULL && (options & DNS_DBADD_MERGE) == 0));
    REQUIRE(DNS_RDATASET_VALID(rdataset));
    REQUIRE(rdataset->methods != NULL);
    REQUIRE(rdataset->rdclass == db->rdclass);
    REQUIRE(addedrdataset == NULL ||
        (DNS_RDATASET_VALID(addedrdataset) &&
         addedrdataset->methods == NULL));

    return ((db->methods->addrdataset)(db, node, version, now, rdataset,
                       options, addedrdataset));
}

isc_result_t
dns_db_subtractrdataset(dns_db_t *db, dns_dbnode_t *node,
            dns_dbversion_t *version, dns_rdataset_t *rdataset,
            dns_rdataset_t *newrdataset)
{
    /*
     * Remove any rdata in 'rdataset' from 'node' in version 'version' of
     * 'db'.
     */

    REQUIRE(DNS_DB_VALID(db));
    REQUIRE(node != NULL);
    REQUIRE((db->attributes & DNS_DBATTR_CACHE) == 0 && version != NULL);
    REQUIRE(DNS_RDATASET_VALID(rdataset));
    REQUIRE(rdataset->methods != NULL);
    REQUIRE(rdataset->rdclass == db->rdclass);
    REQUIRE(newrdataset == NULL ||
        (DNS_RDATASET_VALID(newrdataset) &&
         newrdataset->methods == NULL));

    return ((db->methods->subtractrdataset)(db, node, version, rdataset,
                        newrdataset));
}

isc_result_t
dns_db_deleterdataset(dns_db_t *db, dns_dbnode_t *node,
              dns_dbversion_t *version, dns_rdatatype_t type,
              dns_rdatatype_t covers)
{
    /*
     * Make it so that no rdataset of type 'type' exists at 'node' in
     * version version 'version' of 'db'.
     */

    REQUIRE(DNS_DB_VALID(db));
    REQUIRE(node != NULL);
    REQUIRE(((db->attributes & DNS_DBATTR_CACHE) == 0 && version != NULL)||
        ((db->attributes & DNS_DBATTR_CACHE) != 0 && version == NULL));

    return ((db->methods->deleterdataset)(db, node, version, type, covers));
}