libkern/libkern/OSMalloc.h

   1 /*
   2  * Copyright (c) 2003-2004 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_OSREFERENCE_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
  10  * License may not be used to create, or enable the creation or
  11  * redistribution of, unlawful or unlicensed copies of an Apple operating
  12  * system, or to circumvent, violate, or enable the circumvention or
  13  * violation of, any terms of an Apple operating system software license
  14  * agreement.
  15  *
  16  * Please obtain a copy of the License at
  17  * http://www.opensource.apple.com/apsl/ and read it before using this
  18  * file.
  19  *
  20  * The Original Code and all software distributed under the License are
  21  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  22  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  23  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  24  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  25  * Please see the License for the specific language governing rights and
  26  * limitations under the License.
  27  *
  28  * @APPLE_LICENSE_OSREFERENCE_HEADER_END@
  29  */
  30
  31 #ifndef LIBKERN_OSMALLOC_h
  32 #define LIBKERN_OSMALLOC_h
  33
  34 #include <sys/cdefs.h>
  35
  36 __BEGIN_DECLS
  37
  38 #include <stdint.h>
  39 #ifdef  MACH_KERNEL_PRIVATE
  40 #include <kern/queue.h>
  41 #endif
  42
  43 #ifdef  MACH_KERNEL_PRIVATE
  44
  45 #define OSMT_MAX_NAME   64
  46
  47 typedef struct  _OSMallocTag_ {
  48         queue_chain_t   OSMT_link;
  49         uint32_t                OSMT_refcnt;
  50         uint32_t                OSMT_state;
  51         uint32_t                OSMT_attr;
  52         char                    OSMT_name[OSMT_MAX_NAME];
  53 } *OSMallocTag;
  54
  55 #define OSMT_VALID_MASK         0xFFFF0000
  56 #define OSMT_VALID              0xDEAB0000
  57 #define OSMT_RELEASED           0x00000001
  58
  59 #define OSMT_ATTR_PAGEABLE      0x01
  60 #else
  61 typedef struct __OSMallocTag__  *OSMallocTag, *OSMallocTag_t;
  62 #endif
  63
  64 #define  OSMT_DEFAULT   0x00
  65 #define  OSMT_PAGEABLE  0x01
  66
  67 extern OSMallocTag              OSMalloc_Tagalloc(const char * str, uint32_t flags);
  68
  69 extern void                             OSMalloc_Tagfree(OSMallocTag tag);
  70
  71 extern void *                   OSMalloc(uint32_t size, OSMallocTag tag);
  72
  73 extern void *                   OSMalloc_nowait(uint32_t size, OSMallocTag tag);
  74
  75 extern void *                   OSMalloc_noblock(uint32_t size, OSMallocTag tag);
  76
  77 extern void                             OSFree(void * addr, uint32_t size, OSMallocTag tag);
  78
  79 __END_DECLS
  80
  81 #endif  /* LIBKERN_OSMALLOC_h */