[net-next-2.6.git] / include / linux / exportfs.h

#ifndef LINUX_EXPORTFS_H
#define LINUX_EXPORTFS_H 1

#include <linux/types.h>

struct dentry;
struct inode;
struct super_block;
struct vfsmount;

/*
 * The fileid_type identifies how the file within the filesystem is encoded.
 * In theory this is freely set and parsed by the filesystem, but we try to
 * stick to conventions so we can share some generic code and don't confuse
 * sniffers like ethereal/wireshark.
 *
 * The filesystem must not use the value '0' or '0xff'.
 */
enum fid_type {
	/*
	 * The root, or export point, of the filesystem.
	 * (Never actually passed down to the filesystem.
	 */
	FILEID_ROOT = 0,

	/*
	 * 32bit inode number, 32 bit generation number.
	 */
	FILEID_INO32_GEN = 1,

	/*
	 * 32bit inode number, 32 bit generation number,
	 * 32 bit parent directory inode number.
	 */
	FILEID_INO32_GEN_PARENT = 2,

	/*
	 * 64 bit object ID, 64 bit root object ID,
	 * 32 bit generation number.
	 */
	FILEID_BTRFS_WITHOUT_PARENT = 0x4d,

	/*
	 * 64 bit object ID, 64 bit root object ID,
	 * 32 bit generation number,
	 * 64 bit parent object ID, 32 bit parent generation.
	 */
	FILEID_BTRFS_WITH_PARENT = 0x4e,

	/*
	 * 64 bit object ID, 64 bit root object ID,
	 * 32 bit generation number,
	 * 64 bit parent object ID, 32 bit parent generation,
	 * 64 bit parent root object ID.
	 */
	FILEID_BTRFS_WITH_PARENT_ROOT = 0x4f,

	/*
	 * 32 bit block number, 16 bit partition reference,
	 * 16 bit unused, 32 bit generation number.
	 */
	FILEID_UDF_WITHOUT_PARENT = 0x51,

	/*
	 * 32 bit block number, 16 bit partition reference,
	 * 16 bit unused, 32 bit generation number,
	 * 32 bit parent block number, 32 bit parent generation number
	 */
	FILEID_UDF_WITH_PARENT = 0x52,

	/*
	 * 64 bit checkpoint number, 64 bit inode number,
	 * 32 bit generation number.
	 */
	FILEID_NILFS_WITHOUT_PARENT = 0x61,

	/*
	 * 64 bit checkpoint number, 64 bit inode number,
	 * 32 bit generation number, 32 bit parent generation.
	 * 64 bit parent inode number.
	 */
	FILEID_NILFS_WITH_PARENT = 0x62,
};

struct fid {
	union {
		struct {
			u32 ino;
			u32 gen;
			u32 parent_ino;
			u32 parent_gen;
		} i32;
 		struct {
 			u32 block;
 			u16 partref;
 			u16 parent_partref;
 			u32 generation;
 			u32 parent_block;
 			u32 parent_generation;
 		} udf;
		__u32 raw[0];
	};
};

/**
 * struct export_operations - for nfsd to communicate with file systems
 * @encode_fh:      encode a file handle fragment from a dentry
 * @fh_to_dentry:   find the implied object and get a dentry for it
 * @fh_to_parent:   find the implied object's parent and get a dentry for it
 * @get_name:       find the name for a given inode in a given directory
 * @get_parent:     find the parent of a given directory
 * @commit_metadata: commit metadata changes to stable storage
 *
 * See Documentation/filesystems/nfs/Exporting for details on how to use
 * this interface correctly.
 *
 * encode_fh:
 *    @encode_fh should store in the file handle fragment @fh (using at most
 *    @max_len bytes) information that can be used by @decode_fh to recover the
 *    file refered to by the &struct dentry @de.  If the @connectable flag is
 *    set, the encode_fh() should store sufficient information so that a good
 *    attempt can be made to find not only the file but also it's place in the
 *    filesystem.   This typically means storing a reference to de->d_parent in
 *    the filehandle fragment.  encode_fh() should return the number of bytes
 *    stored or a negative error code such as %-ENOSPC
 *
 * fh_to_dentry:
 *    @fh_to_dentry is given a &struct super_block (@sb) and a file handle
 *    fragment (@fh, @fh_len). It should return a &struct dentry which refers
 *    to the same file that the file handle fragment refers to.  If it cannot,
 *    it should return a %NULL pointer if the file was found but no acceptable
 *    &dentries were available, or an %ERR_PTR error code indicating why it
 *    couldn't be found (e.g. %ENOENT or %ENOMEM).  Any suitable dentry can be
 *    returned including, if necessary, a new dentry created with d_alloc_root.
 *    The caller can then find any other extant dentries by following the
 *    d_alias links.
 *
 * fh_to_parent:
 *    Same as @fh_to_dentry, except that it returns a pointer to the parent
 *    dentry if it was encoded into the filehandle fragment by @encode_fh.
 *
 * get_name:
 *    @get_name should find a name for the given @child in the given @parent
 *    directory.  The name should be stored in the @name (with the
 *    understanding that it is already pointing to a a %NAME_MAX+1 sized
 *    buffer.   get_name() should return %0 on success, a negative error code
 *    or error.  @get_name will be called without @parent->i_mutex held.
 *
 * get_parent:
 *    @get_parent should find the parent directory for the given @child which
 *    is also a directory.  In the event that it cannot be found, or storage
 *    space cannot be allocated, a %ERR_PTR should be returned.
 *
 * commit_metadata:
 *    @commit_metadata should commit metadata changes to stable storage.
 *
 * Locking rules:
 *    get_parent is called with child->d_inode->i_mutex down
 *    get_name is not (which is possibly inconsistent)
 */

struct export_operations {
	int (*encode_fh)(struct dentry *de, __u32 *fh, int *max_len,
			int connectable);
	struct dentry * (*fh_to_dentry)(struct super_block *sb, struct fid *fid,
			int fh_len, int fh_type);
	struct dentry * (*fh_to_parent)(struct super_block *sb, struct fid *fid,
			int fh_len, int fh_type);
	int (*get_name)(struct dentry *parent, char *name,
			struct dentry *child);
	struct dentry * (*get_parent)(struct dentry *child);
	int (*commit_metadata)(struct inode *inode);
};

extern int exportfs_encode_fh(struct dentry *dentry, struct fid *fid,
	int *max_len, int connectable);
extern struct dentry *exportfs_decode_fh(struct vfsmount *mnt, struct fid *fid,
	int fh_len, int fileid_type, int (*acceptable)(void *, struct dentry *),
	void *context);

/*
 * Generic helpers for filesystems.
 */
extern struct dentry *generic_fh_to_dentry(struct super_block *sb,
	struct fid *fid, int fh_len, int fh_type,
	struct inode *(*get_inode) (struct super_block *sb, u64 ino, u32 gen));
extern struct dentry *generic_fh_to_parent(struct super_block *sb,
	struct fid *fid, int fh_len, int fh_type,
	struct inode *(*get_inode) (struct super_block *sb, u64 ino, u32 gen));

#endif /* LINUX_EXPORTFS_H */
Commit	Line	Data
a5694255 CH	1	#ifndef LINUX_EXPORTFS_H
	2	#define LINUX_EXPORTFS_H 1
	3
	4	#include <linux/types.h>
	5
	6	struct dentry;
2596110a	7	struct inode;
a5694255	8	struct super_block;
d37065cd	9	struct vfsmount;
a5694255	10
6e91ea2b CH	11	/*
	12	* The fileid_type identifies how the file within the filesystem is encoded.
	13	* In theory this is freely set and parsed by the filesystem, but we try to
	14	* stick to conventions so we can share some generic code and don't confuse
	15	* sniffers like ethereal/wireshark.
	16	*
	17	* The filesystem must not use the value '0' or '0xff'.
	18	*/
	19	enum fid_type {
	20	/*
	21	* The root, or export point, of the filesystem.
	22	* (Never actually passed down to the filesystem.
	23	*/
	24	FILEID_ROOT = 0,
	25
	26	/*
	27	* 32bit inode number, 32 bit generation number.
	28	*/
	29	FILEID_INO32_GEN = 1,
	30
	31	/*
	32	* 32bit inode number, 32 bit generation number,
	33	* 32 bit parent directory inode number.
	34	*/
	35	FILEID_INO32_GEN_PARENT = 2,
221e583a	36
e4464fac DW	37	/*
	38	* 64 bit object ID, 64 bit root object ID,
	39	* 32 bit generation number.
	40	*/
	41	FILEID_BTRFS_WITHOUT_PARENT = 0x4d,
	42
	43	/*
	44	* 64 bit object ID, 64 bit root object ID,
	45	* 32 bit generation number,
	46	* 64 bit parent object ID, 32 bit parent generation.
	47	*/
	48	FILEID_BTRFS_WITH_PARENT = 0x4e,
	49
	50	/*
	51	* 64 bit object ID, 64 bit root object ID,
	52	* 32 bit generation number,
	53	* 64 bit parent object ID, 32 bit parent generation,
	54	* 64 bit parent root object ID.
	55	*/
	56	FILEID_BTRFS_WITH_PARENT_ROOT = 0x4f,
	57
221e583a RR	58	/*
	59	* 32 bit block number, 16 bit partition reference,
	60	* 16 bit unused, 32 bit generation number.
	61	*/
	62	FILEID_UDF_WITHOUT_PARENT = 0x51,
	63
	64	/*
	65	* 32 bit block number, 16 bit partition reference,
	66	* 16 bit unused, 32 bit generation number,
	67	* 32 bit parent block number, 32 bit parent generation number
	68	*/
	69	FILEID_UDF_WITH_PARENT = 0x52,
8e656fd5 RK	70
	71	/*
	72	* 64 bit checkpoint number, 64 bit inode number,
	73	* 32 bit generation number.
	74	*/
	75	FILEID_NILFS_WITHOUT_PARENT = 0x61,
	76
	77	/*
	78	* 64 bit checkpoint number, 64 bit inode number,
	79	* 32 bit generation number, 32 bit parent generation.
	80	* 64 bit parent inode number.
	81	*/
	82	FILEID_NILFS_WITH_PARENT = 0x62,
6e91ea2b CH	83	};
	84
	85	struct fid {
	86	union {
	87	struct {
	88	u32 ino;
	89	u32 gen;
	90	u32 parent_ino;
	91	u32 parent_gen;
	92	} i32;
221e583a RR	93	struct {
	94	u32 block;
	95	u16 partref;
	96	u16 parent_partref;
	97	u32 generation;
	98	u32 parent_block;
	99	u32 parent_generation;
	100	} udf;
9078dc08	101	__u32 raw[0];
6e91ea2b CH	102	};
6e91ea2b CH	103	};
a5694255 CH	104
	105	/**
	106	* struct export_operations - for nfsd to communicate with file systems
a5694255	107	* @encode_fh: encode a file handle fragment from a dentry
9b89ca7a MD	108	* @fh_to_dentry: find the implied object and get a dentry for it
9b89ca7a MD	109	* @fh_to_parent: find the implied object's parent and get a dentry for it
a5694255 CH	110	* @get_name: find the name for a given inode in a given directory
a5694255 CH	111	* @get_parent: find the parent of a given directory
f501912a	112	* @commit_metadata: commit metadata changes to stable storage
a5694255	113	*
dc7a0816	114	* See Documentation/filesystems/nfs/Exporting for details on how to use
e38f9817	115	* this interface correctly.
a5694255	116	*
a5694255 CH	117	* encode_fh:
	118	* @encode_fh should store in the file handle fragment @fh (using at most
	119	* @max_len bytes) information that can be used by @decode_fh to recover the
	120	* file refered to by the &struct dentry @de. If the @connectable flag is
	121	* set, the encode_fh() should store sufficient information so that a good
	122	* attempt can be made to find not only the file but also it's place in the
	123	* filesystem. This typically means storing a reference to de->d_parent in
	124	* the filehandle fragment. encode_fh() should return the number of bytes
	125	* stored or a negative error code such as %-ENOSPC
	126	*
2596110a CH	127	* fh_to_dentry:
	128	* @fh_to_dentry is given a &struct super_block (@sb) and a file handle
	129	* fragment (@fh, @fh_len). It should return a &struct dentry which refers
	130	* to the same file that the file handle fragment refers to. If it cannot,
	131	* it should return a %NULL pointer if the file was found but no acceptable
	132	* &dentries were available, or an %ERR_PTR error code indicating why it
	133	* couldn't be found (e.g. %ENOENT or %ENOMEM). Any suitable dentry can be
	134	* returned including, if necessary, a new dentry created with d_alloc_root.
	135	* The caller can then find any other extant dentries by following the
	136	* d_alias links.
	137	*
	138	* fh_to_parent:
	139	* Same as @fh_to_dentry, except that it returns a pointer to the parent
	140	* dentry if it was encoded into the filehandle fragment by @encode_fh.
	141	*
a5694255 CH	142	* get_name:
	143	* @get_name should find a name for the given @child in the given @parent
	144	* directory. The name should be stored in the @name (with the
	145	* understanding that it is already pointing to a a %NAME_MAX+1 sized
	146	* buffer. get_name() should return %0 on success, a negative error code
	147	* or error. @get_name will be called without @parent->i_mutex held.
	148	*
	149	* get_parent:
	150	* @get_parent should find the parent directory for the given @child which
	151	* is also a directory. In the event that it cannot be found, or storage
	152	* space cannot be allocated, a %ERR_PTR should be returned.
	153	*
f501912a BM	154	* commit_metadata:
	155	* @commit_metadata should commit metadata changes to stable storage.
	156	*
a5694255 CH	157	* Locking rules:
	158	* get_parent is called with child->d_inode->i_mutex down
	159	* get_name is not (which is possibly inconsistent)
	160	*/
	161
	162	struct export_operations {
a5694255 CH	163	int (encode_fh)(struct dentry de, __u32 fh, int max_len,
a5694255 CH	164	int connectable);
2596110a CH	165	struct dentry * (fh_to_dentry)(struct super_block sb, struct fid *fid,
	166	int fh_len, int fh_type);
	167	struct dentry * (fh_to_parent)(struct super_block sb, struct fid *fid,
	168	int fh_len, int fh_type);
a5694255 CH	169	int (get_name)(struct dentry parent, char *name,
	170	struct dentry *child);
	171	struct dentry * (get_parent)(struct dentry child);
f501912a	172	int (commit_metadata)(struct inode inode);
a5694255 CH	173	};
a5694255 CH	174
6e91ea2b CH	175	extern int exportfs_encode_fh(struct dentry dentry, struct fid fid,
	176	int *max_len, int connectable);
	177	extern struct dentry exportfs_decode_fh(struct vfsmount mnt, struct fid *fid,
d37065cd CH	178	int fh_len, int fileid_type, int (acceptable)(void , struct dentry *),
	179	void *context);
	180
2596110a CH	181	/*
	182	* Generic helpers for filesystems.
	183	*/
	184	extern struct dentry generic_fh_to_dentry(struct super_block sb,
	185	struct fid *fid, int fh_len, int fh_type,
	186	struct inode (get_inode) (struct super_block *sb, u64 ino, u32 gen));
	187	extern struct dentry generic_fh_to_parent(struct super_block sb,
	188	struct fid *fid, int fh_len, int fh_type,
	189	struct inode (get_inode) (struct super_block *sb, u64 ino, u32 gen));
	190
a5694255	191	#endif /* LINUX_EXPORTFS_H */