1/* Copyright (c) 2008, Google Inc.
2 * All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
6 * met:
7 *
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
11 * copyright notice, this list of conditions and the following disclaimer
12 * in the documentation and/or other materials provided with the
13 * distribution.
14 *     * Neither the name of Google Inc. nor the names of its
15 * contributors may be used to endorse or promote products derived from
16 * this software without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 *
30 * --
31 * Author: Craig Silverstein
32 *
33 * C shims for the C++ malloc_hook.h.  See malloc_hook.h for details
34 * on how to use these.
35 */
36
37#ifndef _MALLOC_HOOK_C_H_
38#define _MALLOC_HOOK_C_H_
39
40#include <stddef.h>
41#include <sys/types.h>
42
43/* Annoying stuff for windows; makes sure clients can import these functions */
44#ifndef PERFTOOLS_DLL_DECL
45# ifdef _WIN32
46#   define PERFTOOLS_DLL_DECL  __declspec(dllimport)
47# else
48#   define PERFTOOLS_DLL_DECL
49# endif
50#endif
51
52#ifdef __cplusplus
53extern "C" {
54#endif
55
56/* Get the current stack trace.  Try to skip all routines up to and
57 * and including the caller of MallocHook::Invoke*.
58 * Use "skip_count" (similarly to GetStackTrace from stacktrace.h)
59 * as a hint about how many routines to skip if better information
60 * is not available.
61 */
62PERFTOOLS_DLL_DECL
63int MallocHook_GetCallerStackTrace(void** result, int max_depth,
64                                   int skip_count);
65
66/* The MallocHook_{Add,Remove}*Hook functions return 1 on success and 0 on
67 * failure.
68 */
69
70typedef void (*MallocHook_NewHook)(const void* ptr, size_t size);
71PERFTOOLS_DLL_DECL
72int MallocHook_AddNewHook(MallocHook_NewHook hook);
73PERFTOOLS_DLL_DECL
74int MallocHook_RemoveNewHook(MallocHook_NewHook hook);
75
76typedef void (*MallocHook_DeleteHook)(const void* ptr);
77PERFTOOLS_DLL_DECL
78int MallocHook_AddDeleteHook(MallocHook_DeleteHook hook);
79PERFTOOLS_DLL_DECL
80int MallocHook_RemoveDeleteHook(MallocHook_DeleteHook hook);
81
82typedef void (*MallocHook_PreMmapHook)(const void *start,
83                                       size_t size,
84                                       int protection,
85                                       int flags,
86                                       int fd,
87                                       off_t offset);
88PERFTOOLS_DLL_DECL
89int MallocHook_AddPreMmapHook(MallocHook_PreMmapHook hook);
90PERFTOOLS_DLL_DECL
91int MallocHook_RemovePreMmapHook(MallocHook_PreMmapHook hook);
92
93typedef void (*MallocHook_MmapHook)(const void* result,
94                                    const void* start,
95                                    size_t size,
96                                    int protection,
97                                    int flags,
98                                    int fd,
99                                    off_t offset);
100PERFTOOLS_DLL_DECL
101int MallocHook_AddMmapHook(MallocHook_MmapHook hook);
102PERFTOOLS_DLL_DECL
103int MallocHook_RemoveMmapHook(MallocHook_MmapHook hook);
104
105typedef int (*MallocHook_MmapReplacement)(const void* start,
106                                          size_t size,
107                                          int protection,
108                                          int flags,
109                                          int fd,
110                                          off_t offset,
111                                          void** result);
112int MallocHook_SetMmapReplacement(MallocHook_MmapReplacement hook);
113int MallocHook_RemoveMmapReplacement(MallocHook_MmapReplacement hook);
114
115typedef void (*MallocHook_MunmapHook)(const void* ptr, size_t size);
116PERFTOOLS_DLL_DECL
117int MallocHook_AddMunmapHook(MallocHook_MunmapHook hook);
118PERFTOOLS_DLL_DECL
119int MallocHook_RemoveMunmapHook(MallocHook_MunmapHook hook);
120
121typedef int (*MallocHook_MunmapReplacement)(const void* ptr,
122                                            size_t size,
123                                            int* result);
124int MallocHook_SetMunmapReplacement(MallocHook_MunmapReplacement hook);
125int MallocHook_RemoveMunmapReplacement(MallocHook_MunmapReplacement hook);
126
127typedef void (*MallocHook_MremapHook)(const void* result,
128                                      const void* old_addr,
129                                      size_t old_size,
130                                      size_t new_size,
131                                      int flags,
132                                      const void* new_addr);
133PERFTOOLS_DLL_DECL
134int MallocHook_AddMremapHook(MallocHook_MremapHook hook);
135PERFTOOLS_DLL_DECL
136int MallocHook_RemoveMremapHook(MallocHook_MremapHook hook);
137
138typedef void (*MallocHook_PreSbrkHook)(ptrdiff_t increment);
139PERFTOOLS_DLL_DECL
140int MallocHook_AddPreSbrkHook(MallocHook_PreSbrkHook hook);
141PERFTOOLS_DLL_DECL
142int MallocHook_RemovePreSbrkHook(MallocHook_PreSbrkHook hook);
143
144typedef void (*MallocHook_SbrkHook)(const void* result, ptrdiff_t increment);
145PERFTOOLS_DLL_DECL
146int MallocHook_AddSbrkHook(MallocHook_SbrkHook hook);
147PERFTOOLS_DLL_DECL
148int MallocHook_RemoveSbrkHook(MallocHook_SbrkHook hook);
149
150/* The following are DEPRECATED. */
151PERFTOOLS_DLL_DECL
152MallocHook_NewHook MallocHook_SetNewHook(MallocHook_NewHook hook);
153PERFTOOLS_DLL_DECL
154MallocHook_DeleteHook MallocHook_SetDeleteHook(MallocHook_DeleteHook hook);
155PERFTOOLS_DLL_DECL
156MallocHook_PreMmapHook MallocHook_SetPreMmapHook(MallocHook_PreMmapHook hook);
157PERFTOOLS_DLL_DECL
158MallocHook_MmapHook MallocHook_SetMmapHook(MallocHook_MmapHook hook);
159PERFTOOLS_DLL_DECL
160MallocHook_MunmapHook MallocHook_SetMunmapHook(MallocHook_MunmapHook hook);
161PERFTOOLS_DLL_DECL
162MallocHook_MremapHook MallocHook_SetMremapHook(MallocHook_MremapHook hook);
163PERFTOOLS_DLL_DECL
164MallocHook_PreSbrkHook MallocHook_SetPreSbrkHook(MallocHook_PreSbrkHook hook);
165PERFTOOLS_DLL_DECL
166MallocHook_SbrkHook MallocHook_SetSbrkHook(MallocHook_SbrkHook hook);
167/* End of DEPRECATED functions. */
168
169#ifdef __cplusplus
170}   // extern "C"
171#endif
172
173#endif /* _MALLOC_HOOK_C_H_ */
174