1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21#ifndef _CONFIGFS_H_
22#define _CONFIGFS_H_
23
24#include <linux/stat.h>
25#include <linux/types.h>
26#include <linux/list.h>
27#include <linux/kref.h>
28#include <linux/mutex.h>
29
30#define CONFIGFS_ITEM_NAME_LEN 20
31
32struct module;
33
34struct configfs_item_operations;
35struct configfs_group_operations;
36struct configfs_attribute;
37struct configfs_bin_attribute;
38struct configfs_subsystem;
39
40struct config_item {
41 char *ci_name;
42 char ci_namebuf[CONFIGFS_ITEM_NAME_LEN];
43 struct kref ci_kref;
44 struct list_head ci_entry;
45 struct config_item *ci_parent;
46 struct config_group *ci_group;
47 const struct config_item_type *ci_type;
48 struct dentry *ci_dentry;
49};
50
51extern __printf(2, 3)
52int config_item_set_name(struct config_item *, const char *, ...);
53
54static inline char *config_item_name(struct config_item * item)
55{
56 return item->ci_name;
57}
58
59extern void config_item_init_type_name(struct config_item *item,
60 const char *name,
61 const struct config_item_type *type);
62
63extern struct config_item *config_item_get(struct config_item *);
64extern struct config_item *config_item_get_unless_zero(struct config_item *);
65extern void config_item_put(struct config_item *);
66
67struct config_item_type {
68 struct module *ct_owner;
69 struct configfs_item_operations *ct_item_ops;
70 struct configfs_group_operations *ct_group_ops;
71 struct configfs_attribute **ct_attrs;
72 struct configfs_bin_attribute **ct_bin_attrs;
73};
74
75
76
77
78
79struct config_group {
80 struct config_item cg_item;
81 struct list_head cg_children;
82 struct configfs_subsystem *cg_subsys;
83 struct list_head default_groups;
84 struct list_head group_entry;
85};
86
87extern void config_group_init(struct config_group *group);
88extern void config_group_init_type_name(struct config_group *group,
89 const char *name,
90 const struct config_item_type *type);
91
92static inline struct config_group *to_config_group(struct config_item *item)
93{
94 return item ? container_of(item,struct config_group,cg_item) : NULL;
95}
96
97static inline struct config_group *config_group_get(struct config_group *group)
98{
99 return group ? to_config_group(config_item_get(&group->cg_item)) : NULL;
100}
101
102static inline void config_group_put(struct config_group *group)
103{
104 config_item_put(&group->cg_item);
105}
106
107extern struct config_item *config_group_find_item(struct config_group *,
108 const char *);
109
110
111static inline void configfs_add_default_group(struct config_group *new_group,
112 struct config_group *group)
113{
114 list_add_tail(&new_group->group_entry, &group->default_groups);
115}
116
117struct configfs_attribute {
118 const char *ca_name;
119 struct module *ca_owner;
120 umode_t ca_mode;
121 ssize_t (*show)(struct config_item *, char *);
122 ssize_t (*store)(struct config_item *, const char *, size_t);
123};
124
125#define CONFIGFS_ATTR(_pfx, _name) \
126static struct configfs_attribute _pfx##attr_##_name = { \
127 .ca_name = __stringify(_name), \
128 .ca_mode = S_IRUGO | S_IWUSR, \
129 .ca_owner = THIS_MODULE, \
130 .show = _pfx##_name##_show, \
131 .store = _pfx##_name##_store, \
132}
133
134#define CONFIGFS_ATTR_RO(_pfx, _name) \
135static struct configfs_attribute _pfx##attr_##_name = { \
136 .ca_name = __stringify(_name), \
137 .ca_mode = S_IRUGO, \
138 .ca_owner = THIS_MODULE, \
139 .show = _pfx##_name##_show, \
140}
141
142#define CONFIGFS_ATTR_WO(_pfx, _name) \
143static struct configfs_attribute _pfx##attr_##_name = { \
144 .ca_name = __stringify(_name), \
145 .ca_mode = S_IWUSR, \
146 .ca_owner = THIS_MODULE, \
147 .store = _pfx##_name##_store, \
148}
149
150struct file;
151struct vm_area_struct;
152
153struct configfs_bin_attribute {
154 struct configfs_attribute cb_attr;
155 void *cb_private;
156 size_t cb_max_size;
157 ssize_t (*read)(struct config_item *, void *, size_t);
158 ssize_t (*write)(struct config_item *, const void *, size_t);
159};
160
161#define CONFIGFS_BIN_ATTR(_pfx, _name, _priv, _maxsz) \
162static struct configfs_bin_attribute _pfx##attr_##_name = { \
163 .cb_attr = { \
164 .ca_name = __stringify(_name), \
165 .ca_mode = S_IRUGO | S_IWUSR, \
166 .ca_owner = THIS_MODULE, \
167 }, \
168 .cb_private = _priv, \
169 .cb_max_size = _maxsz, \
170 .read = _pfx##_name##_read, \
171 .write = _pfx##_name##_write, \
172}
173
174#define CONFIGFS_BIN_ATTR_RO(_pfx, _name, _priv, _maxsz) \
175static struct configfs_bin_attribute _pfx##attr_##_name = { \
176 .cb_attr = { \
177 .ca_name = __stringify(_name), \
178 .ca_mode = S_IRUGO, \
179 .ca_owner = THIS_MODULE, \
180 }, \
181 .cb_private = _priv, \
182 .cb_max_size = _maxsz, \
183 .read = _pfx##_name##_read, \
184}
185
186#define CONFIGFS_BIN_ATTR_WO(_pfx, _name, _priv, _maxsz) \
187static struct configfs_bin_attribute _pfx##attr_##_name = { \
188 .cb_attr = { \
189 .ca_name = __stringify(_name), \
190 .ca_mode = S_IWUSR, \
191 .ca_owner = THIS_MODULE, \
192 }, \
193 .cb_private = _priv, \
194 .cb_max_size = _maxsz, \
195 .write = _pfx##_name##_write, \
196}
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212struct configfs_item_operations {
213 void (*release)(struct config_item *);
214 int (*allow_link)(struct config_item *src, struct config_item *target);
215 void (*drop_link)(struct config_item *src, struct config_item *target);
216};
217
218struct configfs_group_operations {
219 struct config_item *(*make_item)(struct config_group *group, const char *name);
220 struct config_group *(*make_group)(struct config_group *group, const char *name);
221 int (*commit_item)(struct config_item *item);
222 void (*disconnect_notify)(struct config_group *group, struct config_item *item);
223 void (*drop_item)(struct config_group *group, struct config_item *item);
224};
225
226struct configfs_subsystem {
227 struct config_group su_group;
228 struct mutex su_mutex;
229};
230
231static inline struct configfs_subsystem *to_configfs_subsystem(struct config_group *group)
232{
233 return group ?
234 container_of(group, struct configfs_subsystem, su_group) :
235 NULL;
236}
237
238int configfs_register_subsystem(struct configfs_subsystem *subsys);
239void configfs_unregister_subsystem(struct configfs_subsystem *subsys);
240
241int configfs_register_group(struct config_group *parent_group,
242 struct config_group *group);
243void configfs_unregister_group(struct config_group *group);
244
245void configfs_remove_default_groups(struct config_group *group);
246
247struct config_group *
248configfs_register_default_group(struct config_group *parent_group,
249 const char *name,
250 const struct config_item_type *item_type);
251void configfs_unregister_default_group(struct config_group *group);
252
253
254
255int configfs_depend_item(struct configfs_subsystem *subsys,
256 struct config_item *target);
257void configfs_undepend_item(struct config_item *target);
258
259
260
261
262
263
264
265
266int configfs_depend_item_unlocked(struct configfs_subsystem *caller_subsys,
267 struct config_item *target);
268
269
270static inline void configfs_undepend_item_unlocked(struct config_item *target)
271{
272 configfs_undepend_item(target);
273}
274
275#endif
276