920e709069
When using clangd or running clang-tidy on headers there are currently many errors. These are noisy in IDEs, make auto fixes impossible, and break features like code completion, refactoring and navigation. This makes source/blender headers work by themselves, which is generally the goal anyway. But #includes and forward declarations were often incomplete. * Add #includes and forward declarations * Add IWYU pragma: export in a few places * Remove some unused #includes (but there are many more) * Tweak ShaderCreateInfo macros to work better with clangd Some types of headers still have errors, these could be fixed or worked around with more investigation. Mostly preprocessor template headers like NOD_static_types.h. Note that that disabling WITH_UNITY_BUILD is required for clangd to work properly, otherwise compile_commands.json does not contain the information for the relevant source files. For more details see the developer docs: https://developer.blender.org/docs/handbook/tooling/clangd/ Pull Request: https://projects.blender.org/blender/blender/pulls/132608
71 lines
2.1 KiB
C++
71 lines
2.1 KiB
C++
/* SPDX-FileCopyrightText: 2024 Blender Authors
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
|
|
#pragma once
|
|
|
|
/** \file
|
|
* \ingroup bli
|
|
*/
|
|
|
|
#include "BLI_function_ref.hh"
|
|
#include "BLI_implicit_sharing_ptr.hh"
|
|
#include "BLI_memory_counter_fwd.hh"
|
|
#include "BLI_set.hh"
|
|
|
|
namespace blender::memory_counter {
|
|
|
|
class MemoryCount {
|
|
public:
|
|
/**
|
|
* Get the total number of counted bytes.
|
|
*
|
|
* \note This is only a rough estimate of the actual used memory. Often, not every little bit of
|
|
* memory is counted, so this is generally a lower bound. The actual memory usage should not be
|
|
* significantly higher though.
|
|
*/
|
|
int64_t total_bytes = 0;
|
|
|
|
Set<WeakImplicitSharingPtr> handled_shared_data;
|
|
|
|
void reset();
|
|
};
|
|
|
|
/**
|
|
* #MemoryCounter helps counting the amount of memory used in cases where data is shared and should
|
|
* not be double-counted. To achieve that, it counts bytes that are uniquely owned separately from
|
|
* those that are shared.
|
|
*/
|
|
class MemoryCounter : NonCopyable, NonMovable {
|
|
private:
|
|
MemoryCount &count_;
|
|
|
|
public:
|
|
MemoryCounter(MemoryCount &count);
|
|
|
|
/**
|
|
* Add bytes that are uniquely owned, i.e. not shared.
|
|
*/
|
|
void add(const int64_t bytes);
|
|
|
|
/**
|
|
* Add (potentially) shared data which should not be counted twice.
|
|
*
|
|
* \param sharing_info: The sharing info that owns the data. If null, the data is assumed to be
|
|
* uniquely owned.
|
|
* \param count_fn: Function to count the amount of memory used by the shared data. This is only
|
|
* called if the shared memory was not counted before. It's a callback, because sometimes
|
|
* counting the amount of used memory can be a bit more involved.
|
|
*/
|
|
void add_shared(const ImplicitSharingInfo *sharing_info,
|
|
const FunctionRef<void(MemoryCounter &shared_memory)> count_fn);
|
|
|
|
/**
|
|
* Same as above, but takes in the number of bytes directly instead of callback. This is easier
|
|
* to use in cases where computing the number of bytes is very cheap.
|
|
*/
|
|
void add_shared(const ImplicitSharingInfo *sharing_info, const int64_t bytes);
|
|
};
|
|
|
|
} // namespace blender::memory_counter
|