blob: 42b0327d16242de175f9142c3c359a569f86a492 [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 Heobc747f32007-09-20 16:05:12 +09004 /* children list starts here and goes through sd->s_sibling */
5 struct sysfs_dirent *children;
Tejun Heo3e519032007-06-14 03:45:15 +09006};
7
8struct sysfs_elem_symlink {
Tejun Heo59f69012007-09-20 16:05:10 +09009 struct sysfs_dirent *target_sd;
Tejun Heo3e519032007-06-14 03:45:15 +090010};
11
12struct sysfs_elem_attr {
Tejun Heo59f69012007-09-20 16:05:10 +090013 struct attribute *attr;
Tejun Heo3e519032007-06-14 03:45:15 +090014};
15
16struct sysfs_elem_bin_attr {
Tejun Heo59f69012007-09-20 16:05:10 +090017 struct bin_attribute *bin_attr;
Tejun Heo3e519032007-06-14 03:45:15 +090018};
19
Tejun Heo0ab66082007-06-14 03:45:16 +090020/*
Tejun Heo59f69012007-09-20 16:05:10 +090021 * sysfs_dirent - the building block of sysfs hierarchy. Each and
22 * every sysfs node is represented by single sysfs_dirent.
23 *
Tejun Heo0ab66082007-06-14 03:45:16 +090024 * As long as s_count reference is held, the sysfs_dirent itself is
25 * accessible. Dereferencing s_elem or any other outer entity
26 * requires s_active reference.
27 */
Adam J. Richterd56c3ea2007-02-16 21:35:25 +080028struct sysfs_dirent {
29 atomic_t s_count;
Tejun Heo8619f972007-06-14 03:45:18 +090030 atomic_t s_active;
Tejun Heo59f69012007-09-20 16:05:10 +090031 struct sysfs_dirent *s_parent;
32 struct sysfs_dirent *s_sibling;
Tejun Heo59f69012007-09-20 16:05:10 +090033 const char *s_name;
Tejun Heo3e519032007-06-14 03:45:15 +090034
35 union {
Tejun Heob1fc3d62007-09-20 16:05:11 +090036 struct sysfs_elem_dir s_dir;
37 struct sysfs_elem_symlink s_symlink;
38 struct sysfs_elem_attr s_attr;
39 struct sysfs_elem_bin_attr s_bin_attr;
40 };
Tejun Heo3e519032007-06-14 03:45:15 +090041
Tejun Heob402d722007-06-14 04:27:21 +090042 unsigned int s_flags;
Eric Sandeendc351252007-06-11 14:02:45 +090043 ino_t s_ino;
Tejun Heob13dc892007-09-20 16:05:10 +090044 umode_t s_mode;
Tejun Heo59f69012007-09-20 16:05:10 +090045 struct iattr *s_iattr;
Adam J. Richterd56c3ea2007-02-16 21:35:25 +080046 atomic_t s_event;
47};
Linus Torvalds1da177e2005-04-16 15:20:36 -070048
Tejun Heo59f69012007-09-20 16:05:10 +090049#define SD_DEACTIVATED_BIAS INT_MIN
Tejun Heo0ab66082007-06-14 03:45:16 +090050
Tejun Heo59f69012007-09-20 16:05:10 +090051#define SYSFS_TYPE_MASK 0x00ff
Tejun Heodc2f75f2007-09-20 16:05:12 +090052#define SYSFS_DIR 0x0001
53#define SYSFS_KOBJ_ATTR 0x0002
54#define SYSFS_KOBJ_BIN_ATTR 0x0004
55#define SYSFS_KOBJ_LINK 0x0008
Tejun Heo59f69012007-09-20 16:05:10 +090056#define SYSFS_COPY_NAME (SYSFS_DIR | SYSFS_KOBJ_LINK)
57
58#define SYSFS_FLAG_MASK ~SYSFS_TYPE_MASK
59#define SYSFS_FLAG_REMOVED 0x0200
60
61static inline unsigned int sysfs_type(struct sysfs_dirent *sd)
62{
63 return sd->s_flags & SYSFS_TYPE_MASK;
64}
65
66/*
67 * Context structure to be used while adding/removing nodes.
68 */
Tejun Heofb6896d2007-06-14 04:27:24 +090069struct sysfs_addrm_cxt {
70 struct sysfs_dirent *parent_sd;
71 struct inode *parent_inode;
72 struct sysfs_dirent *removed;
73 int cnt;
74};
75
Tejun Heo59f69012007-09-20 16:05:10 +090076/*
77 * mount.c
78 */
Tejun Heo51225032007-06-14 04:27:25 +090079extern struct sysfs_dirent sysfs_root;
Tejun Heo59f69012007-09-20 16:05:10 +090080extern struct super_block *sysfs_sb;
Christoph Lametere18b8902006-12-06 20:33:20 -080081extern struct kmem_cache *sysfs_dir_cachep;
Linus Torvalds1da177e2005-04-16 15:20:36 -070082
Tejun Heo59f69012007-09-20 16:05:10 +090083/*
84 * dir.c
85 */
Tejun Heo3007e992007-06-14 04:27:23 +090086extern struct mutex sysfs_mutex;
Eric W. Biederman932ea2e2007-08-20 21:36:30 +090087extern struct mutex sysfs_rename_mutex;
Tejun Heo59f69012007-09-20 16:05:10 +090088extern spinlock_t sysfs_assoc_lock;
89
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -080090extern const struct file_operations sysfs_dir_operations;
Arjan van de Venc5ef1c42007-02-12 00:55:40 -080091extern const struct inode_operations sysfs_dir_inode_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -070092
Tejun Heo59f69012007-09-20 16:05:10 +090093struct dentry *sysfs_get_dentry(struct sysfs_dirent *sd);
94struct sysfs_dirent *sysfs_get_active(struct sysfs_dirent *sd);
95void sysfs_put_active(struct sysfs_dirent *sd);
96struct sysfs_dirent *sysfs_get_active_two(struct sysfs_dirent *sd);
97void sysfs_put_active_two(struct sysfs_dirent *sd);
98void sysfs_addrm_start(struct sysfs_addrm_cxt *acxt,
99 struct sysfs_dirent *parent_sd);
100int sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd);
101void sysfs_remove_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd);
102void sysfs_addrm_finish(struct sysfs_addrm_cxt *acxt);
Tejun Heob402d722007-06-14 04:27:21 +0900103
Tejun Heo59f69012007-09-20 16:05:10 +0900104struct sysfs_dirent *sysfs_find_dirent(struct sysfs_dirent *parent_sd,
105 const unsigned char *name);
106struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
107 const unsigned char *name);
108struct sysfs_dirent *sysfs_new_dirent(const char *name, umode_t mode, int type);
109
110void release_sysfs_dirent(struct sysfs_dirent *sd);
111
112int sysfs_create_subdir(struct kobject *kobj, const char *name,
113 struct sysfs_dirent **p_sd);
114void sysfs_remove_subdir(struct sysfs_dirent *sd);
115
116static inline struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117{
118 if (sd) {
119 WARN_ON(!atomic_read(&sd->s_count));
120 atomic_inc(&sd->s_count);
121 }
122 return sd;
123}
124
Tejun Heo59f69012007-09-20 16:05:10 +0900125static inline void sysfs_put(struct sysfs_dirent *sd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126{
Tejun Heo7a23ad42007-06-14 03:45:13 +0900127 if (sd && atomic_dec_and_test(&sd->s_count))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128 release_sysfs_dirent(sd);
129}
Tejun Heo59f69012007-09-20 16:05:10 +0900130
131/*
132 * inode.c
133 */
134struct inode *sysfs_get_inode(struct sysfs_dirent *sd);
135int sysfs_setattr(struct dentry *dentry, struct iattr *iattr);
136int sysfs_hash_and_remove(struct sysfs_dirent *dir_sd, const char *name);
137
138/*
139 * file.c
140 */
141extern const struct file_operations sysfs_file_operations;
142
143int sysfs_add_file(struct sysfs_dirent *dir_sd,
144 const struct attribute *attr, int type);
145
146/*
147 * bin.c
148 */
149extern const struct file_operations bin_fops;
150
151/*
152 * symlink.c
153 */
154extern const struct inode_operations sysfs_symlink_inode_operations;