1/*
2 * Copyright (C) 2009 The Android Open Source Project
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *  * Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 *  * Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in
12 *    the documentation and/or other materials provided with the
13 *    distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
18 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
19 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
21 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
22 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
23 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
25 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 */
28
29/*
30 * Contains declarations of types and constants used by malloc leak
31 * detection code in both, libc and libc_malloc_debug libraries.
32 */
33#ifndef MALLOC_DEBUG_COMMON_H
34#define MALLOC_DEBUG_COMMON_H
35
36#include <pthread.h>
37#include <stdint.h>
38#include <stdlib.h>
39
40#include "private/bionic_config.h"
41#include "private/libc_logging.h"
42
43#define HASHTABLE_SIZE      1543
44#define BACKTRACE_SIZE      32
45/* flag definitions, currently sharing storage with "size" */
46#define SIZE_FLAG_ZYGOTE_CHILD  (1<<31)
47#define SIZE_FLAG_MASK          (SIZE_FLAG_ZYGOTE_CHILD)
48
49// This must match the alignment used by the malloc implementation.
50#ifndef MALLOC_ALIGNMENT
51#define MALLOC_ALIGNMENT ((size_t)(2 * sizeof(void *)))
52#endif
53
54// =============================================================================
55// Structures
56// =============================================================================
57
58struct HashEntry {
59    size_t slot;
60    HashEntry* prev;
61    HashEntry* next;
62    size_t numEntries;
63    // fields above "size" are NOT sent to the host
64    size_t size;
65    size_t allocations;
66    uintptr_t backtrace[0];
67};
68
69struct HashTable {
70    pthread_mutex_t lock;
71    size_t count;
72    HashEntry* slots[HASHTABLE_SIZE];
73};
74
75/* Entry in malloc dispatch table. */
76typedef void* (*MallocDebugCalloc)(size_t, size_t);
77typedef void (*MallocDebugFree)(void*);
78typedef struct mallinfo (*MallocDebugMallinfo)();
79typedef void* (*MallocDebugMalloc)(size_t);
80typedef size_t (*MallocDebugMallocUsableSize)(const void*);
81typedef void* (*MallocDebugMemalign)(size_t, size_t);
82typedef int (*MallocDebugPosixMemalign)(void**, size_t, size_t);
83#if defined(HAVE_DEPRECATED_MALLOC_FUNCS)
84typedef void* (*MallocDebugPvalloc)(size_t);
85#endif
86typedef void* (*MallocDebugRealloc)(void*, size_t);
87#if defined(HAVE_DEPRECATED_MALLOC_FUNCS)
88typedef void* (*MallocDebugValloc)(size_t);
89#endif
90
91struct MallocDebug {
92  MallocDebugCalloc calloc;
93  MallocDebugFree free;
94  MallocDebugMallinfo mallinfo;
95  MallocDebugMalloc malloc;
96  MallocDebugMallocUsableSize malloc_usable_size;
97  MallocDebugMemalign memalign;
98  MallocDebugPosixMemalign posix_memalign;
99#if defined(HAVE_DEPRECATED_MALLOC_FUNCS)
100  MallocDebugPvalloc pvalloc;
101#endif
102  MallocDebugRealloc realloc;
103#if defined(HAVE_DEPRECATED_MALLOC_FUNCS)
104  MallocDebugValloc valloc;
105#endif
106};
107
108typedef bool (*MallocDebugInit)(HashTable*, const MallocDebug*);
109typedef void (*MallocDebugFini)(int);
110
111// =============================================================================
112// log functions
113// =============================================================================
114
115#define debug_log(format, ...)  \
116    __libc_format_log(ANDROID_LOG_DEBUG, "malloc_leak_check", (format), ##__VA_ARGS__ )
117#define error_log(format, ...)  \
118    __libc_format_log(ANDROID_LOG_ERROR, "malloc_leak_check", (format), ##__VA_ARGS__ )
119#define info_log(format, ...)  \
120    __libc_format_log(ANDROID_LOG_INFO, "malloc_leak_check", (format), ##__VA_ARGS__ )
121
122#endif  // MALLOC_DEBUG_COMMON_H
123