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 {
32 struct attribute *attr;
33 struct sysfs_open_dirent *open;
36 struct sysfs_elem_bin_attr {
37 struct bin_attribute *bin_attr;
38 struct hlist_head buffers;
41 struct sysfs_inode_attrs {
42 struct iattr ia_iattr;
48 * sysfs_dirent - the building block of sysfs hierarchy. Each and
49 * every sysfs node is represented by single sysfs_dirent.
51 * As long as s_count reference is held, the sysfs_dirent itself is
52 * accessible. Dereferencing s_elem or any other outer entity
53 * requires s_active reference.
58 #ifdef CONFIG_DEBUG_LOCK_ALLOC
59 struct lockdep_map dep_map;
61 struct sysfs_dirent *s_parent;
67 struct completion *completion;
68 struct sysfs_dirent *removed_list;
71 const void *s_ns; /* namespace tag */
72 unsigned int s_hash; /* ns + name hash */
74 struct sysfs_elem_dir s_dir;
75 struct sysfs_elem_symlink s_symlink;
76 struct sysfs_elem_attr s_attr;
77 struct sysfs_elem_bin_attr s_bin_attr;
80 unsigned short s_flags;
83 struct sysfs_inode_attrs *s_iattr;
86 #define SD_DEACTIVATED_BIAS INT_MIN
88 #define SYSFS_TYPE_MASK 0x00ff
89 #define SYSFS_DIR 0x0001
90 #define SYSFS_KOBJ_ATTR 0x0002
91 #define SYSFS_KOBJ_BIN_ATTR 0x0004
92 #define SYSFS_KOBJ_LINK 0x0008
93 #define SYSFS_COPY_NAME (SYSFS_DIR | SYSFS_KOBJ_LINK)
94 #define SYSFS_ACTIVE_REF (SYSFS_KOBJ_ATTR | SYSFS_KOBJ_BIN_ATTR)
96 #define SYSFS_FLAG_MASK ~SYSFS_TYPE_MASK
97 #define SYSFS_FLAG_HAS_NS 0x01000
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;
105 #ifdef CONFIG_DEBUG_LOCK_ALLOC
107 #define sysfs_dirent_init_lockdep(sd) \
109 struct attribute *attr = sd->s_attr.attr; \
110 struct lock_class_key *key = attr->key; \
114 lockdep_init_map(&sd->dep_map, "s_active", key, 0); \
117 /* Test for attributes that want to ignore lockdep for read-locking */
118 static inline bool sysfs_ignore_lockdep(struct sysfs_dirent *sd)
120 return sysfs_type(sd) == SYSFS_KOBJ_ATTR &&
121 sd->s_attr.attr->ignore_lockdep;
126 #define sysfs_dirent_init_lockdep(sd) do {} while (0)
128 static inline bool sysfs_ignore_lockdep(struct sysfs_dirent *sd)
136 * Context structure to be used while adding/removing nodes.
138 struct sysfs_addrm_cxt {
139 struct sysfs_dirent *removed;
147 * Each sb is associated with one namespace tag, currently the network
148 * namespace of the task which mounted this sysfs instance. If multiple
149 * tags become necessary, make the following an array and compare
150 * sysfs_dirent tag against every entry.
152 struct sysfs_super_info {
155 #define sysfs_info(SB) ((struct sysfs_super_info *)(SB->s_fs_info))
156 extern struct sysfs_dirent sysfs_root;
157 extern struct kmem_cache *sysfs_dir_cachep;
162 extern struct mutex sysfs_mutex;
163 extern spinlock_t sysfs_assoc_lock;
164 extern const struct dentry_operations sysfs_dentry_ops;
166 extern const struct file_operations sysfs_dir_operations;
167 extern const struct inode_operations sysfs_dir_inode_operations;
169 struct dentry *sysfs_get_dentry(struct sysfs_dirent *sd);
170 struct sysfs_dirent *sysfs_get_active(struct sysfs_dirent *sd);
171 void sysfs_put_active(struct sysfs_dirent *sd);
172 void sysfs_addrm_start(struct sysfs_addrm_cxt *acxt);
173 int __sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd,
174 struct sysfs_dirent *parent_sd);
175 int sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd,
176 struct sysfs_dirent *parent_sd);
177 void __sysfs_remove(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd);
178 void sysfs_remove(struct sysfs_dirent *sd);
179 void sysfs_addrm_finish(struct sysfs_addrm_cxt *acxt);
181 struct sysfs_dirent *sysfs_find_dirent(struct sysfs_dirent *parent_sd,
182 const unsigned char *name,
184 struct sysfs_dirent *sysfs_new_dirent(const char *name, umode_t mode, int type);
186 void release_sysfs_dirent(struct sysfs_dirent *sd);
188 int sysfs_create_subdir(struct kobject *kobj, const char *name,
189 struct sysfs_dirent **p_sd);
191 int sysfs_rename(struct sysfs_dirent *sd, struct sysfs_dirent *new_parent_sd,
192 const char *new_name, const void *new_ns);
194 static inline struct sysfs_dirent *__sysfs_get(struct sysfs_dirent *sd)
197 WARN_ON(!atomic_read(&sd->s_count));
198 atomic_inc(&sd->s_count);
202 #define sysfs_get(sd) __sysfs_get(sd)
204 static inline void __sysfs_put(struct sysfs_dirent *sd)
206 if (sd && atomic_dec_and_test(&sd->s_count))
207 release_sysfs_dirent(sd);
209 #define sysfs_put(sd) __sysfs_put(sd)
214 struct inode *sysfs_get_inode(struct super_block *sb, struct sysfs_dirent *sd);
215 void sysfs_evict_inode(struct inode *inode);
216 int sysfs_sd_setattr(struct sysfs_dirent *sd, struct iattr *iattr);
217 int sysfs_permission(struct inode *inode, int mask);
218 int sysfs_setattr(struct dentry *dentry, struct iattr *iattr);
219 int sysfs_getattr(struct vfsmount *mnt, struct dentry *dentry,
221 int sysfs_setxattr(struct dentry *dentry, const char *name, const void *value,
222 size_t size, int flags);
223 int sysfs_hash_and_remove(struct sysfs_dirent *dir_sd, const char *name,
225 int sysfs_inode_init(void);
230 extern const struct file_operations sysfs_file_operations;
231 extern const struct file_operations sysfs_bin_operations;
233 int sysfs_add_file(struct sysfs_dirent *dir_sd,
234 const struct attribute *attr, int type);
236 int sysfs_add_file_mode_ns(struct sysfs_dirent *dir_sd,
237 const struct attribute *attr, int type,
238 umode_t amode, const void *ns);
239 void sysfs_unmap_bin_file(struct sysfs_dirent *sd);
244 extern const struct inode_operations sysfs_symlink_inode_operations;
245 int sysfs_create_link_sd(struct sysfs_dirent *sd, struct kobject *target,