sysfs.h 14.5 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5
/*
 * sysfs.h - definitions for the device driver filesystem
 *
 * Copyright (c) 2001,2002 Patrick Mochel
 * Copyright (c) 2004 Silicon Graphics, Inc.
T
Tejun Heo 已提交
6 7
 * Copyright (c) 2007 SUSE Linux Products GmbH
 * Copyright (c) 2007 Tejun Heo <teheo@suse.de>
L
Linus Torvalds 已提交
8 9 10 11 12 13 14
 *
 * Please see Documentation/filesystems/sysfs.txt for more information.
 */

#ifndef _SYSFS_H_
#define _SYSFS_H_

15
#include <linux/kernfs.h>
16
#include <linux/compiler.h>
17
#include <linux/errno.h>
18
#include <linux/list.h>
19
#include <linux/lockdep.h>
20
#include <linux/kobject_ns.h>
21
#include <linux/stat.h>
A
Arun Sharma 已提交
22
#include <linux/atomic.h>
L
Linus Torvalds 已提交
23 24 25

struct kobject;
struct module;
26
struct bin_attribute;
27
enum kobj_ns_type;
L
Linus Torvalds 已提交
28 29

struct attribute {
T
Tejun Heo 已提交
30
	const char		*name;
A
Al Viro 已提交
31
	umode_t			mode;
32
#ifdef CONFIG_DEBUG_LOCK_ALLOC
33
	bool			ignore_lockdep:1;
34 35 36
	struct lock_class_key	*key;
	struct lock_class_key	skey;
#endif
L
Linus Torvalds 已提交
37 38
};

39 40 41 42 43 44 45 46 47 48
/**
 *	sysfs_attr_init - initialize a dynamically allocated sysfs attribute
 *	@attr: struct attribute to initialize
 *
 *	Initialize a dynamically allocated struct attribute so we can
 *	make lockdep happy.  This is a new requirement for attributes
 *	and initially this is only needed when lockdep is enabled.
 *	Lockdep gives a nice error when your attribute is added to
 *	sysfs if you don't have this.
 */
49 50 51 52 53 54
#ifdef CONFIG_DEBUG_LOCK_ALLOC
#define sysfs_attr_init(attr)				\
do {							\
	static struct lock_class_key __key;		\
							\
	(attr)->key = &__key;				\
55
} while (0)
56
#else
57
#define sysfs_attr_init(attr) do {} while (0)
58 59
#endif

60 61 62 63 64 65 66
/**
 * struct attribute_group - data structure used to declare an attribute group.
 * @name:	Optional: Attribute group name
 *		If specified, the attribute group will be created in
 *		a new subdirectory with this name.
 * @is_visible:	Optional: Function to return permissions associated with an
 *		attribute of the group. Will be called repeatedly for each
67 68 69 70 71 72 73 74 75 76 77 78
 *		non-binary attribute in the group. Only read/write
 *		permissions as well as SYSFS_PREALLOC are accepted. Must
 *		return 0 if an attribute is not visible. The returned value
 *		will replace static permissions defined in struct attribute.
 * @is_bin_visible:
 *		Optional: Function to return permissions associated with a
 *		binary attribute of the group. Will be called repeatedly
 *		for each binary attribute in the group. Only read/write
 *		permissions as well as SYSFS_PREALLOC are accepted. Must
 *		return 0 if a binary attribute is not visible. The returned
 *		value will replace static permissions defined in
 *		struct bin_attribute.
79 80 81 82
 * @attrs:	Pointer to NULL terminated list of attributes.
 * @bin_attrs:	Pointer to NULL terminated list of binary attributes.
 *		Either attrs or bin_attrs or both must be provided.
 */
L
Linus Torvalds 已提交
83
struct attribute_group {
T
Tejun Heo 已提交
84
	const char		*name;
85
	umode_t			(*is_visible)(struct kobject *,
86
					      struct attribute *, int);
87 88
	umode_t			(*is_bin_visible)(struct kobject *,
						  struct bin_attribute *, int);
T
Tejun Heo 已提交
89
	struct attribute	**attrs;
90
	struct bin_attribute	**bin_attrs;
L
Linus Torvalds 已提交
91 92 93 94 95 96 97
};

/**
 * Use these macros to make defining attributes easier. See include/linux/device.h
 * for examples..
 */

98 99
#define SYSFS_PREALLOC 010000

100
#define __ATTR(_name, _mode, _show, _store) {				\
101 102
	.attr = {.name = __stringify(_name),				\
		 .mode = VERIFY_OCTAL_PERMISSIONS(_mode) },		\
103 104
	.show	= _show,						\
	.store	= _store,						\
L
Linus Torvalds 已提交
105 106
}

107 108 109 110 111 112 113
#define __ATTR_PREALLOC(_name, _mode, _show, _store) {			\
	.attr = {.name = __stringify(_name),				\
		 .mode = SYSFS_PREALLOC | VERIFY_OCTAL_PERMISSIONS(_mode) },\
	.show	= _show,						\
	.store	= _store,						\
}

114 115 116
#define __ATTR_RO(_name) {						\
	.attr	= { .name = __stringify(_name), .mode = S_IRUGO },	\
	.show	= _name##_show,						\
L
Linus Torvalds 已提交
117 118
}

G
Greg Kroah-Hartman 已提交
119 120 121 122 123
#define __ATTR_WO(_name) {						\
	.attr	= { .name = __stringify(_name), .mode = S_IWUSR },	\
	.store	= _name##_store,					\
}

124 125
#define __ATTR_RW(_name) __ATTR(_name, (S_IWUSR | S_IRUGO),		\
			 _name##_show, _name##_store)
126

L
Linus Torvalds 已提交
127
#define __ATTR_NULL { .attr = { .name = NULL } }
128 129 130 131 132 133 134 135 136 137 138

#ifdef CONFIG_DEBUG_LOCK_ALLOC
#define __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) {	\
	.attr = {.name = __stringify(_name), .mode = _mode,	\
			.ignore_lockdep = true },		\
	.show		= _show,				\
	.store		= _store,				\
}
#else
#define __ATTR_IGNORE_LOCKDEP	__ATTR
#endif
L
Linus Torvalds 已提交
139

140 141 142
#define __ATTRIBUTE_GROUPS(_name)				\
static const struct attribute_group *_name##_groups[] = {	\
	&_name##_group,						\
143 144 145
	NULL,							\
}

146 147 148 149 150 151
#define ATTRIBUTE_GROUPS(_name)					\
static const struct attribute_group _name##_group = {		\
	.attrs = _name##_attrs,					\
};								\
__ATTRIBUTE_GROUPS(_name)

152
struct file;
L
Linus Torvalds 已提交
153 154 155 156 157 158
struct vm_area_struct;

struct bin_attribute {
	struct attribute	attr;
	size_t			size;
	void			*private;
159
	ssize_t (*read)(struct file *, struct kobject *, struct bin_attribute *,
160
			char *, loff_t, size_t);
161
	ssize_t (*write)(struct file *, struct kobject *, struct bin_attribute *,
162
			 char *, loff_t, size_t);
163
	int (*mmap)(struct file *, struct kobject *, struct bin_attribute *attr,
L
Linus Torvalds 已提交
164 165 166
		    struct vm_area_struct *vma);
};

167 168 169 170 171 172 173 174 175 176
/**
 *	sysfs_bin_attr_init - initialize a dynamically allocated bin_attribute
 *	@attr: struct bin_attribute to initialize
 *
 *	Initialize a dynamically allocated struct bin_attribute so we
 *	can make lockdep happy.  This is a new requirement for
 *	attributes and initially this is only needed when lockdep is
 *	enabled.  Lockdep gives a nice error when your attribute is
 *	added to sysfs if you don't have this.
 */
177
#define sysfs_bin_attr_init(bin_attr) sysfs_attr_init(&(bin_attr)->attr)
178

179 180 181 182 183 184 185 186 187 188 189 190
/* macros to create static binary attributes easier */
#define __BIN_ATTR(_name, _mode, _read, _write, _size) {		\
	.attr = { .name = __stringify(_name), .mode = _mode },		\
	.read	= _read,						\
	.write	= _write,						\
	.size	= _size,						\
}

#define __BIN_ATTR_RO(_name, _size) {					\
	.attr	= { .name = __stringify(_name), .mode = S_IRUGO },	\
	.read	= _name##_read,						\
	.size	= _size,						\
G
Greg Kroah-Hartman 已提交
191 192
}

193 194
#define __BIN_ATTR_RW(_name, _size) __BIN_ATTR(_name,			\
				   (S_IWUSR | S_IRUGO), _name##_read,	\
195
				   _name##_write, _size)
196 197 198 199 200 201 202 203 204 205 206 207 208

#define __BIN_ATTR_NULL __ATTR_NULL

#define BIN_ATTR(_name, _mode, _read, _write, _size)			\
struct bin_attribute bin_attr_##_name = __BIN_ATTR(_name, _mode, _read,	\
					_write, _size)

#define BIN_ATTR_RO(_name, _size)					\
struct bin_attribute bin_attr_##_name = __BIN_ATTR_RO(_name, _size)

#define BIN_ATTR_RW(_name, _size)					\
struct bin_attribute bin_attr_##_name = __BIN_ATTR_RW(_name, _size)

L
Linus Torvalds 已提交
209
struct sysfs_ops {
210 211
	ssize_t	(*show)(struct kobject *, struct attribute *, char *);
	ssize_t	(*store)(struct kobject *, struct attribute *, const char *, size_t);
L
Linus Torvalds 已提交
212 213 214 215
};

#ifdef CONFIG_SYSFS

216
int __must_check sysfs_create_dir_ns(struct kobject *kobj, const void *ns);
T
Tejun Heo 已提交
217
void sysfs_remove_dir(struct kobject *kobj);
218 219 220 221 222
int __must_check sysfs_rename_dir_ns(struct kobject *kobj, const char *new_name,
				     const void *new_ns);
int __must_check sysfs_move_dir_ns(struct kobject *kobj,
				   struct kobject *new_parent_kobj,
				   const void *new_ns);
223 224 225 226
int __must_check sysfs_create_mount_point(struct kobject *parent_kobj,
					  const char *name);
void sysfs_remove_mount_point(struct kobject *parent_kobj,
			      const char *name);
227

228 229 230
int __must_check sysfs_create_file_ns(struct kobject *kobj,
				      const struct attribute *attr,
				      const void *ns);
231 232
int __must_check sysfs_create_files(struct kobject *kobj,
				   const struct attribute **attr);
233
int __must_check sysfs_chmod_file(struct kobject *kobj,
A
Al Viro 已提交
234
				  const struct attribute *attr, umode_t mode);
235 236
void sysfs_remove_file_ns(struct kobject *kobj, const struct attribute *attr,
			  const void *ns);
237
bool sysfs_remove_file_self(struct kobject *kobj, const struct attribute *attr);
238
void sysfs_remove_files(struct kobject *kobj, const struct attribute **attr);
L
Linus Torvalds 已提交
239

240
int __must_check sysfs_create_bin_file(struct kobject *kobj,
241 242 243
				       const struct bin_attribute *attr);
void sysfs_remove_bin_file(struct kobject *kobj,
			   const struct bin_attribute *attr);
L
Linus Torvalds 已提交
244

T
Tejun Heo 已提交
245 246
int __must_check sysfs_create_link(struct kobject *kobj, struct kobject *target,
				   const char *name);
247 248 249
int __must_check sysfs_create_link_nowarn(struct kobject *kobj,
					  struct kobject *target,
					  const char *name);
T
Tejun Heo 已提交
250 251
void sysfs_remove_link(struct kobject *kobj, const char *name);

252 253 254
int sysfs_rename_link_ns(struct kobject *kobj, struct kobject *target,
			 const char *old_name, const char *new_name,
			 const void *new_ns);
255

256 257 258
void sysfs_delete_link(struct kobject *dir, struct kobject *targ,
			const char *name);

T
Tejun Heo 已提交
259 260
int __must_check sysfs_create_group(struct kobject *kobj,
				    const struct attribute_group *grp);
261 262
int __must_check sysfs_create_groups(struct kobject *kobj,
				     const struct attribute_group **groups);
263 264
int sysfs_update_group(struct kobject *kobj,
		       const struct attribute_group *grp);
T
Tejun Heo 已提交
265 266
void sysfs_remove_group(struct kobject *kobj,
			const struct attribute_group *grp);
267 268
void sysfs_remove_groups(struct kobject *kobj,
			 const struct attribute_group **groups);
269
int sysfs_add_file_to_group(struct kobject *kobj,
T
Tejun Heo 已提交
270
			const struct attribute *attr, const char *group);
271
void sysfs_remove_file_from_group(struct kobject *kobj,
T
Tejun Heo 已提交
272
			const struct attribute *attr, const char *group);
273 274 275 276
int sysfs_merge_group(struct kobject *kobj,
		       const struct attribute_group *grp);
void sysfs_unmerge_group(struct kobject *kobj,
		       const struct attribute_group *grp);
277 278 279 280
int sysfs_add_link_to_group(struct kobject *kobj, const char *group_name,
			    struct kobject *target, const char *link_name);
void sysfs_remove_link_from_group(struct kobject *kobj, const char *group_name,
				  const char *link_name);
281 282 283
int __compat_only_sysfs_link_entry_to_kobj(struct kobject *kobj,
				      struct kobject *target_kobj,
				      const char *target_name);
284

285
void sysfs_notify(struct kobject *kobj, const char *dir, const char *attr);
286

287
int __must_check sysfs_init(void);
288

289 290 291 292 293
static inline void sysfs_enable_ns(struct kernfs_node *kn)
{
	return kernfs_enable_ns(kn);
}

L
Linus Torvalds 已提交
294 295
#else /* CONFIG_SYSFS */

296
static inline int sysfs_create_dir_ns(struct kobject *kobj, const void *ns)
L
Linus Torvalds 已提交
297 298 299 300
{
	return 0;
}

T
Tejun Heo 已提交
301
static inline void sysfs_remove_dir(struct kobject *kobj)
L
Linus Torvalds 已提交
302 303 304
{
}

305 306
static inline int sysfs_rename_dir_ns(struct kobject *kobj,
				      const char *new_name, const void *new_ns)
L
Linus Torvalds 已提交
307
{
308
	return 0;
L
Linus Torvalds 已提交
309 310
}

311 312 313
static inline int sysfs_move_dir_ns(struct kobject *kobj,
				    struct kobject *new_parent_kobj,
				    const void *new_ns)
314 315 316 317
{
	return 0;
}

318 319 320 321 322 323 324 325 326 327 328
static inline int sysfs_create_mount_point(struct kobject *parent_kobj,
					   const char *name)
{
	return 0;
}

static inline void sysfs_remove_mount_point(struct kobject *parent_kobj,
					    const char *name)
{
}

329 330 331
static inline int sysfs_create_file_ns(struct kobject *kobj,
				       const struct attribute *attr,
				       const void *ns)
L
Linus Torvalds 已提交
332 333 334 335
{
	return 0;
}

336 337 338 339 340 341
static inline int sysfs_create_files(struct kobject *kobj,
				    const struct attribute **attr)
{
	return 0;
}

T
Tejun Heo 已提交
342
static inline int sysfs_chmod_file(struct kobject *kobj,
A
Al Viro 已提交
343
				   const struct attribute *attr, umode_t mode)
344 345 346
{
	return 0;
}
L
Linus Torvalds 已提交
347

348 349 350
static inline void sysfs_remove_file_ns(struct kobject *kobj,
					const struct attribute *attr,
					const void *ns)
L
Linus Torvalds 已提交
351 352 353
{
}

354 355 356 357 358 359
static inline bool sysfs_remove_file_self(struct kobject *kobj,
					  const struct attribute *attr)
{
	return false;
}

360 361 362 363 364
static inline void sysfs_remove_files(struct kobject *kobj,
				     const struct attribute **attr)
{
}

T
Tejun Heo 已提交
365
static inline int sysfs_create_bin_file(struct kobject *kobj,
366
					const struct bin_attribute *attr)
L
Linus Torvalds 已提交
367 368 369 370
{
	return 0;
}

371
static inline void sysfs_remove_bin_file(struct kobject *kobj,
372
					 const struct bin_attribute *attr)
L
Linus Torvalds 已提交
373 374 375
{
}

T
Tejun Heo 已提交
376 377
static inline int sysfs_create_link(struct kobject *kobj,
				    struct kobject *target, const char *name)
L
Linus Torvalds 已提交
378 379 380 381
{
	return 0;
}

382 383 384 385 386 387 388
static inline int sysfs_create_link_nowarn(struct kobject *kobj,
					   struct kobject *target,
					   const char *name)
{
	return 0;
}

T
Tejun Heo 已提交
389
static inline void sysfs_remove_link(struct kobject *kobj, const char *name)
L
Linus Torvalds 已提交
390 391 392
{
}

393 394 395
static inline int sysfs_rename_link_ns(struct kobject *k, struct kobject *t,
				       const char *old_name,
				       const char *new_name, const void *ns)
396 397 398 399
{
	return 0;
}

400 401 402 403 404
static inline void sysfs_delete_link(struct kobject *k, struct kobject *t,
				     const char *name)
{
}

T
Tejun Heo 已提交
405 406
static inline int sysfs_create_group(struct kobject *kobj,
				     const struct attribute_group *grp)
L
Linus Torvalds 已提交
407 408 409 410
{
	return 0;
}

411 412 413
static inline int sysfs_create_groups(struct kobject *kobj,
				      const struct attribute_group **groups)
{
414
	return 0;
415 416
}

417 418 419 420 421 422
static inline int sysfs_update_group(struct kobject *kobj,
				const struct attribute_group *grp)
{
	return 0;
}

T
Tejun Heo 已提交
423 424
static inline void sysfs_remove_group(struct kobject *kobj,
				      const struct attribute_group *grp)
L
Linus Torvalds 已提交
425 426 427
{
}

428 429 430 431 432
static inline void sysfs_remove_groups(struct kobject *kobj,
				       const struct attribute_group **groups)
{
}

433 434 435 436 437 438 439
static inline int sysfs_add_file_to_group(struct kobject *kobj,
		const struct attribute *attr, const char *group)
{
	return 0;
}

static inline void sysfs_remove_file_from_group(struct kobject *kobj,
440
		const struct attribute *attr, const char *group)
441 442 443
{
}

444 445 446 447 448 449 450 451 452 453 454
static inline int sysfs_merge_group(struct kobject *kobj,
		       const struct attribute_group *grp)
{
	return 0;
}

static inline void sysfs_unmerge_group(struct kobject *kobj,
		       const struct attribute_group *grp)
{
}

455 456 457 458 459 460 461 462 463 464 465 466
static inline int sysfs_add_link_to_group(struct kobject *kobj,
		const char *group_name, struct kobject *target,
		const char *link_name)
{
	return 0;
}

static inline void sysfs_remove_link_from_group(struct kobject *kobj,
		const char *group_name, const char *link_name)
{
}

467 468 469 470 471 472 473 474
static inline int __compat_only_sysfs_link_entry_to_kobj(
	struct kobject *kobj,
	struct kobject *target_kobj,
	const char *target_name)
{
	return 0;
}

475 476
static inline void sysfs_notify(struct kobject *kobj, const char *dir,
				const char *attr)
477 478 479
{
}

480 481 482 483 484
static inline int __must_check sysfs_init(void)
{
	return 0;
}

485 486 487 488
static inline void sysfs_enable_ns(struct kernfs_node *kn)
{
}

L
Linus Torvalds 已提交
489 490
#endif /* CONFIG_SYSFS */

491 492 493 494 495 496 497 498 499
static inline int __must_check sysfs_create_file(struct kobject *kobj,
						 const struct attribute *attr)
{
	return sysfs_create_file_ns(kobj, attr, NULL);
}

static inline void sysfs_remove_file(struct kobject *kobj,
				     const struct attribute *attr)
{
500
	sysfs_remove_file_ns(kobj, attr, NULL);
501 502
}

503 504 505 506 507 508
static inline int sysfs_rename_link(struct kobject *kobj, struct kobject *target,
				    const char *old_name, const char *new_name)
{
	return sysfs_rename_link_ns(kobj, target, old_name, new_name, NULL);
}

509
static inline void sysfs_notify_dirent(struct kernfs_node *kn)
510
{
511
	kernfs_notify(kn);
512 513
}

514 515
static inline struct kernfs_node *sysfs_get_dirent(struct kernfs_node *parent,
						   const unsigned char *name)
T
Tejun Heo 已提交
516
{
517
	return kernfs_find_and_get(parent, name);
T
Tejun Heo 已提交
518 519
}

520
static inline struct kernfs_node *sysfs_get(struct kernfs_node *kn)
521
{
522 523
	kernfs_get(kn);
	return kn;
524 525
}

526
static inline void sysfs_put(struct kernfs_node *kn)
527
{
528
	kernfs_put(kn);
529 530
}

L
Linus Torvalds 已提交
531
#endif /* _SYSFS_H_ */