1 .\"
2 .\" Mach Operating System
3 .\" Copyright (c) 1993,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_set_policy_limit.man,v $
29 .\" Revision 2.2 93/12/07 13:56:59 dbg
30 .\" Modified for processor_set_policy_limit.
31 .\" [93/09/22 dbg]
32 .\"
33 .\" Revision 2.5 93/03/18 15:14:28 mrt
34 .\" corrected types
35 .\" [93/03/11 12:54:05 lli]
36 .\"
37 .\" Revision 2.4 91/05/14 17:11:46 mrt
38 .\" Correcting copyright
39 .\"
40 .\" Revision 2.3 91/02/14 14:14:07 mrt
41 .\" Changed to new Mach copyright
42 .\" [91/02/12 18:14:56 mrt]
43 .\"
44 .\" Revision 2.2 90/08/07 18:42:50 rpd
45 .\" Created.
46 .\"
47 .TH processor_set_policy_limit 2 9/22/93
48 .CM 4
49 .SH NAME
50 .nf
51 processor_set_policy_limit \- set maximum values for a policy on a
52 processor set
53 .SH SYNOPSIS
54 .nf
55 .ft B
56 #include <mach.h>
57
58 .nf
59 .ft B
60 kern_return_t
61 processor_set_policy_limit(
62 mach_port_t processor_set,
63 int policy,
64 policy_param_t limit,
65 natural_t limit_count,
66 boolean_t change_threads);
67
68
69 .fi
70 .ft P
71 .SH ARGUMENTS
72 .TP 15
73 .B
74 processor_set
75 Processor set to set maximum priority for.
76 .TP 15
77 .B
78 policy
79 The policy whose limit values are to be changed.
80 .TP 15
81 .B
82 limit
83 The new limit values for the policy.
84 .TP 15
85 .B
86 limit_count
87 Number of items (as natural_t) in
88 .B
89 limit
90 .TP 15
91 .B
92 change_threads
93 Change limit value of existing threads running
94 .B
95 policy
96 if TRUE.
97
98 .SH DESCRIPTION
99 The policy limit values for a particular policy on a processor set are
100 used only for newly created threads running that policy
101 (thread's policy limit is set to processor set's) and the assignment
102 of threads to the set (thread's policy limit is reduced if it exceeds
103 the set's policy limit for the thread's policy; thread's policy
104 parameters are similarly reduced).
105 .B processor_set_policy_limit
106 changes this limit. It also sets the limit values of
107 all threads assigned to the processor set
108 to this new value if
109 .B change_threads
110 is TRUE. If this policy limit is less than the policy parameters of any
111 of these threads, their policy parameters will also be set to this new value.
112
113 .SH DIAGNOSTICS
114 .TP 25
115 KERN_SUCCESS
116 The call succeeded.
117 .TP 25
118 KERN_INVALID_ARGUMENT
119 .B task
120 is not a task, or
121 .B policy
122 is not currently enabled on the processor set, or
123 .B limit
124 is not a valid value for the policy.
125
126 .SH BUGS
127 Availability limited.
128
129 .SH SEE ALSO
130 .B thread_set_policy, thread_set_policy_param,
131 task_set_default_policy, thread_assign
132
133
134
135
Cache object: 65018550cd8c5dc96f179c2d4cd35a5b
|