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