1/* Copyright (c) 2003, 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: Sanjay Ghemawat <opensource@google.com>
32 *         .h.in file by Craig Silverstein <opensource@google.com>
33 */
34
35#ifndef TCMALLOC_TCMALLOC_H_
36#define TCMALLOC_TCMALLOC_H_
37
38#include <stddef.h>                     // for size_t
39#ifdef HAVE_SYS_CDEFS_H
40#include <sys/cdefs.h>   // where glibc defines __THROW
41#endif
42
43// __THROW is defined in glibc systems.  It means, counter-intuitively,
44// "This function will never throw an exception."  It's an optional
45// optimization tool, but we may need to use it to match glibc prototypes.
46#ifndef __THROW    /* I guess we're not on a glibc system */
47# define __THROW   /* __THROW is just an optimization, so ok to make it "" */
48#endif
49
50// Define the version number so folks can check against it
51#define TC_VERSION_MAJOR  2
52#define TC_VERSION_MINOR  0
53#define TC_VERSION_PATCH  ""
54#define TC_VERSION_STRING "gperftools 2.0"
55
56#include <stdlib.h>   // for struct mallinfo, if it's defined
57
58// Annoying stuff for windows -- makes sure clients can import these functions
59#ifndef PERFTOOLS_DLL_DECL
60# ifdef _WIN32
61#   define PERFTOOLS_DLL_DECL  __declspec(dllimport)
62# else
63#   define PERFTOOLS_DLL_DECL
64# endif
65#endif
66
67#ifdef __cplusplus
68namespace std {
69struct nothrow_t;
70}
71
72extern "C" {
73#endif
74  // Returns a human-readable version string.  If major, minor,
75  // and/or patch are not NULL, they are set to the major version,
76  // minor version, and patch-code (a string, usually "").
77  PERFTOOLS_DLL_DECL const char* tc_version(int* major, int* minor,
78                                            const char** patch) __THROW;
79
80  PERFTOOLS_DLL_DECL void* tc_malloc(size_t size) __THROW;
81  PERFTOOLS_DLL_DECL void tc_free(void* ptr) __THROW;
82  PERFTOOLS_DLL_DECL void* tc_realloc(void* ptr, size_t size) __THROW;
83  PERFTOOLS_DLL_DECL void* tc_calloc(size_t nmemb, size_t size) __THROW;
84  PERFTOOLS_DLL_DECL void tc_cfree(void* ptr) __THROW;
85
86  PERFTOOLS_DLL_DECL void* tc_memalign(size_t __alignment,
87                                       size_t __size) __THROW;
88  PERFTOOLS_DLL_DECL int tc_posix_memalign(void** ptr,
89                                           size_t align, size_t size) __THROW;
90  PERFTOOLS_DLL_DECL void* tc_valloc(size_t __size) __THROW;
91  PERFTOOLS_DLL_DECL void* tc_pvalloc(size_t __size) __THROW;
92
93  PERFTOOLS_DLL_DECL void tc_malloc_stats(void) __THROW;
94  PERFTOOLS_DLL_DECL int tc_mallopt(int cmd, int value) __THROW;
95#if 0
96  PERFTOOLS_DLL_DECL struct mallinfo tc_mallinfo(void) __THROW;
97#endif
98
99  // This is an alias for MallocExtension::instance()->GetAllocatedSize().
100  // It is equivalent to
101  //    OS X: malloc_size()
102  //    glibc: malloc_usable_size()
103  //    Windows: _msize()
104  PERFTOOLS_DLL_DECL size_t tc_malloc_size(void* ptr) __THROW;
105
106#ifdef __cplusplus
107  PERFTOOLS_DLL_DECL int tc_set_new_mode(int flag) __THROW;
108  PERFTOOLS_DLL_DECL void* tc_new(size_t size);
109  PERFTOOLS_DLL_DECL void* tc_new_nothrow(size_t size,
110                                          const std::nothrow_t&) __THROW;
111  PERFTOOLS_DLL_DECL void tc_delete(void* p) __THROW;
112  PERFTOOLS_DLL_DECL void tc_delete_nothrow(void* p,
113                                            const std::nothrow_t&) __THROW;
114  PERFTOOLS_DLL_DECL void* tc_newarray(size_t size);
115  PERFTOOLS_DLL_DECL void* tc_newarray_nothrow(size_t size,
116                                               const std::nothrow_t&) __THROW;
117  PERFTOOLS_DLL_DECL void tc_deletearray(void* p) __THROW;
118  PERFTOOLS_DLL_DECL void tc_deletearray_nothrow(void* p,
119                                                 const std::nothrow_t&) __THROW;
120}
121#endif
122
123#endif  // #ifndef TCMALLOC_TCMALLOC_H_
124