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