[mirror_ubuntu-artful-kernel.git] / fs / sysfs / sysfs.h

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

struct sysfs_elem_symlink {
	struct sysfs_dirent	*target_sd;
};

struct sysfs_elem_attr {
	struct attribute	*attr;
};

struct sysfs_elem_bin_attr {
	struct bin_attribute	*bin_attr;
};

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

	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;
	ino_t			s_ino;
	umode_t			s_mode;
	struct iattr		*s_iattr;
	atomic_t		s_event;
};

#define SD_DEACTIVATED_BIAS		INT_MIN

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

#define SYSFS_FLAG_MASK			~SYSFS_TYPE_MASK
#define SYSFS_FLAG_REMOVED		0x0200

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

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

/*
 * mount.c
 */
extern struct sysfs_dirent sysfs_root;
extern struct super_block *sysfs_sb;
extern struct kmem_cache *sysfs_dir_cachep;

/*
 * dir.c
 */
extern struct mutex sysfs_mutex;
extern struct mutex sysfs_rename_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);
struct sysfs_dirent *sysfs_get_active_two(struct sysfs_dirent *sd);
void sysfs_put_active_two(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);
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 unsigned char *name);
struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
				      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);

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

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

/*
 * inode.c
 */
struct inode *sysfs_get_inode(struct sysfs_dirent *sd);
int sysfs_setattr(struct dentry *dentry, struct iattr *iattr);
int sysfs_hash_and_remove(struct sysfs_dirent *dir_sd, const char *name);

/*
 * 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);

/*
 * bin.c
 */
extern const struct file_operations bin_fops;

/*
 * symlink.c
 */
extern const struct inode_operations sysfs_symlink_inode_operations;
Commit	Line	Data
59f69015	1	/* type-specific structures for sysfs_dirent->s_* union members */
3e519038	2	struct sysfs_elem_dir {
59f69015	3	struct kobject *kobj;
3e519038 TH	4	};
	5
	6	struct sysfs_elem_symlink {
59f69015	7	struct sysfs_dirent *target_sd;
3e519038 TH	8	};
	9
	10	struct sysfs_elem_attr {
59f69015	11	struct attribute *attr;
3e519038 TH	12	};
	13
	14	struct sysfs_elem_bin_attr {
59f69015	15	struct bin_attribute *bin_attr;
3e519038 TH	16	};
3e519038 TH	17
0ab66088	18	/*
59f69015 TH	19	* sysfs_dirent - the building block of sysfs hierarchy. Each and
	20	* every sysfs node is represented by single sysfs_dirent.
	21	*
0ab66088 TH	22	* As long as s_count reference is held, the sysfs_dirent itself is
	23	* accessible. Dereferencing s_elem or any other outer entity
	24	* requires s_active reference.
	25	*/
d56c3eae AR	26	struct sysfs_dirent {
d56c3eae AR	27	atomic_t s_count;
8619f979	28	atomic_t s_active;
59f69015 TH	29	struct sysfs_dirent *s_parent;
	30	struct sysfs_dirent *s_sibling;
	31	struct sysfs_dirent *s_children;
	32	const char *s_name;
3e519038 TH	33
3e519038 TH	34	union {
b1fc3d61 TH	35	struct sysfs_elem_dir s_dir;
	36	struct sysfs_elem_symlink s_symlink;
	37	struct sysfs_elem_attr s_attr;
	38	struct sysfs_elem_bin_attr s_bin_attr;
	39	};
3e519038	40
b402d72c	41	unsigned int s_flags;
dc351252	42	ino_t s_ino;
b13dc89c	43	umode_t s_mode;
59f69015	44	struct iattr *s_iattr;
d56c3eae AR	45	atomic_t s_event;
d56c3eae AR	46	};
1da177e4	47
59f69015	48	#define SD_DEACTIVATED_BIAS INT_MIN
0ab66088	49
59f69015 TH	50	#define SYSFS_TYPE_MASK 0x00ff
	51	#define SYSFS_ROOT 0x0001
	52	#define SYSFS_DIR 0x0002
	53	#define SYSFS_KOBJ_ATTR 0x0004
	54	#define SYSFS_KOBJ_BIN_ATTR 0x0008
	55	#define SYSFS_KOBJ_LINK 0x0020
	56	#define SYSFS_COPY_NAME (SYSFS_DIR \| SYSFS_KOBJ_LINK)
	57
	58	#define SYSFS_FLAG_MASK ~SYSFS_TYPE_MASK
	59	#define SYSFS_FLAG_REMOVED 0x0200
	60
	61	static inline unsigned int sysfs_type(struct sysfs_dirent *sd)
	62	{
	63	return sd->s_flags & SYSFS_TYPE_MASK;
	64	}
	65
	66	/*
	67	* Context structure to be used while adding/removing nodes.
	68	*/
fb6896da TH	69	struct sysfs_addrm_cxt {
	70	struct sysfs_dirent *parent_sd;
	71	struct inode *parent_inode;
	72	struct sysfs_dirent *removed;
	73	int cnt;
	74	};
	75
59f69015 TH	76	/*
	77	* mount.c
	78	*/
51225039	79	extern struct sysfs_dirent sysfs_root;
59f69015	80	extern struct super_block *sysfs_sb;
e18b890b	81	extern struct kmem_cache *sysfs_dir_cachep;
1da177e4	82
59f69015 TH	83	/*
	84	* dir.c
	85	*/
3007e997	86	extern struct mutex sysfs_mutex;
932ea2e3	87	extern struct mutex sysfs_rename_mutex;
59f69015 TH	88	extern spinlock_t sysfs_assoc_lock;
59f69015 TH	89
4b6f5d20	90	extern const struct file_operations sysfs_dir_operations;
c5ef1c42	91	extern const struct inode_operations sysfs_dir_inode_operations;
1da177e4	92
59f69015 TH	93	struct dentry sysfs_get_dentry(struct sysfs_dirent sd);
	94	struct sysfs_dirent sysfs_get_active(struct sysfs_dirent sd);
	95	void sysfs_put_active(struct sysfs_dirent *sd);
	96	struct sysfs_dirent sysfs_get_active_two(struct sysfs_dirent sd);
	97	void sysfs_put_active_two(struct sysfs_dirent *sd);
	98	void sysfs_addrm_start(struct sysfs_addrm_cxt *acxt,
	99	struct sysfs_dirent *parent_sd);
	100	int sysfs_add_one(struct sysfs_addrm_cxt acxt, struct sysfs_dirent sd);
	101	void sysfs_remove_one(struct sysfs_addrm_cxt acxt, struct sysfs_dirent sd);
	102	void sysfs_addrm_finish(struct sysfs_addrm_cxt *acxt);
	103
	104	struct sysfs_dirent sysfs_find_dirent(struct sysfs_dirent parent_sd,
	105	const unsigned char *name);
	106	struct sysfs_dirent sysfs_get_dirent(struct sysfs_dirent parent_sd,
	107	const unsigned char *name);
	108	struct sysfs_dirent sysfs_new_dirent(const char name, umode_t mode, int type);
	109
	110	void release_sysfs_dirent(struct sysfs_dirent *sd);
	111
	112	int sysfs_create_subdir(struct kobject kobj, const char name,
	113	struct sysfs_dirent **p_sd);
	114	void sysfs_remove_subdir(struct sysfs_dirent *sd);
	115
	116	static inline struct sysfs_dirent sysfs_get(struct sysfs_dirent sd)
1da177e4	117	{
0ab66088 TH	118	if (sd) {
	119	WARN_ON(!atomic_read(&sd->s_count));
	120	atomic_inc(&sd->s_count);
	121	}
	122	return sd;
1da177e4 LT	123	}
1da177e4 LT	124
59f69015	125	static inline void sysfs_put(struct sysfs_dirent *sd)
1da177e4	126	{
0ab66088 TH	127	if (sd && atomic_dec_and_test(&sd->s_count))
	128	release_sysfs_dirent(sd);
	129	}
59f69015 TH	130
	131	/*
	132	* inode.c
	133	*/
	134	struct inode sysfs_get_inode(struct sysfs_dirent sd);
	135	int sysfs_setattr(struct dentry dentry, struct iattr iattr);
	136	int sysfs_hash_and_remove(struct sysfs_dirent dir_sd, const char name);
	137
	138	/*
	139	* file.c
	140	*/
	141	extern const struct file_operations sysfs_file_operations;
	142
	143	int sysfs_add_file(struct sysfs_dirent *dir_sd,
	144	const struct attribute *attr, int type);
	145
	146	/*
	147	* bin.c
	148	*/
	149	extern const struct file_operations bin_fops;
	150
	151	/*
	152	* symlink.c
	153	*/
	154	extern const struct inode_operations sysfs_symlink_inode_operations;