folly/folly/memory/SanitizeLeak.cpp

/*
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#include <folly/memory/SanitizeLeak.h>

#include <mutex>
#include <numeric>
#include <shared_mutex>
#include <unordered_map>

#include <folly/lang/Extern.h>

//  Leak Sanitizer interface may be found at:
//    https://github.com/llvm/llvm-project/blob/main/compiler-rt/include/sanitizer/lsan_interface.h
extern "C" void __lsan_ignore_object(void const*);
extern "C" void __lsan_register_root_region(void const*, std::size_t);
extern "C" void __lsan_unregister_root_region(void const*, std::size_t);

namespace … // namespace

namespace folly {

namespace detail {

FOLLY_STORAGE_CONSTEXPR lsan_ignore_object_t* const //
    lsan_ignore_object_v = …;
FOLLY_STORAGE_CONSTEXPR lsan_register_root_region_t* const //
    lsan_register_root_region_v = …;
FOLLY_STORAGE_CONSTEXPR lsan_unregister_root_region_t* const //
    lsan_unregister_root_region_v = …;

namespace {

struct fake_mutex { … };

// some hardware targets may not have mutexes
#if __cpp_lib_shared_mutex >= 201505L
mutex_type;
#else
using mutex_type = fake_mutex;
#endif

struct LeakedPtrs { … };

} // namespace

void annotate_object_leaked_impl(void const* ptr) { … }

void annotate_object_collected_impl(void const* ptr) { … }

size_t annotate_object_count_leaked_uncollected_impl() { … }

} // namespace detail
} // namespace folly