blob: 3adce7d5e4f7e506b102f509bb8e5ab611ec6588 [file] [log] [blame]
Tejun Heo85a4ffa2007-09-20 16:05:12 +09001struct sysfs_open_dirent;
2
Tejun Heo59f69012007-09-20 16:05:10 +09003/* type-specific structures for sysfs_dirent->s_* union members */
Tejun Heo3e519032007-06-14 03:45:15 +09004struct sysfs_elem_dir {
Tejun Heo59f69012007-09-20 16:05:10 +09005 struct kobject *kobj;
Tejun Heobc747f32007-09-20 16:05:12 +09006 /* children list starts here and goes through sd->s_sibling */
7 struct sysfs_dirent *children;
Tejun Heo3e519032007-06-14 03:45:15 +09008};
9
10struct sysfs_elem_symlink {
Tejun Heo59f69012007-09-20 16:05:10 +090011 struct sysfs_dirent *target_sd;
Tejun Heo3e519032007-06-14 03:45:15 +090012};
13
14struct sysfs_elem_attr {
Tejun Heo59f69012007-09-20 16:05:10 +090015 struct attribute *attr;
Tejun Heo85a4ffa2007-09-20 16:05:12 +090016 struct sysfs_open_dirent *open;
Tejun Heo3e519032007-06-14 03:45:15 +090017};
18
19struct sysfs_elem_bin_attr {
Tejun Heo59f69012007-09-20 16:05:10 +090020 struct bin_attribute *bin_attr;
Tejun Heo3e519032007-06-14 03:45:15 +090021};
22
Tejun Heo0ab66082007-06-14 03:45:16 +090023/*
Tejun Heo59f69012007-09-20 16:05:10 +090024 * sysfs_dirent - the building block of sysfs hierarchy. Each and
25 * every sysfs node is represented by single sysfs_dirent.
26 *
Tejun Heo0ab66082007-06-14 03:45:16 +090027 * 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 */
Adam J. Richterd56c3ea2007-02-16 21:35:25 +080031struct sysfs_dirent {
32 atomic_t s_count;
Tejun Heo8619f972007-06-14 03:45:18 +090033 atomic_t s_active;
Tejun Heo59f69012007-09-20 16:05:10 +090034 struct sysfs_dirent *s_parent;
35 struct sysfs_dirent *s_sibling;
Tejun Heo59f69012007-09-20 16:05:10 +090036 const char *s_name;
Tejun Heo3e519032007-06-14 03:45:15 +090037
38 union {
Tejun Heob1fc3d62007-09-20 16:05:11 +090039 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 };
Tejun Heo3e519032007-06-14 03:45:15 +090044
Tejun Heob402d722007-06-14 04:27:21 +090045 unsigned int s_flags;
Eric Sandeendc351252007-06-11 14:02:45 +090046 ino_t s_ino;
Tejun Heob13dc892007-09-20 16:05:10 +090047 umode_t s_mode;
Tejun Heo59f69012007-09-20 16:05:10 +090048 struct iattr *s_iattr;
Adam J. Richterd56c3ea2007-02-16 21:35:25 +080049 atomic_t s_event;
50};
Linus Torvalds1da177e2005-04-16 15:20:36 -070051
Tejun Heo59f69012007-09-20 16:05:10 +090052#define SD_DEACTIVATED_BIAS INT_MIN
Tejun Heo0ab66082007-06-14 03:45:16 +090053
Tejun Heo59f69012007-09-20 16:05:10 +090054#define SYSFS_TYPE_MASK 0x00ff
Tejun Heodc2f75f2007-09-20 16:05:12 +090055#define SYSFS_DIR 0x0001
56#define SYSFS_KOBJ_ATTR 0x0002
57#define SYSFS_KOBJ_BIN_ATTR 0x0004
58#define SYSFS_KOBJ_LINK 0x0008
Tejun Heo59f69012007-09-20 16:05:10 +090059#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
64static 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 */
Tejun Heofb6896d2007-06-14 04:27:24 +090072struct sysfs_addrm_cxt {
73 struct sysfs_dirent *parent_sd;
74 struct inode *parent_inode;
75 struct sysfs_dirent *removed;
76 int cnt;
77};
78
Tejun Heo59f69012007-09-20 16:05:10 +090079/*
80 * mount.c
81 */
Tejun Heo51225032007-06-14 04:27:25 +090082extern struct sysfs_dirent sysfs_root;
Tejun Heo59f69012007-09-20 16:05:10 +090083extern struct super_block *sysfs_sb;
Christoph Lametere18b8902006-12-06 20:33:20 -080084extern struct kmem_cache *sysfs_dir_cachep;
Linus Torvalds1da177e2005-04-16 15:20:36 -070085
Tejun Heo59f69012007-09-20 16:05:10 +090086/*
87 * dir.c
88 */
Tejun Heo3007e992007-06-14 04:27:23 +090089extern struct mutex sysfs_mutex;
Eric W. Biederman932ea2e2007-08-20 21:36:30 +090090extern struct mutex sysfs_rename_mutex;
Tejun Heo59f69012007-09-20 16:05:10 +090091extern spinlock_t sysfs_assoc_lock;
92
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -080093extern const struct file_operations sysfs_dir_operations;
Arjan van de Venc5ef1c42007-02-12 00:55:40 -080094extern const struct inode_operations sysfs_dir_inode_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -070095
Tejun Heo59f69012007-09-20 16:05:10 +090096struct dentry *sysfs_get_dentry(struct sysfs_dirent *sd);
97struct sysfs_dirent *sysfs_get_active(struct sysfs_dirent *sd);
98void sysfs_put_active(struct sysfs_dirent *sd);
99struct sysfs_dirent *sysfs_get_active_two(struct sysfs_dirent *sd);
100void sysfs_put_active_two(struct sysfs_dirent *sd);
101void sysfs_addrm_start(struct sysfs_addrm_cxt *acxt,
102 struct sysfs_dirent *parent_sd);
103int sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd);
104void sysfs_remove_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd);
105void sysfs_addrm_finish(struct sysfs_addrm_cxt *acxt);
Tejun Heob402d722007-06-14 04:27:21 +0900106
Tejun Heo59f69012007-09-20 16:05:10 +0900107struct sysfs_dirent *sysfs_find_dirent(struct sysfs_dirent *parent_sd,
108 const unsigned char *name);
109struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
110 const unsigned char *name);
111struct sysfs_dirent *sysfs_new_dirent(const char *name, umode_t mode, int type);
112
113void release_sysfs_dirent(struct sysfs_dirent *sd);
114
115int sysfs_create_subdir(struct kobject *kobj, const char *name,
116 struct sysfs_dirent **p_sd);
117void sysfs_remove_subdir(struct sysfs_dirent *sd);
118
119static inline struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120{
121 if (sd) {
122 WARN_ON(!atomic_read(&sd->s_count));
123 atomic_inc(&sd->s_count);
124 }
125 return sd;
126}
127
Tejun Heo59f69012007-09-20 16:05:10 +0900128static inline void sysfs_put(struct sysfs_dirent *sd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129{
Tejun Heo7a23ad42007-06-14 03:45:13 +0900130 if (sd && atomic_dec_and_test(&sd->s_count))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131 release_sysfs_dirent(sd);
132}
Tejun Heo59f69012007-09-20 16:05:10 +0900133
134/*
135 * inode.c
136 */
137struct inode *sysfs_get_inode(struct sysfs_dirent *sd);
138int sysfs_setattr(struct dentry *dentry, struct iattr *iattr);
139int sysfs_hash_and_remove(struct sysfs_dirent *dir_sd, const char *name);
140
141/*
142 * file.c
143 */
144extern const struct file_operations sysfs_file_operations;
145
146int sysfs_add_file(struct sysfs_dirent *dir_sd,
147 const struct attribute *attr, int type);
148
149/*
150 * bin.c
151 */
152extern const struct file_operations bin_fops;
153
154/*
155 * symlink.c
156 */
157extern const struct inode_operations sysfs_symlink_inode_operations;