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         ({ VM_ALLOC_SITE_STATIC(0, 0);                  \
  91         vm_size_t tsize = (size);                       \
  92         kalloc_canblock(&tsize, TRUE, &site); })
  93
  94 #define kalloc_tag(size, itag)                      \
  95         ({ VM_ALLOC_SITE_STATIC(0, (itag));             \
  96         vm_size_t tsize = (size);                       \
  97         kalloc_canblock(&tsize, TRUE, &site); })
  98
  99 #define kalloc_tag_bt(size, itag)                   \
 100         ({ VM_ALLOC_SITE_STATIC(VM_TAG_BT, (itag));     \
 101         vm_size_t tsize = (size);                       \
 102         kalloc_canblock(&tsize, TRUE, &site); })
 103
 104 #define kalloc_noblock(size)                        \
 105         ({ VM_ALLOC_SITE_STATIC(0, 0);                  \
 106         vm_size_t tsize = (size);                       \
 107         kalloc_canblock(&tsize, FALSE, &site); })
 108
 109 #define kalloc_noblock_tag(size, itag)              \
 110         ({ VM_ALLOC_SITE_STATIC(0, (itag));             \
 111         vm_size_t tsize = (size);                       \
 112         kalloc_canblock(&tsize, FALSE, &site); })
 113
 114 #define kalloc_noblock_tag_bt(size, itag)           \
 115         ({ VM_ALLOC_SITE_STATIC(VM_TAG_BT, (itag));     \
 116         vm_size_t tsize = (size);                       \
 117         kalloc_canblock(&tsize, FALSE, &site); })
 118
 119
 120 /* these versions update the size reference with the actual size allocated */
 121
 122 #define kallocp(size)                               \
 123         ({ VM_ALLOC_SITE_STATIC(0, 0);                  \
 124         kalloc_canblock((size), TRUE, &site); })
 125
 126 #define kallocp_tag(size, itag)                     \
 127         ({ VM_ALLOC_SITE_STATIC(0, (itag));             \
 128         kalloc_canblock((size), TRUE, &site); })
 129
 130 #define kallocp_tag_bt(size, itag)                  \
 131         ({ VM_ALLOC_SITE_STATIC(VM_TAG_BT, (itag));     \
 132         kalloc_canblock((size), TRUE, &site); })
 133
 134 #define kallocp_noblock(size)                       \
 135         ({ VM_ALLOC_SITE_STATIC(0, 0);                  \
 136         kalloc_canblock((size), FALSE, &site); })
 137
 138 #define kallocp_noblock_tag_bt(size, itag)          \
 139         ({ VM_ALLOC_SITE_STATIC(VM_TAG_BT, (itag));     \
 140         kalloc_canblock((size), FALSE, &site); })
 141
 142
 143
 144 extern void kfree(void          *data,
 145     vm_size_t     size);
 146
 147 #define kfree(data, size) \
 148 _Pragma("clang diagnostic push") \
 149 _Pragma("clang diagnostic ignored \"-Wshadow\"") \
 150         do { \
 151                 _Static_assert(sizeof (data) == sizeof (void *) || sizeof (data) == sizeof (mach_vm_address_t), "data is not a pointer"); \
 152                 void *__tmp_addr = (void *) data; \
 153                 vm_size_t __tmp_size = size; \
 154                 data = (__typeof__(data)) NULL; \
 155                 (kfree)(__tmp_addr, __tmp_size); \
 156         } while (0) \
 157 _Pragma("clang diagnostic pop")
 158
 159 #define kfree_addr(addr) \
 160 _Pragma("clang diagnostic push") \
 161 _Pragma("clang diagnostic ignored \"-Wshadow\"") \
 162         do { \
 163                 _Static_assert(sizeof (addr) == sizeof (void *) || sizeof (addr) == sizeof (mach_vm_address_t), "addr is not a pointer"); \
 164                 void *__tmp_addr = (void *) addr; \
 165                 addr = (__typeof__(addr)) NULL; \
 166                 (kfree_addr)(__tmp_addr); \
 167         } while (0) \
 168 _Pragma("clang diagnostic pop")
 169
 170 #else /* XNU_KERNEL_PRIVATE */
 171
 172 extern void *kalloc(vm_size_t   size) __attribute__((alloc_size(1)));
 173
 174 extern void *kalloc_noblock(vm_size_t   size) __attribute__((alloc_size(1)));
 175
 176 extern void kfree(void          *data,
 177     vm_size_t     size);
 178
 179 #endif /* !XNU_KERNEL_PRIVATE */
 180
 181 __END_DECLS
 182
 183 #ifdef  MACH_KERNEL_PRIVATE
 184
 185 extern void             kalloc_init(void);
 186
 187 extern void             kalloc_fake_zone_init( int );
 188
 189 extern void             kalloc_fake_zone_info(
 190         int             *count,
 191         vm_size_t       *cur_size,
 192         vm_size_t       *max_size,
 193         vm_size_t       *elem_size,
 194         vm_size_t       *alloc_size,
 195         uint64_t        *sum_size,
 196         int             *collectable,
 197         int             *exhaustable,
 198         int             *caller_acct);
 199
 200 extern vm_size_t kalloc_max_prerounded;
 201 extern vm_size_t kalloc_large_total;
 202
 203 #endif  /* MACH_KERNEL_PRIVATE */
 204
 205 #endif  /* _KERN_KALLOC_H_ */
 206
 207 #endif  /* KERNEL_PRIVATE */