[linux-2.6-block.git] / fs / kernfs / kernfs-internal.h

/*
 * fs/kernfs/kernfs-internal.h - kernfs internal header file
 *
 * Copyright (c) 2001-3 Patrick Mochel
 * Copyright (c) 2007 SUSE Linux Products GmbH
 * Copyright (c) 2007, 2013 Tejun Heo <teheo@suse.de>
 *
 * This file is released under the GPLv2.
 */

#ifndef __KERNFS_INTERNAL_H
#define __KERNFS_INTERNAL_H

#include <linux/lockdep.h>
#include <linux/fs.h>
#include <linux/mutex.h>
#include <linux/xattr.h>

#include <linux/kernfs.h>

struct kernfs_iattrs {
	struct iattr		ia_iattr;
	void			*ia_secdata;
	u32			ia_secdata_len;

	struct simple_xattrs	xattrs;
};

/* +1 to avoid triggering overflow warning when negating it */
#define KN_DEACTIVATED_BIAS		(INT_MIN + 1)

/* KERNFS_TYPE_MASK and types are defined in include/linux/kernfs.h */

/**
 * kernfs_root - find out the kernfs_root a kernfs_node belongs to
 * @kn: kernfs_node of interest
 *
 * Return the kernfs_root @kn belongs to.
 */
static inline struct kernfs_root *kernfs_root(struct kernfs_node *kn)
{
	/* if parent exists, it's always a dir; otherwise, @sd is a dir */
	if (kn->parent)
		kn = kn->parent;
	return kn->dir.root;
}

/*
 * mount.c
 */
struct kernfs_super_info {
	struct super_block	*sb;

	/*
	 * The root associated with this super_block.  Each super_block is
	 * identified by the root and ns it's associated with.
	 */
	struct kernfs_root	*root;

	/*
	 * Each sb is associated with one namespace tag, currently the
	 * network namespace of the task which mounted this kernfs
	 * instance.  If multiple tags become necessary, make the following
	 * an array and compare kernfs_node tag against every entry.
	 */
	const void		*ns;

	/* anchored at kernfs_root->supers, protected by kernfs_mutex */
	struct list_head	node;
};
#define kernfs_info(SB) ((struct kernfs_super_info *)(SB->s_fs_info))

extern const struct super_operations kernfs_sops;
extern struct kmem_cache *kernfs_node_cache;

/*
 * inode.c
 */
void kernfs_evict_inode(struct inode *inode);
int kernfs_iop_permission(struct inode *inode, int mask);
int kernfs_iop_setattr(struct dentry *dentry, struct iattr *iattr);
int kernfs_iop_getattr(struct vfsmount *mnt, struct dentry *dentry,
		       struct kstat *stat);
int kernfs_iop_setxattr(struct dentry *dentry, struct inode *inode,
			const char *name, const void *value,
			size_t size, int flags);
int kernfs_iop_removexattr(struct dentry *dentry, const char *name);
ssize_t kernfs_iop_getxattr(struct dentry *dentry, struct inode *inode,
			    const char *name, void *buf, size_t size);
ssize_t kernfs_iop_listxattr(struct dentry *dentry, char *buf, size_t size);

/*
 * dir.c
 */
extern struct mutex kernfs_mutex;
extern const struct dentry_operations kernfs_dops;
extern const struct file_operations kernfs_dir_fops;
extern const struct inode_operations kernfs_dir_iops;

struct kernfs_node *kernfs_get_active(struct kernfs_node *kn);
void kernfs_put_active(struct kernfs_node *kn);
int kernfs_add_one(struct kernfs_node *kn);
struct kernfs_node *kernfs_new_node(struct kernfs_node *parent,
				    const char *name, umode_t mode,
				    unsigned flags);

/*
 * file.c
 */
extern const struct file_operations kernfs_file_fops;

void kernfs_unmap_bin_file(struct kernfs_node *kn);

/*
 * symlink.c
 */
extern const struct inode_operations kernfs_symlink_iops;

#endif	/* __KERNFS_INTERNAL_H */
Commit	Line	Data
ae6621b0 TH	1	/*
	2	* fs/kernfs/kernfs-internal.h - kernfs internal header file
	3	*
	4	* Copyright (c) 2001-3 Patrick Mochel
	5	* Copyright (c) 2007 SUSE Linux Products GmbH
	6	* Copyright (c) 2007, 2013 Tejun Heo <teheo@suse.de>
	7	*
	8	* This file is released under the GPLv2.
	9	*/
	10
	11	#ifndef __KERNFS_INTERNAL_H
	12	#define __KERNFS_INTERNAL_H
	13
	14	#include <linux/lockdep.h>
	15	#include <linux/fs.h>
fd7b9f7b	16	#include <linux/mutex.h>
2322392b	17	#include <linux/xattr.h>
ae6621b0 TH	18
	19	#include <linux/kernfs.h>
	20
c525aadd	21	struct kernfs_iattrs {
9a8049af TH	22	struct iattr ia_iattr;
	23	void *ia_secdata;
	24	u32 ia_secdata_len;
2322392b TH	25
2322392b TH	26	struct simple_xattrs xattrs;
ae6621b0 TH	27	};
ae6621b0 TH	28
81c173cb TH	29	/* +1 to avoid triggering overflow warning when negating it */
81c173cb TH	30	#define KN_DEACTIVATED_BIAS (INT_MIN + 1)
ae6621b0	31
df23fc39	32	/* KERNFS_TYPE_MASK and types are defined in include/linux/kernfs.h */
ae6621b0	33
ba7443bc	34	/**
324a56e1 TH	35	* kernfs_root - find out the kernfs_root a kernfs_node belongs to
324a56e1 TH	36	* @kn: kernfs_node of interest
ba7443bc	37	*
324a56e1	38	* Return the kernfs_root @kn belongs to.
ba7443bc	39	*/
324a56e1	40	static inline struct kernfs_root kernfs_root(struct kernfs_node kn)
ba7443bc TH	41	{
ba7443bc TH	42	/* if parent exists, it's always a dir; otherwise, @sd is a dir */
adc5e8b5 TH	43	if (kn->parent)
	44	kn = kn->parent;
	45	return kn->dir.root;
ba7443bc TH	46	}
ba7443bc TH	47
fa736a95 TH	48	/*
	49	* mount.c
	50	*/
c525aadd	51	struct kernfs_super_info {
7d568a83 TH	52	struct super_block *sb;
7d568a83 TH	53
fa736a95 TH	54	/*
	55	* The root associated with this super_block. Each super_block is
	56	* identified by the root and ns it's associated with.
	57	*/
	58	struct kernfs_root *root;
	59
	60	/*
324a56e1	61	* Each sb is associated with one namespace tag, currently the
c525aadd TH	62	* network namespace of the task which mounted this kernfs
	63	* instance. If multiple tags become necessary, make the following
	64	* an array and compare kernfs_node tag against every entry.
fa736a95 TH	65	*/
fa736a95 TH	66	const void *ns;
7d568a83 TH	67
	68	/* anchored at kernfs_root->supers, protected by kernfs_mutex */
	69	struct list_head node;
fa736a95	70	};
c525aadd	71	#define kernfs_info(SB) ((struct kernfs_super_info *)(SB->s_fs_info))
fa736a95	72
f41c5934	73	extern const struct super_operations kernfs_sops;
a797bfc3	74	extern struct kmem_cache *kernfs_node_cache;
fa736a95	75
ffed24e2 TH	76	/*
	77	* inode.c
	78	*/
c637b8ac TH	79	void kernfs_evict_inode(struct inode *inode);
	80	int kernfs_iop_permission(struct inode *inode, int mask);
	81	int kernfs_iop_setattr(struct dentry dentry, struct iattr iattr);
	82	int kernfs_iop_getattr(struct vfsmount mnt, struct dentry dentry,
	83	struct kstat *stat);
3767e255 AV	84	int kernfs_iop_setxattr(struct dentry dentry, struct inode inode,
3767e255 AV	85	const char name, const void value,
c637b8ac TH	86	size_t size, int flags);
c637b8ac TH	87	int kernfs_iop_removexattr(struct dentry dentry, const char name);
ce23e640 AV	88	ssize_t kernfs_iop_getxattr(struct dentry dentry, struct inode inode,
ce23e640 AV	89	const char name, void buf, size_t size);
c637b8ac	90	ssize_t kernfs_iop_listxattr(struct dentry dentry, char buf, size_t size);
ffed24e2	91
fd7b9f7b TH	92	/*
	93	* dir.c
	94	*/
a797bfc3 TH	95	extern struct mutex kernfs_mutex;
	96	extern const struct dentry_operations kernfs_dops;
	97	extern const struct file_operations kernfs_dir_fops;
	98	extern const struct inode_operations kernfs_dir_iops;
fd7b9f7b	99
c637b8ac TH	100	struct kernfs_node kernfs_get_active(struct kernfs_node kn);
c637b8ac TH	101	void kernfs_put_active(struct kernfs_node *kn);
988cd7af	102	int kernfs_add_one(struct kernfs_node *kn);
db4aad20 TH	103	struct kernfs_node kernfs_new_node(struct kernfs_node parent,
	104	const char *name, umode_t mode,
	105	unsigned flags);
fd7b9f7b	106
414985ae TH	107	/*
	108	* file.c
	109	*/
a797bfc3	110	extern const struct file_operations kernfs_file_fops;
414985ae	111
55f6e30d	112	void kernfs_unmap_bin_file(struct kernfs_node *kn);
414985ae	113
2072f1af TH	114	/*
	115	* symlink.c
	116	*/
a797bfc3	117	extern const struct inode_operations kernfs_symlink_iops;
2072f1af	118
ae6621b0	119	#endif /* __KERNFS_INTERNAL_H */