xref: /freebsd/contrib/unbound/util/shm_side/shm_main.h (revision 5fa84c6ec176d186ddad25d31f8760e50f48157f)
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 #include "util/locks.h"
51 
52 /**
53  * The SHM info.
54  */
55 struct shm_main_info {
56 	/** stats_info array, shared memory segment.
57 	 * [0] is totals, [1..thread_num] are per-thread stats */
58 	struct ub_stats_info* ptr_arr;
59 	/** the global stats block, shared memory segment */
60 	struct ub_shm_stat_info* ptr_ctl;
61 	int key;
62 	int id_ctl;
63 	int id_arr;
64 
65 	/** This mutex is on the volley information. */
66 	lock_basic_type lock;
67 	/** If there is a volley, a number of stat timer callbacks by the
68 	 * threads, in progress. If not, there is no volley in progress and the
69 	 * previous stat run has terminated succesfully for all threads.
70 	 * Usually activated by the first thread and deactivated by the last
71 	 * thread that starts its stat callback. */
72 	int volley_in_progress;
73 	/** Per thread, if they have put in stats. 0 if not. */
74 	int* thread_volley;
75 	/** The total stats of the thread stat timers, it is in progress */
76 	struct ub_stats_info total_in_progress;
77 };
78 
79 int shm_main_init(struct daemon* daemon);
80 void shm_main_shutdown(struct daemon* daemon);
81 void shm_main_run(struct worker *worker);
82 
83 #endif /* UTIL_SHM_SIDE_MAIN_H */
84