blob: 6a13105b55949804a4d582e235df083b645bfe3f [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
Eric W. Biederman846f9972010-01-02 13:37:12 -080011#include <linux/lockdep.h>
David P. Quigleyddd29ec2009-09-09 14:25:37 -040012#include <linux/fs.h>
13
Tejun Heo85a4ffa2007-09-20 16:05:12 +090014struct sysfs_open_dirent;
15
Tejun Heo59f69012007-09-20 16:05:10 +090016/* type-specific structures for sysfs_dirent->s_* union members */
Tejun Heo3e519032007-06-14 03:45:15 +090017struct sysfs_elem_dir {
Tejun Heo59f69012007-09-20 16:05:10 +090018 struct kobject *kobj;
Tejun Heobc747f32007-09-20 16:05:12 +090019 /* children list starts here and goes through sd->s_sibling */
20 struct sysfs_dirent *children;
Tejun Heo3e519032007-06-14 03:45:15 +090021};
22
23struct sysfs_elem_symlink {
Tejun Heo59f69012007-09-20 16:05:10 +090024 struct sysfs_dirent *target_sd;
Tejun Heo3e519032007-06-14 03:45:15 +090025};
26
27struct sysfs_elem_attr {
Tejun Heo59f69012007-09-20 16:05:10 +090028 struct attribute *attr;
Tejun Heo85a4ffa2007-09-20 16:05:12 +090029 struct sysfs_open_dirent *open;
Tejun Heo3e519032007-06-14 03:45:15 +090030};
31
32struct sysfs_elem_bin_attr {
Tejun Heo59f69012007-09-20 16:05:10 +090033 struct bin_attribute *bin_attr;
Eric W. Biedermane0edd3c2009-03-04 11:57:20 -080034 struct hlist_head buffers;
Tejun Heo3e519032007-06-14 03:45:15 +090035};
36
David P. Quigleyddd29ec2009-09-09 14:25:37 -040037struct sysfs_inode_attrs {
38 struct iattr ia_iattr;
39 void *ia_secdata;
40 u32 ia_secdata_len;
41};
42
Tejun Heo0ab66082007-06-14 03:45:16 +090043/*
Tejun Heo59f69012007-09-20 16:05:10 +090044 * sysfs_dirent - the building block of sysfs hierarchy. Each and
45 * every sysfs node is represented by single sysfs_dirent.
46 *
Tejun Heo0ab66082007-06-14 03:45:16 +090047 * As long as s_count reference is held, the sysfs_dirent itself is
48 * accessible. Dereferencing s_elem or any other outer entity
49 * requires s_active reference.
50 */
Adam J. Richterd56c3ea2007-02-16 21:35:25 +080051struct sysfs_dirent {
52 atomic_t s_count;
Tejun Heo8619f972007-06-14 03:45:18 +090053 atomic_t s_active;
Eric W. Biederman846f9972010-01-02 13:37:12 -080054#ifdef CONFIG_DEBUG_LOCK_ALLOC
55 struct lockdep_map dep_map;
56#endif
Tejun Heo59f69012007-09-20 16:05:10 +090057 struct sysfs_dirent *s_parent;
58 struct sysfs_dirent *s_sibling;
Tejun Heo59f69012007-09-20 16:05:10 +090059 const char *s_name;
Tejun Heo3e519032007-06-14 03:45:15 +090060
Serge E. Hallynbe867b12010-05-03 16:23:15 -050061 const void *s_ns; /* namespace tag */
Tejun Heo3e519032007-06-14 03:45:15 +090062 union {
Tejun Heob1fc3d62007-09-20 16:05:11 +090063 struct sysfs_elem_dir s_dir;
64 struct sysfs_elem_symlink s_symlink;
65 struct sysfs_elem_attr s_attr;
66 struct sysfs_elem_bin_attr s_bin_attr;
67 };
Tejun Heo3e519032007-06-14 03:45:15 +090068
Tejun Heob402d722007-06-14 04:27:21 +090069 unsigned int s_flags;
Eric W. Biederman19c38b62010-02-12 19:22:24 -080070 unsigned short s_mode;
Eric Sandeendc351252007-06-11 14:02:45 +090071 ino_t s_ino;
David P. Quigleyddd29ec2009-09-09 14:25:37 -040072 struct sysfs_inode_attrs *s_iattr;
Adam J. Richterd56c3ea2007-02-16 21:35:25 +080073};
Linus Torvalds1da177e2005-04-16 15:20:36 -070074
Tejun Heo59f69012007-09-20 16:05:10 +090075#define SD_DEACTIVATED_BIAS INT_MIN
Tejun Heo0ab66082007-06-14 03:45:16 +090076
Tejun Heo59f69012007-09-20 16:05:10 +090077#define SYSFS_TYPE_MASK 0x00ff
Tejun Heodc2f75f2007-09-20 16:05:12 +090078#define SYSFS_DIR 0x0001
79#define SYSFS_KOBJ_ATTR 0x0002
80#define SYSFS_KOBJ_BIN_ATTR 0x0004
81#define SYSFS_KOBJ_LINK 0x0008
Tejun Heo59f69012007-09-20 16:05:10 +090082#define SYSFS_COPY_NAME (SYSFS_DIR | SYSFS_KOBJ_LINK)
Eric W. Biedermana2db6842010-02-11 15:20:00 -080083#define SYSFS_ACTIVE_REF (SYSFS_KOBJ_ATTR | SYSFS_KOBJ_BIN_ATTR)
Tejun Heo59f69012007-09-20 16:05:10 +090084
Serge E. Hallynbe867b12010-05-03 16:23:15 -050085/* identify any namespace tag on sysfs_dirents */
Eric W. Biederman3ff195b2010-03-30 11:31:26 -070086#define SYSFS_NS_TYPE_MASK 0xff00
87#define SYSFS_NS_TYPE_SHIFT 8
88
89#define SYSFS_FLAG_MASK ~(SYSFS_NS_TYPE_MASK|SYSFS_TYPE_MASK)
90#define SYSFS_FLAG_REMOVED 0x020000
Tejun Heo59f69012007-09-20 16:05:10 +090091
92static inline unsigned int sysfs_type(struct sysfs_dirent *sd)
93{
94 return sd->s_flags & SYSFS_TYPE_MASK;
95}
96
Serge E. Hallynbe867b12010-05-03 16:23:15 -050097/*
98 * Return any namespace tags on this dirent.
99 * enum kobj_ns_type is defined in linux/kobject.h
100 */
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700101static inline enum kobj_ns_type sysfs_ns_type(struct sysfs_dirent *sd)
102{
103 return (sd->s_flags & SYSFS_NS_TYPE_MASK) >> SYSFS_NS_TYPE_SHIFT;
104}
105
Eric W. Biederman846f9972010-01-02 13:37:12 -0800106#ifdef CONFIG_DEBUG_LOCK_ALLOC
107#define sysfs_dirent_init_lockdep(sd) \
108do { \
Eric W. Biederman6992f532010-02-11 15:21:53 -0800109 struct attribute *attr = sd->s_attr.attr; \
110 struct lock_class_key *key = attr->key; \
111 if (!key) \
112 key = &attr->skey; \
Eric W. Biederman846f9972010-01-02 13:37:12 -0800113 \
Eric W. Biederman6992f532010-02-11 15:21:53 -0800114 lockdep_init_map(&sd->dep_map, "s_active", key, 0); \
Eric W. Biederman846f9972010-01-02 13:37:12 -0800115} while(0)
116#else
117#define sysfs_dirent_init_lockdep(sd) do {} while(0)
118#endif
119
Tejun Heo59f69012007-09-20 16:05:10 +0900120/*
121 * Context structure to be used while adding/removing nodes.
122 */
Tejun Heofb6896d2007-06-14 04:27:24 +0900123struct sysfs_addrm_cxt {
124 struct sysfs_dirent *parent_sd;
Tejun Heofb6896d2007-06-14 04:27:24 +0900125 struct sysfs_dirent *removed;
Tejun Heofb6896d2007-06-14 04:27:24 +0900126};
127
Tejun Heo59f69012007-09-20 16:05:10 +0900128/*
129 * mount.c
130 */
Serge E. Hallynbe867b12010-05-03 16:23:15 -0500131
132/*
133 * Each sb is associated with a set of namespace tags (i.e.
134 * the network namespace of the task which mounted this sysfs
135 * instance).
136 */
Eric W. Biederman9e7fdd22010-03-30 11:31:24 -0700137struct sysfs_super_info {
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700138 const void *ns[KOBJ_NS_TYPES];
Eric W. Biederman9e7fdd22010-03-30 11:31:24 -0700139};
140#define sysfs_info(SB) ((struct sysfs_super_info *)(SB->s_fs_info))
Tejun Heo51225032007-06-14 04:27:25 +0900141extern struct sysfs_dirent sysfs_root;
Christoph Lametere18b8902006-12-06 20:33:20 -0800142extern struct kmem_cache *sysfs_dir_cachep;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143
Tejun Heo59f69012007-09-20 16:05:10 +0900144/*
145 * dir.c
146 */
Tejun Heo3007e992007-06-14 04:27:23 +0900147extern struct mutex sysfs_mutex;
Tejun Heo59f69012007-09-20 16:05:10 +0900148extern spinlock_t sysfs_assoc_lock;
149
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -0800150extern const struct file_operations sysfs_dir_operations;
Arjan van de Venc5ef1c42007-02-12 00:55:40 -0800151extern const struct inode_operations sysfs_dir_inode_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152
Tejun Heo59f69012007-09-20 16:05:10 +0900153struct dentry *sysfs_get_dentry(struct sysfs_dirent *sd);
Eric W. Biedermane72ceb82010-02-11 15:18:38 -0800154struct sysfs_dirent *sysfs_get_active(struct sysfs_dirent *sd);
155void sysfs_put_active(struct sysfs_dirent *sd);
Tejun Heo59f69012007-09-20 16:05:10 +0900156void sysfs_addrm_start(struct sysfs_addrm_cxt *acxt,
157 struct sysfs_dirent *parent_sd);
Cornelia Huck36ce6da2008-06-10 11:09:08 +0200158int __sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd);
Tejun Heo59f69012007-09-20 16:05:10 +0900159int sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd);
160void sysfs_remove_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd);
161void sysfs_addrm_finish(struct sysfs_addrm_cxt *acxt);
Tejun Heob402d722007-06-14 04:27:21 +0900162
Tejun Heo59f69012007-09-20 16:05:10 +0900163struct sysfs_dirent *sysfs_find_dirent(struct sysfs_dirent *parent_sd,
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700164 const void *ns,
Tejun Heo59f69012007-09-20 16:05:10 +0900165 const unsigned char *name);
166struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700167 const void *ns,
Tejun Heo59f69012007-09-20 16:05:10 +0900168 const unsigned char *name);
169struct sysfs_dirent *sysfs_new_dirent(const char *name, umode_t mode, int type);
170
171void release_sysfs_dirent(struct sysfs_dirent *sd);
172
173int sysfs_create_subdir(struct kobject *kobj, const char *name,
174 struct sysfs_dirent **p_sd);
175void sysfs_remove_subdir(struct sysfs_dirent *sd);
176
Eric W. Biedermanca1bab32009-11-20 16:08:57 -0800177int sysfs_rename(struct sysfs_dirent *sd,
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700178 struct sysfs_dirent *new_parent_sd, const void *ns, const char *new_name);
Eric W. Biedermanca1bab32009-11-20 16:08:57 -0800179
Neil Brownf1282c82008-07-16 08:58:04 +1000180static inline struct sysfs_dirent *__sysfs_get(struct sysfs_dirent *sd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181{
182 if (sd) {
183 WARN_ON(!atomic_read(&sd->s_count));
184 atomic_inc(&sd->s_count);
185 }
186 return sd;
187}
Neil Brownf1282c82008-07-16 08:58:04 +1000188#define sysfs_get(sd) __sysfs_get(sd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189
Neil Brownf1282c82008-07-16 08:58:04 +1000190static inline void __sysfs_put(struct sysfs_dirent *sd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191{
Tejun Heo7a23ad42007-06-14 03:45:13 +0900192 if (sd && atomic_dec_and_test(&sd->s_count))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193 release_sysfs_dirent(sd);
194}
Neil Brownf1282c82008-07-16 08:58:04 +1000195#define sysfs_put(sd) __sysfs_put(sd)
Tejun Heo59f69012007-09-20 16:05:10 +0900196
197/*
198 * inode.c
199 */
Eric W. Biedermanfac26222010-02-12 19:22:27 -0800200struct inode *sysfs_get_inode(struct super_block *sb, struct sysfs_dirent *sd);
Eric W. Biederman04256b42009-02-11 13:20:23 -0800201void sysfs_delete_inode(struct inode *inode);
Eric W. Biederman35df63c2009-11-20 16:08:50 -0800202int sysfs_sd_setattr(struct sysfs_dirent *sd, struct iattr *iattr);
Eric W. Biedermane61ab4a2009-11-20 16:08:53 -0800203int sysfs_permission(struct inode *inode, int mask);
Tejun Heo59f69012007-09-20 16:05:10 +0900204int sysfs_setattr(struct dentry *dentry, struct iattr *iattr);
Eric W. Biedermane61ab4a2009-11-20 16:08:53 -0800205int sysfs_getattr(struct vfsmount *mnt, struct dentry *dentry, struct kstat *stat);
David P. Quigleyddd29ec2009-09-09 14:25:37 -0400206int sysfs_setxattr(struct dentry *dentry, const char *name, const void *value,
207 size_t size, int flags);
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700208int sysfs_hash_and_remove(struct sysfs_dirent *dir_sd, const void *ns, const char *name);
Peter Zijlstrae0bf68d2007-10-16 23:25:46 -0700209int sysfs_inode_init(void);
Tejun Heo59f69012007-09-20 16:05:10 +0900210
211/*
212 * file.c
213 */
214extern const struct file_operations sysfs_file_operations;
215
216int sysfs_add_file(struct sysfs_dirent *dir_sd,
217 const struct attribute *attr, int type);
218
James Bottomley0f423892008-03-20 20:47:52 -0500219int sysfs_add_file_mode(struct sysfs_dirent *dir_sd,
220 const struct attribute *attr, int type, mode_t amode);
Tejun Heo59f69012007-09-20 16:05:10 +0900221/*
222 * bin.c
223 */
224extern const struct file_operations bin_fops;
Eric W. Biedermane0edd3c2009-03-04 11:57:20 -0800225void unmap_bin_file(struct sysfs_dirent *attr_sd);
Tejun Heo59f69012007-09-20 16:05:10 +0900226
227/*
228 * symlink.c
229 */
230extern const struct inode_operations sysfs_symlink_inode_operations;