RepoMirrors
/
gperftools
mirror of https://github.com/gperftools/gperftools
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

replace heap-checker "bcad" stuff 

The comments in this file stated that it has to be linked in specific
order to get initialized early enough. But our initialization is
de-facto via initial malloc hook. And to deal with latest-possible
destruction, we use more convenient destructor function
attribute, and make things simpler.
This commit is contained in:
Aliaksey Kandratsenka 2024-04-06 15:05:57 -04:00
parent 33cda2c9b3
commit 29b6eff4c7
4 changed files with 9 additions and 109 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CMakeLists.txt
View File

@ -757,8 +757,7 @@ if(GPERFTOOLS_BUILD_HEAP_CHECKER OR GPERFTOOLS_BUILD_HEAP_PROFILER)
if(GPERFTOOLS_BUILD_HEAP_CHECKER) if(GPERFTOOLS_BUILD_HEAP_CHECKER)
set(HEAP_CHECKER_SRC src/base/linuxthreads.cc set(HEAP_CHECKER_SRC src/base/linuxthreads.cc
src/heap-checker.cc src/heap-checker.cc)
src/heap-checker-bcad.cc)
set(HEAP_CHECKER_DEFINE ) set(HEAP_CHECKER_DEFINE )
else() else()
set(HEAP_CHECKER_SRC ) set(HEAP_CHECKER_SRC )

7
Makefile.am
View File

@ -624,13 +624,8 @@ endif !BUILD_EMERGENCY_MALLOC
### Making the library ### Making the library
if WITH_HEAP_CHECKER if WITH_HEAP_CHECKER
# heap-checker-bcad is last, in hopes its global ctor will run first.
# (Note this is added to libtcmalloc.la, not libtcmalloc_internal.la,
# but that's ok; the internal/external distinction is only useful for
# cygwin, and cygwin doesn't use HEAP_CHECKER anyway.)
HEAP_CHECKER_SOURCES = src/base/linuxthreads.cc \ HEAP_CHECKER_SOURCES = src/base/linuxthreads.cc \
src/heap-checker.cc \ src/heap-checker.cc
src/heap-checker-bcad.cc
MAYBE_NO_HEAP_CHECK = MAYBE_NO_HEAP_CHECK =
else !WITH_HEAP_CHECKER else !WITH_HEAP_CHECKER
HEAP_CHECKER_SOURCES = HEAP_CHECKER_SOURCES =

98
src/heap-checker-bcad.cc
View File

@ -1,98 +0,0 @@
// -*- Mode: C++; c-basic-offset: 2; indent-tabs-mode: nil -*-
// Copyright (c) 2005, Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
// * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// ---
// All Rights Reserved.
//
// Author: Maxim Lifantsev
//
// A file to ensure that components of heap leak checker run before
// all global object constructors and after all global object
// destructors.
//
// This file must be the last library any binary links against.
// Otherwise, the heap checker may not be able to run early enough to
// catalog all the global objects in your program. If this happens,
// and later in the program you allocate memory and have one of these
// "uncataloged" global objects point to it, the heap checker will
// consider that allocation to be a leak, even though it's not (since
// the allocated object is reachable from global data and hence "live").
#include <stdlib.h> // for abort()
#include <gperftools/malloc_extension.h>
// A dummy variable to refer from heap-checker.cc. This is to make
// sure this file is not optimized out by the linker.
bool heap_leak_checker_bcad_variable;
extern void HeapLeakChecker_AfterDestructors(); // in heap-checker.cc
// A helper class to ensure that some components of heap leak checking
// can happen before construction and after destruction
// of all global/static objects.
class HeapLeakCheckerGlobalPrePost {
public:
HeapLeakCheckerGlobalPrePost() {
if (count_ == 0) {
// The 'new int' will ensure that we have run an initial malloc
// hook, which will set up the heap checker via
// MallocHook_InitAtFirstAllocation_HeapLeakChecker. See malloc_hook.cc.
// This is done in this roundabout fashion in order to avoid self-deadlock
// if we directly called HeapLeakChecker_BeforeConstructors here.
//
// We use explicit global operator new/delete functions since
// plain 'naked' delete new int modern compilers optimize out to
// nothing. And apparently calling those global new/delete
// functions is assumed by compilers to be 'for effect' as well.
(operator delete)((operator new)(4));
// This needs to be called before the first allocation of an STL
// object, but after libc is done setting up threads (because it
// calls setenv, which requires a thread-aware errno). By
// putting it here, we hope it's the first bit of code executed
// after the libc global-constructor code.
MallocExtension::Initialize();
}
++count_;
}
~HeapLeakCheckerGlobalPrePost() {
if (count_ <= 0) abort();
--count_;
if (count_ == 0) HeapLeakChecker_AfterDestructors();
}
private:
// Counter of constructions/destructions of objects of this class
// (just in case there are more than one of them).
static int count_;
};
int HeapLeakCheckerGlobalPrePost::count_ = 0;
// The early-construction/late-destruction global object.
static const HeapLeakCheckerGlobalPrePost heap_leak_checker_global_pre_post;

10
src/heap-checker.cc
View File

@ -2244,8 +2244,6 @@ void HeapLeakChecker::TurnItselfOffLocked() {
RAW_CHECK(!heap_checker_on, ""); RAW_CHECK(!heap_checker_on, "");
} }
extern bool heap_leak_checker_bcad_variable; // in heap-checker-bcad.cc
static bool has_called_before_constructors = false; static bool has_called_before_constructors = false;
// TODO(maxim): inline this function with // TODO(maxim): inline this function with
@ -2260,7 +2258,6 @@ void HeapLeakChecker_BeforeConstructors() {
has_called_before_constructors = true; has_called_before_constructors = true;
heap_checker_pid = getpid(); // set it always heap_checker_pid = getpid(); // set it always
heap_leak_checker_bcad_variable = true;
// just to reference it, so that heap-checker-bcad.o is linked in // just to reference it, so that heap-checker-bcad.o is linked in
// This function can be called *very* early, before the normal // This function can be called *very* early, before the normal
@ -2305,6 +2302,13 @@ extern "C" int MallocHook_InitAtFirstAllocation_HeapLeakChecker() {
} }
// This function is executed after all global object destructors run. // This function is executed after all global object destructors run.
//
// Note, heap checker is Linux-only. Which implies we're dealing with
// gcc-compatible compiler, so we can do __attribute__ thingy. In
// practice destructor functions end up being called after c++
// destructors (those are set up via __cxa_atexit thingy), so we get
// the right ordering.
__attribute__((destructor))
void HeapLeakChecker_AfterDestructors() { void HeapLeakChecker_AfterDestructors() {
{ SpinLockHolder l(&heap_checker_lock); { SpinLockHolder l(&heap_checker_lock);
// can get here (via forks?) with other pids // can get here (via forks?) with other pids