Blame view

fs/configfs/item.c 5.43 KB
7063fbf22   Joel Becker   [PATCH] configfs:...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
  /* -*- mode: c; c-basic-offset: 8; -*-
   * vim: noexpandtab sw=8 ts=8 sts=0:
   *
   * item.c - library routines for handling generic config items
   *
   * This program is free software; you can redistribute it and/or
   * modify it under the terms of the GNU General Public
   * License as published by the Free Software Foundation; either
   * version 2 of the License, or (at your option) any later version.
   *
   * This program is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   * General Public License for more details.
   *
   * You should have received a copy of the GNU General Public
   * License along with this program; if not, write to the
   * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
   * Boston, MA 021110-1307, USA.
   *
   * Based on kobject:
f6b1fe7c2   Fabian Frederick   fs/configs/item.c...
22
   *	kobject is Copyright (c) 2002-2003 Patrick Mochel
7063fbf22   Joel Becker   [PATCH] configfs:...
23
24
25
   *
   * configfs Copyright (C) 2005 Oracle.  All rights reserved.
   *
395cf9691   Paul Bolle   doc: fix broken r...
26
   * Please see the file Documentation/filesystems/configfs/configfs.txt for
7063fbf22   Joel Becker   [PATCH] configfs:...
27
28
29
30
31
32
33
34
35
   * 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...
36
  static inline struct config_item *to_item(struct list_head *entry)
7063fbf22   Joel Becker   [PATCH] configfs:...
37
  {
f6b1fe7c2   Fabian Frederick   fs/configs/item.c...
38
  	return container_of(entry, struct config_item, ci_entry);
7063fbf22   Joel Becker   [PATCH] configfs:...
39
40
41
42
43
44
45
46
47
  }
  
  /* Evil kernel */
  static void config_item_release(struct kref *kref);
  
  /**
   *	config_item_init - initialize item.
   *	@item:	item in question.
   */
5286d20c4   Fabian Frederick   configfs: unexpor...
48
  static void config_item_init(struct config_item *item)
7063fbf22   Joel Becker   [PATCH] configfs:...
49
50
51
52
53
54
55
56
  {
  	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...
57
   *	@fmt:  The vsnprintf()'s format string.
7063fbf22   Joel Becker   [PATCH] configfs:...
58
59
60
61
62
   *
   *	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...
63
  int config_item_set_name(struct config_item *item, const char *fmt, ...)
7063fbf22   Joel Becker   [PATCH] configfs:...
64
65
66
67
68
  {
  	int error = 0;
  	int limit = CONFIGFS_ITEM_NAME_LEN;
  	int need;
  	va_list args;
f6b1fe7c2   Fabian Frederick   fs/configs/item.c...
69
  	char *name;
7063fbf22   Joel Becker   [PATCH] configfs:...
70
71
72
73
  
  	/*
  	 * First, try the static array
  	 */
f6b1fe7c2   Fabian Frederick   fs/configs/item.c...
74
75
  	va_start(args, fmt);
  	need = vsnprintf(item->ci_namebuf, limit, fmt, args);
7063fbf22   Joel Becker   [PATCH] configfs:...
76
77
78
79
80
81
82
83
  	va_end(args);
  	if (need < limit)
  		name = item->ci_namebuf;
  	else {
  		/*
  		 * Need more space? Allocate it and try again
  		 */
  		limit = need + 1;
f6b1fe7c2   Fabian Frederick   fs/configs/item.c...
84
  		name = kmalloc(limit, GFP_KERNEL);
7063fbf22   Joel Becker   [PATCH] configfs:...
85
86
87
88
  		if (!name) {
  			error = -ENOMEM;
  			goto Done;
  		}
f6b1fe7c2   Fabian Frederick   fs/configs/item.c...
89
90
  		va_start(args, fmt);
  		need = vsnprintf(name, limit, fmt, args);
7063fbf22   Joel Becker   [PATCH] configfs:...
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
  		va_end(args);
  
  		/* Still? Give up. */
  		if (need >= limit) {
  			kfree(name);
  			error = -EFAULT;
  			goto Done;
  		}
  	}
  
  	/* 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;
   Done:
  	return error;
  }
7063fbf22   Joel Becker   [PATCH] configfs:...
110
111
112
113
114
115
  EXPORT_SYMBOL(config_item_set_name);
  
  void config_item_init_type_name(struct config_item *item,
  				const char *name,
  				struct config_item_type *type)
  {
3958b7926   Nicolas Iooss   configfs: fix ker...
116
  	config_item_set_name(item, "%s", name);
7063fbf22   Joel Becker   [PATCH] configfs:...
117
118
119
120
121
122
123
124
  	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,
  			 struct config_item_type *type)
  {
3958b7926   Nicolas Iooss   configfs: fix ker...
125
  	config_item_set_name(&group->cg_item, "%s", name);
7063fbf22   Joel Becker   [PATCH] configfs:...
126
127
128
129
  	group->cg_item.ci_type = type;
  	config_group_init(group);
  }
  EXPORT_SYMBOL(config_group_init_type_name);
f6b1fe7c2   Fabian Frederick   fs/configs/item.c...
130
  struct config_item *config_item_get(struct config_item *item)
7063fbf22   Joel Becker   [PATCH] configfs:...
131
132
133
134
135
  {
  	if (item)
  		kref_get(&item->ci_kref);
  	return item;
  }
f6b1fe7c2   Fabian Frederick   fs/configs/item.c...
136
  EXPORT_SYMBOL(config_item_get);
7063fbf22   Joel Becker   [PATCH] configfs:...
137

f6b1fe7c2   Fabian Frederick   fs/configs/item.c...
138
  static void config_item_cleanup(struct config_item *item)
7063fbf22   Joel Becker   [PATCH] configfs:...
139
  {
f6b1fe7c2   Fabian Frederick   fs/configs/item.c...
140
141
142
  	struct config_item_type *t = item->ci_type;
  	struct config_group *s = item->ci_group;
  	struct config_item *parent = item->ci_parent;
7063fbf22   Joel Becker   [PATCH] configfs:...
143

f6b1fe7c2   Fabian Frederick   fs/configs/item.c...
144
145
  	pr_debug("config_item %s: cleaning up
  ", config_item_name(item));
7063fbf22   Joel Becker   [PATCH] configfs:...
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
  	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...
168
  void config_item_put(struct config_item *item)
7063fbf22   Joel Becker   [PATCH] configfs:...
169
170
171
172
  {
  	if (item)
  		kref_put(&item->ci_kref, config_item_release);
  }
f6b1fe7c2   Fabian Frederick   fs/configs/item.c...
173
  EXPORT_SYMBOL(config_item_put);
7063fbf22   Joel Becker   [PATCH] configfs:...
174

7063fbf22   Joel Becker   [PATCH] configfs:...
175
176
  /**
   *	config_group_init - initialize a group for use
f6b1fe7c2   Fabian Frederick   fs/configs/item.c...
177
   *	@group:	config_group
7063fbf22   Joel Becker   [PATCH] configfs:...
178
   */
7063fbf22   Joel Becker   [PATCH] configfs:...
179
180
181
182
  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 ...
183
  	INIT_LIST_HEAD(&group->default_groups);
7063fbf22   Joel Becker   [PATCH] configfs:...
184
  }
f6b1fe7c2   Fabian Frederick   fs/configs/item.c...
185
  EXPORT_SYMBOL(config_group_init);
7063fbf22   Joel Becker   [PATCH] configfs:...
186

7063fbf22   Joel Becker   [PATCH] configfs:...
187
  /**
3fe6c5ce1   Satyam Sharma   [PATCH] configfs+...
188
   *	config_group_find_item - search for item in group.
7063fbf22   Joel Becker   [PATCH] configfs:...
189
190
191
   *	@group:	group we're looking in.
   *	@name:	item's name.
   *
3fe6c5ce1   Satyam Sharma   [PATCH] configfs+...
192
193
194
   *	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:...
195
   */
3fe6c5ce1   Satyam Sharma   [PATCH] configfs+...
196
197
  struct config_item *config_group_find_item(struct config_group *group,
  					   const char *name)
7063fbf22   Joel Becker   [PATCH] configfs:...
198
  {
f6b1fe7c2   Fabian Frederick   fs/configs/item.c...
199
200
  	struct list_head *entry;
  	struct config_item *ret = NULL;
7063fbf22   Joel Becker   [PATCH] configfs:...
201

f6b1fe7c2   Fabian Frederick   fs/configs/item.c...
202
203
  	list_for_each(entry, &group->cg_children) {
  		struct config_item *item = to_item(entry);
7063fbf22   Joel Becker   [PATCH] configfs:...
204
  		if (config_item_name(item) &&
3fe6c5ce1   Satyam Sharma   [PATCH] configfs+...
205
  		    !strcmp(config_item_name(item), name)) {
7063fbf22   Joel Becker   [PATCH] configfs:...
206
207
208
209
210
211
  			ret = config_item_get(item);
  			break;
  		}
  	}
  	return ret;
  }
3fe6c5ce1   Satyam Sharma   [PATCH] configfs+...
212
  EXPORT_SYMBOL(config_group_find_item);