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