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 _PGHW_H 28 #define _PGHW_H 29 30 #ifdef __cplusplus 31 extern "C" { 32 #endif 33 34 #if (defined(_KERNEL) || defined(_KMEMUSER)) 35 #include <sys/cpuvar.h> 36 #include <sys/group.h> 37 #include <sys/processor.h> 38 #include <sys/bitmap.h> 39 #include <sys/atomic.h> 40 #include <sys/types.h> 41 #include <sys/kstat.h> 42 #include <sys/pg.h> 43 44 /* 45 * Hardware that may be shared by a group of processors 46 */ 47 typedef enum pghw_type { 48 PGHW_START, 49 PGHW_IPIPE, /* Instruction Pipeline */ 50 PGHW_CACHE, /* Cache (generally last level) */ 51 PGHW_FPU, /* Floating Point Unit / Pipeline */ 52 PGHW_MPIPE, /* Pipe to Memory */ 53 PGHW_CHIP, /* Socket */ 54 PGHW_MEMORY, 55 PGHW_POW_ACTIVE, /* Active Power Management Domain */ 56 PGHW_POW_IDLE, /* Idle Power Management Domain */ 57 PGHW_NUM_COMPONENTS 58 } pghw_type_t; 59 60 /* 61 * See comments in usr/src/uts/i86pc/os/cpuid.c 62 * for description of processor nodes 63 * 64 * From sharing point of view processor nodes are 65 * very similar to memory pipes, hence the #define below. 66 */ 67 #define PGHW_PROCNODE PGHW_MPIPE 68 69 /* 70 * Returns true if the hardware is a type of power management domain 71 */ 72 #define PGHW_IS_PM_DOMAIN(hw) \ 73 (hw == PGHW_POW_ACTIVE || hw == PGHW_POW_IDLE) 74 75 /* 76 * Anonymous instance id 77 */ 78 #define PGHW_INSTANCE_ANON ((id_t)0xdecafbad) 79 80 /* 81 * Max length of PGHW kstat strings 82 */ 83 #define PGHW_KSTAT_STR_LEN_MAX 32 84 85 86 /* 87 * Platform specific handle 88 */ 89 typedef uintptr_t pghw_handle_t; 90 91 /* 92 * Representation of PG hardware utilization NOTE: All the sums listed below are 93 * the sums of running total of each item for each CPU in the PG (eg. 94 * sum(utilization) is sum of running total utilization of each CPU in PG) 95 */ 96 typedef struct pghw_util { 97 uint64_t pghw_util; /* sum(utilization) */ 98 uint64_t pghw_rate; /* Last observed utilization rate */ 99 uint64_t pghw_rate_max; /* Max observed rate (in units/sec) */ 100 hrtime_t pghw_time_stamp; /* Timestamp of last snapshot */ 101 /* 102 * sum(time utilization counters on) 103 */ 104 hrtime_t pghw_time_running; 105 /* 106 * sum(time utilization counters off) 107 */ 108 hrtime_t pghw_time_stopped; 109 } pghw_util_t; 110 111 112 /* 113 * Processor Group (physical sharing relationship) 114 */ 115 typedef struct pghw { 116 pg_t pghw_pg; /* processor group */ 117 pghw_type_t pghw_hw; /* HW sharing relationship */ 118 id_t pghw_instance; /* sharing instance identifier */ 119 pghw_handle_t pghw_handle; /* hw specific opaque handle */ 120 kstat_t *pghw_kstat; /* physical kstats exported */ 121 kstat_t *pghw_cu_kstat; /* for capacity and utilization */ 122 /* 123 * pghw_generation should be updated by superclasses whenever PG changes 124 * significanly (e.g. new CPUs join or leave PG). 125 */ 126 uint_t pghw_generation; /* generation number */ 127 128 /* 129 * The following fields are used by PGHW cu kstats 130 */ 131 char *pghw_cpulist; /* list of CPUs */ 132 size_t pghw_cpulist_len; /* length of the list */ 133 /* 134 * Generation number at kstat update time 135 */ 136 uint_t pghw_kstat_gen; 137 pghw_util_t pghw_stats; /* Utilization data */ 138 } pghw_t; 139 140 /* 141 * IDs associating a CPU with various physical hardware 142 */ 143 typedef struct cpu_physid { 144 id_t cpu_chipid; /* CPU's physical processor */ 145 id_t cpu_coreid; /* CPU's physical core */ 146 id_t cpu_cacheid; /* CPU's cache id */ 147 } cpu_physid_t; 148 149 /* 150 * Physical PG initialization / CPU service hooks 151 */ 152 extern void pghw_init(pghw_t *, cpu_t *, pghw_type_t); 153 extern void pghw_fini(pghw_t *); 154 extern void pghw_cpu_add(pghw_t *, cpu_t *); 155 extern pghw_t *pghw_place_cpu(cpu_t *, pghw_type_t); 156 157 /* 158 * Physical ID cache creation / destruction 159 */ 160 extern void pghw_physid_create(cpu_t *); 161 extern void pghw_physid_destroy(cpu_t *); 162 163 /* 164 * CPU / PG hardware related seach operations 165 */ 166 extern pghw_t *pghw_find_pg(cpu_t *, pghw_type_t); 167 extern pghw_t *pghw_find_by_instance(id_t, pghw_type_t); 168 extern group_t *pghw_set_lookup(pghw_type_t); 169 170 /* Hardware sharing relationship platform interfaces */ 171 extern int pg_plat_hw_shared(cpu_t *, pghw_type_t); 172 extern int pg_plat_cpus_share(cpu_t *, cpu_t *, pghw_type_t); 173 extern id_t pg_plat_hw_instance_id(cpu_t *, pghw_type_t); 174 extern pghw_type_t pg_plat_hw_rank(pghw_type_t, pghw_type_t); 175 176 /* 177 * String representation of the hardware type 178 */ 179 extern char *pghw_type_string(pghw_type_t); 180 extern char *pghw_type_shortstring(pghw_type_t); 181 182 /* 183 * What comprises a "core" may vary across processor implementations, 184 * and so the term itself is somewhat unstable. For this reason, there 185 * is no PGHW_CORE type, but we provide an interface here to allow platforms 186 * to express cpu <=> core mappings. 187 */ 188 extern id_t pg_plat_get_core_id(cpu_t *); 189 190 #endif /* !_KERNEL && !_KMEMUSER */ 191 192 #ifdef __cplusplus 193 } 194 #endif 195 196 #endif /* _PGHW_H */ 197