[mirror_ubuntu-bionic-kernel.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 <teheo@suse.de>
 *
 * This file is released under the GPLv2.
 */

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

struct sysfs_open_dirent;

/* type-specific structures for sysfs_dirent->s_* union members */
struct sysfs_elem_dir {
	struct kobject		*kobj;
	/* children list starts here and goes through sd->s_sibling */
	struct sysfs_dirent	*children;
};

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;
	struct sysfs_dirent	*s_sibling;
	const char		*s_name;

	const void		*s_ns;
	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)

#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;
}

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