blob: 269c845c590f3bdca607f1755841184c81582353 [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};
Linus Torvalds1da177e2005-04-16 15:20:36 -070050
Tejun Heo59f69012007-09-20 16:05:10 +090051#define SD_DEACTIVATED_BIAS INT_MIN
Tejun Heo0ab66082007-06-14 03:45:16 +090052
Tejun Heo59f69012007-09-20 16:05:10 +090053#define SYSFS_TYPE_MASK 0x00ff
Tejun Heodc2f75f2007-09-20 16:05:12 +090054#define SYSFS_DIR 0x0001
55#define SYSFS_KOBJ_ATTR 0x0002
56#define SYSFS_KOBJ_BIN_ATTR 0x0004
57#define SYSFS_KOBJ_LINK 0x0008
Tejun Heo59f69012007-09-20 16:05:10 +090058#define SYSFS_COPY_NAME (SYSFS_DIR | SYSFS_KOBJ_LINK)
59
60#define SYSFS_FLAG_MASK ~SYSFS_TYPE_MASK
61#define SYSFS_FLAG_REMOVED 0x0200
62
63static inline unsigned int sysfs_type(struct sysfs_dirent *sd)
64{
65 return sd->s_flags & SYSFS_TYPE_MASK;
66}
67
68/*
69 * Context structure to be used while adding/removing nodes.
70 */
Tejun Heofb6896da2007-06-14 04:27:24 +090071struct sysfs_addrm_cxt {
72 struct sysfs_dirent *parent_sd;
73 struct inode *parent_inode;
74 struct sysfs_dirent *removed;
75 int cnt;
76};
77
Tejun Heo59f69012007-09-20 16:05:10 +090078/*
79 * mount.c
80 */
Tejun Heo51225032007-06-14 04:27:25 +090081extern struct sysfs_dirent sysfs_root;
Tejun Heo59f69012007-09-20 16:05:10 +090082extern struct super_block *sysfs_sb;
Christoph Lametere18b8902006-12-06 20:33:20 -080083extern struct kmem_cache *sysfs_dir_cachep;
Linus Torvalds1da177e2005-04-16 15:20:36 -070084
Tejun Heo59f69012007-09-20 16:05:10 +090085/*
86 * dir.c
87 */
Tejun Heo3007e992007-06-14 04:27:23 +090088extern struct mutex sysfs_mutex;
Eric W. Biederman932ea2e2007-08-20 21:36:30 +090089extern struct mutex sysfs_rename_mutex;
Tejun Heo59f69012007-09-20 16:05:10 +090090extern spinlock_t sysfs_assoc_lock;
91
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -080092extern const struct file_operations sysfs_dir_operations;
Arjan van de Venc5ef1c42007-02-12 00:55:40 -080093extern const struct inode_operations sysfs_dir_inode_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -070094
Tejun Heo59f69012007-09-20 16:05:10 +090095struct dentry *sysfs_get_dentry(struct sysfs_dirent *sd);
96struct sysfs_dirent *sysfs_get_active(struct sysfs_dirent *sd);
97void sysfs_put_active(struct sysfs_dirent *sd);
98struct sysfs_dirent *sysfs_get_active_two(struct sysfs_dirent *sd);
99void sysfs_put_active_two(struct sysfs_dirent *sd);
100void sysfs_addrm_start(struct sysfs_addrm_cxt *acxt,
101 struct sysfs_dirent *parent_sd);
102int sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd);
103void sysfs_remove_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd);
104void sysfs_addrm_finish(struct sysfs_addrm_cxt *acxt);
Tejun Heob402d722007-06-14 04:27:21 +0900105
Tejun Heo59f69012007-09-20 16:05:10 +0900106struct sysfs_dirent *sysfs_find_dirent(struct sysfs_dirent *parent_sd,
107 const unsigned char *name);
108struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
109 const unsigned char *name);
110struct sysfs_dirent *sysfs_new_dirent(const char *name, umode_t mode, int type);
111
112void release_sysfs_dirent(struct sysfs_dirent *sd);
113
114int sysfs_create_subdir(struct kobject *kobj, const char *name,
115 struct sysfs_dirent **p_sd);
116void sysfs_remove_subdir(struct sysfs_dirent *sd);
117
118static inline struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119{
120 if (sd) {
121 WARN_ON(!atomic_read(&sd->s_count));
122 atomic_inc(&sd->s_count);
123 }
124 return sd;
125}
126
Tejun Heo59f69012007-09-20 16:05:10 +0900127static inline void sysfs_put(struct sysfs_dirent *sd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128{
Tejun Heo7a23ad42007-06-14 03:45:13 +0900129 if (sd && atomic_dec_and_test(&sd->s_count))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130 release_sysfs_dirent(sd);
131}
Tejun Heo59f69012007-09-20 16:05:10 +0900132
133/*
134 * inode.c
135 */
136struct inode *sysfs_get_inode(struct sysfs_dirent *sd);
137int sysfs_setattr(struct dentry *dentry, struct iattr *iattr);
138int sysfs_hash_and_remove(struct sysfs_dirent *dir_sd, const char *name);
139
140/*
141 * file.c
142 */
143extern const struct file_operations sysfs_file_operations;
144
145int sysfs_add_file(struct sysfs_dirent *dir_sd,
146 const struct attribute *attr, int type);
147
148/*
149 * bin.c
150 */
151extern const struct file_operations bin_fops;
152
153/*
154 * symlink.c
155 */
156extern const struct inode_operations sysfs_symlink_inode_operations;