xnu-792.6.76.tar.gz

[apple/xnu.git] / osfmk / man / thread_wire.html

diff --git a/osfmk/man/thread_wire.html b/osfmk/man/thread_wire.html
index f52f7a9849d6eea27c0a302ec8c19513783f3502..740aaaf09217309ac359926bbc0144ed4ec4db63 100755 (executable)
--- a/osfmk/man/thread_wire.html
+++ b/osfmk/man/thread_wire.html
@@ -1 +1,53 @@
-<h2>thread_wire</h2>\r<hr>\r<p>\r<strong>Function</strong> - Mark the thread as privileged with respect to kernel resources.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   thread_wire</strong>\r                <strong>(host_priv_t</strong>                          <var>host_priv</var>,\r                 <strong>thread_act_t</strong>                            <var>thread</var>,\r                 <strong>boolean_t</strong>                                <var>wired</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<p>\r<dt> <var>host_priv</var> \r<dd>\r[in host-control send right]\rThe privileged control port for the host on \rwhich the thread executes.\r<p>\r<dt> <var>thread</var> \r<dd>\r[in thread send right]\rThe thread to be wired.\r<p>\r<dt> <var>wired</var> \r<dd>\r[in scalar]\r<strong>TRUE</strong> if the thread is to be wired.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>thread_wire</strong> function marks the thread as "wired".\rA "wired" thread is\ralways eligible to be scheduled and can consume physical memory even when \rfree memory is scarce.  This property should be assigned to threads in the\rdefault page-out path.  Threads not in the default page-out path\rshould not have \rthis property to prevent the kernel's free list of pages from being exhausted.\r<h3>RETURN VALUES</h3>\r<dl>\r<p>\r<dt> <strong>KERN_INVALID_ARGUMENT</strong>\r<dd>\r<var>thread</var> is not a thread port.\r.P\r<var>host_priv</var> is not the control port for the host on which <var>thread</var>\rexecutes.\r</dl>\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="vm_wire.html"><strong>vm_wire</strong></a>.\r
\ No newline at end of file
+<h2>thread_wire</h2>
+<hr>
+<p>
+<strong>Function</strong> - Mark the thread as privileged with respect to kernel resources.
+<h3>SYNOPSIS</h3>
+<pre>
+<strong>kern_return_t   thread_wire</strong>
+                <strong>(host_priv_t</strong>                          <var>host_priv</var>,
+                 <strong>thread_act_t</strong>                            <var>thread</var>,
+                 <strong>boolean_t</strong>                                <var>wired</var><strong>);</strong>
+</pre>
+<h3>PARAMETERS</h3>
+<dl>
+<p>
+<dt> <var>host_priv</var> 
+<dd>
+[in host-control send right]
+The privileged control port for the host on 
+which the thread executes.
+<p>
+<dt> <var>thread</var> 
+<dd>
+[in thread send right]
+The thread to be wired.
+<p>
+<dt> <var>wired</var> 
+<dd>
+[in scalar]
+<strong>TRUE</strong> if the thread is to be wired.
+</dl>
+<h3>DESCRIPTION</h3>
+<p>
+The <strong>thread_wire</strong> function marks the thread as "wired".
+A "wired" thread is
+always eligible to be scheduled and can consume physical memory even when 
+free memory is scarce.  This property should be assigned to threads in the
+default page-out path.  Threads not in the default page-out path
+should not have 
+this property to prevent the kernel's free list of pages from being exhausted.
+<h3>RETURN VALUES</h3>
+<dl>
+<p>
+<dt> <strong>KERN_INVALID_ARGUMENT</strong>
+<dd>
+<var>thread</var> is not a thread port.
+.P
+<var>host_priv</var> is not the control port for the host on which <var>thread</var>
+executes.
+</dl>
+<h3>RELATED INFORMATION</h3>
+<p>
+Functions:
+<a href="vm_wire.html"><strong>vm_wire</strong></a>.