[linux-2.6-block.git] / fs / sysfs / inode.c

/*
 * fs/sysfs/inode.c - basic sysfs inode and dentry operations
 *
 * Copyright (c) 2001-3 Patrick Mochel
 * Copyright (c) 2007 SUSE Linux Products GmbH
 * Copyright (c) 2007 Tejun Heo <teheo@suse.de>
 *
 * This file is released under the GPLv2.
 *
 * Please see Documentation/filesystems/sysfs.txt for more information.
 */

#undef DEBUG 

#include <linux/pagemap.h>
#include <linux/namei.h>
#include <linux/backing-dev.h>
#include <linux/capability.h>
#include <linux/errno.h>
#include <linux/sched.h>
#include "sysfs.h"

extern struct super_block * sysfs_sb;

static const struct address_space_operations sysfs_aops = {
	.readpage	= simple_readpage,
	.write_begin	= simple_write_begin,
	.write_end	= simple_write_end,
};

static struct backing_dev_info sysfs_backing_dev_info = {
	.ra_pages	= 0,	/* No readahead */
	.capabilities	= BDI_CAP_NO_ACCT_AND_WRITEBACK,
};

static const struct inode_operations sysfs_inode_operations ={
	.setattr	= sysfs_setattr,
};

int __init sysfs_inode_init(void)
{
	return bdi_init(&sysfs_backing_dev_info);
}

int sysfs_setattr(struct dentry * dentry, struct iattr * iattr)
{
	struct inode * inode = dentry->d_inode;
	struct sysfs_dirent * sd = dentry->d_fsdata;
	struct iattr * sd_iattr;
	unsigned int ia_valid = iattr->ia_valid;
	int error;

	if (!sd)
		return -EINVAL;

	sd_iattr = sd->s_iattr;

	error = inode_change_ok(inode, iattr);
	if (error)
		return error;

	iattr->ia_valid &= ~ATTR_SIZE; /* ignore size changes */

	error = inode_setattr(inode, iattr);
	if (error)
		return error;

	if (!sd_iattr) {
		/* setting attributes for the first time, allocate now */
		sd_iattr = kzalloc(sizeof(struct iattr), GFP_KERNEL);
		if (!sd_iattr)
			return -ENOMEM;
		/* assign default attributes */
		sd_iattr->ia_mode = sd->s_mode;
		sd_iattr->ia_uid = 0;
		sd_iattr->ia_gid = 0;
		sd_iattr->ia_atime = sd_iattr->ia_mtime = sd_iattr->ia_ctime = CURRENT_TIME;
		sd->s_iattr = sd_iattr;
	}

	/* attributes were changed atleast once in past */

	if (ia_valid & ATTR_UID)
		sd_iattr->ia_uid = iattr->ia_uid;
	if (ia_valid & ATTR_GID)
		sd_iattr->ia_gid = iattr->ia_gid;
	if (ia_valid & ATTR_ATIME)
		sd_iattr->ia_atime = timespec_trunc(iattr->ia_atime,
						inode->i_sb->s_time_gran);
	if (ia_valid & ATTR_MTIME)
		sd_iattr->ia_mtime = timespec_trunc(iattr->ia_mtime,
						inode->i_sb->s_time_gran);
	if (ia_valid & ATTR_CTIME)
		sd_iattr->ia_ctime = timespec_trunc(iattr->ia_ctime,
						inode->i_sb->s_time_gran);
	if (ia_valid & ATTR_MODE) {
		umode_t mode = iattr->ia_mode;

		if (!in_group_p(inode->i_gid) && !capable(CAP_FSETID))
			mode &= ~S_ISGID;
		sd_iattr->ia_mode = sd->s_mode = mode;
	}

	return error;
}

static inline void set_default_inode_attr(struct inode * inode, mode_t mode)
{
	inode->i_mode = mode;
	inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
}

static inline void set_inode_attr(struct inode * inode, struct iattr * iattr)
{
	inode->i_mode = iattr->ia_mode;
	inode->i_uid = iattr->ia_uid;
	inode->i_gid = iattr->ia_gid;
	inode->i_atime = iattr->ia_atime;
	inode->i_mtime = iattr->ia_mtime;
	inode->i_ctime = iattr->ia_ctime;
}


/*
 * sysfs has a different i_mutex lock order behavior for i_mutex than other
 * filesystems; sysfs i_mutex is called in many places with subsystem locks
 * held. At the same time, many of the VFS locking rules do not apply to
 * sysfs at all (cross directory rename for example). To untangle this mess
 * (which gives false positives in lockdep), we're giving sysfs inodes their
 * own class for i_mutex.
 */
static struct lock_class_key sysfs_inode_imutex_key;

static int sysfs_count_nlink(struct sysfs_dirent *sd)
{
	struct sysfs_dirent *child;
	int nr = 0;

	for (child = sd->s_dir.children; child; child = child->s_sibling)
		if (sysfs_type(child) == SYSFS_DIR)
			nr++;

	return nr + 2;
}

static void sysfs_init_inode(struct sysfs_dirent *sd, struct inode *inode)
{
	struct bin_attribute *bin_attr;

	inode->i_private = sysfs_get(sd);
	inode->i_mapping->a_ops = &sysfs_aops;
	inode->i_mapping->backing_dev_info = &sysfs_backing_dev_info;
	inode->i_op = &sysfs_inode_operations;
	inode->i_ino = sd->s_ino;
	lockdep_set_class(&inode->i_mutex, &sysfs_inode_imutex_key);

	if (sd->s_iattr) {
		/* sysfs_dirent has non-default attributes
		 * get them for the new inode from persistent copy
		 * in sysfs_dirent
		 */
		set_inode_attr(inode, sd->s_iattr);
	} else
		set_default_inode_attr(inode, sd->s_mode);


	/* initialize inode according to type */
	switch (sysfs_type(sd)) {
	case SYSFS_DIR:
		inode->i_op = &sysfs_dir_inode_operations;
		inode->i_fop = &sysfs_dir_operations;
		inode->i_nlink = sysfs_count_nlink(sd);
		break;
	case SYSFS_KOBJ_ATTR:
		inode->i_size = PAGE_SIZE;
		inode->i_fop = &sysfs_file_operations;
		break;
	case SYSFS_KOBJ_BIN_ATTR:
		bin_attr = sd->s_bin_attr.bin_attr;
		inode->i_size = bin_attr->size;
		inode->i_fop = &bin_fops;
		break;
	case SYSFS_KOBJ_LINK:
		inode->i_op = &sysfs_symlink_inode_operations;
		break;
	default:
		BUG();
	}

	unlock_new_inode(inode);
}

/**
 *	sysfs_get_inode - get inode for sysfs_dirent
 *	@sd: sysfs_dirent to allocate inode for
 *
 *	Get inode for @sd.  If such inode doesn't exist, a new inode
 *	is allocated and basics are initialized.  New inode is
 *	returned locked.
 *
 *	LOCKING:
 *	Kernel thread context (may sleep).
 *
 *	RETURNS:
 *	Pointer to allocated inode on success, NULL on failure.
 */
struct inode * sysfs_get_inode(struct sysfs_dirent *sd)
{
	struct inode *inode;

	inode = iget_locked(sysfs_sb, sd->s_ino);
	if (inode && (inode->i_state & I_NEW))
		sysfs_init_inode(sd, inode);

	return inode;
}

/*
 * The sysfs_dirent serves as both an inode and a directory entry for sysfs.
 * To prevent the sysfs inode numbers from being freed prematurely we take a
 * reference to sysfs_dirent from the sysfs inode.  A
 * super_operations.delete_inode() implementation is needed to drop that
 * reference upon inode destruction.
 */
void sysfs_delete_inode(struct inode *inode)
{
	struct sysfs_dirent *sd  = inode->i_private;

	truncate_inode_pages(&inode->i_data, 0);
	clear_inode(inode);
	sysfs_put(sd);
}

int sysfs_hash_and_remove(struct sysfs_dirent *dir_sd, const char *name)
{
	struct sysfs_addrm_cxt acxt;
	struct sysfs_dirent *sd;

	if (!dir_sd)
		return -ENOENT;

	sysfs_addrm_start(&acxt, dir_sd);

	sd = sysfs_find_dirent(dir_sd, name);
	if (sd)
		sysfs_remove_one(&acxt, sd);

	sysfs_addrm_finish(&acxt);

	if (sd)
		return 0;
	else
		return -ENOENT;
}
Commit	Line	Data
1da177e4	1	/*
6d66f5cd	2	* fs/sysfs/inode.c - basic sysfs inode and dentry operations
1da177e4	3	*
6d66f5cd TH	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.
1da177e4 LT	9	*
	10	* Please see Documentation/filesystems/sysfs.txt for more information.
	11	*/
	12
	13	#undef DEBUG
	14
	15	#include <linux/pagemap.h>
	16	#include <linux/namei.h>
	17	#include <linux/backing-dev.h>
16f7e0fe	18	#include <linux/capability.h>
995982ca	19	#include <linux/errno.h>
e8edc6e0	20	#include <linux/sched.h>
1da177e4 LT	21	#include "sysfs.h"
	22
	23	extern struct super_block * sysfs_sb;
	24
f5e54d6e	25	static const struct address_space_operations sysfs_aops = {
1da177e4	26	.readpage = simple_readpage,
800d15a5 NP	27	.write_begin = simple_write_begin,
800d15a5 NP	28	.write_end = simple_write_end,
1da177e4 LT	29	};
	30
	31	static struct backing_dev_info sysfs_backing_dev_info = {
	32	.ra_pages = 0, /* No readahead */
e4ad08fe	33	.capabilities = BDI_CAP_NO_ACCT_AND_WRITEBACK,
1da177e4 LT	34	};
1da177e4 LT	35
c5ef1c42	36	static const struct inode_operations sysfs_inode_operations ={
988d186d MS	37	.setattr = sysfs_setattr,
	38	};
	39
e0bf68dd PZ	40	int __init sysfs_inode_init(void)
	41	{
	42	return bdi_init(&sysfs_backing_dev_info);
	43	}
	44
988d186d MS	45	int sysfs_setattr(struct dentry * dentry, struct iattr * iattr)
	46	{
	47	struct inode * inode = dentry->d_inode;
	48	struct sysfs_dirent * sd = dentry->d_fsdata;
	49	struct iattr * sd_iattr;
	50	unsigned int ia_valid = iattr->ia_valid;
	51	int error;
	52
	53	if (!sd)
	54	return -EINVAL;
	55
	56	sd_iattr = sd->s_iattr;
	57
	58	error = inode_change_ok(inode, iattr);
	59	if (error)
	60	return error;
	61
40a2159a BH	62	iattr->ia_valid &= ~ATTR_SIZE; /* ignore size changes */
40a2159a BH	63
988d186d MS	64	error = inode_setattr(inode, iattr);
	65	if (error)
	66	return error;
	67
	68	if (!sd_iattr) {
	69	/* setting attributes for the first time, allocate now */
58d49283	70	sd_iattr = kzalloc(sizeof(struct iattr), GFP_KERNEL);
988d186d MS	71	if (!sd_iattr)
	72	return -ENOMEM;
	73	/* assign default attributes */
988d186d MS	74	sd_iattr->ia_mode = sd->s_mode;
	75	sd_iattr->ia_uid = 0;
	76	sd_iattr->ia_gid = 0;
	77	sd_iattr->ia_atime = sd_iattr->ia_mtime = sd_iattr->ia_ctime = CURRENT_TIME;
	78	sd->s_iattr = sd_iattr;
	79	}
	80
	81	/* attributes were changed atleast once in past */
	82
	83	if (ia_valid & ATTR_UID)
	84	sd_iattr->ia_uid = iattr->ia_uid;
	85	if (ia_valid & ATTR_GID)
	86	sd_iattr->ia_gid = iattr->ia_gid;
	87	if (ia_valid & ATTR_ATIME)
	88	sd_iattr->ia_atime = timespec_trunc(iattr->ia_atime,
	89	inode->i_sb->s_time_gran);
	90	if (ia_valid & ATTR_MTIME)
	91	sd_iattr->ia_mtime = timespec_trunc(iattr->ia_mtime,
	92	inode->i_sb->s_time_gran);
	93	if (ia_valid & ATTR_CTIME)
	94	sd_iattr->ia_ctime = timespec_trunc(iattr->ia_ctime,
	95	inode->i_sb->s_time_gran);
	96	if (ia_valid & ATTR_MODE) {
	97	umode_t mode = iattr->ia_mode;
	98
	99	if (!in_group_p(inode->i_gid) && !capable(CAP_FSETID))
	100	mode &= ~S_ISGID;
9ca1eb32	101	sd_iattr->ia_mode = sd->s_mode = mode;
988d186d MS	102	}
	103
	104	return error;
	105	}
	106
8215534c MS	107	static inline void set_default_inode_attr(struct inode * inode, mode_t mode)
	108	{
	109	inode->i_mode = mode;
8215534c MS	110	inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
	111	}
	112
	113	static inline void set_inode_attr(struct inode * inode, struct iattr * iattr)
	114	{
	115	inode->i_mode = iattr->ia_mode;
	116	inode->i_uid = iattr->ia_uid;
	117	inode->i_gid = iattr->ia_gid;
	118	inode->i_atime = iattr->ia_atime;
	119	inode->i_mtime = iattr->ia_mtime;
	120	inode->i_ctime = iattr->ia_ctime;
	121	}
	122
232ba9db AV	123
	124	/*
	125	* sysfs has a different i_mutex lock order behavior for i_mutex than other
	126	* filesystems; sysfs i_mutex is called in many places with subsystem locks
	127	* held. At the same time, many of the VFS locking rules do not apply to
	128	* sysfs at all (cross directory rename for example). To untangle this mess
	129	* (which gives false positives in lockdep), we're giving sysfs inodes their
	130	* own class for i_mutex.
	131	*/
	132	static struct lock_class_key sysfs_inode_imutex_key;
	133
372e88bd EB	134	static int sysfs_count_nlink(struct sysfs_dirent *sd)
	135	{
	136	struct sysfs_dirent *child;
	137	int nr = 0;
	138
bc747f37	139	for (child = sd->s_dir.children; child; child = child->s_sibling)
372e88bd EB	140	if (sysfs_type(child) == SYSFS_DIR)
	141	nr++;
	142
	143	return nr + 2;
	144	}
	145
bc37e283	146	static void sysfs_init_inode(struct sysfs_dirent sd, struct inode inode)
1da177e4	147	{
372e88bd EB	148	struct bin_attribute *bin_attr;
372e88bd EB	149
04256b4a	150	inode->i_private = sysfs_get(sd);
fc9f54b9 TH	151	inode->i_mapping->a_ops = &sysfs_aops;
	152	inode->i_mapping->backing_dev_info = &sysfs_backing_dev_info;
	153	inode->i_op = &sysfs_inode_operations;
	154	inode->i_ino = sd->s_ino;
	155	lockdep_set_class(&inode->i_mutex, &sysfs_inode_imutex_key);
	156
	157	if (sd->s_iattr) {
	158	/* sysfs_dirent has non-default attributes
	159	* get them for the new inode from persistent copy
	160	* in sysfs_dirent
	161	*/
	162	set_inode_attr(inode, sd->s_iattr);
	163	} else
	164	set_default_inode_attr(inode, sd->s_mode);
372e88bd EB	165
	166
	167	/* initialize inode according to type */
	168	switch (sysfs_type(sd)) {
372e88bd EB	169	case SYSFS_DIR:
	170	inode->i_op = &sysfs_dir_inode_operations;
	171	inode->i_fop = &sysfs_dir_operations;
	172	inode->i_nlink = sysfs_count_nlink(sd);
	173	break;
	174	case SYSFS_KOBJ_ATTR:
	175	inode->i_size = PAGE_SIZE;
	176	inode->i_fop = &sysfs_file_operations;
	177	break;
	178	case SYSFS_KOBJ_BIN_ATTR:
b1fc3d61	179	bin_attr = sd->s_bin_attr.bin_attr;
372e88bd EB	180	inode->i_size = bin_attr->size;
	181	inode->i_fop = &bin_fops;
	182	break;
	183	case SYSFS_KOBJ_LINK:
	184	inode->i_op = &sysfs_symlink_inode_operations;
	185	break;
	186	default:
	187	BUG();
	188	}
	189
	190	unlock_new_inode(inode);
fc9f54b9 TH	191	}
	192
	193	/**
8312a8d7	194	* sysfs_get_inode - get inode for sysfs_dirent
fc9f54b9 TH	195	* @sd: sysfs_dirent to allocate inode for
fc9f54b9 TH	196	*
8312a8d7 TH	197	* Get inode for @sd. If such inode doesn't exist, a new inode
	198	* is allocated and basics are initialized. New inode is
	199	* returned locked.
fc9f54b9 TH	200	*
	201	* LOCKING:
	202	* Kernel thread context (may sleep).
	203	*
	204	* RETURNS:
	205	* Pointer to allocated inode on success, NULL on failure.
	206	*/
8312a8d7	207	struct inode * sysfs_get_inode(struct sysfs_dirent *sd)
fc9f54b9 TH	208	{
	209	struct inode *inode;
	210
8312a8d7 TH	211	inode = iget_locked(sysfs_sb, sd->s_ino);
8312a8d7 TH	212	if (inode && (inode->i_state & I_NEW))
fc9f54b9 TH	213	sysfs_init_inode(sd, inode);
fc9f54b9 TH	214
1da177e4 LT	215	return inode;
	216	}
	217
04256b4a EB	218	/*
	219	* The sysfs_dirent serves as both an inode and a directory entry for sysfs.
	220	* To prevent the sysfs inode numbers from being freed prematurely we take a
	221	* reference to sysfs_dirent from the sysfs inode. A
	222	* super_operations.delete_inode() implementation is needed to drop that
	223	* reference upon inode destruction.
	224	*/
	225	void sysfs_delete_inode(struct inode *inode)
	226	{
	227	struct sysfs_dirent *sd = inode->i_private;
	228
	229	truncate_inode_pages(&inode->i_data, 0);
	230	clear_inode(inode);
	231	sysfs_put(sd);
	232	}
	233
608e266a	234	int sysfs_hash_and_remove(struct sysfs_dirent dir_sd, const char name)
1da177e4	235	{
fb6896da	236	struct sysfs_addrm_cxt acxt;
41fc1c27	237	struct sysfs_dirent *sd;
641e6f30	238
608e266a	239	if (!dir_sd)
995982ca	240	return -ENOENT;
1da177e4	241
fb6896da	242	sysfs_addrm_start(&acxt, dir_sd);
608e266a	243
41fc1c27 TH	244	sd = sysfs_find_dirent(dir_sd, name);
	245	if (sd)
	246	sysfs_remove_one(&acxt, sd);
3007e997	247
990e53f8 TH	248	sysfs_addrm_finish(&acxt);
	249
	250	if (sd)
fb6896da	251	return 0;
990e53f8 TH	252	else
990e53f8 TH	253	return -ENOENT;
1da177e4	254	}