[linux.git] / fs / sysfs / sysfs.h

/*
 * fs/sysfs/sysfs.h - sysfs internal header file
 *
 * Copyright (c) 2001-3 Patrick Mochel
 * Copyright (c) 2007 SUSE Linux Products GmbH
 * Copyright (c) 2007 Tejun Heo <[email protected]>
 *
 * This file is released under the GPLv2.
 */

#include <linux/lockdep.h>
#include <linux/kobject_ns.h>
#include <linux/fs.h>
#include <linux/rbtree.h>

struct sysfs_open_dirent;

/* type-specific structures for sysfs_dirent->s_* union members */
struct sysfs_elem_dir {
	struct kobject		*kobj;

	unsigned long		subdirs;

	struct rb_root		inode_tree;
	struct rb_root		name_tree;
};

struct sysfs_elem_symlink {
	struct sysfs_dirent	*target_sd;
};

struct sysfs_elem_attr {
	struct attribute	*attr;
	struct sysfs_open_dirent *open;
};

struct sysfs_elem_bin_attr {
	struct bin_attribute	*bin_attr;
	struct hlist_head	buffers;
};

struct sysfs_inode_attrs {
	struct iattr	ia_iattr;
	void		*ia_secdata;
	u32		ia_secdata_len;
};

/*
 * sysfs_dirent - the building block of sysfs hierarchy.  Each and
 * every sysfs node is represented by single sysfs_dirent.
 *
 * As long as s_count reference is held, the sysfs_dirent itself is
 * accessible.  Dereferencing s_elem or any other outer entity
 * requires s_active reference.
 */
struct sysfs_dirent {
	atomic_t		s_count;
	atomic_t		s_active;
#ifdef CONFIG_DEBUG_LOCK_ALLOC
	struct lockdep_map	dep_map;
#endif
	struct sysfs_dirent	*s_parent;
	const char		*s_name;

	struct rb_node		inode_node;
	struct rb_node		name_node;

	union {
		struct completion	*completion;
		struct sysfs_dirent	*removed_list;
	} u;

	const void		*s_ns; /* namespace tag */
	union {
		struct sysfs_elem_dir		s_dir;
		struct sysfs_elem_symlink	s_symlink;
		struct sysfs_elem_attr		s_attr;
		struct sysfs_elem_bin_attr	s_bin_attr;
	};

	unsigned int		s_flags;
	unsigned short		s_mode;
	ino_t			s_ino;
	struct sysfs_inode_attrs *s_iattr;
};

#define SD_DEACTIVATED_BIAS		INT_MIN

#define SYSFS_TYPE_MASK			0x00ff
#define SYSFS_DIR			0x0001
#define SYSFS_KOBJ_ATTR			0x0002
#define SYSFS_KOBJ_BIN_ATTR		0x0004
#define SYSFS_KOBJ_LINK			0x0008
#define SYSFS_COPY_NAME			(SYSFS_DIR | SYSFS_KOBJ_LINK)
#define SYSFS_ACTIVE_REF		(SYSFS_KOBJ_ATTR | SYSFS_KOBJ_BIN_ATTR)

/* identify any namespace tag on sysfs_dirents */
#define SYSFS_NS_TYPE_MASK		0xff00
#define SYSFS_NS_TYPE_SHIFT		8

#define SYSFS_FLAG_MASK			~(SYSFS_NS_TYPE_MASK|SYSFS_TYPE_MASK)
#define SYSFS_FLAG_REMOVED		0x020000

static inline unsigned int sysfs_type(struct sysfs_dirent *sd)
{
	return sd->s_flags & SYSFS_TYPE_MASK;
}

/*
 * Return any namespace tags on this dirent.
 * enum kobj_ns_type is defined in linux/kobject.h
 */
static inline enum kobj_ns_type sysfs_ns_type(struct sysfs_dirent *sd)
{
	return (sd->s_flags & SYSFS_NS_TYPE_MASK) >> SYSFS_NS_TYPE_SHIFT;
}

#ifdef CONFIG_DEBUG_LOCK_ALLOC
#define sysfs_dirent_init_lockdep(sd)				\
do {								\
	struct attribute *attr = sd->s_attr.attr;		\
	struct lock_class_key *key = attr->key;			\
	if (!key)						\
		key = &attr->skey;				\
								\
	lockdep_init_map(&sd->dep_map, "s_active", key, 0);	\
} while(0)
#else
#define sysfs_dirent_init_lockdep(sd) do {} while(0)
#endif

/*
 * Context structure to be used while adding/removing nodes.
 */
struct sysfs_addrm_cxt {
	struct sysfs_dirent	*parent_sd;
	struct sysfs_dirent	*removed;
};

/*
 * mount.c
 */

/*
 * Each sb is associated with a set of namespace tags (i.e.
 * the network namespace of the task which mounted this sysfs
 * instance).
 */
struct sysfs_super_info {
	void *ns[KOBJ_NS_TYPES];
};
#define sysfs_info(SB) ((struct sysfs_super_info *)(SB->s_fs_info))
extern struct sysfs_dirent sysfs_root;
extern struct kmem_cache *sysfs_dir_cachep;

/*
 * dir.c
 */
extern struct mutex sysfs_mutex;
extern spinlock_t sysfs_assoc_lock;

extern const struct file_operations sysfs_dir_operations;
extern const struct inode_operations sysfs_dir_inode_operations;

struct dentry *sysfs_get_dentry(struct sysfs_dirent *sd);
struct sysfs_dirent *sysfs_get_active(struct sysfs_dirent *sd);
void sysfs_put_active(struct sysfs_dirent *sd);
void sysfs_addrm_start(struct sysfs_addrm_cxt *acxt,
		       struct sysfs_dirent *parent_sd);
int __sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd);
int sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd);
void sysfs_remove_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd);
void sysfs_addrm_finish(struct sysfs_addrm_cxt *acxt);

struct sysfs_dirent *sysfs_find_dirent(struct sysfs_dirent *parent_sd,
				       const void *ns,
				       const unsigned char *name);
struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
				      const void *ns,
				      const unsigned char *name);
struct sysfs_dirent *sysfs_new_dirent(const char *name, umode_t mode, int type);

void release_sysfs_dirent(struct sysfs_dirent *sd);

int sysfs_create_subdir(struct kobject *kobj, const char *name,
			struct sysfs_dirent **p_sd);
void sysfs_remove_subdir(struct sysfs_dirent *sd);

int sysfs_rename(struct sysfs_dirent *sd,
	struct sysfs_dirent *new_parent_sd, const void *ns, const char *new_name);

static inline struct sysfs_dirent *__sysfs_get(struct sysfs_dirent *sd)
{
	if (sd) {
		WARN_ON(!atomic_read(&sd->s_count));
		atomic_inc(&sd->s_count);
	}
	return sd;
}
#define sysfs_get(sd) __sysfs_get(sd)

static inline void __sysfs_put(struct sysfs_dirent *sd)
{
	if (sd && atomic_dec_and_test(&sd->s_count))
		release_sysfs_dirent(sd);
}
#define sysfs_put(sd) __sysfs_put(sd)

/*
 * inode.c
 */
struct inode *sysfs_get_inode(struct super_block *sb, struct sysfs_dirent *sd);
void sysfs_evict_inode(struct inode *inode);
int sysfs_sd_setattr(struct sysfs_dirent *sd, struct iattr *iattr);
int sysfs_permission(struct inode *inode, int mask);
int sysfs_setattr(struct dentry *dentry, struct iattr *iattr);
int sysfs_getattr(struct vfsmount *mnt, struct dentry *dentry, struct kstat *stat);
int sysfs_setxattr(struct dentry *dentry, const char *name, const void *value,
		size_t size, int flags);
int sysfs_hash_and_remove(struct sysfs_dirent *dir_sd, const void *ns, const char *name);
int sysfs_inode_init(void);

/*
 * file.c
 */
extern const struct file_operations sysfs_file_operations;

int sysfs_add_file(struct sysfs_dirent *dir_sd,
		   const struct attribute *attr, int type);

int sysfs_add_file_mode(struct sysfs_dirent *dir_sd,
			const struct attribute *attr, int type, mode_t amode);
/*
 * bin.c
 */
extern const struct file_operations bin_fops;
void unmap_bin_file(struct sysfs_dirent *attr_sd);

/*
 * symlink.c
 */
extern const struct inode_operations sysfs_symlink_inode_operations;
Commit	Line	Data
6d66f5cd TH	1	/*
	2	* fs/sysfs/sysfs.h - sysfs internal header file
	3	*
	4	* Copyright (c) 2001-3 Patrick Mochel
	5	* Copyright (c) 2007 SUSE Linux Products GmbH
	6	* Copyright (c) 2007 Tejun Heo <[email protected]>
	7	*
	8	* This file is released under the GPLv2.
	9	*/
	10
846f9974	11	#include <linux/lockdep.h>
57cc7215	12	#include <linux/kobject_ns.h>
ddd29ec6	13	#include <linux/fs.h>
4f72c0ca	14	#include <linux/rbtree.h>
ddd29ec6	15
85a4ffad TH	16	struct sysfs_open_dirent;
85a4ffad TH	17
59f69015	18	/* type-specific structures for sysfs_dirent->s_* union members */
3e519038	19	struct sysfs_elem_dir {
59f69015	20	struct kobject *kobj;
7f9838fd MP	21
7f9838fd MP	22	unsigned long subdirs;
4f72c0ca	23
a406f758	24	struct rb_root inode_tree;
4f72c0ca	25	struct rb_root name_tree;
3e519038 TH	26	};
	27
	28	struct sysfs_elem_symlink {
59f69015	29	struct sysfs_dirent *target_sd;
3e519038 TH	30	};
	31
	32	struct sysfs_elem_attr {
59f69015	33	struct attribute *attr;
85a4ffad	34	struct sysfs_open_dirent *open;
3e519038 TH	35	};
	36
	37	struct sysfs_elem_bin_attr {
59f69015	38	struct bin_attribute *bin_attr;
e0edd3c6	39	struct hlist_head buffers;
3e519038 TH	40	};
3e519038 TH	41
ddd29ec6 DQ	42	struct sysfs_inode_attrs {
	43	struct iattr ia_iattr;
	44	void *ia_secdata;
	45	u32 ia_secdata_len;
	46	};
	47
0ab66088	48	/*
59f69015 TH	49	* sysfs_dirent - the building block of sysfs hierarchy. Each and
	50	* every sysfs node is represented by single sysfs_dirent.
	51	*
0ab66088 TH	52	* As long as s_count reference is held, the sysfs_dirent itself is
	53	* accessible. Dereferencing s_elem or any other outer entity
	54	* requires s_active reference.
	55	*/
d56c3eae AR	56	struct sysfs_dirent {
d56c3eae AR	57	atomic_t s_count;
8619f979	58	atomic_t s_active;
846f9974 EB	59	#ifdef CONFIG_DEBUG_LOCK_ALLOC
	60	struct lockdep_map dep_map;
	61	#endif
59f69015	62	struct sysfs_dirent *s_parent;
59f69015	63	const char *s_name;
3e519038	64
a406f758	65	struct rb_node inode_node;
4f72c0ca MP	66	struct rb_node name_node;
4f72c0ca MP	67
58f2a4c7 MP	68	union {
	69	struct completion *completion;
	70	struct sysfs_dirent *removed_list;
	71	} u;
	72
be867b19	73	const void s_ns; / namespace tag */
3e519038	74	union {
b1fc3d61 TH	75	struct sysfs_elem_dir s_dir;
	76	struct sysfs_elem_symlink s_symlink;
	77	struct sysfs_elem_attr s_attr;
	78	struct sysfs_elem_bin_attr s_bin_attr;
	79	};
3e519038	80
b402d72c	81	unsigned int s_flags;
19c38b63	82	unsigned short s_mode;
dc351252	83	ino_t s_ino;
ddd29ec6	84	struct sysfs_inode_attrs *s_iattr;
d56c3eae	85	};
1da177e4	86
59f69015	87	#define SD_DEACTIVATED_BIAS INT_MIN
0ab66088	88
59f69015	89	#define SYSFS_TYPE_MASK 0x00ff
dc2f75f0 TH	90	#define SYSFS_DIR 0x0001
	91	#define SYSFS_KOBJ_ATTR 0x0002
	92	#define SYSFS_KOBJ_BIN_ATTR 0x0004
	93	#define SYSFS_KOBJ_LINK 0x0008
59f69015	94	#define SYSFS_COPY_NAME (SYSFS_DIR \| SYSFS_KOBJ_LINK)
a2db6842	95	#define SYSFS_ACTIVE_REF (SYSFS_KOBJ_ATTR \| SYSFS_KOBJ_BIN_ATTR)
59f69015	96
be867b19	97	/* identify any namespace tag on sysfs_dirents */
3ff195b0 EB	98	#define SYSFS_NS_TYPE_MASK 0xff00
	99	#define SYSFS_NS_TYPE_SHIFT 8
	100
	101	#define SYSFS_FLAG_MASK ~(SYSFS_NS_TYPE_MASK\|SYSFS_TYPE_MASK)
	102	#define SYSFS_FLAG_REMOVED 0x020000
59f69015 TH	103
	104	static inline unsigned int sysfs_type(struct sysfs_dirent *sd)
	105	{
	106	return sd->s_flags & SYSFS_TYPE_MASK;
	107	}
	108
be867b19 SH	109	/*
	110	* Return any namespace tags on this dirent.
	111	* enum kobj_ns_type is defined in linux/kobject.h
	112	*/
3ff195b0 EB	113	static inline enum kobj_ns_type sysfs_ns_type(struct sysfs_dirent *sd)
	114	{
	115	return (sd->s_flags & SYSFS_NS_TYPE_MASK) >> SYSFS_NS_TYPE_SHIFT;
	116	}
	117
846f9974 EB	118	#ifdef CONFIG_DEBUG_LOCK_ALLOC
	119	#define sysfs_dirent_init_lockdep(sd) \
	120	do { \
6992f533 EB	121	struct attribute *attr = sd->s_attr.attr; \
	122	struct lock_class_key *key = attr->key; \
	123	if (!key) \
	124	key = &attr->skey; \
846f9974	125	\
6992f533	126	lockdep_init_map(&sd->dep_map, "s_active", key, 0); \
846f9974 EB	127	} while(0)
	128	#else
	129	#define sysfs_dirent_init_lockdep(sd) do {} while(0)
	130	#endif
	131
59f69015 TH	132	/*
	133	* Context structure to be used while adding/removing nodes.
	134	*/
fb6896da TH	135	struct sysfs_addrm_cxt {
fb6896da TH	136	struct sysfs_dirent *parent_sd;
fb6896da	137	struct sysfs_dirent *removed;
fb6896da TH	138	};
fb6896da TH	139
59f69015 TH	140	/*
	141	* mount.c
	142	*/
be867b19 SH	143
	144	/*
	145	* Each sb is associated with a set of namespace tags (i.e.
	146	* the network namespace of the task which mounted this sysfs
	147	* instance).
	148	*/
9e7fdd25	149	struct sysfs_super_info {
a685e089	150	void *ns[KOBJ_NS_TYPES];
9e7fdd25 EB	151	};
9e7fdd25 EB	152	#define sysfs_info(SB) ((struct sysfs_super_info *)(SB->s_fs_info))
51225039	153	extern struct sysfs_dirent sysfs_root;
e18b890b	154	extern struct kmem_cache *sysfs_dir_cachep;
1da177e4	155
59f69015 TH	156	/*
	157	* dir.c
	158	*/
3007e997	159	extern struct mutex sysfs_mutex;
59f69015 TH	160	extern spinlock_t sysfs_assoc_lock;
59f69015 TH	161
4b6f5d20	162	extern const struct file_operations sysfs_dir_operations;
c5ef1c42	163	extern const struct inode_operations sysfs_dir_inode_operations;
1da177e4	164
59f69015	165	struct dentry sysfs_get_dentry(struct sysfs_dirent sd);
e72ceb8c EB	166	struct sysfs_dirent sysfs_get_active(struct sysfs_dirent sd);
e72ceb8c EB	167	void sysfs_put_active(struct sysfs_dirent *sd);
59f69015 TH	168	void sysfs_addrm_start(struct sysfs_addrm_cxt *acxt,
59f69015 TH	169	struct sysfs_dirent *parent_sd);
36ce6dad	170	int __sysfs_add_one(struct sysfs_addrm_cxt acxt, struct sysfs_dirent sd);
59f69015 TH	171	int sysfs_add_one(struct sysfs_addrm_cxt acxt, struct sysfs_dirent sd);
	172	void sysfs_remove_one(struct sysfs_addrm_cxt acxt, struct sysfs_dirent sd);
	173	void sysfs_addrm_finish(struct sysfs_addrm_cxt *acxt);
	174
	175	struct sysfs_dirent sysfs_find_dirent(struct sysfs_dirent parent_sd,
3ff195b0	176	const void *ns,
59f69015 TH	177	const unsigned char *name);
59f69015 TH	178	struct sysfs_dirent sysfs_get_dirent(struct sysfs_dirent parent_sd,
3ff195b0	179	const void *ns,
59f69015 TH	180	const unsigned char *name);
	181	struct sysfs_dirent sysfs_new_dirent(const char name, umode_t mode, int type);
	182
	183	void release_sysfs_dirent(struct sysfs_dirent *sd);
	184
	185	int sysfs_create_subdir(struct kobject kobj, const char name,
	186	struct sysfs_dirent **p_sd);
	187	void sysfs_remove_subdir(struct sysfs_dirent *sd);
	188
ca1bab38	189	int sysfs_rename(struct sysfs_dirent *sd,
3ff195b0	190	struct sysfs_dirent new_parent_sd, const void ns, const char *new_name);
ca1bab38	191
f1282c84	192	static inline struct sysfs_dirent __sysfs_get(struct sysfs_dirent sd)
1da177e4	193	{
0ab66088 TH	194	if (sd) {
	195	WARN_ON(!atomic_read(&sd->s_count));
	196	atomic_inc(&sd->s_count);
	197	}
	198	return sd;
1da177e4	199	}
f1282c84	200	#define sysfs_get(sd) __sysfs_get(sd)
1da177e4	201
f1282c84	202	static inline void __sysfs_put(struct sysfs_dirent *sd)
1da177e4	203	{
0ab66088 TH	204	if (sd && atomic_dec_and_test(&sd->s_count))
	205	release_sysfs_dirent(sd);
	206	}
f1282c84	207	#define sysfs_put(sd) __sysfs_put(sd)
59f69015 TH	208
	209	/*
	210	* inode.c
	211	*/
fac2622b	212	struct inode sysfs_get_inode(struct super_block sb, struct sysfs_dirent *sd);
01cd9fef	213	void sysfs_evict_inode(struct inode *inode);
35df63c4	214	int sysfs_sd_setattr(struct sysfs_dirent sd, struct iattr iattr);
10556cb2	215	int sysfs_permission(struct inode *inode, int mask);
59f69015	216	int sysfs_setattr(struct dentry dentry, struct iattr iattr);
e61ab4ae	217	int sysfs_getattr(struct vfsmount mnt, struct dentry dentry, struct kstat *stat);
ddd29ec6 DQ	218	int sysfs_setxattr(struct dentry dentry, const char name, const void *value,
ddd29ec6 DQ	219	size_t size, int flags);
3ff195b0	220	int sysfs_hash_and_remove(struct sysfs_dirent dir_sd, const void ns, const char *name);
e0bf68dd	221	int sysfs_inode_init(void);
59f69015 TH	222
	223	/*
	224	* file.c
	225	*/
	226	extern const struct file_operations sysfs_file_operations;
	227
	228	int sysfs_add_file(struct sysfs_dirent *dir_sd,
	229	const struct attribute *attr, int type);
	230
0f423895 JB	231	int sysfs_add_file_mode(struct sysfs_dirent *dir_sd,
0f423895 JB	232	const struct attribute *attr, int type, mode_t amode);
59f69015 TH	233	/*
	234	* bin.c
	235	*/
	236	extern const struct file_operations bin_fops;
e0edd3c6	237	void unmap_bin_file(struct sysfs_dirent *attr_sd);
59f69015 TH	238
	239	/*
	240	* symlink.c
	241	*/
	242	extern const struct inode_operations sysfs_symlink_inode_operations;