Merge branch 'samsung/exynos5' into next/soc2
[linux-2.6.git] / fs / sysfs / sysfs.h
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
11 #include <linux/lockdep.h>
12 #include <linux/kobject_ns.h>
13 #include <linux/fs.h>
14 #include <linux/rbtree.h>
15
16 struct sysfs_open_dirent;
17
18 /* type-specific structures for sysfs_dirent->s_* union members */
19 struct sysfs_elem_dir {
20         struct kobject          *kobj;
21
22         /* children rbtree starts here and goes through sd->s_rb */
23         struct rb_root          children;
24 };
25
26 struct sysfs_elem_symlink {
27         struct sysfs_dirent     *target_sd;
28 };
29
30 struct sysfs_elem_attr {
31         struct attribute        *attr;
32         struct sysfs_open_dirent *open;
33 };
34
35 struct sysfs_elem_bin_attr {
36         struct bin_attribute    *bin_attr;
37         struct hlist_head       buffers;
38 };
39
40 struct sysfs_inode_attrs {
41         struct iattr    ia_iattr;
42         void            *ia_secdata;
43         u32             ia_secdata_len;
44 };
45
46 /*
47  * sysfs_dirent - the building block of sysfs hierarchy.  Each and
48  * every sysfs node is represented by single sysfs_dirent.
49  *
50  * As long as s_count reference is held, the sysfs_dirent itself is
51  * accessible.  Dereferencing s_elem or any other outer entity
52  * requires s_active reference.
53  */
54 struct sysfs_dirent {
55         atomic_t                s_count;
56         atomic_t                s_active;
57 #ifdef CONFIG_DEBUG_LOCK_ALLOC
58         struct lockdep_map      dep_map;
59 #endif
60         struct sysfs_dirent     *s_parent;
61         const char              *s_name;
62
63         struct rb_node          s_rb;
64
65         union {
66                 struct completion       *completion;
67                 struct sysfs_dirent     *removed_list;
68         } u;
69
70         const void              *s_ns; /* namespace tag */
71         unsigned int            s_hash; /* ns + name hash */
72         union {
73                 struct sysfs_elem_dir           s_dir;
74                 struct sysfs_elem_symlink       s_symlink;
75                 struct sysfs_elem_attr          s_attr;
76                 struct sysfs_elem_bin_attr      s_bin_attr;
77         };
78
79         unsigned short          s_flags;
80         umode_t                 s_mode;
81         unsigned int            s_ino;
82         struct sysfs_inode_attrs *s_iattr;
83 };
84
85 #define SD_DEACTIVATED_BIAS             INT_MIN
86
87 #define SYSFS_TYPE_MASK                 0x00ff
88 #define SYSFS_DIR                       0x0001
89 #define SYSFS_KOBJ_ATTR                 0x0002
90 #define SYSFS_KOBJ_BIN_ATTR             0x0004
91 #define SYSFS_KOBJ_LINK                 0x0008
92 #define SYSFS_COPY_NAME                 (SYSFS_DIR | SYSFS_KOBJ_LINK)
93 #define SYSFS_ACTIVE_REF                (SYSFS_KOBJ_ATTR | SYSFS_KOBJ_BIN_ATTR)
94
95 /* identify any namespace tag on sysfs_dirents */
96 #define SYSFS_NS_TYPE_MASK              0xf00
97 #define SYSFS_NS_TYPE_SHIFT             8
98
99 #define SYSFS_FLAG_MASK                 ~(SYSFS_NS_TYPE_MASK|SYSFS_TYPE_MASK)
100 #define SYSFS_FLAG_REMOVED              0x02000
101
102 static inline unsigned int sysfs_type(struct sysfs_dirent *sd)
103 {
104         return sd->s_flags & SYSFS_TYPE_MASK;
105 }
106
107 /*
108  * Return any namespace tags on this dirent.
109  * enum kobj_ns_type is defined in linux/kobject.h
110  */
111 static inline enum kobj_ns_type sysfs_ns_type(struct sysfs_dirent *sd)
112 {
113         return (sd->s_flags & SYSFS_NS_TYPE_MASK) >> SYSFS_NS_TYPE_SHIFT;
114 }
115
116 #ifdef CONFIG_DEBUG_LOCK_ALLOC
117 #define sysfs_dirent_init_lockdep(sd)                           \
118 do {                                                            \
119         struct attribute *attr = sd->s_attr.attr;               \
120         struct lock_class_key *key = attr->key;                 \
121         if (!key)                                               \
122                 key = &attr->skey;                              \
123                                                                 \
124         lockdep_init_map(&sd->dep_map, "s_active", key, 0);     \
125 } while(0)
126 #else
127 #define sysfs_dirent_init_lockdep(sd) do {} while(0)
128 #endif
129
130 /*
131  * Context structure to be used while adding/removing nodes.
132  */
133 struct sysfs_addrm_cxt {
134         struct sysfs_dirent     *parent_sd;
135         struct sysfs_dirent     *removed;
136 };
137
138 /*
139  * mount.c
140  */
141
142 /*
143  * Each sb is associated with a set of namespace tags (i.e.
144  * the network namespace of the task which mounted this sysfs
145  * instance).
146  */
147 struct sysfs_super_info {
148         void *ns[KOBJ_NS_TYPES];
149 };
150 #define sysfs_info(SB) ((struct sysfs_super_info *)(SB->s_fs_info))
151 extern struct sysfs_dirent sysfs_root;
152 extern struct kmem_cache *sysfs_dir_cachep;
153
154 /*
155  * dir.c
156  */
157 extern struct mutex sysfs_mutex;
158 extern spinlock_t sysfs_assoc_lock;
159
160 extern const struct file_operations sysfs_dir_operations;
161 extern const struct inode_operations sysfs_dir_inode_operations;
162
163 struct dentry *sysfs_get_dentry(struct sysfs_dirent *sd);
164 struct sysfs_dirent *sysfs_get_active(struct sysfs_dirent *sd);
165 void sysfs_put_active(struct sysfs_dirent *sd);
166 void sysfs_addrm_start(struct sysfs_addrm_cxt *acxt,
167                        struct sysfs_dirent *parent_sd);
168 int __sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd);
169 int sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd);
170 void sysfs_remove_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd);
171 void sysfs_addrm_finish(struct sysfs_addrm_cxt *acxt);
172
173 struct sysfs_dirent *sysfs_find_dirent(struct sysfs_dirent *parent_sd,
174                                        const void *ns,
175                                        const unsigned char *name);
176 struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
177                                       const void *ns,
178                                       const unsigned char *name);
179 struct sysfs_dirent *sysfs_new_dirent(const char *name, umode_t mode, int type);
180
181 void release_sysfs_dirent(struct sysfs_dirent *sd);
182
183 int sysfs_create_subdir(struct kobject *kobj, const char *name,
184                         struct sysfs_dirent **p_sd);
185 void sysfs_remove_subdir(struct sysfs_dirent *sd);
186
187 int sysfs_rename(struct sysfs_dirent *sd,
188         struct sysfs_dirent *new_parent_sd, const void *ns, const char *new_name);
189
190 static inline struct sysfs_dirent *__sysfs_get(struct sysfs_dirent *sd)
191 {
192         if (sd) {
193                 WARN_ON(!atomic_read(&sd->s_count));
194                 atomic_inc(&sd->s_count);
195         }
196         return sd;
197 }
198 #define sysfs_get(sd) __sysfs_get(sd)
199
200 static inline void __sysfs_put(struct sysfs_dirent *sd)
201 {
202         if (sd && atomic_dec_and_test(&sd->s_count))
203                 release_sysfs_dirent(sd);
204 }
205 #define sysfs_put(sd) __sysfs_put(sd)
206
207 /*
208  * inode.c
209  */
210 struct inode *sysfs_get_inode(struct super_block *sb, struct sysfs_dirent *sd);
211 void sysfs_evict_inode(struct inode *inode);
212 int sysfs_sd_setattr(struct sysfs_dirent *sd, struct iattr *iattr);
213 int sysfs_permission(struct inode *inode, int mask);
214 int sysfs_setattr(struct dentry *dentry, struct iattr *iattr);
215 int sysfs_getattr(struct vfsmount *mnt, struct dentry *dentry, struct kstat *stat);
216 int sysfs_setxattr(struct dentry *dentry, const char *name, const void *value,
217                 size_t size, int flags);
218 int sysfs_hash_and_remove(struct sysfs_dirent *dir_sd, const void *ns, const char *name);
219 int sysfs_inode_init(void);
220
221 /*
222  * file.c
223  */
224 extern const struct file_operations sysfs_file_operations;
225
226 int sysfs_add_file(struct sysfs_dirent *dir_sd,
227                    const struct attribute *attr, int type);
228
229 int sysfs_add_file_mode(struct sysfs_dirent *dir_sd,
230                         const struct attribute *attr, int type, umode_t amode);
231 /*
232  * bin.c
233  */
234 extern const struct file_operations bin_fops;
235 void unmap_bin_file(struct sysfs_dirent *attr_sd);
236
237 /*
238  * symlink.c
239  */
240 extern const struct inode_operations sysfs_symlink_inode_operations;