xref: /dragonfly/sys/sys/globaldata.h (revision cfd1aba3)
1 /*
2  * Copyright (c) 2003-2011 The DragonFly Project.  All rights reserved.
3  *
4  * This code is derived from software contributed to The DragonFly Project
5  * by Matthew Dillon <dillon@backplane.com>
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in
15  *    the documentation and/or other materials provided with the
16  *    distribution.
17  * 3. Neither the name of The DragonFly Project nor the names of its
18  *    contributors may be used to endorse or promote products derived
19  *    from this software without specific, prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
25  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  * Copyright (c) Peter Wemm <peter@netplex.com.au> All rights reserved.
35  *
36  * Redistribution and use in source and binary forms, with or without
37  * modification, are permitted provided that the following conditions
38  * are met:
39  * 1. Redistributions of source code must retain the above copyright
40  *    notice, this list of conditions and the following disclaimer.
41  * 2. Redistributions in binary form must reproduce the above copyright
42  *    notice, this list of conditions and the following disclaimer in the
43  *    documentation and/or other materials provided with the distribution.
44  *
45  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
46  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
47  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
48  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
49  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
50  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
51  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
52  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
53  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
54  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
55  * SUCH DAMAGE.
56  */
57 
58 #ifndef _SYS_GLOBALDATA_H_
59 #define _SYS_GLOBALDATA_H_
60 
61 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
62 
63 #ifndef _SYS_STDINT_H_
64 #include <sys/stdint.h>	/* __int types */
65 #endif
66 #ifndef _SYS_TIME_H_
67 #include <sys/time.h>	/* struct timeval */
68 #endif
69 #ifndef _SYS_VMMETER_H_
70 #include <sys/vmmeter.h> /* struct vmmeter */
71 #endif
72 #ifndef _SYS_THREAD_H_
73 #include <sys/thread.h>	/* struct thread */
74 #endif
75 #ifndef _SYS_SLABALLOC_H_
76 #include <sys/slaballoc.h> /* SLGlobalData */
77 #endif
78 #ifndef _SYS_SYSTIMER_H_
79 #include <sys/systimer.h> /* fine-grained system timers */
80 #endif
81 #ifndef _SYS_NCHSTATS_H_
82 #include <sys/nchstats.h>
83 #endif
84 #ifndef _SYS_SYSID_H_
85 #include <sys/sysid.h>	  /* sysid_t */
86 #endif
87 
88 /*
89  * This structure maps out the global data that needs to be kept on a
90  * per-cpu basis.  genassym uses this to generate offsets for the assembler
91  * code.  The machine-dependant portions of this file can be found in
92  * <machine/globaldata.h>, but only MD code should retrieve it.
93  *
94  * The SMP parts are setup in pmap.c and locore.s for the BSP, and
95  * mp_machdep.c sets up the data for the AP's to "see" when they awake.
96  * The reason for doing it via a struct is so that an array of pointers
97  * to each CPU's data can be set up for things like "check curproc on all
98  * other processors"
99  *
100  * NOTE! this structure needs to remain compatible between module accessors
101  * and the kernel, so we can't throw in lots of #ifdef's.
102  *
103  * gd_reqflags serves serveral purposes, but it is primarily an interrupt
104  * rollup flag used by the task switcher and spl mechanisms to decide that
105  * further checks are necessary.  Interrupts are typically managed on a
106  * per-processor basis at least until you leave a critical section, but
107  * may then be scheduled to other cpus.
108  *
109  * gd_vme_avail and gd_vme_base cache free vm_map_entry structures for use
110  * in various vm_map related operations.  gd_vme_avail is *NOT* a count of
111  * the number of structures in the cache but is instead a count of the number
112  * of unreserved structures in the cache.  See vm_map_entry_reserve().
113  */
114 
115 struct sysmsg;
116 struct tslpentry;
117 struct privatespace;
118 struct vm_map_entry;
119 struct spinlock;
120 struct pipe;
121 
122 struct globaldata {
123 	struct privatespace *gd_prvspace;	/* self-reference */
124 	struct thread	*gd_curthread;
125 	struct thread	*gd_freetd;		/* cache one free td */
126 	__uint32_t	gd_reqflags;		/* (see note above) */
127 	long		gd_flags;
128 	lwkt_queue	gd_tdallq;		/* all threads */
129 	lwkt_queue	gd_tdrunq;		/* runnable threads */
130 	__uint32_t	gd_cpuid;
131 	cpumask_t	gd_cpumask;		/* mask = CPUMASK(cpuid) */
132 	cpumask_t	gd_other_cpus;		/* mask of 'other' cpus */
133 	struct timeval	gd_stattv;
134 	int		gd_intr_nesting_level;	/* hard code, intrs, ipis */
135 	struct vmmeter	gd_cnt;
136 	struct vmtotal	gd_vmtotal;
137 	cpumask_t	gd_ipimask;		/* pending ipis from cpus */
138 	struct lwkt_ipiq *gd_ipiq;		/* array[ncpu] of ipiq's */
139 	struct lwkt_ipiq gd_cpusyncq;		/* ipiq for cpu synchro */
140 	u_int		gd_npoll;		/* ipiq synchronization */
141 	int		gd_tdrunqcount;
142 	struct thread	gd_unused02B;
143 	struct thread	gd_idlethread;
144 	SLGlobalData	gd_slab;		/* slab allocator */
145 	int		gd_trap_nesting_level;	/* track traps */
146 	int		gd_vme_avail;		/* vm_map_entry reservation */
147 	struct vm_map_entry *gd_vme_base;	/* vm_map_entry reservation */
148 	struct systimerq gd_systimerq;		/* per-cpu system timers */
149 	int		gd_syst_nest;
150 	struct systimer gd_hardclock;		/* scheduler periodic */
151 	struct systimer gd_statclock;		/* statistics periodic */
152 	struct systimer gd_schedclock;		/* scheduler periodic */
153 	volatile __uint32_t gd_time_seconds;	/* uptime in seconds */
154 	volatile sysclock_t gd_cpuclock_base;	/* cpuclock relative base */
155 
156 	struct pipe	*gd_pipeq;		/* cache pipe structures */
157 	struct nchstats	*gd_nchstats;		/* namecache effectiveness */
158 	int		gd_pipeqcount;		/* number of structures */
159 	sysid_t		gd_sysid_alloc;		/* allocate unique sysid */
160 
161 	struct tslpque	*gd_tsleep_hash;	/* tsleep/wakeup support */
162 	long		gd_processing_ipiq;
163 	int		gd_spinlocks;		/* Exclusive spinlocks held */
164 	struct systimer	*gd_systimer_inprog;	/* in-progress systimer */
165 	int		gd_timer_running;
166 	u_int		gd_idle_repeat;		/* repeated switches to idle */
167 	int		gd_ireserved[7];
168 	const char	*gd_infomsg;		/* debugging */
169 	struct lwkt_tokref gd_handoff;		/* hand-off tokref */
170 	void		*gd_delayed_wakeup[2];
171 	void		*gd_sample_pc;		/* sample program ctr/tr */
172 	void		*gd_preserved[5];	/* future fields */
173 	/* extended by <machine/globaldata.h> */
174 };
175 
176 typedef struct globaldata *globaldata_t;
177 
178 #define RQB_IPIQ		0	/* 0001 */
179 #define RQB_INTPEND		1	/* 0002 */
180 #define RQB_AST_OWEUPC		2	/* 0004 */
181 #define RQB_AST_SIGNAL		3	/* 0008 */
182 #define RQB_AST_USER_RESCHED	4	/* 0010 */
183 #define RQB_AST_LWKT_RESCHED	5	/* 0020 */
184 #define RQB_UNUSED6		6	/* 0040 */
185 #define RQB_TIMER		7	/* 0080 */
186 #define RQB_RUNNING		8	/* 0100 */
187 #define RQB_SPINNING		9	/* 0200 */
188 #define RQB_QUICKRET		10	/* 0400 */
189 
190 #define RQF_IPIQ		(1 << RQB_IPIQ)
191 #define RQF_INTPEND		(1 << RQB_INTPEND)
192 #define RQF_TIMER		(1 << RQB_TIMER)
193 #define RQF_AST_OWEUPC		(1 << RQB_AST_OWEUPC)
194 #define RQF_AST_SIGNAL		(1 << RQB_AST_SIGNAL)
195 #define RQF_AST_USER_RESCHED	(1 << RQB_AST_USER_RESCHED)
196 #define RQF_AST_LWKT_RESCHED	(1 << RQB_AST_LWKT_RESCHED)
197 #define RQF_RUNNING		(1 << RQB_RUNNING)
198 #define RQF_SPINNING		(1 << RQB_SPINNING)
199 #define RQF_QUICKRET		(1 << RQB_QUICKRET)
200 
201 #define RQF_AST_MASK		(RQF_AST_OWEUPC|RQF_AST_SIGNAL|\
202 				RQF_AST_USER_RESCHED|RQF_AST_LWKT_RESCHED)
203 #define RQF_IDLECHECK_MASK	(RQF_IPIQ|RQF_INTPEND|RQF_TIMER)
204 #define RQF_IDLECHECK_WK_MASK	(RQF_IDLECHECK_MASK|RQF_AST_LWKT_RESCHED)
205 
206 /*
207  * globaldata flags
208  */
209 #define GDF_KPRINTF		0x0001	/* kprintf() reentrancy */
210 
211 #endif
212 
213 /*
214  * MANUAL DEBUG CODE FOR DEBUGGING LOCKUPS
215  */
216 #ifdef _KERNEL
217 
218 #if 0
219 
220 #define DEBUG_PUSH_INFO(msg)				\
221 	const char *save_infomsg;			\
222 	save_infomsg = mycpu->gd_infomsg;		\
223 	mycpu->gd_infomsg = msg				\
224 
225 #define DEBUG_POP_INFO()	mycpu->gd_infomsg = save_infomsg
226 
227 #else
228 
229 #define DEBUG_PUSH_INFO(msg)
230 #define DEBUG_POP_INFO()
231 
232 #endif
233 
234 #endif
235 
236 #ifdef _KERNEL
237 struct globaldata *globaldata_find(int cpu);
238 int is_globaldata_space(vm_offset_t saddr, vm_offset_t eaddr);
239 #endif
240 
241 #endif
242