blob: f0326f281d1cdbbe228fce7146cd4d9bef3e9fe1 [file] [log] [blame]
Tejun Heo6d66f5c2007-09-20 17:31:38 +09001/*
2 * fs/sysfs/sysfs.h - sysfs internal header file
3 *
4 * Copyright (c) 2001-3 Patrick Mochel
5 * Copyright (c) 2007 SUSE Linux Products GmbH
6 * Copyright (c) 2007 Tejun Heo <teheo@suse.de>
7 *
8 * This file is released under the GPLv2.
9 */
10
Tejun Heo85a4ffa2007-09-20 16:05:12 +090011struct sysfs_open_dirent;
12
Tejun Heo59f69012007-09-20 16:05:10 +090013/* type-specific structures for sysfs_dirent->s_* union members */
Tejun Heo3e519032007-06-14 03:45:15 +090014struct sysfs_elem_dir {
Tejun Heo59f69012007-09-20 16:05:10 +090015 struct kobject *kobj;
Tejun Heobc747f32007-09-20 16:05:12 +090016 /* children list starts here and goes through sd->s_sibling */
17 struct sysfs_dirent *children;
Tejun Heo3e519032007-06-14 03:45:15 +090018};
19
20struct sysfs_elem_symlink {
Tejun Heo59f69012007-09-20 16:05:10 +090021 struct sysfs_dirent *target_sd;
Tejun Heo3e519032007-06-14 03:45:15 +090022};
23
24struct sysfs_elem_attr {
Tejun Heo59f69012007-09-20 16:05:10 +090025 struct attribute *attr;
Tejun Heo85a4ffa2007-09-20 16:05:12 +090026 struct sysfs_open_dirent *open;
Tejun Heo3e519032007-06-14 03:45:15 +090027};
28
29struct sysfs_elem_bin_attr {
Tejun Heo59f69012007-09-20 16:05:10 +090030 struct bin_attribute *bin_attr;
Tejun Heo3e519032007-06-14 03:45:15 +090031};
32
Tejun Heo0ab66082007-06-14 03:45:16 +090033/*
Tejun Heo59f69012007-09-20 16:05:10 +090034 * sysfs_dirent - the building block of sysfs hierarchy. Each and
35 * every sysfs node is represented by single sysfs_dirent.
36 *
Tejun Heo0ab66082007-06-14 03:45:16 +090037 * As long as s_count reference is held, the sysfs_dirent itself is
38 * accessible. Dereferencing s_elem or any other outer entity
39 * requires s_active reference.
40 */
Adam J. Richterd56c3ea2007-02-16 21:35:25 +080041struct sysfs_dirent {
42 atomic_t s_count;
Tejun Heo8619f972007-06-14 03:45:18 +090043 atomic_t s_active;
Tejun Heo59f69012007-09-20 16:05:10 +090044 struct sysfs_dirent *s_parent;
45 struct sysfs_dirent *s_sibling;
Tejun Heo59f69012007-09-20 16:05:10 +090046 const char *s_name;
Tejun Heo3e519032007-06-14 03:45:15 +090047
48 union {
Tejun Heob1fc3d62007-09-20 16:05:11 +090049 struct sysfs_elem_dir s_dir;
50 struct sysfs_elem_symlink s_symlink;
51 struct sysfs_elem_attr s_attr;
52 struct sysfs_elem_bin_attr s_bin_attr;
53 };
Tejun Heo3e519032007-06-14 03:45:15 +090054
Tejun Heob402d722007-06-14 04:27:21 +090055 unsigned int s_flags;
Eric Sandeendc351252007-06-11 14:02:45 +090056 ino_t s_ino;
Tejun Heob13dc892007-09-20 16:05:10 +090057 umode_t s_mode;
Tejun Heo59f69012007-09-20 16:05:10 +090058 struct iattr *s_iattr;
Adam J. Richterd56c3ea2007-02-16 21:35:25 +080059};
Linus Torvalds1da177e2005-04-16 15:20:36 -070060
Tejun Heo59f69012007-09-20 16:05:10 +090061#define SD_DEACTIVATED_BIAS INT_MIN
Tejun Heo0ab66082007-06-14 03:45:16 +090062
Tejun Heo59f69012007-09-20 16:05:10 +090063#define SYSFS_TYPE_MASK 0x00ff
Tejun Heodc2f75f2007-09-20 16:05:12 +090064#define SYSFS_DIR 0x0001
65#define SYSFS_KOBJ_ATTR 0x0002
66#define SYSFS_KOBJ_BIN_ATTR 0x0004
67#define SYSFS_KOBJ_LINK 0x0008
Tejun Heo59f69012007-09-20 16:05:10 +090068#define SYSFS_COPY_NAME (SYSFS_DIR | SYSFS_KOBJ_LINK)
69
70#define SYSFS_FLAG_MASK ~SYSFS_TYPE_MASK
71#define SYSFS_FLAG_REMOVED 0x0200
72
73static inline unsigned int sysfs_type(struct sysfs_dirent *sd)
74{
75 return sd->s_flags & SYSFS_TYPE_MASK;
76}
77
78/*
79 * Context structure to be used while adding/removing nodes.
80 */
Tejun Heofb6896d2007-06-14 04:27:24 +090081struct sysfs_addrm_cxt {
82 struct sysfs_dirent *parent_sd;
83 struct inode *parent_inode;
84 struct sysfs_dirent *removed;
85 int cnt;
86};
87
Tejun Heo59f69012007-09-20 16:05:10 +090088/*
89 * mount.c
90 */
Tejun Heo51225032007-06-14 04:27:25 +090091extern struct sysfs_dirent sysfs_root;
Tejun Heo59f69012007-09-20 16:05:10 +090092extern struct super_block *sysfs_sb;
Christoph Lametere18b8902006-12-06 20:33:20 -080093extern struct kmem_cache *sysfs_dir_cachep;
Linus Torvalds1da177e2005-04-16 15:20:36 -070094
Tejun Heo59f69012007-09-20 16:05:10 +090095/*
96 * dir.c
97 */
Tejun Heo3007e992007-06-14 04:27:23 +090098extern struct mutex sysfs_mutex;
Eric W. Biederman932ea2e2007-08-20 21:36:30 +090099extern struct mutex sysfs_rename_mutex;
Tejun Heo59f69012007-09-20 16:05:10 +0900100extern spinlock_t sysfs_assoc_lock;
101
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -0800102extern const struct file_operations sysfs_dir_operations;
Arjan van de Venc5ef1c42007-02-12 00:55:40 -0800103extern const struct inode_operations sysfs_dir_inode_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104
Tejun Heo59f69012007-09-20 16:05:10 +0900105struct dentry *sysfs_get_dentry(struct sysfs_dirent *sd);
106struct sysfs_dirent *sysfs_get_active(struct sysfs_dirent *sd);
107void sysfs_put_active(struct sysfs_dirent *sd);
108struct sysfs_dirent *sysfs_get_active_two(struct sysfs_dirent *sd);
109void sysfs_put_active_two(struct sysfs_dirent *sd);
110void sysfs_addrm_start(struct sysfs_addrm_cxt *acxt,
111 struct sysfs_dirent *parent_sd);
112int sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd);
113void sysfs_remove_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd);
114void sysfs_addrm_finish(struct sysfs_addrm_cxt *acxt);
Tejun Heob402d722007-06-14 04:27:21 +0900115
Tejun Heo59f69012007-09-20 16:05:10 +0900116struct sysfs_dirent *sysfs_find_dirent(struct sysfs_dirent *parent_sd,
117 const unsigned char *name);
118struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
119 const unsigned char *name);
120struct sysfs_dirent *sysfs_new_dirent(const char *name, umode_t mode, int type);
121
122void release_sysfs_dirent(struct sysfs_dirent *sd);
123
124int sysfs_create_subdir(struct kobject *kobj, const char *name,
125 struct sysfs_dirent **p_sd);
126void sysfs_remove_subdir(struct sysfs_dirent *sd);
127
128static inline struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129{
130 if (sd) {
131 WARN_ON(!atomic_read(&sd->s_count));
132 atomic_inc(&sd->s_count);
133 }
134 return sd;
135}
136
Tejun Heo59f69012007-09-20 16:05:10 +0900137static inline void sysfs_put(struct sysfs_dirent *sd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138{
Tejun Heo7a23ad42007-06-14 03:45:13 +0900139 if (sd && atomic_dec_and_test(&sd->s_count))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140 release_sysfs_dirent(sd);
141}
Tejun Heo59f69012007-09-20 16:05:10 +0900142
143/*
144 * inode.c
145 */
146struct inode *sysfs_get_inode(struct sysfs_dirent *sd);
147int sysfs_setattr(struct dentry *dentry, struct iattr *iattr);
148int sysfs_hash_and_remove(struct sysfs_dirent *dir_sd, const char *name);
149
150/*
151 * file.c
152 */
153extern const struct file_operations sysfs_file_operations;
154
155int sysfs_add_file(struct sysfs_dirent *dir_sd,
156 const struct attribute *attr, int type);
157
158/*
159 * bin.c
160 */
161extern const struct file_operations bin_fops;
162
163/*
164 * symlink.c
165 */
166extern const struct inode_operations sysfs_symlink_inode_operations;