15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/* Copyright (c) 2005, Google Inc. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * All rights reserved. 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Redistribution and use in source and binary forms, with or without 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * modification, are permitted provided that the following conditions are 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * met: 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * * Redistributions of source code must retain the above copyright 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * notice, this list of conditions and the following disclaimer. 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * * Redistributions in binary form must reproduce the above 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * copyright notice, this list of conditions and the following disclaimer 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * in the documentation and/or other materials provided with the 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * distribution. 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * * Neither the name of Google Inc. nor the names of its 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * contributors may be used to endorse or promote products derived from 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * this software without specific prior written permission. 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * --- 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Author: Sanjay Ghemawat 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Module for heap-profiling. 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * For full(er) information, see doc/heapprofile.html 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * This module can be linked into your program with 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * no slowdown caused by this unless you activate the profiler 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * using one of the following methods: 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 1. Before starting the program, set the environment variable 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * "HEAPPROFILE" to be the name of the file to which the profile 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * data should be written. 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 2. Programmatically, start and stop the profiler using the 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * routines "HeapProfilerStart(filename)" and "HeapProfilerStop()". 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef BASE_HEAP_PROFILER_H_ 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define BASE_HEAP_PROFILER_H_ 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <stddef.h> 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/* Annoying stuff for windows; makes sure clients can import these functions */ 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef PERFTOOLS_DLL_DECL 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# ifdef _WIN32 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# define PERFTOOLS_DLL_DECL __declspec(dllimport) 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# else 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# define PERFTOOLS_DLL_DECL 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# endif 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 64a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)// Make the linker NOT to strip functions in this file. 65a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)#if defined(_WIN64) 66a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)#pragma comment(linker, "/INCLUDE:HeapProfilerStart") 67a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)#elif defined(_WIN32) 68a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)#pragma comment(linker, "/INCLUDE:_HeapProfilerStart") 69a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)#endif 70a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/* All this code should be usable from within C apps. */ 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifdef __cplusplus 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)extern "C" { 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/* Start profiling and arrange to write profile data to file names 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * of the form: "prefix.0000", "prefix.0001", ... 78bbcdd45c55eb7c4641ab97aef9889b0fc828e7d3Ben Murdoch * 79bbcdd45c55eb7c4641ab97aef9889b0fc828e7d3Ben Murdoch * If |prefix| is NULL then dumps will not be written to disk. Applications 80bbcdd45c55eb7c4641ab97aef9889b0fc828e7d3Ben Murdoch * can use GetHeapProfile() to get profile data, but HeapProfilerDump() will do 81bbcdd45c55eb7c4641ab97aef9889b0fc828e7d3Ben Murdoch * nothing. 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PERFTOOLS_DLL_DECL void HeapProfilerStart(const char* prefix); 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85bbcdd45c55eb7c4641ab97aef9889b0fc828e7d3Ben Murdoch/* Start profiling with a callback function that returns application-generated 86bbcdd45c55eb7c4641ab97aef9889b0fc828e7d3Ben Murdoch * stacks. Profiles are not written to disk, but may be obtained via 87bbcdd45c55eb7c4641ab97aef9889b0fc828e7d3Ben Murdoch * GetHeapProfile(). The callback: 88bbcdd45c55eb7c4641ab97aef9889b0fc828e7d3Ben Murdoch * 1. May optionally skip the first |skip_count| items on the stack. 89bbcdd45c55eb7c4641ab97aef9889b0fc828e7d3Ben Murdoch * 2. Must provide a |stack| buffer of at least size 32 * sizeof(void*). 90bbcdd45c55eb7c4641ab97aef9889b0fc828e7d3Ben Murdoch * 3. Must return the number of items copied or zero. 91bbcdd45c55eb7c4641ab97aef9889b0fc828e7d3Ben Murdoch */ 92bbcdd45c55eb7c4641ab97aef9889b0fc828e7d3Ben Murdochtypedef int (*StackGeneratorFunction)(int skip_count, void** stack); 93bbcdd45c55eb7c4641ab97aef9889b0fc828e7d3Ben MurdochPERFTOOLS_DLL_DECL void HeapProfilerWithPseudoStackStart( 94bbcdd45c55eb7c4641ab97aef9889b0fc828e7d3Ben Murdoch StackGeneratorFunction callback); 95bbcdd45c55eb7c4641ab97aef9889b0fc828e7d3Ben Murdoch 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/* Returns non-zero if we are currently profiling the heap. (Returns 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * an int rather than a bool so it's usable from C.) This is true 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * between calls to HeapProfilerStart() and HeapProfilerStop(), and 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * also if the program has been run with HEAPPROFILER, or some other 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * way to turn on whole-program profiling. 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int IsHeapProfilerRunning(); 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/* Stop heap profiling. Can be restarted again with HeapProfilerStart(), 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * but the currently accumulated profiling information will be cleared. 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PERFTOOLS_DLL_DECL void HeapProfilerStop(); 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/* Dump a profile now - can be used for dumping at a hopefully 1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * quiescent state in your program, in order to more easily track down 1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * memory leaks. Will include the reason in the logged message 1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PERFTOOLS_DLL_DECL void HeapProfilerDump(const char *reason); 1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/* Generate current heap profiling information. 1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Returns an empty string when heap profiling is not active. 1175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * The returned pointer is a '\0'-terminated string allocated using malloc() 1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * and should be free()-ed as soon as the caller does not need it anymore. 1195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 1205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PERFTOOLS_DLL_DECL char* GetHeapProfile(); 1215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/* Callback function for iterating through all allocated objects. Accepts 1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * pointer to user data passed into IterateAllocatedObjects and pointer 1245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * to the object being visited. 1255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 1265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)typedef void (*AddressVisitor)(void* data, const void* ptr); 1275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/* Iterate over all live allocated objects. For each allocation the 1295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * callback will be invoked with the data argument and allocation pointer. 1305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 1315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PERFTOOLS_DLL_DECL void IterateAllocatedObjects(AddressVisitor callback, 1325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void* data); 1335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifdef __cplusplus 1355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // extern "C" 1365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 1375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif /* BASE_HEAP_PROFILER_H_ */ 139