Merge tag 'mm-hotfixes-stable-2023-05-03-16-27' of git://git.kernel.org/pub/scm/linux...
[linux-block.git] / include / linux / klist.h
CommitLineData
e311edbc 1/* SPDX-License-Identifier: GPL-2.0-only */
9a19fea4 2/*
3 * klist.h - Some generic list helpers, extending struct list_head a bit.
4 *
5 * Implementations are found in lib/klist.c
6 *
9a19fea4 7 * Copyright (C) 2005 Patrick Mochel
9a19fea4 8 */
9
d856f1e3
JB
10#ifndef _LINUX_KLIST_H
11#define _LINUX_KLIST_H
12
9a19fea4 13#include <linux/spinlock.h>
9a19fea4 14#include <linux/kref.h>
15#include <linux/list.h>
16
34bb61f9 17struct klist_node;
9a19fea4 18struct klist {
19 spinlock_t k_lock;
20 struct list_head k_list;
34bb61f9
JB
21 void (*get)(struct klist_node *);
22 void (*put)(struct klist_node *);
795abaf1 23} __attribute__ ((aligned (sizeof(void *))));
9a19fea4 24
1da43e4a
TH
25#define KLIST_INIT(_name, _get, _put) \
26 { .k_lock = __SPIN_LOCK_UNLOCKED(_name.k_lock), \
27 .k_list = LIST_HEAD_INIT(_name.k_list), \
28 .get = _get, \
29 .put = _put, }
30
31#define DEFINE_KLIST(_name, _get, _put) \
32 struct klist _name = KLIST_INIT(_name, _get, _put)
9a19fea4 33
c3bb7fad 34extern void klist_init(struct klist *k, void (*get)(struct klist_node *),
34bb61f9 35 void (*put)(struct klist_node *));
9a19fea4 36
37struct klist_node {
a1ed5b0c 38 void *n_klist; /* never access directly */
9a19fea4 39 struct list_head n_node;
40 struct kref n_ref;
9a19fea4 41};
42
c3bb7fad
GKH
43extern void klist_add_tail(struct klist_node *n, struct klist *k);
44extern void klist_add_head(struct klist_node *n, struct klist *k);
0f9859ca 45extern void klist_add_behind(struct klist_node *n, struct klist_node *pos);
93dd4001 46extern void klist_add_before(struct klist_node *n, struct klist_node *pos);
9a19fea4 47
c3bb7fad
GKH
48extern void klist_del(struct klist_node *n);
49extern void klist_remove(struct klist_node *n);
9a19fea4 50
c3bb7fad 51extern int klist_node_attached(struct klist_node *n);
8b0c250b 52
9a19fea4 53
54struct klist_iter {
c3bb7fad 55 struct klist *i_klist;
c3bb7fad 56 struct klist_node *i_cur;
9a19fea4 57};
58
59
c3bb7fad
GKH
60extern void klist_iter_init(struct klist *k, struct klist_iter *i);
61extern void klist_iter_init_node(struct klist *k, struct klist_iter *i,
62 struct klist_node *n);
63extern void klist_iter_exit(struct klist_iter *i);
2e0fed7f 64extern struct klist_node *klist_prev(struct klist_iter *i);
c3bb7fad 65extern struct klist_node *klist_next(struct klist_iter *i);
9a19fea4 66
d856f1e3 67#endif