zone_info.h (7423B) - Raw
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,1989 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 #ifndef _MACH_DEBUG_ZONE_INFO_H_ 60 #define _MACH_DEBUG_ZONE_INFO_H_ 61 62 #include <mach/boolean.h> 63 #include <mach/machine/vm_types.h> 64 65 /* 66 * Legacy definitions for host_zone_info(). This interface, and 67 * these definitions have been deprecated in favor of the new 68 * mach_zone_info() inteface and types below. 69 */ 70 71 #define ZONE_NAME_MAX_LEN 80 72 73 typedef struct zone_name { 74 char zn_name[ZONE_NAME_MAX_LEN]; 75 } zone_name_t; 76 77 typedef zone_name_t *zone_name_array_t; 78 79 80 typedef struct zone_info { 81 integer_t zi_count; /* Number of elements used now */ 82 vm_size_t zi_cur_size; /* current memory utilization */ 83 vm_size_t zi_max_size; /* how large can this zone grow */ 84 vm_size_t zi_elem_size; /* size of an element */ 85 vm_size_t zi_alloc_size; /* size used for more memory */ 86 integer_t zi_pageable; /* zone pageable? */ 87 integer_t zi_sleepable; /* sleep if empty? */ 88 integer_t zi_exhaustible; /* merely return if empty? */ 89 integer_t zi_collectable; /* garbage collect elements? */ 90 } zone_info_t; 91 92 typedef zone_info_t *zone_info_array_t; 93 94 95 /* 96 * Remember to update the mig type definitions 97 * in mach_debug_types.defs when adding/removing fields. 98 */ 99 100 #define MACH_ZONE_NAME_MAX_LEN 80 101 102 typedef struct mach_zone_name { 103 char mzn_name[ZONE_NAME_MAX_LEN]; 104 } mach_zone_name_t; 105 106 typedef mach_zone_name_t *mach_zone_name_array_t; 107 108 typedef struct mach_zone_info_data { 109 uint64_t mzi_count; /* count of elements in use */ 110 uint64_t mzi_cur_size; /* current memory utilization */ 111 uint64_t mzi_max_size; /* how large can this zone grow */ 112 uint64_t mzi_elem_size; /* size of an element */ 113 uint64_t mzi_alloc_size; /* size used for more memory */ 114 uint64_t mzi_sum_size; /* sum of all allocs (life of zone) */ 115 uint64_t mzi_exhaustible; /* merely return if empty? */ 116 uint64_t mzi_collectable; /* garbage collect elements? and how much? */ 117 } mach_zone_info_t; 118 119 typedef mach_zone_info_t *mach_zone_info_array_t; 120 121 /* 122 * The lowest bit of mzi_collectable indicates whether or not the zone 123 * is collectable by zone_gc(). The higher bits contain the size in bytes 124 * that can be collected. 125 */ 126 #define GET_MZI_COLLECTABLE_BYTES(val) ((val) >> 1) 127 #define GET_MZI_COLLECTABLE_FLAG(val) ((val) & 1) 128 129 #define SET_MZI_COLLECTABLE_BYTES(val, size) \ 130 (val) = ((val) & 1) | ((size) << 1) 131 #define SET_MZI_COLLECTABLE_FLAG(val, flag) \ 132 (val) = (flag) ? ((val) | 1) : (val) 133 134 typedef struct task_zone_info_data { 135 uint64_t tzi_count; /* count of elements in use */ 136 uint64_t tzi_cur_size; /* current memory utilization */ 137 uint64_t tzi_max_size; /* how large can this zone grow */ 138 uint64_t tzi_elem_size; /* size of an element */ 139 uint64_t tzi_alloc_size; /* size used for more memory */ 140 uint64_t tzi_sum_size; /* sum of all allocs (life of zone) */ 141 uint64_t tzi_exhaustible; /* merely return if empty? */ 142 uint64_t tzi_collectable; /* garbage collect elements? */ 143 uint64_t tzi_caller_acct; /* charged to caller (or kernel) */ 144 uint64_t tzi_task_alloc; /* sum of all allocs by this task */ 145 uint64_t tzi_task_free; /* sum of all frees by this task */ 146 } task_zone_info_t; 147 148 typedef task_zone_info_t *task_zone_info_array_t; 149 150 #define MACH_MEMORY_INFO_NAME_MAX_LEN 80 151 152 typedef struct mach_memory_info { 153 uint64_t flags; 154 uint64_t site; 155 uint64_t size; 156 uint64_t free; 157 uint64_t largest; 158 uint64_t collectable_bytes; 159 uint64_t mapped; 160 uint64_t peak; 161 uint16_t tag; 162 uint16_t zone; 163 uint16_t _resvA[2]; 164 uint64_t _resv[3]; 165 char name[MACH_MEMORY_INFO_NAME_MAX_LEN]; 166 } mach_memory_info_t; 167 168 typedef mach_memory_info_t *mach_memory_info_array_t; 169 170 /* 171 * MAX_ZTRACE_DEPTH configures how deep of a stack trace is taken on each zalloc in the zone of interest. 15 172 * levels is usually enough to get past all the layers of code in kalloc and IOKit and see who the actual 173 * caller is up above these lower levels. 174 * 175 * This is used both for the zone leak detector and the zone corruption log. Make sure this isn't greater than 176 * BTLOG_MAX_DEPTH defined in btlog.h. Also make sure to update the definition of zone_btrecord_t in 177 * mach_debug_types.defs if this changes. 178 */ 179 180 #define MAX_ZTRACE_DEPTH 15 181 182 /* 183 * Opcodes for the btlog operation field: 184 */ 185 186 #define ZOP_ALLOC 1 187 #define ZOP_FREE 0 188 189 /* 190 * Structure used to copy out btlog records to userspace, via the MIG call 191 * mach_zone_get_btlog_records(). 192 */ 193 typedef struct zone_btrecord { 194 uint32_t ref_count; /* no. of active references on the record */ 195 uint32_t operation_type; /* operation type (alloc/free) */ 196 uint64_t bt[MAX_ZTRACE_DEPTH]; /* backtrace */ 197 } zone_btrecord_t; 198 199 typedef zone_btrecord_t *zone_btrecord_array_t; 200 201 #endif /* _MACH_DEBUG_ZONE_INFO_H_ */