Home | History | Annotate | Line # | Download | only in services
view.h revision 1.1.1.2 
      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 struct respip_set;
     51 
     52 
     53 /**
     54  * Views storage, shared.
     55  */
     56 struct views {
     57 	/** lock on the view tree. When locking order, the views lock
     58 	 * is before the forwards,hints,anchors,localzones lock. */
     59 	lock_rw_type lock;
     60 	/** rbtree of struct view */
     61 	rbtree_type vtree;
     62 };
     63 
     64 /**
     65  * View. Named structure holding local authority zones.
     66  */
     67 struct view {
     68 	/** rbtree node, key is name */
     69 	rbnode_type node;
     70 	/** view name.
     71 	 * Has to be right after rbnode_t due to pointer arithmetic in
     72 	 * view_create's lock protect */
     73 	char* name;
     74 	/** view specific local authority zones */
     75 	struct local_zones* local_zones;
     76 	/** response-ip configuration data for this view */
     77 	struct respip_set* respip_set;
     78 	/** Fallback to global local_zones when there is no match in the view
     79 	 * specific tree. 1 for yes, 0 for no */
     80 	int isfirst;
     81 	/** lock on the data in the structure
     82 	 * For the node and name you need to also hold the views_tree lock to
     83 	 * change them. */
     84 	lock_rw_type lock;
     85 };
     86 
     87 
     88 /**
     89  * Create views storage
     90  * @return new struct or NULL on error.
     91  */
     92 struct views* views_create(void);
     93 
     94 /**
     95  * Delete views storage
     96  * @param v: views to delete.
     97  */
     98 void views_delete(struct views* v);
     99 
    100 /**
    101  * Apply config settings;
    102  * Takes care of locking.
    103  * @param v: view is set up.
    104  * @param cfg: config data.
    105  * @return false on error.
    106  */
    107 int views_apply_cfg(struct views* v, struct config_file* cfg);
    108 
    109 /**
    110  * Compare two view entries in rbtree. Sort canonical.
    111  * @param v1: view 1
    112  * @param v2: view 2
    113  * @return: negative, positive or 0 comparison value.
    114  */
    115 int view_cmp(const void* v1, const void* v2);
    116 
    117 /**
    118  * Delete one view
    119  * @param v: view to delete.
    120  */
    121 void view_delete(struct view* v);
    122 
    123 /**
    124  * Debug helper. Print all views
    125  * Takes care of locking.
    126  * @param v: the views tree
    127  */
    128 void views_print(struct views* v);
    129 
    130 /**
    131  * Find a view by name.
    132  * @param vs: views
    133  * @param name: name of the view we are looking for
    134  * @param write: 1 for obtaining write lock on found view, 0 for read lock
    135  * @return: locked view or NULL.
    136  */
    137 struct view* views_find_view(struct views* vs, const char* name, int write);
    138 
    139 /**
    140  * Calculate memory usage of views.
    141  * @param vs: the views tree. The routine locks and unlocks the structure
    142  * 	for reading.
    143  * @return memory in bytes.
    144  */
    145 size_t views_get_mem(struct views* vs);
    146 
    147 /**
    148  * Calculate memory usage of view.
    149  * @param v: the view. The routine locks and unlocks the structure for reading.
    150  * @return memory in bytes.
    151  */
    152 size_t view_get_mem(struct view* v);
    153 
    154 /**
    155  * Swap internal tree with preallocated entries. Caller should manage
    156  * the locks.
    157  * @param vs: views tree
    158  * @param data: preallocated information.
    159  */
    160 void views_swap_tree(struct views* vs, struct views* data);
    161 
    162 #endif /* SERVICES_VIEW_H */
    163