Home | History | Annotate | Line # | Download | only in iterator 
      1 /*
      2  * iterator/iter_donotq.h - iterative resolver donotqueryaddresses storage.
      3  *
      4  * Copyright (c) 2007, NLnet Labs. All rights reserved.
      5  *
      6  * This software is open source.
      7  *
      8  * Redistribution and use in source and binary forms, with or without
      9  * modification, are permitted provided that the following conditions
     10  * are met:
     11  *
     12  * Redistributions of source code must retain the above copyright notice,
     13  * this list of conditions and the following disclaimer.
     14  *
     15  * Redistributions in binary form must reproduce the above copyright notice,
     16  * this list of conditions and the following disclaimer in the documentation
     17  * and/or other materials provided with the distribution.
     18  *
     19  * Neither the name of the NLNET LABS nor the names of its contributors may
     20  * be used to endorse or promote products derived from this software without
     21  * specific prior written permission.
     22  *
     23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     24  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     25  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
     26  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     27  * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     28  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
     29  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
     30  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
     31  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
     32  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
     33  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     34  */
     35 
     36 /**
     37  * \file
     38  *
     39  * This file contains functions to assist the iterator module.
     40  * Keep track of the donotquery addresses and lookup fast.
     41  */
     42 
     43 #ifndef ITERATOR_ITER_DONOTQ_H
     44 #define ITERATOR_ITER_DONOTQ_H
     45 #include "util/storage/dnstree.h"
     46 struct iter_env;
     47 struct config_file;
     48 struct regional;
     49 
     50 /**
     51  * Iterator donotqueryaddresses structure
     52  */
     53 struct iter_donotq {
     54 	/** regional for allocation */
     55 	struct regional* region;
     56 	/**
     57 	 * Tree of the address spans that are blocked.
     58 	 * contents of type addr_tree_node. Each node is an address span
     59 	 * that must not be used to send queries to.
     60 	 */
     61 	rbtree_type tree;
     62 };
     63 
     64 /**
     65  * Create donotqueryaddresses structure
     66  * @return new structure or NULL on error.
     67  */
     68 struct iter_donotq* donotq_create(void);
     69 
     70 /**
     71  * Delete donotqueryaddresses structure.
     72  * @param donotq: to delete.
     73  */
     74 void donotq_delete(struct iter_donotq* donotq);
     75 
     76 /**
     77  * Process donotqueryaddresses config.
     78  * @param donotq: where to store.
     79  * @param cfg: config options.
     80  * @return 0 on error.
     81  */
     82 int donotq_apply_cfg(struct iter_donotq* donotq, struct config_file* cfg);
     83 
     84 /**
     85  * See if an address is blocked.
     86  * @param donotq: structure for address storage.
     87  * @param addr: address to check
     88  * @param addrlen: length of addr.
     89  * @return: true if the address must not be queried. false if unlisted.
     90  */
     91 int donotq_lookup(struct iter_donotq* donotq, struct sockaddr_storage* addr,
     92 	socklen_t addrlen);
     93 
     94 /**
     95  * Get memory used by donotqueryaddresses structure.
     96  * @param donotq: structure for address storage.
     97  * @return bytes in use.
     98  */
     99 size_t donotq_get_mem(struct iter_donotq* donotq);
    100 
    101 #endif /* ITERATOR_ITER_DONOTQ_H */
    102