Files
test/source/blender/blenlib/BLI_linklist_lockfree.h
Campbell Barton e955c94ed3 License Headers: Set copyright to "Blender Authors", add AUTHORS
Listing the "Blender Foundation" as copyright holder implied the Blender
Foundation holds copyright to files which may include work from many
developers.

While keeping copyright on headers makes sense for isolated libraries,
Blender's own code may be refactored or moved between files in a way
that makes the per file copyright holders less meaningful.

Copyright references to the "Blender Foundation" have been replaced with
"Blender Authors", with the exception of `./extern/` since these this
contains libraries which are more isolated, any changed to license
headers there can be handled on a case-by-case basis.

Some directories in `./intern/` have also been excluded:

- `./intern/cycles/` it's own `AUTHORS` file is planned.
- `./intern/opensubdiv/`.

An "AUTHORS" file has been added, using the chromium projects authors
file as a template.

Design task: #110784

Ref !110783.
2023-08-16 00:20:26 +10:00

61 lines
1.8 KiB
C

/* SPDX-FileCopyrightText: 2018 Blender Authors
*
* SPDX-License-Identifier: GPL-2.0-or-later */
#pragma once
/** \file
* \ingroup bli
*/
#ifdef __cplusplus
extern "C" {
#endif
typedef struct LockfreeLinkNode {
struct LockfreeLinkNode *next;
/* NOTE: "Subclass" this structure to add custom-defined data. */
} LockfreeLinkNode;
typedef struct LockfreeLinkList {
/* We keep a dummy node at the beginning of the list all the time.
* This allows us to make sure head and tail pointers are always
* valid, and saves from annoying exception cases in insert().
*/
LockfreeLinkNode dummy_node;
/* NOTE: This fields might point to a dummy node. */
LockfreeLinkNode *head, *tail;
} LockfreeLinkList;
typedef void (*LockfreeeLinkNodeFreeFP)(void *link);
/* ************************************************************************** */
/* NOTE: These functions are NOT safe for use from threads. */
/* NOTE: !!! I REPEAT: DO NOT USE THEM WITHOUT EXTERNAL LOCK !!! */
/** Make list ready for lock-free access. */
void BLI_linklist_lockfree_init(LockfreeLinkList *list);
/** Completely free the whole list, it is NOT re-usable after this. */
void BLI_linklist_lockfree_free(LockfreeLinkList *list, LockfreeeLinkNodeFreeFP free_func);
/**
* Remove all the elements from the list, keep it usable for further inserts.
*/
void BLI_linklist_lockfree_clear(LockfreeLinkList *list, LockfreeeLinkNodeFreeFP free_func);
/**
* Begin iteration of lock-free linked list, starting with a
* first user=defined node. Will ignore the dummy node.
*/
LockfreeLinkNode *BLI_linklist_lockfree_begin(LockfreeLinkList *list);
/* ************************************************************************** */
/* NOTE: These functions are safe for use from threads. */
void BLI_linklist_lockfree_insert(LockfreeLinkList *list, LockfreeLinkNode *node);
#ifdef __cplusplus
}
#endif