Files
test2/source/blender/blenlib/intern/BLI_mempool_private.h
Brecht Van Lommel 920e709069 Refactor: Make header files more clangd and clang-tidy friendly
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
2025-01-07 12:39:13 +01:00

53 lines
1.7 KiB
C

/* SPDX-FileCopyrightText: 2008 Blender Authors
*
* SPDX-License-Identifier: GPL-2.0-or-later */
#pragma once
/** \file
* \ingroup bli
*
* Shared logic for #BLI_task_parallel_mempool to create a threaded iterator,
* without exposing the these functions publicly.
*/
#include "BLI_compiler_attrs.h"
#include "BLI_mempool.h"
#include "BLI_task.h"
typedef struct BLI_mempool_threadsafe_iter {
BLI_mempool_iter iter;
struct BLI_mempool_chunk **curchunk_threaded_shared;
} BLI_mempool_threadsafe_iter;
typedef struct ParallelMempoolTaskData {
BLI_mempool_threadsafe_iter ts_iter;
TaskParallelTLS tls;
} ParallelMempoolTaskData;
/**
* Initialize an array of mempool iterators, #BLI_MEMPOOL_ALLOW_ITER flag must be set.
*
* This is used in threaded code, to generate as much iterators as needed
* (each task should have its own),
* such that each iterator goes over its own single chunk,
* and only getting the next chunk to iterate over has to be
* protected against concurrency (which can be done in a lock-less way).
*
* To be used when creating a task for each single item in the pool is totally overkill.
*
* See #BLI_task_parallel_mempool implementation for detailed usage example.
*/
ParallelMempoolTaskData *mempool_iter_threadsafe_create(BLI_mempool *pool,
size_t iter_num) ATTR_WARN_UNUSED_RESULT
ATTR_NONNULL();
void mempool_iter_threadsafe_destroy(ParallelMempoolTaskData *iter_arr) ATTR_NONNULL();
/**
* A version of #BLI_mempool_iterstep that uses
* #BLI_mempool_threadsafe_iter.curchunk_threaded_shared for threaded iteration support.
* (threaded section noted in comments).
*/
void *mempool_iter_threadsafe_step(BLI_mempool_threadsafe_iter *ts_iter);