xref: /trueos/sys/sys/mach_debug/zone_info.h (revision 9c1dde6c551c2fcfdb84a29c80e2a77eff789c59)
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 <sys/mach/vm_types.h>
63 
64 /*
65  *	Legacy definitions for host_zone_info().  This interface, and
66  *	these definitions have been deprecated in favor of the new
67  *	mach_zone_info() inteface and types below.
68  */
69 
70 #define ZONE_NAME_MAX_LEN		80
71 
72 typedef struct zone_name {
73 	char		zn_name[ZONE_NAME_MAX_LEN];
74 } zone_name_t;
75 
76 typedef zone_name_t *zone_name_array_t;
77 
78 
79 typedef struct zone_info {
80 	integer_t	zi_count;	/* Number of elements used now */
81 	vm_size_t	zi_cur_size;	/* current memory utilization */
82 	vm_size_t	zi_max_size;	/* how large can this zone grow */
83 	vm_size_t	zi_elem_size;	/* size of an element */
84 	vm_size_t	zi_alloc_size;	/* size used for more memory */
85 	integer_t	zi_pageable;	/* zone pageable? */
86 	integer_t	zi_sleepable;	/* sleep if empty? */
87 	integer_t	zi_exhaustible;	/* merely return if empty? */
88 	integer_t	zi_collectable;	/* garbage collect elements? */
89 } zone_info_t;
90 
91 typedef zone_info_t *zone_info_array_t;
92 
93 
94 /*
95  *	Remember to update the mig type definitions
96  *	in mach_debug_types.defs when adding/removing fields.
97  */
98 
99 #define MACH_ZONE_NAME_MAX_LEN		80
100 
101 typedef struct mach_zone_name {
102 	char		mzn_name[ZONE_NAME_MAX_LEN];
103 } mach_zone_name_t;
104 
105 typedef mach_zone_name_t *mach_zone_name_array_t;
106 
107 typedef struct mach_zone_info_data {
108 	uint64_t	mzi_count;	/* count of elements in use */
109 	uint64_t	mzi_cur_size;	/* current memory utilization */
110 	uint64_t	mzi_max_size;	/* how large can this zone grow */
111         uint64_t	mzi_elem_size;	/* size of an element */
112 	uint64_t	mzi_alloc_size;	/* size used for more memory */
113 	uint64_t	mzi_sum_size;	/* sum of all allocs (life of zone) */
114 	uint64_t	mzi_exhaustible;	/* merely return if empty? */
115 	uint64_t	mzi_collectable;	/* garbage collect elements? */
116 } mach_zone_info_t;
117 
118 typedef mach_zone_info_t *mach_zone_info_array_t;
119 
120 typedef struct task_zone_info_data {
121 	uint64_t	tzi_count;	/* count of elements in use */
122 	uint64_t	tzi_cur_size;	/* current memory utilization */
123 	uint64_t	tzi_max_size;	/* how large can this zone grow */
124         uint64_t	tzi_elem_size;	/* size of an element */
125 	uint64_t	tzi_alloc_size;	/* size used for more memory */
126 	uint64_t	tzi_sum_size;	/* sum of all allocs (life of zone) */
127 	uint64_t	tzi_exhaustible;	/* merely return if empty? */
128 	uint64_t	tzi_collectable;	/* garbage collect elements? */
129 	uint64_t	tzi_caller_acct;	/* charged to caller (or kernel) */
130 	uint64_t	tzi_task_alloc;	/* sum of all allocs by this task */
131 	uint64_t	tzi_task_free;	/* sum of all frees by this task */
132 } task_zone_info_t;
133 
134 typedef task_zone_info_t *task_zone_info_array_t;
135 #endif	/* _MACH_DEBUG_ZONE_INFO_H_ */
136