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