xref: /titanic_44/usr/src/uts/common/sys/cpuvar.h (revision dd1104fbe0f0f41434502f335b9f0b34999f771c)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 
22 /*
23  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
24  * Use is subject to license terms.
25  */
26 
27 #ifndef _SYS_CPUVAR_H
28 #define	_SYS_CPUVAR_H
29 
30 #include <sys/thread.h>
31 #include <sys/sysinfo.h>	/* has cpu_stat_t definition */
32 #include <sys/disp.h>
33 #include <sys/processor.h>
34 
35 #if (defined(_KERNEL) || defined(_KMEMUSER)) && defined(_MACHDEP)
36 #include <sys/machcpuvar.h>
37 #endif
38 
39 #include <sys/types.h>
40 #include <sys/file.h>
41 #include <sys/bitmap.h>
42 #include <sys/rwlock.h>
43 #include <sys/msacct.h>
44 #if defined(__GNUC__) && defined(_ASM_INLINES) && defined(_KERNEL) && \
45 	(defined(__i386) || defined(__amd64))
46 #include <asm/cpuvar.h>
47 #endif
48 
49 #ifdef	__cplusplus
50 extern "C" {
51 #endif
52 
53 struct squeue_set_s;
54 
55 #define	CPU_CACHE_COHERENCE_SIZE	64
56 #define	S_LOADAVG_SZ	11
57 #define	S_MOVAVG_SZ	10
58 
59 struct loadavg_s {
60 	int lg_cur;		/* current loadavg entry */
61 	unsigned int lg_len;	/* number entries recorded */
62 	hrtime_t lg_total;	/* used to temporarily hold load totals */
63 	hrtime_t lg_loads[S_LOADAVG_SZ];	/* table of recorded entries */
64 };
65 
66 /*
67  * For fast event tracing.
68  */
69 struct ftrace_record;
70 typedef struct ftrace_data {
71 	int			ftd_state;	/* ftrace flags */
72 	kmutex_t		ftd_unused;	/* ftrace buffer lock, unused */
73 	struct ftrace_record	*ftd_cur;	/* current record */
74 	struct ftrace_record	*ftd_first;	/* first record */
75 	struct ftrace_record	*ftd_last;	/* last record */
76 } ftrace_data_t;
77 
78 struct cyc_cpu;
79 struct nvlist;
80 
81 /*
82  * Per-CPU data.
83  *
84  * Be careful adding new members: if they are not the same in all modules (e.g.
85  * change size depending on a #define), CTF uniquification can fail to work
86  * properly.  Furthermore, this is transitive in that it applies recursively to
87  * all types pointed to by cpu_t.
88  */
89 typedef struct cpu {
90 	processorid_t	cpu_id;			/* CPU number */
91 	processorid_t	cpu_seqid;	/* sequential CPU id (0..ncpus-1) */
92 	volatile cpu_flag_t cpu_flags;		/* flags indicating CPU state */
93 	struct cpu	*cpu_self;		/* pointer to itself */
94 	kthread_t	*cpu_thread;		/* current thread */
95 	kthread_t	*cpu_idle_thread;	/* idle thread for this CPU */
96 	kthread_t	*cpu_pause_thread;	/* pause thread for this CPU */
97 	klwp_id_t	cpu_lwp;		/* current lwp (if any) */
98 	klwp_id_t	cpu_fpowner;		/* currently loaded fpu owner */
99 	struct cpupart	*cpu_part;		/* partition with this CPU */
100 	struct lgrp_ld	*cpu_lpl;		/* pointer to this cpu's load */
101 	int		cpu_cache_offset;	/* see kmem.c for details */
102 
103 	/*
104 	 * Links to other CPUs.  It is safe to walk these lists if
105 	 * one of the following is true:
106 	 * 	- cpu_lock held
107 	 * 	- preemption disabled via kpreempt_disable
108 	 * 	- PIL >= DISP_LEVEL
109 	 * 	- acting thread is an interrupt thread
110 	 * 	- all other CPUs are paused
111 	 */
112 	struct cpu	*cpu_next;		/* next existing CPU */
113 	struct cpu	*cpu_prev;		/* prev existing CPU */
114 	struct cpu	*cpu_next_onln;		/* next online (enabled) CPU */
115 	struct cpu	*cpu_prev_onln;		/* prev online (enabled) CPU */
116 	struct cpu	*cpu_next_part;		/* next CPU in partition */
117 	struct cpu	*cpu_prev_part;		/* prev CPU in partition */
118 	struct cpu	*cpu_next_lgrp;		/* next CPU in latency group */
119 	struct cpu	*cpu_prev_lgrp;		/* prev CPU in latency group */
120 	struct cpu	*cpu_next_lpl;		/* next CPU in lgrp partition */
121 	struct cpu	*cpu_prev_lpl;
122 
123 	struct cpu_pg	*cpu_pg;		/* cpu's processor groups */
124 
125 	void		*cpu_reserved[4];	/* reserved for future use */
126 
127 	/*
128 	 * Scheduling variables.
129 	 */
130 	disp_t		*cpu_disp;		/* dispatch queue data */
131 	/*
132 	 * Note that cpu_disp is set before the CPU is added to the system
133 	 * and is never modified.  Hence, no additional locking is needed
134 	 * beyond what's necessary to access the cpu_t structure.
135 	 */
136 	char		cpu_runrun;	/* scheduling flag - set to preempt */
137 	char		cpu_kprunrun;		/* force kernel preemption */
138 	pri_t		cpu_chosen_level; 	/* priority at which cpu */
139 						/* was chosen for scheduling */
140 	kthread_t	*cpu_dispthread; /* thread selected for dispatch */
141 	disp_lock_t	cpu_thread_lock; /* dispatcher lock on current thread */
142 	uint8_t		cpu_disp_flags;	/* flags used by dispatcher */
143 	/*
144 	 * The following field is updated when ever the cpu_dispthread
145 	 * changes. Also in places, where the current thread(cpu_dispthread)
146 	 * priority changes. This is used in disp_lowpri_cpu()
147 	 */
148 	pri_t		cpu_dispatch_pri; /* priority of cpu_dispthread */
149 	clock_t		cpu_last_swtch;	/* last time switched to new thread */
150 
151 	/*
152 	 * Interrupt data.
153 	 */
154 	caddr_t		cpu_intr_stack;	/* interrupt stack */
155 	kthread_t	*cpu_intr_thread; /* interrupt thread list */
156 	uint_t		cpu_intr_actv;	/* interrupt levels active (bitmask) */
157 	int		cpu_base_spl;	/* priority for highest rupt active */
158 
159 	/*
160 	 * Statistics.
161 	 */
162 	cpu_stats_t	cpu_stats;		/* per-CPU statistics */
163 	struct kstat	*cpu_info_kstat;	/* kstat for cpu info */
164 
165 	uintptr_t	cpu_profile_pc;	/* kernel PC in profile interrupt */
166 	uintptr_t	cpu_profile_upc; /* user PC in profile interrupt */
167 	uintptr_t	cpu_profile_pil; /* PIL when profile interrupted */
168 
169 	ftrace_data_t	cpu_ftrace;		/* per cpu ftrace data */
170 
171 	clock_t		cpu_deadman_lbolt;	/* used by deadman() */
172 	uint_t		cpu_deadman_countdown;	/* used by deadman() */
173 
174 	kmutex_t	cpu_cpc_ctxlock; /* protects context for idle thread */
175 	kcpc_ctx_t	*cpu_cpc_ctx;	/* performance counter context */
176 
177 	/*
178 	 * Configuration information for the processor_info system call.
179 	 */
180 	processor_info_t cpu_type_info;	/* config info */
181 	time_t		cpu_state_begin; /* when CPU entered current state */
182 	char		cpu_cpr_flags;	/* CPR related info */
183 	struct cyc_cpu	*cpu_cyclic;	/* per cpu cyclic subsystem data */
184 	struct squeue_set_s *cpu_squeue_set;	/* per cpu squeue set */
185 	struct nvlist	*cpu_props;	/* pool-related properties */
186 
187 	krwlock_t	cpu_ft_lock;		/* DTrace: fasttrap lock */
188 	uintptr_t	cpu_dtrace_caller;	/* DTrace: caller, if any */
189 	hrtime_t	cpu_dtrace_chillmark;	/* DTrace: chill mark time */
190 	hrtime_t	cpu_dtrace_chilled;	/* DTrace: total chill time */
191 	volatile uint16_t cpu_mstate;		/* cpu microstate */
192 	volatile uint16_t cpu_mstate_gen;	/* generation counter */
193 	volatile hrtime_t cpu_mstate_start;	/* cpu microstate start time */
194 	volatile hrtime_t cpu_acct[NCMSTATES];	/* cpu microstate data */
195 	hrtime_t	cpu_intracct[NCMSTATES]; /* interrupt mstate data */
196 	hrtime_t	cpu_waitrq;		/* cpu run-queue wait time */
197 	struct loadavg_s cpu_loadavg;		/* loadavg info for this cpu */
198 
199 	char		*cpu_idstr;	/* for printing and debugging */
200 	char		*cpu_brandstr;	/* for printing */
201 
202 	/*
203 	 * Sum of all device interrupt weights that are currently directed at
204 	 * this cpu. Cleared at start of interrupt redistribution.
205 	 */
206 	int32_t		cpu_intr_weight;
207 	void		*cpu_vm_data;
208 
209 	struct cpu_physid *cpu_physid;	/* physical associations */
210 
211 	uint64_t	cpu_curr_clock;		/* current clock freq in Hz */
212 	char		*cpu_supp_freqs;	/* supported freqs in Hz */
213 
214 	uintptr_t	cpu_cpcprofile_pc;	/* kernel PC in cpc interrupt */
215 	uintptr_t	cpu_cpcprofile_upc;	/* user PC in cpc interrupt */
216 
217 	/*
218 	 * Interrupt load factor used by dispatcher & softcall
219 	 */
220 	hrtime_t	cpu_intrlast;   /* total interrupt time (nsec) */
221 	int		cpu_intrload;   /* interrupt load factor (0-99%) */
222 
223 	uint_t		cpu_rotor;	/* for cheap pseudo-random numbers */
224 
225 	/*
226 	 * New members must be added /before/ this member, as the CTF tools
227 	 * rely on this being the last field before cpu_m, so they can
228 	 * correctly calculate the offset when synthetically adding the cpu_m
229 	 * member in objects that do not have it.  This fixup is required for
230 	 * uniquification to work correctly.
231 	 */
232 	uintptr_t	cpu_m_pad;
233 
234 #if (defined(_KERNEL) || defined(_KMEMUSER)) && defined(_MACHDEP)
235 	struct machcpu	cpu_m;		/* per architecture info */
236 #endif
237 } cpu_t;
238 
239 /*
240  * The cpu_core structure consists of per-CPU state available in any context.
241  * On some architectures, this may mean that the page(s) containing the
242  * NCPU-sized array of cpu_core structures must be locked in the TLB -- it
243  * is up to the platform to assure that this is performed properly.  Note that
244  * the structure is sized to avoid false sharing.
245  */
246 #define	CPUC_SIZE		(sizeof (uint16_t) + sizeof (uint8_t) + \
247 				sizeof (uintptr_t) + sizeof (kmutex_t))
248 #define	CPUC_PADSIZE		CPU_CACHE_COHERENCE_SIZE - CPUC_SIZE
249 
250 typedef struct cpu_core {
251 	uint16_t	cpuc_dtrace_flags;	/* DTrace flags */
252 	uint8_t		cpuc_dcpc_intr_state;	/* DCPC provider intr state */
253 	uint8_t		cpuc_pad[CPUC_PADSIZE];	/* padding */
254 	uintptr_t	cpuc_dtrace_illval;	/* DTrace illegal value */
255 	kmutex_t	cpuc_pid_lock;		/* DTrace pid provider lock */
256 } cpu_core_t;
257 
258 #ifdef _KERNEL
259 extern cpu_core_t cpu_core[];
260 #endif /* _KERNEL */
261 
262 /*
263  * CPU_ON_INTR() macro. Returns non-zero if currently on interrupt stack.
264  * Note that this isn't a test for a high PIL.  For example, cpu_intr_actv
265  * does not get updated when we go through sys_trap from TL>0 at high PIL.
266  * getpil() should be used instead to check for PIL levels.
267  */
268 #define	CPU_ON_INTR(cpup) ((cpup)->cpu_intr_actv >> (LOCK_LEVEL + 1))
269 
270 /*
271  * CPU_PSEUDO_RANDOM() returns a per CPU value that changes each time one
272  * looks at it. It's meant as a cheap mechanism to be incorporated in routines
273  * wanting to avoid biasing, but where true randomness isn't needed (just
274  * something that changes).
275  */
276 #define	CPU_PSEUDO_RANDOM() (CPU->cpu_rotor++)
277 
278 #if defined(_KERNEL) || defined(_KMEMUSER)
279 
280 #define	INTR_STACK_SIZE	MAX(DEFAULTSTKSZ, PAGESIZE)
281 
282 /* MEMBERS PROTECTED BY "atomicity": cpu_flags */
283 
284 /*
285  * Flags in the CPU structure.
286  *
287  * These are protected by cpu_lock (except during creation).
288  *
289  * Offlined-CPUs have three stages of being offline:
290  *
291  * CPU_ENABLE indicates that the CPU is participating in I/O interrupts
292  * that can be directed at a number of different CPUs.  If CPU_ENABLE
293  * is off, the CPU will not be given interrupts that can be sent elsewhere,
294  * but will still get interrupts from devices associated with that CPU only,
295  * and from other CPUs.
296  *
297  * CPU_OFFLINE indicates that the dispatcher should not allow any threads
298  * other than interrupt threads to run on that CPU.  A CPU will not have
299  * CPU_OFFLINE set if there are any bound threads (besides interrupts).
300  *
301  * CPU_QUIESCED is set if p_offline was able to completely turn idle the
302  * CPU and it will not have to run interrupt threads.  In this case it'll
303  * stay in the idle loop until CPU_QUIESCED is turned off.
304  *
305  * CPU_FROZEN is used only by CPR to mark CPUs that have been successfully
306  * suspended (in the suspend path), or have yet to be resumed (in the resume
307  * case).
308  *
309  * On some platforms CPUs can be individually powered off.
310  * The following flags are set for powered off CPUs: CPU_QUIESCED,
311  * CPU_OFFLINE, and CPU_POWEROFF.  The following flags are cleared:
312  * CPU_RUNNING, CPU_READY, CPU_EXISTS, and CPU_ENABLE.
313  */
314 #define	CPU_RUNNING	0x001		/* CPU running */
315 #define	CPU_READY	0x002		/* CPU ready for cross-calls */
316 #define	CPU_QUIESCED	0x004		/* CPU will stay in idle */
317 #define	CPU_EXISTS	0x008		/* CPU is configured */
318 #define	CPU_ENABLE	0x010		/* CPU enabled for interrupts */
319 #define	CPU_OFFLINE	0x020		/* CPU offline via p_online */
320 #define	CPU_POWEROFF	0x040		/* CPU is powered off */
321 #define	CPU_FROZEN	0x080		/* CPU is frozen via CPR suspend */
322 #define	CPU_SPARE	0x100		/* CPU offline available for use */
323 #define	CPU_FAULTED	0x200		/* CPU offline diagnosed faulty */
324 
325 #define	FMT_CPU_FLAGS							\
326 	"\20\12fault\11spare\10frozen"					\
327 	"\7poweroff\6offline\5enable\4exist\3quiesced\2ready\1run"
328 
329 #define	CPU_ACTIVE(cpu)	(((cpu)->cpu_flags & CPU_OFFLINE) == 0)
330 
331 /*
332  * Flags for cpu_offline(), cpu_faulted(), and cpu_spare().
333  */
334 #define	CPU_FORCED	0x0001		/* Force CPU offline */
335 
336 /*
337  * DTrace flags.
338  */
339 #define	CPU_DTRACE_NOFAULT	0x0001	/* Don't fault */
340 #define	CPU_DTRACE_DROP		0x0002	/* Drop this ECB */
341 #define	CPU_DTRACE_BADADDR	0x0004	/* DTrace fault: bad address */
342 #define	CPU_DTRACE_BADALIGN	0x0008	/* DTrace fault: bad alignment */
343 #define	CPU_DTRACE_DIVZERO	0x0010	/* DTrace fault: divide by zero */
344 #define	CPU_DTRACE_ILLOP	0x0020	/* DTrace fault: illegal operation */
345 #define	CPU_DTRACE_NOSCRATCH	0x0040	/* DTrace fault: out of scratch */
346 #define	CPU_DTRACE_KPRIV	0x0080	/* DTrace fault: bad kernel access */
347 #define	CPU_DTRACE_UPRIV	0x0100	/* DTrace fault: bad user access */
348 #define	CPU_DTRACE_TUPOFLOW	0x0200	/* DTrace fault: tuple stack overflow */
349 #if defined(__sparc)
350 #define	CPU_DTRACE_FAKERESTORE	0x0400	/* pid provider hint to getreg */
351 #endif
352 #define	CPU_DTRACE_ENTRY	0x0800	/* pid provider hint to ustack() */
353 #define	CPU_DTRACE_BADSTACK	0x1000	/* DTrace fault: bad stack */
354 
355 #define	CPU_DTRACE_FAULT	(CPU_DTRACE_BADADDR | CPU_DTRACE_BADALIGN | \
356 				CPU_DTRACE_DIVZERO | CPU_DTRACE_ILLOP | \
357 				CPU_DTRACE_NOSCRATCH | CPU_DTRACE_KPRIV | \
358 				CPU_DTRACE_UPRIV | CPU_DTRACE_TUPOFLOW | \
359 				CPU_DTRACE_BADSTACK)
360 #define	CPU_DTRACE_ERROR	(CPU_DTRACE_FAULT | CPU_DTRACE_DROP)
361 
362 /*
363  * Dispatcher flags
364  * These flags must be changed only by the current CPU.
365  */
366 #define	CPU_DISP_DONTSTEAL	0x01	/* CPU undergoing context swtch */
367 #define	CPU_DISP_HALTED		0x02	/* CPU halted waiting for interrupt */
368 
369 
370 #endif /* _KERNEL || _KMEMUSER */
371 
372 #if (defined(_KERNEL) || defined(_KMEMUSER)) && defined(_MACHDEP)
373 
374 /*
375  * Macros for manipulating sets of CPUs as a bitmap.  Note that this
376  * bitmap may vary in size depending on the maximum CPU id a specific
377  * platform supports.  This may be different than the number of CPUs
378  * the platform supports, since CPU ids can be sparse.  We define two
379  * sets of macros; one for platforms where the maximum CPU id is less
380  * than the number of bits in a single word (32 in a 32-bit kernel,
381  * 64 in a 64-bit kernel), and one for platforms that require bitmaps
382  * of more than one word.
383  */
384 
385 #define	CPUSET_WORDS	BT_BITOUL(NCPU)
386 #define	CPUSET_NOTINSET	((uint_t)-1)
387 
388 #if	CPUSET_WORDS > 1
389 
390 typedef struct cpuset {
391 	ulong_t	cpub[CPUSET_WORDS];
392 } cpuset_t;
393 
394 /*
395  * Private functions for manipulating cpusets that do not fit in a
396  * single word.  These should not be used directly; instead the
397  * CPUSET_* macros should be used so the code will be portable
398  * across different definitions of NCPU.
399  */
400 extern	void	cpuset_all(cpuset_t *);
401 extern	void	cpuset_all_but(cpuset_t *, uint_t);
402 extern	int	cpuset_isnull(cpuset_t *);
403 extern	int	cpuset_cmp(cpuset_t *, cpuset_t *);
404 extern	void	cpuset_only(cpuset_t *, uint_t);
405 extern	uint_t	cpuset_find(cpuset_t *);
406 extern	void	cpuset_bounds(cpuset_t *, uint_t *, uint_t *);
407 
408 #define	CPUSET_ALL(set)			cpuset_all(&(set))
409 #define	CPUSET_ALL_BUT(set, cpu)	cpuset_all_but(&(set), cpu)
410 #define	CPUSET_ONLY(set, cpu)		cpuset_only(&(set), cpu)
411 #define	CPU_IN_SET(set, cpu)		BT_TEST((set).cpub, cpu)
412 #define	CPUSET_ADD(set, cpu)		BT_SET((set).cpub, cpu)
413 #define	CPUSET_DEL(set, cpu)		BT_CLEAR((set).cpub, cpu)
414 #define	CPUSET_ISNULL(set)		cpuset_isnull(&(set))
415 #define	CPUSET_ISEQUAL(set1, set2)	cpuset_cmp(&(set1), &(set2))
416 
417 /*
418  * Find one CPU in the cpuset.
419  * Sets "cpu" to the id of the found CPU, or CPUSET_NOTINSET if no cpu
420  * could be found. (i.e. empty set)
421  */
422 #define	CPUSET_FIND(set, cpu)		{		\
423 	cpu = cpuset_find(&(set));			\
424 }
425 
426 /*
427  * Determine the smallest and largest CPU id in the set. Returns
428  * CPUSET_NOTINSET in smallest and largest when set is empty.
429  */
430 #define	CPUSET_BOUNDS(set, smallest, largest)	{		\
431 	cpuset_bounds(&(set), &(smallest), &(largest));		\
432 }
433 
434 /*
435  * Atomic cpuset operations
436  * These are safe to use for concurrent cpuset manipulations.
437  * "xdel" and "xadd" are exclusive operations, that set "result" to "0"
438  * if the add or del was successful, or "-1" if not successful.
439  * (e.g. attempting to add a cpu to a cpuset that's already there, or
440  * deleting a cpu that's not in the cpuset)
441  */
442 
443 #define	CPUSET_ATOMIC_DEL(set, cpu)	BT_ATOMIC_CLEAR((set).cpub, (cpu))
444 #define	CPUSET_ATOMIC_ADD(set, cpu)	BT_ATOMIC_SET((set).cpub, (cpu))
445 
446 #define	CPUSET_ATOMIC_XADD(set, cpu, result) \
447 	BT_ATOMIC_SET_EXCL((set).cpub, cpu, result)
448 
449 #define	CPUSET_ATOMIC_XDEL(set, cpu, result) \
450 	BT_ATOMIC_CLEAR_EXCL((set).cpub, cpu, result)
451 
452 
453 #define	CPUSET_OR(set1, set2)		{		\
454 	int _i;						\
455 	for (_i = 0; _i < CPUSET_WORDS; _i++)		\
456 		(set1).cpub[_i] |= (set2).cpub[_i];	\
457 }
458 
459 #define	CPUSET_XOR(set1, set2)		{		\
460 	int _i;						\
461 	for (_i = 0; _i < CPUSET_WORDS; _i++)		\
462 		(set1).cpub[_i] ^= (set2).cpub[_i];	\
463 }
464 
465 #define	CPUSET_AND(set1, set2)		{		\
466 	int _i;						\
467 	for (_i = 0; _i < CPUSET_WORDS; _i++)		\
468 		(set1).cpub[_i] &= (set2).cpub[_i];	\
469 }
470 
471 #define	CPUSET_ZERO(set)		{		\
472 	int _i;						\
473 	for (_i = 0; _i < CPUSET_WORDS; _i++)		\
474 		(set).cpub[_i] = 0;			\
475 }
476 
477 #elif	CPUSET_WORDS == 1
478 
479 typedef	ulong_t	cpuset_t;	/* a set of CPUs */
480 
481 #define	CPUSET(cpu)			(1UL << (cpu))
482 
483 #define	CPUSET_ALL(set)			((void)((set) = ~0UL))
484 #define	CPUSET_ALL_BUT(set, cpu)	((void)((set) = ~CPUSET(cpu)))
485 #define	CPUSET_ONLY(set, cpu)		((void)((set) = CPUSET(cpu)))
486 #define	CPU_IN_SET(set, cpu)		((set) & CPUSET(cpu))
487 #define	CPUSET_ADD(set, cpu)		((void)((set) |= CPUSET(cpu)))
488 #define	CPUSET_DEL(set, cpu)		((void)((set) &= ~CPUSET(cpu)))
489 #define	CPUSET_ISNULL(set)		((set) == 0)
490 #define	CPUSET_ISEQUAL(set1, set2)	((set1) == (set2))
491 #define	CPUSET_OR(set1, set2)		((void)((set1) |= (set2)))
492 #define	CPUSET_XOR(set1, set2)		((void)((set1) ^= (set2)))
493 #define	CPUSET_AND(set1, set2)		((void)((set1) &= (set2)))
494 #define	CPUSET_ZERO(set)		((void)((set) = 0))
495 
496 #define	CPUSET_FIND(set, cpu)		{		\
497 	cpu = (uint_t)(lowbit(set) - 1);				\
498 }
499 
500 #define	CPUSET_BOUNDS(set, smallest, largest)	{	\
501 	smallest = (uint_t)(lowbit(set) - 1);		\
502 	largest = (uint_t)(highbit(set) - 1);		\
503 }
504 
505 #define	CPUSET_ATOMIC_DEL(set, cpu)	atomic_and_long(&(set), ~CPUSET(cpu))
506 #define	CPUSET_ATOMIC_ADD(set, cpu)	atomic_or_long(&(set), CPUSET(cpu))
507 
508 #define	CPUSET_ATOMIC_XADD(set, cpu, result) \
509 	{ result = atomic_set_long_excl(&(set), (cpu)); }
510 
511 #define	CPUSET_ATOMIC_XDEL(set, cpu, result) \
512 	{ result = atomic_clear_long_excl(&(set), (cpu)); }
513 
514 #else	/* CPUSET_WORDS <= 0 */
515 
516 #error NCPU is undefined or invalid
517 
518 #endif	/* CPUSET_WORDS	*/
519 
520 extern cpuset_t cpu_seqid_inuse;
521 
522 #endif	/* (_KERNEL || _KMEMUSER) && _MACHDEP */
523 
524 #define	CPU_CPR_OFFLINE		0x0
525 #define	CPU_CPR_ONLINE		0x1
526 #define	CPU_CPR_IS_OFFLINE(cpu)	(((cpu)->cpu_cpr_flags & CPU_CPR_ONLINE) == 0)
527 #define	CPU_CPR_IS_ONLINE(cpu)	((cpu)->cpu_cpr_flags & CPU_CPR_ONLINE)
528 #define	CPU_SET_CPR_FLAGS(cpu, flag)	((cpu)->cpu_cpr_flags |= flag)
529 
530 #if defined(_KERNEL) || defined(_KMEMUSER)
531 
532 extern struct cpu	*cpu[];		/* indexed by CPU number */
533 extern struct cpu	**cpu_seq;	/* indexed by sequential CPU id */
534 extern cpu_t		*cpu_list;	/* list of CPUs */
535 extern cpu_t		*cpu_active;	/* list of active CPUs */
536 extern int		ncpus;		/* number of CPUs present */
537 extern int		ncpus_online;	/* number of CPUs not quiesced */
538 extern int		max_ncpus;	/* max present before ncpus is known */
539 extern int		boot_max_ncpus;	/* like max_ncpus but for real */
540 extern int		boot_ncpus;	/* # cpus present @ boot */
541 extern processorid_t	max_cpuid;	/* maximum CPU number */
542 extern struct cpu	*cpu_inmotion;	/* offline or partition move target */
543 extern cpu_t		*clock_cpu_list;
544 
545 #if defined(__i386) || defined(__amd64)
546 extern struct cpu *curcpup(void);
547 #define	CPU		(curcpup())	/* Pointer to current CPU */
548 #else
549 #define	CPU		(curthread->t_cpu)	/* Pointer to current CPU */
550 #endif
551 
552 /*
553  * CPU_CURRENT indicates to thread_affinity_set to use CPU->cpu_id
554  * as the target and to grab cpu_lock instead of requiring the caller
555  * to grab it.
556  */
557 #define	CPU_CURRENT	-3
558 
559 /*
560  * Per-CPU statistics
561  *
562  * cpu_stats_t contains numerous system and VM-related statistics, in the form
563  * of gauges or monotonically-increasing event occurrence counts.
564  */
565 
566 #define	CPU_STATS_ENTER_K()	kpreempt_disable()
567 #define	CPU_STATS_EXIT_K()	kpreempt_enable()
568 
569 #define	CPU_STATS_ADD_K(class, stat, amount) \
570 	{	kpreempt_disable(); /* keep from switching CPUs */\
571 		CPU_STATS_ADDQ(CPU, class, stat, amount); \
572 		kpreempt_enable(); \
573 	}
574 
575 #define	CPU_STATS_ADDQ(cp, class, stat, amount)	{			\
576 	extern void __dtrace_probe___cpu_##class##info_##stat(uint_t,	\
577 	    uint64_t *, cpu_t *);					\
578 	uint64_t *stataddr = &((cp)->cpu_stats.class.stat);		\
579 	__dtrace_probe___cpu_##class##info_##stat((amount),		\
580 	    stataddr, cp);						\
581 	*(stataddr) += (amount);					\
582 }
583 
584 #define	CPU_STATS(cp, stat)                                       \
585 	((cp)->cpu_stats.stat)
586 
587 #endif /* _KERNEL || _KMEMUSER */
588 
589 /*
590  * CPU support routines.
591  */
592 #if	defined(_KERNEL) && defined(__STDC__)	/* not for genassym.c */
593 
594 struct zone;
595 
596 void	cpu_list_init(cpu_t *);
597 void	cpu_add_unit(cpu_t *);
598 void	cpu_del_unit(int cpuid);
599 void	cpu_add_active(cpu_t *);
600 void	cpu_kstat_init(cpu_t *);
601 void	cpu_visibility_add(cpu_t *, struct zone *);
602 void	cpu_visibility_remove(cpu_t *, struct zone *);
603 void	cpu_visibility_configure(cpu_t *, struct zone *);
604 void	cpu_visibility_unconfigure(cpu_t *, struct zone *);
605 void	cpu_visibility_online(cpu_t *, struct zone *);
606 void	cpu_visibility_offline(cpu_t *, struct zone *);
607 void	cpu_create_intrstat(cpu_t *);
608 void	cpu_delete_intrstat(cpu_t *);
609 int	cpu_kstat_intrstat_update(kstat_t *, int);
610 void	cpu_intr_swtch_enter(kthread_t *);
611 void	cpu_intr_swtch_exit(kthread_t *);
612 
613 void	mbox_lock_init(void);	 /* initialize cross-call locks */
614 void	mbox_init(int cpun);	 /* initialize cross-calls */
615 void	poke_cpu(int cpun);	 /* interrupt another CPU (to preempt) */
616 
617 /*
618  * values for safe_list.  Pause state that CPUs are in.
619  */
620 #define	PAUSE_IDLE	0		/* normal state */
621 #define	PAUSE_READY	1		/* paused thread ready to spl */
622 #define	PAUSE_WAIT	2		/* paused thread is spl-ed high */
623 #define	PAUSE_DIE	3		/* tell pause thread to leave */
624 #define	PAUSE_DEAD	4		/* pause thread has left */
625 
626 void	mach_cpu_pause(volatile char *);
627 
628 void	pause_cpus(cpu_t *off_cp);
629 void	start_cpus(void);
630 int	cpus_paused(void);
631 
632 void	cpu_pause_init(void);
633 cpu_t	*cpu_get(processorid_t cpun);	/* get the CPU struct associated */
634 
635 int	cpu_online(cpu_t *cp);			/* take cpu online */
636 int	cpu_offline(cpu_t *cp, int flags);	/* take cpu offline */
637 int	cpu_spare(cpu_t *cp, int flags);	/* take cpu to spare */
638 int	cpu_faulted(cpu_t *cp, int flags);	/* take cpu to faulted */
639 int	cpu_poweron(cpu_t *cp);		/* take powered-off cpu to offline */
640 int	cpu_poweroff(cpu_t *cp);	/* take offline cpu to powered-off */
641 
642 cpu_t	*cpu_intr_next(cpu_t *cp);	/* get next online CPU taking intrs */
643 int	cpu_intr_count(cpu_t *cp);	/* count # of CPUs handling intrs */
644 int	cpu_intr_on(cpu_t *cp);		/* CPU taking I/O interrupts? */
645 void	cpu_intr_enable(cpu_t *cp);	/* enable I/O interrupts */
646 int	cpu_intr_disable(cpu_t *cp);	/* disable I/O interrupts */
647 void	cpu_intr_alloc(cpu_t *cp, int n); /* allocate interrupt threads */
648 
649 /*
650  * Routines for checking CPU states.
651  */
652 int	cpu_is_online(cpu_t *);		/* check if CPU is online */
653 int	cpu_is_nointr(cpu_t *);		/* check if CPU can service intrs */
654 int	cpu_is_active(cpu_t *);		/* check if CPU can run threads */
655 int	cpu_is_offline(cpu_t *);	/* check if CPU is offline */
656 int	cpu_is_poweredoff(cpu_t *);	/* check if CPU is powered off */
657 
658 int	cpu_flagged_online(cpu_flag_t);	/* flags show CPU is online */
659 int	cpu_flagged_nointr(cpu_flag_t);	/* flags show CPU not handling intrs */
660 int	cpu_flagged_active(cpu_flag_t); /* flags show CPU scheduling threads */
661 int	cpu_flagged_offline(cpu_flag_t); /* flags show CPU is offline */
662 int	cpu_flagged_poweredoff(cpu_flag_t); /* flags show CPU is powered off */
663 
664 /*
665  * The processor_info(2) state of a CPU is a simplified representation suitable
666  * for use by an application program.  Kernel subsystems should utilize the
667  * internal per-CPU state as given by the cpu_flags member of the cpu structure,
668  * as this information may include platform- or architecture-specific state
669  * critical to a subsystem's disposition of a particular CPU.
670  */
671 void	cpu_set_state(cpu_t *);		/* record/timestamp current state */
672 int	cpu_get_state(cpu_t *);		/* get current cpu state */
673 const char *cpu_get_state_str(cpu_t *);	/* get current cpu state as string */
674 
675 
676 void	cpu_set_supp_freqs(cpu_t *, const char *); /* set the CPU supported */
677 						/* frequencies */
678 
679 int	cpu_configure(int);
680 int	cpu_unconfigure(int);
681 void	cpu_destroy_bound_threads(cpu_t *cp);
682 
683 extern int cpu_bind_thread(kthread_t *tp, processorid_t bind,
684     processorid_t *obind, int *error);
685 extern int cpu_unbind(processorid_t cpu_id, boolean_t force);
686 extern void thread_affinity_set(kthread_t *t, int cpu_id);
687 extern void thread_affinity_clear(kthread_t *t);
688 extern void affinity_set(int cpu_id);
689 extern void affinity_clear(void);
690 extern void init_cpu_mstate(struct cpu *, int);
691 extern void term_cpu_mstate(struct cpu *);
692 extern void new_cpu_mstate(int, hrtime_t);
693 extern void get_cpu_mstate(struct cpu *, hrtime_t *);
694 extern void thread_nomigrate(void);
695 extern void thread_allowmigrate(void);
696 extern void weakbinding_stop(void);
697 extern void weakbinding_start(void);
698 
699 /*
700  * The following routines affect the CPUs participation in interrupt processing,
701  * if that is applicable on the architecture.  This only affects interrupts
702  * which aren't directed at the processor (not cross calls).
703  *
704  * cpu_disable_intr returns non-zero if interrupts were previously enabled.
705  */
706 int	cpu_disable_intr(struct cpu *cp); /* stop issuing interrupts to cpu */
707 void	cpu_enable_intr(struct cpu *cp); /* start issuing interrupts to cpu */
708 
709 /*
710  * The mutex cpu_lock protects cpu_flags for all CPUs, as well as the ncpus
711  * and ncpus_online counts.
712  */
713 extern kmutex_t	cpu_lock;	/* lock protecting CPU data */
714 
715 typedef enum {
716 	CPU_INIT,
717 	CPU_CONFIG,
718 	CPU_UNCONFIG,
719 	CPU_ON,
720 	CPU_OFF,
721 	CPU_CPUPART_IN,
722 	CPU_CPUPART_OUT,
723 	CPU_SETUP
724 } cpu_setup_t;
725 
726 typedef int cpu_setup_func_t(cpu_setup_t, int, void *);
727 
728 /*
729  * Routines used to register interest in cpu's being added to or removed
730  * from the system.
731  */
732 extern void register_cpu_setup_func(cpu_setup_func_t *, void *);
733 extern void unregister_cpu_setup_func(cpu_setup_func_t *, void *);
734 extern void cpu_state_change_notify(int, cpu_setup_t);
735 
736 /*
737  * Create various strings that describe the given CPU for the
738  * processor_info system call and configuration-related kstats.
739  */
740 #define	CPU_IDSTRLEN	100
741 
742 extern void init_cpu_info(struct cpu *);
743 extern void populate_idstr(struct cpu *);
744 extern void cpu_vm_data_init(struct cpu *);
745 extern void cpu_vm_data_destroy(struct cpu *);
746 
747 #endif	/* _KERNEL */
748 
749 #ifdef	__cplusplus
750 }
751 #endif
752 
753 #endif /* _SYS_CPUVAR_H */
754