1/* 2 * Copyright (C) 2004, 2005, 2007 Internet Systems Consortium, Inc. ("ISC") 3 * Copyright (C) 2000, 2001 Internet Software Consortium. 4 * 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. 8 * 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. 16 */ 17 18/* $Id: lwsearch.h,v 1.9 2007/06/19 23:46:59 tbox Exp $ */ 19 20#ifndef NAMED_LWSEARCH_H 21#define NAMED_LWSEARCH_H 1 22 23#include <isc/mutex.h> 24#include <isc/result.h> 25#include <isc/types.h> 26 27#include <dns/types.h> 28 29#include <named/types.h> 30 31/*! \file 32 * \brief 33 * Lightweight resolver search list types and routines. 34 * 35 * An ns_lwsearchlist_t holds a list of search path elements. 36 * 37 * An ns_lwsearchctx stores the state of search list during a lookup 38 * operation. 39 */ 40 41/*% An ns_lwsearchlist_t holds a list of search path elements. */ 42struct ns_lwsearchlist { 43 unsigned int magic; 44 45 isc_mutex_t lock; 46 isc_mem_t *mctx; 47 unsigned int refs; 48 dns_namelist_t names; 49}; 50/*% An ns_lwsearchctx stores the state of search list during a lookup operation. */ 51struct ns_lwsearchctx { 52 dns_name_t *relname; 53 dns_name_t *searchname; 54 unsigned int ndots; 55 ns_lwsearchlist_t *list; 56 isc_boolean_t doneexact; 57 isc_boolean_t exactfirst; 58}; 59 60isc_result_t 61ns_lwsearchlist_create(isc_mem_t *mctx, ns_lwsearchlist_t **listp); 62/*%< 63 * Create an empty search list object. 64 */ 65 66void 67ns_lwsearchlist_attach(ns_lwsearchlist_t *source, ns_lwsearchlist_t **target); 68/*%< 69 * Attach to a search list object. 70 */ 71 72void 73ns_lwsearchlist_detach(ns_lwsearchlist_t **listp); 74/*%< 75 * Detach from a search list object. 76 */ 77 78isc_result_t 79ns_lwsearchlist_append(ns_lwsearchlist_t *list, dns_name_t *name); 80/*%< 81 * Append an element to a search list. This creates a copy of the name. 82 */ 83 84void 85ns_lwsearchctx_init(ns_lwsearchctx_t *sctx, ns_lwsearchlist_t *list, 86 dns_name_t *name, unsigned int ndots); 87/*%< 88 * Creates a search list context structure. 89 */ 90 91void 92ns_lwsearchctx_first(ns_lwsearchctx_t *sctx); 93/*%< 94 * Moves the search list context iterator to the first element, which 95 * is usually the exact name. 96 */ 97 98isc_result_t 99ns_lwsearchctx_next(ns_lwsearchctx_t *sctx); 100/*%< 101 * Moves the search list context iterator to the next element. 102 */ 103 104isc_result_t 105ns_lwsearchctx_current(ns_lwsearchctx_t *sctx, dns_name_t *absname); 106/*%< 107 * Obtains the current name to be looked up. This involves either 108 * concatenating the name with a search path element, making an 109 * exact name absolute, or doing nothing. 110 */ 111 112#endif /* NAMED_LWSEARCH_H */ 113