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