blob: b6deca3e301d2947c94c5789c8a941a0dfe497fa [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>
Alexey Dobriyan57cc7212011-01-10 08:18:25 +020012#include <linux/kobject_ns.h>
David P. Quigleyddd29ec2009-09-09 14:25:37 -040013#include <linux/fs.h>
Mikulas Patocka4f72c0c2011-07-25 17:55:57 -040014#include <linux/rbtree.h>
David P. Quigleyddd29ec2009-09-09 14:25:37 -040015
Tejun Heo85a4ffa2007-09-20 16:05:12 +090016struct sysfs_open_dirent;
17
Tejun Heo59f69012007-09-20 16:05:10 +090018/* type-specific structures for sysfs_dirent->s_* union members */
Tejun Heo3e519032007-06-14 03:45:15 +090019struct sysfs_elem_dir {
Tejun Heo59f69012007-09-20 16:05:10 +090020 struct kobject *kobj;
Mikulas Patocka7f9838f2011-07-21 19:59:22 -040021
Greg Kroah-Hartman54d20f02012-03-08 13:03:10 -080022 unsigned long subdirs;
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -080023 /* children rbtree starts here and goes through sd->s_rb */
24 struct rb_root children;
Tejun Heo3e519032007-06-14 03:45:15 +090025};
26
27struct sysfs_elem_symlink {
Tejun Heo59f69012007-09-20 16:05:10 +090028 struct sysfs_dirent *target_sd;
Tejun Heo3e519032007-06-14 03:45:15 +090029};
30
31struct sysfs_elem_attr {
Tejun Heo59f69012007-09-20 16:05:10 +090032 struct attribute *attr;
Tejun Heo85a4ffa2007-09-20 16:05:12 +090033 struct sysfs_open_dirent *open;
Tejun Heo3e519032007-06-14 03:45:15 +090034};
35
36struct sysfs_elem_bin_attr {
Tejun Heo59f69012007-09-20 16:05:10 +090037 struct bin_attribute *bin_attr;
Eric W. Biedermane0edd3c2009-03-04 11:57:20 -080038 struct hlist_head buffers;
Tejun Heo3e519032007-06-14 03:45:15 +090039};
40
David P. Quigleyddd29ec2009-09-09 14:25:37 -040041struct sysfs_inode_attrs {
42 struct iattr ia_iattr;
43 void *ia_secdata;
44 u32 ia_secdata_len;
45};
46
Tejun Heo0ab66082007-06-14 03:45:16 +090047/*
Tejun Heo59f69012007-09-20 16:05:10 +090048 * sysfs_dirent - the building block of sysfs hierarchy. Each and
49 * every sysfs node is represented by single sysfs_dirent.
50 *
Tejun Heo0ab66082007-06-14 03:45:16 +090051 * As long as s_count reference is held, the sysfs_dirent itself is
52 * accessible. Dereferencing s_elem or any other outer entity
53 * requires s_active reference.
54 */
Adam J. Richterd56c3ea2007-02-16 21:35:25 +080055struct sysfs_dirent {
56 atomic_t s_count;
Tejun Heo8619f972007-06-14 03:45:18 +090057 atomic_t s_active;
Eric W. Biederman846f9972010-01-02 13:37:12 -080058#ifdef CONFIG_DEBUG_LOCK_ALLOC
59 struct lockdep_map dep_map;
60#endif
Tejun Heo59f69012007-09-20 16:05:10 +090061 struct sysfs_dirent *s_parent;
Tejun Heo59f69012007-09-20 16:05:10 +090062 const char *s_name;
Tejun Heo3e519032007-06-14 03:45:15 +090063
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -080064 struct rb_node s_rb;
Mikulas Patocka4f72c0c2011-07-25 17:55:57 -040065
Mikulas Patocka58f2a4c2011-07-21 20:01:12 -040066 union {
67 struct completion *completion;
68 struct sysfs_dirent *removed_list;
69 } u;
70
Serge E. Hallynbe867b12010-05-03 16:23:15 -050071 const void *s_ns; /* namespace tag */
Eric W. Biederman4e4d6d82011-12-18 20:05:43 -080072 unsigned int s_hash; /* ns + name hash */
Tejun Heo3e519032007-06-14 03:45:15 +090073 union {
Tejun Heob1fc3d62007-09-20 16:05:11 +090074 struct sysfs_elem_dir s_dir;
75 struct sysfs_elem_symlink s_symlink;
76 struct sysfs_elem_attr s_attr;
77 struct sysfs_elem_bin_attr s_bin_attr;
78 };
Tejun Heo3e519032007-06-14 03:45:15 +090079
Eric W. Biederman15a33822011-12-18 20:07:23 -080080 unsigned short s_flags;
Greg Kroah-Hartman2c3a9082013-08-21 16:40:05 -070081 umode_t s_mode;
Eric W. Biedermancafa6b52011-12-18 20:08:16 -080082 unsigned int s_ino;
David P. Quigleyddd29ec2009-09-09 14:25:37 -040083 struct sysfs_inode_attrs *s_iattr;
Adam J. Richterd56c3ea2007-02-16 21:35:25 +080084};
Linus Torvalds1da177e2005-04-16 15:20:36 -070085
Tejun Heo59f69012007-09-20 16:05:10 +090086#define SD_DEACTIVATED_BIAS INT_MIN
Tejun Heo0ab66082007-06-14 03:45:16 +090087
Tejun Heo59f69012007-09-20 16:05:10 +090088#define SYSFS_TYPE_MASK 0x00ff
Tejun Heodc2f75f2007-09-20 16:05:12 +090089#define SYSFS_DIR 0x0001
90#define SYSFS_KOBJ_ATTR 0x0002
91#define SYSFS_KOBJ_BIN_ATTR 0x0004
92#define SYSFS_KOBJ_LINK 0x0008
Tejun Heo59f69012007-09-20 16:05:10 +090093#define SYSFS_COPY_NAME (SYSFS_DIR | SYSFS_KOBJ_LINK)
Eric W. Biedermana2db6842010-02-11 15:20:00 -080094#define SYSFS_ACTIVE_REF (SYSFS_KOBJ_ATTR | SYSFS_KOBJ_BIN_ATTR)
Tejun Heo59f69012007-09-20 16:05:10 +090095
Serge E. Hallynbe867b12010-05-03 16:23:15 -050096/* identify any namespace tag on sysfs_dirents */
Eric W. Biederman15a33822011-12-18 20:07:23 -080097#define SYSFS_NS_TYPE_MASK 0xf00
Eric W. Biederman3ff195b2010-03-30 11:31:26 -070098#define SYSFS_NS_TYPE_SHIFT 8
99
100#define SYSFS_FLAG_MASK ~(SYSFS_NS_TYPE_MASK|SYSFS_TYPE_MASK)
Eric W. Biederman15a33822011-12-18 20:07:23 -0800101#define SYSFS_FLAG_REMOVED 0x02000
Tejun Heo59f69012007-09-20 16:05:10 +0900102
103static inline unsigned int sysfs_type(struct sysfs_dirent *sd)
104{
105 return sd->s_flags & SYSFS_TYPE_MASK;
106}
107
Serge E. Hallynbe867b12010-05-03 16:23:15 -0500108/*
109 * Return any namespace tags on this dirent.
110 * enum kobj_ns_type is defined in linux/kobject.h
111 */
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700112static inline enum kobj_ns_type sysfs_ns_type(struct sysfs_dirent *sd)
113{
114 return (sd->s_flags & SYSFS_NS_TYPE_MASK) >> SYSFS_NS_TYPE_SHIFT;
115}
116
Eric W. Biederman846f9972010-01-02 13:37:12 -0800117#ifdef CONFIG_DEBUG_LOCK_ALLOC
118#define sysfs_dirent_init_lockdep(sd) \
119do { \
Eric W. Biederman6992f532010-02-11 15:21:53 -0800120 struct attribute *attr = sd->s_attr.attr; \
121 struct lock_class_key *key = attr->key; \
122 if (!key) \
123 key = &attr->skey; \
Eric W. Biederman846f9972010-01-02 13:37:12 -0800124 \
Eric W. Biederman6992f532010-02-11 15:21:53 -0800125 lockdep_init_map(&sd->dep_map, "s_active", key, 0); \
Greg Kroah-Hartman2c3a9082013-08-21 16:40:05 -0700126} while (0)
Eric W. Biederman846f9972010-01-02 13:37:12 -0800127#else
Greg Kroah-Hartman2c3a9082013-08-21 16:40:05 -0700128#define sysfs_dirent_init_lockdep(sd) do {} while (0)
Eric W. Biederman846f9972010-01-02 13:37:12 -0800129#endif
130
Tejun Heo59f69012007-09-20 16:05:10 +0900131/*
132 * Context structure to be used while adding/removing nodes.
133 */
Tejun Heofb6896d2007-06-14 04:27:24 +0900134struct sysfs_addrm_cxt {
135 struct sysfs_dirent *parent_sd;
Tejun Heofb6896d2007-06-14 04:27:24 +0900136 struct sysfs_dirent *removed;
Tejun Heofb6896d2007-06-14 04:27:24 +0900137};
138
Tejun Heo59f69012007-09-20 16:05:10 +0900139/*
140 * mount.c
141 */
Serge E. Hallynbe867b12010-05-03 16:23:15 -0500142
143/*
144 * Each sb is associated with a set of namespace tags (i.e.
145 * the network namespace of the task which mounted this sysfs
146 * instance).
147 */
Eric W. Biederman9e7fdd22010-03-30 11:31:24 -0700148struct sysfs_super_info {
Al Viroa685e082011-06-08 21:13:01 -0400149 void *ns[KOBJ_NS_TYPES];
Eric W. Biederman9e7fdd22010-03-30 11:31:24 -0700150};
151#define sysfs_info(SB) ((struct sysfs_super_info *)(SB->s_fs_info))
Tejun Heo51225032007-06-14 04:27:25 +0900152extern struct sysfs_dirent sysfs_root;
Christoph Lametere18b8902006-12-06 20:33:20 -0800153extern struct kmem_cache *sysfs_dir_cachep;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154
Tejun Heo59f69012007-09-20 16:05:10 +0900155/*
156 * dir.c
157 */
Tejun Heo3007e992007-06-14 04:27:23 +0900158extern struct mutex sysfs_mutex;
Tejun Heo59f69012007-09-20 16:05:10 +0900159extern spinlock_t sysfs_assoc_lock;
Al Viro469796d2012-06-07 20:51:39 -0400160extern const struct dentry_operations sysfs_dentry_ops;
Tejun Heo59f69012007-09-20 16:05:10 +0900161
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -0800162extern const struct file_operations sysfs_dir_operations;
Arjan van de Venc5ef1c42007-02-12 00:55:40 -0800163extern const struct inode_operations sysfs_dir_inode_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164
Tejun Heo59f69012007-09-20 16:05:10 +0900165struct dentry *sysfs_get_dentry(struct sysfs_dirent *sd);
Eric W. Biedermane72ceb82010-02-11 15:18:38 -0800166struct sysfs_dirent *sysfs_get_active(struct sysfs_dirent *sd);
167void sysfs_put_active(struct sysfs_dirent *sd);
Tejun Heo59f69012007-09-20 16:05:10 +0900168void sysfs_addrm_start(struct sysfs_addrm_cxt *acxt,
169 struct sysfs_dirent *parent_sd);
Cornelia Huck36ce6da2008-06-10 11:09:08 +0200170int __sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd);
Tejun Heo59f69012007-09-20 16:05:10 +0900171int sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd);
172void sysfs_remove_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd);
173void sysfs_addrm_finish(struct sysfs_addrm_cxt *acxt);
Tejun Heob402d722007-06-14 04:27:21 +0900174
Tejun Heo59f69012007-09-20 16:05:10 +0900175struct sysfs_dirent *sysfs_find_dirent(struct sysfs_dirent *parent_sd,
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700176 const void *ns,
Tejun Heo59f69012007-09-20 16:05:10 +0900177 const unsigned char *name);
178struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700179 const void *ns,
Tejun Heo59f69012007-09-20 16:05:10 +0900180 const unsigned char *name);
181struct sysfs_dirent *sysfs_new_dirent(const char *name, umode_t mode, int type);
182
183void release_sysfs_dirent(struct sysfs_dirent *sd);
184
185int sysfs_create_subdir(struct kobject *kobj, const char *name,
186 struct sysfs_dirent **p_sd);
187void sysfs_remove_subdir(struct sysfs_dirent *sd);
188
Greg Kroah-Hartman2c3a9082013-08-21 16:40:05 -0700189int sysfs_rename(struct sysfs_dirent *sd, struct sysfs_dirent *new_parent_sd,
190 const void *ns, const char *new_name);
Eric W. Biedermanca1bab32009-11-20 16:08:57 -0800191
Neil Brownf1282c82008-07-16 08:58:04 +1000192static inline struct sysfs_dirent *__sysfs_get(struct sysfs_dirent *sd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193{
194 if (sd) {
195 WARN_ON(!atomic_read(&sd->s_count));
196 atomic_inc(&sd->s_count);
197 }
198 return sd;
199}
Neil Brownf1282c82008-07-16 08:58:04 +1000200#define sysfs_get(sd) __sysfs_get(sd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201
Neil Brownf1282c82008-07-16 08:58:04 +1000202static inline void __sysfs_put(struct sysfs_dirent *sd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203{
Tejun Heo7a23ad42007-06-14 03:45:13 +0900204 if (sd && atomic_dec_and_test(&sd->s_count))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205 release_sysfs_dirent(sd);
206}
Neil Brownf1282c82008-07-16 08:58:04 +1000207#define sysfs_put(sd) __sysfs_put(sd)
Tejun Heo59f69012007-09-20 16:05:10 +0900208
209/*
210 * inode.c
211 */
Eric W. Biedermanfac26222010-02-12 19:22:27 -0800212struct inode *sysfs_get_inode(struct super_block *sb, struct sysfs_dirent *sd);
Al Viro01cd9fe2010-06-04 22:21:54 -0400213void sysfs_evict_inode(struct inode *inode);
Eric W. Biederman35df63c2009-11-20 16:08:50 -0800214int sysfs_sd_setattr(struct sysfs_dirent *sd, struct iattr *iattr);
Al Viro10556cb2011-06-20 19:28:19 -0400215int sysfs_permission(struct inode *inode, int mask);
Tejun Heo59f69012007-09-20 16:05:10 +0900216int sysfs_setattr(struct dentry *dentry, struct iattr *iattr);
Greg Kroah-Hartman2c3a9082013-08-21 16:40:05 -0700217int sysfs_getattr(struct vfsmount *mnt, struct dentry *dentry,
218 struct kstat *stat);
David P. Quigleyddd29ec2009-09-09 14:25:37 -0400219int sysfs_setxattr(struct dentry *dentry, const char *name, const void *value,
Greg Kroah-Hartman2c3a9082013-08-21 16:40:05 -0700220 size_t size, int flags);
221int sysfs_hash_and_remove(struct sysfs_dirent *dir_sd, const void *ns,
222 const char *name);
Peter Zijlstrae0bf68d2007-10-16 23:25:46 -0700223int sysfs_inode_init(void);
Tejun Heo59f69012007-09-20 16:05:10 +0900224
225/*
226 * file.c
227 */
228extern const struct file_operations sysfs_file_operations;
229
230int sysfs_add_file(struct sysfs_dirent *dir_sd,
231 const struct attribute *attr, int type);
232
James Bottomley0f423892008-03-20 20:47:52 -0500233int sysfs_add_file_mode(struct sysfs_dirent *dir_sd,
Al Virofaef2b62011-07-24 23:44:53 -0400234 const struct attribute *attr, int type, umode_t amode);
Tejun Heo59f69012007-09-20 16:05:10 +0900235/*
236 * bin.c
237 */
238extern const struct file_operations bin_fops;
Eric W. Biedermane0edd3c2009-03-04 11:57:20 -0800239void unmap_bin_file(struct sysfs_dirent *attr_sd);
Tejun Heo59f69012007-09-20 16:05:10 +0900240
241/*
242 * symlink.c
243 */
244extern const struct inode_operations sysfs_symlink_inode_operations;
Rafael J. Wysocki0bb8f3d2013-01-25 21:51:13 +0100245int sysfs_create_link_sd(struct sysfs_dirent *sd, struct kobject *target,
246 const char *name);