leak_detector.cc

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2020-2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#include <any>
#include <cstdio> /* Needed for `printf` on WIN32/APPLE. */
#include <cstdlib>
#include <mutex>
#include <vector>
 
#include "MEM_guardedalloc.h"
#include "mallocn_intern.hh"
 
bool leak_detector_has_run = false;
char free_after_leak_detection_message[] =
    "Freeing memory after the leak detector has run. This can happen when using "
    "static variables in C++ that are defined outside of functions. To fix this "
    "error, use the 'construct on first use' idiom.";
 
namespace {
 
bool fail_on_memleak = false;
bool ignore_memleak = false;
 
class MemLeakPrinter {
 public:
  ~MemLeakPrinter()
  {
    if (ignore_memleak) {
      return;
    }
    leak_detector_has_run = true;
    const uint leaked_blocks = MEM_get_memory_blocks_in_use();
    if (leaked_blocks == 0) {
      return;
    }
    const size_t mem_in_use = MEM_get_memory_in_use();
    printf("Error: Not freed memory blocks: %u, total unfreed memory %f MB\n",
           leaked_blocks,
           double(mem_in_use) / 1024 / 1024);
    MEM_printmemlist();
 
    /* In guarded implementation, the fact that all allocated memory blocks are stored in the
     * static `membase` listbase is enough for LSAN to not detect them as leaks. Clearing it solves
     * that issue. */
    mem_clearmemlist();
 
    if (fail_on_memleak) {
      /* There are many other ways to change the exit code to failure here:
       * - Make the destructor `noexcept(false)` and throw an exception.
       * - Call exit(EXIT_FAILURE).
       * - Call terminate().
       */
      abort();
    }
  }
};
}  // namespace
 
void MEM_init_memleak_detection()
{
  /* Calling this ensures that the memory usage counters outlive the memory leak detection. */
  memory_usage_init();
 
  /* Ensure that the static memleak data storage is initialized before the #MemLeakPrinter one, so
   * that it outlives the memory leak detection. */
  std::any any_data = std::make_any<int>(0);
  mem_guarded::internal::add_memleak_data(any_data);
 
  static MemLeakPrinter printer;
}
 
void MEM_use_memleak_detection(bool enabled)
{
  ignore_memleak = !enabled;
}
 
void MEM_enable_fail_on_memleak()
{
  fail_on_memleak = true;
}
 
void mem_guarded::internal::add_memleak_data(std::any data)
{
  static std::mutex mutex;
  static std::vector<std::any> data_vec;
  std::lock_guard lock{mutex};
  data_vec.push_back(std::move(data));
}