third_party/apple_apsl/malloc.h

   1 /*
   2  * Copyright (c) 1999 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_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. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23
  24 #ifndef THIRD_PARTY_APPLE_APSL_MALLOC_H_
  25 #define THIRD_PARTY_APPLE_APSL_MALLOC_H_
  26
  27 typedef struct _ChromeMallocZone {
  28     /* Only zone implementors should depend on the layout of this structure;
  29     Regular callers should use the access functions below */
  30     void        *reserved1;     /* RESERVED FOR CFAllocator DO NOT USE */
  31     void        *reserved2;     /* RESERVED FOR CFAllocator DO NOT USE */
  32     size_t      (*size)(struct _malloc_zone_t *zone, const void *ptr); /* returns the size of a block or 0 if not in this zone; must be fast, especially for negative answers */
  33     void        *(*malloc)(struct _malloc_zone_t *zone, size_t size);
  34     void        *(*calloc)(struct _malloc_zone_t *zone, size_t num_items, size_t size); /* same as malloc, but block returned is set to zero */
  35     void        *(*valloc)(struct _malloc_zone_t *zone, size_t size); /* same as malloc, but block returned is set to zero and is guaranteed to be page aligned */
  36     void        (*free)(struct _malloc_zone_t *zone, void *ptr);
  37     void        *(*realloc)(struct _malloc_zone_t *zone, void *ptr, size_t size);
  38     void        (*destroy)(struct _malloc_zone_t *zone); /* zone is destroyed and all memory reclaimed */
  39     const char  *zone_name;
  40
  41     /* Optional batch callbacks; these may be NULL */
  42     unsigned    (*batch_malloc)(struct _malloc_zone_t *zone, size_t size, void **results, unsigned num_requested); /* given a size, returns pointers capable of holding that size; returns the number of pointers allocated (maybe 0 or less than num_requested) */
  43     void        (*batch_free)(struct _malloc_zone_t *zone, void **to_be_freed, unsigned num_to_be_freed); /* frees all the pointers in to_be_freed; note that to_be_freed may be overwritten during the process */
  44
  45     struct malloc_introspection_t       *introspect;
  46     unsigned    version;
  47
  48     /* aligned memory allocation. The callback may be NULL. Present in version >= 5. */
  49     void *(*memalign)(struct _malloc_zone_t *zone, size_t alignment, size_t size);
  50
  51     /* free a pointer known to be in zone and known to have the given size. The callback may be NULL. Present in version >= 6.*/
  52     void (*free_definite_size)(struct _malloc_zone_t *zone, void *ptr, size_t size);
  53
  54     /* Empty out caches in the face of memory pressure. The callback may be NULL. Present in version >= 8. */
  55     size_t      (*pressure_relief)(struct _malloc_zone_t *zone, size_t goal);
  56 } ChromeMallocZone;
  57
  58 #endif  // THIRD_PARTY_APPLE_APSL_MALLOC_H_