xref: /xnu-11215/osfmk/man/thread_wire.html (revision 186b8fce)
1*e13b1fa5SApple OSS Distributions<h2>thread_wire</h2>
2*e13b1fa5SApple OSS Distributions<hr>
3*e13b1fa5SApple OSS Distributions<p>
4*e13b1fa5SApple OSS Distributions<strong>Function</strong> - Mark the thread as privileged with respect to kernel resources.
5*e13b1fa5SApple OSS Distributions<h3>SYNOPSIS</h3>
6*e13b1fa5SApple OSS Distributions<pre>
7*e13b1fa5SApple OSS Distributions<strong>kern_return_t   thread_wire</strong>
8*e13b1fa5SApple OSS Distributions                <strong>(host_priv_t</strong>                          <var>host_priv</var>,
9*e13b1fa5SApple OSS Distributions                 <strong>thread_act_t</strong>                            <var>thread</var>,
10*e13b1fa5SApple OSS Distributions                 <strong>boolean_t</strong>                                <var>wired</var><strong>);</strong>
11*e13b1fa5SApple OSS Distributions</pre>
12*e13b1fa5SApple OSS Distributions<h3>PARAMETERS</h3>
13*e13b1fa5SApple OSS Distributions<dl>
14*e13b1fa5SApple OSS Distributions<p>
15*e13b1fa5SApple OSS Distributions<dt> <var>host_priv</var>
16*e13b1fa5SApple OSS Distributions<dd>
17*e13b1fa5SApple OSS Distributions[in host-control send right]
18*e13b1fa5SApple OSS DistributionsThe privileged control port for the host on
19*e13b1fa5SApple OSS Distributionswhich the thread executes.
20*e13b1fa5SApple OSS Distributions<p>
21*e13b1fa5SApple OSS Distributions<dt> <var>thread</var>
22*e13b1fa5SApple OSS Distributions<dd>
23*e13b1fa5SApple OSS Distributions[in thread send right]
24*e13b1fa5SApple OSS DistributionsThe thread to be wired.
25*e13b1fa5SApple OSS Distributions<p>
26*e13b1fa5SApple OSS Distributions<dt> <var>wired</var>
27*e13b1fa5SApple OSS Distributions<dd>
28*e13b1fa5SApple OSS Distributions[in scalar]
29*e13b1fa5SApple OSS Distributions<strong>TRUE</strong> if the thread is to be wired.
30*e13b1fa5SApple OSS Distributions</dl>
31*e13b1fa5SApple OSS Distributions<h3>DESCRIPTION</h3>
32*e13b1fa5SApple OSS Distributions<p>
33*e13b1fa5SApple OSS DistributionsThe <strong>thread_wire</strong> function marks the thread as "wired".
34*e13b1fa5SApple OSS DistributionsA "wired" thread is
35*e13b1fa5SApple OSS Distributionsalways eligible to be scheduled and can consume physical memory even when
36*e13b1fa5SApple OSS Distributionsfree memory is scarce.  This property should be assigned to threads in the
37*e13b1fa5SApple OSS Distributionsdefault page-out path.  Threads not in the default page-out path
38*e13b1fa5SApple OSS Distributionsshould not have
39*e13b1fa5SApple OSS Distributionsthis property to prevent the kernel's free list of pages from being exhausted.
40*e13b1fa5SApple OSS Distributions<h3>RETURN VALUES</h3>
41*e13b1fa5SApple OSS Distributions<dl>
42*e13b1fa5SApple OSS Distributions<p>
43*e13b1fa5SApple OSS Distributions<dt> <strong>KERN_INVALID_ARGUMENT</strong>
44*e13b1fa5SApple OSS Distributions<dd>
45*e13b1fa5SApple OSS Distributions<var>thread</var> is not a thread port.
46*e13b1fa5SApple OSS Distributions.P
47*e13b1fa5SApple OSS Distributions<var>host_priv</var> is not the control port for the host on which <var>thread</var>
48*e13b1fa5SApple OSS Distributionsexecutes.
49*e13b1fa5SApple OSS Distributions</dl>
50*e13b1fa5SApple OSS Distributions<h3>RELATED INFORMATION</h3>
51*e13b1fa5SApple OSS Distributions<p>
52*e13b1fa5SApple OSS DistributionsFunctions:
53*e13b1fa5SApple OSS Distributions<a href="vm_wire.html"><strong>vm_wire</strong></a>.
54