xref: /freebsd/contrib/unbound/util/shm_side/shm_main.h (revision e0c4386e7e71d93b0edc0c8fa156263fc4a8b0b6)
1 /*
2  * util/shm_side/shm_main.h - control the shared memory for unbound.
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 for the SHM side.
40  */
41 
42 #ifndef UTIL_SHM_SIDE_MAIN_H
43 #define UTIL_SHM_SIDE_MAIN_H
44 struct daemon;
45 struct worker;
46 
47 /* get struct ub_shm_stat_info */
48 #include "libunbound/unbound.h"
49 
50 /**
51  * The SHM info.
52  */
53 struct shm_main_info {
54 	/** stats_info array, shared memory segment.
55 	 * [0] is totals, [1..thread_num] are per-thread stats */
56 	struct ub_stats_info* ptr_arr;
57 	/** the global stats block, shared memory segment */
58 	struct ub_shm_stat_info* ptr_ctl;
59 	int key;
60 	int id_ctl;
61 	int id_arr;
62 };
63 
64 int shm_main_init(struct daemon* daemon);
65 void shm_main_shutdown(struct daemon* daemon);
66 void shm_main_run(struct worker *worker);
67 
68 #endif /* UTIL_SHM_SIDE_MAIN_H */
69