blob: 3d28af31d86300ecbddde7b4dc9d7eb25a255dc6 [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>
14
Tejun Heo85a4ffa2007-09-20 16:05:12 +090015struct sysfs_open_dirent;
16
Tejun Heo59f69012007-09-20 16:05:10 +090017/* type-specific structures for sysfs_dirent->s_* union members */
Tejun Heo3e519032007-06-14 03:45:15 +090018struct sysfs_elem_dir {
Tejun Heo59f69012007-09-20 16:05:10 +090019 struct kobject *kobj;
Tejun Heobc747f32007-09-20 16:05:12 +090020 /* children list starts here and goes through sd->s_sibling */
21 struct sysfs_dirent *children;
Tejun Heo3e519032007-06-14 03:45:15 +090022};
23
24struct sysfs_elem_symlink {
Tejun Heo59f69012007-09-20 16:05:10 +090025 struct sysfs_dirent *target_sd;
Tejun Heo3e519032007-06-14 03:45:15 +090026};
27
28struct sysfs_elem_attr {
Tejun Heo59f69012007-09-20 16:05:10 +090029 struct attribute *attr;
Tejun Heo85a4ffa2007-09-20 16:05:12 +090030 struct sysfs_open_dirent *open;
Tejun Heo3e519032007-06-14 03:45:15 +090031};
32
33struct sysfs_elem_bin_attr {
Tejun Heo59f69012007-09-20 16:05:10 +090034 struct bin_attribute *bin_attr;
Eric W. Biedermane0edd3c2009-03-04 11:57:20 -080035 struct hlist_head buffers;
Tejun Heo3e519032007-06-14 03:45:15 +090036};
37
David P. Quigleyddd29ec2009-09-09 14:25:37 -040038struct sysfs_inode_attrs {
39 struct iattr ia_iattr;
40 void *ia_secdata;
41 u32 ia_secdata_len;
42};
43
Tejun Heo0ab66082007-06-14 03:45:16 +090044/*
Tejun Heo59f69012007-09-20 16:05:10 +090045 * sysfs_dirent - the building block of sysfs hierarchy. Each and
46 * every sysfs node is represented by single sysfs_dirent.
47 *
Tejun Heo0ab66082007-06-14 03:45:16 +090048 * As long as s_count reference is held, the sysfs_dirent itself is
49 * accessible. Dereferencing s_elem or any other outer entity
50 * requires s_active reference.
51 */
Adam J. Richterd56c3ea2007-02-16 21:35:25 +080052struct sysfs_dirent {
53 atomic_t s_count;
Tejun Heo8619f972007-06-14 03:45:18 +090054 atomic_t s_active;
Eric W. Biederman846f9972010-01-02 13:37:12 -080055#ifdef CONFIG_DEBUG_LOCK_ALLOC
56 struct lockdep_map dep_map;
57#endif
Tejun Heo59f69012007-09-20 16:05:10 +090058 struct sysfs_dirent *s_parent;
59 struct sysfs_dirent *s_sibling;
Tejun Heo59f69012007-09-20 16:05:10 +090060 const char *s_name;
Tejun Heo3e519032007-06-14 03:45:15 +090061
Serge E. Hallynbe867b12010-05-03 16:23:15 -050062 const void *s_ns; /* namespace tag */
Tejun Heo3e519032007-06-14 03:45:15 +090063 union {
Tejun Heob1fc3d62007-09-20 16:05:11 +090064 struct sysfs_elem_dir s_dir;
65 struct sysfs_elem_symlink s_symlink;
66 struct sysfs_elem_attr s_attr;
67 struct sysfs_elem_bin_attr s_bin_attr;
68 };
Tejun Heo3e519032007-06-14 03:45:15 +090069
Tejun Heob402d722007-06-14 04:27:21 +090070 unsigned int s_flags;
Eric W. Biederman19c38b62010-02-12 19:22:24 -080071 unsigned short s_mode;
Eric Sandeendc351252007-06-11 14:02:45 +090072 ino_t s_ino;
David P. Quigleyddd29ec2009-09-09 14:25:37 -040073 struct sysfs_inode_attrs *s_iattr;
Adam J. Richterd56c3ea2007-02-16 21:35:25 +080074};
Linus Torvalds1da177e2005-04-16 15:20:36 -070075
Tejun Heo59f69012007-09-20 16:05:10 +090076#define SD_DEACTIVATED_BIAS INT_MIN
Tejun Heo0ab66082007-06-14 03:45:16 +090077
Tejun Heo59f69012007-09-20 16:05:10 +090078#define SYSFS_TYPE_MASK 0x00ff
Tejun Heodc2f75f2007-09-20 16:05:12 +090079#define SYSFS_DIR 0x0001
80#define SYSFS_KOBJ_ATTR 0x0002
81#define SYSFS_KOBJ_BIN_ATTR 0x0004
82#define SYSFS_KOBJ_LINK 0x0008
Tejun Heo59f69012007-09-20 16:05:10 +090083#define SYSFS_COPY_NAME (SYSFS_DIR | SYSFS_KOBJ_LINK)
Eric W. Biedermana2db6842010-02-11 15:20:00 -080084#define SYSFS_ACTIVE_REF (SYSFS_KOBJ_ATTR | SYSFS_KOBJ_BIN_ATTR)
Tejun Heo59f69012007-09-20 16:05:10 +090085
Serge E. Hallynbe867b12010-05-03 16:23:15 -050086/* identify any namespace tag on sysfs_dirents */
Eric W. Biederman3ff195b2010-03-30 11:31:26 -070087#define SYSFS_NS_TYPE_MASK 0xff00
88#define SYSFS_NS_TYPE_SHIFT 8
89
90#define SYSFS_FLAG_MASK ~(SYSFS_NS_TYPE_MASK|SYSFS_TYPE_MASK)
91#define SYSFS_FLAG_REMOVED 0x020000
Tejun Heo59f69012007-09-20 16:05:10 +090092
93static inline unsigned int sysfs_type(struct sysfs_dirent *sd)
94{
95 return sd->s_flags & SYSFS_TYPE_MASK;
96}
97
Serge E. Hallynbe867b12010-05-03 16:23:15 -050098/*
99 * Return any namespace tags on this dirent.
100 * enum kobj_ns_type is defined in linux/kobject.h
101 */
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700102static inline enum kobj_ns_type sysfs_ns_type(struct sysfs_dirent *sd)
103{
104 return (sd->s_flags & SYSFS_NS_TYPE_MASK) >> SYSFS_NS_TYPE_SHIFT;
105}
106
Eric W. Biederman846f9972010-01-02 13:37:12 -0800107#ifdef CONFIG_DEBUG_LOCK_ALLOC
108#define sysfs_dirent_init_lockdep(sd) \
109do { \
Eric W. Biederman6992f532010-02-11 15:21:53 -0800110 struct attribute *attr = sd->s_attr.attr; \
111 struct lock_class_key *key = attr->key; \
112 if (!key) \
113 key = &attr->skey; \
Eric W. Biederman846f9972010-01-02 13:37:12 -0800114 \
Eric W. Biederman6992f532010-02-11 15:21:53 -0800115 lockdep_init_map(&sd->dep_map, "s_active", key, 0); \
Eric W. Biederman846f9972010-01-02 13:37:12 -0800116} while(0)
117#else
118#define sysfs_dirent_init_lockdep(sd) do {} while(0)
119#endif
120
Tejun Heo59f69012007-09-20 16:05:10 +0900121/*
122 * Context structure to be used while adding/removing nodes.
123 */
Tejun Heofb6896d2007-06-14 04:27:24 +0900124struct sysfs_addrm_cxt {
125 struct sysfs_dirent *parent_sd;
Tejun Heofb6896d2007-06-14 04:27:24 +0900126 struct sysfs_dirent *removed;
Tejun Heofb6896d2007-06-14 04:27:24 +0900127};
128
Tejun Heo59f69012007-09-20 16:05:10 +0900129/*
130 * mount.c
131 */
Serge E. Hallynbe867b12010-05-03 16:23:15 -0500132
133/*
134 * Each sb is associated with a set of namespace tags (i.e.
135 * the network namespace of the task which mounted this sysfs
136 * instance).
137 */
Eric W. Biederman9e7fdd22010-03-30 11:31:24 -0700138struct sysfs_super_info {
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700139 const void *ns[KOBJ_NS_TYPES];
Eric W. Biederman9e7fdd22010-03-30 11:31:24 -0700140};
141#define sysfs_info(SB) ((struct sysfs_super_info *)(SB->s_fs_info))
Tejun Heo51225032007-06-14 04:27:25 +0900142extern struct sysfs_dirent sysfs_root;
Christoph Lametere18b8902006-12-06 20:33:20 -0800143extern struct kmem_cache *sysfs_dir_cachep;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144
Tejun Heo59f69012007-09-20 16:05:10 +0900145/*
146 * dir.c
147 */
Tejun Heo3007e992007-06-14 04:27:23 +0900148extern struct mutex sysfs_mutex;
Tejun Heo59f69012007-09-20 16:05:10 +0900149extern spinlock_t sysfs_assoc_lock;
150
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -0800151extern const struct file_operations sysfs_dir_operations;
Arjan van de Venc5ef1c42007-02-12 00:55:40 -0800152extern const struct inode_operations sysfs_dir_inode_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153
Tejun Heo59f69012007-09-20 16:05:10 +0900154struct dentry *sysfs_get_dentry(struct sysfs_dirent *sd);
Eric W. Biedermane72ceb82010-02-11 15:18:38 -0800155struct sysfs_dirent *sysfs_get_active(struct sysfs_dirent *sd);
156void sysfs_put_active(struct sysfs_dirent *sd);
Tejun Heo59f69012007-09-20 16:05:10 +0900157void sysfs_addrm_start(struct sysfs_addrm_cxt *acxt,
158 struct sysfs_dirent *parent_sd);
Cornelia Huck36ce6da2008-06-10 11:09:08 +0200159int __sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd);
Tejun Heo59f69012007-09-20 16:05:10 +0900160int sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd);
161void sysfs_remove_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd);
162void sysfs_addrm_finish(struct sysfs_addrm_cxt *acxt);
Tejun Heob402d722007-06-14 04:27:21 +0900163
Tejun Heo59f69012007-09-20 16:05:10 +0900164struct sysfs_dirent *sysfs_find_dirent(struct sysfs_dirent *parent_sd,
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700165 const void *ns,
Tejun Heo59f69012007-09-20 16:05:10 +0900166 const unsigned char *name);
167struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700168 const void *ns,
Tejun Heo59f69012007-09-20 16:05:10 +0900169 const unsigned char *name);
170struct sysfs_dirent *sysfs_new_dirent(const char *name, umode_t mode, int type);
171
172void release_sysfs_dirent(struct sysfs_dirent *sd);
173
174int sysfs_create_subdir(struct kobject *kobj, const char *name,
175 struct sysfs_dirent **p_sd);
176void sysfs_remove_subdir(struct sysfs_dirent *sd);
177
Eric W. Biedermanca1bab32009-11-20 16:08:57 -0800178int sysfs_rename(struct sysfs_dirent *sd,
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700179 struct sysfs_dirent *new_parent_sd, const void *ns, const char *new_name);
Eric W. Biedermanca1bab32009-11-20 16:08:57 -0800180
Neil Brownf1282c82008-07-16 08:58:04 +1000181static inline struct sysfs_dirent *__sysfs_get(struct sysfs_dirent *sd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182{
183 if (sd) {
184 WARN_ON(!atomic_read(&sd->s_count));
185 atomic_inc(&sd->s_count);
186 }
187 return sd;
188}
Neil Brownf1282c82008-07-16 08:58:04 +1000189#define sysfs_get(sd) __sysfs_get(sd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190
Neil Brownf1282c82008-07-16 08:58:04 +1000191static inline void __sysfs_put(struct sysfs_dirent *sd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192{
Tejun Heo7a23ad42007-06-14 03:45:13 +0900193 if (sd && atomic_dec_and_test(&sd->s_count))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194 release_sysfs_dirent(sd);
195}
Neil Brownf1282c82008-07-16 08:58:04 +1000196#define sysfs_put(sd) __sysfs_put(sd)
Tejun Heo59f69012007-09-20 16:05:10 +0900197
198/*
199 * inode.c
200 */
Eric W. Biedermanfac26222010-02-12 19:22:27 -0800201struct inode *sysfs_get_inode(struct super_block *sb, struct sysfs_dirent *sd);
Al Viro01cd9fe2010-06-04 22:21:54 -0400202void sysfs_evict_inode(struct inode *inode);
Eric W. Biederman35df63c2009-11-20 16:08:50 -0800203int sysfs_sd_setattr(struct sysfs_dirent *sd, struct iattr *iattr);
Nick Pigginb74c79e2011-01-07 17:49:58 +1100204int sysfs_permission(struct inode *inode, int mask, unsigned int flags);
Tejun Heo59f69012007-09-20 16:05:10 +0900205int sysfs_setattr(struct dentry *dentry, struct iattr *iattr);
Eric W. Biedermane61ab4a2009-11-20 16:08:53 -0800206int sysfs_getattr(struct vfsmount *mnt, struct dentry *dentry, struct kstat *stat);
David P. Quigleyddd29ec2009-09-09 14:25:37 -0400207int sysfs_setxattr(struct dentry *dentry, const char *name, const void *value,
208 size_t size, int flags);
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700209int sysfs_hash_and_remove(struct sysfs_dirent *dir_sd, const void *ns, const char *name);
Peter Zijlstrae0bf68d2007-10-16 23:25:46 -0700210int sysfs_inode_init(void);
Tejun Heo59f69012007-09-20 16:05:10 +0900211
212/*
213 * file.c
214 */
215extern const struct file_operations sysfs_file_operations;
216
217int sysfs_add_file(struct sysfs_dirent *dir_sd,
218 const struct attribute *attr, int type);
219
James Bottomley0f423892008-03-20 20:47:52 -0500220int sysfs_add_file_mode(struct sysfs_dirent *dir_sd,
221 const struct attribute *attr, int type, mode_t amode);
Tejun Heo59f69012007-09-20 16:05:10 +0900222/*
223 * bin.c
224 */
225extern const struct file_operations bin_fops;
Eric W. Biedermane0edd3c2009-03-04 11:57:20 -0800226void unmap_bin_file(struct sysfs_dirent *attr_sd);
Tejun Heo59f69012007-09-20 16:05:10 +0900227
228/*
229 * symlink.c
230 */
231extern const struct inode_operations sysfs_symlink_inode_operations;