Blame view

include/linux/exportfs.h 7.78 KB
a56942551   Christoph Hellwig   knfsd: exportfs: ...
1
2
3
4
5
6
  #ifndef LINUX_EXPORTFS_H
  #define LINUX_EXPORTFS_H 1
  
  #include <linux/types.h>
  
  struct dentry;
7fbc1067f   Christoph Hellwig   exportfs: add met...
7
  struct iattr;
2596110a3   Christoph Hellwig   exportfs: add new...
8
  struct inode;
a56942551   Christoph Hellwig   knfsd: exportfs: ...
9
  struct super_block;
d37065cd6   Christoph Hellwig   knfsd: exportfs: ...
10
  struct vfsmount;
a56942551   Christoph Hellwig   knfsd: exportfs: ...
11

990d6c2d7   Aneesh Kumar K.V   vfs: Add name to ...
12
13
  /* limit the handle size to NFSv4 handle size now */
  #define MAX_HANDLE_SZ 128
6e91ea2bb   Christoph Hellwig   exportfs: add fid...
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
  /*
   * 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,
221e583a7   Rasmus Rohde   udf: Make udf exp...
39
40
  
  	/*
e4464facd   David Woodhouse   Reserve NFS filei...
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
  	 * 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,
  
  	/*
221e583a7   Rasmus Rohde   udf: Make udf exp...
62
63
64
65
66
67
68
69
70
71
72
  	 * 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,
8e656fd51   Ryusuke Konishi   nilfs2: make snap...
73
74
75
76
77
78
79
80
81
82
83
84
85
  
  	/*
  	 * 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,
216b6cbdc   Namjae Jeon   exportfs: add FIL...
86
87
  
  	/*
ea3983ace   Namjae Jeon   fat: restructure ...
88
89
90
91
92
93
94
95
96
97
98
  	 * 32 bit generation number, 40 bit i_pos.
  	 */
  	FILEID_FAT_WITHOUT_PARENT = 0x71,
  
  	/*
  	 * 32 bit generation number, 40 bit i_pos,
  	 * 32 bit parent generation number, 40 bit parent i_pos
  	 */
  	FILEID_FAT_WITH_PARENT = 0x72,
  
  	/*
216b6cbdc   Namjae Jeon   exportfs: add FIL...
99
100
101
  	 * Filesystems must not use 0xff file ID.
  	 */
  	FILEID_INVALID = 0xff,
6e91ea2bb   Christoph Hellwig   exportfs: add fid...
102
103
104
105
106
107
108
109
110
111
  };
  
  struct fid {
  	union {
  		struct {
  			u32 ino;
  			u32 gen;
  			u32 parent_ino;
  			u32 parent_gen;
  		} i32;
221e583a7   Rasmus Rohde   udf: Make udf exp...
112
113
114
115
116
117
118
119
   		struct {
   			u32 block;
   			u16 partref;
   			u16 parent_partref;
   			u32 generation;
   			u32 parent_block;
   			u32 parent_generation;
   		} udf;
9078dc081   Steven Whitehouse   Use a zero sized ...
120
  		__u32 raw[0];
6e91ea2bb   Christoph Hellwig   exportfs: add fid...
121
122
  	};
  };
a56942551   Christoph Hellwig   knfsd: exportfs: ...
123
124
125
  
  /**
   * struct export_operations - for nfsd to communicate with file systems
a56942551   Christoph Hellwig   knfsd: exportfs: ...
126
   * @encode_fh:      encode a file handle fragment from a dentry
9b89ca7a3   Marc Dionne   struct export_ope...
127
128
   * @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
a56942551   Christoph Hellwig   knfsd: exportfs: ...
129
130
   * @get_name:       find the name for a given inode in a given directory
   * @get_parent:     find the parent of a given directory
f501912a3   Ben Myers   commit_metadata e...
131
   * @commit_metadata: commit metadata changes to stable storage
a56942551   Christoph Hellwig   knfsd: exportfs: ...
132
   *
dc7a08166   J. Bruce Fields   nfs: new subdir D...
133
   * See Documentation/filesystems/nfs/Exporting for details on how to use
e38f98175   Christoph Hellwig   exportfs: update ...
134
   * this interface correctly.
a56942551   Christoph Hellwig   knfsd: exportfs: ...
135
   *
a56942551   Christoph Hellwig   knfsd: exportfs: ...
136
137
138
   * 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
25985edce   Lucas De Marchi   Fix common misspe...
139
   *    file referred to by the &struct dentry @de.  If the @connectable flag is
a56942551   Christoph Hellwig   knfsd: exportfs: ...
140
141
142
   *    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
5fe0c2378   Aneesh Kumar K.V   exportfs: Return ...
143
144
145
146
   *    the filehandle fragment.  encode_fh() should return the fileid_type on
   *    success and on error returns 255 (if the space needed to encode fh is
   *    greater than @max_len*4 bytes). On error @max_len contains the minimum
   *    size(in 4 byte unit) needed to encode the file handle.
a56942551   Christoph Hellwig   knfsd: exportfs: ...
147
   *
2596110a3   Christoph Hellwig   exportfs: add new...
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
   * 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.
   *
a56942551   Christoph Hellwig   knfsd: exportfs: ...
163
164
165
166
167
168
169
170
171
172
173
174
   * 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.
   *
f501912a3   Ben Myers   commit_metadata e...
175
176
177
   * commit_metadata:
   *    @commit_metadata should commit metadata changes to stable storage.
   *
a56942551   Christoph Hellwig   knfsd: exportfs: ...
178
179
180
181
   * Locking rules:
   *    get_parent is called with child->d_inode->i_mutex down
   *    get_name is not (which is possibly inconsistent)
   */
7fbc1067f   Christoph Hellwig   exportfs: add met...
182
183
184
185
186
187
188
189
190
191
192
193
194
195
  /* types of block ranges for multipage write mappings. */
  #define IOMAP_HOLE	0x01	/* no blocks allocated, need allocation */
  #define IOMAP_DELALLOC	0x02	/* delayed allocation blocks */
  #define IOMAP_MAPPED	0x03	/* blocks allocated @blkno */
  #define IOMAP_UNWRITTEN	0x04	/* blocks allocated @blkno in unwritten state */
  
  #define IOMAP_NULL_BLOCK -1LL	/* blkno is not valid */
  
  struct iomap {
  	sector_t	blkno;	/* first sector of mapping */
  	loff_t		offset;	/* file offset of mapping, bytes */
  	u64		length;	/* length of mapping, bytes */
  	int		type;	/* type of mapping */
  };
a56942551   Christoph Hellwig   knfsd: exportfs: ...
196
  struct export_operations {
b0b0382bb   Al Viro   ->encode_fh() API...
197
198
  	int (*encode_fh)(struct inode *inode, __u32 *fh, int *max_len,
  			struct inode *parent);
2596110a3   Christoph Hellwig   exportfs: add new...
199
200
201
202
  	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);
a56942551   Christoph Hellwig   knfsd: exportfs: ...
203
204
205
  	int (*get_name)(struct dentry *parent, char *name,
  			struct dentry *child);
  	struct dentry * (*get_parent)(struct dentry *child);
f501912a3   Ben Myers   commit_metadata e...
206
  	int (*commit_metadata)(struct inode *inode);
7fbc1067f   Christoph Hellwig   exportfs: add met...
207
208
209
210
211
212
213
  
  	int (*get_uuid)(struct super_block *sb, u8 *buf, u32 *len, u64 *offset);
  	int (*map_blocks)(struct inode *inode, loff_t offset,
  			  u64 len, struct iomap *iomap,
  			  bool write, u32 *device_generation);
  	int (*commit_blocks)(struct inode *inode, struct iomap *iomaps,
  			     int nr_iomaps, struct iattr *iattr);
a56942551   Christoph Hellwig   knfsd: exportfs: ...
214
  };
711c7bf99   Cyrill Gorcunov   fs, exportfs: add...
215
216
  extern int exportfs_encode_inode_fh(struct inode *inode, struct fid *fid,
  				    int *max_len, struct inode *parent);
6e91ea2bb   Christoph Hellwig   exportfs: add fid...
217
218
219
  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,
d37065cd6   Christoph Hellwig   knfsd: exportfs: ...
220
221
  	int fh_len, int fileid_type, int (*acceptable)(void *, struct dentry *),
  	void *context);
2596110a3   Christoph Hellwig   exportfs: add new...
222
223
224
225
226
227
228
229
230
  /*
   * 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));
a56942551   Christoph Hellwig   knfsd: exportfs: ...
231
  #endif /* LINUX_EXPORTFS_H */