-<h2>vm_wire</h2>
\r<hr>
\r<p>
\r<strong>Function</strong> - Modify the target region's paging characteristics.
\r<h3>SYNOPSIS</h3>
\r<pre>
\r<strong>kern_return_t vm_wire</strong>
\r <strong>(host_priv_t</strong> <var>host</var>,
\r <strong>vm_task_t</strong> <var>target_task</var>,
\r <strong>vm_address_t</strong> <var>address</var>,
\r <strong>vm_size_t</strong> <var>size</var>,
\r <strong>vm_prot_t</strong> <var>wired_access</var><strong>);</strong>
\r</pre>
\r<h3>PARAMETERS</h3>
\r<dl>
\r<p>
\r<dt> <var>host</var>
\r<dd>
\r[in host-control send right]
\rThe control port for the host for which
\rinformation is to be obtained.
\r<p>
\r<dt> <var>target_task</var>
\r<dd>
\r[in task send right]
\rThe port for the task whose address space contains
\rthe region.
\r<p>
\r<dt> <var>address</var>
\r<dd>
\r[in scalar]
\rThe starting address for the region.
\r<p>
\r<dt> <var>size</var>
\r<dd>
\r[in scalar]
\rThe number of bytes in the region.
\r<p>
\r<dt> <var>wired_access</var>
\r<dd>
\r[in scalar]
\rThe pageability of the region. The following values cause
\rthe region to be wired and protected as specified
\r(values may be combined):
\r<dl>
\r<dt> <strong>VM_PROT_READ</strong>
\r<dt> <strong>VM_PROT_WRITE</strong>
\r<dt> <strong>VM_PROT_execute</strong>
\r</dl>
\r<p>
\rThe following value causes the region to be unwired (made pageable):
\r<dl>
\r<dt> <strong>VM_PROT_NONE</strong>
\r</dl>
\r</dl>
\r<h3>DESCRIPTION</h3>
\r<p>
\rThe <strong>vm_wire</strong> function sets the pageability privileges
\rfor a region within the
\rspecified task's address space. <var>wired_access</var> specifies the types
\rof accesses to
\rthe memory region which must not suffer from (internal) faults
\rof any kind after
\rthis call returns. A non-null <var>wired_access</var> value indicates that
\rthe page is to be
\r"wired" into memory; a null value indicates "un-wiring". The kernel maintains
\rfor the region a count of the number of times the region is wired. A page is
\rwired into physical memory if any task accessing it has a non-zero wired count
\rfor the page.
\r<p>
\rThe region starts at the beginning of the virtual page containing
\r<var>address</var>; it ends at the end of the virtual page containing
\r<var>address</var> + <var>size</var> - 1. Because of this
\rrounding to virtual page boundaries, the amount of memory affected may be
\rgreater than <var>size</var>. Use <strong>host_page_size</strong> to find the current
\rvirtual page size.
\r<h3>NOTES</h3>
\r<p>
\rThis interface is machine word length specific because of the virtual address
\rparameter.
\r<h3>RETURN VALUES</h3>
\r<dl>
\r<p>
\r<dt> <strong>KERN_INVALID_ADDRESS</strong>
\r<dd>
\rThe address is illegal or specifies a non-allocated region.
\r</dl>
\r<h3>RELATED INFORMATION</h3>
\r<p>
\rFunctions:
\r<a href="thread_wire.html"><strong>thread_wire</strong></a>.
\r\ No newline at end of file
+<h2>vm_wire</h2>
+<hr>
+<p>
+<strong>Function</strong> - Modify the target region's paging characteristics.
+<h3>SYNOPSIS</h3>
+<pre>
+<strong>kern_return_t vm_wire</strong>
+ <strong>(host_priv_t</strong> <var>host</var>,
+ <strong>vm_task_t</strong> <var>target_task</var>,
+ <strong>vm_address_t</strong> <var>address</var>,
+ <strong>vm_size_t</strong> <var>size</var>,
+ <strong>vm_prot_t</strong> <var>wired_access</var><strong>);</strong>
+</pre>
+<h3>PARAMETERS</h3>
+<dl>
+<p>
+<dt> <var>host</var>
+<dd>
+[in host-control send right]
+The control port for the host for which
+information is to be obtained.
+<p>
+<dt> <var>target_task</var>
+<dd>
+[in task send right]
+The port for the task whose address space contains
+the region.
+<p>
+<dt> <var>address</var>
+<dd>
+[in scalar]
+The starting address for the region.
+<p>
+<dt> <var>size</var>
+<dd>
+[in scalar]
+The number of bytes in the region.
+<p>
+<dt> <var>wired_access</var>
+<dd>
+[in scalar]
+The pageability of the region. The following values cause
+the region to be wired and protected as specified
+(values may be combined):
+<dl>
+<dt> <strong>VM_PROT_READ</strong>
+<dt> <strong>VM_PROT_WRITE</strong>
+<dt> <strong>VM_PROT_execute</strong>
+</dl>
+<p>
+The following value causes the region to be unwired (made pageable):
+<dl>
+<dt> <strong>VM_PROT_NONE</strong>
+</dl>
+</dl>
+<h3>DESCRIPTION</h3>
+<p>
+The <strong>vm_wire</strong> function sets the pageability privileges
+for a region within the
+specified task's address space. <var>wired_access</var> specifies the types
+of accesses to
+the memory region which must not suffer from (internal) faults
+of any kind after
+this call returns. A non-null <var>wired_access</var> value indicates that
+the page is to be
+"wired" into memory; a null value indicates "un-wiring". The kernel maintains
+for the region a count of the number of times the region is wired. A page is
+wired into physical memory if any task accessing it has a non-zero wired count
+for the page.
+<p>
+The region starts at the beginning of the virtual page containing
+<var>address</var>; it ends at the end of the virtual page containing
+<var>address</var> + <var>size</var> - 1. Because of this
+rounding to virtual page boundaries, the amount of memory affected may be
+greater than <var>size</var>. Use <strong>host_page_size</strong> to find the current
+virtual page size.
+<h3>NOTES</h3>
+<p>
+This interface is machine word length specific because of the virtual address
+parameter.
+<h3>RETURN VALUES</h3>
+<dl>
+<p>
+<dt> <strong>KERN_INVALID_ADDRESS</strong>
+<dd>
+The address is illegal or specifies a non-allocated region.
+</dl>
+<h3>RELATED INFORMATION</h3>
+<p>
+Functions:
+<a href="thread_wire.html"><strong>thread_wire</strong></a>.
projects / apple / xnu.git / blobdiff