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

<h2>vm_region_basic_info</h2>\r<hr>\r<p>\r<strong>Structure</strong> - Defines the attributes of a task's memory region.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>struct vm_region_basic_info</strong>\r<strong>{</strong>\r       <strong>vm_prot_t</strong>             <var>protection</var><strong>;</strong>\r       <strong>vm_prot_t</strong>         <var>max_protection</var><strong>;</strong>\r       <strong>vm_inherit_t</strong>         <var>inheritance</var><strong>;</strong>\r       <strong>boolean_t</strong>                 <var>shared</var><strong>;</strong>\r       <strong>boolean_t</strong>               <var>reserved</var><strong>;</strong>\r       <strong>vm_offset_t</strong>               <var>offset</var><strong>;</strong>\r       <strong>vm_behavior_t</strong>           <var>behavior</var><strong>;</strong>\r       <strong>unsigned short</strong>  <var>user_wired_count</var><strong>;</strong>\r<strong>};</strong>\r\r<strong>typedef struct vm_region_basic_info* vm_region_basic_info_t;</strong>\r</pre>\r<h3>FIELDS</h3>\r<dl>\r<dt> <var>protection</var>\r<dd>\rThe current protection for the region.\r<p>\r<dt> <var>max_protection</var>\r<dd>\rThe maximum protection allowed for the region.\r<p>\r<dt> <var>inheritance</var>\r<dd>\rThe inheritance attribute for the region.\r<p>\r<dt> <var>shared</var>\r<dd>\rShared indicator.  If true, the region is shared by another task.  If false, \rthe region is not shared.\r<p>\r<dt> <var>reserved</var>\r<dd>\rIf true the region is protected from random allocation.\r<p>\r<dt> <var>offset</var>\r<dd>\rThe region's offset into the memory object.  The region begins at this \roffset.\r<p>\r<dt> <var>behavior</var>\r<dd>\rExpected reference pattern for the memory.  Valid values are:\r<dl>\r<p>\r<dt> <strong>VM_BEHAVIOR_DEFAULT</strong>\r<dd>\rThe system's default behavior.\r<p>\r<dt> <strong>VM_BEHAVIOR_RANDOM</strong>\r<dd>\rNo particular order expected.\r<p>\r<dt> <strong>VM_BEHAVIOR_SEQUENTIAL</strong>\r<dd>\rForward sequential order.\r<p>\r<dt> <strong>VM_BEHAVIOR_RSEQNTL</strong>\r<dd>\rReverse sequential order.\r</dl>\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>vm_region_basic_info</strong> structure defines the attributes\rof a memory region returned by <strong>vm_region</strong>.\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="vm_region.html"><strong>vm_region</strong></a>,\r<a href="vm_inherit.html"><strong>vm_inherit</strong></a>,\r<a href="vm_protect.html"><strong>vm_protect</strong></a>.\r