contrib/unbound/services/view.h

   1 /*
   2  * services/view.h - named views containing local zones authority service.
   3  *
   4  * Copyright (c) 2016, 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 enable named views that can hold local zone
  40  * authority service.
  41  */
  42
  43 #ifndef SERVICES_VIEW_H
  44 #define SERVICES_VIEW_H
  45 #include "util/rbtree.h"
  46 #include "util/locks.h"
  47 struct regional;
  48 struct config_file;
  49 struct config_view;
  50
  51
  52 /**
  53  * Views storage, shared.
  54  */
  55 struct views {
  56         /** lock on the view tree */
  57         lock_rw_t lock;
  58         /** rbtree of struct view */
  59         rbtree_t vtree;
  60 };
  61
  62 /**
  63  * View. Named structure holding local authority zones.
  64  */
  65 struct view {
  66         /** rbtree node, key is name */
  67         rbnode_t node;
  68         /** view name.
  69          * Has to be right after rbnode_t due to pointer arithmatic in
  70          * view_create's lock protect */
  71         char* name;
  72         /** view specific local authority zones */
  73         struct local_zones* local_zones;
  74         /** Fallback to global local_zones when there is no match in the view
  75          * specific tree. 1 for yes, 0 for no */
  76         int isfirst;
  77         /** lock on the data in the structure
  78          * For the node and name you
  79          * need to also hold the views_tree lock to change them (or to
  80          * delete this view) */
  81         lock_rw_t lock;
  82 };
  83
  84
  85 /**
  86  * Create views storage
  87  * @return new struct or NULL on error.
  88  */
  89 struct views* views_create(void);
  90
  91 /**
  92  * Delete views storage
  93  * @param v: views to delete.
  94  */
  95 void views_delete(struct views* v);
  96
  97 /**
  98  * Apply config settings;
  99  * Takes care of locking.
 100  * @param v: view is set up.
 101  * @param cfg: config data.
 102  * @return false on error.
 103  */
 104 int views_apply_cfg(struct views* v, struct config_file* cfg);
 105
 106 /**
 107  * Compare two view entries in rbtree. Sort canonical.
 108  * @param v1: view 1
 109  * @param v2: view 2
 110  * @return: negative, positive or 0 comparison value.
 111  */
 112 int view_cmp(const void* v1, const void* v2);
 113
 114 /**
 115  * Delete one view
 116  * @param v: view to delete.
 117  */
 118 void view_delete(struct view* v);
 119
 120 /**
 121  * Debug helper. Print all views
 122  * Takes care of locking.
 123  * @param v: the views tree
 124  */
 125 void views_print(struct views* v);
 126
 127 /* Find a view by name.
 128  * @param vs: views
 129  * @param name: name of the view we are looking for
 130  * @param write: 1 for obtaining write lock on found view, 0 for read lock
 131  * @return: locked view or NULL.
 132  */
 133 struct view* views_find_view(struct views* vs, const char* name, int write);
 134
 135 #endif /* SERVICES_VIEW_H */