osfmk/mach_debug/vm_info.h

   1 /*
   2  * Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /*
  29  * @OSF_COPYRIGHT@
  30  */
  31 /*
  32  * Mach Operating System
  33  * Copyright (c) 1991,1990 Carnegie Mellon University
  34  * All Rights Reserved.
  35  *
  36  * Permission to use, copy, modify and distribute this software and its
  37  * documentation is hereby granted, provided that both the copyright
  38  * notice and this permission notice appear in all copies of the
  39  * software, derivative works or modified versions, and any portions
  40  * thereof, and that both notices appear in supporting documentation.
  41  *
  42  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  43  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
  44  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  45  *
  46  * Carnegie Mellon requests users of this software to return to
  47  *
  48  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  49  *  School of Computer Science
  50  *  Carnegie Mellon University
  51  *  Pittsburgh PA 15213-3890
  52  *
  53  * any improvements or extensions that they make and grant Carnegie Mellon
  54  * the rights to redistribute these changes.
  55  */
  56 /*
  57  */
  58 /*
  59  *      File:   mach_debug/vm_info.h
  60  *      Author: Rich Draves
  61  *      Date:   March, 1990
  62  *
  63  *      Definitions for the VM debugging interface.
  64  */
  65
  66 #ifndef _MACH_DEBUG_VM_INFO_H_
  67 #define _MACH_DEBUG_VM_INFO_H_
  68
  69 #include <mach/boolean.h>
  70 #include <mach/machine/vm_types.h>
  71 #include <mach/vm_inherit.h>
  72 #include <mach/vm_prot.h>
  73 #include <mach/memory_object_types.h>
  74
  75 #if __DARWIN_ALIGN_POWER
  76 #pragma options align=power
  77 #endif
  78
  79 /*
  80  *      Remember to update the mig type definitions
  81  *      in mach_debug_types.defs when adding/removing fields.
  82  */
  83 typedef struct mach_vm_info_region {
  84         mach_vm_offset_t vir_start;     /* start of region */
  85         mach_vm_offset_t vir_end;       /* end of region */
  86         mach_vm_offset_t vir_object;    /* the mapped object(kernal addr) */
  87         memory_object_offset_t vir_offset;      /* offset into object */
  88         boolean_t vir_needs_copy;       /* does object need to be copied? */
  89         vm_prot_t vir_protection;       /* protection code */
  90         vm_prot_t vir_max_protection;   /* maximum protection */
  91         vm_inherit_t vir_inheritance;   /* inheritance */
  92         natural_t vir_wired_count;      /* number of times wired */
  93         natural_t vir_user_wired_count; /* number of times user has wired */
  94 } mach_vm_info_region_t;
  95
  96 typedef struct vm_info_region_64 {
  97         natural_t vir_start;            /* start of region */
  98         natural_t vir_end;              /* end of region */
  99         natural_t vir_object;           /* the mapped object */
 100         memory_object_offset_t vir_offset;      /* offset into object */
 101         boolean_t vir_needs_copy;       /* does object need to be copied? */
 102         vm_prot_t vir_protection;       /* protection code */
 103         vm_prot_t vir_max_protection;   /* maximum protection */
 104         vm_inherit_t vir_inheritance;   /* inheritance */
 105         natural_t vir_wired_count;      /* number of times wired */
 106         natural_t vir_user_wired_count; /* number of times user has wired */
 107 } vm_info_region_64_t;
 108
 109 typedef struct vm_info_region {
 110         natural_t vir_start;            /* start of region */
 111         natural_t vir_end;              /* end of region */
 112         natural_t vir_object;           /* the mapped object */
 113         natural_t vir_offset;           /* offset into object */
 114         boolean_t vir_needs_copy;       /* does object need to be copied? */
 115         vm_prot_t vir_protection;       /* protection code */
 116         vm_prot_t vir_max_protection;   /* maximum protection */
 117         vm_inherit_t vir_inheritance;   /* inheritance */
 118         natural_t vir_wired_count;      /* number of times wired */
 119         natural_t vir_user_wired_count; /* number of times user has wired */
 120 } vm_info_region_t;
 121
 122
 123 typedef struct vm_info_object {
 124         natural_t vio_object;           /* this object */
 125         natural_t vio_size;             /* object size (valid if internal - but too small) */
 126         unsigned int vio_ref_count;     /* number of references */
 127         unsigned int vio_resident_page_count; /* number of resident pages */
 128         unsigned int vio_absent_count;  /* number requested but not filled */
 129         natural_t vio_copy;             /* copy object */
 130         natural_t vio_shadow;           /* shadow object */
 131         natural_t vio_shadow_offset;    /* offset into shadow object */
 132         natural_t vio_paging_offset;    /* offset into memory object */
 133         memory_object_copy_strategy_t vio_copy_strategy;
 134                                         /* how to handle data copy */
 135         vm_offset_t vio_last_alloc;     /* offset of last allocation */
 136         /* many random attributes */
 137         unsigned int vio_paging_in_progress;
 138         boolean_t vio_pager_created;
 139         boolean_t vio_pager_initialized;
 140         boolean_t vio_pager_ready;
 141         boolean_t vio_can_persist;
 142         boolean_t vio_internal;
 143         boolean_t vio_temporary;
 144         boolean_t vio_alive;
 145         boolean_t vio_purgable;
 146         boolean_t vio_purgable_volatile;
 147 } vm_info_object_t;
 148
 149 typedef vm_info_object_t *vm_info_object_array_t;
 150
 151 #if __DARWIN_ALIGN_POWER
 152 #pragma options align=reset
 153 #endif
 154
 155 #endif  /* _MACH_DEBUG_VM_INFO_H_ */