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 (c) 1984, 1986, 1987, 1988, 1989 AT&T
23 * All Rights Reserved
24 *
25 */
26
27 /*
28 * Copyright 2008 Sun Microsystems, Inc. All rights reserved.
29 * Use is subject to license terms.
30 */
31
32 #ifndef _SYS_PROCESSOR_H
33 #define _SYS_PROCESSOR_H
34
35 #include <sys/types.h>
36 #include <sys/procset.h>
37
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41
42 /*
43 * Definitions for p_online, processor_info & lgrp system calls.
44 */
45
46 /*
47 * Type for an lgrpid
48 */
49 typedef uint16_t lgrpid_t;
50
51 /*
52 * Type for processor name (CPU number).
53 */
54 typedef int processorid_t;
55 typedef int chipid_t;
56
57 /*
58 * Flags and return values for p_online(2), and pi_state for processor_info(2).
59 * These flags are *not* for in-kernel examination of CPU states.
60 * See <sys/cpuvar.h> for appropriate informational functions.
61 */
62 #define P_OFFLINE 0x0001 /* processor is offline, as quiet as possible */
63 #define P_ONLINE 0x0002 /* processor is online */
64 #define P_STATUS 0x0003 /* value passed to p_online to request status */
65 #define P_FAULTED 0x0004 /* processor is offline, in faulted state */
66 #define P_POWEROFF 0x0005 /* processor is powered off */
67 #define P_NOINTR 0x0006 /* processor is online, but no I/O interrupts */
68 #define P_SPARE 0x0007 /* processor is offline, can be reactivated */
69 #define P_BAD P_FAULTED /* unused but defined by USL */
70 #define P_FORCED 0x10000000 /* force processor offline */
71
72 /*
73 * String names for processor states defined above.
74 */
75 #define PS_OFFLINE "off-line"
76 #define PS_ONLINE "on-line"
77 #define PS_FAULTED "faulted"
78 #define PS_POWEROFF "powered-off"
79 #define PS_NOINTR "no-intr"
80 #define PS_SPARE "spare"
81
82 /*
83 * Structure filled in by processor_info(2). This structure
84 * SHOULD NOT BE MODIFIED. Changes to the structure would
85 * negate ABI compatibility.
86 *
87 * The string fields are guaranteed to contain a NULL.
88 *
89 * The pi_fputypes field contains a (possibly empty) comma-separated
90 * list of floating point identifier strings.
91 */
92 #define PI_TYPELEN 16 /* max size of CPU type string */
93 #define PI_FPUTYPE 32 /* max size of FPU types string */
94
95 typedef struct {
96 int pi_state; /* processor state, see above */
97 char pi_processor_type[PI_TYPELEN]; /* ASCII CPU type */
98 char pi_fputypes[PI_FPUTYPE]; /* ASCII FPU types */
99 int pi_clock; /* CPU clock freq in MHz */
100 } processor_info_t;
101
102 /*
103 * Binding values for processor_bind(2)
104 */
105 #define PBIND_NONE -1 /* LWP/thread is not bound */
106 #define PBIND_QUERY -2 /* don't set, just return the binding */
107 #define PBIND_HARD -3 /* prevents offlining CPU (default) */
108 #define PBIND_SOFT -4 /* allows offlining CPU */
109 #define PBIND_QUERY_TYPE -5 /* Return binding type */
110
111 /*
112 * User-level system call interface prototypes
113 */
114 #ifndef _KERNEL
115 #ifdef __STDC__
116
117 extern int p_online(processorid_t processorid, int flag);
118 extern int processor_info(processorid_t processorid,
119 processor_info_t *infop);
120 extern int processor_bind(idtype_t idtype, id_t id,
121 processorid_t processorid, processorid_t *obind);
122 extern processorid_t getcpuid(void);
123 extern lgrpid_t gethomelgroup(void);
124
125 #else
126
127 extern int p_online();
128 extern int processor_info();
129 extern int processor_bind();
130 extern processorid_t getcpuid();
131 extern lgrpid_t gethomelgroup();
132
133 #endif /* __STDC__ */
134
135 #else /* _KERNEL */
136
137 /*
138 * Internal interface prototypes
139 */
140 extern int p_online_internal(processorid_t, int, int *);
141 extern int p_online_internal_locked(processorid_t, int, int *);
142
143 #endif /* !_KERNEL */
144
145 #ifdef __cplusplus
146 }
147 #endif
148
149 #endif /* _SYS_PROCESSOR_H */