xref: /illumos-gate/usr/src/uts/common/sys/pghw.h (revision 581cede61ac9c14d8d4ea452562a567189eead78)
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  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 #ifndef	_PGHW_H
27 #define	_PGHW_H
28 
29 #ifdef	__cplusplus
30 extern "C" {
31 #endif
32 
33 #if (defined(_KERNEL) || defined(_KMEMUSER))
34 #include <sys/cpuvar.h>
35 #include <sys/group.h>
36 #include <sys/processor.h>
37 #include <sys/bitmap.h>
38 #include <sys/atomic.h>
39 #include <sys/types.h>
40 #include <sys/kstat.h>
41 #include <sys/pg.h>
42 
43 /*
44  * Hardware that may be shared by a group of processors
45  */
46 typedef enum pghw_type {
47 	PGHW_START,
48 	PGHW_IPIPE,	/* Instruction Pipeline */
49 	PGHW_CACHE,	/* Cache (generally last level) */
50 	PGHW_FPU,	/* Floating Point Unit / Pipeline */
51 	PGHW_MPIPE,	/* Pipe to Memory */
52 	PGHW_CHIP,	/* Socket */
53 	PGHW_MEMORY,
54 	PGHW_POW_ACTIVE,	/* Active Power Management Domain */
55 	PGHW_POW_IDLE,		/* Idle Power Management Domain */
56 	PGHW_NUM_COMPONENTS
57 } pghw_type_t;
58 
59 /*
60  * Returns true if the hardware is a type of power management domain
61  */
62 #define	PGHW_IS_PM_DOMAIN(hw)	\
63 	(hw == PGHW_POW_ACTIVE || hw == PGHW_POW_IDLE)
64 
65 /*
66  * Anonymous instance id
67  */
68 #define	PGHW_INSTANCE_ANON ((id_t)0xdecafbad)
69 
70 /*
71  * Max length of PGHW kstat strings
72  */
73 #define	PGHW_KSTAT_STR_LEN_MAX	32
74 
75 
76 /*
77  * Platform specific handle
78  */
79 typedef uintptr_t pghw_handle_t;
80 
81 /*
82  * Processor Group (physical sharing relationship)
83  */
84 typedef struct pghw {
85 	pg_t		pghw_pg;	/* processor group */
86 	pghw_type_t	pghw_hw;	/* HW sharing relationship */
87 	id_t		pghw_instance;	/* sharing instance identifier */
88 	pghw_handle_t	pghw_handle;	/* hw specific opaque handle */
89 	kstat_t		*pghw_kstat;	/* physical kstats exported */
90 } pghw_t;
91 
92 /*
93  * IDs associating a CPU with various physical hardware
94  */
95 typedef struct cpu_physid {
96 	id_t		cpu_chipid;	/* CPU's physical processor */
97 	id_t		cpu_coreid;	/* CPU's physical core */
98 	id_t		cpu_cacheid;	/* CPU's cache id */
99 } cpu_physid_t;
100 
101 /*
102  * Physical PG initialization / CPU service hooks
103  */
104 void		pghw_init(pghw_t *, cpu_t *, pghw_type_t);
105 void		pghw_fini(pghw_t *);
106 void		pghw_cpu_add(pghw_t *, cpu_t *);
107 pghw_t		*pghw_place_cpu(cpu_t *, pghw_type_t);
108 
109 /*
110  * Physical ID cache creation / destruction
111  */
112 void		pghw_physid_create(cpu_t *);
113 void		pghw_physid_destroy(cpu_t *);
114 
115 /*
116  * CPU / PG hardware related seach operations
117  */
118 pghw_t		*pghw_find_pg(cpu_t *, pghw_type_t);
119 pghw_t		*pghw_find_by_instance(id_t, pghw_type_t);
120 group_t		*pghw_set_lookup(pghw_type_t);
121 
122 void		pghw_kstat_create(pghw_t *);
123 int		pghw_kstat_update(kstat_t *, int);
124 
125 /* Hardware sharing relationship platform interfaces */
126 int		pg_plat_hw_shared(cpu_t *, pghw_type_t);
127 int		pg_plat_cpus_share(cpu_t *, cpu_t *, pghw_type_t);
128 id_t		pg_plat_hw_instance_id(cpu_t *, pghw_type_t);
129 pghw_type_t	pg_plat_hw_rank(pghw_type_t, pghw_type_t);
130 
131 /*
132  * What comprises a "core" may vary across processor implementations,
133  * and so the term itself is somewhat unstable. For this reason, there
134  * is no PGHW_CORE type, but we provide an interface here to allow platforms
135  * to express cpu <=> core mappings.
136  */
137 id_t		pg_plat_get_core_id(cpu_t *);
138 
139 #endif	/* !_KERNEL && !_KMEMUSER */
140 
141 #ifdef	__cplusplus
142 }
143 #endif
144 
145 #endif /* _PGHW_H */
146