2 * fs/sysfs/sysfs.h - sysfs internal header file
4 * Copyright (c) 2001-3 Patrick Mochel
5 * Copyright (c) 2007 SUSE Linux Products GmbH
6 * Copyright (c) 2007 Tejun Heo <teheo@suse.de>
8 * This file is released under the GPLv2.
11 #include <linux/lockdep.h>
12 #include <linux/kobject_ns.h>
14 #include <linux/rbtree.h>
16 struct sysfs_open_dirent
;
18 /* type-specific structures for sysfs_dirent->s_* union members */
19 struct sysfs_elem_dir
{
22 unsigned long subdirs
;
23 /* children rbtree starts here and goes through sd->s_rb */
24 struct rb_root children
;
27 struct sysfs_elem_symlink
{
28 struct sysfs_dirent
*target_sd
;
31 struct sysfs_elem_attr
{
33 struct attribute
*attr
;
34 struct bin_attribute
*bin_attr
;
36 struct sysfs_open_dirent
*open
;
39 struct sysfs_inode_attrs
{
40 struct iattr ia_iattr
;
46 * sysfs_dirent - the building block of sysfs hierarchy. Each and
47 * every sysfs node is represented by single sysfs_dirent.
49 * As long as s_count reference is held, the sysfs_dirent itself is
50 * accessible. Dereferencing s_elem or any other outer entity
51 * requires s_active reference.
56 #ifdef CONFIG_DEBUG_LOCK_ALLOC
57 struct lockdep_map dep_map
;
59 struct sysfs_dirent
*s_parent
;
65 struct completion
*completion
;
66 struct sysfs_dirent
*removed_list
;
69 const void *s_ns
; /* namespace tag */
70 unsigned int s_hash
; /* ns + name hash */
72 struct sysfs_elem_dir s_dir
;
73 struct sysfs_elem_symlink s_symlink
;
74 struct sysfs_elem_attr s_attr
;
77 unsigned short s_flags
;
80 struct sysfs_inode_attrs
*s_iattr
;
83 #define SD_DEACTIVATED_BIAS INT_MIN
85 #define SYSFS_TYPE_MASK 0x00ff
86 #define SYSFS_DIR 0x0001
87 #define SYSFS_KOBJ_ATTR 0x0002
88 #define SYSFS_KOBJ_BIN_ATTR 0x0004
89 #define SYSFS_KOBJ_LINK 0x0008
90 #define SYSFS_COPY_NAME (SYSFS_DIR | SYSFS_KOBJ_LINK)
91 #define SYSFS_ACTIVE_REF (SYSFS_KOBJ_ATTR | SYSFS_KOBJ_BIN_ATTR)
93 /* identify any namespace tag on sysfs_dirents */
94 #define SYSFS_NS_TYPE_MASK 0xf00
95 #define SYSFS_NS_TYPE_SHIFT 8
97 #define SYSFS_FLAG_MASK ~(SYSFS_NS_TYPE_MASK|SYSFS_TYPE_MASK)
98 #define SYSFS_FLAG_REMOVED 0x02000
100 static inline unsigned int sysfs_type(struct sysfs_dirent
*sd
)
102 return sd
->s_flags
& SYSFS_TYPE_MASK
;
106 * Return any namespace tags on this dirent.
107 * enum kobj_ns_type is defined in linux/kobject.h
109 static inline enum kobj_ns_type
sysfs_ns_type(struct sysfs_dirent
*sd
)
111 return (sd
->s_flags
& SYSFS_NS_TYPE_MASK
) >> SYSFS_NS_TYPE_SHIFT
;
114 #ifdef CONFIG_DEBUG_LOCK_ALLOC
116 #define sysfs_dirent_init_lockdep(sd) \
118 struct attribute *attr = sd->s_attr.attr; \
119 struct lock_class_key *key = attr->key; \
123 lockdep_init_map(&sd->dep_map, "s_active", key, 0); \
126 /* Test for attributes that want to ignore lockdep for read-locking */
127 static inline bool sysfs_ignore_lockdep(struct sysfs_dirent
*sd
)
129 int type
= sysfs_type(sd
);
131 return (type
== SYSFS_KOBJ_ATTR
|| type
== SYSFS_KOBJ_BIN_ATTR
) &&
132 sd
->s_attr
.attr
->ignore_lockdep
;
137 #define sysfs_dirent_init_lockdep(sd) do {} while (0)
139 static inline bool sysfs_ignore_lockdep(struct sysfs_dirent
*sd
)
147 * Context structure to be used while adding/removing nodes.
149 struct sysfs_addrm_cxt
{
150 struct sysfs_dirent
*removed
;
158 * Each sb is associated with a set of namespace tags (i.e.
159 * the network namespace of the task which mounted this sysfs
162 struct sysfs_super_info
{
163 void *ns
[KOBJ_NS_TYPES
];
165 #define sysfs_info(SB) ((struct sysfs_super_info *)(SB->s_fs_info))
166 extern struct sysfs_dirent sysfs_root
;
167 extern struct kmem_cache
*sysfs_dir_cachep
;
172 extern struct mutex sysfs_mutex
;
173 extern spinlock_t sysfs_symlink_target_lock
;
174 extern const struct dentry_operations sysfs_dentry_ops
;
176 extern const struct file_operations sysfs_dir_operations
;
177 extern const struct inode_operations sysfs_dir_inode_operations
;
179 struct sysfs_dirent
*sysfs_get_active(struct sysfs_dirent
*sd
);
180 void sysfs_put_active(struct sysfs_dirent
*sd
);
181 void sysfs_addrm_start(struct sysfs_addrm_cxt
*acxt
);
182 void sysfs_warn_dup(struct sysfs_dirent
*parent
, const char *name
);
183 int __sysfs_add_one(struct sysfs_addrm_cxt
*acxt
, struct sysfs_dirent
*sd
,
184 struct sysfs_dirent
*parent_sd
);
185 int sysfs_add_one(struct sysfs_addrm_cxt
*acxt
, struct sysfs_dirent
*sd
,
186 struct sysfs_dirent
*parent_sd
);
187 void sysfs_remove(struct sysfs_dirent
*sd
);
188 int sysfs_hash_and_remove(struct sysfs_dirent
*dir_sd
, const char *name
,
190 void sysfs_addrm_finish(struct sysfs_addrm_cxt
*acxt
);
192 struct sysfs_dirent
*sysfs_find_dirent(struct sysfs_dirent
*parent_sd
,
193 const unsigned char *name
,
195 struct sysfs_dirent
*sysfs_new_dirent(const char *name
, umode_t mode
, int type
);
197 void release_sysfs_dirent(struct sysfs_dirent
*sd
);
199 int sysfs_create_subdir(struct kobject
*kobj
, const char *name
,
200 struct sysfs_dirent
**p_sd
);
202 int sysfs_rename(struct sysfs_dirent
*sd
, struct sysfs_dirent
*new_parent_sd
,
203 const char *new_name
, const void *new_ns
);
205 static inline struct sysfs_dirent
*__sysfs_get(struct sysfs_dirent
*sd
)
208 WARN_ON(!atomic_read(&sd
->s_count
));
209 atomic_inc(&sd
->s_count
);
213 #define sysfs_get(sd) __sysfs_get(sd)
215 static inline void __sysfs_put(struct sysfs_dirent
*sd
)
217 if (sd
&& atomic_dec_and_test(&sd
->s_count
))
218 release_sysfs_dirent(sd
);
220 #define sysfs_put(sd) __sysfs_put(sd)
225 struct inode
*sysfs_get_inode(struct super_block
*sb
, struct sysfs_dirent
*sd
);
226 void sysfs_evict_inode(struct inode
*inode
);
227 int sysfs_sd_setattr(struct sysfs_dirent
*sd
, struct iattr
*iattr
);
228 int sysfs_permission(struct inode
*inode
, int mask
);
229 int sysfs_setattr(struct dentry
*dentry
, struct iattr
*iattr
);
230 int sysfs_getattr(struct vfsmount
*mnt
, struct dentry
*dentry
,
232 int sysfs_setxattr(struct dentry
*dentry
, const char *name
, const void *value
,
233 size_t size
, int flags
);
234 int sysfs_inode_init(void);
239 extern const struct file_operations sysfs_file_operations
;
240 extern const struct file_operations sysfs_bin_operations
;
242 int sysfs_add_file(struct sysfs_dirent
*dir_sd
,
243 const struct attribute
*attr
, int type
);
245 int sysfs_add_file_mode_ns(struct sysfs_dirent
*dir_sd
,
246 const struct attribute
*attr
, int type
,
247 umode_t amode
, const void *ns
);
248 void sysfs_unmap_bin_file(struct sysfs_dirent
*sd
);
253 extern const struct inode_operations sysfs_symlink_inode_operations
;
254 int sysfs_create_link_sd(struct sysfs_dirent
*sd
, struct kobject
*target
,