Blame view

fs/configfs/item.c 4.65 KB
328970de0   Thomas Gleixner   treewide: Replace...
1
  // SPDX-License-Identifier: GPL-2.0-or-later
fa60ce2cb   Masahiro Yamada   treewide: remove ...
2
  /*
7063fbf22   Joel Becker   [PATCH] configfs:...
3
4
   * item.c - library routines for handling generic config items
   *
7063fbf22   Joel Becker   [PATCH] configfs:...
5
   * Based on kobject:
f6b1fe7c2   Fabian Frederick   fs/configs/item.c...
6
   *	kobject is Copyright (c) 2002-2003 Patrick Mochel
7063fbf22   Joel Becker   [PATCH] configfs:...
7
8
9
   *
   * configfs Copyright (C) 2005 Oracle.  All rights reserved.
   *
982649915   Mauro Carvalho Chehab   docs: filesystems...
10
   * Please see the file Documentation/filesystems/configfs.rst for
7063fbf22   Joel Becker   [PATCH] configfs:...
11
12
13
14
15
16
17
18
19
   * critical information about using the config_item interface.
   */
  
  #include <linux/string.h>
  #include <linux/module.h>
  #include <linux/stat.h>
  #include <linux/slab.h>
  
  #include <linux/configfs.h>
f6b1fe7c2   Fabian Frederick   fs/configs/item.c...
20
  static inline struct config_item *to_item(struct list_head *entry)
7063fbf22   Joel Becker   [PATCH] configfs:...
21
  {
f6b1fe7c2   Fabian Frederick   fs/configs/item.c...
22
  	return container_of(entry, struct config_item, ci_entry);
7063fbf22   Joel Becker   [PATCH] configfs:...
23
24
25
26
27
28
29
30
31
  }
  
  /* Evil kernel */
  static void config_item_release(struct kref *kref);
  
  /**
   *	config_item_init - initialize item.
   *	@item:	item in question.
   */
5286d20c4   Fabian Frederick   configfs: unexpor...
32
  static void config_item_init(struct config_item *item)
7063fbf22   Joel Becker   [PATCH] configfs:...
33
34
35
36
37
38
39
40
  {
  	kref_init(&item->ci_kref);
  	INIT_LIST_HEAD(&item->ci_entry);
  }
  
  /**
   *	config_item_set_name - Set the name of an item
   *	@item:	item.
f6b1fe7c2   Fabian Frederick   fs/configs/item.c...
41
   *	@fmt:  The vsnprintf()'s format string.
7063fbf22   Joel Becker   [PATCH] configfs:...
42
43
44
45
46
   *
   *	If strlen(name) >= CONFIGFS_ITEM_NAME_LEN, then use a
   *	dynamically allocated string that @item->ci_name points to.
   *	Otherwise, use the static @item->ci_namebuf array.
   */
f6b1fe7c2   Fabian Frederick   fs/configs/item.c...
47
  int config_item_set_name(struct config_item *item, const char *fmt, ...)
7063fbf22   Joel Becker   [PATCH] configfs:...
48
  {
7063fbf22   Joel Becker   [PATCH] configfs:...
49
50
51
  	int limit = CONFIGFS_ITEM_NAME_LEN;
  	int need;
  	va_list args;
f6b1fe7c2   Fabian Frederick   fs/configs/item.c...
52
  	char *name;
7063fbf22   Joel Becker   [PATCH] configfs:...
53
54
55
56
  
  	/*
  	 * First, try the static array
  	 */
f6b1fe7c2   Fabian Frederick   fs/configs/item.c...
57
58
  	va_start(args, fmt);
  	need = vsnprintf(item->ci_namebuf, limit, fmt, args);
7063fbf22   Joel Becker   [PATCH] configfs:...
59
60
61
62
  	va_end(args);
  	if (need < limit)
  		name = item->ci_namebuf;
  	else {
f6b1fe7c2   Fabian Frederick   fs/configs/item.c...
63
  		va_start(args, fmt);
707c62352   Bart Van Assche   configfs: use kva...
64
  		name = kvasprintf(GFP_KERNEL, fmt, args);
7063fbf22   Joel Becker   [PATCH] configfs:...
65
  		va_end(args);
707c62352   Bart Van Assche   configfs: use kva...
66
67
  		if (!name)
  			return -EFAULT;
7063fbf22   Joel Becker   [PATCH] configfs:...
68
69
70
71
72
73
74
75
  	}
  
  	/* Free the old name, if necessary. */
  	if (item->ci_name && item->ci_name != item->ci_namebuf)
  		kfree(item->ci_name);
  
  	/* Now, set the new name */
  	item->ci_name = name;
707c62352   Bart Van Assche   configfs: use kva...
76
  	return 0;
7063fbf22   Joel Becker   [PATCH] configfs:...
77
  }
7063fbf22   Joel Becker   [PATCH] configfs:...
78
79
80
81
  EXPORT_SYMBOL(config_item_set_name);
  
  void config_item_init_type_name(struct config_item *item,
  				const char *name,
aa293583f   Bhumika Goyal   configfs: make ci...
82
  				const struct config_item_type *type)
7063fbf22   Joel Becker   [PATCH] configfs:...
83
  {
3958b7926   Nicolas Iooss   configfs: fix ker...
84
  	config_item_set_name(item, "%s", name);
7063fbf22   Joel Becker   [PATCH] configfs:...
85
86
87
88
89
90
  	item->ci_type = type;
  	config_item_init(item);
  }
  EXPORT_SYMBOL(config_item_init_type_name);
  
  void config_group_init_type_name(struct config_group *group, const char *name,
aa293583f   Bhumika Goyal   configfs: make ci...
91
  			 const struct config_item_type *type)
7063fbf22   Joel Becker   [PATCH] configfs:...
92
  {
3958b7926   Nicolas Iooss   configfs: fix ker...
93
  	config_item_set_name(&group->cg_item, "%s", name);
7063fbf22   Joel Becker   [PATCH] configfs:...
94
95
96
97
  	group->cg_item.ci_type = type;
  	config_group_init(group);
  }
  EXPORT_SYMBOL(config_group_init_type_name);
f6b1fe7c2   Fabian Frederick   fs/configs/item.c...
98
  struct config_item *config_item_get(struct config_item *item)
7063fbf22   Joel Becker   [PATCH] configfs:...
99
100
101
102
103
  {
  	if (item)
  		kref_get(&item->ci_kref);
  	return item;
  }
f6b1fe7c2   Fabian Frederick   fs/configs/item.c...
104
  EXPORT_SYMBOL(config_item_get);
7063fbf22   Joel Becker   [PATCH] configfs:...
105

19e72d3ab   Bart Van Assche   configfs: Introdu...
106
107
108
109
110
111
112
  struct config_item *config_item_get_unless_zero(struct config_item *item)
  {
  	if (item && kref_get_unless_zero(&item->ci_kref))
  		return item;
  	return NULL;
  }
  EXPORT_SYMBOL(config_item_get_unless_zero);
f6b1fe7c2   Fabian Frederick   fs/configs/item.c...
113
  static void config_item_cleanup(struct config_item *item)
7063fbf22   Joel Becker   [PATCH] configfs:...
114
  {
aa293583f   Bhumika Goyal   configfs: make ci...
115
  	const struct config_item_type *t = item->ci_type;
f6b1fe7c2   Fabian Frederick   fs/configs/item.c...
116
117
  	struct config_group *s = item->ci_group;
  	struct config_item *parent = item->ci_parent;
7063fbf22   Joel Becker   [PATCH] configfs:...
118

f6b1fe7c2   Fabian Frederick   fs/configs/item.c...
119
120
  	pr_debug("config_item %s: cleaning up
  ", config_item_name(item));
7063fbf22   Joel Becker   [PATCH] configfs:...
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
  	if (item->ci_name != item->ci_namebuf)
  		kfree(item->ci_name);
  	item->ci_name = NULL;
  	if (t && t->ct_item_ops && t->ct_item_ops->release)
  		t->ct_item_ops->release(item);
  	if (s)
  		config_group_put(s);
  	if (parent)
  		config_item_put(parent);
  }
  
  static void config_item_release(struct kref *kref)
  {
  	config_item_cleanup(container_of(kref, struct config_item, ci_kref));
  }
  
  /**
   *	config_item_put - decrement refcount for item.
   *	@item:	item.
   *
   *	Decrement the refcount, and if 0, call config_item_cleanup().
   */
f6b1fe7c2   Fabian Frederick   fs/configs/item.c...
143
  void config_item_put(struct config_item *item)
7063fbf22   Joel Becker   [PATCH] configfs:...
144
145
146
147
  {
  	if (item)
  		kref_put(&item->ci_kref, config_item_release);
  }
f6b1fe7c2   Fabian Frederick   fs/configs/item.c...
148
  EXPORT_SYMBOL(config_item_put);
7063fbf22   Joel Becker   [PATCH] configfs:...
149

7063fbf22   Joel Becker   [PATCH] configfs:...
150
151
  /**
   *	config_group_init - initialize a group for use
f6b1fe7c2   Fabian Frederick   fs/configs/item.c...
152
   *	@group:	config_group
7063fbf22   Joel Becker   [PATCH] configfs:...
153
   */
7063fbf22   Joel Becker   [PATCH] configfs:...
154
155
156
157
  void config_group_init(struct config_group *group)
  {
  	config_item_init(&group->cg_item);
  	INIT_LIST_HEAD(&group->cg_children);
1ae1602de   Christoph Hellwig   configfs: switch ...
158
  	INIT_LIST_HEAD(&group->default_groups);
7063fbf22   Joel Becker   [PATCH] configfs:...
159
  }
f6b1fe7c2   Fabian Frederick   fs/configs/item.c...
160
  EXPORT_SYMBOL(config_group_init);
7063fbf22   Joel Becker   [PATCH] configfs:...
161

7063fbf22   Joel Becker   [PATCH] configfs:...
162
  /**
3fe6c5ce1   Satyam Sharma   [PATCH] configfs+...
163
   *	config_group_find_item - search for item in group.
7063fbf22   Joel Becker   [PATCH] configfs:...
164
165
166
   *	@group:	group we're looking in.
   *	@name:	item's name.
   *
3fe6c5ce1   Satyam Sharma   [PATCH] configfs+...
167
168
169
   *	Iterate over @group->cg_list, looking for a matching config_item.
   *	If matching item is found take a reference and return the item.
   *	Caller must have locked group via @group->cg_subsys->su_mtx.
7063fbf22   Joel Becker   [PATCH] configfs:...
170
   */
3fe6c5ce1   Satyam Sharma   [PATCH] configfs+...
171
172
  struct config_item *config_group_find_item(struct config_group *group,
  					   const char *name)
7063fbf22   Joel Becker   [PATCH] configfs:...
173
  {
f6b1fe7c2   Fabian Frederick   fs/configs/item.c...
174
175
  	struct list_head *entry;
  	struct config_item *ret = NULL;
7063fbf22   Joel Becker   [PATCH] configfs:...
176

f6b1fe7c2   Fabian Frederick   fs/configs/item.c...
177
178
  	list_for_each(entry, &group->cg_children) {
  		struct config_item *item = to_item(entry);
7063fbf22   Joel Becker   [PATCH] configfs:...
179
  		if (config_item_name(item) &&
3fe6c5ce1   Satyam Sharma   [PATCH] configfs+...
180
  		    !strcmp(config_item_name(item), name)) {
7063fbf22   Joel Becker   [PATCH] configfs:...
181
182
183
184
185
186
  			ret = config_item_get(item);
  			break;
  		}
  	}
  	return ret;
  }
3fe6c5ce1   Satyam Sharma   [PATCH] configfs+...
187
  EXPORT_SYMBOL(config_group_find_item);