sysfs.h 5.9 KB
Newer Older
T
Tejun Heo 已提交
1 2 3 4 5 6 7 8 9 10
/*
 * 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.
 */

11
#include <linux/lockdep.h>
A
Alexey Dobriyan 已提交
12
#include <linux/kobject_ns.h>
13
#include <linux/fs.h>
14
#include <linux/rbtree.h>
15

T
Tejun Heo 已提交
16 17
struct sysfs_open_dirent;

T
Tejun Heo 已提交
18
/* type-specific structures for sysfs_dirent->s_* union members */
19
struct sysfs_elem_dir {
20
	unsigned long		subdirs;
21 22
	/* children rbtree starts here and goes through sd->s_rb */
	struct rb_root		children;
23 24 25
};

struct sysfs_elem_symlink {
T
Tejun Heo 已提交
26
	struct sysfs_dirent	*target_sd;
27 28 29
};

struct sysfs_elem_attr {
T
Tejun Heo 已提交
30
	struct sysfs_open_dirent *open;
31 32
};

33 34 35 36 37 38
struct sysfs_inode_attrs {
	struct iattr	ia_iattr;
	void		*ia_secdata;
	u32		ia_secdata_len;
};

39
/*
T
Tejun Heo 已提交
40 41 42
 * sysfs_dirent - the building block of sysfs hierarchy.  Each and
 * every sysfs node is represented by single sysfs_dirent.
 *
43 44 45 46
 * 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.
 */
47 48
struct sysfs_dirent {
	atomic_t		s_count;
49
	atomic_t		s_active;
50 51 52
#ifdef CONFIG_DEBUG_LOCK_ALLOC
	struct lockdep_map	dep_map;
#endif
T
Tejun Heo 已提交
53 54
	struct sysfs_dirent	*s_parent;
	const char		*s_name;
55

56
	struct rb_node		s_rb;
57

M
Mikulas Patocka 已提交
58 59 60 61 62
	union {
		struct completion	*completion;
		struct sysfs_dirent	*removed_list;
	} u;

63
	const void		*s_ns; /* namespace tag */
64
	unsigned int		s_hash; /* ns + name hash */
65
	union {
T
Tejun Heo 已提交
66 67 68 69
		struct sysfs_elem_dir		s_dir;
		struct sysfs_elem_symlink	s_symlink;
		struct sysfs_elem_attr		s_attr;
	};
70

71 72
	void			*priv;

73
	unsigned short		s_flags;
74
	umode_t			s_mode;
75
	unsigned int		s_ino;
76
	struct sysfs_inode_attrs *s_iattr;
77
};
L
Linus Torvalds 已提交
78

T
Tejun Heo 已提交
79
#define SD_DEACTIVATED_BIAS		INT_MIN
80

T
Tejun Heo 已提交
81
#define SYSFS_TYPE_MASK			0x00ff
82 83 84 85
#define SYSFS_DIR			0x0001
#define SYSFS_KOBJ_ATTR			0x0002
#define SYSFS_KOBJ_BIN_ATTR		0x0004
#define SYSFS_KOBJ_LINK			0x0008
T
Tejun Heo 已提交
86
#define SYSFS_COPY_NAME			(SYSFS_DIR | SYSFS_KOBJ_LINK)
87
#define SYSFS_ACTIVE_REF		(SYSFS_KOBJ_ATTR | SYSFS_KOBJ_BIN_ATTR)
T
Tejun Heo 已提交
88

89 90
#define SYSFS_FLAG_MASK			~SYSFS_TYPE_MASK
#define SYSFS_FLAG_NS			0x01000
91
#define SYSFS_FLAG_REMOVED		0x02000
T
Tejun Heo 已提交
92 93 94 95 96 97

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

98
#ifdef CONFIG_DEBUG_LOCK_ALLOC
99

100 101
#define sysfs_dirent_init_lockdep(sd)				\
do {								\
102
	struct attribute *attr = sd->priv;			\
103 104 105
	struct lock_class_key *key = attr->key;			\
	if (!key)						\
		key = &attr->skey;				\
106
								\
107
	lockdep_init_map(&sd->dep_map, "s_active", key, 0);	\
108
} while (0)
109 110 111 112

/* Test for attributes that want to ignore lockdep for read-locking */
static inline bool sysfs_ignore_lockdep(struct sysfs_dirent *sd)
{
113
	struct attribute *attr = sd->priv;
114 115 116
	int type = sysfs_type(sd);

	return (type == SYSFS_KOBJ_ATTR || type == SYSFS_KOBJ_BIN_ATTR) &&
117
		attr->ignore_lockdep;
118 119
}

120
#else
121

122
#define sysfs_dirent_init_lockdep(sd) do {} while (0)
123 124 125 126 127 128

static inline bool sysfs_ignore_lockdep(struct sysfs_dirent *sd)
{
	return true;
}

129 130
#endif

T
Tejun Heo 已提交
131 132 133
/*
 * Context structure to be used while adding/removing nodes.
 */
134 135 136 137
struct sysfs_addrm_cxt {
	struct sysfs_dirent	*removed;
};

T
Tejun Heo 已提交
138 139 140
/*
 * mount.c
 */
141 142

/*
143 144 145 146
 * Each sb is associated with one namespace tag, currently the network
 * namespace of the task which mounted this sysfs instance.  If multiple
 * tags become necessary, make the following an array and compare
 * sysfs_dirent tag against every entry.
147
 */
148
struct sysfs_super_info {
149
	void *ns;
150 151
};
#define sysfs_info(SB) ((struct sysfs_super_info *)(SB->s_fs_info))
152
extern struct sysfs_dirent sysfs_root;
153
extern struct kmem_cache *sysfs_dir_cachep;
L
Linus Torvalds 已提交
154

T
Tejun Heo 已提交
155 156 157
/*
 * dir.c
 */
158
extern struct mutex sysfs_mutex;
159
extern spinlock_t sysfs_symlink_target_lock;
160
extern const struct dentry_operations sysfs_dentry_ops;
T
Tejun Heo 已提交
161

162
extern const struct file_operations sysfs_dir_operations;
163
extern const struct inode_operations sysfs_dir_inode_operations;
L
Linus Torvalds 已提交
164

165 166
struct sysfs_dirent *sysfs_get_active(struct sysfs_dirent *sd);
void sysfs_put_active(struct sysfs_dirent *sd);
167
void sysfs_addrm_start(struct sysfs_addrm_cxt *acxt);
168
void sysfs_warn_dup(struct sysfs_dirent *parent, const char *name);
169 170 171 172
int __sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd,
		    struct sysfs_dirent *parent_sd);
int sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd,
		  struct sysfs_dirent *parent_sd);
T
Tejun Heo 已提交
173 174 175
void sysfs_addrm_finish(struct sysfs_addrm_cxt *acxt);

struct sysfs_dirent *sysfs_find_dirent(struct sysfs_dirent *parent_sd,
T
Tejun Heo 已提交
176 177
				       const unsigned char *name,
				       const void *ns);
T
Tejun Heo 已提交
178 179 180 181
struct sysfs_dirent *sysfs_new_dirent(const char *name, umode_t mode, int type);

void release_sysfs_dirent(struct sysfs_dirent *sd);

182
static inline struct sysfs_dirent *__sysfs_get(struct sysfs_dirent *sd)
L
Linus Torvalds 已提交
183
{
184 185 186 187 188
	if (sd) {
		WARN_ON(!atomic_read(&sd->s_count));
		atomic_inc(&sd->s_count);
	}
	return sd;
L
Linus Torvalds 已提交
189
}
190
#define sysfs_get(sd) __sysfs_get(sd)
L
Linus Torvalds 已提交
191

192
static inline void __sysfs_put(struct sysfs_dirent *sd)
L
Linus Torvalds 已提交
193
{
194 195 196
	if (sd && atomic_dec_and_test(&sd->s_count))
		release_sysfs_dirent(sd);
}
197
#define sysfs_put(sd) __sysfs_put(sd)
T
Tejun Heo 已提交
198 199 200 201

/*
 * inode.c
 */
202
struct inode *sysfs_get_inode(struct super_block *sb, struct sysfs_dirent *sd);
A
Al Viro 已提交
203
void sysfs_evict_inode(struct inode *inode);
204
int sysfs_permission(struct inode *inode, int mask);
T
Tejun Heo 已提交
205
int sysfs_setattr(struct dentry *dentry, struct iattr *iattr);
206 207
int sysfs_getattr(struct vfsmount *mnt, struct dentry *dentry,
		  struct kstat *stat);
208
int sysfs_setxattr(struct dentry *dentry, const char *name, const void *value,
209
		   size_t size, int flags);
P
Peter Zijlstra 已提交
210
int sysfs_inode_init(void);
T
Tejun Heo 已提交
211 212 213 214

/*
 * file.c
 */
215
extern const struct file_operations kernfs_file_operations;
T
Tejun Heo 已提交
216 217 218 219

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

220 221 222
int sysfs_add_file_mode_ns(struct sysfs_dirent *dir_sd,
			   const struct attribute *attr, int type,
			   umode_t amode, const void *ns);
223 224
void sysfs_unmap_bin_file(struct sysfs_dirent *sd);

T
Tejun Heo 已提交
225 226 227 228
/*
 * symlink.c
 */
extern const struct inode_operations sysfs_symlink_inode_operations;
229 230
int sysfs_create_link_sd(struct sysfs_dirent *sd, struct kobject *target,
			 const char *name);