osfmk/kern/kalloc.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,1988,1987 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 #ifdef  KERNEL_PRIVATE
  58
  59 #ifndef _KERN_KALLOC_H_
  60 #define _KERN_KALLOC_H_
  61
  62 #include <mach/machine/vm_types.h>
  63 #include <mach/boolean.h>
  64 #include <sys/cdefs.h>
  65 #include <mach/vm_types.h>
  66
  67 __BEGIN_DECLS
  68
  69 #if XNU_KERNEL_PRIVATE
  70
  71 extern void *
  72 kalloc_canblock(
  73                 vm_size_t                * size,
  74                 boolean_t              canblock,
  75                 vm_allocation_site_t * site);
  76
  77 extern vm_size_t
  78 kalloc_size(
  79                 void                             * addr);
  80
  81 extern vm_size_t
  82 kfree_addr(
  83                 void                             * addr);
  84
  85 extern vm_size_t
  86 kalloc_bucket_size(
  87                 vm_size_t                          size);
  88
  89 #define kalloc(size)                                    \
  90         ({ static vm_allocation_site_t site __attribute__((section("__DATA, __data"))); \
  91         vm_size_t tsize = (size);                       \
  92         kalloc_canblock(&tsize, TRUE, &site); })
  93
  94 #define kalloc_tag(size, tag)                   \
  95         ({ static vm_allocation_site_t site __attribute__((section("__DATA, __data"))) \
  96                 = { (tag), 0 };                                 \
  97         vm_size_t tsize = (size);                       \
  98         kalloc_canblock(&tsize, TRUE, &site); })
  99
 100 #define kalloc_tag_bt(size, tag)                \
 101         ({ static vm_allocation_site_t site __attribute__((section("__DATA, __data"))) \
 102                 = { (tag), VM_TAG_BT };                 \
 103         vm_size_t tsize = (size);                       \
 104         kalloc_canblock(&tsize, TRUE, &site); })
 105
 106 #define kalloc_noblock(size)                    \
 107         ({ static vm_allocation_site_t site __attribute__((section("__DATA, __data"))); \
 108         vm_size_t tsize = (size);                       \
 109         kalloc_canblock(&tsize, FALSE, &site); })
 110
 111 #define kalloc_noblock_tag(size, tag)   \
 112         ({ static vm_allocation_site_t site __attribute__((section("__DATA, __data"))) \
 113                 = { (tag), 0 };                 \
 114         vm_size_t tsize = (size);                       \
 115         kalloc_canblock(&tsize, FALSE, &site); })
 116
 117 #define kalloc_noblock_tag_bt(size, tag)        \
 118         ({ static vm_allocation_site_t site __attribute__((section("__DATA, __data"))) \
 119                 = { (tag), VM_TAG_BT };                 \
 120         vm_size_t tsize = (size);                       \
 121         kalloc_canblock(&tsize, FALSE, &site); })
 122
 123
 124 /* these versions update the size reference with the actual size allocated */
 125
 126 #define kallocp(size)                                   \
 127         ({ static vm_allocation_site_t site __attribute__((section("__DATA, __data"))); \
 128         kalloc_canblock((size), TRUE, &site); })
 129
 130 #define kallocp_tag(size, tag)                  \
 131         ({ static vm_allocation_site_t site __attribute__((section("__DATA, __data"))) \
 132                 = { (tag), 0 };                                 \
 133         kalloc_canblock((size), TRUE, &site); })
 134
 135 #define kallocp_tag_bt(size, tag)               \
 136         ({ static vm_allocation_site_t site __attribute__((section("__DATA, __data"))) \
 137                 = { (tag), VM_TAG_BT };                 \
 138         kalloc_canblock((size), TRUE, &site); })
 139
 140 #define kallocp_noblock(size)                   \
 141         ({ static vm_allocation_site_t site __attribute__((section("__DATA, __data"))); \
 142         kalloc_canblock((size), FALSE, &site); })
 143
 144 #define kallocp_noblock_tag_bt(size, tag)       \
 145         ({ static vm_allocation_site_t site __attribute__((section("__DATA, __data"))) \
 146                 = { (tag), VM_TAG_BT };                 \
 147         kalloc_canblock((size), FALSE, &site); })
 148
 149
 150
 151 extern void kfree(void          *data,
 152                   vm_size_t     size);
 153
 154 #else /* XNU_KERNEL_PRIVATE */
 155
 156 extern void *kalloc(vm_size_t   size);
 157
 158 extern void *kalloc_noblock(vm_size_t   size);
 159
 160 extern void kfree(void          *data,
 161                   vm_size_t     size);
 162
 163 #endif /* !XNU_KERNEL_PRIVATE */
 164
 165 __END_DECLS
 166
 167 #ifdef  MACH_KERNEL_PRIVATE
 168
 169 extern void             kalloc_init(void);
 170
 171 extern void             kalloc_fake_zone_init( int );
 172
 173 extern void             kalloc_fake_zone_info(
 174                                 int             *count,
 175                                 vm_size_t       *cur_size,
 176                                 vm_size_t       *max_size,
 177                                 vm_size_t       *elem_size,
 178                                 vm_size_t       *alloc_size,
 179                                 uint64_t        *sum_size,
 180                                 int             *collectable,
 181                                 int             *exhaustable,
 182                                 int             *caller_acct);
 183
 184 extern vm_size_t kalloc_max_prerounded;
 185 extern vm_size_t kalloc_large_total;
 186
 187 #endif  /* MACH_KERNEL_PRIVATE */
 188
 189 #endif  /* _KERN_KALLOC_H_ */
 190
 191 #endif  /* KERNEL_PRIVATE */