blob: 60405a6e4c226d44200bb21703505ca8d9c146ed [file] [log] [blame]
Tejun Heo59f69012007-09-20 16:05:10 +09001/* type-specific structures for sysfs_dirent->s_* union members */
Tejun Heo3e519032007-06-14 03:45:15 +09002struct sysfs_elem_dir {
Tejun Heo59f69012007-09-20 16:05:10 +09003 struct kobject *kobj;
Tejun Heo3e519032007-06-14 03:45:15 +09004};
5
6struct sysfs_elem_symlink {
Tejun Heo59f69012007-09-20 16:05:10 +09007 struct sysfs_dirent *target_sd;
Tejun Heo3e519032007-06-14 03:45:15 +09008};
9
10struct sysfs_elem_attr {
Tejun Heo59f69012007-09-20 16:05:10 +090011 struct attribute *attr;
Tejun Heo3e519032007-06-14 03:45:15 +090012};
13
14struct sysfs_elem_bin_attr {
Tejun Heo59f69012007-09-20 16:05:10 +090015 struct bin_attribute *bin_attr;
Tejun Heo3e519032007-06-14 03:45:15 +090016};
17
Tejun Heo0ab66082007-06-14 03:45:16 +090018/*
Tejun Heo59f69012007-09-20 16:05:10 +090019 * sysfs_dirent - the building block of sysfs hierarchy. Each and
20 * every sysfs node is represented by single sysfs_dirent.
21 *
Tejun Heo0ab66082007-06-14 03:45:16 +090022 * As long as s_count reference is held, the sysfs_dirent itself is
23 * accessible. Dereferencing s_elem or any other outer entity
24 * requires s_active reference.
25 */
Adam J. Richterd56c3ea2007-02-16 21:35:25 +080026struct sysfs_dirent {
27 atomic_t s_count;
Tejun Heo8619f972007-06-14 03:45:18 +090028 atomic_t s_active;
Tejun Heo59f69012007-09-20 16:05:10 +090029 struct sysfs_dirent *s_parent;
30 struct sysfs_dirent *s_sibling;
31 struct sysfs_dirent *s_children;
32 const char *s_name;
Tejun Heo3e519032007-06-14 03:45:15 +090033
34 union {
Tejun Heob1fc3d62007-09-20 16:05:11 +090035 struct sysfs_elem_dir s_dir;
36 struct sysfs_elem_symlink s_symlink;
37 struct sysfs_elem_attr s_attr;
38 struct sysfs_elem_bin_attr s_bin_attr;
39 };
Tejun Heo3e519032007-06-14 03:45:15 +090040
Tejun Heob402d722007-06-14 04:27:21 +090041 unsigned int s_flags;
Eric Sandeendc351252007-06-11 14:02:45 +090042 ino_t s_ino;
Tejun Heob13dc892007-09-20 16:05:10 +090043 umode_t s_mode;
Tejun Heo59f69012007-09-20 16:05:10 +090044 struct iattr *s_iattr;
Adam J. Richterd56c3ea2007-02-16 21:35:25 +080045 atomic_t s_event;
46};
Linus Torvalds1da177e2005-04-16 15:20:36 -070047
Tejun Heo59f69012007-09-20 16:05:10 +090048#define SD_DEACTIVATED_BIAS INT_MIN
Tejun Heo0ab66082007-06-14 03:45:16 +090049
Tejun Heo59f69012007-09-20 16:05:10 +090050#define SYSFS_TYPE_MASK 0x00ff
Tejun Heodc2f75f2007-09-20 16:05:12 +090051#define SYSFS_DIR 0x0001
52#define SYSFS_KOBJ_ATTR 0x0002
53#define SYSFS_KOBJ_BIN_ATTR 0x0004
54#define SYSFS_KOBJ_LINK 0x0008
Tejun Heo59f69012007-09-20 16:05:10 +090055#define SYSFS_COPY_NAME (SYSFS_DIR | SYSFS_KOBJ_LINK)
56
57#define SYSFS_FLAG_MASK ~SYSFS_TYPE_MASK
58#define SYSFS_FLAG_REMOVED 0x0200
59
60static inline unsigned int sysfs_type(struct sysfs_dirent *sd)
61{
62 return sd->s_flags & SYSFS_TYPE_MASK;
63}
64
65/*
66 * Context structure to be used while adding/removing nodes.
67 */
Tejun Heofb6896d2007-06-14 04:27:24 +090068struct sysfs_addrm_cxt {
69 struct sysfs_dirent *parent_sd;
70 struct inode *parent_inode;
71 struct sysfs_dirent *removed;
72 int cnt;
73};
74
Tejun Heo59f69012007-09-20 16:05:10 +090075/*
76 * mount.c
77 */
Tejun Heo51225032007-06-14 04:27:25 +090078extern struct sysfs_dirent sysfs_root;
Tejun Heo59f69012007-09-20 16:05:10 +090079extern struct super_block *sysfs_sb;
Christoph Lametere18b8902006-12-06 20:33:20 -080080extern struct kmem_cache *sysfs_dir_cachep;
Linus Torvalds1da177e2005-04-16 15:20:36 -070081
Tejun Heo59f69012007-09-20 16:05:10 +090082/*
83 * dir.c
84 */
Tejun Heo3007e992007-06-14 04:27:23 +090085extern struct mutex sysfs_mutex;
Eric W. Biederman932ea2e2007-08-20 21:36:30 +090086extern struct mutex sysfs_rename_mutex;
Tejun Heo59f69012007-09-20 16:05:10 +090087extern spinlock_t sysfs_assoc_lock;
88
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -080089extern const struct file_operations sysfs_dir_operations;
Arjan van de Venc5ef1c42007-02-12 00:55:40 -080090extern const struct inode_operations sysfs_dir_inode_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -070091
Tejun Heo59f69012007-09-20 16:05:10 +090092struct dentry *sysfs_get_dentry(struct sysfs_dirent *sd);
93struct sysfs_dirent *sysfs_get_active(struct sysfs_dirent *sd);
94void sysfs_put_active(struct sysfs_dirent *sd);
95struct sysfs_dirent *sysfs_get_active_two(struct sysfs_dirent *sd);
96void sysfs_put_active_two(struct sysfs_dirent *sd);
97void sysfs_addrm_start(struct sysfs_addrm_cxt *acxt,
98 struct sysfs_dirent *parent_sd);
99int sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd);
100void sysfs_remove_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd);
101void sysfs_addrm_finish(struct sysfs_addrm_cxt *acxt);
Tejun Heob402d722007-06-14 04:27:21 +0900102
Tejun Heo59f69012007-09-20 16:05:10 +0900103struct sysfs_dirent *sysfs_find_dirent(struct sysfs_dirent *parent_sd,
104 const unsigned char *name);
105struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
106 const unsigned char *name);
107struct sysfs_dirent *sysfs_new_dirent(const char *name, umode_t mode, int type);
108
109void release_sysfs_dirent(struct sysfs_dirent *sd);
110
111int sysfs_create_subdir(struct kobject *kobj, const char *name,
112 struct sysfs_dirent **p_sd);
113void sysfs_remove_subdir(struct sysfs_dirent *sd);
114
115static inline struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116{
117 if (sd) {
118 WARN_ON(!atomic_read(&sd->s_count));
119 atomic_inc(&sd->s_count);
120 }
121 return sd;
122}
123
Tejun Heo59f69012007-09-20 16:05:10 +0900124static inline void sysfs_put(struct sysfs_dirent *sd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125{
Tejun Heo7a23ad42007-06-14 03:45:13 +0900126 if (sd && atomic_dec_and_test(&sd->s_count))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127 release_sysfs_dirent(sd);
128}
Tejun Heo59f69012007-09-20 16:05:10 +0900129
130/*
131 * inode.c
132 */
133struct inode *sysfs_get_inode(struct sysfs_dirent *sd);
134int sysfs_setattr(struct dentry *dentry, struct iattr *iattr);
135int sysfs_hash_and_remove(struct sysfs_dirent *dir_sd, const char *name);
136
137/*
138 * file.c
139 */
140extern const struct file_operations sysfs_file_operations;
141
142int sysfs_add_file(struct sysfs_dirent *dir_sd,
143 const struct attribute *attr, int type);
144
145/*
146 * bin.c
147 */
148extern const struct file_operations bin_fops;
149
150/*
151 * symlink.c
152 */
153extern const struct inode_operations sysfs_symlink_inode_operations;