blob: b0f238f20dbb278cf506223d61edad7387d205d9 [file] [log] [blame]
Thomas Gleixnere311edb2019-06-03 07:45:00 +02001/* SPDX-License-Identifier: GPL-2.0-only */
mochel@digitalimplant.org9a19fea2005-03-21 11:45:16 -08002/*
3 * klist.h - Some generic list helpers, extending struct list_head a bit.
4 *
5 * Implementations are found in lib/klist.c
6 *
mochel@digitalimplant.org9a19fea2005-03-21 11:45:16 -08007 * Copyright (C) 2005 Patrick Mochel
mochel@digitalimplant.org9a19fea2005-03-21 11:45:16 -08008 */
9
James Bottomleyd856f1e32005-08-19 09:14:01 -040010#ifndef _LINUX_KLIST_H
11#define _LINUX_KLIST_H
12
mochel@digitalimplant.org9a19fea2005-03-21 11:45:16 -080013#include <linux/spinlock.h>
mochel@digitalimplant.org9a19fea2005-03-21 11:45:16 -080014#include <linux/kref.h>
15#include <linux/list.h>
16
James Bottomley34bb61f2005-09-06 16:56:51 -070017struct klist_node;
mochel@digitalimplant.org9a19fea2005-03-21 11:45:16 -080018struct klist {
19 spinlock_t k_lock;
20 struct list_head k_list;
James Bottomley34bb61f2005-09-06 16:56:51 -070021 void (*get)(struct klist_node *);
22 void (*put)(struct klist_node *);
David Miller795abaf2011-02-13 16:37:07 -080023} __attribute__ ((aligned (sizeof(void *))));
mochel@digitalimplant.org9a19fea2005-03-21 11:45:16 -080024
Tejun Heo1da43e4a2008-04-26 03:16:04 +090025#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)
mochel@digitalimplant.org9a19fea2005-03-21 11:45:16 -080033
Greg Kroah-Hartmanc3bb7fad2008-04-30 16:43:45 -070034extern void klist_init(struct klist *k, void (*get)(struct klist_node *),
James Bottomley34bb61f2005-09-06 16:56:51 -070035 void (*put)(struct klist_node *));
mochel@digitalimplant.org9a19fea2005-03-21 11:45:16 -080036
37struct klist_node {
Tejun Heoa1ed5b02008-08-25 19:50:16 +020038 void *n_klist; /* never access directly */
mochel@digitalimplant.org9a19fea2005-03-21 11:45:16 -080039 struct list_head n_node;
40 struct kref n_ref;
mochel@digitalimplant.org9a19fea2005-03-21 11:45:16 -080041};
42
Greg Kroah-Hartmanc3bb7fad2008-04-30 16:43:45 -070043extern void klist_add_tail(struct klist_node *n, struct klist *k);
44extern void klist_add_head(struct klist_node *n, struct klist *k);
Ken Helias0f9859c2014-08-06 16:09:18 -070045extern void klist_add_behind(struct klist_node *n, struct klist_node *pos);
Tejun Heo93dd4002008-04-22 18:58:46 +090046extern void klist_add_before(struct klist_node *n, struct klist_node *pos);
mochel@digitalimplant.org9a19fea2005-03-21 11:45:16 -080047
Greg Kroah-Hartmanc3bb7fad2008-04-30 16:43:45 -070048extern void klist_del(struct klist_node *n);
49extern void klist_remove(struct klist_node *n);
mochel@digitalimplant.org9a19fea2005-03-21 11:45:16 -080050
Greg Kroah-Hartmanc3bb7fad2008-04-30 16:43:45 -070051extern int klist_node_attached(struct klist_node *n);
mochel@digitalimplant.org8b0c250b2005-03-24 12:58:57 -080052
mochel@digitalimplant.org9a19fea2005-03-21 11:45:16 -080053
54struct klist_iter {
Greg Kroah-Hartmanc3bb7fad2008-04-30 16:43:45 -070055 struct klist *i_klist;
Greg Kroah-Hartmanc3bb7fad2008-04-30 16:43:45 -070056 struct klist_node *i_cur;
mochel@digitalimplant.org9a19fea2005-03-21 11:45:16 -080057};
58
59
Greg Kroah-Hartmanc3bb7fad2008-04-30 16:43:45 -070060extern 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);
Andy Shevchenko2e0fed72015-07-27 18:03:59 +030064extern struct klist_node *klist_prev(struct klist_iter *i);
Greg Kroah-Hartmanc3bb7fad2008-04-30 16:43:45 -070065extern struct klist_node *klist_next(struct klist_iter *i);
mochel@digitalimplant.org9a19fea2005-03-21 11:45:16 -080066
James Bottomleyd856f1e32005-08-19 09:14:01 -040067#endif