projects / apple / xnu.git / blame
| Commit | Line | Data |
|---|---|---|
| 13fec989 A |
1 | <h2>vm_region_basic_info</h2> |
| 2 | <hr> | |
| 3 | <p> | |
| 4 | <strong>Structure</strong> - Defines the attributes of a task's memory region. | |
| 5 | <h3>SYNOPSIS</h3> | |
| 6 | <pre> | |
| 7 | <strong>struct vm_region_basic_info</strong> | |
| 8 | <strong>{</strong> | |
| 9 | <strong>vm_prot_t</strong> <var>protection</var><strong>;</strong> | |
| 10 | <strong>vm_prot_t</strong> <var>max_protection</var><strong>;</strong> | |
| 11 | <strong>vm_inherit_t</strong> <var>inheritance</var><strong>;</strong> | |
| 12 | <strong>boolean_t</strong> <var>shared</var><strong>;</strong> | |
| 13 | <strong>boolean_t</strong> <var>reserved</var><strong>;</strong> | |
| 14 | <strong>vm_offset_t</strong> <var>offset</var><strong>;</strong> | |
| 15 | <strong>vm_behavior_t</strong> <var>behavior</var><strong>;</strong> | |
| 16 | <strong>unsigned short</strong> <var>user_wired_count</var><strong>;</strong> | |
| 17 | <strong>};</strong> | |
| 18 | ||
| 19 | <strong>typedef struct vm_region_basic_info* vm_region_basic_info_t;</strong> | |
| 20 | </pre> | |
| 21 | <h3>FIELDS</h3> | |
| 22 | <dl> | |
| 23 | <dt> <var>protection</var> | |
| 24 | <dd> | |
| 25 | The current protection for the region. | |
| 26 | <p> | |
| 27 | <dt> <var>max_protection</var> | |
| 28 | <dd> | |
| 29 | The maximum protection allowed for the region. | |
| 30 | <p> | |
| 31 | <dt> <var>inheritance</var> | |
| 32 | <dd> | |
| 33 | The inheritance attribute for the region. | |
| 34 | <p> | |
| 35 | <dt> <var>shared</var> | |
| 36 | <dd> | |
| 37 | Shared indicator. If true, the region is shared by another task. If false, | |
| 38 | the region is not shared. | |
| 39 | <p> | |
| 40 | <dt> <var>reserved</var> | |
| 41 | <dd> | |
| 42 | If true the region is protected from random allocation. | |
| 43 | <p> | |
| 44 | <dt> <var>offset</var> | |
| 45 | <dd> | |
| 46 | The region's offset into the memory object. The region begins at this | |
| 47 | offset. | |
| 48 | <p> | |
| 49 | <dt> <var>behavior</var> | |
| 50 | <dd> | |
| 51 | Expected reference pattern for the memory. Valid values are: | |
| 52 | <dl> | |
| 53 | <p> | |
| 54 | <dt> <strong>VM_BEHAVIOR_DEFAULT</strong> | |
| 55 | <dd> | |
| 56 | The system's default behavior. | |
| 57 | <p> | |
| 58 | <dt> <strong>VM_BEHAVIOR_RANDOM</strong> | |
| 59 | <dd> | |
| 60 | No particular order expected. | |
| 61 | <p> | |
| 62 | <dt> <strong>VM_BEHAVIOR_SEQUENTIAL</strong> | |
| 63 | <dd> | |
| 64 | Forward sequential order. | |
| 65 | <p> | |
| 66 | <dt> <strong>VM_BEHAVIOR_RSEQNTL</strong> | |
| 67 | <dd> | |
| 68 | Reverse sequential order. | |
| 69 | </dl> | |
| 70 | </dl> | |
| 71 | <h3>DESCRIPTION</h3> | |
| 72 | <p> | |
| 73 | The <strong>vm_region_basic_info</strong> structure defines the attributes | |
| 74 | of a memory region returned by <strong>vm_region</strong>. | |
| 75 | <h3>RELATED INFORMATION</h3> | |
| 76 | <p> | |
| 77 | Functions: | |
| 78 | <a href="vm_region.html"><strong>vm_region</strong></a>, | |
| 79 | <a href="vm_inherit.html"><strong>vm_inherit</strong></a>, | |
| 80 | <a href="vm_protect.html"><strong>vm_protect</strong></a>. |