[deliverable/linux.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 {
	/*
	 * 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;
};
#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
 */
struct inode *kernfs_get_inode(struct super_block *sb, struct kernfs_node *kn);
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, 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, const char *name, void *buf,
			    size_t size);
ssize_t kernfs_iop_listxattr(struct dentry *dentry, char *buf, size_t size);
void kernfs_inode_init(void);

/*
 * 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
	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>
	16	#include <linux/mutex.h>
	17	#include <linux/xattr.h>
	18
	19	#include <linux/kernfs.h>
	20
	21	struct kernfs_iattrs {
	22	struct iattr ia_iattr;
	23	void *ia_secdata;
	24	u32 ia_secdata_len;
	25
	26	struct simple_xattrs xattrs;
	27	};
	28
	29	/* +1 to avoid triggering overflow warning when negating it */
	30	#define KN_DEACTIVATED_BIAS (INT_MIN + 1)
	31
	32	/* KERNFS_TYPE_MASK and types are defined in include/linux/kernfs.h */
	33
	34	/**
	35	* kernfs_root - find out the kernfs_root a kernfs_node belongs to
	36	* @kn: kernfs_node of interest
	37	*
	38	* Return the kernfs_root @kn belongs to.
	39	*/
	40	static inline struct kernfs_root kernfs_root(struct kernfs_node kn)
	41	{
	42	/* if parent exists, it's always a dir; otherwise, @sd is a dir */
	43	if (kn->parent)
	44	kn = kn->parent;
	45	return kn->dir.root;
	46	}
	47
	48	/*
	49	* mount.c
	50	*/
	51	struct kernfs_super_info {
	52	/*
	53	* The root associated with this super_block. Each super_block is
	54	* identified by the root and ns it's associated with.
	55	*/
	56	struct kernfs_root *root;
	57
	58	/*
	59	* Each sb is associated with one namespace tag, currently the
	60	* network namespace of the task which mounted this kernfs
	61	* instance. If multiple tags become necessary, make the following
	62	* an array and compare kernfs_node tag against every entry.
	63	*/
	64	const void *ns;
	65	};
	66	#define kernfs_info(SB) ((struct kernfs_super_info *)(SB->s_fs_info))
	67
	68	extern const struct super_operations kernfs_sops;
	69	extern struct kmem_cache *kernfs_node_cache;
	70
	71	/*
	72	* inode.c
	73	*/
	74	struct inode kernfs_get_inode(struct super_block sb, struct kernfs_node *kn);
	75	void kernfs_evict_inode(struct inode *inode);
	76	int kernfs_iop_permission(struct inode *inode, int mask);
	77	int kernfs_iop_setattr(struct dentry dentry, struct iattr iattr);
	78	int kernfs_iop_getattr(struct vfsmount mnt, struct dentry dentry,
	79	struct kstat *stat);
	80	int kernfs_iop_setxattr(struct dentry dentry, const char name, const void *value,
	81	size_t size, int flags);
	82	int kernfs_iop_removexattr(struct dentry dentry, const char name);
	83	ssize_t kernfs_iop_getxattr(struct dentry dentry, const char name, void *buf,
	84	size_t size);
	85	ssize_t kernfs_iop_listxattr(struct dentry dentry, char buf, size_t size);
	86	void kernfs_inode_init(void);
	87
	88	/*
	89	* dir.c
	90	*/
	91	extern struct mutex kernfs_mutex;
	92	extern const struct dentry_operations kernfs_dops;
	93	extern const struct file_operations kernfs_dir_fops;
	94	extern const struct inode_operations kernfs_dir_iops;
	95
	96	struct kernfs_node kernfs_get_active(struct kernfs_node kn);
	97	void kernfs_put_active(struct kernfs_node *kn);
	98	int kernfs_add_one(struct kernfs_node *kn);
	99	struct kernfs_node kernfs_new_node(struct kernfs_node parent,
	100	const char *name, umode_t mode,
	101	unsigned flags);
	102
	103	/*
	104	* file.c
	105	*/
	106	extern const struct file_operations kernfs_file_fops;
	107
	108	void kernfs_unmap_bin_file(struct kernfs_node *kn);
	109
	110	/*
	111	* symlink.c
	112	*/
	113	extern const struct inode_operations kernfs_symlink_iops;
	114
	115	#endif /* __KERNFS_INTERNAL_H */