1 .\"
2 .\" Mach Operating System
3 .\" Copyright (c) 1991,1990 Carnegie Mellon University
4 .\" All Rights Reserved.
5 .\"
6 .\" Permission to use, copy, modify and distribute this software and its
7 .\" documentation is hereby granted, provided that both the copyright
8 .\" notice and this permission notice appear in all copies of the
9 .\" software, derivative works or modified versions, and any portions
10 .\" thereof, and that both notices appear in supporting documentation.
11 .\"
12 .\" CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
13 .\" CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
14 .\" ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
15 .\"
16 .\" Carnegie Mellon requests users of this software to return to
17 .\"
18 .\" Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
19 .\" School of Computer Science
20 .\" Carnegie Mellon University
21 .\" Pittsburgh PA 15213-3890
22 .\"
23 .\" any improvements or extensions that they make and grant Carnegie Mellon
24 .\" the rights to redistribute these changes.
25 .\"
26 .\"
27 .\" HISTORY
28 .\" $Log: processor_control.man,v $
29 .\" Revision 2.5 93/03/18 14:46:40 mrt
30 .\" corrected types
31 .\" [93/03/11 12:51:02 lli]
32 .\"
33 .\" Revision 2.4 91/05/14 17:10:59 mrt
34 .\" Correcting copyright
35 .\"
36 .\" Revision 2.3 91/02/14 14:13:43 mrt
37 .\" Changed to new Mach copyright
38 .\" [91/02/12 18:14:26 mrt]
39 .\"
40 .\" Revision 2.2 90/08/07 18:42:03 rpd
41 .\" Created.
42 .\"
43 .TH processor_control 2 8/13/89
44 .CM 4
45 .SH NAME
46 .nf
47 processor_control \- do something to a processor
48 processor_exit \- exit a processor
49 processor_start \- start a processor
50 .SH SYNOPSIS
51 .nf
52 .ft B
53 #include <mach.h>
54
55 .nf
56 .ft B
57 kern_return_t processor_start(processor)
58 mach_port_t processor;
59
60
61 .fi
62 .ft P
63 .nf
64 .ft B
65 kern_return_t processor_exit(processor)
66 mach_port_t processor;
67
68
69 .fi
70 .ft P
71 .nf
72 .ft B
73 kern_return_t processor_control(processor, cmd, count)
74 mach_port_t processor;
75 processor_info_t *cmd; /* array of ints */
76 mach_msg_type_number_t count;
77
78
79 .fi
80 .ft P
81 .SH ARGUMENTS
82 .TP 15
83 .B
84 .B processor
85 Specifies the processor.
86 .TP 15
87 .B
88 .B cmd
89 Contains the command to be applied to the processor.
90 .TP 15
91 .B
92 .B count
93 Specifies the length of the command as a number of ints.
94
95 .SH DESCRIPTION
96 Some multiprocessors may allow privileged software to control processors.
97 The
98 .B processor_start, processor_exit
99 , and
100 .B processor_control
101 operations implement this. The interpretation of the command in
102 .B cmd
103 is machine dependent. A newly started processor is assigned to the
104 default processor set. An exited processor is removed from the
105 processor set to which it was assigned and ceases to be active.
106
107
108 .SH DIAGNOSTICS
109 .TP 25
110 KERN_SUCCESS
111 The operation was performed.
112 .TP 25
113 KERN_FAILURE
114 The operation was not performed. A likely reason is that it
115 is not supported on this processor.
116 .TP 25
117 KERN_INVALID_ARGUMENT
118 .B processor
119 is not a processor.
120 .TP 25
121 KERN_INVALID_ADDRESS
122 .B data
123 points to inaccessible memory.
124
125 .SH SEE ALSO
126 .B processor_info, host_processors
127
128 .SH BUGS
129 Availability limited.
130 All of these operations are machine-dependent. They may do nothing.
131 The ability to restart an exited processor is also machine-dependent.
132
Cache object: fa7694865c3803bcbe9236f608caee48
|