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

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

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

#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_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_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);
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);
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;

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