osfmk/mach_debug/zone_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,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? */
 117 } mach_zone_info_t;
 118
 119 typedef mach_zone_info_t *mach_zone_info_array_t;
 120
 121 typedef struct task_zone_info_data {
 122         uint64_t        tzi_count;      /* count of elements in use */
 123         uint64_t        tzi_cur_size;   /* current memory utilization */
 124         uint64_t        tzi_max_size;   /* how large can this zone grow */
 125         uint64_t        tzi_elem_size;  /* size of an element */
 126         uint64_t        tzi_alloc_size; /* size used for more memory */
 127         uint64_t        tzi_sum_size;   /* sum of all allocs (life of zone) */
 128         uint64_t        tzi_exhaustible;        /* merely return if empty? */
 129         uint64_t        tzi_collectable;        /* garbage collect elements? */
 130         uint64_t        tzi_caller_acct;        /* charged to caller (or kernel) */
 131         uint64_t        tzi_task_alloc; /* sum of all allocs by this task */
 132         uint64_t        tzi_task_free;  /* sum of all frees by this task */
 133 } task_zone_info_t;
 134
 135 typedef task_zone_info_t *task_zone_info_array_t;
 136
 137 typedef struct mach_memory_info {
 138     uint64_t flags;
 139     uint64_t site;
 140     uint64_t size;
 141     uint64_t free;
 142     uint64_t largest;
 143     uint64_t _resv[3];
 144 } mach_memory_info_t;
 145
 146 typedef mach_memory_info_t *mach_memory_info_array_t;
 147
 148 #endif  /* _MACH_DEBUG_ZONE_INFO_H_ */