30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington/*
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews * Copyright (C) 2000, 2001, 2004-2007, 2009, 2013, 2016 Internet Systems Consortium, Inc. ("ISC")
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington *
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews * This Source Code Form is subject to the terms of the Mozilla Public
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews * License, v. 2.0. If a copy of the MPL was not distributed with this
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews * file, You can obtain one at http://mozilla.org/MPL/2.0/.
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington */
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington#ifndef DNS_FORWARD_H
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington#define DNS_FORWARD_H 1
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/*! \file dns/forward.h */
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington#include <isc/lang.h>
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington#include <isc/result.h>
b4ccec331dbd81581c6226a54847385a27d9eb25Evan Hunt#include <isc/sockaddr.h>
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington#include <dns/types.h>
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian WellingtonISC_LANG_BEGINDECLS
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington
67adc03ef81fb610f8df093b17f55275ee816754Evan Huntstruct dns_forwarder {
67adc03ef81fb610f8df093b17f55275ee816754Evan Hunt isc_sockaddr_t addr;
67adc03ef81fb610f8df093b17f55275ee816754Evan Hunt isc_dscp_t dscp;
67adc03ef81fb610f8df093b17f55275ee816754Evan Hunt ISC_LINK(dns_forwarder_t) link;
67adc03ef81fb610f8df093b17f55275ee816754Evan Hunt};
67adc03ef81fb610f8df093b17f55275ee816754Evan Hunt
67adc03ef81fb610f8df093b17f55275ee816754Evan Hunttypedef ISC_LIST(struct dns_forwarder) dns_forwarderlist_t;
67adc03ef81fb610f8df093b17f55275ee816754Evan Hunt
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellingtonstruct dns_forwarders {
67adc03ef81fb610f8df093b17f55275ee816754Evan Hunt dns_forwarderlist_t fwdrs;
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington dns_fwdpolicy_t fwdpolicy;
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington};
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellingtonisc_result_t
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellingtondns_fwdtable_create(isc_mem_t *mctx, dns_fwdtable_t **fwdtablep);
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein/*%<
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington * Creates a new forwarding table.
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington *
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington * Requires:
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein * \li mctx is a valid memory context.
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein * \li fwdtablep != NULL && *fwdtablep == NULL
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington *
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington * Returns:
fb827ed6df9a473770fb69a75a455b4ad0d14f52Mark Andrews * \li #ISC_R_SUCCESS
fb827ed6df9a473770fb69a75a455b4ad0d14f52Mark Andrews * \li #ISC_R_NOMEMORY
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington */
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellingtonisc_result_t
67adc03ef81fb610f8df093b17f55275ee816754Evan Huntdns_fwdtable_addfwd(dns_fwdtable_t *fwdtable, dns_name_t *name,
67adc03ef81fb610f8df093b17f55275ee816754Evan Hunt dns_forwarderlist_t *fwdrs, dns_fwdpolicy_t policy);
67adc03ef81fb610f8df093b17f55275ee816754Evan Huntisc_result_t
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellingtondns_fwdtable_add(dns_fwdtable_t *fwdtable, dns_name_t *name,
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington isc_sockaddrlist_t *addrs, dns_fwdpolicy_t policy);
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein/*%<
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington * Adds an entry to the forwarding table. The entry associates
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington * a domain with a list of forwarders and a forwarding policy. The
67adc03ef81fb610f8df093b17f55275ee816754Evan Hunt * addrs/fwdrs list is copied if not empty, so the caller should free
67adc03ef81fb610f8df093b17f55275ee816754Evan Hunt * its copy.
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington *
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington * Requires:
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein * \li fwdtable is a valid forwarding table.
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein * \li name is a valid name
67adc03ef81fb610f8df093b17f55275ee816754Evan Hunt * \li addrs/fwdrs is a valid list of isc_sockaddr/dns_forwarder
67adc03ef81fb610f8df093b17f55275ee816754Evan Hunt * structures, which may be empty.
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington *
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington * Returns:
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein * \li #ISC_R_SUCCESS
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein * \li #ISC_R_NOMEMORY
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington */
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉isc_result_t
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉dns_fwdtable_delete(dns_fwdtable_t *fwdtable, dns_name_t *name);
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉/*%<
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 * Removes an entry for 'name' from the forwarding table. If an entry
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 * that exactly matches 'name' does not exist, ISC_R_NOTFOUND will be returned.
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 *
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 * Requires:
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 * \li fwdtable is a valid forwarding table.
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 * \li name is a valid name
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 *
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 * Returns:
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 * \li #ISC_R_SUCCESS
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 * \li #ISC_R_NOTFOUND
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 */
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellingtonisc_result_t
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellingtondns_fwdtable_find(dns_fwdtable_t *fwdtable, dns_name_t *name,
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington dns_forwarders_t **forwardersp);
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein/*%<
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein * Finds a domain in the forwarding table. The closest matching parent
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein * domain is returned.
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein *
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein * Requires:
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein * \li fwdtable is a valid forwarding table.
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein * \li name is a valid name
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein * \li forwardersp != NULL && *forwardersp == NULL
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein *
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein * Returns:
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein * \li #ISC_R_SUCCESS
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein * \li #ISC_R_NOTFOUND
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein */
8a713ca49ddddb36e432d4717800f9258a5c2ea9Mark Andrews
8a713ca49ddddb36e432d4717800f9258a5c2ea9Mark Andrewsisc_result_t
8a713ca49ddddb36e432d4717800f9258a5c2ea9Mark Andrewsdns_fwdtable_find2(dns_fwdtable_t *fwdtable, dns_name_t *name,
8a713ca49ddddb36e432d4717800f9258a5c2ea9Mark Andrews dns_name_t *foundname, dns_forwarders_t **forwardersp);
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein/*%<
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington * Finds a domain in the forwarding table. The closest matching parent
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington * domain is returned.
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington *
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington * Requires:
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein * \li fwdtable is a valid forwarding table.
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein * \li name is a valid name
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein * \li forwardersp != NULL && *forwardersp == NULL
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein * \li foundname to be NULL or a valid name with buffer.
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington *
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington * Returns:
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein * \li #ISC_R_SUCCESS
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein * \li #ISC_R_NOTFOUND
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington */
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellingtonvoid
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellingtondns_fwdtable_destroy(dns_fwdtable_t **fwdtablep);
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein/*%<
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington * Destroys a forwarding table.
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington *
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington * Requires:
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein * \li fwtablep != NULL && *fwtablep != NULL
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington *
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington * Ensures:
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein * \li all memory associated with the forwarding table is freed.
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington */
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian WellingtonISC_LANG_ENDDECLS
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington#endif /* DNS_FORWARD_H */