Cleanup: comment line length (blenlib)
[blender.git] / source / blender / blenlib / BLI_linklist_lockfree.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2018 Blender Foundation.
19  * All rights reserved.
20  *
21  * Contributor(s): Sergey Sharybin.
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 #ifndef __BLI_LINKLIST_LOCKFREE_H__
27 #define __BLI_LINKLIST_LOCKFREE_H__
28
29 /** \file BLI_linklist_lockfree.h
30  *  \ingroup bli
31  */
32
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36
37 typedef struct LockfreeLinkNode {
38         struct LockfreeLinkNode *next;
39         /* NOTE: "Subclass" this structure to add custom-defined data. */
40 } LockfreeLinkNode;
41
42 typedef struct LockfreeLinkList {
43         /* We keep a dummy node at the beginning of the list all the time.
44          * This allows us to make sure head and tail pointers are always
45          * valid, and saves from annoying exception cases in insert().
46          */
47         LockfreeLinkNode dummy_node;
48         /* NOTE: This fields might point to a dummy node. */
49         LockfreeLinkNode *head, *tail;
50 } LockfreeLinkList;
51
52 typedef void (*LockfreeeLinkNodeFreeFP)(void *link);
53
54 /* ************************************************************************** */
55 /* NOTE: These functions are NOT safe for use from threads. */
56 /* NOTE: !!! I REPEAT: DO NOT USE THEM WITHOUT EXTERNAL LOCK !!! */
57
58 /* Make list ready for lock-free access. */
59 void BLI_linklist_lockfree_init(LockfreeLinkList *list);
60
61 /* Completely free the whole list, it is NOT re-usable after this. */
62 void BLI_linklist_lockfree_free(LockfreeLinkList *list,
63                                 LockfreeeLinkNodeFreeFP free_func);
64
65 /* Remove all the elements from the list, keep it usable for further
66  * inserts.
67  */
68 void BLI_linklist_lockfree_clear(LockfreeLinkList *list,
69                                  LockfreeeLinkNodeFreeFP free_func);
70
71
72 /* Begin iteration of lock-free linked list, starting with a
73  * first user=defined node. Will ignore the dummy node.
74  */
75 LockfreeLinkNode *BLI_linklist_lockfree_begin(LockfreeLinkList *list);
76
77
78 /* ************************************************************************** */
79 /* NOTE: These functions are safe for use from threads. */
80
81 void BLI_linklist_lockfree_insert(LockfreeLinkList *list,
82                                   LockfreeLinkNode *node);
83
84 #ifdef __cplusplus
85 }
86 #endif
87
88 #endif  /* __BLI_LINKLIST_H__ */