mirror of
https://github.com/isc-projects/bind9.git
synced 2026-05-23 18:47:40 -04:00
10accd6260
the isc_mem allocation functions can no longer fail; as a result, ISC_R_NOMEMORY is now rarely used: only when an external library such as libjson-c or libfstrm could return NULL. (even in these cases, arguably we should assert rather than returning ISC_R_NOMEMORY.) code and comments that mentioned ISC_R_NOMEMORY have been cleaned up, and the following functions have been changed to type void, since (in most cases) the only value they could return was ISC_R_SUCCESS: - dns_dns64_create() - dns_dyndb_create() - dns_ipkeylist_resize() - dns_kasp_create() - dns_kasp_key_create() - dns_keystore_create() - dns_order_create() - dns_order_add() - dns_peerlist_new() - dns_tkeyctx_create() - dns_view_create() - dns_zone_setorigin() - dns_zone_setfile() - dns_zone_setstream() - dns_zone_getdbtype() - dns_zone_setjournal() - dns_zone_setkeydirectory() - isc_lex_openstream() - isc_portset_create() - isc_symtab_create() (the exception is dns_view_create(), which could have returned other error codes in the event of a crypto library failure when calling isc_file_sanitize(), but that should be a RUNTIME_CHECK anyway.)
174 lines
4.1 KiB
C
174 lines
4.1 KiB
C
/*
|
|
* Copyright (C) Internet Systems Consortium, Inc. ("ISC")
|
|
*
|
|
* SPDX-License-Identifier: MPL-2.0
|
|
*
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, you can obtain one at https://mozilla.org/MPL/2.0/.
|
|
*
|
|
* See the COPYRIGHT file distributed with this work for additional
|
|
* information regarding copyright ownership.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
/*****
|
|
***** Module Info
|
|
*****/
|
|
|
|
/*! \file dns/rriterator.h
|
|
* \brief
|
|
* Functions for "walking" a zone database, visiting each RR or RRset in turn.
|
|
*/
|
|
|
|
/*****
|
|
***** Imports
|
|
*****/
|
|
|
|
#include <inttypes.h>
|
|
|
|
#include <isc/magic.h>
|
|
#include <isc/stdtime.h>
|
|
|
|
#include <dns/db.h>
|
|
#include <dns/dbiterator.h>
|
|
#include <dns/fixedname.h>
|
|
#include <dns/name.h>
|
|
#include <dns/rdata.h>
|
|
#include <dns/rdataset.h>
|
|
#include <dns/rdatasetiter.h>
|
|
#include <dns/types.h>
|
|
|
|
/*****
|
|
***** Types
|
|
*****/
|
|
|
|
/*%
|
|
* A dns_rriterator_t is an iterator that iterates over an entire database,
|
|
* returning one RR at a time, in some arbitrary order.
|
|
*/
|
|
|
|
typedef struct dns_rriterator {
|
|
unsigned int magic;
|
|
isc_result_t result;
|
|
dns_db_t *db;
|
|
dns_dbiterator_t *dbit;
|
|
dns_dbversion_t *ver;
|
|
isc_stdtime_t now;
|
|
dns_dbnode_t *node;
|
|
dns_fixedname_t fixedname;
|
|
dns_rdatasetiter_t *rdatasetit;
|
|
dns_rdataset_t rdataset;
|
|
dns_rdata_t rdata;
|
|
} dns_rriterator_t;
|
|
|
|
#define RRITERATOR_MAGIC ISC_MAGIC('R', 'R', 'I', 't')
|
|
#define VALID_RRITERATOR(m) ISC_MAGIC_VALID(m, RRITERATOR_MAGIC)
|
|
|
|
isc_result_t
|
|
dns_rriterator_init(dns_rriterator_t *it, dns_db_t *db, dns_dbversion_t *ver,
|
|
isc_stdtime_t now);
|
|
/*%
|
|
* Initialize an rriterator; sets the cursor to the origin node
|
|
* of the database.
|
|
*
|
|
* Requires:
|
|
*
|
|
* \li 'db' is a valid database.
|
|
*
|
|
* Returns:
|
|
*
|
|
* \li #ISC_R_SUCCESS
|
|
* \li any error from dns_db_createiterator()
|
|
*/
|
|
|
|
isc_result_t
|
|
dns_rriterator_first(dns_rriterator_t *it);
|
|
/*%<
|
|
* Move the rriterator cursor to the first rdata in the database.
|
|
*
|
|
* Requires:
|
|
*\li 'it' is a valid, initialized rriterator
|
|
*
|
|
* Returns:
|
|
*\li #ISC_R_SUCCESS
|
|
*\li #ISC_R_NOMORE There are no rdata in the set.
|
|
*/
|
|
|
|
isc_result_t
|
|
dns_rriterator_nextrrset(dns_rriterator_t *it);
|
|
/*%<
|
|
* Move the rriterator cursor to the next rrset in the database,
|
|
* skipping over any remaining records that have the same rdatatype
|
|
* as the current one.
|
|
*
|
|
* Requires:
|
|
*\li 'it' is a valid, initialized rriterator
|
|
*
|
|
* Returns:
|
|
*\li #ISC_R_SUCCESS
|
|
*\li #ISC_R_NOMORE No more rrsets in the database
|
|
*/
|
|
|
|
isc_result_t
|
|
dns_rriterator_next(dns_rriterator_t *it);
|
|
/*%<
|
|
* Move the rriterator cursor to the next rrset in the database,
|
|
* skipping over any remaining records that have the same rdatatype
|
|
* as the current one.
|
|
*
|
|
* Requires:
|
|
*\li 'it' is a valid, initialized rriterator
|
|
*
|
|
* Returns:
|
|
*\li #ISC_R_SUCCESS
|
|
*\li #ISC_R_NOMORE No more records in the database
|
|
*/
|
|
|
|
void
|
|
dns_rriterator_current(dns_rriterator_t *it, dns_name_t **name, uint32_t *ttl,
|
|
dns_rdataset_t **rdataset, dns_rdata_t **rdata);
|
|
/*%<
|
|
* Make '*name' refer to the current name. If 'rdataset' is not NULL,
|
|
* make '*rdataset' refer to the current * rdataset. If '*rdata' is not
|
|
* NULL, make '*rdata' refer to the current record.
|
|
*
|
|
* Requires:
|
|
*\li '*name' is a valid name object
|
|
*\li 'rdataset' is NULL or '*rdataset' is NULL
|
|
*\li 'rdata' is NULL or '*rdata' is NULL
|
|
*
|
|
* Ensures:
|
|
*\li 'rdata' refers to the rdata at the rdata cursor location of
|
|
*\li 'rdataset'.
|
|
*/
|
|
|
|
void
|
|
dns_rriterator_pause(dns_rriterator_t *it);
|
|
/*%<
|
|
* Pause rriterator. Frees any locks held by the database iterator.
|
|
* Callers should use this routine any time they are not going to
|
|
* execute another rriterator method in the immediate future.
|
|
*
|
|
* Requires:
|
|
*\li 'it' is a valid iterator.
|
|
*
|
|
* Ensures:
|
|
*\li Any database locks being held for efficiency of iterator access are
|
|
* released.
|
|
*/
|
|
|
|
void
|
|
dns_rriterator_destroy(dns_rriterator_t *it);
|
|
/*%<
|
|
* Shut down and free resources in rriterator 'it'.
|
|
*
|
|
* Requires:
|
|
*
|
|
*\li 'it' is a valid iterator.
|
|
*
|
|
* Ensures:
|
|
*
|
|
*\li All resources used by the rriterator are freed.
|
|
*/
|